src/common/quassel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2016 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #ifndef QUASSEL_H_
  22 #define QUASSEL_H_
  23
  24 #include <QCoreApplication>
  25 #include <QLocale>
  26 #include <QString>
  27
  28 #include "abstractcliparser.h"
  29
  30 class QFile;
  31
  32 class Quassel
  33 {
  34     Q_DECLARE_TR_FUNCTIONS(Quassel)
  35
  36 public:
  37     enum RunMode {
  38         Monolithic,
  39         ClientOnly,
  40         CoreOnly
  41     };
  42
  43     struct BuildInfo {
  44         QString fancyVersionString; // clickable rev
  45         QString plainVersionString; // no <a> tag
  46
  47         QString baseVersion;
  48         QString generatedVersion;
  49         QString commitHash;
  50         QString commitDate;
  51
  52         uint protocolVersion; // deprecated
  53
  54         QString applicationName;
  55         QString coreApplicationName;
  56         QString clientApplicationName;
  57         QString organizationName;
  58         QString organizationDomain;
  59     };
  60
  61     //! A list of features that are optional in core and/or client, but need runtime checking
  62     /** Some features require an uptodate counterpart, but don't justify a protocol break.
  63      *  This is what we use this enum for. Add such features to it and check at runtime on the other
  64      *  side for their existence.
  65      *
  66      *  This list should be cleaned up after every protocol break, as we can assume them to be present then.
  67      */
  68     enum Feature {
  69         SynchronizedMarkerLine = 0x0001,
  70         SaslAuthentication = 0x0002,
  71         SaslExternal = 0x0004,
  72         HideInactiveNetworks = 0x0008,
  73         PasswordChange = 0x0010,
  74         CapNegotiation = 0x0020,           /// IRCv3 capability negotiation, account tracking
  75         VerifyServerSSL = 0x0040,          /// IRC server SSL validation
  76         CustomRateLimits = 0x0080,         /// IRC server custom message rate limits
  77         DccFileTransfer = 0x0100,
  78         AwayFormatTimestamp = 0x0200,      /// Timestamp formatting in away (e.g. %%hh:mm%%)
  79
  80         NumFeatures = 0x0200
  81     };
  82     Q_DECLARE_FLAGS(Features, Feature)
  83
  84     //! The features the current version of Quassel supports (\sa Feature)
  85     /** \return An ORed list of all enum values in Feature
  86      */
  87     static Features features();
  88
  89     virtual ~Quassel();
  90
  91     static void setupBuildInfo();
  92     static inline const BuildInfo &buildInfo();
  93     static inline RunMode runMode();
  94
  95     static QString configDirPath();
  96
  97     //! Returns a list of data directory paths
  98     /** There are several locations for applications to install their data files in. On Unix,
  99     *  a common location is /usr/share; others include $PREFIX/share and additional directories
 100     *  specified in the env variable XDG_DATA_DIRS.
 101     *  \return A list of directory paths to look for data files in
 102     */
 103     static QStringList dataDirPaths();
 104
 105     //! Searches for a data file in the possible data directories
 106     /** Data files can reside in $DATA_DIR/apps/quassel, where $DATA_DIR is one of the directories
 107     *  returned by \sa dataDirPaths().
 108     *  \Note With KDE integration enabled, files are searched (only) in KDE's appdata dirs.
 109     *  \return The full path to the data file if found; a null QString else
 110     */
 111     static QString findDataFilePath(const QString &filename);
 112
 113     static QString translationDirPath();
 114
 115     //! Returns a list of directories we look for scripts in
 116     /** We look for a subdirectory named "scripts" in the configdir and in all datadir paths.
 117     *   \return A list of directory paths containing executable scripts for /exec
 118     */
 119     static QStringList scriptDirPaths();
 120
 121     static void loadTranslation(const QLocale &locale);
 122
 123     static inline void setCliParser(AbstractCliParser *cliParser);
 124     static inline AbstractCliParser *cliParser();
 125     static inline QString optionValue(const QString &option);
 126     static inline bool isOptionSet(const QString &option);
 127
 128     static const QString &coreDumpFileName();
 129
 130     static bool DEBUG;
 131
 132     enum LogLevel {
 133         DebugLevel,
 134         InfoLevel,
 135         WarningLevel,
 136         ErrorLevel
 137     };
 138
 139     static inline LogLevel logLevel();
 140     static inline QFile *logFile();
 141     static inline bool logToSyslog();
 142
 143     static void logFatalMessage(const char *msg);
 144
 145 protected:
 146     Quassel();
 147     virtual bool init();
 148     virtual void quit();
 149
 150     /**
 151      * Requests a reload of relevant runtime configuration.
 152      *
 153      * Does not reload all configuration, but could catch things such as SSL certificates.  Unless
 154      * overridden, simply does nothing.
 155      *
 156      * @return True if configuration reload successful, otherwise false
 157      */
 158     virtual bool reloadConfig() { return true; }
 159
 160     inline void setRunMode(RunMode mode);
 161     inline void setDataDirPaths(const QStringList &paths);
 162     QStringList findDataDirPaths() const;
 163     inline void disableCrashhandler();
 164
 165 private:
 166     void setupEnvironment();
 167     void registerMetaTypes();
 168
 169     static void handleSignal(int signal);
 170     static void logBacktrace(const QString &filename);
 171
 172     static Quassel *_instance;
 173     static BuildInfo _buildInfo;
 174     static AbstractCliParser *_cliParser;
 175     static RunMode _runMode;
 176     static bool _initialized;
 177     static bool _handleCrashes;
 178
 179     static QString _coreDumpFileName;
 180     static QString _configDirPath;
 181     static QStringList _dataDirPaths;
 182     static QString _translationDirPath;
 183
 184     static LogLevel _logLevel;
 185     static QFile *_logFile;
 186     static bool _logToSyslog;
 187 };
 188
 189
 190 Q_DECLARE_OPERATORS_FOR_FLAGS(Quassel::Features);
 191
 192 const Quassel::BuildInfo &Quassel::buildInfo() { return _buildInfo; }
 193 Quassel::RunMode Quassel::runMode() { return _runMode; }
 194 void Quassel::setRunMode(Quassel::RunMode mode) { _runMode = mode; }
 195 void Quassel::setDataDirPaths(const QStringList &paths) { _dataDirPaths = paths; }
 196 void Quassel::disableCrashhandler() { _handleCrashes = false; }
 197
 198 void Quassel::setCliParser(AbstractCliParser *parser) { _cliParser = parser; }
 199 AbstractCliParser *Quassel::cliParser() { return _cliParser; }
 200 QString Quassel::optionValue(const QString &key) { return cliParser()->value(key); }
 201 bool Quassel::isOptionSet(const QString &key) { return cliParser()->isSet(key); }
 202
 203 Quassel::LogLevel Quassel::logLevel() { return _logLevel; }
 204 QFile *Quassel::logFile() { return _logFile; }
 205 bool Quassel::logToSyslog() { return _logToSyslog; }
 206
 207 #endif