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
|
/*
* Copyright 2014 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 "hook-utils.h"
#include <QDateTime>
#include <QDebug>
#include <QFileInfo>
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonObject>
#include <QStandardPaths>
namespace {
QString shortAppIdFromUnversionedAppId(const QString& appId)
{
QStringList components = appId.split('_');
components.removeLast();
return components.join('_');
}
QString stringFromClickLifeCyclePhase(
HookUtils::WebappHookParser::ClickLifeCyclePhase phase)
{
using namespace HookUtils;
switch(phase) {
case WebappHookParser::CLICK_LIFECYCLE_PHASE_INSTALL:
return "install";
break;
case WebappHookParser::CLICK_LIFECYCLE_PHASE_UNINSTALL:
return "uninstall";
break;
case WebappHookParser::CLICK_LIFECYCLE_PHASE_UPDATE:
return "update";
break;
}
return QString();
}
void executeHookDirectives(const QString& hookFilename,
HookUtils::WebappHookParser::ClickLifeCyclePhase phase) {
QFileInfo fileInfo(hookFilename);
if (!fileInfo.exists() || !fileInfo.isFile())
{
qDebug() << "Cannot execute directives for" << hookFilename;
return;
}
qDebug() << "Handling" << hookFilename;
HookUtils::WebappHookParser webappHookParser;
HookUtils::WebappHookParser::Data data =
webappHookParser.parseContent(
hookFilename,
phase);
QString appIdNoVersion = fileInfo.fileName();
if (data.shouldDeleteCache)
{
QDir dir(QStandardPaths::writableLocation(QStandardPaths::GenericCacheLocation)
+ "/" + shortAppIdFromUnversionedAppId(appIdNoVersion));
dir.removeRecursively();
qDebug() << "Removing cache from" << dir.absolutePath();
}
if (data.shouldDeleteCookies)
{
QDir dir(QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation)
+ "/" + shortAppIdFromUnversionedAppId(appIdNoVersion));
dir.removeRecursively();
qDebug() << "Removing cookies from" << dir.absolutePath();
}
}
}
namespace HookUtils {
WebappHookParser::Data
WebappHookParser::parseContent(const QString& filename,
ClickLifeCyclePhase clickLifeCyclePhase)
{
QFileInfo info(filename);
if (!info.exists() || !info.isFile() || !info.isReadable())
{
return Data();
}
QFile file(filename);
if (!file.open(QIODevice::ReadOnly))
{
qWarning() << "Cannot open webapp hook: " << filename;
return Data();
}
QJsonDocument document(QJsonDocument::fromJson(file.readAll()));
if (document.isNull() || document.isEmpty() || !document.isArray()) {
return Data();
}
return parseDocument(
document.array(),
clickLifeCyclePhase);
}
WebappHookParser::Data
WebappHookParser::parseDocument(const QJsonArray& array,
ClickLifeCyclePhase clickLifeCyclePhase)
{
Data result;
if (array.count() == 0
|| !array.at(0).isObject())
{
return result;
}
QJsonObject rootObject = array.at(0).toObject();
#define JSON_OBJECT_VALIDATE(o,key,predicate) \
o.contains(key) && o.value(key).predicate()
QString phase = stringFromClickLifeCyclePhase(clickLifeCyclePhase);
if (JSON_OBJECT_VALIDATE(rootObject,phase,isObject))
{
const QString DELETE_COOKIES = "delete-cookies";
const QString DELETE_CACHE = "delete-cache";
QJsonObject directiveObject =
rootObject.value(phase).toObject();
if (JSON_OBJECT_VALIDATE(directiveObject,DELETE_COOKIES,isBool))
{
result.shouldDeleteCookies =
directiveObject.value(DELETE_COOKIES).toBool();
}
if (JSON_OBJECT_VALIDATE(directiveObject,DELETE_CACHE,isBool))
{
result.shouldDeleteCache =
directiveObject.value(DELETE_CACHE).toBool();
}
}
#undef JSON_OBJECT_VALIDATE
return result;
}
WebappClickHookInstallDescription
listWebappProcessedClickHookFilesIn(const QDir& dir)
{
WebappClickHookInstallDescription
description(dir.absolutePath(), QHash<QString, QString>());
Q_FOREACH(const QFileInfo& fileInfo, dir.entryInfoList())
{
if (fileInfo.isFile())
{
QString filename = fileInfo.fileName();
description.hookFiles[filename] = filename;
}
}
return description;
}
WebappClickHookInstallDescription
listWebappInstalledClickHookFilesIn(const QDir& dir)
{
WebappClickHookInstallDescription
description(dir.absolutePath(), QHash<QString, QString>());
const QString WEBAPP_CLICK_HOOK_FILE_EXT = "webapp";
Q_FOREACH(const QFileInfo& fileInfo, dir.entryInfoList())
{
if (fileInfo.suffix() == WEBAPP_CLICK_HOOK_FILE_EXT)
{
description.hookFiles[removeVersionFrom(fileInfo.completeBaseName())] =
fileInfo.fileName();
}
}
return description;
}
QString
getProcessedClickHooksFolder()
{
QString result = QStandardPaths::writableLocation(QStandardPaths::GenericCacheLocation)
+ "/webapp-container";
if (!qgetenv("WEBAPPCONTAINER_PROCESSED_HOOKS_FOLDER").isNull())
{
result = QString(qgetenv("WEBAPPCONTAINER_PROCESSED_HOOKS_FOLDER"));
}
return result;
}
QString
getClickHooksInstallFolder()
{
QString result = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation)
+ "/webapp-container";
if (!qgetenv("WEBAPPCONTAINER_INSTALLED_HOOKS_FOLDER").isNull())
{
result = QString(qgetenv("WEBAPPCONTAINER_INSTALLED_HOOKS_FOLDER"));
}
return result;
}
QString removeVersionFrom(const QString& appId)
{
QStringList components = appId.split('_');
if (components.count() != 3)
{
return appId;
}
components.removeLast();
return components.join('_');
}
void handleInstalls(const WebappClickHookInstallDescription& alreadyProcessedClickHooks
, const WebappClickHookInstallDescription& installedClickHooks)
{
QStringList newlyInstalledClickPackages =
installedClickHooks.hookFiles.keys().toSet().subtract(
alreadyProcessedClickHooks.hookFiles.keys().toSet()).toList();
if (newlyInstalledClickPackages.isEmpty())
{
qDebug() << "Nothing to install.";
return;
}
Q_FOREACH(const QString& webappClickHook, newlyInstalledClickPackages)
{
QString hookFilename =
installedClickHooks.parentFolder + "/"
+ installedClickHooks.hookFiles[webappClickHook];
executeHookDirectives(hookFilename,
WebappHookParser::CLICK_LIFECYCLE_PHASE_INSTALL);
QFileInfo hookFileInfo(hookFilename);
QString appIdNoVersion = removeVersionFrom(hookFileInfo.completeBaseName());
QString destination = QString("%1/%2").
arg(alreadyProcessedClickHooks.parentFolder).arg(appIdNoVersion);
qDebug() << "Installing: " << destination;
QFile::copy(hookFilename, destination);
}
}
void handleUninstall(const WebappClickHookInstallDescription& alreadyProcessedClickHooks
, const WebappClickHookInstallDescription& currentClickHooks)
{
QStringList deletedClickPackages =
alreadyProcessedClickHooks.hookFiles.keys().toSet().subtract(
currentClickHooks.hookFiles.keys().toSet()).toList();
if (deletedClickPackages.count() == 0)
{
qDebug() << "Nothing to delete.";
return;
}
Q_FOREACH(const QString& webappClickHook, deletedClickPackages)
{
QString hookFilename =
alreadyProcessedClickHooks.parentFolder + "/" + webappClickHook;
executeHookDirectives(hookFilename,
WebappHookParser::CLICK_LIFECYCLE_PHASE_UNINSTALL);
qDebug() << "Uninstalling: " << hookFilename;
QFile::remove(hookFilename);
}
}
void handleUpdates(const WebappClickHookInstallDescription& alreadyProcessedClickHooks
, const WebappClickHookInstallDescription& installedClickHooks)
{
QStringList foundClickHooks =
alreadyProcessedClickHooks.hookFiles.keys().toSet().intersect(
installedClickHooks.hookFiles.keys().toSet()).toList();
if (foundClickHooks.count() == 0)
{
qDebug() << "Nothing to update.";
return;
}
Q_FOREACH(const QString& webappClickHook, foundClickHooks)
{
QString hookFilename =
installedClickHooks.parentFolder + "/"
+ installedClickHooks.hookFiles[webappClickHook];
QFileInfo hookFileInfo(hookFilename);
QString appIdNoVersion = removeVersionFrom(hookFileInfo.completeBaseName());
QString destination = QString("%1/%2").
arg(alreadyProcessedClickHooks.parentFolder).arg(appIdNoVersion);
QFileInfo destinationInfo(destination);
if (destinationInfo.exists() &&
destinationInfo.lastModified() >= hookFileInfo.lastModified()) {
continue;
}
executeHookDirectives(hookFilename,
WebappHookParser::CLICK_LIFECYCLE_PHASE_UPDATE);
qDebug() << "Updating " << destination;
if (QFile::exists(destination))
{
QFile::remove(destination);
}
QFile::copy(hookFilename, destination);
}
}
}
|