sys-filesystem 0.2.0 → 0.3.0

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.3.0 - 26-Feb-2009
+* Added support for OS X and FreeBSD thanks to an awesome patch by Nobuyoshi
+  Miyokawa.
+* Added the Filesystem.mount_point method that takes a file and returns
+  the mount point its sitting on.
+
 == 0.2.0 - 30-Dec-2008
 * Added the Filesystem.mounts method for iterating over mount or volume
   information.

data/README

@@ -13,7 +13,8 @@
    require 'sys/filesystem'
    include Sys
    
-   p Filesystem.stat("/")
+   # Display information about a particular filesystem.
+   p Filesystem.stat('/')
 
    # Sample output
 
@@ -33,11 +34,15 @@
       @blocks_free = 20301129
    >
    
+   # Describe all mount points on the system
    Filesystem.mounts{ |mount| p mount }
+   
+   # Find the mount point of any particular file
+   puts Filesystem.mount_point('/home/djberge/some_file.txt') => '/home'
 
 = Notes
 === MS Windows
-   This is a pure Ruby implementation using the windows-pr package, which in
+   This is a pure Ruby implementation using the windows-pr library, which in
    turn wraps native Windows functions.
 === UNIX
    This is a C extension that wraps statvfs, etc.
@@ -54,11 +59,15 @@
    Suggestions welcome.
 
 = Acknowledgements
-   Mike Hall, for ideas and code that I borrowed from his 'filesystem' package.
+   Mike Hall, for ideas and code that I borrowed from his 'filesystem'
+   library.
+   
    Park Heesob, for implementation and API ideas for the MS Windows version.
+   
+   Nobuyoshi Miyokawa, for adding FreeBSD and OS X support.
 
 = Copyright
-   (C) 2003-2008 Daniel J. Berger
+   (C) 2003-2009 Daniel J. Berger
    All Rights Reserved
 
 = Warranty

data/Rakefile

@@ -58,6 +58,10 @@ Rake::TestTask.new("test") do |t|
    t.test_files = FileList['test/test_sys_filesystem.rb']
 end
 
+task :test do
+   Rake.application[:clean].execute
+end
+
 desc "Run the example program"
 task :example => [:build] do |t|
    Dir.chdir('examples') do

data/ext/extconf.rb

@@ -7,6 +7,11 @@ have_header("sys/mnttab.h") || have_header("mntent.h")
 have_func("statvfs")
 have_func("getextmntent")
 
+if have_func("getmntinfo")
+   have_macro("MNT_NOATIME", "sys/mount.h")
+   have_macro("MNT_MULTILABEL", "sys/mount.h")
+end
+
 if have_header("sys/statvfs.h")
    have_struct_member("struct statvfs", "f_basetype", "sys/statvfs.h")
 else

data/ext/sys/filesystem.c

@@ -19,17 +19,35 @@
 #ifdef HAVE_SYS_MNTTAB_H  /* Solaris */
 
 #include <sys/mnttab.h>
-#define MNTENT	mnttab
+#define MNTENT mnttab
 #define START_MNT(F,M) fopen(F,M)
 #define GET_MNT(FP,MP) (getmntent(FP,MP) == 0)
 #define END_MNT(F) fclose(F)
 #define MOUNTFILE "/etc/mnttab"
 
+#elif HAVE_GETMNTINFO
+
+struct _ment {
+  struct statfs *mntbufp;
+  int current;
+  int max;
+};
+
+#include <sys/param.h>
+#include <sys/mount.h>
+#include <sys/vnode.h>
+
+#define MNTENT _ment
+#define START_MNT(F,M) start_mnt(F,M)
+#define GET_MNT(FP,MP) ((MP = get_mnt(MP)) != NULL)
+#define END_MNT(F) end_mnt(F)
+#define MOUNTFILE "getmntinfo"
+
 #else /* Most flavors of UNIX */
 
 #ifdef HAVE_MNTENT_H
 #include <mntent.h>
-#define MNTENT	mntent
+#define MNTENT mntent
 #define START_MNT(F,M) setmntent(F,M)
 #define GET_MNT(FP,MP) ((MP = getmntent(FP)) != NULL)
 #define END_MNT(F) endmntent(F)
@@ -38,6 +56,71 @@
 
 #endif
 
+#ifdef HAVE_GETMNTINFO
+
+/* below table comes from FreeBSD mount.c@1.105 */
+static struct opt {
+  int o_opt;
+  const char *o_name;
+} optnames[] = {
+  { MNT_ASYNC,    "asynchronous" },
+  { MNT_EXPORTED, "NFS exported" },
+  { MNT_LOCAL,    "local" },
+  { MNT_NOEXEC,      "noexec" },
+  { MNT_NOSUID,      "nosuid" },
+  { MNT_QUOTA,    "with quotas" },
+  { MNT_RDONLY,      "read-only" },
+  { MNT_SYNCHRONOUS, "synchronous" },
+  { MNT_UNION,    "union" },
+#ifdef HAVE_MNT_MULTILABEL
+  { MNT_MULTILABEL,  "multilabel" },
+#endif
+#ifdef HAVE_MNT_NOATIME
+  { MNT_NOATIME,  "noatime" },
+#endif
+#if !defined(__MACH__) || !defined(__APPLE__)
+  { MNT_NOSYMFOLLOW, "nosymfollow" },
+  { MNT_NOCLUSTERR,  "noclusterr" },
+  { MNT_NOCLUSTERW,  "noclusterw" },
+  { MNT_SUIDDIR,  "suiddir" },
+  { MNT_SOFTDEP,  "soft-updates" },
+  { MNT_ACLS,     "acls" },
+#endif
+  { 0, NULL }
+};
+
+static FILE* start_mnt(const char *filename, const char *type)
+{
+  return (FILE*)!0;     /* do nothing */
+}
+
+static struct _ment* get_mnt(struct _ment* m)
+{
+  struct _ment* ret = m;
+
+  if (m->max == 0) {
+    if ((m->max = getmntinfo(&(m->mntbufp), MNT_NOWAIT)) == 0) {
+      return NULL;      /* XXX */
+    }
+    m->current = 0;
+  }
+
+  if (m->current >= m->max) {
+    ret = NULL;
+  }
+  m->current++;
+
+  return ret;
+}
+
+static void end_mnt(FILE* fp)
+{
+  /* do nothing */
+}
+
+#endif
+
+
 VALUE mSys, cFilesys, cStat, cMount;
 
 static VALUE create_mount_object(struct MNTENT*);
@@ -63,7 +146,7 @@ static VALUE fs_stat(VALUE klass, VALUE v_path){
    struct proc p;
 
    if(VFS_STATFS(&mp, &fs, &p) < 0)
-      rb_sys_fail("VFS_STATFS");  
+      rb_sys_fail("VFS_STATFS");
 #endif
 
    v_stat = rb_funcall(cStat, rb_intern("new"), 0, 0);
@@ -148,8 +231,12 @@ static VALUE fs_mounts(VALUE klass){
    FILE* fp;
    struct MNTENT* mp;
 #ifdef HAVE_SYS_MNTTAB_H
-	struct MNTENT mt;
-	mp = &mt;
+   struct MNTENT mt;
+   mp = &mt;
+#elif HAVE_GETMNTINFO
+   struct MNTENT mt;
+   mt.max = 0;
+   mp = &mt;
 #endif
 
    v_array = Qnil;
@@ -168,7 +255,7 @@ static VALUE fs_mounts(VALUE klass){
    }
 
    END_MNT(fp);
-   
+
    return v_array; /* nil in block form */
 }
 
@@ -184,6 +271,32 @@ static VALUE create_mount_object(struct MNTENT* mp){
    rb_iv_set(v_mount, "@mount_time", rb_time_new(atoi(mp->mnt_time), 0));
    rb_iv_set(v_mount, "@dump_frequency", Qnil);
    rb_iv_set(v_mount, "@pass_number", Qnil);
+#elif HAVE_GETMNTINFO
+   {
+      struct statfs *p = mp->mntbufp + (mp->current-1);
+      struct opt *o;
+      int flags, mul;
+      char ostr[BUFSIZ];
+
+      flags = p->f_flags & MNT_VISFLAGMASK;
+      ostr[0] = '\0';
+
+      for (mul = 0, o = optnames; flags && o->o_opt; o++) {
+         if (flags & o->o_opt) {
+            strlcat(ostr, ((mul++) ? "," : ""), BUFSIZ);
+            strlcat(ostr, o->o_name, BUFSIZ);
+            flags &= ~o->o_opt;
+         }
+      }
+
+      rb_iv_set(v_mount, "@name", rb_tainted_str_new2(p->f_mntfromname));
+      rb_iv_set(v_mount, "@mount_point", rb_tainted_str_new2(p->f_mntonname));
+      rb_iv_set(v_mount, "@mount_type", rb_tainted_str_new2(p->f_fstypename));
+      rb_iv_set(v_mount, "@options", rb_tainted_str_new2(ostr));
+      rb_iv_set(v_mount, "@mount_time", Qnil);
+      rb_iv_set(v_mount, "@dump_frequency", Qnil);
+      rb_iv_set(v_mount, "@pass_number", Qnil);
+   }
 #else
    rb_iv_set(v_mount, "@name", rb_tainted_str_new2(mp->mnt_fsname));
    rb_iv_set(v_mount, "@mount_point", rb_tainted_str_new2(mp->mnt_dir));
@@ -197,6 +310,48 @@ static VALUE create_mount_object(struct MNTENT* mp){
    return v_mount;
 }
 
+/*
+ * call-seq:
+ *    Filesystem.mount_point(file)
+ *
+ * Returns the mount point of the given +file+, or itself if it cannot be
+ * determined.
+ *
+ * Example:
+ *
+ *    Filesystem.mount_point('/home/djberge/some_file.txt') => '/home'
+ */
+static VALUE fs_mount_point(VALUE klass, VALUE v_file){
+   VALUE v_stat, v_stat_m, v_mounts, v_mount_pt, v_mount;
+   VALUE v_found = Qfalse;
+   long dev1, dev2;
+   int i = 0;
+
+   v_stat   = rb_funcall(rb_cFile, rb_intern("stat"), 1, v_file);
+   v_mounts = fs_mounts(klass);
+   dev1     = FIX2LONG(rb_funcall(v_stat, rb_intern("dev"), 0, 0));
+
+   /* Stat each mount point and compare its device number with the device
+    * number of the file provided. If they match, we have a winner.
+    */
+   for(i = 0; i < RARRAY(v_mounts)->len; i++){
+      v_mount    = RARRAY(v_mounts)->ptr[i];
+      v_mount_pt = rb_funcall(v_mount, rb_intern("mount_point"), 0, 0);
+      v_stat_m   = rb_funcall(rb_cFile, rb_intern("stat"), 1, v_mount_pt);
+      dev2       = FIX2LONG(rb_funcall(v_stat_m, rb_intern("dev"), 0, 0));
+
+      if(dev1 == dev2){
+         v_found = Qtrue;
+         break;
+      }
+   }
+
+   if(v_found == Qtrue)
+      return v_mount_pt;
+   else
+      return v_file;
+}
+
 void Init_filesystem(){
    /* The toplevel namespace */
    mSys = rb_define_module("Sys");
@@ -210,9 +365,10 @@ void Init_filesystem(){
    cMount = rb_define_class_under(cFilesys, "Mount", rb_cObject);
 
    /* Instances of this class are returned by the Filesystem.stat method */
-   cStat  = rb_define_class_under(cFilesys, "Stat", rb_cObject);
+   cStat = rb_define_class_under(cFilesys, "Stat", rb_cObject);
 
    /* Singleton methods */
+   rb_define_singleton_method(cFilesys, "mount_point", fs_mount_point, 1);
    rb_define_singleton_method(cFilesys, "mounts", fs_mounts, 0);
    rb_define_singleton_method(cFilesys, "stat", fs_stat, 1);
 
@@ -290,8 +446,8 @@ void Init_filesystem(){
 
    /* Constants */
 
-   /* 0.2.0: The version of this library (a String) */
-   rb_define_const(cFilesys, "VERSION", rb_str_new2("0.2.0"));
+   /* 0.3.0: The version of this library (a String) */
+   rb_define_const(cFilesys, "VERSION", rb_str_new2("0.3.0"));
 
    /* 0x00000001: Read only file system */
    rb_define_const(cStat, "RDONLY", INT2FIX(ST_RDONLY));

data/test/test_sys_filesystem_unix.rb

@@ -15,6 +15,8 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
    def self.startup
       @@solaris = Config::CONFIG['host_os'] =~ /solaris/i
       @@linux   = Config::CONFIG['host_os'] =~ /linux/i
+      @@freebsd = Config::CONFIG['host_os'] =~ /freebsd/i
+      @@darwin  = Config::CONFIG['host_os'] =~ /darwin/i
    end
 
    def setup
@@ -26,7 +28,7 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.2.0', Filesystem::VERSION)
+      assert_equal('0.3.0', Filesystem::VERSION)
    end
 
    def test_stat_path
@@ -105,7 +107,8 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
    end
 
    def test_stat_base_type
-      omit_unless(@@solaris, "NOTRUNC test skipped except on Solaris")
+      omit_unless(@@solaris, "base_type test skipped except on Solaris")
+
       assert_respond_to(@stat, :base_type)
       assert_kind_of(String, @stat.base_type)
    end
@@ -113,7 +116,9 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
    def test_stat_constants
       assert_not_nil(Filesystem::Stat::RDONLY)
       assert_not_nil(Filesystem::Stat::NOSUID)
+
       omit_unless(@@solaris, "NOTRUNC test skipped except on Solaris")
+
       assert_not_nil(Filesystem::Stat::NOTRUNC)
    end
 
@@ -192,15 +197,16 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
 
    def test_mount_time
       assert_respond_to(@mnt, :mount_time)
+
       if @@solaris
-         assert_kind_of(String, @mnt.mount_time)
+         assert_kind_of(Time, @mnt.mount_time)
       else
          assert_nil(@mnt.mount_time)
       end
    end
 
    def test_mount_dump_frequency
-      omit_if(@@solaris, 'dump_frequency test skipped on Solaris')
+      omit_if(@@solaris || @@freebsd || @@darwin, 'dump_frequency test skipped on this platform')
       assert_respond_to(@mnt, :dump_frequency)
       assert_kind_of(Fixnum, @mnt.dump_frequency)
    end
@@ -211,7 +217,7 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
    end
 
    def test_mount_pass_number
-      omit_if(@@solaris, 'pass_number test skipped on Solaris')
+      omit_if(@@solaris || @@freebsd || @@darwin, 'pass_number test skipped on this platform')
       assert_respond_to(@mnt, :pass_number)
       assert_kind_of(Fixnum, @mnt.pass_number)
    end
@@ -221,6 +227,12 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
       assert_true(@mnt.method(:passno) == @mnt.method(:pass_number))
    end
 
+   def test_mount_point_singleton
+      assert_respond_to(Filesystem, :mount_point)
+      assert_nothing_raised{ Filesystem.mount_point(Dir.pwd) }
+      assert_kind_of(String, Filesystem.mount_point(Dir.pwd))
+   end
+
    def teardown
       @dir   = nil
       @stat  = nil
@@ -230,5 +242,7 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
    def self.shutdown
       @@solaris = nil
       @@linux   = nil
+      @@freebsd = nil
+      @@darwin  = nil
    end
 end

data/test/test_sys_filesystem_windows.rb

@@ -22,7 +22,7 @@ class TC_Sys_Filesystem_Windows < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.2.0', Filesystem::VERSION)
+      assert_equal('0.3.0', Filesystem::VERSION)
    end
 
    def test_stat_path
@@ -93,6 +93,12 @@ class TC_Sys_Filesystem_Windows < Test::Unit::TestCase
       assert_kind_of(String, @stat.base_type)
    end
 
+   def test_mount_point_singleton
+      assert_respond_to(Filesystem, :mount_point)
+      assert_nothing_raised{ Filesystem.mount_point(Dir.pwd) }
+      assert_kind_of(String, Filesystem.mount_point(Dir.pwd))
+   end
+
    def test_constants
       assert_not_nil(Filesystem::CASE_SENSITIVE_SEARCH)
       assert_not_nil(Filesystem::CASE_PRESERVED_NAMES)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sys-filesystem
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-13 00:00:00 -07:00
+date: 2009-01-26 00:00:00 -07:00
 default_executable: 
 dependencies: []