[browserpaths] Move directory functions to dedicated module. Fixes JB…

…#32547

common/browserpaths.cpp

@@ -0,0 +1,53 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Jolla Ltd.
+** Contact: Dmitry Rozhkov <dmitry.rozhkov@jolla.com>
+**
+****************************************************************************/
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include <QString>
+#include <QDir>
+#include <QStandardPaths>
+#include "browserpaths.h"
+
+static QString getLocation(QStandardPaths::StandardLocation locationType) {
+    QString location(QStandardPaths::writableLocation(locationType));
+    QDir dir(location);
+    if (!dir.exists()) {
+        if (!dir.mkpath(location)) {
+            qWarning(QString("Can't create directory ").append(location).toLatin1().data()) ;
+            return QString();
+        }
+    }
+
+    return location;
+}
+
+QString BrowserPaths::downloadLocation()
+{
+    return getLocation(QStandardPaths::DownloadLocation);
+}
+
+QString BrowserPaths::picturesLocation()
+{
+    return getLocation(QStandardPaths::PicturesLocation);
+}
+
+QString BrowserPaths::dataLocation()
+{
+    return getLocation(QStandardPaths::DataLocation);
+}
+
+QString BrowserPaths::applicationsLocation()
+{
+    return getLocation(QStandardPaths::ApplicationsLocation);
+}
+
+QString BrowserPaths::cacheLocation()
+{
+    return getLocation(QStandardPaths::CacheLocation);
+}

common/browserpaths.h

@@ -0,0 +1,26 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Jolla Ltd.
+** Contact: Dmitry Rozhkov <dmitry.rozhkov@jolla.com>
+**
+****************************************************************************/
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef BROWSERPATHS_H
+#define BROWSERPATHS_H
+
+class QString;
+
+struct BrowserPaths
+{
+    static QString downloadLocation();
+    static QString picturesLocation();
+    static QString dataLocation();
+    static QString applicationsLocation();
+    static QString cacheLocation();
+};
+
+#endif // BROWSERPATHS_H

common/opensearchconfigs.cpp

@@ -12,7 +12,6 @@
 
 #include <QDir>
 #include <QFile>
-#include <QStandardPaths>
 #include <QXmlStreamReader>
 #include "opensearchconfigs.h"
 

common/paths.pri

@@ -0,0 +1,9 @@
+INCLUDEPATH += $$PWD
+
+# C++ sources
+SOURCES += \
+    $$PWD/browserpaths.cpp \
+
+# C++ headers
+HEADERS += \
+    $$PWD/browserpaths.h \

settings/settings.pro

@@ -12,7 +12,7 @@ import.files = qmldir
 import.path = $$TARGETPATH
 target.path = $$TARGETPATH
 
-include(../common/common.pri)
+include(../common/opensearchconfigs.pri)
 
 SOURCES += \
         declarative_plugin.cpp \

src/bookmarks/bookmarkmanager.cpp

@@ -11,8 +11,6 @@
 
 #include "bookmarkmanager.h"
 #include <QDebug>
-#include <QStandardPaths>
-#include <QDir>
 #include <QFile>
 #include <QTextStream>
 #include <QJsonObject>
@@ -22,6 +20,7 @@
 #include <MGConfItem>
 
 #include "bookmark.h"
+#include "browserpaths.h"
 
 BookmarkManager::BookmarkManager()
   : QObject(nullptr)
@@ -46,13 +45,9 @@ BookmarkManager* BookmarkManager::instance()
 
 void BookmarkManager::save(const QList<Bookmark*> & bookmarks)
 {
-    QString dataLocation = QStandardPaths::writableLocation(QStandardPaths::DataLocation);
-    QDir dir(dataLocation);
-    if (!dir.exists()) {
-        if (!dir.mkpath(dataLocation)) {
-            qWarning() << "Can't create directory " << dataLocation;
-            return;
-        }
+    QString dataLocation = BrowserPaths::dataLocation();
+    if (dataLocation.isNull()) {
+        return;
     }
     QString path = dataLocation + "/bookmarks.json";
     QFile file(path);
@@ -85,7 +80,7 @@ void BookmarkManager::clear()
 
 QList<Bookmark*> BookmarkManager::load() {
     QList<Bookmark*> bookmarks;
-    QString bookmarkFile = QStandardPaths::writableLocation(QStandardPaths::DataLocation) + "/bookmarks.json";
+    QString bookmarkFile = BrowserPaths::dataLocation() + "/bookmarks.json";
     QScopedPointer<QFile> file(new QFile(bookmarkFile));
 
     if (!file->open(QIODevice::ReadOnly | QIODevice::Text)) {

src/bookmarks/desktopbookmarkwriter.cpp

@@ -9,12 +9,12 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-#include "desktopbookmarkwriter.h"
-
 #include <QDir>
-#include <QStandardPaths>
 #include <QtConcurrent>
 
+#include "desktopbookmarkwriter.h"
+#include "browserpaths.h"
+
 static bool dbw_testMode = false;
 
 DesktopBookmarkWriter::DesktopBookmarkWriter(QObject *parent)
@@ -64,9 +64,9 @@ QString DesktopBookmarkWriter::uniqueDesktopFileName(QString title)
 {
     QString filePath;
     if (!isTestModeEnabled()) {
-        filePath = QStandardPaths::writableLocation(QStandardPaths::ApplicationsLocation);
+        filePath = BrowserPaths::applicationsLocation();
     } else {
-        filePath = QStandardPaths::writableLocation(QStandardPaths::DataLocation);
+        filePath = BrowserPaths::dataLocation();
     }
     title = title.simplified().replace(QString(" "), QString("-"));
 

src/core/core.pri

@@ -1,7 +1,5 @@
 INCLUDEPATH += $$PWD
 
-include(../../common/common.pri)
-
 # C++ sources
 SOURCES += \
     $$PWD/declarativewebcontainer.cpp \

src/core/declarativewebcontainer.cpp

@@ -17,13 +17,12 @@
 #include "downloadmanager.h"
 #include "declarativewebutils.h"
 #include "webpagefactory.h"
+#include "browserpaths.h"
 
 #include <QPointer>
 #include <QTimerEvent>
 #include <QQuickWindow>
-#include <QDir>
 #include <QTransform>
-#include <QStandardPaths>
 #include <QtConcurrentRun>
 #include <QGuiApplication>
 #include <QScreen>
@@ -93,10 +92,8 @@ DeclarativeWebContainer::DeclarativeWebContainer(QWindow *parent)
     connect(QMozContext::GetInstance(), SIGNAL(onInitialized()), this, SLOT(initialize()));
     connect(this, SIGNAL(portraitChanged()), this, SLOT(resetHeight()));
 
-    QString cacheLocation = QStandardPaths::writableLocation(QStandardPaths::CacheLocation);
-    QDir dir(cacheLocation);
-    if(!dir.exists() && !dir.mkpath(cacheLocation)) {
-        qWarning() << "Can't create directory "+ cacheLocation;
+    QString cacheLocation = BrowserPaths::cacheLocation();
+    if (cacheLocation.isNull()) {
         return;
     }
 

src/declarativewebutils.cpp

@@ -31,6 +31,7 @@
 #include "declarativewebutils.h"
 #include "qmozcontext.h"
 #include "opensearchconfigs.h"
+#include "browserpaths.h"
 
 static const QString gSystemComponentsTimeStamp("/var/lib/_MOZEMBED_CACHE_CLEAN_");
 static const QString gProfilePath("/.mozilla/mozembed");
@@ -76,7 +77,7 @@ DeclarativeWebUtils::DeclarativeWebUtils()
     connect(QMozContext::GetInstance(), SIGNAL(recvObserve(QString, QVariant)),
             this, SLOT(handleObserve(QString, QVariant)));
 
-    QString path = QStandardPaths::writableLocation(QStandardPaths::DataLocation) + QStringLiteral("/.firstUseDone");
+    QString path = BrowserPaths::dataLocation() + QStringLiteral("/.firstUseDone");
     m_firstUseDone = fileExists(path);
 
     connect(&m_homePage, SIGNAL(valueChanged()), this, SIGNAL(homePageChanged()));
@@ -158,7 +159,7 @@ void DeclarativeWebUtils::updateWebEngineSettings()
     // see https://developer.mozilla.org/en-US/docs/Download_Manager_preferences
     // Use custom downloads location defined in browser.download.dir
     mozContext->setPref(QString("browser.download.folderList"), QVariant(2));
-    mozContext->setPref(QString("browser.download.dir"), downloadDir());
+    mozContext->setPref(QString("browser.download.dir"), BrowserPaths::downloadLocation());
     // Downloads should never be removed automatically
     mozContext->setPref(QString("browser.download.manager.retention"), QVariant(2));
     // Downloads will be canceled on quit
@@ -212,7 +213,7 @@ void DeclarativeWebUtils::updateWebEngineSettings()
 }
 
 void DeclarativeWebUtils::setFirstUseDone(bool firstUseDone) {
-    QString path = QStandardPaths::writableLocation(QStandardPaths::DataLocation) + QStringLiteral("/.firstUseDone");
+    QString path = BrowserPaths::dataLocation() + QStringLiteral("/.firstUseDone");
     if (m_firstUseDone != firstUseDone) {
         m_firstUseDone = firstUseDone;
         if (!firstUseDone) {
@@ -359,14 +360,9 @@ DeclarativeWebUtils *DeclarativeWebUtils::instance()
     return gSingleton;
 }
 
-QString DeclarativeWebUtils::downloadDir() const
-{
-    return QStandardPaths::writableLocation(QStandardPaths::DownloadLocation);
-}
-
 QString DeclarativeWebUtils::picturesDir() const
 {
-    return QStandardPaths::writableLocation(QStandardPaths::PicturesLocation);
+    return BrowserPaths::picturesLocation();
 }
 
 QString DeclarativeWebUtils::displayableUrl(QString fullUrl) const

src/declarativewebutils.h

@@ -25,7 +25,6 @@ class DeclarativeWebUtils : public QObject
     Q_OBJECT
 
     Q_PROPERTY(QString homePage READ homePage NOTIFY homePageChanged FINAL)
-    Q_PROPERTY(QString downloadDir READ downloadDir CONSTANT FINAL)
     Q_PROPERTY(QString picturesDir READ picturesDir CONSTANT FINAL)
     Q_PROPERTY(bool firstUseDone READ firstUseDone WRITE setFirstUseDone NOTIFY firstUseDoneChanged)
     Q_PROPERTY(bool debugMode READ debugMode CONSTANT FINAL)
@@ -40,7 +39,6 @@ class DeclarativeWebUtils : public QObject
 public:
     static DeclarativeWebUtils *instance();
 
-    QString downloadDir() const;
     QString picturesDir() const;
     bool firstUseDone() const;
     void setFirstUseDone(bool firstUseDone);

src/downloadmanager.cpp

@@ -11,7 +11,7 @@
 
 #include "downloadmanager.h"
 #include "qmozcontext.h"
-#include "declarativewebutils.h"
+#include "browserpaths.h"
 
 #include <transferengineinterface.h>
 #include <transfertypes.h>
@@ -129,7 +129,7 @@ void DownloadManager::recvObserve(const QString message, const QVariant data)
 
 bool DownloadManager::moveMyAppPackage(QString path)
 {
-    QString aptoideDownloadPath = QString("%1/.aptoide/").arg(DeclarativeWebUtils::instance()->downloadDir());
+    QString aptoideDownloadPath = QString("%1/.aptoide/").arg(BrowserPaths::downloadLocation());
     QDir dir(aptoideDownloadPath);
 
     if (!dir.exists()) {

src/qtmozembed/declarativewebpage.cpp

@@ -12,9 +12,9 @@
 #include "declarativewebpage.h"
 #include "declarativewebcontainer.h"
 #include "dbmanager.h"
+#include "browserpaths.h"
 
 #include <QtConcurrent>
-#include <QStandardPaths>
 
 static const QString gFullScreenMessage("embed:fullscreenchanged");
 static const QString gDomContentLoadedMessage("embed:domcontentloaded");
@@ -333,7 +333,7 @@ QString DeclarativeWebPage::saveToFile(QImage image)
     }
 
     // 75% quality jpg produces small and good enough capture.
-    QString path = QString("%1/tab-%2-thumb.jpg").arg(QStandardPaths::writableLocation(QStandardPaths::CacheLocation)).arg(tabId());
+    QString path = QString("%1/tab-%2-thumb.jpg").arg(BrowserPaths::cacheLocation()).arg(tabId());
     return !allBlack(image) && image.save(path, "jpg", 75) ? path : "";
 }
 

src/src.pro

@@ -46,6 +46,8 @@ EE_QM = $$OUT_PWD/sailfish-browser_eng_en.qm
 include(../translations/translations.pri)
 
 include(../defaults.pri)
+include(../common/opensearchconfigs.pri)
+include(../common/paths.pri)
 include(core/core.pri)
 include(history/history.pri)
 include(bookmarks/bookmarks.pri)

src/storage/dbworker.cpp

@@ -9,8 +9,6 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-#include "dbworker.h"
-
 #include <QSqlError>
 #include <QSqlQuery>
 #include <QSqlRecord>
@@ -22,6 +20,9 @@
 #include <QFile>
 #include <QDateTime>
 
+#include "dbworker.h"
+#include "browserpaths.h"
+
 #ifndef DEBUG_LOGS
 #define DEBUG_LOGS 0
 #endif
@@ -86,14 +87,12 @@ DBWorker::DBWorker(QObject *parent) :
 
 void DBWorker::init()
 {
-    QString databaseDir = QStandardPaths::writableLocation(QStandardPaths::DataLocation);
-    const QString dbFileName = QLatin1String(DB_NAME);
-    QDir dir(databaseDir);
-
-    if(!dir.mkpath(databaseDir)) {
-        qWarning() << "Can't create directory "+ databaseDir;
+    QString databaseDir = BrowserPaths::dataLocation();
+    if (databaseDir.isNull()) {
         return;
     }
+    QDir dir(databaseDir);
+    const QString dbFileName(QLatin1String(DB_NAME));
 
     m_database = QSqlDatabase::addDatabase("QSQLITE");
     m_database.setDatabaseName(dir.absoluteFilePath(dbFileName));

tests/auto/mocks/declarativewebutils/declarativewebutils.cpp

@@ -85,8 +85,3 @@ DeclarativeWebUtils *DeclarativeWebUtils::instance()
     return gSingleton;
 }
 
-QString DeclarativeWebUtils::downloadDir() const
-{
-    QString dir;
-    return dir;
-}

tests/auto/mocks/declarativewebutils/declarativewebutils.h

@@ -35,7 +35,6 @@ class DeclarativeWebUtils : public QObject
     bool firstUseDone() const;
     void setFirstUseDone(bool firstUseDone);
     qreal silicaPixelRatio() const;
-    QString downloadDir() const;
 
 signals:
     void homePageChanged();