include/installmgr.h

Go to the documentation of this file.

#ifndef INSTALLMGR_H
#define INSTALLMGR_H

#include <defs.h>
#include <swbuf.h>
#include <map>
#include <set>

SWORD_NAMESPACE_START

class SWMgr;
class SWModule;
class SWConfig;
class FTPTransport;
class StatusReporter;

class SWDLLEXPORT InstallSource {
    SWMgr *mgr;
public:
    InstallSource(const char *type, const char *confEnt = 0);
    virtual ~InstallSource();
    SWBuf getConfEnt() {
        return caption +"|" + source + "|" + directory + "|" + u + "|" + p + "|" + uid;
    }
    SWBuf caption;
    SWBuf source;
    SWBuf directory;
    SWBuf u;
    SWBuf p;
    SWBuf uid;

    SWBuf type;
    SWBuf localShadow;
    void *userData;
    SWMgr *getMgr();
    void flush();
};

typedef std::map<SWBuf, InstallSource *> InstallSourceMap;

class SWDLLEXPORT InstallMgr {

protected:
    bool userDisclaimerConfirmed;
    std::set<SWBuf> defaultMods;
    char *privatePath;
    SWBuf confPath;
    StatusReporter *statusReporter;
    bool passive;
    SWBuf u, p;

    virtual FTPTransport *createFTPTransport(const char *host, StatusReporter *statusReporter);

    virtual FTPTransport *createHTTPTransport(const char *host, StatusReporter *statusReporter);


    FTPTransport *transport;

public:

    static const int MODSTAT_OLDER;
    static const int MODSTAT_SAMEVERSION;
    static const int MODSTAT_UPDATED;
    static const int MODSTAT_NEW;
    static const int MODSTAT_CIPHERED;
    static const int MODSTAT_CIPHERKEYPRESENT;

    SWConfig *installConf;

    InstallSourceMap sources;

    InstallMgr(const char *privatePath = "./", StatusReporter *statusReporter = 0, SWBuf u="ftp", SWBuf p="installmgr@user.com");
    virtual ~InstallMgr();

    void readInstallConf();

    void saveInstallConf();

    void clearSources();

    virtual int removeModule(SWMgr *manager, const char *modName);

    virtual int ftpCopy(InstallSource *is, const char *src, const char *dest, bool dirTransfer = false, const char *suffix = "");

    virtual int installModule(SWMgr *destMgr, const char *fromLocation, const char *modName, InstallSource *is = 0);

    virtual int refreshRemoteSource(InstallSource *is);

    virtual int refreshRemoteSourceConfiguration();

    virtual bool isUserDisclaimerConfirmed() const { return userDisclaimerConfirmed; }

    void setUserDisclaimerConfirmed(bool val) { userDisclaimerConfirmed = val; }


        virtual bool getCipherCode(const char *modName, SWConfig *config) { (void) modName; (void) config; return false; }



    void setFTPPassive(bool passive) { this->passive = passive; }
    bool isFTPPassive() { return passive; }

    void terminate();

    /************************************************************************
     * getModuleStatus - compare the modules of two SWMgrs and return a
     *  vector describing the status of each.  See MODSTAT_*
     */
    static std::map<SWModule *, int> getModuleStatus(const SWMgr &base, const SWMgr &other);

    /************************************************************************
     * isDefaultModule - allows an installation to provide a set of modules
     *   in installMgr.conf like:
     *     [General]
     *     DefaultMod=KJV
     *     DefaultMod=StrongsGreek
     *     DefaultMod=Personal
     *   This method allows a user interface to ask if a module is specified
     *   as a default in the above way.  The logic is, if no modules are
     *   installed then all default modules should be automatically selected for install
     *   to help the user select a basic foundation of useful modules
     */
    bool isDefaultModule(const char *modName);
};


SWORD_NAMESPACE_END

#endif

---