webgen 0.3.8 → 0.4.0

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

@@ -0,0 +1,65 @@
+#
+#--
+#
+# $Id: meta.rb 462 2006-08-19 15:23:42Z 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
+#
+#++
+#
+
+load_plugin 'webgen/plugins/tags/tag_processor'
+
+module Tags
+
+  # Substitutes the tag with an actual content block.
+  class BlockTag < DefaultTag
+
+    infos( :name => 'Tag/Block',
+           :author => Webgen::AUTHOR,
+           :summary => "Returns the rendered content of a page file block"
+           )
+
+    param 'blockName', 'content', 'The name of the block which should be rendered.'
+    set_mandatory 'blockName', true
+
+    register_tag 'block'
+
+    def process_tag( tag, chain )
+      block_node = (chain.length > 1 ? chain[1] : chain[0])
+      block_name = param( 'blockName' )
+      if block_node.node_info[:pagedata].blocks.has_key?( block_name )
+        if block_node['useERB']
+          node = chain.last
+          ref_node = block_node
+          begin
+            content = block_node.node_info[:pagedata].blocks[block_name].render_with_erb( binding )
+          rescue
+            log(:error) { "Error while running ERB on <#{block_node.node_info[:src]}> (block '#{block_name}'): #{$!.message}" }
+            content = ''
+          end
+        else
+          content = block_node.node_info[:pagedata].blocks[block_name].content
+        end
+        [content, (chain[1..-1].empty? ? chain : chain[1..-1]) ]
+      else
+        log(:error) { "Node <#{block_node.node_info[:src]}> does not contain a block called '#{block_name}'" }
+        ''
+      end
+    end
+
+  end
+
+end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: breadcrumbtrail.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: breadcrumbtrail.rb 561 2006-12-28 07:41:28Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'webgen/plugins/tags/tags'
+load_plugin 'webgen/plugins/tags/tag_processor'
 
 module Tags
 
@@ -34,22 +34,26 @@ module Tags
   # where each listed name is linked to the corresponding file.
   class BreadcrumbTrailTag < DefaultTag
 
-    summary 'Shows the hierarchy of current page'
-    add_param 'separator', ' / ', 'Separates the hierachy entries from each other.'
+    infos( :name => 'Tag/BreadcrumbTrail',
+           :author => Webgen::AUTHOR,
+           :summary => 'Shows the hierarchy for the current page'
+           )
 
-    tag 'breadcrumbTrail'
+    param 'separator', ' / ', 'Separates the hierachy entries from each other.'
 
-    def process_tag( tag, srcNode, refNode )
+    register_tag 'breadcrumbTrail'
+
+    def process_tag( tag, chain )
       out = []
-      node = srcNode
+      node = chain.last
 
       until node.nil?
-        out.push( node['processor'].get_html_link( node, srcNode ) )
-        begin node = node.parent end while !node.nil? && node['virtual']
+        out.push( node.link_from( chain.last ) )
+        node = node.parent
       end
 
-      out = out.reverse.join( get_param( 'separator' ) )
-      self.logger.debug { "Breadcrumb trail for <#{srcNode.recursive_value( 'src' )}>: #{out}" }
+      out = out.reverse.join( param( 'separator' ) )
+      log(:debug) { "Breadcrumb trail for <#{chain.last.node_info[:src]}>: #{out}" }
       out
     end
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: date.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: date.rb 562 2006-12-28 08:00:37Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'webgen/plugins/tags/tags'
+load_plugin 'webgen/plugins/tags/tag_processor'
 
 module Tags
 
@@ -28,13 +28,17 @@ module Tags
   # can use everything Time#strftime offers.
   class DateTag < DefaultTag
 
-    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).'
+    infos( :name => 'Tag/Date',
+           :author => Webgen::AUTHOR,
+           :summary => "Prints out the current date/time in a customizable format"
+           )
 
-    tag 'date'
+    param 'format', '%A, %B %d %H:%M:%S %Z %Y', 'The format of the date (same options as Ruby\'s Time#strftime).'
 
-    def process_tag( tag, node, refNode )
-      Time.now.strftime( get_param( 'format' ) )
+    register_tag 'date'
+
+    def process_tag( tag, chain )
+      Time.now.strftime( param( 'format' ) )
     end
 
   end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: download.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: download.rb 563 2006-12-29 08:59:41Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,8 +20,8 @@
 #++
 #
 
-require 'webgen/plugins/tags/tags'
-require 'webgen/plugins/coreplugins/resourcemanager'
+load_plugin 'webgen/plugins/tags/tag_processor'
+load_plugin 'webgen/plugins/coreplugins/resourcemanager'
 require 'yaml'
 require 'uri'
 require 'open-uri'
@@ -30,43 +30,45 @@ 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
+    infos( :name => 'Tag/Download',
+           :author => Webgen::AUTHOR,
+           :summary => "Provides a nice download link and, optional, image "
+           )
 
-    depends_on 'ResourceManager'
+    param 'url', nil, 'The URL to the file. Can be a local file or one referenced via HTTP/FTP.'
+    param 'icon', nil, 'The URL to an icon which will be shown next to the name.'
+    param 'alwaysShowDownloadIcon', false, 'Specifies if the download icon should always be shown, or only ' +
+      'when no icon is available for the file type.'
+    param 'mappingFile', nil, 'An additional mapping file used for mapping extensions to icons.'
+    set_mandatory 'url', true
 
-    CSS = '
-.webgen-file-icon, .webgen-download-icon {
-  vertical-align: middle;
-}
-'
+    depends_on 'Core/ResourceManager'
 
-    tag 'download'
+    register_tag 'download'
 
-    def initialize
+    def initialize( plugin_manager )
       super
-      Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
-      @default_mapping = load_mapping( File.join( CorePlugins::Configuration.data_dir, 'icon_mapping.yaml' ) )
+      @plugin_manager['Core/ResourceManager'].append_data( 'webgen-css', '
+/* START webgen download tag */
+.webgen-file-icon, .webgen-download-icon { vertical-align: middle; }
+/* STOP webgen download tag */
+' )
+      @default_mapping = load_mapping( File.join( Webgen.data_dir, 'icon_mapping.yaml' ) )
     end
 
-    def process_tag( tag, node, refNode )
-      url = get_param( 'url' )
+    def process_tag( tag, chain )
+      url = param( 'url' )
       return '' if url.nil?
 
       mapping = @default_mapping.dup
-      mapping.update( load_mapping( get_param( 'mappingFile' ) ) ) if File.exists?( get_param( 'mappingFile' ) || '' )
+      mapping.update( load_mapping( param( 'mappingFile' ) ) ) if File.exists?( param( 'mappingFile' ) || '' )
 
-      icon = file_icon( File.extname( url ), mapping, node )
+      icon = file_icon( File.extname( url ), mapping, chain.last )
       output = ''
-      output << download_icon if get_param( 'alwaysShowDownloadIcon' ) || icon.nil?
+      output << download_icon if param( 'alwaysShowDownloadIcon' ) || icon.nil?
       output << icon unless icon.nil?
-      output << file_link( url, node, refNode )
-      output << file_size( url, refNode )
+      output << file_link( url, chain.last, chain.first )
+      output << file_size( url, chain.first )
     end
 
     #######
@@ -79,48 +81,46 @@ module Tags
 
     def file_icon( ext, mapping, node )
       data = mapping[ext]
-      src = get_param( 'icon' )
+      src = 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
+          src = node.route_to( icon_node ) unless icon_node.nil?
         end
       end
       (src.nil? ? nil : "<img class=\"webgen-file-icon\" src=\"#{src}\" alt=\"File icon\" />")
     end
 
-    def file_link( url, node, refNode )
+    def file_link( url, node, ref_node )
       link = if URI.parse( url ).absolute?
                url
              else
-               fileNode = refNode.node_for_string( url )
-               (fileNode.nil? ? '' : node.relpath_to_node( fileNode ))
+               file_node = ref_node.resolve_node( url )
+               (file_node.nil? ? '' : node.route_to( file_node ))
              end
       "<a href=\"#{link}\">#{File.basename( url )}</a>"
     end
 
     UNIT_NAMES = ['Byte', 'KiB', 'MiB', 'GiB', 'TiB']
 
-    def file_size( url, refNode )
+    def file_size( url, ref_node )
       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' ) )
+            file_node = ref_node.resolve_node( url )
+            size = File.size( file_node.node_info[:src] )
           end
         rescue
         end
       end
 
       if size.nil?
-        logger.warn { "Could not get file size information for file <#{url}>" }
+        log(:warn) { "Could not get file size information for file <#{url}>" }
         ''
       else
         size, unit = [size.to_f, 0]

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: executecommand.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: executecommand.rb 563 2006-12-29 08:59:41Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -21,7 +21,9 @@
 #
 
 require 'cgi'
-require 'webgen/plugins/tags/tags'
+require 'webgen/extcommand'
+load_plugin 'webgen/plugins/tags/tag_processor'
+load_plugin 'webgen/plugins/miscplugins/syntax_highlighter'
 
 module Tags
 
@@ -29,23 +31,36 @@ module Tags
   # characters are escaped.
   class ExecuteCommandTag < DefaultTag
 
-    summary "Executes the given command and includes its standard output"
-    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'
+    infos( :name => 'Tag/ExecuteCommand',
+           :author => Webgen::AUTHOR,
+           :summary => "Executes the given command and uses its standard output as the tag value"
+           )
+
+    param 'command', nil, 'The command which should be executed'
+    param 'processOutput', true, 'The output of the command will be further processed by the TagProcessor if true'
+    param 'escapeHTML', true, 'Special HTML characters in the output will be escaped if true'
+    param 'highlight', nil, 'Name of language that should be used for syntax highlighting ' +
+      'the output of the command. If set to nil, no highlighting is performed. ' +
+      "Available langs: #{MiscPlugins::SyntaxHighlighter.available_languages.sort.join(', ')}"
     set_mandatory 'command', true
 
-    tag 'execute'
+    register_tag 'execute'
 
-    def process_tag( tag, node, refNode )
-      @processOutput = get_param( 'processOutput' )
-      begin
-        output = ( get_param( 'command' ) ? `#{get_param( 'command' )}` : '' )
-      rescue StandardError => e
-        output = ''
-        logger.error { "Could not execute command #{get_param( 'command' )}: #{e.message}" }
+    def process_tag( tag, chain )
+      @process_output = param( 'processOutput' )
+      command = param( 'command' )
+      if command
+        cmd = ExtendedCommand.new( command )
+        log(:debug) { "Executed command '#{command}', results: #{cmd.inspect}" }
+        output = cmd.out_text
+        if cmd.ret_code != 0
+          log(:error) { "Command '#{command}' did not return with exit value 0: #{cmd.err_text}" }
+        end
+        output = CGI::escapeHTML( output ) if param( 'escapeHTML' )
+        if !param( 'highlight' ).nil?
+          output = @plugin_manager['Misc/SyntaxHighlighter'].highlight( output, param( 'highlight' ) )
+        end
       end
-      output = CGI::escapeHTML( output ) if get_param( 'escapeHTML' )
       output
     end
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: includefile.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: includefile.rb 563 2006-12-29 08:59:41Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -21,33 +21,46 @@
 #
 
 require 'cgi'
-require 'webgen/plugins/tags/tags'
+load_plugin 'webgen/plugins/tags/tag_processor'
+load_plugin 'webgen/plugins/miscplugins/syntax_highlighter'
 
 module Tags
 
   # Includes a file verbatim. All HTML special characters are escaped.
   class IncludeFileTag < DefaultTag
 
-    summary "Includes a file verbatim"
-    add_param 'filename', nil, 'The name of the file which should be included'
-    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'
+    infos( :name => 'Tag/IncludeFile',
+           :author => Webgen::AUTHOR,
+           :summary => "Includes a file verbatim"
+           )
+
+    param 'filename', nil, 'The name of the file which should be included (relative to the ' +
+      'file specifying the tag).'
+    param 'processOutput', true, 'The file content will be scanned for tags if true'
+    param 'escapeHTML', true, 'Special HTML characters in the file content will be escaped if true'
+    param 'highlight', nil, 'Name of language that should be used for syntax highlighting of ' +
+      'the content of the file. If set to nil, no highlighting is performed. ' +
+      "Available langs: #{MiscPlugins::SyntaxHighlighter.available_languages.sort.join(', ')}"
     set_mandatory 'filename', true
 
-    tag 'includeFile'
+    register_tag 'includeFile'
+
 
-    def process_tag( tag, node, refNode )
-      @processOutput = get_param( 'processOutput' )
+    def process_tag( tag, chain )
+      @process_output = param( 'processOutput' )
       content = ''
       begin
-        filename = refNode.parent_dir.recursive_value( 'src' ) + get_param( 'filename' )
-        self.logger.debug { "File location: <#{filename}>" }
+        filename = param( 'filename' )
+        filename = File.join( chain.first.parent.node_info[:src], param( 'filename' ) ) unless filename =~ /^(\/|\w:)/
         content = File.read( filename )
       rescue
-        self.logger.error { "Given file <#{filename}> does not exist (tag specified in <#{refNode.recursive_value( 'src' )}>" }
+        log(:error) { "Given file <#{filename}> specified in <#{chain.first.node_info[:src]}> does not exist or can't be read" }
       end
-      content = CGI::escapeHTML( content ) if get_param( 'escapeHTML' )
+      content = CGI::escapeHTML( content ) if param( 'escapeHTML' )
 
+      if !param( 'highlight' ).nil?
+        content = @plugin_manager['Misc/SyntaxHighlighter'].highlight( content, param( 'highlight' ) )
+      end
       content
     end
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: langbar.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: langbar.rb 563 2006-12-29 08:59:41Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,29 +20,34 @@
 #++
 #
 
-require 'webgen/plugins/tags/tags'
+load_plugin 'webgen/plugins/tags/tag_processor'
 
 module Tags
 
   # Generates a list with all the languages for a page.
   class LangbarTag < DefaultTag
 
-    summary 'Provides links to translations of the page'
-    add_param 'separator', ' | ', 'Separates the languages from each other.'
-    add_param 'showSingleLang', true, 'Should the link be shown '\
-    'although the page is only available in one language?'
-    add_param 'showOwnLang', true, 'Should the link to the currently displayed '\
-    'language page be shown? '
-
-    tag 'langbar'
-
-    def process_tag( tag, node, refNode )
-      output = node.parent.find_all do |a|
-        a['int:pagename'] == node['int:pagename'] && (node['lang'] != a['lang'] || get_param( 'showOwnLang' ))
-      end.sort {|a, b| a['lang'] <=> b['lang']}.collect do |n|
-        n['processor'].get_html_link( n, n, n['lang'] )
-      end.join( get_param( 'separator' ) )
-      return ( get_param( 'showSingleLang' ) || node.parent.children.length > 1 ? output : "" )
+    infos( :name => 'Tag/Langbar',
+           :author => Webgen::AUTHOR,
+           :summary => 'Provides links to translations of the page'
+           )
+
+    param 'separator', ' | ', 'Separates the languages from each other.'
+    param 'showSingleLang', true, 'Should the link be shown although the page is only available in one language?'
+    param 'showOwnLang', true, 'Should the link to the currently displayed language page be shown?'
+
+    register_tag 'langbar'
+
+    def process_tag( tag, chain )
+      cur_node = chain.last
+      langs = cur_node.parent.find_all {|child| child.node_info[:pagename] == cur_node.node_info[:pagename] }
+      nr_langs = langs.length
+      langs = langs.
+        delete_if {|child| (cur_node['lang'] == child['lang'] && !param( 'showOwnLang' )) }.
+        sort {|a, b| a['lang'] <=> b['lang']}.
+        collect {|n| n.link_from( cur_node, :resolve_lang_node => false, :link_text => n['lang'] )}.
+        join( param( 'separator' ) )
+      ( param( 'showSingleLang' ) || nr_langs > 1 ? langs : "" )
     end
 
   end