OsConfigDb.h

Go to the documentation of this file.

//
// Copyright (C) 2006-2012 SIPez LLC.  All rights reserved.
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _OsConfigDb_h_
#define _OsConfigDb_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "os/OsDefs.h"
#include "os/OsRWMutex.h"
#include "utl/UtlContainable.h"
#include "utl/UtlSortedList.h"
#include "utl/UtlString.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class OsConfigEncryption;
class UtlSList;

class DbEntry : public UtlContainable
{
 public:

    DbEntry(const UtlString &key);

    DbEntry(const UtlString &key, const UtlString &value);

    ~DbEntry();

    virtual UtlContainableType getContainableType() const;

    static const UtlContainableType TYPE;

    virtual unsigned int hash() const;

    int compareTo(const UtlContainable *b) const;

    UtlString key;

    UtlString value;
};


class OsConfigDb
{
   friend class OsConfigDbTest;

public:

    OsConfigDb();

    virtual ~OsConfigDb();

    virtual OsStatus loadFromFile(FILE* fp);

    virtual OsStatus loadFromFile(const char *filename);

    virtual OsStatus loadFromBuffer(const char *buf);

    virtual OsStatus storeToFile(const char *filename);

    virtual OsStatus updateFile(const char* filename) const;

    OsStatus remove(const UtlString& rKey);

    OsStatus removeByPrefix(const UtlString& rPrefix) ;
 
    void set(const UtlString& rKey, const UtlString& rNewValue);

    void set(const UtlString& rKey, const int iNewValue) ;

    virtual OsStatus get(const UtlString& rKey, UtlString& rValue) const;

    virtual OsStatus get(const UtlString& rKey, int& rValue) const;

    virtual const char *getIdentityLabel() const;

    virtual void setIdentityLabel(const char *idLabel);

    OsConfigEncryption *getEncryption() const;

    static void setStaticEncryption(OsConfigEncryption *encryption);

    static OsConfigEncryption *getStaticEncryption();

    void setCapitalizeName(UtlBoolean capitalize);

    void storeToBuffer(char *buff) const;

    int calculateBufferSize() const;

    virtual UtlBoolean isEmpty(void) const;

    virtual int numEntries(void) const;

    virtual OsStatus getSubHash(const UtlString& rHashSubKey, 
                                OsConfigDb& rSubDb) const;

    virtual OsStatus getNext(const UtlString& rKey,
                            UtlString& rNextKey, UtlString& rNextValue) const;


    virtual void addList(const UtlString& rPrefix,
                         UtlSList& rList) ;

    virtual int loadList(const UtlString& rPrefix,
                         UtlSList& rList) const;


    int getPort(const char* szKey) const;

    void clear() ;

    static void removeNewlineReturns(UtlString& stringData);

 protected:

    mutable OsRWMutex mRWMutex;

    UtlSortedList mDb;

    UtlString mIdentityLabel;

    UtlBoolean mCapitalizeName;

    OsStatus loadFromEncryptedFile(const char *filename);

    OsStatus loadFromUnencryptedFile(FILE* fp);

    OsStatus loadFromEncryptedBuffer(char *buf, int bufLen);

    OsStatus loadFromUnencryptedBuffer(const char *buf);

    OsStatus storeToEncryptedFile(const char *filename);

    OsStatus storeBufferToFile(const char *filename, const char *buff, unsigned long buffLen);

    void dump();

        virtual OsStatus storeToFile(FILE* fp);

    static UtlBoolean parseLine(const char* line, UtlBoolean capitalizeName, const char* fileLabelForError,
                                UtlString& name, UtlString& value);

    void insertEntry(const UtlString& rKey, const UtlString& rNewValue);

    OsConfigDb(const OsConfigDb& rOsConfigDb);

    OsConfigDb& operator=(const OsConfigDb& rhs);

    static void removeChars(UtlString *s, char c);
};


/* ============================ INLINE METHODS ============================ */

#endif  // _OsConfigDb_h_