The hunchentoot-cgi Reference Manual

Table of Contents

The hunchentoot-cgi Reference Manual

This is the hunchentoot-cgi Reference Manual, version 0.3, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:26:32 2021 GMT+0.

1 Introduction

hunchentoot-cgi

A library for executing CGI scripts from the hunchentoot webserver written by Cyrus Harmon.

To activate hunchentoot-cgi, create a new dispatcher-and-handler and add this to the hunchentoot global dispatch table roughly as follows:

(pushnew (hunchentoot-cgi:create-cgi-dispatcher-and-handler
          "/cgi-bin/"
          "/usr/local/share/hunchentoot/cgi/"
         hunchentoot:*dispatch-table*
         :test #'equal)

This will instruct hunchentoot to field requests to /cgi-bin/foo and execute /usr/local/share/hunchentoot/cgi/foo as a CGI script.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 hunchentoot-cgi

Author

Cyrus Harmon <ch-lisp@bobobeach.com>

License

BSD

Version

0.3

Dependencies

• hunchentoot
• puri

Source

hunchentoot-cgi.asd (file)

Components

• defpackage.lisp (file)
• util.lisp (file)
• hunchentoot-cgi.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 hunchentoot-cgi.asd

Location

hunchentoot-cgi.asd

Systems

hunchentoot-cgi (system)

3.1.2 hunchentoot-cgi/defpackage.lisp

Parent

hunchentoot-cgi (system)

Location

defpackage.lisp

Packages

hunchentoot-cgi

3.1.3 hunchentoot-cgi/util.lisp

Dependency

defpackage.lisp (file)

Parent

hunchentoot-cgi (system)

Location

util.lisp

Internal Definitions

• copy-stream (function)
• with-program (macro)

3.1.4 hunchentoot-cgi/hunchentoot-cgi.lisp

Dependencies

• defpackage.lisp (file)
• util.lisp (file)

Parent

hunchentoot-cgi (system)

Location

hunchentoot-cgi.lisp

Exported Definitions

create-cgi-dispatcher-and-handler (function)

Internal Definitions

• handle-cgi-script (function)
• host-name (function)
• host-name-and-port (function)

4 Packages

Packages are listed by definition order.

4.1 hunchentoot-cgi

Source

defpackage.lisp (file)

Use List

• hunchentoot
• common-lisp

Exported Definitions

create-cgi-dispatcher-and-handler (function)

Internal Definitions

• copy-stream (function)
• handle-cgi-script (function)
• host-name (function)
• host-name-and-port (function)
• with-program (macro)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: create-cgi-dispatcher-and-handler URI-PREFIX BASE-PATH &optional CONTENT-TYPE

Package

hunchentoot-cgi

Source

hunchentoot-cgi.lisp (file)

5.2 Internal definitions

5.2.1 Macros

Macro: with-program (PROGRAM PROGRAM-ARGS ENVIRONMENT &key OUTPUT INPUT) &body BODY

Creates an new process of the specified by PROGRAM using PROGRAM-ARGS as a list of the arguments to the program. Binds the stream variable to an input stream from which the output of the process can be read and executes body as an implicit progn.

Package

hunchentoot-cgi

Source

util.lisp (file)

5.2.2 Functions

Function: copy-stream IN OUT &optional ELEMENT-TYPE

Copy everything from in to out

Package

hunchentoot-cgi

Source

util.lisp (file)

Function: handle-cgi-script PATH &optional CONTENT-TYPE

A function which acts like a Hunchentoot handler for the file denoted by PATH. Send a content type header corresponding to CONTENT-TYPE or (if that is NIL) tries to determine the content type via the file’s suffix.

Package

hunchentoot-cgi

Source

hunchentoot-cgi.lisp (file)

Function: host-name &optional REQUEST

Returns just the host portion of the ’Host’ incoming http header value, rather than either host or host:port if the port is specified.

Package

hunchentoot-cgi

Source

hunchentoot-cgi.lisp (file)

Function: host-name-and-port &optional REQUEST

Returns the multiple values host and port (or nil if no port
is specified) of the ’Host’ incoming http header value, rather than either host or host:port if the port is specified.

Package

hunchentoot-cgi

Source

hunchentoot-cgi.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types