From 3bf0301e397dae074a782a2b7cc5730278cbf780 Mon Sep 17 00:00:00 2001
From: Chris Hennick <4961925+Pr0methean@users.noreply.github.com>
Date: Mon, 13 May 2024 19:52:14 -0700
Subject: [PATCH] feat: Add `is_symlink` method

---
 src/read.rs            |  18 ++++++++++++++++--
 src/types.rs           |   1 +
 src/write.rs           |   3 ++-
 tests/data/symlink.zip | Bin 0 -> 159 bytes
 4 files changed, 19 insertions(+), 3 deletions(-)
 create mode 100644 tests/data/symlink.zip

diff --git a/src/read.rs b/src/read.rs
index d717ee18..0025e2a7 100644
--- a/src/read.rs
+++ b/src/read.rs
@@ -87,6 +87,7 @@ use crate::result::ZipError::{InvalidPassword, UnsupportedArchive};
 use crate::spec::path_to_string;
 use crate::unstable::LittleEndianReadExt;
 pub use zip_archive::ZipArchive;
+use crate::types::ffi::S_IFLNK;
 
 #[allow(clippy::large_enum_variant)]
 pub(crate) enum CryptoReader<'a> {
@@ -1210,9 +1211,14 @@ impl<'a> ZipFile<'a> {
             .map_or(false, |c| c == '/' || c == '\\')
     }
 
-    /// Returns whether the file is a regular file
+    /// Returns whether the file is actually a symbolic link
+    pub fn is_symlink(&self) -> bool {
+        self.unix_mode().is_some_and(|mode| mode & S_IFLNK == S_IFLNK)
+    }
+
+    /// Returns whether the file is a normal file (i.e. not a directory or symlink)
     pub fn is_file(&self) -> bool {
-        !self.is_dir()
+        !self.is_dir() && !self.is_symlink()
     }
 
     /// Get unix mode for the file
@@ -1594,4 +1600,12 @@ mod test {
         let mut file = reader.by_index(0).unwrap();
         assert_eq!(file.read(&mut decompressed).unwrap(), 12);
     }
+
+    #[test]
+    fn test_is_symlink() {
+        let mut v = Vec::new();
+        v.extend_from_slice(include_bytes!("../tests/data/symlink.zip"));
+        let mut reader = ZipArchive::new(Cursor::new(v)).unwrap();
+        assert!(reader.by_index(0).unwrap().is_symlink())
+    }
 }
diff --git a/src/types.rs b/src/types.rs
index 00a851da..ab8d22da 100644
--- a/src/types.rs
+++ b/src/types.rs
@@ -11,6 +11,7 @@ use {crate::read::ZipFile, crate::write::FileOptions};
 pub(crate) mod ffi {
     pub const S_IFDIR: u32 = 0o0040000;
     pub const S_IFREG: u32 = 0o0100000;
+    pub const S_IFLNK: u32 = 0o0120000;
 }
 
 use crate::extra_fields::ExtraField;
diff --git a/src/write.rs b/src/write.rs
index e56aff02..e406ca2a 100644
--- a/src/write.rs
+++ b/src/write.rs
@@ -1,5 +1,6 @@
 //! Types for creating ZIP archives
 
+use crate::write::ffi::S_IFLNK;
 #[cfg(feature = "aes-crypto")]
 use crate::aes::AesWriter;
 use crate::compression::CompressionMethod;
@@ -1341,7 +1342,7 @@ impl<W: Write + Seek> ZipWriter<W> {
         if options.permissions.is_none() {
             options.permissions = Some(0o777);
         }
-        *options.permissions.as_mut().unwrap() |= 0o120000;
+        *options.permissions.as_mut().unwrap() |= S_IFLNK;
         // The symlink target is stored as file content. And compressing the target path
         // likely wastes space. So always store.
         options.compression_method = Stored;
diff --git a/tests/data/symlink.zip b/tests/data/symlink.zip
new file mode 100644
index 0000000000000000000000000000000000000000..2565bf79e5b6a7be2bf208d297af83d464e0143b
GIT binary patch
literal 159
zcmWIWW@h1H0D<Lm*G4F&7WXg%*$^zlkd#;y8p6rIY<a;c4TMW8xEUB({MF?|Sww)!
v((>~IycwC~m~ojP0Wug2-Yx`DVDnfZ=AoGt;LXYgQo;y?o<Q0G#9;scBFGuK

literal 0
HcmV?d00001