solaris-file 0.3.2 → 0.3.3

data/CHANGES

@@ -1,3 +1,11 @@
+== 0.3.3 - 20-Aug-2007
+* Added the File.door? method, and the underlying File::Stat#door? method,
+  that returns whether or not the file is a door file.
+* Modified the File.ftype method, and the underlying File::Stat#ftype method,
+  so that the word 'door' is returned if the file is a door file.
+* Added tests for the new and updated methods.
+* These modifications were inspired by Hiro Asari (ruby-core: 11890).
+
 == 0.3.2 - 24-Jul-2007
 * Added a Rakefile with tasks for testing and installation.
 * Fixed an internal function name that conflicted with one in the acl.h file.

data/README

@@ -1,32 +1,31 @@
 == Description
-   Adds ACL support for the File class on Solaris.
+   Adds ACL support and Door methods for the File class on Solaris.
 
 == Prerequisites
    Ruby 1.8.x
 
 == Installation
-=== Manual Installation
    rake test (optional)
-   rake install
-
-=== Gem Install
-   rake test (optional)
-   rake install_gem
+   rake install (non-gem) OR rake install_gem (gem)
 
 == Synopsis
-   require "solaris/file"
+   require 'solaris/file'
    
-   f = "some_file.txt"
+   f = 'some_file.txt'
    acl_text = "user::rw-,user:nobody:r--,"
    acl_text << "group::r--,group:sys:r--,mask:r--,other:r--"
    
-   File.trivial?(f) # probably true
+   File.trivial?(f) # => true (probably)
    File.acl_write_text(acl_text)
    
    # No longer a trivial file
-   File.trivial?(f) # false
+   File.trivial?(f) # => false
    File.acl_read(f).each{ |acl| p acl }
 
+   # Door file?
+   File.door?("/var/run/syslog_door") # => true
+   File.ftype("/var/run/syslog_door") # => 'door'
+
 == Class Methods
 File.acl_count(file_name)
    Returns the number of ACL entries for the file. Returns 0 if it's a
@@ -42,6 +41,12 @@ Fiel.acl_read_text(file_name)
 File.acl_write_text(file_name, acl_string)
    Accepts a formatted ACL string that set the ACL for the file. If the
    string is badly formed, a File::SolarisError is raised.
+
+File.door?(file_name)
+   Returns whether or not +file_name+ is a Door file.
+
+File.ftype(file_name)
+   Modified so that it returns the word 'door' if +file_name+ is a door file.
    
 File.realpath(path)
    Resolves all symbolic links in +path+. Resolves to an absolute pathname
@@ -57,7 +62,7 @@ File.trivial?(file_name)
    Returns true if the file is a trivial ACL file, i.e. has no ACL entries for
    additional users or groups.
    
-= Instance Methods
+= File Instance Methods
 File#acl_count
    Returns the number of ACL entries for the file. Returns 0 if it's a
    trivial file.
@@ -77,6 +82,14 @@ File#trivial?
    Returns true if the file is a trivial ACL file, i.e. has no ACL entries for
    additional users or groups
 
+= File::Stat Instance Methods
+File::Stat#door?
+   Returns whether or not the stat object is a door file.
+
+File::Stat#ftype
+   Modified so that the stat object returns the word 'door' if the stat file
+   is a Door file.
+
 == Constants
 File::SOLARIS_VERSION
    Returns the current version number of this package as a String.

data/ext/solaris/sfile.c

@@ -1,9 +1,11 @@
-#include "ruby.h"
-#include "rubyio.h"
+#include <ruby.h>
+#include <rubyio.h>
 #include <sys/acl.h>
 #include <sys/param.h>
+#include <sys/stat.h>
 #include <unistd.h>
-#include "sfile.h"
+#include <fcntl.h>
+#include <sfile.h>
 
 /*
  * call-seq:
@@ -39,9 +41,9 @@ static VALUE acl_count(VALUE klass, VALUE v_path){
  */
 static VALUE acl_icount(VALUE self){
    int num_acls = 0;
-   int fildes = FIX2INT(rb_funcall(self,rb_intern("fileno"), 0, 0));
+   int fd = FIX2INT(rb_funcall(self,rb_intern("fileno"), 0, 0));
 
-   if((num_acls = facl(fildes, GETACLCNT, 0, NULL)) == -1)
+   if((num_acls = facl(fd, GETACLCNT, 0, NULL)) == -1)
       rb_sys_fail(0);
 
    if(num_acls == MIN_ACL_ENTRIES)
@@ -117,10 +119,10 @@ static VALUE acl_read(VALUE klass, VALUE v_path){
 static VALUE acl_iread(VALUE self){
    int i;
    int num_acls = 0;
-   int fildes = FIX2INT(rb_funcall(self, rb_intern("fileno"), 0, 0));
+   int fd = FIX2INT(rb_funcall(self, rb_intern("fileno"), 0, 0));
    VALUE v_array = Qnil;
 
-   if( (num_acls = facl(fildes, GETACLCNT, 0, NULL)) == -1)
+   if( (num_acls = facl(fd, GETACLCNT, 0, NULL)) == -1)
       rb_sys_fail(0);
 
    if(num_acls != MIN_ACL_ENTRIES){
@@ -130,7 +132,7 @@ static VALUE acl_iread(VALUE self){
       if( (acl_buf = malloc(sizeof(aclent_t) * num_acls) ) == NULL)
          rb_sys_fail(0);
 
-      if(facl(fildes, GETACL, num_acls, acl_buf) != num_acls)
+      if(facl(fd, GETACL, num_acls, acl_buf) != num_acls)
          rb_sys_fail(0);
 
       for(i = 0; i < num_acls; i++){
@@ -251,7 +253,7 @@ static VALUE solaris_resolvepath(VALUE klass, VALUE v_path){
  * call-seq:
  *    File.realpath(path)
  *
- * Resolves all symbolic links in +path+.  Resolves to an absolute pathname
+ * Resolves all symbolic links in +path+. Resolves to an absolute pathname
  * where possible.
  *
  * The difference between this method and File.resolvepath is that this method
@@ -277,14 +279,14 @@ static VALUE solaris_realpath(VALUE klass, VALUE v_path){
  * Sets the ACL for the file using +acl_text+.  The +acl_text+ argument is a
  * human readable ACL text String.
  *
- * If +acl_text+ is invalid then a File::SolarisError is raised, and in most
+ * If +acl_text+ is invalid then a File::Solaris::Error is raised, and in most
  * cases the offending entry number will be identified.
  */
 static VALUE acl_iwrite_text(VALUE self, VALUE v_text){
    aclent_t* acl_buf;
    int num_acls, which;
    char* acl_text = StringValuePtr(v_text);
-   int fildes = FIX2INT(rb_funcall(self, rb_intern("fileno"), 0, 0));
+   int fd = FIX2INT(rb_funcall(self, rb_intern("fileno"), 0, 0));
    int rv;
 
    SafeStringValue(v_text);
@@ -295,7 +297,7 @@ static VALUE acl_iwrite_text(VALUE self, VALUE v_text){
    rv = aclcheck(acl_buf, num_acls, &which);
    do_acl_check(rv, which);
 
-   if(facl(fildes, SETACL, num_acls, acl_buf) == -1){
+   if(facl(fd, SETACL, num_acls, acl_buf) == -1){
       free(acl_text);
       rb_sys_fail(0);
    }
@@ -317,10 +319,10 @@ static VALUE acl_iwrite_text(VALUE self, VALUE v_text){
 static VALUE acl_iread_text(VALUE self){
    char* acl_text;
    int num_acls = 0;
-   int fildes = FIX2INT(rb_funcall(self,rb_intern("fileno"),0,0));
+   int fd = FIX2INT(rb_funcall(self,rb_intern("fileno"),0,0));
    VALUE v_text = Qnil;
 
-   if( (num_acls = facl(fildes,GETACLCNT,0,NULL)) == -1)
+   if( (num_acls = facl(fd,GETACLCNT,0,NULL)) == -1)
       rb_sys_fail(0);
 
    if(num_acls != MIN_ACL_ENTRIES){
@@ -329,7 +331,7 @@ static VALUE acl_iread_text(VALUE self){
       if( (acl_buf = malloc(sizeof(aclent_t) * num_acls) ) == NULL)
          rb_sys_fail(0);
 
-      if(facl(fildes, GETACL, num_acls, acl_buf) != num_acls)
+      if(facl(fd, GETACL, num_acls, acl_buf) != num_acls)
          rb_sys_fail(0);
 
       acl_text = acltotext(acl_buf,num_acls);
@@ -346,7 +348,7 @@ static VALUE acl_iread_text(VALUE self){
  *    File.trivial?(file_name)
  *
  * Returns true if +file_name+ is a trivial file, i.e. has no additional ACL
- * entries.  Otherwise, it returns false.
+ * entries. Otherwise, it returns false.
  */
 static VALUE acl_is_trivial(VALUE klass, VALUE v_path){
    char pathp[PATH_MAX];
@@ -375,11 +377,11 @@ static VALUE acl_is_trivial(VALUE klass, VALUE v_path){
  * ACL entries.  Otherwise, it returns false.
  */
 static VALUE acl_itrivial(VALUE self){
-   int fildes = FIX2INT(rb_funcall(self,rb_intern("fileno"),0,0));
+   int fd = FIX2INT(rb_funcall(self, rb_intern("fileno"), 0, 0));
    int num_acls = 0;
    VALUE v_bool = Qfalse;
 
-   if( (num_acls = facl(fildes,GETACLCNT,0,NULL)) == -1)
+   if( (num_acls = facl(fd, GETACLCNT, 0, NULL)) == -1)
       rb_sys_fail(0);
 
    if(num_acls == MIN_ACL_ENTRIES)
@@ -388,6 +390,55 @@ static VALUE acl_itrivial(VALUE self){
    return v_bool;
 }
 
+/* File::Stat Additions */
+
+/*
+ * call-seq:
+ *    statfile.door?
+ *
+ * Returns true if +statfile+ is a door, false otherwise.
+ */
+static VALUE solaris_stat_is_door(VALUE self){
+   struct stat stat_buf;
+   VALUE v_bool = Qtrue;
+   int mode = FIX2INT(rb_funcall(self, rb_intern("mode"), 0, 0));
+
+   if(S_ISDOOR(mode) == 0)
+      v_bool = Qfalse;
+
+   return v_bool;
+}
+
+static VALUE solaris_stat_ftype(VALUE self){
+   int mode = FIX2INT(rb_funcall(self, rb_intern("mode"), 0, 0));
+
+   if(S_ISDOOR(mode))
+      return rb_str_new2("door");
+   else
+      return rb_funcall(self, rb_intern("old_ftype"), 0, 0);
+}
+
+/* call-seq:
+ *    File.door?(file)
+ *
+ * Returns true if +file+ is a door file, false otherwise.
+ */
+static VALUE solaris_file_is_door(VALUE klass, VALUE v_file){
+   VALUE v_stat = rb_funcall(rb_cStat, rb_intern("new"), 1, v_file);
+   return solaris_stat_is_door(v_stat);
+}
+
+/* call-seq:
+ *    File.ftype(file)
+ *
+ * The File.ftype method was modified so that 'door' is returned if the
+ * +file+ is a door file.
+ */
+static VALUE solaris_file_ftype(VALUE klass, VALUE v_file){
+   VALUE v_stat = rb_funcall(rb_cStat, rb_intern("new"), 1, v_file);
+   return solaris_stat_ftype(v_stat);
+}
+
 /*
  * Adds ACL support for the File class on Solaris
  */
@@ -405,19 +456,26 @@ void Init_file(){
    rb_define_singleton_method(rb_cFile, "trivial?", acl_is_trivial, 1);
    rb_define_singleton_method(rb_cFile, "realpath", solaris_realpath, 1);
    rb_define_singleton_method(rb_cFile, "resolvepath", solaris_resolvepath, 1);
+   rb_define_singleton_method(rb_cFile, "door?", solaris_file_is_door, 1);
+   rb_define_singleton_method(rb_cFile, "ftype", solaris_file_ftype, 1);
+
+   /* File Instance Methods */
+   rb_define_method(rb_cFile, "acl_count", acl_icount, 0);
+   rb_define_method(rb_cFile, "acl_read", acl_iread, 0);
+   rb_define_method(rb_cFile, "acl_read_text", acl_iread_text, 0);
+   rb_define_method(rb_cFile, "acl_write_text", acl_iwrite_text, 1);
+   rb_define_method(rb_cFile, "trivial?", acl_itrivial, 0);
 
-   /* Instance Methods */
-   rb_define_method(rb_cFile,"acl_count", acl_icount, 0);
-   rb_define_method(rb_cFile,"acl_read", acl_iread, 0);
-   rb_define_method(rb_cFile,"acl_read_text", acl_iread_text, 0);
-   rb_define_method(rb_cFile,"acl_write_text", acl_iwrite_text, 1);
-   rb_define_method(rb_cFile,"trivial?", acl_itrivial, 0);
+   /* File::Stat Instance Methods */
+   rb_define_alias(rb_cStat, "old_ftype", "ftype");
+   rb_define_method(rb_cStat, "door?", solaris_stat_is_door, 0);
+   rb_define_method(rb_cStat, "ftype", solaris_stat_ftype, 0);
 
    /* Structs */
    sACLStruct = rb_struct_define("ACLStruct",
       "acl_type", "acl_id", "acl_perm", NULL
    );
 
-   /* 0.3.2: The version of this library, returned as a String */
+   /* 0.3.3: The version of this library, returned as a String */
    rb_define_const(rb_cFile, "SOLARIS_VERSION", rb_str_new2(SOLARIS_VERSION));
 }

data/ext/solaris/sfile.h

@@ -1,4 +1,4 @@
-#define SOLARIS_VERSION "0.3.2"
+#define SOLARIS_VERSION "0.3.3"
 #define MAX_STRING 512
 
 VALUE cSolarisFileError;

data/test/tc_solaris_file.rb

@@ -13,6 +13,8 @@ class TC_Solaris_File < Test::Unit::TestCase
       @dir   = Dir.pwd
       @file  = "foo.txt" # trivial
       @file2 = "bar.txt" # non-trivial
+      @door  = "/var/run/syslog_door"
+      @stat  = File::Stat.new(@door)
 
       @acl_text = "user::rw-,user:nobody:r--,"
       @acl_text << "group::r--,group:sys:r--,mask:r--,other:r--"
@@ -27,7 +29,7 @@ class TC_Solaris_File < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal("0.3.2", File::SOLARIS_VERSION)
+      assert_equal('0.3.3', File::SOLARIS_VERSION)
    end
 
    # CLASS METHODS
@@ -95,6 +97,20 @@ class TC_Solaris_File < Test::Unit::TestCase
       assert_raises(Errno::ENOENT){ File.resolvepath("bogus") }
    end
 
+   def test_class_is_door
+      assert_respond_to(File, :door?)
+      assert_equal(true, File.door?(@door))
+      assert_equal(false, File.door?(Dir.pwd))
+      assert_raises(Errno::ENOENT){ File.door?("bogus") }
+   end
+
+   def test_class_ftype
+      assert_respond_to(File, :ftype)
+      assert_equal('door', File.ftype(@door))
+      assert_equal('directory', File.ftype(Dir.pwd))
+      assert_raises(Errno::ENOENT){ File.ftype("bogus") }
+   end
+
    # INSTANCE METHODS
 
    def test_instance_acl
@@ -132,8 +148,18 @@ class TC_Solaris_File < Test::Unit::TestCase
       assert_respond_to(@fh,:acl_count)
       assert_nothing_raised{ @fh.acl_count }
       assert_kind_of(Fixnum,@fh.acl_count)
-      assert_equal(0,@fh.acl_count)
-      assert_equal(6,@fh2.acl_count)
+      assert_equal(0, @fh.acl_count)
+      assert_equal(6, @fh2.acl_count)
+   end
+
+   def test_stat_door
+      assert_respond_to(@stat, :door?)
+      assert_equal(true, @stat.door?)
+   end
+
+   def test_stat_ftype
+      assert_respond_to(@stat, :ftype)
+      assert_equal('door', @stat.ftype)
    end
 
    def teardown

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: solaris-file
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
-date: 2007-07-24 00:00:00 -06:00
+  version: 0.3.3
+date: 2007-08-20 00:00:00 -06:00
 summary: ACL and other methods for the File class on Solaris
 require_paths: 
 - lib