mirror of
https://github.com/zulip/zulip.git
synced 2025-11-07 15:33:30 +00:00
fd62e71737
When you send a message to a bot that wants to talk via an outgoing webhook, and there's an error (e.g. server is down), we send a message to the bot's owner that links to the message that triggered the error. The code to produce those links was out of date. Now we move the important code to the `url_encoding.py` library and fix the PM links to use the more modern style (user_ids instead of emails). We also replace "subject" with "topic" in the stream urls.
93 lines
2.8 KiB
Python
93 lines
2.8 KiB
Python
import urllib
|
|
from typing import Any, Dict, List
|
|
|
|
from zerver.models import Realm, Stream
|
|
|
|
def hash_util_encode(string: str) -> str:
|
|
# Do the same encoding operation as hash_util.encodeHashComponent on the
|
|
# frontend.
|
|
# `safe` has a default value of "/", but we want those encoded, too.
|
|
return urllib.parse.quote(
|
|
string.encode("utf-8"), 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 pm_narrow_url(realm: Realm, participants: List[str]) -> str:
|
|
participants.sort()
|
|
base_url = "%s/#narrow/pm-with/" % (realm.uri,)
|
|
return base_url + hash_util_encode(",".join(participants))
|
|
|
|
def stream_narrow_url(realm: Realm, stream: Stream) -> str:
|
|
base_url = "%s/#narrow/stream/" % (realm.uri,)
|
|
return base_url + encode_stream(stream.id, stream.name)
|
|
|
|
def topic_narrow_url(realm: Realm, stream: Stream, topic: str) -> str:
|
|
base_url = "%s/#narrow/stream/" % (realm.uri,)
|
|
return "%s%s/topic/%s" % (base_url,
|
|
encode_stream(stream.id, stream.name),
|
|
hash_util_encode(topic))
|
|
|
|
def near_message_url(realm: Realm,
|
|
message: Dict[str, Any]) -> str:
|
|
|
|
if message['type'] == 'stream':
|
|
url = near_stream_message_url(
|
|
realm=realm,
|
|
message=message,
|
|
)
|
|
return url
|
|
|
|
url = near_pm_message_url(
|
|
realm=realm,
|
|
message=message,
|
|
)
|
|
return url
|
|
|
|
def near_stream_message_url(realm: Realm,
|
|
message: Dict[str, Any]) -> str:
|
|
message_id = str(message['id'])
|
|
stream_id = message['stream_id']
|
|
stream_name = message['display_recipient']
|
|
topic_name = message['subject']
|
|
encoded_topic = hash_util_encode(topic_name)
|
|
encoded_stream = encode_stream(stream_id=stream_id, stream_name=stream_name)
|
|
|
|
parts = [
|
|
realm.uri,
|
|
'#narrow',
|
|
'stream',
|
|
encoded_stream,
|
|
'topic',
|
|
encoded_topic,
|
|
'near',
|
|
message_id,
|
|
]
|
|
full_url = '/'.join(parts)
|
|
return full_url
|
|
|
|
def near_pm_message_url(realm: Realm,
|
|
message: Dict[str, Any]) -> str:
|
|
message_id = str(message['id'])
|
|
str_user_ids = [
|
|
str(recipient['id'])
|
|
for recipient in message['display_recipient']
|
|
]
|
|
|
|
# Use the "perma-link" format here that includes the sender's
|
|
# user_id, so they're easier to share between people.
|
|
pm_str = ','.join(str_user_ids) + '-pm'
|
|
|
|
parts = [
|
|
realm.uri,
|
|
'#narrow',
|
|
'pm-with',
|
|
pm_str,
|
|
'near',
|
|
message_id,
|
|
]
|
|
full_url = '/'.join(parts)
|
|
return full_url
|