datapaths.cpp

Go to the documentation of this file.

/* ============================================================
* Falkon - Qt web browser
* Copyright (C) 2014-2018 David Rosca <nowrep@gmail.com>
*
* 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 3 of the License, 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.
*
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>.
* ============================================================ */
#include "datapaths.h"
#include "qztools.h"
#include "../config.h"
#include "mainapplication.h"
 
#include <QApplication>
#include <QDir>
 
#include <QStandardPaths>
#include <QTemporaryDir>
 
Q_GLOBAL_STATIC(DataPaths, qz_data_paths)
 
DataPaths::DataPaths()
{
    init();
}
 
DataPaths::~DataPaths()
= default;
 
// static
void DataPaths::setCurrentProfilePath(const QString &profilePath)
{
    qz_data_paths()->initCurrentProfile(profilePath);
}
 
// static
void DataPaths::setPortableVersion()
{
    DataPaths* d = qz_data_paths();
 
    const QString appDir = QCoreApplication::applicationDirPath();
 
    d->m_paths[AppData] = QStringList{appDir};
    d->m_paths[Config] = QStringList{appDir + QSL("/config")};
    d->m_paths[Cache] = QStringList{appDir + QSL("/cache")};
    d->m_paths[Profiles] = QStringList{appDir + QSL("/config/profiles")};
 
    d->m_paths[Themes].clear();
    d->m_paths[Plugins].clear();
    d->initAssetsIn(appDir);
 
    // Make sure Temp path exists
    QDir().mkpath(d->m_paths[Temp].at(0));
}
 
// static
QString DataPaths::path(DataPaths::Path path)
{
    Q_ASSERT(!qz_data_paths()->m_paths[path].isEmpty());
 
    return qz_data_paths()->m_paths[path].at(0);
}
 
// static
QStringList DataPaths::allPaths(DataPaths::Path type)
{
    Q_ASSERT(!qz_data_paths()->m_paths[type].isEmpty());
 
    return qz_data_paths()->m_paths[type];
}
 
// static
QString DataPaths::locate(Path type, const QString &file)
{
    const QStringList dirs = allPaths(type);
    for (const QString &dir : dirs) {
        const QString fullPath = QDir(dir).absoluteFilePath(file);
        if (QFileInfo::exists(fullPath)) {
            return fullPath;
        }
    }
    return {};
}
 
// static
QString DataPaths::currentProfilePath()
{
    return path(CurrentProfile);
}
 
void DataPaths::init()
{
    m_paths[AppData].append(QStandardPaths::standardLocations(QStandardPaths::AppDataLocation));
 
#ifdef FALKON_PLUGIN_PATH
    m_paths[Plugins].append(QStringLiteral(FALKON_PLUGIN_PATH));
#endif
 
    for (const QString &location : std::as_const(m_paths[AppData])) {
        initAssetsIn(location);
    }
 
    if (MainApplication::isTestModeEnabled()) {
        m_paths[Config].append(QDir::tempPath() + QSL("/Falkon-test"));
    } else {
        m_paths[Config].append(QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation));
    }
 
    m_paths[Profiles].append(m_paths[Config].at(0) + QLatin1String("/profiles"));
    // We also allow to load data from Config path
    initAssetsIn(m_paths[Config].at(0));
 
    // If FALKON_PLUGIN_PATH is set, only load plugins from there
    const QByteArray pluginPath = qgetenv("FALKON_PLUGIN_PATH");
    if (!pluginPath.isNull()) {
        m_paths[Plugins] = QStringList{QString::fromLocal8Bit(pluginPath)};
    }
 
    m_tmpdir.reset(new QTemporaryDir());
    m_paths[Temp].append(m_tmpdir->path());
    if (!m_tmpdir->isValid()) {
        qWarning() << "Failed to create temporary directory" << m_tmpdir->path();
    }
 
    m_paths[Cache].append(QStandardPaths::writableLocation(QStandardPaths::CacheLocation));
}
 
void DataPaths::initCurrentProfile(const QString &profilePath)
{
    m_paths[CurrentProfile].append(profilePath);
 
    if (m_paths[Cache].isEmpty())
        m_paths[Cache].append(m_paths[CurrentProfile].at(0) + QLatin1String("/cache"));
 
    if (m_paths[Sessions].isEmpty())
        m_paths[Sessions].append(m_paths[CurrentProfile].at(0) + QLatin1String("/sessions"));
 
    QDir dir;
    dir.mkpath(m_paths[Cache].at(0));
    dir.mkpath(m_paths[Sessions].at(0));
}
 
void DataPaths::initAssetsIn(const QString &path)
{
    m_paths[Themes].append(path + QLatin1String("/themes"));
    m_paths[Plugins].append(path + QLatin1String("/plugins"));
}