harbour-books/app/src/BooksShelf.h

/*
 * Copyright (C) 2015-2018 Jolla Ltd.
 * Copyright (C) 2015-2018 Slava Monich <slava.monich@jolla.com>
 *
 * You may use this file under the terms of the BSD license as follows:
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *   * Neither the name of Jolla Ltd nor the names of its contributors
 *     may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef BOOKS_SHELF_MODEL_H
#define BOOKS_SHELF_MODEL_H

#include "BooksItem.h"
#include "BooksStorage.h"
#include "BooksSaveTimer.h"
#include "BooksTaskQueue.h"
#include "BooksLoadingProperty.h"

#include <QDir>
#include <QHash>
#include <QVariant>
#include <QByteArray>
#include <QAbstractListModel>
#include <QtQml>

class BooksShelf: public QAbstractListModel, public BooksItem, public BooksLoadingProperty
{
    Q_OBJECT
    Q_PROPERTY(int count READ count NOTIFY countChanged)
    Q_PROPERTY(int bookCount READ bookCount NOTIFY bookCountChanged)
    Q_PROPERTY(int shelfCount READ shelfCount NOTIFY shelfCountChanged)
    Q_PROPERTY(bool loading READ loading NOTIFY loadingChanged)
    Q_PROPERTY(bool accessible READ accessible CONSTANT)
    Q_PROPERTY(QString path READ path NOTIFY pathChanged)
    Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
    Q_PROPERTY(QString device READ device WRITE setDevice NOTIFY deviceChanged)
    Q_PROPERTY(QString relativePath READ relativePath WRITE setRelativePath NOTIFY relativePathChanged)
    Q_PROPERTY(bool editMode READ editMode WRITE setEditMode NOTIFY editModeChanged)
    Q_PROPERTY(bool hasDummyItem READ hasDummyItem WRITE setHasDummyItem NOTIFY hasDummyItemChanged)
    Q_PROPERTY(int dummyItemIndex READ dummyItemIndex WRITE setDummyItemIndex NOTIFY dummyItemIndexChanged)
    Q_PROPERTY(BooksBook* book READ book CONSTANT)
    Q_PROPERTY(BooksShelf* shelf READ shelf CONSTANT)
    Q_PROPERTY(QObject* storage READ storageObject CONSTANT)

public:
    explicit BooksShelf(QObject* aParent = NULL);
    BooksShelf(BooksStorage aStorage, QString aRelativePath);
    ~BooksShelf();

    Q_INVOKABLE QObject* get(int aIndex) const;
    Q_INVOKABLE bool drop(QObject* aItem);
    Q_INVOKABLE void move(int aFrom, int aTo);
    Q_INVOKABLE void remove(int aIndex);
    Q_INVOKABLE void removeAll();
    Q_INVOKABLE bool deleteRequested(int aIndex) const;
    Q_INVOKABLE void setDeleteRequested(int aIndex, bool aValue);
    Q_INVOKABLE void cancelAllDeleteRequests();
    Q_INVOKABLE void importBook(QObject* aBook);

    bool loading() const { return iLoadTask != NULL; }
    int count() const;
    int bookCount() const;
    int shelfCount() const;
    QString relativePath() const { return iRelativePath; }
    void setRelativePath(QString aPath);
    BooksBook* bookAt(int aIndex) const;
    QObject* storageObject() { return &iStorage; }
    const BooksStorage& storage() const { return iStorage; }
    void setName(QString aName);

    bool editMode() const { return iEditMode; }
    void setEditMode(bool aEditMode);

    bool hasDummyItem() const { return iDummyItemIndex >= 0; }
    void setHasDummyItem(bool aHasDummyItem);

    int dummyItemIndex() const { return iDummyItemIndex; }
    void setDummyItemIndex(int aIndex);

    QString device() { return iStorage.device(); }
    void setDevice(QString aDevice);

    // QAbstractListModel
    virtual QHash<int,QByteArray> roleNames() const;
    virtual int rowCount(const QModelIndex& aParent) const;
    virtual QVariant data(const QModelIndex& aIndex, int aRole) const;

    // BooksItem
    virtual BooksItem* retain();
    virtual void release();
    virtual QObject* object();
    virtual BooksShelf* shelf();
    virtual BooksBook* book();
    virtual QString name() const;
    virtual QString fileName() const;
    virtual QString path() const;
    virtual bool accessible() const;
    virtual void deleteFiles();
    virtual BooksItem* copyTo(const BooksStorage& aStorage, QString aRelPath,
        CopyOperation* aObserver);

Q_SIGNALS:
    void loadingChanged();
    void countChanged();
    void bookCountChanged();
    void shelfCountChanged();
    void pathChanged();
    void nameChanged();
    void deviceChanged();
    void relativePathChanged();
    void editModeChanged();
    void hasDummyItemChanged();
    void dummyItemIndexChanged();
    void bookAdded(BooksBook* aBook);
    void bookRemoved(BooksBook* aBook);

private Q_SLOTS:
    void onLoadTaskDone();
    void onBookAccessibleChanged();
    void onBookCopyingOutChanged();
    void onBookMovedAway();
    void onCopyTaskProgressChanged();
    void onCopyTaskDone();
    void onDeleteTaskDone();
    void onStorageReplaced(BooksStorage aOldStorage, BooksStorage aNewStorage);
    void saveState();

private:
    void init();
    QString stateFileName() const;
    QString stateFileName(QString aRelativePath) const;
    int bookIndex(BooksBook* aBook) const;
    int itemIndex(QString aFileName, int aStartIndex = 0) const;
    bool validIndex(int aIndex) const;
    void emitDataChangedSignal(int aRow, int aRole);
    void queueStateSave();
    void loadBookList();
    void updatePath();
    void updateFileName();
    void submitDeleteTask(int aIndex);

private:
    class Data;
    class Counts;
    class CopyTask;
    class LoadTask;
    class ImportTask;
    class DeleteTask;
    friend class Counts;

    bool iLoadBookList;
    QList<Data*> iList;
    QList<DeleteTask*> iDeleteTasks;
    LoadTask* iLoadTask;
    QString iFileName;
    QString iPath;
    QString iRelativePath;
    BooksStorage iStorage;
    int iDummyItemIndex;
    bool iEditMode;
    QAtomicInt iRef;
    BooksSaveTimer* iSaveTimer;
    shared_ptr<BooksTaskQueue> iTaskQueue;
};

QML_DECLARE_TYPE(BooksShelf)

inline bool BooksShelf::validIndex(int aIndex) const
    { return aIndex >= 0 && aIndex < iList.count(); }
inline QString BooksShelf::stateFileName() const
    { return stateFileName(iRelativePath); }

#endif // BOOKS_SHELF_MODEL_H