webgen 0.3.0

data/lib/webgen/plugins/filehandler/pagehandler/rdoc.rb

@@ -0,0 +1,50 @@
+#
+#--
+#
+# $Id: rdoc.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 'rdoc/markup/simple_markup'
+require 'rdoc/markup/simple_markup/to_html'
+require 'webgen/plugins/filehandler/pagehandler/page'
+
+module ContentHandlers
+
+  # Handles text in RDoc format.
+  class RDocHandler < ContentHandler
+
+    summary "Handles content in RDOC format"
+    depends_on "PageHandler"
+
+    def initialize
+      register_format( 'rdoc' )
+      @processor = SM::SimpleMarkup.new
+      @formatter = SM::ToHtml.new
+    end
+
+    def format_content( txt )
+      @processor.convert( txt, @formatter )
+    rescue
+      self.logger.error { "Error converting RDOC text to HTML" }
+      ''
+    end
+
+  end
+
+end

data/lib/webgen/plugins/filehandler/pagehandler/textile.rb

@@ -0,0 +1,52 @@
+#
+#--
+#
+# $Id: textile.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
+#
+#++
+#
+
+begin
+  require 'redcloth'
+  require 'webgen/plugins/filehandler/pagehandler/page'
+
+  module ContentHandlers
+
+    # Handles content in Textile format using RedCloth.
+    class TextileHandler < ContentHandler
+
+      summary "Handles content in Textile format using RedCloth"
+      depends_on "PageHandler"
+
+      def initialize
+        register_format( 'textile' )
+      end
+
+      def format_content( txt )
+        RedCloth.new( txt ).to_html
+      rescue
+        self.logger.error { "Error converting Textile text to HTML" }
+        ''
+      end
+
+    end
+
+  end
+
+rescue LoadError => e
+  self.logger.warn { "Textile not available as content format as RedCloth could not be loaded: #{e.message}" }
+end

data/lib/webgen/plugins/filehandler/picturegallery.rb

@@ -0,0 +1,194 @@
+#
+#--
+#
+# $Id: picturegallery.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/filehandler/filehandler'
+require 'webgen/plugins/filehandler/directory'
+require 'webgen/plugins/filehandler/pagehandler/page'
+
+module FileHandlers
+
+  class PictureGalleryFileHandler < DefaultHandler
+
+    summary "Handles picture gallery files for page file"
+    extension 'gallery'
+    add_param "picturesPerPage", 20, 'Number of picture per gallery page'
+    add_param "picturePageInMenu", false, 'True if the picture pages should be in the menu'
+    add_param "galleryPageInMenu", false, 'True if the gallery pages should be in the menu'
+    add_param "mainPageInMenu", true, 'True if the main page of the picture gallery should be in the menu'
+    add_param "galleryPageTemplate", nil, 'The template for gallery pages. If nil or a not existing file is specified, the default template is used.'
+    add_param "picturePageTemplate", nil, 'The template for picture pages. If nil or a not existing file is specified, the default template is used.'
+    add_param "mainPageTemplate", nil, 'The template for the main page. If nil or a not existing file is specified, the default template is used.'
+    add_param "files", 'images/**/*.jpg', 'The Dir glob for specifying the picture files'
+    add_param "title", 'Gallery', 'The title of the gallery'
+    add_param "layout", 'default', 'The layout used'
+
+    depends_on 'FileHandler', 'PageHandler'
+
+    def create_node( file, parent )
+      begin
+        @filedata = YAML::load( File.read( file ) )
+      rescue
+        self.logger.error { "Could not parse gallery file <#{file}>, not creating gallery pages" }
+        return
+      end
+      path = File.dirname( file )
+      images = Dir[File.join( path, get_param( 'files' ))].collect {|i| i.sub( /#{path + File::SEPARATOR}/, '' ) }
+      self.logger.info { "Creating gallery for file <#{file}> with #{images.length} pictures" }
+
+      create_gallery( images, parent )
+
+      nil
+    end
+
+    def write_node( node )
+      # do nothing
+    end
+
+    #######
+    private
+    #######
+
+    # Method overridden to lookup parameters specified in the gallery file first.
+    def get_param( name )
+      ( @filedata.has_key?( name ) ? @filedata[name] : super )
+    end
+
+    def call_layouter( type, data )
+      content = self.send( type.to_s + "_page_" + get_param( 'layout' ), data )
+      "#{data.to_yaml}\n---\n#{content}"
+    end
+
+    def create_gallery( images, parent )
+      nr_gallery_pages = (Float(images.length) / get_param( 'picturesPerPage' ) ).ceil
+      main = create_main_page( images )
+      main['galleries'] = create_gallery_pages( images )
+
+      if nr_gallery_pages != 1
+        mainNode = Webgen::Plugin['PageHandler'].create_node_from_data( call_layouter( :main, main ), main['srcName'], parent )
+        parent.add_child( mainNode )
+      else
+        main['galleries'][0]['title'] = main['title']
+        main['galleries'][0]['inMenu'] = main['inMenu']
+        main['galleries'][0].update( @filedata['mainPage'] || {} )
+      end
+
+      main['galleries'].each do |gallery|
+        node = Webgen::Plugin['PageHandler'].create_node_from_data( call_layouter( :gallery, gallery ), gallery['link'], parent )
+        parent.add_child( node )
+        gallery['imageList'].each do |image|
+          node = Webgen::Plugin['PageHandler'].create_node_from_data( call_layouter( :picture, image ), image['srcName'], parent )
+          parent.add_child( node )
+        end
+      end
+    end
+
+    def create_main_page( images )
+      main = {}
+      main['title'] = get_param( 'title' )
+      main['inMenu'] = get_param( 'mainPageInMenu' )
+      main['template'] = get_param( 'mainPageTemplate' )
+      main['srcName'] = gallery_file_name( main['title'] )
+      main.update( @filedata['mainPage'] || {} )
+      main
+    end
+
+    def create_gallery_pages( images )
+      galleries = []
+      picsPerPage = get_param( 'picturesPerPage' )
+      0.step( images.length - 1, picsPerPage ) do |i|
+        data = Hash.new
+
+        data['template'] = get_param( 'galleryPageTemplate' )
+        data['inMenu'] = get_param( 'galleryPageInMenu' )
+        data['number'] = i/picsPerPage + 1
+        data['title'] = gallery_title( data['number'] )
+        data['link'] = gallery_file_name( data['title'] )
+        data['prevGalleryNumber'] = ( i == 0 ? nil : data['number'] - 1 )
+        data['prevGalleryTitle'] = gallery_title( data['prevGalleryNumber'] )
+        data['prevGalleryLink'] = gallery_file_name( data['prevGalleryTitle'] )
+        data['nextGalleryNumber']= ( images.length <= i + picsPerPage ? nil : data['number'] + 1 )
+        data['nextGalleryTitle'] = gallery_title( data['nextGalleryNumber'] )
+        data['nextGalleryLink'] = gallery_file_name( data['nextGalleryTitle'] )
+        data['images'] = images[i..(i + picsPerPage - 1)]
+        data['imageList'] = create_picture_pages( data['images'] )
+
+        galleries << data
+      end
+      galleries
+    end
+
+    def gallery_title( index )
+      ( index.nil? ? nil : get_param( 'title' ) + ' ' + index.to_s )
+    end
+
+    def gallery_file_name( title )
+      ( title.nil? ? nil : title.tr( ' .', '_' ) + '.html' )
+    end
+
+    def create_picture_pages( images )
+      imageList = []
+      images.each do |image|
+        imageData = @filedata[image] || {}
+
+        imageData['title'] ||= "Picture #{File.basename( image )}"
+        imageData['description'] ||= ''
+        imageData['inMenu'] = get_param( 'picturePageInMenu' )
+        imageData['template'] = get_param( 'picturePageTemplate' )
+        imageData['imageFilename'] = image
+        imageData['srcName'] = File.basename( image ).tr( ' .', '_' ) + '.html'
+
+        imageList << imageData
+      end
+      imageList
+    end
+
+    def main_page_default( data )
+      "
+#{data['galleries'].collect {|g| "<img src='#{g['images'][0]}' width='100' height='100' alt='#{g['title']}' /> \"#{g['title']}\":#{g['link']}"}.join( "\n\n" )}
+"
+    end
+
+    def gallery_page_default( data )
+      "
+<div class=\"webgen-gallery\">
+
+#{data['imageList'].collect {|i| "<img src='#{i['imageFilename']}' width='100' height='100' alt='#{i['title']}'/> \"#{i['title']}\":#{i['srcName']}" }.join( "\n\n" )}
+
+</div>
+"
+    end
+
+    def picture_page_default( data )
+      "
+<div class=\"webgen-picture\">
+
+<img src='#{data['imageFilename']}' alt='#{data['title']}' />
+
+</div>
+
+{description: }
+"
+    end
+
+  end
+
+end

data/lib/webgen/plugins/filehandler/template.rb

@@ -0,0 +1,98 @@
+#
+#--
+#
+# $Id: template.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/filehandler/filehandler'
+
+module FileHandlers
+
+  # Handles template files. Template files are generic files which specify the layout.
+  class TemplateFileHandler < DefaultHandler
+
+    summary "Represents the template files for the page generation in the tree"
+    extension 'template'
+    add_param 'defaultTemplate', 'default.template', 'The default file name for the template file.'
+    depends_on 'FileHandler'
+
+    def create_node( srcName, parent )
+      node = Node.new( parent )
+      node['title'] = 'Template'
+      node['src'] = node['dest'] = File.basename( srcName )
+      node['processor'] = self
+      File.open( srcName ) { |file| node['content'] = file.read }
+      node
+    end
+
+    def write_node( node )
+      # do not write anything
+    end
+
+    # Return the template for +node+.
+    def get_template_for_node( node )
+      return get_template( node ) || get_default_template( node )
+    end
+
+    #######
+    private
+    #######
+
+    def get_template( node )
+      if node['template'].kind_of?( String )
+        templateNode = node.node_for_string( node['template'] )
+        if templateNode.nil?
+          self.logger.warn { "Specified template for file <#{node.recursive_value('src')}> not found, using default template!" }
+        end
+        node['template'] = templateNode unless templateNode.nil?
+        return templateNode
+      end
+    end
+
+    # Return the default template for +node+. If the template node is not found in the directory of
+    # the node, the parent directories are searched.
+    def get_default_template( node )
+      node = node.parent until node.kind_of?( FileHandlers::DirHandler::DirNode )
+      templateNode = node.find { |child| child['src'] == get_param( 'defaultTemplate' ) }
+      if templateNode.nil?
+        if node.parent.nil?
+          self.logger.error { "Template file #{get_param( 'defaultTemplate' )} in root directory not found, creating dummy!" }
+          templateNode = DummyTemplateNode.new( node )
+          node.add_child( templateNode )
+        else
+          templateNode = get_default_template( node.parent )
+        end
+      end
+      templateNode
+    end
+
+  end
+
+  class DummyTemplateNode < Node
+
+    def initialize( parent )
+      super( parent )
+      self['src'] = self['dest'] = self['title'] = Webgen::Plugin['TemplateFileHandler']['defaultTemplate']
+      self['processor'] = Webgen::Plugin['TemplateFileHandler']
+      self['content'] = ''
+    end
+
+  end
+
+end

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

@@ -0,0 +1,46 @@
+#
+#--
+#
+# $Id: date.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
+
+  # Prints out the date using a format string which will be passed to Time#strftime. Therefore you
+  # can use everything Time#strftime offers.
+  class DateTag < DefaultTag
+
+    summary "Prints out the date"
+    add_param 'format', '%A, %B %d %H:%M:%S %Z %Y', 'The format of the date (same options as Time#strftime).'
+    depends_on 'Tags'
+
+    def initialize
+      super
+      register_tag( 'date' )
+    end
+
+    def process_tag( tag, node, refNode )
+      Time.now.strftime( get_param( 'format' ) )
+    end
+
+  end
+
+end

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

@@ -0,0 +1,53 @@
+#
+#--
+#
+# $Id: executecommand.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 'cgi'
+require 'webgen/plugins/tags/tags'
+
+module Tags
+
+  # Executes the given command and writes the standard output into the output file. All HTML special
+  # characters are escaped.
+  class ExecuteCommandTag < DefaultTag
+
+    summary "Executes the given command and includes its standard output"
+    depends_on 'Tags'
+    add_param 'command', nil, 'The command which should be executed'
+    add_param 'processOutput', true, 'The output of the command will be processed if true'
+    add_param 'escapeHTML', true, 'Special HTML characters in the output will be escaped if true'
+    set_mandatory 'command', true
+
+    def initialize
+      super
+      register_tag( 'execute' )
+    end
+
+    def process_tag( tag, node, refNode )
+      @processOutput = get_param( 'processOutput' )
+      output = ( get_param( 'command' ) ? `#{get_param( 'command' )}` : '' )
+      output = CGI::escapeHTML( output ) if get_param( 'escapeHTML' )
+      output
+    end
+
+  end
+
+end