// Handle capability negotiation
// See: http://ircv3.net/specs/core/capability-negotiation-3.2.html
// And: http://ircv3.net/specs/core/capability-negotiation-3.1.html
- if (e->params().count() >= 3) {
- CoreNetwork *coreNet = coreNetwork(e);
- QString capCommand = e->params().at(1).trimmed().toUpper();
- if (capCommand == "LS" || capCommand == "NEW") {
- // Either we've gotten a list of capabilities, or new capabilities we may want
- // Server: CAP * LS * :multi-prefix extended-join account-notify batch invite-notify tls
- // Server: CAP * LS * :cap-notify server-time example.org/dummy-cap=dummyvalue example.org/second-dummy-cap
- // Server: CAP * LS :userhost-in-names sasl=EXTERNAL,DH-AES,DH-BLOWFISH,ECDSA-NIST256P-CHALLENGE,PLAIN
- bool capListFinished;
- QStringList availableCaps;
- if (e->params().count() == 4) {
- // Middle of multi-line reply, ignore the asterisk
- capListFinished = false;
- availableCaps = e->params().at(3).split(' ');
- } else {
- // Single line reply
- capListFinished = true;
+
+ // All commands require at least 2 parameters
+ if (!checkParamCount(e, 2))
+ return;
+
+ CoreNetwork *coreNet = coreNetwork(e);
+ QString capCommand = e->params().at(1).trimmed().toUpper();
+ if (capCommand == "LS" || capCommand == "NEW") {
+ // Either we've gotten a list of capabilities, or new capabilities we may want
+ // Server: CAP * LS * :multi-prefix extended-join account-notify batch invite-notify tls
+ // Server: CAP * LS * :cap-notify server-time example.org/dummy-cap=dummyvalue example.org/second-dummy-cap
+ // Server: CAP * LS :userhost-in-names sasl=EXTERNAL,DH-AES,DH-BLOWFISH,ECDSA-NIST256P-CHALLENGE,PLAIN
+ bool capListFinished;
+ QStringList availableCaps;
+ if (e->params().count() == 4) {
+ // Middle of multi-line reply, ignore the asterisk
+ capListFinished = false;
+ availableCaps = e->params().at(3).split(' ');
+ } else {
+ // Single line reply
+ capListFinished = true;
+ if (e->params().count() >= 3) {
+ // Some capabilities are specified, add them
availableCaps = e->params().at(2).split(' ');
+ } else {
+ // No capabilities available, add an empty list
+ availableCaps = QStringList();
}
- // Store what capabilities are available
- QStringList availableCapPair;
- for (int i = 0; i < availableCaps.count(); ++i) {
- // Capability may include values, e.g. CAP * LS :multi-prefix sasl=EXTERNAL
- availableCapPair = availableCaps[i].trimmed().split('=');
- if(availableCapPair.count() >= 2) {
- coreNet->addCap(availableCapPair.at(0).trimmed().toLower(), availableCapPair.at(1).trimmed());
- } else {
- coreNet->addCap(availableCapPair.at(0).trimmed().toLower());
- }
+ }
+ // Sort capabilities before requesting for consistency among networks. This may avoid
+ // unexpected cases when some networks offer capabilities in a different order than
+ // others. It also looks nicer in logs. Not required.
+ availableCaps.sort();
+ // Store what capabilities are available
+ QString availableCapName, availableCapValue;
+ for (int i = 0; i < availableCaps.count(); ++i) {
+ // Capability may include values, e.g. CAP * LS :multi-prefix sasl=EXTERNAL
+ // Capability name comes before the first '='. If no '=' exists, this gets the
+ // whole string instead.
+ availableCapName = availableCaps[i].section('=', 0, 0).trimmed();
+ // Some capabilities include multiple key=value pairs in the listing,
+ // e.g. "sts=duration=31536000,port=6697"
+ // Include everything after the first equal sign as part of the value. If no '='
+ // exists, this gets an empty string.
+ availableCapValue = availableCaps[i].section('=', 1).trimmed();
+ // Only add the capability if it's non-empty
+ if (!availableCapName.isEmpty()) {
+ coreNet->addCap(availableCapName, availableCapValue);
}
+ }
+
+ // Begin capability requests when capability listing complete
+ if (capListFinished)
+ coreNet->beginCapNegotiation();
+ } else if (capCommand == "ACK") {
+ // CAP ACK requires at least 3 parameters (no empty response allowed)
+ if (!checkParamCount(e, 3)) {
+ // If an invalid reply is sent, try to continue rather than getting stuck.
+ coreNet->sendNextCap();
+ return;
+ }
- // Begin capability requests when capability listing complete
- if (capListFinished)
- coreNet->beginCapNegotiation();
- } else if (capCommand == "ACK") {
- // Server: CAP * ACK :multi-prefix sasl
- // Got the capability we want, handle as needed.
- // As only one capability is requested at a time, no need to split
- QString acceptedCap = e->params().at(2).trimmed().toLower();
+ // Server: CAP * ACK :multi-prefix sasl
+ // Got the capabilities we want, handle as needed.
+ QStringList acceptedCaps;
+ acceptedCaps = e->params().at(2).split(' ');
+ // Store what capability was acknowledged
+ QString acceptedCap;
+
+ // Keep track of whether or not a capability requires further configuration. Due to queuing
+ // logic in CoreNetwork::queueCap(), this shouldn't ever happen when more than one
+ // capability is requested, but it's better to handle edge cases or faulty servers.
+ bool capsRequireConfiguration = false;
+
+ for (int i = 0; i < acceptedCaps.count(); ++i) {
+ acceptedCap = acceptedCaps[i].trimmed().toLower();
// Mark this cap as accepted
coreNet->acknowledgeCap(acceptedCap);
-
- if (!coreNet->capsRequiringConfiguration.contains(acceptedCap)) {
+ if (!capsRequireConfiguration &&
+ coreNet->capsRequiringConfiguration.contains(acceptedCap)) {
+ capsRequireConfiguration = true;
// Some capabilities (e.g. SASL) require further messages to finish. If so, do NOT
// send the next capability; it will be handled elsewhere in CoreNetwork.
- // Otherwise, move on to the next capability
- coreNet->sendNextCap();
- }
- } else if (capCommand == "NAK" || capCommand == "DEL") {
- // Either something went wrong with this capability, or it is no longer supported
- // > For CAP NAK
- // Server: CAP * NAK :multi-prefix sasl
- // > For CAP DEL
- // Server: :irc.example.com CAP modernclient DEL :multi-prefix sasl
- // CAP NAK and CAP DEL replies are always single-line
-
- QStringList removedCaps;
- removedCaps = e->params().at(2).split(' ');
-
- // Store what capability was denied or removed
- QString removedCap;
- for (int i = 0; i < removedCaps.count(); ++i) {
- removedCap = removedCaps[i].trimmed().toLower();
- // Mark this cap as removed
- coreNet->removeCap(removedCap);
+ // Otherwise, allow moving on to the next capability.
}
+ }
+ if (!capsRequireConfiguration) {
+ // No additional configuration required, move on to the next capability
+ coreNet->sendNextCap();
+ }
+ } else if (capCommand == "NAK" || capCommand == "DEL") {
+ // CAP NAK/DEL require at least 3 parameters (no empty response allowed)
+ if (!checkParamCount(e, 3)) {
if (capCommand == "NAK") {
- // Continue negotiation when capability listing complete only if this is the result
- // of a denied cap, not a removed cap
+ // If an invalid reply is sent, try to continue rather than getting stuck. This
+ // only matters for denied caps, not removed caps.
coreNet->sendNextCap();
}
+ return;
+ }
+
+ // Either something went wrong with the capabilities, or they are no longer supported
+ // > For CAP NAK
+ // Server: CAP * NAK :multi-prefix sasl
+ // > For CAP DEL
+ // Server: :irc.example.com CAP modernclient DEL :multi-prefix sasl
+ // CAP NAK and CAP DEL replies are always single-line
+
+ QStringList removedCaps;
+ removedCaps = e->params().at(2).split(' ');
+
+ // Store the capabilities that were denied or removed
+ QString removedCap;
+ for (int i = 0; i < removedCaps.count(); ++i) {
+ removedCap = removedCaps[i].trimmed().toLower();
+ // Mark this cap as removed.
+ // For CAP DEL, removes it from use.
+ // For CAP NAK when received before negotiation enabled these capabilities, removeCap()
+ // should do nothing. This merely guards against non-spec servers sending an
+ // unsolicited CAP ACK then later removing that capability.
+ coreNet->removeCap(removedCap);
+ }
+
+ if (capCommand == "NAK") {
+ // Continue negotiation only if this is the result of denied caps, not removed caps
+ if (removedCaps.count() > 1) {
+ // We've received a CAP NAK reply to multiple capabilities at once. Unfortunately,
+ // we don't know which capability failed and which ones are valid to re-request, so
+ // individually retry each capability from the failed bundle.
+ // See CoreNetwork::retryCapsIndividually() for more details.
+ coreNet->retryCapsIndividually();
+ // Still need to call sendNextCap() to carry on.
+ }
+ // Carry on with negotiation
+ coreNet->sendNextCap();
}
}
}
projects / quassel.git / blobdiff