keys: Add a key to view a message in the browser.

Author: punchagan

README.md

@@ -101,6 +101,7 @@ autohide=autohide
 | Search Streams                                        | <kbd>q</kbd>                                  |
 | Add/remove thumbs-up reaction to the current message  | <kbd>+</kbd>                                  |
 | Add/remove star status of the current message         | <kbd>*</kbd>                                  |
+| View the current message in a web-browser             | <kbd>v</kbd>                                  |
 | Jump to the Beginning of line                         | <kbd>Ctrl</kbd> + <kbd>A</kbd>                |
 | Jump backward one character                           | <kbd>Ctrl</kbd> + <kbd>B</kbd> / <kbd>←</kbd> |
 | Jump backward one word                                | <kbd>Meta</kbd> + <kbd>B</kbd>                |

tests/core/test_core.py

@@ -1,3 +1,4 @@
+import os
 from platform import platform
 from typing import Any
 
@@ -173,6 +174,18 @@ def test_show_all_starred(self, mocker, controller, index_all_starred):
         msg_ids = {widget.original_widget.message['id'] for widget in widgets}
         assert msg_ids == id_list
 
+    def test_view_message_in_browser(self, mocker, controller):
+        # Set DISPLAY environ to be able to run test in Travis
+        os.environ['DISPLAY'] = ':0'
+        mock_open = mocker.patch('webbrowser.open', mocker.Mock())
+        message_id = 123456
+        controller.model.server_url = 'https://foo.zulipchat.com/'
+        controller.view_in_browser(message_id)
+        assert mock_open.call_count == 1
+        url = mock_open.call_args[0][0]
+        assert url.startswith(controller.model.server_url)
+        assert url.endswith('/{}'.format(message_id))
+
     def test_main(self, mocker, controller):
         ret_mock = mocker.Mock()
         mock_loop = mocker.patch('urwid.MainLoop', return_value=ret_mock)

zulipterminal/config/keys.py

@@ -136,6 +136,10 @@
         'keys': {'ctrl c'},
         'help_text': 'Quit',
     }),
+    ('VIEW_IN_BROWSER', {
+        'keys': {'v'},
+        'help_text': 'View the current message in a web browser',
+    }),
 ])  # type: OrderedDict[str, KeyBinding]
 
 

zulipterminal/core.py

@@ -4,12 +4,13 @@
 import sys
 import time
 import signal
+import webbrowser
 
 import urwid
 import zulip
 
 from zulipterminal.version import ZT_VERSION
-from zulipterminal.helper import asynch
+from zulipterminal.helper import asynch, suppress_output
 from zulipterminal.model import Model, GetMessagesArgs, ServerConnectionFailure
 from zulipterminal.ui import View, Screen
 from zulipterminal.ui_tools.utils import create_msg_box_list
@@ -252,6 +253,16 @@ def show_all_starred(self, button: Any) -> None:
 
         self._finalize_show(w_list)
 
+    def view_in_browser(self, message_id: int) -> None:
+        url = '{}#narrow/near/{}'.format(self.model.server_url, message_id)
+        if (sys.platform != 'darwin' and sys.platform[:3] != 'win' and
+                not os.environ.get('DISPLAY') and os.environ.get('TERM')):
+            # Don't try to open web browser if running without a GUI
+            return
+        with suppress_output():
+            # Suppress anything on stdout or stderr when opening the browser
+            webbrowser.open(url)
+
     def _finalize_show(self, w_list: List[Any]) -> None:
         focus_position = self.model.get_focus_in_current_narrow()
 

zulipterminal/helper.py

@@ -3,9 +3,11 @@
 from functools import wraps
 from threading import Thread
 from typing import (
-    Any, Dict, List, Set, Tuple, Optional, DefaultDict, FrozenSet, Union
+    Any, Dict, List, Set, Tuple, Optional, DefaultDict, FrozenSet, Union,
+    Iterator
 )
 from mypy_extensions import TypedDict
+from contextlib import contextmanager
 
 import os
 
@@ -347,3 +349,21 @@ def match_user(user: Any, text: str) -> bool:
         if keyword.startswith(text.lower()):
             return True
     return False
+
+
+@contextmanager
+def suppress_output() -> Iterator[Any]:
+    """Context manager to redirect stdout and stderr to /dev/null.
+
+    Adapted from https://stackoverflow.com/a/2323563
+    """
+    out = os.dup(1)
+    err = os.dup(2)
+    os.close(1)
+    os.close(2)
+    os.open(os.devnull, os.O_RDWR)
+    try:
+        yield
+    finally:
+        os.dup2(out, 1)
+        os.dup2(err, 2)

zulipterminal/ui_tools/boxes.py

@@ -625,6 +625,8 @@ def keypress(self, size: Tuple[int, int], key: str) -> str:
             self.model.controller.view.write_box.msg_write_box.set_edit_pos(
                 len(quote))
             self.model.controller.view.middle_column.set_focus('footer')
+        elif is_command_key('VIEW_IN_BROWSER', key):
+            self.model.controller.view_in_browser(self.message['id'])
         return key