Add file_list to Get interface (#179)

Author: Gae24

Cargo.lock

@@ -44,7 +44,7 @@ windows-sys = { version = ">=0.52.0, <0.60.0", optional = true, features = [
     "Win32_System_Memory",
     "Win32_System_Ole",
 ] }
-clipboard-win = "5.3.1"
+clipboard-win = { version = "5.3.1", features = ["std"] }
 log = "0.4"
 image = { version = "0.25", optional = true, default-features = false, features = [
     "png",
@@ -58,6 +58,7 @@ objc2-foundation = { version = "0.3.0", default-features = false, features = [
     "NSString",
     "NSEnumerator",
     "NSGeometry",
+    "NSValue",
 ] }
 objc2-app-kit = { version = "0.3.0", default-features = false, features = [
     "std",
@@ -88,6 +89,7 @@ image = { version = "0.25", optional = true, default-features = false, features
     "png",
 ] }
 parking_lot = "0.12"
+percent-encoding = "2.3.1"
 
 [[example]]
 name = "get_image"

Cargo.toml

@@ -10,7 +10,7 @@ and conditions of the chosen license apply to this file.
 #![warn(unreachable_pub)]
 
 mod common;
-use std::borrow::Cow;
+use std::{borrow::Cow, path::PathBuf};
 
 pub use common::Error;
 #[cfg(feature = "image-data")]
@@ -197,6 +197,11 @@ impl Get<'_> {
 	pub fn html(self) -> Result<String, Error> {
 		self.platform.html()
 	}
+
+	/// Completes the "get" operation by fetching a list of file paths from the clipboard.
+	pub fn file_list(self) -> Result<Vec<PathBuf>, Error> {
+		self.platform.file_list()
+	}
 }
 
 /// A builder for an operation that sets a value to the clipboard.

src/lib.rs

@@ -1,7 +1,8 @@
-use std::{borrow::Cow, time::Instant};
+use std::{borrow::Cow, path::PathBuf, time::Instant};
 
 #[cfg(feature = "wayland-data-control")]
 use log::{trace, warn};
+use percent_encoding::percent_decode_str;
 
 #[cfg(feature = "image-data")]
 use crate::ImageData;
@@ -38,6 +39,15 @@ fn encode_as_png(image: &ImageData) -> Result<Vec<u8>, Error> {
 	Ok(png_bytes)
 }
 
+fn paths_from_uri_list(uri_list: String) -> Vec<PathBuf> {
+	uri_list
+		.lines()
+		.filter_map(|s| s.strip_prefix("file://"))
+		.filter_map(|s| percent_decode_str(s).decode_utf8().ok())
+		.map(|decoded| PathBuf::from(decoded.as_ref()))
+		.collect()
+}
+
 /// Clipboard selection
 ///
 /// Linux has a concept of clipboard "selections" which tend to be used in different contexts. This
@@ -130,6 +140,14 @@ impl<'clipboard> Get<'clipboard> {
 			Clipboard::WlDataControl(clipboard) => clipboard.get_html(self.selection),
 		}
 	}
+
+	pub(crate) fn file_list(self) -> Result<Vec<PathBuf>, Error> {
+		match self.clipboard {
+			Clipboard::X11(clipboard) => clipboard.get_file_list(self.selection),
+			#[cfg(feature = "wayland-data-control")]
+			Clipboard::WlDataControl(clipboard) => clipboard.get_file_list(self.selection),
+		}
+	}
 }
 
 /// Linux-specific extensions to the [`Get`](super::Get) builder.
@@ -330,3 +348,28 @@ impl ClearExtLinux for crate::Clear<'_> {
 		self.platform.clear_inner(selection)
 	}
 }
+
+#[cfg(test)]
+mod tests {
+	use super::*;
+
+	#[test]
+	fn test_decoding_uri_list() {
+		// Test that paths_from_uri_list correctly decodes
+		// differents percent encoded characters
+		let file_list = vec![
+			"file:///tmp/bar.log",
+			"file:///tmp/test%5C.txt",
+			"file:///tmp/foo%3F.png",
+			"file:///tmp/white%20space.txt",
+		];
+
+		let paths = vec![
+			PathBuf::from("/tmp/bar.log"),
+			PathBuf::from("/tmp/test\\.txt"),
+			PathBuf::from("/tmp/foo?.png"),
+			PathBuf::from("/tmp/white space.txt"),
+		];
+		assert_eq!(paths_from_uri_list(file_list.join("\n")), paths);
+	}
+}

src/platform/linux/mod.rs

@@ -1,5 +1,4 @@
-use std::borrow::Cow;
-use std::io::Read;
+use std::{borrow::Cow, io::Read, path::PathBuf};
 
 use wl_clipboard_rs::{
 	copy::{self, Error as CopyError, MimeSource, MimeType, Options, Source},
@@ -9,7 +8,7 @@ use wl_clipboard_rs::{
 
 #[cfg(feature = "image-data")]
 use super::encode_as_png;
-use super::{into_unknown, LinuxClipboardKind, WaitConfig};
+use super::{into_unknown, paths_from_uri_list, LinuxClipboardKind, WaitConfig};
 use crate::common::Error;
 #[cfg(feature = "image-data")]
 use crate::common::ImageData;
@@ -182,4 +181,12 @@ impl Clipboard {
 		opts.copy(source, MimeType::Specific(MIME_PNG.into())).map_err(into_unknown)?;
 		Ok(())
 	}
+
+	pub(crate) fn get_file_list(
+		&mut self,
+		selection: LinuxClipboardKind,
+	) -> Result<Vec<PathBuf>, Error> {
+		self.string_for_mime(selection, paste::MimeType::Specific("text/uri-list"))
+			.map(paths_from_uri_list)
+	}
 }

src/platform/linux/wayland.rs

@@ -16,6 +16,7 @@ use std::{
 	borrow::Cow,
 	cell::RefCell,
 	collections::{hash_map::Entry, HashMap},
+	path::PathBuf,
 	sync::{
 		atomic::{AtomicBool, Ordering},
 		Arc,
@@ -44,7 +45,7 @@ use x11rb::{
 
 #[cfg(feature = "image-data")]
 use super::encode_as_png;
-use super::{into_unknown, LinuxClipboardKind, WaitConfig};
+use super::{into_unknown, paths_from_uri_list, LinuxClipboardKind, WaitConfig};
 #[cfg(feature = "image-data")]
 use crate::ImageData;
 use crate::{common::ScopeGuard, Error};
@@ -77,6 +78,7 @@ x11rb::atom_manager! {
 		TEXT_MIME_UNKNOWN: b"text/plain",
 
 		HTML: b"text/html",
+		URI_LIST: b"text/uri-list",
 
 		PNG_MIME: b"image/png",
 
@@ -929,6 +931,14 @@ impl Clipboard {
 		let data = vec![ClipboardData { bytes: encoded, format: self.inner.atoms.PNG_MIME }];
 		self.inner.write(data, selection, wait)
 	}
+
+	pub(crate) fn get_file_list(&self, selection: LinuxClipboardKind) -> Result<Vec<PathBuf>> {
+		let result = self.inner.read(&[self.inner.atoms.URI_LIST], selection)?;
+
+		String::from_utf8(result.bytes)
+			.map_err(|_| Error::ConversionFailure)
+			.map(paths_from_uri_list)
+	}
 }
 
 impl Drop for Clipboard {

src/platform/linux/x11.rs

@@ -17,11 +17,15 @@ use objc2::{
 	runtime::ProtocolObject,
 	ClassType,
 };
-use objc2_app_kit::{NSPasteboard, NSPasteboardTypeHTML, NSPasteboardTypeString};
-use objc2_foundation::{ns_string, NSArray, NSString};
+use objc2_app_kit::{
+	NSPasteboard, NSPasteboardTypeHTML, NSPasteboardTypeString,
+	NSPasteboardURLReadingFileURLsOnlyKey,
+};
+use objc2_foundation::{ns_string, NSArray, NSDictionary, NSNumber, NSString, NSURL};
 use std::{
 	borrow::Cow,
 	panic::{RefUnwindSafe, UnwindSafe},
+	path::PathBuf,
 };
 
 /// Returns an NSImage object on success.
@@ -236,6 +240,35 @@ impl<'clipboard> Get<'clipboard> {
 			bytes: rgba.into_raw().into(),
 		})
 	}
+
+	pub(crate) fn file_list(self) -> Result<Vec<PathBuf>, Error> {
+		autoreleasepool(|_| {
+			let class_array = NSArray::from_slice(&[NSURL::class()]);
+			let options = NSDictionary::from_slices(
+				&[unsafe { NSPasteboardURLReadingFileURLsOnlyKey }],
+				&[NSNumber::new_bool(true).as_ref()],
+			);
+			let objects = unsafe {
+				self.clipboard
+					.pasteboard
+					.readObjectsForClasses_options(&class_array, Some(&options))
+			};
+
+			objects
+				.map(|array| {
+					array
+						.iter()
+						.filter_map(|obj| {
+							obj.downcast::<NSURL>().ok().and_then(|url| {
+								unsafe { url.path() }.map(|p| PathBuf::from(p.to_string()))
+							})
+						})
+						.collect::<Vec<_>>()
+				})
+				.filter(|file_list| !file_list.is_empty())
+				.ok_or(Error::ContentNotAvailable)
+		})
+	}
 }
 
 pub(crate) struct Set<'clipboard> {

src/platform/osx.rs

@@ -11,7 +11,7 @@ and conditions of the chosen license apply to this file.
 #[cfg(feature = "image-data")]
 use crate::common::ImageData;
 use crate::common::{private, Error};
-use std::{borrow::Cow, marker::PhantomData, thread, time::Duration};
+use std::{borrow::Cow, marker::PhantomData, path::PathBuf, thread, time::Duration};
 
 #[cfg(feature = "image-data")]
 mod image_data {
@@ -635,6 +635,16 @@ impl<'clipboard> Get<'clipboard> {
 
 		image_data::read_cf_dibv5(&data)
 	}
+
+	pub(crate) fn file_list(self) -> Result<Vec<PathBuf>, Error> {
+		let _clipboard_assertion = self.clipboard?;
+
+		let mut file_list = Vec::new();
+		clipboard_win::raw::get_file_list_path(&mut file_list)
+			.map_err(|_| Error::ContentNotAvailable)?;
+
+		Ok(file_list)
+	}
 }
 
 pub(crate) struct Set<'clipboard> {