searchmodel.h

Go to the documentation of this file.

/*     -*-C++-*- -*-coding: utf-8-unix;-*-
    Classified Ads is Copyright (c) Antti Järvinen 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 FULLTEXTSEARCHMODEL_H
#define FULLTEXTSEARCHMODEL_H

#include <QAbstractListModel>
#include "../util/hash.h"
#include "../net/protocol.h"
#include "../mcontroller.h"
#include <QVariantMap> // is actually typedef

class MModelProtocolInterface ; 
class CA ; 
class Profile ;
class ProfileComment ;
class QTextDocument ; // for parsing html


class SearchModel: public QAbstractListModel {
  Q_OBJECT
public: 
  typedef struct SearchResultItemStruct {
    ProtocolItemType iItemType ;
    Hash iItemHash ; 
    Hash iFoundFromNode ; 
    QString iDisplayName ; 
    bool operator==(const struct SearchResultItemStruct& a) const ;
  } SearchResultItem ;

  SearchModel(MModelProtocolInterface& aModel,
          MController& aController) ;
  ~SearchModel() ; 
  void setSearchString(const QString& aSearch,
               bool aSearchAds,
               bool aSearchProfiles,
               bool aSearchComments,
               bool aNetworkSeacrh = false ) ; 
  virtual int rowCount(const QModelIndex & parent = QModelIndex())  const  ; 
  virtual QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const ;
  QList<SearchModel::SearchResultItem> performSearch(const QString& aForString,
                             bool aSearchAds,
                             bool aSearchProfiles,
                             bool aSearchComments) ; 
  
  void appendNetworkSearchResults(const QList<SearchModel::SearchResultItem>& aResults,
                  quint32 aSearchId,
                  const Hash& aFromPeer) ; 

  static QVariant serializeSearchResults(const QList<SearchModel::SearchResultItem>& aResults,
                     quint32 aSearchId ) ;

  static bool deSerializeSearchResults(const QVariantMap& aResultJson, 
                       QList<SearchModel::SearchResultItem>* aResults,
                       quint32* aSearchId ) ;
  bool isFTSSupported () const { return iIsFTSSupported ; } 
  static bool queryIfFTSSupported() ; 
  static void createFTSTables() ; 
  void indexClassifiedAd(const CA& aCa) ;

  void indexProfileComment(const ProfileComment& aProfileComment) ;

  void indexProfile(const Profile& aProfile,
            bool aWasUpdate = false ) ;
  void getSearchCriteria(QString* aSearchStrPtr,
             bool* aSearchAdsPtr,
             bool* aSearchProfilesPtr,
             bool* aSearchCommentsPtr,
             Hash* aSearchIdPtr ) const ; 
signals:
  void error(MController::CAErrorSituation aError,
             const QString& aExplanation) ;
private: // data
  MModelProtocolInterface& iModel ; 
  QString iSearchString ;
  const bool iIsFTSSupported ; 
  QTextDocument *iHtmlParser ; 
  QList<SearchResultItem> iDisplayedResults ;
  MController& iController ; 
  Hash iSearchId ; 
  bool iSearchAds ;
  bool iSearchProfiles ; 
  bool iSearchComments ; 
} ; 
#endif