html2slideshow 2.0

data/lib/file_checking.rb

@@ -0,0 +1,153 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2011-2021 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 'filemagic'
+
+=begin
+A module to facilitate frequently occuring checks on
+file-system objects
+=end
+module File_Checking
+
+  @@last_mime_type = nil
+
+  @@text_messages  = {
+    :exist? => "does not exist!",
+    :exist => "does not exist!",
+    :readable? => "is not readable!",
+    :readable => "is not readable!",
+    :executable? => "is not executable!",
+    :executable => "is not executable!",
+    :writable? => "is not writable!",
+    :writable => "is not writable!",
+    :directory? => "is not a directory!",
+    :directory => "is not a directory!",
+    :file? => "is not a file!",
+    :file => "is not a file!",
+# different thing
+    :type => "is not of the sought file-type (not '%s', but '%s')!",
+    :mime => "does not have the sought mime-type (not '%s', but '%s')!",
+  }
+
+  def self::last_mime_type
+    @@last_mime_type
+  end
+
+  # Checks if the file with the name from the first
+  # parameter has the properties, listed in the second. 
+  # The messages parameter is an array of one or several
+  # of :exist?, :readable?, :writable?, :directory?  or 
+  # their string-representations, respectively. 
+  # Returns nil in case of success, otherwise an 
+  # informative message, describing the first negative
+  # test-result.
+  def file_check(file, *messages)
+    File_Checking.file_check(file, *messages)
+  end
+
+  # Checks if the file with the name from the first
+  # parameter has the properties, listed in the second. 
+  # The messages parameter is an array of one or all
+  # of :exist?, :readable?, :writable?, :directory? or
+  # their string-representations, respectively. 
+  # Returns nil in case of success, otherwise an 
+  # informative message, describing the first negative
+  # test-result.
+  def self.file_check(file, *messages)
+    if !File.exist?(file)
+      return file.dup << ' ' << ' does not exist!'
+    end
+    msg = nil
+    if(file && messages.respond_to?(:to_ary) && !messages.empty?)
+      messages.each do |k|
+        if( k != :mime && k != :type) 
+          if(! k.to_s.end_with?('?'))	
+            k = (k.to_s << '?').to_sym
+          end
+          @log.debug ('checking ' << k.to_s) if @log
+          if(msg == nil && File.respond_to?(k) && ! File.send(k, file.to_s))
+            msg = "#{file} #{@@text_messages[k.to_sym]}"
+          end
+        end
+      end
+    end
+    msg
+  end
+
+  def self.mime_check(file, mime_type_s)
+    if !File.exist?(file)
+      return file.dup << ' ' << ' does not exist!'
+    end
+
+    fm = FileMagic.mime
+       if (!File.directory?(file) )
+         begin
+           fd = fm.fd(File.new(file) ).split(';')[0]
+         rescue Exception => ex
+           @@last_mime_type = nil
+           return ex.message 
+         end
+         @@last_mime_type = fd
+         # list of mime_types
+         if mime_type_s.respond_to?(:to_ary) 
+           format = mime_type_s.detect {|f| fd == f.strip}
+           if !format
+             return file.dup << ' is of none of the supported mime-types, but ' << fd
+           end
+           # one mime_type only
+         elsif fd != mime_type.strip  
+           return file.dup << ' ' << (@@text_messages[:mime] %[mime_type, fd])
+         end
+       else 
+         @@last_mime_type = "inode/directory"
+         return file.dup << " is a directory!"
+       end
+       return nil
+  end
+
+  def self.magic_check(file, magic)
+    if !File.exist?(file)
+      return file.dup << ' ' << ' does not exist!'
+    end
+    fm = FileMagic.fm
+    fd = fm.fd(File.new(file) ).split(';')[0]
+    if fd != magic.strip  
+      return file.dup << ' ' << (@@text_messages[:type] %[magic, fd])
+    end
+    return nil
+  end
+
+end # module
+
+=begin
+# example
+
+include File_Checking
+msg = file_check('some_file.txt', [:exist?, :readable?, 'writable'])
+# same as 
+# msg = file_check('some_file.txt', [:exist, :readable, 'writable?'])
+
+msg ||= magic_check('some_file.txt', 'OpenDocument Text')
+msg ||= mime_check('some_file.txt', 'application/vnd.oasis.opendocument.text')
+puts msg if msg
+=end
+# E O F

data/lib/html2slideshow.cfg

@@ -0,0 +1,22 @@
+---
+:recursive: true
+:source: "/local_data/Photos/Chez_Fares_Mai_2022/"
+:target: "/local_data/Photos/Chez_Fares_Mai_2022/slide show"
+:image_types:
+- jpg
+- JPG
+- jpeg
+- JPEG
+- WEBP
+- webp
+:source_type: files
+:file_pattern: ".*"
+:merge: false
+:title: Broyage
+:log: "/tmp/test.log"
+:debug: true
+:scale_medium: '800'
+:scale_small: '500'
+:browser: qutebrowser
+:date: '2022-05-22 20:57:10 +0200'
+:suffix:

data/lib/html2slideshow.rb

@@ -0,0 +1,132 @@
+#!/usr/bin/env ruby 
+#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 'argparser'
+require_relative 'sourcefile'
+require_relative 'file_checking'
+require_relative 'htmlbuilder'
+require_relative 'configurator'
+require_relative 'extstring'
+require_relative 'logging'
+require 'singleton'
+
+=begin
+ The SlideShowGenerator class provides the main routine to start 
+ the slideshow-generation.
+ Alternatively a commandline parameter -g or --generic can be
+ used to write a generic configuration file, which can be used
+ to alter the program output in later runs of the generator.
+ See Argparser for details on commandline parameters.
+=end
+class SlideShowGenerator
+  include Singleton
+  
+  self::extend(Logging)
+  @@log = self::init_logger()
+
+  def initialize
+    @log = @@log
+  end
+  
+  # The original console-version works with this method
+  def generate(args)
+    message = nil
+    options = ArgParser.parse(args)
+    @log.level = Logger::INFO  if !options.debug
+    @log.debug('Log-level is ' << @log.level.to_s)
+    
+    @log.debug("options are " + options.to_s) 
+    unless options.generic
+      pwd = Dir.pwd()
+      if(options.source && !options.source.empty?)
+        message = File_Checking.file_check(options.source, [:exist?, :readable?, :writable?, :directory?])
+        if(message)
+          message = sprintf( trl("Source-directory") << ": %s" , message)
+        else
+          Dir.chdir(options.source)
+
+          if('files' == options.source_type)      
+            read_dir(options)
+          else
+            read_html(options)
+          end
+          Dir.chdir(pwd)
+        end
+      else
+        message = trl('No source-directory given!')
+      end
+    else
+      message = Configurator.write_configuration(options.generic)
+    end
+    message if message
+  end
+
+  # read from DIR
+  def read_dir(options) 
+    @log.debug('reading files from souce-directory') 
+    if(!options.formats || options.formats.empty?)
+      options.formats = %w[jpg JPG jpeg JPEG webp]
+      @log.debug("no image types chosen, looking for JPEGs and WebP") 
+    end
+    @log.debug('working on directory ' + Dir.pwd) 
+    source = SourceFile.new(Dir.pwd, options)
+    HtmlBuilder.new(source, options)
+  end
+
+  # read from html
+  def read_html(options) 
+    @log.debug('reading references from html') 
+    htmlfiles = Dir.glob("{*.htm,*.html}") 
+    if(htmlfiles && !htmlfiles.empty?)
+      htmlfiles.each do |sf|
+        @log.debug('working on file ' + sf) 
+        source = SourceFile.new(sf, options)
+        HtmlBuilder.new(source, options)
+      end
+    else 
+      @log.error("NO source-files in %s! Check source-directory!" %options.source)
+    end
+  end
+  #
+  # main routine.
+  def run()
+
+    message = generate(ARGV)
+    if message
+      @log.error message
+      @log.debug('returning nil') 
+      nil
+    else 
+      msg = trl('DONE')
+      puts "-" * msg.length << "\n" << msg
+      @log.debug('returning true') 
+      true
+    end
+  end
+end
+
+if __FILE__ == $0
+  SlideShowGenerator.instance().run() 
+end
+

data/lib/htmlbuilder.rb

@@ -0,0 +1,267 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   Copyright © 2008-2012, 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_relative 'sourcefile'
+require_relative 'file_checking'
+require_relative 'slideshow_template'
+require_relative 'slideshow_css'
+require_relative 'slideshow_js'
+require 'yaml'
+require 'date'
+require_relative 'completable'
+require 'fileutils'
+require_relative 'configurator'
+require_relative 'logging'
+
+FS = File::Separator
+
+=begin
+  This class writes the final slide-show
+  pages.
+=end
+class HtmlBuilder
+  self::extend(Logging)
+  @@log = init_logger
+  @@count_tag = "<span id=\"lastImage\" style=\"display:none\">"
+  @@span_close = "</span>"
+
+  include File_Checking 
+
+  def initialize(sourcefile, options)
+    @log = @@log
+    @log.debug(format("source: %s", sourcefile.to_s)) 
+    @log.debug(format("options: %s", options.to_s)) 
+    @configurator = Configurator.new(options)
+    @source = sourcefile
+    @target_dir = nil
+    @substitutions = { 
+      'title'         => @source.title,
+      'javaScript'     => 'slideshow.js',
+      'css'           => 'slideshow.css',
+      'NoJsUrl'       => 'index.html',
+      'NoJsTitle'     => trl('Back to the welcome page'), 
+      'NoJsName'      => trl('welcome page'),
+      'heading1'      => @source.title,
+      'nullImageUrl'  => 'images/olive.png',
+      'pxMedium'      => format("%spx", @configurator.scale_medium || '500'),
+      'pxSmall'       => format("%spx", @configurator.scale_small || '300'), 
+      'ImgReferences' => format_references
+    } 
+   
+    @log.debug(format("substitutions are %s", @substitutions)) 
+    msg = create_slideshow if @substitutions['ImgReferences']
+    @log.debug(msg) if msg
+  end
+
+  private 
+
+  def format_references()
+    images = @source.images
+    size = images.size
+    refs = images.collect {|im| im.reference}
+    references = nil
+
+    if(size > 1)
+      @log.debug('configurator sais target = ' << @configurator.target)
+      sd = @configurator.target.sub(@configurator.source, '').strip()
+      references = @@count_tag + size.to_s + @@span_close
+      if @configurator.target != "./"
+        dpfx = '../' 
+      end
+      images.each_with_index do |image, index|
+        image_url = nil
+        references += "<span style=\"display:none;\" id=\"image#{index}\"" 
+        if(@source.title)
+          references << " title=\"" << @source.title << "\">"
+        else
+          references << ">"
+        end
+        references << format("%s%s", dpfx, image.reference) << @@span_close 
+      end
+    end
+    references
+  end
+
+  def create_slideshow()
+    template_file, msg = template() 
+    @log.debug("template_file is #{template_file}") 
+    if(!msg)
+      slideshow_file, msg = target_file()
+      if(!msg)
+        @log.debug("writing slide-show to #{slideshow_file}") 
+        File.delete(slideshow_file) if File.exist?(slideshow_file)
+        File.open(slideshow_file, 'w') do |slf|
+          File.open(template_file, 'r') do |tpf| 
+            tpf.extend(Completable)
+            tpf.field_delimiter = "%-"
+            fc, msg = tpf.complete(@substitutions) do |chunk|  
+              slf << chunk
+            end
+            @log.debug("field-count is #{fc}") 
+            msg = "Success: replaced #{fc} fields." if (fc && fc > 0)
+            summary = tpf.summary
+            msg += "\nfound: #{summary.fields_found.inspect}"
+            msg += "\nmissed: #{summary.fields_missing.join(', ')}"
+          end
+        end
+        msg = put_js
+        msg = put_css if !msg
+        msg = put_icons if !msg
+      else
+        msg = "Cannot write slideshow to #{slideshow_file} (#{msg.to_s})"
+      end
+    else
+      msg = "Cannot create template-file (#{msg.to_s})"
+    end
+    return msg
+  end
+
+  def put_icons
+    tdir, msg = target_dir
+    if(!msg)
+      icons_dir = tdir + FS + 'images'
+      Dir.mkdir(icons_dir) if (!File.exist?(icons_dir))
+      icons_source = RD + FS + 'slideshow_images' + FS
+      icons = Dir.new(icons_source).collect{|i| (icons_source + i) if( i.end_with?('.png'))}.compact!
+      FileUtils.cp(icons, icons_dir) 
+      @log.debug("copied icons into #{icons_dir}") 
+    else
+      return msg
+    end
+  end
+
+
+  def put_css
+    tdir, msg = target_dir
+    if(!msg)
+      css_file = tdir + File::Separator + 'slideshow.css'
+      if(!File.exist?(css_file))
+        css_dir = File.dirname(css_file)
+        Dir.mkdir(css_dir) if (!File.exist?(css_dir))
+        msg = file_check(css_dir, [:exist?, :writable?, :directory?])
+        if(!msg)
+          File.open(css_file, File::CREAT|File::WRONLY) do |slf|
+            slf.write($SLIDESHOW_CSS)
+            @log.debug("wrote css-file to #{css_file}") 
+          end
+        else
+          return msg
+        end
+      end
+      return nil
+    else
+      return msg
+    end
+  end
+
+  def put_js
+    tdir, msg = target_dir
+    if(!msg)
+      js_file = tdir + File::Separator + 'slideshow.js'
+      if(!File.exist?(js_file))
+        js_dir = File.dirname(js_file)
+        Dir.mkdir(js_dir) if (!File.exist?(js_dir))
+        msg = file_check(js_dir, [:exist?, :writable?, :directory?])
+        if(!msg)
+          File.open(js_file, File::CREAT|File::WRONLY) do |slf|
+            slf.write($JAVASCRIPT)
+            @log.debug("wrote js-file to #{js_file}") 
+          end
+        else
+          return msg
+        end
+      end
+      return nil
+    else
+      return msg
+    end
+  end
+
+  def template
+    msg = nil
+    template_file = nil
+    tdir, msg = target_dir
+    if(!msg)
+      template_file = tdir + File::Separator + 'template.html'
+      if(!File.exist?('template_file'))
+        template_dir = File.dirname(template_file)
+        Dir.mkdir(template_dir) if (!File.exist?(template_dir))
+        msg = file_check(template_dir, [:exist?, :writable?, :directory?])
+        if(!msg)
+          # avoid trailing garbage when overwriting old templates
+          File.delete(template_file) if File.exist?(template_file)
+          File.open(template_file, File::CREAT|File::WRONLY) do |slf|
+            slf.write($TEMPLATE)
+            @log.debug("wrote template-file to #{template_file}") 
+          end
+        end
+      else
+        @log.debug('template is already available') 
+      end
+    end
+    return template_file, msg
+  end
+
+  def target_dir
+    return @target_dir if @target_dir
+    path = @configurator.target
+    Dir.mkdir(path) if(!File.exist?(path)) 
+    msg = file_check(path, [:exist?, :writable?, :directory?])
+    if(!msg)
+      @target_dir = String.new(path)
+      @target_dir.freeze
+      @log.debug("target dir is #{@target_dir}") 
+      return path, nil
+    else
+      return nil, msg
+    end
+  end
+
+  def target_file
+    td, msg = target_dir
+    @log.debug('writing file to ' + target_dir) 
+    @log.debug(format("title from configuration: %s", @configurator.title)) 
+    path = ''
+    if(!msg)
+      tf = ''
+      if(@configurator.title && !@configurator.title.empty?)
+        tf = @configurator.title.strip
+        @log.debug('tf ex configurator.title: ' + tf) 
+      elsif(@source.title)
+        tf = @source.title.gsub('/', '-')
+        @log.debug('tf ex source.title: ' + tf) 
+      else
+        tf = @source.file_name.strip
+        tf << @configurator.suffix 
+        @log.debug('tf ex source.file_name: ' + tf) 
+      end
+      path << td.strip << FS << tf
+      path << @source.file_ext
+      @log.debug("\tfile is " + path) 
+      return path, nil
+    else
+      return nil, msg
+    end
+  end
+end

data/lib/image.rb

@@ -0,0 +1,62 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   Copyright © 2008-2012, 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 'file_checking'
+require_relative 'logging'
+
+=begin
+  An object of this class represents 1 picture file.
+=end
+class Image
+  extend Logging  
+
+  @@log = init_logger(STDOUT)
+
+  attr_reader :reference
+
+  # string representations of supported image formats
+  FORMATS = { :jpg  => 'image/jpeg',
+              :webp => 'image/webp',
+              :png  => 'image/png',
+              :gif  => 'image/gif',
+              :svg  => 'image/svg'}
+  
+
+  def self::supported?(image, formats)
+    @log.debug('formats is ' << formats.to_s)
+    msg = File_Checking::mime_check(image, FORMATS.values) 
+    @@log.info(image.dup << ' ' << trl("is not supported, wrong mime-type") << ': ' << File_Checking.last_mime_type.to_s) if msg
+    if !msg
+      if !formats.include?(File_Checking.last_mime_type)
+        msg = image.dup << ' ' << trl("is not in one of the requested file types") << ' (' << formats.join(', ') << ')'
+        @@log.info(msg)     
+      end
+    end
+    return msg
+  end
+
+  def initialize(path_url)  
+    @log = @@log
+    @reference = path_url
+
+    @log.debug('new Image instance : ' << @reference)
+  end
+end

data/lib/list_fields.rb

@@ -0,0 +1,34 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   Copyright © 2008-2012, 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
+
+# Unused in the html2slideshow program. This will just
+# create a list of fields, recognized by a certain delimeter
+# (here: %-   -%).
+
+File.open('slideshow_template.rb', 'r') do |tp|
+  File.open('/tmp/listFields.txt', 'w') do |list|
+    while tp.gets('-%') 
+      m = $_.match("%-(.*)-%")
+      list.puts( m[0]) if m
+    end
+  end
+end