glongman-otv-ffiruby-filemagic 0.2.0 → 0.3.0

data/README

@@ -1,6 +1,8 @@
 ffiruby-filemagic
 =================
 
+Win32 Support? sorry.
+
 A new implementation of the ancient ruby-filemagic gem (http://grub.ath.cx/filemagic/). 
 
 This version uses FFI to talk to the native library (JRuby friendly).
@@ -15,27 +17,45 @@ What is FileMagic?
 
 Install:
 
-Make sure you have the magic(4) library installed. On OSX this can be done using MacPorts (http://www.macports.org/)
+Make sure you have the magic(4) library installed. 
 
-> sudo port install file
 > sudo gem sources -a http://gems.github.com
 > sudo gem install glongman-otv-ffiruby-filemagic
 
- - Linux? should just work 
- - Cygwin? no idea, never use it
- - Windows? see above
-
-Usage:
+After Install:
 
 > irb
 >> require 'ffi_file_magic'
 => true
 >> fm = FFIFileMagic.new(FFIFileMagic::MAGIC_MIME)
 => #<FFIFileMagic:0x11a4d9c @cookie=#<Native Pointer address=0x13606f0>>
->> fm.file('rails.png')
+>> fm.file('rails.png') #supply a path to your own image
 => "image/png"
 >> 
 
+Install Problems?
+ 
+If the gem complains that it can't find the magic library you can run the setup.rb file
+in the root of the gem
+
+> sudo ruby /path/to/ffiruby-filemagic/setup.rb    (where is the gem? 'gem contents ffiruby-filemagic')
+
+Without any arguments setup.rb will look around the filesystem for a magic library and test to see if
+that library is compatible. If so a small modification will be made so the gem will work.
+
+You can run setup.rb more than once. 
+
+you can also tell setup.rb exactly where to look for the magic libary
+
+> sudo ruby /path/to/ffiruby-filemagic/setup.rb --with-magic-lib=/opt/local/lib
+
+This gem has been tested with the magic library shipped with File 4.26 from ftp://ftp.astron.com/pub/file
+
+On OSX, and at the time of writing this, you can get file using macports (http://www.macports.org/)
+
+> sudo port install file
+
+On other Unix variants, download the source, build and install. then run setup.rb
 
 COPYRIGHT
 =========

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
+require 'ruby-debug'
 
 begin
   require 'jeweler'
@@ -12,7 +13,7 @@ begin
     s.description = %Q{new implementation of the ancient ruby-filemagic gem. Uses FFI to talk to native library}
     s.authors = ["Geoff Longman"]
     s.add_dependency 'ffi'
-    s.files =  FileList["[A-Z]*", "{lib,test}/**/*"]
+    s.files =  FileList["setup.rb", "[A-Z]*", "{lib,test}/**/*"]
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :patch: 0
 :major: 0
-:minor: 2
+:minor: 3

data/lib/ffi_file_magic.rb

@@ -1,116 +1 @@
-require 'rubygems'
-require 'ffi'
-class FFIFileMagicError < StandardError; end
-class FFIFileMagic
-  # constants (see magic.h)
-  MAGIC_NONE              =0x000000 # No flags 
-  MAGIC_DEBUG		          =0x000001 # Turn on debugging 
-  MAGIC_SYMLINK		        =0x000002 # Follow symlinks 
-  MAGIC_COMPRESS		      =0x000004 # Check inside compressed files 
-  MAGIC_DEVICES		        =0x000008 # Look at the contents of devices 
-  MAGIC_MIME_TYPE		      =0x000010 # Return only the MIME type 
-  MAGIC_CONTINUE		      =0x000020 # Return all matches 
-  MAGIC_CHECK		          =0x000040 # Print warnings to stderr 
-  MAGIC_PRESERVE_ATIME	  =0x000080 # Restore access time on exit 
-  MAGIC_RAW		            =0x000100 # Don't translate unprint chars 
-  MAGIC_ERROR		          =0x000200 # Handle ENOENT etc as real errors 
-  MAGIC_MIME_ENCODING	    =0x000400 # Return only the MIME encoding 
-  MAGIC_MIME              =(FFIFileMagic::MAGIC_MIME_TYPE|FFIFileMagic::MAGIC_MIME_ENCODING) 
-  MAGIC_NO_CHECK_COMPRESS	=0x001000 # Don't check for compressed files 
-  MAGIC_NO_CHECK_TAR	    =0x002000 # Don't check for tar files 
-  MAGIC_NO_CHECK_SOFT	    =0x004000 # Don't check magic entries 
-  MAGIC_NO_CHECK_APPTYPE  =0x008000 # Don't check application type 
-  MAGIC_NO_CHECK_ELF	    =0x010000 # Don't check for elf details 
-  MAGIC_NO_CHECK_ASCII	  =0x020000 # Don't check for ascii files 
-  MAGIC_NO_CHECK_TOKENS	  =0x100000 # Don't check ascii/tokens
-  
-  def initialize(flags)
-    @cookie = Native::magic_open(flags)
-    raise "out of memory" unless @cookie
-    raise  FFIFileMagicError, Native::magic_error(@cookie) if Native::magic_load(@cookie, nil) == -1
-  end
-  
-  def check_cookie
-    raise "invalid state: closed" unless @cookie
-  end
-  
-  # returns a textual description of the contents of the filename argument
-  def file(filename)
-    check_cookie
-    raise  FFIFileMagicError, Native::magic_error(@cookie) if (result = Native::magic_file(@cookie, filename)) == nil
-    result
-  end
-  
-  # returns a textual description of the contents of the string argument
-  def buffer(string)
-    check_cookie
-    raise  FFIFileMagicError, Native::magic_error(@cookie) if (result = Native::magic_buffer(@cookie, string, string.length)) == nil
-    result
-  end
- 
-  # checks the validity of entries in the colon separated database files passed in as filename
-  def check(filename)
-    check_cookie
-    Native::magic_check(@cookie, filename);
-  end
-  # compile the the colon separated list of database files passed in as filename
-  def compile(filename)
-    check_cookie
-    Native::magic_compile(@cookie, filename);
-  end
-  
-  # closes the magic database and frees any memory allocated.
-  # if memory is a concern, use this.
-  def close
-    check_cookie
-    Native::magic_close(@cookie);
-    @cookie = nil
-  end
-  
-  module Native
-    extend FFI::Library
-    
-    begin
-      ffi_lib 'magic'
-    rescue LoadError
-      libsuffix = %x(uname -a) =~ /Darwin/ ? '.dylib' : '.so'
-      ffi_lib "/opt/local/lib/libmagic" + libsuffix
-    end
-    
-    #magic_t is a pointer (I think)
-    #magic_t magic_open(int);
-    attach_function :magic_open, [:int], :pointer
-    
-    #void magic_close(magic_t);
-    attach_function :magic_close, [:pointer], :void
-    
-    # const char *magic_file(magic_t, const char *);
-    attach_function :magic_file, [:pointer, :string], :string
-    
-    # const char *magic_descriptor(magic_t, int);
-    attach_function :magic_descriptor, [:pointer, :int], :string
-    
-    # const char *magic_buffer(magic_t, const void *, size_t);
-    attach_function :magic_buffer, [:pointer, :pointer, :int], :string
-    
-    # const char *magic_error(magic_t);
-    attach_function :magic_error, [:pointer], :string
-    
-    # int magic_setflags(magic_t, int);
-    attach_function :magic_setflags, [:pointer, :int], :int
-
-    # int magic_load(magic_t, const char *);
-    attach_function :magic_load, [:pointer, :string], :int
-    
-    # int magic_compile(magic_t, const char *);
-    attach_function :magic_compile, [:pointer, :string], :int
-    
-    # int magic_check(magic_t, const char *);
-    attach_function :magic_check, [:pointer, :string], :int
-    
-    # int magic_errno(magic_t);
-    attach_function :magic_errno, [:pointer], :int
-    
-  end
-end
-
+require File.dirname(__FILE__) + '/ffi_file_magic/ffi_file_magic.rb'

data/lib/ffi_file_magic/ffi_file_magic.rb

@@ -0,0 +1,111 @@
+require 'rubygems'
+require 'ffi'
+require File.expand_path(File.dirname(__FILE__) + '/load_library.rb')
+class FFIFileMagicError < StandardError; end
+class FFIFileMagic
+  INSTALL_PATH = nil #installation found libmagic here
+  # constants (see magic.h)
+  MAGIC_NONE              =0x000000 # No flags 
+  MAGIC_DEBUG		          =0x000001 # Turn on debugging 
+  MAGIC_SYMLINK		        =0x000002 # Follow symlinks 
+  MAGIC_COMPRESS		      =0x000004 # Check inside compressed files 
+  MAGIC_DEVICES		        =0x000008 # Look at the contents of devices 
+  MAGIC_MIME_TYPE		      =0x000010 # Return only the MIME type 
+  MAGIC_CONTINUE		      =0x000020 # Return all matches 
+  MAGIC_CHECK		          =0x000040 # Print warnings to stderr 
+  MAGIC_PRESERVE_ATIME	  =0x000080 # Restore access time on exit 
+  MAGIC_RAW		            =0x000100 # Don't translate unprint chars 
+  MAGIC_ERROR		          =0x000200 # Handle ENOENT etc as real errors 
+  MAGIC_MIME_ENCODING	    =0x000400 # Return only the MIME encoding 
+  MAGIC_MIME              =(FFIFileMagic::MAGIC_MIME_TYPE|FFIFileMagic::MAGIC_MIME_ENCODING) 
+  MAGIC_NO_CHECK_COMPRESS	=0x001000 # Don't check for compressed files 
+  MAGIC_NO_CHECK_TAR	    =0x002000 # Don't check for tar files 
+  MAGIC_NO_CHECK_SOFT	    =0x004000 # Don't check magic entries 
+  MAGIC_NO_CHECK_APPTYPE  =0x008000 # Don't check application type 
+  MAGIC_NO_CHECK_ELF	    =0x010000 # Don't check for elf details 
+  MAGIC_NO_CHECK_ASCII	  =0x020000 # Don't check for ascii files 
+  MAGIC_NO_CHECK_TOKENS	  =0x100000 # Don't check ascii/tokens
+  
+  def initialize(flags)
+    @cookie = Native::magic_open(flags)
+    raise "out of memory" unless @cookie
+    raise  FFIFileMagicError, Native::magic_error(@cookie) if Native::magic_load(@cookie, nil) == -1
+  end
+  
+  def check_cookie
+    raise "invalid state: closed" unless @cookie
+  end
+  
+  # returns a textual description of the contents of the filename argument
+  def file(filename)
+    check_cookie
+    raise  FFIFileMagicError, Native::magic_error(@cookie) if (result = Native::magic_file(@cookie, filename)) == nil
+    result
+  end
+  
+  # returns a textual description of the contents of the string argument
+  def buffer(string)
+    check_cookie
+    raise  FFIFileMagicError, Native::magic_error(@cookie) if (result = Native::magic_buffer(@cookie, string, string.length)) == nil
+    result
+  end
+  
+  # checks the validity of entries in the colon separated database files passed in as filename
+  def check(filename)
+    check_cookie
+    Native::magic_check(@cookie, filename);
+  end
+  # compile the the colon separated list of database files passed in as filename
+  def compile(filename)
+    check_cookie
+    Native::magic_compile(@cookie, filename);
+  end
+  
+  # closes the magic database and frees any memory allocated.
+  # if memory is a concern, use this.
+  def close
+    check_cookie
+    Native::magic_close(@cookie);
+    @cookie = nil
+  end
+  
+  module Native
+    extend FFI::Library
+    include FFIFileMagic::Native::LoadLibrary
+    
+    #magic_t is a pointer (I think)
+    #magic_t magic_open(int);
+    attach_function :magic_open, [:int], :pointer
+    
+    #void magic_close(magic_t);
+    attach_function :magic_close, [:pointer], :void
+    
+    # const char *magic_file(magic_t, const char *);
+    attach_function :magic_file, [:pointer, :string], :string
+    
+    # const char *magic_descriptor(magic_t, int);
+    attach_function :magic_descriptor, [:pointer, :int], :string
+    
+    # const char *magic_buffer(magic_t, const void *, size_t);
+    attach_function :magic_buffer, [:pointer, :pointer, :int], :string
+    
+    # const char *magic_error(magic_t);
+    attach_function :magic_error, [:pointer], :string
+    
+    # int magic_setflags(magic_t, int);
+    attach_function :magic_setflags, [:pointer, :int], :int
+    
+    # int magic_load(magic_t, const char *);
+    attach_function :magic_load, [:pointer, :string], :int
+    
+    # int magic_compile(magic_t, const char *);
+    attach_function :magic_compile, [:pointer, :string], :int
+    
+    # int magic_check(magic_t, const char *);
+    attach_function :magic_check, [:pointer, :string], :int
+    
+    # int magic_errno(magic_t);
+    attach_function :magic_errno, [:pointer], :int
+    
+  end
+end

data/lib/ffi_file_magic/load_library.rb

@@ -0,0 +1,12 @@
+class FFIFileMagic
+  module Native
+    module LoadLibrary
+      def self.included(base)
+        base.class_eval do
+          # setup.rb found this library as suitable
+          ffi_lib '/opt/local/lib/libmagic.dylib'
+        end
+      end
+    end
+  end 
+end

data/setup.rb

@@ -0,0 +1,131 @@
+require 'optparse'
+require "rubygems"
+require "ffi"
+
+
+libname = FFI.map_library_name('magic')
+
+module FFIFileMagic
+  module Checker
+    def self.check_lib(path)
+      begin
+        dylib = FFI::DynamicLibrary.open(path, FFI::DynamicLibrary::RTLD_LAZY | FFI::DynamicLibrary::RTLD_LOCAL)
+      rescue LoadError
+        return
+      end
+      puts "checking for needed methods in #{dylib.name}"
+      result = true
+      [:magic_open,   :magic_close,   :magic_file,
+       :magic_buffer, :magic_error,   :magic_setflags,
+       :magic_load,   :magic_compile, :magic_check,
+       :magic_errno].each do |method|
+         result &= begin
+           print "\tmethod exists? #{method} ... "
+           if dylib.find_symbol(method.to_s) 
+             puts "yes"; true
+           else
+             puts "no"; false
+           end
+         end
+      end
+      if result
+        puts "\t#{dylib.name} suitable? ... #{result ? 'yes' : 'no'}"; return dylib
+      end
+    end
+  end
+end
+#sorry, no windows
+if RUBY_PLATFORM =~ /mswin/
+  raise <<END_MSWIN
+\nInstall Failed
++--------------------------------------------------------------------+
+| This gem is for use only on Linux, BSD, OS X, and similar systems. |
++--------------------------------------------------------------------+
+END_MSWIN
+end
+
+op = nil
+ARGV.options do |op|
+  op.def_option('--with-magic-lib=ARBITRARY', '-l', 'arg') do |arg|
+    puts arg
+    $user_lib_path = File.join(arg, libname) if arg
+  end
+end
+ARGV.options.parse!
+
+dylib = nil
+if $user_lib_path
+  #user supplied
+  dylib = FFIFileMagic::Checker.check_lib($user_lib_path)
+  puts "No suitable magic library found at #{$user_lib_path}" unless dylib
+end
+
+
+unless dylib || $user_lib_path
+  # no fuss, no muss?
+  dylib = default_dylib = FFIFileMagic::Checker.check_lib('magic')
+end
+
+unless dylib || $user_lib_path
+  #check some usual suspects
+  paths = %w{ /lib/ /usr/lib/ /usr/local/lib/ /opt/local/lib/}
+  found_path = nil
+  paths.uniq.each do |path|
+     full_path = path + libname
+  	 if File.exist? full_path
+  	   begin
+  	     break if (dylib = FFIFileMagic::Checker.check_lib(full_path))
+	     rescue LoadError; end
+     end
+  end
+end
+
+unless dylib
+  raise <<END_FAIL
+\nInstall Failed
++----------------------------------------------------------------------------+
+| Could not find a suitable magic library.                                   |
+|                                                                            |
+| OSX - use macports               http://www.macports.org/                  |
+|     > port install file                                                    |
+|                                                                            |
+| Others - build file from source - ftp://ftp.astron.com/pub/file/           |
++----------------------------------------------------------------------------+
+END_FAIL
+end
+
+template =<<END_TEMPLATE
+class FFIFileMagic
+  module Native
+    module LoadLibrary
+      def self.included(base)
+        base.class_eval do
+          # setup.rb found this library as suitable
+          ffi_lib '#{dylib.name}'
+        end
+      end
+    end
+  end 
+end
+END_TEMPLATE
+
+if dylib
+  print "writing path #{dylib.name} into lib/ffi_file_magic/load_library.rb ...."
+  load_library = File.expand_path(File.dirname(__FILE__) + '/lib/ffi_file_magic/load_library.rb')
+  File.open(load_library, 'w') do |file|
+    file.write template
+  end
+  puts "success"
+end
+
+puts "\n Finished."
+
+
+
+
+
+
+
+
+
+

data/test/ffiruby_filemagic_test.rb

@@ -1,12 +1,12 @@
 require File.dirname(__FILE__) + '/test_helper'
-require 'ruby-debug'
+
 class TestFFIFileMagic < Test::Unit::TestCase
   BASE = File.expand_path(File.dirname(__FILE__)) + "/"
   FILE = BASE + "pyfile"
   LINK = BASE + 'pylink'
   COMPRESSED = BASE + 'pyfile-compressed.gz'
   PERL = BASE + "perl"
-  DB = File.expand_path(BASE + '../perl.mgc')
+  DB = File.expand_path(BASE + '/perl.mgc')
   def test_file
     fm = FFIFileMagic.new(FFIFileMagic::MAGIC_NONE)  
     res = fm.file FILE
@@ -51,13 +51,15 @@ class TestFFIFileMagic < Test::Unit::TestCase
     fm.close
     assert_equal(0, res)
   end
-
+  
   def test_compile
-    fm = FFIFileMagic.new(FFIFileMagic::MAGIC_NONE)
-    res = fm.compile PERL
-    fm.close
-    assert_equal(0, res)
-    File.unlink DB
+    Dir.chdir(File.dirname(__FILE__)) do
+      fm = FFIFileMagic.new(FFIFileMagic::MAGIC_NONE)
+      res = fm.compile PERL
+      fm.close
+      assert_equal(0, res)
+      File.unlink DB
+    end
   end
   
   def file(name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: glongman-otv-ffiruby-filemagic
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Geoff Longman
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-03 00:00:00 -08:00
+date: 2009-02-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ffi
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -30,10 +31,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- setup.rb
 - LICENSE
 - Rakefile
 - README
 - VERSION.yml
+- lib/ffi_file_magic
+- lib/ffi_file_magic/ffi_file_magic.rb
+- lib/ffi_file_magic/load_library.rb
 - lib/ffi_file_magic.rb
 - test/ffiruby_filemagic_test.rb
 - test/leaktest.rb