mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 14:03:30 +00:00 
			
		
		
		
	Updates user-facing translated strings containing "private message" on the backend to use "direct message" instead.
		
			
				
	
	
		
			96 lines
		
	
	
		
			3.7 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			96 lines
		
	
	
		
			3.7 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
from typing import Dict, Optional, Sequence
 | 
						|
 | 
						|
from django.core.exceptions import ValidationError
 | 
						|
from django.utils.translation import gettext as _
 | 
						|
 | 
						|
from zerver.models import Recipient, UserProfile, get_huddle_recipient, is_cross_realm_bot_email
 | 
						|
 | 
						|
 | 
						|
def get_recipient_from_user_profiles(
 | 
						|
    recipient_profiles: Sequence[UserProfile],
 | 
						|
    forwarded_mirror_message: bool,
 | 
						|
    forwarder_user_profile: Optional[UserProfile],
 | 
						|
    sender: UserProfile,
 | 
						|
) -> Recipient:
 | 
						|
    # Avoid mutating the passed in list of recipient_profiles.
 | 
						|
    recipient_profiles_map = {user_profile.id: user_profile for user_profile in recipient_profiles}
 | 
						|
 | 
						|
    if forwarded_mirror_message:
 | 
						|
        # In our mirroring integrations with some third-party
 | 
						|
        # protocols, bots subscribed to the third-party protocol
 | 
						|
        # forward to Zulip messages that they received in the
 | 
						|
        # third-party service.  The permissions model for that
 | 
						|
        # forwarding is that users can only submit to Zulip private
 | 
						|
        # messages they personally received, and here we do the check
 | 
						|
        # for whether forwarder_user_profile is among the private
 | 
						|
        # message recipients of the message.
 | 
						|
        assert forwarder_user_profile is not None
 | 
						|
        if forwarder_user_profile.id not in recipient_profiles_map:
 | 
						|
            raise ValidationError(_("User not authorized for this query"))
 | 
						|
 | 
						|
    # If the private message is just between the sender and
 | 
						|
    # another person, force it to be a personal internally
 | 
						|
    if len(recipient_profiles_map) == 2 and sender.id in recipient_profiles_map:
 | 
						|
        del recipient_profiles_map[sender.id]
 | 
						|
 | 
						|
    assert recipient_profiles_map
 | 
						|
    if len(recipient_profiles_map) == 1:
 | 
						|
        [user_profile] = recipient_profiles_map.values()
 | 
						|
        return Recipient(
 | 
						|
            id=user_profile.recipient_id,
 | 
						|
            type=Recipient.PERSONAL,
 | 
						|
            type_id=user_profile.id,
 | 
						|
        )
 | 
						|
 | 
						|
    # Otherwise, we need a huddle.  Make sure the sender is included in huddle messages
 | 
						|
    recipient_profiles_map[sender.id] = sender
 | 
						|
 | 
						|
    user_ids = set(recipient_profiles_map)
 | 
						|
    return get_huddle_recipient(user_ids)
 | 
						|
 | 
						|
 | 
						|
def validate_recipient_user_profiles(
 | 
						|
    user_profiles: Sequence[UserProfile], sender: UserProfile, allow_deactivated: bool = False
 | 
						|
) -> Sequence[UserProfile]:
 | 
						|
    recipient_profiles_map: Dict[int, UserProfile] = {}
 | 
						|
 | 
						|
    # We exempt cross-realm bots from the check that all the recipients
 | 
						|
    # are in the same realm.
 | 
						|
    realms = set()
 | 
						|
    if not is_cross_realm_bot_email(sender.email):
 | 
						|
        realms.add(sender.realm_id)
 | 
						|
 | 
						|
    for user_profile in user_profiles:
 | 
						|
        if (
 | 
						|
            not user_profile.is_active
 | 
						|
            and not user_profile.is_mirror_dummy
 | 
						|
            and not allow_deactivated
 | 
						|
        ) or user_profile.realm.deactivated:
 | 
						|
            raise ValidationError(
 | 
						|
                _("'{email}' is no longer using Zulip.").format(email=user_profile.email)
 | 
						|
            )
 | 
						|
        recipient_profiles_map[user_profile.id] = user_profile
 | 
						|
        if not is_cross_realm_bot_email(user_profile.email):
 | 
						|
            realms.add(user_profile.realm_id)
 | 
						|
 | 
						|
    if len(realms) > 1:
 | 
						|
        raise ValidationError(_("You can't send direct messages outside of your organization."))
 | 
						|
 | 
						|
    return list(recipient_profiles_map.values())
 | 
						|
 | 
						|
 | 
						|
def recipient_for_user_profiles(
 | 
						|
    user_profiles: Sequence[UserProfile],
 | 
						|
    forwarded_mirror_message: bool,
 | 
						|
    forwarder_user_profile: Optional[UserProfile],
 | 
						|
    sender: UserProfile,
 | 
						|
    allow_deactivated: bool = False,
 | 
						|
) -> Recipient:
 | 
						|
    recipient_profiles = validate_recipient_user_profiles(
 | 
						|
        user_profiles, sender, allow_deactivated=allow_deactivated
 | 
						|
    )
 | 
						|
 | 
						|
    return get_recipient_from_user_profiles(
 | 
						|
        recipient_profiles, forwarded_mirror_message, forwarder_user_profile, sender
 | 
						|
    )
 |