model: Add can_user_edit_topic function.

The function verifies whether editing a message or editing a
community topic is disabled. Also if the current user is eligible to
edit a topic according to organization permissions is checked.
New test added.

Author: srdeotarse

tests/model/test_model.py

@@ -1097,11 +1097,11 @@ def test_get_latest_message_in_topic(
                 },
                 {
                     "_": ["User not found", False],
-                    "_owner": ["Editing messages is disabled", False],
-                    "_admin": ["Editing messages is disabled", False],
-                    "_moderator": ["Editing messages is disabled", False],
-                    "_member": ["Editing messages is disabled", False],
-                    "_guest": ["Editing messages is disabled", False],
+                    "_owner": [" Editing messages is disabled", False],
+                    "_admin": [" Editing messages is disabled", False],
+                    "_moderator": [" Editing messages is disabled", False],
+                    "_member": [" Editing messages is disabled", False],
+                    "_guest": [" Editing messages is disabled", False],
                 },
                 id="editing_msg_disabled:PreZulip4.0",
             ),
@@ -1114,9 +1114,9 @@ def test_get_latest_message_in_topic(
                     "_": ["User not found", False],
                     "_owner": ["", True],
                     "_admin": ["", True],
-                    "_moderator": ["Editing topic is disabled", False],
-                    "_member": ["Editing topic is disabled", False],
-                    "_guest": ["Editing topic is disabled", False],
+                    "_moderator": [" Editing topic is disabled", False],
+                    "_member": [" Editing topic is disabled", False],
+                    "_guest": [" Editing topic is disabled", False],
                 },
                 id="editing_topic_disabled:PreZulip4.0",
             ),
@@ -1135,18 +1135,6 @@ def test_get_latest_message_in_topic(
                 },
                 id="editing_topic_and_msg_enabled:PreZulip4.0",
             ),
-            case(
-                {"allow_message_editing": False, "edit_topic_policy": 1},
-                {
-                    "_": ["User not found", False],
-                    "_owner": ["Editing messages is disabled", False],
-                    "_admin": ["Editing messages is disabled", False],
-                    "_moderator": ["Editing messages is disabled", False],
-                    "_member": ["Editing messages is disabled", False],
-                    "_guest": ["Editing messages is disabled", False],
-                },
-                id="all_but_no_editing:Zulip4.0+:ZFL75",
-            ),
             case(
                 {"allow_message_editing": True, "edit_topic_policy": 1},
                 {
@@ -1156,8 +1144,8 @@ def test_get_latest_message_in_topic(
                     "_moderator": ["", True],
                     "_member": ["", True],
                     "_guest": [
-                        "Only organization administrators, moderators, full members and"
-                        " members can edit topic",
+                        "Only organization administrators, moderators, full members"
+                        " and members can edit topic",
                         False,
                     ],
                 },
@@ -1208,13 +1196,13 @@ def test_get_latest_message_in_topic(
                     "_admin": ["", True],
                     "_moderator": ["", True],
                     "_member": [
-                        "Only organization administrators and moderators"
-                        " can edit topic",
+                        "Only organization administrators and moderators can edit"
+                        " topic",
                         False,
                     ],
                     "_guest": [
-                        "Only organization administrators and moderators"
-                        " can edit topic",
+                        "Only organization administrators and moderators can edit"
+                        " topic",
                         False,
                     ],
                 },
@@ -1246,9 +1234,9 @@ def test_can_user_edit_topic(
     ):
         model.get_user_info = mocker.Mock(return_value=user_role)
         model.initial_data = initial_data
-        initial_data["realm_allow_message_editing"] = realm_editing_settings[
+        initial_data["realm_allow_message_editing"] = realm_editing_settings.get(
             "allow_message_editing"
-        ]
+        )
         allow_community_topic_editing = realm_editing_settings.get(
             "allow_community_topic_editing", None
         )

zulipterminal/model.py

@@ -648,7 +648,7 @@ def can_user_edit_topic(self) -> bool:
         user_info = self.get_user_info(self.user_id)
         if user_info is not None:
             if not self.initial_data.get("realm_allow_message_editing"):
-                self.controller.report_error("Editing messages is disabled")
+                self.controller.report_error(" Editing messages is disabled")
                 return False
             role = user_info["role"]
             if role <= 200:
@@ -661,7 +661,7 @@ def can_user_edit_topic(self) -> bool:
             if allow_community_topic_editing is True:
                 return True
             elif allow_community_topic_editing is False:
-                self.controller.report_error("Editing topic is disabled")
+                self.controller.report_error(" Editing topic is disabled")
                 return False
             else:
                 edit_topic_policy = self.initial_data.get("realm_edit_topic_policy")
@@ -693,7 +693,7 @@ def can_user_edit_topic(self) -> bool:
                     else:
                         self.controller.report_error(EDIT_TOPIC_POLICY[1])
                         return False
-                else:  # edit_topic_policy == 5 (or None)
+                else:
                     # All users including guests
                     return True
         self.controller.report_error("User not found")