lib/CGI.pm

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