# Copyright 2002-2004 The Apache Software Foundation

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#	http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

package provide RivetTcl 1.1

namespace eval ::Rivet {

    ###
    ## This routine gets called each time a new request comes in.
    ## It sets up the request namespace and creates a global command
    ## to replace the default global.  This ensures that when a user
    ## uses global variables, they're actually contained within the
    ## namespace.  So, everything gets deleted when the request is finished.
    ###
    proc initialize_request {} {
	catch { namespace delete ::request }

	namespace eval ::request { }

	proc ::request::global {args} {
	    foreach arg $args {
		uplevel "::global ::request::$arg"
	    }
	}
    }

    ###
    ## The default error handler for Rivet.  Any time a page runs into an
    ## error, this routine will be called to handle the error information.
    ## If an ErrorScript has been specified, this routine will not be called.
    ###
    proc handle_error {} {
	global errorInfo
	global errorOutbuf

	puts <PRE>
	puts "<HR>$errorInfo<HR>"
	puts "<P><B>OUTPUT BUFFER:</B></P>"
	puts $errorOutbuf
	puts </PRE>
    }

    ###
    ## This routine gets called each time a request is finished.  Any kind
    ## of special cleanup can be placed here.
    ###
    proc cleanup_request {} {
    }

    ###
    ## The main initialization procedure for Rivet.
    ###
    proc init {} {
	global auto_path
	global server

	## Add the rivet-tcl directory to Tcl's auto search path.
	## We insert it at the head of the list because we want any of
	## our procs named the same as Tcl's procs to be overridden.
	## Example: parray
	set tclpath [file join [file dirname [info script]] rivet-tcl]
	set auto_path [linsert $auto_path 0 $tclpath]

	## Add the packages directory to the auto_path.
	## If we have a packages$tcl_version directory
	## (IE: packages8.3, packages8.4) append that as well.

	## The packages directory come right after the rivet-tcl directory.
	set pkgpath [file join [file dirname [info script]] packages]
	set auto_path [linsert $auto_path 1 $pkgpath]
	set auto_path [linsert $auto_path 2 ${pkgpath}-local]

	if { [file exists ${pkgpath}$::tcl_version] } {
	    lappend auto_path ${pkgpath}$::tcl_version
	}

	## This will allow users to create proc libraries and tclIndex files
	## in the local directory that can be autoloaded.
	## Perhaps this must go to the front of the list to allow the user
	## to override even Rivet's procs.
	lappend auto_path .
    }

} ;## namespace eval ::Rivet

## Initialize Rivet.
::Rivet::init