gettalong-webgen 0.5.8.20090507 → 0.5.9.20090620

data/lib/webgen/sourcehandler/sitemap.rb

@@ -14,12 +14,12 @@ module Webgen::SourceHandler
     include Webgen::WebsiteAccess
     include Base
 
-    # Create an XML sitemap from +parent+ and +path+.
-    def create_node(parent, path)
+    # Create an XML sitemap from +path+.
+    def create_node(path)
       page_from_path(path)
       path.ext = 'xml'
       raise "Needed information site_url missing for sitemap <#{path}>" if path.meta_info['site_url'].nil?
-      super(parent, path)
+      super(path)
     end
 
     # Return the rendered feed represented by +node+.

data/lib/webgen/sourcehandler/template.rb

@@ -9,30 +9,30 @@ module Webgen::SourceHandler
     include Webgen::Loggable
     include Base
 
-    # Create a template node in +parent+ for +path+.
-    def create_node(parent, path)
+    # Create a template node for +path+.
+    def create_node(path)
       page = page_from_path(path)
-      super(parent, path) do |node|
+      super(path) do |node|
         node.node_info[:page] = page
       end
     end
 
     # Return the template chain for +node+.
     def templates_for_node(node, lang = node.lang)
-      cached_template = (website.cache.volatile[[node.absolute_lcn, :templates]] ||= {})
+      cached_template = (website.cache.volatile[[node.alcn, :templates]] ||= {})
       if cached_template[lang]
         template_node = cached_template[lang]
       elsif node['template'].kind_of?(String)
         template_node = node.resolve(node['template'], lang)
         if template_node.nil?
-          log(:warn) { "Specified template '#{node['template']}' for <#{node.absolute_lcn}> not found, using default template!" }
+          log(:warn) { "Specified template '#{node['template']}' for <#{node.alcn}> not found, using default template!" }
           template_node = default_template(node.parent, lang)
         end
         cached_template[lang] = template_node
       elsif node.meta_info.has_key?('template') && node['template'].nil?
         template_node = cached_template[lang] = nil
       else
-        log(:info) { "Using default template in language '#{lang}' for <#{node.absolute_lcn}>" }
+        log(:info) { "Using default template in language '#{lang}' for <#{node.alcn}>" }
         template_node = default_template(node.parent, lang)
         if template_node == node && !node.parent.is_root?
           template_node = default_template(node.parent.parent, lang)

data/lib/webgen/sourcehandler/virtual.rb

@@ -19,26 +19,25 @@ module Webgen::SourceHandler
       @path_data = {}
     end
 
-    # Create all virtual nodes under +parent+ which are specified in +path+.
-    def create_node(parent, path)
+    # Create all virtual nodes which are specified in +path+.
+    def create_node(path)
       nodes = []
       read_data(path).each do |key, meta_info|
         cache_data = [key, meta_info.dup]
 
-        key = Webgen::Common.absolute_path(key, parent.absolute_lcn) + (key =~ /\/$/ ? '/' : '')
-        temp_parent = create_directories(parent.tree.root, File.dirname(key), path)
+        key = Webgen::Path.make_absolute(path.parent_path, key) + (key =~ /\/$/ ? '/' : '')
+        temp_parent = create_directories(File.dirname(key), path)
 
         output_path = meta_info.delete('url') || key
         output_path = (URI::parse(output_path).absolute? || output_path =~ /^\// ?
-                       output_path : File.join(temp_parent.absolute_lcn, output_path))
+                       output_path : File.join(temp_parent.alcn, output_path))
 
         if key =~ /\/$/
-          nodes << create_directory(temp_parent, key, path, meta_info)
+          nodes << create_directory(key, path, meta_info)
         else
-          nodes += website.blackboard.invoke(:create_nodes, parent.tree, temp_parent.absolute_lcn,
-                                             Webgen::Path.new(key, path.source_path), self) do |cn_parent, cn_path|
+          nodes += website.blackboard.invoke(:create_nodes, Webgen::Path.new(key, path.source_path), self) do |cn_path|
             cn_path.meta_info.update(meta_info)
-            super(cn_parent, cn_path, output_path) do |n|
+            super(cn_path, :output_path => output_path) do |n|
               n.node_info[:sh_virtual_cache_data] = cache_data
             end
           end
@@ -69,25 +68,28 @@ module Webgen::SourceHandler
     end
 
     # Create the needed parent directories for a virtual node.
-    def create_directories(parent, dirname, path)
-      dirname.sub(/^\//, '').split('/').each do |dir|
-        parent = create_directory(parent, File.join(parent.absolute_lcn, dir), path)
+    def create_directories(dirname, path)
+      parent = website.tree.root
+      dirname.sub(/^\//, '').split('/').inject('/') do |parent_path, dir|
+        parent_path = File.join(parent_path, dir)
+        parent = create_directory(parent_path, path)
       end
       parent
     end
 
     # Create a virtual directory if it does not already exist.
-    def create_directory(parent, dir, path, meta_info = nil)
+    def create_directory(dir, path, meta_info = nil)
       dir_handler = website.cache.instance('Webgen::SourceHandler::Directory')
-      website.blackboard.invoke(:create_nodes, parent.tree, parent.absolute_lcn,
+      parent = website.tree.root
+      website.blackboard.invoke(:create_nodes,
                                 Webgen::Path.new(File.join(dir, '/'), path.source_path),
-                                dir_handler) do |par, temp_path|
-        parent = dir_handler.node_exists?(par, temp_path)
+                                dir_handler) do |temp_path|
+        parent = dir_handler.node_exists?(temp_path)
         if (parent && (parent.node_info[:src] == path.source_path) && !meta_info.nil?) ||
             !parent
           temp_path.meta_info.update(meta_info) if meta_info
           parent.flag(:reinit) if parent
-          parent = dir_handler.create_node(par, temp_path)
+          parent = dir_handler.create_node(temp_path)
         end
         parent
       end

data/lib/webgen/tag/base.rb

@@ -21,7 +21,7 @@ require 'webgen/websiteaccess'
 # the actual processing. And the +initialize+ method must not take any parameters!
 #
 # Tag classes *can* also choose to not use this module. If they don't use it they have to provide
-# the following methods: +set_params+, +create_tag_params+, +call+.
+# the following methods: +set_params+, +create_tag_params+, +create_params_hash+, +call+.
 #
 # == Tag parameters
 #
@@ -50,8 +50,8 @@ require 'webgen/websiteaccess'
 #
 #     def call(tag, body, context)
 #       result = param('do_reverse') ? body.reverse : body
-#       result += "Node: " + context.content_node.absolute_lcn + " (" + context.content_node['title'] + ")"
-#       result += "Reference node: " + context.ref_node.absolute_lcn
+#       result += "Node: " + context.content_node.alcn + " (" + context.content_node['title'] + ")"
+#       result += "Reference node: " + context.ref_node.alcn
 #       result
 #     end
 #
@@ -65,17 +65,44 @@ module Webgen::Tag::Base
   include Webgen::Loggable
   include Webgen::WebsiteAccess
 
-  # Return a hash with parameter values extracted from the string +tag_config+.
+  # Create a hash with parameter values extracted from the string +tag_config+.
+  #
+  # Returns the parameter hash and a boolean which is +true+ if any mandatory parameters are
+  # missing.
   def create_tag_params(tag_config, ref_node)
     begin
       config = YAML::load("--- #{tag_config}")
     rescue ArgumentError => e
-      log(:error) { "Could not parse the tag params '#{tag_config}' in <#{ref_node.absolute_lcn}>: #{e.message}" }
+      log(:error) { "Could not parse the tag params '#{tag_config}' in <#{ref_node.alcn}>: #{e.message}" }
       config = {}
     end
     create_params_hash(config, ref_node)
   end
 
+  # Create and return the parameter hash from +config+ which needs to be a Hash, a String or +nil+.
+  #
+  # Returns the parameter hash and a boolean which is +true+ if any mandatory parameters are
+  # missing.
+  def create_params_hash(config, node)
+    params = tag_params_list
+    result = case config
+             when Hash then create_from_hash(config, params, node)
+             when String then create_from_string(config, params, node)
+             when NilClass then {}
+             else
+               log(:error) { "Invalid parameter type (#{config.class}) for tag '#{self.class.name}' in <#{node.alcn}>" }
+               {}
+             end
+
+    mandatory_params_missing = false
+    unless params.all? {|k| !website.config.meta_info[k][:mandatory] || result.has_key?(k)}
+      log(:error) { "Not all mandatory parameters for tag '#{self.class.name}' in <#{node.alcn}> set" }
+      mandatory_params_missing = true
+    end
+
+    [result, mandatory_params_missing]
+  end
+
   # Set the current parameter configuration to +params+.
   def set_params(params)
     @params = params
@@ -122,25 +149,6 @@ module Webgen::Tag::Base
     website.config.data.keys.select {|key| key =~ regexp}
   end
 
-  # Create the parameter hash from +config+ which needs to be a Hash, a String or +nil+.
-  def create_params_hash(config, node)
-    params = tag_params_list
-    result = case config
-             when Hash then create_from_hash(config, params, node)
-             when String then create_from_string(config, params, node)
-             when NilClass then {}
-             else
-               log(:error) { "Invalid parameter type (#{config.class}) for tag '#{self.class.name}' in <#{node.absolute_lcn}>" }
-               {}
-             end
-
-    unless params.all? {|k| !website.config.meta_info[k][:mandatory] || result.has_key?(k)}
-      log(:error) { "Not all mandatory parameters for tag '#{self.class.name}' in <#{node.absolute_lcn}> set" }
-    end
-
-    result
-  end
-
   # Return a valid parameter hash taking values from +config+ which has to be a Hash.
   def create_from_hash(config, params, node)
     result = {}
@@ -150,7 +158,7 @@ module Webgen::Tag::Base
       elsif params.include?(tag_config_base + '.' + key)
         result[tag_config_base + '.' + key] = value
       else
-        log(:warn) { "Invalid parameter '#{key}' for tag '#{self.class.name}' in <#{node.absolute_lcn}>" }
+        log(:warn) { "Invalid parameter '#{key}' for tag '#{self.class.name}' in <#{node.alcn}>" }
       end
     end
     result
@@ -160,7 +168,7 @@ module Webgen::Tag::Base
   def create_from_string(value, params, node)
     param_name = params.find {|k| website.config.meta_info[k][:mandatory] == 'default'}
     if param_name.nil?
-      log(:error) { "No default mandatory parameter specified for tag '#{self.class.name}' but set in <#{node.absolute_lcn}>"}
+      log(:error) { "No default mandatory parameter specified for tag '#{self.class.name}' but set in <#{node.alcn}>"}
       {}
     else
       {param_name => value}

data/lib/webgen/tag/breadcrumbtrail.rb

@@ -16,10 +16,10 @@ module Webgen::Tag
     # Create the breadcrumb trail.
     def call(tag, body, context)
       out = breadcrumb_trail_list(context.content_node)
-      (context.dest_node.node_info[:tag_breadcrumb_trail] ||= {})[[@params.to_a.sort, context.content_node.absolute_lcn]] = out.map {|n| n.absolute_lcn}
+      (context.dest_node.node_info[:tag_breadcrumb_trail] ||= {})[[@params.to_a.sort, context.content_node.alcn]] = out.map {|n| n.alcn}
       out = out.map {|n| context.dest_node.link_to(n, :lang => context.content_node.lang) }.
         join(param('tag.breadcrumbtrail.separator'))
-      log(:debug) { "Breadcrumb trail for <#{context.content_node.absolute_lcn}>: #{out}" }
+      log(:debug) { "Breadcrumb trail for <#{context.content_node.alcn}>: #{out}" }
       out
     end
 
@@ -57,7 +57,7 @@ module Webgen::Tag
         list = breadcrumb_trail_list(cn)
         set_params({})
 
-        if (list.map {|n| n.absolute_lcn} != cached_list) ||
+        if (list.map {|n| n.alcn} != cached_list) ||
             list.any? {|n| (r = n.routing_node(cn.lang)) && r != node && r.meta_info_changed?}
           node.flag(:dirty)
           break

data/lib/webgen/tag/executecommand.rb

@@ -12,14 +12,14 @@ module Webgen::Tag
 
     include Webgen::Tag::Base
 
-    BIT_BUCKET = (Config::CONFIG['arch'].include?('mswin32') ?  "nul" : "/dev/null")
+    BIT_BUCKET = (Config::CONFIG['host_os'] =~ /mswin|mingw/ ?  "nul" : "/dev/null")
 
     # Execute the command and return the standard output.
     def call(tag, body, context)
       command = param('tag.executecommand.command')
       output = `#{command} 2> #{BIT_BUCKET}`
-      if ($? >> 8) != 0
-        raise "Command '#{command}' in <#{context.ref_node.absolute_lcn}> has return value != 0: #{output}"
+      if $?.exitstatus != 0
+        raise "Command '#{command}' in <#{context.ref_node.alcn}> has return value != 0: #{output}"
       end
       output = CGI::escapeHTML(output) if param('tag.executecommand.escape_html')
       [output, param('tag.executecommand.process_output')]

data/lib/webgen/tag/langbar.rb

@@ -15,7 +15,7 @@ module Webgen::Tag
     # Return a list of all translations of the content page.
     def call(tag, body, context)
       lang_nodes = all_lang_nodes(context.content_node)
-      (context.dest_node.node_info[:tag_langbar_data] ||= {})[context.content_node.absolute_cn] = lang_nodes.map {|n| n.absolute_lcn}
+      (context.dest_node.node_info[:tag_langbar_data] ||= {})[context.content_node.acn] = lang_nodes.map {|n| n.alcn}
       result = lang_nodes.
         reject {|n| (context.content_node.lang == n.lang && !param('tag.langbar.show_own_lang'))}.
         sort {|a, b| a.lang <=> b.lang}.
@@ -31,7 +31,7 @@ module Webgen::Tag
 
     # Return all nodes with the same absolute cn as +node+.
     def all_lang_nodes(node)
-      node.tree.node_access[:acn][node.absolute_cn]
+      node.tree.node_access[:acn][node.acn]
     end
 
     # Check if the langbar tag for +node+ changed.

data/lib/webgen/tag/link.rb

@@ -9,14 +9,14 @@ module Webgen::Tag
 
     # Return a HTML link to the given (A)LCN.
     def call(tag, body, context)
-      if (dest_node = context.ref_node.resolve(param('tag.link.path'), context.dest_node.lang))
-        context.dest_node.node_info[:used_meta_info_nodes] << dest_node.absolute_lcn
+      if (dest_node = context.ref_node.resolve(param('tag.link.path').to_s, context.dest_node.lang))
+        context.dest_node.node_info[:used_meta_info_nodes] << dest_node.alcn
         context.dest_node.link_to(dest_node, param('tag.link.attr').merge(:lang => context.content_node.lang))
       else
         raise ArgumentError, 'Resolving of path failed'
       end
     rescue ArgumentError, URI::InvalidURIError => e
-      log(:error) { "Could not link to path '#{param('tag.link.path')}' in <#{context.ref_node.absolute_lcn}>: #{e.message}" }
+      log(:error) { "Could not link to path '#{param('tag.link.path')}' in <#{context.ref_node.alcn}>: #{e.message}" }
       context.dest_node.flag(:dirty)
       ''
     end

data/lib/webgen/tag/menu.rb

@@ -44,7 +44,7 @@ module Webgen::Tag
 
       # Return the menu tree under the node as nested list of alcn values.
       def to_lcn_list
-        self.children.inject([]) {|temp, n| temp << n.node.absolute_lcn; temp += ((t = n.to_lcn_list).empty? ? [] : [t]) }
+        self.children.inject([]) {|temp, n| temp << n.node.alcn; temp += ((t = n.to_lcn_list).empty? ? [] : [t]) }
       end
 
     end
@@ -57,7 +57,7 @@ module Webgen::Tag
     def call(tag, body, context)
       tree = specific_menu_tree_for(context.content_node)
 
-      (context.dest_node.node_info[:tag_menu_menus] ||= {})[[@params.to_a.sort, context.content_node.absolute_lcn]] = (tree ? tree.to_lcn_list : nil)
+      (context.dest_node.node_info[:tag_menu_menus] ||= {})[[@params.to_a.sort, context.content_node.alcn]] = (tree ? tree.to_lcn_list : nil)
 
       if !tree || tree.children.empty?
         ''

data/lib/webgen/tag/metainfo.rb

@@ -15,7 +15,7 @@ module Webgen::Tag
       elsif context.content_node[tag]
         output = context.content_node[tag].to_s
       else
-        log(:warn) { "No value for meta info key '#{tag}' in <#{context.ref_node.absolute_lcn}> found in <#{context.content_node.absolute_lcn}>" }
+        log(:warn) { "No value for meta info key '#{tag}' in <#{context.ref_node.alcn}> found in <#{context.content_node.alcn}>" }
       end
       output
     end

data/lib/webgen/tag/relocatable.rb

@@ -16,24 +16,13 @@ module Webgen::Tag
 
     # Return the relativized path for the path provided in the tag definition.
     def call(tag, body, context)
-      uri_string = param('tag.relocatable.path')
+      path = param('tag.relocatable.path')
       result = ''
-      unless uri_string.nil?
-        begin
-          uri = URI.parse(uri_string)
-          if uri.absolute?
-            result = uri_string
-          else
-            result = resolve_path(uri_string, context)
-          end
-          if result.empty?
-            log(:error) { "Could not resolve path '#{uri_string}' in <#{context.ref_node.absolute_lcn}>" }
-            context.dest_node.flag(:dirty)
-          end
-        rescue URI::InvalidURIError => e
-          log(:error) { "Error while parsing path for tag relocatable in <#{context.ref_node.absolute_lcn}>: #{e.message}" }
-          context.dest_node.flag(:dirty)
-        end
+      begin
+        result = (Webgen::Node.url(path, false).absolute? ? path : resolve_path(path, context))
+      rescue URI::InvalidURIError => e
+        log(:error) { "Error while parsing path for tag relocatable in <#{context.ref_node.alcn}>: #{e.message}" }
+        context.dest_node.flag(:dirty)
       end
       result
     end
@@ -42,11 +31,18 @@ module Webgen::Tag
     private
     #######
 
-    # Resolve the path +uri+ using the reference node and return the correct relative path from the
+    # Resolve the path +path+ using the reference node and return the correct relative path from the
     # destination node.
-    def resolve_path(uri, context)
-      dest_node = context.ref_node.resolve(uri, context.dest_node.lang)
-      (dest_node ? context.dest_node.route_to(dest_node) : '')
+    def resolve_path(path, context)
+      dest_node = context.ref_node.resolve(path, context.dest_node.lang)
+      if dest_node
+        context.dest_node.node_info[:used_meta_info_nodes] << dest_node.alcn
+        context.dest_node.route_to(dest_node)
+      else
+        log(:error) { "Could not resolve path '#{path}' in <#{context.ref_node.alcn}>" }
+        context.dest_node.flag(:dirty)
+        ''
+      end
     end
 
   end

data/lib/webgen/tag/tikz.rb

@@ -32,16 +32,15 @@ EOF
     # Create a graphic from the commands in the body of the tag.
     def call(tag, body, context)
       path = param('tag.tikz.path')
-      path = Webgen::Common.absolute_path(path, context.ref_node.parent.absolute_lcn)
+      path = Webgen::Path.make_absolute(context.ref_node.parent.alcn, path)
 
       mem_handler = website.cache.instance('Webgen::SourceHandler::Memory')
       src_path = context.ref_node.node_info[:src]
       parent = website.blackboard.invoke(:create_directories, context.ref_node.tree.root, File.dirname(path), src_path)
       params = @params
 
-      node = website.blackboard.invoke(:create_nodes, parent.tree, parent.absolute_lcn,
-                                       Webgen::Path.new(path, src_path), mem_handler) do |node_parent, node_path|
-        mem_handler.create_node(node_parent, node_path, context.ref_node.absolute_lcn) do |pic_node|
+      node = website.blackboard.invoke(:create_nodes, Webgen::Path.new(path, src_path), mem_handler) do |node_path|
+        mem_handler.create_node(node_path, context.ref_node.alcn) do |pic_node|
           set_params(params)
           document = ERB.new(LATEX_TEMPLATE).result(binding)
           pic_path = compile(document, File.extname(path), context)
@@ -74,7 +73,7 @@ EOF
       output = `#{cmd_prefix} pdflatex --shell-escape -interaction=batchmode #{File.basename(file.path)}.tex`
       if $?.exitstatus != 0
         errors = output.scan(/^!(.*\n.*)/).join("\n")
-        log(:error) { "There was an error creating a TikZ picture in <#{context.ref_node.absolute_lcn}>: #{errors}"}
+        log(:error) { "There was an error creating a TikZ picture in <#{context.ref_node.alcn}>: #{errors}"}
         context.dest_node.flag(:dirty)
         nil
       else
@@ -106,7 +105,7 @@ EOF
     def run_command(cmd, context)
       output = `#{cmd}`
       if $?.exitstatus != 0
-        log(:error) { "There was an error running a command for a TikZ picture in <#{context.ref_node.absolute_lcn}>: #{output}"}
+        log(:error) { "There was an error running a command for a TikZ picture in <#{context.ref_node.alcn}>: #{output}"}
         context.dest_node.flag(:dirty)
         nil
       else

data/lib/webgen/tree.rb

@@ -47,12 +47,12 @@ module Webgen
 
     # A utility method called by Node#initialize. This method should not be used directly!
     def register_node(node)
-      if @node_access[:alcn].has_key?(node.absolute_lcn)
-        raise "Can't have two nodes with same absolute lcn: #{node.absolute_lcn}"
+      if @node_access[:alcn].has_key?(node.alcn)
+        raise "Can't have two nodes with same absolute lcn: #{node.alcn}"
       else
-        @node_access[:alcn][node.absolute_lcn] = node
+        @node_access[:alcn][node.alcn] = node
       end
-      (@node_access[:acn][node.absolute_cn] ||= []) << node
+      (@node_access[:acn][node.acn] ||= []) << node
       register_path(node)
     end
 
@@ -78,11 +78,11 @@ module Webgen
 
       website.blackboard.dispatch_msg(:before_node_deleted, n)
       n.parent.children.delete(n)
-      @node_access[:alcn].delete(n.absolute_lcn)
-      @node_access[:acn][n.absolute_cn].delete(n)
+      @node_access[:alcn].delete(n.alcn)
+      @node_access[:acn][n.acn].delete(n)
       @node_access[:path].delete(n.path)
 
-      node_info.delete(n.absolute_lcn)
+      node_info.delete(n.alcn)
     end
 
   end