vos/applibs/daemon/vosdaemon.cc

Go to the documentation of this file.

/* $Id: vosdaemon.cc,v 1.14 2003/08/06 08:04:10 tetron Exp $ */


/** @file vosdaemon.cc
    @author Reed Hedges (reed@zerohour.net)

    Copyright 2003 Reed Hedges

    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 2 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, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#if defined(_WIN32) && defined(_MSC_VER)
# include <vos/applibs/vos_applibs_config-vc7.h>
#else
# include <vos/applibs/vos_applibs_config.h>
#endif

#ifdef HAVE_GETOPT_LONG
# define _GNU_SOURCE
typedef struct option LongOptionStruct;
#endif

#ifdef HAVE_GETOPT_H
# include <getopt.h>
#endif

#ifdef HAVE_UNISTD_H
# include <unistd.h>
#endif

#ifdef HAVE_SIGNAL
#include <signal.h>
#endif

#include <stdlib.h>

#include <iostream>
#include <fstream>

#include <vos/metaobjects/property/property.hh>

#include "vosdaemon.hh"


#if 0
// The most recently created vosdaemon.
VOSDaemon* _daemon = 0;

void _VOSDaemon_killsignal(int signal)  {
    if(_daemon) {
        _daemon->save();
        delete _daemon;
    }
    exit(0);
}

void _VOSDaemon_hupsignal(int signal) {
    if(_daemon)
        _daemon->save();
}

void _VOSDaemon_autosave(void* something) {
    VOSDaemon* daemon = (VOSDaemon*)something;
    if(daemon) {
        daemon->save();
    }
}
#endif

VOSDaemon::~VOSDaemon() {
    fflush(stdout);
    fflush(stderr);
    if(logStream) {
        logStream->flush();
        delete logStream;
    }
    LOG(programName, 2, "goodbye.");
}



VOSDaemon::VOSDaemon(char* progName, LocalSite* s) : 
    saveFreq(0), rootObj(0), programName(progName), rootName(0), 
    mayLoad(false), maySave(false), mayNameRoot(false),
    loadfile(0), dontFork(false)
{
    int n = strlen("/var/log/") + strlen(programName) + 1;
    logFile = (char*) malloc(n * sizeof(char));
    snprintf(logFile, n, "/var/log/%s", programName);
    if(s) 
        site = s;
    else {
        site = new LocalSocketSite(&NoAccessControl::static_);
        site->setTimeoutOnSelect(-1);
    }
}

/*
void VOSDaemon::enableArg_load(bool p) {
    mayLoad = p;
}

void VOSDaemon::enableArg_save(bool p) {
    maySave = p;
}

void VOSDaemon::enableArg_nameRoot(bool p) {
    mayNameRoot = p;
}

void VOSDaemon::setRootObject(Vobject* obj) {
    if(rootObj)
        rootObj->release();
    rootObj = obj;
    rootObj->acquire(); // released at exit or next call to setRootObj
}

void VOSDaemon::setSaveFile(char* sf) {
    saveFile = sf;
}

void VOSDaemon::setSaveFrequency(int freq) {
    saveFreq = freq;
}

void VOSDaemon::setRootName(char* name) {
    rootName = name;
}

*/

void VOSDaemon::setLogFile(char* file) {
    logFile = file;
}

void VOSDaemon::setLogLevel(int lev) {
    Log::setDefaultLevel(lev);
}



void VOSDaemon::checkArgs(int argc, char** argv) {

    // start the getopt string and the getopt_long array out with the default
    // VOSDaemon arguments.
    
    string optstring = "-hE:L:N";
    /*
    if(mayLoad)
        optstring += "l:";
    if(maySave) {
        optstring += "s:";
        optstring += "S:";
    }
    if(mayNameRoot)
        optstring += "n:";
        */

#ifdef HAVE_GETOPT_LONG
    LongOptionStruct *longopts;
    longopts = (LongOptionStruct*)malloc( (7 + args.size()) * sizeof(LongOptionStruct));
    int l = 0;

    longopts[l].name = "help"; 
    longopts[l].has_arg = no_argument;
    longopts[l].flag = NULL;
    longopts[l].val = 'h';
    l++;

    longopts[l].name = "log"; 
    longopts[l].has_arg = required_argument;
    longopts[l].flag = NULL;
    longopts[l].val = 'L';
    l++;

    longopts[l].name = "loglevel"; 
    longopts[l].has_arg = required_argument;
    longopts[l].flag = NULL;
    longopts[l].val = 'E';
    l++;

    /*
#ifdef HAVE_SIGNAL
    if(maySave) {
        longopts[l].name = "save"; 
        longopts[l].has_arg = required_argument;
        longopts[l].flag = NULL;
        longopts[l].val = 's';
        l++;

        longopts[l].name = "save-freq"; 
        longopts[l].has_arg = required_argument;
        longopts[l].flag = NULL;
        longopts[l].val = 'S';
        l++;
    }
#endif

    if(mayLoad) {
        longopts[l].name = "load"; 
        longopts[l].has_arg = required_argument;
        longopts[l].flag = NULL;
        longopts[l].val = 'l';
        l++;
    }

    if(mayNameRoot) {
        longopts[l].name = "name"; 
        longopts[l].has_arg = required_argument;
        longopts[l].flag = NULL;
        longopts[l].val = 'n';
        l++;
    }
    */
#endif

    // Now build options string and long options array with arg the user
    // has added with addArg and addFlag, after checking for environment
    // variables and pre-setting the arg value.

    for(ArgMap::iterator i = args.begin(); i != args.end(); i++) {

        // first add any environment variables that are present
        if(i->second.envVar != "") {
            char* e = getenv(i->second.envVar.c_str());
            if(e) {
                i->second.given = true;
                if(!(i->second.isFlag)) {
                    i->second.value = e;
                }
            }
        }

        // now add arg to the getopt string of short names (single chars)
        if(i->second.argChar != 0) {
            optstring += i->second.argChar;
            if(!(i->second.isFlag))
                optstring += ":";
        }

#ifdef HAVE_GETOPT_LONG
        // now add an entry to the array of long options structs.
        longopts[l].name = i->second.argName.c_str();
        if(i->second.isFlag)
            longopts[l].has_arg = no_argument;
        else
            longopts[l].has_arg = required_argument;
        longopts[l].flag = NULL;
        longopts[l].val = 0;
        l++;
#endif

    }

#ifdef HAVE_GETOPT_LONG
    // terminate array of long option structs
    memset(&longopts[l], 0, sizeof(LongOptionStruct));
#endif

    // finally, use getopt() and getopt_long() to check command line arguments:
    int *indexp = new int;
    *indexp = -1;
    char o = 0;
    while( (o = 
#ifdef HAVE_GETOPT_LONG
            getopt_long(argc, argv, optstring.c_str(), longopts, indexp) 
#else
            getopt(argc, argv, optstring.c_str())
#endif
     ) != -1 ) {

        if(o == 1) {        // random text given with out preceding flags
            printHelp();
            exit(-1);
        }

        ArgInfo* ai = 0;
#ifdef HAVE_GETOPT_LONG
        if(o == 0) {
            assert(indexp);
            assert(*indexp > 0);
            ai = &(args[longopts[*indexp].name]);
        } else 
#endif
        {
            if(checkBuiltinArgs(o, optarg))
                continue;
            assert(shortArgs.count(o) > 0);   
            ai = shortArgs[o]; 
        }
        assert(ai);
        ai->given = true;
        if(!(ai->isFlag) && (optarg != 0)) {
            ai->value = strdup(optarg);
        }
    }

    delete indexp;
#ifdef HAVE_GETOPT_LONG
    free(longopts);
#endif

}

void VOSDaemon::printHelp() {
    bool have_long;
#ifdef HAVE_GETOPT_LONG
    have_long = true;
#else
    have_long = false;
#endif

    cout << "Usage:\n\t" << programName << " [options]\nOptions:\n";

#ifdef HAVE_FORK
    cout << "\t-N\tDon't run in the background.\n";
#endif

    cout << "\t-h " << (have_long?"or --help":"") << "\tPrint a brief help message.\n" <<
        "\t-L <FILENAME>" << (have_long?" or --log <FILENAME>":"") << "\tLog to file <FILENAME>.  (default is /var/log/" << programName <<")  Use \"-L -\" to log to stdout (-N is implied in this case).\n" <<
        "\t-E <LEVEL>" << (have_long?" or --loglevel <LEVEL>":"") << "\tSet log level to <LEVEL> (default is " << Log::getDefaultLevel() <<").\n";

    /*
    if(mayNameRoot)
        cout << "\t-n <NAME>" << (have_long?" or --name <NAME>":"") << "\tName the root object <NAME> (default is \"" << rootName << "\")\n";
    if(mayLoad)
        cout << "\t-l <FILE>" << (have_long?" or --load <FILE>":"") << "\tLoad objects from vop script <FILE>.\n";
#ifdef HAVE_SIGNAL
    if(maySave)
        cout << "\t-s <FILE>" << (have_long?" or --save <FILE>":"") << "\tSave state to vop script <FILE> when SIGINT, SIGTERM, SIGHUP, or SIGABRT signals are recieved or at a given frequency (see below). You can kill the program without saving by using SIGQUIT (CTRL-\\). Default save file is \"" << saveFile << "\"\n" <<
                "\t-S <FREQ>" << (have_long?" or --save-freq <FREQ>":"") << "\tUsed in combination with -s, specifies frequency to save world ntate to disk. Default frequency is \"" << saveFreq << "\" sec\n";
#endif
    */

    for(ArgMap::const_iterator i = args.begin(); i != args.end(); i++) {
        cout << "\t-" << i->second.argChar;
        cout << " " << i->second.valueLabel;   // will be "" if it's a flag
        if(have_long) {
            cout << " or --" << i->second.argName;
            cout << " " << i->second.valueLabel;   // will be "" if it's a flag
        }
        cout << "\t" << i->second.description << endl;
    }
    if(have_long)
        cout << "\nNote that long argument names may not be available on all platforms.\n";
}

bool VOSDaemon::checkBuiltinArgs(char o, char* val) {
    switch(o) {
        case '?':
        case 'h':
            printHelp();
            exit(0);
        case 'E':
            Log::setDefaultLevel( atoi(val) );
            return true;
        case 'L':
            if(logFile)
                free(logFile);
            logFile = strdup(val);
            return true;
        /*
        case 'n':
            rootName = strdup(val);
            return true;
        case 'l':
            loadfile = strdup(val);
            return true;
        case 's':
            saveFile = strdup(val);
            return true;
        case 'S':
            saveFreq = atoi(val);
            return true;
        */
        case 'N':
            dontFork = true;
            return true;
    }
    return false;
}


void VOSDaemon::run() {

    // Send log messages to a file, if requested
    if(!strcmp(logFile, "-")) {
        Log::setDefaultOutputStream(&cout);
        dontFork = true;
    } else {
        ofstream* l = new ofstream(logFile, ofstream::app);
        if(l->bad()) {
            cerr << "Warning: could not open log file (" << logFile << "). No logging will occur." << endl;
            Log::setDefaultLevel(0);
            logStream = 0;
            fclose(stdout);
            fclose(stderr);
            fclose(stdin);
        } else {
            Log::setDefaultOutputStream(l);
            //cerr = cout = clog = *l; STLPort doesn't like this
            logStream = l;

            // XXX this is not the best way to do it, but it is OK for now:
            // streams should be set non-buffered, or some way of relaying
            // stdout->cout and stderr->cerr should be found
            // (streambuf::sync_with_stdio(true)??
            freopen(logFile, "a", stdout);
            freopen(logFile, "a", stderr);
            fclose(stdin);
        }
    }


#if 0
    try {
        // load from disk?
        if(loadfile) {
            LOG("VOSDaemon", 0, "Oops, loading is not implemented.");
            /*
            LOG(programName, 2, "Loading \"" << loadfile << "\"...");
            RemoteStreamSite::runScript(string(loadfile), *this);
            LOG(programName, 2, "Done.");
            */
        }
    } catch(exception& e) {
        LOG(programName, 0, "Error: " << e.what() );
        exit(-1);
    }
#endif

#ifdef HAVE_SIGNAL
    // set signal hanlers
    /*
    _daemon = this;
    if(saveFile) {
        signal(SIGABRT, _VOSDaemon_killsignal);
        signal(SIGINT, _VOSDaemon_killsignal);
        signal(SIGTERM, _VOSDaemon_killsignal);
        signal(SIGHUP, _VOSDaemon_hupsignal);
    }
    */
#endif


    /* Set periodic autosave */
    /*
    if(saveFreq > 0) {
        site->addCallback(_VOSDaemon_autosave, this, saveFreq, true);
    }
    */

#ifdef HAVE_FORK
    if(!dontFork) {
        // fork
        int pid;
        pid = fork();
        if (pid == -1)  {
            cerr << "Error forking daemon!\n";
            exit(-2);
        }
        if (pid != 0) {   // exit parent process
            cerr << "Running in background with PID " << pid << endl;
            exit(0);
        }
    }
#else
//#warning HAVE_FORK was not defined, so daemons will not run in the background.
#endif


    // Run
    try {
        LOG(programName, 3, "Site running... ");
        if(rootObj) LOG(programName, 1, "Root object is: " << rootObj->getURL().getString() );
        while(true)  {
            site->flushIncomingBuffers();
            loop();
        }
    } catch(exception& e) {
        LOG(programName, 0, "Error: " << e.what() << " (" << typeid(e).name() << ")" );
        exit(-1);
    }

}


void VOSDaemon::save() {
    LOG("VOSDaemon", 0, "Oops, saving is not implemented.");
/*
    if(_VOSDaemon_rootObj && _VOSDaemon_saveFile) {
        LOG(_VOSDaemon_progName, 2, "Saving world state to \"" << _VOSDaemon_saveFile << "\"...");
        MessageBlock block;
        _VOSDaemon_rootObj->saveState(block, true, false, true, true );
        FILE* f = fopen(_VOSDaemon_saveFile, "w");
        if(!f) {
            LOG(_VOSDaemon_progName, 0, "Error saving world state: could not open file \"" << _VOSDaemon_saveFile << "\" for writing.");
            exit(-1);
        }
        pREF(Message*, m, new Message(),
            m->setType("message");
            m->setMethod("core:hello");
            fwrite(m->getFormattedString().c_str(), m->getFormattedString().length(), 1, f);
            fwrite("\n", 1, 1, f);
        );
        fwrite(block.getString().c_str(), block.getString().length(), 1, f);
        fclose(f);
    }
*/
}

    

void VOSDaemon::addArg(string argName, string valueLabel, string description, char argChar, string envVar) {
    args[argName].argName = argName;
    args[argName].valueLabel = valueLabel;
    args[argName].description = description;
    args[argName].argChar = argChar;
    args[argName].isFlag = false;
    args[argName].given = false;
    args[argName].value = "";
    args[argName].envVar = envVar;
    if(argChar != 0)
        shortArgs[argChar] = &args[argName];
}

void VOSDaemon::addArg(string argName, string valueLabel, string description, string defaultValue, char argChar, string envVar) {
    addArg(argName, valueLabel, description, argChar, envVar);
    args[argName].value = defaultValue;
    args[argName].given = true;
}

void VOSDaemon::addFlag(string name, string descrip, char flagch, string envVar) {
    addArg(name, "", descrip, flagch, envVar);
    args[name].isFlag = true;
}


string VOSDaemon::getArg(string name) {
    if(args.count(name) == 0)
        throw runtime_error("No such argument registered. use addArg().");
    if(!args[name].given)
        throw runtime_error("Argument not given.");
    return args[name].value;
}

bool VOSDaemon::argGiven(string argName) {
    if(args.count(argName) == 0)
        throw runtime_error("No such argument registered. use addArg().");
    return args[argName].given;
}

void VOSDaemon::debugArgs() {
    for(ArgMap::const_iterator i = args.begin(); i != args.end(); i++) {
        cerr << "Argument name=" << i->second.argName << endl;
        cerr << "\tvalueLabel=" << i->second.valueLabel << endl;
        cerr << "\tvalue=" << i->second.value << endl;
        cerr << "\targChar=" << i->second.argChar << endl;
        cerr << "\tisFlag=" << ((i->second.isFlag)?"true":"false") << endl;
        cerr << "\tdescription=" << i->second.description << endl;
        cerr << "\tgiven=" << ((i->second.given)?"true":"false") << endl;
        cerr << "\tenvVar=" << i->second.envVar << endl;
    }
}

---