rdp-ruby-wmi 0.3.1

data/History.txt

@@ -0,0 +1,44 @@
+== 0.3.0 / 2008-04-30
+
+* 2 major enhancements
+  * added #all, #first, and #last methods as aliases for
+    #find(:all), #find(:first), and #find(:last)
+  * added #set_wmi_class_name method, similar to ActiveRecord's #set_table_name
+  
+    This allows you to create models with names you like.
+    
+    <code>
+      class Disk < WMI::Base
+        set_wmi_class_name "Win32_LogicalDisk"
+      end
+      
+      disks = Disk.all
+    </code>
+
+
+== 0.2.2 / 2008-01-11
+
+* 1 major enhancement
+  * supports privileges
+    <code>
+      events = WMI::Win32_NTLogEvent.find(
+        :all,
+        :privileges => [WMI::Privilege::Security],
+        :conditions => {:logfile => 'Security', :eventcode => '517'} )
+    </code>
+* minor enhancements
+    * added error handling for invalid queries and class name typos
+    * better documentation
+
+== 0.2.1 / 2007-07-19
+
+* minor enhancements
+  * fixed version numbers
+  * fixed sample code
+
+
+== 0.2.0 / 2007-07-19
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ruby-wmi.rb
+lib/ruby-wmi/base.rb
+lib/ruby-wmi/constants.rb
+lib/ruby-wmi/core_ext.rb
+lib/ruby-wmi/core_ext/time_ext.rb
+lib/ruby-wmi/core_ext/win32ole_ext.rb
+samples/disk.rb
+samples/logoff.rb
+samples/memory.rb
+test/test_ruby-wmi.rb

data/README.txt

@@ -0,0 +1,66 @@
+ruby-wmi
+    by Gordon Thiesfeld
+    http://ruby-wmi.rubyforge.org/
+    gthiesfeld@gmail.com
+
+== DESCRIPTION:
+
+  ruby-wmi is an ActiveRecord style interface for Microsoft's Windows
+  Management Instrumentation provider.
+
+  Many of the methods in WMI::Base are borrowed directly, or with some
+  modification from ActiveRecord.
+    http://api.rubyonrails.org/classes/ActiveRecord/Base.html
+
+  The major tool in this library is the #find method.  For more
+  information, see WMI::Base.
+
+  There is also a WMI.sublasses method included for reflection.
+
+== SYNOPSIS:
+
+  # The following code sample kills all processes of a given name
+  # (in this case, Notepad), except the oldest.
+
+    require 'ruby-wmi'
+
+    procs = WMI::Win32_Process.find(:all,
+                                    :conditions => { :name => 'Notepad.exe' }
+                                   )
+    morituri = procs.sort_by{|p| p.CreationDate } #those who are about to die
+    morituri.shift
+    morituri.each{|p| p.terminate }
+
+== REQUIREMENTS:
+
+    Windows 2000 or newer
+    Ruby 1.8
+
+== INSTALL:
+
+  gem install ruby-wmi
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Gordon Thiesfeld
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'jeweler'
+
+Jeweler::Tasks.new do |p|
+  p.name = 'rdp-ruby-wmi'
+  p.summary = 'WMI queries, easier'
+  p.author = 'Gordon Thiesfeld'
+  p.email = 'gthiesfeld@gmail.com'
+  p.summary = "ruby-wmi is an ActiveRecord style interface for Microsoft\'s Windows Management Instrumentation provider."
+  p.description = File.read 'README.txt'
+  p.rdoc_options = ['--title' , p.name ,
+                       '--main' , 'README.txt' ,
+                       '--line-numbers']
+                
+  p.homepage = 'http://rubyforge.org/projects/ruby-wmi/'
+
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/lib/ruby-wmi.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'ruby-wmi/core_ext'
+require 'ruby-wmi/constants'
+require 'ruby-wmi/base'

data/lib/ruby-wmi/base.rb

@@ -0,0 +1,213 @@
+require 'win32ole'
+
+module WMI
+
+  # Generic WMI exception class.
+  class WMIError < StandardError
+  end
+
+  # Invalid Class exception class.
+  class InvalidClass < WMIError
+  end
+
+  # Invalid Query exception class.
+  class InvalidQuery < WMIError
+  end
+
+  # Returns an array conating all the WMI subclasses
+  # on a sytem.  Defaults to localhost
+  #
+  #   WMI.subclasses
+  #   => ["Win32_PrivilegesStatus", "Win32_TSNetworkAdapterSettingError", ...]
+  #
+  #  For a more human readable version of subclasses when using options:
+  #
+  #   WMI.subclasses_of(:host => some_computer)
+  #   => ["Win32_PrivilegesStatus", "Win32_TSNetworkAdapterSettingError", ...]
+  def subclasses(options ={})
+    Base.set_connection(options)
+    b = Base.send(:connection)
+    b.SubclassesOf.map { |subclass| class_name = subclass.Path_.Class }
+  end
+
+
+  alias :subclasses_of :subclasses
+
+  extend self
+
+  class Base
+  # Many of the methods in Base are borrowed directly, or with some modification from ActiveRecord
+  #   http://api.rubyonrails.org/classes/ActiveRecord/Base.html
+
+    class << self
+    
+      # #find_by_wql currently only works when called through #find
+      # it may stay like that too.  I haven't decided.
+      def find_by_wql(query)
+        d = connection.ExecQuery(query)
+        begin
+          d.count # needed to check for errors.  Weird, but it works.
+        rescue => error
+          case error.to_s
+          when /Invalid class/i ; raise InvalidClass
+          when /Invalid query/i ; raise InvalidQuery
+
+          end
+        end
+        d.to_a
+      end
+
+      #  WMI::Win32ComputerSystem.find(:all)
+      #    returns an array of Win32ComputerSystem objects
+      #
+      #  WMI::Win32ComputerSystem.find(:first)
+      #    returns the first Win32ComputerSystem object
+      #
+      #  WMI::Win32ComputerSystem.find(:last)
+      #    returns the last Win32ComputerSystem object
+      #
+      #  options:
+      #
+      #    :conditions
+      #
+      #     Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
+      #     The array form is to be used when the condition input is tainted and requires sanitization. The string form can
+      #     be used for statements that don't involve tainted data. The hash form works much like the array form, except
+      #     only equality and range is possible. Examples:
+      #
+      #       Win32ComputerSystem.find(:all, :conditions => {:drivetype => 3} )  # Hash
+      #       Win32ComputerSystem.find(:all, :conditions => [:drivetype, 3] )   # Array
+      #       Win32ComputerSystem.find(:all, :conditions => 'drivetype = 3' )   # String
+      #
+      #    :host       - computername, defaults to localhost
+      #    :class      - swebm class , defaults to 'root\\cimv2'
+      #    :privileges - see WMI::Privilege for a list of privileges
+      #    :user       - username (domain\\username)
+      #    :password   - password
+      def find(arg=:all, options={})
+        set_connection options
+        case arg
+          when :all; find_all(options)
+          when :first; find_first(options)
+          when :last; find_last(options)
+        end
+      end
+
+      # an alias for find(:last)      
+      def last(options={})
+        find(:last, options)
+      end
+      
+      # an alias for find(:first)      
+      def first(options={})
+        find(:first, options)
+      end
+      
+      # an alias for find(:all)
+      def all(options={})
+        find(:all, options)
+      end
+
+      def set_connection(options={})
+        @host = options[:host]
+        @klass = options[:class] || 'root\\cimv2'
+        @user,@password = options[:user], options[:password]
+        @privileges = options[:privileges]
+      end
+      
+      def set_wmi_class_name(name)
+        @subclass_name = name
+      end
+
+      def subclass_name
+        @subclass_name ||= self.name.split('::').last
+      end
+
+    private
+
+      def connection
+        @c ||= WIN32OLE.new("WbemScripting.SWbemLocator")
+        @privileges.each { |priv| @c.security_.privileges.add(priv, true) } if @privileges
+        @c.ConnectServer(@host,@klass,@user,@password)
+      end
+
+      def find_first(options={})
+        find_all(options).first
+      end
+      
+      def find_last(options={})
+        find_all(options).last
+      end
+
+      def find_all(options={})
+        find_by_wql(construct_finder_sql(options))
+      end
+
+      def construct_finder_sql(options)
+        #~ scope = scope(:find)
+        sql  = "SELECT #{options[:select] || '*'} "
+        sql << "FROM #{options[:from] || subclass_name} "
+
+        #~ add_joins!(sql, options, scope)
+        add_conditions!(sql, options[:conditions], nil)
+
+        sql << " GROUP BY #{options[:group]} " if options[:group]
+
+        #~ add_order!(sql, options[:order], scope)
+        #~ add_limit!(sql, options, scope)
+        #~ add_lock!(sql, options, scope)
+
+        sql
+      end
+
+      def add_conditions!(sql, conditions, scope = :auto)
+        #~ scope = scope(:find) if :auto == scope
+        segments = []
+        segments << sanitize_sql(conditions)  unless conditions.nil?
+        #~ segments << conditions unless conditions.nil?
+        #~ segments << type_condition unless descends_from_active_record?
+        segments.compact!
+        sql << "WHERE #{segments.join(") AND (")} " unless segments.empty?
+        sql.gsub!("\\","\\\\\\")
+      end
+
+      # Accepts an array, hash, or string of sql conditions and sanitizes
+      # them into a valid SQL fragment.
+      #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
+      #   { :name => "foo'bar", :group_id => 4 }  returns "name='foo''bar' and group_id='4'"
+      #   "name='foo''bar' and group_id='4'" returns "name='foo''bar' and group_id='4'"
+      def sanitize_sql(condition)
+        case condition
+          when Array; sanitize_sql_array(condition)
+          when Hash;  sanitize_sql_hash(condition)
+          else        condition
+        end
+      end
+
+      # Sanitizes a hash of attribute/value pairs into SQL conditions.
+      #   { :name => "foo'bar", :group_id => 4 }
+      #     # => "name='foo''bar' and group_id= 4"
+      #   { :status => nil, :group_id => [1,2,3] }
+      #     # => "status IS NULL and group_id IN (1,2,3)"
+      def sanitize_sql_hash(attrs)
+        conditions = attrs.map do |attr, value|
+          #~ "#{table_name}.#{connection.quote_column_name(attr)} #{attribute_condition(value)}"
+          "#{attr} = '#{value}'"
+        end.join(' AND ')
+
+        #~ replace_bind_variables(conditions, attrs.values)
+      end
+    end
+  end
+
+  private
+
+  def const_missing(name)
+    self.const_set(name, Class.new(self::Base))
+  end
+
+  # allow for "WMI.Win32_Disk" style access
+  def self.method_missing(m, *args)
+   eval("WMI::" + m)
+  end
+end

data/lib/ruby-wmi/constants.rb

@@ -0,0 +1,94 @@
+module WMI
+  module Privilege
+    # Required to create a primary token.
+    CreateToken = 1
+
+    # Required to assign the primary token of a process.
+    PrimaryToken = 2
+
+    # Required to lock physical pages in memory.
+    LockMemory = 3
+
+    # Required to increase the quota assigned to a process.
+    IncreaseQuota = 4
+
+    # Required to create a machine account.
+    MachineAccount = 5
+
+    # Identifies its holder as part of the trusted computer base. Some trusted, protected
+    # subsystems are granted this privilege.
+    Tcb = 6
+
+    # Required to perform a number of security-related functions, such as controlling and
+    # viewing audit messages. This privilege identifies its holder as a security operator.
+    #
+    Security = 7
+
+    # Required to take ownership of an object without being granted discretionary access.
+    # This privilege allows the owner value to be set only to those values that the holder
+    # may legitimately assign as the owner of an object.
+    TakeOwnership = 8
+
+    # Required to load or unload a device driver.
+    LoadDriver = 9
+
+    # Required to gather profiling information for the entire system.
+    SystemProfile = 10
+
+    # Required to modify the system time.
+    Systemtime = 11
+
+    # Required to gather profiling information for a single process.
+    ProfileSingleProcess = 12
+
+    # Required to increase the base priority of a process.
+    IncreaseBasePriority = 13
+
+    # Required to create a paging file.
+    CreatePagefile = 14
+
+    # Required to create a permanent object.
+    CreatePermanent = 15
+
+    # Required to perform backup operations.
+    Backup = 16
+
+    # Required to perform restore operations. This privilege enables you to set any valid
+    # user or group security identifier (SID) as the owner of an object.
+    Restore = 17
+
+    # Required to shut down a local system.
+    Shutdown = 18
+
+    # Required to debug a process.
+    Debug = 19
+
+    # Required to generate audit-log entries.
+    Audit = 20
+
+    # Required to modify the nonvolatile RAM of systems that use this type of memory to store
+    # configuration information.
+    SystemEnvironment = 21
+
+    # Required to receive notifications of changes to files or directories. This privilege
+    # also causes the system to skip all traversal access checks. It is enabled by default
+    # for all users.
+    ChangeNotify = 22
+
+    # Required to shut down a system using a network request.
+    RemoteShutdown = 23
+
+    # Required to remove a computer from a docking station.
+    Undock = 24
+
+    # Required to synchronize directory service data.
+    SyncAgent = 25
+
+    # Required to enable computer and user accounts to be trusted for delegation.
+    EnableDelegation = 26
+
+    # Required to perform volume maintenance tasks. Windows 2000, Windows NT 4.0, and Windows
+    # Me/98/95:  This privilege is not available.
+    ManageVolume = 27
+  end
+end