~singpolyma/biboumi

47ff1cd3116424342c79d173d30a0f118859bc9f — louiz 5 years ago eec8f68 + 96d460d
Merge branch 'mam_default_limit' into 'master'

Limit of 100 MAM messages, if no other limit has been set by the client

Closes #3256

See merge request !9
M CHANGELOG.rst => CHANGELOG.rst +2 -0
@@ 11,6 11,8 @@ Version 5.0
 - Use the udns library instead of c-ares, for asynchronous DNS resolution.
   It’s still fully optional.
 - Update MAM implementation to version 6.0 (namespace mam:2)
 - If the client doesn’t specify any limit, MAM results contain at most 100
   messages, instead of the whole archive.
 - Multiline topics are now properly handled

Version 4.1 - 2017-03-21

M src/xmpp/biboumi_component.cpp => src/xmpp/biboumi_component.cpp +6 -0
@@ 627,6 627,12 @@ bool BiboumiComponent::handle_mam_request(const Stanza& stanza)
            if (max)
              limit = std::atoi(max->get_inner().data());
          }
        // If the archive is really big, and the client didn’t specify any
        // limit, we avoid flooding it: we set an arbitrary max limit.
        if (limit == -1 && start.empty() && end.empty())
          {
            limit = 100;
          }
        const auto lines = Database::get_muc_logs(from.bare(), iid.get_local(), iid.get_server(), limit, start, end);
        for (const db::MucLogLine& line: lines)
        {

M tests/end_to_end/__main__.py => tests/end_to_end/__main__.py +53 -0
@@ 423,6 423,7 @@ def connection_begin_sequence(irc_host, jid):
            xpath_re % (r'^%s: (\*\*\* Checking Ident|\*\*\* Looking up your hostname\.\.\.|\*\*\* Found your hostname: .*|ACK multi-prefix|\*\*\* Got Ident response)$' % 'irc.localhost')),
    partial(expect_stanza,
            xpath_re % (r'^%s: (\*\*\* Checking Ident|\*\*\* Looking up your hostname\.\.\.|\*\*\* Found your hostname: .*|ACK multi-prefix|\*\*\* Got Ident response)$' % 'irc.localhost')),
    partial(expect_stanza, xpath_re % (r'^%s: \*\*\* You are exempt from flood limits$' % 'irc.localhost')),
    )

def connection_tls_begin_sequence(irc_host, jid):


@@ 446,6 447,7 @@ def connection_tls_begin_sequence(irc_host, jid):
                xpath_re % (r'^%s: (\*\*\* Checking Ident|\*\*\* Looking up your hostname\.\.\.|\*\*\* Found your hostname: .*|ACK multi-prefix|\*\*\* Got Ident response)$' % irc_host)),
        partial(expect_stanza,
                xpath_re % (r'^%s: (\*\*\* Checking Ident|\*\*\* Looking up your hostname\.\.\.|\*\*\* Found your hostname: .*|ACK multi-prefix|\*\*\* Got Ident response)$' % irc_host)),
        partial(expect_stanza, xpath_re % (r'^%s: \*\*\* You are exempt from flood limits$' % 'irc.localhost')),
    )

def connection_end_sequence(irc_host, jid):


@@ 491,9 493,15 @@ def extract_attribute(xpath, name, stanza):
    return matched[0].get(name)


def extract_text(xpath, stanza):
    matched = match(stanza, xpath)
    return matched[0].text


def save_value(name, func, stanza, xmpp):
    xmpp.saved_values[name] = func(stanza)


if __name__ == '__main__':

    atexit.register(asyncio.get_event_loop().close)


@@ 1697,6 1705,51 @@ if __name__ == '__main__':
                              "/message/mam:result[@queryid='qid1']/forward:forwarded/client:message[@from='#foo@{biboumi_host}/{nick_one}'][@type='groupchat']/client:body[text()='coucou 2']")
                             ),
                 ], conf="fixed_server"),
         Scenario("default_mam_limit",
                 [
                     handshake_sequence(),
                     partial(send_stanza,
                             "<presence from='{jid_one}/{resource_one}' to='#foo%{irc_server_one}/{nick_one}' />"),
                     connection_sequence("irc.localhost", '{jid_one}/{resource_one}'),
                     partial(expect_stanza,
                             "/message/body[text()='Mode #foo [+nt] by {irc_host_one}']"),
                     partial(expect_stanza,
                            ("/presence[@to='{jid_one}/{resource_one}'][@from='#foo%{irc_server_one}/{nick_one}']/muc_user:x/muc_user:item[@affiliation='admin'][@role='moderator']",
                             "/presence/muc_user:x/muc_user:status[@code='110']")
                      ),
                     partial(expect_stanza, "/message[@from='#foo%{irc_server_one}'][@type='groupchat']/subject[not(text())]",
                             after = partial(save_value, "counter", lambda x: 0)),
                 ] + [
                     partial(send_stanza, "<message from='{jid_one}/{resource_one}' to='#foo%{irc_server_one}' type='groupchat'><body>{counter}</body></message>"),
                     partial(expect_stanza,
                             "/message[@from='#foo%{irc_server_one}/{nick_one}'][@to='{jid_one}/{resource_one}'][@type='groupchat']/body[text()='{counter}']",
                             after = partial(save_value, "counter", lambda stanza: str(1 + int(extract_text("/message/body", stanza))))
                             ),
                 ] * 150 + [
                    # Retrieve the archive, without any restriction
                    partial(send_stanza, "<iq to='#foo%{irc_server_one}' from='{jid_one}/{resource_one}' type='set' id='id1'><query xmlns='urn:xmpp:mam:2' queryid='qid1' /></iq>"),
                    # Since we should only receive the last 100 messages from the archive,
                    # it should start with message "50"
                    partial(expect_stanza,
                            ("/message/mam:result[@queryid='qid1']/forward:forwarded/delay:delay",
                            "/message/mam:result[@queryid='qid1']/forward:forwarded/client:message[@from='#foo%{irc_server_one}/{nick_one}'][@type='groupchat']/client:body[text()='50']")
                            ),
                 ] + [
                     # followed by 98 more messages
                    partial(expect_stanza,
                            ("/message/mam:result[@queryid='qid1']/forward:forwarded/delay:delay",
                            "/message/mam:result[@queryid='qid1']/forward:forwarded/client:message[@from='#foo%{irc_server_one}/{nick_one}'][@type='groupchat']/client:body")
                            ),
                  ] * 98 + [
                     # and finally the message "149"
                    partial(expect_stanza,
                            ("/message/mam:result[@queryid='qid1']/forward:forwarded/delay:delay",
                            "/message/mam:result[@queryid='qid1']/forward:forwarded/client:message[@from='#foo%{irc_server_one}/{nick_one}'][@type='groupchat']/client:body[text()='149']")
                            ),
                    partial(expect_stanza,
                            "/iq[@type='result'][@id='id1'][@from='#foo%{irc_server_one}'][@to='{jid_one}/{resource_one}']"),

                  ]),
        Scenario("channel_history_on_fixed_server",
                 [
                     handshake_sequence(),

M tests/end_to_end/ircd.conf => tests/end_to_end/ircd.conf +1 -0
@@ 221,6 221,7 @@ auth {
auth {
	user = "*@*";
	class = "users";
        flags = flood_exempt;
};

/* privset {} blocks MUST be specified before anything that uses them.  That