provider.h

/*
    This file is part of KDE.

    SPDX-FileCopyrightText: 2008 Cornelius Schumacher <[email protected]>
    SPDX-FileCopyrightText: 2011 Laszlo Papp <[email protected]>

    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/

#ifndef ATTICA_PROVIDER_H
#define ATTICA_PROVIDER_H

#include <QExplicitlySharedDataPointer>
#include <QSharedPointer>
#include <QString>
#include <QStringList>

#include <QUrl>

#include "achievement.h"
#include "attica_export.h"
#include "category.h"
#include "forum.h"
#include "itemjob.h"
#include "listjob.h"
#include "message.h"
#include "comment.h"
#include "distribution.h"
#include "license.h"

class QDate;
class QUrl;

namespace Attica
{

class PlatformDependent;

class PostJobStatus;

class AccountBalance;
class Activity;
class BuildServiceJobOutput;
class BuildServiceJob;
class BuildService;
class PrivateData;
class Config;
class Content;
class DownloadItem;
class Distribution;
class Event;
class Folder;
class HomePageType;
class KnowledgeBaseEntry;
class License;
class Person;
class PostJob;
class Project;
class Provider;
class Publisher;
class PublisherField;
class RemoteAccount;

class ATTICA_EXPORT Provider
{
public:
    Provider();
    Provider(const Provider &other);
    Provider &operator=(const Provider &other);
    ~Provider();

    bool isValid() const;

    bool isEnabled() const;
    void setEnabled(bool enabled);

    void setAdditionalAgentInformation(const QString& additionalInformation);
    QString additionalAgentInformation() const;

    QUrl baseUrl() const;

    QString name() const;

    enum SortMode {
        Newest,
        Alphabetical,
        Rating,
        Downloads
    };

    bool hasPersonService() const;
    QString personServiceVersion() const;

    bool hasFriendService() const;

    QString friendServiceVersion() const;

    bool hasMessageService() const;
    QString messageServiceVersion() const;

    bool hasAchievementService() const;
    QString achievementServiceVersion() const;

    bool hasActivityService() const;
    QString activityServiceVersion() const;

    bool hasContentService() const;
    QString contentServiceVersion() const;

    bool hasFanService() const;
    QString fanServiceVersion() const;

    bool hasForumService() const;
    QString forumServiceVersion() const;

    bool hasKnowledgebaseService() const;
    QString knowledgebaseServiceVersion() const;

    bool hasCommentService() const;
    QString commentServiceVersion() const;

    bool hasCredentials() const;
    bool hasCredentials();

    bool loadCredentials(QString &user, QString &password);

    bool saveCredentials(const QString &user, const QString &password);

    PostJob *checkLogin(const QString &user, const QString &password);

    ItemJob<Config> *requestConfig();

    // Person part of OCS

    PostJob *registerAccount(const QString &id, const QString &password, const QString &mail, const QString &firstName, const QString &lastName);
    ItemJob<Person> *requestPerson(const QString &id);
    ItemJob<Person> *requestPersonSelf();
    ItemJob<AccountBalance> *requestAccountBalance();
    ListJob<Person> *requestPersonSearchByName(const QString &name);
    ListJob<Person> *requestPersonSearchByLocation(qreal latitude, qreal longitude, qreal distance = 0.0, int page = 0, int pageSize = 20);
    PostJob *postLocation(qreal latitude, qreal longitude, const QString &city = QString(), const QString &country = QString());

    // PrivateData part of OCS

    ItemJob<PrivateData> *requestPrivateData(const QString &app, const QString &key = QString());

    ItemJob<PrivateData> *requestPrivateData()
    {
        return requestPrivateData(QString(), QString());
    }

    PostJob *setPrivateData(const QString &app, const QString &key, const QString &value);

    // Friend part of OCS

    ListJob<Person> *requestFriends(const QString &id, int page = 0, int pageSize = 20);
    PostJob *postFriendInvitation(const QString &to, const QString &message);
    ListJob<Person> *requestSentInvitations(int page = 0, int pageSize = 20);
    ListJob<Person> *requestReceivedInvitations(int page = 0, int pageSize = 20);
    PostJob *inviteFriend(const QString &to, const QString &message);
    PostJob *approveFriendship(const QString &to);
    PostJob *declineFriendship(const QString &to);
    PostJob *cancelFriendship(const QString &to);

    // Message part of OCS

    ListJob<Folder> *requestFolders();
    ListJob<Message> *requestMessages(const Folder &folder);
    ListJob<Message> *requestMessages(const Folder &folder, Message::Status status);
    ItemJob<Message> *requestMessage(const Folder &folder, const QString &id);
    PostJob *postMessage(const Message &message);

    // Achievement part of OCS
    ListJob<Achievement> *requestAchievements(const QString &contentId, const QString &achievementId, const QString &userId);

    ItemPostJob<Achievement> *addNewAchievement(const QString &id, const Achievement &newAchievement);

    PutJob *editAchievement(const QString &contentId, const QString &achievementId, const Achievement &achievement);

    DeleteJob *deleteAchievement(const QString &contentId, const QString &achievementId);

    // PostJob* postAchievement(const Achievement& achievement);
    PostJob *setAchievementProgress(const QString &id, const QVariant &progress, const QDateTime &timestamp);
    DeleteJob *resetAchievementProgress(const QString &id);

    // Activity part of OCS

    ListJob<Activity> *requestActivities();
    PostJob *postActivity(const QString &message);

    // Project part of OCS
    ListJob<Project> *requestProjects();

    ItemJob<Project> *requestProject(const QString &id);

    PostJob *createProject(const Project &project);

    PostJob *deleteProject(const Project &project);

    PostJob *editProject(const Project &project);

    // Buildservice part of OCS

    ItemJob<BuildService> *requestBuildService(const QString &id);

    ItemJob<Publisher> *requestPublisher(const QString &id);

    PostJob *savePublisherField(const Project &project, const PublisherField &field);

    PostJob *publishBuildJob(const BuildServiceJob &buildjob, const Publisher &publisher);

    ItemJob<BuildServiceJobOutput> *requestBuildServiceJobOutput(const QString &id);

    ItemJob<BuildServiceJob> *requestBuildServiceJob(const QString &id);

    ListJob<BuildService> *requestBuildServices();

    ListJob<Publisher> *requestPublishers();

    ListJob<BuildServiceJob> *requestBuildServiceJobs(const Project &project);

    PostJob *createBuildServiceJob(const BuildServiceJob &job);

    PostJob *cancelBuildServiceJob(const BuildServiceJob &job);

    ListJob<RemoteAccount> *requestRemoteAccounts();

    PostJob *deleteRemoteAccount(const QString &id);

    PostJob *createRemoteAccount(const RemoteAccount &account);

    PostJob *editRemoteAccount(const RemoteAccount &account);

    ItemJob<RemoteAccount> *requestRemoteAccount(const QString &id);

    Attica::PostJob *uploadTarballToBuildService(const QString &projectId, const QString &fileName, const QByteArray &payload);

    // Content part of OCS

    ListJob<Category> *requestCategories();

    ListJob<License> *requestLicenses();

    ListJob<Distribution> *requestDistributions();

    ListJob<HomePageType> *requestHomePageTypes();

    ListJob<Content> *searchContents(const Category::List &categories, const QString &search = QString(), SortMode mode = Rating, uint page = 0, uint pageSize = 10);

    ListJob<Content> *searchContentsByPerson(const Category::List &categories, const QString &person, const QString &search = QString(), SortMode mode = Rating, uint page = 0, uint pageSize = 10);

    ListJob<Content> *searchContents(const Category::List &categories, const QString &person, const Distribution::List &distributions, const License::List &licenses, const QString &search = QString(), SortMode sortMode = Rating, uint page = 0, uint pageSize = 10);

    ItemJob<Content> *requestContent(const QString &contentId);

    ItemJob<DownloadItem> *downloadLink(const QString &contentId, const QString &itemId = QStringLiteral("1"));

#if ATTICA_ENABLE_DEPRECATED_SINCE(0, 2)

    ATTICA_DEPRECATED_VERSION(0, 2, "Use Provider::voteForContent(const QString &, uint)")
    PostJob *voteForContent(const QString &contentId, bool positiveVote);
#endif

    PostJob *voteForContent(const QString &contentId, uint rating);

    ItemPostJob<Content> *addNewContent(const Category &category, const Content &newContent);
    ItemPostJob<Content> *editContent(const Category &updatedCategory, const QString &contentId, const Content &updatedContent);
    PostJob *deleteContent(const QString &contentId);

    PostJob *setDownloadFile(const QString &contentId, const QString &fileName, QIODevice *payload);
    PostJob *setDownloadFile(const QString &contentId, const QString &fileName, const QByteArray &payload);
    PostJob *deleteDownloadFile(const QString &contentId);

    PostJob *setPreviewImage(const QString &contentId, const QString &previewId, const QString &fileName, const QByteArray &image);
    PostJob *deletePreviewImage(const QString &contentId, const QString &previewId);

    // KnowledgeBase part of OCS

    ItemJob<KnowledgeBaseEntry> *requestKnowledgeBaseEntry(const QString &id);
    ListJob<KnowledgeBaseEntry> *searchKnowledgeBase(const Content &content, const QString &search, SortMode, int page, int pageSize);

    // Event part of OCS

    ItemJob<Event> *requestEvent(const QString &id);
    ListJob<Event> *requestEvent(const QString &country, const QString &search, const QDate &startAt, SortMode mode, int page, int pageSize);

    // Comment part of OCS
    ListJob<Comment> *requestComments(const Comment::Type commentType, const QString &id, const QString &id2, int page, int pageSize);

    ItemPostJob<Comment> *addNewComment(const Comment::Type commentType, const QString &id, const QString &id2, const QString &parentId, const QString &subject, const QString &message);

    PostJob *voteForComment(const QString &id, uint rating);

    // Fan part of OCS

    PostJob *becomeFan(const QString &contentId);
    ListJob<Person> *requestFans(const QString &contentId, uint page = 0, uint pageSize = 10);

    // Forum part of OCS
    ListJob<Forum> *requestForums(uint page = 0, uint pageSize = 10);
    ListJob<Topic> *requestTopics(const QString &forum, const QString &search, const QString &description, SortMode mode, int page, int pageSize);
    PostJob *postTopic(const QString &forumId, const QString &subject, const QString &content);

    const QString &getRegisterAccountUrl() const;

protected:
    QUrl createUrl(const QString &path);
    QNetworkRequest createRequest(const QUrl &url);
    // Convenience overload
    QNetworkRequest createRequest(const QString &path);

    ItemJob<Config> *doRequestConfig(const QUrl &url);
    ItemJob<Person> *doRequestPerson(const QUrl &url);
    ItemJob<AccountBalance> *doRequestAccountBalance(const QUrl &url);
    ListJob<Person> *doRequestPersonList(const QUrl &url);
    ListJob<Achievement> *doRequestAchievementList(const QUrl &url);
    ListJob<Activity> *doRequestActivityList(const QUrl &url);
    ListJob<Folder> *doRequestFolderList(const QUrl &url);
    ListJob<Forum> *doRequestForumList(const QUrl &url);
    ListJob<Topic> *doRequestTopicList(const QUrl &url);
    ListJob<Message> *doRequestMessageList(const QUrl &url);

private:
    class Private;
    QExplicitlySharedDataPointer<Private> d;

    Provider(PlatformDependent *internals, const QUrl &baseUrl, const QString &name, const QUrl &icon = QUrl());
    Provider(PlatformDependent *internals, const QUrl &baseUrl, const QString &name, const QUrl &icon,
             const QString &person, const QString &friendV, const QString &message, const QString &achievements,
             const QString &activity, const QString &content, const QString &fan, const QString &forum,
             const QString &knowledgebase, const QString &event, const QString &comment);
    // kde-SC5: merge with the constructor above (i.e. remove the above one)
    Provider(PlatformDependent *internals, const QUrl &baseUrl, const QString &name, const QUrl &icon,
             const QString &person, const QString &friendV, const QString &message, const QString &achievements,
             const QString &activity, const QString &content, const QString &fan, const QString &forum,
             const QString &knowledgebase, const QString &event, const QString &comment, const QString &registerUrl);
    // TODO KF6: merge with the constructor above (i.e. remove the above one - and actually do it this time :P )
    Provider(PlatformDependent *internals, const QUrl &baseUrl, const QString &name, const QUrl &icon,
             const QString &person, const QString &friendV, const QString &message, const QString &achievements,
             const QString &activity, const QString &content, const QString &fan, const QString &forum,
             const QString &knowledgebase, const QString &event, const QString &comment, const QString &registerUrl,
             const QString &additionalAgentInformation);

    friend class ProviderManager;
};
}

QDebug operator<<(QDebug s, const Attica::Provider& prov);

#endif