4 # See the bottom of this file for the POD documentation. Search for the
7 # You can run this file through either pod2man or pod2html to produce pretty
8 # documentation in manual or html file format (these utilities are part of the
9 # Perl 5 distribution).
11 # Copyright 1995-1998 Lincoln D. Stein. All rights reserved.
12 # It may be used and modified freely, but I do request that this copyright
13 # notice remain attached to the file. You may modify this module as you
14 # wish, but if you redistribute a modified version, please attach a note
15 # listing the modifications you have made.
17 # The most recent version and complete docs are available at:
18 # http://stein.cshl.org/WWW/software/CGI/
20 $CGI::revision = '$Id: CGI.pm,v 1.42 2000/08/13 16:04:43 lstein Exp $';
23 # HARD-CODED LOCATION FOR FILE UPLOAD TEMPORARY FILES.
24 # UNCOMMENT THIS ONLY IF YOU KNOW WHAT YOU'RE DOING.
25 # $TempFile::TMPDIRECTORY = '/usr/tmp';
26 use CGI::Util qw(rearrange make_attributes unescape escape expires);
28 use constant XHTML_DTD => ['-//W3C//DTD XHTML 1.0 Transitional//EN',
29 'DTD/xhtml1-transitional.dtd'];
31 # >>>>> Here are some globals that you might want to adjust <<<<<<
32 sub initialize_globals {
33 # Set this to 1 to enable copious autoloader debugging messages
36 # Set this to 1 to generate XTML-compatible output
39 # Change this to the preferred DTD to print in start_html()
40 # or use default_dtd('text of DTD to use');
41 $DEFAULT_DTD = [ '-//W3C//DTD HTML 4.01 Transitional//EN',
42 'http://www.w3.org/TR/html4/loose.dtd' ] ;
44 # Set this to 1 to enable NOSTICKY scripts
46 # 1) use CGI qw(-nosticky)
47 # 2) $CGI::nosticky(1)
50 # Set this to 1 to enable NPH scripts
54 # 3) print header(-nph=>1)
57 # Set this to 1 to enable debugging from @ARGV
58 # Set to 2 to enable debugging from STDIN
61 # Set this to 1 to make the temporary files created
62 # during file uploads safe from prying eyes
64 # 1) use CGI qw(:private_tempfiles)
65 # 2) CGI::private_tempfiles(1);
66 $PRIVATE_TEMPFILES = 0;
68 # Set this to a positive value to limit the size of a POSTing
69 # to a certain number of bytes:
72 # Change this to 1 to disable uploads entirely:
75 # Automatically determined -- don't change
78 # Change this to 1 to suppress redundant HTTP headers
81 # separate the name=value pairs by semicolons rather than ampersands
82 $USE_PARAM_SEMICOLONS = 1;
84 # Other globals that you shouldn't worry about.
90 # prevent complaints by mod_perl
94 # ------------------ START OF THE LIBRARY ------------
99 # FIGURE OUT THE OS WE'RE RUNNING UNDER
100 # Some systems support the $^O variable. If not
101 # available then require() the Config library
105 $OS = $Config::Config{'osname'};
110 } elsif ($OS=~/vms/i) {
112 } elsif ($OS=~/bsdos/i) {
114 } elsif ($OS=~/dos/i) {
116 } elsif ($OS=~/^MacOS$/i) {
118 } elsif ($OS=~/os2/i) {
124 # Some OS logic. Binary mode enabled on DOS, NT and VMS
125 $needs_binmode = $OS=~/^(WINDOWS|DOS|OS2|MSWin)/;
127 # This is the default class for the CGI object to use when all else fails.
128 $DefaultClass = 'CGI' unless defined $CGI::DefaultClass;
130 # This is where to look for autoloaded routines.
131 $AutoloadClass = $DefaultClass unless defined $CGI::AutoloadClass;
133 # The path separator is a slash, backslash or semicolon, depending
136 UNIX=>'/', OS2=>'\\', WINDOWS=>'\\', DOS=>'\\', MACINTOSH=>':', VMS=>'/'
139 # This no longer seems to be necessary
140 # Turn on NPH scripts by default when running under IIS server!
141 # $NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
142 $IIS++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
144 # Turn on special checking for Doug MacEachern's modperl
145 if (exists $ENV{'GATEWAY_INTERFACE'}
147 ($MOD_PERL = $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-Perl\//))
152 # Turn on special checking for ActiveState's PerlEx
153 $PERLEX++ if defined($ENV{'GATEWAY_INTERFACE'}) && $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-PerlEx/;
155 # Define the CRLF sequence. I can't use a simple "\r\n" because the meaning
156 # of "\n" is different on different OS's (sometimes it generates CRLF, sometimes LF
157 # and sometimes CR). The most popular VMS web server
158 # doesn't accept CRLF -- instead it wants a LR. EBCDIC machines don't
159 # use ASCII, so \015\012 means something different. I find this all
161 $EBCDIC = "\t" ne "\011";
170 if ($needs_binmode) {
171 $CGI::DefaultClass->binmode(main::STDOUT);
172 $CGI::DefaultClass->binmode(main::STDIN);
173 $CGI::DefaultClass->binmode(main::STDERR);
177 ':html2'=>['h1'..'h6',qw/p br hr ol ul li dl dt dd menu code var strong em
178 tt u i b blockquote pre img a address cite samp dfn html head
179 base body Link nextid title meta kbd start_html end_html
180 input Select option comment charset escapeHTML/],
181 ':html3'=>[qw/div table caption th td TR Tr sup Sub strike applet Param
182 embed basefont style span layer ilayer font frameset frame script small big/],
183 ':netscape'=>[qw/blink fontsize center/],
184 ':form'=>[qw/textfield textarea filefield password_field hidden checkbox checkbox_group
185 submit reset defaults radio_group popup_menu button autoEscape
186 scrolling_list image_button start_form end_form startform endform
187 start_multipart_form end_multipart_form isindex tmpFileName uploadInfo URL_ENCODED MULTIPART/],
188 ':cgi'=>[qw/param upload path_info path_translated url self_url script_name cookie Dump
189 raw_cookie request_method query_string Accept user_agent remote_host content_type
190 remote_addr referer server_name server_software server_port server_protocol
191 virtual_host remote_ident auth_type http
192 save_parameters restore_parameters param_fetch
193 remote_user user_name header redirect import_names put
194 Delete Delete_all url_param cgi_error/],
195 ':ssl' => [qw/https/],
196 ':imagemap' => [qw/Area Map/],
197 ':cgi-lib' => [qw/ReadParse PrintHeader HtmlTop HtmlBot SplitParam Vars/],
198 ':html' => [qw/:html2 :html3 :netscape/],
199 ':standard' => [qw/:html2 :html3 :form :cgi/],
200 ':push' => [qw/multipart_init multipart_start multipart_end/],
201 ':all' => [qw/:html2 :html3 :netscape :form :cgi :internal/]
204 # to import symbols into caller
208 # This causes modules to clash.
212 $self->_setup_symbols(@_);
213 my ($callpack, $callfile, $callline) = caller;
215 # To allow overriding, search through the packages
216 # Till we find one in which the correct subroutine is defined.
217 my @packages = ($self,@{"$self\:\:ISA"});
218 foreach $sym (keys %EXPORT) {
220 my $def = ${"$self\:\:AutoloadClass"} || $DefaultClass;
221 foreach $pck (@packages) {
222 if (defined(&{"$pck\:\:$sym"})) {
227 *{"${callpack}::$sym"} = \&{"$def\:\:$sym"};
233 $pack->_setup_symbols('-compile',@_);
238 return ("start_$1","end_$1") if $tag=~/^(?:\*|start_|end_)(.+)/;
240 return ($tag) unless $EXPORT_TAGS{$tag};
241 foreach (@{$EXPORT_TAGS{$tag}}) {
242 push(@r,&expand_tags($_));
248 # The new routine. This will check the current environment
249 # for an existing query string, and initialize itself, if so.
252 my($class,$initializer) = @_;
254 bless $self,ref $class || $class || $DefaultClass;
255 if ($MOD_PERL && defined Apache->request) {
256 Apache->request->register_cleanup(\&CGI::_reset_globals);
259 $self->_reset_globals if $PERLEX;
260 $self->init($initializer);
264 # We provide a DESTROY method so that the autoloader
265 # doesn't bother trying to find it.
269 # Returns the value(s)of a named parameter.
270 # If invoked in a list context, returns the
271 # entire list. Otherwise returns the first
272 # member of the list.
273 # If name is not provided, return a list of all
274 # the known parameters names available.
275 # If more than one argument is provided, the
276 # second and subsequent arguments are used to
277 # set the value of the parameter.
280 my($self,@p) = self_or_default(@_);
281 return $self->all_parameters unless @p;
282 my($name,$value,@other);
284 # For compatibility between old calling style and use_named_parameters() style,
285 # we have to special case for a single parameter present.
287 ($name,$value,@other) = rearrange([NAME,[DEFAULT,VALUE,VALUES]],@p);
290 if (substr($p[0],0,1) eq '-') {
291 @values = defined($value) ? (ref($value) && ref($value) eq 'ARRAY' ? @{$value} : $value) : ();
293 foreach ($value,@other) {
294 push(@values,$_) if defined($_);
297 # If values is provided, then we set it.
299 $self->add_parameter($name);
300 $self->{$name}=[@values];
306 return unless defined($name) && $self->{$name};
307 return wantarray ? @{$self->{$name}} : $self->{$name}->[0];
310 sub self_or_default {
311 return @_ if defined($_[0]) && (!ref($_[0])) &&($_[0] eq 'CGI');
312 unless (defined($_[0]) &&
313 (ref($_[0]) eq 'CGI' || UNIVERSAL::isa($_[0],'CGI')) # slightly optimized for common case
315 $Q = $CGI::DefaultClass->new unless defined($Q);
318 return wantarray ? @_ : $Q;
322 local $^W=0; # prevent a warning
323 if (defined($_[0]) &&
324 (substr(ref($_[0]),0,3) eq 'CGI'
325 || UNIVERSAL::isa($_[0],'CGI'))) {
328 return ($DefaultClass,@_);
332 ########################################
333 # THESE METHODS ARE MORE OR LESS PRIVATE
334 # GO TO THE __DATA__ SECTION TO SEE MORE
336 ########################################
338 # Initialize the query object from the environment.
339 # If a parameter list is found, this object will be set
340 # to an associative array in which parameter names are keys
341 # and the values are stored as lists
342 # If a keyword list is found, this method creates a bogus
343 # parameter list with the single parameter 'keywords'.
346 my($self,$initializer) = @_;
347 my($query_string,$meth,$content_length,$fh,@lines) = ('','','','');
350 # if we get called more than once, we want to initialize
351 # ourselves from the original query (which may be gone
352 # if it was read from STDIN originally.)
353 if (@QUERY_PARAM && !defined($initializer)) {
354 foreach (@QUERY_PARAM) {
355 $self->param('-name'=>$_,'-value'=>$QUERY_PARAM{$_});
360 $meth=$ENV{'REQUEST_METHOD'} if defined($ENV{'REQUEST_METHOD'});
361 $content_length = defined($ENV{'CONTENT_LENGTH'}) ? $ENV{'CONTENT_LENGTH'} : 0;
363 $fh = to_filehandle($initializer) if $initializer;
365 # set charset to the safe ISO-8859-1
366 $self->charset('ISO-8859-1');
370 # avoid unreasonably large postings
371 if (($POST_MAX > 0) && ($content_length > $POST_MAX)) {
372 $self->cgi_error("413 Request entity too large");
376 # Process multipart postings, but only if the initializer is
379 && defined($ENV{'CONTENT_TYPE'})
380 && $ENV{'CONTENT_TYPE'}=~m|^multipart/form-data|
381 && !defined($initializer)
383 my($boundary) = $ENV{'CONTENT_TYPE'} =~ /boundary=\"?([^\";,]+)\"?/;
384 $self->read_multipart($boundary,$content_length);
388 # If initializer is defined, then read parameters
390 if (defined($initializer)) {
391 if (UNIVERSAL::isa($initializer,'CGI')) {
392 $query_string = $initializer->query_string;
395 if (ref($initializer) && ref($initializer) eq 'HASH') {
396 foreach (keys %$initializer) {
397 $self->param('-name'=>$_,'-value'=>$initializer->{$_});
402 if (defined($fh) && ($fh ne '')) {
408 # massage back into standard format
409 if ("@lines" =~ /=/) {
410 $query_string=join("&",@lines);
412 $query_string=join("+",@lines);
417 # last chance -- treat it as a string
418 $initializer = $$initializer if ref($initializer) eq 'SCALAR';
419 $query_string = $initializer;
424 # If method is GET or HEAD, fetch the query from
426 if ($meth=~/^(GET|HEAD)$/) {
428 $query_string = Apache->request->args;
430 $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
431 $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'};
436 if ($meth eq 'POST') {
437 $self->read_from_client(\*STDIN,\$query_string,$content_length,0)
438 if $content_length > 0;
439 # Some people want to have their cake and eat it too!
440 # Uncomment this line to have the contents of the query string
441 # APPENDED to the POST data.
442 # $query_string .= (length($query_string) ? '&' : '') . $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
446 # If $meth is not of GET, POST or HEAD, assume we're being debugged offline.
447 # Check the command line and then the standard input for data.
448 # We use the shellwords package in order to behave the way that
449 # UN*X programmers expect.
450 $query_string = read_from_cmdline() if $DEBUG;
453 # We now have the query string in hand. We do slightly
454 # different things for keyword lists and parameter lists.
455 if (defined $query_string && $query_string) {
456 if ($query_string =~ /[&=;]/) {
457 $self->parse_params($query_string);
459 $self->add_parameter('keywords');
460 $self->{'keywords'} = [$self->parse_keywordlist($query_string)];
464 # Special case. Erase everything if there is a field named
466 if ($self->param('.defaults')) {
470 # Associative array containing our defined fieldnames
471 $self->{'.fieldnames'} = {};
472 foreach ($self->param('.cgifields')) {
473 $self->{'.fieldnames'}->{$_}++;
476 # Clear out our default submission button flag if present
477 $self->delete('.submit');
478 $self->delete('.cgifields');
480 $self->save_request unless $initializer;
483 # FUNCTIONS TO OVERRIDE:
484 # Turn a string into a filehandle
487 return undef unless $thingy;
488 return $thingy if UNIVERSAL::isa($thingy,'GLOB');
489 return $thingy if UNIVERSAL::isa($thingy,'FileHandle');
492 while (my $package = caller($caller++)) {
493 my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy";
494 return $tmp if defined(fileno($tmp));
500 # send output to the browser
502 my($self,@p) = self_or_default(@_);
506 # print to standard output (for overriding in mod_perl)
512 # get/set last cgi_error
514 my ($self,$err) = self_or_default(@_);
515 $self->{'.cgi_error'} = $err if defined $err;
516 return $self->{'.cgi_error'};
521 # We're going to play with the package globals now so that if we get called
522 # again, we initialize ourselves in exactly the same way. This allows
523 # us to have several of these objects.
524 @QUERY_PARAM = $self->param; # save list of parameters
525 foreach (@QUERY_PARAM) {
526 next unless defined $_;
527 $QUERY_PARAM{$_}=$self->{$_};
532 my($self,$tosplit) = @_;
533 my(@pairs) = split(/[&;]/,$tosplit);
536 ($param,$value) = split('=',$_,2);
537 $value = '' unless defined $value;
538 $param = unescape($param);
539 $value = unescape($value);
540 $self->add_parameter($param);
541 push (@{$self->{$param}},$value);
547 return unless defined $param;
548 push (@{$self->{'.parameters'}},$param)
549 unless defined($self->{$param});
554 return () unless defined($self) && $self->{'.parameters'};
555 return () unless @{$self->{'.parameters'}};
556 return @{$self->{'.parameters'}};
559 # put a filehandle into binary mode (DOS)
561 CORE::binmode($_[1]);
565 my ($self,$tagname) = @_;
570 (substr(ref(\$_[0]),0,3) eq 'CGI' ||
571 UNIVERSAL::isa(\$_[0],'CGI')));
573 if (ref(\$_[0]) && ref(\$_[0]) eq 'HASH') {
574 my(\@attr) = make_attributes(shift()||undef,1);
575 \$attr = " \@attr" if \@attr;
578 if ($tagname=~/start_(\w+)/i) {
579 $func .= qq! return "<\L$1\E\$attr>";} !;
580 } elsif ($tagname=~/end_(\w+)/i) {
581 $func .= qq! return "<\L/$1\E>"; } !;
584 return \$XHTML ? "\L<$tagname\E\$attr />" : "\L<$tagname\E\$attr>" unless \@_;
585 my(\$tag,\$untag) = ("\L<$tagname\E\$attr>","\L</$tagname>\E");
586 my \@result = map { "\$tag\$_\$untag" }
587 (ref(\$_[0]) eq 'ARRAY') ? \@{\$_[0]} : "\@_";
595 print STDERR "CGI::AUTOLOAD for $AUTOLOAD\n" if $CGI::AUTOLOAD_DEBUG;
596 my $func = &_compile;
601 my($func) = $AUTOLOAD;
602 my($pack,$func_name);
604 local($1,$2); # this fixes an obscure variable suicide problem.
605 $func=~/(.+)::([^:]+)$/;
606 ($pack,$func_name) = ($1,$2);
607 $pack=~s/::SUPER$//; # fix another obscure problem
608 $pack = ${"$pack\:\:AutoloadClass"} || $CGI::DefaultClass
609 unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"});
611 my($sub) = \%{"$pack\:\:SUBS"};
613 my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"};
614 eval "package $pack; $$auto";
616 $$auto = ''; # Free the unneeded storage (but don't undef it!!!)
618 my($code) = $sub->{$func_name};
620 $code = "sub $AUTOLOAD { }" if (!$code and $func_name eq 'DESTROY');
622 (my $base = $func_name) =~ s/^(start_|end_)//i;
623 if ($EXPORT{':any'} ||
626 (%EXPORT_OK || grep(++$EXPORT_OK{$_},&expand_tags(':html')))
627 && $EXPORT_OK{$base}) {
628 $code = $CGI::DefaultClass->_make_tag_func($func_name);
631 die "Undefined subroutine $AUTOLOAD\n" unless $code;
632 eval "package $pack; $code";
638 CORE::delete($sub->{$func_name}); #free storage
639 return "$pack\:\:$func_name";
642 sub _reset_globals { initialize_globals(); }
648 $HEADERS_ONCE++, next if /^[:-]unique_headers$/;
649 $NPH++, next if /^[:-]nph$/;
650 $NOSTICKY++, next if /^[:-]nosticky$/;
651 $DEBUG=0, next if /^[:-]no_?[Dd]ebug$/;
652 $DEBUG=2, next if /^[:-][Dd]ebug$/;
653 $USE_PARAM_SEMICOLONS++, next if /^[:-]newstyle_urls$/;
654 $XHTML++, next if /^[:-]xhtml$/;
655 $XHTML=0, next if /^[:-]no_?xhtml$/;
656 $USE_PARAM_SEMICOLONS=0, next if /^[:-]oldstyle_urls$/;
657 $PRIVATE_TEMPFILES++, next if /^[:-]private_tempfiles$/;
658 $EXPORT{$_}++, next if /^[:-]any$/;
659 $compile++, next if /^[:-]compile$/;
661 # This is probably extremely evil code -- to be deleted some day.
662 if (/^[-]autoload$/) {
663 my($pkg) = caller(1);
664 *{"${pkg}::AUTOLOAD"} = sub {
665 my($routine) = $AUTOLOAD;
666 $routine =~ s/^.*::/CGI::/;
672 foreach (&expand_tags($_)) {
673 tr/a-zA-Z0-9_//cd; # don't allow weird function names
677 _compile_all(keys %EXPORT) if $compile;
681 my ($self,$charset) = self_or_default(@_);
682 $self->{'.charset'} = $charset if defined $charset;
686 ###############################################################################
687 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
688 ###############################################################################
689 $AUTOLOADED_ROUTINES = ''; # get rid of -w warning
690 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
694 'URL_ENCODED'=> <<'END_OF_FUNC',
695 sub URL_ENCODED { 'application/x-www-form-urlencoded'; }
698 'MULTIPART' => <<'END_OF_FUNC',
699 sub MULTIPART { 'multipart/form-data'; }
702 'SERVER_PUSH' => <<'END_OF_FUNC',
703 sub SERVER_PUSH { 'multipart/x-mixed-replace; boundary="' . shift() . '"'; }
706 'new_MultipartBuffer' => <<'END_OF_FUNC',
707 # Create a new multipart buffer
708 sub new_MultipartBuffer {
709 my($self,$boundary,$length,$filehandle) = @_;
710 return MultipartBuffer->new($self,$boundary,$length,$filehandle);
714 'read_from_client' => <<'END_OF_FUNC',
715 # Read data from a file handle
716 sub read_from_client {
717 my($self, $fh, $buff, $len, $offset) = @_;
718 local $^W=0; # prevent a warning
719 return undef unless defined($fh);
720 return read($fh, $$buff, $len, $offset);
724 'delete' => <<'END_OF_FUNC',
726 # Deletes the named parameter entirely.
729 my($self,@p) = self_or_default(@_);
730 my($name) = rearrange([NAME],@p);
731 CORE::delete $self->{$name};
732 CORE::delete $self->{'.fieldnames'}->{$name};
733 @{$self->{'.parameters'}}=grep($_ ne $name,$self->param());
734 return wantarray ? () : undef;
738 #### Method: import_names
739 # Import all parameters into the given namespace.
740 # Assumes namespace 'Q' if not specified
742 'import_names' => <<'END_OF_FUNC',
744 my($self,$namespace,$delete) = self_or_default(@_);
745 $namespace = 'Q' unless defined($namespace);
746 die "Can't import names into \"main\"\n" if \%{"${namespace}::"} == \%::;
747 if ($delete || $MOD_PERL || exists $ENV{'FCGI_ROLE'}) {
748 # can anyone find an easier way to do this?
749 foreach (keys %{"${namespace}::"}) {
750 local *symbol = "${namespace}::${_}";
756 my($param,@value,$var);
757 foreach $param ($self->param) {
758 # protect against silly names
759 ($var = $param)=~tr/a-zA-Z0-9_/_/c;
760 $var =~ s/^(?=\d)/_/;
761 local *symbol = "${namespace}::$var";
762 @value = $self->param($param);
769 #### Method: keywords
770 # Keywords acts a bit differently. Calling it in a list context
771 # returns the list of keywords.
772 # Calling it in a scalar context gives you the size of the list.
774 'keywords' => <<'END_OF_FUNC',
776 my($self,@values) = self_or_default(@_);
777 # If values is provided, then we set it.
778 $self->{'keywords'}=[@values] if @values;
779 my(@result) = defined($self->{'keywords'}) ? @{$self->{'keywords'}} : ();
784 # These are some tie() interfaces for compatibility
785 # with Steve Brenner's cgi-lib.pl routines
786 'Vars' => <<'END_OF_FUNC',
791 return %in if wantarray;
796 # These are some tie() interfaces for compatibility
797 # with Steve Brenner's cgi-lib.pl routines
798 'ReadParse' => <<'END_OF_FUNC',
808 return scalar(keys %in);
812 'PrintHeader' => <<'END_OF_FUNC',
814 my($self) = self_or_default(@_);
815 return $self->header();
819 'HtmlTop' => <<'END_OF_FUNC',
821 my($self,@p) = self_or_default(@_);
822 return $self->start_html(@p);
826 'HtmlBot' => <<'END_OF_FUNC',
828 my($self,@p) = self_or_default(@_);
829 return $self->end_html(@p);
833 'SplitParam' => <<'END_OF_FUNC',
836 my (@params) = split ("\0", $param);
837 return (wantarray ? @params : $params[0]);
841 'MethGet' => <<'END_OF_FUNC',
843 return request_method() eq 'GET';
847 'MethPost' => <<'END_OF_FUNC',
849 return request_method() eq 'POST';
853 'TIEHASH' => <<'END_OF_FUNC',
855 return $_[1] if defined $_[1];
856 return $Q ||= new shift;
860 'STORE' => <<'END_OF_FUNC',
865 my @vals = index($vals,"\0")!=-1 ? split("\0",$vals) : $vals;
866 $self->param(-name=>$tag,-value=>\@vals);
870 'FETCH' => <<'END_OF_FUNC',
872 return $_[0] if $_[1] eq 'CGI';
873 return undef unless defined $_[0]->param($_[1]);
874 return join("\0",$_[0]->param($_[1]));
878 'FIRSTKEY' => <<'END_OF_FUNC',
880 $_[0]->{'.iterator'}=0;
881 $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
885 'NEXTKEY' => <<'END_OF_FUNC',
887 $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
891 'EXISTS' => <<'END_OF_FUNC',
893 exists $_[0]->{$_[1]};
897 'DELETE' => <<'END_OF_FUNC',
899 $_[0]->delete($_[1]);
903 'CLEAR' => <<'END_OF_FUNC',
911 # Append a new value to an existing query
916 my($name,$value) = rearrange([NAME,[VALUE,VALUES]],@p);
917 my(@values) = defined($value) ? (ref($value) ? @{$value} : $value) : ();
919 $self->add_parameter($name);
920 push(@{$self->{$name}},@values);
922 return $self->param($name);
926 #### Method: delete_all
927 # Delete all parameters
929 'delete_all' => <<'EOF',
931 my($self) = self_or_default(@_);
938 my($self,@p) = self_or_default(@_);
943 'Delete_all' => <<'EOF',
945 my($self,@p) = self_or_default(@_);
946 $self->delete_all(@p);
950 #### Method: autoescape
951 # If you want to turn off the autoescaping features,
952 # call this method with undef as the argument
953 'autoEscape' => <<'END_OF_FUNC',
955 my($self,$escape) = self_or_default(@_);
956 $self->{'dontescape'}=!$escape;
962 # Return the current version
964 'version' => <<'END_OF_FUNC',
970 #### Method: url_param
971 # Return a parameter in the QUERY_STRING, regardless of
972 # whether this was a POST or a GET
974 'url_param' => <<'END_OF_FUNC',
976 my ($self,@p) = self_or_default(@_);
977 my $name = shift(@p);
978 return undef unless exists($ENV{QUERY_STRING});
979 unless (exists($self->{'.url_param'})) {
980 $self->{'.url_param'}={}; # empty hash
981 if ($ENV{QUERY_STRING} =~ /=/) {
982 my(@pairs) = split(/[&;]/,$ENV{QUERY_STRING});
985 ($param,$value) = split('=',$_,2);
986 $param = unescape($param);
987 $value = unescape($value);
988 push(@{$self->{'.url_param'}->{$param}},$value);
991 $self->{'.url_param'}->{'keywords'} = [$self->parse_keywordlist($ENV{QUERY_STRING})];
994 return keys %{$self->{'.url_param'}} unless defined($name);
995 return () unless $self->{'.url_param'}->{$name};
996 return wantarray ? @{$self->{'.url_param'}->{$name}}
997 : $self->{'.url_param'}->{$name}->[0];
1002 # Returns a string in which all the known parameter/value
1003 # pairs are represented as nested lists, mainly for the purposes
1006 'Dump' => <<'END_OF_FUNC',
1008 my($self) = self_or_default(@_);
1009 my($param,$value,@result);
1010 return '<UL></UL>' unless $self->param;
1011 push(@result,"<UL>");
1012 foreach $param ($self->param) {
1013 my($name)=$self->escapeHTML($param);
1014 push(@result,"<LI><STRONG>$param</STRONG>");
1015 push(@result,"<UL>");
1016 foreach $value ($self->param($param)) {
1017 $value = $self->escapeHTML($value);
1018 $value =~ s/\n/<BR>\n/g;
1019 push(@result,"<LI>$value");
1021 push(@result,"</UL>");
1023 push(@result,"</UL>\n");
1024 return join("\n",@result);
1028 #### Method as_string
1030 # synonym for "dump"
1032 'as_string' => <<'END_OF_FUNC',
1039 # Write values out to a filehandle in such a way that they can
1040 # be reinitialized by the filehandle form of the new() method
1042 'save' => <<'END_OF_FUNC',
1044 my($self,$filehandle) = self_or_default(@_);
1045 $filehandle = to_filehandle($filehandle);
1047 local($,) = ''; # set print field separator back to a sane value
1048 local($\) = ''; # set output line separator to a sane value
1049 foreach $param ($self->param) {
1050 my($escaped_param) = escape($param);
1052 foreach $value ($self->param($param)) {
1053 print $filehandle "$escaped_param=",escape("$value"),"\n";
1056 print $filehandle "=\n"; # end of record
1061 #### Method: save_parameters
1062 # An alias for save() that is a better name for exportation.
1063 # Only intended to be used with the function (non-OO) interface.
1065 'save_parameters' => <<'END_OF_FUNC',
1066 sub save_parameters {
1068 return save(to_filehandle($fh));
1072 #### Method: restore_parameters
1073 # A way to restore CGI parameters from an initializer.
1074 # Only intended to be used with the function (non-OO) interface.
1076 'restore_parameters' => <<'END_OF_FUNC',
1077 sub restore_parameters {
1078 $Q = $CGI::DefaultClass->new(@_);
1082 #### Method: multipart_init
1083 # Return a Content-Type: style header for server-push
1084 # This has to be NPH, and it is advisable to set $| = 1
1086 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1089 'multipart_init' => <<'END_OF_FUNC',
1090 sub multipart_init {
1091 my($self,@p) = self_or_default(@_);
1092 my($boundary,@other) = rearrange([BOUNDARY],@p);
1093 $boundary = $boundary || '------- =_aaaaaaaaaa0';
1094 $self->{'separator'} = "\n--$boundary\n";
1095 $type = SERVER_PUSH($boundary);
1096 return $self->header(
1099 (map { split "=", $_, 2 } @other),
1100 ) . $self->multipart_end;
1105 #### Method: multipart_start
1106 # Return a Content-Type: style header for server-push, start of section
1108 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1111 'multipart_start' => <<'END_OF_FUNC',
1112 sub multipart_start {
1113 my($self,@p) = self_or_default(@_);
1114 my($type,@other) = rearrange([TYPE],@p);
1115 $type = $type || 'text/html';
1116 return $self->header(
1118 (map { split "=", $_, 2 } @other),
1124 #### Method: multipart_end
1125 # Return a Content-Type: style header for server-push, end of section
1127 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1130 'multipart_end' => <<'END_OF_FUNC',
1132 my($self,@p) = self_or_default(@_);
1133 return $self->{'separator'};
1139 # Return a Content-Type: style header
1142 'header' => <<'END_OF_FUNC',
1144 my($self,@p) = self_or_default(@_);
1147 return undef if $self->{'.header_printed'}++ and $HEADERS_ONCE;
1149 my($type,$status,$cookie,$target,$expires,$nph,$charset,$attachment,@other) =
1150 rearrange([['TYPE','CONTENT_TYPE','CONTENT-TYPE'],
1151 'STATUS',['COOKIE','COOKIES'],'TARGET',
1152 'EXPIRES','NPH','CHARSET',
1156 if (defined $charset) {
1157 $self->charset($charset);
1159 $charset = $self->charset;
1162 # rearrange() was designed for the HTML portion, so we
1163 # need to fix it up a little.
1165 next unless my($header,$value) = /([^\s=]+)=\"?(.+?)\"?$/;
1166 ($_ = $header) =~ s/^(\w)(.*)/$1 . lc ($2) . ': '.$self->unescapeHTML($value)/e;
1169 $type ||= 'text/html' unless defined($type);
1170 $type .= "; charset=$charset" if $type ne '' and $type =~ m!^text/! and $type !~ /\bcharset\b/;
1172 # Maybe future compatibility. Maybe not.
1173 my $protocol = $ENV{SERVER_PROTOCOL} || 'HTTP/1.0';
1174 push(@header,$protocol . ' ' . ($status || '200 OK')) if $nph;
1176 push(@header,"Status: $status") if $status;
1177 push(@header,"Window-Target: $target") if $target;
1178 # push all the cookies -- there may be several
1180 my(@cookie) = ref($cookie) && ref($cookie) eq 'ARRAY' ? @{$cookie} : $cookie;
1182 my $cs = UNIVERSAL::isa($_,'CGI::Cookie') ? $_->as_string : $_;
1183 push(@header,"Set-Cookie: $cs") if $cs ne '';
1186 # if the user indicates an expiration time, then we need
1187 # both an Expires and a Date header (so that the browser is
1189 push(@header,"Expires: " . expires($expires,'http'))
1191 push(@header,"Date: " . expires(0,'http')) if $expires || $cookie;
1192 push(@header,"Pragma: no-cache") if $self->cache();
1193 push(@header,"Content-Disposition: attachment; filename=\"$attachment\"") if $attachment;
1194 push(@header,@other);
1195 push(@header,"Content-Type: $type") if $type ne '';
1197 my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1198 if ($MOD_PERL and not $nph) {
1199 my $r = Apache->request;
1200 $r->send_cgi_header($header);
1209 # Control whether header() will produce the no-cache
1212 'cache' => <<'END_OF_FUNC',
1214 my($self,$new_value) = self_or_default(@_);
1215 $new_value = '' unless $new_value;
1216 if ($new_value ne '') {
1217 $self->{'cache'} = $new_value;
1219 return $self->{'cache'};
1224 #### Method: redirect
1225 # Return a Location: style header
1228 'redirect' => <<'END_OF_FUNC',
1230 my($self,@p) = self_or_default(@_);
1231 my($url,$target,$cookie,$nph,@other) = rearrange([[LOCATION,URI,URL],TARGET,COOKIE,NPH],@p);
1232 $url ||= $self->self_url;
1234 foreach (@other) { tr/\"//d; push(@o,split("=",$_,2)); }
1236 '-Status'=>'302 Moved',
1239 unshift(@o,'-Target'=>$target) if $target;
1240 unshift(@o,'-Cookie'=>$cookie) if $cookie;
1241 unshift(@o,'-Type'=>'');
1242 return $self->header(@o);
1247 #### Method: start_html
1248 # Canned HTML header
1251 # $title -> (optional) The title for this HTML document (-title)
1252 # $author -> (optional) e-mail address of the author (-author)
1253 # $base -> (optional) if set to true, will enter the BASE address of this document
1254 # for resolving relative references (-base)
1255 # $xbase -> (optional) alternative base at some remote location (-xbase)
1256 # $target -> (optional) target window to load all links into (-target)
1257 # $script -> (option) Javascript code (-script)
1258 # $no_script -> (option) Javascript <noscript> tag (-noscript)
1259 # $meta -> (optional) Meta information tags
1260 # $head -> (optional) any other elements you'd like to incorporate into the <HEAD> tag
1261 # (a scalar or array ref)
1262 # $style -> (optional) reference to an external style sheet
1263 # @other -> (optional) any other named parameters you'd like to incorporate into
1266 'start_html' => <<'END_OF_FUNC',
1268 my($self,@p) = &self_or_default(@_);
1269 my($title,$author,$base,$xbase,$script,$noscript,$target,$meta,$head,$style,$dtd,$lang,@other) =
1270 rearrange([TITLE,AUTHOR,BASE,XBASE,SCRIPT,NOSCRIPT,TARGET,META,HEAD,STYLE,DTD,LANG],@p);
1272 # strangely enough, the title needs to be escaped as HTML
1273 # while the author needs to be escaped as a URL
1274 $title = $self->escapeHTML($title || 'Untitled Document');
1275 $author = $self->escape($author);
1279 if (defined(ref($dtd)) and (ref($dtd) eq 'ARRAY')) {
1280 $dtd = $DEFAULT_DTD unless $dtd->[0] =~ m|^-//|;
1282 $dtd = $DEFAULT_DTD unless $dtd =~ m|^-//|;
1285 $dtd = $XHTML ? XHTML_DTD : $DEFAULT_DTD;
1287 if (ref($dtd) && ref($dtd) eq 'ARRAY') {
1288 push(@result,qq(<!DOCTYPE HTML\n\tPUBLIC "$dtd->[0]"\n\t"$dtd->[1]">));
1290 push(@result,qq(<!DOCTYPE HTML\n\tPUBLIC "$dtd">));
1292 push(@result,$XHTML ? qq(<html xmlns="http://www.w3.org/1999/xhtml" lang="$lang"><head><title>$title</title>)
1293 : qq(<html lang="$lang"><head><title>$title</title>));
1294 if (defined $author) {
1295 push(@result,$XHTML ? "<link rev=\"made\" href=\"mailto:$author\" />"
1296 : "<link rev=made href=\"mailto:$author\">");
1299 if ($base || $xbase || $target) {
1300 my $href = $xbase || $self->url('-path'=>1);
1301 my $t = $target ? qq/ target="$target"/ : '';
1302 push(@result,$XHTML ? qq(<base href="$href"$t />) : qq(<base href="$href"$t>));
1305 if ($meta && ref($meta) && (ref($meta) eq 'HASH')) {
1306 foreach (keys %$meta) { push(@result,$XHTML ? qq(<meta name="$_" content="$meta->{$_}" />)
1307 : qq(<meta name="$_" content="$meta->{$_}">)); }
1310 push(@result,ref($head) ? @$head : $head) if $head;
1312 # handle the infrequently-used -style and -script parameters
1313 push(@result,$self->_style($style)) if defined $style;
1314 push(@result,$self->_script($script)) if defined $script;
1316 # handle -noscript parameter
1317 push(@result,<<END) if $noscript;
1323 my($other) = @other ? " @other" : '';
1324 push(@result,"</head><body$other>");
1325 return join("\n",@result);
1330 # internal method for generating a CSS style section
1332 '_style' => <<'END_OF_FUNC',
1334 my ($self,$style) = @_;
1336 my $type = 'text/css';
1338 my $cdata_start = $XHTML ? "\n<!--/* <![CDATA[ */" : "\n<!-- ";
1339 my $cdata_end = $XHTML ? "\n/* ]]> */-->\n" : " -->\n";
1342 my($src,$code,$stype,@other) =
1343 rearrange([SRC,CODE,TYPE],
1344 '-foo'=>'bar', # a trick to allow the '-' to be omitted
1345 ref($style) eq 'ARRAY' ? @$style : %$style);
1346 $type = $stype if $stype;
1347 if (ref($src) eq "ARRAY") # Check to see if the $src variable is an array reference
1348 { # If it is, push a LINK tag for each one.
1349 foreach $src (@$src)
1351 push(@result,qq/<link rel="stylesheet" type="$type" href="$src">/) if $src;
1355 { # Otherwise, push the single -src, if it exists.
1356 push(@result,qq/<link rel="stylesheet" type="$type" href="$src">/) if $src;
1358 push(@result,style({'type'=>$type},"$cdata_start\n$code\n$cdata_end")) if $code;
1360 push(@result,style({'type'=>$type},"$cdata_start\n$style\n$cdata_end"));
1366 '_script' => <<'END_OF_FUNC',
1368 my ($self,$script) = @_;
1371 my (@scripts) = ref($script) eq 'ARRAY' ? @$script : ($script);
1372 foreach $script (@scripts) {
1373 my($src,$code,$language);
1374 if (ref($script)) { # script is a hash
1375 ($src,$code,$language, $type) =
1376 rearrange([SRC,CODE,LANGUAGE,TYPE],
1377 '-foo'=>'bar', # a trick to allow the '-' to be omitted
1378 ref($script) eq 'ARRAY' ? @$script : %$script);
1379 # User may not have specified language
1380 $language ||= 'JavaScript';
1381 unless (defined $type) {
1382 $type = lc $language;
1383 # strip '1.2' from 'javascript1.2'
1384 $type =~ s/^(\D+).*$/text\/$1/;
1387 ($src,$code,$language, $type) = ('',$script,'JavaScript', 'text/javascript');
1390 my $comment = '//'; # javascript by default
1391 $comment = '#' if $type=~/perl|tcl/i;
1392 $comment = "'" if $type=~/vbscript/i;
1394 my $cdata_start = "\n<!-- Hide script\n";
1395 $cdata_start .= "$comment<![CDATA[\n" if $XHTML;
1396 my $cdata_end = $XHTML ? "\n$comment]]>" : $comment;
1397 $cdata_end .= " End script hiding -->\n";
1400 push(@satts,'src'=>$src) if $src;
1401 push(@satts,'language'=>$language);
1402 push(@satts,'type'=>$type);
1403 $code = "$cdata_start$code$cdata_end";
1404 push(@result,script({@satts},$code || ''));
1410 #### Method: end_html
1411 # End an HTML document.
1412 # Trivial method for completeness. Just returns "</BODY>"
1414 'end_html' => <<'END_OF_FUNC',
1416 return "</body></html>";
1421 ################################
1422 # METHODS USED IN BUILDING FORMS
1423 ################################
1425 #### Method: isindex
1426 # Just prints out the isindex tag.
1428 # $action -> optional URL of script to run
1430 # A string containing a <ISINDEX> tag
1431 'isindex' => <<'END_OF_FUNC',
1433 my($self,@p) = self_or_default(@_);
1434 my($action,@other) = rearrange([ACTION],@p);
1435 $action = qq/action="$action"/ if $action;
1436 my($other) = @other ? " @other" : '';
1437 return $XHTML ? "<isindex $action$other />" : "<isindex $action$other>";
1442 #### Method: startform
1445 # $method -> optional submission method to use (GET or POST)
1446 # $action -> optional URL of script to run
1447 # $enctype ->encoding to use (URL_ENCODED or MULTIPART)
1448 'startform' => <<'END_OF_FUNC',
1450 my($self,@p) = self_or_default(@_);
1452 my($method,$action,$enctype,@other) =
1453 rearrange([METHOD,ACTION,ENCTYPE],@p);
1455 $method = uc($method) || 'POST';
1456 $enctype = $enctype || &URL_ENCODED;
1457 $action = $action ? qq(action="$action") : qq 'action="' .
1458 $self->url(-absolute=>1,-path=>1,-query=>1) . '"';
1459 my($other) = @other ? " @other" : '';
1460 $self->{'.parametersToAdd'}={};
1461 return qq/<form method="$method" $action enctype="$enctype"$other>\n/;
1466 #### Method: start_form
1467 # synonym for startform
1468 'start_form' => <<'END_OF_FUNC',
1474 'end_multipart_form' => <<'END_OF_FUNC',
1475 sub end_multipart_form {
1480 #### Method: start_multipart_form
1481 # synonym for startform
1482 'start_multipart_form' => <<'END_OF_FUNC',
1483 sub start_multipart_form {
1484 my($self,@p) = self_or_default(@_);
1485 if (defined($param[0]) && substr($param[0],0,1) eq '-') {
1487 $p{'-enctype'}=&MULTIPART;
1488 return $self->startform(%p);
1490 my($method,$action,@other) =
1491 rearrange([METHOD,ACTION],@p);
1492 return $self->startform($method,$action,&MULTIPART,@other);
1498 #### Method: endform
1500 'endform' => <<'END_OF_FUNC',
1502 my($self,@p) = self_or_default(@_);
1504 return wantarray ? ("</form>") : "\n</form>";
1506 return wantarray ? ($self->get_fields,"</form>") :
1507 $self->get_fields ."\n</form>";
1513 #### Method: end_form
1514 # synonym for endform
1515 'end_form' => <<'END_OF_FUNC',
1522 '_textfield' => <<'END_OF_FUNC',
1524 my($self,$tag,@p) = self_or_default(@_);
1525 my($name,$default,$size,$maxlength,$override,@other) =
1526 rearrange([NAME,[DEFAULT,VALUE],SIZE,MAXLENGTH,[OVERRIDE,FORCE]],@p);
1528 my $current = $override ? $default :
1529 (defined($self->param($name)) ? $self->param($name) : $default);
1531 $current = defined($current) ? $self->escapeHTML($current,1) : '';
1532 $name = defined($name) ? $self->escapeHTML($name) : '';
1533 my($s) = defined($size) ? qq/ size=$size/ : '';
1534 my($m) = defined($maxlength) ? qq/ maxlength=$maxlength/ : '';
1535 my($other) = @other ? " @other" : '';
1536 # this entered at cristy's request to fix problems with file upload fields
1537 # and WebTV -- not sure it won't break stuff
1538 my($value) = $current ne '' ? qq(value="$current") : '';
1539 return $XHTML ? qq(<input type="$tag" name="$name" $value$s$m$other />)
1540 : qq/<input type="$tag" name="$name" $value$s$m$other>/;
1544 #### Method: textfield
1546 # $name -> Name of the text field
1547 # $default -> Optional default value of the field if not
1549 # $size -> Optional width of field in characaters.
1550 # $maxlength -> Optional maximum number of characters.
1552 # A string containing a <INPUT TYPE="text"> field
1554 'textfield' => <<'END_OF_FUNC',
1556 my($self,@p) = self_or_default(@_);
1557 $self->_textfield('text',@p);
1562 #### Method: filefield
1564 # $name -> Name of the file upload field
1565 # $size -> Optional width of field in characaters.
1566 # $maxlength -> Optional maximum number of characters.
1568 # A string containing a <INPUT TYPE="text"> field
1570 'filefield' => <<'END_OF_FUNC',
1572 my($self,@p) = self_or_default(@_);
1573 $self->_textfield('file',@p);
1578 #### Method: password
1579 # Create a "secret password" entry field
1581 # $name -> Name of the field
1582 # $default -> Optional default value of the field if not
1584 # $size -> Optional width of field in characters.
1585 # $maxlength -> Optional maximum characters that can be entered.
1587 # A string containing a <INPUT TYPE="password"> field
1589 'password_field' => <<'END_OF_FUNC',
1590 sub password_field {
1591 my ($self,@p) = self_or_default(@_);
1592 $self->_textfield('password',@p);
1596 #### Method: textarea
1598 # $name -> Name of the text field
1599 # $default -> Optional default value of the field if not
1601 # $rows -> Optional number of rows in text area
1602 # $columns -> Optional number of columns in text area
1604 # A string containing a <TEXTAREA></TEXTAREA> tag
1606 'textarea' => <<'END_OF_FUNC',
1608 my($self,@p) = self_or_default(@_);
1610 my($name,$default,$rows,$cols,$override,@other) =
1611 rearrange([NAME,[DEFAULT,VALUE],ROWS,[COLS,COLUMNS],[OVERRIDE,FORCE]],@p);
1613 my($current)= $override ? $default :
1614 (defined($self->param($name)) ? $self->param($name) : $default);
1616 $name = defined($name) ? $self->escapeHTML($name) : '';
1617 $current = defined($current) ? $self->escapeHTML($current) : '';
1618 my($r) = $rows ? " rows=$rows" : '';
1619 my($c) = $cols ? " cols=$cols" : '';
1620 my($other) = @other ? " @other" : '';
1621 return qq{<textarea name="$name"$r$c$other>$current</textarea>};
1627 # Create a javascript button.
1629 # $name -> (optional) Name for the button. (-name)
1630 # $value -> (optional) Value of the button when selected (and visible name) (-value)
1631 # $onclick -> (optional) Text of the JavaScript to run when the button is
1634 # A string containing a <INPUT TYPE="button"> tag
1636 'button' => <<'END_OF_FUNC',
1638 my($self,@p) = self_or_default(@_);
1640 my($label,$value,$script,@other) = rearrange([NAME,[VALUE,LABEL],
1641 [ONCLICK,SCRIPT]],@p);
1643 $label=$self->escapeHTML($label);
1644 $value=$self->escapeHTML($value,1);
1645 $script=$self->escapeHTML($script);
1648 $name = qq/ NAME="$label"/ if $label;
1649 $value = $value || $label;
1651 $val = qq/ value="$value"/ if $value;
1652 $script = qq/ onclick="$script"/ if $script;
1653 my($other) = @other ? " @other" : '';
1654 return $XHTML ? qq(<input type="button"$name$val$script$other />)
1655 : qq/<input type="button"$name$val$script$other>/;
1661 # Create a "submit query" button.
1663 # $name -> (optional) Name for the button.
1664 # $value -> (optional) Value of the button when selected (also doubles as label).
1665 # $label -> (optional) Label printed on the button(also doubles as the value).
1667 # A string containing a <INPUT TYPE="submit"> tag
1669 'submit' => <<'END_OF_FUNC',
1671 my($self,@p) = self_or_default(@_);
1673 my($label,$value,@other) = rearrange([NAME,[VALUE,LABEL]],@p);
1675 $label=$self->escapeHTML($label);
1676 $value=$self->escapeHTML($value,1);
1678 my($name) = ' name=".submit"' unless $NOSTICKY;
1679 $name = qq/ name="$label"/ if defined($label);
1680 $value = defined($value) ? $value : $label;
1682 $val = qq/ value="$value"/ if defined($value);
1683 my($other) = @other ? " @other" : '';
1684 return $XHTML ? qq(<input type="submit"$name$val$other />)
1685 : qq/<input type="submit"$name$val$other>/;
1691 # Create a "reset" button.
1693 # $name -> (optional) Name for the button.
1695 # A string containing a <INPUT TYPE="reset"> tag
1697 'reset' => <<'END_OF_FUNC',
1699 my($self,@p) = self_or_default(@_);
1700 my($label,@other) = rearrange([NAME],@p);
1701 $label=$self->escapeHTML($label);
1702 my($value) = defined($label) ? qq/ value="$label"/ : '';
1703 my($other) = @other ? " @other" : '';
1704 return $XHTML ? qq(<input type="reset"$value$other />)
1705 : qq/<input type="reset"$value$other>/;
1710 #### Method: defaults
1711 # Create a "defaults" button.
1713 # $name -> (optional) Name for the button.
1715 # A string containing a <INPUT TYPE="submit" NAME=".defaults"> tag
1717 # Note: this button has a special meaning to the initialization script,
1718 # and tells it to ERASE the current query string so that your defaults
1721 'defaults' => <<'END_OF_FUNC',
1723 my($self,@p) = self_or_default(@_);
1725 my($label,@other) = rearrange([[NAME,VALUE]],@p);
1727 $label=$self->escapeHTML($label,1);
1728 $label = $label || "Defaults";
1729 my($value) = qq/ value="$label"/;
1730 my($other) = @other ? " @other" : '';
1731 return $XHTML ? qq(<input type="submit" value".defaults"$value$other />)
1732 : qq/<input type="submit" NAME=".defaults"$value$other>/;
1737 #### Method: comment
1738 # Create an HTML <!-- comment -->
1739 # Parameters: a string
1740 'comment' => <<'END_OF_FUNC',
1742 my($self,@p) = self_or_CGI(@_);
1743 return "<!-- @p -->";
1747 #### Method: checkbox
1748 # Create a checkbox that is not logically linked to any others.
1749 # The field value is "on" when the button is checked.
1751 # $name -> Name of the checkbox
1752 # $checked -> (optional) turned on by default if true
1753 # $value -> (optional) value of the checkbox, 'on' by default
1754 # $label -> (optional) a user-readable label printed next to the box.
1755 # Otherwise the checkbox name is used.
1757 # A string containing a <INPUT TYPE="checkbox"> field
1759 'checkbox' => <<'END_OF_FUNC',
1761 my($self,@p) = self_or_default(@_);
1763 my($name,$checked,$value,$label,$override,@other) =
1764 rearrange([NAME,[CHECKED,SELECTED,ON],VALUE,LABEL,[OVERRIDE,FORCE]],@p);
1766 $value = defined $value ? $value : 'on';
1768 if (!$override && ($self->{'.fieldnames'}->{$name} ||
1769 defined $self->param($name))) {
1770 $checked = grep($_ eq $value,$self->param($name)) ? ' checked="yes"' : '';
1772 $checked = $checked ? qq/ checked="yes"/ : '';
1774 my($the_label) = defined $label ? $label : $name;
1775 $name = $self->escapeHTML($name);
1776 $value = $self->escapeHTML($value,1);
1777 $the_label = $self->escapeHTML($the_label);
1778 my($other) = @other ? " @other" : '';
1779 $self->register_parameter($name);
1780 return $XHTML ? qq{<input type="checkbox" name="$name" value="$value"$checked$other />$the_label}
1781 : qq{<input type="checkbox" name="$name" value="$value"$checked$other>$the_label};
1786 #### Method: checkbox_group
1787 # Create a list of logically-linked checkboxes.
1789 # $name -> Common name for all the check boxes
1790 # $values -> A pointer to a regular array containing the
1791 # values for each checkbox in the group.
1792 # $defaults -> (optional)
1793 # 1. If a pointer to a regular array of checkbox values,
1794 # then this will be used to decide which
1795 # checkboxes to turn on by default.
1796 # 2. If a scalar, will be assumed to hold the
1797 # value of a single checkbox in the group to turn on.
1798 # $linebreak -> (optional) Set to true to place linebreaks
1799 # between the buttons.
1800 # $labels -> (optional)
1801 # A pointer to an associative array of labels to print next to each checkbox
1802 # in the form $label{'value'}="Long explanatory label".
1803 # Otherwise the provided values are used as the labels.
1805 # An ARRAY containing a series of <INPUT TYPE="checkbox"> fields
1807 'checkbox_group' => <<'END_OF_FUNC',
1808 sub checkbox_group {
1809 my($self,@p) = self_or_default(@_);
1811 my($name,$values,$defaults,$linebreak,$labels,$rows,$columns,
1812 $rowheaders,$colheaders,$override,$nolabels,@other) =
1813 rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT],
1814 LINEBREAK,LABELS,ROWS,[COLUMNS,COLS],
1815 ROWHEADERS,COLHEADERS,
1816 [OVERRIDE,FORCE],NOLABELS],@p);
1818 my($checked,$break,$result,$label);
1820 my(%checked) = $self->previous_or_default($name,$defaults,$override);
1823 $break = $XHTML ? "<br />" : "<br>";
1828 $name=$self->escapeHTML($name);
1830 # Create the elements
1831 my(@elements,@values);
1833 @values = $self->_set_values_and_labels($values,\$labels,$name);
1835 my($other) = @other ? " @other" : '';
1837 $checked = $checked{$_} ? qq/ checked="yes"/ : '';
1839 unless (defined($nolabels) && $nolabels) {
1841 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
1842 $label = $self->escapeHTML($label);
1844 $_ = $self->escapeHTML($_,1);
1845 push(@elements,$XHTML ? qq(<input type="checkbox" name="$name" value="$_"$checked$other />${label}${break})
1846 : qq/<input type="checkbox" name="$name" value="$_"$checked$other>${label}${break}/);
1848 $self->register_parameter($name);
1849 return wantarray ? @elements : join(' ',@elements)
1850 unless defined($columns) || defined($rows);
1851 return _tableize($rows,$columns,$rowheaders,$colheaders,@elements);
1855 # Escape HTML -- used internally
1856 'escapeHTML' => <<'END_OF_FUNC',
1858 my ($self,$toencode,$newlinestoo) = CGI::self_or_default(@_);
1859 return undef unless defined($toencode);
1860 return $toencode if ref($self) && $self->{'dontescape'};
1861 $toencode =~ s{&}{&}gso;
1862 $toencode =~ s{<}{<}gso;
1863 $toencode =~ s{>}{>}gso;
1864 $toencode =~ s{"}{"}gso;
1865 my $latin = uc $self->{'.charset'} eq 'ISO-8859-1' ||
1866 uc $self->{'.charset'} eq 'WINDOWS-1252';
1867 if ($latin) { # bug in some browsers
1868 $toencode =~ s{\x8b}{‹}gso;
1869 $toencode =~ s{\x9b}{›}gso;
1870 if (defined $newlinestoo && $newlinestoo) {
1871 $toencode =~ s{\012}{ }gso;
1872 $toencode =~ s{\015}{ }gso;
1879 # unescape HTML -- used internally
1880 'unescapeHTML' => <<'END_OF_FUNC',
1882 my ($self,$string) = CGI::self_or_default(@_);
1883 return undef unless defined($string);
1884 my $latin = defined $self->{'.charset'} ? $self->{'.charset'} =~ /^(ISO-8859-1|WINDOWS-1252)$/i
1886 # thanks to Randal Schwartz for the correct solution to this one
1887 $string=~ s[&(.*?);]{
1893 /^#(\d+)$/ && $latin ? chr($1) :
1894 /^#x([0-9a-f]+)$/i && $latin ? chr(hex($1)) :
1901 # Internal procedure - don't use
1902 '_tableize' => <<'END_OF_FUNC',
1904 my($rows,$columns,$rowheaders,$colheaders,@elements) = @_;
1905 $rowheaders = [] unless defined $rowheaders;
1906 $colheaders = [] unless defined $colheaders;
1909 if (defined($columns)) {
1910 $rows = int(0.99 + @elements/$columns) unless defined($rows);
1912 if (defined($rows)) {
1913 $columns = int(0.99 + @elements/$rows) unless defined($columns);
1916 # rearrange into a pretty table
1917 $result = "<table>";
1919 unshift(@$colheaders,'') if @$colheaders && @$rowheaders;
1920 $result .= "<tr>" if @{$colheaders};
1921 foreach (@{$colheaders}) {
1922 $result .= "<th>$_</th>";
1924 for ($row=0;$row<$rows;$row++) {
1926 $result .= "<th>$rowheaders->[$row]</th>" if @$rowheaders;
1927 for ($column=0;$column<$columns;$column++) {
1928 $result .= "<td>" . $elements[$column*$rows + $row] . "</td>"
1929 if defined($elements[$column*$rows + $row]);
1933 $result .= "</table>";
1939 #### Method: radio_group
1940 # Create a list of logically-linked radio buttons.
1942 # $name -> Common name for all the buttons.
1943 # $values -> A pointer to a regular array containing the
1944 # values for each button in the group.
1945 # $default -> (optional) Value of the button to turn on by default. Pass '-'
1946 # to turn _nothing_ on.
1947 # $linebreak -> (optional) Set to true to place linebreaks
1948 # between the buttons.
1949 # $labels -> (optional)
1950 # A pointer to an associative array of labels to print next to each checkbox
1951 # in the form $label{'value'}="Long explanatory label".
1952 # Otherwise the provided values are used as the labels.
1954 # An ARRAY containing a series of <INPUT TYPE="radio"> fields
1956 'radio_group' => <<'END_OF_FUNC',
1958 my($self,@p) = self_or_default(@_);
1960 my($name,$values,$default,$linebreak,$labels,
1961 $rows,$columns,$rowheaders,$colheaders,$override,$nolabels,@other) =
1962 rearrange([NAME,[VALUES,VALUE],DEFAULT,LINEBREAK,LABELS,
1963 ROWS,[COLUMNS,COLS],
1964 ROWHEADERS,COLHEADERS,
1965 [OVERRIDE,FORCE],NOLABELS],@p);
1966 my($result,$checked);
1968 if (!$override && defined($self->param($name))) {
1969 $checked = $self->param($name);
1971 $checked = $default;
1973 my(@elements,@values);
1974 @values = $self->_set_values_and_labels($values,\$labels,$name);
1976 # If no check array is specified, check the first by default
1977 $checked = $values[0] unless defined($checked) && $checked ne '';
1978 $name=$self->escapeHTML($name);
1980 my($other) = @other ? " @other" : '';
1982 my($checkit) = $checked eq $_ ? qq/ checked="yes"/ : '';
1985 $break = $XHTML ? "<br />" : "<br>";
1991 unless (defined($nolabels) && $nolabels) {
1993 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
1994 $label = $self->escapeHTML($label,1);
1996 $_=$self->escapeHTML($_);
1997 push(@elements,$XHTML ? qq(<input type="radio" name="$name" value="$_"$checkit$other />${label}${break})
1998 : qq/<input type="radio" name="$name" value="$_"$checkit$other>${label}${break}/);
2000 $self->register_parameter($name);
2001 return wantarray ? @elements : join(' ',@elements)
2002 unless defined($columns) || defined($rows);
2003 return _tableize($rows,$columns,$rowheaders,$colheaders,@elements);
2008 #### Method: popup_menu
2009 # Create a popup menu.
2011 # $name -> Name for all the menu
2012 # $values -> A pointer to a regular array containing the
2013 # text of each menu item.
2014 # $default -> (optional) Default item to display
2015 # $labels -> (optional)
2016 # A pointer to an associative array of labels to print next to each checkbox
2017 # in the form $label{'value'}="Long explanatory label".
2018 # Otherwise the provided values are used as the labels.
2020 # A string containing the definition of a popup menu.
2022 'popup_menu' => <<'END_OF_FUNC',
2024 my($self,@p) = self_or_default(@_);
2026 my($name,$values,$default,$labels,$override,@other) =
2027 rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LABELS,[OVERRIDE,FORCE]],@p);
2028 my($result,$selected);
2030 if (!$override && defined($self->param($name))) {
2031 $selected = $self->param($name);
2033 $selected = $default;
2035 $name=$self->escapeHTML($name);
2036 my($other) = @other ? " @other" : '';
2039 @values = $self->_set_values_and_labels($values,\$labels,$name);
2041 $result = qq/<select name="$name"$other>\n/;
2043 my($selectit) = defined($selected) ? ($selected eq $_ ? qq/selected="yes"/ : '' ) : '';
2045 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2046 my($value) = $self->escapeHTML($_);
2047 $label=$self->escapeHTML($label,1);
2048 $result .= "<option $selectit value=\"$value\">$label</option>\n";
2051 $result .= "</select>\n";
2057 #### Method: scrolling_list
2058 # Create a scrolling list.
2060 # $name -> name for the list
2061 # $values -> A pointer to a regular array containing the
2062 # values for each option line in the list.
2063 # $defaults -> (optional)
2064 # 1. If a pointer to a regular array of options,
2065 # then this will be used to decide which
2066 # lines to turn on by default.
2067 # 2. Otherwise holds the value of the single line to turn on.
2068 # $size -> (optional) Size of the list.
2069 # $multiple -> (optional) If set, allow multiple selections.
2070 # $labels -> (optional)
2071 # A pointer to an associative array of labels to print next to each checkbox
2072 # in the form $label{'value'}="Long explanatory label".
2073 # Otherwise the provided values are used as the labels.
2075 # A string containing the definition of a scrolling list.
2077 'scrolling_list' => <<'END_OF_FUNC',
2078 sub scrolling_list {
2079 my($self,@p) = self_or_default(@_);
2080 my($name,$values,$defaults,$size,$multiple,$labels,$override,@other)
2081 = rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT],
2082 SIZE,MULTIPLE,LABELS,[OVERRIDE,FORCE]],@p);
2084 my($result,@values);
2085 @values = $self->_set_values_and_labels($values,\$labels,$name);
2087 $size = $size || scalar(@values);
2089 my(%selected) = $self->previous_or_default($name,$defaults,$override);
2090 my($is_multiple) = $multiple ? qq/ multiple="yes"/ : '';
2091 my($has_size) = $size ? qq/ size="$size"/: '';
2092 my($other) = @other ? " @other" : '';
2094 $name=$self->escapeHTML($name);
2095 $result = qq/<select name="$name"$has_size$is_multiple$other>\n/;
2097 my($selectit) = $selected{$_} ? qq/selected="yes"/ : '';
2099 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2100 $label=$self->escapeHTML($label);
2101 my($value)=$self->escapeHTML($_,1);
2102 $result .= "<option $selectit value=\"$value\">$label</option>\n";
2104 $result .= "</select>\n";
2105 $self->register_parameter($name);
2113 # $name -> Name of the hidden field
2114 # @default -> (optional) Initial values of field (may be an array)
2116 # $default->[initial values of field]
2118 # A string containing a <INPUT TYPE="hidden" NAME="name" VALUE="value">
2120 'hidden' => <<'END_OF_FUNC',
2122 my($self,@p) = self_or_default(@_);
2124 # this is the one place where we departed from our standard
2125 # calling scheme, so we have to special-case (darn)
2127 my($name,$default,$override,@other) =
2128 rearrange([NAME,[DEFAULT,VALUE,VALUES],[OVERRIDE,FORCE]],@p);
2130 my $do_override = 0;
2131 if ( ref($p[0]) || substr($p[0],0,1) eq '-') {
2132 @value = ref($default) ? @{$default} : $default;
2133 $do_override = $override;
2135 foreach ($default,$override,@other) {
2136 push(@value,$_) if defined($_);
2140 # use previous values if override is not set
2141 my @prev = $self->param($name);
2142 @value = @prev if !$do_override && @prev;
2144 $name=$self->escapeHTML($name);
2146 $_ = defined($_) ? $self->escapeHTML($_,1) : '';
2147 push(@result,$XHTMl ? qq(<input type="hidden" name="$name" value="$_" />)
2148 : qq/<input type="hidden" name="$name" value="$_">/);
2150 return wantarray ? @result : join('',@result);
2155 #### Method: image_button
2157 # $name -> Name of the button
2158 # $src -> URL of the image source
2159 # $align -> Alignment style (TOP, BOTTOM or MIDDLE)
2161 # A string containing a <INPUT TYPE="image" NAME="name" SRC="url" ALIGN="alignment">
2163 'image_button' => <<'END_OF_FUNC',
2165 my($self,@p) = self_or_default(@_);
2167 my($name,$src,$alignment,@other) =
2168 rearrange([NAME,SRC,ALIGN],@p);
2170 my($align) = $alignment ? " align=\U$alignment" : '';
2171 my($other) = @other ? " @other" : '';
2172 $name=$self->escapeHTML($name);
2173 return $XHTML ? qq(<input type="image" name="$name" src="$src"$align$other />)
2174 : qq/<input type="image" name="$name" src="$src"$align$other>/;
2179 #### Method: self_url
2180 # Returns a URL containing the current script and all its
2181 # param/value pairs arranged as a query. You can use this
2182 # to create a link that, when selected, will reinvoke the
2183 # script with all its state information preserved.
2185 'self_url' => <<'END_OF_FUNC',
2187 my($self,@p) = self_or_default(@_);
2188 return $self->url('-path_info'=>1,'-query'=>1,'-full'=>1,@p);
2193 # This is provided as a synonym to self_url() for people unfortunate
2194 # enough to have incorporated it into their programs already!
2195 'state' => <<'END_OF_FUNC',
2203 # Like self_url, but doesn't return the query string part of
2206 'url' => <<'END_OF_FUNC',
2208 my($self,@p) = self_or_default(@_);
2209 my ($relative,$absolute,$full,$path_info,$query) =
2210 rearrange(['RELATIVE','ABSOLUTE','FULL',['PATH','PATH_INFO'],['QUERY','QUERY_STRING']],@p);
2212 $full++ if !($relative || $absolute);
2214 my $path = $self->path_info;
2216 if (exists($ENV{REQUEST_URI})) {
2218 $script_name = $ENV{REQUEST_URI};
2219 # strip query string
2220 substr($script_name,$index) = '' if ($index = index($script_name,'?')) >= 0;
2222 if (exists($ENV{PATH_INFO})) {
2223 my $decoded_path = unescape($ENV{PATH_INFO});
2224 substr($script_name,$index) = '' if ($index = rindex($script_name,$decoded_path)) >= 0;
2227 $script_name = $self->script_name;
2231 my $protocol = $self->protocol();
2232 $url = "$protocol://";
2233 my $vh = http('host');
2237 $url .= server_name();
2238 my $port = $self->server_port;
2240 unless (lc($protocol) eq 'http' && $port == 80)
2241 || (lc($protocol) eq 'https' && $port == 443);
2243 $url .= $script_name;
2244 } elsif ($relative) {
2245 ($url) = $script_name =~ m!([^/]+)$!;
2246 } elsif ($absolute) {
2247 $url = $script_name;
2249 $url .= $path if $path_info and defined $path;
2250 $url .= "?" . $self->query_string if $query and $self->query_string;
2251 $url = '' unless defined $url;
2252 $url =~ s/([^a-zA-Z0-9_.%;&?\/\\:+=~-])/uc sprintf("%%%02x",ord($1))/eg;
2259 # Set or read a cookie from the specified name.
2260 # Cookie can then be passed to header().
2261 # Usual rules apply to the stickiness of -value.
2263 # -name -> name for this cookie (optional)
2264 # -value -> value of this cookie (scalar, array or hash)
2265 # -path -> paths for which this cookie is valid (optional)
2266 # -domain -> internet domain in which this cookie is valid (optional)
2267 # -secure -> if true, cookie only passed through secure channel (optional)
2268 # -expires -> expiry date in format Wdy, DD-Mon-YYYY HH:MM:SS GMT (optional)
2270 'cookie' => <<'END_OF_FUNC',
2272 my($self,@p) = self_or_default(@_);
2273 my($name,$value,$path,$domain,$secure,$expires) =
2274 rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES],@p);
2276 require CGI::Cookie;
2278 # if no value is supplied, then we retrieve the
2279 # value of the cookie, if any. For efficiency, we cache the parsed
2280 # cookies in our state variables.
2281 unless ( defined($value) ) {
2282 $self->{'.cookies'} = CGI::Cookie->fetch
2283 unless $self->{'.cookies'};
2285 # If no name is supplied, then retrieve the names of all our cookies.
2286 return () unless $self->{'.cookies'};
2287 return keys %{$self->{'.cookies'}} unless $name;
2288 return () unless $self->{'.cookies'}->{$name};
2289 return $self->{'.cookies'}->{$name}->value if defined($name) && $name ne '';
2292 # If we get here, we're creating a new cookie
2293 return undef unless $name; # this is an error
2296 push(@param,'-name'=>$name);
2297 push(@param,'-value'=>$value);
2298 push(@param,'-domain'=>$domain) if $domain;
2299 push(@param,'-path'=>$path) if $path;
2300 push(@param,'-expires'=>$expires) if $expires;
2301 push(@param,'-secure'=>$secure) if $secure;
2303 return new CGI::Cookie(@param);
2307 'parse_keywordlist' => <<'END_OF_FUNC',
2308 sub parse_keywordlist {
2309 my($self,$tosplit) = @_;
2310 $tosplit = unescape($tosplit); # unescape the keywords
2311 $tosplit=~tr/+/ /; # pluses to spaces
2312 my(@keywords) = split(/\s+/,$tosplit);
2317 'param_fetch' => <<'END_OF_FUNC',
2319 my($self,@p) = self_or_default(@_);
2320 my($name) = rearrange([NAME],@p);
2321 unless (exists($self->{$name})) {
2322 $self->add_parameter($name);
2323 $self->{$name} = [];
2326 return $self->{$name};
2330 ###############################################
2331 # OTHER INFORMATION PROVIDED BY THE ENVIRONMENT
2332 ###############################################
2334 #### Method: path_info
2335 # Return the extra virtual path information provided
2336 # after the URL (if any)
2338 'path_info' => <<'END_OF_FUNC',
2340 my ($self,$info) = self_or_default(@_);
2341 if (defined($info)) {
2342 $info = "/$info" if $info ne '' && substr($info,0,1) ne '/';
2343 $self->{'.path_info'} = $info;
2344 } elsif (! defined($self->{'.path_info'}) ) {
2345 $self->{'.path_info'} = defined($ENV{'PATH_INFO'}) ?
2346 $ENV{'PATH_INFO'} : '';
2348 # hack to fix broken path info in IIS
2349 $self->{'.path_info'} =~ s/^\Q$ENV{'SCRIPT_NAME'}\E// if $IIS;
2352 return $self->{'.path_info'};
2357 #### Method: request_method
2358 # Returns 'POST', 'GET', 'PUT' or 'HEAD'
2360 'request_method' => <<'END_OF_FUNC',
2361 sub request_method {
2362 return $ENV{'REQUEST_METHOD'};
2366 #### Method: content_type
2367 # Returns the content_type string
2369 'content_type' => <<'END_OF_FUNC',
2371 return $ENV{'CONTENT_TYPE'};
2375 #### Method: path_translated
2376 # Return the physical path information provided
2377 # by the URL (if any)
2379 'path_translated' => <<'END_OF_FUNC',
2380 sub path_translated {
2381 return $ENV{'PATH_TRANSLATED'};
2386 #### Method: query_string
2387 # Synthesize a query string from our current
2390 'query_string' => <<'END_OF_FUNC',
2392 my($self) = self_or_default(@_);
2393 my($param,$value,@pairs);
2394 foreach $param ($self->param) {
2395 my($eparam) = escape($param);
2396 foreach $value ($self->param($param)) {
2397 $value = escape($value);
2398 next unless defined $value;
2399 push(@pairs,"$eparam=$value");
2402 return join($USE_PARAM_SEMICOLONS ? ';' : '&',@pairs);
2408 # Without parameters, returns an array of the
2409 # MIME types the browser accepts.
2410 # With a single parameter equal to a MIME
2411 # type, will return undef if the browser won't
2412 # accept it, 1 if the browser accepts it but
2413 # doesn't give a preference, or a floating point
2414 # value between 0.0 and 1.0 if the browser
2415 # declares a quantitative score for it.
2416 # This handles MIME type globs correctly.
2418 'Accept' => <<'END_OF_FUNC',
2420 my($self,$search) = self_or_CGI(@_);
2421 my(%prefs,$type,$pref,$pat);
2423 my(@accept) = split(',',$self->http('accept'));
2426 ($pref) = /q=(\d\.\d+|\d+)/;
2427 ($type) = m#(\S+/[^;]+)#;
2429 $prefs{$type}=$pref || 1;
2432 return keys %prefs unless $search;
2434 # if a search type is provided, we may need to
2435 # perform a pattern matching operation.
2436 # The MIME types use a glob mechanism, which
2437 # is easily translated into a perl pattern match
2439 # First return the preference for directly supported
2441 return $prefs{$search} if $prefs{$search};
2443 # Didn't get it, so try pattern matching.
2444 foreach (keys %prefs) {
2445 next unless /\*/; # not a pattern match
2446 ($pat = $_) =~ s/([^\w*])/\\$1/g; # escape meta characters
2447 $pat =~ s/\*/.*/g; # turn it into a pattern
2448 return $prefs{$_} if $search=~/$pat/;
2454 #### Method: user_agent
2455 # If called with no parameters, returns the user agent.
2456 # If called with one parameter, does a pattern match (case
2457 # insensitive) on the user agent.
2459 'user_agent' => <<'END_OF_FUNC',
2461 my($self,$match)=self_or_CGI(@_);
2462 return $self->http('user_agent') unless $match;
2463 return $self->http('user_agent') =~ /$match/i;
2468 #### Method: raw_cookie
2469 # Returns the magic cookies for the session.
2470 # The cookies are not parsed or altered in any way, i.e.
2471 # cookies are returned exactly as given in the HTTP
2472 # headers. If a cookie name is given, only that cookie's
2473 # value is returned, otherwise the entire raw cookie
2476 'raw_cookie' => <<'END_OF_FUNC',
2478 my($self,$key) = self_or_CGI(@_);
2480 require CGI::Cookie;
2482 if (defined($key)) {
2483 $self->{'.raw_cookies'} = CGI::Cookie->raw_fetch
2484 unless $self->{'.raw_cookies'};
2486 return () unless $self->{'.raw_cookies'};
2487 return () unless $self->{'.raw_cookies'}->{$key};
2488 return $self->{'.raw_cookies'}->{$key};
2490 return $self->http('cookie') || $ENV{'COOKIE'} || '';
2494 #### Method: virtual_host
2495 # Return the name of the virtual_host, which
2496 # is not always the same as the server
2498 'virtual_host' => <<'END_OF_FUNC',
2500 my $vh = http('host') || server_name();
2501 $vh =~ s/:\d+$//; # get rid of port number
2506 #### Method: remote_host
2507 # Return the name of the remote host, or its IP
2508 # address if unavailable. If this variable isn't
2509 # defined, it returns "localhost" for debugging
2512 'remote_host' => <<'END_OF_FUNC',
2514 return $ENV{'REMOTE_HOST'} || $ENV{'REMOTE_ADDR'}
2520 #### Method: remote_addr
2521 # Return the IP addr of the remote host.
2523 'remote_addr' => <<'END_OF_FUNC',
2525 return $ENV{'REMOTE_ADDR'} || '127.0.0.1';
2530 #### Method: script_name
2531 # Return the partial URL to this script for
2532 # self-referencing scripts. Also see
2533 # self_url(), which returns a URL with all state information
2536 'script_name' => <<'END_OF_FUNC',
2538 return $ENV{'SCRIPT_NAME'} if defined($ENV{'SCRIPT_NAME'});
2539 # These are for debugging
2540 return "/$0" unless $0=~/^\//;
2546 #### Method: referer
2547 # Return the HTTP_REFERER: useful for generating
2550 'referer' => <<'END_OF_FUNC',
2552 my($self) = self_or_CGI(@_);
2553 return $self->http('referer');
2558 #### Method: server_name
2559 # Return the name of the server
2561 'server_name' => <<'END_OF_FUNC',
2563 return $ENV{'SERVER_NAME'} || 'localhost';
2567 #### Method: server_software
2568 # Return the name of the server software
2570 'server_software' => <<'END_OF_FUNC',
2571 sub server_software {
2572 return $ENV{'SERVER_SOFTWARE'} || 'cmdline';
2576 #### Method: server_port
2577 # Return the tcp/ip port the server is running on
2579 'server_port' => <<'END_OF_FUNC',
2581 return $ENV{'SERVER_PORT'} || 80; # for debugging
2585 #### Method: server_protocol
2586 # Return the protocol (usually HTTP/1.0)
2588 'server_protocol' => <<'END_OF_FUNC',
2589 sub server_protocol {
2590 return $ENV{'SERVER_PROTOCOL'} || 'HTTP/1.0'; # for debugging
2595 # Return the value of an HTTP variable, or
2596 # the list of variables if none provided
2598 'http' => <<'END_OF_FUNC',
2600 my ($self,$parameter) = self_or_CGI(@_);
2601 return $ENV{$parameter} if $parameter=~/^HTTP/;
2602 $parameter =~ tr/-/_/;
2603 return $ENV{"HTTP_\U$parameter\E"} if $parameter;
2605 foreach (keys %ENV) {
2606 push(@p,$_) if /^HTTP/;
2613 # Return the value of HTTPS
2615 'https' => <<'END_OF_FUNC',
2618 my ($self,$parameter) = self_or_CGI(@_);
2619 return $ENV{HTTPS} unless $parameter;
2620 return $ENV{$parameter} if $parameter=~/^HTTPS/;
2621 $parameter =~ tr/-/_/;
2622 return $ENV{"HTTPS_\U$parameter\E"} if $parameter;
2624 foreach (keys %ENV) {
2625 push(@p,$_) if /^HTTPS/;
2631 #### Method: protocol
2632 # Return the protocol (http or https currently)
2634 'protocol' => <<'END_OF_FUNC',
2638 return 'https' if uc($self->https()) eq 'ON';
2639 return 'https' if $self->server_port == 443;
2640 my $prot = $self->server_protocol;
2641 my($protocol,$version) = split('/',$prot);
2642 return "\L$protocol\E";
2646 #### Method: remote_ident
2647 # Return the identity of the remote user
2648 # (but only if his host is running identd)
2650 'remote_ident' => <<'END_OF_FUNC',
2652 return $ENV{'REMOTE_IDENT'};
2657 #### Method: auth_type
2658 # Return the type of use verification/authorization in use, if any.
2660 'auth_type' => <<'END_OF_FUNC',
2662 return $ENV{'AUTH_TYPE'};
2667 #### Method: remote_user
2668 # Return the authorization name used for user
2671 'remote_user' => <<'END_OF_FUNC',
2673 return $ENV{'REMOTE_USER'};
2678 #### Method: user_name
2679 # Try to return the remote user's name by hook or by
2682 'user_name' => <<'END_OF_FUNC',
2684 my ($self) = self_or_CGI(@_);
2685 return $self->http('from') || $ENV{'REMOTE_IDENT'} || $ENV{'REMOTE_USER'};
2689 #### Method: nosticky
2690 # Set or return the NOSTICKY global flag
2692 'nosticky' => <<'END_OF_FUNC',
2694 my ($self,$param) = self_or_CGI(@_);
2695 $CGI::NOSTICKY = $param if defined($param);
2696 return $CGI::NOSTICKY;
2701 # Set or return the NPH global flag
2703 'nph' => <<'END_OF_FUNC',
2705 my ($self,$param) = self_or_CGI(@_);
2706 $CGI::NPH = $param if defined($param);
2711 #### Method: private_tempfiles
2712 # Set or return the private_tempfiles global flag
2714 'private_tempfiles' => <<'END_OF_FUNC',
2715 sub private_tempfiles {
2716 my ($self,$param) = self_or_CGI(@_);
2717 $CGI::PRIVATE_TEMPFILES = $param if defined($param);
2718 return $CGI::PRIVATE_TEMPFILES;
2722 #### Method: default_dtd
2723 # Set or return the default_dtd global
2725 'default_dtd' => <<'END_OF_FUNC',
2727 my ($self,$param,$param2) = self_or_CGI(@_);
2728 if (defined $param2 && defined $param) {
2729 $CGI::DEFAULT_DTD = [ $param, $param2 ];
2730 } elsif (defined $param) {
2731 $CGI::DEFAULT_DTD = $param;
2733 return $CGI::DEFAULT_DTD;
2737 # -------------- really private subroutines -----------------
2738 'previous_or_default' => <<'END_OF_FUNC',
2739 sub previous_or_default {
2740 my($self,$name,$defaults,$override) = @_;
2743 if (!$override && ($self->{'.fieldnames'}->{$name} ||
2744 defined($self->param($name)) ) ) {
2745 grep($selected{$_}++,$self->param($name));
2746 } elsif (defined($defaults) && ref($defaults) &&
2747 (ref($defaults) eq 'ARRAY')) {
2748 grep($selected{$_}++,@{$defaults});
2750 $selected{$defaults}++ if defined($defaults);
2757 'register_parameter' => <<'END_OF_FUNC',
2758 sub register_parameter {
2759 my($self,$param) = @_;
2760 $self->{'.parametersToAdd'}->{$param}++;
2764 'get_fields' => <<'END_OF_FUNC',
2767 return $self->CGI::hidden('-name'=>'.cgifields',
2768 '-values'=>[keys %{$self->{'.parametersToAdd'}}],
2773 'read_from_cmdline' => <<'END_OF_FUNC',
2774 sub read_from_cmdline {
2777 if ($DEBUG && @ARGV) {
2779 } elsif ($DEBUG > 1) {
2780 require "shellwords.pl";
2781 print STDERR "(offline mode: enter name=value pairs on standard input)\n";
2782 chomp(@lines = <STDIN>); # remove newlines
2783 $input = join(" ",@lines);
2784 @words = &shellwords($input);
2791 if ("@words"=~/=/) {
2792 $query_string = join('&',@words);
2794 $query_string = join('+',@words);
2796 return $query_string;
2801 # subroutine: read_multipart
2803 # Read multipart data and store it into our parameters.
2804 # An interesting feature is that if any of the parts is a file, we
2805 # create a temporary file and open up a filehandle on it so that the
2806 # caller can read from it if necessary.
2808 'read_multipart' => <<'END_OF_FUNC',
2809 sub read_multipart {
2810 my($self,$boundary,$length,$filehandle) = @_;
2811 my($buffer) = $self->new_MultipartBuffer($boundary,$length,$filehandle);
2812 return unless $buffer;
2815 while (!$buffer->eof) {
2816 %header = $buffer->readHeader;
2819 $self->cgi_error("400 Bad request (malformed multipart POST)");
2823 my($param)= $header{'Content-Disposition'}=~/ name="?([^\";]*)"?/;
2825 # Bug: Netscape doesn't escape quotation marks in file names!!!
2826 my($filename) = $header{'Content-Disposition'}=~/ filename="?([^\"]*)"?/;
2828 # add this parameter to our list
2829 $self->add_parameter($param);
2831 # If no filename specified, then just read the data and assign it
2832 # to our parameter list.
2833 if ( !defined($filename) || $filename eq '' ) {
2834 my($value) = $buffer->readBody;
2835 push(@{$self->{$param}},$value);
2839 my ($tmpfile,$tmp,$filehandle);
2841 # If we get here, then we are dealing with a potentially large
2842 # uploaded form. Save the data to a temporary file, then open
2843 # the file for reading.
2845 # skip the file if uploads disabled
2846 if ($DISABLE_UPLOADS) {
2847 while (defined($data = $buffer->read)) { }
2851 # choose a relatively unpredictable tmpfile sequence number
2852 my $seqno = unpack("%16C*",join('',localtime,values %ENV));
2853 for (my $cnt=10;$cnt>0;$cnt--) {
2854 next unless $tmpfile = new TempFile($seqno);
2855 $tmp = $tmpfile->as_string;
2856 last if defined($filehandle = Fh->new($filename,$tmp,$PRIVATE_TEMPFILES));
2857 $seqno += int rand(100);
2859 die "CGI open of tmpfile: $!\n" unless $filehandle;
2860 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
2864 while (defined($data = $buffer->read)) {
2865 print $filehandle $data;
2868 # back up to beginning of file
2869 seek($filehandle,0,0);
2870 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
2872 # Save some information about the uploaded file where we can get
2874 $self->{'.tmpfiles'}->{fileno($filehandle)}= {
2878 push(@{$self->{$param}},$filehandle);
2884 'upload' =><<'END_OF_FUNC',
2886 my($self,$param_name) = self_or_default(@_);
2887 my $param = $self->param($param_name);
2888 return unless $param;
2889 return unless ref($param) && fileno($param);
2894 'tmpFileName' => <<'END_OF_FUNC',
2896 my($self,$filename) = self_or_default(@_);
2897 return $self->{'.tmpfiles'}->{fileno($filename)}->{name} ?
2898 $self->{'.tmpfiles'}->{fileno($filename)}->{name}->as_string
2903 'uploadInfo' => <<'END_OF_FUNC',
2905 my($self,$filename) = self_or_default(@_);
2906 return $self->{'.tmpfiles'}->{fileno($filename)}->{info};
2910 # internal routine, don't use
2911 '_set_values_and_labels' => <<'END_OF_FUNC',
2912 sub _set_values_and_labels {
2915 $$l = $v if ref($v) eq 'HASH' && !ref($$l);
2916 return $self->param($n) if !defined($v);
2917 return $v if !ref($v);
2918 return ref($v) eq 'HASH' ? keys %$v : @$v;
2922 '_compile_all' => <<'END_OF_FUNC',
2925 next if defined(&$_);
2926 $AUTOLOAD = "CGI::$_";
2936 #########################################################
2937 # Globals and stubs for other packages that we use.
2938 #########################################################
2940 ################### Fh -- lightweight filehandle ###############
2949 *Fh::AUTOLOAD = \&CGI::AUTOLOAD;
2951 $AUTOLOADED_ROUTINES = ''; # prevent -w error
2952 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
2954 'asString' => <<'END_OF_FUNC',
2957 # get rid of package name
2958 (my $i = $$self) =~ s/^\*(\w+::fh\d{5})+//;
2962 # This was an extremely clever patch that allowed "use strict refs".
2963 # Unfortunately it relied on another bug that caused leaky file descriptors.
2964 # The underlying bug has been fixed, so this no longer works. However
2965 # "strict refs" still works for some reason.
2967 # return ${*{$self}{SCALAR}};
2972 'compare' => <<'END_OF_FUNC',
2976 return "$self" cmp $value;
2980 'new' => <<'END_OF_FUNC',
2982 my($pack,$name,$file,$delete) = @_;
2983 require Fcntl unless defined &Fcntl::O_RDWR;
2984 my $fv = ++$FH . quotemeta($name);
2985 warn unless *{"Fh::$fv"};
2986 my $ref = \*{"Fh::$fv"};
2987 sysopen($ref,$file,Fcntl::O_RDWR()|Fcntl::O_CREAT()|Fcntl::O_EXCL(),0600) || return;
2988 unlink($file) if $delete;
2989 CORE::delete $Fh::{$fv};
2990 return bless $ref,$pack;
2994 'DESTROY' => <<'END_OF_FUNC',
3004 ######################## MultipartBuffer ####################
3005 package MultipartBuffer;
3007 # how many bytes to read at a time. We use
3008 # a 4K buffer by default.
3009 $INITIAL_FILLUNIT = 1024 * 4;
3010 $TIMEOUT = 240*60; # 4 hour timeout for big files
3011 $SPIN_LOOP_MAX = 2000; # bug fix for some Netscape servers
3014 #reuse the autoload function
3015 *MultipartBuffer::AUTOLOAD = \&CGI::AUTOLOAD;
3017 # avoid autoloader warnings
3020 ###############################################################################
3021 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
3022 ###############################################################################
3023 $AUTOLOADED_ROUTINES = ''; # prevent -w error
3024 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3027 'new' => <<'END_OF_FUNC',
3029 my($package,$interface,$boundary,$length,$filehandle) = @_;
3030 $FILLUNIT = $INITIAL_FILLUNIT;
3033 my($package) = caller;
3034 # force into caller's package if necessary
3035 $IN = $filehandle=~/[':]/ ? $filehandle : "$package\:\:$filehandle";
3037 $IN = "main::STDIN" unless $IN;
3039 $CGI::DefaultClass->binmode($IN) if $CGI::needs_binmode;
3041 # If the user types garbage into the file upload field,
3042 # then Netscape passes NOTHING to the server (not good).
3043 # We may hang on this read in that case. So we implement
3044 # a read timeout. If nothing is ready to read
3045 # by then, we return.
3047 # Netscape seems to be a little bit unreliable
3048 # about providing boundary strings.
3049 my $boundary_read = 0;
3052 # Under the MIME spec, the boundary consists of the
3053 # characters "--" PLUS the Boundary string
3055 # BUG: IE 3.01 on the Macintosh uses just the boundary -- not
3056 # the two extra hyphens. We do a special case here on the user-agent!!!!
3057 $boundary = "--$boundary" unless CGI::user_agent('MSIE\s+3\.0[12];\s*Mac');
3059 } else { # otherwise we find it ourselves
3061 ($old,$/) = ($/,$CRLF); # read a CRLF-delimited line
3062 $boundary = <$IN>; # BUG: This won't work correctly under mod_perl
3063 $length -= length($boundary);
3064 chomp($boundary); # remove the CRLF
3065 $/ = $old; # restore old line separator
3069 my $self = {LENGTH=>$length,
3070 BOUNDARY=>$boundary,
3072 INTERFACE=>$interface,
3076 $FILLUNIT = length($boundary)
3077 if length($boundary) > $FILLUNIT;
3079 my $retval = bless $self,ref $package || $package;
3081 # Read the preamble and the topmost (boundary) line plus the CRLF.
3082 unless ($boundary_read) {
3083 while ($self->read(0)) { }
3085 die "Malformed multipart POST\n" if $self->eof;
3091 'readHeader' => <<'END_OF_FUNC',
3098 local($CRLF) = "\015\012" if $CGI::OS eq 'VMS';
3101 $self->fillBuffer($FILLUNIT);
3102 $ok++ if ($end = index($self->{BUFFER},"${CRLF}${CRLF}")) >= 0;
3103 $ok++ if $self->{BUFFER} eq '';
3104 $bad++ if !$ok && $self->{LENGTH} <= 0;
3105 # this was a bad idea
3106 # $FILLUNIT *= 2 if length($self->{BUFFER}) >= $FILLUNIT;
3107 } until $ok || $bad;
3110 my($header) = substr($self->{BUFFER},0,$end+2);
3111 substr($self->{BUFFER},0,$end+4) = '';
3115 # See RFC 2045 Appendix A and RFC 822 sections 3.4.8
3116 # (Folding Long Header Fields), 3.4.3 (Comments)
3117 # and 3.4.5 (Quoted-Strings).
3119 my $token = '[-\w!\#$%&\'*+.^_\`|{}~]';
3120 $header=~s/$CRLF\s+/ /og; # merge continuation lines
3121 while ($header=~/($token+):\s+([^$CRLF]*)/mgox) {
3122 my ($field_name,$field_value) = ($1,$2); # avoid taintedness
3123 $field_name =~ s/\b(\w)/uc($1)/eg; #canonicalize
3124 $return{$field_name}=$field_value;
3130 # This reads and returns the body as a single scalar value.
3131 'readBody' => <<'END_OF_FUNC',
3136 while (defined($data = $self->read)) {
3137 $returnval .= $data;
3143 # This will read $bytes or until the boundary is hit, whichever happens
3144 # first. After the boundary is hit, we return undef. The next read will
3145 # skip over the boundary and begin reading again;
3146 'read' => <<'END_OF_FUNC',
3148 my($self,$bytes) = @_;
3150 # default number of bytes to read
3151 $bytes = $bytes || $FILLUNIT;
3153 # Fill up our internal buffer in such a way that the boundary
3154 # is never split between reads.
3155 $self->fillBuffer($bytes);
3157 # Find the boundary in the buffer (it may not be there).
3158 my $start = index($self->{BUFFER},$self->{BOUNDARY});
3159 # protect against malformed multipart POST operations
3160 die "Malformed multipart POST\n" unless ($start >= 0) || ($self->{LENGTH} > 0);
3162 # If the boundary begins the data, then skip past it
3163 # and return undef. The +2 here is a fiendish plot to
3164 # remove the CR/LF pair at the end of the boundary.
3167 # clear us out completely if we've hit the last boundary.
3168 if (index($self->{BUFFER},"$self->{BOUNDARY}--")==0) {
3174 # just remove the boundary.
3175 substr($self->{BUFFER},0,length($self->{BOUNDARY})+2)='';
3180 if ($start > 0) { # read up to the boundary
3181 $bytesToReturn = $start > $bytes ? $bytes : $start;
3182 } else { # read the requested number of bytes
3183 # leave enough bytes in the buffer to allow us to read
3184 # the boundary. Thanks to Kevin Hendrick for finding
3186 $bytesToReturn = $bytes - (length($self->{BOUNDARY})+1);
3189 my $returnval=substr($self->{BUFFER},0,$bytesToReturn);
3190 substr($self->{BUFFER},0,$bytesToReturn)='';
3192 # If we hit the boundary, remove the CRLF from the end.
3193 return ($start > 0) ? substr($returnval,0,-2) : $returnval;
3198 # This fills up our internal buffer in such a way that the
3199 # boundary is never split between reads
3200 'fillBuffer' => <<'END_OF_FUNC',
3202 my($self,$bytes) = @_;
3203 return unless $self->{LENGTH};
3205 my($boundaryLength) = length($self->{BOUNDARY});
3206 my($bufferLength) = length($self->{BUFFER});
3207 my($bytesToRead) = $bytes - $bufferLength + $boundaryLength + 2;
3208 $bytesToRead = $self->{LENGTH} if $self->{LENGTH} < $bytesToRead;
3210 # Try to read some data. We may hang here if the browser is screwed up.
3211 my $bytesRead = $self->{INTERFACE}->read_from_client($self->{IN},
3215 $self->{BUFFER} = '' unless defined $self->{BUFFER};
3217 # An apparent bug in the Apache server causes the read()
3218 # to return zero bytes repeatedly without blocking if the
3219 # remote user aborts during a file transfer. I don't know how
3220 # they manage this, but the workaround is to abort if we get
3221 # more than SPIN_LOOP_MAX consecutive zero reads.
3222 if ($bytesRead == 0) {
3223 die "CGI.pm: Server closed socket during multipart read (client aborted?).\n"
3224 if ($self->{ZERO_LOOP_COUNTER}++ >= $SPIN_LOOP_MAX);
3226 $self->{ZERO_LOOP_COUNTER}=0;
3229 $self->{LENGTH} -= $bytesRead;
3234 # Return true when we've finished reading
3235 'eof' => <<'END_OF_FUNC'
3238 return 1 if (length($self->{BUFFER}) == 0)
3239 && ($self->{LENGTH} <= 0);
3247 ####################################################################################
3248 ################################## TEMPORARY FILES #################################
3249 ####################################################################################
3253 $MAC = $CGI::OS eq 'MACINTOSH';
3254 my ($vol) = $MAC ? MacPerl::Volumes() =~ /:(.*)/ : "";
3255 unless ($TMPDIRECTORY) {
3256 @TEMP=("${SL}usr${SL}tmp","${SL}var${SL}tmp",
3257 "C:${SL}temp","${SL}tmp","${SL}temp",
3258 "${vol}${SL}Temporary Items",
3259 "${SL}WWW_ROOT", "${SL}SYS\$SCRATCH");
3260 unshift(@TEMP,$ENV{'TMPDIR'}) if exists $ENV{'TMPDIR'};
3262 # this feature was supposed to provide per-user tmpfiles, but
3263 # it is problematic.
3264 # unshift(@TEMP,(getpwuid($<))[7].'/tmp') if $CGI::OS eq 'UNIX';
3265 # Rob: getpwuid() is unfortunately UNIX specific. On brain dead OS'es this
3266 # : can generate a 'getpwuid() not implemented' exception, even though
3267 # : it's never called. Found under DOS/Win with the DJGPP perl port.
3268 # : Refer to getpwuid() only at run-time if we're fortunate and have UNIX.
3269 # unshift(@TEMP,(eval {(getpwuid($>))[7]}).'/tmp') if $CGI::OS eq 'UNIX' and $> != 0;
3272 do {$TMPDIRECTORY = $_; last} if -d $_ && -w _;
3276 $TMPDIRECTORY = $MAC ? "" : "." unless $TMPDIRECTORY;
3279 # cute feature, but overload implementation broke it
3280 # %OVERLOAD = ('""'=>'as_string');
3281 *TempFile::AUTOLOAD = \&CGI::AUTOLOAD;
3283 ###############################################################################
3284 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
3285 ###############################################################################
3286 $AUTOLOADED_ROUTINES = ''; # prevent -w error
3287 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3290 'new' => <<'END_OF_FUNC',
3292 my($package,$sequence) = @_;
3294 for (my $i = 0; $i < $MAXTRIES; $i++) {
3295 last if ! -f ($filename = sprintf("${TMPDIRECTORY}${SL}CGItemp%d",$sequence++));
3297 # untaint the darn thing
3298 return unless $filename =~ m!^([a-zA-Z0-9_ '":/.\$\\]+)$!;
3300 return bless \$filename;
3304 'DESTROY' => <<'END_OF_FUNC',
3307 unlink $$self; # get rid of the file
3311 'as_string' => <<'END_OF_FUNC'
3323 # We get a whole bunch of warnings about "possibly uninitialized variables"
3324 # when running with the -w switch. Touch them all once to get rid of the
3325 # warnings. This is ugly and I hate it.
3330 $MultipartBuffer::SPIN_LOOP_MAX;
3331 $MultipartBuffer::CRLF;
3332 $MultipartBuffer::TIMEOUT;
3333 $MultipartBuffer::INITIAL_FILLUNIT;
3344 CGI - Simple Common Gateway Interface Class
3348 # CGI script that creates a fill-out form
3349 # and echoes back its values.
3351 use CGI qw/:standard/;
3353 start_html('A Simple Example'),
3354 h1('A Simple Example'),
3356 "What's your name? ",textfield('name'),p,
3357 "What's the combination?", p,
3358 checkbox_group(-name=>'words',
3359 -values=>['eenie','meenie','minie','moe'],
3360 -defaults=>['eenie','minie']), p,
3361 "What's your favorite color? ",
3362 popup_menu(-name=>'color',
3363 -values=>['red','green','blue','chartreuse']),p,
3369 print "Your name is",em(param('name')),p,
3370 "The keywords are: ",em(join(", ",param('words'))),p,
3371 "Your favorite color is ",em(param('color')),
3377 This perl library uses perl5 objects to make it easy to create Web
3378 fill-out forms and parse their contents. This package defines CGI
3379 objects, entities that contain the values of the current query string
3380 and other state variables. Using a CGI object's methods, you can
3381 examine keywords and parameters passed to your script, and create
3382 forms whose initial values are taken from the current query (thereby
3383 preserving state information). The module provides shortcut functions
3384 that produce boilerplate HTML, reducing typing and coding errors. It
3385 also provides functionality for some of the more advanced features of
3386 CGI scripting, including support for file uploads, cookies, cascading
3387 style sheets, server push, and frames.
3389 CGI.pm also provides a simple function-oriented programming style for
3390 those who don't need its object-oriented features.
3392 The current version of CGI.pm is available at
3394 http://www.genome.wi.mit.edu/ftp/pub/software/WWW/cgi_docs.html
3395 ftp://ftp-genome.wi.mit.edu/pub/software/WWW/
3399 =head2 PROGRAMMING STYLE
3401 There are two styles of programming with CGI.pm, an object-oriented
3402 style and a function-oriented style. In the object-oriented style you
3403 create one or more CGI objects and then use object methods to create
3404 the various elements of the page. Each CGI object starts out with the
3405 list of named parameters that were passed to your CGI script by the
3406 server. You can modify the objects, save them to a file or database
3407 and recreate them. Because each object corresponds to the "state" of
3408 the CGI script, and because each object's parameter list is
3409 independent of the others, this allows you to save the state of the
3410 script and restore it later.
3412 For example, using the object oriented style, here is how you create
3413 a simple "Hello World" HTML page:
3415 #!/usr/local/bin/perl -w
3416 use CGI; # load CGI routines
3417 $q = new CGI; # create new CGI object
3418 print $q->header, # create the HTTP header
3419 $q->start_html('hello world'), # start the HTML
3420 $q->h1('hello world'), # level 1 header
3421 $q->end_html; # end the HTML
3423 In the function-oriented style, there is one default CGI object that
3424 you rarely deal with directly. Instead you just call functions to
3425 retrieve CGI parameters, create HTML tags, manage cookies, and so
3426 on. This provides you with a cleaner programming interface, but
3427 limits you to using one CGI object at a time. The following example
3428 prints the same page, but uses the function-oriented interface.
3429 The main differences are that we now need to import a set of functions
3430 into our name space (usually the "standard" functions), and we don't
3431 need to create the CGI object.
3433 #!/usr/local/bin/perl
3434 use CGI qw/:standard/; # load standard CGI routines
3435 print header, # create the HTTP header
3436 start_html('hello world'), # start the HTML
3437 h1('hello world'), # level 1 header
3438 end_html; # end the HTML
3440 The examples in this document mainly use the object-oriented style.
3441 See HOW TO IMPORT FUNCTIONS for important information on
3442 function-oriented programming in CGI.pm
3444 =head2 CALLING CGI.PM ROUTINES
3446 Most CGI.pm routines accept several arguments, sometimes as many as 20
3447 optional ones! To simplify this interface, all routines use a named
3448 argument calling style that looks like this:
3450 print $q->header(-type=>'image/gif',-expires=>'+3d');
3452 Each argument name is preceded by a dash. Neither case nor order
3453 matters in the argument list. -type, -Type, and -TYPE are all
3454 acceptable. In fact, only the first argument needs to begin with a
3455 dash. If a dash is present in the first argument, CGI.pm assumes
3456 dashes for the subsequent ones.
3458 Several routines are commonly called with just one argument. In the
3459 case of these routines you can provide the single argument without an
3460 argument name. header() happens to be one of these routines. In this
3461 case, the single argument is the document type.
3463 print $q->header('text/html');
3465 Other such routines are documented below.
3467 Sometimes named arguments expect a scalar, sometimes a reference to an
3468 array, and sometimes a reference to a hash. Often, you can pass any
3469 type of argument and the routine will do whatever is most appropriate.
3470 For example, the param() routine is used to set a CGI parameter to a
3471 single or a multi-valued value. The two cases are shown below:
3473 $q->param(-name=>'veggie',-value=>'tomato');
3474 $q->param(-name=>'veggie',-value=>['tomato','tomahto','potato','potahto']);
3476 A large number of routines in CGI.pm actually aren't specifically
3477 defined in the module, but are generated automatically as needed.
3478 These are the "HTML shortcuts," routines that generate HTML tags for
3479 use in dynamically-generated pages. HTML tags have both attributes
3480 (the attribute="value" pairs within the tag itself) and contents (the
3481 part between the opening and closing pairs.) To distinguish between
3482 attributes and contents, CGI.pm uses the convention of passing HTML
3483 attributes as a hash reference as the first argument, and the
3484 contents, if any, as any subsequent arguments. It works out like
3490 h1('some','contents'); <H1>some contents</H1>
3491 h1({-align=>left}); <H1 ALIGN="LEFT">
3492 h1({-align=>left},'contents'); <H1 ALIGN="LEFT">contents</H1>
3494 HTML tags are described in more detail later.
3496 Many newcomers to CGI.pm are puzzled by the difference between the
3497 calling conventions for the HTML shortcuts, which require curly braces
3498 around the HTML tag attributes, and the calling conventions for other
3499 routines, which manage to generate attributes without the curly
3500 brackets. Don't be confused. As a convenience the curly braces are
3501 optional in all but the HTML shortcuts. If you like, you can use
3502 curly braces when calling any routine that takes named arguments. For
3505 print $q->header( {-type=>'image/gif',-expires=>'+3d'} );
3507 If you use the B<-w> switch, you will be warned that some CGI.pm argument
3508 names conflict with built-in Perl functions. The most frequent of
3509 these is the -values argument, used to create multi-valued menus,
3510 radio button clusters and the like. To get around this warning, you
3511 have several choices:
3515 =item 1. Use another name for the argument, if one is available. For
3516 example, -value is an alias for -values.
3518 =item 2. Change the capitalization, e.g. -Values
3520 =item 3. Put quotes around the argument name, e.g. '-values'
3524 Many routines will do something useful with a named argument that it
3525 doesn't recognize. For example, you can produce non-standard HTTP
3526 header fields by providing them as named arguments:
3528 print $q->header(-type => 'text/html',
3529 -cost => 'Three smackers',
3530 -annoyance_level => 'high',
3531 -complaints_to => 'bit bucket');
3533 This will produce the following nonstandard HTTP header:
3536 Cost: Three smackers
3537 Annoyance-level: high
3538 Complaints-to: bit bucket
3539 Content-type: text/html
3541 Notice the way that underscores are translated automatically into
3542 hyphens. HTML-generating routines perform a different type of
3545 This feature allows you to keep up with the rapidly changing HTTP and
3548 =head2 CREATING A NEW QUERY OBJECT (OBJECT-ORIENTED STYLE):
3552 This will parse the input (from both POST and GET methods) and store
3553 it into a perl5 object called $query.
3555 =head2 CREATING A NEW QUERY OBJECT FROM AN INPUT FILE
3557 $query = new CGI(INPUTFILE);
3559 If you provide a file handle to the new() method, it will read
3560 parameters from the file (or STDIN, or whatever). The file can be in
3561 any of the forms describing below under debugging (i.e. a series of
3562 newline delimited TAG=VALUE pairs will work). Conveniently, this type
3563 of file is created by the save() method (see below). Multiple records
3564 can be saved and restored.
3566 Perl purists will be pleased to know that this syntax accepts
3567 references to file handles, or even references to filehandle globs,
3568 which is the "official" way to pass a filehandle:
3570 $query = new CGI(\*STDIN);
3572 You can also initialize the CGI object with a FileHandle or IO::File
3575 If you are using the function-oriented interface and want to
3576 initialize CGI state from a file handle, the way to do this is with
3577 B<restore_parameters()>. This will (re)initialize the
3578 default CGI object from the indicated file handle.
3580 open (IN,"test.in") || die;
3581 restore_parameters(IN);
3584 You can also initialize the query object from an associative array
3587 $query = new CGI( {'dinosaur'=>'barney',
3588 'song'=>'I love you',
3589 'friends'=>[qw/Jessica George Nancy/]}
3592 or from a properly formatted, URL-escaped query string:
3594 $query = new CGI('dinosaur=barney&color=purple');
3596 or from a previously existing CGI object (currently this clones the
3597 parameter list, but none of the other object-specific fields, such as
3600 $old_query = new CGI;
3601 $new_query = new CGI($old_query);
3603 To create an empty query, initialize it from an empty string or hash:
3605 $empty_query = new CGI("");
3609 $empty_query = new CGI({});
3611 =head2 FETCHING A LIST OF KEYWORDS FROM THE QUERY:
3613 @keywords = $query->keywords
3615 If the script was invoked as the result of an <ISINDEX> search, the
3616 parsed keywords can be obtained as an array using the keywords() method.
3618 =head2 FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT:
3620 @names = $query->param
3622 If the script was invoked with a parameter list
3623 (e.g. "name1=value1&name2=value2&name3=value3"), the param() method
3624 will return the parameter names as a list. If the script was invoked
3625 as an <ISINDEX> script and contains a string without ampersands
3626 (e.g. "value1+value2+value3") , there will be a single parameter named
3627 "keywords" containing the "+"-delimited keywords.
3629 NOTE: As of version 1.5, the array of parameter names returned will
3630 be in the same order as they were submitted by the browser.
3631 Usually this order is the same as the order in which the
3632 parameters are defined in the form (however, this isn't part
3633 of the spec, and so isn't guaranteed).
3635 =head2 FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER:
3637 @values = $query->param('foo');
3641 $value = $query->param('foo');
3643 Pass the param() method a single argument to fetch the value of the
3644 named parameter. If the parameter is multivalued (e.g. from multiple
3645 selections in a scrolling list), you can ask to receive an array. Otherwise
3646 the method will return a single value.
3648 If a value is not given in the query string, as in the queries
3649 "name1=&name2=" or "name1&name2", it will be returned as an empty
3650 string. This feature is new in 2.63.
3652 =head2 SETTING THE VALUE(S) OF A NAMED PARAMETER:
3654 $query->param('foo','an','array','of','values');
3656 This sets the value for the named parameter 'foo' to an array of
3657 values. This is one way to change the value of a field AFTER
3658 the script has been invoked once before. (Another way is with
3659 the -override parameter accepted by all methods that generate
3662 param() also recognizes a named parameter style of calling described
3663 in more detail later:
3665 $query->param(-name=>'foo',-values=>['an','array','of','values']);
3669 $query->param(-name=>'foo',-value=>'the value');
3671 =head2 APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER:
3673 $query->append(-name=>'foo',-values=>['yet','more','values']);
3675 This adds a value or list of values to the named parameter. The
3676 values are appended to the end of the parameter if it already exists.
3677 Otherwise the parameter is created. Note that this method only
3678 recognizes the named argument calling syntax.
3680 =head2 IMPORTING ALL PARAMETERS INTO A NAMESPACE:
3682 $query->import_names('R');
3684 This creates a series of variables in the 'R' namespace. For example,
3685 $R::foo, @R:foo. For keyword lists, a variable @R::keywords will appear.
3686 If no namespace is given, this method will assume 'Q'.
3687 WARNING: don't import anything into 'main'; this is a major security
3690 In older versions, this method was called B<import()>. As of version 2.20,
3691 this name has been removed completely to avoid conflict with the built-in
3692 Perl module B<import> operator.
3694 =head2 DELETING A PARAMETER COMPLETELY:
3696 $query->delete('foo');
3698 This completely clears a parameter. It sometimes useful for
3699 resetting parameters that you don't want passed down between
3702 If you are using the function call interface, use "Delete()" instead
3703 to avoid conflicts with Perl's built-in delete operator.
3705 =head2 DELETING ALL PARAMETERS:
3707 $query->delete_all();
3709 This clears the CGI object completely. It might be useful to ensure
3710 that all the defaults are taken when you create a fill-out form.
3712 Use Delete_all() instead if you are using the function call interface.
3714 =head2 DIRECT ACCESS TO THE PARAMETER LIST:
3716 $q->param_fetch('address')->[1] = '1313 Mockingbird Lane';
3717 unshift @{$q->param_fetch(-name=>'address')},'George Munster';
3719 If you need access to the parameter list in a way that isn't covered
3720 by the methods above, you can obtain a direct reference to it by
3721 calling the B<param_fetch()> method with the name of the . This
3722 will return an array reference to the named parameters, which you then
3723 can manipulate in any way you like.
3725 You can also use a named argument style using the B<-name> argument.
3727 =head2 FETCHING THE PARAMETER LIST AS A HASH:
3730 print $params->{'address'};
3731 @foo = split("\0",$params->{'foo'});
3737 Many people want to fetch the entire parameter list as a hash in which
3738 the keys are the names of the CGI parameters, and the values are the
3739 parameters' values. The Vars() method does this. Called in a scalar
3740 context, it returns the parameter list as a tied hash reference.
3741 Changing a key changes the value of the parameter in the underlying
3742 CGI parameter list. Called in a list context, it returns the
3743 parameter list as an ordinary hash. This allows you to read the
3744 contents of the parameter list, but not to change it.
3746 When using this, the thing you must watch out for are multivalued CGI
3747 parameters. Because a hash cannot distinguish between scalar and
3748 list context, multivalued parameters will be returned as a packed
3749 string, separated by the "\0" (null) character. You must split this
3750 packed string in order to get at the individual values. This is the
3751 convention introduced long ago by Steve Brenner in his cgi-lib.pl
3752 module for Perl version 4.
3754 If you wish to use Vars() as a function, import the I<:cgi-lib> set of
3755 function calls (also see the section on CGI-LIB compatibility).
3757 =head2 SAVING THE STATE OF THE SCRIPT TO A FILE:
3759 $query->save(FILEHANDLE)
3761 This will write the current state of the form to the provided
3762 filehandle. You can read it back in by providing a filehandle
3763 to the new() method. Note that the filehandle can be a file, a pipe,
3766 The format of the saved file is:
3774 Both name and value are URL escaped. Multi-valued CGI parameters are
3775 represented as repeated names. A session record is delimited by a
3776 single = symbol. You can write out multiple records and read them
3777 back in with several calls to B<new>. You can do this across several
3778 sessions by opening the file in append mode, allowing you to create
3779 primitive guest books, or to keep a history of users' queries. Here's
3780 a short example of creating multiple session records:
3784 open (OUT,">>test.out") || die;
3786 foreach (0..$records) {
3788 $q->param(-name=>'counter',-value=>$_);
3793 # reopen for reading
3794 open (IN,"test.out") || die;
3796 my $q = new CGI(IN);
3797 print $q->param('counter'),"\n";
3800 The file format used for save/restore is identical to that used by the
3801 Whitehead Genome Center's data exchange format "Boulderio", and can be
3802 manipulated and even databased using Boulderio utilities. See
3804 http://stein.cshl.org/boulder/
3806 for further details.
3808 If you wish to use this method from the function-oriented (non-OO)
3809 interface, the exported name for this method is B<save_parameters()>.
3811 =head2 RETRIEVING CGI ERRORS
3813 Errors can occur while processing user input, particularly when
3814 processing uploaded files. When these errors occur, CGI will stop
3815 processing and return an empty parameter list. You can test for
3816 the existence and nature of errors using the I<cgi_error()> function.
3817 The error messages are formatted as HTTP status codes. You can either
3818 incorporate the error text into an HTML page, or use it as the value
3821 my $error = $q->cgi_error;
3823 print $q->header(-status=>$error),
3824 $q->start_html('Problems'),
3825 $q->h2('Request not processed'),
3830 When using the function-oriented interface (see the next section),
3831 errors may only occur the first time you call I<param()>. Be ready
3834 =head2 USING THE FUNCTION-ORIENTED INTERFACE
3836 To use the function-oriented interface, you must specify which CGI.pm
3837 routines or sets of routines to import into your script's namespace.
3838 There is a small overhead associated with this importation, but it
3841 use CGI <list of methods>;
3843 The listed methods will be imported into the current package; you can
3844 call them directly without creating a CGI object first. This example
3845 shows how to import the B<param()> and B<header()>
3846 methods, and then use them directly:
3848 use CGI 'param','header';
3849 print header('text/plain');
3850 $zipcode = param('zipcode');
3852 More frequently, you'll import common sets of functions by referring
3853 to the groups by name. All function sets are preceded with a ":"
3854 character as in ":html3" (for tags defined in the HTML 3 standard).
3856 Here is a list of the function sets you can import:
3862 Import all CGI-handling methods, such as B<param()>, B<path_info()>
3867 Import all fill-out form generating methods, such as B<textfield()>.
3871 Import all methods that generate HTML 2.0 standard elements.
3875 Import all methods that generate HTML 3.0 proposed elements (such as
3876 <table>, <super> and <sub>).
3880 Import all methods that generate Netscape-specific HTML extensions.
3884 Import all HTML-generating shortcuts (i.e. 'html2' + 'html3' +
3889 Import "standard" features, 'html2', 'html3', 'form' and 'cgi'.
3893 Import all the available methods. For the full list, see the CGI.pm
3894 code, where the variable %EXPORT_TAGS is defined.
3898 If you import a function name that is not part of CGI.pm, the module
3899 will treat it as a new HTML tag and generate the appropriate
3900 subroutine. You can then use it like any other HTML tag. This is to
3901 provide for the rapidly-evolving HTML "standard." For example, say
3902 Microsoft comes out with a new tag called <GRADIENT> (which causes the
3903 user's desktop to be flooded with a rotating gradient fill until his
3904 machine reboots). You don't need to wait for a new version of CGI.pm
3905 to start using it immediately:
3907 use CGI qw/:standard :html3 gradient/;
3908 print gradient({-start=>'red',-end=>'blue'});
3910 Note that in the interests of execution speed CGI.pm does B<not> use
3911 the standard L<Exporter> syntax for specifying load symbols. This may
3912 change in the future.
3914 If you import any of the state-maintaining CGI or form-generating
3915 methods, a default CGI object will be created and initialized
3916 automatically the first time you use any of the methods that require
3917 one to be present. This includes B<param()>, B<textfield()>,
3918 B<submit()> and the like. (If you need direct access to the CGI
3919 object, you can find it in the global variable B<$CGI::Q>). By
3920 importing CGI.pm methods, you can create visually elegant scripts:
3922 use CGI qw/:standard/;
3925 start_html('Simple Script'),
3926 h1('Simple Script'),
3928 "What's your name? ",textfield('name'),p,
3929 "What's the combination?",
3930 checkbox_group(-name=>'words',
3931 -values=>['eenie','meenie','minie','moe'],
3932 -defaults=>['eenie','moe']),p,
3933 "What's your favorite color?",
3934 popup_menu(-name=>'color',
3935 -values=>['red','green','blue','chartreuse']),p,
3942 "Your name is ",em(param('name')),p,
3943 "The keywords are: ",em(join(", ",param('words'))),p,
3944 "Your favorite color is ",em(param('color')),".\n";
3950 In addition to the function sets, there are a number of pragmas that
3951 you can import. Pragmas, which are always preceded by a hyphen,
3952 change the way that CGI.pm functions in various ways. Pragmas,
3953 function sets, and individual functions can all be imported in the
3954 same use() line. For example, the following use statement imports the
3955 standard set of functions and enables debugging mode (pragma
3958 use CGI qw/:standard -debug/;
3960 The current list of pragmas is as follows:
3966 When you I<use CGI -any>, then any method that the query object
3967 doesn't recognize will be interpreted as a new HTML tag. This allows
3968 you to support the next I<ad hoc> Netscape or Microsoft HTML
3969 extension. This lets you go wild with new and unsupported tags:
3973 print $q->gradient({speed=>'fast',start=>'red',end=>'blue'});
3975 Since using <cite>any</cite> causes any mistyped method name
3976 to be interpreted as an HTML tag, use it with care or not at
3981 This causes the indicated autoloaded methods to be compiled up front,
3982 rather than deferred to later. This is useful for scripts that run
3983 for an extended period of time under FastCGI or mod_perl, and for
3984 those destined to be crunched by Malcom Beattie's Perl compiler. Use
3985 it in conjunction with the methods or method families you plan to use.
3987 use CGI qw(-compile :standard :html3);
3991 use CGI qw(-compile :all);
3993 Note that using the -compile pragma in this way will always have
3994 the effect of importing the compiled functions into the current
3995 namespace. If you want to compile without importing use the
3996 compile() method instead (see below).
4000 This makes CGI.pm not generating the hidden fields .submit
4001 and .cgifields. It is very useful if you don't want to
4002 have the hidden fields appear in the querystring in a GET method.
4003 For example, a search script generated this way will have
4004 a very nice url with search parameters for bookmarking.
4008 By default, CGI.pm versions 2.69 and higher emit XHTML
4009 (http://www.w3.org/TR/xhtml1/). The -no_xhtml pragma disables this
4010 feature. Thanks to Michalis Kabrianis <kabrianis@hellug.gr> for this
4015 This makes CGI.pm produce a header appropriate for an NPH (no
4016 parsed header) script. You may need to do other things as well
4017 to tell the server that the script is NPH. See the discussion
4018 of NPH scripts below.
4020 =item -newstyle_urls
4022 Separate the name=value pairs in CGI parameter query strings with
4023 semicolons rather than ampersands. For example:
4025 ?name=fred;age=24;favorite_color=3
4027 Semicolon-delimited query strings are always accepted, but will not be
4028 emitted by self_url() and query_string() unless the -newstyle_urls
4029 pragma is specified.
4031 This became the default in version 2.64.
4033 =item -oldstyle_urls
4035 Separate the name=value pairs in CGI parameter query strings with
4036 ampersands rather than semicolons. This is no longer the default.
4040 This overrides the autoloader so that any function in your program
4041 that is not recognized is referred to CGI.pm for possible evaluation.
4042 This allows you to use all the CGI.pm functions without adding them to
4043 your symbol table, which is of concern for mod_perl users who are
4044 worried about memory consumption. I<Warning:> when
4045 I<-autoload> is in effect, you cannot use "poetry mode"
4046 (functions without the parenthesis). Use I<hr()> rather
4047 than I<hr>, or add something like I<use subs qw/hr p header/>
4048 to the top of your script.
4052 This turns off the command-line processing features. If you want to
4053 run a CGI.pm script from the command line to produce HTML, and you
4054 don't want it to read CGI parameters from the command line or STDIN,
4055 then use this pragma:
4057 use CGI qw(-no_debug :standard);
4061 This turns on full debugging. In addition to reading CGI arguments
4062 from the command-line processing, CGI.pm will pause and try to read
4063 arguments from STDIN, producing the message "(offline mode: enter
4064 name=value pairs on standard input)" features.
4066 See the section on debugging for more details.
4068 =item -private_tempfiles
4070 CGI.pm can process uploaded file. Ordinarily it spools the uploaded
4071 file to a temporary directory, then deletes the file when done.
4072 However, this opens the risk of eavesdropping as described in the file
4073 upload section. Another CGI script author could peek at this data
4074 during the upload, even if it is confidential information. On Unix
4075 systems, the -private_tempfiles pragma will cause the temporary file
4076 to be unlinked as soon as it is opened and before any data is written
4077 into it, reducing, but not eliminating the risk of eavesdropping
4078 (there is still a potential race condition). To make life harder for
4079 the attacker, the program chooses tempfile names by calculating a 32
4080 bit checksum of the incoming HTTP headers.
4082 To ensure that the temporary file cannot be read by other CGI scripts,
4083 use suEXEC or a CGI wrapper program to run your script. The temporary
4084 file is created with mode 0600 (neither world nor group readable).
4086 The temporary directory is selected using the following algorithm:
4088 1. if the current user (e.g. "nobody") has a directory named
4089 "tmp" in its home directory, use that (Unix systems only).
4091 2. if the environment variable TMPDIR exists, use the location
4094 3. Otherwise try the locations /usr/tmp, /var/tmp, C:\temp,
4095 /tmp, /temp, ::Temporary Items, and \WWW_ROOT.
4097 Each of these locations is checked that it is a directory and is
4098 writable. If not, the algorithm tries the next choice.
4102 =head2 SPECIAL FORMS FOR IMPORTING HTML-TAG FUNCTIONS
4104 Many of the methods generate HTML tags. As described below, tag
4105 functions automatically generate both the opening and closing tags.
4108 print h1('Level 1 Header');
4112 <H1>Level 1 Header</H1>
4114 There will be some times when you want to produce the start and end
4115 tags yourself. In this case, you can use the form start_I<tag_name>
4116 and end_I<tag_name>, as in:
4118 print start_h1,'Level 1 Header',end_h1;
4120 With a few exceptions (described below), start_I<tag_name> and
4121 end_I<tag_name> functions are not generated automatically when you
4122 I<use CGI>. However, you can specify the tags you want to generate
4123 I<start/end> functions for by putting an asterisk in front of their
4124 name, or, alternatively, requesting either "start_I<tag_name>" or
4125 "end_I<tag_name>" in the import list.
4129 use CGI qw/:standard *table start_ul/;
4131 In this example, the following functions are generated in addition to
4136 =item 1. start_table() (generates a <TABLE> tag)
4138 =item 2. end_table() (generates a </TABLE> tag)
4140 =item 3. start_ul() (generates a <UL> tag)
4142 =item 4. end_ul() (generates a </UL> tag)
4146 =head1 GENERATING DYNAMIC DOCUMENTS
4148 Most of CGI.pm's functions deal with creating documents on the fly.
4149 Generally you will produce the HTTP header first, followed by the
4150 document itself. CGI.pm provides functions for generating HTTP
4151 headers of various types as well as for generating HTML. For creating
4152 GIF images, see the GD.pm module.
4154 Each of these functions produces a fragment of HTML or HTTP which you
4155 can print out directly so that it displays in the browser window,
4156 append to a string, or save to a file for later use.
4158 =head2 CREATING A STANDARD HTTP HEADER:
4160 Normally the first thing you will do in any CGI script is print out an
4161 HTTP header. This tells the browser what type of document to expect,
4162 and gives other optional information, such as the language, expiration
4163 date, and whether to cache the document. The header can also be
4164 manipulated for special purposes, such as server push and pay per view
4167 print $query->header;
4171 print $query->header('image/gif');
4175 print $query->header('text/html','204 No response');
4179 print $query->header(-type=>'image/gif',
4181 -status=>'402 Payment required',
4185 -attachment=>'foo.gif',
4188 header() returns the Content-type: header. You can provide your own
4189 MIME type if you choose, otherwise it defaults to text/html. An
4190 optional second parameter specifies the status code and a human-readable
4191 message. For example, you can specify 204, "No response" to create a
4192 script that tells the browser to do nothing at all.
4194 The last example shows the named argument style for passing arguments
4195 to the CGI methods using named parameters. Recognized parameters are
4196 B<-type>, B<-status>, B<-expires>, and B<-cookie>. Any other named
4197 parameters will be stripped of their initial hyphens and turned into
4198 header fields, allowing you to specify any HTTP header you desire.
4199 Internal underscores will be turned into hyphens:
4201 print $query->header(-Content_length=>3002);
4203 Most browsers will not cache the output from CGI scripts. Every time
4204 the browser reloads the page, the script is invoked anew. You can
4205 change this behavior with the B<-expires> parameter. When you specify
4206 an absolute or relative expiration interval with this parameter, some
4207 browsers and proxy servers will cache the script's output until the
4208 indicated expiration date. The following forms are all valid for the
4211 +30s 30 seconds from now
4212 +10m ten minutes from now
4213 +1h one hour from now
4214 -1d yesterday (i.e. "ASAP!")
4217 +10y in ten years time
4218 Thursday, 25-Apr-1999 00:40:33 GMT at the indicated time & date
4220 The B<-cookie> parameter generates a header that tells the browser to provide
4221 a "magic cookie" during all subsequent transactions with your script.
4222 Netscape cookies have a special format that includes interesting attributes
4223 such as expiration time. Use the cookie() method to create and retrieve
4226 The B<-nph> parameter, if set to a true value, will issue the correct
4227 headers to work with a NPH (no-parse-header) script. This is important
4228 to use with certain servers that expect all their scripts to be NPH.
4230 The B<-charset> parameter can be used to control the character set
4231 sent to the browser. If not provided, defaults to ISO-8859-1. As a
4232 side effect, this sets the charset() method as well.
4234 The B<-attachment> parameter can be used to turn the page into an
4235 attachment. Instead of displaying the page, some browsers will prompt
4236 the user to save it to disk. The value of the argument is the
4237 suggested name for the saved file. In order for this to work, you may
4238 have to set the B<-type> to "application/octet-stream".
4240 =head2 GENERATING A REDIRECTION HEADER
4242 print $query->redirect('http://somewhere.else/in/movie/land');
4244 Sometimes you don't want to produce a document yourself, but simply
4245 redirect the browser elsewhere, perhaps choosing a URL based on the
4246 time of day or the identity of the user.
4248 The redirect() function redirects the browser to a different URL. If
4249 you use redirection like this, you should B<not> print out a header as
4252 One hint I can offer is that relative links may not work correctly
4253 when you generate a redirection to another document on your site.
4254 This is due to a well-intentioned optimization that some servers use.
4255 The solution to this is to use the full URL (including the http: part)
4256 of the document you are redirecting to.
4258 You can also use named arguments:
4260 print $query->redirect(-uri=>'http://somewhere.else/in/movie/land',
4263 The B<-nph> parameter, if set to a true value, will issue the correct
4264 headers to work with a NPH (no-parse-header) script. This is important
4265 to use with certain servers, such as Microsoft Internet Explorer, which
4266 expect all their scripts to be NPH.
4268 =head2 CREATING THE HTML DOCUMENT HEADER
4270 print $query->start_html(-title=>'Secrets of the Pyramids',
4271 -author=>'fred@capricorn.org',
4274 -meta=>{'keywords'=>'pharaoh secret mummy',
4275 'copyright'=>'copyright 1996 King Tut'},
4276 -style=>{'src'=>'/styles/style1.css'},
4279 After creating the HTTP header, most CGI scripts will start writing
4280 out an HTML document. The start_html() routine creates the top of the
4281 page, along with a lot of optional information that controls the
4282 page's appearance and behavior.
4284 This method returns a canned HTML header and the opening <BODY> tag.
4285 All parameters are optional. In the named parameter form, recognized
4286 parameters are -title, -author, -base, -xbase, -dtd, -lang and -target
4287 (see below for the explanation). Any additional parameters you
4288 provide, such as the Netscape unofficial BGCOLOR attribute, are added
4289 to the <BODY> tag. Additional parameters must be proceeded by a
4292 The argument B<-xbase> allows you to provide an HREF for the <BASE> tag
4293 different from the current location, as in
4295 -xbase=>"http://home.mcom.com/"
4297 All relative links will be interpreted relative to this tag.
4299 The argument B<-target> allows you to provide a default target frame
4300 for all the links and fill-out forms on the page. B<This is a
4301 non-standard HTTP feature which only works with Netscape browsers!>
4302 See the Netscape documentation on frames for details of how to
4305 -target=>"answer_window"
4307 All relative links will be interpreted relative to this tag.
4308 You add arbitrary meta information to the header with the B<-meta>
4309 argument. This argument expects a reference to an associative array
4310 containing name/value pairs of meta information. These will be turned
4311 into a series of header <META> tags that look something like this:
4313 <META NAME="keywords" CONTENT="pharaoh secret mummy">
4314 <META NAME="description" CONTENT="copyright 1996 King Tut">
4316 To create an HTTP-EQUIV type of <META> tag, use B<-head>, described
4319 The B<-style> argument is used to incorporate cascading stylesheets
4320 into your code. See the section on CASCADING STYLESHEETS for more
4323 The B<-lang> argument is used to incorporate a language attribute into
4324 the <HTML> tag. The default if not specified is "en-US" for US
4325 English. For example:
4327 print $q->header(-lang=>'fr-CA');
4329 You can place other arbitrary HTML elements to the <HEAD> section with the
4330 B<-head> tag. For example, to place the rarely-used <LINK> element in the
4331 head section, use this:
4333 print start_html(-head=>Link({-rel=>'next',
4334 -href=>'http://www.capricorn.com/s2.html'}));
4336 To incorporate multiple HTML elements into the <HEAD> section, just pass an
4339 print start_html(-head=>[
4341 -href=>'http://www.capricorn.com/s2.html'}),
4342 Link({-rel=>'previous',
4343 -href=>'http://www.capricorn.com/s1.html'})
4347 And here's how to create an HTTP-EQUIV <META> tag:
4349 print header(-head=>meta({-http_equiv => 'Content-Type',
4350 -content => 'text/html'}))
4353 JAVASCRIPTING: The B<-script>, B<-noScript>, B<-onLoad>,
4354 B<-onMouseOver>, B<-onMouseOut> and B<-onUnload> parameters are used
4355 to add Netscape JavaScript calls to your pages. B<-script> should
4356 point to a block of text containing JavaScript function definitions.
4357 This block will be placed within a <SCRIPT> block inside the HTML (not
4358 HTTP) header. The block is placed in the header in order to give your
4359 page a fighting chance of having all its JavaScript functions in place
4360 even if the user presses the stop button before the page has loaded
4361 completely. CGI.pm attempts to format the script in such a way that
4362 JavaScript-naive browsers will not choke on the code: unfortunately
4363 there are some browsers, such as Chimera for Unix, that get confused
4366 The B<-onLoad> and B<-onUnload> parameters point to fragments of JavaScript
4367 code to execute when the page is respectively opened and closed by the
4368 browser. Usually these parameters are calls to functions defined in the
4372 print $query->header;
4374 // Ask a silly question
4375 function riddle_me_this() {
4376 var r = prompt("What walks on four legs in the morning, " +
4377 "two legs in the afternoon, " +
4378 "and three legs in the evening?");
4381 // Get a silly answer
4382 function response(answer) {
4383 if (answer == "man")
4384 alert("Right you are!");
4386 alert("Wrong! Guess again.");
4389 print $query->start_html(-title=>'The Riddle of the Sphinx',
4392 Use the B<-noScript> parameter to pass some HTML text that will be displayed on
4393 browsers that do not have JavaScript (or browsers where JavaScript is turned
4396 Netscape 3.0 recognizes several attributes of the <SCRIPT> tag,
4397 including LANGUAGE and SRC. The latter is particularly interesting,
4398 as it allows you to keep the JavaScript code in a file or CGI script
4399 rather than cluttering up each page with the source. To use these
4400 attributes pass a HASH reference in the B<-script> parameter containing
4401 one or more of -language, -src, or -code:
4403 print $q->start_html(-title=>'The Riddle of the Sphinx',
4404 -script=>{-language=>'JAVASCRIPT',
4405 -src=>'/javascript/sphinx.js'}
4408 print $q->(-title=>'The Riddle of the Sphinx',
4409 -script=>{-language=>'PERLSCRIPT',
4410 -code=>'print "hello world!\n;"'}
4414 A final feature allows you to incorporate multiple <SCRIPT> sections into the
4415 header. Just pass the list of script sections as an array reference.
4416 this allows you to specify different source files for different dialects
4417 of JavaScript. Example:
4419 print $q->start_html(-title=>'The Riddle of the Sphinx',
4421 { -language => 'JavaScript1.0',
4422 -src => '/javascript/utilities10.js'
4424 { -language => 'JavaScript1.1',
4425 -src => '/javascript/utilities11.js'
4427 { -language => 'JavaScript1.2',
4428 -src => '/javascript/utilities12.js'
4430 { -language => 'JavaScript28.2',
4431 -src => '/javascript/utilities219.js'
4437 If this looks a bit extreme, take my advice and stick with straight CGI scripting.
4441 http://home.netscape.com/eng/mozilla/2.0/handbook/javascript/
4443 for more information about JavaScript.
4445 The old-style positional parameters are as follows:
4449 =item B<Parameters:>
4457 The author's e-mail address (will create a <LINK REV="MADE"> tag if present
4461 A 'true' flag if you want to include a <BASE> tag in the header. This
4462 helps resolve relative addresses to absolute ones when the document is moved,
4463 but makes the document hierarchy non-portable. Use with care!
4467 Any other parameters you want to include in the <BODY> tag. This is a good
4468 place to put Netscape extensions, such as colors and wallpaper patterns.
4472 =head2 ENDING THE HTML DOCUMENT:
4474 print $query->end_html
4476 This ends an HTML document by printing the </BODY></HTML> tags.
4478 =head2 CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION:
4480 $myself = $query->self_url;
4481 print q(<A HREF="$myself">I'm talking to myself.</A>);
4483 self_url() will return a URL, that, when selected, will reinvoke
4484 this script with all its state information intact. This is most
4485 useful when you want to jump around within the document using
4486 internal anchors but you don't want to disrupt the current contents
4487 of the form(s). Something like this will do the trick.
4489 $myself = $query->self_url;
4490 print "<A HREF=$myself#table1>See table 1</A>";
4491 print "<A HREF=$myself#table2>See table 2</A>";
4492 print "<A HREF=$myself#yourself>See for yourself</A>";
4494 If you want more control over what's returned, using the B<url()>
4497 You can also retrieve the unprocessed query string with query_string():
4499 $the_string = $query->query_string;
4501 =head2 OBTAINING THE SCRIPT'S URL
4503 $full_url = $query->url();
4504 $full_url = $query->url(-full=>1); #alternative syntax
4505 $relative_url = $query->url(-relative=>1);
4506 $absolute_url = $query->url(-absolute=>1);
4507 $url_with_path = $query->url(-path_info=>1);
4508 $url_with_path_and_query = $query->url(-path_info=>1,-query=>1);
4510 B<url()> returns the script's URL in a variety of formats. Called
4511 without any arguments, it returns the full form of the URL, including
4512 host name and port number
4514 http://your.host.com/path/to/script.cgi
4516 You can modify this format with the following named arguments:
4522 If true, produce an absolute URL, e.g.
4528 Produce a relative URL. This is useful if you want to reinvoke your
4529 script with different parameters. For example:
4535 Produce the full URL, exactly as if called without any arguments.
4536 This overrides the -relative and -absolute arguments.
4538 =item B<-path> (B<-path_info>)
4540 Append the additional path information to the URL. This can be
4541 combined with B<-full>, B<-absolute> or B<-relative>. B<-path_info>
4542 is provided as a synonym.
4544 =item B<-query> (B<-query_string>)
4546 Append the query string to the URL. This can be combined with
4547 B<-full>, B<-absolute> or B<-relative>. B<-query_string> is provided
4552 =head2 MIXING POST AND URL PARAMETERS
4554 $color = $query->url_param('color');
4556 It is possible for a script to receive CGI parameters in the URL as
4557 well as in the fill-out form by creating a form that POSTs to a URL
4558 containing a query string (a "?" mark followed by arguments). The
4559 B<param()> method will always return the contents of the POSTed
4560 fill-out form, ignoring the URL's query string. To retrieve URL
4561 parameters, call the B<url_param()> method. Use it in the same way as
4562 B<param()>. The main difference is that it allows you to read the
4563 parameters, but not set them.
4566 Under no circumstances will the contents of the URL query string
4567 interfere with similarly-named CGI parameters in POSTed forms. If you
4568 try to mix a URL query string with a form submitted with the GET
4569 method, the results will not be what you expect.
4571 =head1 CREATING STANDARD HTML ELEMENTS:
4573 CGI.pm defines general HTML shortcut methods for most, if not all of
4574 the HTML 3 and HTML 4 tags. HTML shortcuts are named after a single
4575 HTML element and return a fragment of HTML text that you can then
4576 print or manipulate as you like. Each shortcut returns a fragment of
4577 HTML code that you can append to a string, save to a file, or, most
4578 commonly, print out so that it displays in the browser window.
4580 This example shows how to use the HTML methods:
4583 print $q->blockquote(
4584 "Many years ago on the island of",
4585 $q->a({href=>"http://crete.org/"},"Crete"),
4586 "there lived a Minotaur named",
4587 $q->strong("Fred."),
4591 This results in the following HTML code (extra newlines have been
4592 added for readability):
4595 Many years ago on the island of
4596 <a HREF="http://crete.org/">Crete</a> there lived
4597 a minotaur named <strong>Fred.</strong>
4601 If you find the syntax for calling the HTML shortcuts awkward, you can
4602 import them into your namespace and dispense with the object syntax
4603 completely (see the next section for more details):
4605 use CGI ':standard';
4607 "Many years ago on the island of",
4608 a({href=>"http://crete.org/"},"Crete"),
4609 "there lived a minotaur named",
4614 =head2 PROVIDING ARGUMENTS TO HTML SHORTCUTS
4616 The HTML methods will accept zero, one or multiple arguments. If you
4617 provide no arguments, you get a single tag:
4621 If you provide one or more string arguments, they are concatenated
4622 together with spaces and placed between opening and closing tags:
4624 print h1("Chapter","1"); # <H1>Chapter 1</H1>"
4626 If the first argument is an associative array reference, then the keys
4627 and values of the associative array become the HTML tag's attributes:
4629 print a({-href=>'fred.html',-target=>'_new'},
4630 "Open a new frame");
4632 <A HREF="fred.html",TARGET="_new">Open a new frame</A>
4634 You may dispense with the dashes in front of the attribute names if
4637 print img {src=>'fred.gif',align=>'LEFT'};
4639 <IMG ALIGN="LEFT" SRC="fred.gif">
4641 Sometimes an HTML tag attribute has no argument. For example, ordered
4642 lists can be marked as COMPACT. The syntax for this is an argument that
4643 that points to an undef string:
4645 print ol({compact=>undef},li('one'),li('two'),li('three'));
4647 Prior to CGI.pm version 2.41, providing an empty ('') string as an
4648 attribute argument was the same as providing undef. However, this has
4649 changed in order to accommodate those who want to create tags of the form
4650 <IMG ALT="">. The difference is shown in these two pieces of code:
4653 img({alt=>undef}) <IMG ALT>
4654 img({alt=>''}) <IMT ALT="">
4656 =head2 THE DISTRIBUTIVE PROPERTY OF HTML SHORTCUTS
4658 One of the cool features of the HTML shortcuts is that they are
4659 distributive. If you give them an argument consisting of a
4660 B<reference> to a list, the tag will be distributed across each
4661 element of the list. For example, here's one way to make an ordered
4665 li({-type=>'disc'},['Sneezy','Doc','Sleepy','Happy'])
4668 This example will result in HTML output that looks like this:
4671 <LI TYPE="disc">Sneezy</LI>
4672 <LI TYPE="disc">Doc</LI>
4673 <LI TYPE="disc">Sleepy</LI>
4674 <LI TYPE="disc">Happy</LI>
4677 This is extremely useful for creating tables. For example:
4679 print table({-border=>undef},
4680 caption('When Should You Eat Your Vegetables?'),
4681 Tr({-align=>CENTER,-valign=>TOP},
4683 th(['Vegetable', 'Breakfast','Lunch','Dinner']),
4684 td(['Tomatoes' , 'no', 'yes', 'yes']),
4685 td(['Broccoli' , 'no', 'no', 'yes']),
4686 td(['Onions' , 'yes','yes', 'yes'])
4691 =head2 HTML SHORTCUTS AND LIST INTERPOLATION
4693 Consider this bit of code:
4695 print blockquote(em('Hi'),'mom!'));
4697 It will ordinarily return the string that you probably expect, namely:
4699 <BLOCKQUOTE><EM>Hi</EM> mom!</BLOCKQUOTE>
4701 Note the space between the element "Hi" and the element "mom!".
4702 CGI.pm puts the extra space there using array interpolation, which is
4703 controlled by the magic $" variable. Sometimes this extra space is
4704 not what you want, for example, when you are trying to align a series
4705 of images. In this case, you can simply change the value of $" to an
4710 print blockquote(em('Hi'),'mom!'));
4713 I suggest you put the code in a block as shown here. Otherwise the
4714 change to $" will affect all subsequent code until you explicitly
4717 =head2 NON-STANDARD HTML SHORTCUTS
4719 A few HTML tags don't follow the standard pattern for various
4722 B<comment()> generates an HTML comment (<!-- comment -->). Call it
4725 print comment('here is my comment');
4727 Because of conflicts with built-in Perl functions, the following functions
4728 begin with initial caps:
4737 In addition, start_html(), end_html(), start_form(), end_form(),
4738 start_multipart_form() and all the fill-out form tags are special.
4739 See their respective sections.
4741 =head2 AUTOESCAPING HTML
4743 By default, all HTML that is emitted by the form-generating functions
4744 is passed through a function called escapeHTML():
4748 =item $escaped_string = escapeHTML("unescaped string");
4750 Escape HTML formatting characters in a string.
4754 Provided that you have specified a character set of ISO-8859-1 (the
4755 default), the standard HTML escaping rules will be used. The "<"
4756 character becomes "<", ">" becomes ">", "&" becomes "&", and
4757 the quote character becomes """. In addition, the hexadecimal
4758 0x8b and 0x9b characters, which many windows-based browsers interpret
4759 as the left and right angle-bracket characters, are replaced by their
4760 numeric HTML entities ("‹" and "›"). If you manually change
4761 the charset, either by calling the charset() method explicitly or by
4762 passing a -charset argument to header(), then B<all> characters will
4763 be replaced by their numeric entities, since CGI.pm has no lookup
4764 table for all the possible encodings.
4766 The automatic escaping does not apply to other shortcuts, such as
4767 h1(). You should call escapeHTML() yourself on untrusted data in
4768 order to protect your pages against nasty tricks that people may enter
4769 into guestbooks, etc.. To change the character set, use charset().
4770 To turn autoescaping off completely, use autoescape():
4774 =item $charset = charset([$charset]);
4776 Get or set the current character set.
4778 =item $flag = autoEscape([$flag]);
4780 Get or set the value of the autoescape flag.
4784 =head2 PRETTY-PRINTING HTML
4786 By default, all the HTML produced by these functions comes out as one
4787 long line without carriage returns or indentation. This is yuck, but
4788 it does reduce the size of the documents by 10-20%. To get
4789 pretty-printed output, please use L<CGI::Pretty>, a subclass
4790 contributed by Brian Paulsen.
4792 =head1 CREATING FILL-OUT FORMS:
4794 I<General note> The various form-creating methods all return strings
4795 to the caller, containing the tag or tags that will create the requested
4796 form element. You are responsible for actually printing out these strings.
4797 It's set up this way so that you can place formatting tags
4798 around the form elements.
4800 I<Another note> The default values that you specify for the forms are only
4801 used the B<first> time the script is invoked (when there is no query
4802 string). On subsequent invocations of the script (when there is a query
4803 string), the former values are used even if they are blank.
4805 If you want to change the value of a field from its previous value, you have two
4808 (1) call the param() method to set it.
4810 (2) use the -override (alias -force) parameter (a new feature in version 2.15).
4811 This forces the default value to be used, regardless of the previous value:
4813 print $query->textfield(-name=>'field_name',
4814 -default=>'starting value',
4819 I<Yet another note> By default, the text and labels of form elements are
4820 escaped according to HTML rules. This means that you can safely use
4821 "<CLICK ME>" as the label for a button. However, it also interferes with
4822 your ability to incorporate special HTML character sequences, such as Á,
4823 into your fields. If you wish to turn off automatic escaping, call the
4824 autoEscape() method with a false value immediately after creating the CGI object:
4827 $query->autoEscape(undef);
4829 =head2 CREATING AN ISINDEX TAG
4831 print $query->isindex(-action=>$action);
4835 print $query->isindex($action);
4837 Prints out an <ISINDEX> tag. Not very exciting. The parameter
4838 -action specifies the URL of the script to process the query. The
4839 default is to process the query with the current script.
4841 =head2 STARTING AND ENDING A FORM
4843 print $query->start_form(-method=>$method,
4845 -enctype=>$encoding);
4846 <... various form stuff ...>
4847 print $query->endform;
4851 print $query->start_form($method,$action,$encoding);
4852 <... various form stuff ...>
4853 print $query->endform;
4855 start_form() will return a <FORM> tag with the optional method,
4856 action and form encoding that you specify. The defaults are:
4860 enctype: application/x-www-form-urlencoded
4862 endform() returns the closing </FORM> tag.
4864 Start_form()'s enctype argument tells the browser how to package the various
4865 fields of the form before sending the form to the server. Two
4866 values are possible:
4868 B<Note:> This method was previously named startform(), and startform()
4869 is still recognized as an alias.
4873 =item B<application/x-www-form-urlencoded>
4875 This is the older type of encoding used by all browsers prior to
4876 Netscape 2.0. It is compatible with many CGI scripts and is
4877 suitable for short fields containing text data. For your
4878 convenience, CGI.pm stores the name of this encoding
4879 type in B<&CGI::URL_ENCODED>.
4881 =item B<multipart/form-data>
4883 This is the newer type of encoding introduced by Netscape 2.0.
4884 It is suitable for forms that contain very large fields or that
4885 are intended for transferring binary data. Most importantly,
4886 it enables the "file upload" feature of Netscape 2.0 forms. For
4887 your convenience, CGI.pm stores the name of this encoding type
4888 in B<&CGI::MULTIPART>
4890 Forms that use this type of encoding are not easily interpreted
4891 by CGI scripts unless they use CGI.pm or another library designed
4896 For compatibility, the start_form() method uses the older form of
4897 encoding by default. If you want to use the newer form of encoding
4898 by default, you can call B<start_multipart_form()> instead of
4901 JAVASCRIPTING: The B<-name> and B<-onSubmit> parameters are provided
4902 for use with JavaScript. The -name parameter gives the
4903 form a name so that it can be identified and manipulated by
4904 JavaScript functions. -onSubmit should point to a JavaScript
4905 function that will be executed just before the form is submitted to your
4906 server. You can use this opportunity to check the contents of the form
4907 for consistency and completeness. If you find something wrong, you
4908 can put up an alert box or maybe fix things up yourself. You can
4909 abort the submission by returning false from this function.
4911 Usually the bulk of JavaScript functions are defined in a <SCRIPT>
4912 block in the HTML header and -onSubmit points to one of these function
4913 call. See start_html() for details.
4915 =head2 CREATING A TEXT FIELD
4917 print $query->textfield(-name=>'field_name',
4918 -default=>'starting value',
4923 print $query->textfield('field_name','starting value',50,80);
4925 textfield() will return a text input field.
4933 The first parameter is the required name for the field (-name).
4937 The optional second parameter is the default starting value for the field
4938 contents (-default).
4942 The optional third parameter is the size of the field in
4947 The optional fourth parameter is the maximum number of characters the
4948 field will accept (-maxlength).
4952 As with all these methods, the field will be initialized with its
4953 previous contents from earlier invocations of the script.
4954 When the form is processed, the value of the text field can be
4957 $value = $query->param('foo');
4959 If you want to reset it from its initial value after the script has been
4960 called once, you can do so like this:
4962 $query->param('foo',"I'm taking over this value!");
4964 NEW AS OF VERSION 2.15: If you don't want the field to take on its previous
4965 value, you can force its current value by using the -override (alias -force)
4968 print $query->textfield(-name=>'field_name',
4969 -default=>'starting value',
4974 JAVASCRIPTING: You can also provide B<-onChange>, B<-onFocus>,
4975 B<-onBlur>, B<-onMouseOver>, B<-onMouseOut> and B<-onSelect>
4976 parameters to register JavaScript event handlers. The onChange
4977 handler will be called whenever the user changes the contents of the
4978 text field. You can do text validation if you like. onFocus and
4979 onBlur are called respectively when the insertion point moves into and
4980 out of the text field. onSelect is called when the user changes the
4981 portion of the text that is selected.
4983 =head2 CREATING A BIG TEXT FIELD
4985 print $query->textarea(-name=>'foo',
4986 -default=>'starting value',
4992 print $query->textarea('foo','starting value',10,50);
4994 textarea() is just like textfield, but it allows you to specify
4995 rows and columns for a multiline text entry box. You can provide
4996 a starting value for the field, which can be long and contain
4999 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur> ,
5000 B<-onMouseOver>, B<-onMouseOut>, and B<-onSelect> parameters are
5001 recognized. See textfield().
5003 =head2 CREATING A PASSWORD FIELD
5005 print $query->password_field(-name=>'secret',
5006 -value=>'starting value',
5011 print $query->password_field('secret','starting value',50,80);
5013 password_field() is identical to textfield(), except that its contents
5014 will be starred out on the web page.
5016 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>,
5017 B<-onMouseOver>, B<-onMouseOut> and B<-onSelect> parameters are
5018 recognized. See textfield().
5020 =head2 CREATING A FILE UPLOAD FIELD
5022 print $query->filefield(-name=>'uploaded_file',
5023 -default=>'starting value',
5028 print $query->filefield('uploaded_file','starting value',50,80);
5030 filefield() will return a file upload field for Netscape 2.0 browsers.
5031 In order to take full advantage of this I<you must use the new
5032 multipart encoding scheme> for the form. You can do this either
5033 by calling B<start_form()> with an encoding type of B<&CGI::MULTIPART>,
5034 or by calling the new method B<start_multipart_form()> instead of
5035 vanilla B<start_form()>.
5043 The first parameter is the required name for the field (-name).
5047 The optional second parameter is the starting value for the field contents
5048 to be used as the default file name (-default).
5050 For security reasons, browsers don't pay any attention to this field,
5051 and so the starting value will always be blank. Worse, the field
5052 loses its "sticky" behavior and forgets its previous contents. The
5053 starting value field is called for in the HTML specification, however,
5054 and possibly some browser will eventually provide support for it.
5058 The optional third parameter is the size of the field in
5063 The optional fourth parameter is the maximum number of characters the
5064 field will accept (-maxlength).
5068 When the form is processed, you can retrieve the entered filename
5071 $filename = $query->param('uploaded_file');
5073 Different browsers will return slightly different things for the
5074 name. Some browsers return the filename only. Others return the full
5075 path to the file, using the path conventions of the user's machine.
5076 Regardless, the name returned is always the name of the file on the
5077 I<user's> machine, and is unrelated to the name of the temporary file
5078 that CGI.pm creates during upload spooling (see below).
5080 The filename returned is also a file handle. You can read the contents
5081 of the file using standard Perl file reading calls:
5083 # Read a text file and print it out
5084 while (<$filename>) {
5088 # Copy a binary file to somewhere safe
5089 open (OUTFILE,">>/usr/local/web/users/feedback");
5090 while ($bytesread=read($filename,$buffer,1024)) {
5091 print OUTFILE $buffer;
5094 However, there are problems with the dual nature of the upload fields.
5095 If you C<use strict>, then Perl will complain when you try to use a
5096 string as a filehandle. You can get around this by placing the file
5097 reading code in a block containing the C<no strict> pragma. More
5098 seriously, it is possible for the remote user to type garbage into the
5099 upload field, in which case what you get from param() is not a
5100 filehandle at all, but a string.
5102 To be safe, use the I<upload()> function (new in version 2.47). When
5103 called with the name of an upload field, I<upload()> returns a
5104 filehandle, or undef if the parameter is not a valid filehandle.
5106 $fh = $query->upload('uploaded_file');
5111 This is the recommended idiom.
5113 When a file is uploaded the browser usually sends along some
5114 information along with it in the format of headers. The information
5115 usually includes the MIME content type. Future browsers may send
5116 other information as well (such as modification date and size). To
5117 retrieve this information, call uploadInfo(). It returns a reference to
5118 an associative array containing all the document headers.
5120 $filename = $query->param('uploaded_file');
5121 $type = $query->uploadInfo($filename)->{'Content-Type'};
5122 unless ($type eq 'text/html') {
5123 die "HTML FILES ONLY!";
5126 If you are using a machine that recognizes "text" and "binary" data
5127 modes, be sure to understand when and how to use them (see the Camel book).
5128 Otherwise you may find that binary files are corrupted during file
5131 There are occasionally problems involving parsing the uploaded file.
5132 This usually happens when the user presses "Stop" before the upload is
5133 finished. In this case, CGI.pm will return undef for the name of the
5134 uploaded file and set I<cgi_error()> to the string "400 Bad request
5135 (malformed multipart POST)". This error message is designed so that
5136 you can incorporate it into a status code to be sent to the browser.
5139 $file = $query->upload('uploaded_file');
5140 if (!$file && $query->cgi_error) {
5141 print $query->header(-status=>$query->cgi_error);
5145 You are free to create a custom HTML page to complain about the error,
5148 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>,
5149 B<-onMouseOver>, B<-onMouseOut> and B<-onSelect> parameters are
5150 recognized. See textfield() for details.
5152 =head2 CREATING A POPUP MENU
5154 print $query->popup_menu('menu_name',
5155 ['eenie','meenie','minie'],
5160 %labels = ('eenie'=>'your first choice',
5161 'meenie'=>'your second choice',
5162 'minie'=>'your third choice');
5163 print $query->popup_menu('menu_name',
5164 ['eenie','meenie','minie'],
5167 -or (named parameter style)-
5169 print $query->popup_menu(-name=>'menu_name',
5170 -values=>['eenie','meenie','minie'],
5174 popup_menu() creates a menu.
5180 The required first argument is the menu's name (-name).
5184 The required second argument (-values) is an array B<reference>
5185 containing the list of menu items in the menu. You can pass the
5186 method an anonymous array, as shown in the example, or a reference to
5187 a named array, such as "\@foo".
5191 The optional third parameter (-default) is the name of the default
5192 menu choice. If not specified, the first item will be the default.
5193 The values of the previous choice will be maintained across queries.
5197 The optional fourth parameter (-labels) is provided for people who
5198 want to use different values for the user-visible label inside the
5199 popup menu nd the value returned to your script. It's a pointer to an
5200 associative array relating menu values to user-visible labels. If you
5201 leave this parameter blank, the menu values will be displayed by
5202 default. (You can also leave a label undefined if you want to).
5206 When the form is processed, the selected value of the popup menu can
5209 $popup_menu_value = $query->param('menu_name');
5211 JAVASCRIPTING: popup_menu() recognizes the following event handlers:
5212 B<-onChange>, B<-onFocus>, B<-onMouseOver>, B<-onMouseOut>, and
5213 B<-onBlur>. See the textfield() section for details on when these
5214 handlers are called.
5216 =head2 CREATING A SCROLLING LIST
5218 print $query->scrolling_list('list_name',
5219 ['eenie','meenie','minie','moe'],
5220 ['eenie','moe'],5,'true');
5223 print $query->scrolling_list('list_name',
5224 ['eenie','meenie','minie','moe'],
5225 ['eenie','moe'],5,'true',
5230 print $query->scrolling_list(-name=>'list_name',
5231 -values=>['eenie','meenie','minie','moe'],
5232 -default=>['eenie','moe'],
5237 scrolling_list() creates a scrolling list.
5241 =item B<Parameters:>
5245 The first and second arguments are the list name (-name) and values
5246 (-values). As in the popup menu, the second argument should be an
5251 The optional third argument (-default) can be either a reference to a
5252 list containing the values to be selected by default, or can be a
5253 single value to select. If this argument is missing or undefined,
5254 then nothing is selected when the list first appears. In the named
5255 parameter version, you can use the synonym "-defaults" for this
5260 The optional fourth argument is the size of the list (-size).
5264 The optional fifth argument can be set to true to allow multiple
5265 simultaneous selections (-multiple). Otherwise only one selection
5266 will be allowed at a time.
5270 The optional sixth argument is a pointer to an associative array
5271 containing long user-visible labels for the list items (-labels).
5272 If not provided, the values will be displayed.
5274 When this form is processed, all selected list items will be returned as
5275 a list under the parameter name 'list_name'. The values of the
5276 selected items can be retrieved with:
5278 @selected = $query->param('list_name');
5282 JAVASCRIPTING: scrolling_list() recognizes the following event
5283 handlers: B<-onChange>, B<-onFocus>, B<-onMouseOver>, B<-onMouseOut>
5284 and B<-onBlur>. See textfield() for the description of when these
5285 handlers are called.
5287 =head2 CREATING A GROUP OF RELATED CHECKBOXES
5289 print $query->checkbox_group(-name=>'group_name',
5290 -values=>['eenie','meenie','minie','moe'],
5291 -default=>['eenie','moe'],
5295 print $query->checkbox_group('group_name',
5296 ['eenie','meenie','minie','moe'],
5297 ['eenie','moe'],'true',\%labels);
5299 HTML3-COMPATIBLE BROWSERS ONLY:
5301 print $query->checkbox_group(-name=>'group_name',
5302 -values=>['eenie','meenie','minie','moe'],
5303 -rows=2,-columns=>2);
5306 checkbox_group() creates a list of checkboxes that are related
5311 =item B<Parameters:>
5315 The first and second arguments are the checkbox name and values,
5316 respectively (-name and -values). As in the popup menu, the second
5317 argument should be an array reference. These values are used for the
5318 user-readable labels printed next to the checkboxes as well as for the
5319 values passed to your script in the query string.
5323 The optional third argument (-default) can be either a reference to a
5324 list containing the values to be checked by default, or can be a
5325 single value to checked. If this argument is missing or undefined,
5326 then nothing is selected when the list first appears.
5330 The optional fourth argument (-linebreak) can be set to true to place
5331 line breaks between the checkboxes so that they appear as a vertical
5332 list. Otherwise, they will be strung together on a horizontal line.
5336 The optional fifth argument is a pointer to an associative array
5337 relating the checkbox values to the user-visible labels that will
5338 be printed next to them (-labels). If not provided, the values will
5339 be used as the default.
5343 B<HTML3-compatible browsers> (such as Netscape) can take advantage of
5344 the optional parameters B<-rows>, and B<-columns>. These parameters
5345 cause checkbox_group() to return an HTML3 compatible table containing
5346 the checkbox group formatted with the specified number of rows and
5347 columns. You can provide just the -columns parameter if you wish;
5348 checkbox_group will calculate the correct number of rows for you.
5350 To include row and column headings in the returned table, you
5351 can use the B<-rowheaders> and B<-colheaders> parameters. Both
5352 of these accept a pointer to an array of headings to use.
5353 The headings are just decorative. They don't reorganize the
5354 interpretation of the checkboxes -- they're still a single named
5359 When the form is processed, all checked boxes will be returned as
5360 a list under the parameter name 'group_name'. The values of the
5361 "on" checkboxes can be retrieved with:
5363 @turned_on = $query->param('group_name');
5365 The value returned by checkbox_group() is actually an array of button
5366 elements. You can capture them and use them within tables, lists,
5367 or in other creative ways:
5369 @h = $query->checkbox_group(-name=>'group_name',-values=>\@values);
5370 &use_in_creative_way(@h);
5372 JAVASCRIPTING: checkbox_group() recognizes the B<-onClick>
5373 parameter. This specifies a JavaScript code fragment or
5374 function call to be executed every time the user clicks on
5375 any of the buttons in the group. You can retrieve the identity
5376 of the particular button clicked on using the "this" variable.
5378 =head2 CREATING A STANDALONE CHECKBOX
5380 print $query->checkbox(-name=>'checkbox_name',
5381 -checked=>'checked',
5383 -label=>'CLICK ME');
5387 print $query->checkbox('checkbox_name','checked','ON','CLICK ME');
5389 checkbox() is used to create an isolated checkbox that isn't logically
5390 related to any others.
5394 =item B<Parameters:>
5398 The first parameter is the required name for the checkbox (-name). It
5399 will also be used for the user-readable label printed next to the
5404 The optional second parameter (-checked) specifies that the checkbox
5405 is turned on by default. Synonyms are -selected and -on.
5409 The optional third parameter (-value) specifies the value of the
5410 checkbox when it is checked. If not provided, the word "on" is
5415 The optional fourth parameter (-label) is the user-readable label to
5416 be attached to the checkbox. If not provided, the checkbox name is
5421 The value of the checkbox can be retrieved using:
5423 $turned_on = $query->param('checkbox_name');
5425 JAVASCRIPTING: checkbox() recognizes the B<-onClick>
5426 parameter. See checkbox_group() for further details.
5428 =head2 CREATING A RADIO BUTTON GROUP
5430 print $query->radio_group(-name=>'group_name',
5431 -values=>['eenie','meenie','minie'],
5438 print $query->radio_group('group_name',['eenie','meenie','minie'],
5439 'meenie','true',\%labels);
5442 HTML3-COMPATIBLE BROWSERS ONLY:
5444 print $query->radio_group(-name=>'group_name',
5445 -values=>['eenie','meenie','minie','moe'],
5446 -rows=2,-columns=>2);
5448 radio_group() creates a set of logically-related radio buttons
5449 (turning one member of the group on turns the others off)
5453 =item B<Parameters:>
5457 The first argument is the name of the group and is required (-name).
5461 The second argument (-values) is the list of values for the radio
5462 buttons. The values and the labels that appear on the page are
5463 identical. Pass an array I<reference> in the second argument, either
5464 using an anonymous array, as shown, or by referencing a named array as
5469 The optional third parameter (-default) is the name of the default
5470 button to turn on. If not specified, the first item will be the
5471 default. You can provide a nonexistent button name, such as "-" to
5472 start up with no buttons selected.
5476 The optional fourth parameter (-linebreak) can be set to 'true' to put
5477 line breaks between the buttons, creating a vertical list.
5481 The optional fifth parameter (-labels) is a pointer to an associative
5482 array relating the radio button values to user-visible labels to be
5483 used in the display. If not provided, the values themselves are
5488 B<HTML3-compatible browsers> (such as Netscape) can take advantage
5490 parameters B<-rows>, and B<-columns>. These parameters cause
5491 radio_group() to return an HTML3 compatible table containing
5492 the radio group formatted with the specified number of rows
5493 and columns. You can provide just the -columns parameter if you
5494 wish; radio_group will calculate the correct number of rows
5497 To include row and column headings in the returned table, you
5498 can use the B<-rowheader> and B<-colheader> parameters. Both
5499 of these accept a pointer to an array of headings to use.
5500 The headings are just decorative. They don't reorganize the
5501 interpretation of the radio buttons -- they're still a single named
5506 When the form is processed, the selected radio button can
5509 $which_radio_button = $query->param('group_name');
5511 The value returned by radio_group() is actually an array of button
5512 elements. You can capture them and use them within tables, lists,
5513 or in other creative ways:
5515 @h = $query->radio_group(-name=>'group_name',-values=>\@values);
5516 &use_in_creative_way(@h);
5518 =head2 CREATING A SUBMIT BUTTON
5520 print $query->submit(-name=>'button_name',
5525 print $query->submit('button_name','value');
5527 submit() will create the query submission button. Every form
5528 should have one of these.
5532 =item B<Parameters:>
5536 The first argument (-name) is optional. You can give the button a
5537 name if you have several submission buttons in your form and you want
5538 to distinguish between them. The name will also be used as the
5539 user-visible label. Be aware that a few older browsers don't deal with this correctly and
5540 B<never> send back a value from a button.
5544 The second argument (-value) is also optional. This gives the button
5545 a value that will be passed to your script in the query string.
5549 You can figure out which button was pressed by using different
5550 values for each one:
5552 $which_one = $query->param('button_name');
5554 JAVASCRIPTING: radio_group() recognizes the B<-onClick>
5555 parameter. See checkbox_group() for further details.
5557 =head2 CREATING A RESET BUTTON
5561 reset() creates the "reset" button. Note that it restores the
5562 form to its value from the last time the script was called,
5563 NOT necessarily to the defaults.
5565 Note that this conflicts with the Perl reset() built-in. Use
5566 CORE::reset() to get the original reset function.
5568 =head2 CREATING A DEFAULT BUTTON
5570 print $query->defaults('button_label')
5572 defaults() creates a button that, when invoked, will cause the
5573 form to be completely reset to its defaults, wiping out all the
5574 changes the user ever made.
5576 =head2 CREATING A HIDDEN FIELD
5578 print $query->hidden(-name=>'hidden_name',
5579 -default=>['value1','value2'...]);
5583 print $query->hidden('hidden_name','value1','value2'...);
5585 hidden() produces a text field that can't be seen by the user. It
5586 is useful for passing state variable information from one invocation
5587 of the script to the next.
5591 =item B<Parameters:>
5595 The first argument is required and specifies the name of this
5600 The second argument is also required and specifies its value
5601 (-default). In the named parameter style of calling, you can provide
5602 a single value here or a reference to a whole list
5606 Fetch the value of a hidden field this way:
5608 $hidden_value = $query->param('hidden_name');
5610 Note, that just like all the other form elements, the value of a
5611 hidden field is "sticky". If you want to replace a hidden field with
5612 some other values after the script has been called once you'll have to
5615 $query->param('hidden_name','new','values','here');
5617 =head2 CREATING A CLICKABLE IMAGE BUTTON
5619 print $query->image_button(-name=>'button_name',
5620 -src=>'/source/URL',
5625 print $query->image_button('button_name','/source/URL','MIDDLE');
5627 image_button() produces a clickable image. When it's clicked on the
5628 position of the click is returned to your script as "button_name.x"
5629 and "button_name.y", where "button_name" is the name you've assigned
5632 JAVASCRIPTING: image_button() recognizes the B<-onClick>
5633 parameter. See checkbox_group() for further details.
5637 =item B<Parameters:>
5641 The first argument (-name) is required and specifies the name of this
5646 The second argument (-src) is also required and specifies the URL
5649 The third option (-align, optional) is an alignment type, and may be
5650 TOP, BOTTOM or MIDDLE
5654 Fetch the value of the button this way:
5655 $x = $query->param('button_name.x');
5656 $y = $query->param('button_name.y');
5658 =head2 CREATING A JAVASCRIPT ACTION BUTTON
5660 print $query->button(-name=>'button_name',
5661 -value=>'user visible label',
5662 -onClick=>"do_something()");
5666 print $query->button('button_name',"do_something()");
5668 button() produces a button that is compatible with Netscape 2.0's
5669 JavaScript. When it's pressed the fragment of JavaScript code
5670 pointed to by the B<-onClick> parameter will be executed. On
5671 non-Netscape browsers this form element will probably not even
5676 Netscape browsers versions 1.1 and higher, and all versions of
5677 Internet Explorer, support a so-called "cookie" designed to help
5678 maintain state within a browser session. CGI.pm has several methods
5679 that support cookies.
5681 A cookie is a name=value pair much like the named parameters in a CGI
5682 query string. CGI scripts create one or more cookies and send
5683 them to the browser in the HTTP header. The browser maintains a list
5684 of cookies that belong to a particular Web server, and returns them
5685 to the CGI script during subsequent interactions.
5687 In addition to the required name=value pair, each cookie has several
5688 optional attributes:
5692 =item 1. an expiration time
5694 This is a time/date string (in a special GMT format) that indicates
5695 when a cookie expires. The cookie will be saved and returned to your
5696 script until this expiration date is reached if the user exits
5697 the browser and restarts it. If an expiration date isn't specified, the cookie
5698 will remain active until the user quits the browser.
5702 This is a partial or complete domain name for which the cookie is
5703 valid. The browser will return the cookie to any host that matches
5704 the partial domain name. For example, if you specify a domain name
5705 of ".capricorn.com", then the browser will return the cookie to
5706 Web servers running on any of the machines "www.capricorn.com",
5707 "www2.capricorn.com", "feckless.capricorn.com", etc. Domain names
5708 must contain at least two periods to prevent attempts to match
5709 on top level domains like ".edu". If no domain is specified, then
5710 the browser will only return the cookie to servers on the host the
5711 cookie originated from.
5715 If you provide a cookie path attribute, the browser will check it
5716 against your script's URL before returning the cookie. For example,
5717 if you specify the path "/cgi-bin", then the cookie will be returned
5718 to each of the scripts "/cgi-bin/tally.pl", "/cgi-bin/order.pl",
5719 and "/cgi-bin/customer_service/complain.pl", but not to the script
5720 "/cgi-private/site_admin.pl". By default, path is set to "/", which
5721 causes the cookie to be sent to any CGI script on your site.
5723 =item 4. a "secure" flag
5725 If the "secure" attribute is set, the cookie will only be sent to your
5726 script if the CGI request is occurring on a secure channel, such as SSL.
5730 The interface to HTTP cookies is the B<cookie()> method:
5732 $cookie = $query->cookie(-name=>'sessionID',
5735 -path=>'/cgi-bin/database',
5736 -domain=>'.capricorn.org',
5738 print $query->header(-cookie=>$cookie);
5740 B<cookie()> creates a new cookie. Its parameters include:
5746 The name of the cookie (required). This can be any string at all.
5747 Although browsers limit their cookie names to non-whitespace
5748 alphanumeric characters, CGI.pm removes this restriction by escaping
5749 and unescaping cookies behind the scenes.
5753 The value of the cookie. This can be any scalar value,
5754 array reference, or even associative array reference. For example,
5755 you can store an entire associative array into a cookie this way:
5757 $cookie=$query->cookie(-name=>'family information',
5758 -value=>\%childrens_ages);
5762 The optional partial path for which this cookie will be valid, as described
5767 The optional partial domain for which this cookie will be valid, as described
5772 The optional expiration date for this cookie. The format is as described
5773 in the section on the B<header()> method:
5775 "+1h" one hour from now
5779 If set to true, this cookie will only be used within a secure
5784 The cookie created by cookie() must be incorporated into the HTTP
5785 header within the string returned by the header() method:
5787 print $query->header(-cookie=>$my_cookie);
5789 To create multiple cookies, give header() an array reference:
5791 $cookie1 = $query->cookie(-name=>'riddle_name',
5792 -value=>"The Sphynx's Question");
5793 $cookie2 = $query->cookie(-name=>'answers',
5795 print $query->header(-cookie=>[$cookie1,$cookie2]);
5797 To retrieve a cookie, request it by name by calling cookie()
5798 method without the B<-value> parameter:
5802 %answers = $query->cookie(-name=>'answers');
5803 # $query->cookie('answers') will work too!
5805 The cookie and CGI namespaces are separate. If you have a parameter
5806 named 'answers' and a cookie named 'answers', the values retrieved by
5807 param() and cookie() are independent of each other. However, it's
5808 simple to turn a CGI parameter into a cookie, and vice-versa:
5810 # turn a CGI parameter into a cookie
5811 $c=$q->cookie(-name=>'answers',-value=>[$q->param('answers')]);
5813 $q->param(-name=>'answers',-value=>[$q->cookie('answers')]);
5815 See the B<cookie.cgi> example script for some ideas on how to use
5816 cookies effectively.
5818 =head1 WORKING WITH FRAMES
5820 It's possible for CGI.pm scripts to write into several browser panels
5821 and windows using the HTML 4 frame mechanism. There are three
5822 techniques for defining new frames programmatically:
5826 =item 1. Create a <Frameset> document
5828 After writing out the HTTP header, instead of creating a standard
5829 HTML document using the start_html() call, create a <FRAMESET>
5830 document that defines the frames on the page. Specify your script(s)
5831 (with appropriate parameters) as the SRC for each of the frames.
5833 There is no specific support for creating <FRAMESET> sections
5834 in CGI.pm, but the HTML is very simple to write. See the frame
5835 documentation in Netscape's home pages for details
5837 http://home.netscape.com/assist/net_sites/frames.html
5839 =item 2. Specify the destination for the document in the HTTP header
5841 You may provide a B<-target> parameter to the header() method:
5843 print $q->header(-target=>'ResultsWindow');
5845 This will tell the browser to load the output of your script into the
5846 frame named "ResultsWindow". If a frame of that name doesn't already
5847 exist, the browser will pop up a new window and load your script's
5848 document into that. There are a number of magic names that you can
5849 use for targets. See the frame documents on Netscape's home pages for
5852 =item 3. Specify the destination for the document in the <FORM> tag
5854 You can specify the frame to load in the FORM tag itself. With
5855 CGI.pm it looks like this:
5857 print $q->start_form(-target=>'ResultsWindow');
5859 When your script is reinvoked by the form, its output will be loaded
5860 into the frame named "ResultsWindow". If one doesn't already exist
5861 a new window will be created.
5865 The script "frameset.cgi" in the examples directory shows one way to
5866 create pages in which the fill-out form and the response live in
5867 side-by-side frames.
5869 =head1 LIMITED SUPPORT FOR CASCADING STYLE SHEETS
5871 CGI.pm has limited support for HTML3's cascading style sheets (css).
5872 To incorporate a stylesheet into your document, pass the
5873 start_html() method a B<-style> parameter. The value of this
5874 parameter may be a scalar, in which case it is incorporated directly
5875 into a <STYLE> section, or it may be a hash reference. In the latter
5876 case you should provide the hash with one or more of B<-src> or
5877 B<-code>. B<-src> points to a URL where an externally-defined
5878 stylesheet can be found. B<-code> points to a scalar value to be
5879 incorporated into a <STYLE> section. Style definitions in B<-code>
5880 override similarly-named ones in B<-src>, hence the name "cascading."
5882 You may also specify the type of the stylesheet by adding the optional
5883 B<-type> parameter to the hash pointed to by B<-style>. If not
5884 specified, the style defaults to 'text/css'.
5886 To refer to a style within the body of your document, add the
5887 B<-class> parameter to any HTML element:
5889 print h1({-class=>'Fancy'},'Welcome to the Party');
5891 Or define styles on the fly with the B<-style> parameter:
5893 print h1({-style=>'Color: red;'},'Welcome to Hell');
5895 You may also use the new B<span()> element to apply a style to a
5898 print span({-style=>'Color: red;'},
5899 h1('Welcome to Hell'),
5900 "Where did that handbasket get to?"
5903 Note that you must import the ":html3" definitions to have the
5904 B<span()> method available. Here's a quick and dirty example of using
5905 CSS's. See the CSS specification at
5906 http://www.w3.org/pub/WWW/TR/Wd-css-1.html for more information.
5908 use CGI qw/:standard :html3/;
5910 #here's a stylesheet incorporated directly into the page
5920 font-family: sans-serif;
5926 print start_html( -title=>'CGI with Style',
5927 -style=>{-src=>'http://www.capricorn.com/style/st1.css',
5930 print h1('CGI with Style'),
5932 "Better read the cascading style sheet spec before playing with this!"),
5933 span({-style=>'color: magenta'},
5934 "Look Mom, no hands!",
5940 Pass an array reference to B<-style> in order to incorporate multiple
5941 stylesheets into your document.
5945 If you are running the script from the command line or in the perl
5946 debugger, you can pass the script a list of keywords or
5947 parameter=value pairs on the command line or from standard input (you
5948 don't have to worry about tricking your script into reading from
5949 environment variables). You can pass keywords like this:
5951 your_script.pl keyword1 keyword2 keyword3
5955 your_script.pl keyword1+keyword2+keyword3
5959 your_script.pl name1=value1 name2=value2
5963 your_script.pl name1=value1&name2=value2
5965 To turn off this feature, use the -no_debug pragma.
5967 To test the POST method, you may enable full debugging with the -debug
5968 pragma. This will allow you to feed newline-delimited name=value
5969 pairs to the script on standard input.
5971 When debugging, you can use quotes and backslashes to escape
5972 characters in the familiar shell manner, letting you place
5973 spaces and other funny characters in your parameter=value
5976 your_script.pl "name1='I am a long value'" "name2=two\ words"
5978 =head2 DUMPING OUT ALL THE NAME/VALUE PAIRS
5980 The Dump() method produces a string consisting of all the query's
5981 name/value pairs formatted nicely as a nested list. This is useful
5982 for debugging purposes:
5987 Produces something that looks like:
6001 As a shortcut, you can interpolate the entire CGI object into a string
6002 and it will be replaced with the a nice HTML dump shown above:
6005 print "<H2>Current Values</H2> $query\n";
6007 =head1 FETCHING ENVIRONMENT VARIABLES
6009 Some of the more useful environment variables can be fetched
6010 through this interface. The methods are as follows:
6016 Return a list of MIME types that the remote browser accepts. If you
6017 give this method a single argument corresponding to a MIME type, as in
6018 $query->Accept('text/html'), it will return a floating point value
6019 corresponding to the browser's preference for this type from 0.0
6020 (don't want) to 1.0. Glob types (e.g. text/*) in the browser's accept
6021 list are handled correctly.
6023 Note that the capitalization changed between version 2.43 and 2.44 in
6024 order to avoid conflict with Perl's accept() function.
6026 =item B<raw_cookie()>
6028 Returns the HTTP_COOKIE variable, an HTTP extension implemented by
6029 Netscape browsers version 1.1 and higher, and all versions of Internet
6030 Explorer. Cookies have a special format, and this method call just
6031 returns the raw form (?cookie dough). See cookie() for ways of
6032 setting and retrieving cooked cookies.
6034 Called with no parameters, raw_cookie() returns the packed cookie
6035 structure. You can separate it into individual cookies by splitting
6036 on the character sequence "; ". Called with the name of a cookie,
6037 retrieves the B<unescaped> form of the cookie. You can use the
6038 regular cookie() method to get the names, or use the raw_fetch()
6039 method from the CGI::Cookie module.
6041 =item B<user_agent()>
6043 Returns the HTTP_USER_AGENT variable. If you give
6044 this method a single argument, it will attempt to
6045 pattern match on it, allowing you to do something
6046 like $query->user_agent(netscape);
6048 =item B<path_info()>
6050 Returns additional path information from the script URL.
6051 E.G. fetching /cgi-bin/your_script/additional/stuff will result in
6052 $query->path_info() returning "/additional/stuff".
6054 NOTE: The Microsoft Internet Information Server
6055 is broken with respect to additional path information. If
6056 you use the Perl DLL library, the IIS server will attempt to
6057 execute the additional path information as a Perl script.
6058 If you use the ordinary file associations mapping, the
6059 path information will be present in the environment,
6060 but incorrect. The best thing to do is to avoid using additional
6061 path information in CGI scripts destined for use with IIS.
6063 =item B<path_translated()>
6065 As per path_info() but returns the additional
6066 path information translated into a physical path, e.g.
6067 "/usr/local/etc/httpd/htdocs/additional/stuff".
6069 The Microsoft IIS is broken with respect to the translated
6072 =item B<remote_host()>
6074 Returns either the remote host name or IP address.
6075 if the former is unavailable.
6077 =item B<script_name()>
6078 Return the script name as a partial URL, for self-refering
6083 Return the URL of the page the browser was viewing
6084 prior to fetching your script. Not available for all
6087 =item B<auth_type ()>
6089 Return the authorization/verification method in use for this
6092 =item B<server_name ()>
6094 Returns the name of the server, usually the machine's host
6097 =item B<virtual_host ()>
6099 When using virtual hosts, returns the name of the host that
6100 the browser attempted to contact
6102 =item B<server_software ()>
6104 Returns the server software and version number.
6106 =item B<remote_user ()>
6108 Return the authorization/verification name used for user
6109 verification, if this script is protected.
6111 =item B<user_name ()>
6113 Attempt to obtain the remote user's name, using a variety of different
6114 techniques. This only works with older browsers such as Mosaic.
6115 Newer browsers do not report the user name for privacy reasons!
6117 =item B<request_method()>
6119 Returns the method used to access your script, usually
6120 one of 'POST', 'GET' or 'HEAD'.
6122 =item B<content_type()>
6124 Returns the content_type of data submitted in a POST, generally
6125 multipart/form-data or application/x-www-form-urlencoded
6129 Called with no arguments returns the list of HTTP environment
6130 variables, including such things as HTTP_USER_AGENT,
6131 HTTP_ACCEPT_LANGUAGE, and HTTP_ACCEPT_CHARSET, corresponding to the
6132 like-named HTTP header fields in the request. Called with the name of
6133 an HTTP header field, returns its value. Capitalization and the use
6134 of hyphens versus underscores are not significant.
6136 For example, all three of these examples are equivalent:
6138 $requested_language = $q->http('Accept-language');
6139 $requested_language = $q->http('Accept_language');
6140 $requested_language = $q->http('HTTP_ACCEPT_LANGUAGE');
6144 The same as I<http()>, but operates on the HTTPS environment variables
6145 present when the SSL protocol is in effect. Can be used to determine
6146 whether SSL is turned on.
6150 =head1 USING NPH SCRIPTS
6152 NPH, or "no-parsed-header", scripts bypass the server completely by
6153 sending the complete HTTP header directly to the browser. This has
6154 slight performance benefits, but is of most use for taking advantage
6155 of HTTP extensions that are not directly supported by your server,
6156 such as server push and PICS headers.
6158 Servers use a variety of conventions for designating CGI scripts as
6159 NPH. Many Unix servers look at the beginning of the script's name for
6160 the prefix "nph-". The Macintosh WebSTAR server and Microsoft's
6161 Internet Information Server, in contrast, try to decide whether a
6162 program is an NPH script by examining the first line of script output.
6165 CGI.pm supports NPH scripts with a special NPH mode. When in this
6166 mode, CGI.pm will output the necessary extra header information when
6167 the header() and redirect() methods are
6170 The Microsoft Internet Information Server requires NPH mode. As of version
6171 2.30, CGI.pm will automatically detect when the script is running under IIS
6172 and put itself into this mode. You do not need to do this manually, although
6173 it won't hurt anything if you do.
6175 There are a number of ways to put CGI.pm into NPH mode:
6179 =item In the B<use> statement
6181 Simply add the "-nph" pragmato the list of symbols to be imported into
6184 use CGI qw(:standard -nph)
6186 =item By calling the B<nph()> method:
6188 Call B<nph()> with a non-zero parameter at any point after using CGI.pm in your program.
6192 =item By using B<-nph> parameters in the B<header()> and B<redirect()> statements:
6194 print $q->header(-nph=>1);
6200 CGI.pm provides three simple functions for producing multipart
6201 documents of the type needed to implement server push. These
6202 functions were graciously provided by Ed Jordan <ed@fidalgo.net>. To
6203 import these into your namespace, you must import the ":push" set.
6204 You are also advised to put the script into NPH mode and to set $| to
6205 1 to avoid buffering problems.
6207 Here is a simple script that demonstrates server push:
6209 #!/usr/local/bin/perl
6210 use CGI qw/:push -nph/;
6212 print multipart_init(-boundary=>'----------------here we go!');
6214 print multipart_start(-type=>'text/plain'),
6215 "The current time is ",scalar(localtime),"\n",
6220 This script initializes server push by calling B<multipart_init()>.
6221 It then enters an infinite loop in which it begins a new multipart
6222 section by calling B<multipart_start()>, prints the current local time,
6223 and ends a multipart section with B<multipart_end()>. It then sleeps
6224 a second, and begins again.
6228 =item multipart_init()
6230 multipart_init(-boundary=>$boundary);
6232 Initialize the multipart system. The -boundary argument specifies
6233 what MIME boundary string to use to separate parts of the document.
6234 If not provided, CGI.pm chooses a reasonable boundary for you.
6236 =item multipart_start()
6238 multipart_start(-type=>$type)
6240 Start a new part of the multipart document using the specified MIME
6241 type. If not specified, text/html is assumed.
6243 =item multipart_end()
6247 End a part. You must remember to call multipart_end() once for each
6252 Users interested in server push applications should also have a look
6253 at the CGI::Push module.
6255 =head1 Avoiding Denial of Service Attacks
6257 A potential problem with CGI.pm is that, by default, it attempts to
6258 process form POSTings no matter how large they are. A wily hacker
6259 could attack your site by sending a CGI script a huge POST of many
6260 megabytes. CGI.pm will attempt to read the entire POST into a
6261 variable, growing hugely in size until it runs out of memory. While
6262 the script attempts to allocate the memory the system may slow down
6263 dramatically. This is a form of denial of service attack.
6265 Another possible attack is for the remote user to force CGI.pm to
6266 accept a huge file upload. CGI.pm will accept the upload and store it
6267 in a temporary directory even if your script doesn't expect to receive
6268 an uploaded file. CGI.pm will delete the file automatically when it
6269 terminates, but in the meantime the remote user may have filled up the
6270 server's disk space, causing problems for other programs.
6272 The best way to avoid denial of service attacks is to limit the amount
6273 of memory, CPU time and disk space that CGI scripts can use. Some Web
6274 servers come with built-in facilities to accomplish this. In other
6275 cases, you can use the shell I<limit> or I<ulimit>
6276 commands to put ceilings on CGI resource usage.
6279 CGI.pm also has some simple built-in protections against denial of
6280 service attacks, but you must activate them before you can use them.
6281 These take the form of two global variables in the CGI name space:
6285 =item B<$CGI::POST_MAX>
6287 If set to a non-negative integer, this variable puts a ceiling
6288 on the size of POSTings, in bytes. If CGI.pm detects a POST
6289 that is greater than the ceiling, it will immediately exit with an error
6290 message. This value will affect both ordinary POSTs and
6291 multipart POSTs, meaning that it limits the maximum size of file
6292 uploads as well. You should set this to a reasonably high
6293 value, such as 1 megabyte.
6295 =item B<$CGI::DISABLE_UPLOADS>
6297 If set to a non-zero value, this will disable file uploads
6298 completely. Other fill-out form values will work as usual.
6302 You can use these variables in either of two ways.
6306 =item B<1. On a script-by-script basis>
6308 Set the variable at the top of the script, right after the "use" statement:
6310 use CGI qw/:standard/;
6311 use CGI::Carp 'fatalsToBrowser';
6312 $CGI::POST_MAX=1024 * 100; # max 100K posts
6313 $CGI::DISABLE_UPLOADS = 1; # no uploads
6315 =item B<2. Globally for all scripts>
6317 Open up CGI.pm, find the definitions for $POST_MAX and
6318 $DISABLE_UPLOADS, and set them to the desired values. You'll
6319 find them towards the top of the file in a subroutine named
6320 initialize_globals().
6324 An attempt to send a POST larger than $POST_MAX bytes will cause
6325 I<param()> to return an empty CGI parameter list. You can test for
6326 this event by checking I<cgi_error()>, either after you create the CGI
6327 object or, if you are using the function-oriented interface, call
6328 <param()> for the first time. If the POST was intercepted, then
6329 cgi_error() will return the message "413 POST too large".
6331 This error message is actually defined by the HTTP protocol, and is
6332 designed to be returned to the browser as the CGI script's status
6335 $uploaded_file = param('upload');
6336 if (!$uploaded_file && cgi_error()) {
6337 print header(-status=>cgi_error());
6341 However it isn't clear that any browser currently knows what to do
6342 with this status code. It might be better just to create an
6343 HTML page that warns the user of the problem.
6345 =head1 COMPATIBILITY WITH CGI-LIB.PL
6347 To make it easier to port existing programs that use cgi-lib.pl the
6348 compatibility routine "ReadParse" is provided. Porting is simple:
6351 require "cgi-lib.pl";
6353 print "The value of the antique is $in{antique}.\n";
6358 print "The value of the antique is $in{antique}.\n";
6360 CGI.pm's ReadParse() routine creates a tied variable named %in,
6361 which can be accessed to obtain the query variables. Like
6362 ReadParse, you can also provide your own variable. Infrequently
6363 used features of ReadParse, such as the creation of @in and $in
6364 variables, are not supported.
6366 Once you use ReadParse, you can retrieve the query object itself
6370 print $q->textfield(-name=>'wow',
6371 -value=>'does this really work?');
6373 This allows you to start using the more interesting features
6374 of CGI.pm without rewriting your old scripts from scratch.
6376 =head1 AUTHOR INFORMATION
6378 Copyright 1995-1998, Lincoln D. Stein. All rights reserved.
6380 This library is free software; you can redistribute it and/or modify
6381 it under the same terms as Perl itself.
6383 Address bug reports and comments to: lstein@cshl.org. When sending
6384 bug reports, please provide the version of CGI.pm, the version of
6385 Perl, the name and version of your Web server, and the name and
6386 version of the operating system you are using. If the problem is even
6387 remotely browser dependent, please provide information about the
6388 affected browers as well.
6392 Thanks very much to:
6396 =item Matt Heffron (heffron@falstaff.css.beckman.com)
6398 =item James Taylor (james.taylor@srs.gov)
6400 =item Scott Anguish <sanguish@digifix.com>
6402 =item Mike Jewell (mlj3u@virginia.edu)
6404 =item Timothy Shimmin (tes@kbs.citri.edu.au)
6406 =item Joergen Haegg (jh@axis.se)
6408 =item Laurent Delfosse (delfosse@delfosse.com)
6410 =item Richard Resnick (applepi1@aol.com)
6412 =item Craig Bishop (csb@barwonwater.vic.gov.au)
6414 =item Tony Curtis (tc@vcpc.univie.ac.at)
6416 =item Tim Bunce (Tim.Bunce@ig.co.uk)
6418 =item Tom Christiansen (tchrist@convex.com)
6420 =item Andreas Koenig (k@franz.ww.TU-Berlin.DE)
6422 =item Tim MacKenzie (Tim.MacKenzie@fulcrum.com.au)
6424 =item Kevin B. Hendricks (kbhend@dogwood.tyler.wm.edu)
6426 =item Stephen Dahmen (joyfire@inxpress.net)
6428 =item Ed Jordan (ed@fidalgo.net)
6430 =item David Alan Pisoni (david@cnation.com)
6432 =item Doug MacEachern (dougm@opengroup.org)
6434 =item Robin Houston (robin@oneworld.org)
6436 =item ...and many many more...
6438 for suggestions and bug fixes.
6442 =head1 A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT
6445 #!/usr/local/bin/perl
6451 print $query->header;
6452 print $query->start_html("Example CGI.pm Form");
6453 print "<H1> Example CGI.pm Form</H1>\n";
6454 &print_prompt($query);
6457 print $query->end_html;
6462 print $query->start_form;
6463 print "<EM>What's your name?</EM><BR>";
6464 print $query->textfield('name');
6465 print $query->checkbox('Not my real name');
6467 print "<P><EM>Where can you find English Sparrows?</EM><BR>";
6468 print $query->checkbox_group(
6469 -name=>'Sparrow locations',
6470 -values=>[England,France,Spain,Asia,Hoboken],
6472 -defaults=>[England,Asia]);
6474 print "<P><EM>How far can they fly?</EM><BR>",
6475 $query->radio_group(
6477 -values=>['10 ft','1 mile','10 miles','real far'],
6478 -default=>'1 mile');
6480 print "<P><EM>What's your favorite color?</EM> ";
6481 print $query->popup_menu(-name=>'Color',
6482 -values=>['black','brown','red','yellow'],
6485 print $query->hidden('Reference','Monty Python and the Holy Grail');
6487 print "<P><EM>What have you got there?</EM><BR>";
6488 print $query->scrolling_list(
6489 -name=>'possessions',
6490 -values=>['A Coconut','A Grail','An Icon',
6491 'A Sword','A Ticket'],
6495 print "<P><EM>Any parting comments?</EM><BR>";
6496 print $query->textarea(-name=>'Comments',
6500 print "<P>",$query->reset;
6501 print $query->submit('Action','Shout');
6502 print $query->submit('Action','Scream');
6503 print $query->endform;
6511 print "<H2>Here are the current settings in this form</H2>";
6513 foreach $key ($query->param) {
6514 print "<STRONG>$key</STRONG> -> ";
6515 @values = $query->param($key);
6516 print join(", ",@values),"<BR>\n";
6523 <ADDRESS>Lincoln D. Stein</ADDRESS><BR>
6524 <A HREF="/">Home Page</A>
6530 This module has grown large and monolithic. Furthermore it's doing many
6531 things, such as handling URLs, parsing CGI input, writing HTML, etc., that
6532 are also done in the LWP modules. It should be discarded in favor of
6533 the CGI::* modules, but somehow I continue to work on it.
6535 Note that the code is truly contorted in order to avoid spurious
6536 warnings when programs are run with the B<-w> switch.
6540 L<CGI::Carp>, L<URI::URL>, L<CGI::Request>, L<CGI::MiniSvr>,
6541 L<CGI::Base>, L<CGI::Form>, L<CGI::Push>, L<CGI::Fast>,