html2slideshow 2.0

data/lib/about.rb

@@ -0,0 +1,57 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   Copyright © 2008-2017, Michael Uplawski <michael.uplawski@uplawski.eu>   *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+
+
+$APPNAME='Html2Slideshow'
+
+$VERSION='2.0'
+
+$AUTHOR='Michael Uplawski' 
+$EMAIL = '<michael.uplawski@uplawski.eu>'
+
+$WEB_SITE='https://rubygems.org'
+
+$YEARS='2008 - 2022'
+
+$SYSTEM=`uname -a`
+
+$LICENSE_NAME='GPL-3.0'
+
+$COPYRIGHT=format("Copyright © %s, %s\n\t%s", $YEARS, $AUTHOR, $EMAIL)
+
+$LICENSE="This program is free software; you can redistribute it
+and/or modify it under the terms of the GNU General Public
+License as published by the Free Software Foundation; either
+version 3 of the License, or (at your option) any later
+version.
+This program is distributed in the hope that it will
+be useful, but WITHOUT ANY WARRANTY; without even the implied
+warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU General Public License for more details.  
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the 
+
+Free Software Foundation, Inc., 
+59 Temple Place - Suite 330, 
+Boston, MA
+02111-1307, 
+USA."

data/lib/argparser.rb

@@ -0,0 +1,143 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   Copyright © 2008-2022, Michael Uplawski <michael.uplawski@uplawski.eu>   *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+require_relative 'image'
+require_relative 'translating'
+require_relative 'about'
+require_relative 'logging'
+require_relative 'extstring'
+
+class ArgParser 
+  include Logging
+
+  PREFIX = '/usr/local'
+  SUPPLDIR = "#{PREFIX}/share/#{$APPNAME}"
+
+  CODES = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
+  CODE_ALIASES = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" }
+
+  self::extend(Logging)
+  @@log = self::init_logger()
+ 
+  # Returns a structure describing the options.
+  #
+  def self.parse(args)
+    # The options specified on the command line will be collected in <b>options</b>.
+    # We set default values here.
+    options = OpenStruct.new
+    options.source = './'
+    options.target = './'
+    options.config = SUPPLDIR + File::Separator + 'html2slideshow.cfg'
+    options.debug = false 
+    options.debug_dir = nil
+    options.source_type = 'HTML' # 'files' if not 'HTML'
+    options.recursive = false
+    
+    # can be a space-separated list.
+    options.formats = "jpg"
+
+    op = OptionParser.new do |opts|
+      opts.banner = trl("Usage") << ":\truby #{$APPNAME}.rb [options]\n\t" << trl("or") << " #{$APPNAME} [options]"
+
+      opts.separator ""
+      opts.separator trl("Specific options") << ':'
+
+      opts.on(trl("-f"), '--' << trl("formats") << " [\"" << Image::FORMATS.keys.collect{|f| f.to_s}.join(', ') << "\"]", trl("specify the comma-separated list of image formats,"), trl("which should be used, others will be ignored.") ) do |iforms|
+        
+        options.formats = iforms.split(',').collect do |f| 
+          f.strip!
+          f.downcase!
+          f.delete!('e') if f != 'webp'
+          format = Image::FORMATS[f.to_sym]
+          if !format
+            @log.error('Not a supported image format: ' << f << ". Choose from " << Image::FORMATS.keys.collect{|f| f.to_s}.join(', ')) 
+            @log.error("Aborting. Bye.")
+            exit false
+          end
+          format 
+        end
+        @log.debug('storing formats in options : ' << options.to_s)
+      end
+
+      opts.on(trl("-d"), '--' << trl("debug [true|FALSE]"), trl("Switch on debug-mode."), trl("Will generate log-messages during processing") ) do |deb|
+        options.debug = (deb && deb.chomp.downcase == 'false' ? nil : true)
+        @log.level = Logger::DEBUG if options.debug
+      end
+      opts.on(trl("-l"), '--' << trl("local"), trl("Collect the image-files from the source-directory"), trl("(if not provided, HTML-files are analyzed)") ) do |l|
+        options.source_type = 'files'
+      end
+
+      opts.on(trl("-r"),'--' << trl("recursive"), trl("When collecting image-files from the source-directory,"), trl("also include the sub-directories.")) do |l|
+        options.recursive = true
+      end
+
+      opts.on(trl("-s"), '--' << trl("source SOURCE DIR"), trl("Read HTML source-files from this directory")) do |source|
+        options.source = File.expand_path(source)
+        options.target = options.source
+      end
+      opts.on(trl("-t"), '--' << trl("target [TARGET DIR]"), trl("Write slideshow-files to this sub-directory"), "  " << trl("(if not provided, SOURCE DIR is used)")) do |target|
+        sd = File.expand_path(options.source)
+        sd << File::Separator if (!sd.end_with?(File::Separator) )
+        options.target = sd << target
+      end
+
+=begin
+      opts.on("-c", "--config [CONFIG FILE]",
+              "Read alternative configuration from this file") do |conf|
+        $LOG.debug("config-file should be #{conf}") if $LOG
+        options.config = File.expand_path(conf )
+              end
+      opts.on("-g", "--generic [CONFIG FILE]",
+              "Write generic configuration options to this file") do |file|
+        options.generic = File.expand_path(file )
+              end
+=end
+      opts.separator ""
+      opts.separator trl("Common options") << ':'
+
+      # No argument, shows at tail.  This will print an options summary.
+      # Try it and see!
+      # show help
+      opts.on_tail(trl("-h"), '--' << trl("help"), trl("Show this message")) do
+        puts opts
+        exit
+      end
+
+      # Another typical switch to print the version.
+      opts.on_tail('--' << trl("version"), trl("Show version")) do
+        msg = "\t#{$APPNAME}, " << trl("version") << " #{$VERSION}"
+        msg << "\n\t#{$COPYRIGHT}"
+        msg << "\n\n%50s" %($LICENSE)
+        puts msg.box(:padding => 2, :left => 2, :top => 1)
+        exit
+      end
+    end
+
+    op.parse!(args)
+    options
+  end  # parse()
+
+end  
+

data/lib/completable.rb

@@ -0,0 +1,157 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   Copyright © 2008-2017, Michael Uplawski <michael.uplawski@uplawski.eu>   *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+
+require_relative 'logging'
+# Completable file-objects can treat their
+# contents like a fillable form. Predefined
+# fields are searched and replaced by values. 
+
+module Completable
+
+  include Logging
+  attr_reader :backup, :summary
+
+  # The main function of this module.
+  # Expects as parameters a Hash of field/substituion-
+  # pairs and an optional block.
+  # If a block is given, the original file will
+  # be processed and a backup is created.
+
+  def complete(subst_def, &b) 
+
+    init_logger()
+    @summary = Summary.new(subst_def)
+    @field_count = 0
+    if(self.respond_to?(:gets) )         
+      if(self.respond_to?(:closed?) && !self.closed?)
+        self.rewind
+        if(subst_def && subst_def.respond_to?(:has_key?))
+          cpos = 0
+          if(!b)
+            @backup="#{self.path}_backup"
+            outfile = File.open(@backup, 'w'){|bf| bf.write(self.readlines() )}
+            self.rewind
+          end
+          while(chunk = self.gets())
+            chunk, msg = process(chunk, subst_def)
+            if(!chunk && msg)
+              return nil, msg
+            end
+            if(b)
+              b.call(chunk)
+            else
+              self.seek(cpos, IO::SEEK_SET)
+              self.write(chunk)
+            end
+            cpos = self.pos
+          end
+        else
+          return nil, 'first parameter must be a Hash'
+        end
+      else
+        return nil, 'completable object must at least be open for reading'
+      end
+    else
+      return nil, 'completable object must also respond to :gets'
+    end
+    @field_count
+  end
+
+  # sets the character sequence, which marks
+  # substitutable text 
+  def field_delimiter=(d)
+    @field_delimiter = d
+    @field_regex = Regexp.new("#{d}[^#{d}]*#{d.reverse}")
+  end
+  # returns the character sequence, which marks
+  # substitutable text
+  def field_delimiter()
+    if(!@field_delimiter)
+      field_delimiter=(' ')
+    end
+    @field_delimiter
+  end
+
+  private
+
+  # processes one chunk of text with the given
+  # map of field/substitution pairs
+  def process(chunk, subst_def)
+    if(@field_regex)
+      # rpl = chunk.match(@field_regex)
+      begin
+        fields = chunk.force_encoding("UTF-8").scan(@field_regex)
+      rescue ArgumentError => er
+        @log.error("ERROR: " << er.message);
+        @log.error("chunk is: " << chunk.to_s)
+        @log.error("encoding: " << chunk.encoding().to_s)
+      end
+      fields.each do |rpl|
+        if rpl
+          # offset = rpl.offset(0) if rpl
+          offset = chunk.index(rpl)
+          test_key = rpl.to_s.delete(@field_delimiter) 
+          if(subst_def.has_key?(test_key))
+            @summary.add_found(test_key)
+            value = subst_def[test_key]
+            chunk.gsub!(rpl.to_s, value) if value
+            @field_count += 1
+          end
+        end
+      end
+      chunk
+    else
+      return nil, 'field-delimiter must be set.'
+    end
+  end
+
+  # a class to summarize processing results
+  class Summary
+    attr_accessor :fields_found 
+
+    def fields_missing 
+      if(@fields_found)
+        @fields - @fields_found.keys  
+      else
+        @fields
+      end
+    end
+
+    def initialize(fields)
+      if fields.respond_to?(:keys)
+        @fields = Array.new(fields.keys)
+      elsif fields.respond_to?(:to_ary)
+        @fields = Array.new(fields)
+      else
+        @fields = Array.new()
+      end
+      @fields_found = Hash.new
+    end
+
+    def add_found(field)
+      count = @fields_found[field]
+      count = 0 if !count
+      @fields_found[field] = count + 1
+    end
+  end
+end
+

data/lib/configurator.rb

@@ -0,0 +1,155 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   Copyright © 2008-2022, Michael Uplawski <michael.uplawski@uplawski.eu>   *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+
+RD = File.expand_path(File.dirname(__FILE__) ) + File::Separator if !defined?(RD) 
+require 'date'
+require 'yaml'
+require 'ostruct'
+require_relative 'file_checking'
+require_relative 'logging'
+require 'singleton'
+
+=begin
+This class reads and writes configuration data.
+=end
+class Configurator
+	include  File_Checking
+	include Logging
+
+	# default configuration will be overwritten with
+	# user-defined values.
+	#
+	# There shall be no instance-variables!
+	# 
+	CONFIG = format("%shtml2slideshow.cfg", RD)
+
+	def initialize(opts = nil)
+		init_logger()
+		@configurations = Hash.new
+		init_config(opts) 
+		@log.debug(format("opts are of type %s", opts.class)) if @log
+	end
+
+	def method_missing(method, args = nil)
+		@log.debug("requested value for #{method}: #{@configurations[method]}") if @log
+		if(@configurations.has_key?(method))
+			@configurations[method]
+		else
+			super
+		end
+	end
+
+	# combines the values from the parameter-object and
+	# those, already present in the existing configuration
+	def consolidate_configuration(cfg)
+		if(cfg.respond_to?(:each_key))
+			cfg.each_key {|k| @configurations[k] = cfg[k] if cfg[k]}
+		end
+	end
+
+	def complete_configuration(cfg)
+		if(cfg.respond_to?(:each_key))
+			@configurations.each_key do |k|
+				if(! cfg.has_key?(k) )
+					cfg[k] = @configurations[k]
+				end
+			end
+		end
+		cfg
+	end
+	def save(opts)
+		@log.debug(format("shall write options to config-file", CONFIG)) if @log
+		@configurations = complete_configuration(opts)
+		if(!File.exist?(CONFIG) || !file_check(CONFIG, [:file?, :writable?]))
+			@configurations[:date] = Time.now.to_s
+			@log.debug(format("writing to config-file %s:\n%s", CONFIG, @configurations)) if @log
+			File.open(CONFIG, 'w') {|cfg| YAML::dump(@configurations, cfg)}
+		end
+	end
+
+        # The initial default configuration is merged with program options, or
+        # those from the configuration file.
+	def init_config(opts = nil)
+		if (!@configurations || @configurations.empty?)
+			@configurations =  {
+				:date => Time.now.to_s,
+                                :formats => Image::FORMATS,
+				:target => './',
+				:source => './',
+				:suffix => '_slideshow',
+				:source_type => 'HTML',
+				:recursive => false,
+				:browser => 'firefox',
+				:log => '/tmp/html2slideshow.log',
+				:merge => false,
+				:scale_medium => '500',
+				:scale_small => '300',
+				:title => '',
+			}
+		end
+		if(opts)
+			if opts.respond_to?(:delete_field)
+                            @log.debug('calling read_options')
+				read_options(opts) 
+			elsif opts.respond_to?(:to_hash)
+                            @log.debug('calling read_hashed_options')
+				read_hashed_options(opts)   
+			end
+		else
+			read_from_file
+		end
+		@configurations.freeze
+	end
+	private
+
+	def read_hashed_options(options)
+		@configurations.merge!(options)    
+		@log.debug(format("merged configuration is: %s", @configurations.inspect)) if @log
+	end
+
+	def read_options(options)
+		@log.debug(format("reading options from %s", options.inspect)) if options && @log
+		@log.debug(format("configurations is %s", @configurations.inspect) ) if @log
+                @configurations[:formats] = options.formats if options.formats
+                @configurations[:recursive] = options.recursive if options.recursive
+		@configurations[:source] = options.source if options.source
+		@configurations[:target] = options.target if options.target
+		@configurations[:browser] = options.browser if options.browser
+		@configurations[:scale_small] = options.scale_small if options.scale_small
+		@configurations[:scale_medium] = options.scale_medium if options.scale_medium
+		@log.debug("configuration is #{@configurations.inspect}") if @log
+	end
+
+	def read_from_file
+		if(!file_check(CONFIG, [:exist?, :file?, :readable?]))
+			@configurations.merge!( YAML::load_file(CONFIG))
+			@log = Logger.new(@configurations[:log]) if @configurations[:log]
+			@log.level = Logger::INFO if @log && !@configurations[:debug]
+			@log.debug("configuration from File is #{@configurations.inspect}") if @log
+		end
+	end
+end # end of class definition
+
+class Single_Configurator < Configurator
+	include Singleton
+end # end of class definition
+

data/lib/copyright.txt

@@ -0,0 +1,22 @@
+=begin
+/***************************************************************************
+ *   Copyright ©2008-2017,                                                 * 
+ *   Michael Uplawski <michael.uplawski@uplawski.de>                       *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+

data/lib/extstring.rb

@@ -0,0 +1,75 @@
+#encoding: UTF-8
+
+if(! String.method_defined?(:end_with?))
+  class String
+    def end_with?(str)
+      isso = false;
+      if(str.respond_to?(:to_str) && self.include?(str))
+        isso = (slice(rindex(str), (size()-1)) == str)
+      end
+      return isso
+    end
+  end
+end
+
+class String
+  def box(opt = {})
+    upleft = "\u250F"
+    upright = "\u2513"
+    downleft = "\u2517"
+    downright = "\u251B"
+
+    vert = "\u2503"
+    hor = "\u2501"
+
+    max_width = size[0] - 5
+
+    left = opt[:left]
+    top = opt[:top]
+    padding = opt[:padding]
+    # width = opt[:width]
+
+    size = `stty size`.split.map { |x| x.to_i }.reverse
+
+    left ||= 0
+    top ||= 0
+    padding ||= 0
+    # width ||= max_width
+    # width = max_width if max_width < width
+
+    gsub!("\t", '    ')
+    width = self.split("\n").max {|l1, l2| l1.length <=> l2.length}.length + 2* padding 
+
+
+    box = ''
+    box << "\n" * top
+    # top border
+    box << ' ' * left << upleft.dup << hor.dup * width << upright.dup << "\n"
+    # top padding
+    box << ' ' * left << vert.dup << ' ' * width << vert.dup << "\n"
+    # lines
+    self.split("\n").each do |line|
+      if(line && !line.empty?)
+        nl = ' ' * left << vert.dup << ' ' * padding << line << ' ' * padding
+        # wanted length : width + left margin + width of the first vertical border sign
+        until(nl.length >= ( width + left +1) )
+          nl << ' '
+        end
+        nl << vert.dup << "\n"
+      else
+        nl = ' ' * left << vert.dup << ' ' * width << vert.dup << "\n"
+      end
+      box << nl
+    end
+    # bottom padding
+    box << ' ' * left << vert.dup << ' ' * width << vert.dup << "\n"
+    # bottom border
+    box << ' ' * left << downleft.dup << hor.dup * width << downright.dup
+    return box
+  end
+
+  def box!(opt = {})
+    self.replace(String.new(box(opt)))
+  end
+
+end