package CGI;
require 5.006;
use Carp 'croak';
# See the bottom of this file for the POD documentation. Search for the
# string '=head'.
# You can run this file through either pod2man or pod2html to produce pretty
# documentation in manual or html file format (these utilities are part of the
# Perl 5 distribution).
# Copyright 1995-1998 Lincoln D. Stein. All rights reserved.
# It may be used and modified freely, but I do request that this copyright
# notice remain attached to the file. You may modify this module as you
# wish, but if you redistribute a modified version, please attach a note
# listing the modifications you have made.
# The most recent version and complete docs are available at:
# The revision is no longer being updated since moving to git.
# HARD-CODED LOCATION FOR FILE UPLOAD TEMPORARY FILES.
# UNCOMMENT THIS ONLY IF YOU KNOW WHAT YOU'RE DOING.
use CGI::Util qw(rearrange rearrange_header make_attributes unescape escape expires ebcdic2ascii ascii2ebcdic);
#use constant XHTML_DTD => ['-//W3C//DTD XHTML Basic 1.0//EN',
{
local $^W = 0;
}
#global settings
$DISABLE_UPLOADS = 0;
@SAVED_SYMBOLS = ();
# >>>>> Here are some globals that you might want to adjust <<<<<<
sub initialize_globals {
# Set this to 1 to enable copious autoloader debugging messages
$AUTOLOAD_DEBUG = 0;
# Set this to 1 to generate XTML-compatible output
$XHTML = 1;
# Change this to the preferred DTD to print in start_html()
# or use default_dtd('text of DTD to use');
$DEFAULT_DTD = [ '-//W3C//DTD HTML 4.01 Transitional//EN',
# Set this to 1 to enable NOSTICKY scripts
# or:
# 1) use CGI '-nosticky';
# 2) $CGI::NOSTICKY = 1;
$NOSTICKY = 0;
# Set this to 1 to enable NPH scripts
# or:
# 1) use CGI qw(-nph)
# 2) CGI::nph(1)
# 3) print header(-nph=>1)
$NPH = 0;
# Set this to 1 to enable debugging from @ARGV
# Set to 2 to enable debugging from STDIN
$DEBUG = 1;
# Set this to 1 to make the temporary files created
# during file uploads safe from prying eyes
# or do...
# 1) use CGI qw(:private_tempfiles)
# 2) CGI::private_tempfiles(1);
$PRIVATE_TEMPFILES = 0;
# Set this to 1 to generate automatic tab indexes
$TABINDEX = 0;
# Set this to 1 to cause files uploaded in multipart documents
# to be closed, instead of caching the file handle
# or:
# 1) use CGI qw(:close_upload_files)
# 2) $CGI::close_upload_files(1);
# Uploads with many files run out of file handles.
# Also, for performance, since the file is already on disk,
# it can just be renamed, instead of read and written.
$CLOSE_UPLOAD_FILES = 0;
# Automatically determined -- don't change
$EBCDIC = 0;
# Change this to 1 to suppress redundant HTTP headers
$HEADERS_ONCE = 0;
# separate the name=value pairs by semicolons rather than ampersands
$USE_PARAM_SEMICOLONS = 1;
# Do not include undefined params parsed from query string
# use CGI qw(-no_undef_params);
$NO_UNDEF_PARAMS = 0;
# return everything as utf-8
$PARAM_UTF8 = 0;
# Other globals that you shouldn't worry about.
undef $Q;
$BEEN_THERE = 0;
$DTD_PUBLIC_IDENTIFIER = "";
undef @QUERY_PARAM;
undef %EXPORT;
undef $QUERY_CHARSET;
undef %QUERY_FIELDNAMES;
undef %QUERY_TMPFILES;
# prevent complaints by mod_perl
1;
}
# ------------------ START OF THE LIBRARY ------------
#### Method: endform
# This method is DEPRECATED
# make mod_perlhappy
# FIGURE OUT THE OS WE'RE RUNNING UNDER
# Some systems support the $^O variable. If not
# available then require() the Config library
unless ($OS) {
unless ($OS = $^O) {
require Config;
}
}
$OS = 'WINDOWS';
$OS = 'VMS';
$OS = 'DOS';
$OS = 'MACINTOSH';
$OS = 'OS2';
$OS = 'EPOC';
$OS = 'CYGWIN';
$OS = 'NETWARE';
} else {
$OS = 'UNIX';
}
# Some OS logic. Binary mode enabled on DOS, NT and VMS
# This is the default class for the CGI object to use when all else fails.
# This is where to look for autoloaded routines.
# The path separator is a slash, backslash or semicolon, depending
# on the paltform.
$SL = {
}->{$OS};
# This no longer seems to be necessary
# Turn on NPH scripts by default when running under IIS server!
# $NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
# Turn on special checking for ActiveState's PerlEx
# Turn on special checking for Doug MacEachern's modperl
# PerlEx::DBI tries to fool DBI by setting MOD_PERL
# mod_perl handlers may run system() on scripts using CGI.pm;
# Make sure so we don't get fooled by inherited $ENV{MOD_PERL}
$MOD_PERL = 2;
require Apache2::RequestRec;
require Apache2::RequestUtil;
} else {
$MOD_PERL = 1;
require Apache;
}
}
# Define the CRLF sequence. I can't use a simple "\r\n" because the meaning
# of "\n" is different on different OS's (sometimes it generates CRLF, sometimes LF
# and sometimes CR). The most popular VMS web server
# doesn't accept CRLF -- instead it wants a LR. EBCDIC machines don't
# use ASCII, so \015\012 means something different. I find this all
# really annoying.
if ($OS eq 'VMS') {
$CRLF = "\n";
} elsif ($EBCDIC) {
$CRLF= "\r\n";
} else {
$CRLF = "\015\012";
}
if ($needs_binmode) {
}
%EXPORT_TAGS = (
':ssl' => [qw/https/],
);
# Custom 'can' method for both autoloaded and non-autoloaded subroutines.
# Author: Cees Hek <cees@sitesuite.com.au>
sub can {
# See if UNIVERSAL::can finds it.
return $func;
}
# Try to compile the function.
eval {
# _compile looks at $AUTOLOAD for the function name.
&_compile;
};
# Now that the function is loaded (if it exists)
# just use UNIVERSAL::can again to do the work.
}
# to import symbols into caller
sub import {
my $self = shift;
# This causes modules to clash.
undef %EXPORT_OK;
undef %EXPORT;
$self->_setup_symbols(@_);
# To allow overriding, search through the packages
# Till we find one in which the correct subroutine is defined.
my $pck;
if (defined(&{"$pck\:\:$sym"})) {
last;
}
}
*{"${callpack}::$sym"} = \&{"$def\:\:$sym"};
}
}
sub compile {
my $pack = shift;
}
sub expand_tags {
my($tag) = @_;
my(@r);
for (@{$EXPORT_TAGS{$tag}}) {
push(@r,&expand_tags($_));
}
return @r;
}
#### Method: new
# The new routine. This will check the current environment
# for an existing query string, and initialize itself, if so.
####
sub new {
my($class,@initializer) = @_;
my $self = {};
# always use a tempfile
if (ref($initializer[0])
||
)) {
$self->r(shift @initializer);
}
if (ref($initializer[0])
}
if ($MOD_PERL) {
if ($MOD_PERL == 1) {
my $r = $self->r;
}
else {
# XXX: once we have the new API
# will do a real PerlOptions -SetupEnv check
my $r = $self->r;
}
undef $NPH;
}
return $self;
}
# We provide a DESTROY method so that we can ensure that
# temporary files are closed (via Fh->DESTROY) before they
# are unlinked (via CGITempFile->DESTROY) because it is not
# possible to unlink an open file on Win32. We explicitly
# call DESTROY on each, rather than just undefing them and
# letting Perl DESTROY them by garbage collection, in case the
# user is still holding any reference to them as well.
sub DESTROY {
my $self = shift;
if ($OS eq 'WINDOWS') {
}
}
}
sub r {
my $self = shift;
my $r = $self->{'.r'};
$self->{'.r'} = shift if @_;
$r;
}
sub upload_hook {
my $self;
if (ref $_[0] eq 'CODE') {
} else {
$self = shift;
}
}
#### Method: param
# Returns the value(s)of a named parameter.
# If invoked in a list context, returns the
# entire list. Otherwise returns the first
# member of the list.
# If name is not provided, return a list of all
# the known parameters names available.
# If more than one argument is provided, the
# second and subsequent arguments are used to
# set the value of the parameter.
####
sub param {
my($self,@p) = self_or_default(@_);
return $self->all_parameters unless @p;
# For compatibility between old calling style and use_named_parameters() style,
# we have to special case for a single parameter present.
if (@p > 1) {
my(@values);
if (substr($p[0],0,1) eq '-') {
} else {
push(@values,$_) if defined($_);
}
}
# If values is provided, then we set it.
}
} else {
$name = $p[0];
}
if ($PARAM_UTF8) {
}
}
sub _decode_utf8 {
return $val;
}
else {
}
}
sub self_or_default {
return @_ if defined($_[0]) && (!ref($_[0])) &&($_[0] eq 'CGI');
unless (defined($_[0]) &&
) {
$Q = $CGI::DefaultClass->new unless defined($Q);
unshift(@_,$Q);
}
return wantarray ? @_ : $Q;
}
sub self_or_CGI {
local $^W=0; # prevent a warning
if (defined($_[0]) &&
(substr(ref($_[0]),0,3) eq 'CGI'
return @_;
} else {
return ($DefaultClass,@_);
}
}
########################################
# THESE METHODS ARE MORE OR LESS PRIVATE
# GO TO THE __DATA__ SECTION TO SEE MORE
# PUBLIC METHODS
########################################
# Initialize the query object from the environment.
# If a parameter list is found, this object will be set
# to a hash in which parameter names are keys
# and the values are stored as lists
# If a keyword list is found, this method creates a bogus
# parameter list with the single parameter 'keywords'.
sub init {
my $self = shift;
my $is_xforms;
my $initializer = shift; # for backward compatibility
local($/) = "\n";
# set autoescaping on by default
# if we get called more than once, we want to initialize
# ourselves from the original query (which may be gone
# if it was read from STDIN originally.)
if (defined(@QUERY_PARAM) && !defined($initializer)) {
for my $name (@QUERY_PARAM) {
}
}
}
return;
}
# set charset to the safe ISO-8859-1
METHOD: {
# avoid unreasonably large postings
#discard the post, unread
last METHOD;
}
# Process multipart postings, but only if the initializer is
# not defined.
if ($meth eq 'POST'
&& defined($ENV{'CONTENT_TYPE'})
&& !defined($initializer)
) {
last METHOD;
}
# Process XForms postings. We know that we have XForms in the
# following cases:
# method eq 'POST' && content-type eq 'application/xml'
# method eq 'POST' && content-type =~ /multipart\/related.+start=/
# There are more cases, actually, but for now, we don't support other
# methods for XForm posts.
# In a XForm POST, the QUERY_STRING is parsed normally.
# If the content-type is 'application/xml', we just set the param
# XForms:Model (referring to the xml syntax) param containing the
# unparsed XML data.
# the other parts are available as uploads with the Content-ID as the
# the key.
# See the URL below for XForms specs on this issue.
# http://www.w3.org/TR/2006/REC-xforms-20060314/slice11.html#submit-options
my($param) = 'XForms:Model';
my($value) = '';
if $content_length > 0;
$is_xforms = 1;
} elsif ($ENV{'CONTENT_TYPE'} =~ /multipart\/related.+boundary=\"?([^\";,]+)\"?.+start=\"?\<?([^\"\>]+)\>?\"?/) {
my($param) = 'XForms:Model';
if ($MOD_PERL) {
} else {
}
$is_xforms = 1;
}
}
# If initializer is defined, then read parameters
# from it.
if (!$is_xforms && defined($initializer)) {
last METHOD;
}
for (keys %$initializer) {
}
last METHOD;
}
chomp $line;
last if $line =~ /^=$/;
}
# massage back into standard format
if ("@lines" =~ /=/) {
} else {
}
last METHOD;
}
# last chance -- treat it as a string
$query_string = $initializer;
last METHOD;
}
# If method is GET or HEAD, fetch the query from
# the environment.
if ($MOD_PERL) {
} else {
}
last METHOD;
}
if ( $content_length > 0 ) {
}
elsif (not defined $ENV{CONTENT_LENGTH}) {
# should this be PUTDATA in case of PUT ?
undef $query_string ;
}
# Some people want to have their cake and eat it too!
# Uncomment this line to have the contents of the query string
# APPENDED to the POST data.
# $query_string .= (length($query_string) ? '&' : '') . $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
last METHOD;
}
# If $meth is not of GET, POST, PUT or HEAD, assume we're
# being debugged offline.
# Check the command line and then the standard input for data.
# We use the shellwords package in order to behave the way that
# UN*X programmers expect.
if ($DEBUG)
{
my $cmdline_ret = read_from_cmdline();
if (defined($cmdline_ret->{'subpath'}))
{
}
}
}
# YL: Begin Change for XML handler 10/19/2001
&& defined($ENV{'CONTENT_TYPE'})
undef $query_string ;
}
# YL: End Change for XML handler 10/19/2001
# We now have the query string in hand. We do slightly
# different things for keyword lists and parameter lists.
if (defined $query_string && length $query_string) {
if ($query_string =~ /[&=;]/) {
} else {
}
}
# Special case. Erase everything if there is a field named
# .defaults.
$self->delete_all();
}
# hash containing our defined fieldnames
$self->{'.fieldnames'} = {};
$self->{'.fieldnames'}->{$_}++;
}
# Clear out our default submission button flag if present
$self->delete('.submit');
$self->delete('.cgifields');
}
# FUNCTIONS TO OVERRIDE:
# Turn a string into a filehandle
sub to_filehandle {
my $thingy = shift;
return undef unless $thingy;
if (!ref($thingy)) {
my $caller = 1;
}
}
return undef;
}
# send output to the browser
sub put {
my($self,@p) = self_or_default(@_);
$self->print(@p);
}
# print to standard output (for overriding in mod_perl)
sub print {
shift;
CORE::print(@_);
}
sub cgi_error {
return $self->{'.cgi_error'};
}
sub save_request {
my($self) = @_;
# We're going to play with the package globals now so that if we get called
# again, we initialize ourselves in exactly the same way. This allows
# us to have several of these objects.
for (@QUERY_PARAM) {
next unless defined $_;
}
}
sub parse_params {
for (@pairs) {
next unless defined $param;
next if $NO_UNDEF_PARAMS and not defined $value;
}
}
sub add_parameter {
return unless defined $param;
}
sub all_parameters {
my $self = shift;
return () unless @{$self->{'.parameters'}};
return @{$self->{'.parameters'}};
}
# put a filehandle into binary mode (DOS)
sub binmode {
return unless defined($_[1]) && defined fileno($_[1]);
CORE::binmode($_[1]);
}
sub _make_tag_func {
my $func = qq(
sub $tagname {
my (\$q,\$a,\@rest) = self_or_default(\@_);
my(\$attr) = '';
if (ref(\$a) && ref(\$a) eq 'HASH') {
} else {
unshift \@rest,\$a if defined \$a;
}
);
$func .= qq! return "<\L$1\E\$attr>";} !;
$func .= qq! return "<\L/$1\E>"; } !;
} else {
$func .= qq#
my \@result = map { "\$tag\$_\$untag" }
return "\@result";
}#;
}
return $func;
}
sub AUTOLOAD {
goto &$func;
}
sub _compile {
{
local($1,$2); # this fixes an obscure variable suicide problem.
$func=~/(.+)::([^:]+)$/;
unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"});
my($sub) = \%{"$pack\:\:SUBS"};
unless (%$sub) {
my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"};
local ($@,$!);
eval "package $pack; $$auto";
croak("$AUTOLOAD: $@") if $@;
}
if (!$code) {
if ($EXPORT{':any'} ||
$EXPORT{'-any'} ||
}
}
croak("Undefined subroutine $AUTOLOAD\n") unless $code;
local ($@,$!);
eval "package $pack; $code";
if ($@) {
$@ =~ s/ at .*\n//;
croak("$AUTOLOAD: $@");
}
}
return "$pack\:\:$func_name";
}
sub _selected {
my $self = shift;
my $value = shift;
return '' unless $value;
}
sub _checked {
my $self = shift;
my $value = shift;
return '' unless $value;
}
sub _setup_symbols {
my $self = shift;
my $compile = 0;
# to avoid reexporting unwanted variables
undef %EXPORT;
for (@_) {
$HEADERS_ONCE++, next if /^[:-]unique_headers$/;
$USE_PARAM_SEMICOLONS++, next if /^[:-]newstyle_urls$/;
$PARAM_UTF8++, next if /^[:-]utf8$/;
$PRIVATE_TEMPFILES++, next if /^[:-]private_tempfiles$/;
$CLOSE_UPLOAD_FILES++, next if /^[:-]close_upload_files$/;
$NO_UNDEF_PARAMS++, next if /^[:-]no_undef_params$/;
# This is probably extremely evil code -- to be deleted some day.
if (/^[-]autoload$/) {
my($pkg) = caller(1);
*{"${pkg}::AUTOLOAD"} = sub {
&$routine;
};
next;
}
for (&expand_tags($_)) {
$EXPORT{$_}++;
}
}
@SAVED_SYMBOLS = @_;
}
sub charset {
$self->{'.charset'};
}
sub element_id {
}
sub element_tab {
return qq(tabindex="$tab" );
}
###############################################################################
################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
###############################################################################
$AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
%SUBS = (
'URL_ENCODED'=> <<'END_OF_FUNC',
'MULTIPART' => <<'END_OF_FUNC',
'SERVER_PUSH' => <<'END_OF_FUNC',
'new_MultipartBuffer' => <<'END_OF_FUNC',
# Create a new multipart buffer
sub new_MultipartBuffer {
}
'read_from_client' => <<'END_OF_FUNC',
# Read data from a file handle
sub read_from_client {
local $^W=0; # prevent a warning
return $MOD_PERL
}
'read_from_stdin' => <<'END_OF_FUNC',
# Read data from stdin until all is read
sub read_from_stdin {
local $^W=0; # prevent a warning
#
# TODO: loop over STDIN until all is read
#
my($eoffound) = 0;
my($localbuf) = '';
my($tempbuf) = '';
my($bufsiz) = 1024;
my($res);
while ($eoffound == 0) {
if ( $MOD_PERL ) {
}
else {
}
if ( !defined($res) ) {
# TODO: how to do error reporting ?
$eoffound = 1;
last;
}
if ( $res == 0 ) {
$eoffound = 1;
last;
}
}
return $res;
}
'delete' => <<'END_OF_FUNC',
#### Method: delete
# Deletes the named parameter entirely.
####
sub delete {
my($self,@p) = self_or_default(@_);
my %to_delete;
{
}
return;
}
#### Method: import_names
# Import all parameters into the given namespace.
# Assumes namespace 'Q' if not specified
####
'import_names' => <<'END_OF_FUNC',
sub import_names {
die "Can't import names into \"main\"\n" if \%{"${namespace}::"} == \%::;
# can anyone find an easier way to do this?
for (keys %{"${namespace}::"}) {
local *symbol = "${namespace}::${_}";
undef $symbol;
undef @symbol;
undef %symbol;
}
}
# protect against silly names
$var =~ s/^(?=\d)/_/;
local *symbol = "${namespace}::$var";
}
}
#### Method: keywords
# Keywords acts a bit differently. Calling it in a list context
# returns the list of keywords.
# Calling it in a scalar context gives you the size of the list.
####
'keywords' => <<'END_OF_FUNC',
sub keywords {
# If values is provided, then we set it.
@result;
}
# These are some tie() interfaces for compatibility
# with Steve Brenner's cgi-lib.pl routines
'Vars' => <<'END_OF_FUNC',
sub Vars {
my $q = shift;
my %in;
return %in if wantarray;
return \%in;
}
# These are some tie() interfaces for compatibility
# with Steve Brenner's cgi-lib.pl routines
'ReadParse' => <<'END_OF_FUNC',
sub ReadParse {
local(*in);
if (@_) {
*in = $_[0];
} else {
my $pkg = caller();
*in=*{"${pkg}::in"};
}
return scalar(keys %in);
}
'PrintHeader' => <<'END_OF_FUNC',
sub PrintHeader {
my($self) = self_or_default(@_);
}
'HtmlTop' => <<'END_OF_FUNC',
sub HtmlTop {
my($self,@p) = self_or_default(@_);
return $self->start_html(@p);
}
'HtmlBot' => <<'END_OF_FUNC',
sub HtmlBot {
my($self,@p) = self_or_default(@_);
}
'SplitParam' => <<'END_OF_FUNC',
sub SplitParam {
my ($param) = @_;
}
'MethGet' => <<'END_OF_FUNC',
sub MethGet {
return request_method() eq 'GET';
}
'MethPost' => <<'END_OF_FUNC',
sub MethPost {
return request_method() eq 'POST';
}
'MethPut' => <<'END_OF_FUNC',
sub MethPut {
return request_method() eq 'PUT';
}
'TIEHASH' => <<'END_OF_FUNC',
sub TIEHASH {
my $class = shift;
my $arg = $_[0];
return $arg;
}
return $Q ||= $class->new(@_);
}
'STORE' => <<'END_OF_FUNC',
sub STORE {
my $self = shift;
my $tag = shift;
my $vals = shift;
}
'FETCH' => <<'END_OF_FUNC',
sub FETCH {
return $_[0] if $_[1] eq 'CGI';
}
'FIRSTKEY' => <<'END_OF_FUNC',
sub FIRSTKEY {
$_[0]->{'.iterator'}=0;
$_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
}
'NEXTKEY' => <<'END_OF_FUNC',
sub NEXTKEY {
$_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
}
'EXISTS' => <<'END_OF_FUNC',
sub EXISTS {
}
'DELETE' => <<'END_OF_FUNC',
sub DELETE {
$_[0]->delete($_[1]);
}
'CLEAR' => <<'END_OF_FUNC',
sub CLEAR {
%{$_[0]}=();
}
####
####
# Append a new value to an existing query
####
'append' => <<'EOF',
sub append {
my($self,@p) = self_or_default(@_);
if (@values) {
}
}
#### Method: delete_all
# Delete all parameters
####
'delete_all' => <<'EOF',
sub delete_all {
my($self) = self_or_default(@_);
}
'Delete' => <<'EOF',
sub Delete {
my($self,@p) = self_or_default(@_);
$self->delete(@p);
}
'Delete_all' => <<'EOF',
sub Delete_all {
my($self,@p) = self_or_default(@_);
$self->delete_all(@p);
}
#### Method: autoescape
# If you want to turn off the autoescaping features,
# call this method with undef as the argument
'autoEscape' => <<'END_OF_FUNC',
sub autoEscape {
my $d = $self->{'escape'};
$d;
}
#### Method: version
# Return the current version
####
'version' => <<'END_OF_FUNC',
sub version {
return $VERSION;
}
#### Method: url_param
# Return a parameter in the QUERY_STRING, regardless of
# whether this was a POST or a GET
####
'url_param' => <<'END_OF_FUNC',
sub url_param {
my ($self,@p) = self_or_default(@_);
my $name = shift(@p);
return undef unless exists($ENV{QUERY_STRING});
unless (exists($self->{'.url_param'})) {
if ($ENV{QUERY_STRING} =~ /=/) {
for (@pairs) {
}
} else {
}
}
}
#### Method: Dump
# pairs are represented as nested lists, mainly for the purposes
# of debugging.
####
'Dump' => <<'END_OF_FUNC',
sub Dump {
my($self) = self_or_default(@_);
push(@result,"<ul>");
push(@result,"<li><strong>$name</strong></li>");
push(@result,"<ul>");
push(@result,"<li>$value</li>");
}
push(@result,"</ul>");
}
push(@result,"</ul>");
return join("\n",@result);
}
#### Method as_string
#
# synonym for "dump"
####
'as_string' => <<'END_OF_FUNC',
sub as_string {
&Dump(@_);
}
#### Method: save
# Write values out to a filehandle in such a way that they can
# be reinitialized by the filehandle form of the new() method
####
'save' => <<'END_OF_FUNC',
sub save {
my($param);
local($,) = ''; # set print field separator back to a sane value
local($\) = ''; # set output line separator to a sane value
my($value);
if length($escaped_param) or length($value);
}
}
for (keys %{$self->{'.fieldnames'}}) {
}
}
#### Method: save_parameters
# An alias for save() that is a better name for exportation.
# Only intended to be used with the function (non-OO) interface.
####
'save_parameters' => <<'END_OF_FUNC',
sub save_parameters {
my $fh = shift;
}
#### Method: restore_parameters
# A way to restore CGI parameters from an initializer.
# Only intended to be used with the function (non-OO) interface.
####
'restore_parameters' => <<'END_OF_FUNC',
sub restore_parameters {
$Q = $CGI::DefaultClass->new(@_);
}
#### Method: multipart_init
# Return a Content-Type: style header for server-push
# This has to be NPH on most web servers, and it is advisable to set $| = 1
#
# Many thanks to Ed Jordan <ed@fidalgo.net> for this
# contribution, updated by Andrew Benham (adsb@bigfoot.com)
####
'multipart_init' => <<'END_OF_FUNC',
sub multipart_init {
my($self,@p) = self_or_default(@_);
if (!$boundary) {
$boundary = '------- =_';
for (1..17) {
}
}
-nph => 0,
}
#### Method: multipart_start
# Return a Content-Type: style header for server-push, start of section
#
# Many thanks to Ed Jordan <ed@fidalgo.net> for this
# contribution, updated by Andrew Benham (adsb@bigfoot.com)
####
'multipart_start' => <<'END_OF_FUNC',
sub multipart_start {
my(@header);
my($self,@p) = self_or_default(@_);
push(@header,"Content-Type: $type");
# rearrange() was designed for the HTML portion, so we
# need to fix it up a little.
for (@other) {
# Don't use \s because of perl bug 21951
}
return $header;
}
#### Method: multipart_end
# Return a MIME boundary separator for server-push, end of section
#
# Many thanks to Ed Jordan <ed@fidalgo.net> for this
# contribution
####
'multipart_end' => <<'END_OF_FUNC',
sub multipart_end {
my($self,@p) = self_or_default(@_);
return $self->{'separator'};
}
#### Method: multipart_final
# Return a MIME boundary separator for server-push, end of all sections
#
# Contributed by Andrew Benham (adsb@bigfoot.com)
####
'multipart_final' => <<'END_OF_FUNC',
sub multipart_final {
my($self,@p) = self_or_default(@_);
return $self->{'final_separator'} . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $CRLF;
}
#### Method: header
# Return a Content-Type: style header
#
####
'header' => <<'END_OF_FUNC',
sub header {
my($self,@p) = self_or_default(@_);
my(@header);
'STATUS',['COOKIE','COOKIES'],'TARGET',
'EXPIRES','NPH','CHARSET',
'ATTACHMENT','P3P'],@p);
# CR escaping for values, per RFC 822
if (defined $header) {
# From RFC 822:
# Unfolding is accomplished by regarding CRLF immediately
# followed by a LWSP-char as equivalent to the LWSP-char.
# All other uses of newlines are invalid input.
# shorten very long values in the diagnostic
die "Invalid header value contains a newline not followed by whitespace: $header";
}
}
}
# sets if $charset is given, gets if not
# rearrange() was designed for the HTML portion, so we
# need to fix it up a little.
for (@other) {
# Don't use \s because of perl bug 21951
}
$type .= "; charset=$charset"
if $type ne ''
and defined $charset
and $charset ne '';
# Maybe future compatibility. Maybe not.
if ($p3p) {
}
# push all the cookies -- there may be several
if ($cookie) {
for (@cookie) {
}
}
# if the user indicates an expiration time, then we need
# both an Expires and a Date header (so that the browser is
# uses OUR clock)
if $expires;
return '';
}
return $header;
}
#### Method: cache
# Control whether header() will produce the no-cache
# Pragma directive.
####
'cache' => <<'END_OF_FUNC',
sub cache {
if ($new_value ne '') {
}
return $self->{'cache'};
}
#### Method: redirect
# Return a Location: style header
#
####
'redirect' => <<'END_OF_FUNC',
sub redirect {
my($self,@p) = self_or_default(@_);
my(@o);
unshift(@o,
'-Status' => $status,
'-Location'=> $url,
'-nph' => $nph);
unshift(@o,'-Type'=>'');
my @unescaped;
}
#### Method: start_html
# Canned HTML header
#
# Parameters:
# $title -> (optional) The title for this HTML document (-title)
# $author -> (optional) e-mail address of the author (-author)
# $base -> (optional) if set to true, will enter the BASE address of this document
# for resolving relative references (-base)
# $xbase -> (optional) alternative base at some remote location (-xbase)
# $target -> (optional) target window to load all links into (-target)
# $script -> (option) Javascript code (-script)
# $no_script -> (option) Javascript <noscript> tag (-noscript)
# $meta -> (optional) Meta information tags
# $head -> (optional) any other elements you'd like to incorporate into the <head> tag
# (a scalar or array ref)
# $style -> (optional) reference to an external style sheet
# @other -> (optional) any other named parameters you'd like to incorporate into
# the <body> tag.
####
'start_html' => <<'END_OF_FUNC',
sub start_html {
my($self,@p) = &self_or_default(@_);
# Need to sort out the DTD before it's okay to call escapeHTML().
if ($dtd) {
} else {
}
} else {
}
} else {
$DTD_PUBLIC_IDENTIFIER = $dtd;
}
# Now that we know whether we're using the HTML 3.2 DTD or not, it's okay to
# call escapeHTML(). Strangely enough, the title needs to be escaped as
# HTML while the author needs to be escaped as a URL.
$XHTML = 0;
}
else {
}
push(@result,$XHTML ? qq(<html xmlns="http://www.w3.org/1999/xhtml"$lang_bits>\n<head>\n<title>$title</title>)
. "<head><title>$title</title>");
if (defined $author) {
: "<link rev=\"made\" href=\"mailto:$author\">");
}
}
}
my $meta_bits_set = 0;
if( $head ) {
if( ref $head ) {
}
else {
}
}
# handle the infrequently-used -style and -script parameters
# handle -noscript parameter
<noscript>
</noscript>
END
;
push(@result,"</head>\n<body$other>\n");
return join("\n",@result);
}
### Method: _style
# internal method for generating a CSS style section
####
'_style' => <<'END_OF_FUNC',
sub _style {
my (@result);
my $rel = 'stylesheet';
my $other = '';
for my $s (@s) {
if (ref($s)) {
('-foo'=>'bar',
ref($s) eq 'ARRAY' ? @$s : %$s));
{ # If it is, push a LINK tag for each one
{
}
}
else
{ # Otherwise, push the single -src, if it exists.
) if $src;
}
if ($verbatim) {
}
} else {
my $src = $s;
}
}
@result;
}
'_script' => <<'END_OF_FUNC',
sub _script {
my (@result);
if (ref($script)) { # script is a hash
'-foo'=>'bar', # a trick to allow the '-' to be omitted
$type ||= 'text/javascript';
unless ($type =~ m!\w+/\w+!) {
$type =~ s/[\d.]+$//;
$type = "text/$type";
}
} else {
}
my ($cdata_start,$cdata_end);
if ($XHTML) {
$cdata_start = "$comment<![CDATA[\n";
$cdata_end .= "\n$comment]]>";
} else {
$cdata_start = "\n<!-- Hide script\n";
$cdata_end .= " End script hiding -->\n";
}
my(@satts);
}
@result;
}
#### Method: end_html
# End an HTML document.
# Trivial method for completeness. Just returns "</body>"
####
'end_html' => <<'END_OF_FUNC',
sub end_html {
return "\n</body>\n</html>";
}
################################
# METHODS USED IN BUILDING FORMS
################################
#### Method: isindex
# Just prints out the isindex tag.
# Parameters:
# $action -> optional URL of script to run
# Returns:
# A string containing a <isindex> tag
'isindex' => <<'END_OF_FUNC',
sub isindex {
my($self,@p) = self_or_default(@_);
}
#### Method: startform
# This method is DEPRECATED
# Start a form
# Parameters:
# $method -> optional submission method to use (GET or POST)
# $action -> optional URL of script to run
# $enctype ->encoding to use (URL_ENCODED or MULTIPART)
'startform' => <<'END_OF_FUNC',
sub startform {
my($self,@p) = self_or_default(@_);
if (defined $action) {
}
else {
}
$self->{'.parametersToAdd'}={};
}
#### Method: start_form
# Start a form
# Parameters:
# $method -> optional submission method to use (GET or POST)
# $action -> optional URL of script to run
# $enctype ->encoding to use (URL_ENCODED or MULTIPART)
'start_form' => <<'END_OF_FUNC',
sub start_form {
my($self,@p) = self_or_default(@_);
if( $XHTML ){
}else{
}
if (defined $action) {
}
else {
}
$self->{'.parametersToAdd'}={};
}
#### Method: start_multipart_form
'start_multipart_form' => <<'END_OF_FUNC',
sub start_multipart_form {
my($self,@p) = self_or_default(@_);
if (defined($p[0]) && substr($p[0],0,1) eq '-') {
} else {
}
}
#### Method: end_form
# End a form
'end_form' => <<'END_OF_FUNC',
sub end_form {
my($self,@p) = self_or_default(@_);
if ( $NOSTICKY ) {
return wantarray ? ("</form>") : "\n</form>";
} else {
} else {
return "</form>";
}
}
}
#### Method: end_multipart_form
# end a multipart form
'end_multipart_form' => <<'END_OF_FUNC',
sub end_multipart_form {
&end_form;
}
'_textfield' => <<'END_OF_FUNC',
sub _textfield {
# this entered at cristy's request to fix problems with file upload fields
# and WebTV -- not sure it won't break stuff
}
#### Method: textfield
# Parameters:
# $name -> Name of the text field
# $default -> Optional default value of the field if not
# already defined.
# $size -> Optional width of field in characaters.
# $maxlength -> Optional maximum number of characters.
# Returns:
# A string containing a <input type="text"> field
#
'textfield' => <<'END_OF_FUNC',
sub textfield {
my($self,@p) = self_or_default(@_);
}
#### Method: filefield
# Parameters:
# $name -> Name of the file upload field
# $size -> Optional width of field in characaters.
# $maxlength -> Optional maximum number of characters.
# Returns:
# A string containing a <input type="file"> field
#
'filefield' => <<'END_OF_FUNC',
sub filefield {
my($self,@p) = self_or_default(@_);
}
#### Method: password
# Create a "secret password" entry field
# Parameters:
# $name -> Name of the field
# $default -> Optional default value of the field if not
# already defined.
# $size -> Optional width of field in characters.
# $maxlength -> Optional maximum characters that can be entered.
# Returns:
# A string containing a <input type="password"> field
#
'password_field' => <<'END_OF_FUNC',
sub password_field {
my ($self,@p) = self_or_default(@_);
}
#### Method: textarea
# Parameters:
# $name -> Name of the text field
# $default -> Optional default value of the field if not
# already defined.
# $rows -> Optional number of rows in text area
# $columns -> Optional number of columns in text area
# Returns:
# A string containing a <textarea></textarea> tag
#
'textarea' => <<'END_OF_FUNC',
sub textarea {
my($self,@p) = self_or_default(@_);
}
#### Method: button
# Create a javascript button.
# Parameters:
# $name -> (optional) Name for the button. (-name)
# $value -> (optional) Value of the button when selected (and visible name) (-value)
# $onclick -> (optional) Text of the JavaScript to run when the button is
# clicked.
# Returns:
# A string containing a <input type="button"> tag
####
'button' => <<'END_OF_FUNC',
sub button {
my($self,@p) = self_or_default(@_);
$script ||= '';
my($name) = '';
my($val) = '';
}
#### Method: submit
# Create a "submit query" button.
# Parameters:
# $name -> (optional) Name for the button.
# $value -> (optional) Value of the button when selected (also doubles as label).
# $label -> (optional) Label printed on the button(also doubles as the value).
# Returns:
# A string containing a <input type="submit"> tag
####
'submit' => <<'END_OF_FUNC',
sub submit {
my($self,@p) = self_or_default(@_);
my $val = '';
}
#### Method: reset
# Create a "reset" button.
# Parameters:
# $name -> (optional) Name for the button.
# Returns:
# A string containing a <input type="reset"> tag
####
'reset' => <<'END_OF_FUNC',
sub reset {
my($self,@p) = self_or_default(@_);
my ($name) = ' name=".reset"';
my($val) = '';
}
#### Method: defaults
# Create a "defaults" button.
# Parameters:
# $name -> (optional) Name for the button.
# Returns:
# A string containing a <input type="submit" name=".defaults"> tag
#
# Note: this button has a special meaning to the initialization script,
# and tells it to ERASE the current query string so that your defaults
# are used again!
####
'defaults' => <<'END_OF_FUNC',
sub defaults {
my($self,@p) = self_or_default(@_);
}
#### Method: comment
# Create an HTML <!-- comment -->
# Parameters: a string
'comment' => <<'END_OF_FUNC',
sub comment {
my($self,@p) = self_or_CGI(@_);
return "<!-- @p -->";
}
#### Method: checkbox
# Create a checkbox that is not logically linked to any others.
# The field value is "on" when the button is checked.
# Parameters:
# $name -> Name of the checkbox
# $checked -> (optional) turned on by default if true
# $value -> (optional) value of the checkbox, 'on' by default
# $label -> (optional) a user-readable label printed next to the box.
# Otherwise the checkbox name is used.
# Returns:
# A string containing a <input type="checkbox"> field
####
'checkbox' => <<'END_OF_FUNC',
sub checkbox {
my($self,@p) = self_or_default(@_);
} else {
}
}
# Escape HTML
'escapeHTML' => <<'END_OF_FUNC',
sub escapeHTML {
# hack to work around earlier hacks
push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
return undef unless defined($toencode);
# $quot; was accidentally omitted from the HTML 3.2 DTD -- see
# <http://validator.w3.org/docs/errors.html#bad-entity> /
$toencode =~ s{"}{"}gso;
}
else {
$toencode =~ s{"}{"}gso;
}
# Handle bug in some browsers with Latin charsets
if ($self->{'.charset'}
$toencode =~ s{'}{'}gso;
if (defined $newlinestoo && $newlinestoo) {
}
}
return $toencode;
}
# unescape HTML -- used internally
'unescapeHTML' => <<'END_OF_FUNC',
sub unescapeHTML {
# hack to work around earlier hacks
push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
return undef unless defined($string);
: 1;
# thanks to Randal Schwartz for the correct solution to this one
$string=~ s[&(\S*?);]{
local $_ = $1;
/^amp$/i ? "&" :
/^quot$/i ? '"' :
/^gt$/i ? ">" :
/^lt$/i ? "<" :
/^#(\d+)$/ && $latin ? chr($1) :
/^#x([0-9a-f]+)$/i && $latin ? chr(hex($1)) :
$_
}gex;
return $string;
}
# Internal procedure - don't use
'_tableize' => <<'END_OF_FUNC',
sub _tableize {
my($result);
if (defined($columns)) {
}
if (defined($rows)) {
}
# rearrange into a pretty table
$result = "<table>";
for (@colheaders) {
$result .= "<th>$_</th>";
}
$result .= "<tr>";
}
$result .= "</tr>";
}
$result .= "</table>";
return $result;
}
#### Method: radio_group
# Create a list of logically-linked radio buttons.
# Parameters:
# $name -> Common name for all the buttons.
# $values -> A pointer to a regular array containing the
# values for each button in the group.
# $default -> (optional) Value of the button to turn on by default. Pass '-'
# to turn _nothing_ on.
# $linebreak -> (optional) Set to true to place linebreaks
# between the buttons.
# $labels -> (optional)
# A pointer to a hash of labels to print next to each checkbox
# in the form $label{'value'}="Long explanatory label".
# Otherwise the provided values are used as the labels.
# Returns:
# An ARRAY containing a series of <input type="radio"> fields
####
'radio_group' => <<'END_OF_FUNC',
sub radio_group {
my($self,@p) = self_or_default(@_);
}
#### Method: checkbox_group
# Create a list of logically-linked checkboxes.
# Parameters:
# $name -> Common name for all the check boxes
# $values -> A pointer to a regular array containing the
# values for each checkbox in the group.
# $defaults -> (optional)
# 1. If a pointer to a regular array of checkbox values,
# then this will be used to decide which
# checkboxes to turn on by default.
# 2. If a scalar, will be assumed to hold the
# value of a single checkbox in the group to turn on.
# $linebreak -> (optional) Set to true to place linebreaks
# between the buttons.
# $labels -> (optional)
# A pointer to a hash of labels to print next to each checkbox
# in the form $label{'value'}="Long explanatory label".
# Otherwise the provided values are used as the labels.
# Returns:
# An ARRAY containing a series of <input type="checkbox"> fields
####
'checkbox_group' => <<'END_OF_FUNC',
sub checkbox_group {
my($self,@p) = self_or_default(@_);
}
'_box_group' => <<'END_OF_FUNC',
sub _box_group {
my $self = shift;
my $box_type = shift;
],@_);
# If no check array is specified, check the first by default
my %tabs = ();
if (!ref $tabindex) {
} elsif (ref $tabindex eq 'ARRAY') {
} elsif (ref $tabindex eq 'HASH') {
}
}
my $radio_checked;
my %disabled;
for (@{$disabled}) {
$disabled{$_}=1;
}
for (@values) {
my $disable="";
if ($disabled{$_}) {
$disable="disabled='1'";
}
: $checked{$_});
my($break);
if ($linebreak) {
}
else {
$break = '';
}
my($label)='';
$label = $_;
}
$_=$self->_maybe_escapeHTML($_);
if ($XHTML) {
push @elements,
qq(<input type="$box_type" name="$name" value="$_" $checkit$other$tab$attribs$disable/>$label)).${break};
} else {
push(@elements,qq/<input type="$box_type" name="$name" value="$_" $checkit$other$tab$attribs$disable>${label}${break}/);
}
}
return wantarray ? @elements : "@elements"
}
#### Method: popup_menu
# Create a popup menu.
# Parameters:
# $name -> Name for all the menu
# $values -> A pointer to a regular array containing the
# text of each menu item.
# $default -> (optional) Default item to display
# $labels -> (optional)
# A pointer to a hash of labels to print next to each checkbox
# in the form $label{'value'}="Long explanatory label".
# Otherwise the provided values are used as the labels.
# Returns:
# A string containing the definition of a popup menu.
####
'popup_menu' => <<'END_OF_FUNC',
sub popup_menu {
my($self,@p) = self_or_default(@_);
} elsif (defined $default) {
? @$default
: $default;
}
my(@values);
for (@values) {
if (/<optgroup/) {
for my $v (split(/\n/)) {
}
$result .= "$v\n";
}
}
else {
my($label) = $_;
$result .= "<option${attribs} ${selectit}value=\"$value\">$label</option>\n";
}
}
$result .= "</select>";
return $result;
}
#### Method: optgroup
# Create a optgroup.
# Parameters:
# $name -> Label for the group
# $values -> A pointer to a regular array containing the
# values for each option line in the group.
# $labels -> (optional)
# A pointer to a hash of labels to print next to each item
# in the form $label{'value'}="Long explanatory label".
# Otherwise the provided values are used as the labels.
# $labeled -> (optional)
# A true value indicates the value should be used as the label attribute
# in the option elements.
# The label attribute specifies the option label presented to the user.
# This defaults to the content of the <option> element, but the label
# attribute allows authors to more easily use optgroup without sacrificing
# compatibility with browsers that do not support option groups.
# $novals -> (optional)
# A true value indicates to suppress the val attribute in the option elements
# Returns:
# A string containing the definition of an option group.
####
'optgroup' => <<'END_OF_FUNC',
sub optgroup {
my($self,@p) = self_or_default(@_);
for (@values) {
if (/<optgroup/) {
for (split(/\n/)) {
$result .= "$_\n";
}
}
else {
my($label) = $_;
: "<option$attribs label=\"$value\" value=\"$value\">$label</option>\n"
: $novals ? "<option$attribs>$label</option>\n"
: "<option$attribs value=\"$value\">$label</option>\n";
}
}
$result .= "</optgroup>";
return $result;
}
#### Method: scrolling_list
# Create a scrolling list.
# Parameters:
# $name -> name for the list
# $values -> A pointer to a regular array containing the
# values for each option line in the list.
# $defaults -> (optional)
# 1. If a pointer to a regular array of options,
# then this will be used to decide which
# lines to turn on by default.
# 2. Otherwise holds the value of the single line to turn on.
# $size -> (optional) Size of the list.
# $multiple -> (optional) If set, allow multiple selections.
# $labels -> (optional)
# A pointer to a hash of labels to print next to each checkbox
# in the form $label{'value'}="Long explanatory label".
# Otherwise the provided values are used as the labels.
# Returns:
# A string containing the definition of a scrolling list.
####
'scrolling_list' => <<'END_OF_FUNC',
sub scrolling_list {
my($self,@p) = self_or_default(@_);
for (@values) {
if (/<optgroup/) {
for my $v (split(/\n/)) {
}
$result .= "$v\n";
}
}
else {
my($label) = $_;
$result .= "<option${attribs} ${selectit}value=\"$value\">$label</option>\n";
}
}
$result .= "</select>";
return $result;
}
#### Method: hidden
# Parameters:
# $name -> Name of the hidden field
# @default -> (optional) Initial values of field (may be an array)
# or
# $default->[initial values of field]
# Returns:
# A string containing a <input type="hidden" name="name" value="value">
####
'hidden' => <<'END_OF_FUNC',
sub hidden {
my($self,@p) = self_or_default(@_);
# this is the one place where we departed from our standard
# calling scheme, so we have to special-case (darn)
my $do_override = 0;
if ( ref($p[0]) || substr($p[0],0,1) eq '-') {
$do_override = $override;
} else {
push(@value,$_) if defined($_);
}
undef @other;
}
# use previous values if override is not set
for (@value) {
}
}
#### Method: image_button
# Parameters:
# $name -> Name of the button
# $src -> URL of the image source
# $align -> Alignment style (TOP, BOTTOM or MIDDLE)
# Returns:
# A string containing a <input type="image" name="name" src="url" align="alignment">
####
'image_button' => <<'END_OF_FUNC',
sub image_button {
my($self,@p) = self_or_default(@_);
}
#### Method: self_url
# Returns a URL containing the current script and all its
# to create a link that, when selected, will reinvoke the
# script with all its state information preserved.
####
'self_url' => <<'END_OF_FUNC',
sub self_url {
my($self,@p) = self_or_default(@_);
}
# This is provided as a synonym to self_url() for people unfortunate
# enough to have incorporated it into their programs already!
'state' => <<'END_OF_FUNC',
sub state {
&self_url;
}
#### Method: url
# Like self_url, but doesn't return the query string part of
# the URL.
####
'url' => <<'END_OF_FUNC',
sub url {
my($self,@p) = self_or_default(@_);
rearrange(['RELATIVE','ABSOLUTE','FULL',['PATH','PATH_INFO'],['QUERY','QUERY_STRING'],'BASE','REWRITE'],@p);
my $url = '';
$uri =~ s/\?.*$//s; # remove query string
# $uri =~ s/\Q$path\E$// if defined $path; # remove path
if ($full) {
$url = "$protocol://";
$vh =~ s/\:\d+$//; # some clients add the port number (incorrectly). Get rid of it.
# add the port to the url unless it's the protocol's default port
} elsif ($relative) {
} elsif ($absolute) {
}
$url ||= '';
return $url;
}
#### Method: cookie
# Set or read a cookie from the specified name.
# Cookie can then be passed to header().
# Usual rules apply to the stickiness of -value.
# Parameters:
# -name -> name for this cookie (optional)
# -value -> value of this cookie (scalar, array or hash)
# -path -> paths for which this cookie is valid (optional)
# -domain -> internet domain in which this cookie is valid (optional)
# -secure -> if true, cookie only passed through secure channel (optional)
# -expires -> expiry date in format Wdy, DD-Mon-YYYY HH:MM:SS GMT (optional)
####
'cookie' => <<'END_OF_FUNC',
sub cookie {
my($self,@p) = self_or_default(@_);
# if no value is supplied, then we retrieve the
# value of the cookie, if any. For efficiency, we cache the parsed
# cookies in our state variables.
unless ( defined($value) ) {
# If no name is supplied, then retrieve the names of all our cookies.
return () unless $self->{'.cookies'};
}
# If we get here, we're creating a new cookie
my @param;
}
'parse_keywordlist' => <<'END_OF_FUNC',
sub parse_keywordlist {
$tosplit=~tr/+/ /; # pluses to spaces
return @keywords;
}
'param_fetch' => <<'END_OF_FUNC',
sub param_fetch {
my($self,@p) = self_or_default(@_);
return [] unless defined $name;
}
}
###############################################
# OTHER INFORMATION PROVIDED BY THE ENVIRONMENT
###############################################
#### Method: path_info
# Return the extra virtual path information provided
# after the URL (if any)
####
'path_info' => <<'END_OF_FUNC',
sub path_info {
if (defined($info)) {
} elsif (! defined($self->{'.path_info'}) ) {
}
return $self->{'.path_info'};
}
# This function returns a potentially modified version of SCRIPT_NAME
# and PATH_INFO. Some HTTP servers do sanitise the paths in those
# variables. It is the case of at least Apache 2. If for instance the
# user requests: /path/./to/script.cgi/x//y/z/../x?y, Apache will set:
# REQUEST_URI=/path/./to/script.cgi/x//y/z/../x?y
# PATH_INFO=/x/y/x
#
# This is all fine except that some bogus CGI scripts expect
# PATH_INFO=/http://foo when the user requests
#
# Old versions of this module used to accomodate with those scripts, so
# this is why we do this here to keep those scripts backward compatible.
# Basically, we accomodate with those scripts but within limits, that is
# we only try to preserve the number of / that were provided by the user
# if $REQUEST_URI and "$SCRIPT_NAME$PATH_INFO" only differ by the number
# of consecutive /.
#
# So for instance, in: http://foo/x//y/script.cgi/a//b, we'll return a
# script_name of /x//y/script.cgi and a path_info of /a//b, but in:
# http://foo/./x//z/script.cgi/a/../b//c, we'll return the versions
# possibly sanitised by the HTTP server, so in the case of Apache 2:
# script_name == /foo/x/z/script.cgi and path_info == /b/c.
#
# Future versions of this module may no longer do that, so one should
# avoid relying on the browser, proxy, server, and CGI.pm preserving the
# number of consecutive slashes as no guarantee can be made there.
'_name_and_path_from_env' => <<'END_OF_FUNC',
sub _name_and_path_from_env {
my $self = shift;
$uri =~ s/\?.*//s;
if ($uri ne "$script_name$path_info") {
my $script_name_pattern = quotemeta($script_name);
my $path_info_pattern = quotemeta($path_info);
$script_name_pattern =~ s{(?:\\/)+}{/+}g;
$path_info_pattern =~ s{(?:\\/)+}{/+}g;
# REQUEST_URI and SCRIPT_NAME . PATH_INFO only differ by the
# numer of consecutive slashes, so we can extract the info from
# REQUEST_URI:
}
}
return ($script_name,$path_info);
}
#### Method: request_method
# Returns 'POST', 'GET', 'PUT' or 'HEAD'
####
'request_method' => <<'END_OF_FUNC',
sub request_method {
}
#### Method: content_type
# Returns the content_type string
####
'content_type' => <<'END_OF_FUNC',
sub content_type {
}
#### Method: path_translated
# Return the physical path information provided
# by the URL (if any)
####
'path_translated' => <<'END_OF_FUNC',
sub path_translated {
}
#### Method: request_uri
# Return the literal request URI
####
'request_uri' => <<'END_OF_FUNC',
sub request_uri {
}
#### Method: query_string
# Synthesize a query string from our current
# parameters
####
'query_string' => <<'END_OF_FUNC',
sub query_string {
my($self) = self_or_default(@_);
next unless defined $value;
push(@pairs,"$eparam=$value");
}
}
for (keys %{$self->{'.fieldnames'}}) {
}
}
#### Method: accept
# Without parameters, returns an array of the
# MIME types the browser accepts.
# With a single parameter equal to a MIME
# type, will return undef if the browser won't
# accept it, 1 if the browser accepts it but
# doesn't give a preference, or a floating point
# value between 0.0 and 1.0 if the browser
# declares a quantitative score for it.
# This handles MIME type globs correctly.
####
'Accept' => <<'END_OF_FUNC',
sub Accept {
: ();
for (@accept) {
($pref) = /q=(\d\.\d+|\d+)/;
($type) = m#(\S+/[^;]+)#;
next unless $type;
}
# if a search type is provided, we may need to
# perform a pattern matching operation.
# The MIME types use a glob mechanism, which
# is easily translated into a perl pattern match
# First return the preference for directly supported
# types:
# Didn't get it, so try pattern matching.
for (keys %prefs) {
next unless /\*/; # not a pattern match
$pat =~ s/\*/.*/g; # turn it into a pattern
}
}
#### Method: user_agent
# If called with no parameters, returns the user agent.
# If called with one parameter, does a pattern match (case
# insensitive) on the user agent.
####
'user_agent' => <<'END_OF_FUNC',
sub user_agent {
return $user_agent =~ /$match/i;
}
#### Method: raw_cookie
# Returns the magic cookies for the session.
# The cookies are not parsed or altered in any way, i.e.
# cookies are returned exactly as given in the HTTP
# headers. If a cookie name is given, only that cookie's
# value is returned, otherwise the entire raw cookie
# is returned.
####
'raw_cookie' => <<'END_OF_FUNC',
sub raw_cookie {
if (defined($key)) {
unless $self->{'.raw_cookies'};
return () unless $self->{'.raw_cookies'};
}
}
#### Method: virtual_host
# Return the name of the virtual_host, which
# is not always the same as the server
######
'virtual_host' => <<'END_OF_FUNC',
sub virtual_host {
$vh =~ s/:\d+$//; # get rid of port number
return $vh;
}
#### Method: remote_host
# Return the name of the remote host, or its IP
# address if unavailable. If this variable isn't
# defined, it returns "localhost" for debugging
# purposes.
####
'remote_host' => <<'END_OF_FUNC',
sub remote_host {
|| 'localhost';
}
#### Method: remote_addr
# Return the IP addr of the remote host.
####
'remote_addr' => <<'END_OF_FUNC',
sub remote_addr {
}
#### Method: script_name
# Return the partial URL to this script for
# self-referencing scripts. Also see
# self_url(), which returns a URL with all state information
# preserved.
####
'script_name' => <<'END_OF_FUNC',
sub script_name {
my ($self,@p) = self_or_default(@_);
if (@p) {
$self->{'.script_name'} = shift @p;
} elsif (!exists $self->{'.script_name'}) {
}
return $self->{'.script_name'};
}
#### Method: referer
# Return the HTTP_REFERER: useful for generating
# a GO BACK button.
####
'referer' => <<'END_OF_FUNC',
sub referer {
my($self) = self_or_CGI(@_);
}
#### Method: server_name
# Return the name of the server
####
'server_name' => <<'END_OF_FUNC',
sub server_name {
}
#### Method: server_software
# Return the name of the server software
####
'server_software' => <<'END_OF_FUNC',
sub server_software {
}
#### Method: virtual_port
# Return the server port, taking virtual hosts into account
####
'virtual_port' => <<'END_OF_FUNC',
sub virtual_port {
my($self) = self_or_default(@_);
if ($vh) {
} else {
return $self->server_port();
}
}
#### Method: server_port
####
'server_port' => <<'END_OF_FUNC',
sub server_port {
}
#### Method: server_protocol
# Return the protocol (usually HTTP/1.0)
####
'server_protocol' => <<'END_OF_FUNC',
sub server_protocol {
}
#### Method: http
# Return the value of an HTTP variable, or
# the list of variables if none provided
####
'http' => <<'END_OF_FUNC',
sub http {
if ( defined($parameter) ) {
}
return $ENV{"HTTP_$parameter"};
}
}
#### Method: https
# Return the value of HTTPS, or
# the value of an HTTPS variable, or
# the list of variables
####
'https' => <<'END_OF_FUNC',
sub https {
if ( defined($parameter) ) {
}
return $ENV{"HTTPS_$parameter"};
}
return wantarray
: $ENV{'HTTPS'};
}
#### Method: protocol
# Return the protocol (http or https currently)
####
'protocol' => <<'END_OF_FUNC',
sub protocol {
local($^W)=0;
my $self = shift;
return "\L$protocol\E";
}
#### Method: remote_ident
# Return the identity of the remote user
# (but only if his host is running identd)
####
'remote_ident' => <<'END_OF_FUNC',
sub remote_ident {
}
#### Method: auth_type
# Return the type of use verification/authorization in use, if any.
####
'auth_type' => <<'END_OF_FUNC',
sub auth_type {
}
#### Method: remote_user
# Return the authorization name used for user
# verification.
####
'remote_user' => <<'END_OF_FUNC',
sub remote_user {
}
#### Method: user_name
# Try to return the remote user's name by hook or by
# crook
####
'user_name' => <<'END_OF_FUNC',
sub user_name {
my ($self) = self_or_CGI(@_);
}
#### Method: nosticky
# Set or return the NOSTICKY global flag
####
'nosticky' => <<'END_OF_FUNC',
sub nosticky {
}
#### Method: nph
# Set or return the NPH global flag
####
'nph' => <<'END_OF_FUNC',
sub nph {
}
#### Method: private_tempfiles
# Set or return the private_tempfiles global flag
####
'private_tempfiles' => <<'END_OF_FUNC',
sub private_tempfiles {
return $CGI::PRIVATE_TEMPFILES;
}
#### Method: close_upload_files
# Set or return the close_upload_files global flag
####
'close_upload_files' => <<'END_OF_FUNC',
sub close_upload_files {
return $CGI::CLOSE_UPLOAD_FILES;
}
#### Method: default_dtd
# Set or return the default_dtd global
####
'default_dtd' => <<'END_OF_FUNC',
sub default_dtd {
} elsif (defined $param) {
}
return $CGI::DEFAULT_DTD;
}
# -------------- really private subroutines -----------------
'_maybe_escapeHTML' => <<'END_OF_FUNC',
sub _maybe_escapeHTML {
# hack to work around earlier hacks
push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
return undef unless defined($toencode);
}
'previous_or_default' => <<'END_OF_FUNC',
sub previous_or_default {
my(%selected);
(ref($defaults) eq 'ARRAY')) {
} else {
}
return %selected;
}
'register_parameter' => <<'END_OF_FUNC',
sub register_parameter {
}
'get_fields' => <<'END_OF_FUNC',
sub get_fields {
my($self) = @_;
'-override'=>1);
}
'read_from_cmdline' => <<'END_OF_FUNC',
sub read_from_cmdline {
my($query_string);
my($subpath);
} elsif ($DEBUG > 1) {
require "shellwords.pl";
print STDERR "(offline mode: enter name=value pairs on standard input; press ^D or ^Z when done)\n";
}
for (@words) {
s/\\=/%3D/g;
s/\\&/%26/g;
}
if ("@words"=~/=/) {
} else {
}
if ($query_string =~ /^(.*?)\?(.*)$/)
{
$query_string = $2;
$subpath = $1;
}
}
#####
# subroutine: read_multipart
#
# Read multipart data and store it into our parameters.
# An interesting feature is that if any of the parts is a file, we
# create a temporary file and open up a filehandle on it so that the
# caller can read from it if necessary.
#####
'read_multipart' => <<'END_OF_FUNC',
sub read_multipart {
return unless $buffer;
my $filenumber = 0;
while (!$buffer->eof) {
unless (%header) {
return;
}
# See RFC 1867, 2183, 2045
# NB: File content will be loaded into memory should
# content-disposition parsing fail.
# Test for Opera's multiple upload feature
1 : 0;
# add this parameter to our list
# If no filename specified, then just read the data and assign it
# to our parameter list.
next;
}
UPLOADS: {
# If we get here, then we are dealing with a potentially large
# uploaded form. Save the data to a temporary file, then open
# the file for reading.
# skip the file if uploads disabled
if ($DISABLE_UPLOADS) {
last UPLOADS;
}
# set the filename to some recognizable value
}
# choose a relatively unpredictable tmpfile sequence number
$seqno += int rand(100);
}
die "CGI.pm open of tmpfile $tmp/$filename failed: $!\n" unless defined $filehandle;
&& defined fileno($filehandle);
# together with the body for later parsing with an external
# MIME parser module
if ( $multipart ) {
for ( keys %header ) {
print $filehandle "$_: $header{$_}${CRLF}";
}
print $filehandle "${CRLF}";
}
my ($data);
local($\) = '';
my $totalbytes = 0;
if (defined $self->{'.upload_hook'})
{
$totalbytes += length($data);
}
}
# back up to beginning of file
## Close the filehandle if requested this allows a multipart MIME
## upload to contain many files, and we won't die due to too many
## open file handles. The user can access the files using the hash
## below.
close $filehandle if $CLOSE_UPLOAD_FILES;
# Save some information about the uploaded file where we can get
# at it later.
# Use the typeglob as the key, as this is guaranteed to be
# unique for each filehandle. Don't use the file descriptor as
# this will be re-used for each filehandle if the
# close_upload_files feature is used.
hndl => $filehandle,
};
}
}
}
#####
# subroutine: read_multipart_related
#
# first parameter sets the start of the data. The part identified by
# this Content-ID will not be stored as a file upload, but will be
# returned by this method. All other parts will be available as file
# uploads accessible by their Content-ID
#####
'read_multipart_related' => <<'END_OF_FUNC',
sub read_multipart_related {
return unless $buffer;
my $filenumber = 0;
my $returnvalue;
while (!$buffer->eof) {
unless (%header) {
return;
}
# If this is the start part, then just read the data and assign it
# to our return variable.
$returnvalue .= $TAINTED;
next;
}
# add this parameter to our list
UPLOADS: {
# If we get here, then we are dealing with a potentially large
# uploaded form. Save the data to a temporary file, then open
# the file for reading.
# skip the file if uploads disabled
if ($DISABLE_UPLOADS) {
last UPLOADS;
}
# choose a relatively unpredictable tmpfile sequence number
$seqno += int rand(100);
}
die "CGI open of tmpfile: $!\n" unless defined $filehandle;
&& defined fileno($filehandle);
my ($data);
local($\) = '';
my $totalbytes;
if (defined $self->{'.upload_hook'})
{
$totalbytes += length($data);
}
}
# back up to beginning of file
## Close the filehandle if requested this allows a multipart MIME
## upload to contain many files, and we won't die due to too many
## open file handles. The user can access the files using the hash
## below.
close $filehandle if $CLOSE_UPLOAD_FILES;
# Save some information about the uploaded file where we can get
# at it later.
# Use the typeglob as the key, as this is guaranteed to be
# unique for each filehandle. Don't use the file descriptor as
# this will be re-used for each filehandle if the
# close_upload_files feature is used.
hndl => $filehandle,
};
}
}
return $returnvalue;
}
'upload' =><<'END_OF_FUNC',
sub upload {
return unless @param;
}
'tmpFileName' => <<'END_OF_FUNC',
sub tmpFileName {
: '';
}
'uploadInfo' => <<'END_OF_FUNC',
sub uploadInfo {
}
# internal routine, don't use
'_set_values_and_labels' => <<'END_OF_FUNC',
sub _set_values_and_labels {
my $self = shift;
my ($v,$l,$n) = @_;
$$l = $v if ref($v) eq 'HASH' && !ref($$l);
return $v if !ref($v);
return ref($v) eq 'HASH' ? keys %$v : @$v;
}
# internal routine, don't use
'_set_attributes' => <<'END_OF_FUNC',
sub _set_attributes {
my $self = shift;
my($element, $attributes) = @_;
$attribs = ' ';
(my $clean_attrib = $attrib) =~ s/^-//;
$attribs .= "@{[lc($clean_attrib)]}=\"$attributes->{$element}{$attrib}\" ";
}
$attribs =~ s/ $//;
return $attribs;
}
'_compile_all' => <<'END_OF_FUNC',
sub _compile_all {
for (@_) {
next if defined(&$_);
$AUTOLOAD = "CGI::$_";
_compile();
}
}
);
;
#########################################################
# Globals and stubs for other packages that we use.
#########################################################
################### Fh -- lightweight filehandle ###############
package Fh;
use overload
'""' => \&asString,
'cmp' => \&compare,
'fallback'=>1;
$FH='fh00000';
sub DESTROY {
my $self = shift;
close $self;
}
$AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
%SUBS = (
'asString' => <<'END_OF_FUNC',
sub asString {
my $self = shift;
# get rid of package name
$i =~ s/%(..)/ chr(hex($1)) /eg;
# BEGIN DEAD CODE
# This was an extremely clever patch that allowed "use strict refs".
# Unfortunately it relied on another bug that caused leaky file descriptors.
# The underlying bug has been fixed, so this no longer works. However
# "strict refs" still works for some reason.
# my $self = shift;
# return ${*{$self}{SCALAR}};
# END DEAD CODE
}
'compare' => <<'END_OF_FUNC',
sub compare {
my $self = shift;
my $value = shift;
return "$self" cmp $value;
}
'new' => <<'END_OF_FUNC',
sub new {
my $ref = \*{"Fh::$fv"};
# Note this same regex is also used elsewhere in the same file for CGITempFile::new
my $safe = $1;
}
'handle' => <<'END_OF_FUNC',
sub handle {
my $self = shift;
}
);
######################## MultipartBuffer ####################
package MultipartBuffer;
# how many bytes to read at a time. We use
# a 4K buffer by default.
#reuse the autoload function
# avoid autoloader warnings
sub DESTROY {}
###############################################################################
################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
###############################################################################
$AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
%SUBS = (
'new' => <<'END_OF_FUNC',
sub new {
$FILLUNIT = $INITIAL_FILLUNIT;
# If the user types garbage into the file upload field,
# then Netscape passes NOTHING to the server (not good).
# We may hang on this read in that case. So we implement
# a read timeout. If nothing is ready to read
# by then, we return.
# Netscape seems to be a little bit unreliable
# about providing boundary strings.
my $boundary_read = 0;
if ($boundary) {
# Under the MIME spec, the boundary consists of the
# characters "--" PLUS the Boundary string
# BUG: IE 3.01 on the Macintosh uses just the boundary -- not
# the two extra hyphens. We do a special case here on the user-agent!!!!
} else { # otherwise we find it ourselves
my($old);
chomp($boundary); # remove the CRLF
$/ = $old; # restore old line separator
$boundary_read++;
}
BUFFER=>'',
};
# Read the preamble and the topmost (boundary) line plus the CRLF.
unless ($boundary_read) {
while ($self->read(0)) { }
}
die "Malformed multipart POST: data truncated\n" if $self->eof;
return $retval;
}
'readHeader' => <<'END_OF_FUNC',
sub readHeader {
my($self) = @_;
my($end);
my($ok) = 0;
my($bad) = 0;
do {
# this was a bad idea
# $FILLUNIT *= 2 if length($self->{BUFFER}) >= $FILLUNIT;
return () if $bad;
#EBCDIC NOTE: translate header into EBCDIC, but watch out for continuation lines!
my %return;
warn "untranslated header=$header\n" if DEBUG;
warn "translated header=$header\n" if DEBUG;
}
# See RFC 2045 Appendix A and RFC 822 sections 3.4.8
# (Folding Long Header Fields), 3.4.3 (Comments)
# and 3.4.5 (Quoted-Strings).
my $token = '[-\w!\#$%&\'*+.^_\`|{}~]';
}
return %return;
}
# This reads and returns the body as a single scalar value.
'readBody' => <<'END_OF_FUNC',
sub readBody {
my($self) = @_;
my($data);
my($returnval)='';
#EBCDIC NOTE: want to translate returnval into EBCDIC HERE
}
warn "untranslated body=$returnval\n" if DEBUG;
warn "translated body=$returnval\n" if DEBUG;
}
return $returnval;
}
# This will read $bytes or until the boundary is hit, whichever happens
# first. After the boundary is hit, we return undef. The next read will
# skip over the boundary and begin reading again;
'read' => <<'END_OF_FUNC',
sub read {
# default number of bytes to read
# Fill up our internal buffer in such a way that the boundary
# is never split between reads.
my $boundary_end = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY}.'--') : $self->{BOUNDARY}.'--';
# Find the boundary in the buffer (it may not be there).
warn "boundary=$self->{BOUNDARY} length=$self->{LENGTH} start=$start\n" if DEBUG;
# protect against malformed multipart POST operations
#EBCDIC NOTE: want to translate boundary search into ASCII here.
# If the boundary begins the data, then skip past it
# and return undef.
if ($start == 0) {
# clear us out completely if we've hit the last boundary.
return undef;
}
# just remove the boundary.
return undef;
}
my $bytesToReturn;
} else { # read the requested number of bytes
# leave enough bytes in the buffer to allow us to read
# the boundary. Thanks to Kevin Hendrick for finding
# this one.
}
# If we hit the boundary, remove the CRLF from the end.
return ($bytesToReturn==$start)
}
# This fills up our internal buffer in such a way that the
# boundary is never split between reads
'fillBuffer' => <<'END_OF_FUNC',
sub fillBuffer {
# Try to read some data. We may hang here if the browser is screwed up.
$bufferLength);
warn "bytesToRead=$bytesToRead, bufferLength=$bufferLength, buffer=$self->{BUFFER}\n" if DEBUG;
# An apparent bug in the Apache server causes the read()
# to return zero bytes repeatedly without blocking if the
# remote user aborts during a file transfer. I don't know how
# they manage this, but the workaround is to abort if we get
# more than SPIN_LOOP_MAX consecutive zero reads.
if ($bytesRead <= 0) {
die "CGI.pm: Server closed socket during multipart read (client aborted?).\n"
} else {
}
}
# Return true when we've finished reading
'eof' => <<'END_OF_FUNC'
sub eof {
my($self) = @_;
undef;
}
);
####################################################################################
################################## TEMPORARY FILES #################################
####################################################################################
package CGITempFile;
sub find_tempdir {
unless (defined $TMPDIRECTORY) {
"C:${SL}temp","${SL}tmp","${SL}temp",
"${vol}${SL}Temporary Items",
"${SL}WWW_ROOT", "${SL}SYS\$SCRATCH",
"C:${SL}system${SL}temp");
# PeterH: These evars may not exist if this is invoked within a service and untainting
# is in effect - with 'use warnings' the undefined array entries causes Perl to die
}
# this feature was supposed to provide per-user tmpfiles, but
# it is problematic.
# unshift(@TEMP,(getpwuid($<))[7].'/tmp') if $CGI::OS eq 'UNIX';
# Rob: getpwuid() is unfortunately UNIX specific. On brain dead OS'es this
# : can generate a 'getpwuid() not implemented' exception, even though
# : Refer to getpwuid() only at run-time if we're fortunate and have UNIX.
# unshift(@TEMP,(eval {(getpwuid($>))[7]}).'/tmp') if $CGI::OS eq 'UNIX' and $> != 0;
for (@TEMP) {
do {$TMPDIRECTORY = $_; last} if -d $_ && -w _;
}
}
}
find_tempdir();
$MAXTRIES = 5000;
# cute feature, but overload implementation broke it
# %OVERLOAD = ('""'=>'as_string');
sub DESTROY {
my($self) = @_;
unlink $safe; # get rid of the file
}
###############################################################################
################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
###############################################################################
$AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
%SUBS = (
'new' => <<'END_OF_FUNC',
sub new {
my $filename;
unless (-w $TMPDIRECTORY) {
$TMPDIRECTORY = undef;
find_tempdir();
}
for (my $i = 0; $i < $MAXTRIES; $i++) {
}
# check that it is a more-or-less valid filename
# Note this same regex is also used elsewhere in the same file for Fh::new
# this used to untaint, now it doesn't
# $filename = $1;
return bless \$filename;
}
'as_string' => <<'END_OF_FUNC'
sub as_string {
my($self) = @_;
return $$self;
}
);
package CGI;
# We get a whole bunch of warnings about "possibly uninitialized variables"
# when running with the -w switch. Touch them all once to get rid of the
# warnings. This is ugly and I hate it.
if ($^W) {
;
}
1;
=head1 NAME
CGI - Handle Common Gateway Interface requests and responses
=head1 SYNOPSIS
use CGI;
my $q = CGI->new;
# Process an HTTP request
@values = $q->param('form_field');
$fh = $q->upload('file_field');
$riddle = $query->cookie('riddle_name');
%answers = $query->cookie('answers');
# Prepare various HTTP responses
print $q->header();
print $q->header('application/json');
$cookie1 = $q->cookie(-name=>'riddle_name', -value=>"The Sphynx's Question");
$cookie2 = $q->cookie(-name=>'answers', -value=>\%answers);
print $q->header(
-expires => '+3d',
-cookie => [$cookie1,$cookie2]
);
print $q->redirect('http://somewhere.else/in/movie/land');
=head1 DESCRIPTION
CGI.pm is a stable, complete and mature solution for processing and preparing
HTTP requests and responses. Major features including processing form
submissions, file uploads, reading and writing cookies, query string generation
and manipulation, and processing and preparing HTTP headers. Some HTML
generation utilities are included as well.
with built-in support for mod_perl and mod_perl2 as well as FastCGI.
It has the benefit of having developed and refined over 10 years with input
from dozens of contributors and being deployed on thousands of websites.
CGI.pm has been included in the Perl distribution since Perl 5.4, and has
become a de-facto standard.
=head2 PROGRAMMING STYLE
There are two styles of programming with CGI.pm, an object-oriented
style and a function-oriented style. In the object-oriented style you
create one or more CGI objects and then use object methods to create
the various elements of the page. Each CGI object starts out with the
list of named parameters that were passed to your CGI script by the
server. You can modify the objects, save them to a file or database
and recreate them. Because each object corresponds to the "state" of
the CGI script, and because each object's parameter list is
independent of the others, this allows you to save the state of the
script and restore it later.
For example, using the object oriented style, here is how you create
a simple "Hello World" HTML page:
use CGI; # load CGI routines
$q = CGI->new; # create new CGI object
print $q->header, # create the HTTP header
$q->start_html('hello world'), # start the HTML
$q->h1('hello world'), # level 1 header
$q->end_html; # end the HTML
In the function-oriented style, there is one default CGI object that
you rarely deal with directly. Instead you just call functions to
retrieve CGI parameters, create HTML tags, manage cookies, and so
on. This provides you with a cleaner programming interface, but
limits you to using one CGI object at a time. The following example
prints the same page, but uses the function-oriented interface.
The main differences are that we now need to import a set of functions
into our name space (usually the "standard" functions), and we don't
need to create the CGI object.
use CGI qw/:standard/; # load standard CGI routines
print header, # create the HTTP header
start_html('hello world'), # start the HTML
h1('hello world'), # level 1 header
end_html; # end the HTML
The examples in this document mainly use the object-oriented style.
See HOW TO IMPORT FUNCTIONS for important information on
function-oriented programming in CGI.pm
=head2 CALLING CGI.PM ROUTINES
Most CGI.pm routines accept several arguments, sometimes as many as 20
optional ones! To simplify this interface, all routines use a named
argument calling style that looks like this:
Each argument name is preceded by a dash. Neither case nor order
matters in the argument list. -type, -Type, and -TYPE are all
acceptable. In fact, only the first argument needs to begin with a
dash. If a dash is present in the first argument, CGI.pm assumes
dashes for the subsequent ones.
Several routines are commonly called with just one argument. In the
case of these routines you can provide the single argument without an
argument name. header() happens to be one of these routines. In this
case, the single argument is the document type.
Other such routines are documented below.
Sometimes named arguments expect a scalar, sometimes a reference to an
array, and sometimes a reference to a hash. Often, you can pass any
type of argument and the routine will do whatever is most appropriate.
For example, the param() routine is used to set a CGI parameter to a
single or a multi-valued value. The two cases are shown below:
$q->param(-name=>'veggie',-value=>'tomato');
$q->param(-name=>'veggie',-value=>['tomato','tomahto','potato','potahto']);
A large number of routines in CGI.pm actually aren't specifically
defined in the module, but are generated automatically as needed.
These are the "HTML shortcuts," routines that generate HTML tags for
use in dynamically-generated pages. HTML tags have both attributes
(the attribute="value" pairs within the tag itself) and contents (the
part between the opening and closing pairs.) To distinguish between
attributes and contents, CGI.pm uses the convention of passing HTML
attributes as a hash reference as the first argument, and the
contents, if any, as any subsequent arguments. It works out like
this:
Code Generated HTML
---- --------------
h1() <h1>
h1('some','contents'); <h1>some contents</h1>
h1({-align=>left}); <h1 align="LEFT">
h1({-align=>left},'contents'); <h1 align="LEFT">contents</h1>
HTML tags are described in more detail later.
Many newcomers to CGI.pm are puzzled by the difference between the
calling conventions for the HTML shortcuts, which require curly braces
around the HTML tag attributes, and the calling conventions for other
routines, which manage to generate attributes without the curly
brackets. Don't be confused. As a convenience the curly braces are
optional in all but the HTML shortcuts. If you like, you can use
curly braces when calling any routine that takes named arguments. For
example:
If you use the B<-w> switch, you will be warned that some CGI.pm argument
names conflict with built-in Perl functions. The most frequent of
these is the -values argument, used to create multi-valued menus,
radio button clusters and the like. To get around this warning, you
have several choices:
=over 4
=item 1.
Use another name for the argument, if one is available.
For example, -value is an alias for -values.
=item 2.
Change the capitalization, e.g. -Values
=item 3.
Put quotes around the argument name, e.g. '-values'
=back
Many routines will do something useful with a named argument that it
doesn't recognize. For example, you can produce non-standard HTTP
header fields by providing them as named arguments:
-cost => 'Three smackers',
-annoyance_level => 'high',
-complaints_to => 'bit bucket');
This will produce the following nonstandard HTTP header:
HTTP/1.0 200 OK
Cost: Three smackers
Annoyance-level: high
Complaints-to: bit bucket
Notice the way that underscores are translated automatically into
hyphens. HTML-generating routines perform a different type of
translation.
This feature allows you to keep up with the rapidly changing HTTP and
HTML "standards".
=head2 CREATING A NEW QUERY OBJECT (OBJECT-ORIENTED STYLE):
$query = CGI->new;
This will parse the input (from both POST and GET methods) and store
it into a perl5 object called $query.
Any filehandles from file uploads will have their position reset to
the beginning of the file.
=head2 CREATING A NEW QUERY OBJECT FROM AN INPUT FILE
$query = CGI->new(INPUTFILE);
If you provide a file handle to the new() method, it will read
parameters from the file (or STDIN, or whatever). The file can be in
any of the forms describing below under debugging (i.e. a series of
newline delimited TAG=VALUE pairs will work). Conveniently, this type
of file is created by the save() method (see below). Multiple records
can be saved and restored.
Perl purists will be pleased to know that this syntax accepts
references to file handles, or even references to filehandle globs,
which is the "official" way to pass a filehandle:
$query = CGI->new(\*STDIN);
You can also initialize the CGI object with a FileHandle or IO::File
object.
If you are using the function-oriented interface and want to
initialize CGI state from a file handle, the way to do this is with
B<restore_parameters()>. This will (re)initialize the
default CGI object from the indicated file handle.
open (IN,"test.in") || die;
restore_parameters(IN);
close IN;
You can also initialize the query object from a hash
reference:
$query = CGI->new( {'dinosaur'=>'barney',
'song'=>'I love you',
);
or from a properly formatted, URL-escaped query string:
$query = CGI->new('dinosaur=barney&color=purple');
or from a previously existing CGI object (currently this clones the
parameter list, but none of the other object-specific fields, such as
autoescaping):
$old_query = CGI->new;
$new_query = CGI->new($old_query);
To create an empty query, initialize it from an empty string or hash:
$empty_query = CGI->new("");
-or-
$empty_query = CGI->new({});
=head2 FETCHING A LIST OF KEYWORDS FROM THE QUERY:
@keywords = $query->keywords
If the script was invoked as the result of an <ISINDEX> search, the
parsed keywords can be obtained as an array using the keywords() method.
=head2 FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT:
@names = $query->param
If the script was invoked with a parameter list
(e.g. "name1=value1&name2=value2&name3=value3"), the param() method
will return the parameter names as a list. If the script was invoked
as an <ISINDEX> script and contains a string without ampersands
(e.g. "value1+value2+value3") , there will be a single parameter named
"keywords" containing the "+"-delimited keywords.
NOTE: As of version 1.5, the array of parameter names returned will
be in the same order as they were submitted by the browser.
Usually this order is the same as the order in which the
parameters are defined in the form (however, this isn't part
of the spec, and so isn't guaranteed).
=head2 FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER:
@values = $query->param('foo');
-or-
$value = $query->param('foo');
Pass the param() method a single argument to fetch the value of the
named parameter. If the parameter is multivalued (e.g. from multiple
selections in a scrolling list), you can ask to receive an array. Otherwise
the method will return a single value.
If a value is not given in the query string, as in the queries
"name1=&name2=", it will be returned as an empty string.
If the parameter does not exist at all, then param() will return undef
in a scalar context, and the empty list in a list context.
=head2 SETTING THE VALUE(S) OF A NAMED PARAMETER:
$query->param('foo','an','array','of','values');
This sets the value for the named parameter 'foo' to an array of
values. This is one way to change the value of a field AFTER
the script has been invoked once before. (Another way is with
the -override parameter accepted by all methods that generate
form elements.)
param() also recognizes a named parameter style of calling described
in more detail later:
$query->param(-name=>'foo',-values=>['an','array','of','values']);
-or-
$query->param(-name=>'foo',-value=>'the value');
=head2 APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER:
$query->append(-name=>'foo',-values=>['yet','more','values']);
This adds a value or list of values to the named parameter. The
values are appended to the end of the parameter if it already exists.
Otherwise the parameter is created. Note that this method only
recognizes the named argument calling syntax.
=head2 IMPORTING ALL PARAMETERS INTO A NAMESPACE:
$query->import_names('R');
This creates a series of variables in the 'R' namespace. For example,
$R::foo, @R:foo. For keyword lists, a variable @R::keywords will appear.
If no namespace is given, this method will assume 'Q'.
WARNING: don't import anything into 'main'; this is a major security
risk!!!!
NOTE 1: Variable names are transformed as necessary into legal Perl
variable names. All non-legal characters are transformed into
underscores. If you need to keep the original names, you should use
the param() method instead to access CGI variables by name.
NOTE 2: In older versions, this method was called B<import()>. As of version 2.20,
this name has been removed completely to avoid conflict with the built-in
Perl module B<import> operator.
=head2 DELETING A PARAMETER COMPLETELY:
$query->delete('foo','bar','baz');
This completely clears a list of parameters. It sometimes useful for
resetting parameters that you don't want passed down between script
invocations.
If you are using the function call interface, use "Delete()" instead
to avoid conflicts with Perl's built-in delete operator.
=head2 DELETING ALL PARAMETERS:
$query->delete_all();
This clears the CGI object completely. It might be useful to ensure
that all the defaults are taken when you create a fill-out form.
Use Delete_all() instead if you are using the function call interface.
=head2 HANDLING NON-URLENCODED ARGUMENTS
If POSTed data is not of type application/x-www-form-urlencoded or
instead be returned as-is in a parameter named POSTDATA. To retrieve
it, use code like this:
my $data = $query->param('POSTDATA');
Likewise if PUTed data can be retrieved with code like this:
my $data = $query->param('PUTDATA');
(If you don't know what the preceding means, don't worry about it. It
only affects people trying to use CGI for XML processing and other
specialized tasks.)
=head2 DIRECT ACCESS TO THE PARAMETER LIST:
$q->param_fetch('address')->[1] = '1313 Mockingbird Lane';
unshift @{$q->param_fetch(-name=>'address')},'George Munster';
If you need access to the parameter list in a way that isn't covered
by the methods given in the previous sections, you can obtain a direct
reference to it by
calling the B<param_fetch()> method with the name of the parameter. This
will return an array reference to the named parameter, which you then
can manipulate in any way you like.
You can also use a named argument style using the B<-name> argument.
=head2 FETCHING THE PARAMETER LIST AS A HASH:
$params = $q->Vars;
print $params->{'address'};
@foo = split("\0",$params->{'foo'});
%params = $q->Vars;
use CGI ':cgi-lib';
$params = Vars;
Many people want to fetch the entire parameter list as a hash in which
the keys are the names of the CGI parameters, and the values are the
parameters' values. The Vars() method does this. Called in a scalar
context, it returns the parameter list as a tied hash reference.
Changing a key changes the value of the parameter in the underlying
CGI parameter list. Called in a list context, it returns the
parameter list as an ordinary hash. This allows you to read the
contents of the parameter list, but not to change it.
When using this, the thing you must watch out for are multivalued CGI
parameters. Because a hash cannot distinguish between scalar and
list context, multivalued parameters will be returned as a packed
string, separated by the "\0" (null) character. You must split this
packed string in order to get at the individual values. This is the
convention introduced long ago by Steve Brenner in his cgi-lib.pl
module for Perl version 4.
If you wish to use Vars() as a function, import the I<:cgi-lib> set of
function calls (also see the section on CGI-LIB compatibility).
=head2 SAVING THE STATE OF THE SCRIPT TO A FILE:
$query->save(\*FILEHANDLE)
This will write the current state of the form to the provided
filehandle. You can read it back in by providing a filehandle
to the new() method. Note that the filehandle can be a file, a pipe,
or whatever!
The format of the saved file is:
NAME1=VALUE1
NAME1=VALUE1'
NAME2=VALUE2
NAME3=VALUE3
=
Both name and value are URL escaped. Multi-valued CGI parameters are
represented as repeated names. A session record is delimited by a
single = symbol. You can write out multiple records and read them
back in with several calls to B<new>. You can do this across several
sessions by opening the file in append mode, allowing you to create
primitive guest books, or to keep a history of users' queries. Here's
a short example of creating multiple session records:
use CGI;
open (OUT,'>>','test.out') || die;
$records = 5;
for (0..$records) {
my $q = CGI->new;
$q->param(-name=>'counter',-value=>$_);
$q->save(\*OUT);
}
close OUT;
# reopen for reading
open (IN,'<','test.out') || die;
while (!eof(IN)) {
my $q = CGI->new(\*IN);
print $q->param('counter'),"\n";
}
Whitehead Genome Center's data exchange format "Boulderio", and can be
manipulated and even databased using Boulderio utilities. See
for further details.
If you wish to use this method from the function-oriented (non-OO)
interface, the exported name for this method is B<save_parameters()>.
=head2 RETRIEVING CGI ERRORS
Errors can occur while processing user input, particularly when
processing uploaded files. When these errors occur, CGI will stop
processing and return an empty parameter list. You can test for
the existence and nature of errors using the I<cgi_error()> function.
The error messages are formatted as HTTP status codes. You can either
incorporate the error text into an HTML page, or use it as the value
of the HTTP status:
my $error = $q->cgi_error;
if ($error) {
print $q->header(-status=>$error),
$q->start_html('Problems'),
$q->h2('Request not processed'),
$q->strong($error);
exit 0;
}
When using the function-oriented interface (see the next section),
errors may only occur the first time you call I<param()>. Be ready
for this!
=head2 USING THE FUNCTION-ORIENTED INTERFACE
To use the function-oriented interface, you must specify which CGI.pm
routines or sets of routines to import into your script's namespace.
There is a small overhead associated with this importation, but it
isn't much.
use CGI <list of methods>;
The listed methods will be imported into the current package; you can
call them directly without creating a CGI object first. This example
shows how to import the B<param()> and B<header()>
methods, and then use them directly:
use CGI 'param','header';
$zipcode = param('zipcode');
More frequently, you'll import common sets of functions by referring
to the groups by name. All function sets are preceded with a ":"
character as in ":html3" (for tags defined in the HTML 3 standard).
Here is a list of the function sets you can import:
=over 4
=item B<:cgi>
Import all CGI-handling methods, such as B<param()>, B<path_info()>
and the like.
=item B<:form>
Import all fill-out form generating methods, such as B<textfield()>.
=item B<:html2>
Import all methods that generate HTML 2.0 standard elements.
=item B<:html3>
Import all methods that generate HTML 3.0 elements (such as
<table>, <super> and <sub>).
=item B<:html4>
Import all methods that generate HTML 4 elements (such as
<abbrev>, <acronym> and <thead>).
=item B<:netscape>
Import the <blink>, <fontsize> and <center> tags.
=item B<:html>
Import all HTML-generating shortcuts (i.e. 'html2', 'html3', 'html4' and 'netscape')
=item B<:standard>
Import "standard" features, 'html2', 'html3', 'html4', 'form' and 'cgi'.
=item B<:all>
Import all the available methods. For the full list, see the CGI.pm
code, where the variable %EXPORT_TAGS is defined.
=back
If you import a function name that is not part of CGI.pm, the module
will treat it as a new HTML tag and generate the appropriate
subroutine. You can then use it like any other HTML tag. This is to
provide for the rapidly-evolving HTML "standard." For example, say
Microsoft comes out with a new tag called <gradient> (which causes the
user's desktop to be flooded with a rotating gradient fill until his
machine reboots). You don't need to wait for a new version of CGI.pm
to start using it immediately:
use CGI qw/:standard :html3 gradient/;
print gradient({-start=>'red',-end=>'blue'});
Note that in the interests of execution speed CGI.pm does B<not> use
the standard L<Exporter> syntax for specifying load symbols. This may
change in the future.
If you import any of the state-maintaining CGI or form-generating
methods, a default CGI object will be created and initialized
automatically the first time you use any of the methods that require
one to be present. This includes B<param()>, B<textfield()>,
B<submit()> and the like. (If you need direct access to the CGI
object, you can find it in the global variable B<$CGI::Q>). By
importing CGI.pm methods, you can create visually elegant scripts:
use CGI qw/:standard/;
print
header,
start_html('Simple Script'),
h1('Simple Script'),
start_form,
"What's your name? ",textfield('name'),p,
"What's the combination?",
checkbox_group(-name=>'words',
-values=>['eenie','meenie','minie','moe'],
-defaults=>['eenie','moe']),p,
"What's your favorite color?",
popup_menu(-name=>'color',
-values=>['red','green','blue','chartreuse']),p,
submit,
end_form,
hr,"\n";
if (param) {
print
"Your name is ",em(param('name')),p,
"The keywords are: ",em(join(", ",param('words'))),p,
"Your favorite color is ",em(param('color')),".\n";
}
print end_html;
=head2 PRAGMAS
In addition to the function sets, there are a number of pragmas that
you can import. Pragmas, which are always preceded by a hyphen,
change the way that CGI.pm functions in various ways. Pragmas,
function sets, and individual functions can all be imported in the
same use() line. For example, the following use statement imports the
standard set of functions and enables debugging mode (pragma
-debug):
use CGI qw/:standard -debug/;
The current list of pragmas is as follows:
=over 4
=item -any
When you I<use CGI -any>, then any method that the query object
doesn't recognize will be interpreted as a new HTML tag. This allows
you to support the next I<ad hoc> HTML
extension. This lets you go wild with new and unsupported tags:
use CGI qw(-any);
$q=CGI->new;
print $q->gradient({speed=>'fast',start=>'red',end=>'blue'});
Since using <cite>any</cite> causes any mistyped method name
to be interpreted as an HTML tag, use it with care or not at
all.
=item -compile
This causes the indicated autoloaded methods to be compiled up front,
rather than deferred to later. This is useful for scripts that run
for an extended period of time under FastCGI or mod_perl, and for
those destined to be crunched by Malcolm Beattie's Perl compiler. Use
it in conjunction with the methods or method families you plan to use.
use CGI qw(-compile :standard :html3);
or even
use CGI qw(-compile :all);
Note that using the -compile pragma in this way will always have
the effect of importing the compiled functions into the current
namespace. If you want to compile without importing use the
compile() method instead:
use CGI();
CGI->compile();
This is particularly useful in a mod_perl environment, in which you
might want to precompile all CGI routines in a startup script, and
then import the functions individually in each mod_perl script.
=item -nosticky
By default the CGI module implements a state-preserving behavior
called "sticky" fields. The way this works is that if you are
regenerating a form, the methods that generate the form field values
will interrogate param() to see if similarly-named parameters are
present in the query string. If they find a like-named parameter, they
will use it to set their default values.
Sometimes this isn't what you want. The B<-nosticky> pragma prevents
this behavior. You can also selectively change the sticky behavior in
each element that you generate.
=item -tabindex
Automatically add tab index attributes to each form field. With this
option turned off, you can still add tab indexes manually by passing a
-tabindex option to each field-generating method.
=item -no_undef_params
This keeps CGI.pm from including undef params in the parameter list.
=item -no_xhtml
By default, CGI.pm versions 2.69 and higher emit XHTML
(http://www.w3.org/TR/xhtml1/). The -no_xhtml pragma disables this
feature. Thanks to Michalis Kabrianis <kabrianis@hellug.gr> for this
feature.
If start_html()'s -dtd parameter specifies an HTML 2.0,
3.2, 4.0 or 4.01 DTD,
XHTML will automatically be disabled without needing to use this
pragma.
=item -utf8
This makes CGI.pm treat all parameters as UTF-8 strings. Use this with
care, as it will interfere with the processing of binary uploads. It
is better to manually select which fields are expected to return utf-8
strings and convert them using code like this:
use Encode;
my $arg = decode utf8=>param('foo');
=item -nph
This makes CGI.pm produce a header appropriate for an NPH (no
parsed header) script. You may need to do other things as well
to tell the server that the script is NPH. See the discussion
of NPH scripts below.
=item -newstyle_urls
Separate the name=value pairs in CGI parameter query strings with
semicolons rather than ampersands. For example:
?name=fred;age=24;favorite_color=3
Semicolon-delimited query strings are always accepted, and will be emitted by
self_url() and query_string(). newstyle_urls became the default in version
2.64.
=item -oldstyle_urls
Separate the name=value pairs in CGI parameter query strings with
ampersands rather than semicolons. This is no longer the default.
=item -autoload
This overrides the autoloader so that any function in your program
that is not recognized is referred to CGI.pm for possible evaluation.
This allows you to use all the CGI.pm functions without adding them to
your symbol table, which is of concern for mod_perl users who are
worried about memory consumption. I<Warning:> when
I<-autoload> is in effect, you cannot use "poetry mode"
(functions without the parenthesis). Use I<hr()> rather
to the top of your script.
=item -no_debug
This turns off the command-line processing features. If you want to
run a CGI.pm script from the command line to produce HTML, and you
don't want it to read CGI parameters from the command line or STDIN,
then use this pragma:
use CGI qw(-no_debug :standard);
=item -debug
This turns on full debugging. In addition to reading CGI arguments
from the command-line processing, CGI.pm will pause and try to read
arguments from STDIN, producing the message "(offline mode: enter
name=value pairs on standard input)" features.
See the section on debugging for more details.
=item -private_tempfiles
CGI.pm can process uploaded file. Ordinarily it spools the uploaded
file to a temporary directory, then deletes the file when done.
However, this opens the risk of eavesdropping as described in the file
upload section. Another CGI script author could peek at this data
during the upload, even if it is confidential information. On Unix
systems, the -private_tempfiles pragma will cause the temporary file
to be unlinked as soon as it is opened and before any data is written
into it, reducing, but not eliminating the risk of eavesdropping
(there is still a potential race condition). To make life harder for
the attacker, the program chooses tempfile names by calculating a 32
bit checksum of the incoming HTTP headers.
To ensure that the temporary file cannot be read by other CGI scripts,
use suEXEC or a CGI wrapper program to run your script. The temporary
file is created with mode 0600 (neither world nor group readable).
The temporary directory is selected using the following algorithm:
1. if $CGITempFile::TMPDIRECTORY is already set, use that
2. if the environment variable TMPDIR exists, use the location
indicated.
/tmp, /temp, ::Temporary Items, and \WWW_ROOT.
Each of these locations is checked that it is a directory and is
writable. If not, the algorithm tries the next choice.
=back
=head2 SPECIAL FORMS FOR IMPORTING HTML-TAG FUNCTIONS
Many of the methods generate HTML tags. As described below, tag
functions automatically generate both the opening and closing tags.
For example:
print h1('Level 1 Header');
produces
<h1>Level 1 Header</h1>
There will be some times when you want to produce the start and end
tags yourself. In this case, you can use the form start_I<tag_name>
and end_I<tag_name>, as in:
print start_h1,'Level 1 Header',end_h1;
With a few exceptions (described below), start_I<tag_name> and
end_I<tag_name> functions are not generated automatically when you
I<use CGI>. However, you can specify the tags you want to generate
name, or, alternatively, requesting either "start_I<tag_name>" or
"end_I<tag_name>" in the import list.
Example:
use CGI qw/:standard *table start_ul/;
In this example, the following functions are generated in addition to
the standard ones:
=over 4
=item 1. start_table() (generates a <table> tag)
=item 2. end_table() (generates a </table> tag)
=item 3. start_ul() (generates a <ul> tag)
=item 4. end_ul() (generates a </ul> tag)
=back
=head1 GENERATING DYNAMIC DOCUMENTS
Most of CGI.pm's functions deal with creating documents on the fly.
Generally you will produce the HTTP header first, followed by the
document itself. CGI.pm provides functions for generating HTTP
headers of various types as well as for generating HTML. For creating
GIF images, see the GD.pm module.
Each of these functions produces a fragment of HTML or HTTP which you
can print out directly so that it displays in the browser window,
append to a string, or save to a file for later use.
=head2 CREATING A STANDARD HTTP HEADER:
Normally the first thing you will do in any CGI script is print out an
HTTP header. This tells the browser what type of document to expect,
and gives other optional information, such as the language, expiration
date, and whether to cache the document. The header can also be
manipulated for special purposes, such as server push and pay per view
pages.
print header;
-or-
-or-
-or-
-nph=>1,
-status=>'402 Payment required',
-expires=>'+3d',
-cookie=>$cookie,
-charset=>'utf-7',
-attachment=>'foo.gif',
-Cost=>'$2.00');
header() returns the Content-type: header. You can provide your own
optional second parameter specifies the status code and a human-readable
message. For example, you can specify 204, "No response" to create a
script that tells the browser to do nothing at all.
The last example shows the named argument style for passing arguments
to the CGI methods using named parameters. Recognized parameters are
B<-type>, B<-status>, B<-expires>, and B<-cookie>. Any other named
parameters will be stripped of their initial hyphens and turned into
header fields, allowing you to specify any HTTP header you desire.
Internal underscores will be turned into hyphens:
print header(-Content_length=>3002);
Most browsers will not cache the output from CGI scripts. Every time
the browser reloads the page, the script is invoked anew. You can
change this behavior with the B<-expires> parameter. When you specify
an absolute or relative expiration interval with this parameter, some
browsers and proxy servers will cache the script's output until the
indicated expiration date. The following forms are all valid for the
-expires field:
+30s 30 seconds from now
+10m ten minutes from now
+1h one hour from now
-1d yesterday (i.e. "ASAP!")
now immediately
+3M in three months
+10y in ten years time
Thursday, 25-Apr-1999 00:40:33 GMT at the indicated time & date
The B<-cookie> parameter generates a header that tells the browser to provide
a "magic cookie" during all subsequent transactions with your script.
Some cookies have a special format that includes interesting attributes
such as expiration time. Use the cookie() method to create and retrieve
session cookies.
The B<-nph> parameter, if set to a true value, will issue the correct
headers to work with a NPH (no-parse-header) script. This is important
to use with certain servers that expect all their scripts to be NPH.
The B<-charset> parameter can be used to control the character set
sent to the browser. If not provided, defaults to ISO-8859-1. As a
side effect, this sets the charset() method as well.
The B<-attachment> parameter can be used to turn the page into an
attachment. Instead of displaying the page, some browsers will prompt
the user to save it to disk. The value of the argument is the
suggested name for the saved file. In order for this to work, you may
have to set the B<-type> to "application/octet-stream".
The B<-p3p> parameter will add a P3P tag to the outgoing header. The
parameter can be an arrayref or a space-delimited string of P3P tags.
For example:
print header(-p3p=>[qw(CAO DSP LAW CURa)]);
print header(-p3p=>'CAO DSP LAW CURa');
In either case, the outgoing header will be formatted as:
CGI.pm will accept valid multi-line headers when each line is separated with a
CRLF value ("\r\n" on most platforms) followed by at least one space. For example:
print header( -ingredients => "ham\r\n\seggs\r\n\sbacon" );
Invalid multi-line header input will trigger in an exception. When multi-line headers
are received, CGI.pm will always output them back as a single line, according to the
folding rules of RFC 2616: the newlines will be removed, while the white space remains.
=head2 GENERATING A REDIRECTION HEADER
print $q->redirect('http://somewhere.else/in/movie/land');
Sometimes you don't want to produce a document yourself, but simply
redirect the browser elsewhere, perhaps choosing a URL based on the
time of day or the identity of the user.
The redirect() method redirects the browser to a different URL. If
you use redirection like this, you should B<not> print out a header as
well.
You should always use full URLs (including the http: or ftp: part) in
redirection requests. Relative URLs will not work correctly.
You can also use named arguments:
print $q->redirect(
-uri=>'http://somewhere.else/in/movie/land',
-nph=>1,
-status=>301);
All names arguments recognized by header() are also recognized by
redirect(). However, most HTTP headers, including those generated by
-cookie and -target, are ignored by the browser.
The B<-nph> parameter, if set to a true value, will issue the correct
headers to work with a NPH (no-parse-header) script. This is important
to use with certain servers, such as Microsoft IIS, which
expect all their scripts to be NPH.
The B<-status> parameter will set the status of the redirect. HTTP
defines three different possible redirection status codes:
301 Moved Permanently
302 Found
303 See Other
The default if not specified is 302, which means "moved temporarily."
You may change the status to another status code if you wish. Be
advised that changing the status to anything other than 301, 302 or
303 will probably break redirection.
=head2 CREATING THE HTML DOCUMENT HEADER
print start_html(-title=>'Secrets of the Pyramids',
-author=>'fred@capricorn.org',
-base=>'true',
-target=>'_blank',
-meta=>{'keywords'=>'pharaoh secret mummy',
'copyright'=>'copyright 1996 King Tut'},
-style=>{'src'=>'/styles/style1.css'},
-BGCOLOR=>'blue');
The start_html() routine creates the top of the
page, along with a lot of optional information that controls the
page's appearance and behavior.
This method returns a canned HTML header and the opening <body> tag.
All parameters are optional. In the named parameter form, recognized
parameters are -title, -author, -base, -xbase, -dtd, -lang and -target
(see below for the explanation). Any additional parameters you
provide, such as the unofficial BGCOLOR attribute, are added
to the <body> tag. Additional parameters must be proceeded by a
hyphen.
The argument B<-xbase> allows you to provide an HREF for the <base> tag
different from the current location, as in
-xbase=>"http://home.mcom.com/"
All relative links will be interpreted relative to this tag.
The argument B<-target> allows you to provide a default target frame
for all the links and fill-out forms on the page. B<This is a
non-standard HTTP feature which only works with some browsers!>
-target=>"answer_window"
All relative links will be interpreted relative to this tag.
You add arbitrary meta information to the header with the B<-meta>
argument. This argument expects a reference to a hash
into a series of header <meta> tags that look something like this:
<meta name="keywords" content="pharaoh secret mummy">
<meta name="description" content="copyright 1996 King Tut">
To create an HTTP-EQUIV type of <meta> tag, use B<-head>, described
below.
The B<-style> argument is used to incorporate cascading stylesheets
into your code. See the section on CASCADING STYLESHEETS for more
information.
The B<-lang> argument is used to incorporate a language attribute into
the <html> tag. For example:
print $q->start_html(-lang=>'fr-CA');
The default if not specified is "en-US" for US English, unless the
-dtd parameter specifies an HTML 2.0 or 3.2 DTD, in which case the
lang attribute is left off. You can force the lang attribute to left
off in other cases by passing an empty string (-lang=>'').
The B<-encoding> argument can be used to specify the character set for
XHTML. It defaults to iso-8859-1 if not specified.
The B<-dtd> argument can be used to specify a public DTD identifier string. For example:
-dtd => '-//W3C//DTD HTML 4.01 Transitional//EN')
Alternatively, it can take public and system DTD identifiers as an array:
dtd => [ '-//W3C//DTD HTML 4.01 Transitional//EN', 'http://www.w3.org/TR/html4/loose.dtd' ]
For the public DTD identifier to be considered, it must be valid. Otherwise it
will be replaced by the default DTD. If the public DTD contains 'XHTML', CGI.pm
will emit XML.
The B<-declare_xml> argument, when used in conjunction with XHTML,
will put a <?xml> declaration at the top of the HTML header. The sole
purpose of this declaration is to declare the character set
encoding. In the absence of -declare_xml, the output HTML will contain
a <meta> tag that specifies the encoding, allowing the HTML to pass
most validators. The default for -declare_xml is false.
You can place other arbitrary HTML elements to the <head> section with the
B<-head> tag. For example, to place a <link> element in the
head section, use this:
print start_html(-head=>Link({-rel=>'shortcut icon',
-href=>'favicon.ico'}));
To incorporate multiple HTML elements into the <head> section, just pass an
array reference:
print start_html(-head=>[
Link({-rel=>'next',
-href=>'http://www.capricorn.com/s2.html'}),
Link({-rel=>'previous',
-href=>'http://www.capricorn.com/s1.html'})
]
);
And here's how to create an HTTP-EQUIV <meta> tag:
print start_html(-head=>meta({-http_equiv => 'Content-Type',
JAVASCRIPTING: The B<-script>, B<-noScript>, B<-onLoad>,
B<-onMouseOver>, B<-onMouseOut> and B<-onUnload> parameters are used
to add JavaScript calls to your pages. B<-script> should
point to a block of text containing JavaScript function definitions.
This block will be placed within a <script> block inside the HTML (not
HTTP) header. The block is placed in the header in order to give your
page a fighting chance of having all its JavaScript functions in place
even if the user presses the stop button before the page has loaded
completely. CGI.pm attempts to format the script in such a way that
JavaScript-naive browsers will not choke on the code: unfortunately
there are some browsers, such as Chimera for Unix, that get confused
by it nevertheless.
The B<-onLoad> and B<-onUnload> parameters point to fragments of JavaScript
code to execute when the page is respectively opened and closed by the
browser. Usually these parameters are calls to functions defined in the
B<-script> field:
$query = CGI->new;
print header;
$JSCRIPT=<<END;
// Ask a silly question
function riddle_me_this() {
var r = prompt("What walks on four legs in the morning, " +
"two legs in the afternoon, " +
"and three legs in the evening?");
response(r);
}
// Get a silly answer
function response(answer) {
if (answer == "man")
alert("Right you are!");
else
alert("Wrong! Guess again.");
}
END
print start_html(-title=>'The Riddle of the Sphinx',
-script=>$JSCRIPT);
Use the B<-noScript> parameter to pass some HTML text that will be displayed on
browsers that do not have JavaScript (or browsers where JavaScript is turned
off).
The <script> tag, has several attributes including "type", "charset" and "src".
"src" allows you to keep JavaScript code in an external file. To use these
attributes pass a HASH reference in the B<-script> parameter containing one or
more of -type, -src, or -code:
print $q->start_html(-title=>'The Riddle of the Sphinx',
-script=>{-type=>'JAVASCRIPT',
-src=>'/javascript/sphinx.js'}
);
print $q->(-title=>'The Riddle of the Sphinx',
-script=>{-type=>'PERLSCRIPT',
-code=>'print "hello world!\n;"'}
);
A final feature allows you to incorporate multiple <script> sections into the
header. Just pass the list of script sections as an array reference.
this allows you to specify different source files for different dialects
of JavaScript. Example:
print $q->start_html(-title=>'The Riddle of the Sphinx',
-script=>[
{ -type => 'text/javascript',
-src => '/javascript/utilities10.js'
},
{ -type => 'text/javascript',
-src => '/javascript/utilities11.js'
},
-src => '/javascript/utilities12.js'
},
{ -type => 'text/ecmascript',
-src => '/javascript/utilities219.js'
}
]
);
The option "-language" is a synonym for -type, and is supported for
backwards compatibility.
The old-style positional parameters are as follows:
=over 4
=item B<Parameters:>
=item 1.
The title
=item 2.
The author's e-mail address (will create a <link rev="MADE"> tag if present
=item 3.
A 'true' flag if you want to include a <base> tag in the header. This
helps resolve relative addresses to absolute ones when the document is moved,
but makes the document hierarchy non-portable. Use with care!
=item 4, 5, 6...
Any other parameters you want to include in the <body> tag. This is a good
place to put HTML extensions, such as colors and wallpaper patterns.
=back
=head2 ENDING THE HTML DOCUMENT:
print end_html
This ends an HTML document by printing the </body></html> tags.
=head2 CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION:
$myself = self_url;
print q(<a href="$myself">I'm talking to myself.</a>);
self_url() will return a URL, that, when selected, will reinvoke
this script with all its state information intact. This is most
useful when you want to jump around within the document using
internal anchors but you don't want to disrupt the current contents
of the form(s). Something like this will do the trick.
$myself = self_url;
print "<a href=\"$myself#table1\">See table 1</a>";
print "<a href=\"$myself#table2\">See table 2</a>";
print "<a href=\"$myself#yourself\">See for yourself</a>";
If you want more control over what's returned, using the B<url()>
method instead.
You can also retrieve the unprocessed query string with query_string():
$the_string = query_string;
=head2 OBTAINING THE SCRIPT'S URL
$full_url = url();
$full_url = url(-full=>1); #alternative syntax
$relative_url = url(-relative=>1);
$absolute_url = url(-absolute=>1);
$url_with_path = url(-path_info=>1);
$url_with_path_and_query = url(-path_info=>1,-query=>1);
$netloc = url(-base => 1);
B<url()> returns the script's URL in a variety of formats. Called
without any arguments, it returns the full form of the URL, including
host name and port number
You can modify this format with the following named arguments:
=over 4
=item B<-absolute>
If true, produce an absolute URL, e.g.
=item B<-relative>
Produce a relative URL. This is useful if you want to reinvoke your
script with different parameters. For example:
script.cgi
=item B<-full>
Produce the full URL, exactly as if called without any arguments.
This overrides the -relative and -absolute arguments.
=item B<-path> (B<-path_info>)
Append the additional path information to the URL. This can be
combined with B<-full>, B<-absolute> or B<-relative>. B<-path_info>
is provided as a synonym.
=item B<-query> (B<-query_string>)
Append the query string to the URL. This can be combined with
B<-full>, B<-absolute> or B<-relative>. B<-query_string> is provided
as a synonym.
=item B<-base>
Generate just the protocol and net location, as in http://www.foo.com:8000
=item B<-rewrite>
If Apache's mod_rewrite is turned on, then the script name and path
info probably won't match the request that the user sent. Set
-rewrite=>1 (default) to return URLs that match what the user sent
(the original request URI). Set -rewrite=>0 to return URLs that match
the URL after mod_rewrite's rules have run. Because the additional
path information only makes sense in the context of the rewritten URL,
-rewrite is set to false when you request path info in the URL.
=back
=head2 MIXING POST AND URL PARAMETERS
$color = url_param('color');
It is possible for a script to receive CGI parameters in the URL as
well as in the fill-out form by creating a form that POSTs to a URL
containing a query string (a "?" mark followed by arguments). The
B<param()> method will always return the contents of the POSTed
fill-out form, ignoring the URL's query string. To retrieve URL
parameters, call the B<url_param()> method. Use it in the same way as
B<param()>. The main difference is that it allows you to read the
parameters, but not set them.
Under no circumstances will the contents of the URL query string
interfere with similarly-named CGI parameters in POSTed forms. If you
try to mix a URL query string with a form submitted with the GET
method, the results will not be what you expect.
=head1 CREATING STANDARD HTML ELEMENTS:
CGI.pm defines general HTML shortcut methods for many HTML tags. HTML shortcuts are named after a single
HTML element and return a fragment of HTML text. Example:
print $q->blockquote(
"Many years ago on the island of",
$q->a({href=>"http://crete.org/"},"Crete"),
"there lived a Minotaur named",
$q->strong("Fred."),
),
$q->hr;
This results in the following HTML code (extra newlines have been
added for readability):
<blockquote>
Many years ago on the island of
<a href="http://crete.org/">Crete</a> there lived
a minotaur named <strong>Fred.</strong>
</blockquote>
<hr>
If you find the syntax for calling the HTML shortcuts awkward, you can
import them into your namespace and dispense with the object syntax
completely (see the next section for more details):
use CGI ':standard';
print blockquote(
"Many years ago on the island of",
a({href=>"http://crete.org/"},"Crete"),
"there lived a minotaur named",
strong("Fred."),
),
hr;
=head2 PROVIDING ARGUMENTS TO HTML SHORTCUTS
The HTML methods will accept zero, one or multiple arguments. If you
provide no arguments, you get a single tag:
print hr; # <hr>
If you provide one or more string arguments, they are concatenated
together with spaces and placed between opening and closing tags:
print h1("Chapter","1"); # <h1>Chapter 1</h1>"
If the first argument is a hash reference, then the keys
and values of the hash become the HTML tag's attributes:
print a({-href=>'fred.html',-target=>'_new'},
"Open a new frame");
<a href="fred.html",target="_new">Open a new frame</a>
You may dispense with the dashes in front of the attribute names if
you prefer:
print img {src=>'fred.gif',align=>'LEFT'};
<img align="LEFT" src="fred.gif">
Sometimes an HTML tag attribute has no argument. For example, ordered
lists can be marked as COMPACT. The syntax for this is an argument that
that points to an undef string:
print ol({compact=>undef},li('one'),li('two'),li('three'));
Prior to CGI.pm version 2.41, providing an empty ('') string as an
attribute argument was the same as providing undef. However, this has
changed in order to accommodate those who want to create tags of the form
<img alt="">. The difference is shown in these two pieces of code:
CODE RESULT
img({alt=>undef}) <img alt>
img({alt=>''}) <img alt="">
=head2 THE DISTRIBUTIVE PROPERTY OF HTML SHORTCUTS
One of the cool features of the HTML shortcuts is that they are
distributive. If you give them an argument consisting of a
B<reference> to a list, the tag will be distributed across each
element of the list. For example, here's one way to make an ordered
list:
print ul(
li({-type=>'disc'},['Sneezy','Doc','Sleepy','Happy'])
);
This example will result in HTML output that looks like this:
<ul>
<li type="disc">Sneezy</li>
<li type="disc">Doc</li>
<li type="disc">Sleepy</li>
<li type="disc">Happy</li>
</ul>
This is extremely useful for creating tables. For example:
print table({-border=>undef},
caption('When Should You Eat Your Vegetables?'),
Tr({-align=>'CENTER',-valign=>'TOP'},
[
th(['Vegetable', 'Breakfast','Lunch','Dinner']),
td(['Tomatoes' , 'no', 'yes', 'yes']),
td(['Broccoli' , 'no', 'no', 'yes']),
td(['Onions' , 'yes','yes', 'yes'])
]
)
);
=head2 HTML SHORTCUTS AND LIST INTERPOLATION
Consider this bit of code:
print blockquote(em('Hi'),'mom!'));
It will ordinarily return the string that you probably expect, namely:
<blockquote><em>Hi</em> mom!</blockquote>
Note the space between the element "Hi" and the element "mom!".
CGI.pm puts the extra space there using array interpolation, which is
controlled by the magic $" variable. Sometimes this extra space is
not what you want, for example, when you are trying to align a series
of images. In this case, you can simply change the value of $" to an
empty string.
{
local($") = '';
print blockquote(em('Hi'),'mom!'));
}
I suggest you put the code in a block as shown here. Otherwise the
change to $" will affect all subsequent code until you explicitly
reset it.
=head2 NON-STANDARD HTML SHORTCUTS
A few HTML tags don't follow the standard pattern for various
reasons.
B<comment()> generates an HTML comment (<!-- comment -->). Call it
like
print comment('here is my comment');
Because of conflicts with built-in Perl functions, the following functions
begin with initial caps:
Select
Tr
Link
Delete
Accept
Sub
In addition, start_html(), end_html(), start_form(), end_form(),
start_multipart_form() and all the fill-out form tags are special.
See their respective sections.
=head2 AUTOESCAPING HTML
By default, all HTML that is emitted by the form-generating functions
is passed through a function called escapeHTML():
=over 4
=item $escaped_string = escapeHTML("unescaped string");
Escape HTML formatting characters in a string.
=back
Provided that you have specified a character set of ISO-8859-1 (the
default), the standard HTML escaping rules will be used. The "<"
character becomes "<", ">" becomes ">", "&" becomes "&", and
the quote character becomes """. In addition, the hexadecimal
0x8b and 0x9b characters, which some browsers incorrectly interpret
as the left and right angle-bracket characters, are replaced by their
numeric character entities ("‹" and "›"). If you manually change
the charset, either by calling the charset() method explicitly or by
passing a -charset argument to header(), then B<all> characters will
be replaced by their numeric entities, since CGI.pm has no lookup
table for all the possible encodings.
C<escapeHTML()> expects the supplied string to be a character string. This means you
should Encode::decode data received from "outside" and Encode::encode your
strings before sending them back outside. If your source code UTF-8 encoded and
you want to upgrade string literals in your source to character strings, you
can use "use utf8". See L<perlunitut>, L<perlunifaq> and L<perlunicode> for more
information on how Perl handles the difference between bytes and characters.
The automatic escaping does not apply to other shortcuts, such as
h1(). You should call escapeHTML() yourself on untrusted data in
order to protect your pages against nasty tricks that people may enter
into guestbooks, etc.. To change the character set, use charset().
To turn autoescaping off completely, use autoEscape(0):
=over 4
=item $charset = charset([$charset]);
Get or set the current character set.
=item $flag = autoEscape([$flag]);
Get or set the value of the autoescape flag.
=back
=head2 PRETTY-PRINTING HTML
By default, all the HTML produced by these functions comes out as one
long line without carriage returns or indentation. This is yuck, but
it does reduce the size of the documents by 10-20%. To get
pretty-printed output, please use L<CGI::Pretty>, a subclass
contributed by Brian Paulsen.
=head1 CREATING FILL-OUT FORMS:
I<General note> The various form-creating methods all return strings
to the caller, containing the tag or tags that will create the requested
form element. You are responsible for actually printing out these strings.
It's set up this way so that you can place formatting tags
around the form elements.
I<Another note> The default values that you specify for the forms are only
used the B<first> time the script is invoked (when there is no query
string). On subsequent invocations of the script (when there is a query
string), the former values are used even if they are blank.
If you want to change the value of a field from its previous value, you have two
choices:
(1) call the param() method to set it.
(2) use the -override (alias -force) parameter (a new feature in version 2.15).
This forces the default value to be used, regardless of the previous value:
print textfield(-name=>'field_name',
-default=>'starting value',
-override=>1,
-size=>50,
-maxlength=>80);
I<Yet another note> By default, the text and labels of form elements are
escaped according to HTML rules. This means that you can safely use
"<CLICK ME>" as the label for a button. However, it also interferes with
your ability to incorporate special HTML character sequences, such as Á,
into your fields. If you wish to turn off automatic escaping, call the
autoEscape() method with a false value immediately after creating the CGI object:
$query = CGI->new;
$query->autoEscape(0);
Note that autoEscape() is exclusively used to effect the behavior of how some
CGI.pm HTML generation functions handle escaping. Calling escapeHTML()
explicitly will always escape the HTML.
I<A Lurking Trap!> Some of the form-element generating methods return
multiple tags. In a scalar context, the tags will be concatenated
together with spaces, or whatever is the current value of the $"
global. In a list context, the methods will return a list of
elements, allowing you to modify them if you wish. Usually you will
not notice this behavior, but beware of this:
printf("%s\n",end_form())
end_form() produces several tags, and only the first of them will be
printed because the format only expects one value.
<p>
=head2 CREATING AN ISINDEX TAG
print isindex(-action=>$action);
-or-
print isindex($action);
Prints out an <isindex> tag. Not very exciting. The parameter
-action specifies the URL of the script to process the query. The
default is to process the query with the current script.
=head2 STARTING AND ENDING A FORM
print start_form(-method=>$method,
-action=>$action,
-enctype=>$encoding);
<... various form stuff ...>
print end_form;
-or-
print start_form($method,$action,$encoding);
<... various form stuff ...>
print end_form;
start_form() will return a <form> tag with the optional method,
action and form encoding that you specify. The defaults are:
method: POST
action: this script
enctype: application/x-www-form-urlencoded for non-XHTML
end_form() returns the closing </form> tag.
Start_form()'s enctype argument tells the browser how to package the various
fields of the form before sending the form to the server. Two
values are possible:
B<Note:> These methods were previously named startform() and endform().
These methods are now DEPRECATED.
Please use start_form() and end_form() instead.
=over 4
=item B<application/x-www-form-urlencoded>
This is the older type of encoding. It is compatible with many CGI scripts and is
suitable for short fields containing text data. For your
convenience, CGI.pm stores the name of this encoding
type in B<&CGI::URL_ENCODED>.
This is the newer type of encoding.
It is suitable for forms that contain very large fields or that
are intended for transferring binary data. Most importantly,
it enables the "file upload" feature. For
your convenience, CGI.pm stores the name of this encoding type
in B<&CGI::MULTIPART>
Forms that use this type of encoding are not easily interpreted
by CGI scripts unless they use CGI.pm or another library designed
to handle them.
If XHTML is activated (the default), then forms will be automatically
created using this type of encoding.
=back
The start_form() method uses the older form of encoding by
default unless XHTML is requested. If you want to use the
newer form of encoding by default, you can call
B<start_multipart_form()> instead of B<start_form()>. The
method B<end_multipart_form()> is an alias to B<end_form()>.
JAVASCRIPTING: The B<-name> and B<-onSubmit> parameters are provided
for use with JavaScript. The -name parameter gives the
form a name so that it can be identified and manipulated by
JavaScript functions. -onSubmit should point to a JavaScript
function that will be executed just before the form is submitted to your
server. You can use this opportunity to check the contents of the form
for consistency and completeness. If you find something wrong, you
can put up an alert box or maybe fix things up yourself. You can
abort the submission by returning false from this function.
Usually the bulk of JavaScript functions are defined in a <script>
block in the HTML header and -onSubmit points to one of these function
call. See start_html() for details.
=head2 FORM ELEMENTS
After starting a form, you will typically create one or more
textfields, popup menus, radio groups and other form elements. Each
of these elements takes a standard set of named arguments. Some
elements also have optional arguments. The standard arguments are as
follows:
=over 4
=item B<-name>
The name of the field. After submission this name can be used to
retrieve the field's value using the param() method.
=item B<-value>, B<-values>
The initial value of the field which will be returned to the script
after form submission. Some form elements, such as text fields, take
a single scalar -value argument. Others, such as popup menus, take a
reference to an array of values. The two arguments are synonyms.
=item B<-tabindex>
A numeric value that sets the order in which the form element receives
focus when the user presses the tab key. Elements with lower values
receive focus first.
=item B<-id>
A string identifier that can be used to identify this element to
JavaScript and DHTML.
=item B<-override>
A boolean, which, if true, forces the element to take on the value
specified by B<-value>, overriding the sticky behavior described
earlier for the B<-nosticky> pragma.
=item B<-onChange>, B<-onFocus>, B<-onBlur>, B<-onMouseOver>, B<-onMouseOut>, B<-onSelect>
These are used to assign JavaScript event handlers. See the
JavaScripting section for more details.
=back
Other common arguments are described in the next section. In addition
to these, all attributes described in the HTML specifications are
supported.
=head2 CREATING A TEXT FIELD
print textfield(-name=>'field_name',
-value=>'starting value',
-size=>50,
-maxlength=>80);
-or-
print textfield('field_name','starting value',50,80);
textfield() will return a text input field.
=over 4
=item B<Parameters>
=item 1.
The first parameter is the required name for the field (-name).
=item 2.
The optional second parameter is the default starting value for the field
contents (-value, formerly known as -default).
=item 3.
The optional third parameter is the size of the field in
characters (-size).
=item 4.
The optional fourth parameter is the maximum number of characters the
field will accept (-maxlength).
=back
As with all these methods, the field will be initialized with its
previous contents from earlier invocations of the script.
When the form is processed, the value of the text field can be
retrieved with:
$value = param('foo');
If you want to reset it from its initial value after the script has been
called once, you can do so like this:
param('foo',"I'm taking over this value!");
=head2 CREATING A BIG TEXT FIELD
print textarea(-name=>'foo',
-default=>'starting value',
-rows=>10,
-columns=>50);
-or
print textarea('foo','starting value',10,50);
textarea() is just like textfield, but it allows you to specify
rows and columns for a multiline text entry box. You can provide
a starting value for the field, which can be long and contain
multiple lines.
=head2 CREATING A PASSWORD FIELD
print password_field(-name=>'secret',
-value=>'starting value',
-size=>50,
-maxlength=>80);
-or-
print password_field('secret','starting value',50,80);
password_field() is identical to textfield(), except that its contents
will be starred out on the web page.
=head2 CREATING A FILE UPLOAD FIELD
print filefield(-name=>'uploaded_file',
-default=>'starting value',
-size=>50,
-maxlength=>80);
-or-
print filefield('uploaded_file','starting value',50,80);
filefield() will return a file upload field.
In order to take full advantage of this I<you must use the new
multipart encoding scheme> for the form. You can do this either
by calling B<start_form()> with an encoding type of B<&CGI::MULTIPART>,
or by calling the new method B<start_multipart_form()> instead of
vanilla B<start_form()>.
=over 4
=item B<Parameters>
=item 1.
The first parameter is the required name for the field (-name).
=item 2.
The optional second parameter is the starting value for the field contents
to be used as the default file name (-default).
For security reasons, browsers don't pay any attention to this field,
and so the starting value will always be blank. Worse, the field
loses its "sticky" behavior and forgets its previous contents. The
starting value field is called for in the HTML specification, however,
and possibly some browser will eventually provide support for it.
=item 3.
The optional third parameter is the size of the field in
characters (-size).
=item 4.
The optional fourth parameter is the maximum number of characters the
field will accept (-maxlength).
=back
JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>,
B<-onMouseOver>, B<-onMouseOut> and B<-onSelect> parameters are
recognized. See textfield() for details.
=head2 PROCESSING A FILE UPLOAD FIELD
=head3 Basics
When the form is processed, you can retrieve an L<IO::Handle> compatible
handle for a file upload field like this:
$lightweight_fh = $q->upload('field_name');
# undef may be returned if it's not a valid file handle
if (defined $lightweight_fh) {
# Upgrade the handle to one compatible with IO::Handle:
my $io_handle = $lightweight_fh->handle;
while ($bytesread = $io_handle->read($buffer,1024)) {
print OUTFILE $buffer;
}
}
In a list context, upload() will return an array of filehandles.
This makes it possible to process forms that use the same name for
multiple upload fields.
If you want the entered file name for the file, you can just call param():
$filename = $q->param('field_name');
Different browsers will return slightly different things for the
name. Some browsers return the filename only. Others return the full
path to the file, using the path conventions of the user's machine.
Regardless, the name returned is always the name of the file on the
I<user's> machine, and is unrelated to the name of the temporary file
that CGI.pm creates during upload spooling (see below).
When a file is uploaded the browser usually sends along some
information along with it in the format of headers. The information
usually includes the MIME content type. To
retrieve this information, call uploadInfo(). It returns a reference to
a hash containing all the document headers.
$filename = $q->param('uploaded_file');
$type = $q->uploadInfo($filename)->{'Content-Type'};
die "HTML FILES ONLY!";
}
If you are using a machine that recognizes "text" and "binary" data
modes, be sure to understand when and how to use them (see the Camel book).
Otherwise you may find that binary files are corrupted during file
uploads.
=head3 Accessing the temp files directly
When processing an uploaded file, CGI.pm creates a temporary file on your hard
disk and passes you a file handle to that file. After you are finished with the
file handle, CGI.pm unlinks (deletes) the temporary file. If you need to you
can access the temporary file directly. You can access the temp file for a file
upload by passing the file name to the tmpFileName() method:
$filename = $query->param('uploaded_file');
$tmpfilename = $query->tmpFileName($filename);
The temporary file will be deleted automatically when your program exits unless
you manually rename it. On some operating systems (such as Windows NT), you
will need to close the temporary file's filehandle before your program exits.
Otherwise the attempt to delete the temporary file will fail.
=head3 Handling interrupted file uploads
There are occasionally problems involving parsing the uploaded file.
This usually happens when the user presses "Stop" before the upload is
finished. In this case, CGI.pm will return undef for the name of the
uploaded file and set I<cgi_error()> to the string "400 Bad request
(malformed multipart POST)". This error message is designed so that
you can incorporate it into a status code to be sent to the browser.
Example:
$file = $q->upload('uploaded_file');
if (!$file && $q->cgi_error) {
print $q->header(-status=>$q->cgi_error);
exit 0;
}
You are free to create a custom HTML page to complain about the error,
if you wish.
=head3 Progress bars for file uploads and avoiding temp files
CGI.pm gives you low-level access to file upload management through
a file upload hook. You can use this feature to completely turn off
the temp file storage of file uploads, or potentially write your own
file upload progress meter.
This is much like the UPLOAD_HOOK facility available in L<Apache::Request>, with
the exception that the first argument to the callback is an L<Apache::Upload>
object, here it's the remote filename.
$q = CGI->new(\&hook [,$data [,$use_tempfile]]);
sub hook {
my ($filename, $buffer, $bytes_read, $data) = @_;
print "Read $bytes_read bytes of $filename\n";
}
The C<< $data >> field is optional; it lets you pass configuration
information (e.g. a database handle) to your hook callback.
The C<< $use_tempfile >> field is a flag that lets you turn on and off
CGI.pm's use of a temporary disk-based file during file upload. If you
set this to a FALSE value (default true) then $q->param('uploaded_file')
will no longer work, and the only way to get at the uploaded data is
via the hook you provide.
If using the function-oriented interface, call the CGI::upload_hook()
method before calling param() or any other CGI functions:
CGI::upload_hook(\&hook [,$data [,$use_tempfile]]);
This method is not exported by default. You will have to import it
explicitly if you wish to use it without the CGI:: prefix.
=head3 Troubleshooting file uploads on Windows
If you are using CGI.pm on a Windows platform and find that binary
files get slightly larger when uploaded but that text files remain the
same, then you have forgotten to activate binary mode on the output
filehandle. Be sure to call binmode() on any handle that you create
to write the uploaded file to disk.
=head3 Older ways to process file uploads
( This section is here for completeness. if you are building a new application with CGI.pm, you can skip it. )
The original way to process file uploads with CGI.pm was to use param(). The
value it returns has a dual nature as both a file name and a lightweight
filehandle. This dual nature is problematic if you following the recommended
practice of having C<use strict> in your code. Perl will complain when you try
to use a string as a filehandle. More seriously, it is possible for the remote
user to type garbage into the upload field, in which case what you get from
param() is not a filehandle at all, but a string.
To solve this problem the upload() method was added, which always returns a
lightweight filehandle. This generally works well, but will have trouble
interoperating with some other modules because the file handle is not derived
from L<IO::Handle>. So that brings us to current recommendation given above,
which is to call the handle() method on the file handle returned by upload().
That upgrades the handle to an IO::Handle. It's a big win for compatibility for
a small penalty of loading IO::Handle the first time you call it.
=head2 CREATING A POPUP MENU
print popup_menu('menu_name',
['eenie','meenie','minie'],
'meenie');
-or-
%labels = ('eenie'=>'your first choice',
'meenie'=>'your second choice',
'minie'=>'your third choice');
%attributes = ('eenie'=>{'class'=>'class of first choice'});
print popup_menu('menu_name',
['eenie','meenie','minie'],
'meenie',\%labels,\%attributes);
-or (named parameter style)-
print popup_menu(-name=>'menu_name',
-values=>['eenie','meenie','minie'],
-default=>['meenie','minie'],
-labels=>\%labels,
-attributes=>\%attributes);
popup_menu() creates a menu.
=over 4
=item 1.
The required first argument is the menu's name (-name).
=item 2.
The required second argument (-values) is an array B<reference>
containing the list of menu items in the menu. You can pass the
method an anonymous array, as shown in the example, or a reference to
a named array, such as "\@foo".
=item 3.
The optional third parameter (-default) is the name of the default
menu choice. If not specified, the first item will be the default.
The values of the previous choice will be maintained across
queries. Pass an array reference to select multiple defaults.
=item 4.
The optional fourth parameter (-labels) is provided for people who
want to use different values for the user-visible label inside the
popup menu and the value returned to your script. It's a pointer to an
hash relating menu values to user-visible labels. If you
leave this parameter blank, the menu values will be displayed by
default. (You can also leave a label undefined if you want to).
=item 5.
The optional fifth parameter (-attributes) is provided to assign
any of the common HTML attributes to an individual menu item. It's
a pointer to a hash relating menu values to another
hash with the attribute's name as the key and the
attribute's value as the value.
=back
When the form is processed, the selected value of the popup menu can
be retrieved using:
$popup_menu_value = param('menu_name');
=head2 CREATING AN OPTION GROUP
Named parameter style
print popup_menu(-name=>'menu_name',
optgroup(-name=>'optgroup_name',
-values => ['moe','catch'],
-attributes=>{'catch'=>{'class'=>'red'}})],
-labels=>{'eenie'=>'one',
'meenie'=>'two',
'minie'=>'three'},
-default=>'meenie');
Old style
print popup_menu('menu_name',
['eenie','meenie','minie',
optgroup('optgroup_name', ['moe', 'catch'],
{'catch'=>{'class'=>'red'}})],'meenie',
{'eenie'=>'one','meenie'=>'two','minie'=>'three'});
optgroup() creates an option group within a popup menu.
=over 4
=item 1.
The required first argument (B<-name>) is the label attribute of the
optgroup and is B<not> inserted in the parameter list of the query.
=item 2.
The required second argument (B<-values>) is an array reference
containing the list of menu items in the menu. You can pass the
method an anonymous array, as shown in the example, or a reference
to a named array, such as \@foo. If you pass a HASH reference,
the keys will be used for the menu values, and the values will be
used for the menu labels (see -labels below).
=item 3.
The optional third parameter (B<-labels>) allows you to pass a reference
to a hash containing user-visible labels for one or more
of the menu items. You can use this when you want the user to see one
menu string, but have the browser return your program a different one.
If you don't specify this, the value string will be used instead
("eenie", "meenie" and "minie" in this example). This is equivalent
to using a hash reference for the -values parameter.
=item 4.
An optional fourth parameter (B<-labeled>) can be set to a true value
and indicates that the values should be used as the label attribute
for each option element within the optgroup.
=item 5.
An optional fifth parameter (-novals) can be set to a true value and
indicates to suppress the val attribute in each option element within
the optgroup.
See the discussion on optgroup at W3C
(http://www.w3.org/TR/REC-html40/interact/forms.html#edef-OPTGROUP)
for details.
=item 6.
An optional sixth parameter (-attributes) is provided to assign
any of the common HTML attributes to an individual menu item. It's
a pointer to a hash relating menu values to another
hash with the attribute's name as the key and the
attribute's value as the value.
=back
=head2 CREATING A SCROLLING LIST
print scrolling_list('list_name',
['eenie','meenie','minie','moe'],
['eenie','moe'],5,'true',{'moe'=>{'class'=>'red'}});
-or-
print scrolling_list('list_name',
['eenie','meenie','minie','moe'],
['eenie','moe'],5,'true',
\%labels,%attributes);
-or-
print scrolling_list(-name=>'list_name',
-values=>['eenie','meenie','minie','moe'],
-default=>['eenie','moe'],
-size=>5,
-multiple=>'true',
-labels=>\%labels,
-attributes=>\%attributes);
scrolling_list() creates a scrolling list.
=over 4
=item B<Parameters:>
=item 1.
The first and second arguments are the list name (-name) and values
(-values). As in the popup menu, the second argument should be an
array reference.
=item 2.
The optional third argument (-default) can be either a reference to a
list containing the values to be selected by default, or can be a
single value to select. If this argument is missing or undefined,
then nothing is selected when the list first appears. In the named
parameter version, you can use the synonym "-defaults" for this
parameter.
=item 3.
The optional fourth argument is the size of the list (-size).
=item 4.
The optional fifth argument can be set to true to allow multiple
simultaneous selections (-multiple). Otherwise only one selection
will be allowed at a time.
=item 5.
The optional sixth argument is a pointer to a hash
containing long user-visible labels for the list items (-labels).
If not provided, the values will be displayed.
=item 6.
The optional sixth parameter (-attributes) is provided to assign
any of the common HTML attributes to an individual menu item. It's
a pointer to a hash relating menu values to another
hash with the attribute's name as the key and the
attribute's value as the value.
When this form is processed, all selected list items will be returned as
a list under the parameter name 'list_name'. The values of the
selected items can be retrieved with:
@selected = param('list_name');
=back
=head2 CREATING A GROUP OF RELATED CHECKBOXES
print checkbox_group(-name=>'group_name',
-values=>['eenie','meenie','minie','moe'],
-default=>['eenie','moe'],
-linebreak=>'true',
-disabled => ['moe'],
-labels=>\%labels,
-attributes=>\%attributes);
print checkbox_group('group_name',
['eenie','meenie','minie','moe'],
['eenie','moe'],'true',\%labels,
{'moe'=>{'class'=>'red'}});
HTML3-COMPATIBLE BROWSERS ONLY:
print checkbox_group(-name=>'group_name',
-values=>['eenie','meenie','minie','moe'],
-rows=2,-columns=>2);
checkbox_group() creates a list of checkboxes that are related
by the same name.
=over 4
=item B<Parameters:>
=item 1.
The first and second arguments are the checkbox name and values,
respectively (-name and -values). As in the popup menu, the second
argument should be an array reference. These values are used for the
user-readable labels printed next to the checkboxes as well as for the
values passed to your script in the query string.
=item 2.
The optional third argument (-default) can be either a reference to a
list containing the values to be checked by default, or can be a
single value to checked. If this argument is missing or undefined,
then nothing is selected when the list first appears.
=item 3.
The optional fourth argument (-linebreak) can be set to true to place
line breaks between the checkboxes so that they appear as a vertical
list. Otherwise, they will be strung together on a horizontal line.
=back
The optional B<-labels> argument is a pointer to a hash
relating the checkbox values to the user-visible labels that will be
printed next to them. If not provided, the values will be used as the
default.
The optional parameters B<-rows>, and B<-columns> cause
checkbox_group() to return an HTML3 compatible table containing the
checkbox group formatted with the specified number of rows and
columns. You can provide just the -columns parameter if you wish;
checkbox_group will calculate the correct number of rows for you.
The option B<-disabled> takes an array of checkbox values and disables
them by greying them out (this may not be supported by all browsers).
The optional B<-attributes> argument is provided to assign any of the
common HTML attributes to an individual menu item. It's a pointer to
a hash relating menu values to another hash
with the attribute's name as the key and the attribute's value as the
value.
The optional B<-tabindex> argument can be used to control the order in which
radio buttons receive focus when the user presses the tab button. If
passed a scalar numeric value, the first element in the group will
receive this tab index and subsequent elements will be incremented by
one. If given a reference to an array of radio button values, then
the indexes will be jiggered so that the order specified in the array
will correspond to the tab order. You can also pass a reference to a
hash in which the hash keys are the radio button values and the values
are the tab indexes of each button. Examples:
-tabindex => 100 # this group starts at index 100 and counts up
-tabindex => ['moe','minie','eenie','meenie'] # tab in this order
-tabindex => {meenie=>100,moe=>101,minie=>102,eenie=>200} # tab in this order
The optional B<-labelattributes> argument will contain attributes
attached to the <label> element that surrounds each button.
When the form is processed, all checked boxes will be returned as
a list under the parameter name 'group_name'. The values of the
"on" checkboxes can be retrieved with:
@turned_on = param('group_name');
The value returned by checkbox_group() is actually an array of button
elements. You can capture them and use them within tables, lists,
or in other creative ways:
@h = checkbox_group(-name=>'group_name',-values=>\@values);
&use_in_creative_way(@h);
=head2 CREATING A STANDALONE CHECKBOX
print checkbox(-name=>'checkbox_name',
-checked=>1,
-value=>'ON',
-label=>'CLICK ME');
-or-
print checkbox('checkbox_name','checked','ON','CLICK ME');
checkbox() is used to create an isolated checkbox that isn't logically
related to any others.
=over 4
=item B<Parameters:>
=item 1.
The first parameter is the required name for the checkbox (-name). It
will also be used for the user-readable label printed next to the
checkbox.
=item 2.
The optional second parameter (-checked) specifies that the checkbox
is turned on by default. Synonyms are -selected and -on.
=item 3.
The optional third parameter (-value) specifies the value of the
checkbox when it is checked. If not provided, the word "on" is
assumed.
=item 4.
The optional fourth parameter (-label) is the user-readable label to
be attached to the checkbox. If not provided, the checkbox name is
used.
=back
The value of the checkbox can be retrieved using:
$turned_on = param('checkbox_name');
=head2 CREATING A RADIO BUTTON GROUP
print radio_group(-name=>'group_name',
-values=>['eenie','meenie','minie'],
-default=>'meenie',
-linebreak=>'true',
-labels=>\%labels,
-attributes=>\%attributes);
-or-
print radio_group('group_name',['eenie','meenie','minie'],
'meenie','true',\%labels,\%attributes);
HTML3-COMPATIBLE BROWSERS ONLY:
print radio_group(-name=>'group_name',
-values=>['eenie','meenie','minie','moe'],
-rows=2,-columns=>2);
radio_group() creates a set of logically-related radio buttons
(turning one member of the group on turns the others off)
=over 4
=item B<Parameters:>
=item 1.
The first argument is the name of the group and is required (-name).
=item 2.
The second argument (-values) is the list of values for the radio
buttons. The values and the labels that appear on the page are
identical. Pass an array I<reference> in the second argument, either
using an anonymous array, as shown, or by referencing a named array as
in "\@foo".
=item 3.
The optional third parameter (-default) is the name of the default
button to turn on. If not specified, the first item will be the
default. You can provide a nonexistent button name, such as "-" to
start up with no buttons selected.
=item 4.
The optional fourth parameter (-linebreak) can be set to 'true' to put
line breaks between the buttons, creating a vertical list.
=item 5.
The optional fifth parameter (-labels) is a pointer to an associative
array relating the radio button values to user-visible labels to be
used in the display. If not provided, the values themselves are
displayed.
=back
All modern browsers can take advantage of the optional parameters
B<-rows>, and B<-columns>. These parameters cause radio_group() to
return an HTML3 compatible table containing the radio group formatted
with the specified number of rows and columns. You can provide just
the -columns parameter if you wish; radio_group will calculate the
correct number of rows for you.
To include row and column headings in the returned table, you
can use the B<-rowheaders> and B<-colheaders> parameters. Both
of these accept a pointer to an array of headings to use.
The headings are just decorative. They don't reorganize the
interpretation of the radio buttons -- they're still a single named
unit.
The optional B<-tabindex> argument can be used to control the order in which
radio buttons receive focus when the user presses the tab button. If
passed a scalar numeric value, the first element in the group will
receive this tab index and subsequent elements will be incremented by
one. If given a reference to an array of radio button values, then
the indexes will be jiggered so that the order specified in the array
will correspond to the tab order. You can also pass a reference to a
hash in which the hash keys are the radio button values and the values
are the tab indexes of each button. Examples:
-tabindex => 100 # this group starts at index 100 and counts up
-tabindex => ['moe','minie','eenie','meenie'] # tab in this order
-tabindex => {meenie=>100,moe=>101,minie=>102,eenie=>200} # tab in this order
The optional B<-attributes> argument is provided to assign any of the
common HTML attributes to an individual menu item. It's a pointer to
a hash relating menu values to another hash
with the attribute's name as the key and the attribute's value as the
value.
The optional B<-labelattributes> argument will contain attributes
attached to the <label> element that surrounds each button.
When the form is processed, the selected radio button can
be retrieved using:
$which_radio_button = param('group_name');
The value returned by radio_group() is actually an array of button
elements. You can capture them and use them within tables, lists,
or in other creative ways:
@h = radio_group(-name=>'group_name',-values=>\@values);
&use_in_creative_way(@h);
=head2 CREATING A SUBMIT BUTTON
print submit(-name=>'button_name',
-value=>'value');
-or-
print submit('button_name','value');
submit() will create the query submission button. Every form
should have one of these.
=over 4
=item B<Parameters:>
=item 1.
The first argument (-name) is optional. You can give the button a
name if you have several submission buttons in your form and you want
to distinguish between them.
=item 2.
The second argument (-value) is also optional. This gives the button
a value that will be passed to your script in the query string. The
name will also be used as the user-visible label.
=item 3.
You can use -label as an alias for -value. I always get confused
about which of -name and -value changes the user-visible label on the
button.
=back
You can figure out which button was pressed by using different
values for each one:
$which_one = param('button_name');
=head2 CREATING A RESET BUTTON
print reset
reset() creates the "reset" button. Note that it restores the
form to its value from the last time the script was called,
NOT necessarily to the defaults.
Note that this conflicts with the Perl reset() built-in. Use
CORE::reset() to get the original reset function.
=head2 CREATING A DEFAULT BUTTON
print defaults('button_label')
defaults() creates a button that, when invoked, will cause the
form to be completely reset to its defaults, wiping out all the
changes the user ever made.
=head2 CREATING A HIDDEN FIELD
print hidden(-name=>'hidden_name',
-default=>['value1','value2'...]);
-or-
print hidden('hidden_name','value1','value2'...);
hidden() produces a text field that can't be seen by the user. It
is useful for passing state variable information from one invocation
of the script to the next.
=over 4
=item B<Parameters:>
=item 1.
The first argument is required and specifies the name of this
field (-name).
=item 2.
The second argument is also required and specifies its value
(-default). In the named parameter style of calling, you can provide
a single value here or a reference to a whole list
=back
Fetch the value of a hidden field this way:
$hidden_value = param('hidden_name');
Note, that just like all the other form elements, the value of a
hidden field is "sticky". If you want to replace a hidden field with
some other values after the script has been called once you'll have to
do it manually:
param('hidden_name','new','values','here');
=head2 CREATING A CLICKABLE IMAGE BUTTON
print image_button(-name=>'button_name',
-align=>'MIDDLE');
-or-
image_button() produces a clickable image. When it's clicked on the
position of the click is returned to your script as "button_name.x"
and "button_name.y", where "button_name" is the name you've assigned
to it.
=over 4
=item B<Parameters:>
=item 1.
The first argument (-name) is required and specifies the name of this
field.
=item 2.
The second argument (-src) is also required and specifies the URL
=item 3.
The third option (-align, optional) is an alignment type, and may be
TOP, BOTTOM or MIDDLE
=back
Fetch the value of the button this way:
$x = param('button_name.x');
$y = param('button_name.y');
=head2 CREATING A JAVASCRIPT ACTION BUTTON
print button(-name=>'button_name',
-value=>'user visible label',
-onClick=>"do_something()");
-or-
print button('button_name',"user visible value","do_something()");
button() produces an C<< <input> >> tag with C<type="button">. When it's
pressed the fragment of JavaScript code pointed to by the B<-onClick> parameter
will be executed.
=head1 HTTP COOKIES
Browsers support a so-called "cookie" designed to help maintain state
within a browser session. CGI.pm has several methods that support
cookies.
A cookie is a name=value pair much like the named parameters in a CGI
query string. CGI scripts create one or more cookies and send
them to the browser in the HTTP header. The browser maintains a list
of cookies that belong to a particular Web server, and returns them
to the CGI script during subsequent interactions.
In addition to the required name=value pair, each cookie has several
optional attributes:
=over 4
=item 1. an expiration time
when a cookie expires. The cookie will be saved and returned to your
script until this expiration date is reached if the user exits
the browser and restarts it. If an expiration date isn't specified, the cookie
will remain active until the user quits the browser.
=item 2. a domain
This is a partial or complete domain name for which the cookie is
valid. The browser will return the cookie to any host that matches
the partial domain name. For example, if you specify a domain name
of ".capricorn.com", then the browser will return the cookie to
Web servers running on any of the machines "www.capricorn.com",
"www2.capricorn.com", "feckless.capricorn.com", etc. Domain names
must contain at least two periods to prevent attempts to match
on top level domains like ".edu". If no domain is specified, then
the browser will only return the cookie to servers on the host the
cookie originated from.
=item 3. a path
If you provide a cookie path attribute, the browser will check it
against your script's URL before returning the cookie. For example,
if you specify the path "/cgi-bin", then the cookie will be returned
and "/cgi-bin/customer_service/complain.pl", but not to the script
"/cgi-private/site_admin.pl". By default, path is set to "/", which
causes the cookie to be sent to any CGI script on your site.
=item 4. a "secure" flag
If the "secure" attribute is set, the cookie will only be sent to your
script if the CGI request is occurring on a secure channel, such as SSL.
=back
The interface to HTTP cookies is the B<cookie()> method:
$cookie = cookie(-name=>'sessionID',
-value=>'xyzzy',
-expires=>'+1h',
-domain=>'.capricorn.org',
-secure=>1);
print header(-cookie=>$cookie);
B<cookie()> creates a new cookie. Its parameters include:
=over 4
=item B<-name>
The name of the cookie (required). This can be any string at all.
Although browsers limit their cookie names to non-whitespace
alphanumeric characters, CGI.pm removes this restriction by escaping
and unescaping cookies behind the scenes.
=item B<-value>
The value of the cookie. This can be any scalar value,
array reference, or even hash reference. For example,
you can store an entire hash into a cookie this way:
$cookie=cookie(-name=>'family information',
-value=>\%childrens_ages);
=item B<-path>
The optional partial path for which this cookie will be valid, as described
above.
=item B<-domain>
The optional partial domain for which this cookie will be valid, as described
above.
=item B<-expires>
The optional expiration date for this cookie. The format is as described
in the section on the B<header()> method:
"+1h" one hour from now
=item B<-secure>
If set to true, this cookie will only be used within a secure
SSL session.
=back
The cookie created by cookie() must be incorporated into the HTTP
header within the string returned by the header() method:
use CGI ':standard';
print header(-cookie=>$my_cookie);
To create multiple cookies, give header() an array reference:
$cookie1 = cookie(-name=>'riddle_name',
-value=>"The Sphynx's Question");
$cookie2 = cookie(-name=>'answers',
-value=>\%answers);
print header(-cookie=>[$cookie1,$cookie2]);
To retrieve a cookie, request it by name by calling cookie() method
without the B<-value> parameter. This example uses the object-oriented
form:
use CGI;
$query = CGI->new;
$riddle = $query->cookie('riddle_name');
%answers = $query->cookie('answers');
Cookies created with a single scalar value, such as the "riddle_name"
cookie, will be returned in that form. Cookies with array and hash
values can also be retrieved.
The cookie and CGI namespaces are separate. If you have a parameter
named 'answers' and a cookie named 'answers', the values retrieved by
param() and cookie() are independent of each other. However, it's
simple to turn a CGI parameter into a cookie, and vice-versa:
# turn a CGI parameter into a cookie
$c=cookie(-name=>'answers',-value=>[param('answers')]);
# vice-versa
param(-name=>'answers',-value=>[cookie('answers')]);
If you call cookie() without any parameters, it will return a list of
the names of all cookies passed to your script:
@cookies = cookie();
See the B<cookie.cgi> example script for some ideas on how to use
cookies effectively.
=head1 WORKING WITH FRAMES
It's possible for CGI.pm scripts to write into several browser panels
and windows using the HTML 4 frame mechanism. There are three
techniques for defining new frames programmatically:
=over 4
=item 1. Create a <Frameset> document
After writing out the HTTP header, instead of creating a standard
HTML document using the start_html() call, create a <frameset>
document that defines the frames on the page. Specify your script(s)
(with appropriate parameters) as the SRC for each of the frames.
There is no specific support for creating <frameset> sections
in CGI.pm, but the HTML is very simple to write.
=item 2. Specify the destination for the document in the HTTP header
You may provide a B<-target> parameter to the header() method:
print header(-target=>'ResultsWindow');
This will tell the browser to load the output of your script into the
frame named "ResultsWindow". If a frame of that name doesn't already
exist, the browser will pop up a new window and load your script's
document into that. There are a number of magic names that you can
use for targets. See the HTML C<< <frame> >> documentation for details.
=item 3. Specify the destination for the document in the <form> tag
You can specify the frame to load in the FORM tag itself. With
CGI.pm it looks like this:
print start_form(-target=>'ResultsWindow');
When your script is reinvoked by the form, its output will be loaded
into the frame named "ResultsWindow". If one doesn't already exist
a new window will be created.
=back
The script "frameset.cgi" in the examples directory shows one way to
create pages in which the fill-out form and the response live in
side-by-side frames.
=head1 SUPPORT FOR JAVASCRIPT
The usual way to use JavaScript is to define a set of functions in a
<SCRIPT> block inside the HTML header and then to register event
handlers in the various elements of the page. Events include such
things as the mouse passing over a form element, a button being
clicked, the contents of a text field changing, or a form being
submitted. When an event occurs that involves an element that has
registered an event handler, its associated JavaScript code gets
called.
The elements that can register event handlers include the <BODY> of an
HTML document, hypertext links, all the various elements of a fill-out
form, and the form itself. There are a large number of events, and
each applies only to the elements for which it is relevant. Here is a
partial list:
=over 4
=item B<onLoad>
The browser is loading the current document. Valid in:
+ The HTML <BODY> section only.
=item B<onUnload>
The browser is closing the current page or frame. Valid for:
+ The HTML <BODY> section only.
=item B<onSubmit>
The user has pressed the submit button of a form. This event happens
just before the form is submitted, and your function can return a
value of false in order to abort the submission. Valid for:
+ Forms only.
=item B<onClick>
The mouse has clicked on an item in a fill-out form. Valid for:
+ Buttons (including submit, reset, and image buttons)
+ Checkboxes
+ Radio buttons
=item B<onChange>
The user has changed the contents of a field. Valid for:
+ Text fields
+ Text areas
+ Password fields
+ File fields
+ Popup Menus
+ Scrolling lists
=item B<onFocus>
The user has selected a field to work with. Valid for:
+ Text fields
+ Text areas
+ Password fields
+ File fields
+ Popup Menus
+ Scrolling lists
=item B<onBlur>
The user has deselected a field (gone to work somewhere else). Valid
for:
+ Text fields
+ Text areas
+ Password fields
+ File fields
+ Popup Menus
+ Scrolling lists
=item B<onSelect>
The user has changed the part of a text field that is selected. Valid
for:
+ Text fields
+ Text areas
+ Password fields
+ File fields
=item B<onMouseOver>
The mouse has moved over an element.
+ Text fields
+ Text areas
+ Password fields
+ File fields
+ Popup Menus
+ Scrolling lists
=item B<onMouseOut>
The mouse has moved off an element.
+ Text fields
+ Text areas
+ Password fields
+ File fields
+ Popup Menus
+ Scrolling lists
=back
In order to register a JavaScript event handler with an HTML element,
just use the event name as a parameter when you call the corresponding
CGI method. For example, to have your validateAge() JavaScript code
executed every time the textfield named "age" changes, generate the
field like this:
print textfield(-name=>'age',-onChange=>"validateAge(this)");
This example assumes that you've already declared the validateAge()
function by incorporating it into a <SCRIPT> block. The CGI.pm
start_html() method provides a convenient way to create this section.
Similarly, you can create a form that checks itself over for
consistency and alerts the user if some essential value is missing by
creating it this way:
print start_form(-onSubmit=>"validateMe(this)");
See the javascript.cgi script for a demonstration of how this all
works.
=head1 LIMITED SUPPORT FOR CASCADING STYLE SHEETS
CGI.pm has limited support for HTML3's cascading style sheets (css).
To incorporate a stylesheet into your document, pass the
start_html() method a B<-style> parameter. The value of this
parameter may be a scalar, in which case it is treated as the source
URL for the stylesheet, or it may be a hash reference. In the latter
case you should provide the hash with one or more of B<-src> or
B<-code>. B<-src> points to a URL where an externally-defined
stylesheet can be found. B<-code> points to a scalar value to be
incorporated into a <style> section. Style definitions in B<-code>
override similarly-named ones in B<-src>, hence the name "cascading."
You may also specify the type of the stylesheet by adding the optional
B<-type> parameter to the hash pointed to by B<-style>. If not
To refer to a style within the body of your document, add the
B<-class> parameter to any HTML element:
print h1({-class=>'Fancy'},'Welcome to the Party');
Or define styles on the fly with the B<-style> parameter:
print h1({-style=>'Color: red;'},'Welcome to Hell');
You may also use the new B<span()> element to apply a style to a
section of text:
print span({-style=>'Color: red;'},
h1('Welcome to Hell'),
"Where did that handbasket get to?"
);
Note that you must import the ":html3" definitions to have the
B<span()> method available. Here's a quick and dirty example of using
CSS's. See the CSS specification at
http://www.w3.org/Style/CSS/ for more information.
use CGI qw/:standard :html3/;
#here's a stylesheet incorporated directly into the page
$newStyle=<<END;
<!--
P.Tip {
margin-right: 50pt;
margin-left: 50pt;
color: red;
}
P.Alert {
font-size: 30pt;
font-family: sans-serif;
color: red;
}
-->
END
print header();
print start_html( -title=>'CGI with Style',
-style=>{-src=>'http://www.capricorn.com/style/st1.css',
-code=>$newStyle}
);
print h1('CGI with Style'),
p({-class=>'Tip'},
"Better read the cascading style sheet spec before playing with this!"),
span({-style=>'color: magenta'},
"Look Mom, no hands!",
p(),
"Whooo wee!"
);
print end_html;
Pass an array reference to B<-code> or B<-src> in order to incorporate
multiple stylesheets into your document.
Should you wish to incorporate a verbatim stylesheet that includes
arbitrary formatting in the header, you may pass a -verbatim tag to
the -style hash, as follows:
print start_html (-style => {-verbatim => '@import url("/server-common/css/'.$cssFile.'");',
-src => '/server-common/css/core.css'});
This will generate an HTML header that contains this:
<link rel="stylesheet" type="text/css" href="/server-common/css/core.css">
@import url("/server-common/css/main.css");
</style>
Any additional arguments passed in the -style value will be
incorporated into the <link> tag. For example:
start_html(-style=>{-src=>['/styles/print.css','/styles/layout.css'],
-media => 'all'});
This will give:
<link rel="stylesheet" type="text/css" href="/styles/layout.css" media="all"/>
<p>
To make more complicated <link> tags, use the Link() function
and pass it to start_html() in the -head argument, as in:
print start_html({-head=>\@h})
To create primary and "alternate" stylesheet, use the B<-alternate> option:
start_html(-style=>{-src=>[
]
});
=head1 DEBUGGING
If you are running the script from the command line or in the perl
debugger, you can pass the script a list of keywords or
parameter=value pairs on the command line or from standard input (you
don't have to worry about tricking your script into reading from
environment variables). You can pass keywords like this:
your_script.pl keyword1 keyword2 keyword3
or this:
your_script.pl keyword1+keyword2+keyword3
or this:
your_script.pl name1=value1 name2=value2
or this:
your_script.pl name1=value1&name2=value2
To turn off this feature, use the -no_debug pragma.
To test the POST method, you may enable full debugging with the -debug
pragma. This will allow you to feed newline-delimited name=value
pairs to the script on standard input.
When debugging, you can use quotes and backslashes to escape
characters in the familiar shell manner, letting you place
spaces and other funny characters in your parameter=value
pairs:
your_script.pl "name1='I am a long value'" "name2=two\ words"
Finally, you can set the path info for the script by prefixing the first
your_script.pl /your/path/here?name1=value1&name2=value2
The Dump() method produces a string consisting of all the query's
for debugging purposes:
print Dump
Produces something that looks like:
<ul>
<li>name1
<ul>
<li>value1
<li>value2
</ul>
<li>name2
<ul>
<li>value1
</ul>
</ul>
As a shortcut, you can interpolate the entire CGI object into a string
and it will be replaced with the a nice HTML dump shown above:
$query=CGI->new;
print "<h2>Current Values</h2> $query\n";
=head1 FETCHING ENVIRONMENT VARIABLES
Some of the more useful environment variables can be fetched
through this interface. The methods are as follows:
=over 4
=item B<Accept()>
Return a list of MIME types that the remote browser accepts. If you
give this method a single argument corresponding to a MIME type, as in
corresponding to the browser's preference for this type from 0.0
(don't want) to 1.0. Glob types (e.g. text/*) in the browser's accept
list are handled correctly.
Note that the capitalization changed between version 2.43 and 2.44 in
order to avoid conflict with Perl's accept() function.
=item B<raw_cookie()>
Returns the HTTP_COOKIE variable. Cookies have a special format, and
this method call just returns the raw form (?cookie dough). See
cookie() for ways of setting and retrieving cooked cookies.
Called with no parameters, raw_cookie() returns the packed cookie
structure. You can separate it into individual cookies by splitting
on the character sequence "; ". Called with the name of a cookie,
retrieves the B<unescaped> form of the cookie. You can use the
regular cookie() method to get the names, or use the raw_fetch()
method from the CGI::Cookie module.
=item B<user_agent()>
Returns the HTTP_USER_AGENT variable. If you give
this method a single argument, it will attempt to
pattern match on it, allowing you to do something
like user_agent(Mozilla);
=item B<path_info()>
Returns additional path information from the script URL.
E.G. fetching /cgi-bin/your_script/additional/stuff will result in
path_info() returning "/additional/stuff".
NOTE: The Microsoft Internet Information Server
is broken with respect to additional path information. If
you use the Perl DLL library, the IIS server will attempt to
execute the additional path information as a Perl script.
If you use the ordinary file associations mapping, the
path information will be present in the environment,
but incorrect. The best thing to do is to avoid using additional
path information in CGI scripts destined for use with IIS.
=item B<path_translated()>
As per path_info() but returns the additional
path information translated into a physical path, e.g.
The Microsoft IIS is broken with respect to the translated
path as well.
=item B<remote_host()>
Returns either the remote host name or IP address.
if the former is unavailable.
=item B<remote_addr()>
Returns the remote host IP address, or
127.0.0.1 if the address is unavailable.
=item B<script_name()>
Return the script name as a partial URL, for self-referring
scripts.
=item B<referer()>
Return the URL of the page the browser was viewing
prior to fetching your script. Not available for all
browsers.
=item B<auth_type ()>
Return the authorization/verification method in use for this
script, if any.
=item B<server_name ()>
Returns the name of the server, usually the machine's host
name.
=item B<virtual_host ()>
When using virtual hosts, returns the name of the host that
the browser attempted to contact
=item B<server_port ()>
Return the port that the server is listening on.
=item B<virtual_port ()>
Like server_port() except that it takes virtual hosts into account.
Use this when running with virtual hosts.
=item B<server_software ()>
Returns the server software and version number.
=item B<remote_user ()>
Return the authorization/verification name used for user
verification, if this script is protected.
=item B<user_name ()>
Attempt to obtain the remote user's name, using a variety of different
techniques. This only works with older browsers such as Mosaic.
Newer browsers do not report the user name for privacy reasons!
=item B<request_method()>
Returns the method used to access your script, usually
one of 'POST', 'GET' or 'HEAD'.
=item B<content_type()>
Returns the content_type of data submitted in a POST, generally
=item B<http()>
Called with no arguments returns the list of HTTP environment
variables, including such things as HTTP_USER_AGENT,
HTTP_ACCEPT_LANGUAGE, and HTTP_ACCEPT_CHARSET, corresponding to the
like-named HTTP header fields in the request. Called with the name of
an HTTP header field, returns its value. Capitalization and the use
of hyphens versus underscores are not significant.
For example, all three of these examples are equivalent:
$requested_language = http('Accept-language');
$requested_language = http('Accept_language');
$requested_language = http('HTTP_ACCEPT_LANGUAGE');
=item B<https()>
The same as I<http()>, but operates on the HTTPS environment variables
present when the SSL protocol is in effect. Can be used to determine
whether SSL is turned on.
=back
=head1 USING NPH SCRIPTS
NPH, or "no-parsed-header", scripts bypass the server completely by
sending the complete HTTP header directly to the browser. This has
slight performance benefits, but is of most use for taking advantage
of HTTP extensions that are not directly supported by your server,
such as server push and PICS headers.
Servers use a variety of conventions for designating CGI scripts as
NPH. Many Unix servers look at the beginning of the script's name for
the prefix "nph-". The Macintosh WebSTAR server and Microsoft's
Internet Information Server, in contrast, try to decide whether a
program is an NPH script by examining the first line of script output.
CGI.pm supports NPH scripts with a special NPH mode. When in this
mode, CGI.pm will output the necessary extra header information when
the header() and redirect() methods are
called.
The Microsoft Internet Information Server requires NPH mode. As of
version 2.30, CGI.pm will automatically detect when the script is
running under IIS and put itself into this mode. You do not need to
do this manually, although it won't hurt anything if you do. However,
note that if you have applied Service Pack 6, much of the
functionality of NPH scripts, including the ability to redirect while
setting a cookie, B<do not work at all> on IIS without a special patch
from Microsoft. See
Non-Parsed Headers Stripped From CGI Applications That Have nph-
Prefix in Name.
=over 4
=item In the B<use> statement
Simply add the "-nph" pragma to the list of symbols to be imported into
your script:
use CGI qw(:standard -nph)
=item By calling the B<nph()> method:
Call B<nph()> with a non-zero parameter at any point after using CGI.pm in your program.
CGI->nph(1)
=item By using B<-nph> parameters
in the B<header()> and B<redirect()> statements:
print header(-nph=>1);
=back
=head1 Server Push
CGI.pm provides four simple functions for producing multipart
documents of the type needed to implement server push. These
functions were graciously provided by Ed Jordan <ed@fidalgo.net>. To
import these into your namespace, you must import the ":push" set.
You are also advised to put the script into NPH mode and to set $| to
1 to avoid buffering problems.
Here is a simple script that demonstrates server push:
use CGI qw/:push -nph/;
$| = 1;
print multipart_init(-boundary=>'----here we go!');
for (0 .. 4) {
"The current time is ",scalar(localtime),"\n";
if ($_ < 4) {
print multipart_end;
} else {
print multipart_final;
}
sleep 1;
}
This script initializes server push by calling B<multipart_init()>.
It then enters a loop in which it begins a new multipart section by
calling B<multipart_start()>, prints the current local time,
and ends a multipart section with B<multipart_end()>. It then sleeps
a second, and begins again. On the final iteration, it ends the
multipart section with B<multipart_final()> rather than with
B<multipart_end()>.
=over 4
=item multipart_init()
multipart_init(-boundary=>$boundary);
Initialize the multipart system. The -boundary argument specifies
what MIME boundary string to use to separate parts of the document.
If not provided, CGI.pm chooses a reasonable boundary for you.
=item multipart_start()
multipart_start(-type=>$type)
Start a new part of the multipart document using the specified MIME
=item multipart_end()
multipart_end()
End a part. You must remember to call multipart_end() once for each
multipart_start(), except at the end of the last part of the multipart
document when multipart_final() should be called instead of multipart_end().
=item multipart_final()
multipart_final()
End all parts. You should call multipart_final() rather than
multipart_end() at the end of the last part of the multipart document.
=back
Users interested in server push applications should also have a look
at the CGI::Push module.
=head1 Avoiding Denial of Service Attacks
A potential problem with CGI.pm is that, by default, it attempts to
process form POSTings no matter how large they are. A wily hacker
could attack your site by sending a CGI script a huge POST of many
megabytes. CGI.pm will attempt to read the entire POST into a
variable, growing hugely in size until it runs out of memory. While
the script attempts to allocate the memory the system may slow down
dramatically. This is a form of denial of service attack.
Another possible attack is for the remote user to force CGI.pm to
accept a huge file upload. CGI.pm will accept the upload and store it
in a temporary directory even if your script doesn't expect to receive
an uploaded file. CGI.pm will delete the file automatically when it
terminates, but in the meantime the remote user may have filled up the
server's disk space, causing problems for other programs.
The best way to avoid denial of service attacks is to limit the amount
of memory, CPU time and disk space that CGI scripts can use. Some Web
servers come with built-in facilities to accomplish this. In other
cases, you can use the shell I<limit> or I<ulimit>
commands to put ceilings on CGI resource usage.
CGI.pm also has some simple built-in protections against denial of
service attacks, but you must activate them before you can use them.
These take the form of two global variables in the CGI name space:
=over 4
=item B<$CGI::POST_MAX>
If set to a non-negative integer, this variable puts a ceiling
on the size of POSTings, in bytes. If CGI.pm detects a POST
that is greater than the ceiling, it will immediately exit with an error
message. This value will affect both ordinary POSTs and
multipart POSTs, meaning that it limits the maximum size of file
uploads as well. You should set this to a reasonably high
value, such as 1 megabyte.
=item B<$CGI::DISABLE_UPLOADS>
If set to a non-zero value, this will disable file uploads
completely. Other fill-out form values will work as usual.
=back
You can use these variables in either of two ways.
=over 4
=item B<1. On a script-by-script basis>
Set the variable at the top of the script, right after the "use" statement:
use CGI qw/:standard/;
use CGI::Carp 'fatalsToBrowser';
$CGI::POST_MAX=1024 * 100; # max 100K posts
$CGI::DISABLE_UPLOADS = 1; # no uploads
=item B<2. Globally for all scripts>
Open up CGI.pm, find the definitions for $POST_MAX and
$DISABLE_UPLOADS, and set them to the desired values. You'll
find them towards the top of the file in a subroutine named
initialize_globals().
=back
An attempt to send a POST larger than $POST_MAX bytes will cause
I<param()> to return an empty CGI parameter list. You can test for
this event by checking I<cgi_error()>, either after you create the CGI
object or, if you are using the function-oriented interface, call
<param()> for the first time. If the POST was intercepted, then
cgi_error() will return the message "413 POST too large".
This error message is actually defined by the HTTP protocol, and is
designed to be returned to the browser as the CGI script's status
code. For example:
$uploaded_file = param('upload');
if (!$uploaded_file && cgi_error()) {
print header(-status=>cgi_error());
exit 0;
}
However it isn't clear that any browser currently knows what to do
with this status code. It might be better just to create an
HTML page that warns the user of the problem.
=head1 COMPATIBILITY WITH CGI-LIB.PL
To make it easier to port existing programs that use cgi-lib.pl the
compatibility routine "ReadParse" is provided. Porting is simple:
OLD VERSION
require "cgi-lib.pl";
&ReadParse;
print "The value of the antique is $in{antique}.\n";
NEW VERSION
use CGI;
CGI::ReadParse();
print "The value of the antique is $in{antique}.\n";
CGI.pm's ReadParse() routine creates a tied variable named %in,
which can be accessed to obtain the query variables. Like
ReadParse, you can also provide your own variable. Infrequently
used features of ReadParse, such as the creation of @in and $in
variables, are not supported.
Once you use ReadParse, you can retrieve the query object itself
this way:
$q = $in{CGI};
print $q->textfield(-name=>'wow',
-value=>'does this really work?');
This allows you to start using the more interesting features
of CGI.pm without rewriting your old scripts from scratch.
An even simpler way to mix cgi-lib calls with CGI.pm calls is to import both the
C<:cgi-lib> and C<:standard> method:
use CGI qw(:cgi-lib :standard);
&ReadParse;
print "The price of your purchase is $in{price}.\n";
print textfield(-name=>'price', -default=>'$1.99');
=head2 Cgi-lib functions that are available in CGI.pm
In compatability mode, the following cgi-lib.pl functions are
available for your use:
ReadParse()
PrintHeader()
HtmlTop()
HtmlBot()
SplitParam()
MethGet()
MethPost()
=head2 Cgi-lib functions that are not available in CGI.pm
* Extended form of ReadParse()
The extended form of ReadParse() that provides for file upload
spooling, is not available.
* MyBaseURL()
This function is not available. Use CGI.pm's url() method instead.
* MyFullURL()
This function is not available. Use CGI.pm's self_url() method
instead.
* CgiError(), CgiDie()
These functions are not supported. Look at CGI::Carp for the way I
prefer to handle error messages.
* PrintVariables()
This function is not available. To achieve the same effect,
just print out the CGI object:
use CGI qw(:standard);
$q = CGI->new;
print h1("The Variables Are"),$q;
* PrintEnv()
This function is not available. You'll have to roll your own if you really need it.
=head1 AUTHOR INFORMATION
The CGI.pm distribution is copyright 1995-2007, Lincoln D. Stein. It is
distributed under GPL and the Artistic License 2.0.
Address bug reports and comments to: lstein@cshl.org. When sending
bug reports, please provide the version of CGI.pm, the version of
Perl, the name and version of your Web server, and the name and
version of the operating system you are using. If the problem is even
remotely browser dependent, please provide information about the
affected browsers as well.
=head1 CREDITS
Thanks very much to:
=over 4
=item Matt Heffron (heffron@falstaff.css.beckman.com)
=item James Taylor (james.taylor@srs.gov)
=item Scott Anguish <sanguish@digifix.com>
=item Mike Jewell (mlj3u@virginia.edu)
=item Timothy Shimmin (tes@kbs.citri.edu.au)
=item Joergen Haegg (jh@axis.se)
=item Laurent Delfosse (delfosse@delfosse.com)
=item Richard Resnick (applepi1@aol.com)
=item Craig Bishop (csb@barwonwater.vic.gov.au)
=item Tony Curtis (tc@vcpc.univie.ac.at)
=item Tim Bunce (Tim.Bunce@ig.co.uk)
=item Tom Christiansen (tchrist@convex.com)
=item Andreas Koenig (k@franz.ww.TU-Berlin.DE)
=item Tim MacKenzie (Tim.MacKenzie@fulcrum.com.au)
=item Kevin B. Hendricks (kbhend@dogwood.tyler.wm.edu)
=item Stephen Dahmen (joyfire@inxpress.net)
=item Ed Jordan (ed@fidalgo.net)
=item David Alan Pisoni (david@cnation.com)
=item Doug MacEachern (dougm@opengroup.org)
=item Robin Houston (robin@oneworld.org)
=item ...and many many more...
for suggestions and bug fixes.
=back
=head1 A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT
use CGI ':standard';
print header;
print start_html("Example CGI.pm Form");
print "<h1> Example CGI.pm Form</h1>\n";
print_prompt();
do_work();
print_tail();
print end_html;
sub print_prompt {
print start_form;
print "<em>What's your name?</em><br>";
print textfield('name');
print checkbox('Not my real name');
print "<p><em>Where can you find English Sparrows?</em><br>";
print checkbox_group(
-name=>'Sparrow locations',
-values=>[England,France,Spain,Asia,Hoboken],
-linebreak=>'yes',
-defaults=>[England,Asia]);
print "<p><em>How far can they fly?</em><br>",
radio_group(
-name=>'how far',
-values=>['10 ft','1 mile','10 miles','real far'],
-default=>'1 mile');
print "<p><em>What's your favorite color?</em> ";
print popup_menu(-name=>'Color',
-values=>['black','brown','red','yellow'],
-default=>'red');
print hidden('Reference','Monty Python and the Holy Grail');
print "<p><em>What have you got there?</em><br>";
print scrolling_list(
-name=>'possessions',
-values=>['A Coconut','A Grail','An Icon',
'A Sword','A Ticket'],
-size=>5,
-multiple=>'true');
print "<p><em>Any parting comments?</em><br>";
print textarea(-name=>'Comments',
-rows=>10,
-columns=>50);
print "<p>",reset;
print submit('Action','Shout');
print submit('Action','Scream');
print end_form;
print "<hr>\n";
}
sub do_work {
print "<h2>Here are the current settings in this form</h2>";
for my $key (param) {
print "<strong>$key</strong> -> ";
my @values = param($key);
print join(", ",@values),"<br>\n";
}
}
sub print_tail {
print <<END;
<hr>
<address>Lincoln D. Stein</address><br>
<a href="/">Home Page</a>
END
}
=head1 BUGS
Please report them.
=head1 SEE ALSO
L<CGI::Carp> - provides a L<Carp> implementation tailored to the CGI environment.
L<CGI::Fast> - supports running CGI applications under FastCGI
L<CGI::Pretty> - pretty prints HTML generated by CGI.pm (with a performance penalty)
=cut