#
#--
#
# $Id: directory.rb 369 2005-12-24 11:37:40Z 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/filehandlers/filehandler'

module FileHandlers

  # Handles directories.
  class DirectoryHandler < DefaultFileHandler

    # Specialized node describing a directory.
    class DirNode < Node

      def initialize( parent, name )
        super( parent )
        self['title'] = name
        self['src'] = self['dest'] = name + '/'
        self['processor'] = Webgen::Plugin['DirectoryHandler']
        self['int:directory?'] = true
      end

      def []( name )
        process_dir_index if !self.metainfo.has_key?( 'indexFile' ) && name == 'indexFile'
        super
      end

      def process_dir_index
        indexFile = Webgen::Plugin['DirectoryHandler']['indexFile']
        if indexFile.nil?
          self['indexFile'] = nil
        else
          node = node_for_string( indexFile )
          if node
            self.logger.info { "Directory index file for <#{self.recursive_value( 'src' )}> => <#{node.recursive_value( 'src', false )}>" }
            self['indexFile'] = node
          else
            self.logger.warn { "No directory index file found for directory <#{self.recursive_value( 'src' )}>" }
            self['indexFile'] = nil
          end
        end
      end

    end


    summary "Handles directories"
    handle_path '**/'
    add_param 'indexFile', 'index.page', 'The default file name for the directory index page file.'
    depends_on 'FileHandler'
    used_meta_info 'indexFile', 'directoryName'

    # Return a new DirNode.
    def create_node( path, parent )
      unless parent && node = parent.find {|child| /^#{File.basename( path )}\/$/ =~ child['src'] }
        node = DirNode.new( parent, File.basename( path ) )
      end
      node
    end

    # Create the directory (and all its parent directories if necessary).
    def write_node( node )
      name = node.recursive_value( 'dest' )
      FileUtils.makedirs( name ) unless File.exists?( name )
    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 get_node_for_lang( node, lang )
      if node['indexFile']
        node['indexFile']['processor'].get_node_for_lang( node['indexFile'], lang )
      else
        node
      end
    end

    # Get the HTML link for the directory +node+.
    def get_html_link( node, refNode, title = nil )
      lang_node = get_node_for_lang( node, refNode['lang'] )
      title ||=  lang_node['directoryName'] || node['title']
      super( lang_node, refNode, title )
    end

    # Recursively create a given path
    def recursive_create_path( path, parent )
      p = parent
      node = nil
      path.split( File::SEPARATOR ).each do |pathname|
        case pathname
        when '.' then
          # do nothing
        when '..' then
          p = p.parent
        else
          node = create_node( pathname, p )
          p.add_child( node ) unless p.nil? || node.nil?
          p = node
        end
      end
      node
    end

  end

end