Add WebAPI/WebUI for managing cookies

Closes #21125.
PR #21340.
This commit is contained in:
Thomas Piccirello
2024-09-30 05:13:25 -04:00
committed by GitHub
parent 10eb921d70
commit 6bbb7b71cd
10 changed files with 285 additions and 29 deletions

View File

@@ -41,6 +41,7 @@
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonObject>
#include <QNetworkCookie>
#include <QNetworkInterface>
#include <QRegularExpression>
#include <QStringList>
@@ -50,6 +51,7 @@
#include "base/bittorrent/session.h"
#include "base/global.h"
#include "base/interfaces/iapplication.h"
#include "base/net/downloadmanager.h"
#include "base/net/portforwarder.h"
#include "base/net/proxyconfigurationmanager.h"
#include "base/path.h"
@@ -58,6 +60,7 @@
#include "base/rss/rss_session.h"
#include "base/torrentfileguard.h"
#include "base/torrentfileswatcher.h"
#include "base/utils/datetime.h"
#include "base/utils/fs.h"
#include "base/utils/misc.h"
#include "base/utils/net.h"
@@ -69,6 +72,12 @@
using namespace std::chrono_literals;
const QString KEY_COOKIE_NAME = u"name"_s;
const QString KEY_COOKIE_DOMAIN = u"domain"_s;
const QString KEY_COOKIE_PATH = u"path"_s;
const QString KEY_COOKIE_VALUE = u"value"_s;
const QString KEY_COOKIE_EXPIRATION_DATE = u"expirationDate"_s;
void AppController::webapiVersionAction()
{
setResult(API_VERSION.toString());
@@ -1187,6 +1196,63 @@ void AppController::getDirectoryContentAction()
setResult(ret);
}
void AppController::cookiesAction()
{
const QList<QNetworkCookie> cookies = Net::DownloadManager::instance()->allCookies();
QJsonArray ret;
for (const QNetworkCookie &cookie : cookies)
{
ret << QJsonObject {
{KEY_COOKIE_NAME, QString::fromLatin1(cookie.name())},
{KEY_COOKIE_DOMAIN, cookie.domain()},
{KEY_COOKIE_PATH, cookie.path()},
{KEY_COOKIE_VALUE, QString::fromLatin1(cookie.value())},
{KEY_COOKIE_EXPIRATION_DATE, Utils::DateTime::toSecsSinceEpoch(cookie.expirationDate())},
};
}
setResult(ret);
}
void AppController::setCookiesAction()
{
requireParams({u"cookies"_s});
const QString cookiesParam {params()[u"cookies"_s].trimmed()};
QJsonParseError jsonError;
const auto cookiesJsonDocument = QJsonDocument::fromJson(cookiesParam.toUtf8(), &jsonError);
if (jsonError.error != QJsonParseError::NoError)
throw APIError(APIErrorType::BadParams, jsonError.errorString());
if (!cookiesJsonDocument.isArray())
throw APIError(APIErrorType::BadParams, tr("cookies must be array"));
const QJsonArray cookiesJsonArr = cookiesJsonDocument.array();
QList<QNetworkCookie> cookies;
cookies.reserve(cookiesJsonArr.size());
for (const QJsonValue &jsonVal : cookiesJsonArr)
{
if (!jsonVal.isObject())
throw APIError(APIErrorType::BadParams);
QNetworkCookie cookie;
const QJsonObject jsonObj = jsonVal.toObject();
if (jsonObj.contains(KEY_COOKIE_NAME))
cookie.setName(jsonObj.value(KEY_COOKIE_NAME).toString().toLatin1());
if (jsonObj.contains(KEY_COOKIE_DOMAIN))
cookie.setDomain(jsonObj.value(KEY_COOKIE_DOMAIN).toString());
if (jsonObj.contains(KEY_COOKIE_PATH))
cookie.setPath(jsonObj.value(KEY_COOKIE_PATH).toString());
if (jsonObj.contains(KEY_COOKIE_VALUE))
cookie.setValue(jsonObj.value(KEY_COOKIE_VALUE).toString().toUtf8());
if (jsonObj.contains(KEY_COOKIE_EXPIRATION_DATE))
cookie.setExpirationDate(QDateTime::fromSecsSinceEpoch(jsonObj.value(KEY_COOKIE_EXPIRATION_DATE).toInteger()));
cookies << cookie;
}
Net::DownloadManager::instance()->setAllCookies(cookies);
}
void AppController::networkInterfaceListAction()
{
QJsonArray ifaceList;

View File

@@ -50,6 +50,8 @@ private slots:
void defaultSavePathAction();
void sendTestEmailAction();
void getDirectoryContentAction();
void cookiesAction();
void setCookiesAction();
void networkInterfaceListAction();
void networkInterfaceAddressListAction();

View File

@@ -34,7 +34,6 @@
#include <QJsonArray>
#include <QJsonObject>
#include <QList>
#include <QNetworkCookie>
#include <QRegularExpression>
#include <QUrl>
@@ -53,7 +52,6 @@
#include "base/interfaces/iapplication.h"
#include "base/global.h"
#include "base/logger.h"
#include "base/net/downloadmanager.h"
#include "base/torrentfilter.h"
#include "base/utils/datetime.h"
#include "base/utils/fs.h"
@@ -787,7 +785,6 @@ void TorrentsController::pieceStatesAction()
void TorrentsController::addAction()
{
const QString urls = params()[u"urls"_s];
const QString cookie = params()[u"cookie"_s];
const bool skipChecking = parseBool(params()[u"skip_checking"_s]).value_or(false);
const bool seqDownload = parseBool(params()[u"sequentialDownload"_s]).value_or(false);
@@ -818,23 +815,6 @@ void TorrentsController::addAction()
? Utils::String::toEnum(contentLayoutParam, BitTorrent::TorrentContentLayout::Original)
: std::optional<BitTorrent::TorrentContentLayout> {});
QList<QNetworkCookie> cookies;
if (!cookie.isEmpty())
{
const QStringList cookiesStr = cookie.split(u"; "_s);
for (QString cookieStr : cookiesStr)
{
cookieStr = cookieStr.trimmed();
int index = cookieStr.indexOf(u'=');
if (index > 1)
{
QByteArray name = cookieStr.left(index).toLatin1();
QByteArray value = cookieStr.right(cookieStr.length() - index - 1).toLatin1();
cookies += QNetworkCookie(name, value);
}
}
}
const BitTorrent::AddTorrentParams addTorrentParams
{
// TODO: Check if destination actually exists
@@ -875,7 +855,6 @@ void TorrentsController::addAction()
url = url.trimmed();
if (!url.isEmpty())
{
Net::DownloadManager::instance()->setCookiesFromUrl(cookies, QUrl::fromEncoded(url.toUtf8()));
partialSuccess |= app()->addTorrentManager()->addTorrent(url, addTorrentParams);
}
}