mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 05:53:43 +00:00
460119986b
There are some remaining errors related to the django `Manager[T]` and the `List[T]` type that we use to annotate the `Manage[T]` objects.
129 lines
4.8 KiB
Python
129 lines
4.8 KiB
Python
import base64
|
|
import email
|
|
import email.policy
|
|
import os
|
|
from email.message import EmailMessage
|
|
from typing import Any, Optional
|
|
|
|
import orjson
|
|
from django.conf import settings
|
|
from django.core.management.base import CommandError, CommandParser
|
|
|
|
from zerver.lib.email_mirror import mirror_email_message
|
|
from zerver.lib.email_mirror_helpers import encode_email_address
|
|
from zerver.lib.management import ZulipBaseCommand
|
|
from zerver.models import Realm, get_realm, get_stream
|
|
|
|
# This command loads an email from a specified file and sends it
|
|
# to the email mirror. Simple emails can be passed in a JSON file,
|
|
# Look at zerver/tests/fixtures/email/1.json for an example of how
|
|
# it should look. You can also pass a file which has the raw email,
|
|
# for example by writing an email.message.EmailMessage type object
|
|
# to a file using as_string() or as_bytes() methods, or copy-pasting
|
|
# the content of "Show original" on an email in Gmail.
|
|
# See zerver/tests/fixtures/email/1.txt for a very simple example,
|
|
# but anything that the message_from_binary_file function
|
|
# from the email library can parse should work.
|
|
# Value of the TO: header doesn't matter, as it is overridden
|
|
# by the command in order for the email to be sent to the correct stream.
|
|
|
|
|
|
class Command(ZulipBaseCommand):
|
|
help = """
|
|
Send specified email from a fixture file to the email mirror
|
|
Example:
|
|
./manage.py send_to_email_mirror --fixture=zerver/tests/fixtures/emails/filename
|
|
|
|
"""
|
|
|
|
def add_arguments(self, parser: CommandParser) -> None:
|
|
parser.add_argument(
|
|
"-f",
|
|
"--fixture",
|
|
help="The path to the email message you'd like to send "
|
|
"to the email mirror.\n"
|
|
"Accepted formats: json or raw email file. "
|
|
"See zerver/tests/fixtures/email/ for examples",
|
|
)
|
|
parser.add_argument(
|
|
"-s",
|
|
"--stream",
|
|
help="The name of the stream to which you'd like to send "
|
|
"the message. Default: Denmark",
|
|
)
|
|
|
|
self.add_realm_args(parser, help="Specify which realm to connect to; default is zulip")
|
|
|
|
def handle(self, *args: Any, **options: Optional[str]) -> None:
|
|
if options["fixture"] is None:
|
|
self.print_help("./manage.py", "send_to_email_mirror")
|
|
raise CommandError
|
|
|
|
if options["stream"] is None:
|
|
stream = "Denmark"
|
|
else:
|
|
stream = options["stream"]
|
|
|
|
realm = self.get_realm(options)
|
|
if realm is None:
|
|
realm = get_realm("zulip")
|
|
|
|
full_fixture_path = os.path.join(settings.DEPLOY_ROOT, options["fixture"])
|
|
|
|
# parse the input email into EmailMessage type and prepare to process_message() it
|
|
message = self._parse_email_fixture(full_fixture_path)
|
|
self._prepare_message(message, realm, stream)
|
|
|
|
mirror_email_message(
|
|
message["To"].addresses[0].addr_spec,
|
|
base64.b64encode(message.as_bytes()).decode(),
|
|
)
|
|
|
|
def _does_fixture_path_exist(self, fixture_path: str) -> bool:
|
|
return os.path.exists(fixture_path)
|
|
|
|
def _parse_email_json_fixture(self, fixture_path: str) -> EmailMessage:
|
|
with open(fixture_path, "rb") as fp:
|
|
json_content = orjson.loads(fp.read())[0]
|
|
|
|
message = EmailMessage()
|
|
message["From"] = json_content["from"]
|
|
message["Subject"] = json_content["subject"]
|
|
message.set_content(json_content["body"])
|
|
return message
|
|
|
|
def _parse_email_fixture(self, fixture_path: str) -> EmailMessage:
|
|
if not self._does_fixture_path_exist(fixture_path):
|
|
raise CommandError(f"Fixture {fixture_path} does not exist")
|
|
|
|
if fixture_path.endswith(".json"):
|
|
return self._parse_email_json_fixture(fixture_path)
|
|
else:
|
|
with open(fixture_path, "rb") as fp:
|
|
message = email.message_from_binary_file(fp, policy=email.policy.default)
|
|
# https://github.com/python/typeshed/issues/2417
|
|
assert isinstance(message, EmailMessage)
|
|
return message
|
|
|
|
def _prepare_message(self, message: EmailMessage, realm: Realm, stream_name: str) -> None:
|
|
stream = get_stream(stream_name, realm)
|
|
|
|
# The block below ensures that the imported email message doesn't have any recipient-like
|
|
# headers that are inconsistent with the recipient we want (the stream address).
|
|
recipient_headers = [
|
|
"X-Gm-Original-To",
|
|
"Delivered-To",
|
|
"Envelope-To",
|
|
"Resent-To",
|
|
"Resent-CC",
|
|
"CC",
|
|
]
|
|
for header in recipient_headers:
|
|
if header in message:
|
|
del message[header]
|
|
message[header] = encode_email_address(stream)
|
|
|
|
if "To" in message:
|
|
del message["To"]
|
|
message["To"] = encode_email_address(stream)
|