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