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