webgen 0.3.4 → 0.3.5

data/lib/webgen/plugins/menustyles/vertical.rb

@@ -0,0 +1,107 @@
+#
+#--
+#
+# $Id: vertical.rb 293 2005-06-11 08:37:51Z 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/menustyles/defaultmenustyle'
+
+module MenuStyles
+
+  class VerticalMenuStyle < MenuStyles::DefaultMenuStyle
+
+    summary "Builds a vertical menu"
+
+    register_menu_style 'vertical'
+
+    add_param 'level', 1, \
+    'Specifies how many levels the menu should have by default, ie. how deep it is. ' \
+    'For example, if level = 3, then three levels are always shown at least.'
+    add_param 'subtreeLevel', 3, \
+    'Specifies how many levels should be shown for subtrees. The number specifies ' \
+    'the maximum depth the menu will have.'
+    add_param 'showCurrentSubtreeOnly', true, \
+    'True if only the current subtree should be shown in the menu. If set to false, ' \
+    'each subtree will be shown.'
+
+    CSS = "
+/* START Webgen vertical menu style */
+.webgen-menu-vert li > ul {
+  font-size: 95%;
+}
+
+.webgen-menu-vert ul {
+  padding: 0px;
+  margin-left: 10px;
+}
+
+.webgen-menu-vert li {
+  padding-left: 5px;
+}
+
+.webgen-menu-vert .webgen-menu-submenu-inhierarchy > a {
+  font-weight: bold;
+}
+
+.webgen-menu-vert .webgen-menu-item-selected > a {
+  font-weight: bold;
+}
+/* STOP Webgen vertical menu style */
+"
+
+    def internal_build_menu( srcNode, menuTree )
+      unless defined?( @css_added )
+        Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
+        @css_added = true
+      end
+      "<div class=\"webgen-menu-vert #{get_param('divClass')}\">#{submenu( srcNode, menuTree, 1 )}</div>"
+    end
+
+    #######
+    private
+    #######
+
+    def submenu( srcNode, node, level )
+      if node.nil? \
+        || level > get_param( 'subtreeLevel' ) \
+        || ( level > get_param( 'level' ) \
+             && ( node['node'].level > srcNode.level \
+                  || ( get_param( 'showCurrentSubtreeOnly' ) && !srcNode.in_subtree?( node['node'] ) )
+                  )
+             )
+        return ''
+      end
+
+      out = "<ul>"
+      node.each do |child|
+        menu = child['node']['int:directory?'] ? submenu( srcNode, child, level + 1 ) : ''
+        style, link = menu_item_details( srcNode, child['node'] )
+
+        out << "<li #{style}>#{link}"
+        out << menu
+        out << "</li>"
+      end
+      out << "</ul>"
+
+      return out
+    end
+
+  end
+
+end

data/lib/webgen/plugins/menustyles/vertical_dropdown.rb

@@ -0,0 +1,107 @@
+#
+#--
+#
+# $Id: vertical_dropdown.rb 300 2005-06-14 10:04:17Z 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/menustyles/defaultmenustyle'
+
+module MenuStyles
+
+  class VerticalDropdownMenuStyle < MenuStyles::DefaultMenuStyle
+
+    summary "Builds a vertical menu with CSS drop down submenus"
+
+    register_menu_style 'vertical-dropdown'
+
+    CSS = "
+/* START Webgen vertical dropdown menu style */
+.webgen-menu-vert-dd ul {
+  list-style-type: none;
+  margin: 0;
+  padding: 0;
+  width: 15em;
+}
+
+.webgen-menu-vert-dd ul ul {
+  border: 1px solid black;
+  position: absolute;
+  z-index: 500;
+  left: 100%;
+  top: 0;
+}
+
+.webgen-menu-vert-dd a {
+  display: block;
+  margin: 0px;
+  padding: 3px 3px;
+  background-color: white;
+}
+
+.webgen-menu-vert-dd li {
+  position: relative;
+}
+
+.webgen-menu-vert-dd ul ul {
+  display: none;
+}
+
+.webgen-menu-vert-dd ul li:hover > ul > ul {
+  display: none;
+}
+
+.webgen-menu-vert-dd ul li:hover > ul {
+  display: block;
+}
+/* STOP Webgen vertical dropdown menu style */
+"
+
+    def internal_build_menu( srcNode, menuTree )
+      unless defined?( @css_added )
+        Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
+        @css_added = true
+      end
+      "<div class=\"webgen-menu-vert-dd #{get_param('divClass')}\">#{submenu( srcNode, menuTree, 1 )}</div>"
+    end
+
+    #######
+    private
+    #######
+
+    def submenu( srcNode, node, level )
+      out = ''
+      out = "<ul>" if level > 1
+      node.each do |child|
+        menu = child['node']['int:directory?'] ? submenu( srcNode, child, level + 1 ) : ''
+        style, link = menu_item_details( srcNode, child['node'] )
+
+        out << "<ul>" if level == 1
+        out << "<li #{style}>#{link}"
+        out << menu
+        out << "</li>"
+        out << "</ul>" if level == 1
+      end
+      out << "</ul>" if level > 1
+
+      return out
+    end
+
+  end
+
+end

data/lib/webgen/plugins/resourcemanager.rb

@@ -0,0 +1,264 @@
+#
+#--
+#
+# $Id: resourcemanager.rb 300 2005-06-14 10:04:17Z 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 'rbconfig'
+require 'fileutils'
+require 'webgen/plugins/tags/tags'
+require 'webgen/plugins/filehandler/filehandler'
+
+module Webgen
+
+  class ResourceManager < Plugin
+
+    class Resource
+
+      attr_reader :name
+      attr_reader :output_path
+      attr_accessor :predefined
+      attr_accessor :type
+
+      def initialize( name, type, output_path )
+        @name = name
+        @type = type
+        @output_path = output_path.sub( /^\//, '' )
+        @used = false
+      end
+
+      # Returns the relative path from the node to the resource.
+      def relpath_from_node( node )
+        node.relpath_to_string( '/' + @output_path )
+      end
+
+      # Returns the complete destination path.
+      def dest_path
+        File.join( Webgen::Plugin['Configuration']['outDirectory'], @output_path )
+      end
+
+      # Mark the resource as referenced. Only referenced resources are written to the output directory.
+      def referenced!
+        @referenced = true
+      end
+
+      # Has the resource been used somewhere?
+      def referenced?
+        @referenced
+      end
+
+      # Can the resource be written to the output directory?
+      def write_resource?
+        @referenced
+      end
+
+      # Write the resource to the output directory.
+      def write_resource
+        raise NotImplementedError
+      end
+
+    end
+
+    class FileResource < Resource
+
+      attr_reader :res_path
+
+      def initialize( name, output_path, res_path )
+        super( name, :file, output_path )
+        @res_path = res_path
+      end
+
+      def data
+        File.read( @res_path )
+      end
+
+      def write_resource?
+        referenced? && Webgen::Plugin['FileHandler'].file_modified?( @res_path, dest_path )
+      end
+
+      def write_resource
+        FileUtils.cp( res_path, dest_path ) if write_resource?
+      end
+
+    end
+
+    class MemoryResource < Resource
+
+      def initialize( name, output_path )
+        super( name, :memory, output_path )
+        @data = ''
+      end
+
+      def data
+        @data
+      end
+
+      def append_data( data )
+        @data << data
+      end
+
+      def write_resource
+        File.open( dest_path, 'w' ) {|file| file.write( data )} if write_resource?
+      end
+
+    end
+
+
+    summary "Provides access to pre- and userdefined resources"
+    description "The resource manager manages a list of predefined and " \
+    "userdefined resources. These resources can be used in page files."
+    add_param 'resources', [], 'User defined file resources. Value has to be an array of arrays with three strings defining '\
+    'name, resource path and output path'
+
+    depends_on 'FileHandler'
+
+    attr_reader :data_dir
+
+    def initialize
+      Plugin.config[self.class].resources = {}
+      Plugin['FileHandler'].add_msg_listener( :AFTER_ALL_WRITTEN, method( :write_resources ) )
+      define_webgen_resources unless Webgen::Configuration.data_dir.empty?
+      define_user_resources
+    end
+
+
+    # Adds an exisiting file resource which can be referenced later by using +name+. The +output_path+
+    # should be an absolute path, like +/images/logo.png+. If not, it will be relative to the output
+    # directory.
+    def define_file_resource( name, resource_path, output_path )
+      if !File.exists?( resource_path )
+        logger.error { "Path <#{resource_path}> for resource #{name} is invalid!" }
+      else
+        define_resource( name, FileResource.new( name, output_path, resource_path ) )
+      end
+    end
+
+
+    # Adds a new resource which can be referenced later by using +name+. The +output_path+
+    # should be an absolute path, like +/images/logo.png+. If not, it will be relative to the output
+    # directory.
+    def define_memory_resource( name, output_path )
+      define_resource( name, MemoryResource.new( name, output_path ) )
+    end
+
+
+    # Returns the requested resource.
+    def get_resource( name )
+      Plugin.config[self.class].resources[name]
+    end
+
+
+    # Appends given +data+ to the resource +name+. Data can only be appended to memory resources!
+    def append_data( name, data )
+      if (res = get_resource( name )) && res.type == :memory
+        res.append_data( data )
+      else
+        logger.error {"Resource #{name} does not exist or data cannot be appended to it!" }
+      end
+    end
+
+    #######
+    private
+    #######
+
+    def define_resource( name, res )
+      if Plugin.config[self.class].resources.has_key?( name )
+        logger.error { "Resource #{name} already defined, not using new definition (#{res.inspect})" }
+      else
+        logger.info { "Adding resource #{name} to pool (#{res.inspect})" }
+        Plugin.config[self.class].resources[name] = res
+      end
+    end
+
+    def define_webgen_resources
+      define_file_resource( 'webgen-logo', File.join( Webgen::Configuration.data_dir, 'images', 'webgen_logo.png' ),
+                            '/images/webgen-logo.png' ).predefined = "The logo of webgen as seen on the homepage."
+      define_file_resource( 'webgen-generated', File.join( Webgen::Configuration.data_dir, 'images', 'generated_by_webgen.png' ),
+                            '/images/webgen-generated-by.png' ).predefined = "A 88x31 image for use on web sites that were generated by webgen."
+      define_file_resource( 'w3c-valid-css', File.join( Webgen::Configuration.data_dir, 'images', 'valid-css.gif' ),
+                            '/images/w3c-valid-css.gif' ).predefined = 'The W3C image for valid css.'
+      define_file_resource( 'w3c-valid-xhtml11', File.join( Webgen::Configuration.data_dir, 'images', 'valid-xhtml11.png' ),
+                            '/images/w3c-valid-xhtml11.png' ).predefined = "The W3C image for valid XHTML1.1"
+
+      define_memory_resource( 'webgen-css', '/css/webgen.css' ).predefined = "Plugins use this resource for their CSS styles."
+      define_memory_resource( 'webgen-javascript', '/css/webgen.js' ).predefined = "Plugins use this resource for their Javascript fragments."
+    end
+
+    def define_user_resources
+      p = get_param( 'resources' )
+      if !p.kind_of?( Array ) || p.find {|h| !h.kind_of?( Array ) || h.length != 3}
+        logger.error { "Parameter resources not correctly structured!" }
+        return
+      end
+      p.each {|name, res_path, out_path| define_file_resource( name, res_path, out_path ) }
+    end
+
+
+    def write_resources
+      Plugin.config[self.class].resources.each do |name, res|
+        if res.write_resource?
+          begin
+            FileUtils.makedirs( File.dirname( res.dest_path ) )
+            res.write_resource
+            logger.info { "Resource #{name} written to <#{res.dest_path}>" }
+          rescue Exception => e
+            logger.error { "Error while writing resource #{name}: #{e.message}" }
+          end
+        end
+      end
+    end
+
+  end
+
+end
+
+
+module Tags
+
+  class ResourceTag < DefaultTag
+
+    summary "Used for referencing resources"
+    description "This tag should be used output the path to a resource or the resource itself."
+
+    add_param 'name', nil, 'The name of the resource'
+    add_param 'insert', :path, 'What should be returned by the tag: the path to the resource (value :path) ' \
+    'or the data (value :data)'
+
+    set_mandatory 'name', true
+
+    depends_on 'Tags'
+
+    def initialize
+      super
+      register_tag( 'resource' )
+    end
+
+    def process_tag( tag, node, refNode )
+      result = ''
+      if res = Webgen::Plugin['ResourceManager'].get_resource( get_param( 'name' ) )
+        result = (get_param( 'insert' ) == :path ? res.referenced! && res.relpath_from_node( node ) : res.data )
+      else
+        logger.error { "Could not retrieve resource #{get_param( 'name' )} as it does not exist!" }
+      end
+      result
+    end
+
+  end
+
+end