hardware_information 1.0.71

data/lib/hardware_information/class/misc.rb

@@ -0,0 +1,275 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class HardwareInformation
+
+  # ========================================================================= #
+  # === set_run_already
+  # ========================================================================= #
+  def set_run_already(i)
+    @run_already = i
+  end
+
+  # ========================================================================= #
+  # === pad?
+  # ========================================================================= #
+  def pad?
+    @default_padding
+  end
+
+  # ========================================================================= #
+  # === append_newline
+  # ========================================================================= #
+  def append_newline
+    add N
+  end
+
+  # ========================================================================= #
+  # === report_result
+  # ========================================================================= #
+  def report_result
+    e string?
+  end
+
+  # ========================================================================= #
+  # === string?
+  # ========================================================================= #
+  def string?
+    @string
+  end; alias string string? # === string
+
+  # ========================================================================= #
+  # === set_commandline_mode
+  # ========================================================================= #
+  def set_commandline_mode
+    @mode = :commandline
+  end
+
+  # ========================================================================= #
+  # === set_web_mode
+  # ========================================================================= #
+  def set_web_mode
+    @mode = :web
+  end
+
+  # ========================================================================= #
+  # === default_ljust
+  # ========================================================================= #
+  def default_rjust(i)
+    if i.is_a? Array # We do not handle Arrays.
+      i
+    else
+      i.to_s.rjust(MAIN_DEFAULT_RJUST)
+    end
+  end
+
+  # ========================================================================= #
+  # === _                                                             (_ tag)
+  #
+  # This method, as a shortcut, makes use of the method called add(),
+  # but it will also append a newline to the given input and support
+  # colours (if given as argument).
+  # ========================================================================= #
+  def _(i, optional_colour = nil)
+    if optional_colour and use_colours? # Add colours only if needed.
+      if optional_colour.is_a? Symbol
+        i = ::Colours.send(optional_colour, i)
+      else
+        i = optional_colour+i+rev
+      end
+    end
+    add i+N # We try it with mandatory newline for now.
+  end
+
+  # ========================================================================= #
+  # === add_title
+  # ========================================================================= #
+  def add_title
+    optional_colour = nil
+    if use_colours?
+      if Object.const_defined? :Colours # User has the colours gem installed.
+        optional_colour = :mediumslateblue
+      else
+        optional_colour = green?
+      end
+    end
+    _ N+'Hardware Information'+N, optional_colour
+  end
+
+  # ========================================================================= #
+  # === colourize_filesize_of_the_harddisc
+  # ========================================================================= #
+  def colourize_filesize_of_the_harddisc(i)
+    Colours.send(
+      @hash_use_these_colours[:filesize_of_the_harddisc],
+      i
+    )
+  end
+
+  # ========================================================================= #
+  # === colourize_file_system_type
+  # ========================================================================= #
+  def colourize_file_system_type(i)
+    Colours.send(
+      @hash_use_these_colours[:file_system_type],
+      i
+    )
+  end
+
+  # ========================================================================= #
+  # === colourize_n_percent_occupied
+  # ========================================================================= #
+  def colourize_n_percent_occupied(i)
+    Colours.send(
+      @hash_use_these_colours[:n_percent_occupied],
+      i
+    )
+  end
+
+  # ========================================================================= #
+  # === colourize_highlighted_content
+  # ========================================================================= #
+  def colourize_highlighted_content(i)
+    Colours.send(
+      @hash_use_these_colours[:highlighted_content],
+      i
+    )
+  end
+
+  # ========================================================================= #
+  # === colourize_via_regular_colour
+  #
+  # Do note that this is presently hardcoded to the "thistle" colour.
+  # Unsure whether to allow the user more customization here, so for
+  # the time being this remains hardcoded.
+  # ========================================================================= #
+  def colourize_via_regular_colour(i)
+    Colours.send(
+      :thistle,
+      i
+    )
+  end
+
+  # ========================================================================= #
+  # === append_output_generated_via_lsblk
+  #
+  # Typical output generated via lsblk may be like this:
+  #
+  #   NAME   MAJ:MIN RM  SIZE RO TYPE MOUNTPOINT
+  #   sda      8:0    0  2.7T  0 disk 
+  #   ├─sda1   8:1    0    1M  0 part 
+  #   └─sda2   8:2    0  2.7T  0 part /
+  #   sr0     11:0    1 1024M  0 rom
+  #
+  # ========================================================================= #
+  def append_output_generated_via_lsblk
+    _ = ''.dup
+    # ======================================================================== #
+    # Next we will display/obtain more information, via df.
+    # ======================================================================== #
+    extended_information = `df -T`.split(N)
+    result = `lsblk`.strip.split(N).map {|line| "    #{line}" }
+    result.each {|entry|
+      # ===================================================================== #
+      # Modify the input.
+      # ===================================================================== #
+      if entry.include? ' /'
+        # =================================================================== #
+        # These entries will be colourized. Note that the first part may
+        # look like this: "└─sda2"
+        #
+        #   "    └─sda2   8:2    0  2.7T  0 part /"
+        #
+        # =================================================================== #
+        splitted = entry.split(' ')
+        # =================================================================== #
+        # The root_entry may look like this:
+        #
+        #   /dev/sda2      ext4     2883218608 529813416 2206875608  20% /
+        #
+        # =================================================================== #
+        selection = extended_information.select {|line|
+          last = line.split(' ').last
+          last == '/' or last.include?('USB')
+        }
+        if selection
+          selection = selection.select {|inner_line|
+            inner_line.end_with? splitted[-1]
+          }
+          if selection.is_a?(Array) and selection.first
+            selection = selection.first.split(' ')
+          end
+        end
+        splitted[-1] = colourize_highlighted_content(splitted[-1].ljust(12)) # ← The last part.
+        splitted[0] = colourize_highlighted_content("    #{splitted[0]}")    # ← The first part.
+        splitted[1] = colourize_via_regular_colour(splitted[1].strip.ljust(4).rjust(6))
+        splitted[2] = colourize_via_regular_colour(" #{splitted[2].strip.rjust(2)}")
+        splitted[3] = colourize_filesize_of_the_harddisc(splitted[3].strip.rjust(5).ljust(6)) # ← The size of the harddisc.
+        splitted[4] = colourize_via_regular_colour(splitted[4].strip.ljust(2).rjust(3))
+        splitted[5] = colourize_via_regular_colour(splitted[5].strip)
+        file_system_type   = selection[1]
+        n_percent_occupied = selection[5]
+        # =================================================================== #
+        # /dev/sda2   ext4    2883218608 529753916 2206935108  20% /"]
+        # =================================================================== #
+        splitted = splitted.join(' ')
+        unless entry.include? '/boot/' # ← Don't show information for /boot/ entries.
+          splitted << colourize_file_system_type(" (#{file_system_type})")
+          splitted << colourize_n_percent_occupied(" (#{n_percent_occupied} used)")
+        end
+        entry = splitted
+      else # Else we only do a slightly simpler colourization-part.
+        splitted = entry.split(' ')
+        splitted[0] = colourize_via_regular_colour("    #{splitted[0].ljust(6)}")      # ← The first part.
+        splitted[1] = colourize_via_regular_colour(splitted[1].strip.ljust(4).rjust(6))
+        splitted[2] = colourize_via_regular_colour(" #{splitted[2].strip.rjust(2)}")
+        splitted[3] = colourize_filesize_of_the_harddisc(splitted[3].strip.rjust(5).ljust(6)) # ← The size of the harddisc.
+        splitted[4] = colourize_via_regular_colour(splitted[4].strip.ljust(2).rjust(3))
+        splitted[5] = colourize_via_regular_colour(splitted[5].strip)
+        if splitted[6] and (splitted[6] == '[SWAP]')
+          splitted[6] = royalblue(splitted[6])
+        end
+        entry = splitted.join(' ')
+        entry = colourize_via_regular_colour(entry)
+      end
+      _ << "#{entry}\n" # Now we can append this.
+    }
+    # ======================================================================= #
+    # Add two newlines too, for slightly more readable output.
+    # ======================================================================= #
+    _ << "#{N}#{N}"
+    add _
+  end
+
+  # ========================================================================= #
+  # === default_ljust
+  # ========================================================================= #
+  def default_ljust(i)
+    i.to_s.ljust(15)
+  end
+
+  # ========================================================================= #
+  # === add_audio_information                                     (audio tag)
+  # ========================================================================= #
+  def add_audio_information
+    audio_device = `aplay -l`.scan(/card.+$/).first
+    make_line(pad?+'Audio Device', N+(pad? * 2)+audio_device.to_s)
+  end
+
+  # ========================================================================= #
+  # === find_out_the_amount_of_processors
+  # ========================================================================= #
+  def find_out_the_amount_of_processors
+    data = CPUINFO.scan(/cpu cores\t: (\d+)\n/).flatten.map(&:to_i).sum.to_i
+    make_line('  Processors', data) { :slateblue }
+  end
+
+  # ========================================================================= #
+  # === add                                                         (add tag)
+  # ========================================================================= #
+  def add(i)
+    @string << i
+  end
+
+end

data/lib/hardware_information/class/obtain.rb

@@ -0,0 +1,255 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'hardware_information/class/obtain.rb'
+# =========================================================================== #
+class HardwareInformation
+
+  # ========================================================================= #
+  # === obtain_virtualization
+  #
+  # This method call may fail, depending on the output of the LSCPU
+  # command, hence why this check has to be a bit more complicated.
+  # ========================================================================= #
+  def obtain_virtualization
+    result = LSCPU.grep(/Virtualization:/)
+    if result
+      result = result.first.split(':').last.strip
+      make_line('  Virtualization', result) { :mediumseagreen }
+    end
+  end
+
+  require 'hardware_information/monitor/monitor.rb'
+  # ========================================================================= #
+  # === obtain_information_about_the_monitor
+  # ========================================================================= #
+  def obtain_information_about_the_monitor
+    make_line(
+      '  Monitor resolution',
+      ::HardwareInformation.return_the_monitor_resolution
+    ) { :mediumspringgreen }
+  end
+
+  # ========================================================================= #
+  # === obtain_information_about_the_GPU
+  # ========================================================================= #
+  def obtain_information_about_the_GPU
+    make_line(
+      '  GPU',
+      return_information_about_the_GPU
+    ) { :mediumpurple }
+  end
+
+  # ========================================================================= #
+  # === return_information_about_the_GPU
+  #
+  # This method will return information about the GPU in use on the given
+  # computer system.
+  #
+  # This may be similar to a String such as:
+  #
+  #   GPU: AMD ATI Radeon R7 Graphics
+  #
+  # ========================================================================= #
+  def return_information_about_the_GPU
+    result = `lspci #{ERROR_LINE}`.strip
+    if result and result.include?('VGA compatible controller')
+      result = result.split(N).select {|line|
+        line.include? 'VGA compatible controller'
+      }.first
+      # ===================================================================== #
+      # Work on:
+      #
+      #   VGA compatible controller: Advanced Micro Devices, Inc. [AMD/ATI] Kaveri [Radeon R7 Graphics]"
+      #
+      # ===================================================================== #
+      result = result.split('. [').last.
+               delete('[]').tr('/',' ')
+    end
+    return result
+  end
+
+  # ========================================================================= #
+  # === obtain_firmware_information
+  #
+  # Note that this functionality depends on the binary called "lshw".
+  # ========================================================================= #
+  def obtain_firmware_information
+    result = `lshw 2>&1`
+    if result
+      # ===================================================================== #
+      # See: https://rubular.com/r/Uf4XqmbZW3atCy
+      # ===================================================================== #
+      regex = 
+        /description: Motherboard\s+product: (.+)\s+vendor: (.+)\s+[.:0-9a-zA-Z\n ]+\*-firmware[.:0-9a-zA-Z\n ]+version: (\d{0,4}[0-9.]+)\s+date: (\d{1,2}.+)/
+      result =~ regex
+      motherboard = $1.to_s.dup
+      motherboard_vendor = $2.to_s.dup
+      bios_version = $3.to_s.dup
+      bios_release = $4.to_s.dup
+      # ===================================================================== #
+      # Show some more information next, in particular the BIOS.
+      # ===================================================================== #
+      make_line('  Motherboard vendor', motherboard_vendor)
+      make_line('  Motherboard', motherboard)
+      make_line('  BIOS version', bios_version)
+      make_line('  BIOS released on', bios_release)
+    end
+  end
+
+  # ========================================================================= #
+  # === obtain_vendor_id
+  # ========================================================================= #
+  def obtain_vendor_id
+    result = LSCPU.grep(/Vendor ID:/).first.split(':').last.strip
+    make_line('  Vendor ID', result) { :mediumseagreen }
+  end
+
+  # ========================================================================= #
+  # === obtain_n_cores
+  #
+  # Return how many cores that machine has.
+  # ========================================================================= #
+  def obtain_n_cores
+    make_line(
+      '  n CPU cores',
+      `nproc --all`.strip
+    ) { :lightgreen }
+  end
+
+  # ========================================================================= #
+  # === obtain_ram                                                  (ram tag)
+  # ========================================================================= #
+  def obtain_ram
+    make_line('  RAM (max)', RAM_AVAILABLE) { :orangered }
+  end
+
+  # ========================================================================= #
+  # === obtain_ram_free
+  # ========================================================================= #
+  def obtain_ram_free
+    make_line('  RAM (free)', RAM_AVAILABLE_FREE) { :orangered }
+  end
+
+  # ========================================================================= #
+  # === obtain_swap_size                                           (swap tag)
+  # ========================================================================= #
+  def obtain_swap_size
+    _ = DATASET_FROM_PROC_MEMINFO.grep(/SwapTotal:/).first.
+        split('  ').last.strip.upcase
+    make_line('  SwapTotal', _) { :springgreen }
+  end
+
+  # ========================================================================= #
+  # === obtain_system_bogomips
+  #
+  # BogoMIPS measure CPU speed.
+  # ========================================================================= #
+  def obtain_system_bogomips
+    make_line '  BogoMIPS',
+      SPLITTED_CPUINFO.select {|line|
+        line.include? 'bogomips'
+      }.first.split(':')[1].strip
+  end
+
+  # ========================================================================= #
+  # === obtain_pci_information
+  # ========================================================================= #
+  def obtain_pci_information
+    array_fetch_these_types = %w(
+      SMBus Audio IDE VGA
+      Memory Controller
+    )
+    results = []
+    if LSPCI
+      LSPCI.split(N).each {|line|
+        array_fetch_these_types.each { |inner_line|
+          results << line if line.include? inner_line
+        }
+      }
+      make_line '  PCI Devices', results
+    end
+  end
+
+  # ========================================================================= #
+  # === obtain_chip_mhz
+  # ========================================================================= #
+  def obtain_chip_mhz
+    make_line '  Chip MHzx',
+      SPLITTED_CPUINFO.select {|line|
+        line.include? 'cpu MHz'
+      }.first.split(':')[1].strip
+  end
+
+  # ========================================================================= #
+  # === obtain_cache_size
+  # ========================================================================= #
+  def obtain_cache_size
+    make_line '  Cache Size',
+      SPLITTED_CPUINFO.select {|line|
+        line.include? 'cache size'
+      }.first.split(':')[1].strip
+  end
+
+  # ========================================================================= #
+  # === obtain_cpu_model
+  # ========================================================================= #
+  def obtain_cpu_model
+    result = SPLITTED_CPUINFO.select {|line|
+      line.include? 'model name'
+    }.first.split(':')[1].strip
+    make_line '  Model', result
+  end
+
+  # ========================================================================= #
+  # === obtain_byte_order
+  # ========================================================================= #
+  def obtain_byte_order
+    result = LSCPU.grep(/Byte Order:/).first.split(':').last.strip
+    make_line '  Byte Order', result
+  end
+
+  # ========================================================================= #
+  # === obtain_cpu_family
+  # ========================================================================= #
+  def obtain_cpu_family
+    result = LSCPU.grep(/CPU family:/).first.split(':').last.strip
+    make_line '  CPU family', result
+  end
+
+  # ========================================================================= #
+  # === obtain_model
+  # ========================================================================= #
+  def obtain_model
+    result = LSCPU.grep(/Model:/).first.split(':').last.strip
+    make_line '  Model', result
+  end
+
+  # ========================================================================= #
+  # === obtain_cpu_op_modes
+  # ========================================================================= #
+  def obtain_cpu_op_modes
+    result = LSCPU.grep(/CPU op-mode/).first.split(':').last.strip
+    make_line('  CPU op-mode(s)', result)
+  end
+
+  # ========================================================================= #
+  # === obtain_linux_kernel_version
+  #
+  # This method should return a String, such as '4.14.4'.
+  # ========================================================================= #
+  def obtain_linux_kernel_version
+    result = `uname -r`.strip
+    make_line('  Linux kernel version', result)
+  end
+
+  # ========================================================================= #
+  # === obtain_architecture
+  # ========================================================================= #
+  def obtain_architecture
+    result = LSCPU.grep(/Architecture:/).first.split(':').last.strip
+    make_line('  Architecture', result) { :violet }
+  end
+
+end

data/lib/hardware_information/class/reset.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'hardware_information/class/reset.rb'
+# =========================================================================== #
+class HardwareInformation
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @string
+    # ======================================================================= #
+    @string = ''.dup
+    # ======================================================================= #
+    # === @default_colour
+    # ======================================================================= #
+    @default_colour = green?
+    # ======================================================================= #
+    # === @default_padding
+    #
+    # This variable denotes the leading padding. That padding will be
+    # prepended to the output.
+    # ======================================================================= #
+    @default_padding = ' '.dup # 1 space.
+    # ======================================================================= #
+    # === @use_colours
+    # ======================================================================= #
+    @use_colours = true # If true we use ANSI colours.
+    # ======================================================================= #
+    # === @use_colon_as_delimiter
+    # ======================================================================= #
+    @use_colon_as_delimiter = true # If true we use colon as delimiter.
+    # ======================================================================= #
+    # === @hash_use_these_colours
+    #
+    # Next we will load the internal .yml file, if it exists.
+    # ======================================================================= #
+    @hash_use_these_colours = {}
+    if File.exist? FILE_COLOURS_FOR_THE_HARDWARE_PROJECT
+      require 'yaml'
+      @hash_use_these_colours.update(
+        YAML.load_file(FILE_COLOURS_FOR_THE_HARDWARE_PROJECT)
+      )
+    else # else use a hardcoded approach.
+      @hash_use_these_colours[:filesize_of_the_harddisc] = :orchid
+      @hash_use_these_colours[:file_system_type] = :steelblue
+    end
+    set_commandline_mode # Default.
+  end
+
+end

data/lib/hardware_information/class/run.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'hardware_information/class/run.rb'
+# =========================================================================== #
+class HardwareInformation
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    add_title
+    obtain_architecture                  # === Architecture
+    obtain_cpu_model                     # === The CPU model, such as "AMD"
+    obtain_cpu_op_modes                  # === CPU op-modes
+    obtain_n_cores                       # === n CPU cores
+    find_out_the_amount_of_processors    # === Amount of processors
+    obtain_vendor_id                     # === Vendor ID
+    obtain_virtualization                # === Virtualization
+    obtain_linux_kernel_version          # === The Linux kernel version
+    obtain_ram                           # === Amount of RAM
+    obtain_ram_free
+    obtain_swap_size                     # === SwapTotal
+    obtain_chip_mhz                      # === Chip MHzx
+    obtain_cache_size
+    obtain_system_bogomips               # === BogoMIPS
+    obtain_byte_order
+    obtain_cpu_family
+    obtain_model                         # === Model
+    obtain_information_about_the_GPU     # === Show the GPU in use
+    obtain_firmware_information          # === Firmware Information
+    obtain_pci_information
+    add_audio_information                # === Show the audio device
+    obtain_information_about_the_monitor # === Gather information about the monitor
+    append_newline
+    append_output_generated_via_lsblk
+    report_result if @run_already # Last but not least, report the result.
+  end
+
+  # ========================================================================= #
+  # === HardwareInformation.run
+  # ========================================================================= #
+  def self.run
+    self.new
+  end; self.instance_eval { alias report run } # === HardwareInformation.report
+
+end

data/lib/hardware_information/css/project.css

@@ -0,0 +1,3 @@
+#image1 {
+  border: 1px solid black;
+}

data/lib/hardware_information/gui/gtk2/purchased_hardware/purchased_hardware.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === HardwareInformation::GUI::Gtk::PurchasedHardware
+# =========================================================================== #
+# require 'hardware_information/gui/gtk2/purchased_hardware/purchased_hardware.rb'
+# HardwareInformation::GUI::Gtk::PurchasedHardware.new
+# =========================================================================== #
+require 'gtk_paradise/require_gtk2'
+
+class HardwareInformation
+
+module GUI
+
+module Gtk
+
+class PurchasedHardware < ::Gtk::VBox
+
+  require 'hardware_information/gui/shared_code/purchased_hardware/purchased_hardware_module.rb'
+  include ::HardwareInformation::GUI::Gtk::PurchasedHardwareModule
+
+  # ========================================================================= #
+  # === HardwareInformation::GUI::Gtk::PurchasedHardware.run
+  # ========================================================================= #
+  def self.run
+    ::HardwareInformation::GUI::Gtk::PurchasedHardwareModule.run
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  HardwareInformation::GUI::Gtk::PurchasedHardware.run
+end