sys-uname 0.7.4-mswin32

data/CHANGES

@@ -0,0 +1,115 @@
+== 0.7.4 - 19-Nov-2006
+* Internal layout changes, doc updates and gemspec improvements.
+* No code changes.
+
+== 0.7.3 - 30-Jul-2006
+* Bug fix for 64 bit platforms.
+* Minor modification of the extconf.rb file.
+
+== 0.7.2 - 5-Jul-2006
+* Removed '?' from the struct member names on MS Windows since these are no
+  longer legal.
+* Removed duplicate definition of Uname.version on MS Windows (oops).
+* Added a gemspec.
+* Added inline rdoc documentation to the source files.
+
+== 0.7.1 - 5-May-2005
+* Removed the uname.rd file.  The uname.txt file is rdoc friendly, so you
+  can autogenerate html from that file if you wish.
+* Removed the version.h file - no longer needed now that the Windows version
+  is pure Ruby.
+* Renamed test.rb to uname_test.rb
+* Minor setup modifications to the test suite.
+* This package is now hosted on RubyForge.
+
+== 0.7.0 - 11-Jan-2004
+* Scrapped the C version for Windows in favor of a pure Ruby version that uses
+  WMI + OLE.  I highly recommend using Ruby 1.8.2 or later on Win32 systems.
+  Earlier versions may cause segfaults.
+* Added the isa_list, hw_provider, hw_serial_number, srpc_domain and
+  dhcp_cache methods for Solaris.
+* Added install.rb program for Windows, and modified extconf.rb to only run on
+  non-Windows systems.
+* The 'examples' directory has been moved to the toplevel directory.
+* Removed the INSTALL file.  That information is now included in the README.
+* Documentation updates.
+
+== 0.6.1 - 25-Apr-2004
+* Simplified extconf.rb script and installation instructions.
+* Combined three test scripts into a single test script.
+* Warranty information added.
+
+== 0.6.0 - 25-Jun-2003
+* Added HP-UX support, including the id() class method (HP-UX only)
+* Fixed minor bug in extconf.rb (forgot 'require ftools' at top)
+* Added HP-UX specific tests and support
+* Made test.rb friendlier for folks without TestUnit installed
+
+== 0.5.0 - 16-Jun-2003
+* Added OS X support, including the "model" method.  Thanks to Mike Hall
+  for the patch
+* Removed VERSION() class method.  Use the constant instead
+* Moved rd documentation to its own file (under /doc directory)
+* Added a version.h file under 'lib' to store VERSION info for
+  all source files
+* Modified extconf.rb file to handle OS X support.  In addition, moved
+  test.rb into a static file under /test, instead of dynamically
+  generating it
+* Fixed up test suite.  Added OS X specific tests and support.  Should now
+  work with TestUnit 0.1.6 or later
+    
+== 0.4.1 - 7-Feb-2003
+* Fixed C89 issue (again) - thanks go to Daniel Zepeda for the spot
+* Fixed bugs in extconf.rb file (rescue clause, ftools)
+
+== 0.4.0 - 6-Feb-2003
+* MS Windows support!
+* Added a test suite and automatic test.rb creation
+* Documentation additions/fixes
+* Internal directory layout and filename changes (Changelog -> CHANGES)
+
+== 0.3.3 - 6-Jan-2003
+* Made the code C89 compliant for older compilers.  Thanks to Paul Brannan
+  for teaching me how to fix this in general.
+* Moved README to doc/uname.txt
+* Created an INSTALL file
+* Added a copyright notice
+* Added a VERSION class method
+* Changed tarball name to reflect RAA package name
+* Minor doc changes
+
+== 0.3.2 - 8-Aug-2002
+* Changed the struct name returned by the 'uname()' method from
+  "Uname::UnameStruct" to just "UnameStruct".  This was to make it
+  compliant with future versions of Ruby.  The extra namespace was
+  redundant anyway.
+* I include the documentation now, instead of making you install rd2 :)
+
+== 0.3.1 - 22-Jul-2002
+* Added the 'uname' class method, which returns a struct that contains all
+  of the uname information
+* Added a test script.  Do 'ruby test.rb' to run it.
+* If rd2 is installed on your system, the documentation is automatically
+  generated for you.
+* Moved html documentation to 'doc' directory.
+* Changed version number style to be consistent with other 'Sys' modules
+* Now installs into 'Sys-Uname-x.x.x' directory (instead of just 'Uname')
+
+== 0.03 - 6-June-2002
+* rd style documentation now inline
+* README.html is now uname.html - created via rdtool
+* The 'platform()' and 'architecture()' methods have been added for Solaris
+* You can now do an 'include Sys' to shorten your syntax
+* The whole 'Sys' class has been removed.  Delete your sys.so file if you
+  installed a previous version of Sys-Uname
+
+== 0.02 - 3-June-2002
+* Potentially fatal memory problems corrected.
+* Should now build with C++ as well
+* Thanks to Mike Hall for both the spot and the fix
+* Added a Changelog file
+* Added a README.html file
+* Added a Manifest file
+
+== 0.01 - 31-May-2002
+* Initial release (unannounced)

data/MANIFEST

@@ -0,0 +1,16 @@
+install.rb
+MANIFEST
+CHANGES
+README
+sys-uname.gemspec
+
+doc/uname.txt
+
+examples/uname_test.rb
+
+ext/extconf.rb
+ext/uname.c
+
+lib/sys/uname.rb
+
+test/tc_uname.rb

data/README

@@ -0,0 +1,42 @@
+= Prerequisites
+=== Unix
+   Ruby 1.8.0 or later.
+=== MS Windows
+   Ruby 1.8.2 or later.  Earlier versions segfault due to OLE bugs.
+   Active WMI service (normally on by default).
+
+= Installation
+=== Unix
+   ruby extconf.rb
+   make
+   ruby test/tc_uname.rb (optional)
+   make site-install
+=== MS Windows
+   ruby test\tc_uname.rb (optional)
+   ruby install.rb
+   
+= Synopsis
+   require 'sys/uname'
+   include Sys
+   
+   p Uname.uname
+   
+= Solaris Notes
+   Folks building this package on SunOS get two extra methods: architecture()
+   and platform()
+
+= OS X Notes
+   OS X users get the extra method "model()".
+
+= HP-UX Notes
+   HP-UX users get the extra method "id()".  This is actually a String, not
+   a Fixnum, because that's how it's defined in the utsname struct.
+
+= MS Windows Notes
+   The C version for Windows has been completely scrapped in favor of an OLE
+   plus WMI approach.  It is pure Ruby.  Please see the MSDN documentation for
+   the Win32_OperatingSystem class for a complete list of what each of the
+   UnameStruct members mean.
+
+= Documentation
+  For more details, see the 'uname.txt' file under the 'doc' directory. 

data/doc/uname.txt

@@ -0,0 +1,122 @@
+== Description
+   A Ruby interface to the 'uname' command.
+
+== Synopsis
+   require 'sys/uname'
+   include Sys
+
+   puts Uname.nodename
+   puts Uname.version
+   puts Uname.sysname
+   puts Uname.machine
+   puts Uname.release
+	
+   p Uname.uname
+
+== Constants
+VERSION
+   The current version number of sys-uname.
+
+== Class Methods
+Uname.sysname
+   Returns the operating system name.  e.g. "SunOS"
+    
+Uname.nodename
+   Returns the nodename.  This is usually, but not necessarily, the 
+   same as the system's hostname.
+	
+   You cannot currently set the nodename (root or otherwise). This may
+   be added in a future release.
+
+Uname.machine
+   Returns the machine hardware type.  e.g. "i686"
+    
+Uname.version
+   Returns the operating system version. e.g. "5.8".  In the case of MS
+   Windows, it returns the version plus patch information, separated by
+   a hyphen, e.g. "2915-Service Pack 2".
+    
+Uname.release
+   Returns the operating system release. e.g. "2.2.16-3"
+    
+Uname.uname
+   Returns a struct of type UnameStruct that contains sysname, nodename,
+   machine, version, and release.  On Solaris, it will also include 
+   architecture and platform.  On HP-UX, it will also include id.
+    
+   MS Windows - there are many more, and different, fields in the struct.
+   Please see the MSDN documenation for a complete explanation of what
+   each of these members mean.
+    
+== Solaris Only
+Uname.architecture
+   Returns the instruction set architecture.  e.g. "sparc"
+    
+Uname.platform
+   Returns the platform identifier.  e.g. "SUNW,Sun-Blade-100"
+    
+Uname.isa_list
+   Returns a space separated string containing a list of all variant
+   instruction set architectures executable on the current system.
+	 
+   They are listed in order of performance, from best to worst.
+
+Uname.hw_provider
+   Returns the name of the hardware manufacturer.
+
+Uname.hw_serial_number
+   Returns the ASCII representation of the hardware-specific serial number
+   of the machine that executes the function.
+
+Uname.srpc_domain
+   Returns the name of the Secure Remote Procedure Call domain, if any.
+
+Uname.dhcp_cache
+   Returns a hexidecimal encoding, in String form, of the name of the
+   interface configured by boot(1M) followed by the DHCPACK reply from
+   the server.
+    
+== OS X Only
+Uname.model
+   Returns the model type,  e.g. "PowerBook5,1"
+    
+== HP-UX Only
+Uname.id
+   Returns the id number, e.g. 234233587.  This is a String, not a Fixnum.
+
+== Notes
+   Not all of the information that you might be used to seeing with
+   a 'uname -a' is available.  This may be added in future releases,
+   but since different implementations provide different information
+   (via different header files) it will be a bit of a pain.
+
+   Windows users - please see the MSDN documentation for the
+   Win32_OperatingSystem class for a complete list of what each of the
+   UnameStruct members mean.
+
+== Known Bugs
+   None that I'm aware of.  Please log any bugs on the project page at
+   http://www.rubyforge.org/projects/sysutils.
+	
+== Future Plans
+   Add additional info for Linux, Solaris, BSD.
+
+== License
+   Ruby's
+
+== Copyright
+   (C) 2002-2006 Daniel J. Berger
+   All Rights Reserved
+
+== Warranty
+   This package is provided "as is" and without any express or
+   implied warranties, including, without limitation, the implied
+   warranties of merchantability and fitness for a particular purpose.
+
+== Author
+   Daniel Berger
+   djberg96 at gmail dot com
+   imperator on IRC (Freenode)
+	
+== See Also
+   uname(1) for unix, or WMI for MS Windows.

data/install.rb

@@ -0,0 +1,30 @@
+###############################################
+# install.rb
+#
+# This is used for MS Windows only.
+###############################################
+require "ftools"
+require "rbconfig"
+include Config
+
+unless RUBY_PLATFORM.match('mswin')
+   STDERR.puts "Run 'ruby extconf.rb; make; make site-install' instead"
+   STDERR.puts "Exiting..."
+end
+
+sitelibdir = CONFIG["sitelibdir"]
+file = nil
+
+file = "lib/sys/uname.rb"
+install_dir = sitelibdir + "/sys"
+
+unless File.exist?(install_dir)
+	begin
+		Dir.mkdir(install_dir)
+	rescue Exception => e
+		STDERR.puts "Unable to create #{install_dir}: #{e}"
+		exit
+	end
+end
+
+File.copy(file, install_dir, true)

data/lib/sys/uname.rb

@@ -0,0 +1,464 @@
+require 'win32ole'
+require 'socket'
+require 'parsedate'
+
+module Sys
+   # This is the error raised if any of the Sys::Uname methods should fail.
+   class UnameError < StandardError; end
+
+   # An interface for returning uname (platform) information.
+   class Uname
+      VERSION = '0.7.4'
+
+      fields = %w/
+         boot_device
+         build_number
+         build_type
+         caption
+         code_set
+         country_code
+         creation_class_name
+         cscreation_class_name
+         csd_version
+         cs_name
+         current_time_zone 
+         debug
+         description
+         distributed
+         foreground_application_boost
+         free_physical_memory
+         free_space_in_paging_files
+         free_virtual_memory        
+         install_date
+         last_bootup_time
+         local_date_time
+         locale
+         manufacturer
+         max_number_of_processes
+         max_process_memory_size         
+         name
+         number_of_licensed_users
+         number_of_processes
+         number_of_users
+         organization
+         os_language
+         os_product_suite
+         os_type
+         other_type_description
+         plus_product_id
+         plus_version_number
+         primary
+         quantum_length
+         quantum_type
+         registered_user
+         serial_number
+         service_pack_major_version
+         service_pack_minor_version
+         size_stored_in_paging_files        
+         status
+         system_device
+         system_directory
+         total_swap_space_size
+         total_virtual_memory_size
+         total_visible_memory_size        
+         version
+         windows_directory                
+      /
+      
+      UnameStruct = Struct.new("UnameStruct", *fields)
+
+      #########################################################################
+      # The instance name is unpredictable, so we have to resort to using
+      # the 'InstancesOf' method to get the data we need, rather than 
+      # including it as part of the connection.
+      #########################################################################
+           
+      # Returns the version plus patch information of the operating system,
+      # separated by a hyphen, e.g. "2915-Service Pack 2".
+      #
+      def self.version(host=Socket.gethostname)
+         cs = "winmgmts://#{host}/root/cimv2"
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise UnameError, e
+         else
+            query = "select * from Win32_OperatingSystem"
+            wmi.InstancesOf("Win32_OperatingSystem").each{ |ole|
+               str = "#{ole.Version} #{ole.BuildNumber}-"
+               str << "#{ole.ServicePackMajorVersion}"
+               return str
+            }
+         end
+      end
+      
+      # Returns the operating system name, e.g. "Microsoft Windows XP Home"
+      #
+      def self.sysname(host=Socket.gethostname)
+         cs = "winmgmts:{impersonationLevel=impersonate,(security)}"
+         cs << "//#{host}/root/cimv2"
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise UnameError, e
+         else
+            query = "select * from Win32_OperatingSystem"
+            wmi.InstancesOf("Win32_OperatingSystem").each{ |ole|
+               return ole.Caption
+            }
+         end
+      end
+      
+      # Returns the nodename.  This is usually, but not necessarily, the
+      # same as the system's hostname.
+      #
+      def self.nodename(host=Socket.gethostname)
+         cs = "winmgmts:{impersonationLevel=impersonate,(security)}"
+         cs << "//#{host}/root/cimv2"
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise UnameError, e
+         else
+            query = "select * from Win32_OperatingSystem"
+            wmi.InstancesOf("Win32_OperatingSystem").each{ |ole|
+               return ole.CSName
+            }
+         end
+      end
+      
+      # Returns the machine hardware type.  e.g. "i686".
+      #--
+      # This may or may not return the expected value because some CPU types
+      # were unknown to the OS when the OS was originally released.  It
+      # appears that MS doesn't necessarily patch this, either.
+      #
+      def self.machine(cpu_num=0, host=Socket.gethostname)
+         cs = "winmgmts:{impersonationLevel=impersonate,(security)}"
+         cs << "//#{host}/root/cimv2:Win32_Processor='cpu#{cpu_num}'"    
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise UnameError, e
+         else
+            # Convert a family number into the equivalent string
+	        case wmi.Family
+	           when 1
+	              return "Other"
+               when 2
+                  return "Unknown"
+               when 3
+                  return "8086"
+               when 4
+                  return "80286"
+               when 5
+                  return "80386"
+               when 6
+                  return "80486"
+               when 7
+                  return "8087"
+               when 8
+                  return "80287"
+               when 9
+                  return "80387"
+               when 10
+                  return "80487"
+               when 11
+                  return "Pentium brand"
+               when 12
+                  return "Pentium Pro"
+               when 13
+                  return "Pentium II"
+               when 14
+                  return "Pentium processor with MMX technology"
+               when 15
+                  return "Celeron"
+               when 16
+                  return "Pentium II Xeon"
+               when 17
+                  return "Pentium III"
+               when 18
+                  return "M1 Family"
+               when 19
+                  return "M2 Family"
+               when 24
+                  return "K5 Family"
+               when 25
+                  return "K6 Family"
+               when 26
+                  return "K6-2"
+               when 27
+                  return "K6-3"
+               when 28
+                  return "AMD Athlon Processor Family"
+               when 29
+                  return "AMD Duron Processor"
+               when 30
+                  return "AMD2900 Family"
+               when 31
+                  return "K6-2+"
+               when 32
+                  return "Power PC Family"
+               when 33
+                  return "Power PC 601"
+               when 34
+                  return "Power PC 603"
+               when 35
+                  return "Power PC 603+"
+               when 36
+                  return "Power PC 604"
+               when 37
+                  return "Power PC 620"
+               when 38
+                  return "Power PC X704"
+               when 39
+                  return "Power PC 750"
+               when 48
+                  return "Alpha Family"
+               when 49
+                  return "Alpha 21064"
+               when 50
+                  return "Alpha 21066"
+               when 51
+                  return "Alpha 21164"
+               when 52
+                  return "Alpha 21164PC"
+               when 53
+                  return "Alpha 21164a"
+               when 54
+                  return "Alpha 21264"
+               when 55
+                  return "Alpha 21364"
+               when 64
+                  return "MIPS Family"
+               when 65
+                  return "MIPS R4000"
+               when 66
+                  return "MIPS R4200"
+               when 67
+                  return "MIPS R4400"
+               when 68
+                  return "MIPS R4600"
+               when 69
+                  return "MIPS R10000"
+               when 80
+                  return "SPARC Family"
+               when 81
+                  return "SuperSPARC"
+               when 82
+                  return "microSPARC II"
+               when 83
+                  return "microSPARC IIep"
+               when 84
+                  return "UltraSPARC"
+               when 85
+                  return "UltraSPARC II"
+               when 86
+                  return "UltraSPARC IIi"
+               when 87
+                  return "UltraSPARC III"
+               when 88
+                  return "UltraSPARC IIIi"
+               when 96
+                  return "68040"
+               when 97
+                  return "68xxx Family"
+               when 98
+                  return "68000"
+               when 99
+                  return "68010"
+               when 100
+                  return "68020"
+               when 101
+                  return "68030"
+               when 112
+                  return "Hobbit Family"
+               when 120
+                  return "Crusoe TM5000 Family"
+               when 121
+                  return "Crusoe TM3000 Family"
+               when 128   
+                  return "Weitek"
+               when 130
+                  return "Itanium Processor"
+               when 144
+                  return "PA-RISC Family"
+               when 145
+                  return "PA-RISC 8500"
+               when 146
+                  return "PA-RISC 8000"
+               when 147
+                  return "PA-RISC 7300LC"
+               when 148
+                  return "PA-RISC 7200"
+               when 149
+                  return "PA-RISC 7100LC"
+               when 150
+                  return "PA-RISC 7100"
+               when 160
+                  return "V30 Family"
+               when 176
+                  return "Pentium III Xeon�"
+               when 177
+                  return "Pentium III Processor with Intel SpeedStep Technology"
+               when 178
+                  return "Pentium 4"
+               when 179
+                  return "Intel Xeon�"
+               when 180
+                  return "AS400 Family"
+               when 181
+                  return "Intel Xeon processor MP"
+               when 182
+                  return "AMD AthlonXP Family"
+               when 183
+                  return "AMD AthlonMP Family"
+               when 184
+                  return "Intel Itanium 2"
+               when 185
+                  return "AMD Opteron� Family"
+               when 190
+                  return "K7"
+               when 200
+                  return "IBM390 Family"
+               when 201
+                  return "G4"
+               when 202
+                  return "G5"
+               when 250
+                  return "i860"
+               when 251
+                  return "i960"
+               when 260
+                  return "SH-3"
+               when 261
+                  return "SH-4"
+               when 280
+                  return "ARM"
+               when 281
+                  return "StrongARM"
+               when 300
+                  return "6x86"
+               when 301
+                  return "MediaGX"
+               when 302
+                  return "MII"
+               when 320
+                  return "WinChip"
+               when 350
+                  return "DSP"
+               when 500
+                  return "Video Processor"  
+               else
+                  return "Unknown"
+	        end
+	     end
+      end
+      
+      # Returns the release number, e.g. 5.1.2600.
+      #
+      def self.release(host=Socket.gethostname)
+         cs = "winmgmts://#{host}/root/cimv2"
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise UnameError, e
+         else
+            query = "select * from Win32_OperatingSystem"
+            wmi.InstancesOf("Win32_OperatingSystem").each{ |ole|
+               return ole.Version
+            }
+         end
+      end
+      
+      # Returns a struct of type UnameStruct that contains sysname, nodename,
+      # machine, version, and release, as well as a plethora of other fields.
+      # Please see the MSDN documentation for what each of these fields mean.
+      #
+      def self.uname(host=Socket.gethostname)
+         cs = "winmgmts://#{host}/root/cimv2"
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise UnameError, e
+         else
+            query = "select * from Win32_OperatingSystem"
+            wmi.InstancesOf("Win32_OperatingSystem").each{ |os|
+               return UnameStruct.new(
+                  os.BootDevice,
+                  os.BuildNumber,
+                  os.BuildType,
+                  os.Caption,
+                  os.CodeSet,
+                  os.CountryCode,
+                  os.CreationClassName,
+                  os.CSCreationClassName,
+                  os.CSDVersion,
+                  os.CSName,
+                  os.CurrentTimeZone,
+                  os.Debug,
+                  os.Description,
+                  os.Distributed,
+                  os.ForegroundApplicationBoost,
+                  self.convert(os.FreePhysicalMemory),
+                  self.convert(os.FreeSpaceInPagingFiles),
+                  self.convert(os.FreeVirtualMemory),
+                  self.parse_ms_date(os.InstallDate),
+                  self.parse_ms_date(os.LastBootUpTime),
+                  self.parse_ms_date(os.LocalDateTime),
+                  os.Locale,
+                  os.Manufacturer,
+                  os.MaxNumberOfProcesses,
+                  self.convert(os.MaxProcessMemorySize),
+                  os.Name,
+                  os.NumberOfLicensedUsers,
+                  os.NumberOfProcesses,
+                  os.NumberOfUsers,
+                  os.Organization,
+                  os.OSLanguage,
+                  os.OSProductSuite,
+                  os.OSType,
+                  os.OtherTypeDescription,
+                  os.PlusProductID,
+                  os.PlusVersionNumber,
+                  os.Primary,
+                  os.QuantumLength,
+                  os.QuantumType,
+                  os.RegisteredUser,
+                  os.SerialNumber,
+                  os.ServicePackMajorVersion,
+                  os.ServicePackMinorVersion,
+                  self.convert(os.SizeStoredInPagingFiles),
+                  os.Status,
+                  os.SystemDevice,
+                  os.SystemDirectory,
+                  self.convert(os.TotalSwapSpaceSize),
+                  self.convert(os.TotalVirtualMemorySize),
+                  self.convert(os.TotalVisibleMemorySize),
+                  os.Version,
+                  os.WindowsDirectory
+               )
+            }
+         end
+      end
+      
+      private
+      
+      # Converts a string in the format '20040703074625.015625-360' into a
+      # Ruby Time object.
+      #
+      def self.parse_ms_date(str)
+         return if str.nil?
+         parsed = ParseDate.parsedate(str)
+         return Time.mktime(*parsed)
+      end
+      
+      # There is a bug in win32ole where uint64 types are returned as a
+      # String rather than a Fixnum/Bignum.  This deals with that for now.
+      #
+      def self.convert(str)
+         return nil if str.nil?  # Don't turn nil into 0
+         return str.to_i
+      end 
+   end
+end