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 434 435 436
|
/*
* SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "sharetestutils.h"
#include "testhelper.h"
using namespace OCC;
FakeShareDefinition::FakeShareDefinition(ShareTestHelper *helper,
const Share::ShareType type,
const QString &shareWith,
const QString &displayString,
const QString &password,
const QString ¬e,
const QString &expiration)
{
++helper->latestShareId;
const auto idString = QString::number(helper->latestShareId);
fileDefinition = helper->fakeFileDefinition;
shareId = idString;
shareCanDelete = true;
shareCanEdit = true;
shareUidOwner = helper->account->davUser();;
shareDisplayNameOwner = helper->account->davDisplayName();
sharePassword = password;
sharePermissions = static_cast<int>(SharePermissions(SharePermissionRead |
SharePermissionUpdate |
SharePermissionCreate |
SharePermissionDelete |
SharePermissionShare));
shareNote = note;
shareHideDownload = 0;
shareExpiration = expiration;
shareSendPasswordByTalk = false;
shareType = type;
const auto token = QString(QStringLiteral("GQ4aLrZEdJJkopW-") + idString);
// Weird, but it's what the server does
const auto finalShareWith = type == Share::TypeLink ? password : shareWith;
const auto shareWithDisplayName = type == Share::TypeLink ? QStringLiteral("(Shared Link)") : displayString;
const auto linkLabel = type == Share::TypeLink ? displayString : QString();
const auto linkName = linkShareLabel;
const auto linkUrl = type == Share::TypeLink ? QString(helper->account->davUrl().toString() + QStringLiteral("/s/") + token) : QString();
shareShareWith = finalShareWith;
shareShareWithDisplayName = shareWithDisplayName;
shareToken = token;
linkShareName = linkName;
linkShareLabel = linkLabel;
linkShareUrl = linkUrl;
}
QJsonObject FakeShareDefinition::toShareJsonObject() const
{
QJsonObject newShareJson;
newShareJson.insert("uid_file_owner", fileDefinition.fileOwnerUid);
newShareJson.insert("displayname_file_owner", fileDefinition.fileOwnerDisplayName);
newShareJson.insert("file_target", fileDefinition.fileTarget);
newShareJson.insert("has_preview", fileDefinition.fileHasPreview);
newShareJson.insert("file_parent", fileDefinition.fileFileParent);
newShareJson.insert("file_source", fileDefinition.fileSource);
newShareJson.insert("item_source", fileDefinition.fileItemSource);
newShareJson.insert("item_type", fileDefinition.fileItemType);
newShareJson.insert("mail_send", fileDefinition.fileMailSend);
newShareJson.insert("mimetype", fileDefinition.fileMimeType);
newShareJson.insert("parent", fileDefinition.fileParent);
newShareJson.insert("path", fileDefinition.filePath);
newShareJson.insert("storage", fileDefinition.fileStorage);
newShareJson.insert("storage_id", fileDefinition.fileStorageId);
newShareJson.insert("id", shareId);
newShareJson.insert("can_delete", shareCanDelete);
newShareJson.insert("can_edit", shareCanEdit);
newShareJson.insert("uid_owner", shareUidOwner);
newShareJson.insert("displayname_owner", shareDisplayNameOwner);
newShareJson.insert("password", sharePassword);
newShareJson.insert("permissions", sharePermissions);
newShareJson.insert("note", shareNote);
newShareJson.insert("hide_download", shareHideDownload);
newShareJson.insert("expiration", shareExpiration);
newShareJson.insert("send_password_by_talk", shareSendPasswordByTalk);
newShareJson.insert("share_type", shareType);
newShareJson.insert("share_with", shareShareWith);
newShareJson.insert("share_with_displayname", shareShareWithDisplayName);
newShareJson.insert("token", shareToken);
newShareJson.insert("name", linkShareName);
newShareJson.insert("label", linkShareLabel);
newShareJson.insert("url", linkShareUrl);
return newShareJson;
}
QByteArray FakeShareDefinition::toRequestReply() const
{
const auto shareJson = toShareJsonObject();
return jsonValueToOccReply(shareJson);
}
// Below is ShareTestHelper
ShareTestHelper::ShareTestHelper(QObject *parent)
: QObject(parent)
{
}
ShareTestHelper::~ShareTestHelper()
{
const auto folder = FolderMan::instance()->folder(fakeFolder.localPath());
if (folder) {
FolderMan::instance()->removeFolder(folder);
}
AccountManager::instance()->deleteAccount(accountState.data());
}
void ShareTestHelper::setup()
{
_fakeQnam.reset(new FakeQNAM({}));
_fakeQnam->setOverride([this](const QNetworkAccessManager::Operation op, const QNetworkRequest &req, QIODevice *device) {
return qnamOverride(op, req, device);
});
account = Account::create();
account->setCredentials(new FakeCredentials{_fakeQnam.data()});
account->setUrl(QUrl(("owncloud://somehost/owncloud")));
account->setCapabilities(_fakeCapabilities);
accountState = new AccountState(account);
AccountManager::instance()->addAccount(account);
QCOMPARE(fakeFolder.currentLocalState(), fakeFolder.currentRemoteState());
fakeFolder.localModifier().insert(testFileName);
const auto folderMan = FolderMan::instance();
QCOMPARE(folderMan, &fm);
auto folderDef = folderDefinition(fakeFolder.localPath());
folderDef.targetPath = QString();
QVERIFY(folderMan->addFolder(accountState.data(), folderDef));
const auto folder = FolderMan::instance()->folder(fakeFolder.localPath());
QVERIFY(folder);
QVERIFY(fakeFolder.syncOnce());
QCOMPARE(fakeFolder.currentLocalState(), fakeFolder.currentRemoteState());
const auto fakeFileInfo = fakeFolder.remoteModifier().find(testFileName);
QVERIFY(fakeFileInfo);
fakeFileInfo->permissions.setPermission(RemotePermissions::CanRead);
fakeFileInfo->permissions.setPermission(RemotePermissions::CanReshare);
QVERIFY(fakeFolder.syncOnce());
QCOMPARE(fakeFolder.currentLocalState(), fakeFolder.currentRemoteState());
QVERIFY(fakeFileInfo->permissions.CanReshare);
_fakeCapabilities = QVariantMap {
{QStringLiteral("files_sharing"), QVariantMap {
{QStringLiteral("api_enabled"), true},
{QStringLiteral("default_permissions"), 19},
{QStringLiteral("public"), QVariantMap {
{QStringLiteral("enabled"), true},
{QStringLiteral("expire_date"), QVariantMap {
{QStringLiteral("days"), 30},
{QStringLiteral("enforced"), false},
}},
{QStringLiteral("expire_date_internal"), QVariantMap {
{QStringLiteral("days"), 30},
{QStringLiteral("enforced"), false},
}},
{QStringLiteral("expire_date_remote"), QVariantMap {
{QStringLiteral("days"), 30},
{QStringLiteral("enforced"), false},
}},
{QStringLiteral("password"), QVariantMap {
{QStringLiteral("enforced"), false},
}},
}},
{QStringLiteral("sharebymail"), QVariantMap {
{QStringLiteral("enabled"), true},
{QStringLiteral("password"), QVariantMap {
{QStringLiteral("enforced"), false},
}},
}},
}},
};
// Generate test data
// Properties that apply to the file generally
const auto fileOwnerUid = account->davUser();
const auto fileOwnerDisplayName = account->davDisplayName();
const auto fileTarget = QString(QStringLiteral("/") + fakeFileInfo->name);
const auto fileHasPreview = true;
const auto fileFileParent = QString(fakeFolder.remoteModifier().fileId);
const auto fileSource = QString(fakeFileInfo->fileId);
const auto fileItemSource = fileSource;
const auto fileItemType = QStringLiteral("file");
const auto fileMailSend = 0;
const auto fileMimeType = QStringLiteral("text/markdown");
const auto fileParent = QString();
const auto filePath = fakeFileInfo->path();
const auto fileStorage = 3;
const auto fileStorageId = QString(QStringLiteral("home::") + account->davUser());
fakeFileDefinition = FakeFileReplyDefinition {
fileOwnerUid,
fileOwnerDisplayName,
fileTarget,
fileHasPreview,
fileFileParent,
fileSource,
fileItemSource,
fileItemType,
fileMailSend,
fileMimeType,
fileParent,
filePath,
fileStorage,
fileStorageId,
};
emit setupSucceeded();
}
QNetworkReply *ShareTestHelper::qnamOverride(QNetworkAccessManager::Operation op, const QNetworkRequest &req, QIODevice *device)
{
QNetworkReply *reply = nullptr;
const auto reqUrl = req.url();
const auto reqRawPath = reqUrl.path();
const auto reqPath = reqRawPath.startsWith("/owncloud/") ? reqRawPath.mid(10) : reqRawPath;
qDebug() << req.url() << reqPath << op;
// Properly formatted PROPFIND URL goes something like:
// https://cloud.nextcloud.com/remote.php/dav/files/claudio/Readme.md
if(reqPath.endsWith(testFileName) && req.attribute(QNetworkRequest::CustomVerbAttribute).toString() == "PROPFIND") {
reply = new FakePropfindReply(fakeFolder.remoteModifier(), op, req, this);
} else if (req.url().toString().startsWith(accountState->account()->url().toString()) &&
reqPath.startsWith(QStringLiteral("ocs/v2.php/apps/files_sharing/api/v1/shares"))) {
if (op == QNetworkAccessManager::PostOperation) {
reply = handleSharePostOperation(op, req, device);
} else if(req.attribute(QNetworkRequest::CustomVerbAttribute).toString() == "DELETE") {
reply = handleShareDeleteOperation(op, req, reqPath);
} else if(op == QNetworkAccessManager::PutOperation) {
reply = handleSharePutOperation(op, req, reqPath, device);
} else if(req.attribute(QNetworkRequest::CustomVerbAttribute).toString() == "GET") {
reply = handleShareGetOperation(op, req, reqPath);
}
} else {
reply = new FakeErrorReply(op, req, this, 404, _fake404Response);
}
return reply;
}
QNetworkReply *ShareTestHelper::handleSharePostOperation(QNetworkAccessManager::Operation op, const QNetworkRequest &req, QIODevice *device)
{
QNetworkReply *reply = nullptr;
// POST https://somehost/owncloud/ocs/v2.php/apps/files_sharing/api/v1/shares?format=json
// Header: { Ocs-APIREQUEST: true, Content-Type: application/x-www-form-urlencoded, X-Request-ID: 1527752d-e147-4da7-89b8-fb06315a5fad, }
// Data: [path=file.md&shareType=3]"
const QUrlQuery urlQuery(req.url());
const auto formatParam = urlQuery.queryItemValue(QStringLiteral("format"));
if (formatParam == QStringLiteral("json")) {
device->open(QIODevice::ReadOnly);
const auto requestBody = device->readAll();
device->close();
const auto requestData = requestBody.split('&');
// We don't care about path since we know the file we are testing with
auto requestShareType = -10; // Just in case
QString requestShareWith;
QString requestName;
QString requestPassword;
for(const auto &data : requestData) {
const auto requestDataUrl = QUrl::fromPercentEncoding(data);
const QString requestDataUrlString(requestDataUrl);
if (data.contains("shareType=")) {
const auto shareTypeString = requestDataUrlString.mid(10);
requestShareType = Share::ShareType(shareTypeString.toInt());
} else if (data.contains("shareWith=")) {
requestShareWith = data.mid(10);
} else if (data.contains("name=")) {
requestName = data.mid(5);
} else if (data.contains("password=")) {
requestPassword = data.mid(9);
}
}
if (requestPassword.isEmpty() &&
((requestShareType == Share::TypeEmail && account->capabilities().shareEmailPasswordEnforced()) ||
(requestShareType == Share::TypeLink && account->capabilities().sharePublicLinkEnforcePassword()))) {
reply = new FakePayloadReply(op, req, _fake403Response, searchResultsReplyDelay, _fakeQnam.data());
} else if (requestShareType >= 0) {
const auto shareType = Share::ShareType(requestShareType);
reply = new FakePayloadReply(op, req, createNewShare(shareType, requestShareWith, requestPassword), searchResultsReplyDelay, _fakeQnam.data());
}
}
return reply;
}
QNetworkReply *ShareTestHelper::handleSharePutOperation(const QNetworkAccessManager::Operation op, const QNetworkRequest &req, const QString &reqPath, QIODevice *device)
{
QNetworkReply *reply = nullptr;
const auto splitUrlPath = reqPath.split('/');
const auto shareId = splitUrlPath.last();
const QUrlQuery urlQuery(req.url());
const auto formatParam = urlQuery.queryItemValue(QStringLiteral("format"));
if (formatParam == QStringLiteral("json")) {
device->open(QIODevice::ReadOnly);
const auto requestBody = device->readAll();
device->close();
const auto requestData = requestBody.split('&');
const auto existingShareIterator = std::find_if(_sharesReplyData.cbegin(), _sharesReplyData.cend(), [&shareId](const QJsonValue &value) {
return value.toObject().value("id").toString() == shareId;
});
if (existingShareIterator == _sharesReplyData.cend()) {
reply = new FakeErrorReply(op, req, this, 404, _fake404Response);
} else {
const auto existingShareValue = *existingShareIterator;
auto shareObject = existingShareValue.toObject();
for (const auto &requestDataItem : requestData) {
const auto requestSplit = requestDataItem.split('=');
auto requestKey = requestSplit.first();
auto requestValue = requestSplit.last();
// We send expireDate without time but the server returns with time at 00:00:00
if (requestKey == "expireDate") {
requestKey = "expiration";
requestValue.append(" 00:00:00");
}
shareObject.insert(QString(requestKey), QString(requestValue));
}
_sharesReplyData.replace(existingShareIterator - _sharesReplyData.cbegin(), shareObject);
reply = new FakePayloadReply(op, req, jsonValueToOccReply(shareObject), searchResultsReplyDelay, _fakeQnam.data());
}
}
return reply;
}
QNetworkReply *ShareTestHelper::handleShareDeleteOperation(const QNetworkAccessManager::Operation op, const QNetworkRequest &req, const QString &reqPath)
{
QNetworkReply *reply = nullptr;
const auto splitUrlPath = reqPath.split('/');
const auto shareId = splitUrlPath.last();
const auto existingShareIterator = std::find_if(_sharesReplyData.cbegin(), _sharesReplyData.cend(), [&shareId](const QJsonValue &value) {
return value.toObject().value("id").toString() == shareId;
});
if (existingShareIterator == _sharesReplyData.cend()) {
reply = new FakeErrorReply(op, req, this, 404, _fake404Response);
} else {
_sharesReplyData.removeAt(existingShareIterator - _sharesReplyData.cbegin());
reply = new FakePayloadReply(op, req, _fake200JsonResponse, searchResultsReplyDelay, _fakeQnam.data());
}
return reply;
}
QNetworkReply *ShareTestHelper::handleShareGetOperation(const QNetworkAccessManager::Operation op, const QNetworkRequest &req, const QString &reqPath)
{
QNetworkReply *reply = nullptr;
// Properly formatted request to fetch shares goes something like:
// GET https://somehost/owncloud/ocs/v2.php/apps/files_sharing/api/v1/shares?path=file.md&reshares=true&format=json
// Header: { Ocs-APIREQUEST: true, Content-Type: application/x-www-form-urlencoded, X-Request-ID: 8ba8960d-ca0d-45ba-abf4-03ab95ba6064, }
// Data: []
const auto urlQuery = QUrlQuery(req.url());
const auto pathParam = urlQuery.queryItemValue(QStringLiteral("path"));
const auto resharesParam = urlQuery.queryItemValue(QStringLiteral("reshares"));
const auto formatParam = urlQuery.queryItemValue(QStringLiteral("format"));
if (formatParam != QStringLiteral("json") || (!pathParam.isEmpty() && !pathParam.endsWith(QString(testFileName)))) {
reply = new FakeErrorReply(op, req, this, 400, _fake400Response);
} else if (reqPath.contains(QStringLiteral("ocs/v2.php/apps/files_sharing/api/v1/shares"))) {
reply = new FakePayloadReply(op, req, jsonValueToOccReply(_sharesReplyData), searchResultsReplyDelay, _fakeQnam.data());
}
return reply;
}
const QByteArray ShareTestHelper::createNewShare(const Share::ShareType shareType, const QString &shareWith, const QString &password)
{
const auto displayString = shareType == Share::TypeLink ? QString() : shareWith;
const FakeShareDefinition newShareDefinition(this,
shareType,
shareWith,
displayString,
password);
_sharesReplyData.append(newShareDefinition.toShareJsonObject());
return newShareDefinition.toRequestReply();
}
int ShareTestHelper::shareCount() const
{
return _sharesReplyData.count();
}
void ShareTestHelper::appendShareReplyData(const FakeShareDefinition &definition)
{
_sharesReplyData.append(definition.toShareJsonObject());
}
void ShareTestHelper::resetTestShares()
{
_sharesReplyData = QJsonArray();
}
void ShareTestHelper::resetTestData()
{
resetTestShares();
account->setCapabilities(_fakeCapabilities);
}
|