diff --git a/tools/linter_lib/custom_check.py b/tools/linter_lib/custom_check.py index c38d07883a..a489dde55a 100644 --- a/tools/linter_lib/custom_check.py +++ b/tools/linter_lib/custom_check.py @@ -257,7 +257,7 @@ python_rules = RuleList( "description": "Always pass update_fields when saving user_profile objects", "exclude_line": { ( - "zerver/lib/actions.py", + "zerver/actions/bots.py", "user_profile.save() # Can't use update_fields because of how the foreign key works.", ), }, diff --git a/zerver/actions/bots.py b/zerver/actions/bots.py new file mode 100644 index 0000000000..29c303c443 --- /dev/null +++ b/zerver/actions/bots.py @@ -0,0 +1,220 @@ +from typing import Optional + +import orjson +from django.db import transaction +from django.utils.timezone import now as timezone_now + +from zerver.actions.create_user import created_bot_event +from zerver.models import RealmAuditLog, Stream, UserProfile, active_user_ids, bot_owner_user_ids +from zerver.tornado.django_api import send_event + + +@transaction.atomic(durable=True) +def do_change_bot_owner( + user_profile: UserProfile, bot_owner: UserProfile, acting_user: UserProfile +) -> None: + previous_owner = user_profile.bot_owner + user_profile.bot_owner = bot_owner + user_profile.save() # Can't use update_fields because of how the foreign key works. + event_time = timezone_now() + RealmAuditLog.objects.create( + realm=user_profile.realm, + acting_user=acting_user, + modified_user=user_profile, + event_type=RealmAuditLog.USER_BOT_OWNER_CHANGED, + event_time=event_time, + ) + + update_users = bot_owner_user_ids(user_profile) + + # For admins, update event is sent instead of delete/add + # event. bot_data of admin contains all the + # bots and none of them should be removed/(added again). + + # Delete the bot from previous owner's bot data. + if previous_owner and not previous_owner.is_realm_admin: + delete_event = dict( + type="realm_bot", + op="delete", + bot=dict( + user_id=user_profile.id, + ), + ) + transaction.on_commit( + lambda: send_event( + user_profile.realm, + delete_event, + {previous_owner.id}, + ) + ) + # Do not send update event for previous bot owner. + update_users = update_users - {previous_owner.id} + + # Notify the new owner that the bot has been added. + if not bot_owner.is_realm_admin: + add_event = created_bot_event(user_profile) + transaction.on_commit(lambda: send_event(user_profile.realm, add_event, {bot_owner.id})) + # Do not send update event for bot_owner. + update_users = update_users - {bot_owner.id} + + bot_event = dict( + type="realm_bot", + op="update", + bot=dict( + user_id=user_profile.id, + owner_id=user_profile.bot_owner.id, + ), + ) + transaction.on_commit( + lambda: send_event( + user_profile.realm, + bot_event, + update_users, + ) + ) + + # Since `bot_owner_id` is included in the user profile dict we need + # to update the users dict with the new bot owner id + event = dict( + type="realm_user", + op="update", + person=dict( + user_id=user_profile.id, + bot_owner_id=user_profile.bot_owner.id, + ), + ) + transaction.on_commit( + lambda: send_event(user_profile.realm, event, active_user_ids(user_profile.realm_id)) + ) + + +@transaction.atomic(durable=True) +def do_change_default_sending_stream( + user_profile: UserProfile, stream: Optional[Stream], *, acting_user: Optional[UserProfile] +) -> None: + old_value = user_profile.default_sending_stream_id + user_profile.default_sending_stream = stream + user_profile.save(update_fields=["default_sending_stream"]) + + event_time = timezone_now() + RealmAuditLog.objects.create( + realm=user_profile.realm, + event_type=RealmAuditLog.USER_DEFAULT_SENDING_STREAM_CHANGED, + event_time=event_time, + modified_user=user_profile, + acting_user=acting_user, + extra_data=orjson.dumps( + { + RealmAuditLog.OLD_VALUE: old_value, + RealmAuditLog.NEW_VALUE: None if stream is None else stream.id, + } + ).decode(), + ) + + if user_profile.is_bot: + if stream: + stream_name: Optional[str] = stream.name + else: + stream_name = None + event = dict( + type="realm_bot", + op="update", + bot=dict( + user_id=user_profile.id, + default_sending_stream=stream_name, + ), + ) + transaction.on_commit( + lambda: send_event( + user_profile.realm, + event, + bot_owner_user_ids(user_profile), + ) + ) + + +@transaction.atomic(durable=True) +def do_change_default_events_register_stream( + user_profile: UserProfile, stream: Optional[Stream], *, acting_user: Optional[UserProfile] +) -> None: + old_value = user_profile.default_events_register_stream_id + user_profile.default_events_register_stream = stream + user_profile.save(update_fields=["default_events_register_stream"]) + + event_time = timezone_now() + RealmAuditLog.objects.create( + realm=user_profile.realm, + event_type=RealmAuditLog.USER_DEFAULT_REGISTER_STREAM_CHANGED, + event_time=event_time, + modified_user=user_profile, + acting_user=acting_user, + extra_data=orjson.dumps( + { + RealmAuditLog.OLD_VALUE: old_value, + RealmAuditLog.NEW_VALUE: None if stream is None else stream.id, + } + ).decode(), + ) + + if user_profile.is_bot: + if stream: + stream_name: Optional[str] = stream.name + else: + stream_name = None + + event = dict( + type="realm_bot", + op="update", + bot=dict( + user_id=user_profile.id, + default_events_register_stream=stream_name, + ), + ) + transaction.on_commit( + lambda: send_event( + user_profile.realm, + event, + bot_owner_user_ids(user_profile), + ) + ) + + +@transaction.atomic(durable=True) +def do_change_default_all_public_streams( + user_profile: UserProfile, value: bool, *, acting_user: Optional[UserProfile] +) -> None: + old_value = user_profile.default_all_public_streams + user_profile.default_all_public_streams = value + user_profile.save(update_fields=["default_all_public_streams"]) + + event_time = timezone_now() + RealmAuditLog.objects.create( + realm=user_profile.realm, + event_type=RealmAuditLog.USER_DEFAULT_ALL_PUBLIC_STREAMS_CHANGED, + event_time=event_time, + modified_user=user_profile, + acting_user=acting_user, + extra_data=orjson.dumps( + { + RealmAuditLog.OLD_VALUE: old_value, + RealmAuditLog.NEW_VALUE: value, + } + ).decode(), + ) + + if user_profile.is_bot: + event = dict( + type="realm_bot", + op="update", + bot=dict( + user_id=user_profile.id, + default_all_public_streams=user_profile.default_all_public_streams, + ), + ) + transaction.on_commit( + lambda: send_event( + user_profile.realm, + event, + bot_owner_user_ids(user_profile), + ) + ) diff --git a/zerver/lib/actions.py b/zerver/lib/actions.py index 21b303ca2f..1a3d047433 100644 --- a/zerver/lib/actions.py +++ b/zerver/lib/actions.py @@ -13,7 +13,6 @@ from django.utils.translation import override as override_language from typing_extensions import TypedDict from confirmation.models import Confirmation, create_confirmation_link, generate_key -from zerver.actions.create_user import created_bot_event from zerver.actions.custom_profile_fields import do_remove_realm_custom_profile_fields from zerver.actions.message_flags import ( do_mark_muted_user_messages_as_read, @@ -96,7 +95,6 @@ from zerver.models import ( UserMessage, UserProfile, active_user_ids, - bot_owner_user_ids, get_realm, get_realm_domains, get_stream_by_id_in_realm, @@ -722,85 +720,6 @@ def check_update_message( return number_changed -@transaction.atomic(durable=True) -def do_change_bot_owner( - user_profile: UserProfile, bot_owner: UserProfile, acting_user: UserProfile -) -> None: - previous_owner = user_profile.bot_owner - user_profile.bot_owner = bot_owner - user_profile.save() # Can't use update_fields because of how the foreign key works. - event_time = timezone_now() - RealmAuditLog.objects.create( - realm=user_profile.realm, - acting_user=acting_user, - modified_user=user_profile, - event_type=RealmAuditLog.USER_BOT_OWNER_CHANGED, - event_time=event_time, - ) - - update_users = bot_owner_user_ids(user_profile) - - # For admins, update event is sent instead of delete/add - # event. bot_data of admin contains all the - # bots and none of them should be removed/(added again). - - # Delete the bot from previous owner's bot data. - if previous_owner and not previous_owner.is_realm_admin: - delete_event = dict( - type="realm_bot", - op="delete", - bot=dict( - user_id=user_profile.id, - ), - ) - transaction.on_commit( - lambda: send_event( - user_profile.realm, - delete_event, - {previous_owner.id}, - ) - ) - # Do not send update event for previous bot owner. - update_users = update_users - {previous_owner.id} - - # Notify the new owner that the bot has been added. - if not bot_owner.is_realm_admin: - add_event = created_bot_event(user_profile) - transaction.on_commit(lambda: send_event(user_profile.realm, add_event, {bot_owner.id})) - # Do not send update event for bot_owner. - update_users = update_users - {bot_owner.id} - - bot_event = dict( - type="realm_bot", - op="update", - bot=dict( - user_id=user_profile.id, - owner_id=user_profile.bot_owner.id, - ), - ) - transaction.on_commit( - lambda: send_event( - user_profile.realm, - bot_event, - update_users, - ) - ) - - # Since `bot_owner_id` is included in the user profile dict we need - # to update the users dict with the new bot owner id - event = dict( - type="realm_user", - op="update", - person=dict( - user_id=user_profile.id, - bot_owner_id=user_profile.bot_owner.id, - ), - ) - transaction.on_commit( - lambda: send_event(user_profile.realm, event, active_user_ids(user_profile.realm_id)) - ) - - @transaction.atomic(durable=True) def do_change_realm_org_type( realm: Realm, @@ -872,138 +791,6 @@ def do_change_realm_plan_type( transaction.on_commit(lambda: send_event(realm, event, active_user_ids(realm.id))) -@transaction.atomic(durable=True) -def do_change_default_sending_stream( - user_profile: UserProfile, stream: Optional[Stream], *, acting_user: Optional[UserProfile] -) -> None: - old_value = user_profile.default_sending_stream_id - user_profile.default_sending_stream = stream - user_profile.save(update_fields=["default_sending_stream"]) - - event_time = timezone_now() - RealmAuditLog.objects.create( - realm=user_profile.realm, - event_type=RealmAuditLog.USER_DEFAULT_SENDING_STREAM_CHANGED, - event_time=event_time, - modified_user=user_profile, - acting_user=acting_user, - extra_data=orjson.dumps( - { - RealmAuditLog.OLD_VALUE: old_value, - RealmAuditLog.NEW_VALUE: None if stream is None else stream.id, - } - ).decode(), - ) - - if user_profile.is_bot: - if stream: - stream_name: Optional[str] = stream.name - else: - stream_name = None - event = dict( - type="realm_bot", - op="update", - bot=dict( - user_id=user_profile.id, - default_sending_stream=stream_name, - ), - ) - transaction.on_commit( - lambda: send_event( - user_profile.realm, - event, - bot_owner_user_ids(user_profile), - ) - ) - - -@transaction.atomic(durable=True) -def do_change_default_events_register_stream( - user_profile: UserProfile, stream: Optional[Stream], *, acting_user: Optional[UserProfile] -) -> None: - old_value = user_profile.default_events_register_stream_id - user_profile.default_events_register_stream = stream - user_profile.save(update_fields=["default_events_register_stream"]) - - event_time = timezone_now() - RealmAuditLog.objects.create( - realm=user_profile.realm, - event_type=RealmAuditLog.USER_DEFAULT_REGISTER_STREAM_CHANGED, - event_time=event_time, - modified_user=user_profile, - acting_user=acting_user, - extra_data=orjson.dumps( - { - RealmAuditLog.OLD_VALUE: old_value, - RealmAuditLog.NEW_VALUE: None if stream is None else stream.id, - } - ).decode(), - ) - - if user_profile.is_bot: - if stream: - stream_name: Optional[str] = stream.name - else: - stream_name = None - - event = dict( - type="realm_bot", - op="update", - bot=dict( - user_id=user_profile.id, - default_events_register_stream=stream_name, - ), - ) - transaction.on_commit( - lambda: send_event( - user_profile.realm, - event, - bot_owner_user_ids(user_profile), - ) - ) - - -@transaction.atomic(durable=True) -def do_change_default_all_public_streams( - user_profile: UserProfile, value: bool, *, acting_user: Optional[UserProfile] -) -> None: - old_value = user_profile.default_all_public_streams - user_profile.default_all_public_streams = value - user_profile.save(update_fields=["default_all_public_streams"]) - - event_time = timezone_now() - RealmAuditLog.objects.create( - realm=user_profile.realm, - event_type=RealmAuditLog.USER_DEFAULT_ALL_PUBLIC_STREAMS_CHANGED, - event_time=event_time, - modified_user=user_profile, - acting_user=acting_user, - extra_data=orjson.dumps( - { - RealmAuditLog.OLD_VALUE: old_value, - RealmAuditLog.NEW_VALUE: value, - } - ).decode(), - ) - - if user_profile.is_bot: - event = dict( - type="realm_bot", - op="update", - bot=dict( - user_id=user_profile.id, - default_all_public_streams=user_profile.default_all_public_streams, - ), - ) - transaction.on_commit( - lambda: send_event( - user_profile.realm, - event, - bot_owner_user_ids(user_profile), - ) - ) - - def set_realm_permissions_based_on_org_type(realm: Realm) -> None: """This function implements overrides for the default configuration for new organizations when the administrator selected specific diff --git a/zerver/tests/test_audit_log.py b/zerver/tests/test_audit_log.py index 2d96563421..a77a8f6f0e 100644 --- a/zerver/tests/test_audit_log.py +++ b/zerver/tests/test_audit_log.py @@ -6,6 +6,12 @@ from django.contrib.auth.password_validation import validate_password from django.utils.timezone import now as timezone_now from analytics.models import StreamCount +from zerver.actions.bots import ( + do_change_bot_owner, + do_change_default_all_public_streams, + do_change_default_events_register_stream, + do_change_default_sending_stream, +) from zerver.actions.create_user import ( do_activate_mirror_dummy_user, do_create_user, @@ -31,10 +37,6 @@ from zerver.actions.user_settings import ( from zerver.actions.users import do_change_user_role, do_deactivate_user from zerver.lib.actions import ( do_add_realm_domain, - do_change_bot_owner, - do_change_default_all_public_streams, - do_change_default_events_register_stream, - do_change_default_sending_stream, do_change_realm_domain, do_deactivate_realm, do_reactivate_realm, diff --git a/zerver/tests/test_events.py b/zerver/tests/test_events.py index a7b32dd077..8fd0adec72 100644 --- a/zerver/tests/test_events.py +++ b/zerver/tests/test_events.py @@ -14,6 +14,12 @@ import orjson from django.utils.timezone import now as timezone_now from zerver.actions.alert_words import do_add_alert_words, do_remove_alert_words +from zerver.actions.bots import ( + do_change_bot_owner, + do_change_default_all_public_streams, + do_change_default_events_register_stream, + do_change_default_sending_stream, +) from zerver.actions.create_user import do_create_user, do_reactivate_user from zerver.actions.custom_profile_fields import ( do_remove_realm_custom_profile_field, @@ -89,10 +95,6 @@ from zerver.actions.users import ( from zerver.actions.video_calls import do_set_zoom_token from zerver.lib.actions import ( do_add_realm_domain, - do_change_bot_owner, - do_change_default_all_public_streams, - do_change_default_events_register_stream, - do_change_default_sending_stream, do_change_realm_domain, do_change_realm_plan_type, do_deactivate_realm, diff --git a/zerver/views/users.py b/zerver/views/users.py index ac4ef87825..852a45c9d6 100644 --- a/zerver/views/users.py +++ b/zerver/views/users.py @@ -6,6 +6,12 @@ from django.http import HttpRequest, HttpResponse from django.shortcuts import redirect from django.utils.translation import gettext as _ +from zerver.actions.bots import ( + do_change_bot_owner, + do_change_default_all_public_streams, + do_change_default_events_register_stream, + do_change_default_sending_stream, +) from zerver.actions.create_user import do_create_user, do_reactivate_user, notify_created_bot from zerver.actions.custom_profile_fields import ( check_remove_custom_profile_field_value, @@ -26,12 +32,6 @@ from zerver.actions.users import ( from zerver.context_processors import get_valid_realm_from_request from zerver.decorator import require_member_or_admin, require_realm_admin from zerver.forms import PASSWORD_TOO_WEAK_ERROR, CreateUserForm -from zerver.lib.actions import ( - do_change_bot_owner, - do_change_default_all_public_streams, - do_change_default_events_register_stream, - do_change_default_sending_stream, -) from zerver.lib.avatar import avatar_url, get_gravatar_url from zerver.lib.bot_config import set_bot_config from zerver.lib.email_validation import email_allowed_for_realm