sys-admin 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc10ad595e0df60b19272734c766f8c4dfd28a34
-  data.tar.gz: f12fb6920c06080d493579d2390a5ae84adbae68
+  metadata.gz: 269ba9323aaf5a4925fc94d9c0f5d085ff9d5d2c
+  data.tar.gz: b4a6312be3304b7aa12a3e0444230235a9df99ef
 SHA512:
-  metadata.gz: 61dbfb21ccdae123b1411f8ad5288b6a6f681247bce7fa652861c0504388e9b7a3a6d756d2dda106236980f508164199da98cffc0ff7fb53ca4494969063a837
-  data.tar.gz: e09a0b8607bcf2812366a9ba1409bc62a4c6b5a94e68efe0b91fdaf5e6a53e4d695733dac416eb4ca760ba48ebfc5ddccaebc55ddf6d998fd7808ae13a18d624
+  metadata.gz: fa2f68ca7a992a8dda0821f76c583eb9abeae941f8446f60368185e1860ee640353a9ccbe5f7f02927e04755220a7f65ad4d18f824866b99b48d972398dfe97c
+  data.tar.gz: 25f88dee1694e2e669a1952973c0747f5bc820d396f47b751ff89c630a41719af5c0cb73c5e8cd41929506656868516d541381a8162079a4fb380ce933b578d5

data/CHANGES

@@ -1,3 +1,7 @@
+== 1.6.3 - 8-Mar-2014
+* The Admin#get_group method now handles groups with very large numbers
+  of members more robustly.
+
 == 1.6.2 - 11-Feb-2014
 * The User#gid method is now supported on MS Windows. It returns the user's
   primary group ID.

data/README

@@ -131,7 +131,15 @@ Admin::Error < StandardError
 
 == Known Bugs
   None that I'm aware of. If you find any, please log them on the project
-  page at http://www.rubyforge.org/projects/sysutils.
+  page at:
+
+  https://github.com/djberg96/sys-admin
+
+== Contributions
+  Although this library is free, please consider having your company
+  setup a gittip if used by your company professionally.
+
+  http://www.gittip.com/djberg96/
 
 == License
   Artistic 2.0

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake/clean'
 require 'rake/testtask'
 require 'rbconfig'
 
-CLEAN.include("**/*.gem", "**/*.rbx", "**/*.rbc")
+CLEAN.include("**/*.gem", "**/*.rbx", "**/*.rbc", "ruby.core")
 
 namespace :gem do
   desc "Create the sys-uname gem"

data/lib/bsd/sys/admin.rb

@@ -1,5 +1,6 @@
 require 'sys/admin/custom'
 require 'sys/admin/common'
+require 'rbconfig'
 
 # The BSD specific code.
 
@@ -7,6 +8,9 @@ module Sys
   class Admin
     private
 
+    # :no-doc:
+    BUF_MAX = 65536 # Max buffer for retry
+
     # I'm making some aliases here to prevent potential conflicts
     attach_function :open_c, :open, [:string, :int], :int
     attach_function :pread_c, :pread, [:int, :pointer, :size_t, :off_t], :size_t
@@ -24,18 +28,24 @@ module Sys
 
     # struct passwd from /usr/include/pwd.h
     class PasswdStruct < FFI::Struct
-      layout(
+      fields = [
         :pw_name, :string,
         :pw_passwd, :string,
-        :pw_uid, :uint,
-        :pw_gid, :uint,
-        :pw_change, :ulong,
+        :pw_uid, :uid_t,
+        :pw_gid, :gid_t,
+        :pw_change, :time_t,
         :pw_class, :string,
         :pw_gecos, :string,
         :pw_dir, :string,
         :pw_shell, :string,
-        :pw_expire, :ulong
-      )
+        :pw_expire, :time_t
+      ]
+
+      if RbConfig::CONFIG['host_os'] =~ /freebsd/i
+        fields.push(:pw_fields, :int)
+      end
+
+      layout(*fields)
     end
 
     # struct group from /usr/include/grp.h
@@ -113,24 +123,31 @@ module Sys
     #    Sys::Admin.get_group(101)
     #
     def self.get_group(gid)
-      buf  = FFI::MemoryPointer.new(:char, 1024)
+      size = 1024
+      buf  = FFI::MemoryPointer.new(:char, size)
       pbuf = FFI::MemoryPointer.new(PasswdStruct)
       temp = GroupStruct.new
 
-      if gid.is_a?(String)
-        if getgrnam_r(gid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getgrnam_r function failed: " + strerror(FFI.errno)
-        end
-      else
-        if getgrgid_r(gid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getgrgid_r function failed: " + strerror(FFI.errno)
+      begin
+        if gid.is_a?(String)
+          val = getgrnam_r(gid, temp, buf, buf.size, pbuf)
+          fun = 'getgrnam_r'
+        else
+          val = getgrgid_r(gid, temp, buf, buf.size, pbuf)
+          fun = 'getgrgid_r'
         end
+        raise SystemCallError.new(fun, val) if val != 0
+      rescue Errno::ERANGE
+        size += 1024
+        raise if size > BUF_MAX
+        buf = FFI::MemoryPointer.new(:char, size)
+        retry
       end
 
       ptr = pbuf.read_pointer
 
       if ptr.null?
-        raise Error, "no group found for #{gid}"
+        raise Error, "no group found for '#{gid}'"
       end
 
       grp = GroupStruct.new(ptr)

data/lib/darwin/sys/admin.rb

@@ -7,6 +7,9 @@ module Sys
   class Admin
     private
 
+    # :no-doc:
+    BUF_MAX = 65536 # Max buf size for retry.
+
     attach_function :getlogin_r, [:pointer, :int], :int
     attach_function :getpwnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
     attach_function :getpwuid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
@@ -109,24 +112,31 @@ module Sys
     #    Sys::Admin.get_group(101)
     #
     def self.get_group(gid)
-      buf  = FFI::MemoryPointer.new(:char, 1024)
+      size = 1024
+      buf  = FFI::MemoryPointer.new(:char, size)
       pbuf = FFI::MemoryPointer.new(PasswdStruct)
       temp = GroupStruct.new
 
-      if gid.is_a?(String)
-        if getgrnam_r(gid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getgrnam_r function failed: " + strerror(FFI.errno)
-        end
-      else
-        if getgrgid_r(gid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getgrgid_r function failed: " + strerror(FFI.errno)
+      begin
+        if gid.is_a?(String)
+          val = getgrnam_r(gid, temp, buf, buf.size, pbuf)
+          fun = 'getgrnam_r'
+        else
+          val = getgrgid_r(gid, temp, buf, buf.size, pbuf)
+          fun = 'getgrgid_r'
         end
+        raise SystemCallError.new(fun, val) if val != 0
+      rescue Errno::ERANGE
+        size += 1024
+        raise if size > BUF_MAX
+        buf = FFI::MemoryPointer.new(:char, size)
+        retry
       end
 
       ptr = pbuf.read_pointer
 
       if ptr.null?
-        raise Error, "no group found for #{gid}"
+        raise Error, "no group found for '#{gid}'"
       end
 
       grp = GroupStruct.new(ptr)

data/lib/linux/sys/admin.rb

@@ -7,6 +7,9 @@ module Sys
   class Admin
     private
 
+    # :no-doc:
+    BUF_MAX = 65536 # Absolute max buffer size for retry attempts.
+
     # I'm making some aliases here to prevent potential conflicts
     attach_function :open_c, :open, [:string, :int], :int
     attach_function :pread_c, :pread, [:int, :pointer, :size_t, :off_t], :size_t
@@ -110,26 +113,37 @@ module Sys
     #
     #    Sys::Admin.get_group('admin')
     #    Sys::Admin.get_group(101)
+    #--
+    # For groups with a large number of members we retry, allocating another
+    # 1k on each retry attempt, up to a maximum of 64k, which ought to be way
+    # more than you'll ever need.
     #
     def self.get_group(gid)
-      buf  = FFI::MemoryPointer.new(:char, 1024)
+      size = 1024
+      buf  = FFI::MemoryPointer.new(:char, size)
       pbuf = FFI::MemoryPointer.new(PasswdStruct)
       temp = GroupStruct.new
 
-      if gid.is_a?(String)
-        if getgrnam_r(gid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getgrnam_r function failed: " + strerror(FFI.errno)
-        end
-      else
-        if getgrgid_r(gid, temp, buf, buf.size, pbuf) != 0
-          raise Error, "getgrgid_r function failed: " + strerror(FFI.errno)
+      begin
+        if gid.is_a?(String)
+          val = getgrnam_r(gid, temp, buf, buf.size, pbuf)
+          fun = 'getgrnam_r'
+        else
+          val = getgrgid_r(gid, temp, buf, buf.size, pbuf)
+          fun = 'getgrgid_r'
         end
+        raise SystemCallError.new(fun, val) if val != 0
+      rescue Errno::ERANGE # Large groups
+        size += 1024
+        raise if size > BUF_MAX
+        buf = FFI::MemoryPointer.new(:char, size)
+        retry
       end
 
       ptr = pbuf.read_pointer
 
       if ptr.null?
-        raise Error, "no group found for #{gid}"
+        raise Error, "no group found for '#{gid}'"
       end
 
       grp = GroupStruct.new(ptr)

data/lib/sunos/sys/admin.rb

@@ -7,6 +7,9 @@ module Sys
   class Admin
     private
 
+    # :no-doc:
+    BUF_MAX = 65536 # Max buffer size for retry.
+
     # I'm making some aliases here to prevent potential conflicts
     attach_function :open_c, :open, [:string, :int], :int
     attach_function :pread_c, :pread, [:int, :pointer, :size_t, :off_t], :size_t
@@ -109,17 +112,34 @@ module Sys
     #    Sys::Admin.get_group(101)
     #
     def self.get_group(gid)
-      buf  = FFI::MemoryPointer.new(:char, 1024)
+      size = 1024
+      buf  = FFI::MemoryPointer.new(:char, size)
       temp = GroupStruct.new
 
-      if gid.is_a?(String)
-        ptr = getgrnam_r(gid, temp, buf, buf.size)
-      else
-        ptr = getgrgid_r(gid, temp, buf, buf.size)
-      end
+      begin
+        if gid.is_a?(String)
+          ptr = getgrnam_r(gid, temp, buf, buf.size)
+          fun = 'getgrnam_r'
+        else
+          ptr = getgrgid_r(gid, temp, buf, buf.size)
+          fun = 'getgrgid_r'
+        end
 
-      if ptr.null?
-        raise Error, "getgrnam_r or getgrgid_r function failed: " + strerror(FFI.errno)
+        # SunOS distinguishes between a failed function call and a
+        # group that isn't found.
+
+        if ptr.null?
+          if FFI.errno > 0
+            raise SystemCallError.new(fun, FFI.errno)
+          else
+            raise Error, "group '#{gid}' not found"
+          end
+        end
+      rescue Errno::ERANGE
+        size += 1024
+        raise if size > BUF_MAX
+        buf = FFI::MemoryPointer.new(:char, size)
+        retry
       end
 
       grp = GroupStruct.new(ptr)

data/lib/sys/admin/common.rb

@@ -34,7 +34,7 @@ module Sys
     public
 
     # The version of the sys-admin library.
-    VERSION = '1.6.2'
+    VERSION = '1.6.3'
 
     # Error typically raised if any of the Sys::Admin methods fail.
     class Error < StandardError; end

data/lib/unix/sys/admin.rb

@@ -5,7 +5,6 @@ require 'sys/admin/common'
 
 module Sys
   class Admin
-
     private
 
     class PasswdStruct < FFI::Struct

data/lib/windows/sys/admin.rb

@@ -300,7 +300,7 @@ module Sys
     extend FFI::Library
 
     # The version of the sys-admin library.
-    VERSION = '1.6.2'
+    VERSION = '1.6.3'
 
     # This is the error raised in the majority of cases if anything goes wrong
     # with any of the Sys::Admin methods.

data/sys-admin.gemspec

@@ -3,7 +3,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name      = 'sys-admin'
-  spec.version   = '1.6.2'
+  spec.version   = '1.6.3'
   spec.author    = 'Daniel J. Berger'
   spec.license   = 'Artistic 2.0'
   spec.email     = 'djberg96@gmail.com'

data/test/test_sys_admin.rb

@@ -14,6 +14,6 @@ end
 
 class TC_Sys_Admin_All < Test::Unit::TestCase
   test "version is set to expected value" do
-    assert_equal('1.6.2', Sys::Admin::VERSION)
+    assert_equal('1.6.3', Sys::Admin::VERSION)
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: sys-admin
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
@@ -97,12 +97,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []