lib/CGI.pm

   1 package CGI;
   2 require 5.004;
   3 use Carp 'croak';
   4
   5 # See the bottom of this file for the POD documentation.  Search for the
   6 # string '=head'.
   7
   8 # You can run this file through either pod2man or pod2html to produce pretty
   9 # documentation in manual or html file format (these utilities are part of the
  10 # Perl 5 distribution).
  11
  12 # Copyright 1995-1998 Lincoln D. Stein.  All rights reserved.
  13 # It may be used and modified freely, but I do request that this copyright
  14 # notice remain attached to the file.  You may modify this module as you
  15 # wish, but if you redistribute a modified version, please attach a note
  16 # listing the modifications you have made.
  17
  18 # The most recent version and complete docs are available at:
  19 #   http://stein.cshl.org/WWW/software/CGI/
  20
  21 $CGI::revision = '$Id: CGI.pm,v 1.247 2008/03/14 14:29:36 lstein Exp $';
  22 $CGI::VERSION='3.34_01';
  23
  24 # HARD-CODED LOCATION FOR FILE UPLOAD TEMPORARY FILES.
  25 # UNCOMMENT THIS ONLY IF YOU KNOW WHAT YOU'RE DOING.
  26 # $CGITempFile::TMPDIRECTORY = '/usr/tmp';
  27 use CGI::Util qw(rearrange make_attributes unescape escape expires ebcdic2ascii ascii2ebcdic);
  28
  29 #use constant XHTML_DTD => ['-//W3C//DTD XHTML Basic 1.0//EN',
  30 #                           'http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd'];
  31
  32 use constant XHTML_DTD => ['-//W3C//DTD XHTML 1.0 Transitional//EN',
  33                            'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'];
  34
  35 {
  36   local $^W = 0;
  37   $TAINTED = substr("$0$^X",0,0);
  38 }
  39
  40 $MOD_PERL = 0; # no mod_perl by default
  41 @SAVED_SYMBOLS = ();
  42
  43
  44 # >>>>> Here are some globals that you might want to adjust <<<<<<
  45 sub initialize_globals {
  46     # Set this to 1 to enable copious autoloader debugging messages
  47     $AUTOLOAD_DEBUG = 0;
  48
  49     # Set this to 1 to generate XTML-compatible output
  50     $XHTML = 1;
  51
  52     # Change this to the preferred DTD to print in start_html()
  53     # or use default_dtd('text of DTD to use');
  54     $DEFAULT_DTD = [ '-//W3C//DTD HTML 4.01 Transitional//EN',
  55                      'http://www.w3.org/TR/html4/loose.dtd' ] ;
  56
  57     # Set this to 1 to enable NOSTICKY scripts
  58     # or:
  59     #    1) use CGI qw(-nosticky)
  60     #    2) $CGI::nosticky(1)
  61     $NOSTICKY = 0;
  62
  63     # Set this to 1 to enable NPH scripts
  64     # or:
  65     #    1) use CGI qw(-nph)
  66     #    2) CGI::nph(1)
  67     #    3) print header(-nph=>1)
  68     $NPH = 0;
  69
  70     # Set this to 1 to enable debugging from @ARGV
  71     # Set to 2 to enable debugging from STDIN
  72     $DEBUG = 1;
  73
  74     # Set this to 1 to make the temporary files created
  75     # during file uploads safe from prying eyes
  76     # or do...
  77     #    1) use CGI qw(:private_tempfiles)
  78     #    2) CGI::private_tempfiles(1);
  79     $PRIVATE_TEMPFILES = 0;
  80
  81     # Set this to 1 to generate automatic tab indexes
  82     $TABINDEX = 0;
  83
  84     # Set this to 1 to cause files uploaded in multipart documents
  85     # to be closed, instead of caching the file handle
  86     # or:
  87     #    1) use CGI qw(:close_upload_files)
  88     #    2) $CGI::close_upload_files(1);
  89     # Uploads with many files run out of file handles.
  90     # Also, for performance, since the file is already on disk,
  91     # it can just be renamed, instead of read and written.
  92     $CLOSE_UPLOAD_FILES = 0;
  93
  94     # Set this to a positive value to limit the size of a POSTing
  95     # to a certain number of bytes:
  96     $POST_MAX = -1;
  97
  98     # Change this to 1 to disable uploads entirely:
  99     $DISABLE_UPLOADS = 0;
 100
 101     # Automatically determined -- don't change
 102     $EBCDIC = 0;
 103
 104     # Change this to 1 to suppress redundant HTTP headers
 105     $HEADERS_ONCE = 0;
 106
 107     # separate the name=value pairs by semicolons rather than ampersands
 108     $USE_PARAM_SEMICOLONS = 1;
 109
 110     # Do not include undefined params parsed from query string
 111     # use CGI qw(-no_undef_params);
 112     $NO_UNDEF_PARAMS = 0;
 113
 114     # return everything as utf-8
 115     $PARAM_UTF8      = 0;
 116
 117     # Other globals that you shouldn't worry about.
 118     undef $Q;
 119     $BEEN_THERE = 0;
 120     $DTD_PUBLIC_IDENTIFIER = "";
 121     undef @QUERY_PARAM;
 122     undef %EXPORT;
 123     undef $QUERY_CHARSET;
 124     undef %QUERY_FIELDNAMES;
 125     undef %QUERY_TMPFILES;
 126
 127     # prevent complaints by mod_perl
 128     1;
 129 }
 130
 131 # ------------------ START OF THE LIBRARY ------------
 132
 133 *end_form = \&endform;
 134
 135 # make mod_perlhappy
 136 initialize_globals();
 137
 138 # FIGURE OUT THE OS WE'RE RUNNING UNDER
 139 # Some systems support the $^O variable.  If not
 140 # available then require() the Config library
 141 unless ($OS) {
 142     unless ($OS = $^O) {
 143         require Config;
 144         $OS = $Config::Config{'osname'};
 145     }
 146 }
 147 if ($OS =~ /^MSWin/i) {
 148   $OS = 'WINDOWS';
 149 } elsif ($OS =~ /^VMS/i) {
 150   $OS = 'VMS';
 151 } elsif ($OS =~ /^dos/i) {
 152   $OS = 'DOS';
 153 } elsif ($OS =~ /^MacOS/i) {
 154     $OS = 'MACINTOSH';
 155 } elsif ($OS =~ /^os2/i) {
 156     $OS = 'OS2';
 157 } elsif ($OS =~ /^epoc/i) {
 158     $OS = 'EPOC';
 159 } elsif ($OS =~ /^cygwin/i) {
 160     $OS = 'CYGWIN';
 161 } else {
 162     $OS = 'UNIX';
 163 }
 164
 165 # Some OS logic.  Binary mode enabled on DOS, NT and VMS
 166 $needs_binmode = $OS=~/^(WINDOWS|DOS|OS2|MSWin|CYGWIN)/;
 167
 168 # This is the default class for the CGI object to use when all else fails.
 169 $DefaultClass = 'CGI' unless defined $CGI::DefaultClass;
 170
 171 # This is where to look for autoloaded routines.
 172 $AutoloadClass = $DefaultClass unless defined $CGI::AutoloadClass;
 173
 174 # The path separator is a slash, backslash or semicolon, depending
 175 # on the paltform.
 176 $SL = {
 177      UNIX    => '/',  OS2 => '\\', EPOC      => '/', CYGWIN => '/',
 178      WINDOWS => '\\', DOS => '\\', MACINTOSH => ':', VMS    => '/'
 179     }->{$OS};
 180
 181 # This no longer seems to be necessary
 182 # Turn on NPH scripts by default when running under IIS server!
 183 # $NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
 184 $IIS++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
 185
 186 # Turn on special checking for Doug MacEachern's modperl
 187 if (exists $ENV{MOD_PERL}) {
 188   # mod_perl handlers may run system() on scripts using CGI.pm;
 189   # Make sure so we don't get fooled by inherited $ENV{MOD_PERL}
 190   if (exists $ENV{MOD_PERL_API_VERSION} && $ENV{MOD_PERL_API_VERSION} == 2) {
 191     $MOD_PERL = 2;
 192     require Apache2::Response;
 193     require Apache2::RequestRec;
 194     require Apache2::RequestUtil;
 195     require Apache2::RequestIO;
 196     require APR::Pool;
 197   } else {
 198     $MOD_PERL = 1;
 199     require Apache;
 200   }
 201 }
 202
 203 # Turn on special checking for ActiveState's PerlEx
 204 $PERLEX++ if defined($ENV{'GATEWAY_INTERFACE'}) && $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-PerlEx/;
 205
 206 # Define the CRLF sequence.  I can't use a simple "\r\n" because the meaning
 207 # of "\n" is different on different OS's (sometimes it generates CRLF, sometimes LF
 208 # and sometimes CR).  The most popular VMS web server
 209 # doesn't accept CRLF -- instead it wants a LR.  EBCDIC machines don't
 210 # use ASCII, so \015\012 means something different.  I find this all
 211 # really annoying.
 212 $EBCDIC = "\t" ne "\011";
 213 if ($OS eq 'VMS') {
 214   $CRLF = "\n";
 215 } elsif ($EBCDIC) {
 216   $CRLF= "\r\n";
 217 } else {
 218   $CRLF = "\015\012";
 219 }
 220
 221 if ($needs_binmode) {
 222     $CGI::DefaultClass->binmode(\*main::STDOUT);
 223     $CGI::DefaultClass->binmode(\*main::STDIN);
 224     $CGI::DefaultClass->binmode(\*main::STDERR);
 225 }
 226
 227 %EXPORT_TAGS = (
 228                 ':html2'=>['h1'..'h6',qw/p br hr ol ul li dl dt dd menu code var strong em
 229                            tt u i b blockquote pre img a address cite samp dfn html head
 230                            base body Link nextid title meta kbd start_html end_html
 231                            input Select option comment charset escapeHTML/],
 232                 ':html3'=>[qw/div table caption th td TR Tr sup Sub strike applet Param
 233                            embed basefont style span layer ilayer font frameset frame script small big Area Map/],
 234                 ':html4'=>[qw/abbr acronym bdo col colgroup del fieldset iframe
 235                             ins label legend noframes noscript object optgroup Q
 236                             thead tbody tfoot/],
 237                 ':netscape'=>[qw/blink fontsize center/],
 238                 ':form'=>[qw/textfield textarea filefield password_field hidden checkbox checkbox_group
 239                           submit reset defaults radio_group popup_menu button autoEscape
 240                           scrolling_list image_button start_form end_form startform endform
 241                           start_multipart_form end_multipart_form isindex tmpFileName uploadInfo URL_ENCODED MULTIPART/],
 242                 ':cgi'=>[qw/param upload path_info path_translated request_uri url self_url script_name
 243                          cookie Dump
 244                          raw_cookie request_method query_string Accept user_agent remote_host content_type
 245                          remote_addr referer server_name server_software server_port server_protocol virtual_port
 246                          virtual_host remote_ident auth_type http append
 247                          save_parameters restore_parameters param_fetch
 248                          remote_user user_name header redirect import_names put
 249                          Delete Delete_all url_param cgi_error/],
 250                 ':ssl' => [qw/https/],
 251                 ':cgi-lib' => [qw/ReadParse PrintHeader HtmlTop HtmlBot SplitParam Vars/],
 252                 ':html' => [qw/:html2 :html3 :html4 :netscape/],
 253                 ':standard' => [qw/:html2 :html3 :html4 :form :cgi/],
 254                 ':push' => [qw/multipart_init multipart_start multipart_end multipart_final/],
 255                 ':all' => [qw/:html2 :html3 :netscape :form :cgi :internal :html4/]
 256                 );
 257
 258 # Custom 'can' method for both autoloaded and non-autoloaded subroutines.
 259 # Author: Cees Hek <cees@sitesuite.com.au>
 260
 261 sub can {
 262         my($class, $method) = @_;
 263
 264         # See if UNIVERSAL::can finds it.
 265
 266         if (my $func = $class -> SUPER::can($method) ){
 267                 return $func;
 268         }
 269
 270         # Try to compile the function.
 271
 272         eval {
 273                 # _compile looks at $AUTOLOAD for the function name.
 274
 275                 local $AUTOLOAD = join "::", $class, $method;
 276                 &_compile;
 277         };
 278
 279         # Now that the function is loaded (if it exists)
 280         # just use UNIVERSAL::can again to do the work.
 281
 282         return $class -> SUPER::can($method);
 283 }
 284
 285 # to import symbols into caller
 286 sub import {
 287     my $self = shift;
 288
 289     # This causes modules to clash.
 290     undef %EXPORT_OK;
 291     undef %EXPORT;
 292
 293     $self->_setup_symbols(@_);
 294     my ($callpack, $callfile, $callline) = caller;
 295
 296     # To allow overriding, search through the packages
 297     # Till we find one in which the correct subroutine is defined.
 298     my @packages = ($self,@{"$self\:\:ISA"});
 299     foreach $sym (keys %EXPORT) {
 300         my $pck;
 301         my $def = ${"$self\:\:AutoloadClass"} || $DefaultClass;
 302         foreach $pck (@packages) {
 303             if (defined(&{"$pck\:\:$sym"})) {
 304                 $def = $pck;
 305                 last;
 306             }
 307         }
 308         *{"${callpack}::$sym"} = \&{"$def\:\:$sym"};
 309     }
 310 }
 311
 312 sub compile {
 313     my $pack = shift;
 314     $pack->_setup_symbols('-compile',@_);
 315 }
 316
 317 sub expand_tags {
 318     my($tag) = @_;
 319     return ("start_$1","end_$1") if $tag=~/^(?:\*|start_|end_)(.+)/;
 320     my(@r);
 321     return ($tag) unless $EXPORT_TAGS{$tag};
 322     foreach (@{$EXPORT_TAGS{$tag}}) {
 323         push(@r,&expand_tags($_));
 324     }
 325     return @r;
 326 }
 327
 328 #### Method: new
 329 # The new routine.  This will check the current environment
 330 # for an existing query string, and initialize itself, if so.
 331 ####
 332 sub new {
 333   my($class,@initializer) = @_;
 334   my $self = {};
 335
 336   bless $self,ref $class || $class || $DefaultClass;
 337
 338   # always use a tempfile
 339   $self->{'use_tempfile'} = 1;
 340
 341   if (ref($initializer[0])
 342       && (UNIVERSAL::isa($initializer[0],'Apache')
 343           ||
 344           UNIVERSAL::isa($initializer[0],'Apache2::RequestRec')
 345          )) {
 346     $self->r(shift @initializer);
 347   }
 348  if (ref($initializer[0])
 349      && (UNIVERSAL::isa($initializer[0],'CODE'))) {
 350     $self->upload_hook(shift @initializer, shift @initializer);
 351     $self->{'use_tempfile'} = shift @initializer if (@initializer > 0);
 352   }
 353   if ($MOD_PERL) {
 354     if ($MOD_PERL == 1) {
 355       $self->r(Apache->request) unless $self->r;
 356       my $r = $self->r;
 357       $r->register_cleanup(\&CGI::_reset_globals);
 358     }
 359     else {
 360       # XXX: once we have the new API
 361       # will do a real PerlOptions -SetupEnv check
 362       $self->r(Apache2::RequestUtil->request) unless $self->r;
 363       my $r = $self->r;
 364       $r->subprocess_env unless exists $ENV{REQUEST_METHOD};
 365       $r->pool->cleanup_register(\&CGI::_reset_globals);
 366     }
 367     undef $NPH;
 368   }
 369   $self->_reset_globals if $PERLEX;
 370   $self->init(@initializer);
 371   return $self;
 372 }
 373
 374 # We provide a DESTROY method so that we can ensure that
 375 # temporary files are closed (via Fh->DESTROY) before they
 376 # are unlinked (via CGITempFile->DESTROY) because it is not
 377 # possible to unlink an open file on Win32. We explicitly
 378 # call DESTROY on each, rather than just undefing them and
 379 # letting Perl DESTROY them by garbage collection, in case the
 380 # user is still holding any reference to them as well.
 381 sub DESTROY {
 382   my $self = shift;
 383   if ($OS eq 'WINDOWS') {
 384     foreach my $href (values %{$self->{'.tmpfiles'}}) {
 385       $href->{hndl}->DESTROY if defined $href->{hndl};
 386       $href->{name}->DESTROY if defined $href->{name};
 387     }
 388   }
 389 }
 390
 391 sub r {
 392   my $self = shift;
 393   my $r = $self->{'.r'};
 394   $self->{'.r'} = shift if @_;
 395   $r;
 396 }
 397
 398 sub upload_hook {
 399   my $self;
 400   if (ref $_[0] eq 'CODE') {
 401     $CGI::Q = $self = $CGI::DefaultClass->new(@_);
 402   } else {
 403     $self = shift;
 404   }
 405   my ($hook,$data,$use_tempfile) = @_;
 406   $self->{'.upload_hook'} = $hook;
 407   $self->{'.upload_data'} = $data;
 408   $self->{'use_tempfile'} = $use_tempfile if defined $use_tempfile;
 409 }
 410
 411 #### Method: param
 412 # Returns the value(s)of a named parameter.
 413 # If invoked in a list context, returns the
 414 # entire list.  Otherwise returns the first
 415 # member of the list.
 416 # If name is not provided, return a list of all
 417 # the known parameters names available.
 418 # If more than one argument is provided, the
 419 # second and subsequent arguments are used to
 420 # set the value of the parameter.
 421 ####
 422 sub param {
 423     my($self,@p) = self_or_default(@_);
 424     return $self->all_parameters unless @p;
 425     my($name,$value,@other);
 426
 427     # For compatibility between old calling style and use_named_parameters() style,
 428     # we have to special case for a single parameter present.
 429     if (@p > 1) {
 430         ($name,$value,@other) = rearrange([NAME,[DEFAULT,VALUE,VALUES]],@p);
 431         my(@values);
 432
 433         if (substr($p[0],0,1) eq '-') {
 434             @values = defined($value) ? (ref($value) && ref($value) eq 'ARRAY' ? @{$value} : $value) : ();
 435         } else {
 436             foreach ($value,@other) {
 437                 push(@values,$_) if defined($_);
 438             }
 439         }
 440         # If values is provided, then we set it.
 441         if (@values or defined $value) {
 442             $self->add_parameter($name);
 443             $self->{$name}=[@values];
 444         }
 445     } else {
 446         $name = $p[0];
 447     }
 448
 449     return unless defined($name) && $self->{$name};
 450
 451     my @result = @{$self->{$name}};
 452
 453     if ($PARAM_UTF8) {
 454       eval "require Encode; 1;" unless Encode->can('decode'); # bring in these functions
 455       @result = map {ref $_ ? $_ : Encode::decode(utf8=>$_) } @result;
 456     }
 457
 458     return wantarray ?  @result : $result[0];
 459 }
 460
 461 sub self_or_default {
 462     return @_ if defined($_[0]) && (!ref($_[0])) &&($_[0] eq 'CGI');
 463     unless (defined($_[0]) &&
 464             (ref($_[0]) eq 'CGI' || UNIVERSAL::isa($_[0],'CGI')) # slightly optimized for common case
 465             ) {
 466         $Q = $CGI::DefaultClass->new unless defined($Q);
 467         unshift(@_,$Q);
 468     }
 469     return wantarray ? @_ : $Q;
 470 }
 471
 472 sub self_or_CGI {
 473     local $^W=0;                # prevent a warning
 474     if (defined($_[0]) &&
 475         (substr(ref($_[0]),0,3) eq 'CGI'
 476          || UNIVERSAL::isa($_[0],'CGI'))) {
 477         return @_;
 478     } else {
 479         return ($DefaultClass,@_);
 480     }
 481 }
 482
 483 ########################################
 484 # THESE METHODS ARE MORE OR LESS PRIVATE
 485 # GO TO THE __DATA__ SECTION TO SEE MORE
 486 # PUBLIC METHODS
 487 ########################################
 488
 489 # Initialize the query object from the environment.
 490 # If a parameter list is found, this object will be set
 491 # to an associative array in which parameter names are keys
 492 # and the values are stored as lists
 493 # If a keyword list is found, this method creates a bogus
 494 # parameter list with the single parameter 'keywords'.
 495
 496 sub init {
 497   my $self = shift;
 498   my($query_string,$meth,$content_length,$fh,@lines) = ('','','','');
 499
 500   my $is_xforms;
 501
 502   my $initializer = shift;  # for backward compatibility
 503   local($/) = "\n";
 504
 505     # set autoescaping on by default
 506     $self->{'escape'} = 1;
 507
 508     # if we get called more than once, we want to initialize
 509     # ourselves from the original query (which may be gone
 510     # if it was read from STDIN originally.)
 511     if (defined(@QUERY_PARAM) && !defined($initializer)) {
 512         for my $name (@QUERY_PARAM) {
 513             my $val = $QUERY_PARAM{$name}; # always an arrayref;
 514             $self->param('-name'=>$name,'-value'=> $val);
 515             if (defined $val and ref $val eq 'ARRAY') {
 516                 for my $fh (grep {defined(fileno($_))} @$val) {
 517                    seek($fh,0,0); # reset the filehandle.
 518                 }
 519
 520             }
 521         }
 522         $self->charset($QUERY_CHARSET);
 523         $self->{'.fieldnames'} = {%QUERY_FIELDNAMES};
 524         $self->{'.tmpfiles'}   = {%QUERY_TMPFILES};
 525         return;
 526     }
 527
 528     $meth=$ENV{'REQUEST_METHOD'} if defined($ENV{'REQUEST_METHOD'});
 529     $content_length = defined($ENV{'CONTENT_LENGTH'}) ? $ENV{'CONTENT_LENGTH'} : 0;
 530
 531     $fh = to_filehandle($initializer) if $initializer;
 532
 533     # set charset to the safe ISO-8859-1
 534     $self->charset('ISO-8859-1');
 535
 536   METHOD: {
 537
 538       # avoid unreasonably large postings
 539       if (($POST_MAX > 0) && ($content_length > $POST_MAX)) {
 540         #discard the post, unread
 541         $self->cgi_error("413 Request entity too large");
 542         last METHOD;
 543       }
 544
 545       # Process multipart postings, but only if the initializer is
 546       # not defined.
 547       if ($meth eq 'POST'
 548           && defined($ENV{'CONTENT_TYPE'})
 549           && $ENV{'CONTENT_TYPE'}=~m|^multipart/form-data|
 550           && !defined($initializer)
 551           ) {
 552           my($boundary) = $ENV{'CONTENT_TYPE'} =~ /boundary=\"?([^\";,]+)\"?/;
 553           $self->read_multipart($boundary,$content_length);
 554           last METHOD;
 555       }
 556
 557       # Process XForms postings. We know that we have XForms in the
 558       # following cases:
 559       # method eq 'POST' && content-type eq 'application/xml'
 560       # method eq 'POST' && content-type =~ /multipart\/related.+start=/
 561       # There are more cases, actually, but for now, we don't support other
 562       # methods for XForm posts.
 563       # In a XForm POST, the QUERY_STRING is parsed normally.
 564       # If the content-type is 'application/xml', we just set the param
 565       # XForms:Model (referring to the xml syntax) param containing the
 566       # unparsed XML data.
 567       # In the case of multipart/related we set XForms:Model as above, but
 568       # the other parts are available as uploads with the Content-ID as the
 569       # the key.
 570       # See the URL below for XForms specs on this issue.
 571       # http://www.w3.org/TR/2006/REC-xforms-20060314/slice11.html#submit-options
 572       if ($meth eq 'POST' && defined($ENV{'CONTENT_TYPE'})) {
 573               if ($ENV{'CONTENT_TYPE'} eq 'application/xml') {
 574                       my($param) = 'XForms:Model';
 575                       my($value) = '';
 576                       $self->add_parameter($param);
 577                       $self->read_from_client(\$value,$content_length,0)
 578                         if $content_length > 0;
 579                       push (@{$self->{$param}},$value);
 580                       $is_xforms = 1;
 581               } elsif ($ENV{'CONTENT_TYPE'} =~ /multipart\/related.+boundary=\"?([^\";,]+)\"?.+start=\"?\<?([^\"\>]+)\>?\"?/) {
 582                       my($boundary,$start) = ($1,$2);
 583                       my($param) = 'XForms:Model';
 584                       $self->add_parameter($param);
 585                       my($value) = $self->read_multipart_related($start,$boundary,$content_length,0);
 586                       push (@{$self->{$param}},$value);
 587                       if ($MOD_PERL) {
 588                               $query_string = $self->r->args;
 589                       } else {
 590                               $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
 591                               $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'};
 592                       }
 593                       $is_xforms = 1;
 594               }
 595       }
 596
 597
 598       # If initializer is defined, then read parameters
 599       # from it.
 600       if (!$is_xforms && defined($initializer)) {
 601           if (UNIVERSAL::isa($initializer,'CGI')) {
 602               $query_string = $initializer->query_string;
 603               last METHOD;
 604           }
 605           if (ref($initializer) && ref($initializer) eq 'HASH') {
 606               foreach (keys %$initializer) {
 607                   $self->param('-name'=>$_,'-value'=>$initializer->{$_});
 608               }
 609               last METHOD;
 610           }
 611
 612           if (defined($fh) && ($fh ne '')) {
 613               while (<$fh>) {
 614                   chomp;
 615                   last if /^=/;
 616                   push(@lines,$_);
 617               }
 618               # massage back into standard format
 619               if ("@lines" =~ /=/) {
 620                   $query_string=join("&",@lines);
 621               } else {
 622                   $query_string=join("+",@lines);
 623               }
 624               last METHOD;
 625           }
 626
 627           # last chance -- treat it as a string
 628           $initializer = $$initializer if ref($initializer) eq 'SCALAR';
 629           $query_string = $initializer;
 630
 631           last METHOD;
 632       }
 633
 634       # If method is GET or HEAD, fetch the query from
 635       # the environment.
 636       if ($is_xforms || $meth=~/^(GET|HEAD)$/) {
 637           if ($MOD_PERL) {
 638             $query_string = $self->r->args;
 639           } else {
 640               $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
 641               $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'};
 642           }
 643           last METHOD;
 644       }
 645
 646       if ($meth eq 'POST' || $meth eq 'PUT') {
 647           $self->read_from_client(\$query_string,$content_length,0)
 648               if $content_length > 0;
 649           # Some people want to have their cake and eat it too!
 650           # Uncomment this line to have the contents of the query string
 651           # APPENDED to the POST data.
 652           # $query_string .= (length($query_string) ? '&' : '') . $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
 653           last METHOD;
 654       }
 655
 656       # If $meth is not of GET, POST or HEAD, assume we're being debugged offline.
 657       # Check the command line and then the standard input for data.
 658       # We use the shellwords package in order to behave the way that
 659       # UN*X programmers expect.
 660       if ($DEBUG)
 661       {
 662           my $cmdline_ret = read_from_cmdline();
 663           $query_string = $cmdline_ret->{'query_string'};
 664           if (defined($cmdline_ret->{'subpath'}))
 665           {
 666               $self->path_info($cmdline_ret->{'subpath'});
 667           }
 668       }
 669   }
 670
 671 # YL: Begin Change for XML handler 10/19/2001
 672     if (!$is_xforms && ($meth eq 'POST' || $meth eq 'PUT')
 673         && defined($ENV{'CONTENT_TYPE'})
 674         && $ENV{'CONTENT_TYPE'} !~ m|^application/x-www-form-urlencoded|
 675         && $ENV{'CONTENT_TYPE'} !~ m|^multipart/form-data| ) {
 676         my($param) = $meth . 'DATA' ;
 677         $self->add_parameter($param) ;
 678       push (@{$self->{$param}},$query_string);
 679       undef $query_string ;
 680     }
 681 # YL: End Change for XML handler 10/19/2001
 682
 683     # We now have the query string in hand.  We do slightly
 684     # different things for keyword lists and parameter lists.
 685     if (defined $query_string && length $query_string) {
 686         if ($query_string =~ /[&=;]/) {
 687             $self->parse_params($query_string);
 688         } else {
 689             $self->add_parameter('keywords');
 690             $self->{'keywords'} = [$self->parse_keywordlist($query_string)];
 691         }
 692     }
 693
 694     # Special case.  Erase everything if there is a field named
 695     # .defaults.
 696     if ($self->param('.defaults')) {
 697       $self->delete_all();
 698     }
 699
 700     # Associative array containing our defined fieldnames
 701     $self->{'.fieldnames'} = {};
 702     foreach ($self->param('.cgifields')) {
 703         $self->{'.fieldnames'}->{$_}++;
 704     }
 705
 706     # Clear out our default submission button flag if present
 707     $self->delete('.submit');
 708     $self->delete('.cgifields');
 709
 710     $self->save_request unless defined $initializer;
 711 }
 712
 713 # FUNCTIONS TO OVERRIDE:
 714 # Turn a string into a filehandle
 715 sub to_filehandle {
 716     my $thingy = shift;
 717     return undef unless $thingy;
 718     return $thingy if UNIVERSAL::isa($thingy,'GLOB');
 719     return $thingy if UNIVERSAL::isa($thingy,'FileHandle');
 720     if (!ref($thingy)) {
 721         my $caller = 1;
 722         while (my $package = caller($caller++)) {
 723             my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy";
 724             return $tmp if defined(fileno($tmp));
 725         }
 726     }
 727     return undef;
 728 }
 729
 730 # send output to the browser
 731 sub put {
 732     my($self,@p) = self_or_default(@_);
 733     $self->print(@p);
 734 }
 735
 736 # print to standard output (for overriding in mod_perl)
 737 sub print {
 738     shift;
 739     CORE::print(@_);
 740 }
 741
 742 # get/set last cgi_error
 743 sub cgi_error {
 744     my ($self,$err) = self_or_default(@_);
 745     $self->{'.cgi_error'} = $err if defined $err;
 746     return $self->{'.cgi_error'};
 747 }
 748
 749 sub save_request {
 750     my($self) = @_;
 751     # We're going to play with the package globals now so that if we get called
 752     # again, we initialize ourselves in exactly the same way.  This allows
 753     # us to have several of these objects.
 754     @QUERY_PARAM = $self->param; # save list of parameters
 755     foreach (@QUERY_PARAM) {
 756       next unless defined $_;
 757       $QUERY_PARAM{$_}=$self->{$_};
 758     }
 759     $QUERY_CHARSET = $self->charset;
 760     %QUERY_FIELDNAMES = %{$self->{'.fieldnames'}};
 761     %QUERY_TMPFILES   = %{ $self->{'.tmpfiles'} || {} };
 762 }
 763
 764 sub parse_params {
 765     my($self,$tosplit) = @_;
 766     my(@pairs) = split(/[&;]/,$tosplit);
 767     my($param,$value);
 768     foreach (@pairs) {
 769         ($param,$value) = split('=',$_,2);
 770         next unless defined $param;
 771         next if $NO_UNDEF_PARAMS and not defined $value;
 772         $value = '' unless defined $value;
 773         $param = unescape($param);
 774         $value = unescape($value);
 775         $self->add_parameter($param);
 776         push (@{$self->{$param}},$value);
 777     }
 778 }
 779
 780 sub add_parameter {
 781     my($self,$param)=@_;
 782     return unless defined $param;
 783     push (@{$self->{'.parameters'}},$param)
 784         unless defined($self->{$param});
 785 }
 786
 787 sub all_parameters {
 788     my $self = shift;
 789     return () unless defined($self) && $self->{'.parameters'};
 790     return () unless @{$self->{'.parameters'}};
 791     return @{$self->{'.parameters'}};
 792 }
 793
 794 # put a filehandle into binary mode (DOS)
 795 sub binmode {
 796     return unless defined($_[1]) && defined fileno($_[1]);
 797     CORE::binmode($_[1]);
 798 }
 799
 800 sub _make_tag_func {
 801     my ($self,$tagname) = @_;
 802     my $func = qq(
 803         sub $tagname {
 804          my (\$q,\$a,\@rest) = self_or_default(\@_);
 805          my(\$attr) = '';
 806          if (ref(\$a) && ref(\$a) eq 'HASH') {
 807             my(\@attr) = make_attributes(\$a,\$q->{'escape'});
 808             \$attr = " \@attr" if \@attr;
 809           } else {
 810             unshift \@rest,\$a if defined \$a;
 811           }
 812         );
 813     if ($tagname=~/start_(\w+)/i) {
 814         $func .= qq! return "<\L$1\E\$attr>";} !;
 815     } elsif ($tagname=~/end_(\w+)/i) {
 816         $func .= qq! return "<\L/$1\E>"; } !;
 817     } else {
 818         $func .= qq#
 819             return \$XHTML ? "\L<$tagname\E\$attr />" : "\L<$tagname\E\$attr>" unless \@rest;
 820             my(\$tag,\$untag) = ("\L<$tagname\E\$attr>","\L</$tagname>\E");
 821             my \@result = map { "\$tag\$_\$untag" }
 822                               (ref(\$rest[0]) eq 'ARRAY') ? \@{\$rest[0]} : "\@rest";
 823             return "\@result";
 824             }#;
 825     }
 826 return $func;
 827 }
 828
 829 sub AUTOLOAD {
 830     print STDERR "CGI::AUTOLOAD for $AUTOLOAD\n" if $CGI::AUTOLOAD_DEBUG;
 831     my $func = &_compile;
 832     goto &$func;
 833 }
 834
 835 sub _compile {
 836     my($func) = $AUTOLOAD;
 837     my($pack,$func_name);
 838     {
 839         local($1,$2); # this fixes an obscure variable suicide problem.
 840         $func=~/(.+)::([^:]+)$/;
 841         ($pack,$func_name) = ($1,$2);
 842         $pack=~s/::SUPER$//;    # fix another obscure problem
 843         $pack = ${"$pack\:\:AutoloadClass"} || $CGI::DefaultClass
 844             unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"});
 845
 846         my($sub) = \%{"$pack\:\:SUBS"};
 847         unless (%$sub) {
 848            my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"};
 849            local ($@,$!);
 850            eval "package $pack; $$auto";
 851            croak("$AUTOLOAD: $@") if $@;
 852            $$auto = '';  # Free the unneeded storage (but don't undef it!!!)
 853        }
 854        my($code) = $sub->{$func_name};
 855
 856        $code = "sub $AUTOLOAD { }" if (!$code and $func_name eq 'DESTROY');
 857        if (!$code) {
 858            (my $base = $func_name) =~ s/^(start_|end_)//i;
 859            if ($EXPORT{':any'} ||
 860                $EXPORT{'-any'} ||
 861                $EXPORT{$base} ||
 862                (%EXPORT_OK || grep(++$EXPORT_OK{$_},&expand_tags(':html')))
 863                    && $EXPORT_OK{$base}) {
 864                $code = $CGI::DefaultClass->_make_tag_func($func_name);
 865            }
 866        }
 867        croak("Undefined subroutine $AUTOLOAD\n") unless $code;
 868        local ($@,$!);
 869        eval "package $pack; $code";
 870        if ($@) {
 871            $@ =~ s/ at .*\n//;
 872            croak("$AUTOLOAD: $@");
 873        }
 874     }
 875     CORE::delete($sub->{$func_name});  #free storage
 876     return "$pack\:\:$func_name";
 877 }
 878
 879 sub _selected {
 880   my $self = shift;
 881   my $value = shift;
 882   return '' unless $value;
 883   return $XHTML ? qq(selected="selected" ) : qq(selected );
 884 }
 885
 886 sub _checked {
 887   my $self = shift;
 888   my $value = shift;
 889   return '' unless $value;
 890   return $XHTML ? qq(checked="checked" ) : qq(checked );
 891 }
 892
 893 sub _reset_globals { initialize_globals(); }
 894
 895 sub _setup_symbols {
 896     my $self = shift;
 897     my $compile = 0;
 898
 899     # to avoid reexporting unwanted variables
 900     undef %EXPORT;
 901
 902     foreach (@_) {
 903         $HEADERS_ONCE++,         next if /^[:-]unique_headers$/;
 904         $NPH++,                  next if /^[:-]nph$/;
 905         $NOSTICKY++,             next if /^[:-]nosticky$/;
 906         $DEBUG=0,                next if /^[:-]no_?[Dd]ebug$/;
 907         $DEBUG=2,                next if /^[:-][Dd]ebug$/;
 908         $USE_PARAM_SEMICOLONS++, next if /^[:-]newstyle_urls$/;
 909         $PARAM_UTF8++,           next if /^[:-]utf8$/;
 910         $XHTML++,                next if /^[:-]xhtml$/;
 911         $XHTML=0,                next if /^[:-]no_?xhtml$/;
 912         $USE_PARAM_SEMICOLONS=0, next if /^[:-]oldstyle_urls$/;
 913         $PRIVATE_TEMPFILES++,    next if /^[:-]private_tempfiles$/;
 914         $TABINDEX++,             next if /^[:-]tabindex$/;
 915         $CLOSE_UPLOAD_FILES++,   next if /^[:-]close_upload_files$/;
 916         $EXPORT{$_}++,           next if /^[:-]any$/;
 917         $compile++,              next if /^[:-]compile$/;
 918         $NO_UNDEF_PARAMS++,      next if /^[:-]no_undef_params$/;
 919
 920         # This is probably extremely evil code -- to be deleted some day.
 921         if (/^[-]autoload$/) {
 922             my($pkg) = caller(1);
 923             *{"${pkg}::AUTOLOAD"} = sub {
 924                 my($routine) = $AUTOLOAD;
 925                 $routine =~ s/^.*::/CGI::/;
 926                 &$routine;
 927             };
 928             next;
 929         }
 930
 931         foreach (&expand_tags($_)) {
 932             tr/a-zA-Z0-9_//cd;  # don't allow weird function names
 933             $EXPORT{$_}++;
 934         }
 935     }
 936     _compile_all(keys %EXPORT) if $compile;
 937     @SAVED_SYMBOLS = @_;
 938 }
 939
 940 sub charset {
 941   my ($self,$charset) = self_or_default(@_);
 942   $self->{'.charset'} = $charset if defined $charset;
 943   $self->{'.charset'};
 944 }
 945
 946 sub element_id {
 947   my ($self,$new_value) = self_or_default(@_);
 948   $self->{'.elid'} = $new_value if defined $new_value;
 949   sprintf('%010d',$self->{'.elid'}++);
 950 }
 951
 952 sub element_tab {
 953   my ($self,$new_value) = self_or_default(@_);
 954   $self->{'.etab'} ||= 1;
 955   $self->{'.etab'} = $new_value if defined $new_value;
 956   my $tab = $self->{'.etab'}++;
 957   return '' unless $TABINDEX or defined $new_value;
 958   return qq(tabindex="$tab" );
 959 }
 960
 961 ###############################################################################
 962 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
 963 ###############################################################################
 964 $AUTOLOADED_ROUTINES = '';      # get rid of -w warning
 965 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
 966
 967 %SUBS = (
 968
 969 'URL_ENCODED'=> <<'END_OF_FUNC',
 970 sub URL_ENCODED { 'application/x-www-form-urlencoded'; }
 971 END_OF_FUNC
 972
 973 'MULTIPART' => <<'END_OF_FUNC',
 974 sub MULTIPART {  'multipart/form-data'; }
 975 END_OF_FUNC
 976
 977 'SERVER_PUSH' => <<'END_OF_FUNC',
 978 sub SERVER_PUSH { 'multipart/x-mixed-replace;boundary="' . shift() . '"'; }
 979 END_OF_FUNC
 980
 981 'new_MultipartBuffer' => <<'END_OF_FUNC',
 982 # Create a new multipart buffer
 983 sub new_MultipartBuffer {
 984     my($self,$boundary,$length) = @_;
 985     return MultipartBuffer->new($self,$boundary,$length);
 986 }
 987 END_OF_FUNC
 988
 989 'read_from_client' => <<'END_OF_FUNC',
 990 # Read data from a file handle
 991 sub read_from_client {
 992     my($self, $buff, $len, $offset) = @_;
 993     local $^W=0;                # prevent a warning
 994     return $MOD_PERL
 995         ? $self->r->read($$buff, $len, $offset)
 996         : read(\*STDIN, $$buff, $len, $offset);
 997 }
 998 END_OF_FUNC
 999
1000 'delete' => <<'END_OF_FUNC',
1001 #### Method: delete
1002 # Deletes the named parameter entirely.
1003 ####
1004 sub delete {
1005     my($self,@p) = self_or_default(@_);
1006     my(@names) = rearrange([NAME],@p);
1007     my @to_delete = ref($names[0]) eq 'ARRAY' ? @$names[0] : @names;
1008     my %to_delete;
1009     foreach my $name (@to_delete)
1010     {
1011         CORE::delete $self->{$name};
1012         CORE::delete $self->{'.fieldnames'}->{$name};
1013         $to_delete{$name}++;
1014     }
1015     @{$self->{'.parameters'}}=grep { !exists($to_delete{$_}) } $self->param();
1016     return;
1017 }
1018 END_OF_FUNC
1019
1020 #### Method: import_names
1021 # Import all parameters into the given namespace.
1022 # Assumes namespace 'Q' if not specified
1023 ####
1024 'import_names' => <<'END_OF_FUNC',
1025 sub import_names {
1026     my($self,$namespace,$delete) = self_or_default(@_);
1027     $namespace = 'Q' unless defined($namespace);
1028     die "Can't import names into \"main\"\n" if \%{"${namespace}::"} == \%::;
1029     if ($delete || $MOD_PERL || exists $ENV{'FCGI_ROLE'}) {
1030         # can anyone find an easier way to do this?
1031         foreach (keys %{"${namespace}::"}) {
1032             local *symbol = "${namespace}::${_}";
1033             undef $symbol;
1034             undef @symbol;
1035             undef %symbol;
1036         }
1037     }
1038     my($param,@value,$var);
1039     foreach $param ($self->param) {
1040         # protect against silly names
1041         ($var = $param)=~tr/a-zA-Z0-9_/_/c;
1042         $var =~ s/^(?=\d)/_/;
1043         local *symbol = "${namespace}::$var";
1044         @value = $self->param($param);
1045         @symbol = @value;
1046         $symbol = $value[0];
1047     }
1048 }
1049 END_OF_FUNC
1050
1051 #### Method: keywords
1052 # Keywords acts a bit differently.  Calling it in a list context
1053 # returns the list of keywords.
1054 # Calling it in a scalar context gives you the size of the list.
1055 ####
1056 'keywords' => <<'END_OF_FUNC',
1057 sub keywords {
1058     my($self,@values) = self_or_default(@_);
1059     # If values is provided, then we set it.
1060     $self->{'keywords'}=[@values] if @values;
1061     my(@result) = defined($self->{'keywords'}) ? @{$self->{'keywords'}} : ();
1062     @result;
1063 }
1064 END_OF_FUNC
1065
1066 # These are some tie() interfaces for compatibility
1067 # with Steve Brenner's cgi-lib.pl routines
1068 'Vars' => <<'END_OF_FUNC',
1069 sub Vars {
1070     my $q = shift;
1071     my %in;
1072     tie(%in,CGI,$q);
1073     return %in if wantarray;
1074     return \%in;
1075 }
1076 END_OF_FUNC
1077
1078 # These are some tie() interfaces for compatibility
1079 # with Steve Brenner's cgi-lib.pl routines
1080 'ReadParse' => <<'END_OF_FUNC',
1081 sub ReadParse {
1082     local(*in);
1083     if (@_) {
1084         *in = $_[0];
1085     } else {
1086         my $pkg = caller();
1087         *in=*{"${pkg}::in"};
1088     }
1089     tie(%in,CGI);
1090     return scalar(keys %in);
1091 }
1092 END_OF_FUNC
1093
1094 'PrintHeader' => <<'END_OF_FUNC',
1095 sub PrintHeader {
1096     my($self) = self_or_default(@_);
1097     return $self->header();
1098 }
1099 END_OF_FUNC
1100
1101 'HtmlTop' => <<'END_OF_FUNC',
1102 sub HtmlTop {
1103     my($self,@p) = self_or_default(@_);
1104     return $self->start_html(@p);
1105 }
1106 END_OF_FUNC
1107
1108 'HtmlBot' => <<'END_OF_FUNC',
1109 sub HtmlBot {
1110     my($self,@p) = self_or_default(@_);
1111     return $self->end_html(@p);
1112 }
1113 END_OF_FUNC
1114
1115 'SplitParam' => <<'END_OF_FUNC',
1116 sub SplitParam {
1117     my ($param) = @_;
1118     my (@params) = split ("\0", $param);
1119     return (wantarray ? @params : $params[0]);
1120 }
1121 END_OF_FUNC
1122
1123 'MethGet' => <<'END_OF_FUNC',
1124 sub MethGet {
1125     return request_method() eq 'GET';
1126 }
1127 END_OF_FUNC
1128
1129 'MethPost' => <<'END_OF_FUNC',
1130 sub MethPost {
1131     return request_method() eq 'POST';
1132 }
1133 END_OF_FUNC
1134
1135 'TIEHASH' => <<'END_OF_FUNC',
1136 sub TIEHASH {
1137     my $class = shift;
1138     my $arg   = $_[0];
1139     if (ref($arg) && UNIVERSAL::isa($arg,'CGI')) {
1140        return $arg;
1141     }
1142     return $Q ||= $class->new(@_);
1143 }
1144 END_OF_FUNC
1145
1146 'STORE' => <<'END_OF_FUNC',
1147 sub STORE {
1148     my $self = shift;
1149     my $tag  = shift;
1150     my $vals = shift;
1151     my @vals = index($vals,"\0")!=-1 ? split("\0",$vals) : $vals;
1152     $self->param(-name=>$tag,-value=>\@vals);
1153 }
1154 END_OF_FUNC
1155
1156 'FETCH' => <<'END_OF_FUNC',
1157 sub FETCH {
1158     return $_[0] if $_[1] eq 'CGI';
1159     return undef unless defined $_[0]->param($_[1]);
1160     return join("\0",$_[0]->param($_[1]));
1161 }
1162 END_OF_FUNC
1163
1164 'FIRSTKEY' => <<'END_OF_FUNC',
1165 sub FIRSTKEY {
1166     $_[0]->{'.iterator'}=0;
1167     $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
1168 }
1169 END_OF_FUNC
1170
1171 'NEXTKEY' => <<'END_OF_FUNC',
1172 sub NEXTKEY {
1173     $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
1174 }
1175 END_OF_FUNC
1176
1177 'EXISTS' => <<'END_OF_FUNC',
1178 sub EXISTS {
1179     exists $_[0]->{$_[1]};
1180 }
1181 END_OF_FUNC
1182
1183 'DELETE' => <<'END_OF_FUNC',
1184 sub DELETE {
1185     $_[0]->delete($_[1]);
1186 }
1187 END_OF_FUNC
1188
1189 'CLEAR' => <<'END_OF_FUNC',
1190 sub CLEAR {
1191     %{$_[0]}=();
1192 }
1193 ####
1194 END_OF_FUNC
1195
1196 ####
1197 # Append a new value to an existing query
1198 ####
1199 'append' => <<'EOF',
1200 sub append {
1201     my($self,@p) = self_or_default(@_);
1202     my($name,$value) = rearrange([NAME,[VALUE,VALUES]],@p);
1203     my(@values) = defined($value) ? (ref($value) ? @{$value} : $value) : ();
1204     if (@values) {
1205         $self->add_parameter($name);
1206         push(@{$self->{$name}},@values);
1207     }
1208     return $self->param($name);
1209 }
1210 EOF
1211
1212 #### Method: delete_all
1213 # Delete all parameters
1214 ####
1215 'delete_all' => <<'EOF',
1216 sub delete_all {
1217     my($self) = self_or_default(@_);
1218     my @param = $self->param();
1219     $self->delete(@param);
1220 }
1221 EOF
1222
1223 'Delete' => <<'EOF',
1224 sub Delete {
1225     my($self,@p) = self_or_default(@_);
1226     $self->delete(@p);
1227 }
1228 EOF
1229
1230 'Delete_all' => <<'EOF',
1231 sub Delete_all {
1232     my($self,@p) = self_or_default(@_);
1233     $self->delete_all(@p);
1234 }
1235 EOF
1236
1237 #### Method: autoescape
1238 # If you want to turn off the autoescaping features,
1239 # call this method with undef as the argument
1240 'autoEscape' => <<'END_OF_FUNC',
1241 sub autoEscape {
1242     my($self,$escape) = self_or_default(@_);
1243     my $d = $self->{'escape'};
1244     $self->{'escape'} = $escape;
1245     $d;
1246 }
1247 END_OF_FUNC
1248
1249
1250 #### Method: version
1251 # Return the current version
1252 ####
1253 'version' => <<'END_OF_FUNC',
1254 sub version {
1255     return $VERSION;
1256 }
1257 END_OF_FUNC
1258
1259 #### Method: url_param
1260 # Return a parameter in the QUERY_STRING, regardless of
1261 # whether this was a POST or a GET
1262 ####
1263 'url_param' => <<'END_OF_FUNC',
1264 sub url_param {
1265     my ($self,@p) = self_or_default(@_);
1266     my $name = shift(@p);
1267     return undef unless exists($ENV{QUERY_STRING});
1268     unless (exists($self->{'.url_param'})) {
1269         $self->{'.url_param'}={}; # empty hash
1270         if ($ENV{QUERY_STRING} =~ /=/) {
1271             my(@pairs) = split(/[&;]/,$ENV{QUERY_STRING});
1272             my($param,$value);
1273             foreach (@pairs) {
1274                 ($param,$value) = split('=',$_,2);
1275                 $param = unescape($param);
1276                 $value = unescape($value);
1277                 push(@{$self->{'.url_param'}->{$param}},$value);
1278             }
1279         } else {
1280             $self->{'.url_param'}->{'keywords'} = [$self->parse_keywordlist($ENV{QUERY_STRING})];
1281         }
1282     }
1283     return keys %{$self->{'.url_param'}} unless defined($name);
1284     return () unless $self->{'.url_param'}->{$name};
1285     return wantarray ? @{$self->{'.url_param'}->{$name}}
1286                      : $self->{'.url_param'}->{$name}->[0];
1287 }
1288 END_OF_FUNC
1289
1290 #### Method: Dump
1291 # Returns a string in which all the known parameter/value
1292 # pairs are represented as nested lists, mainly for the purposes
1293 # of debugging.
1294 ####
1295 'Dump' => <<'END_OF_FUNC',
1296 sub Dump {
1297     my($self) = self_or_default(@_);
1298     my($param,$value,@result);
1299     return '<ul></ul>' unless $self->param;
1300     push(@result,"<ul>");
1301     foreach $param ($self->param) {
1302         my($name)=$self->escapeHTML($param);
1303         push(@result,"<li><strong>$param</strong></li>");
1304         push(@result,"<ul>");
1305         foreach $value ($self->param($param)) {
1306             $value = $self->escapeHTML($value);
1307             $value =~ s/\n/<br \/>\n/g;
1308             push(@result,"<li>$value</li>");
1309         }
1310         push(@result,"</ul>");
1311     }
1312     push(@result,"</ul>");
1313     return join("\n",@result);
1314 }
1315 END_OF_FUNC
1316
1317 #### Method as_string
1318 #
1319 # synonym for "dump"
1320 ####
1321 'as_string' => <<'END_OF_FUNC',
1322 sub as_string {
1323     &Dump(@_);
1324 }
1325 END_OF_FUNC
1326
1327 #### Method: save
1328 # Write values out to a filehandle in such a way that they can
1329 # be reinitialized by the filehandle form of the new() method
1330 ####
1331 'save' => <<'END_OF_FUNC',
1332 sub save {
1333     my($self,$filehandle) = self_or_default(@_);
1334     $filehandle = to_filehandle($filehandle);
1335     my($param);
1336     local($,) = '';  # set print field separator back to a sane value
1337     local($\) = '';  # set output line separator to a sane value
1338     foreach $param ($self->param) {
1339         my($escaped_param) = escape($param);
1340         my($value);
1341         foreach $value ($self->param($param)) {
1342             print $filehandle "$escaped_param=",escape("$value"),"\n";
1343         }
1344     }
1345     foreach (keys %{$self->{'.fieldnames'}}) {
1346           print $filehandle ".cgifields=",escape("$_"),"\n";
1347     }
1348     print $filehandle "=\n";    # end of record
1349 }
1350 END_OF_FUNC
1351
1352
1353 #### Method: save_parameters
1354 # An alias for save() that is a better name for exportation.
1355 # Only intended to be used with the function (non-OO) interface.
1356 ####
1357 'save_parameters' => <<'END_OF_FUNC',
1358 sub save_parameters {
1359     my $fh = shift;
1360     return save(to_filehandle($fh));
1361 }
1362 END_OF_FUNC
1363
1364 #### Method: restore_parameters
1365 # A way to restore CGI parameters from an initializer.
1366 # Only intended to be used with the function (non-OO) interface.
1367 ####
1368 'restore_parameters' => <<'END_OF_FUNC',
1369 sub restore_parameters {
1370     $Q = $CGI::DefaultClass->new(@_);
1371 }
1372 END_OF_FUNC
1373
1374 #### Method: multipart_init
1375 # Return a Content-Type: style header for server-push
1376 # This has to be NPH on most web servers, and it is advisable to set $| = 1
1377 #
1378 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1379 # contribution, updated by Andrew Benham (adsb@bigfoot.com)
1380 ####
1381 'multipart_init' => <<'END_OF_FUNC',
1382 sub multipart_init {
1383     my($self,@p) = self_or_default(@_);
1384     my($boundary,@other) = rearrange([BOUNDARY],@p);
1385     $boundary = $boundary || '------- =_aaaaaaaaaa0';
1386     $self->{'separator'} = "$CRLF--$boundary$CRLF";
1387     $self->{'final_separator'} = "$CRLF--$boundary--$CRLF";
1388     $type = SERVER_PUSH($boundary);
1389     return $self->header(
1390         -nph => 0,
1391         -type => $type,
1392         (map { split "=", $_, 2 } @other),
1393     ) . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $self->multipart_end;
1394 }
1395 END_OF_FUNC
1396
1397
1398 #### Method: multipart_start
1399 # Return a Content-Type: style header for server-push, start of section
1400 #
1401 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1402 # contribution, updated by Andrew Benham (adsb@bigfoot.com)
1403 ####
1404 'multipart_start' => <<'END_OF_FUNC',
1405 sub multipart_start {
1406     my(@header);
1407     my($self,@p) = self_or_default(@_);
1408     my($type,@other) = rearrange([TYPE],@p);
1409     $type = $type || 'text/html';
1410     push(@header,"Content-Type: $type");
1411
1412     # rearrange() was designed for the HTML portion, so we
1413     # need to fix it up a little.
1414     foreach (@other) {
1415         # Don't use \s because of perl bug 21951
1416         next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/;
1417         ($_ = $header) =~ s/^(\w)(.*)/$1 . lc ($2) . ': '.$self->unescapeHTML($value)/e;
1418     }
1419     push(@header,@other);
1420     my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1421     return $header;
1422 }
1423 END_OF_FUNC
1424
1425
1426 #### Method: multipart_end
1427 # Return a MIME boundary separator for server-push, end of section
1428 #
1429 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1430 # contribution
1431 ####
1432 'multipart_end' => <<'END_OF_FUNC',
1433 sub multipart_end {
1434     my($self,@p) = self_or_default(@_);
1435     return $self->{'separator'};
1436 }
1437 END_OF_FUNC
1438
1439
1440 #### Method: multipart_final
1441 # Return a MIME boundary separator for server-push, end of all sections
1442 #
1443 # Contributed by Andrew Benham (adsb@bigfoot.com)
1444 ####
1445 'multipart_final' => <<'END_OF_FUNC',
1446 sub multipart_final {
1447     my($self,@p) = self_or_default(@_);
1448     return $self->{'final_separator'} . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $CRLF;
1449 }
1450 END_OF_FUNC
1451
1452
1453 #### Method: header
1454 # Return a Content-Type: style header
1455 #
1456 ####
1457 'header' => <<'END_OF_FUNC',
1458 sub header {
1459     my($self,@p) = self_or_default(@_);
1460     my(@header);
1461
1462     return "" if $self->{'.header_printed'}++ and $HEADERS_ONCE;
1463
1464     my($type,$status,$cookie,$target,$expires,$nph,$charset,$attachment,$p3p,@other) =
1465         rearrange([['TYPE','CONTENT_TYPE','CONTENT-TYPE'],
1466                             'STATUS',['COOKIE','COOKIES'],'TARGET',
1467                             'EXPIRES','NPH','CHARSET',
1468                             'ATTACHMENT','P3P'],@p);
1469
1470     $nph     ||= $NPH;
1471
1472     $type ||= 'text/html' unless defined($type);
1473
1474     if (defined $charset) {
1475       $self->charset($charset);
1476     } else {
1477       $charset = $self->charset if $type =~ /^text\//;
1478     }
1479    $charset ||= '';
1480
1481     # rearrange() was designed for the HTML portion, so we
1482     # need to fix it up a little.
1483     foreach (@other) {
1484         # Don't use \s because of perl bug 21951
1485         next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/;
1486         ($_ = $header) =~ s/^(\w)(.*)/"\u$1\L$2" . ': '.$self->unescapeHTML($value)/e;
1487     }
1488
1489     $type .= "; charset=$charset"
1490       if     $type ne ''
1491          and $type !~ /\bcharset\b/
1492          and defined $charset
1493          and $charset ne '';
1494
1495     # Maybe future compatibility.  Maybe not.
1496     my $protocol = $ENV{SERVER_PROTOCOL} || 'HTTP/1.0';
1497     push(@header,$protocol . ' ' . ($status || '200 OK')) if $nph;
1498     push(@header,"Server: " . &server_software()) if $nph;
1499
1500     push(@header,"Status: $status") if $status;
1501     push(@header,"Window-Target: $target") if $target;
1502     if ($p3p) {
1503        $p3p = join ' ',@$p3p if ref($p3p) eq 'ARRAY';
1504        push(@header,qq(P3P: policyref="/w3c/p3p.xml", CP="$p3p"));
1505     }
1506     # push all the cookies -- there may be several
1507     if ($cookie) {
1508         my(@cookie) = ref($cookie) && ref($cookie) eq 'ARRAY' ? @{$cookie} : $cookie;
1509         foreach (@cookie) {
1510             my $cs = UNIVERSAL::isa($_,'CGI::Cookie') ? $_->as_string : $_;
1511             push(@header,"Set-Cookie: $cs") if $cs ne '';
1512         }
1513     }
1514     # if the user indicates an expiration time, then we need
1515     # both an Expires and a Date header (so that the browser is
1516     # uses OUR clock)
1517     push(@header,"Expires: " . expires($expires,'http'))
1518         if $expires;
1519     push(@header,"Date: " . expires(0,'http')) if $expires || $cookie || $nph;
1520     push(@header,"Pragma: no-cache") if $self->cache();
1521     push(@header,"Content-Disposition: attachment; filename=\"$attachment\"") if $attachment;
1522     push(@header,map {ucfirst $_} @other);
1523     push(@header,"Content-Type: $type") if $type ne '';
1524     my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1525     if (($MOD_PERL >= 1) && !$nph) {
1526         $self->r->send_cgi_header($header);
1527         return '';
1528     }
1529     return $header;
1530 }
1531 END_OF_FUNC
1532
1533
1534 #### Method: cache
1535 # Control whether header() will produce the no-cache
1536 # Pragma directive.
1537 ####
1538 'cache' => <<'END_OF_FUNC',
1539 sub cache {
1540     my($self,$new_value) = self_or_default(@_);
1541     $new_value = '' unless $new_value;
1542     if ($new_value ne '') {
1543         $self->{'cache'} = $new_value;
1544     }
1545     return $self->{'cache'};
1546 }
1547 END_OF_FUNC
1548
1549
1550 #### Method: redirect
1551 # Return a Location: style header
1552 #
1553 ####
1554 'redirect' => <<'END_OF_FUNC',
1555 sub redirect {
1556     my($self,@p) = self_or_default(@_);
1557     my($url,$target,$status,$cookie,$nph,@other) =
1558          rearrange([[LOCATION,URI,URL],TARGET,STATUS,['COOKIE','COOKIES'],NPH],@p);
1559     $status = '302 Found' unless defined $status;
1560     $url ||= $self->self_url;
1561     my(@o);
1562     foreach (@other) { tr/\"//d; push(@o,split("=",$_,2)); }
1563     unshift(@o,
1564          '-Status'  => $status,
1565          '-Location'=> $url,
1566          '-nph'     => $nph);
1567     unshift(@o,'-Target'=>$target) if $target;
1568     unshift(@o,'-Type'=>'');
1569     my @unescaped;
1570     unshift(@unescaped,'-Cookie'=>$cookie) if $cookie;
1571     return $self->header((map {$self->unescapeHTML($_)} @o),@unescaped);
1572 }
1573 END_OF_FUNC
1574
1575
1576 #### Method: start_html
1577 # Canned HTML header
1578 #
1579 # Parameters:
1580 # $title -> (optional) The title for this HTML document (-title)
1581 # $author -> (optional) e-mail address of the author (-author)
1582 # $base -> (optional) if set to true, will enter the BASE address of this document
1583 #          for resolving relative references (-base)
1584 # $xbase -> (optional) alternative base at some remote location (-xbase)
1585 # $target -> (optional) target window to load all links into (-target)
1586 # $script -> (option) Javascript code (-script)
1587 # $no_script -> (option) Javascript <noscript> tag (-noscript)
1588 # $meta -> (optional) Meta information tags
1589 # $head -> (optional) any other elements you'd like to incorporate into the <head> tag
1590 #           (a scalar or array ref)
1591 # $style -> (optional) reference to an external style sheet
1592 # @other -> (optional) any other named parameters you'd like to incorporate into
1593 #           the <body> tag.
1594 ####
1595 'start_html' => <<'END_OF_FUNC',
1596 sub start_html {
1597     my($self,@p) = &self_or_default(@_);
1598     my($title,$author,$base,$xbase,$script,$noscript,
1599         $target,$meta,$head,$style,$dtd,$lang,$encoding,$declare_xml,@other) =
1600         rearrange([TITLE,AUTHOR,BASE,XBASE,SCRIPT,NOSCRIPT,TARGET,
1601                    META,HEAD,STYLE,DTD,LANG,ENCODING,DECLARE_XML],@p);
1602
1603     $self->element_id(0);
1604     $self->element_tab(0);
1605
1606     $encoding = lc($self->charset) unless defined $encoding;
1607
1608     # Need to sort out the DTD before it's okay to call escapeHTML().
1609     my(@result,$xml_dtd);
1610     if ($dtd) {
1611         if (defined(ref($dtd)) and (ref($dtd) eq 'ARRAY')) {
1612             $dtd = $DEFAULT_DTD unless $dtd->[0] =~ m|^-//|;
1613         } else {
1614             $dtd = $DEFAULT_DTD unless $dtd =~ m|^-//|;
1615         }
1616     } else {
1617         $dtd = $XHTML ? XHTML_DTD : $DEFAULT_DTD;
1618     }
1619
1620     $xml_dtd++ if ref($dtd) eq 'ARRAY' && $dtd->[0] =~ /\bXHTML\b/i;
1621     $xml_dtd++ if ref($dtd) eq '' && $dtd =~ /\bXHTML\b/i;
1622     push @result,qq(<?xml version="1.0" encoding="$encoding"?>) if $xml_dtd && $declare_xml;
1623
1624     if (ref($dtd) && ref($dtd) eq 'ARRAY') {
1625         push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd->[0]"\n\t "$dtd->[1]">));
1626         $DTD_PUBLIC_IDENTIFIER = $dtd->[0];
1627     } else {
1628         push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd">));
1629         $DTD_PUBLIC_IDENTIFIER = $dtd;
1630     }
1631
1632     # Now that we know whether we're using the HTML 3.2 DTD or not, it's okay to
1633     # call escapeHTML().  Strangely enough, the title needs to be escaped as
1634     # HTML while the author needs to be escaped as a URL.
1635     $title = $self->escapeHTML($title || 'Untitled Document');
1636     $author = $self->escape($author);
1637
1638     if ($DTD_PUBLIC_IDENTIFIER =~ /[^X]HTML (2\.0|3\.2)/i) {
1639         $lang = "" unless defined $lang;
1640         $XHTML = 0;
1641     }
1642     else {
1643         $lang = 'en-US' unless defined $lang;
1644     }
1645
1646     my $lang_bits = $lang ne '' ? qq( lang="$lang" xml:lang="$lang") : '';
1647     my $meta_bits = qq(<meta http-equiv="Content-Type" content="text/html; charset=$encoding" />)
1648                     if $XHTML && $encoding && !$declare_xml;
1649
1650     push(@result,$XHTML ? qq(<html xmlns="http://www.w3.org/1999/xhtml"$lang_bits>\n<head>\n<title>$title</title>)
1651                         : ($lang ? qq(<html lang="$lang">) : "<html>")
1652                           . "<head><title>$title</title>");
1653         if (defined $author) {
1654     push(@result,$XHTML ? "<link rev=\"made\" href=\"mailto:$author\" />"
1655                         : "<link rev=\"made\" href=\"mailto:$author\">");
1656         }
1657
1658     if ($base || $xbase || $target) {
1659         my $href = $xbase || $self->url('-path'=>1);
1660         my $t = $target ? qq/ target="$target"/ : '';
1661         push(@result,$XHTML ? qq(<base href="$href"$t />) : qq(<base href="$href"$t>));
1662     }
1663
1664     if ($meta && ref($meta) && (ref($meta) eq 'HASH')) {
1665         foreach (keys %$meta) { push(@result,$XHTML ? qq(<meta name="$_" content="$meta->{$_}" />)
1666                         : qq(<meta name="$_" content="$meta->{$_}">)); }
1667     }
1668
1669     push(@result,ref($head) ? @$head : $head) if $head;
1670
1671     # handle the infrequently-used -style and -script parameters
1672     push(@result,$self->_style($style))   if defined $style;
1673     push(@result,$self->_script($script)) if defined $script;
1674     push(@result,$meta_bits)              if defined $meta_bits;
1675
1676     # handle -noscript parameter
1677     push(@result,<<END) if $noscript;
1678 <noscript>
1679 $noscript
1680 </noscript>
1681 END
1682     ;
1683     my($other) = @other ? " @other" : '';
1684     push(@result,"</head>\n<body$other>\n");
1685     return join("\n",@result);
1686 }
1687 END_OF_FUNC
1688
1689 ### Method: _style
1690 # internal method for generating a CSS style section
1691 ####
1692 '_style' => <<'END_OF_FUNC',
1693 sub _style {
1694     my ($self,$style) = @_;
1695     my (@result);
1696
1697     my $type = 'text/css';
1698     my $rel  = 'stylesheet';
1699
1700
1701     my $cdata_start = $XHTML ? "\n<!--/* <![CDATA[ */" : "\n<!-- ";
1702     my $cdata_end   = $XHTML ? "\n/* ]]> */-->\n" : " -->\n";
1703
1704     my @s = ref($style) eq 'ARRAY' ? @$style : $style;
1705     my $other = '';
1706
1707     for my $s (@s) {
1708       if (ref($s)) {
1709        my($src,$code,$verbatim,$stype,$alternate,$foo,@other) =
1710            rearrange([qw(SRC CODE VERBATIM TYPE ALTERNATE FOO)],
1711                       ('-foo'=>'bar',
1712                        ref($s) eq 'ARRAY' ? @$s : %$s));
1713        my $type = defined $stype ? $stype : 'text/css';
1714        my $rel  = $alternate ? 'alternate stylesheet' : 'stylesheet';
1715        $other = "@other" if @other;
1716
1717        if (ref($src) eq "ARRAY") # Check to see if the $src variable is an array reference
1718        { # If it is, push a LINK tag for each one
1719            foreach $src (@$src)
1720          {
1721            push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>)
1722                              : qq(<link rel="$rel" type="$type" href="$src"$other>)) if $src;
1723          }
1724        }
1725        else
1726        { # Otherwise, push the single -src, if it exists.
1727          push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>)
1728                              : qq(<link rel="$rel" type="$type" href="$src"$other>)
1729               ) if $src;
1730         }
1731      if ($verbatim) {
1732            my @v = ref($verbatim) eq 'ARRAY' ? @$verbatim : $verbatim;
1733            push(@result, "<style type=\"text/css\">\n$_\n</style>") foreach @v;
1734       }
1735       my @c = ref($code) eq 'ARRAY' ? @$code : $code if $code;
1736       push(@result,style({'type'=>$type},"$cdata_start\n$_\n$cdata_end")) foreach @c;
1737
1738       } else {
1739            my $src = $s;
1740            push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>)
1741                                : qq(<link rel="$rel" type="$type" href="$src"$other>));
1742       }
1743     }
1744     @result;
1745 }
1746 END_OF_FUNC
1747
1748 '_script' => <<'END_OF_FUNC',
1749 sub _script {
1750     my ($self,$script) = @_;
1751     my (@result);
1752
1753     my (@scripts) = ref($script) eq 'ARRAY' ? @$script : ($script);
1754     foreach $script (@scripts) {
1755         my($src,$code,$language);
1756         if (ref($script)) { # script is a hash
1757             ($src,$code,$type) =
1758                 rearrange(['SRC','CODE',['LANGUAGE','TYPE']],
1759                                  '-foo'=>'bar', # a trick to allow the '-' to be omitted
1760                                  ref($script) eq 'ARRAY' ? @$script : %$script);
1761             $type ||= 'text/javascript';
1762             unless ($type =~ m!\w+/\w+!) {
1763                 $type =~ s/[\d.]+$//;
1764                 $type = "text/$type";
1765             }
1766         } else {
1767             ($src,$code,$type) = ('',$script, 'text/javascript');
1768         }
1769
1770     my $comment = '//';  # javascript by default
1771     $comment = '#' if $type=~/perl|tcl/i;
1772     $comment = "'" if $type=~/vbscript/i;
1773
1774     my ($cdata_start,$cdata_end);
1775     if ($XHTML) {
1776        $cdata_start    = "$comment<![CDATA[\n";
1777        $cdata_end     .= "\n$comment]]>";
1778     } else {
1779        $cdata_start  =  "\n<!-- Hide script\n";
1780        $cdata_end    = $comment;
1781        $cdata_end   .= " End script hiding -->\n";
1782    }
1783      my(@satts);
1784      push(@satts,'src'=>$src) if $src;
1785      push(@satts,'type'=>$type);
1786      $code = $cdata_start . $code . $cdata_end if defined $code;
1787      push(@result,$self->script({@satts},$code || ''));
1788     }
1789     @result;
1790 }
1791 END_OF_FUNC
1792
1793 #### Method: end_html
1794 # End an HTML document.
1795 # Trivial method for completeness.  Just returns "</body>"
1796 ####
1797 'end_html' => <<'END_OF_FUNC',
1798 sub end_html {
1799     return "\n</body>\n</html>";
1800 }
1801 END_OF_FUNC
1802
1803
1804 ################################
1805 # METHODS USED IN BUILDING FORMS
1806 ################################
1807
1808 #### Method: isindex
1809 # Just prints out the isindex tag.
1810 # Parameters:
1811 #  $action -> optional URL of script to run
1812 # Returns:
1813 #   A string containing a <isindex> tag
1814 'isindex' => <<'END_OF_FUNC',
1815 sub isindex {
1816     my($self,@p) = self_or_default(@_);
1817     my($action,@other) = rearrange([ACTION],@p);
1818     $action = qq/ action="$action"/ if $action;
1819     my($other) = @other ? " @other" : '';
1820     return $XHTML ? "<isindex$action$other />" : "<isindex$action$other>";
1821 }
1822 END_OF_FUNC
1823
1824
1825 #### Method: startform
1826 # Start a form
1827 # Parameters:
1828 #   $method -> optional submission method to use (GET or POST)
1829 #   $action -> optional URL of script to run
1830 #   $enctype ->encoding to use (URL_ENCODED or MULTIPART)
1831 'startform' => <<'END_OF_FUNC',
1832 sub startform {
1833     my($self,@p) = self_or_default(@_);
1834
1835     my($method,$action,$enctype,@other) =
1836         rearrange([METHOD,ACTION,ENCTYPE],@p);
1837
1838     $method  = $self->escapeHTML(lc($method || 'post'));
1839     $enctype = $self->escapeHTML($enctype || &URL_ENCODED);
1840     if (defined $action) {
1841        $action = $self->escapeHTML($action);
1842     }
1843     else {
1844        $action = $self->escapeHTML($self->request_uri || $self->self_url);
1845     }
1846     $action = qq(action="$action");
1847     my($other) = @other ? " @other" : '';
1848     $self->{'.parametersToAdd'}={};
1849     return qq/<form method="$method" $action enctype="$enctype"$other>\n/;
1850 }
1851 END_OF_FUNC
1852
1853
1854 #### Method: start_form
1855 # synonym for startform
1856 'start_form' => <<'END_OF_FUNC',
1857 sub start_form {
1858     $XHTML ? &start_multipart_form : &startform;
1859 }
1860 END_OF_FUNC
1861
1862 'end_multipart_form' => <<'END_OF_FUNC',
1863 sub end_multipart_form {
1864     &endform;
1865 }
1866 END_OF_FUNC
1867
1868 #### Method: start_multipart_form
1869 # synonym for startform
1870 'start_multipart_form' => <<'END_OF_FUNC',
1871 sub start_multipart_form {
1872     my($self,@p) = self_or_default(@_);
1873     if (defined($p[0]) && substr($p[0],0,1) eq '-') {
1874       return $self->startform(-enctype=>&MULTIPART,@p);
1875     } else {
1876         my($method,$action,@other) =
1877             rearrange([METHOD,ACTION],@p);
1878         return $self->startform($method,$action,&MULTIPART,@other);
1879     }
1880 }
1881 END_OF_FUNC
1882
1883
1884 #### Method: endform
1885 # End a form
1886 'endform' => <<'END_OF_FUNC',
1887 sub endform {
1888     my($self,@p) = self_or_default(@_);
1889     if ( $NOSTICKY ) {
1890     return wantarray ? ("</form>") : "\n</form>";
1891     } else {
1892       if (my @fields = $self->get_fields) {
1893          return wantarray ? ("<div>",@fields,"</div>","</form>")
1894                           : "<div>".(join '',@fields)."</div>\n</form>";
1895       } else {
1896          return "</form>";
1897       }
1898     }
1899 }
1900 END_OF_FUNC
1901
1902
1903 '_textfield' => <<'END_OF_FUNC',
1904 sub _textfield {
1905     my($self,$tag,@p) = self_or_default(@_);
1906     my($name,$default,$size,$maxlength,$override,$tabindex,@other) =
1907         rearrange([NAME,[DEFAULT,VALUE,VALUES],SIZE,MAXLENGTH,[OVERRIDE,FORCE],TABINDEX],@p);
1908
1909     my $current = $override ? $default :
1910         (defined($self->param($name)) ? $self->param($name) : $default);
1911
1912     $current = defined($current) ? $self->escapeHTML($current,1) : '';
1913     $name = defined($name) ? $self->escapeHTML($name) : '';
1914     my($s) = defined($size) ? qq/ size="$size"/ : '';
1915     my($m) = defined($maxlength) ? qq/ maxlength="$maxlength"/ : '';
1916     my($other) = @other ? " @other" : '';
1917     # this entered at cristy's request to fix problems with file upload fields
1918     # and WebTV -- not sure it won't break stuff
1919     my($value) = $current ne '' ? qq(value="$current") : '';
1920     $tabindex = $self->element_tab($tabindex);
1921     return $XHTML ? qq(<input type="$tag" name="$name" $tabindex$value$s$m$other />)
1922                   : qq(<input type="$tag" name="$name" $value$s$m$other>);
1923 }
1924 END_OF_FUNC
1925
1926 #### Method: textfield
1927 # Parameters:
1928 #   $name -> Name of the text field
1929 #   $default -> Optional default value of the field if not
1930 #                already defined.
1931 #   $size ->  Optional width of field in characaters.
1932 #   $maxlength -> Optional maximum number of characters.
1933 # Returns:
1934 #   A string containing a <input type="text"> field
1935 #
1936 'textfield' => <<'END_OF_FUNC',
1937 sub textfield {
1938     my($self,@p) = self_or_default(@_);
1939     $self->_textfield('text',@p);
1940 }
1941 END_OF_FUNC
1942
1943
1944 #### Method: filefield
1945 # Parameters:
1946 #   $name -> Name of the file upload field
1947 #   $size ->  Optional width of field in characaters.
1948 #   $maxlength -> Optional maximum number of characters.
1949 # Returns:
1950 #   A string containing a <input type="file"> field
1951 #
1952 'filefield' => <<'END_OF_FUNC',
1953 sub filefield {
1954     my($self,@p) = self_or_default(@_);
1955     $self->_textfield('file',@p);
1956 }
1957 END_OF_FUNC
1958
1959
1960 #### Method: password
1961 # Create a "secret password" entry field
1962 # Parameters:
1963 #   $name -> Name of the field
1964 #   $default -> Optional default value of the field if not
1965 #                already defined.
1966 #   $size ->  Optional width of field in characters.
1967 #   $maxlength -> Optional maximum characters that can be entered.
1968 # Returns:
1969 #   A string containing a <input type="password"> field
1970 #
1971 'password_field' => <<'END_OF_FUNC',
1972 sub password_field {
1973     my ($self,@p) = self_or_default(@_);
1974     $self->_textfield('password',@p);
1975 }
1976 END_OF_FUNC
1977
1978 #### Method: textarea
1979 # Parameters:
1980 #   $name -> Name of the text field
1981 #   $default -> Optional default value of the field if not
1982 #                already defined.
1983 #   $rows ->  Optional number of rows in text area
1984 #   $columns -> Optional number of columns in text area
1985 # Returns:
1986 #   A string containing a <textarea></textarea> tag
1987 #
1988 'textarea' => <<'END_OF_FUNC',
1989 sub textarea {
1990     my($self,@p) = self_or_default(@_);
1991     my($name,$default,$rows,$cols,$override,$tabindex,@other) =
1992         rearrange([NAME,[DEFAULT,VALUE],ROWS,[COLS,COLUMNS],[OVERRIDE,FORCE],TABINDEX],@p);
1993
1994     my($current)= $override ? $default :
1995         (defined($self->param($name)) ? $self->param($name) : $default);
1996
1997     $name = defined($name) ? $self->escapeHTML($name) : '';
1998     $current = defined($current) ? $self->escapeHTML($current) : '';
1999     my($r) = $rows ? qq/ rows="$rows"/ : '';
2000     my($c) = $cols ? qq/ cols="$cols"/ : '';
2001     my($other) = @other ? " @other" : '';
2002     $tabindex = $self->element_tab($tabindex);
2003     return qq{<textarea name="$name" $tabindex$r$c$other>$current</textarea>};
2004 }
2005 END_OF_FUNC
2006
2007
2008 #### Method: button
2009 # Create a javascript button.
2010 # Parameters:
2011 #   $name ->  (optional) Name for the button. (-name)
2012 #   $value -> (optional) Value of the button when selected (and visible name) (-value)
2013 #   $onclick -> (optional) Text of the JavaScript to run when the button is
2014 #                clicked.
2015 # Returns:
2016 #   A string containing a <input type="button"> tag
2017 ####
2018 'button' => <<'END_OF_FUNC',
2019 sub button {
2020     my($self,@p) = self_or_default(@_);
2021
2022     my($label,$value,$script,$tabindex,@other) = rearrange([NAME,[VALUE,LABEL],
2023                                                             [ONCLICK,SCRIPT],TABINDEX],@p);
2024
2025     $label=$self->escapeHTML($label);
2026     $value=$self->escapeHTML($value,1);
2027     $script=$self->escapeHTML($script);
2028
2029     my($name) = '';
2030     $name = qq/ name="$label"/ if $label;
2031     $value = $value || $label;
2032     my($val) = '';
2033     $val = qq/ value="$value"/ if $value;
2034     $script = qq/ onclick="$script"/ if $script;
2035     my($other) = @other ? " @other" : '';
2036     $tabindex = $self->element_tab($tabindex);
2037     return $XHTML ? qq(<input type="button" $tabindex$name$val$script$other />)
2038                   : qq(<input type="button"$name$val$script$other>);
2039 }
2040 END_OF_FUNC
2041
2042
2043 #### Method: submit
2044 # Create a "submit query" button.
2045 # Parameters:
2046 #   $name ->  (optional) Name for the button.
2047 #   $value -> (optional) Value of the button when selected (also doubles as label).
2048 #   $label -> (optional) Label printed on the button(also doubles as the value).
2049 # Returns:
2050 #   A string containing a <input type="submit"> tag
2051 ####
2052 'submit' => <<'END_OF_FUNC',
2053 sub submit {
2054     my($self,@p) = self_or_default(@_);
2055
2056     my($label,$value,$tabindex,@other) = rearrange([NAME,[VALUE,LABEL],TABINDEX],@p);
2057
2058     $label=$self->escapeHTML($label);
2059     $value=$self->escapeHTML($value,1);
2060
2061     my $name = $NOSTICKY ? '' : 'name=".submit" ';
2062     $name = qq/name="$label" / if defined($label);
2063     $value = defined($value) ? $value : $label;
2064     my $val = '';
2065     $val = qq/value="$value" / if defined($value);
2066     $tabindex = $self->element_tab($tabindex);
2067     my($other) = @other ? "@other " : '';
2068     return $XHTML ? qq(<input type="submit" $tabindex$name$val$other/>)
2069                   : qq(<input type="submit" $name$val$other>);
2070 }
2071 END_OF_FUNC
2072
2073
2074 #### Method: reset
2075 # Create a "reset" button.
2076 # Parameters:
2077 #   $name -> (optional) Name for the button.
2078 # Returns:
2079 #   A string containing a <input type="reset"> tag
2080 ####
2081 'reset' => <<'END_OF_FUNC',
2082 sub reset {
2083     my($self,@p) = self_or_default(@_);
2084     my($label,$value,$tabindex,@other) = rearrange(['NAME',['VALUE','LABEL'],TABINDEX],@p);
2085     $label=$self->escapeHTML($label);
2086     $value=$self->escapeHTML($value,1);
2087     my ($name) = ' name=".reset"';
2088     $name = qq/ name="$label"/ if defined($label);
2089     $value = defined($value) ? $value : $label;
2090     my($val) = '';
2091     $val = qq/ value="$value"/ if defined($value);
2092     my($other) = @other ? " @other" : '';
2093     $tabindex = $self->element_tab($tabindex);
2094     return $XHTML ? qq(<input type="reset" $tabindex$name$val$other />)
2095                   : qq(<input type="reset"$name$val$other>);
2096 }
2097 END_OF_FUNC
2098
2099
2100 #### Method: defaults
2101 # Create a "defaults" button.
2102 # Parameters:
2103 #   $name -> (optional) Name for the button.
2104 # Returns:
2105 #   A string containing a <input type="submit" name=".defaults"> tag
2106 #
2107 # Note: this button has a special meaning to the initialization script,
2108 # and tells it to ERASE the current query string so that your defaults
2109 # are used again!
2110 ####
2111 'defaults' => <<'END_OF_FUNC',
2112 sub defaults {
2113     my($self,@p) = self_or_default(@_);
2114
2115     my($label,$tabindex,@other) = rearrange([[NAME,VALUE],TABINDEX],@p);
2116
2117     $label=$self->escapeHTML($label,1);
2118     $label = $label || "Defaults";
2119     my($value) = qq/ value="$label"/;
2120     my($other) = @other ? " @other" : '';
2121     $tabindex = $self->element_tab($tabindex);
2122     return $XHTML ? qq(<input type="submit" name=".defaults" $tabindex$value$other />)
2123                   : qq/<input type="submit" NAME=".defaults"$value$other>/;
2124 }
2125 END_OF_FUNC
2126
2127
2128 #### Method: comment
2129 # Create an HTML <!-- comment -->
2130 # Parameters: a string
2131 'comment' => <<'END_OF_FUNC',
2132 sub comment {
2133     my($self,@p) = self_or_CGI(@_);
2134     return "<!-- @p -->";
2135 }
2136 END_OF_FUNC
2137
2138 #### Method: checkbox
2139 # Create a checkbox that is not logically linked to any others.
2140 # The field value is "on" when the button is checked.
2141 # Parameters:
2142 #   $name -> Name of the checkbox
2143 #   $checked -> (optional) turned on by default if true
2144 #   $value -> (optional) value of the checkbox, 'on' by default
2145 #   $label -> (optional) a user-readable label printed next to the box.
2146 #             Otherwise the checkbox name is used.
2147 # Returns:
2148 #   A string containing a <input type="checkbox"> field
2149 ####
2150 'checkbox' => <<'END_OF_FUNC',
2151 sub checkbox {
2152     my($self,@p) = self_or_default(@_);
2153
2154     my($name,$checked,$value,$label,$labelattributes,$override,$tabindex,@other) =
2155        rearrange([NAME,[CHECKED,SELECTED,ON],VALUE,LABEL,LABELATTRIBUTES,
2156                    [OVERRIDE,FORCE],TABINDEX],@p);
2157
2158     $value = defined $value ? $value : 'on';
2159
2160     if (!$override && ($self->{'.fieldnames'}->{$name} ||
2161                        defined $self->param($name))) {
2162         $checked = grep($_ eq $value,$self->param($name)) ? $self->_checked(1) : '';
2163     } else {
2164         $checked = $self->_checked($checked);
2165     }
2166     my($the_label) = defined $label ? $label : $name;
2167     $name = $self->escapeHTML($name);
2168     $value = $self->escapeHTML($value,1);
2169     $the_label = $self->escapeHTML($the_label);
2170     my($other) = @other ? "@other " : '';
2171     $tabindex = $self->element_tab($tabindex);
2172     $self->register_parameter($name);
2173     return $XHTML ? CGI::label($labelattributes,
2174                     qq{<input type="checkbox" name="$name" value="$value" $tabindex$checked$other/>$the_label})
2175                   : qq{<input type="checkbox" name="$name" value="$value"$checked$other>$the_label};
2176 }
2177 END_OF_FUNC
2178
2179
2180
2181 # Escape HTML -- used internally
2182 'escapeHTML' => <<'END_OF_FUNC',
2183 sub escapeHTML {
2184          # hack to work around  earlier hacks
2185          push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
2186          my ($self,$toencode,$newlinestoo) = CGI::self_or_default(@_);
2187          return undef unless defined($toencode);
2188          return $toencode if ref($self) && !$self->{'escape'};
2189          $toencode =~ s{&}{&amp;}gso;
2190          $toencode =~ s{<}{&lt;}gso;
2191          $toencode =~ s{>}{&gt;}gso;
2192          if ($DTD_PUBLIC_IDENTIFIER =~ /[^X]HTML 3\.2/i) {
2193              # $quot; was accidentally omitted from the HTML 3.2 DTD -- see
2194              # <http://validator.w3.org/docs/errors.html#bad-entity> /
2195              # <http://lists.w3.org/Archives/Public/www-html/1997Mar/0003.html>.
2196              $toencode =~ s{"}{&#34;}gso;
2197          }
2198          else {
2199              $toencode =~ s{"}{&quot;}gso;
2200          }
2201          # Handle bug in some browsers with Latin charsets
2202          if ($self->{'.charset'} &&
2203              (uc($self->{'.charset'}) eq 'ISO-8859-1' ||
2204               uc($self->{'.charset'}) eq 'WINDOWS-1252'))
2205          {
2206                 $toencode =~ s{'}{&#39;}gso;
2207                 $toencode =~ s{\x8b}{&#8249;}gso;
2208                 $toencode =~ s{\x9b}{&#8250;}gso;
2209                 if (defined $newlinestoo && $newlinestoo) {
2210                      $toencode =~ s{\012}{&#10;}gso;
2211                      $toencode =~ s{\015}{&#13;}gso;
2212                 }
2213          }
2214          return $toencode;
2215 }
2216 END_OF_FUNC
2217
2218 # unescape HTML -- used internally
2219 'unescapeHTML' => <<'END_OF_FUNC',
2220 sub unescapeHTML {
2221     # hack to work around  earlier hacks
2222     push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
2223     my ($self,$string) = CGI::self_or_default(@_);
2224     return undef unless defined($string);
2225     my $latin = defined $self->{'.charset'} ? $self->{'.charset'} =~ /^(ISO-8859-1|WINDOWS-1252)$/i
2226                                             : 1;
2227     # thanks to Randal Schwartz for the correct solution to this one
2228     $string=~ s[&(.*?);]{
2229         local $_ = $1;
2230         /^amp$/i        ? "&" :
2231         /^quot$/i       ? '"' :
2232         /^gt$/i         ? ">" :
2233         /^lt$/i         ? "<" :
2234         /^#(\d+)$/ && $latin         ? chr($1) :
2235         /^#x([0-9a-f]+)$/i && $latin ? chr(hex($1)) :
2236         $_
2237         }gex;
2238     return $string;
2239 }
2240 END_OF_FUNC
2241
2242 # Internal procedure - don't use
2243 '_tableize' => <<'END_OF_FUNC',
2244 sub _tableize {
2245     my($rows,$columns,$rowheaders,$colheaders,@elements) = @_;
2246     my @rowheaders = $rowheaders ? @$rowheaders : ();
2247     my @colheaders = $colheaders ? @$colheaders : ();
2248     my($result);
2249
2250     if (defined($columns)) {
2251         $rows = int(0.99 + @elements/$columns) unless defined($rows);
2252     }
2253     if (defined($rows)) {
2254         $columns = int(0.99 + @elements/$rows) unless defined($columns);
2255     }
2256
2257     # rearrange into a pretty table
2258     $result = "<table>";
2259     my($row,$column);
2260     unshift(@colheaders,'') if @colheaders && @rowheaders;
2261     $result .= "<tr>" if @colheaders;
2262     foreach (@colheaders) {
2263         $result .= "<th>$_</th>";
2264     }
2265     for ($row=0;$row<$rows;$row++) {
2266         $result .= "<tr>";
2267         $result .= "<th>$rowheaders[$row]</th>" if @rowheaders;
2268         for ($column=0;$column<$columns;$column++) {
2269             $result .= "<td>" . $elements[$column*$rows + $row] . "</td>"
2270                 if defined($elements[$column*$rows + $row]);
2271         }
2272         $result .= "</tr>";
2273     }
2274     $result .= "</table>";
2275     return $result;
2276 }
2277 END_OF_FUNC
2278
2279
2280 #### Method: radio_group
2281 # Create a list of logically-linked radio buttons.
2282 # Parameters:
2283 #   $name -> Common name for all the buttons.
2284 #   $values -> A pointer to a regular array containing the
2285 #             values for each button in the group.
2286 #   $default -> (optional) Value of the button to turn on by default.  Pass '-'
2287 #               to turn _nothing_ on.
2288 #   $linebreak -> (optional) Set to true to place linebreaks
2289 #             between the buttons.
2290 #   $labels -> (optional)
2291 #             A pointer to an associative array of labels to print next to each checkbox
2292 #             in the form $label{'value'}="Long explanatory label".
2293 #             Otherwise the provided values are used as the labels.
2294 # Returns:
2295 #   An ARRAY containing a series of <input type="radio"> fields
2296 ####
2297 'radio_group' => <<'END_OF_FUNC',
2298 sub radio_group {
2299     my($self,@p) = self_or_default(@_);
2300    $self->_box_group('radio',@p);
2301 }
2302 END_OF_FUNC
2303
2304 #### Method: checkbox_group
2305 # Create a list of logically-linked checkboxes.
2306 # Parameters:
2307 #   $name -> Common name for all the check boxes
2308 #   $values -> A pointer to a regular array containing the
2309 #             values for each checkbox in the group.
2310 #   $defaults -> (optional)
2311 #             1. If a pointer to a regular array of checkbox values,
2312 #             then this will be used to decide which
2313 #             checkboxes to turn on by default.
2314 #             2. If a scalar, will be assumed to hold the
2315 #             value of a single checkbox in the group to turn on.
2316 #   $linebreak -> (optional) Set to true to place linebreaks
2317 #             between the buttons.
2318 #   $labels -> (optional)
2319 #             A pointer to an associative array of labels to print next to each checkbox
2320 #             in the form $label{'value'}="Long explanatory label".
2321 #             Otherwise the provided values are used as the labels.
2322 # Returns:
2323 #   An ARRAY containing a series of <input type="checkbox"> fields
2324 ####
2325
2326 'checkbox_group' => <<'END_OF_FUNC',
2327 sub checkbox_group {
2328     my($self,@p) = self_or_default(@_);
2329    $self->_box_group('checkbox',@p);
2330 }
2331 END_OF_FUNC
2332
2333 '_box_group' => <<'END_OF_FUNC',
2334 sub _box_group {
2335     my $self     = shift;
2336     my $box_type = shift;
2337
2338     my($name,$values,$defaults,$linebreak,$labels,$labelattributes,
2339        $attributes,$rows,$columns,$rowheaders,$colheaders,
2340        $override,$nolabels,$tabindex,$disabled,@other) =
2341         rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LINEBREAK,LABELS,LABELATTRIBUTES,
2342                        ATTRIBUTES,ROWS,[COLUMNS,COLS],[ROWHEADERS,ROWHEADER],[COLHEADERS,COLHEADER],
2343                        [OVERRIDE,FORCE],NOLABELS,TABINDEX,DISABLED
2344                   ],@_);
2345
2346
2347     my($result,$checked,@elements,@values);
2348
2349     @values = $self->_set_values_and_labels($values,\$labels,$name);
2350     my %checked = $self->previous_or_default($name,$defaults,$override);
2351
2352     # If no check array is specified, check the first by default
2353     $checked{$values[0]}++ if $box_type eq 'radio' && !%checked;
2354
2355     $name=$self->escapeHTML($name);
2356
2357     my %tabs = ();
2358     if ($TABINDEX && $tabindex) {
2359       if (!ref $tabindex) {
2360           $self->element_tab($tabindex);
2361       } elsif (ref $tabindex eq 'ARRAY') {
2362           %tabs = map {$_=>$self->element_tab} @$tabindex;
2363       } elsif (ref $tabindex eq 'HASH') {
2364           %tabs = %$tabindex;
2365       }
2366     }
2367     %tabs = map {$_=>$self->element_tab} @values unless %tabs;
2368     my $other = @other ? "@other " : '';
2369     my $radio_checked;
2370
2371     # for disabling groups of radio/checkbox buttons
2372     my %disabled;
2373     foreach (@{$disabled}) {
2374         $disabled{$_}=1;
2375     }
2376
2377     foreach (@values) {
2378          my $disable="";
2379          if ($disabled{$_}) {
2380                 $disable="disabled='1'";
2381          }
2382
2383         my $checkit = $self->_checked($box_type eq 'radio' ? ($checked{$_} && !$radio_checked++)
2384                                                            : $checked{$_});
2385         my($break);
2386         if ($linebreak) {
2387           $break = $XHTML ? "<br />" : "<br>";
2388         }
2389         else {
2390           $break = '';
2391         }
2392         my($label)='';
2393         unless (defined($nolabels) && $nolabels) {
2394             $label = $_;
2395             $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2396             $label = $self->escapeHTML($label,1);
2397             $label = "<span style=\"color:gray\">$label</span>" if $disabled{$_};
2398         }
2399         my $attribs = $self->_set_attributes($_, $attributes);
2400         my $tab     = $tabs{$_};
2401         $_=$self->escapeHTML($_);
2402
2403         if ($XHTML) {
2404            push @elements,
2405               CGI::label($labelattributes,
2406                    qq(<input type="$box_type" name="$name" value="$_" $checkit$other$tab$attribs$disable/>$label)).${break};
2407         } else {
2408             push(@elements,qq/<input type="$box_type" name="$name" value="$_"$checkit$other$tab$attribs$disable>${label}${break}/);
2409         }
2410     }
2411     $self->register_parameter($name);
2412     return wantarray ? @elements : "@elements"
2413            unless defined($columns) || defined($rows);
2414     return _tableize($rows,$columns,$rowheaders,$colheaders,@elements);
2415 }
2416 END_OF_FUNC
2417
2418
2419 #### Method: popup_menu
2420 # Create a popup menu.
2421 # Parameters:
2422 #   $name -> Name for all the menu
2423 #   $values -> A pointer to a regular array containing the
2424 #             text of each menu item.
2425 #   $default -> (optional) Default item to display
2426 #   $labels -> (optional)
2427 #             A pointer to an associative array of labels to print next to each checkbox
2428 #             in the form $label{'value'}="Long explanatory label".
2429 #             Otherwise the provided values are used as the labels.
2430 # Returns:
2431 #   A string containing the definition of a popup menu.
2432 ####
2433 'popup_menu' => <<'END_OF_FUNC',
2434 sub popup_menu {
2435     my($self,@p) = self_or_default(@_);
2436
2437     my($name,$values,$default,$labels,$attributes,$override,$tabindex,@other) =
2438        rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LABELS,
2439        ATTRIBUTES,[OVERRIDE,FORCE],TABINDEX],@p);
2440     my($result,$selected);
2441
2442     if (!$override && defined($self->param($name))) {
2443         $selected = $self->param($name);
2444     } else {
2445         $selected = $default;
2446     }
2447     $name=$self->escapeHTML($name);
2448     my($other) = @other ? " @other" : '';
2449
2450     my(@values);
2451     @values = $self->_set_values_and_labels($values,\$labels,$name);
2452     $tabindex = $self->element_tab($tabindex);
2453     $result = qq/<select name="$name" $tabindex$other>\n/;
2454     foreach (@values) {
2455         if (/<optgroup/) {
2456             foreach (split(/\n/)) {
2457                 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2458                 s/(value="$selected")/$selectit $1/ if defined $selected;
2459                 $result .= "$_\n";
2460             }
2461         }
2462         else {
2463           my $attribs = $self->_set_attributes($_, $attributes);
2464           my($selectit) = defined($selected) ? $self->_selected($selected eq $_) : '';
2465           my($label) = $_;
2466           $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2467           my($value) = $self->escapeHTML($_);
2468           $label=$self->escapeHTML($label,1);
2469           $result .= "<option${attribs} ${selectit}value=\"$value\">$label</option>\n";
2470         }
2471     }
2472
2473     $result .= "</select>";
2474     return $result;
2475 }
2476 END_OF_FUNC
2477
2478
2479 #### Method: optgroup
2480 # Create a optgroup.
2481 # Parameters:
2482 #   $name -> Label for the group
2483 #   $values -> A pointer to a regular array containing the
2484 #              values for each option line in the group.
2485 #   $labels -> (optional)
2486 #              A pointer to an associative array of labels to print next to each item
2487 #              in the form $label{'value'}="Long explanatory label".
2488 #              Otherwise the provided values are used as the labels.
2489 #   $labeled -> (optional)
2490 #               A true value indicates the value should be used as the label attribute
2491 #               in the option elements.
2492 #               The label attribute specifies the option label presented to the user.
2493 #               This defaults to the content of the <option> element, but the label
2494 #               attribute allows authors to more easily use optgroup without sacrificing
2495 #               compatibility with browsers that do not support option groups.
2496 #   $novals -> (optional)
2497 #              A true value indicates to suppress the val attribute in the option elements
2498 # Returns:
2499 #   A string containing the definition of an option group.
2500 ####
2501 'optgroup' => <<'END_OF_FUNC',
2502 sub optgroup {
2503     my($self,@p) = self_or_default(@_);
2504     my($name,$values,$attributes,$labeled,$noval,$labels,@other)
2505         = rearrange([NAME,[VALUES,VALUE],ATTRIBUTES,LABELED,NOVALS,LABELS],@p);
2506
2507     my($result,@values);
2508     @values = $self->_set_values_and_labels($values,\$labels,$name,$labeled,$novals);
2509     my($other) = @other ? " @other" : '';
2510
2511     $name=$self->escapeHTML($name);
2512     $result = qq/<optgroup label="$name"$other>\n/;
2513     foreach (@values) {
2514         if (/<optgroup/) {
2515             foreach (split(/\n/)) {
2516                 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2517                 s/(value="$selected")/$selectit $1/ if defined $selected;
2518                 $result .= "$_\n";
2519             }
2520         }
2521         else {
2522             my $attribs = $self->_set_attributes($_, $attributes);
2523             my($label) = $_;
2524             $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2525             $label=$self->escapeHTML($label);
2526             my($value)=$self->escapeHTML($_,1);
2527             $result .= $labeled ? $novals ? "<option$attribs label=\"$value\">$label</option>\n"
2528                                           : "<option$attribs label=\"$value\" value=\"$value\">$label</option>\n"
2529                                 : $novals ? "<option$attribs>$label</option>\n"
2530                                           : "<option$attribs value=\"$value\">$label</option>\n";
2531         }
2532     }
2533     $result .= "</optgroup>";
2534     return $result;
2535 }
2536 END_OF_FUNC
2537
2538
2539 #### Method: scrolling_list
2540 # Create a scrolling list.
2541 # Parameters:
2542 #   $name -> name for the list
2543 #   $values -> A pointer to a regular array containing the
2544 #             values for each option line in the list.
2545 #   $defaults -> (optional)
2546 #             1. If a pointer to a regular array of options,
2547 #             then this will be used to decide which
2548 #             lines to turn on by default.
2549 #             2. Otherwise holds the value of the single line to turn on.
2550 #   $size -> (optional) Size of the list.
2551 #   $multiple -> (optional) If set, allow multiple selections.
2552 #   $labels -> (optional)
2553 #             A pointer to an associative array of labels to print next to each checkbox
2554 #             in the form $label{'value'}="Long explanatory label".
2555 #             Otherwise the provided values are used as the labels.
2556 # Returns:
2557 #   A string containing the definition of a scrolling list.
2558 ####
2559 'scrolling_list' => <<'END_OF_FUNC',
2560 sub scrolling_list {
2561     my($self,@p) = self_or_default(@_);
2562     my($name,$values,$defaults,$size,$multiple,$labels,$attributes,$override,$tabindex,@other)
2563         = rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT],
2564           SIZE,MULTIPLE,LABELS,ATTRIBUTES,[OVERRIDE,FORCE],TABINDEX],@p);
2565
2566     my($result,@values);
2567     @values = $self->_set_values_and_labels($values,\$labels,$name);
2568
2569     $size = $size || scalar(@values);
2570
2571     my(%selected) = $self->previous_or_default($name,$defaults,$override);
2572     my($is_multiple) = $multiple ? qq/ multiple="multiple"/ : '';
2573     my($has_size) = $size ? qq/ size="$size"/: '';
2574     my($other) = @other ? " @other" : '';
2575
2576     $name=$self->escapeHTML($name);
2577     $tabindex = $self->element_tab($tabindex);
2578     $result = qq/<select name="$name" $tabindex$has_size$is_multiple$other>\n/;
2579     foreach (@values) {
2580         my($selectit) = $self->_selected($selected{$_});
2581         my($label) = $_;
2582         $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2583         $label=$self->escapeHTML($label);
2584         my($value)=$self->escapeHTML($_,1);
2585         my $attribs = $self->_set_attributes($_, $attributes);
2586         $result .= "<option ${selectit}${attribs}value=\"$value\">$label</option>\n";
2587     }
2588     $result .= "</select>";
2589     $self->register_parameter($name);
2590     return $result;
2591 }
2592 END_OF_FUNC
2593
2594
2595 #### Method: hidden
2596 # Parameters:
2597 #   $name -> Name of the hidden field
2598 #   @default -> (optional) Initial values of field (may be an array)
2599 #      or
2600 #   $default->[initial values of field]
2601 # Returns:
2602 #   A string containing a <input type="hidden" name="name" value="value">
2603 ####
2604 'hidden' => <<'END_OF_FUNC',
2605 sub hidden {
2606     my($self,@p) = self_or_default(@_);
2607
2608     # this is the one place where we departed from our standard
2609     # calling scheme, so we have to special-case (darn)
2610     my(@result,@value);
2611     my($name,$default,$override,@other) =
2612         rearrange([NAME,[DEFAULT,VALUE,VALUES],[OVERRIDE,FORCE]],@p);
2613
2614     my $do_override = 0;
2615     if ( ref($p[0]) || substr($p[0],0,1) eq '-') {
2616         @value = ref($default) ? @{$default} : $default;
2617         $do_override = $override;
2618     } else {
2619         foreach ($default,$override,@other) {
2620             push(@value,$_) if defined($_);
2621         }
2622     }
2623
2624     # use previous values if override is not set
2625     my @prev = $self->param($name);
2626     @value = @prev if !$do_override && @prev;
2627
2628     $name=$self->escapeHTML($name);
2629     foreach (@value) {
2630         $_ = defined($_) ? $self->escapeHTML($_,1) : '';
2631         push @result,$XHTML ? qq(<input type="hidden" name="$name" value="$_" @other />)
2632                             : qq(<input type="hidden" name="$name" value="$_" @other>);
2633     }
2634     return wantarray ? @result : join('',@result);
2635 }
2636 END_OF_FUNC
2637
2638
2639 #### Method: image_button
2640 # Parameters:
2641 #   $name -> Name of the button
2642 #   $src ->  URL of the image source
2643 #   $align -> Alignment style (TOP, BOTTOM or MIDDLE)
2644 # Returns:
2645 #   A string containing a <input type="image" name="name" src="url" align="alignment">
2646 ####
2647 'image_button' => <<'END_OF_FUNC',
2648 sub image_button {
2649     my($self,@p) = self_or_default(@_);
2650
2651     my($name,$src,$alignment,@other) =
2652         rearrange([NAME,SRC,ALIGN],@p);
2653
2654     my($align) = $alignment ? " align=\L\"$alignment\"" : '';
2655     my($other) = @other ? " @other" : '';
2656     $name=$self->escapeHTML($name);
2657     return $XHTML ? qq(<input type="image" name="$name" src="$src"$align$other />)
2658                   : qq/<input type="image" name="$name" src="$src"$align$other>/;
2659 }
2660 END_OF_FUNC
2661
2662
2663 #### Method: self_url
2664 # Returns a URL containing the current script and all its
2665 # param/value pairs arranged as a query.  You can use this
2666 # to create a link that, when selected, will reinvoke the
2667 # script with all its state information preserved.
2668 ####
2669 'self_url' => <<'END_OF_FUNC',
2670 sub self_url {
2671     my($self,@p) = self_or_default(@_);
2672     return $self->url('-path_info'=>1,'-query'=>1,'-full'=>1,@p);
2673 }
2674 END_OF_FUNC
2675
2676
2677 # This is provided as a synonym to self_url() for people unfortunate
2678 # enough to have incorporated it into their programs already!
2679 'state' => <<'END_OF_FUNC',
2680 sub state {
2681     &self_url;
2682 }
2683 END_OF_FUNC
2684
2685
2686 #### Method: url
2687 # Like self_url, but doesn't return the query string part of
2688 # the URL.
2689 ####
2690 'url' => <<'END_OF_FUNC',
2691 sub url {
2692     my($self,@p) = self_or_default(@_);
2693     my ($relative,$absolute,$full,$path_info,$query,$base,$rewrite) =
2694         rearrange(['RELATIVE','ABSOLUTE','FULL',['PATH','PATH_INFO'],['QUERY','QUERY_STRING'],'BASE','REWRITE'],@p);
2695     my $url  = '';
2696     $full++      if $base || !($relative || $absolute);
2697     $rewrite++   unless defined $rewrite;
2698
2699     my $path        =  $self->path_info;
2700     my $script_name =  $self->script_name;
2701     my $request_uri =  unescape($self->request_uri) || '';
2702     my $query_str   =  $self->query_string;
2703
2704     my $rewrite_in_use = $request_uri && $request_uri !~ /^\Q$script_name/;
2705     undef $path if $rewrite_in_use && $rewrite;  # path not valid when rewriting active
2706
2707     my $uri         =  $rewrite && $request_uri ? $request_uri : $script_name;
2708     $uri            =~ s/\?.*$//;                                 # remove query string
2709     $uri            =~ s/\Q$path\E$//      if defined $path;      # remove path
2710
2711     if ($full) {
2712         my $protocol = $self->protocol();
2713         $url = "$protocol://";
2714         my $vh = http('x_forwarded_host') || http('host') || '';
2715         $vh =~ s/\:\d+$//;  # some clients add the port number (incorrectly). Get rid of it.
2716         if ($vh) {
2717             $url .= $vh;
2718         } else {
2719             $url .= server_name();
2720         }
2721         my $port = $self->server_port;
2722         $url .= ":" . $port
2723           unless (lc($protocol) eq 'http'  && $port == 80)
2724                 || (lc($protocol) eq 'https' && $port == 443);
2725         return $url if $base;
2726         $url .= $uri;
2727     } elsif ($relative) {
2728         ($url) = $uri =~ m!([^/]+)$!;
2729     } elsif ($absolute) {
2730         $url = $uri;
2731     }
2732
2733     $url .= $path         if $path_info and defined $path;
2734     $url .= "?$query_str" if $query     and $query_str ne '';
2735     $url ||= '';
2736     $url =~ s/([^a-zA-Z0-9_.%;&?\/\\:+=~-])/sprintf("%%%02X",ord($1))/eg;
2737     return $url;
2738 }
2739
2740 END_OF_FUNC
2741
2742 #### Method: cookie
2743 # Set or read a cookie from the specified name.
2744 # Cookie can then be passed to header().
2745 # Usual rules apply to the stickiness of -value.
2746 #  Parameters:
2747 #   -name -> name for this cookie (optional)
2748 #   -value -> value of this cookie (scalar, array or hash)
2749 #   -path -> paths for which this cookie is valid (optional)
2750 #   -domain -> internet domain in which this cookie is valid (optional)
2751 #   -secure -> if true, cookie only passed through secure channel (optional)
2752 #   -expires -> expiry date in format Wdy, DD-Mon-YYYY HH:MM:SS GMT (optional)
2753 ####
2754 'cookie' => <<'END_OF_FUNC',
2755 sub cookie {
2756     my($self,@p) = self_or_default(@_);
2757     my($name,$value,$path,$domain,$secure,$expires,$httponly) =
2758         rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES,HTTPONLY],@p);
2759
2760     require CGI::Cookie;
2761
2762     # if no value is supplied, then we retrieve the
2763     # value of the cookie, if any.  For efficiency, we cache the parsed
2764     # cookies in our state variables.
2765     unless ( defined($value) ) {
2766         $self->{'.cookies'} = CGI::Cookie->fetch
2767             unless $self->{'.cookies'};
2768
2769         # If no name is supplied, then retrieve the names of all our cookies.
2770         return () unless $self->{'.cookies'};
2771         return keys %{$self->{'.cookies'}} unless $name;
2772         return () unless $self->{'.cookies'}->{$name};
2773         return $self->{'.cookies'}->{$name}->value if defined($name) && $name ne '';
2774     }
2775
2776     # If we get here, we're creating a new cookie
2777     return undef unless defined($name) && $name ne '';  # this is an error
2778
2779     my @param;
2780     push(@param,'-name'=>$name);
2781     push(@param,'-value'=>$value);
2782     push(@param,'-domain'=>$domain) if $domain;
2783     push(@param,'-path'=>$path) if $path;
2784     push(@param,'-expires'=>$expires) if $expires;
2785     push(@param,'-secure'=>$secure) if $secure;
2786     push(@param,'-httponly'=>$httponly) if $httponly;
2787
2788     return new CGI::Cookie(@param);
2789 }
2790 END_OF_FUNC
2791
2792 'parse_keywordlist' => <<'END_OF_FUNC',
2793 sub parse_keywordlist {
2794     my($self,$tosplit) = @_;
2795     $tosplit = unescape($tosplit); # unescape the keywords
2796     $tosplit=~tr/+/ /;          # pluses to spaces
2797     my(@keywords) = split(/\s+/,$tosplit);
2798     return @keywords;
2799 }
2800 END_OF_FUNC
2801
2802 'param_fetch' => <<'END_OF_FUNC',
2803 sub param_fetch {
2804     my($self,@p) = self_or_default(@_);
2805     my($name) = rearrange([NAME],@p);
2806     unless (exists($self->{$name})) {
2807         $self->add_parameter($name);
2808         $self->{$name} = [];
2809     }
2810
2811     return $self->{$name};
2812 }
2813 END_OF_FUNC
2814
2815 ###############################################
2816 # OTHER INFORMATION PROVIDED BY THE ENVIRONMENT
2817 ###############################################
2818
2819 #### Method: path_info
2820 # Return the extra virtual path information provided
2821 # after the URL (if any)
2822 ####
2823 'path_info' => <<'END_OF_FUNC',
2824 sub path_info {
2825     my ($self,$info) = self_or_default(@_);
2826     if (defined($info)) {
2827         $info = "/$info" if $info ne '' &&  substr($info,0,1) ne '/';
2828         $self->{'.path_info'} = $info;
2829     } elsif (! defined($self->{'.path_info'}) ) {
2830         my (undef,$path_info) = $self->_name_and_path_from_env;
2831         $self->{'.path_info'} = $path_info || '';
2832     }
2833     return $self->{'.path_info'};
2834 }
2835 END_OF_FUNC
2836
2837 # WE USE THIS TO COMPENSATE FOR A BUG IN APACHE 2 PRESENT AT LEAST UP THROUGH 2.0.54
2838 '_name_and_path_from_env' => <<'END_OF_FUNC',
2839 sub _name_and_path_from_env {
2840    my $self = shift;
2841    my $raw_script_name = $ENV{SCRIPT_NAME} || '';
2842    my $raw_path_info   = $ENV{PATH_INFO}   || '';
2843    my $uri             = unescape($self->request_uri) || '';
2844
2845    my $protected    = quotemeta($raw_path_info);
2846    $raw_script_name =~ s/$protected$//;
2847
2848    my @uri_double_slashes  = $uri =~ m^(/{2,}?)^g;
2849    my @path_double_slashes = "$raw_script_name $raw_path_info" =~ m^(/{2,}?)^g;
2850
2851    my $apache_bug      = @uri_double_slashes != @path_double_slashes;
2852    return ($raw_script_name,$raw_path_info) unless $apache_bug;
2853
2854    my $path_info_search = quotemeta($raw_path_info);
2855    $path_info_search    =~ s!/!/+!g;
2856    if ($uri =~ m/^(.+)($path_info_search)/) {
2857        return ($1,$2);
2858    } else {
2859        return ($raw_script_name,$raw_path_info);
2860    }
2861 }
2862 END_OF_FUNC
2863
2864
2865 #### Method: request_method
2866 # Returns 'POST', 'GET', 'PUT' or 'HEAD'
2867 ####
2868 'request_method' => <<'END_OF_FUNC',
2869 sub request_method {
2870     return $ENV{'REQUEST_METHOD'};
2871 }
2872 END_OF_FUNC
2873
2874 #### Method: content_type
2875 # Returns the content_type string
2876 ####
2877 'content_type' => <<'END_OF_FUNC',
2878 sub content_type {
2879     return $ENV{'CONTENT_TYPE'};
2880 }
2881 END_OF_FUNC
2882
2883 #### Method: path_translated
2884 # Return the physical path information provided
2885 # by the URL (if any)
2886 ####
2887 'path_translated' => <<'END_OF_FUNC',
2888 sub path_translated {
2889     return $ENV{'PATH_TRANSLATED'};
2890 }
2891 END_OF_FUNC
2892
2893
2894 #### Method: request_uri
2895 # Return the literal request URI
2896 ####
2897 'request_uri' => <<'END_OF_FUNC',
2898 sub request_uri {
2899     return $ENV{'REQUEST_URI'};
2900 }
2901 END_OF_FUNC
2902
2903
2904 #### Method: query_string
2905 # Synthesize a query string from our current
2906 # parameters
2907 ####
2908 'query_string' => <<'END_OF_FUNC',
2909 sub query_string {
2910     my($self) = self_or_default(@_);
2911     my($param,$value,@pairs);
2912     foreach $param ($self->param) {
2913         my($eparam) = escape($param);
2914         foreach $value ($self->param($param)) {
2915             $value = escape($value);
2916             next unless defined $value;
2917             push(@pairs,"$eparam=$value");
2918         }
2919     }
2920     foreach (keys %{$self->{'.fieldnames'}}) {
2921       push(@pairs,".cgifields=".escape("$_"));
2922     }
2923     return join($USE_PARAM_SEMICOLONS ? ';' : '&',@pairs);
2924 }
2925 END_OF_FUNC
2926
2927
2928 #### Method: accept
2929 # Without parameters, returns an array of the
2930 # MIME types the browser accepts.
2931 # With a single parameter equal to a MIME
2932 # type, will return undef if the browser won't
2933 # accept it, 1 if the browser accepts it but
2934 # doesn't give a preference, or a floating point
2935 # value between 0.0 and 1.0 if the browser
2936 # declares a quantitative score for it.
2937 # This handles MIME type globs correctly.
2938 ####
2939 'Accept' => <<'END_OF_FUNC',
2940 sub Accept {
2941     my($self,$search) = self_or_CGI(@_);
2942     my(%prefs,$type,$pref,$pat);
2943
2944     my(@accept) = split(',',$self->http('accept'));
2945
2946     foreach (@accept) {
2947         ($pref) = /q=(\d\.\d+|\d+)/;
2948         ($type) = m#(\S+/[^;]+)#;
2949         next unless $type;
2950         $prefs{$type}=$pref || 1;
2951     }
2952
2953     return keys %prefs unless $search;
2954
2955     # if a search type is provided, we may need to
2956     # perform a pattern matching operation.
2957     # The MIME types use a glob mechanism, which
2958     # is easily translated into a perl pattern match
2959
2960     # First return the preference for directly supported
2961     # types:
2962     return $prefs{$search} if $prefs{$search};
2963
2964     # Didn't get it, so try pattern matching.
2965     foreach (keys %prefs) {
2966         next unless /\*/;       # not a pattern match
2967         ($pat = $_) =~ s/([^\w*])/\\$1/g; # escape meta characters
2968         $pat =~ s/\*/.*/g; # turn it into a pattern
2969         return $prefs{$_} if $search=~/$pat/;
2970     }
2971 }
2972 END_OF_FUNC
2973
2974
2975 #### Method: user_agent
2976 # If called with no parameters, returns the user agent.
2977 # If called with one parameter, does a pattern match (case
2978 # insensitive) on the user agent.
2979 ####
2980 'user_agent' => <<'END_OF_FUNC',
2981 sub user_agent {
2982     my($self,$match)=self_or_CGI(@_);
2983     return $self->http('user_agent') unless $match;
2984     return $self->http('user_agent') =~ /$match/i;
2985 }
2986 END_OF_FUNC
2987
2988
2989 #### Method: raw_cookie
2990 # Returns the magic cookies for the session.
2991 # The cookies are not parsed or altered in any way, i.e.
2992 # cookies are returned exactly as given in the HTTP
2993 # headers.  If a cookie name is given, only that cookie's
2994 # value is returned, otherwise the entire raw cookie
2995 # is returned.
2996 ####
2997 'raw_cookie' => <<'END_OF_FUNC',
2998 sub raw_cookie {
2999     my($self,$key) = self_or_CGI(@_);
3000
3001     require CGI::Cookie;
3002
3003     if (defined($key)) {
3004         $self->{'.raw_cookies'} = CGI::Cookie->raw_fetch
3005             unless $self->{'.raw_cookies'};
3006
3007         return () unless $self->{'.raw_cookies'};
3008         return () unless $self->{'.raw_cookies'}->{$key};
3009         return $self->{'.raw_cookies'}->{$key};
3010     }
3011     return $self->http('cookie') || $ENV{'COOKIE'} || '';
3012 }
3013 END_OF_FUNC
3014
3015 #### Method: virtual_host
3016 # Return the name of the virtual_host, which
3017 # is not always the same as the server
3018 ######
3019 'virtual_host' => <<'END_OF_FUNC',
3020 sub virtual_host {
3021     my $vh = http('x_forwarded_host') || http('host') || server_name();
3022     $vh =~ s/:\d+$//;           # get rid of port number
3023     return $vh;
3024 }
3025 END_OF_FUNC
3026
3027 #### Method: remote_host
3028 # Return the name of the remote host, or its IP
3029 # address if unavailable.  If this variable isn't
3030 # defined, it returns "localhost" for debugging
3031 # purposes.
3032 ####
3033 'remote_host' => <<'END_OF_FUNC',
3034 sub remote_host {
3035     return $ENV{'REMOTE_HOST'} || $ENV{'REMOTE_ADDR'}
3036     || 'localhost';
3037 }
3038 END_OF_FUNC
3039
3040
3041 #### Method: remote_addr
3042 # Return the IP addr of the remote host.
3043 ####
3044 'remote_addr' => <<'END_OF_FUNC',
3045 sub remote_addr {
3046     return $ENV{'REMOTE_ADDR'} || '127.0.0.1';
3047 }
3048 END_OF_FUNC
3049
3050
3051 #### Method: script_name
3052 # Return the partial URL to this script for
3053 # self-referencing scripts.  Also see
3054 # self_url(), which returns a URL with all state information
3055 # preserved.
3056 ####
3057 'script_name' => <<'END_OF_FUNC',
3058 sub script_name {
3059     my ($self,@p) = self_or_default(@_);
3060     if (@p) {
3061         $self->{'.script_name'} = shift @p;
3062     } elsif (!exists $self->{'.script_name'}) {
3063         my ($script_name,$path_info) = $self->_name_and_path_from_env();
3064         $self->{'.script_name'} = $script_name;
3065     }
3066     return $self->{'.script_name'};
3067 }
3068 END_OF_FUNC
3069
3070
3071 #### Method: referer
3072 # Return the HTTP_REFERER: useful for generating
3073 # a GO BACK button.
3074 ####
3075 'referer' => <<'END_OF_FUNC',
3076 sub referer {
3077     my($self) = self_or_CGI(@_);
3078     return $self->http('referer');
3079 }
3080 END_OF_FUNC
3081
3082
3083 #### Method: server_name
3084 # Return the name of the server
3085 ####
3086 'server_name' => <<'END_OF_FUNC',
3087 sub server_name {
3088     return $ENV{'SERVER_NAME'} || 'localhost';
3089 }
3090 END_OF_FUNC
3091
3092 #### Method: server_software
3093 # Return the name of the server software
3094 ####
3095 'server_software' => <<'END_OF_FUNC',
3096 sub server_software {
3097     return $ENV{'SERVER_SOFTWARE'} || 'cmdline';
3098 }
3099 END_OF_FUNC
3100
3101 #### Method: virtual_port
3102 # Return the server port, taking virtual hosts into account
3103 ####
3104 'virtual_port' => <<'END_OF_FUNC',
3105 sub virtual_port {
3106     my($self) = self_or_default(@_);
3107     my $vh = $self->http('x_forwarded_host') || $self->http('host');
3108     my $protocol = $self->protocol;
3109     if ($vh) {
3110         return ($vh =~ /:(\d+)$/)[0] || ($protocol eq 'https' ? 443 : 80);
3111     } else {
3112         return $self->server_port();
3113     }
3114 }
3115 END_OF_FUNC
3116
3117 #### Method: server_port
3118 # Return the tcp/ip port the server is running on
3119 ####
3120 'server_port' => <<'END_OF_FUNC',
3121 sub server_port {
3122     return $ENV{'SERVER_PORT'} || 80; # for debugging
3123 }
3124 END_OF_FUNC
3125
3126 #### Method: server_protocol
3127 # Return the protocol (usually HTTP/1.0)
3128 ####
3129 'server_protocol' => <<'END_OF_FUNC',
3130 sub server_protocol {
3131     return $ENV{'SERVER_PROTOCOL'} || 'HTTP/1.0'; # for debugging
3132 }
3133 END_OF_FUNC
3134
3135 #### Method: http
3136 # Return the value of an HTTP variable, or
3137 # the list of variables if none provided
3138 ####
3139 'http' => <<'END_OF_FUNC',
3140 sub http {
3141     my ($self,$parameter) = self_or_CGI(@_);
3142     return $ENV{$parameter} if $parameter=~/^HTTP/;
3143     $parameter =~ tr/-/_/;
3144     return $ENV{"HTTP_\U$parameter\E"} if $parameter;
3145     my(@p);
3146     foreach (keys %ENV) {
3147         push(@p,$_) if /^HTTP/;
3148     }
3149     return @p;
3150 }
3151 END_OF_FUNC
3152
3153 #### Method: https
3154 # Return the value of HTTPS
3155 ####
3156 'https' => <<'END_OF_FUNC',
3157 sub https {
3158     local($^W)=0;
3159     my ($self,$parameter) = self_or_CGI(@_);
3160     return $ENV{HTTPS} unless $parameter;
3161     return $ENV{$parameter} if $parameter=~/^HTTPS/;
3162     $parameter =~ tr/-/_/;
3163     return $ENV{"HTTPS_\U$parameter\E"} if $parameter;
3164     my(@p);
3165     foreach (keys %ENV) {
3166         push(@p,$_) if /^HTTPS/;
3167     }
3168     return @p;
3169 }
3170 END_OF_FUNC
3171
3172 #### Method: protocol
3173 # Return the protocol (http or https currently)
3174 ####
3175 'protocol' => <<'END_OF_FUNC',
3176 sub protocol {
3177     local($^W)=0;
3178     my $self = shift;
3179     return 'https' if uc($self->https()) eq 'ON';
3180     return 'https' if $self->server_port == 443;
3181     my $prot = $self->server_protocol;
3182     my($protocol,$version) = split('/',$prot);
3183     return "\L$protocol\E";
3184 }
3185 END_OF_FUNC
3186
3187 #### Method: remote_ident
3188 # Return the identity of the remote user
3189 # (but only if his host is running identd)
3190 ####
3191 'remote_ident' => <<'END_OF_FUNC',
3192 sub remote_ident {
3193     return $ENV{'REMOTE_IDENT'};
3194 }
3195 END_OF_FUNC
3196
3197
3198 #### Method: auth_type
3199 # Return the type of use verification/authorization in use, if any.
3200 ####
3201 'auth_type' => <<'END_OF_FUNC',
3202 sub auth_type {
3203     return $ENV{'AUTH_TYPE'};
3204 }
3205 END_OF_FUNC
3206
3207
3208 #### Method: remote_user
3209 # Return the authorization name used for user
3210 # verification.
3211 ####
3212 'remote_user' => <<'END_OF_FUNC',
3213 sub remote_user {
3214     return $ENV{'REMOTE_USER'};
3215 }
3216 END_OF_FUNC
3217
3218
3219 #### Method: user_name
3220 # Try to return the remote user's name by hook or by
3221 # crook
3222 ####
3223 'user_name' => <<'END_OF_FUNC',
3224 sub user_name {
3225     my ($self) = self_or_CGI(@_);
3226     return $self->http('from') || $ENV{'REMOTE_IDENT'} || $ENV{'REMOTE_USER'};
3227 }
3228 END_OF_FUNC
3229
3230 #### Method: nosticky
3231 # Set or return the NOSTICKY global flag
3232 ####
3233 'nosticky' => <<'END_OF_FUNC',
3234 sub nosticky {
3235     my ($self,$param) = self_or_CGI(@_);
3236     $CGI::NOSTICKY = $param if defined($param);
3237     return $CGI::NOSTICKY;
3238 }
3239 END_OF_FUNC
3240
3241 #### Method: nph
3242 # Set or return the NPH global flag
3243 ####
3244 'nph' => <<'END_OF_FUNC',
3245 sub nph {
3246     my ($self,$param) = self_or_CGI(@_);
3247     $CGI::NPH = $param if defined($param);
3248     return $CGI::NPH;
3249 }
3250 END_OF_FUNC
3251
3252 #### Method: private_tempfiles
3253 # Set or return the private_tempfiles global flag
3254 ####
3255 'private_tempfiles' => <<'END_OF_FUNC',
3256 sub private_tempfiles {
3257     my ($self,$param) = self_or_CGI(@_);
3258     $CGI::PRIVATE_TEMPFILES = $param if defined($param);
3259     return $CGI::PRIVATE_TEMPFILES;
3260 }
3261 END_OF_FUNC
3262 #### Method: close_upload_files
3263 # Set or return the close_upload_files global flag
3264 ####
3265 'close_upload_files' => <<'END_OF_FUNC',
3266 sub close_upload_files {
3267     my ($self,$param) = self_or_CGI(@_);
3268     $CGI::CLOSE_UPLOAD_FILES = $param if defined($param);
3269     return $CGI::CLOSE_UPLOAD_FILES;
3270 }
3271 END_OF_FUNC
3272
3273
3274 #### Method: default_dtd
3275 # Set or return the default_dtd global
3276 ####
3277 'default_dtd' => <<'END_OF_FUNC',
3278 sub default_dtd {
3279     my ($self,$param,$param2) = self_or_CGI(@_);
3280     if (defined $param2 && defined $param) {
3281         $CGI::DEFAULT_DTD = [ $param, $param2 ];
3282     } elsif (defined $param) {
3283         $CGI::DEFAULT_DTD = $param;
3284     }
3285     return $CGI::DEFAULT_DTD;
3286 }
3287 END_OF_FUNC
3288
3289 # -------------- really private subroutines -----------------
3290 'previous_or_default' => <<'END_OF_FUNC',
3291 sub previous_or_default {
3292     my($self,$name,$defaults,$override) = @_;
3293     my(%selected);
3294
3295     if (!$override && ($self->{'.fieldnames'}->{$name} ||
3296                        defined($self->param($name)) ) ) {
3297         $selected{$_}++ for $self->param($name);
3298     } elsif (defined($defaults) && ref($defaults) &&
3299              (ref($defaults) eq 'ARRAY')) {
3300         $selected{$_}++ for @{$defaults};
3301     } else {
3302         $selected{$defaults}++ if defined($defaults);
3303     }
3304
3305     return %selected;
3306 }
3307 END_OF_FUNC
3308
3309 'register_parameter' => <<'END_OF_FUNC',
3310 sub register_parameter {
3311     my($self,$param) = @_;
3312     $self->{'.parametersToAdd'}->{$param}++;
3313 }
3314 END_OF_FUNC
3315
3316 'get_fields' => <<'END_OF_FUNC',
3317 sub get_fields {
3318     my($self) = @_;
3319     return $self->CGI::hidden('-name'=>'.cgifields',
3320                               '-values'=>[keys %{$self->{'.parametersToAdd'}}],
3321                               '-override'=>1);
3322 }
3323 END_OF_FUNC
3324
3325 'read_from_cmdline' => <<'END_OF_FUNC',
3326 sub read_from_cmdline {
3327     my($input,@words);
3328     my($query_string);
3329     my($subpath);
3330     if ($DEBUG && @ARGV) {
3331         @words = @ARGV;
3332     } elsif ($DEBUG > 1) {
3333         require "shellwords.pl";
3334         print STDERR "(offline mode: enter name=value pairs on standard input; press ^D or ^Z when done)\n";
3335         chomp(@lines = <STDIN>); # remove newlines
3336         $input = join(" ",@lines);
3337         @words = &shellwords($input);
3338     }
3339     foreach (@words) {
3340         s/\\=/%3D/g;
3341         s/\\&/%26/g;
3342     }
3343
3344     if ("@words"=~/=/) {
3345         $query_string = join('&',@words);
3346     } else {
3347         $query_string = join('+',@words);
3348     }
3349     if ($query_string =~ /^(.*?)\?(.*)$/)
3350     {
3351         $query_string = $2;
3352         $subpath = $1;
3353     }
3354     return { 'query_string' => $query_string, 'subpath' => $subpath };
3355 }
3356 END_OF_FUNC
3357
3358 #####
3359 # subroutine: read_multipart
3360 #
3361 # Read multipart data and store it into our parameters.
3362 # An interesting feature is that if any of the parts is a file, we
3363 # create a temporary file and open up a filehandle on it so that the
3364 # caller can read from it if necessary.
3365 #####
3366 'read_multipart' => <<'END_OF_FUNC',
3367 sub read_multipart {
3368     my($self,$boundary,$length) = @_;
3369     my($buffer) = $self->new_MultipartBuffer($boundary,$length);
3370     return unless $buffer;
3371     my(%header,$body);
3372     my $filenumber = 0;
3373     while (!$buffer->eof) {
3374         %header = $buffer->readHeader;
3375
3376         unless (%header) {
3377             $self->cgi_error("400 Bad request (malformed multipart POST)");
3378             return;
3379         }
3380
3381         my($param)= $header{'Content-Disposition'}=~/ name="([^"]*)"/;
3382         $param .= $TAINTED;
3383
3384         # Bug:  Netscape doesn't escape quotation marks in file names!!!
3385         # See RFC 1867, 2183, 2045
3386         # NB: File content will be loaded into memory should
3387         # content-disposition parsing fail.
3388         my ($filename) = $header{'Content-Disposition'}=~/ filename=(("[^"]*")|([a-z\d!\#'\*\+,\.^_\`\{\}\|\~]*))/i;
3389         $filename =~ s/^"([^"]*)"$/$1/;
3390         # Test for Opera's multiple upload feature
3391         my($multipart) = ( defined( $header{'Content-Type'} ) &&
3392                 $header{'Content-Type'} =~ /multipart\/mixed/ ) ?
3393                 1 : 0;
3394
3395         # add this parameter to our list
3396         $self->add_parameter($param);
3397
3398         # If no filename specified, then just read the data and assign it
3399         # to our parameter list.
3400         if ( ( !defined($filename) || $filename eq '' ) && !$multipart ) {
3401             my($value) = $buffer->readBody;
3402             $value .= $TAINTED;
3403             push(@{$self->{$param}},$value);
3404             next;
3405         }
3406
3407         my ($tmpfile,$tmp,$filehandle);
3408       UPLOADS: {
3409           # If we get here, then we are dealing with a potentially large
3410           # uploaded form.  Save the data to a temporary file, then open
3411           # the file for reading.
3412
3413           # skip the file if uploads disabled
3414           if ($DISABLE_UPLOADS) {
3415               while (defined($data = $buffer->read)) { }
3416               last UPLOADS;
3417           }
3418
3419           # set the filename to some recognizable value
3420           if ( ( !defined($filename) || $filename eq '' ) && $multipart ) {
3421               $filename = "multipart/mixed";
3422           }
3423
3424           # choose a relatively unpredictable tmpfile sequence number
3425           my $seqno = unpack("%16C*",join('',localtime,grep {defined $_} values %ENV));
3426           for (my $cnt=10;$cnt>0;$cnt--) {
3427             next unless $tmpfile = new CGITempFile($seqno);
3428             $tmp = $tmpfile->as_string;
3429             last if defined($filehandle = Fh->new($filename,$tmp,$PRIVATE_TEMPFILES));
3430             $seqno += int rand(100);
3431           }
3432           die "CGI open of tmpfile: $!\n" unless defined $filehandle;
3433           $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode
3434                      && defined fileno($filehandle);
3435
3436           # if this is an multipart/mixed attachment, save the header
3437           # together with the body for later parsing with an external
3438           # MIME parser module
3439           if ( $multipart ) {
3440               foreach ( keys %header ) {
3441                   print $filehandle "$_: $header{$_}${CRLF}";
3442               }
3443               print $filehandle "${CRLF}";
3444           }
3445
3446           my ($data);
3447           local($\) = '';
3448           my $totalbytes = 0;
3449           while (defined($data = $buffer->read)) {
3450               if (defined $self->{'.upload_hook'})
3451                {
3452                   $totalbytes += length($data);
3453                    &{$self->{'.upload_hook'}}($filename ,$data, $totalbytes, $self->{'.upload_data'});
3454               }
3455               print $filehandle $data if ($self->{'use_tempfile'});
3456           }
3457
3458           # back up to beginning of file
3459           seek($filehandle,0,0);
3460
3461       ## Close the filehandle if requested this allows a multipart MIME
3462       ## upload to contain many files, and we won't die due to too many
3463       ## open file handles. The user can access the files using the hash
3464       ## below.
3465       close $filehandle if $CLOSE_UPLOAD_FILES;
3466           $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
3467
3468           # Save some information about the uploaded file where we can get
3469           # at it later.
3470           # Use the typeglob as the key, as this is guaranteed to be
3471           # unique for each filehandle.  Don't use the file descriptor as
3472           # this will be re-used for each filehandle if the
3473           # close_upload_files feature is used.
3474           $self->{'.tmpfiles'}->{$$filehandle}= {
3475               hndl => $filehandle,
3476               name => $tmpfile,
3477               info => {%header},
3478           };
3479           push(@{$self->{$param}},$filehandle);
3480       }
3481     }
3482 }
3483 END_OF_FUNC
3484
3485 #####
3486 # subroutine: read_multipart_related
3487 #
3488 # Read multipart/related data and store it into our parameters.  The
3489 # first parameter sets the start of the data. The part identified by
3490 # this Content-ID will not be stored as a file upload, but will be
3491 # returned by this method.  All other parts will be available as file
3492 # uploads accessible by their Content-ID
3493 #####
3494 'read_multipart_related' => <<'END_OF_FUNC',
3495 sub read_multipart_related {
3496     my($self,$start,$boundary,$length) = @_;
3497     my($buffer) = $self->new_MultipartBuffer($boundary,$length);
3498     return unless $buffer;
3499     my(%header,$body);
3500     my $filenumber = 0;
3501     my $returnvalue;
3502     while (!$buffer->eof) {
3503         %header = $buffer->readHeader;
3504
3505         unless (%header) {
3506             $self->cgi_error("400 Bad request (malformed multipart POST)");
3507             return;
3508         }
3509
3510         my($param) = $header{'Content-ID'}=~/\<([^\>]*)\>/;
3511         $param .= $TAINTED;
3512
3513         # If this is the start part, then just read the data and assign it
3514         # to our return variable.
3515         if ( $param eq $start ) {
3516             $returnvalue = $buffer->readBody;
3517             $returnvalue .= $TAINTED;
3518             next;
3519         }
3520
3521         # add this parameter to our list
3522         $self->add_parameter($param);
3523
3524         my ($tmpfile,$tmp,$filehandle);
3525       UPLOADS: {
3526           # If we get here, then we are dealing with a potentially large
3527           # uploaded form.  Save the data to a temporary file, then open
3528           # the file for reading.
3529
3530           # skip the file if uploads disabled
3531           if ($DISABLE_UPLOADS) {
3532               while (defined($data = $buffer->read)) { }
3533               last UPLOADS;
3534           }
3535
3536           # choose a relatively unpredictable tmpfile sequence number
3537           my $seqno = unpack("%16C*",join('',localtime,grep {defined $_} values %ENV));
3538           for (my $cnt=10;$cnt>0;$cnt--) {
3539             next unless $tmpfile = new CGITempFile($seqno);
3540             $tmp = $tmpfile->as_string;
3541             last if defined($filehandle = Fh->new($param,$tmp,$PRIVATE_TEMPFILES));
3542             $seqno += int rand(100);
3543           }
3544           die "CGI open of tmpfile: $!\n" unless defined $filehandle;
3545           $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode
3546                      && defined fileno($filehandle);
3547
3548           my ($data);
3549           local($\) = '';
3550           my $totalbytes;
3551           while (defined($data = $buffer->read)) {
3552               if (defined $self->{'.upload_hook'})
3553                {
3554                   $totalbytes += length($data);
3555                    &{$self->{'.upload_hook'}}($param ,$data, $totalbytes, $self->{'.upload_data'});
3556               }
3557               print $filehandle $data if ($self->{'use_tempfile'});
3558           }
3559
3560           # back up to beginning of file
3561           seek($filehandle,0,0);
3562
3563       ## Close the filehandle if requested this allows a multipart MIME
3564       ## upload to contain many files, and we won't die due to too many
3565       ## open file handles. The user can access the files using the hash
3566       ## below.
3567       close $filehandle if $CLOSE_UPLOAD_FILES;
3568           $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
3569
3570           # Save some information about the uploaded file where we can get
3571           # at it later.
3572           # Use the typeglob as the key, as this is guaranteed to be
3573           # unique for each filehandle.  Don't use the file descriptor as
3574           # this will be re-used for each filehandle if the
3575           # close_upload_files feature is used.
3576           $self->{'.tmpfiles'}->{$$filehandle}= {
3577               hndl => $filehandle,
3578               name => $tmpfile,
3579               info => {%header},
3580           };
3581           push(@{$self->{$param}},$filehandle);
3582       }
3583     }
3584     return $returnvalue;
3585 }
3586 END_OF_FUNC
3587
3588
3589 'upload' =><<'END_OF_FUNC',
3590 sub upload {
3591     my($self,$param_name) = self_or_default(@_);
3592     my @param = grep {ref($_) && defined(fileno($_))} $self->param($param_name);
3593     return unless @param;
3594     return wantarray ? @param : $param[0];
3595 }
3596 END_OF_FUNC
3597
3598 'tmpFileName' => <<'END_OF_FUNC',
3599 sub tmpFileName {
3600     my($self,$filename) = self_or_default(@_);
3601     return $self->{'.tmpfiles'}->{$$filename}->{name} ?
3602         $self->{'.tmpfiles'}->{$$filename}->{name}->as_string
3603             : '';
3604 }
3605 END_OF_FUNC
3606
3607 'uploadInfo' => <<'END_OF_FUNC',
3608 sub uploadInfo {
3609     my($self,$filename) = self_or_default(@_);
3610     return $self->{'.tmpfiles'}->{$$filename}->{info};
3611 }
3612 END_OF_FUNC
3613
3614 # internal routine, don't use
3615 '_set_values_and_labels' => <<'END_OF_FUNC',
3616 sub _set_values_and_labels {
3617     my $self = shift;
3618     my ($v,$l,$n) = @_;
3619     $$l = $v if ref($v) eq 'HASH' && !ref($$l);
3620     return $self->param($n) if !defined($v);
3621     return $v if !ref($v);
3622     return ref($v) eq 'HASH' ? keys %$v : @$v;
3623 }
3624 END_OF_FUNC
3625
3626 # internal routine, don't use
3627 '_set_attributes' => <<'END_OF_FUNC',
3628 sub _set_attributes {
3629     my $self = shift;
3630     my($element, $attributes) = @_;
3631     return '' unless defined($attributes->{$element});
3632     $attribs = ' ';
3633     foreach my $attrib (keys %{$attributes->{$element}}) {
3634         (my $clean_attrib = $attrib) =~ s/^-//;
3635         $attribs .= "@{[lc($clean_attrib)]}=\"$attributes->{$element}{$attrib}\" ";
3636     }
3637     $attribs =~ s/ $//;
3638     return $attribs;
3639 }
3640 END_OF_FUNC
3641
3642 '_compile_all' => <<'END_OF_FUNC',
3643 sub _compile_all {
3644     foreach (@_) {
3645         next if defined(&$_);
3646         $AUTOLOAD = "CGI::$_";
3647         _compile();
3648     }
3649 }
3650 END_OF_FUNC
3651
3652 );
3653 END_OF_AUTOLOAD
3654 ;
3655
3656 #########################################################
3657 # Globals and stubs for other packages that we use.
3658 #########################################################
3659
3660 ################### Fh -- lightweight filehandle ###############
3661 package Fh;
3662 use overload
3663     '""'  => \&asString,
3664     'cmp' => \&compare,
3665     'fallback'=>1;
3666
3667 $FH='fh00000';
3668
3669 *Fh::AUTOLOAD = \&CGI::AUTOLOAD;
3670
3671 sub DESTROY {
3672     my $self = shift;
3673     close $self;
3674 }
3675
3676 $AUTOLOADED_ROUTINES = '';      # prevent -w error
3677 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3678 %SUBS =  (
3679 'asString' => <<'END_OF_FUNC',
3680 sub asString {
3681     my $self = shift;
3682     # get rid of package name
3683     (my $i = $$self) =~ s/^\*(\w+::fh\d{5})+//;
3684     $i =~ s/%(..)/ chr(hex($1)) /eg;
3685     return $i.$CGI::TAINTED;
3686 # BEGIN DEAD CODE
3687 # This was an extremely clever patch that allowed "use strict refs".
3688 # Unfortunately it relied on another bug that caused leaky file descriptors.
3689 # The underlying bug has been fixed, so this no longer works.  However
3690 # "strict refs" still works for some reason.
3691 #    my $self = shift;
3692 #    return ${*{$self}{SCALAR}};
3693 # END DEAD CODE
3694 }
3695 END_OF_FUNC
3696
3697 'compare' => <<'END_OF_FUNC',
3698 sub compare {
3699     my $self = shift;
3700     my $value = shift;
3701     return "$self" cmp $value;
3702 }
3703 END_OF_FUNC
3704
3705 'new'  => <<'END_OF_FUNC',
3706 sub new {
3707     my($pack,$name,$file,$delete) = @_;
3708     _setup_symbols(@SAVED_SYMBOLS) if @SAVED_SYMBOLS;
3709     require Fcntl unless defined &Fcntl::O_RDWR;
3710     (my $safename = $name) =~ s/([':%])/ sprintf '%%%02X', ord $1 /eg;
3711     my $fv = ++$FH . $safename;
3712     my $ref = \*{"Fh::$fv"};
3713     $file =~ m!^([a-zA-Z0-9_\+ \'\":/.\$\\-]+)$! || return;
3714     my $safe = $1;
3715     sysopen($ref,$safe,Fcntl::O_RDWR()|Fcntl::O_CREAT()|Fcntl::O_EXCL(),0600) || return;
3716     unlink($safe) if $delete;
3717     CORE::delete $Fh::{$fv};
3718     return bless $ref,$pack;
3719 }
3720 END_OF_FUNC
3721
3722 );
3723 END_OF_AUTOLOAD
3724
3725 ######################## MultipartBuffer ####################
3726 package MultipartBuffer;
3727
3728 use constant DEBUG => 0;
3729
3730 # how many bytes to read at a time.  We use
3731 # a 4K buffer by default.
3732 $INITIAL_FILLUNIT = 1024 * 4;
3733 $TIMEOUT = 240*60;       # 4 hour timeout for big files
3734 $SPIN_LOOP_MAX = 2000;  # bug fix for some Netscape servers
3735 $CRLF=$CGI::CRLF;
3736
3737 #reuse the autoload function
3738 *MultipartBuffer::AUTOLOAD = \&CGI::AUTOLOAD;
3739
3740 # avoid autoloader warnings
3741 sub DESTROY {}
3742
3743 ###############################################################################
3744 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
3745 ###############################################################################
3746 $AUTOLOADED_ROUTINES = '';      # prevent -w error
3747 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3748 %SUBS =  (
3749
3750 'new' => <<'END_OF_FUNC',
3751 sub new {
3752     my($package,$interface,$boundary,$length) = @_;
3753     $FILLUNIT = $INITIAL_FILLUNIT;
3754     $CGI::DefaultClass->binmode($IN); # if $CGI::needs_binmode;  # just do it always
3755
3756     # If the user types garbage into the file upload field,
3757     # then Netscape passes NOTHING to the server (not good).
3758     # We may hang on this read in that case. So we implement
3759     # a read timeout.  If nothing is ready to read
3760     # by then, we return.
3761
3762     # Netscape seems to be a little bit unreliable
3763     # about providing boundary strings.
3764     my $boundary_read = 0;
3765     if ($boundary) {
3766
3767         # Under the MIME spec, the boundary consists of the
3768         # characters "--" PLUS the Boundary string
3769
3770         # BUG: IE 3.01 on the Macintosh uses just the boundary -- not
3771         # the two extra hyphens.  We do a special case here on the user-agent!!!!
3772         $boundary = "--$boundary" unless CGI::user_agent('MSIE\s+3\.0[12];\s*Mac|DreamPassport');
3773
3774     } else { # otherwise we find it ourselves
3775         my($old);
3776         ($old,$/) = ($/,$CRLF); # read a CRLF-delimited line
3777         $boundary = <STDIN>;      # BUG: This won't work correctly under mod_perl
3778         $length -= length($boundary);
3779         chomp($boundary);               # remove the CRLF
3780         $/ = $old;                      # restore old line separator
3781         $boundary_read++;
3782     }
3783
3784     my $self = {LENGTH=>$length,
3785                 CHUNKED=>!defined $length,
3786                 BOUNDARY=>$boundary,
3787                 INTERFACE=>$interface,
3788                 BUFFER=>'',
3789             };
3790
3791     $FILLUNIT = length($boundary)
3792         if length($boundary) > $FILLUNIT;
3793
3794     my $retval = bless $self,ref $package || $package;
3795
3796     # Read the preamble and the topmost (boundary) line plus the CRLF.
3797     unless ($boundary_read) {
3798       while ($self->read(0)) { }
3799     }
3800     die "Malformed multipart POST: data truncated\n" if $self->eof;
3801
3802     return $retval;
3803 }
3804 END_OF_FUNC
3805
3806 'readHeader' => <<'END_OF_FUNC',
3807 sub readHeader {
3808     my($self) = @_;
3809     my($end);
3810     my($ok) = 0;
3811     my($bad) = 0;
3812
3813     local($CRLF) = "\015\012" if $CGI::OS eq 'VMS' || $CGI::EBCDIC;
3814
3815     do {
3816         $self->fillBuffer($FILLUNIT);
3817         $ok++ if ($end = index($self->{BUFFER},"${CRLF}${CRLF}")) >= 0;
3818         $ok++ if $self->{BUFFER} eq '';
3819         $bad++ if !$ok && $self->{LENGTH} <= 0;
3820         # this was a bad idea
3821         # $FILLUNIT *= 2 if length($self->{BUFFER}) >= $FILLUNIT;
3822     } until $ok || $bad;
3823     return () if $bad;
3824
3825     #EBCDIC NOTE: translate header into EBCDIC, but watch out for continuation lines!
3826
3827     my($header) = substr($self->{BUFFER},0,$end+2);
3828     substr($self->{BUFFER},0,$end+4) = '';
3829     my %return;
3830
3831     if ($CGI::EBCDIC) {
3832       warn "untranslated header=$header\n" if DEBUG;
3833       $header = CGI::Util::ascii2ebcdic($header);
3834       warn "translated header=$header\n" if DEBUG;
3835     }
3836
3837     # See RFC 2045 Appendix A and RFC 822 sections 3.4.8
3838     #   (Folding Long Header Fields), 3.4.3 (Comments)
3839     #   and 3.4.5 (Quoted-Strings).
3840
3841     my $token = '[-\w!\#$%&\'*+.^_\`|{}~]';
3842     $header=~s/$CRLF\s+/ /og;           # merge continuation lines
3843
3844     while ($header=~/($token+):\s+([^$CRLF]*)/mgox) {
3845         my ($field_name,$field_value) = ($1,$2);
3846         $field_name =~ s/\b(\w)/uc($1)/eg; #canonicalize
3847         $return{$field_name}=$field_value;
3848     }
3849     return %return;
3850 }
3851 END_OF_FUNC
3852
3853 # This reads and returns the body as a single scalar value.
3854 'readBody' => <<'END_OF_FUNC',
3855 sub readBody {
3856     my($self) = @_;
3857     my($data);
3858     my($returnval)='';
3859
3860     #EBCDIC NOTE: want to translate returnval into EBCDIC HERE
3861
3862     while (defined($data = $self->read)) {
3863         $returnval .= $data;
3864     }
3865
3866     if ($CGI::EBCDIC) {
3867       warn "untranslated body=$returnval\n" if DEBUG;
3868       $returnval = CGI::Util::ascii2ebcdic($returnval);
3869       warn "translated body=$returnval\n"   if DEBUG;
3870     }
3871     return $returnval;
3872 }
3873 END_OF_FUNC
3874
3875 # This will read $bytes or until the boundary is hit, whichever happens
3876 # first.  After the boundary is hit, we return undef.  The next read will
3877 # skip over the boundary and begin reading again;
3878 'read' => <<'END_OF_FUNC',
3879 sub read {
3880     my($self,$bytes) = @_;
3881
3882     # default number of bytes to read
3883     $bytes = $bytes || $FILLUNIT;
3884
3885     # Fill up our internal buffer in such a way that the boundary
3886     # is never split between reads.
3887     $self->fillBuffer($bytes);
3888
3889     my $boundary_start = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY})      : $self->{BOUNDARY};
3890     my $boundary_end   = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY}.'--') : $self->{BOUNDARY}.'--';
3891
3892     # Find the boundary in the buffer (it may not be there).
3893     my $start = index($self->{BUFFER},$boundary_start);
3894
3895     warn "boundary=$self->{BOUNDARY} length=$self->{LENGTH} start=$start\n" if DEBUG;
3896
3897     # protect against malformed multipart POST operations
3898     die "Malformed multipart POST\n" unless $self->{CHUNKED} || ($start >= 0 || $self->{LENGTH} > 0);
3899
3900     #EBCDIC NOTE: want to translate boundary search into ASCII here.
3901
3902     # If the boundary begins the data, then skip past it
3903     # and return undef.
3904     if ($start == 0) {
3905
3906         # clear us out completely if we've hit the last boundary.
3907         if (index($self->{BUFFER},$boundary_end)==0) {
3908             $self->{BUFFER}='';
3909             $self->{LENGTH}=0;
3910             return undef;
3911         }
3912
3913         # just remove the boundary.
3914         substr($self->{BUFFER},0,length($boundary_start))='';
3915         $self->{BUFFER} =~ s/^\012\015?//;
3916         return undef;
3917     }
3918
3919     my $bytesToReturn;
3920     if ($start > 0) {           # read up to the boundary
3921         $bytesToReturn = $start-2 > $bytes ? $bytes : $start;
3922     } else {    # read the requested number of bytes
3923         # leave enough bytes in the buffer to allow us to read
3924         # the boundary.  Thanks to Kevin Hendrick for finding
3925         # this one.
3926         $bytesToReturn = $bytes - (length($boundary_start)+1);
3927     }
3928
3929     my $returnval=substr($self->{BUFFER},0,$bytesToReturn);
3930     substr($self->{BUFFER},0,$bytesToReturn)='';
3931
3932     # If we hit the boundary, remove the CRLF from the end.
3933     return ($bytesToReturn==$start)
3934            ? substr($returnval,0,-2) : $returnval;
3935 }
3936 END_OF_FUNC
3937
3938
3939 # This fills up our internal buffer in such a way that the
3940 # boundary is never split between reads
3941 'fillBuffer' => <<'END_OF_FUNC',
3942 sub fillBuffer {
3943     my($self,$bytes) = @_;
3944     return unless $self->{CHUNKED} || $self->{LENGTH};
3945
3946     my($boundaryLength) = length($self->{BOUNDARY});
3947     my($bufferLength) = length($self->{BUFFER});
3948     my($bytesToRead) = $bytes - $bufferLength + $boundaryLength + 2;
3949     $bytesToRead = $self->{LENGTH} if !$self->{CHUNKED} && $self->{LENGTH} < $bytesToRead;
3950
3951     # Try to read some data.  We may hang here if the browser is screwed up.
3952     my $bytesRead = $self->{INTERFACE}->read_from_client(\$self->{BUFFER},
3953                                                          $bytesToRead,
3954                                                          $bufferLength);
3955     warn "bytesToRead=$bytesToRead, bufferLength=$bufferLength, buffer=$self->{BUFFER}\n" if DEBUG;
3956     $self->{BUFFER} = '' unless defined $self->{BUFFER};
3957
3958     # An apparent bug in the Apache server causes the read()
3959     # to return zero bytes repeatedly without blocking if the
3960     # remote user aborts during a file transfer.  I don't know how
3961     # they manage this, but the workaround is to abort if we get
3962     # more than SPIN_LOOP_MAX consecutive zero reads.
3963     if ($bytesRead <= 0) {
3964         die  "CGI.pm: Server closed socket during multipart read (client aborted?).\n"
3965             if ($self->{ZERO_LOOP_COUNTER}++ >= $SPIN_LOOP_MAX);
3966     } else {
3967         $self->{ZERO_LOOP_COUNTER}=0;
3968     }
3969
3970     $self->{LENGTH} -= $bytesRead if !$self->{CHUNKED} && $bytesRead;
3971 }
3972 END_OF_FUNC
3973
3974
3975 # Return true when we've finished reading
3976 'eof' => <<'END_OF_FUNC'
3977 sub eof {
3978     my($self) = @_;
3979     return 1 if (length($self->{BUFFER}) == 0)
3980                  && ($self->{LENGTH} <= 0);
3981     undef;
3982 }
3983 END_OF_FUNC
3984
3985 );
3986 END_OF_AUTOLOAD
3987
3988 ####################################################################################
3989 ################################## TEMPORARY FILES #################################
3990 ####################################################################################
3991 package CGITempFile;
3992
3993 sub find_tempdir {
3994   $SL = $CGI::SL;
3995   $MAC = $CGI::OS eq 'MACINTOSH';
3996   my ($vol) = $MAC ? MacPerl::Volumes() =~ /:(.*)/ : "";
3997   unless (defined $TMPDIRECTORY) {
3998     @TEMP=("${SL}usr${SL}tmp","${SL}var${SL}tmp",
3999            "C:${SL}temp","${SL}tmp","${SL}temp",
4000            "${vol}${SL}Temporary Items",
4001            "${SL}WWW_ROOT", "${SL}SYS\$SCRATCH",
4002            "C:${SL}system${SL}temp");
4003     unshift(@TEMP,$ENV{'TMPDIR'}) if defined $ENV{'TMPDIR'};
4004
4005     # this feature was supposed to provide per-user tmpfiles, but
4006     # it is problematic.
4007     #    unshift(@TEMP,(getpwuid($<))[7].'/tmp') if $CGI::OS eq 'UNIX';
4008     # Rob: getpwuid() is unfortunately UNIX specific. On brain dead OS'es this
4009     #    : can generate a 'getpwuid() not implemented' exception, even though
4010     #    : it's never called.  Found under DOS/Win with the DJGPP perl port.
4011     #    : Refer to getpwuid() only at run-time if we're fortunate and have  UNIX.
4012     # unshift(@TEMP,(eval {(getpwuid($>))[7]}).'/tmp') if $CGI::OS eq 'UNIX' and $> != 0;
4013
4014     foreach (@TEMP) {
4015       do {$TMPDIRECTORY = $_; last} if -d $_ && -w _;
4016     }
4017   }
4018   $TMPDIRECTORY  = $MAC ? "" : "." unless $TMPDIRECTORY;
4019 }
4020
4021 find_tempdir();
4022
4023 $MAXTRIES = 5000;
4024
4025 # cute feature, but overload implementation broke it
4026 # %OVERLOAD = ('""'=>'as_string');
4027 *CGITempFile::AUTOLOAD = \&CGI::AUTOLOAD;
4028
4029 sub DESTROY {
4030     my($self) = @_;
4031     $$self =~ m!^([a-zA-Z0-9_ \'\":/.\$\\-]+)$! || return;
4032     my $safe = $1;             # untaint operation
4033     unlink $safe;              # get rid of the file
4034 }
4035
4036 ###############################################################################
4037 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
4038 ###############################################################################
4039 $AUTOLOADED_ROUTINES = '';      # prevent -w error
4040 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
4041 %SUBS = (
4042
4043 'new' => <<'END_OF_FUNC',
4044 sub new {
4045     my($package,$sequence) = @_;
4046     my $filename;
4047     find_tempdir() unless -w $TMPDIRECTORY;
4048     for (my $i = 0; $i < $MAXTRIES; $i++) {
4049         last if ! -f ($filename = sprintf("\%s${SL}CGItemp%d", $TMPDIRECTORY, $sequence++));
4050     }
4051     # check that it is a more-or-less valid filename
4052     return unless $filename =~ m!^([a-zA-Z0-9_\+ \'\":/.\$\\-]+)$!;
4053     # this used to untaint, now it doesn't
4054     # $filename = $1;
4055     return bless \$filename;
4056 }
4057 END_OF_FUNC
4058
4059 'as_string' => <<'END_OF_FUNC'
4060 sub as_string {
4061     my($self) = @_;
4062     return $$self;
4063 }
4064 END_OF_FUNC
4065
4066 );
4067 END_OF_AUTOLOAD
4068
4069 package CGI;
4070
4071 # We get a whole bunch of warnings about "possibly uninitialized variables"
4072 # when running with the -w switch.  Touch them all once to get rid of the
4073 # warnings.  This is ugly and I hate it.
4074 if ($^W) {
4075     $CGI::CGI = '';
4076     $CGI::CGI=<<EOF;
4077     $CGI::VERSION;
4078     $MultipartBuffer::SPIN_LOOP_MAX;
4079     $MultipartBuffer::CRLF;
4080     $MultipartBuffer::TIMEOUT;
4081     $MultipartBuffer::INITIAL_FILLUNIT;
4082 EOF
4083     ;
4084 }
4085
4086 1;
4087
4088 __END__
4089
4090 =head1 NAME
4091
4092 CGI - Simple Common Gateway Interface Class
4093
4094 =head1 SYNOPSIS
4095
4096   # CGI script that creates a fill-out form
4097   # and echoes back its values.
4098
4099   use CGI qw/:standard/;
4100   print header,
4101         start_html('A Simple Example'),
4102         h1('A Simple Example'),
4103         start_form,
4104         "What's your name? ",textfield('name'),p,
4105         "What's the combination?", p,
4106         checkbox_group(-name=>'words',
4107                        -values=>['eenie','meenie','minie','moe'],
4108                        -defaults=>['eenie','minie']), p,
4109         "What's your favorite color? ",
4110         popup_menu(-name=>'color',
4111                    -values=>['red','green','blue','chartreuse']),p,
4112         submit,
4113         end_form,
4114         hr;
4115
4116    if (param()) {
4117        my $name      = param('name');
4118        my $keywords  = join ', ',param('words');
4119        my $color     = param('color');
4120        print "Your name is",em(escapeHTML($name)),p,
4121              "The keywords are: ",em(escapeHTML($keywords)),p,
4122              "Your favorite color is ",em(escapeHTML($color)),
4123              hr;
4124    }
4125
4126    print end_html;
4127
4128 =head1 ABSTRACT
4129
4130 This perl library uses perl5 objects to make it easy to create Web
4131 fill-out forms and parse their contents.  This package defines CGI
4132 objects, entities that contain the values of the current query string
4133 and other state variables.  Using a CGI object's methods, you can
4134 examine keywords and parameters passed to your script, and create
4135 forms whose initial values are taken from the current query (thereby
4136 preserving state information).  The module provides shortcut functions
4137 that produce boilerplate HTML, reducing typing and coding errors. It
4138 also provides functionality for some of the more advanced features of
4139 CGI scripting, including support for file uploads, cookies, cascading
4140 style sheets, server push, and frames.
4141
4142 CGI.pm also provides a simple function-oriented programming style for
4143 those who don't need its object-oriented features.
4144
4145 The current version of CGI.pm is available at
4146
4147   http://www.genome.wi.mit.edu/ftp/pub/software/WWW/cgi_docs.html
4148   ftp://ftp-genome.wi.mit.edu/pub/software/WWW/
4149
4150 =head1 DESCRIPTION
4151
4152 =head2 PROGRAMMING STYLE
4153
4154 There are two styles of programming with CGI.pm, an object-oriented
4155 style and a function-oriented style.  In the object-oriented style you
4156 create one or more CGI objects and then use object methods to create
4157 the various elements of the page.  Each CGI object starts out with the
4158 list of named parameters that were passed to your CGI script by the
4159 server.  You can modify the objects, save them to a file or database
4160 and recreate them.  Because each object corresponds to the "state" of
4161 the CGI script, and because each object's parameter list is
4162 independent of the others, this allows you to save the state of the
4163 script and restore it later.
4164
4165 For example, using the object oriented style, here is how you create
4166 a simple "Hello World" HTML page:
4167
4168    #!/usr/local/bin/perl -w
4169    use CGI;                             # load CGI routines
4170    $q = new CGI;                        # create new CGI object
4171    print $q->header,                    # create the HTTP header
4172          $q->start_html('hello world'), # start the HTML
4173          $q->h1('hello world'),         # level 1 header
4174          $q->end_html;                  # end the HTML
4175
4176 In the function-oriented style, there is one default CGI object that
4177 you rarely deal with directly.  Instead you just call functions to
4178 retrieve CGI parameters, create HTML tags, manage cookies, and so
4179 on.  This provides you with a cleaner programming interface, but
4180 limits you to using one CGI object at a time.  The following example
4181 prints the same page, but uses the function-oriented interface.
4182 The main differences are that we now need to import a set of functions
4183 into our name space (usually the "standard" functions), and we don't
4184 need to create the CGI object.
4185
4186    #!/usr/local/bin/perl
4187    use CGI qw/:standard/;           # load standard CGI routines
4188    print header,                    # create the HTTP header
4189          start_html('hello world'), # start the HTML
4190          h1('hello world'),         # level 1 header
4191          end_html;                  # end the HTML
4192
4193 The examples in this document mainly use the object-oriented style.
4194 See HOW TO IMPORT FUNCTIONS for important information on
4195 function-oriented programming in CGI.pm
4196
4197 =head2 CALLING CGI.PM ROUTINES
4198
4199 Most CGI.pm routines accept several arguments, sometimes as many as 20
4200 optional ones!  To simplify this interface, all routines use a named
4201 argument calling style that looks like this:
4202
4203    print $q->header(-type=>'image/gif',-expires=>'+3d');
4204
4205 Each argument name is preceded by a dash.  Neither case nor order
4206 matters in the argument list.  -type, -Type, and -TYPE are all
4207 acceptable.  In fact, only the first argument needs to begin with a
4208 dash.  If a dash is present in the first argument, CGI.pm assumes
4209 dashes for the subsequent ones.
4210
4211 Several routines are commonly called with just one argument.  In the
4212 case of these routines you can provide the single argument without an
4213 argument name.  header() happens to be one of these routines.  In this
4214 case, the single argument is the document type.
4215
4216    print $q->header('text/html');
4217
4218 Other such routines are documented below.
4219
4220 Sometimes named arguments expect a scalar, sometimes a reference to an
4221 array, and sometimes a reference to a hash.  Often, you can pass any
4222 type of argument and the routine will do whatever is most appropriate.
4223 For example, the param() routine is used to set a CGI parameter to a
4224 single or a multi-valued value.  The two cases are shown below:
4225
4226    $q->param(-name=>'veggie',-value=>'tomato');
4227    $q->param(-name=>'veggie',-value=>['tomato','tomahto','potato','potahto']);
4228
4229 A large number of routines in CGI.pm actually aren't specifically
4230 defined in the module, but are generated automatically as needed.
4231 These are the "HTML shortcuts," routines that generate HTML tags for
4232 use in dynamically-generated pages.  HTML tags have both attributes
4233 (the attribute="value" pairs within the tag itself) and contents (the
4234 part between the opening and closing pairs.)  To distinguish between
4235 attributes and contents, CGI.pm uses the convention of passing HTML
4236 attributes as a hash reference as the first argument, and the
4237 contents, if any, as any subsequent arguments.  It works out like
4238 this:
4239
4240    Code                           Generated HTML
4241    ----                           --------------
4242    h1()                           <h1>
4243    h1('some','contents');         <h1>some contents</h1>
4244    h1({-align=>left});            <h1 align="LEFT">
4245    h1({-align=>left},'contents'); <h1 align="LEFT">contents</h1>
4246
4247 HTML tags are described in more detail later.
4248
4249 Many newcomers to CGI.pm are puzzled by the difference between the
4250 calling conventions for the HTML shortcuts, which require curly braces
4251 around the HTML tag attributes, and the calling conventions for other
4252 routines, which manage to generate attributes without the curly
4253 brackets.  Don't be confused.  As a convenience the curly braces are
4254 optional in all but the HTML shortcuts.  If you like, you can use
4255 curly braces when calling any routine that takes named arguments.  For
4256 example:
4257
4258    print $q->header( {-type=>'image/gif',-expires=>'+3d'} );
4259
4260 If you use the B<-w> switch, you will be warned that some CGI.pm argument
4261 names conflict with built-in Perl functions.  The most frequent of
4262 these is the -values argument, used to create multi-valued menus,
4263 radio button clusters and the like.  To get around this warning, you
4264 have several choices:
4265
4266 =over 4
4267
4268 =item 1.
4269
4270 Use another name for the argument, if one is available.
4271 For example, -value is an alias for -values.
4272
4273 =item 2.
4274
4275 Change the capitalization, e.g. -Values
4276
4277 =item 3.
4278
4279 Put quotes around the argument name, e.g. '-values'
4280
4281 =back
4282
4283 Many routines will do something useful with a named argument that it
4284 doesn't recognize.  For example, you can produce non-standard HTTP
4285 header fields by providing them as named arguments:
4286
4287   print $q->header(-type  =>  'text/html',
4288                    -cost  =>  'Three smackers',
4289                    -annoyance_level => 'high',
4290                    -complaints_to   => 'bit bucket');
4291
4292 This will produce the following nonstandard HTTP header:
4293
4294    HTTP/1.0 200 OK
4295    Cost: Three smackers
4296    Annoyance-level: high
4297    Complaints-to: bit bucket
4298    Content-type: text/html
4299
4300 Notice the way that underscores are translated automatically into
4301 hyphens.  HTML-generating routines perform a different type of
4302 translation.
4303
4304 This feature allows you to keep up with the rapidly changing HTTP and
4305 HTML "standards".
4306
4307 =head2 CREATING A NEW QUERY OBJECT (OBJECT-ORIENTED STYLE):
4308
4309      $query = new CGI;
4310
4311 This will parse the input (from both POST and GET methods) and store
4312 it into a perl5 object called $query.
4313
4314 Any filehandles from file uploads will have their position reset to
4315 the beginning of the file.
4316
4317 =head2 CREATING A NEW QUERY OBJECT FROM AN INPUT FILE
4318
4319      $query = new CGI(INPUTFILE);
4320
4321 If you provide a file handle to the new() method, it will read
4322 parameters from the file (or STDIN, or whatever).  The file can be in
4323 any of the forms describing below under debugging (i.e. a series of
4324 newline delimited TAG=VALUE pairs will work).  Conveniently, this type
4325 of file is created by the save() method (see below).  Multiple records
4326 can be saved and restored.
4327
4328 Perl purists will be pleased to know that this syntax accepts
4329 references to file handles, or even references to filehandle globs,
4330 which is the "official" way to pass a filehandle:
4331
4332     $query = new CGI(\*STDIN);
4333
4334 You can also initialize the CGI object with a FileHandle or IO::File
4335 object.
4336
4337 If you are using the function-oriented interface and want to
4338 initialize CGI state from a file handle, the way to do this is with
4339 B<restore_parameters()>.  This will (re)initialize the
4340 default CGI object from the indicated file handle.
4341
4342     open (IN,"test.in") || die;
4343     restore_parameters(IN);
4344     close IN;
4345
4346 You can also initialize the query object from an associative array
4347 reference:
4348
4349     $query = new CGI( {'dinosaur'=>'barney',
4350                        'song'=>'I love you',
4351                        'friends'=>[qw/Jessica George Nancy/]}
4352                     );
4353
4354 or from a properly formatted, URL-escaped query string:
4355
4356     $query = new CGI('dinosaur=barney&color=purple');
4357
4358 or from a previously existing CGI object (currently this clones the
4359 parameter list, but none of the other object-specific fields, such as
4360 autoescaping):
4361
4362     $old_query = new CGI;
4363     $new_query = new CGI($old_query);
4364
4365 To create an empty query, initialize it from an empty string or hash:
4366
4367    $empty_query = new CGI("");
4368
4369        -or-
4370
4371    $empty_query = new CGI({});
4372
4373 =head2 FETCHING A LIST OF KEYWORDS FROM THE QUERY:
4374
4375      @keywords = $query->keywords
4376
4377 If the script was invoked as the result of an <ISINDEX> search, the
4378 parsed keywords can be obtained as an array using the keywords() method.
4379
4380 =head2 FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT:
4381
4382      @names = $query->param
4383
4384 If the script was invoked with a parameter list
4385 (e.g. "name1=value1&name2=value2&name3=value3"), the param() method
4386 will return the parameter names as a list.  If the script was invoked
4387 as an <ISINDEX> script and contains a string without ampersands
4388 (e.g. "value1+value2+value3") , there will be a single parameter named
4389 "keywords" containing the "+"-delimited keywords.
4390
4391 NOTE: As of version 1.5, the array of parameter names returned will
4392 be in the same order as they were submitted by the browser.
4393 Usually this order is the same as the order in which the
4394 parameters are defined in the form (however, this isn't part
4395 of the spec, and so isn't guaranteed).
4396
4397 =head2 FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER:
4398
4399     @values = $query->param('foo');
4400
4401               -or-
4402
4403     $value = $query->param('foo');
4404
4405 Pass the param() method a single argument to fetch the value of the
4406 named parameter. If the parameter is multivalued (e.g. from multiple
4407 selections in a scrolling list), you can ask to receive an array.  Otherwise
4408 the method will return a single value.
4409
4410 If a value is not given in the query string, as in the queries
4411 "name1=&name2=" or "name1&name2", it will be returned as an empty
4412 string.  This feature is new in 2.63.
4413
4414
4415 If the parameter does not exist at all, then param() will return undef
4416 in a scalar context, and the empty list in a list context.
4417
4418
4419 =head2 SETTING THE VALUE(S) OF A NAMED PARAMETER:
4420
4421     $query->param('foo','an','array','of','values');
4422
4423 This sets the value for the named parameter 'foo' to an array of
4424 values.  This is one way to change the value of a field AFTER
4425 the script has been invoked once before.  (Another way is with
4426 the -override parameter accepted by all methods that generate
4427 form elements.)
4428
4429 param() also recognizes a named parameter style of calling described
4430 in more detail later:
4431
4432     $query->param(-name=>'foo',-values=>['an','array','of','values']);
4433
4434                               -or-
4435
4436     $query->param(-name=>'foo',-value=>'the value');
4437
4438 =head2 APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER:
4439
4440    $query->append(-name=>'foo',-values=>['yet','more','values']);
4441
4442 This adds a value or list of values to the named parameter.  The
4443 values are appended to the end of the parameter if it already exists.
4444 Otherwise the parameter is created.  Note that this method only
4445 recognizes the named argument calling syntax.
4446
4447 =head2 IMPORTING ALL PARAMETERS INTO A NAMESPACE:
4448
4449    $query->import_names('R');
4450
4451 This creates a series of variables in the 'R' namespace.  For example,
4452 $R::foo, @R:foo.  For keyword lists, a variable @R::keywords will appear.
4453 If no namespace is given, this method will assume 'Q'.
4454 WARNING:  don't import anything into 'main'; this is a major security
4455 risk!!!!
4456
4457 NOTE 1: Variable names are transformed as necessary into legal Perl
4458 variable names.  All non-legal characters are transformed into
4459 underscores.  If you need to keep the original names, you should use
4460 the param() method instead to access CGI variables by name.
4461
4462 NOTE 2: In older versions, this method was called B<import()>.  As of version 2.20,
4463 this name has been removed completely to avoid conflict with the built-in
4464 Perl module B<import> operator.
4465
4466 =head2 DELETING A PARAMETER COMPLETELY:
4467
4468     $query->delete('foo','bar','baz');
4469
4470 This completely clears a list of parameters.  It sometimes useful for
4471 resetting parameters that you don't want passed down between script
4472 invocations.
4473
4474 If you are using the function call interface, use "Delete()" instead
4475 to avoid conflicts with Perl's built-in delete operator.
4476
4477 =head2 DELETING ALL PARAMETERS:
4478
4479    $query->delete_all();
4480
4481 This clears the CGI object completely.  It might be useful to ensure
4482 that all the defaults are taken when you create a fill-out form.
4483
4484 Use Delete_all() instead if you are using the function call interface.
4485
4486 =head2 HANDLING NON-URLENCODED ARGUMENTS
4487
4488
4489 If POSTed data is not of type application/x-www-form-urlencoded or
4490 multipart/form-data, then the POSTed data will not be processed, but
4491 instead be returned as-is in a parameter named POSTDATA.  To retrieve
4492 it, use code like this:
4493
4494    my $data = $query->param('POSTDATA');
4495
4496 Likewise if PUTed data can be retrieved with code like this:
4497
4498    my $data = $query->param('PUTDATA');
4499
4500 (If you don't know what the preceding means, don't worry about it.  It
4501 only affects people trying to use CGI for XML processing and other
4502 specialized tasks.)
4503
4504
4505 =head2 DIRECT ACCESS TO THE PARAMETER LIST:
4506
4507    $q->param_fetch('address')->[1] = '1313 Mockingbird Lane';
4508    unshift @{$q->param_fetch(-name=>'address')},'George Munster';
4509
4510 If you need access to the parameter list in a way that isn't covered
4511 by the methods above, you can obtain a direct reference to it by
4512 calling the B<param_fetch()> method with the name of the .  This
4513 will return an array reference to the named parameters, which you then
4514 can manipulate in any way you like.
4515
4516 You can also use a named argument style using the B<-name> argument.
4517
4518 =head2 FETCHING THE PARAMETER LIST AS A HASH:
4519
4520     $params = $q->Vars;
4521     print $params->{'address'};
4522     @foo = split("\0",$params->{'foo'});
4523     %params = $q->Vars;
4524
4525     use CGI ':cgi-lib';
4526     $params = Vars;
4527
4528 Many people want to fetch the entire parameter list as a hash in which
4529 the keys are the names of the CGI parameters, and the values are the
4530 parameters' values.  The Vars() method does this.  Called in a scalar
4531 context, it returns the parameter list as a tied hash reference.
4532 Changing a key changes the value of the parameter in the underlying
4533 CGI parameter list.  Called in a list context, it returns the
4534 parameter list as an ordinary hash.  This allows you to read the
4535 contents of the parameter list, but not to change it.
4536
4537 When using this, the thing you must watch out for are multivalued CGI
4538 parameters.  Because a hash cannot distinguish between scalar and
4539 list context, multivalued parameters will be returned as a packed
4540 string, separated by the "\0" (null) character.  You must split this
4541 packed string in order to get at the individual values.  This is the
4542 convention introduced long ago by Steve Brenner in his cgi-lib.pl
4543 module for Perl version 4.
4544
4545 If you wish to use Vars() as a function, import the I<:cgi-lib> set of
4546 function calls (also see the section on CGI-LIB compatibility).
4547
4548 =head2 SAVING THE STATE OF THE SCRIPT TO A FILE:
4549
4550     $query->save(\*FILEHANDLE)
4551
4552 This will write the current state of the form to the provided
4553 filehandle.  You can read it back in by providing a filehandle
4554 to the new() method.  Note that the filehandle can be a file, a pipe,
4555 or whatever!
4556
4557 The format of the saved file is:
4558
4559         NAME1=VALUE1
4560         NAME1=VALUE1'
4561         NAME2=VALUE2
4562         NAME3=VALUE3
4563         =
4564
4565 Both name and value are URL escaped.  Multi-valued CGI parameters are
4566 represented as repeated names.  A session record is delimited by a
4567 single = symbol.  You can write out multiple records and read them
4568 back in with several calls to B<new>.  You can do this across several
4569 sessions by opening the file in append mode, allowing you to create
4570 primitive guest books, or to keep a history of users' queries.  Here's
4571 a short example of creating multiple session records:
4572
4573    use CGI;
4574
4575    open (OUT,">>test.out") || die;
4576    $records = 5;
4577    foreach (0..$records) {
4578        my $q = new CGI;
4579        $q->param(-name=>'counter',-value=>$_);
4580        $q->save(\*OUT);
4581    }
4582    close OUT;
4583
4584    # reopen for reading
4585    open (IN,"test.out") || die;
4586    while (!eof(IN)) {
4587        my $q = new CGI(\*IN);
4588        print $q->param('counter'),"\n";
4589    }
4590
4591 The file format used for save/restore is identical to that used by the
4592 Whitehead Genome Center's data exchange format "Boulderio", and can be
4593 manipulated and even databased using Boulderio utilities.  See
4594
4595   http://stein.cshl.org/boulder/
4596
4597 for further details.
4598
4599 If you wish to use this method from the function-oriented (non-OO)
4600 interface, the exported name for this method is B<save_parameters()>.
4601
4602 =head2 RETRIEVING CGI ERRORS
4603
4604 Errors can occur while processing user input, particularly when
4605 processing uploaded files.  When these errors occur, CGI will stop
4606 processing and return an empty parameter list.  You can test for
4607 the existence and nature of errors using the I<cgi_error()> function.
4608 The error messages are formatted as HTTP status codes. You can either
4609 incorporate the error text into an HTML page, or use it as the value
4610 of the HTTP status:
4611
4612     my $error = $q->cgi_error;
4613     if ($error) {
4614         print $q->header(-status=>$error),
4615               $q->start_html('Problems'),
4616               $q->h2('Request not processed'),
4617               $q->strong($error);
4618         exit 0;
4619     }
4620
4621 When using the function-oriented interface (see the next section),
4622 errors may only occur the first time you call I<param()>. Be ready
4623 for this!
4624
4625 =head2 USING THE FUNCTION-ORIENTED INTERFACE
4626
4627 To use the function-oriented interface, you must specify which CGI.pm
4628 routines or sets of routines to import into your script's namespace.
4629 There is a small overhead associated with this importation, but it
4630 isn't much.
4631
4632    use CGI <list of methods>;
4633
4634 The listed methods will be imported into the current package; you can
4635 call them directly without creating a CGI object first.  This example
4636 shows how to import the B<param()> and B<header()>
4637 methods, and then use them directly:
4638
4639    use CGI 'param','header';
4640    print header('text/plain');
4641    $zipcode = param('zipcode');
4642
4643 More frequently, you'll import common sets of functions by referring
4644 to the groups by name.  All function sets are preceded with a ":"
4645 character as in ":html3" (for tags defined in the HTML 3 standard).
4646
4647 Here is a list of the function sets you can import:
4648
4649 =over 4
4650
4651 =item B<:cgi>
4652
4653 Import all CGI-handling methods, such as B<param()>, B<path_info()>
4654 and the like.
4655
4656 =item B<:form>
4657
4658 Import all fill-out form generating methods, such as B<textfield()>.
4659
4660 =item B<:html2>
4661
4662 Import all methods that generate HTML 2.0 standard elements.
4663
4664 =item B<:html3>
4665
4666 Import all methods that generate HTML 3.0 elements (such as
4667 <table>, <super> and <sub>).
4668
4669 =item B<:html4>
4670
4671 Import all methods that generate HTML 4 elements (such as
4672 <abbrev>, <acronym> and <thead>).
4673
4674 =item B<:netscape>
4675
4676 Import all methods that generate Netscape-specific HTML extensions.
4677
4678 =item B<:html>
4679
4680 Import all HTML-generating shortcuts (i.e. 'html2' + 'html3' +
4681 'netscape')...
4682
4683 =item B<:standard>
4684
4685 Import "standard" features, 'html2', 'html3', 'html4', 'form' and 'cgi'.
4686
4687 =item B<:all>
4688
4689 Import all the available methods.  For the full list, see the CGI.pm
4690 code, where the variable %EXPORT_TAGS is defined.
4691
4692 =back
4693
4694 If you import a function name that is not part of CGI.pm, the module
4695 will treat it as a new HTML tag and generate the appropriate
4696 subroutine.  You can then use it like any other HTML tag.  This is to
4697 provide for the rapidly-evolving HTML "standard."  For example, say
4698 Microsoft comes out with a new tag called <gradient> (which causes the
4699 user's desktop to be flooded with a rotating gradient fill until his
4700 machine reboots).  You don't need to wait for a new version of CGI.pm
4701 to start using it immediately:
4702
4703    use CGI qw/:standard :html3 gradient/;
4704    print gradient({-start=>'red',-end=>'blue'});
4705
4706 Note that in the interests of execution speed CGI.pm does B<not> use
4707 the standard L<Exporter> syntax for specifying load symbols.  This may
4708 change in the future.
4709
4710 If you import any of the state-maintaining CGI or form-generating
4711 methods, a default CGI object will be created and initialized
4712 automatically the first time you use any of the methods that require
4713 one to be present.  This includes B<param()>, B<textfield()>,
4714 B<submit()> and the like.  (If you need direct access to the CGI
4715 object, you can find it in the global variable B<$CGI::Q>).  By
4716 importing CGI.pm methods, you can create visually elegant scripts:
4717
4718    use CGI qw/:standard/;
4719    print
4720        header,
4721        start_html('Simple Script'),
4722        h1('Simple Script'),
4723        start_form,
4724        "What's your name? ",textfield('name'),p,
4725        "What's the combination?",
4726        checkbox_group(-name=>'words',
4727                       -values=>['eenie','meenie','minie','moe'],
4728                       -defaults=>['eenie','moe']),p,
4729        "What's your favorite color?",
4730        popup_menu(-name=>'color',
4731                   -values=>['red','green','blue','chartreuse']),p,
4732        submit,
4733        end_form,
4734        hr,"\n";
4735
4736     if (param) {
4737        print
4738            "Your name is ",em(param('name')),p,
4739            "The keywords are: ",em(join(", ",param('words'))),p,
4740            "Your favorite color is ",em(param('color')),".\n";
4741     }
4742     print end_html;
4743
4744 =head2 PRAGMAS
4745
4746 In addition to the function sets, there are a number of pragmas that
4747 you can import.  Pragmas, which are always preceded by a hyphen,
4748 change the way that CGI.pm functions in various ways.  Pragmas,
4749 function sets, and individual functions can all be imported in the
4750 same use() line.  For example, the following use statement imports the
4751 standard set of functions and enables debugging mode (pragma
4752 -debug):
4753
4754    use CGI qw/:standard -debug/;
4755
4756 The current list of pragmas is as follows:
4757
4758 =over 4
4759
4760 =item -any
4761
4762 When you I<use CGI -any>, then any method that the query object
4763 doesn't recognize will be interpreted as a new HTML tag.  This allows
4764 you to support the next I<ad hoc> Netscape or Microsoft HTML
4765 extension.  This lets you go wild with new and unsupported tags:
4766
4767    use CGI qw(-any);
4768    $q=new CGI;
4769    print $q->gradient({speed=>'fast',start=>'red',end=>'blue'});
4770
4771 Since using <cite>any</cite> causes any mistyped method name
4772 to be interpreted as an HTML tag, use it with care or not at
4773 all.
4774
4775 =item -compile
4776
4777 This causes the indicated autoloaded methods to be compiled up front,
4778 rather than deferred to later.  This is useful for scripts that run
4779 for an extended period of time under FastCGI or mod_perl, and for
4780 those destined to be crunched by Malcolm Beattie's Perl compiler.  Use
4781 it in conjunction with the methods or method families you plan to use.
4782
4783    use CGI qw(-compile :standard :html3);
4784
4785 or even
4786
4787    use CGI qw(-compile :all);
4788
4789 Note that using the -compile pragma in this way will always have
4790 the effect of importing the compiled functions into the current
4791 namespace.  If you want to compile without importing use the
4792 compile() method instead:
4793
4794    use CGI();
4795    CGI->compile();
4796
4797 This is particularly useful in a mod_perl environment, in which you
4798 might want to precompile all CGI routines in a startup script, and
4799 then import the functions individually in each mod_perl script.
4800
4801 =item -nosticky
4802
4803 By default the CGI module implements a state-preserving behavior
4804 called "sticky" fields.  The way this works is that if you are
4805 regenerating a form, the methods that generate the form field values
4806 will interrogate param() to see if similarly-named parameters are
4807 present in the query string. If they find a like-named parameter, they
4808 will use it to set their default values.
4809
4810 Sometimes this isn't what you want.  The B<-nosticky> pragma prevents
4811 this behavior.  You can also selectively change the sticky behavior in
4812 each element that you generate.
4813
4814 =item -tabindex
4815
4816 Automatically add tab index attributes to each form field. With this
4817 option turned off, you can still add tab indexes manually by passing a
4818 -tabindex option to each field-generating method.
4819
4820 =item -no_undef_params
4821
4822 This keeps CGI.pm from including undef params in the parameter list.
4823
4824 =item -no_xhtml
4825
4826 By default, CGI.pm versions 2.69 and higher emit XHTML
4827 (http://www.w3.org/TR/xhtml1/).  The -no_xhtml pragma disables this
4828 feature.  Thanks to Michalis Kabrianis <kabrianis@hellug.gr> for this
4829 feature.
4830
4831 If start_html()'s -dtd parameter specifies an HTML 2.0 or 3.2 DTD,
4832 XHTML will automatically be disabled without needing to use this
4833 pragma.
4834
4835 =item -utf8
4836
4837 This makes CGI.pm treat all parameters as UTF-8 strings. Use this with
4838 care, as it will interfere with the processing of binary uploads. It
4839 is better to manually select which fields are expected to return utf-8
4840 strings and convert them using code like this:
4841
4842  use Encode;
4843  my $arg = decode utf8=>param('foo');
4844
4845 =item -nph
4846
4847 This makes CGI.pm produce a header appropriate for an NPH (no
4848 parsed header) script.  You may need to do other things as well
4849 to tell the server that the script is NPH.  See the discussion
4850 of NPH scripts below.
4851
4852 =item -newstyle_urls
4853
4854 Separate the name=value pairs in CGI parameter query strings with
4855 semicolons rather than ampersands.  For example:
4856
4857    ?name=fred;age=24;favorite_color=3
4858
4859 Semicolon-delimited query strings are always accepted, but will not be
4860 emitted by self_url() and query_string() unless the -newstyle_urls
4861 pragma is specified.
4862
4863 This became the default in version 2.64.
4864
4865 =item -oldstyle_urls
4866
4867 Separate the name=value pairs in CGI parameter query strings with
4868 ampersands rather than semicolons.  This is no longer the default.
4869
4870 =item -autoload
4871
4872 This overrides the autoloader so that any function in your program
4873 that is not recognized is referred to CGI.pm for possible evaluation.
4874 This allows you to use all the CGI.pm functions without adding them to
4875 your symbol table, which is of concern for mod_perl users who are
4876 worried about memory consumption.  I<Warning:> when
4877 I<-autoload> is in effect, you cannot use "poetry mode"
4878 (functions without the parenthesis).  Use I<hr()> rather
4879 than I<hr>, or add something like I<use subs qw/hr p header/>
4880 to the top of your script.
4881
4882 =item -no_debug
4883
4884 This turns off the command-line processing features.  If you want to
4885 run a CGI.pm script from the command line to produce HTML, and you
4886 don't want it to read CGI parameters from the command line or STDIN,
4887 then use this pragma:
4888
4889    use CGI qw(-no_debug :standard);
4890
4891 =item -debug
4892
4893 This turns on full debugging.  In addition to reading CGI arguments
4894 from the command-line processing, CGI.pm will pause and try to read
4895 arguments from STDIN, producing the message "(offline mode: enter
4896 name=value pairs on standard input)" features.
4897
4898 See the section on debugging for more details.
4899
4900 =item -private_tempfiles
4901
4902 CGI.pm can process uploaded file. Ordinarily it spools the uploaded
4903 file to a temporary directory, then deletes the file when done.
4904 However, this opens the risk of eavesdropping as described in the file
4905 upload section.  Another CGI script author could peek at this data
4906 during the upload, even if it is confidential information. On Unix
4907 systems, the -private_tempfiles pragma will cause the temporary file
4908 to be unlinked as soon as it is opened and before any data is written
4909 into it, reducing, but not eliminating the risk of eavesdropping
4910 (there is still a potential race condition).  To make life harder for
4911 the attacker, the program chooses tempfile names by calculating a 32
4912 bit checksum of the incoming HTTP headers.
4913
4914 To ensure that the temporary file cannot be read by other CGI scripts,
4915 use suEXEC or a CGI wrapper program to run your script.  The temporary
4916 file is created with mode 0600 (neither world nor group readable).
4917
4918 The temporary directory is selected using the following algorithm:
4919
4920     1. if the current user (e.g. "nobody") has a directory named
4921     "tmp" in its home directory, use that (Unix systems only).
4922
4923     2. if the environment variable TMPDIR exists, use the location
4924     indicated.
4925
4926     3. Otherwise try the locations /usr/tmp, /var/tmp, C:\temp,
4927     /tmp, /temp, ::Temporary Items, and \WWW_ROOT.
4928
4929 Each of these locations is checked that it is a directory and is
4930 writable.  If not, the algorithm tries the next choice.
4931
4932 =back
4933
4934 =head2 SPECIAL FORMS FOR IMPORTING HTML-TAG FUNCTIONS
4935
4936 Many of the methods generate HTML tags.  As described below, tag
4937 functions automatically generate both the opening and closing tags.
4938 For example:
4939
4940   print h1('Level 1 Header');
4941
4942 produces
4943
4944   <h1>Level 1 Header</h1>
4945
4946 There will be some times when you want to produce the start and end
4947 tags yourself.  In this case, you can use the form start_I<tag_name>
4948 and end_I<tag_name>, as in:
4949
4950   print start_h1,'Level 1 Header',end_h1;
4951
4952 With a few exceptions (described below), start_I<tag_name> and
4953 end_I<tag_name> functions are not generated automatically when you
4954 I<use CGI>.  However, you can specify the tags you want to generate
4955 I<start/end> functions for by putting an asterisk in front of their
4956 name, or, alternatively, requesting either "start_I<tag_name>" or
4957 "end_I<tag_name>" in the import list.
4958
4959 Example:
4960
4961   use CGI qw/:standard *table start_ul/;
4962
4963 In this example, the following functions are generated in addition to
4964 the standard ones:
4965
4966 =over 4
4967
4968 =item 1. start_table() (generates a <table> tag)
4969
4970 =item 2. end_table() (generates a </table> tag)
4971
4972 =item 3. start_ul() (generates a <ul> tag)
4973
4974 =item 4. end_ul() (generates a </ul> tag)
4975
4976 =back
4977
4978 =head1 GENERATING DYNAMIC DOCUMENTS
4979
4980 Most of CGI.pm's functions deal with creating documents on the fly.
4981 Generally you will produce the HTTP header first, followed by the
4982 document itself.  CGI.pm provides functions for generating HTTP
4983 headers of various types as well as for generating HTML.  For creating
4984 GIF images, see the GD.pm module.
4985
4986 Each of these functions produces a fragment of HTML or HTTP which you
4987 can print out directly so that it displays in the browser window,
4988 append to a string, or save to a file for later use.
4989
4990 =head2 CREATING A STANDARD HTTP HEADER:
4991
4992 Normally the first thing you will do in any CGI script is print out an
4993 HTTP header.  This tells the browser what type of document to expect,
4994 and gives other optional information, such as the language, expiration
4995 date, and whether to cache the document.  The header can also be
4996 manipulated for special purposes, such as server push and pay per view
4997 pages.
4998
4999         print header;
5000
5001              -or-
5002
5003         print header('image/gif');
5004
5005              -or-
5006
5007         print header('text/html','204 No response');
5008
5009              -or-
5010
5011         print header(-type=>'image/gif',
5012                              -nph=>1,
5013                              -status=>'402 Payment required',
5014                              -expires=>'+3d',
5015                              -cookie=>$cookie,
5016                              -charset=>'utf-7',
5017                              -attachment=>'foo.gif',
5018                              -Cost=>'$2.00');
5019
5020 header() returns the Content-type: header.  You can provide your own
5021 MIME type if you choose, otherwise it defaults to text/html.  An
5022 optional second parameter specifies the status code and a human-readable
5023 message.  For example, you can specify 204, "No response" to create a
5024 script that tells the browser to do nothing at all.
5025
5026 The last example shows the named argument style for passing arguments
5027 to the CGI methods using named parameters.  Recognized parameters are
5028 B<-type>, B<-status>, B<-expires>, and B<-cookie>.  Any other named
5029 parameters will be stripped of their initial hyphens and turned into
5030 header fields, allowing you to specify any HTTP header you desire.
5031 Internal underscores will be turned into hyphens:
5032
5033     print header(-Content_length=>3002);
5034
5035 Most browsers will not cache the output from CGI scripts.  Every time
5036 the browser reloads the page, the script is invoked anew.  You can
5037 change this behavior with the B<-expires> parameter.  When you specify
5038 an absolute or relative expiration interval with this parameter, some
5039 browsers and proxy servers will cache the script's output until the
5040 indicated expiration date.  The following forms are all valid for the
5041 -expires field:
5042
5043         +30s                              30 seconds from now
5044         +10m                              ten minutes from now
5045         +1h                               one hour from now
5046         -1d                               yesterday (i.e. "ASAP!")
5047         now                               immediately
5048         +3M                               in three months
5049         +10y                              in ten years time
5050         Thursday, 25-Apr-1999 00:40:33 GMT  at the indicated time & date
5051
5052 The B<-cookie> parameter generates a header that tells the browser to provide
5053 a "magic cookie" during all subsequent transactions with your script.
5054 Netscape cookies have a special format that includes interesting attributes
5055 such as expiration time.  Use the cookie() method to create and retrieve
5056 session cookies.
5057
5058 The B<-nph> parameter, if set to a true value, will issue the correct
5059 headers to work with a NPH (no-parse-header) script.  This is important
5060 to use with certain servers that expect all their scripts to be NPH.
5061
5062 The B<-charset> parameter can be used to control the character set
5063 sent to the browser.  If not provided, defaults to ISO-8859-1.  As a
5064 side effect, this sets the charset() method as well.
5065
5066 The B<-attachment> parameter can be used to turn the page into an
5067 attachment.  Instead of displaying the page, some browsers will prompt
5068 the user to save it to disk.  The value of the argument is the
5069 suggested name for the saved file.  In order for this to work, you may
5070 have to set the B<-type> to "application/octet-stream".
5071
5072 The B<-p3p> parameter will add a P3P tag to the outgoing header.  The
5073 parameter can be an arrayref or a space-delimited string of P3P tags.
5074 For example:
5075
5076    print header(-p3p=>[qw(CAO DSP LAW CURa)]);
5077    print header(-p3p=>'CAO DSP LAW CURa');
5078
5079 In either case, the outgoing header will be formatted as:
5080
5081   P3P: policyref="/w3c/p3p.xml" cp="CAO DSP LAW CURa"
5082
5083 =head2 GENERATING A REDIRECTION HEADER
5084
5085    print redirect('http://somewhere.else/in/movie/land');
5086
5087 Sometimes you don't want to produce a document yourself, but simply
5088 redirect the browser elsewhere, perhaps choosing a URL based on the
5089 time of day or the identity of the user.
5090
5091 The redirect() function redirects the browser to a different URL.  If
5092 you use redirection like this, you should B<not> print out a header as
5093 well.
5094
5095 You should always use full URLs (including the http: or ftp: part) in
5096 redirection requests.  Relative URLs will not work correctly.
5097
5098 You can also use named arguments:
5099
5100     print redirect(-uri=>'http://somewhere.else/in/movie/land',
5101                            -nph=>1,
5102                            -status=>301);
5103
5104 The B<-nph> parameter, if set to a true value, will issue the correct
5105 headers to work with a NPH (no-parse-header) script.  This is important
5106 to use with certain servers, such as Microsoft IIS, which
5107 expect all their scripts to be NPH.
5108
5109 The B<-status> parameter will set the status of the redirect.  HTTP
5110 defines three different possible redirection status codes:
5111
5112      301 Moved Permanently
5113      302 Found
5114      303 See Other
5115
5116 The default if not specified is 302, which means "moved temporarily."
5117 You may change the status to another status code if you wish.  Be
5118 advised that changing the status to anything other than 301, 302 or
5119 303 will probably break redirection.
5120
5121 =head2 CREATING THE HTML DOCUMENT HEADER
5122
5123    print start_html(-title=>'Secrets of the Pyramids',
5124                             -author=>'fred@capricorn.org',
5125                             -base=>'true',
5126                             -target=>'_blank',
5127                             -meta=>{'keywords'=>'pharaoh secret mummy',
5128                                     'copyright'=>'copyright 1996 King Tut'},
5129                             -style=>{'src'=>'/styles/style1.css'},
5130                             -BGCOLOR=>'blue');
5131
5132 After creating the HTTP header, most CGI scripts will start writing
5133 out an HTML document.  The start_html() routine creates the top of the
5134 page, along with a lot of optional information that controls the
5135 page's appearance and behavior.
5136
5137 This method returns a canned HTML header and the opening <body> tag.
5138 All parameters are optional.  In the named parameter form, recognized
5139 parameters are -title, -author, -base, -xbase, -dtd, -lang and -target
5140 (see below for the explanation).  Any additional parameters you
5141 provide, such as the Netscape unofficial BGCOLOR attribute, are added
5142 to the <body> tag.  Additional parameters must be proceeded by a
5143 hyphen.
5144
5145 The argument B<-xbase> allows you to provide an HREF for the <base> tag
5146 different from the current location, as in
5147
5148     -xbase=>"http://home.mcom.com/"
5149
5150 All relative links will be interpreted relative to this tag.
5151
5152 The argument B<-target> allows you to provide a default target frame
5153 for all the links and fill-out forms on the page.  B<This is a
5154 non-standard HTTP feature which only works with Netscape browsers!>
5155 See the Netscape documentation on frames for details of how to
5156 manipulate this.
5157
5158     -target=>"answer_window"
5159
5160 All relative links will be interpreted relative to this tag.
5161 You add arbitrary meta information to the header with the B<-meta>
5162 argument.  This argument expects a reference to an associative array
5163 containing name/value pairs of meta information.  These will be turned
5164 into a series of header <meta> tags that look something like this:
5165
5166     <meta name="keywords" content="pharaoh secret mummy">
5167     <meta name="description" content="copyright 1996 King Tut">
5168
5169 To create an HTTP-EQUIV type of <meta> tag, use B<-head>, described
5170 below.
5171
5172 The B<-style> argument is used to incorporate cascading stylesheets
5173 into your code.  See the section on CASCADING STYLESHEETS for more
5174 information.
5175
5176 The B<-lang> argument is used to incorporate a language attribute into
5177 the <html> tag.  For example:
5178
5179     print $q->start_html(-lang=>'fr-CA');
5180
5181 The default if not specified is "en-US" for US English, unless the
5182 -dtd parameter specifies an HTML 2.0 or 3.2 DTD, in which case the
5183 lang attribute is left off.  You can force the lang attribute to left
5184 off in other cases by passing an empty string (-lang=>'').
5185
5186 The B<-encoding> argument can be used to specify the character set for
5187 XHTML.  It defaults to iso-8859-1 if not specified.
5188
5189 The B<-declare_xml> argument, when used in conjunction with XHTML,
5190 will put a <?xml> declaration at the top of the HTML header. The sole
5191 purpose of this declaration is to declare the character set
5192 encoding. In the absence of -declare_xml, the output HTML will contain
5193 a <meta> tag that specifies the encoding, allowing the HTML to pass
5194 most validators.  The default for -declare_xml is false.
5195
5196 You can place other arbitrary HTML elements to the <head> section with the
5197 B<-head> tag.  For example, to place the rarely-used <link> element in the
5198 head section, use this:
5199
5200     print start_html(-head=>Link({-rel=>'next',
5201                                   -href=>'http://www.capricorn.com/s2.html'}));
5202
5203 To incorporate multiple HTML elements into the <head> section, just pass an
5204 array reference:
5205
5206     print start_html(-head=>[
5207                              Link({-rel=>'next',
5208                                    -href=>'http://www.capricorn.com/s2.html'}),
5209                              Link({-rel=>'previous',
5210                                    -href=>'http://www.capricorn.com/s1.html'})
5211                              ]
5212                      );
5213
5214 And here's how to create an HTTP-EQUIV <meta> tag:
5215
5216       print start_html(-head=>meta({-http_equiv => 'Content-Type',
5217                                     -content    => 'text/html'}))
5218
5219
5220 JAVASCRIPTING: The B<-script>, B<-noScript>, B<-onLoad>,
5221 B<-onMouseOver>, B<-onMouseOut> and B<-onUnload> parameters are used
5222 to add Netscape JavaScript calls to your pages.  B<-script> should
5223 point to a block of text containing JavaScript function definitions.
5224 This block will be placed within a <script> block inside the HTML (not
5225 HTTP) header.  The block is placed in the header in order to give your
5226 page a fighting chance of having all its JavaScript functions in place
5227 even if the user presses the stop button before the page has loaded
5228 completely.  CGI.pm attempts to format the script in such a way that
5229 JavaScript-naive browsers will not choke on the code: unfortunately
5230 there are some browsers, such as Chimera for Unix, that get confused
5231 by it nevertheless.
5232
5233 The B<-onLoad> and B<-onUnload> parameters point to fragments of JavaScript
5234 code to execute when the page is respectively opened and closed by the
5235 browser.  Usually these parameters are calls to functions defined in the
5236 B<-script> field:
5237
5238       $query = new CGI;
5239       print header;
5240       $JSCRIPT=<<END;
5241       // Ask a silly question
5242       function riddle_me_this() {
5243          var r = prompt("What walks on four legs in the morning, " +
5244                        "two legs in the afternoon, " +
5245                        "and three legs in the evening?");
5246          response(r);
5247       }
5248       // Get a silly answer
5249       function response(answer) {
5250          if (answer == "man")
5251             alert("Right you are!");
5252          else
5253             alert("Wrong!  Guess again.");
5254       }
5255       END
5256       print start_html(-title=>'The Riddle of the Sphinx',
5257                                -script=>$JSCRIPT);
5258
5259 Use the B<-noScript> parameter to pass some HTML text that will be displayed on
5260 browsers that do not have JavaScript (or browsers where JavaScript is turned
5261 off).
5262
5263 The <script> tag, has several attributes including "type" and src.
5264 The latter is particularly interesting, as it allows you to keep the
5265 JavaScript code in a file or CGI script rather than cluttering up each
5266 page with the source.  To use these attributes pass a HASH reference
5267 in the B<-script> parameter containing one or more of -type, -src, or
5268 -code:
5269
5270     print $q->start_html(-title=>'The Riddle of the Sphinx',
5271                          -script=>{-type=>'JAVASCRIPT',
5272                                    -src=>'/javascript/sphinx.js'}
5273                          );
5274
5275     print $q->(-title=>'The Riddle of the Sphinx',
5276                -script=>{-type=>'PERLSCRIPT',
5277                          -code=>'print "hello world!\n;"'}
5278                );
5279
5280
5281 A final feature allows you to incorporate multiple <script> sections into the
5282 header.  Just pass the list of script sections as an array reference.
5283 this allows you to specify different source files for different dialects
5284 of JavaScript.  Example:
5285
5286      print $q->start_html(-title=>'The Riddle of the Sphinx',
5287                           -script=>[
5288                                     { -type => 'text/javascript',
5289                                       -src      => '/javascript/utilities10.js'
5290                                     },
5291                                     { -type => 'text/javascript',
5292                                       -src      => '/javascript/utilities11.js'
5293                                     },
5294                                     { -type => 'text/jscript',
5295                                       -src      => '/javascript/utilities12.js'
5296                                     },
5297                                     { -type => 'text/ecmascript',
5298                                       -src      => '/javascript/utilities219.js'
5299                                     }
5300                                  ]
5301                              );
5302
5303 The option "-language" is a synonym for -type, and is supported for
5304 backwad compatibility.
5305
5306 The old-style positional parameters are as follows:
5307
5308 =over 4
5309
5310 =item B<Parameters:>
5311
5312 =item 1.
5313
5314 The title
5315
5316 =item 2.
5317
5318 The author's e-mail address (will create a <link rev="MADE"> tag if present
5319
5320 =item 3.
5321
5322 A 'true' flag if you want to include a <base> tag in the header.  This
5323 helps resolve relative addresses to absolute ones when the document is moved,
5324 but makes the document hierarchy non-portable.  Use with care!
5325
5326 =item 4, 5, 6...
5327
5328 Any other parameters you want to include in the <body> tag.  This is a good
5329 place to put Netscape extensions, such as colors and wallpaper patterns.
5330
5331 =back
5332
5333 =head2 ENDING THE HTML DOCUMENT:
5334
5335         print end_html
5336
5337 This ends an HTML document by printing the </body></html> tags.
5338
5339 =head2 CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION:
5340
5341     $myself = self_url;
5342     print q(<a href="$myself">I'm talking to myself.</a>);
5343
5344 self_url() will return a URL, that, when selected, will reinvoke
5345 this script with all its state information intact.  This is most
5346 useful when you want to jump around within the document using
5347 internal anchors but you don't want to disrupt the current contents
5348 of the form(s).  Something like this will do the trick.
5349
5350      $myself = self_url;
5351      print "<a href=\"$myself#table1\">See table 1</a>";
5352      print "<a href=\"$myself#table2\">See table 2</a>";
5353      print "<a href=\"$myself#yourself\">See for yourself</a>";
5354
5355 If you want more control over what's returned, using the B<url()>
5356 method instead.
5357
5358 You can also retrieve the unprocessed query string with query_string():
5359
5360     $the_string = query_string;
5361
5362 =head2 OBTAINING THE SCRIPT'S URL
5363
5364     $full_url      = url();
5365     $full_url      = url(-full=>1);  #alternative syntax
5366     $relative_url  = url(-relative=>1);
5367     $absolute_url  = url(-absolute=>1);
5368     $url_with_path = url(-path_info=>1);
5369     $url_with_path_and_query = url(-path_info=>1,-query=>1);
5370     $netloc        = url(-base => 1);
5371
5372 B<url()> returns the script's URL in a variety of formats.  Called
5373 without any arguments, it returns the full form of the URL, including
5374 host name and port number
5375
5376     http://your.host.com/path/to/script.cgi
5377
5378 You can modify this format with the following named arguments:
5379
5380 =over 4
5381
5382 =item B<-absolute>
5383
5384 If true, produce an absolute URL, e.g.
5385
5386     /path/to/script.cgi
5387
5388 =item B<-relative>
5389
5390 Produce a relative URL.  This is useful if you want to reinvoke your
5391 script with different parameters. For example:
5392
5393     script.cgi
5394
5395 =item B<-full>
5396
5397 Produce the full URL, exactly as if called without any arguments.
5398 This overrides the -relative and -absolute arguments.
5399
5400 =item B<-path> (B<-path_info>)
5401
5402 Append the additional path information to the URL.  This can be
5403 combined with B<-full>, B<-absolute> or B<-relative>.  B<-path_info>
5404 is provided as a synonym.
5405
5406 =item B<-query> (B<-query_string>)
5407
5408 Append the query string to the URL.  This can be combined with
5409 B<-full>, B<-absolute> or B<-relative>.  B<-query_string> is provided
5410 as a synonym.
5411
5412 =item B<-base>
5413
5414 Generate just the protocol and net location, as in http://www.foo.com:8000
5415
5416 =item B<-rewrite>
5417
5418 If Apache's mod_rewrite is turned on, then the script name and path
5419 info probably won't match the request that the user sent. Set
5420 -rewrite=>1 (default) to return URLs that match what the user sent
5421 (the original request URI). Set -rewrite=>0 to return URLs that match
5422 the URL after mod_rewrite's rules have run. Because the additional
5423 path information only makes sense in the context of the rewritten URL,
5424 -rewrite is set to false when you request path info in the URL.
5425
5426 =back
5427
5428 =head2 MIXING POST AND URL PARAMETERS
5429
5430    $color = url_param('color');
5431
5432 It is possible for a script to receive CGI parameters in the URL as
5433 well as in the fill-out form by creating a form that POSTs to a URL
5434 containing a query string (a "?" mark followed by arguments).  The
5435 B<param()> method will always return the contents of the POSTed
5436 fill-out form, ignoring the URL's query string.  To retrieve URL
5437 parameters, call the B<url_param()> method.  Use it in the same way as
5438 B<param()>.  The main difference is that it allows you to read the
5439 parameters, but not set them.
5440
5441
5442 Under no circumstances will the contents of the URL query string
5443 interfere with similarly-named CGI parameters in POSTed forms.  If you
5444 try to mix a URL query string with a form submitted with the GET
5445 method, the results will not be what you expect.
5446
5447 =head1 CREATING STANDARD HTML ELEMENTS:
5448
5449 CGI.pm defines general HTML shortcut methods for most, if not all of
5450 the HTML 3 and HTML 4 tags.  HTML shortcuts are named after a single
5451 HTML element and return a fragment of HTML text that you can then
5452 print or manipulate as you like.  Each shortcut returns a fragment of
5453 HTML code that you can append to a string, save to a file, or, most
5454 commonly, print out so that it displays in the browser window.
5455
5456 This example shows how to use the HTML methods:
5457
5458    print $q->blockquote(
5459                      "Many years ago on the island of",
5460                      $q->a({href=>"http://crete.org/"},"Crete"),
5461                      "there lived a Minotaur named",
5462                      $q->strong("Fred."),
5463                     ),
5464        $q->hr;
5465
5466 This results in the following HTML code (extra newlines have been
5467 added for readability):
5468
5469    <blockquote>
5470    Many years ago on the island of
5471    <a href="http://crete.org/">Crete</a> there lived
5472    a minotaur named <strong>Fred.</strong>
5473    </blockquote>
5474    <hr>
5475
5476 If you find the syntax for calling the HTML shortcuts awkward, you can
5477 import them into your namespace and dispense with the object syntax
5478 completely (see the next section for more details):
5479
5480    use CGI ':standard';
5481    print blockquote(
5482       "Many years ago on the island of",
5483       a({href=>"http://crete.org/"},"Crete"),
5484       "there lived a minotaur named",
5485       strong("Fred."),
5486       ),
5487       hr;
5488
5489 =head2 PROVIDING ARGUMENTS TO HTML SHORTCUTS
5490
5491 The HTML methods will accept zero, one or multiple arguments.  If you
5492 provide no arguments, you get a single tag:
5493
5494    print hr;    #  <hr>
5495
5496 If you provide one or more string arguments, they are concatenated
5497 together with spaces and placed between opening and closing tags:
5498
5499    print h1("Chapter","1"); # <h1>Chapter 1</h1>"
5500
5501 If the first argument is an associative array reference, then the keys
5502 and values of the associative array become the HTML tag's attributes:
5503
5504    print a({-href=>'fred.html',-target=>'_new'},
5505       "Open a new frame");
5506
5507             <a href="fred.html",target="_new">Open a new frame</a>
5508
5509 You may dispense with the dashes in front of the attribute names if
5510 you prefer:
5511
5512    print img {src=>'fred.gif',align=>'LEFT'};
5513
5514            <img align="LEFT" src="fred.gif">
5515
5516 Sometimes an HTML tag attribute has no argument.  For example, ordered
5517 lists can be marked as COMPACT.  The syntax for this is an argument that
5518 that points to an undef string:
5519
5520    print ol({compact=>undef},li('one'),li('two'),li('three'));
5521
5522 Prior to CGI.pm version 2.41, providing an empty ('') string as an
5523 attribute argument was the same as providing undef.  However, this has
5524 changed in order to accommodate those who want to create tags of the form
5525 <img alt="">.  The difference is shown in these two pieces of code:
5526
5527    CODE                   RESULT
5528    img({alt=>undef})      <img alt>
5529    img({alt=>''})         <img alt="">
5530
5531 =head2 THE DISTRIBUTIVE PROPERTY OF HTML SHORTCUTS
5532
5533 One of the cool features of the HTML shortcuts is that they are
5534 distributive.  If you give them an argument consisting of a
5535 B<reference> to a list, the tag will be distributed across each
5536 element of the list.  For example, here's one way to make an ordered
5537 list:
5538
5539    print ul(
5540              li({-type=>'disc'},['Sneezy','Doc','Sleepy','Happy'])
5541            );
5542
5543 This example will result in HTML output that looks like this:
5544
5545    <ul>
5546      <li type="disc">Sneezy</li>
5547      <li type="disc">Doc</li>
5548      <li type="disc">Sleepy</li>
5549      <li type="disc">Happy</li>
5550    </ul>
5551
5552 This is extremely useful for creating tables.  For example:
5553
5554    print table({-border=>undef},
5555            caption('When Should You Eat Your Vegetables?'),
5556            Tr({-align=>CENTER,-valign=>TOP},
5557            [
5558               th(['Vegetable', 'Breakfast','Lunch','Dinner']),
5559               td(['Tomatoes' , 'no', 'yes', 'yes']),
5560               td(['Broccoli' , 'no', 'no',  'yes']),
5561               td(['Onions'   , 'yes','yes', 'yes'])
5562            ]
5563            )
5564         );
5565
5566 =head2 HTML SHORTCUTS AND LIST INTERPOLATION
5567
5568 Consider this bit of code:
5569
5570    print blockquote(em('Hi'),'mom!'));
5571
5572 It will ordinarily return the string that you probably expect, namely:
5573
5574    <blockquote><em>Hi</em> mom!</blockquote>
5575
5576 Note the space between the element "Hi" and the element "mom!".
5577 CGI.pm puts the extra space there using array interpolation, which is
5578 controlled by the magic $" variable.  Sometimes this extra space is
5579 not what you want, for example, when you are trying to align a series
5580 of images.  In this case, you can simply change the value of $" to an
5581 empty string.
5582
5583    {
5584       local($") = '';
5585       print blockquote(em('Hi'),'mom!'));
5586     }
5587
5588 I suggest you put the code in a block as shown here.  Otherwise the
5589 change to $" will affect all subsequent code until you explicitly
5590 reset it.
5591
5592 =head2 NON-STANDARD HTML SHORTCUTS
5593
5594 A few HTML tags don't follow the standard pattern for various
5595 reasons.
5596
5597 B<comment()> generates an HTML comment (<!-- comment -->).  Call it
5598 like
5599
5600     print comment('here is my comment');
5601
5602 Because of conflicts with built-in Perl functions, the following functions
5603 begin with initial caps:
5604
5605     Select
5606     Tr
5607     Link
5608     Delete
5609     Accept
5610     Sub
5611
5612 In addition, start_html(), end_html(), start_form(), end_form(),
5613 start_multipart_form() and all the fill-out form tags are special.
5614 See their respective sections.
5615
5616 =head2 AUTOESCAPING HTML
5617
5618 By default, all HTML that is emitted by the form-generating functions
5619 is passed through a function called escapeHTML():
5620
5621 =over 4
5622
5623 =item $escaped_string = escapeHTML("unescaped string");
5624
5625 Escape HTML formatting characters in a string.
5626
5627 =back
5628
5629 Provided that you have specified a character set of ISO-8859-1 (the
5630 default), the standard HTML escaping rules will be used.  The "<"
5631 character becomes "&lt;", ">" becomes "&gt;", "&" becomes "&amp;", and
5632 the quote character becomes "&quot;".  In addition, the hexadecimal
5633 0x8b and 0x9b characters, which some browsers incorrectly interpret
5634 as the left and right angle-bracket characters, are replaced by their
5635 numeric character entities ("&#8249" and "&#8250;").  If you manually change
5636 the charset, either by calling the charset() method explicitly or by
5637 passing a -charset argument to header(), then B<all> characters will
5638 be replaced by their numeric entities, since CGI.pm has no lookup
5639 table for all the possible encodings.
5640
5641 The automatic escaping does not apply to other shortcuts, such as
5642 h1().  You should call escapeHTML() yourself on untrusted data in
5643 order to protect your pages against nasty tricks that people may enter
5644 into guestbooks, etc..  To change the character set, use charset().
5645 To turn autoescaping off completely, use autoEscape(0):
5646
5647 =over 4
5648
5649 =item $charset = charset([$charset]);
5650
5651 Get or set the current character set.
5652
5653 =item $flag = autoEscape([$flag]);
5654
5655 Get or set the value of the autoescape flag.
5656
5657 =back
5658
5659 =head2 PRETTY-PRINTING HTML
5660
5661 By default, all the HTML produced by these functions comes out as one
5662 long line without carriage returns or indentation. This is yuck, but
5663 it does reduce the size of the documents by 10-20%.  To get
5664 pretty-printed output, please use L<CGI::Pretty>, a subclass
5665 contributed by Brian Paulsen.
5666
5667 =head1 CREATING FILL-OUT FORMS:
5668
5669 I<General note>  The various form-creating methods all return strings
5670 to the caller, containing the tag or tags that will create the requested
5671 form element.  You are responsible for actually printing out these strings.
5672 It's set up this way so that you can place formatting tags
5673 around the form elements.
5674
5675 I<Another note> The default values that you specify for the forms are only
5676 used the B<first> time the script is invoked (when there is no query
5677 string).  On subsequent invocations of the script (when there is a query
5678 string), the former values are used even if they are blank.
5679
5680 If you want to change the value of a field from its previous value, you have two
5681 choices:
5682
5683 (1) call the param() method to set it.
5684
5685 (2) use the -override (alias -force) parameter (a new feature in version 2.15).
5686 This forces the default value to be used, regardless of the previous value:
5687
5688    print textfield(-name=>'field_name',
5689                            -default=>'starting value',
5690                            -override=>1,
5691                            -size=>50,
5692                            -maxlength=>80);
5693
5694 I<Yet another note> By default, the text and labels of form elements are
5695 escaped according to HTML rules.  This means that you can safely use
5696 "<CLICK ME>" as the label for a button.  However, it also interferes with
5697 your ability to incorporate special HTML character sequences, such as &Aacute;,
5698 into your fields.  If you wish to turn off automatic escaping, call the
5699 autoEscape() method with a false value immediately after creating the CGI object:
5700
5701    $query = new CGI;
5702    autoEscape(undef);
5703
5704 I<A Lurking Trap!> Some of the form-element generating methods return
5705 multiple tags.  In a scalar context, the tags will be concatenated
5706 together with spaces, or whatever is the current value of the $"
5707 global.  In a list context, the methods will return a list of
5708 elements, allowing you to modify them if you wish.  Usually you will
5709 not notice this behavior, but beware of this:
5710
5711     printf("%s\n",end_form())
5712
5713 end_form() produces several tags, and only the first of them will be
5714 printed because the format only expects one value.
5715
5716 <p>
5717
5718
5719 =head2 CREATING AN ISINDEX TAG
5720
5721    print isindex(-action=>$action);
5722
5723          -or-
5724
5725    print isindex($action);
5726
5727 Prints out an <isindex> tag.  Not very exciting.  The parameter
5728 -action specifies the URL of the script to process the query.  The
5729 default is to process the query with the current script.
5730
5731 =head2 STARTING AND ENDING A FORM
5732
5733     print start_form(-method=>$method,
5734                     -action=>$action,
5735                     -enctype=>$encoding);
5736       <... various form stuff ...>
5737     print endform;
5738
5739         -or-
5740
5741     print start_form($method,$action,$encoding);
5742       <... various form stuff ...>
5743     print endform;
5744
5745 start_form() will return a <form> tag with the optional method,
5746 action and form encoding that you specify.  The defaults are:
5747
5748     method: POST
5749     action: this script
5750     enctype: application/x-www-form-urlencoded
5751
5752 endform() returns the closing </form> tag.
5753
5754 Start_form()'s enctype argument tells the browser how to package the various
5755 fields of the form before sending the form to the server.  Two
5756 values are possible:
5757
5758 B<Note:> This method was previously named startform(), and startform()
5759 is still recognized as an alias.
5760
5761 =over 4
5762
5763 =item B<application/x-www-form-urlencoded>
5764
5765 This is the older type of encoding used by all browsers prior to
5766 Netscape 2.0.  It is compatible with many CGI scripts and is
5767 suitable for short fields containing text data.  For your
5768 convenience, CGI.pm stores the name of this encoding
5769 type in B<&CGI::URL_ENCODED>.
5770
5771 =item B<multipart/form-data>
5772
5773 This is the newer type of encoding introduced by Netscape 2.0.
5774 It is suitable for forms that contain very large fields or that
5775 are intended for transferring binary data.  Most importantly,
5776 it enables the "file upload" feature of Netscape 2.0 forms.  For
5777 your convenience, CGI.pm stores the name of this encoding type
5778 in B<&CGI::MULTIPART>
5779
5780 Forms that use this type of encoding are not easily interpreted
5781 by CGI scripts unless they use CGI.pm or another library designed
5782 to handle them.
5783
5784 If XHTML is activated (the default), then forms will be automatically
5785 created using this type of encoding.
5786
5787 =back
5788
5789 For compatibility, the start_form() method uses the older form of
5790 encoding by default.  If you want to use the newer form of encoding
5791 by default, you can call B<start_multipart_form()> instead of
5792 B<start_form()>.
5793
5794 JAVASCRIPTING: The B<-name> and B<-onSubmit> parameters are provided
5795 for use with JavaScript.  The -name parameter gives the
5796 form a name so that it can be identified and manipulated by
5797 JavaScript functions.  -onSubmit should point to a JavaScript
5798 function that will be executed just before the form is submitted to your
5799 server.  You can use this opportunity to check the contents of the form
5800 for consistency and completeness.  If you find something wrong, you
5801 can put up an alert box or maybe fix things up yourself.  You can
5802 abort the submission by returning false from this function.
5803
5804 Usually the bulk of JavaScript functions are defined in a <script>
5805 block in the HTML header and -onSubmit points to one of these function
5806 call.  See start_html() for details.
5807
5808 =head2 FORM ELEMENTS
5809
5810 After starting a form, you will typically create one or more
5811 textfields, popup menus, radio groups and other form elements.  Each
5812 of these elements takes a standard set of named arguments.  Some
5813 elements also have optional arguments.  The standard arguments are as
5814 follows:
5815
5816 =over 4
5817
5818 =item B<-name>
5819
5820 The name of the field. After submission this name can be used to
5821 retrieve the field's value using the param() method.
5822
5823 =item B<-value>, B<-values>
5824
5825 The initial value of the field which will be returned to the script
5826 after form submission.  Some form elements, such as text fields, take
5827 a single scalar -value argument. Others, such as popup menus, take a
5828 reference to an array of values. The two arguments are synonyms.
5829
5830 =item B<-tabindex>
5831
5832 A numeric value that sets the order in which the form element receives
5833 focus when the user presses the tab key. Elements with lower values
5834 receive focus first.
5835
5836 =item B<-id>
5837
5838 A string identifier that can be used to identify this element to
5839 JavaScript and DHTML.
5840
5841 =item B<-override>
5842
5843 A boolean, which, if true, forces the element to take on the value
5844 specified by B<-value>, overriding the sticky behavior described
5845 earlier for the B<-no_sticky> pragma.
5846
5847 =item B<-onChange>, B<-onFocus>, B<-onBlur>, B<-onMouseOver>, B<-onMouseOut>, B<-onSelect>
5848
5849 These are used to assign JavaScript event handlers. See the
5850 JavaScripting section for more details.
5851
5852 =back
5853
5854 Other common arguments are described in the next section. In addition
5855 to these, all attributes described in the HTML specifications are
5856 supported.
5857
5858 =head2 CREATING A TEXT FIELD
5859
5860     print textfield(-name=>'field_name',
5861                     -value=>'starting value',
5862                     -size=>50,
5863                     -maxlength=>80);
5864         -or-
5865
5866     print textfield('field_name','starting value',50,80);
5867
5868 textfield() will return a text input field.
5869
5870 =over 4
5871
5872 =item B<Parameters>
5873
5874 =item 1.
5875
5876 The first parameter is the required name for the field (-name).
5877
5878 =item 2.
5879
5880 The optional second parameter is the default starting value for the field
5881 contents (-value, formerly known as -default).
5882
5883 =item 3.
5884
5885 The optional third parameter is the size of the field in
5886       characters (-size).
5887
5888 =item 4.
5889
5890 The optional fourth parameter is the maximum number of characters the
5891       field will accept (-maxlength).
5892
5893 =back
5894
5895 As with all these methods, the field will be initialized with its
5896 previous contents from earlier invocations of the script.
5897 When the form is processed, the value of the text field can be
5898 retrieved with:
5899
5900        $value = param('foo');
5901
5902 If you want to reset it from its initial value after the script has been
5903 called once, you can do so like this:
5904
5905        param('foo',"I'm taking over this value!");
5906
5907 =head2 CREATING A BIG TEXT FIELD
5908
5909    print textarea(-name=>'foo',
5910                           -default=>'starting value',
5911                           -rows=>10,
5912                           -columns=>50);
5913
5914         -or
5915
5916    print textarea('foo','starting value',10,50);
5917
5918 textarea() is just like textfield, but it allows you to specify
5919 rows and columns for a multiline text entry box.  You can provide
5920 a starting value for the field, which can be long and contain
5921 multiple lines.
5922
5923 =head2 CREATING A PASSWORD FIELD
5924
5925    print password_field(-name=>'secret',
5926                                 -value=>'starting value',
5927                                 -size=>50,
5928                                 -maxlength=>80);
5929         -or-
5930
5931    print password_field('secret','starting value',50,80);
5932
5933 password_field() is identical to textfield(), except that its contents
5934 will be starred out on the web page.
5935
5936 =head2 CREATING A FILE UPLOAD FIELD
5937
5938     print filefield(-name=>'uploaded_file',
5939                             -default=>'starting value',
5940                             -size=>50,
5941                             -maxlength=>80);
5942         -or-
5943
5944     print filefield('uploaded_file','starting value',50,80);
5945
5946 filefield() will return a file upload field for Netscape 2.0 browsers.
5947 In order to take full advantage of this I<you must use the new
5948 multipart encoding scheme> for the form.  You can do this either
5949 by calling B<start_form()> with an encoding type of B<&CGI::MULTIPART>,
5950 or by calling the new method B<start_multipart_form()> instead of
5951 vanilla B<start_form()>.
5952
5953 =over 4
5954
5955 =item B<Parameters>
5956
5957 =item 1.
5958
5959 The first parameter is the required name for the field (-name).
5960
5961 =item 2.
5962
5963 The optional second parameter is the starting value for the field contents
5964 to be used as the default file name (-default).
5965
5966 For security reasons, browsers don't pay any attention to this field,
5967 and so the starting value will always be blank.  Worse, the field
5968 loses its "sticky" behavior and forgets its previous contents.  The
5969 starting value field is called for in the HTML specification, however,
5970 and possibly some browser will eventually provide support for it.
5971
5972 =item 3.
5973
5974 The optional third parameter is the size of the field in
5975 characters (-size).
5976
5977 =item 4.
5978
5979 The optional fourth parameter is the maximum number of characters the
5980 field will accept (-maxlength).
5981
5982 =back
5983
5984 When the form is processed, you can retrieve the entered filename
5985 by calling param():
5986
5987        $filename = param('uploaded_file');
5988
5989 Different browsers will return slightly different things for the
5990 name.  Some browsers return the filename only.  Others return the full
5991 path to the file, using the path conventions of the user's machine.
5992 Regardless, the name returned is always the name of the file on the
5993 I<user's> machine, and is unrelated to the name of the temporary file
5994 that CGI.pm creates during upload spooling (see below).
5995
5996 The filename returned is also a file handle.  You can read the contents
5997 of the file using standard Perl file reading calls:
5998
5999         # Read a text file and print it out
6000         while (<$filename>) {
6001            print;
6002         }
6003
6004         # Copy a binary file to somewhere safe
6005         open (OUTFILE,">>/usr/local/web/users/feedback");
6006         while ($bytesread=read($filename,$buffer,1024)) {
6007            print OUTFILE $buffer;
6008         }
6009
6010 However, there are problems with the dual nature of the upload fields.
6011 If you C<use strict>, then Perl will complain when you try to use a
6012 string as a filehandle.  You can get around this by placing the file
6013 reading code in a block containing the C<no strict> pragma.  More
6014 seriously, it is possible for the remote user to type garbage into the
6015 upload field, in which case what you get from param() is not a
6016 filehandle at all, but a string.
6017
6018 To be safe, use the I<upload()> function (new in version 2.47).  When
6019 called with the name of an upload field, I<upload()> returns a
6020 filehandle, or undef if the parameter is not a valid filehandle.
6021
6022      $fh = upload('uploaded_file');
6023      while (<$fh>) {
6024            print;
6025      }
6026
6027 In an list context, upload() will return an array of filehandles.
6028 This makes it possible to create forms that use the same name for
6029 multiple upload fields.
6030
6031 This is the recommended idiom.
6032
6033 For robust code, consider reseting the file handle position to beginning of the
6034 file. Inside of larger frameworks, other code may have already used the query
6035 object and changed the filehandle postion:
6036
6037   seek($fh,0,0); # reset postion to beginning of file.
6038
6039 When a file is uploaded the browser usually sends along some
6040 information along with it in the format of headers.  The information
6041 usually includes the MIME content type.  Future browsers may send
6042 other information as well (such as modification date and size). To
6043 retrieve this information, call uploadInfo().  It returns a reference to
6044 an associative array containing all the document headers.
6045
6046        $filename = param('uploaded_file');
6047        $type = uploadInfo($filename)->{'Content-Type'};
6048        unless ($type eq 'text/html') {
6049           die "HTML FILES ONLY!";
6050        }
6051
6052 If you are using a machine that recognizes "text" and "binary" data
6053 modes, be sure to understand when and how to use them (see the Camel book).
6054 Otherwise you may find that binary files are corrupted during file
6055 uploads.
6056
6057 There are occasionally problems involving parsing the uploaded file.
6058 This usually happens when the user presses "Stop" before the upload is
6059 finished.  In this case, CGI.pm will return undef for the name of the
6060 uploaded file and set I<cgi_error()> to the string "400 Bad request
6061 (malformed multipart POST)".  This error message is designed so that
6062 you can incorporate it into a status code to be sent to the browser.
6063 Example:
6064
6065    $file = upload('uploaded_file');
6066    if (!$file && cgi_error) {
6067       print header(-status=>cgi_error);
6068       exit 0;
6069    }
6070
6071 You are free to create a custom HTML page to complain about the error,
6072 if you wish.
6073
6074 You can set up a callback that will be called whenever a file upload
6075 is being read during the form processing. This is much like the
6076 UPLOAD_HOOK facility available in Apache::Request, with the exception
6077 that the first argument to the callback is an Apache::Upload object,
6078 here it's the remote filename.
6079
6080  $q = CGI->new(\&hook [,$data [,$use_tempfile]]);
6081
6082  sub hook
6083  {
6084         my ($filename, $buffer, $bytes_read, $data) = @_;
6085         print  "Read $bytes_read bytes of $filename\n";
6086  }
6087
6088 The $data field is optional; it lets you pass configuration
6089 information (e.g. a database handle) to your hook callback.
6090
6091 The $use_tempfile field is a flag that lets you turn on and off
6092 CGI.pm's use of a temporary disk-based file during file upload. If you
6093 set this to a FALSE value (default true) then param('uploaded_file')
6094 will no longer work, and the only way to get at the uploaded data is
6095 via the hook you provide.
6096
6097 If using the function-oriented interface, call the CGI::upload_hook()
6098 method before calling param() or any other CGI functions:
6099
6100   CGI::upload_hook(\&hook [,$data [,$use_tempfile]]);
6101
6102 This method is not exported by default.  You will have to import it
6103 explicitly if you wish to use it without the CGI:: prefix.
6104
6105 If you are using CGI.pm on a Windows platform and find that binary
6106 files get slightly larger when uploaded but that text files remain the
6107 same, then you have forgotten to activate binary mode on the output
6108 filehandle.  Be sure to call binmode() on any handle that you create
6109 to write the uploaded file to disk.
6110
6111 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>,
6112 B<-onMouseOver>, B<-onMouseOut> and B<-onSelect> parameters are
6113 recognized.  See textfield() for details.
6114
6115 =head2 CREATING A POPUP MENU
6116
6117    print popup_menu('menu_name',
6118                             ['eenie','meenie','minie'],
6119                             'meenie');
6120
6121       -or-
6122
6123    %labels = ('eenie'=>'your first choice',
6124               'meenie'=>'your second choice',
6125               'minie'=>'your third choice');
6126    %attributes = ('eenie'=>{'class'=>'class of first choice'});
6127    print popup_menu('menu_name',
6128                             ['eenie','meenie','minie'],
6129           'meenie',\%labels,\%attributes);
6130
6131         -or (named parameter style)-
6132
6133    print popup_menu(-name=>'menu_name',
6134                             -values=>['eenie','meenie','minie'],
6135                             -default=>'meenie',
6136           -labels=>\%labels,
6137           -attributes=>\%attributes);
6138
6139 popup_menu() creates a menu.
6140
6141 =over 4
6142
6143 =item 1.
6144
6145 The required first argument is the menu's name (-name).
6146
6147 =item 2.
6148
6149 The required second argument (-values) is an array B<reference>
6150 containing the list of menu items in the menu.  You can pass the
6151 method an anonymous array, as shown in the example, or a reference to
6152 a named array, such as "\@foo".
6153
6154 =item 3.
6155
6156 The optional third parameter (-default) is the name of the default
6157 menu choice.  If not specified, the first item will be the default.
6158 The values of the previous choice will be maintained across queries.
6159
6160 =item 4.
6161
6162 The optional fourth parameter (-labels) is provided for people who
6163 want to use different values for the user-visible label inside the
6164 popup menu and the value returned to your script.  It's a pointer to an
6165 associative array relating menu values to user-visible labels.  If you
6166 leave this parameter blank, the menu values will be displayed by
6167 default.  (You can also leave a label undefined if you want to).
6168
6169 =item 5.
6170
6171 The optional fifth parameter (-attributes) is provided to assign
6172 any of the common HTML attributes to an individual menu item. It's
6173 a pointer to an associative array relating menu values to another
6174 associative array with the attribute's name as the key and the
6175 attribute's value as the value.
6176
6177 =back
6178
6179 When the form is processed, the selected value of the popup menu can
6180 be retrieved using:
6181
6182       $popup_menu_value = param('menu_name');
6183
6184 =head2 CREATING AN OPTION GROUP
6185
6186 Named parameter style
6187
6188   print popup_menu(-name=>'menu_name',
6189                   -values=>[qw/eenie meenie minie/,
6190                             optgroup(-name=>'optgroup_name',
6191                                              -values => ['moe','catch'],
6192                                              -attributes=>{'catch'=>{'class'=>'red'}})],
6193                   -labels=>{'eenie'=>'one',
6194                             'meenie'=>'two',
6195                             'minie'=>'three'},
6196                   -default=>'meenie');
6197
6198   Old style
6199   print popup_menu('menu_name',
6200                   ['eenie','meenie','minie',
6201                    optgroup('optgroup_name', ['moe', 'catch'],
6202                                    {'catch'=>{'class'=>'red'}})],'meenie',
6203                   {'eenie'=>'one','meenie'=>'two','minie'=>'three'});
6204
6205 optgroup() creates an option group within a popup menu.
6206
6207 =over 4
6208
6209 =item 1.
6210
6211 The required first argument (B<-name>) is the label attribute of the
6212 optgroup and is B<not> inserted in the parameter list of the query.
6213
6214 =item 2.
6215
6216 The required second argument (B<-values>)  is an array reference
6217 containing the list of menu items in the menu.  You can pass the
6218 method an anonymous array, as shown in the example, or a reference
6219 to a named array, such as \@foo.  If you pass a HASH reference,
6220 the keys will be used for the menu values, and the values will be
6221 used for the menu labels (see -labels below).
6222
6223 =item 3.
6224
6225 The optional third parameter (B<-labels>) allows you to pass a reference
6226 to an associative array containing user-visible labels for one or more
6227 of the menu items.  You can use this when you want the user to see one
6228 menu string, but have the browser return your program a different one.
6229 If you don't specify this, the value string will be used instead
6230 ("eenie", "meenie" and "minie" in this example).  This is equivalent
6231 to using a hash reference for the -values parameter.
6232
6233 =item 4.
6234
6235 An optional fourth parameter (B<-labeled>) can be set to a true value
6236 and indicates that the values should be used as the label attribute
6237 for each option element within the optgroup.
6238
6239 =item 5.
6240
6241 An optional fifth parameter (-novals) can be set to a true value and
6242 indicates to suppress the val attribute in each option element within
6243 the optgroup.
6244
6245 See the discussion on optgroup at W3C
6246 (http://www.w3.org/TR/REC-html40/interact/forms.html#edef-OPTGROUP)
6247 for details.
6248
6249 =item 6.
6250
6251 An optional sixth parameter (-attributes) is provided to assign
6252 any of the common HTML attributes to an individual menu item. It's
6253 a pointer to an associative array relating menu values to another
6254 associative array with the attribute's name as the key and the
6255 attribute's value as the value.
6256
6257 =back
6258
6259 =head2 CREATING A SCROLLING LIST
6260
6261    print scrolling_list('list_name',
6262                                 ['eenie','meenie','minie','moe'],
6263         ['eenie','moe'],5,'true',{'moe'=>{'class'=>'red'}});
6264       -or-
6265
6266    print scrolling_list('list_name',
6267                                 ['eenie','meenie','minie','moe'],
6268                                 ['eenie','moe'],5,'true',
6269         \%labels,%attributes);
6270
6271         -or-
6272
6273    print scrolling_list(-name=>'list_name',
6274                                 -values=>['eenie','meenie','minie','moe'],
6275                                 -default=>['eenie','moe'],
6276                                 -size=>5,
6277                                 -multiple=>'true',
6278         -labels=>\%labels,
6279         -attributes=>\%attributes);
6280
6281 scrolling_list() creates a scrolling list.
6282
6283 =over 4
6284
6285 =item B<Parameters:>
6286
6287 =item 1.
6288
6289 The first and second arguments are the list name (-name) and values
6290 (-values).  As in the popup menu, the second argument should be an
6291 array reference.
6292
6293 =item 2.
6294
6295 The optional third argument (-default) can be either a reference to a
6296 list containing the values to be selected by default, or can be a
6297 single value to select.  If this argument is missing or undefined,
6298 then nothing is selected when the list first appears.  In the named
6299 parameter version, you can use the synonym "-defaults" for this
6300 parameter.
6301
6302 =item 3.
6303
6304 The optional fourth argument is the size of the list (-size).
6305
6306 =item 4.
6307
6308 The optional fifth argument can be set to true to allow multiple
6309 simultaneous selections (-multiple).  Otherwise only one selection
6310 will be allowed at a time.
6311
6312 =item 5.
6313
6314 The optional sixth argument is a pointer to an associative array
6315 containing long user-visible labels for the list items (-labels).
6316 If not provided, the values will be displayed.
6317
6318 =item 6.
6319
6320 The optional sixth parameter (-attributes) is provided to assign
6321 any of the common HTML attributes to an individual menu item. It's
6322 a pointer to an associative array relating menu values to another
6323 associative array with the attribute's name as the key and the
6324 attribute's value as the value.
6325
6326 When this form is processed, all selected list items will be returned as
6327 a list under the parameter name 'list_name'.  The values of the
6328 selected items can be retrieved with:
6329
6330       @selected = param('list_name');
6331
6332 =back
6333
6334 =head2 CREATING A GROUP OF RELATED CHECKBOXES
6335
6336    print checkbox_group(-name=>'group_name',
6337                                 -values=>['eenie','meenie','minie','moe'],
6338                                 -default=>['eenie','moe'],
6339                                 -linebreak=>'true',
6340                                 -disabled => ['moe'],
6341         -labels=>\%labels,
6342         -attributes=>\%attributes);
6343
6344    print checkbox_group('group_name',
6345                                 ['eenie','meenie','minie','moe'],
6346         ['eenie','moe'],'true',\%labels,
6347         {'moe'=>{'class'=>'red'}});
6348
6349    HTML3-COMPATIBLE BROWSERS ONLY:
6350
6351    print checkbox_group(-name=>'group_name',
6352                                 -values=>['eenie','meenie','minie','moe'],
6353                                 -rows=2,-columns=>2);
6354
6355
6356 checkbox_group() creates a list of checkboxes that are related
6357 by the same name.
6358
6359 =over 4
6360
6361 =item B<Parameters:>
6362
6363 =item 1.
6364
6365 The first and second arguments are the checkbox name and values,
6366 respectively (-name and -values).  As in the popup menu, the second
6367 argument should be an array reference.  These values are used for the
6368 user-readable labels printed next to the checkboxes as well as for the
6369 values passed to your script in the query string.
6370
6371 =item 2.
6372
6373 The optional third argument (-default) can be either a reference to a
6374 list containing the values to be checked by default, or can be a
6375 single value to checked.  If this argument is missing or undefined,
6376 then nothing is selected when the list first appears.
6377
6378 =item 3.
6379
6380 The optional fourth argument (-linebreak) can be set to true to place
6381 line breaks between the checkboxes so that they appear as a vertical
6382 list.  Otherwise, they will be strung together on a horizontal line.
6383
6384 =back
6385
6386
6387 The optional b<-labels> argument is a pointer to an associative array
6388 relating the checkbox values to the user-visible labels that will be
6389 printed next to them.  If not provided, the values will be used as the
6390 default.
6391
6392
6393 The optional parameters B<-rows>, and B<-columns> cause
6394 checkbox_group() to return an HTML3 compatible table containing the
6395 checkbox group formatted with the specified number of rows and
6396 columns.  You can provide just the -columns parameter if you wish;
6397 checkbox_group will calculate the correct number of rows for you.
6398
6399 The option b<-disabled> takes an array of checkbox values and disables
6400 them by greying them out (this may not be supported by all browsers).
6401
6402 The optional B<-attributes> argument is provided to assign any of the
6403 common HTML attributes to an individual menu item. It's a pointer to
6404 an associative array relating menu values to another associative array
6405 with the attribute's name as the key and the attribute's value as the
6406 value.
6407
6408 The optional B<-tabindex> argument can be used to control the order in which
6409 radio buttons receive focus when the user presses the tab button.  If
6410 passed a scalar numeric value, the first element in the group will
6411 receive this tab index and subsequent elements will be incremented by
6412 one.  If given a reference to an array of radio button values, then
6413 the indexes will be jiggered so that the order specified in the array
6414 will correspond to the tab order.  You can also pass a reference to a
6415 hash in which the hash keys are the radio button values and the values
6416 are the tab indexes of each button.  Examples:
6417
6418   -tabindex => 100    #  this group starts at index 100 and counts up
6419   -tabindex => ['moe','minie','eenie','meenie']  # tab in this order
6420   -tabindex => {meenie=>100,moe=>101,minie=>102,eenie=>200} # tab in this order
6421
6422 The optional B<-labelattributes> argument will contain attributes
6423 attached to the <label> element that surrounds each button.
6424
6425 When the form is processed, all checked boxes will be returned as
6426 a list under the parameter name 'group_name'.  The values of the
6427 "on" checkboxes can be retrieved with:
6428
6429       @turned_on = param('group_name');
6430
6431 The value returned by checkbox_group() is actually an array of button
6432 elements.  You can capture them and use them within tables, lists,
6433 or in other creative ways:
6434
6435     @h = checkbox_group(-name=>'group_name',-values=>\@values);
6436     &use_in_creative_way(@h);
6437
6438 =head2 CREATING A STANDALONE CHECKBOX
6439
6440     print checkbox(-name=>'checkbox_name',
6441                            -checked=>1,
6442                            -value=>'ON',
6443                            -label=>'CLICK ME');
6444
6445         -or-
6446
6447     print checkbox('checkbox_name','checked','ON','CLICK ME');
6448
6449 checkbox() is used to create an isolated checkbox that isn't logically
6450 related to any others.
6451
6452 =over 4
6453
6454 =item B<Parameters:>
6455
6456 =item 1.
6457
6458 The first parameter is the required name for the checkbox (-name).  It
6459 will also be used for the user-readable label printed next to the
6460 checkbox.
6461
6462 =item 2.
6463
6464 The optional second parameter (-checked) specifies that the checkbox
6465 is turned on by default.  Synonyms are -selected and -on.
6466
6467 =item 3.
6468
6469 The optional third parameter (-value) specifies the value of the
6470 checkbox when it is checked.  If not provided, the word "on" is
6471 assumed.
6472
6473 =item 4.
6474
6475 The optional fourth parameter (-label) is the user-readable label to
6476 be attached to the checkbox.  If not provided, the checkbox name is
6477 used.
6478
6479 =back
6480
6481 The value of the checkbox can be retrieved using:
6482
6483     $turned_on = param('checkbox_name');
6484
6485 =head2 CREATING A RADIO BUTTON GROUP
6486
6487    print radio_group(-name=>'group_name',
6488                              -values=>['eenie','meenie','minie'],
6489                              -default=>'meenie',
6490                              -linebreak=>'true',
6491            -labels=>\%labels,
6492            -attributes=>\%attributes);
6493
6494         -or-
6495
6496    print radio_group('group_name',['eenie','meenie','minie'],
6497             'meenie','true',\%labels,\%attributes);
6498
6499
6500    HTML3-COMPATIBLE BROWSERS ONLY:
6501
6502    print radio_group(-name=>'group_name',
6503                              -values=>['eenie','meenie','minie','moe'],
6504                              -rows=2,-columns=>2);
6505
6506 radio_group() creates a set of logically-related radio buttons
6507 (turning one member of the group on turns the others off)
6508
6509 =over 4
6510
6511 =item B<Parameters:>
6512
6513 =item 1.
6514
6515 The first argument is the name of the group and is required (-name).
6516
6517 =item 2.
6518
6519 The second argument (-values) is the list of values for the radio
6520 buttons.  The values and the labels that appear on the page are
6521 identical.  Pass an array I<reference> in the second argument, either
6522 using an anonymous array, as shown, or by referencing a named array as
6523 in "\@foo".
6524
6525 =item 3.
6526
6527 The optional third parameter (-default) is the name of the default
6528 button to turn on. If not specified, the first item will be the
6529 default.  You can provide a nonexistent button name, such as "-" to
6530 start up with no buttons selected.
6531
6532 =item 4.
6533
6534 The optional fourth parameter (-linebreak) can be set to 'true' to put
6535 line breaks between the buttons, creating a vertical list.
6536
6537 =item 5.
6538
6539 The optional fifth parameter (-labels) is a pointer to an associative
6540 array relating the radio button values to user-visible labels to be
6541 used in the display.  If not provided, the values themselves are
6542 displayed.
6543
6544 =back
6545
6546
6547 All modern browsers can take advantage of the optional parameters
6548 B<-rows>, and B<-columns>.  These parameters cause radio_group() to
6549 return an HTML3 compatible table containing the radio group formatted
6550 with the specified number of rows and columns.  You can provide just
6551 the -columns parameter if you wish; radio_group will calculate the
6552 correct number of rows for you.
6553
6554 To include row and column headings in the returned table, you
6555 can use the B<-rowheaders> and B<-colheaders> parameters.  Both
6556 of these accept a pointer to an array of headings to use.
6557 The headings are just decorative.  They don't reorganize the
6558 interpretation of the radio buttons -- they're still a single named
6559 unit.
6560
6561 The optional B<-tabindex> argument can be used to control the order in which
6562 radio buttons receive focus when the user presses the tab button.  If
6563 passed a scalar numeric value, the first element in the group will
6564 receive this tab index and subsequent elements will be incremented by
6565 one.  If given a reference to an array of radio button values, then
6566 the indexes will be jiggered so that the order specified in the array
6567 will correspond to the tab order.  You can also pass a reference to a
6568 hash in which the hash keys are the radio button values and the values
6569 are the tab indexes of each button.  Examples:
6570
6571   -tabindex => 100    #  this group starts at index 100 and counts up
6572   -tabindex => ['moe','minie','eenie','meenie']  # tab in this order
6573   -tabindex => {meenie=>100,moe=>101,minie=>102,eenie=>200} # tab in this order
6574
6575
6576 The optional B<-attributes> argument is provided to assign any of the
6577 common HTML attributes to an individual menu item. It's a pointer to
6578 an associative array relating menu values to another associative array
6579 with the attribute's name as the key and the attribute's value as the
6580 value.
6581
6582 The optional B<-labelattributes> argument will contain attributes
6583 attached to the <label> element that surrounds each button.
6584
6585 When the form is processed, the selected radio button can
6586 be retrieved using:
6587
6588       $which_radio_button = param('group_name');
6589
6590 The value returned by radio_group() is actually an array of button
6591 elements.  You can capture them and use them within tables, lists,
6592 or in other creative ways:
6593
6594     @h = radio_group(-name=>'group_name',-values=>\@values);
6595     &use_in_creative_way(@h);
6596
6597 =head2 CREATING A SUBMIT BUTTON
6598
6599    print submit(-name=>'button_name',
6600                         -value=>'value');
6601
6602         -or-
6603
6604    print submit('button_name','value');
6605
6606 submit() will create the query submission button.  Every form
6607 should have one of these.
6608
6609 =over 4
6610
6611 =item B<Parameters:>
6612
6613 =item 1.
6614
6615 The first argument (-name) is optional.  You can give the button a
6616 name if you have several submission buttons in your form and you want
6617 to distinguish between them.
6618
6619 =item 2.
6620
6621 The second argument (-value) is also optional.  This gives the button
6622 a value that will be passed to your script in the query string. The
6623 name will also be used as the user-visible label.
6624
6625 =item 3.
6626
6627 You can use -label as an alias for -value.  I always get confused
6628 about which of -name and -value changes the user-visible label on the
6629 button.
6630
6631 =back
6632
6633 You can figure out which button was pressed by using different
6634 values for each one:
6635
6636      $which_one = param('button_name');
6637
6638 =head2 CREATING A RESET BUTTON
6639
6640    print reset
6641
6642 reset() creates the "reset" button.  Note that it restores the
6643 form to its value from the last time the script was called,
6644 NOT necessarily to the defaults.
6645
6646 Note that this conflicts with the Perl reset() built-in.  Use
6647 CORE::reset() to get the original reset function.
6648
6649 =head2 CREATING A DEFAULT BUTTON
6650
6651    print defaults('button_label')
6652
6653 defaults() creates a button that, when invoked, will cause the
6654 form to be completely reset to its defaults, wiping out all the
6655 changes the user ever made.
6656
6657 =head2 CREATING A HIDDEN FIELD
6658
6659         print hidden(-name=>'hidden_name',
6660                              -default=>['value1','value2'...]);
6661
6662                 -or-
6663
6664         print hidden('hidden_name','value1','value2'...);
6665
6666 hidden() produces a text field that can't be seen by the user.  It
6667 is useful for passing state variable information from one invocation
6668 of the script to the next.
6669
6670 =over 4
6671
6672 =item B<Parameters:>
6673
6674 =item 1.
6675
6676 The first argument is required and specifies the name of this
6677 field (-name).
6678
6679 =item 2.
6680
6681 The second argument is also required and specifies its value
6682 (-default).  In the named parameter style of calling, you can provide
6683 a single value here or a reference to a whole list
6684
6685 =back
6686
6687 Fetch the value of a hidden field this way:
6688
6689      $hidden_value = param('hidden_name');
6690
6691 Note, that just like all the other form elements, the value of a
6692 hidden field is "sticky".  If you want to replace a hidden field with
6693 some other values after the script has been called once you'll have to
6694 do it manually:
6695
6696      param('hidden_name','new','values','here');
6697
6698 =head2 CREATING A CLICKABLE IMAGE BUTTON
6699
6700      print image_button(-name=>'button_name',
6701                                 -src=>'/source/URL',
6702                                 -align=>'MIDDLE');
6703
6704         -or-
6705
6706      print image_button('button_name','/source/URL','MIDDLE');
6707
6708 image_button() produces a clickable image.  When it's clicked on the
6709 position of the click is returned to your script as "button_name.x"
6710 and "button_name.y", where "button_name" is the name you've assigned
6711 to it.
6712
6713 =over 4
6714
6715 =item B<Parameters:>
6716
6717 =item 1.
6718
6719 The first argument (-name) is required and specifies the name of this
6720 field.
6721
6722 =item 2.
6723
6724 The second argument (-src) is also required and specifies the URL
6725
6726 =item 3.
6727 The third option (-align, optional) is an alignment type, and may be
6728 TOP, BOTTOM or MIDDLE
6729
6730 =back
6731
6732 Fetch the value of the button this way:
6733      $x = param('button_name.x');
6734      $y = param('button_name.y');
6735
6736 =head2 CREATING A JAVASCRIPT ACTION BUTTON
6737
6738      print button(-name=>'button_name',
6739                           -value=>'user visible label',
6740                           -onClick=>"do_something()");
6741
6742         -or-
6743
6744      print button('button_name',"do_something()");
6745
6746 button() produces a button that is compatible with Netscape 2.0's
6747 JavaScript.  When it's pressed the fragment of JavaScript code
6748 pointed to by the B<-onClick> parameter will be executed.  On
6749 non-Netscape browsers this form element will probably not even
6750 display.
6751
6752 =head1 HTTP COOKIES
6753
6754 Netscape browsers versions 1.1 and higher, and all versions of
6755 Internet Explorer, support a so-called "cookie" designed to help
6756 maintain state within a browser session.  CGI.pm has several methods
6757 that support cookies.
6758
6759 A cookie is a name=value pair much like the named parameters in a CGI
6760 query string.  CGI scripts create one or more cookies and send
6761 them to the browser in the HTTP header.  The browser maintains a list
6762 of cookies that belong to a particular Web server, and returns them
6763 to the CGI script during subsequent interactions.
6764
6765 In addition to the required name=value pair, each cookie has several
6766 optional attributes:
6767
6768 =over 4
6769
6770 =item 1. an expiration time
6771
6772 This is a time/date string (in a special GMT format) that indicates
6773 when a cookie expires.  The cookie will be saved and returned to your
6774 script until this expiration date is reached if the user exits
6775 the browser and restarts it.  If an expiration date isn't specified, the cookie
6776 will remain active until the user quits the browser.
6777
6778 =item 2. a domain
6779
6780 This is a partial or complete domain name for which the cookie is
6781 valid.  The browser will return the cookie to any host that matches
6782 the partial domain name.  For example, if you specify a domain name
6783 of ".capricorn.com", then the browser will return the cookie to
6784 Web servers running on any of the machines "www.capricorn.com",
6785 "www2.capricorn.com", "feckless.capricorn.com", etc.  Domain names
6786 must contain at least two periods to prevent attempts to match
6787 on top level domains like ".edu".  If no domain is specified, then
6788 the browser will only return the cookie to servers on the host the
6789 cookie originated from.
6790
6791 =item 3. a path
6792
6793 If you provide a cookie path attribute, the browser will check it
6794 against your script's URL before returning the cookie.  For example,
6795 if you specify the path "/cgi-bin", then the cookie will be returned
6796 to each of the scripts "/cgi-bin/tally.pl", "/cgi-bin/order.pl",
6797 and "/cgi-bin/customer_service/complain.pl", but not to the script
6798 "/cgi-private/site_admin.pl".  By default, path is set to "/", which
6799 causes the cookie to be sent to any CGI script on your site.
6800
6801 =item 4. a "secure" flag
6802
6803 If the "secure" attribute is set, the cookie will only be sent to your
6804 script if the CGI request is occurring on a secure channel, such as SSL.
6805
6806 =back
6807
6808 The interface to HTTP cookies is the B<cookie()> method:
6809
6810     $cookie = cookie(-name=>'sessionID',
6811                              -value=>'xyzzy',
6812                              -expires=>'+1h',
6813                              -path=>'/cgi-bin/database',
6814                              -domain=>'.capricorn.org',
6815                              -secure=>1);
6816     print header(-cookie=>$cookie);
6817
6818 B<cookie()> creates a new cookie.  Its parameters include:
6819
6820 =over 4
6821
6822 =item B<-name>
6823
6824 The name of the cookie (required).  This can be any string at all.
6825 Although browsers limit their cookie names to non-whitespace
6826 alphanumeric characters, CGI.pm removes this restriction by escaping
6827 and unescaping cookies behind the scenes.
6828
6829 =item B<-value>
6830
6831 The value of the cookie.  This can be any scalar value,
6832 array reference, or even associative array reference.  For example,
6833 you can store an entire associative array into a cookie this way:
6834
6835         $cookie=cookie(-name=>'family information',
6836                                -value=>\%childrens_ages);
6837
6838 =item B<-path>
6839
6840 The optional partial path for which this cookie will be valid, as described
6841 above.
6842
6843 =item B<-domain>
6844
6845 The optional partial domain for which this cookie will be valid, as described
6846 above.
6847
6848 =item B<-expires>
6849
6850 The optional expiration date for this cookie.  The format is as described
6851 in the section on the B<header()> method:
6852
6853         "+1h"  one hour from now
6854
6855 =item B<-secure>
6856
6857 If set to true, this cookie will only be used within a secure
6858 SSL session.
6859
6860 =back
6861
6862 The cookie created by cookie() must be incorporated into the HTTP
6863 header within the string returned by the header() method:
6864
6865         use CGI ':standard';
6866         print header(-cookie=>$my_cookie);
6867
6868 To create multiple cookies, give header() an array reference:
6869
6870         $cookie1 = cookie(-name=>'riddle_name',
6871                                   -value=>"The Sphynx's Question");
6872         $cookie2 = cookie(-name=>'answers',
6873                                   -value=>\%answers);
6874         print header(-cookie=>[$cookie1,$cookie2]);
6875
6876 To retrieve a cookie, request it by name by calling cookie() method
6877 without the B<-value> parameter. This example uses the object-oriented
6878 form:
6879
6880         use CGI;
6881         $query = new CGI;
6882         $riddle = $query->cookie('riddle_name');
6883         %answers = $query->cookie('answers');
6884
6885 Cookies created with a single scalar value, such as the "riddle_name"
6886 cookie, will be returned in that form.  Cookies with array and hash
6887 values can also be retrieved.
6888
6889 The cookie and CGI namespaces are separate.  If you have a parameter
6890 named 'answers' and a cookie named 'answers', the values retrieved by
6891 param() and cookie() are independent of each other.  However, it's
6892 simple to turn a CGI parameter into a cookie, and vice-versa:
6893
6894    # turn a CGI parameter into a cookie
6895    $c=cookie(-name=>'answers',-value=>[param('answers')]);
6896    # vice-versa
6897    param(-name=>'answers',-value=>[cookie('answers')]);
6898
6899 If you call cookie() without any parameters, it will return a list of
6900 the names of all cookies passed to your script:
6901
6902   @cookies = cookie();
6903
6904 See the B<cookie.cgi> example script for some ideas on how to use
6905 cookies effectively.
6906
6907 =head1 WORKING WITH FRAMES
6908
6909 It's possible for CGI.pm scripts to write into several browser panels
6910 and windows using the HTML 4 frame mechanism.  There are three
6911 techniques for defining new frames programmatically:
6912
6913 =over 4
6914
6915 =item 1. Create a <Frameset> document
6916
6917 After writing out the HTTP header, instead of creating a standard
6918 HTML document using the start_html() call, create a <frameset>
6919 document that defines the frames on the page.  Specify your script(s)
6920 (with appropriate parameters) as the SRC for each of the frames.
6921
6922 There is no specific support for creating <frameset> sections
6923 in CGI.pm, but the HTML is very simple to write.  See the frame
6924 documentation in Netscape's home pages for details
6925
6926   http://wp.netscape.com/assist/net_sites/frames.html
6927
6928 =item 2. Specify the destination for the document in the HTTP header
6929
6930 You may provide a B<-target> parameter to the header() method:
6931
6932     print header(-target=>'ResultsWindow');
6933
6934 This will tell the browser to load the output of your script into the
6935 frame named "ResultsWindow".  If a frame of that name doesn't already
6936 exist, the browser will pop up a new window and load your script's
6937 document into that.  There are a number of magic names that you can
6938 use for targets.  See the frame documents on Netscape's home pages for
6939 details.
6940
6941 =item 3. Specify the destination for the document in the <form> tag
6942
6943 You can specify the frame to load in the FORM tag itself.  With
6944 CGI.pm it looks like this:
6945
6946     print start_form(-target=>'ResultsWindow');
6947
6948 When your script is reinvoked by the form, its output will be loaded
6949 into the frame named "ResultsWindow".  If one doesn't already exist
6950 a new window will be created.
6951
6952 =back
6953
6954 The script "frameset.cgi" in the examples directory shows one way to
6955 create pages in which the fill-out form and the response live in
6956 side-by-side frames.
6957
6958 =head1 SUPPORT FOR JAVASCRIPT
6959
6960 Netscape versions 2.0 and higher incorporate an interpreted language
6961 called JavaScript. Internet Explorer, 3.0 and higher, supports a
6962 closely-related dialect called JScript. JavaScript isn't the same as
6963 Java, and certainly isn't at all the same as Perl, which is a great
6964 pity. JavaScript allows you to programmatically change the contents of
6965 fill-out forms, create new windows, and pop up dialog box from within
6966 Netscape itself. From the point of view of CGI scripting, JavaScript
6967 is quite useful for validating fill-out forms prior to submitting
6968 them.
6969
6970 You'll need to know JavaScript in order to use it. There are many good
6971 sources in bookstores and on the web.
6972
6973 The usual way to use JavaScript is to define a set of functions in a
6974 <SCRIPT> block inside the HTML header and then to register event
6975 handlers in the various elements of the page. Events include such
6976 things as the mouse passing over a form element, a button being
6977 clicked, the contents of a text field changing, or a form being
6978 submitted. When an event occurs that involves an element that has
6979 registered an event handler, its associated JavaScript code gets
6980 called.
6981
6982 The elements that can register event handlers include the <BODY> of an
6983 HTML document, hypertext links, all the various elements of a fill-out
6984 form, and the form itself. There are a large number of events, and
6985 each applies only to the elements for which it is relevant. Here is a
6986 partial list:
6987
6988 =over 4
6989
6990 =item B<onLoad>
6991
6992 The browser is loading the current document. Valid in:
6993
6994      + The HTML <BODY> section only.
6995
6996 =item B<onUnload>
6997
6998 The browser is closing the current page or frame. Valid for:
6999
7000      + The HTML <BODY> section only.
7001
7002 =item B<onSubmit>
7003
7004 The user has pressed the submit button of a form. This event happens
7005 just before the form is submitted, and your function can return a
7006 value of false in order to abort the submission.  Valid for:
7007
7008      + Forms only.
7009
7010 =item B<onClick>
7011
7012 The mouse has clicked on an item in a fill-out form. Valid for:
7013
7014      + Buttons (including submit, reset, and image buttons)
7015      + Checkboxes
7016      + Radio buttons
7017
7018 =item B<onChange>
7019
7020 The user has changed the contents of a field. Valid for:
7021
7022      + Text fields
7023      + Text areas
7024      + Password fields
7025      + File fields
7026      + Popup Menus
7027      + Scrolling lists
7028
7029 =item B<onFocus>
7030
7031 The user has selected a field to work with. Valid for:
7032
7033      + Text fields
7034      + Text areas
7035      + Password fields
7036      + File fields
7037      + Popup Menus
7038      + Scrolling lists
7039
7040 =item B<onBlur>
7041
7042 The user has deselected a field (gone to work somewhere else).  Valid
7043 for:
7044
7045      + Text fields
7046      + Text areas
7047      + Password fields
7048      + File fields
7049      + Popup Menus
7050      + Scrolling lists
7051
7052 =item B<onSelect>
7053
7054 The user has changed the part of a text field that is selected.  Valid
7055 for:
7056
7057      + Text fields
7058      + Text areas
7059      + Password fields
7060      + File fields
7061
7062 =item B<onMouseOver>
7063
7064 The mouse has moved over an element.
7065
7066      + Text fields
7067      + Text areas
7068      + Password fields
7069      + File fields
7070      + Popup Menus
7071      + Scrolling lists
7072
7073 =item B<onMouseOut>
7074
7075 The mouse has moved off an element.
7076
7077      + Text fields
7078      + Text areas
7079      + Password fields
7080      + File fields
7081      + Popup Menus
7082      + Scrolling lists
7083
7084 =back
7085
7086 In order to register a JavaScript event handler with an HTML element,
7087 just use the event name as a parameter when you call the corresponding
7088 CGI method. For example, to have your validateAge() JavaScript code
7089 executed every time the textfield named "age" changes, generate the
7090 field like this:
7091
7092  print textfield(-name=>'age',-onChange=>"validateAge(this)");
7093
7094 This example assumes that you've already declared the validateAge()
7095 function by incorporating it into a <SCRIPT> block. The CGI.pm
7096 start_html() method provides a convenient way to create this section.
7097
7098 Similarly, you can create a form that checks itself over for
7099 consistency and alerts the user if some essential value is missing by
7100 creating it this way:
7101   print startform(-onSubmit=>"validateMe(this)");
7102
7103 See the javascript.cgi script for a demonstration of how this all
7104 works.
7105
7106
7107 =head1 LIMITED SUPPORT FOR CASCADING STYLE SHEETS
7108
7109 CGI.pm has limited support for HTML3's cascading style sheets (css).
7110 To incorporate a stylesheet into your document, pass the
7111 start_html() method a B<-style> parameter.  The value of this
7112 parameter may be a scalar, in which case it is treated as the source
7113 URL for the stylesheet, or it may be a hash reference.  In the latter
7114 case you should provide the hash with one or more of B<-src> or
7115 B<-code>.  B<-src> points to a URL where an externally-defined
7116 stylesheet can be found.  B<-code> points to a scalar value to be
7117 incorporated into a <style> section.  Style definitions in B<-code>
7118 override similarly-named ones in B<-src>, hence the name "cascading."
7119
7120 You may also specify the type of the stylesheet by adding the optional
7121 B<-type> parameter to the hash pointed to by B<-style>.  If not
7122 specified, the style defaults to 'text/css'.
7123
7124 To refer to a style within the body of your document, add the
7125 B<-class> parameter to any HTML element:
7126
7127     print h1({-class=>'Fancy'},'Welcome to the Party');
7128
7129 Or define styles on the fly with the B<-style> parameter:
7130
7131     print h1({-style=>'Color: red;'},'Welcome to Hell');
7132
7133 You may also use the new B<span()> element to apply a style to a
7134 section of text:
7135
7136     print span({-style=>'Color: red;'},
7137                h1('Welcome to Hell'),
7138                "Where did that handbasket get to?"
7139                );
7140
7141 Note that you must import the ":html3" definitions to have the
7142 B<span()> method available.  Here's a quick and dirty example of using
7143 CSS's.  See the CSS specification at
7144 http://www.w3.org/pub/WWW/TR/Wd-css-1.html for more information.
7145
7146     use CGI qw/:standard :html3/;
7147
7148     #here's a stylesheet incorporated directly into the page
7149     $newStyle=<<END;
7150     <!--
7151     P.Tip {
7152         margin-right: 50pt;
7153         margin-left: 50pt;
7154         color: red;
7155     }
7156     P.Alert {
7157         font-size: 30pt;
7158         font-family: sans-serif;
7159       color: red;
7160     }
7161     -->
7162     END
7163     print header();
7164     print start_html( -title=>'CGI with Style',
7165                       -style=>{-src=>'http://www.capricorn.com/style/st1.css',
7166                                -code=>$newStyle}
7167                      );
7168     print h1('CGI with Style'),
7169           p({-class=>'Tip'},
7170             "Better read the cascading style sheet spec before playing with this!"),
7171           span({-style=>'color: magenta'},
7172                "Look Mom, no hands!",
7173                p(),
7174                "Whooo wee!"
7175                );
7176     print end_html;
7177
7178 Pass an array reference to B<-code> or B<-src> in order to incorporate
7179 multiple stylesheets into your document.
7180
7181 Should you wish to incorporate a verbatim stylesheet that includes
7182 arbitrary formatting in the header, you may pass a -verbatim tag to
7183 the -style hash, as follows:
7184
7185 print start_html (-style  =>  {-verbatim => '@import url("/server-common/css/'.$cssFile.'");',
7186                   -src    =>  '/server-common/css/core.css'});
7187
7188
7189 This will generate an HTML header that contains this:
7190
7191  <link rel="stylesheet" type="text/css"  href="/server-common/css/core.css">
7192    <style type="text/css">
7193    @import url("/server-common/css/main.css");
7194    </style>
7195
7196 Any additional arguments passed in the -style value will be
7197 incorporated into the <link> tag.  For example:
7198
7199  start_html(-style=>{-src=>['/styles/print.css','/styles/layout.css'],
7200                           -media => 'all'});
7201
7202 This will give:
7203
7204  <link rel="stylesheet" type="text/css" href="/styles/print.css" media="all"/>
7205  <link rel="stylesheet" type="text/css" href="/styles/layout.css" media="all"/>
7206
7207 <p>
7208
7209 To make more complicated <link> tags, use the Link() function
7210 and pass it to start_html() in the -head argument, as in:
7211
7212   @h = (Link({-rel=>'stylesheet',-type=>'text/css',-src=>'/ss/ss.css',-media=>'all'}),
7213         Link({-rel=>'stylesheet',-type=>'text/css',-src=>'/ss/fred.css',-media=>'paper'}));
7214   print start_html({-head=>\@h})
7215
7216 To create primary and  "alternate" stylesheet, use the B<-alternate> option:
7217
7218  start_html(-style=>{-src=>[
7219                            {-src=>'/styles/print.css'},
7220                            {-src=>'/styles/alt.css',-alternate=>1}
7221                            ]
7222                     });
7223
7224 =head1 DEBUGGING
7225
7226 If you are running the script from the command line or in the perl
7227 debugger, you can pass the script a list of keywords or
7228 parameter=value pairs on the command line or from standard input (you
7229 don't have to worry about tricking your script into reading from
7230 environment variables).  You can pass keywords like this:
7231
7232     your_script.pl keyword1 keyword2 keyword3
7233
7234 or this:
7235
7236    your_script.pl keyword1+keyword2+keyword3
7237
7238 or this:
7239
7240     your_script.pl name1=value1 name2=value2
7241
7242 or this:
7243
7244     your_script.pl name1=value1&name2=value2
7245
7246 To turn off this feature, use the -no_debug pragma.
7247
7248 To test the POST method, you may enable full debugging with the -debug
7249 pragma.  This will allow you to feed newline-delimited name=value
7250 pairs to the script on standard input.
7251
7252 When debugging, you can use quotes and backslashes to escape
7253 characters in the familiar shell manner, letting you place
7254 spaces and other funny characters in your parameter=value
7255 pairs:
7256
7257    your_script.pl "name1='I am a long value'" "name2=two\ words"
7258
7259 Finally, you can set the path info for the script by prefixing the first
7260 name/value parameter with the path followed by a question mark (?):
7261
7262     your_script.pl /your/path/here?name1=value1&name2=value2
7263
7264 =head2 DUMPING OUT ALL THE NAME/VALUE PAIRS
7265
7266 The Dump() method produces a string consisting of all the query's
7267 name/value pairs formatted nicely as a nested list.  This is useful
7268 for debugging purposes:
7269
7270     print Dump
7271
7272
7273 Produces something that looks like:
7274
7275     <ul>
7276     <li>name1
7277         <ul>
7278         <li>value1
7279         <li>value2
7280         </ul>
7281     <li>name2
7282         <ul>
7283         <li>value1
7284         </ul>
7285     </ul>
7286
7287 As a shortcut, you can interpolate the entire CGI object into a string
7288 and it will be replaced with the a nice HTML dump shown above:
7289
7290     $query=new CGI;
7291     print "<h2>Current Values</h2> $query\n";
7292
7293 =head1 FETCHING ENVIRONMENT VARIABLES
7294
7295 Some of the more useful environment variables can be fetched
7296 through this interface.  The methods are as follows:
7297
7298 =over 4
7299
7300 =item B<Accept()>
7301
7302 Return a list of MIME types that the remote browser accepts. If you
7303 give this method a single argument corresponding to a MIME type, as in
7304 Accept('text/html'), it will return a floating point value
7305 corresponding to the browser's preference for this type from 0.0
7306 (don't want) to 1.0.  Glob types (e.g. text/*) in the browser's accept
7307 list are handled correctly.
7308
7309 Note that the capitalization changed between version 2.43 and 2.44 in
7310 order to avoid conflict with Perl's accept() function.
7311
7312 =item B<raw_cookie()>
7313
7314 Returns the HTTP_COOKIE variable, an HTTP extension implemented by
7315 Netscape browsers version 1.1 and higher, and all versions of Internet
7316 Explorer.  Cookies have a special format, and this method call just
7317 returns the raw form (?cookie dough).  See cookie() for ways of
7318 setting and retrieving cooked cookies.
7319
7320 Called with no parameters, raw_cookie() returns the packed cookie
7321 structure.  You can separate it into individual cookies by splitting
7322 on the character sequence "; ".  Called with the name of a cookie,
7323 retrieves the B<unescaped> form of the cookie.  You can use the
7324 regular cookie() method to get the names, or use the raw_fetch()
7325 method from the CGI::Cookie module.
7326
7327 =item B<user_agent()>
7328
7329 Returns the HTTP_USER_AGENT variable.  If you give
7330 this method a single argument, it will attempt to
7331 pattern match on it, allowing you to do something
7332 like user_agent(netscape);
7333
7334 =item B<path_info()>
7335
7336 Returns additional path information from the script URL.
7337 E.G. fetching /cgi-bin/your_script/additional/stuff will result in
7338 path_info() returning "/additional/stuff".
7339
7340 NOTE: The Microsoft Internet Information Server
7341 is broken with respect to additional path information.  If
7342 you use the Perl DLL library, the IIS server will attempt to
7343 execute the additional path information as a Perl script.
7344 If you use the ordinary file associations mapping, the
7345 path information will be present in the environment,
7346 but incorrect.  The best thing to do is to avoid using additional
7347 path information in CGI scripts destined for use with IIS.
7348
7349 =item B<path_translated()>
7350
7351 As per path_info() but returns the additional
7352 path information translated into a physical path, e.g.
7353 "/usr/local/etc/httpd/htdocs/additional/stuff".
7354
7355 The Microsoft IIS is broken with respect to the translated
7356 path as well.
7357
7358 =item B<remote_host()>
7359
7360 Returns either the remote host name or IP address.
7361 if the former is unavailable.
7362
7363 =item B<script_name()>
7364 Return the script name as a partial URL, for self-refering
7365 scripts.
7366
7367 =item B<referer()>
7368
7369 Return the URL of the page the browser was viewing
7370 prior to fetching your script.  Not available for all
7371 browsers.
7372
7373 =item B<auth_type ()>
7374
7375 Return the authorization/verification method in use for this
7376 script, if any.
7377
7378 =item B<server_name ()>
7379
7380 Returns the name of the server, usually the machine's host
7381 name.
7382
7383 =item B<virtual_host ()>
7384
7385 When using virtual hosts, returns the name of the host that
7386 the browser attempted to contact
7387
7388 =item B<server_port ()>
7389
7390 Return the port that the server is listening on.
7391
7392 =item B<virtual_port ()>
7393
7394 Like server_port() except that it takes virtual hosts into account.
7395 Use this when running with virtual hosts.
7396
7397 =item B<server_software ()>
7398
7399 Returns the server software and version number.
7400
7401 =item B<remote_user ()>
7402
7403 Return the authorization/verification name used for user
7404 verification, if this script is protected.
7405
7406 =item B<user_name ()>
7407
7408 Attempt to obtain the remote user's name, using a variety of different
7409 techniques.  This only works with older browsers such as Mosaic.
7410 Newer browsers do not report the user name for privacy reasons!
7411
7412 =item B<request_method()>
7413
7414 Returns the method used to access your script, usually
7415 one of 'POST', 'GET' or 'HEAD'.
7416
7417 =item B<content_type()>
7418
7419 Returns the content_type of data submitted in a POST, generally
7420 multipart/form-data or application/x-www-form-urlencoded
7421
7422 =item B<http()>
7423
7424 Called with no arguments returns the list of HTTP environment
7425 variables, including such things as HTTP_USER_AGENT,
7426 HTTP_ACCEPT_LANGUAGE, and HTTP_ACCEPT_CHARSET, corresponding to the
7427 like-named HTTP header fields in the request.  Called with the name of
7428 an HTTP header field, returns its value.  Capitalization and the use
7429 of hyphens versus underscores are not significant.
7430
7431 For example, all three of these examples are equivalent:
7432
7433    $requested_language = http('Accept-language');
7434    $requested_language = http('Accept_language');
7435    $requested_language = http('HTTP_ACCEPT_LANGUAGE');
7436
7437 =item B<https()>
7438
7439 The same as I<http()>, but operates on the HTTPS environment variables
7440 present when the SSL protocol is in effect.  Can be used to determine
7441 whether SSL is turned on.
7442
7443 =back
7444
7445 =head1 USING NPH SCRIPTS
7446
7447 NPH, or "no-parsed-header", scripts bypass the server completely by
7448 sending the complete HTTP header directly to the browser.  This has
7449 slight performance benefits, but is of most use for taking advantage
7450 of HTTP extensions that are not directly supported by your server,
7451 such as server push and PICS headers.
7452
7453 Servers use a variety of conventions for designating CGI scripts as
7454 NPH.  Many Unix servers look at the beginning of the script's name for
7455 the prefix "nph-".  The Macintosh WebSTAR server and Microsoft's
7456 Internet Information Server, in contrast, try to decide whether a
7457 program is an NPH script by examining the first line of script output.
7458
7459
7460 CGI.pm supports NPH scripts with a special NPH mode.  When in this
7461 mode, CGI.pm will output the necessary extra header information when
7462 the header() and redirect() methods are
7463 called.
7464
7465 The Microsoft Internet Information Server requires NPH mode.  As of
7466 version 2.30, CGI.pm will automatically detect when the script is
7467 running under IIS and put itself into this mode.  You do not need to
7468 do this manually, although it won't hurt anything if you do.  However,
7469 note that if you have applied Service Pack 6, much of the
7470 functionality of NPH scripts, including the ability to redirect while
7471 setting a cookie, b<do not work at all> on IIS without a special patch
7472 from Microsoft.  See
7473 http://support.microsoft.com/support/kb/articles/Q280/3/41.ASP:
7474 Non-Parsed Headers Stripped From CGI Applications That Have nph-
7475 Prefix in Name.
7476
7477 =over 4
7478
7479 =item In the B<use> statement
7480
7481 Simply add the "-nph" pragmato the list of symbols to be imported into
7482 your script:
7483
7484       use CGI qw(:standard -nph)
7485
7486 =item By calling the B<nph()> method:
7487
7488 Call B<nph()> with a non-zero parameter at any point after using CGI.pm in your program.
7489
7490       CGI->nph(1)
7491
7492 =item By using B<-nph> parameters
7493
7494 in the B<header()> and B<redirect()>  statements:
7495
7496       print header(-nph=>1);
7497
7498 =back
7499
7500 =head1 Server Push
7501
7502 CGI.pm provides four simple functions for producing multipart
7503 documents of the type needed to implement server push.  These
7504 functions were graciously provided by Ed Jordan <ed@fidalgo.net>.  To
7505 import these into your namespace, you must import the ":push" set.
7506 You are also advised to put the script into NPH mode and to set $| to
7507 1 to avoid buffering problems.
7508
7509 Here is a simple script that demonstrates server push:
7510
7511   #!/usr/local/bin/perl
7512   use CGI qw/:push -nph/;
7513   $| = 1;
7514   print multipart_init(-boundary=>'----here we go!');
7515   foreach (0 .. 4) {
7516       print multipart_start(-type=>'text/plain'),
7517             "The current time is ",scalar(localtime),"\n";
7518       if ($_ < 4) {
7519               print multipart_end;
7520       } else {
7521               print multipart_final;
7522       }
7523       sleep 1;
7524   }
7525
7526 This script initializes server push by calling B<multipart_init()>.
7527 It then enters a loop in which it begins a new multipart section by
7528 calling B<multipart_start()>, prints the current local time,
7529 and ends a multipart section with B<multipart_end()>.  It then sleeps
7530 a second, and begins again. On the final iteration, it ends the
7531 multipart section with B<multipart_final()> rather than with
7532 B<multipart_end()>.
7533
7534 =over 4
7535
7536 =item multipart_init()
7537
7538   multipart_init(-boundary=>$boundary);
7539
7540 Initialize the multipart system.  The -boundary argument specifies
7541 what MIME boundary string to use to separate parts of the document.
7542 If not provided, CGI.pm chooses a reasonable boundary for you.
7543
7544 =item multipart_start()
7545
7546   multipart_start(-type=>$type)
7547
7548 Start a new part of the multipart document using the specified MIME
7549 type.  If not specified, text/html is assumed.
7550
7551 =item multipart_end()
7552
7553   multipart_end()
7554
7555 End a part.  You must remember to call multipart_end() once for each
7556 multipart_start(), except at the end of the last part of the multipart
7557 document when multipart_final() should be called instead of multipart_end().
7558
7559 =item multipart_final()
7560
7561   multipart_final()
7562
7563 End all parts.  You should call multipart_final() rather than
7564 multipart_end() at the end of the last part of the multipart document.
7565
7566 =back
7567
7568 Users interested in server push applications should also have a look
7569 at the CGI::Push module.
7570
7571 Only Netscape Navigator supports server push.  Internet Explorer
7572 browsers do not.
7573
7574 =head1 Avoiding Denial of Service Attacks
7575
7576 A potential problem with CGI.pm is that, by default, it attempts to
7577 process form POSTings no matter how large they are.  A wily hacker
7578 could attack your site by sending a CGI script a huge POST of many
7579 megabytes.  CGI.pm will attempt to read the entire POST into a
7580 variable, growing hugely in size until it runs out of memory.  While
7581 the script attempts to allocate the memory the system may slow down
7582 dramatically.  This is a form of denial of service attack.
7583
7584 Another possible attack is for the remote user to force CGI.pm to
7585 accept a huge file upload.  CGI.pm will accept the upload and store it
7586 in a temporary directory even if your script doesn't expect to receive
7587 an uploaded file.  CGI.pm will delete the file automatically when it
7588 terminates, but in the meantime the remote user may have filled up the
7589 server's disk space, causing problems for other programs.
7590
7591 The best way to avoid denial of service attacks is to limit the amount
7592 of memory, CPU time and disk space that CGI scripts can use.  Some Web
7593 servers come with built-in facilities to accomplish this. In other
7594 cases, you can use the shell I<limit> or I<ulimit>
7595 commands to put ceilings on CGI resource usage.
7596
7597
7598 CGI.pm also has some simple built-in protections against denial of
7599 service attacks, but you must activate them before you can use them.
7600 These take the form of two global variables in the CGI name space:
7601
7602 =over 4
7603
7604 =item B<$CGI::POST_MAX>
7605
7606 If set to a non-negative integer, this variable puts a ceiling
7607 on the size of POSTings, in bytes.  If CGI.pm detects a POST
7608 that is greater than the ceiling, it will immediately exit with an error
7609 message.  This value will affect both ordinary POSTs and
7610 multipart POSTs, meaning that it limits the maximum size of file
7611 uploads as well.  You should set this to a reasonably high
7612 value, such as 1 megabyte.
7613
7614 =item B<$CGI::DISABLE_UPLOADS>
7615
7616 If set to a non-zero value, this will disable file uploads
7617 completely.  Other fill-out form values will work as usual.
7618
7619 =back
7620
7621 You can use these variables in either of two ways.
7622
7623 =over 4
7624
7625 =item B<1. On a script-by-script basis>
7626
7627 Set the variable at the top of the script, right after the "use" statement:
7628
7629     use CGI qw/:standard/;
7630     use CGI::Carp 'fatalsToBrowser';
7631     $CGI::POST_MAX=1024 * 100;  # max 100K posts
7632     $CGI::DISABLE_UPLOADS = 1;  # no uploads
7633
7634 =item B<2. Globally for all scripts>
7635
7636 Open up CGI.pm, find the definitions for $POST_MAX and
7637 $DISABLE_UPLOADS, and set them to the desired values.  You'll
7638 find them towards the top of the file in a subroutine named
7639 initialize_globals().
7640
7641 =back
7642
7643 An attempt to send a POST larger than $POST_MAX bytes will cause
7644 I<param()> to return an empty CGI parameter list.  You can test for
7645 this event by checking I<cgi_error()>, either after you create the CGI
7646 object or, if you are using the function-oriented interface, call
7647 <param()> for the first time.  If the POST was intercepted, then
7648 cgi_error() will return the message "413 POST too large".
7649
7650 This error message is actually defined by the HTTP protocol, and is
7651 designed to be returned to the browser as the CGI script's status
7652  code.  For example:
7653
7654    $uploaded_file = param('upload');
7655    if (!$uploaded_file && cgi_error()) {
7656       print header(-status=>cgi_error());
7657       exit 0;
7658    }
7659
7660 However it isn't clear that any browser currently knows what to do
7661 with this status code.  It might be better just to create an
7662 HTML page that warns the user of the problem.
7663
7664 =head1 COMPATIBILITY WITH CGI-LIB.PL
7665
7666 To make it easier to port existing programs that use cgi-lib.pl the
7667 compatibility routine "ReadParse" is provided.  Porting is simple:
7668
7669 OLD VERSION
7670     require "cgi-lib.pl";
7671     &ReadParse;
7672     print "The value of the antique is $in{antique}.\n";
7673
7674 NEW VERSION
7675     use CGI;
7676     CGI::ReadParse();
7677     print "The value of the antique is $in{antique}.\n";
7678
7679 CGI.pm's ReadParse() routine creates a tied variable named %in,
7680 which can be accessed to obtain the query variables.  Like
7681 ReadParse, you can also provide your own variable.  Infrequently
7682 used features of ReadParse, such as the creation of @in and $in
7683 variables, are not supported.
7684
7685 Once you use ReadParse, you can retrieve the query object itself
7686 this way:
7687
7688     $q = $in{CGI};
7689     print textfield(-name=>'wow',
7690                         -value=>'does this really work?');
7691
7692 This allows you to start using the more interesting features
7693 of CGI.pm without rewriting your old scripts from scratch.
7694
7695 =head1 AUTHOR INFORMATION
7696
7697 The GD.pm interface is copyright 1995-2007, Lincoln D. Stein.  It is
7698 distributed under GPL and the Artistic License 2.0.
7699
7700 Address bug reports and comments to: lstein@cshl.org.  When sending
7701 bug reports, please provide the version of CGI.pm, the version of
7702 Perl, the name and version of your Web server, and the name and
7703 version of the operating system you are using.  If the problem is even
7704 remotely browser dependent, please provide information about the
7705 affected browers as well.
7706
7707 =head1 CREDITS
7708
7709 Thanks very much to:
7710
7711 =over 4
7712
7713 =item Matt Heffron (heffron@falstaff.css.beckman.com)
7714
7715 =item James Taylor (james.taylor@srs.gov)
7716
7717 =item Scott Anguish <sanguish@digifix.com>
7718
7719 =item Mike Jewell (mlj3u@virginia.edu)
7720
7721 =item Timothy Shimmin (tes@kbs.citri.edu.au)
7722
7723 =item Joergen Haegg (jh@axis.se)
7724
7725 =item Laurent Delfosse (delfosse@delfosse.com)
7726
7727 =item Richard Resnick (applepi1@aol.com)
7728
7729 =item Craig Bishop (csb@barwonwater.vic.gov.au)
7730
7731 =item Tony Curtis (tc@vcpc.univie.ac.at)
7732
7733 =item Tim Bunce (Tim.Bunce@ig.co.uk)
7734
7735 =item Tom Christiansen (tchrist@convex.com)
7736
7737 =item Andreas Koenig (k@franz.ww.TU-Berlin.DE)
7738
7739 =item Tim MacKenzie (Tim.MacKenzie@fulcrum.com.au)
7740
7741 =item Kevin B. Hendricks (kbhend@dogwood.tyler.wm.edu)
7742
7743 =item Stephen Dahmen (joyfire@inxpress.net)
7744
7745 =item Ed Jordan (ed@fidalgo.net)
7746
7747 =item David Alan Pisoni (david@cnation.com)
7748
7749 =item Doug MacEachern (dougm@opengroup.org)
7750
7751 =item Robin Houston (robin@oneworld.org)
7752
7753 =item ...and many many more...
7754
7755 for suggestions and bug fixes.
7756
7757 =back
7758
7759 =head1 A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT
7760
7761
7762         #!/usr/local/bin/perl
7763
7764         use CGI ':standard';
7765
7766         print header;
7767         print start_html("Example CGI.pm Form");
7768         print "<h1> Example CGI.pm Form</h1>\n";
7769         print_prompt();
7770         do_work();
7771         print_tail();
7772         print end_html;
7773
7774         sub print_prompt {
7775            print start_form;
7776            print "<em>What's your name?</em><br>";
7777            print textfield('name');
7778            print checkbox('Not my real name');
7779
7780            print "<p><em>Where can you find English Sparrows?</em><br>";
7781            print checkbox_group(
7782                                  -name=>'Sparrow locations',
7783                                  -values=>[England,France,Spain,Asia,Hoboken],
7784                                  -linebreak=>'yes',
7785                                  -defaults=>[England,Asia]);
7786
7787            print "<p><em>How far can they fly?</em><br>",
7788                 radio_group(
7789                         -name=>'how far',
7790                         -values=>['10 ft','1 mile','10 miles','real far'],
7791                         -default=>'1 mile');
7792
7793            print "<p><em>What's your favorite color?</em>  ";
7794            print popup_menu(-name=>'Color',
7795                                     -values=>['black','brown','red','yellow'],
7796                                     -default=>'red');
7797
7798            print hidden('Reference','Monty Python and the Holy Grail');
7799
7800            print "<p><em>What have you got there?</em><br>";
7801            print scrolling_list(
7802                          -name=>'possessions',
7803                          -values=>['A Coconut','A Grail','An Icon',
7804                                    'A Sword','A Ticket'],
7805                          -size=>5,
7806                          -multiple=>'true');
7807
7808            print "<p><em>Any parting comments?</em><br>";
7809            print textarea(-name=>'Comments',
7810                                   -rows=>10,
7811                                   -columns=>50);
7812
7813            print "<p>",reset;
7814            print submit('Action','Shout');
7815            print submit('Action','Scream');
7816            print endform;
7817            print "<hr>\n";
7818         }
7819
7820         sub do_work {
7821            my(@values,$key);
7822
7823            print "<h2>Here are the current settings in this form</h2>";
7824
7825            foreach $key (param) {
7826               print "<strong>$key</strong> -> ";
7827               @values = param($key);
7828               print join(", ",@values),"<br>\n";
7829           }
7830         }
7831
7832         sub print_tail {
7833            print <<END;
7834         <hr>
7835         <address>Lincoln D. Stein</address><br>
7836         <a href="/">Home Page</a>
7837         END
7838         }
7839
7840 =head1 BUGS
7841
7842 Please report them.
7843
7844 =head1 SEE ALSO
7845
7846 L<CGI::Carp>, L<CGI::Fast>, L<CGI::Pretty>
7847
7848 =cut
7849