globaloptions.h

/*
 * ARIA2CPP: Basic CPP library to connect to an ARIA2 daemon 
 * via the RPC interface.
 *
 * 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/>.
 *
 */
 
#include <string>
#include <memory>
#include "ariadefs.h"
#include "aria2cppexception.h"
#include "client.h"
 
#ifndef GLOBALOPTIONS_H_
#define GLOBALOPTIONS_H_
 
using namespace jsonrpc;
 
enum class DownloadResultFormat {
    dfault,
    full,
    hide
};
 
enum class LogLevel {
    debug,  
    info, 
    notice, 
    warn, 
    error 
};
 
enum class EventPoll {
    epoll,
    kqueue,
    port,
    poll,
    select
};
 
enum class FileAllocation {
    none,
    prealloc,
    falloc,
    trunc
};
 
enum class FTPType {
    binary,
    ascii
};
 
enum class CryptoLevel {
    plain,
    arc4
};
 
enum class MetalinkProtocol {
    http,
    https,
    ftp,
    none
};
 
enum class ProxyMethod {
    get,
    tunnel
};
 
enum class PieceSelectionAlgorithm {
    def,
    inorder,
    geom,
    random
};
 
enum class URISelector {
    inorder,
    feedback,
    adaptive
};
 
class Options
{
public:
    
    Options() = delete;
    Options(std::shared_ptr<StubClient> c, std::string secret);
    bool setAllowOverwrite(bool value);
    bool setAlwaysResume(bool value);
    bool setAsyncDns(bool value);
    bool setAutoFileRenaming(bool value);
    bool setBtEnablelpd(bool value);
    bool setBtForceEncryption(bool value);
    bool setBtHashCheckSeed(bool value);
    bool setBtLoadSavedMetadata(bool value);
    bool setBtMetadataOnly(bool value);
    bool setBtRequireCrypto(bool value);
    bool setBtSaveMetadata(bool value);
    bool setBtSeedUnverified(bool value);
    bool setBtDetachSeedOnly(bool value);
    bool setBtEnableHookAfterHashCheck(bool value);
    bool setCheckCertificate(bool value);
    bool setCheckIntegrity(bool value);
    bool setConditionalGet(bool value);
    bool setCont(bool value);
    bool setContentDispositionDefaultUtf8(bool value);
    bool setDaemon(bool value);
    bool setDeferredInput(bool value);
    bool setDisableIpv6(bool value);
    bool setEnableColor(bool value);
    bool setEnableDht6(bool value);
    bool setEnableDht(bool value);
    bool setEnableHttpKeepAlive(bool value);
    bool setEnableHttpPipelining(bool value);
    bool setEnableMmap(bool value);
    bool setEnablePeerExchange(bool value);
    bool setEnableRpc(bool value);
    bool setFollowMetalink(bool value);
    bool setFollowTorrent(bool value);
    bool setFtpPasv(bool value);
    bool setFtpReuseConnection(bool value);
    bool setHashCheckOnly(bool value);
    bool setHttpAcceptGzip(bool value);
    bool setHttpAuthChallenge(bool value);
    bool setHttpNoCache(bool value);
    bool setHumanReadable(bool value);
    bool setKeepUnfinishedDownloadResult(bool value);
    bool setMetalinkEnableUniqueProtocol(bool value);
    bool setNoNetrc(bool value);
    bool setOptimizeConcurrentDownloads(bool value);
    bool setParameterizedUri(bool value);
    bool setPauseMetadata(bool value);
    bool setQuiet(bool value);
    bool setRealtimeChunkChecksum(bool value);
    bool setRemoteTime(bool value);
    bool setRemoveControlFile(bool value);
    bool setReuseUri(bool value);
    bool setRpcAllowOriginAll(bool value);
    bool setRpcListenAll(bool value);
    bool setRpcSecure(bool value);
    bool setSaveNotFound(bool value);
    bool setShowConsoleReadout(bool value);
    bool setShowFiles(bool value);
    bool setStderr(bool value);
    bool setTruncateConsoleReadout(bool value);
    bool setUseHead(bool value);
    bool setSeedRatio(float value);
    bool setAutosaveInterval(int value);
    bool setBtMaxOpenFiles(int value);
    bool setBtMaxPeers(int value);
    bool setBtRequestPeerSpeedLimit(int value);
    bool setBtStopTimeout(int value);
    bool setBtTrackerConnectTimeout(int value);
    bool setBtTrackerInterval(int value);
    bool setBtTrackerTimeout(int value);
    bool setConnectTimeout(int value);
    bool setDhtListenPort(int value);
    bool setDhtMessageTimeout(int value);
    bool setDscp(int value);
    bool setListenPort(int value);
    bool setLowestSpeedLimit(int value);
    bool setMaxConcurrentDownloads(int value);
    bool setMaxConnectionPerServer(int value);
    bool setMaxDownloadResult(int value);
    bool setMaxFileNotFound(int value);
    bool setMaxOverallDownloadLimit(int value);
    bool setMaxOverallUploadLimit(int value);
    bool setMaxResumeFailureTries(int value);
    bool setMaxTries(int value);
    bool setMinTlsVersion(std::string value);
    bool setNoConf(int value);
    bool setRetryWait(int value);
    bool setRlimitNofile(int value);
    bool setRpcListenPort(int value);
    bool setSaveSessionInterval(int value);
    bool setServerStatTimeout(int value);
    bool setSocketRecvBufferSize(int value);
    bool setSplit(int value);
    bool setStop(int value);
    bool setSummaryInterval(int value);
    bool setTimeout(int value);
    bool setDiskCache(int value);
    bool setMaxMmapLimit(int value);
    bool setMinSplitSize(int value);
    bool setNoFileAllocationLimit(int value);
    bool setRpcMaxRequestSize(int value);
    bool setBtEnableHookAfterHashCheck(std::string value);
    bool setBtExternalIp(std::string value);
    bool setCaCertificate(std::string value);
    bool setConfPath(std::string value);
    bool setDhtFilePath6(std::string value);
    bool setDhtFilePath(std::string value);
    bool setDir(std::string value);
    bool setHelp(std::string value);
    bool setNetrcPath(std::string value);
    bool setOnDownloadComplete(std::string value);
    bool setPeerAgent(std::string value);
    bool setPeerIdPrefix(std::string value);
    bool setSaveSession(std::string value);
    bool setSeedTime(int value);
    bool setUserAgent(std::string value);
    // FTP User Methods
    bool setFtpUser(std::string value);
    bool setFtpPasswd(std::string value);
    bool setFtpProxy(std::string value);
    bool setFtpProxyPasswd(std::string value);
    bool setFtpProxyUser(std::string value);
 
    // HTTP User Methods
    
    bool setHttpUser(std::string value);
    bool setHttpPasswd(std::string value);
    bool setHttpProxy(std::string value);
    bool setHttpProxyPasswd(std::string value);
    bool setHttpProxyUser(std::string value);
    bool setHttpsProxy(std::string value);
    bool setHttpsProxyPasswd(std::string value);
    bool setHttpsProxyUser(std::string value);
 
 
    bool setBtMinCryptoLevel(CryptoLevel value);
    bool setDownloadResult(DownloadResultFormat value);
    bool setEventPoll(EventPoll value);
    bool setFtpType(FTPType value);
    bool setFileAllocation(FileAllocation value);
    bool setConsoleLogLevel(LogLevel value);
    bool setLogLevel(LogLevel value);
    bool setMetalinkPreferredProtocol(MetalinkProtocol value);
    bool setStreamPieceSelector(PieceSelectionAlgorithm value);
    bool setProxyMethod(ProxyMethod value);
    bool setUriSelector(URISelector value);
    bool setDryRun(bool value);
    bool setPieceLength(int value);
    bool setRpcSaveUploadMetadata(bool value);
    bool setBtRemoveUnselectedFile(bool value);
    bool setForceSave(bool value);
    bool setMaxDownloadLimit(int value);
    bool setMaxUploadLimit(int value);
    bool setBtTracker(stringList URI);
    
 
 
    // Getter methods
    bool getAllowOverwrite();
    bool getAlwaysResume();
    bool getAsyncDns();
    bool getAutoFileRenaming();
    bool getBtEnablelpd();
    bool getBtEnableHookAfterHashCheck();
 
    bool getBtForceEncryption();
    bool getBtHashCheckSeed();
    bool getBtLoadSavedMetadata();
    bool getBtMetadataOnly();
    bool getBtRequireCrypto();
    bool getBtSaveMetadata();
    bool getBtSeedUnverified();
    bool getBtDetachSeedOnly();
    bool getCheckCertificate();
    bool getCheckIntegrity();
    bool getConditionalGet();
    bool getCont();
    bool getContentDispositionDefaultUtf8();
    bool getDaemon();
    bool getDeferredInput();
    bool getDisableIpv6();
    bool getEnableColor();
    bool getEnableDht6();
    bool getEnableDht();
    bool getEnableHttpKeepAlive();
    bool getEnableHttpPipelining();
    bool getEnableMmap();
    bool getEnablePeerExchange();
    bool getEnableRpc();
    bool getFollowMetalink();
    bool getFollowTorrent();
    bool getFtpPasv();
    bool getFtpReuseConnection();
    bool getHashCheckOnly();
    bool getHttpAcceptGzip();
    bool getHttpAuthChallenge();
    bool getHttpNoCache();
    bool getHumanReadable();
    bool getKeepUnfinishedDownloadResult();
    bool getMetalinkEnableUniqueProtocol();
    bool getNoNetrc();
    bool getOptimizeConcurrentDownloads();
    bool getParameterizedUri();
    bool getPauseMetadata();
    bool getQuiet();
    bool getRealtimeChunkChecksum();
    bool getRemoteTime();
    bool getRemoveControlFile();
    bool getReuseUri();
    bool getRpcAllowOriginAll();
    bool getRpcListenAll();
    bool getRpcSecure();
    bool getSaveNotFound();
    bool getShowConsoleReadout();
    bool getShowFiles();
    bool getStderr();
    bool getTruncateConsoleReadout();
    bool getUseHead();
    bool getBtRemoveUnselectedFile();
    bool getDryRun();
    bool getForceSave();
    bool getRpcSaveUploadMetadata();
    int getBtMaxPeers();
    int getBtRequestPeerSpeedLimit();
    int getMaxDownloadLimit();
    int getMaxUploadLimit();
    size_t getPieceLength();
    float getSeedRatio();
    int getAutosaveInterval();
    int getBtMaxOpenFiles();
    int getBtStopTimeout();
    int getBtTrackerConnectTimeout();
    int getBtTrackerInterval();
    int getBtTrackerTimeout();
    int getConnectTimeout();
    int getDhtListenPort();
    int getDhtMessageTimeout();
    int getDscp();
    int getListenPort();
    int getLowestSpeedLimit();
    int getMaxConcurrentDownloads();
    int getMaxConnectionPerServer();
    int getMaxDownloadResult();
    int getMaxFileNotFound();
    int getMaxOverallDownloadLimit();
    int getMaxOverallUploadLimit();
    int getMaxResumeFailureTries();
    int getMaxTries();
    int getMinTlsVersion();
    int getNoConf();
    int getRetryWait();
    int getRlimitNofile();
    int getRpcListenPort();
    int getSeedTime();
    int getSaveSessionInterval();
    int getServerStatTimeout();
    int getSocketRecvBufferSize();
    int getSplit();
    int getStop();
    int getSummaryInterval();
    int getTimeout();
    size_t getDiskCache();
    size_t getMaxMmapLimit();
    size_t getMinSplitSize();
    size_t getNoFileAllocationLimit();
    size_t getRpcMaxRequestSize();
 
 
 
    std::string getFtpUser();
    std::string getFtpPasswd();
    std::string getFtpProxy();
    std::string getFtpProxyPasswd();
    std::string getFtpProxyUser();
 
 
    
    std::string getHttpUser();
    std::string getHttpPasswd();
    std::string getHttpProxy();
    std::string getHttpProxyPasswd();
    std::string getHttpProxyUser();
    std::string getHttpsProxy();
    std::string getHttpsProxyPasswd();
    std::string getHttpsProxyUser();
 
    std::string getBtExternalIp();
 
    std::string getCaCertificate();
    std::string getConfPath();
    std::string getDhtFilePath6();
    std::string getDhtFilePath();
    std::string getDir();
    std::string getHelp();
    std::string getNetrcPath();
    std::string getOnDownloadComplete();
    std::string getPeerAgent();
    std::string getPeerIdPrefix();
    std::string getSaveSession();
    std::string getUserAgent();
    CryptoLevel getBtMinCryptoLevel();
    DownloadResultFormat getDownloadResult();
    EventPoll getEventPoll();
    FTPType getFtpType();
    FileAllocation getFileAllocation();
    LogLevel getConsoleLogLevel();
    LogLevel getLogLevel();
    MetalinkProtocol getMetalinkPreferredProtocol();
    PieceSelectionAlgorithm getStreamPieceSelector();
    ProxyMethod getProxyMethod();
    URISelector getUriSelector();
    stringList getBtTracker();
 
private:
    std::shared_ptr<StubClient> c;
    Json::Value m_options;
    std::string m_secret;
};
 
 
#endif //GLOBALOPTIONS_H_