CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-06-24 21:08:25 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Annotate zerver/lib/email_mirror.py.

Browse Source 
[With some fixes from @sharmaeklavya2].
This commit is contained in:
medullaskyline 2016-06-05 12:16:54 -07:00 committed by Tim Abbott
parent a2668a2853
commit e2eb4e0b7e
1 changed files with 35 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
zerver/lib/email_mirror.py
View File

@ -1,9 +1,11 @@
from __future__ import absolute_import
from typing import Any, Optional
import logging
import re
from email.header import decode_header
import email.message as message
from django.conf import settings
@ -14,34 +16,39 @@ from zerver.lib.redis_utils import get_redis_client
from zerver.lib.upload import upload_message_image
from zerver.lib.utils import generate_random_token
from zerver.models import Stream, Recipient, get_user_profile_by_email, \
get_user_profile_by_id, get_display_recipient, get_recipient
get_user_profile_by_id, get_display_recipient, get_recipient, \
Message, Realm, UserProfile
from six import text_type
import six
logger = logging.getLogger(__name__)
def redact_stream(error_message):
# type: (text_type) -> text_type
domain = settings.EMAIL_GATEWAY_PATTERN.rsplit('@')[-1]
stream_match = re.search(r'\b(.*?)@' + domain, error_message)
stream_match = re.search(u'\\b(.*?)@' + domain, error_message)
if stream_match:
stream_name = stream_match.groups()[0]
return error_message.replace(stream_name, "X" * len(stream_name))
return error_message
def report_to_zulip(error_message):
# type: (text_type) -> None
error_stream = Stream.objects.get(name="errors", realm__domain=settings.ADMIN_DOMAIN)
send_zulip(error_stream, "email mirror error",
"""~~~\n%s\n~~~""" % (error_message,))
send_zulip(error_stream, u"email mirror error",
u"""~~~\n%s\n~~~""" % (error_message,))
def log_and_report(email_message, error_message, debug_info):
scrubbed_error = "Sender: %s\n%s" % (email_message.get("From"),
# type: (message.Message, text_type, Dict[str, Any]) -> None
scrubbed_error = u"Sender: %s\n%s" % (email_message.get("From"),
redact_stream(error_message))
if "to" in debug_info:
scrubbed_error = "Stream: %s\n%s" % (redact_stream(debug_info["to"]),
scrubbed_error = u"Stream: %s\n%s" % (redact_stream(debug_info["to"]),
scrubbed_error)
if "stream" in debug_info:
scrubbed_error = "Realm: %s\n%s" % (debug_info["stream"].realm.domain,
scrubbed_error = u"Realm: %s\n%s" % (debug_info["stream"].realm.domain,
scrubbed_error)
logger.error(scrubbed_error)
@ -54,15 +61,18 @@ redis_client = get_redis_client()
def missed_message_redis_key(token):
# type: (text_type) -> text_type
return 'missed_message:' + token
def is_missed_message_address(address):
# type: (text_type) -> bool
msg_string = get_email_gateway_message_string_from_address(address)
return msg_string.startswith('mm') and len(msg_string) == 34
def get_missed_message_token_from_address(address):
# type: (text_type) -> text_type
msg_string = get_email_gateway_message_string_from_address(address)
if not msg_string.startswith('mm') and len(msg_string) != 34:
@ -72,6 +82,7 @@ def get_missed_message_token_from_address(address):
return msg_string[2:]
def create_missed_message_address(user_profile, message):
# type: (UserProfile, Message) -> text_type
if message.recipient.type == Recipient.PERSONAL:
# We need to reply to the sender so look up their personal recipient_id
recipient_id = get_recipient(Recipient.PERSONAL, message.sender_id).id
@ -95,11 +106,12 @@ def create_missed_message_address(user_profile, message):
pipeline.expire(key, 60 * 60 * 24 * 5)
pipeline.execute()
address = 'mm' + token
address = u'mm' + token
return settings.EMAIL_GATEWAY_PATTERN % (address,)
def mark_missed_message_address_as_used(address):
# type: (text_type) -> None
token = get_missed_message_token_from_address(address)
key = missed_message_redis_key(token)
with redis_client.pipeline() as pipeline:
@ -112,6 +124,7 @@ def mark_missed_message_address_as_used(address):
def send_to_missed_message_address(address, message):
# type: (text_type, message.Message) -> None
token = get_missed_message_token_from_address(address)
key = missed_message_redis_key(token)
result = redis_client.hmget(key, 'user_profile_id', 'recipient_id', 'subject')
@ -150,6 +163,7 @@ class ZulipEmailForwardError(Exception):
pass
def send_zulip(stream, topic, content):
# type: (Stream, text_type, text_type) -> None
internal_send_message(
settings.EMAIL_GATEWAY_BOT,
"stream",
@ -159,6 +173,7 @@ def send_zulip(stream, topic, content):
stream.realm)
def valid_stream(stream_name, token):
# type: (text_type, text_type) -> bool
try:
stream = Stream.objects.get(email_token=token)
return stream.name.lower() == stream_name.lower()
@ -166,6 +181,7 @@ def valid_stream(stream_name, token):
return False
def get_message_part_by_type(message, content_type):
# type: (message.Message, text_type) -> text_type
charsets = message.get_charsets()
for idx, part in enumerate(message.walk()):
@ -176,6 +192,7 @@ def get_message_part_by_type(message, content_type):
return content
def extract_body(message):
# type: (message.Message) -> text_type
# If the message contains a plaintext version of the body, use
# that.
plaintext_content = get_message_part_by_type(message, "text/plain")
@ -190,6 +207,7 @@ def extract_body(message):
raise ZulipEmailForwardError("Unable to find plaintext or HTML message body")
def filter_footer(text):
# type: (text_type) -> text_type
# Try to filter out obvious footers.
possible_footers = [line for line in text.split("\n") if line.strip().startswith("--")]
if len(possible_footers) != 1:
@ -200,6 +218,7 @@ def filter_footer(text):
return text.partition("--")[0].strip()
def extract_and_upload_attachments(message, realm):
# type: (message.Message, Realm) -> text_type
user_profile = get_user_profile_by_email(settings.EMAIL_GATEWAY_BOT)
attachment_links = []
@ -216,12 +235,13 @@ def extract_and_upload_attachments(message, realm):
part.get_payload(decode=True),
user_profile,
target_realm=realm)
formatted_link = "[%s](%s)" % (filename, s3_url)
formatted_link = u"[%s](%s)" % (filename, s3_url)
attachment_links.append(formatted_link)
return "\n".join(attachment_links)
return u"\n".join(attachment_links)
def extract_and_validate(email):
# type: (text_type) -> Stream
try:
stream_name, token = decode_email_address(email)
except (TypeError, ValueError):
@ -233,11 +253,12 @@ def extract_and_validate(email):
return Stream.objects.get(email_token=token)
def find_emailgateway_recipient(message):
# type: (message.Message) -> text_type
# We can't use Delivered-To; if there is a X-Gm-Original-To
# it is more accurate, so try to find the most-accurate
# recipient list in descending priority order
recipient_headers = ["X-Gm-Original-To", "Delivered-To", "To"]
recipients = [] # type: List[str]
recipients = [] # type: List[text_type]
for recipient_header in recipient_headers:
r = message.get_all(recipient_header, None)
if r:
@ -253,6 +274,7 @@ def find_emailgateway_recipient(message):
raise ZulipEmailForwardError("Missing recipient in mirror email")
def process_stream_message(to, subject, message, debug_info):
# type: (text_type, text_type, message.Message, Dict[str, Any]) -> None
stream = extract_and_validate(to)
body = filter_footer(extract_body(message))
body += extract_and_upload_attachments(message, stream.realm)
@ -260,11 +282,13 @@ def process_stream_message(to, subject, message, debug_info):
send_zulip(stream, subject, body)
def process_missed_message(to, message, pre_checked):
# type: (text_type, message.Message, bool) -> None
if not pre_checked:
mark_missed_message_address_as_used(to)
send_to_missed_message_address(to, message)
def process_message(message, rcpt_to=None, pre_checked=False):
# type: (message.Message, Optional[text_type], bool) -> None
subject = decode_header(message.get("Subject", "(no subject)"))[0][0]
debug_info = {}