studium 0.13.1

data/lib/studium/toplevel_methods/return_div_timetable_of_upcoming_exams.rb

@@ -0,0 +1,498 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/return_div_timetable_of_upcoming_exams.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/constants/constants.rb'
+  require 'studium/constants/web_constants.rb'
+  require 'studium/colours/colours.rb'
+  require 'studium/toplevel_methods/curriculum_related_code.rb'
+  require 'studium/toplevel_methods/main_dataset.rb'
+  require 'studium/toplevel_methods/time.rb'
+  require 'studium/toplevel_methods/try_to_guess_the_most_likely_lva_id.rb'
+  require 'studium/toplevel_methods/return_remote_homepage_of_this_lecture.rb'
+  require 'studium/constants/image_constants.rb'
+
+  begin
+    require 'cliner'
+  rescue LoadError; end
+
+  begin
+    require 'html_tags'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === CSS_STYLE_TO_USE_FOR_THE_FIRST_TIMETABLE_DIV
+  # ========================================================================= #
+  CSS_STYLE_TO_USE_FOR_THE_FIRST_TIMETABLE_DIV =
+    'font-weight: bold; margin-bottom: 1px; padding:5px; font-family: monospace; font-size:3.0em'
+
+  # ========================================================================= #
+  # === add_balloon
+  #
+  # This method can be used to add a CSS-tooltip to a text (in a html
+  # page).
+  #
+  # Invocation example:
+  #
+  #   add_balloon(rand(5)+1.0, raw_name_of_the_lecture)
+  #
+  # ========================================================================= #
+  def self.add_balloon(
+      add_this_text       = 5.0,
+      name_of_the_lecture = 'Vorlesungsname hier'
+    )
+    if add_this_text.is_a? Numeric
+      add_this_text = add_this_text.to_s
+    end
+    unless add_this_text.include? 'ECTS'
+      add_this_text = add_this_text.dup if add_this_text.frozen?
+      add_this_text << ' ECTS'
+    end
+    '<span data-balloon="'+add_this_text.to_s+'" data-balloon-pos="right" '\
+    'data-balloon-length="medium">'+name_of_the_lecture+'</span>'+N
+  end
+
+  require 'studium/toplevel_methods/try_to_return_the_expanded_name_of_this_lecture.rb'
+  # ========================================================================= #
+  # === Studium.return_div_timetable_of_upcoming_exams
+  #
+  # This method can be used to create a timetable <div>, which can then
+  # be embedded/displayed into a .html or .cgi page.
+  #
+  # In order for this to work, the input-Hash for this method, which
+  # is the first argument to this method, must be given in the "correct
+  # format".
+  #
+  # In particular, we need entries within that Hash that have Symbols
+  # such as :next_exam and :remote_url, so make sure that these entries
+  # exist BEFORE you do access this method here. Some aliases are
+  # allowed as well, such as :exams, which may originate straight
+  # from the entries stored in the file "lecture_information.yml".
+  #
+  # An example entry for :next_exam would be this here:
+  #
+  #   :next_exam => "01.11.2017"
+  #
+  # So in other words, the date of this upcoming exam must be passed
+  # in via the dd.mm.yyyy notation.
+  # ========================================================================= #
+  def self.return_div_timetable_of_upcoming_exams(
+      i, # <- The input is usually an Array.
+      optional_commands = nil
+    )
+    n_ects_points_can_be_done = 0
+    # ======================================================================= #
+    # Keep an Array that tells us which lectures have no upcoming
+    # exam entry. That way we can remedy this problem.
+    # ======================================================================= #
+    array_these_courses_have_no_upcoming_exam_entry = []
+    array_obsolete_time_entries = []
+    require 'html_tags' unless Object.const_defined? :HtmlTags
+    _ = ''.dup
+    # =================================================================== #
+    # How many exams will be actually shown.
+    # =================================================================== #
+    we_will_show_n_exams = 0
+    # =================================================================== #
+    # === Timetable tag
+    # =================================================================== #
+    _ << WebConstants::TIMETABLE_DIV+N # in $RUBY_STUDIUM/constants/www_constants.rb
+    _ << '<b style="font-size: 1.5em; padding-left:1.5em">'
+    # =================================================================== #
+    # Next, build up the HTML table that will be displayed, via the
+    # <table> tag.
+    # =================================================================== #
+    the_html_table = '<table cellspacing="3" style="font-size:0.8em; margin-left:4em; padding:4px; border-collapse: collapse;">'+N+N
+    the_html_table << '<tr style="font-size:larger; font-weight:bold">'+N
+    the_html_table << '  <td><b>University</b></td>'+N
+    the_html_table << '  <td style="padding:6px">Name of the lecture<td>'+N
+    the_html_table << '  <td style="padding:6px">n ECTS points and date of the exam</td>'+N
+    # the_html_table << '  <td style="padding:6px">date of the exam</td>'+N
+    the_html_table << '  <td style="padding:6px">priority and remote URL</td></tr>'+N
+    inner_counter = 0
+    # =================================================================== #
+    # We expect the Hash to be already time-sorted, so you may have to
+    # make sure on your own that this is the case, before calling this
+    # method.
+    # =================================================================== #
+    i.each {|name_of_the_lecture, inner_hash|
+      # ================================================================= #
+      # Do note that the following variable is normally an Array, such
+      # as ["Freitag 13.07.2018, 15:30-18:00, Ort: Audimax ...']
+      # ================================================================= #
+      registered_for_an_upcoming_exam_at = inner_hash['registered']
+      n_ects_points = inner_hash[:ects].to_s.dup
+      lva_id        = name_of_the_lecture.split(' ').first.to_s
+      lecture_type  = inner_hash[:type]
+      already_solved_this_lecture = inner_hash[:already_solved]
+      at_this_university = inner_hash[:university].to_sym
+      # ================================================================= #
+      # Very early on, we will register entries that:
+      #
+      #   (1) we have NOT yet solved
+      #   (2) that do NOT have an entry called exams:
+      #   (3) for entries that are not mandatory-attendance, aka
+      #       "prüfungsimmanent"
+      #
+      # ================================================================= #
+      unless already_solved_this_lecture
+        unless inner_hash.has_key? 'exams'
+          unless is_prüfungsimmanent?(lecture_type, :SE) # ← Only ignore seminar-type lectures.
+            array_these_courses_have_no_upcoming_exam_entry << 
+              # "#{lva_id} #{name_of_the_lecture}"
+              "#{name_of_the_lecture}"
+          end
+        end
+      end
+      # ================================================================= #
+      # If the lva_id does not at the least have two consecutive numbers,
+      # we will use another method to guess a lva-id here.
+      # ================================================================= #
+      unless lva_id =~ /\d{2}/
+        lva_id = ::Studium.try_to_guess_the_most_likely_lva_id(
+          name_of_the_lecture
+        )
+      end
+      # ================================================================= #
+      # Add an "invisible" LVA ID entry next.
+      # ================================================================= #
+      colourized_lva_id =
+        '<span style="color:white; font-weight: bold"> '+lva_id+'</span>'
+      case optional_commands
+      when :remove_leading_lva_id_entries
+        if name_of_the_lecture.include? ' '
+          name_of_the_lecture = name_of_the_lecture.split(' ')[1..-1].join(' ').strip
+        end
+      end
+      lecture_has_been_solved_already = false
+      # ===================================================================== #
+      # The first entry keeps the name of the lecture. The inner hash keeps
+      # the associated dataset and will have entries such as remote_url.
+      # ===================================================================== #
+      if inner_hash.has_key? :next_exam
+        the_next_exam = inner_hash[:next_exam]
+      elsif inner_hash.has_key? 'exams'
+        the_next_exam = inner_hash['exams']
+        the_next_exam = the_next_exam.first if the_next_exam.is_a? Array
+      end
+      if inner_hash.has_key? :already_solved
+        lecture_has_been_solved_already = inner_hash[:already_solved]
+      end
+      # ===================================================================== #
+      # Next determine the remote URL. It will be available in the variable
+      # called remote_url.
+      # ===================================================================== #
+      if inner_hash.has_key? :homepage
+        remote_url = inner_hash[:homepage] 
+      elsif inner_hash.has_key? :remote_url
+        remote_url = inner_hash[:remote_url]
+      elsif inner_hash.has_key? :url
+        remote_url = inner_hash[:url]
+      else # else this key does not exist, so we must query beautiful_url
+      end
+      original_priority = nil
+      _priority = inner_hash[:priority] # This is optional.
+      original_priority = _priority.to_i if _priority
+      # ===================================================================== #
+      # if the_next_exam.nil? and !lecture_has_been_solved_already
+      #   e 'A nil value was found for '+
+      #     Studium::Colours.sfancy(name_of_the_lecture)
+      #   pp inner_hash
+      # end # ^^^ disabled as of March 2018; may re-consider re-enabling it one day.
+      # ===================================================================== #
+      if the_next_exam and (!lecture_has_been_solved_already)
+        # =================================================================== #
+        # The variable the_next_exam can also be an Array such as:
+        #   ["01.03.2018, 10:00-13:00"]
+        # Hence, the following check has to be used.
+        # =================================================================== #
+        if the_next_exam.is_a? Array
+          the_next_exam = the_next_exam.first
+        end
+        first_part = the_next_exam
+        unless the_next_exam.is_a? Time
+          first_part = first_part.split(',').first
+          # =================================================================== #
+          # Also remove weekend days if it is a String already.
+          # =================================================================== #
+          if first_part.is_a? String
+            first_part.squeeze!(' ')
+            first_part = remove_leading_weekday_names_from(first_part)
+          end
+          # =================================================================== #
+          # We may only display exams that are upcoming, not exams that
+          # have already been happening. This explains the following code.
+          #
+          # 12 hours cool-down phase before showing an old exam.
+          # =================================================================== #
+          if first_part.nil?
+            e "There is a problem: #{name_of_the_lecture} has "\
+              "invalid time entries. Please fix this."
+          end
+          unless first_part =~ /\d+/ # Unless it does not have at the least one number
+            e 'Something appears to be wrong for the time-format '\
+              'of the lecture `'+name_of_the_lecture+'`.'
+          end
+        end
+        twelve_hours_ago = (Time.now - (12 * ONE_HOUR))
+        if first_part.is_a? Time
+          time_parsed_first_part = first_part
+        else
+          time_parsed_first_part = Time.parse(first_part)
+        end
+        if time_parsed_first_part < twelve_hours_ago
+          # ================================================================= #
+          # This is valid for when the exam is already over. We will
+          # add it into an Array. But only with a 23 hour delay or so.
+          # ================================================================= #
+          array_obsolete_time_entries << lva_id+' '+
+                                         name_of_the_lecture+' '+
+                                         first_part.to_s.squeeze(' ')
+        else
+          n_ects_points_can_be_done += n_ects_points.to_f
+          we_will_show_n_exams += 1
+          inner_counter += 1
+          # ================================================================= #
+          # Colourize in crimson.
+          # ================================================================= #
+          if the_next_exam.frozen?
+            the_next_exam = the_next_exam.to_s.dup
+          end
+          unless the_next_exam.is_a? Time
+            the_next_exam.lstrip!
+            # =============================================================== #
+            # The next line will get rid of e. g. "Freitag" and similar strings.
+            # =============================================================== #
+            the_next_exam = remove_leading_weekday_names_from(the_next_exam)
+          end
+          if _priority
+            case _priority.to_s.strip
+            when '1'
+              # ============================================================= #
+              # High priority entries get the colour blue.
+              # ============================================================= #
+              _priority = '<b>Priorität: <span style="font-size:xx-large; color: darkblue">'+
+                _priority.to_s+
+              '</span></b>'+N
+            else
+              _priority = '<b>Priorität: <span style="font-size:large;">'+
+                _priority.to_s+
+              '</span></b>'+N
+            end
+          end
+          # ================================================================= #
+          # Colourize the next exam with a crimson colour.
+          # ================================================================= #
+          if the_next_exam.is_a? Time
+            the_next_exam = dd_mm_yyyy(the_next_exam)
+          end
+          crimson_coloured_the_next_exam = the_next_exam.sub(
+            /(\d\d.\d\d.\d\d\d\d)/, # See: http://rubular.com/r/qOQqVOjR63
+            '<span style="color:crimson">\1</span>'
+          )
+          # ================================================================= #
+          # Add the counter next. And colourize the more important lectures
+          # in darkblue. Lectures that are part of the vektor-curriculum
+          # get midnightblue in colour and will be larger.
+          # ================================================================= #
+          possibly_colourized_name_of_the_lecture = name_of_the_lecture.dup
+          if Studium.is_part_of_the_vektor_curriculum?(possibly_colourized_name_of_the_lecture)
+            possibly_colourized_name_of_the_lecture =
+              '<span style="color: midnightblue; text-decoration: underline">'+
+              possibly_colourized_name_of_the_lecture+
+              '</span>'
+          else
+            if original_priority == 1 # Then use a darkblue colour for the lecture in this case.
+              possibly_colourized_name_of_the_lecture =
+                '<span style="color: darkblue">'+
+                possibly_colourized_name_of_the_lecture+
+                '</span>'
+              if registered_for_an_upcoming_exam_at.is_a? Array
+                possibly_colourized_name_of_the_lecture =
+                  '<i style="text-decoration: underline;">'+
+                  possibly_colourized_name_of_the_lecture+
+                  '</i>'
+              end
+            end
+          end
+          # ================================================================= #
+          # Add the name of the lecture next, including a little balloon
+          # popup.
+          # ================================================================= #
+          if original_priority < 6
+            add_this_text_for_the_balloon = n_ects_points.to_s.dup
+            if registered_for_an_upcoming_exam_at
+              add_this_text_for_the_balloon << ' ECTS (registered for this exam)'
+            end
+            possibly_colourized_name_of_the_lecture_with_balloon_tooltip =
+              # ============================================================= #
+              # Add the balloon next:
+              # ============================================================= #
+              add_balloon(
+                add_this_text_for_the_balloon,
+                possibly_colourized_name_of_the_lecture
+              )
+            # =============================================================== #
+            # Creating the <html>-table's content next. This will make use
+            # of a university-logo.
+            # =============================================================== #
+            if remote_url.is_a? Array
+              remote_url = remote_url.first 
+            end
+            the_html_table << N+N+
+                              '<tr>'+N+
+                              '<td>'+
+                              '<a href ="'+remote_url+'">'+
+                              Studium.return_logo_for_this_university(at_this_university).to_s+
+                              '</a>'+N+
+                              '</td>'+N+
+                              '<td>'\
+                              '<b>'+' ('+inner_counter.to_s+') '+
+                              possibly_colourized_name_of_the_lecture_with_balloon_tooltip+'</b> '+
+                              colourized_lva_id+
+                              '</td>'+N
+          end
+          # ================================================================= #
+          # We will also add the weekday entry in the following code chunk.
+          # ================================================================= #
+          use_this_weekday = Studium.return_weekday_of_this_date(
+            the_next_exam, :german
+          ).strip
+          # ================================================================= #
+          # Add the amount of ECTS points next.
+          # ================================================================= #
+          if original_priority < 6
+            if registered_for_an_upcoming_exam_at.is_a? Array
+              # =============================================================== #
+              # This entry point is for exams the user has registered for.
+              # =============================================================== #
+              the_html_table << '<td><b style="color: navy">' << n_ects_points.to_s << ' ECTS</b></td>'+N
+            else
+              the_html_table << '<td><b>' << n_ects_points.to_s << ' ECTS</b></td>'+N
+            end
+            # ================================================================= #
+            # Add the next exam to the HTML table next. We will also use
+            # the weekday.
+            # ================================================================= #
+            the_html_table << "<td><b style=\"color: #930522\">#{use_this_weekday}</b> "\
+                              "<b>#{crimson_coloured_the_next_exam}</b></span> "\
+                              "<span></td>#{N}"
+            # ================================================================= #
+            # Append the priority but only if the priority is smaller than 6.
+            # We will also show the URL here.
+            # ================================================================= #
+            the_html_table << "<td>#{_priority}"\
+                              "<span style=\"font-size:smaller\">"\
+                              "#{HtmlTags.a(remote_url.to_s)}</span></td></tr>#{N}"
+          end
+        end
+      else
+        # =================================================================== #
+        # Ok, so the lecture may have not been solved already. We could
+        # report this, but I found this to be too spammy so I disabled it
+        # during March 2018.
+        # =================================================================== #
+        # if !lecture_has_been_solved_already
+        #   cliner {
+        #     e 'The lecture '+Studium::Colours.sfancy(name_of_the_lecture)+' either '\
+        #       'does not have a key called '+Studium::Colours.orange(':next_exam or exams')+
+        #       ' - at the least none could be found.'
+        #     pp inner_hash
+        #     pp the_next_exam
+        #   }
+        # end
+      end
+    }
+    _ << the_html_table+'</table>'+N # Add the HTML table here.
+    # ======================================================================= #
+    # Sneak in the timetable-header next.
+    # ======================================================================= #
+    _[WebConstants::TIMETABLE_DIV.size+1,0] =
+      "<div style=\"#{CSS_STYLE_TO_USE_FOR_THE_FIRST_TIMETABLE_DIV}\">#{N}#{N}"\
+      "Timetable for the next #{we_will_show_n_exams} upcoming exams:</b>"\
+       "#{N}#{N}</div>"
+    # ======================================================================= #
+    # Report how many ECTS points can be attained through the registered
+    # exams listed above.
+    # ======================================================================= #
+    _ << '<br><span style="margin-left: 2em; font-family: monospace; '\
+         'font-size:1.1em">A total of <b style="color:darkblue">'+
+         n_ects_points_can_be_done.to_s+' ECTS points</b> '\
+         'can be attained through the above exams.</span>'+N
+    _ << '</div>' # End the Timetable <div> tag here.
+    # ======================================================================= #
+    # Add obsolete time entries then.
+    # ======================================================================= #
+    unless array_obsolete_time_entries.empty?
+      string = 'There are some outdated entries:'.dup
+      string << "#{N}Consider updating these entries in the file lecture_information.yml#{N}"
+      e string
+      _ << HtmlTags.h3(string)
+      array_obsolete_time_entries.each {|this_lecture|
+        this_lecture.squeeze!(' ')
+        # =================================================================== #
+        # ["182.711", "Betriebssysteme", "04.03.2020"]
+        # =================================================================== #
+        splitted = this_lecture.split(' ')
+        splitted[-1] = "# #{splitted[-1]}"
+        this_lecture = splitted.join(' ')
+        leading_part = this_lecture.split(' ')[0 .. -2].join(' ')
+        e ::Colours.crimson('   →  ')+
+          ::Colours.orange(this_lecture)
+        # =================================================================== #
+        # Since as of 29.01.2020 we will also display the remote URL here.
+        # =================================================================== #
+        if leading_part.end_with? ' #'
+          leading_part[-2,2] = '' # Ad-hoc fix.
+        end
+        remote_url = Studium.return_remote_homepage_of_this_lecture(leading_part)
+        _ << "<b>#{this_lecture}</b> → <b><a href=\"#{remote_url}\">"\
+             "#{remote_url}</a></b><br>#{N}"
+      }
+    end
+    # ======================================================================= #
+    # And report lectures without an upcoming exam entry.
+    # ======================================================================= #
+    unless array_these_courses_have_no_upcoming_exam_entry.empty?
+      n_courses = array_these_courses_have_no_upcoming_exam_entry.size
+      _ << '<h4 style="margin-left:1em">The following '+n_courses.to_s+' courses '\
+           'have no upcoming exam entry:</h4>'+N
+      main_dataset = Studium.main_dataset?
+      array_these_courses_have_no_upcoming_exam_entry.each {|entry|
+        possible_remote_homepage = Studium.return_remote_homepage_of_this_lecture(entry)
+        # =================================================================== #
+        # Must expand the name next:
+        # =================================================================== #
+        entry = Studium.try_to_return_the_expanded_name_of_this_lecture(entry)
+        if possible_remote_homepage == entry
+          # ================================================================= #
+          # In this case try again, but with BeautifulUrl instead.
+          # ================================================================= #
+          possible_remote_homepage = BeautifulUrl[possible_remote_homepage]
+        end
+        if possible_remote_homepage.is_a? Array
+          possible_remote_homepage = possible_remote_homepage.first
+        end
+        this_university = main_dataset[entry][:university]
+        # =================================================================== #
+        # Next insert the picture of the university on the left hand side:
+        # =================================================================== #
+        case this_university.to_s
+        when 'Uni Wien','BOKU','TU Vienna'
+          _ << '<a href ="'+possible_remote_homepage+'" style="margin-left:4em">'+
+                           Studium.return_logo_for_this_university(this_university).to_s+
+                           '</a>'+N
+        end
+        _ << '<span style="font-weight:bold">'+entry+'</span>'
+        _ << ' | <a href="'+possible_remote_homepage+'">'+possible_remote_homepage+'</a>'
+        _ << '<br>'
+      }
+    end
+    _ # And return the result here.
+  end
+
+end