GXmlDataController.h

/***************************************************************************
 *   Copyright (C) 2004 - 2006 by Raphael Langerhorst                      *
 *   raphael-langerhorst@gmx.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 GXMLDATACONTROLLER_H
#define GXMLDATACONTROLLER_H

#include "GDataController.h"

#include <qdom.h>
#include <QMap>
#include <QStringList>
#include <GElementID.h>
#include <GElement.h>

namespace GWE
{

class GCoreXmlSerializer;
class GStorage;
class GXmlNetwork;


class GXmlDataController : public GDataController
{
  Q_OBJECT
  
  protected:
  
    GCoreXmlSerializer* Serializer;
    
    GStorage* Storage;
    
    GXmlNetwork* Network;
    
//     QStringList ChildServers;
    
//     QMap<GCS::GElementID,QString> ElementServerMapping;
    
//     QValueList<GCS::GElementID> PrimaryElements;
    
//     QValueList<GCS::GElementID> SecondaryElements;
    
    QMap<GCS::GElementID,GCS::GElement*> OpenElements;
    
    QMap<GCS::GElementID,QDateTime> LastSyndicationTime;
    
    QList<GCS::GElementID> PendingSyndication;

  public:
  
    GXmlDataController(GStorage* storage, GXmlNetwork* network, QObject *parent = 0);
    
    virtual ~GXmlDataController();
    
    // GDataController implementation //
    
    virtual const GCS::GElement* read(const GCS::GElementID& ) const;
    
    virtual QList<GCS::GElementID> getChildren(const GCS::GElementID& parent) const;
    
    virtual GCS::GElement* open(const GCS::GElementID& );
    
    virtual GCS::GElement* getOpenElement(const GCS::GElementID& );

    virtual QList<GCS::GElementID> getListOfOpenElements();

    virtual QList<GCS::GElementID> getListOfAllElements();
    
    virtual bool isPrimaryElement(const GCS::GElementID&) const;
    
  public slots:
  
    virtual bool add(GCS::GElement* );

    virtual bool writeOpenElementToStorage(const GCS::GElementID& );

    virtual bool close(const GCS::GElementID& );

    virtual bool postDelete(const GCS::GElementID& );

  public:

    bool isMasterServer();
    
    QString getMasterServer() const;
    
    bool isRegisteredWithMaster() const;

    QString getManagingServerOfElement(const GCS::GElementID&) const;
    
    QStringList getAllKnownElementOwners() const;

    QStringList getAllKnownServers() const;
    
    

  protected slots:

    virtual void shutdown();
    
    virtual void syndicateGenericMessage(QDomElement data, bool to_master = false, QString exclude = QString());
    
    virtual void registerWithMaster();

    virtual void unregisterFromMaster();
    
    virtual void unregisterFromAllKnownServers();

    virtual void checkFreeIDs();

    virtual void requestFreeIDs(unsigned long amount);
    
    virtual void sendFreeIDs(QString server, unsigned long amount);
    
    virtual void postSyndication(const GCS::GElementID& id);
    
    virtual void checkElementsForSyndication();

    virtual void syndicateElementDataToServer(const GCS::GElementID& id,const QString& server);

    virtual void syndicateElementData(const GCS::GElementID& id);

    virtual void syndicateAllElementDataToServer(const QString& server);
    
    virtual void updateServerPresence(QString server, bool available);


    //BEGIN ELEMENT OBSERVATION
    
    virtual void prepareOpenedElement(GCS::GElement* element);
    
    virtual void processChildCreation(GCS::GElement* element);
    
    virtual void processInfluencing(const GCS::GElementInfluence& influence);
    
    virtual void processActionPerformed(const QString& action, QStringList params, const QString& agent);
    
    //BEGIN ELEMENT OBSERVATION
    
    virtual void processUnregister(const QString& server);

  public slots:

    virtual void receiveData(QDomElement data, const QString& sender);

    virtual void addSecondary(GCS::GElement* element, QString managing_server);
    
    virtual void moveElement(const GCS::GElementID& id, QString new_owner);

    virtual bool checkConsistency(bool& ok);
    
    //BEGIN SLOTS / SIGNALS FOR USER INTERACTION
    
  public slots:
    
    void sendUserMessage(QString message, QString destination);
    
  signals:
    
    void userMessageReceived(QString message, QString sender, bool internal);
    
    void serverPresenceChanged(QString server, bool available, bool internal);

    //END SLOTS / SIGNALS FOR USER INTERACTION
};

}

#endif //GXMLDATACONTROLLER_H

---