glongman-otv-ffiruby-filemagic 0.1.0

data/VERSION.yml

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

data/lib/ffi_file_magic.rb

@@ -0,0 +1,116 @@
+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
+

data/test/ffiruby_filemagic_test.rb

@@ -0,0 +1,66 @@
+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')
+  def test_file
+    fm = FFIFileMagic.new(FFIFileMagic::MAGIC_NONE)  
+    res = fm.file FILE
+    assert_equal("a python script text executable", res)
+  end
+  
+  def test_symlink
+    File.symlink FILE, LINK
+    fm = FFIFileMagic.new(FFIFileMagic::MAGIC_NONE)
+    res = fm.file LINK
+    assert_match(/^symbolic link to `.*pyfile'$/, res)
+    fm.close
+    fm = FFIFileMagic.new(FFIFileMagic::MAGIC_SYMLINK)
+    res = fm.file LINK
+    assert_equal("a python script text executable", res)
+    fm.close
+    fm = FFIFileMagic.new(FFIFileMagic::MAGIC_SYMLINK | FFIFileMagic::MAGIC_MIME)
+    res = fm.file LINK
+    assert_equal("text/plain charset=us-ascii", res)
+    fm.close
+  ensure
+    File.unlink LINK
+  end
+  
+  def test_compressed
+    fm = FFIFileMagic.new(FFIFileMagic::MAGIC_COMPRESS)
+    res = fm.file COMPRESSED
+    assert_match(/^a python script text executable/, res)
+    fm.close
+  end
+
+  def test_buffer
+    fm = FFIFileMagic.new(FFIFileMagic::MAGIC_NONE)
+    res = fm.buffer("#!/bin/sh\n")
+    fm.close
+    assert_equal("POSIX shell script text executable", res)
+  end
+
+  def test_check
+    fm = FFIFileMagic.new(FFIFileMagic::MAGIC_NONE)
+    res = fm.check PERL
+    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
+  end
+  
+  def file(name)
+    File.expand_path(File.dirname(__FILE__)) + "/" + name
+  end
+end

data/test/leaktest.rb

@@ -0,0 +1,15 @@
+require '../filemagic'
+
+# watch -n 1 'ps aux | grep leaktest'
+
+def do_file(filename)
+  fm = FileMagic.new(0)
+  file = fm.file(filename)
+  fm.close
+  return file
+end
+
+loop do
+  puts do_file($0)
+  sleep 1
+end

data/test/perl

@@ -0,0 +1,19 @@
+
+#------------------------------------------------------------------------------
+# perl:  file(1) magic for Larry Wall's perl language.
+#
+# The ``eval'' line recognizes an outrageously clever hack for USG systems.
+# Keith Waclena <keith@cerberus.uchicago.edu>
+# Send additions to <perl5-porters@perl.org>
+0	string/b	#!\ /bin/perl			perl script text executable
+0	string		eval\ "exec\ /bin/perl		perl script text
+0	string/b	#!\ /usr/bin/perl		perl script text executable
+0	string		eval\ "exec\ /usr/bin/perl	perl script text
+0	string/b	#!\ /usr/local/bin/perl		perl script text
+0	string		eval\ "exec\ /usr/local/bin/perl	perl script text executable
+0	string		eval\ '(exit\ $?0)'\ &&\ eval\ 'exec	perl script text
+
+# a couple more, by me
+# XXX: christos matches
+#0	regex		package		Perl5 module source text (via regex)
+0	string		package		Perl5 module source text

data/test/pyfile

@@ -0,0 +1 @@
+"""

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/ffi_file_magic')
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: glongman-otv-ffiruby-filemagic
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Geoff Longman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-02 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: new implementation of the ancient ruby-filemagic gem. Uses FFI to talk to native library
+email: glongman@overlay.tv
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/ffi_file_magic.rb
+- test/ffiruby_filemagic_test.rb
+- test/leaktest.rb
+- test/perl
+- test/pyfile
+- test/pyfile-compressed.gz
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/glongman-otv/ffiruby-filemagic
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: new implementation of the ancient ruby-filemagic gem. Uses FFI to talk to native library
+test_files: []
+