Add metadata key preference to configuration

Author: 4e554c4c

data/src/capabilities.rs

@@ -77,6 +77,69 @@ pub struct MultilineLimits {
     pub max_lines: Option<usize>,
 }
 
+#[derive(Debug, Clone, thiserror::Error)]
+pub enum CapParseError {
+    #[error(transparent)]
+    ParseInt(#[from] std::num::ParseIntError),
+    #[error("Missing key `{0}` in dictionary: {1}")]
+    MissingKey(String, String),
+}
+
+impl FromStr for MultilineLimits {
+    type Err = CapParseError;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let dictionary = s
+            .split(',')
+            .flat_map(|s| s.split_once('='))
+            .collect::<HashMap<_, _>>();
+
+        Ok(MultilineLimits {
+            max_bytes: dictionary
+                .get("max-bytes")
+                .ok_or_else(|| {
+                    CapParseError::MissingKey(
+                        "max-bytes".to_owned(),
+                        s.to_owned(),
+                    )
+                })?
+                .parse::<usize>()?,
+            max_lines: dictionary
+                .get("max-lines")
+                .map(|s| s.parse::<usize>())
+                .transpose()?,
+        })
+    }
+}
+
+#[derive(Debug, Clone, Copy)]
+pub struct MetadataLimits {
+    pub max_subs: usize,
+}
+
+impl FromStr for MetadataLimits {
+    type Err = CapParseError;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let dictionary = s
+            .split(',')
+            .flat_map(|s| s.split_once('='))
+            .collect::<HashMap<_, _>>();
+
+        Ok(MetadataLimits {
+            max_subs: dictionary
+                .get("max-subs")
+                .ok_or_else(|| {
+                    CapParseError::MissingKey(
+                        "max-subs".to_owned(),
+                        s.to_owned(),
+                    )
+                })?
+                .parse::<usize>()?,
+        })
+    }
+}
+
 impl MultilineLimits {
     pub fn concat_bytes(
         &self,
@@ -199,10 +262,9 @@ pub enum MultilineBatchKind {
 
 #[derive(Debug, Default)]
 pub struct Capabilities {
-    listed: HashSet<String>,
+    listed: HashMap<String, String>,
     pending: HashMap<String, String>,
     acknowledged: HashSet<Capability>,
-    multiline: Option<MultilineLimits>,
 }
 
 impl Capabilities {
@@ -346,27 +408,11 @@ impl Capabilities {
             requested.push("sasl");
         }
 
-        if let Some(multiline) = self.pending.get("draft/multiline") {
-            let dictionary = multiline.split(',').collect::<Vec<_>>();
-
-            if let Some(max_bytes) = dictionary.iter().find_map(|key_value| {
-                key_value
-                    .strip_prefix("max-bytes=")
-                    .and_then(|value| value.parse::<usize>().ok())
-            }) {
-                self.multiline = Some(MultilineLimits {
-                    max_bytes,
-                    max_lines: dictionary.iter().find_map(|key_value| {
-                        key_value
-                            .strip_prefix("max-lines=")
-                            .and_then(|value| value.parse::<usize>().ok())
-                    }),
-                });
-
-                if !self.acknowledged(Capability::Multiline) {
-                    requested.push("draft/multiline");
-                }
-            }
+        if let Some(multiline) = self.pending.get("draft/multiline")
+            && !self.acknowledged(Capability::Multiline)
+            && MultilineLimits::from_str(multiline).is_ok()
+        {
+            requested.push("draft/multiline");
         }
 
         if self.pending.contains_key("draft/metadata-2")
@@ -375,8 +421,8 @@ impl Capabilities {
             requested.push("draft/metadata-2");
         }
 
-        for (cap, _) in self.pending.drain() {
-            self.listed.insert(cap);
+        for (cap, val) in self.pending.drain() {
+            self.listed.insert(cap, val);
         }
 
         requested
@@ -403,11 +449,21 @@ impl Capabilities {
     }
 
     pub fn multiline_limits(&self) -> Option<MultilineLimits> {
-        if self.acknowledged(Capability::Multiline) {
-            self.multiline
-        } else {
-            None
-        }
+        self.acknowledged(Capability::Multiline)
+            .then(|| {
+                MultilineLimits::from_str(self.listed.get("draft/multiline")?)
+                    .ok()
+            })
+            .flatten()
+    }
+
+    pub fn metadata_limits(&self) -> Option<MetadataLimits> {
+        self.acknowledged(Capability::Metadata)
+            .then(|| {
+                MetadataLimits::from_str(self.listed.get("draft/metadata-2")?)
+                    .ok()
+            })
+            .flatten()
     }
 
     pub fn contains_multiline_limits(&self) -> bool {

data/src/client.rs

@@ -2876,13 +2876,30 @@ impl Client {
 
                     // request metadata
                     if self.capabilities.acknowledged(Capability::Metadata) {
-                        // TODO(pounce) have list of currently implemented keys somewhere
-                        self.handle.try_send(command!(
-                            "METADATA",
-                            "*",
-                            "SUB",
-                            "display-name",
-                        ))?;
+                        let mut requested = config
+                            .metadata
+                            .preferred_key_strs()
+                            .map(ToString::to_string)
+                            .collect::<Vec<String>>();
+
+                        if let Some(limits) =
+                            self.capabilities.metadata_limits()
+                        {
+                            requested.truncate(limits.max_subs);
+                        }
+
+                        log::debug!(
+                            "[{}] Requesting subs: {requested:?}",
+                            self.server
+                        );
+
+                        if !requested.is_empty() {
+                            let mut args =
+                                vec!["*".to_string(), "SUB".to_string()];
+                            args.extend(requested);
+
+                            self.handle.try_send(command("METADATA", args))?;
+                        }
                     }
 
                     let channels = self

data/src/config.rs

@@ -33,6 +33,7 @@ pub use self::window::Window;
 use crate::appearance::theme::Styles;
 use crate::appearance::{self, Appearance};
 use crate::audio::{self};
+use crate::config::metadata::Metadata;
 use crate::serde::{
     deserialize_f32_positive_float_maybe, deserialize_u8_positive_integer_maybe,
 };
@@ -49,6 +50,7 @@ pub mod highlights;
 pub mod inclusivities;
 pub mod keys;
 pub mod logs;
+pub mod metadata;
 pub mod notification;
 pub mod pane;
 pub mod platform_specific;
@@ -85,6 +87,7 @@ pub struct Config {
     pub logs: Logs,
     pub platform_specific: PlatformSpecific,
     pub check_for_update_on_launch: bool,
+    pub metadata: Metadata,
 }
 
 impl Default for Config {
@@ -112,6 +115,7 @@ impl Default for Config {
             logs: Logs::default(),
             platform_specific: PlatformSpecific::default(),
             check_for_update_on_launch: true,
+            metadata: Metadata::default(),
         }
     }
 }
@@ -372,6 +376,7 @@ impl Config {
             pub logs: Logs,
             pub platform_specific: PlatformSpecific,
             pub check_for_update_on_launch: bool,
+            pub metadata: Metadata,
         }
 
         impl Default for Configuration {
@@ -399,6 +404,7 @@ impl Config {
                     logs: Logs::default(),
                     platform_specific: PlatformSpecific::default(),
                     check_for_update_on_launch: true,
+                    metadata: Metadata::default(),
                 }
             }
         }
@@ -437,6 +443,7 @@ impl Config {
             logs,
             platform_specific,
             check_for_update_on_launch,
+            metadata,
         } = serde_ignored::deserialize(config, |ignored| {
             log::warn!("[config.toml] Ignoring unknown setting: {ignored}");
         })
@@ -476,6 +483,7 @@ impl Config {
             logs,
             platform_specific,
             check_for_update_on_launch,
+            metadata,
         })
     }
 

data/src/config/metadata.rs

@@ -0,0 +1,31 @@
+use serde::Deserialize;
+
+use crate::metadata;
+use crate::metadata::Key::{self, *};
+
+#[derive(Debug, Clone, Deserialize)]
+pub struct Metadata {
+    /// List of keys to subscribe to, in order of preference
+    pub preferred_keys: Vec<metadata::Key>,
+}
+
+impl Default for Metadata {
+    fn default() -> Self {
+        Self {
+            preferred_keys: vec![
+                DisplayName,
+                Avatar,
+                Pronouns,
+                Homepage,
+                Color,
+                Status,
+            ],
+        }
+    }
+}
+
+impl Metadata {
+    pub fn preferred_key_strs(&self) -> impl Iterator<Item = &'static str> {
+        self.preferred_keys.iter().copied().map(Key::to_str)
+    }
+}