GStorage.h

/***************************************************************************
 *   Copyright (C) 2005 - 2006 by the G System Team                        *
 *   http://www.g-system.at                                                *
 *                                                                         *
 *   Permission is hereby granted, free of charge, to any person obtaining *
 *   a copy of this software and associated documentation files (the       *
 *   "Software"), to deal in the Software without restriction, including   *
 *   without limitation the rights to use, copy, modify, merge, publish,   *
 *   distribute, sublicense, and/or sell copies of the Software, and to    *
 *   permit persons to whom the Software is furnished to do so, subject to *
 *   the following conditions:                                             *
 *                                                                         *
 *   The above copyright notice and this permission notice shall be        *
 *   included in all copies or substantial portions of the Software.       *
 *                                                                         *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       *
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    *
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR     *
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR *
 *   OTHER DEALINGS IN THE SOFTWARE.                                       *
 ***************************************************************************/

#ifndef GWEGSTORAGE_H
#define GWEGSTORAGE_H

#include <QObject>
#include <QList>
#include <QSqlDatabase>
#include <QMutex>

#include <exception>

class QDomDocument;
class QStringList;

namespace GCS
{
  class GElement;
  class GElementID;
  class GAgent;
  class GEnergy;
  class GForm;
  class GVector3;
  class GElementData;
  class GWorldData;
}

namespace GWE
{

class GStorageException : public std::exception
{
  private:
    
    QString Text;
  public:
    
    GStorageException(QString error) : Text(error) {}
    
    virtual ~GStorageException() throw() {}
    
    QString toString() {return Text;}
};

class GStorage : public QObject, public QMutex
{
  Q_OBJECT
    
  protected:
    
    QSqlDatabase Database;
    
    QString DbDriver;
    
    QString DbName;
    
    QString DbHost;
    
    int DbPort;
    
    QString DbUser;
    
    QString DbPassword;
    
  public:
    
    GStorage(QObject *parent = 0);
    
    virtual ~GStorage();
    
    void setDatabaseDriver(QString driver);
    
    void setDatabaseName(QString connection);
    
    void setDatabaseHost(QString host);
    
    void setDatabasePort(int port);
    
    void setDatabaseUser(QString user);
    
    void setDatabasePassword(QString password);
    
    void setDatabase(QString driver, QString name, QString user, QString password, QString host="", int port=0);
    
    bool connectDatabase();
    
    bool isDatabaseConnected();
    
    bool initializeDatabase();
    
    bool disconnectDatabase();
    
    QString getLastDatabaseError();
    
    //BEGIN Data management
    
  protected:
    
    GCS::GVector3 getVector3(unsigned long id) throw(GStorageException);
    
  public:
    
    //BEGIN GWE stuff
    
    // get
    
    QStringList getAllElementOwners() throw(GStorageException);
    
    QStringList getAllServers() throw(GStorageException);
    
    bool getServerExists(const QString& server) throw(GStorageException);
    
    QStringList getServersForElementChildren(const GCS::GElementID& parent) throw(GStorageException);

    QList<GCS::GElementID> getElementsForServer(const QString& server) throw(GStorageException);
    
    QString getManagingServerForElement(const GCS::GElementID& id) throw(GStorageException);
    
    QString getServerPresence(const QString& server) throw(GStorageException);
    
    QStringList getServersSubscribedToElementUpdates(const GCS::GElementID& id) throw(GStorageException);
    
    QStringList getServersSubscribedToDataUpdates(const GCS::GElementID& id) throw(GStorageException);
    
    QStringList getServersSubscribedToEnergyUpdates(const GCS::GElementID& id) throw(GStorageException);
    
    QStringList getServersSubscribedToFormUpdates(const GCS::GElementID& id) throw(GStorageException);
    
    // modifications:
    
    void addServer(const QString& server, const QString& presence) throw(GStorageException);
    
    void updateServerPresence(const QString& server, const QString& presence) throw(GStorageException);
    
    void removeServer(const QString& server) throw(GStorageException);
    
    void setSubscription(const GCS::GElementID& element, const QString& server, const QString& type) throw(GStorageException);
    
    void clearSubscription(const GCS::GElementID& element, const QString& server, const QString& type) throw(GStorageException);
    
    void updateManagingServer(const GCS::GElementID& element, const QString& new_server) throw(GStorageException);
    
    
    //END GWE stuff
    
    //BEGIN Element stuff
    
    // NOTE the agent list has only one column, it might be extended in the future
    
    // get
    
    bool getElementExists(const GCS::GElementID& id) throw(GStorageException);
    
    QList<GCS::GElementID> getAllElementIDs() throw(GStorageException);
    
    QList<GCS::GElementID> getAllElementIDsByServer(const QString& managing_server) throw(GStorageException);
    
    GCS::GElement* getElement(const GCS::GElementID& id, const GCS::GWorldData* data) throw(GStorageException);
    
    QList<GCS::GElement*> getElements(QList<GCS::GElementID> id_list, const GCS::GWorldData* worlddata) throw(GStorageException);
    
    GCS::GElementData* getElementData(const GCS::GElementID& id) throw(GStorageException);
    
    GCS::GEnergy* getElementEnergy(const GCS::GElementID& id) throw(GStorageException);
    
    GCS::GForm* getElementForm(const GCS::GElementID& id) throw(GStorageException);
    
    QList<GCS::GElementID> getChildren(const GCS::GElementID& id) throw(GStorageException);
    
    GCS::GElementID getParent(const GCS::GElementID& id) throw(GStorageException);
    
    QStringList getElementAgents(const GCS::GElementID& id) throw(GStorageException);
    
    GCS::GElementID getConnection(const GCS::GElementID& id) throw(GStorageException);
    
    
    QStringList getAllAgents() throw(GStorageException);
    
    QString getAgent(const QString& agent) throw(GStorageException);
    
    // modifications
    
    void addElement(const GCS::GElement* element, const QString& managing_server) throw(GStorageException);
    
    void updateElement(const GCS::GElement* element) throw(GStorageException);
    
    void removeElement(const GCS::GElementID& id) throw(GStorageException);
    
    void removeElements(QList<GCS::GElementID> id_list) throw(GStorageException);
    
    void reparentElement(const GCS::GElementID& element, const GCS::GElementID& old_parent, const GCS::GElementID& new_parent) throw(GStorageException);
    
    void changeConnection(const GCS::GElementID& element, const GCS::GElementID& connection) throw(GStorageException);
    
    void addElementAgent(const GCS::GElementID& element, const QString& agent) throw(GStorageException);
    
    void removeElementAgent(const GCS::GElementID& element, const QString& agent) throw(GStorageException);
    
    QStringList removeAllElementAgents(const GCS::GElementID& element) throw(GStorageException);
    
    QList<GCS::GElementID> removeAgentFromAllElements(const QString& agent) throw(GStorageException);
    
    void updateElementData(const GCS::GElementID& element, const GCS::GElementData* data) throw(GStorageException);
    
    void updateEnergy(const GCS::GElementID& element, const GCS::GEnergy* energy) throw(GStorageException);
    
    void updateForm(const GCS::GElementID& element, const GCS::GForm* form) throw(GStorageException);
    
    
    void removeAllAgents() throw(GStorageException);
    
    void addAgent(const QString& agent) throw(GStorageException);
    
    void removeAgent(const QString& agent) throw(GStorageException);
    
    //END Element stuff
    
    //END Data management
};

}

#endif

---