InstallMgr Class Reference

#include <installmgr.h>

Inheritance diagram for InstallMgr:

Collaboration diagram for InstallMgr:

Public Member Functions
void	clearSources ()
virtual bool	getCipherCode (const char *modName, SWConfig *config)
long	getTimeoutMillis ()
	InstallMgr (const char *privatePath="./", StatusReporter *statusReporter=0, SWBuf u="ftp", SWBuf p="installmgr@user.com")
virtual int	installModule (SWMgr *destMgr, const char *fromLocation, const char *modName, InstallSource *is=0)
bool	isDefaultModule (const char *modName)
bool	isFTPPassive ()
bool	isUnverifiedPeerAllowed ()
virtual bool	isUserDisclaimerConfirmed () const
void	readInstallConf ()
virtual int	refreshRemoteSource (InstallSource *is)
virtual int	refreshRemoteSourceConfiguration ()
virtual int	remoteCopy (InstallSource *is, const char *src, const char *dest, bool dirTransfer=false, const char *suffix="")
virtual int	removeModule (SWMgr *manager, const char *modName)
void	saveInstallConf ()
void	setFTPPassive (bool passive)
void	setTimeoutMillis (long timeoutMillis)
void	setUnverifiedPeerAllowed (bool allowed)
void	setUserDisclaimerConfirmed (bool val)
void	terminate ()
virtual	~InstallMgr ()

Static Public Member Functions
static std::map< SWModule *, int >	getModuleStatus (const SWMgr &base, const SWMgr &other, bool utilModules=false)

Public Attributes
SWConfig *	installConf
InstallSourceMap	sources

Static Public Attributes
static const unsigned int	MODSTAT_CIPHERED = 0x010
static const unsigned int	MODSTAT_CIPHERKEYPRESENT = 0x020
static const unsigned int	MODSTAT_NEW = 0x008
static const unsigned int	MODSTAT_OLDER = 0x001
static const unsigned int	MODSTAT_SAMEVERSION = 0x002
static const unsigned int	MODSTAT_UPDATED = 0x004
static bool	userDisclaimerConfirmed = false

Protected Member Functions
virtual RemoteTransport *	createFTPTransport (const char *host, StatusReporter *statusReporter)
virtual RemoteTransport *	createHTTPTransport (const char *host, StatusReporter *statusReporter)

Protected Attributes
SWBuf	confPath
std::set< SWBuf >	defaultMods
SWBuf	p
bool	passive
char *	privatePath
StatusReporter *	statusReporter
long	timeoutMillis
RemoteTransport *	transport
SWBuf	u
bool	unverifiedPeerAllowed

Detailed Description

Class to handle installation and maintenance of a SWORD library of books.

Definition at line 70 of file installmgr.h.

Constructor & Destructor Documentation

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

Username and Password supplied here can be used to identify your frontend by supplying a valid anon password like insta.nosp@m.llmg.nosp@m.r@mac.nosp@m.swor.nosp@m.d.com This will get overridden if a password is required and provided in an indivual source configuration.

Definition at line 99 of file installmgr.cpp.

                                                                                    {
    passive = true;
    timeoutMillis = 10000;
    unverifiedPeerAllowed = true;
    statusReporter = sr;
    this->u = u;
    this->p = p;
    this->privatePath = 0;
    this->transport = 0;
    installConf = 0;
    stdstr(&(this->privatePath), privatePath);
    if (this->privatePath) {
        int len = (int)strlen(this->privatePath);
        if ((this->privatePath[len-1] == '/')
         || (this->privatePath[len-1] == '\\'))
            this->privatePath[len-1] = 0;
    }
    confPath = (SWBuf)privatePath + "/InstallMgr.conf";
    FileMgr::createParent(confPath.c_str());
    
    readInstallConf();
}

InstallMgr::~InstallMgr ( )

virtual

Definition at line 123 of file installmgr.cpp.

                        {
    delete [] privatePath;
    delete installConf;
    clearSources();
}

Member Function Documentation

void InstallMgr::clearSources

(

)

Removes all configured sources from memory. Call saveInstallConf() to persist

Definition at line 130 of file installmgr.cpp.

                              {
    for (InstallSourceMap::iterator it = sources.begin(); it != sources.end(); ++it) {
        delete it->second;
    }
    sources.clear();
}

RemoteTransport * InstallMgr::createFTPTransport ( const char *  host, StatusReporter *  statusReporter  )

protectedvirtual

override this method and provide your own custom RemoteTransport subclass

Definition at line 81 of file installmgr.cpp.

                                                                                                {
#ifdef CURLAVAILABLE
    return new CURLFTPTransport(host, statusReporter);
#else
    return new FTPLibFTPTransport(host, statusReporter);
#endif
}

RemoteTransport * InstallMgr::createHTTPTransport ( const char *  host, StatusReporter *  statusReporter  )

protectedvirtual

override this method and provide your own custom HTTP RemoteTransport

Definition at line 90 of file installmgr.cpp.

                                                                                                 {
#ifdef CURLAVAILABLE
    return new CURLHTTPTransport(host, statusReporter);
#else
    return 0;
#endif
}

virtual bool InstallMgr::getCipherCode ( const char *  modName, SWConfig *  config  )

inlinevirtual

override this and provide an input mechanism to allow your users to enter the decipher code for a module. return true you added the cipher code to the config. default to return 'aborted'

Definition at line 222 of file installmgr.h.

                                                                      {
        (void) modName; (void) config;  // to avoid "unused variable" warnings
        return false;

        /*
        A sample implementation, roughly taken from the windows installmgr:

        SectionMap::iterator section;
        ConfigEntMap::iterator entry;
        SWBuf tmpBuf;
        section = config->Sections.find(modName);
        if (section != config->Sections.end()) {
            entry = section->second.find("CipherKey");
            if (entry != section->second.end()) {
                entry->second = ASK_USER_FOR_CIPHER_CODE();
                config->Save();

                // LET'S SHOW THE USER SOME SAMPLE TEXT FROM THE MODULE
                SWMgr *mgr = new SWMgr();
                SWModule *mod = mgr->getModule(modName);
                mod->setKey("Ipet 2:12");
                tmpBuf = mod->StripText();
                mod->setKey("gen 1:10");
                tmpBuf += "\n\n";
                tmpBuf += mod->StripText();
                if (SOME_DIALOG_CONFIRMATION(SWBuf(
                            "Using your provided cipher code,   \
                            here is the data from the module.   \
                            Does this look good?\n\n") + tmpBuf.c_str())) {

                    // if USER CLICKS OK means we should return true
                    return true;
                }
                delete mgr;
            }
        }
        return false;
        */
    }

map< SWModule *, int > InstallMgr::getModuleStatus ( const SWMgr &  base, const SWMgr &  other, bool  utilModules = false  )

static

Definition at line 592 of file installmgr.cpp.

                                                                                                        {
    map<SWModule *, int> retVal;
    SWBuf targetVersion;
    SWBuf sourceVersion;
    SWBuf softwareVersion;
    bool cipher;
    bool keyPresent;
    int modStat;
    
    for (ModMap::const_iterator mod = (!utilModules ? other.getModules().begin() : other.getUtilModules().begin()); mod != (!utilModules ? other.getModules().end() : other.getUtilModules().end()); ++mod) {
    
        modStat = 0;

        cipher = false;
        keyPresent = false;
        
        const char *v = mod->second->getConfigEntry("CipherKey");
        if (v) {
            cipher = true;
            keyPresent = *v;
        }
        
        targetVersion = "0.0";
        sourceVersion = "1.0";
        softwareVersion = (const char *)SWVersion::currentVersion;
        
        v = mod->second->getConfigEntry("Version");
        if (v) sourceVersion = v;

        v = mod->second->getConfigEntry("MinimumVersion");
        if (v) softwareVersion = v;

        const SWModule *baseMod = base.getModule(mod->first);
        if (baseMod) {
            targetVersion = "1.0";
            v = baseMod->getConfigEntry("Version");
            if (v) targetVersion = v;
            modStat |= (SWVersion(sourceVersion.c_str()) > SWVersion(targetVersion.c_str())) ? MODSTAT_UPDATED : (SWVersion(sourceVersion.c_str()) < SWVersion(targetVersion.c_str())) ? MODSTAT_OLDER : MODSTAT_SAMEVERSION;
        }
        else modStat |= MODSTAT_NEW;

        if (cipher) modStat |= MODSTAT_CIPHERED;
        if (keyPresent) modStat |= MODSTAT_CIPHERKEYPRESENT;
        retVal[mod->second] = modStat;
    }
    return retVal;
}

long InstallMgr::getTimeoutMillis ( )

inline

Definition at line 270 of file installmgr.h.

{ return timeoutMillis; }

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

virtual

call to install a module from a local path (fromLocation) or remote InstallSource (is) (leave the other 0)

Definition at line 394 of file installmgr.cpp.

                                                                                                              {
    int retVal = 0;
    SectionMap::iterator module, section;
    ConfigEntMap::iterator fileBegin;
    ConfigEntMap::iterator fileEnd;
    ConfigEntMap::iterator entry;
    SWBuf sourceDir;
    SWBuf buffer;
    bool aborted = false;
    bool cipher = false;
    SWBuf modFile;

SWLOGD("***** InstallMgr::installModule\n");
    if (fromLocation) {
SWLOGD("***** fromLocation: %s \n", fromLocation);
    }
SWLOGD("***** modName: %s \n", modName);

    if (is)
        sourceDir = (SWBuf)privatePath + "/" + is->uid;
    else    sourceDir = fromLocation;

    removeTrailingSlash(sourceDir);
    sourceDir += '/';

    SWMgr mgr(sourceDir.c_str());
    
    module = mgr.config->getSections().find(modName);

    if (module != mgr.config->getSections().end()) {
    
        entry = module->second.find("CipherKey");
        if (entry != module->second.end())
            cipher = true;
        
        //
        // This first check is a method to allow a module to specify each
        // file that needs to be copied
        //
        fileEnd = module->second.upper_bound("File");
        fileBegin = module->second.lower_bound("File");

        if (fileBegin != fileEnd) { // copy each file
            if (is) {
                while (fileBegin != fileEnd) {  // netCopy each file first
                    buffer = sourceDir + fileBegin->second.c_str();
                    if (remoteCopy(is, fileBegin->second.c_str(), buffer.c_str())) {
                        aborted = true;
                        break;  // user aborted
                    }
                    fileBegin++;
                }
                fileBegin = module->second.lower_bound("File");
            }

            if (!aborted) {
                // DO THE INSTALL
                while (fileBegin != fileEnd && !retVal) {
                    SWBuf sourcePath = sourceDir;
                    sourcePath += fileBegin->second.c_str();
                    SWBuf dest = destMgr->prefixPath;
                    removeTrailingSlash(dest);
                    dest += '/';
                    dest += fileBegin->second.c_str();
                    retVal = FileMgr::copyFile(sourcePath.c_str(), dest.c_str());

                    fileBegin++;
                }
            }
            //---------------

            if (is) {
                fileBegin = module->second.lower_bound("File");
                while (fileBegin != fileEnd) {  // delete each tmp netCopied file
                    buffer = sourceDir + fileBegin->second.c_str();
                    FileMgr::removeFile(buffer.c_str());
                    fileBegin++;
                }
            }
        }

        // This is the REAL install code, the above code I don't think has
        // ever been used
        //
        // Copy all files in DataPath directory
        // 
        else {
            ConfigEntMap::iterator entry;

            entry = module->second.find("AbsoluteDataPath");
            if (entry != module->second.end()) {
                SWBuf absolutePath = entry->second.c_str();
                SWBuf relativePath = absolutePath;
                entry = module->second.find("PrefixPath");
                if (entry != module->second.end()) {
                    relativePath << strlen(entry->second.c_str());
                }
                else {
                    relativePath << strlen(mgr.prefixPath);
                }
SWLOGD("***** mgr.prefixPath: %s \n", mgr.prefixPath);
SWLOGD("***** destMgr->prefixPath: %s \n", destMgr->prefixPath);
SWLOGD("***** absolutePath: %s \n", absolutePath.c_str());
SWLOGD("***** relativePath: %s \n", relativePath.c_str());

                if (is) {
                    if (remoteCopy(is, relativePath.c_str(), absolutePath.c_str(), true)) {
                        aborted = true; // user aborted
                    }
                }
                if (!aborted) {
                    SWBuf destPath = (SWBuf)destMgr->prefixPath + relativePath;
                    retVal = FileMgr::copyDir(absolutePath.c_str(), destPath.c_str());
                }
                if (is) {       // delete tmp netCopied files
//                  mgr->deleteModule(modName);
                    FileMgr::removeDir(absolutePath.c_str());
                }
            }
        }
        if (!aborted) {
            SWBuf confDir = sourceDir + "mods.d/";
            std::vector<DirEntry> dirList = FileMgr::getDirList(confDir);
            for (unsigned int i = 0; i < dirList.size() && !retVal; ++i) {
                if (dirList[i].name.endsWith(".conf")) {
                    modFile = confDir;
                    modFile += dirList[i].name;
                    SWConfig *config = new SWConfig(modFile);
                    if (config->getSections().find(modName) != config->getSections().end()) {
                        SWBuf targetFile = destMgr->configPath; //"./mods.d/";
                        removeTrailingSlash(targetFile);
                        targetFile += "/";
                        targetFile += dirList[i].name;
                        retVal = FileMgr::copyFile(modFile.c_str(), targetFile.c_str());
                        if (cipher) {
                            if (getCipherCode(modName, config)) {
                                SWMgr newDest(destMgr->prefixPath);
                                removeModule(&newDest, modName);
                                aborted = true;
                            }
                            else {
                                config->save();
                                retVal = FileMgr::copyFile(modFile.c_str(), targetFile.c_str());
                            }
                        }
                    }
                    delete config;
                }
            }
        }
        return (aborted) ? -9 : retVal;
    }
    return 1;
}

bool InstallMgr::isDefaultModule

(

const char *

modName

)

Definition at line 583 of file installmgr.cpp.

                                                    {
    return defaultMods.count(modName);
}

bool InstallMgr::isFTPPassive ( )

inline

Definition at line 267 of file installmgr.h.

{ return passive; }

bool InstallMgr::isUnverifiedPeerAllowed ( )

inline

Definition at line 273 of file installmgr.h.

{ return unverifiedPeerAllowed; }

bool InstallMgr::isUserDisclaimerConfirmed ( ) const

virtual

Override this and provide an input mechanism to allow your users to confirm that they understand this important disclaimer. This method will be called immediately before attempting to perform any network function. If you would like your confirmation to always show at a predefined time before attempting network operations, then you can call this method yourself at the desired time.

Return true if your user confirms.

User disclaimer should ask user for confirmation of 2 critical items: and the default answer should be NO (due to possibly the wrong language for the disclaimer)

1) detection OK (Not in persecuted country) 2) repos other than CrossWire may have questionable content

A sample default impl is provided below:

Reimplemented in MyInstallMgr.

Definition at line 777 of file installmgr.cpp.

                                                 {

    if (!userDisclaimerConfirmed) {
        std::cout << "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n";
        std::cout << "                -=+* WARNING *+=- -=+* WARNING *+=-\n\n\n";
        std::cout << "Although Install Manager provides a convenient way for installing\n";
        std::cout << "and upgrading SWORD components, it also uses a systematic method\n";
        std::cout << "for accessing sites which gives packet sniffers a target to lock\n";
        std::cout << "into for singling out users. \n\n\n";
        std::cout << "IF YOU LIVE IN A PERSECUTED COUNTRY AND DO NOT WISH TO RISK DETECTION,\n";
        std::cout << "YOU SHOULD *NOT* USE INSTALL MANAGER'S REMOTE SOURCE FEATURES.\n\n\n";
        std::cout << "Also, Remote Sources other than CrossWire may contain less than\n";
        std::cout << "quality modules, modules with unorthodox content, or even modules\n";
        std::cout << "which are not legitimately distributable.  Many repositories\n";
        std::cout << "contain wonderfully useful content.  These repositories simply\n";
        std::cout << "are not reviewed or maintained by CrossWire and CrossWire\n";
        std::cout << "cannot be held responsible for their content. CAVEAT EMPTOR.\n\n\n";
        std::cout << "If you understand this and are willing to enable remote source features\n";
        std::cout << "then type yes at the prompt\n\n";
        std::cout << "enable? [no] ";

        char prompt[10];
        fgets(prompt, 9, stdin);
        userDisclaimerConfirmed = (!strcmp(prompt, "yes\n"));
        std::cout << "\n";
    }
    return userDisclaimerConfirmed;
}

void InstallMgr::readInstallConf

(

)

Call to re-read InstallMgr.conf

Definition at line 138 of file installmgr.cpp.

                                 {

    if (installConf) delete installConf;

    installConf = new SWConfig(confPath.c_str());

    clearSources();
    
    setFTPPassive(stricmp((*installConf)["General"]["PassiveFTP"].c_str(), "false") != 0);
    long t = atol((*installConf)["General"]["TimeoutMillis"].c_str());
    if (t > 0) setTimeoutMillis(t);
    setUnverifiedPeerAllowed(stricmp((*installConf)["General"]["UnverifiedPeerAllowed"].c_str(), "false") != 0);

    SectionMap::iterator confSection = installConf->getSections().find("Sources");
    ConfigEntMap::iterator sourceBegin;
    ConfigEntMap::iterator sourceEnd;

    if (confSection != installConf->getSections().end()) {

        sourceBegin = confSection->second.lower_bound("FTPSource");
        sourceEnd = confSection->second.upper_bound("FTPSource");

        while (sourceBegin != sourceEnd) {
            InstallSource *is = new InstallSource("FTP", sourceBegin->second.c_str());
            sources[is->caption] = is;
            SWBuf parent = (SWBuf)privatePath + "/" + is->uid + "/file";
            FileMgr::createParent(parent.c_str());
            is->localShadow = (SWBuf)privatePath + "/" + is->uid;
            sourceBegin++;
        }

#ifdef CURLSFTPAVAILABLE
        sourceBegin = confSection->second.lower_bound("SFTPSource");
        sourceEnd   = confSection->second.upper_bound("SFTPSource");

        while (sourceBegin != sourceEnd) {
            InstallSource *is = new InstallSource("SFTP", sourceBegin->second.c_str());
            sources[is->caption] = is;
            SWBuf parent = (SWBuf)privatePath + "/" + is->uid + "/file";
            FileMgr::createParent(parent.c_str());
            is->localShadow = (SWBuf)privatePath + "/" + is->uid;
            sourceBegin++;
        }
#endif // CURLSFTPAVAILABLE

        sourceBegin = confSection->second.lower_bound("HTTPSource");
        sourceEnd = confSection->second.upper_bound("HTTPSource");

        while (sourceBegin != sourceEnd) {
            InstallSource *is = new InstallSource("HTTP", sourceBegin->second.c_str());
            sources[is->caption] = is;
            SWBuf parent = (SWBuf)privatePath + "/" + is->uid + "/file";
            FileMgr::createParent(parent.c_str());
            is->localShadow = (SWBuf)privatePath + "/" + is->uid;
            sourceBegin++;
        }

        sourceBegin = confSection->second.lower_bound("HTTPSSource");
        sourceEnd   = confSection->second.upper_bound("HTTPSSource");

        while (sourceBegin != sourceEnd) {
            InstallSource *is = new InstallSource("HTTPS", sourceBegin->second.c_str());
            sources[is->caption] = is;
            SWBuf parent = (SWBuf)privatePath + "/" + is->uid + "/file";
            FileMgr::createParent(parent.c_str());
            is->localShadow = (SWBuf)privatePath + "/" + is->uid;
            sourceBegin++;
        }
    }

    defaultMods.clear();
    confSection = installConf->getSections().find("General");
    if (confSection != installConf->getSections().end()) {
        sourceBegin = confSection->second.lower_bound("DefaultMod");
        sourceEnd = confSection->second.upper_bound("DefaultMod");

        while (sourceBegin != sourceEnd) {
            defaultMods.insert(sourceBegin->second.c_str());
            sourceBegin++;
        }
    }
}

int InstallMgr::refreshRemoteSource ( InstallSource *  is )

virtual

call to obtain and locally cache the available content list of the remote source

Definition at line 550 of file installmgr.cpp.

                                                     {

    // assert user disclaimer has been confirmed
    if (!isUserDisclaimerConfirmed()) return -1;

    SWBuf root = (SWBuf)privatePath + (SWBuf)"/" + is->uid.c_str();
    removeTrailingSlash(root);
    SWBuf target = root + "/mods.d";
    int errorCode = -1; //0 means successful

    FileMgr::removeDir(target.c_str());

    if (!FileMgr::existsDir(target))
        FileMgr::createPathAndFile(target+"/globals.conf");

#ifndef EXCLUDEZLIB
    SWBuf archive = root + "/mods.d.tar.gz";

    errorCode = remoteCopy(is, "mods.d.tar.gz", archive.c_str(), false);
    if (!errorCode) { //sucessfully downloaded the tar,gz of module configs
        int fd = FileMgr::openFileReadOnly(archive.c_str());
        ZipCompress::unTarGZ(fd, root.c_str());
        FileMgr::closeFile(fd);
    }
    else if (errorCode > -2)    // don't try the next attempt on connection error or user requested termination
#endif
    errorCode = remoteCopy(is, "mods.d", target.c_str(), true, ".conf"); //copy the whole directory

    is->flush();
    return errorCode;
}

int InstallMgr::refreshRemoteSourceConfiguration ( )

virtual

call to populate installmgr configuration with all known remote sources from the master list at CrossWire

Definition at line 645 of file installmgr.cpp.

                                                 {

    // assert user disclaimer has been confirmed
    if (!isUserDisclaimerConfirmed()) return -1;

    SWBuf root = (SWBuf)privatePath;
    removeTrailingSlash(root);
    SWBuf masterRepoListPath = root + "/" + masterRepoList;
    InstallSource is("FTP");
    is.source = "ftp.crosswire.org";
    is.directory = "/pub/sword";
    int errorCode = remoteCopy(&is, masterRepoList, masterRepoListPath.c_str(), false);
    if (!errorCode) { //sucessfully downloaded the repo list
        SWConfig masterList(masterRepoListPath);
        SectionMap::iterator sections = masterList.getSections().find("Repos");
        if (sections != masterList.getSections().end()) {
            for (ConfigEntMap::iterator actions = sections->second.begin(); actions != sections->second.end(); actions++) {
                // Search through our current sources and see if we have a matching UID
                InstallSourceMap::iterator it;
                for (it = sources.begin(); it != sources.end(); ++it) {
                    // is this our UID?
                    if ((it->second) && (it->second->uid == actions->first)) {
                        if (actions->second == "REMOVE") {
                            // be sure to call save/reload after this
                            // or this could be dangerous
                            delete it->second;
                            it->second = 0;
                        }
                        else {
                            SWBuf key = actions->second.stripPrefix('=');
                            if (key == "FTPSource") {
                                // we might consider instantiating a temp IS
                                // from our config string and then copy only
                                // some entries.  This would allow the use to
                                // change some fields and not have them overwritten
                                // but it seems like we might want to change any
                                // of the current fields so we don't do this now
                                // InstallSource i("FTP", actions->second);
                                delete it->second;
                                it->second = new InstallSource("FTP", actions->second.c_str());
                                it->second->uid = actions->first;
                            }
                        }
                        break;
                    }
                }
                // didn't find our UID, let's add it
                if (it == sources.end()) {
                    SWBuf key = actions->second.stripPrefix('=');
                    if (key == "FTPSource") {
                        if (actions->second != "REMOVE") {
                            InstallSource *is = new InstallSource("FTP", actions->second.c_str());
                            is->uid = actions->first;
                            sources[is->caption] = is;
                        }
                    }
                }
            }

            // persist and re-read
            saveInstallConf();
            readInstallConf();

            return 0;
        }
    }
    return -1;
}

int InstallMgr::remoteCopy ( InstallSource *  is, const char *  src, const char *  dest, bool  dirTransfer = false, const char *  suffix = ""  )

virtual

mostly an internally used method to remote download from a remote source to a local destination

Definition at line 300 of file installmgr.cpp.

                                                                                                                     {
SWLOGD("remoteCopy: %s, %s, %s, %c, %s", (is?is->source.c_str():"null"), src, (dest?dest:"null"), (dirTransfer?'t':'f'), (suffix?suffix:"null"));

    // assert user disclaimer has been confirmed
    if (!isUserDisclaimerConfirmed()) return -1;

    int retVal = 0;
    RemoteTransport *trans = 0;
    if (is->type == "FTP" 
#ifdef CURLSFTPAVAILABLE
        || is->type == "SFTP"
#endif
        ) {

        trans = createFTPTransport(is->source, statusReporter);
        trans->setPassive(passive);
        trans->setTimeoutMillis(timeoutMillis);
    }
    else if (is->type == "HTTP" || is->type == "HTTPS") {
        trans = createHTTPTransport(is->source, statusReporter);
    }
    transport = trans; // set classwide current transport for other thread terminate() call
    if (is->u.length()) {
        trans->setUser(is->u);
        trans->setPasswd(is->p);
    }
    else {
        trans->setUser(u);
        trans->setPasswd(p);
    }

    trans->setUnverifiedPeerAllowed(unverifiedPeerAllowed);

    SWBuf urlPrefix;
    if (is->type == "HTTP") {
        urlPrefix = (SWBuf) "http://";
    }
    else if (is->type == "HTTPS") {
        urlPrefix = (SWBuf) "https://";
    }
#ifdef CURLSFTPAVAILABLE
    else if (is->type == "SFTP") {
        urlPrefix = (SWBuf) "sftp://";
    }
#endif
    else {
        urlPrefix = (SWBuf) "ftp://";
    }
    urlPrefix.append(is->source);

    // let's be sure we can connect.  This seems to be necessary but sucks
//  SWBuf url = urlPrefix + is->directory.c_str() + "/"; //dont forget the final slash
//  if (trans->getURL("swdirlist.tmp", url.c_str())) {
// SWLOGD("FTPCopy: failed to get dir %s\n", url.c_str());
//       return -1;
//  }


    if (dirTransfer) {
        SWBuf dir = (SWBuf)is->directory.c_str();
        removeTrailingSlash(dir);
        dir += (SWBuf)"/" + src; //dont forget the final slash
SWLOGD("remoteCopy: dirTransfer: %s", dir.c_str());

        retVal = trans->copyDirectory(urlPrefix, dir, dest, suffix);


    }
    else {
        SWTRY {
            SWBuf url = urlPrefix + is->directory.c_str();
            removeTrailingSlash(url);
            url += (SWBuf)"/" + src; //dont forget the final slash
            retVal = trans->getURL(dest, url.c_str());
            if (retVal) {
SWLOGD("netCopy: failed to get file %s", url.c_str());
            }
        }
        SWCATCH (...) {
            retVal = -1;
        }
    }
    SWTRY {
        RemoteTransport *deleteMe = trans;
        // do this order for threadsafeness
        // (see terminate())
        trans = transport = 0;
        delete deleteMe;
    }
    SWCATCH (...) {}
    return retVal;
}

int InstallMgr::removeModule ( SWMgr *  manager, const char *  modName  )

virtual

call to delete all files of a locally installed module.

Definition at line 241 of file installmgr.cpp.

                                                                   {
    SectionMap::iterator module;
    ConfigEntMap::iterator fileBegin;
    ConfigEntMap::iterator fileEnd, entry;

    // save our own copy, cuz when we remove the module from the SWMgr
    // it's likely we'll free the memory passed to us in moduleName
    SWBuf modName = moduleName;
    module = manager->config->getSections().find(modName);

    if (module != manager->config->getSections().end()) {
        // to be sure all files are closed
        // this does not remove the .conf information from SWMgr
        manager->deleteModule(modName);

        fileBegin = module->second.lower_bound("File");
        fileEnd = module->second.upper_bound("File");

        SWBuf modFile;
        SWBuf modDir;
        entry = module->second.find("AbsoluteDataPath");
        modDir = entry->second.c_str();
        removeTrailingSlash(modDir);
        if (fileBegin != fileEnd) { // remove each file
            while (fileBegin != fileEnd) {
                modFile = modDir;
                modFile += "/";
                modFile += fileBegin->second.c_str();
                //remove file
                FileMgr::removeFile(modFile.c_str());
                fileBegin++;
            }
        }
        else {  //remove all files in DataPath directory
            ConfigEntMap::iterator entry;
            FileMgr::removeDir(modDir.c_str());
            std::vector<DirEntry> dirList = FileMgr::getDirList(manager->configPath);
            for (unsigned int i = 0; i < dirList.size(); ++i) {
                if (dirList[i].name.endsWith(".conf")) {
                    modFile = manager->configPath;
                    removeTrailingSlash(modFile);
                    modFile += "/";
                    modFile += dirList[i].name;
                    SWConfig *config = new SWConfig(modFile.c_str());
                    if (config->getSections().find(modName) != config->getSections().end()) {
                        delete config;
                        FileMgr::removeFile(modFile.c_str());
                    }
                    else    delete config;
                }
            }
        }
        return 0;
    }
    return 1;
}

void InstallMgr::saveInstallConf

(

)

Call to dump sources and other settings to InstallMgr.conf

Definition at line 222 of file installmgr.cpp.

                                 {

    installConf->getSection("Sources").clear();

    for (InstallSourceMap::iterator it = sources.begin(); it != sources.end(); ++it) {
        if (it->second) {
            installConf->getSection("Sources").insert(ConfigEntMap::value_type(it->second->type + "Source", it->second->getConfEnt().c_str()));
        }
    }
    (*installConf)["General"]["PassiveFTP"] = (isFTPPassive()) ? "true" : "false";
    (*installConf)["General"]["UnverifiedPeerAllowed"] = (isUnverifiedPeerAllowed()) ? "true" : "false";

    installConf->save();
}

void InstallMgr::setFTPPassive ( bool  passive )

inline

whether or not to use passive mode when doing ftp transfers

Definition at line 266 of file installmgr.h.

{ this->passive = passive; }

void InstallMgr::setTimeoutMillis ( long  timeoutMillis )

inline

Definition at line 269 of file installmgr.h.

{ this->timeoutMillis = timeoutMillis; }

void InstallMgr::setUnverifiedPeerAllowed ( bool  allowed )

inline

Definition at line 272 of file installmgr.h.

{ this->unverifiedPeerAllowed = allowed; }

void InstallMgr::setUserDisclaimerConfirmed ( bool  val )

inline

Preferred method of reporting user disclaimer confirmation is to override the above method instead of using the setter below. This is provided for clients who don't wish to inherit InstallMgr and override method.

Definition at line 214 of file installmgr.h.

{ InstallMgr::userDisclaimerConfirmed = val; }

void InstallMgr::terminate

(

)

Request nicely to terminate an ongoing transfer. If threading is a concern, consider calling terminate() from your status reporters as they are typically the link between the transfer thread and your UI.

Definition at line 238 of file installmgr.cpp.

{ if (transport) transport->terminate(); }

Member Data Documentation

SWBuf InstallMgr::confPath

protected

Definition at line 75 of file installmgr.h.

std::set<SWBuf> InstallMgr::defaultMods

protected

Definition at line 73 of file installmgr.h.

SWConfig* InstallMgr::installConf

Definition at line 106 of file installmgr.h.

const unsigned int InstallMgr::MODSTAT_CIPHERED = 0x010

static

Definition at line 103 of file installmgr.h.

const unsigned int InstallMgr::MODSTAT_CIPHERKEYPRESENT = 0x020

static

Definition at line 104 of file installmgr.h.

const unsigned int InstallMgr::MODSTAT_NEW = 0x008

static

Definition at line 102 of file installmgr.h.

const unsigned int InstallMgr::MODSTAT_OLDER = 0x001

static

Definition at line 99 of file installmgr.h.

const unsigned int InstallMgr::MODSTAT_SAMEVERSION = 0x002

static

Definition at line 100 of file installmgr.h.

const unsigned int InstallMgr::MODSTAT_UPDATED = 0x004

static

Definition at line 101 of file installmgr.h.

SWBuf InstallMgr::p

protected

Definition at line 79 of file installmgr.h.

bool InstallMgr::passive

protected

Definition at line 77 of file installmgr.h.

char* InstallMgr::privatePath

protected

Definition at line 74 of file installmgr.h.

InstallSourceMap InstallMgr::sources

all remote sources configured for this installmgr. Use this to gain access to individual remote sources.

Definition at line 111 of file installmgr.h.

StatusReporter* InstallMgr::statusReporter

protected

Definition at line 76 of file installmgr.h.

long InstallMgr::timeoutMillis

protected

Definition at line 78 of file installmgr.h.

RemoteTransport* InstallMgr::transport

protected

we have a transport member to set as current running transport so we can ask it to terminate below, if user requests

Definition at line 94 of file installmgr.h.

SWBuf InstallMgr::u

protected

Definition at line 79 of file installmgr.h.

bool InstallMgr::unverifiedPeerAllowed

protected

Definition at line 80 of file installmgr.h.

bool InstallMgr::userDisclaimerConfirmed = false

static

Definition at line 98 of file installmgr.h.

---

The documentation for this class was generated from the following files:

• include/installmgr.h
• src/mgr/installmgr.cpp