velir_virtualbox 0.8.4

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

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

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

@@ -0,0 +1,17 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_4_0_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/4.0.x/virtual_system_description.rb

@@ -0,0 +1,19 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_4_0_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/4.0.x/virtual_system_description_type.rb

@@ -0,0 +1,14 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_4_0_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/4.0.x/virtual_system_description_value_type.rb

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

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

@@ -0,0 +1,50 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_4_0_X
+        class VirtualBox < AbstractInterface
+          IID_STR = "D2DE270C-1D4B-4C9E-843F-BBB9B47269FF"
+
+          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
+          property :event_source, :EventSource, :readonly => true
+          property :extension_pack_manager, :ExtPackManager, :readonly => true
+
+          function :compose_machine_filename, WSTRING, [WSTRING, WSTRING]
+          function :create_machine, :Machine, [WSTRING, WSTRING, WSTRING, WSTRING, T_BOOL]
+          function :open_machine, :Machine, [WSTRING]
+          function :register_machine, nil, [:Machine]
+          function :find_machine, :Machine, [WSTRING]
+          function :create_appliance, :Appliance, []
+          function :create_hard_disk, :Medium, [WSTRING, WSTRING]
+          function :open_medium, :Medium, [WSTRING, :DeviceType, :AccessMode]
+          function :find_medium, :Medium, [WSTRING, :DeviceType]
+          function :get_guest_os_type, :GuestOSType, [WSTRING]
+          function :create_shared_folder, nil, [WSTRING, WSTRING, T_BOOL, 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 :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/4.0.x/vrde_server.rb

@@ -0,0 +1,23 @@
+module VirtualBox
+  module COM
+    module Interface
+      module Version_4_0_X
+        class VRDEServer < AbstractInterface
+          IID = "72e671bc-1712-4052-ad6b-e45e76d9d3e4"
+
+          property :enabled, T_BOOL
+          property :auth_type, :AuthType
+          property :auth_timeout, T_UINT32
+          property :allow_multi_connection, T_BOOL
+          property :reuse_single_connection, T_BOOL
+          property :vrde_ext_pack, WSTRING
+          property :auth_library, WSTRING
+          property :vrde_properties, [WSTRING], :readonly => true
+
+          function :set_vrde_property, nil, [WSTRING, WSTRING]
+          function :get_vrde_property, WSTRING, [WSTRING]
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/mscom_interface.rb

@@ -0,0 +1,44 @@
+module VirtualBox
+  module COM
+    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
+      # instances.
+      attr_reader :virtualbox
+      attr_reader :session
+
+      def initialize
+        super
+        initialize_mscom
+      end
+
+      def initialize_mscom
+        require 'win32ole'
+
+        interface_dir = File.expand_path(File.join(File.dirname(__FILE__), "interface"))
+        Dir[File.join(interface_dir, "*")].each do |f|
+          return if File.directory?(f) && initialize_for_version(File.basename(f))
+        end
+      end
+
+      def initialize_for_version(version)
+        COM::Util.set_interface_version(version)
+
+        @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"))
+
+        vb_version = @virtualbox.version
+
+        # Check if they match or not.
+        return false if vb_version.length == version.length
+        (0...(version.length)).each do |i|
+          next if version[i,1] == "x"
+          return false if version[i,1] != vb_version[i,1]
+        end
+
+        true
+      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

@@ -0,0 +1,32 @@
+module VirtualBox
+  module COM
+    class Util
+      class << self
+        # Returns a boolean true/false whether the given COM interface
+        # exists.
+        #
+        # @return [Boolean]
+        def interface?(name)
+          COM::Interface.const_get(name.to_sym)
+          true
+        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

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

@@ -0,0 +1,27 @@
+module VirtualBox
+  # Represents a DVD image stored by VirtualBox. These DVD images can be
+  # mounted onto virtual machines. Because DVD just inherits from {Medium},
+  # it also inherits all methods and attributes which are on {Medium}. For more
+  # attributes, the ability to destroy, etc, please view {Medium}.
+  #
+  # # Finding all DVDs
+  #
+  # The only method at the moment of finding DVDs is to use {DVD.all}, which
+  # returns an array of {DVD}s.
+  #
+  #     DVD.all
+  #
+  class DVD < Medium
+    class << self
+      # Returns an array of all available DVDs as DVD objects
+      def all
+        Global.global.media.dvds
+      end
+
+      # Override of {Medium.device_type}.
+      def device_type
+        :dvd
+      end
+    end
+  end
+end

data/lib/virtualbox/exceptions.rb

@@ -0,0 +1,39 @@
+module VirtualBox
+  # Gem specific exceptions will reside under this namespace for easy
+  # documentation and searching.
+  module Exceptions
+    class Exception < ::Exception; end
+
+    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 UnsupportedVersionException < Exception; end
+
+    class FFIException < Exception
+      attr_accessor :data
+
+      def initialize(data={})
+        @data = data
+        super("Error in API call to #{data[:function]}: #{data[:result_code]}")
+      end
+    end
+
+    # FFI Exceptions, these exceptions are only raised on *nix machines
+    # when some error occurs in the foreign function interface.
+    class ObjectNotFoundException < FFIException; end
+    class InvalidVMStateException < FFIException; end
+    class VMErrorException < FFIException; end
+    class FileErrorException < FFIException; end
+    class SubsystemException < FFIException; end
+    class PDMException < FFIException; end
+    class InvalidObjectStateException < FFIException; end
+    class HostErrorException < FFIException; end
+    class NotSupportedException < FFIException; end
+    class XMLErrorException < FFIException; end
+    class InvalidSessionStateException < FFIException; end
+    class ObjectInUseException < FFIException; end
+  end
+end