1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
|
/*
* Copyright 2013-2015 Canonical Ltd.
*
* This file is part of webbrowser-app.
*
* webbrowser-app is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 3.
*
* webbrowser-app is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "config.h"
#include "webapp-container.h"
#include "chrome-cookie-store.h"
#include "intent-filter.h"
#include "local-cookie-store.h"
#include "online-accounts-cookie-store.h"
#include "session-utils.h"
#include "shared-cookie-store.h"
#include "url-pattern-utils.h"
#include "webapp-container-helper.h"
// Qt
#include <QtCore/QCoreApplication>
#include <QtCore/QDebug>
#include <QtCore/QFile>
#include <QtCore/QFileInfo>
#include <QtCore/QtGlobal>
#include <QtCore/QRegularExpression>
#include <QtCore/QTextStream>
#include <QtQml/QQmlComponent>
#include <QtQml/QQmlContext>
#include <QtQml/QQmlEngine>
#include <QtQml>
#include <QtQuick/QQuickWindow>
#include <QStandardPaths>
#include <QSettings>
static const char privateModuleUri[] = "webcontainer.private";
namespace
{
/* Hack to clear the local data of the webapp, when it's integrated with OA:
* https://bugs.launchpad.net/bugs/1371659
* This is needed because cookie sets from different accounts might not
* completely overwrite each other, and therefore we end up with an
* inconsistent cookie jar. */
static void clearCookiesHack(const QString &provider)
{
if (provider.isEmpty()) {
qWarning() << "--clear-cookies only works with an accountProvider" << endl;
return;
}
/* check both ~/.local/share and ~/.cache, as the data will eventually be
* moving from the first to the latter.
*/
QStringList baseDirs;
baseDirs << QStandardPaths::writableLocation(QStandardPaths::DataLocation);
baseDirs << QStandardPaths::writableLocation(QStandardPaths::CacheLocation);
Q_FOREACH(const QString &baseDir, baseDirs) {
QDir dir(baseDir);
dir.removeRecursively();
}
}
}
const QString WebappContainer::URL_PATTERN_SEPARATOR = ",";
const QString WebappContainer::LOCAL_INTENT_FILTER_FILENAME = "local-intent-filter.js";
WebappContainer::WebappContainer(int& argc, char** argv):
BrowserApplication(argc, argv),
m_storeSessionCookies(false),
m_backForwardButtonsVisible(false),
m_addressBarVisible(false),
m_sharedCookies(false),
m_localWebappManifest(false),
m_webappContainerHelper(new WebappContainerHelper())
{
}
bool WebappContainer::initialize()
{
earlyEnvironment();
if (BrowserApplication::initialize("webcontainer/webapp-container.qml")) {
parseCommandLine();
parseExtraConfiguration();
if (m_localWebappManifest)
m_webappModelSearchPath = ".";
if (!m_webappModelSearchPath.isEmpty())
{
QDir searchDir(m_webappModelSearchPath);
searchDir.makeAbsolute();
if (searchDir.exists()) {
m_window->setProperty("webappModelSearchPath", searchDir.path());
}
}
if ( ! m_localCookieStoreDbPath.isEmpty()) {
m_window->setProperty("localCookieStoreDbPath", m_localCookieStoreDbPath);
}
m_window->setProperty("webappName", m_webappName);
m_window->setProperty("backForwardButtonsVisible", m_backForwardButtonsVisible);
m_window->setProperty("chromeVisible", m_addressBarVisible);
m_window->setProperty("accountProvider", m_accountProvider);
m_window->setProperty("sharedCookies", m_sharedCookies);
m_window->setProperty("webappUrlPatterns", m_webappUrlPatterns);
QQmlContext* context = m_engine->rootContext();
if (m_storeSessionCookies) {
QString sessionCookieMode = SessionUtils::firstRun(m_webappName) ?
QStringLiteral("persistent") : QStringLiteral("restored");
qDebug() << "Setting session cookie mode to" << sessionCookieMode;
context->setContextProperty("webContextSessionCookieMode", sessionCookieMode);
}
context->setContextProperty("webappContainerHelper", m_webappContainerHelper.data());
if ( ! m_popupRedirectionUrlPrefixPattern.isEmpty()) {
const QString WEBAPP_CONTAINER_DO_NOT_FILTER_PATTERN_URL_ENV_VAR =
qgetenv("WEBAPP_CONTAINER_DO_NOT_FILTER_PATTERN_URL");
m_window->setProperty(
"popupRedirectionUrlPrefixPattern",
WEBAPP_CONTAINER_DO_NOT_FILTER_PATTERN_URL_ENV_VAR == "1"
? m_popupRedirectionUrlPrefixPattern
: UrlPatternUtils::transformWebappSearchPatternToSafePattern(
m_popupRedirectionUrlPrefixPattern, false));
}
if (!m_userAgentOverride.isEmpty()) {
m_window->setProperty("localUserAgentOverride", m_userAgentOverride);
}
// Experimental, unsupported API, to override the webview
QFileInfo overrideFile("webview-override.qml");
if (overrideFile.exists()) {
m_window->setProperty("webviewOverrideFile", QUrl::fromLocalFile(overrideFile.absoluteFilePath()));
}
const QString WEBAPP_CONTAINER_BLOCK_OPEN_URL_EXTERNALLY_ENV_VAR =
qgetenv("WEBAPP_CONTAINER_BLOCK_OPEN_URL_EXTERNALLY");
if (WEBAPP_CONTAINER_BLOCK_OPEN_URL_EXTERNALLY_ENV_VAR == "1") {
m_window->setProperty("blockOpenExternalUrls", true);
}
bool runningLocalApp = false;
QList<QUrl> urls = this->urls();
if (!urls.isEmpty()) {
QUrl homeUrl = urls.last();
m_window->setProperty("url", homeUrl);
if (UrlPatternUtils::isLocalHtml5ApplicationHomeUrl(homeUrl)) {
qDebug() << "Started as a local application container.";
runningLocalApp = true;
}
} else if (m_webappModelSearchPath.isEmpty()
&& m_webappName.isEmpty()) {
qCritical() << "No starting homepage provided";
return false;
}
// Otherwise, assume that the homepage will come from a locally defined
// webapp-properties.json file pulled from the webapp model element
// or from a default local system install (if any).
m_window->setProperty("runningLocalApplication", runningLocalApp);
// Handle the invalid runtime conditions for the local apps
if (runningLocalApp && !isValidLocalApplicationRunningContext()) {
qCritical() << "Cannot run a local HTML5 application, invalid command line flags detected.";
return false;
}
// Handle an optional intent filter. The default filter does nothing.
setupLocalIntentFilterIfAny(context);
m_component->completeCreate();
return true;
} else {
return false;
}
}
void WebappContainer::setupLocalIntentFilterIfAny(QQmlContext* context)
{
if(!context)
{
return;
}
QString localIntentFilterFileContent;
if (IntentFilter::isValidLocalIntentFilterFile(LOCAL_INTENT_FILTER_FILENAME))
{
QFile f(LOCAL_INTENT_FILTER_FILENAME);
if (f.open(QIODevice::ReadOnly))
{
localIntentFilterFileContent = QString(f.readAll());
}
f.close();
qDebug() << "Using local intent filter file:"
<< LOCAL_INTENT_FILTER_FILENAME;
}
m_intentFilter.reset(new IntentFilter(localIntentFilterFileContent, NULL));
context->setContextProperty("webappIntentFilter", m_intentFilter.data());
}
bool WebappContainer::isValidLocalApplicationRunningContext() const
{
return m_webappModelSearchPath.isEmpty() &&
m_popupRedirectionUrlPrefixPattern.isEmpty() &&
m_webappUrlPatterns.isEmpty() &&
m_webappName.isEmpty();
}
void WebappContainer::qmlEngineCreated(QQmlEngine* engine)
{
if (engine) {
qmlRegisterType<ChromeCookieStore>(privateModuleUri, 0, 1,
"ChromeCookieStore");
qmlRegisterType<LocalCookieStore>(privateModuleUri, 0, 1,
"LocalCookieStore");
qmlRegisterType<OnlineAccountsCookieStore>(privateModuleUri, 0, 1,
"OnlineAccountsCookieStore");
qmlRegisterType<SharedCookieStore>(privateModuleUri, 0, 1,
"SharedCookieStore");
}
}
void WebappContainer::printUsage() const
{
QTextStream out(stdout);
QString command = QFileInfo(QCoreApplication::applicationFilePath()).fileName();
out << "Usage: " << command << " [-h|--help]"
" [--fullscreen]"
" [--maximized]"
" [--inspector]"
" [--app-id=APP_ID]"
" [--homepage=URL]"
" [--webapp=name]"
" [--webappModelSearchPath=PATH]"
" [--webappUrlPatterns=URL_PATTERNS]"
" [--accountProvider=PROVIDER_NAME]"
" [--enable-back-forward]"
" [--enable-addressbar]"
" [--store-session-cookies]"
" [--shared-cookies]"
" [--user-agent-string=USER_AGENT]"
" [URL]" << endl;
out << "Options:" << endl;
out << " -h, --help display this help message and exit" << endl;
out << " --fullscreen display full screen" << endl;
out << " --local-webapp-manifest configure the webapp assuming that it has a local manifest.json file" << endl;
out << " --maximized opens the application maximized" << endl;
out << " --inspector[=PORT] run a remote inspector on a specified port or " << REMOTE_INSPECTOR_PORT << " as the default port" << endl;
out << " --app-id=APP_ID run the application with a specific APP_ID" << endl;
out << " --homepage=URL override any URL passed as an argument" << endl;
out << " --webapp=name try to match the webapp by name with an installed integration script" << endl;
out << " --webappModelSearchPath=PATH alter the search path for installed webapps and set it to PATH. PATH can be an absolute or path relative to CWD" << endl;
out << " --webappUrlPatterns=URL_PATTERNS list of comma-separated url patterns (wildcard based) that the webapp is allowed to navigate to" << endl;
out << " --accountProvider=PROVIDER_NAME Online account provider for the application if the application is to reuse a local account." << endl;
out << " --store-session-cookies store session cookies on disk" << endl;
out << " --shared-cookies share cookies with other webapps using the same account" << endl;
out << " --enable-media-hub-audio enable media-hub for audio playback" << endl;
out << " --user-agent-string=USER_AGENT overrides the default User Agent with the provided one." << endl;
out << "Chrome options (if none specified, no chrome is shown by default):" << endl;
out << " --enable-back-forward enable the display of the back and forward buttons (implies --enable-addressbar)" << endl;
out << " --enable-addressbar enable the display of a minimal chrome (favicon and title)" << endl;
}
void WebappContainer::earlyEnvironment()
{
Q_FOREACH(const QString& argument, m_arguments) {
if (argument.startsWith("--enable-media-hub-audio")) {
qputenv("OXIDE_ENABLE_MEDIA_HUB_AUDIO", QString("1").toLocal8Bit().constData());
}
}
}
void WebappContainer::parseCommandLine()
{
Q_FOREACH(const QString& argument, m_arguments) {
if (argument.startsWith("--webappModelSearchPath=")) {
m_webappModelSearchPath = argument.split("--webappModelSearchPath=")[1];
} else if (argument.startsWith("--webapp=")) {
// We use the name as a reference instead of the URL with a subsequent step to match it with a webapp.
// TODO: validate that it is fine in all cases (country dependent, etc…).
QString name = argument.split("--webapp=")[1];
m_webappName = QByteArray::fromBase64(name.toUtf8()).trimmed();
} else if (argument.startsWith("--webappUrlPatterns=")) {
QString tail = argument.split("--webappUrlPatterns=")[1];
if (!tail.isEmpty()) {
QStringList includePatterns = tail.split(URL_PATTERN_SEPARATOR);
m_webappUrlPatterns = UrlPatternUtils::filterAndTransformUrlPatterns(includePatterns);
}
} else if (argument.startsWith("--accountProvider=")) {
m_accountProvider = argument.split("--accountProvider=")[1];
} else if (argument == "--clear-cookies") {
qWarning() << argument << " is an unsupported option: it can be removed without notice..." << endl;
clearCookiesHack(m_accountProvider);
} else if (argument == "--store-session-cookies") {
m_storeSessionCookies = true;
} else if (argument == "--shared-cookies") {
m_sharedCookies = true;
} else if (argument == "--enable-back-forward") {
m_backForwardButtonsVisible = true;
} else if (argument == "--enable-addressbar") {
m_addressBarVisible = true;
} else if (argument == "--local-webapp-manifest") {
m_localWebappManifest = true;
} else if (argument.startsWith("--popup-redirection-url-prefix=")) {
m_popupRedirectionUrlPrefixPattern = argument.split("--popup-redirection-url-prefix=")[1];
} else if (argument.startsWith("--local-cookie-db-path=")) {
m_localCookieStoreDbPath = argument.split("--local-cookie-db-path=")[1];
} else if (argument.startsWith("--user-agent-string=")) {
m_userAgentOverride = argument.split("--user-agent-string=")[1];
}
}
}
void WebappContainer::parseExtraConfiguration()
{
// Add potential extra url patterns not listed in the command line
m_webappUrlPatterns.append(
UrlPatternUtils::filterAndTransformUrlPatterns(
getExtraWebappUrlPatterns().split(URL_PATTERN_SEPARATOR)));
}
QString WebappContainer::getExtraWebappUrlPatterns() const
{
static const QString EXTRA_APP_URL_PATTERNS_CONF_FILENAME =
"extra-url-patterns.conf";
QString extraUrlPatternsFilename =
QString("%1/%2")
.arg(QStandardPaths::writableLocation(QStandardPaths::DataLocation))
.arg(EXTRA_APP_URL_PATTERNS_CONF_FILENAME);
QString extraPatterns;
QFileInfo f(extraUrlPatternsFilename);
if (f.exists() && f.isReadable())
{
QSettings extraUrlPatternsSetting(f.absoluteFilePath(), QSettings::IniFormat);
extraUrlPatternsSetting.beginGroup("Extra Patterns");
QVariant patternsValue = extraUrlPatternsSetting.value("Patterns");
// The line can contain comma separated args Patterns=1,2,3. In this case
// QSettings interprets this as a StringList instead of giving us
// the raw value.
if (patternsValue.type() == QVariant::StringList)
extraPatterns = patternsValue.toStringList().join(",");
else
extraPatterns = patternsValue.toString();
if ( ! extraPatterns.isEmpty())
{
qDebug() << "Found extra url patterns to be added to the list of allowed urls: "
<< extraPatterns;
}
extraUrlPatternsSetting.endGroup();
}
return extraPatterns;
}
bool WebappContainer::isValidLocalResource(const QString& resourceName) const
{
QFileInfo info(resourceName);
return info.isFile() && info.exists();
}
bool WebappContainer::shouldNotValidateCommandLineUrls() const
{
return qEnvironmentVariableIsSet("WEBAPP_CONTAINER_SHOULD_NOT_VALIDATE_CLI_URLS")
&& QString(qgetenv("WEBAPP_CONTAINER_SHOULD_NOT_VALIDATE_CLI_URLS")) == "1";
}
QList<QUrl> WebappContainer::urls() const
{
QList<QUrl> urls;
Q_FOREACH(const QString& argument, m_arguments) {
if (!argument.startsWith("-")) {
// This is used for testing to avoid having existing
// resources to run against.
if (shouldNotValidateCommandLineUrls()) {
urls.append(argument.startsWith("file://")
? argument
: (QString("file://") + argument));
continue;
}
QUrl url;
if (isValidLocalResource(argument)) {
url = QUrl::fromLocalFile(QFileInfo(argument).absoluteFilePath());
} else {
url = QUrl::fromUserInput(argument);
}
if (url.isValid()) {
urls.append(url);
}
}
}
return urls;
}
int main(int argc, char** argv)
{
QCoreApplication::setAttribute(Qt::AA_ShareOpenGLContexts);
WebappContainer app(argc, argv);
if (app.initialize()) {
return app.run();
} else {
return 0;
}
}
|