lib/CGI.pm

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