common: Represent core/client features as string list in the protocol
[quassel.git] / src / client / coreconnection.cpp
1 /***************************************************************************
2  *   Copyright (C) 2005-2016 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 #include "coreconnection.h"
22
23 #include "client.h"
24 #include "clientauthhandler.h"
25 #include "clientsettings.h"
26 #include "coreaccountmodel.h"
27 #include "identity.h"
28 #include "internalpeer.h"
29 #include "network.h"
30 #include "networkmodel.h"
31 #include "quassel.h"
32 #include "signalproxy.h"
33 #include "util.h"
34
35 #include "protocols/legacy/legacypeer.h"
36
37 CoreConnection::CoreConnection(QObject *parent)
38     : QObject(parent),
39     _authHandler(0),
40     _state(Disconnected),
41     _wantReconnect(false),
42     _wasReconnect(false),
43     _progressMinimum(0),
44     _progressMaximum(-1),
45     _progressValue(-1),
46     _resetting(false)
47 {
48     qRegisterMetaType<ConnectionState>("CoreConnection::ConnectionState");
49 }
50
51
52 void CoreConnection::init()
53 {
54     Client::signalProxy()->setHeartBeatInterval(30);
55     connect(Client::signalProxy(), SIGNAL(lagUpdated(int)), SIGNAL(lagUpdated(int)));
56
57     _reconnectTimer.setSingleShot(true);
58     connect(&_reconnectTimer, SIGNAL(timeout()), SLOT(reconnectTimeout()));
59
60     _qNetworkConfigurationManager = new QNetworkConfigurationManager(this);
61     connect(_qNetworkConfigurationManager, SIGNAL(onlineStateChanged(bool)), SLOT(onlineStateChanged(bool)));
62
63     CoreConnectionSettings s;
64     s.initAndNotify("PingTimeoutInterval", this, SLOT(pingTimeoutIntervalChanged(QVariant)), 60);
65     s.initAndNotify("ReconnectInterval", this, SLOT(reconnectIntervalChanged(QVariant)), 60);
66     s.notify("NetworkDetectionMode", this, SLOT(networkDetectionModeChanged(QVariant)));
67     networkDetectionModeChanged(s.networkDetectionMode());
68 }
69
70
71 CoreAccountModel *CoreConnection::accountModel() const
72 {
73     return Client::coreAccountModel();
74 }
75
76
77 void CoreConnection::setProgressText(const QString &text)
78 {
79     if (_progressText != text) {
80         _progressText = text;
81         emit progressTextChanged(text);
82     }
83 }
84
85
86 void CoreConnection::setProgressValue(int value)
87 {
88     if (_progressValue != value) {
89         _progressValue = value;
90         emit progressValueChanged(value);
91     }
92 }
93
94
95 void CoreConnection::setProgressMinimum(int minimum)
96 {
97     if (_progressMinimum != minimum) {
98         _progressMinimum = minimum;
99         emit progressRangeChanged(minimum, _progressMaximum);
100     }
101 }
102
103
104 void CoreConnection::setProgressMaximum(int maximum)
105 {
106     if (_progressMaximum != maximum) {
107         _progressMaximum = maximum;
108         emit progressRangeChanged(_progressMinimum, maximum);
109     }
110 }
111
112
113 void CoreConnection::updateProgress(int value, int max)
114 {
115     if (max != _progressMaximum) {
116         _progressMaximum = max;
117         emit progressRangeChanged(_progressMinimum, _progressMaximum);
118     }
119     setProgressValue(value);
120 }
121
122
123 void CoreConnection::reconnectTimeout()
124 {
125     if (!_peer) {
126         CoreConnectionSettings s;
127         if (_wantReconnect && s.autoReconnect()) {
128             // If using QNetworkConfigurationManager, we don't want to reconnect if we're offline
129             if (s.networkDetectionMode() == CoreConnectionSettings::UseQNetworkConfigurationManager) {
130                if (!_qNetworkConfigurationManager->isOnline()) {
131                     return;
132                }
133             }
134             reconnectToCore();
135         }
136     }
137 }
138
139
140 void CoreConnection::networkDetectionModeChanged(const QVariant &vmode)
141 {
142     CoreConnectionSettings s;
143     CoreConnectionSettings::NetworkDetectionMode mode = (CoreConnectionSettings::NetworkDetectionMode)vmode.toInt();
144     if (mode == CoreConnectionSettings::UsePingTimeout)
145         Client::signalProxy()->setMaxHeartBeatCount(s.pingTimeoutInterval() / 30);
146     else {
147         Client::signalProxy()->setMaxHeartBeatCount(-1);
148     }
149 }
150
151
152 void CoreConnection::pingTimeoutIntervalChanged(const QVariant &interval)
153 {
154     CoreConnectionSettings s;
155     if (s.networkDetectionMode() == CoreConnectionSettings::UsePingTimeout)
156         Client::signalProxy()->setMaxHeartBeatCount(interval.toInt() / 30);  // interval is 30 seconds
157 }
158
159
160 void CoreConnection::reconnectIntervalChanged(const QVariant &interval)
161 {
162     _reconnectTimer.setInterval(interval.toInt() * 1000);
163 }
164
165
166 void CoreConnection::onlineStateChanged(bool isOnline)
167 {
168     CoreConnectionSettings s;
169     if (s.networkDetectionMode() != CoreConnectionSettings::UseQNetworkConfigurationManager)
170         return;
171
172     if(isOnline) {
173         // qDebug() << "QNetworkConfigurationManager reports Online";
174         if (state() == Disconnected) {
175             if (_wantReconnect && s.autoReconnect()) {
176                 reconnectToCore();
177             }
178         }
179     } else {
180         // qDebug() << "QNetworkConfigurationManager reports Offline";
181         if (state() != Disconnected && !isLocalConnection())
182             disconnectFromCore(tr("Network is down"), true);
183     }
184 }
185
186
187 QPointer<Peer> CoreConnection::peer() const
188 {
189     if (_peer) {
190         return _peer;
191     }
192     return _authHandler ? _authHandler->peer() : nullptr;
193 }
194
195
196 bool CoreConnection::isEncrypted() const
197 {
198     return _peer && _peer->isSecure();
199 }
200
201
202 bool CoreConnection::isLocalConnection() const
203 {
204     if (!isConnected())
205         return false;
206     if (currentAccount().isInternal())
207         return true;
208     if (_authHandler)
209         return _authHandler->isLocal();
210     if (_peer)
211         return _peer->isLocal();
212
213     return false;
214 }
215
216
217 void CoreConnection::onConnectionReady()
218 {
219     setState(Connected);
220 }
221
222
223 void CoreConnection::setState(ConnectionState state)
224 {
225     if (state != _state) {
226         _state = state;
227         emit stateChanged(state);
228         if (state == Connected)
229             _wantReconnect = true;
230         if (state == Disconnected)
231             emit disconnected();
232     }
233 }
234
235
236 void CoreConnection::coreSocketError(QAbstractSocket::SocketError error, const QString &errorString)
237 {
238     Q_UNUSED(error)
239
240     disconnectFromCore(errorString, true);
241 }
242
243
244 void CoreConnection::coreSocketDisconnected()
245 {
246     setState(Disconnected);
247     _wasReconnect = false;
248     resetConnection(_wantReconnect);
249 }
250
251
252 void CoreConnection::disconnectFromCore()
253 {
254     disconnectFromCore(QString(), false); // requested disconnect, so don't try to reconnect
255 }
256
257
258 void CoreConnection::disconnectFromCore(const QString &errorString, bool wantReconnect)
259 {
260     if (wantReconnect)
261         _reconnectTimer.start();
262     else
263         _reconnectTimer.stop();
264
265     _wantReconnect = wantReconnect; // store if disconnect was requested
266     _wasReconnect = false;
267
268     if (_authHandler)
269         _authHandler->close();
270     else if(_peer)
271         _peer->close();
272
273     if (errorString.isEmpty())
274         emit connectionError(tr("Disconnected"));
275     else
276         emit connectionError(errorString);
277 }
278
279
280 void CoreConnection::resetConnection(bool wantReconnect)
281 {
282     if (_resetting)
283         return;
284     _resetting = true;
285
286     _wantReconnect = wantReconnect;
287
288     if (_authHandler) {
289         disconnect(_authHandler, 0, this, 0);
290         _authHandler->close();
291         _authHandler->deleteLater();
292         _authHandler = 0;
293     }
294
295     if (_peer) {
296         disconnect(_peer, 0, this, 0);
297         // peer belongs to the sigproxy and thus gets deleted by it
298         _peer->close();
299         _peer = 0;
300     }
301
302     _netsToSync.clear();
303     _numNetsToSync = 0;
304
305     setProgressMaximum(-1); // disable
306     setState(Disconnected);
307     emit lagUpdated(-1);
308
309     emit connectionMsg(tr("Disconnected from core."));
310     emit encrypted(false);
311     setState(Disconnected);
312
313     // initiate if a reconnect if appropriate
314     CoreConnectionSettings s;
315     if (wantReconnect && s.autoReconnect()) {
316         _reconnectTimer.start();
317     }
318
319     _resetting = false;
320 }
321
322
323 void CoreConnection::reconnectToCore()
324 {
325     if (currentAccount().isValid()) {
326         _wasReconnect = true;
327         connectToCore(currentAccount().accountId());
328     }
329 }
330
331
332 bool CoreConnection::connectToCore(AccountId accId)
333 {
334     if (isConnected())
335         return false;
336
337     CoreAccountSettings s;
338
339     // FIXME: Don't force connection to internal core in mono client
340     if (Quassel::runMode() == Quassel::Monolithic) {
341         _account = accountModel()->account(accountModel()->internalAccount());
342         Q_ASSERT(_account.isValid());
343     }
344     else {
345         if (!accId.isValid()) {
346             // check our settings and figure out what to do
347             if (!s.autoConnectOnStartup())
348                 return false;
349             if (s.autoConnectToFixedAccount())
350                 accId = s.autoConnectAccount();
351             else
352                 accId = s.lastAccount();
353             if (!accId.isValid())
354                 return false;
355         }
356         _account = accountModel()->account(accId);
357         if (!_account.accountId().isValid()) {
358             return false;
359         }
360         if (Quassel::runMode() != Quassel::Monolithic) {
361             if (_account.isInternal())
362                 return false;
363         }
364     }
365
366     s.setLastAccount(accId);
367     connectToCurrentAccount();
368     return true;
369 }
370
371
372 void CoreConnection::connectToCurrentAccount()
373 {
374     if (_authHandler) {
375         qWarning() << Q_FUNC_INFO << "Already connected!";
376         return;
377     }
378
379     if (currentAccount().isInternal()) {
380         if (Quassel::runMode() != Quassel::Monolithic) {
381             qWarning() << "Cannot connect to internal core in client-only mode!";
382             return;
383         }
384         emit startInternalCore();
385
386         InternalPeer *peer = new InternalPeer();
387         _peer = peer;
388         Client::instance()->signalProxy()->addPeer(peer); // sigproxy will take ownership
389         emit connectToInternalCore(peer);
390         setState(Connected);
391
392         return;
393     }
394
395     _authHandler = new ClientAuthHandler(currentAccount(), this);
396
397     connect(_authHandler, SIGNAL(disconnected()), SLOT(coreSocketDisconnected()));
398     connect(_authHandler, SIGNAL(connectionReady()), SLOT(onConnectionReady()));
399     connect(_authHandler, SIGNAL(socketError(QAbstractSocket::SocketError,QString)), SLOT(coreSocketError(QAbstractSocket::SocketError,QString)));
400     connect(_authHandler, SIGNAL(transferProgress(int,int)), SLOT(updateProgress(int,int)));
401     connect(_authHandler, SIGNAL(requestDisconnect(QString,bool)), SLOT(disconnectFromCore(QString,bool)));
402
403     connect(_authHandler, SIGNAL(errorMessage(QString)), SIGNAL(connectionError(QString)));
404     connect(_authHandler, SIGNAL(errorPopup(QString)), SIGNAL(connectionErrorPopup(QString)), Qt::QueuedConnection);
405     connect(_authHandler, SIGNAL(statusMessage(QString)), SIGNAL(connectionMsg(QString)));
406     connect(_authHandler, SIGNAL(encrypted(bool)), SIGNAL(encrypted(bool)));
407     connect(_authHandler, SIGNAL(startCoreSetup(QVariantList, QVariantList)), SIGNAL(startCoreSetup(QVariantList, QVariantList)));
408     connect(_authHandler, SIGNAL(coreSetupFailed(QString)), SIGNAL(coreSetupFailed(QString)));
409     connect(_authHandler, SIGNAL(coreSetupSuccessful()), SIGNAL(coreSetupSuccess()));
410     connect(_authHandler, SIGNAL(userAuthenticationRequired(CoreAccount*,bool*,QString)), SIGNAL(userAuthenticationRequired(CoreAccount*,bool*,QString)));
411     connect(_authHandler, SIGNAL(handleNoSslInClient(bool*)), SIGNAL(handleNoSslInClient(bool*)));
412     connect(_authHandler, SIGNAL(handleNoSslInCore(bool*)), SIGNAL(handleNoSslInCore(bool*)));
413 #ifdef HAVE_SSL
414     connect(_authHandler, SIGNAL(handleSslErrors(const QSslSocket*,bool*,bool*)), SIGNAL(handleSslErrors(const QSslSocket*,bool*,bool*)));
415 #endif
416
417     connect(_authHandler, SIGNAL(loginSuccessful(CoreAccount)), SLOT(onLoginSuccessful(CoreAccount)));
418     connect(_authHandler, SIGNAL(handshakeComplete(RemotePeer*,Protocol::SessionState)), SLOT(onHandshakeComplete(RemotePeer*,Protocol::SessionState)));
419
420     setState(Connecting);
421     _authHandler->connectToCore();
422 }
423
424
425 void CoreConnection::setupCore(const Protocol::SetupData &setupData)
426 {
427     _authHandler->setupCore(setupData);
428 }
429
430
431 void CoreConnection::loginToCore(const QString &user, const QString &password, bool remember)
432 {
433     _authHandler->login(user, password, remember);
434 }
435
436
437 void CoreConnection::onLoginSuccessful(const CoreAccount &account)
438 {
439     updateProgress(0, 0);
440
441     // save current account data
442     accountModel()->createOrUpdateAccount(account);
443     accountModel()->save();
444
445     _reconnectTimer.stop();
446
447     setProgressText(tr("Receiving session state"));
448     setState(Synchronizing);
449     emit connectionMsg(tr("Synchronizing to %1...").arg(account.accountName()));
450 }
451
452
453 void CoreConnection::onHandshakeComplete(RemotePeer *peer, const Protocol::SessionState &sessionState)
454 {
455     updateProgress(100, 100);
456
457     disconnect(_authHandler, 0, this, 0);
458     _authHandler->deleteLater();
459     _authHandler = 0;
460
461     _peer = peer;
462     connect(peer, SIGNAL(disconnected()), SLOT(coreSocketDisconnected()));
463     connect(peer, SIGNAL(statusMessage(QString)), SIGNAL(connectionMsg(QString)));
464     connect(peer, SIGNAL(socketError(QAbstractSocket::SocketError,QString)), SLOT(coreSocketError(QAbstractSocket::SocketError,QString)));
465
466     Client::signalProxy()->addPeer(_peer);  // sigproxy takes ownership of the peer!
467
468     syncToCore(sessionState);
469 }
470
471
472 void CoreConnection::internalSessionStateReceived(const Protocol::SessionState &sessionState)
473 {
474     updateProgress(100, 100);
475     setState(Synchronizing);
476     syncToCore(sessionState);
477 }
478
479
480 void CoreConnection::syncToCore(const Protocol::SessionState &sessionState)
481 {
482     setProgressText(tr("Receiving network states"));
483     updateProgress(0, 100);
484
485     // create identities
486     foreach(const QVariant &vid, sessionState.identities) {
487         Client::instance()->coreIdentityCreated(vid.value<Identity>());
488     }
489
490     // create buffers
491     // FIXME: get rid of this crap -- why?
492     NetworkModel *networkModel = Client::networkModel();
493     Q_ASSERT(networkModel);
494     foreach(const QVariant &vinfo, sessionState.bufferInfos)
495         networkModel->bufferUpdated(vinfo.value<BufferInfo>());  // create BufferItems
496
497     // prepare sync progress thingys...
498     // FIXME: Care about removal of networks
499     _numNetsToSync = sessionState.networkIds.count();
500     updateProgress(0, _numNetsToSync);
501
502     // create network objects
503     foreach(const QVariant &networkid, sessionState.networkIds) {
504         NetworkId netid = networkid.value<NetworkId>();
505         if (Client::network(netid))
506             continue;
507         Network *net = new Network(netid, Client::instance());
508         _netsToSync.insert(net);
509         connect(net, SIGNAL(initDone()), SLOT(networkInitDone()));
510         connect(net, SIGNAL(destroyed()), SLOT(networkInitDone()));
511         Client::addNetwork(net);
512     }
513     checkSyncState();
514 }
515
516
517 // this is also called for destroyed networks!
518 void CoreConnection::networkInitDone()
519 {
520     QObject *net = sender();
521     Q_ASSERT(net);
522     disconnect(net, 0, this, 0);
523     _netsToSync.remove(net);
524     updateProgress(_numNetsToSync - _netsToSync.count(), _numNetsToSync);
525     checkSyncState();
526 }
527
528
529 void CoreConnection::checkSyncState()
530 {
531     if (_netsToSync.isEmpty() && state() >= Synchronizing) {
532         setState(Synchronized);
533         setProgressText(tr("Synchronized to %1").arg(currentAccount().accountName()));
534         setProgressMaximum(-1);
535         emit synchronized();
536     }
537 }