boxes/server_url: Relocated URL generation code to server_url module.

The URL generation part from the previous commit has been moved to
a new module server_url.py to segregate the url component from the
rest of the code in helper.py
This will allow to track changes in the server and make constructing
and deconstructing server URL's easier. This module can also be later
integrated into the API package.

Author: zee-bit

zulipterminal/helper.py

@@ -11,7 +11,7 @@
     Any, Callable, DefaultDict, Dict, FrozenSet, Iterable, List, Set, Tuple,
     TypeVar, Union,
 )
-from urllib.parse import quote, unquote
+from urllib.parse import unquote
 
 import lxml.html
 from typing_extensions import Literal, TypedDict
@@ -668,61 +668,3 @@ def get_unused_fence(content: Any) -> Any:
                                len(max(matches, key=len)) + 1)
 
     return '`' * max_length_fence
-
-
-def all_user_ids_in_pm(message: Any) -> Any:
-    """
-    Returns a sorted list of all user_ids invloved in
-    a private chat, else None
-    """
-    if (message['type'] != 'private'
-            or len(message['display_recipient']) == 0):
-        return None
-
-    user_ids = map(lambda x: x['id'], message['display_recipient'])
-    sorted_user_ids = sorted(user_ids)
-    return sorted_user_ids
-
-
-def pm_perma_link(message: Any) -> Any:
-    """
-    Returns the link to a message from PM's
-    """
-    user_ids = all_user_ids_in_pm(message)
-
-    if user_ids is not None:
-        suffix = 'group' if len(user_ids) >= 3 else 'pm'
-        slug = ','.join(map(str, user_ids)) + '-' + suffix
-        uri = '#narrow/pm-with/' + slug
-        return uri
-
-
-def encode_hash_component(string: str) -> str:
-    """
-    Hide URI-encoding by replacing % with .
-    [referred from zulip/static/js/hash_util.js]
-    """
-    return quote(string, safe='~()*!.\'').replace('.', '%2E').replace('%', '.')
-
-
-def absolute_url_of_message(model: Any, message: Any) -> str:
-    """
-    Returns the absolute url of any message as present
-    in the webapp. Currently only used to get the url
-    of a quoted message.
-    """
-    absolute_url = model.server_url
-    suffix = '/near/' + str(message['id'])
-
-    if message['type'] == 'stream':
-        absolute_url += '#narrow/stream/'
-        stream_name = message['display_recipient'].replace(' ', '-')
-        prefix = encode_hash_component(str(message['stream_id'])
-                                       + '-' + stream_name)
-        prefix += '/topic/' + encode_hash_component(message['subject'])
-
-        absolute_url += prefix + suffix
-        return absolute_url
-
-    absolute_url += pm_perma_link(message) + suffix
-    return absolute_url

zulipterminal/server_url.py

@@ -0,0 +1,79 @@
+import urllib
+
+from zulipterminal.helper import Message
+
+
+def hash_util_encode(string: str) -> str:
+    """
+    Hide URI-encoding by replacing % with .
+    Referred from zerver/lib/url_encoding.py
+    """
+    # `safe` has a default value of "/", but we want those encoded, too.
+    return urllib.parse.quote(
+        string, safe=b"").replace(".", "%2E").replace("%", ".")
+
+
+def encode_stream(stream_id: int, stream_name: str) -> str:
+    # We encode streams for urls as something like 99-Verona.
+    stream_name = stream_name.replace(' ', '-')
+    return str(stream_id) + '-' + hash_util_encode(stream_name)
+
+
+def near_stream_message_url(server_url: str, message: Message) -> str:
+    """
+    Returns the encoded URL of a message from #narrow/stream.
+    """
+    message_id = str(message['id'])
+    stream_id = message['stream_id']
+    stream_name = message['display_recipient']
+    topic_name = message['subject']
+    encoded_stream = encode_stream(stream_id, stream_name)
+    encoded_topic = hash_util_encode(topic_name)
+
+    parts = [
+        server_url,
+        '#narrow',
+        'stream',
+        encoded_stream,
+        'topic',
+        encoded_topic,
+        'near',
+        message_id,
+    ]
+    full_url = '/'.join(parts)
+    return full_url
+
+
+def near_pm_message_url(server_url: str, message: Message) -> str:
+    """
+    Returns the encoded URL of a message from #narrow/pm-with.
+    """
+    message_id = str(message['id'])
+    str_user_ids = [
+        str(recipient['id'])
+        for recipient in message['display_recipient']
+    ]
+
+    pm_str = ','.join(str_user_ids) + '-pm'
+    parts = [
+        server_url,
+        '#narrow',
+        'pm-with',
+        pm_str,
+        'near',
+        message_id,
+    ]
+    full_url = '/'.join(parts)
+    return full_url
+
+
+def near_message_url(server_url: str, message: Message) -> str:
+    """
+    Returns the correct encoded URL of a message, if
+    it is present in stream/pm-with accordingly.
+    """
+    if message['type'] == 'stream':
+        url = near_stream_message_url(server_url, message)
+    else:
+        url = near_pm_message_url(server_url, message)
+    return url

zulipterminal/ui_tools/boxes.py

@@ -22,9 +22,10 @@
     STREAM_TOPIC_SEPARATOR, TIME_MENTION_MARKER,
 )
 from zulipterminal.helper import (
-    Message, absolute_url_of_message, format_string, get_unused_fence,
-    match_emoji, match_group, match_stream, match_topics, match_user,
+    Message, format_string, get_unused_fence, match_emoji, match_group,
+    match_stream, match_topics, match_user,
 )
+from zulipterminal.server_url import near_message_url
 from zulipterminal.ui_tools.buttons import EditModeButton
 from zulipterminal.ui_tools.tables import render_table
 from zulipterminal.urwid_types import urwid_Size
@@ -1200,7 +1201,8 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
             #   ```quote
             #   message_content
             #   ```
-            absolute_url = absolute_url_of_message(self.model, self.message)
+            absolute_url = near_message_url(
+                self.model.server_url[:-1], self.message)
             fence = get_unused_fence(self.model.client.get_raw_message(
                 self.message['id'])['raw_content'])