runtime/nepomuk/kioslaves/search/kio_nepomuksearch.h

   1 /*
   2    Copyright (C) 2008 by Sebastian Trueg <trueg at kde.org>
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  */
  18
  19 #ifndef _NEPOMUK_KIO_NEPOMUK_SEARCH_H_
  20 #define _NEPOMUK_KIO_NEPOMUK_SEARCH_H_
  21
  22 #include <kio/forwardingslavebase.h>
  23
  24 #include "term.h"
  25 #include "searchfolder.h"
  26
  27 #include <QtCore/QQueue>
  28
  29 namespace Nepomuk {
  30     namespace Search {
  31         class Query;
  32     }
  33
  34     class SearchProtocol : public KIO::ForwardingSlaveBase
  35     {
  36         Q_OBJECT
  37
  38     public:
  39         SearchProtocol( const QByteArray& poolSocket, const QByteArray& appSocket );
  40         virtual ~SearchProtocol();
  41
  42         /**
  43          *
  44          */
  45         void listDir( const KUrl& url );
  46
  47         /**
  48          * Will be forwarded for files.
  49          */
  50         void get( const KUrl& url );
  51
  52         /**
  53          * Not supported.
  54          */
  55         void put( const KUrl& url, int permissions, KIO::JobFlags flags );
  56
  57         /**
  58          * Files will be forwarded.
  59          * Folders will be created as virtual folders.
  60          */
  61         void mimetype( const KUrl& url );
  62
  63         /**
  64          * Files will be forwarded.
  65          * Folders will be created as virtual folders.
  66          */
  67         void stat( const KUrl& url );
  68
  69     protected:
  70         /**
  71          * reimplemented from ForwardingSlaveBase
  72          */
  73         bool rewriteUrl( const KUrl& url, KUrl& newURL );
  74
  75     private:
  76         void listRoot();
  77         void listQuery( const QString& query );
  78         void listActions();
  79         void listDefaultSearches();
  80         void listDefaultSearch( const QString& path );
  81         void addDefaultSearch( const QString& name, const Search::Query& );
  82
  83         SearchFolder* extractSearchFolder( const KUrl& url );
  84
  85         /**
  86          * Get (possibly cached) query results
  87          */
  88         SearchFolder* getQueryResults( const QString& query );
  89         SearchFolder* getDefaultQueryFolder( const QString& name );
  90
  91         // the default search folders
  92         QHash<QString, Nepomuk::Search::Query> m_defaultSearches;
  93
  94         // cache of all on-the-fly search folders
  95         QHash<QString, SearchFolder*>  m_searchCache;
  96
  97         // queue to remember the order of the search cache
  98         // when enforcing the cache max
  99         QQueue<QString> m_searchCacheNameQueue;
 100
 101         // cache for the default searches, needs to differ from
 102         // on-the-fly cache because of the name
 103         QHash<QString, SearchFolder*>  m_defaultSearchCache;
 104     };
 105 }
 106
 107 #endif