1 /***************************************************************************
2 * Copyright (C) 2005-2016 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
23 #include "corenetwork.h"
26 #include "coreidentity.h"
27 #include "corenetworkconfig.h"
28 #include "coresession.h"
29 #include "coreuserinputhandler.h"
30 #include "networkevent.h"
35 INIT_SYNCABLE_OBJECT(CoreNetwork)
36 CoreNetwork::CoreNetwork(const NetworkId &networkid, CoreSession *session)
37 : Network(networkid, session),
38 _coreSession(session),
39 _userInputHandler(new CoreUserInputHandler(this)),
40 _autoReconnectCount(0),
41 _quitRequested(false),
42 _disconnectExpected(false),
44 _previousConnectionAttemptFailed(false),
45 _lastUsedServerIndex(0),
50 _requestedUserModes('-')
52 _autoReconnectTimer.setSingleShot(true);
53 connect(&_socketCloseTimer, SIGNAL(timeout()), this, SLOT(socketCloseTimeout()));
55 setPingInterval(networkConfig()->pingInterval());
56 connect(&_pingTimer, SIGNAL(timeout()), this, SLOT(sendPing()));
58 setAutoWhoDelay(networkConfig()->autoWhoDelay());
59 setAutoWhoInterval(networkConfig()->autoWhoInterval());
61 QHash<QString, QString> channels = coreSession()->persistentChannels(networkId());
62 foreach(QString chan, channels.keys()) {
63 _channelKeys[chan.toLower()] = channels[chan];
66 connect(networkConfig(), SIGNAL(pingTimeoutEnabledSet(bool)), SLOT(enablePingTimeout(bool)));
67 connect(networkConfig(), SIGNAL(pingIntervalSet(int)), SLOT(setPingInterval(int)));
68 connect(networkConfig(), SIGNAL(autoWhoEnabledSet(bool)), SLOT(setAutoWhoEnabled(bool)));
69 connect(networkConfig(), SIGNAL(autoWhoIntervalSet(int)), SLOT(setAutoWhoInterval(int)));
70 connect(networkConfig(), SIGNAL(autoWhoDelaySet(int)), SLOT(setAutoWhoDelay(int)));
72 connect(&_autoReconnectTimer, SIGNAL(timeout()), this, SLOT(doAutoReconnect()));
73 connect(&_autoWhoTimer, SIGNAL(timeout()), this, SLOT(sendAutoWho()));
74 connect(&_autoWhoCycleTimer, SIGNAL(timeout()), this, SLOT(startAutoWhoCycle()));
75 connect(&_tokenBucketTimer, SIGNAL(timeout()), this, SLOT(checkTokenBucket()));
77 connect(&socket, SIGNAL(connected()), this, SLOT(socketInitialized()));
78 connect(&socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(socketError(QAbstractSocket::SocketError)));
79 connect(&socket, SIGNAL(stateChanged(QAbstractSocket::SocketState)), this, SLOT(socketStateChanged(QAbstractSocket::SocketState)));
80 connect(&socket, SIGNAL(readyRead()), this, SLOT(socketHasData()));
82 connect(&socket, SIGNAL(encrypted()), this, SLOT(socketInitialized()));
83 connect(&socket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
85 connect(this, SIGNAL(newEvent(Event *)), coreSession()->eventManager(), SLOT(postEvent(Event *)));
87 // Custom rate limiting
88 // These react to the user changing settings in the client
89 connect(this, SIGNAL(useCustomMessageRateSet(bool)), SLOT(updateRateLimiting()));
90 connect(this, SIGNAL(messageRateBurstSizeSet(quint32)), SLOT(updateRateLimiting()));
91 connect(this, SIGNAL(messageRateDelaySet(quint32)), SLOT(updateRateLimiting()));
92 connect(this, SIGNAL(unlimitedMessageRateSet(bool)), SLOT(updateRateLimiting()));
94 // IRCv3 capability handling
95 // These react to CAP messages from the server
96 connect(this, SIGNAL(capAdded(QString)), this, SLOT(serverCapAdded(QString)));
97 connect(this, SIGNAL(capAcknowledged(QString)), this, SLOT(serverCapAcknowledged(QString)));
98 connect(this, SIGNAL(capRemoved(QString)), this, SLOT(serverCapRemoved(QString)));
100 if (Quassel::isOptionSet("oidentd")) {
101 connect(this, SIGNAL(socketInitialized(const CoreIdentity*, QHostAddress, quint16, QHostAddress, quint16)), Core::instance()->oidentdConfigGenerator(), SLOT(addSocket(const CoreIdentity*, QHostAddress, quint16, QHostAddress, quint16)), Qt::BlockingQueuedConnection);
102 connect(this, SIGNAL(socketDisconnected(const CoreIdentity*, QHostAddress, quint16, QHostAddress, quint16)), Core::instance()->oidentdConfigGenerator(), SLOT(removeSocket(const CoreIdentity*, QHostAddress, quint16, QHostAddress, quint16)));
107 CoreNetwork::~CoreNetwork()
109 // Request a proper disconnect, but don't count as user-requested disconnect
110 if (socketConnected()) {
111 // Only try if the socket's fully connected (not initializing or disconnecting).
112 // Force an immediate disconnect, jumping the command queue. Ensures the proper QUIT is
113 // shown even if other messages are queued.
114 disconnectFromIrc(false, QString(), false, true);
115 // Process the putCmd events that trigger the quit. Without this, shutting down the core
116 // results in abrubtly closing the socket rather than sending the QUIT as expected.
117 QCoreApplication::processEvents();
118 // Wait briefly for each network to disconnect. Sometimes it takes a little while to send.
119 if (!forceDisconnect()) {
120 qWarning() << "Timed out quitting network" << networkName() <<
121 "(user ID " << userId() << ")";
124 disconnect(&socket, 0, this, 0); // this keeps the socket from triggering events during clean up
125 delete _userInputHandler;
129 bool CoreNetwork::forceDisconnect(int msecs)
131 if (socket.state() == QAbstractSocket::UnconnectedState) {
132 // Socket already disconnected.
135 // Request a socket-level disconnect if not already happened
136 socket.disconnectFromHost();
137 // Return the result of waiting for disconnect; true if successful, otherwise false
138 return socket.waitForDisconnected(msecs);
142 QString CoreNetwork::channelDecode(const QString &bufferName, const QByteArray &string) const
144 if (!bufferName.isEmpty()) {
145 IrcChannel *channel = ircChannel(bufferName);
147 return channel->decodeString(string);
149 return decodeString(string);
153 QString CoreNetwork::userDecode(const QString &userNick, const QByteArray &string) const
155 IrcUser *user = ircUser(userNick);
157 return user->decodeString(string);
158 return decodeString(string);
162 QByteArray CoreNetwork::channelEncode(const QString &bufferName, const QString &string) const
164 if (!bufferName.isEmpty()) {
165 IrcChannel *channel = ircChannel(bufferName);
167 return channel->encodeString(string);
169 return encodeString(string);
173 QByteArray CoreNetwork::userEncode(const QString &userNick, const QString &string) const
175 IrcUser *user = ircUser(userNick);
177 return user->encodeString(string);
178 return encodeString(string);
182 void CoreNetwork::connectToIrc(bool reconnecting)
184 if (!reconnecting && useAutoReconnect() && _autoReconnectCount == 0) {
185 _autoReconnectTimer.setInterval(autoReconnectInterval() * 1000);
186 if (unlimitedReconnectRetries())
187 _autoReconnectCount = -1;
189 _autoReconnectCount = autoReconnectRetries();
191 if (serverList().isEmpty()) {
192 qWarning() << "Server list empty, ignoring connect request!";
195 CoreIdentity *identity = identityPtr();
197 qWarning() << "Invalid identity configures, ignoring connect request!";
201 // cleaning up old quit reason
204 // Reset capability negotiation tracking, also handling server changes during reconnect
205 _capsQueuedIndividual.clear();
206 _capsQueuedBundled.clear();
208 _capNegotiationActive = false;
209 _capInitialNegotiationEnded = false;
211 // use a random server?
212 if (useRandomServer()) {
213 _lastUsedServerIndex = qrand() % serverList().size();
215 else if (_previousConnectionAttemptFailed) {
216 // cycle to next server if previous connection attempt failed
217 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connection failed. Cycling to next Server"));
218 if (++_lastUsedServerIndex >= serverList().size()) {
219 _lastUsedServerIndex = 0;
222 _previousConnectionAttemptFailed = false;
224 Server server = usedServer();
225 displayStatusMsg(tr("Connecting to %1:%2...").arg(server.host).arg(server.port));
226 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connecting to %1:%2...").arg(server.host).arg(server.port));
228 if (server.useProxy) {
229 QNetworkProxy proxy((QNetworkProxy::ProxyType)server.proxyType, server.proxyHost, server.proxyPort, server.proxyUser, server.proxyPass);
230 socket.setProxy(proxy);
233 socket.setProxy(QNetworkProxy::NoProxy);
238 // Qt caches DNS entries for a minute, resulting in round-robin (e.g. for chat.freenode.net) not working if several users
239 // connect at a similar time. QHostInfo::fromName(), however, always performs a fresh lookup, overwriting the cache entry.
240 QHostInfo::fromName(server.host);
244 CoreIdentity *identity = identityPtr();
246 socket.setLocalCertificate(identity->sslCert());
247 socket.setPrivateKey(identity->sslKey());
249 socket.connectToHostEncrypted(server.host, server.port);
252 socket.connectToHost(server.host, server.port);
255 socket.connectToHost(server.host, server.port);
260 void CoreNetwork::disconnectFromIrc(bool requested, const QString &reason, bool withReconnect,
263 // Disconnecting from the network, should expect a socket close or error
264 _disconnectExpected = true;
265 _quitRequested = requested; // see socketDisconnected();
266 if (!withReconnect) {
267 _autoReconnectTimer.stop();
268 _autoReconnectCount = 0; // prohibiting auto reconnect
270 disablePingTimeout();
277 awayMsg = me_->awayMessage();
278 Core::setAwayMessage(userId(), networkId(), awayMsg);
281 if (reason.isEmpty() && identityPtr())
282 _quitReason = identityPtr()->quitReason();
284 _quitReason = reason;
286 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Disconnecting. (%1)").arg((!requested && !withReconnect) ? tr("Core Shutdown") : _quitReason));
287 if (socket.state() == QAbstractSocket::UnconnectedState) {
288 socketDisconnected();
290 if (socket.state() == QAbstractSocket::ConnectedState) {
291 userInputHandler()->issueQuit(_quitReason, forceImmediate);
295 if (requested || withReconnect) {
296 // the irc server has 10 seconds to close the socket
297 _socketCloseTimer.start(10000);
303 void CoreNetwork::userInput(BufferInfo buf, QString msg)
305 userInputHandler()->handleUserInput(buf, msg);
309 void CoreNetwork::putRawLine(const QByteArray s, const bool prepend)
311 if (_tokenBucket > 0 || (_skipMessageRates && _msgQueue.size() == 0)) {
312 // If there's tokens remaining, ...
313 // Or rate limits don't apply AND no messages are in queue (to prevent out-of-order), ...
314 // Send the message now.
317 // Otherwise, queue the message for later
319 // Jump to the start, skipping other messages
320 _msgQueue.prepend(s);
322 // Add to back, waiting in order
329 void CoreNetwork::putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix, const bool prepend)
333 if (!prefix.isEmpty())
334 msg += ":" + prefix + " ";
335 msg += cmd.toUpper().toLatin1();
337 for (int i = 0; i < params.size(); i++) {
340 if (i == params.size() - 1 && (params[i].contains(' ') || (!params[i].isEmpty() && params[i][0] == ':')))
346 putRawLine(msg, prepend);
350 void CoreNetwork::putCmd(const QString &cmd, const QList<QList<QByteArray>> ¶ms, const QByteArray &prefix, const bool prependAll)
352 QListIterator<QList<QByteArray>> i(params);
353 while (i.hasNext()) {
354 QList<QByteArray> msg = i.next();
355 putCmd(cmd, msg, prefix, prependAll);
360 void CoreNetwork::setChannelJoined(const QString &channel)
362 queueAutoWhoOneshot(channel); // check this new channel first
364 Core::setChannelPersistent(userId(), networkId(), channel, true);
365 Core::setPersistentChannelKey(userId(), networkId(), channel, _channelKeys[channel.toLower()]);
369 void CoreNetwork::setChannelParted(const QString &channel)
371 removeChannelKey(channel);
372 _autoWhoQueue.removeAll(channel.toLower());
373 _autoWhoPending.remove(channel.toLower());
375 Core::setChannelPersistent(userId(), networkId(), channel, false);
379 void CoreNetwork::addChannelKey(const QString &channel, const QString &key)
382 removeChannelKey(channel);
385 _channelKeys[channel.toLower()] = key;
390 void CoreNetwork::removeChannelKey(const QString &channel)
392 _channelKeys.remove(channel.toLower());
397 Cipher *CoreNetwork::cipher(const QString &target)
399 if (target.isEmpty())
402 if (!Cipher::neededFeaturesAvailable())
405 CoreIrcChannel *channel = qobject_cast<CoreIrcChannel *>(ircChannel(target));
407 return channel->cipher();
409 CoreIrcUser *user = qobject_cast<CoreIrcUser *>(ircUser(target));
411 return user->cipher();
412 } else if (!isChannelName(target)) {
413 return qobject_cast<CoreIrcUser*>(newIrcUser(target))->cipher();
419 QByteArray CoreNetwork::cipherKey(const QString &target) const
421 CoreIrcChannel *c = qobject_cast<CoreIrcChannel*>(ircChannel(target));
423 return c->cipher()->key();
425 CoreIrcUser *u = qobject_cast<CoreIrcUser*>(ircUser(target));
427 return u->cipher()->key();
433 void CoreNetwork::setCipherKey(const QString &target, const QByteArray &key)
435 CoreIrcChannel *c = qobject_cast<CoreIrcChannel*>(ircChannel(target));
437 c->setEncrypted(c->cipher()->setKey(key));
441 CoreIrcUser *u = qobject_cast<CoreIrcUser*>(ircUser(target));
442 if (!u && !isChannelName(target))
443 u = qobject_cast<CoreIrcUser*>(newIrcUser(target));
446 u->setEncrypted(u->cipher()->setKey(key));
452 bool CoreNetwork::cipherUsesCBC(const QString &target)
454 CoreIrcChannel *c = qobject_cast<CoreIrcChannel*>(ircChannel(target));
456 return c->cipher()->usesCBC();
457 CoreIrcUser *u = qobject_cast<CoreIrcUser*>(ircUser(target));
459 return u->cipher()->usesCBC();
463 #endif /* HAVE_QCA2 */
465 bool CoreNetwork::setAutoWhoDone(const QString &channel)
467 QString chan = channel.toLower();
468 if (_autoWhoPending.value(chan, 0) <= 0)
470 if (--_autoWhoPending[chan] <= 0)
471 _autoWhoPending.remove(chan);
476 void CoreNetwork::setMyNick(const QString &mynick)
478 Network::setMyNick(mynick);
479 if (connectionState() == Network::Initializing)
480 networkInitialized();
484 void CoreNetwork::socketHasData()
486 while (socket.canReadLine()) {
487 QByteArray s = socket.readLine();
488 if (s.endsWith("\r\n"))
490 else if (s.endsWith("\n"))
492 NetworkDataEvent *event = new NetworkDataEvent(EventManager::NetworkIncoming, this, s);
493 event->setTimestamp(QDateTime::currentDateTimeUtc());
494 emit newEvent(event);
499 void CoreNetwork::socketError(QAbstractSocket::SocketError error)
501 // Ignore socket closed errors if expected
502 if (_disconnectExpected && error == QAbstractSocket::RemoteHostClosedError) {
506 _previousConnectionAttemptFailed = true;
507 qWarning() << qPrintable(tr("Could not connect to %1 (%2)").arg(networkName(), socket.errorString()));
508 emit connectionError(socket.errorString());
509 displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Connection failure: %1").arg(socket.errorString()));
510 emitConnectionError(socket.errorString());
511 if (socket.state() < QAbstractSocket::ConnectedState) {
512 socketDisconnected();
517 void CoreNetwork::socketInitialized()
519 CoreIdentity *identity = identityPtr();
521 qCritical() << "Identity invalid!";
526 Server server = usedServer();
529 // Non-SSL connections enter here only once, always emit socketInitialized(...) in these cases
530 // SSL connections call socketInitialized() twice, only emit socketInitialized(...) on the first (not yet encrypted) run
531 if (!server.useSsl || !socket.isEncrypted()) {
532 emit socketInitialized(identity, localAddress(), localPort(), peerAddress(), peerPort());
535 if (server.useSsl && !socket.isEncrypted()) {
536 // We'll finish setup once we're encrypted, and called again
540 emit socketInitialized(identity, localAddress(), localPort(), peerAddress(), peerPort());
543 socket.setSocketOption(QAbstractSocket::KeepAliveOption, true);
545 // Update the TokenBucket, force-enabling unlimited message rates for initial registration and
546 // capability negotiation. networkInitialized() will call updateRateLimiting() without the
547 // force flag to apply user preferences. When making changes, ensure that this still happens!
548 // As Quassel waits for CAP ACK/NAK and AUTHENTICATE replies, this shouldn't ever fill the IRC
549 // server receive queue and cause a kill. "Shouldn't" being the operative word; the real world
551 updateRateLimiting(true);
552 // Fill up the token bucket as we're connecting from scratch
555 // Request capabilities as per IRCv3.2 specifications
556 // Older servers should ignore this; newer servers won't downgrade to RFC1459
557 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Requesting capability list..."));
558 putRawLine(serverEncode(QString("CAP LS 302")));
560 if (!server.password.isEmpty()) {
561 putRawLine(serverEncode(QString("PASS %1").arg(server.password)));
564 if (identity->nicks().isEmpty()) {
566 qWarning() << "CoreNetwork::socketInitialized(): no nicks supplied for identity Id" << identity->id();
569 nick = identity->nicks()[0];
571 putRawLine(serverEncode(QString("NICK %1").arg(nick)));
572 putRawLine(serverEncode(QString("USER %1 8 * :%2").arg(identity->ident(), identity->realName())));
576 void CoreNetwork::socketDisconnected()
578 disablePingTimeout();
581 _autoWhoCycleTimer.stop();
582 _autoWhoTimer.stop();
583 _autoWhoQueue.clear();
584 _autoWhoPending.clear();
586 _socketCloseTimer.stop();
588 _tokenBucketTimer.stop();
592 foreach(QString channel, me_->channels())
593 displayMsg(Message::Quit, BufferInfo::ChannelBuffer, channel, _quitReason, me_->hostmask());
597 emit disconnected(networkId());
598 emit socketDisconnected(identityPtr(), localAddress(), localPort(), peerAddress(), peerPort());
599 // Reset disconnect expectations
600 _disconnectExpected = false;
601 if (_quitRequested) {
602 _quitRequested = false;
603 setConnectionState(Network::Disconnected);
604 Core::setNetworkConnected(userId(), networkId(), false);
606 else if (_autoReconnectCount != 0) {
607 setConnectionState(Network::Reconnecting);
608 if (_autoReconnectCount == -1 || _autoReconnectCount == autoReconnectRetries())
609 doAutoReconnect(); // first try is immediate
611 _autoReconnectTimer.start();
616 void CoreNetwork::socketStateChanged(QAbstractSocket::SocketState socketState)
618 Network::ConnectionState state;
619 switch (socketState) {
620 case QAbstractSocket::UnconnectedState:
621 state = Network::Disconnected;
622 socketDisconnected();
624 case QAbstractSocket::HostLookupState:
625 case QAbstractSocket::ConnectingState:
626 state = Network::Connecting;
628 case QAbstractSocket::ConnectedState:
629 state = Network::Initializing;
631 case QAbstractSocket::ClosingState:
632 state = Network::Disconnecting;
635 state = Network::Disconnected;
637 setConnectionState(state);
641 void CoreNetwork::networkInitialized()
643 setConnectionState(Network::Initialized);
645 _disconnectExpected = false;
646 _quitRequested = false;
648 // Update the TokenBucket with specified rate-limiting settings, removing the force-unlimited
649 // flag used for initial registration and capability negotiation.
650 updateRateLimiting();
652 if (useAutoReconnect()) {
654 _autoReconnectCount = unlimitedReconnectRetries() ? -1 : autoReconnectRetries();
657 // restore away state
658 QString awayMsg = Core::awayMessage(userId(), networkId());
659 if (!awayMsg.isEmpty())
660 userInputHandler()->handleAway(BufferInfo(), Core::awayMessage(userId(), networkId()));
666 if (networkConfig()->autoWhoEnabled()) {
667 _autoWhoCycleTimer.start();
668 _autoWhoTimer.start();
669 startAutoWhoCycle(); // FIXME wait for autojoin to be completed
672 Core::bufferInfo(userId(), networkId(), BufferInfo::StatusBuffer); // create status buffer
673 Core::setNetworkConnected(userId(), networkId(), true);
677 void CoreNetwork::sendPerform()
679 BufferInfo statusBuf = BufferInfo::fakeStatusBuffer(networkId());
682 if (useAutoIdentify() && !autoIdentifyService().isEmpty() && !autoIdentifyPassword().isEmpty()) {
683 userInputHandler()->handleMsg(statusBuf, QString("%1 IDENTIFY %2").arg(autoIdentifyService(), autoIdentifyPassword()));
686 // restore old user modes if server default mode is set.
689 if (!me_->userModes().isEmpty()) {
693 connect(me_, SIGNAL(userModesSet(QString)), this, SLOT(restoreUserModes()));
694 connect(me_, SIGNAL(userModesAdded(QString)), this, SLOT(restoreUserModes()));
699 foreach(QString line, perform()) {
700 if (!line.isEmpty()) userInput(statusBuf, line);
703 // rejoin channels we've been in
704 if (rejoinChannels()) {
705 QStringList channels, keys;
706 foreach(QString chan, coreSession()->persistentChannels(networkId()).keys()) {
707 QString key = channelKey(chan);
708 if (!key.isEmpty()) {
709 channels.prepend(chan);
713 channels.append(chan);
716 QString joinString = QString("%1 %2").arg(channels.join(",")).arg(keys.join(",")).trimmed();
717 if (!joinString.isEmpty())
718 userInputHandler()->handleJoin(statusBuf, joinString);
723 void CoreNetwork::restoreUserModes()
728 disconnect(me_, SIGNAL(userModesSet(QString)), this, SLOT(restoreUserModes()));
729 disconnect(me_, SIGNAL(userModesAdded(QString)), this, SLOT(restoreUserModes()));
731 QString modesDelta = Core::userModes(userId(), networkId());
732 QString currentModes = me_->userModes();
734 QString addModes, removeModes;
735 if (modesDelta.contains('-')) {
736 addModes = modesDelta.section('-', 0, 0);
737 removeModes = modesDelta.section('-', 1);
740 addModes = modesDelta;
743 addModes.remove(QRegExp(QString("[%1]").arg(currentModes)));
744 if (currentModes.isEmpty())
745 removeModes = QString();
747 removeModes.remove(QRegExp(QString("[^%1]").arg(currentModes)));
749 if (addModes.isEmpty() && removeModes.isEmpty())
752 if (!addModes.isEmpty())
753 addModes = '+' + addModes;
754 if (!removeModes.isEmpty())
755 removeModes = '-' + removeModes;
757 // don't use InputHandler::handleMode() as it keeps track of our persistent mode changes
758 putRawLine(serverEncode(QString("MODE %1 %2%3").arg(me_->nick()).arg(addModes).arg(removeModes)));
762 void CoreNetwork::updateIssuedModes(const QString &requestedModes)
768 for (int i = 0; i < requestedModes.length(); i++) {
769 if (requestedModes[i] == '+') {
773 if (requestedModes[i] == '-') {
778 addModes += requestedModes[i];
781 removeModes += requestedModes[i];
785 QString addModesOld = _requestedUserModes.section('-', 0, 0);
786 QString removeModesOld = _requestedUserModes.section('-', 1);
788 addModes.remove(QRegExp(QString("[%1]").arg(addModesOld))); // deduplicate
789 addModesOld.remove(QRegExp(QString("[%1]").arg(removeModes))); // update
790 addModes += addModesOld;
792 removeModes.remove(QRegExp(QString("[%1]").arg(removeModesOld))); // deduplicate
793 removeModesOld.remove(QRegExp(QString("[%1]").arg(addModes))); // update
794 removeModes += removeModesOld;
796 _requestedUserModes = QString("%1-%2").arg(addModes).arg(removeModes);
800 void CoreNetwork::updatePersistentModes(QString addModes, QString removeModes)
802 QString persistentUserModes = Core::userModes(userId(), networkId());
804 QString requestedAdd = _requestedUserModes.section('-', 0, 0);
805 QString requestedRemove = _requestedUserModes.section('-', 1);
807 QString persistentAdd, persistentRemove;
808 if (persistentUserModes.contains('-')) {
809 persistentAdd = persistentUserModes.section('-', 0, 0);
810 persistentRemove = persistentUserModes.section('-', 1);
813 persistentAdd = persistentUserModes;
816 // remove modes we didn't issue
817 if (requestedAdd.isEmpty())
818 addModes = QString();
820 addModes.remove(QRegExp(QString("[^%1]").arg(requestedAdd)));
822 if (requestedRemove.isEmpty())
823 removeModes = QString();
825 removeModes.remove(QRegExp(QString("[^%1]").arg(requestedRemove)));
828 persistentAdd.remove(QRegExp(QString("[%1]").arg(addModes)));
829 persistentRemove.remove(QRegExp(QString("[%1]").arg(removeModes)));
832 persistentAdd.remove(QRegExp(QString("[%1]").arg(removeModes)));
833 persistentRemove.remove(QRegExp(QString("[%1]").arg(addModes)));
835 // update issued mode list
836 requestedAdd.remove(QRegExp(QString("[%1]").arg(addModes)));
837 requestedRemove.remove(QRegExp(QString("[%1]").arg(removeModes)));
838 _requestedUserModes = QString("%1-%2").arg(requestedAdd).arg(requestedRemove);
840 persistentAdd += addModes;
841 persistentRemove += removeModes;
842 Core::setUserModes(userId(), networkId(), QString("%1-%2").arg(persistentAdd).arg(persistentRemove));
846 void CoreNetwork::resetPersistentModes()
848 _requestedUserModes = QString('-');
849 Core::setUserModes(userId(), networkId(), QString());
853 void CoreNetwork::setUseAutoReconnect(bool use)
855 Network::setUseAutoReconnect(use);
857 _autoReconnectTimer.stop();
861 void CoreNetwork::setAutoReconnectInterval(quint32 interval)
863 Network::setAutoReconnectInterval(interval);
864 _autoReconnectTimer.setInterval(interval * 1000);
868 void CoreNetwork::setAutoReconnectRetries(quint16 retries)
870 Network::setAutoReconnectRetries(retries);
871 if (_autoReconnectCount != 0) {
872 if (unlimitedReconnectRetries())
873 _autoReconnectCount = -1;
875 _autoReconnectCount = autoReconnectRetries();
880 void CoreNetwork::doAutoReconnect()
882 if (connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting) {
883 qWarning() << "CoreNetwork::doAutoReconnect(): Cannot reconnect while not being disconnected!";
886 if (_autoReconnectCount > 0 || _autoReconnectCount == -1)
887 _autoReconnectCount--; // -2 means we delay the next reconnect
892 void CoreNetwork::sendPing()
894 uint now = QDateTime::currentDateTime().toTime_t();
895 if (_pingCount != 0) {
896 qDebug() << "UserId:" << userId() << "Network:" << networkName() << "missed" << _pingCount << "pings."
897 << "BA:" << socket.bytesAvailable() << "BTW:" << socket.bytesToWrite();
899 if ((int)_pingCount >= networkConfig()->maxPingCount() && now - _lastPingTime <= (uint)(_pingTimer.interval() / 1000) + 1) {
900 // the second check compares the actual elapsed time since the last ping and the pingTimer interval
901 // if the interval is shorter then the actual elapsed time it means that this thread was somehow blocked
902 // and unable to even handle a ping answer. So we ignore those misses.
903 disconnectFromIrc(false, QString("No Ping reply in %1 seconds.").arg(_pingCount * _pingTimer.interval() / 1000), true /* withReconnect */);
908 // Don't send pings until the network is initialized
910 userInputHandler()->handlePing(BufferInfo(), QString());
915 void CoreNetwork::enablePingTimeout(bool enable)
918 disablePingTimeout();
921 if (networkConfig()->pingTimeoutEnabled())
927 void CoreNetwork::disablePingTimeout()
935 void CoreNetwork::setPingInterval(int interval)
937 _pingTimer.setInterval(interval * 1000);
941 /******** Custom Rate Limiting ********/
943 void CoreNetwork::updateRateLimiting(const bool forceUnlimited)
945 // Verify and apply custom rate limiting options, always resetting the delay and burst size
946 // (safe-guarding against accidentally starting the timer), but don't reset the token bucket as
947 // this may be called while connected to a server.
949 if (useCustomMessageRate() || forceUnlimited) {
950 // Custom message rates enabled, or chosen by means of forcing unlimited. Let's go for it!
952 _messageDelay = messageRateDelay();
954 _burstSize = messageRateBurstSize();
955 if (_burstSize < 1) {
956 qWarning() << "Invalid messageRateBurstSize data, cannot have zero message burst size!"
958 // Can't go slower than one message at a time
962 if (_tokenBucket > _burstSize) {
963 // Don't let the token bucket exceed the maximum
964 _tokenBucket = _burstSize;
965 // To fill up the token bucket, use resetRateLimiting(). Don't do that here, otherwise
966 // changing the rate-limit settings while connected to a server will incorrectly reset
970 // Toggle the timer according to whether or not rate limiting is enabled
971 // If we're here, either useCustomMessageRate or forceUnlimited is true. Thus, the logic is
972 // _skipMessageRates = ((useCustomMessageRate && unlimitedMessageRate) || forceUnlimited)
973 // Override user preferences if called with force unlimited, only used during connect.
974 _skipMessageRates = (unlimitedMessageRate() || forceUnlimited);
975 if (_skipMessageRates) {
976 // If the message queue already contains messages, they need sent before disabling the
977 // timer. Set the timer to a rapid pace and let it disable itself.
978 if (_msgQueue.size() > 0) {
979 qDebug() << "Outgoing message queue contains messages while disabling rate "
980 "limiting. Sending remaining queued messages...";
981 // Promptly run the timer again to clear the messages. Rate limiting is disabled,
982 // so nothing should cause this to block.. in theory. However, don't directly call
983 // fillBucketAndProcessQueue() in order to keep it on a separate thread.
985 // TODO If testing shows this isn't needed, it can be simplified to a direct call.
986 // Hesitant to change it without a wide variety of situations to verify behavior.
987 _tokenBucketTimer.start(100);
989 // No rate limiting, disable the timer
990 _tokenBucketTimer.stop();
993 // Rate limiting enabled, enable the timer
994 _tokenBucketTimer.start(_messageDelay);
997 // Custom message rates disabled. Go for the default.
999 _skipMessageRates = false; // Enable rate-limiting by default
1000 _messageDelay = 2200; // This seems to be a safe value (2.2 seconds delay)
1001 _burstSize = 5; // 5 messages at once
1002 if (_tokenBucket > _burstSize) {
1003 // TokenBucket to avoid sending too much at once. Don't let the token bucket exceed the
1005 _tokenBucket = _burstSize;
1006 // To fill up the token bucket, use resetRateLimiting(). Don't do that here, otherwise
1007 // changing the rate-limit settings while connected to a server will incorrectly reset
1008 // the token bucket.
1010 // Rate limiting enabled, enable the timer
1011 _tokenBucketTimer.start(_messageDelay);
1015 void CoreNetwork::resetTokenBucket()
1017 // Fill up the token bucket to the maximum
1018 _tokenBucket = _burstSize;
1022 /******** IRCv3 Capability Negotiation ********/
1024 void CoreNetwork::serverCapAdded(const QString &capability)
1026 // Check if it's a known capability; if so, add it to the list
1027 // Handle special cases first
1028 if (capability == IrcCap::SASL) {
1029 // Only request SASL if it's enabled
1030 if (networkInfo().useSasl)
1031 queueCap(capability);
1032 } else if (IrcCap::knownCaps.contains(capability)) {
1033 // Handling for general known capabilities
1034 queueCap(capability);
1038 void CoreNetwork::serverCapAcknowledged(const QString &capability)
1040 // This may be called multiple times in certain situations.
1042 // Handle core-side configuration
1043 if (capability == IrcCap::AWAY_NOTIFY) {
1044 // away-notify enabled, stop the autoWho timers, handle manually
1045 setAutoWhoEnabled(false);
1048 // Handle capabilities that require further messages sent to the IRC server
1049 // If you change this list, ALSO change the list in CoreNetwork::capsRequiringServerMessages
1050 if (capability == IrcCap::SASL) {
1051 // If SASL mechanisms specified, limit to what's accepted for authentication
1052 // if the current identity has a cert set, use SASL EXTERNAL
1055 if (!identityPtr()->sslCert().isNull()) {
1056 if (IrcCap::SaslMech::maybeSupported(capValue(IrcCap::SASL), IrcCap::SaslMech::EXTERNAL)) {
1057 // EXTERNAL authentication supported, send request
1058 putRawLine(serverEncode("AUTHENTICATE EXTERNAL"));
1060 displayMsg(Message::Error, BufferInfo::StatusBuffer, "",
1061 tr("SASL EXTERNAL authentication not supported"));
1066 if (IrcCap::SaslMech::maybeSupported(capValue(IrcCap::SASL), IrcCap::SaslMech::PLAIN)) {
1067 // PLAIN authentication supported, send request
1068 // Only working with PLAIN atm, blowfish later
1069 putRawLine(serverEncode("AUTHENTICATE PLAIN"));
1071 displayMsg(Message::Error, BufferInfo::StatusBuffer, "",
1072 tr("SASL PLAIN authentication not supported"));
1081 void CoreNetwork::serverCapRemoved(const QString &capability)
1083 // This may be called multiple times in certain situations.
1085 // Handle special cases here
1086 if (capability == IrcCap::AWAY_NOTIFY) {
1087 // away-notify disabled, enable autoWho according to configuration
1088 setAutoWhoEnabled(networkConfig()->autoWhoEnabled());
1092 void CoreNetwork::queueCap(const QString &capability)
1094 // IRCv3 specs all use lowercase capability names
1095 QString _capLowercase = capability.toLower();
1097 if(capsRequiringConfiguration.contains(_capLowercase)) {
1098 // The capability requires additional configuration before being acknowledged (e.g. SASL),
1099 // so we should negotiate it separately from all other capabilities. Otherwise new
1100 // capabilities will be requested while still configuring the previous one.
1101 if (!_capsQueuedIndividual.contains(_capLowercase)) {
1102 _capsQueuedIndividual.append(_capLowercase);
1105 // The capability doesn't need any special configuration, so it should be safe to try
1106 // bundling together with others. "Should" being the imperative word, as IRC servers can do
1108 if (!_capsQueuedBundled.contains(_capLowercase)) {
1109 _capsQueuedBundled.append(_capLowercase);
1114 QString CoreNetwork::takeQueuedCaps()
1116 // Clear the record of the most recently negotiated capability bundle. Does nothing if the list
1118 _capsQueuedLastBundle.clear();
1120 // First, negotiate all the standalone capabilities that require additional configuration.
1121 if (!_capsQueuedIndividual.empty()) {
1122 // We have an individual capability available. Take the first and pass it back.
1123 return _capsQueuedIndividual.takeFirst();
1124 } else if (!_capsQueuedBundled.empty()) {
1125 // We have capabilities available that can be grouped. Try to fit in as many as within the
1127 // See CoreNetwork::maxCapRequestLength
1129 // Response must have at least one capability regardless of max length for anything to
1131 QString capBundle = _capsQueuedBundled.takeFirst();
1132 QString nextCap("");
1133 while (!_capsQueuedBundled.empty()) {
1134 // As long as capabilities remain, get the next...
1135 nextCap = _capsQueuedBundled.first();
1136 if ((capBundle.length() + 1 + nextCap.length()) <= maxCapRequestLength) {
1137 // [capability + 1 for a space + this new capability] fit within length limits
1138 // Add it to formatted list
1139 capBundle.append(" " + nextCap);
1140 // Add it to most recent bundle of requested capabilities (simplifies retry logic)
1141 _capsQueuedLastBundle.append(nextCap);
1142 // Then remove it from the queue
1143 _capsQueuedBundled.removeFirst();
1145 // We've reached the length limit for a single capability request, stop adding more
1149 // Return this space-separated set of capabilities, removing any extra spaces
1150 return capBundle.trimmed();
1152 // No capabilities left to negotiate, return an empty string.
1157 void CoreNetwork::retryCapsIndividually()
1159 // The most recent set of capabilities got denied by the IRC server. As we don't know what got
1160 // denied, try each capability individually.
1161 if (_capsQueuedLastBundle.empty()) {
1162 // No most recently tried capability set, just return.
1164 // Note: there's little point in retrying individually requested caps during negotiation.
1165 // We know the individual capability was the one that failed, and it's not likely it'll
1166 // suddenly start working within a few seconds. 'cap-notify' provides a better system for
1167 // handling capability removal and addition.
1170 // This should be fairly rare, e.g. services restarting during negotiation, so simplicity wins
1171 // over efficiency. If this becomes an issue, implement a binary splicing system instead,
1172 // keeping track of which halves of the group fail, dividing the set each time.
1174 // Add most recently tried capability set to individual list, re-requesting them one at a time
1175 _capsQueuedIndividual.append(_capsQueuedLastBundle);
1176 // Warn of this issue to explain the slower login. Servers usually shouldn't trigger this.
1177 displayMsg(Message::Server, BufferInfo::StatusBuffer, "",
1178 tr("Could not negotiate some capabilities, retrying individually (%1)...")
1179 .arg(_capsQueuedLastBundle.join(", ")));
1180 // Capabilities are already removed from the capability bundle queue via takeQueuedCaps(), no
1181 // need to remove them here.
1182 // Clear the most recently tried set to reduce risk that mistakes elsewhere causes retrying
1184 _capsQueuedLastBundle.clear();
1187 void CoreNetwork::beginCapNegotiation()
1189 // Don't begin negotiation if no capabilities are queued to request
1190 if (!capNegotiationInProgress()) {
1191 // If the server doesn't have any capabilities, but supports CAP LS, continue on with the
1192 // normal connection.
1193 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("No capabilities available"));
1194 endCapNegotiation();
1198 _capNegotiationActive = true;
1199 displayMsg(Message::Server, BufferInfo::StatusBuffer, "",
1200 tr("Ready to negotiate (found: %1)").arg(caps().join(", ")));
1202 // Build a list of queued capabilities, starting with individual, then bundled, only adding the
1203 // comma separator between the two if needed.
1204 QString queuedCapsDisplay =
1205 (!_capsQueuedIndividual.empty() ? _capsQueuedIndividual.join(", ") + ", " : "")
1206 + _capsQueuedBundled.join(", ");
1207 displayMsg(Message::Server, BufferInfo::StatusBuffer, "",
1208 tr("Negotiating capabilities (requesting: %1)...").arg(queuedCapsDisplay));
1213 void CoreNetwork::sendNextCap()
1215 if (capNegotiationInProgress()) {
1216 // Request the next set of capabilities and remove them from the list
1217 putRawLine(serverEncode(QString("CAP REQ :%1").arg(takeQueuedCaps())));
1219 // No pending desired capabilities, capability negotiation finished
1220 // If SASL requested but not available, print a warning
1221 if (networkInfo().useSasl && !capEnabled(IrcCap::SASL))
1222 displayMsg(Message::Error, BufferInfo::StatusBuffer, "",
1223 tr("SASL authentication currently not supported by server"));
1225 if (_capNegotiationActive) {
1226 displayMsg(Message::Server, BufferInfo::StatusBuffer, "",
1227 tr("Capability negotiation finished (enabled: %1)").arg(capsEnabled().join(", ")));
1228 _capNegotiationActive = false;
1231 endCapNegotiation();
1235 void CoreNetwork::endCapNegotiation()
1237 // If nick registration is already complete, CAP END is not required
1238 if (!_capInitialNegotiationEnded) {
1239 putRawLine(serverEncode(QString("CAP END")));
1240 _capInitialNegotiationEnded = true;
1244 /******** AutoWHO ********/
1246 void CoreNetwork::startAutoWhoCycle()
1248 if (!_autoWhoQueue.isEmpty()) {
1249 _autoWhoCycleTimer.stop();
1252 _autoWhoQueue = channels();
1255 void CoreNetwork::queueAutoWhoOneshot(const QString &channelOrNick)
1257 // Prepend so these new channels/nicks are the first to be checked
1258 // Don't allow duplicates
1259 if (!_autoWhoQueue.contains(channelOrNick.toLower())) {
1260 _autoWhoQueue.prepend(channelOrNick.toLower());
1262 if (capEnabled(IrcCap::AWAY_NOTIFY)) {
1263 // When away-notify is active, the timer's stopped. Start a new cycle to who this channel.
1264 setAutoWhoEnabled(true);
1269 void CoreNetwork::setAutoWhoDelay(int delay)
1271 _autoWhoTimer.setInterval(delay * 1000);
1275 void CoreNetwork::setAutoWhoInterval(int interval)
1277 _autoWhoCycleTimer.setInterval(interval * 1000);
1281 void CoreNetwork::setAutoWhoEnabled(bool enabled)
1283 if (enabled && isConnected() && !_autoWhoTimer.isActive())
1284 _autoWhoTimer.start();
1285 else if (!enabled) {
1286 _autoWhoTimer.stop();
1287 _autoWhoCycleTimer.stop();
1292 void CoreNetwork::sendAutoWho()
1294 // Don't send autowho if there are still some pending
1295 if (_autoWhoPending.count())
1298 while (!_autoWhoQueue.isEmpty()) {
1299 QString chanOrNick = _autoWhoQueue.takeFirst();
1300 // Check if it's a known channel or nick
1301 IrcChannel *ircchan = ircChannel(chanOrNick);
1302 IrcUser *ircuser = ircUser(chanOrNick);
1304 // Apply channel limiting rules
1305 // If using away-notify, don't impose channel size limits in order to capture away
1306 // state of everyone. Auto-who won't run on a timer so network impact is minimal.
1307 if (networkConfig()->autoWhoNickLimit() > 0
1308 && ircchan->ircUsers().count() >= networkConfig()->autoWhoNickLimit()
1309 && !capEnabled(IrcCap::AWAY_NOTIFY))
1311 _autoWhoPending[chanOrNick.toLower()]++;
1312 } else if (ircuser) {
1313 // Checking a nick, add it to the pending list
1314 _autoWhoPending[ircuser->nick().toLower()]++;
1316 // Not a channel or a nick, skip it
1317 qDebug() << "Skipping who polling of unknown channel or nick" << chanOrNick;
1320 if (supports("WHOX")) {
1321 // Use WHO extended to poll away users and/or user accounts
1322 // See http://faerion.sourceforge.net/doc/irc/whox.var
1323 // And https://github.com/hexchat/hexchat/blob/c874a9525c9b66f1d5ddcf6c4107d046eba7e2c5/src/common/proto-irc.c#L750
1324 putRawLine(serverEncode(QString("WHO %1 %%chtsunfra,%2")
1325 .arg(serverEncode(chanOrNick), QString::number(IrcCap::ACCOUNT_NOTIFY_WHOX_NUM))));
1327 putRawLine(serverEncode(QString("WHO %1").arg(chanOrNick)));
1332 if (_autoWhoQueue.isEmpty() && networkConfig()->autoWhoEnabled() && !_autoWhoCycleTimer.isActive()
1333 && !capEnabled(IrcCap::AWAY_NOTIFY)) {
1334 // Timer was stopped, means a new cycle is due immediately
1335 // Don't run a new cycle if using away-notify; server will notify as appropriate
1336 _autoWhoCycleTimer.start();
1337 startAutoWhoCycle();
1338 } else if (capEnabled(IrcCap::AWAY_NOTIFY) && _autoWhoCycleTimer.isActive()) {
1339 // Don't run another who cycle if away-notify is enabled
1340 _autoWhoCycleTimer.stop();
1346 void CoreNetwork::sslErrors(const QList<QSslError> &sslErrors)
1348 Server server = usedServer();
1349 if (server.sslVerify) {
1350 // Treat the SSL error as a hard error
1351 QString sslErrorMessage = tr("Encrypted connection couldn't be verified, disconnecting "
1352 "since verification is required");
1353 if (!sslErrors.empty()) {
1354 // Add the error reason if known
1355 sslErrorMessage.append(tr(" (Reason: %1)").arg(sslErrors.first().errorString()));
1357 displayMsg(Message::Error, BufferInfo::StatusBuffer, "", sslErrorMessage);
1359 // Disconnect, triggering a reconnect in case it's a temporary issue with certificate
1360 // validity, network trouble, etc.
1361 disconnectFromIrc(false, QString("Encrypted connection not verified"), true /* withReconnect */);
1363 // Treat the SSL error as a warning, continue to connect anyways
1364 QString sslErrorMessage = tr("Encrypted connection couldn't be verified, continuing "
1365 "since verification is not required");
1366 if (!sslErrors.empty()) {
1367 // Add the error reason if known
1368 sslErrorMessage.append(tr(" (Reason: %1)").arg(sslErrors.first().errorString()));
1370 displayMsg(Message::Info, BufferInfo::StatusBuffer, "", sslErrorMessage);
1372 // Proceed with the connection
1373 socket.ignoreSslErrors();
1380 void CoreNetwork::checkTokenBucket()
1382 if (_skipMessageRates) {
1383 if (_msgQueue.size() == 0) {
1384 // Message queue emptied; stop the timer and bail out
1385 _tokenBucketTimer.stop();
1388 // Otherwise, we're emptying the queue, continue on as normal
1391 // Process whatever messages are pending
1392 fillBucketAndProcessQueue();
1396 void CoreNetwork::fillBucketAndProcessQueue()
1398 // If there's less tokens than burst size, refill the token bucket by 1
1399 if (_tokenBucket < _burstSize) {
1403 // As long as there's tokens available and messages remaining, sending messages from the queue
1404 while (_msgQueue.size() > 0 && _tokenBucket > 0) {
1405 writeToSocket(_msgQueue.takeFirst());
1410 void CoreNetwork::writeToSocket(const QByteArray &data)
1413 socket.write("\r\n");
1414 if (!_skipMessageRates) {
1415 // Only subtract from the token bucket if message rate limiting is enabled
1421 Network::Server CoreNetwork::usedServer() const
1423 if (_lastUsedServerIndex < serverList().count())
1424 return serverList()[_lastUsedServerIndex];
1426 if (!serverList().isEmpty())
1427 return serverList()[0];
1429 return Network::Server();
1433 void CoreNetwork::requestConnect() const
1435 if (connectionState() != Disconnected) {
1436 qWarning() << "Requesting connect while already being connected!";
1439 QMetaObject::invokeMethod(const_cast<CoreNetwork *>(this), "connectToIrc", Qt::QueuedConnection);
1443 void CoreNetwork::requestDisconnect() const
1445 if (connectionState() == Disconnected) {
1446 qWarning() << "Requesting disconnect while not being connected!";
1449 userInputHandler()->handleQuit(BufferInfo(), QString());
1453 void CoreNetwork::requestSetNetworkInfo(const NetworkInfo &info)
1455 Network::Server currentServer = usedServer();
1456 setNetworkInfo(info);
1457 Core::updateNetwork(coreSession()->user(), info);
1459 // the order of the servers might have changed,
1460 // so we try to find the previously used server
1461 _lastUsedServerIndex = 0;
1462 for (int i = 0; i < serverList().count(); i++) {
1463 Network::Server server = serverList()[i];
1464 if (server.host == currentServer.host && server.port == currentServer.port) {
1465 _lastUsedServerIndex = i;
1472 QList<QList<QByteArray>> CoreNetwork::splitMessage(const QString &cmd, const QString &message, std::function<QList<QByteArray>(QString &)> cmdGenerator)
1474 QString wrkMsg(message);
1475 QList<QList<QByteArray>> msgsToSend;
1477 // do while (wrkMsg.size() > 0)
1479 // First, check to see if the whole message can be sent at once. The
1480 // cmdGenerator function is passed in by the caller and is used to encode
1481 // and encrypt (if applicable) the message, since different callers might
1482 // want to use different encoding or encode different values.
1483 int splitPos = wrkMsg.size();
1484 QList<QByteArray> initialSplitMsgEnc = cmdGenerator(wrkMsg);
1485 int initialOverrun = userInputHandler()->lastParamOverrun(cmd, initialSplitMsgEnc);
1487 if (initialOverrun) {
1488 // If the message was too long to be sent, first try splitting it along
1489 // word boundaries with QTextBoundaryFinder.
1490 QString splitMsg(wrkMsg);
1491 QTextBoundaryFinder qtbf(QTextBoundaryFinder::Word, splitMsg);
1492 qtbf.setPosition(initialSplitMsgEnc[1].size() - initialOverrun);
1493 QList<QByteArray> splitMsgEnc;
1494 int overrun = initialOverrun;
1497 splitPos = qtbf.toPreviousBoundary();
1499 // splitPos==-1 means the QTBF couldn't find a split point at all and
1500 // splitPos==0 means the QTBF could only find a boundary at the beginning of
1501 // the string. Neither one of these works for us.
1503 // If a split point could be found, split the message there, calculate the
1504 // overrun, and continue with the loop.
1505 splitMsg = splitMsg.left(splitPos);
1506 splitMsgEnc = cmdGenerator(splitMsg);
1507 overrun = userInputHandler()->lastParamOverrun(cmd, splitMsgEnc);
1510 // If a split point could not be found (the beginning of the message
1511 // is reached without finding a split point short enough to send) and we
1512 // are still in Word mode, switch to Grapheme mode. We also need to restore
1513 // the full wrkMsg to splitMsg, since splitMsg may have been cut down during
1514 // the previous attempt to find a split point.
1515 if (qtbf.type() == QTextBoundaryFinder::Word) {
1517 splitPos = splitMsg.size();
1518 QTextBoundaryFinder graphemeQtbf(QTextBoundaryFinder::Grapheme, splitMsg);
1519 graphemeQtbf.setPosition(initialSplitMsgEnc[1].size() - initialOverrun);
1520 qtbf = graphemeQtbf;
1523 // If the QTBF fails to find a split point in Grapheme mode, we give up.
1524 // This should never happen, but it should be handled anyway.
1525 qWarning() << "Unexpected failure to split message!";
1531 // Once a message of sendable length has been found, remove it from the wrkMsg and
1532 // add it to the list of messages to be sent.
1533 wrkMsg.remove(0, splitPos);
1534 msgsToSend.append(splitMsgEnc);
1537 // If the entire remaining message is short enough to be sent all at once, remove
1538 // it from the wrkMsg and add it to the list of messages to be sent.
1539 wrkMsg.remove(0, splitPos);
1540 msgsToSend.append(initialSplitMsgEnc);
1542 } while (wrkMsg.size() > 0);