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