core: Improve handling of core initialization errors
[quassel.git] / src / client / client.h
index a7e6c2c..00c9c97 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2016 by the Quassel Project                        *
+ *   Copyright (C) 2005-2018 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -24,6 +24,7 @@
 #include <QPointer>
 
 #include "bufferinfo.h"
+#include "coreinfo.h"
 #include "coreaccount.h"
 #include "coreconnection.h"
 #include "highlightrulemanager.h"
@@ -115,6 +116,7 @@ public:
 
     static inline ClientAliasManager *aliasManager() { return instance()->_aliasManager; }
     static inline ClientBacklogManager *backlogManager() { return instance()->_backlogManager; }
+    static inline CoreInfo *coreInfo() { return instance()->_coreInfo; }
     static inline DccConfig *dccConfig() { return instance()->_dccConfig; }
     static inline ClientIrcListHelper *ircListHelper() { return instance()->_ircListHelper; }
     static inline ClientBufferViewManager *bufferViewManager() { return instance()->_bufferViewManager; }
@@ -147,6 +149,17 @@ public:
     static void mergeBuffersPermanently(BufferId bufferId1, BufferId bufferId2);
     static void purgeKnownBufferIds();
 
+    /**
+     * Requests client to resynchronize the CoreInfo object for legacy (pre-0.13) cores
+     *
+     * This provides compatibility with updating core information for legacy cores, and can be
+     * removed after protocol break.
+     *
+     * NOTE: On legacy (pre-0.13) cores, any existing connected signals will be destroyed and must
+     * be re-added after calling this, in addition to checking for existing data in coreInfo().
+     */
+    static void refreshLegacyCoreInfo();
+
     static void changePassword(const QString &oldPassword, const QString &newPassword);
     static void kickClient(int peerId);
 
@@ -154,24 +167,55 @@ public:
         emit showIgnoreList(ignoreRule);
     }
 
-#if QT_VERSION < 0x050000
-    static void logMessage(QtMsgType type, const char *msg);
-#else
-    static void logMessage(QtMsgType, const QMessageLogContext&, const QString&);
-#endif
-    static inline const QString &debugLog() { return instance()->_debugLogBuffer; }
+    /**
+     * Request to show the channel list dialog for the network, optionally searching by channel name
+     *
+     * @see Client::showChannelList()
+     *
+     * @param networkId        Network ID for associated network
+     * @param channelFilters   Partial channel name to search for, or empty to show all
+     * @param listImmediately  If true, immediately list channels, otherwise just show dialog
+     */
+    void displayChannelList(NetworkId networkId, const QString &channelFilters = {},
+                            bool listImmediately = false)
+    {
+        emit showChannelList(networkId, channelFilters, listImmediately);
+    }
 
 signals:
     void requestNetworkStates();
 
     void showConfigWizard(const QVariantMap &coredata);
-    void showChannelList(NetworkId networkId);
+
+    /**
+     * Request to show the channel list dialog for the network, optionally searching by channel name
+     *
+     * @see MainWin::showChannelList()
+     *
+     * @param networkId        Network ID for associated network
+     * @param channelFilters   Partial channel name to search for, or empty to show all
+     * @param listImmediately  If true, immediately list channels, otherwise just show dialog
+     */
+    void showChannelList(NetworkId networkId, const QString &channelFilters = {},
+                         bool listImmediately = false);
+
     void showIgnoreList(QString ignoreRule);
 
     void connected();
     void disconnected();
     void coreConnectionStateChanged(bool);
 
+    /**
+     * Signals that core information has been resynchronized, removing existing signal handlers
+     *
+     * Whenever this is emitted, one should re-add any handlers for CoreInfo::coreDataChanged() and
+     * apply any existing information in the coreInfo() object.
+     *
+     * Only emitted on legacy (pre-0.13) cores.  Generally, one should use the
+     * CoreInfo::coreDataChanged() signal too.
+     */
+    void coreInfoResynchronized();
+
     //! The identity with the given ID has been newly created in core and client.
     /** \param id The ID of the newly created identity.
      */
@@ -196,8 +240,6 @@ signals:
     void requestCreateNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList());
     void requestRemoveNetwork(NetworkId);
 
-    void logUpdated(const QString &msg);
-
     //! Emitted when a buffer has been marked as read
     /** This is currently triggered by setting lastSeenMsg, either local or remote,
      *  or by bringing the window to front.
@@ -211,6 +253,12 @@ signals:
     void requestKickClient(int peerId);
     void passwordChanged(bool success);
 
+    //! Emitted when database schema upgrade starts or ends (only mono client)
+    void dbUpgradeInProgress(bool inProgress);
+
+    //! Emitted before an exit request is handled
+    void exitRequested(const QString &reason);
+
 public slots:
     void disconnectFromCore();
 
@@ -220,6 +268,9 @@ public slots:
 
     void markBufferAsRead(BufferId id);
 
+    void onDbUpgradeInProgress(bool inProgress);
+    void onExitRequested(int exitCode, const QString &reason);
+
 private slots:
     void setSyncedToCore();
     void setDisconnectedFromCore();
@@ -247,6 +298,17 @@ private:
 
     void requestInitialBacklog();
 
+    /**
+     * Deletes and resynchronizes the CoreInfo object for legacy (pre-0.13) cores
+     *
+     * This provides compatibility with updating core information for legacy cores, and can be
+     * removed after protocol break.
+     *
+     * NOTE: On legacy (pre-0.13) cores, any existing connected signals will be destroyed and must
+     * be re-added after calling this, in addition to checking for existing data in coreInfo().
+     */
+    void requestLegacyCoreInfo();
+
     static void addNetwork(Network *);
 
     static QPointer<Client> instanceptr;
@@ -260,6 +322,7 @@ private:
     ClientBacklogManager *_backlogManager;
     ClientBufferViewManager *_bufferViewManager;
     BufferViewOverlay *_bufferViewOverlay;
+    CoreInfo *_coreInfo;
     DccConfig *_dccConfig;
     ClientIrcListHelper *_ircListHelper;
     ClientUserInputHandler *_inputHandler;
@@ -282,9 +345,6 @@ private:
 
     bool _connected;
 
-    QString _debugLogBuffer;
-    QTextStream _debugLog;
-
     QList<QPair<BufferInfo, QString> > _userInputBuffer;
 
     friend class CoreConnection;