utilities/installmgr.cpp File Reference

#include <swmgr.h>
#include <installmgr.h>
#include <ftptrans.h>
#include <filemgr.h>
#include <iostream>
#include <map>
#include <swmodule.h>
#include <stdio.h>
#include <swlog.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)
void	finish (int status)
void	init ()
void	initConfig ()
void	listModules (SWMgr *otherMgr=0, bool onlyNewAndUpdates=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	remoteInstallModule (const char *sourceName, const char *modName)
void	remoteListModules (const char *sourceName, bool onlyNewAndUpdated=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
SWMgr *	mgr = 0
StatusReporter *	statusReporter = 0

---

Function Documentation

void createBasicConfig	(	bool	enableRemote,
		bool	addCrossWire
	)

Definition at line 145 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";
    if (enableRemote) {
        config["Sources"]["FTPSource"] = is.getConfEnt();
    }
    config.Save();
}

void finish

(

int

status

)

Definition at line 130 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 112 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 = mgr->getHomeDir();
        if (baseDir.length() < 1) baseDir = ".";
        baseDir += "/.sword/InstallMgr";
        confPath = baseDir + "/InstallMgr.conf";
        statusReporter = new MyStatusReporter();
        installMgr = new MyInstallMgr(baseDir, statusReporter);
    }
}

void initConfig

(

)

Definition at line 164 of file installmgr.cpp.

                  {
    init();

    bool enable = installMgr->isUserDisclaimerConfirmed();

    createBasicConfig(enable, true);

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

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

Definition at line 237 of file installmgr.cpp.

                                                                      {
    init();
    SWModule *module;
    if (!otherMgr) otherMgr = mgr;
    std::map<SWModule *, int> mods = InstallMgr::getModuleStatus(*mgr, *otherMgr);
    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 211 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 300 of file installmgr.cpp.

                                                                 {
    init();
    SWMgr lmgr(dir);
    SWModule *module;
    ModMap::iterator it = lmgr.Modules.find(modName);
    if (it == lmgr.Modules.end()) {
        fprintf(stderr, "Module [%s] not available at path [%s]\n", modName, dir);
        finish(-4);
    }
    module = it->second;
    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 269 of file installmgr.cpp.

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

int main	(	int	argc,
		char **	argv
	)

Definition at line 342 of file installmgr.cpp.

                                {

    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], "-init")) {
            initConfig();
        }
        else if (!strcmp(argv[i], "-l")) {  // list installed modules
            cout << "Installed Modules:\n\n";
            listModules();
        }
        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 modules
            if (i+1 < argc) remoteListModules(argv[++i]);
            else usage(*argv, "-rl requires <remoteSrcName>");
        }
        else if (!strcmp(argv[i], "-rd")) { // list differences between remote source and installed modules
            if (i+1 < argc) remoteListModules(argv[++i], true);
            else usage(*argv, "-rd requires <remoteSrcName>");
        }
        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 223 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 remoteInstallModule	(	const char *	sourceName,
		const char *	modName
	)

Definition at line 276 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;
    ModMap::iterator it = rmgr->Modules.find(modName);
    if (it == rmgr->Modules.end()) {
        fprintf(stderr, "Remote source [%s] does not make available module [%s]\n", sourceName, modName);
        finish(-4);
    }
    module = it->second;

    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
	)

Definition at line 257 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);
}

void syncConfig

(

)

Definition at line 176 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);
        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 197 of file installmgr.cpp.

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

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

Definition at line 317 of file installmgr.cpp.

                                                    {

    if (error) fprintf(stderr, "\n%s: %s\n", (progName ? progName : "installmgr"), error);

    fprintf(stderr, "\nusage: %s <command> [command ...]\n"
        "\n  Commands (run in order they are passed):\n\n"
        "\t-init\t\t\t\tcreate a basic user config file.\n"
        "\t\t\t\t\t\tWARNING: overwrites existing.\n"
        "\t-sc\t\t\t\tsync config with known remote repo list\n"
        "\t\t\t\t\t\tNOTE: also creates if none exists\n"
        "\t-s\t\t\t\tlist remote sources\n"
        "\t-r  <remoteSrcName>\t\trefresh remote source\n"
        "\t-rl <remoteSrcName>\t\tlist available modules from remote source\n"
        "\t-rd <remoteSrcName>\t\tlist new/updated modules from remote source\n"
        "\t-ri <remoteSrcName> <modName>\tinstall module from remote source\n"
        "\t-l\t\t\t\tlist installed modules\n"
        "\t-u <modName>\t\t\tuninstall module\n"
        "\t-ll <path>\t\t\tlist available modules at local path\n"
        "\t-li <path> <modName>\t\tinstall module from local path\n"
        "\t-d\t\t\t\tturn debug output on\n"
        , (progName ? progName : "installmgr"));
    finish(-1);
}

---

Variable Documentation

SWBuf baseDir

Definition at line 42 of file installmgr.cpp.

SWBuf confPath

Definition at line 43 of file installmgr.cpp.

InstallMgr* installMgr = 0

Definition at line 40 of file installmgr.cpp.

SWMgr* mgr = 0

Definition at line 39 of file installmgr.cpp.

StatusReporter* statusReporter = 0

Definition at line 41 of file installmgr.cpp.