core: Stop ratelimiting log spam with old client

[quassel.git] / src / common / network.cpp

diff --git a/src/common/network.cpp b/src/common/network.cpp
index cde2af7..3b1fe1d 100644 (file)
--- a/src/common/network.cpp
+++ b/src/common/network.cpp
@@ -50,6 +50,10 @@ Network::Network(const NetworkId &networkid, QObject *parent)
     _autoReconnectInterval(60),
     _autoReconnectRetries(10),
     _unlimitedReconnectRetries(false),
+    _useCustomMessageRate(false),
+    _messageRateBurstSize(5),
+    _messageRateDelay(2200),
+    _unlimitedMessageRate(false),
     _codecForServer(0),
     _codecForEncoding(0),
     _codecForDecoding(0),
@@ -112,6 +116,10 @@ NetworkInfo Network::networkInfo() const
     info.autoReconnectRetries = autoReconnectRetries();
     info.unlimitedReconnectRetries = unlimitedReconnectRetries();
     info.rejoinChannels = rejoinChannels();
+    info.useCustomMessageRate = useCustomMessageRate();
+    info.messageRateBurstSize = messageRateBurstSize();
+    info.messageRateDelay = messageRateDelay();
+    info.unlimitedMessageRate = unlimitedMessageRate();
     return info;
 }
 
@@ -138,6 +146,15 @@ void Network::setNetworkInfo(const NetworkInfo &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);
 }
 
 
@@ -224,6 +241,28 @@ QString Network::support(const QString &param) const
 }
 
 
+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());
@@ -676,6 +715,64 @@ void Network::setRejoinChannels(bool rejoin)
 }
 
 
+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 &param, const QString &value)
 {
     if (!_supports.contains(param)) {
@@ -746,6 +843,10 @@ void Network::removeCap(const QString &capability)
 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).
@@ -997,7 +1098,11 @@ NetworkInfo::NetworkInfo()
     autoReconnectInterval(60),
     autoReconnectRetries(20),
     unlimitedReconnectRetries(false),
-    rejoinChannels(true)
+    rejoinChannels(true),
+    useCustomMessageRate(false),
+    messageRateBurstSize(5),
+    messageRateDelay(2200),
+    unlimitedMessageRate(false)
 {
 }
 
@@ -1024,6 +1129,11 @@ bool NetworkInfo::operator==(const NetworkInfo &other) const
     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;
 }
 
@@ -1057,6 +1167,11 @@ QDataStream &operator<<(QDataStream &out, const NetworkInfo &info)
     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;
 }
@@ -1086,6 +1201,11 @@ QDataStream &operator>>(QDataStream &in, NetworkInfo &info)
     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;
 }
 
@@ -1099,7 +1219,12 @@ QDebug operator<<(QDebug dbg, const NetworkInfo &i)
     << " 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();
 }