Merge remote-tracking branch 'origin/mr/46'

MAM refactoring!

5 files changed, 104 insertions, 78 deletions

diff --git a/poezio/core/core.py b/poezio/core/core.py
index a99b47d9..5b18a8e1 100644
--- a/poezio/core/core.py
+++ b/poezio/core/core.py
@@ -2010,7 +2010,7 @@ class Core:
                     show=self.status.show,
                     tab=tab)
                 if tab._text_buffer.last_message is None:
-                    mam.mam_scroll(tab, action='query')
+                    asyncio.ensure_future(mam.on_tab_open(tab))
 
     def check_bookmark_storage(self, features):
         private = 'jabber:iq:private' in features
diff --git a/poezio/mam.py b/poezio/mam.py
index 514c7b60..919bb6dd 100644
--- a/poezio/mam.py
+++ b/poezio/mam.py
@@ -9,12 +9,20 @@
 import asyncio
 import random
 from datetime import datetime, timedelta, timezone
+from slixmpp import JID
 from slixmpp.exceptions import IqError, IqTimeout
 from poezio.theming import get_theme
 from poezio import tabs
 from poezio import xhtml, colors
 from poezio.config import config
 from poezio.text_buffer import Message, TextBuffer
+from typing import List, Optional, Callable
+
+
+class DiscoInfoException(Exception): pass
+class MAMQueryException(Exception): pass
+class NoMAMSupportException(Exception): pass
+
 
 def add_line(tab, text_buffer: TextBuffer, text: str, str_time: str, nick: str, top: bool):
     """Adds a textual entry in the TextBuffer"""
@@ -62,62 +70,68 @@ def add_line(tab, text_buffer: TextBuffer, text: str, str_time: str, nick: str,
         jid=None,
     )
 
-async def query(tab, remote_jid, action, top, start=None, end=None, before=None):
-    text_buffer = tab._text_buffer
+async def query(
+        core,
+        groupchat: bool,
+        remote_jid: JID,
+        amount: int,
+        reverse: bool,
+        start: Optional[datetime] = None,
+        end: Optional[datetime] = None,
+        before: Optional[str] = None,
+        callback: Optional[Callable] = None,
+    ) -> None:
     try:
-        iq = await tab.core.xmpp.plugin['xep_0030'].get_info(jid=remote_jid)
+        iq = await core.xmpp.plugin['xep_0030'].get_info(jid=remote_jid)
     except (IqError, IqTimeout):
-        return tab.core.information('Failed to retrieve messages', 'Error')
-    if 'urn:xmpp:mam:2' not in iq['disco_info'].get_features() and action is 'scroll':
-        return tab.core.information("%s doesn't support MAM." % remote_jid, "Info")
-    if top:
-        if isinstance(tab, tabs.MucTab):
-            try:
-                if before is not None:
-                    results = tab.core.xmpp['xep_0313'].retrieve(jid=remote_jid,
-                    iterator=True, reverse=top, rsm={'before':before})
-                else:
-                    results = tab.core.xmpp['xep_0313'].retrieve(jid=remote_jid,
-                    iterator=True, reverse=top, end=end)
-            except (IqError, IqTimeout):
-                if action is 'scroll':
-                    return tab.core.information('Failed to retrieve messages', 'Error')
-        else:
-            try:
-                if before is not None:
-                    results = tab.core.xmpp['xep_0313'].retrieve(with_jid=remote_jid,
-                    iterator=True, reverse=top, rsm={'before':before})
-                else:
-                    results = tab.core.xmpp['xep_0313'].retrieve(with_jid=remote_jid,
-                    iterator=True, reverse=top, end=end)
-            except (IqError, IqTimeout):
-                if action is 'scroll':
-                    return tab.core.information('Failed to retrieve messages', 'Error')
+        raise DiscoInfoException
+    if 'urn:xmpp:mam:2' not in iq['disco_info'].get_features():
+        raise NoMAMSupportException
+
+    args = {
+        'iterator': True,
+        'reverse': reverse,
+    }
+
+    if groupchat:
+        args['jid'] = remote_jid
     else:
-        if 'conference' in list(iq['disco_info']['identities'])[0]:
-            try:
-                results = tab.core.xmpp['xep_0313'].retrieve(jid=remote_jid,
-                iterator=True, reverse=top, start=start, end=end)
-            except (IqError, IqTimeout):
-                return tab.core.information('Failed to retrieve messages', 'Error')
+        args['with_jid'] = remote_jid
+
+    args['rsm'] = {'max': amount}
+    if reverse:
+        if before is not None:
+            args['rsm']['before'] = before
         else:
-            try:
-                results = tab.core.xmpp['xep_0313'].retrieve(with_jid=remote_jid,
-                iterator=True, reverse=top, start=start, end=end)
-            except (IqError, IqTimeout):
-                return tab.core.information('Failed to retrieve messages', 'Error')
+            args['end'] = end
+    else:
+        args['rsm']['start'] = start
+        if before is not None:
+            args['rsm']['end'] = end
+    try:
+        results = core.xmpp['xep_0313'].retrieve(**args)
+    except (IqError, IqTimeout):
+        raise MAMQueryException
+    if callback is not None:
+        callback(results)
+
+    return results
+
+async def add_messages_to_buffer(tab, top: bool, results, amount: int) -> None:
+    """Prepends or appends messages to the tab text_buffer"""
+
+    text_buffer = tab._text_buffer
     msg_count = 0
     msgs = []
     async for rsm in results:
         if top:
             for msg in rsm['mam']['results']:
-                if msg['mam_result']['forwarded']['stanza'].xml.find(
-                    '{%s}%s' % ('jabber:client', 'body')) is not None:
+                if msg['mam_result']['forwarded']['stanza'] \
+                .xml.find('{%s}%s' % ('jabber:client', 'body')) is not None:
                     msgs.append(msg)
-                if msg_count == 10:
-                    tab.query_status = False
+                if msg_count == amount:
                     tab.core.refresh_window()
-                    return
+                    return False
                 msg_count += 1
             msgs.reverse()
             for msg in msgs:
@@ -127,8 +141,6 @@ async def query(tab, remote_jid, action, top, start=None, end=None, before=None)
                 tab.last_stanza_id = msg['mam_result']['id']
                 nick = str(message['from'])
                 add_line(tab, text_buffer, message['body'], timestamp, nick, top)
-                if action is 'scroll':
-                    tab.text_win.scroll_up(len(tab.text_win.built_lines))
         else:
             for msg in rsm['mam']['results']:
                 forwarded = msg['mam_result']['forwarded']
@@ -137,34 +149,47 @@ async def query(tab, remote_jid, action, top, start=None, end=None, before=None)
                 nick = str(message['from'])
                 add_line(tab, text_buffer, message['body'], timestamp, nick, top)
                 tab.core.refresh_window()
-    if len(msgs) == 0 and action is 'scroll':
-        return tab.core.information('No more messages left to retrieve', 'Info')
-    tab.query_status = False
+    return False
 
-def mam_scroll(tab, action):
+async def fetch_history(tab, end: Optional[datetime] = None, amount: Optional[int] = None):
     remote_jid = tab.jid
-    text_buffer = tab._text_buffer
     before = tab.last_stanza_id
-    end = datetime.now()
-    if isinstance(tab, tabs.MucTab) is False:
-        for message in text_buffer.messages:
-            time = message.time
-            if time < end:
-                end = time
-        end = end + timedelta(seconds=-1)
+    if end is None:
+        end = datetime.now()
     tzone = datetime.now().astimezone().tzinfo
     end = end.replace(tzinfo=tzone).astimezone(tz=timezone.utc)
     end = end.replace(tzinfo=None)
     end = datetime.strftime(end, '%Y-%m-%dT%H:%M:%SZ')
-    pos = tab.text_win.pos
-    tab.text_win.pos += tab.text_win.height - 1
-    if tab.text_win.pos + tab.text_win.height > len(tab.text_win.built_lines):
-        if before is None:
-            asyncio.ensure_future(query(tab, remote_jid, action, top=True, end=end))
-        else:
-            asyncio.ensure_future(query(tab, remote_jid, action, top=True, before=before))
-        tab.query_status = True
-        tab.text_win.pos = len(tab.text_win.built_lines) - tab.text_win.height
-        if tab.text_win.pos < 0:
-            tab.text_win.pos = 0
-    return tab.text_win.pos != pos
+
+    if amount >= 100:
+        amount = 99
+
+    groupchat = isinstance(tab, tabs.MucTab)
+
+    results = await query(tab.core, groupchat, remote_jid, amount, reverse=True, end=end, before=before)
+    query_status = await add_messages_to_buffer(tab, True, results, amount)
+    tab.query_status = query_status
+
+async def on_tab_open(tab) -> None:
+    amount = 2 * tab.text_win.height
+    end = datetime.now()
+    for message in tab._text_buffer.messages:
+        time = message.time
+        if time < end:
+            end = time
+    end = end + timedelta(seconds=-1)
+    try:
+        await fetch_history(tab, end=end, amount=amount)
+    except (NoMAMSupportException, MAMQueryException, DiscoInfoException):
+        return None
+
+async def on_scroll_up(tab) -> None:
+    amount = tab.text_win.height
+    try:
+        await fetch_history(tab, amount=amount)
+    except NoMAMSupportException:
+        tab.core.information('MAM not supported for %r' % tab.jid, 'Info')
+        return None
+    except (MAMQueryException, DiscoInfoException):
+        tab.core.information('An error occured when fetching MAM for %r' % tab.jid, 'Error')
+        return None
diff --git a/poezio/tabs/basetabs.py b/poezio/tabs/basetabs.py
index 22601ec7..e3ae7d9d 100644
--- a/poezio/tabs/basetabs.py
+++ b/poezio/tabs/basetabs.py
@@ -15,6 +15,7 @@ revolving around chats.
 
 import logging
 import string
+import asyncio
 import time
 from datetime import datetime
 from xml.etree import cElementTree as ET
@@ -916,10 +917,9 @@ class ChatTab(Tab):
         return self.text_win.scroll_down(1)
 
     def on_scroll_up(self):
-        if self.query_status:
-            return self.text_win.scroll_up(self.text_win.height - 1)
-        else:
-            return mam.mam_scroll(tab=self, action='scroll')
+        if not self.query_status:
+            asyncio.ensure_future(mam.on_scroll_up(tab=self))
+        return self.text_win.scroll_up(self.text_win.height - 1)
 
     def on_scroll_down(self):
         return self.text_win.scroll_down(self.text_win.height - 1)
diff --git a/poezio/tabs/muctab.py b/poezio/tabs/muctab.py
index d9c09b7c..3e754ae6 100644
--- a/poezio/tabs/muctab.py
+++ b/poezio/tabs/muctab.py
@@ -10,6 +10,7 @@ user list, and updates private tabs when necessary.
 import bisect
 import curses
 import logging
+import asyncio
 import os
 import random
 import re
@@ -157,7 +158,7 @@ class MucTab(ChatTab):
             status=status.message,
             show=status.show,
             seconds=seconds)
-        mam.mam_scroll(self, action='query')
+        asyncio.ensure_future(mam.on_tab_open(self))
 
     def leave_room(self, message: str):
         if self.joined:
diff --git a/poezio/text_buffer.py b/poezio/text_buffer.py
index 526e4b69..d9347527 100644
--- a/poezio/text_buffer.py
+++ b/poezio/text_buffer.py
@@ -181,7 +181,7 @@ class TextBuffer:
                 nick_size=nick_size)
             if ret_val == 0:
                 ret_val = nb
-            if window.pos != 0:
+            if window.pos != 0 and top is False:
                 window.scroll_up(nb)
 
         return min(ret_val, 1)