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