zulip/zerver/lib/addressee.py

139 lines
4.6 KiB
Python

from typing import Iterable, List, Optional, Sequence, Text
from django.core.exceptions import ValidationError
from django.utils.translation import ugettext as _
from zerver.lib.exceptions import JsonableError
from zerver.lib.request import JsonableError
from zerver.models import (
Realm,
UserProfile,
get_user_including_cross_realm,
)
def user_profiles_from_unvalidated_emails(emails, realm):
# type: (Iterable[Text], Realm) -> List[UserProfile]
user_profiles = [] # type: List[UserProfile]
for email in emails:
try:
user_profile = get_user_including_cross_realm(email, realm)
except UserProfile.DoesNotExist:
raise ValidationError(_("Invalid email '%s'") % (email,))
user_profiles.append(user_profile)
return user_profiles
def get_user_profiles(emails, realm):
# type: (Iterable[Text], Realm) -> List[UserProfile]
try:
return user_profiles_from_unvalidated_emails(emails, realm)
except ValidationError as e:
assert isinstance(e.messages[0], str)
raise JsonableError(e.messages[0])
class Addressee(object):
# This is really just a holder for vars that tended to be passed
# around in a non-type-safe way before this class was introduced.
#
# It also avoids some nonsense where you have to think about whether
# topic should be None or '' for a PM, or you have to make an array
# of one stream.
#
# Eventually we can use this to cache Stream and UserProfile objects
# in memory.
#
# This should be treated as an immutable class.
def __init__(self, msg_type, user_profiles=None, stream_name=None, topic=None):
# type: (str, Optional[Sequence[UserProfile]], Optional[Text], Text) -> None
assert(msg_type in ['stream', 'private'])
self._msg_type = msg_type
self._user_profiles = user_profiles
self._stream_name = stream_name
self._topic = topic
def msg_type(self):
# type: () -> str
return self._msg_type
def is_stream(self):
# type: () -> bool
return self._msg_type == 'stream'
def is_private(self):
# type: () -> bool
return self._msg_type == 'private'
def user_profiles(self):
# type: () -> List[UserProfile]
assert(self.is_private())
return self._user_profiles # type: ignore # assertion protects us
def stream_name(self):
# type: () -> Text
assert(self.is_stream())
return self._stream_name
def topic(self):
# type: () -> Text
assert(self.is_stream())
return self._topic
@staticmethod
def legacy_build(sender, message_type_name, message_to, topic_name, realm=None):
# type: (UserProfile, Text, Sequence[Text], Text, Optional[Realm]) -> Addressee
# For legacy reason message_to used to be either a list of
# emails or a list of streams. We haven't fixed all of our
# callers yet.
if realm is None:
realm = sender.realm
if message_type_name == 'stream':
if len(message_to) > 1:
raise JsonableError(_("Cannot send to multiple streams"))
if message_to:
stream_name = message_to[0]
else:
# This is a hack to deal with the fact that we still support
# default streams (and the None will be converted later in the
# callpath).
if sender.default_sending_stream:
# Use the users default stream
stream_name = sender.default_sending_stream.name
else:
raise JsonableError(_('Missing stream'))
return Addressee.for_stream(stream_name, topic_name)
elif message_type_name == 'private':
emails = message_to
return Addressee.for_private(emails, realm)
else:
raise JsonableError(_("Invalid message type"))
@staticmethod
def for_stream(stream_name, topic):
# type: (Text, Text) -> Addressee
return Addressee(
msg_type='stream',
stream_name=stream_name,
topic=topic,
)
@staticmethod
def for_private(emails, realm):
# type: (Sequence[Text], Realm) -> Addressee
user_profiles = get_user_profiles(emails, realm)
return Addressee(
msg_type='private',
user_profiles=user_profiles,
)
@staticmethod
def for_user_profile(user_profile):
# type: (UserProfile) -> Addressee
user_profiles = [user_profile]
return Addressee(
msg_type='private',
user_profiles=user_profiles,
)