src/base/profile.h

   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 #pragma once
  31
  32 #include <memory>
  33
  34 #include <QSettings>
  35
  36 class QString;
  37
  38 namespace Private
  39 {
  40     class Profile;
  41     class PathConverter;
  42 }
  43
  44 using SettingsPtr = std::unique_ptr<QSettings>;
  45
  46 enum class SpecialFolder
  47 {
  48     Cache,
  49     Config,
  50     Data,
  51     Downloads
  52 };
  53
  54 class Profile
  55 {
  56 public:
  57     static void initInstance(const QString &rootProfilePath, const QString &configurationName,
  58         bool convertPathsToProfileRelative);
  59     static void freeInstance();
  60     static const Profile *instance();
  61
  62     QString location(SpecialFolder folder) const;
  63     SettingsPtr applicationSettings(const QString &name) const;
  64
  65     QString rootPath() const;
  66     QString configurationName() const;
  67
  68     /// Returns either default name for configuration file (QCoreApplication::applicationName())
  69     /// or the value, supplied via parameters
  70     QString profileName() const;
  71
  72     QString toPortablePath(const QString &absolutePath) const;
  73     QString fromPortablePath(const QString &portablePath) const;
  74
  75 private:
  76     Profile(const QString &rootProfilePath, const QString &configurationName, bool convertPathsToProfileRelative);
  77     ~Profile() = default;  // to generate correct call to ProfilePrivate::~ProfileImpl()
  78
  79     void ensureDirectoryExists(SpecialFolder folder) const;
  80
  81     std::unique_ptr<Private::Profile> m_profileImpl;
  82     std::unique_ptr<Private::PathConverter> m_pathConverterImpl;
  83     static Profile *m_instance;
  84 };
  85
  86 QString specialFolderLocation(SpecialFolder folder);