src/common/quassel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 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 #pragma once
  22
  23 #include <functional>
  24 #include <memory>
  25 #include <vector>
  26
  27 #include <QCoreApplication>
  28 #include <QFile>
  29 #include <QObject>
  30 #include <QLocale>
  31 #include <QString>
  32 #include <QStringList>
  33
  34 #include "abstractcliparser.h"
  35 #include "abstractsignalwatcher.h"
  36 #include "singleton.h"
  37
  38 class QFile;
  39
  40 class Logger;
  41
  42 class Quassel : public QObject, public Singleton<Quassel>
  43 {
  44     // TODO Qt5: Use Q_GADGET
  45     Q_OBJECT
  46
  47 public:
  48     enum RunMode {
  49         Monolithic,
  50         ClientOnly,
  51         CoreOnly
  52     };
  53
  54     struct BuildInfo {
  55         QString fancyVersionString; // clickable rev
  56         QString plainVersionString; // no <a> tag
  57
  58         QString baseVersion;
  59         QString generatedVersion;
  60         QString commitHash;
  61         QString commitDate;
  62
  63         uint protocolVersion; // deprecated
  64
  65         QString applicationName;
  66         QString coreApplicationName;
  67         QString clientApplicationName;
  68         QString organizationName;
  69         QString organizationDomain;
  70     };
  71
  72     /**
  73      * This enum defines the optional features supported by cores/clients prior to version 0.13.
  74      *
  75      * Since the number of features declared this way is limited to 16 (due to the enum not having a defined
  76      * width in cores/clients prior to 0.13), and for more robustness when negotiating features on connect,
  77      * the bitfield-based representation was replaced by a string-based representation in 0.13, support for
  78      * which is indicated by having the ExtendedFeatures flag set. Extended features are defined in the Feature
  79      * enum.
  80      *
  81      * @warning Do not alter this enum; new features must be added (only) to the @a Feature enum.
  82      *
  83      * @sa Feature
  84      */
  85     enum class LegacyFeature : quint32 {
  86         SynchronizedMarkerLine = 0x0001,
  87         SaslAuthentication     = 0x0002,
  88         SaslExternal           = 0x0004,
  89         HideInactiveNetworks   = 0x0008,
  90         PasswordChange         = 0x0010,
  91         CapNegotiation         = 0x0020,
  92         VerifyServerSSL        = 0x0040,
  93         CustomRateLimits       = 0x0080,
  94         // DccFileTransfer     = 0x0100,  // never in use
  95         AwayFormatTimestamp    = 0x0200,
  96         Authenticators         = 0x0400,
  97         BufferActivitySync     = 0x0800,
  98         CoreSideHighlights     = 0x1000,
  99         SenderPrefixes         = 0x2000,
 100         RemoteDisconnect       = 0x4000,
 101         ExtendedFeatures       = 0x8000,
 102     };
 103     Q_FLAGS(LegacyFeature)
 104     Q_DECLARE_FLAGS(LegacyFeatures, LegacyFeature)
 105
 106     /**
 107      * A list of features that are optional in core and/or client, but need runtime checking.
 108      *
 109      * Some features require an uptodate counterpart, but don't justify a protocol break.
 110      * This is what we use this enum for. Add such features to it and check at runtime on the other
 111      * side for their existence.
 112      *
 113      * For feature negotiation, these enum values are serialized as strings, so order does not matter. However,
 114      * do not rename existing enum values to avoid breaking compatibility.
 115      *
 116      * This list should be cleaned up after every protocol break, as we can assume them to be present then.
 117      */
 118     enum class Feature : uint32_t {
 119         SynchronizedMarkerLine,
 120         SaslAuthentication,
 121         SaslExternal,
 122         HideInactiveNetworks,
 123         PasswordChange,           ///< Remote password change
 124         CapNegotiation,           ///< IRCv3 capability negotiation, account tracking
 125         VerifyServerSSL,          ///< IRC server SSL validation
 126         CustomRateLimits,         ///< IRC server custom message rate limits
 127         AwayFormatTimestamp,      ///< Timestamp formatting in away (e.g. %%hh:mm%%)
 128         Authenticators,           ///< Whether or not the core supports auth backends
 129         BufferActivitySync,       ///< Sync buffer activity status
 130         CoreSideHighlights,       ///< Core-Side highlight configuration and matching
 131         SenderPrefixes,           ///< Show prefixes for senders in backlog
 132         RemoteDisconnect,         ///< Allow this peer to be remotely disconnected
 133         ExtendedFeatures,         ///< Extended features
 134         LongTime,                 ///< Serialize time as 64-bit values
 135         RichMessages,             ///< Real Name and Avatar URL in backlog
 136         BacklogFilterType,        ///< BacklogManager supports filtering backlog by MessageType
 137         EcdsaCertfpKeys,          ///< ECDSA keys for CertFP in identities
 138         LongMessageId,            ///< 64-bit IDs for messages
 139         SyncedCoreInfo,           ///< CoreInfo dynamically updated using signals
 140     };
 141     Q_ENUMS(Feature)
 142
 143     class Features;
 144
 145     Quassel();
 146
 147     void init(RunMode runMode);
 148
 149     /**
 150      * Provides access to the Logger instance.
 151      *
 152      * @returns The Logger instance
 153      */
 154     Logger *logger() const;
 155
 156     static void setupBuildInfo();
 157     static const BuildInfo &buildInfo();
 158     static RunMode runMode();
 159
 160     static QString configDirPath();
 161
 162     //! Returns a list of data directory paths
 163     /** There are several locations for applications to install their data files in. On Unix,
 164     *  a common location is /usr/share; others include $PREFIX/share and additional directories
 165     *  specified in the env variable XDG_DATA_DIRS.
 166     *  \return A list of directory paths to look for data files in
 167     */
 168     static QStringList dataDirPaths();
 169
 170     //! Searches for a data file in the possible data directories
 171     /** Data files can reside in $DATA_DIR/apps/quassel, where $DATA_DIR is one of the directories
 172     *  returned by \sa dataDirPaths().
 173     *  \Note With KDE integration enabled, files are searched (only) in KDE's appdata dirs.
 174     *  \return The full path to the data file if found; a null QString else
 175     */
 176     static QString findDataFilePath(const QString &filename);
 177
 178     static QString translationDirPath();
 179
 180     //! Returns a list of directories we look for scripts in
 181     /** We look for a subdirectory named "scripts" in the configdir and in all datadir paths.
 182     *   \return A list of directory paths containing executable scripts for /exec
 183     */
 184     static QStringList scriptDirPaths();
 185
 186     static void loadTranslation(const QLocale &locale);
 187
 188     static void setCliParser(std::shared_ptr<AbstractCliParser> cliParser);
 189     static QString optionValue(const QString &option);
 190     static bool isOptionSet(const QString &option);
 191
 192     using ReloadHandler = std::function<bool()>;
 193
 194     static void registerReloadHandler(ReloadHandler handler);
 195
 196     using QuitHandler = std::function<void()>;
 197
 198     /**
 199      * Registers a handler that is called when the application is supposed to quit.
 200      *
 201      * @note If multiple handlers are registered, they are processed in order of registration.
 202      * @note If any handler is registered, quit() will not call QCoreApplication::quit(). It relies
 203      *       on one of the handlers doing so, instead.
 204      * @param quitHandler Handler to register
 205      */
 206     static void registerQuitHandler(QuitHandler quitHandler);
 207
 208     const QString &coreDumpFileName();
 209
 210 public slots:
 211     /**
 212      * Requests to quit the application.
 213      *
 214      * Calls any registered quit handlers. If no handlers are registered, calls QCoreApplication::quit().
 215      */
 216     void quit();
 217
 218 signals:
 219     void messageLogged(const QDateTime &timeStamp, const QString &msg);
 220
 221 private:
 222     void setupEnvironment();
 223     void registerMetaTypes();
 224     void setupSignalHandling();
 225
 226     /**
 227      * Requests a reload of relevant runtime configuration.
 228      *
 229      * Calls any registered reload handlers, and returns the cumulative result. If no handlers are registered,
 230      * does nothing and returns true.
 231      *
 232      * @returns True if configuration reload successful, otherwise false
 233      */
 234     bool reloadConfig();
 235
 236     void logBacktrace(const QString &filename);
 237
 238 private slots:
 239     void handleSignal(AbstractSignalWatcher::Action action);
 240
 241 private:
 242     BuildInfo _buildInfo;
 243     RunMode _runMode;
 244     bool _quitting{false};
 245
 246     QString _coreDumpFileName;
 247     QString _configDirPath;
 248     QStringList _dataDirPaths;
 249     QString _translationDirPath;
 250
 251     std::shared_ptr<AbstractCliParser> _cliParser;
 252
 253     Logger *_logger;
 254     AbstractSignalWatcher *_signalWatcher{nullptr};
 255
 256     std::vector<ReloadHandler> _reloadHandlers;
 257     std::vector<QuitHandler> _quitHandlers;
 258 };
 259
 260 // --------------------------------------------------------------------------------------------------------------------
 261
 262 /**
 263  * Class representing a set of supported core/client features.
 264  *
 265  * @sa Quassel::Feature
 266  */
 267 class Quassel::Features
 268 {
 269 public:
 270     /**
 271      * Default constructor.
 272      *
 273      * Creates a Feature instance with all known features (i.e., all values declared in the Quassel::Feature enum) set.
 274      * This is useful for easily creating a Feature instance that represent the current version's capabilities.
 275      */
 276     Features();
 277
 278     /**
 279      * Constructs a Feature instance holding the given list of features.
 280      *
 281      * Both the @a features and the @a legacyFeatures arguments are considered (additively).
 282      * This is useful when receiving a list of features from another peer.
 283      *
 284      * @param features       A list of strings matching values in the Quassel::Feature enum. Strings that don't match are
 285      *                       can be accessed after construction via unknownFeatures(), but are otherwise ignored.
 286      * @param legacyFeatures Holds a bit-wise combination of LegacyFeature flag values, which are each added to the list of
 287      *                       features represented by this Features instance.
 288      */
 289     Features(const QStringList &features, LegacyFeatures legacyFeatures);
 290
 291     /**
 292      * Check if a given feature is marked as enabled in this Features instance.
 293      *
 294      * @param feature The feature to be queried
 295      * @returns Whether the given feature is marked as enabled
 296      */
 297     bool isEnabled(Feature feature) const;
 298
 299     /**
 300      * Provides a list of all features marked as either enabled or disabled (as indicated by the @a enabled argument) as strings.
 301      *
 302      * @param enabled Whether to return the enabled or the disabled features
 303      * @return A string list containing all enabled or disabled features
 304      */
 305     QStringList toStringList(bool enabled = true) const;
 306
 307     /**
 308      * Provides a list of all enabled legacy features (i.e. features defined prior to v0.13) as bit-wise combination in a
 309      * LegacyFeatures type.
 310      *
 311      * @note Extended features cannot be represented this way, and are thus ignored even if set.
 312      * @return A LegacyFeatures type holding the bit-wise combination of all legacy features enabled in this Features instance
 313      */
 314     LegacyFeatures toLegacyFeatures() const;
 315
 316     /**
 317      * Provides the list of strings that could not be mapped to Quassel::Feature enum values on construction.
 318      *
 319      * Useful for debugging/logging purposes.
 320      *
 321      * @returns A list of strings that could not be mapped to the Feature enum on construction of this Features instance, if any
 322      */
 323     QStringList unknownFeatures() const;
 324
 325 private:
 326     std::vector<bool> _features;
 327     QStringList _unknownFeatures;
 328 };