webgen 0.4.7 → 0.5.0

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

@@ -1,75 +0,0 @@
-#
-#--
-#
-# $Id: breadcrumbtrail.rb 595 2007-02-14 07:43:28Z 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
-
-  # Generates a breadcrumb trail. It consists of all pages in the hierarchy of the
-  # current page.
-  #
-  # For example, assuming we have the following branch
-  #   /directory1/directory2/currentFile
-  # this plugin will generate something like this:
-  #   root / directory1 / directory2 / currentFile
-  # where each listed name is linked to the corresponding file.
-  class BreadcrumbTrailTag < DefaultTag
-
-    infos( :name => 'Tag/BreadcrumbTrail',
-           :author => Webgen::AUTHOR,
-           :summary => 'Shows the hierarchy for the current page'
-           )
-
-    param 'separator', ' / ', 'Separates the hierachy entries from each other.'
-    param 'omitLast', false, 'Omits the last path component.'
-    param 'omitIndexFile', false, 'Omits the last path component if it is an index file.'
-
-    register_tag 'breadcrumbTrail'
-
-    def process_tag( tag, chain )
-      out = []
-      node = chain.last
-
-      omitIndexFile = if node.meta_info.has_key?( 'omitIndexFileInBreadcrumbTrail' )
-                        node['omitIndexFileInBreadcrumbTrail']
-                      else
-                        param( 'omitIndexFile' )
-                      end
-      omitIndexFile = omitIndexFile && node.parent['indexFile'] &&
-        node.parent['indexFile'].node_for_lang( node['lang'] ) == node
-
-      node = node.parent if omitIndexFile
-
-      until node.nil?
-        out.push( node.link_from( chain.last, :context => { :caller => self.class.plugin_name } ) )
-        node = node.parent
-      end
-
-      out[0] = '' if param( 'omitLast' ) && !omitIndexFile
-      out = out.reverse.join( param( 'separator' ) )
-      log(:debug) { "Breadcrumb trail for <#{chain.last.node_info[:src]}>: #{out}" }
-      out
-    end
-
-  end
-
-end

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

@@ -1,54 +0,0 @@
-#
-#--
-#
-# $Id: meta.rb 563 2006-12-29 08:59:41Z 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
-
-  class CustomVarTag < DefaultTag
-
-    infos( :name => 'Tag/CustomVar',
-           :author => Webgen::AUTHOR,
-           :summary => "Used to output custom variables defined in Core/Configuration:customVars."
-           )
-
-    param 'var', nil, 'The variable of which the value should be retrieved.'
-    set_mandatory 'var', true
-
-    register_tag 'customVar'
-
-    def process_tag( tag, chain )
-      output = ''
-      customVars = param( 'customVars', 'Core/Configuration' )
-      var = param( 'var' )
-
-      if customVars.kind_of?( Hash ) && customVars.has_key?( var )
-        output = customVars[var]
-      else
-        log(:warn) { "No custom variable called '#{var}' found in Core/Configuration:customVars (file <#{chain.first.node_info[:src]}>)" }
-      end
-      output
-    end
-
-  end
-
-end

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

@@ -1,46 +0,0 @@
-#
-#--
-#
-# $Id: date.rb 562 2006-12-28 08:00:37Z 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
-
-  # Prints out the date using a format string which will be passed to Time#strftime. Therefore you
-  # can use everything Time#strftime offers.
-  class DateTag < DefaultTag
-
-    infos( :name => 'Tag/Date',
-           :author => Webgen::AUTHOR,
-           :summary => "Prints out the current date/time in a customizable format"
-           )
-
-    param 'format', '%A, %B %d %H:%M:%S %Z %Y', 'The format of the date (same options as Ruby\'s Time#strftime).'
-
-    register_tag 'date'
-
-    def process_tag( tag, chain )
-      Time.now.strftime( param( 'format' ) )
-    end
-
-  end
-
-end

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

@@ -1,155 +0,0 @@
-#
-#--
-#
-# $Id: download.rb 563 2006-12-29 08:59:41Z 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'
-load_plugin 'webgen/plugins/coreplugins/resourcemanager'
-require 'yaml'
-require 'uri'
-require 'open-uri'
-
-module Tags
-
-  class DownloadTag < DefaultTag
-
-    infos( :name => 'Tag/Download',
-           :author => Webgen::AUTHOR,
-           :summary => "Provides a nice download link and, optional, image "
-           )
-
-    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
-
-    depends_on 'Core/ResourceManager'
-
-    register_tag 'download'
-
-    def initialize( plugin_manager )
-      super
-      @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, chain )
-      url = param( 'url' )
-      return '' if url.nil?
-
-      mapping = @default_mapping.dup
-      mapping.update( load_mapping( param( 'mappingFile' ) ) ) if File.exists?( param( 'mappingFile' ) || '' )
-
-      icon = file_icon( File.extname( url ), mapping, chain.last )
-      output = ''
-      output << download_icon if param( 'alwaysShowDownloadIcon' ) || icon.nil?
-      output << icon unless icon.nil?
-      output << file_link( url, chain.last, chain.first )
-      output << file_size( url, chain.first )
-    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 = 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] )
-          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, ref_node )
-      link = if URI.parse( url ).absolute?
-               url
-             else
-               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, ref_node )
-      size = nil
-      catch :size do
-        begin
-          if URI.parse( url ).absolute?
-            open( url, :content_length_proc => proc {|size| throw :size} ) {|f| }
-          else
-            file_node = ref_node.resolve_node( url )
-            size = File.size( file_node.node_info[:src] )
-          end
-        rescue
-        end
-      end
-
-      if size.nil?
-        log(: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,69 +0,0 @@
-#
-#--
-#
-# $Id: executecommand.rb 563 2006-12-29 08:59:41Z 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 'cgi'
-require 'webgen/extcommand'
-load_plugin 'webgen/plugins/tags/tag_processor'
-load_plugin 'webgen/plugins/miscplugins/syntax_highlighter'
-
-module Tags
-
-  # Executes the given command and writes the standard output into the output file. All HTML special
-  # characters are escaped.
-  class ExecuteCommandTag < DefaultTag
-
-    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
-
-    register_tag 'execute'
-
-    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
-    end
-
-  end
-
-end

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

@@ -1,27 +0,0 @@
-load_plugin 'webgen/plugins/tags/tag_processor'
-
-module Tags
-
-  class HtmlMetaInfo < DefaultTag
-
-    infos( :name => 'Tag/HtmlMetaInfo',
-           :author => 'Andrea Censi',
-           :summary => 'Writes the content of the "description","author","keywords" as HTML META tags.')
-
-    register_tag 'htmlmetainfo'
-
-    def process_tag( tag, chain )
-      cur_node = chain.last
-      s = ""
-      ['description', 'author', 'keywords'].each do |key|
-         if value = cur_node.meta_info[key]
-            value = CGI::escapeHTML(value)
-            s += "<meta name='#{key}' content='#{value}'/>\n"
-         end
-      end
-      s
-    end
-
-  end
-
-end

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

@@ -1,69 +0,0 @@
-#
-#--
-#
-# $Id: includefile.rb 563 2006-12-29 08:59:41Z 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 'cgi'
-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
-
-    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
-
-    register_tag 'includeFile'
-
-
-    def process_tag( tag, chain )
-      @process_output = param( 'processOutput' )
-      content = ''
-      begin
-        filename = param( 'filename' )
-        filename = File.join( chain.first.parent.node_info[:src], param( 'filename' ) ) unless filename =~ /^(\/|\w:)/
-        content = File.read( filename )
-      rescue
-        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 param( 'escapeHTML' )
-
-      if !param( 'highlight' ).nil?
-        content = @plugin_manager['Misc/SyntaxHighlighter'].highlight( content, param( 'highlight' ) )
-      end
-      content
-    end
-
-  end
-
-end