Merge branch 'mam-update' into 'master'

MAM Update

See merge request poezio/slixmpp!149

2 files changed, 445 insertions, 0 deletions

diff --git a/tests/test_stanza_xep_0313.py b/tests/test_stanza_xep_0313.py
new file mode 100644
index 00000000..ac5fcb14
--- /dev/null
+++ b/tests/test_stanza_xep_0313.py
@@ -0,0 +1,105 @@
+import unittest
+from slixmpp import JID, Iq, Message
+from slixmpp.test import SlixTest
+from slixmpp.plugins.xep_0313 import stanza
+from slixmpp.plugins.xep_0004.stanza import Form
+from slixmpp.plugins.xep_0297 import stanza as fstanza
+from slixmpp.plugins.xep_0059 import stanza as rstanza
+from slixmpp.xmlstream import register_stanza_plugin
+
+
+class TestMAM(SlixTest):
+
+    def setUp(self):
+        register_stanza_plugin(stanza.MAM, Form)
+        register_stanza_plugin(Iq, stanza.MAM)
+        register_stanza_plugin(Message, stanza.Result)
+        register_stanza_plugin(Iq, stanza.Fin)
+        register_stanza_plugin(
+            stanza.Result,
+            fstanza.Forwarded
+        )
+        register_stanza_plugin(stanza.MAM, rstanza.Set)
+        register_stanza_plugin(stanza.Fin, rstanza.Set)
+
+        register_stanza_plugin(Iq, stanza.Metadata)
+        register_stanza_plugin(stanza.Metadata, stanza.Start)
+        register_stanza_plugin(stanza.Metadata, stanza.End)
+
+    def testMAMQuery(self):
+        """Test that we can build a simple MAM query."""
+        iq = Iq()
+        iq['type'] = 'set'
+        iq['mam']['queryid'] = 'f27'
+
+        self.check(iq, """
+            <iq type='set'>
+              <query xmlns='urn:xmpp:mam:2' queryid='f27'/>
+            </iq>
+        """)
+
+    def testMAMQueryOptions(self):
+        """Test that we can build a mam query with all options."""
+        iq = Iq()
+        iq['type'] = 'set'
+        iq['mam']['with'] = JID('juliet@capulet.lit')
+        iq['mam']['start'] = '2010-06-07T00:00:00Z'
+        iq['mam']['end'] = '2010-07-07T13:23:54Z'
+        iq['mam']['after_id'] = 'id1'
+        iq['mam']['before_id'] = 'id2'
+        iq['mam']['ids'] = ['a', 'b', 'c']
+
+        self.check(iq, """
+            <iq type='set'>
+              <query xmlns='urn:xmpp:mam:2'>
+                <x xmlns='jabber:x:data' type='submit'>
+                  <field var='FORM_TYPE' type='hidden'>
+                    <value>urn:xmpp:mam:2</value>
+                  </field>
+                  <field var='with'>
+                    <value>juliet@capulet.lit</value>
+                  </field>
+                  <field var='start'>
+                    <value>2010-06-07T00:00:00Z</value>
+                  </field>
+                  <field var='end'>
+                    <value>2010-07-07T13:23:54Z</value>
+                  </field>
+                  <field var='after-id'>
+                    <value>id1</value>
+                  </field>
+                  <field var='before-id'>
+                    <value>id2</value>
+                  </field>
+                  <field var='ids'>
+                    <value>a</value>
+                    <value>b</value>
+                    <value>c</value>
+                  </field>
+                </x>
+              </query>
+            </iq>
+        """, use_values=False)
+
+    def testMAMMetadata(self):
+        """Test that we can build a MAM metadata payload"""
+
+        iq = Iq()
+        iq['type'] = 'result'
+        iq['mam_metadata']['start']['id'] = 'YWxwaGEg'
+        iq['mam_metadata']['start']['timestamp'] = '2008-08-22T21:09:04Z'
+        iq['mam_metadata']['end']['id'] = 'b21lZ2Eg'
+        iq['mam_metadata']['end']['timestamp'] = '2020-04-20T14:34:21Z'
+
+        self.check(iq, """
+            <iq type='result'>
+              <metadata xmlns='urn:xmpp:mam:2'>
+                <start id='YWxwaGEg' timestamp='2008-08-22T21:09:04Z' />
+                <end id='b21lZ2Eg' timestamp='2020-04-20T14:34:21Z' />
+              </metadata>
+            </iq>
+        """)
+
+
+
+suite = unittest.TestLoader().loadTestsFromTestCase(TestMAM)
diff --git a/tests/test_stream_xep_0313.py b/tests/test_stream_xep_0313.py
new file mode 100644
index 00000000..25a3a926
--- /dev/null
+++ b/tests/test_stream_xep_0313.py
@@ -0,0 +1,340 @@
+import unittest
+from datetime import datetime
+from slixmpp.test import SlixTest
+from slixmpp import JID
+
+
+class TestMAM(SlixTest):
+
+    def setUp(self):
+        self.stream_start(plugins=['xep_0313'])
+
+    def tearDown(self):
+        self.stream_close()
+
+    def testRetrieveSimple(self):
+        """Test requesting MAM messages without RSM"""
+
+        msgs = []
+
+        async def test():
+            iq = await self.xmpp['xep_0313'].retrieve()
+            for message in iq['mam']['results']:
+                msgs.append(message)
+
+        fut = self.xmpp.wrap(test())
+        self.wait_()
+        self.send("""
+            <iq type='set' id='1'>
+              <query xmlns='urn:xmpp:mam:2' queryid='1' />
+            </iq>
+        """)
+
+        self.recv("""
+            <message id='abc' to='tester@localhost/resource'>
+              <result xmlns='urn:xmpp:mam:2' queryid='1'
+                      id='28482-98726-73623'>
+                <forwarded xmlns='urn:xmpp:forward:0'>
+                  <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
+                  <message xmlns='jabber:client' from="witch@shakespeare.lit"
+                           to="tester@localhost">
+                    <body>Hail to thee</body>
+                  </message>
+                </forwarded>
+              </result>
+            </message>
+        """)
+
+        self.recv("""
+          <iq type="result" id="1" to="tester@localhost">
+            <fin xmlns="urn:xmpp:mam:2">
+              <first index='0'>28482-98726-73623</first>
+              <last>28482-98726-73623</last>
+            </fin>
+          </iq>
+        """)
+
+        self.run_coro(fut)
+        self.assertEqual(
+            msgs[0]['mam_result']['forwarded']['message']['body'],
+            "Hail to thee",
+        )
+        self.assertEqual(len(msgs),1)
+
+    def testRetrieveRSM(self):
+        """Test requesting MAM messages with RSM"""
+
+        msgs = []
+
+        async def test():
+            iterator = self.xmpp['xep_0313'].retrieve(
+                with_jid=JID('toto@titi'),
+                start='2010-06-07T00:00:00Z',
+                iterator=True,
+            )
+            async for page in iterator:
+                for message in page['mam']['results']:
+                    msgs.append(message)
+
+        fut = self.xmpp.wrap(test())
+        self.wait_()
+        self.send("""
+            <iq type='set' id='2'>
+              <query xmlns='urn:xmpp:mam:2' queryid='2'>
+                <x xmlns='jabber:x:data' type='submit'>
+                  <field var='FORM_TYPE' type='hidden'>
+                    <value>urn:xmpp:mam:2</value>
+                  </field>
+                  <field var='with'>
+                    <value>toto@titi</value>
+                  </field>
+                  <field var='start'>
+                    <value>2010-06-07T00:00:00Z</value>
+                  </field>
+                </x>
+                <set xmlns="http://jabber.org/protocol/rsm">
+                  <max>10</max>
+                </set>
+              </query>
+            </iq>
+        """)
+
+        self.recv("""
+            <message id='abc' to='tester@localhost/resource'>
+              <result xmlns='urn:xmpp:mam:2' queryid='2'
+                      id='28482-98726-73623'>
+                <forwarded xmlns='urn:xmpp:forward:0'>
+                  <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
+                  <message xmlns='jabber:client' from="witch@shakespeare.lit"
+                           to="tester@localhost">
+                    <body>Hail to thee</body>
+                  </message>
+                </forwarded>
+              </result>
+            </message>
+        """)
+
+        self.recv("""
+          <iq type="result" id="2" to="tester@localhost">
+            <fin xmlns="urn:xmpp:mam:2">
+              <set xmlns='http://jabber.org/protocol/rsm'>
+                <first index='0'>28482-98726-73623</first>
+                 <last>28482-98726-73623</last>
+                 <count>2</count>
+              </set>
+            </fin>
+          </iq>
+        """)
+
+        self.send("""
+            <iq type='set' id='3'>
+              <query xmlns='urn:xmpp:mam:2' queryid='3'>
+                <x xmlns='jabber:x:data' type='submit'>
+                  <field var='FORM_TYPE' type='hidden'>
+                    <value>urn:xmpp:mam:2</value>
+                  </field>
+                  <field var='with'>
+                    <value>toto@titi</value>
+                  </field>
+                  <field var='start'>
+                    <value>2010-06-07T00:00:00Z</value>
+                  </field>
+                </x>
+                <set xmlns="http://jabber.org/protocol/rsm">
+                  <max>10</max>
+                 <after>28482-98726-73623</after>
+                </set>
+              </query>
+            </iq>
+        """)
+
+        self.recv("""
+            <message id='abc' to='tester@localhost/resource'>
+              <result xmlns='urn:xmpp:mam:2' queryid='3'
+                      id='28482-98726-73624'>
+                <forwarded xmlns='urn:xmpp:forward:0'>
+                  <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:26Z'/>
+                  <message xmlns='jabber:client' from="witch@shakespeare.lit"
+                           to="tester@localhost">
+                    <body>Hi Y'all</body>
+                  </message>
+                </forwarded>
+              </result>
+            </message>
+        """)
+
+        self.recv("""
+          <iq type="result" id="3" to="tester@localhost">
+            <fin xmlns="urn:xmpp:mam:2">
+              <set xmlns='http://jabber.org/protocol/rsm'>
+                <first index='1'>28482-98726-73624</first>
+                 <last>28482-98726-73624</last>
+                 <count>2</count>
+              </set>
+            </fin>
+          </iq>
+        """)
+
+        self.run_coro(fut)
+        self.assertEqual(
+            msgs[0]['mam_result']['forwarded']['message']['body'],
+            "Hail to thee",
+        )
+        self.assertEqual(
+            msgs[1]['mam_result']['forwarded']['message']['body'],
+            "Hi Y'all",
+        )
+        self.assertEqual(len(msgs), 2)
+
+    def testIterate(self):
+        """Test iterating over MAM messages with RSM"""
+
+        msgs = []
+
+        async def test():
+            iterator = self.xmpp['xep_0313'].iterate(
+                with_jid=JID('toto@titi'),
+                start='2010-06-07T00:00:00Z',
+            )
+            async for message in iterator:
+                msgs.append(message)
+
+        fut = self.xmpp.wrap(test())
+        self.wait_()
+        self.send("""
+            <iq type='set' id='2'>
+              <query xmlns='urn:xmpp:mam:2' queryid='2'>
+                <x xmlns='jabber:x:data' type='submit'>
+                  <field var='FORM_TYPE' type='hidden'>
+                    <value>urn:xmpp:mam:2</value>
+                  </field>
+                  <field var='with'>
+                    <value>toto@titi</value>
+                  </field>
+                  <field var='start'>
+                    <value>2010-06-07T00:00:00Z</value>
+                  </field>
+                </x>
+                <set xmlns="http://jabber.org/protocol/rsm">
+                  <max>10</max>
+                </set>
+              </query>
+            </iq>
+        """)
+
+        self.recv("""
+            <message id='abc' to='tester@localhost/resource'>
+              <result xmlns='urn:xmpp:mam:2' queryid='2'
+                             id='28482-98726-73623'>
+                <forwarded xmlns='urn:xmpp:forward:0'>
+                  <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
+                  <message xmlns='jabber:client' from="witch@shakespeare.lit"
+                           to="tester@localhost">
+                    <body>Hail to thee</body>
+                  </message>
+                </forwarded>
+              </result>
+            </message>
+        """)
+
+        self.recv("""
+          <iq type="result" id="2" to="tester@localhost">
+            <fin xmlns="urn:xmpp:mam:2">
+              <set xmlns='http://jabber.org/protocol/rsm'>
+                <first index='0'>28482-98726-73623</first>
+                 <last>28482-98726-73623</last>
+                 <count>2</count>
+              </set>
+            </fin>
+          </iq>
+        """)
+
+        self.send("""
+            <iq type='set' id='3'>
+              <query xmlns='urn:xmpp:mam:2' queryid='3'>
+                <x xmlns='jabber:x:data' type='submit'>
+                  <field var='FORM_TYPE' type='hidden'>
+                    <value>urn:xmpp:mam:2</value>
+                  </field>
+                  <field var='with'>
+                    <value>toto@titi</value>
+                  </field>
+                  <field var='start'>
+                    <value>2010-06-07T00:00:00Z</value>
+                  </field>
+                </x>
+                <set xmlns="http://jabber.org/protocol/rsm">
+                  <max>10</max>
+                 <after>28482-98726-73623</after>
+                </set>
+              </query>
+            </iq>
+        """)
+
+        self.recv("""
+            <message id='abc' to='tester@localhost/resource'>
+              <result xmlns='urn:xmpp:mam:2' queryid='3'
+                      id='28482-98726-73624'>
+                <forwarded xmlns='urn:xmpp:forward:0'>
+                  <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:26Z'/>
+                  <message xmlns='jabber:client' from="witch@shakespeare.lit"
+                           to="tester@localhost">
+                    <body>Hi Y'all</body>
+                  </message>
+                </forwarded>
+              </result>
+            </message>
+        """)
+
+        self.recv("""
+          <iq type="result" id="3" to="tester@localhost">
+            <fin xmlns="urn:xmpp:mam:2">
+              <set xmlns='http://jabber.org/protocol/rsm'>
+                <first index='1'>28482-98726-73624</first>
+                 <last>28482-98726-73624</last>
+                 <count>2</count>
+              </set>
+            </fin>
+          </iq>
+        """)
+
+        self.run_coro(fut)
+        self.assertEqual(
+            msgs[0]['mam_result']['forwarded']['message']['body'],
+            "Hail to thee",
+        )
+        self.assertEqual(
+            msgs[1]['mam_result']['forwarded']['message']['body'],
+            "Hi Y'all",
+        )
+        self.assertEqual(len(msgs), 2)
+
+    def test_get_metadata(self):
+        """Test a MAM metadata retrieval"""
+        fut = self.xmpp.wrap(
+            self.xmpp.plugin['xep_0313'].get_archive_metadata()
+        )
+        self.wait_()
+        self.send("""
+            <iq type='get' id='1'>
+              <metadata xmlns='urn:xmpp:mam:2'/>
+            </iq>
+        """)
+        self.recv("""
+            <iq type='result' id='1'>
+              <metadata xmlns='urn:xmpp:mam:2'>
+                <start id='YWxwaGEg' timestamp='2008-08-22T21:09:04Z' />
+                <end id='b21lZ2Eg' timestamp='2020-04-20T14:34:21Z' />
+              </metadata>
+            </iq>
+        """)
+        self.run_coro(fut)
+        result = fut.result()
+        self.assertEqual(result['mam_metadata']['start']['id'], "YWxwaGEg")
+        self.assertEqual(
+            result['mam_metadata']['start']['timestamp'],
+            datetime.fromisoformat('2008-08-22T21:09:04+00:00')
+        )
+
+
+suite = unittest.TestLoader().loadTestsFromTestCase(TestMAM)