src/search/filenamesearchprotocol.h

   1 /***************************************************************************
   2  *   Copyright (C) 2010 by Peter Penz <peter.penz19@gmail.com>             *
   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 of the License, or     *
   7  *   (at your option) 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                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef FILENAMESEARCHPROTOCOL_H
  21 #define FILENAMESEARCHPROTOCOL_H
  22
  23 #include <kio/slavebase.h>
  24
  25 class KUrl;
  26
  27 /**
  28  * @brief Lists files where the filename matches do a given query.
  29  *
  30  * The query is defined as part of the "search" query item of the URL.
  31  * Example: The URL filenamesearch:///home/peter?search=hello lists
  32  * recursively all files inside the directory home/peter, that contain
  33  * the "hello" as part of their filename.
  34  */
  35 class FileNameSearchProtocol : public KIO::SlaveBase {
  36 public:
  37     FileNameSearchProtocol(const QByteArray& pool, const QByteArray& app);
  38     virtual ~FileNameSearchProtocol();
  39
  40     virtual void listDir(const KUrl& url);
  41
  42 private:
  43     void searchDirectory(const KUrl& directory);
  44
  45     /**
  46      * @return True, if the pattern m_searchPattern is part of
  47      *         the file \a fileName.
  48      */
  49     bool containsPattern(const KUrl& fileName) const;
  50
  51     bool m_checkContent;
  52     QString m_searchPattern;
  53 };
  54
  55 #endif