839be0e316
The server is allowed to keep the counter after the session has expired, which allows a final ack to know wheter in-transit stanzas were delivered or not.
211 lines
8 KiB
Vala
211 lines
8 KiB
Vala
using Gee;
|
|
|
|
namespace Xmpp.Xep.StreamManagement {
|
|
|
|
public const string NS_URI = "urn:xmpp:sm:3";
|
|
|
|
public class Module : XmppStreamNegotiationModule, WriteNodeFunc {
|
|
public static ModuleIdentity<Module> IDENTITY = new ModuleIdentity<Module>(NS_URI, "0198_stream_management");
|
|
|
|
public int h_inbound = 0;
|
|
public int h_outbound = 0;
|
|
|
|
public string? session_id { get; set; default=null; }
|
|
public Gee.List<XmppStreamFlag> flags = null;
|
|
private HashMap<int, QueueItem> in_flight_stanzas = new HashMap<int, QueueItem>();
|
|
private Gee.List<QueueItem> node_queue = new ArrayList<QueueItem>();
|
|
|
|
private class QueueItem {
|
|
public StanzaNode node;
|
|
public Promise<IOError?> promise;
|
|
|
|
public QueueItem(StanzaNode node, Promise<IOError?> promise) {
|
|
this.node = node;
|
|
this.promise = promise;
|
|
}
|
|
}
|
|
|
|
public async void write_stanza(XmppStream stream, StanzaNode node) throws IOStreamError {
|
|
var promise = new Promise<IOError?>();
|
|
|
|
node_queue.add(new QueueItem(node, promise));
|
|
check_queue(stream);
|
|
|
|
try {
|
|
yield promise.future.wait_async();
|
|
} catch (FutureError e) {
|
|
throw new IOStreamError.WRITE("Future returned error %i".printf(e.code));
|
|
}
|
|
}
|
|
|
|
internal async void write_node(XmppStream stream, StanzaNode node) {
|
|
StanzaWriter? writer = ((IoXmppStream)stream).writer;
|
|
if (writer == null) return;
|
|
try {
|
|
stream.log.node("OUT", node, stream);
|
|
if (node.name == "message" || node.name == "iq" || node.name == "presence") {
|
|
var r_node = new StanzaNode.build("r", NS_URI).add_self_xmlns();
|
|
stream.log.node("OUT", r_node, stream);
|
|
yield ((!)writer).write_nodes(node, r_node);
|
|
} else {
|
|
yield ((!)writer).write_node(node);
|
|
}
|
|
} catch (XmlError e) { }
|
|
}
|
|
|
|
private void check_queue(XmppStream stream) {
|
|
while (!node_queue.is_empty && in_flight_stanzas.size < 10) {
|
|
QueueItem queue_item = node_queue.remove_at(0);
|
|
StanzaNode node = queue_item.node;
|
|
|
|
if (node.name == "message" || node.name == "iq" || node.name == "presence") {
|
|
in_flight_stanzas[++h_outbound] = queue_item;
|
|
}
|
|
write_node.begin(stream, node);
|
|
}
|
|
}
|
|
|
|
public override void attach(XmppStream stream) {
|
|
stream.get_module(Bind.Module.IDENTITY).bound_to_resource.connect(check_enable);
|
|
stream.received_features_node.connect(check_resume);
|
|
|
|
stream.received_nonza.connect(on_received_nonza);
|
|
stream.received_message_stanza.connect(on_stanza_received);
|
|
stream.received_presence_stanza.connect(on_stanza_received);
|
|
stream.received_iq_stanza.connect(on_stanza_received);
|
|
}
|
|
|
|
public override void detach(XmppStream stream) {
|
|
stream.get_module(Bind.Module.IDENTITY).bound_to_resource.disconnect(check_enable);
|
|
stream.received_features_node.disconnect(check_resume);
|
|
|
|
stream.received_nonza.disconnect(on_received_nonza);
|
|
stream.received_message_stanza.disconnect(on_stanza_received);
|
|
stream.received_presence_stanza.disconnect(on_stanza_received);
|
|
stream.received_iq_stanza.disconnect(on_stanza_received);
|
|
}
|
|
|
|
public static void require(XmppStream stream) {
|
|
if (stream.get_module(IDENTITY) == null) stream.add_module(new PrivateXmlStorage.Module());
|
|
}
|
|
|
|
public override bool mandatory_outstanding(XmppStream stream) { return false; }
|
|
|
|
public override bool negotiation_active(XmppStream stream) {
|
|
return stream.has_flag(Flag.IDENTITY) && !stream.get_flag(Flag.IDENTITY).finished;
|
|
}
|
|
|
|
public override string get_ns() { return NS_URI; }
|
|
public override string get_id() { return IDENTITY.id; }
|
|
|
|
private void on_stanza_received(XmppStream stream, StanzaNode node) {
|
|
h_inbound++;
|
|
}
|
|
|
|
private void check_resume(XmppStream stream) {
|
|
if (stream_has_sm_feature(stream) && session_id != null) {
|
|
StanzaNode node = new StanzaNode.build("resume", NS_URI).add_self_xmlns()
|
|
.put_attribute("h", h_inbound.to_string())
|
|
.put_attribute("previd", session_id);
|
|
write_node.begin(stream, node);
|
|
stream.add_flag(new Flag());
|
|
}
|
|
}
|
|
|
|
private void check_enable(XmppStream stream) {
|
|
if (stream_has_sm_feature(stream) && session_id == null) {
|
|
StanzaNode node = new StanzaNode.build("enable", NS_URI).add_self_xmlns().put_attribute("resume", "true");
|
|
write_node.begin(stream, node);
|
|
stream.add_flag(new Flag());
|
|
h_outbound = 0;
|
|
}
|
|
}
|
|
|
|
private void on_received_nonza(XmppStream stream, StanzaNode node) {
|
|
if (node.ns_uri == NS_URI) {
|
|
if (node.name == "r") {
|
|
send_ack(stream);
|
|
} else if (node.name == "a") {
|
|
handle_ack(stream, node);
|
|
} else if (node.name in new string[]{"enabled", "resumed", "failed"}) {
|
|
stream.get_flag(Flag.IDENTITY).finished = true;
|
|
|
|
if (node.name == "enabled") {
|
|
h_inbound = 0;
|
|
session_id = node.get_attribute("id", NS_URI);
|
|
flags = stream.flags;
|
|
((IoXmppStream)stream).write_obj = this;
|
|
} else if (node.name == "resumed") {
|
|
stream.get_flag(Flag.IDENTITY).resumed = true;
|
|
|
|
foreach (XmppStreamFlag flag in flags) {
|
|
stream.add_flag(flag);
|
|
}
|
|
|
|
h_outbound = int.parse(node.get_attribute("h", NS_URI));
|
|
handle_incoming_h(stream, h_outbound);
|
|
foreach (var id in in_flight_stanzas.keys) {
|
|
node_queue.add(in_flight_stanzas[id]);
|
|
}
|
|
in_flight_stanzas.clear();
|
|
check_queue(stream);
|
|
((IoXmppStream)stream).write_obj = this;
|
|
} else if (node.name == "failed") {
|
|
session_id = null;
|
|
string? h_acked = node.get_attribute("h", NS_URI);
|
|
if (h_acked != null) {
|
|
h_outbound = int.parse(h_acked);
|
|
handle_incoming_h(stream, h_outbound);
|
|
}
|
|
foreach (var id in in_flight_stanzas.keys) {
|
|
in_flight_stanzas[id].promise.set_exception(new IOStreamError.WRITE("Stanza not acked and session not resumed"));
|
|
}
|
|
in_flight_stanzas.clear();
|
|
check_queue(stream);
|
|
stream.received_features_node(stream);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private void send_ack(XmppStream stream) {
|
|
StanzaNode node = new StanzaNode.build("a", NS_URI).add_self_xmlns().put_attribute("h", h_inbound.to_string());
|
|
write_node.begin(stream, node);
|
|
}
|
|
|
|
private void handle_ack(XmppStream stream, StanzaNode node) {
|
|
string? h_acked = node.get_attribute("h", NS_URI);
|
|
int parsed_int = int.parse(h_acked);
|
|
handle_incoming_h(stream, parsed_int);
|
|
check_queue(stream);
|
|
}
|
|
|
|
private void handle_incoming_h(XmppStream stream, int h) {
|
|
var remove_nrs = new ArrayList<int>();
|
|
foreach (int nr in in_flight_stanzas.keys) {
|
|
if (nr <= h) {
|
|
remove_nrs.add(nr);
|
|
}
|
|
}
|
|
foreach (int nr in remove_nrs) {
|
|
in_flight_stanzas[nr].promise.set_value(null);
|
|
in_flight_stanzas.unset(nr);
|
|
}
|
|
}
|
|
|
|
private bool stream_has_sm_feature(XmppStream stream) {
|
|
return stream.features.get_subnode("sm", NS_URI) != null;
|
|
}
|
|
}
|
|
|
|
public class Flag : XmppStreamFlag {
|
|
public static FlagIdentity<Flag> IDENTITY = new FlagIdentity<Flag>(NS_URI, "stream_management");
|
|
public bool finished = false;
|
|
public bool resumed = false;
|
|
|
|
public override string get_ns() { return NS_URI; }
|
|
public override string get_id() { return IDENTITY.id; }
|
|
}
|
|
|
|
}
|