X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fquassel.h;h=d20fdc23c86ac5fd0b29573c70a0b3098d606918;hp=b490075c550806dcb77e46265808e0d9a8ff7b7d;hb=16f22647e6890d3eb8c3e94f7a0700e12fa29e44;hpb=af5ee11e78a6c98f755d0cc5e3bef77028b227dd diff --git a/src/common/quassel.h b/src/common/quassel.h index b490075c..d20fdc23 100644 --- a/src/common/quassel.h +++ b/src/common/quassel.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-08 by the Quassel IRC Team * + * Copyright (C) 2005-2016 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,92 +15,196 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ #ifndef QUASSEL_H_ #define QUASSEL_H_ #include +#include #include #include "abstractcliparser.h" -class Quassel { - Q_DECLARE_TR_FUNCTIONS(Quassel) +class QFile; + +class Quassel +{ + Q_DECLARE_TR_FUNCTIONS(Quassel) public: - enum RunMode { - Monolithic, - ClientOnly, - CoreOnly - }; - - struct BuildInfo { - QString fancyVersionString; // clickable rev - QString plainVersionString; // no tag - - QString baseVersion; - QString generatedVersion; - QString commitHash; - uint commitDate; - QString buildDate; - bool isSourceDirty; - uint protocolVersion; - uint clientNeedsProtocol; - uint coreNeedsProtocol; - - QString applicationName; - QString coreApplicationName; - QString clientApplicationName; - QString organizationName; - QString organizationDomain; - }; - - virtual ~Quassel(); - - static void setupBuildInfo(const QString &generated); - static inline const BuildInfo & buildInfo(); - static inline RunMode runMode(); - - static inline void setCliParser(AbstractCliParser *cliParser); - static inline AbstractCliParser *cliParser(); - static inline QString optionValue(const QString &option); - static inline bool isOptionSet(const QString &option); - - static const QString &coreDumpFileName(); - - static bool DEBUG; - - static void logFatalMessage(const char *msg); + enum RunMode { + Monolithic, + ClientOnly, + CoreOnly + }; + + struct BuildInfo { + QString fancyVersionString; // clickable rev + QString plainVersionString; // no tag + + QString baseVersion; + QString generatedVersion; + QString commitHash; + QString commitDate; + + uint protocolVersion; // deprecated + + QString applicationName; + QString coreApplicationName; + QString clientApplicationName; + QString organizationName; + QString organizationDomain; + }; + + //! A list of features that are optional in core and/or client, but need runtime checking + /** Some features require an uptodate counterpart, but don't justify a protocol break. + * This is what we use this enum for. Add such features to it and check at runtime on the other + * side for their existence. + * + * This list should be cleaned up after every protocol break, as we can assume them to be present then. + */ + enum Feature { + SynchronizedMarkerLine = 0x0001, + SaslAuthentication = 0x0002, + SaslExternal = 0x0004, + HideInactiveNetworks = 0x0008, + PasswordChange = 0x0010, + CapNegotiation = 0x0020, /// IRCv3 capability negotiation, account tracking + VerifyServerSSL = 0x0040, /// IRC server SSL validation + CustomRateLimits = 0x0080, /// IRC server custom message rate limits + DccFileTransfer = 0x0100, + AwayFormatTimestamp = 0x0200, /// Timestamp formatting in away (e.g. %%hh:mm%%) + Authenticators = 0x0400, /// Whether or not the core supports auth backends. + BufferActivitySync = 0x0800, /// Sync buffer activity status + CoreSideHighlights = 0x1000, /// Core-Side highlight configuration and matching + + NumFeatures = 0x1000 + }; + Q_DECLARE_FLAGS(Features, Feature) + + //! The features the current version of Quassel supports (\sa Feature) + /** \return An ORed list of all enum values in Feature + */ + static Features features(); + + virtual ~Quassel(); + + static void setupBuildInfo(); + static inline const BuildInfo &buildInfo(); + static inline RunMode runMode(); + + static QString configDirPath(); + + //! Returns a list of data directory paths + /** There are several locations for applications to install their data files in. On Unix, + * a common location is /usr/share; others include $PREFIX/share and additional directories + * specified in the env variable XDG_DATA_DIRS. + * \return A list of directory paths to look for data files in + */ + static QStringList dataDirPaths(); + + //! Searches for a data file in the possible data directories + /** Data files can reside in $DATA_DIR/apps/quassel, where $DATA_DIR is one of the directories + * returned by \sa dataDirPaths(). + * \Note With KDE integration enabled, files are searched (only) in KDE's appdata dirs. + * \return The full path to the data file if found; a null QString else + */ + static QString findDataFilePath(const QString &filename); + + static QString translationDirPath(); + + //! Returns a list of directories we look for scripts in + /** We look for a subdirectory named "scripts" in the configdir and in all datadir paths. + * \return A list of directory paths containing executable scripts for /exec + */ + static QStringList scriptDirPaths(); + + static void loadTranslation(const QLocale &locale); + + static inline void setCliParser(AbstractCliParser *cliParser); + static inline AbstractCliParser *cliParser(); + static inline QString optionValue(const QString &option); + static inline bool isOptionSet(const QString &option); + + static const QString &coreDumpFileName(); + + static bool DEBUG; + + enum LogLevel { + DebugLevel, + InfoLevel, + WarningLevel, + ErrorLevel + }; + + static inline LogLevel logLevel(); + static inline QFile *logFile(); + static inline bool logToSyslog(); + + static void logFatalMessage(const char *msg); protected: - Quassel(); - virtual bool init(); - - inline void setRunMode(RunMode mode); + Quassel(); + virtual bool init(); + virtual void quit(); + + /** + * Requests a reload of relevant runtime configuration. + * + * Does not reload all configuration, but could catch things such as SSL certificates. Unless + * overridden, simply does nothing. + * + * @return True if configuration reload successful, otherwise false + */ + virtual bool reloadConfig() { return true; } + + inline void setRunMode(RunMode mode); + inline void setDataDirPaths(const QStringList &paths); + QStringList findDataDirPaths() const; + inline void disableCrashhandler(); private: - void registerMetaTypes(); - - static void handleSignal(int signal); - static void logBacktrace(const QString &filename); + void setupEnvironment(); + void registerMetaTypes(); + + static void handleSignal(int signal); + static void logBacktrace(const QString &filename); + + static Quassel *_instance; + static BuildInfo _buildInfo; + static AbstractCliParser *_cliParser; + static RunMode _runMode; + static bool _initialized; + static bool _handleCrashes; + + static QString _coreDumpFileName; + static QString _configDirPath; + static QStringList _dataDirPaths; + static QString _translationDirPath; + + static LogLevel _logLevel; + static QFile *_logFile; + static bool _logToSyslog; +}; - static BuildInfo _buildInfo; - static AbstractCliParser *_cliParser; - static RunMode _runMode; - static bool _initialized; - static QString _coreDumpFileName; -}; +Q_DECLARE_OPERATORS_FOR_FLAGS(Quassel::Features); -const Quassel::BuildInfo & Quassel::buildInfo() { return _buildInfo; } +const Quassel::BuildInfo &Quassel::buildInfo() { return _buildInfo; } Quassel::RunMode Quassel::runMode() { return _runMode; } void Quassel::setRunMode(Quassel::RunMode mode) { _runMode = mode; } +void Quassel::setDataDirPaths(const QStringList &paths) { _dataDirPaths = paths; } +void Quassel::disableCrashhandler() { _handleCrashes = false; } void Quassel::setCliParser(AbstractCliParser *parser) { _cliParser = parser; } AbstractCliParser *Quassel::cliParser() { return _cliParser; } QString Quassel::optionValue(const QString &key) { return cliParser()->value(key); } bool Quassel::isOptionSet(const QString &key) { return cliParser()->isSet(key); } +Quassel::LogLevel Quassel::logLevel() { return _logLevel; } +QFile *Quassel::logFile() { return _logFile; } +bool Quassel::logToSyslog() { return _logToSyslog; } + #endif