boxes/model: Validate private message recipients more thoroughly.

This commit configures a new helper method to assist with a more
thorough validation of the recipients in the `to_write_box`. The
`tidy_valid_recipients_and_notify_invalid_ones` helper is used to
extract individual recipients, discard any unnecessary text after
the email and then call the `is_valid_private_recipient` helper
from the model.

The `is_valid_private_recipient` helper in `model.py` now also
ensures that the name of the recipient extracted matches the
corresponding name in the `user_dict`.

Tests added.

Author: prah23

tests/ui_tools/test_boxes.py

@@ -78,6 +78,71 @@ def test_not_calling_send_private_message_without_recipients(
 
         assert not write_box.model.send_private_message.called
 
+    @pytest.mark.parametrize(
+        ["raw_recipients", "tidied_recipients"],
+        [
+            ("Human 1 [email protected]", "Human 1 <[email protected]>"),
+            (
+                "Human 2 [email protected] random text",
+                "Human 2 <[email protected]>",
+            ),
+            (
+                "Human Myself [email protected] random, Human 1 <[email protected]>",
+                "Human Myself <[email protected]>, Human 1 <[email protected]>",
+            ),
+            (
+                "Human Myself <[email protected]>, Human 1 [email protected] random",
+                "Human Myself <[email protected]>, Human 1 <[email protected]>",
+            ),
+            (
+                "Human Myself [email protected] random,"
+                "Human 1 [email protected] random",
+                "Human Myself <[email protected]>, Human 1 <[email protected]>",
+            ),
+            (
+                "Human Myself [email protected] random, Human 1 [email protected] "
+                "random, Human 2 [email protected] random",
+                "Human Myself <[email protected]>, Human 1 <[email protected]>, "
+                "Human 2 <[email protected]>",
+            ),
+            (
+                "Human Myself [email protected], Human 1 [email protected] random, "
+                "Human2 [email protected]",
+                "Human Myself <[email protected]>, Human 1 <[email protected]>, "
+                "Human2 <[email protected]>",
+            ),
+        ],
+        ids=[
+            "untidy_with_improper_formatting",
+            "untidy_with_extra_text",
+            "untidy_first_recipient_out_of_two",
+            "untidy_second_recipient_out_of_two",
+            "two_untidy_recipients",
+            "three_untidy_recipients",
+            "untidy_middle_recipient_out_of_three",
+        ],
+    )
+    @pytest.mark.parametrize(
+        "key",
+        keys_for_command("SEND_MESSAGE")
+        + keys_for_command("SAVE_AS_DRAFT")
+        + keys_for_command("CYCLE_COMPOSE_FOCUS"),
+    )
+    def test_tidying_recipients_on_keypresses(
+        self, write_box, widget_size, key, raw_recipients, tidied_recipients
+    ):
+        write_box.private_box_view()
+        write_box.focus_position = write_box.FOCUS_CONTAINER_HEADER
+        write_box.header_write_box.focus_col = write_box.FOCUS_HEADER_BOX_RECIPIENT
+
+        write_box.to_write_box.set_edit_text(raw_recipients)
+        write_box.to_write_box.set_edit_pos(len(raw_recipients))
+
+        size = widget_size(write_box)
+        write_box.keypress(size, key)
+
+        assert write_box.to_write_box.edit_text == tidied_recipients
+
     @pytest.mark.parametrize(
         "text, state",
         [

zulipterminal/model.py

@@ -1019,8 +1019,15 @@ def _handle_typing_event(self, event: Event) -> None:
                 else:
                     raise RuntimeError("Unknown typing event operation")
 
-    def is_valid_private_recipient(self, recipient_email: str) -> bool:
-        return recipient_email in self.user_dict
+    def is_valid_private_recipient(
+        self,
+        recipient_email: str,
+        recipient_name: str,
+    ) -> bool:
+        return (
+            recipient_email in self.user_dict
+            and self.user_dict[recipient_email]["full_name"] == recipient_name
+        )
 
     def is_valid_stream(self, stream_name: str) -> bool:
         for stream in self.stream_dict.values():

zulipterminal/ui_tools/boxes.py

@@ -216,6 +216,50 @@ def track_idleness_and_update_status() -> None:
     def update_recipient_emails(self, write_box: ReadlineEdit) -> None:
         self.recipient_emails = re.findall(r"[\w\.-]+@[\w\.-]+", write_box.edit_text)
 
+    def tidy_valid_recipients_and_notify_invalid_ones(
+        self, write_box: ReadlineEdit
+    ) -> bool:
+        tidied_recipients = list()
+        invalid_recipients = list()
+
+        recipients = [
+            recipient.strip()
+            for recipient in write_box.edit_text.split(",")
+            if recipient.strip()  # This condition avoids whitespace recipients (",  ,")
+        ]
+
+        for recipient in recipients:
+            cleaned_recipient_list = re.findall(
+                r"^(.*?)(?:\s*?<?([\w\.-]+@[\w\.-]+)>?(.*))?$", recipient
+            )
+            recipient_name, recipient_email, invalid_text = cleaned_recipient_list[0]
+            # Discard invalid_text as part of tidying up the recipient.
+
+            if recipient_email:
+                is_valid = self.model.is_valid_private_recipient(
+                    recipient_name, recipient_email
+                )
+            else:
+                is_valid = False
+
+            if is_valid:
+                tidied_recipients.append(f"{recipient_name} <{recipient_email}>")
+            else:
+                invalid_recipients.append(recipient)
+                tidied_recipients.append(recipient)
+
+        write_box.edit_text = ", ".join(tidied_recipients)
+        write_box.edit_pos = len(write_box.edit_text)
+
+        if invalid_recipients:
+            invalid_recipients_error = (
+                f"Invalid recipient(s) - {', '.join(invalid_recipients)}"
+            )
+            self.view.controller.report_error(invalid_recipients_error)
+            return False
+
+        return True
+
     def stream_box_view(
         self, stream_id: int, caption: str = "", title: str = ""
     ) -> None:
@@ -561,6 +605,11 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                         msg_id=self.msg_edit_id,
                     )
                 else:
+                    all_valid = self.tidy_valid_recipients_and_notify_invalid_ones(
+                        self.to_write_box
+                    )
+                    if not all_valid:
+                        return key
                     self.update_recipient_emails(self.to_write_box)
                     if self.recipient_emails:
                         success = self.model.send_private_message(
@@ -587,6 +636,11 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         elif is_command_key("SAVE_AS_DRAFT", key):
             if not self.msg_edit_id:
                 if self.to_write_box:
+                    all_valid = self.tidy_valid_recipients_and_notify_invalid_ones(
+                        self.to_write_box
+                    )
+                    if not all_valid:
+                        return key
                     self.update_recipient_emails(self.to_write_box)
                     this_draft: Composition = PrivateComposition(
                         type="private",
@@ -650,22 +704,12 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                     else:
                         header.focus_col = self.FOCUS_HEADER_BOX_STREAM
                 else:
-                    self.update_recipient_emails(self.to_write_box)
-                    invalid_emails = list()
-
-                    for recipient_email in self.recipient_emails:
-                        is_valid = self.model.is_valid_private_recipient(
-                            recipient_email
-                        )
-                        if not is_valid:
-                            invalid_emails.append(recipient_email)
-
-                    if invalid_emails:
-                        invalid_emails_error = (
-                            f"Invalid recipient(s) - {', '.join(invalid_emails)}"
-                        )
-                        self.view.controller.report_error(invalid_emails_error)
+                    all_valid = self.tidy_valid_recipients_and_notify_invalid_ones(
+                        self.to_write_box
+                    )
+                    if not all_valid:
                         return key
+                    self.update_recipient_emails(self.to_write_box)
                     users = self.model.user_dict
                     self.recipient_user_ids = [
                         users[email]["user_id"] for email in self.recipient_emails