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