Merge pull request #16 from robo9k/version-features

Features for `libmagic` API changes
robo9k · Oct 22, 2021 · dbf7897 · dbf7897
2 parents 2b04d1f + 6b1ff22
commit dbf7897
Show file tree

Hide file tree

Showing 4 changed files with 342 additions and 6 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -24,6 +24,23 @@ exclude = [
 ]
 rust-version = "1.38"
 
+[features]
+default = ["v5-38"]
+v5-04 = []
+v5-05 = ["v5-04"]
+v5-10 = ["v5-05"]
+v5-13 = ["v5-10"]
+v5-20 = ["v5-13"]
+v5-21 = ["v5-20"]
+v5-22 = ["v5-21"]
+v5-23 = ["v5-22"]
+v5-25 = ["v5-23"]
+v5-27 = ["v5-25"]
+v5-32 = ["v5-27"]
+v5-35 = ["v5-32"]
+v5-38 = ["v5-35"]
+v5-40 = ["v5-38"]
+
 [dependencies]
 libc = "0.2.13"
 
@@ -40,3 +57,7 @@ x86_64-pc-windows-msvc = { triplet="x64-windows-static-md" }
 
 [package.metadata]
 msrv = "1.38.0"
+
+[package.metadata.docs.rs]
+all-features = true
+targets = []
diff --git a/README.md b/README.md
@@ -21,6 +21,19 @@ The `rustdoc` is available on [docs.rs](https://docs.rs/magic-sys).
 
 # Requirements
 
+This crate requires the `libmagic` C library in version 5.
+
+You need to specify your `libmagic` version by activating the matching `magic-sys` feature.  
+Each API version has a crate feature like "v5-38" (v5.38 is also the default), see [Cargo.toml](Cargo.toml)  
+If you use a different version of `libmagic`, adjust your configuration:
+```toml
+[dependencies.magic-sys]
+version = "0.2.1"
+default-features = false
+features = ["v5-41"]
+```
+Note that those version features are additive, so "v5-41" implies "v5-40" and other previous versions.
+
 `libmagic` needs to be installed in a standard location (also see [issue #1](https://github.com/robo9k/rust-magic-sys/issues/1)).
 
 On a Debian based Linux system this can be achieved like this:

diff --git a/build.rs b/build.rs
@@ -49,8 +49,15 @@ fn main() {
     } else {
         if let Err(err) = vcpkg::find_package("libmagic") {
             println!("Could not find vcpkg package: {}", err);
+        } else if cfg!(windows) {
+            // workaround, see https://github.com/robo9k/rust-magic-sys/pull/16#issuecomment-949094327
+            println!("cargo:rustc-link-lib=shlwapi");
+
+            // vcpkg was successful, don't print anything else
+            return;
         }
 
+        // default fall through: try linking dynamically to just `libmagic` without further config
         println!("cargo:rustc-link-lib=dylib=magic");
     }
 }
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,19 +1,314 @@
 extern crate libc;
+#[cfg(feature = "v5-20")]
+use libc::c_void;
 use libc::{c_char, c_int, size_t};
 
-pub enum Magic {}
+// `libmagic` API as in "magic.h"
+
+// https://doc.rust-lang.org/nomicon/ffi.html#representing-opaque-structs
+#[repr(C)]
+pub struct Magic {
+    _data: [u8; 0],
+    _marker: core::marker::PhantomData<(*mut u8, core::marker::PhantomPinned)>,
+}
+
+pub const MAGIC_NONE: c_int = 0x000_0000;
+pub const MAGIC_DEBUG: c_int = 0x000_0001;
+pub const MAGIC_SYMLINK: c_int = 0x000_0002;
+pub const MAGIC_COMPRESS: c_int = 0x000_0004;
+pub const MAGIC_DEVICES: c_int = 0x000_0008;
+pub const MAGIC_MIME_TYPE: c_int = 0x000_0010;
+pub const MAGIC_CONTINUE: c_int = 0x000_0020;
+pub const MAGIC_CHECK: c_int = 0x000_0040;
+pub const MAGIC_PRESERVE_ATIME: c_int = 0x000_0080;
+pub const MAGIC_RAW: c_int = 0x000_0100;
+pub const MAGIC_ERROR: c_int = 0x000_0200;
+pub const MAGIC_MIME_ENCODING: c_int = 0x000_0400;
+pub const MAGIC_MIME: c_int = MAGIC_MIME_TYPE | MAGIC_MIME_ENCODING;
+pub const MAGIC_APPLE: c_int = 0x00_0800;
+#[cfg(feature = "v5-23")]
+pub const MAGIC_EXTENSION: c_int = 0x100_0000;
+#[cfg(feature = "v5-23")]
+pub const MAGIC_COMPRESS_TRANSP: c_int = 0x200_0000;
+#[cfg(feature = "v5-23")]
+pub const MAGIC_NODESC: c_int = MAGIC_EXTENSION | MAGIC_MIME | MAGIC_APPLE;
+
+pub const MAGIC_NO_CHECK_COMPRESS: c_int = 0x000_1000;
+pub const MAGIC_NO_CHECK_TAR: c_int = 0x000_2000;
+pub const MAGIC_NO_CHECK_SOFT: c_int = 0x000_4000;
+pub const MAGIC_NO_CHECK_APPTYPE: c_int = 0x000_8000;
+pub const MAGIC_NO_CHECK_ELF: c_int = 0x001_0000;
+pub const MAGIC_NO_CHECK_TEXT: c_int = 0x002_0000;
+pub const MAGIC_NO_CHECK_CDF: c_int = 0x004_0000;
+#[cfg(feature = "v5-38")]
+pub const MAGIC_NO_CHECK_CSV: c_int = 0x008_0000;
+pub const MAGIC_NO_CHECK_TOKENS: c_int = 0x010_0000;
+pub const MAGIC_NO_CHECK_ENCODING: c_int = 0x020_0000;
+#[cfg(feature = "v5-35")]
+pub const MAGIC_NO_CHECK_JSON: c_int = 0x040_0000;
+
+#[cfg(all(feature = "v5-05", not(feature = "v5-10")))]
+pub const MAGIC_NO_CHECK_BUILTIN: c_int = 0x3f_b000;
+#[cfg(all(feature = "v5-10", not(feature = "v5-35")))]
+pub const MAGIC_NO_CHECK_BUILTIN: c_int = MAGIC_NO_CHECK_COMPRESS |
+MAGIC_NO_CHECK_TAR      |
+// MAGIC_NO_CHECK_SOFT  |
+MAGIC_NO_CHECK_APPTYPE  |
+MAGIC_NO_CHECK_ELF      |
+MAGIC_NO_CHECK_TEXT     |
+MAGIC_NO_CHECK_CDF      |
+MAGIC_NO_CHECK_TOKENS   |
+MAGIC_NO_CHECK_ENCODING;
+#[cfg(all(feature = "v5-35", not(feature = "v5-38")))]
+pub const MAGIC_NO_CHECK_BUILTIN: c_int = MAGIC_NO_CHECK_COMPRESS |
+MAGIC_NO_CHECK_TAR      |
+// MAGIC_NO_CHECK_SOFT  |
+MAGIC_NO_CHECK_APPTYPE  |
+MAGIC_NO_CHECK_ELF      |
+MAGIC_NO_CHECK_TEXT     |
+MAGIC_NO_CHECK_CDF      |
+MAGIC_NO_CHECK_TOKENS   |
+MAGIC_NO_CHECK_ENCODING |
+MAGIC_NO_CHECK_JSON;
+#[cfg(feature = "v5-38")]
+pub const MAGIC_NO_CHECK_BUILTIN: c_int = MAGIC_NO_CHECK_COMPRESS |
+MAGIC_NO_CHECK_TAR      |
+// MAGIC_NO_CHECK_SOFT  |
+MAGIC_NO_CHECK_APPTYPE  |
+MAGIC_NO_CHECK_ELF      |
+MAGIC_NO_CHECK_TEXT     |
+MAGIC_NO_CHECK_CSV      |
+MAGIC_NO_CHECK_CDF      |
+MAGIC_NO_CHECK_TOKENS   |
+MAGIC_NO_CHECK_ENCODING |
+MAGIC_NO_CHECK_JSON;
+
+#[deprecated]
+pub const MAGIC_NO_CHECK_ASCII: c_int = MAGIC_NO_CHECK_TEXT;
+
+#[deprecated]
+pub const MAGIC_NO_CHECK_FORTRAN: c_int = 0x00_0000;
+#[deprecated]
+pub const MAGIC_NO_CHECK_TROFF: c_int = 0x00_0000;
+
+// TODO: MAGIC_VERSION string
+
+// TODO: MAGIC_SNPRINTB bytes
+
+#[cfg(feature = "v5-21")]
+pub const MAGIC_PARAM_INDIR_MAX: c_int = 0;
+#[cfg(feature = "v5-21")]
+pub const MAGIC_PARAM_NAME_MAX: c_int = 1;
+#[cfg(feature = "v5-21")]
+pub const MAGIC_PARAM_ELF_PHNUM_MAX: c_int = 2;
+#[cfg(feature = "v5-21")]
+pub const MAGIC_PARAM_ELF_SHNUM_MAX: c_int = 3;
+#[cfg(feature = "v5-22")]
+pub const MAGIC_PARAM_ELF_NOTES_MAX: c_int = 4;
+#[cfg(feature = "v5-25")]
+pub const MAGIC_PARAM_REGEX_MAX: c_int = 5;
+#[cfg(feature = "v5-27")]
+pub const MAGIC_PARAM_BYTES_MAX: c_int = 6;
+#[cfg(feature = "v5-40")]
+pub const MAGIC_PARAM_ENCODING_MAX: c_int = 7;
+
+// NOTE: the following are from `file.h`, but part of `magic.h` API
+#[cfg(feature = "v5-04")]
+pub const FILE_LOAD: c_int = 0;
+#[cfg(feature = "v5-04")]
+pub const FILE_CHECK: c_int = 1;
+#[cfg(feature = "v5-04")]
+pub const FILE_COMPILE: c_int = 2;
+#[cfg(feature = "v5-05")]
+pub const FILE_LIST: c_int = 3;
 
 extern "C" {
     pub fn magic_open(flags: c_int) -> *const Magic;
     pub fn magic_close(cookie: *const Magic);
-    pub fn magic_error(cookie: *const Magic) -> *const c_char;
-    pub fn magic_errno(cookie: *const Magic) -> *const c_int;
-    pub fn magic_descriptor(cookie: *const Magic, fd: c_int) -> *const c_char;
+
+    #[cfg(feature = "v5-04")]
+    pub fn magic_getpath(magicfile: *const c_char, action: c_int) -> *const c_char;
     pub fn magic_file(cookie: *const Magic, filename: *const c_char) -> *const c_char;
+    pub fn magic_descriptor(cookie: *const Magic, fd: c_int) -> *const c_char;
     pub fn magic_buffer(cookie: *const Magic, buffer: *const u8, length: size_t) -> *const c_char;
+
+    pub fn magic_error(cookie: *const Magic) -> *const c_char;
+    #[cfg(feature = "v5-32")]
+    pub fn magic_getflags(cookie: *const Magic) -> c_int;
+    #[must_use]
     pub fn magic_setflags(cookie: *const Magic, flags: c_int) -> c_int;
-    pub fn magic_check(cookie: *const Magic, filename: *const c_char) -> c_int;
+
+    #[cfg(feature = "v5-13")]
+    pub fn magic_version() -> c_int;
+    #[must_use]
+    pub fn magic_load(cookie: *const Magic, filename: *const c_char) -> c_int;
+    #[cfg(feature = "v5-20")]
+    #[must_use]
+    pub fn magic_load_buffers(
+        cookie: *const Magic,
+        buffers: *const *const c_void,
+        sizes: *const size_t,
+        nbuffers: size_t,
+    ) -> c_int;
+
+    #[must_use]
     pub fn magic_compile(cookie: *const Magic, filename: *const c_char) -> c_int;
+    #[must_use]
+    pub fn magic_check(cookie: *const Magic, filename: *const c_char) -> c_int;
+    #[cfg(feature = "v5-05")]
+    #[must_use]
     pub fn magic_list(cookie: *const Magic, filename: *const c_char) -> c_int;
-    pub fn magic_load(cookie: *const Magic, filename: *const c_char) -> c_int;
+    pub fn magic_errno(cookie: *const Magic) -> *const c_int;
+
+    #[cfg(feature = "v5-21")]
+    #[must_use]
+    pub fn magic_setparam(cookie: *const Magic, param: c_int, value: *const c_void) -> c_int;
+    #[cfg(feature = "v5-21")]
+    #[must_use]
+    pub fn magic_getparam(cookie: *const Magic, param: c_int, value: *mut c_void) -> c_int;
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    // Those tests are mostly just sanity checks to see if linkage works,
+    // they are NOT testing `libmagic` API/implementation
+
+    #[test]
+    fn test_magic_open() {
+        unsafe {
+            magic_open(MAGIC_NONE);
+        }
+    }
+
+    #[test]
+    fn test_magic_close() {
+        unsafe {
+            magic_close(std::ptr::null());
+        }
+    }
+
+    #[cfg(feature = "v5-04")]
+    #[test]
+    fn test_magic_getpath() {
+        unsafe {
+            magic_getpath(std::ptr::null(), FILE_CHECK);
+        }
+    }
+
+    #[test]
+    fn test_magic_file() {
+        unsafe {
+            magic_file(std::ptr::null(), std::ptr::null());
+        }
+    }
+
+    #[test]
+    fn test_magic_descriptor() {
+        unsafe {
+            magic_descriptor(std::ptr::null(), -1);
+        }
+    }
+
+    #[test]
+    fn test_magic_buffer() {
+        unsafe {
+            magic_buffer(std::ptr::null(), std::ptr::null(), 0);
+        }
+    }
+
+    #[test]
+    fn test_magic_error() {
+        unsafe {
+            magic_error(std::ptr::null());
+        }
+    }
+
+    #[cfg(feature = "v5-32")]
+    #[test]
+    fn test_magic_getflags() {
+        unsafe {
+            magic_getflags(std::ptr::null());
+        }
+    }
+
+    #[test]
+    fn test_magic_setflags() {
+        unsafe {
+            let _ = magic_setflags(std::ptr::null(), MAGIC_NONE);
+        }
+    }
+
+    #[cfg(feature = "v5-13")]
+    #[test]
+    fn test_magic_version() {
+        unsafe {
+            magic_version();
+        }
+    }
+
+    #[test]
+    fn test_magic_load() {
+        unsafe {
+            let _ = magic_load(std::ptr::null(), std::ptr::null());
+        }
+    }
+
+    #[cfg(feature = "v5-20")]
+    #[test]
+    fn test_magic_load_buffers() {
+        unsafe {
+            let _ = magic_load_buffers(std::ptr::null(), std::ptr::null(), std::ptr::null(), 0);
+        }
+    }
+
+    #[test]
+    fn test_magic_compile() {
+        unsafe {
+            let _ = magic_compile(std::ptr::null(), std::ptr::null());
+        }
+    }
+
+    #[test]
+    fn test_magic_check() {
+        unsafe {
+            let _ = magic_check(std::ptr::null(), std::ptr::null());
+        }
+    }
+
+    #[cfg(feature = "v5-05")]
+    #[test]
+    fn test_magic_list() {
+        unsafe {
+            let _ = magic_list(std::ptr::null(), std::ptr::null());
+        }
+    }
+
+    #[test]
+    fn test_magic_errno() {
+        unsafe {
+            magic_errno(std::ptr::null());
+        }
+    }
+
+    #[cfg(feature = "v5-21")]
+    #[test]
+    fn test_magic_setparam() {
+        unsafe {
+            let _ = magic_setparam(std::ptr::null(), MAGIC_PARAM_INDIR_MAX, std::ptr::null());
+        }
+    }
+
+    #[cfg(feature = "v5-21")]
+    #[test]
+    fn test_magic_getparam() {
+        unsafe {
+            let _ = magic_getparam(
+                std::ptr::null(),
+                MAGIC_PARAM_INDIR_MAX,
+                std::ptr::null_mut(),
+            );
+        }
+    }
 }