mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	Previous cleanups (mostly the removals of Python __future__ imports) were done in a way that introduced leading newlines. Delete leading newlines from all files, except static/assets/zulip-emoji/NOTICE, which is a verbatim copy of the Apache 2.0 license. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
		
			
				
	
	
		
			127 lines
		
	
	
		
			6.5 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			127 lines
		
	
	
		
			6.5 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
from django.contrib.auth.models import UserManager
 | 
						|
from django.utils.timezone import now as timezone_now
 | 
						|
from zerver.models import UserProfile, Recipient, Subscription, Realm, Stream
 | 
						|
from zerver.lib.upload import copy_avatar
 | 
						|
from zerver.lib.hotspots import copy_hotpots
 | 
						|
from zerver.lib.utils import generate_api_key
 | 
						|
 | 
						|
import ujson
 | 
						|
 | 
						|
from typing import Optional
 | 
						|
 | 
						|
def copy_user_settings(source_profile: UserProfile, target_profile: UserProfile) -> None:
 | 
						|
    """Warning: Does not save, to avoid extra database queries"""
 | 
						|
    for settings_name in UserProfile.property_types:
 | 
						|
        value = getattr(source_profile, settings_name)
 | 
						|
        setattr(target_profile, settings_name, value)
 | 
						|
 | 
						|
    for settings_name in UserProfile.notification_setting_types:
 | 
						|
        value = getattr(source_profile, settings_name)
 | 
						|
        setattr(target_profile, settings_name, value)
 | 
						|
 | 
						|
    setattr(target_profile, "full_name", source_profile.full_name)
 | 
						|
    setattr(target_profile, "enter_sends", source_profile.enter_sends)
 | 
						|
    target_profile.save()
 | 
						|
 | 
						|
    if source_profile.avatar_source == UserProfile.AVATAR_FROM_USER:
 | 
						|
        from zerver.lib.actions import do_change_avatar_fields
 | 
						|
        do_change_avatar_fields(target_profile, UserProfile.AVATAR_FROM_USER)
 | 
						|
        copy_avatar(source_profile, target_profile)
 | 
						|
 | 
						|
    copy_hotpots(source_profile, target_profile)
 | 
						|
 | 
						|
def get_display_email_address(user_profile: UserProfile, realm: Realm) -> str:
 | 
						|
    if realm.email_address_visibility != Realm.EMAIL_ADDRESS_VISIBILITY_EVERYONE:
 | 
						|
        # TODO: realm.host isn't always a valid option here.
 | 
						|
        return "user%s@%s" % (user_profile.id, realm.host.split(':')[0])
 | 
						|
    return user_profile.delivery_email
 | 
						|
 | 
						|
# create_user_profile is based on Django's User.objects.create_user,
 | 
						|
# except that we don't save to the database so it can used in
 | 
						|
# bulk_creates
 | 
						|
#
 | 
						|
# Only use this for bulk_create -- for normal usage one should use
 | 
						|
# create_user (below) which will also make the Subscription and
 | 
						|
# Recipient objects
 | 
						|
def create_user_profile(realm: Realm, email: str, password: Optional[str],
 | 
						|
                        active: bool, bot_type: Optional[int], full_name: str,
 | 
						|
                        short_name: str, bot_owner: Optional[UserProfile],
 | 
						|
                        is_mirror_dummy: bool, tos_version: Optional[str],
 | 
						|
                        timezone: Optional[str],
 | 
						|
                        tutorial_status: Optional[str] = UserProfile.TUTORIAL_WAITING,
 | 
						|
                        enter_sends: bool = False) -> UserProfile:
 | 
						|
    now = timezone_now()
 | 
						|
    email = UserManager.normalize_email(email)
 | 
						|
 | 
						|
    user_profile = UserProfile(is_staff=False, is_active=active,
 | 
						|
                               full_name=full_name, short_name=short_name,
 | 
						|
                               last_login=now, date_joined=now, realm=realm,
 | 
						|
                               pointer=-1, is_bot=bool(bot_type), bot_type=bot_type,
 | 
						|
                               bot_owner=bot_owner, is_mirror_dummy=is_mirror_dummy,
 | 
						|
                               tos_version=tos_version, timezone=timezone,
 | 
						|
                               tutorial_status=tutorial_status,
 | 
						|
                               enter_sends=enter_sends,
 | 
						|
                               onboarding_steps=ujson.dumps([]),
 | 
						|
                               default_language=realm.default_language,
 | 
						|
                               twenty_four_hour_time=realm.default_twenty_four_hour_time,
 | 
						|
                               delivery_email=email)
 | 
						|
 | 
						|
    if bot_type or not active:
 | 
						|
        password = None
 | 
						|
    if realm.email_address_visibility == Realm.EMAIL_ADDRESS_VISIBILITY_EVERYONE:
 | 
						|
        # If emails are visible to everyone, we can set this here and save a DB query
 | 
						|
        user_profile.email = get_display_email_address(user_profile, realm)
 | 
						|
    user_profile.set_password(password)
 | 
						|
    user_profile.api_key = generate_api_key()
 | 
						|
    return user_profile
 | 
						|
 | 
						|
def create_user(email: str, password: Optional[str], realm: Realm,
 | 
						|
                full_name: str, short_name: str, active: bool = True,
 | 
						|
                is_realm_admin: bool = False,
 | 
						|
                is_guest: bool = False,
 | 
						|
                bot_type: Optional[int] = None,
 | 
						|
                bot_owner: Optional[UserProfile] = None,
 | 
						|
                tos_version: Optional[str] = None, timezone: str = "",
 | 
						|
                avatar_source: str = UserProfile.AVATAR_FROM_GRAVATAR,
 | 
						|
                is_mirror_dummy: bool = False,
 | 
						|
                default_sending_stream: Optional[Stream] = None,
 | 
						|
                default_events_register_stream: Optional[Stream] = None,
 | 
						|
                default_all_public_streams: Optional[bool] = None,
 | 
						|
                source_profile: Optional[UserProfile] = None) -> UserProfile:
 | 
						|
    user_profile = create_user_profile(realm, email, password, active, bot_type,
 | 
						|
                                       full_name, short_name, bot_owner,
 | 
						|
                                       is_mirror_dummy, tos_version, timezone)
 | 
						|
    user_profile.is_realm_admin = is_realm_admin
 | 
						|
    user_profile.is_guest = is_guest
 | 
						|
    user_profile.avatar_source = avatar_source
 | 
						|
    user_profile.timezone = timezone
 | 
						|
    user_profile.default_sending_stream = default_sending_stream
 | 
						|
    user_profile.default_events_register_stream = default_events_register_stream
 | 
						|
    # Allow the ORM default to be used if not provided
 | 
						|
    if default_all_public_streams is not None:
 | 
						|
        user_profile.default_all_public_streams = default_all_public_streams
 | 
						|
    # If a source profile was specified, we copy settings from that
 | 
						|
    # user.  Note that this is positioned in a way that overrides
 | 
						|
    # other arguments passed in, which is correct for most defaults
 | 
						|
    # like timezone where the source profile likely has a better value
 | 
						|
    # than the guess. As we decide on details like avatars and full
 | 
						|
    # names for this feature, we may want to move it.
 | 
						|
    if source_profile is not None:
 | 
						|
        # copy_user_settings saves the attribute values so a secondary
 | 
						|
        # save is not required.
 | 
						|
        copy_user_settings(source_profile, user_profile)
 | 
						|
    else:
 | 
						|
        user_profile.save()
 | 
						|
 | 
						|
    if realm.email_address_visibility != Realm.EMAIL_ADDRESS_VISIBILITY_EVERYONE:
 | 
						|
        # With restricted access to email addresses, we can't generate
 | 
						|
        # the fake email addresses we use for display purposes without
 | 
						|
        # a User ID, which isn't generated until the .save() above.
 | 
						|
        user_profile.email = get_display_email_address(user_profile, realm)
 | 
						|
        user_profile.save(update_fields=['email'])
 | 
						|
 | 
						|
    recipient = Recipient.objects.create(type_id=user_profile.id,
 | 
						|
                                         type=Recipient.PERSONAL)
 | 
						|
    Subscription.objects.create(user_profile=user_profile, recipient=recipient)
 | 
						|
    return user_profile
 |