virtualbox 0.6.1 → 0.7.0

data/lib/virtualbox/com/interface/3.2.x/storage_controller.rb

@@ -0,0 +1,24 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class StorageController < AbstractInterface
+          IID = "6bf8335b-d14a-44a5-9b45-ddc49ce7d5b2"
+
+          property :name, WSTRING, :readonly => true
+          property :max_devices_per_port_count, T_UINT32, :readonly => true
+          property :min_port_count, T_UINT32, :readonly => true
+          property :max_port_count, T_UINT32, :readonly => true
+          property :instance, T_UINT32
+          property :port_count, T_UINT32
+          property :bus, :StorageBus, :readonly => true
+          property :controller_type, :StorageControllerType
+          property :use_host_io_cache, T_BOOL
+
+          function :get_ide_emulation_port, T_INT32, [T_INT32]
+          function :set_ide_emulation_port, nil, [T_INT32, T_INT32]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/storage_controller_type.rb

@@ -0,0 +1,11 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class StorageControllerType < AbstractEnum
+          map [:null, :lsi_logic, :bus_logic, :intel_ahci, :piix3, :piix4, :ich6, :i82078, :lsi_logic_sas]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/system_properties.rb

@@ -0,0 +1,42 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class SystemProperties < AbstractInterface
+          IID = "8030645c-8fef-4320-bb7b-c829f00069dc"
+
+          property :min_guest_ram, T_UINT32, :readonly => true
+          property :max_guest_ram, T_UINT32, :readonly => true
+          property :min_guest_vram, T_UINT32, :readonly => true
+          property :max_guest_vram, T_UINT32, :readonly => true
+          property :min_guest_cpu_count, T_UINT32, :readonly => true
+          property :max_guest_cpu_count, T_UINT32, :readonly => true
+          property :max_guest_monitors, T_UINT32, :readonly => true
+          property :max_vdi_size, T_UINT64, :readonly => true
+          property :network_adapter_count, T_UINT32, :readonly => true
+          property :serial_port_count, T_UINT32, :readonly => true
+          property :parallel_port_count, T_UINT32, :readonly => true
+          property :max_boot_position, T_UINT32, :readonly => true
+          property :default_machine_folder, WSTRING
+          property :default_hard_disk_folder, WSTRING
+          property :medium_formats, [:MediumFormat], :readonly => true
+          property :default_hard_disk_format, WSTRING
+          property :free_disk_space_warning, T_UINT64
+          property :free_disk_space_percent_warning, T_UINT32
+          property :free_disk_space_error, T_UINT64
+          property :free_disk_space_percent_error, T_UINT64
+          property :remote_display_auth_library, WSTRING
+          property :web_service_auth_library, WSTRING
+          property :log_history_count, T_UINT32
+          property :default_audio_driver, :AudioDriverType, :readonly => true
+
+          function :get_max_devices_per_port_for_storage_bus, T_UINT32, [:StorageBus]
+          function :get_min_port_count_for_storage_bus, T_UINT32, [:StorageBus]
+          function :get_max_port_count_for_storage_bus, T_UINT32, [:StorageBus]
+          function :get_max_instances_of_storage_bus, T_UINT32, [:StorageBus]
+          function :get_device_types_for_storage_bus, [:DeviceType], [:StorageBus]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/usb_controller.rb

@@ -0,0 +1,21 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class USBController < AbstractInterface
+          IID = "238540fa-4b73-435a-a38e-4e1d9eab5c17"
+
+          property :enabled, T_BOOL
+          property :enabled_ehci, T_BOOL
+          property :proxy_available, T_BOOL, :readonly => true
+          property :usb_standard, T_UINT16, :readonly => true
+          property :device_filters, [:USBDeviceFilter], :readonly => true
+
+          function :create_device_filter, :USBDeviceFilter, [WSTRING]
+          function :insert_device_filter, nil, [T_UINT32, :USBDeviceFilter]
+          function :remove_device_filter, :USBDeviceFilter, [T_UINT32]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/usb_device.rb

@@ -0,0 +1,24 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class USBDevice < AbstractInterface
+          IID = "f8967b0b-4483-400f-92b5-8b675d98a85b"
+
+          property :id, WSTRING, :readonly => true
+          property :vendor_id, T_UINT16, :readonly => true
+          property :product_id, T_UINT16, :readonly => true
+          property :revision, T_UINT16, :readonly => true
+          property :manfacturer, WSTRING, :readonly => true
+          property :product, WSTRING, :readonly => true
+          property :serial_number, WSTRING, :readonly => true
+          property :address, WSTRING, :readonly => true
+          property :port, T_UINT16, :readonly => true
+          property :version, T_UINT16, :readonly => true
+          property :port_version, T_UINT16, :readonly => true
+          property :remote, T_BOOL, :readonly => true
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/usb_device_filter.rb

@@ -0,0 +1,23 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class USBDeviceFilter < AbstractInterface
+          IID = "d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
+
+          property :name, WSTRING
+          property :active, T_BOOL
+          property :vendor_id, WSTRING
+          property :product_id, WSTRING
+          property :revision, WSTRING
+          property :manufacturer, WSTRING
+          property :product, WSTRING
+          property :serial_number, WSTRING
+          property :port, WSTRING
+          property :remote, WSTRING
+          property :masked_interfaces, T_UINT32
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/usb_device_filter_action.rb

@@ -0,0 +1,11 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class USBDeviceFilterAction < AbstractEnum
+          map [:null, :ignore, :hold]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/usb_device_state.rb

@@ -0,0 +1,11 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class USBDeviceState < AbstractEnum
+          map [:not_supported, :unavailable, :busy, :available, :help, :captured]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/virtual_box_error_info.rb

@@ -0,0 +1,17 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class VirtualBoxErrorInfo < AbstractInterface
+          IID = "4b86d186-407e-4f9e-8be8-e50061be8725"
+
+          property :result_code, T_UINT32, :readonly => true
+          property :interface_i_d, WSTRING, :readonly => true
+          property :component, WSTRING, :readonly => true
+          property :text, WSTRING, :readonly => true
+          property :next, :VirtualBoxErrorInfo, :readonly => true
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/virtual_system_description.rb

@@ -0,0 +1,19 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class VirtualSystemDescription < AbstractInterface
+          IID = "d7525e6c-531a-4c51-8e04-41235083a3d8"
+
+          property :count, T_UINT32, :readonly => true
+
+          function :get_description, nil, [[:out, [:VirtualSystemDescriptionType]], [:out, [WSTRING]], [:out, [WSTRING]], [:out, [WSTRING]], [:out, [WSTRING]]]
+          function :get_description_by_type, nil, [:VirtualSystemDescriptionType, [:out, [:VirtualSystemDescriptionType]], [:out, [WSTRING]], [:out, [WSTRING]], [:out, [WSTRING]], [:out, [WSTRING]]]
+          function :get_values_by_type, [WSTRING], [:VirtualSystemDescriptionType, :VirtualSystemDescriptionValueType]
+          function :set_final_values, nil, [[T_BOOL], [WSTRING], [WSTRING]]
+          function :add_description, nil, [:VirtualSystemDescriptionType, WSTRING, WSTRING]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/virtual_system_description_type.rb

@@ -0,0 +1,14 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class VirtualSystemDescriptionType < AbstractEnum
+          map [:null, :ignore, :os, :name, :product, :vendor, :version, :product_url, :vendor_url,
+                :description, :license, :misc, :cpu, :memory, :hard_disk_controller_ide,
+                :hard_disk_controller_sata, :hard_disk_controller_scsi, :hard_disk_controller_sas, :hard_disk_image,
+                :floppy, :cdrom, :network_adapter, :usb_controller, :sound_card]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/virtual_system_description_value_type.rb

@@ -0,0 +1,11 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class VirtualSystemDescriptionValueType < AbstractEnum
+          map [:null, :reference, :original, :auto, :extra_config]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/virtualbox.rb

@@ -0,0 +1,67 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class VirtualBox < AbstractInterface
+          IID_STR = "3f36e024-7fed-4f20-a02c-9158a82b44e6"
+
+          property :version, WSTRING, :readonly => true
+          property :revision, T_ULONG, :readonly => true
+          property :package_type, WSTRING, :readonly => true
+          property :home_folder, WSTRING, :readonly => true
+          property :settings_file_path, WSTRING, :readonly => true
+          property :host, :Host, :readonly => true
+          property :system_properties, :SystemProperties, :readonly => true
+          property :machines, [:Machine], :readonly => true
+          property :hard_disks, [:Medium], :readonly => true
+          property :dvd_images, [:Medium], :readonly => true
+          property :floppy_images, [:Medium], :readonly => true
+          property :progress_operations, [:Progress], :readonly => true
+          property :guest_os_types, [:GuestOSType], :readonly => true
+          property :shared_folders, [:SharedFolder], :readonly => true
+          property :performance_collector, :PerformanceCollector, :readonly => true
+          property :dhcp_servers, [:DHCPServer], :readonly => true
+
+          function :create_machine, :Machine, [WSTRING, WSTRING, WSTRING, WSTRING, T_BOOL]
+          function :create_legacy_machine, :Machine, [WSTRING, WSTRING, WSTRING, WSTRING]
+          function :open_machine, :Machine, [WSTRING]
+          function :register_machine, :Machine, [:Machine]
+          function :get_machine, :Machine, [WSTRING]
+          function :find_machine, :Machine, [WSTRING]
+          function :unregister_machine, :Machine, [WSTRING]
+          function :create_appliance, :Appliance, []
+          function :create_hard_disk, :Medium, [WSTRING, WSTRING]
+          function :open_hard_disk, :Medium, [WSTRING, T_UINT32, T_BOOL, WSTRING, T_BOOL, WSTRING]
+          function :get_hard_disk, :Medium, [WSTRING]
+          function :find_hard_disk, :Medium, [WSTRING]
+          function :open_dvd_image, :Medium, [WSTRING, WSTRING]
+          function :get_dvd_image, :Medium, [WSTRING]
+          function :find_dvd_image, :Medium, [WSTRING]
+          function :open_floppy_image, :Medium, [WSTRING, WSTRING]
+          function :get_floppy_image, :Medium, [WSTRING]
+          function :find_floppy_image, :Medium, [WSTRING]
+          function :get_guest_os_type, :GuestOSType, [WSTRING]
+          function :create_shared_folder, nil, [WSTRING, WSTRING, T_BOOL]
+          function :remove_shared_folder, nil, [WSTRING]
+          function :get_extra_data_keys, [WSTRING], []
+          function :get_extra_data, WSTRING, [WSTRING]
+          function :set_extra_data, nil, [WSTRING, WSTRING]
+          function :open_session, nil, [:Session, WSTRING]
+          function :open_remote_session, :Progress, [:Session, WSTRING, WSTRING, WSTRING]
+          function :open_existing_session, nil, [:Session, WSTRING]
+
+          # TODO: The following two are wrong, they don't take a
+          # string as input
+          function :register_callback, nil, [WSTRING]
+          function :unregister_callback, nil, [WSTRING]
+
+          function :wait_for_property_change, nil, [WSTRING, T_UINT32, [:out, WSTRING], [:out, WSTRING]]
+          function :create_dhcp_server, :DHCPServer, [WSTRING]
+          function :find_dhcp_server_by_network_name, :DHCPServer, [WSTRING]
+          function :remove_dhcp_server, nil, [:DHCPServer]
+          function :check_firmware_present, T_BOOL, [:FirmwareType, WSTRING, [:out, WSTRING], [:out, WSTRING]]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/vrdp_auth_type.rb

@@ -0,0 +1,11 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class VRDPAuthType < AbstractEnum
+          map [:null, :external, :guest]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/3.2.x/vrdp_server.rb

@@ -0,0 +1,21 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_3_2_X
+        class VRDPServer < AbstractInterface
+          IID = "72e671bc-1712-4052-ad6b-e45e76d9d3e4"
+
+          property :enabled, T_BOOL
+          property :ports, WSTRING
+          property :net_address, WSTRING
+          property :auth_type, :VRDPAuthType
+          property :auth_timeout, T_UINT32
+          property :allow_multi_connection, T_BOOL
+          property :reuse_single_connection, T_BOOL
+          property :video_channel, T_BOOL
+          property :video_channel_quality, T_UINT32
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/mscom_interface.rb

@@ -1,6 +1,6 @@
 module VirtualBox
   module COM
-    class MSCOMInterface
+    class MSCOMInterface < BaseInterface
       # The VirtualBox and Session interfaces, both of which are extremely
       # important in interfacing with the VirtualBox API. Once these have been
       # initialized, all other parts of the API can be accessed via these
@@ -9,14 +9,19 @@ module VirtualBox
       attr_reader :session
 
       def initialize
+        super
         initialize_mscom
       end
 
       def initialize_mscom
         require 'win32ole'
-        @virtualbox = Interface::VirtualBox.new(Implementer::MSCOM, self, WIN32OLE.new("VirtualBox.VirtualBox"))
-        @session = Interface::Session.new(Implementer::MSCOM, self, WIN32OLE.new("VirtualBox.Session"))
+
+        # TODO: Dynamic version finding
+        COM::Util.set_interface_version("3.1.x")
+
+        @virtualbox = COM::Util.versioned_interface(:VirtualBox).new(Implementer::MSCOM, self, WIN32OLE.new("VirtualBox.VirtualBox"))
+        @session = COM::Util.versioned_interface(:Session).new(Implementer::MSCOM, self, WIN32OLE.new("VirtualBox.Session"))
       end
     end
   end
-end
+end

data/lib/virtualbox/com/nil_interface.rb

@@ -0,0 +1,7 @@
+module VirtualBox
+  module COM
+    # Used for tests
+    class NilInterface < BaseInterface
+    end
+  end
+end

data/lib/virtualbox/com/util.rb

@@ -1,7 +1,7 @@
 module VirtualBox
   module COM
     class Util
-      class <<self
+      class << self
         # Returns a boolean true/false whether the given COM interface
         # exists.
         #
@@ -12,7 +12,21 @@ module VirtualBox
         rescue NameError
           false
         end
+
+        # Gets an interface within the current version namespace.
+        def versioned_interface(interface)
+          Object.module_eval("::VirtualBox::COM::Interface::#{version_const}::#{interface}")
+        end
+
+        # Returns a namespace representation for a version.
+        def version_const
+          "Version_" + @__version.upcase.gsub(".", "_")
+        end
+
+        def set_interface_version(version)
+          @__version = version
+        end
       end
     end
   end
-end
+end

data/lib/virtualbox/com.rb

@@ -20,4 +20,4 @@ comdir = File.join(File.dirname(__FILE__), 'com')
 require File.expand_path("abstract_interface", comdir)
 require File.expand_path("abstract_enum", comdir)
 VirtualBox::GlobLoader.glob_require(File.join(comdir, "interface"))
-VirtualBox::GlobLoader.glob_require(comdir, %w{abstract_interface abstract_implementer util ffi/interface ffi/util implementer/base})
+VirtualBox::GlobLoader.glob_require(comdir, %w{base_interface abstract_interface abstract_implementer util ffi/interface ffi/util implementer/base})

data/lib/virtualbox/cpu.rb

@@ -0,0 +1,61 @@
+module VirtualBox
+  # Represents the CPU properties on a VM.
+  class CPU < AbstractModel
+    attribute :parent, :readonly => true, :property => false
+    attribute_scope(:property_getter => Proc.new { |instance, *args| instance.get_property(*args) },
+                    :property_setter => Proc.new { |instance, *args| instance.set_property(*args) }) do
+      attribute :pae, :boolean => true
+      attribute :synthetic, :boolean => true
+    end
+
+    class << self
+      # Populates a relationship with another model.
+      #
+      # **This method typically won't be used except internally.**
+      #
+      # @return [CPU]
+      def populate_relationship(caller, imachine)
+        data = new(caller, imachine)
+      end
+
+      # Saves the relationship.
+      #
+      # **This method typically won't be used except internally.**
+      def save_relationship(caller, instance)
+        instance.save
+      end
+    end
+
+    def initialize(parent, imachine)
+      write_attribute(:parent, parent)
+
+      # Load the attributes and mark the whole thing as existing
+      load_interface_attributes(imachine)
+      clear_dirty!
+      existing_record!
+    end
+
+    def get_property(interface, key)
+      interface.get_cpu_property(key)
+    end
+
+    def set_property(interface, key, value)
+      interface.set_cpu_property(key, value)
+    end
+
+    def validate
+      super
+
+      validates_inclusion_of :pae, :synthetic, :in => [true, false]
+    end
+
+    def save
+      parent.with_open_session do |session|
+        machine = session.machine
+
+        # Save them
+        save_changed_interface_attributes(machine)
+      end
+    end
+  end
+end

data/lib/virtualbox/dhcp_server.rb

@@ -0,0 +1,89 @@
+module VirtualBox
+  class DHCPServer < AbstractModel
+    attribute :parent, :readonly => true, :property => false
+    attribute :parent_collection, :readonly => true, :property => false
+    attribute :interface, :readonly => true, :property => false
+    attribute :enabled
+    attribute :ip_address
+    attribute :network_mask
+    attribute :network_name, :readonly => true
+    attribute :lower_ip
+    attribute :upper_ip
+
+    class << self
+      # Populates a relationship with another model.
+      #
+      # **This method typically won't be used except internally.**
+      #
+      # @return [Array<DHCPServer>]
+      def populate_relationship(caller, servers)
+        relation = Proxies::Collection.new(caller, self)
+
+        servers.each do |interface|
+          relation << new(interface)
+        end
+
+        relation
+      end
+
+      # Creates a DHCP server for the given network name.
+      # This method should not be called directly, its recommended that you call
+      # the `create` method on the `dhcp_servers` relationship on
+      # `VirtualBox::Global` object.
+      def create(proxy, network_name)
+        interface = proxy.parent.lib.virtualbox.create_dhcp_server(network_name)
+        new(interface)
+      end
+    end
+
+    def initialize(raw)
+      initialize_attributes(raw)
+    end
+
+    def initialize_attributes(raw)
+      write_attribute(:interface, raw)
+
+      load_interface_attributes(interface)
+      existing_record!
+    end
+
+    def added_to_relationship(proxy)
+      write_attribute(:parent, proxy.parent)
+      write_attribute(:parent_collection, proxy)
+    end
+
+    def save
+      configs = [:ip_address, :network_mask, :lower_ip, :upper_ip]
+      configs_changed = configs.map { |key| changed?(key) }.any? { |i| i }
+
+      if configs_changed
+        interface.set_configuration(ip_address, network_mask, lower_ip, upper_ip)
+
+        # Clear the dirtiness so that the abstract model doesn't try
+        # to save the attributes
+        configs.each do |key|
+          clear_dirty!(key)
+        end
+      end
+
+      save_changed_interface_attributes(interface)
+    end
+
+    # Removes the DHCP server.
+    def destroy
+      parent.lib.virtualbox.remove_dhcp_server(interface)
+      parent_collection.delete(self, true)
+      true
+    end
+
+    # Returns the host network associated with this DHCP server, if it
+    # exists.
+    def host_network
+      return nil unless network_name =~ /^HostInterfaceNetworking-(.+?)$/
+
+      parent.host.network_interfaces.detect do |i|
+        i.interface_type == :host_only && i.name == $1.to_s
+      end
+    end
+  end
+end

data/lib/virtualbox/dvd.rb

@@ -12,7 +12,7 @@ module VirtualBox
   #     DVD.all
   #
   class DVD < Medium
-    class <<self
+    class << self
       # Returns an array of all available DVDs as DVD objects
       def all
         Global.global.media.dvds
@@ -24,4 +24,4 @@ module VirtualBox
       end
     end
   end
-end
+end

data/lib/virtualbox/exceptions.rb

@@ -6,6 +6,10 @@ module VirtualBox
 
     class NonSettableRelationshipException < Exception; end
     class ValidationFailedException < Exception; end
+    class MediumLocationInUseException < Exception; end
+    class MediumCreationFailedException < Exception; end
+    class MediumNotUpdatableException < Exception; end
+    class ReadonlyVMStateException < Exception; end
 
     class FFIException < Exception
       attr_accessor :data

data/lib/virtualbox/ext/platform.rb

@@ -1,6 +1,6 @@
 module VirtualBox
   class Platform
-    class <<self
+    class << self
       def mac?
         platform.include?("darwin")
       end
@@ -18,4 +18,4 @@ module VirtualBox
       end
     end
   end
-end
+end

data/lib/virtualbox/extra_data.rb

@@ -39,7 +39,7 @@ module VirtualBox
 
     @@global_data = nil
 
-    class <<self
+    class << self
       # Gets the global extra data. This will "cache" the data for
       # future use unless you set the `reload` paramter to true.
       #
@@ -116,13 +116,12 @@ module VirtualBox
     # Alias away the old delete method so its still accessible somehow
     alias :hash_delete :delete
 
-    # Deletes the specified extra data. This method is deferred, meaning that
-    # although the key itself is marked to be deleted (by setting the value
-    # to nil), the deletion itself does not occur until {#save} is called.
+    # Deletes the specified extra data.
     #
     # @param [String] key The extra data key to delete
     def delete(key)
-      self[key] = nil
+      interface.set_extra_data(key.to_s, nil)
+      hash_delete(key.to_s)
     end
   end
-end
+end