dhcpsapi 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eab370b485c2d24997d56b50fac94077e398180c
-  data.tar.gz: b353650fc66eff961b3830c7e889e45c505a6618
+  metadata.gz: 8aa52005e543e55ac0af399ce937ade44dbfe74a
+  data.tar.gz: acaade242dcd8c290c26c056a4933f71199d3e05
 SHA512:
-  metadata.gz: 564ad7fc55c3e81878c45c6aa120a45dbc8c91fb1f1a269576b47eade09d9e1182b168575ad76d01e7dc72361e136e2b0d40f193a1d70807a89b1a127d83e7e1
-  data.tar.gz: 3cf3391b10eabfb292d181d14e41ace4ca3498e9a3e4d8bb931a9a39aa68a520f9a3da1ad60f06cbefb9cbb42b35cb61c40a74d7a9604f6299c4ee2947427421
+  metadata.gz: ba5318e348a9936bc493bd711a73ccbcd8df4d7ef76fba6578dd4d0aaad7074d23e5a02b00cbef36ebf9252fa2ff9ceae534bcc329c58d4cb1c6a93788ddee48
+  data.tar.gz: 35894f52b25644e6a9b3795e8fafc17b84b56f175b8552f2f6dcb1c071899d22c9918585e8f149f2ceb151ee00ccc0d4a8cc28ad53f6657363c68307b9191702

data/lib/dhcpsapi.rb

@@ -11,4 +11,5 @@ require 'dhcpsapi/option'
 require 'dhcpsapi/option_value'
 require 'dhcpsapi/reservation'
 require 'dhcpsapi/subnet'
+require 'dhcpsapi/subnet_element'
 require 'dhcpsapi/server'

data/lib/dhcpsapi/data_structures.rb

@@ -522,6 +522,11 @@ typedef struct _DHCP_OPTION_ARRAY {
     layout :reserved_ip_address, :uint32,
            :reserved_for_client, :pointer,
            :b_allowed_client_types, :uint8 # see ClientType
+
+    ruby_struct_attr :uint32_to_ip, :reserved_ip_address
+    def reserved_for_client_as_ruby_struct_attr
+      DHCP_CLIENT_UID.new(self[:reserved_for_client]).as_ruby_struct
+    end
   end
 
 =begin
@@ -547,6 +552,69 @@ typedef struct _DHCP_OPTION_ARRAY {
   class DHCP_SUBNET_ELEMENT_DATA_V4 < DHCPS_Struct
     layout :element_type, :uint32,
            :element, DHCP_SUBNET_ELEMENT
+
+    def self.build_for_reservation(reservation_ip, reservation_mac, client_type = DhcpsApi::ClientType::CLIENT_TYPE_DHCP)
+      subnet_element = DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.new
+      subnet_element[:element_type] = DhcpsApi::DHCP_SUBNET_ELEMENT_TYPE::DhcpReservedIps
+      subnet_element[:element][:reserved_ip] = (reserved_ip = DhcpsApi::DHCP_IP_RESERVATION_V4.new).pointer
+
+      reserved_ip[:reserved_ip_address] = reserved_ip.ip_to_uint32(reservation_ip)
+      reserved_ip[:reserved_for_client] = DhcpsApi::DHCP_CLIENT_UID.from_mac_address(reservation_mac).pointer
+      reserved_ip[:b_allowed_client_types] = client_type
+
+      subnet_element
+    end
+
+    def self.build_for_subnet_range(start_ip_address, end_ip_address)
+      subnet_element = DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.new
+      subnet_element[:element_type] = DhcpsApi::DHCP_SUBNET_ELEMENT_TYPE::DhcpIpRanges
+      subnet_element[:element][:ip_range] = (ip_range = DhcpsApi::DHCP_IP_RANGE.new).pointer
+      ip_range[:start_address] = ip_range.ip_to_uint32(start_ip_address)
+      ip_range[:end_address] = ip_range.ip_to_uint32(end_ip_address)
+
+      subnet_element
+    end
+
+    def element_as_ruby_struct_attr
+      case self[:element_type]
+        when DHCP_SUBNET_ELEMENT_TYPE::DhcpIpRanges
+          DHCP_IP_RANGE.new(self[:element][:ip_range]).as_ruby_struct
+        when DHCP_SUBNET_ELEMENT_TYPE::DhcpSecondaryHosts
+          DHCP_HOST_INFO.new(self[:element][:secondary_host]).as_ruby_struct
+        when DHCP_SUBNET_ELEMENT_TYPE::DhcpReservedIps
+          DHCP_IP_RESERVATION_V4.new(self[:element][:reserved_ip]).as_ruby_struct
+        when DHCP_SUBNET_ELEMENT_TYPE::DhcpExcludedIpRanges
+          DHCP_IP_RANGE.new(self[:element][:exclude_ip_range]).as_ruby_struct
+        else
+          self[:element]
+      end
+    end
+  end
+
+=begin
+  typedef struct _DHCP_SUBNET_ELEMENT_INFO_ARRAY_V4 {
+    DWORD                         NumElements;
+    LPDHCP_SUBNET_ELEMENT_DATA_V4 Elements;
+  } DHCP_SUBNET_ELEMENT_INFO_ARRAY_V4, *LPDHCP_SUBNET_ELEMENT_INFO_ARRAY_V4;
+=end
+  #
+  # DHCP_SUBNET_ELEMENT_INFO_ARRAY_V4 defines a list of DHCP subnet elements.
+  #
+  # Available fields:
+  # :bum_elements [Fixnum], The number of option values in the list
+  # :values [Array<DHCP_SUBNET_ELEMENT_DATA_V4>], Array of subnet elements
+  #
+  # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ee460931(v=vs.85).aspx
+  #
+  class DHCP_SUBNET_ELEMENT_INFO_ARRAY_V4 < DHCPS_Struct
+    layout :num_elements, :uint32,
+           :values, :pointer
+
+    def as_ruby_struct
+      0.upto(self[:num_elements]-1).inject([]) do |all, offset|
+        all << DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.new(self[:values] + offset*DHCP_SUBNET_ELEMENT_DATA_V4.size).as_ruby_struct
+      end
+    end
   end
 
 =begin
@@ -581,7 +649,7 @@ typedef struct _DHCP_OPTION_ARRAY {
     layout :start_address, :uint32,
            :end_address, :uint32
 
-    ruby_struct_attr :uint32_to_ip, :subnet_address, :subnet_mask
+    ruby_struct_attr :uint32_to_ip, :start_address, :end_address
   end
 
 #

data/lib/dhcpsapi/reservation.rb

@@ -38,24 +38,14 @@ module DhcpsApi
     # @see ClientType ClientType documentation for the list of available client types.
     #
     def create_reservation(reservation_ip, reservation_subnet_mask, reservation_mac, reservation_name, reservation_comment = '', client_type = DhcpsApi::ClientType::CLIENT_TYPE_DHCP)
-      subnet_element = DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.new
-      subnet_element[:element_type] = DhcpsApi::DHCP_SUBNET_ELEMENT_TYPE::DhcpReservedIps
-      subnet_element[:element][:reserved_ip] = (reserved_ip = DhcpsApi::DHCP_IP_RESERVATION_V4.new).pointer
-
-      reserved_ip[:reserved_ip_address] = ip_to_uint32(reservation_ip)
-      reserved_ip[:reserved_for_client] = DhcpsApi::DHCP_CLIENT_UID.from_mac_address(reservation_mac).pointer
-      reserved_ip[:b_allowed_client_types] = client_type
-
       ip_as_octets = reservation_ip.split('.').map {|octet| octet.to_i}
       mask_as_octets = reservation_subnet_mask.split('.').map {|octet| octet.to_i}
       subnet_address = (0..3).inject([]) {|all, i| all << (ip_as_octets[i] & mask_as_octets[i])}.join('.')
 
-      error = DhcpsApi::Win2008::SubnetElement.DhcpAddSubnetElementV4(to_wchar_string(server_ip_address), ip_to_uint32(subnet_address), subnet_element.pointer)
-      raise DhcpsApi::Error.new("Error creating reservation.", error) if error != 0
-
+      subnet_element = create_reservation_subnet_element(subnet_address, reservation_ip, reservation_mac, client_type)
       modify_client(reservation_ip, reservation_subnet_mask, reservation_mac, reservation_name, reservation_comment, 0, client_type)
 
-      subnet_element.as_ruby_struct
+      subnet_element
     end
 
     # Deletes subnet reservations.
@@ -70,21 +60,9 @@ module DhcpsApi
     #
     # @return [void]
     #
-    def delete_reservation(reservation_ip, subnet_address, reservation_mac)
-      to_delete = DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.new
-      to_delete[:element_type] = DhcpsApi::DHCP_SUBNET_ELEMENT_TYPE::DhcpReservedIps
-      to_delete[:element][:reserved_ip] = (reserved_ip = DhcpsApi::DHCP_IP_RESERVATION_V4.new).pointer
-
-      reserved_ip[:reserved_ip_address] = ip_to_uint32(reservation_ip)
-      reserved_ip[:reserved_for_client] = DhcpsApi::DHCP_CLIENT_UID.from_mac_address(reservation_mac).pointer
-      reserved_ip[:b_allowed_client_types] = DhcpsApi::ClientType::CLIENT_TYPE_NONE
-
-      error = DhcpsApi::Win2008::SubnetElement.DhcpRemoveSubnetElementV4(
-          to_wchar_string(server_ip_address),
-          ip_to_uint32(subnet_address),
-          to_delete.pointer,
-          DhcpsApi::DHCP_FORCE_FLAG::DhcpNoForce)
-      raise DhcpsApi::Error.new("Error deleting reservation.", error) if error != 0
+    def delete_reservation(reservation_ip, subnet_address, reservation_mac, client_type = DhcpsApi::ClientType::CLIENT_TYPE_DHCP)
+      delete_subnet_element(subnet_address, DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.build_for_reservation(
+          reservation_ip, reservation_mac, client_type))
     end
 
     # Sets dns configuration for a reservation.
@@ -115,6 +93,13 @@ module DhcpsApi
       set_reserved_option_value(81, reservation_ip, subnet_address, DhcpsApi::DHCP_OPTION_DATA_TYPE::DhcpDWordOption, [value])
     end
 
+    def create_reservation_subnet_element(subnet_address, reservation_ip_address, reservation_mac_address, client_type = DhcpsApi::ClientType::CLIENT_TYPE_DHCP)
+      add_subnet_element(subnet_address,
+                         DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.build_for_reservation(
+                             reservation_ip_address, reservation_mac_address, client_type)
+      )
+    end
+
     def dhcp_v4_enum_subnet_reservations(subnet_address, preferred_maximum, resume_handle)
       resume_handle_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, resume_handle)
       enum_element_info_ptr_ptr = FFI::MemoryPointer.new(:pointer)

data/lib/dhcpsapi/server.rb

@@ -1,8 +1,8 @@
 module DhcpsApi
   class Server
-    DHCPS_WIN2008_API = Object,new
-    DHCPS_WIN2012_API = Object,new
-    DHCPS_NONE = Object,new
+    DHCPS_WIN2008_API = Object.new
+    DHCPS_WIN2012_API = Object.new
+    DHCPS_NONE = Object.new
 
     include RubyStructAttrHelpers
     include CommonMethods
@@ -14,6 +14,7 @@ module DhcpsApi
     include OptionValue
     include Reservation
     include Subnet
+    include SubnetElement
 
     attr_reader :server_ip_address
 
@@ -32,6 +33,7 @@ module DhcpsApi
       require 'dhcpsapi/win2008/option_value'
       require 'dhcpsapi/win2008/subnet_element'
       require 'dhcpsapi/win2008/subnet'
+      require 'dhcpsapi/win2008/subnet_element'
 
       level = :win2008
 

data/lib/dhcpsapi/subnet.rb

@@ -83,17 +83,8 @@ module DhcpsApi
     # @return [Hash]
     #
     # @see DHCP_SUBNET_ELEMENT_DATA_V4 DHCP_SUBNET_ELEMENT_DATA_V4 documentation for the list of available fields.
-    def add_subnet_ip_range(subnet_address, start_address, end_address)
-      subnet_element = DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.new
-      subnet_element[:element_type] = DhcpsApi::DHCP_SUBNET_ELEMENT_TYPE::DhcpIpRanges
-      subnet_element[:element][:ip_range] = (ip_range = DhcpsApi::DHCP_IP_RANGE.new).pointer
-      ip_range[:start_address] = ip_to_uint32(start_address)
-      ip_range[:end_address] = ip_to_uint32(end_address)
-
-      error = DhcpsApi::Win2008::SubnetElement.DhcpAddSubnetElementV4(to_wchar_string(server_ip_address), ip_to_uint32(subnet_address), subnet_element.pointer)
-      raise DhcpsApi::Error.new("Error adding a subnet range to '%s'." % [subnet_address], error) if error != 0
-
-      subnet_element.as_ruby_struct
+    def create_subnet_ip_range(subnet_address, start_address, end_address)
+      add_subnet_element(subnet_address, DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.build_for_subnet_range(start_address, end_address))
     end
 
     # Deletes a subnet ip address range.
@@ -108,18 +99,7 @@ module DhcpsApi
     #
     # @return [void]
     def delete_subnet_ip_range(subnet_address, start_address, end_address)
-      to_delete = DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.new
-      to_delete[:element_type] = DhcpsApi::DHCP_SUBNET_ELEMENT_TYPE::DhcpIpRanges
-      to_delete[:element][:ip_range] = (ip_range = DhcpsApi::DHCP_IP_RANGE.new).pointer
-      ip_range[:start_address] = ip_to_uint32(start_address)
-      ip_range[:end_address] = ip_to_uint32(end_address)
-
-      error = DhcpsApi::Win2008::SubnetElement.DhcpRemoveSubnetElementV4(
-          to_wchar_string(server_ip_address),
-          ip_to_uint32(subnet_address),
-          to_delete.pointer,
-          DhcpsApi::DHCP_FORCE_FLAG::DhcpNoForce)
-      raise DhcpsApi::Error.new("Error deleting reservation.", error) if error != 0
+      delete_subnet_element(subnet_address, DhcpsApi::DHCP_SUBNET_ELEMENT_DATA_V4.build_for_subnet_range(start_address, end_address))
     end
 
     private

data/lib/dhcpsapi/subnet_element.rb

@@ -0,0 +1,85 @@
+module DhcpsApi
+  module SubnetElement
+    # Returns a a list of subnet elements.
+    #
+    # @example List subnet elements
+    #
+    # api.list_subnet_elements('192.168.42.0', DhcpsApi::DHCP_SUBNET_ELEMENT_TYPE::DhcpReservedIps)
+    #
+    # @param subnet_address [String] Subnet ip address
+    # @param element_type [DHCP_SUBNET_ELEMENT_TYPE] Subnet element type
+    #
+    # @return [Array<Hash>]
+    #
+    # @see DHCP_SUBNET_ELEMENT_DATA_V4 DHCP_SUBNET_ELEMENT_DATA_V4 documentation for the list of available fields.
+    #
+    def list_subnet_elements(subnet_address, element_type)
+      items, _ = retrieve_items(:dhcp_enum_subnet_elements_v4, subnet_address, element_type, 1024, 0)
+      items
+    end
+
+    # Creates a new subnet element.
+    #
+    # @example Create a new subnet element
+    #
+    # api.add_subnet_element('192.168.42.0', a_subnet_element)
+    #
+    # @param subnet_ip_address [String] Subnet ip address
+    # @param subnet_element [DHCP_SUBNET_ELEMENT_DATA_V4] Subnet element
+    #
+    # @return [Hash]
+    #
+    # @see DHCP_SUBNET_ELEMENT_DATA_V4 DHCP_SUBNET_ELEMENT_DATA_V4 documentation for the list of available fields.
+    #
+    def add_subnet_element(subnet_address, subnet_element)
+      error = DhcpsApi::Win2008::SubnetElement.DhcpAddSubnetElementV4(to_wchar_string(server_ip_address), ip_to_uint32(subnet_address), subnet_element.pointer)
+      raise DhcpsApi::Error.new("Error creating subnet element.", error) if error != 0
+      subnet_element.as_ruby_struct
+    end
+
+    # Deletes subnet element.
+    #
+    # @example Delete a subnet element
+    #
+    # api.delete_subnet_element('192.168.42.0', an_existing_subnet_element)
+    #
+    # @param subnet_ip_address [String] Subnet ip address
+    # @param subnet_element [DHCP_SUBNET_ELEMENT_DATA_V4] Subnet element
+    #
+    # @return [void]
+    #
+    def delete_subnet_element(subnet_address, subnet_element)
+      error = DhcpsApi::Win2008::SubnetElement.DhcpRemoveSubnetElementV4(
+          to_wchar_string(server_ip_address),
+          ip_to_uint32(subnet_address),
+          subnet_element.pointer,
+          DhcpsApi::DHCP_FORCE_FLAG::DhcpNoForce)
+      raise DhcpsApi::Error.new("Error deleting subnet element.", error) if error != 0
+    end
+
+    def dhcp_enum_subnet_elements_v4(subnet_address, element_type, preferred_maximum, resume_handle)
+      resume_handle_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, resume_handle)
+      subnet_element_info_ptr_ptr = FFI::MemoryPointer.new(:pointer)
+      elements_read_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, 0)
+      elements_total_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, 0)
+
+      error = DhcpsApi::Win2008::SubnetElement.DhcpEnumSubnetElementsV4(
+          to_wchar_string(server_ip_address), ip_to_uint32(subnet_address), element_type, resume_handle_ptr, preferred_maximum,
+          subnet_element_info_ptr_ptr, elements_read_ptr, elements_total_ptr)
+      return empty_response if error == 259
+      if is_error?(error)
+        unless (subnet_element_info_ptr_ptr.null? || (to_free = subnet_element_info_ptr_ptr.read_pointer).null?)
+          free_memory(DhcpsApi::DHCP_SUBNET_ELEMENT_INFO_ARRAY_V4.new(to_free))
+        end
+        raise DhcpsApi::Error.new("Error retrieving subnet elements for subnet '%s'." % [subnet_address], error)
+      end
+
+      subnet_elements_array = DhcpsApi::DHCP_SUBNET_ELEMENT_INFO_ARRAY_V4.new(subnet_element_info_ptr_ptr.read_pointer)
+      subnet_elements = subnet_elements_array.as_ruby_struct
+      free_memory(subnet_elements_array)
+
+      [subnet_elements, resume_handle_ptr.get_uint32(0), elements_read_ptr.get_uint32(0), elements_total_ptr.get_uint32(0)]
+    end
+  end
+end
+

data/lib/dhcpsapi/version.rb

@@ -1,3 +1,3 @@
 module DhcpsApi
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/dhcpsapi/win2008/subnet_element.rb

@@ -22,5 +22,20 @@ module DhcpsApi::Win2008
   );
 =end
     attach_function :DhcpRemoveSubnetElementV4, [:pointer, :uint32, :pointer, :uint32], :uint32
+
+=begin
+DWORD DHCP_API_FUNCTION DhcpEnumSubnetElementsV4(
+  _In_    DHCP_CONST WCHAR                    *ServerIpAddress,
+  _In_    DHCP_IP_ADDRESS                     SubnetAddress,
+  _In_    DHCP_SUBNET_ELEMENT_TYPE            EnumElementType,
+  _Inout_ DHCP_RESUME_HANDLE                  *ResumeHandle,
+  _In_    DWORD                               PreferredMaximum,
+  _Out_   LPDHCP_SUBNET_ELEMENT_INFO_ARRAY_V4 *EnumElementInfo,
+  _Out_   DWORD                               *ElementsRead,
+  _Out_   DWORD                               *ElementsTotal
+);
+=end
+    attach_function :DhcpEnumSubnetElementsV4, [:pointer, :uint32, :uint32, :pointer, :uint32, :pointer, :pointer, :pointer], :uint32
   end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhcpsapi
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Dmitri Dolguikh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -88,6 +88,7 @@ files:
 - lib/dhcpsapi/reservation.rb
 - lib/dhcpsapi/server.rb
 - lib/dhcpsapi/subnet.rb
+- lib/dhcpsapi/subnet_element.rb
 - lib/dhcpsapi/version.rb
 - lib/dhcpsapi/win2008/class.rb
 - lib/dhcpsapi/win2008/client.rb