nextcloud-desktop/src/libsync/networkjobs.h

513 lines
14 KiB
C
Raw Normal View History

2013-12-13 23:27:08 +04:00
/*
* Copyright (C) by Klaas Freitag <freitag@owncloud.com>
* Copyright (C) by Daniel Molkentin <danimo@owncloud.com>
*
* This program 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; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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.
*/
#ifndef NETWORKJOBS_H
#define NETWORKJOBS_H
#include "abstractnetworkjob.h"
#include "common/result.h"
2018-10-15 17:51:24 +03:00
#include <QBuffer>
#include <QUrlQuery>
#include <functional>
class QUrl;
2017-04-26 13:15:33 +03:00
class QJsonObject;
2014-11-10 00:34:07 +03:00
namespace OCC {
/** Strips quotes and gzip annotations */
2019-06-28 18:26:54 +03:00
OWNCLOUDSYNC_EXPORT QByteArray parseEtag(const char *header);
struct HttpError
{
int code; // HTTP error code
QString message;
};
template <typename T>
using HttpResult = Result<T, HttpError>;
2015-06-29 19:56:09 +03:00
/**
* @brief The EntityExistsJob class
* @ingroup libsync
*/
2017-05-17 11:55:42 +03:00
class OWNCLOUDSYNC_EXPORT EntityExistsJob : public AbstractNetworkJob
{
Q_OBJECT
public:
explicit EntityExistsJob(AccountPtr account, const QString &path, QObject *parent = nullptr);
void start() override;
2013-11-14 22:20:09 +04:00
signals:
2017-05-17 11:55:42 +03:00
void exists(QNetworkReply *);
private slots:
bool finished() override;
};
/**
* @brief sends a DELETE http request to a url.
*
* See Nextcloud API usage for the possible DELETE requests.
*
* This does *not* delete files, it does a http request.
*/
class OWNCLOUDSYNC_EXPORT DeleteApiJob : public AbstractNetworkJob
{
Q_OBJECT
public:
explicit DeleteApiJob(AccountPtr account, const QString &path, QObject *parent = nullptr);
void start() override;
signals:
void result(int httpCode);
private slots:
bool finished() override;
};
struct ExtraFolderInfo {
QByteArray fileId;
qint64 size = -1;
};
2015-06-29 19:56:09 +03:00
/**
* @brief The LsColJob class
* @ingroup libsync
*/
2017-05-17 11:55:42 +03:00
class OWNCLOUDSYNC_EXPORT LsColXMLParser : public QObject
{
2015-04-14 14:41:51 +03:00
Q_OBJECT
public:
explicit LsColXMLParser();
bool parse(const QByteArray &xml,
QHash<QString, ExtraFolderInfo> *sizes,
const QString &expectedPath);
2015-04-14 14:41:51 +03:00
signals:
void directoryListingSubfolders(const QStringList &items);
2017-05-17 11:55:42 +03:00
void directoryListingIterated(const QString &name, const QMap<QString, QString> &properties);
2015-04-14 14:41:51 +03:00
void finishedWithError(QNetworkReply *reply);
void finishedWithoutError();
};
2017-05-17 11:55:42 +03:00
class OWNCLOUDSYNC_EXPORT LsColJob : public AbstractNetworkJob
{
Q_OBJECT
public:
explicit LsColJob(AccountPtr account, const QString &path, QObject *parent = nullptr);
explicit LsColJob(AccountPtr account, const QUrl &url, QObject *parent = nullptr);
void start() override;
QHash<QString, ExtraFolderInfo> _folderInfos;
/**
* Used to specify which properties shall be retrieved.
*
* The properties can
* - contain no colon: they refer to a property in the DAV: namespace
* - contain a colon: and thus specify an explicit namespace,
* e.g. "ns:with:colons:bar", which is "bar" in the "ns:with:colons" namespace
*/
void setProperties(QList<QByteArray> properties);
QList<QByteArray> properties() const;
signals:
void directoryListingSubfolders(const QStringList &items);
2017-05-17 11:55:42 +03:00
void directoryListingIterated(const QString &name, const QMap<QString, QString> &properties);
void finishedWithError(QNetworkReply *reply);
void finishedWithoutError();
private slots:
bool finished() override;
private:
QList<QByteArray> _properties;
2016-08-02 18:14:44 +03:00
QUrl _url; // Used instead of path() if the url is specified in the constructor
};
2015-06-29 19:56:09 +03:00
/**
* @brief The PropfindJob class
2015-02-26 14:36:11 +03:00
*
* Setting the desired properties with setProperties() is mandatory.
*
* Note that this job is only for querying one item.
* There is also the LsColJob which can be used to list collections
*
2015-06-29 19:56:09 +03:00
* @ingroup libsync
2013-10-23 16:48:44 +04:00
*/
2017-05-17 11:55:42 +03:00
class OWNCLOUDSYNC_EXPORT PropfindJob : public AbstractNetworkJob
{
2013-10-23 16:48:44 +04:00
Q_OBJECT
public:
explicit PropfindJob(AccountPtr account, const QString &path, QObject *parent = nullptr);
void start() override;
2015-02-26 14:36:11 +03:00
/**
* Used to specify which properties shall be retrieved.
*
* The properties can
* - contain no colon: they refer to a property in the DAV: namespace
* - contain a colon: and thus specify an explicit namespace,
* e.g. "ns:with:colons:bar", which is "bar" in the "ns:with:colons" namespace
*/
2013-11-14 22:20:09 +04:00
void setProperties(QList<QByteArray> properties);
QList<QByteArray> properties() const;
2013-10-23 16:48:44 +04:00
signals:
void result(const QVariantMap &values);
void finishedWithError(QNetworkReply *reply = nullptr);
2013-10-23 16:48:44 +04:00
private slots:
bool finished() override;
2013-11-14 22:20:09 +04:00
private:
QList<QByteArray> _properties;
2013-10-23 16:48:44 +04:00
};
#ifndef TOKEN_AUTH_ONLY
/**
* @brief Retrieves the account users avatar from the server using a GET request.
*
* If the server does not have the avatar, the result Pixmap is empty.
*
* @ingroup libsync
*/
2017-05-17 11:55:42 +03:00
class OWNCLOUDSYNC_EXPORT AvatarJob : public AbstractNetworkJob
{
Q_OBJECT
public:
/**
* @param userId The user for which to obtain the avatar
* @param size The size of the avatar (square so size*size)
*/
explicit AvatarJob(AccountPtr account, const QString &userId, int size, QObject *parent = nullptr);
void start() override;
/** The retrieved avatar images don't have the circle shape by default */
static QImage makeCircularAvatar(const QImage &baseAvatar);
signals:
/**
* @brief avatarPixmap - returns either a valid pixmap or not.
*/
void avatarPixmap(const QImage &);
private slots:
bool finished() override;
private:
QUrl _avatarUrl;
};
#endif
2015-11-12 13:20:45 +03:00
/**
* @brief Send a Proppatch request
*
* Setting the desired properties with setProperties() is mandatory.
*
* WARNING: Untested!
*
* @ingroup libsync
*/
2017-05-17 11:55:42 +03:00
class OWNCLOUDSYNC_EXPORT ProppatchJob : public AbstractNetworkJob
{
2015-11-12 13:20:45 +03:00
Q_OBJECT
public:
explicit ProppatchJob(AccountPtr account, const QString &path, QObject *parent = nullptr);
void start() override;
2015-11-12 13:20:45 +03:00
/**
* Used to specify which properties shall be set.
*
* The property keys can
* - contain no colon: they refer to a property in the DAV: namespace
* - contain a colon: and thus specify an explicit namespace,
* e.g. "ns:with:colons:bar", which is "bar" in the "ns:with:colons" namespace
*/
void setProperties(QMap<QByteArray, QByteArray> properties);
QMap<QByteArray, QByteArray> properties() const;
signals:
void success();
void finishedWithError();
private slots:
bool finished() override;
2015-11-12 13:20:45 +03:00
private:
QMap<QByteArray, QByteArray> _properties;
};
2013-10-23 16:48:44 +04:00
/**
2015-06-29 19:56:09 +03:00
* @brief The MkColJob class
* @ingroup libsync
2013-10-23 16:48:44 +04:00
*/
2017-05-17 11:55:42 +03:00
class OWNCLOUDSYNC_EXPORT MkColJob : public AbstractNetworkJob
{
Q_OBJECT
QUrl _url; // Only used if the constructor taking a url is taken.
QMap<QByteArray, QByteArray> _extraHeaders;
2017-05-17 11:55:42 +03:00
public:
explicit MkColJob(AccountPtr account, const QString &path, QObject *parent = nullptr);
explicit MkColJob(AccountPtr account, const QString &path, const QMap<QByteArray, QByteArray> &extraHeaders, QObject *parent = nullptr);
explicit MkColJob(AccountPtr account, const QUrl &url,
const QMap<QByteArray, QByteArray> &extraHeaders, QObject *parent = nullptr);
void start() override;
signals:
void finished(QNetworkReply::NetworkError);
private slots:
bool finished() override;
};
2015-06-29 19:56:09 +03:00
/**
* @brief The CheckServerJob class
* @ingroup libsync
*/
2017-05-17 11:55:42 +03:00
class OWNCLOUDSYNC_EXPORT CheckServerJob : public AbstractNetworkJob
{
Q_OBJECT
public:
explicit CheckServerJob(AccountPtr account, QObject *parent = nullptr);
void start() override;
2013-10-23 16:48:44 +04:00
2017-04-26 13:15:33 +03:00
static QString version(const QJsonObject &info);
static QString versionString(const QJsonObject &info);
static bool installed(const QJsonObject &info);
signals:
/** Emitted when a status.php was successfully read.
*
* \a url see _serverStatusUrl (does not include "/status.php")
* \a info The status.php reply information
*/
2017-05-17 11:55:42 +03:00
void instanceFound(const QUrl &url, const QJsonObject &info);
/** Emitted on invalid status.php reply.
*
* \a reply is never null
*/
void instanceNotFound(QNetworkReply *reply);
/** A timeout occurred.
*
* \a url The specific url where the timeout happened.
*/
2017-05-17 11:55:42 +03:00
void timeout(const QUrl &url);
private:
bool finished() override;
void onTimedOut() override;
private slots:
virtual void metaDataChangedSlot();
2015-08-11 13:18:25 +03:00
virtual void encryptedSlot();
void slotRedirected(QNetworkReply *reply, const QUrl &targetUrl, int redirectCount);
private:
bool _subdirFallback;
/** The permanent-redirect adjusted account url.
*
* Note that temporary redirects or a permanent redirect behind a temporary
* one do not affect this url.
*/
QUrl _serverUrl;
/** Keep track of how many permanent redirect were applied. */
int _permanentRedirects;
};
2015-06-29 19:56:09 +03:00
/**
* @brief The RequestEtagJob class
*/
2017-05-17 11:55:42 +03:00
class OWNCLOUDSYNC_EXPORT RequestEtagJob : public AbstractNetworkJob
{
Q_OBJECT
public:
explicit RequestEtagJob(AccountPtr account, const QString &path, QObject *parent = nullptr);
void start() override;
signals:
void etagRetrieved(const QString &etag, const QDateTime &time);
void finishedWithResult(const HttpResult<QString> &etag);
private slots:
bool finished() override;
};
/**
* @brief Job to check an API that return JSON
*
* Note! you need to be in the connected state before calling this because of a server bug:
* https://github.com/owncloud/core/issues/12930
*
* To be used like this:
* \code
* _job = new JsonApiJob(account, QLatin1String("ocs/v1.php/foo/bar"), this);
2017-04-26 13:15:33 +03:00
* connect(job, SIGNAL(jsonReceived(QJsonDocument)), ...)
* The received QVariantMap is null in case of error
* \encode
*
2015-06-29 19:56:09 +03:00
* @ingroup libsync
*/
2017-05-17 11:55:42 +03:00
class OWNCLOUDSYNC_EXPORT JsonApiJob : public AbstractNetworkJob
{
Q_OBJECT
public:
explicit JsonApiJob(const AccountPtr &account, const QString &path, QObject *parent = nullptr);
/**
* @brief addQueryParams - add more parameters to the ocs call
* @param params: list pairs of strings containing the parameter name and the value.
*
* All parameters from the passed list are appended to the query. Note
* that the format=json parameter is added automatically and does not
* need to be set this way.
*
* This function needs to be called before start() obviously.
*/
void addQueryParams(const QUrlQuery &params);
void addRawHeader(const QByteArray &headerName, const QByteArray &value);
/**
* @brief usePOST - allow job to do an anonymous POST request instead of GET
* @param params: (optional) true for POST, false for GET (default).
*
* This function needs to be called before start() obviously.
*/
void usePOST(bool usePOST = true) {
_usePOST = usePOST;
}
public slots:
void start() override;
2017-05-17 11:55:42 +03:00
protected:
bool finished() override;
signals:
/**
* @brief jsonReceived - signal to report the json answer from ocs
2017-04-26 13:15:33 +03:00
* @param json - the parsed json document
* @param statusCode - the OCS status code: 100 (!) for success
*/
2017-04-26 13:15:33 +03:00
void jsonReceived(const QJsonDocument &json, int statusCode);
/**
* @brief etagResponseHeaderReceived - signal to report the ETag response header value
* from ocs api v2
* @param value - the ETag response header value
* @param statusCode - the OCS status code: 100 (!) for success
*/
void etagResponseHeaderReceived(const QByteArray &value, int statusCode);
/**
* @brief desktopNotificationStatusReceived - signal to report if notifications are allowed
* @param status - set desktop notifications allowed status
*/
void allowDesktopNotificationsChanged(bool isAllowed);
private:
QUrlQuery _additionalParams;
QNetworkRequest _request;
bool _usePOST = false;
};
/**
* @brief Checks with auth type to use for a server
* @ingroup libsync
*/
class OWNCLOUDSYNC_EXPORT DetermineAuthTypeJob : public QObject
{
Q_OBJECT
public:
enum AuthType {
NoAuthType, // used only before we got a chance to probe the server
Basic, // also the catch-all fallback for backwards compatibility reasons
OAuth,
WebViewFlow,
LoginFlowV2
};
Q_ENUM(AuthType)
explicit DetermineAuthTypeJob(AccountPtr account, QObject *parent = nullptr);
void start();
signals:
void authType(AuthType);
private:
void checkAllDone();
AccountPtr _account;
AuthType _resultGet = NoAuthType;
AuthType _resultPropfind = NoAuthType;
AuthType _resultOldFlow = NoAuthType;
bool _getDone = false;
bool _propfindDone = false;
bool _oldFlowDone = false;
};
/**
* @brief A basic job around a network request without extra funtionality
* @ingroup libsync
*
* Primarily adds timeout and redirection handling.
*/
class OWNCLOUDSYNC_EXPORT SimpleNetworkJob : public AbstractNetworkJob
{
Q_OBJECT
public:
explicit SimpleNetworkJob(AccountPtr account, QObject *parent = nullptr);
QNetworkReply *startRequest(const QByteArray &verb, const QUrl &url,
QNetworkRequest req = QNetworkRequest(),
QIODevice *requestBody = nullptr);
signals:
void finishedSignal(QNetworkReply *reply);
private slots:
bool finished() override;
};
/**
* @brief Runs a PROPFIND to figure out the private link url
*
* The numericFileId is used only to build the deprecatedPrivateLinkUrl
* locally as a fallback. If it's empty and the PROPFIND fails, targetFun
* will be called with an empty string.
*
* The job and signal connections are parented to the target QObject.
*
* Note: targetFun is guaranteed to be called only through the event
* loop and never directly.
*/
void OWNCLOUDSYNC_EXPORT fetchPrivateLinkUrl(
AccountPtr account, const QString &remotePath,
const QByteArray &numericFileId, QObject *target,
std::function<void(const QString &url)> targetFun);
2014-11-10 00:34:07 +03:00
} // namespace OCC
#endif // NETWORKJOBS_H