deltachat/param.rs
1use std::collections::BTreeMap;
2use std::fmt;
3use std::path::PathBuf;
4use std::str;
5
6use anyhow::ensure;
7use anyhow::{bail, Error, Result};
8use num_traits::FromPrimitive;
9use serde::{Deserialize, Serialize};
10
11use crate::blob::BlobObject;
12use crate::context::Context;
13use crate::mimeparser::SystemMessage;
14
15/// Available param keys.
16#[derive(
17 PartialEq, Eq, Debug, Clone, Copy, Hash, PartialOrd, Ord, FromPrimitive, Serialize, Deserialize,
18)]
19#[repr(u8)]
20pub enum Param {
21 /// For messages
22 File = b'f',
23
24 /// For messages: original filename (as shown in chat)
25 Filename = b'v',
26
27 /// For messages: This name should be shown instead of contact.get_display_name()
28 /// (used if this is a mailinglist
29 /// or explicitly set using set_override_sender_name(), eg. by bots)
30 OverrideSenderDisplayname = b'O',
31
32 /// For Messages
33 Width = b'w',
34
35 /// For Messages
36 Height = b'h',
37
38 /// For Messages
39 Duration = b'd',
40
41 /// For Messages
42 MimeType = b'm',
43
44 /// For Messages: HTML to be written to the database and to be send.
45 /// `SendHtml` param is not used for received messages.
46 /// Use `MsgId::get_html()` to get HTML of received messages.
47 SendHtml = b'T',
48
49 /// For Messages: message is encrypted, outgoing: guarantee E2EE or the message is not send
50 GuaranteeE2ee = b'c',
51
52 /// For Messages: quoted message is encrypted.
53 ///
54 /// If this message is sent unencrypted, quote text should be replaced.
55 ProtectQuote = b'0',
56
57 /// For Messages: decrypted with validation errors or without mutual set, if neither
58 /// 'c' nor 'e' are preset, the messages is only transport encrypted.
59 ///
60 /// Deprecated on 2024-12-25.
61 ErroneousE2ee = b'e',
62
63 /// For Messages: force unencrypted message, a value from `ForcePlaintext` enum.
64 ForcePlaintext = b'u',
65
66 /// For Messages: do not include Autocrypt header.
67 SkipAutocrypt = b'o',
68
69 /// For Messages
70 WantsMdn = b'r',
71
72 /// For Messages: the message is a reaction.
73 Reaction = b'x',
74
75 /// For Chats: the timestamp of the last reaction.
76 LastReactionTimestamp = b'y',
77
78 /// For Chats: Message ID of the last reaction.
79 LastReactionMsgId = b'Y',
80
81 /// For Chats: Contact ID of the last reaction.
82 LastReactionContactId = b'1',
83
84 /// For Messages: a message with "Auto-Submitted: auto-generated" header ("bot").
85 Bot = b'b',
86
87 /// For Messages: unset or 0=not forwarded,
88 /// 1=forwarded from unknown msg_id, >9 forwarded from msg_id
89 Forwarded = b'a',
90
91 /// For Messages: quoted text.
92 Quote = b'q',
93
94 /// For Messages: the 1st part of summary text (i.e. before the dash if any).
95 Summary1 = b'4',
96
97 /// For Messages
98 Cmd = b'S',
99
100 /// For Messages
101 ///
102 /// For "MemberRemovedFromGroup" this is the email address
103 /// removed from the group.
104 ///
105 /// For "MemberAddedToGroup" this is the email address added to the group.
106 Arg = b'E',
107
108 /// For Messages
109 Arg2 = b'F',
110
111 /// `Secure-Join-Fingerprint` header for `{vc,vg}-request-with-auth` messages.
112 Arg3 = b'G',
113
114 /// Deprecated `Secure-Join-Group` header for messages.
115 Arg4 = b'H',
116
117 /// For Messages
118 AttachGroupImage = b'A',
119
120 /// For Messages
121 WebrtcRoom = b'V',
122
123 /// For Messages: space-separated list of messaged IDs of forwarded copies.
124 ///
125 /// This is used when a [crate::message::Message] is in the
126 /// [crate::message::MessageState::OutPending] state but is already forwarded.
127 /// In this case the forwarded messages are written to the
128 /// database and their message IDs are added to this parameter of
129 /// the original message, which is also saved in the database.
130 /// When the original message is then finally sent this parameter
131 /// is used to also send all the forwarded messages.
132 PrepForwards = b'P',
133
134 /// For Messages
135 SetLatitude = b'l',
136
137 /// For Messages
138 SetLongitude = b'n',
139
140 /// For Groups
141 ///
142 /// An unpromoted group has not had any messages sent to it and thus only exists on the
143 /// creator's device. Any changes made to an unpromoted group do not need to send
144 /// system messages to the group members to update them of the changes. Once a message
145 /// has been sent to a group it is promoted and group changes require sending system
146 /// messages to all members.
147 Unpromoted = b'U',
148
149 /// For Groups and Contacts
150 ProfileImage = b'i',
151
152 /// For Chats
153 /// Signals whether the chat is the `saved messages` chat
154 Selftalk = b'K',
155
156 /// For Chats: On sending a new message we set the subject to `Re: <last subject>`.
157 /// Usually we just use the subject of the parent message, but if the parent message
158 /// is deleted, we use the LastSubject of the chat.
159 LastSubject = b't',
160
161 /// For Chats
162 Devicetalk = b'D',
163
164 /// For Chats: If this is a mailing list chat, contains the List-Post address.
165 /// None if there simply is no `List-Post` header in the mailing list.
166 /// Some("") if the mailing list is using multiple different List-Post headers.
167 ///
168 /// The List-Post address is the email address where the user can write to in order to
169 /// post something to the mailing list.
170 ListPost = b'p',
171
172 /// For Contacts: If this is the List-Post address of a mailing list, contains
173 /// the List-Id of the mailing list (which is also used as the group id of the chat).
174 ListId = b's',
175
176 /// For Contacts: timestamp of status (aka signature or footer) update.
177 StatusTimestamp = b'j',
178
179 /// For Contacts and Chats: timestamp of avatar update.
180 AvatarTimestamp = b'J',
181
182 /// For Chats: timestamp of status/signature/footer update.
183 EphemeralSettingsTimestamp = b'B',
184
185 /// For Chats: timestamp of subject update.
186 SubjectTimestamp = b'C',
187
188 /// For Chats: timestamp of group name update.
189 GroupNameTimestamp = b'g',
190
191 /// For Chats: timestamp of member list update.
192 MemberListTimestamp = b'k',
193
194 /// For Webxdc Message Instances: Current document name
195 WebxdcDocument = b'R',
196
197 /// For Webxdc Message Instances: timestamp of document name update.
198 WebxdcDocumentTimestamp = b'W',
199
200 /// For Webxdc Message Instances: Current summary
201 WebxdcSummary = b'N',
202
203 /// For Webxdc Message Instances: timestamp of summary update.
204 WebxdcSummaryTimestamp = b'Q',
205
206 /// For Webxdc Message Instances: Webxdc is an integration, see init_webxdc_integration()
207 WebxdcIntegration = b'3',
208
209 /// For Webxdc Message Instances: Chat to integrate the Webxdc for.
210 WebxdcIntegrateFor = b'2',
211
212 /// For messages: Whether [crate::message::Viewtype::Sticker] should be forced.
213 ForceSticker = b'X',
214
215 /// For messages: Message is a deletion request. The value is a list of rfc724_mid of the messages to delete.
216 DeleteRequestFor = b'M',
217
218 /// For messages: Message is a text edit message. the value of this parameter is the rfc724_mid of the original message.
219 TextEditFor = b'I',
220
221 /// For messages: Message text was edited.
222 IsEdited = b'L',
223
224 /// For info messages: Contact ID in added or removed to a group.
225 ContactAddedRemoved = b'5',
226}
227
228/// An object for handling key=value parameter lists.
229///
230/// The structure is serialized by calling `to_string()` on it.
231///
232/// Only for library-internal use.
233#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
234pub struct Params {
235 inner: BTreeMap<Param, String>,
236}
237
238impl fmt::Display for Params {
239 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
240 for (i, (key, value)) in self.inner.iter().enumerate() {
241 if i > 0 {
242 writeln!(f)?;
243 }
244 write!(
245 f,
246 "{}={}",
247 *key as u8 as char,
248 value.split('\n').collect::<Vec<&str>>().join("\n\n")
249 )?;
250 }
251 Ok(())
252 }
253}
254
255impl str::FromStr for Params {
256 type Err = Error;
257
258 /// Parse a raw string to Param.
259 ///
260 /// Silently ignore unknown keys:
261 /// they may come from a downgrade (when a shortly new version adds a key)
262 /// or from an upgrade (when a key is dropped but was used in the past)
263 fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
264 let mut inner = BTreeMap::new();
265 let mut lines = s.lines().peekable();
266
267 while let Some(line) = lines.next() {
268 if let [key, value] = line.splitn(2, '=').collect::<Vec<_>>()[..] {
269 let key = key.to_string();
270 let mut value = value.to_string();
271 while let Some(s) = lines.peek() {
272 if !s.is_empty() {
273 break;
274 }
275 lines.next();
276 value.push('\n');
277 value += lines.next().unwrap_or_default();
278 }
279
280 if let Some(key) = key.as_bytes().first().and_then(|key| Param::from_u8(*key)) {
281 inner.insert(key, value);
282 }
283 } else {
284 bail!("Not a key-value pair: {:?}", line);
285 }
286 }
287
288 Ok(Params { inner })
289 }
290}
291
292impl Params {
293 /// Create new empty params.
294 pub fn new() -> Self {
295 Default::default()
296 }
297
298 /// Get the value of the given key, return `None` if no value is set.
299 pub fn get(&self, key: Param) -> Option<&str> {
300 self.inner.get(&key).map(|s| s.as_str())
301 }
302
303 /// Check if the given key is set.
304 pub fn exists(&self, key: Param) -> bool {
305 self.inner.contains_key(&key)
306 }
307
308 /// Set the given key to the passed in value.
309 pub fn set(&mut self, key: Param, value: impl ToString) -> &mut Self {
310 if key == Param::File {
311 debug_assert!(value.to_string().starts_with("$BLOBDIR/"));
312 }
313 self.inner.insert(key, value.to_string());
314 self
315 }
316
317 /// Removes the given key, if it exists.
318 pub fn remove(&mut self, key: Param) -> &mut Self {
319 self.inner.remove(&key);
320 self
321 }
322
323 /// Sets the given key from an optional value.
324 /// Removes the key if the value is `None`.
325 pub fn set_optional(&mut self, key: Param, value: Option<impl ToString>) -> &mut Self {
326 if let Some(value) = value {
327 self.set(key, value)
328 } else {
329 self.remove(key)
330 }
331 }
332
333 /// Check if there are any values in this.
334 pub fn is_empty(&self) -> bool {
335 self.inner.is_empty()
336 }
337
338 /// Returns how many key-value pairs are set.
339 pub fn len(&self) -> usize {
340 self.inner.len()
341 }
342
343 /// Get the given parameter and parse as `i32`.
344 pub fn get_int(&self, key: Param) -> Option<i32> {
345 self.get(key).and_then(|s| s.parse().ok())
346 }
347
348 /// Get the given parameter and parse as `i64`.
349 pub fn get_i64(&self, key: Param) -> Option<i64> {
350 self.get(key).and_then(|s| s.parse().ok())
351 }
352
353 /// Get the given parameter and parse as `bool`.
354 pub fn get_bool(&self, key: Param) -> Option<bool> {
355 self.get_int(key).map(|v| v != 0)
356 }
357
358 /// Get the parameter behind `Param::Cmd` interpreted as `SystemMessage`.
359 pub fn get_cmd(&self) -> SystemMessage {
360 self.get_int(Param::Cmd)
361 .and_then(SystemMessage::from_i32)
362 .unwrap_or_default()
363 }
364
365 /// Set the parameter behind `Param::Cmd`.
366 pub fn set_cmd(&mut self, value: SystemMessage) {
367 self.set_int(Param::Cmd, value as i32);
368 }
369
370 /// Get the given parameter and parse as `f64`.
371 pub fn get_float(&self, key: Param) -> Option<f64> {
372 self.get(key).and_then(|s| s.parse().ok())
373 }
374
375 /// Returns a [BlobObject] for the [Param::File] parameter.
376 pub fn get_file_blob<'a>(&self, context: &'a Context) -> Result<Option<BlobObject<'a>>> {
377 let Some(val) = self.get(Param::File) else {
378 return Ok(None);
379 };
380 ensure!(val.starts_with("$BLOBDIR/"));
381 let blob = BlobObject::from_name(context, val)?;
382 Ok(Some(blob))
383 }
384
385 /// Returns a [PathBuf] for the [Param::File] parameter.
386 pub fn get_file_path(&self, context: &Context) -> Result<Option<PathBuf>> {
387 let blob = self.get_file_blob(context)?;
388 Ok(blob.map(|p| p.to_abs_path()))
389 }
390
391 /// Set the given parameter to the passed in `i32`.
392 pub fn set_int(&mut self, key: Param, value: i32) -> &mut Self {
393 self.set(key, format!("{value}"));
394 self
395 }
396
397 /// Set the given parameter to the passed in `i64`.
398 pub fn set_i64(&mut self, key: Param, value: i64) -> &mut Self {
399 self.set(key, value.to_string());
400 self
401 }
402
403 /// Set the given parameter to the passed in `f64` .
404 pub fn set_float(&mut self, key: Param, value: f64) -> &mut Self {
405 self.set(key, format!("{value}"));
406 self
407 }
408}
409
410#[cfg(test)]
411mod tests {
412 use std::str::FromStr;
413
414 use super::*;
415
416 #[test]
417 fn test_dc_param() {
418 let mut p1: Params = "a=1\nw=2\nc=3".parse().unwrap();
419
420 assert_eq!(p1.get_int(Param::Forwarded), Some(1));
421 assert_eq!(p1.get_int(Param::Width), Some(2));
422 assert_eq!(p1.get_int(Param::Height), None);
423 assert!(!p1.exists(Param::Height));
424
425 p1.set_int(Param::Duration, 4);
426
427 assert_eq!(p1.get_int(Param::Duration), Some(4));
428
429 let mut p1 = Params::new();
430
431 p1.set(Param::Forwarded, "foo")
432 .set_int(Param::Width, 2)
433 .remove(Param::GuaranteeE2ee)
434 .set_int(Param::Duration, 4);
435
436 assert_eq!(p1.to_string(), "a=foo\nd=4\nw=2");
437
438 p1.remove(Param::Width);
439
440 assert_eq!(p1.to_string(), "a=foo\nd=4",);
441 assert_eq!(p1.len(), 2);
442
443 p1.remove(Param::Forwarded);
444 p1.remove(Param::Duration);
445
446 assert_eq!(p1.to_string(), "",);
447
448 assert!(p1.is_empty());
449 assert_eq!(p1.len(), 0)
450 }
451
452 #[test]
453 fn test_roundtrip() {
454 let mut params = Params::new();
455 params.set(Param::Height, "foo\nbar=baz\nquux");
456 params.set(Param::Width, "\n\n\na=\n=");
457 assert_eq!(params.to_string().parse::<Params>().unwrap(), params);
458 }
459
460 #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
461 async fn test_params_unknown_key() -> Result<()> {
462 // 'Z' is used as a key that is known to be unused; these keys should be ignored silently by definition.
463 let p = Params::from_str("w=12\nZ=13\nh=14")?;
464 assert_eq!(p.len(), 2);
465 assert_eq!(p.get(Param::Width), Some("12"));
466 assert_eq!(p.get(Param::Height), Some("14"));
467 Ok(())
468 }
469}