Skip to main content

deltachat/
chat.rs

1//! # Chat module.
2
3use std::cmp;
4use std::collections::{BTreeSet, HashMap};
5use std::fmt;
6use std::io::Cursor;
7use std::marker::Sync;
8use std::path::{Path, PathBuf};
9use std::time::Duration;
10
11use anyhow::{Context as _, Result, anyhow, bail, ensure};
12use chrono::TimeZone;
13use deltachat_contact_tools::{ContactAddress, sanitize_bidi_characters, sanitize_single_line};
14use humansize::{BINARY, format_size};
15use mail_builder::mime::MimePart;
16use serde::{Deserialize, Serialize};
17use strum_macros::EnumIter;
18
19use crate::blob::BlobObject;
20use crate::chatlist::Chatlist;
21use crate::chatlist_events;
22use crate::color::str_to_color;
23use crate::config::Config;
24use crate::constants::{
25    self, Blocked, Chattype, DC_CHAT_ID_ALLDONE_HINT, DC_CHAT_ID_ARCHIVED_LINK,
26    DC_CHAT_ID_LAST_SPECIAL, DC_CHAT_ID_TRASH, DC_RESEND_USER_AVATAR_DAYS, EDITED_PREFIX,
27    TIMESTAMP_SENT_TOLERANCE,
28};
29use crate::contact::{self, Contact, ContactId, Origin};
30use crate::context::Context;
31use crate::debug_logging::maybe_set_logging_xdc;
32use crate::download::{
33    DownloadState, PRE_MSG_ATTACHMENT_SIZE_THRESHOLD, PRE_MSG_SIZE_WARNING_THRESHOLD,
34};
35use crate::ephemeral::{Timer as EphemeralTimer, start_chat_ephemeral_timers};
36use crate::events::EventType;
37use crate::key::{Fingerprint, self_fingerprint};
38use crate::location;
39use crate::log::{LogExt, warn};
40use crate::logged_debug_assert;
41use crate::message::{self, Message, MessageState, MsgId, Viewtype};
42use crate::mimefactory::{MimeFactory, RenderedEmail};
43use crate::mimeparser::SystemMessage;
44use crate::param::{Param, Params};
45use crate::pgp::addresses_from_public_key;
46use crate::receive_imf::ReceivedMsg;
47use crate::smtp::{self, send_msg_to_smtp};
48use crate::stock_str;
49use crate::sync::{self, Sync::*, SyncData};
50use crate::tools::{
51    IsNoneOrEmpty, SystemTime, buf_compress, create_broadcast_secret, create_id,
52    create_outgoing_rfc724_mid, create_smeared_timestamp, create_smeared_timestamps, get_abs_path,
53    gm2local_offset, normalize_text, smeared_time, time, truncate_msg_text,
54};
55use crate::webxdc::StatusUpdateSerial;
56
57pub(crate) const PARAM_BROADCAST_SECRET: Param = Param::Arg3;
58
59/// An chat item, such as a message or a marker.
60#[derive(Debug, Copy, Clone, PartialEq, Eq)]
61pub enum ChatItem {
62    /// Chat message stored in the database.
63    Message {
64        /// Database ID of the message.
65        msg_id: MsgId,
66    },
67
68    /// Day marker, separating messages that correspond to different
69    /// days according to local time.
70    DayMarker {
71        /// Marker timestamp, for day markers
72        timestamp: i64,
73    },
74}
75
76/// The reason why messages cannot be sent to the chat.
77///
78/// The reason is mainly for logging and displaying in debug REPL, thus not translated.
79#[derive(Debug, Clone, Copy, PartialEq, Eq)]
80pub(crate) enum CantSendReason {
81    /// Special chat.
82    SpecialChat,
83
84    /// The chat is a device chat.
85    DeviceChat,
86
87    /// The chat is a contact request, it needs to be accepted before sending a message.
88    ContactRequest,
89
90    /// Mailing list without known List-Post header.
91    ReadOnlyMailingList,
92
93    /// Incoming broadcast channel where the user can't send messages.
94    InBroadcast,
95
96    /// Not a member of the chat.
97    NotAMember,
98
99    /// State for 1:1 chat with a key-contact that does not have a key.
100    MissingKey,
101}
102
103impl fmt::Display for CantSendReason {
104    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
105        match self {
106            Self::SpecialChat => write!(f, "the chat is a special chat"),
107            Self::DeviceChat => write!(f, "the chat is a device chat"),
108            Self::ContactRequest => write!(
109                f,
110                "contact request chat should be accepted before sending messages"
111            ),
112            Self::ReadOnlyMailingList => {
113                write!(f, "mailing list does not have a know post address")
114            }
115            Self::InBroadcast => {
116                write!(f, "Broadcast channel is read-only")
117            }
118            Self::NotAMember => write!(f, "not a member of the chat"),
119            Self::MissingKey => write!(f, "key is missing"),
120        }
121    }
122}
123
124/// Chat ID, including reserved IDs.
125///
126/// Some chat IDs are reserved to identify special chat types.  This
127/// type can represent both the special as well as normal chats.
128#[derive(
129    Debug, Copy, Clone, Default, PartialEq, Eq, Serialize, Deserialize, Hash, PartialOrd, Ord,
130)]
131pub struct ChatId(u32);
132
133impl ChatId {
134    /// Create a new [ChatId].
135    pub const fn new(id: u32) -> ChatId {
136        ChatId(id)
137    }
138
139    /// An unset ChatId
140    ///
141    /// This is transitional and should not be used in new code.
142    pub fn is_unset(self) -> bool {
143        self.0 == 0
144    }
145
146    /// Whether the chat ID signifies a special chat.
147    ///
148    /// This kind of chat ID can not be used for real chats.
149    pub fn is_special(self) -> bool {
150        (0..=DC_CHAT_ID_LAST_SPECIAL.0).contains(&self.0)
151    }
152
153    /// Chat ID for messages which need to be deleted.
154    ///
155    /// Messages which should be deleted get this chat ID and are
156    /// deleted later.  Deleted messages need to stay around as long
157    /// as they are not deleted on the server so that their rfc724_mid
158    /// remains known and downloading them again can be avoided.
159    pub fn is_trash(self) -> bool {
160        self == DC_CHAT_ID_TRASH
161    }
162
163    /// Chat ID signifying there are **any** number of archived chats.
164    ///
165    /// This chat ID can be returned in a [`Chatlist`] and signals to
166    /// the UI to include a link to the archived chats.
167    ///
168    /// [`Chatlist`]: crate::chatlist::Chatlist
169    pub fn is_archived_link(self) -> bool {
170        self == DC_CHAT_ID_ARCHIVED_LINK
171    }
172
173    /// Virtual chat ID signalling there are **only** archived chats.
174    ///
175    /// This can be included in the chatlist if the
176    /// [`DC_GCL_ADD_ALLDONE_HINT`] flag is used to build the
177    /// [`Chatlist`].
178    ///
179    /// [`DC_GCL_ADD_ALLDONE_HINT`]: crate::constants::DC_GCL_ADD_ALLDONE_HINT
180    /// [`Chatlist`]: crate::chatlist::Chatlist
181    pub fn is_alldone_hint(self) -> bool {
182        self == DC_CHAT_ID_ALLDONE_HINT
183    }
184
185    /// Returns [`ChatId`] of a chat that `msg` belongs to.
186    pub(crate) fn lookup_by_message(msg: &Message) -> Option<Self> {
187        if msg.chat_id == DC_CHAT_ID_TRASH {
188            return None;
189        }
190        if msg.download_state == DownloadState::Undecipherable {
191            return None;
192        }
193        Some(msg.chat_id)
194    }
195
196    /// Returns the [`ChatId`] for the 1:1 chat with `contact_id`
197    /// if it exists and is not blocked.
198    ///
199    /// If the chat does not exist or is blocked, `None` is returned.
200    pub async fn lookup_by_contact(
201        context: &Context,
202        contact_id: ContactId,
203    ) -> Result<Option<Self>> {
204        let Some(chat_id_blocked) = ChatIdBlocked::lookup_by_contact(context, contact_id).await?
205        else {
206            return Ok(None);
207        };
208
209        let chat_id = match chat_id_blocked.blocked {
210            Blocked::Not | Blocked::Request => Some(chat_id_blocked.id),
211            Blocked::Yes => None,
212        };
213        Ok(chat_id)
214    }
215
216    /// Returns the [`ChatId`] for the 1:1 chat with `contact_id`.
217    ///
218    /// If the chat does not yet exist an unblocked chat ([`Blocked::Not`]) is created.
219    ///
220    /// This is an internal API, if **a user action** needs to get a chat
221    /// [`ChatId::create_for_contact`] should be used as this also scales up the
222    /// [`Contact`]'s origin.
223    pub(crate) async fn get_for_contact(context: &Context, contact_id: ContactId) -> Result<Self> {
224        ChatIdBlocked::get_for_contact(context, contact_id, Blocked::Not)
225            .await
226            .map(|chat| chat.id)
227    }
228
229    /// Returns the unblocked 1:1 chat with `contact_id`.
230    ///
231    /// This should be used when **a user action** creates a chat 1:1, it ensures the chat
232    /// exists, is unblocked and scales the [`Contact`]'s origin.
233    pub async fn create_for_contact(context: &Context, contact_id: ContactId) -> Result<Self> {
234        ChatId::create_for_contact_with_blocked(context, contact_id, Blocked::Not).await
235    }
236
237    /// Same as `create_for_contact()` with an additional `create_blocked` parameter
238    /// that is used in case the chat does not exist or to unblock existing chats.
239    /// `create_blocked` won't block already unblocked chats again.
240    pub(crate) async fn create_for_contact_with_blocked(
241        context: &Context,
242        contact_id: ContactId,
243        create_blocked: Blocked,
244    ) -> Result<Self> {
245        let chat_id = match ChatIdBlocked::lookup_by_contact(context, contact_id).await? {
246            Some(chat) => {
247                if create_blocked != Blocked::Not || chat.blocked == Blocked::Not {
248                    return Ok(chat.id);
249                }
250                chat.id.set_blocked(context, Blocked::Not).await?;
251                chat.id
252            }
253            None => {
254                if Contact::real_exists_by_id(context, contact_id).await?
255                    || contact_id == ContactId::SELF
256                {
257                    let chat_id =
258                        ChatIdBlocked::get_for_contact(context, contact_id, create_blocked)
259                            .await
260                            .map(|chat| chat.id)?;
261                    if create_blocked != Blocked::Yes {
262                        info!(context, "Scale up origin of {contact_id} to CreateChat.");
263                        ContactId::scaleup_origin(context, &[contact_id], Origin::CreateChat)
264                            .await?;
265                    }
266                    chat_id
267                } else {
268                    warn!(
269                        context,
270                        "Cannot create chat, contact {contact_id} does not exist."
271                    );
272                    bail!("Can not create chat for non-existing contact");
273                }
274            }
275        };
276        context.emit_msgs_changed_without_ids();
277        chatlist_events::emit_chatlist_changed(context);
278        chatlist_events::emit_chatlist_item_changed(context, chat_id);
279        Ok(chat_id)
280    }
281
282    /// Create a group or mailinglist raw database record with the given parameters.
283    /// The function does not add SELF nor checks if the record already exists.
284    pub(crate) async fn create_multiuser_record(
285        context: &Context,
286        chattype: Chattype,
287        grpid: &str,
288        grpname: &str,
289        create_blocked: Blocked,
290        param: Option<String>,
291        timestamp: i64,
292    ) -> Result<Self> {
293        let grpname = sanitize_single_line(grpname);
294        let timestamp = cmp::min(timestamp, smeared_time(context));
295        let row_id =
296            context.sql.insert(
297                "INSERT INTO chats (type, name, name_normalized, grpid, blocked, created_timestamp, protected, param) VALUES(?, ?, ?, ?, ?, ?, 0, ?)",
298                (
299                    chattype,
300                    &grpname,
301                    normalize_text(&grpname),
302                    grpid,
303                    create_blocked,
304                    timestamp,
305                    param.unwrap_or_default(),
306                ),
307            ).await?;
308
309        let chat_id = ChatId::new(u32::try_from(row_id)?);
310        let chat = Chat::load_from_db(context, chat_id).await?;
311
312        if chat.is_encrypted(context).await? {
313            chat_id.add_e2ee_notice(context, timestamp).await?;
314        }
315
316        info!(
317            context,
318            "Created group/broadcast '{}' grpid={} as {}, blocked={}.",
319            &grpname,
320            grpid,
321            chat_id,
322            create_blocked,
323        );
324
325        Ok(chat_id)
326    }
327
328    async fn set_selfavatar_timestamp(self, context: &Context, timestamp: i64) -> Result<()> {
329        context
330            .sql
331            .execute(
332                "UPDATE contacts
333                 SET selfavatar_sent=?
334                 WHERE id IN(SELECT contact_id FROM chats_contacts WHERE chat_id=? AND add_timestamp >= remove_timestamp)",
335                (timestamp, self),
336            )
337            .await?;
338        Ok(())
339    }
340
341    /// Updates chat blocked status.
342    ///
343    /// Returns true if the value was modified.
344    pub(crate) async fn set_blocked(self, context: &Context, new_blocked: Blocked) -> Result<bool> {
345        if self.is_special() {
346            bail!("ignoring setting of Block-status for {self}");
347        }
348        let count = context
349            .sql
350            .execute(
351                "UPDATE chats SET blocked=?1 WHERE id=?2 AND blocked != ?1",
352                (new_blocked, self),
353            )
354            .await?;
355        Ok(count > 0)
356    }
357
358    /// Blocks the chat as a result of explicit user action.
359    pub async fn block(self, context: &Context) -> Result<()> {
360        self.block_ex(context, Sync).await
361    }
362
363    pub(crate) async fn block_ex(self, context: &Context, sync: sync::Sync) -> Result<()> {
364        let chat = Chat::load_from_db(context, self).await?;
365        let mut delete = false;
366
367        match chat.typ {
368            Chattype::OutBroadcast => {
369                bail!("Can't block chat of type {:?}", chat.typ)
370            }
371            Chattype::Single => {
372                for contact_id in get_chat_contacts(context, self).await? {
373                    if contact_id != ContactId::SELF {
374                        info!(
375                            context,
376                            "Blocking the contact {contact_id} to block 1:1 chat."
377                        );
378                        contact::set_blocked(context, Nosync, contact_id, true).await?;
379                    }
380                }
381            }
382            Chattype::Group => {
383                info!(context, "Can't block groups yet, deleting the chat.");
384                delete = true;
385            }
386            Chattype::Mailinglist | Chattype::InBroadcast => {
387                if self.set_blocked(context, Blocked::Yes).await? {
388                    context.emit_event(EventType::ChatModified(self));
389                }
390            }
391        }
392        chatlist_events::emit_chatlist_changed(context);
393
394        if sync.into() {
395            // NB: For a 1:1 chat this currently triggers `Contact::block()` on other devices.
396            chat.sync(context, SyncAction::Block)
397                .await
398                .log_err(context)
399                .ok();
400        }
401        if delete {
402            self.delete_ex(context, Nosync).await?;
403        }
404        Ok(())
405    }
406
407    /// Unblocks the chat.
408    pub async fn unblock(self, context: &Context) -> Result<()> {
409        self.unblock_ex(context, Sync).await
410    }
411
412    pub(crate) async fn unblock_ex(self, context: &Context, sync: sync::Sync) -> Result<()> {
413        self.set_blocked(context, Blocked::Not).await?;
414
415        chatlist_events::emit_chatlist_changed(context);
416
417        if sync.into() {
418            let chat = Chat::load_from_db(context, self).await?;
419            // TODO: For a 1:1 chat this currently triggers `Contact::unblock()` on other devices.
420            // Maybe we should unblock the contact locally too, this would also resolve discrepancy
421            // with `block()` which also blocks the contact.
422            chat.sync(context, SyncAction::Unblock)
423                .await
424                .log_err(context)
425                .ok();
426        }
427
428        Ok(())
429    }
430
431    /// Accept the contact request.
432    ///
433    /// Unblocks the chat and scales up origin of contacts.
434    pub async fn accept(self, context: &Context) -> Result<()> {
435        self.accept_ex(context, Sync).await
436    }
437
438    pub(crate) async fn accept_ex(self, context: &Context, sync: sync::Sync) -> Result<()> {
439        let chat = Chat::load_from_db(context, self).await?;
440
441        match chat.typ {
442            Chattype::Single | Chattype::Group | Chattype::OutBroadcast | Chattype::InBroadcast => {
443                // Previously accepting a chat literally created a chat because unaccepted chats
444                // went to "contact requests" list rather than normal chatlist.
445                // But for groups we use lower origin because users don't always check all members
446                // before accepting a chat and may not want to have the group members mixed with
447                // existing contacts. `IncomingTo` fits here by its definition.
448                let origin = match chat.typ {
449                    Chattype::Group => Origin::IncomingTo,
450                    _ => Origin::CreateChat,
451                };
452                for contact_id in get_chat_contacts(context, self).await? {
453                    if contact_id != ContactId::SELF {
454                        ContactId::scaleup_origin(context, &[contact_id], origin).await?;
455                    }
456                }
457            }
458            Chattype::Mailinglist => {
459                // If the message is from a mailing list, the contacts are not counted as "known"
460            }
461        }
462
463        if self.set_blocked(context, Blocked::Not).await? {
464            context.emit_event(EventType::ChatModified(self));
465            chatlist_events::emit_chatlist_item_changed(context, self);
466        }
467
468        if sync.into() {
469            chat.sync(context, SyncAction::Accept)
470                .await
471                .log_err(context)
472                .ok();
473        }
474        Ok(())
475    }
476
477    /// Adds message "Messages are end-to-end encrypted".
478    pub(crate) async fn add_e2ee_notice(self, context: &Context, timestamp: i64) -> Result<()> {
479        let text = stock_str::messages_e2ee_info_msg(context);
480
481        // Sort this notice to the very beginning of the chat.
482        // We don't want any message to appear before this notice
483        // which is normally added when encrypted chat is created.
484        let sort_timestamp = 0;
485        add_info_msg_with_cmd(
486            context,
487            self,
488            &text,
489            SystemMessage::ChatE2ee,
490            Some(sort_timestamp),
491            timestamp,
492            None,
493            None,
494            None,
495        )
496        .await?;
497        Ok(())
498    }
499
500    /// Adds info message to the beginning of the chat.
501    ///
502    /// Used for messages such as
503    /// "Others will only see this group after you sent a first message."
504    pub(crate) async fn add_start_info_message(self, context: &Context, text: &str) -> Result<()> {
505        let sort_timestamp = 0;
506        add_info_msg_with_cmd(
507            context,
508            self,
509            text,
510            SystemMessage::Unknown,
511            Some(sort_timestamp),
512            time(),
513            None,
514            None,
515            None,
516        )
517        .await?;
518        Ok(())
519    }
520
521    /// Archives or unarchives a chat.
522    pub async fn set_visibility(self, context: &Context, visibility: ChatVisibility) -> Result<()> {
523        self.set_visibility_ex(context, Sync, visibility).await
524    }
525
526    pub(crate) async fn set_visibility_ex(
527        self,
528        context: &Context,
529        sync: sync::Sync,
530        visibility: ChatVisibility,
531    ) -> Result<()> {
532        ensure!(
533            !self.is_special(),
534            "bad chat_id, can not be special chat: {self}"
535        );
536
537        context
538            .sql
539            .transaction(move |transaction| {
540                if visibility == ChatVisibility::Archived {
541                    transaction.execute(
542                        "UPDATE msgs SET state=? WHERE chat_id=? AND state=?;",
543                        (MessageState::InNoticed, self, MessageState::InFresh),
544                    )?;
545                }
546                transaction.execute(
547                    "UPDATE chats SET archived=? WHERE id=?;",
548                    (visibility, self),
549                )?;
550                Ok(())
551            })
552            .await?;
553
554        if visibility == ChatVisibility::Archived {
555            start_chat_ephemeral_timers(context, self).await?;
556        }
557
558        context.emit_msgs_changed_without_ids();
559        chatlist_events::emit_chatlist_changed(context);
560        chatlist_events::emit_chatlist_item_changed(context, self);
561
562        if sync.into() {
563            let chat = Chat::load_from_db(context, self).await?;
564            chat.sync(context, SyncAction::SetVisibility(visibility))
565                .await
566                .log_err(context)
567                .ok();
568        }
569        Ok(())
570    }
571
572    /// Unarchives a chat that is archived and not muted.
573    /// Needed after a message is added to a chat so that the chat gets a normal visibility again.
574    /// `msg_state` is the state of the message. Matters only for incoming messages currently. For
575    /// multiple outgoing messages the function may be called once with MessageState::Undefined.
576    /// Sending an appropriate event is up to the caller.
577    /// Also emits DC_EVENT_MSGS_CHANGED for DC_CHAT_ID_ARCHIVED_LINK when the number of archived
578    /// chats with unread messages increases (which is possible if the chat is muted).
579    pub async fn unarchive_if_not_muted(
580        self,
581        context: &Context,
582        msg_state: MessageState,
583    ) -> Result<()> {
584        if msg_state != MessageState::InFresh {
585            context
586                .sql
587                .execute(
588                    "UPDATE chats SET archived=0 WHERE id=? AND archived=1 \
589                AND NOT(muted_until=-1 OR muted_until>?)",
590                    (self, time()),
591                )
592                .await?;
593            return Ok(());
594        }
595        let chat = Chat::load_from_db(context, self).await?;
596        if chat.visibility != ChatVisibility::Archived {
597            return Ok(());
598        }
599        if chat.is_muted() {
600            let unread_cnt = context
601                .sql
602                .count(
603                    "SELECT COUNT(*)
604                FROM msgs
605                WHERE state=?
606                AND hidden=0
607                AND chat_id=?",
608                    (MessageState::InFresh, self),
609                )
610                .await?;
611            if unread_cnt == 1 {
612                // Added the first unread message in the chat.
613                context.emit_msgs_changed_without_msg_id(DC_CHAT_ID_ARCHIVED_LINK);
614            }
615            return Ok(());
616        }
617        context
618            .sql
619            .execute("UPDATE chats SET archived=0 WHERE id=?", (self,))
620            .await?;
621        Ok(())
622    }
623
624    /// Emits an appropriate event for a message. `important` is whether a notification should be
625    /// shown.
626    pub(crate) fn emit_msg_event(self, context: &Context, msg_id: MsgId, important: bool) {
627        if important {
628            debug_assert!(!msg_id.is_unset());
629
630            context.emit_incoming_msg(self, msg_id);
631        } else {
632            context.emit_msgs_changed(self, msg_id);
633        }
634    }
635
636    /// Deletes a chat.
637    ///
638    /// Messages are deleted from the device and the chat database entry is deleted.
639    /// After that, a `MsgsChanged` event is emitted.
640    /// Messages are deleted from the server in background.
641    pub async fn delete(self, context: &Context) -> Result<()> {
642        self.delete_ex(context, Sync).await
643    }
644
645    pub(crate) async fn delete_ex(self, context: &Context, sync: sync::Sync) -> Result<()> {
646        ensure!(
647            !self.is_special(),
648            "bad chat_id, can not be a special chat: {self}"
649        );
650
651        let chat = Chat::load_from_db(context, self).await?;
652        let sync_id = match sync {
653            Nosync => None,
654            Sync => chat.get_sync_id(context).await?,
655        };
656
657        context
658            .sql
659            .transaction(|transaction| {
660                transaction.execute(
661                    "UPDATE imap SET target='' WHERE rfc724_mid IN (SELECT rfc724_mid FROM msgs WHERE chat_id=? AND rfc724_mid!='')",
662                    (self,),
663                )?;
664                transaction.execute(
665                    "UPDATE imap SET target='' WHERE rfc724_mid IN (SELECT pre_rfc724_mid FROM msgs WHERE chat_id=? AND pre_rfc724_mid!='')",
666                    (self,),
667                )?;
668                transaction.execute(
669                    "DELETE FROM msgs_mdns WHERE msg_id IN (SELECT id FROM msgs WHERE chat_id=?)",
670                    (self,),
671                )?;
672                // If you change which information is preserved here, also change `MsgId::trash()`
673                // and other places it references.
674                transaction.execute(
675                    "
676INSERT OR REPLACE INTO msgs (id, rfc724_mid, pre_rfc724_mid, timestamp, chat_id, deleted)
677SELECT id, rfc724_mid, pre_rfc724_mid, timestamp, ?, 1 FROM msgs WHERE chat_id=?
678                    ",
679                    (DC_CHAT_ID_TRASH, self),
680                )?;
681                transaction.execute("DELETE FROM chats_contacts WHERE chat_id=?", (self,))?;
682                transaction.execute("DELETE FROM chats WHERE id=?", (self,))?;
683                Ok(())
684            })
685            .await?;
686
687        context.emit_event(EventType::ChatDeleted { chat_id: self });
688        context.emit_msgs_changed_without_ids();
689
690        if let Some(id) = sync_id {
691            self::sync(context, id, SyncAction::Delete)
692                .await
693                .log_err(context)
694                .ok();
695        }
696
697        if chat.is_self_talk() {
698            let mut msg = Message::new_text(stock_str::self_deleted_msg_body(context));
699            add_device_msg(context, None, Some(&mut msg)).await?;
700        }
701        chatlist_events::emit_chatlist_changed(context);
702
703        context
704            .set_config_internal(Config::LastHousekeeping, None)
705            .await?;
706        context.scheduler.interrupt_smtp().await;
707
708        Ok(())
709    }
710
711    /// Sets draft message.
712    ///
713    /// Passing `None` as message just deletes the draft
714    pub async fn set_draft(self, context: &Context, mut msg: Option<&mut Message>) -> Result<()> {
715        if self.is_special() {
716            return Ok(());
717        }
718
719        let changed = match &mut msg {
720            None => self.maybe_delete_draft(context).await?,
721            Some(msg) => self.do_set_draft(context, msg).await?,
722        };
723
724        if changed {
725            if msg.is_some() {
726                match self.get_draft_msg_id(context).await? {
727                    Some(msg_id) => context.emit_msgs_changed(self, msg_id),
728                    None => context.emit_msgs_changed_without_msg_id(self),
729                }
730            } else {
731                context.emit_msgs_changed_without_msg_id(self)
732            }
733        }
734
735        Ok(())
736    }
737
738    /// Returns ID of the draft message, if there is one.
739    async fn get_draft_msg_id(self, context: &Context) -> Result<Option<MsgId>> {
740        let msg_id: Option<MsgId> = context
741            .sql
742            .query_get_value(
743                "SELECT id FROM msgs WHERE chat_id=? AND state=?;",
744                (self, MessageState::OutDraft),
745            )
746            .await?;
747        Ok(msg_id)
748    }
749
750    /// Returns draft message, if there is one.
751    pub async fn get_draft(self, context: &Context) -> Result<Option<Message>> {
752        if self.is_special() {
753            return Ok(None);
754        }
755        match self.get_draft_msg_id(context).await? {
756            Some(draft_msg_id) => {
757                let msg = Message::load_from_db(context, draft_msg_id).await?;
758                Ok(Some(msg))
759            }
760            None => Ok(None),
761        }
762    }
763
764    /// Deletes draft message, if there is one.
765    ///
766    /// Returns `true`, if message was deleted, `false` otherwise.
767    async fn maybe_delete_draft(self, context: &Context) -> Result<bool> {
768        Ok(context
769            .sql
770            .execute(
771                "DELETE FROM msgs WHERE chat_id=? AND state=?",
772                (self, MessageState::OutDraft),
773            )
774            .await?
775            > 0)
776    }
777
778    /// Set provided message as draft message for specified chat.
779    /// Returns true if the draft was added or updated in place.
780    async fn do_set_draft(self, context: &Context, msg: &mut Message) -> Result<bool> {
781        match msg.viewtype {
782            Viewtype::Unknown => bail!("Can not set draft of unknown type."),
783            Viewtype::Text => {
784                if msg.text.is_empty() && msg.in_reply_to.is_none_or_empty() {
785                    bail!("No text and no quote in draft");
786                }
787            }
788            _ => {
789                if msg.viewtype == Viewtype::File
790                    && let Some((better_type, _)) = message::guess_msgtype_from_suffix(msg)
791                        // We do not do an automatic conversion to other viewtypes here so that
792                        // users can send images as "files" to preserve the original quality
793                        // (usually we compress images). The remaining conversions are done by
794                        // `prepare_msg_blob()` later.
795                        .filter(|&(vt, _)| vt == Viewtype::Webxdc || vt == Viewtype::Vcard)
796                {
797                    msg.viewtype = better_type;
798                }
799                if msg.viewtype == Viewtype::Vcard {
800                    let blob = msg
801                        .param
802                        .get_file_blob(context)?
803                        .context("no file stored in params")?;
804                    msg.try_set_vcard(context, &blob.to_abs_path()).await?;
805                }
806            }
807        }
808
809        // set back draft information to allow identifying the draft later on -
810        // no matter if message object is reused or reloaded from db
811        msg.state = MessageState::OutDraft;
812        msg.chat_id = self;
813
814        // if possible, replace existing draft and keep id
815        if !msg.id.is_special()
816            && let Some(old_draft) = self.get_draft(context).await?
817            && old_draft.id == msg.id
818            && old_draft.chat_id == self
819            && old_draft.state == MessageState::OutDraft
820        {
821            let affected_rows = context
822                        .sql.execute(
823                                "UPDATE msgs
824                                SET timestamp=?1,type=?2,txt=?3,txt_normalized=?4,param=?5,mime_in_reply_to=?6
825                                WHERE id=?7
826                                AND (type <> ?2 
827                                    OR txt <> ?3 
828                                    OR txt_normalized <> ?4
829                                    OR param <> ?5
830                                    OR mime_in_reply_to <> ?6);",
831                                (
832                                    time(),
833                                    msg.viewtype,
834                                    &msg.text,
835                                    normalize_text(&msg.text),
836                                    msg.param.to_string(),
837                                    msg.in_reply_to.as_deref().unwrap_or_default(),
838                                    msg.id,
839                                ),
840                            ).await?;
841            return Ok(affected_rows > 0);
842        }
843
844        let row_id = context
845            .sql
846            .transaction(|transaction| {
847                // Delete existing draft if it exists.
848                transaction.execute(
849                    "DELETE FROM msgs WHERE chat_id=? AND state=?",
850                    (self, MessageState::OutDraft),
851                )?;
852
853                // Insert new draft.
854                transaction.execute(
855                    "INSERT INTO msgs (
856                 chat_id,
857                 rfc724_mid,
858                 from_id,
859                 timestamp,
860                 type,
861                 state,
862                 txt,
863                 txt_normalized,
864                 param,
865                 hidden,
866                 mime_in_reply_to)
867         VALUES (?,?,?,?,?,?,?,?,?,?,?);",
868                    (
869                        self,
870                        &msg.rfc724_mid,
871                        ContactId::SELF,
872                        time(),
873                        msg.viewtype,
874                        MessageState::OutDraft,
875                        &msg.text,
876                        normalize_text(&msg.text),
877                        msg.param.to_string(),
878                        1,
879                        msg.in_reply_to.as_deref().unwrap_or_default(),
880                    ),
881                )?;
882
883                Ok(transaction.last_insert_rowid())
884            })
885            .await?;
886        msg.id = MsgId::new(row_id.try_into()?);
887        Ok(true)
888    }
889
890    /// Returns number of messages in a chat.
891    pub async fn get_msg_cnt(self, context: &Context) -> Result<usize> {
892        let count = context
893            .sql
894            .count(
895                "SELECT COUNT(*) FROM msgs WHERE hidden=0 AND chat_id=?",
896                (self,),
897            )
898            .await?;
899        Ok(count)
900    }
901
902    /// Returns the number of fresh messages in the chat.
903    pub async fn get_fresh_msg_cnt(self, context: &Context) -> Result<usize> {
904        // this function is typically used to show a badge counter beside _each_ chatlist item.
905        // to make this as fast as possible, esp. on older devices, we added an combined index over the rows used for querying.
906        // so if you alter the query here, you may want to alter the index over `(state, hidden, chat_id)` in `sql.rs`.
907        //
908        // the impact of the index is significant once the database grows:
909        // - on an older android4 with 18k messages, query-time decreased from 110ms to 2ms
910        // - on an mid-class moto-g or iphone7 with 50k messages, query-time decreased from 26ms or 6ms to 0-1ms
911        // the times are average, no matter if there are fresh messages or not -
912        // and have to be multiplied by the number of items shown at once on the chatlist,
913        // so savings up to 2 seconds are possible on older devices - newer ones will feel "snappier" :)
914        let count = if self.is_archived_link() {
915            context
916                .sql
917                .count(
918                    "SELECT COUNT(DISTINCT(m.chat_id))
919                    FROM msgs m
920                    LEFT JOIN chats c ON m.chat_id=c.id
921                    WHERE m.state=10
922                    and m.hidden=0
923                    AND m.chat_id>9
924                    AND c.blocked=0
925                    AND c.archived=1
926                    ",
927                    (),
928                )
929                .await?
930        } else {
931            context
932                .sql
933                .count(
934                    "SELECT COUNT(*)
935                FROM msgs
936                WHERE state=?
937                AND hidden=0
938                AND chat_id=?;",
939                    (MessageState::InFresh, self),
940                )
941                .await?
942        };
943        Ok(count)
944    }
945
946    pub(crate) async fn created_timestamp(self, context: &Context) -> Result<i64> {
947        Ok(context
948            .sql
949            .query_get_value("SELECT created_timestamp FROM chats WHERE id=?", (self,))
950            .await?
951            .unwrap_or(0))
952    }
953
954    /// Returns timestamp of us joining the chat if we are the member of the chat.
955    pub(crate) async fn join_timestamp(self, context: &Context) -> Result<Option<i64>> {
956        context
957            .sql
958            .query_get_value(
959                "SELECT add_timestamp FROM chats_contacts WHERE chat_id=? AND contact_id=?",
960                (self, ContactId::SELF),
961            )
962            .await
963    }
964
965    /// Returns timestamp of the latest message in the chat,
966    /// including hidden messages or a draft if there is one.
967    pub(crate) async fn get_timestamp(self, context: &Context) -> Result<Option<i64>> {
968        let timestamp = context
969            .sql
970            .query_get_value(
971                "SELECT MAX(timestamp)
972                 FROM msgs
973                 WHERE chat_id=?
974                 HAVING COUNT(*) > 0",
975                (self,),
976            )
977            .await?;
978        Ok(timestamp)
979    }
980
981    /// Returns a list of active similar chat IDs sorted by similarity metric.
982    ///
983    /// Jaccard similarity coefficient is used to estimate similarity of chat member sets.
984    ///
985    /// Chat is considered active if something was posted there within the last 42 days.
986    #[expect(clippy::arithmetic_side_effects)]
987    pub async fn get_similar_chat_ids(self, context: &Context) -> Result<Vec<(ChatId, f64)>> {
988        // Count number of common members in this and other chats.
989        let intersection = context
990            .sql
991            .query_map_vec(
992                "SELECT y.chat_id, SUM(x.contact_id = y.contact_id)
993                 FROM chats_contacts as x
994                 JOIN chats_contacts as y
995                 WHERE x.contact_id > 9
996                   AND y.contact_id > 9
997                   AND x.add_timestamp >= x.remove_timestamp
998                   AND y.add_timestamp >= y.remove_timestamp
999                   AND x.chat_id=?
1000                   AND y.chat_id<>x.chat_id
1001                   AND y.chat_id>?
1002                 GROUP BY y.chat_id",
1003                (self, DC_CHAT_ID_LAST_SPECIAL),
1004                |row| {
1005                    let chat_id: ChatId = row.get(0)?;
1006                    let intersection: f64 = row.get(1)?;
1007                    Ok((chat_id, intersection))
1008                },
1009            )
1010            .await
1011            .context("failed to calculate member set intersections")?;
1012
1013        let chat_size: HashMap<ChatId, f64> = context
1014            .sql
1015            .query_map_collect(
1016                "SELECT chat_id, count(*) AS n
1017                 FROM chats_contacts
1018                 WHERE contact_id > ? AND chat_id > ?
1019                 AND add_timestamp >= remove_timestamp
1020                 GROUP BY chat_id",
1021                (ContactId::LAST_SPECIAL, DC_CHAT_ID_LAST_SPECIAL),
1022                |row| {
1023                    let chat_id: ChatId = row.get(0)?;
1024                    let size: f64 = row.get(1)?;
1025                    Ok((chat_id, size))
1026                },
1027            )
1028            .await
1029            .context("failed to count chat member sizes")?;
1030
1031        let our_chat_size = chat_size.get(&self).copied().unwrap_or_default();
1032        let mut chats_with_metrics = Vec::new();
1033        for (chat_id, intersection_size) in intersection {
1034            if intersection_size > 0.0 {
1035                let other_chat_size = chat_size.get(&chat_id).copied().unwrap_or_default();
1036                let union_size = our_chat_size + other_chat_size - intersection_size;
1037                let metric = intersection_size / union_size;
1038                chats_with_metrics.push((chat_id, metric))
1039            }
1040        }
1041        chats_with_metrics.sort_unstable_by(|(chat_id1, metric1), (chat_id2, metric2)| {
1042            metric2
1043                .partial_cmp(metric1)
1044                .unwrap_or(chat_id2.cmp(chat_id1))
1045        });
1046
1047        // Select up to five similar active chats.
1048        let mut res = Vec::new();
1049        let now = time();
1050        for (chat_id, metric) in chats_with_metrics {
1051            if let Some(chat_timestamp) = chat_id.get_timestamp(context).await?
1052                && now > chat_timestamp + 42 * 24 * 3600
1053            {
1054                // Chat was inactive for 42 days, skip.
1055                continue;
1056            }
1057
1058            if metric < 0.1 {
1059                // Chat is unrelated.
1060                break;
1061            }
1062
1063            let chat = Chat::load_from_db(context, chat_id).await?;
1064            if chat.typ != Chattype::Group {
1065                continue;
1066            }
1067
1068            match chat.visibility {
1069                ChatVisibility::Normal | ChatVisibility::Pinned => {}
1070                ChatVisibility::Archived => continue,
1071            }
1072
1073            res.push((chat_id, metric));
1074            if res.len() >= 5 {
1075                break;
1076            }
1077        }
1078
1079        Ok(res)
1080    }
1081
1082    /// Returns similar chats as a [`Chatlist`].
1083    ///
1084    /// [`Chatlist`]: crate::chatlist::Chatlist
1085    pub async fn get_similar_chatlist(self, context: &Context) -> Result<Chatlist> {
1086        let chat_ids: Vec<ChatId> = self
1087            .get_similar_chat_ids(context)
1088            .await
1089            .context("failed to get similar chat IDs")?
1090            .into_iter()
1091            .map(|(chat_id, _metric)| chat_id)
1092            .collect();
1093        let chatlist = Chatlist::from_chat_ids(context, &chat_ids).await?;
1094        Ok(chatlist)
1095    }
1096
1097    pub(crate) async fn get_param(self, context: &Context) -> Result<Params> {
1098        let res: Option<String> = context
1099            .sql
1100            .query_get_value("SELECT param FROM chats WHERE id=?", (self,))
1101            .await?;
1102        Ok(res
1103            .map(|s| s.parse().unwrap_or_default())
1104            .unwrap_or_default())
1105    }
1106
1107    /// Returns true if the chat is not promoted.
1108    pub(crate) async fn is_unpromoted(self, context: &Context) -> Result<bool> {
1109        let param = self.get_param(context).await?;
1110        let unpromoted = param.get_bool(Param::Unpromoted).unwrap_or_default();
1111        Ok(unpromoted)
1112    }
1113
1114    /// Returns true if the chat is promoted.
1115    pub(crate) async fn is_promoted(self, context: &Context) -> Result<bool> {
1116        let promoted = !self.is_unpromoted(context).await?;
1117        Ok(promoted)
1118    }
1119
1120    /// Returns true if chat is a saved messages chat.
1121    pub async fn is_self_talk(self, context: &Context) -> Result<bool> {
1122        Ok(self.get_param(context).await?.exists(Param::Selftalk))
1123    }
1124
1125    /// Returns true if chat is a device chat.
1126    pub async fn is_device_talk(self, context: &Context) -> Result<bool> {
1127        Ok(self.get_param(context).await?.exists(Param::Devicetalk))
1128    }
1129
1130    async fn parent_query<T, F>(
1131        self,
1132        context: &Context,
1133        fields: &str,
1134        state_out_min: MessageState,
1135        f: F,
1136    ) -> Result<Option<T>>
1137    where
1138        F: Send + FnOnce(&rusqlite::Row) -> rusqlite::Result<T>,
1139        T: Send + 'static,
1140    {
1141        let sql = &context.sql;
1142        let query = format!(
1143            "SELECT {fields} \
1144             FROM msgs \
1145             WHERE chat_id=? \
1146             AND ((state BETWEEN {} AND {}) OR (state >= {})) \
1147             AND NOT hidden \
1148             AND download_state={} \
1149             AND from_id != {} \
1150             ORDER BY timestamp DESC, id DESC \
1151             LIMIT 1;",
1152            MessageState::InFresh as u32,
1153            MessageState::InSeen as u32,
1154            state_out_min as u32,
1155            // Do not reply to not fully downloaded messages. Such a message could be a group chat
1156            // message that we assigned to 1:1 chat.
1157            DownloadState::Done as u32,
1158            // Do not reference info messages, they are not actually sent out
1159            // and have Message-IDs unknown to other chat members.
1160            ContactId::INFO.to_u32(),
1161        );
1162        sql.query_row_optional(&query, (self,), f).await
1163    }
1164
1165    async fn get_parent_mime_headers(
1166        self,
1167        context: &Context,
1168        state_out_min: MessageState,
1169    ) -> Result<Option<(String, String, String)>> {
1170        self.parent_query(
1171            context,
1172            "rfc724_mid, mime_in_reply_to, IFNULL(mime_references, '')",
1173            state_out_min,
1174            |row: &rusqlite::Row| {
1175                let rfc724_mid: String = row.get(0)?;
1176                let mime_in_reply_to: String = row.get(1)?;
1177                let mime_references: String = row.get(2)?;
1178                Ok((rfc724_mid, mime_in_reply_to, mime_references))
1179            },
1180        )
1181        .await
1182    }
1183
1184    /// Returns multi-line text summary of encryption preferences of all chat contacts.
1185    ///
1186    /// This can be used to find out if encryption is not available because
1187    /// keys for some users are missing or simply because the majority of the users in a group
1188    /// prefer plaintext emails.
1189    ///
1190    /// To get more verbose summary for a contact, including its key fingerprint, use [`Contact::get_encrinfo`].
1191    pub async fn get_encryption_info(self, context: &Context) -> Result<String> {
1192        let chat = Chat::load_from_db(context, self).await?;
1193        if !chat.is_encrypted(context).await? {
1194            return Ok(stock_str::encr_none(context));
1195        }
1196
1197        let mut ret = stock_str::messages_are_e2ee(context) + "\n";
1198
1199        for &contact_id in get_chat_contacts(context, self)
1200            .await?
1201            .iter()
1202            .filter(|&contact_id| !contact_id.is_special())
1203        {
1204            let contact = Contact::get_by_id(context, contact_id).await?;
1205            let addr = contact.get_addr();
1206            logged_debug_assert!(
1207                context,
1208                contact.is_key_contact(),
1209                "get_encryption_info: contact {contact_id} is not a key-contact."
1210            );
1211            let fingerprint = contact
1212                .fingerprint()
1213                .context("Contact does not have a fingerprint in encrypted chat")?
1214                .human_readable();
1215            if let Some(public_key) = contact.public_key(context).await? {
1216                if let Some(relay_addrs) = addresses_from_public_key(&public_key) {
1217                    let relays = relay_addrs.join(",");
1218                    ret += &format!("\n{addr}({relays})\n{fingerprint}\n");
1219                } else {
1220                    ret += &format!("\n{addr}\n{fingerprint}\n");
1221                }
1222            } else {
1223                ret += &format!("\n{addr}\n(key missing)\n{fingerprint}\n");
1224            }
1225        }
1226
1227        Ok(ret.trim().to_string())
1228    }
1229
1230    /// Bad evil escape hatch.
1231    ///
1232    /// Avoid using this, eventually types should be cleaned up enough
1233    /// that it is no longer necessary.
1234    pub fn to_u32(self) -> u32 {
1235        self.0
1236    }
1237
1238    pub(crate) async fn reset_gossiped_timestamp(self, context: &Context) -> Result<()> {
1239        context
1240            .sql
1241            .execute("DELETE FROM gossip_timestamp WHERE chat_id=?", (self,))
1242            .await?;
1243        Ok(())
1244    }
1245
1246    /// Returns the sort timestamp for a new message in the chat.
1247    ///
1248    /// `message_timestamp` should be either the message "sent" timestamp or a timestamp of the
1249    /// corresponding event in case of a system message (usually the current system time).
1250    /// `always_sort_to_bottom` makes this adjust the returned timestamp up so that the message goes
1251    /// to the chat bottom.
1252    pub(crate) async fn calc_sort_timestamp(
1253        self,
1254        context: &Context,
1255        message_timestamp: i64,
1256        always_sort_to_bottom: bool,
1257    ) -> Result<i64> {
1258        let mut sort_timestamp = cmp::min(message_timestamp, smeared_time(context));
1259
1260        let last_msg_time: Option<i64> = if always_sort_to_bottom {
1261            // get newest message for this chat
1262
1263            // Let hidden messages also be ordered with protection messages because hidden messages
1264            // also can be or not be verified, so let's preserve this information -- even it's not
1265            // used currently, it can be useful in the future versions.
1266            context
1267                .sql
1268                .query_get_value(
1269                    "SELECT MAX(timestamp)
1270                     FROM msgs
1271                     WHERE chat_id=? AND state!=?
1272                     HAVING COUNT(*) > 0",
1273                    (self, MessageState::OutDraft),
1274                )
1275                .await?
1276        } else {
1277            None
1278        };
1279
1280        if let Some(last_msg_time) = last_msg_time
1281            && last_msg_time > sort_timestamp
1282        {
1283            sort_timestamp = last_msg_time;
1284        }
1285
1286        if let Some(join_timestamp) = self.join_timestamp(context).await? {
1287            // If we are the member of the chat, don't add messages
1288            // before the timestamp of us joining it.
1289            // This is needed to avoid sorting "Member added"
1290            // or automatically sent bot welcome messages
1291            // above SecureJoin system messages.
1292            Ok(std::cmp::max(sort_timestamp, join_timestamp))
1293        } else {
1294            Ok(sort_timestamp)
1295        }
1296    }
1297}
1298
1299impl std::fmt::Display for ChatId {
1300    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1301        if self.is_trash() {
1302            write!(f, "Chat#Trash")
1303        } else if self.is_archived_link() {
1304            write!(f, "Chat#ArchivedLink")
1305        } else if self.is_alldone_hint() {
1306            write!(f, "Chat#AlldoneHint")
1307        } else if self.is_special() {
1308            write!(f, "Chat#Special{}", self.0)
1309        } else {
1310            write!(f, "Chat#{}", self.0)
1311        }
1312    }
1313}
1314
1315/// Allow converting [ChatId] to an SQLite type.
1316///
1317/// This allows you to directly store [ChatId] into the database as
1318/// well as query for a [ChatId].
1319impl rusqlite::types::ToSql for ChatId {
1320    fn to_sql(&self) -> rusqlite::Result<rusqlite::types::ToSqlOutput<'_>> {
1321        let val = rusqlite::types::Value::Integer(i64::from(self.0));
1322        let out = rusqlite::types::ToSqlOutput::Owned(val);
1323        Ok(out)
1324    }
1325}
1326
1327/// Allow converting an SQLite integer directly into [ChatId].
1328impl rusqlite::types::FromSql for ChatId {
1329    fn column_result(value: rusqlite::types::ValueRef) -> rusqlite::types::FromSqlResult<Self> {
1330        i64::column_result(value).and_then(|val| {
1331            if 0 <= val && val <= i64::from(u32::MAX) {
1332                Ok(ChatId::new(val as u32))
1333            } else {
1334                Err(rusqlite::types::FromSqlError::OutOfRange(val))
1335            }
1336        })
1337    }
1338}
1339
1340/// An object representing a single chat in memory.
1341/// Chat objects are created using eg. `Chat::load_from_db`
1342/// and are not updated on database changes;
1343/// if you want an update, you have to recreate the object.
1344#[derive(Debug, Clone, Deserialize, Serialize)]
1345pub struct Chat {
1346    /// Database ID.
1347    pub id: ChatId,
1348
1349    /// Chat type, e.g. 1:1 chat, group chat, mailing list.
1350    pub typ: Chattype,
1351
1352    /// Chat name.
1353    pub name: String,
1354
1355    /// Whether the chat is archived or pinned.
1356    pub visibility: ChatVisibility,
1357
1358    /// Group ID. For [`Chattype::Mailinglist`] -- mailing list address. Empty for 1:1 chats and
1359    /// ad-hoc groups.
1360    pub grpid: String,
1361
1362    /// Whether the chat is blocked, unblocked or a contact request.
1363    pub blocked: Blocked,
1364
1365    /// Additional chat parameters stored in the database.
1366    pub param: Params,
1367
1368    /// If location streaming is enabled in the chat.
1369    is_sending_locations: bool,
1370
1371    /// Duration of the chat being muted.
1372    pub mute_duration: MuteDuration,
1373}
1374
1375impl Chat {
1376    /// Loads chat from the database by its ID.
1377    pub async fn load_from_db(context: &Context, chat_id: ChatId) -> Result<Self> {
1378        let mut chat = context
1379            .sql
1380            .query_row(
1381                "SELECT c.type, c.name, c.grpid, c.param, c.archived,
1382                    c.blocked, c.locations_send_until, c.muted_until
1383             FROM chats c
1384             WHERE c.id=?;",
1385                (chat_id,),
1386                |row| {
1387                    let c = Chat {
1388                        id: chat_id,
1389                        typ: row.get(0)?,
1390                        name: row.get::<_, String>(1)?,
1391                        grpid: row.get::<_, String>(2)?,
1392                        param: row.get::<_, String>(3)?.parse().unwrap_or_default(),
1393                        visibility: row.get(4)?,
1394                        blocked: row.get::<_, Option<_>>(5)?.unwrap_or_default(),
1395                        is_sending_locations: row.get(6)?,
1396                        mute_duration: row.get(7)?,
1397                    };
1398                    Ok(c)
1399                },
1400            )
1401            .await
1402            .context(format!("Failed loading chat {chat_id} from database"))?;
1403
1404        if chat.id.is_archived_link() {
1405            chat.name = stock_str::archived_chats(context);
1406        } else {
1407            if chat.typ == Chattype::Single && chat.name.is_empty() {
1408                // chat.name is set to contact.display_name on changes,
1409                // however, if things went wrong somehow, we do this here explicitly.
1410                let mut chat_name = "Err [Name not found]".to_owned();
1411                match get_chat_contacts(context, chat.id).await {
1412                    Ok(contacts) => {
1413                        if let Some(contact_id) = contacts.first()
1414                            && let Ok(contact) = Contact::get_by_id(context, *contact_id).await
1415                        {
1416                            contact.get_display_name().clone_into(&mut chat_name);
1417                        }
1418                    }
1419                    Err(err) => {
1420                        error!(
1421                            context,
1422                            "Failed to load contacts for {}: {:#}.", chat.id, err
1423                        );
1424                    }
1425                }
1426                chat.name = chat_name;
1427            }
1428            if chat.param.exists(Param::Selftalk) {
1429                chat.name = stock_str::saved_messages(context);
1430            } else if chat.param.exists(Param::Devicetalk) {
1431                chat.name = stock_str::device_messages(context);
1432            }
1433        }
1434
1435        Ok(chat)
1436    }
1437
1438    /// Returns whether this is the `saved messages` chat
1439    pub fn is_self_talk(&self) -> bool {
1440        self.param.exists(Param::Selftalk)
1441    }
1442
1443    /// Returns true if chat is a device chat.
1444    pub fn is_device_talk(&self) -> bool {
1445        self.param.exists(Param::Devicetalk)
1446    }
1447
1448    /// Returns true if chat is a mailing list.
1449    pub fn is_mailing_list(&self) -> bool {
1450        self.typ == Chattype::Mailinglist
1451    }
1452
1453    /// Returns None if user can send messages to this chat.
1454    ///
1455    /// Otherwise returns a reason useful for logging.
1456    pub(crate) async fn why_cant_send(&self, context: &Context) -> Result<Option<CantSendReason>> {
1457        self.why_cant_send_ex(context, &|_| false).await
1458    }
1459
1460    pub(crate) async fn why_cant_send_ex(
1461        &self,
1462        context: &Context,
1463        skip_fn: &(dyn Send + Sync + Fn(&CantSendReason) -> bool),
1464    ) -> Result<Option<CantSendReason>> {
1465        use CantSendReason::*;
1466        // NB: Don't forget to update Chatlist::try_load() when changing this function!
1467
1468        if self.id.is_special() {
1469            let reason = SpecialChat;
1470            if !skip_fn(&reason) {
1471                return Ok(Some(reason));
1472            }
1473        }
1474        if self.is_device_talk() {
1475            let reason = DeviceChat;
1476            if !skip_fn(&reason) {
1477                return Ok(Some(reason));
1478            }
1479        }
1480        if self.is_contact_request() {
1481            let reason = ContactRequest;
1482            if !skip_fn(&reason) {
1483                return Ok(Some(reason));
1484            }
1485        }
1486        if self.is_mailing_list() && self.get_mailinglist_addr().is_none_or_empty() {
1487            let reason = ReadOnlyMailingList;
1488            if !skip_fn(&reason) {
1489                return Ok(Some(reason));
1490            }
1491        }
1492        if self.typ == Chattype::InBroadcast {
1493            let reason = InBroadcast;
1494            if !skip_fn(&reason) {
1495                return Ok(Some(reason));
1496            }
1497        }
1498
1499        // Do potentially slow checks last and after calls to `skip_fn` which should be fast.
1500        let reason = NotAMember;
1501        if !skip_fn(&reason) && !self.is_self_in_chat(context).await? {
1502            return Ok(Some(reason));
1503        }
1504
1505        let reason = MissingKey;
1506        if !skip_fn(&reason) && self.typ == Chattype::Single {
1507            let contact_ids = get_chat_contacts(context, self.id).await?;
1508            if let Some(contact_id) = contact_ids.first() {
1509                let contact = Contact::get_by_id(context, *contact_id).await?;
1510                if contact.is_key_contact() && contact.public_key(context).await?.is_none() {
1511                    return Ok(Some(reason));
1512                }
1513            }
1514        }
1515
1516        Ok(None)
1517    }
1518
1519    /// Returns true if can send to the chat.
1520    ///
1521    /// This function can be used by the UI to decide whether to display the input box.
1522    pub async fn can_send(&self, context: &Context) -> Result<bool> {
1523        Ok(self.why_cant_send(context).await?.is_none())
1524    }
1525
1526    /// Checks if the user is part of a chat
1527    /// and has basically the permissions to edit the chat therefore.
1528    /// The function does not check if the chat type allows editing of concrete elements.
1529    pub async fn is_self_in_chat(&self, context: &Context) -> Result<bool> {
1530        match self.typ {
1531            Chattype::Single | Chattype::OutBroadcast | Chattype::Mailinglist => Ok(true),
1532            Chattype::Group | Chattype::InBroadcast => {
1533                is_contact_in_chat(context, self.id, ContactId::SELF).await
1534            }
1535        }
1536    }
1537
1538    pub(crate) async fn update_param(&mut self, context: &Context) -> Result<()> {
1539        context
1540            .sql
1541            .execute(
1542                "UPDATE chats SET param=? WHERE id=?",
1543                (self.param.to_string(), self.id),
1544            )
1545            .await?;
1546        Ok(())
1547    }
1548
1549    /// Returns chat ID.
1550    pub fn get_id(&self) -> ChatId {
1551        self.id
1552    }
1553
1554    /// Returns chat type.
1555    pub fn get_type(&self) -> Chattype {
1556        self.typ
1557    }
1558
1559    /// Returns chat name.
1560    pub fn get_name(&self) -> &str {
1561        &self.name
1562    }
1563
1564    /// Returns mailing list address where messages are sent to.
1565    pub fn get_mailinglist_addr(&self) -> Option<&str> {
1566        self.param.get(Param::ListPost)
1567    }
1568
1569    /// Returns profile image path for the chat.
1570    pub async fn get_profile_image(&self, context: &Context) -> Result<Option<PathBuf>> {
1571        if self.id.is_archived_link() {
1572            // This is not a real chat, but the "Archive" button
1573            // that is shown at the top of the chats list
1574            return Ok(Some(get_archive_icon(context).await?));
1575        } else if self.is_device_talk() {
1576            return Ok(Some(get_device_icon(context).await?));
1577        } else if self.is_self_talk() {
1578            return Ok(Some(get_saved_messages_icon(context).await?));
1579        } else if !self.is_encrypted(context).await? {
1580            // This is an unencrypted chat, show a special avatar that marks it as such.
1581            return Ok(Some(get_abs_path(
1582                context,
1583                Path::new(&get_unencrypted_icon(context).await?),
1584            )));
1585        } else if self.typ == Chattype::Single {
1586            // For 1:1 chats, we always use the same avatar as for the contact
1587            // This is before the `self.is_encrypted()` check, because that function
1588            // has two database calls, i.e. it's slow
1589            let contacts = get_chat_contacts(context, self.id).await?;
1590            if let Some(contact_id) = contacts.first() {
1591                let contact = Contact::get_by_id(context, *contact_id).await?;
1592                return contact.get_profile_image(context).await;
1593            }
1594        } else if let Some(image_rel) = self.param.get(Param::ProfileImage) {
1595            // Load the group avatar, or the device-chat / saved-messages icon
1596            if !image_rel.is_empty() {
1597                return Ok(Some(get_abs_path(context, Path::new(&image_rel))));
1598            }
1599        }
1600        Ok(None)
1601    }
1602
1603    /// Returns chat avatar color.
1604    ///
1605    /// For 1:1 chats, the color is calculated from the contact's address
1606    /// for address-contacts and from the OpenPGP key fingerprint for key-contacts.
1607    /// For group chats the color is calculated from the grpid, if present, or the chat name.
1608    pub async fn get_color(&self, context: &Context) -> Result<u32> {
1609        let mut color = 0;
1610
1611        if self.typ == Chattype::Single {
1612            let contacts = get_chat_contacts(context, self.id).await?;
1613            if let Some(contact_id) = contacts.first()
1614                && let Ok(contact) = Contact::get_by_id(context, *contact_id).await
1615            {
1616                color = contact.get_color();
1617            }
1618        } else if !self.grpid.is_empty() {
1619            color = str_to_color(&self.grpid);
1620        } else {
1621            color = str_to_color(&self.name);
1622        }
1623
1624        Ok(color)
1625    }
1626
1627    /// Returns a struct describing the current state of the chat.
1628    ///
1629    /// This is somewhat experimental, even more so than the rest of
1630    /// deltachat, and the data returned is still subject to change.
1631    pub async fn get_info(&self, context: &Context) -> Result<ChatInfo> {
1632        let draft = match self.id.get_draft(context).await? {
1633            Some(message) => message.text,
1634            _ => String::new(),
1635        };
1636        Ok(ChatInfo {
1637            id: self.id,
1638            type_: self.typ as u32,
1639            name: self.name.clone(),
1640            archived: self.visibility == ChatVisibility::Archived,
1641            param: self.param.to_string(),
1642            is_sending_locations: self.is_sending_locations,
1643            color: self.get_color(context).await?,
1644            profile_image: self
1645                .get_profile_image(context)
1646                .await?
1647                .unwrap_or_else(std::path::PathBuf::new),
1648            draft,
1649            is_muted: self.is_muted(),
1650            ephemeral_timer: self.id.get_ephemeral_timer(context).await?,
1651        })
1652    }
1653
1654    /// Returns chat visibilitiy, e.g. whether it is archived or pinned.
1655    pub fn get_visibility(&self) -> ChatVisibility {
1656        self.visibility
1657    }
1658
1659    /// Returns true if chat is a contact request.
1660    ///
1661    /// Messages cannot be sent to such chat and read receipts are not
1662    /// sent until the chat is manually unblocked.
1663    pub fn is_contact_request(&self) -> bool {
1664        self.blocked == Blocked::Request
1665    }
1666
1667    /// Returns true if the chat is not promoted.
1668    pub fn is_unpromoted(&self) -> bool {
1669        self.param.get_bool(Param::Unpromoted).unwrap_or_default()
1670    }
1671
1672    /// Returns true if the chat is promoted.
1673    /// This means a message has been sent to it and it _not_ only exists on the users device.
1674    pub fn is_promoted(&self) -> bool {
1675        !self.is_unpromoted()
1676    }
1677
1678    /// Returns true if the chat is encrypted.
1679    pub async fn is_encrypted(&self, context: &Context) -> Result<bool> {
1680        let is_encrypted = self.is_self_talk()
1681            || match self.typ {
1682                Chattype::Single => {
1683                    match context
1684                        .sql
1685                        .query_row_optional(
1686                            "SELECT cc.contact_id, c.fingerprint<>''
1687                             FROM chats_contacts cc LEFT JOIN contacts c
1688                                 ON c.id=cc.contact_id
1689                             WHERE cc.chat_id=?
1690                            ",
1691                            (self.id,),
1692                            |row| {
1693                                let id: ContactId = row.get(0)?;
1694                                let is_key: bool = row.get(1)?;
1695                                Ok((id, is_key))
1696                            },
1697                        )
1698                        .await?
1699                    {
1700                        Some((id, is_key)) => is_key || id == ContactId::DEVICE,
1701                        None => true,
1702                    }
1703                }
1704                Chattype::Group => {
1705                    // Do not encrypt ad-hoc groups.
1706                    !self.grpid.is_empty()
1707                }
1708                Chattype::Mailinglist => false,
1709                Chattype::OutBroadcast | Chattype::InBroadcast => true,
1710            };
1711        Ok(is_encrypted)
1712    }
1713
1714    /// Returns true if location streaming is enabled in the chat.
1715    pub fn is_sending_locations(&self) -> bool {
1716        self.is_sending_locations
1717    }
1718
1719    /// Returns true if the chat is currently muted.
1720    pub fn is_muted(&self) -> bool {
1721        match self.mute_duration {
1722            MuteDuration::NotMuted => false,
1723            MuteDuration::Forever => true,
1724            MuteDuration::Until(when) => when > SystemTime::now(),
1725        }
1726    }
1727
1728    /// Returns chat member list timestamp.
1729    pub(crate) async fn member_list_timestamp(&self, context: &Context) -> Result<i64> {
1730        if let Some(member_list_timestamp) = self.param.get_i64(Param::MemberListTimestamp) {
1731            Ok(member_list_timestamp)
1732        } else {
1733            Ok(self.id.created_timestamp(context).await?)
1734        }
1735    }
1736
1737    /// Returns true if member list is stale,
1738    /// i.e. has not been updated for 60 days.
1739    ///
1740    /// This is used primarily to detect the case
1741    /// where the user just restored an old backup.
1742    pub(crate) async fn member_list_is_stale(&self, context: &Context) -> Result<bool> {
1743        let now = time();
1744        let member_list_ts = self.member_list_timestamp(context).await?;
1745        let is_stale = now.saturating_add(TIMESTAMP_SENT_TOLERANCE)
1746            >= member_list_ts.saturating_add(60 * 24 * 3600);
1747        Ok(is_stale)
1748    }
1749
1750    /// Adds missing values to the msg object,
1751    /// writes the record to the database.
1752    ///
1753    /// If `update_msg_id` is set, that record is reused;
1754    /// if `update_msg_id` is None, a new record is created.
1755    async fn prepare_msg_raw(
1756        &mut self,
1757        context: &Context,
1758        msg: &mut Message,
1759        update_msg_id: Option<MsgId>,
1760    ) -> Result<()> {
1761        let mut to_id = 0;
1762        let mut location_id = 0;
1763
1764        if msg.rfc724_mid.is_empty() {
1765            msg.rfc724_mid = create_outgoing_rfc724_mid();
1766        }
1767
1768        if self.typ == Chattype::Single {
1769            if let Some(id) = context
1770                .sql
1771                .query_get_value(
1772                    "SELECT contact_id FROM chats_contacts WHERE chat_id=?;",
1773                    (self.id,),
1774                )
1775                .await?
1776            {
1777                to_id = id;
1778            } else {
1779                error!(
1780                    context,
1781                    "Cannot send message, contact for {} not found.", self.id,
1782                );
1783                bail!("Cannot set message, contact for {} not found.", self.id);
1784            }
1785        } else if matches!(self.typ, Chattype::Group | Chattype::OutBroadcast)
1786            && self.param.get_int(Param::Unpromoted).unwrap_or_default() == 1
1787        {
1788            msg.param.set_int(Param::AttachChatAvatarAndDescription, 1);
1789            self.param
1790                .remove(Param::Unpromoted)
1791                .set_i64(Param::GroupNameTimestamp, msg.timestamp_sort)
1792                .set_i64(Param::GroupDescriptionTimestamp, msg.timestamp_sort);
1793            self.update_param(context).await?;
1794        }
1795
1796        let is_bot = context.get_config_bool(Config::Bot).await?;
1797        msg.param
1798            .set_optional(Param::Bot, Some("1").filter(|_| is_bot));
1799
1800        // Set "In-Reply-To:" to identify the message to which the composed message is a reply.
1801        // Set "References:" to identify the "thread" of the conversation.
1802        // Both according to [RFC 5322 3.6.4, page 25](https://www.rfc-editor.org/rfc/rfc5322#section-3.6.4).
1803        let new_references;
1804        if self.is_self_talk() {
1805            // As self-talks are mainly used to transfer data between devices,
1806            // we do not set In-Reply-To/References in this case.
1807            new_references = String::new();
1808        } else if let Some((parent_rfc724_mid, parent_in_reply_to, parent_references)) =
1809            // We don't filter `OutPending` and `OutFailed` messages because the new message for
1810            // which `parent_query()` is done may assume that it will be received in a context
1811            // affected by those messages, e.g. they could add new members to a group and the
1812            // new message will contain them in "To:". Anyway recipients must be prepared to
1813            // orphaned references.
1814            self
1815                .id
1816                .get_parent_mime_headers(context, MessageState::OutPending)
1817                .await?
1818        {
1819            // "In-Reply-To:" is not changed if it is set manually.
1820            // This does not affect "References:" header, it will contain "default parent" (the
1821            // latest message in the thread) anyway.
1822            if msg.in_reply_to.is_none() && !parent_rfc724_mid.is_empty() {
1823                msg.in_reply_to = Some(parent_rfc724_mid.clone());
1824            }
1825
1826            // Use parent `In-Reply-To` as a fallback
1827            // in case parent message has no `References` header
1828            // as specified in RFC 5322:
1829            // > If the parent message does not contain
1830            // > a "References:" field but does have an "In-Reply-To:" field
1831            // > containing a single message identifier, then the "References:" field
1832            // > will contain the contents of the parent's "In-Reply-To:" field
1833            // > followed by the contents of the parent's "Message-ID:" field (if
1834            // > any).
1835            let parent_references = if parent_references.is_empty() {
1836                parent_in_reply_to
1837            } else {
1838                parent_references
1839            };
1840
1841            // The whole list of messages referenced may be huge.
1842            // Only take 2 recent references and add third from `In-Reply-To`.
1843            let mut references_vec: Vec<&str> = parent_references.rsplit(' ').take(2).collect();
1844            references_vec.reverse();
1845
1846            if !parent_rfc724_mid.is_empty()
1847                && !references_vec.contains(&parent_rfc724_mid.as_str())
1848            {
1849                references_vec.push(&parent_rfc724_mid)
1850            }
1851
1852            if references_vec.is_empty() {
1853                // As a fallback, use our Message-ID,
1854                // same as in the case of top-level message.
1855                new_references = msg.rfc724_mid.clone();
1856            } else {
1857                new_references = references_vec.join(" ");
1858            }
1859        } else {
1860            // This is a top-level message.
1861            // Add our Message-ID as first references.
1862            // This allows us to identify replies to our message even if
1863            // email server such as Outlook changes `Message-ID:` header.
1864            // MUAs usually keep the first Message-ID in `References:` header unchanged.
1865            new_references = msg.rfc724_mid.clone();
1866        }
1867
1868        // add independent location to database
1869        if msg.param.exists(Param::SetLatitude)
1870            && let Ok(row_id) = context
1871                .sql
1872                .insert(
1873                    "INSERT INTO locations \
1874                     (timestamp,from_id,chat_id, latitude,longitude,independent)\
1875                     VALUES (?,?,?, ?,?,1);",
1876                    (
1877                        msg.timestamp_sort,
1878                        ContactId::SELF,
1879                        self.id,
1880                        msg.param.get_float(Param::SetLatitude).unwrap_or_default(),
1881                        msg.param.get_float(Param::SetLongitude).unwrap_or_default(),
1882                    ),
1883                )
1884                .await
1885        {
1886            location_id = row_id;
1887        }
1888
1889        let ephemeral_timer = if msg.param.get_cmd() == SystemMessage::EphemeralTimerChanged {
1890            EphemeralTimer::Disabled
1891        } else {
1892            self.id.get_ephemeral_timer(context).await?
1893        };
1894        let ephemeral_timestamp = match ephemeral_timer {
1895            EphemeralTimer::Disabled => 0,
1896            EphemeralTimer::Enabled { duration } => time().saturating_add(duration.into()),
1897        };
1898
1899        let (msg_text, was_truncated) = truncate_msg_text(context, msg.text.clone()).await?;
1900        let new_mime_headers = if msg.has_html() {
1901            msg.param.get(Param::SendHtml).map(|s| s.to_string())
1902        } else {
1903            None
1904        };
1905        let new_mime_headers: Option<String> = new_mime_headers.map(|s| {
1906            let html_part = MimePart::new("text/html", s);
1907            let mut buffer = Vec::new();
1908            let cursor = Cursor::new(&mut buffer);
1909            html_part.write_part(cursor).ok();
1910            String::from_utf8_lossy(&buffer).to_string()
1911        });
1912        let new_mime_headers = new_mime_headers.or_else(|| match was_truncated {
1913            // We need to add some headers so that they are stripped before formatting HTML by
1914            // `MsgId::get_html()`, not a part of the actual text. Let's add "Content-Type", it's
1915            // anyway a useful metadata about the stored text.
1916            true => Some("Content-Type: text/plain; charset=utf-8\r\n\r\n".to_string() + &msg.text),
1917            false => None,
1918        });
1919        let new_mime_headers = match new_mime_headers {
1920            Some(h) => Some(tokio::task::block_in_place(move || {
1921                buf_compress(h.as_bytes())
1922            })?),
1923            None => None,
1924        };
1925
1926        msg.chat_id = self.id;
1927        msg.from_id = ContactId::SELF;
1928
1929        // add message to the database
1930        if let Some(update_msg_id) = update_msg_id {
1931            context
1932                .sql
1933                .execute(
1934                    "UPDATE msgs
1935                     SET rfc724_mid=?, chat_id=?, from_id=?, to_id=?, timestamp=?, type=?,
1936                         state=?, txt=?, txt_normalized=?, subject=?, param=?,
1937                         hidden=?, mime_in_reply_to=?, mime_references=?, mime_modified=?,
1938                         mime_headers=?, mime_compressed=1, location_id=?, ephemeral_timer=?,
1939                         ephemeral_timestamp=?
1940                     WHERE id=?;",
1941                    params_slice![
1942                        msg.rfc724_mid,
1943                        msg.chat_id,
1944                        msg.from_id,
1945                        to_id,
1946                        msg.timestamp_sort,
1947                        msg.viewtype,
1948                        msg.state,
1949                        msg_text,
1950                        normalize_text(&msg_text),
1951                        &msg.subject,
1952                        msg.param.to_string(),
1953                        msg.hidden,
1954                        msg.in_reply_to.as_deref().unwrap_or_default(),
1955                        new_references,
1956                        new_mime_headers.is_some(),
1957                        new_mime_headers.unwrap_or_default(),
1958                        location_id as i32,
1959                        ephemeral_timer,
1960                        ephemeral_timestamp,
1961                        update_msg_id
1962                    ],
1963                )
1964                .await?;
1965            msg.id = update_msg_id;
1966        } else {
1967            let raw_id = context
1968                .sql
1969                .insert(
1970                    "INSERT INTO msgs (
1971                        rfc724_mid,
1972                        chat_id,
1973                        from_id,
1974                        to_id,
1975                        timestamp,
1976                        type,
1977                        state,
1978                        txt,
1979                        txt_normalized,
1980                        subject,
1981                        param,
1982                        hidden,
1983                        mime_in_reply_to,
1984                        mime_references,
1985                        mime_modified,
1986                        mime_headers,
1987                        mime_compressed,
1988                        location_id,
1989                        ephemeral_timer,
1990                        ephemeral_timestamp)
1991                        VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,1,?,?,?);",
1992                    params_slice![
1993                        msg.rfc724_mid,
1994                        msg.chat_id,
1995                        msg.from_id,
1996                        to_id,
1997                        msg.timestamp_sort,
1998                        msg.viewtype,
1999                        msg.state,
2000                        msg_text,
2001                        normalize_text(&msg_text),
2002                        &msg.subject,
2003                        msg.param.to_string(),
2004                        msg.hidden,
2005                        msg.in_reply_to.as_deref().unwrap_or_default(),
2006                        new_references,
2007                        new_mime_headers.is_some(),
2008                        new_mime_headers.unwrap_or_default(),
2009                        location_id as i32,
2010                        ephemeral_timer,
2011                        ephemeral_timestamp
2012                    ],
2013                )
2014                .await?;
2015            context.new_msgs_notify.notify_one();
2016            msg.id = MsgId::new(u32::try_from(raw_id)?);
2017
2018            maybe_set_logging_xdc(context, msg, self.id).await?;
2019            context
2020                .update_webxdc_integration_database(msg, context)
2021                .await?;
2022        }
2023        context.scheduler.interrupt_ephemeral_task().await;
2024        Ok(())
2025    }
2026
2027    /// Sends a `SyncAction` synchronising chat contacts to other devices.
2028    pub(crate) async fn sync_contacts(&self, context: &Context) -> Result<()> {
2029        if self.is_encrypted(context).await? {
2030            let self_fp = self_fingerprint(context).await?;
2031            let fingerprint_addrs = context
2032                .sql
2033                .query_map_vec(
2034                    "SELECT c.id, c.fingerprint, c.addr
2035                     FROM contacts c INNER JOIN chats_contacts cc
2036                     ON c.id=cc.contact_id
2037                     WHERE cc.chat_id=? AND cc.add_timestamp >= cc.remove_timestamp",
2038                    (self.id,),
2039                    |row| {
2040                        if row.get::<_, ContactId>(0)? == ContactId::SELF {
2041                            return Ok((self_fp.to_string(), String::new()));
2042                        }
2043                        let fingerprint = row.get(1)?;
2044                        let addr = row.get(2)?;
2045                        Ok((fingerprint, addr))
2046                    },
2047                )
2048                .await?;
2049            self.sync(context, SyncAction::SetPgpContacts(fingerprint_addrs))
2050                .await?;
2051        } else {
2052            let addrs = context
2053                .sql
2054                .query_map_vec(
2055                    "SELECT c.addr \
2056                    FROM contacts c INNER JOIN chats_contacts cc \
2057                    ON c.id=cc.contact_id \
2058                    WHERE cc.chat_id=? AND cc.add_timestamp >= cc.remove_timestamp",
2059                    (self.id,),
2060                    |row| {
2061                        let addr: String = row.get(0)?;
2062                        Ok(addr)
2063                    },
2064                )
2065                .await?;
2066            self.sync(context, SyncAction::SetContacts(addrs)).await?;
2067        }
2068        Ok(())
2069    }
2070
2071    /// Returns chat id for the purpose of synchronisation across devices.
2072    async fn get_sync_id(&self, context: &Context) -> Result<Option<SyncId>> {
2073        match self.typ {
2074            Chattype::Single => {
2075                if self.is_device_talk() {
2076                    return Ok(Some(SyncId::Device));
2077                }
2078
2079                let mut r = None;
2080                for contact_id in get_chat_contacts(context, self.id).await? {
2081                    if contact_id == ContactId::SELF && !self.is_self_talk() {
2082                        continue;
2083                    }
2084                    if r.is_some() {
2085                        return Ok(None);
2086                    }
2087                    let contact = Contact::get_by_id(context, contact_id).await?;
2088                    if let Some(fingerprint) = contact.fingerprint() {
2089                        r = Some(SyncId::ContactFingerprint(fingerprint.hex()));
2090                    } else {
2091                        r = Some(SyncId::ContactAddr(contact.get_addr().to_string()));
2092                    }
2093                }
2094                Ok(r)
2095            }
2096            Chattype::OutBroadcast
2097            | Chattype::InBroadcast
2098            | Chattype::Group
2099            | Chattype::Mailinglist => {
2100                if !self.grpid.is_empty() {
2101                    return Ok(Some(SyncId::Grpid(self.grpid.clone())));
2102                }
2103
2104                let Some((parent_rfc724_mid, parent_in_reply_to, _)) = self
2105                    .id
2106                    .get_parent_mime_headers(context, MessageState::OutDelivered)
2107                    .await?
2108                else {
2109                    warn!(
2110                        context,
2111                        "Chat::get_sync_id({}): No good message identifying the chat found.",
2112                        self.id
2113                    );
2114                    return Ok(None);
2115                };
2116                Ok(Some(SyncId::Msgids(vec![
2117                    parent_in_reply_to,
2118                    parent_rfc724_mid,
2119                ])))
2120            }
2121        }
2122    }
2123
2124    /// Synchronises a chat action to other devices.
2125    pub(crate) async fn sync(&self, context: &Context, action: SyncAction) -> Result<()> {
2126        if let Some(id) = self.get_sync_id(context).await? {
2127            sync(context, id, action).await?;
2128        }
2129        Ok(())
2130    }
2131}
2132
2133pub(crate) async fn sync(context: &Context, id: SyncId, action: SyncAction) -> Result<()> {
2134    context
2135        .add_sync_item(SyncData::AlterChat { id, action })
2136        .await?;
2137    context.scheduler.interrupt_smtp().await;
2138    Ok(())
2139}
2140
2141/// Whether the chat is pinned or archived.
2142#[derive(Debug, Copy, Eq, PartialEq, Clone, Serialize, Deserialize, EnumIter, Default)]
2143#[repr(i8)]
2144pub enum ChatVisibility {
2145    /// Chat is neither archived nor pinned.
2146    #[default]
2147    Normal = 0,
2148
2149    /// Chat is archived.
2150    Archived = 1,
2151
2152    /// Chat is pinned to the top of the chatlist.
2153    Pinned = 2,
2154}
2155
2156impl rusqlite::types::ToSql for ChatVisibility {
2157    fn to_sql(&self) -> rusqlite::Result<rusqlite::types::ToSqlOutput<'_>> {
2158        let val = rusqlite::types::Value::Integer(*self as i64);
2159        let out = rusqlite::types::ToSqlOutput::Owned(val);
2160        Ok(out)
2161    }
2162}
2163
2164impl rusqlite::types::FromSql for ChatVisibility {
2165    fn column_result(value: rusqlite::types::ValueRef) -> rusqlite::types::FromSqlResult<Self> {
2166        i64::column_result(value).map(|val| {
2167            match val {
2168                2 => ChatVisibility::Pinned,
2169                1 => ChatVisibility::Archived,
2170                0 => ChatVisibility::Normal,
2171                // fallback to Normal for unknown values, may happen eg. on imports created by a newer version.
2172                _ => ChatVisibility::Normal,
2173            }
2174        })
2175    }
2176}
2177
2178/// The current state of a chat.
2179#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2180#[non_exhaustive]
2181pub struct ChatInfo {
2182    /// The chat ID.
2183    pub id: ChatId,
2184
2185    /// The type of chat as a `u32` representation of [Chattype].
2186    ///
2187    /// On the C API this number is one of the
2188    /// `DC_CHAT_TYPE_UNDEFINED`, `DC_CHAT_TYPE_SINGLE`,
2189    /// or `DC_CHAT_TYPE_GROUP`
2190    /// constants.
2191    #[serde(rename = "type")]
2192    pub type_: u32,
2193
2194    /// The name of the chat.
2195    pub name: String,
2196
2197    /// Whether the chat is archived.
2198    pub archived: bool,
2199
2200    /// The "params" of the chat.
2201    ///
2202    /// This is the string-serialised version of `Params` currently.
2203    pub param: String,
2204
2205    /// Whether this chat is currently sending location-stream messages.
2206    pub is_sending_locations: bool,
2207
2208    /// Colour this chat should be represented in by the UI.
2209    ///
2210    /// Yes, spelling colour is hard.
2211    pub color: u32,
2212
2213    /// The path to the profile image.
2214    ///
2215    /// If there is no profile image set this will be an empty string
2216    /// currently.
2217    pub profile_image: std::path::PathBuf,
2218
2219    /// The draft message text.
2220    ///
2221    /// If the chat has not draft this is an empty string.
2222    ///
2223    /// TODO: This doesn't seem rich enough, it can not handle drafts
2224    ///       which contain non-text parts.  Perhaps it should be a
2225    ///       simple `has_draft` bool instead.
2226    pub draft: String,
2227
2228    /// Whether the chat is muted
2229    ///
2230    /// The exact time its muted can be found out via the `chat.mute_duration` property
2231    pub is_muted: bool,
2232
2233    /// Ephemeral message timer.
2234    pub ephemeral_timer: EphemeralTimer,
2235    // ToDo:
2236    // - [ ] summary,
2237    // - [ ] lastUpdated,
2238    // - [ ] freshMessageCounter,
2239    // - [ ] email
2240}
2241
2242async fn get_asset_icon(context: &Context, name: &str, bytes: &[u8]) -> Result<PathBuf> {
2243    ensure!(name.starts_with("icon-"));
2244    if let Some(icon) = context.sql.get_raw_config(name).await? {
2245        return Ok(get_abs_path(context, Path::new(&icon)));
2246    }
2247
2248    let blob =
2249        BlobObject::create_and_deduplicate_from_bytes(context, bytes, &format!("{name}.png"))?;
2250    let icon = blob.as_name().to_string();
2251    context.sql.set_raw_config(name, Some(&icon)).await?;
2252
2253    Ok(get_abs_path(context, Path::new(&icon)))
2254}
2255
2256pub(crate) async fn get_saved_messages_icon(context: &Context) -> Result<PathBuf> {
2257    get_asset_icon(
2258        context,
2259        "icon-saved-messages",
2260        include_bytes!("../assets/icon-saved-messages.png"),
2261    )
2262    .await
2263}
2264
2265pub(crate) async fn get_device_icon(context: &Context) -> Result<PathBuf> {
2266    get_asset_icon(
2267        context,
2268        "icon-device",
2269        include_bytes!("../assets/icon-device.png"),
2270    )
2271    .await
2272}
2273
2274pub(crate) async fn get_archive_icon(context: &Context) -> Result<PathBuf> {
2275    get_asset_icon(
2276        context,
2277        "icon-archive",
2278        include_bytes!("../assets/icon-archive.png"),
2279    )
2280    .await
2281}
2282
2283/// Returns path to the icon
2284/// indicating unencrypted chats and address-contacts.
2285pub(crate) async fn get_unencrypted_icon(context: &Context) -> Result<PathBuf> {
2286    get_asset_icon(
2287        context,
2288        "icon-unencrypted",
2289        include_bytes!("../assets/icon-unencrypted.png"),
2290    )
2291    .await
2292}
2293
2294async fn update_special_chat_name(
2295    context: &Context,
2296    contact_id: ContactId,
2297    name: String,
2298) -> Result<()> {
2299    if let Some(ChatIdBlocked { id: chat_id, .. }) =
2300        ChatIdBlocked::lookup_by_contact(context, contact_id).await?
2301    {
2302        // the `!= name` condition avoids unneeded writes
2303        context
2304            .sql
2305            .execute(
2306                "UPDATE chats SET name=?, name_normalized=? WHERE id=? AND name!=?",
2307                (&name, normalize_text(&name), chat_id, &name),
2308            )
2309            .await?;
2310    }
2311    Ok(())
2312}
2313
2314pub(crate) async fn update_special_chat_names(context: &Context) -> Result<()> {
2315    update_special_chat_name(
2316        context,
2317        ContactId::DEVICE,
2318        stock_str::device_messages(context),
2319    )
2320    .await?;
2321    update_special_chat_name(context, ContactId::SELF, stock_str::saved_messages(context)).await?;
2322    Ok(())
2323}
2324
2325/// Handle a [`ChatId`] and its [`Blocked`] status at once.
2326///
2327/// This struct is an optimisation to read a [`ChatId`] and its [`Blocked`] status at once
2328/// from the database.  It [`Deref`]s to [`ChatId`] so it can be used as an extension to
2329/// [`ChatId`].
2330///
2331/// [`Deref`]: std::ops::Deref
2332#[derive(Debug)]
2333pub(crate) struct ChatIdBlocked {
2334    /// Chat ID.
2335    pub id: ChatId,
2336
2337    /// Whether the chat is blocked, unblocked or a contact request.
2338    pub blocked: Blocked,
2339}
2340
2341impl ChatIdBlocked {
2342    /// Searches the database for the 1:1 chat with this contact.
2343    ///
2344    /// If no chat is found `None` is returned.
2345    pub async fn lookup_by_contact(
2346        context: &Context,
2347        contact_id: ContactId,
2348    ) -> Result<Option<Self>> {
2349        ensure!(context.sql.is_open().await, "Database not available");
2350        ensure!(
2351            contact_id != ContactId::UNDEFINED,
2352            "Invalid contact id requested"
2353        );
2354
2355        context
2356            .sql
2357            .query_row_optional(
2358                "SELECT c.id, c.blocked
2359                   FROM chats c
2360                  INNER JOIN chats_contacts j
2361                          ON c.id=j.chat_id
2362                  WHERE c.type=100  -- 100 = Chattype::Single
2363                    AND c.id>9      -- 9 = DC_CHAT_ID_LAST_SPECIAL
2364                    AND j.contact_id=?;",
2365                (contact_id,),
2366                |row| {
2367                    let id: ChatId = row.get(0)?;
2368                    let blocked: Blocked = row.get(1)?;
2369                    Ok(ChatIdBlocked { id, blocked })
2370                },
2371            )
2372            .await
2373    }
2374
2375    /// Returns the chat for the 1:1 chat with this contact.
2376    ///
2377    /// If the chat does not yet exist a new one is created, using the provided [`Blocked`]
2378    /// state.
2379    pub async fn get_for_contact(
2380        context: &Context,
2381        contact_id: ContactId,
2382        create_blocked: Blocked,
2383    ) -> Result<Self> {
2384        ensure!(context.sql.is_open().await, "Database not available");
2385        ensure!(
2386            contact_id != ContactId::UNDEFINED,
2387            "Invalid contact id requested"
2388        );
2389
2390        if let Some(res) = Self::lookup_by_contact(context, contact_id).await? {
2391            // Already exists, no need to create.
2392            return Ok(res);
2393        }
2394
2395        let contact = Contact::get_by_id(context, contact_id).await?;
2396        let chat_name = contact.get_display_name().to_string();
2397        let mut params = Params::new();
2398        match contact_id {
2399            ContactId::SELF => {
2400                params.set_int(Param::Selftalk, 1);
2401            }
2402            ContactId::DEVICE => {
2403                params.set_int(Param::Devicetalk, 1);
2404            }
2405            _ => (),
2406        }
2407
2408        let smeared_time = create_smeared_timestamp(context);
2409
2410        let chat_id = context
2411            .sql
2412            .transaction(move |transaction| {
2413                transaction.execute(
2414                    "INSERT INTO chats
2415                     (type, name, name_normalized, param, blocked, created_timestamp)
2416                     VALUES(?, ?, ?, ?, ?, ?)",
2417                    (
2418                        Chattype::Single,
2419                        &chat_name,
2420                        normalize_text(&chat_name),
2421                        params.to_string(),
2422                        create_blocked as u8,
2423                        smeared_time,
2424                    ),
2425                )?;
2426                let chat_id = ChatId::new(
2427                    transaction
2428                        .last_insert_rowid()
2429                        .try_into()
2430                        .context("chat table rowid overflows u32")?,
2431                );
2432
2433                transaction.execute(
2434                    "INSERT INTO chats_contacts
2435                 (chat_id, contact_id)
2436                 VALUES((SELECT last_insert_rowid()), ?)",
2437                    (contact_id,),
2438                )?;
2439
2440                Ok(chat_id)
2441            })
2442            .await?;
2443
2444        let chat = Chat::load_from_db(context, chat_id).await?;
2445        if chat.is_encrypted(context).await?
2446            && !chat.param.exists(Param::Devicetalk)
2447            && !chat.param.exists(Param::Selftalk)
2448        {
2449            chat_id.add_e2ee_notice(context, smeared_time).await?;
2450        }
2451
2452        Ok(Self {
2453            id: chat_id,
2454            blocked: create_blocked,
2455        })
2456    }
2457}
2458
2459async fn prepare_msg_blob(context: &Context, msg: &mut Message) -> Result<()> {
2460    if msg.viewtype == Viewtype::Text || msg.viewtype == Viewtype::Call {
2461        // the caller should check if the message text is empty
2462    } else if msg.viewtype.has_file() {
2463        let viewtype_orig = msg.viewtype;
2464        let mut blob = msg
2465            .param
2466            .get_file_blob(context)?
2467            .with_context(|| format!("attachment missing for message of type #{}", msg.viewtype))?;
2468        let mut maybe_image = false;
2469
2470        if msg.viewtype == Viewtype::File || msg.viewtype == Viewtype::Image {
2471            // Correct the type, take care not to correct already very special
2472            // formats as GIF or VOICE.
2473            //
2474            // Typical conversions:
2475            // - from FILE to AUDIO/VIDEO/IMAGE
2476            // - from FILE/IMAGE to GIF */
2477            if let Some((better_type, _)) = message::guess_msgtype_from_suffix(msg) {
2478                if better_type == Viewtype::Image {
2479                    maybe_image = true;
2480                } else if better_type != Viewtype::Webxdc
2481                    || context
2482                        .ensure_sendable_webxdc_file(&blob.to_abs_path())
2483                        .await
2484                        .is_ok()
2485                {
2486                    msg.viewtype = better_type;
2487                }
2488            }
2489        } else if msg.viewtype == Viewtype::Webxdc {
2490            context
2491                .ensure_sendable_webxdc_file(&blob.to_abs_path())
2492                .await?;
2493        }
2494
2495        if msg.viewtype == Viewtype::Vcard {
2496            msg.try_set_vcard(context, &blob.to_abs_path()).await?;
2497        }
2498        if msg.viewtype == Viewtype::File && maybe_image || msg.viewtype == Viewtype::Image {
2499            let new_name = blob
2500                .check_or_recode_image(context, msg.get_filename(), &mut msg.viewtype)
2501                .await?;
2502            msg.param.set(Param::Filename, new_name);
2503            msg.param.set(Param::File, blob.as_name());
2504        }
2505
2506        if !msg.param.exists(Param::MimeType)
2507            && let Some((viewtype, mime)) = message::guess_msgtype_from_suffix(msg)
2508        {
2509            // If we unexpectedly didn't recognize the file as image, don't send it as such,
2510            // either the format is unsupported or the image is corrupted.
2511            let mime = match viewtype != Viewtype::Image
2512                || matches!(msg.viewtype, Viewtype::Image | Viewtype::Sticker)
2513            {
2514                true => mime,
2515                false => "application/octet-stream",
2516            };
2517            msg.param.set(Param::MimeType, mime);
2518        }
2519
2520        msg.try_calc_and_set_dimensions(context).await?;
2521
2522        let filename = msg.get_filename().context("msg has no file")?;
2523        let suffix = Path::new(&filename)
2524            .extension()
2525            .and_then(|e| e.to_str())
2526            .unwrap_or("dat");
2527        // Get file name to use for sending. For privacy purposes, we do not transfer the original
2528        // filenames e.g. for images; these names are normally not needed and contain timestamps,
2529        // running numbers, etc.
2530        let filename: String = match viewtype_orig {
2531            Viewtype::Voice => format!(
2532                "voice-messsage_{}.{suffix}",
2533                chrono::Utc
2534                    .timestamp_opt(msg.timestamp_sort, 0)
2535                    .single()
2536                    .map_or_else(
2537                        || "YY-mm-dd_hh:mm:ss".to_string(),
2538                        |ts| ts.format("%Y-%m-%d_%H-%M-%S").to_string()
2539                    ),
2540            ),
2541            Viewtype::Image | Viewtype::Gif => format!(
2542                "image_{}.{suffix}",
2543                chrono::Utc
2544                    .timestamp_opt(msg.timestamp_sort, 0)
2545                    .single()
2546                    .map_or_else(
2547                        || "YY-mm-dd_hh:mm:ss".to_string(),
2548                        |ts| ts.format("%Y-%m-%d_%H-%M-%S").to_string(),
2549                    ),
2550            ),
2551            Viewtype::Video => format!(
2552                "video_{}.{suffix}",
2553                chrono::Utc
2554                    .timestamp_opt(msg.timestamp_sort, 0)
2555                    .single()
2556                    .map_or_else(
2557                        || "YY-mm-dd_hh:mm:ss".to_string(),
2558                        |ts| ts.format("%Y-%m-%d_%H-%M-%S").to_string()
2559                    ),
2560            ),
2561            _ => filename,
2562        };
2563        msg.param.set(Param::Filename, filename);
2564
2565        info!(
2566            context,
2567            "Attaching \"{}\" for message type #{}.",
2568            blob.to_abs_path().display(),
2569            msg.viewtype
2570        );
2571    } else {
2572        bail!("Cannot send messages of type #{}.", msg.viewtype);
2573    }
2574    Ok(())
2575}
2576
2577/// Returns whether a contact is in a chat or not.
2578pub async fn is_contact_in_chat(
2579    context: &Context,
2580    chat_id: ChatId,
2581    contact_id: ContactId,
2582) -> Result<bool> {
2583    // this function works for group and for normal chats, however, it is more useful
2584    // for group chats.
2585    // ContactId::SELF may be used to check whether oneself
2586    // is in a group or incoming broadcast chat
2587    // (ContactId::SELF is not added to 1:1 chats or outgoing broadcast channels)
2588
2589    let exists = context
2590        .sql
2591        .exists(
2592            "SELECT COUNT(*) FROM chats_contacts
2593             WHERE chat_id=? AND contact_id=?
2594             AND add_timestamp >= remove_timestamp",
2595            (chat_id, contact_id),
2596        )
2597        .await?;
2598    Ok(exists)
2599}
2600
2601/// Sends a message object to a chat.
2602///
2603/// Sends the event #DC_EVENT_MSGS_CHANGED on success.
2604/// However, this does not imply, the message really reached the recipient -
2605/// sending may be delayed eg. due to network problems. However, from your
2606/// view, you're done with the message. Sooner or later it will find its way.
2607pub async fn send_msg(context: &Context, chat_id: ChatId, msg: &mut Message) -> Result<MsgId> {
2608    ensure!(
2609        !chat_id.is_special(),
2610        "chat_id cannot be a special chat: {chat_id}"
2611    );
2612
2613    if msg.state != MessageState::Undefined {
2614        msg.param.remove(Param::GuaranteeE2ee);
2615        msg.param.remove(Param::ForcePlaintext);
2616        // create_send_msg_jobs() will update `param` in the db.
2617    }
2618
2619    // protect all system messages against RTLO attacks
2620    if msg.is_system_message() {
2621        msg.text = sanitize_bidi_characters(&msg.text);
2622    }
2623
2624    if !prepare_send_msg(context, chat_id, msg).await?.is_empty() {
2625        if !msg.hidden {
2626            context.emit_msgs_changed(msg.chat_id, msg.id);
2627        }
2628
2629        if msg.param.exists(Param::SetLatitude) {
2630            context.emit_location_changed(Some(ContactId::SELF)).await?;
2631        }
2632
2633        context.scheduler.interrupt_smtp().await;
2634    }
2635
2636    Ok(msg.id)
2637}
2638
2639/// Tries to send a message synchronously.
2640///
2641/// Creates jobs in the `smtp` table, then drectly opens an SMTP connection and sends the
2642/// message. If this fails, the jobs remain in the database for later sending.
2643pub async fn send_msg_sync(context: &Context, chat_id: ChatId, msg: &mut Message) -> Result<MsgId> {
2644    let rowids = prepare_send_msg(context, chat_id, msg).await?;
2645    if rowids.is_empty() {
2646        return Ok(msg.id);
2647    }
2648    let mut smtp = crate::smtp::Smtp::new();
2649    for rowid in rowids {
2650        send_msg_to_smtp(context, &mut smtp, rowid)
2651            .await
2652            .context("failed to send message, queued for later sending")?;
2653    }
2654    context.emit_msgs_changed(msg.chat_id, msg.id);
2655    Ok(msg.id)
2656}
2657
2658/// Prepares a message to be sent out.
2659///
2660/// Returns row ids of the `smtp` table.
2661async fn prepare_send_msg(
2662    context: &Context,
2663    chat_id: ChatId,
2664    msg: &mut Message,
2665) -> Result<Vec<i64>> {
2666    let mut chat = Chat::load_from_db(context, chat_id).await?;
2667
2668    let skip_fn = |reason: &CantSendReason| match reason {
2669        CantSendReason::ContactRequest => {
2670            // Allow securejoin messages, they are supposed to repair the verification.
2671            // If the chat is a contact request, let the user accept it later.
2672            msg.param.get_cmd() == SystemMessage::SecurejoinMessage
2673        }
2674        // Allow to send "Member removed" messages so we can leave the group/broadcast.
2675        // Necessary checks should be made anyway before removing contact
2676        // from the chat.
2677        CantSendReason::NotAMember => msg.param.get_cmd() == SystemMessage::MemberRemovedFromGroup,
2678        CantSendReason::InBroadcast => {
2679            matches!(
2680                msg.param.get_cmd(),
2681                SystemMessage::MemberRemovedFromGroup | SystemMessage::SecurejoinMessage
2682            )
2683        }
2684        CantSendReason::MissingKey => msg
2685            .param
2686            .get_bool(Param::ForcePlaintext)
2687            .unwrap_or_default(),
2688        _ => false,
2689    };
2690    if let Some(reason) = chat.why_cant_send_ex(context, &skip_fn).await? {
2691        bail!("Cannot send to {chat_id}: {reason}");
2692    }
2693
2694    // Check a quote reply is not leaking data from other chats.
2695    // This is meant as a last line of defence, the UI should check that before as well.
2696    // (We allow Chattype::Single in general for "Reply Privately";
2697    // checking for exact contact_id will produce false positives when ppl just left the group)
2698    if chat.typ != Chattype::Single
2699        && !context.get_config_bool(Config::Bot).await?
2700        && let Some(quoted_message) = msg.quoted_message(context).await?
2701        && quoted_message.chat_id != chat_id
2702    {
2703        bail!(
2704            "Quote of message from {} cannot be sent to {chat_id}",
2705            quoted_message.chat_id
2706        );
2707    }
2708
2709    // check current MessageState for drafts (to keep msg_id) ...
2710    let update_msg_id = if msg.state == MessageState::OutDraft {
2711        msg.hidden = false;
2712        if !msg.id.is_special() && msg.chat_id == chat_id {
2713            Some(msg.id)
2714        } else {
2715            None
2716        }
2717    } else {
2718        None
2719    };
2720
2721    if msg.state == MessageState::Undefined
2722        // Legacy SecureJoin "v*-request" messages are unencrypted.
2723        && msg.param.get_cmd() != SystemMessage::SecurejoinMessage
2724        && chat.is_encrypted(context).await?
2725    {
2726        msg.param.set_int(Param::GuaranteeE2ee, 1);
2727        if !msg.id.is_unset() {
2728            msg.update_param(context).await?;
2729        }
2730    }
2731    msg.state = MessageState::OutPending;
2732
2733    msg.timestamp_sort = create_smeared_timestamp(context);
2734    prepare_msg_blob(context, msg).await?;
2735    if !msg.hidden {
2736        chat_id.unarchive_if_not_muted(context, msg.state).await?;
2737    }
2738    chat.prepare_msg_raw(context, msg, update_msg_id).await?;
2739
2740    let row_ids = create_send_msg_jobs(context, msg)
2741        .await
2742        .context("Failed to create send jobs")?;
2743    if !row_ids.is_empty() {
2744        donation_request_maybe(context).await.log_err(context).ok();
2745    }
2746    Ok(row_ids)
2747}
2748
2749/// Renders the Message or splits it into Pre- and Post-Message.
2750///
2751/// Pre-Message is a small message with metadata which announces a larger Post-Message.
2752/// Post-Messages are not downloaded in the background.
2753///
2754/// If pre-message is not nessesary, this returns `None` as the 0th value.
2755async fn render_mime_message_and_pre_message(
2756    context: &Context,
2757    msg: &mut Message,
2758    mimefactory: MimeFactory,
2759) -> Result<(Option<RenderedEmail>, RenderedEmail)> {
2760    let needs_pre_message = msg.viewtype.has_file()
2761        && mimefactory.will_be_encrypted() // unencrypted is likely email, we don't want to spam by sending multiple messages
2762        && msg
2763            .get_filebytes(context)
2764            .await?
2765            .context("filebytes not available, even though message has attachment")?
2766            > PRE_MSG_ATTACHMENT_SIZE_THRESHOLD;
2767
2768    if needs_pre_message {
2769        info!(
2770            context,
2771            "Message {} is large and will be split into pre- and post-messages.", msg.id,
2772        );
2773
2774        let mut mimefactory_post_msg = mimefactory.clone();
2775        mimefactory_post_msg.set_as_post_message();
2776        let rendered_msg = Box::pin(mimefactory_post_msg.render(context))
2777            .await
2778            .context("Failed to render post-message")?;
2779
2780        let mut mimefactory_pre_msg = mimefactory;
2781        mimefactory_pre_msg.set_as_pre_message_for(&rendered_msg);
2782        let rendered_pre_msg = Box::pin(mimefactory_pre_msg.render(context))
2783            .await
2784            .context("pre-message failed to render")?;
2785
2786        if rendered_pre_msg.message.len() > PRE_MSG_SIZE_WARNING_THRESHOLD {
2787            warn!(
2788                context,
2789                "Pre-message for message {} is larger than expected: {}.",
2790                msg.id,
2791                rendered_pre_msg.message.len()
2792            );
2793        }
2794
2795        Ok((Some(rendered_pre_msg), rendered_msg))
2796    } else {
2797        Ok((None, Box::pin(mimefactory.render(context)).await?))
2798    }
2799}
2800
2801/// Constructs jobs for sending a message and inserts them into the `smtp` table.
2802///
2803/// Updates the message `GuaranteeE2ee` parameter and persists it
2804/// in the database depending on whether the message
2805/// is added to the outgoing queue as encrypted or not.
2806///
2807/// Returns row ids if `smtp` table jobs were created or an empty `Vec` otherwise.
2808///
2809/// The caller has to interrupt SMTP loop or otherwise process new rows.
2810pub(crate) async fn create_send_msg_jobs(context: &Context, msg: &mut Message) -> Result<Vec<i64>> {
2811    let cmd = msg.param.get_cmd();
2812    if cmd == SystemMessage::GroupNameChanged || cmd == SystemMessage::GroupDescriptionChanged {
2813        msg.chat_id
2814            .update_timestamp(
2815                context,
2816                if cmd == SystemMessage::GroupNameChanged {
2817                    Param::GroupNameTimestamp
2818                } else {
2819                    Param::GroupDescriptionTimestamp
2820                },
2821                msg.timestamp_sort,
2822            )
2823            .await?;
2824    }
2825
2826    let needs_encryption = msg.param.get_bool(Param::GuaranteeE2ee).unwrap_or_default();
2827    let mimefactory = match MimeFactory::from_msg(context, msg.clone()).await {
2828        Ok(mf) => mf,
2829        Err(err) => {
2830            // Mark message as failed
2831            message::set_msg_failed(context, msg, &err.to_string())
2832                .await
2833                .ok();
2834            return Err(err);
2835        }
2836    };
2837    let attach_selfavatar = mimefactory.attach_selfavatar;
2838    let mut recipients = mimefactory.recipients();
2839
2840    let from = context.get_primary_self_addr().await?;
2841    let lowercase_from = from.to_lowercase();
2842
2843    recipients.retain(|x| x.to_lowercase() != lowercase_from);
2844
2845    // Default Webxdc integrations are hidden messages and must not be sent out:
2846    if (msg.param.get_int(Param::WebxdcIntegration).is_some() && msg.hidden)
2847        // This may happen eg. for groups with only SELF and bcc_self disabled:
2848        || (!context.get_config_bool(Config::BccSelf).await? && recipients.is_empty())
2849    {
2850        info!(
2851            context,
2852            "Message {} has no recipient, skipping smtp-send.", msg.id
2853        );
2854        msg.param.set_int(Param::GuaranteeE2ee, 1);
2855        msg.update_param(context).await?;
2856        msg.id.set_delivered(context).await?;
2857        msg.state = MessageState::OutDelivered;
2858        return Ok(Vec::new());
2859    }
2860
2861    let (rendered_pre_msg, rendered_msg) =
2862        match render_mime_message_and_pre_message(context, msg, mimefactory).await {
2863            Ok(res) => Ok(res),
2864            Err(err) => {
2865                message::set_msg_failed(context, msg, &err.to_string()).await?;
2866                Err(err)
2867            }
2868        }?;
2869
2870    if let (post_msg, Some(pre_msg)) = (&rendered_msg, &rendered_pre_msg) {
2871        info!(
2872            context,
2873            "Message {} sizes: pre-message: {}; post-message: {}.",
2874            msg.id,
2875            format_size(pre_msg.message.len(), BINARY),
2876            format_size(post_msg.message.len(), BINARY),
2877        );
2878        msg.pre_rfc724_mid = pre_msg.rfc724_mid.clone();
2879    } else {
2880        info!(
2881            context,
2882            "Message {} will be sent in one shot (no pre- and post-message). Size: {}.",
2883            msg.id,
2884            format_size(rendered_msg.message.len(), BINARY),
2885        );
2886    }
2887
2888    if context.get_config_bool(Config::BccSelf).await? {
2889        smtp::add_self_recipients(context, &mut recipients, rendered_msg.is_encrypted).await?;
2890    }
2891
2892    if needs_encryption && !rendered_msg.is_encrypted {
2893        /* unrecoverable */
2894        message::set_msg_failed(
2895            context,
2896            msg,
2897            "End-to-end-encryption unavailable unexpectedly.",
2898        )
2899        .await?;
2900        bail!(
2901            "e2e encryption unavailable {} - {:?}",
2902            msg.id,
2903            needs_encryption
2904        );
2905    }
2906
2907    let now = smeared_time(context);
2908
2909    if rendered_msg.last_added_location_id.is_some()
2910        && let Err(err) = location::set_kml_sent_timestamp(context, msg.chat_id, now).await
2911    {
2912        error!(context, "Failed to set kml sent_timestamp: {err:#}.");
2913    }
2914
2915    if attach_selfavatar && let Err(err) = msg.chat_id.set_selfavatar_timestamp(context, now).await
2916    {
2917        error!(context, "Failed to set selfavatar timestamp: {err:#}.");
2918    }
2919
2920    if rendered_msg.is_encrypted {
2921        msg.param.set_int(Param::GuaranteeE2ee, 1);
2922    } else {
2923        msg.param.remove(Param::GuaranteeE2ee);
2924    }
2925    msg.subject.clone_from(&rendered_msg.subject);
2926    // Sort the message to the bottom. Employ `msgs_index7` to compute `timestamp`.
2927    context
2928        .sql
2929        .execute(
2930            "
2931UPDATE msgs SET
2932    timestamp=(
2933        SELECT MAX(timestamp) FROM msgs INDEXED BY msgs_index7 WHERE
2934            -- From `InFresh` to `OutDelivered` inclusive, except `OutDraft`.
2935            state IN(10,13,16,18,20,24,26) AND
2936            hidden IN(0,1) AND
2937            chat_id=? AND
2938            id<=?
2939    ),
2940    pre_rfc724_mid=?, subject=?, param=?
2941WHERE id=?
2942            ",
2943            (
2944                msg.chat_id,
2945                msg.id,
2946                &msg.pre_rfc724_mid,
2947                &msg.subject,
2948                msg.param.to_string(),
2949                msg.id,
2950            ),
2951        )
2952        .await?;
2953
2954    let chunk_size = context.get_max_smtp_rcpt_to().await?;
2955    let trans_fn = |t: &mut rusqlite::Transaction| {
2956        let mut row_ids = Vec::<i64>::new();
2957
2958        if let Some(sync_ids) = rendered_msg.sync_ids_to_delete {
2959            t.execute(
2960                &format!("DELETE FROM multi_device_sync WHERE id IN ({sync_ids})"),
2961                (),
2962            )?;
2963        }
2964        let mut stmt = t.prepare(
2965            "INSERT INTO smtp (rfc724_mid, recipients, mime, msg_id)
2966            VALUES            (?1,         ?2,         ?3,   ?4)",
2967        )?;
2968        for recipients_chunk in recipients.chunks(chunk_size) {
2969            let recipients_chunk = recipients_chunk.join(" ");
2970            if let Some(pre_msg) = &rendered_pre_msg {
2971                let row_id = stmt.execute((
2972                    &pre_msg.rfc724_mid,
2973                    &recipients_chunk,
2974                    &pre_msg.message,
2975                    msg.id,
2976                ))?;
2977                row_ids.push(row_id.try_into()?);
2978            }
2979            let row_id = stmt.execute((
2980                &rendered_msg.rfc724_mid,
2981                &recipients_chunk,
2982                &rendered_msg.message,
2983                msg.id,
2984            ))?;
2985            row_ids.push(row_id.try_into()?);
2986        }
2987        Ok(row_ids)
2988    };
2989    context.sql.transaction(trans_fn).await
2990}
2991
2992/// Sends a text message to the given chat.
2993///
2994/// Returns database ID of the sent message.
2995pub async fn send_text_msg(
2996    context: &Context,
2997    chat_id: ChatId,
2998    text_to_send: String,
2999) -> Result<MsgId> {
3000    ensure!(
3001        !chat_id.is_special(),
3002        "bad chat_id, can not be a special chat: {chat_id}"
3003    );
3004
3005    let mut msg = Message::new_text(text_to_send);
3006    send_msg(context, chat_id, &mut msg).await
3007}
3008
3009/// Sends chat members a request to edit the given message's text.
3010pub async fn send_edit_request(context: &Context, msg_id: MsgId, new_text: String) -> Result<()> {
3011    let mut original_msg = Message::load_from_db(context, msg_id).await?;
3012    ensure!(
3013        original_msg.from_id == ContactId::SELF,
3014        "Can edit only own messages"
3015    );
3016    ensure!(!original_msg.is_info(), "Cannot edit info messages");
3017    ensure!(!original_msg.has_html(), "Cannot edit HTML messages");
3018    ensure!(original_msg.viewtype != Viewtype::Call, "Cannot edit calls");
3019    ensure!(
3020        !original_msg.text.is_empty(), // avoid complexity in UI element changes. focus is typos and rewordings
3021        "Cannot add text"
3022    );
3023    ensure!(!new_text.trim().is_empty(), "Edited text cannot be empty");
3024    if original_msg.text == new_text {
3025        info!(context, "Text unchanged.");
3026        return Ok(());
3027    }
3028
3029    save_text_edit_to_db(context, &mut original_msg, &new_text).await?;
3030
3031    let mut edit_msg = Message::new_text(EDITED_PREFIX.to_owned() + &new_text); // prefix only set for nicer display in Non-Delta-MUAs
3032    edit_msg.set_quote(context, Some(&original_msg)).await?; // quote only set for nicer display in Non-Delta-MUAs
3033    if original_msg.get_showpadlock() {
3034        edit_msg.param.set_int(Param::GuaranteeE2ee, 1);
3035    }
3036    edit_msg
3037        .param
3038        .set(Param::TextEditFor, original_msg.rfc724_mid);
3039    edit_msg.hidden = true;
3040    send_msg(context, original_msg.chat_id, &mut edit_msg).await?;
3041    Ok(())
3042}
3043
3044pub(crate) async fn save_text_edit_to_db(
3045    context: &Context,
3046    original_msg: &mut Message,
3047    new_text: &str,
3048) -> Result<()> {
3049    original_msg.param.set_int(Param::IsEdited, 1);
3050    context
3051        .sql
3052        .execute(
3053            "UPDATE msgs SET txt=?, txt_normalized=?, param=? WHERE id=?",
3054            (
3055                new_text,
3056                normalize_text(new_text),
3057                original_msg.param.to_string(),
3058                original_msg.id,
3059            ),
3060        )
3061        .await?;
3062    context.emit_msgs_changed(original_msg.chat_id, original_msg.id);
3063    Ok(())
3064}
3065
3066async fn donation_request_maybe(context: &Context) -> Result<()> {
3067    let secs_between_checks = 30 * 24 * 60 * 60;
3068    let now = time();
3069    let ts = context
3070        .get_config_i64(Config::DonationRequestNextCheck)
3071        .await?;
3072    if ts > now {
3073        return Ok(());
3074    }
3075    let msg_cnt = context.sql.count(
3076        "SELECT COUNT(*) FROM msgs WHERE state>=? AND hidden=0",
3077        (MessageState::OutDelivered,),
3078    );
3079    let ts = if ts == 0 || msg_cnt.await? < 100 {
3080        now.saturating_add(secs_between_checks)
3081    } else {
3082        let mut msg = Message::new_text(stock_str::donation_request(context));
3083        add_device_msg(context, None, Some(&mut msg)).await?;
3084        i64::MAX
3085    };
3086    context
3087        .set_config_internal(Config::DonationRequestNextCheck, Some(&ts.to_string()))
3088        .await
3089}
3090
3091/// Chat message list request options.
3092#[derive(Debug)]
3093pub struct MessageListOptions {
3094    /// Add day markers before each date regarding the local timezone.
3095    pub add_daymarker: bool,
3096}
3097
3098/// Returns all messages belonging to the chat.
3099pub async fn get_chat_msgs(context: &Context, chat_id: ChatId) -> Result<Vec<ChatItem>> {
3100    get_chat_msgs_ex(
3101        context,
3102        chat_id,
3103        MessageListOptions {
3104            add_daymarker: false,
3105        },
3106    )
3107    .await
3108}
3109
3110/// Returns messages belonging to the chat according to the given options,
3111/// sorted by oldest message first.
3112#[expect(clippy::arithmetic_side_effects)]
3113pub async fn get_chat_msgs_ex(
3114    context: &Context,
3115    chat_id: ChatId,
3116    options: MessageListOptions,
3117) -> Result<Vec<ChatItem>> {
3118    let MessageListOptions { add_daymarker } = options;
3119    let process_row = |row: &rusqlite::Row| {
3120        Ok((
3121            row.get::<_, i64>("timestamp")?,
3122            row.get::<_, MsgId>("id")?,
3123            false,
3124        ))
3125    };
3126    let process_rows = |rows: rusqlite::AndThenRows<_>| {
3127        // It is faster to sort here rather than
3128        // let sqlite execute an ORDER BY clause.
3129        let mut sorted_rows = Vec::new();
3130        for row in rows {
3131            let (ts, curr_id, exclude_message): (i64, MsgId, bool) = row?;
3132            if !exclude_message {
3133                sorted_rows.push((ts, curr_id));
3134            }
3135        }
3136        sorted_rows.sort_unstable();
3137
3138        let mut ret = Vec::new();
3139        let mut last_day = 0;
3140        let cnv_to_local = gm2local_offset();
3141
3142        for (ts, curr_id) in sorted_rows {
3143            if add_daymarker {
3144                let curr_local_timestamp = ts + cnv_to_local;
3145                let secs_in_day = 86400;
3146                let curr_day = curr_local_timestamp / secs_in_day;
3147                if curr_day != last_day {
3148                    ret.push(ChatItem::DayMarker {
3149                        timestamp: curr_day * secs_in_day - cnv_to_local,
3150                    });
3151                    last_day = curr_day;
3152                }
3153            }
3154            ret.push(ChatItem::Message { msg_id: curr_id });
3155        }
3156        Ok(ret)
3157    };
3158
3159    let items = context
3160        .sql
3161        .query_map(
3162            "SELECT m.id AS id, m.timestamp AS timestamp
3163               FROM msgs m
3164              WHERE m.chat_id=?
3165                AND m.hidden=0;",
3166            (chat_id,),
3167            process_row,
3168            process_rows,
3169        )
3170        .await?;
3171    Ok(items)
3172}
3173
3174/// Marks all unread messages in all chats as noticed.
3175/// Ignores messages from blocked contacts, but does not ignore messages in muted chats.
3176pub async fn marknoticed_all_chats(context: &Context) -> Result<()> {
3177    // The sql statement here is similar to the one in get_fresh_msgs
3178    let list = context
3179        .sql
3180        .query_map_vec(
3181            "SELECT DISTINCT(c.id)
3182                 FROM msgs m
3183                 INNER JOIN chats c
3184                        ON m.chat_id=c.id
3185                 WHERE m.state=?
3186                   AND m.hidden=0
3187                   AND m.chat_id>9
3188                   AND c.blocked=0;",
3189            (MessageState::InFresh,),
3190            |row| {
3191                let msg_id: ChatId = row.get(0)?;
3192                Ok(msg_id)
3193            },
3194        )
3195        .await?;
3196
3197    for chat_id in list {
3198        marknoticed_chat(context, chat_id).await?;
3199    }
3200
3201    Ok(())
3202}
3203
3204/// Marks all messages in the chat as noticed.
3205/// If the given chat-id is the archive-link, marks all messages in all archived chats as noticed.
3206pub async fn marknoticed_chat(context: &Context, chat_id: ChatId) -> Result<()> {
3207    // "WHERE" below uses the index `(state, hidden, chat_id)`, see get_fresh_msg_cnt() for reasoning
3208    // the additional SELECT statement may speed up things as no write-blocking is needed.
3209    if chat_id.is_archived_link() {
3210        let chat_ids_in_archive = context
3211            .sql
3212            .query_map_vec(
3213                "SELECT DISTINCT(m.chat_id) FROM msgs m
3214                    LEFT JOIN chats c ON m.chat_id=c.id
3215                    WHERE m.state=10 AND m.hidden=0 AND m.chat_id>9 AND c.archived=1",
3216                (),
3217                |row| {
3218                    let chat_id: ChatId = row.get(0)?;
3219                    Ok(chat_id)
3220                },
3221            )
3222            .await?;
3223        if chat_ids_in_archive.is_empty() {
3224            return Ok(());
3225        }
3226
3227        context
3228            .sql
3229            .transaction(|transaction| {
3230                let mut stmt = transaction.prepare(
3231                    "UPDATE msgs SET state=13 WHERE state=10 AND hidden=0 AND chat_id = ?",
3232                )?;
3233                for chat_id_in_archive in &chat_ids_in_archive {
3234                    stmt.execute((chat_id_in_archive,))?;
3235                }
3236                Ok(())
3237            })
3238            .await?;
3239
3240        for chat_id_in_archive in chat_ids_in_archive {
3241            start_chat_ephemeral_timers(context, chat_id_in_archive).await?;
3242            context.emit_event(EventType::MsgsNoticed(chat_id_in_archive));
3243            chatlist_events::emit_chatlist_item_changed(context, chat_id_in_archive);
3244        }
3245    } else {
3246        start_chat_ephemeral_timers(context, chat_id).await?;
3247
3248        let noticed_msgs_count = context
3249            .sql
3250            .execute(
3251                "UPDATE msgs
3252            SET state=?
3253          WHERE state=?
3254            AND hidden=0
3255            AND chat_id=?;",
3256                (MessageState::InNoticed, MessageState::InFresh, chat_id),
3257            )
3258            .await?;
3259
3260        // This is to trigger emitting `MsgsNoticed` on other devices when reactions are noticed
3261        // locally (i.e. when the chat was opened locally).
3262        let hidden_messages = context
3263            .sql
3264            .query_map_vec(
3265                "SELECT id FROM msgs
3266                    WHERE state=?
3267                      AND hidden=1
3268                      AND chat_id=?
3269                    ORDER BY id LIMIT 100", // LIMIT to 100 in order to avoid blocking the UI too long, usually there will be less than 100 messages anyway
3270                (MessageState::InFresh, chat_id), // No need to check for InNoticed messages, because reactions are never InNoticed
3271                |row| {
3272                    let msg_id: MsgId = row.get(0)?;
3273                    Ok(msg_id)
3274                },
3275            )
3276            .await?;
3277        message::markseen_msgs(context, hidden_messages).await?;
3278        if noticed_msgs_count == 0 {
3279            return Ok(());
3280        }
3281    }
3282
3283    context.emit_event(EventType::MsgsNoticed(chat_id));
3284    chatlist_events::emit_chatlist_item_changed(context, chat_id);
3285    context.on_archived_chats_maybe_noticed();
3286    Ok(())
3287}
3288
3289/// Marks messages preceding outgoing messages as noticed.
3290///
3291/// In a chat, if there is an outgoing message, it can be assumed that all previous
3292/// messages were noticed. So, this function takes a Vec of messages that were
3293/// just received, and for all the outgoing messages, it marks all
3294/// previous messages as noticed.
3295pub(crate) async fn mark_old_messages_as_noticed(
3296    context: &Context,
3297    mut msgs: Vec<ReceivedMsg>,
3298) -> Result<()> {
3299    if context.get_config_bool(Config::TeamProfile).await? {
3300        return Ok(());
3301    }
3302
3303    msgs.retain(|m| m.state.is_outgoing());
3304    if msgs.is_empty() {
3305        return Ok(());
3306    }
3307
3308    let mut msgs_by_chat: HashMap<ChatId, ReceivedMsg> = HashMap::new();
3309    for msg in msgs {
3310        let chat_id = msg.chat_id;
3311        if let Some(existing_msg) = msgs_by_chat.get(&chat_id) {
3312            if msg.sort_timestamp > existing_msg.sort_timestamp {
3313                msgs_by_chat.insert(chat_id, msg);
3314            }
3315        } else {
3316            msgs_by_chat.insert(chat_id, msg);
3317        }
3318    }
3319
3320    let changed_chats = context
3321        .sql
3322        .transaction(|transaction| {
3323            let mut changed_chats = Vec::new();
3324            for (_, msg) in msgs_by_chat {
3325                let changed_rows = transaction.execute(
3326                    "UPDATE msgs
3327            SET state=?
3328          WHERE state=?
3329            AND hidden=0
3330            AND chat_id=?
3331            AND timestamp<=?;",
3332                    (
3333                        MessageState::InNoticed,
3334                        MessageState::InFresh,
3335                        msg.chat_id,
3336                        msg.sort_timestamp,
3337                    ),
3338                )?;
3339                if changed_rows > 0 {
3340                    changed_chats.push(msg.chat_id);
3341                }
3342            }
3343            Ok(changed_chats)
3344        })
3345        .await?;
3346
3347    if !changed_chats.is_empty() {
3348        info!(
3349            context,
3350            "Marking chats as noticed because there are newer outgoing messages: {changed_chats:?}."
3351        );
3352        context.on_archived_chats_maybe_noticed();
3353    }
3354
3355    for c in changed_chats {
3356        start_chat_ephemeral_timers(context, c).await?;
3357        context.emit_event(EventType::MsgsNoticed(c));
3358        chatlist_events::emit_chatlist_item_changed(context, c);
3359    }
3360
3361    Ok(())
3362}
3363
3364/// Marks last incoming message in a chat as fresh.
3365pub async fn markfresh_chat(context: &Context, chat_id: ChatId) -> Result<()> {
3366    let affected_rows = context
3367        .sql
3368        .execute(
3369            "UPDATE msgs
3370                SET state=?1
3371              WHERE id=(SELECT id
3372                          FROM msgs
3373                         WHERE state IN (?1, ?2, ?3) AND hidden=0 AND chat_id=?4
3374                      ORDER BY timestamp DESC, id DESC
3375                         LIMIT 1)
3376                AND state!=?1",
3377            (
3378                MessageState::InFresh,
3379                MessageState::InNoticed,
3380                MessageState::InSeen,
3381                chat_id,
3382            ),
3383        )
3384        .await?;
3385
3386    if affected_rows == 0 {
3387        return Ok(());
3388    }
3389
3390    context.emit_msgs_changed_without_msg_id(chat_id);
3391    chatlist_events::emit_chatlist_item_changed(context, chat_id);
3392
3393    Ok(())
3394}
3395
3396/// Returns all database message IDs of the given types.
3397///
3398/// If `chat_id` is None, return messages from any chat.
3399///
3400/// `Viewtype::Unknown` can be used for `msg_type2` and `msg_type3`
3401/// if less than 3 viewtypes are requested.
3402pub async fn get_chat_media(
3403    context: &Context,
3404    chat_id: Option<ChatId>,
3405    msg_type: Viewtype,
3406    msg_type2: Viewtype,
3407    msg_type3: Viewtype,
3408) -> Result<Vec<MsgId>> {
3409    let list = if msg_type == Viewtype::Webxdc
3410        && msg_type2 == Viewtype::Unknown
3411        && msg_type3 == Viewtype::Unknown
3412    {
3413        context
3414            .sql
3415            .query_map_vec(
3416                "SELECT id
3417               FROM msgs
3418              WHERE (1=? OR chat_id=?)
3419                AND chat_id != ?
3420                AND type = ?
3421                AND hidden=0
3422              ORDER BY max(timestamp, timestamp_rcvd), id;",
3423                (
3424                    chat_id.is_none(),
3425                    chat_id.unwrap_or_else(|| ChatId::new(0)),
3426                    DC_CHAT_ID_TRASH,
3427                    Viewtype::Webxdc,
3428                ),
3429                |row| {
3430                    let msg_id: MsgId = row.get(0)?;
3431                    Ok(msg_id)
3432                },
3433            )
3434            .await?
3435    } else {
3436        context
3437            .sql
3438            .query_map_vec(
3439                "SELECT id
3440               FROM msgs
3441              WHERE (1=? OR chat_id=?)
3442                AND chat_id != ?
3443                AND type IN (?, ?, ?)
3444                AND hidden=0
3445              ORDER BY timestamp, id;",
3446                (
3447                    chat_id.is_none(),
3448                    chat_id.unwrap_or_else(|| ChatId::new(0)),
3449                    DC_CHAT_ID_TRASH,
3450                    msg_type,
3451                    if msg_type2 != Viewtype::Unknown {
3452                        msg_type2
3453                    } else {
3454                        msg_type
3455                    },
3456                    if msg_type3 != Viewtype::Unknown {
3457                        msg_type3
3458                    } else {
3459                        msg_type
3460                    },
3461                ),
3462                |row| {
3463                    let msg_id: MsgId = row.get(0)?;
3464                    Ok(msg_id)
3465                },
3466            )
3467            .await?
3468    };
3469    Ok(list)
3470}
3471
3472/// Returns a vector of contact IDs for given chat ID.
3473pub async fn get_chat_contacts(context: &Context, chat_id: ChatId) -> Result<Vec<ContactId>> {
3474    // Normal chats do not include SELF.  Group chats do (as it may happen that one is deleted from a
3475    // groupchat but the chats stays visible, moreover, this makes displaying lists easier)
3476    context
3477        .sql
3478        .query_map_vec(
3479            "SELECT cc.contact_id
3480               FROM chats_contacts cc
3481               LEFT JOIN contacts c
3482                      ON c.id=cc.contact_id
3483              WHERE cc.chat_id=? AND cc.add_timestamp >= cc.remove_timestamp
3484              ORDER BY c.id=1, c.last_seen DESC, c.id DESC;",
3485            (chat_id,),
3486            |row| {
3487                let contact_id: ContactId = row.get(0)?;
3488                Ok(contact_id)
3489            },
3490        )
3491        .await
3492}
3493
3494/// Returns a vector of contact IDs for given chat ID that are no longer part of the group.
3495///
3496/// Members that have been removed recently are in the beginning of the list.
3497pub async fn get_past_chat_contacts(context: &Context, chat_id: ChatId) -> Result<Vec<ContactId>> {
3498    let now = time();
3499    context
3500        .sql
3501        .query_map_vec(
3502            "SELECT cc.contact_id
3503             FROM chats_contacts cc
3504             LEFT JOIN contacts c
3505                  ON c.id=cc.contact_id
3506             WHERE cc.chat_id=?
3507             AND cc.add_timestamp < cc.remove_timestamp
3508             AND ? < cc.remove_timestamp
3509             ORDER BY c.id=1, cc.remove_timestamp DESC, c.id DESC",
3510            (chat_id, now.saturating_sub(60 * 24 * 3600)),
3511            |row| {
3512                let contact_id: ContactId = row.get(0)?;
3513                Ok(contact_id)
3514            },
3515        )
3516        .await
3517}
3518
3519/// Creates an encrypted group chat.
3520pub async fn create_group(context: &Context, name: &str) -> Result<ChatId> {
3521    create_group_ex(context, Sync, create_id(), name).await
3522}
3523
3524/// Creates an unencrypted group chat.
3525pub async fn create_group_unencrypted(context: &Context, name: &str) -> Result<ChatId> {
3526    create_group_ex(context, Sync, String::new(), name).await
3527}
3528
3529/// Creates a group chat.
3530///
3531/// * `sync` - Whether a multi-device synchronization message should be sent. Ignored for
3532///   unencrypted chats currently.
3533/// * `grpid` - Group ID. Iff nonempty, the chat is encrypted (with key-contacts).
3534/// * `name` - Chat name.
3535pub(crate) async fn create_group_ex(
3536    context: &Context,
3537    sync: sync::Sync,
3538    grpid: String,
3539    name: &str,
3540) -> Result<ChatId> {
3541    let mut chat_name = sanitize_single_line(name);
3542    if chat_name.is_empty() {
3543        // We can't just fail because the user would lose the work already done in the UI like
3544        // selecting members.
3545        error!(context, "Invalid chat name: {name}.");
3546        chat_name = "…".to_string();
3547    }
3548
3549    let timestamp = create_smeared_timestamp(context);
3550    let row_id = context
3551        .sql
3552        .insert(
3553            "INSERT INTO chats
3554        (type, name, name_normalized, grpid, param, created_timestamp)
3555        VALUES(?, ?, ?, ?, \'U=1\', ?)",
3556            (
3557                Chattype::Group,
3558                &chat_name,
3559                normalize_text(&chat_name),
3560                &grpid,
3561                timestamp,
3562            ),
3563        )
3564        .await?;
3565
3566    let chat_id = ChatId::new(u32::try_from(row_id)?);
3567    add_to_chat_contacts_table(context, timestamp, chat_id, &[ContactId::SELF]).await?;
3568
3569    context.emit_msgs_changed_without_ids();
3570    chatlist_events::emit_chatlist_changed(context);
3571    chatlist_events::emit_chatlist_item_changed(context, chat_id);
3572
3573    if !grpid.is_empty() {
3574        // Add "Messages are end-to-end encrypted." message.
3575        chat_id.add_e2ee_notice(context, timestamp).await?;
3576    }
3577
3578    if !context.get_config_bool(Config::Bot).await?
3579        && !context.get_config_bool(Config::SkipStartMessages).await?
3580    {
3581        let text = if !grpid.is_empty() {
3582            // Add "Others will only see this group after you sent a first message." message.
3583            stock_str::new_group_send_first_message(context)
3584        } else {
3585            // Add "Messages in this chat use classic email and are not encrypted." message.
3586            stock_str::chat_unencrypted_explanation(context)
3587        };
3588        chat_id.add_start_info_message(context, &text).await?;
3589    }
3590    if let (true, true) = (sync.into(), !grpid.is_empty()) {
3591        let id = SyncId::Grpid(grpid);
3592        let action = SyncAction::CreateGroupEncrypted(chat_name);
3593        self::sync(context, id, action).await.log_err(context).ok();
3594    }
3595    Ok(chat_id)
3596}
3597
3598/// Create a new, outgoing **broadcast channel**
3599/// (called "Channel" in the UI).
3600///
3601/// Broadcast channels are similar to groups on the sending device,
3602/// however, recipients get the messages in a read-only chat
3603/// and will not see who the other members are.
3604///
3605/// Called `broadcast` here rather than `channel`,
3606/// because the word "channel" already appears a lot in the code,
3607/// which would make it hard to grep for it.
3608///
3609/// After creation, the chat contains no recipients and is in _unpromoted_ state;
3610/// see [`create_group`] for more information on the unpromoted state.
3611///
3612/// Returns the created chat's id.
3613pub async fn create_broadcast(context: &Context, chat_name: String) -> Result<ChatId> {
3614    let grpid = create_id();
3615    let secret = create_broadcast_secret();
3616    create_out_broadcast_ex(context, Sync, grpid, chat_name, secret).await
3617}
3618
3619const SQL_INSERT_BROADCAST_SECRET: &str =
3620    "INSERT INTO broadcast_secrets (chat_id, secret) VALUES (?, ?)
3621    ON CONFLICT(chat_id) DO UPDATE SET secret=excluded.secret";
3622
3623pub(crate) async fn create_out_broadcast_ex(
3624    context: &Context,
3625    sync: sync::Sync,
3626    grpid: String,
3627    chat_name: String,
3628    secret: String,
3629) -> Result<ChatId> {
3630    let chat_name = sanitize_single_line(&chat_name);
3631    if chat_name.is_empty() {
3632        bail!("Invalid broadcast channel name: {chat_name}.");
3633    }
3634
3635    let timestamp = create_smeared_timestamp(context);
3636    let trans_fn = |t: &mut rusqlite::Transaction| -> Result<ChatId> {
3637        let cnt: u32 = t.query_row(
3638            "SELECT COUNT(*) FROM chats WHERE grpid=?",
3639            (&grpid,),
3640            |row| row.get(0),
3641        )?;
3642        ensure!(cnt == 0, "{cnt} chats exist with grpid {grpid}");
3643
3644        t.execute(
3645            "INSERT INTO chats
3646            (type, name, name_normalized, grpid, created_timestamp)
3647            VALUES(?, ?, ?, ?, ?)",
3648            (
3649                Chattype::OutBroadcast,
3650                &chat_name,
3651                normalize_text(&chat_name),
3652                &grpid,
3653                timestamp,
3654            ),
3655        )?;
3656        let chat_id = ChatId::new(t.last_insert_rowid().try_into()?);
3657
3658        t.execute(SQL_INSERT_BROADCAST_SECRET, (chat_id, &secret))?;
3659        Ok(chat_id)
3660    };
3661    let chat_id = context.sql.transaction(trans_fn).await?;
3662    chat_id.add_e2ee_notice(context, timestamp).await?;
3663
3664    context.emit_msgs_changed_without_ids();
3665    chatlist_events::emit_chatlist_changed(context);
3666    chatlist_events::emit_chatlist_item_changed(context, chat_id);
3667
3668    if sync.into() {
3669        let id = SyncId::Grpid(grpid);
3670        let action = SyncAction::CreateOutBroadcast { chat_name, secret };
3671        self::sync(context, id, action).await.log_err(context).ok();
3672    }
3673
3674    Ok(chat_id)
3675}
3676
3677pub(crate) async fn load_broadcast_secret(
3678    context: &Context,
3679    chat_id: ChatId,
3680) -> Result<Option<String>> {
3681    context
3682        .sql
3683        .query_get_value(
3684            "SELECT secret FROM broadcast_secrets WHERE chat_id=?",
3685            (chat_id,),
3686        )
3687        .await
3688}
3689
3690pub(crate) async fn save_broadcast_secret(
3691    context: &Context,
3692    chat_id: ChatId,
3693    secret: &str,
3694) -> Result<()> {
3695    info!(context, "Saving broadcast secret for chat {chat_id}");
3696    context
3697        .sql
3698        .execute(SQL_INSERT_BROADCAST_SECRET, (chat_id, secret))
3699        .await?;
3700
3701    Ok(())
3702}
3703
3704pub(crate) async fn delete_broadcast_secret(context: &Context, chat_id: ChatId) -> Result<()> {
3705    info!(context, "Removing broadcast secret for chat {chat_id}");
3706    context
3707        .sql
3708        .execute("DELETE FROM broadcast_secrets WHERE chat_id=?", (chat_id,))
3709        .await?;
3710
3711    Ok(())
3712}
3713
3714/// Set chat contacts in the `chats_contacts` table.
3715pub(crate) async fn update_chat_contacts_table(
3716    context: &Context,
3717    timestamp: i64,
3718    id: ChatId,
3719    contacts: &BTreeSet<ContactId>,
3720) -> Result<()> {
3721    context
3722        .sql
3723        .transaction(move |transaction| {
3724            // Bump `remove_timestamp` to at least `now`
3725            // even for members from `contacts`.
3726            // We add members from `contacts` back below.
3727            transaction.execute(
3728                "UPDATE chats_contacts
3729                 SET remove_timestamp=MAX(add_timestamp+1, ?)
3730                 WHERE chat_id=?",
3731                (timestamp, id),
3732            )?;
3733
3734            if !contacts.is_empty() {
3735                let mut statement = transaction.prepare(
3736                    "INSERT INTO chats_contacts (chat_id, contact_id, add_timestamp)
3737                     VALUES                     (?1,      ?2,         ?3)
3738                     ON CONFLICT (chat_id, contact_id)
3739                     DO UPDATE SET add_timestamp=remove_timestamp",
3740                )?;
3741
3742                for contact_id in contacts {
3743                    // We bumped `add_timestamp` for existing rows above,
3744                    // so on conflict it is enough to set `add_timestamp = remove_timestamp`
3745                    // and this guarantees that `add_timestamp` is no less than `timestamp`.
3746                    statement.execute((id, contact_id, timestamp))?;
3747                }
3748            }
3749            Ok(())
3750        })
3751        .await?;
3752    Ok(())
3753}
3754
3755/// Adds contacts to the `chats_contacts` table.
3756pub(crate) async fn add_to_chat_contacts_table(
3757    context: &Context,
3758    timestamp: i64,
3759    chat_id: ChatId,
3760    contact_ids: &[ContactId],
3761) -> Result<()> {
3762    context
3763        .sql
3764        .transaction(move |transaction| {
3765            let mut add_statement = transaction.prepare(
3766                "INSERT INTO chats_contacts (chat_id, contact_id, add_timestamp) VALUES(?1, ?2, ?3)
3767                 ON CONFLICT (chat_id, contact_id)
3768                 DO UPDATE SET add_timestamp=MAX(remove_timestamp, ?3)",
3769            )?;
3770
3771            for contact_id in contact_ids {
3772                add_statement.execute((chat_id, contact_id, timestamp))?;
3773            }
3774            Ok(())
3775        })
3776        .await?;
3777
3778    Ok(())
3779}
3780
3781/// Removes a contact from the chat
3782/// by updating the `remove_timestamp`.
3783pub(crate) async fn remove_from_chat_contacts_table(
3784    context: &Context,
3785    chat_id: ChatId,
3786    contact_id: ContactId,
3787) -> Result<()> {
3788    let now = time();
3789    context
3790        .sql
3791        .execute(
3792            "UPDATE chats_contacts
3793             SET remove_timestamp=MAX(add_timestamp+1, ?)
3794             WHERE chat_id=? AND contact_id=?",
3795            (now, chat_id, contact_id),
3796        )
3797        .await?;
3798    Ok(())
3799}
3800
3801/// Removes a contact from the chat
3802/// without leaving a trace.
3803///
3804/// Note that if we call this function,
3805/// and then receive a message from another device
3806/// that doesn't know that this this member was removed
3807/// then the group membership algorithm will wrongly re-add this member.
3808pub(crate) async fn remove_from_chat_contacts_table_without_trace(
3809    context: &Context,
3810    chat_id: ChatId,
3811    contact_id: ContactId,
3812) -> Result<()> {
3813    context
3814        .sql
3815        .execute(
3816            "DELETE FROM chats_contacts
3817            WHERE chat_id=? AND contact_id=?",
3818            (chat_id, contact_id),
3819        )
3820        .await?;
3821
3822    Ok(())
3823}
3824
3825/// Adds a contact to the chat.
3826/// If the group is promoted, also sends out a system message to all group members
3827pub async fn add_contact_to_chat(
3828    context: &Context,
3829    chat_id: ChatId,
3830    contact_id: ContactId,
3831) -> Result<()> {
3832    add_contact_to_chat_ex(context, Sync, chat_id, contact_id, false).await?;
3833    Ok(())
3834}
3835
3836pub(crate) async fn add_contact_to_chat_ex(
3837    context: &Context,
3838    mut sync: sync::Sync,
3839    chat_id: ChatId,
3840    contact_id: ContactId,
3841    from_handshake: bool,
3842) -> Result<bool> {
3843    ensure!(!chat_id.is_special(), "can not add member to special chats");
3844    let contact = Contact::get_by_id(context, contact_id).await?;
3845    let mut msg = Message::new(Viewtype::default());
3846
3847    chat_id.reset_gossiped_timestamp(context).await?;
3848
3849    // this also makes sure, no contacts are added to special or normal chats
3850    let mut chat = Chat::load_from_db(context, chat_id).await?;
3851    ensure!(
3852        chat.typ == Chattype::Group || (from_handshake && chat.typ == Chattype::OutBroadcast),
3853        "{chat_id} is not a group where one can add members",
3854    );
3855    ensure!(
3856        Contact::real_exists_by_id(context, contact_id).await? || contact_id == ContactId::SELF,
3857        "invalid contact_id {contact_id} for adding to group"
3858    );
3859    ensure!(
3860        chat.typ != Chattype::OutBroadcast || contact_id != ContactId::SELF,
3861        "Cannot add SELF to broadcast channel."
3862    );
3863    match chat.is_encrypted(context).await? {
3864        true => ensure!(
3865            contact.is_key_contact(),
3866            "Only key-contacts can be added to encrypted chats"
3867        ),
3868        false => ensure!(
3869            !contact.is_key_contact(),
3870            "Only address-contacts can be added to unencrypted chats"
3871        ),
3872    }
3873
3874    if !chat.is_self_in_chat(context).await? {
3875        context.emit_event(EventType::ErrorSelfNotInGroup(
3876            "Cannot add contact to group; self not in group.".into(),
3877        ));
3878        warn!(
3879            context,
3880            "Can not add contact because the account is not part of the group/broadcast."
3881        );
3882        return Ok(false);
3883    }
3884    if from_handshake && chat.param.get_int(Param::Unpromoted).unwrap_or_default() == 1 {
3885        let smeared_time = smeared_time(context);
3886        chat.param
3887            .remove(Param::Unpromoted)
3888            .set_i64(Param::GroupNameTimestamp, smeared_time)
3889            .set_i64(Param::GroupDescriptionTimestamp, smeared_time);
3890        chat.update_param(context).await?;
3891    }
3892    if context.is_self_addr(contact.get_addr()).await? {
3893        // ourself is added using ContactId::SELF, do not add this address explicitly.
3894        // if SELF is not in the group, members cannot be added at all.
3895        warn!(
3896            context,
3897            "Invalid attempt to add self e-mail address to group."
3898        );
3899        return Ok(false);
3900    }
3901
3902    if is_contact_in_chat(context, chat_id, contact_id).await? {
3903        if !from_handshake {
3904            return Ok(true);
3905        }
3906    } else {
3907        // else continue and send status mail
3908        add_to_chat_contacts_table(context, time(), chat_id, &[contact_id]).await?;
3909    }
3910    if chat.is_promoted() {
3911        msg.viewtype = Viewtype::Text;
3912
3913        let contact_addr = contact.get_addr().to_lowercase();
3914        let added_by = if from_handshake && chat.typ == Chattype::OutBroadcast {
3915            // The contact was added via a QR code rather than explicit user action,
3916            // so it could be confusing to say 'You added member Alice'.
3917            // And in a broadcast, SELF is the only one who can add members,
3918            // so, no information is lost by just writing 'Member Alice added' instead.
3919            ContactId::UNDEFINED
3920        } else {
3921            ContactId::SELF
3922        };
3923        msg.text = stock_str::msg_add_member_local(context, contact.id, added_by).await;
3924        msg.param.set_cmd(SystemMessage::MemberAddedToGroup);
3925        msg.param.set(Param::Arg, contact_addr);
3926        msg.param.set_int(Param::Arg2, from_handshake.into());
3927        let fingerprint = contact.fingerprint().map(|f| f.hex());
3928        msg.param.set_optional(Param::Arg4, fingerprint);
3929        msg.param
3930            .set_int(Param::ContactAddedRemoved, contact.id.to_u32() as i32);
3931        if chat.typ == Chattype::OutBroadcast {
3932            let secret = load_broadcast_secret(context, chat_id)
3933                .await?
3934                .context("Failed to find broadcast shared secret")?;
3935            msg.param.set(PARAM_BROADCAST_SECRET, secret);
3936        }
3937        send_msg(context, chat_id, &mut msg).await?;
3938
3939        sync = Nosync;
3940    }
3941    context.emit_event(EventType::ChatModified(chat_id));
3942    if sync.into() {
3943        chat.sync_contacts(context).await.log_err(context).ok();
3944    }
3945    if chat.typ == Chattype::OutBroadcast {
3946        resend_last_msgs(context, chat.id, &contact)
3947            .await
3948            .log_err(context)
3949            .ok();
3950    }
3951    Ok(true)
3952}
3953
3954async fn resend_last_msgs(context: &Context, chat_id: ChatId, to_contact: &Contact) -> Result<()> {
3955    let msgs: Vec<MsgId> = context
3956        .sql
3957        .query_map_vec(
3958            "
3959SELECT id
3960FROM msgs
3961WHERE chat_id=?
3962    AND hidden=0
3963    AND NOT ( -- Exclude info and system messages
3964        param GLOB '*\nS=*' OR param GLOB 'S=*'
3965        OR from_id=?
3966        OR to_id=?
3967    )
3968    AND type!=?
3969ORDER BY timestamp DESC, id DESC LIMIT ?",
3970            (
3971                chat_id,
3972                ContactId::INFO,
3973                ContactId::INFO,
3974                Viewtype::Webxdc,
3975                constants::N_MSGS_TO_NEW_BROADCAST_MEMBER,
3976            ),
3977            |row: &rusqlite::Row| Ok(row.get::<_, MsgId>(0)?),
3978        )
3979        .await?
3980        .into_iter()
3981        .rev()
3982        .collect();
3983    resend_msgs_ex(context, &msgs, to_contact.fingerprint()).await
3984}
3985
3986/// Returns true if an avatar should be attached in the given chat.
3987///
3988/// This function does not check if the avatar is set.
3989/// If avatar is not set and this function returns `true`,
3990/// a `Chat-User-Avatar: 0` header should be sent to reset the avatar.
3991#[expect(clippy::arithmetic_side_effects)]
3992pub(crate) async fn shall_attach_selfavatar(context: &Context, chat_id: ChatId) -> Result<bool> {
3993    let timestamp_some_days_ago = time() - DC_RESEND_USER_AVATAR_DAYS * 24 * 60 * 60;
3994    let needs_attach = context
3995        .sql
3996        .query_map(
3997            "SELECT c.selfavatar_sent
3998             FROM chats_contacts cc
3999             LEFT JOIN contacts c ON c.id=cc.contact_id
4000             WHERE cc.chat_id=? AND cc.contact_id!=? AND cc.add_timestamp >= cc.remove_timestamp",
4001            (chat_id, ContactId::SELF),
4002            |row| {
4003                let selfavatar_sent: i64 = row.get(0)?;
4004                Ok(selfavatar_sent)
4005            },
4006            |rows| {
4007                let mut needs_attach = false;
4008                for row in rows {
4009                    let selfavatar_sent = row?;
4010                    if selfavatar_sent < timestamp_some_days_ago {
4011                        needs_attach = true;
4012                    }
4013                }
4014                Ok(needs_attach)
4015            },
4016        )
4017        .await?;
4018    Ok(needs_attach)
4019}
4020
4021/// Chat mute duration.
4022#[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize)]
4023pub enum MuteDuration {
4024    /// Chat is not muted.
4025    NotMuted,
4026
4027    /// Chat is muted until the user unmutes the chat.
4028    Forever,
4029
4030    /// Chat is muted for a limited period of time.
4031    Until(std::time::SystemTime),
4032}
4033
4034impl rusqlite::types::ToSql for MuteDuration {
4035    fn to_sql(&self) -> rusqlite::Result<rusqlite::types::ToSqlOutput<'_>> {
4036        let duration: i64 = match &self {
4037            MuteDuration::NotMuted => 0,
4038            MuteDuration::Forever => -1,
4039            MuteDuration::Until(when) => {
4040                let duration = when
4041                    .duration_since(SystemTime::UNIX_EPOCH)
4042                    .map_err(|err| rusqlite::Error::ToSqlConversionFailure(Box::new(err)))?;
4043                i64::try_from(duration.as_secs())
4044                    .map_err(|err| rusqlite::Error::ToSqlConversionFailure(Box::new(err)))?
4045            }
4046        };
4047        let val = rusqlite::types::Value::Integer(duration);
4048        let out = rusqlite::types::ToSqlOutput::Owned(val);
4049        Ok(out)
4050    }
4051}
4052
4053impl rusqlite::types::FromSql for MuteDuration {
4054    fn column_result(value: rusqlite::types::ValueRef) -> rusqlite::types::FromSqlResult<Self> {
4055        // Negative values other than -1 should not be in the
4056        // database.  If found they'll be NotMuted.
4057        match i64::column_result(value)? {
4058            0 => Ok(MuteDuration::NotMuted),
4059            -1 => Ok(MuteDuration::Forever),
4060            n if n > 0 => match SystemTime::UNIX_EPOCH.checked_add(Duration::from_secs(n as u64)) {
4061                Some(t) => Ok(MuteDuration::Until(t)),
4062                None => Err(rusqlite::types::FromSqlError::OutOfRange(n)),
4063            },
4064            _ => Ok(MuteDuration::NotMuted),
4065        }
4066    }
4067}
4068
4069/// Mutes the chat for a given duration or unmutes it.
4070pub async fn set_muted(context: &Context, chat_id: ChatId, duration: MuteDuration) -> Result<()> {
4071    set_muted_ex(context, Sync, chat_id, duration).await
4072}
4073
4074pub(crate) async fn set_muted_ex(
4075    context: &Context,
4076    sync: sync::Sync,
4077    chat_id: ChatId,
4078    duration: MuteDuration,
4079) -> Result<()> {
4080    ensure!(!chat_id.is_special(), "Invalid chat ID");
4081    context
4082        .sql
4083        .execute(
4084            "UPDATE chats SET muted_until=? WHERE id=?;",
4085            (duration, chat_id),
4086        )
4087        .await
4088        .context(format!("Failed to set mute duration for {chat_id}"))?;
4089    context.emit_event(EventType::ChatModified(chat_id));
4090    chatlist_events::emit_chatlist_item_changed(context, chat_id);
4091    if sync.into() {
4092        let chat = Chat::load_from_db(context, chat_id).await?;
4093        chat.sync(context, SyncAction::SetMuted(duration))
4094            .await
4095            .log_err(context)
4096            .ok();
4097    }
4098    Ok(())
4099}
4100
4101/// Removes contact from the chat.
4102pub async fn remove_contact_from_chat(
4103    context: &Context,
4104    chat_id: ChatId,
4105    contact_id: ContactId,
4106) -> Result<()> {
4107    ensure!(
4108        !chat_id.is_special(),
4109        "bad chat_id, can not be special chat: {chat_id}"
4110    );
4111    ensure!(
4112        !contact_id.is_special() || contact_id == ContactId::SELF,
4113        "Cannot remove special contact"
4114    );
4115
4116    let chat = Chat::load_from_db(context, chat_id).await?;
4117    if chat.typ == Chattype::InBroadcast {
4118        ensure!(
4119            contact_id == ContactId::SELF,
4120            "Cannot remove other member from incoming broadcast channel"
4121        );
4122        delete_broadcast_secret(context, chat_id).await?;
4123    }
4124
4125    ensure!(
4126        matches!(
4127            chat.typ,
4128            Chattype::Group | Chattype::OutBroadcast | Chattype::InBroadcast
4129        ),
4130        "Cannot remove members from non-group chats."
4131    );
4132
4133    if !chat.is_self_in_chat(context).await? {
4134        let err_msg =
4135            format!("Cannot remove contact {contact_id} from chat {chat_id}: self not in group.");
4136        context.emit_event(EventType::ErrorSelfNotInGroup(err_msg.clone()));
4137        bail!("{err_msg}");
4138    }
4139
4140    let mut sync = Nosync;
4141
4142    if chat.is_promoted() && chat.typ != Chattype::OutBroadcast {
4143        remove_from_chat_contacts_table(context, chat_id, contact_id).await?;
4144    } else {
4145        remove_from_chat_contacts_table_without_trace(context, chat_id, contact_id).await?;
4146    }
4147
4148    // We do not return an error if the contact does not exist in the database.
4149    // This allows to delete dangling references to deleted contacts
4150    // in case of the database becoming inconsistent due to a bug.
4151    if let Some(contact) = Contact::get_by_id_optional(context, contact_id).await? {
4152        if chat.is_promoted() {
4153            let addr = contact.get_addr();
4154            let fingerprint = contact.fingerprint().map(|f| f.hex());
4155
4156            let res =
4157                send_member_removal_msg(context, &chat, contact_id, addr, fingerprint.as_deref())
4158                    .await;
4159
4160            if contact_id == ContactId::SELF {
4161                res?;
4162            } else if let Err(e) = res {
4163                warn!(
4164                    context,
4165                    "remove_contact_from_chat({chat_id}, {contact_id}): send_msg() failed: {e:#}."
4166                );
4167            }
4168        } else {
4169            sync = Sync;
4170        }
4171    }
4172    context.emit_event(EventType::ChatModified(chat_id));
4173    if sync.into() {
4174        chat.sync_contacts(context).await.log_err(context).ok();
4175    }
4176
4177    Ok(())
4178}
4179
4180async fn send_member_removal_msg(
4181    context: &Context,
4182    chat: &Chat,
4183    contact_id: ContactId,
4184    addr: &str,
4185    fingerprint: Option<&str>,
4186) -> Result<MsgId> {
4187    let mut msg = Message::new(Viewtype::Text);
4188
4189    if contact_id == ContactId::SELF {
4190        if chat.typ == Chattype::InBroadcast {
4191            msg.text = stock_str::msg_you_left_broadcast(context);
4192        } else {
4193            msg.text = stock_str::msg_group_left_local(context, ContactId::SELF).await;
4194        }
4195    } else {
4196        msg.text = stock_str::msg_del_member_local(context, contact_id, ContactId::SELF).await;
4197    }
4198
4199    msg.param.set_cmd(SystemMessage::MemberRemovedFromGroup);
4200    msg.param.set(Param::Arg, addr.to_lowercase());
4201    msg.param.set_optional(Param::Arg4, fingerprint);
4202    msg.param
4203        .set(Param::ContactAddedRemoved, contact_id.to_u32());
4204
4205    send_msg(context, chat.id, &mut msg).await
4206}
4207
4208/// Set group or broadcast channel description.
4209///
4210/// If the group is already _promoted_ (any message was sent to the group),
4211/// or if this is a brodacast channel,
4212/// all members are informed by a special status message that is sent automatically by this function.
4213///
4214/// Sends out #DC_EVENT_CHAT_MODIFIED and #DC_EVENT_MSGS_CHANGED if a status message was sent.
4215///
4216/// See also [`get_chat_description`]
4217pub async fn set_chat_description(
4218    context: &Context,
4219    chat_id: ChatId,
4220    new_description: &str,
4221) -> Result<()> {
4222    set_chat_description_ex(context, Sync, chat_id, new_description).await
4223}
4224
4225async fn set_chat_description_ex(
4226    context: &Context,
4227    mut sync: sync::Sync,
4228    chat_id: ChatId,
4229    new_description: &str,
4230) -> Result<()> {
4231    let new_description = sanitize_bidi_characters(new_description.trim());
4232
4233    ensure!(!chat_id.is_special(), "Invalid chat ID");
4234
4235    let chat = Chat::load_from_db(context, chat_id).await?;
4236    ensure!(
4237        chat.typ == Chattype::Group || chat.typ == Chattype::OutBroadcast,
4238        "Can only set description for groups / broadcasts"
4239    );
4240    ensure!(
4241        !chat.grpid.is_empty(),
4242        "Cannot set description for ad hoc groups"
4243    );
4244    if !chat.is_self_in_chat(context).await? {
4245        context.emit_event(EventType::ErrorSelfNotInGroup(
4246            "Cannot set chat description; self not in group".into(),
4247        ));
4248        bail!("Cannot set chat description; self not in group");
4249    }
4250
4251    let old_description = get_chat_description(context, chat_id).await?;
4252    if old_description == new_description {
4253        return Ok(());
4254    }
4255
4256    context
4257        .sql
4258        .execute(
4259            "INSERT OR REPLACE INTO chats_descriptions(chat_id, description) VALUES(?, ?)",
4260            (chat_id, &new_description),
4261        )
4262        .await?;
4263
4264    if chat.is_promoted() {
4265        let mut msg = Message::new(Viewtype::Text);
4266        msg.text = stock_str::msg_chat_description_changed(context, ContactId::SELF).await;
4267        msg.param.set_cmd(SystemMessage::GroupDescriptionChanged);
4268
4269        msg.id = send_msg(context, chat_id, &mut msg).await?;
4270        context.emit_msgs_changed(chat_id, msg.id);
4271        sync = Nosync;
4272    }
4273    context.emit_event(EventType::ChatModified(chat_id));
4274
4275    if sync.into() {
4276        chat.sync(context, SyncAction::SetDescription(new_description))
4277            .await
4278            .log_err(context)
4279            .ok();
4280    }
4281
4282    Ok(())
4283}
4284
4285/// Load the chat description from the database.
4286///
4287/// UIs show this in the profile page of the chat,
4288/// it is settable by [`set_chat_description`]
4289pub async fn get_chat_description(context: &Context, chat_id: ChatId) -> Result<String> {
4290    let description = context
4291        .sql
4292        .query_get_value(
4293            "SELECT description FROM chats_descriptions WHERE chat_id=?",
4294            (chat_id,),
4295        )
4296        .await?
4297        .unwrap_or_default();
4298    Ok(description)
4299}
4300
4301/// Sets group, mailing list, or broadcast channel chat name.
4302///
4303/// If the group is already _promoted_ (any message was sent to the group),
4304/// or if this is a brodacast channel,
4305/// all members are informed by a special status message that is sent automatically by this function.
4306///
4307/// Sends out #DC_EVENT_CHAT_MODIFIED and #DC_EVENT_MSGS_CHANGED if a status message was sent.
4308pub async fn set_chat_name(context: &Context, chat_id: ChatId, new_name: &str) -> Result<()> {
4309    rename_ex(context, Sync, chat_id, new_name).await
4310}
4311
4312async fn rename_ex(
4313    context: &Context,
4314    mut sync: sync::Sync,
4315    chat_id: ChatId,
4316    new_name: &str,
4317) -> Result<()> {
4318    let new_name = sanitize_single_line(new_name);
4319    /* the function only sets the names of group chats; normal chats get their names from the contacts */
4320    let mut success = false;
4321
4322    ensure!(!new_name.is_empty(), "Invalid name");
4323    ensure!(!chat_id.is_special(), "Invalid chat ID");
4324
4325    let chat = Chat::load_from_db(context, chat_id).await?;
4326    let mut msg = Message::new(Viewtype::default());
4327
4328    if chat.typ == Chattype::Group
4329        || chat.typ == Chattype::Mailinglist
4330        || chat.typ == Chattype::OutBroadcast
4331    {
4332        if chat.name == new_name {
4333            success = true;
4334        } else if !chat.is_self_in_chat(context).await? {
4335            context.emit_event(EventType::ErrorSelfNotInGroup(
4336                "Cannot set chat name; self not in group".into(),
4337            ));
4338        } else {
4339            context
4340                .sql
4341                .execute(
4342                    "UPDATE chats SET name=?, name_normalized=? WHERE id=?",
4343                    (&new_name, normalize_text(&new_name), chat_id),
4344                )
4345                .await?;
4346            if chat.is_promoted()
4347                && !chat.is_mailing_list()
4348                && sanitize_single_line(&chat.name) != new_name
4349            {
4350                msg.viewtype = Viewtype::Text;
4351                msg.text = if chat.typ == Chattype::OutBroadcast {
4352                    stock_str::msg_broadcast_name_changed(context, &chat.name, &new_name)
4353                } else {
4354                    stock_str::msg_grp_name(context, &chat.name, &new_name, ContactId::SELF).await
4355                };
4356                msg.param.set_cmd(SystemMessage::GroupNameChanged);
4357                if !chat.name.is_empty() {
4358                    msg.param.set(Param::Arg, &chat.name);
4359                }
4360                msg.id = send_msg(context, chat_id, &mut msg).await?;
4361                context.emit_msgs_changed(chat_id, msg.id);
4362                sync = Nosync;
4363            }
4364            context.emit_event(EventType::ChatModified(chat_id));
4365            chatlist_events::emit_chatlist_item_changed(context, chat_id);
4366            success = true;
4367        }
4368    }
4369
4370    if !success {
4371        bail!("Failed to set name");
4372    }
4373    if sync.into() && chat.name != new_name {
4374        let sync_name = new_name.to_string();
4375        chat.sync(context, SyncAction::Rename(sync_name))
4376            .await
4377            .log_err(context)
4378            .ok();
4379    }
4380    Ok(())
4381}
4382
4383/// Sets a new profile image for the chat.
4384///
4385/// The profile image can only be set when you are a member of the
4386/// chat.  To remove the profile image pass an empty string for the
4387/// `new_image` parameter.
4388pub async fn set_chat_profile_image(
4389    context: &Context,
4390    chat_id: ChatId,
4391    new_image: &str, // XXX use PathBuf
4392) -> Result<()> {
4393    ensure!(!chat_id.is_special(), "Invalid chat ID");
4394    let mut chat = Chat::load_from_db(context, chat_id).await?;
4395    ensure!(
4396        chat.typ == Chattype::Group || chat.typ == Chattype::OutBroadcast,
4397        "Can only set profile image for groups / broadcasts"
4398    );
4399    ensure!(
4400        !chat.grpid.is_empty(),
4401        "Cannot set profile image for ad hoc groups"
4402    );
4403    /* we should respect this - whatever we send to the group, it gets discarded anyway! */
4404    if !chat.is_self_in_chat(context).await? {
4405        context.emit_event(EventType::ErrorSelfNotInGroup(
4406            "Cannot set chat profile image; self not in group.".into(),
4407        ));
4408        bail!("Failed to set profile image");
4409    }
4410    let mut msg = Message::new(Viewtype::Text);
4411    msg.param
4412        .set_int(Param::Cmd, SystemMessage::GroupImageChanged as i32);
4413    if new_image.is_empty() {
4414        chat.param.remove(Param::ProfileImage);
4415        msg.param.remove(Param::Arg);
4416        msg.text = if chat.typ == Chattype::OutBroadcast {
4417            stock_str::msg_broadcast_img_changed(context)
4418        } else {
4419            stock_str::msg_grp_img_deleted(context, ContactId::SELF).await
4420        };
4421    } else {
4422        let mut image_blob = BlobObject::create_and_deduplicate(
4423            context,
4424            Path::new(new_image),
4425            Path::new(new_image),
4426        )?;
4427        image_blob.recode_to_avatar_size(context).await?;
4428        chat.param.set(Param::ProfileImage, image_blob.as_name());
4429        msg.param.set(Param::Arg, image_blob.as_name());
4430        msg.text = if chat.typ == Chattype::OutBroadcast {
4431            stock_str::msg_broadcast_img_changed(context)
4432        } else {
4433            stock_str::msg_grp_img_changed(context, ContactId::SELF).await
4434        };
4435    }
4436    chat.update_param(context).await?;
4437    if chat.is_promoted() {
4438        msg.id = send_msg(context, chat_id, &mut msg).await?;
4439        context.emit_msgs_changed(chat_id, msg.id);
4440    }
4441    context.emit_event(EventType::ChatModified(chat_id));
4442    chatlist_events::emit_chatlist_item_changed(context, chat_id);
4443    Ok(())
4444}
4445
4446/// Forwards multiple messages to a chat.
4447pub async fn forward_msgs(context: &Context, msg_ids: &[MsgId], chat_id: ChatId) -> Result<()> {
4448    forward_msgs_2ctx(context, msg_ids, context, chat_id).await
4449}
4450
4451/// Forwards multiple messages to a chat in another context.
4452#[expect(clippy::arithmetic_side_effects)]
4453pub async fn forward_msgs_2ctx(
4454    ctx_src: &Context,
4455    msg_ids: &[MsgId],
4456    ctx_dst: &Context,
4457    chat_id: ChatId,
4458) -> Result<()> {
4459    ensure!(!msg_ids.is_empty(), "empty msgs_ids: nothing to forward");
4460    ensure!(!chat_id.is_special(), "can not forward to special chat");
4461
4462    let mut created_msgs: Vec<MsgId> = Vec::new();
4463    let mut curr_timestamp: i64;
4464
4465    chat_id
4466        .unarchive_if_not_muted(ctx_dst, MessageState::Undefined)
4467        .await?;
4468    let mut chat = Chat::load_from_db(ctx_dst, chat_id).await?;
4469    if let Some(reason) = chat.why_cant_send(ctx_dst).await? {
4470        bail!("cannot send to {chat_id}: {reason}");
4471    }
4472    curr_timestamp = create_smeared_timestamps(ctx_dst, msg_ids.len());
4473    let mut msgs = Vec::with_capacity(msg_ids.len());
4474    for id in msg_ids {
4475        let ts: i64 = ctx_src
4476            .sql
4477            .query_get_value("SELECT timestamp FROM msgs WHERE id=?", (id,))
4478            .await?
4479            .with_context(|| format!("No message {id}"))?;
4480        msgs.push((ts, *id));
4481    }
4482    msgs.sort_unstable();
4483    for (_, id) in msgs {
4484        let src_msg_id: MsgId = id;
4485        let mut msg = Message::load_from_db(ctx_src, src_msg_id).await?;
4486        if msg.state == MessageState::OutDraft {
4487            bail!("cannot forward drafts.");
4488        }
4489
4490        let mut param = msg.param;
4491        msg.param = Params::new();
4492
4493        if msg.get_viewtype() != Viewtype::Sticker {
4494            let forwarded_msg_id = match ctx_src.blobdir == ctx_dst.blobdir {
4495                true => src_msg_id,
4496                false => MsgId::new_unset(),
4497            };
4498            msg.param
4499                .set_int(Param::Forwarded, forwarded_msg_id.to_u32() as i32);
4500        }
4501
4502        if msg.get_viewtype() == Viewtype::Call {
4503            msg.viewtype = Viewtype::Text;
4504        }
4505        msg.text += &msg.additional_text;
4506
4507        let param = &mut param;
4508
4509        // When forwarding between different accounts, blob files must be physically copied
4510        // because each account has its own blob directory.
4511        if ctx_src.blobdir == ctx_dst.blobdir {
4512            msg.param.steal(param, Param::File);
4513        } else if let Some(src_path) = param.get_file_path(ctx_src)? {
4514            let new_blob = BlobObject::create_and_deduplicate(ctx_dst, &src_path, &src_path)
4515                .context("Failed to copy blob file to destination account")?;
4516            msg.param.set(Param::File, new_blob.as_name());
4517        }
4518        msg.param.steal(param, Param::Filename);
4519        msg.param.steal(param, Param::Width);
4520        msg.param.steal(param, Param::Height);
4521        msg.param.steal(param, Param::Duration);
4522        msg.param.steal(param, Param::MimeType);
4523        msg.param.steal(param, Param::ProtectQuote);
4524        msg.param.steal(param, Param::Quote);
4525        msg.param.steal(param, Param::Summary1);
4526        if msg.has_html() {
4527            msg.set_html(src_msg_id.get_html(ctx_src).await?);
4528        }
4529        msg.in_reply_to = None;
4530
4531        // do not leak data as group names; a default subject is generated by mimefactory
4532        msg.subject = "".to_string();
4533
4534        msg.state = MessageState::OutPending;
4535        msg.rfc724_mid = create_outgoing_rfc724_mid();
4536        msg.pre_rfc724_mid.clear();
4537        msg.timestamp_sort = curr_timestamp;
4538        chat.prepare_msg_raw(ctx_dst, &mut msg, None).await?;
4539
4540        curr_timestamp += 1;
4541        if !create_send_msg_jobs(ctx_dst, &mut msg).await?.is_empty() {
4542            ctx_dst.scheduler.interrupt_smtp().await;
4543        }
4544        created_msgs.push(msg.id);
4545    }
4546    for msg_id in created_msgs {
4547        ctx_dst.emit_msgs_changed(chat_id, msg_id);
4548    }
4549    Ok(())
4550}
4551
4552/// Save a copy of the message in "Saved Messages"
4553/// and send a sync messages so that other devices save the message as well, unless deleted there.
4554pub async fn save_msgs(context: &Context, msg_ids: &[MsgId]) -> Result<()> {
4555    let mut msgs = Vec::with_capacity(msg_ids.len());
4556    for id in msg_ids {
4557        let ts: i64 = context
4558            .sql
4559            .query_get_value("SELECT timestamp FROM msgs WHERE id=?", (id,))
4560            .await?
4561            .with_context(|| format!("No message {id}"))?;
4562        msgs.push((ts, *id));
4563    }
4564    msgs.sort_unstable();
4565    for (_, src_msg_id) in msgs {
4566        let dest_rfc724_mid = create_outgoing_rfc724_mid();
4567        let src_rfc724_mid = save_copy_in_self_talk(context, src_msg_id, &dest_rfc724_mid).await?;
4568        context
4569            .add_sync_item(SyncData::SaveMessage {
4570                src: src_rfc724_mid,
4571                dest: dest_rfc724_mid,
4572            })
4573            .await?;
4574    }
4575    context.scheduler.interrupt_smtp().await;
4576    Ok(())
4577}
4578
4579/// Saves a copy of the given message in "Saved Messages" using the given RFC724 id.
4580/// To allow UIs to have a "show in context" button,
4581/// the copy contains a reference to the original message
4582/// as well as to the original chat in case the original message gets deleted.
4583/// Returns data needed to add a `SaveMessage` sync item.
4584pub(crate) async fn save_copy_in_self_talk(
4585    context: &Context,
4586    src_msg_id: MsgId,
4587    dest_rfc724_mid: &String,
4588) -> Result<String> {
4589    let dest_chat_id = ChatId::create_for_contact(context, ContactId::SELF).await?;
4590    let mut msg = Message::load_from_db(context, src_msg_id).await?;
4591    msg.param.remove(Param::Cmd);
4592    msg.param.remove(Param::WebxdcDocument);
4593    msg.param.remove(Param::WebxdcDocumentTimestamp);
4594    msg.param.remove(Param::WebxdcSummary);
4595    msg.param.remove(Param::WebxdcSummaryTimestamp);
4596    msg.param.remove(Param::PostMessageFileBytes);
4597    msg.param.remove(Param::PostMessageViewtype);
4598
4599    msg.text += &msg.additional_text;
4600
4601    if !msg.original_msg_id.is_unset() {
4602        bail!("message already saved.");
4603    }
4604
4605    let copy_fields = "from_id, to_id, timestamp_rcvd, type,
4606                       mime_modified, mime_headers, mime_compressed, mime_in_reply_to, subject, msgrmsg";
4607    let row_id = context
4608        .sql
4609        .insert(
4610            &format!(
4611                "INSERT INTO msgs ({copy_fields},
4612                                   timestamp_sent,
4613                                   txt, chat_id, rfc724_mid, state, timestamp, param, starred)
4614                 SELECT            {copy_fields},
4615                                   -- Outgoing messages on originating device
4616                                   -- have timestamp_sent == 0.
4617                                   -- We copy sort timestamp instead
4618                                   -- so UIs display the same timestamp
4619                                   -- for saved and original message.
4620                                   IIF(timestamp_sent == 0, timestamp, timestamp_sent),
4621                                   ?, ?, ?, ?, ?, ?, ?
4622                 FROM msgs WHERE id=?;"
4623            ),
4624            (
4625                msg.text,
4626                dest_chat_id,
4627                dest_rfc724_mid,
4628                if msg.from_id == ContactId::SELF {
4629                    MessageState::OutDelivered
4630                } else {
4631                    MessageState::InSeen
4632                },
4633                create_smeared_timestamp(context),
4634                msg.param.to_string(),
4635                src_msg_id,
4636                src_msg_id,
4637            ),
4638        )
4639        .await?;
4640    let dest_msg_id = MsgId::new(row_id.try_into()?);
4641
4642    context.emit_msgs_changed(msg.chat_id, src_msg_id);
4643    context.emit_msgs_changed(dest_chat_id, dest_msg_id);
4644    chatlist_events::emit_chatlist_changed(context);
4645    chatlist_events::emit_chatlist_item_changed(context, dest_chat_id);
4646
4647    Ok(msg.rfc724_mid)
4648}
4649
4650/// Resends given messages to members of the corresponding chats.
4651///
4652/// This is primarily intended to make existing webxdcs available to new chat members.
4653pub async fn resend_msgs(context: &Context, msg_ids: &[MsgId]) -> Result<()> {
4654    resend_msgs_ex(context, msg_ids, None).await
4655}
4656
4657/// Resends given messages to a contact with fingerprint `to_fingerprint` or, if it's `None`, to
4658/// members of the corresponding chats.
4659///
4660/// NB: Actually `to_fingerprint` is only passed for `OutBroadcast` chats when a new member is
4661/// added. Regarding webxdcs: It is not trivial to resend only the own status updates,
4662/// and it is not trivial to resend them only to the newly-joined member,
4663/// so that for now, [`resend_last_msgs`] does not automatically resend webxdcs at all.
4664pub(crate) async fn resend_msgs_ex(
4665    context: &Context,
4666    msg_ids: &[MsgId],
4667    to_fingerprint: Option<Fingerprint>,
4668) -> Result<()> {
4669    let to_fingerprint = to_fingerprint.map(|f| f.hex());
4670    let mut msgs: Vec<Message> = Vec::new();
4671    for msg_id in msg_ids {
4672        let msg = Message::load_from_db(context, *msg_id).await?;
4673        ensure!(
4674            msg.from_id == ContactId::SELF,
4675            "can resend only own messages"
4676        );
4677        ensure!(!msg.is_info(), "cannot resend info messages");
4678        msgs.push(msg)
4679    }
4680
4681    for mut msg in msgs {
4682        match msg.get_state() {
4683            // `get_state()` may return an outdated `OutPending`, so update anyway.
4684            MessageState::OutPending
4685            | MessageState::OutFailed
4686            | MessageState::OutDelivered
4687            | MessageState::OutMdnRcvd => {
4688                // Broadcast owners shouldn't see spinners on messages being auto-re-sent to new
4689                // subscribers (otherwise big channel owners will see spinners most of the time).
4690                if to_fingerprint.is_none() {
4691                    message::update_msg_state(context, msg.id, MessageState::OutPending).await?;
4692                }
4693            }
4694            msg_state => bail!("Unexpected message state {msg_state}"),
4695        }
4696        if let Some(to_fingerprint) = &to_fingerprint {
4697            msg.param.set(Param::Arg4, to_fingerprint.clone());
4698        }
4699        if create_send_msg_jobs(context, &mut msg).await?.is_empty() {
4700            continue;
4701        }
4702
4703        // Emit the event only after `create_send_msg_jobs`
4704        // because `create_send_msg_jobs` may change the message
4705        // encryption status and call `msg.update_param`.
4706        context.emit_event(EventType::MsgsChanged {
4707            chat_id: msg.chat_id,
4708            msg_id: msg.id,
4709        });
4710        // The event only matters if the message is last in the chat.
4711        // But it's probably too expensive check, and UIs anyways need to debounce.
4712        chatlist_events::emit_chatlist_item_changed(context, msg.chat_id);
4713
4714        if msg.viewtype == Viewtype::Webxdc {
4715            let conn_fn = |conn: &mut rusqlite::Connection| {
4716                let range = conn.query_row(
4717                    "SELECT IFNULL(min(id), 1), IFNULL(max(id), 0) \
4718                     FROM msgs_status_updates WHERE msg_id=?",
4719                    (msg.id,),
4720                    |row| {
4721                        let min_id: StatusUpdateSerial = row.get(0)?;
4722                        let max_id: StatusUpdateSerial = row.get(1)?;
4723                        Ok((min_id, max_id))
4724                    },
4725                )?;
4726                if range.0 > range.1 {
4727                    return Ok(());
4728                };
4729                // `first_serial` must be decreased, otherwise if `Context::flush_status_updates()`
4730                // runs in parallel, it would miss the race and instead of resending just remove the
4731                // updates thinking that they have been already sent.
4732                conn.execute(
4733                    "INSERT INTO smtp_status_updates (msg_id, first_serial, last_serial, descr) \
4734                     VALUES(?, ?, ?, '') \
4735                     ON CONFLICT(msg_id) \
4736                     DO UPDATE SET first_serial=min(first_serial - 1, excluded.first_serial)",
4737                    (msg.id, range.0, range.1),
4738                )?;
4739                Ok(())
4740            };
4741            context.sql.call_write(conn_fn).await?;
4742        }
4743        context.scheduler.interrupt_smtp().await;
4744    }
4745    Ok(())
4746}
4747
4748pub(crate) async fn get_chat_cnt(context: &Context) -> Result<usize> {
4749    if context.sql.is_open().await {
4750        // no database, no chats - this is no error (needed eg. for information)
4751        let count = context
4752            .sql
4753            .count("SELECT COUNT(*) FROM chats WHERE id>9 AND blocked=0;", ())
4754            .await?;
4755        Ok(count)
4756    } else {
4757        Ok(0)
4758    }
4759}
4760
4761/// Returns a tuple of `(chatid, blocked)`.
4762pub(crate) async fn get_chat_id_by_grpid(
4763    context: &Context,
4764    grpid: &str,
4765) -> Result<Option<(ChatId, Blocked)>> {
4766    context
4767        .sql
4768        .query_row_optional(
4769            "SELECT id, blocked FROM chats WHERE grpid=?;",
4770            (grpid,),
4771            |row| {
4772                let chat_id = row.get::<_, ChatId>(0)?;
4773
4774                let b = row.get::<_, Option<Blocked>>(1)?.unwrap_or_default();
4775                Ok((chat_id, b))
4776            },
4777        )
4778        .await
4779}
4780
4781/// Adds a message to device chat.
4782///
4783/// Optional `label` can be provided to ensure that message is added only once.
4784/// If `important` is true, a notification will be sent.
4785#[expect(clippy::arithmetic_side_effects)]
4786pub async fn add_device_msg_with_importance(
4787    context: &Context,
4788    label: Option<&str>,
4789    msg: Option<&mut Message>,
4790    important: bool,
4791) -> Result<MsgId> {
4792    ensure!(
4793        label.is_some() || msg.is_some(),
4794        "device-messages need label, msg or both"
4795    );
4796    let mut chat_id = ChatId::new(0);
4797    let mut msg_id = MsgId::new_unset();
4798
4799    if let Some(label) = label
4800        && was_device_msg_ever_added(context, label).await?
4801    {
4802        info!(context, "Device-message {label} already added.");
4803        return Ok(msg_id);
4804    }
4805
4806    if let Some(msg) = msg {
4807        chat_id = ChatId::get_for_contact(context, ContactId::DEVICE).await?;
4808
4809        let rfc724_mid = create_outgoing_rfc724_mid();
4810        let timestamp_sent = create_smeared_timestamp(context);
4811
4812        // makes sure, the added message is the last one,
4813        // even if the date is wrong (useful esp. when warning about bad dates)
4814        msg.timestamp_sort = timestamp_sent;
4815        if let Some(last_msg_time) = chat_id.get_timestamp(context).await?
4816            && msg.timestamp_sort <= last_msg_time
4817        {
4818            msg.timestamp_sort = last_msg_time + 1;
4819        }
4820        prepare_msg_blob(context, msg).await?;
4821        let state = MessageState::InFresh;
4822        let row_id = context
4823            .sql
4824            .insert(
4825                "INSERT INTO msgs (
4826            chat_id,
4827            from_id,
4828            to_id,
4829            timestamp,
4830            timestamp_sent,
4831            timestamp_rcvd,
4832            type,state,
4833            txt,
4834            txt_normalized,
4835            param,
4836            rfc724_mid)
4837            VALUES (?,?,?,?,?,?,?,?,?,?,?,?);",
4838                (
4839                    chat_id,
4840                    ContactId::DEVICE,
4841                    ContactId::SELF,
4842                    msg.timestamp_sort,
4843                    timestamp_sent,
4844                    timestamp_sent, // timestamp_sent equals timestamp_rcvd
4845                    msg.viewtype,
4846                    state,
4847                    &msg.text,
4848                    normalize_text(&msg.text),
4849                    msg.param.to_string(),
4850                    rfc724_mid,
4851                ),
4852            )
4853            .await?;
4854        context.new_msgs_notify.notify_one();
4855
4856        msg_id = MsgId::new(u32::try_from(row_id)?);
4857        if !msg.hidden {
4858            chat_id.unarchive_if_not_muted(context, state).await?;
4859        }
4860    }
4861
4862    if let Some(label) = label {
4863        context
4864            .sql
4865            .execute("INSERT INTO devmsglabels (label) VALUES (?);", (label,))
4866            .await?;
4867    }
4868
4869    if !msg_id.is_unset() {
4870        chat_id.emit_msg_event(context, msg_id, important);
4871    }
4872
4873    Ok(msg_id)
4874}
4875
4876/// Adds a message to device chat.
4877pub async fn add_device_msg(
4878    context: &Context,
4879    label: Option<&str>,
4880    msg: Option<&mut Message>,
4881) -> Result<MsgId> {
4882    add_device_msg_with_importance(context, label, msg, false).await
4883}
4884
4885/// Returns true if device message with a given label was ever added to the device chat.
4886pub async fn was_device_msg_ever_added(context: &Context, label: &str) -> Result<bool> {
4887    ensure!(!label.is_empty(), "empty label");
4888    let exists = context
4889        .sql
4890        .exists(
4891            "SELECT COUNT(label) FROM devmsglabels WHERE label=?",
4892            (label,),
4893        )
4894        .await?;
4895
4896    Ok(exists)
4897}
4898
4899// needed on device-switches during export/import;
4900// - deletion in `msgs` with `ContactId::DEVICE` makes sure,
4901//   no wrong information are shown in the device chat
4902// - deletion in `devmsglabels` makes sure,
4903//   deleted messages are reset and useful messages can be added again
4904pub(crate) async fn delete_and_reset_all_device_msgs(context: &Context) -> Result<()> {
4905    context
4906        .sql
4907        .execute("DELETE FROM msgs WHERE from_id=?;", (ContactId::DEVICE,))
4908        .await?;
4909    context.sql.execute("DELETE FROM devmsglabels;", ()).await?;
4910
4911    // Insert labels for welcome messages to avoid them being re-added on reconfiguration.
4912    context
4913        .sql
4914        .execute(
4915            r#"INSERT INTO devmsglabels (label) VALUES ("core-welcome-image"), ("core-welcome")"#,
4916            (),
4917        )
4918        .await?;
4919    Ok(())
4920}
4921
4922/// Adds an informational message to chat.
4923///
4924/// For example, it can be a message showing that a member was added to a group.
4925/// Doesn't fail if the chat doesn't exist.
4926#[expect(clippy::too_many_arguments)]
4927pub(crate) async fn add_info_msg_with_cmd(
4928    context: &Context,
4929    chat_id: ChatId,
4930    text: &str,
4931    cmd: SystemMessage,
4932    // Timestamp where in the chat the message will be sorted.
4933    // If this is None, the message will be sorted to the bottom.
4934    timestamp_sort: Option<i64>,
4935    // Timestamp to show to the user
4936    timestamp_sent_rcvd: i64,
4937    parent: Option<&Message>,
4938    from_id: Option<ContactId>,
4939    added_removed_id: Option<ContactId>,
4940) -> Result<MsgId> {
4941    let rfc724_mid = create_outgoing_rfc724_mid();
4942    let ephemeral_timer = chat_id.get_ephemeral_timer(context).await?;
4943
4944    let mut param = Params::new();
4945    if cmd != SystemMessage::Unknown {
4946        param.set_cmd(cmd);
4947    }
4948    if let Some(contact_id) = added_removed_id {
4949        param.set(Param::ContactAddedRemoved, contact_id.to_u32().to_string());
4950    }
4951
4952    let timestamp_sort = if let Some(ts) = timestamp_sort {
4953        ts
4954    } else {
4955        let sort_to_bottom = true;
4956        chat_id
4957            .calc_sort_timestamp(context, smeared_time(context), sort_to_bottom)
4958            .await?
4959    };
4960
4961    let row_id =
4962    context.sql.insert(
4963        "INSERT INTO msgs (chat_id,from_id,to_id,timestamp,timestamp_sent,timestamp_rcvd,type,state,txt,txt_normalized,rfc724_mid,ephemeral_timer,param,mime_in_reply_to)
4964        VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?);",
4965        (
4966            chat_id,
4967            from_id.unwrap_or(ContactId::INFO),
4968            ContactId::INFO,
4969            timestamp_sort,
4970            timestamp_sent_rcvd,
4971            timestamp_sent_rcvd,
4972            Viewtype::Text,
4973            MessageState::InNoticed,
4974            text,
4975            normalize_text(text),
4976            rfc724_mid,
4977            ephemeral_timer,
4978            param.to_string(),
4979            parent.map(|msg|msg.rfc724_mid.clone()).unwrap_or_default()
4980        )
4981    ).await?;
4982    context.new_msgs_notify.notify_one();
4983
4984    let msg_id = MsgId::new(row_id.try_into()?);
4985    context.emit_msgs_changed(chat_id, msg_id);
4986
4987    Ok(msg_id)
4988}
4989
4990/// Adds info message with a given text and `timestamp` to the chat.
4991pub(crate) async fn add_info_msg(context: &Context, chat_id: ChatId, text: &str) -> Result<MsgId> {
4992    add_info_msg_with_cmd(
4993        context,
4994        chat_id,
4995        text,
4996        SystemMessage::Unknown,
4997        None,
4998        time(),
4999        None,
5000        None,
5001        None,
5002    )
5003    .await
5004}
5005
5006pub(crate) async fn update_msg_text_and_timestamp(
5007    context: &Context,
5008    chat_id: ChatId,
5009    msg_id: MsgId,
5010    text: &str,
5011    timestamp: i64,
5012) -> Result<()> {
5013    context
5014        .sql
5015        .execute(
5016            "UPDATE msgs SET txt=?, txt_normalized=?, timestamp=? WHERE id=?;",
5017            (text, normalize_text(text), timestamp, msg_id),
5018        )
5019        .await?;
5020    context.emit_msgs_changed(chat_id, msg_id);
5021    Ok(())
5022}
5023
5024/// Set chat contacts by their addresses creating the corresponding contacts if necessary.
5025async fn set_contacts_by_addrs(context: &Context, id: ChatId, addrs: &[String]) -> Result<()> {
5026    let chat = Chat::load_from_db(context, id).await?;
5027    ensure!(
5028        !chat.is_encrypted(context).await?,
5029        "Cannot add address-contacts to encrypted chat {id}"
5030    );
5031    ensure!(
5032        chat.typ == Chattype::OutBroadcast,
5033        "{id} is not a broadcast list",
5034    );
5035    let mut contacts = BTreeSet::new();
5036    for addr in addrs {
5037        let contact_addr = ContactAddress::new(addr)?;
5038        let contact = Contact::add_or_lookup(context, "", &contact_addr, Origin::Hidden)
5039            .await?
5040            .0;
5041        contacts.insert(contact);
5042    }
5043    let contacts_old = BTreeSet::<ContactId>::from_iter(get_chat_contacts(context, id).await?);
5044    if contacts == contacts_old {
5045        return Ok(());
5046    }
5047    context
5048        .sql
5049        .transaction(move |transaction| {
5050            transaction.execute("DELETE FROM chats_contacts WHERE chat_id=?", (id,))?;
5051
5052            // We do not care about `add_timestamp` column
5053            // because timestamps are not used for broadcast channels.
5054            let mut statement = transaction
5055                .prepare("INSERT INTO chats_contacts (chat_id, contact_id) VALUES (?, ?)")?;
5056            for contact_id in &contacts {
5057                statement.execute((id, contact_id))?;
5058            }
5059            Ok(())
5060        })
5061        .await?;
5062    context.emit_event(EventType::ChatModified(id));
5063    Ok(())
5064}
5065
5066/// Set chat contacts by their fingerprints creating the corresponding contacts if necessary.
5067///
5068/// `fingerprint_addrs` is a list of pairs of fingerprint and address.
5069async fn set_contacts_by_fingerprints(
5070    context: &Context,
5071    id: ChatId,
5072    fingerprint_addrs: &[(String, String)],
5073) -> Result<()> {
5074    let chat = Chat::load_from_db(context, id).await?;
5075    ensure!(
5076        chat.is_encrypted(context).await?,
5077        "Cannot add key-contacts to unencrypted chat {id}"
5078    );
5079    ensure!(
5080        matches!(chat.typ, Chattype::Group | Chattype::OutBroadcast),
5081        "{id} is not a group or broadcast",
5082    );
5083    let mut contacts = BTreeSet::new();
5084    for (fingerprint, addr) in fingerprint_addrs {
5085        let contact = Contact::add_or_lookup_ex(context, "", addr, fingerprint, Origin::Hidden)
5086            .await?
5087            .0;
5088        contacts.insert(contact);
5089    }
5090    let contacts_old = BTreeSet::<ContactId>::from_iter(get_chat_contacts(context, id).await?);
5091    if contacts == contacts_old {
5092        return Ok(());
5093    }
5094    let broadcast_contacts_added = context
5095        .sql
5096        .transaction(move |transaction| {
5097            // For broadcast channels, we only add members,
5098            // because we don't use the membership consistency algorithm,
5099            // and are using sync messages as a basic way to ensure consistency between devices.
5100            // For groups, we also remove members,
5101            // because the sync message is used in order to sync unpromoted groups.
5102            if chat.typ != Chattype::OutBroadcast {
5103                transaction.execute("DELETE FROM chats_contacts WHERE chat_id=?", (id,))?;
5104            }
5105
5106            // We do not care about `add_timestamp` column
5107            // because timestamps are not used for broadcast channels.
5108            let mut statement = transaction.prepare(
5109                "INSERT OR IGNORE INTO chats_contacts (chat_id, contact_id) VALUES (?, ?)",
5110            )?;
5111            let mut broadcast_contacts_added = Vec::new();
5112            for contact_id in &contacts {
5113                if statement.execute((id, contact_id))? > 0 && chat.typ == Chattype::OutBroadcast {
5114                    broadcast_contacts_added.push(*contact_id);
5115                }
5116            }
5117            Ok(broadcast_contacts_added)
5118        })
5119        .await?;
5120    let timestamp = smeared_time(context);
5121    for added_id in broadcast_contacts_added {
5122        let msg = stock_str::msg_add_member_local(context, added_id, ContactId::UNDEFINED).await;
5123        add_info_msg_with_cmd(
5124            context,
5125            id,
5126            &msg,
5127            SystemMessage::MemberAddedToGroup,
5128            Some(timestamp),
5129            timestamp,
5130            None,
5131            Some(ContactId::SELF),
5132            Some(added_id),
5133        )
5134        .await?;
5135    }
5136    context.emit_event(EventType::ChatModified(id));
5137    Ok(())
5138}
5139
5140/// A cross-device chat id used for synchronisation.
5141#[derive(Debug, Serialize, Deserialize, PartialEq)]
5142pub(crate) enum SyncId {
5143    /// E-mail address of the contact.
5144    ContactAddr(String),
5145
5146    /// OpenPGP key fingerprint of the contact.
5147    ContactFingerprint(String),
5148
5149    Grpid(String),
5150    /// "Message-ID"-s, from oldest to latest. Used for ad-hoc groups.
5151    Msgids(Vec<String>),
5152
5153    /// Special id for device chat.
5154    Device,
5155}
5156
5157/// An action synchronised to other devices.
5158#[derive(Debug, Serialize, Deserialize, PartialEq)]
5159pub(crate) enum SyncAction {
5160    Block,
5161    Unblock,
5162    Accept,
5163    SetVisibility(ChatVisibility),
5164    SetMuted(MuteDuration),
5165    /// Create broadcast channel with the given name.
5166    CreateOutBroadcast {
5167        chat_name: String,
5168        secret: String,
5169    },
5170    /// Create encrypted group chat with the given name.
5171    CreateGroupEncrypted(String),
5172    Rename(String),
5173    /// Set chat contacts by their addresses.
5174    SetContacts(Vec<String>),
5175    /// Set chat contacts by their fingerprints.
5176    ///
5177    /// The list is a list of pairs of fingerprint and address.
5178    SetPgpContacts(Vec<(String, String)>),
5179    SetDescription(String),
5180    Delete,
5181}
5182
5183impl Context {
5184    /// Executes [`SyncData::AlterChat`] item sent by other device.
5185    pub(crate) async fn sync_alter_chat(&self, id: &SyncId, action: &SyncAction) -> Result<()> {
5186        let chat_id = match id {
5187            SyncId::ContactAddr(addr) => {
5188                if let SyncAction::Rename(to) = action {
5189                    Contact::create_ex(self, Nosync, to, addr).await?;
5190                    return Ok(());
5191                }
5192                let addr = ContactAddress::new(addr).context("Invalid address")?;
5193                let (contact_id, _) =
5194                    Contact::add_or_lookup(self, "", &addr, Origin::Hidden).await?;
5195                match action {
5196                    SyncAction::Block => {
5197                        return contact::set_blocked(self, Nosync, contact_id, true).await;
5198                    }
5199                    SyncAction::Unblock => {
5200                        return contact::set_blocked(self, Nosync, contact_id, false).await;
5201                    }
5202                    _ => (),
5203                }
5204                // Use `Request` so that even if the program crashes, the user doesn't have to look
5205                // into the blocked contacts.
5206                ChatIdBlocked::get_for_contact(self, contact_id, Blocked::Request)
5207                    .await?
5208                    .id
5209            }
5210            SyncId::ContactFingerprint(fingerprint) => {
5211                let name = "";
5212                let addr = "";
5213                let (contact_id, _) =
5214                    Contact::add_or_lookup_ex(self, name, addr, fingerprint, Origin::Hidden)
5215                        .await?;
5216                match action {
5217                    SyncAction::Rename(to) => {
5218                        contact_id.set_name_ex(self, Nosync, to).await?;
5219                        self.emit_event(EventType::ContactsChanged(Some(contact_id)));
5220                        return Ok(());
5221                    }
5222                    SyncAction::Block => {
5223                        return contact::set_blocked(self, Nosync, contact_id, true).await;
5224                    }
5225                    SyncAction::Unblock => {
5226                        return contact::set_blocked(self, Nosync, contact_id, false).await;
5227                    }
5228                    _ => (),
5229                }
5230                ChatIdBlocked::get_for_contact(self, contact_id, Blocked::Request)
5231                    .await?
5232                    .id
5233            }
5234            SyncId::Grpid(grpid) => {
5235                match action {
5236                    SyncAction::CreateOutBroadcast { chat_name, secret } => {
5237                        create_out_broadcast_ex(
5238                            self,
5239                            Nosync,
5240                            grpid.to_string(),
5241                            chat_name.clone(),
5242                            secret.to_string(),
5243                        )
5244                        .await?;
5245                        return Ok(());
5246                    }
5247                    SyncAction::CreateGroupEncrypted(name) => {
5248                        create_group_ex(self, Nosync, grpid.clone(), name).await?;
5249                        return Ok(());
5250                    }
5251                    _ => {}
5252                }
5253                get_chat_id_by_grpid(self, grpid)
5254                    .await?
5255                    .with_context(|| format!("No chat for grpid '{grpid}'"))?
5256                    .0
5257            }
5258            SyncId::Msgids(msgids) => {
5259                let msg = message::get_by_rfc724_mids(self, msgids)
5260                    .await?
5261                    .with_context(|| format!("No message found for Message-IDs {msgids:?}"))?;
5262                ChatId::lookup_by_message(&msg)
5263                    .with_context(|| format!("No chat found for Message-IDs {msgids:?}"))?
5264            }
5265            SyncId::Device => ChatId::get_for_contact(self, ContactId::DEVICE).await?,
5266        };
5267        match action {
5268            SyncAction::Block => chat_id.block_ex(self, Nosync).await,
5269            SyncAction::Unblock => chat_id.unblock_ex(self, Nosync).await,
5270            SyncAction::Accept => chat_id.accept_ex(self, Nosync).await,
5271            SyncAction::SetVisibility(v) => chat_id.set_visibility_ex(self, Nosync, *v).await,
5272            SyncAction::SetMuted(duration) => set_muted_ex(self, Nosync, chat_id, *duration).await,
5273            SyncAction::CreateOutBroadcast { .. } | SyncAction::CreateGroupEncrypted(..) => {
5274                // Create action should have been handled above already.
5275                Err(anyhow!("sync_alter_chat({id:?}, {action:?}): Bad request."))
5276            }
5277            SyncAction::Rename(to) => rename_ex(self, Nosync, chat_id, to).await,
5278            SyncAction::SetDescription(to) => {
5279                set_chat_description_ex(self, Nosync, chat_id, to).await
5280            }
5281            SyncAction::SetContacts(addrs) => set_contacts_by_addrs(self, chat_id, addrs).await,
5282            SyncAction::SetPgpContacts(fingerprint_addrs) => {
5283                set_contacts_by_fingerprints(self, chat_id, fingerprint_addrs).await
5284            }
5285            SyncAction::Delete => chat_id.delete_ex(self, Nosync).await,
5286        }
5287    }
5288
5289    /// Emits the appropriate `MsgsChanged` event. Should be called if the number of unnoticed
5290    /// archived chats could decrease. In general we don't want to make an extra db query to know if
5291    /// a noticed chat is archived. Emitting events should be cheap, a false-positive `MsgsChanged`
5292    /// is ok.
5293    pub(crate) fn on_archived_chats_maybe_noticed(&self) {
5294        self.emit_msgs_changed_without_msg_id(DC_CHAT_ID_ARCHIVED_LINK);
5295    }
5296}
5297
5298#[cfg(test)]
5299mod chat_tests;