webgen 0.3.6 → 0.3.7

data/lib/webgen/plugins/menustyles/horizontal.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: horizontal.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: horizontal.rb 348 2005-09-02 08:43:33Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'webgen/plugins/menustyles/defaultmenustyle'
+require 'webgen/plugins/menustyles/default'
 
 module MenuStyles
 

data/lib/webgen/plugins/menustyles/horizontal_dropdown.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: horizontal_dropdown.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: horizontal_dropdown.rb 348 2005-09-02 08:43:33Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'webgen/plugins/menustyles/defaultmenustyle'
+require 'webgen/plugins/menustyles/default'
 
 module MenuStyles
 

data/lib/webgen/plugins/menustyles/partial.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: partial.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: partial.rb 348 2005-09-02 08:43:33Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'webgen/plugins/menustyles/defaultmenustyle'
+require 'webgen/plugins/menustyles/default'
 
 module MenuStyles
 

data/lib/webgen/plugins/menustyles/vertical.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: vertical.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: vertical.rb 348 2005-09-02 08:43:33Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'webgen/plugins/menustyles/defaultmenustyle'
+require 'webgen/plugins/menustyles/default'
 
 module MenuStyles
 

data/lib/webgen/plugins/menustyles/vertical_dropdown.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: vertical_dropdown.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: vertical_dropdown.rb 348 2005-09-02 08:43:33Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'webgen/plugins/menustyles/defaultmenustyle'
+require 'webgen/plugins/menustyles/default'
 
 module MenuStyles
 

data/lib/webgen/plugins/miscplugins/smileyreplacer.rb

@@ -0,0 +1,84 @@
+#
+#--
+#
+# $Id: smileyreplacer.rb 350 2005-09-02 09:44:23Z thomas $
+#
+# webgen: template based static website generator
+# Copyright (C) 2004 Thomas Leitner
+#
+# 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 2 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
+#
+#++
+#
+
+require 'webgen/plugins/filehandlers/filehandler'
+require 'webgen/plugins/coreplugins/resourcemanager'
+
+module MiscPlugins
+
+  class SmileyReplacer < Webgen::Plugin
+
+    summary "Replaces smiley characters with actual smileys"
+    depends_on 'FileHandler', 'ResourceManager'
+
+    add_param 'emoticonPack', nil, 'The name of the emoticon package which should be used. If set to nil, ' \
+    'smileys are not replaced.'
+
+    used_meta_info 'emoticonPack'
+
+    SMILEY_MAP = {
+      ':-@' => 'angry',
+      '8-)' => 'cool',
+      ':\'-(' => 'cry',
+      ':*)' => 'drunk',
+      ':-D' => 'lol',
+      ':-O' => 'oops',
+      ':-(' => 'sad',
+      '|-I' => 'sleep',
+      ':-)' => 'smile',
+      ':-P' => 'tongue',
+      ';-)' => 'wink'
+    }
+    SMILEY_REGEXP = Regexp.union( *SMILEY_MAP.keys.collect {|t| /#{Regexp.escape(t)}/ } )
+
+    def initialize
+      Webgen::Plugin['PageFileHandler'].add_msg_listener( :AFTER_CONTENT_RENDERED, method( :replace_smileys ) )
+    end
+
+    #######
+    private
+    #######
+
+    def replace_smileys( content, node )
+      pack = smiley_pack( node )
+      return if pack.nil?
+
+      logger.info { "Replacing smileys in file <#{node.recursive_value('dest')}>..." }
+      content.gsub!( SMILEY_REGEXP ) do |match|
+        logger.info { "Found smiley #{match}, trying to replace it with emoticon..." }
+        if res = Webgen::Plugin['ResourceManager'].get_resource( "webgen-emoticons-#{pack}-#{SMILEY_MAP[match]}" )
+          res.referenced!
+          "<img src=\"#{res.relpath_from_node( node )}\" alt=\"smiley #{match}\" />"
+        else
+          logger.warn { "Could not replace smiley '#{match}'(#{SMILEY_MAP[match]}) in <#{node.recursive_value('src')}>: resource not found!" }
+          match
+        end
+      end
+    end
+
+    def smiley_pack( node )
+      node.metainfo.has_key?( 'emoticonPack' ) && node['emoticonPack'].nil? ? nil : node['emoticonPack'] || get_param( 'emoticonPack' )
+    end
+
+  end
+
+end

data/lib/webgen/plugins/{treewalker.rb → miscplugins/treewalker.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: treewalker.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: treewalker.rb 348 2005-09-02 08:43:33Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner

data/lib/webgen/plugins/tags/{navbar.rb → breadcrumbtrail.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: navbar.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: breadcrumbtrail.rb 355 2005-09-05 18:04:17Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -24,7 +24,7 @@ require 'webgen/plugins/tags/tags'
 
 module Tags
 
-  # Generates a navigation bar. A navigation bar consists of all pages in the hierarchy of the
+  # Generates a breadcrumb trail. It consists of all pages in the hierarchy of the
   # current page.
   #
   # For example, assuming we have the following branch
@@ -32,16 +32,12 @@ module Tags
   # this plugin will generate something like this:
   #   root / directory1 / directory2 / currentFile
   # where each listed name is linked to the corresponding file.
-  class NavbarTag < DefaultTag
+  class BreadcrumbTrailTag < DefaultTag
 
     summary 'Shows the hierarchy of current page'
     add_param 'separator', ' / ', 'Separates the hierachy entries from each other.'
-    depends_on 'Tags'
 
-    def initialize
-      super
-      register_tag( 'navbar' )
-    end
+    tag 'breadcrumbTrail'
 
     def process_tag( tag, srcNode, refNode )
       out = []
@@ -53,7 +49,7 @@ module Tags
       end
 
       out = out.reverse.join( get_param( 'separator' ) )
-      self.logger.debug { "Navbar for #{srcNode.recursive_value( 'src' )}: #{out}" }
+      self.logger.debug { "Breadcrumb trail for <#{srcNode.recursive_value( 'src' )}>: #{out}" }
       out
     end
 

data/lib/webgen/plugins/tags/date.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: date.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: date.rb 324 2005-07-04 12:54:25Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -30,12 +30,8 @@ module Tags
 
     summary "Prints out the date"
     add_param 'format', '%A, %B %d %H:%M:%S %Z %Y', 'The format of the date (same options as Time#strftime).'
-    depends_on 'Tags'
 
-    def initialize
-      super
-      register_tag( 'date' )
-    end
+    tag 'date'
 
     def process_tag( tag, node, refNode )
       Time.now.strftime( get_param( 'format' ) )

data/lib/webgen/plugins/tags/download.rb

@@ -0,0 +1,155 @@
+#
+#--
+#
+# $Id: download.rb 349 2005-09-02 09:28:06Z thomas $
+#
+# webgen: template based static website generator
+# Copyright (C) 2004 Thomas Leitner
+#
+# 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 2 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
+#
+#++
+#
+
+require 'webgen/plugins/tags/tags'
+require 'webgen/plugins/coreplugins/resourcemanager'
+require 'yaml'
+require 'uri'
+require 'open-uri'
+
+module Tags
+
+  class DownloadTag < DefaultTag
+
+    summary "Provides a nice download link and, optional, image "
+    add_param 'url', nil, 'The URL to the file. Can be a local file or one referenced via HTTP/FTP.'
+    add_param 'icon', nil, 'The URL to an icon which will be shown next to the name.'
+    add_param 'alwaysShowDownloadIcon', false, 'Specifies if the download icon should always be shown, or only ' \
+    'when no icon is available for the file type.'
+    add_param 'mappingFile', nil, 'An additional mapping file used for mapping extensions to icons.'
+    set_mandatory 'url', true
+
+    depends_on 'ResourceManager'
+
+    CSS = '
+.webgen-file-icon, .webgen-download-icon {
+  vertical-align: middle;
+}
+'
+
+    tag 'download'
+
+    def initialize
+      super
+      Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
+      @default_mapping = load_mapping( File.join( CorePlugins::Configuration.data_dir, 'icon_mapping.yaml' ) )
+    end
+
+    def process_tag( tag, node, refNode )
+      url = get_param( 'url' )
+      return '' if url.nil?
+
+      mapping = @default_mapping.dup
+      mapping.update( load_mapping( get_param( 'mappingFile' ) ) ) if File.exists?( get_param( 'mappingFile' ) || '' )
+
+      icon = file_icon( File.extname( url ), mapping, node )
+      output = ''
+      output << download_icon if get_param( 'alwaysShowDownloadIcon' ) || icon.nil?
+      output << icon unless icon.nil?
+      output << file_link( url, node, refNode )
+      output << file_size( url, refNode )
+    end
+
+    #######
+    private
+    #######
+
+    def download_icon
+      "<img class=\"webgen-download-icon\" src=\"{resource: webgen-icons-download}\" alt=\"Download icon\" />"
+    end
+
+    def file_icon( ext, mapping, node )
+      data = mapping[ext]
+      src = get_param( 'icon' )
+      if src.nil? && !data.nil?
+        if data[0] == :resource
+          src = "{resource: #{data[1]}}"
+        else
+          icon_node = Node.root( node ).node_for_string( data[1] )
+          unless icon_node.nil?
+            src = node.relpath_to_node( icon_node )
+          end
+        end
+      end
+      (src.nil? ? nil : "<img class=\"webgen-file-icon\" src=\"#{src}\" alt=\"File icon\" />")
+    end
+
+    def file_link( url, node, refNode )
+      link = if URI.parse( url ).absolute?
+               url
+             else
+               fileNode = refNode.node_for_string( url )
+               (fileNode.nil? ? '' : node.relpath_to_node( fileNode ))
+             end
+      "<a href=\"#{link}\">#{File.basename( url )}</a>"
+    end
+
+    UNIT_NAMES = ['Byte', 'KiB', 'MiB', 'GiB', 'TiB']
+
+    def file_size( url, refNode )
+      size = nil
+      catch :size do
+        begin
+          if URI.parse( url ).absolute?
+            open( url, :content_length_proc => proc {|size| throw :size} ) {|f| }
+          else
+            fileNode = refNode.node_for_string( url )
+            size = File.size( fileNode.recursive_value( 'src' ) )
+          end
+        rescue
+        end
+      end
+
+      if size.nil?
+        logger.warn { "Could not get file size information for file <#{url}>" }
+        ''
+      else
+        size, unit = [size.to_f, 0]
+        size, unit = [size / 1024, unit + 1] while size > 1024
+        format_str = if unit == 0
+                       " (%d %s)"
+                     else
+                       " (%.2f %s)"
+                     end
+        format_str % [size, UNIT_NAMES[unit]]
+      end
+    end
+
+    def load_mapping( file )
+      data = YAML::load( File.read( file ) )
+      mapping = {}
+      if data['resource-mapping']
+        data['resource-mapping'].each do |icon, exts|
+          exts.each {|ext| mapping[ext] = [:resource, icon]}
+        end
+      end
+      if data['file-mapping']
+        data['file-mapping'].each do |icon, exts|
+          exts.each {|ext| mapping[ext] = [:file, icon]}
+        end
+      end
+      mapping
+    end
+
+  end
+
+end

data/lib/webgen/plugins/tags/executecommand.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: executecommand.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: executecommand.rb 324 2005-07-04 12:54:25Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -30,16 +30,12 @@ module Tags
   class ExecuteCommandTag < DefaultTag
 
     summary "Executes the given command and includes its standard output"
-    depends_on 'Tags'
     add_param 'command', nil, 'The command which should be executed'
     add_param 'processOutput', true, 'The output of the command will be processed if true'
     add_param 'escapeHTML', true, 'Special HTML characters in the output will be escaped if true'
     set_mandatory 'command', true
 
-    def initialize
-      super
-      register_tag( 'execute' )
-    end
+    tag 'execute'
 
     def process_tag( tag, node, refNode )
       @processOutput = get_param( 'processOutput' )

data/lib/webgen/plugins/tags/includefile.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: includefile.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: includefile.rb 324 2005-07-04 12:54:25Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -29,22 +29,18 @@ module Tags
   class IncludeFileTag < DefaultTag
 
     summary "Includes a file verbatim"
-    depends_on 'Tags'
     add_param 'filename', nil, 'The name of the file which should be included'
-    add_param 'processOutput', true, 'The file content will be processed if true'
+    add_param 'processOutput', true, 'The file content will be scanned for tags if true'
     add_param 'escapeHTML', true, 'Special HTML characters in the file content will be escaped if true'
     set_mandatory 'filename', true
 
-    def initialize
-      super
-      register_tag( 'includeFile' )
-    end
+    tag 'includeFile'
 
     def process_tag( tag, node, refNode )
       @processOutput = get_param( 'processOutput' )
       content = ''
       begin
-        filename = refNode.parent.recursive_value( 'src' ) + get_param( 'filename' )
+        filename = refNode.parent_dir.recursive_value( 'src' ) + get_param( 'filename' )
         self.logger.debug { "File location: <#{filename}>" }
         content = File.read( filename )
       rescue