src/client/coreconnection.h

   1 /***************************************************************************
   2  *   Copyright (C) 2009 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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef CORECONNECTION_H_
  22 #define CORECONNECTION_H_
  23
  24 // TODO: support system application proxy (new in Qt 4.6)
  25
  26 #include "QPointer"
  27 #include "QTimer"
  28
  29 #ifdef HAVE_SSL
  30 #  include <QSslSocket>
  31 #else
  32 #  include <QTcpSocket>
  33 #endif
  34
  35 #ifdef HAVE_KDE
  36 #  include <Solid/Networking>
  37 #endif
  38
  39 #include "coreaccount.h"
  40 #include "types.h"
  41
  42 class CoreAccountModel;
  43 class Network;
  44 class SignalProxy;
  45
  46 class CoreConnection : public QObject {
  47   Q_OBJECT
  48
  49 public:
  50   enum ConnectionState {
  51     Disconnected,
  52     Connecting,
  53     Connected,
  54     Synchronizing,
  55     Synchronized
  56   };
  57
  58   CoreConnection(CoreAccountModel *model, QObject *parent = 0);
  59
  60   void init();
  61
  62   inline bool isConnected() const;
  63   inline ConnectionState state() const;
  64   inline CoreAccount currentAccount() const;
  65
  66   bool isEncrypted() const;
  67   bool isLocalConnection() const;
  68
  69   inline int progressMinimum() const;
  70   inline int progressMaximum() const;
  71   inline int progressValue() const;
  72   inline QString progressText() const;
  73
  74 #ifdef HAVE_SSL
  75   inline const QSslSocket *sslSocket() const;
  76 #endif
  77
  78 public slots:
  79   bool connectToCore(AccountId = 0);
  80   void reconnectToCore();
  81   void disconnectFromCore();
  82
  83 signals:
  84   void stateChanged(CoreConnection::ConnectionState);
  85   void encrypted(bool isEncrypted = true);
  86   void synchronized();
  87   void lagUpdated(int msecs);
  88
  89   void connectionError(const QString &errorMsg);
  90   void connectionErrorPopup(const QString &errorMsg);
  91   void connectionWarnings(const QStringList &warnings);
  92   void connectionMsg(const QString &msg);
  93   void disconnected();
  94
  95   void progressRangeChanged(int minimum, int maximum);
  96   void progressValueChanged(int value);
  97   void progressTextChanged(const QString &);
  98
  99   void startCoreSetup(const QVariantList &);
 100   void coreSetupSuccess();
 101   void coreSetupFailed(const QString &error);
 102
 103   void startInternalCore();
 104   void connectToInternalCore(SignalProxy *proxy);
 105
 106   // These signals MUST be handled synchronously!
 107   void userAuthenticationRequired(CoreAccount *, bool *valid, const QString &errorMessage = QString());
 108   void handleNoSslInClient(bool *accepted);
 109   void handleNoSslInCore(bool *accepted);
 110 #ifdef HAVE_SSL
 111   void handleSslErrors(const QSslSocket *socket, bool *accepted, bool *permanently);
 112 #endif
 113
 114 private slots:
 115   void connectToCurrentAccount();
 116   void disconnectFromCore(const QString &errorString, bool wantReconnect = true);
 117
 118   void socketStateChanged(QAbstractSocket::SocketState);
 119   void coreSocketError(QAbstractSocket::SocketError);
 120   void coreHasData();
 121   void coreSocketConnected();
 122   void coreSocketDisconnected();
 123
 124   void clientInitAck(const QVariantMap &msg);
 125
 126   // for sync progress
 127   void networkInitDone();
 128   void checkSyncState();
 129
 130   void syncToCore(const QVariantMap &sessionState);
 131   void internalSessionStateReceived(const QVariant &packedState);
 132   void sessionStateReceived(const QVariantMap &state);
 133
 134   void resetConnection(bool wantReconnect = false);
 135   void connectionReady();
 136
 137   void loginToCore(const QString &user, const QString &password, bool remember); // for config wizard
 138   void loginToCore(const QString &previousError = QString());
 139   void loginSuccess();
 140   void loginFailed(const QString &errorMessage);
 141
 142   void doCoreSetup(const QVariant &setupData);
 143
 144   void updateProgress(int value, int maximum);
 145   void setProgressText(const QString &text);
 146   void setProgressValue(int value);
 147   void setProgressMinimum(int minimum);
 148   void setProgressMaximum(int maximum);
 149
 150   void setState(QAbstractSocket::SocketState socketState);
 151   void setState(ConnectionState state);
 152
 153 #ifdef HAVE_SSL
 154   void sslSocketEncrypted();
 155   void sslErrors();
 156 #endif
 157
 158   void networkDetectionModeChanged(const QVariant &mode);
 159   void pingTimeoutIntervalChanged(const QVariant &interval);
 160   void reconnectIntervalChanged(const QVariant &interval);
 161   void reconnectTimeout();
 162
 163 #ifdef HAVE_KDE
 164   void solidNetworkStatusChanged(Solid::Networking::Status status);
 165 #endif
 166
 167 private:
 168   CoreAccountModel *_model;
 169   CoreAccount _account;
 170   QVariantMap _coreMsgBuffer;
 171
 172   QPointer<QAbstractSocket> _socket;
 173   quint32 _blockSize;
 174   ConnectionState _state;
 175
 176   QTimer _reconnectTimer;
 177   bool _wantReconnect;
 178
 179   QSet<QObject *> _netsToSync;
 180   int _numNetsToSync;
 181   int _progressMinimum, _progressMaximum, _progressValue;
 182   QString _progressText;
 183
 184   QString _coreInfoString(const QVariantMap &);
 185
 186   inline CoreAccountModel *accountModel() const;
 187
 188   friend class CoreConfigWizard;
 189 };
 190
 191 Q_DECLARE_METATYPE(CoreConnection::ConnectionState)
 192
 193 // Inlines
 194 int CoreConnection::progressMinimum() const { return _progressMinimum; }
 195 int CoreConnection::progressMaximum() const { return _progressMaximum; }
 196 int CoreConnection::progressValue() const { return _progressValue; }
 197 QString CoreConnection::progressText() const { return _progressText; }
 198
 199 CoreConnection::ConnectionState CoreConnection::state() const { return _state; }
 200 bool CoreConnection::isConnected() const { return state() >= Connected; }
 201 CoreAccount CoreConnection::currentAccount() const { return _account; }
 202 CoreAccountModel *CoreConnection::accountModel() const { return _model; }
 203
 204 #ifdef HAVE_SSL
 205 const QSslSocket *CoreConnection::sslSocket() const { return qobject_cast<QSslSocket *>(_socket); }
 206 #endif
 207
 208 #endif