import re from typing import Any, Dict, Tuple, List, Optional # stubs ZerverFieldsT = Dict[str, Any] AddedUsersT = Dict[str, int] AddedChannelsT = Dict[str, Tuple[str, int]] # Slack link can be in the format and LINK_REGEX = r""" (<) # match '>' (http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/|ftp:\/\/)? # protocol and www ([a-z0-9]+([\-\.]{1}[a-z0-9]+)*)(\.) # domain name ([a-z]{2,63}(:[0-9]{1,5})?) # domain (\/[^>]*)? # path (\|)?(?:\|([^>]+))? # char after pipe (for slack links) (>) """ SLACK_MAILTO_REGEX = r""" <((mailto:)? # match ` # match email """ SLACK_USERMENTION_REGEX = r""" (<@) # Start with '<@' ([a-zA-Z0-9]+) # Here we have the Slack id (\|)? # We not always have a Vertical line in mention ([a-zA-Z0-9]+)? # If Vertical line is present, this is short name (>) # ends with '>' """ # Slack doesn't have mid-word message-formatting like Zulip. # Hence, ~stri~ke doesn't format the word in slack, but ~~stri~~ke # formats the word in Zulip SLACK_STRIKETHROUGH_REGEX = r""" (^|[ -(]|[+-/]|\*|\_|[:-?]|\{|\[|\||\^) # Start after specified characters (\~) # followed by an asterisk ([ -)+-}—]*)([ -}]+) # any character except asterisk (\~) # followed by an asterisk ($|[ -']|[+-/]|[:-?]|\*|\_|\}|\)|\]|\||\^) # ends with specified characters """ SLACK_ITALIC_REGEX = r""" (^|[ -*]|[+-/]|[:-?]|\{|\[|\||\^|~) (\_) ([ -^`~—]*)([ -^`-~]+) # any character (\_) ($|[ -']|[+-/]|[:-?]|\}|\)|\]|\*|\||\^|~) """ SLACK_BOLD_REGEX = r""" (^|[ -(]|[+-/]|[:-?]|\{|\[|\_|\||\^|~) (\*) ([ -)+-~—]*)([ -)+-~]+) # any character (\*) ($|[ -']|[+-/]|[:-?]|\}|\)|\]|\_|\||\^|~) """ def get_user_full_name(user: ZerverFieldsT) -> str: if user['deleted'] is False: if user['real_name'] == '': return user['name'] else: return user['real_name'] else: return user['name'] # Markdown mapping def convert_to_zulip_markdown(text: str, users: List[ZerverFieldsT], added_channels: AddedChannelsT, added_users: AddedUsersT) -> Tuple[str, List[int], bool]: mentioned_users_id = [] text = convert_markdown_syntax(text, SLACK_BOLD_REGEX, "**") text = convert_markdown_syntax(text, SLACK_STRIKETHROUGH_REGEX, "~~") text = convert_markdown_syntax(text, SLACK_ITALIC_REGEX, "*") # Map Slack's mention all: '' to '@**all** ' # Map Slack's mention all: '' to '@**all** ' # Map Slack's mention all: '' to '@**all** ' # No regex for this as it can be present anywhere in the sentence text = text.replace('', '@**all**') text = text.replace('', '@**all**') text = text.replace('', '@**all**') # Map Slack channel mention: '<#C5Z73A7RA|general>' to '#**general**' for cname, ids in added_channels.items(): cid = ids[0] text = text.replace('<#%s|%s>' % (cid, cname), '#**' + cname + '**') tokens = text.split(' ') for iterator in range(len(tokens)): # Check user mentions and change mention format from # '<@slack_id|short_name>' to '@**full_name**' if (re.findall(SLACK_USERMENTION_REGEX, tokens[iterator], re.VERBOSE)): tokens[iterator], user_id = get_user_mentions(tokens[iterator], users, added_users) if user_id is not None: mentioned_users_id.append(user_id) text = ' '.join(tokens) # Check and convert link format text, has_link = convert_link_format(text) # convert `` to `mailto:foo@foo.com` text, has_mailto_link = convert_mailto_format(text) if has_link is True or has_mailto_link is True: message_has_link = True else: message_has_link = False return text, mentioned_users_id, message_has_link def get_user_mentions(token: str, users: List[ZerverFieldsT], added_users: AddedUsersT) -> Tuple[str, Optional[int]]: slack_usermention_match = re.search(SLACK_USERMENTION_REGEX, token, re.VERBOSE) short_name = slack_usermention_match.group(4) # type: ignore # slack_usermention_match exists and is not None slack_id = slack_usermention_match.group(2) # type: ignore # slack_usermention_match exists and is not None for user in users: if (user['id'] == slack_id and user['name'] == short_name and short_name) or \ (user['id'] == slack_id and short_name is None): full_name = get_user_full_name(user) user_id = added_users[slack_id] mention = "@**" + full_name + "**" token = re.sub(SLACK_USERMENTION_REGEX, mention, token, flags=re.VERBOSE) return token, user_id return token, None # Map italic, bold and strikethrough markdown def convert_markdown_syntax(text: str, regex: str, zulip_keyword: str) -> str: """ Returns: 1. For strikethrough formatting: This maps Slack's '~strike~' to Zulip's '~~strike~~' 2. For bold formatting: This maps Slack's '*bold*' to Zulip's '**bold**' 3. For italic formatting: This maps Slack's '_italic_' to Zulip's '*italic*' """ for match in re.finditer(regex, text, re.VERBOSE): converted_token = (match.group(1) + zulip_keyword + match.group(3) + match.group(4) + zulip_keyword + match.group(6)) text = text.replace(match.group(0), converted_token) return text def convert_link_format(text: str) -> Tuple[str, bool]: """ 1. Converts '' to 'https://foo.com' 2. Converts '' to 'https://foo.com|foo' """ has_link = False for match in re.finditer(LINK_REGEX, text, re.VERBOSE): converted_text = match.group(0).replace('>', '').replace('<', '') has_link = True text = text.replace(match.group(0), converted_text) return text, has_link def convert_mailto_format(text: str) -> Tuple[str, bool]: """ 1. Converts '' to 'mailto:foo@foo.com' 2. Converts '' to 'mailto:foo@foo.com' """ has_link = False for match in re.finditer(SLACK_MAILTO_REGEX, text, re.VERBOSE): has_link = True text = text.replace(match.group(0), match.group(1)) return text, has_link