directory_paradise 1.4.4

data/lib/directory_paradise/report/misc.rb

@@ -0,0 +1,675 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'directory_paradise/report/misc.rb'
+# =========================================================================== #
+require 'directory_paradise/base/base.rb'
+
+module DirectoryParadise
+
+class Report < Base # === DirectoryParadise::Report
+
+  # ========================================================================= #
+  # === set_work_on_this_directory
+  #
+  # This method will determine on which target directory (the base
+  # directory) this class will work on.
+  #
+  # It must be ensured that this variable will have a trailing '/'
+  # character, to properly indicate that we are dealing with a
+  # directory here.
+  # ========================================================================= #
+  def set_work_on_this_directory(
+      i = return_pwd
+    )
+    # ======================================================================= #
+    # === Handle Hashes first
+    # ======================================================================= #
+    if i.is_a? Hash
+      if i.has_key? :from
+        i = i.delete(:from)
+      end
+    end
+    if i.is_a? Array
+      _ = return_non_hyphen_entries_from(i)
+      if _.empty?
+        i = return_pwd
+      else
+        i = _
+      end
+      i = i.join(' ').strip if i.is_a? Array
+    end
+    case i
+    # ======================================================================= #
+    # === :dont_run_yet
+    # ======================================================================= #
+    when :dont_run_yet
+      i = nil
+      @run_already = false
+    # ======================================================================= #
+    # === :show_content
+    # ======================================================================= #
+    when :show_content
+      do_show_the_content
+      i = return_pwd
+    end
+    begin
+      # ===================================================================== #
+      # Default values come next here in this clause.
+      # ===================================================================== #
+      i = return_pwd if i.nil?
+      i = i.dup if i.frozen?
+      # ===================================================================== #
+      # We need to default to the current directory if there exists a
+      # directory with that name.
+      # ===================================================================== #
+      i = return_pwd unless Dir.exist?(i)
+      if i.is_a? String and i.empty?
+        i = return_pwd
+      end
+    rescue Errno::ENOENT # Rescue non-existing directories.
+      e 'An error occurred. The directory may have been removed or the local'
+      e "filesystem is unavailable. Thus, we will display \"/\" instead.#{N}"
+      i = '/'
+    end
+    i = i.dup if i.frozen?
+    i << '/' unless i.end_with? '/'
+    i.squeeze!('/')
+    @internal_hash[:work_on_this_directory] = i
+  end; alias set_from_which_directory set_work_on_this_directory # === set_from_which_directory
+       alias set_dir                  set_work_on_this_directory # === set_dir
+       alias set_main_directory       set_work_on_this_directory # === set_main_directory
+       alias set_base_directory       set_work_on_this_directory # === set_base_directory
+
+
+  # ========================================================================= #
+  # === apply_filter
+  #
+  # Use this method here to apply a filter on the main entries.
+  # ========================================================================= #
+  def apply_filter(i)
+    i = i.dup if i.frozen?
+    i.delete!('*') if i.include? '*'
+    i.delete!('/') if i.include? '/' # This may be incorrect.
+    obtain_entries unless entries?
+    entries?.select! {|entry|
+      entry.include?(i)
+    }
+    entries?
+  end
+
+  # ========================================================================= #
+  # === consider_colourizing_filename
+  # ========================================================================= # 
+  def consider_colourizing_filename(filename)
+    result = ''.dup
+    if File.exist? filename
+      filetype = File.ftype(filename)
+      unless show_leading_slash?
+        filename[0,1] = '' if filename.start_with? '/'
+      end
+      # ===================================================================== #
+      # Next, honour the variable @show_full_path if it was set to true.
+      # ===================================================================== #
+      unless show_full_path?
+        filename = File.basename(filename)
+      end
+      case filetype
+      when 'link' # Handle Symlinks here.
+        result = colourize_symlink(filename)
+      when 'directory'
+        result = colourize_directory(filename) # This is actually sdir().
+      when 'file'
+        result = sfile(filename)
+      end
+    end
+    result
+  end
+
+  # ========================================================================= #
+  # === do_ignore_backups
+  # ========================================================================= #
+  def do_ignore_backups
+    # ======================================================================= #
+    # Do not list implied entries ending with '~' in the following option.
+    # ======================================================================= #
+    if ignore_backups?
+      directory_content?.ignore_backups
+    end
+  end
+
+  # ========================================================================= #
+  # === consider_sorting_by
+  #
+  # This is the specific sorting-action. The method will delegate onto
+  # class DirectoryContent::ShowDirectoryContent.
+  # ========================================================================= #
+  def consider_sorting_by(
+      i = sort_by?
+    )
+    directory_content?.consider_sorting_by(i)
+  end
+
+  # ========================================================================= #
+  # === shorten_file_elegantly
+  #
+  # We need to take into account that our file could be a directory too.
+  # ========================================================================= #
+  def shorten_file_elegantly(
+      i, threshold = FILE_SIZE_THRESHOLD
+    )
+    i = i.to_s.dup
+    middle_pos = (i.size / 2) - 10
+    oversize = i.size - threshold # The oversize value
+    if oversize > 0
+      start_pos = middle_pos - (oversize / 2)
+      end_pos   = start_pos + oversize
+      i[start_pos .. end_pos] = '[… Truncated …]' # This is the padding to use.
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === do_not_display_content
+  # ========================================================================= #
+  def do_not_display_content
+    @internal_hash[:display_content] = false # if true, we display() the result.
+  end
+
+  # ========================================================================= #
+  # === do_show_the_content
+  # ========================================================================= #  
+  def do_show_the_content
+    @internal_hash[:display_content] = true
+  end; alias do_display_content do_show_the_content # === do_display_content
+
+  # ========================================================================= #
+  # === colourize_symlink
+  #
+  # Use this method to colourize a symlink.
+  # ========================================================================= #
+  def colourize_symlink(i)
+    result = return_name_of_this_symlink(i)
+    # ======================================================================= #
+    # Check whether we will use colours or whether we will not.
+    # ======================================================================= #
+    if File.symlink?(i)
+      if use_colours?
+        if stop_on_missing_symlink? and !File.readlink?(i)
+          opn; e "The symlink for #{i} does not exist."
+          opn; e 'Exiting now, as set per a configuration option.'
+          exit
+        end
+        result = ' → '+
+                 skyblue(
+                   File.readlink(i)
+                 ) # Need to readlink on the original variant.
+      else
+        result = ' → '+File.readlink(i)
+      end
+    end
+    result
+  end
+
+  # ========================================================================= #
+  # === return_name_of_this_symlink
+  #
+  # File.basename() kills off leading '/', hence we need this method.
+  # ========================================================================= #
+  def return_name_of_this_symlink(i)
+    i = File.basename(i)
+    if return_pwd == '/' and show_leading_slash?
+      i.prepend '/'
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === do_show_only_symlinks
+  # ========================================================================= #
+  def do_show_only_symlinks
+    @internal_hash[:show_only_symlinks] = true
+  end
+
+  # ========================================================================= #
+  # === toggle_permission
+  # ========================================================================= #
+  def toggle_permission
+    _ = @internal_hash[:show_condensed_permissions]
+    @internal_hash[:show_condensed_permissions] = !_ # Toggle it here.
+  end
+
+  # ========================================================================= #
+  # === do_not_display_only_directories
+  # ========================================================================= #
+  def do_not_display_only_directories
+    @internal_hash[:display_only_directories] = false # Whether to display only directories or not.
+  end
+
+  # ========================================================================= #
+  # === dont_show_header
+  # ========================================================================= #
+  def dont_show_header
+    @internal_hash[:show_header] = false
+  end; alias do_not_show_the_header dont_show_header # === do_not_show_the_header
+
+  # ========================================================================= #
+  # === do_show_hidden_files
+  # ========================================================================= # 
+  def do_show_hidden_files
+    @internal_hash[:show_hidden_files] = true
+  end
+
+  # ========================================================================= #
+  # == dont_show_index
+  # ========================================================================= #
+  def dont_show_index
+    @internal_hash[:show_index] = false
+  end; alias do_not_show_the_index dont_show_index # === do_not_show_the_index
+       alias do_not_show_index     dont_show_index # === do_not_show_index
+
+  # ========================================================================= #
+  # === toggle_colourize
+  # ========================================================================= #
+  def toggle_colourize
+    if @internal_hash[:colourize_kb_and_mb] == false
+      @internal_hash[:colourize_kb_and_mb] = true
+    else
+      @internal_hash[:colourize_kb_and_mb] = false
+    end
+  end; alias toggle toggle_colourize # === toggle
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    @internal_hash[:default_colour]
+  end
+
+  # ========================================================================= #
+  # === do_not_stop_on_missing_symlink
+  # ========================================================================= #
+  def do_not_stop_on_missing_symlink
+    @internal_hash[:stop_on_missing_symlink] = false # if true we will stop on missing symlink.
+  end
+
+  # ========================================================================= #
+  # === do_show_condensed_permissions
+  # ========================================================================= #
+  def do_show_condensed_permissions
+    @internal_hash[:show_condensed_permissions] = true
+  end
+
+  # ========================================================================= #
+  # === do_not_ignore_backups
+  # ========================================================================= #
+  def do_not_ignore_backups
+    @internal_hash[:ignore_backups] = false
+  end
+
+  # ========================================================================= #
+  # === ignore_backups
+  # ========================================================================= #
+  def ignore_backups
+    @internal_hash[:ignore_backups] = true
+  end
+
+  # ========================================================================= #
+  # === do_not_report_filesize
+  # ========================================================================= #
+  def do_not_report_filesize
+    @internal_hash[:report_filesize] = false
+  end; alias dont_report_total_filesize do_not_report_filesize # === dont_report_total_filesize
+
+  # ========================================================================= #
+  # === do_show_index
+  # ========================================================================= #
+  def do_show_index
+    @internal_hash[:show_index] = true # if true then we will show the index.
+  end
+
+  # ========================================================================= #
+  # === do_report_filesize
+  # ========================================================================= #
+  def do_report_filesize
+    @internal_hash[:report_filesize] = true
+  end
+
+  # ========================================================================= #
+  # === do_not_show_size
+  # ========================================================================= #
+  def do_not_show_size
+    @internal_hash[:show_size] = false
+  end
+
+  # ========================================================================= #
+  # === do_show_almost_nothing
+  # ========================================================================= #
+  def do_show_almost_nothing
+    do_not_show_size
+    do_not_show_index
+    do_not_show_permissions
+    do_not_show_modtime
+  end
+
+  # ========================================================================= #
+  # === do_truncate_long_file_names
+  # ========================================================================= #
+  def do_truncate_long_file_names
+    @internal_hash[:truncate_long_file_names] = true
+  end; alias truncate do_truncate_long_file_names # === truncate
+
+  # ========================================================================= #
+  # === disable_show_modification_time
+  # ========================================================================= #
+  def disable_show_modification_time
+    @internal_hash[:show_modification_time] = false
+  end; alias dont_show_modification_time   disable_show_modification_time
+       alias do_not_show_modification_time disable_show_modification_time
+       alias do_not_show_modtime           disable_show_modification_time
+
+  # ========================================================================= #
+  # === do_shorten_display
+  # ========================================================================= #
+  def do_shorten_display
+    enable_collapse
+    disable_show_modification_time # Added Aug 2012.
+  end
+
+  # ========================================================================= #
+  # === do_not_debug
+  # ========================================================================= #
+  def do_not_debug
+    @internal_hash[:debug] = false # Whether we debug this class or not.
+  end
+
+  # ========================================================================= #
+  # === do_not_truncate_long_file_names
+  # ========================================================================= #
+  def do_not_truncate_long_file_names
+    @internal_hash[:truncate_long_file_names] = false
+  end
+
+  # ========================================================================= #
+  # === show_simplified
+  # ========================================================================= #
+  def do_show_simplified
+    @internal_hash[:show_simplified] = true
+  end; alias show_simplified do_show_simplified # === show_simplified
+
+  # ========================================================================= #
+  # === do_show_leading_slash
+  # ========================================================================= #
+  def do_show_leading_slash
+    @internal_hash[:show_leading_slash] = true
+  end
+
+  # ========================================================================= #
+  # === do_show_modification_time
+  # ========================================================================= #
+  def do_show_modification_time
+    @internal_hash[:show_modification_time] = true
+  end
+
+  # ========================================================================= #
+  # === do_not_show_inode
+  # ========================================================================= #
+  def do_not_show_inode
+    @internal_hash[:show_inode] = false
+  end
+
+  # ========================================================================= #
+  # === do_show_inode
+  # ========================================================================= #
+  def do_show_inode # Show the inode number if true.
+    @internal_hash[:show_inode] = true
+  end
+
+  # ========================================================================= #
+  # === do_hide_files
+  # ========================================================================= #
+  def do_hide_files
+    @internal_hash[:show_hidden_files] = false
+  end; alias do_not_show_hidden_files do_hide_files # === do_not_show_hidden_files
+
+  # ========================================================================= #
+  # === do_show_uncondensed_permissions
+  # ========================================================================= #
+  def do_show_uncondensed_permissions
+    @internal_hash[:show_condensed_permissions] = false
+  end; alias dont_show_condensed_permissions do_show_uncondensed_permissions
+
+  # ========================================================================= #
+  # === show_this_help_line
+  # ========================================================================= #
+  def show_this_help_line(
+      i = :toggle, optional_additional_argument = nil
+    )
+    if optional_additional_argument
+      e "  - #{sfancy(i)} / #{sfancy(optional_additional_argument)}"
+    else
+      e "  - #{sfancy(i)}"
+    end
+  end
+
+  # ========================================================================= #
+  # === set_show_full_path
+  # ========================================================================= #
+  def set_show_full_path(i = true)
+    @internal_hash[:show_full_path] = i
+  end
+
+  # ========================================================================= #
+  # === do_colourize_kb_and_mb
+  # ========================================================================= #
+  def do_colourize_kb_and_mb
+    @internal_hash[:colourize_kb_and_mb] = true
+  end
+
+  # ========================================================================= #
+  # === collapse=
+  # ========================================================================= #
+  def collapse=(i)
+    @internal_hash[:collapse] = i
+  end
+
+  # ========================================================================= #
+  # === do_not_show_simplified
+  # ========================================================================= #
+  def do_not_show_simplified
+    @internal_hash[:show_simplified] = false
+  end
+
+  # ========================================================================= #
+  # === stop_on_missing_symlink=
+  # ========================================================================= #
+  def stop_on_missing_symlink=(i)
+    @internal_hash[:stop_on_missing_symlink] = i
+  end
+
+  # ========================================================================= #
+  # === do_show_full_path
+  # ========================================================================= #
+  def do_show_full_path
+    @internal_hash[:show_full_path] = true
+  end
+
+  # ========================================================================= #
+  # === dont_show_full_path
+  #
+  # I assume that this option is interconnected with another option,
+  # namely the ability to show, or rather not show, a leading slash.
+  #
+  # Thus, as of May 2015, we will also disable showing the leading
+  # slash whenever we invoke this method here.
+  # ========================================================================= #
+  def dont_show_full_path
+    set_show_full_path(false)
+    do_not_show_leading_slash
+  end; alias do_not_show_full_path     dont_show_full_path # === do_not_show_full_path
+       alias enable_collapse           dont_show_full_path # === enable_collapse
+       alias do_not_show_the_full_path dont_show_full_path # === do_not_show_the_full_path
+       alias do_show_only_filename     dont_show_full_path # === do_show_only_filename
+
+  # ========================================================================= #
+  # === do_not_show_permissions
+  # ========================================================================= #
+  def do_not_show_permissions
+    @internal_hash[:show_permission_bits] = false
+  end
+
+  # ========================================================================= #
+  # === do_show_header
+  # ========================================================================= #
+  def do_show_header
+    @internal_hash[:show_header] = true
+  end
+
+  # ========================================================================= #
+  # === do_sort_reversed
+  # ========================================================================= #
+  def do_sort_reversed
+    sort_how :reverse
+  end
+
+  # ========================================================================= #
+  # === do_not_show_group_information
+  # ========================================================================= #
+  def do_not_show_group_information
+    @internal_hash[:show_group_information] = false
+  end; alias no_groups do_not_show_group_information # === no_groups
+
+  # ========================================================================= #
+  # === do_not_show_the_owner
+  # ========================================================================= #
+  def do_not_show_the_owner
+    @internal_hash[:show_owner] = false
+  end
+
+  # ========================================================================= #
+  # === do_show_group_information
+  # ========================================================================= #
+  def do_show_group_information
+    @internal_hash[:show_group_information] = true
+  end
+
+  # ========================================================================= #
+  # === do_show_owner
+  # ========================================================================= #
+  def do_show_owner
+    @internal_hash[:show_owner] = true
+  end
+
+  # ========================================================================= #
+  # === do_not_show_leading_slash
+  # ========================================================================= #
+  def do_not_show_leading_slash
+    @internal_hash[:show_leading_slash] = false
+  end
+
+  # ========================================================================= #
+  # === do_show_permissions
+  # ========================================================================= #
+  def do_show_permissions
+    @internal_hash[:show_permission_bits] = true
+  end
+
+  # ========================================================================= #
+  # === only_directories
+  #
+  # Only get directories, with this method.
+  # ========================================================================= #
+  def only_directories
+    @internal_hash[:display_only_directories] = true
+  end
+
+  # ========================================================================= #
+  # === run_then_display
+  # ========================================================================= #
+  def run_then_display
+    run
+    display
+  end; alias gather_then_display_content run_then_display # === gather_then_display_content
+
+  # ========================================================================= #
+  # === define_colours
+  #
+  # define_colours() is called from reset()
+  # ========================================================================= #
+  def define_colours(
+      optional_hash_use_these_colours = nil
+    ) # Colours tag, colors tag.
+    _ = optional_hash_use_these_colours
+    if use_colours?
+      if _ # If the Hash is defined, enter here.
+        @internal_hash[:default_colour]           = Colours.beautiful _['colour_for_normal']
+        @internal_hash[:colour_for_files]         = Colours.beautiful _['colour_for_files']
+        @internal_hash[:colour_for_symlinks]      = Colours.beautiful _['colour_for_symlinks']
+        @internal_hash[:colour_for_directories]   = Colours.beautiful _['colour_for_directories']
+      else # Try to use Konsole after this point.
+        if Object.const_defined? :Colours
+          @internal_hash[:default_colour]         = Colours.restore? # Restore the default again.
+          @internal_hash[:colour_for_files]       = Colours.springgreen
+          @internal_hash[:colour_for_symlinks]    = Colours.slateblue
+          @internal_hash[:colour_for_directories] = Colours.paleturquoise
+        else # Else, use the default colours. They are defined in the module Colours.
+          @internal_hash[:default_colour]         = Colours::WHITE
+          @internal_hash[:colour_for_files]       = Colours::GREEN
+          @internal_hash[:colour_for_symlinks]    = Colours::BLUE
+          @internal_hash[:colour_for_directories] = Colours::CYAN # Which colour to use for directories.
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === check_whether_we_use_colours
+  #
+  # We will enable the colours if necessary.
+  # ========================================================================= #
+  def check_whether_we_use_colours
+    if use_colours?
+      enable_colours
+      check_whether_the_colours_defined_in_the_yaml_file_are_valid
+      define_colours
+    end
+  end
+
+  # ========================================================================= #
+  # === yaml_file?
+  # ========================================================================= #
+  def yaml_file? 
+    FILE_COLOURS_FOR_BYTES_VALUES
+  end
+
+  # ========================================================================= #
+  # === check_whether_the_colours_defined_in_the_yaml_file_are_valid
+  # ========================================================================= #
+  def check_whether_the_colours_defined_in_the_yaml_file_are_valid
+    _ = @internal_hash[:hash_colours_for_bytes_value]
+    _.each_pair {|key, value| # The entries will be 'KB' and :lightgreen, for instance.
+      if Object.const_defined?(:Colours) and
+         ::Colours.respond_to?(value)
+      else
+        e 'Attention please: the Colours namespace does not have a'
+        e 'colour named `'+value.to_s+'` defined.'
+        e
+        e 'One key (the one named '+key.to_s+') currently has this'
+        e 'value defined, though.'
+        e
+        e 'Please change this by modifying the following file:'
+        e
+        e sfile("  #{yaml_file?}")
+        e
+        e 'To get a listing of all defined colour-names, do this:'
+        e
+        e "  require 'colours'"
+        e '  pp Colours.html_colours?'
+        e
+        exit
+      end
+    }
+  end
+
+end; end