Open Source Projects Europe

    ConfNull *cloneMainConfig();

    ConfNull *cloneMainConfig();

    /** (re)Read recoll.conf */

    /** (re)Read recoll.conf */

    bool updateMainConfig();

    bool updateMainConfig();

    bool ok() {return m_ok;}

    const string &getReason() {return m_reason;}

    /** Return the directory where this configuration is stored. 

    /** Return the directory where this configuration is stored. 

     *  This was possibly silently created by the rclconfig

     *  This was possibly silently created by the rclconfig

     *  constructor it it is the default one (~/.recoll) and it did 

     *  constructor it it is the default one (~/.recoll) and it did 

     *  not exist yet. */

     *  not exist yet. */

    string getConfDir() {return m_confdir;}

    /** Check if the config files were modified since we read them */

    /** Check if the config files were modified since we read them */

    bool sourceChanged();

    /** Returns true if this is ~/.recoll */

    /** Returns true if this is ~/.recoll */

    /** Get the local value for /usr/local/share/recoll/ */

    /** Get the local value for /usr/local/share/recoll/ */

    const string& getDatadir() {return m_datadir;}

    /** Set current directory reference, and fetch automatic parameters. */

    /** Set current directory reference, and fetch automatic parameters. */

    void setKeyDir(const string &dir);

    void setKeyDir(const string &dir);

    string getKeyDir() const {return m_keydir;}

    string getKeyDir() const {return m_keydir;}

    /** Get generic configuration parameter according to current keydir */

    /** Get generic configuration parameter according to current keydir */

    bool getConfParam(const string &name, string &value) 

    {

    {

    if (m_conf == 0)

    if (m_conf == 0)

        return false;

        return false;

    return m_conf->get(name, value, m_keydir);

    return m_conf->get(name, value, m_keydir);

    }

    }

    /** Variant with autoconversion to int */

    /** Variant with autoconversion to int */

    bool getConfParam(const string &name, int *value);

    /** Variant with autoconversion to bool */

    /** Variant with autoconversion to bool */

    bool getConfParam(const string &name, bool *value);

    /** Variant with conversion to string list/vector

    /** Variant with conversion to string list/vector

     *  (stringToStrings). Can fail if the string is malformed. */

     *  (stringToStrings). Can fail if the string is malformed. */

    bool getConfParam(const string &name, vector<string> *value);

    bool getConfParam(const string &name, list<string> *value);

    /** 

    /** 

     * Get list of config names under current sk, with possible 

     * Get list of config names under current sk, with possible 

     * wildcard filtering 

     * wildcard filtering 

     */

     */

    return m_conf->getNames(m_keydir, pattern);

    return m_conf->getNames(m_keydir, pattern);

    }

    }

    /** Check if name exists anywhere in config */

    /** Check if name exists anywhere in config */

    bool hasNameAnywhere(const string& nm) 

    {

    {

        return m_conf? m_conf->hasNameAnywhere(nm) : false;

        return m_conf? m_conf->hasNameAnywhere(nm) : false;

    }

    }

    /** Get default charset for current keydir (was set during setKeydir) 

    /** Get default charset for current keydir (was set during setKeydir) 

     * filenames are handled differently */

     * filenames are handled differently */

    const string &getDefCharset(bool filename = false);

    /** Get list of top directories. This is needed from a number of places

    /** Get list of top directories. This is needed from a number of places

     * and needs some cleaning-up code. An empty list is always an error, no

     * and needs some cleaning-up code. An empty list is always an error, no

     * need for other status */

     * need for other status */

    list<string> getTopdirs();

    /** Get database directory */

    /** Get database directory */

    string getDbDir();

    /** Get stoplist file name */

    /** Get stoplist file name */

    string getStopfile();

    /** Get indexing pid file name */

    /** Get indexing pid file name */

    string getPidfile();

    /** Get indexing status file name */

    /** Get indexing status file name */

    string getIdxStatusFile();

    /** Get list of skipped file names for current keydir */

    /** Get list of skipped file names for current keydir */

    vector<string>& getSkippedNames();

    vector<string>& getSkippedNames();

    /** Get list of skipped paths patterns. Doesn't depend on the keydir */

    /** Get list of skipped paths patterns. Doesn't depend on the keydir */

    vector<string> getSkippedPaths();

    /** Get list of skipped paths patterns, daemon version (may add some)

    /** Get list of skipped paths patterns, daemon version (may add some)

    Doesn't depend on the keydir */

    Doesn't depend on the keydir */

    vector<string> getDaemSkippedPaths();

    /** conf: Add local fields to target dic */

    /** conf: Add local fields to target dic */

    bool addLocalFields(map<string, string> *tgt);

    /** 

    /** 

     * mimemap: Check if file name should be ignored because of suffix

     * mimemap: Check if file name should be ignored because of suffix

     *

     *

     * The list of ignored suffixes is initialized on first call, and

     * The list of ignored suffixes is initialized on first call, and

     * return command to uncompress if it is.

     * return command to uncompress if it is.

     *

     *

     * The returned command has substitutable places for input file name 

     * The returned command has substitutable places for input file name 

     * and temp dir name, and will return output name

     * and temp dir name, and will return output name

     */

     */

    bool getUncompressor(const string &mtpe, vector<string>& cmd);

    /** mimemap: compute mimetype */

    /** mimemap: compute mimetype */

    string getMimeTypeFromSuffix(const string &suffix);

    /** mimemap: get a list of all indexable mime types defined */

    /** mimemap: get a list of all indexable mime types defined */

    vector<string> getAllMimeTypes();

    /** mimemap: Get appropriate suffix for mime type. This is inefficient */

    /** mimemap: Get appropriate suffix for mime type. This is inefficient */

    string getSuffixFromMimeType(const string &mt);

    /** mimeconf: get input filter for mimetype */

    /** mimeconf: get input filter for mimetype */

    string getMimeHandlerDef(const string &mimetype, bool filtertypes=false);

    string getMimeHandlerDef(const string &mimetype, bool filtertypes=false);

    /** For lines like: "name = some value; attr1 = value1; attr2 = val2"

    /** For lines like: "name = some value; attr1 = value1; attr2 = val2"

     * Separate the value and store the attributes in a ConfSimple 

     * Separate the value and store the attributes in a ConfSimple 

     * @param whole the raw value. No way to escape a semi-colon in there.

     * @param whole the raw value. No way to escape a semi-colon in there.

     */

     */

    bool valueSplitAttributes(const string& whole, string& value, 

    /** Return icon path for mime type and tag */

    /** Return icon path for mime type and tag */

    string getMimeIconPath(const string &mt, const string& apptag);

    /** mimeconf: get list of file categories */

    /** mimeconf: get list of file categories */

    bool getMimeCategories(vector<string>&);

    /** mimeconf: is parameter one of the categories ? */

    /** mimeconf: is parameter one of the categories ? */

    bool isMimeCategory(string&);

    /** mimeconf: get list of mime types for category */

    /** mimeconf: get list of mime types for category */

    bool getMimeCatTypes(const string& cat, vector<string>&);

    /** mimeconf: get list of gui filters (doc cats by default */

    /** mimeconf: get list of gui filters (doc cats by default */

    bool getGuiFilterNames(vector<string>&);

    /** mimeconf: get query lang frag for named filter */

    /** mimeconf: get query lang frag for named filter */

    bool getGuiFilter(const string& filtername, string& frag);

    /** fields: get field prefix from field name */

    /** fields: get field prefix from field name */

    bool getFieldTraits(const string& fldname, const FieldTraits **);

    const set<string>& getStoredFields() {return m_storedFields;}

    set<string> getIndexedFields();

    /** Get canonic name for possible alias */

    /** Get canonic name for possible alias */

    string fieldCanon(const string& fld);

    /** Get xattr name to field names translations */

    /** Get xattr name to field names translations */

    const map<string, string>& getXattrToField() {return m_xattrtofld;}

    /** Get value of a parameter inside the "fields" file. Only some filters 

    /** Get value of a parameter inside the "fields" file. Only some filters 

        use this (ie: mh_mail). The information specific to a given filter

        use this (ie: mh_mail). The information specific to a given filter

        is typically stored in a separate section(ie: [mail]) */

        is typically stored in a separate section(ie: [mail]) */

    vector<string> getFieldSectNames(const string &sk, const char* = 0);

    bool getFieldConfParam(const string &name, const string &sk, string &value)

    /** mimeview: get/set external viewer exec string(s) for mimetype(s) */

    /** mimeview: get/set external viewer exec string(s) for mimetype(s) */

    string getMimeViewerDef(const string &mimetype, const string& apptag, 

    string getMimeViewerDef(const string &mimetype, const string& apptag, 

                bool useall);

    string getMimeViewerAllEx();

    bool setMimeViewerAllEx(const string& allex);

    bool setMimeViewerAllEx(const string& allex);

    bool getMimeViewerDefs(vector<pair<string, string> >&);

    bool setMimeViewerDef(const string& mimetype, const string& cmd);

    bool setMimeViewerDef(const string& mimetype, const string& cmd);

    /** Check if mime type is designated as needing no uncompress before view

    /** Check if mime type is designated as needing no uncompress before view

     * (if a file of this type is found compressed). Default is true,

     * (if a file of this type is found compressed). Default is true,

     *  exceptions are found in the nouncompforviewmts mimeview list */

     *  exceptions are found in the nouncompforviewmts mimeview list */

    bool mimeViewerNeedsUncomp(const string &mimetype);

    /** Store/retrieve missing helpers description string */

    /** Store/retrieve missing helpers description string */

    string getMissingHelperDesc();

    void storeMissingHelperDesc(const string &s);

    void storeMissingHelperDesc(const string &s);

    /** Find exec file for external filter. cmd is the command name from the

    /** Find exec file for external filter. cmd is the command name from the

     * command string returned by getMimeHandlerDef */

     * command string returned by getMimeHandlerDef */

    string findFilter(const string& cmd);

    ~RclConfig() {

    ~RclConfig() {

    freeAll();

    freeAll();

    }

    }

    ParamStale   m_skpnstate;

    ParamStale   m_skpnstate;

    vector<string> m_skpnlist;

    vector<string> m_skpnlist;

    // Parameters auto-fetched on setkeydir

    // Parameters auto-fetched on setkeydir

    string defcharset;

    // Limiting set of mime types to be processed. Normally empty.

    // Limiting set of mime types to be processed. Normally empty.

    ParamStale    m_rmtstate;

    ParamStale    m_rmtstate;

    set<string>   m_restrictMTypes; 

    set<string>   m_restrictMTypes; 

    /** Create initial user configuration */

    /** Create initial user configuration */