webgen 0.5.1 → 0.5.2

data/lib/webgen/output.rb

@@ -15,6 +15,8 @@ module Webgen
   # <tt>write(path, data, type)</tt>::
   #   Write the data to the given output path. The parameter +type+ specifies the type of the
   #   to be written path: +:file+ or +:directory+.
+  # <tt>read(path)</tt>:
+  #   Return the content of the given path if it exists or raise an error otherwise.
   #
   module Output
 
@@ -22,8 +24,12 @@ module Webgen
 
     # Returns an instance of the configured output class.
     def self.instance
-      klass, *args = WebsiteAccess.website.config['output']
-      Object.constant(klass).new(*args)
+      classes = (WebsiteAccess.website.cache.volatile[:classes] ||= {})
+      unless classes.has_key?(:output_instance)
+        klass, *args = WebsiteAccess.website.config['output']
+        classes[:output_instance] = Object.constant(klass).new(*args)
+      end
+      classes[:output_instance]
     end
 
   end

data/lib/webgen/output/filesystem.rb

@@ -2,7 +2,8 @@ require 'fileutils'
 
 module Webgen::Output
 
-  # This class is used to write rendered nodes out to the file system.
+  # This class uses the file systems as output device. On initialization a +root+ path is set and
+  # all other operations are taken relative to this root path.
   class FileSystem
 
     include Webgen::WebsiteAccess
@@ -56,6 +57,11 @@ module Webgen::Output
       end
     end
 
+    # Return the content of the given +path+.
+    def read(path)
+      File.open(File.join(@root, path), 'rb') {|f| f.read}
+    end
+
   end
 
 end

data/lib/webgen/path.rb

@@ -63,11 +63,14 @@ module Webgen
       analyse(path)
     end
 
-    # Mount this path at the mount point +mp+ and return the new path object.
-    def mount_at(mp)
+    # Mount this path at the mount point +mp+ optionally stripping +prefix+ from the path and return
+    # the new path object.
+    def mount_at(mp, prefix = nil)
       temp = dup
-      temp.path = File.join(mp, @path)
-      if @path == '/'
+      temp.path = temp.path.sub(/^#{Regexp.escape(prefix.chomp("/"))}/, '') if prefix     #"
+      reanalyse = (@path == '/' || temp.path == '/')
+      temp.path = File.join(mp, temp.path)
+      if reanalyse
         temp.send(:analyse, temp.path)
       else
         temp.directory = File.join(File.dirname(temp.path), '/')

data/lib/webgen/source/filesystem.rb

@@ -1,3 +1,4 @@
+require 'pathname'
 require 'webgen/websiteaccess'
 require 'webgen/path'
 
@@ -11,9 +12,10 @@ module Webgen
 
       # Create a new object with absolute path +path+ for the file system path +fs_path+.
       def initialize(path, fs_path)
-        super(path) { File.open(fs_path, 'r') }
+        super(path) { File.open(fs_path, 'rb') }
         @fs_path = fs_path
         WebsiteAccess.website.cache[[:fs_path, @fs_path]] = File.mtime(@fs_path)
+        @meta_info['modified_at'] = File.mtime(@fs_path)
       end
 
       # Return +true+ if the file system path used by the object has been modified.
@@ -44,7 +46,7 @@ module Webgen
     # Return all paths under #root which match #glob.
     def paths
       @paths ||= Dir.glob(File.join(@root, @glob), File::FNM_DOTMATCH|File::FNM_CASEFOLD).to_set.collect! do |f|
-        temp = File.expand_path(f.sub(/^#{Regexp.escape(@root)}\/?/, '/'))
+        temp = Pathname.new(f.sub(/^#{Regexp.escape(@root)}\/?/, '/')).cleanpath.to_s
         temp += '/' if File.directory?(f) && temp[-1] != ?/
         path = Path.new(temp, f)
         path

data/lib/webgen/source/resource.rb

@@ -11,9 +11,16 @@ module Webgen::Source
     # The glob specifying the resources.
     attr_reader :glob
 
-    # Create a new resource source for the the +glob+.
-    def initialize(glob)
-      @glob = glob
+    # The glob specifying the paths that should be used from the resources.
+    attr_reader :paths_glob
+
+    # The prefix that should optionally be stripped from the paths.
+    attr_reader :strip_prefix
+
+    # Create a new resource source for the the +glob+ and use only those paths matching +paths_glob+
+    # while stripping +strip_prefix+ off the path.
+    def initialize(glob, paths_glob = nil, strip_prefix = nil)
+      @glob, @paths_glob, @strip_prefix = glob, paths_glob, strip_prefix
     end
 
     # Return all paths associated with the resources identified by #glob.
@@ -24,6 +31,8 @@ module Webgen::Source
           stack.add([['/', constant(infos.first).new(*infos[1..-1])]])
         end
         @paths = stack.paths
+        @paths = @paths.select {|p| File.fnmatch(@paths_glob, p)} if @paths_glob
+        @paths.collect! {|p| p.mount_at('/', @strip_prefix)} if @strip_prefix
       end
       @paths
     end

data/lib/webgen/sourcehandler.rb

@@ -31,6 +31,7 @@ module Webgen
       def initialize #:nodoc:
         website.blackboard.add_service(:create_nodes, method(:create_nodes))
         website.blackboard.add_service(:source_paths, method(:find_all_source_paths))
+        website.blackboard.add_listener(:node_meta_info_changed?, method(:meta_info_changed?))
       end
 
       # Render the nodes provided in the +tree+. Before the actual rendering is done, the sources
@@ -44,20 +45,19 @@ module Webgen
           while paths.length > 0
             used_paths += (paths = Set.new(find_all_source_paths.keys) - used_paths - clean(tree))
             create_nodes_from_paths(tree, paths)
+            website.cache.reset_volatile_cache
           end
         end
         puts "...done in " + ('%2.4f' % time.real) + ' seconds'
 
         output = website.blackboard.invoke(:output_instance)
 
-        # Enable permanent (till end of run) storing of volatile information
-        website.cache.enable_volatile_cache
-
         puts "Writing changed nodes..."
         time = Benchmark.measure do
           tree.node_access[:alcn].sort.each do |name, node|
+            node.dirty_meta_info = node.created = false
             next if node == tree.dummy_root || !node.dirty
-            node.dirty = node.created = false
+            node.dirty = false
 
             begin
               if !node['no_output'] && (content = node.content)
@@ -85,7 +85,7 @@ module Webgen
 
       # Return a hash with all source paths.
       def find_all_source_paths
-        if !@paths
+        if !defined?(@paths)
           source = Webgen::Source::Stacked.new(website.config['sources'].collect do |mp, name, *args|
                                                  [mp, constant(name).new(*args)]
                                                end)
@@ -134,8 +134,8 @@ module Webgen
           raise "The specified parent path <#{parent_path_name}> does not exist"
         end
         path = path.dup
-        path.meta_info.update(website.config['sourcehandler.default_meta_info'][:all])
-        path.meta_info.update(website.config['sourcehandler.default_meta_info'][source_handler.class.name] || {})
+        path.meta_info = default_meta_info(path, source_handler.class.name)
+        (website.cache[:sourcehandler_path_mi] ||= {})[[path.path, source_handler.class.name]] = path.meta_info.dup
         website.blackboard.dispatch_msg(:before_node_created, parent, path)
         *nodes = if block_given?
                    yield(parent, path)
@@ -148,12 +148,27 @@ module Webgen
         nodes
       end
 
+      # Return the default meta info for the pair of +path+ and +sh_name+.
+      def default_meta_info(path, sh_name)
+        path.meta_info.merge(website.config['sourcehandler.default_meta_info'][:all]).
+          merge(website.config['sourcehandler.default_meta_info'][sh_name] || {})
+      end
+
+      # Check if the default meta information for +node+ has changed since the last run.
+      def meta_info_changed?(node)
+        path = node.node_info[:src]
+        cached_mi = website.cache[:sourcehandler_path_mi][[path, node.node_info[:processor]]]
+        if !cached_mi || cached_mi != default_meta_info(@paths[path], node.node_info[:processor])
+          node.dirty_meta_info = true
+        end
+      end
 
       # Clean the +tree+ by deleting nodes which have changed or which don't have an associated
-      # source anymore.
+      # source anymore. Return all paths for which nodes need to be created.
       def clean(tree)
         paths_to_delete = Set.new
         paths_not_to_delete = Set.new
+        nodes_to_be_deleted = Set.new
         tree.node_access[:alcn].each do |alcn, node|
           next if node == tree.dummy_root || tree[alcn].nil?
 
@@ -162,13 +177,15 @@ module Webgen
                                find_all_source_paths[node.node_info[:src]].changed? ||
                                node.changed?)
             paths_not_to_delete << node.node_info[:src]
-            tree.delete_node(node, deleted)
-            #TODO: delete output path
+            nodes_to_be_deleted << [node, deleted]
           else
             paths_to_delete << node.node_info[:src]
           end
         end
 
+        nodes_to_be_deleted.each {|node, deleted| tree.delete_node(node, deleted)}
+        #TODO: delete output path
+
         # source paths that should be used
         paths_to_delete - paths_not_to_delete
       end

data/lib/webgen/sourcehandler/fragment.rb

@@ -47,17 +47,22 @@ module Webgen::SourceHandler
     end
 
     # Create nested fragment nodes under +parent+ from +sections+ (which can be created using
-    # +parse_html_headers+). The meta information +in_menu+ of the fragment nodes is set to the
-    # parameter +in_menu+ and the meta info +sort_info+ is calculated from the base +si+ value.
-    def create_fragment_nodes(sections, parent, in_menu, si = 1000 )
+    # +parse_html_headers+). +path+ is the source path that defines the fragments. The meta
+    # information +in_menu+ of the fragment nodes is set to the parameter +in_menu+ and the meta
+    # info +sort_info+ is calculated from the base +si+ value.
+    def create_fragment_nodes(sections, parent, path, in_menu, si = 1000 )
       sections.each do |level, id, title, sub_sections|
         node = website.blackboard.invoke(:create_nodes, parent.tree, parent.absolute_lcn,
-                                         Webgen::Path.new('#' + id), self).first
+                                         path, self) do |cn_parent, cn_path|
+          ptemp = Webgen::Path.new('#' + id)
+          ptemp.meta_info = cn_path.meta_info.merge(ptemp.meta_info)
+          create_node(cn_parent, ptemp)
+        end.first
         node['title'] = title
         node['in_menu'] = in_menu
         node['sort_info'] = si = si.succ
-        node.node_info[:src] = parent.node_info[:src]
-        create_fragment_nodes(sub_sections, node, in_menu, si.succ)
+        node.node_info[:src] = path.path
+        create_fragment_nodes(sub_sections, node, path, in_menu, si.succ)
       end
     end
 

data/lib/webgen/sourcehandler/metainfo.rb

@@ -1,3 +1,4 @@
+require 'pathname'
 require 'yaml'
 require 'webgen/sourcehandler/base'
 require 'webgen/websiteaccess'
@@ -28,7 +29,7 @@ module Webgen::SourceHandler
         [[:mi_paths, 'paths'], [:mi_alcn, 'alcn']].each do |mi_key, block_name|
           node.node_info[mi_key] = {}
           YAML::load(page.blocks[block_name].content).each do |key, value|
-            key = File.expand_path(key =~ /^\// ? key : File.join(parent.absolute_lcn, key))
+            key = Pathname.new(key =~ /^\// ? key : File.join(parent.absolute_lcn, key)).cleanpath.to_s
             node.node_info[mi_key][key.chomp('/')] = value
           end if page.blocks.has_key?(block_name)
         end

data/lib/webgen/sourcehandler/page.rb

@@ -9,6 +9,10 @@ module Webgen::SourceHandler
     include Webgen::WebsiteAccess
     include Base
 
+    def initialize #:nodoc:
+      website.blackboard.add_listener(:node_meta_info_changed?, method(:meta_info_changed?))
+    end
+
     # Create a page file from +parent+ and +path+.
     def create_node(parent, path)
       page = page_from_path(path)
@@ -16,6 +20,8 @@ module Webgen::SourceHandler
       path.ext = 'html' if path.ext == 'page'
 
       super(parent, path) do |node|
+        website.cache[[:sh_page_node_mi, node.absolute_lcn]] = node.meta_info.dup
+
         node.node_info[:page] = page
         tmp_logger = website.logger
         website.logger = nil    # disabling logging whiling creating fragment nodes
@@ -29,7 +35,8 @@ module Webgen::SourceHandler
         website.cache.permanent[:page_sections][node.absolute_lcn] = sections
         website.blackboard.invoke(:create_fragment_nodes,
                                   sections,
-                                  node, node.meta_info['fragments_in_menu'])
+                                  node, website.blackboard.invoke(:source_paths)[path.path],
+                                  node.meta_info['fragments_in_menu'])
         website.logger = tmp_logger
       end
     end
@@ -50,6 +57,19 @@ module Webgen::SourceHandler
     end
     alias_method :content, :render_node
 
+    #######
+    private
+    #######
+
+    # Checks if the meta information provided by the file in Webgen Page Format changed.
+    def meta_info_changed?(node)
+      return if !node.created || node.node_info[:processor] != self.class.name
+      ckey = [:sh_page_node_mi, node.absolute_lcn]
+      if website.cache.old_data[ckey]  != website.cache.new_data[ckey]
+        node.dirty_meta_info = true
+      end
+    end
+
   end
 
 end

data/lib/webgen/tag/breadcrumbtrail.rb

@@ -23,8 +23,8 @@ module Webgen::Tag
       node = node.parent if omit_index_path
 
       until node == node.tree.dummy_root
-        context.dest_node.node_info[:used_nodes] << node.routing_node(context.dest_node.lang).absolute_lcn
-        context.dest_node.node_info[:used_nodes] << node.absolute_lcn
+        context.dest_node.node_info[:used_meta_info_nodes] << node.routing_node(context.dest_node.lang).absolute_lcn
+        context.dest_node.node_info[:used_meta_info_nodes] << node.absolute_lcn
         out.push(context.dest_node.link_to(node.in_lang(context.content_node.lang)))
         node = node.parent
       end

data/lib/webgen/tag/executecommand.rb

@@ -1,6 +1,7 @@
 require 'webgen/tag'
 require 'cgi'
 require "tempfile"
+require 'rbconfig'
 
 module Webgen::Tag
 
@@ -10,10 +11,12 @@ module Webgen::Tag
 
     include Webgen::Tag::Base
 
+    BIT_BUCKET = (Config::CONFIG['arch'].include?('mswin32') ?  "nul" : "/dev/null")
+
     # Execute the command and return the standard output.
     def call(tag, body, context)
       command = param('tag.executecommand.command')
-      output = `#{command} 2> /dev/null`
+      output = `#{command} 2> #{BIT_BUCKET}`
       if ($? >> 8) != 0
         raise "Command '#{command}' in <#{context.ref_node.absolute_lcn}> has return value != 0: #{output}"
       end

data/lib/webgen/tag/includefile.rb

@@ -20,7 +20,7 @@ module Webgen::Tag
     def call(tag, body, context)
       filename = param('tag.includefile.filename')
       filename = File.join(website.directory, filename) unless filename =~ /^(\/|\w:)/
-      content = File.read(filename)
+      content = File.open(filename, 'rb') {|f| f.read}
       content = CGI::escapeHTML(content) if param('tag.includefile.escape_html')
       (context.dest_node.node_info[:tag_includefile_filenames] ||= []) << [filename, File.mtime(filename)]
 

data/lib/webgen/tag/langbar.rb

@@ -1,4 +1,5 @@
 require 'webgen/tag'
+require 'webgen/websiteaccess'
 
 module Webgen::Tag
 
@@ -6,17 +7,44 @@ module Webgen::Tag
   class Langbar
 
     include Webgen::Tag::Base
+    include Webgen::WebsiteAccess
+
+    def initialize #:nodoc:
+      website.blackboard.add_listener(:node_changed?, method(:node_changed?))
+    end
 
     # Return a list of all translations of the content page.
     def call(tag, body, context)
-      lang_nodes = context.content_node.tree.node_access[:acn][context.content_node.absolute_cn]
-      nr_langs = lang_nodes.length
+      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}
       result = lang_nodes.
-        reject {|n| (context.content_node.lang == n.lang && !param('tag.langbar.show_own_lang')) }.
+        reject {|n| (context.content_node.lang == n.lang && !param('tag.langbar.show_own_lang'))}.
         sort {|a, b| a.lang <=> b.lang}.
         collect {|n| context.dest_node.link_to(n, :link_text => n.lang)}.
         join(param('tag.langbar.separator'))
-      (param('tag.langbar.show_single_lang') || nr_langs > 1 ? result : "")
+      (param('tag.langbar.show_single_lang') || lang_nodes.length > 1 ? result : "")
+    end
+
+    #######
+    private
+    #######
+
+    # Return all nodes with the same absolute cn as +node+.
+    def all_lang_nodes(node)
+      node.tree.node_access[:acn][node.absolute_cn]
+    end
+
+    # Check if the langbar tag for +node+ changed.
+    def node_changed?(node)
+      return unless (cdata = node.node_info[:tag_langbar_data])
+      cdata.each do |acn, clang_nodes|
+        lang_nodes = all_lang_nodes(node.tree[acn, :acn]) rescue nil
+        if !lang_nodes || lang_nodes.length != clang_nodes.length ||
+            lang_nodes.any? {|n| n.meta_info_changed?}
+          node.dirty = true
+          break
+        end
+      end
     end
 
   end

data/lib/webgen/tag/menu.rb

@@ -21,6 +21,9 @@ module Webgen::Tag
       # The encapsulated node.
       attr_reader :node
 
+      # Set to +true+ if the menu node is in the tree of files.
+      attr_writer :is_in_tree_of_files
+
       # Create a new menu node under +parent+ for the real node +node+.
       def initialize(parent, node)
         @parent = parent
@@ -28,6 +31,11 @@ module Webgen::Tag
         @children = []
       end
 
+      # Return +true+ if the menu node is in the menu tree of only files.
+      def is_in_tree_of_files?
+        @is_in_tree_of_files
+      end
+
       # Sort recursively all children of the node using the wrapped nodes.
       def sort!
         self.children.sort! {|a,b| a.node <=> b.node}
@@ -77,7 +85,9 @@ module Webgen::Tag
         set_params({})
 
         if (tree.nil? && !cached_tree.nil?) || (tree_list && tree_list != cached_tree) ||
-            (tree_list && tree_list.flatten.any? {|alcn| (n = node.tree[alcn]) && (r = n.routing_node(cn.lang)) && r != node && r.changed?})
+            (tree_list && tree_list.flatten.any? do |alcn|
+               (n = node.tree[alcn]) && (r = n.routing_node(cn.lang)) && r != node && r.meta_info_changed?
+             end)
           node.dirty = true
           break
         end
@@ -110,7 +120,7 @@ module Webgen::Tag
       sub_menu_tree = MenuNode.new(nil, menu_node.node)
       menu_tree = MenuNode.new(nil, menu_node.node)
       menu_node.children.each do |child|
-        next if param('tag.menu.used_nodes') == 'files' && !is_in_menu_tree_of_files?(child)
+        next if param('tag.menu.used_nodes') == 'files' && !child.is_in_tree_of_files?
         menu_tree.children << (this_node = MenuNode.new(menu_tree, child.node))
         sub_node = child.children.length > 0 ? build_specific_menu_tree(content_node, child, level + 1) : nil
         sub_node.children.each {|n| this_node.children << n; sub_menu_tree.children << n} if sub_node
@@ -123,11 +133,6 @@ module Webgen::Tag
       end
     end
 
-    # Return +true+ if +menu_node+ is in the menu tree without fragment nodes.
-    def is_in_menu_tree_of_files?(menu_node)
-      (!menu_node.node.is_fragment? && menu_node.node['in_menu']) || menu_node.children.any? {|c| is_in_menu_tree_of_files?(c)}
-    end
-
     # Create the HTML menu of the +tree+ using the provided +context+.
     def create_output(context, tree)
       out = "<ul>"
@@ -177,11 +182,11 @@ module Webgen::Tag
         sub_node = create_menu_tree(child, menu_node, lang)
         menu_node.children << sub_node unless sub_node.nil?
       end
+      menu_node.is_in_tree_of_files = (!node.is_fragment? && node['in_menu']) || menu_node.children.any? {|c| c.is_in_tree_of_files?}
 
       menu_node.children.empty? ? (node['in_menu'] ? menu_node : nil) : menu_node
     end
 
-
   end
 
 end