fileindexerconfig.h

Go to the documentation of this file.

/* This file is part of the KDE Project
   Copyright (c) 2008-2009 Sebastian Trueg <trueg@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef _NEPOMUK_FILEINDEXER_SERVICE_CONFIG_H_
#define _NEPOMUK_FILEINDEXER_SERVICE_CONFIG_H_

#include <QtCore/QObject>
#include <QtCore/QList>
#include <QtCore/QSet>
#include <QtCore/QRegExp>
#include <QtCore/QReadWriteLock>

#include <kconfig.h>
#include <kio/global.h>

#include "regexpcache.h"

namespace Nepomuk2 {
    class FileIndexerConfig : public QObject
    {
        Q_OBJECT

    public:
        FileIndexerConfig(QObject* parent = 0);
        ~FileIndexerConfig();

        static FileIndexerConfig* self();

        QList<QPair<QString, bool> > folders() const;

        QStringList includeFolders() const;

        QStringList excludeFolders() const;

        QStringList excludeFilters() const;

        bool indexHiddenFilesAndFolders() const;

        KIO::filesize_t minDiskSpace() const;

        bool isInitialRun() const;

        bool initialUpdateDisabled() const;

        bool suspendOnPowerSaveDisabled() const;

        bool shouldBeIndexed( const QString& path ) const;

        bool shouldFolderBeIndexed( const QString& path ) const;

        bool shouldFileBeIndexed( const QString& fileName ) const;

        bool shouldMimeTypeBeIndexed( const QString& mimeType ) const;

        bool isDebugModeEnabled() const;


        bool folderInFolderList( const QString& path );

    Q_SIGNALS:
        void configChanged();

        void includeFolderListChanged( const QStringList& added, const QStringList& removed );
        void excludeFolderListChanged( const QStringList& added, const QStringList& removed );
        void fileExcludeFiltersChanged();
        void mimeTypeFiltersChanged();

    public Q_SLOTS:
        bool forceConfigUpdate();

        void setInitialRun(bool isInitialRun);

    private Q_SLOTS:
        void slotConfigDirty();

    private:
        bool folderInFolderList( const QString& path, QString& folder ) const;

        // These functions return true if the the new cache is different from the old one
        // They also emit signals to indicate how they are different
        bool buildFolderCache();
        bool buildExcludeFilterRegExpCache();
        bool buildMimeTypeCache();

        mutable KConfig m_config;

        QList<QPair<QString, bool> > m_folderCache;

        RegExpCache m_excludeFilterRegExpCache;
        QSet<QString> m_prevFileFilters;

        QSet<QString> m_excludeMimetypes;

        bool m_indexHidden;

        mutable QReadWriteLock m_folderCacheMutex;
        mutable QReadWriteLock m_mimetypeMutex;

        static FileIndexerConfig* s_self;

        //
        // Use to save the previous data in order to inform clients of the changes
        //
        struct Entry {
            QSet<QString> includes;
            QSet<QString> excludes;
        };
        QHash<QString, Entry> m_entries;

        void fillIncludeFolderChanges( const Entry& entry, const QSet<QString>& include,
                                       QStringList* includeAdded, QStringList* includeRemoved );
        void fillExcludeFolderChanges( const Entry& entry, const QSet<QString>& exclude,
                                       QStringList* excludeAdded, QStringList* excludeRemoved );
    };
}

#endif