harbour-books/app/src/BooksSettings.cpp

/*
 * Copyright (C) 2015-2019 Jolla Ltd.
 * Copyright (C) 2015-2019 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:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *   2. 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.
 *   3. Neither the names of the copyright holders 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.
 */

#include "BooksSettings.h"
#include "BooksTextStyle.h"
#include "BooksTextView.h"
#include "BooksBook.h"
#include "BooksDefs.h"
#include "BooksUtil.h"

#include "HarbourDebug.h"

#include <MGConfItem>

#define DCONF_PATH                  BOOKS_DCONF_ROOT
#define KEY_FONT_SIZE               "fontSize"
#define KEY_PAGE_DETAILS            "pageDetails"
#define KEY_PAGE_DETAILS_FIXED      "pageDetailsFixed"
#define KEY_TURN_PAGE_BY_TAP        "turnPageByTap"
#define KEY_SAMPLE_BOOK_COPIED      "sampleBookCopied"
#define KEY_CURRENT_BOOK            "currentBook"
#define KEY_CURRENT_FOLDER          "currentFolder"
#define KEY_REMOVABLE_ROOT          "removableRoot"
#define KEY_INVERT_COLORS           "invertColors"
#define KEY_KEEP_DISPLAY_ON         "keepDisplayOn"
#define KEY_VOLUME_UP_ACTION        "volumeUpAction"
#define KEY_VOLUME_DOWN_ACTION      "volumeDownAction"
#define KEY_ORIENTATION             "orientation"

#define DEFAULT_FONT_SIZE           0
#define DEFAULT_PAGE_DETAILS        0
#define DEFAULT_PAGE_DETAILS_FIXED  false
#define DEFAULT_TURN_PAGE_BY_TAP    false
#define DEFAULT_SAMPLE_BOOK_COPIED  false
#define DEFAULT_CURRENT_BOOK        QString()
#define DEFAULT_CURRENT_FOLDER      QString()
#define DEFAULT_REMOVABLE_ROOT      "Books"
#define DEFAULT_INVERT_COLORS       false
#define DEFAULT_KEEP_DISPLAY_ON     false
#define DEFAULT_VOLUME_UP_ACTION    (BooksSettings::ActionNextPage)
#define DEFAULT_VOLUME_DOWN_ACTION  (BooksSettings::ActionPreviousPage)
#define DEFAULT_ORIENTATION         (BooksSettings::OrientationAny)

#define PAGETOOL_COLOR                      QColor(128,128,128) // any bg
#define NORMAL_PAGETOOL_HIGHLIGHT_COLOR     QColor(64,64,64)    // on white
#define INVERTED_PAGETOOL_HIGHLIGHT_COLOR   QColor(192,192,192) // on black

// ==========================================================================
// BooksSettings::TextStyle
// ==========================================================================

class BooksSettings::TextStyle : public ZLTextStyle
{
public:
    TextStyle(int aFontSizeModifier) :
        iDefaultStyle(BooksTextStyle::defaults()),
        iFontSize(iDefaultStyle->fontSize() + 2*aFontSizeModifier)
        { HDEBUG(iFontSize); }

    bool isDecorated() const;

    const std::vector<std::string> &fontFamilies() const;

    int fontSize() const;
    bool bold() const;
    bool italic() const;

    const std::string &colorStyle() const;

    short spaceBefore(const ZLTextStyleEntry::Metrics& aMetrics) const;
    short spaceAfter(const ZLTextStyleEntry::Metrics& aMetrics) const;
    short lineStartIndent(const ZLTextStyleEntry::Metrics& aMetrics, bool aRtl) const;
    short lineEndIndent(const ZLTextStyleEntry::Metrics& aMetrics, bool aRtl) const;
    short firstLineIndentDelta(const ZLTextStyleEntry::Metrics& aMetrics) const;
    int verticalShift() const;

    ZLTextAlignmentType alignment() const;

    double lineSpace() const;
    bool allowHyphenations() const;

private:
    shared_ptr<ZLTextStyle> iDefaultStyle;
    int iFontSize;
};

const std::string&
BooksSettings::TextStyle::colorStyle() const
{
    return iDefaultStyle->colorStyle();
}

bool
BooksSettings::TextStyle::isDecorated() const
{
    return iDefaultStyle->isDecorated();
}

const std::vector<std::string>&
BooksSettings::TextStyle::fontFamilies() const
{
    return iDefaultStyle->fontFamilies();
}

int
BooksSettings::TextStyle::fontSize() const
{
    return iFontSize;
}

bool
BooksSettings::TextStyle::bold() const
{
    return iDefaultStyle->bold();
}

bool
BooksSettings::TextStyle::italic() const
{
    return iDefaultStyle->italic();
}

short
BooksSettings::TextStyle::spaceBefore(
    const ZLTextStyleEntry::Metrics& aMetrics) const
{
    return iDefaultStyle->spaceBefore(aMetrics);
}

short
BooksSettings::TextStyle::spaceAfter(
    const ZLTextStyleEntry::Metrics& aMetrics) const
{
    return iDefaultStyle->spaceAfter(aMetrics);
}

short
BooksSettings::TextStyle::lineStartIndent(
    const ZLTextStyleEntry::Metrics& aMetrics,
    bool aRtl) const
{
    return iDefaultStyle->lineStartIndent(aMetrics, aRtl);
}

short
BooksSettings::TextStyle::lineEndIndent(
    const ZLTextStyleEntry::Metrics& aMetrics,
    bool aRtl) const
{
    return iDefaultStyle->lineEndIndent(aMetrics, aRtl);
}

short
BooksSettings::TextStyle::firstLineIndentDelta(
    const ZLTextStyleEntry::Metrics& aMetrics) const
{
    return iDefaultStyle->firstLineIndentDelta(aMetrics);
}

int
BooksSettings::TextStyle::verticalShift() const
{
    return iDefaultStyle->verticalShift();
}

ZLTextAlignmentType
BooksSettings::TextStyle::alignment() const
{
    return iDefaultStyle->alignment();
}

double
BooksSettings::TextStyle::lineSpace() const
{
    return iDefaultStyle->lineSpace();
}

bool
BooksSettings::TextStyle::allowHyphenations() const
{
    return iDefaultStyle->allowHyphenations();
}

// ==========================================================================
// BooksSettings::Private
// ==========================================================================

class BooksSettings::Private : public QObject {
    Q_OBJECT
public:
    Private(BooksSettings* aParent);

    bool updateCurrentBook();
    bool updateCurrentStorage();
    int currentFontSize() const;
    int fontSize(int aFontSizeAdjust) const;
    QString currentFolder() const;
    shared_ptr<ZLTextStyle> textStyle(int aFontSizeAdjust) const;
    void setCurrentBook(QObject* aBook);
    static Action getAction(MGConfItem* aItem, Action aDefault);

private Q_SLOTS:
    void onFontSizeValueChanged();
    void onCurrentBookPathChanged();
    void onCurrentFolderChanged();

public:
    static QWeakPointer<BooksSettings> sSharedInstance;
    BooksSettings* iParent;
    MGConfItem* iFontSizeConf;
    MGConfItem* iPageDetailsConf;
    MGConfItem* iPageDetailsFixedConf;
    MGConfItem* iTurnPageByTapConf;
    MGConfItem* iInvertColorsConf;
    MGConfItem* iSampleBookCopiedConf;
    MGConfItem* iKeepDisplayOnConf;
    MGConfItem* iVolumeUpActionConf;
    MGConfItem* iVolumeDownActionConf;
    MGConfItem* iCurrentFolderConf;
    MGConfItem* iCurrentBookPathConf;
    MGConfItem* iOrientationConf;
    MGConfItem* iRemovableRootConf;
    mutable shared_ptr<ZLTextStyle> iTextStyle[FontSizeSteps+1];
    BooksBook* iCurrentBook;
    QString iCurrentStorageDevice;
    int iFontSize;
};

QWeakPointer<BooksSettings> BooksSettings::Private::sSharedInstance;

BooksSettings::Private::Private(BooksSettings* aParent) :
    QObject(aParent),
    iParent(aParent),
    iFontSizeConf(new MGConfItem(DCONF_PATH KEY_FONT_SIZE, this)),
    iPageDetailsConf(new MGConfItem(DCONF_PATH KEY_PAGE_DETAILS, this)),
    iPageDetailsFixedConf(new MGConfItem(DCONF_PATH KEY_PAGE_DETAILS_FIXED, this)),
    iTurnPageByTapConf(new MGConfItem(DCONF_PATH KEY_TURN_PAGE_BY_TAP, this)),
    iInvertColorsConf(new MGConfItem(DCONF_PATH KEY_INVERT_COLORS, this)),
    iSampleBookCopiedConf(new MGConfItem(DCONF_PATH KEY_SAMPLE_BOOK_COPIED, this)),
    iKeepDisplayOnConf(new MGConfItem(DCONF_PATH KEY_KEEP_DISPLAY_ON, this)),
    iVolumeUpActionConf(new MGConfItem(DCONF_PATH KEY_VOLUME_UP_ACTION, this)),
    iVolumeDownActionConf(new MGConfItem(DCONF_PATH KEY_VOLUME_DOWN_ACTION, this)),
    iCurrentFolderConf(new MGConfItem(DCONF_PATH KEY_CURRENT_FOLDER, this)),
    iCurrentBookPathConf(new MGConfItem(DCONF_PATH KEY_CURRENT_BOOK, this)),
    iOrientationConf(new MGConfItem(DCONF_PATH KEY_ORIENTATION, this)),
    iRemovableRootConf(new MGConfItem(DCONF_PATH KEY_REMOVABLE_ROOT, this)),
    iCurrentBook(NULL)
{
    iFontSize = currentFontSize();
    connect(iFontSizeConf, SIGNAL(valueChanged()), SLOT(onFontSizeValueChanged()));
    connect(iCurrentFolderConf, SIGNAL(valueChanged()), SLOT(onCurrentFolderChanged()));
    connect(iCurrentBookPathConf, SIGNAL(valueChanged()), SLOT(onCurrentBookPathChanged()));
    connect(iPageDetailsConf, SIGNAL(valueChanged()), iParent, SIGNAL(pageDetailsChanged()));
    connect(iPageDetailsFixedConf, SIGNAL(valueChanged()), iParent, SIGNAL(pageDetailsFixedChanged()));
    connect(iTurnPageByTapConf, SIGNAL(valueChanged()), iParent, SIGNAL(turnPageByTapChanged()));
    connect(iInvertColorsConf, SIGNAL(valueChanged()), iParent, SIGNAL(invertColorsChanged()));
    connect(iInvertColorsConf, SIGNAL(valueChanged()), iParent, SIGNAL(pageBackgroundColorChanged()));
    connect(iSampleBookCopiedConf, SIGNAL(valueChanged()), iParent, SIGNAL(sampleBookCopiedChanged()));
    connect(iKeepDisplayOnConf, SIGNAL(valueChanged()), iParent, SIGNAL(keepDisplayOnChanged()));
    connect(iVolumeUpActionConf, SIGNAL(valueChanged()), iParent, SIGNAL(volumeUpActionChanged()));
    connect(iVolumeDownActionConf, SIGNAL(valueChanged()), iParent, SIGNAL(volumeDownActionChanged()));
    connect(iOrientationConf, SIGNAL(valueChanged()), iParent, SIGNAL(orientationChanged()));
    connect(iRemovableRootConf, SIGNAL(valueChanged()), iParent, SIGNAL(removableRootChanged()));
}

int
BooksSettings::Private::currentFontSize() const
{
    const int fontSize = iFontSizeConf->value(DEFAULT_FONT_SIZE).toInt();
    if (fontSize < MinFontSize) {
        return MinFontSize;
    } else if (fontSize > MaxFontSize) {
        return MaxFontSize;
    } else {
        return fontSize;
    }
}

int
BooksSettings::Private::fontSize(
    int aFontSizeAdjust) const
{
    const int fontSize = iFontSize + aFontSizeAdjust;
    if (fontSize < MinFontSize) {
        return MinFontSize;
    } else if (fontSize > MaxFontSize) {
        return MaxFontSize;
    } else {
        return fontSize;
    }
}

shared_ptr<ZLTextStyle>
BooksSettings::Private::textStyle(
    int aFontSizeAdjust) const
{
    const int size = fontSize(aFontSizeAdjust);
    const int i = size - MinFontSize;
    shared_ptr<ZLTextStyle> style = iTextStyle[i];
    if (style.isNull()) {
        style = new TextStyle(size);
        iTextStyle[i] = style;
    }
    return style;
}

QString
BooksSettings::Private::currentFolder() const
{
    return iCurrentFolderConf->value(DEFAULT_CURRENT_FOLDER).toString();
}

void
BooksSettings::Private::setCurrentBook(
    QObject* aBook)
{
    BooksBook* book = qobject_cast<BooksBook*>(aBook);
    if (iCurrentBook != book) {
        if (iCurrentBook) iCurrentBook->release();
        if (book) {
            HDEBUG(book->path());
            (iCurrentBook = book)->retain();
            iCurrentBookPathConf->set(book->path());
        } else {
            iCurrentBook = NULL;
            iCurrentBookPathConf->set(QString());
        }
        Q_EMIT iParent->currentBookChanged();
    }
}

bool
BooksSettings::Private::updateCurrentBook()
{
    QString path = iCurrentBookPathConf->value(DEFAULT_CURRENT_BOOK).toString();
    if (path.isEmpty()) {
        if (iCurrentBook) {
            iCurrentBook->release();
            iCurrentBook = NULL;
            return true;
        }
    } else if (!iCurrentBook || iCurrentBook->path() != path) {
        shared_ptr<Book> book = BooksUtil::bookFromFile(path);
        if (!book.isNull()) {
            QString rel;
            QFileInfo info(path);
            BooksStorageManager* mgr = BooksStorageManager::instance();
            BooksStorage storage = mgr->storageForPath(info.path(), &rel);
            if (storage.isValid()) {
                if (iCurrentBook) iCurrentBook->release();
                iCurrentBook = new BooksBook(storage, rel, book);
                iCurrentBook->requestCoverImage();
                return true;
            }
        }
        if (iCurrentBook) {
            iCurrentBook->release();
            iCurrentBook = NULL;
            return true;
        }
    }
    return false;
}

bool
BooksSettings::Private::updateCurrentStorage()
{
    BooksStorageManager* mgr = BooksStorageManager::instance();
    BooksStorage storage = mgr->storageForPath(currentFolder());
    if (storage.isValid() && storage.device() != iCurrentStorageDevice) {
        iCurrentStorageDevice = storage.device();
        return true;
    }
    return false;
}

void
BooksSettings::Private::onFontSizeValueChanged()
{
    const int newSize = currentFontSize();
    HDEBUG(newSize);
    if (iFontSize != newSize) {
        iFontSize = newSize;
        for (int i=0; i<=FontSizeSteps; i++) {
            iTextStyle[i].reset();
        }
        Q_EMIT iParent->fontSizeChanged();
        Q_EMIT iParent->textStyleChanged();
    }
}

void
BooksSettings::Private::onCurrentFolderChanged()
{
    if (updateCurrentStorage()) {
        Q_EMIT iParent->currentStorageChanged();
    }
    Q_EMIT iParent->currentFolderChanged();
    Q_EMIT iParent->relativePathChanged();
}

void
BooksSettings::Private::onCurrentBookPathChanged()
{
    if (updateCurrentBook()) {
        Q_EMIT iParent->currentBookChanged();
    }
}

BooksSettings::Action
BooksSettings::Private::getAction(
    MGConfItem* aItem,
    Action aDefault)
{
    // Need to cast int to enum right away to force "enumeration value not
    // handled in switch" warning if we miss one of the actions:
    Action value = (Action)aItem->value(aDefault).toInt();
    switch (value) {
    case ActionNone:
    case ActionPreviousPage:
    case ActionNextPage:
        return value;
    }
    return aDefault;
}

// ==========================================================================
// BooksSettings
// ==========================================================================

BooksSettings::BooksSettings(QObject* aParent) :
    QObject(aParent),
    iPrivate(new Private(this))
{
}

QSharedPointer<BooksSettings>
BooksSettings::sharedInstance()
{
    QSharedPointer<BooksSettings> instance = Private::sSharedInstance;
    if (instance.isNull()) {
        // QObject::deleteLater protects against trouble in case if the
        // recipient of the signal drops the last shared reference.
        instance = QSharedPointer<BooksSettings>(new BooksSettings, &QObject::deleteLater);
        Private::sSharedInstance = instance;
        // Finish initialization. These invoke BooksStorageManager::instance()
        // which in turn calls BooksSettings::sharedInstance() to call
        // removableRoot(). Now that Private::sSharedInstance is set, it
        // won't cause infinite recursion although the returned BooksSettings
        // object will be slightly under-initialized, so to speak. But that's
        // ok as long as BooksStorageManager::instance() doesn't need anything
        // from BooksSettings other than removableRoot()
        instance->iPrivate->updateCurrentBook();
        instance->iPrivate->updateCurrentStorage();
    }
    return instance;
}

bool
BooksSettings::increaseFontSize()
{
    if (iPrivate->iFontSize < MaxFontSize) {
        setFontSize(iPrivate->iFontSize+1);
        return true;
    } else {
        return false;
    }
}

bool
BooksSettings::decreaseFontSize()
{
    if (iPrivate->iFontSize > MinFontSize) {
        setFontSize(iPrivate->iFontSize-1);
        return true;
    } else {
        return false;
    }
}

void
BooksSettings::setFontSize(
    int aValue)
{
    HDEBUG(aValue);
    iPrivate->iFontSizeConf->set(aValue);
}

int
BooksSettings::fontSize() const
{
    return iPrivate->iFontSize;
}

QString
BooksSettings::currentStorage() const
{
    return iPrivate->iCurrentStorageDevice;
}

shared_ptr<ZLTextStyle>
BooksSettings::textStyle(
    int aFontSizeAdjust) const
{
    return iPrivate->textStyle(aFontSizeAdjust);
}

int
BooksSettings::pageDetails() const
{
    return iPrivate->iPageDetailsConf->value(DEFAULT_PAGE_DETAILS).toInt();
}

void
BooksSettings::setPageDetails(
    int aValue)
{
    HDEBUG(aValue);
    iPrivate->iPageDetailsConf->set(aValue);
}

bool
BooksSettings::pageDetailsFixed() const
{
    return iPrivate->iPageDetailsFixedConf->value(DEFAULT_PAGE_DETAILS_FIXED).toBool();
}

void
BooksSettings::setPageDetailsFixed(
    bool aValue)
{
    HDEBUG(aValue);
    iPrivate->iPageDetailsFixedConf->set(aValue);
}

bool
BooksSettings::turnPageByTap() const
{
    return iPrivate->iTurnPageByTapConf->value(DEFAULT_TURN_PAGE_BY_TAP).toBool();
}

void
BooksSettings::setTurnPageByTap(
    bool aValue)
{
    HDEBUG(aValue);
    iPrivate->iTurnPageByTapConf->set(aValue);
}

bool
BooksSettings::invertColors() const
{
    return iPrivate->iInvertColorsConf->value(DEFAULT_INVERT_COLORS).toBool();
}

void
BooksSettings::setInvertColors(
    bool aValue)
{
    HDEBUG(aValue);
    iPrivate->iInvertColorsConf->set(aValue);
}

bool
BooksSettings::sampleBookCopied() const
{
    return iPrivate->iSampleBookCopiedConf->value(DEFAULT_SAMPLE_BOOK_COPIED).toBool();
}

void
BooksSettings::setSampleBookCopied()
{
    HDEBUG("");
    iPrivate->iSampleBookCopiedConf->set(true);
}

bool
BooksSettings::keepDisplayOn() const
{
    return iPrivate->iKeepDisplayOnConf->value(DEFAULT_KEEP_DISPLAY_ON).toBool();
}

void
BooksSettings::setKeepDisplayOn(
    bool aValue)
{
    HDEBUG(aValue);
    iPrivate->iKeepDisplayOnConf->set(aValue);
}

BooksSettings::Action
BooksSettings::volumeUpAction() const
{
    return Private::getAction(iPrivate->iVolumeUpActionConf,
        DEFAULT_VOLUME_UP_ACTION);
}

void
BooksSettings::setVolumeUpAction(
    int aValue)
{
    HDEBUG(aValue);
    iPrivate->iVolumeUpActionConf->set(aValue);
}

BooksSettings::Action
BooksSettings::volumeDownAction() const
{
    return Private::getAction(iPrivate->iVolumeDownActionConf,
        DEFAULT_VOLUME_DOWN_ACTION);
}

void
BooksSettings::setVolumeDownAction(
    int aValue)
{
    HDEBUG(aValue);
    iPrivate->iVolumeDownActionConf->set(aValue);
}

QString
BooksSettings::removableRoot() const
{
    return iPrivate->iRemovableRootConf->value(DEFAULT_REMOVABLE_ROOT).toString();
}

QString
BooksSettings::relativePath() const
{
    QString rel;
    BooksStorageManager::instance()->storageForPath(currentFolder(), &rel);
    return rel;
}

QString
BooksSettings::currentFolder() const
{
    return iPrivate->currentFolder();
}

void
BooksSettings::setCurrentFolder(
    QString aValue)
{
    HDEBUG(aValue);
    iPrivate->iCurrentFolderConf->set(aValue);
}

QObject*
BooksSettings::currentBook() const
{
    return iPrivate->iCurrentBook;
}

void
BooksSettings::setCurrentBook(
    QObject* aBook)
{
    iPrivate->setCurrentBook(aBook);
}

QColor
BooksSettings::primaryPageToolColor() const
{
    return PAGETOOL_COLOR;
}

QColor
BooksSettings::highlightPageToolColor() const
{
    return invertColors() ?
        INVERTED_PAGETOOL_HIGHLIGHT_COLOR :
        NORMAL_PAGETOOL_HIGHLIGHT_COLOR;
}

QColor
BooksSettings::pageBackgroundColor() const
{
    return qtColor(invertColors() ?
        BooksTextView::INVERTED_BACKGROUND :
        BooksTextView::DEFAULT_BACKGROUND);
}

BooksSettings::Orientation
BooksSettings::orientation() const
{
    // Need to cast int to enum right away to force "enumeration value not
    // handled in switch" warning if we miss one of the Orientation:
    Orientation value = (Orientation)
        iPrivate->iOrientationConf->value(DEFAULT_ORIENTATION).toInt();
    switch (value) {
    case OrientationAny:
    case OrientationPortrait:
    case OrientationLandscape:
        return value;
    }
    return DEFAULT_ORIENTATION;
}

#include "BooksSettings.moc"