deltachat/
constants.rs

1//! # Constants.
2
3#![allow(missing_docs)]
4
5use std::sync::LazyLock;
6
7use deltachat_derive::{FromSql, ToSql};
8use percent_encoding::{AsciiSet, NON_ALPHANUMERIC};
9use serde::{Deserialize, Serialize};
10
11use crate::chat::ChatId;
12
13pub static DC_VERSION_STR: LazyLock<String> =
14    LazyLock::new(|| env!("CARGO_PKG_VERSION").to_string());
15
16/// Set of characters to percent-encode in email addresses and names.
17pub(crate) const NON_ALPHANUMERIC_WITHOUT_DOT: &AsciiSet = &NON_ALPHANUMERIC.remove(b'.');
18
19#[derive(
20    Debug,
21    Default,
22    Display,
23    Clone,
24    Copy,
25    PartialEq,
26    Eq,
27    FromPrimitive,
28    ToPrimitive,
29    FromSql,
30    ToSql,
31    Serialize,
32    Deserialize,
33)]
34#[repr(i8)]
35pub enum Blocked {
36    #[default]
37    Not = 0,
38    Yes = 1,
39    Request = 2,
40}
41
42#[derive(
43    Debug, Default, Display, Clone, Copy, PartialEq, Eq, FromPrimitive, ToPrimitive, FromSql, ToSql,
44)]
45#[repr(u8)]
46pub enum ShowEmails {
47    Off = 0,
48    AcceptedContacts = 1,
49    #[default] // also change Config.ShowEmails props(default) on changes
50    All = 2,
51}
52
53#[derive(
54    Debug, Default, Display, Clone, Copy, PartialEq, Eq, FromPrimitive, ToPrimitive, FromSql, ToSql,
55)]
56#[repr(u8)]
57pub enum MediaQuality {
58    #[default] // also change Config.MediaQuality props(default) on changes
59    Balanced = 0,
60    Worse = 1,
61}
62
63/// Video chat URL type.
64#[derive(
65    Debug, Default, Display, Clone, Copy, PartialEq, Eq, FromPrimitive, ToPrimitive, FromSql, ToSql,
66)]
67#[repr(i8)]
68pub enum VideochatType {
69    /// Unknown type.
70    #[default]
71    Unknown = 0,
72
73    /// [basicWebRTC](https://github.com/cracker0dks/basicwebrtc) instance.
74    BasicWebrtc = 1,
75
76    /// [Jitsi Meet](https://jitsi.org/jitsi-meet/) instance.
77    Jitsi = 2,
78}
79
80pub const DC_HANDSHAKE_CONTINUE_NORMAL_PROCESSING: i32 = 0x01;
81pub const DC_HANDSHAKE_STOP_NORMAL_PROCESSING: i32 = 0x02;
82pub const DC_HANDSHAKE_ADD_DELETE_JOB: i32 = 0x04;
83
84pub(crate) const DC_FROM_HANDSHAKE: i32 = 0x01;
85
86pub const DC_GCL_ARCHIVED_ONLY: usize = 0x01;
87pub const DC_GCL_NO_SPECIALS: usize = 0x02;
88pub const DC_GCL_ADD_ALLDONE_HINT: usize = 0x04;
89pub const DC_GCL_FOR_FORWARDING: usize = 0x08;
90
91pub const DC_GCL_ADD_SELF: u32 = 0x02;
92
93// unchanged user avatars are resent to the recipients every some days
94pub(crate) const DC_RESEND_USER_AVATAR_DAYS: i64 = 14;
95
96// warn about an outdated app after a given number of days.
97// as we use the "provider-db generation date" as reference (that might not be updated very often)
98// and as not all system get speedy updates,
99// do not use too small value that will annoy users checking for nonexistent updates.
100pub(crate) const DC_OUTDATED_WARNING_DAYS: i64 = 365;
101
102/// messages that should be deleted get this chat_id; the messages are deleted from the working thread later then. This is also needed as rfc724_mid should be preset as long as the message is not deleted on the server (otherwise it is downloaded again)
103pub const DC_CHAT_ID_TRASH: ChatId = ChatId::new(3);
104/// only an indicator in a chatlist
105pub const DC_CHAT_ID_ARCHIVED_LINK: ChatId = ChatId::new(6);
106/// only an indicator in a chatlist
107pub const DC_CHAT_ID_ALLDONE_HINT: ChatId = ChatId::new(7);
108/// larger chat IDs are "real" chats, their messages are "real" messages.
109pub const DC_CHAT_ID_LAST_SPECIAL: ChatId = ChatId::new(9);
110
111/// Chat type.
112#[derive(
113    Debug,
114    Display,
115    Clone,
116    Copy,
117    PartialEq,
118    Eq,
119    FromPrimitive,
120    ToPrimitive,
121    FromSql,
122    ToSql,
123    IntoStaticStr,
124    Serialize,
125    Deserialize,
126)]
127#[repr(u32)]
128pub enum Chattype {
129    /// 1:1 chat.
130    Single = 100,
131
132    /// Group chat.
133    Group = 120,
134
135    /// Mailing list.
136    Mailinglist = 140,
137
138    /// Broadcast list.
139    Broadcast = 160,
140}
141
142pub const DC_MSG_ID_DAYMARKER: u32 = 9;
143pub const DC_MSG_ID_LAST_SPECIAL: u32 = 9;
144
145/// String that indicates that something is left out or truncated.
146pub(crate) const DC_ELLIPSIS: &str = "[...]";
147// how many lines desktop can display when fullscreen (fullscreen at zoomlevel 1x)
148// (taken from "subjective" testing what looks ok)
149pub const DC_DESIRED_TEXT_LINES: usize = 38;
150// how many chars desktop can display per line (from "subjective" testing)
151pub const DC_DESIRED_TEXT_LINE_LEN: usize = 100;
152
153/// Message length limit.
154///
155/// To keep bubbles and chat flow usable and to avoid problems with controls using very long texts,
156/// we limit the text length to `DC_DESIRED_TEXT_LEN`.  If the text is longer, the full text can be
157/// retrieved using has_html()/get_html().
158///
159/// Note that for simplicity maximum length is defined as the number of Unicode Scalar Values (Rust
160/// `char`s), not Unicode Grapheme Clusters.
161pub const DC_DESIRED_TEXT_LEN: usize = DC_DESIRED_TEXT_LINE_LEN * DC_DESIRED_TEXT_LINES;
162
163// Flags for configuring IMAP and SMTP servers.
164// These flags are optional
165// and may be set together with the username, password etc.
166// via dc_set_config() using the key "server_flags".
167
168/// Force OAuth2 authorization.
169///
170/// This flag does not skip automatic configuration.
171/// Before calling configure() with DC_LP_AUTH_OAUTH2 set,
172/// the user has to confirm access at the URL returned by dc_get_oauth2_url().
173pub const DC_LP_AUTH_OAUTH2: i32 = 0x2;
174
175/// Force NORMAL authorization, this is the default.
176/// If this flag is set, automatic configuration is skipped.
177pub const DC_LP_AUTH_NORMAL: i32 = 0x4;
178
179/// if none of these flags are set, the default is chosen
180pub const DC_LP_AUTH_FLAGS: i32 = DC_LP_AUTH_OAUTH2 | DC_LP_AUTH_NORMAL;
181
182// max. weight of images to send w/o recoding
183pub const BALANCED_IMAGE_BYTES: usize = 500_000;
184pub const WORSE_IMAGE_BYTES: usize = 130_000;
185
186// max. width/height and bytes of an avatar
187pub(crate) const BALANCED_AVATAR_SIZE: u32 = 512;
188pub(crate) const BALANCED_AVATAR_BYTES: usize = 60_000;
189pub(crate) const WORSE_AVATAR_SIZE: u32 = 128;
190pub(crate) const WORSE_AVATAR_BYTES: usize = 20_000; // this also fits to Outlook servers don't allowing headers larger than 32k.
191
192// max. width/height of images scaled down because of being too huge
193pub const BALANCED_IMAGE_SIZE: u32 = 1280;
194pub const WORSE_IMAGE_SIZE: u32 = 640;
195
196// Key for the folder configuration version (see below).
197pub(crate) const DC_FOLDERS_CONFIGURED_KEY: &str = "folders_configured";
198// this value can be increased if the folder configuration is changed and must be redone on next program start
199pub(crate) const DC_FOLDERS_CONFIGURED_VERSION: i32 = 5;
200
201// If more recipients are needed in SMTP's `RCPT TO:` header, the recipient list is split into
202// chunks. This does not affect MIME's `To:` header. Can be overwritten by setting
203// `max_smtp_rcpt_to` in the provider db.
204pub(crate) const DEFAULT_MAX_SMTP_RCPT_TO: usize = 50;
205
206/// How far the last quota check needs to be in the past to be checked by the background function (in seconds).
207pub(crate) const DC_BACKGROUND_FETCH_QUOTA_CHECK_RATELIMIT: u64 = 12 * 60 * 60; // 12 hours
208
209/// How far in the future the sender timestamp of a message is allowed to be, in seconds. Also used
210/// in the group membership consistency algo to reject outdated membership changes.
211pub(crate) const TIMESTAMP_SENT_TOLERANCE: i64 = 60;
212
213// To make text edits clearer for Non-Delta-MUA or old Delta Chats, edited text will be prefixed by EDITED_PREFIX.
214// Newer Delta Chats will remove the prefix as needed.
215pub(crate) const EDITED_PREFIX: &str = "✏️";
216
217// Strings needed to render the Autocrypt Setup Message.
218// Left untranslated as not being supported/recommended workflow and as translations would require deep knowledge.
219pub(crate) const ASM_SUBJECT: &str = "Autocrypt Setup Message";
220pub(crate) const ASM_BODY: &str = "This is the Autocrypt Setup Message \
221    used to transfer your end-to-end setup between clients.
222
223    To decrypt and use your setup, \
224    open the message in an Autocrypt-compliant client \
225    and enter the setup code presented on the generating device.
226
227    If you see this message in a chatmail client (Delta Chat, Arcane Chat, Delta Touch ...), \
228    use \"Settings / Add Second Device\" instead.";
229
230#[cfg(test)]
231mod tests {
232    use num_traits::FromPrimitive;
233
234    use super::*;
235
236    #[test]
237    fn test_chattype_values() {
238        // values may be written to disk and must not change
239        assert_eq!(Chattype::Single, Chattype::from_i32(100).unwrap());
240        assert_eq!(Chattype::Group, Chattype::from_i32(120).unwrap());
241        assert_eq!(Chattype::Mailinglist, Chattype::from_i32(140).unwrap());
242        assert_eq!(Chattype::Broadcast, Chattype::from_i32(160).unwrap());
243    }
244
245    #[test]
246    fn test_showemails_values() {
247        // values may be written to disk and must not change
248        assert_eq!(ShowEmails::All, ShowEmails::default());
249        assert_eq!(ShowEmails::Off, ShowEmails::from_i32(0).unwrap());
250        assert_eq!(
251            ShowEmails::AcceptedContacts,
252            ShowEmails::from_i32(1).unwrap()
253        );
254        assert_eq!(ShowEmails::All, ShowEmails::from_i32(2).unwrap());
255    }
256
257    #[test]
258    fn test_blocked_values() {
259        // values may be written to disk and must not change
260        assert_eq!(Blocked::Not, Blocked::default());
261        assert_eq!(Blocked::Not, Blocked::from_i32(0).unwrap());
262        assert_eq!(Blocked::Yes, Blocked::from_i32(1).unwrap());
263        assert_eq!(Blocked::Request, Blocked::from_i32(2).unwrap());
264    }
265
266    #[test]
267    fn test_mediaquality_values() {
268        // values may be written to disk and must not change
269        assert_eq!(MediaQuality::Balanced, MediaQuality::default());
270        assert_eq!(MediaQuality::Balanced, MediaQuality::from_i32(0).unwrap());
271        assert_eq!(MediaQuality::Worse, MediaQuality::from_i32(1).unwrap());
272    }
273
274    #[test]
275    fn test_videochattype_values() {
276        // values may be written to disk and must not change
277        assert_eq!(VideochatType::Unknown, VideochatType::default());
278        assert_eq!(VideochatType::Unknown, VideochatType::from_i32(0).unwrap());
279        assert_eq!(
280            VideochatType::BasicWebrtc,
281            VideochatType::from_i32(1).unwrap()
282        );
283        assert_eq!(VideochatType::Jitsi, VideochatType::from_i32(2).unwrap());
284    }
285}
deltachat/constants.rs

deltachat/
constants.rs
