aria2cpp.h

/*
 * ARIA2CPP: Basic CPP library to connect to an ARIA2 daemon 
 * via the RPC interface.
 *
 * *ALPHA VERSION!*
 * 
 * **** THE API IS NOT STABLE YET!!! ****
 *
 * Copyright (C) 2021  Dennis Katsonis dennisk@netspace.net.au
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef ARIA2CPP_H_
#define ARIA2CPP_H_
 
#include <string>
#include <vector>
#include <unistd.h>
#include <fcntl.h>
#include <memory>
#include <jsonrpccpp/client/connectors/httpclient.h>
#include "globaloptions.h"
 
#include "download.h"
#include "downloadoptions.h"
#include "base64.h"
#include "client.h"
#include "globaloptions.h"
#include "aria2cppexception.h"
#include "ariadefs.h"
 
class Aria2CPP
{
public:
    Aria2CPP(const char* host, const char* port, std::string secret = "");
    std::shared_ptr<Options> getOptions() const;
    void update(stringList keys = stringList());
    std::string addDownload(const std::string URI,
                            int position = 0);
    std::string addDownload(const std::string URI,
                            DownloadOptions &options,
                            int position = 0);
    std::string addTorrent(const std::string torrentFile,
                           DownloadOptions &options,
                           stringList URIs = stringList{},
                           int position = 0);
    std::string addTorrent(const std::string torrentFile,
                           stringList URIs = stringList{},
                           int position = 0);
    stringList addMetalink(const std::string metalinkFile, int position = 0);
    stringList addMetalink(const std::string metalinkFile, DownloadOptions  &dopts, int position = 0);
    bool pause(const std::string gid) const;
    bool resume(const std::string gid) const;
    bool pauseAll() const;
    bool shutdown() const;
    
    bool forceShutdown() const;
    
    bool resumeAll() const;
    bool saveSession() const;
    int changePosition(const std::string gid, const int count, std::string how) const;
    bool remove(const std::string gid) const;
    bool forceRemove(const std::string gid) const;
    std::string name(const size_t pos) const;
    std::string gid(const size_t pos) const;
    bool hasGid(const std::string gid) const;
    bool purgeDownloadResult() const;
    bool removeDownloadResult(const std::string gid) const;
    Options getGlobalOption() const;
    bool setGlobalOption(const std::string option, const std::string value);
    GlobalStat getGlobalStat() const;
    Version getVersion() const;
    std::string getSessionID();
    stringList listMethods();
    std::vector<URI> getUris(std::string gid) const;
 
    std::vector<Download> getDownloads(stringList keys = stringList());
    Download getDownload(const std::string gid,  // Specify which one we want by GID
                         stringList keys = stringList(),
                         bool getPeers = true,
                         bool getServers = true);
    Download getDownload(const size_t pos,
                         stringList keys = stringList(),
                         bool getPeers = true,
                         bool getServers = true);
protected:
    // The following four methods may be removed or changed in the
    // future!  This is an alpha, so changes may happen.
    //  Json::Value getDownloads(stringList keys = stringList()) const;
    Json::Value tellStatus(std::string gid, stringList values = stringList());
 
    Json::Value getWaitingDownloads(stringList keys = stringList()) const;
    Json::Value getWaitingStopped(stringList keys = stringList()) const;
    Json::Value getActiveDownloads(stringList keys = stringList()) const;
    void addJsonValueToDownloads(Json::Value downloads, bool getPeers = true, bool getServers = true);
    std::unique_ptr<HttpClient> m_httpclient;
    std::shared_ptr<StubClient> m_client;
    std::shared_ptr<Options> m_options;
    std::vector<Download> m_downloads;
    std::string m_secret = "token:";
    bool m_hasSecret;
};
 
#endif //ARIA2CPP_H_