sys-admin 1.3.1-mswin32

data/CHANGES

@@ -0,0 +1,31 @@
+== 1.3.1 - 29-Jun-2005
+* Fixed a bug where the inability to read the lastlog file caused an error.
+  From now on that error is ignored, and the lastlog attributes of the User
+  object are set to nil.
+* Added a beta version of Admin.delete_user (Windows only).
+
+== 1.3.0 - 3-Jun-2005
+* Bug fixes for Linux.
+* Removed the version.h file - no longer needed since the Win32 version is
+  pure Ruby.
+
+== 1.2.0 - 30-Apr-2005
+* Replaced the Win32 version with a pure Ruby version that uses Win32API and
+  win32ole + WMI.
+* The LocalGroup class no longer exists in the Win32 version.  Instead, it is
+  now an attribute of a Group object.  The issue was forced by WMI.
+* The default for users and groups on Win32 systems is now local rather than
+  global.  See the documentation for why you probably don't want to iterate
+  over global accounts.
+* Corresponding doc changes and test suite changes.
+
+== 1.1.0 - 1-Apr-2005
+* Fixed bug where a segfault could occur when trying to retrieve a user or
+  group by an ID that didn't exist (Unix).
+* Added tests for intentional failures.
+* Added lastlog information tothe User class (Unix).
+* Modified the way User objects are created internally (Unix).
+* Fixed a bug in the User#shell attribute (Unix).
+
+== 1.0.0 - 25-Mar-2005
+* Initial release

data/MANIFEST

@@ -0,0 +1,17 @@
+extconf.rb
+install.rb
+sys-admin.gemspec
+CHANGES
+MANIFEST
+README
+
+examples/groups.rb
+examples/users.rb
+
+lib/sys/unix.c
+lib/sys/unix.h
+lib/sys/win32.rb
+
+test/tc_admin.rb
+test/tc_unix.rb
+test/tc_win32.rb

data/README

@@ -0,0 +1,174 @@
+== Description
+   The sys-admin package is a unified, cross platform replacement for the
+   Etc module.
+   
+== Installation
+=== Win32
+	ruby test\tc_admin.rb # optional
+	ruby install.rb
+	
+=== Unix
+   ruby extconf.rb
+   nmake
+   ruby test\tc_admin.rb # optional
+   nmake site-install
+
+== Synopsis
+   require "sys/admin"
+   include Sys
+
+   # Yields a User object for each user
+   Admin.users{ |user|
+      p user
+   }
+
+   # Returns an Array of User objects
+   a = Admin.users
+
+   # Yields a Group object for each group
+   Admin.groups{ |group|
+      p group
+   }
+
+   # Returns an Array of Group objects
+   g = Admin.groups
+
+   # Get information about a particular user
+   p Admin.get_user("nobody")
+
+   # Get information about a particular group
+   p Admin.get_group("adm")
+
+== Admin
+Admin.get_login
+   Returns the user name (only) of the current login.
+
+Admin.get_user(name, host=localhost)
+Admin.get_user(uid, host=localhost, local=true)
+   Returns a User object based on +name+ or +uid+.
+   
+   Win32 only: you may specify a host from which information is retrieved.
+   The default is the local machine.  You may also specify whether to
+   retrieve a local or global account.  The default is local.
+
+Admin.get_group(name, host=localhost, local=true) 
+Admin.get_group(gid, host=localhost, local=true)
+   Returns a Group object based on +name+ or +uid+.
+   
+   Win32 only: you may specify a host from which information is retrieved.
+   The default is the local machine.  You can retrieve either a global or
+   local group, depending on the value of the +local+ argument.
+
+Admin.groups(host=localhost, local=true)
+Admin.groups(host=localhost, local=true){ |group| ... }
+   In block form, yields a Group object for each user on the system.  In
+   non-block form, returns an Array of Group objects.
+
+   Win32 only: you may specify a host from which information is retrieved.
+   The default is the local machine.  You can retrieve either a global or
+   local group, depending on the value of the +local+ argument.
+
+Admin.users(host=localhost, local=true)
+Admin.users(host=localhost, local=true){ |user| ... }
+   In block form, yields a User object for each user on the system.  In
+   non-block form, returns an Array of User objects.
+   
+   Win32 only: you may specify a host from which information is retrieved.
+   The default is the local machine.  You can retrieve either a global or
+   local group, depending on the value of the +local+ argument.
+   
+== User class
+=== User (Win32)
+	The User class has the following attributes on Win32 systems:
+	
+   * account_type
+   * caption
+   * description
+   * domain
+   * password
+   * full_name
+   * install_date
+   * name
+   * sid
+   * status
+   * disabled?
+   * local?
+   * lockout?
+   * password_changeable?
+   * password_expires?
+   * password_required?
+     
+=== User (Unix)
+	The User class has the following attributes on Unix systems:
+	
+   * name
+   * passwd
+   * uid
+   * gid
+   * dir
+   * shell
+   * gecos
+   * quota
+   * age
+   * class
+   * comment
+   * expire
+
+== Group Classes
+=== Group (Win32)
+	The Group class has the following attributes on Win32 systems:
+	
+   * caption
+   * description
+   * domain
+   * install_date
+   * name
+   * sid
+   * status
+   * gid
+   * local?
+	
+=== Group (Unix)
+	The Group class has the following attributes on Unix systems:
+	
+	* name
+	* gid
+	* members
+	* passwd
+
+== Error Classes
+AdminError < StandardError
+   Raised if anything goes wrong with any of the above methods.
+
+== Developer's Notes
+=== Win32
+	The Win32 version now uses a win32ole + WMI approach to getting
+	information.  This means that the WMI service must be running on the
+	target machine in order to work (which it is, by default).
+	
+	Note that, by default, local user and group information is retrieved
+	instead of global.  You probably do NOT want to iterate over global users
+	or groups because there can be quite a few on your domain.
+
+== Future Plans
+   The following methods will be added for both platforms:
+
+   * Admin.add_user
+   * Admin.config_user
+   * Admin.delete_user
+
+== 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.
+
+== License
+   Ruby's
+
+== Copyright
+   (C) 2005, Daniel J. Berger
+   All Rights Reserved
+
+== Author
+   Daniel J. Berger
+   djberg96@yahoo.com
+   IRC nickname: imperator/mok/rubyhacker1

data/lib/sys/admin.rb

@@ -0,0 +1,403 @@
+require "win32ole"
+require "Win32API"
+require "socket"
+
+module Sys
+   class AdminError < StandardError; end
+   
+   class Group
+      attr_accessor :caption, :description, :domain, :install_date
+      attr_accessor :name, :sid, :status, :gid
+      attr_writer :local
+      def initialize
+         yield self if block_given?
+      end
+      
+      def local?
+         @local
+      end
+      
+      def sid_type
+         @sid_type
+      end
+      
+      def sid_type=(stype)
+         case stype
+            when 1
+               @sid_type = "user"
+            when 2
+               @sid_type = "group"
+            when 3
+               @sid_type = "domain"
+            when 4
+               @sid_type = "alias"
+            when 5
+               @sid_type = "well_known_group"
+            when 6
+               @sid_type = "deleted_account"
+            when 7
+               @sid_type = "invalid"
+            when 8
+               @sid_type = "unknown"
+            when 9
+               @sid_type = "computer"
+            else
+               @sid_type = "unknown"
+         end
+         @sid_type
+      end
+   end
+   
+   class User
+   
+      attr_accessor :caption, :description, :domain, :password
+      attr_accessor :full_name, :install_date, :name, :sid, :status
+      attr_writer :disabled, :local, :lockout, :password_changeable
+      attr_writer :password_expires, :password_required
+      attr_reader :account_type
+      
+      def initialize
+         yield self if block_given?
+      end
+      
+      def account_type=(type)
+         case type
+            when 256
+               @account_type = "duplicate"
+            when 512
+               @account_type = "normal"
+            when 2048
+               @account_type = "interdomain_trust"
+            when 4096
+               @account_type = "workstation_trust"
+            when 8192
+               @account_type = "server_trust"
+            else
+               @account_type = "unknown"
+         end
+      end
+     
+      def sid_type
+         @sid_type
+      end
+     
+      def sid_type=(stype)
+         case stype
+            when 1
+               @sid_type = "user"
+            when 2
+               @sid_type = "group"
+            when 3
+               @sid_type = "domain"
+            when 4
+               @sid_type = "alias"
+            when 5
+               @sid_type = "well_known_group"
+            when 6
+               @sid_type = "deleted_account"
+            when 7
+               @sid_type = "invalid"
+            when 8
+               @sid_type = "unknown"
+            when 9
+               @sid_type = "computer"
+            else
+               @sid_type = "unknown"
+         end
+      end
+      
+      def disabled?
+         @disabled
+      end
+      
+      def local?
+         @local
+      end
+      
+      def lockout?
+         @lockout
+      end
+      
+      def password_changeable?
+         @password_changeable
+      end
+      
+      def password_expires?
+         @password_expires
+      end
+      
+      def password_required?
+         @password_required
+      end
+   end
+   
+   class Admin
+      VERSION = "1.3.1"
+      
+      # Deletes +userid+ from the given +host+, or the local host if no host
+      # is specified.
+      #
+      def self.delete_user(userid=nil, host=Socket.gethostname)
+         begin
+            adsi = WIN32OLE.connect("WinNT://#{host},Computer")
+         rescue WIN32OLERuntimeError => err
+            raise AdminError, err
+         end
+         
+         begin
+            adsi.delete("user", userid)
+         rescue WIN32OLERuntimeError => err
+            raise AdminError, err
+         end   
+      end
+      
+      # Returns the user name (only) of the current login.
+      #
+      def self.get_login
+         getlogin = Win32API.new("advapi32","GetUserName",['P','P'],'L')  
+         buffer = "\0" * 256;           
+         nsize = [256].pack("L")
+         getlogin.call(buffer,nsize)
+         len = nsize.unpack("L")[0]
+         username = buffer[0 ... len].chop
+         username
+      end
+      
+      # Returns a User object based on either +name+ or +uid+.
+      #
+      # call-seq:
+      #    get_user(name, host=localhost)
+      #    get_user(uid, host=localhost, local=true)
+      #
+      # You may specify a +host+ from which information is retrieved.  The
+      # default is the local machine.  You may also specify whether to
+      # retrieve a local or global account.  The default is local.
+      #
+      def self.get_user(uid, host=Socket.gethostname, local=true)
+         host = Socket.gethostname if host.nil?
+         cs = "winmgmts:{impersonationLevel=impersonate}!"
+         cs << "//#{host}/root/cimv2"
+         
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise AdminError, e
+         end
+         
+         query = "select * from win32_useraccount"
+         query << " where localaccount = true" if local
+         
+         if uid.kind_of?(Fixnum)
+            if local
+               query << " and sid like '%-#{uid}'"
+            else
+               query << " where sid like '%-#{uid}'"
+            end
+         else
+            if local
+               query << " and name = '#{uid}'"
+            else
+               query << " where name = '#{uid}'"
+            end
+         end
+         
+         wmi.execquery(query).each{ |user|
+            # Because our 'like' query isn't fulproof, let's parse
+            # the SID again to make sure
+            if uid.kind_of?(Fixnum)
+               if user.sid.split("-").last.to_i != uid
+                  next
+               end
+            end
+            usr = User.new do |u|
+               u.account_type = user.accounttype
+               u.caption      = user.caption
+               u.description  = user.description
+               u.disabled     = user.disabled
+               u.domain       = user.domain
+               u.full_name    = user.fullname
+               u.install_date = user.installdate
+               u.local        = user.localaccount
+               u.lockout      = user.lockout
+               u.name         = user.name
+               u.password_changeable = user.passwordchangeable
+               u.password_expires    = user.passwordexpires
+               u.password_required   = user.passwordrequired
+               u.sid      = user.sid
+               u.sid_type = user.sidtype
+               u.status   = user.status
+            end
+            return usr
+         }
+      end
+      
+      # In block form, yields a User object for each user on the system.  In
+      # non-block form, returns an Array of User objects.
+      #
+      # call-seq:
+      #    users(host=localhost, local=true)
+      #    users(host=localhost, local=true){ |user| ... }
+      #
+      # You may specify a host from which information is retrieved.  The
+      # default is the local machine.  You can retrieve either a global or
+      # group, depending on the value of the +local+ argument.
+      #
+      def self.users(host=Socket.gethostname, local=true)
+         host = Socket.gethostname if host.nil?
+         cs = "winmgmts:{impersonationLevel=impersonate}!"
+         cs << "//#{host}/root/cimv2"
+         
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise AdminError, e
+         end
+         
+         query = "select * from win32_useraccount"
+         query << " where localaccount = true" if local
+         array = []
+         
+         wmi.execquery(query).each{ |user|
+            usr = User.new do |u|
+               u.account_type = user.accounttype
+               u.caption      = user.caption
+               u.description  = user.description
+               u.disabled     = user.disabled
+               u.domain       = user.domain
+               u.full_name    = user.fullname
+               u.install_date = user.installdate
+               u.local        = user.localaccount
+               u.lockout      = user.lockout
+               u.name         = user.name
+               u.password_changeable = user.passwordchangeable
+               u.password_expires    = user.passwordexpires
+               u.password_required   = user.passwordrequired
+               u.sid      = user.sid
+               u.sid_type = user.sidtype
+               u.status   = user.status
+            end
+            
+            if block_given?
+               yield usr
+            else
+               array.push(usr)
+            end
+         }
+         return array unless block_given?
+      end
+      
+      # Returns a Group object based on either +name+ or +uid+.
+      #
+      # call-seq:
+      #    get_group(name, host=localhost, local=true) 
+      #    get_group(gid, host=localhost, local=true)
+      #
+      # You may specify a host from which information is retrieved.
+      # The default is the local machine.  You can retrieve either a global or
+      # local group, depending on the value of the +local+ argument.
+      #
+      def self.get_group(grp, host=Socket.gethostname, local=true)
+         host = Socket.gethostname if host.nil?
+         cs = "winmgmts:{impersonationLevel=impersonate}!"
+         cs << "//#{host}/root/cimv2"
+         gid = nil
+         
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise AdminError, e
+         end
+                  
+         query = "select * from win32_group"
+         query << " where localaccount = true" if local
+         
+         if grp.kind_of?(Fixnum)
+            if local
+               query << " and sid like '%-#{grp}'"
+            else
+               query << " where sid like '%-#{grp}'"
+            end
+         else
+            if local
+               query << " and name = '#{grp}'"
+            else
+               query << " where name = '#{grp}'"
+            end
+         end
+         
+         wmi.execquery(query).each{ |group|
+            gid = group.sid.split("-").last.to_i
+            
+            # Because our 'like' query isn't fulproof, let's parse
+            # the SID again to make sure
+            if grp.kind_of?(Fixnum)              
+               next if grp != gid
+            end
+            
+            grp = Group.new do |g|
+               g.caption      = group.caption
+               g.description  = group.description              
+               g.domain       = group.domain
+               g.gid          = gid
+               g.install_date = group.installdate
+               g.local        = group.localaccount
+               g.name         = group.name   
+               g.sid          = group.sid                         
+               g.sid_type     = group.sidtype
+               g.status       = group.status
+            end
+            return grp
+         }
+         # If we're here, it means it wasn't found.
+         raise AdminError, "no group found for '#{grp}'"
+      end
+   
+      # In block form, yields a Group object for each user on the system.  In
+      # non-block form, returns an Array of Group objects.
+      #
+      # call-seq:
+      #    groups(host=localhost, local=true)
+      #    groups(host=localhost, local=true){ |group| ... }
+      #
+      # You may specify a host from which information is retrieved.
+      # The default is the local machine.  You can retrieve either a global or
+      # local group, depending on the value of the +local+ argument.
+      #
+      def self.groups(host=Socket.gethostname, local=true)
+         host = Socket.gethostname if host.nil?
+         cs = "winmgmts:{impersonationLevel=impersonate}!"
+         cs << "//#{host}/root/cimv2"
+         
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise AdminError, e
+         end
+         
+         query = "select * from win32_group"
+         query << " where localaccount = true" if local
+         
+         array = []
+         wmi.execquery(query).each{ |group|
+            grp = Group.new do |g|
+               g.caption      = group.caption
+               g.description  = group.description              
+               g.domain       = group.domain
+               g.gid          = group.sid.split("-").last.to_i
+               g.install_date = group.installdate
+               g.local        = group.localaccount
+               g.name         = group.name   
+               g.sid          = group.sid                         
+               g.sid_type     = group.sidtype
+               g.status       = group.status
+            end
+            if block_given?
+               yield grp
+            else
+               array.push(grp)
+            end
+         }
+         return array unless block_given?
+      end
+   end
+end

data/test/tc_admin.rb

@@ -0,0 +1,14 @@
+###############################################################################
+# tc_admin.rb
+#
+# This exists mostly for the sake of the gemspec, so that it calls the right
+# test suite based on the platform.
+###############################################################################
+$LOAD_PATH.unshift Dir.pwd
+$LOAD_PATH.unshift Dir.pwd + "/test"
+
+if File::ALT_SEPARATOR
+   require "tc_win32"
+else
+   require "tc_unix"
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: sys-admin
+version: !ruby/object:Gem::Version 
+  version: 1.3.1
+date: 2006-11-19 00:00:00 -07:00
+summary: A unified, cross platform replacement for the 'etc' package.
+require_paths: 
+- lib
+email: djberg96@gmail.com
+homepage: http://www.rubyforge.org/projects/sysutils
+rubyforge_project: sysutils
+description: A unified, cross platform replacement for the 'etc' package.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.2
+  version: 
+platform: mswin32
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Daniel J. Berger
+files: 
+- lib/sys/admin.rb
+- CHANGES
+- README
+- MANIFEST
+test_files: 
+- test/tc_admin.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- CHANGES
+- README
+- MANIFEST
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+