studium 0.14.16

data/lib/studium/utility_scripts/show_conflicting_lva_lectures/show_conflicting_lva_lectures.rb

@@ -0,0 +1,1339 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowConflictingLvaLectures
+#
+# This class can show conflicting dates for Lva-lectures (and exams to
+# these lectures).
+#
+# As argument you can pass in a string in a date format such as 'dd.mm.yyyy',
+# which is commonly seen in Europe.
+# =========================================================================== #
+# require 'studium/utility_scripts/show_conflicting_lva_lectures/show_conflicting_lva_lectures.rb'
+# Studium::ShowConflictingLvaLectures.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowConflictingLvaLectures < Base # === Studium::ShowConflictingLvaLectures
+
+  require 'studium/utility_scripts/holidays/holidays.rb'
+  require 'studium/utility_scripts/preparatory_meetings/preparatory_meetings.rb'
+
+  # ========================================================================= #
+  # === UNICODE_THUMBS_UP
+  # ========================================================================= #
+  UNICODE_THUMBS_UP = '👍'
+
+  # ========================================================================= #
+  # === ALPHABET
+  #
+  # Keep a reference to the alphabet.
+  # ========================================================================= #
+  ALPHABET = ('a'..'z').to_a
+
+  # ========================================================================= #
+  # === A
+  #
+  # This special constant denotes a very important date, such as the
+  # '01.10.2018' (first october in the year 2018). Based on this date,
+  # we can also input capital letters into this class, such as "conflict A",
+  # "conflict B", "conflict C" - where conflict is an alias to this class
+  # here. A means this set date, aka '01.10.2018', B then simply refers to
+  # the date after this date listed at A, C then means the date after B
+  # and so on, and so forth.
+  #
+  # The idea behind this is to just quickly input single letters and still
+  # get some meaningful output, without having to type whole years in the
+  # dd.mm.yyyy schemata, as the latter can become fairly tedious.
+  #
+  # Ideally, a monday may be used for A, simply because this is the start
+  # of the week.
+  # ========================================================================= #
+  A = '18.10.2022'
+
+  # ========================================================================= #
+  # === ARRAY_SHORTCUTS_FOR_TOMORROW
+  #
+  # Some string-aliases, stored as array, for "tomorrow".
+  # ========================================================================= #
+  ARRAY_SHORTCUTS_FOR_TOMORROW = %w(
+    morgen
+    tomorrow
+    +1
+    +
+  )
+
+  # ========================================================================= #
+  # === ARRAY_SHORTCUTS_FOR_THE_DAY_AFTER_TOMORROW
+  # ========================================================================= #
+  ARRAY_SHORTCUTS_FOR_THE_DAY_AFTER_TOMORROW = %w(
+    übermorgen
+    +2
+  )
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      use_this_date = DEFAULT_DATE,
+      run_already   = true
+    )
+    reset
+    use_this_date = check_for_commandline_arguments(
+      use_this_date
+    )
+    set_use_this_date(
+      use_this_date
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # Invoke this method like so:
+  #
+  #   conflict --help
+  #
+  # ========================================================================= #
+  def show_help
+    e
+    e "#{rev}This class can report all study-related lectures on "\
+      "the given (input) date."
+    e
+    e "The date must be in the format dd.mm.yyyy, such as #{sfancy('01.10.2018')}" 
+    e
+    e '  conflict <DD.MM.YYYY>          # example: conflict 11.10.2018'
+    e
+    e '  conflict --lva-dates-of=301246 # show the lva-dates of lecture id 301246'
+    e '                                 # ^^^ this is, sort of, a batch-variant'
+    e
+    e "  conflict A                     # show the courses on day #{sfancy(A)}"
+    e '  conflict B                     # show the courses on day +1 after '+sfancy(A)
+    e '  conflict def                   # simply repeat the last day '\
+      'that was used before'
+    e
+    e 'Do note that for the last example (conflict def) to work, at the least'
+    e 'one other date has to have been used before.'
+    e
+    e '  --show-raw                     # show some debug information (rarely needed)'
+    e
+    e 'You can also input a range separated via "-", such as in:'
+    e
+    e '  conflict 11.10.2020-11.11.2020'
+    e
+    e 'This would specify a total of 5 consecutive days.'
+    e
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= # 
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === conflict 15.01.2019 --show-raw-data
+      # ===================================================================== #
+      when /^-?-?show(-|_)?raw(-|_)?data$/,
+           /^-?-?show(-|_)?raw$/
+        do_show_raw_data
+      # ===================================================================== #
+      # === slectures --help
+      # ===================================================================== #
+      when /help$/
+        show_help
+        exit
+      # ===================================================================== #
+      # === slectures --lva-dates-of=301246
+      #
+      # This entry point allows us to show all LVA-dates of a specific
+      # lecture, by using the lecture-id for this.
+      #
+      # Invocation examples:
+      #
+      #   slectures --lvaid=941110
+      #
+      # ===================================================================== #
+      when /^-?-?lva(-|_)?dates(-|_)?of=(.+)$/i,
+           /^-?-?for=(.+)$/i,
+           /^-?-?lvaid=(.+)$/i
+        _ = $1.to_s.dup
+        _ = $3.to_s.dup if $3
+        show_lva_dates_of_this_lecture(_)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === check_for_commandline_arguments
+  # ========================================================================= #
+  def check_for_commandline_arguments(i)
+    if i.is_a? Array
+      if i.any? {|line| line.start_with?('--') }
+        # =================================================================== #
+        # Ok, the user has provided at the least one -- argument.
+        # =================================================================== #
+        set_commandline_arguments(
+          i.select {|inner_line| inner_line.start_with?('--') }
+        )
+        # =================================================================== #
+        # And reject them, too.
+        # =================================================================== #
+        i.reject! {|inner_line| inner_line.start_with?('--') }
+      end
+    end
+    i # We must return this here.
+  end
+
+  # ========================================================================= #
+  # === do_show_raw_data
+  # ========================================================================= #
+  def do_show_raw_data
+    @show_raw_data = true
+  end
+
+  # ========================================================================= #
+  # === show_raw_data?
+  # ========================================================================= #
+  def show_raw_data?
+    @show_raw_data
+  end; alias show_raw? show_raw_data? # === show_raw?
+       alias debug?    show_raw_data? # === debug?
+
+  # ========================================================================= #
+  # === append_onto_the_main_hash
+  # ========================================================================= #
+  def append_onto_the_main_hash(
+      i = @use_these_dates
+    )
+    our_date_of_interest = Time.parse(i) # This will be a date such as 2023-01-18 00:00:00.
+    @dataset.each_pair {|name_of_the_lecture, inner_hash|
+      # ===================================================================== #
+      # === Check for exams on that day
+      #
+      # First find relevant exams: We will also register the lva_dates
+      # but check them later.
+      # ===================================================================== #
+      exams = inner_hash['exams']
+      if exams
+        begin
+          # ================================================================= #
+          # First, check for flawed entries:
+          # ================================================================= #
+          if exams.is_a?(Array) and exams.first.nil?
+            opne 'A '+steelblue('problem')+' occurred for '+
+                 sfancy(name_of_the_lecture)+'.'
+            opne tomato('There is a faulty exams: entry. Please correct '\
+                 'this before this class can continue')
+            pp exams
+            exit
+          end
+          array_exams_on = remove_weekday_names_from(
+            exams
+          ).map(&:strip)
+          array_exams_on.compact!
+          array_exams_on.map!(&:strip).map {|line|
+            # =============================================================== #
+            # Get rid of "Ort" if it is there:
+            # =============================================================== #
+            if line.include? ', Ort:'
+              line = line.split(', Ort:').first.to_s.strip
+            end
+            Time.parse(line.delete(','))
+          }
+        rescue ArgumentError => error
+          opnn; e 'An error was encountered for '\
+                  'the '+steelblue('lecture')+' called `'+
+                  royalblue(name_of_the_lecture)+'`:'          
+          pp error; e; pp exams; e; pp array_exams_on; e
+          opnn; e tomato('Exiting now - consider fixing this problem.')
+          exit
+        end
+      end
+      # ===================================================================== #
+      # Check for the lva-dates entry next.
+      # ===================================================================== #
+      lva_dates = inner_hash['lva_dates']
+      if lva_dates
+        begin
+          # ================================================================= #
+          # First remove all "Ort:" entries here.
+          # ================================================================= #
+          lva_dates.map! {|entry|
+            if entry.include?('Ort:')
+              entry = entry.split('Ort:').first.to_s
+            end
+            entry.strip
+          }
+          array_lva_dates_on = remove_weekday_names_from(
+            lva_dates
+          ).map(&:strip).map {|line| line.delete(',').strip }
+          array_lva_dates_on.map! {|line|
+            Time.parse(line.strip)
+          }
+        rescue ArgumentError => error
+          opnn; e 'Problem with lecture name: '+
+                  sfancy(name_of_the_lecture)
+          pp error
+        end
+      end
+      if exams.nil?
+      else
+        if exams
+          # =================================================================== #
+          # Ok, we have found at the least one exam here.
+          # =================================================================== #
+          exams.map! {|line| line.to_s.strip }
+          if exams.first.empty?
+            opnn; e 'Empty exams-entry for '+
+                    slateblue(name_of_the_lecture)
+          end
+          # =================================================================== #
+          # Next, we must find out if the exams are on the same date.
+          # This works if we use date-objects via Time.at().to_date.
+          # =================================================================== #
+          if array_exams_on.any? {|time_entry|
+              date1 = time_entry
+              if date1.is_a? String
+                if date1.include? ', Ort:'
+                  date1 = date1.split(', Ort:').first.to_s.strip
+                end
+                date1 = Time.parse(date1)
+              end
+              if date1.respond_to? :to_date
+                date1 = date1.to_date
+              end
+              date2 = our_date_of_interest.to_date
+              # =============================================================== #
+              # Must convert date1 to start at 00:00:00 too.
+              # =============================================================== #
+              if date1.respond_to? :day
+                _ = date1.day.to_s+'.'+
+                    date1.month.to_s+'.'+
+                    date1.year.to_s
+                date1 = Time.parse(_).to_date
+              end
+              date1 === date2
+            }
+
+            # ================================================================= #
+            # Store our findings next:
+            # ================================================================= #
+            main_hash?[:exams] << name_of_the_lecture
+          end
+        end
+      end
+      # ===================================================================== #
+      # Next check for lva-dates.
+      # ===================================================================== #
+      if lva_dates.nil?
+      else
+        # =================================================================== #
+        # Next, we must find out if the exams are on the same date.
+        # This works if we use date-objects via Time.at().to_date.
+        # =================================================================== #
+        if array_lva_dates_on.any? {|time_entry|
+            date1 = time_entry.to_date
+            date2 = our_date_of_interest.to_date
+            # =============================================================== #
+            # Must convert date1 to start at 00:00:00 too.
+            # =============================================================== #
+            assumed_date = date1.day.to_s+'.'+date1.month.to_s+'.'+date1.year.to_s
+            date1 = Time.parse(assumed_date).to_date
+            # =============================================================== #
+            # Check whether it is from the past year:
+            # =============================================================== #
+            if date2.year - date1.year > 0
+              register_this_lecture_having_a_wrong_date(
+                name_of_the_lecture.strip, date1
+              )
+              opnn; e crimson('There may be a wrong date (year) set '\
+                      'for the lecture `')+royalblue(name_of_the_lecture)+
+                      crimson('`.')
+              pp date1
+            end
+            date1 === date2
+          }
+          main_hash?[:lva_dates] << name_of_the_lecture
+        end
+        if @show_raw_data
+          opnn; e royalblue('Debug output of the variable called array_lva_dates_on')
+          opnn; e slateblue('For the lecture called ')+lightgreen(name_of_the_lecture)
+          e
+          pp array_lva_dates_on
+          e
+          e 'The inner_hash dataset was:'
+          e
+          pp inner_hash
+          e
+        end
+      end
+    }
+    if @show_raw_data
+      opnn; e royalblue('Debug output:')
+      e
+      pp main_hash?
+      e
+    end
+    report_lectures_having_an_outdated_year
+  end
+
+  # ========================================================================= #
+  # === prepare_dataset_and_then_report_for_this_date
+  # ========================================================================= #
+  def prepare_dataset_and_then_report_for_this_date(
+      this_date
+    )
+    reset_internal_dataset
+    filter_the_main_dataset
+    append_onto_the_main_hash(
+      this_date
+    )
+    report(
+      this_date
+    )
+    store_this_date_into_a_local_file
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i = main_day?
+    )
+    e # An initial newline to make this prettier.
+    opnn { :no_colon }
+    header_string = (" [Heutiger Tag: #{return_weekday}, #{dd_mm_yyyy}]").
+                    rjust(50)
+    if use_unicode_symbols? and Object.const_defined? :Roebe
+      lindex = header_string.index('[')
+      header_string[lindex, 0] = '|'
+      splitted = header_string.split('|')
+      splitted[0] = crimson(splitted[0]+Roebe.shamrock) # Add a shamrock-unicode icon.
+      splitted[1] = lightseagreen(splitted[1])+
+                    crimson(Roebe.shamrock) # Add the clear-sun weather icon.
+      header_string = lightseagreen(splitted.join)
+
+    else
+      header_string = lightseagreen(header_string)
+    end
+    ee header_string
+    e
+    e
+    if Studium.is_this_day_a_holiday?(i)
+      opnn; e "Note that the day #{sfancy(i)} is a holiday."
+      e
+    end
+    # ======================================================================= #
+    # First, look if there are any "vorbesprechungen", aka
+    # "preliminary meetings". If so, we will show these first.
+    # ======================================================================= #
+    if Studium.is_a_vorbesprechungs_day?(i)
+      do_report_all_preliminary_meetings_on_that_day(i)
+    end
+    lva_dates_on_that_day = main_hash?[:lva_dates]
+    sorted_lectures_on_that_day = []
+    main_day = i
+    unless lva_dates_on_that_day.empty?
+      # ===================================================================== #
+      # === "The following lectures occur on"
+      # ===================================================================== #
+      result = 'The following '.dup
+      if use_unicode_symbols? and Object.const_defined? :Roebe
+        result << lightgreen(Roebe.white_sun_with_rays)+' '
+      end
+      result << colour_for_lectures('lectures')+
+                ' occur on '+orange(main_day)+
+                ' ('+colourize_weekday(translate_dd_mm_yyy_to_weekday(main_day))+
+                ')'+
+                darkslategray(':')
+      e result
+      # ===================================================================== #
+      # Iterate over our lectures next:
+      # ===================================================================== #
+      lva_dates_on_that_day.each {|name_of_the_lecture|
+        pointer   = main_dataset?[name_of_the_lecture]
+        currently_participating_in_this_course = pointer[:currently_participating_in_this_course]
+        selection = pointer['lva_dates'].select {|line|
+          line.include? i
+        }
+        if selection
+          _ = selection.first
+          _.strip! if _
+          # ================================================================= #
+          # The _ variable is now something like this: "16.04.2018, 18:00-19:30"
+          # ================================================================= #
+          _.delete!(',')
+          _.squeeze!(' ')
+          if _.include? '-'
+            _ = _.split('-').first+':00'
+          end
+          begin
+            sorted_lectures_on_that_day << [
+              name_of_the_lecture,
+              Time.parse(_),
+              { participating_in_this_course: currently_participating_in_this_course }
+            ]
+          rescue Exception => error
+            e 'A problem occurred.'
+            pp error
+            pp name_of_the_lecture
+            pp _
+            exit
+          end
+        end
+      }
+      sorted_lectures_on_that_day = sorted_lectures_on_that_day.sort_by {|a, time_entry, c|
+        time_entry
+      }
+      # ===================================================================== #
+      # === The lectures on that day
+      #
+      # Finally, we will display the lectures that happen on that day.
+      # ===================================================================== #
+      display_these_lectures_on_that_day(
+        sorted_lectures_on_that_day
+      )
+      # ===================================================================== #
+      # === Report upcoming exams next
+      #
+      # Next, report the exams. The lva-dates will be reported lateron.
+      # i will be a String such as "18.01.2023".
+      # ===================================================================== #
+      do_report_the_upcoming_exams(i)
+    else
+      e grey("No lectures were found on the day ")+
+        orange(main_day)+
+        grey(" (")+
+        colourize_weekday(
+          return_weekday_for(main_day)
+        )+
+        grey(").")
+    end
+    e
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    reset_internal_dataset
+    infer_the_namespace
+    # ======================================================================= #
+    # === :commandline_arguments
+    # ======================================================================= #
+    reset_the_commandline_arguments
+    # ======================================================================= #
+    # === @store_into_this_file
+    # ======================================================================= #
+    @store_into_this_file =
+      "#{log_dir?}last_date_for_conflicting_lva_lectures.md"
+    # ======================================================================= #
+    # === @show_raw_data
+    #
+    # The next instance variable determines whether we will show some
+    # additional debug information or not. By default we will not do
+    # so, hence why it is set to false.
+    # ======================================================================= #
+    @show_raw_data = false
+    # ======================================================================= #
+    # === @reported_n_lectures_having_a_wrong_date
+    # ======================================================================= #
+    @reported_n_lectures_having_a_wrong_date = 0
+  end
+
+  # ========================================================================= #
+  # === reset_internal_dataset
+  #
+  # Put variables into this method here only if you really wish to
+  # reset them. Commandline arguments should normally NOT be reset
+  # in this method.
+  # ========================================================================= #
+  def reset_internal_dataset
+    # ======================================================================= #
+    # The @main_hash will store :exams and :lectures as separate entities.
+    # ======================================================================= #
+    @main_hash = {}
+    @main_hash[:exams] = []
+    @main_hash[:lva_dates] = []
+    # ======================================================================= #
+    # === @array_we_have_registered_for_these_exams_on_that_day
+    # ======================================================================= #
+    @array_we_have_registered_for_these_exams_on_that_day = []
+    # ======================================================================= #
+    # === @original_dataset
+    # ======================================================================= #
+    @original_dataset = return_dataset_from_file_lecture_information
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = @original_dataset.dup
+    # ======================================================================= #
+    # === @n_ljust
+    # ======================================================================= #
+    @n_ljust = 78
+    # ======================================================================= #
+    # === @left_pad
+    # ======================================================================= #
+    @left_pad = '  ' # This one is displayed when showing indices in this class.
+    # ======================================================================= #
+    # === @hash_these_lectures_have_a_wrong_date
+    # ======================================================================= #
+    @hash_these_lectures_have_a_wrong_date = {}
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @dataset
+  end; alias main_dataset? dataset? # === main_dataset?
+
+  # ========================================================================= #
+  # === main_hash?
+  # ========================================================================= #
+  def main_hash?
+    @main_hash
+  end
+
+  # ========================================================================= #
+  # === input_given?
+  #
+  # This will return the first date.
+  # ========================================================================= #
+  def input_given?
+    @use_these_dates.first
+  end
+
+  # ========================================================================= #
+  # === filter_the_main_dataset
+  #
+  # We have to be careful what we filter in this method, as an erroneous
+  # filter means we may drop lectures and exams that are still relevant
+  # to the user.
+  # ========================================================================= #
+  def filter_the_main_dataset
+    # ======================================================================= #
+    # (1) First, we will skip lectures that have already been passed
+    #     successfully.
+    # ======================================================================= #
+    @dataset.reject! {|name_of_the_lecture, inner_hash|
+      inner_hash.has_key?(:already_solved) and
+      inner_hash[:already_solved] == true 
+    }
+    # ======================================================================= #
+    # (2) Second, we will only respect courses that have either a
+    #     lva_dates entry or an exams-entry.
+    # ======================================================================= #
+    @dataset.select! {|name_of_the_lecture, inner_hash|
+      inner_hash.has_key?('lva_dates') or
+      inner_hash.has_key?('exams')
+    }
+  end
+
+  # ========================================================================= #
+  # === append_university
+  #
+  # This will properly format and colourize the "university-string", before
+  # returning it. It is to be used to append it to the displayed string.
+  # ========================================================================= #
+  def append_university(i)
+    # Still have to modify these two:
+    #  VetMed
+    case i
+    when 'TU Vienna'
+      i = 'TU'
+    when 'Uni Wien'
+      i = 'UniWien'
+    end
+    i = " #{i.center(8)}"
+    return dodgerblue(i) # Or deepskyblue
+  end
+
+  # ========================================================================= #
+  # === properly_colourize_this_lecture_type
+  #
+  # Lecture types such as SE, UE and so forth, will be displayed in a
+  # slightly brighter colour, to denote that they are more important
+  # than other lecture-types such as VO.
+  # ========================================================================= #
+  def properly_colourize_this_lecture_type(lecture_type)
+    _ = ' ['+lecture_type+'] '
+    if is_prüfungsimmanent?(lecture_type)
+      darkturquoise(_)
+    else
+      steelblue(_)
+    end
+  end
+
+  # ========================================================================= #
+  # === colourize_weekday
+  # ========================================================================= #
+  def colourize_weekday(i)
+    limegreen(i)
+  end
+
+  # ========================================================================= #
+  # === use_this_date?
+  # ========================================================================= #
+  def use_these_dates?
+    @use_these_dates
+  end; alias main_day?        use_these_dates? # === main_day?
+       alias interesting_day? use_these_dates? # === interesting_day?
+       alias use_this_date?   use_these_dates? # === use_this_date?
+       alias use_which_date?  use_these_dates? # === use_which_date?
+
+  # ========================================================================= #
+  # === return_dataset_of_this_lecture
+  # ========================================================================= #
+  def return_dataset_of_this_lecture(i)
+    @dataset[i]
+  end
+
+  # ========================================================================= #
+  # === colour_for_index_strings
+  # ========================================================================= #
+  def colour_for_index_strings(i)
+    powderblue(i)
+  end
+
+  # ========================================================================= #
+  # === colour_for_preliminary_meetings
+  # ========================================================================= #
+  def colour_for_preliminary_meetings(i)
+    rosybrown(i)
+  end
+
+  # ========================================================================= #
+  # === colour_for_exams
+  # ========================================================================= #
+  def colour_for_exams(
+      i,
+      optional_priority                 = nil,
+      optional_registered_for_that_exam = false
+    )
+    if optional_registered_for_that_exam
+      orangered(i)+
+      orangered(" #{left_arrow} [Registered for this exam]")
+    else
+      case optional_priority
+      when 1
+        crimson(i)+
+        crimson(" #{left_arrow} [High Priority Exam]")
+      else
+        springgreen(i)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === colour_for_lectures
+  # ========================================================================= #
+  def colour_for_lectures(i)
+    turquoise(i)
+  end; alias colour_for_vorbesprechungs_termin colour_for_lectures # === colour_for_vorbesprechungs_termin
+
+  # ========================================================================= #
+  # === display_these_exams_on_that_day
+  #
+  # This is the method that will report which exams will happen during
+  # the given input-day.
+  # ========================================================================= #
+  def display_these_exams_on_that_day(i)
+    index = 0
+    e
+    i.each {|name_of_the_lecture, date_of_the_lecture| index += 1
+      _ = date_of_the_lecture
+      padded_index = "#{index})".rjust(3)
+      colourized_and_padded_index = powderblue(padded_index)
+      priority         = return_dataset_of_this_lecture(name_of_the_lecture)[:priority]
+      which_university = return_dataset_of_this_lecture(name_of_the_lecture)[:university].to_s
+      registered_for_an_upcoming_exam_at = @dataset[name_of_the_lecture]['registered']
+      if registered_for_an_upcoming_exam_at
+        if registered_for_an_upcoming_exam_at.is_a? Array
+          # ================================================================= #
+          # Note that the array above may have some additional ' '
+          # characters, so we apply .squeeze() on it.
+          #
+          # An example for this is:
+          #
+          #   "Dienstag     12.06.2018, 14:00-16:00, Ort: Foobar"
+          # ================================================================= #
+          registered_for_an_upcoming_exam_at.map! {|entry| entry.squeeze(' ') }
+          registered_for_an_upcoming_exam_at = registered_for_an_upcoming_exam_at.first
+        end
+        registered_for_an_upcoming_exam_at = remove_leading_weeknames(
+          registered_for_an_upcoming_exam_at
+        )
+      end
+      case which_university
+      when 'TU Vienna'
+        which_university = 'TU Wien'
+      end
+      padded_which_university = " #{which_university}".center(10)
+      colourized_and_padded_which_university = plum('['+padded_which_university+'] ')
+      # ===================================================================== #
+      # In the event that priority is 1, we will use slightly different
+      # colours - aka red.
+      # ===================================================================== #
+      are_we_registered_for_that_exam = false
+      if registered_for_an_upcoming_exam_at # to prevent nil-entries
+        # =================================================================== #
+        # The line may be like this:
+        #   "18.06.2018, 14:00-16:00, Ort: Hörsaal 2 UZA 1 Biozentrum 2.249 1.OG"
+        # =================================================================== #
+        splitted = registered_for_an_upcoming_exam_at.split(',')
+        first    = splitted.first
+        if first == input_given?
+          are_we_registered_for_that_exam = true
+        end
+      end
+      return_colourized_entry_for_an_upcoming_exam = colour_for_exams(
+        '['+return_dd_mm_yy_and_time_from(date_of_the_lecture).to_s.rjust(19,'0')+']',
+        priority,
+        are_we_registered_for_that_exam
+      )
+      padded_name_of_the_lecture = name_of_the_lecture.ljust(@n_ljust)
+      # ===================================================================== #
+      # If we are registered for that particular exam then we
+      # will use a slightly brighter colour.
+      # ===================================================================== #
+      if are_we_registered_for_that_exam
+        @array_we_have_registered_for_these_exams_on_that_day << [
+          name_of_the_lecture, date_of_the_lecture
+        ]
+        colourized_and_padded_name_of_the_lecture =
+          cadetblue(padded_name_of_the_lecture)
+      else
+        colourized_and_padded_name_of_the_lecture =
+          cornflowerblue(padded_name_of_the_lecture)
+      end
+      # ===================================================================== #
+      # And finally, report which exams will happen on that day next,
+      # on the commandline.
+      # ===================================================================== #
+      e @left_pad+
+        colourized_and_padded_index+ # The index such as ' 1)'
+        ' '+
+        colourized_and_padded_name_of_the_lecture+ # The name of the lecture.
+        colourized_and_padded_which_university+
+        return_colourized_entry_for_an_upcoming_exam
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === this_exam_happens_on_that_day?
+  # ========================================================================= #
+  def this_exam_happens_on_that_day?(i)
+    result = false
+    unless @array_we_have_registered_for_these_exams_on_that_day.empty?
+      @array_we_have_registered_for_these_exams_on_that_day.each {|a, b|
+        result = true if a.include? i
+      }
+    end
+    result
+  end
+
+  # ========================================================================= #
+  # === store_this_date_into_a_local_file
+  #
+  # This method will store the date used, aka the dd.mm.yyyy format,
+  # into a local file.
+  # ========================================================================= #
+  def store_this_date_into_a_local_file
+    what = use_which_date?
+    what = what.first if what.is_a? Array
+    into = @store_into_this_file
+    write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === register_this_lecture_having_a_wrong_date
+  # ========================================================================= #
+  def register_this_lecture_having_a_wrong_date(
+      name_of_the_lecture, date
+    )
+    # ======================================================================= #
+    # We will only register the first incorrect lecture; the others will
+    # be ignored. This way the user can fix the flawed dataset.
+    # ======================================================================= #
+    unless @hash_these_lectures_have_a_wrong_date.has_key? name_of_the_lecture.strip
+      @hash_these_lectures_have_a_wrong_date[name_of_the_lecture.strip] = date
+    end
+  end
+
+  # ========================================================================= #
+  # === show_lva_dates_of_this_lecture
+  #
+  # This method will report all LVA-dates of the given lecture at hand.
+  # ========================================================================= #
+  def show_lva_dates_of_this_lecture(i)
+    entries = @dataset.select {|name_of_the_lecture, inner_dataset|
+      name_of_the_lecture.include? i
+    }
+    if entries.size > 1
+      e 'More than one entry. Need to decide what to do with that.'
+      e 'Proposing to just return the first entry. Acceptable? '\
+        'Consider later (July 2018)'
+    else
+      name = entries.keys.first
+      e 'Showing all lva-dates of the lecture `'+royalblue(name)+'` next:'
+      hash = entries[name]
+      lva_dates = hash['lva_dates']
+      if lva_dates
+        lva_dates.each {|lva_date|
+          lva_date = remove_weekday_name(lva_date).strip
+          lva_date = extract_dd_mm_yyyy(lva_date)
+          prepare_dataset_and_then_report_for_this_date(lva_date)
+        }
+      else
+        e 'No lva_dates: entry appears to be '\
+          'registered for `'+royalblue(name)+'`.'
+      end
+    end
+    exit
+  end
+
+  # ========================================================================= #
+  # === return_colourized_people_cheering_for_an_exam
+  # ========================================================================= #
+  def return_colourized_people_cheering_for_an_exam
+    colourized_orangered(
+      return_people_cheering_for_an_exam
+    )
+  end
+
+  # ========================================================================= #
+  # === colourized_orangered
+  # ========================================================================= #
+  def colourized_orangered(i)
+    orangered(i)
+  end; alias colourize_via_orangered colourized_orangered # === colourize_via_orangered
+
+  # ========================================================================= #
+  # === set_use_this_date                                           (set tag)
+  #
+  # This will set the date that we are interested in. If the input is an
+  # Array then we will work on a String. In general, the String should
+  # be in the format dd.mm.yyyy such as '25.02.2018'.
+  # ========================================================================= #
+  def set_use_this_date(
+      i = nil
+    )
+    i = DEFAULT_DATE if i.nil?
+    # ======================================================================= #
+    # === Handle Arrays next
+    # ======================================================================= #
+    if i.is_a?(Array)
+      # ===================================================================== #
+      # First, we will reject all entries that are a weekday, such as
+      # "Freitag". The reason for this behaviour is because we can also
+      # invoke this class here via e. g.:
+      #
+      #   conflict Freitag 25.10.2019
+      #
+      # But we don't care about the weekday name here; the dd.mm.yyyy format
+      # is sufficient. So, let's modify the array.
+      # ===================================================================== #
+      i.reject! {|entry| weekdays?.include?(entry.capitalize) }
+      first = i.first
+      if i.empty?
+        i = return_dd_mm_yyyy
+      elsif first.is_a?(String) and first.include?('-') and (first =~ /\d+/)
+        require 'studium/utility_scripts/expand_time_range.rb'
+        i = Studium.expand_these_lectures(i)
+      elsif first !~ /\d+/ # If it does not have a number but is not empty.
+        case first
+        # =================================================================== #
+        # === default
+        # =================================================================== #
+        when 'default','def'
+          if File.exist? @store_into_this_file
+            opnn; e 'Reading from the file'
+            opnn; e "  `#{sfile(@store_into_this_file)}`."
+            i = File.read(@store_into_this_file).strip
+          else
+            opnn
+            e 'No entry could be found at non-existing '\
+              'file `'+sfile(@store_into_this_file)+'`.'
+          end
+        when *ALPHABET.map(&:upcase)
+          i = A # ← i will now be e. g. 01.10.2018
+          # ================================================================= #
+          # Next, we add the difference to this string.
+          # ================================================================= #
+          n_difference = ALPHABET.index(first.downcase)
+          i = Time.parse(i) + ONE_DAY * n_difference
+          i = dd_mm_yyyy(i)  
+        end
+      end
+    end
+    if i.is_a?(Array) and i.size == 1
+      i = i.first
+    end
+    case i # case tag
+    when *ARRAY_SHORTCUTS_FOR_THE_DAY_AFTER_TOMORROW
+      i = Time.now + ONE_DAY + ONE_DAY
+      i = return_dd_mm_yyyy(i)
+    when *ARRAY_SHORTCUTS_FOR_TOMORROW
+      i = Time.now + ONE_DAY
+      i = return_dd_mm_yyyy(i)
+    end
+    # ======================================================================= #
+    # We require an Array past this point:
+    # ======================================================================= #
+    i = [i].compact unless i.is_a? Array
+    i.flatten!
+    i.map! {|line|
+      line = remove_leading_weekdays(line)
+      case line
+      when *ARRAY_SHORTCUTS_FOR_TOMORROW
+        line = Time.now + ONE_DAY # ← Add one day.
+        line = return_dd_mm_yyyy(line)
+      when 'today','heute'
+        line = return_dd_mm_yyyy(Time.now)
+      end
+      if line.end_with? ','
+        line = line.dup if line.frozen?
+        line.chop!
+      end
+      # ===================================================================== #
+      # Check for a proper date, which is in the format dd.mm.yyyy.
+      # ===================================================================== #
+      if line =~ /^\d{1,2}\.\d{1,2}\.\d{4}$/
+      else
+        if line.count('.') == 1
+          line = line.dup if line.frozen?
+          line << '.'+current_year?
+        end
+      end
+      line
+    }
+    @use_these_dates = i
+  end
+
+  # ========================================================================= #
+  # === report_lectures_having_an_outdated_year
+  # ========================================================================= #
+  def report_lectures_having_an_outdated_year
+    unless @hash_these_lectures_have_a_wrong_date.empty?
+      @hash_these_lectures_have_a_wrong_date.each_pair {|name_of_the_lecture, date|
+        @reported_n_lectures_having_a_wrong_date += 1
+        unless @reported_n_lectures_having_a_wrong_date > 3
+          # ================================================================= #
+          # Don't show more than 3 outdated dates.
+          # ================================================================= #
+          e crimson('There may be a wrong date (year) set '\
+            'for the lecture `')+royalblue(name_of_the_lecture)+
+            crimson('`.')
+          pp date
+        end
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === do_report_the_upcoming_exams
+  #
+  # The input argument to this method should be a String, representing
+  # the exam-date, such as "18.01.2023".
+  # ========================================================================= #
+  def do_report_the_upcoming_exams(
+      i = main_day?
+    )
+    i = i.dup if i.frozen?
+    i.strip! # Get rid of irrelevant ' ', just in case.
+    main_day = i
+    exams_on_that_day = main_hash?[:exams]
+    unless exams_on_that_day.empty?
+      # ===================================================================== #
+      # === "The following exams happen on ..."
+      # ===================================================================== #
+      e grey('The following ')+
+        colour_for_exams('exams')+
+        grey(' happen on ')+
+        orange(main_day)+
+        grey(' (')+
+        colourize_weekday(
+          translate_dd_mm_yyy_to_weekday(main_day)
+        )+
+        grey(')')+
+        darkslategray(':')
+      sorted_exams_on_that_day = []
+      exams_on_that_day = exams_on_that_day.each {|name_of_the_lecture|
+        pointer = main_dataset?[name_of_the_lecture]
+        selection = pointer['exams'].select {|line|
+          line.include? i
+        }
+        if selection
+          if selection.empty?
+            opnn; e "The selection is empty for the day #{sfancy(i.to_s)}."
+            opnn; e "The name of the lecture was #{sfancy(name_of_the_lecture)}"
+            pp exams_on_that_day
+          else
+            selection_match = selection.first.strip
+            if selection_match.include?('Ort:')
+              selection_match = selection_match.split('Ort:').first.to_s.delete(',')
+            end
+            begin
+              parsed_date = Time.parse(selection_match)
+            rescue Exception => error
+              e tomato('An error happened for ')+
+                steelblue(selection_match)
+              e
+              pp error
+              e
+            end
+            sorted_exams_on_that_day << [
+              name_of_the_lecture,
+              parsed_date
+            ]
+          end
+        end
+      }
+      sorted_exams_on_that_day = sorted_exams_on_that_day.sort_by {|a,b|
+        b
+      }
+      display_these_exams_on_that_day(sorted_exams_on_that_day)
+    else
+      e "No exams were found on the day #{orange(main_day)}"\
+        " (#{sfancy(return_weekday_for(main_day))})."
+    end
+  end
+
+  # ========================================================================= #
+  # === do_report_all_preliminary_meetings_on_that_day
+  # ========================================================================= #
+  def do_report_all_preliminary_meetings_on_that_day(
+      i,
+      use_this_key = :preparatory_meeting # This used to be 'vorbesprechung' in the past.
+    )
+    selection = @original_dataset.select {|a, inner_hash|
+      if inner_hash.has_key?(use_this_key)
+        pointer = inner_hash[use_this_key]
+        if pointer.is_a? Array
+          pointer = pointer.first
+        end
+        pointer = pointer.to_s
+        pointer.include?(i.to_s)
+      end
+    }
+    index = 0
+    if selection.empty?
+    else
+      # ===================================================================== #
+      # === "The following preliminary meetings happen on ... "
+      # ===================================================================== #
+      e 'The following '+
+        colour_for_preliminary_meetings('preliminary meetings')+
+        ' happen on '+orange(i)+
+        ' ('+simp(translate_dd_mm_yyy_to_weekday(i))+').'
+      e
+      selection.each_pair {|name_of_the_lecture, hash| index += 1
+        vorbesprechungs_day = hash[use_this_key]
+        if vorbesprechungs_day.is_a? Array
+          vorbesprechungs_day = vorbesprechungs_day.first
+        end
+        colourized_and_padded_index =
+          '   '+colour_for_index_strings(index.to_s+')')
+        e colourized_and_padded_index+' '+
+          sfancy(name_of_the_lecture.ljust(@n_ljust+5))+
+          colour_for_vorbesprechungs_termin(
+            '['+vorbesprechungs_day+']'
+          )
+      }
+    end
+    e
+  end
+
+  # ========================================================================= #
+  # === return_people_cheering_for_an_exam
+  # ========================================================================= #
+  def return_people_cheering_for_an_exam
+    '\\o/ EXAM \\o/'
+  end
+
+  # ========================================================================= #
+  # === display_these_lectures_on_that_day                     (lectures tag)
+  #
+  # This method will display the lectures on that given day, along
+  # with some additional information to make it easier to read what
+  # is all happening on that day.
+  # ========================================================================= #
+  def display_these_lectures_on_that_day(i)
+    index = 0
+    # ======================================================================= #
+    # Obtain a reference to the main dataset next:
+    # ======================================================================= #
+    main_dataset = main_dataset?
+    # ======================================================================= #
+    # Merge in all exams that occur on that day:
+    # ======================================================================= #
+    unless @array_we_have_registered_for_these_exams_on_that_day.empty?
+      @array_we_have_registered_for_these_exams_on_that_day.each {|element|
+        # =================================================================== #
+        # We have to re-set the time counter for these elements, as they
+        # may have the wrong timezone-offset, which would mess up our
+        # sorting done at a later point.
+        # =================================================================== #
+        second_element = Studium.normalize_time(
+          element.last
+        )
+        element[-1] = second_element
+        # =================================================================== #
+        # We will add that element onto the dataset, aka i - but before
+        # we do so, we have to remove the old element from our dataset.
+        # =================================================================== #
+        i.reject! {|array|
+          name = array.first
+          first_entry = element.first
+          name == first_entry
+        }
+        i << element
+      }
+    end
+    sorted_by_date = i.sort_by {|name_of_the_lecture, time_entry, participating_in_this_course|
+      Time.parse(time_entry.to_s)
+    }
+    # ======================================================================= #
+    # Go through our dataset and finally display the useful content:
+    # ======================================================================= #
+    e; sorted_by_date.each {|name_of_the_lecture, date_of_the_lecture, hash_participating_in_this_course| index += 1
+      _ = date_of_the_lecture
+      # ===================================================================== #
+      # Pad the index a bit:
+      # ===================================================================== #
+      padded_index = ("#{index})").rjust(3)
+      if this_exam_happens_on_that_day?(name_of_the_lecture)
+        colourized_and_padded_index = colourize_via_orangered(padded_index)
+      else
+        colourized_and_padded_index = colour_for_index_strings(padded_index)
+      end
+      priority               = main_dataset[name_of_the_lecture][:priority]
+      lecture_type           = main_dataset[name_of_the_lecture][:type] # Can be "VO" or "VO+SE" and so forth.
+      name_of_the_university = main_dataset[name_of_the_lecture][:university]
+      do_we_participate      = main_dataset[name_of_the_lecture][:currently_participating_in_this_course]
+      # ===================================================================== #
+      # We will store everything in the String referenced via the variabled
+      # called "result".
+      # ===================================================================== #
+      result = @left_pad+colourized_and_padded_index               # First show the index
+      if do_we_participate
+        # =================================================================== #
+        # Prepend a ✓ icon next.
+        # =================================================================== #
+        result[1,1] = mediumseagreen('✓') # This icon denotes that we currently participate in this course.
+      end
+      # ===================================================================== #
+      # Next we will append the lecture-type, such as "VO" or "SE" or "PR" etc.
+      # ===================================================================== #
+      result << properly_colourize_this_lecture_type(lecture_type)
+      padding_to_use = @n_ljust
+      if lecture_type.size > 2
+        # =================================================================== #
+        # In this case, use a slightly shorter padding.
+        # =================================================================== #
+        padding_to_use -= (lecture_type.size - 2)
+      end
+      # ===================================================================== #
+      # Make too long names shorter (truncate):
+      # ===================================================================== #
+      chop_off_at_this_offset = @n_ljust - 4
+      if name_of_the_lecture.size > chop_off_at_this_offset
+        name_of_the_lecture = name_of_the_lecture[0 .. (chop_off_at_this_offset - 6)]+' [...]'
+      end
+      padded_name_of_the_lecture = name_of_the_lecture.ljust(padding_to_use)
+      # ===================================================================== #
+      # === Colourize the lecture name next
+      #
+      # The normal colour for lectures here is slateblue; but if the
+      # lecture is of high priority, aka priority 1, then a slightly
+      # brighter colour will be used, to also visually denote that
+      # this lecture is more important.
+      # ===================================================================== #
+      if this_exam_happens_on_that_day?(name_of_the_lecture)
+        # =================================================================== #
+        # In this case we will also pad anew:
+        # =================================================================== #
+        result << orangered(
+          (
+            "#{name_of_the_lecture} # #{left_arrow} #{return_people_cheering_for_an_exam}"
+          ).ljust(padding_to_use)
+        )
+      else
+        if do_we_participate
+          result << tomato(padded_name_of_the_lecture)
+        else
+          case priority
+          when 1
+            result << mediumpurple(padded_name_of_the_lecture) # Now the name of the lecture.
+          else
+            result << slateblue(padded_name_of_the_lecture)    # Now the name of the lecture.
+          end
+        end
+      end
+      # ===================================================================== #
+      # Next we will append a String such as "[08.03.2023 17:00:00]".
+      # ===================================================================== # 
+      result << colour_for_lectures(
+                  '['+return_dd_mm_yy_and_time_from(date_of_the_lecture).to_s.rjust(19,'0')+']'
+                )
+      # ===================================================================== #
+      # Find out whether this exame happens on the day:
+      # ===================================================================== #
+      if this_exam_happens_on_that_day?(name_of_the_lecture)
+        # =================================================================== #
+        # Registered exams will appear in another colour:
+        # =================================================================== #
+        result << skyblue(' [')+return_colourized_people_cheering_for_an_exam+skyblue(']')
+      elsif priority.to_i == 1
+        result << skyblue(' [')+orange('Priorität: '+priority.to_s)+skyblue(']')
+      else
+        result << skyblue(" [Priorität: #{priority}]")
+      end
+      # ===================================================================== #
+      # Next, append the university.
+      # ===================================================================== #
+      result << append_university(name_of_the_university)
+      # ===================================================================== #
+      # Last but not least, append the unicode-thumbs-up symbol if we are
+      # currently participating in this course:
+      # ===================================================================== #
+      if hash_participating_in_this_course and (hash_participating_in_this_course[:participating_in_this_course])
+        result << " #{yellowgreen(UNICODE_THUMBS_UP)}"
+      end
+      e result
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    ensure_that_the_log_directory_exists # Make sure that the log dir exists.
+    menu # Pass the commandline arguments into the menu() interface.
+    @use_these_dates.each {|this_date|
+      prepare_dataset_and_then_report_for_this_date(this_date)
+    }
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowConflictingLvaLectures.new(ARGV)
+end # conflict 15.04.2018
+    # conflict 20.04.2018 21.04.2018
+    # conflict 19.06.2018
+    # conflict --lva-dates-of=LVA_ID_HERE
+    # conflict --lva-dates-of=301246