mirror of
https://github.com/nextcloud/desktop.git
synced 2024-12-19 12:22:16 +03:00
159 lines
4.2 KiB
C++
159 lines
4.2 KiB
C++
/*
|
|
* Copyright (C) by Roeland Jago Douma <roeland@famdouma.nl>
|
|
*
|
|
* 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 OCSJOB_H
|
|
#define OCSJOB_H
|
|
|
|
#include "accountfwd.h"
|
|
#include "abstractnetworkjob.h"
|
|
|
|
#include <QVector>
|
|
#include <QHash>
|
|
#include <QUrl>
|
|
|
|
#define OCS_SUCCESS_STATUS_CODE 100
|
|
// Apparantly the v2.php URLs can return that
|
|
#define OCS_SUCCESS_STATUS_CODE_V2 200
|
|
// Two factor auth notification returns Accepted 202
|
|
#define OCS_ACCEPTED_STATUS_CODE 202
|
|
// not modified when using ETag
|
|
#define OCS_NOT_MODIFIED_STATUS_CODE_V2 304
|
|
|
|
class QJsonDocument;
|
|
|
|
namespace OCC {
|
|
|
|
/**
|
|
* @brief The OcsShareJob class
|
|
* @ingroup gui
|
|
*
|
|
* Base class for jobs that talk to the OCS endpoints on the server.
|
|
* All the communication logic is handled in this class.
|
|
*
|
|
* All OCS jobs (e.g. sharing) should extend this class.
|
|
*/
|
|
class OcsJob : public AbstractNetworkJob
|
|
{
|
|
Q_OBJECT
|
|
|
|
protected:
|
|
explicit OcsJob(AccountPtr account);
|
|
|
|
/**
|
|
* Set the verb for the job
|
|
*
|
|
* @param verb currently supported PUT POST DELETE
|
|
*/
|
|
void setVerb(const QByteArray &verb);
|
|
|
|
/**
|
|
* Add a new parameter to the request.
|
|
* Depending on the verb this is GET or POST parameter
|
|
*
|
|
* @param name The name of the parameter
|
|
* @param value The value of the parameter
|
|
*/
|
|
void addParam(const QString &name, const QString &value);
|
|
|
|
/**
|
|
* Set the post parameters
|
|
*
|
|
* @param postParams list of pairs to add (urlEncoded) to the body of the
|
|
* request
|
|
*/
|
|
void setPostParams(const QList<QPair<QString, QString>> &postParams);
|
|
|
|
/**
|
|
* List of expected statuscodes for this request
|
|
* A warning will be printed to the debug log if a different status code is
|
|
* encountered
|
|
*
|
|
* @param code Accepted status code
|
|
*/
|
|
void addPassStatusCode(int code);
|
|
|
|
/**
|
|
* The base path for an OcsJob is always the same. But it could be the case that
|
|
* certain operations need to append something to the URL.
|
|
*
|
|
* This function appends the common id. so <PATH>/<ID>
|
|
*/
|
|
void appendPath(const QString &id);
|
|
|
|
public:
|
|
/**
|
|
* Parse the response and return the status code and the message of the
|
|
* reply (metadata)
|
|
*
|
|
* @param json The reply from OCS
|
|
* @param message The message that is set in the metadata
|
|
* @return The statuscode of the OCS response
|
|
*/
|
|
static int getJsonReturnCode(const QJsonDocument &json, QString &message);
|
|
|
|
/**
|
|
* @brief Adds header to the request e.g. "If-None-Match"
|
|
* @param headerName a string with the header name
|
|
* @param value a string with the value
|
|
*/
|
|
void addRawHeader(const QByteArray &headerName, const QByteArray &value);
|
|
|
|
[[nodiscard]] QString getParamValue(const QString &key) const;
|
|
|
|
|
|
protected slots:
|
|
|
|
/**
|
|
* Start the OCS request
|
|
*/
|
|
void start() override;
|
|
|
|
signals:
|
|
|
|
/**
|
|
* Result of the OCS request
|
|
*
|
|
* @param reply the reply
|
|
*/
|
|
void jobFinished(QJsonDocument reply, int statusCode);
|
|
|
|
/**
|
|
* The status code was not one of the expected (passing)
|
|
* status code for this command
|
|
*
|
|
* @param statusCode The actual status code
|
|
* @param message The message provided by the server
|
|
*/
|
|
void ocsError(int statusCode, const QString &message);
|
|
|
|
/**
|
|
* @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);
|
|
|
|
private slots:
|
|
bool finished() override;
|
|
|
|
private:
|
|
QByteArray _verb;
|
|
QHash<QString, QString> _params;
|
|
QVector<int> _passStatusCodes;
|
|
QNetworkRequest _request;
|
|
};
|
|
}
|
|
|
|
#endif // OCSJOB_H
|