/***************************************************************************
- * Copyright (C) 2005-2013 by the Quassel Project *
+ * Copyright (C) 2005-2016 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#include <QSettings>
#include <QTextCodec>
#include "network.h"
-#include "quassel.h"
QTextCodec *Network::_defaultCodecForServer = 0;
QTextCodec *Network::_defaultCodecForEncoding = 0;
QTextCodec *Network::_defaultCodecForDecoding = 0;
-QString Network::_networksIniPath = QString();
// ====================
// Public:
_autoReconnectInterval(60),
_autoReconnectRetries(10),
_unlimitedReconnectRetries(false),
+ _useCustomMessageRate(false),
+ _messageRateBurstSize(5),
+ _messageRateDelay(2200),
+ _unlimitedMessageRate(false),
_codecForServer(0),
_codecForEncoding(0),
_codecForDecoding(0),
}
+bool Network::isStatusMsg(const QString &target) const
+{
+ if (target.isEmpty())
+ return false;
+
+ if (supports("STATUSMSG"))
+ return support("STATUSMSG").contains(target[0]);
+ else
+ return QString("@+").contains(target[0]);
+}
+
+
NetworkInfo Network::networkInfo() const
{
NetworkInfo info;
info.autoReconnectRetries = autoReconnectRetries();
info.unlimitedReconnectRetries = unlimitedReconnectRetries();
info.rejoinChannels = rejoinChannels();
+ info.useCustomMessageRate = useCustomMessageRate();
+ info.messageRateBurstSize = messageRateBurstSize();
+ info.messageRateDelay = messageRateDelay();
+ info.unlimitedMessageRate = unlimitedMessageRate();
return info;
}
if (info.autoReconnectRetries != autoReconnectRetries()) setAutoReconnectRetries(info.autoReconnectRetries);
if (info.unlimitedReconnectRetries != unlimitedReconnectRetries()) setUnlimitedReconnectRetries(info.unlimitedReconnectRetries);
if (info.rejoinChannels != rejoinChannels()) setRejoinChannels(info.rejoinChannels);
+ // Custom rate limiting
+ if (info.useCustomMessageRate != useCustomMessageRate())
+ setUseCustomMessageRate(info.useCustomMessageRate);
+ if (info.messageRateBurstSize != messageRateBurstSize())
+ setMessageRateBurstSize(info.messageRateBurstSize);
+ if (info.messageRateDelay != messageRateDelay())
+ setMessageRateDelay(info.messageRateDelay);
+ if (info.unlimitedMessageRate != unlimitedMessageRate())
+ setUnlimitedMessageRate(info.unlimitedMessageRate);
}
}
+bool Network::saslMaybeSupports(const QString &saslMechanism) const
+{
+ if (!capAvailable(IrcCap::SASL)) {
+ // If SASL's not advertised at all, it's likely the mechanism isn't supported, as per specs.
+ // Unfortunately, we don't know for sure, but Quassel won't request SASL without it being
+ // advertised, anyways.
+ // This may also occur if the network's disconnected or negotiation hasn't yet happened.
+ return false;
+ }
+
+ // Get the SASL capability value
+ QString saslCapValue = capValue(IrcCap::SASL);
+ // SASL mechanisms are only specified in capability values as part of SASL 3.2. In SASL 3.1,
+ // it's handled differently. If we don't know via capability value, assume it's supported to
+ // reduce the risk of breaking existing setups.
+ // See: http://ircv3.net/specs/extensions/sasl-3.1.html
+ // And: http://ircv3.net/specs/extensions/sasl-3.2.html
+ return (saslCapValue.length() == 0)
+ || (saslCapValue.contains(saslMechanism, Qt::CaseInsensitive));
+}
+
+
IrcUser *Network::newIrcUser(const QString &hostmask, const QVariantMap &initData)
{
QString nick(nickFromMask(hostmask).toLower());
_ircUsers[nick] = ircuser;
- SYNC_OTHER(addIrcUser, ARG(hostmask))
- // emit ircUserAdded(hostmask);
+ // This method will be called with a nick instead of hostmask by setInitIrcUsersAndChannels().
+ // Not a problem because initData contains all we need; however, making sure here to get the real
+ // hostmask out of the IrcUser afterwards.
+ QString mask = ircuser->hostmask();
+ SYNC_OTHER(addIrcUser, ARG(mask));
+ // emit ircUserAdded(mask);
emit ircUserAdded(ircuser);
}
QList<IrcChannel *> channels = ircChannels();
_ircChannels.clear();
- foreach(IrcChannel *channel, channels) {
- proxy()->detachObject(channel);
- disconnect(channel, 0, this, 0);
- }
- foreach(IrcUser *user, users) {
- proxy()->detachObject(user);
- disconnect(user, 0, this, 0);
- }
-
- // the second loop is needed because quit can have sideffects
- foreach(IrcUser *user, users) {
- user->quit();
- }
-
qDeleteAll(users);
qDeleteAll(channels);
}
if (_defaultCodecForEncoding) {
return _defaultCodecForEncoding->fromUnicode(string);
}
- return string.toAscii();
+ return string.toLatin1();
}
if (_defaultCodecForServer) {
return _defaultCodecForServer->fromUnicode(string);
}
- return string.toAscii();
-}
-
-
-/*** Handle networks.ini ***/
-
-QStringList Network::presetNetworks(bool onlyDefault)
-{
- // lazily find the file, make sure to not call one of the other preset functions first (they'll fail else)
- if (_networksIniPath.isNull()) {
- _networksIniPath = Quassel::findDataFilePath("networks.ini");
- if (_networksIniPath.isNull()) {
- _networksIniPath = ""; // now we won't check again, as it's not null anymore
- return QStringList();
- }
- }
- if (!_networksIniPath.isEmpty()) {
- QSettings s(_networksIniPath, QSettings::IniFormat);
- QStringList networks = s.childGroups();
- if (!networks.isEmpty()) {
- // we sort the list case-insensitive
- QMap<QString, QString> sorted;
- foreach(QString net, networks) {
- if (onlyDefault && !s.value(QString("%1/Default").arg(net)).toBool())
- continue;
- sorted[net.toLower()] = net;
- }
- return sorted.values();
- }
- }
- return QStringList();
-}
-
-
-QStringList Network::presetDefaultChannels(const QString &networkName)
-{
- if (_networksIniPath.isEmpty()) // be sure to have called presetNetworks() first, else this always fails
- return QStringList();
- QSettings s(_networksIniPath, QSettings::IniFormat);
- return s.value(QString("%1/DefaultChannels").arg(networkName)).toStringList();
-}
-
-
-NetworkInfo Network::networkInfoFromPreset(const QString &networkName)
-{
- NetworkInfo info;
- if (!_networksIniPath.isEmpty()) {
- info.networkName = networkName;
- QSettings s(_networksIniPath, QSettings::IniFormat);
- s.beginGroup(info.networkName);
- foreach(QString server, s.value("Servers").toStringList()) {
- bool ssl = false;
- QStringList splitserver = server.split(':', QString::SkipEmptyParts);
- if (splitserver.count() != 2) {
- qWarning() << "Invalid server entry in networks.conf:" << server;
- continue;
- }
- if (splitserver[1].at(0) == '+')
- ssl = true;
- uint port = splitserver[1].toUInt();
- if (!port) {
- qWarning() << "Invalid port entry in networks.conf:" << server;
- continue;
- }
- info.serverList << Network::Server(splitserver[0].trimmed(), port, QString(), ssl);
- }
- }
- return info;
+ return string.toLatin1();
}
}
+void Network::setUseCustomMessageRate(bool useCustomRate)
+{
+ if (_useCustomMessageRate != useCustomRate) {
+ _useCustomMessageRate = useCustomRate;
+ SYNC(ARG(useCustomRate))
+ emit configChanged();
+ emit useCustomMessageRateSet(_useCustomMessageRate);
+ }
+}
+
+
+void Network::setMessageRateBurstSize(quint32 burstSize)
+{
+ if (burstSize < 1) {
+ // Can't go slower than one message at a time. Also blocks old clients from trying to set
+ // this to 0.
+ qDebug() << "Received invalid setMessageRateBurstSize data - message burst size must be "
+ "non-zero positive, given" << burstSize;
+ return;
+ }
+ if (_messageRateBurstSize != burstSize) {
+ _messageRateBurstSize = burstSize;
+ SYNC(ARG(burstSize))
+ emit configChanged();
+ emit messageRateBurstSizeSet(_messageRateBurstSize);
+ }
+}
+
+
+void Network::setMessageRateDelay(quint32 messageDelay)
+{
+ if (messageDelay == 0) {
+ // Nonsensical to have no delay - just check the Unlimited box instead. Also blocks old
+ // clients from trying to set this to 0.
+ qDebug() << "Received invalid setMessageRateDelay data - message delay must be non-zero "
+ "positive, given" << messageDelay;
+ return;
+ }
+ if (_messageRateDelay != messageDelay) {
+ _messageRateDelay = messageDelay;
+ SYNC(ARG(messageDelay))
+ emit configChanged();
+ emit messageRateDelaySet(_messageRateDelay);
+ }
+}
+
+
+void Network::setUnlimitedMessageRate(bool unlimitedRate)
+{
+ if (_unlimitedMessageRate != unlimitedRate) {
+ _unlimitedMessageRate = unlimitedRate;
+ SYNC(ARG(unlimitedRate))
+ emit configChanged();
+ emit unlimitedMessageRateSet(_unlimitedMessageRate);
+ }
+}
+
+
void Network::addSupport(const QString ¶m, const QString &value)
{
if (!_supports.contains(param)) {
return supports;
}
+void Network::addCap(const QString &capability, const QString &value)
+{
+ // IRCv3 specs all use lowercase capability names
+ QString _capLowercase = capability.toLower();
+ if (!_caps.contains(_capLowercase)) {
+ _caps[_capLowercase] = value;
+ SYNC(ARG(capability), ARG(value))
+ emit capAdded(_capLowercase);
+ }
+}
+void Network::acknowledgeCap(const QString &capability)
+{
+ // IRCv3 specs all use lowercase capability names
+ QString _capLowercase = capability.toLower();
+ if (!_capsEnabled.contains(_capLowercase)) {
+ _capsEnabled.append(_capLowercase);
+ SYNC(ARG(capability))
+ emit capAcknowledged(_capLowercase);
+ }
+}
+
+void Network::removeCap(const QString &capability)
+{
+ // IRCv3 specs all use lowercase capability names
+ QString _capLowercase = capability.toLower();
+ if (_caps.contains(_capLowercase)) {
+ // Remove from the list of available capabilities.
+ _caps.remove(_capLowercase);
+ // Remove it from the acknowledged list if it was previously acknowledged. The SYNC call
+ // ensures this propogates to the other side.
+ // Use removeOne() for speed; no more than one due to contains() check in acknowledgeCap().
+ _capsEnabled.removeOne(_capLowercase);
+ SYNC(ARG(capability))
+ emit capRemoved(_capLowercase);
+ }
+}
+
+void Network::clearCaps()
+{
+ // IRCv3 specs all use lowercase capability names
+ if (_caps.empty() && _capsEnabled.empty()) {
+ // Avoid the sync call if there's nothing to clear (e.g. failed reconnects)
+ return;
+ }
+ // To ease core-side configuration, loop through the list and emit capRemoved for each entry.
+ // If performance issues arise, this can be converted to a more-efficient setup without breaking
+ // protocol (in theory).
+ QString _capLowercase;
+ foreach (const QString &capability, _caps) {
+ _capLowercase = capability.toLower();
+ emit capRemoved(_capLowercase);
+ }
+ // Clear capabilities from the stored list
+ _caps.clear();
+ _capsEnabled.clear();
+
+ SYNC(NO_ARG)
+}
+
+QVariantMap Network::initCaps() const
+{
+ QVariantMap caps;
+ QHashIterator<QString, QString> iter(_caps);
+ while (iter.hasNext()) {
+ iter.next();
+ caps[iter.key()] = iter.value();
+ }
+ return caps;
+}
+
+
+// There's potentially a lot of users and channels, so it makes sense to optimize the format of this.
+// Rather than sending a thousand maps with identical keys, we convert this into one map containing lists
+// where each list index corresponds to a particular IrcUser. This saves sending the key names a thousand times.
+// Benchmarks have shown space savings of around 56%, resulting in saving several MBs worth of data on sync
+// (without compression) with a decent amount of IrcUsers.
QVariantMap Network::initIrcUsersAndChannels() const
{
QVariantMap usersAndChannels;
- QVariantMap users;
- QVariantMap channels;
-
- QHash<QString, IrcUser *>::const_iterator userIter = _ircUsers.constBegin();
- QHash<QString, IrcUser *>::const_iterator userIterEnd = _ircUsers.constEnd();
- while (userIter != userIterEnd) {
- users[userIter.value()->hostmask()] = userIter.value()->toVariantMap();
- userIter++;
+
+ if (_ircUsers.count()) {
+ QHash<QString, QVariantList> users;
+ QHash<QString, IrcUser *>::const_iterator it = _ircUsers.begin();
+ QHash<QString, IrcUser *>::const_iterator end = _ircUsers.end();
+ while (it != end) {
+ const QVariantMap &map = it.value()->toVariantMap();
+ QVariantMap::const_iterator mapiter = map.begin();
+ while (mapiter != map.end()) {
+ users[mapiter.key()] << mapiter.value();
+ ++mapiter;
+ }
+ ++it;
+ }
+ // Can't have a container with a value type != QVariant in a QVariant :(
+ // However, working directly on a QVariantMap is awkward for appending, thus the detour via the hash above.
+ QVariantMap userMap;
+ foreach(const QString &key, users.keys())
+ userMap[key] = users[key];
+ usersAndChannels["Users"] = userMap;
}
- usersAndChannels["users"] = users;
- QHash<QString, IrcChannel *>::const_iterator channelIter = _ircChannels.constBegin();
- QHash<QString, IrcChannel *>::const_iterator channelIterEnd = _ircChannels.constEnd();
- while (channelIter != channelIterEnd) {
- channels[channelIter.value()->name()] = channelIter.value()->toVariantMap();
- channelIter++;
+ if (_ircChannels.count()) {
+ QHash<QString, QVariantList> channels;
+ QHash<QString, IrcChannel *>::const_iterator it = _ircChannels.begin();
+ QHash<QString, IrcChannel *>::const_iterator end = _ircChannels.end();
+ while (it != end) {
+ const QVariantMap &map = it.value()->toVariantMap();
+ QVariantMap::const_iterator mapiter = map.begin();
+ while (mapiter != map.end()) {
+ channels[mapiter.key()] << mapiter.value();
+ ++mapiter;
+ }
+ ++it;
+ }
+ QVariantMap channelMap;
+ foreach(const QString &key, channels.keys())
+ channelMap[key] = channels[key];
+ usersAndChannels["Channels"] = channelMap;
}
- usersAndChannels["channels"] = channels;
return usersAndChannels;
}
{
Q_ASSERT(proxy());
if (isInitialized()) {
- qWarning() << "Network" << networkId() << "received init data for users and channels allthough there allready are known users or channels!";
+ qWarning() << "Network" << networkId() << "received init data for users and channels although there already are known users or channels!";
return;
}
- QVariantMap users = usersAndChannels.value("users").toMap();
- QVariantMap::const_iterator userIter = users.constBegin();
- QVariantMap::const_iterator userIterEnd = users.constEnd();
- while (userIter != userIterEnd) {
- newIrcUser(userIter.key(), userIter.value().toMap());
- userIter++;
+ // toMap() and toList() are cheap, so we can avoid copying to lists...
+ // However, we really have to make sure to never accidentally detach from the shared data!
+
+ const QVariantMap &users = usersAndChannels["Users"].toMap();
+
+ // sanity check
+ int count = users["nick"].toList().count();
+ foreach(const QString &key, users.keys()) {
+ if (users[key].toList().count() != count) {
+ qWarning() << "Received invalid usersAndChannels init data, sizes of attribute lists don't match!";
+ return;
+ }
+ }
+
+ // now create the individual IrcUsers
+ for(int i = 0; i < count; i++) {
+ QVariantMap map;
+ foreach(const QString &key, users.keys())
+ map[key] = users[key].toList().at(i);
+ newIrcUser(map["nick"].toString(), map); // newIrcUser() properly handles the hostmask being just the nick
}
- QVariantMap channels = usersAndChannels.value("channels").toMap();
- QVariantMap::const_iterator channelIter = channels.constBegin();
- QVariantMap::const_iterator channelIterEnd = channels.constEnd();
- while (channelIter != channelIterEnd) {
- newIrcChannel(channelIter.key(), channelIter.value().toMap());
- channelIter++;
+ // same thing for IrcChannels
+ const QVariantMap &channels = usersAndChannels["Channels"].toMap();
+
+ // sanity check
+ count = channels["name"].toList().count();
+ foreach(const QString &key, channels.keys()) {
+ if (channels[key].toList().count() != count) {
+ qWarning() << "Received invalid usersAndChannels init data, sizes of attribute lists don't match!";
+ return;
+ }
+ }
+ // now create the individual IrcChannels
+ for(int i = 0; i < count; i++) {
+ QVariantMap map;
+ foreach(const QString &key, channels.keys())
+ map[key] = channels[key].toList().at(i);
+ newIrcChannel(map["name"].toString(), map);
}
}
}
+void Network::initSetCaps(const QVariantMap &caps)
+{
+ QMapIterator<QString, QVariant> iter(caps);
+ while (iter.hasNext()) {
+ iter.next();
+ addCap(iter.key(), iter.value().toString());
+ }
+}
+
+
IrcUser *Network::updateNickFromMask(const QString &mask)
{
QString nick(nickFromMask(mask).toLower());
autoReconnectInterval(60),
autoReconnectRetries(20),
unlimitedReconnectRetries(false),
- rejoinChannels(true)
+ rejoinChannels(true),
+ useCustomMessageRate(false),
+ messageRateBurstSize(5),
+ messageRateDelay(2200),
+ unlimitedMessageRate(false)
{
}
if (autoReconnectRetries != other.autoReconnectRetries) return false;
if (unlimitedReconnectRetries != other.unlimitedReconnectRetries) return false;
if (rejoinChannels != other.rejoinChannels) return false;
+ // Custom rate limiting
+ if (useCustomMessageRate != other.useCustomMessageRate) return false;
+ if (messageRateBurstSize != other.messageRateBurstSize) return false;
+ if (messageRateDelay != other.messageRateDelay) return false;
+ if (unlimitedMessageRate != other.unlimitedMessageRate) return false;
return true;
}
i["AutoReconnectRetries"] = info.autoReconnectRetries;
i["UnlimitedReconnectRetries"] = info.unlimitedReconnectRetries;
i["RejoinChannels"] = info.rejoinChannels;
+ // Custom rate limiting
+ i["UseCustomMessageRate"] = info.useCustomMessageRate;
+ i["MessageRateBurstSize"] = info.messageRateBurstSize;
+ i["MessageRateDelay"] = info.messageRateDelay;
+ i["UnlimitedMessageRate"] = info.unlimitedMessageRate;
out << i;
return out;
}
info.autoReconnectRetries = i["AutoReconnectRetries"].toInt();
info.unlimitedReconnectRetries = i["UnlimitedReconnectRetries"].toBool();
info.rejoinChannels = i["RejoinChannels"].toBool();
+ // Custom rate limiting
+ info.useCustomMessageRate = i["UseCustomMessageRate"].toBool();
+ info.messageRateBurstSize = i["MessageRateBurstSize"].toUInt();
+ info.messageRateDelay = i["MessageRateDelay"].toUInt();
+ info.unlimitedMessageRate = i["UnlimitedMessageRate"].toBool();
return in;
}
<< " useSasl = " << i.useSasl << " saslAccount = " << i.saslAccount << " saslPassword = " << i.saslPassword
<< " useAutoReconnect = " << i.useAutoReconnect << " autoReconnectInterval = " << i.autoReconnectInterval
<< " autoReconnectRetries = " << i.autoReconnectRetries << " unlimitedReconnectRetries = " << i.unlimitedReconnectRetries
- << " rejoinChannels = " << i.rejoinChannels << ")";
+ << " rejoinChannels = " << i.rejoinChannels
+ << " useCustomMessageRate = " << i.useCustomMessageRate
+ << " messageRateBurstSize = " << i.messageRateBurstSize
+ << " messageRateDelay = " << i.messageRateDelay
+ << " unlimitedMessageRate = " << i.unlimitedMessageRate
+ << ")";
return dbg.space();
}
serverMap["Port"] = server.port;
serverMap["Password"] = server.password;
serverMap["UseSSL"] = server.useSsl;
+ serverMap["sslVerify"] = server.sslVerify;
serverMap["sslVersion"] = server.sslVersion;
serverMap["UseProxy"] = server.useProxy;
serverMap["ProxyType"] = server.proxyType;
server.port = serverMap["Port"].toUInt();
server.password = serverMap["Password"].toString();
server.useSsl = serverMap["UseSSL"].toBool();
+ server.sslVerify = serverMap["sslVerify"].toBool();
server.sslVersion = serverMap["sslVersion"].toInt();
server.useProxy = serverMap["UseProxy"].toBool();
server.proxyType = serverMap["ProxyType"].toInt();
if (port != other.port) return false;
if (password != other.password) return false;
if (useSsl != other.useSsl) return false;
+ if (sslVerify != other.sslVerify) return false;
if (sslVersion != other.sslVersion) return false;
if (useProxy != other.useProxy) return false;
if (proxyType != other.proxyType) return false;
QDebug operator<<(QDebug dbg, const Network::Server &server)
{
- dbg.nospace() << "Server(host = " << server.host << ":" << server.port << ", useSsl = " << server.useSsl << ")";
+ dbg.nospace() << "Server(host = " << server.host << ":" << server.port << ", useSsl = " <<
+ server.useSsl << ", sslVerify = " << server.sslVerify << ")";
return dbg.space();
}
projects / quassel.git / blobdiff