src/base/profile_p.cpp

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2016  Eugene Shalygin <eugene.shalygin@gmail.com>
   4  * Copyright (C) 2012  Christophe Dumez
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  *
  20  * In addition, as a special exception, the copyright holders give permission to
  21  * link this program with the OpenSSL project's "OpenSSL" library (or with
  22  * modified versions of it that use the same license as the "OpenSSL" library),
  23  * and distribute the linked executables. You must obey the GNU General Public
  24  * License in all respects for all of the code used other than "OpenSSL".  If you
  25  * modify file(s), you may extend this exception to your version of the file(s),
  26  * but you are not obligated to do so. If you do not wish to do so, delete this
  27  * exception statement from your version.
  28  */
  29
  30 #include "profile_p.h"
  31
  32 #include <QCoreApplication>
  33
  34 #include "base/global.h"
  35 #include "base/utils/fs.h"
  36
  37 Private::Profile::Profile(const QString &configurationName)
  38     : m_configurationName {configurationName}
  39 {
  40 }
  41
  42 QString Private::Profile::configurationName() const
  43 {
  44     return m_configurationName;
  45 }
  46
  47 QString Private::Profile::configurationSuffix() const
  48 {
  49     return (m_configurationName.isEmpty() ? QString() : (u'_' + m_configurationName));
  50 }
  51
  52 QString Private::Profile::profileName() const
  53 {
  54     return QCoreApplication::applicationName() + configurationSuffix();
  55 }
  56
  57 Private::DefaultProfile::DefaultProfile(const QString &configurationName)
  58     : Profile {configurationName}
  59 {
  60 }
  61
  62 Path Private::DefaultProfile::rootPath() const
  63 {
  64     return {};
  65 }
  66
  67 Path Private::DefaultProfile::basePath() const
  68 {
  69     return Utils::Fs::homePath();
  70 }
  71
  72 Path Private::DefaultProfile::cacheLocation() const
  73 {
  74     return locationWithConfigurationName(QStandardPaths::CacheLocation);
  75 }
  76
  77 Path Private::DefaultProfile::configLocation() const
  78 {
  79 #if defined(Q_OS_WIN)
  80     // On Windows QSettings stores files in FOLDERID_RoamingAppData\AppName
  81     return locationWithConfigurationName(QStandardPaths::AppDataLocation);
  82 #else
  83     return locationWithConfigurationName(QStandardPaths::AppConfigLocation);
  84 #endif
  85 }
  86
  87 Path Private::DefaultProfile::dataLocation() const
  88 {
  89 #if defined(Q_OS_WIN) || defined (Q_OS_MACOS)
  90     return locationWithConfigurationName(QStandardPaths::AppLocalDataLocation);
  91 #else
  92     // On Linux keep using the legacy directory ~/.local/share/data/ if it exists
  93     const Path genericDataPath {QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation)};
  94     const Path profilePath {profileName()};
  95     const Path legacyDir = genericDataPath / Path(u"data"_s) / profilePath;
  96
  97     const Path dataDir = genericDataPath / profilePath;
  98
  99     if (!dataDir.exists() && legacyDir.exists())
 100     {
 101         qWarning("The legacy data directory '%s' is used. It is recommended to move its content to '%s'",
 102             qUtf8Printable(legacyDir.toString()), qUtf8Printable(dataDir.toString()));
 103
 104         return legacyDir;
 105     }
 106
 107     return dataDir;
 108 #endif
 109 }
 110
 111 Path Private::DefaultProfile::downloadLocation() const
 112 {
 113     return Path(QStandardPaths::writableLocation(QStandardPaths::DownloadLocation));
 114 }
 115
 116 std::unique_ptr<QSettings> Private::DefaultProfile::applicationSettings(const QString &name) const
 117 {
 118 #if defined(Q_OS_WIN) || defined(Q_OS_MACOS)
 119     return std::make_unique<QSettings>(QSettings::IniFormat, QSettings::UserScope, profileName(), name);
 120 #else
 121     return std::make_unique<QSettings>(profileName(), name);
 122 #endif
 123 }
 124
 125 Path Private::DefaultProfile::locationWithConfigurationName(const QStandardPaths::StandardLocation location) const
 126 {
 127     return Path(QStandardPaths::writableLocation(location) + configurationSuffix());
 128 }
 129
 130 Private::CustomProfile::CustomProfile(const Path &rootPath, const QString &configurationName)
 131     : Profile {configurationName}
 132     , m_rootPath {rootPath}
 133     , m_basePath {m_rootPath / Path(profileName())}
 134     , m_cacheLocation {m_basePath / Path(u"cache"_s)}
 135     , m_configLocation {m_basePath / Path(u"config"_s)}
 136     , m_dataLocation {m_basePath / Path(u"data"_s)}
 137     , m_downloadLocation {m_basePath / Path(u"downloads"_s)}
 138 {
 139 }
 140
 141 Path Private::CustomProfile::rootPath() const
 142 {
 143     return m_rootPath;
 144 }
 145
 146 Path Private::CustomProfile::basePath() const
 147 {
 148     return m_basePath;
 149 }
 150
 151 Path Private::CustomProfile::cacheLocation() const
 152 {
 153     return m_cacheLocation;
 154 }
 155
 156 Path Private::CustomProfile::configLocation() const
 157 {
 158     return m_configLocation;
 159 }
 160
 161 Path Private::CustomProfile::dataLocation() const
 162 {
 163     return m_dataLocation;
 164 }
 165
 166 Path Private::CustomProfile::downloadLocation() const
 167 {
 168     return m_downloadLocation;
 169 }
 170
 171 std::unique_ptr<QSettings> Private::CustomProfile::applicationSettings(const QString &name) const
 172 {
 173     // here we force QSettings::IniFormat format always because we need it to be portable across platforms
 174 #if defined(Q_OS_WIN) || defined(Q_OS_MACOS)
 175     const auto CONF_FILE_EXTENSION = u".ini"_s;
 176 #else
 177     const auto CONF_FILE_EXTENSION = u".conf"_s;
 178 #endif
 179     const Path settingsFilePath = configLocation() / Path(name + CONF_FILE_EXTENSION);
 180     return std::make_unique<QSettings>(settingsFilePath.data(), QSettings::IniFormat);
 181 }
 182
 183 Path Private::NoConvertConverter::fromPortablePath(const Path &portablePath) const
 184 {
 185     return portablePath;
 186 }
 187
 188 Path Private::NoConvertConverter::toPortablePath(const Path &path) const
 189 {
 190     return path;
 191 }
 192
 193 Private::Converter::Converter(const Path &basePath)
 194     : m_basePath {basePath}
 195 {
 196     Q_ASSERT(basePath.isAbsolute());
 197 }
 198
 199 Path Private::Converter::toPortablePath(const Path &path) const
 200 {
 201     if (path.isEmpty())
 202         return path;
 203
 204 #ifdef Q_OS_WIN
 205     if (path.isAbsolute())
 206     {
 207         const QChar driveLetter = path.data()[0].toUpper();
 208         const QChar baseDriveLetter = m_basePath.data()[0].toUpper();
 209         const bool onSameDrive = (driveLetter.category() == QChar::Letter_Uppercase) && (driveLetter == baseDriveLetter);
 210         if (!onSameDrive)
 211             return path;
 212     }
 213 #endif
 214     return m_basePath.relativePathOf(path);
 215 }
 216
 217 Path Private::Converter::fromPortablePath(const Path &portablePath) const
 218 {
 219     if (portablePath.isEmpty() || portablePath.isAbsolute())
 220         return portablePath;
 221
 222     return m_basePath / portablePath;
 223 }