collectionmanager.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-04-09
 * Description : Collection location management
 *
 * Copyright (C) 2007-2009 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_COLLECTION_MANAGER_H
#define DIGIKAM_COLLECTION_MANAGER_H
 
// Qt includes
 
#include <QString>
#include <QStringList>
#include <QUrl>
#include <QObject>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class CollectionLocation;
class AlbumRootChangeset;
 
class DIGIKAM_DATABASE_EXPORT CollectionManager : public QObject
{
    Q_OBJECT
 
public:
 
    enum LocationCheckResult
    {
        LocationInvalidCheck,
 
        LocationAllRight,
 
        LocationHasProblems,
 
        LocationNotAllowed
    };
 
public:
 
    static CollectionManager* instance();
    static void cleanUp();
 
    void setWatchDisabled();
 
    void refresh();
 
private Q_SLOTS:
 
    void deviceAdded(const QString&);
    void deviceRemoved(const QString&);
    void accessibilityChanged(bool, const QString&);
 
private:
 
    // Disabled
    CollectionManager();
    explicit CollectionManager(QObject*) = delete;
    ~CollectionManager() override;
 
    void clearLocations();
 
    Q_PRIVATE_SLOT(d, void slotTriggerUpdateVolumesList())
 
Q_SIGNALS: // internal use only with slotTriggerUpdateVolumesList()
 
    void triggerUpdateVolumesList();
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    CollectionLocation addLocation(const QUrl& fileUrl, const QString& label = QString());
    CollectionLocation addNetworkLocation(const QUrl& fileUrl, const QString& label = QString());
    CollectionLocation refreshLocation(const CollectionLocation& location, int newType,
                                       const QUrl& fileUrl, const QString& label = QString());
 
    LocationCheckResult checkLocation(const QUrl& fileUrl, QList<CollectionLocation>& assumeDeleted,
                                      QString* message = nullptr, QString* suggestedMessageIconName = nullptr);
    LocationCheckResult checkNetworkLocation(const QUrl& fileUrl, QList<CollectionLocation>& assumeDeleted,
                                             QString* message = nullptr, QString* suggestedMessageIconName = nullptr);
 
    void removeLocation(const CollectionLocation& location);
 
    void setLabel(const CollectionLocation& location, const QString& label);
 
    void changeType(const CollectionLocation& location, int type);
 
    QList<CollectionLocation> checkHardWiredLocations();
 
    void migrationCandidates(const CollectionLocation& disappearedLocation,
                             QString* const technicalDescription,
                             QStringList* const candidateIdentifiers,
                             QStringList* const candidateDescriptions);
 
    void migrateToVolume(const CollectionLocation& location, const QString& identifier);
 
    QList<CollectionLocation> allLocations();
 
    QList<CollectionLocation> allAvailableLocations();
 
    CollectionLocation locationForAlbumRootId(int id);
 
    CollectionLocation locationForAlbumRoot(const QUrl& fileUrl);
    CollectionLocation locationForAlbumRootPath(const QString& albumRootPath);
 
    CollectionLocation locationForUrl(const QUrl& fileUrl);
    CollectionLocation locationForPath(const QString& filePath);
 
private:
 
    void updateLocations();
 
Q_SIGNALS:
 
    void locationStatusChanged(const CollectionLocation& location, int oldStatus);
 
    void locationPropertiesChanged(const CollectionLocation& location);
 
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    QStringList allAvailableAlbumRootPaths();
 
    QString albumRootPath(int id);
 
    QString albumRootLabel(int id);
 
 
    QUrl    albumRoot(const QUrl& fileUrl);
    QString albumRootPath(const QUrl& fileUrl);
    QString albumRootPath(const QString& filePath);
 
    bool    isAlbumRoot(const QUrl& fileUrl);
 
    bool    isAlbumRoot(const QString& filePath);
 
 
    QString album(const QUrl& fileUrl);
    QString album(const QString& filePath);
    QString album(const CollectionLocation& location, const QUrl& fileUrl);
    QString album(const CollectionLocation& location, const QString& filePath);
 
 
    QUrl    oneAlbumRoot();
    QString oneAlbumRootPath();
 
private Q_SLOTS:
 
    void slotAlbumRootChange(const AlbumRootChangeset& changeset);
 
 
public:
 
    class Private;
 
private:
 
    static CollectionManager* m_instance;
 
    Private* const d;
 
    friend class Private;
    friend class CoreDbWatch;
    friend class CoreDbAccess;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_COLLECTION_MANAGER_H