html2slideshow 2.0

data/lib/sourcefile.rb

@@ -0,0 +1,191 @@
+#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 'extstring.rb'
+require_relative 'image.rb'
+require_relative 'file_checking'
+require_relative 'logging'
+
+=begin 
+  SourceFile defines objects, which represent the original html-files,
+  to be processed by the slideshow-generator. Each SourceFile-object will 
+  provide a few details about the contents and location of 1 such file.
+=end
+
+class SourceFile 
+  self::extend(Logging)
+  @@log = self::init_logger
+
+  attr_reader :images, :dirname, :img_count, :title, :file_name, :file_ext
+
+  def initialize(path, options)
+    @log = @@log
+    @log.debug(format("initializing SourceFile for %s ", path)) if @log
+    @log.debug('options are ' << options.to_s)
+
+    @path = path
+    @formats = options.formats
+
+    # file extension
+    local = 'files' == options.source_type 
+    @file_ext = ((local || options.merge) ? '.html' : File.extname(@path))
+
+    # file name without path or extension
+    @file_name = File.basename(@path.gsub("\\", '/'), @file_ext)
+
+    # directory where the original html-file is found 
+    @dirname = File.dirname(@path)
+
+    # All references to image-files, found in the file
+    @images = Array.new 
+
+    # number of images, found 
+    @img_count = 0
+
+    # title of the original page
+    # or the final slide show file
+    @title = nil
+    @title = options.title if options.title && !options.title.empty?
+
+    @title.strip! if @title
+
+    # scan sub-directories (local image-files, only)
+    @recursive = options.recursive
+    @log.debug("recursive ? " << @recursive.to_s)
+    @log.debug(format("files from %s", (local ? 'directory' : 'html')) ) if @log
+    # read pages or files, analyze, set image-references and title
+    if(local)
+      read_dir
+    elsif(options.merge)
+      read_files
+    else
+      read_file
+    end
+    @log.debug("sourcefile initialized: " + @path) if @log
+  end
+
+  private
+
+  def read_files(p = @path)
+    dir_msg = File_Checking.file_check(p, [:exist?, :directory?, :readable?])
+    if (!dir_msg)
+      @title ||= File.basename(@path).strip
+      Dir.open(p) do |dir|
+        dir.each do |file|
+          @log.debug("testing #{file}") if @log
+          if(file.index('.') != 0 && file.downcase.end_with?('html') )
+            file = format("%s%s%s", p, File::Separator, file)
+            if (!File_Checking.file_check(file, [:file?, :readable?]))
+              read_file(file)
+            end
+          end
+        end
+      end
+    else
+      @log.error(msg) if msg && @log
+    end
+  end
+
+  def read_dir(p = @path, dir_path = nil)
+    @log.debug(format("read_dir: %s ", p)) if @log
+    Dir.open(p) do |dir|
+      @log.debug('dir is ' << dir.path)
+      dir.each do |file_name|
+        path = File.expand_path(file_name, dir_path)
+        @log.debug('file_name ' << file_name << ', path is ' << path) if @log
+        msg = File_Checking.file_check(path, [:exist?, :file?, :readable?])
+        if(!msg)
+          msg ||= Image::supported?(path, @formats)
+          if(!msg)
+            img = Image.new(file_name)
+            images.push(img)
+          end
+        end
+        if(@recursive) 
+          msg = File_Checking.file_check(file_name, :exist?, :directory?, :readable?) 
+          if(!msg && file_name && file_name != '.' && file_name != '..' )
+            @log.debug('recursively checking sub-directories')
+            @log.debug('decending into ' << path)
+            read_dir( path, p)
+          end # check if directory
+        end
+      end # all in path 'p'
+    end # Dir.open
+    @title ||= File.basename(@path) if !@images.empty?
+    @title.strip! if @title 
+    @log.debug("found #{@images.size} images: " << @images.collect {|im| im.reference}.join(', ')) if @log
+  end
+
+  def read_file(f = @path)
+    @log.debug(format("working on file %s", f)) if @log
+    File.open(f, 'r') do |fp|
+      # order matters!
+      set_title(fp) if !@title
+      register_images(fp)
+    end
+    @img_count = @images.size
+  end
+
+  def set_title(fp)
+    otag = "<title.*"
+    ctag = "</title>"
+    while(!@title && fp.gets('>'))
+      ttag = $_.match(otag)
+      ttext = fp.gets(ctag) if ttag
+      @title = ttext[0, ttext.rindex(ctag)] if ttext
+    end
+  end
+
+  def register_images(fp)
+    while(fp.gets('>'))
+      url = $_.match("<a.*\n?.*\n?.*")
+      img = nil
+      if(url)
+        url = url.to_s
+        @log.debug(format("testing link %s", url)) if @log
+        @extensions = Image::FORMATS.keys.collect{|f| f.to_s}
+        @extensions.each do |ex|
+          img = url.to_s.match(/[\w\/]*.#{ex}/)
+          img = img.to_s.delete("\"") if img
+          @log.debug("testing image, result: #{img}") if img && @log
+          if(img && img.size > 0)
+           # img = dir.dup << img
+            image = Image.new(img)
+            @log.debug("result: #{image.to_s}") if image && @log
+           
+            @images.push(image )
+            break
+          end
+        end
+      end
+    end
+    @log.debug(format("found %d references", @images.size))  if @log
+    @images.uniq!()
+    @log.debug(format("after uniq: %d", @images.size))  if @log
+
+  end
+end
+#---------------------------

data/lib/translating.rb

@@ -0,0 +1,90 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2011-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
+
+
+RD = File.expand_path(File.dirname(__FILE__) ) +  File::SEPARATOR if !defined?(RD)
+
+require 'yaml'
+require_relative 'file_checking'
+
+
+# A way to produce translated text in a ruby-program.
+# Translations are read from a file "translations" in the program folder.
+module Translating
+  # There are better ways to extend a translated 
+  # string, but I keep the 'wild-card' for 
+  # historical reasons.
+  # TODO: GET RID OF THIS CRAP
+  @@awild = 'XX'
+
+  @@lang = nil 
+  @@lang_file = format("%s%s", RD, 'LANG')  
+  @@tr = YAML::load_file("#{RD}translations")
+
+  # find the current language-setting and return it.
+  def self.language()
+    if @@lang == nil
+      r = ENV['LANG']
+      if(r)
+        @@lang = r[0, 2]
+      elsif( !File_Checking::file_check(@@lang_file, [:exist?, :readable?]) && File::size(@@lang_file) >= 2)
+        File::open(@@lang_file, 'r') {|f| @@lang = f.readline}
+        @@lang.chomp!.downcase! if @@lang
+      end
+    end
+    @@lang = 'en' if !@@lang
+  end
+
+  # Translate a string to the currently set langage.  The args parameter may
+  # contain replacement-text which will appear at the positions indicated by
+  # wildcard-characters in the original string (DARN).
+  # This is for historical reasons. The format() function is much better suited
+  # to extend plaintext messages.
+  def self.trl(t, *args)
+    Translating::language()
+    lt = @@tr[t]
+    if(lt)
+      lt = lt[@@lang]
+    else
+      # File.open('/tmp/mtf', 'a+') {|f| f << t << "\n"}
+      puts "\nTRANSLATION MISSING: \"" << t << "\""
+    end
+    lt ||= t
+    if(args && !args.empty?)
+      i = -1 
+      lt = lt.gsub(@@awild) do |a| 
+        i += 1
+        args.flatten[i]
+      end
+      lt += args[i + 1, args.length].join
+    end
+    return lt
+  end
+
+  # Translate a string to the currently set langage. 
+  # The args parameter may contain replacement-text which 
+  # will appear at the positions indicated by wildcard-characters
+  # in the original string.
+  def trl(t, *args )
+    Translating::trl(t, args)
+  end
+end

data/lib/translations

@@ -0,0 +1,354 @@
+ERROR:
+  de: FEHLER
+  fr: ERREUR
+
+Source-directory:
+  de: Quellverzeichnis
+  fr: Dosssier source
+
+No source-directory given.:
+  de: Kein HTML-Quellverzeichnis angegeben.
+  fr: Veuillez indiquer le dossier sources HTML.
+
+is not supported, wrong mime-type:
+  de: wird nicht unterstützt, verkehrter Mime-Type
+  fr: Le Mime-Type n'est pas supporté
+
+DONE:
+  fr: Terminé
+  de: Fertig
+
+sec:
+  fr: sec
+  de: sek
+
+Start:
+  fr: Start
+  de: Start
+
+Image:
+  fr: Image
+  de: Bild
+
+Specific options:
+  fr: Options spécifiques
+  de: Spezielle Optionen
+
+-d:
+  fr: -d
+  de: -d
+
+debug [true|FALSE]:
+  fr: --debug[true|FALSE]
+  de: --debug[true|FALSE]
+
+Switch on debug-mode.:
+  fr: Activer le protocole.
+  de: Debug-Modus aktivieren.
+
+Will generate log-messages during processing:
+  fr: Le logiciel va afficher des messages pendant l'exécution
+  de: Während der Verarbeitung werden Protokollmeldungen ausgegeben
+
+-f:
+  fr: -f
+  de: -f
+
+formats: 
+  fr: formats
+  de: Formate
+
+specify the comma-separated list of image formats,:
+  fr: indiquez une liste de formats, séparés par comma,
+  de: Geben Sie eine komma-separierte Liste von Bildformaten an,
+
+which should be used, others will be ignored.:
+  fr: qui doivent être utilisés. D'autres sont ignorés.
+  de: die benutzt werden sollen; andere werden ignoriert.
+
+-l:
+  fr: -l
+  de: -l 
+
+local:
+  fr: local
+  de: lokal
+
+
+Collect the image-files from the source-directory:
+  fr: Les images sont des fichiers dans le répertoire de source
+  de: Verwende die Bilddateien aus dem Quellverzeichnis
+
+(if not provided, HTML-files are analyzed):
+  fr: (sinon, des fichiers HTML sont analysés)
+  de: (anderenfalls werden HTML-Dateien analysiert)
+
+-r:
+  fr: -r
+  de: -r
+
+recursive:
+  fr: récursif
+  de: rekursiv
+
+When collecting image-files from the source-directory,:
+  fr: Si les images sont trouvés dans le répertoire de source,
+  de: Wenn die Bilddateien im Quellverszeichnis liegen,
+
+also include the sub-directories.:
+  fr: traverse aussi les sous-répertoires
+  de: lies auch die Unterverzeichnisse
+
+Usage:	
+  fr: Syntaxe
+  de: Aufrufsyntax
+
+or:
+  fr: ou
+  de: oder
+
+-s:
+  fr: -s
+  de: -q
+
+source SOURCE DIR:
+  fr: source RÉPERTOIRE SOURCE
+  de: quelle QUELLVERZEICHNIS
+
+Read HTML source-files from this directory:
+  fr: Lis les fichiers HTML dans le répertoire de source
+  de: Lies die HTML-Dateien im Quellverzechnis
+
+-t:
+  fr: -p
+  de: -z
+
+target [TARGET DIR]:
+  fr: projet [Répertoire du Diaporama]
+  de: ziel [Zielverzeichnis] 
+
+Write slideshow-files to this sub-directory:
+  fr: sauvegarde les diaporamas dans ce sous-répertoire
+  de: Schreibe die Diashow-Dateien in dieses Unterverzeichnis
+
+(if not provided, SOURCE DIR is used):
+  fr: (sinon, le répertoire de source est utilisé)
+  de: (anderenfalls wird das Quellverzeichnis verwendet)
+
+Common options:
+  fr: Options généraux
+  de: Allgemeine Optionen
+
+-h:
+  fr: -a
+  de: -h
+
+help:
+  fr: aide
+  de: Hilfe
+
+Show this message:
+  fr: Afficher ce message
+  de: Diese Meldung anzeigen
+
+version:
+  fr: version
+  de: Version
+
+Show version:
+  fr: Affiche version
+  de: Version anzeigen
+
+# Tooltips
+########################################
+Path to the source-files:
+  de: Pfad zu den Quelldateien
+  fr: Chemin des fichiers sources
+
+Include sub-directories in the search for images:
+  de: Unterverzeichnisse bei der Suche nach Bildern einschließen
+  fr: Chercher des images aussi dans les sous-dossiers
+
+Choose a source-directory:
+  de: Ein Quellverzeichnis wählen
+  fr: Choisir le dossier des sources
+
+Start generating the slide show(s):
+  de: Diashow(s) generieren
+  fr: Demarrer la création des diaporamas
+
+Quit Html2Slideshow:
+  de: Html2Slideshow beenden
+  fr: Quitter Html2Slideshow
+
+About Html2Slideshow:
+  de: Über Html2Slideshow
+  fr: A propos de Html2Slideshow
+
+Path to the generated slide show(s):
+  de: Pfad zu den generierten Diashows
+  fr: Chemin du dossier pour le(s) diaporama(s)
+
+Back to the general options:
+  de: Zurück zu den allgemeinen Einstellungen
+  fr: Retour à la configuration principale
+
+Path and name of the log-file:
+  de: Pfad und name der Log-Datei
+  fr: Chemin et nom du fichier de protocole
+
+Toggle to write or stop writing to the log-file:
+  de: Schreiben der Protokolldatein ein- und ausschalten
+  fr: Activer ou déactiver la création du protocole
+
+Activate image-formats to include in the slide show:
+  de: Bildformate auswählen, die berücksichtigt werden sollen
+  fr: Choisissez les formats graphiques à inclure dans les diaporamas
+
+Use the image-files, found in the source-folder:
+  de: Bilddateien direkt dem Quellverzeichnis entnehmen
+  fr: Les fichiers graphiques sont lus directement du dossiers des sources
+
+Use the images, which are linked in HTML-files:
+  de: Bildverweise aus HTML-Dateien verwenden
+  fr: Les chemins des images sont extraits des fichiers HTML
+
+file-names should match this regular expression:
+  de: Dateinamen der Bilder sollen diesem regulären Ausdruck entsprechen
+  fr: Expression regulaire pour filtrer les noms des fichiers
+
+Create only one slide show file from several HTML source-files:
+  de: Nur eine Diashow-Datei aus mehreren HTML Quelldateien
+  fr: Tous les fichiers HTML seront fusionnés dans un seul diaporama
+
+Title of the slide show file:
+  de: Titel der Diashow
+  fr: Titre du diaporama
+
+# Special characters needed for the surface!
+# JavaScript needs the escape-sequences
+####################################### 
+You have reached the last picture:
+  de: Sie haben das letzte Bild erreicht.
+  fr: Vous %EAtes arriv%E9 %E0 la derni%E8re image
+
+You have reached the first picture:
+  de: Sie haben das erste Bild erreicht.
+  fr: Vous %EAtes arriv%E9 %E0 la premi%E8re image
+
+Image:
+  de: Bild
+  fr: Image
+
+Continue slideshow:
+  de: Diashow fortsetzen
+  fr: Continuer le diaporama
+
+Stop the automatic slideshow:
+  de: Automatische Diashow anhalten
+  fr: Arr%EAter le diaporama automatique
+
+In the Internet-Explorer, the slideshow may suffer from display-errors.:
+  de: Im Internet-Explorer kommt es leider zu Darstellungsfehlern.
+  fr: Avec Internet-Explorer, la pr%E9sentation du diaporama peut %EAtre pertub%E9.
+
+Please switch to a standard-complient browser until these issues are solved.:
+  de: Bitte weichen Sie auf einen standard-konformen Browser aus, bis diese Fehler beseitigt sind.
+  fr: Veuillez-utiliser un autre logiciel en attendant la correction de ces erreurs.
+
+# Special characters needed for the surface!
+# HTML needs HTML-entities. 
+####################################### 
+
+This page will only work, when your browser is configured to use JavaScript.:
+  de: Diese Seite funktioniert leider nur, wenn JavaScript in Ihrem Browser aktiviert ist.
+  fr: Cette page va fonctionner seulement si votre Browser est configuré pour executer JavaScript.
+
+Click the back-button to return to the previous page or go directly to the:
+  de: Klicken Sie den Zurück-Button, um zur vorigen Seite zu gelangen, oder öffenen Sie direkt die 
+  fr: Clickez sur le bouton "retour" pour revenir à la page précédente ou allez directement à la 
+
+Back to the welcome page:
+  de: Zurück zur Startseite
+  fr: Retour à la page de d'acceuil
+
+welcome page: 
+  de: Startseite
+  fr: page d'acceuil
+
+toggle controls:
+  de: Steuerelemente ein- oder ausblenden
+  fr: afficher/masquer la colonne de commandes 
+
+start (again) automatic slideshow:
+  de: automatische Diashow (neu) starten
+  fr: démarrer (de nouveau) le diaporama automatique
+
+Run:
+  de: Start
+  fr: Démarrer
+
+stop the automatic slideshow:
+  de: automatische Diashow stoppen
+  fr: arrêter le diaporama automatique
+
+Stop:
+  de: Stopp
+  fr: Stop
+
+pause the automatic slideshow:
+  de: automatische Diashow anhalten
+  fr: pause
+
+Pause:
+  de: Pause
+  fr: Pause
+
+forward after:
+  de: weiter nach
+  fr: délai 
+
+sec.:
+  de: Sek.
+  fr: sec.
+
+time span for each picture:
+  de: Anzeigedauer für jedes Bild
+  fr: durée d'affichage pour chaque image
+
+more time:
+  de: mehr Zeit
+  fr: plus de temps
+
+less time:
+  de: weniger Zeit
+  fr: moins de temps
+
+next/previous:
+  de: vor/zurück
+  fr: avance/retour
+
+previous picture (please allow time for loading):
+  de: voriges Bild (bitte Ladezeit abwarten)
+  fr: image précédante (l'affichage de l'image peut prendre quelques secondes)
+
+scale to normal size:
+  de: Bild in Originalgröße
+  fr: Image en taille originale
+
+scale to alternative large size:
+  de: Bild auf alternativen, großen Maßstab dimensionieren
+  fr: Dimensionner à la grande échelle alternative
+
+scale to alternative small size:
+  de: Bild auf alternativen, kleinen Maßstab dimensionieren
+  fr: Dimensionner à la petite échelle alternative
+
+next picture (please allow time for loading):
+  de: nächstes Bild (bitte Ladezeit abwarten)
+  fr: prochaine image (l'affichage de l'image peut prendre quelques secondes)
+
+Please allow for longer loading-times during the very first cycle.:
+  de: Beim allerersten Durchlauf längere Ladezeiten abwarten.
+  fr: Pendant le premier passage, prévoyez plus de temps pour le chargement des images
+