webgen 0.4.7 → 0.5.0

data/lib/webgen/plugins/coreplugins/resourcemanager.rb

@@ -1,307 +0,0 @@
-#
-#--
-#
-# $Id: resourcemanager.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 'fileutils'
-load_plugin 'webgen/plugins/tags/tag_processor'
-load_plugin 'webgen/plugins/filehandlers/filehandler'
-
-module CorePlugins
-
-  # Handles resources in webgen.
-  class ResourceManager < Webgen::Plugin
-
-    # The base class for all resources.
-    class Resource
-
-      # The unique name of the resource.
-      attr_reader :name
-
-      # The output path.
-      attr_reader :output_path
-
-      # Specifies if this resource is predefined. This is only used internally by webgen!
-      attr_accessor :predefined
-
-      # The type of resource: file or memory.
-      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 route_from( node )
-        node.route_to( '/' + @output_path )
-      end
-
-      # Returns the complete destination path.
-      def dest_path( root_dir )
-        File.join( root_dir, @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?( root_dir, file_handler )
-        @referenced
-      end
-
-      # Write the resource to the output directory.
-      def write_resource( root_dir, file_handler )
-        raise NotImplementedError
-      end
-
-    end
-
-    # Describes a file resource.
-    class FileResource < Resource
-
-      # The path to the file the resource references.
-      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?( root_dir, file_handler )
-        referenced? && file_handler.file_modified?( @res_path, dest_path( root_dir ) )
-      end
-
-      def write_resource( root_dir, file_handler )
-        FileUtils.cp( res_path, dest_path( root_dir ) ) if write_resource?( root_dir, file_handler )
-      end
-
-    end
-
-    # Describes a memory resource.
-    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( root_dir, file_handler )
-        File.open( dest_path( root_dir ), 'w' ) {|file| file.write( data )} if write_resource?( root_dir, file_handler )
-      end
-
-    end
-
-
-    infos( :name => 'Core/ResourceManager',
-           :author => Webgen::AUTHOR,
-           :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, for example, in page files."
-          )
-
-    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 'Core/FileHandler'
-
-
-    # Returns all defined resources.
-    attr_reader :resources
-
-
-    def initialize( plugin_manager )
-      super
-      @plugin_manager['Core/FileHandler'].add_msg_listener( :after_all_nodes_written, method( :write_resources ) )
-      @resources = {}
-      define_webgen_resources unless Webgen.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 )
-        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
-
-    # Assigns the resource +res+ the name +name+.
-    def define_resource( name, res )
-      @resources[name] = res unless @resources.has_key?( name )
-    end
-
-    # Returns the requested resource.
-    def get_resource( name )
-      @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
-        log(:error) {"Resource #{name} does not exist or data cannot be appended to it!" }
-      end
-    end
-
-    #######
-    private
-    #######
-
-    def define_webgen_resources
-      define_file_resource( 'webgen-logo', File.join( Webgen.data_dir, 'resources', '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.data_dir, 'resources', '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.data_dir, 'resources', '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.data_dir, 'resources', 'images', 'valid-xhtml11.png' ),
-                            '/images/w3c-valid-xhtml11.png'
-                            ).predefined = "The W3C image for valid XHTML1.1"
-
-      define_webgen_emoticons
-      define_webgen_icons
-
-      define_memory_resource( 'webgen-css', '/css/webgen.css'
-                              ).predefined = "Plugins use this resource for adding their CSS styles."
-      define_memory_resource( 'webgen-javascript', '/js/webgen.js'
-                              ).predefined = "Plugins use this resource for adding their Javascript fragments."
-    end
-
-    def define_webgen_emoticons
-      Dir.glob(File.join( Webgen.data_dir, 'resources', 'emoticons', '*/'), File::FNM_CASEFOLD ).each do |pack_dir|
-        pack = File.basename( pack_dir )
-        Dir.glob( File.join( pack_dir, '*' ), File::FNM_CASEFOLD ).each do |smiley_file|
-          smiley = File.basename( smiley_file, '.*' )
-          res = define_file_resource( "webgen-emoticons-#{pack}-#{smiley}",
-                                      smiley_file,
-                                      "/images/emoticons/#{pack}-#{File.basename(smiley_file)}" )
-          res.predefined = "Emoticon from pack '#{pack}' for '#{smiley}'"
-        end
-      end
-    end
-
-    def define_webgen_icons
-      base_dir = File.join( Webgen.data_dir, 'resources', 'icons' )
-      Dir.glob( File.join( base_dir, '**/*'), File::FNM_CASEFOLD ).each do |icon|
-        dirs = File.dirname( icon ).sub( /^#{base_dir}/, '' ).split( '/' ).join( '-' )
-        dirs += '-' if dirs.length > 0
-        res = define_file_resource( "webgen-icons-#{dirs}#{File.basename( icon, '.*' )}",
-                                    icon,
-                                    "/images/icons/#{dirs}#{File.basename(icon)}" )
-        res.predefined = "Icon named #{File.basename(icon)}"
-      end
-    end
-
-    def define_user_resources
-      p = param( 'resources' )
-      if !p.kind_of?( Array ) || p.find {|h| !h.kind_of?( Array ) || h.length != 3}
-        log(: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( root )
-      outDir = @plugin_manager.param_for_plugin( 'Core/Configuration', 'outDir' )
-
-      @resources.each do |name, res|
-        if res.write_resource?( outDir, @plugin_manager['Core/FileHandler'] )
-          begin
-            FileUtils.makedirs( File.dirname( res.dest_path( outDir ) ) )
-            res.write_resource( outDir, @plugin_manager['Core/FileHandler'] )
-            log(:info) { "Resource '#{name}' written to <#{res.dest_path( outDir )}>" }
-          rescue Exception => e
-            log(:error) { "Error while writing resource '#{name}': #{e.message}" }
-          end
-        end
-      end
-    end
-
-  end
-
-end
-
-
-module Tags
-
-  class ResourceTag < DefaultTag
-
-    infos( :name => 'Tag/Resource',
-           :author => Webgen::AUTHOR,
-           :summary => "Used for referencing resources",
-           :description => "This tag can be used to output the path to a resource or the resource itself."
-          )
-
-    param 'name', nil, 'The name of the resource'
-    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
-
-    register_tag 'resource'
-
-    def process_tag( tag, chain )
-      result = ''
-      if res = @plugin_manager['Core/ResourceManager'].get_resource( param( 'name' ) )
-        result = (param( 'insert' ) == :path ? res.referenced! && res.route_from( chain.last ) : res.data )
-      else
-        log(:error) { "Could not use resource #{param( 'name' )} as it does not exist!" }
-      end
-      result
-    end
-
-  end
-
-end

data/lib/webgen/plugins/filehandlers/copy.rb

@@ -1,82 +0,0 @@
-#
-#--
-#
-# $Id: copy.rb 538 2006-12-18 08:52:02Z 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 'fileutils'
-require 'erb'
-load_plugin 'webgen/plugins/filehandlers/filehandler'
-
-module FileHandlers
-
-  # A simple file handler which copies files specified by a pattern from the source to the output
-  # directory.
-  class CopyHandler < DefaultHandler
-
-    infos( :name => 'File/CopyHandler',
-           :author => Webgen::AUTHOR,
-           :summary => "Copies files from source to destination"
-           )
-
-    param 'paths', ['**/*.css', '**/*.js', '**/*.jpg', '**/*.png', '**/*.gif'], 'The path patterns ' +
-      'which match the files that should get copied by this handler.'
-
-    param 'erbPaths', ['**/*.rhtml', '**/*.rcss'], 'The path patterns which match the files ' +
-      'that should get preprocessed by ERB. The leading letter r is removed from the extension.'
-
-    def initialize( plugin_manager )
-      super
-      param( 'paths' ).each {|path| register_path_pattern( path ) }
-      param( 'erbPaths' ).each {|path| register_path_pattern( path ) }
-    end
-
-    def create_node( path, parent, meta_info )
-      processWithErb = param( 'erbPaths' ).any? {|pattern| File.fnmatch( pattern, path, File::FNM_DOTMATCH )}
-      name = File.basename( path )
-      name = name.sub( /\.r([^.]+)$/, '.\1' ) if processWithErb
-
-      node = parent.find {|c| c =~ name }
-      if node.nil?
-        node = Node.new( parent, name )
-        node['title'] = name
-        node.meta_info.update( meta_info )
-        node.node_info[:src] = path
-        node.node_info[:processor] = self
-        node.node_info[:preprocess] = processWithErb
-      else
-        log(:warn) { "Can't create node <#{node.full_path}> as it already exists (node handled by #{node.node_info[:processor].class.plugin_name})!" }
-      end
-      node
-    end
-
-    # Copy the file to the destination directory if it has been modified.
-    def write_node( node )
-      if @plugin_manager['Core/FileHandler'].file_modified?( node.node_info[:src], node.full_path )
-        if node.node_info[:preprocess]
-          File.open( node.full_path, 'w+' ) {|f| f.write( ERB.new( File.read( node.node_info[:src] ) ).result( binding ) ) }
-        else
-          FileUtils.cp( node.node_info[:src], node.full_path )
-        end
-      end
-    end
-
-  end
-
-end

data/lib/webgen/plugins/filehandlers/directory.rb

@@ -1,126 +0,0 @@
-#
-#--
-#
-# $Id: directory.rb 548 2006-12-23 14:45:53Z 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/filehandlers/filehandler.rb'
-require 'webgen/node'
-
-module FileHandlers
-
-  # Handles directories.
-  class DirectoryHandler < DefaultHandler
-
-    # Specialized node for a directory.
-    class DirNode < Node
-
-      def initialize( parent, path, meta_info = {} )
-        super( parent, path )
-        self.meta_info = meta_info
-        self['title'] = File.basename( path ).capitalize
-      end
-
-      def []( name )
-        process_dir_index if name == 'indexFile' &&
-          (!self.meta_info.has_key?( 'indexFile' ) ||
-           (!self.meta_info['indexFile'].nil? && !self.meta_info['indexFile'].kind_of?( Node ) ) )
-        super
-      end
-
-      #######
-      private
-      #######
-
-      def process_dir_index
-        indexFile = self.meta_info['indexFile']
-        if indexFile.nil?
-          self['indexFile'] = nil
-        else
-          node = resolve_node( indexFile )
-          if node
-            node_info[:processor].log(:info) { "Directory index file for <#{self.full_path}> => <#{node.full_path}>" }
-            self['indexFile'] = node
-          else
-            node_info[:processor].log(:warn) { "No directory index file found for directory <#{self.full_path}>" }
-            self['indexFile'] = nil
-          end
-        end
-      end
-
-    end
-
-
-    infos( :name => 'File/DirectoryHandler',
-           :author => Webgen::AUTHOR,
-           :summary => "Handles directories"
-           )
-
-    default_meta_info( { 'indexFile' => 'index.page' } )
-
-    register_path_pattern '**/', 0
-
-
-    # Returns a new DirNode.
-    def create_node( path, parent, meta_info )
-      filename = File.basename( path ) + '/'
-      if parent.nil? || (node = parent.find {|child| child =~ filename }).nil?
-        node = DirNode.new( parent, filename, meta_info )
-        node.node_info[:processor] = self
-        node.node_info[:src] = path
-      end
-      node
-    end
-
-    # Creates the directory (and all its parent directories if necessary).
-    def write_node( node )
-      FileUtils.makedirs( node.full_path ) unless File.exists?( node.full_path )
-    end
-
-    # Return the page node for the directory +node+ using the specified language +lang+. If an
-    # index file is specified, then the its correct language node is returned, else +node+ is
-    # returned.
-    def node_for_lang( node, lang )
-      langnode = node['indexFile'].node_for_lang( lang ) if node['indexFile']
-      langnode || node
-    end
-
-    # See DefaultFileHandler#link_from and PageHandler#link_from.
-    def link_from( node, ref_node, attr = {} )
-      lang_node = (attr[:resolve_lang_node] == false ? node : node.node_for_lang( ref_node['lang'] ) )
-      attr[:link_text] ||=  lang_node['directoryName'] || node['title']
-      super( lang_node, ref_node, attr )
-    end
-
-    # Recursively creates a given directory path starting from the path of +parent+ and returns the
-    # bottom most directory node.
-    def recursive_create_path( path, parent )
-      path.split( File::SEPARATOR ).each do |pathname|
-        case pathname
-        when '.' then  #do nothing
-        when '..' then parent = parent.parent
-        else parent = @plugin_manager['Core/FileHandler'].create_node( pathname, parent, self )
-        end
-      end
-      parent
-    end
-
-  end
-
-end