Feat/cs/attachment payload

.github/workflows/test.yml

@@ -12,6 +12,8 @@ env:
 jobs:
   Test:
     runs-on: ubuntu-latest
+    env:
+      TZ: PST
 
     steps:
       - uses: actions/checkout@v2

imessage-database/src/message_types/app.rs

@@ -88,7 +88,7 @@ impl AppMessage<'_> {
 mod tests {
     use crate::{
         message_types::{app::AppMessage, variants::BalloonProvider},
-        util::plist::parse_plist,
+        util::plist::parse_ns_keyed_archiver,
     };
     use plist::Value;
     use std::fs::File;
@@ -102,7 +102,7 @@ mod tests {
             .join("test_data/app_message/Sent265.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
         let expected = AppMessage {
@@ -129,7 +129,7 @@ mod tests {
             .join("test_data/app_message/ApplePayRecurring.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
         let expected = AppMessage {
@@ -156,7 +156,7 @@ mod tests {
             .join("test_data/app_message/OpenTableInvited.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
         let expected = AppMessage {
@@ -183,7 +183,7 @@ mod tests {
             .join("test_data/app_message/Slideshow.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
         let expected = AppMessage {
@@ -210,7 +210,7 @@ mod tests {
             .join("test_data/app_message/Game.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
         let expected = AppMessage {
@@ -237,7 +237,7 @@ mod tests {
             .join("test_data/app_message/Business.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
         let expected = AppMessage {
@@ -264,7 +264,7 @@ mod tests {
             .join("test_data/app_message/Business.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
         let mut expected = HashMap::new();
@@ -282,7 +282,7 @@ mod tests {
             .join("test_data/app_message/CheckinTimer.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
 
@@ -310,7 +310,7 @@ mod tests {
             .join("test_data/app_message/CheckinLate.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
 
@@ -338,7 +338,7 @@ mod tests {
             .join("test_data/app_message/CheckinLocation.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
 
@@ -366,7 +366,7 @@ mod tests {
             .join("test_data/app_message/CheckinTimer.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
         let mut expected = HashMap::new();
@@ -385,7 +385,7 @@ mod tests {
             .join("test_data/app_message/FindMy.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppMessage::from_map(&parsed).unwrap();
         let expected = AppMessage {

imessage-database/src/message_types/app_store.rs

@@ -78,7 +78,7 @@ impl<'a> AppStoreMessage<'a> {
 mod tests {
     use crate::{
         message_types::{app_store::AppStoreMessage, variants::BalloonProvider},
-        util::plist::parse_plist,
+        util::plist::parse_ns_keyed_archiver,
     };
     use plist::Value;
     use std::env::current_dir;
@@ -92,7 +92,7 @@ mod tests {
             .join("test_data/app_store/AppStoreLink.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = AppStoreMessage::from_map(&parsed).unwrap();
         let expected = AppStoreMessage {

imessage-database/src/message_types/collaboration.rs

@@ -104,7 +104,7 @@ impl<'a> CollaborationMessage<'a> {
 mod tests {
     use crate::{
         message_types::{collaboration::CollaborationMessage, variants::BalloonProvider},
-        util::plist::parse_plist,
+        util::plist::parse_ns_keyed_archiver,
     };
     use plist::Value;
     use std::env::current_dir;
@@ -118,7 +118,7 @@ mod tests {
             .join("test_data/collaboration_message/Freeform.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let actual = CollaborationMessage::from_map(&parsed).unwrap();
         let expected = CollaborationMessage {

imessage-database/src/message_types/music.rs

@@ -77,7 +77,7 @@ impl<'a> MusicMessage<'a> {
 mod tests {
     use crate::{
         message_types::{music::MusicMessage, variants::BalloonProvider},
-        util::plist::parse_plist,
+        util::plist::parse_ns_keyed_archiver,
     };
     use plist::Value;
     use std::env::current_dir;
@@ -91,7 +91,7 @@ mod tests {
             .join("test_data/music_message/AppleMusic.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = MusicMessage::from_map(&parsed).unwrap();
         let expected = MusicMessage {

imessage-database/src/message_types/placemark.rs

@@ -137,7 +137,7 @@ mod tests {
             placemark::{Placemark, PlacemarkMessage},
             variants::BalloonProvider,
         },
-        util::plist::parse_plist,
+        util::plist::parse_ns_keyed_archiver,
     };
     use plist::Value;
     use std::env::current_dir;
@@ -151,7 +151,7 @@ mod tests {
             .join("test_data/shared_placemark/SharedPlacemark.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = PlacemarkMessage::from_map(&parsed).unwrap();
         let expected = PlacemarkMessage {
@@ -183,7 +183,7 @@ mod tests {
             .join("test_data/shared_placemark/SharedPlacemark.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let (placemark_data, _) = PlacemarkMessage::get_body_and_url(&parsed).unwrap();
 

imessage-database/src/message_types/sticker.rs

@@ -4,13 +4,52 @@ These are [sticker messages](https://support.apple.com/guide/iphone/send-sticker
 
 use std::fmt::Display;
 
+use crate::util::bundle_id::parse_balloon_bundle_id;
+
 /// Bytes for `stickerEffect:type="`
 const STICKER_EFFECT_PREFIX: [u8; 20] = [
     115, 116, 105, 99, 107, 101, 114, 69, 102, 102, 101, 99, 116, 58, 116, 121, 112, 101, 61, 34,
 ];
 /// Bytes for `"/>`
 const STICKER_EFFECT_SUFFIX: [u8; 3] = [34, 47, 62];
 
+/// Represents the source that created a sticker attachment
+#[derive(Debug, PartialEq, Eq)]
+pub enum StickerSource {
+    /// A [Genmoji](https://support.apple.com/guide/iphone/create-genmoji-with-apple-intelligence-iph4e76f5667/ios)
+    Genmoji,
+    /// A [Memoji](https://support.apple.com/en-us/111115)
+    Memoji,
+    /// User-created stickers
+    UserGenerated,
+    /// Application provided stickers
+    App(String),
+}
+
+impl StickerSource {
+    /// Given an application's bundle ID, determine the source
+    ///
+    /// # Example
+    ///
+    /// ```rust
+    /// use imessage_database::message_types::sticker::StickerSource;;
+    ///
+    /// println!("{:?}", StickerSource::from_bundle_id("com.apple.messages.genmoji")); // StickerSource::Genmoji
+    /// ```
+    pub fn from_bundle_id(bundle_id: &str) -> Option<Self> {
+        match parse_balloon_bundle_id(Some(bundle_id)) {
+            Some("com.apple.messages.genmoji") => Some(StickerSource::Genmoji),
+            Some("com.apple.Animoji.StickersApp.MessagesExtension")
+            | Some("com.apple.Jellyfish.Animoji") => Some(StickerSource::Memoji),
+            Some("com.apple.Stickers.UserGenerated.MessagesExtension") => {
+                Some(StickerSource::UserGenerated)
+            }
+            Some(other) => Some(StickerSource::App(other.to_string())),
+            None => None,
+        }
+    }
+}
+
 /// Represents different types of [sticker effects](https://www.macrumors.com/how-to/add-effects-to-stickers-in-messages/) that can be applied to sticker iMessage balloons.
 #[derive(Debug, PartialEq, Eq)]
 pub enum StickerEffect {

imessage-database/src/message_types/url.rs

@@ -136,7 +136,7 @@ impl<'a> URLMessage<'a> {
 mod url_tests {
     use crate::{
         message_types::{url::URLMessage, variants::BalloonProvider},
-        util::plist::parse_plist,
+        util::plist::parse_ns_keyed_archiver,
     };
     use plist::Value;
     use std::env::current_dir;
@@ -150,7 +150,7 @@ mod url_tests {
             .join("test_data/url_message/URL.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = URLMessage::from_map(&parsed).unwrap();
         let expected = URLMessage {
@@ -176,7 +176,7 @@ mod url_tests {
             .join("test_data/url_message/MetadataURL.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = URLMessage::from_map(&parsed).unwrap();
         let expected = URLMessage {
@@ -206,7 +206,7 @@ mod url_tests {
             .join("test_data/url_message/Twitter.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = URLMessage::from_map(&parsed).unwrap();
         let expected = URLMessage {
@@ -239,7 +239,7 @@ mod url_tests {
             .join("test_data/url_message/Reminder.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = URLMessage::from_map(&parsed).unwrap();
         let expected = URLMessage {
@@ -312,7 +312,7 @@ mod url_tests {
 mod url_override_tests {
     use crate::{
         message_types::{url::URLMessage, variants::URLOverride},
-        util::plist::parse_plist,
+        util::plist::parse_ns_keyed_archiver,
     };
     use plist::Value;
     use std::env::current_dir;
@@ -326,7 +326,7 @@ mod url_override_tests {
             .join("test_data/url_message/URL.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = URLMessage::get_url_message_override(&parsed).unwrap();
         assert!(matches!(balloon, URLOverride::Normal(_)));
@@ -340,7 +340,7 @@ mod url_override_tests {
             .join("test_data/music_message/AppleMusic.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = URLMessage::get_url_message_override(&parsed).unwrap();
         assert!(matches!(balloon, URLOverride::AppleMusic(_)));
@@ -354,7 +354,7 @@ mod url_override_tests {
             .join("test_data/app_store/AppStoreLink.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = URLMessage::get_url_message_override(&parsed).unwrap();
         assert!(matches!(balloon, URLOverride::AppStore(_)));
@@ -368,7 +368,7 @@ mod url_override_tests {
             .join("test_data/collaboration_message/Freeform.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = URLMessage::get_url_message_override(&parsed).unwrap();
         assert!(matches!(balloon, URLOverride::Collaboration(_)));
@@ -382,7 +382,7 @@ mod url_override_tests {
             .join("test_data/shared_placemark/SharedPlacemark.plist");
         let plist_data = File::open(plist_path).unwrap();
         let plist = Value::from_reader(plist_data).unwrap();
-        let parsed = parse_plist(&plist).unwrap();
+        let parsed = parse_ns_keyed_archiver(&plist).unwrap();
 
         let balloon = URLMessage::get_url_message_override(&parsed).unwrap();
         println!("{balloon:?}");