storagejanitor.h

/*
    Copyright (c) 2011 Volker Krause <[email protected]>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    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 STORAGEJANITOR_H
#define STORAGEJANITOR_H

#include "akthread.h"

#include <QDBusConnection>

namespace Akonadi
{
namespace Server
{

class Collection;
class AkonadiServer;

class StorageJanitor : public AkThread
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.freedesktop.Akonadi.Janitor")

public:
    explicit StorageJanitor(AkonadiServer &mAkonadi);
    ~StorageJanitor() override;

public Q_SLOTS:
    Q_SCRIPTABLE Q_NOREPLY void check();
    Q_SCRIPTABLE Q_NOREPLY void vacuum();

Q_SIGNALS:
    Q_SCRIPTABLE void information(const QString &msg);
    Q_SCRIPTABLE void done();

protected:
    void init() override;
    void quit() override;

private:
    void inform(const char *msg);
    void inform(const QString &msg);
    qint64 lostAndFoundCollection();

    void findOrphanedResources();

    void findOrphanedCollections();

    void checkPathToRoot(const Collection &col);

    void findOrphanedItems();

    void findOrphanedParts();

    void findOrphanedPimItemFlags();

    void findOverlappingParts();

    void verifyExternalParts();

    void findDirtyObjects();

    void findRIDDuplicates();

    void checkSizeTreshold();

    void migrateToLevelledCacheHierarchy();

    void findOrphanSearchIndexEntries();

    void ensureSearchCollection();

private:
    qint64 m_lostFoundCollectionId;
    AkonadiServer &m_akonadi;
};

} // namespace Server
} // namespace Akonadi

#endif // STORAGEJANITOR_H