webgen 0.3.0

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

@@ -0,0 +1,247 @@
+#
+#--
+#
+# $Id: tags.rb 203 2005-02-21 18:42:04Z 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 'yaml'
+
+module Tags
+
+  # This is the main class for tags. Tag plugins can register themselves by adding a new key:value
+  # pair to +tags+. The key has to be the name of the tag as specified in the page description files
+  # and the value is the plugin object itself. When the content is parsed and a tag is
+  # encountered, the registered plugin for the tag is called. If no plugin for a tag is registered
+  # but a default plugin is, the default plugin is called. Otherwise an error is raised.
+  #
+  # The default plugin can be registered by using the special key <tt>:default</tt>.
+  class Tags < Webgen::Plugin
+
+    summary "Super plugin for handling tags"
+
+    # Tag plugins should add an entry to this hash.
+    attr_reader :tags
+
+    def initialize
+      @tags = Hash.new
+    end
+
+    # Substitutes all references to tags in the string +content+. The +node+ parameter specifies the
+    # tree node the content of which is used. The +refNode+ parameter specifies relative to which
+    # all references should be resolved.
+    def substitute_tags( content, node, refNode )
+      if !content.kind_of?( String )
+        self.logger.error { "The content in <#{refNode.recursive_value( 'src' )}> is not a string, but a #{content.class.name}" }
+        content = content.to_s
+      end
+      return replace_tags( content ) do |tag, data|
+        self.logger.info { "Replacing tag #{tag} with data '#{data}' in <#{node.recursive_value( 'dest' )}>" }
+        processor = get_tag_processor( tag )
+        begin
+          processor.set_tag_config( YAML::load( "--- #{data}" ), refNode )
+        rescue ArgumentError => e
+          self.logger.error { "Could parse the data '#{data}' for tag #{tag} in <#{node.recursive_value( 'dest' )}>: #{e.message}" }
+        end
+        output = processor.process_tag( tag, node, refNode )
+        processor.reset_tag_config
+        output = substitute_tags( output, node, node ) if processor.processOutput
+        output
+      end
+    end
+
+    #######
+    private
+    #######
+
+    # Scans the +content+ for tags. If a tag is found, the block is called which needs to return the
+    # value for the given tag. The changed content is returned.
+    def replace_tags( content ) # :yields: tag, data
+      offset = 0;
+      while index = content.index( /(\\*)\{(\w+):/, offset )
+        bracketCount = 1;
+        length = $1.length + 1;
+        tag = $2
+        content[(index + length)..-1].each_byte do |char|
+          length += 1
+          bracketCount += 1 if char == ?{
+          bracketCount -= 1 if char == ?}
+          break if bracketCount == 0
+        end
+
+        if bracketCount > 0
+          self.logger.error { "Unbalanced curly brackets!!!" }
+          newContent = content[index, length]
+        else
+          newContent = "\\"* ( $1.length / 2 )
+          if $1.length % 2 == 1
+            newContent += content[index + $1.length, length - $1.length]
+          else
+            tagHeaderLength = $1.length + tag.length + 2
+            realContent = content[index + tagHeaderLength, length - tagHeaderLength - 1]
+            newContent += yield( tag, realContent )
+          end
+          content[index, length] = newContent
+        end
+        offset = index + newContent.length
+      end
+      content
+    end
+
+
+    # Returns the tag processor for +tag+ or throws an error if +tag+ is unkown.
+    def get_tag_processor( tag )
+      if @tags.has_key?( tag )
+        return @tags[tag]
+      elsif @tags.has_key?( :default )
+        return @tags[:default]
+      else
+        self.logger.error { "No tag processor for tag '#{tag}' found" }
+        return DefaultTag.new
+      end
+    end
+
+  end
+
+
+  # Base class for all tag plugins. The base class provides a default mechanism for retrieving
+  # configuration data from either the configuration file or the tag itself.
+  class DefaultTag < Webgen::Plugin
+
+    VIRTUAL = true
+
+    summary "Base class for all tag plugins"
+    depends_on "Tags"
+
+    # +true+, if the output should be processed again
+    attr_reader :processOutput
+
+    def initialize
+      @processOutput = true
+    end
+
+    # Set the parameter +param+ as mandatory. The parameter +default+ specifies, if this parameter
+    # should be the default mandatory parameter. If only a String is supplied in a tag, its value
+    # will be assigned to the default mandatory parameter. There *should* be only one default
+    # mandatory parameter.
+    def self.set_mandatory( param, default = false )
+      if Webgen::Plugin.config[self.name].params.nil? || !Webgen::Plugin.config[self.name].params.has_key?( param )
+        self.logger.error { "Cannot set parameter #{param} as mandatory as this parameter does not exist for #{self.name}" }
+      else
+        Webgen::Plugin.config[self.name].params[param].mandatory = true
+        Webgen::Plugin.config[self.name].params[param].mandatoryDefault = default
+      end
+    end
+
+    # Register +tag+ at the Tags plugin.
+    def register_tag( tag )
+      Webgen::Plugin['Tags'].tags[tag] = self
+      Webgen::Plugin.config[self.class.name].tag = tag
+    end
+
+    # Set the configuration parameters for the next #process_tag call. The configuration, if
+    # specified, is taken from the tag itself.
+    def set_tag_config( config, node )
+      @curConfig = {}
+      case config
+      when Hash
+        set_cur_config( config, node )
+
+      when String
+        set_default_mandatory_param( config )
+
+      when NilClass
+        if has_mandatory_params?
+          self.logger.error { "Mandatory parameters for tag '#{self.class.name}' in <#{node.recursive_value( 'src' )}> not specified" }
+        end
+
+      else
+        self.logger.error { "Invalid parameter for tag '#{self.class.name}' in <#{node.recursive_value( 'src' )}>" }
+      end
+
+      unless all_mandatory_params_set?
+        self.logger.error { "Not all mandatory parameters for tag '#{self.class.name}' in <#{node.recursive_value( 'src' )}> set" }
+      end
+    end
+
+
+    # Resets the tag configuration data.
+    def reset_tag_config
+      @curConfig = {}
+    end
+
+
+    # Default implementation for processing a tag.
+    #
+    # Has to be overridden by the subclass!!!
+    def process_tag( tag, node, refNode )
+      ''
+    end
+
+    #######
+    private
+    #######
+
+    # Set the current configuration taking values from +config+ which has to be a Hash.
+    def set_cur_config( config, node )
+      config.each do |key, value|
+        if has_param?( key )
+          @curConfig[key] = value
+          self.logger.debug { "Setting parameter '#{key}' for tag '#{self.class.name}' in <#{node.recursive_value( 'src' )}>" }
+        else
+          self.logger.warn { "Invalid parameter '#{key}' for tag '#{self.class.name}' in <#{node.recursive_value( 'src' )}>" }
+        end
+      end
+    end
+
+    # Set the default mandatory parameter.
+    def set_default_mandatory_param( value )
+      data = Webgen::Plugin.config[self.class.name]
+      key = data.params.detect {|k,v| v.mandatoryDefault} unless data.params.nil?
+      if key.nil?
+        self.logger.error { "Default mandatory parameter not specified for tag '#{self.class.name}'"}
+      else
+        @curConfig[key[0]] = value
+      end
+    end
+
+    # Check if this tag has mandatory parameters.
+    def has_mandatory_params?
+      data = Webgen::Plugin.config[self.class.name]
+      !data.params.nil? && data.params.any? {|k,v| v.mandatory }
+    end
+
+    # Check if all mandatory parameters have been set
+    def all_mandatory_params_set?
+      params = Webgen::Plugin.config[self.class.name].params
+      ( params.nil? ? true : params.all? { |k,v| !v.mandatory || @curConfig.has_key?( k ) } )
+    end
+
+    # Retrieves the parameter value for +name+. The value is taken from the current tag if the
+    # parameter is specified there or the default value set in #register_config_value is used.
+    def get_param( name )
+      if !@curConfig.nil? && @curConfig.has_key?( name )
+        return @curConfig[name]
+      else
+        super( name )
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,58 @@
+#
+#--
+#
+# $Id: wikilink.rb 203 2005-02-21 18:42:04Z 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'
+
+module Tags
+
+  class WikiLinkTag < DefaultTag
+
+    summary 'Adds a link to wiki page'
+    depends_on 'Tags'
+    add_param 'title', nil, 'The title of the link. If it is not specified, the title of the current page is used.'
+    add_param 'rootURL', '/wiki/wiki.pl?', 'The root URL for the wiki link, ie. the path to the wiki CGI.'
+    add_param 'relURL', nil, 'The relativ URL for the wiki link (the varying part that is appended to rootURL). ' \
+    'If it is not specified, the title of the current page is used.'
+    add_param 'convertSpaces', true, 'True if spaces in the relative URL should be converted to underscores.'
+
+    def initialize
+      super
+      register_tag( 'wikilink' )
+    end
+
+    def process_tag( tag, node, refNode )
+      "<a href=\"#{get_link( node )}\">#{get_param( 'title' ) || node['title']}</a>"
+    end
+
+    #######
+    private
+    #######
+
+    def get_link( node )
+      link = get_param( 'rootURL' )
+      relURL = get_param( 'relURL' ) || node['title']
+      link + (get_param( 'convertSpaces' ) ? relURL.tr( ' ', '_' ) : relURL )
+    end
+
+  end
+
+end

data/lib/webgen/plugins/treewalker.rb

@@ -0,0 +1,81 @@
+#
+#--
+#
+# $Id: treewalker.rb 203 2005-02-21 18:42:04Z 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
+#
+#++
+#
+
+
+# All plugins which count as "tree walkers" should be put into this module.
+module TreeWalkers
+
+  # This is the main class for tree walkers. A tree walker plugin can register itself with this class
+  # so that it is called when the main class' #execute method is called.
+  class TreeWalker < Webgen::Plugin
+
+    summary "Super plugin for transforming the data tree"
+
+    attr_reader :walkers
+
+    def initialize
+      @walkers = []
+    end
+
+    # Uses either all registered walkers or the specified +walker+. Walks the +tree+ for each walker
+    # separately.
+    def execute( tree, walker = nil )
+      walkers = ( walker.nil? ? @walkers : [walker] )
+      walkers.each do |walker|
+        walk_tree( tree, walker, 0 )
+      end
+    end
+
+    #######
+    private
+    #######
+
+    # Walks the tree and calls the plugin +walker+ for each and every node.
+    def walk_tree( node, walker, level )
+      walker.handle_node( node, level )
+      node.each do |child|
+        walk_tree( child, walker, level + 1 )
+      end
+    end
+
+  end
+
+
+  # Prints the whole tree of read files if the log level is at least DEBUG.
+  class DebugTreePrinter < Webgen::Plugin
+
+    summary "Prints out the information in the tree for debug purposes."
+    depends_on 'TreeWalker'
+
+    def initialize
+      Webgen::Plugin['TreeWalker'].walkers << self
+    end
+
+    def handle_node( node, level )
+      self.logger.debug do
+        "   "*level  << "\\_ "*(level > 0 ? 1 : 0) << (node['virtual'] ? "[V]" : "") << "#{node['title']}: #{node['src']} -> #{node['dest']}"
+      end
+    end
+
+  end
+
+end

data/lib/webgen/webgen.rb

@@ -0,0 +1,155 @@
+#
+#--
+#
+# $Id: webgen.rb 203 2005-02-21 18:42:04Z 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 'optparse'
+require 'webgen/configuration'
+
+module Webgen
+
+  class Color
+
+    @@colors = {:bold => [0, 1], :green => [0, 32], :lblue => [1, 34], :lred => [1, 31], :reset => [0, 0]}
+
+    def Color.colorify
+      @@colors.each do |color, values|
+        module_eval <<-EOF
+        def Color.#{color.to_s}
+        "\e[#{values[0]};#{values[1]}m"
+        end
+        EOF
+      end
+    end
+
+    def Color.method_missing( id )
+      ''
+    end
+
+  end
+
+  class WebgenMain
+
+    def main( cmdOptions )
+      Color.colorify if $stdout.isatty
+      main, data = parse_options( cmdOptions )
+
+      Plugin['Configuration'].init_all( data )
+      main.call
+    end
+
+
+    def parse_options( cmdOptions )
+      config = Plugin['Configuration']
+      data = {}
+      main = method( :runMain )
+
+      opts = OptionParser.new do |opts|
+        opts.summary_width = 25
+        opts.summary_indent = '  '
+
+        opts.banner = "Usage: webgen [options]\n#{Webgen::SUMMARY}"
+
+        opts.separator ""
+        opts.separator "Configuration options:"
+
+        opts.on( "--config-file FILE", "-C", String, "The configuration file which should be used" ) { |data['configfile']| }
+        opts.on( "--source-dir DIR", "-S", String, "The directory from where the files are read" ) { |data['srcDirectory']| }
+        opts.on( "--output-dir DIR", "-O", String, "The directory where the output should go" ) { |data['outDirectory']| }
+        opts.on( "--verbosity LEVEL", "-V", Integer, "The verbosity level" ) { |data['verbosityLevel']| }
+        opts.on( "--[no-]logfile", "-L", "Log to file webgen.log" ) { |logfile| config.set_log_dev_to_logfile if logfile }
+
+        opts.separator ""
+        opts.separator "Other options:"
+
+        opts.on( "--list-plugins", "-p", "List all the plugins and information about them" ) { main = method( :runListPlugins ) }
+        opts.on( "--list-configuration", "-c", "List all plugin configuration parameters" ) { main = method( :runListConfiguration ) }
+        opts.on_tail( "--help", "Display this help screen" ) { puts opts; exit }
+        opts.on_tail( "--version", "-v", "Show version" ) do
+          puts "Webgen #{Webgen::VERSION}"
+          exit
+        end
+      end
+
+      begin
+        opts.parse!( cmdOptions )
+      rescue RuntimeError => e
+        print "Error:\n" << e.reason << ": " << e.args.join(", ") << "\n\n"
+        puts opts
+        exit
+      end
+
+      [main, data]
+    end
+
+
+    def runMain
+      logger.info "Starting Webgen..."
+
+      # load all the files in src dir and build tree
+      tree = Plugin['FileHandler'].build_tree
+
+      # execute tree transformer plugins
+      Plugin['TreeWalker'].execute( tree ) unless tree.nil?
+
+      # generate output files
+      Plugin['FileHandler'].write_tree( tree ) unless tree.nil?
+
+      logger.info "Webgen finished"
+    end
+
+
+    def runListPlugins
+      print "List of loaded plugins:\n"
+
+      headers = Hash.new {|h,k| h[k] = k.gsub(/([A-Z])/, ' \1').strip}
+
+      ljustlength = 30 + Color.green.length + Color.reset.length
+      header = ''
+      Plugin.config.sort { |a, b| a[0] <=> b[0] }.each do |classname, data|
+        newHeader = headers[classname[/^.*?(?=::)/]]
+        unless newHeader == header
+          print "\n  #{Color.bold}#{newHeader}#{Color.reset}:\n";
+          header = newHeader
+        end
+        print "    - #{Color.green}#{data.plugin}#{Color.reset}:".ljust(ljustlength) +"#{data.summary}\n"
+      end
+    end
+
+
+    def runListConfiguration
+      print "List of configuration parameters:\n\n"
+      ljustlength = 20 + Color.green.length + Color.reset.length
+      Plugin.config.sort.each do |classname, data|
+        next if data.params.nil?
+        print "  #{Color.bold}#{data.plugin}#{Color.reset}:\n"
+        data.params.sort.each do |key, item|
+          print "    #{Color.green}Parameter:#{Color.reset}".ljust(ljustlength)
+          puts Color.lred + item.name + Color.reset + " = " + Color.lblue +  item.value.inspect + Color.reset + " (" + item.default.inspect + ")"
+          puts "    #{Color.green}Description:#{Color.reset}".ljust(ljustlength) + item.description
+          print "\n"
+        end
+        print "\n"
+      end
+    end
+
+  end
+
+end