This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
98a88a0369724e057210d805407e66e0beb7d7ed
[perl5.git] / 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.206 2006/04/17 13:53:02 lstein Exp $';
22 $CGI::VERSION='3.19';
23
24 # HARD-CODED LOCATION FOR FILE UPLOAD TEMPORARY FILES.
25 # UNCOMMENT THIS ONLY IF YOU KNOW WHAT YOU'RE DOING.
26 # $CGITempFile::TMPDIRECTORY = '/usr/tmp';
27 use CGI::Util qw(rearrange make_attributes unescape escape expires ebcdic2ascii ascii2ebcdic);
28
29 #use constant XHTML_DTD => ['-//W3C//DTD XHTML Basic 1.0//EN',
30 #                           'http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd'];
31
32 use constant XHTML_DTD => ['-//W3C//DTD XHTML 1.0 Transitional//EN',
33                            'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'];
34
35 {
36   local $^W = 0;
37   $TAINTED = substr("$0$^X",0,0);
38 }
39
40 $MOD_PERL = 0; # no mod_perl by default
41 @SAVED_SYMBOLS = ();
42
43 # >>>>> Here are some globals that you might want to adjust <<<<<<
44 sub initialize_globals {
45     # Set this to 1 to enable copious autoloader debugging messages
46     $AUTOLOAD_DEBUG = 0;
47
48     # Set this to 1 to generate XTML-compatible output
49     $XHTML = 1;
50
51     # Change this to the preferred DTD to print in start_html()
52     # or use default_dtd('text of DTD to use');
53     $DEFAULT_DTD = [ '-//W3C//DTD HTML 4.01 Transitional//EN',
54                      'http://www.w3.org/TR/html4/loose.dtd' ] ;
55
56     # Set this to 1 to enable NOSTICKY scripts
57     # or: 
58     #    1) use CGI qw(-nosticky)
59     #    2) $CGI::nosticky(1)
60     $NOSTICKY = 0;
61
62     # Set this to 1 to enable NPH scripts
63     # or: 
64     #    1) use CGI qw(-nph)
65     #    2) CGI::nph(1)
66     #    3) print header(-nph=>1)
67     $NPH = 0;
68
69     # Set this to 1 to enable debugging from @ARGV
70     # Set to 2 to enable debugging from STDIN
71     $DEBUG = 1;
72
73     # Set this to 1 to make the temporary files created
74     # during file uploads safe from prying eyes
75     # or do...
76     #    1) use CGI qw(:private_tempfiles)
77     #    2) CGI::private_tempfiles(1);
78     $PRIVATE_TEMPFILES = 0;
79
80     # Set this to 1 to generate automatic tab indexes
81     $TABINDEX = 0;
82
83     # Set this to 1 to cause files uploaded in multipart documents
84     # to be closed, instead of caching the file handle
85     # or:
86     #    1) use CGI qw(:close_upload_files)
87     #    2) $CGI::close_upload_files(1);
88     # Uploads with many files run out of file handles.
89     # Also, for performance, since the file is already on disk,
90     # it can just be renamed, instead of read and written.
91     $CLOSE_UPLOAD_FILES = 0;
92
93     # Set this to a positive value to limit the size of a POSTing
94     # to a certain number of bytes:
95     $POST_MAX = -1;
96
97     # Change this to 1 to disable uploads entirely:
98     $DISABLE_UPLOADS = 0;
99
100     # Automatically determined -- don't change
101     $EBCDIC = 0;
102
103     # Change this to 1 to suppress redundant HTTP headers
104     $HEADERS_ONCE = 0;
105
106     # separate the name=value pairs by semicolons rather than ampersands
107     $USE_PARAM_SEMICOLONS = 1;
108
109     # Do not include undefined params parsed from query string
110     # use CGI qw(-no_undef_params);
111     $NO_UNDEF_PARAMS = 0;
112
113     # Other globals that you shouldn't worry about.
114     undef $Q;
115     $BEEN_THERE = 0;
116     $DTD_PUBLIC_IDENTIFIER = "";
117     undef @QUERY_PARAM;
118     undef %EXPORT;
119     undef $QUERY_CHARSET;
120     undef %QUERY_FIELDNAMES;
121
122     # prevent complaints by mod_perl
123     1;
124 }
125
126 # ------------------ START OF THE LIBRARY ------------
127
128 *end_form = \&endform;
129
130 # make mod_perlhappy
131 initialize_globals();
132
133 # FIGURE OUT THE OS WE'RE RUNNING UNDER
134 # Some systems support the $^O variable.  If not
135 # available then require() the Config library
136 unless ($OS) {
137     unless ($OS = $^O) {
138         require Config;
139         $OS = $Config::Config{'osname'};
140     }
141 }
142 if ($OS =~ /^MSWin/i) {
143   $OS = 'WINDOWS';
144 } elsif ($OS =~ /^VMS/i) {
145   $OS = 'VMS';
146 } elsif ($OS =~ /^dos/i) {
147   $OS = 'DOS';
148 } elsif ($OS =~ /^MacOS/i) {
149     $OS = 'MACINTOSH';
150 } elsif ($OS =~ /^os2/i) {
151     $OS = 'OS2';
152 } elsif ($OS =~ /^epoc/i) {
153     $OS = 'EPOC';
154 } elsif ($OS =~ /^cygwin/i) {
155     $OS = 'CYGWIN';
156 } else {
157     $OS = 'UNIX';
158 }
159
160 # Some OS logic.  Binary mode enabled on DOS, NT and VMS
161 $needs_binmode = $OS=~/^(WINDOWS|DOS|OS2|MSWin|CYGWIN)/;
162
163 # This is the default class for the CGI object to use when all else fails.
164 $DefaultClass = 'CGI' unless defined $CGI::DefaultClass;
165
166 # This is where to look for autoloaded routines.
167 $AutoloadClass = $DefaultClass unless defined $CGI::AutoloadClass;
168
169 # The path separator is a slash, backslash or semicolon, depending
170 # on the paltform.
171 $SL = {
172      UNIX    => '/',  OS2 => '\\', EPOC      => '/', CYGWIN => '/',
173      WINDOWS => '\\', DOS => '\\', MACINTOSH => ':', VMS    => '/'
174     }->{$OS};
175
176 # This no longer seems to be necessary
177 # Turn on NPH scripts by default when running under IIS server!
178 # $NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
179 $IIS++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
180
181 # Turn on special checking for Doug MacEachern's modperl
182 if (exists $ENV{MOD_PERL}) {
183   # mod_perl handlers may run system() on scripts using CGI.pm;
184   # Make sure so we don't get fooled by inherited $ENV{MOD_PERL}
185   if (exists $ENV{MOD_PERL_API_VERSION} && $ENV{MOD_PERL_API_VERSION} == 2) {
186     $MOD_PERL = 2;
187     require Apache2::Response;
188     require Apache2::RequestRec;
189     require Apache2::RequestUtil;
190     require Apache2::RequestIO;
191     require APR::Pool;
192   } else {
193     $MOD_PERL = 1;
194     require Apache;
195   }
196 }
197
198 # Turn on special checking for ActiveState's PerlEx
199 $PERLEX++ if defined($ENV{'GATEWAY_INTERFACE'}) && $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-PerlEx/;
200
201 # Define the CRLF sequence.  I can't use a simple "\r\n" because the meaning
202 # of "\n" is different on different OS's (sometimes it generates CRLF, sometimes LF
203 # and sometimes CR).  The most popular VMS web server
204 # doesn't accept CRLF -- instead it wants a LR.  EBCDIC machines don't
205 # use ASCII, so \015\012 means something different.  I find this all 
206 # really annoying.
207 $EBCDIC = "\t" ne "\011";
208 if ($OS eq 'VMS') {
209   $CRLF = "\n";
210 } elsif ($EBCDIC) {
211   $CRLF= "\r\n";
212 } else {
213   $CRLF = "\015\012";
214 }
215
216 if ($needs_binmode) {
217     $CGI::DefaultClass->binmode(\*main::STDOUT);
218     $CGI::DefaultClass->binmode(\*main::STDIN);
219     $CGI::DefaultClass->binmode(\*main::STDERR);
220 }
221
222 %EXPORT_TAGS = (
223                 ':html2'=>['h1'..'h6',qw/p br hr ol ul li dl dt dd menu code var strong em
224                            tt u i b blockquote pre img a address cite samp dfn html head
225                            base body Link nextid title meta kbd start_html end_html
226                            input Select option comment charset escapeHTML/],
227                 ':html3'=>[qw/div table caption th td TR Tr sup Sub strike applet Param 
228                            embed basefont style span layer ilayer font frameset frame script small big Area Map/],
229                 ':html4'=>[qw/abbr acronym bdo col colgroup del fieldset iframe
230                             ins label legend noframes noscript object optgroup Q 
231                             thead tbody tfoot/], 
232                 ':netscape'=>[qw/blink fontsize center/],
233                 ':form'=>[qw/textfield textarea filefield password_field hidden checkbox checkbox_group 
234                           submit reset defaults radio_group popup_menu button autoEscape
235                           scrolling_list image_button start_form end_form startform endform
236                           start_multipart_form end_multipart_form isindex tmpFileName uploadInfo URL_ENCODED MULTIPART/],
237                 ':cgi'=>[qw/param upload path_info path_translated request_uri url self_url script_name 
238                          cookie Dump
239                          raw_cookie request_method query_string Accept user_agent remote_host content_type
240                          remote_addr referer server_name server_software server_port server_protocol virtual_port
241                          virtual_host remote_ident auth_type http append
242                          save_parameters restore_parameters param_fetch
243                          remote_user user_name header redirect import_names put 
244                          Delete Delete_all url_param cgi_error/],
245                 ':ssl' => [qw/https/],
246                 ':cgi-lib' => [qw/ReadParse PrintHeader HtmlTop HtmlBot SplitParam Vars/],
247                 ':html' => [qw/:html2 :html3 :html4 :netscape/],
248                 ':standard' => [qw/:html2 :html3 :html4 :form :cgi/],
249                 ':push' => [qw/multipart_init multipart_start multipart_end multipart_final/],
250                 ':all' => [qw/:html2 :html3 :netscape :form :cgi :internal :html4/]
251                 );
252
253 # Custom 'can' method for both autoloaded and non-autoloaded subroutines.
254 # Author: Cees Hek <cees@sitesuite.com.au>
255
256 sub can {
257         my($class, $method) = @_;
258
259         # See if UNIVERSAL::can finds it.
260
261         if (my $func = $class -> SUPER::can($method) ){
262                 return $func;
263         }
264
265         # Try to compile the function.
266
267         eval {
268                 # _compile looks at $AUTOLOAD for the function name.
269
270                 local $AUTOLOAD = join "::", $class, $method;
271                 &_compile;
272         };
273
274         # Now that the function is loaded (if it exists)
275         # just use UNIVERSAL::can again to do the work.
276
277         return $class -> SUPER::can($method);
278 }
279
280 # to import symbols into caller
281 sub import {
282     my $self = shift;
283
284     # This causes modules to clash.
285     undef %EXPORT_OK;
286     undef %EXPORT;
287
288     $self->_setup_symbols(@_);
289     my ($callpack, $callfile, $callline) = caller;
290
291     # To allow overriding, search through the packages
292     # Till we find one in which the correct subroutine is defined.
293     my @packages = ($self,@{"$self\:\:ISA"});
294     foreach $sym (keys %EXPORT) {
295         my $pck;
296         my $def = ${"$self\:\:AutoloadClass"} || $DefaultClass;
297         foreach $pck (@packages) {
298             if (defined(&{"$pck\:\:$sym"})) {
299                 $def = $pck;
300                 last;
301             }
302         }
303         *{"${callpack}::$sym"} = \&{"$def\:\:$sym"};
304     }
305 }
306
307 sub compile {
308     my $pack = shift;
309     $pack->_setup_symbols('-compile',@_);
310 }
311
312 sub expand_tags {
313     my($tag) = @_;
314     return ("start_$1","end_$1") if $tag=~/^(?:\*|start_|end_)(.+)/;
315     my(@r);
316     return ($tag) unless $EXPORT_TAGS{$tag};
317     foreach (@{$EXPORT_TAGS{$tag}}) {
318         push(@r,&expand_tags($_));
319     }
320     return @r;
321 }
322
323 #### Method: new
324 # The new routine.  This will check the current environment
325 # for an existing query string, and initialize itself, if so.
326 ####
327 sub new {
328   my($class,@initializer) = @_;
329   my $self = {};
330
331   bless $self,ref $class || $class || $DefaultClass;
332
333   # always use a tempfile
334   $self->{'use_tempfile'} = 1;
335
336   if (ref($initializer[0])
337       && (UNIVERSAL::isa($initializer[0],'Apache')
338           ||
339           UNIVERSAL::isa($initializer[0],'Apache2::RequestRec')
340          )) {
341     $self->r(shift @initializer);
342   }
343  if (ref($initializer[0]) 
344      && (UNIVERSAL::isa($initializer[0],'CODE'))) {
345     $self->upload_hook(shift @initializer, shift @initializer);
346     $self->{'use_tempfile'} = shift @initializer if (@initializer > 0);
347   }
348   if ($MOD_PERL) {
349     if ($MOD_PERL == 1) {
350       $self->r(Apache->request) unless $self->r;
351       my $r = $self->r;
352       $r->register_cleanup(\&CGI::_reset_globals);
353     }
354     else {
355       # XXX: once we have the new API
356       # will do a real PerlOptions -SetupEnv check
357       $self->r(Apache2::RequestUtil->request) unless $self->r;
358       my $r = $self->r;
359       $r->subprocess_env unless exists $ENV{REQUEST_METHOD};
360       $r->pool->cleanup_register(\&CGI::_reset_globals);
361     }
362     undef $NPH;
363   }
364   $self->_reset_globals if $PERLEX;
365   $self->init(@initializer);
366   return $self;
367 }
368
369 # We provide a DESTROY method so that we can ensure that
370 # temporary files are closed (via Fh->DESTROY) before they
371 # are unlinked (via CGITempFile->DESTROY) because it is not
372 # possible to unlink an open file on Win32. We explicitly
373 # call DESTROY on each, rather than just undefing them and
374 # letting Perl DESTROY them by garbage collection, in case the
375 # user is still holding any reference to them as well.
376 sub DESTROY {
377   my $self = shift;
378   if ($OS eq 'WINDOWS') {
379     foreach my $href (values %{$self->{'.tmpfiles'}}) {
380       $href->{hndl}->DESTROY if defined $href->{hndl};
381       $href->{name}->DESTROY if defined $href->{name};
382     }
383   }
384 }
385
386 sub r {
387   my $self = shift;
388   my $r = $self->{'.r'};
389   $self->{'.r'} = shift if @_;
390   $r;
391 }
392
393 sub upload_hook {
394   my $self;
395   if (ref $_[0] eq 'CODE') {
396     $CGI::Q = $self = $CGI::DefaultClass->new(@_);
397   } else {
398     $self = shift;
399   }
400   my ($hook,$data,$use_tempfile) = @_;
401   $self->{'.upload_hook'} = $hook;
402   $self->{'.upload_data'} = $data;
403   $self->{'use_tempfile'} = $use_tempfile if defined $use_tempfile;
404 }
405
406 #### Method: param
407 # Returns the value(s)of a named parameter.
408 # If invoked in a list context, returns the
409 # entire list.  Otherwise returns the first
410 # member of the list.
411 # If name is not provided, return a list of all
412 # the known parameters names available.
413 # If more than one argument is provided, the
414 # second and subsequent arguments are used to
415 # set the value of the parameter.
416 ####
417 sub param {
418     my($self,@p) = self_or_default(@_);
419     return $self->all_parameters unless @p;
420     my($name,$value,@other);
421
422     # For compatibility between old calling style and use_named_parameters() style, 
423     # we have to special case for a single parameter present.
424     if (@p > 1) {
425         ($name,$value,@other) = rearrange([NAME,[DEFAULT,VALUE,VALUES]],@p);
426         my(@values);
427
428         if (substr($p[0],0,1) eq '-') {
429             @values = defined($value) ? (ref($value) && ref($value) eq 'ARRAY' ? @{$value} : $value) : ();
430         } else {
431             foreach ($value,@other) {
432                 push(@values,$_) if defined($_);
433             }
434         }
435         # If values is provided, then we set it.
436         if (defined $value) {
437             $self->add_parameter($name);
438             $self->{$name}=[@values];
439         }
440     } else {
441         $name = $p[0];
442     }
443
444     return unless defined($name) && $self->{$name};
445     return wantarray ? @{$self->{$name}} : $self->{$name}->[0];
446 }
447
448 sub self_or_default {
449     return @_ if defined($_[0]) && (!ref($_[0])) &&($_[0] eq 'CGI');
450     unless (defined($_[0]) && 
451             (ref($_[0]) eq 'CGI' || UNIVERSAL::isa($_[0],'CGI')) # slightly optimized for common case
452             ) {
453         $Q = $CGI::DefaultClass->new unless defined($Q);
454         unshift(@_,$Q);
455     }
456     return wantarray ? @_ : $Q;
457 }
458
459 sub self_or_CGI {
460     local $^W=0;                # prevent a warning
461     if (defined($_[0]) &&
462         (substr(ref($_[0]),0,3) eq 'CGI' 
463          || UNIVERSAL::isa($_[0],'CGI'))) {
464         return @_;
465     } else {
466         return ($DefaultClass,@_);
467     }
468 }
469
470 ########################################
471 # THESE METHODS ARE MORE OR LESS PRIVATE
472 # GO TO THE __DATA__ SECTION TO SEE MORE
473 # PUBLIC METHODS
474 ########################################
475
476 # Initialize the query object from the environment.
477 # If a parameter list is found, this object will be set
478 # to an associative array in which parameter names are keys
479 # and the values are stored as lists
480 # If a keyword list is found, this method creates a bogus
481 # parameter list with the single parameter 'keywords'.
482
483 sub init {
484   my $self = shift;
485   my($query_string,$meth,$content_length,$fh,@lines) = ('','','','');
486
487   my $initializer = shift;  # for backward compatibility
488   local($/) = "\n";
489
490     # set autoescaping on by default
491     $self->{'escape'} = 1;
492
493     # if we get called more than once, we want to initialize
494     # ourselves from the original query (which may be gone
495     # if it was read from STDIN originally.)
496     if (defined(@QUERY_PARAM) && !defined($initializer)) {
497         foreach (@QUERY_PARAM) {
498             $self->param('-name'=>$_,'-value'=>$QUERY_PARAM{$_});
499         }
500         $self->charset($QUERY_CHARSET);
501         $self->{'.fieldnames'} = {%QUERY_FIELDNAMES};
502         return;
503     }
504
505     $meth=$ENV{'REQUEST_METHOD'} if defined($ENV{'REQUEST_METHOD'});
506     $content_length = defined($ENV{'CONTENT_LENGTH'}) ? $ENV{'CONTENT_LENGTH'} : 0;
507
508     $fh = to_filehandle($initializer) if $initializer;
509
510     # set charset to the safe ISO-8859-1
511     $self->charset('ISO-8859-1');
512
513   METHOD: {
514
515       # avoid unreasonably large postings
516       if (($POST_MAX > 0) && ($content_length > $POST_MAX)) {
517         # quietly read and discard the post
518           my $buffer;
519           my $tmplength = $content_length;
520           while($tmplength > 0) {
521                  my $maxbuffer = ($tmplength < 10000)?$tmplength:10000;
522                  my $bytesread = $MOD_PERL ? $self->r->read($buffer,$maxbuffer) : read(STDIN,$buffer,$maxbuffer);
523                  $tmplength -= $bytesread;
524           }
525           $self->cgi_error("413 Request entity too large");
526           last METHOD;
527        }
528
529       # Process multipart postings, but only if the initializer is
530       # not defined.
531       if ($meth eq 'POST'
532           && defined($ENV{'CONTENT_TYPE'})
533           && $ENV{'CONTENT_TYPE'}=~m|^multipart/form-data|
534           && !defined($initializer)
535           ) {
536           my($boundary) = $ENV{'CONTENT_TYPE'} =~ /boundary=\"?([^\";,]+)\"?/;
537           $self->read_multipart($boundary,$content_length);
538           last METHOD;
539       } 
540
541       # If initializer is defined, then read parameters
542       # from it.
543       if (defined($initializer)) {
544           if (UNIVERSAL::isa($initializer,'CGI')) {
545               $query_string = $initializer->query_string;
546               last METHOD;
547           }
548           if (ref($initializer) && ref($initializer) eq 'HASH') {
549               foreach (keys %$initializer) {
550                   $self->param('-name'=>$_,'-value'=>$initializer->{$_});
551               }
552               last METHOD;
553           }
554           
555           if (defined($fh) && ($fh ne '')) {
556               while (<$fh>) {
557                   chomp;
558                   last if /^=/;
559                   push(@lines,$_);
560               }
561               # massage back into standard format
562               if ("@lines" =~ /=/) {
563                   $query_string=join("&",@lines);
564               } else {
565                   $query_string=join("+",@lines);
566               }
567               last METHOD;
568           }
569
570           if (defined($fh) && ($fh ne '')) {
571               while (<$fh>) {
572                   chomp;
573                   last if /^=/;
574                   push(@lines,$_);
575               }
576               # massage back into standard format
577               if ("@lines" =~ /=/) {
578                   $query_string=join("&",@lines);
579               } else {
580                   $query_string=join("+",@lines);
581               }
582               last METHOD;
583           }
584
585           # last chance -- treat it as a string
586           $initializer = $$initializer if ref($initializer) eq 'SCALAR';
587           $query_string = $initializer;
588
589           last METHOD;
590       }
591
592       # If method is GET or HEAD, fetch the query from
593       # the environment.
594       if ($meth=~/^(GET|HEAD)$/) {
595           if ($MOD_PERL) {
596             $query_string = $self->r->args;
597           } else {
598               $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
599               $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'};
600           }
601           last METHOD;
602       }
603
604       if ($meth eq 'POST') {
605           $self->read_from_client(\$query_string,$content_length,0)
606               if $content_length > 0;
607           # Some people want to have their cake and eat it too!
608           # Uncomment this line to have the contents of the query string
609           # APPENDED to the POST data.
610           # $query_string .= (length($query_string) ? '&' : '') . $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
611           last METHOD;
612       }
613
614       # If $meth is not of GET, POST or HEAD, assume we're being debugged offline.
615       # Check the command line and then the standard input for data.
616       # We use the shellwords package in order to behave the way that
617       # UN*X programmers expect.
618       if ($DEBUG)
619       {
620           my $cmdline_ret = read_from_cmdline();
621           $query_string = $cmdline_ret->{'query_string'};
622           if (defined($cmdline_ret->{'subpath'}))
623           {
624               $self->path_info($cmdline_ret->{'subpath'});
625           }
626       }
627   }
628
629 # YL: Begin Change for XML handler 10/19/2001
630     if ($meth eq 'POST'
631         && defined($ENV{'CONTENT_TYPE'})
632         && $ENV{'CONTENT_TYPE'} !~ m|^application/x-www-form-urlencoded|
633         && $ENV{'CONTENT_TYPE'} !~ m|^multipart/form-data| ) {
634         my($param) = 'POSTDATA' ;
635         $self->add_parameter($param) ;
636       push (@{$self->{$param}},$query_string);
637       undef $query_string ;
638     }
639 # YL: End Change for XML handler 10/19/2001
640
641     # We now have the query string in hand.  We do slightly
642     # different things for keyword lists and parameter lists.
643     if (defined $query_string && length $query_string) {
644         if ($query_string =~ /[&=;]/) {
645             $self->parse_params($query_string);
646         } else {
647             $self->add_parameter('keywords');
648             $self->{'keywords'} = [$self->parse_keywordlist($query_string)];
649         }
650     }
651
652     # Special case.  Erase everything if there is a field named
653     # .defaults.
654     if ($self->param('.defaults')) {
655       $self->delete_all();
656     }
657
658     # Associative array containing our defined fieldnames
659     $self->{'.fieldnames'} = {};
660     foreach ($self->param('.cgifields')) {
661         $self->{'.fieldnames'}->{$_}++;
662     }
663     
664     # Clear out our default submission button flag if present
665     $self->delete('.submit');
666     $self->delete('.cgifields');
667
668     $self->save_request unless defined $initializer;
669 }
670
671 # FUNCTIONS TO OVERRIDE:
672 # Turn a string into a filehandle
673 sub to_filehandle {
674     my $thingy = shift;
675     return undef unless $thingy;
676     return $thingy if UNIVERSAL::isa($thingy,'GLOB');
677     return $thingy if UNIVERSAL::isa($thingy,'FileHandle');
678     if (!ref($thingy)) {
679         my $caller = 1;
680         while (my $package = caller($caller++)) {
681             my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy"; 
682             return $tmp if defined(fileno($tmp));
683         }
684     }
685     return undef;
686 }
687
688 # send output to the browser
689 sub put {
690     my($self,@p) = self_or_default(@_);
691     $self->print(@p);
692 }
693
694 # print to standard output (for overriding in mod_perl)
695 sub print {
696     shift;
697     CORE::print(@_);
698 }
699
700 # get/set last cgi_error
701 sub cgi_error {
702     my ($self,$err) = self_or_default(@_);
703     $self->{'.cgi_error'} = $err if defined $err;
704     return $self->{'.cgi_error'};
705 }
706
707 sub save_request {
708     my($self) = @_;
709     # We're going to play with the package globals now so that if we get called
710     # again, we initialize ourselves in exactly the same way.  This allows
711     # us to have several of these objects.
712     @QUERY_PARAM = $self->param; # save list of parameters
713     foreach (@QUERY_PARAM) {
714       next unless defined $_;
715       $QUERY_PARAM{$_}=$self->{$_};
716     }
717     $QUERY_CHARSET = $self->charset;
718     %QUERY_FIELDNAMES = %{$self->{'.fieldnames'}};
719 }
720
721 sub parse_params {
722     my($self,$tosplit) = @_;
723     my(@pairs) = split(/[&;]/,$tosplit);
724     my($param,$value);
725     foreach (@pairs) {
726         ($param,$value) = split('=',$_,2);
727         next unless defined $param;
728         next if $NO_UNDEF_PARAMS and not defined $value;
729         $value = '' unless defined $value;
730         $param = unescape($param);
731         $value = unescape($value);
732         $self->add_parameter($param);
733         push (@{$self->{$param}},$value);
734     }
735 }
736
737 sub add_parameter {
738     my($self,$param)=@_;
739     return unless defined $param;
740     push (@{$self->{'.parameters'}},$param) 
741         unless defined($self->{$param});
742 }
743
744 sub all_parameters {
745     my $self = shift;
746     return () unless defined($self) && $self->{'.parameters'};
747     return () unless @{$self->{'.parameters'}};
748     return @{$self->{'.parameters'}};
749 }
750
751 # put a filehandle into binary mode (DOS)
752 sub binmode {
753     return unless defined($_[1]) && defined fileno($_[1]);
754     CORE::binmode($_[1]);
755 }
756
757 sub _make_tag_func {
758     my ($self,$tagname) = @_;
759     my $func = qq(
760         sub $tagname {
761          my (\$q,\$a,\@rest) = self_or_default(\@_);
762          my(\$attr) = '';
763          if (ref(\$a) && ref(\$a) eq 'HASH') {
764             my(\@attr) = make_attributes(\$a,\$q->{'escape'});
765             \$attr = " \@attr" if \@attr;
766           } else {
767             unshift \@rest,\$a if defined \$a;
768           }
769         );
770     if ($tagname=~/start_(\w+)/i) {
771         $func .= qq! return "<\L$1\E\$attr>";} !;
772     } elsif ($tagname=~/end_(\w+)/i) {
773         $func .= qq! return "<\L/$1\E>"; } !;
774     } else {
775         $func .= qq#
776             return \$XHTML ? "\L<$tagname\E\$attr />" : "\L<$tagname\E\$attr>" unless \@rest;
777             my(\$tag,\$untag) = ("\L<$tagname\E\$attr>","\L</$tagname>\E");
778             my \@result = map { "\$tag\$_\$untag" } 
779                               (ref(\$rest[0]) eq 'ARRAY') ? \@{\$rest[0]} : "\@rest";
780             return "\@result";
781             }#;
782     }
783 return $func;
784 }
785
786 sub AUTOLOAD {
787     print STDERR "CGI::AUTOLOAD for $AUTOLOAD\n" if $CGI::AUTOLOAD_DEBUG;
788     my $func = &_compile;
789     goto &$func;
790 }
791
792 sub _compile {
793     my($func) = $AUTOLOAD;
794     my($pack,$func_name);
795     {
796         local($1,$2); # this fixes an obscure variable suicide problem.
797         $func=~/(.+)::([^:]+)$/;
798         ($pack,$func_name) = ($1,$2);
799         $pack=~s/::SUPER$//;    # fix another obscure problem
800         $pack = ${"$pack\:\:AutoloadClass"} || $CGI::DefaultClass
801             unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"});
802
803         my($sub) = \%{"$pack\:\:SUBS"};
804         unless (%$sub) {
805            my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"};
806            local ($@,$!);
807            eval "package $pack; $$auto";
808            croak("$AUTOLOAD: $@") if $@;
809            $$auto = '';  # Free the unneeded storage (but don't undef it!!!)
810        }
811        my($code) = $sub->{$func_name};
812
813        $code = "sub $AUTOLOAD { }" if (!$code and $func_name eq 'DESTROY');
814        if (!$code) {
815            (my $base = $func_name) =~ s/^(start_|end_)//i;
816            if ($EXPORT{':any'} || 
817                $EXPORT{'-any'} ||
818                $EXPORT{$base} || 
819                (%EXPORT_OK || grep(++$EXPORT_OK{$_},&expand_tags(':html')))
820                    && $EXPORT_OK{$base}) {
821                $code = $CGI::DefaultClass->_make_tag_func($func_name);
822            }
823        }
824        croak("Undefined subroutine $AUTOLOAD\n") unless $code;
825        local ($@,$!);
826        eval "package $pack; $code";
827        if ($@) {
828            $@ =~ s/ at .*\n//;
829            croak("$AUTOLOAD: $@");
830        }
831     }       
832     CORE::delete($sub->{$func_name});  #free storage
833     return "$pack\:\:$func_name";
834 }
835
836 sub _selected {
837   my $self = shift;
838   my $value = shift;
839   return '' unless $value;
840   return $XHTML ? qq(selected="selected" ) : qq(selected );
841 }
842
843 sub _checked {
844   my $self = shift;
845   my $value = shift;
846   return '' unless $value;
847   return $XHTML ? qq(checked="checked" ) : qq(checked );
848 }
849
850 sub _reset_globals { initialize_globals(); }
851
852 sub _setup_symbols {
853     my $self = shift;
854     my $compile = 0;
855
856     # to avoid reexporting unwanted variables
857     undef %EXPORT;
858
859     foreach (@_) {
860         $HEADERS_ONCE++,         next if /^[:-]unique_headers$/;
861         $NPH++,                  next if /^[:-]nph$/;
862         $NOSTICKY++,             next if /^[:-]nosticky$/;
863         $DEBUG=0,                next if /^[:-]no_?[Dd]ebug$/;
864         $DEBUG=2,                next if /^[:-][Dd]ebug$/;
865         $USE_PARAM_SEMICOLONS++, next if /^[:-]newstyle_urls$/;
866         $XHTML++,                next if /^[:-]xhtml$/;
867         $XHTML=0,                next if /^[:-]no_?xhtml$/;
868         $USE_PARAM_SEMICOLONS=0, next if /^[:-]oldstyle_urls$/;
869         $PRIVATE_TEMPFILES++,    next if /^[:-]private_tempfiles$/;
870         $TABINDEX++,             next if /^[:-]tabindex$/;
871         $CLOSE_UPLOAD_FILES++,   next if /^[:-]close_upload_files$/;
872         $EXPORT{$_}++,           next if /^[:-]any$/;
873         $compile++,              next if /^[:-]compile$/;
874         $NO_UNDEF_PARAMS++,      next if /^[:-]no_undef_params$/;
875         
876         # This is probably extremely evil code -- to be deleted some day.
877         if (/^[-]autoload$/) {
878             my($pkg) = caller(1);
879             *{"${pkg}::AUTOLOAD"} = sub { 
880                 my($routine) = $AUTOLOAD;
881                 $routine =~ s/^.*::/CGI::/;
882                 &$routine;
883             };
884             next;
885         }
886
887         foreach (&expand_tags($_)) {
888             tr/a-zA-Z0-9_//cd;  # don't allow weird function names
889             $EXPORT{$_}++;
890         }
891     }
892     _compile_all(keys %EXPORT) if $compile;
893     @SAVED_SYMBOLS = @_;
894 }
895
896 sub charset {
897   my ($self,$charset) = self_or_default(@_);
898   $self->{'.charset'} = $charset if defined $charset;
899   $self->{'.charset'};
900 }
901
902 sub element_id {
903   my ($self,$new_value) = self_or_default(@_);
904   $self->{'.elid'} = $new_value if defined $new_value;
905   sprintf('%010d',$self->{'.elid'}++);
906 }
907
908 sub element_tab {
909   my ($self,$new_value) = self_or_default(@_);
910   $self->{'.etab'} ||= 1;
911   $self->{'.etab'} = $new_value if defined $new_value;
912   my $tab = $self->{'.etab'}++;
913   return '' unless $TABINDEX or defined $new_value;
914   return qq(tabindex="$tab" );
915 }
916
917 ###############################################################################
918 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
919 ###############################################################################
920 $AUTOLOADED_ROUTINES = '';      # get rid of -w warning
921 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
922
923 %SUBS = (
924
925 'URL_ENCODED'=> <<'END_OF_FUNC',
926 sub URL_ENCODED { 'application/x-www-form-urlencoded'; }
927 END_OF_FUNC
928
929 'MULTIPART' => <<'END_OF_FUNC',
930 sub MULTIPART {  'multipart/form-data'; }
931 END_OF_FUNC
932
933 'SERVER_PUSH' => <<'END_OF_FUNC',
934 sub SERVER_PUSH { 'multipart/x-mixed-replace;boundary="' . shift() . '"'; }
935 END_OF_FUNC
936
937 'new_MultipartBuffer' => <<'END_OF_FUNC',
938 # Create a new multipart buffer
939 sub new_MultipartBuffer {
940     my($self,$boundary,$length) = @_;
941     return MultipartBuffer->new($self,$boundary,$length);
942 }
943 END_OF_FUNC
944
945 'read_from_client' => <<'END_OF_FUNC',
946 # Read data from a file handle
947 sub read_from_client {
948     my($self, $buff, $len, $offset) = @_;
949     local $^W=0;                # prevent a warning
950     return $MOD_PERL
951         ? $self->r->read($$buff, $len, $offset)
952         : read(\*STDIN, $$buff, $len, $offset);
953 }
954 END_OF_FUNC
955
956 'delete' => <<'END_OF_FUNC',
957 #### Method: delete
958 # Deletes the named parameter entirely.
959 ####
960 sub delete {
961     my($self,@p) = self_or_default(@_);
962     my(@names) = rearrange([NAME],@p);
963     my @to_delete = ref($names[0]) eq 'ARRAY' ? @$names[0] : @names;
964     my %to_delete;
965     foreach my $name (@to_delete)
966     {
967         CORE::delete $self->{$name};
968         CORE::delete $self->{'.fieldnames'}->{$name};
969         $to_delete{$name}++;
970     }
971     @{$self->{'.parameters'}}=grep { !exists($to_delete{$_}) } $self->param();
972     return;
973 }
974 END_OF_FUNC
975
976 #### Method: import_names
977 # Import all parameters into the given namespace.
978 # Assumes namespace 'Q' if not specified
979 ####
980 'import_names' => <<'END_OF_FUNC',
981 sub import_names {
982     my($self,$namespace,$delete) = self_or_default(@_);
983     $namespace = 'Q' unless defined($namespace);
984     die "Can't import names into \"main\"\n" if \%{"${namespace}::"} == \%::;
985     if ($delete || $MOD_PERL || exists $ENV{'FCGI_ROLE'}) {
986         # can anyone find an easier way to do this?
987         foreach (keys %{"${namespace}::"}) {
988             local *symbol = "${namespace}::${_}";
989             undef $symbol;
990             undef @symbol;
991             undef %symbol;
992         }
993     }
994     my($param,@value,$var);
995     foreach $param ($self->param) {
996         # protect against silly names
997         ($var = $param)=~tr/a-zA-Z0-9_/_/c;
998         $var =~ s/^(?=\d)/_/;
999         local *symbol = "${namespace}::$var";
1000         @value = $self->param($param);
1001         @symbol = @value;
1002         $symbol = $value[0];
1003     }
1004 }
1005 END_OF_FUNC
1006
1007 #### Method: keywords
1008 # Keywords acts a bit differently.  Calling it in a list context
1009 # returns the list of keywords.  
1010 # Calling it in a scalar context gives you the size of the list.
1011 ####
1012 'keywords' => <<'END_OF_FUNC',
1013 sub keywords {
1014     my($self,@values) = self_or_default(@_);
1015     # If values is provided, then we set it.
1016     $self->{'keywords'}=[@values] if @values;
1017     my(@result) = defined($self->{'keywords'}) ? @{$self->{'keywords'}} : ();
1018     @result;
1019 }
1020 END_OF_FUNC
1021
1022 # These are some tie() interfaces for compatibility
1023 # with Steve Brenner's cgi-lib.pl routines
1024 'Vars' => <<'END_OF_FUNC',
1025 sub Vars {
1026     my $q = shift;
1027     my %in;
1028     tie(%in,CGI,$q);
1029     return %in if wantarray;
1030     return \%in;
1031 }
1032 END_OF_FUNC
1033
1034 # These are some tie() interfaces for compatibility
1035 # with Steve Brenner's cgi-lib.pl routines
1036 'ReadParse' => <<'END_OF_FUNC',
1037 sub ReadParse {
1038     local(*in);
1039     if (@_) {
1040         *in = $_[0];
1041     } else {
1042         my $pkg = caller();
1043         *in=*{"${pkg}::in"};
1044     }
1045     tie(%in,CGI);
1046     return scalar(keys %in);
1047 }
1048 END_OF_FUNC
1049
1050 'PrintHeader' => <<'END_OF_FUNC',
1051 sub PrintHeader {
1052     my($self) = self_or_default(@_);
1053     return $self->header();
1054 }
1055 END_OF_FUNC
1056
1057 'HtmlTop' => <<'END_OF_FUNC',
1058 sub HtmlTop {
1059     my($self,@p) = self_or_default(@_);
1060     return $self->start_html(@p);
1061 }
1062 END_OF_FUNC
1063
1064 'HtmlBot' => <<'END_OF_FUNC',
1065 sub HtmlBot {
1066     my($self,@p) = self_or_default(@_);
1067     return $self->end_html(@p);
1068 }
1069 END_OF_FUNC
1070
1071 'SplitParam' => <<'END_OF_FUNC',
1072 sub SplitParam {
1073     my ($param) = @_;
1074     my (@params) = split ("\0", $param);
1075     return (wantarray ? @params : $params[0]);
1076 }
1077 END_OF_FUNC
1078
1079 'MethGet' => <<'END_OF_FUNC',
1080 sub MethGet {
1081     return request_method() eq 'GET';
1082 }
1083 END_OF_FUNC
1084
1085 'MethPost' => <<'END_OF_FUNC',
1086 sub MethPost {
1087     return request_method() eq 'POST';
1088 }
1089 END_OF_FUNC
1090
1091 'TIEHASH' => <<'END_OF_FUNC',
1092 sub TIEHASH {
1093     my $class = shift;
1094     my $arg   = $_[0];
1095     if (ref($arg) && UNIVERSAL::isa($arg,'CGI')) {
1096        return $arg;
1097     }
1098     return $Q ||= $class->new(@_);
1099 }
1100 END_OF_FUNC
1101
1102 'STORE' => <<'END_OF_FUNC',
1103 sub STORE {
1104     my $self = shift;
1105     my $tag  = shift;
1106     my $vals = shift;
1107     my @vals = index($vals,"\0")!=-1 ? split("\0",$vals) : $vals;
1108     $self->param(-name=>$tag,-value=>\@vals);
1109 }
1110 END_OF_FUNC
1111
1112 'FETCH' => <<'END_OF_FUNC',
1113 sub FETCH {
1114     return $_[0] if $_[1] eq 'CGI';
1115     return undef unless defined $_[0]->param($_[1]);
1116     return join("\0",$_[0]->param($_[1]));
1117 }
1118 END_OF_FUNC
1119
1120 'FIRSTKEY' => <<'END_OF_FUNC',
1121 sub FIRSTKEY {
1122     $_[0]->{'.iterator'}=0;
1123     $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
1124 }
1125 END_OF_FUNC
1126
1127 'NEXTKEY' => <<'END_OF_FUNC',
1128 sub NEXTKEY {
1129     $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
1130 }
1131 END_OF_FUNC
1132
1133 'EXISTS' => <<'END_OF_FUNC',
1134 sub EXISTS {
1135     exists $_[0]->{$_[1]};
1136 }
1137 END_OF_FUNC
1138
1139 'DELETE' => <<'END_OF_FUNC',
1140 sub DELETE {
1141     $_[0]->delete($_[1]);
1142 }
1143 END_OF_FUNC
1144
1145 'CLEAR' => <<'END_OF_FUNC',
1146 sub CLEAR {
1147     %{$_[0]}=();
1148 }
1149 ####
1150 END_OF_FUNC
1151
1152 ####
1153 # Append a new value to an existing query
1154 ####
1155 'append' => <<'EOF',
1156 sub append {
1157     my($self,@p) = self_or_default(@_);
1158     my($name,$value) = rearrange([NAME,[VALUE,VALUES]],@p);
1159     my(@values) = defined($value) ? (ref($value) ? @{$value} : $value) : ();
1160     if (@values) {
1161         $self->add_parameter($name);
1162         push(@{$self->{$name}},@values);
1163     }
1164     return $self->param($name);
1165 }
1166 EOF
1167
1168 #### Method: delete_all
1169 # Delete all parameters
1170 ####
1171 'delete_all' => <<'EOF',
1172 sub delete_all {
1173     my($self) = self_or_default(@_);
1174     my @param = $self->param();
1175     $self->delete(@param);
1176 }
1177 EOF
1178
1179 'Delete' => <<'EOF',
1180 sub Delete {
1181     my($self,@p) = self_or_default(@_);
1182     $self->delete(@p);
1183 }
1184 EOF
1185
1186 'Delete_all' => <<'EOF',
1187 sub Delete_all {
1188     my($self,@p) = self_or_default(@_);
1189     $self->delete_all(@p);
1190 }
1191 EOF
1192
1193 #### Method: autoescape
1194 # If you want to turn off the autoescaping features,
1195 # call this method with undef as the argument
1196 'autoEscape' => <<'END_OF_FUNC',
1197 sub autoEscape {
1198     my($self,$escape) = self_or_default(@_);
1199     my $d = $self->{'escape'};
1200     $self->{'escape'} = $escape;
1201     $d;
1202 }
1203 END_OF_FUNC
1204
1205
1206 #### Method: version
1207 # Return the current version
1208 ####
1209 'version' => <<'END_OF_FUNC',
1210 sub version {
1211     return $VERSION;
1212 }
1213 END_OF_FUNC
1214
1215 #### Method: url_param
1216 # Return a parameter in the QUERY_STRING, regardless of
1217 # whether this was a POST or a GET
1218 ####
1219 'url_param' => <<'END_OF_FUNC',
1220 sub url_param {
1221     my ($self,@p) = self_or_default(@_);
1222     my $name = shift(@p);
1223     return undef unless exists($ENV{QUERY_STRING});
1224     unless (exists($self->{'.url_param'})) {
1225         $self->{'.url_param'}={}; # empty hash
1226         if ($ENV{QUERY_STRING} =~ /=/) {
1227             my(@pairs) = split(/[&;]/,$ENV{QUERY_STRING});
1228             my($param,$value);
1229             foreach (@pairs) {
1230                 ($param,$value) = split('=',$_,2);
1231                 $param = unescape($param);
1232                 $value = unescape($value);
1233                 push(@{$self->{'.url_param'}->{$param}},$value);
1234             }
1235         } else {
1236             $self->{'.url_param'}->{'keywords'} = [$self->parse_keywordlist($ENV{QUERY_STRING})];
1237         }
1238     }
1239     return keys %{$self->{'.url_param'}} unless defined($name);
1240     return () unless $self->{'.url_param'}->{$name};
1241     return wantarray ? @{$self->{'.url_param'}->{$name}}
1242                      : $self->{'.url_param'}->{$name}->[0];
1243 }
1244 END_OF_FUNC
1245
1246 #### Method: Dump
1247 # Returns a string in which all the known parameter/value 
1248 # pairs are represented as nested lists, mainly for the purposes 
1249 # of debugging.
1250 ####
1251 'Dump' => <<'END_OF_FUNC',
1252 sub Dump {
1253     my($self) = self_or_default(@_);
1254     my($param,$value,@result);
1255     return '<ul></ul>' unless $self->param;
1256     push(@result,"<ul>");
1257     foreach $param ($self->param) {
1258         my($name)=$self->escapeHTML($param);
1259         push(@result,"<li><strong>$param</strong></li>");
1260         push(@result,"<ul>");
1261         foreach $value ($self->param($param)) {
1262             $value = $self->escapeHTML($value);
1263             $value =~ s/\n/<br \/>\n/g;
1264             push(@result,"<li>$value</li>");
1265         }
1266         push(@result,"</ul>");
1267     }
1268     push(@result,"</ul>");
1269     return join("\n",@result);
1270 }
1271 END_OF_FUNC
1272
1273 #### Method as_string
1274 #
1275 # synonym for "dump"
1276 ####
1277 'as_string' => <<'END_OF_FUNC',
1278 sub as_string {
1279     &Dump(@_);
1280 }
1281 END_OF_FUNC
1282
1283 #### Method: save
1284 # Write values out to a filehandle in such a way that they can
1285 # be reinitialized by the filehandle form of the new() method
1286 ####
1287 'save' => <<'END_OF_FUNC',
1288 sub save {
1289     my($self,$filehandle) = self_or_default(@_);
1290     $filehandle = to_filehandle($filehandle);
1291     my($param);
1292     local($,) = '';  # set print field separator back to a sane value
1293     local($\) = '';  # set output line separator to a sane value
1294     foreach $param ($self->param) {
1295         my($escaped_param) = escape($param);
1296         my($value);
1297         foreach $value ($self->param($param)) {
1298             print $filehandle "$escaped_param=",escape("$value"),"\n";
1299         }
1300     }
1301     foreach (keys %{$self->{'.fieldnames'}}) {
1302           print $filehandle ".cgifields=",escape("$_"),"\n";
1303     }
1304     print $filehandle "=\n";    # end of record
1305 }
1306 END_OF_FUNC
1307
1308
1309 #### Method: save_parameters
1310 # An alias for save() that is a better name for exportation.
1311 # Only intended to be used with the function (non-OO) interface.
1312 ####
1313 'save_parameters' => <<'END_OF_FUNC',
1314 sub save_parameters {
1315     my $fh = shift;
1316     return save(to_filehandle($fh));
1317 }
1318 END_OF_FUNC
1319
1320 #### Method: restore_parameters
1321 # A way to restore CGI parameters from an initializer.
1322 # Only intended to be used with the function (non-OO) interface.
1323 ####
1324 'restore_parameters' => <<'END_OF_FUNC',
1325 sub restore_parameters {
1326     $Q = $CGI::DefaultClass->new(@_);
1327 }
1328 END_OF_FUNC
1329
1330 #### Method: multipart_init
1331 # Return a Content-Type: style header for server-push
1332 # This has to be NPH on most web servers, and it is advisable to set $| = 1
1333 #
1334 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1335 # contribution, updated by Andrew Benham (adsb@bigfoot.com)
1336 ####
1337 'multipart_init' => <<'END_OF_FUNC',
1338 sub multipart_init {
1339     my($self,@p) = self_or_default(@_);
1340     my($boundary,@other) = rearrange([BOUNDARY],@p);
1341     $boundary = $boundary || '------- =_aaaaaaaaaa0';
1342     $self->{'separator'} = "$CRLF--$boundary$CRLF";
1343     $self->{'final_separator'} = "$CRLF--$boundary--$CRLF";
1344     $type = SERVER_PUSH($boundary);
1345     return $self->header(
1346         -nph => 0,
1347         -type => $type,
1348         (map { split "=", $_, 2 } @other),
1349     ) . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $self->multipart_end;
1350 }
1351 END_OF_FUNC
1352
1353
1354 #### Method: multipart_start
1355 # Return a Content-Type: style header for server-push, start of section
1356 #
1357 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1358 # contribution, updated by Andrew Benham (adsb@bigfoot.com)
1359 ####
1360 'multipart_start' => <<'END_OF_FUNC',
1361 sub multipart_start {
1362     my(@header);
1363     my($self,@p) = self_or_default(@_);
1364     my($type,@other) = rearrange([TYPE],@p);
1365     $type = $type || 'text/html';
1366     push(@header,"Content-Type: $type");
1367
1368     # rearrange() was designed for the HTML portion, so we
1369     # need to fix it up a little.
1370     foreach (@other) {
1371         # Don't use \s because of perl bug 21951
1372         next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/;
1373         ($_ = $header) =~ s/^(\w)(.*)/$1 . lc ($2) . ': '.$self->unescapeHTML($value)/e;
1374     }
1375     push(@header,@other);
1376     my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1377     return $header;
1378 }
1379 END_OF_FUNC
1380
1381
1382 #### Method: multipart_end
1383 # Return a MIME boundary separator for server-push, end of section
1384 #
1385 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1386 # contribution
1387 ####
1388 'multipart_end' => <<'END_OF_FUNC',
1389 sub multipart_end {
1390     my($self,@p) = self_or_default(@_);
1391     return $self->{'separator'};
1392 }
1393 END_OF_FUNC
1394
1395
1396 #### Method: multipart_final
1397 # Return a MIME boundary separator for server-push, end of all sections
1398 #
1399 # Contributed by Andrew Benham (adsb@bigfoot.com)
1400 ####
1401 'multipart_final' => <<'END_OF_FUNC',
1402 sub multipart_final {
1403     my($self,@p) = self_or_default(@_);
1404     return $self->{'final_separator'} . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $CRLF;
1405 }
1406 END_OF_FUNC
1407
1408
1409 #### Method: header
1410 # Return a Content-Type: style header
1411 #
1412 ####
1413 'header' => <<'END_OF_FUNC',
1414 sub header {
1415     my($self,@p) = self_or_default(@_);
1416     my(@header);
1417
1418     return "" if $self->{'.header_printed'}++ and $HEADERS_ONCE;
1419
1420     my($type,$status,$cookie,$target,$expires,$nph,$charset,$attachment,$p3p,@other) = 
1421         rearrange([['TYPE','CONTENT_TYPE','CONTENT-TYPE'],
1422                             'STATUS',['COOKIE','COOKIES'],'TARGET',
1423                             'EXPIRES','NPH','CHARSET',
1424                             'ATTACHMENT','P3P'],@p);
1425
1426     $nph     ||= $NPH;
1427
1428     $type ||= 'text/html' unless defined($type);
1429
1430     if (defined $charset) {
1431       $self->charset($charset);
1432     } else {
1433       $charset = $self->charset if $type =~ /^text\//;
1434     }
1435    $charset ||= '';
1436
1437     # rearrange() was designed for the HTML portion, so we
1438     # need to fix it up a little.
1439     foreach (@other) {
1440         # Don't use \s because of perl bug 21951
1441         next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/;
1442         ($_ = $header) =~ s/^(\w)(.*)/"\u$1\L$2" . ': '.$self->unescapeHTML($value)/e;
1443     }
1444
1445     $type .= "; charset=$charset"
1446       if     $type ne ''
1447          and $type !~ /\bcharset\b/
1448          and defined $charset
1449          and $charset ne '';
1450
1451     # Maybe future compatibility.  Maybe not.
1452     my $protocol = $ENV{SERVER_PROTOCOL} || 'HTTP/1.0';
1453     push(@header,$protocol . ' ' . ($status || '200 OK')) if $nph;
1454     push(@header,"Server: " . &server_software()) if $nph;
1455
1456     push(@header,"Status: $status") if $status;
1457     push(@header,"Window-Target: $target") if $target;
1458     if ($p3p) {
1459        $p3p = join ' ',@$p3p if ref($p3p) eq 'ARRAY';
1460        push(@header,qq(P3P: policyref="/w3c/p3p.xml", CP="$p3p"));
1461     }
1462     # push all the cookies -- there may be several
1463     if ($cookie) {
1464         my(@cookie) = ref($cookie) && ref($cookie) eq 'ARRAY' ? @{$cookie} : $cookie;
1465         foreach (@cookie) {
1466             my $cs = UNIVERSAL::isa($_,'CGI::Cookie') ? $_->as_string : $_;
1467             push(@header,"Set-Cookie: $cs") if $cs ne '';
1468         }
1469     }
1470     # if the user indicates an expiration time, then we need
1471     # both an Expires and a Date header (so that the browser is
1472     # uses OUR clock)
1473     push(@header,"Expires: " . expires($expires,'http'))
1474         if $expires;
1475     push(@header,"Date: " . expires(0,'http')) if $expires || $cookie || $nph;
1476     push(@header,"Pragma: no-cache") if $self->cache();
1477     push(@header,"Content-Disposition: attachment; filename=\"$attachment\"") if $attachment;
1478     push(@header,map {ucfirst $_} @other);
1479     push(@header,"Content-Type: $type") if $type ne '';
1480     my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1481     if ($MOD_PERL and not $nph) {
1482         $self->r->send_cgi_header($header);
1483         return '';
1484     }
1485     return $header;
1486 }
1487 END_OF_FUNC
1488
1489
1490 #### Method: cache
1491 # Control whether header() will produce the no-cache
1492 # Pragma directive.
1493 ####
1494 'cache' => <<'END_OF_FUNC',
1495 sub cache {
1496     my($self,$new_value) = self_or_default(@_);
1497     $new_value = '' unless $new_value;
1498     if ($new_value ne '') {
1499         $self->{'cache'} = $new_value;
1500     }
1501     return $self->{'cache'};
1502 }
1503 END_OF_FUNC
1504
1505
1506 #### Method: redirect
1507 # Return a Location: style header
1508 #
1509 ####
1510 'redirect' => <<'END_OF_FUNC',
1511 sub redirect {
1512     my($self,@p) = self_or_default(@_);
1513     my($url,$target,$status,$cookie,$nph,@other) = 
1514          rearrange([[LOCATION,URI,URL],TARGET,STATUS,['COOKIE','COOKIES'],NPH],@p);
1515     $status = '302 Found' unless defined $status;
1516     $url ||= $self->self_url;
1517     my(@o);
1518     foreach (@other) { tr/\"//d; push(@o,split("=",$_,2)); }
1519     unshift(@o,
1520          '-Status'  => $status,
1521          '-Location'=> $url,
1522          '-nph'     => $nph);
1523     unshift(@o,'-Target'=>$target) if $target;
1524     unshift(@o,'-Type'=>'');
1525     my @unescaped;
1526     unshift(@unescaped,'-Cookie'=>$cookie) if $cookie;
1527     return $self->header((map {$self->unescapeHTML($_)} @o),@unescaped);
1528 }
1529 END_OF_FUNC
1530
1531
1532 #### Method: start_html
1533 # Canned HTML header
1534 #
1535 # Parameters:
1536 # $title -> (optional) The title for this HTML document (-title)
1537 # $author -> (optional) e-mail address of the author (-author)
1538 # $base -> (optional) if set to true, will enter the BASE address of this document
1539 #          for resolving relative references (-base) 
1540 # $xbase -> (optional) alternative base at some remote location (-xbase)
1541 # $target -> (optional) target window to load all links into (-target)
1542 # $script -> (option) Javascript code (-script)
1543 # $no_script -> (option) Javascript <noscript> tag (-noscript)
1544 # $meta -> (optional) Meta information tags
1545 # $head -> (optional) any other elements you'd like to incorporate into the <head> tag
1546 #           (a scalar or array ref)
1547 # $style -> (optional) reference to an external style sheet
1548 # @other -> (optional) any other named parameters you'd like to incorporate into
1549 #           the <body> tag.
1550 ####
1551 'start_html' => <<'END_OF_FUNC',
1552 sub start_html {
1553     my($self,@p) = &self_or_default(@_);
1554     my($title,$author,$base,$xbase,$script,$noscript,
1555         $target,$meta,$head,$style,$dtd,$lang,$encoding,$declare_xml,@other) = 
1556         rearrange([TITLE,AUTHOR,BASE,XBASE,SCRIPT,NOSCRIPT,TARGET,
1557                    META,HEAD,STYLE,DTD,LANG,ENCODING,DECLARE_XML],@p);
1558
1559     $self->element_id(0);
1560     $self->element_tab(0);
1561
1562     $encoding = lc($self->charset) unless defined $encoding;
1563
1564     # Need to sort out the DTD before it's okay to call escapeHTML().
1565     my(@result,$xml_dtd);
1566     if ($dtd) {
1567         if (defined(ref($dtd)) and (ref($dtd) eq 'ARRAY')) {
1568             $dtd = $DEFAULT_DTD unless $dtd->[0] =~ m|^-//|;
1569         } else {
1570             $dtd = $DEFAULT_DTD unless $dtd =~ m|^-//|;
1571         }
1572     } else {
1573         $dtd = $XHTML ? XHTML_DTD : $DEFAULT_DTD;
1574     }
1575
1576     $xml_dtd++ if ref($dtd) eq 'ARRAY' && $dtd->[0] =~ /\bXHTML\b/i;
1577     $xml_dtd++ if ref($dtd) eq '' && $dtd =~ /\bXHTML\b/i;
1578     push @result,qq(<?xml version="1.0" encoding="$encoding"?>) if $xml_dtd && $declare_xml;
1579
1580     if (ref($dtd) && ref($dtd) eq 'ARRAY') {
1581         push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd->[0]"\n\t "$dtd->[1]">));
1582         $DTD_PUBLIC_IDENTIFIER = $dtd->[0];
1583     } else {
1584         push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd">));
1585         $DTD_PUBLIC_IDENTIFIER = $dtd;
1586     }
1587
1588     # Now that we know whether we're using the HTML 3.2 DTD or not, it's okay to
1589     # call escapeHTML().  Strangely enough, the title needs to be escaped as
1590     # HTML while the author needs to be escaped as a URL.
1591     $title = $self->escapeHTML($title || 'Untitled Document');
1592     $author = $self->escape($author);
1593
1594     if ($DTD_PUBLIC_IDENTIFIER =~ /[^X]HTML (2\.0|3\.2)/i) {
1595         $lang = "" unless defined $lang;
1596         $XHTML = 0;
1597     }
1598     else {
1599         $lang = 'en-US' unless defined $lang;
1600     }
1601
1602     my $lang_bits = $lang ne '' ? qq( lang="$lang" xml:lang="$lang") : '';
1603     my $meta_bits = qq(<meta http-equiv="Content-Type" content="text/html; charset=$encoding" />) 
1604                     if $XHTML && $encoding && !$declare_xml;
1605
1606     push(@result,$XHTML ? qq(<html xmlns="http://www.w3.org/1999/xhtml"$lang_bits>\n<head>\n<title>$title</title>)
1607                         : ($lang ? qq(<html lang="$lang">) : "<html>")
1608                           . "<head><title>$title</title>");
1609         if (defined $author) {
1610     push(@result,$XHTML ? "<link rev=\"made\" href=\"mailto:$author\" />"
1611                         : "<link rev=\"made\" href=\"mailto:$author\">");
1612         }
1613
1614     if ($base || $xbase || $target) {
1615         my $href = $xbase || $self->url('-path'=>1);
1616         my $t = $target ? qq/ target="$target"/ : '';
1617         push(@result,$XHTML ? qq(<base href="$href"$t />) : qq(<base href="$href"$t>));
1618     }
1619
1620     if ($meta && ref($meta) && (ref($meta) eq 'HASH')) {
1621         foreach (keys %$meta) { push(@result,$XHTML ? qq(<meta name="$_" content="$meta->{$_}" />) 
1622                         : qq(<meta name="$_" content="$meta->{$_}">)); }
1623     }
1624
1625     push(@result,ref($head) ? @$head : $head) if $head;
1626
1627     # handle the infrequently-used -style and -script parameters
1628     push(@result,$self->_style($style))   if defined $style;
1629     push(@result,$self->_script($script)) if defined $script;
1630     push(@result,$meta_bits)              if defined $meta_bits;
1631
1632     # handle -noscript parameter
1633     push(@result,<<END) if $noscript;
1634 <noscript>
1635 $noscript
1636 </noscript>
1637 END
1638     ;
1639     my($other) = @other ? " @other" : '';
1640     push(@result,"</head>\n<body$other>\n");
1641     return join("\n",@result);
1642 }
1643 END_OF_FUNC
1644
1645 ### Method: _style
1646 # internal method for generating a CSS style section
1647 ####
1648 '_style' => <<'END_OF_FUNC',
1649 sub _style {
1650     my ($self,$style) = @_;
1651     my (@result);
1652     my $type = 'text/css';
1653
1654     my $cdata_start = $XHTML ? "\n<!--/* <![CDATA[ */" : "\n<!-- ";
1655     my $cdata_end   = $XHTML ? "\n/* ]]> */-->\n" : " -->\n";
1656
1657     my @s = ref($style) eq 'ARRAY' ? @$style : $style;
1658
1659     for my $s (@s) {
1660       if (ref($s)) {
1661        my($src,$code,$verbatim,$stype,$foo,@other) =
1662            rearrange([qw(SRC CODE VERBATIM TYPE FOO)],
1663                       ('-foo'=>'bar',
1664                        ref($s) eq 'ARRAY' ? @$s : %$s));
1665        $type  = $stype if $stype;
1666        my $other = @other ? join ' ',@other : '';
1667
1668        if (ref($src) eq "ARRAY") # Check to see if the $src variable is an array reference
1669        { # If it is, push a LINK tag for each one
1670            foreach $src (@$src)
1671          {
1672            push(@result,$XHTML ? qq(<link rel="stylesheet" type="$type" href="$src" $other/>)
1673                              : qq(<link rel="stylesheet" type="$type" href="$src"$other>)) if $src;
1674          }
1675        }
1676        else
1677        { # Otherwise, push the single -src, if it exists.
1678          push(@result,$XHTML ? qq(<link rel="stylesheet" type="$type" href="$src" $other/>)
1679                              : qq(<link rel="stylesheet" type="$type" href="$src"$other>)
1680               ) if $src;
1681         }
1682      if ($verbatim) {
1683            my @v = ref($verbatim) eq 'ARRAY' ? @$verbatim : $verbatim;
1684            push(@result, "<style type=\"text/css\">\n$_\n</style>") foreach @v;
1685       }
1686       my @c = ref($code) eq 'ARRAY' ? @$code : $code if $code;
1687       push(@result,style({'type'=>$type},"$cdata_start\n$_\n$cdata_end")) foreach @c;
1688
1689       } else {
1690            my $src = $s;
1691            push(@result,$XHTML ? qq(<link rel="stylesheet" type="$type" href="$src" $other/>)
1692                                : qq(<link rel="stylesheet" type="$type" href="$src"$other>));
1693       }
1694     }
1695     @result;
1696 }
1697 END_OF_FUNC
1698
1699 '_script' => <<'END_OF_FUNC',
1700 sub _script {
1701     my ($self,$script) = @_;
1702     my (@result);
1703
1704     my (@scripts) = ref($script) eq 'ARRAY' ? @$script : ($script);
1705     foreach $script (@scripts) {
1706         my($src,$code,$language);
1707         if (ref($script)) { # script is a hash
1708             ($src,$code,$language, $type) =
1709                 rearrange([SRC,CODE,LANGUAGE,TYPE],
1710                                  '-foo'=>'bar', # a trick to allow the '-' to be omitted
1711                                  ref($script) eq 'ARRAY' ? @$script : %$script);
1712             # User may not have specified language
1713             $language ||= 'JavaScript';
1714             unless (defined $type) {
1715                 $type = lc $language;
1716                 # strip '1.2' from 'javascript1.2'
1717                 $type =~ s/^(\D+).*$/text\/$1/;
1718             }
1719         } else {
1720             ($src,$code,$language, $type) = ('',$script,'JavaScript', 'text/javascript');
1721         }
1722
1723     my $comment = '//';  # javascript by default
1724     $comment = '#' if $type=~/perl|tcl/i;
1725     $comment = "'" if $type=~/vbscript/i;
1726
1727     my ($cdata_start,$cdata_end);
1728     if ($XHTML) {
1729        $cdata_start    = "$comment<![CDATA[\n";
1730        $cdata_end     .= "\n$comment]]>";
1731     } else {
1732        $cdata_start  =  "\n<!-- Hide script\n";
1733        $cdata_end    = $comment;
1734        $cdata_end   .= " End script hiding -->\n";
1735    }
1736      my(@satts);
1737      push(@satts,'src'=>$src) if $src;
1738      push(@satts,'language'=>$language) unless defined $type;
1739      push(@satts,'type'=>$type);
1740      $code = $cdata_start . $code . $cdata_end if defined $code;
1741      push(@result,$self->script({@satts},$code || ''));
1742     }
1743     @result;
1744 }
1745 END_OF_FUNC
1746
1747 #### Method: end_html
1748 # End an HTML document.
1749 # Trivial method for completeness.  Just returns "</body>"
1750 ####
1751 'end_html' => <<'END_OF_FUNC',
1752 sub end_html {
1753     return "\n</body>\n</html>";
1754 }
1755 END_OF_FUNC
1756
1757
1758 ################################
1759 # METHODS USED IN BUILDING FORMS
1760 ################################
1761
1762 #### Method: isindex
1763 # Just prints out the isindex tag.
1764 # Parameters:
1765 #  $action -> optional URL of script to run
1766 # Returns:
1767 #   A string containing a <isindex> tag
1768 'isindex' => <<'END_OF_FUNC',
1769 sub isindex {
1770     my($self,@p) = self_or_default(@_);
1771     my($action,@other) = rearrange([ACTION],@p);
1772     $action = qq/ action="$action"/ if $action;
1773     my($other) = @other ? " @other" : '';
1774     return $XHTML ? "<isindex$action$other />" : "<isindex$action$other>";
1775 }
1776 END_OF_FUNC
1777
1778
1779 #### Method: startform
1780 # Start a form
1781 # Parameters:
1782 #   $method -> optional submission method to use (GET or POST)
1783 #   $action -> optional URL of script to run
1784 #   $enctype ->encoding to use (URL_ENCODED or MULTIPART)
1785 'startform' => <<'END_OF_FUNC',
1786 sub startform {
1787     my($self,@p) = self_or_default(@_);
1788
1789     my($method,$action,$enctype,@other) = 
1790         rearrange([METHOD,ACTION,ENCTYPE],@p);
1791
1792     $method  = $self->escapeHTML(lc($method) || 'post');
1793     $enctype = $self->escapeHTML($enctype || &URL_ENCODED);
1794     if (defined $action) {
1795        $action = $self->escapeHTML($action);
1796     }
1797     else {
1798        $action = $self->escapeHTML($self->request_uri);
1799     }
1800     $action = qq(action="$action");
1801     my($other) = @other ? " @other" : '';
1802     $self->{'.parametersToAdd'}={};
1803     return qq/<form method="$method" $action enctype="$enctype"$other>\n/;
1804 }
1805 END_OF_FUNC
1806
1807
1808 #### Method: start_form
1809 # synonym for startform
1810 'start_form' => <<'END_OF_FUNC',
1811 sub start_form {
1812     $XHTML ? &start_multipart_form : &startform;
1813 }
1814 END_OF_FUNC
1815
1816 'end_multipart_form' => <<'END_OF_FUNC',
1817 sub end_multipart_form {
1818     &endform;
1819 }
1820 END_OF_FUNC
1821
1822 #### Method: start_multipart_form
1823 # synonym for startform
1824 'start_multipart_form' => <<'END_OF_FUNC',
1825 sub start_multipart_form {
1826     my($self,@p) = self_or_default(@_);
1827     if (defined($p[0]) && substr($p[0],0,1) eq '-') {
1828         my(%p) = @p;
1829         $p{'-enctype'}=&MULTIPART;
1830         return $self->startform(%p);
1831     } else {
1832         my($method,$action,@other) = 
1833             rearrange([METHOD,ACTION],@p);
1834         return $self->startform($method,$action,&MULTIPART,@other);
1835     }
1836 }
1837 END_OF_FUNC
1838
1839
1840 #### Method: endform
1841 # End a form
1842 'endform' => <<'END_OF_FUNC',
1843 sub endform {
1844     my($self,@p) = self_or_default(@_);
1845     if ( $NOSTICKY ) {
1846     return wantarray ? ("</form>") : "\n</form>";
1847     } else {
1848       if (my @fields = $self->get_fields) {
1849          return wantarray ? ("<div>",@fields,"</div>","</form>")
1850                           : "<div>".(join '',@fields)."</div>\n</form>";
1851       } else {
1852          return "</form>";
1853       }
1854     }
1855 }
1856 END_OF_FUNC
1857
1858
1859 '_textfield' => <<'END_OF_FUNC',
1860 sub _textfield {
1861     my($self,$tag,@p) = self_or_default(@_);
1862     my($name,$default,$size,$maxlength,$override,$tabindex,@other) = 
1863         rearrange([NAME,[DEFAULT,VALUE,VALUES],SIZE,MAXLENGTH,[OVERRIDE,FORCE],TABINDEX],@p);
1864
1865     my $current = $override ? $default : 
1866         (defined($self->param($name)) ? $self->param($name) : $default);
1867
1868     $current = defined($current) ? $self->escapeHTML($current,1) : '';
1869     $name = defined($name) ? $self->escapeHTML($name) : '';
1870     my($s) = defined($size) ? qq/ size="$size"/ : '';
1871     my($m) = defined($maxlength) ? qq/ maxlength="$maxlength"/ : '';
1872     my($other) = @other ? " @other" : '';
1873     # this entered at cristy's request to fix problems with file upload fields
1874     # and WebTV -- not sure it won't break stuff
1875     my($value) = $current ne '' ? qq(value="$current") : '';
1876     $tabindex = $self->element_tab($tabindex);
1877     return $XHTML ? qq(<input type="$tag" name="$name" $tabindex$value$s$m$other />) 
1878                   : qq(<input type="$tag" name="$name" $value$s$m$other>);
1879 }
1880 END_OF_FUNC
1881
1882 #### Method: textfield
1883 # Parameters:
1884 #   $name -> Name of the text field
1885 #   $default -> Optional default value of the field if not
1886 #                already defined.
1887 #   $size ->  Optional width of field in characaters.
1888 #   $maxlength -> Optional maximum number of characters.
1889 # Returns:
1890 #   A string containing a <input type="text"> field
1891 #
1892 'textfield' => <<'END_OF_FUNC',
1893 sub textfield {
1894     my($self,@p) = self_or_default(@_);
1895     $self->_textfield('text',@p);
1896 }
1897 END_OF_FUNC
1898
1899
1900 #### Method: filefield
1901 # Parameters:
1902 #   $name -> Name of the file upload field
1903 #   $size ->  Optional width of field in characaters.
1904 #   $maxlength -> Optional maximum number of characters.
1905 # Returns:
1906 #   A string containing a <input type="file"> field
1907 #
1908 'filefield' => <<'END_OF_FUNC',
1909 sub filefield {
1910     my($self,@p) = self_or_default(@_);
1911     $self->_textfield('file',@p);
1912 }
1913 END_OF_FUNC
1914
1915
1916 #### Method: password
1917 # Create a "secret password" entry field
1918 # Parameters:
1919 #   $name -> Name of the field
1920 #   $default -> Optional default value of the field if not
1921 #                already defined.
1922 #   $size ->  Optional width of field in characters.
1923 #   $maxlength -> Optional maximum characters that can be entered.
1924 # Returns:
1925 #   A string containing a <input type="password"> field
1926 #
1927 'password_field' => <<'END_OF_FUNC',
1928 sub password_field {
1929     my ($self,@p) = self_or_default(@_);
1930     $self->_textfield('password',@p);
1931 }
1932 END_OF_FUNC
1933
1934 #### Method: textarea
1935 # Parameters:
1936 #   $name -> Name of the text field
1937 #   $default -> Optional default value of the field if not
1938 #                already defined.
1939 #   $rows ->  Optional number of rows in text area
1940 #   $columns -> Optional number of columns in text area
1941 # Returns:
1942 #   A string containing a <textarea></textarea> tag
1943 #
1944 'textarea' => <<'END_OF_FUNC',
1945 sub textarea {
1946     my($self,@p) = self_or_default(@_);
1947     my($name,$default,$rows,$cols,$override,$tabindex,@other) =
1948         rearrange([NAME,[DEFAULT,VALUE],ROWS,[COLS,COLUMNS],[OVERRIDE,FORCE],TABINDEX],@p);
1949
1950     my($current)= $override ? $default :
1951         (defined($self->param($name)) ? $self->param($name) : $default);
1952
1953     $name = defined($name) ? $self->escapeHTML($name) : '';
1954     $current = defined($current) ? $self->escapeHTML($current) : '';
1955     my($r) = $rows ? qq/ rows="$rows"/ : '';
1956     my($c) = $cols ? qq/ cols="$cols"/ : '';
1957     my($other) = @other ? " @other" : '';
1958     $tabindex = $self->element_tab($tabindex);
1959     return qq{<textarea name="$name" $tabindex$r$c$other>$current</textarea>};
1960 }
1961 END_OF_FUNC
1962
1963
1964 #### Method: button
1965 # Create a javascript button.
1966 # Parameters:
1967 #   $name ->  (optional) Name for the button. (-name)
1968 #   $value -> (optional) Value of the button when selected (and visible name) (-value)
1969 #   $onclick -> (optional) Text of the JavaScript to run when the button is
1970 #                clicked.
1971 # Returns:
1972 #   A string containing a <input type="button"> tag
1973 ####
1974 'button' => <<'END_OF_FUNC',
1975 sub button {
1976     my($self,@p) = self_or_default(@_);
1977
1978     my($label,$value,$script,$tabindex,@other) = rearrange([NAME,[VALUE,LABEL],
1979                                                             [ONCLICK,SCRIPT],TABINDEX],@p);
1980
1981     $label=$self->escapeHTML($label);
1982     $value=$self->escapeHTML($value,1);
1983     $script=$self->escapeHTML($script);
1984
1985     my($name) = '';
1986     $name = qq/ name="$label"/ if $label;
1987     $value = $value || $label;
1988     my($val) = '';
1989     $val = qq/ value="$value"/ if $value;
1990     $script = qq/ onclick="$script"/ if $script;
1991     my($other) = @other ? " @other" : '';
1992     $tabindex = $self->element_tab($tabindex);
1993     return $XHTML ? qq(<input type="button" $tabindex$name$val$script$other />)
1994                   : qq(<input type="button"$name$val$script$other>);
1995 }
1996 END_OF_FUNC
1997
1998
1999 #### Method: submit
2000 # Create a "submit query" button.
2001 # Parameters:
2002 #   $name ->  (optional) Name for the button.
2003 #   $value -> (optional) Value of the button when selected (also doubles as label).
2004 #   $label -> (optional) Label printed on the button(also doubles as the value).
2005 # Returns:
2006 #   A string containing a <input type="submit"> tag
2007 ####
2008 'submit' => <<'END_OF_FUNC',
2009 sub submit {
2010     my($self,@p) = self_or_default(@_);
2011
2012     my($label,$value,$tabindex,@other) = rearrange([NAME,[VALUE,LABEL],TABINDEX],@p);
2013
2014     $label=$self->escapeHTML($label);
2015     $value=$self->escapeHTML($value,1);
2016
2017     my $name = $NOSTICKY ? '' : 'name=".submit" ';
2018     $name = qq/name="$label" / if defined($label);
2019     $value = defined($value) ? $value : $label;
2020     my $val = '';
2021     $val = qq/value="$value" / if defined($value);
2022     $tabindex = $self->element_tab($tabindex);
2023     my($other) = @other ? "@other " : '';
2024     return $XHTML ? qq(<input type="submit" $tabindex$name$val$other/>)
2025                   : qq(<input type="submit" $name$val$other>);
2026 }
2027 END_OF_FUNC
2028
2029
2030 #### Method: reset
2031 # Create a "reset" button.
2032 # Parameters:
2033 #   $name -> (optional) Name for the button.
2034 # Returns:
2035 #   A string containing a <input type="reset"> tag
2036 ####
2037 'reset' => <<'END_OF_FUNC',
2038 sub reset {
2039     my($self,@p) = self_or_default(@_);
2040     my($label,$value,$tabindex,@other) = rearrange(['NAME',['VALUE','LABEL'],TABINDEX],@p);
2041     $label=$self->escapeHTML($label);
2042     $value=$self->escapeHTML($value,1);
2043     my ($name) = ' name=".reset"';
2044     $name = qq/ name="$label"/ if defined($label);
2045     $value = defined($value) ? $value : $label;
2046     my($val) = '';
2047     $val = qq/ value="$value"/ if defined($value);
2048     my($other) = @other ? " @other" : '';
2049     $tabindex = $self->element_tab($tabindex);
2050     return $XHTML ? qq(<input type="reset" $tabindex$name$val$other />)
2051                   : qq(<input type="reset"$name$val$other>);
2052 }
2053 END_OF_FUNC
2054
2055
2056 #### Method: defaults
2057 # Create a "defaults" button.
2058 # Parameters:
2059 #   $name -> (optional) Name for the button.
2060 # Returns:
2061 #   A string containing a <input type="submit" name=".defaults"> tag
2062 #
2063 # Note: this button has a special meaning to the initialization script,
2064 # and tells it to ERASE the current query string so that your defaults
2065 # are used again!
2066 ####
2067 'defaults' => <<'END_OF_FUNC',
2068 sub defaults {
2069     my($self,@p) = self_or_default(@_);
2070
2071     my($label,$tabindex,@other) = rearrange([[NAME,VALUE],TABINDEX],@p);
2072
2073     $label=$self->escapeHTML($label,1);
2074     $label = $label || "Defaults";
2075     my($value) = qq/ value="$label"/;
2076     my($other) = @other ? " @other" : '';
2077     $tabindex = $self->element_tab($tabindex);
2078     return $XHTML ? qq(<input type="submit" name=".defaults" $tabindex$value$other />)
2079                   : qq/<input type="submit" NAME=".defaults"$value$other>/;
2080 }
2081 END_OF_FUNC
2082
2083
2084 #### Method: comment
2085 # Create an HTML <!-- comment -->
2086 # Parameters: a string
2087 'comment' => <<'END_OF_FUNC',
2088 sub comment {
2089     my($self,@p) = self_or_CGI(@_);
2090     return "<!-- @p -->";
2091 }
2092 END_OF_FUNC
2093
2094 #### Method: checkbox
2095 # Create a checkbox that is not logically linked to any others.
2096 # The field value is "on" when the button is checked.
2097 # Parameters:
2098 #   $name -> Name of the checkbox
2099 #   $checked -> (optional) turned on by default if true
2100 #   $value -> (optional) value of the checkbox, 'on' by default
2101 #   $label -> (optional) a user-readable label printed next to the box.
2102 #             Otherwise the checkbox name is used.
2103 # Returns:
2104 #   A string containing a <input type="checkbox"> field
2105 ####
2106 'checkbox' => <<'END_OF_FUNC',
2107 sub checkbox {
2108     my($self,@p) = self_or_default(@_);
2109
2110     my($name,$checked,$value,$label,$override,$tabindex,@other) = 
2111         rearrange([NAME,[CHECKED,SELECTED,ON],VALUE,LABEL,[OVERRIDE,FORCE],TABINDEX],@p);
2112
2113     $value = defined $value ? $value : 'on';
2114
2115     if (!$override && ($self->{'.fieldnames'}->{$name} || 
2116                        defined $self->param($name))) {
2117         $checked = grep($_ eq $value,$self->param($name)) ? $self->_checked(1) : '';
2118     } else {
2119         $checked = $self->_checked($checked);
2120     }
2121     my($the_label) = defined $label ? $label : $name;
2122     $name = $self->escapeHTML($name);
2123     $value = $self->escapeHTML($value,1);
2124     $the_label = $self->escapeHTML($the_label);
2125     my($other) = @other ? "@other " : '';
2126     $tabindex = $self->element_tab($tabindex);
2127     $self->register_parameter($name);
2128     return $XHTML ? CGI::label(qq{<input type="checkbox" name="$name" value="$value" $tabindex$checked$other/>$the_label})
2129                   : qq{<input type="checkbox" name="$name" value="$value"$checked$other>$the_label};
2130 }
2131 END_OF_FUNC
2132
2133
2134
2135 # Escape HTML -- used internally
2136 'escapeHTML' => <<'END_OF_FUNC',
2137 sub escapeHTML {
2138          # hack to work around  earlier hacks
2139          push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
2140          my ($self,$toencode,$newlinestoo) = CGI::self_or_default(@_);
2141          return undef unless defined($toencode);
2142          return $toencode if ref($self) && !$self->{'escape'};
2143          $toencode =~ s{&}{&amp;}gso;
2144          $toencode =~ s{<}{&lt;}gso;
2145          $toencode =~ s{>}{&gt;}gso;
2146          if ($DTD_PUBLIC_IDENTIFIER =~ /[^X]HTML 3\.2/i) {
2147              # $quot; was accidentally omitted from the HTML 3.2 DTD -- see
2148              # <http://validator.w3.org/docs/errors.html#bad-entity> /
2149              # <http://lists.w3.org/Archives/Public/www-html/1997Mar/0003.html>.
2150              $toencode =~ s{"}{&#34;}gso;
2151          }
2152          else {
2153              $toencode =~ s{"}{&quot;}gso;
2154          }
2155          my $latin = uc $self->{'.charset'} eq 'ISO-8859-1' ||
2156                      uc $self->{'.charset'} eq 'WINDOWS-1252';
2157          if ($latin) {  # bug in some browsers
2158                 $toencode =~ s{'}{&#39;}gso;
2159                 $toencode =~ s{\x8b}{&#8249;}gso;
2160                 $toencode =~ s{\x9b}{&#8250;}gso;
2161                 if (defined $newlinestoo && $newlinestoo) {
2162                      $toencode =~ s{\012}{&#10;}gso;
2163                      $toencode =~ s{\015}{&#13;}gso;
2164                 }
2165          }
2166          return $toencode;
2167 }
2168 END_OF_FUNC
2169
2170 # unescape HTML -- used internally
2171 'unescapeHTML' => <<'END_OF_FUNC',
2172 sub unescapeHTML {
2173     # hack to work around  earlier hacks
2174     push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
2175     my ($self,$string) = CGI::self_or_default(@_);
2176     return undef unless defined($string);
2177     my $latin = defined $self->{'.charset'} ? $self->{'.charset'} =~ /^(ISO-8859-1|WINDOWS-1252)$/i
2178                                             : 1;
2179     # thanks to Randal Schwartz for the correct solution to this one
2180     $string=~ s[&(.*?);]{
2181         local $_ = $1;
2182         /^amp$/i        ? "&" :
2183         /^quot$/i       ? '"' :
2184         /^gt$/i         ? ">" :
2185         /^lt$/i         ? "<" :
2186         /^#(\d+)$/ && $latin         ? chr($1) :
2187         /^#x([0-9a-f]+)$/i && $latin ? chr(hex($1)) :
2188         $_
2189         }gex;
2190     return $string;
2191 }
2192 END_OF_FUNC
2193
2194 # Internal procedure - don't use
2195 '_tableize' => <<'END_OF_FUNC',
2196 sub _tableize {
2197     my($rows,$columns,$rowheaders,$colheaders,@elements) = @_;
2198     my @rowheaders = $rowheaders ? @$rowheaders : ();
2199     my @colheaders = $colheaders ? @$colheaders : ();
2200     my($result);
2201
2202     if (defined($columns)) {
2203         $rows = int(0.99 + @elements/$columns) unless defined($rows);
2204     }
2205     if (defined($rows)) {
2206         $columns = int(0.99 + @elements/$rows) unless defined($columns);
2207     }
2208
2209     # rearrange into a pretty table
2210     $result = "<table>";
2211     my($row,$column);
2212     unshift(@colheaders,'') if @colheaders && @rowheaders;
2213     $result .= "<tr>" if @colheaders;
2214     foreach (@colheaders) {
2215         $result .= "<th>$_</th>";
2216     }
2217     for ($row=0;$row<$rows;$row++) {
2218         $result .= "<tr>";
2219         $result .= "<th>$rowheaders[$row]</th>" if @rowheaders;
2220         for ($column=0;$column<$columns;$column++) {
2221             $result .= "<td>" . $elements[$column*$rows + $row] . "</td>"
2222                 if defined($elements[$column*$rows + $row]);
2223         }
2224         $result .= "</tr>";
2225     }
2226     $result .= "</table>";
2227     return $result;
2228 }
2229 END_OF_FUNC
2230
2231
2232 #### Method: radio_group
2233 # Create a list of logically-linked radio buttons.
2234 # Parameters:
2235 #   $name -> Common name for all the buttons.
2236 #   $values -> A pointer to a regular array containing the
2237 #             values for each button in the group.
2238 #   $default -> (optional) Value of the button to turn on by default.  Pass '-'
2239 #               to turn _nothing_ on.
2240 #   $linebreak -> (optional) Set to true to place linebreaks
2241 #             between the buttons.
2242 #   $labels -> (optional)
2243 #             A pointer to an associative array of labels to print next to each checkbox
2244 #             in the form $label{'value'}="Long explanatory label".
2245 #             Otherwise the provided values are used as the labels.
2246 # Returns:
2247 #   An ARRAY containing a series of <input type="radio"> fields
2248 ####
2249 'radio_group' => <<'END_OF_FUNC',
2250 sub radio_group {
2251     my($self,@p) = self_or_default(@_);
2252    $self->_box_group('radio',@p);
2253 }
2254 END_OF_FUNC
2255
2256 #### Method: checkbox_group
2257 # Create a list of logically-linked checkboxes.
2258 # Parameters:
2259 #   $name -> Common name for all the check boxes
2260 #   $values -> A pointer to a regular array containing the
2261 #             values for each checkbox in the group.
2262 #   $defaults -> (optional)
2263 #             1. If a pointer to a regular array of checkbox values,
2264 #             then this will be used to decide which
2265 #             checkboxes to turn on by default.
2266 #             2. If a scalar, will be assumed to hold the
2267 #             value of a single checkbox in the group to turn on. 
2268 #   $linebreak -> (optional) Set to true to place linebreaks
2269 #             between the buttons.
2270 #   $labels -> (optional)
2271 #             A pointer to an associative array of labels to print next to each checkbox
2272 #             in the form $label{'value'}="Long explanatory label".
2273 #             Otherwise the provided values are used as the labels.
2274 # Returns:
2275 #   An ARRAY containing a series of <input type="checkbox"> fields
2276 ####
2277
2278 'checkbox_group' => <<'END_OF_FUNC',
2279 sub checkbox_group {
2280     my($self,@p) = self_or_default(@_);
2281    $self->_box_group('checkbox',@p);
2282 }
2283 END_OF_FUNC
2284
2285 '_box_group' => <<'END_OF_FUNC',
2286 sub _box_group {
2287     my $self     = shift;
2288     my $box_type = shift;
2289
2290     my($name,$values,$defaults,$linebreak,$labels,$attributes,
2291        $rows,$columns,$rowheaders,$colheaders,
2292        $override,$nolabels,$tabindex,@other) =
2293        rearrange([      NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LINEBREAK,LABELS,ATTRIBUTES,
2294                         ROWS,[COLUMNS,COLS],ROWHEADERS,COLHEADERS,
2295                         [OVERRIDE,FORCE],NOLABELS,TABINDEX
2296                  ],@_);
2297     my($result,$checked);
2298
2299
2300     my(@elements,@values);
2301     @values = $self->_set_values_and_labels($values,\$labels,$name);
2302     my %checked = $self->previous_or_default($name,$defaults,$override);
2303
2304     # If no check array is specified, check the first by default
2305     $checked{$values[0]}++ if $box_type eq 'radio' && !%checked;
2306
2307     $name=$self->escapeHTML($name);
2308
2309     my %tabs = ();
2310     if ($TABINDEX && $tabindex) {
2311       if (!ref $tabindex) {
2312           $self->element_tab($tabindex);
2313       } elsif (ref $tabindex eq 'ARRAY') {
2314           %tabs = map {$_=>$self->element_tab} @$tabindex;
2315       } elsif (ref $tabindex eq 'HASH') {
2316           %tabs = %$tabindex;
2317       }
2318     }
2319     %tabs = map {$_=>$self->element_tab} @values unless %tabs;
2320
2321     my $other = @other ? "@other " : '';
2322     my $radio_checked;
2323     foreach (@values) {
2324         my $checkit = $self->_checked($box_type eq 'radio' ? ($checked{$_} && !$radio_checked++)
2325                                                            : $checked{$_});
2326         my($break);
2327         if ($linebreak) {
2328           $break = $XHTML ? "<br />" : "<br>";
2329         }
2330         else {
2331           $break = '';
2332         }
2333         my($label)='';
2334         unless (defined($nolabels) && $nolabels) {
2335             $label = $_;
2336             $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2337             $label = $self->escapeHTML($label,1);
2338         }
2339         my $attribs = $self->_set_attributes($_, $attributes);
2340         my $tab     = $tabs{$_};
2341         $_=$self->escapeHTML($_);
2342         if ($XHTML) {
2343            push @elements,
2344               CGI::label(
2345                    qq(<input type="$box_type" name="$name" value="$_" $checkit$other$tab$attribs/>$label)).${break};
2346         } else {
2347            push(@elements,qq/<input type="$box_type" name="$name" value="$_"$checkit$other$tab$attribs>${label}${break}/);
2348         }
2349     }
2350     $self->register_parameter($name);
2351     return wantarray ? @elements : "@elements"
2352            unless defined($columns) || defined($rows);
2353     return _tableize($rows,$columns,$rowheaders,$colheaders,@elements);
2354 }
2355 END_OF_FUNC
2356
2357
2358 #### Method: popup_menu
2359 # Create a popup menu.
2360 # Parameters:
2361 #   $name -> Name for all the menu
2362 #   $values -> A pointer to a regular array containing the
2363 #             text of each menu item.
2364 #   $default -> (optional) Default item to display
2365 #   $labels -> (optional)
2366 #             A pointer to an associative array of labels to print next to each checkbox
2367 #             in the form $label{'value'}="Long explanatory label".
2368 #             Otherwise the provided values are used as the labels.
2369 # Returns:
2370 #   A string containing the definition of a popup menu.
2371 ####
2372 'popup_menu' => <<'END_OF_FUNC',
2373 sub popup_menu {
2374     my($self,@p) = self_or_default(@_);
2375
2376     my($name,$values,$default,$labels,$attributes,$override,$tabindex,@other) =
2377        rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LABELS,
2378        ATTRIBUTES,[OVERRIDE,FORCE],TABINDEX],@p);
2379     my($result,$selected);
2380
2381     if (!$override && defined($self->param($name))) {
2382         $selected = $self->param($name);
2383     } else {
2384         $selected = $default;
2385     }
2386     $name=$self->escapeHTML($name);
2387     my($other) = @other ? " @other" : '';
2388
2389     my(@values);
2390     @values = $self->_set_values_and_labels($values,\$labels,$name);
2391     $tabindex = $self->element_tab($tabindex);
2392     $result = qq/<select name="$name" $tabindex$other>\n/;
2393     foreach (@values) {
2394         if (/<optgroup/) {
2395             foreach (split(/\n/)) {
2396                 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2397                 s/(value="$selected")/$selectit $1/ if defined $selected;
2398                 $result .= "$_\n";
2399             }
2400         }
2401         else {
2402           my $attribs = $self->_set_attributes($_, $attributes);
2403           my($selectit) = defined($selected) ? $self->_selected($selected eq $_) : '';
2404           my($label) = $_;
2405           $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2406           my($value) = $self->escapeHTML($_);
2407           $label=$self->escapeHTML($label,1);
2408           $result .= "<option${attribs} ${selectit}value=\"$value\">$label</option>\n";
2409         }
2410     }
2411
2412     $result .= "</select>";
2413     return $result;
2414 }
2415 END_OF_FUNC
2416
2417
2418 #### Method: optgroup
2419 # Create a optgroup.
2420 # Parameters:
2421 #   $name -> Label for the group
2422 #   $values -> A pointer to a regular array containing the
2423 #              values for each option line in the group.
2424 #   $labels -> (optional)
2425 #              A pointer to an associative array of labels to print next to each item
2426 #              in the form $label{'value'}="Long explanatory label".
2427 #              Otherwise the provided values are used as the labels.
2428 #   $labeled -> (optional)
2429 #               A true value indicates the value should be used as the label attribute
2430 #               in the option elements.
2431 #               The label attribute specifies the option label presented to the user.
2432 #               This defaults to the content of the <option> element, but the label
2433 #               attribute allows authors to more easily use optgroup without sacrificing
2434 #               compatibility with browsers that do not support option groups.
2435 #   $novals -> (optional)
2436 #              A true value indicates to suppress the val attribute in the option elements
2437 # Returns:
2438 #   A string containing the definition of an option group.
2439 ####
2440 'optgroup' => <<'END_OF_FUNC',
2441 sub optgroup {
2442     my($self,@p) = self_or_default(@_);
2443     my($name,$values,$attributes,$labeled,$noval,$labels,@other)
2444         = rearrange([NAME,[VALUES,VALUE],ATTRIBUTES,LABELED,NOVALS,LABELS],@p);
2445
2446     my($result,@values);
2447     @values = $self->_set_values_and_labels($values,\$labels,$name,$labeled,$novals);
2448     my($other) = @other ? " @other" : '';
2449
2450     $name=$self->escapeHTML($name);
2451     $result = qq/<optgroup label="$name"$other>\n/;
2452     foreach (@values) {
2453         if (/<optgroup/) {
2454             foreach (split(/\n/)) {
2455                 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2456                 s/(value="$selected")/$selectit $1/ if defined $selected;
2457                 $result .= "$_\n";
2458             }
2459         }
2460         else {
2461             my $attribs = $self->_set_attributes($_, $attributes);
2462             my($label) = $_;
2463             $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2464             $label=$self->escapeHTML($label);
2465             my($value)=$self->escapeHTML($_,1);
2466             $result .= $labeled ? $novals ? "<option$attribs label=\"$value\">$label</option>\n"
2467                                           : "<option$attribs label=\"$value\" value=\"$value\">$label</option>\n"
2468                                 : $novals ? "<option$attribs>$label</option>\n"
2469                                           : "<option$attribs value=\"$value\">$label</option>\n";
2470         }
2471     }
2472     $result .= "</optgroup>";
2473     return $result;
2474 }
2475 END_OF_FUNC
2476
2477
2478 #### Method: scrolling_list
2479 # Create a scrolling list.
2480 # Parameters:
2481 #   $name -> name for the list
2482 #   $values -> A pointer to a regular array containing the
2483 #             values for each option line in the list.
2484 #   $defaults -> (optional)
2485 #             1. If a pointer to a regular array of options,
2486 #             then this will be used to decide which
2487 #             lines to turn on by default.
2488 #             2. Otherwise holds the value of the single line to turn on.
2489 #   $size -> (optional) Size of the list.
2490 #   $multiple -> (optional) If set, allow multiple selections.
2491 #   $labels -> (optional)
2492 #             A pointer to an associative array of labels to print next to each checkbox
2493 #             in the form $label{'value'}="Long explanatory label".
2494 #             Otherwise the provided values are used as the labels.
2495 # Returns:
2496 #   A string containing the definition of a scrolling list.
2497 ####
2498 'scrolling_list' => <<'END_OF_FUNC',
2499 sub scrolling_list {
2500     my($self,@p) = self_or_default(@_);
2501     my($name,$values,$defaults,$size,$multiple,$labels,$attributes,$override,$tabindex,@other)
2502         = rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT],
2503           SIZE,MULTIPLE,LABELS,ATTRIBUTES,[OVERRIDE,FORCE],TABINDEX],@p);
2504
2505     my($result,@values);
2506     @values = $self->_set_values_and_labels($values,\$labels,$name);
2507
2508     $size = $size || scalar(@values);
2509
2510     my(%selected) = $self->previous_or_default($name,$defaults,$override);
2511     my($is_multiple) = $multiple ? qq/ multiple="multiple"/ : '';
2512     my($has_size) = $size ? qq/ size="$size"/: '';
2513     my($other) = @other ? " @other" : '';
2514
2515     $name=$self->escapeHTML($name);
2516     $tabindex = $self->element_tab($tabindex);
2517     $result = qq/<select name="$name" $tabindex$has_size$is_multiple$other>\n/;
2518     foreach (@values) {
2519         my($selectit) = $self->_selected($selected{$_});
2520         my($label) = $_;
2521         $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2522         $label=$self->escapeHTML($label);
2523         my($value)=$self->escapeHTML($_,1);
2524         my $attribs = $self->_set_attributes($_, $attributes);
2525         $result .= "<option ${selectit}${attribs}value=\"$value\">$label</option>\n";
2526     }
2527     $result .= "</select>";
2528     $self->register_parameter($name);
2529     return $result;
2530 }
2531 END_OF_FUNC
2532
2533
2534 #### Method: hidden
2535 # Parameters:
2536 #   $name -> Name of the hidden field
2537 #   @default -> (optional) Initial values of field (may be an array)
2538 #      or
2539 #   $default->[initial values of field]
2540 # Returns:
2541 #   A string containing a <input type="hidden" name="name" value="value">
2542 ####
2543 'hidden' => <<'END_OF_FUNC',
2544 sub hidden {
2545     my($self,@p) = self_or_default(@_);
2546
2547     # this is the one place where we departed from our standard
2548     # calling scheme, so we have to special-case (darn)
2549     my(@result,@value);
2550     my($name,$default,$override,@other) = 
2551         rearrange([NAME,[DEFAULT,VALUE,VALUES],[OVERRIDE,FORCE]],@p);
2552
2553     my $do_override = 0;
2554     if ( ref($p[0]) || substr($p[0],0,1) eq '-') {
2555         @value = ref($default) ? @{$default} : $default;
2556         $do_override = $override;
2557     } else {
2558         foreach ($default,$override,@other) {
2559             push(@value,$_) if defined($_);
2560         }
2561     }
2562
2563     # use previous values if override is not set
2564     my @prev = $self->param($name);
2565     @value = @prev if !$do_override && @prev;
2566
2567     $name=$self->escapeHTML($name);
2568     foreach (@value) {
2569         $_ = defined($_) ? $self->escapeHTML($_,1) : '';
2570         push @result,$XHTML ? qq(<input type="hidden" name="$name" value="$_" @other />)
2571                             : qq(<input type="hidden" name="$name" value="$_" @other>);
2572     }
2573     return wantarray ? @result : join('',@result);
2574 }
2575 END_OF_FUNC
2576
2577
2578 #### Method: image_button
2579 # Parameters:
2580 #   $name -> Name of the button
2581 #   $src ->  URL of the image source
2582 #   $align -> Alignment style (TOP, BOTTOM or MIDDLE)
2583 # Returns:
2584 #   A string containing a <input type="image" name="name" src="url" align="alignment">
2585 ####
2586 'image_button' => <<'END_OF_FUNC',
2587 sub image_button {
2588     my($self,@p) = self_or_default(@_);
2589
2590     my($name,$src,$alignment,@other) =
2591         rearrange([NAME,SRC,ALIGN],@p);
2592
2593     my($align) = $alignment ? " align=\U\"$alignment\"" : '';
2594     my($other) = @other ? " @other" : '';
2595     $name=$self->escapeHTML($name);
2596     return $XHTML ? qq(<input type="image" name="$name" src="$src"$align$other />)
2597                   : qq/<input type="image" name="$name" src="$src"$align$other>/;
2598 }
2599 END_OF_FUNC
2600
2601
2602 #### Method: self_url
2603 # Returns a URL containing the current script and all its
2604 # param/value pairs arranged as a query.  You can use this
2605 # to create a link that, when selected, will reinvoke the
2606 # script with all its state information preserved.
2607 ####
2608 'self_url' => <<'END_OF_FUNC',
2609 sub self_url {
2610     my($self,@p) = self_or_default(@_);
2611     return $self->url('-path_info'=>1,'-query'=>1,'-full'=>1,@p);
2612 }
2613 END_OF_FUNC
2614
2615
2616 # This is provided as a synonym to self_url() for people unfortunate
2617 # enough to have incorporated it into their programs already!
2618 'state' => <<'END_OF_FUNC',
2619 sub state {
2620     &self_url;
2621 }
2622 END_OF_FUNC
2623
2624
2625 #### Method: url
2626 # Like self_url, but doesn't return the query string part of
2627 # the URL.
2628 ####
2629 'url' => <<'END_OF_FUNC',
2630 sub url {
2631     my($self,@p) = self_or_default(@_);
2632     my ($relative,$absolute,$full,$path_info,$query,$base,$rewrite) = 
2633         rearrange(['RELATIVE','ABSOLUTE','FULL',['PATH','PATH_INFO'],['QUERY','QUERY_STRING'],'BASE','REWRITE'],@p);
2634     my $url  = '';
2635     $full++      if $base || !($relative || $absolute);
2636     $rewrite++   unless defined $rewrite;
2637
2638     my $path        =  $self->path_info;
2639     my $script_name =  $self->script_name;
2640     my $request_uri =  unescape($self->request_uri) || '';
2641     my $query_str   =  $self->query_string;
2642
2643     my $rewrite_in_use = $request_uri && $request_uri !~ /^$script_name/;
2644     undef $path if $rewrite_in_use && $rewrite;  # path not valid when rewriting active
2645
2646     my $uri         =  $rewrite && $request_uri ? $request_uri : $script_name;
2647     $uri            =~ s/\?.*$//;                                 # remove query string
2648     $uri            =~ s/\Q$path\E$//      if defined $path;          # remove path
2649
2650     if ($full) {
2651         my $protocol = $self->protocol();
2652         $url = "$protocol://";
2653         my $vh = http('x_forwarded_host') || http('host');
2654         if ($vh) {
2655             $url .= $vh;
2656         } else {
2657             $url .= server_name();
2658             my $port = $self->server_port;
2659             $url .= ":" . $port
2660                 unless (lc($protocol) eq 'http'  && $port == 80)
2661                     || (lc($protocol) eq 'https' && $port == 443);
2662         }
2663         return $url if $base;
2664         $url .= $uri;
2665     } elsif ($relative) {
2666         ($url) = $uri =~ m!([^/]+)$!;
2667     } elsif ($absolute) {
2668         $url = $uri;
2669     }
2670
2671     $url .= $path         if $path_info and defined $path;
2672     $url .= "?$query_str" if $query     and $query_str ne '';
2673     $url =~ s/([^a-zA-Z0-9_.%;&?\/\\:+=~-])/sprintf("%%%02X",ord($1))/eg;
2674     return $url;
2675 }
2676
2677 END_OF_FUNC
2678
2679 #### Method: cookie
2680 # Set or read a cookie from the specified name.
2681 # Cookie can then be passed to header().
2682 # Usual rules apply to the stickiness of -value.
2683 #  Parameters:
2684 #   -name -> name for this cookie (optional)
2685 #   -value -> value of this cookie (scalar, array or hash) 
2686 #   -path -> paths for which this cookie is valid (optional)
2687 #   -domain -> internet domain in which this cookie is valid (optional)
2688 #   -secure -> if true, cookie only passed through secure channel (optional)
2689 #   -expires -> expiry date in format Wdy, DD-Mon-YYYY HH:MM:SS GMT (optional)
2690 ####
2691 'cookie' => <<'END_OF_FUNC',
2692 sub cookie {
2693     my($self,@p) = self_or_default(@_);
2694     my($name,$value,$path,$domain,$secure,$expires) =
2695         rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES],@p);
2696
2697     require CGI::Cookie;
2698
2699     # if no value is supplied, then we retrieve the
2700     # value of the cookie, if any.  For efficiency, we cache the parsed
2701     # cookies in our state variables.
2702     unless ( defined($value) ) {
2703         $self->{'.cookies'} = CGI::Cookie->fetch
2704             unless $self->{'.cookies'};
2705
2706         # If no name is supplied, then retrieve the names of all our cookies.
2707         return () unless $self->{'.cookies'};
2708         return keys %{$self->{'.cookies'}} unless $name;
2709         return () unless $self->{'.cookies'}->{$name};
2710         return $self->{'.cookies'}->{$name}->value if defined($name) && $name ne '';
2711     }
2712
2713     # If we get here, we're creating a new cookie
2714     return undef unless defined($name) && $name ne '';  # this is an error
2715
2716     my @param;
2717     push(@param,'-name'=>$name);
2718     push(@param,'-value'=>$value);
2719     push(@param,'-domain'=>$domain) if $domain;
2720     push(@param,'-path'=>$path) if $path;
2721     push(@param,'-expires'=>$expires) if $expires;
2722     push(@param,'-secure'=>$secure) if $secure;
2723
2724     return new CGI::Cookie(@param);
2725 }
2726 END_OF_FUNC
2727
2728 'parse_keywordlist' => <<'END_OF_FUNC',
2729 sub parse_keywordlist {
2730     my($self,$tosplit) = @_;
2731     $tosplit = unescape($tosplit); # unescape the keywords
2732     $tosplit=~tr/+/ /;          # pluses to spaces
2733     my(@keywords) = split(/\s+/,$tosplit);
2734     return @keywords;
2735 }
2736 END_OF_FUNC
2737
2738 'param_fetch' => <<'END_OF_FUNC',
2739 sub param_fetch {
2740     my($self,@p) = self_or_default(@_);
2741     my($name) = rearrange([NAME],@p);
2742     unless (exists($self->{$name})) {
2743         $self->add_parameter($name);
2744         $self->{$name} = [];
2745     }
2746     
2747     return $self->{$name};
2748 }
2749 END_OF_FUNC
2750
2751 ###############################################
2752 # OTHER INFORMATION PROVIDED BY THE ENVIRONMENT
2753 ###############################################
2754
2755 #### Method: path_info
2756 # Return the extra virtual path information provided
2757 # after the URL (if any)
2758 ####
2759 'path_info' => <<'END_OF_FUNC',
2760 sub path_info {
2761     my ($self,$info) = self_or_default(@_);
2762     if (defined($info)) {
2763         $info = "/$info" if $info ne '' &&  substr($info,0,1) ne '/';
2764         $self->{'.path_info'} = $info;
2765     } elsif (! defined($self->{'.path_info'}) ) {
2766         my (undef,$path_info) = $self->_name_and_path_from_env;
2767         $self->{'.path_info'} = $path_info || '';
2768     }
2769     return $self->{'.path_info'};
2770 }
2771 END_OF_FUNC
2772
2773 # WE USE THIS TO COMPENSATE FOR A BUG IN APACHE 2 PRESENT AT LEAST UP THROUGH 2.0.54
2774 '_name_and_path_from_env' => <<'END_OF_FUNC',
2775 sub _name_and_path_from_env {
2776    my $self = shift;
2777    my $raw_script_name = $ENV{SCRIPT_NAME} || '';
2778    my $raw_path_info   = $ENV{PATH_INFO}   || '';
2779    my $uri             = unescape($self->request_uri) || '';
2780
2781    $raw_script_name =~ s/\Q$raw_path_info$\E//;
2782
2783    my @uri_double_slashes  = $uri =~ m^(/{2,}?)^g;
2784    my @path_double_slashes = "$raw_script_name $raw_path_info" =~ m^(/{2,}?)^g;
2785
2786    my $apache_bug      = @uri_double_slashes != @path_double_slashes;
2787    return ($raw_script_name,$raw_path_info) unless $apache_bug;
2788
2789    my $path_info_search = quotemeta($raw_path_info);
2790    $path_info_search    =~ s!/!/+!g;
2791    if ($uri =~ m/^(.+)($path_info_search)/) {
2792        return ($1,$2);
2793    } else {
2794        return ($raw_script_name,$raw_path_info);
2795    }
2796 }
2797 END_OF_FUNC
2798
2799
2800 #### Method: request_method
2801 # Returns 'POST', 'GET', 'PUT' or 'HEAD'
2802 ####
2803 'request_method' => <<'END_OF_FUNC',
2804 sub request_method {
2805     return $ENV{'REQUEST_METHOD'};
2806 }
2807 END_OF_FUNC
2808
2809 #### Method: content_type
2810 # Returns the content_type string
2811 ####
2812 'content_type' => <<'END_OF_FUNC',
2813 sub content_type {
2814     return $ENV{'CONTENT_TYPE'};
2815 }
2816 END_OF_FUNC
2817
2818 #### Method: path_translated
2819 # Return the physical path information provided
2820 # by the URL (if any)
2821 ####
2822 'path_translated' => <<'END_OF_FUNC',
2823 sub path_translated {
2824     return $ENV{'PATH_TRANSLATED'};
2825 }
2826 END_OF_FUNC
2827
2828
2829 #### Method: request_uri
2830 # Return the literal request URI
2831 ####
2832 'request_uri' => <<'END_OF_FUNC',
2833 sub request_uri {
2834     return $ENV{'REQUEST_URI'};
2835 }
2836 END_OF_FUNC
2837
2838
2839 #### Method: query_string
2840 # Synthesize a query string from our current
2841 # parameters
2842 ####
2843 'query_string' => <<'END_OF_FUNC',
2844 sub query_string {
2845     my($self) = self_or_default(@_);
2846     my($param,$value,@pairs);
2847     foreach $param ($self->param) {
2848         my($eparam) = escape($param);
2849         foreach $value ($self->param($param)) {
2850             $value = escape($value);
2851             next unless defined $value;
2852             push(@pairs,"$eparam=$value");
2853         }
2854     }
2855     foreach (keys %{$self->{'.fieldnames'}}) {
2856       push(@pairs,".cgifields=".escape("$_"));
2857     }
2858     return join($USE_PARAM_SEMICOLONS ? ';' : '&',@pairs);
2859 }
2860 END_OF_FUNC
2861
2862
2863 #### Method: accept
2864 # Without parameters, returns an array of the
2865 # MIME types the browser accepts.
2866 # With a single parameter equal to a MIME
2867 # type, will return undef if the browser won't
2868 # accept it, 1 if the browser accepts it but
2869 # doesn't give a preference, or a floating point
2870 # value between 0.0 and 1.0 if the browser
2871 # declares a quantitative score for it.
2872 # This handles MIME type globs correctly.
2873 ####
2874 'Accept' => <<'END_OF_FUNC',
2875 sub Accept {
2876     my($self,$search) = self_or_CGI(@_);
2877     my(%prefs,$type,$pref,$pat);
2878     
2879     my(@accept) = split(',',$self->http('accept'));
2880
2881     foreach (@accept) {
2882         ($pref) = /q=(\d\.\d+|\d+)/;
2883         ($type) = m#(\S+/[^;]+)#;
2884         next unless $type;
2885         $prefs{$type}=$pref || 1;
2886     }
2887
2888     return keys %prefs unless $search;
2889     
2890     # if a search type is provided, we may need to
2891     # perform a pattern matching operation.
2892     # The MIME types use a glob mechanism, which
2893     # is easily translated into a perl pattern match
2894
2895     # First return the preference for directly supported
2896     # types:
2897     return $prefs{$search} if $prefs{$search};
2898
2899     # Didn't get it, so try pattern matching.
2900     foreach (keys %prefs) {
2901         next unless /\*/;       # not a pattern match
2902         ($pat = $_) =~ s/([^\w*])/\\$1/g; # escape meta characters
2903         $pat =~ s/\*/.*/g; # turn it into a pattern
2904         return $prefs{$_} if $search=~/$pat/;
2905     }
2906 }
2907 END_OF_FUNC
2908
2909
2910 #### Method: user_agent
2911 # If called with no parameters, returns the user agent.
2912 # If called with one parameter, does a pattern match (case
2913 # insensitive) on the user agent.
2914 ####
2915 'user_agent' => <<'END_OF_FUNC',
2916 sub user_agent {
2917     my($self,$match)=self_or_CGI(@_);
2918     return $self->http('user_agent') unless $match;
2919     return $self->http('user_agent') =~ /$match/i;
2920 }
2921 END_OF_FUNC
2922
2923
2924 #### Method: raw_cookie
2925 # Returns the magic cookies for the session.
2926 # The cookies are not parsed or altered in any way, i.e.
2927 # cookies are returned exactly as given in the HTTP
2928 # headers.  If a cookie name is given, only that cookie's
2929 # value is returned, otherwise the entire raw cookie
2930 # is returned.
2931 ####
2932 'raw_cookie' => <<'END_OF_FUNC',
2933 sub raw_cookie {
2934     my($self,$key) = self_or_CGI(@_);
2935
2936     require CGI::Cookie;
2937
2938     if (defined($key)) {
2939         $self->{'.raw_cookies'} = CGI::Cookie->raw_fetch
2940             unless $self->{'.raw_cookies'};
2941
2942         return () unless $self->{'.raw_cookies'};
2943         return () unless $self->{'.raw_cookies'}->{$key};
2944         return $self->{'.raw_cookies'}->{$key};
2945     }
2946     return $self->http('cookie') || $ENV{'COOKIE'} || '';
2947 }
2948 END_OF_FUNC
2949
2950 #### Method: virtual_host
2951 # Return the name of the virtual_host, which
2952 # is not always the same as the server
2953 ######
2954 'virtual_host' => <<'END_OF_FUNC',
2955 sub virtual_host {
2956     my $vh = http('x_forwarded_host') || http('host') || server_name();
2957     $vh =~ s/:\d+$//;           # get rid of port number
2958     return $vh;
2959 }
2960 END_OF_FUNC
2961
2962 #### Method: remote_host
2963 # Return the name of the remote host, or its IP
2964 # address if unavailable.  If this variable isn't
2965 # defined, it returns "localhost" for debugging
2966 # purposes.
2967 ####
2968 'remote_host' => <<'END_OF_FUNC',
2969 sub remote_host {
2970     return $ENV{'REMOTE_HOST'} || $ENV{'REMOTE_ADDR'} 
2971     || 'localhost';
2972 }
2973 END_OF_FUNC
2974
2975
2976 #### Method: remote_addr
2977 # Return the IP addr of the remote host.
2978 ####
2979 'remote_addr' => <<'END_OF_FUNC',
2980 sub remote_addr {
2981     return $ENV{'REMOTE_ADDR'} || '127.0.0.1';
2982 }
2983 END_OF_FUNC
2984
2985
2986 #### Method: script_name
2987 # Return the partial URL to this script for
2988 # self-referencing scripts.  Also see
2989 # self_url(), which returns a URL with all state information
2990 # preserved.
2991 ####
2992 'script_name' => <<'END_OF_FUNC',
2993 sub script_name {
2994     my ($self,@p) = self_or_default(@_);
2995     if (@p) {
2996         $self->{'.script_name'} = shift;
2997     } elsif (!exists $self->{'.script_name'}) {
2998         my ($script_name,$path_info) = $self->_name_and_path_from_env();
2999         $self->{'.script_name'} = $script_name;
3000     }
3001     return $self->{'.script_name'};
3002 }
3003 END_OF_FUNC
3004
3005
3006 #### Method: referer
3007 # Return the HTTP_REFERER: useful for generating
3008 # a GO BACK button.
3009 ####
3010 'referer' => <<'END_OF_FUNC',
3011 sub referer {
3012     my($self) = self_or_CGI(@_);
3013     return $self->http('referer');
3014 }
3015 END_OF_FUNC
3016
3017
3018 #### Method: server_name
3019 # Return the name of the server
3020 ####
3021 'server_name' => <<'END_OF_FUNC',
3022 sub server_name {
3023     return $ENV{'SERVER_NAME'} || 'localhost';
3024 }
3025 END_OF_FUNC
3026
3027 #### Method: server_software
3028 # Return the name of the server software
3029 ####
3030 'server_software' => <<'END_OF_FUNC',
3031 sub server_software {
3032     return $ENV{'SERVER_SOFTWARE'} || 'cmdline';
3033 }
3034 END_OF_FUNC
3035
3036 #### Method: virtual_port
3037 # Return the server port, taking virtual hosts into account
3038 ####
3039 'virtual_port' => <<'END_OF_FUNC',
3040 sub virtual_port {
3041     my($self) = self_or_default(@_);
3042     my $vh = $self->http('x_forwarded_host') || $self->http('host');
3043     my $protocol = $self->protocol;
3044     if ($vh) {
3045         return ($vh =~ /:(\d+)$/)[0] || ($protocol eq 'https' ? 443 : 80);
3046     } else {
3047         return $self->server_port();
3048     }
3049 }
3050 END_OF_FUNC
3051
3052 #### Method: server_port
3053 # Return the tcp/ip port the server is running on
3054 ####
3055 'server_port' => <<'END_OF_FUNC',
3056 sub server_port {
3057     return $ENV{'SERVER_PORT'} || 80; # for debugging
3058 }
3059 END_OF_FUNC
3060
3061 #### Method: server_protocol
3062 # Return the protocol (usually HTTP/1.0)
3063 ####
3064 'server_protocol' => <<'END_OF_FUNC',
3065 sub server_protocol {
3066     return $ENV{'SERVER_PROTOCOL'} || 'HTTP/1.0'; # for debugging
3067 }
3068 END_OF_FUNC
3069
3070 #### Method: http
3071 # Return the value of an HTTP variable, or
3072 # the list of variables if none provided
3073 ####
3074 'http' => <<'END_OF_FUNC',
3075 sub http {
3076     my ($self,$parameter) = self_or_CGI(@_);
3077     return $ENV{$parameter} if $parameter=~/^HTTP/;
3078     $parameter =~ tr/-/_/;
3079     return $ENV{"HTTP_\U$parameter\E"} if $parameter;
3080     my(@p);
3081     foreach (keys %ENV) {
3082         push(@p,$_) if /^HTTP/;
3083     }
3084     return @p;
3085 }
3086 END_OF_FUNC
3087
3088 #### Method: https
3089 # Return the value of HTTPS
3090 ####
3091 'https' => <<'END_OF_FUNC',
3092 sub https {
3093     local($^W)=0;
3094     my ($self,$parameter) = self_or_CGI(@_);
3095     return $ENV{HTTPS} unless $parameter;
3096     return $ENV{$parameter} if $parameter=~/^HTTPS/;
3097     $parameter =~ tr/-/_/;
3098     return $ENV{"HTTPS_\U$parameter\E"} if $parameter;
3099     my(@p);
3100     foreach (keys %ENV) {
3101         push(@p,$_) if /^HTTPS/;
3102     }
3103     return @p;
3104 }
3105 END_OF_FUNC
3106
3107 #### Method: protocol
3108 # Return the protocol (http or https currently)
3109 ####
3110 'protocol' => <<'END_OF_FUNC',
3111 sub protocol {
3112     local($^W)=0;
3113     my $self = shift;
3114     return 'https' if uc($self->https()) eq 'ON'; 
3115     return 'https' if $self->server_port == 443;
3116     my $prot = $self->server_protocol;
3117     my($protocol,$version) = split('/',$prot);
3118     return "\L$protocol\E";
3119 }
3120 END_OF_FUNC
3121
3122 #### Method: remote_ident
3123 # Return the identity of the remote user
3124 # (but only if his host is running identd)
3125 ####
3126 'remote_ident' => <<'END_OF_FUNC',
3127 sub remote_ident {
3128     return $ENV{'REMOTE_IDENT'};
3129 }
3130 END_OF_FUNC
3131
3132
3133 #### Method: auth_type
3134 # Return the type of use verification/authorization in use, if any.
3135 ####
3136 'auth_type' => <<'END_OF_FUNC',
3137 sub auth_type {
3138     return $ENV{'AUTH_TYPE'};
3139 }
3140 END_OF_FUNC
3141
3142
3143 #### Method: remote_user
3144 # Return the authorization name used for user
3145 # verification.
3146 ####
3147 'remote_user' => <<'END_OF_FUNC',
3148 sub remote_user {
3149     return $ENV{'REMOTE_USER'};
3150 }
3151 END_OF_FUNC
3152
3153
3154 #### Method: user_name
3155 # Try to return the remote user's name by hook or by
3156 # crook
3157 ####
3158 'user_name' => <<'END_OF_FUNC',
3159 sub user_name {
3160     my ($self) = self_or_CGI(@_);
3161     return $self->http('from') || $ENV{'REMOTE_IDENT'} || $ENV{'REMOTE_USER'};
3162 }
3163 END_OF_FUNC
3164
3165 #### Method: nosticky
3166 # Set or return the NOSTICKY global flag
3167 ####
3168 'nosticky' => <<'END_OF_FUNC',
3169 sub nosticky {
3170     my ($self,$param) = self_or_CGI(@_);
3171     $CGI::NOSTICKY = $param if defined($param);
3172     return $CGI::NOSTICKY;
3173 }
3174 END_OF_FUNC
3175
3176 #### Method: nph
3177 # Set or return the NPH global flag
3178 ####
3179 'nph' => <<'END_OF_FUNC',
3180 sub nph {
3181     my ($self,$param) = self_or_CGI(@_);
3182     $CGI::NPH = $param if defined($param);
3183     return $CGI::NPH;
3184 }
3185 END_OF_FUNC
3186
3187 #### Method: private_tempfiles
3188 # Set or return the private_tempfiles global flag
3189 ####
3190 'private_tempfiles' => <<'END_OF_FUNC',
3191 sub private_tempfiles {
3192     my ($self,$param) = self_or_CGI(@_);
3193     $CGI::PRIVATE_TEMPFILES = $param if defined($param);
3194     return $CGI::PRIVATE_TEMPFILES;
3195 }
3196 END_OF_FUNC
3197 #### Method: close_upload_files
3198 # Set or return the close_upload_files global flag
3199 ####
3200 'close_upload_files' => <<'END_OF_FUNC',
3201 sub close_upload_files {
3202     my ($self,$param) = self_or_CGI(@_);
3203     $CGI::CLOSE_UPLOAD_FILES = $param if defined($param);
3204     return $CGI::CLOSE_UPLOAD_FILES;
3205 }
3206 END_OF_FUNC
3207
3208
3209 #### Method: default_dtd
3210 # Set or return the default_dtd global
3211 ####
3212 'default_dtd' => <<'END_OF_FUNC',
3213 sub default_dtd {
3214     my ($self,$param,$param2) = self_or_CGI(@_);
3215     if (defined $param2 && defined $param) {
3216         $CGI::DEFAULT_DTD = [ $param, $param2 ];
3217     } elsif (defined $param) {
3218         $CGI::DEFAULT_DTD = $param;
3219     }
3220     return $CGI::DEFAULT_DTD;
3221 }
3222 END_OF_FUNC
3223
3224 # -------------- really private subroutines -----------------
3225 'previous_or_default' => <<'END_OF_FUNC',
3226 sub previous_or_default {
3227     my($self,$name,$defaults,$override) = @_;
3228     my(%selected);
3229
3230     if (!$override && ($self->{'.fieldnames'}->{$name} || 
3231                        defined($self->param($name)) ) ) {
3232         grep($selected{$_}++,$self->param($name));
3233     } elsif (defined($defaults) && ref($defaults) && 
3234              (ref($defaults) eq 'ARRAY')) {
3235         grep($selected{$_}++,@{$defaults});
3236     } else {
3237         $selected{$defaults}++ if defined($defaults);
3238     }
3239
3240     return %selected;
3241 }
3242 END_OF_FUNC
3243
3244 'register_parameter' => <<'END_OF_FUNC',
3245 sub register_parameter {
3246     my($self,$param) = @_;
3247     $self->{'.parametersToAdd'}->{$param}++;
3248 }
3249 END_OF_FUNC
3250
3251 'get_fields' => <<'END_OF_FUNC',
3252 sub get_fields {
3253     my($self) = @_;
3254     return $self->CGI::hidden('-name'=>'.cgifields',
3255                               '-values'=>[keys %{$self->{'.parametersToAdd'}}],
3256                               '-override'=>1);
3257 }
3258 END_OF_FUNC
3259
3260 'read_from_cmdline' => <<'END_OF_FUNC',
3261 sub read_from_cmdline {
3262     my($input,@words);
3263     my($query_string);
3264     my($subpath);
3265     if ($DEBUG && @ARGV) {
3266         @words = @ARGV;
3267     } elsif ($DEBUG > 1) {
3268         require "shellwords.pl";
3269         print STDERR "(offline mode: enter name=value pairs on standard input; press ^D or ^Z when done)\n";
3270         chomp(@lines = <STDIN>); # remove newlines
3271         $input = join(" ",@lines);
3272         @words = &shellwords($input);    
3273     }
3274     foreach (@words) {
3275         s/\\=/%3D/g;
3276         s/\\&/%26/g;        
3277     }
3278
3279     if ("@words"=~/=/) {
3280         $query_string = join('&',@words);
3281     } else {
3282         $query_string = join('+',@words);
3283     }
3284     if ($query_string =~ /^(.*?)\?(.*)$/)
3285     {
3286         $query_string = $2;
3287         $subpath = $1;
3288     }
3289     return { 'query_string' => $query_string, 'subpath' => $subpath };
3290 }
3291 END_OF_FUNC
3292
3293 #####
3294 # subroutine: read_multipart
3295 #
3296 # Read multipart data and store it into our parameters.
3297 # An interesting feature is that if any of the parts is a file, we
3298 # create a temporary file and open up a filehandle on it so that the
3299 # caller can read from it if necessary.
3300 #####
3301 'read_multipart' => <<'END_OF_FUNC',
3302 sub read_multipart {
3303     my($self,$boundary,$length) = @_;
3304     my($buffer) = $self->new_MultipartBuffer($boundary,$length);
3305     return unless $buffer;
3306     my(%header,$body);
3307     my $filenumber = 0;
3308     while (!$buffer->eof) {
3309         %header = $buffer->readHeader;
3310
3311         unless (%header) {
3312             $self->cgi_error("400 Bad request (malformed multipart POST)");
3313             return;
3314         }
3315
3316         my($param)= $header{'Content-Disposition'}=~/ name="([^"]*)"/;
3317         $param .= $TAINTED;
3318
3319         # Bug:  Netscape doesn't escape quotation marks in file names!!!
3320         my($filename) = $header{'Content-Disposition'}=~/ filename="([^"]*)"/;
3321         # Test for Opera's multiple upload feature
3322         my($multipart) = ( defined( $header{'Content-Type'} ) &&
3323                 $header{'Content-Type'} =~ /multipart\/mixed/ ) ?
3324                 1 : 0;
3325
3326         # add this parameter to our list
3327         $self->add_parameter($param);
3328
3329         # If no filename specified, then just read the data and assign it
3330         # to our parameter list.
3331         if ( ( !defined($filename) || $filename eq '' ) && !$multipart ) {
3332             my($value) = $buffer->readBody;
3333             $value .= $TAINTED;
3334             push(@{$self->{$param}},$value);
3335             next;
3336         }
3337
3338         my ($tmpfile,$tmp,$filehandle);
3339       UPLOADS: {
3340           # If we get here, then we are dealing with a potentially large
3341           # uploaded form.  Save the data to a temporary file, then open
3342           # the file for reading.
3343
3344           # skip the file if uploads disabled
3345           if ($DISABLE_UPLOADS) {
3346               while (defined($data = $buffer->read)) { }
3347               last UPLOADS;
3348           }
3349
3350           # set the filename to some recognizable value
3351           if ( ( !defined($filename) || $filename eq '' ) && $multipart ) {
3352               $filename = "multipart/mixed";
3353           }
3354
3355           # choose a relatively unpredictable tmpfile sequence number
3356           my $seqno = unpack("%16C*",join('',localtime,grep {defined $_} values %ENV));
3357           for (my $cnt=10;$cnt>0;$cnt--) {
3358             next unless $tmpfile = new CGITempFile($seqno);
3359             $tmp = $tmpfile->as_string;
3360             last if defined($filehandle = Fh->new($filename,$tmp,$PRIVATE_TEMPFILES));
3361             $seqno += int rand(100);
3362           }
3363           die "CGI open of tmpfile: $!\n" unless defined $filehandle;
3364           $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode 
3365                      && defined fileno($filehandle);
3366
3367           # if this is an multipart/mixed attachment, save the header
3368           # together with the body for later parsing with an external
3369           # MIME parser module
3370           if ( $multipart ) {
3371               foreach ( keys %header ) {
3372                   print $filehandle "$_: $header{$_}${CRLF}";
3373               }
3374               print $filehandle "${CRLF}";
3375           }
3376
3377           my ($data);
3378           local($\) = '';
3379           my $totalbytes;
3380           while (defined($data = $buffer->read)) {
3381               if (defined $self->{'.upload_hook'})
3382                {
3383                   $totalbytes += length($data);
3384                    &{$self->{'.upload_hook'}}($filename ,$data, $totalbytes, $self->{'.upload_data'});
3385               }
3386               print $filehandle $data if ($self->{'use_tempfile'});
3387           }
3388
3389           # back up to beginning of file
3390           seek($filehandle,0,0);
3391
3392       ## Close the filehandle if requested this allows a multipart MIME
3393       ## upload to contain many files, and we won't die due to too many
3394       ## open file handles. The user can access the files using the hash
3395       ## below.
3396       close $filehandle if $CLOSE_UPLOAD_FILES;
3397           $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
3398
3399           # Save some information about the uploaded file where we can get
3400           # at it later.
3401           # Use the typeglob as the key, as this is guaranteed to be
3402           # unique for each filehandle.  Don't use the file descriptor as
3403           # this will be re-used for each filehandle if the
3404           # close_upload_files feature is used.
3405           $self->{'.tmpfiles'}->{$$filehandle}= {
3406               hndl => $filehandle,
3407               name => $tmpfile,
3408               info => {%header},
3409           };
3410           push(@{$self->{$param}},$filehandle);
3411       }
3412     }
3413 }
3414 END_OF_FUNC
3415
3416 'upload' =><<'END_OF_FUNC',
3417 sub upload {
3418     my($self,$param_name) = self_or_default(@_);
3419     my @param = grep(ref && fileno($_), $self->param($param_name));
3420     return unless @param;
3421     return wantarray ? @param : $param[0];
3422 }
3423 END_OF_FUNC
3424
3425 'tmpFileName' => <<'END_OF_FUNC',
3426 sub tmpFileName {
3427     my($self,$filename) = self_or_default(@_);
3428     return $self->{'.tmpfiles'}->{$$filename}->{name} ?
3429         $self->{'.tmpfiles'}->{$$filename}->{name}->as_string
3430             : '';
3431 }
3432 END_OF_FUNC
3433
3434 'uploadInfo' => <<'END_OF_FUNC',
3435 sub uploadInfo {
3436     my($self,$filename) = self_or_default(@_);
3437     return $self->{'.tmpfiles'}->{$$filename}->{info};
3438 }
3439 END_OF_FUNC
3440
3441 # internal routine, don't use
3442 '_set_values_and_labels' => <<'END_OF_FUNC',
3443 sub _set_values_and_labels {
3444     my $self = shift;
3445     my ($v,$l,$n) = @_;
3446     $$l = $v if ref($v) eq 'HASH' && !ref($$l);
3447     return $self->param($n) if !defined($v);
3448     return $v if !ref($v);
3449     return ref($v) eq 'HASH' ? keys %$v : @$v;
3450 }
3451 END_OF_FUNC
3452
3453 # internal routine, don't use
3454 '_set_attributes' => <<'END_OF_FUNC',
3455 sub _set_attributes {
3456     my $self = shift;
3457     my($element, $attributes) = @_;
3458     return '' unless defined($attributes->{$element});
3459     $attribs = ' ';
3460     foreach my $attrib (keys %{$attributes->{$element}}) {
3461         (my $clean_attrib = $attrib) =~ s/^-//;
3462         $attribs .= "@{[lc($clean_attrib)]}=\"$attributes->{$element}{$attrib}\" ";
3463     }
3464     $attribs =~ s/ $//;
3465     return $attribs;
3466 }
3467 END_OF_FUNC
3468
3469 '_compile_all' => <<'END_OF_FUNC',
3470 sub _compile_all {
3471     foreach (@_) {
3472         next if defined(&$_);
3473         $AUTOLOAD = "CGI::$_";
3474         _compile();
3475     }
3476 }
3477 END_OF_FUNC
3478
3479 );
3480 END_OF_AUTOLOAD
3481 ;
3482
3483 #########################################################
3484 # Globals and stubs for other packages that we use.
3485 #########################################################
3486
3487 ################### Fh -- lightweight filehandle ###############
3488 package Fh;
3489 use overload 
3490     '""'  => \&asString,
3491     'cmp' => \&compare,
3492     'fallback'=>1;
3493
3494 $FH='fh00000';
3495
3496 *Fh::AUTOLOAD = \&CGI::AUTOLOAD;
3497
3498 sub DESTROY {
3499     my $self = shift;
3500     close $self;
3501 }
3502
3503 $AUTOLOADED_ROUTINES = '';      # prevent -w error
3504 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3505 %SUBS =  (
3506 'asString' => <<'END_OF_FUNC',
3507 sub asString {
3508     my $self = shift;
3509     # get rid of package name
3510     (my $i = $$self) =~ s/^\*(\w+::fh\d{5})+//; 
3511     $i =~ s/%(..)/ chr(hex($1)) /eg;
3512     return $i.$CGI::TAINTED;
3513 # BEGIN DEAD CODE
3514 # This was an extremely clever patch that allowed "use strict refs".
3515 # Unfortunately it relied on another bug that caused leaky file descriptors.
3516 # The underlying bug has been fixed, so this no longer works.  However
3517 # "strict refs" still works for some reason.
3518 #    my $self = shift;
3519 #    return ${*{$self}{SCALAR}};
3520 # END DEAD CODE
3521 }
3522 END_OF_FUNC
3523
3524 'compare' => <<'END_OF_FUNC',
3525 sub compare {
3526     my $self = shift;
3527     my $value = shift;
3528     return "$self" cmp $value;
3529 }
3530 END_OF_FUNC
3531
3532 'new'  => <<'END_OF_FUNC',
3533 sub new {
3534     my($pack,$name,$file,$delete) = @_;
3535     _setup_symbols(@SAVED_SYMBOLS) if @SAVED_SYMBOLS;
3536     require Fcntl unless defined &Fcntl::O_RDWR;
3537     (my $safename = $name) =~ s/([':%])/ sprintf '%%%02X', ord $1 /eg;
3538     my $fv = ++$FH . $safename;
3539     my $ref = \*{"Fh::$fv"};
3540     $file =~ m!^([a-zA-Z0-9_ \'\":/.\$\\-]+)$! || return;
3541     my $safe = $1;
3542     sysopen($ref,$safe,Fcntl::O_RDWR()|Fcntl::O_CREAT()|Fcntl::O_EXCL(),0600) || return;
3543     unlink($safe) if $delete;
3544     CORE::delete $Fh::{$fv};
3545     return bless $ref,$pack;
3546 }
3547 END_OF_FUNC
3548
3549 );
3550 END_OF_AUTOLOAD
3551
3552 ######################## MultipartBuffer ####################
3553 package MultipartBuffer;
3554
3555 use constant DEBUG => 0;
3556
3557 # how many bytes to read at a time.  We use
3558 # a 4K buffer by default.
3559 $INITIAL_FILLUNIT = 1024 * 4;
3560 $TIMEOUT = 240*60;       # 4 hour timeout for big files
3561 $SPIN_LOOP_MAX = 2000;  # bug fix for some Netscape servers
3562 $CRLF=$CGI::CRLF;
3563
3564 #reuse the autoload function
3565 *MultipartBuffer::AUTOLOAD = \&CGI::AUTOLOAD;
3566
3567 # avoid autoloader warnings
3568 sub DESTROY {}
3569
3570 ###############################################################################
3571 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
3572 ###############################################################################
3573 $AUTOLOADED_ROUTINES = '';      # prevent -w error
3574 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3575 %SUBS =  (
3576
3577 'new' => <<'END_OF_FUNC',
3578 sub new {
3579     my($package,$interface,$boundary,$length) = @_;
3580     $FILLUNIT = $INITIAL_FILLUNIT;
3581     $CGI::DefaultClass->binmode($IN); # if $CGI::needs_binmode;  # just do it always
3582
3583     # If the user types garbage into the file upload field,
3584     # then Netscape passes NOTHING to the server (not good).
3585     # We may hang on this read in that case. So we implement
3586     # a read timeout.  If nothing is ready to read
3587     # by then, we return.
3588
3589     # Netscape seems to be a little bit unreliable
3590     # about providing boundary strings.
3591     my $boundary_read = 0;
3592     if ($boundary) {
3593
3594         # Under the MIME spec, the boundary consists of the 
3595         # characters "--" PLUS the Boundary string
3596
3597         # BUG: IE 3.01 on the Macintosh uses just the boundary -- not
3598         # the two extra hyphens.  We do a special case here on the user-agent!!!!
3599         $boundary = "--$boundary" unless CGI::user_agent('MSIE\s+3\.0[12];\s*Mac|DreamPassport');
3600
3601     } else { # otherwise we find it ourselves
3602         my($old);
3603         ($old,$/) = ($/,$CRLF); # read a CRLF-delimited line
3604         $boundary = <STDIN>;      # BUG: This won't work correctly under mod_perl
3605         $length -= length($boundary);
3606         chomp($boundary);               # remove the CRLF
3607         $/ = $old;                      # restore old line separator
3608         $boundary_read++;
3609     }
3610
3611     my $self = {LENGTH=>$length,
3612                 CHUNKED=>!defined $length,
3613                 BOUNDARY=>$boundary,
3614                 INTERFACE=>$interface,
3615                 BUFFER=>'',
3616             };
3617
3618     $FILLUNIT = length($boundary)
3619         if length($boundary) > $FILLUNIT;
3620
3621     my $retval = bless $self,ref $package || $package;
3622
3623     # Read the preamble and the topmost (boundary) line plus the CRLF.
3624     unless ($boundary_read) {
3625       while ($self->read(0)) { }
3626     }
3627     die "Malformed multipart POST: data truncated\n" if $self->eof;
3628
3629     return $retval;
3630 }
3631 END_OF_FUNC
3632
3633 'readHeader' => <<'END_OF_FUNC',
3634 sub readHeader {
3635     my($self) = @_;
3636     my($end);
3637     my($ok) = 0;
3638     my($bad) = 0;
3639
3640     local($CRLF) = "\015\012" if $CGI::OS eq 'VMS' || $CGI::EBCDIC;
3641
3642     do {
3643         $self->fillBuffer($FILLUNIT);
3644         $ok++ if ($end = index($self->{BUFFER},"${CRLF}${CRLF}")) >= 0;
3645         $ok++ if $self->{BUFFER} eq '';
3646         $bad++ if !$ok && $self->{LENGTH} <= 0;
3647         # this was a bad idea
3648         # $FILLUNIT *= 2 if length($self->{BUFFER}) >= $FILLUNIT; 
3649     } until $ok || $bad;
3650     return () if $bad;
3651
3652     #EBCDIC NOTE: translate header into EBCDIC, but watch out for continuation lines!
3653
3654     my($header) = substr($self->{BUFFER},0,$end+2);
3655     substr($self->{BUFFER},0,$end+4) = '';
3656     my %return;
3657
3658     if ($CGI::EBCDIC) {
3659       warn "untranslated header=$header\n" if DEBUG;
3660       $header = CGI::Util::ascii2ebcdic($header);
3661       warn "translated header=$header\n" if DEBUG;
3662     }
3663
3664     # See RFC 2045 Appendix A and RFC 822 sections 3.4.8
3665     #   (Folding Long Header Fields), 3.4.3 (Comments)
3666     #   and 3.4.5 (Quoted-Strings).
3667
3668     my $token = '[-\w!\#$%&\'*+.^_\`|{}~]';
3669     $header=~s/$CRLF\s+/ /og;           # merge continuation lines
3670
3671     while ($header=~/($token+):\s+([^$CRLF]*)/mgox) {
3672         my ($field_name,$field_value) = ($1,$2);
3673         $field_name =~ s/\b(\w)/uc($1)/eg; #canonicalize
3674         $return{$field_name}=$field_value;
3675     }
3676     return %return;
3677 }
3678 END_OF_FUNC
3679
3680 # This reads and returns the body as a single scalar value.
3681 'readBody' => <<'END_OF_FUNC',
3682 sub readBody {
3683     my($self) = @_;
3684     my($data);
3685     my($returnval)='';
3686
3687     #EBCDIC NOTE: want to translate returnval into EBCDIC HERE
3688
3689     while (defined($data = $self->read)) {
3690         $returnval .= $data;
3691     }
3692
3693     if ($CGI::EBCDIC) {
3694       warn "untranslated body=$returnval\n" if DEBUG;
3695       $returnval = CGI::Util::ascii2ebcdic($returnval);
3696       warn "translated body=$returnval\n"   if DEBUG;
3697     }
3698     return $returnval;
3699 }
3700 END_OF_FUNC
3701
3702 # This will read $bytes or until the boundary is hit, whichever happens
3703 # first.  After the boundary is hit, we return undef.  The next read will
3704 # skip over the boundary and begin reading again;
3705 'read' => <<'END_OF_FUNC',
3706 sub read {
3707     my($self,$bytes) = @_;
3708
3709     # default number of bytes to read
3710     $bytes = $bytes || $FILLUNIT;
3711
3712     # Fill up our internal buffer in such a way that the boundary
3713     # is never split between reads.
3714     $self->fillBuffer($bytes);
3715
3716     my $boundary_start = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY})      : $self->{BOUNDARY};
3717     my $boundary_end   = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY}.'--') : $self->{BOUNDARY}.'--';
3718
3719     # Find the boundary in the buffer (it may not be there).
3720     my $start = index($self->{BUFFER},$boundary_start);
3721
3722     warn "boundary=$self->{BOUNDARY} length=$self->{LENGTH} start=$start\n" if DEBUG;
3723
3724     # protect against malformed multipart POST operations
3725     die "Malformed multipart POST\n" unless $self->{CHUNKED} || ($start >= 0 || $self->{LENGTH} > 0);
3726
3727     #EBCDIC NOTE: want to translate boundary search into ASCII here.
3728
3729     # If the boundary begins the data, then skip past it
3730     # and return undef.
3731     if ($start == 0) {
3732
3733         # clear us out completely if we've hit the last boundary.
3734         if (index($self->{BUFFER},$boundary_end)==0) {
3735             $self->{BUFFER}='';
3736             $self->{LENGTH}=0;
3737             return undef;
3738         }
3739
3740         # just remove the boundary.
3741         substr($self->{BUFFER},0,length($boundary_start))='';
3742         $self->{BUFFER} =~ s/^\012\015?//;
3743         return undef;
3744     }
3745
3746     my $bytesToReturn;
3747     if ($start > 0) {           # read up to the boundary
3748         $bytesToReturn = $start-2 > $bytes ? $bytes : $start;
3749     } else {    # read the requested number of bytes
3750         # leave enough bytes in the buffer to allow us to read
3751         # the boundary.  Thanks to Kevin Hendrick for finding
3752         # this one.
3753         $bytesToReturn = $bytes - (length($boundary_start)+1);
3754     }
3755
3756     my $returnval=substr($self->{BUFFER},0,$bytesToReturn);
3757     substr($self->{BUFFER},0,$bytesToReturn)='';
3758     
3759     # If we hit the boundary, remove the CRLF from the end.
3760     return ($bytesToReturn==$start)
3761            ? substr($returnval,0,-2) : $returnval;
3762 }
3763 END_OF_FUNC
3764
3765
3766 # This fills up our internal buffer in such a way that the
3767 # boundary is never split between reads
3768 'fillBuffer' => <<'END_OF_FUNC',
3769 sub fillBuffer {
3770     my($self,$bytes) = @_;
3771     return unless $self->{CHUNKED} || $self->{LENGTH};
3772
3773     my($boundaryLength) = length($self->{BOUNDARY});
3774     my($bufferLength) = length($self->{BUFFER});
3775     my($bytesToRead) = $bytes - $bufferLength + $boundaryLength + 2;
3776     $bytesToRead = $self->{LENGTH} if !$self->{CHUNKED} && $self->{LENGTH} < $bytesToRead;
3777
3778     # Try to read some data.  We may hang here if the browser is screwed up.
3779     my $bytesRead = $self->{INTERFACE}->read_from_client(\$self->{BUFFER},
3780                                                          $bytesToRead,
3781                                                          $bufferLength);
3782     warn "bytesToRead=$bytesToRead, bufferLength=$bufferLength, buffer=$self->{BUFFER}\n" if DEBUG;
3783     $self->{BUFFER} = '' unless defined $self->{BUFFER};
3784
3785     # An apparent bug in the Apache server causes the read()
3786     # to return zero bytes repeatedly without blocking if the
3787     # remote user aborts during a file transfer.  I don't know how
3788     # they manage this, but the workaround is to abort if we get
3789     # more than SPIN_LOOP_MAX consecutive zero reads.
3790     if ($bytesRead <= 0) {
3791         die  "CGI.pm: Server closed socket during multipart read (client aborted?).\n"
3792             if ($self->{ZERO_LOOP_COUNTER}++ >= $SPIN_LOOP_MAX);
3793     } else {
3794         $self->{ZERO_LOOP_COUNTER}=0;
3795     }
3796
3797     $self->{LENGTH} -= $bytesRead if !$self->{CHUNKED} && $bytesRead;
3798 }
3799 END_OF_FUNC
3800
3801
3802 # Return true when we've finished reading
3803 'eof' => <<'END_OF_FUNC'
3804 sub eof {
3805     my($self) = @_;
3806     return 1 if (length($self->{BUFFER}) == 0)
3807                  && ($self->{LENGTH} <= 0);
3808     undef;
3809 }
3810 END_OF_FUNC
3811
3812 );
3813 END_OF_AUTOLOAD
3814
3815 ####################################################################################
3816 ################################## TEMPORARY FILES #################################
3817 ####################################################################################
3818 package CGITempFile;
3819
3820 sub find_tempdir {
3821   $SL = $CGI::SL;
3822   $MAC = $CGI::OS eq 'MACINTOSH';
3823   my ($vol) = $MAC ? MacPerl::Volumes() =~ /:(.*)/ : "";
3824   unless (defined $TMPDIRECTORY) {
3825     @TEMP=("${SL}usr${SL}tmp","${SL}var${SL}tmp",
3826            "C:${SL}temp","${SL}tmp","${SL}temp",
3827            "${vol}${SL}Temporary Items",
3828            "${SL}WWW_ROOT", "${SL}SYS\$SCRATCH",
3829            "C:${SL}system${SL}temp");
3830     unshift(@TEMP,$ENV{'TMPDIR'}) if defined $ENV{'TMPDIR'};
3831
3832     # this feature was supposed to provide per-user tmpfiles, but
3833     # it is problematic.
3834     #    unshift(@TEMP,(getpwuid($<))[7].'/tmp') if $CGI::OS eq 'UNIX';
3835     # Rob: getpwuid() is unfortunately UNIX specific. On brain dead OS'es this
3836     #    : can generate a 'getpwuid() not implemented' exception, even though
3837     #    : it's never called.  Found under DOS/Win with the DJGPP perl port.
3838     #    : Refer to getpwuid() only at run-time if we're fortunate and have  UNIX.
3839     # unshift(@TEMP,(eval {(getpwuid($>))[7]}).'/tmp') if $CGI::OS eq 'UNIX' and $> != 0;
3840
3841     foreach (@TEMP) {
3842       do {$TMPDIRECTORY = $_; last} if -d $_ && -w _;
3843     }
3844   }
3845   $TMPDIRECTORY  = $MAC ? "" : "." unless $TMPDIRECTORY;
3846 }
3847
3848 find_tempdir();
3849
3850 $MAXTRIES = 5000;
3851
3852 # cute feature, but overload implementation broke it
3853 # %OVERLOAD = ('""'=>'as_string');
3854 *CGITempFile::AUTOLOAD = \&CGI::AUTOLOAD;
3855
3856 sub DESTROY {
3857     my($self) = @_;
3858     $$self =~ m!^([a-zA-Z0-9_ \'\":/.\$\\-]+)$! || return;
3859     my $safe = $1;             # untaint operation
3860     unlink $safe;              # get rid of the file
3861 }
3862
3863 ###############################################################################
3864 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
3865 ###############################################################################
3866 $AUTOLOADED_ROUTINES = '';      # prevent -w error
3867 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3868 %SUBS = (
3869
3870 'new' => <<'END_OF_FUNC',
3871 sub new {
3872     my($package,$sequence) = @_;
3873     my $filename;
3874     find_tempdir() unless -w $TMPDIRECTORY;
3875     for (my $i = 0; $i < $MAXTRIES; $i++) {
3876         last if ! -f ($filename = sprintf("${TMPDIRECTORY}${SL}CGItemp%d",$sequence++));
3877     }
3878     # check that it is a more-or-less valid filename
3879     return unless $filename =~ m!^([a-zA-Z0-9_ \'\":/.\$\\-]+)$!;
3880     # this used to untaint, now it doesn't
3881     # $filename = $1;
3882     return bless \$filename;
3883 }
3884 END_OF_FUNC
3885
3886 'as_string' => <<'END_OF_FUNC'
3887 sub as_string {
3888     my($self) = @_;
3889     return $$self;
3890 }
3891 END_OF_FUNC
3892
3893 );
3894 END_OF_AUTOLOAD
3895
3896 package CGI;
3897
3898 # We get a whole bunch of warnings about "possibly uninitialized variables"
3899 # when running with the -w switch.  Touch them all once to get rid of the
3900 # warnings.  This is ugly and I hate it.
3901 if ($^W) {
3902     $CGI::CGI = '';
3903     $CGI::CGI=<<EOF;
3904     $CGI::VERSION;
3905     $MultipartBuffer::SPIN_LOOP_MAX;
3906     $MultipartBuffer::CRLF;
3907     $MultipartBuffer::TIMEOUT;
3908     $MultipartBuffer::INITIAL_FILLUNIT;
3909 EOF
3910     ;
3911 }
3912
3913 1;
3914
3915 __END__
3916
3917 =head1 NAME
3918
3919 CGI - Simple Common Gateway Interface Class
3920
3921 =head1 SYNOPSIS
3922
3923   # CGI script that creates a fill-out form
3924   # and echoes back its values.
3925
3926   use CGI qw/:standard/;
3927   print header,
3928         start_html('A Simple Example'),
3929         h1('A Simple Example'),
3930         start_form,
3931         "What's your name? ",textfield('name'),p,
3932         "What's the combination?", p,
3933         checkbox_group(-name=>'words',
3934                        -values=>['eenie','meenie','minie','moe'],
3935                        -defaults=>['eenie','minie']), p,
3936         "What's your favorite color? ",
3937         popup_menu(-name=>'color',
3938                    -values=>['red','green','blue','chartreuse']),p,
3939         submit,
3940         end_form,
3941         hr;
3942
3943    if (param()) {
3944        my $name      = param('name');
3945        my $keywords  = join ', ',param('words');
3946        my $color     = param('color');
3947        print "Your name is",em(escapeHTML($name)),p,
3948              "The keywords are: ",em(escapeHTML($keywords)),p,
3949              "Your favorite color is ",em(escapeHTML($color)),
3950              hr;
3951    }
3952
3953 =head1 ABSTRACT
3954
3955 This perl library uses perl5 objects to make it easy to create Web
3956 fill-out forms and parse their contents.  This package defines CGI
3957 objects, entities that contain the values of the current query string
3958 and other state variables.  Using a CGI object's methods, you can
3959 examine keywords and parameters passed to your script, and create
3960 forms whose initial values are taken from the current query (thereby
3961 preserving state information).  The module provides shortcut functions
3962 that produce boilerplate HTML, reducing typing and coding errors. It
3963 also provides functionality for some of the more advanced features of
3964 CGI scripting, including support for file uploads, cookies, cascading
3965 style sheets, server push, and frames.
3966
3967 CGI.pm also provides a simple function-oriented programming style for
3968 those who don't need its object-oriented features.
3969
3970 The current version of CGI.pm is available at
3971
3972   http://www.genome.wi.mit.edu/ftp/pub/software/WWW/cgi_docs.html
3973   ftp://ftp-genome.wi.mit.edu/pub/software/WWW/
3974
3975 =head1 DESCRIPTION
3976
3977 =head2 PROGRAMMING STYLE
3978
3979 There are two styles of programming with CGI.pm, an object-oriented
3980 style and a function-oriented style.  In the object-oriented style you
3981 create one or more CGI objects and then use object methods to create
3982 the various elements of the page.  Each CGI object starts out with the
3983 list of named parameters that were passed to your CGI script by the
3984 server.  You can modify the objects, save them to a file or database
3985 and recreate them.  Because each object corresponds to the "state" of
3986 the CGI script, and because each object's parameter list is
3987 independent of the others, this allows you to save the state of the
3988 script and restore it later.
3989
3990 For example, using the object oriented style, here is how you create
3991 a simple "Hello World" HTML page:
3992
3993    #!/usr/local/bin/perl -w
3994    use CGI;                             # load CGI routines
3995    $q = new CGI;                        # create new CGI object
3996    print $q->header,                    # create the HTTP header
3997          $q->start_html('hello world'), # start the HTML
3998          $q->h1('hello world'),         # level 1 header
3999          $q->end_html;                  # end the HTML
4000
4001 In the function-oriented style, there is one default CGI object that
4002 you rarely deal with directly.  Instead you just call functions to
4003 retrieve CGI parameters, create HTML tags, manage cookies, and so
4004 on.  This provides you with a cleaner programming interface, but
4005 limits you to using one CGI object at a time.  The following example
4006 prints the same page, but uses the function-oriented interface.
4007 The main differences are that we now need to import a set of functions
4008 into our name space (usually the "standard" functions), and we don't
4009 need to create the CGI object.
4010
4011    #!/usr/local/bin/perl
4012    use CGI qw/:standard/;           # load standard CGI routines
4013    print header,                    # create the HTTP header
4014          start_html('hello world'), # start the HTML
4015          h1('hello world'),         # level 1 header
4016          end_html;                  # end the HTML
4017
4018 The examples in this document mainly use the object-oriented style.
4019 See HOW TO IMPORT FUNCTIONS for important information on
4020 function-oriented programming in CGI.pm
4021
4022 =head2 CALLING CGI.PM ROUTINES
4023
4024 Most CGI.pm routines accept several arguments, sometimes as many as 20
4025 optional ones!  To simplify this interface, all routines use a named
4026 argument calling style that looks like this:
4027
4028    print $q->header(-type=>'image/gif',-expires=>'+3d');
4029
4030 Each argument name is preceded by a dash.  Neither case nor order
4031 matters in the argument list.  -type, -Type, and -TYPE are all
4032 acceptable.  In fact, only the first argument needs to begin with a
4033 dash.  If a dash is present in the first argument, CGI.pm assumes
4034 dashes for the subsequent ones.
4035
4036 Several routines are commonly called with just one argument.  In the
4037 case of these routines you can provide the single argument without an
4038 argument name.  header() happens to be one of these routines.  In this
4039 case, the single argument is the document type.
4040
4041    print $q->header('text/html');
4042
4043 Other such routines are documented below.
4044
4045 Sometimes named arguments expect a scalar, sometimes a reference to an
4046 array, and sometimes a reference to a hash.  Often, you can pass any
4047 type of argument and the routine will do whatever is most appropriate.
4048 For example, the param() routine is used to set a CGI parameter to a
4049 single or a multi-valued value.  The two cases are shown below:
4050
4051    $q->param(-name=>'veggie',-value=>'tomato');
4052    $q->param(-name=>'veggie',-value=>['tomato','tomahto','potato','potahto']);
4053
4054 A large number of routines in CGI.pm actually aren't specifically
4055 defined in the module, but are generated automatically as needed.
4056 These are the "HTML shortcuts," routines that generate HTML tags for
4057 use in dynamically-generated pages.  HTML tags have both attributes
4058 (the attribute="value" pairs within the tag itself) and contents (the
4059 part between the opening and closing pairs.)  To distinguish between
4060 attributes and contents, CGI.pm uses the convention of passing HTML
4061 attributes as a hash reference as the first argument, and the
4062 contents, if any, as any subsequent arguments.  It works out like
4063 this:
4064
4065    Code                           Generated HTML
4066    ----                           --------------
4067    h1()                           <h1>
4068    h1('some','contents');         <h1>some contents</h1>
4069    h1({-align=>left});            <h1 align="LEFT">
4070    h1({-align=>left},'contents'); <h1 align="LEFT">contents</h1>
4071
4072 HTML tags are described in more detail later.
4073
4074 Many newcomers to CGI.pm are puzzled by the difference between the
4075 calling conventions for the HTML shortcuts, which require curly braces
4076 around the HTML tag attributes, and the calling conventions for other
4077 routines, which manage to generate attributes without the curly
4078 brackets.  Don't be confused.  As a convenience the curly braces are
4079 optional in all but the HTML shortcuts.  If you like, you can use
4080 curly braces when calling any routine that takes named arguments.  For
4081 example:
4082
4083    print $q->header( {-type=>'image/gif',-expires=>'+3d'} );
4084
4085 If you use the B<-w> switch, you will be warned that some CGI.pm argument
4086 names conflict with built-in Perl functions.  The most frequent of
4087 these is the -values argument, used to create multi-valued menus,
4088 radio button clusters and the like.  To get around this warning, you
4089 have several choices:
4090
4091 =over 4
4092
4093 =item 1.
4094
4095 Use another name for the argument, if one is available. 
4096 For example, -value is an alias for -values.
4097
4098 =item 2.
4099
4100 Change the capitalization, e.g. -Values
4101
4102 =item 3.
4103
4104 Put quotes around the argument name, e.g. '-values'
4105
4106 =back
4107
4108 Many routines will do something useful with a named argument that it
4109 doesn't recognize.  For example, you can produce non-standard HTTP
4110 header fields by providing them as named arguments:
4111
4112   print $q->header(-type  =>  'text/html',
4113                    -cost  =>  'Three smackers',
4114                    -annoyance_level => 'high',
4115                    -complaints_to   => 'bit bucket');
4116
4117 This will produce the following nonstandard HTTP header:
4118
4119    HTTP/1.0 200 OK
4120    Cost: Three smackers
4121    Annoyance-level: high
4122    Complaints-to: bit bucket
4123    Content-type: text/html
4124
4125 Notice the way that underscores are translated automatically into
4126 hyphens.  HTML-generating routines perform a different type of
4127 translation. 
4128
4129 This feature allows you to keep up with the rapidly changing HTTP and
4130 HTML "standards".
4131
4132 =head2 CREATING A NEW QUERY OBJECT (OBJECT-ORIENTED STYLE):
4133
4134      $query = new CGI;
4135
4136 This will parse the input (from both POST and GET methods) and store
4137 it into a perl5 object called $query.  
4138
4139 =head2 CREATING A NEW QUERY OBJECT FROM AN INPUT FILE
4140
4141      $query = new CGI(INPUTFILE);
4142
4143 If you provide a file handle to the new() method, it will read
4144 parameters from the file (or STDIN, or whatever).  The file can be in
4145 any of the forms describing below under debugging (i.e. a series of
4146 newline delimited TAG=VALUE pairs will work).  Conveniently, this type
4147 of file is created by the save() method (see below).  Multiple records
4148 can be saved and restored.
4149
4150 Perl purists will be pleased to know that this syntax accepts
4151 references to file handles, or even references to filehandle globs,
4152 which is the "official" way to pass a filehandle:
4153
4154     $query = new CGI(\*STDIN);
4155
4156 You can also initialize the CGI object with a FileHandle or IO::File
4157 object.
4158
4159 If you are using the function-oriented interface and want to
4160 initialize CGI state from a file handle, the way to do this is with
4161 B<restore_parameters()>.  This will (re)initialize the
4162 default CGI object from the indicated file handle.
4163
4164     open (IN,"test.in") || die;
4165     restore_parameters(IN);
4166     close IN;
4167
4168 You can also initialize the query object from an associative array
4169 reference:
4170
4171     $query = new CGI( {'dinosaur'=>'barney',
4172                        'song'=>'I love you',
4173                        'friends'=>[qw/Jessica George Nancy/]}
4174                     );
4175
4176 or from a properly formatted, URL-escaped query string:
4177
4178     $query = new CGI('dinosaur=barney&color=purple');
4179
4180 or from a previously existing CGI object (currently this clones the
4181 parameter list, but none of the other object-specific fields, such as
4182 autoescaping):
4183
4184     $old_query = new CGI;
4185     $new_query = new CGI($old_query);
4186
4187 To create an empty query, initialize it from an empty string or hash:
4188
4189    $empty_query = new CGI("");
4190
4191        -or-
4192
4193    $empty_query = new CGI({});
4194
4195 =head2 FETCHING A LIST OF KEYWORDS FROM THE QUERY:
4196
4197      @keywords = $query->keywords
4198
4199 If the script was invoked as the result of an <ISINDEX> search, the
4200 parsed keywords can be obtained as an array using the keywords() method.
4201
4202 =head2 FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT:
4203
4204      @names = $query->param
4205
4206 If the script was invoked with a parameter list
4207 (e.g. "name1=value1&name2=value2&name3=value3"), the param() method
4208 will return the parameter names as a list.  If the script was invoked
4209 as an <ISINDEX> script and contains a string without ampersands
4210 (e.g. "value1+value2+value3") , there will be a single parameter named
4211 "keywords" containing the "+"-delimited keywords.
4212
4213 NOTE: As of version 1.5, the array of parameter names returned will
4214 be in the same order as they were submitted by the browser.
4215 Usually this order is the same as the order in which the 
4216 parameters are defined in the form (however, this isn't part
4217 of the spec, and so isn't guaranteed).
4218
4219 =head2 FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER:
4220
4221     @values = $query->param('foo');
4222
4223               -or-
4224
4225     $value = $query->param('foo');
4226
4227 Pass the param() method a single argument to fetch the value of the
4228 named parameter. If the parameter is multivalued (e.g. from multiple
4229 selections in a scrolling list), you can ask to receive an array.  Otherwise
4230 the method will return a single value.
4231
4232 If a value is not given in the query string, as in the queries
4233 "name1=&name2=" or "name1&name2", it will be returned as an empty
4234 string.  This feature is new in 2.63.
4235
4236
4237 If the parameter does not exist at all, then param() will return undef
4238 in a scalar context, and the empty list in a list context.
4239
4240
4241 =head2 SETTING THE VALUE(S) OF A NAMED PARAMETER:
4242
4243     $query->param('foo','an','array','of','values');
4244
4245 This sets the value for the named parameter 'foo' to an array of
4246 values.  This is one way to change the value of a field AFTER
4247 the script has been invoked once before.  (Another way is with
4248 the -override parameter accepted by all methods that generate
4249 form elements.)
4250
4251 param() also recognizes a named parameter style of calling described
4252 in more detail later:
4253
4254     $query->param(-name=>'foo',-values=>['an','array','of','values']);
4255
4256                               -or-
4257
4258     $query->param(-name=>'foo',-value=>'the value');
4259
4260 =head2 APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER:
4261
4262    $query->append(-name=>'foo',-values=>['yet','more','values']);
4263
4264 This adds a value or list of values to the named parameter.  The
4265 values are appended to the end of the parameter if it already exists.
4266 Otherwise the parameter is created.  Note that this method only
4267 recognizes the named argument calling syntax.
4268
4269 =head2 IMPORTING ALL PARAMETERS INTO A NAMESPACE:
4270
4271    $query->import_names('R');
4272
4273 This creates a series of variables in the 'R' namespace.  For example,
4274 $R::foo, @R:foo.  For keyword lists, a variable @R::keywords will appear.
4275 If no namespace is given, this method will assume 'Q'.
4276 WARNING:  don't import anything into 'main'; this is a major security
4277 risk!!!!
4278
4279 NOTE 1: Variable names are transformed as necessary into legal Perl
4280 variable names.  All non-legal characters are transformed into
4281 underscores.  If you need to keep the original names, you should use
4282 the param() method instead to access CGI variables by name.
4283
4284 NOTE 2: In older versions, this method was called B<import()>.  As of version 2.20, 
4285 this name has been removed completely to avoid conflict with the built-in
4286 Perl module B<import> operator.
4287
4288 =head2 DELETING A PARAMETER COMPLETELY:
4289
4290     $query->delete('foo','bar','baz');
4291
4292 This completely clears a list of parameters.  It sometimes useful for
4293 resetting parameters that you don't want passed down between script
4294 invocations.
4295
4296 If you are using the function call interface, use "Delete()" instead
4297 to avoid conflicts with Perl's built-in delete operator.
4298
4299 =head2 DELETING ALL PARAMETERS:
4300
4301    $query->delete_all();
4302
4303 This clears the CGI object completely.  It might be useful to ensure
4304 that all the defaults are taken when you create a fill-out form.
4305
4306 Use Delete_all() instead if you are using the function call interface.
4307
4308 =head2 HANDLING NON-URLENCODED ARGUMENTS
4309
4310
4311 If POSTed data is not of type application/x-www-form-urlencoded or
4312 multipart/form-data, then the POSTed data will not be processed, but
4313 instead be returned as-is in a parameter named POSTDATA.  To retrieve
4314 it, use code like this:
4315
4316    my $data = $query->param('POSTDATA');
4317
4318 (If you don't know what the preceding means, don't worry about it.  It
4319 only affects people trying to use CGI for XML processing and other
4320 specialized tasks.)
4321
4322
4323 =head2 DIRECT ACCESS TO THE PARAMETER LIST:
4324
4325    $q->param_fetch('address')->[1] = '1313 Mockingbird Lane';
4326    unshift @{$q->param_fetch(-name=>'address')},'George Munster';
4327
4328 If you need access to the parameter list in a way that isn't covered
4329 by the methods above, you can obtain a direct reference to it by
4330 calling the B<param_fetch()> method with the name of the .  This
4331 will return an array reference to the named parameters, which you then
4332 can manipulate in any way you like.
4333
4334 You can also use a named argument style using the B<-name> argument.
4335
4336 =head2 FETCHING THE PARAMETER LIST AS A HASH:
4337
4338     $params = $q->Vars;
4339     print $params->{'address'};
4340     @foo = split("\0",$params->{'foo'});
4341     %params = $q->Vars;
4342
4343     use CGI ':cgi-lib';
4344     $params = Vars;
4345
4346 Many people want to fetch the entire parameter list as a hash in which
4347 the keys are the names of the CGI parameters, and the values are the
4348 parameters' values.  The Vars() method does this.  Called in a scalar
4349 context, it returns the parameter list as a tied hash reference.
4350 Changing a key changes the value of the parameter in the underlying
4351 CGI parameter list.  Called in a list context, it returns the
4352 parameter list as an ordinary hash.  This allows you to read the
4353 contents of the parameter list, but not to change it.
4354
4355 When using this, the thing you must watch out for are multivalued CGI
4356 parameters.  Because a hash cannot distinguish between scalar and
4357 list context, multivalued parameters will be returned as a packed
4358 string, separated by the "\0" (null) character.  You must split this
4359 packed string in order to get at the individual values.  This is the
4360 convention introduced long ago by Steve Brenner in his cgi-lib.pl
4361 module for Perl version 4.
4362
4363 If you wish to use Vars() as a function, import the I<:cgi-lib> set of
4364 function calls (also see the section on CGI-LIB compatibility).
4365
4366 =head2 SAVING THE STATE OF THE SCRIPT TO A FILE:
4367
4368     $query->save(\*FILEHANDLE)
4369
4370 This will write the current state of the form to the provided
4371 filehandle.  You can read it back in by providing a filehandle
4372 to the new() method.  Note that the filehandle can be a file, a pipe,
4373 or whatever!
4374
4375 The format of the saved file is:
4376
4377         NAME1=VALUE1
4378         NAME1=VALUE1'
4379         NAME2=VALUE2
4380         NAME3=VALUE3
4381         =
4382
4383 Both name and value are URL escaped.  Multi-valued CGI parameters are
4384 represented as repeated names.  A session record is delimited by a
4385 single = symbol.  You can write out multiple records and read them
4386 back in with several calls to B<new>.  You can do this across several
4387 sessions by opening the file in append mode, allowing you to create
4388 primitive guest books, or to keep a history of users' queries.  Here's
4389 a short example of creating multiple session records:
4390
4391    use CGI;
4392
4393    open (OUT,">>test.out") || die;
4394    $records = 5;
4395    foreach (0..$records) {
4396        my $q = new CGI;
4397        $q->param(-name=>'counter',-value=>$_);
4398        $q->save(\*OUT);
4399    }
4400    close OUT;
4401
4402    # reopen for reading
4403    open (IN,"test.out") || die;
4404    while (!eof(IN)) {
4405        my $q = new CGI(\*IN);
4406        print $q->param('counter'),"\n";
4407    }
4408
4409 The file format used for save/restore is identical to that used by the
4410 Whitehead Genome Center's data exchange format "Boulderio", and can be
4411 manipulated and even databased using Boulderio utilities.  See
4412
4413   http://stein.cshl.org/boulder/
4414
4415 for further details.
4416
4417 If you wish to use this method from the function-oriented (non-OO)
4418 interface, the exported name for this method is B<save_parameters()>.
4419
4420 =head2 RETRIEVING CGI ERRORS
4421
4422 Errors can occur while processing user input, particularly when
4423 processing uploaded files.  When these errors occur, CGI will stop
4424 processing and return an empty parameter list.  You can test for
4425 the existence and nature of errors using the I<cgi_error()> function.
4426 The error messages are formatted as HTTP status codes. You can either
4427 incorporate the error text into an HTML page, or use it as the value
4428 of the HTTP status:
4429
4430     my $error = $q->cgi_error;
4431     if ($error) {
4432         print $q->header(-status=>$error),
4433               $q->start_html('Problems'),
4434               $q->h2('Request not processed'),
4435               $q->strong($error);
4436         exit 0;
4437     }
4438
4439 When using the function-oriented interface (see the next section),
4440 errors may only occur the first time you call I<param()>. Be ready
4441 for this!
4442
4443 =head2 USING THE FUNCTION-ORIENTED INTERFACE
4444
4445 To use the function-oriented interface, you must specify which CGI.pm
4446 routines or sets of routines to import into your script's namespace.
4447 There is a small overhead associated with this importation, but it
4448 isn't much.
4449
4450    use CGI <list of methods>;
4451
4452 The listed methods will be imported into the current package; you can
4453 call them directly without creating a CGI object first.  This example
4454 shows how to import the B<param()> and B<header()>
4455 methods, and then use them directly:
4456
4457    use CGI 'param','header';
4458    print header('text/plain');
4459    $zipcode = param('zipcode');
4460
4461 More frequently, you'll import common sets of functions by referring
4462 to the groups by name.  All function sets are preceded with a ":"
4463 character as in ":html3" (for tags defined in the HTML 3 standard).
4464
4465 Here is a list of the function sets you can import:
4466
4467 =over 4
4468
4469 =item B<:cgi>
4470
4471 Import all CGI-handling methods, such as B<param()>, B<path_info()>
4472 and the like.
4473
4474 =item B<:form>
4475
4476 Import all fill-out form generating methods, such as B<textfield()>.
4477
4478 =item B<:html2>
4479
4480 Import all methods that generate HTML 2.0 standard elements.
4481
4482 =item B<:html3>
4483
4484 Import all methods that generate HTML 3.0 elements (such as
4485 <table>, <super> and <sub>).
4486
4487 =item B<:html4>
4488
4489 Import all methods that generate HTML 4 elements (such as
4490 <abbrev>, <acronym> and <thead>).
4491
4492 =item B<:netscape>
4493
4494 Import all methods that generate Netscape-specific HTML extensions.
4495
4496 =item B<:html>
4497
4498 Import all HTML-generating shortcuts (i.e. 'html2' + 'html3' +
4499 'netscape')...
4500
4501 =item B<:standard>
4502
4503 Import "standard" features, 'html2', 'html3', 'html4', 'form' and 'cgi'.
4504
4505 =item B<:all>
4506
4507 Import all the available methods.  For the full list, see the CGI.pm
4508 code, where the variable %EXPORT_TAGS is defined.
4509
4510 =back
4511
4512 If you import a function name that is not part of CGI.pm, the module
4513 will treat it as a new HTML tag and generate the appropriate
4514 subroutine.  You can then use it like any other HTML tag.  This is to
4515 provide for the rapidly-evolving HTML "standard."  For example, say
4516 Microsoft comes out with a new tag called <gradient> (which causes the
4517 user's desktop to be flooded with a rotating gradient fill until his
4518 machine reboots).  You don't need to wait for a new version of CGI.pm
4519 to start using it immediately:
4520
4521    use CGI qw/:standard :html3 gradient/;
4522    print gradient({-start=>'red',-end=>'blue'});
4523
4524 Note that in the interests of execution speed CGI.pm does B<not> use
4525 the standard L<Exporter> syntax for specifying load symbols.  This may
4526 change in the future.
4527
4528 If you import any of the state-maintaining CGI or form-generating
4529 methods, a default CGI object will be created and initialized
4530 automatically the first time you use any of the methods that require
4531 one to be present.  This includes B<param()>, B<textfield()>,
4532 B<submit()> and the like.  (If you need direct access to the CGI
4533 object, you can find it in the global variable B<$CGI::Q>).  By
4534 importing CGI.pm methods, you can create visually elegant scripts:
4535
4536    use CGI qw/:standard/;
4537    print 
4538        header,
4539        start_html('Simple Script'),
4540        h1('Simple Script'),
4541        start_form,
4542        "What's your name? ",textfield('name'),p,
4543        "What's the combination?",
4544        checkbox_group(-name=>'words',
4545                       -values=>['eenie','meenie','minie','moe'],
4546                       -defaults=>['eenie','moe']),p,
4547        "What's your favorite color?",
4548        popup_menu(-name=>'color',
4549                   -values=>['red','green','blue','chartreuse']),p,
4550        submit,
4551        end_form,
4552        hr,"\n";
4553
4554     if (param) {
4555        print 
4556            "Your name is ",em(param('name')),p,
4557            "The keywords are: ",em(join(", ",param('words'))),p,
4558            "Your favorite color is ",em(param('color')),".\n";
4559     }
4560     print end_html;
4561
4562 =head2 PRAGMAS
4563
4564 In addition to the function sets, there are a number of pragmas that
4565 you can import.  Pragmas, which are always preceded by a hyphen,
4566 change the way that CGI.pm functions in various ways.  Pragmas,
4567 function sets, and individual functions can all be imported in the
4568 same use() line.  For example, the following use statement imports the
4569 standard set of functions and enables debugging mode (pragma
4570 -debug):
4571
4572    use CGI qw/:standard -debug/;
4573
4574 The current list of pragmas is as follows:
4575
4576 =over 4
4577
4578 =item -any
4579
4580 When you I<use CGI -any>, then any method that the query object
4581 doesn't recognize will be interpreted as a new HTML tag.  This allows
4582 you to support the next I<ad hoc> Netscape or Microsoft HTML
4583 extension.  This lets you go wild with new and unsupported tags:
4584
4585    use CGI qw(-any);
4586    $q=new CGI;
4587    print $q->gradient({speed=>'fast',start=>'red',end=>'blue'});
4588
4589 Since using <cite>any</cite> causes any mistyped method name
4590 to be interpreted as an HTML tag, use it with care or not at
4591 all.
4592
4593 =item -compile
4594
4595 This causes the indicated autoloaded methods to be compiled up front,
4596 rather than deferred to later.  This is useful for scripts that run
4597 for an extended period of time under FastCGI or mod_perl, and for
4598 those destined to be crunched by Malcom Beattie's Perl compiler.  Use
4599 it in conjunction with the methods or method families you plan to use.
4600
4601    use CGI qw(-compile :standard :html3);
4602
4603 or even
4604
4605    use CGI qw(-compile :all);
4606
4607 Note that using the -compile pragma in this way will always have
4608 the effect of importing the compiled functions into the current
4609 namespace.  If you want to compile without importing use the
4610 compile() method instead:
4611
4612    use CGI();
4613    CGI->compile();
4614
4615 This is particularly useful in a mod_perl environment, in which you
4616 might want to precompile all CGI routines in a startup script, and
4617 then import the functions individually in each mod_perl script.
4618
4619 =item -nosticky
4620
4621 By default the CGI module implements a state-preserving behavior
4622 called "sticky" fields.  The way this works is that if you are
4623 regenerating a form, the methods that generate the form field values
4624 will interrogate param() to see if similarly-named parameters are
4625 present in the query string. If they find a like-named parameter, they
4626 will use it to set their default values.
4627
4628 Sometimes this isn't what you want.  The B<-nosticky> pragma prevents
4629 this behavior.  You can also selectively change the sticky behavior in
4630 each element that you generate.
4631
4632 =item -tabindex
4633
4634 Automatically add tab index attributes to each form field. With this
4635 option turned off, you can still add tab indexes manually by passing a
4636 -tabindex option to each field-generating method.
4637
4638 =item -no_undef_params
4639
4640 This keeps CGI.pm from including undef params in the parameter list.
4641
4642 =item -no_xhtml
4643
4644 By default, CGI.pm versions 2.69 and higher emit XHTML
4645 (http://www.w3.org/TR/xhtml1/).  The -no_xhtml pragma disables this
4646 feature.  Thanks to Michalis Kabrianis <kabrianis@hellug.gr> for this
4647 feature.
4648
4649 If start_html()'s -dtd parameter specifies an HTML 2.0 or 3.2 DTD, 
4650 XHTML will automatically be disabled without needing to use this 
4651 pragma.
4652
4653 =item -nph
4654
4655 This makes CGI.pm produce a header appropriate for an NPH (no
4656 parsed header) script.  You may need to do other things as well
4657 to tell the server that the script is NPH.  See the discussion
4658 of NPH scripts below.
4659
4660 =item -newstyle_urls
4661
4662 Separate the name=value pairs in CGI parameter query strings with
4663 semicolons rather than ampersands.  For example:
4664
4665    ?name=fred;age=24;favorite_color=3
4666
4667 Semicolon-delimited query strings are always accepted, but will not be
4668 emitted by self_url() and query_string() unless the -newstyle_urls
4669 pragma is specified.
4670
4671 This became the default in version 2.64.
4672
4673 =item -oldstyle_urls
4674
4675 Separate the name=value pairs in CGI parameter query strings with
4676 ampersands rather than semicolons.  This is no longer the default.
4677
4678 =item -autoload
4679
4680 This overrides the autoloader so that any function in your program
4681 that is not recognized is referred to CGI.pm for possible evaluation.
4682 This allows you to use all the CGI.pm functions without adding them to
4683 your symbol table, which is of concern for mod_perl users who are
4684 worried about memory consumption.  I<Warning:> when
4685 I<-autoload> is in effect, you cannot use "poetry mode"
4686 (functions without the parenthesis).  Use I<hr()> rather
4687 than I<hr>, or add something like I<use subs qw/hr p header/> 
4688 to the top of your script.
4689
4690 =item -no_debug
4691
4692 This turns off the command-line processing features.  If you want to
4693 run a CGI.pm script from the command line to produce HTML, and you
4694 don't want it to read CGI parameters from the command line or STDIN,
4695 then use this pragma:
4696
4697    use CGI qw(-no_debug :standard);
4698
4699 =item -debug
4700
4701 This turns on full debugging.  In addition to reading CGI arguments
4702 from the command-line processing, CGI.pm will pause and try to read
4703 arguments from STDIN, producing the message "(offline mode: enter
4704 name=value pairs on standard input)" features.
4705
4706 See the section on debugging for more details.
4707
4708 =item -private_tempfiles
4709
4710 CGI.pm can process uploaded file. Ordinarily it spools the uploaded
4711 file to a temporary directory, then deletes the file when done.
4712 However, this opens the risk of eavesdropping as described in the file
4713 upload section.  Another CGI script author could peek at this data
4714 during the upload, even if it is confidential information. On Unix
4715 systems, the -private_tempfiles pragma will cause the temporary file
4716 to be unlinked as soon as it is opened and before any data is written
4717 into it, reducing, but not eliminating the risk of eavesdropping
4718 (there is still a potential race condition).  To make life harder for
4719 the attacker, the program chooses tempfile names by calculating a 32
4720 bit checksum of the incoming HTTP headers.
4721
4722 To ensure that the temporary file cannot be read by other CGI scripts,
4723 use suEXEC or a CGI wrapper program to run your script.  The temporary
4724 file is created with mode 0600 (neither world nor group readable).
4725
4726 The temporary directory is selected using the following algorithm:
4727
4728     1. if the current user (e.g. "nobody") has a directory named
4729     "tmp" in its home directory, use that (Unix systems only).
4730
4731     2. if the environment variable TMPDIR exists, use the location
4732     indicated.
4733
4734     3. Otherwise try the locations /usr/tmp, /var/tmp, C:\temp,
4735     /tmp, /temp, ::Temporary Items, and \WWW_ROOT.
4736
4737 Each of these locations is checked that it is a directory and is
4738 writable.  If not, the algorithm tries the next choice.
4739
4740 =back
4741
4742 =head2 SPECIAL FORMS FOR IMPORTING HTML-TAG FUNCTIONS
4743
4744 Many of the methods generate HTML tags.  As described below, tag
4745 functions automatically generate both the opening and closing tags.
4746 For example:
4747
4748   print h1('Level 1 Header');
4749
4750 produces
4751
4752   <h1>Level 1 Header</h1>
4753
4754 There will be some times when you want to produce the start and end
4755 tags yourself.  In this case, you can use the form start_I<tag_name>
4756 and end_I<tag_name>, as in:
4757
4758   print start_h1,'Level 1 Header',end_h1;
4759
4760 With a few exceptions (described below), start_I<tag_name> and
4761 end_I<tag_name> functions are not generated automatically when you
4762 I<use CGI>.  However, you can specify the tags you want to generate
4763 I<start/end> functions for by putting an asterisk in front of their
4764 name, or, alternatively, requesting either "start_I<tag_name>" or
4765 "end_I<tag_name>" in the import list.
4766
4767 Example:
4768
4769   use CGI qw/:standard *table start_ul/;
4770
4771 In this example, the following functions are generated in addition to
4772 the standard ones:
4773
4774 =over 4
4775
4776 =item 1. start_table() (generates a <table> tag)
4777
4778 =item 2. end_table() (generates a </table> tag)
4779
4780 =item 3. start_ul() (generates a <ul> tag)
4781
4782 =item 4. end_ul() (generates a </ul> tag)
4783
4784 =back
4785
4786 =head1 GENERATING DYNAMIC DOCUMENTS
4787
4788 Most of CGI.pm's functions deal with creating documents on the fly.
4789 Generally you will produce the HTTP header first, followed by the
4790 document itself.  CGI.pm provides functions for generating HTTP
4791 headers of various types as well as for generating HTML.  For creating
4792 GIF images, see the GD.pm module.
4793
4794 Each of these functions produces a fragment of HTML or HTTP which you
4795 can print out directly so that it displays in the browser window,
4796 append to a string, or save to a file for later use.
4797
4798 =head2 CREATING A STANDARD HTTP HEADER:
4799
4800 Normally the first thing you will do in any CGI script is print out an
4801 HTTP header.  This tells the browser what type of document to expect,
4802 and gives other optional information, such as the language, expiration
4803 date, and whether to cache the document.  The header can also be
4804 manipulated for special purposes, such as server push and pay per view
4805 pages.
4806
4807         print header;
4808
4809              -or-
4810
4811         print header('image/gif');
4812
4813              -or-
4814
4815         print header('text/html','204 No response');
4816
4817              -or-
4818
4819         print header(-type=>'image/gif',
4820                              -nph=>1,
4821                              -status=>'402 Payment required',
4822                              -expires=>'+3d',
4823                              -cookie=>$cookie,
4824                              -charset=>'utf-7',
4825                              -attachment=>'foo.gif',
4826                              -Cost=>'$2.00');
4827
4828 header() returns the Content-type: header.  You can provide your own
4829 MIME type if you choose, otherwise it defaults to text/html.  An
4830 optional second parameter specifies the status code and a human-readable
4831 message.  For example, you can specify 204, "No response" to create a
4832 script that tells the browser to do nothing at all.
4833
4834 The last example shows the named argument style for passing arguments
4835 to the CGI methods using named parameters.  Recognized parameters are
4836 B<-type>, B<-status>, B<-expires>, and B<-cookie>.  Any other named
4837 parameters will be stripped of their initial hyphens and turned into
4838 header fields, allowing you to specify any HTTP header you desire.
4839 Internal underscores will be turned into hyphens:
4840
4841     print header(-Content_length=>3002);
4842
4843 Most browsers will not cache the output from CGI scripts.  Every time
4844 the browser reloads the page, the script is invoked anew.  You can
4845 change this behavior with the B<-expires> parameter.  When you specify
4846 an absolute or relative expiration interval with this parameter, some
4847 browsers and proxy servers will cache the script's output until the
4848 indicated expiration date.  The following forms are all valid for the
4849 -expires field:
4850
4851         +30s                              30 seconds from now
4852         +10m                              ten minutes from now
4853         +1h                               one hour from now
4854         -1d                               yesterday (i.e. "ASAP!")
4855         now                               immediately
4856         +3M                               in three months
4857         +10y                              in ten years time
4858         Thursday, 25-Apr-1999 00:40:33 GMT  at the indicated time & date
4859
4860 The B<-cookie> parameter generates a header that tells the browser to provide
4861 a "magic cookie" during all subsequent transactions with your script.
4862 Netscape cookies have a special format that includes interesting attributes
4863 such as expiration time.  Use the cookie() method to create and retrieve
4864 session cookies.
4865
4866 The B<-nph> parameter, if set to a true value, will issue the correct
4867 headers to work with a NPH (no-parse-header) script.  This is important
4868 to use with certain servers that expect all their scripts to be NPH.
4869
4870 The B<-charset> parameter can be used to control the character set
4871 sent to the browser.  If not provided, defaults to ISO-8859-1.  As a
4872 side effect, this sets the charset() method as well.
4873
4874 The B<-attachment> parameter can be used to turn the page into an
4875 attachment.  Instead of displaying the page, some browsers will prompt
4876 the user to save it to disk.  The value of the argument is the
4877 suggested name for the saved file.  In order for this to work, you may
4878 have to set the B<-type> to "application/octet-stream".
4879
4880 The B<-p3p> parameter will add a P3P tag to the outgoing header.  The
4881 parameter can be an arrayref or a space-delimited string of P3P tags.
4882 For example:
4883
4884    print header(-p3p=>[qw(CAO DSP LAW CURa)]);
4885    print header(-p3p=>'CAO DSP LAW CURa');
4886
4887 In either case, the outgoing header will be formatted as:
4888
4889   P3P: policyref="/w3c/p3p.xml" cp="CAO DSP LAW CURa"
4890
4891 =head2 GENERATING A REDIRECTION HEADER
4892
4893    print redirect('http://somewhere.else/in/movie/land');
4894
4895 Sometimes you don't want to produce a document yourself, but simply
4896 redirect the browser elsewhere, perhaps choosing a URL based on the
4897 time of day or the identity of the user.  
4898
4899 The redirect() function redirects the browser to a different URL.  If
4900 you use redirection like this, you should B<not> print out a header as
4901 well.
4902
4903 You should always use full URLs (including the http: or ftp: part) in
4904 redirection requests.  Relative URLs will not work correctly.
4905
4906 You can also use named arguments:
4907
4908     print redirect(-uri=>'http://somewhere.else/in/movie/land',
4909                            -nph=>1,
4910                            -status=>301);
4911
4912 The B<-nph> parameter, if set to a true value, will issue the correct
4913 headers to work with a NPH (no-parse-header) script.  This is important
4914 to use with certain servers, such as Microsoft IIS, which
4915 expect all their scripts to be NPH.
4916
4917 The B<-status> parameter will set the status of the redirect.  HTTP
4918 defines three different possible redirection status codes:
4919
4920      301 Moved Permanently
4921      302 Found
4922      303 See Other
4923
4924 The default if not specified is 302, which means "moved temporarily."
4925 You may change the status to another status code if you wish.  Be
4926 advised that changing the status to anything other than 301, 302 or
4927 303 will probably break redirection.
4928
4929 =head2 CREATING&