sys-admin 1.7.4 → 1.8.1

data/lib/darwin/sys/admin.rb

@@ -5,10 +5,9 @@ require 'sys/admin/common'
 
 module Sys
   class Admin
-    private
-
     # :no-doc:
     BUF_MAX = 65536 # Max buf size for retry.
+    private_constant :BUF_MAX
 
     attach_function :getlogin_r, [:pointer, :int], :int
     attach_function :getpwnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
@@ -17,8 +16,8 @@ module Sys
     attach_function :getgrgid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
     attach_function :getlastlogx, [:long, :pointer], :pointer
 
-    private_class_method :getlogin_r, :getpwnam_r, :getpwuid_r, :getgrnam_r
-    private_class_method :getgrgid_r, :getlastlogx
+    private_class_method :getlogin_r, :getpwnam_r, :getpwuid_r
+    private_class_method :getgrnam_r, :getgrgid_r, :getlastlogx
 
     # struct passwd from /usr/include/pwd.h
     class PasswdStruct < FFI::Struct
@@ -36,6 +35,8 @@ module Sys
       )
     end
 
+    private_constant :PasswdStruct
+
     # struct group from /usr/include/grp.h
     class GroupStruct < FFI::Struct
       layout(
@@ -46,6 +47,8 @@ module Sys
       )
     end
 
+    private_constant :GroupStruct
+
     # I'm blending the timeval struct in directly here
     class LastlogxStruct < FFI::Struct
       layout(
@@ -56,7 +59,7 @@ module Sys
       )
     end
 
-    public
+    private_constant :LastlogxStruct
 
     # Returns the login for the current process.
     #
@@ -77,8 +80,12 @@ module Sys
     #
     #    Sys::Admin.get_user('joe')
     #    Sys::Admin.get_user(501)
+    #    Sys::Admin.get_user('joe', :lastlog => false) # Less info but faster
     #
-    def self.get_user(uid)
+    # Set the :lastlog option to false if you want to ignore lastlog
+    # information and speed this method up considerably.
+    #
+    def self.get_user(uid, options = {})
       buf  = FFI::MemoryPointer.new(:char, 1024)
       pbuf = FFI::MemoryPointer.new(PasswdStruct)
       temp = PasswdStruct.new
@@ -100,7 +107,7 @@ module Sys
       end
 
       pwd = PasswdStruct.new(ptr)
-      get_user_from_struct(pwd)
+      get_user_from_struct(pwd, options)
     end
 
     # Returns a Group object for the given name or uid. Raises an error
@@ -145,11 +152,19 @@ module Sys
 
     # Returns an array of User objects for each user on the system.
     #
+    # Examples:
+    #
+    #   Sys::Admin.users
+    #   Sys::Admin.users(:lastlog => false) # Less info but faster
+    #
+    # Note that on Darwin this method can be very slow. If you want to
+    # speed it up considerably by ignoring lastlog information then set
+    # the :lastlog option to false as part of the +options+ hash.
     #--
     # This method is somewhat slow on OSX because of the call to get
     # lastlog information. I'm not sure why.
     #
-    def self.users
+    def self.users(options = {})
       users = []
 
       begin
@@ -157,7 +172,7 @@ module Sys
 
         until (ptr = getpwent()).null?
           pwd = PasswdStruct.new(ptr)
-          users << get_user_from_struct(pwd)
+          users << get_user_from_struct(pwd, options)
         end
       ensure
         endpwent()
@@ -185,8 +200,6 @@ module Sys
       groups
     end
 
-    private
-
     # Takes a GroupStruct and converts it to a Group object.
     def self.get_group_from_struct(grp)
       Group.new do |g|
@@ -197,8 +210,10 @@ module Sys
       end
     end
 
+    private_class_method :get_group_from_struct
+
     # Takes a UserStruct and converts it to a User object.
-    def self.get_user_from_struct(pwd)
+    def self.get_user_from_struct(pwd, options)
       user = User.new do |u|
         u.name         = pwd[:pw_name]
         u.passwd       = pwd[:pw_passwd]
@@ -212,17 +227,21 @@ module Sys
         u.expire       = Time.at(pwd[:pw_expire])
       end
 
-      log = get_lastlog_info(user.uid)
+      unless options[:lastlog] == false
+        log = get_lastlog_info(user.uid)
 
-      if log
-        user.login_time = Time.at(log[:tv_sec])
-        user.login_device = log[:ll_line].to_s
-        user.login_host = log[:ll_host].to_s
+        if log
+          user.login_time = Time.at(log[:tv_sec])
+          user.login_device = log[:ll_line].to_s
+          user.login_host = log[:ll_host].to_s
+        end
       end
 
       user
     end
 
+    private_class_method :get_user_from_struct
+
     # Gets lastlog information for the given user.
     def self.get_lastlog_info(uid)
       lastlog = LastlogxStruct.new
@@ -233,5 +252,7 @@ module Sys
 
       ptr.null? ? nil : lastlog
     end
+
+    private_class_method :get_lastlog_info
   end
 end

data/lib/linux/sys/admin.rb

@@ -5,17 +5,15 @@ require 'sys/admin/common'
 
 module Sys
   class Admin
-    private
-
     # :no-doc:
     BUF_MAX = 65536 # Absolute max buffer size for retry attempts.
+    private_constant :BUF_MAX
 
     # 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
     attach_function :close_c, :close, [:int], :int
 
-    attach_function :getlogin_r, [:pointer, :size_t], :int
     attach_function :getpwnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
     attach_function :getpwuid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
     attach_function :getpwent_r, [:pointer, :pointer, :size_t, :pointer], :int
@@ -23,7 +21,6 @@ module Sys
     attach_function :getgrnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
     attach_function :getgrgid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
 
-    private_class_method :getlogin_r, :getpwnam_r, :getpwuid_r, :getpwent_r
     private_class_method :getgrent_r, :getgrnam_r, :getgrgid_r
     private_class_method :open_c, :pread_c, :close_c
 
@@ -40,6 +37,8 @@ module Sys
       )
     end
 
+    private_constant :PasswdStruct
+
     # struct group from /usr/include/grp.h
     class GroupStruct < FFI::Struct
       layout(
@@ -50,6 +49,8 @@ module Sys
       )
     end
 
+    private_constant :GroupStruct
+
     # I'm blending the timeval struct in directly here
     class LastlogStruct < FFI::Struct
       layout(
@@ -59,18 +60,12 @@ module Sys
       )
     end
 
-    public
+    private_constant :LastlogStruct
 
     # Returns the login for the current process.
     #
     def self.get_login
-      buf = FFI::MemoryPointer.new(:char, 256)
-
-      if getlogin_r(buf, buf.size) != 0
-        raise Error, "getlogin_r function failed: " + strerror(FFI.errno)
-      end
-
-      buf.read_string
+      get_user(geteuid()).name
     end
 
     # Returns a User object for the given name or uid. Raises an error
@@ -204,8 +199,6 @@ module Sys
       groups
     end
 
-    private
-
     # Takes a GroupStruct and converts it to a Group object.
     def self.get_group_from_struct(grp)
       Group.new do |g|
@@ -216,6 +209,8 @@ module Sys
       end
     end
 
+    private_class_method :get_group_from_struct
+
     # Takes a UserStruct and converts it to a User object.
     def self.get_user_from_struct(pwd)
       user = User.new do |u|
@@ -242,6 +237,8 @@ module Sys
       user
     end
 
+    private_class_method :get_user_from_struct
+
     # Note: it seems that Linux, or at least Ubuntu, does not track logins
     # via GDM (Gnome Display Manager) for some reason, so this may not return
     # anything useful.
@@ -269,5 +266,7 @@ module Sys
 
       lastlog
     end
+
+    private_class_method :get_lastlog_info
   end
 end

data/lib/sunos/sys/admin.rb

@@ -5,10 +5,9 @@ require 'sys/admin/common'
 
 module Sys
   class Admin
-    private
-
     # :no-doc:
     BUF_MAX = 65536 # Max buffer size for retry.
+    private_constant :BUF_MAX
 
     # I'm making some aliases here to prevent potential conflicts
     attach_function :open_c, :open, [:string, :int], :int
@@ -42,6 +41,8 @@ module Sys
       )
     end
 
+    private_constant :PasswdStruct
+
     # struct group from /usr/include/grp.h
     class GroupStruct < FFI::Struct
       layout(
@@ -52,6 +53,8 @@ module Sys
       )
     end
 
+    private_constant :GroupStruct
+
     # I'm blending the timeval struct in directly here
     class LastlogStruct < FFI::Struct
       layout(
@@ -61,7 +64,7 @@ module Sys
       )
     end
 
-    public
+    private_constant :LastlogStruct
 
     # Returns the login for the current process.
     #
@@ -194,8 +197,6 @@ module Sys
       groups
     end
 
-    private
-
     # Takes a GroupStruct and converts it to a Group object.
     def self.get_group_from_struct(grp)
       Group.new do |g|
@@ -206,6 +207,8 @@ module Sys
       end
     end
 
+    private_class_method :get_group_from_struct
+
     # Takes a UserStruct and converts it to a User object.
     def self.get_user_from_struct(pwd)
       user = User.new do |u|
@@ -232,6 +235,8 @@ module Sys
       user
     end
 
+    private_class_method :get_use_from_struct
+
     # The use of pread was necessary here because it's a sparse file. Note
     # also that while Solaris supports the getuserattr function, it doesn't
     # appear to store anything regarding login information.
@@ -257,5 +262,7 @@ module Sys
 
       lastlog
     end
+
+    private_class_method :get_lastlog_info
   end
 end

data/lib/sys/admin/common.rb

@@ -9,12 +9,11 @@ module Sys
     extend FFI::Library
     ffi_lib FFI::Library::LIBC
 
-    private
-
     attach_function :strerror, [:int], :string
 
     attach_function :getlogin, [], :string
     attach_function :getuid, [], :long
+    attach_function :geteuid, [], :long
     attach_function :getpwnam, [:string], :pointer
     attach_function :getpwuid, [:long], :pointer
     attach_function :getpwent, [], :pointer
@@ -27,12 +26,10 @@ module Sys
     attach_function :endgrent, [], :void
     attach_function :setgrent, [], :void
 
-    private_class_method :getlogin, :getuid, :getpwnam, :getpwuid, :getpwent
-    private_class_method :setpwent, :endpwent, :getgrgid, :getgrnam
+    private_class_method :getlogin, :getuid, :geteuid, :getpwnam, :getpwuid
+    private_class_method :getpwent, :setpwent, :endpwent, :getgrgid, :getgrnam
     private_class_method :getgrent, :endgrent, :setgrent, :strerror
 
-    public
-
     # Error typically raised if any of the Sys::Admin methods fail.
     class Error < StandardError; end
 

data/lib/sys/admin.rb

@@ -1,7 +1,7 @@
 module Sys
   class Admin
     # The version of the sys-admin library.
-    VERSION = '1.7.4'.freeze
+    VERSION = '1.8.1'.freeze
   end
 end
 

data/lib/unix/sys/admin.rb

@@ -5,8 +5,6 @@ require 'sys/admin/common'
 
 module Sys
   class Admin
-    private
-
     class PasswdStruct < FFI::Struct
       layout(
         :pw_name,   :string,
@@ -19,6 +17,8 @@ module Sys
       )
     end
 
+    private_constant :PasswdStruct
+
     class GroupStruct < FFI::Struct
       layout(
         :gr_name,   :string,
@@ -28,7 +28,7 @@ module Sys
       )
     end
 
-    public
+    private_constant :GroupStruct
 
     # Returns the login for the current process.
     #
@@ -133,8 +133,6 @@ module Sys
       groups
     end
 
-    private
-
     # Takes a GroupStruct and converts it to a Group object.
     def self.get_group_from_struct(grp)
       Group.new do |g|
@@ -145,6 +143,8 @@ module Sys
       end
     end
 
+    private_class_method :get_group_from_struct
+
     # Takes a UserStruct and converts it to a User object.
     def self.get_user_from_struct(pwd)
       user = User.new do |u|
@@ -159,5 +159,7 @@ module Sys
 
       user
     end
+
+    private_class_method :get_user_from_struct
   end
 end