Opens message links popup menu

Pressing enter on one of the buttons in links popup menu
does one of the following, depending on the link:
- narrow to stream
- narrow to user
- open image in system's default viewer
- open link in system's default browser

Author: shreyamalviya

zulipterminal/config/keys.py

@@ -184,6 +184,10 @@
         'keys': {'ctrl l'},
         'help_text': 'Clear message',
     }),
+    ('MSG_LINKS', {
+        'keys': {'v'},
+        'help_text': 'View all links in the current message',
+    }),
 ])  # type: OrderedDict[str, KeyBinding]
 
 

zulipterminal/core.py

@@ -13,7 +13,7 @@
 from zulipterminal.model import Model, GetMessagesArgs, ServerConnectionFailure
 from zulipterminal.ui import View, Screen
 from zulipterminal.ui_tools.utils import create_msg_box_list
-from zulipterminal.ui_tools.views import HelpView
+from zulipterminal.ui_tools.views import HelpView, MsgLinksView
 from zulipterminal.config.themes import ThemeSpec
 
 
@@ -84,27 +84,34 @@ def update_screen(self) -> None:
     def draw_screen(self, *args: Any, **kwargs: Any) -> None:
         self.loop.draw_screen()
 
-    def show_help(self) -> None:
+    def show_pop_up(self, to_show: Any, title: str) -> None:
         double_lines = dict(tlcorner='╔', tline='═', trcorner='╗',
                             rline='║', lline='║',
                             blcorner='╚', bline='═', brcorner='╝')
         cols, rows = self.loop.screen.get_cols_rows()
-        help_view = HelpView(self)
         self.loop.widget = urwid.Overlay(
-            urwid.LineBox(help_view,
-                          title="Help Menu (up/down scrolls)",
+            urwid.LineBox(to_show,
+                          title,
                           **double_lines),
             self.view,
             align='center',
             valign='middle',
             # +2 to both of the following, due to LineBox
-            width=help_view.width+2,
-            height=min(3*rows//4, help_view.number_of_actions)+2
+            width=to_show.width+2,
+            height=min(3*rows//4, to_show.height)+2
         )
 
-    def exit_help(self) -> None:
+    def show_help(self) -> None:
+        help_view = HelpView(self)
+        self.show_pop_up(help_view, "Help Menu (up/down scrolls)")
+
+    def exit_pop_up(self) -> None:
         self.loop.widget = self.view
 
+    def show_msg_links(self, msg: Any):
+        msg_links_view = MsgLinksView(self, msg)
+        self.show_pop_up(msg_links_view, "Message Links (up/down scrolls)")
+
     def search_messages(self, text: str) -> None:
         # Search for a text in messages
         self.model.set_narrow(search=text)

zulipterminal/ui_tools/boxes.py

@@ -139,6 +139,7 @@ def __init__(self, message: Dict[str, Any], model: Any,
                  last_message: Any) -> None:
         self.model = model
         self.message = message
+        self.message['links'] = dict()  # type: Dict
         self.caption = ''
         self.stream_id = None  # type: Union[int, None]
         self.title = ''
@@ -373,6 +374,7 @@ def soup2markup(self, soup: Any) -> List[Any]:
                      'user-group-mention' in element.attrs.get('class', [])):
                 # USER MENTIONS & USER-GROUP MENTIONS
                 markup.append(('span', element.text))
+                self.message['links'][element.text] = element.text
             elif element.name == 'a':
                 # LINKS
                 link = element.attrs['href']
@@ -383,12 +385,15 @@ def soup2markup(self, soup: Any) -> List[Any]:
                     # a link then just display the link
                     markup.append(text)
                 else:
+                    if link.startswith('user_uploads/'):
+                        link = self.model.server_url + link
                     if link.startswith('/user_uploads/'):
                         # Append org url to before user_uploads to convert it
                         # into a link.
-                        link = self.model.server_url + link
+                        link = self.model.server_url + link[1:]
                     markup.append(
                         ('link', '[' + text + ']' + '(' + link + ')'))
+                self.message['links'][text] = link
             elif element.name == 'blockquote':
                 # BLOCKQUOTE TEXT
                 markup.append((
@@ -680,6 +685,8 @@ def keypress(self, size: Tuple[int, int], key: str) -> str:
             write_box.msg_write_box.set_edit_text(msg)
             write_box.msg_write_box.set_edit_pos(len(msg))
             self.model.controller.view.middle_column.set_focus('footer')
+        elif is_command_key('MSG_LINKS', key):
+            self.model.controller.show_msg_links(self.message)
         return key
 
 

zulipterminal/ui_tools/buttons.py

@@ -72,6 +72,14 @@ def keypress(self, size: Tuple[int, int], key: str) -> str:
         return super().keypress(size, key)
 
 
+class MsgLinkButton(TopButton):
+    def __init__(self, controller: Any, width: int, count: int,
+                 caption: str, function: Callable) -> None:
+        super().__init__(controller, caption,
+                         function, count=count,
+                         width=width)
+
+
 class HomeButton(TopButton):
     def __init__(self, controller: Any, width: int, count: int=0) -> None:
         super().__init__(controller, 'All messages',

zulipterminal/ui_tools/views.py

@@ -17,6 +17,7 @@
 )
 from zulipterminal.ui_tools.utils import create_msg_box_list
 from zulipterminal.ui_tools.boxes import UserSearchBox, StreamSearchBox
+from zulipterminal.ui_tools.buttons import MsgLinkButton
 
 
 class ModListWalker(urwid.SimpleFocusListWalker):
@@ -649,11 +650,70 @@ def __init__(self, controller: Any) -> None:
                 None if index % 2 else 'help')
              for index, binding in enumerate(KEY_BINDINGS.values())])
 
-        self.number_of_actions = len(self.log)
+        self.height = len(self.log)
 
         super(HelpView, self).__init__(self.log)
 
     def keypress(self, size: Tuple[int, int], key: str) -> str:
         if is_command_key('GO_BACK', key) or is_command_key('HELP', key):
-            self.controller.exit_help()
+            self.controller.exit_pop_up()
         return super(HelpView, self).keypress(size, key)
+
+class MsgLinksView(urwid.ListBox):
+    def __init__(self, controller: Any, msg: Any):
+        self.controller = controller
+        self.msg = msg
+
+        self.width = 70
+        self.height = 10
+
+        self.log = []
+        for url in msg['links']:
+            if not url.startswith('/user_uploads'):
+                self.log.append(MsgLinkButton(self.controller,
+                                            self.width,
+                                            0,
+                                            url,
+                                            self.perform_action))
+
+        super(MsgLinksView, self).__init__(self.log)
+
+    def perform_action(self, button):
+        # If stream
+        if self.msg['links'][button.caption].startswith('/#narrow'):
+            for stream_details in self.controller.model.stream_dict.values():
+                # Check mentioned stream with all subscribed streams
+                if stream_details['name'] == button.caption[1:]:
+                    # Prepare stream button to call function to narrow to stream
+                    req_details = ['name', 'stream_id', 'color', 'invite_only']
+                    stream = [stream_details[key] for key in req_details]
+                    btn = StreamButton(stream,
+                                       controller=self.controller,
+                                       view=self.controller.view,
+                                       width=self.width,
+                                       count=0)
+                    self.controller.narrow_to_stream(btn)
+                    break
+        # If user
+        elif self.msg['links'][button.caption].startswith('@'):
+            # print(self.controller.model.users, "\n", button.caption, "\n", flush=True)
+            for user in self.controller.model.users:
+                if user['full_name'] == button.caption[1:]:
+                    btn = UserButton(user,
+                                     controller=self.controller,
+                                     view=self.controller.view,
+                                     width=self.width,
+                                     color=user['status'],
+                                     count=0)
+                    self.controller.narrow_to_user(btn)
+                    break
+
+        else:
+            # Will open images and links in default image viewer and browser
+            pass
+
+
+    def keypress(self, size: Tuple[int, int], key: str) -> str:
+        if is_command_key('GO_BACK', key) or is_command_key('MSG_LINKS', key):
+            self.controller.exit_pop_up()
+        return super(MsgLinksView, self).keypress(size, key)