installmgr.cpp File Reference

#include <swmgr.h>
#include <installmgr.h>
#include <remotetrans.h>
#include <filemgr.h>
#include <iostream>
#include <map>
#include <swmodule.h>
#include <swoptfilter.h>
#include <stdio.h>
#include <swlog.h>
#include <swversion.h>

Include dependency graph for installmgr.cpp:

Go to the source code of this file.

Classes
class	MyInstallMgr
class	MyStatusReporter

Functions
void	createBasicConfig (bool enableRemote, bool addCrossWire, bool unverifiedPeerAllowed)
void	finish (int status)
void	init ()
void	initConfig ()
bool	isUnverifiedPeerAllowed ()
void	listModules (SWMgr *otherMgr=0, bool onlyNewAndUpdates=false, bool utilModules=false)
void	listRemoteSources ()
void	localDirInstallModule (const char *dir, const char *modName)
void	localDirListModules (const char *dir)
int	main (int argc, char **argv)
void	refreshRemoteSource (const char *sourceName)
void	remoteDescribeModule (const char *sourceName, const char *modName)
void	remoteInstallModule (const char *sourceName, const char *modName)
void	remoteListModules (const char *sourceName, bool onlyNewAndUpdated=false, bool utilModules=false)
void	syncConfig ()
void	uninstallModule (const char *modName)
void	usage (const char *progName=0, const char *error=0)

Variables
SWBuf	baseDir
SWBuf	confPath
InstallMgr *	installMgr = 0
bool	isConfirmedByForce
bool	isUnvPeerAllowed
SWMgr *	mgr = 0
StatusReporter *	statusReporter = 0

Function Documentation

void createBasicConfig	(	bool	enableRemote,
		bool	addCrossWire,
		bool	unverifiedPeerAllowed
	)

Definition at line 200 of file installmgr.cpp.

                                                                                         {

    FileMgr::createParent(confPath.c_str());
    remove(confPath.c_str());

    InstallSource is("FTP");
    is.caption = "CrossWire";
    is.source = "ftp.crosswire.org";
    is.directory = "/pub/sword/raw";

    SWConfig config(confPath.c_str());
    config["General"]["PassiveFTP"] = "true";
    config["General"]["TimeoutMillis"] = "10000";
    config["General"]["UnverifiedPeerAllowed"] = (unverifiedPeerAllowed) ? "true" : "false";
    if (enableRemote) {
        config["Sources"]["FTPSource"] = is.getConfEnt();
    }
    config.save();
}

void finish

(

int

status

)

Definition at line 185 of file installmgr.cpp.

                        {
    delete statusReporter;
    delete installMgr;
    delete mgr;

    installMgr = 0;
    mgr        = 0;

    if (status < 1) {
        cout << "\n";
        exit(status);
    }
}

void init

(

)

Definition at line 164 of file installmgr.cpp.

            {
    if (!mgr) {
        mgr = new SWMgr();

        if (!mgr->config)
            usage(0, "ERROR: SWORD configuration not found.  Please configure SWORD before using this program.");

        SWBuf baseDir = FileMgr::getSystemFileMgr()->getHomeDir();
        if (baseDir.length() < 1) baseDir = ".";
        baseDir += "/.sword/InstallMgr";
        confPath = baseDir + "/InstallMgr.conf";
        statusReporter = new MyStatusReporter();
        installMgr = new MyInstallMgr(baseDir, statusReporter);
        if (isConfirmedByForce) { 
            installMgr->setUserDisclaimerConfirmed(true);
        }
    }
}

void initConfig

(

)

Definition at line 221 of file installmgr.cpp.

                  {
    init();

    bool enable = installMgr->isUserDisclaimerConfirmed();
    bool allowed = isUnverifiedPeerAllowed();

    createBasicConfig(enable, true, allowed);

    cout << "\n\nInitialized basic config file at [" << confPath << "]\n";
    cout << "with remote source features " << ((enable) ? "ENABLED" : "DISABLED") << "\n";
    cout << "with unverified peers " << ((allowed) ? "ALLOWED" : "DISALLOWED") << "\n";
}

bool isUnverifiedPeerAllowed

(

)

Definition at line 110 of file installmgr.cpp.

                               {
    static bool allowed = false;
    
    if (isUnvPeerAllowed) { 
        allowed = true;
    }
        if (!allowed) {
        cout << "\n\n";
        cout << "While connecting to an encrypted install source, SWORD can allow\n";
        cout << "unverified peers, e.g., self-signed certificates. While this is\n";
        cout << "generally considered safe because SWORD only retrieves Bible content\n";
        cout << "and does not send any data to the server, it could still possibly\n";
        cout << "allow a malicious actor to sit between you and the server, as with\n";
        cout << "unencrypted sources.  Type no to turn this off.\n\n";
        cout << "Would you like to allow unverified peers? [yes] ";

        char prompt[10];
        fgets(prompt, 9, stdin);
        allowed = (strcmp(prompt, "no\n"));
        cout << "\n";
    }
    return allowed;
}

void listModules	(	SWMgr *	otherMgr = 0,
		bool	onlyNewAndUpdates = false,
		bool	utilModules = false
	)

Definition at line 294 of file installmgr.cpp.

                                                                                                {
    init();
    SWModule *module;
    if (!otherMgr) otherMgr = mgr;
    std::map<SWModule *, int> mods = InstallMgr::getModuleStatus(*mgr, *otherMgr, utilModules);
    for (std::map<SWModule *, int>::iterator it = mods.begin(); it != mods.end(); it++) {
        module = it->first;
        SWBuf version = module->getConfigEntry("Version");
        SWBuf status = " ";
        if (it->second & InstallMgr::MODSTAT_NEW) status = "*";
        if (it->second & InstallMgr::MODSTAT_OLDER) status = "-";
        if (it->second & InstallMgr::MODSTAT_UPDATED) status = "+";

        if (!onlyNewAndUpdates || status == "*" || status == "+") {
            cout << status << "[" << module->getName() << "]  \t(" << version << ")  \t- " << module->getDescription() << "\n";
        }
    }
}

void listRemoteSources

(

)

Definition at line 268 of file installmgr.cpp.

                         {
    init();
    cout << "Remote Sources:\n\n";
    for (InstallSourceMap::iterator it = installMgr->sources.begin(); it != installMgr->sources.end(); it++) {
        cout << "[" << it->second->caption << "]\n";
        cout << "\tType     : " << it->second->type << "\n";
        cout << "\tSource   : " << it->second->source << "\n";
        cout << "\tDirectory: " << it->second->directory << "\n";
    }
}

void localDirInstallModule	(	const char *	dir,
		const char *	modName
	)

Definition at line 383 of file installmgr.cpp.

                                                                 {
    init();
    SWMgr lmgr(dir);
    SWModule *module = lmgr.getModule(modName);
    if (!module) {
        fprintf(stderr, "Module [%s] not available at path [%s]\n", modName, dir);
        finish(-4);
    }
    int error = installMgr->installModule(mgr, dir, module->getName());
    if (error) {
        cout << "\nError installing module: [" << module->getName() << "] (write permissions?)\n";
    } else cout << "\nInstalled module: [" << module->getName() << "]\n";
}

void localDirListModules

(

const char *

dir

)

Definition at line 354 of file installmgr.cpp.

                                          {
    cout << "Available Modules:\n\n";
    SWMgr mgr(dir);
    listModules(&mgr);
}

int main	(	int	argc,
		char **	argv
	)

Definition at line 436 of file installmgr.cpp.

                                {
    
    isConfirmedByForce = false;
    isUnvPeerAllowed = false;
    
    if (argc < 2) usage(*argv);

    for (int i = 1; i < argc; i++) {
        if (!strcmp(argv[i], "-d")) {
            SWLog::getSystemLog()->setLogLevel(SWLog::LOG_DEBUG);
        }
        else if (!strcmp(argv[i], "--allow-internet-access-and-risk-tracing-and-jail-or-martyrdom")) {
            isConfirmedByForce = true;
        }
        else if (!strcmp(argv[i], "--allow-unverified-tls-peer")) {
            isUnvPeerAllowed = true;
        }
        else if (!strcmp(argv[i], "-init")) {
            initConfig();
        }
        else if (!strcmp(argv[i], "-l")) {  // list installed user modules
            cout << "Installed User Modules:\n\n";
            listModules();
        }
        else if (!strcmp(argv[i], "-lu")) { // list installed utility modules
            cout << "Installed Utility Modules:\n\n";
            listModules(0, false, true);
        }
        else if (!strcmp(argv[i], "-ll")) { // list from local directory
            if (i+1 < argc) localDirListModules(argv[++i]);
            else usage(*argv, "-ll requires <path>");
        }
        else if (!strcmp(argv[i], "-li")) { // install from local directory
            if (i+2 < argc) {
                const char *path = argv[++i];
                const char *modName = argv[++i];
                localDirInstallModule(path, modName);
            }
            else usage(*argv, "-li requires <path> <modName>");
        }
        else if (!strcmp(argv[i], "-u")) {  // uninstall module
            if (i+1 < argc) uninstallModule(argv[++i]);
            else usage(*argv, "-u requires <modName>");
        }
        else if (!strcmp(argv[i], "-s")) {  // list sources
            listRemoteSources();
        }
        else if (!strcmp(argv[i], "-sc")) { // sync config with master
            syncConfig();
        }
        else if (!strcmp(argv[i], "-r")) {  // refresh remote source
            if (i+1 < argc) refreshRemoteSource(argv[++i]);
            else usage(*argv, "-r requires <remoteSrcName>");
        }
        else if (!strcmp(argv[i], "-rl")) { // list remote user modules
            if (i+1 < argc) remoteListModules(argv[++i]);
            else usage(*argv, "-rl requires <remoteSrcName>");
        }
        else if (!strcmp(argv[i], "-rlu")) {    // list remote utility modules
            if (i+1 < argc) remoteListModules(argv[++i], false, true);
            else usage(*argv, "-rlu requires <remoteSrcName>");
        }
        else if (!strcmp(argv[i], "-rd")) { // list differences between remote source and installed user modules
            if (i+1 < argc) remoteListModules(argv[++i], true);
            else usage(*argv, "-rd requires <remoteSrcName>");
        }
        else if (!strcmp(argv[i], "-rdu")) {    // list differences between remote source and installed utility modules
            if (i+1 < argc) remoteListModules(argv[++i], true, true);
            else usage(*argv, "-rdu requires <remoteSrcName>");
        }
        else if (!strcmp(argv[i], "-rdesc")) {  // describe remove module
            if (i+2 < argc) {
                const char *source = argv[++i];
                const char *modName = argv[++i];
                remoteDescribeModule(source, modName);
            }
            else usage(*argv, "-rdesc requires <remoteSrcName> <modName>");
        }
        else if (!strcmp(argv[i], "-ri")) { // install from remote directory
            if (i+2 < argc) {
                const char *source = argv[++i];
                const char *modName = argv[++i];
                remoteInstallModule(source, modName);
            }
            else usage(*argv, "-ri requires <remoteSrcName> <modName>");
        }
        else usage(*argv, (((SWBuf)"Unknown argument: ")+ argv[i]).c_str());
    }

    finish(0);

    return 0;
}

void refreshRemoteSource

(

const char *

sourceName

)

Definition at line 280 of file installmgr.cpp.

                                                 {
    init();
    InstallSourceMap::iterator source = installMgr->sources.find(sourceName);
    if (source == installMgr->sources.end()) {
        fprintf(stderr, "Couldn't find remote source [%s]\n", sourceName);
        finish(-3);
    }

    if (!installMgr->refreshRemoteSource(source->second))
        cout << "\nRemote Source Refreshed\n";
    else    cerr << "\nError Refreshing Remote Source\n";
}

void remoteDescribeModule	(	const char *	sourceName,
		const char *	modName
	)

Definition at line 326 of file installmgr.cpp.

                                                                       {
    init();
    InstallSourceMap::iterator source = installMgr->sources.find(sourceName);
    if (source == installMgr->sources.end()) {
        fprintf(stderr, "Couldn't find remote source [%s]\n", sourceName);
        finish(-3);
    }
    SWMgr *mgr = source->second->getMgr();
    SWModule *m = mgr->getModule(modName);
    if (!m) {
        fprintf(stderr, "Couldn't find module [%s] in source [%s]\n", modName, sourceName);
        finish(-3);
    }
    cout << "Module Description\n\n";
    for (ConfigEntMap::const_iterator it = m->getConfig().begin(); it != m->getConfig().end(); ++it) {
        cout << "[" << it->first << "]:" << it->second << "\n";
    }
    cout << "\nOption Features available for module: " << m->getName() << "\n\n";
    for (OptionFilterList::const_iterator it = m->getOptionFilters().begin(); it != m->getOptionFilters().end(); ++it) {
        cout << (*it)->getOptionName() << " (" << (*it)->getOptionTip() << ")\n";
        StringList optionValues = (*it)->getOptionValues();
        for (StringList::const_iterator it2 = optionValues.begin(); it2 != optionValues.end(); ++it2) {
            cout << "\t" << *it2 << "\n";
        }
    }
}

void remoteInstallModule	(	const char *	sourceName,
		const char *	modName
	)

Definition at line 361 of file installmgr.cpp.

                                                                      {
    init();
    InstallSourceMap::iterator source = installMgr->sources.find(sourceName);
    if (source == installMgr->sources.end()) {
        fprintf(stderr, "Couldn't find remote source [%s]\n", sourceName);
        finish(-3);
    }
    InstallSource *is = source->second;
    SWMgr *rmgr = is->getMgr();
    SWModule *module = rmgr->getModule(modName);
    if (!module) {
        fprintf(stderr, "Remote source [%s] does not make available module [%s]\n", sourceName, modName);
        finish(-4);
    }

    int error = installMgr->installModule(mgr, 0, module->getName(), is);
    if (error) {
        cout << "\nError installing module: [" << module->getName() << "] (write permissions?)\n";
    } else cout << "\nInstalled module: [" << module->getName() << "]\n";
}

void remoteListModules	(	const char *	sourceName,
		bool	onlyNewAndUpdated = false,
		bool	utilModules = false
	)

Definition at line 314 of file installmgr.cpp.

                                                                                                         {
    init();
    cout << "Available Modules:\n(be sure to refresh remote source (-r) first for most current list)\n\n";
    InstallSourceMap::iterator source = installMgr->sources.find(sourceName);
    if (source == installMgr->sources.end()) {
        fprintf(stderr, "Couldn't find remote source [%s]\n", sourceName);
        finish(-3);
    }
    listModules(source->second->getMgr(), onlyNewAndUpdated, utilModules);
}

void syncConfig

(

)

Definition at line 235 of file installmgr.cpp.

                  {
    init();

    if (!installMgr->isUserDisclaimerConfirmed()) {  // assert disclaimer is accepted
        cout << "\n\nDisclaimer not accepted.  Aborting.";
        return;
    }

    // be sure we have at least some config file already out there
    if (!FileMgr::existsFile(confPath.c_str())) {
        createBasicConfig(true, false, false);
        finish(1); // cleanup and don't exit
        init();    // re-init with InstallMgr which uses our new config
    }

    if (!installMgr->refreshRemoteSourceConfiguration()) 
        cout << "\nSync'd config file with master remote source list.\n";
    else cout << "\nFailed to sync config file with master remote source list.\n";
}

void uninstallModule

(

const char *

modName

)

Definition at line 256 of file installmgr.cpp.

                                          {
    init();
    SWModule *module = mgr->getModule(modName);
    if (!module) {
        fprintf(stderr, "Couldn't find module [%s] to remove\n", modName);
        finish(-2);
    }
    installMgr->removeModule(mgr, module->getName());
    cout << "Removed module: [" << modName << "]\n";
}

void usage	(	const char *	progName = 0,
		const char *	error = 0
	)

Variable Documentation

SWBuf baseDir

Definition at line 49 of file installmgr.cpp.

SWBuf confPath

Definition at line 50 of file installmgr.cpp.

InstallMgr* installMgr = 0

Definition at line 47 of file installmgr.cpp.

bool isConfirmedByForce

Definition at line 52 of file installmgr.cpp.

bool isUnvPeerAllowed

Definition at line 53 of file installmgr.cpp.

SWMgr* mgr = 0

Definition at line 46 of file installmgr.cpp.

StatusReporter* statusReporter = 0

Definition at line 48 of file installmgr.cpp.