refactor: inline quick-xml::escape::escape (#53)

* refactor: inline quick-xml::escape::escape

* don't use it in examples either

Author: FabianLars

.changes/drop-quickxml.md

@@ -0,0 +1,5 @@
+---
+tauri-winrt-notification: patch
+---
+
+Drop quick-xml dependency.

Cargo.lock

@@ -18,7 +18,6 @@ rust-version = "1.74"
 default-target = "x86_64-pc-windows-msvc"
 
 [dependencies]
-quick-xml = "0.38"
 thiserror = "2"
 windows-version = "0.1"
 

Cargo.toml

@@ -17,6 +17,10 @@ use windows::{
 
 pub use windows::core::{Error, HSTRING};
 
+// In a real project you'd use quick-xml::escape::escape
+#[path = "../src/xml_escape.rs"]
+mod xml_escape;
+
 fn main() {
     do_toast().expect("not sure if this is actually failable");
     // this is a hack to workaround toasts not showing up if the application closes too quickly
@@ -42,7 +46,7 @@ fn do_toast() -> windows::core::Result<()> {
                 <audio src="ms-winsoundevent:Notification.SMS" />
                 <!-- <audio silent="true" /> -->
             </toast>"#,
-            quick_xml::escape::escape(Path::new("C:\\path_to_image_in_toast.jpg").display().to_string()),
+            xml_escape::escape(Path::new("C:\\path_to_image_in_toast.jpg").display().to_string()),
     ))).expect("the xml is malformed");
 
     // Create the toast and attach event listeners

examples/without_library.rs

@@ -31,6 +31,9 @@
 //! * <https://softwareengineering.stackexchange.com/questions/222339/using-the-system-tray-notification-area-app-in-windows-7>
 //!
 //! For actions look at <https://docs.microsoft.com/en-us/dotnet/api/microsoft.toolkit.uwp.notifications.toastactionscustom?view=win-comm-toolkit-dotnet-7.0>
+
+mod xml_escape;
+
 use windows::{
     core::{IInspectable, Interface},
     Data::Xml::Dom::XmlDocument,
@@ -356,10 +359,7 @@ impl Toast {
     /// Will be white.
     /// Supports Unicode ✓
     pub fn title(mut self, content: &str) -> Toast {
-        self.title = format!(
-            r#"<text id="1">{}</text>"#,
-            &quick_xml::escape::escape(content)
-        );
+        self.title = format!(r#"<text id="1">{}</text>"#, xml_escape::escape(content));
         self
     }
 
@@ -368,10 +368,7 @@ impl Toast {
     /// Will be grey.
     /// Supports Unicode ✓
     pub fn text1(mut self, content: &str) -> Toast {
-        self.line1 = format!(
-            r#"<text id="2">{}</text>"#,
-            &quick_xml::escape::escape(content)
-        );
+        self.line1 = format!(r#"<text id="2">{}</text>"#, xml_escape::escape(content));
         self
     }
 
@@ -380,10 +377,7 @@ impl Toast {
     /// Will be grey.
     /// Supports Unicode ✓
     pub fn text2(mut self, content: &str) -> Toast {
-        self.line2 = format!(
-            r#"<text id="3">{}</text>"#,
-            &quick_xml::escape::escape(content)
-        );
+        self.line2 = format!(r#"<text id="3">{}</text>"#, xml_escape::escape(content));
         self
     }
 
@@ -427,8 +421,8 @@ impl Toast {
                 r#"{}<image placement="appLogoOverride" {} src="file:///{}" alt="{}" />"#,
                 self.images,
                 crop_type_attr,
-                quick_xml::escape::escape(source.display().to_string()),
-                quick_xml::escape::escape(alt_text)
+                xml_escape::escape(source.display().to_string()),
+                xml_escape::escape(alt_text)
             );
             self
         } else {
@@ -445,8 +439,8 @@ impl Toast {
             self.images = format!(
                 r#"{}<image placement="Hero" src="file:///{}" alt="{}" />"#,
                 self.images,
-                quick_xml::escape::escape(source.display().to_string()),
-                quick_xml::escape::escape(alt_text)
+                xml_escape::escape(source.display().to_string()),
+                xml_escape::escape(alt_text)
             );
             self
         } else {
@@ -467,8 +461,8 @@ impl Toast {
         self.images = format!(
             r#"{}<image id="1" src="file:///{}" alt="{}" />"#,
             self.images,
-            quick_xml::escape::escape(source.display().to_string()),
-            quick_xml::escape::escape(alt_text)
+            xml_escape::escape(source.display().to_string()),
+            xml_escape::escape(alt_text)
         );
         self
     }

src/lib.rs

@@ -0,0 +1,60 @@
+// Copyright 2022-2022 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+// Copied from https://github.com/tafia/quick-xml/blob/master/src/escape.rs
+
+use std::{borrow::Cow, fmt::Write};
+
+pub fn escape<'a>(raw: impl Into<Cow<'a, str>>) -> Cow<'a, str> {
+    let escape_chars = |ch| matches!(ch, b'<' | b'>' | b'&' | b'\'' | b'\"');
+    let raw = raw.into();
+    let bytes = raw.as_bytes();
+    let mut escaped = None;
+    let mut iter = bytes.iter();
+    let mut pos = 0;
+    while let Some(i) = iter.position(|&b| escape_chars(b)) {
+        if escaped.is_none() {
+            escaped = Some(String::with_capacity(raw.len()));
+        }
+        let escaped = escaped.as_mut().expect("initialized");
+        let new_pos = pos + i;
+        // SAFETY: It should fail only on OOM
+        escape_char(escaped, &raw, pos, new_pos).unwrap();
+        pos = new_pos + 1;
+    }
+
+    if let Some(mut escaped) = escaped {
+        if let Some(raw) = raw.get(pos..) {
+            // SAFETY: It should fail only on OOM
+            escaped.write_str(raw).unwrap();
+        }
+        Cow::Owned(escaped)
+    } else {
+        raw
+    }
+}
+
+fn escape_char<W>(writer: &mut W, value: &str, from: usize, to: usize) -> std::fmt::Result
+where
+    W: Write,
+{
+    writer.write_str(&value[from..to])?;
+    match value.as_bytes()[to] {
+        b'<' => writer.write_str("&lt;")?,
+        b'>' => writer.write_str("&gt;")?,
+        b'\'' => writer.write_str("&apos;")?,
+        b'&' => writer.write_str("&amp;")?,
+        b'"' => writer.write_str("&quot;")?,
+
+        // This set of escapes handles characters that should be escaped
+        // in elements of xs:lists, because those characters works as
+        // delimiters of list elements
+        b'\t' => writer.write_str("&#9;")?,
+        b'\n' => writer.write_str("&#10;")?,
+        b'\r' => writer.write_str("&#13;")?,
+        b' ' => writer.write_str("&#32;")?,
+        _ => unreachable!("Only '<', '>','\', '&', '\"', '\\t', '\\r', '\\n', and ' ' are escaped"),
+    }
+    Ok(())
+}