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