mirror of
				https://github.com/zulip/zulip.git
				synced 2025-10-31 12:03:46 +00:00 
			
		
		
		
	tos_version is marked as Optional[Text] in UserProfile & is Optional in other places within zerver/lib/create_user.py
		
			
				
	
	
		
			84 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			84 lines
		
	
	
		
			4.0 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
 | |
| import base64
 | |
| import ujson
 | |
| import os
 | |
| import string
 | |
| 
 | |
| from typing import Optional, Text
 | |
| 
 | |
| def random_api_key() -> Text:
 | |
|     choices = string.ascii_letters + string.digits
 | |
|     altchars = ''.join([choices[ord(os.urandom(1)) % 62] for _ in range(2)]).encode("utf-8")
 | |
|     return base64.b64encode(os.urandom(24), altchars=altchars).decode("utf-8")
 | |
| 
 | |
| # 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: Text, password: Optional[Text],
 | |
|                         active: bool, bot_type: Optional[int], full_name: Text,
 | |
|                         short_name: Text, bot_owner: Optional[UserProfile],
 | |
|                         is_mirror_dummy: bool, tos_version: Optional[Text],
 | |
|                         timezone: Optional[Text],
 | |
|                         tutorial_status: Optional[Text] = UserProfile.TUTORIAL_WAITING,
 | |
|                         enter_sends: bool = False) -> UserProfile:
 | |
|     now = timezone_now()
 | |
|     email = UserManager.normalize_email(email)
 | |
| 
 | |
|     user_profile = UserProfile(email=email, 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)
 | |
| 
 | |
|     if bot_type or not active:
 | |
|         password = None
 | |
| 
 | |
|     user_profile.set_password(password)
 | |
| 
 | |
|     user_profile.api_key = random_api_key()
 | |
|     return user_profile
 | |
| 
 | |
| def create_user(email: Text, password: Optional[Text], realm: Realm,
 | |
|                 full_name: Text, short_name: Text, active: bool = True,
 | |
|                 is_realm_admin: bool = False, bot_type: Optional[int] = None,
 | |
|                 bot_owner: Optional[UserProfile] = None,
 | |
|                 tos_version: Optional[Text] = None, timezone: Text = "",
 | |
|                 avatar_source: Text = 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,
 | |
|                 user_profile_id: Optional[int] = 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.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 user_profile_id is not None:
 | |
|         user_profile.id = user_profile_id
 | |
| 
 | |
|     user_profile.save()
 | |
|     recipient = Recipient.objects.create(type_id=user_profile.id,
 | |
|                                          type=Recipient.PERSONAL)
 | |
|     Subscription.objects.create(user_profile=user_profile, recipient=recipient)
 | |
|     return user_profile
 |