qBittorrent/src/webui/api/apicontroller.h

/*
 * Bittorrent Client using Qt and libtorrent.
 * Copyright (C) 2018  Vladimir Golovnev <glassez@yandex.ru>
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * In addition, as a special exception, the copyright holders give permission to
 * link this program with the OpenSSL project's "OpenSSL" library (or with
 * modified versions of it that use the same license as the "OpenSSL" library),
 * and distribute the linked executables. You must obey the GNU General Public
 * License in all respects for all of the code used other than "OpenSSL".  If you
 * modify file(s), you may extend this exception to your version of the file(s),
 * but you are not obligated to do so. If you do not wish to do so, delete this
 * exception statement from your version.
 */

#pragma once

#include <QObject>
#include <QVariant>
#include <QtContainerFwd>

class QString;

struct ISessionManager;

using DataMap = QHash<QString, QByteArray>;
using StringMap = QHash<QString, QString>;

class APIController : public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY(APIController)

#ifndef Q_MOC_RUN
#define WEBAPI_PUBLIC
#define WEBAPI_PRIVATE
#endif

public:
    explicit APIController(ISessionManager *sessionManager, QObject *parent = nullptr);

    QVariant run(const QString &action, const StringMap &params, const DataMap &data = {});

    ISessionManager *sessionManager() const;

protected:
    const StringMap &params() const;
    const DataMap &data() const;
    void requireParams(const QVector<QString> &requiredParams) const;

    void setResult(const QString &result);
    void setResult(const QJsonArray &result);
    void setResult(const QJsonObject &result);

private:
    ISessionManager *m_sessionManager;
    StringMap m_params;
    DataMap m_data;
    QVariant m_result;
};