btbookmarksmodel.cpp

Go to the documentation of this file.

/*********
*
* In the name of the Father, and of the Son, and of the Holy Spirit.
*
* This file is part of BibleTime's source code, https://bibletime.info/
*
* Copyright 1999-2021 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License
* version 2.0.
*
**********/
 
/**
  Total change list that should be applied after refactoring complete:
    non latin bookmark titles shown with unrecognized symbols
    feature request: hold Shift and Ctrl upon dragging item
    move loader to private class
    add ability to create bookmarks data with setData/insertRows
    unrecognized characters increaases in size file each save/load
    root folder for bookmarks
*/
 
#include "btbookmarksmodel.h"
 
#include <algorithm>
#include <memory>
#include <QDir>
#include <QDomElement>
#include <QDomNode>
#include <QFile>
#include <QIODevice>
#include <QList>
#include <QString>
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    #include <QTextCodec>
#endif
#include <QTextStream>
#include <QTime>
#include <QTimer>
#include <utility>
#include "../util/btassert.h"
#include "../util/btconnect.h"
#include "../util/cresmgr.h"
#include "../util/directory.h"
#include "../util/tool.h"
#include "btglobal.h"
#include "config/btconfig.h"
#include "drivers/cswordmoduleinfo.h"
#include "keys/cswordversekey.h"
#include "managers/cswordbackend.h"
 
 
#define CURRENT_SYNTAX_VERSION 1
 
 
namespace {
 
inline QString toHeader(QString const & key, QString const & moduleName)
{ return QStringLiteral("%1 (%2)").arg(key).arg(moduleName); }
 
class BookmarkFolder;
 
class BookmarkItemBase {
 
public: // methods:
 
    BookmarkItemBase(BookmarkFolder * parent = nullptr);
 
    BookmarkItemBase(const BookmarkItemBase & other)
        : m_parent(other.m_parent)
        , m_text(other.m_text)
    {}
 
    virtual ~BookmarkItemBase() {}
 
    void setText(QString const & text) { m_text = text; }
 
    QString const & text() const { return m_text; }
 
    virtual QString toolTip() const { return {}; }
 
    virtual Qt::ItemFlags flags() const noexcept { return Qt::NoItemFlags; }
 
    virtual QIcon const & icon() const noexcept {
        static QIcon const noIcon;
        return noIcon;
    }
 
    void setParent(BookmarkFolder * parent) { m_parent = parent; }
 
    BookmarkFolder * parent() const { return m_parent; }
 
    /** \returns index of this item in parent's child array. */
    int index() const;
 
private:
 
    BookmarkFolder * m_parent;
    QString m_text;
 
};
 
class BookmarkItem final : public BookmarkItemBase {
public:
 
    BookmarkItem(BookmarkFolder * parent);
 
    /** Creates a bookmark with module, key and description. */
    BookmarkItem(const CSwordModuleInfo & module, const QString & key,
                 const QString & description, const QString & title);
 
    /** Creates a copy. */
    BookmarkItem(const BookmarkItem & other);
 
    Qt::ItemFlags flags() const noexcept final override {
        return Qt::ItemIsSelectable // | Qt::ItemIsEditable
               | Qt::ItemIsDragEnabled | Qt::ItemIsDropEnabled
               | Qt::ItemIsEnabled;
    }
 
    QIcon const & icon() const noexcept final override
    { return CResMgr::mainIndex::bookmark::icon(); }
 
    /** Returns the used module, 0 if there is no such module. */
    CSwordModuleInfo * module() const;
 
    /** Returns the used key. */
    QString key() const;
 
    void setKey(QString const & key) { m_key = key; }
 
    /** Returns the used description. */
    QString const & description() const { return m_description; }
 
    void setDescription(QString const & description)
    { m_description = description; }
 
    /** Returns a tooltip for this bookmark. */
    QString toolTip() const override;
 
    /** Returns the english key.*/
    QString const & englishKey() const { return m_key; }
 
    void setModule(QString const & moduleName)
    { m_moduleName = moduleName; }
 
    QString const & moduleName() const { return m_moduleName; }
 
private:
    QString m_key;
    QString m_description;
    QString m_moduleName;
 
};
 
class BookmarkFolder final : public BookmarkItemBase {
public:
 
    BookmarkFolder(const QString & name, BookmarkFolder * parent = nullptr);
 
    ~BookmarkFolder() final override { qDeleteAll(m_children); }
 
    Qt::ItemFlags flags() const noexcept final override {
        return Qt::ItemIsSelectable | Qt::ItemIsEditable
               | Qt::ItemIsDragEnabled | Qt::ItemIsDropEnabled
               | Qt::ItemIsEnabled;
    }
 
    QIcon const & icon() const noexcept final override
    { return CResMgr::mainIndex::closedFolder::icon(); }
 
    /** Children routines. */
    void addChild(BookmarkItemBase * child) {
        child->setParent(this);
        BT_ASSERT(!m_children.contains(child));
        m_children.append(child);
    }
 
    QList<BookmarkItemBase *> & children() noexcept { return m_children; }
    QList<BookmarkItemBase *> const & children() const noexcept
    { return m_children; }
 
    void insertChild(int index, BookmarkItemBase * child) {
        child->setParent(this);
        BT_ASSERT(!m_children.contains(child));
        m_children.insert(index, child);
    }
 
    void insertChildren(int index, QList<BookmarkItemBase *> children) {
        for (auto * const c : children)
            insertChild(index++, c);
    }
 
    void removeChild(int index) {
        delete m_children[index];
        m_children.removeAt(index);
    }
 
    /** Returns true if the given item is this or a direct or indirect subitem of this. */
    bool hasDescendant(BookmarkItemBase const * item) const;
 
    /** Creates a deep copy of this item. */
    BookmarkFolder * deepCopy() const;
 
private: // Fields:
 
    QList<BookmarkItemBase *> m_children;
 
};
 
 
BookmarkItemBase::BookmarkItemBase(BookmarkFolder * parent)
    : m_parent(parent)
{
    if (m_parent)
        m_parent->addChild(this);
}
 
int BookmarkItemBase::index() const {
    BT_ASSERT(m_parent);
    return m_parent->children().indexOf(
        const_cast<BookmarkItemBase *>(this));
}
 
}
 
class BtBookmarksModelPrivate {
 
public: // methods:
 
    BtBookmarksModelPrivate(BtBookmarksModel * parent)
        : m_rootItem(new BookmarkFolder(QStringLiteral("Root")))
        , q_ptr(parent)
    {
        m_saveTimer.setInterval(30 * 1000);
        m_saveTimer.setSingleShot(true);
    }
    ~BtBookmarksModelPrivate() { delete m_rootItem; }
 
    static QString defaultBookmarksFile() {
        return util::directory::getUserBaseDir().absolutePath()
                + QStringLiteral("/bookmarks.xml");
    }
 
    BookmarkItemBase * item(const QModelIndex & index) const {
        if (index.isValid())
            return static_cast<BookmarkItemBase *>(index.internalPointer());
        return m_rootItem;
    }
 
    template <typename T>
    T * itemAs(QModelIndex const & index) const
    { return dynamic_cast<T *>(item(index)); }
 
    void needSave(){
        if(m_defaultModel == q_ptr){
            if(!m_saveTimer.isActive())
                m_saveTimer.start();
        }
    }
 
    /** Loads a list of items (with subitem trees) from a named file
    * or from the default bookmarks file. */
    QList<BookmarkItemBase *> loadTree(QString fileName = QString()) {
        QList<BookmarkItemBase*> itemList;
 
        QDomDocument doc;
        QString bookmarksFile = loadXmlFromFile(fileName);
        if (bookmarksFile.isNull())
            return QList<BookmarkItemBase*>();
 
        doc.setContent(bookmarksFile);
        QDomElement document = doc.documentElement();
        if (document.tagName() != QStringLiteral("SwordBookmarks")) {
            qWarning("Not a BibleTime Bookmark XML file");
            return QList<BookmarkItemBase*>();
        }
 
        QDomElement child = document.firstChild().toElement();
 
        while ( !child.isNull() && child.parentNode() == document) {
            BookmarkItemBase* i = handleXmlElement(child, nullptr);
            itemList.append(i);
            if (!child.nextSibling().isNull()) {
                child = child.nextSibling().toElement();
            }
            else {
                child = QDomElement(); //null
            }
 
        }
 
        return itemList;
    }
 
    /** Create a new item from a document element. */
    BookmarkItemBase * handleXmlElement(QDomElement & element, BookmarkFolder * parent) {
        if (element.tagName() == QStringLiteral("Folder")) {
            BookmarkFolder* newFolder = new BookmarkFolder(QString(), parent);
            if (element.hasAttribute(QStringLiteral("caption"))) {
                newFolder->setText(element.attribute(
                                       QStringLiteral("caption")));
            }
            QDomNodeList childList = element.childNodes();
            for (int i = 0; i < childList.length(); i++) {
                QDomElement newElement = childList.at(i).toElement();
                handleXmlElement(newElement, newFolder); // passing parent in constructor will add items to tree
            }
            return newFolder;
        }
        if (element.tagName() == QStringLiteral("Bookmark")) {
            BookmarkItem* newBookmarkItem = new BookmarkItem(parent);
            if (element.hasAttribute(QStringLiteral("modulename"))) {
                //we use the name in all cases, even if the module isn't installed anymore
                newBookmarkItem->setModule(
                            element.attribute(QStringLiteral("modulename")));
            }
            if (element.hasAttribute(QStringLiteral("key"))) {
                newBookmarkItem->setKey(
                            element.attribute(QStringLiteral("key")));
            }
            if (element.hasAttribute(QStringLiteral("description"))) {
                newBookmarkItem->setDescription(
                            element.attribute(QStringLiteral("description")));
            }
            if (element.hasAttribute(QStringLiteral("title"))) {
                newBookmarkItem->setText(
                            element.attribute(QStringLiteral("title")));
            }
            return newBookmarkItem;
        }
        return nullptr;
    }
 
    /** Loads a bookmark XML document from a named file or from the default bookmarks file. */
    QString loadXmlFromFile(QString fileName = QString()) {
        if (fileName.isEmpty())
            fileName = defaultBookmarksFile();
 
        QTextStream t;
        t.setAutoDetectUnicode(false);
        #if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
        t.setCodec(QTextCodec::codecForName(QByteArrayLiteral("UTF-8")));
        #else
        t.setEncoding(QStringConverter::Utf8);
        #endif
 
        QFile file(fileName);
        if (!file.open(QIODevice::ReadOnly))
            return {};
 
        t.setDevice(&file);
        return t.readAll();
    }
 
    /** Takes one item and saves the tree which is under it to a named file
    * or to the default bookmarks file, asking the user about overwriting if necessary. */
    QString serializeTreeFromRootItem(BookmarkFolder * rootItem) {
        BT_ASSERT(rootItem);
 
        QDomDocument doc(QStringLiteral("DOC"));
        doc.appendChild(
                    doc.createProcessingInstruction(
                        QStringLiteral("xml"),
                        QStringLiteral("version=\"1.0\" encoding=\"UTF-8\"")));
 
        auto content =
                doc.createElement(QStringLiteral("SwordBookmarks"));
        content.setAttribute(QStringLiteral("syntaxVersion"),
                             CURRENT_SYNTAX_VERSION);
        doc.appendChild(content);
 
        //append the XML nodes of all child items
 
        for (auto const * const itemPtr : rootItem->children())
            saveItem(itemPtr, content);
        return doc.toString();
    }
 
    /** Writes one item to a document element. */
    void saveItem(BookmarkItemBase const * item, QDomElement & parentElement) {
        BookmarkFolder const * folderItem = nullptr;
        BookmarkItem const * bookmarkItem = nullptr;
 
        if ((folderItem = dynamic_cast<BookmarkFolder const *>(item))) {
            auto elem =
                    parentElement.ownerDocument().createElement(
                        QStringLiteral("Folder"));
            elem.setAttribute(QStringLiteral("caption"), folderItem->text());
 
            parentElement.appendChild(elem);
 
            for (auto const * const itemPtr : folderItem->children())
                saveItem(itemPtr, elem);
        }
        else if ((bookmarkItem = dynamic_cast<BookmarkItem const *>(item))) {
            auto elem =
                    parentElement.ownerDocument().createElement(
                        QStringLiteral("Bookmark"));
 
            elem.setAttribute(QStringLiteral("key"),
                              bookmarkItem->englishKey());
            elem.setAttribute(QStringLiteral("description"),
                              bookmarkItem->description());
            elem.setAttribute(QStringLiteral("modulename"),
                              bookmarkItem->moduleName());
            elem.setAttribute(QStringLiteral("moduledescription"),
                              bookmarkItem->module()
                              ? bookmarkItem->module()->config(
                                    CSwordModuleInfo::Description)
                              : QString());
            if (!bookmarkItem->text().isEmpty()) {
                elem.setAttribute(QStringLiteral("title"), bookmarkItem->text());
            }
            parentElement.appendChild(elem);
        }
    }
 
 
public: // fields:
 
    BookmarkFolder * m_rootItem;
    QTimer m_saveTimer;
    static BtBookmarksModel * m_defaultModel;
 
    Q_DECLARE_PUBLIC(BtBookmarksModel)
    BtBookmarksModel * const q_ptr;
 
};
 
BtBookmarksModel * BtBookmarksModelPrivate::m_defaultModel = nullptr;
 
BookmarkFolder::BookmarkFolder(const QString & name, BookmarkFolder * parent)
        : BookmarkItemBase(parent) {
    setText(name);
}
 
bool BookmarkFolder::hasDescendant(BookmarkItemBase const * const item) const {
    if (this == item)
        return true;
    if (children().indexOf(const_cast<BookmarkItemBase *>(item)) > -1)
        return true;
    for (auto const * const childItem : children())
        if (BookmarkFolder const * const folder =
                dynamic_cast<BookmarkFolder const *>(childItem))
            if (folder->hasDescendant(childItem))
                return true;
    return false;
}
 
BookmarkFolder * BookmarkFolder::deepCopy() const {
    BookmarkFolder* newFolder = new BookmarkFolder(this->text());
    for (auto const * const subitem : children()) {
        if (BookmarkItem const * const bmItem =
                dynamic_cast<BookmarkItem const *>(subitem))
        {
            newFolder->addChild(new BookmarkItem(*bmItem));
        } else if (BookmarkFolder const * const bmFolder =
                           dynamic_cast<BookmarkFolder const *>(subitem))
        {
            newFolder->addChild(bmFolder->deepCopy());
        }
    }
    return newFolder;
}
 
BookmarkItem::BookmarkItem(CSwordModuleInfo const & module,
                               const QString & key,
                               const QString & description,
                               const QString & title)
        : m_description(description)
        , m_moduleName(module.name())
{
    Q_UNUSED(title)
 
    if (((module.type() == CSwordModuleInfo::Bible) || (module.type() == CSwordModuleInfo::Commentary))) {
        /// here we only translate \param key into english
        sword::VerseKey vk(key.toUtf8().constData(), key.toUtf8().constData(),
            static_cast<sword::VerseKey *>(module.swordModule().getKey())->getVersificationSystem());
        CSwordVerseKey k(&vk, &module);
        k.setLocale("en");
        m_key = k.key();
    }
    else {
        m_key = key;
    }
 
    setText(toHeader(key, module.name()));
}
 
BookmarkItem::BookmarkItem(BookmarkFolder * parent)
        : BookmarkItemBase(parent) {
    setText(toHeader(key(), module() ? module()->name() : QObject::tr("unknown")));
}
 
BookmarkItem::BookmarkItem(const BookmarkItem & other)
        : BookmarkItemBase(other)
        , m_key(other.m_key)
        , m_description(other.m_description)
        , m_moduleName(other.m_moduleName)
{
    setText(toHeader(key(), module() ? module()->name() : QObject::tr("unknown")));
}
 
CSwordModuleInfo * BookmarkItem::module() const
{ return CSwordBackend::instance().findModuleByName(m_moduleName); }
 
QString BookmarkItem::key() const {
    const QString englishKeyName = englishKey();
    if (!module()) {
        return englishKeyName;
    }
 
    QString returnKeyName = englishKeyName;
    if ((module()->type() == CSwordModuleInfo::Bible) || (module()->type() == CSwordModuleInfo::Commentary)) {
        /// here we only translate \param key into current book name language
        sword::VerseKey vk(englishKeyName.toUtf8().constData(), englishKeyName.toUtf8().constData(),
            static_cast<sword::VerseKey *>(module()->swordModule().getKey())->getVersificationSystem());
        CSwordVerseKey k(&vk, module());
        k.setLocale(CSwordBackend::instance().booknameLanguage().toLatin1());
        returnKeyName = k.key();
    }
 
    return returnKeyName;
}
 
QString BookmarkItem::toolTip() const {
    auto const * const m = module();
    if (!m)
        return QString();
 
    FilterOptions filterOptions = btConfig().getFilterOptions();
    filterOptions.footnotes = false;
    filterOptions.scriptureReferences = false;
    CSwordBackend::instance().setFilterOptions(filterOptions);
 
    std::unique_ptr<CSwordKey> k(m->createKey());
    BT_ASSERT(k);
    k->setKey(key());
 
    // Language const * lang = m->language();
    // BtConfig::FontSettingsPair fontPair = getBtConfig().getFontForLanguage(lang);
 
    auto const header = toHeader(key(), m->name());
    auto const & txt = text();
    if (txt == header)
        return QStringLiteral("<b>%1)</b><hr>%2").arg(header, description());
    return QStringLiteral("<b>%1)</b><br>%2<hr>%3")
            .arg(header, txt, description());
}
 
 
BtBookmarksModel::BtBookmarksModel(QObject * parent)
    : QAbstractItemModel(parent)
    , d_ptr(new BtBookmarksModelPrivate(this))
{
    load();
}
 
BtBookmarksModel::BtBookmarksModel(QString const & fileName, QObject * parent)
    : QAbstractItemModel(parent)
    , d_ptr(new BtBookmarksModelPrivate(this))
{ load(fileName); }
 
BtBookmarksModel::~BtBookmarksModel() {
    Q_D(BtBookmarksModel);
 
    if(d->m_saveTimer.isActive())
        save();
 
    delete d_ptr;
}
 
int BtBookmarksModel::rowCount(const QModelIndex & parent) const {
    Q_D(const BtBookmarksModel);
 
    if (auto const * const f = dynamic_cast<BookmarkFolder *>(d->item(parent)))
        return f->children().size();
    return 0;
}
 
int BtBookmarksModel::columnCount(const QModelIndex & parent) const {
    Q_UNUSED(parent)
    return 1;
}
 
bool BtBookmarksModel::hasChildren(const QModelIndex & parent) const {
    return rowCount(parent) > 0;
}
QModelIndex BtBookmarksModel::index(int row, int column, const QModelIndex & parent) const {
    Q_D(const BtBookmarksModel);
 
    auto const * const f = dynamic_cast<BookmarkFolder *>(d->item(parent));
    if (f && f->children().size() > row && row >= 0)
        return createIndex(row, column, f->children()[row]);
    return QModelIndex();
}
 
QModelIndex BtBookmarksModel::parent(const QModelIndex & index) const {
    Q_D(const BtBookmarksModel);
 
    const BookmarkItemBase * i = d->item(index);
    return (i->parent() == nullptr || i->parent()->parent() == nullptr) ?
                QModelIndex() : createIndex(i->parent()->index(), 0, i->parent());
}
 
QVariant BtBookmarksModel::data(const QModelIndex & index, int role) const {
    Q_D(const BtBookmarksModel);
 
    const BookmarkItemBase * i = d->item(index);
 
    switch(role)
    {
        case Qt::DisplayRole:
        case Qt::EditRole:
            return i->text();
        case Qt::ToolTipRole:
            return i->toolTip();
        case Qt::DecorationRole:
            return i->icon();
        case TypeRole:
            {
                if(isBookmark(index))
                    return QStringLiteral("bookmark");
                else
                    return QStringLiteral("folder");
            }
    }
    return QVariant();
}
 
Qt::ItemFlags BtBookmarksModel::flags(const QModelIndex & index) const {
    Q_D(const BtBookmarksModel);
 
    return d->item(index)->flags();
}
 
QVariant BtBookmarksModel::headerData(int section, Qt::Orientation orientation, int role) const {
    Q_UNUSED(section)
    Q_UNUSED(orientation)
    Q_UNUSED(role)
 
    return QVariant();
}
 
bool BtBookmarksModel::setData(const QModelIndex & index, const QVariant & val, int role) {
    Q_D(BtBookmarksModel);
 
    BookmarkItemBase * i = d->item(index);
    if (role == Qt::DisplayRole || role == Qt::EditRole) {
        i->setText(val.toString());
        if(dynamic_cast<BookmarkFolder *>(i) || dynamic_cast<BookmarkItem *>(i))
            d->needSave();
        return true;
    }
    return false;
}
 
bool BtBookmarksModel::removeRows(int row, int count, const QModelIndex & parent)
{
    Q_D(BtBookmarksModel);
    if (auto * const f = dynamic_cast<BookmarkFolder *>(d->item(parent))) {
        BT_ASSERT(row + count <= f->children().size());
        beginRemoveRows(parent, row, row + count - 1);
        for(int i = 0; i < count; ++i)
            f->removeChild(row);
        endRemoveRows();
        d->needSave();
        return true;
    }
    return false;
}
 
bool BtBookmarksModel::insertRows(int row, int count, const QModelIndex &parent)
{
    Q_D(BtBookmarksModel);
    if (auto * const f = dynamic_cast<BookmarkFolder *>(d->item(parent))) {
        BT_ASSERT(row <= f->children().size());
        beginInsertRows(parent, row, row + count - 1);
        for(int i = 0; i < count; ++i)
            f->insertChild(row, new BookmarkItemBase);
        endInsertRows();
        return true;
    }
    return false;
}
 
bool BtBookmarksModel::save(QString fileName, const QModelIndex & rootItem) {
    Q_D(BtBookmarksModel);
    BT_ASSERT(dynamic_cast<BookmarkFolder *>(d->item(rootItem)));
    auto const serializedTree =
            d->serializeTreeFromRootItem(
                static_cast<BookmarkFolder *>(d->item(rootItem)));
    if (fileName.isEmpty())
        fileName = BtBookmarksModelPrivate::defaultBookmarksFile();
 
    util::tool::savePlainFile(fileName, serializedTree);
 
    if(d->m_saveTimer.isActive())
        d->m_saveTimer.stop();
 
    return true;
}
 
bool BtBookmarksModel::load(QString fileName, const QModelIndex & rootItem) {
    Q_D(BtBookmarksModel);
    BT_ASSERT(dynamic_cast<BookmarkFolder *>(d->item(rootItem)));
    auto * const i = static_cast<BookmarkFolder *>(d->item(rootItem));
    QList<BookmarkItemBase *> items = d->loadTree(fileName);
 
    if(!rootItem.isValid() && fileName.isEmpty()) {
        BT_ASSERT(!d->m_defaultModel && "Only one default model allowed!");
        BT_CONNECT(&d->m_saveTimer, &QTimer::timeout,
                   this,            &BtBookmarksModel::slotSave);
        d->m_defaultModel = this;
    }
 
    if(items.size() == 0)
        return false;
 
    auto const numChildren = i->children().size();
    beginInsertRows(rootItem, numChildren, numChildren + items.size() - 1);
    i->insertChildren(numChildren, items);
    endInsertRows();
    return true;
}
 
bool BtBookmarksModel::isFolder(const QModelIndex &index) const
{
    Q_D(const BtBookmarksModel);
    return d->itemAs<BookmarkFolder const>(index);
}
 
bool BtBookmarksModel::isBookmark(const QModelIndex &index) const
{
    Q_D(const BtBookmarksModel);
    return d->itemAs<BookmarkItem const>(index);
}
 
void BtBookmarksModel::copyItems(int row, const QModelIndex & parent, const QModelIndexList & toCopy)
{
    Q_D(BtBookmarksModel);
    BT_ASSERT(dynamic_cast<BookmarkFolder *>(d->item(parent)));
    auto * const targetFolder = static_cast<BookmarkFolder *>(d->item(parent));
 
    bool bookmarksOnly = true;
    bool targetIncluded = false;
    bool moreThanOneFolder = false;
 
    QList<BookmarkItemBase *> newList;
 
    for (auto const & index : toCopy) {
        if (BookmarkFolder const * const folder =
                d->itemAs<BookmarkFolder const>(index))
        {
            bookmarksOnly = false;
            if (toCopy.count() > 1) { // only one item allowed if a folder is selected
                moreThanOneFolder = true;
                break;
            }
            if (folder->hasDescendant(d->item(parent))) { // dropping to self or descendand not allowed
                targetIncluded = true;
                break;
            }
        }
        else {
            newList.append(new BookmarkItem(*(d->itemAs<BookmarkItem>(index))));
        }
    }
 
    if (!bookmarksOnly && toCopy.count() == 1)
        newList.append(d->itemAs<BookmarkFolder const>(toCopy[0])->deepCopy());
    if (!bookmarksOnly && toCopy.count() > 1) {
        // wrong amount of items
        moreThanOneFolder = true;
    }
 
    if (moreThanOneFolder || targetIncluded) {
        return;
    }
 
 
    beginInsertRows(parent, row, row + newList.size() - 1);
 
    targetFolder->insertChildren(row, newList);
 
    endInsertRows();
 
    d->needSave();
}
 
CSwordModuleInfo * BtBookmarksModel::module(const QModelIndex & index) const
{
    Q_D(const BtBookmarksModel);
 
    if (BookmarkItem const * const i = d->itemAs<BookmarkItem const>(index))
        return i->module();
    return nullptr;
}
 
QString BtBookmarksModel::key(const QModelIndex & index) const
{
    Q_D(const BtBookmarksModel);
 
    if (BookmarkItem const * const i = d->itemAs<BookmarkItem const>(index))
        return i->key();
    return QString();
}
 
QString BtBookmarksModel::description(const QModelIndex &index) const
{
    Q_D(const BtBookmarksModel);
 
    if (BookmarkItem const * const i = d->itemAs<BookmarkItem const>(index))
        return i->description();
    return QString();
}
 
void BtBookmarksModel::setDescription(const QModelIndex &index, const QString &description)
{
    Q_D(BtBookmarksModel);
 
    if (BookmarkItem * const i = d->itemAs<BookmarkItem>(index)) {
        i->setDescription(description);
        d->needSave();
    }
}
 
QModelIndex BtBookmarksModel::addBookmark(int const row,
                                          QModelIndex const & parent,
                                          CSwordModuleInfo const & module,
                                          QString const & key,
                                          QString const & description,
                                          QString const & title)
{
    Q_D(BtBookmarksModel);
 
    if (BookmarkFolder * const i = d->itemAs<BookmarkFolder>(parent)) {
        int r = row < 0 ? row + rowCount(parent) + 1 : row;
 
        beginInsertRows(parent, r, r);
 
        BookmarkItem * c = new BookmarkItem(module, key, description, title);
        i->insertChild(r, c);
 
        endInsertRows();
 
        d->needSave();
 
        return createIndex(c->index(), 0, c);
    }
    return QModelIndex();
}
 
QModelIndex BtBookmarksModel::addFolder(int row, const QModelIndex &parent, const QString &name)
{
    Q_D(BtBookmarksModel);
 
    if (BookmarkFolder * const i = d->itemAs<BookmarkFolder>(parent)) {
        beginInsertRows(parent, row, row);
 
        BookmarkFolder * c = new BookmarkFolder(name.isEmpty() ? QObject::tr("New folder") : name);
        i->insertChild(row, c);
 
        endInsertRows();
 
        d->needSave();
 
        return createIndex(c->index(), 0, c);
    }
    return QModelIndex();
}
 
bool BtBookmarksModel::hasDescendant(const QModelIndex &baseIndex, const QModelIndex &testIndex) const
{
    Q_D(const BtBookmarksModel);
 
    if (BookmarkFolder const * const f =
            d->itemAs<BookmarkFolder const>(baseIndex))
        return f->hasDescendant(d->item(testIndex));
    return false;
}
 
bool BtBookmarksModelSortAscending(BookmarkItemBase * i1, BookmarkItemBase * i2)
{
    return i1->text().localeAwareCompare(i2->text()) < 0;
}
 
bool BtBookmarksModelSortDescending(BookmarkItemBase * i1, BookmarkItemBase * i2)
{
    return i1->text().localeAwareCompare(i2->text()) > 0;
}
 
void BtBookmarksModel::sortItems(QModelIndex const & parent,
                                 Qt::SortOrder const order)
{
    Q_D(BtBookmarksModel);
 
    if(BookmarkFolder * const f = d->itemAs<BookmarkFolder>(parent)) {
        QList<BookmarkFolder *> parents;
        if(f == d->m_rootItem) {
            QList<BookmarkItemBase *> items;
            items.append(f);
            for(int i = 0; i < items.size(); ++i) {
                if (auto * const ff = dynamic_cast<BookmarkFolder *>(items[i])){
                    items.append(ff->children());
                    parents.append(ff);
                }
            }
        }
        else
            parents.append(f);
 
        for (auto * const f : parents) {
            Q_EMIT layoutAboutToBeChanged();
 
            QModelIndexList indexes;
            for(int i = 0; i < f->children().size(); ++i)
                indexes.append(createIndex(i, 0, f->children()[i]));
 
            std::sort(f->children().begin(),
                      f->children().end(),
                      order == Qt::AscendingOrder
                      ? BtBookmarksModelSortAscending
                      : BtBookmarksModelSortDescending);
 
            for(int i = 0; i < f->children().size(); ++i) {
                BookmarkItemBase * iii = f->children()[i];
                for(int ii = 0; ii < indexes.size(); ++ii)
                    if(iii == indexes[ii].internalPointer())
                        changePersistentIndex(createIndex(ii, 0, iii), createIndex(i, 0, iii));
            }
            Q_EMIT layoutChanged();
 
            d->needSave();
        }
    }
}
 
QHash<int, QByteArray> BtBookmarksModel::roleNames() const {
    static auto const staticRoleNames = {
        std::make_pair(static_cast<int>(Qt::DisplayRole),
                       QByteArrayLiteral("display")),
        std::make_pair(static_cast<int>(Qt::DecorationRole),
                       QByteArrayLiteral("icon")),
        std::make_pair(static_cast<int>(Qt::EditRole),
                       QByteArrayLiteral("edit")),
        std::make_pair(static_cast<int>(TypeRole),
                       QByteArrayLiteral("itemtype"))
    };
    return staticRoleNames;
}