ScriptingAgent.h

Go to the documentation of this file.

// -*- c++ -*-

/*
 *  Authors:    Arvin Schnell <arvin@suse.de>
 *              Klaus Kaempf <kkaempf@suse.de>
 *              Stanislav Visnovsky <visnov@suse.cz>
 *  Maintainer: Arvin Schnell <arvin@suse.de>
 */


#ifndef ScriptingAgent_h
#define ScriptingAgent_h

#include <time.h>
#include <y2/Y2Component.h>
#include <scr/SCRAgent.h>
#include "SCRSubAgent.h"

class ScriptingAgent : public SCRAgent
{

public:

    ScriptingAgent ();

    // used only in agent-ini/testsuite...?
    // TODO try to eliminate it
    ScriptingAgent (const string& file);

    ~ScriptingAgent ();

    virtual YCPValue Read (const YCPPath &path, const YCPValue &arg = YCPNull (), const YCPValue &opt = YCPNull ());

    virtual YCPBoolean Write (const YCPPath &path, const YCPValue &value,
                    const YCPValue &arg = YCPNull ());

    virtual YCPList Dir (const YCPPath &path);

    virtual YCPValue Execute (const YCPPath &path, const YCPValue &value =
                      YCPNull (), const YCPValue &arg = YCPNull ());

    virtual YCPMap Error (const YCPPath &path);

    YCPValue otherCommand (const YCPTerm &term);

    virtual YCPBoolean RegisterAgent (const YCPPath &path, const YCPValue &value);

    virtual YCPBoolean UnregisterAgent (const YCPPath &path);

    virtual YCPBoolean UnregisterAllAgents ();

    virtual YCPBoolean UnmountAgent (const YCPPath &path);

    virtual YCPBoolean RegisterNewAgents ();


private:

    // once we have to do a sweep (read all scr files because of
    // a Dir or we were not lucky with a path patch), set this flag so
    // that we do not unnecessarily sweep again
    bool done_sweep;

    // FIXME rethink the caching
    struct RegistrationDir {
        string name;
        time_t last_changed; 
    };

    list<RegistrationDir> registration_dirs;

    void InitRegDirs ();

    typedef vector<SCRSubAgent*> SubAgents;
    SubAgents agents;


    YCPValue MountAgent (const YCPPath &path);

    YCPValue MountAllAgents ();

    YCPValue UnmountAllAgents ();

    void Sweep ();

    void tryRegister (const YCPPath &path);

    SubAgents::const_iterator findSubagent (const YCPPath &path);

    SubAgents::const_iterator findAndRegisterSubagent (const YCPPath &path);

    YCPList dirSubagents (const YCPPath &path);

    YCPValue executeSubagentCommand (const char *command,
                                     const YCPPath &path,
                                     const YCPValue &arg = YCPNull (),
                                     const YCPValue &optpar = YCPNull ());

    SubAgents::iterator findByPath (const YCPPath &path);

    void parseConfigFiles (const string &directory);

    void parseSingleConfigFile (const string &file);

};


#endif // ScriptingAgent_h