camodel.h

Go to the documentation of this file.

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

    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 General Public License as published by
    the Free Software Foundation, either version 3 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Classified Ads.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef CLASSIFIED_CLASSIFIEDADMODEL_H
#define CLASSIFIED_CLASSIFIEDADMODEL_H
#include <QSqlDatabase>
#include "../mcontroller.h" // because enum from there is needed
#include "../net/protocol.h" // for SendQueueItem 
#include "datamodelbase.h"

class Hash ;
class MModelProtocolInterface ; 
class Profile ; 
class CA ; 

class ClassifiedAdsModel : public ModelBase {
  Q_OBJECT

public:
  enum PurposeOfAd {
    ToBeBought=0, 
    ToBeSold=1, 
    ToBeGivenAway=2, 
    IsWanted=3, 
    ToBeRented=4, 
    ToBeAnnounced=5  
  } ;
  enum ConcernOfAd {
    ConcerningCars=0, 
    ConcerningBoats=1, 
    ConcerningBikes=2, 
    ConcerningOtherVehicles=3, 
    ConcerningVehicleParts=4, 
    ConcerningHabitation=5, 
    ConcerningHouseholdAppliances=6, 
    ConcerningFurniture=7, 
    ConcerningClothing=8, 
    ConcerningTools=9, 
    ConcerningSports=10, 
    ConcerningMusic=11, 
    ConcerningBooks=12, 
    ConcerningMovies=13, 
    ConcerningAnimals=14, 
    ConcerningElectronics=15, 
    ConcerningJobs=16, 
    ConcerningTransportation=17, 
    ConcerningServices=18, 
    ConcerningHealthcare=19, 
    ConcerningFoodstuff=20, 
    ConcerningSoftware=21, 
    ConcerningEvents=22, 
    ConcerningEducation=23, 
    ConcerningFinance=24, 
    ConcerningJewelry=25, 
    ConcerningReligiousRituals=26, 
    ConcerningPhilosophy=27 
  } ;

  class CAObserver {
    virtual void newCaReceived(const CA& aNewCa) = 0 ;
  } ;
  ClassifiedAdsModel(MController *aMController,
          const MModelProtocolInterface &aModel) ;
  ~ClassifiedAdsModel() ;

  const QString& purposeOfAdString(PurposeOfAd aPurpose) const ;
  QString localizedPurposeOfAdString(PurposeOfAd aPurpose) const ;
  const QString& concernOfAdString(ConcernOfAd aConcern) const ;
  QString localizedConcernOfAdString(ConcernOfAd aConcern) const ;

  Hash publishClassifiedAd( const Profile& aPublishingProfile,CA& aAd ) ;

  bool caDataForPublish(const Hash& aFingerPrint,
            QByteArray& aResultingCaData,
            QByteArray& aResultingSignature,
            QByteArray& aPublicKeyOfPublisher,
            quint32* aTimeOfPublish = NULL ) ;

  CA caByHash(const Hash& aFingerPrint) ;

  bool publishedCAReceived(const Hash& aFingerPrint,
               const QByteArray& aContent,
               const QByteArray& aSignature,
               const QList<quint32>& aBangPath,
               const QByteArray& aKeyOfPublisher,
               const unsigned char aFlags,
               const quint32 aTimeStamp,
               const Hash& aFromNode ) ;

  bool sentCAReceived(const Hash& aFingerPrint,
              const QByteArray& aContent,
              const QByteArray& aSignature,
              const QByteArray& aKeyOfPublisher,
              const unsigned char aFlags,
              const quint32 aTimeStamp,
              const Hash& aFromNode ) ;

  void installCAObserver(CAObserver* aObserver) ; 
  void removeCAObserver(CAObserver* aObserver) ; 

  void fillBucket(QList<SendQueueItem>& aSendQueue,
          const Hash& aStartOfBucket,
          const Hash& aEndOfBucket,
          quint32 aLastMutualConnectTime,
          const Hash& aForNode ); 
  void caListingByClassification(const Hash& aClassificationHash,
                 quint32 aStartDate,
                 quint32 aEndDate, 
                 QList<QPair<Hash,quint32> >& aResultingArticles,
                 const Hash& aRequestingNode ) ; 
  bool caListingByClassificationReceived(QList<QPair<Hash,quint32> >& aReceivedArticles,
                     const Hash& aRequestingNode,
                     const Hash& aClassification) ;
  void reIndexAllAdsIntoFTS() ; 
signals:
  void error
(MController::CAErrorSituation aError,
             const QString& aExplanation) ;
  void contentReceived(const Hash& aHashOfContent,
               const Hash& aHashOfClassification,
               const ProtocolItemType aTypeOfReceivdContent) ;
private: // methods
  bool doHandleReceivedCA(const Hash& aFingerPrint,
              const QByteArray& aContent,
              const QByteArray& aSignature,
              const QList<quint32>& aBangPath,
              const QByteArray& aKeyOfPublisher,
              const unsigned char aFlags,
              const quint32 aTimeStamp,
              bool aWasPublish,
              const Hash& aFromNode ) ;
private: // member variables:
  MController *iController  ;
  const MModelProtocolInterface& iModel ;
  QList<CAObserver*>* iNewCaObservers ; 
} ;
#endif