indexscheduler.h

Go to the documentation of this file.

/* This file is part of the KDE Project
   Copyright (c) 2008-2010 Sebastian Trueg <trueg@kde.org>
   Copyright (c) 2012 Vishesh Handa <me@vhanda.in>

   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_INDEX_SCHEDULER_H_
#define _NEPOMUK_FILEINDEXER_INDEX_SCHEDULER_H_

#include "basicindexingqueue.h" // Required for UpdateDirFlags
#include "removablemediacache.h"
#include <QDateTime>

namespace Nepomuk2 {

    class IndexCleaner;
    class FileIndexingQueue;
    class EventMonitor;

    class IndexScheduler : public QObject
    {
        Q_OBJECT

    public:
        enum State {
            State_Normal = 0,
            State_UserIdle = 1,
            State_OnBattery = 2,
            State_LowDiskSpace = 3,
            State_Suspended = 4,
            State_Cleaning = 5
        };

        IndexScheduler( QObject* parent=0 );
        ~IndexScheduler();

        bool isSuspended() const;
        bool isIndexing() const;
        bool isCleaning() const;

        QString userStatusString() const;

        State currentStatus() const;

        QUrl currentUrl() const;

        UpdateDirFlags currentFlags() const;

    public Q_SLOTS:
        void suspend();
        void resume();

        void setSuspended( bool );

        void updateDir( const QString& path, UpdateDirFlags flags = NoUpdateFlags );

        void updateAll( bool forceUpdate = false );

        void analyzeFile( const QString& path );

    Q_SIGNALS:
        // Indexing State
        void indexingStarted();
        void indexingStopped();
        void indexingStateChanged( bool indexing );

        void basicIndexingDone();
        void fileIndexingDone();

        // Emitted on calling suspend/resume
        void indexingSuspended( bool suspended );

        void statusStringChanged();
    private Q_SLOTS:
        // Config
        void slotConfigFiltersChanged();
        void slotIncludeFolderListChanged(const QStringList& added, const QStringList& removed);
        void slotExcludeFolderListChanged(const QStringList& added, const QStringList& removed);

        void slotCleaningDone();

        void slotBeginIndexingFile(const QUrl& url);
        void slotEndIndexingFile(const QUrl& url);
        void slotEndBasicIndexingFile();

        void slotStartedIndexing();
        void slotFinishedIndexing();

        // Event Monitor integration
        void slotScheduleIndexing();

        void slotTeardownRequested(const Nepomuk2::RemovableMediaCache::Entry* entry);
        void emitStatusStringChanged();
    private:
        void queueAllFoldersForUpdate( bool forceUpdate = false );

        // emits indexingStarted or indexingStopped based on parameter. Makes sure
        // no signal is emitted twice
        void setIndexingStarted( bool started );

        void restartCleaner();

        bool m_indexing;

        IndexCleaner* m_cleaner;

        // Queues
        BasicIndexingQueue* m_basicIQ;
        FileIndexingQueue* m_fileIQ;

        EventMonitor* m_eventMonitor;

        State m_state;

        QDateTime m_lastBasicIndexingFile;
        int m_basicIndexingFileCount;

        QString m_oldStatus;
    };
}


#endif