feat: get contact-id for info messages (#6714)

instead of showing addresses in info message, provide an API to get the
contact-id.

UI can then make the info message tappable and open the contact profile
in scope

the corresponding iOS PR - incl. **screencast** - is at
deltachat/deltachat-ios#2652 ; jsonrpc can come
in a subsequent PR when things are settled on android/ios

the number of parameters in `add_info_msg_with_cmd` gets bigger and
bigger, however, i did not want to refactor this in this PR. it is also
not really adding complexity



closes #6702

---------

Co-authored-by: link2xt <link2xt@testrun.org>
Co-authored-by: Hocuri <hocuri@gmx.de>

Author: 3 people

deltachat-ffi/deltachat.h

@@ -4483,13 +4483,22 @@ int             dc_msg_is_info                (const dc_msg_t* msg);
  * UIs can display e.g. an icon based upon the type.
  *
  * Currently, the following types are defined:
+ * - DC_INFO_GROUP_NAME_CHANGED (2) - "Group name changd from OLD to BY by CONTACT"
+ * - DC_INFO_GROUP_IMAGE_CHANGED (3) - "Group image changd by CONTACT"
+ * - DC_INFO_MEMBER_ADDED_TO_GROUP (4) - "Member CONTACT added by OTHER_CONTACT"
+ * - DC_INFO_MEMBER_REMOVED_FROM_GROUP (5) - "Member CONTACT removed by OTHER_CONTACT"
+ * - DC_INFO_EPHEMERAL_TIMER_CHANGED (10) - "Disappearing messages CHANGED_TO by CONTACT"
  * - DC_INFO_PROTECTION_ENABLED (11) - Info-message for "Chat is now protected"
  * - DC_INFO_PROTECTION_DISABLED (12) - Info-message for "Chat is no longer protected"
  * - DC_INFO_INVALID_UNENCRYPTED_MAIL (13) - Info-message for "Provider requires end-to-end encryption which is not setup yet",
  *   the UI should change the corresponding string using #DC_STR_INVALID_UNENCRYPTED_MAIL
  *   and also offer a way to fix the encryption, eg. by a button offering a QR scan
  * - DC_INFO_WEBXDC_INFO_MESSAGE (32) - Info-message created by webxdc app sending `update.info`
  *
+ * For the messages that refer to a CONTACT,
+ * dc_msg_get_info_contact_id() returns the contact ID.
+ * The UI should open the contact's profile when tapping the info message.
+ *
  * Even when you display an icon,
  * you should still display the text of the informational message using dc_msg_get_text()
  *
@@ -4502,6 +4511,29 @@ int             dc_msg_is_info                (const dc_msg_t* msg);
 int             dc_msg_get_info_type          (const dc_msg_t* msg);
 
 
+/**
+ * Return the contact ID of the profile to open when tapping the info message.
+ *
+ * - For DC_INFO_MEMBER_ADDED_TO_GROUP and DC_INFO_MEMBER_REMOVED_FROM_GROUP,
+ *   this is the contact being added/removed.
+ *   The contact that did the adding/removal is usually only a tap away
+ *   (as introducer and/or atop of the memberlist),
+ *   and usually more known anyways.
+ * - For DC_INFO_GROUP_NAME_CHANGED, DC_INFO_GROUP_IMAGE_CHANGED and DC_INFO_EPHEMERAL_TIMER_CHANGED
+ *   this is the contact who did the change.
+ *
+ * No need to check additionally for dc_msg_get_info_type(),
+ * unless you e.g. want to show the info message in another style.
+ *
+ * @memberof dc_msg_t
+ * @param msg The message object.
+ * @return If the info message refers to a contact,
+ *     this contact ID or DC_CONTACT_ID_SELF is returned.
+ *     Otherwise 0.
+ */
+uint32_t        dc_msg_get_info_contact_id    (const dc_msg_t* msg);
+
+
 // DC_INFO* uses the same values as SystemMessage in rust-land
 #define         DC_INFO_UNKNOWN                    0
 #define         DC_INFO_GROUP_NAME_CHANGED         2

deltachat-ffi/src/lib.rs

@@ -3730,6 +3730,20 @@ pub unsafe extern "C" fn dc_msg_get_info_type(msg: *mut dc_msg_t) -> libc::c_int
     ffi_msg.message.get_info_type() as libc::c_int
 }
 
+#[no_mangle]
+pub unsafe extern "C" fn dc_msg_get_info_contact_id(msg: *mut dc_msg_t) -> u32 {
+    if msg.is_null() {
+        eprintln!("ignoring careless call to dc_msg_get_info_contact_id()");
+        return 0;
+    }
+    let ffi_msg = &*msg;
+    let context = &*ffi_msg.context;
+    block_on(ffi_msg.message.get_info_contact_id(context))
+        .unwrap_or_default()
+        .map(|id| id.to_u32())
+        .unwrap_or_default()
+}
+
 #[no_mangle]
 pub unsafe extern "C" fn dc_msg_get_webxdc_href(msg: *mut dc_msg_t) -> *mut libc::c_char {
     if msg.is_null() {

deltachat-rpc-client/tests/test_securejoin.py

@@ -89,7 +89,7 @@ def test_qr_securejoin(acfactory, protect):
     assert alice_contact_bob_snapshot.is_verified
 
     snapshot = bob.get_message_by_id(bob.wait_for_incoming_msg_event().msg_id).get_snapshot()
-    assert snapshot.text == "Member Me ({}) added by {}.".format(bob.get_config("addr"), alice.get_config("addr"))
+    assert snapshot.text == "Member Me added by {}.".format(alice.get_config("addr"))
     assert snapshot.chat.get_basic_snapshot().is_protected == protect
 
     # Test that Bob verified Alice's profile.
@@ -563,7 +563,7 @@ def test_securejoin_after_contact_resetup(acfactory) -> None:
 
     # ac1 waits for member added message and creates a QR code.
     snapshot = ac1.get_message_by_id(ac1.wait_for_incoming_msg_event().msg_id).get_snapshot()
-    assert snapshot.text == "Member Me ({}) added by {}.".format(ac1.get_config("addr"), ac3.get_config("addr"))
+    assert snapshot.text == "Member Me added by {}.".format(ac3.get_config("addr"))
     ac1_qr_code = snapshot.chat.get_qr_code()
 
     # ac2 verifies ac1
@@ -646,7 +646,7 @@ def test_withdraw_securejoin_qr(acfactory):
     alice.clear_all_events()
 
     snapshot = bob.get_message_by_id(bob.wait_for_incoming_msg_event().msg_id).get_snapshot()
-    assert snapshot.text == "Member Me ({}) added by {}.".format(bob.get_config("addr"), alice.get_config("addr"))
+    assert snapshot.text == "Member Me added by {}.".format(alice.get_config("addr"))
     assert snapshot.chat.get_basic_snapshot().is_protected
     bob_chat.leave()
 

python/tests/test_1_online.py

@@ -1346,7 +1346,7 @@ def test_qr_email_capitalization(acfactory, lp):
     lp.sec("ac1 joins a verified group via a QR code")
     ac1_chat = ac1.qr_join_chat(qr)
     msg = ac1._evtracker.wait_next_incoming_message()
-    assert msg.text == "Member Me ({}) added by {}.".format(ac1.get_config("addr"), ac3.get_config("addr"))
+    assert msg.text == "Member Me added by {}.".format(ac3.get_config("addr"))
     assert len(ac1_chat.get_contacts()) == 2
 
     lp.sec("ac2 joins a verified group via a QR code")

src/chat.rs

@@ -582,7 +582,18 @@ impl ChatId {
             ProtectionStatus::Unprotected => SystemMessage::ChatProtectionDisabled,
             ProtectionStatus::ProtectionBroken => SystemMessage::ChatProtectionDisabled,
         };
-        add_info_msg_with_cmd(context, self, &text, cmd, timestamp_sort, None, None, None).await?;
+        add_info_msg_with_cmd(
+            context,
+            self,
+            &text,
+            cmd,
+            timestamp_sort,
+            None,
+            None,
+            None,
+            None,
+        )
+        .await?;
 
         Ok(())
     }
@@ -1791,6 +1802,7 @@ impl Chat {
             Some(now),
             None,
             None,
+            None,
         )
         .await?;
         context.emit_event(EventType::ChatModified(self.id));
@@ -3942,6 +3954,8 @@ pub(crate) async fn add_contact_to_chat_ex(
         msg.param.set_cmd(SystemMessage::MemberAddedToGroup);
         msg.param.set(Param::Arg, contact_addr);
         msg.param.set_int(Param::Arg2, from_handshake.into());
+        msg.param
+            .set_int(Param::ContactAddedRemoved, contact.id.to_u32() as i32);
         send_msg(context, chat_id, &mut msg).await?;
 
         sync = Nosync;
@@ -4139,6 +4153,8 @@ pub async fn remove_contact_from_chat(
                     }
                     msg.param.set_cmd(SystemMessage::MemberRemovedFromGroup);
                     msg.param.set(Param::Arg, contact.get_addr().to_lowercase());
+                    msg.param
+                        .set(Param::ContactAddedRemoved, contact.id.to_u32() as i32);
                     let res = send_msg(context, chat_id, &mut msg).await;
                     if contact_id == ContactId::SELF {
                         res?;
@@ -4737,13 +4753,17 @@ pub(crate) async fn add_info_msg_with_cmd(
     timestamp_sent_rcvd: Option<i64>,
     parent: Option<&Message>,
     from_id: Option<ContactId>,
+    added_removed_id: Option<ContactId>,
 ) -> Result<MsgId> {
     let rfc724_mid = create_outgoing_rfc724_mid();
     let ephemeral_timer = chat_id.get_ephemeral_timer(context).await?;
 
     let mut param = Params::new();
     if cmd != SystemMessage::Unknown {
-        param.set_cmd(cmd)
+        param.set_cmd(cmd);
+    }
+    if let Some(contact_id) = added_removed_id {
+        param.set(Param::ContactAddedRemoved, contact_id.to_u32().to_string());
     }
 
     let row_id =
@@ -4791,6 +4811,7 @@ pub(crate) async fn add_info_msg(
         None,
         None,
         None,
+        None,
     )
     .await
 }

src/chat/chat_tests.rs

@@ -1,6 +1,7 @@
 use super::*;
 use crate::chatlist::get_archived_cnt;
 use crate::constants::{DC_GCL_ARCHIVED_ONLY, DC_GCL_NO_SPECIALS};
+use crate::ephemeral::Timer;
 use crate::headerdef::HeaderDef;
 use crate::imex::{has_backup, imex, ImexMode};
 use crate::message::{delete_msgs, MessengerMessage};
@@ -331,11 +332,12 @@ async fn test_member_add_remove() -> Result<()> {
     // Alice adds Bob to the chat.
     add_contact_to_chat(&alice, alice_chat_id, alice_bob_contact_id).await?;
     let sent = alice.pop_sent_msg().await;
+
     // Locally set name "robert" should not leak.
     assert!(!sent.payload.contains("robert"));
     assert_eq!(
         sent.load_from_db().await.get_text(),
-        "You added member robert (bob@example.net)."
+        "You added member robert."
     );
 
     // Alice removes Bob from the chat.
@@ -344,7 +346,7 @@ async fn test_member_add_remove() -> Result<()> {
     assert!(!sent.payload.contains("robert"));
     assert_eq!(
         sent.load_from_db().await.get_text(),
-        "You removed member robert (bob@example.net)."
+        "You removed member robert."
     );
 
     // Alice leaves the chat.
@@ -412,7 +414,7 @@ async fn test_parallel_member_remove() -> Result<()> {
     // Test that remove message is rewritten.
     assert_eq!(
         bob_received_remove_msg.get_text(),
-        "Member Me (bob@example.net) removed by alice@example.org."
+        "Member Me removed by alice@example.org."
     );
 
     Ok(())
@@ -521,6 +523,14 @@ async fn test_modify_chat_multi_device() -> Result<()> {
     assert!(a2_msg.is_system_message());
     assert_eq!(a1_msg.get_info_type(), SystemMessage::GroupNameChanged);
     assert_eq!(a2_msg.get_info_type(), SystemMessage::GroupNameChanged);
+    assert_eq!(
+        a1_msg.get_info_contact_id(&a1).await?,
+        Some(ContactId::SELF)
+    );
+    assert_eq!(
+        a2_msg.get_info_contact_id(&a2).await?,
+        Some(ContactId::SELF)
+    );
     assert_eq!(Chat::load_from_db(&a1, a1_chat_id).await?.name, "bar");
     assert_eq!(Chat::load_from_db(&a2, a2_chat_id).await?.name, "bar");
 
@@ -1574,6 +1584,7 @@ async fn test_add_info_msg_with_cmd() -> Result<()> {
         None,
         None,
         None,
+        None,
     )
     .await?;
 
@@ -3332,6 +3343,128 @@ async fn test_do_not_overwrite_draft() -> Result<()> {
     Ok(())
 }
 
+#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
+async fn test_info_contact_id() -> Result<()> {
+    let mut tcm = TestContextManager::new();
+    let alice = &tcm.alice().await;
+    let alice2 = &tcm.alice().await;
+    let bob = &tcm.bob().await;
+
+    async fn pop_recv_and_check(
+        alice: &TestContext,
+        alice2: &TestContext,
+        bob: &TestContext,
+        expected_type: SystemMessage,
+        expected_alice_id: ContactId,
+        expected_bob_id: ContactId,
+    ) -> Result<()> {
+        let sent_msg = alice.pop_sent_msg().await;
+        let msg = Message::load_from_db(alice, sent_msg.sender_msg_id).await?;
+        assert_eq!(msg.get_info_type(), expected_type);
+        assert_eq!(
+            msg.get_info_contact_id(alice).await?,
+            Some(expected_alice_id)
+        );
+
+        let msg = alice2.recv_msg(&sent_msg).await;
+        assert_eq!(msg.get_info_type(), expected_type);
+        assert_eq!(
+            msg.get_info_contact_id(alice2).await?,
+            Some(expected_alice_id)
+        );
+
+        let msg = bob.recv_msg(&sent_msg).await;
+        assert_eq!(msg.get_info_type(), expected_type);
+        assert_eq!(msg.get_info_contact_id(bob).await?, Some(expected_bob_id));
+
+        Ok(())
+    }
+
+    // Alice creates group, Bob receives group
+    let alice_chat_id = alice
+        .create_group_with_members(ProtectionStatus::Unprotected, "play", &[bob])
+        .await;
+    let sent_msg1 = alice.send_text(alice_chat_id, "moin").await;
+
+    let msg = bob.recv_msg(&sent_msg1).await;
+    let bob_alice_id = msg.from_id;
+    assert!(!bob_alice_id.is_special());
+
+    // Alice does group changes, Bob receives them
+    set_chat_name(alice, alice_chat_id, "games").await?;
+    pop_recv_and_check(
+        alice,
+        alice2,
+        bob,
+        SystemMessage::GroupNameChanged,
+        ContactId::SELF,
+        bob_alice_id,
+    )
+    .await?;
+
+    let file = alice.get_blobdir().join("avatar.png");
+    let bytes = include_bytes!("../../test-data/image/avatar64x64.png");
+    tokio::fs::write(&file, bytes).await?;
+    set_chat_profile_image(alice, alice_chat_id, file.to_str().unwrap()).await?;
+    pop_recv_and_check(
+        alice,
+        alice2,
+        bob,
+        SystemMessage::GroupImageChanged,
+        ContactId::SELF,
+        bob_alice_id,
+    )
+    .await?;
+
+    alice_chat_id
+        .set_ephemeral_timer(alice, Timer::Enabled { duration: 60 })
+        .await?;
+    pop_recv_and_check(
+        alice,
+        alice2,
+        bob,
+        SystemMessage::EphemeralTimerChanged,
+        ContactId::SELF,
+        bob_alice_id,
+    )
+    .await?;
+
+    let fiona_id = alice.add_or_lookup_contact_id(&tcm.fiona().await).await; // contexts are in sync, fiona_id is same everywhere
+    add_contact_to_chat(alice, alice_chat_id, fiona_id).await?;
+    pop_recv_and_check(
+        alice,
+        alice2,
+        bob,
+        SystemMessage::MemberAddedToGroup,
+        fiona_id,
+        fiona_id,
+    )
+    .await?;
+
+    remove_contact_from_chat(alice, alice_chat_id, fiona_id).await?;
+    pop_recv_and_check(
+        alice,
+        alice2,
+        bob,
+        SystemMessage::MemberRemovedFromGroup,
+        fiona_id,
+        fiona_id,
+    )
+    .await?;
+
+    // When fiona_id is deleted, get_info_contact_id() returns None.
+    // We raw delete in db as Contact::delete() leaves a tombstone (which is great as the tap works longer then)
+    alice
+        .sql
+        .execute("DELETE FROM contacts WHERE id=?", (fiona_id,))
+        .await?;
+    let msg = alice.get_last_msg().await;
+    assert_eq!(msg.get_info_type(), SystemMessage::MemberRemovedFromGroup);
+    assert!(msg.get_info_contact_id(alice).await?.is_none());
+
+    Ok(())
+}
+
 /// Test group consistency.
 #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
 async fn test_add_member_bug() -> Result<()> {

src/contact.rs

@@ -1406,16 +1406,13 @@ impl Contact {
         &self.addr
     }
 
-    /// Get a summary of authorized name and address.
-    ///
-    /// The returned string is either "Name (email@domain.com)" or just
-    /// "email@domain.com" if the name is unset.
+    /// Get authorized name or address.
     ///
     /// This string is suitable for sending over email
     /// as it does not leak the locally set name.
-    pub fn get_authname_n_addr(&self) -> String {
+    pub(crate) fn get_authname_or_addr(&self) -> String {
         if !self.authname.is_empty() {
-            format!("{} ({})", self.authname, self.addr)
+            (&self.authname).into()
         } else {
             (&self.addr).into()
         }