pdf_paradise 0.3.20

data/lib/pdf_paradise/remove_pdf_password.rb

@@ -0,0 +1,391 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: false
+# =========================================================================== #
+# === PdfParadise::RemovePdfPassword
+#
+# Use this class to remove a password from a .pdf file.
+#
+# We can either use "qpdf" or "pdftk".
+#
+# We could also fetch the password from ENV['PASSWORD'].
+#
+# Usage example:
+#
+#   PdfParadise::RemovePdfPassword.new(ARGV)
+#
+# =========================================================================== #
+# require 'pdf_paradise/remove_pdf_password.rb'
+# =========================================================================== #
+require 'pdf_paradise/base/base.rb'
+
+module PdfParadise
+
+class RemovePdfPassword < ::PdfParadise::Base # === PdfParadise::RemovePdfPassword
+
+  include FileUtils::Verbose
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === PASSWORD
+  #
+  # The password in use can be hardcoded here.
+  # ========================================================================= #
+  PASSWORD = 'Quellbrunn' # AGLMT15'
+
+  # ========================================================================= #
+  # === ARRAY_ALLOWED_PASSWORD_FILES
+  #
+  # A directory may include a PASSWORD.md file. In this case, we will use
+  # that particular file as the new password.
+  # ========================================================================= #
+  ARRAY_ALLOWED_PASSWORD_FILES = %w(
+    PASSWORD.md
+    PASSWORT.md
+  )
+
+  # ========================================================================= #
+  # === REGEX_FOR_PASSWORD
+  # ========================================================================= #
+  REGEX_FOR_PASSWORD = /--password(=| )(.+) ?/
+
+  # ========================================================================= #
+  # === AUTOMATICALLY_REPLACE
+  #
+  # If this constant is set to true then we will automatically
+  # replace the old, existing .pdf file with the newly generated
+  # file.
+  # ========================================================================= #
+  AUTOMATICALLY_REPLACE = false
+
+  # ========================================================================= #
+  # === COMMAND_NOT_FOUND
+  # ========================================================================= #
+  COMMAND_NOT_FOUND = "command not found\n"
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    set_password # Reset it here.
+    @output_file = nil
+    # ======================================================================= #
+    # === @automatically_replace
+    # ======================================================================= #
+    @automatically_replace = AUTOMATICALLY_REPLACE
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === run_sys_command
+  # ========================================================================= #
+  def run_sys_command(i = string?)
+    esystem i
+  end
+
+  # ========================================================================= #
+  # === string?
+  # ========================================================================= #
+  def string?
+    @string
+  end
+
+  # ========================================================================= #
+  # === set_password
+  # ========================================================================= #
+  def set_password(i = PASSWORD)
+    @password = i
+  end
+
+  # ========================================================================= #
+  # === mv
+  # ========================================================================= #
+  def mv(old, new)
+    new = new.strip # We don't want any newlines.
+    if File.exist? old
+      opnn; e "Now replacing `#{sfancy(old)}` with `#{simp(new)}`."
+      FileUtils.mv(old, new)
+    else
+      opnn; e "No file exists at `#{sfile(old)}`, thus can not rename/replace."
+    end
+  end
+
+  # ========================================================================= #
+  # === password?
+  # ========================================================================= #
+  def password?
+    @password
+  end
+
+  # ========================================================================= #
+  # === tell_the_user_that_we_will_remove_the_password_next
+  # ========================================================================= #
+  def tell_the_user_that_we_will_remove_the_password_next(this_file = input?)
+    opnn; e 'Now removing the password ('+orange(password?.to_s)+') '\
+            'from the file `'+sfile(this_file)+'`.'
+  end
+
+  # ========================================================================= #
+  # === check_commandline                                          (menu tag)
+  #
+  # Pass the commandline arguments through this method.
+  # ========================================================================= #
+  def check_commandline(i)
+    if i.is_a? Array
+      i.each {|entry|
+        check_commandline(entry)
+      }
+    else
+      case i.to_s # case tag
+      # ===================================================================== #
+      # === remove_password --batch
+      # ===================================================================== #
+      when /-?-?batch/
+        @input = Dir['*.pdf']
+      # ===================================================================== #
+      # === remove_password --password?
+      # ===================================================================== #
+      when '--password?',
+           'password?',
+           'password'
+        e password?
+        exit
+      # ===================================================================== #
+      # === remove_password --help
+      # ===================================================================== #
+      when 'HELP',
+           '--help',
+           'help'
+        show_help
+        exit
+      else
+        if i.include? '--'
+          if i.include?('--password ') or i.include?('--password')
+            i =~ REGEX_FOR_PASSWORD # See here for the test: http://rubular.com/r/P6LScCOVYZ
+            set_password($2.to_s.dup) # The second capture group holds our result.
+            i.gsub!(REGEX_FOR_PASSWORD, '')
+          end
+        end unless i.is_a? Symbol
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # Show some instructions in how to use this class.
+  #
+  # Invocation example:
+  #
+  #   nopassword --help
+  #
+  # ========================================================================= #
+  def show_help
+    e
+    e 'You can set a different password via:'
+    e
+    e sfancy('  --password NEW_PASSWORD_HERE')
+    e
+    e 'nopdf *.pdf --password '+password?
+    e
+    e 'If you want to batch-process all .pdf files in the '\
+      'current directory,'
+    e 'and subsequently remove all password-protection '\
+      'from these files, do:'
+    e
+    e sfancy('  --batch')
+    e
+  end
+
+  # ========================================================================= #
+  # === remove_password_through_qpdf
+  #
+  # Here we make use of qpdf.
+  # ========================================================================= #
+  def remove_password_through_qpdf(
+      work_on_this_file = input?
+    )
+    if qpdf_exists?
+      set_output_file(work_on_this_file)
+      @string = 'qpdf --password='+password?+' --decrypt '+
+                 work_on_this_file+' '+output_file?
+    else
+      e 'qpdf does not exist. Please install it. Exiting now.'
+      exit
+    end
+  end
+
+  # ========================================================================= #
+  # === set_output_file
+  # ========================================================================= #
+  def set_output_file(i)
+    i = file_name_without_extension?(i)
+    i = "no_password_#{i}.pdf"
+    @output_file = i
+  end
+
+  # ========================================================================= #
+  # === file_name_without_extension?
+  # ========================================================================= #
+  def file_name_without_extension?(i = input?)
+    i.strip.sub(/\.pdf$/,'') # Chop off trailing extension name.
+  end
+
+  # ========================================================================= #
+  # === output_file?
+  # ========================================================================= #
+  def output_file?
+    @output_file
+  end; alias output? output_file? # === output?
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    super(NAMESPACE)
+  end
+
+  # ========================================================================= #
+  # === qpdf_exists?
+  #
+  # Query method to try to find out whether qpdf is installed.
+  # ========================================================================= #
+  def qpdf_exists?
+    result = `qpdf 2>&1`
+    ! result.include?(COMMAND_NOT_FOUND)
+  end
+
+  # ========================================================================= #
+  # === remove_password_through_pdftk
+  # ========================================================================= #
+  def remove_password_through_pdftk(this_file)
+    # ======================================================================= #
+    # Decrypt a PDF called input.pdf with YOURPASSWORD-HERE password
+    # and create unencrypted output.pdf, enter:
+    # ======================================================================= #
+    @string = 'pdftk '+this_file+' output no_password_output.pdf user_pw '+password?
+  end
+
+  # ========================================================================= #
+  # === consider_replacing_the_old_file
+  # ========================================================================= #
+  def consider_replacing_the_old_file(
+      old_file    = input?,
+      output_file = @output_file
+    )
+    if @automatically_replace
+      opnn; e 'The constant '+swarn('AUTOMATICALLY_REPLACE')+' is set to true.'
+      opnn; e 'This means that we will automatically try to replace '\
+              'the old .pdf with the new .pdf'
+      mv(output_file, old_file)
+    end
+  end
+
+  # ========================================================================= #
+  # === set_input
+  #
+  # Since as of Jul 2016, the input given to this class must always
+  # be ketp as an Array.
+  # ========================================================================= #
+  def set_input(
+      i = '', do_check_the_commandline = true
+    )
+    case do_check_the_commandline
+    when :do_not_check_the_commandline
+      do_check_the_commandline = false
+    end
+    # ======================================================================= #
+    # Next we will have special symbol-instructions here, in
+    # particular :all_pdf_files
+    # ======================================================================= #
+    if i.is_a? Symbol
+      case i
+      when :all_pdf_files
+        i = Dir['*.pdf']
+      end
+    end
+    if i.is_a? Array
+      i.flatten!
+    else
+      i = [i]
+    end
+    @input = i # This is guaranteed to be an Array.
+    check_commandline(i) if do_check_the_commandline
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    check_for_a_password_file_in_the_current_directory
+    # ======================================================================= #
+    # Iterate over the given input-files.
+    # ======================================================================= #
+    input?.each {|file|
+      remove_password_through_qpdf(file)
+      # remove_password_through_pdftk(file) # Pick this, or the other one.
+      tell_the_user_that_we_will_remove_the_password_next(file)
+      run_sys_command
+      consider_replacing_the_old_file(file)
+    }
+  end
+
+  # ========================================================================= #
+  # === check_for_a_password_file_in_the_current_directory     (password tag)
+  #
+  # We can check for several password files.
+  # ========================================================================= #
+  def check_for_a_password_file_in_the_current_directory
+    _ = ARRAY_ALLOWED_PASSWORD_FILES
+    does_any_file_exist = _.select {|entry|
+      File.exist?(entry)
+    }
+    does_a_password_file_exist = !does_any_file_exist.empty?
+    if does_a_password_file_exist
+      this_selection = does_any_file_exist.first
+      opnn; e 'A file called `'+sfile(this_selection)+'` was found in the current directory.'
+      if File.zero? this_selection # Check whether it is empty.
+        opnn; e 'As it is, however had, empty, we will not change the '\
+                "password to the file's content."
+      else
+        # =================================================================== #
+        # Read in the new password from the existing file.
+        # =================================================================== #
+        use_this_dataset = File.readlines(this_selection).map(&:chomp)
+        set_password(
+          use_this_dataset.first # <- We will only honour the first line of this file.
+        )
+        opnn; e 'We will use the content of this file as the new password '\
+                '(Password thus being: '+orange(password?)+').'
+      end 
+    end
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::RemovePdfPassword.new(ARGV)
+end # no_password

data/lib/pdf_paradise/requires/batch_require_toplevel_files.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module PdfParadise
+
+  require 'pdf_paradise/project/project.rb'
+
+  # ========================================================================= #
+  # === PdfParadise.batch_require_toplevel_files
+  #
+  # Batch require all .rb files that are part of the project.
+  # ========================================================================= #
+  def self.batch_require_toplevel_files
+    files = Dir["#{PdfParadise.project_base_dir?}*.rb"]
+    files.reject! {|entry| entry.include? 'merge_pdf_namespace' }
+    files.each {|file|
+      require "pdf_paradise/#{File.basename(file)}"
+    }
+  end
+
+end; PdfParadise.batch_require_toplevel_files # And call it at once.

data/lib/pdf_paradise/requires/colours.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+begin
+  require 'colours'
+rescue LoadError; end
+
+begin
+  require 'colours/autogenerated/html_colours_methods.rb'
+rescue LoadError; end

data/lib/pdf_paradise/requires/colours_and_esystem_and_save_file_and_fileutils_and_opn.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/requires/colours_and_esystem_and_save_file_and_fileutils_and_opn.rb'
+# =========================================================================== #
+require 'pdf_paradise/requires/esystem_and_opn_and_colours.rb'
+
+require 'fileutils'
+
+begin
+  require 'save_file'
+rescue LoadError; end

data/lib/pdf_paradise/requires/esystem_and_colours.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/requires/esystem_and_colours.rb'
+# =========================================================================== #
+begin
+  require 'esystem'
+rescue LoadError; end
+
+require 'pdf_paradise/requires/colours.rb'

data/lib/pdf_paradise/requires/esystem_and_opn_and_colours.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/requires/esystem_and_opn_and_colours.rb'
+# =========================================================================== #
+require 'pdf_paradise/requires/esystem_and_colours.rb'
+begin
+  require 'opn'
+rescue LoadError; end

data/lib/pdf_paradise/requires/require_the_whole_project.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/requires/require_the_whole_project.rb
+# =========================================================================== #
+# The second require statement will pull in all relevant .rb files
+# from the project toplevel area.
+# =========================================================================== #
+require 'pdf_paradise/version/version.rb'
+require 'pdf_paradise/requires/batch_require_toplevel_files.rb'
+require 'pdf_paradise/merge_pdf/merge_pdf.rb' # Extra-call for class MergePdf
+require 'pdf_paradise/main_pdf/main_pdf.rb'
+# =========================================================================== #
+# Add pdf_paradise/toplevel_methods/ files next:
+# =========================================================================== #
+require 'pdf_paradise/toplevel_methods/reduce_size_of_this_pdf_file.rb'
+require 'pdf_paradise/toplevel_methods/opened_pdf_files.rb'
+require 'pdf_paradise/toplevel_methods/misc.rb'
+# =========================================================================== #
+# And the commandline-part as well:
+# =========================================================================== #
+require 'pdf_paradise/commandline/menu.rb'
+require 'pdf_paradise/prawn_addons/prawn_addons.rb'
+
+require 'pdf_paradise/compress/compress_via_hexapdf.rb'
+
+require 'pdf_paradise/requires/require_utility_scripts.rb'
+
+require 'pdf_paradise/toplevel_methods/query_pdf_title.rb'

data/lib/pdf_paradise/requires/require_utility_scripts.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/requires/require_utility_scripts.rb'
+# =========================================================================== #
+require 'pdf_paradise/toplevel_methods/misc.rb'
+
+PdfParadise.do_require_the_utility_scripts

data/lib/pdf_paradise/set_main_book.rb

@@ -0,0 +1,156 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::SetMainBook
+#
+# This class can set the new main-book for use on my computer system.
+# It will be assumed that the book is kept in a .pdf file format.
+#
+# It is not very useful to other people though.
+#
+# Usage example:
+#
+#   PdfParadise::SetMainBook.new(ARGV)
+#
+# =========================================================================== #
+# require 'pdf_paradise/set_main_book.rb'
+# PdfParadise::SetMainBook.new(ARGV)
+# =========================================================================== #
+require 'pdf_paradise/base/base.rb'
+
+module PdfParadise
+
+class SetMainBook < ::PdfParadise::Base # === PdfParadise::SetMainBook
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === FILE_ROEBERIA_SETTINGS
+  # ========================================================================= #
+  FILE_ROEBERIA_SETTINGS =
+    '/home/x/data/personal/yaml/roeberia_settings.yml'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i = '')
+    i = [i].flatten.compact
+    @commandline_arguments = i
+    consider_sanitizing_the_first_argument
+  end
+
+  # ========================================================================= #
+  # === consider_sanitizing_the_first_argument
+  #
+  # This method currently only makes sure that the argument given to
+  # this class will have the proper full path.
+  # ========================================================================= #
+  def consider_sanitizing_the_first_argument
+    if @commandline_arguments.first
+      unless @commandline_arguments.first.include? '/'
+        @commandline_arguments[0] = return_pwd+File.basename(@commandline_arguments[0])
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === modify_this_file
+  #
+  # This method will modify the file at hand, which is typically a
+  # .yml file (aka "roeberia_settings.yml").
+  #
+  # Call this method after you have made sure that the file at hand
+  # DOES exist.
+  # ========================================================================= #
+  def modify_this_file(
+      this_file = FILE_ROEBERIA_SETTINGS
+    )
+    seek_this_word = 'MAIN_BOOK'
+    require 'find_line_in_file'
+    result = FindLineInFile[
+      search_term: seek_this_word,
+      where:       this_file
+    ]
+    n_padding = 23 # This is hard-coded for now.
+    dataset = File.readlines(this_file)
+    line = dataset[result - 1]
+    if line.include? seek_this_word
+      padding = ' ' * (n_padding - ('MAIN_BOOK:'.size))
+      line = "MAIN_BOOK:"\
+             "#{padding}"\
+             "#{first_argument?}"
+      target = '/home/Temp/'+File.basename(this_file)
+      e "Backing up the old file next, onto `#{sfile(target)}`."
+      FileUtils.copy(this_file, target)
+      # ===================================================================== #
+      # Now we can store this dataset.
+      # ===================================================================== #
+      dataset[result - 1] = line
+      unless dataset.last == "\n"
+        dataset << "\n" # I like a trailing newline.
+      end
+      write_what_into(dataset, this_file)
+    else
+      e "The line does not include our search "\
+        "term #{sfancy(seek_this_word)}."
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    first_argument = first_argument?
+    if first_argument and File.file?(first_argument)
+      opnn; e rev+
+              'Next assigning the file '+sfile(first_argument)
+      opnn; e 'to be the new main .pdf file.'
+      if File.exist? FILE_ROEBERIA_SETTINGS
+        modify_this_file(FILE_ROEBERIA_SETTINGS)
+      else
+        e 'No file exists at '+sfile(FILE_ROEBERIA_SETTINGS)+'.'
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::SetMainBook[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::SetMainBook.new(ARGV)
+end # setmainbook /home/x/books/JAVA/DONE_Learn_Java_the_Easy_Way_2017.pdf