controller.h

Go to the documentation of this file.

/*     -*-C++-*- -*-coding: utf-8-unix;-*-
  Classified Ads is Copyright (c) Antti Järvinen 2013-2017.

  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 CONTROLLER_H
#define CONTROLLER_H
#include <QtGui>
#include <QBoxLayout>
#include <QUrl>
#include "mcontroller.h"
#include "net/protocol.h" // for ProtocolItemType
#include "datamodel/netrequestexecutor.h"

class FrontWidget ;
class PublishingEngine ;
class RetrievalEngine ;
class DbRecordRetrievalEngine ; 
class QMainWindow ;
class QMenu ;
class VoiceCallEngine ;
class QSharedMemory ;
#ifdef WIN32
class QLocalServer ;
#endif
class QFileDialog ; 

class Controller : public MController {
    Q_OBJECT

public:

    Controller(QApplication& app) ;
    ~Controller() ;

    bool init() ;

    virtual void startRetrievingContent(NetworkRequestExecutor::NetworkRequestQueueItem aReq,
                                        bool aIsBackgroundDl,
                                        ProtocolItemType aTypeOfExpectedObject) ;
    virtual void startRetrievingContent( CaDbRecord::SearchTerms aSearchTerms ) ;
    virtual void userInterfaceAction ( CAUserInterfaceRequest aRequest,
                                       const Hash& aHashConcerned = KNullHash,
                                       const Hash& aFetchFromNode = KNullHash,
                                       const QString* aAdditionalInformation = NULL)  ;
    virtual void hideUI() ;
    virtual void showUI() ;
    virtual void setProfileInUse(const Hash& aProfileHash) ;
    virtual const Hash& profileInUse()  ;
    virtual void setContentKeyPasswd(QString aPasswd)  ;
    virtual QString contentKeyPasswd()  const ;

public: // methods
    virtual Node& getNode() const ;
    virtual NetworkListener *networkListener() const ;
    virtual Model &model() const  ;
    void addObjectToOpen(QUrl aClassifiedAdsObject) ;
    void checkForSharedMemoryContents() ;
signals:
    void userProfileSelected(const Hash& aProfile) ;
    void waitDialogToBeDismissed() ;
    void startGettingFileName(QString aSuggestedFileName,bool aIsSaveFile) ; 
public slots:
    virtual void exitApp() ; 
    virtual void displayAboutBox() ; 
    virtual void displayFront() ; 
    virtual void changeProfilePasswd() ; 
    virtual void createProfile() ; 
    virtual void deleteProfile() ; 
    virtual void selectProfile() ; 
    virtual void displaySettings() ; 
    virtual void displayStatus() ; 
    virtual void displaySearch() ; 
    /* tcl-related UI slots */
    virtual void displayTclProgs() ; 
    virtual void displayTclConsole() ; 
    virtual void handleError(MController::CAErrorSituation aError,
                             const QString& aExplanation) ;
    void notifyOfContentReceived(const Hash& aHashOfContent,
                                 const ProtocolItemType aTypeOfReceivedContent );
    void notifyOfContentReceived(const Hash& aHashOfContent,
                                 const Hash& aHashOfClassification,
                                 const ProtocolItemType aTypeOfReceivedContent );
    void notifyOfContentNotReceived(const Hash& aHashOfContent,
                                    const ProtocolItemType aTypeOfNotReceivdContent );

    virtual void storePrivateDataOfSelectedProfile(bool aPublishTrustListToo = false) ;
    virtual void reStorePrivateDataOfSelectedProfile() ;

    virtual bool isContactInContactList(const Hash& aFingerPrint) const ;
    virtual QString displayableNameForProfile(const Hash& aProfileFingerPrint) const ;
    virtual void offerDisplayNameForProfile(const Hash& aProfileFingerPrint,
                                            const QString& aDisplayName,
                                            const bool iUpdatePersistenStorage=false) ;
    virtual void displayFileInfoOnUi(const BinaryFile& aFileMetadata) ;
    virtual VoiceCallEngine* voiceCallEngine()  ;
    virtual MVoiceCallEngine* voiceCallEngineInterface()  ;
    virtual TclWrapper &tclWrapper() ;

    virtual QWidget *frontWidget() ; 
    void sendProfileUpdateQuery(const Hash& aProfileFingerPrint,
                                const Hash& aProfileNodeFingerPrint = KNullHash ) ;
#ifdef WIN32
    void newInstanceConnected() ; 
#endif

    virtual QString getFileName(bool& aSuccess,
                                bool aIsSaveFile = false , 
                                QString aSuggestedFileName = QString()) ;
private:
    void createMenus(); 
    int createPidFile(); 
    void deletePidFile(); 
    bool createSharedMemSegment(QString& aSegmentName);
private slots:
    void checkForObjectToOpen(const Hash& aIgnored) ; 
    void getFileNameSlot(QString aSuggestedFileName,bool aIsSaveFile) ;
private:
    QMainWindow* iWin ;
    FrontWidget* iCurrentWidget ; 
    QApplication& iApp ;
    QBoxLayout* iLayout ;
    QMenu *iFileMenu;
    QAction *iExitAct;
    QAction *iAboutAct;
    QAction *iPwdChangeAct;
    QAction *iProfileDeleteAct;
    QAction *iProfileCreateAct;
    QAction *iProfileSelectAct;
    QAction *iDisplaySettingsAct;
    QAction *iDisplayStatusAct;
    QAction *iDisplaySearchAct;
    QMenu *iTclMenu;
    QAction *iTclLibraryAct; 
    QAction *iTclConsoleAct; 
    Node *iNode ; 
    Model *iModel ; 
    NetworkListener *iListener ; 
    NetworkConnectorEngine *iNetEngine ; 
    QString iContentKeyPasswd ; 
    Hash iProfileHash ; 
    PublishingEngine *iPubEngine ; 
    RetrievalEngine* iRetrievalEngine ;
    DbRecordRetrievalEngine* iDbRetrievalEngine ;
    ProtocolItemType iTypeOfObjectBeingWaitedFor ;
    Hash iHashOfObjectBeingWaitedFor ;
    Hash iHashOfProfileCommentBeingWaitedFor ;
    Hash iNodeForCommentBeingWaitedFor ;
    QMap<Hash,QString> iHashDisplaynameMapping ;
    VoiceCallEngine* iVoiceCallEngine ;
    bool iInsideDestructor ;
    QUrl iObjectToOpen ;
    QSharedMemory* iSharedMemory ;
#ifdef WIN32
    QLocalServer* iLocalServer ; 
#endif
    TclWrapper* iTclWrapper ; 
    QString iGetFileNameResult ; 
    QFileDialog* iGetFileNameDialog ; 
    QSemaphore iGetFileNameSemaphore ; 
    bool iGetFileNameSuccess ; 
} ;
#endif