Table of Contents

Introduction to Apache Rivet version 3.1

Apache Rivet 3.1 Installation

Building Rivet 3.1 with CMake

CMake build procedure and examples

Apache Rivet 3.1 Configuration

Apache Rivet Configuration lines

Configuration Directives

Apache Rivet HTTP Request Processing

Tcl Scripts Processing

Example: basic OO Rivet Application

Apache Child Processes Lifecycle and Request Processing

Rivet Tcl Commands and Variables

<?= ... ?> — Shorthand construct for single strings output

abort_code — Returns the code passed to abort_page earlier during the request processing

abort_page — Stops outputting data to web page, similar in purpose to PHP's die command.

apache_log_error — log messages to the Apache error log

apache_table — access and manipulate Apache tables in the request structure.

catch — wraps core command catch

clock_to_rfc850_gmt — create a rfc850 time from [clock seconds].

cookie — get, set and delete cookies.

debug — A command to print strings, arrays and the values of variables as specified by the arguments.

env — Loads a single "environmental variable" into a Tcl variable.

escape_sgml_chars — escape special SGML characters in a string.

escape_shell_command — escape shell metacharacters in a string.

escape_string — convert a string into escaped characters.

exit — terminate execution and child process

headers — set and parse HTTP headers.

html — construct html tagged text.

http_accept — Parse HTTP Accept header lines

import_keyvalue_pairs — Import an argument list into the named array

include — includes a file into the output stream without modification.

incr0 — increment a variable or set it to 1 if nonexistent.

inspect — Introspection command for Rivet configuration

lassign_array — Assign a list of values to array variables

lempty — Returns 1 if <list> is empty or 0 if it has any elements. This command emulates the TclX lempty command.

lmatch — Look for elements in <list> that match <pattern>

load_cookies — get any cookie variables sent by the client.

load_env — get the request's environment variables.

load_headers — get client request's headers.

load_response — load form variables into an array.

lremove — remove from a list elements matching one or more patterns

makeurl — construct url's based on hostname, port.

no_body — Prevents Rivet from sending any content.

parray — Tcl's parray with html formatting.

parse — parses a Rivet template file.

raw_post — get the unmodified body of a POST request sent by the client.

redirect — Interrupt processing and divert to a new URL

read_file — Read the entire contents of a file and return it as a string.

try — Catch error and exception conditions

unescape_string — unescape escaped characters in a string.

upload — handle a file uploaded by a client.

url_script — get the code of the URL referenced Tcl script or Rivet template

var — get the value of a form variable.

wrap — Split a string on newlines.

wrapline — Split the line into multiple lines by splitting on space characters

xml — XML Fragments creation

Examples and Usage

Rivet Tcl Packages

DIO - Database Interface Objects

DIO — Database Interface Objects

DIODisplay - Database Interface Objects Display Class

DIODisplay — Database Interface Objects Display Class

Session Package

Introduction

Requirements

Preparing To Use It

Example Usage

Using Sessions From Your Code

Session Configuration Options

Session Methods

Getting Additional Randomness From The Entropy File

Form: An HTML Form Fields Generation Utility

Introduction

form — a Tcl command object for creating HTML forms

Calendar Package

Introduction

Calendar — Utility class the builds and prints a calendar table

XmlCalendar — Prints XML formatted calendar tables

HtmlCalendar — Concrete class derived from XmlCalendar

RivetEntities

Introduction

encode — encode a string replacing every occurrence of characters for which an SGML entity exists

decode — decode an SGML encoded string replacing every entity with the corresponding character

AsciiGlyphs

Introduction

toGlyphs — print large ASCII glyphs

Example

The Form Broker

Introduction

FormBroker — Form broker object creator

Resources - How to Get Help

Mailing Lists

Newsgroup

Web Sites

Bug Tracking System

IRC

Editing Rivet Template Files

Rivet Internals

Rivet approach to Apache Multiprocessing Models

mod_rivet MPM Bridge callbacks

Server Initialization and MPM Bridge

RivetChan

The global Command

Page Parsing, Execution and Caching

Extending Rivet by developing C code procedures

Debugging Rivet and Apache

Example: the “Lazy” bridge

The rationale of threaded bridges

Lazy bridge data structures

Handling Tcl's exit core command

HTTP request processing with the lazy bridge