model.h

Go to the documentation of this file.

/*    -*-C++-*- -*-coding: utf-8-unix;-*-
  Classified Ads is Copyright (c) Antti Jarvinen 2013-2016.

  This file is part of Classified Ads.

  Classified Ads is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  Classified Ads is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with Classified Ads; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/

#ifndef CLASSIFIED_DATAMODEL_H
#define CLASSIFIED_DATAMODEL_H
#include <QSqlDatabase>
#include <QObject>
#include "../mcontroller.h" // because enum from there is needed
#include "../net/connection.h"
#include <QHostAddress>
#include <QPair>
#include "netrequestexecutor.h"
#include "nodemodel.h"
#include "mmodelprotocolinterface.h"
#include "mnodemodelprotocolinterface.h"

class QSqlDatabase ;
class QMutex ;
class Hash ;
class QSslCertificate ;
class QSslKey ;
class SearchModel ;
class TrustTreeModel ;
class TclModel ;

class Model : public MModelProtocolInterface {
    Q_OBJECT

public:
    // public enums
    enum RingtoneSetting {
        BowRingTone = 0,
        ElectricalRingTone = 1,
        AcousticRingTone = 2,
        BeepRingTone = 3 ,
        NoRingTone = 4
    } ;
    enum CallAcceptanceSetting {
        AcceptAllCalls = 0,
        AcceptCallsFromTrusted = 1,
        AcceptNoCalls = 2
    } ;
    // methods
    Model(MController *aMController) ;
    ~Model() ;
    ContentEncryptionModel& contentEncryptionModel() const ; 
    virtual ProfileModel& profileModel() const ; 
    virtual BinaryFileModel& binaryFileModel() const ; 
    virtual ClassifiedAdsModel& classifiedAdsModel() const ; 
    virtual PrivMessageModel& privateMessageModel() const ; 
    virtual ProfileCommentModel& profileCommentModel() const ; 
    virtual SearchModel* searchModel() const ; 
    virtual CaDbRecordModel* caDbRecordModel() const ; 
    virtual TrustTreeModel* trustTreeModel() const ; 
    virtual TclModel& tclModel() const ; 
    void addOpenNetworkConnection(Connection *aConnection) ;
    void removeOpenNetworkConnection(Connection *aDeletedConnection) ;

    void addItemToSend(const Hash& aDestinationNode,
                       QByteArray* aBytesToSend) ;

    const QList <Connection *>& getConnections() const ;
    QList <NetworkRequestExecutor::NetworkRequestQueueItem>& getNetRequests() const ;
    virtual void addNetworkRequest(NetworkRequestExecutor::NetworkRequestQueueItem&
                                   aRequest) const ;
    virtual bool lock() ;
    virtual void unlock() ;
    virtual MNodeModelProtocolInterface& nodeModel() const ;
    NetworkRequestExecutor* getNetReqExecutor() ;
    void closeAllConnections(bool aDeleteAlso) ;
    void connectionStateChanged(Connection::ConnectionState aState,
                                Connection *aConnection) ;
    PublishItem nextItemToPublish(bool* aFound) ;
    void addItemToBePublished(ProtocolItemType aType,
                              const Hash& aHash,
                              const QList<quint32>& aBangPath,
                              const Hash& aSecondaryAddr = KNullHash ) ;
    PublishItem addNodeToPublishedItem(const Hash& aContentHash,const Hash& aNodeHash) ;
    Model::RingtoneSetting getRingtoneSetting() ;
    void setRingtoneSetting(Model::RingtoneSetting aRingTone) ;

    Model::CallAcceptanceSetting getCallAcceptanceSetting() ;
    void setCallAcceptanceSetting(Model::CallAcceptanceSetting aAcceptance) ;


public slots:
    void notifyOfContentReceived(const Hash& aHashOfContent,
                                 const ProtocolItemType aTypeOfReceivdContent) ;
    void notifyOfContentReceived(const Hash& aHashOfContent,
                                 const Hash& aHashOfClassification,
                                 const ProtocolItemType aTypeOfReceivdContent) ;
protected:
    void timerEvent(QTimerEvent *event);
private:
    bool openDB();
    QSqlError lastError();
    // 1st-time initialization methods ahead
    bool createTables() ;
    // additions to first version of tables
    bool createTablesV2() ;
    // additions to 2nd version of tables
    bool createTablesV3() ;
    // additions to 3rd version of tables
    bool createTablesV4() ;
    void initPseudoRandom() ; 
signals:
    void error(MController::CAErrorSituation aError,
               const QString& aExplanation) ;
private:
    MController *iController  ;
    QSqlDatabase iDb;
    QMutex* iMutex ; 
    QList <Connection *> *iConnections ; 
    NodeModel* iNodeModel ;
    NetworkRequestExecutor* iNetReqExecutor ;
    QList <NetworkRequestExecutor::NetworkRequestQueueItem>* iNetReqQueue ;
    ContentEncryptionModel* iContentEncryptionModel ;
    ProfileModel* iProfileModel ; 
    BinaryFileModel* iBinaryFileModel ; 
    ClassifiedAdsModel* iCaModel ; 
    int iTimerId ; 
    PrivMessageModel* iPrivMsgModel ; 
    ProfileCommentModel* iProfileCommentModel ; 
    SearchModel* iSearchModel ; 
    CaDbRecordModel* iCaDbRecordModel ;
    TrustTreeModel *iTrustTreeModel ; 
    time_t iTimeOfLastNetworkAddrCheck ; 
    TclModel* iTclModel ; 
} ;
#endif