pdf_paradise 0.1.43

data/lib/pdf_paradise/gui/shared_code/to_pdf/to_pdf_module.rb

@@ -0,0 +1,273 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::GUI::Gtk::ToPdfModule
+# =========================================================================== #
+# require 'pdf_paradise/gui/shared_code/to_pdf/to_pdf_module.rb'
+# include ::PdfParadise::GUI::Gtk::ToPdfModule
+# =========================================================================== #
+module PdfParadise
+
+module GUI
+
+module Gtk
+
+module ToPdfModule
+
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+  include ::Gtk::BaseModule
+
+  require 'pdf_paradise/toplevel_methods/to_pdf.rb'
+
+  begin
+    require 'pdf-reader' # Add an optional dependency here.
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Convert to .pdf'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 1540
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 400
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  #
+  # Set a default font here.
+  # ========================================================================= #
+  USE_THIS_FONT = 'Sans 20'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    super(:vertical)
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    reset_the_internal_variables
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, NAMESPACE]
+    # ======================================================================= #
+    # === @title
+    # ======================================================================= #
+    @title  = TITLE
+    # ======================================================================= #
+    # === @width
+    # ======================================================================= #
+    @width  = WIDTH
+    # ======================================================================= #
+    # === @height
+    # ======================================================================= #
+    @height = HEIGHT
+    set_use_this_font(USE_THIS_FONT)
+    use_gtk_paradise_project_css_file
+  end
+
+  # ========================================================================= #
+  # === create_skeleton
+  # ========================================================================= #
+  def create_skeleton
+    create_buttons
+    create_the_statusbar
+  end
+
+  # ========================================================================= #
+  # === create_the_statusbar
+  # ========================================================================= #
+  def create_the_statusbar
+    @statusbar = gtk_statusbar_with_handle
+    @status_bar_context_id = @statusbar.get_context_id('to_pdf')
+  end
+
+  # ========================================================================= #
+  # === create_buttons                              (buttons tag, button tag)
+  # ========================================================================= #
+  def create_buttons
+    # ======================================================================= #
+    # === @button_do_convert
+    # ======================================================================= #
+    @button_do_convert = gtk_button('_Convert it to .pdf format')
+    @button_do_convert.disallow_resizing
+    @button_do_convert.css_class('clear_background')
+    @button_do_convert.steelblue
+    @button_do_convert.css_class('BG_lightblue')
+    @button_do_convert.hint = 'This will use libreoffice '\
+      'to convert the file at hand into a <b>.pdf file</b>.'
+    @button_do_convert.on_clicked {
+      do_convert_the_given_file
+    }
+    # ======================================================================= #
+    # === @button_choose_file
+    #
+    # This is the "Open File" button.
+    # ======================================================================= #
+    @button_choose_file = gtk_file_chooser_button
+    @button_choose_file.on_clicked {
+      create_a_new_file_chooser_dialog
+      main_entry?.set_text(main_file?.to_s)
+    }
+    # ======================================================================= #
+    # === @button_open_the_converted_file
+    # ======================================================================= #
+    @button_open_the_converted_file = gtk_button('_Open')
+    @button_open_the_converted_file.hint = 'Click to open the '\
+      'converted file via main .pdf reader.'
+    @button_open_the_converted_file.on_clicked {
+      do_open_the_converted_file_via_a_pdf_reader
+    }
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    create_skeleton
+    chdir('/Depot/j/') if File.directory? '/Depot/j/'
+    vbox = gtk_vbox
+    vbox.minimal(
+      gtk_label('Input the filename that you wish to convert here:'), 1
+    )
+    @entry_filename = gtk_entry
+    @entry_filename.bblack1
+    @entry_filename.yellow_background
+    vbox.minimal(@entry_filename, 1)
+    minimal(vbox, 1)
+    pack_without_expand(@button_choose_file, 1)
+    pack_without_expand(@button_do_convert,  1)
+    hbox = gtk_hbox
+    hbox.maximal(@statusbar, 1)
+    hbox.minimal(@button_open_the_converted_file, 1)
+    add(hbox)
+    @text_buffer = gtk_text_buffer
+    @text_view = gtk_text_view(@text_buffer)
+    @scrolled_window = gtk_scrolled_window(@text_view) { :top_to_bottom }
+    @scrolled_window.bblack1
+    @scrolled_window.css_class('pad4px')
+    @scrolled_window.width_height(500, 400)
+    minimal(@scrolled_window)
+    do_style_all_buttons_in_a_uniform_manner
+  end
+
+  # ========================================================================= #
+  # === do_style_all_buttons_in_a_uniform_manner
+  # ========================================================================= #
+  def do_style_all_buttons_in_a_uniform_manner
+    return_all_buttons.each {|entry|
+      entry.bblack1
+      entry.css_class('pad2px')
+    }
+  end
+
+  # ========================================================================= #
+  # === entry_filename?
+  # ========================================================================= #
+  def entry_filename?
+    @entry_filename
+  end; alias main_entry? entry_filename? # === main_entry?
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    0
+  end
+
+  # ========================================================================= #
+  # === favicon?
+  # ========================================================================= #
+  def favicon?
+    :tabble
+  end
+
+  # ========================================================================= #
+  # === do_open_the_converted_file_via_a_pdf_reader
+  # ========================================================================= #
+  def do_open_the_converted_file_via_a_pdf_reader
+    stored_here = stored_where?
+    if File.exist? stored_here
+      system 'evince '+stored_here
+    else
+      e 'No file exists at '+sfile(stored_here)+'.'
+    end
+  end
+
+  # ========================================================================= #
+  # === stored_where?
+  # ========================================================================= #
+  def stored_where?(
+      i = @entry_filename.text?
+    )
+    _ = PdfParadise.to_pdf(i)
+    _ = _.dup
+    _ = _.join(' ').strip if _.is_a? Array
+    _.delete_suffix!(File.extname(i))
+    _ << '.pdf' unless _.end_with? '.pdf' 
+    return _.to_s
+  end
+
+  # ========================================================================= #
+  # === do_convert_the_given_file
+  #
+  # This is the method that will convert the target file into the
+  # .pdf file, usually by using "soffice".
+  # ========================================================================= #
+  def do_convert_the_given_file
+    _ = stored_where?
+    @statusbar.display(
+      'Stored the file at: '+_, :default, @status_bar_context_id
+    ) if File.exist? _
+    # ======================================================================= #
+    # Read in the .pdf file if it exists and if the PDF::Reader namespace
+    # exists.
+    # ======================================================================= #
+    if File.exist?(_) and
+       Object.const_defined?(:PDF) and PDF.const_defined?(:Reader)
+      reader = PDF::Reader.new(_)
+      page   = reader.page(1)
+      use_this_text = page.text.to_s
+      @scrolled_window.set_text(use_this_text.to_s)
+    end
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::GUI::Gtk::ToPdfModule.run
+  # ========================================================================= #
+  def self.run(i = ARGV)
+    require 'gtk_paradise/run'
+    r = ::Gtk.run
+    _ = PdfParadise::GUI::Gtk::ToPdf.new(r)
+    r << _
+    r.automatic
+    r.easy_exit_top_left_then_run
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::GUI::Gtk::ToPdfModule.run
+end

data/lib/pdf_paradise/main_pdf/main_pdf.rb

@@ -0,0 +1,437 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::MainPdf
+#
+# Use this file to open one or several .pdf files.
+#
+# The convention is that you can pass both commandlines and also
+# filenames on the commandlines.
+#
+# Usage example:
+#
+#   PdfParadise::MainPdf.new
+#
+# =========================================================================== #
+# require 'pdf_paradise/main_pdf/main_pdf.rb'
+# =========================================================================== #
+require 'yaml'
+require 'cliner'
+require 'pdf_paradise/base/base.rb'
+require 'pdf_paradise/constants/constants.rb'
+
+module PdfParadise
+
+class MainPdf < Base # === PdfParadise::MainPdf
+
+  begin
+    require 'save_file'
+  rescue LoadError; end
+
+  begin
+    require 'directory_paradise'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === MAIN_PDF_YAML_FILE
+  # ========================================================================= #
+  MAIN_PDF_YAML_FILE = ::PdfParadise.file_main_pdf_yaml_file?
+
+  # ========================================================================= #
+  # === HOME_DIR
+  # ========================================================================= #
+  HOME_DIR = ENV['HOME'].to_s+'/'
+
+  # ========================================================================= #
+  # === LAST_DOWNLOADED_FILE
+  # ========================================================================= #
+  LAST_DOWNLOADED_FILE =
+    "#{HOME_DIR}LAST_DOWNLOADED_FILE.md"
+
+  # ========================================================================= #
+  # === LAST_PDF_FILE_OPENED
+  # ========================================================================= #
+  LAST_PDF_FILE_OPENED =
+    "#{HOME_DIR}LAST_PDF_FILE_OPENED.md"
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # The first argument can be an Array or a String, of pdf-files that
+  # we attempt to open.
+  # ========================================================================= #
+  def initialize(
+      these_pdf_files = nil,
+      run_already     = true
+    )
+    reset
+    check_commandline_options(
+      these_pdf_files
+    )
+    case run_already
+    when :do_not_run_yet
+      run_already = false
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @pdf_viewer
+    # ======================================================================= #
+    if File.exist? MAIN_PDF_YAML_FILE
+      @pdf_viewer = YAML.load_file(MAIN_PDF_YAML_FILE)
+    else
+      ewarn "The file at `#{MAIN_PDF_YAML_FILE}` was not found."
+    end
+    @pdf_viewer = @pdf_viewer.first if @pdf_viewer.is_a? Array # Use only the first entry for now if we read in an Array.
+    # ======================================================================= #
+    # === @open_these_pdf_files
+    # ======================================================================= #
+    @open_these_pdf_files = []
+    # ======================================================================= #
+    # === @commandline_options
+    # ======================================================================= #
+    @commandline_options  = [] # This array may contain our commandline options.
+  end
+
+  # ========================================================================= #
+  # === save_new_pdf_handler
+  #
+  # The first (and only) argument to this method is which new pdf handler
+  # we will use. Afterwards we will exit.
+  #
+  # To invoke this method, do:
+  #   mpdf SAVE xournal
+  #   mpdf SAVE okular
+  # ========================================================================= #
+  def save_new_pdf_handler(i = @commandline_options[1])
+    i = i.to_s
+    e 'Saving `'+sfancy(i)+'` into `'+sfile(MAIN_PDF_YAML_FILE)+'`.'
+    ::SaveFile.save_what_where(i, MAIN_PDF_YAML_FILE)
+    exit
+  end
+
+  # ========================================================================= #
+  # === show_yaml_file
+  # ========================================================================= #
+  def show_yaml_file
+    e 'The main yaml file is at `'+sfile(main_yaml_file?)+'`.'
+  end
+
+  # ========================================================================= #
+  # === MAIN_PDF_YAML_FILE
+  # ========================================================================= #
+  def main_yaml_file?
+    MAIN_PDF_YAML_FILE
+  end
+
+  # ========================================================================= #
+  # === feedback_pdf_handler_in_use
+  # ========================================================================= #
+  def feedback_pdf_handler_in_use
+    e 'You currently use this as .pdf handler: '+
+      sfancy(@pdf_viewer)
+  end
+
+  # ========================================================================= #
+  # === ecomment
+  # ========================================================================= #
+  def ecomment(i)
+    Colours.ecomment(i)
+  end
+
+  # ========================================================================= #
+  # === check_whether_we_have_found_any_pdf_file
+  #
+  # This method checks whether we have found any .pdf file or not. If not,
+  # we try to check whether the current directory has any .pdf file at all.
+  # ========================================================================= #
+  def check_whether_we_have_found_any_pdf_file
+    if @open_these_pdf_files.empty?
+      any_pdf_file = get_all_pdf_files
+      if ! any_pdf_file.empty?
+        _ = any_pdf_file.first
+        e 'It seems as if no .pdf file was supplied.'
+        e 'We did however find at least one .pdf file. We will now '
+        e 'use this .pdf file at '+sfile(_)+'.'
+        add _
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === edit_this_file_here
+  # ========================================================================= #
+  def edit_this_file_here
+    _ = 'bluefish '+__FILE__
+    esystem _
+  end
+
+  # ========================================================================= #
+  # === do_log_this_pdf_file_was_opened_last
+  # ========================================================================= #
+  def do_log_this_pdf_file_was_opened_last(i = @full_file_location)
+    save_what_into(i, LAST_PDF_FILE_OPENED)
+  end
+
+  # ========================================================================= #
+  # === set_full_file_location
+  # ========================================================================= #
+  def set_full_file_location(i)
+    unless i.include? '/'
+      i = Dir.pwd+'/'+i
+    end
+    @full_file_location = i
+  end
+
+  # ========================================================================= #
+  # === MainPdf[]
+  # ========================================================================= #
+  def self.[](i, optional_commandline_arguments = nil)
+    _ = self.new(i, :do_not_run_yet)
+    if optional_commandline_arguments
+      _.commandline_arguments = optional_commandline_arguments
+    end
+    _.run
+  end
+
+  # ========================================================================= #
+  # === check_commandline_options
+  #
+  # The convention is simply - if it is a valid file, we 
+  # add it to the list of pdf files to open.
+  # ========================================================================= #
+  def check_commandline_options(i)
+    if i.is_a? Array
+      i.each {|entry| check_commandline_options(entry) }
+    else # We either add it to the list of pdf files to open, or to the commandline options
+      if File.exist? i
+        # =================================================================== #
+        # Open the .pdf file here, if it exists.
+        # =================================================================== #
+        add_to_open_these_pdf_files(i)
+      else
+        @commandline_options << i
+      end
+    end
+  end; alias commandline_arguments= check_commandline_options # === commandline_arguments=
+
+  # ========================================================================= #
+  # === process_commandline_options
+  #
+  # Use this method to process the commandline options given.
+  # ========================================================================= #
+  def process_commandline_options
+    _ = @commandline_options.first
+    case _ # case tag
+    # ======================================================================= #
+    # === --open-main-pdf
+    # ======================================================================= #
+    when /^-?-?open(-|_)?main(-|_)?pdf$/i
+      add_to_open_these_pdf_files(:the_main_pdf)
+    # ======================================================================= #
+    # === mpdf --open-last
+    # ======================================================================= #
+    when /^-?-?open(-|_)?last$/i,
+         'OPENLATEST','LATEST',
+         'LAST','last'
+      open_last_found_pdf
+    # ======================================================================= #
+    # === mpdf --query?
+    # ======================================================================= #
+    when /-?-?query\??/,'QUERY','QUERY?','?','PDF?',/-?-?current\??/
+      feedback_pdf_handler_in_use
+      exit
+    # ======================================================================= #
+    # === mpdf --file?
+    # ======================================================================= #
+    when /-?-?file\??/
+      show_yaml_file
+      exit
+    # ======================================================================= #
+    # === mpdf SAVE okular
+    # ======================================================================= #
+    when 'SAVE','SET','save','set','--save','--set'
+      save_new_pdf_handler
+    # ======================================================================= #
+    # === mpdf --help
+    # ======================================================================= #
+    when /-?-?help/,'HELP'
+      feedback_available_commandline_options
+    # ======================================================================= #
+    # === mpdf --restore
+    # ======================================================================= #
+    when /-?-?restore/,'RESTORE'
+      add( File.readlines(LAST_PDF_FILE_OPENED)[0].to_s.strip )
+    # ======================================================================= #
+    # === mpdf --edit
+    # ======================================================================= #
+    when 'EDIT','OPEN','OPEN_SELF','OPENSELF',/edit/
+      edit_this_file_here; exit
+    # ======================================================================= #
+    # === mpdf --okular
+    # ======================================================================= #
+    when 'USE_OKULAR','OKULAR',/^-?-?okular/
+      save_new_pdf_handler :okular
+    # ======================================================================= #
+    # === mpdf --use-evince
+    # ======================================================================= #
+    when 'USE_EVINCE','EVINCE','evince',
+         /^-?-?use(-|_)?evince$/i
+      save_new_pdf_handler :evince
+    # ======================================================================= #
+    # === mpdf --fullscreen
+    # ======================================================================= #
+    when 'FULLSCREEN','--fullscreen'
+      @pdf_viewer << ' --fullscreen'
+    # ======================================================================= #
+    # === mpdf LAST_DOWNLOAD
+    # ======================================================================= #
+    when 'LAST_DOWNLOAD','LASTDOWNLOAD'
+      last_downloaded_file = LAST_DOWNLOADED_FILE
+      if File.exist? last_downloaded_file
+        add(File.readlines(last_downloaded_file).first)
+      end
+    else # else step
+      unless File.exist? _
+        opn; e 'Unsure what to do with input `'+simp(_)+'`.'
+      end if _
+    end
+  end
+
+  # ========================================================================= #
+  # === run_sys_command
+  # ========================================================================= #
+  def run_sys_command
+    process_commandline_options
+    check_whether_we_have_found_any_pdf_file
+    open_all_pdf_files
+  end
+
+  # ========================================================================= #
+  # === open_all_pdf_files
+  # ========================================================================= #
+  def open_all_pdf_files
+    @open_these_pdf_files.each {|entry|
+      consider_opening_this_pdf_file(entry)
+    }
+  end
+
+  # ========================================================================= #
+  # === consider_opening_this_pdf_file
+  #
+  # This method will do the actual opening-part, by using system().
+  # ========================================================================= #
+  def consider_opening_this_pdf_file(i = @open_these_pdf_files)
+    if File.exist? i
+      set_full_file_location(i)
+      i = '"'+i+'"' if i.include? ' '
+      i = '"'+i+'"' if i.include? '('
+      i = '"'+i+'"' if i.include? "'"
+      i = @pdf_viewer+' '+i+' &'
+      do_log_this_pdf_file_was_opened_last
+      esystem i
+    else # Ok, at this point the file does not exist. Try a regex first.
+      results = Dir['*'+i+'*']
+      if results.empty? 
+        opn; e 'No valid .pdf file was found at `'+sfile(i)+'`.'
+        opn; e 'Thus we can not open anything.'
+      else
+        consider_opening_this_pdf_file(results.first)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === feedback_available_commandline_options                     (help tag)
+  #
+  # Show the available help options next.
+  # ========================================================================= #
+  def feedback_available_commandline_options(
+      shall_we_exit = true
+    )
+    cliner {
+      ecomment '  RESTORE       - open the last opened .pdf file in general'
+      ecomment '  OPEN_LAST     - open the "youngest" .pdf file in the current working directory'
+      ecomment '  EDIT          - open this file here'
+      ecomment '  QUERY         - query which is our current default pdf reader'
+      ecomment '  --current?    - alias to the above'
+      ecomment '  --file?       - show the location of the .yml file'
+      ecomment '  SAVE / SET    - save a new mpdf handler to use (i.e. '\
+               '"okular", via "mpdf SAVE okular")'
+      ecomment '  LAST_DOWNLOAD - open the last downloaded file stored in '+
+                LAST_DOWNLOADED_FILE
+    }
+    exit if shall_we_exit
+  end
+
+  # ========================================================================= #
+  # === get_all_pdf_files
+  # ========================================================================= #
+  def get_all_pdf_files
+    _ = DirectoryParadise::Reprt.new('', :do_not_run_yetfalse)
+    _.menu(:latest)
+    _.gather_content
+    only_pdf_files = _.content.select {|entry|
+      entry.include? '.pdf'
+    }
+    return only_pdf_files
+  end
+
+  # ========================================================================= #
+  # === open_last_found_pdf
+  #
+  # This will open the last .pdf file in the current directory. Which
+  # one is that? We will act on the file information here.
+  # ========================================================================= #
+  def open_last_found_pdf
+    add :latest_pdf
+  end
+
+  # ========================================================================= #
+  # === add_to_open_these_pdf_files                                 (add tag)
+  # ========================================================================= #
+  def add_to_open_these_pdf_files(i)
+    case i
+    # ======================================================================= #
+    # === :main_pdf
+    # ======================================================================= #
+    when :main_pdf,
+         :the_main_pdf
+      i = ENV['MAIN_BOOK'].to_s
+    # ======================================================================= #
+    # === :latest_pdf
+    # ======================================================================= #
+    when :latest_pdf
+      i = get_all_pdf_files.sort.first.to_s # Get the latest .pdf file. [0] Should be the properly sorted one.
+    end
+    @open_these_pdf_files << i
+  end; alias add add_to_open_these_pdf_files # === add
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_sys_command
+  end
+
+end
+
+# =========================================================================== #
+# === PdfParadise.main_pdf
+# =========================================================================== #
+def self.main_pdf(i = ARGV)
+  ::PdfParadise::MainPdf.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise.main_pdf(ARGV)
+end # mpdf AUPC_Einheit_I_Einfuehrung_2013.pdf  AUPC_Einheit_II_2013.pdf