kanrisuru 0.12.0 → 0.15.0

data/lib/kanrisuru/core/dmi.rb

@@ -1,533 +1,15 @@
 # frozen_string_literal: true
 
+require_relative 'dmi/types'
+require_relative 'dmi/parser'
+require_relative 'dmi/commands'
+
 module Kanrisuru
   module Core
     module Dmi
       extend OsPackage::Define
 
       os_define :linux, :dmi
-
-      ## Type 0: BIOS Information
-      BIOS = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :vendor, :version, :release_date, :address, :runtime_size,
-        :rom_size, :characteristics, :bios_revision, :firmware_revision
-      )
-
-      ## Type 1: Sytem Information
-      System = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :manufacturer, :product_name, :version, :serial_number,
-        :uuid, :wake_up_type, :sku_number, :family
-      )
-
-      ## Type 2: Baseboard Information
-      Baseboard = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :type, :manufacturer, :product_name, :version, :serial_number, :asset_tag,
-        :features, :location_in_chassis, :chassis_handle, :contained_object_handles
-      )
-
-      ## Type 3: Chassis Information
-      Chassis = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :manufacturer, :type, :lock, :version, :serial_number,
-        :asset_tag, :boot_up_state, :power_supply_state, :thermal_state,
-        :security_status, :oem_information, :height, :number_of_power_cords,
-        :contained_elements, :sku_number
-      )
-
-      ## Type 4: Processor Information
-      Processor = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :socket_designation, :type, :family, :manufacturer, :id, :signature, :flags,
-        :version, :voltage, :external_clock, :max_speed, :current_speed,
-        :status, :upgrade, :l1_cache_handle, :l2_cache_handle, :l3_cache_handle,
-        :serial_number, :asset_tag, :part_number, :core_count, :core_enabled, :thread_count,
-        :characteristics
-      )
-
-      ## Type 5: Memory Controller Information
-      MemoryController = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :error_detecting_method, :error_correcting_capabilities, :supported_interleave,
-        :current_interleave, :maximum_memory_module_size, :maximum_total_memory_size,
-        :supported_seeds, :supported_memory_types, :memory_module_voltage, :associated_memory_slots,
-        :enabled_error_correcting_capabilities
-      )
-
-      ## Type 6: Memory Module Information
-      MemoryModule = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :socket_designation, :bank_connections, :current_speed, :type, :installed_size, :enabled_size,
-        :error_status
-      )
-
-      ## Type 7: Cache Information
-      Cache = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :socket_designation, :configuration, :operational_mode, :location,
-        :installed_size, :maximum_size, :supported_sram_types, :installed_sram_type,
-        :speed, :error_correction_type, :system_type, :associativity
-      )
-
-      ## Type 8: Port Connector Information
-      PortConnector = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :internal_reference_designator,
-        :internal_connector_type,
-        :external_reference_designator,
-        :external_connector_type,
-        :port_type
-      )
-
-      ## Type 9: Sytem Slots
-      SystemSlots = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :designation, :type, :current_usage, :slot_length,
-        :id, :characteristics, :bus_address,
-        :data_bus_width, :peer_devices
-      )
-
-      ## Type 10: On Board Device Information
-      OnBoardDevice = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :type, :status, :description
-      )
-
-      ## Type 11: OEM Strings
-      OEMStrings = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :strings
-      )
-
-      ## Type 12: System Configuration Options
-      SystemConfigurationOptions = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :options
-      )
-
-      ## Type 13: BIOS Language Information
-      BIOSLanguage = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :language_description_format, :installed_languages, :currently_installed_language
-      )
-
-      ## Type 14: Group Associations
-      GroupAssociation = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :name, :items
-      )
-
-      ## Type 15: System Event Log
-      SystemEventLog = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :area_length, :header_start_offset, :header_length, :data_start_offset,
-        :access_method, :change_token, :header_format, :supported_log_type_descriptors,
-        :descriptors
-      )
-
-      ## Type 16: Physical Memory Array
-      PhysicalMemoryArray = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :location, :use, :error_correction_type, :maximum_capacity,
-        :error_information_handle, :number_of_devices
-      )
-
-      ## Type 17: Memory Device
-      MemoryDevice = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :array_handle, :error_information_handle, :total_width,
-        :data_width, :mem_size, :form_factor, :set, :locator,
-        :bank_locator, :type, :type_detail, :speed,
-        :manufacturer, :serial_number, :asset_tag,
-        :part_number, :rank, :configured_clock_speed,
-        :minimum_voltage, :maximum_voltage,
-        :configured_voltage, :configured_memory_speed,
-        :firmware_version, :model_manufacturer_id, :module_product_id,
-        :memory_subsystem_controller_manufacturer_id,
-        :memory_subsystem_controller_product_id,
-        :non_volatile_size, :cache_size, :logical_size
-      )
-
-      ## Type 18: 32-bit Memory Error Information
-      MemoryError32Bit = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :type, :granularity, :operation, :vendor_syndrome, :memory_array_address,
-        :device_address, :resolution
-      )
-
-      ## Type 19: Memory Array Mapped Address
-      MemoryArrayMappedAddress = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :starting_address, :ending_address, :range_size,
-        :physical_array_handle, :partition_width
-      )
-
-      ## Type 20: Memory Device Mapped Address
-      MemoryDeviceMappedAddress = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :starting_address, :ending_address, :range_size,
-        :physical_device_handle, :memory_array_mapped_address_handle,
-        :partition_row_position, :interleave_position,
-        :interleaved_data_depth
-      )
-
-      ## Type 21: Built-In Pointing Device
-      BuiltInPointingDevice = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :type, :inteface, :buttons
-      )
-
-      ## Type 22: Portable Battery
-      PortableBattery = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :location, :manufacturer, :manufacture_date,
-        :serial_number, :name, :chemistry,
-        :design_capacity, :design_voltage, :maximum_error,
-        :sbds_version, :sbds_serial_number, :sbds_manufacturer_date,
-        :sbds_chemistry, :oem_specific_information
-      )
-
-      ## Type 23: System Reset
-      SystemReset = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :status, :watchdog_timer, :boot_option,
-        :boot_option_on_limit, :timer_interval,
-        :reset_count, :reset_limit, :timeout
-      )
-
-      ## Type 24: Hardware Security
-      HardwareSecurity = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :power_on_password_status, :keyboard_password_status,
-        :administrator_password_status, :front_panel_reset_status
-      )
-
-      ## Type 25: System Power Controls
-      SystemPowerControls = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :next_scheduled_power_on
-      )
-
-      ## Type 26: Voltage Probe
-      VoltageProbe = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :description, :location, :status, :maximum_value,
-        :minimum_value, :resolution, :tolerance, :accuracy,
-        :oem_specific_information, :nominal_value
-      )
-
-      ## Type 27: Cooling Device
-      CoolingDevice = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :temperature_probe_handle, :type,
-        :status, :cooling_unit_group, :oem_specific_information,
-        :nominal_speed, :description
-      )
-
-      ## Type 28: Temperature Probe
-      TemperatureProbe = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :description, :location, :status,
-        :maximum_value, :minimum_value, :resolution,
-        :tolerance, :accuracy, :oem_specific_information,
-        :nominal_value
-      )
-
-      ## Type 29: Electrical Current Probe
-      ElectricalCurrentProbe = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :description, :location, :status,
-        :maximum_value, :minimum_value, :resolution,
-        :tolerance, :accuracy, :oem_specific_information,
-        :nominal_value
-      )
-
-      ## Type 30: Out-of-band Remote Access
-      OutOfBandRemoteAccess = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :manufacturer_name, :inbound_connection,
-        :outbound_connection
-      )
-
-      ## Type 31: Boot Integrity Services Entry Point
-      BootIntegrityServices = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :checksum,
-        :sixteen_bit_entry_point_address,
-        :thirty_two_bit_entry_point_address
-      )
-
-      ## Type 32: System Boot
-      SystemBoot = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :status
-      )
-
-      ## Type 33: 64-bit Memory Error
-      MemoryError64Bit = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :type, :granularity, :operation, :vendor_syndrome, :memory_array_address,
-        :device_address, :resolution
-      )
-
-      ## Type 34: Management Device
-      ManagementDevice = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :description, :type, :address, :address_type
-      )
-
-      ## Type 35: Management Device Component
-      ManagementDeviceComponent = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :description, :management_device_handle, :component_handle,
-        :threshold_handle
-      )
-
-      ## Type 36: Management Device Threshold Data
-      ManagementDeviceThresholdData = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :lower_non_critical_threshold,
-        :upper_non_critical_threshold,
-        :lower_critical_threshold,
-        :upper_critical_threshold,
-        :lower_non_recoverable_threshold,
-        :upper_non_recoverable_threshold
-      )
-
-      ## Type 37: Memory Channel
-      MemoryChannelDevice = Struct.new(
-        :load,
-        :handle
-      )
-
-      MemoryChannel = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :type, :maximal_load, :devices
-      )
-
-      ## Type 38: IPMI Device Information
-      IPMIDevice = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :interface_type, :specification_version, :i2c_slave_address,
-        :nv_storage_device_address, :nv_storage_device, :base_address, :register_spacing,
-        :interrupt_polarity, :interrupt_trigger_mode, :interrupt_number
-      )
-
-      ## Type 39: System Power Supply
-      SystemPowerSupply = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :power_unit_group, :location, :name,
-        :manufacturer, :serial_number, :asset_tag, :model_part_number,
-        :revision, :max_power_capacity, :status,
-        :type, :input_voltage_range_switching,
-        :plugged, :hot_replaceable,
-        :input_voltage_probe_handle,
-        :cooling_device_handle,
-        :input_current_probe_handle
-      )
-
-      ## Type 40: Additional Information
-      AdditionalInformation = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :referenced_handle, :referenced_offset,
-        :string, :value
-      )
-
-      ## Type 41: On Board Devices Extended Information
-      OnboardDevicesExtendedInformation = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :reference_designation, :type, :status,
-        :type_instance, :bus_address
-      )
-
-      ## Type 42: Management Controller Host Interface
-      ProtocolRecord = Struct.new(
-        :protocol_id,
-        :protocol_type_specific_data
-      )
-
-      ManagementControllerHostInterface = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :interface_type, :vendor_id, :device_type,
-        :protocol_records, :host_ip_assignment_type, :host_ip_address_format
-      )
-
-      ## Type 43: TPM Device
-      TPMDevice = Struct.new(
-        :dmi_type, :dmi_handle, :dmi_size,
-        :specification_version, :firmware_revision,
-        :description, :characteristics, :oem_specific_information
-      )
-
-      def dmi(opts = {})
-        command = Kanrisuru::Command.new('dmidecode')
-        dmi_type_opts(command, opts)
-
-        execute_shell(command)
-
-        Kanrisuru::Result.new(command) do |cmd|
-          lines = cmd.to_a
-
-          rows = []
-          current_struct = nil
-          wrapped_field_line = nil
-
-          lines.each do |line|
-            next if Kanrisuru::Util.blank?(line)
-
-            case line
-            when /^Handle/
-              if current_struct
-                rows << current_struct
-
-                current_struct = nil
-                wrapped_field_line = nil
-              end
-
-              values = line.split(', ')
-              handle = values[0].split('Handle ')[1]
-
-              type = values[1].split(/(\d+)/)[1].to_i
-              type = Kanrisuru::Util::DmiType[type]
-              next if Kanrisuru::Util.blank?(type)
-
-              bytes = values[2].split(/(\d+)/)[1]
-
-              current_struct = dmi_type_to_struct(type)
-              current_struct.dmi_handle = handle
-              current_struct.dmi_type = type
-              current_struct.dmi_size = bytes.to_i
-            when /:/
-              values = line.split(': ')
-
-              field = values[0].strip
-              value = values[1] ? values[1].strip : ''
-
-              dmi_append_field(current_struct, field, value)
-
-              case line
-              when 'Characteristics:'
-                current_struct.characteristics = []
-                wrapped_field_line = :characteristics
-              when 'Flags:'
-                current_struct.flags = []
-                wrapped_field_line = :flags
-              when 'Supported SRAM Types:'
-                current_struct.supported_sram_types = []
-                wrapped_field_line = :supported_sram_types
-              when 'Features:'
-                current_struct.features = []
-                wrapped_field_line = :features
-              when 'Strings:'
-                current_struct.strings = []
-                wrapped_field_line = :strings
-              end
-            else
-              current_struct[wrapped_field_line] << line.strip if wrapped_field_line
-            end
-          end
-
-          rows << current_struct if current_struct
-
-          rows
-        end
-      end
-
-      private
-
-      def dmi_append_field(struct, field, value)
-        field = dmi_field_translate(struct, field)
-        field = field.to_sym
-
-        if struct.respond_to?(field)
-          case struct.dmi_type
-          when 'OEM Strings'
-            if struct.strings
-              struct[field] << value
-            else
-              struct.strings = [value]
-            end
-          else
-            struct[field] = value
-          end
-        else
-          Kanrisuru.logger.warn("Field does not exist for: #{struct.dmi_type}: #{field} => #{value}")
-        end
-      end
-
-      def dmi_field_translate(struct, field)
-        field = field.downcase
-        field = field.gsub(/\s/, '_')
-        field = field.gsub('-', '_')
-        field = field.gsub(':', '')
-
-        case struct.dmi_type
-        when 'Memory Device'
-          case field
-          when 'size'
-            return 'mem_size'
-          end
-        when 'System Slots'
-          case field
-          when 'length'
-            return 'slot_length'
-          end
-        when 'OEM Strings'
-          case field
-          when /^string/
-            return 'strings'
-          end
-        when 'Boot Integrity Services'
-          case field
-          when '16_bit_entry_point_address'
-            return 'sixteen_bit_entry_point_address'
-          when '32_bit_entry_point_address'
-            return 'thirty_two_bit_entry_point_address'
-          end
-        end
-
-        field
-      end
-
-      def dmi_type_to_struct(type)
-        type =
-          case type
-          when '32-bit Memory Error'
-            'Memory Error 32 Bit'
-          when '64-bit Memory Error'
-            'Memory Error 64 Bit'
-          else
-            type
-          end
-
-        type_camelized = Kanrisuru::Util.camelize(type.gsub(/\s/, ''))
-        struct_class = Kanrisuru::Core::Dmi.const_get(type_camelized)
-        struct_class.new
-      end
-
-      def dmi_type_opts(command, opts)
-        return unless Kanrisuru::Util.present?(opts[:types])
-
-        types = opts[:types]
-        types = [types] if types.instance_of?(String)
-
-        types.each do |type|
-          type = parse_dmi_type(type)
-          command.append_arg('--type', type)
-        end
-      end
-
-      def parse_dmi_type(type)
-        raise ArgumentError, 'Invalid DMI type' unless Kanrisuru::Util::DmiType.valid?(type)
-
-        if type.instance_of?(Integer)
-          type
-        else
-          Kanrisuru::Util::DmiType[type]
-        end
-      end
     end
   end
 end

data/lib/kanrisuru/core/file/commands/chmod.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module File
+      def chmod(path, mode, opts = {})
+        recursive = opts[:recursive]
+
+        command =
+          if mode.instance_of?(String) && (mode.include?(',') || /[=+-]/.match(mode))
+            Kanrisuru::Command.new("chmod #{mode} #{path}")
+          elsif mode.instance_of?(Kanrisuru::Mode)
+            Kanrisuru::Command.new("chmod #{mode.numeric} #{path}")
+          else
+            mode = Kanrisuru::Mode.new(mode)
+            Kanrisuru::Command.new("chmod #{mode.numeric} #{path}")
+          end
+
+        command.append_flag('-R', recursive)
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do
+          stat(path).data
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/file/commands/chown.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module File
+      def chown(path, opts = {})
+        owner = opts[:owner]
+        group = opts[:group]
+
+        uid = get_uid(owner).to_i if Kanrisuru::Util.present?(owner)
+        gid = get_gid(group).to_i if Kanrisuru::Util.present?(group)
+
+        ## Don't chown a blank owner and group.
+        return false if Kanrisuru::Util.blank?(uid) && Kanrisuru::Util.blank?(gid)
+
+        command = Kanrisuru::Command.new('chown')
+
+        arg = ''
+        arg = uid.to_s if Kanrisuru::Util.present?(uid)
+        arg += ":#{gid}" if Kanrisuru::Util.present?(gid)
+
+        command.append_value(arg)
+        command.append_flag('-R', opts[:recursive])
+
+        command << path
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do
+          stat(path).data
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/file/commands/copy.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module File
+      def copy(source, dest, opts = {})
+        cp(source, dest, opts)
+      end
+
+      def cp(source, dest, opts = {})
+        backup = opts[:backup]
+        command = Kanrisuru::Command.new('cp')
+
+        command.append_flag('-R', opts[:recursive])
+        command.append_flag('-x', opts[:one_file_system])
+        command.append_flag('-u', opts[:update])
+        command.append_flag('-L', opts[:follow])
+        command.append_flag('-n', opts[:no_clobber])
+        command.append_flag('--strip-trailing-slashes', opts[:strip_trailing_slashes])
+
+        if backup.instance_of?(TrueClass)
+          command.append_flag('-b')
+        elsif Kanrisuru::Util.present?(backup)
+          raise ArgumentError, 'invalid backup control value' unless backup_control_valid?(backup)
+
+          command << "--backup=#{backup}"
+        end
+
+        if opts[:preserve].instance_of?(TrueClass)
+          command.append_flag('-p')
+        elsif Kanrisuru::Util.present?(opts[:preserve])
+          preserve =
+            (opts[:preserve].join(',') if opts[:preserve].instance_of?(Array))
+
+          command << "--preserve=#{preserve}"
+        end
+
+        if opts[:no_target_directory]
+          command.append_flag('-T')
+          command << source
+          command << dest
+        elsif opts[:target_directory]
+          command.append_arg('-t', dest)
+          command.append_array(source)
+        else
+          command.append_array(source)
+          command << dest
+        end
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/file/commands/link.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module File
+      def link(src, dest, opts = {})
+        ln(src, dest, opts)
+      end
+
+      def ln(src, dest, opts = {})
+        ## Can't hardlink dirs
+        return false if dir?(src)
+
+        command = Kanrisuru::Command.new("ln #{src} #{dest}")
+        command.append_flag('-f', opts[:force])
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do
+          stat(dest).data
+        end
+      end
+    end
+  end
+end