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
  88   void connectionError(const QString &errorMsg);
  89   void connectionErrorPopup(const QString &errorMsg);
  90   void connectionWarnings(const QStringList &warnings);
  91   void connectionMsg(const QString &msg);
  92   void disconnected();
  93
  94   void progressRangeChanged(int minimum, int maximum);
  95   void progressValueChanged(int value);
  96   void progressTextChanged(const QString &);
  97
  98   void startCoreSetup(const QVariantList &);
  99   void coreSetupSuccess();
 100   void coreSetupFailed(const QString &error);
 101
 102   void startInternalCore();
 103   void connectToInternalCore(SignalProxy *proxy);
 104
 105   // These signals MUST be handled synchronously!
 106   void userAuthenticationRequired(CoreAccount *, bool *valid, const QString &errorMessage = QString());
 107   void handleNoSslInClient(bool *accepted);
 108   void handleNoSslInCore(bool *accepted);
 109 #ifdef HAVE_SSL
 110   void handleSslErrors(const QSslSocket *socket, bool *accepted, bool *permanently);
 111 #endif
 112
 113 private slots:
 114   void connectToCurrentAccount();
 115   void disconnectFromCore(const QString &errorString, bool wantReconnect = true);
 116
 117   void socketStateChanged(QAbstractSocket::SocketState);
 118   void coreSocketError(QAbstractSocket::SocketError);
 119   void coreHasData();
 120   void coreSocketConnected();
 121   void coreSocketDisconnected();
 122
 123   void clientInitAck(const QVariantMap &msg);
 124
 125   // for sync progress
 126   void networkInitDone();
 127   void checkSyncState();
 128
 129   void syncToCore(const QVariantMap &sessionState);
 130   void internalSessionStateReceived(const QVariant &packedState);
 131   void sessionStateReceived(const QVariantMap &state);
 132
 133   void resetConnection(bool wantReconnect = false);
 134   void connectionReady();
 135
 136   void loginToCore(const QString &user, const QString &password, bool remember); // for config wizard
 137   void loginToCore(const QString &previousError = QString());
 138   void loginSuccess();
 139   void loginFailed(const QString &errorMessage);
 140
 141   void doCoreSetup(const QVariant &setupData);
 142
 143   void updateProgress(int value, int maximum);
 144   void setProgressText(const QString &text);
 145   void setProgressValue(int value);
 146   void setProgressMinimum(int minimum);
 147   void setProgressMaximum(int maximum);
 148
 149   void setState(QAbstractSocket::SocketState socketState);
 150   void setState(ConnectionState state);
 151
 152 #ifdef HAVE_SSL
 153   void sslSocketEncrypted();
 154   void sslErrors();
 155 #endif
 156
 157   void networkDetectionModeChanged(const QVariant &mode);
 158   void pingTimeoutIntervalChanged(const QVariant &interval);
 159   void reconnectIntervalChanged(const QVariant &interval);
 160   void reconnectTimeout();
 161
 162 #ifdef HAVE_KDE
 163   void solidNetworkStatusChanged(Solid::Networking::Status status);
 164 #endif
 165
 166 private:
 167   CoreAccountModel *_model;
 168   CoreAccount _account;
 169   QVariantMap _coreMsgBuffer;
 170
 171   QPointer<QAbstractSocket> _socket;
 172   quint32 _blockSize;
 173   ConnectionState _state;
 174
 175   QTimer _reconnectTimer;
 176   bool _wantReconnect;
 177
 178   QSet<Network *> _netsToSync;
 179   int _numNetsToSync;
 180   int _progressMinimum, _progressMaximum, _progressValue;
 181   QString _progressText;
 182
 183   QString _coreInfoString(const QVariantMap &);
 184
 185   inline CoreAccountModel *accountModel() const;
 186
 187   friend class CoreConfigWizard;
 188 };
 189
 190 Q_DECLARE_METATYPE(CoreConnection::ConnectionState)
 191
 192 // Inlines
 193 int CoreConnection::progressMinimum() const { return _progressMinimum; }
 194 int CoreConnection::progressMaximum() const { return _progressMaximum; }
 195 int CoreConnection::progressValue() const { return _progressValue; }
 196 QString CoreConnection::progressText() const { return _progressText; }
 197
 198 CoreConnection::ConnectionState CoreConnection::state() const { return _state; }
 199 bool CoreConnection::isConnected() const { return state() >= Connected; }
 200 CoreAccount CoreConnection::currentAccount() const { return _account; }
 201 CoreAccountModel *CoreConnection::accountModel() const { return _model; }
 202
 203 #ifdef HAVE_SSL
 204 const QSslSocket *CoreConnection::sslSocket() const { return qobject_cast<QSslSocket *>(_socket); }
 205 #endif
 206
 207 #endif