macltok

public

Star0

Fork 0

Watch0

70 commits 3 branches 0 tags 0 releases3.0 MiB

Commit `d8e76b56867c`

tarball

atagen <boss@atagen.co>2026-10-25 09:30 UTC

4 files changed+88-60

packs: keep unknown usage on clone and reject empty usage

Cloning dropped msc2545 usage values macltok does not know, so a copy stopped meaning what the original meant. Some(vec![]) read back as inheriting, which None and Patch::Clear already say, so it is now rejected as Invalid.

Modified file: src/engine/packs.rs+74 additions−24 deletions@@ -18,7 +18,9 @@ use super::{
 };
 use crate::{
     CommandOutput, Error, ErrorKind, ImagePackSource, PackCommand, PackImageInfo, PackUsage, Patch,
-    normalise::{ENABLED_ROOMS, ROOM_PACKS, USER_PACK, resolve_pack_id, stored_pack},
+    normalise::{
+        ENABLED_ROOMS, ROOM_PACKS, USER_PACK, effective_usage, resolve_pack_id, stored_pack,
+    },
     transport::Responder,
 };
 
@@ -59,6 +61,14 @@ pub(super) async fn edit_pack(
     pack: &ImagePackSource,
     edit: PackEdit,
 ) -> Result<CommandOutput, Error> {
+    match &edit {
+        PackEdit::Meta {
+            usage: Patch::Set(usage),
+            ..
+        } => validate_usage(Some(usage))?,
+        PackEdit::Put { usage, .. } => validate_usage(usage.as_ref())?,
+        _ => {}
+    }
     let current = fetch_pack(client, pack).await?;
     let mut content = current.clone().unwrap_or_default();
     let mut output = CommandOutput::Done;
@@ -205,6 +215,12 @@ pub(super) async fn run_detached(
     max_bytes: usize,
     command: PackCommand,
 ) -> Result<CommandOutput, Error> {
+    if let PackCommand::CloneImage { usage, .. }
+    | PackCommand::CloneSticker { usage, .. }
+    | PackCommand::ClonePack { usage, .. } = &command
+    {
+        validate_usage(usage.as_ref())?;
+    }
     match command {
         PackCommand::SendSticker {
             room_id,
@@ -506,11 +522,25 @@ async fn write_pack(
     written.map_err(|source| Error::from_sdk("writing the pack failed", source))
 }
 
+/// values this crate doesn't know ride along untouched, they may mean something to someone
 fn with_pack_usage(mut image: JsonObject, meta: &JsonObject) -> JsonObject {
-    let usage = known_usage(image.get("usage"))
-        .or_else(|| known_usage(meta.get("usage")))
-        .unwrap_or_else(|| vec![PackUsage::Emoticon, PackUsage::Sticker]);
-    image.insert("usage".to_owned(), usage_json(usage));
+    if known_usage(image.get("usage")).is_some() {
+        return image;
+    }
+    let mut usage = match meta.get("usage") {
+        Some(JsonValue::Array(values)) if known_usage(meta.get("usage")).is_some() => {
+            values.clone()
+        }
+        _ => usage_values(effective_usage(None, None)),
+    };
+    if let Some(JsonValue::Array(own)) = image.get("usage") {
+        for value in own {
+            if !usage.contains(value) {
+                usage.push(value.clone());
+            }
+        }
+    }
+    image.insert("usage".to_owned(), usage.into());
     image
 }
 
@@ -531,6 +561,17 @@ fn known_usage(value: Option<&JsonValue>) -> Option<Vec<PackUsage>> {
     (!usage.is_empty()).then_some(usage)
 }
 
+/// `Some` of nothing would read back as inheriting, which `None` and `Patch::Clear` already say
+fn validate_usage(usage: Option<&Vec<PackUsage>>) -> Result<(), Error> {
+    if usage.is_some_and(Vec::is_empty) {
+        return Err(Error::new(
+            ErrorKind::Invalid,
+            "usage needs at least one value, leave it unset to inherit",
+        ));
+    }
+    Ok(())
+}
+
 fn apply_usage(image: &mut JsonObject, usage: Option<Vec<PackUsage>>) {
     if let Some(usage) = usage {
         image.insert("usage".to_owned(), usage_json(usage));
@@ -585,14 +626,17 @@ fn patch<T>(
 }
 
 fn usage_json(usage: Vec<PackUsage>) -> JsonValue {
+    usage_values(usage).into()
+}
+
+fn usage_values(usage: Vec<PackUsage>) -> Vec<JsonValue> {
     usage
         .into_iter()
         .map(|usage| match usage {
-            PackUsage::Emoticon => "emoticon",
-            PackUsage::Sticker => "sticker",
+            PackUsage::Emoticon => "emoticon".into(),
+            PackUsage::Sticker => "sticker".into(),
         })
-        .collect::<Vec<_>>()
-        .into()
+        .collect()
 }
 
 fn info_json(info: PackImageInfo) -> JsonValue {
@@ -624,23 +668,40 @@ fn object(value: JsonValue) -> JsonObject {
     }
 }
 
+fn parse(json: &str) -> Result<JsonObject, Error> {
+    serde_json::from_str(json)
+        .map_err(|source| Error::with_source(ErrorKind::Server, "the pack is malformed", source))
+}
+
+fn raw<T>(content: &JsonObject) -> Raw<T> {
+    Raw::new(content)
+        .expect("a json object always serialises")
+        .cast_unchecked()
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
 
     #[test]
-    fn pack_usage_inherits_known_values_then_defaults() {
+    fn pack_usage_inherits_known_values_then_defaults_and_keeps_unknown_ones() {
         let pack = object(json!({ "usage": ["sticker", "unknown"] }));
         let inherited = with_pack_usage(object(json!({ "usage": [] })), &pack);
-        assert_eq!(inherited.get("usage"), Some(&json!(["sticker"])));
+        assert_eq!(inherited.get("usage"), Some(&json!(["sticker", "unknown"])));
 
         let pack = object(json!({ "usage": ["emoticon"] }));
         let inherited = with_pack_usage(object(json!({ "usage": ["unknown"] })), &pack);
-        assert_eq!(inherited.get("usage"), Some(&json!(["emoticon"])));
+        assert_eq!(
+            inherited.get("usage"),
+            Some(&json!(["emoticon", "unknown"]))
+        );
 
         let pack = object(json!({ "usage": ["sticker"] }));
         let inherited = with_pack_usage(object(json!({ "usage": ["emoticon", "unknown"] })), &pack);
-        assert_eq!(inherited.get("usage"), Some(&json!(["emoticon"])));
+        assert_eq!(
+            inherited.get("usage"),
+            Some(&json!(["emoticon", "unknown"]))
+        );
 
         let pack = object(json!({ "usage": [] }));
         let inherited = with_pack_usage(object(json!({})), &pack);
@@ -671,14 +732,3 @@ mod tests {
         );
     }
 }
-
-fn parse(json: &str) -> Result<JsonObject, Error> {
-    serde_json::from_str(json)
-        .map_err(|source| Error::with_source(ErrorKind::Server, "the pack is malformed", source))
-}
-
-fn raw<T>(content: &JsonObject) -> Raw<T> {
-    Raw::new(content)
-        .expect("a json object always serialises")
-        .cast_unchecked()
-}

Modified file: src/normalise/image_pack.rs+11 additions−3 deletions@@ -184,9 +184,7 @@ fn pack(
                 mimetype: info.and_then(|info| info.mimetype.clone()),
                 width: info.and_then(|info| info.width).map(u64::from),
                 height: info.and_then(|info| info.height).map(u64::from),
-                usage: usage(&image.usage)
-                    .or_else(|| pack_usage.clone())
-                    .unwrap_or_else(|| vec![PackUsage::Emoticon, PackUsage::Sticker]),
+                usage: effective_usage(usage(&image.usage), pack_usage.clone()),
             })
         })
         .collect();
@@ -210,6 +208,16 @@ fn pack(
     })
 }
 
+/// an image's own known usage, else its pack's, else both. unknown values never count
+pub(crate) fn effective_usage(
+    image: Option<Vec<PackUsage>>,
+    pack: Option<Vec<PackUsage>>,
+) -> Vec<PackUsage> {
+    image
+        .or(pack)
+        .unwrap_or_else(|| vec![PackUsage::Emoticon, PackUsage::Sticker])
+}
+
 fn usage(usage: &BTreeSet<SourceUsage>) -> Option<Vec<PackUsage>> {
     let usage: Vec<PackUsage> = usage
         .iter()

Modified file: src/normalise/mod.rs+2 additions−1 deletions@@ -9,7 +9,8 @@ mod timeline;
 
 pub(crate) use context::{apply_profiles, normalise_context, resolve_replies};
 pub(crate) use image_pack::{
-    ENABLED_ROOMS, ROOM_PACKS, USER_PACK, can_edit_packs, image_packs, resolve_pack_id, stored_pack,
+    ENABLED_ROOMS, ROOM_PACKS, USER_PACK, can_edit_packs, effective_usage, image_packs,
+    resolve_pack_id, stored_pack,
 };
 pub(crate) use link_preview::{ROOM_PREVIEW_URLS, server_preview, url_previews_allowed};
 pub(crate) use media::{MediaRegistration, MediaScope, MediaSourceInfo};

Modified file: src/transport.rs+1 additions−32 deletions@@ -1038,22 +1038,12 @@ impl ClientHandle {
         }
     }
 
-    /// hands back the shortcode it ended up under
+    /// hands back the shortcode it ended up under. `usage` overrides what the image had
     pub async fn clone_pack_image(
         &self,
         from_pack: String,
         shortcode: String,
         to: ImagePackSource,
-    ) -> Result<String, Error> {
-        self.clone_pack_image_with_usage(from_pack, shortcode, to, None)
-            .await
-    }
-
-    pub async fn clone_pack_image_with_usage(
-        &self,
-        from_pack: String,
-        shortcode: String,
-        to: ImagePackSource,
         usage: Option<Vec<PackUsage>>,
     ) -> Result<String, Error> {
         let (mut shortcodes, _) = self
@@ -1076,17 +1066,6 @@ impl ClientHandle {
         event_id: OwnedEventId,
         to: ImagePackSource,
         shortcode: String,
-    ) -> Result<String, Error> {
-        self.clone_sticker_with_usage(room_id, event_id, to, shortcode, None)
-            .await
-    }
-
-    pub async fn clone_sticker_with_usage(
-        &self,
-        room_id: OwnedRoomId,
-        event_id: OwnedEventId,
-        to: ImagePackSource,
-        shortcode: String,
         usage: Option<Vec<PackUsage>>,
     ) -> Result<String, Error> {
         let (mut shortcodes, _) = self
@@ -1109,16 +1088,6 @@ impl ClientHandle {
         from_pack: String,
         to: ImagePackSource,
         display_name: Option<String>,
-    ) -> Result<Vec<String>, Error> {
-        self.clone_pack_with_usage(from_pack, to, display_name, None)
-            .await
-    }
-
-    pub async fn clone_pack_with_usage(
-        &self,
-        from_pack: String,
-        to: ImagePackSource,
-        display_name: Option<String>,
         usage: Option<Vec<PackUsage>>,
     ) -> Result<Vec<String>, Error> {
         let (_, skipped) = self

macltok

Commit d8e76b56867c

Commit `d8e76b56867c`