libmagic_rb 0.1.1.pre.alpha → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9742d29b9e36ec2a6de0079d215965133e97a7f9f03fc9d568b678c229e1c104
-  data.tar.gz: ebc7eccd373d353a3954946d0d88ef92956d478d36fbc4509c7c3cc029fa5de7
+  metadata.gz: 8ac744f446c39849d74275d6f3fd08a40222b3b40894a4ec0c419573c44d819e
+  data.tar.gz: 7fb5c5bbec7cc46fe1a1e2833d50e75d0212b528b9c70d34c0b3bebd8c71bc88
 SHA512:
-  metadata.gz: ea9103f6c7eb96a772e1d712f6a09547c753dee9561c3196de841d998c9200d1104b8fb03b702d8c025c438b9ad728658ff405ffc95e546afa7d834809bb75a7
-  data.tar.gz: 3d0d0bf0308e8472fd77019c3deb00a55869f5a2576b230682690d291023eff69700203b7ec13a3b4b0f1323824f2c61b2bfe281b0dca8ef33dc48c80c374fa5
+  metadata.gz: 639b9571220fe58e27d7b67a48d942232cccdaf7c3e8b66089f27a9bb274d419a73df81b343aaa016ffb5e20193d2b000733d472ea0a6d463bc3a1e05be4f0ba
+  data.tar.gz: 03aba90d37ecca84e1129634f4fbcde15c5c432092e16e1e2b44be4779a1797580fda46acb024eb058eb374dc86e2afed9819ad22f6b669f269774e65f2660d8

data/README.md

@@ -3,21 +3,33 @@ Adds ability to check mime-type of a file using the libmagic ([magic(4)](https:/
 It uses native extensions and it's quite performant.
 
 ## Pre-Installation
-On Linux, you need to install libmagic.
+On Linux, you need to install libmagic. The version we recommend is at least 5.36.
+But if you have an older version of libmagic, it will compile and work flawlessly but with a few caveats:
 
-##### Arch
++ Many constants (modes and params) will be not defined
++ LibmagicRb::MAGIC_VERSION constant will be set to 0.
++ Few methods will not work.
+  some methods that can return a String or Integer will return nil (like setparam and getparam).
+
+[ Do note that the minimum tested version is 5.11, older than that may fail to compile the gem ]
+
+You also need Ruby > 1.9.0 in order to run this gem.
+
+With that info in mind, let's continue to the installation part for your Linux distributions...
+
+#### Arch / Manjaro / Archlabs & other Arch based Linux
 
 ```
 # pacman -S file gcc make
 ```
 
-#### Debian / Ubuntu / Linux Mint / Kali / ParrotOS / RaspberryPi OS
+#### Debian / Ubuntu / Linux Mint / RaspberryPi OS & other Debian based Linux
 
 ```
 # apt install libmagic-dev ruby-dev gcc make
 ```
 
-#### Fedora
+#### Fedora / Amazon Linux / CentOS & Other RedHat based Linux
 
 ```
 # yum install file-devel ruby-devel gcc make
@@ -51,6 +63,9 @@ Or install it yourself as:
 $ gem install libmagic_rb
 ```
 
+We recommend getting the gem only from Rubygems.org. Do not download this repo as zip, compile to install the gem.
+A rubygem version is released after various tests. Any branch here including Master branch can be unstable can even segfault your app. You've been warned!
+
 ## Usage
 The target of this gem is to add mime-type checking easily.
 
@@ -162,18 +177,19 @@ cookie.setparam(LibmagicRb::MAGIC_PARAM_REGEX_MAX, 2 ** 14) # => 16384; but can
 
 #### Notes:
 
-+ To get the parameters, you can refer to the [man page](https://man7.org/linux/man-pages/man3/magic_getflags.3.html).
-+ Cookie setparam returns the value after getting the param as well. So you don't need to confirm by calling getparam() again.
++ To get the parameters, you can run `LibmagicRb.lsparams()` for description, please refer to the [man page](https://man7.org/linux/man-pages/man3/magic_getflags.3.html).
++ `cookie.setparam()` returns the value after getting the param as well. So you don't need to confirm by calling getparam() again.
 + The maximum size depends on the parameter. But the value that can be passed should not be more than 2 ** 32.
++ On older versions of libmagic, where the function isn't available, both getparam() and setparam() will perform no operations, and return nil!
 
 ## Errors
 The following errors are implemented and raised on appropriate situation:
 
-1. LibmagicRb::FileNotFound: When the file is not found.
-2. LibmagicRb::FileUnreadable: When the file is unreadable.
-3. LibmagicRb::InvalidDBError: When the database given is invalid.
-4. LibmagicRb::IsDirError: When the database path is a directory.
-5. LibmagicRb::FileClosedError: When the file is already closed (closed?()) but you are trying to access the cookie.
+1. `LibmagicRb::FileNotFound`: When the file is not found.
+2. `LibmagicRb::FileUnreadable`: When the file is unreadable.
+3. `LibmagicRb::InvalidDBError`: When the database given is invalid.
+4. `LibmagicRb::IsDirError`: When the database path is a directory.
+5. `LibmagicRb::FileClosedError`: When the file is already closed (closed?()) but you are trying to access the cookie.
 
 ## Development
 

data/ext/libmagic/func.h

@@ -52,29 +52,37 @@ VALUE _checkGlobal_(volatile VALUE self) {
 }
 
 VALUE _getParamGlobal_(volatile VALUE self, volatile VALUE param) {
-	RB_UNWRAP(cookie) ;
+	#if MAGIC_VERSION > 525
+		RB_UNWRAP(cookie) ;
 
-	unsigned int _param = NUM2UINT(param) ;
-	unsigned long value ;
+		unsigned int _param = NUM2UINT(param) ;
+		unsigned long value ;
 
-	int status = magic_getparam(*cookie, _param, &value) ;
-	if (status) return Qnil ;
-	return ULONG2NUM(value) ;
+		int status = magic_getparam(*cookie, _param, &value) ;
+		if (status) return Qnil ;
+		return ULONG2NUM(value) ;
+	#else
+		return Qnil ;
+	#endif
 }
 
 VALUE _setParamGlobal_(volatile VALUE self, volatile VALUE param, volatile VALUE paramVal) {
-	unsigned int _param = NUM2UINT(param) ;
-	unsigned long _paramVal = NUM2ULONG(paramVal) ;
+	#if MAGIC_VERSION > 525
+		unsigned int _param = NUM2UINT(param) ;
+		unsigned long _paramVal = NUM2ULONG(paramVal) ;
 
-	RB_UNWRAP(cookie) ;
+		RB_UNWRAP(cookie) ;
 
-	unsigned long value ;
-	magic_setparam(*cookie, _param, &_paramVal) ;
+		unsigned long value ;
+		magic_setparam(*cookie, _param, &_paramVal) ;
 
-	int status = magic_getparam(*cookie, _param, &value) ;
+		int status = magic_getparam(*cookie, _param, &value) ;
+		if (status) return Qnil ;
 
-	if (status) return Qnil ;
-	return ULONG2NUM((int)value) ;
+		return ULONG2NUM((int)value) ;
+	#else
+		return Qnil ;
+	#endif
 }
 
 VALUE _bufferGlobal_(volatile VALUE self, volatile VALUE string) {

data/ext/libmagic/magic.c

@@ -10,6 +10,10 @@
 #include "params.h"
 #include "definitions.h"
 
+#ifndef MAGIC_VERSION
+#define MAGIC_VERSION 0
+#endif
+
 /*
 * Errors
 */
@@ -111,14 +115,11 @@ VALUE rb_libmagicRb_initialize(volatile VALUE self, volatile VALUE args) {
 
 	VALUE argDBPath = rb_hash_aref(args, ID2SYM(rb_intern("db"))) ;
 
-	char *databasePath ;
 	if (RB_TYPE_P(argDBPath, T_NIL)) {
-		databasePath = NULL ;
 		rb_ivar_set(self, rb_intern("@db"), Qnil) ;
 	} else if (!RB_TYPE_P(argDBPath, T_STRING)) {
 		rb_raise(rb_eArgError, "Database name must be an instance of String.") ;
 	} else {
-		databasePath = StringValuePtr(argDBPath) ;
 		rb_ivar_set(self, rb_intern("@db"), argDBPath) ;
 	}
 
@@ -183,9 +184,13 @@ void Init_main() {
 	modes(cLibmagicRb) ;
 	params(cLibmagicRb) ;
 
-	char version[6] ;
-	sprintf(version, "%0.2f", magic_version() / 100.0) ;
-	rb_define_const(cLibmagicRb, "MAGIC_VERSION", rb_str_new_cstr(version)) ;
+	#if MAGIC_VERSION > 525
+		char version[6] ;
+		sprintf(version, "%0.2f", magic_version() / 100.0) ;
+		rb_define_const(cLibmagicRb, "MAGIC_VERSION", rb_str_new_cstr(version)) ;
+	#else
+		rb_define_const(cLibmagicRb, "MAGIC_VERSION", rb_str_new_cstr("0")) ;
+	#endif
 
 	/*
 	* Singleton Methods

data/ext/libmagic/modes.h

@@ -15,24 +15,57 @@ void modes(volatile VALUE rb_klass) {
 	rb_define_const(rb_klass, "MAGIC_RAW", INT2FIX(MAGIC_RAW)) ;
 	rb_define_const(rb_klass, "MAGIC_ERROR", INT2FIX(MAGIC_ERROR)) ;
 	rb_define_const(rb_klass, "MAGIC_APPLE", INT2FIX(MAGIC_APPLE)) ;
+
+	#ifdef MAGIC_EXTENSION
 	rb_define_const(rb_klass, "MAGIC_EXTENSION", INT2FIX(MAGIC_EXTENSION)) ;
+	#endif
+
+	#ifdef MAGIC_COMPRESS_TRANSP
 	rb_define_const(rb_klass, "MAGIC_COMPRESS_TRANSP", INT2FIX(MAGIC_COMPRESS_TRANSP)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_APPTYPE
 	rb_define_const(rb_klass, "MAGIC_NO_CHECK_APPTYPE", INT2FIX(MAGIC_NO_CHECK_APPTYPE)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_CDF
 	rb_define_const(rb_klass, "MAGIC_NO_CHECK_CDF", INT2FIX(MAGIC_NO_CHECK_CDF)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_COMPRESS
 	rb_define_const(rb_klass, "MAGIC_NO_CHECK_COMPRESS", INT2FIX(MAGIC_NO_CHECK_COMPRESS)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_ELF
 	rb_define_const(rb_klass, "MAGIC_NO_CHECK_ELF", INT2FIX(MAGIC_NO_CHECK_ELF)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_ENCODING
 	rb_define_const(rb_klass, "MAGIC_NO_CHECK_ENCODING", INT2FIX(MAGIC_NO_CHECK_ENCODING)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_SOFT
 	rb_define_const(rb_klass, "MAGIC_NO_CHECK_SOFT", INT2FIX(MAGIC_NO_CHECK_SOFT)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_TAR
 	rb_define_const(rb_klass, "MAGIC_NO_CHECK_TAR", INT2FIX(MAGIC_NO_CHECK_TAR)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_TEXT
 	rb_define_const(rb_klass, "MAGIC_NO_CHECK_TEXT", INT2FIX(MAGIC_NO_CHECK_TEXT)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_TOKENS
 	rb_define_const(rb_klass, "MAGIC_NO_CHECK_TOKENS", INT2FIX(MAGIC_NO_CHECK_TOKENS)) ;
+	#endif
 
 	#ifdef MAGIC_NO_CHECK_JSON
-		rb_define_const(rb_klass, "MAGIC_NO_CHECK_JSON", INT2FIX(MAGIC_NO_CHECK_JSON)) ;
+	rb_define_const(rb_klass, "MAGIC_NO_CHECK_JSON", INT2FIX(MAGIC_NO_CHECK_JSON)) ;
 	#endif
 
 	#ifdef MAGIC_NO_CHECK_CSV
-		rb_define_const(rb_klass, "MAGIC_NO_CHECK_CSV", INT2FIX(MAGIC_NO_CHECK_CSV)) ;
+	rb_define_const(rb_klass, "MAGIC_NO_CHECK_CSV", INT2FIX(MAGIC_NO_CHECK_CSV)) ;
 	#endif
 }
 
@@ -53,24 +86,56 @@ VALUE lsmodes(volatile VALUE obj) {
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_RAW")), INT2FIX(MAGIC_RAW)) ;
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_ERROR")), INT2FIX(MAGIC_ERROR)) ;
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_APPLE")), INT2FIX(MAGIC_APPLE)) ;
+	#ifdef MAGIC_EXTENSION
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_EXTENSION")), INT2FIX(MAGIC_EXTENSION)) ;
+	#endif
+
+	#ifdef MAGIC_COMPRESS_TRANSP
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_COMPRESS_TRANSP")), INT2FIX(MAGIC_COMPRESS_TRANSP)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_APPTYPE
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_APPTYPE")), INT2FIX(MAGIC_NO_CHECK_APPTYPE)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_CDF
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_CDF")), INT2FIX(MAGIC_NO_CHECK_CDF)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_COMPRESS
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_COMPRESS")), INT2FIX(MAGIC_NO_CHECK_COMPRESS)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_ELF
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_ELF")), INT2FIX(MAGIC_NO_CHECK_ELF)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_ENCODING
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_ENCODING")), INT2FIX(MAGIC_NO_CHECK_ENCODING)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_SOFT
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_SOFT")), INT2FIX(MAGIC_NO_CHECK_SOFT)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_TAR
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_TAR")), INT2FIX(MAGIC_NO_CHECK_TAR)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_TEXT
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_TEXT")), INT2FIX(MAGIC_NO_CHECK_TEXT)) ;
+	#endif
+
+	#ifdef MAGIC_NO_CHECK_TOKENS
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_TOKENS")), INT2FIX(MAGIC_NO_CHECK_TOKENS)) ;
+	#endif
 
 	#ifdef  MAGIC_NO_CHECK_CSV
-		rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_CSV")), INT2FIX(MAGIC_NO_CHECK_CSV)) ;
+	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_CSV")), INT2FIX(MAGIC_NO_CHECK_CSV)) ;
 	#endif
 
 	#ifdef  MAGIC_NO_CHECK_CSV
-		rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_JSON")), INT2FIX(MAGIC_NO_CHECK_JSON)) ;
+	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_NO_CHECK_JSON")), INT2FIX(MAGIC_NO_CHECK_JSON)) ;
 	#endif
 
 	return hash ;

data/ext/libmagic/params.h

@@ -1,28 +1,62 @@
 void params(volatile VALUE rb_klass) {
+	#ifdef MAGIC_PARAM_INDIR_MAX
 	rb_define_const(rb_klass, "MAGIC_PARAM_INDIR_MAX", UINT2NUM(MAGIC_PARAM_INDIR_MAX)) ;
+	#endif
+
+	#ifdef MAGIC_PARAM_NAME_MAX
 	rb_define_const(rb_klass, "MAGIC_PARAM_NAME_MAX", UINT2NUM(MAGIC_PARAM_NAME_MAX)) ;
+	#endif
+
+	#ifdef MAGIC_PARAM_ELF_NOTES_MAX
 	rb_define_const(rb_klass, "MAGIC_PARAM_ELF_NOTES_MAX", UINT2NUM(MAGIC_PARAM_ELF_NOTES_MAX)) ;
+	#endif
+
+	#ifdef MAGIC_PARAM_ELF_PHNUM_MAX
 	rb_define_const(rb_klass, "MAGIC_PARAM_ELF_PHNUM_MAX", UINT2NUM(MAGIC_PARAM_ELF_PHNUM_MAX)) ;
+	#endif
+
+	#ifdef MAGIC_PARAM_ELF_SHNUM_MAX
 	rb_define_const(rb_klass, "MAGIC_PARAM_ELF_SHNUM_MAX", UINT2NUM(MAGIC_PARAM_ELF_SHNUM_MAX)) ;
+	#endif
+
+	#ifdef MAGIC_PARAM_REGEX_MAX
 	rb_define_const(rb_klass, "MAGIC_PARAM_REGEX_MAX", UINT2NUM(MAGIC_PARAM_REGEX_MAX)) ;
+	#endif
 
 	#ifdef MAGIC_PARAM_BYTES_MAX
-		rb_define_const(rb_klass, "MAGIC_PARAM_BYTES_MAX", UINT2NUM(MAGIC_PARAM_BYTES_MAX)) ;
+	rb_define_const(rb_klass, "MAGIC_PARAM_BYTES_MAX", UINT2NUM(MAGIC_PARAM_BYTES_MAX)) ;
 	#endif
 }
 
 VALUE lsparams(volatile VALUE obj) {
 	VALUE hash = rb_hash_new() ;
 
+	#ifdef MAGIC_PARAM_INDIR_MAX
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_PARAM_INDIR_MAX")), UINT2NUM(MAGIC_PARAM_INDIR_MAX)) ;
+	#endif
+
+	#ifdef MAGIC_PARAM_NAME_MAX
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_PARAM_NAME_MAX")), UINT2NUM(MAGIC_PARAM_NAME_MAX)) ;
+	#endif
+
+	#ifdef MAGIC_PARAM_ELF_NOTES_MAX
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_PARAM_ELF_NOTES_MAX")), UINT2NUM(MAGIC_PARAM_ELF_NOTES_MAX)) ;
+	#endif
+
+	#ifdef MAGIC_PARAM_ELF_PHNUM_MAX
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_PARAM_ELF_PHNUM_MAX")), UINT2NUM(MAGIC_PARAM_ELF_PHNUM_MAX)) ;
+	#endif
+
+	#ifdef MAGIC_PARAM_ELF_SHNUM_MAX
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_PARAM_ELF_SHNUM_MAX")), UINT2NUM(MAGIC_PARAM_ELF_SHNUM_MAX)) ;
+	#endif
+
+	#ifdef MAGIC_PARAM_REGEX_MAX
 	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_PARAM_REGEX_MAX")), UINT2NUM(MAGIC_PARAM_REGEX_MAX)) ;
+	#endif
 
 	#ifdef MAGIC_PARAM_BYTES_MAX
-		rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_PARAM_BYTES_MAX")), UINT2NUM(MAGIC_PARAM_BYTES_MAX)) ;
+	rb_hash_aset(hash, ID2SYM(rb_intern("MAGIC_PARAM_BYTES_MAX")), UINT2NUM(MAGIC_PARAM_BYTES_MAX)) ;
 	#endif
 
 	return hash ;

data/lib/libmagic_rb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class LibmagicRb
-  VERSION = "0.1.1-alpha"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libmagic_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1.pre.alpha
+  version: 0.1.1
 platform: ruby
 authors:
 - Cybergizer
@@ -47,9 +47,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.21
 signing_key: