5 # See the bottom of this file for the POD documentation. Search for the
8 # You can run this file through either pod2man or pod2html to produce pretty
9 # documentation in manual or html file format (these utilities are part of the
10 # Perl 5 distribution).
12 # Copyright 1995-1998 Lincoln D. Stein. All rights reserved.
13 # It may be used and modified freely, but I do request that this copyright
14 # notice remain attached to the file. You may modify this module as you
15 # wish, but if you redistribute a modified version, please attach a note
16 # listing the modifications you have made.
18 # The most recent version and complete docs are available at:
19 # http://stein.cshl.org/WWW/software/CGI/
21 $CGI::revision = '$Id: CGI.pm,v 1.112 2003/04/28 13:35:56 lstein Exp $';
24 # HARD-CODED LOCATION FOR FILE UPLOAD TEMPORARY FILES.
25 # UNCOMMENT THIS ONLY IF YOU KNOW WHAT YOU'RE DOING.
26 # $CGITempFile::TMPDIRECTORY = '/usr/tmp';
27 use CGI::Util qw(rearrange make_attributes unescape escape expires);
29 #use constant XHTML_DTD => ['-//W3C//DTD XHTML Basic 1.0//EN',
30 # 'http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd'];
32 use constant XHTML_DTD => ['-//W3C//DTD XHTML 1.0 Transitional//EN',
33 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'];
37 $TAINTED = substr("$0$^X",0,0);
42 $MOD_PERL = 0; # no mod_perl by default
44 # >>>>> Here are some globals that you might want to adjust <<<<<<
45 sub initialize_globals {
46 # Set this to 1 to enable copious autoloader debugging messages
49 # Set this to 1 to generate XTML-compatible output
52 # Change this to the preferred DTD to print in start_html()
53 # or use default_dtd('text of DTD to use');
54 $DEFAULT_DTD = [ '-//W3C//DTD HTML 4.01 Transitional//EN',
55 'http://www.w3.org/TR/html4/loose.dtd' ] ;
57 # Set this to 1 to enable NOSTICKY scripts
59 # 1) use CGI qw(-nosticky)
60 # 2) $CGI::nosticky(1)
63 # Set this to 1 to enable NPH scripts
67 # 3) print header(-nph=>1)
70 # Set this to 1 to enable debugging from @ARGV
71 # Set to 2 to enable debugging from STDIN
74 # Set this to 1 to make the temporary files created
75 # during file uploads safe from prying eyes
77 # 1) use CGI qw(:private_tempfiles)
78 # 2) CGI::private_tempfiles(1);
79 $PRIVATE_TEMPFILES = 0;
81 # Set this to 1 to cause files uploaded in multipart documents
82 # to be closed, instead of caching the file handle
84 # 1) use CGI qw(:close_upload_files)
85 # 2) $CGI::close_upload_files(1);
86 # Uploads with many files run out of file handles.
87 # Also, for performance, since the file is already on disk,
88 # it can just be renamed, instead of read and written.
89 $CLOSE_UPLOAD_FILES = 0;
91 # Set this to a positive value to limit the size of a POSTing
92 # to a certain number of bytes:
95 # Change this to 1 to disable uploads entirely:
98 # Automatically determined -- don't change
101 # Change this to 1 to suppress redundant HTTP headers
104 # separate the name=value pairs by semicolons rather than ampersands
105 $USE_PARAM_SEMICOLONS = 1;
107 # Do not include undefined params parsed from query string
108 # use CGI qw(-no_undef_params);
109 $NO_UNDEF_PARAMS = 0;
111 # Other globals that you shouldn't worry about.
116 undef $QUERY_CHARSET;
117 undef %QUERY_FIELDNAMES;
119 # prevent complaints by mod_perl
123 # ------------------ START OF THE LIBRARY ------------
126 initialize_globals();
128 # FIGURE OUT THE OS WE'RE RUNNING UNDER
129 # Some systems support the $^O variable. If not
130 # available then require() the Config library
134 $OS = $Config::Config{'osname'};
137 if ($OS =~ /^MSWin/i) {
139 } elsif ($OS =~ /^VMS/i) {
141 } elsif ($OS =~ /^dos/i) {
143 } elsif ($OS =~ /^MacOS/i) {
145 } elsif ($OS =~ /^os2/i) {
147 } elsif ($OS =~ /^epoc/i) {
149 } elsif ($OS =~ /^cygwin/i) {
155 # Some OS logic. Binary mode enabled on DOS, NT and VMS
156 $needs_binmode = $OS=~/^(WINDOWS|DOS|OS2|MSWin|CYGWIN)/;
158 # This is the default class for the CGI object to use when all else fails.
159 $DefaultClass = 'CGI' unless defined $CGI::DefaultClass;
161 # This is where to look for autoloaded routines.
162 $AutoloadClass = $DefaultClass unless defined $CGI::AutoloadClass;
164 # The path separator is a slash, backslash or semicolon, depending
167 UNIX => '/', OS2 => '\\', EPOC => '/', CYGWIN => '/',
168 WINDOWS => '\\', DOS => '\\', MACINTOSH => ':', VMS => '/'
171 # This no longer seems to be necessary
172 # Turn on NPH scripts by default when running under IIS server!
173 # $NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
174 $IIS++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
176 # Turn on special checking for Doug MacEachern's modperl
177 if (exists $ENV{MOD_PERL}) {
178 eval "require mod_perl";
179 # mod_perl handlers may run system() on scripts using CGI.pm;
180 # Make sure so we don't get fooled by inherited $ENV{MOD_PERL}
181 if (defined $mod_perl::VERSION) {
182 if ($mod_perl::VERSION >= 1.99) {
184 require Apache::RequestRec;
185 require Apache::RequestUtil;
194 # Turn on special checking for ActiveState's PerlEx
195 $PERLEX++ if defined($ENV{'GATEWAY_INTERFACE'}) && $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-PerlEx/;
197 # Define the CRLF sequence. I can't use a simple "\r\n" because the meaning
198 # of "\n" is different on different OS's (sometimes it generates CRLF, sometimes LF
199 # and sometimes CR). The most popular VMS web server
200 # doesn't accept CRLF -- instead it wants a LR. EBCDIC machines don't
201 # use ASCII, so \015\012 means something different. I find this all
203 $EBCDIC = "\t" ne "\011";
212 if ($needs_binmode) {
213 $CGI::DefaultClass->binmode(main::STDOUT);
214 $CGI::DefaultClass->binmode(main::STDIN);
215 $CGI::DefaultClass->binmode(main::STDERR);
219 ':html2'=>['h1'..'h6',qw/p br hr ol ul li dl dt dd menu code var strong em
220 tt u i b blockquote pre img a address cite samp dfn html head
221 base body Link nextid title meta kbd start_html end_html
222 input Select option comment charset escapeHTML/],
223 ':html3'=>[qw/div table caption th td TR Tr sup Sub strike applet Param
224 embed basefont style span layer ilayer font frameset frame script small big/],
225 ':html4'=>[qw/abbr acronym bdo col colgroup del fieldset iframe
226 ins label legend noframes noscript object optgroup Q
228 ':netscape'=>[qw/blink fontsize center/],
229 ':form'=>[qw/textfield textarea filefield password_field hidden checkbox checkbox_group
230 submit reset defaults radio_group popup_menu button autoEscape
231 scrolling_list image_button start_form end_form startform endform
232 start_multipart_form end_multipart_form isindex tmpFileName uploadInfo URL_ENCODED MULTIPART/],
233 ':cgi'=>[qw/param upload path_info path_translated url self_url script_name cookie Dump
234 raw_cookie request_method query_string Accept user_agent remote_host content_type
235 remote_addr referer server_name server_software server_port server_protocol
236 virtual_host remote_ident auth_type http
237 save_parameters restore_parameters param_fetch
238 remote_user user_name header redirect import_names put
239 Delete Delete_all url_param cgi_error/],
240 ':ssl' => [qw/https/],
241 ':imagemap' => [qw/Area Map/],
242 ':cgi-lib' => [qw/ReadParse PrintHeader HtmlTop HtmlBot SplitParam Vars/],
243 ':html' => [qw/:html2 :html3 :html4 :netscape/],
244 ':standard' => [qw/:html2 :html3 :html4 :form :cgi/],
245 ':push' => [qw/multipart_init multipart_start multipart_end multipart_final/],
246 ':all' => [qw/:html2 :html3 :netscape :form :cgi :internal :html4/]
249 # to import symbols into caller
253 # This causes modules to clash.
257 $self->_setup_symbols(@_);
258 my ($callpack, $callfile, $callline) = caller;
260 # To allow overriding, search through the packages
261 # Till we find one in which the correct subroutine is defined.
262 my @packages = ($self,@{"$self\:\:ISA"});
263 foreach $sym (keys %EXPORT) {
265 my $def = ${"$self\:\:AutoloadClass"} || $DefaultClass;
266 foreach $pck (@packages) {
267 if (defined(&{"$pck\:\:$sym"})) {
272 *{"${callpack}::$sym"} = \&{"$def\:\:$sym"};
278 $pack->_setup_symbols('-compile',@_);
283 return ("start_$1","end_$1") if $tag=~/^(?:\*|start_|end_)(.+)/;
285 return ($tag) unless $EXPORT_TAGS{$tag};
286 foreach (@{$EXPORT_TAGS{$tag}}) {
287 push(@r,&expand_tags($_));
293 # The new routine. This will check the current environment
294 # for an existing query string, and initialize itself, if so.
297 my($class,@initializer) = @_;
299 bless $self,ref $class || $class || $DefaultClass;
300 if (ref($initializer[0])
301 && (UNIVERSAL::isa($initializer[0],'Apache')
303 UNIVERSAL::isa($initializer[0],'Apache::RequestRec')
305 $self->r(shift @initializer);
308 $self->r(Apache->request) unless $self->r;
310 if ($MOD_PERL == 1) {
311 $r->register_cleanup(\&CGI::_reset_globals);
314 # XXX: once we have the new API
315 # will do a real PerlOptions -SetupEnv check
316 $r->subprocess_env unless exists $ENV{REQUEST_METHOD};
317 $r->pool->cleanup_register(\&CGI::_reset_globals);
321 $self->_reset_globals if $PERLEX;
322 $self->init(@initializer);
326 # We provide a DESTROY method so that the autoloader
327 # doesn't bother trying to find it.
332 my $r = $self->{'.r'};
333 $self->{'.r'} = shift if @_;
338 # Returns the value(s)of a named parameter.
339 # If invoked in a list context, returns the
340 # entire list. Otherwise returns the first
341 # member of the list.
342 # If name is not provided, return a list of all
343 # the known parameters names available.
344 # If more than one argument is provided, the
345 # second and subsequent arguments are used to
346 # set the value of the parameter.
349 my($self,@p) = self_or_default(@_);
350 return $self->all_parameters unless @p;
351 my($name,$value,@other);
353 # For compatibility between old calling style and use_named_parameters() style,
354 # we have to special case for a single parameter present.
356 ($name,$value,@other) = rearrange([NAME,[DEFAULT,VALUE,VALUES]],@p);
359 if (substr($p[0],0,1) eq '-') {
360 @values = defined($value) ? (ref($value) && ref($value) eq 'ARRAY' ? @{$value} : $value) : ();
362 foreach ($value,@other) {
363 push(@values,$_) if defined($_);
366 # If values is provided, then we set it.
368 $self->add_parameter($name);
369 $self->{$name}=[@values];
375 return unless defined($name) && $self->{$name};
376 return wantarray ? @{$self->{$name}} : $self->{$name}->[0];
379 sub self_or_default {
380 return @_ if defined($_[0]) && (!ref($_[0])) &&($_[0] eq 'CGI');
381 unless (defined($_[0]) &&
382 (ref($_[0]) eq 'CGI' || UNIVERSAL::isa($_[0],'CGI')) # slightly optimized for common case
384 $Q = $CGI::DefaultClass->new unless defined($Q);
387 return wantarray ? @_ : $Q;
391 local $^W=0; # prevent a warning
392 if (defined($_[0]) &&
393 (substr(ref($_[0]),0,3) eq 'CGI'
394 || UNIVERSAL::isa($_[0],'CGI'))) {
397 return ($DefaultClass,@_);
401 ########################################
402 # THESE METHODS ARE MORE OR LESS PRIVATE
403 # GO TO THE __DATA__ SECTION TO SEE MORE
405 ########################################
407 # Initialize the query object from the environment.
408 # If a parameter list is found, this object will be set
409 # to an associative array in which parameter names are keys
410 # and the values are stored as lists
411 # If a keyword list is found, this method creates a bogus
412 # parameter list with the single parameter 'keywords'.
416 my($query_string,$meth,$content_length,$fh,@lines) = ('','','','');
418 my $initializer = shift; # for backward compatibility
421 # set autoescaping on by default
422 $self->{'escape'} = 1;
424 # if we get called more than once, we want to initialize
425 # ourselves from the original query (which may be gone
426 # if it was read from STDIN originally.)
427 if (defined(@QUERY_PARAM) && !defined($initializer)) {
428 foreach (@QUERY_PARAM) {
429 $self->param('-name'=>$_,'-value'=>$QUERY_PARAM{$_});
431 $self->charset($QUERY_CHARSET);
432 $self->{'.fieldnames'} = {%QUERY_FIELDNAMES};
436 $meth=$ENV{'REQUEST_METHOD'} if defined($ENV{'REQUEST_METHOD'});
437 $content_length = defined($ENV{'CONTENT_LENGTH'}) ? $ENV{'CONTENT_LENGTH'} : 0;
439 $fh = to_filehandle($initializer) if $initializer;
441 # set charset to the safe ISO-8859-1
442 $self->charset('ISO-8859-1');
446 # avoid unreasonably large postings
447 if (($POST_MAX > 0) && ($content_length > $POST_MAX)) {
448 $self->cgi_error("413 Request entity too large");
452 # Process multipart postings, but only if the initializer is
455 && defined($ENV{'CONTENT_TYPE'})
456 && $ENV{'CONTENT_TYPE'}=~m|^multipart/form-data|
457 && !defined($initializer)
459 my($boundary) = $ENV{'CONTENT_TYPE'} =~ /boundary=\"?([^\";,]+)\"?/;
460 $self->read_multipart($boundary,$content_length);
464 # If initializer is defined, then read parameters
466 if (defined($initializer)) {
467 if (UNIVERSAL::isa($initializer,'CGI')) {
468 $query_string = $initializer->query_string;
471 if (ref($initializer) && ref($initializer) eq 'HASH') {
472 foreach (keys %$initializer) {
473 $self->param('-name'=>$_,'-value'=>$initializer->{$_});
478 if (defined($fh) && ($fh ne '')) {
484 # massage back into standard format
485 if ("@lines" =~ /=/) {
486 $query_string=join("&",@lines);
488 $query_string=join("+",@lines);
493 # last chance -- treat it as a string
494 $initializer = $$initializer if ref($initializer) eq 'SCALAR';
495 $query_string = $initializer;
500 # If method is GET or HEAD, fetch the query from
502 if ($meth=~/^(GET|HEAD)$/) {
504 $query_string = $self->r->args;
506 $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
507 $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'};
512 if ($meth eq 'POST') {
513 $self->read_from_client(\*STDIN,\$query_string,$content_length,0)
514 if $content_length > 0;
515 # Some people want to have their cake and eat it too!
516 # Uncomment this line to have the contents of the query string
517 # APPENDED to the POST data.
518 # $query_string .= (length($query_string) ? '&' : '') . $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
522 # If $meth is not of GET, POST or HEAD, assume we're being debugged offline.
523 # Check the command line and then the standard input for data.
524 # We use the shellwords package in order to behave the way that
525 # UN*X programmers expect.
526 $query_string = read_from_cmdline() if $DEBUG;
529 # YL: Begin Change for XML handler 10/19/2001
531 && defined($ENV{'CONTENT_TYPE'})
532 && $ENV{'CONTENT_TYPE'} !~ m|^application/x-www-form-urlencoded| ) {
533 my($param) = 'POSTDATA' ;
534 $self->add_parameter($param) ;
535 push (@{$self->{$param}},$query_string);
536 undef $query_string ;
538 # YL: End Change for XML handler 10/19/2001
540 # We now have the query string in hand. We do slightly
541 # different things for keyword lists and parameter lists.
542 if (defined $query_string && length $query_string) {
543 if ($query_string =~ /[&=;]/) {
544 $self->parse_params($query_string);
546 $self->add_parameter('keywords');
547 $self->{'keywords'} = [$self->parse_keywordlist($query_string)];
551 # Special case. Erase everything if there is a field named
553 if ($self->param('.defaults')) {
557 # Associative array containing our defined fieldnames
558 $self->{'.fieldnames'} = {};
559 foreach ($self->param('.cgifields')) {
560 $self->{'.fieldnames'}->{$_}++;
563 # Clear out our default submission button flag if present
564 $self->delete('.submit');
565 $self->delete('.cgifields');
567 $self->save_request unless defined $initializer;
570 # FUNCTIONS TO OVERRIDE:
571 # Turn a string into a filehandle
574 return undef unless $thingy;
575 return $thingy if UNIVERSAL::isa($thingy,'GLOB');
576 return $thingy if UNIVERSAL::isa($thingy,'FileHandle');
579 while (my $package = caller($caller++)) {
580 my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy";
581 return $tmp if defined(fileno($tmp));
587 # send output to the browser
589 my($self,@p) = self_or_default(@_);
593 # print to standard output (for overriding in mod_perl)
599 # get/set last cgi_error
601 my ($self,$err) = self_or_default(@_);
602 $self->{'.cgi_error'} = $err if defined $err;
603 return $self->{'.cgi_error'};
608 # We're going to play with the package globals now so that if we get called
609 # again, we initialize ourselves in exactly the same way. This allows
610 # us to have several of these objects.
611 @QUERY_PARAM = $self->param; # save list of parameters
612 foreach (@QUERY_PARAM) {
613 next unless defined $_;
614 $QUERY_PARAM{$_}=$self->{$_};
616 $QUERY_CHARSET = $self->charset;
617 %QUERY_FIELDNAMES = %{$self->{'.fieldnames'}};
621 my($self,$tosplit) = @_;
622 my(@pairs) = split(/[&;]/,$tosplit);
625 ($param,$value) = split('=',$_,2);
626 next unless defined $param;
627 next if $NO_UNDEF_PARAMS and not defined $value;
628 $value = '' unless defined $value;
629 $param = unescape($param);
630 $value = unescape($value);
631 $self->add_parameter($param);
632 push (@{$self->{$param}},$value);
638 return unless defined $param;
639 push (@{$self->{'.parameters'}},$param)
640 unless defined($self->{$param});
645 return () unless defined($self) && $self->{'.parameters'};
646 return () unless @{$self->{'.parameters'}};
647 return @{$self->{'.parameters'}};
650 # put a filehandle into binary mode (DOS)
652 CORE::binmode($_[1]);
656 my ($self,$tagname) = @_;
659 my (\$q,\$a,\@rest) = self_or_default(\@_);
661 if (ref(\$a) && ref(\$a) eq 'HASH') {
662 my(\@attr) = make_attributes(\$a,\$q->{'escape'});
663 \$attr = " \@attr" if \@attr;
668 if ($tagname=~/start_(\w+)/i) {
669 $func .= qq! return "<\L$1\E\$attr>";} !;
670 } elsif ($tagname=~/end_(\w+)/i) {
671 $func .= qq! return "<\L/$1\E>"; } !;
674 \# return \$XHTML ? "\L<$tagname\E\$attr />" : "\L<$tagname\E\$attr>" unless \@_;
675 return \$XHTML ? "\L<$tagname\E\$attr />" : "\L<$tagname\E\$attr>" unless \@rest && defined(\$rest[0]);
676 my(\$tag,\$untag) = ("\L<$tagname\E\$attr>","\L</$tagname>\E");
677 my \@result = map { "\$tag\$_\$untag" }
678 (ref(\$rest[0]) eq 'ARRAY') ? \@{\$rest[0]} : "\@rest";
686 print STDERR "CGI::AUTOLOAD for $AUTOLOAD\n" if $CGI::AUTOLOAD_DEBUG;
687 my $func = &_compile;
692 my($func) = $AUTOLOAD;
693 my($pack,$func_name);
695 local($1,$2); # this fixes an obscure variable suicide problem.
696 $func=~/(.+)::([^:]+)$/;
697 ($pack,$func_name) = ($1,$2);
698 $pack=~s/::SUPER$//; # fix another obscure problem
699 $pack = ${"$pack\:\:AutoloadClass"} || $CGI::DefaultClass
700 unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"});
702 my($sub) = \%{"$pack\:\:SUBS"};
704 my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"};
705 eval "package $pack; $$auto";
706 croak("$AUTOLOAD: $@") if $@;
707 $$auto = ''; # Free the unneeded storage (but don't undef it!!!)
709 my($code) = $sub->{$func_name};
711 $code = "sub $AUTOLOAD { }" if (!$code and $func_name eq 'DESTROY');
713 (my $base = $func_name) =~ s/^(start_|end_)//i;
714 if ($EXPORT{':any'} ||
717 (%EXPORT_OK || grep(++$EXPORT_OK{$_},&expand_tags(':html')))
718 && $EXPORT_OK{$base}) {
719 $code = $CGI::DefaultClass->_make_tag_func($func_name);
722 croak("Undefined subroutine $AUTOLOAD\n") unless $code;
723 eval "package $pack; $code";
726 croak("$AUTOLOAD: $@");
729 CORE::delete($sub->{$func_name}); #free storage
730 return "$pack\:\:$func_name";
736 return '' unless $value;
737 return $XHTML ? qq( selected="selected") : qq( selected);
743 return '' unless $value;
744 return $XHTML ? qq( checked="checked") : qq( checked);
747 sub _reset_globals { initialize_globals(); }
753 # to avoid reexporting unwanted variables
757 $HEADERS_ONCE++, next if /^[:-]unique_headers$/;
758 $NPH++, next if /^[:-]nph$/;
759 $NOSTICKY++, next if /^[:-]nosticky$/;
760 $DEBUG=0, next if /^[:-]no_?[Dd]ebug$/;
761 $DEBUG=2, next if /^[:-][Dd]ebug$/;
762 $USE_PARAM_SEMICOLONS++, next if /^[:-]newstyle_urls$/;
763 $XHTML++, next if /^[:-]xhtml$/;
764 $XHTML=0, next if /^[:-]no_?xhtml$/;
765 $USE_PARAM_SEMICOLONS=0, next if /^[:-]oldstyle_urls$/;
766 $PRIVATE_TEMPFILES++, next if /^[:-]private_tempfiles$/;
767 $CLOSE_UPLOAD_FILES++, next if /^[:-]close_upload_files$/;
768 $EXPORT{$_}++, next if /^[:-]any$/;
769 $compile++, next if /^[:-]compile$/;
770 $NO_UNDEF_PARAMS++, next if /^[:-]no_undef_params$/;
772 # This is probably extremely evil code -- to be deleted some day.
773 if (/^[-]autoload$/) {
774 my($pkg) = caller(1);
775 *{"${pkg}::AUTOLOAD"} = sub {
776 my($routine) = $AUTOLOAD;
777 $routine =~ s/^.*::/CGI::/;
783 foreach (&expand_tags($_)) {
784 tr/a-zA-Z0-9_//cd; # don't allow weird function names
788 _compile_all(keys %EXPORT) if $compile;
793 my ($self,$charset) = self_or_default(@_);
794 $self->{'.charset'} = $charset if defined $charset;
798 ###############################################################################
799 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
800 ###############################################################################
801 $AUTOLOADED_ROUTINES = ''; # get rid of -w warning
802 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
806 'URL_ENCODED'=> <<'END_OF_FUNC',
807 sub URL_ENCODED { 'application/x-www-form-urlencoded'; }
810 'MULTIPART' => <<'END_OF_FUNC',
811 sub MULTIPART { 'multipart/form-data'; }
814 'SERVER_PUSH' => <<'END_OF_FUNC',
815 sub SERVER_PUSH { 'multipart/x-mixed-replace;boundary="' . shift() . '"'; }
818 'new_MultipartBuffer' => <<'END_OF_FUNC',
819 # Create a new multipart buffer
820 sub new_MultipartBuffer {
821 my($self,$boundary,$length,$filehandle) = @_;
822 return MultipartBuffer->new($self,$boundary,$length,$filehandle);
826 'read_from_client' => <<'END_OF_FUNC',
827 # Read data from a file handle
828 sub read_from_client {
829 my($self, $fh, $buff, $len, $offset) = @_;
830 local $^W=0; # prevent a warning
831 return undef unless defined($fh);
832 return read($fh, $$buff, $len, $offset);
836 'delete' => <<'END_OF_FUNC',
838 # Deletes the named parameter entirely.
841 my($self,@p) = self_or_default(@_);
842 my($name) = rearrange([NAME],@p);
843 my @to_delete = ref($name) eq 'ARRAY' ? @$name : ($name);
845 foreach my $name (@to_delete)
847 CORE::delete $self->{$name};
848 CORE::delete $self->{'.fieldnames'}->{$name};
851 @{$self->{'.parameters'}}=grep { !exists($to_delete{$_}) } $self->param();
852 return wantarray ? () : undef;
856 #### Method: import_names
857 # Import all parameters into the given namespace.
858 # Assumes namespace 'Q' if not specified
860 'import_names' => <<'END_OF_FUNC',
862 my($self,$namespace,$delete) = self_or_default(@_);
863 $namespace = 'Q' unless defined($namespace);
864 die "Can't import names into \"main\"\n" if \%{"${namespace}::"} == \%::;
865 if ($delete || $MOD_PERL || exists $ENV{'FCGI_ROLE'}) {
866 # can anyone find an easier way to do this?
867 foreach (keys %{"${namespace}::"}) {
868 local *symbol = "${namespace}::${_}";
874 my($param,@value,$var);
875 foreach $param ($self->param) {
876 # protect against silly names
877 ($var = $param)=~tr/a-zA-Z0-9_/_/c;
878 $var =~ s/^(?=\d)/_/;
879 local *symbol = "${namespace}::$var";
880 @value = $self->param($param);
887 #### Method: keywords
888 # Keywords acts a bit differently. Calling it in a list context
889 # returns the list of keywords.
890 # Calling it in a scalar context gives you the size of the list.
892 'keywords' => <<'END_OF_FUNC',
894 my($self,@values) = self_or_default(@_);
895 # If values is provided, then we set it.
896 $self->{'keywords'}=[@values] if @values;
897 my(@result) = defined($self->{'keywords'}) ? @{$self->{'keywords'}} : ();
902 # These are some tie() interfaces for compatibility
903 # with Steve Brenner's cgi-lib.pl routines
904 'Vars' => <<'END_OF_FUNC',
909 return %in if wantarray;
914 # These are some tie() interfaces for compatibility
915 # with Steve Brenner's cgi-lib.pl routines
916 'ReadParse' => <<'END_OF_FUNC',
926 return scalar(keys %in);
930 'PrintHeader' => <<'END_OF_FUNC',
932 my($self) = self_or_default(@_);
933 return $self->header();
937 'HtmlTop' => <<'END_OF_FUNC',
939 my($self,@p) = self_or_default(@_);
940 return $self->start_html(@p);
944 'HtmlBot' => <<'END_OF_FUNC',
946 my($self,@p) = self_or_default(@_);
947 return $self->end_html(@p);
951 'SplitParam' => <<'END_OF_FUNC',
954 my (@params) = split ("\0", $param);
955 return (wantarray ? @params : $params[0]);
959 'MethGet' => <<'END_OF_FUNC',
961 return request_method() eq 'GET';
965 'MethPost' => <<'END_OF_FUNC',
967 return request_method() eq 'POST';
971 'TIEHASH' => <<'END_OF_FUNC',
975 if (ref($arg) && UNIVERSAL::isa($arg,'CGI')) {
978 return $Q ||= $class->new(@_);
982 'STORE' => <<'END_OF_FUNC',
987 my @vals = index($vals,"\0")!=-1 ? split("\0",$vals) : $vals;
988 $self->param(-name=>$tag,-value=>\@vals);
992 'FETCH' => <<'END_OF_FUNC',
994 return $_[0] if $_[1] eq 'CGI';
995 return undef unless defined $_[0]->param($_[1]);
996 return join("\0",$_[0]->param($_[1]));
1000 'FIRSTKEY' => <<'END_OF_FUNC',
1002 $_[0]->{'.iterator'}=0;
1003 $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
1007 'NEXTKEY' => <<'END_OF_FUNC',
1009 $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
1013 'EXISTS' => <<'END_OF_FUNC',
1015 exists $_[0]->{$_[1]};
1019 'DELETE' => <<'END_OF_FUNC',
1021 $_[0]->delete($_[1]);
1025 'CLEAR' => <<'END_OF_FUNC',
1033 # Append a new value to an existing query
1035 'append' => <<'EOF',
1038 my($name,$value) = rearrange([NAME,[VALUE,VALUES]],@p);
1039 my(@values) = defined($value) ? (ref($value) ? @{$value} : $value) : ();
1041 $self->add_parameter($name);
1042 push(@{$self->{$name}},@values);
1044 return $self->param($name);
1048 #### Method: delete_all
1049 # Delete all parameters
1051 'delete_all' => <<'EOF',
1053 my($self) = self_or_default(@_);
1054 my @param = $self->param;
1055 $self->delete(@param);
1059 'Delete' => <<'EOF',
1061 my($self,@p) = self_or_default(@_);
1066 'Delete_all' => <<'EOF',
1068 my($self,@p) = self_or_default(@_);
1069 $self->delete_all(@p);
1073 #### Method: autoescape
1074 # If you want to turn off the autoescaping features,
1075 # call this method with undef as the argument
1076 'autoEscape' => <<'END_OF_FUNC',
1078 my($self,$escape) = self_or_default(@_);
1079 my $d = $self->{'escape'};
1080 $self->{'escape'} = $escape;
1086 #### Method: version
1087 # Return the current version
1089 'version' => <<'END_OF_FUNC',
1095 #### Method: url_param
1096 # Return a parameter in the QUERY_STRING, regardless of
1097 # whether this was a POST or a GET
1099 'url_param' => <<'END_OF_FUNC',
1101 my ($self,@p) = self_or_default(@_);
1102 my $name = shift(@p);
1103 return undef unless exists($ENV{QUERY_STRING});
1104 unless (exists($self->{'.url_param'})) {
1105 $self->{'.url_param'}={}; # empty hash
1106 if ($ENV{QUERY_STRING} =~ /=/) {
1107 my(@pairs) = split(/[&;]/,$ENV{QUERY_STRING});
1110 ($param,$value) = split('=',$_,2);
1111 $param = unescape($param);
1112 $value = unescape($value);
1113 push(@{$self->{'.url_param'}->{$param}},$value);
1116 $self->{'.url_param'}->{'keywords'} = [$self->parse_keywordlist($ENV{QUERY_STRING})];
1119 return keys %{$self->{'.url_param'}} unless defined($name);
1120 return () unless $self->{'.url_param'}->{$name};
1121 return wantarray ? @{$self->{'.url_param'}->{$name}}
1122 : $self->{'.url_param'}->{$name}->[0];
1127 # Returns a string in which all the known parameter/value
1128 # pairs are represented as nested lists, mainly for the purposes
1131 'Dump' => <<'END_OF_FUNC',
1133 my($self) = self_or_default(@_);
1134 my($param,$value,@result);
1135 return '<ul></ul>' unless $self->param;
1136 push(@result,"<ul>");
1137 foreach $param ($self->param) {
1138 my($name)=$self->escapeHTML($param);
1139 push(@result,"<li><strong>$param</strong>");
1140 push(@result,"<ul>");
1141 foreach $value ($self->param($param)) {
1142 $value = $self->escapeHTML($value);
1143 $value =~ s/\n/<br>\n/g;
1144 push(@result,"<li>$value");
1146 push(@result,"</ul>");
1148 push(@result,"</ul>");
1149 return join("\n",@result);
1153 #### Method as_string
1155 # synonym for "dump"
1157 'as_string' => <<'END_OF_FUNC',
1164 # Write values out to a filehandle in such a way that they can
1165 # be reinitialized by the filehandle form of the new() method
1167 'save' => <<'END_OF_FUNC',
1169 my($self,$filehandle) = self_or_default(@_);
1170 $filehandle = to_filehandle($filehandle);
1172 local($,) = ''; # set print field separator back to a sane value
1173 local($\) = ''; # set output line separator to a sane value
1174 foreach $param ($self->param) {
1175 my($escaped_param) = escape($param);
1177 foreach $value ($self->param($param)) {
1178 print $filehandle "$escaped_param=",escape("$value"),"\n";
1181 foreach (keys %{$self->{'.fieldnames'}}) {
1182 print $filehandle ".cgifields=",escape("$_"),"\n";
1184 print $filehandle "=\n"; # end of record
1189 #### Method: save_parameters
1190 # An alias for save() that is a better name for exportation.
1191 # Only intended to be used with the function (non-OO) interface.
1193 'save_parameters' => <<'END_OF_FUNC',
1194 sub save_parameters {
1196 return save(to_filehandle($fh));
1200 #### Method: restore_parameters
1201 # A way to restore CGI parameters from an initializer.
1202 # Only intended to be used with the function (non-OO) interface.
1204 'restore_parameters' => <<'END_OF_FUNC',
1205 sub restore_parameters {
1206 $Q = $CGI::DefaultClass->new(@_);
1210 #### Method: multipart_init
1211 # Return a Content-Type: style header for server-push
1212 # This has to be NPH on most web servers, and it is advisable to set $| = 1
1214 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1215 # contribution, updated by Andrew Benham (adsb@bigfoot.com)
1217 'multipart_init' => <<'END_OF_FUNC',
1218 sub multipart_init {
1219 my($self,@p) = self_or_default(@_);
1220 my($boundary,@other) = rearrange([BOUNDARY],@p);
1221 $boundary = $boundary || '------- =_aaaaaaaaaa0';
1222 $self->{'separator'} = "$CRLF--$boundary$CRLF";
1223 $self->{'final_separator'} = "$CRLF--$boundary--$CRLF";
1224 $type = SERVER_PUSH($boundary);
1225 return $self->header(
1228 (map { split "=", $_, 2 } @other),
1229 ) . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $self->multipart_end;
1234 #### Method: multipart_start
1235 # Return a Content-Type: style header for server-push, start of section
1237 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1238 # contribution, updated by Andrew Benham (adsb@bigfoot.com)
1240 'multipart_start' => <<'END_OF_FUNC',
1241 sub multipart_start {
1243 my($self,@p) = self_or_default(@_);
1244 my($type,@other) = rearrange([TYPE],@p);
1245 $type = $type || 'text/html';
1246 push(@header,"Content-Type: $type");
1248 # rearrange() was designed for the HTML portion, so we
1249 # need to fix it up a little.
1251 # Don't use \s because of perl bug 21951
1252 next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/;
1253 ($_ = $header) =~ s/^(\w)(.*)/$1 . lc ($2) . ': '.$self->unescapeHTML($value)/e;
1255 push(@header,@other);
1256 my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1262 #### Method: multipart_end
1263 # Return a MIME boundary separator for server-push, end of section
1265 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1268 'multipart_end' => <<'END_OF_FUNC',
1270 my($self,@p) = self_or_default(@_);
1271 return $self->{'separator'};
1276 #### Method: multipart_final
1277 # Return a MIME boundary separator for server-push, end of all sections
1279 # Contributed by Andrew Benham (adsb@bigfoot.com)
1281 'multipart_final' => <<'END_OF_FUNC',
1282 sub multipart_final {
1283 my($self,@p) = self_or_default(@_);
1284 return $self->{'final_separator'} . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $CRLF;
1290 # Return a Content-Type: style header
1293 'header' => <<'END_OF_FUNC',
1295 my($self,@p) = self_or_default(@_);
1298 return undef if $self->{'.header_printed'}++ and $HEADERS_ONCE;
1300 my($type,$status,$cookie,$target,$expires,$nph,$charset,$attachment,$p3p,@other) =
1301 rearrange([['TYPE','CONTENT_TYPE','CONTENT-TYPE'],
1302 'STATUS',['COOKIE','COOKIES'],'TARGET',
1303 'EXPIRES','NPH','CHARSET',
1304 'ATTACHMENT','P3P'],@p);
1307 if (defined $charset) {
1308 $self->charset($charset);
1310 $charset = $self->charset;
1313 # rearrange() was designed for the HTML portion, so we
1314 # need to fix it up a little.
1316 # Don't use \s because of perl bug 21951
1317 next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/;
1318 ($_ = $header) =~ s/^(\w)(.*)/"\u$1\L$2" . ': '.$self->unescapeHTML($value)/e;
1321 $type ||= 'text/html' unless defined($type);
1322 $type .= "; charset=$charset" if $type ne '' and $type =~ m!^text/! and $type !~ /\bcharset\b/ and $charset ne '';
1324 # Maybe future compatibility. Maybe not.
1325 my $protocol = $ENV{SERVER_PROTOCOL} || 'HTTP/1.0';
1326 push(@header,$protocol . ' ' . ($status || '200 OK')) if $nph;
1327 push(@header,"Server: " . &server_software()) if $nph;
1329 push(@header,"Status: $status") if $status;
1330 push(@header,"Window-Target: $target") if $target;
1332 $p3p = join ' ',@$p3p if ref($p3p) eq 'ARRAY';
1333 push(@header,qq(P3P: policyref="/w3c/p3p.xml", CP="$p3p"));
1335 # push all the cookies -- there may be several
1337 my(@cookie) = ref($cookie) && ref($cookie) eq 'ARRAY' ? @{$cookie} : $cookie;
1339 my $cs = UNIVERSAL::isa($_,'CGI::Cookie') ? $_->as_string : $_;
1340 push(@header,"Set-Cookie: $cs") if $cs ne '';
1343 # if the user indicates an expiration time, then we need
1344 # both an Expires and a Date header (so that the browser is
1346 push(@header,"Expires: " . expires($expires,'http'))
1348 push(@header,"Date: " . expires(0,'http')) if $expires || $cookie || $nph;
1349 push(@header,"Pragma: no-cache") if $self->cache();
1350 push(@header,"Content-Disposition: attachment; filename=\"$attachment\"") if $attachment;
1351 push(@header,map {ucfirst $_} @other);
1352 push(@header,"Content-Type: $type") if $type ne '';
1353 my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1354 if ($MOD_PERL and not $nph) {
1355 $self->r->send_cgi_header($header);
1364 # Control whether header() will produce the no-cache
1367 'cache' => <<'END_OF_FUNC',
1369 my($self,$new_value) = self_or_default(@_);
1370 $new_value = '' unless $new_value;
1371 if ($new_value ne '') {
1372 $self->{'cache'} = $new_value;
1374 return $self->{'cache'};
1379 #### Method: redirect
1380 # Return a Location: style header
1383 'redirect' => <<'END_OF_FUNC',
1385 my($self,@p) = self_or_default(@_);
1386 my($url,$target,$cookie,$nph,@other) = rearrange([[LOCATION,URI,URL],TARGET,['COOKIE','COOKIES'],NPH],@p);
1387 $url ||= $self->self_url;
1389 foreach (@other) { tr/\"//d; push(@o,split("=",$_,2)); }
1391 '-Status' => '302 Moved',
1394 unshift(@o,'-Target'=>$target) if $target;
1395 unshift(@o,'-Type'=>'');
1397 unshift(@unescaped,'-Cookie'=>$cookie) if $cookie;
1398 return $self->header((map {$self->unescapeHTML($_)} @o),@unescaped);
1403 #### Method: start_html
1404 # Canned HTML header
1407 # $title -> (optional) The title for this HTML document (-title)
1408 # $author -> (optional) e-mail address of the author (-author)
1409 # $base -> (optional) if set to true, will enter the BASE address of this document
1410 # for resolving relative references (-base)
1411 # $xbase -> (optional) alternative base at some remote location (-xbase)
1412 # $target -> (optional) target window to load all links into (-target)
1413 # $script -> (option) Javascript code (-script)
1414 # $no_script -> (option) Javascript <noscript> tag (-noscript)
1415 # $meta -> (optional) Meta information tags
1416 # $head -> (optional) any other elements you'd like to incorporate into the <head> tag
1417 # (a scalar or array ref)
1418 # $style -> (optional) reference to an external style sheet
1419 # @other -> (optional) any other named parameters you'd like to incorporate into
1422 'start_html' => <<'END_OF_FUNC',
1424 my($self,@p) = &self_or_default(@_);
1425 my($title,$author,$base,$xbase,$script,$noscript,
1426 $target,$meta,$head,$style,$dtd,$lang,$encoding,@other) =
1427 rearrange([TITLE,AUTHOR,BASE,XBASE,SCRIPT,NOSCRIPT,TARGET,META,HEAD,STYLE,DTD,LANG,ENCODING],@p);
1429 $encoding = 'iso-8859-1' unless defined $encoding;
1431 # strangely enough, the title needs to be escaped as HTML
1432 # while the author needs to be escaped as a URL
1433 $title = $self->escapeHTML($title || 'Untitled Document');
1434 $author = $self->escape($author);
1435 $lang = 'en-US' unless defined $lang;
1436 my(@result,$xml_dtd);
1438 if (defined(ref($dtd)) and (ref($dtd) eq 'ARRAY')) {
1439 $dtd = $DEFAULT_DTD unless $dtd->[0] =~ m|^-//|;
1441 $dtd = $DEFAULT_DTD unless $dtd =~ m|^-//|;
1444 $dtd = $XHTML ? XHTML_DTD : $DEFAULT_DTD;
1447 $xml_dtd++ if ref($dtd) eq 'ARRAY' && $dtd->[0] =~ /\bXHTML\b/i;
1448 $xml_dtd++ if ref($dtd) eq '' && $dtd =~ /\bXHTML\b/i;
1449 push @result,qq(<?xml version="1.0" encoding="$encoding"?>) if $xml_dtd;
1451 if (ref($dtd) && ref($dtd) eq 'ARRAY') {
1452 push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd->[0]"\n\t "$dtd->[1]">));
1454 push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd">));
1456 push(@result,$XHTML ? qq(<html xmlns="http://www.w3.org/1999/xhtml" lang="$lang" xml:lang="$lang"><head><title>$title</title>)
1457 : ($lang ? qq(<html lang="$lang">) : "<html>")
1458 . "<head><title>$title</title>");
1459 if (defined $author) {
1460 push(@result,$XHTML ? "<link rev=\"made\" href=\"mailto:$author\" />"
1461 : "<link rev=\"made\" href=\"mailto:$author\">");
1464 if ($base || $xbase || $target) {
1465 my $href = $xbase || $self->url('-path'=>1);
1466 my $t = $target ? qq/ target="$target"/ : '';
1467 push(@result,$XHTML ? qq(<base href="$href"$t />) : qq(<base href="$href"$t>));
1470 if ($meta && ref($meta) && (ref($meta) eq 'HASH')) {
1471 foreach (keys %$meta) { push(@result,$XHTML ? qq(<meta name="$_" content="$meta->{$_}" />)
1472 : qq(<meta name="$_" content="$meta->{$_}">)); }
1475 push(@result,ref($head) ? @$head : $head) if $head;
1477 # handle the infrequently-used -style and -script parameters
1478 push(@result,$self->_style($style)) if defined $style;
1479 push(@result,$self->_script($script)) if defined $script;
1481 # handle -noscript parameter
1482 push(@result,<<END) if $noscript;
1488 my($other) = @other ? " @other" : '';
1489 push(@result,"</head><body$other>");
1490 return join("\n",@result);
1495 # internal method for generating a CSS style section
1497 '_style' => <<'END_OF_FUNC',
1499 my ($self,$style) = @_;
1501 my $type = 'text/css';
1503 my $cdata_start = $XHTML ? "\n<!--/* <![CDATA[ */" : "\n<!-- ";
1504 my $cdata_end = $XHTML ? "\n/* ]]> */-->\n" : " -->\n";
1507 my($src,$code,$verbatim,$stype,@other) =
1508 rearrange([SRC,CODE,VERBATIM,TYPE],
1509 '-foo'=>'bar', # a trick to allow the '-' to be omitted
1510 ref($style) eq 'ARRAY' ? @$style : %$style);
1511 $type = $stype if $stype;
1513 if (ref($src) eq "ARRAY") # Check to see if the $src variable is an array reference
1514 { # If it is, push a LINK tag for each one
1515 foreach $src (@$src)
1517 push(@result,$XHTML ? qq(<link rel="stylesheet" type="$type" href="$src" />)
1518 : qq(<link rel="stylesheet" type="$type" href="$src">)) if $src;
1522 { # Otherwise, push the single -src, if it exists.
1523 push(@result,$XHTML ? qq(<link rel="stylesheet" type="$type" href="$src" />)
1524 : qq(<link rel="stylesheet" type="$type" href="$src">)
1528 push(@result, "<style type=\"text/css\">\n$verbatim\n</style>");
1530 push(@result,style({'type'=>$type},"$cdata_start\n$code\n$cdata_end")) if $code;
1532 push(@result,style({'type'=>$type},"$cdata_start\n$style\n$cdata_end"));
1538 '_script' => <<'END_OF_FUNC',
1540 my ($self,$script) = @_;
1543 my (@scripts) = ref($script) eq 'ARRAY' ? @$script : ($script);
1544 foreach $script (@scripts) {
1545 my($src,$code,$language);
1546 if (ref($script)) { # script is a hash
1547 ($src,$code,$language, $type) =
1548 rearrange([SRC,CODE,LANGUAGE,TYPE],
1549 '-foo'=>'bar', # a trick to allow the '-' to be omitted
1550 ref($script) eq 'ARRAY' ? @$script : %$script);
1551 # User may not have specified language
1552 $language ||= 'JavaScript';
1553 unless (defined $type) {
1554 $type = lc $language;
1555 # strip '1.2' from 'javascript1.2'
1556 $type =~ s/^(\D+).*$/text\/$1/;
1559 ($src,$code,$language, $type) = ('',$script,'JavaScript', 'text/javascript');
1562 my $comment = '//'; # javascript by default
1563 $comment = '#' if $type=~/perl|tcl/i;
1564 $comment = "'" if $type=~/vbscript/i;
1566 my $cdata_start = "\n<!-- Hide script\n";
1567 $cdata_start .= "$comment<![CDATA[\n" if $XHTML;
1568 my $cdata_end = $XHTML ? "\n$comment]]>" : $comment;
1569 $cdata_end .= " End script hiding -->\n";
1572 push(@satts,'src'=>$src) if $src;
1573 push(@satts,'language'=>$language) unless defined $type;
1574 push(@satts,'type'=>$type);
1575 $code = "$cdata_start$code$cdata_end" if defined $code;
1576 push(@result,script({@satts},$code || ''));
1582 #### Method: end_html
1583 # End an HTML document.
1584 # Trivial method for completeness. Just returns "</body>"
1586 'end_html' => <<'END_OF_FUNC',
1588 return "</body></html>";
1593 ################################
1594 # METHODS USED IN BUILDING FORMS
1595 ################################
1597 #### Method: isindex
1598 # Just prints out the isindex tag.
1600 # $action -> optional URL of script to run
1602 # A string containing a <isindex> tag
1603 'isindex' => <<'END_OF_FUNC',
1605 my($self,@p) = self_or_default(@_);
1606 my($action,@other) = rearrange([ACTION],@p);
1607 $action = qq/ action="$action"/ if $action;
1608 my($other) = @other ? " @other" : '';
1609 return $XHTML ? "<isindex$action$other />" : "<isindex$action$other>";
1614 #### Method: startform
1617 # $method -> optional submission method to use (GET or POST)
1618 # $action -> optional URL of script to run
1619 # $enctype ->encoding to use (URL_ENCODED or MULTIPART)
1620 'startform' => <<'END_OF_FUNC',
1622 my($self,@p) = self_or_default(@_);
1624 my($method,$action,$enctype,@other) =
1625 rearrange([METHOD,ACTION,ENCTYPE],@p);
1627 $method = lc($method) || 'post';
1628 $enctype = $enctype || &URL_ENCODED;
1629 unless (defined $action) {
1630 $action = $self->url(-absolute=>1,-path=>1);
1631 if (length($ENV{QUERY_STRING})>0) {
1632 $action .= "?$ENV{QUERY_STRING}";
1635 $action = qq(action="$action");
1636 my($other) = @other ? " @other" : '';
1637 $self->{'.parametersToAdd'}={};
1638 return qq/<form method="$method" $action enctype="$enctype"$other>\n/;
1643 #### Method: start_form
1644 # synonym for startform
1645 'start_form' => <<'END_OF_FUNC',
1651 'end_multipart_form' => <<'END_OF_FUNC',
1652 sub end_multipart_form {
1657 #### Method: start_multipart_form
1658 # synonym for startform
1659 'start_multipart_form' => <<'END_OF_FUNC',
1660 sub start_multipart_form {
1661 my($self,@p) = self_or_default(@_);
1662 if (defined($param[0]) && substr($param[0],0,1) eq '-') {
1664 $p{'-enctype'}=&MULTIPART;
1665 return $self->startform(%p);
1667 my($method,$action,@other) =
1668 rearrange([METHOD,ACTION],@p);
1669 return $self->startform($method,$action,&MULTIPART,@other);
1675 #### Method: endform
1677 'endform' => <<'END_OF_FUNC',
1679 my($self,@p) = self_or_default(@_);
1681 return wantarray ? ("</form>") : "\n</form>";
1683 return wantarray ? ("<div>",$self->get_fields,"</div>","</form>") :
1684 "<div>".$self->get_fields ."</div>\n</form>";
1690 #### Method: end_form
1691 # synonym for endform
1692 'end_form' => <<'END_OF_FUNC',
1699 '_textfield' => <<'END_OF_FUNC',
1701 my($self,$tag,@p) = self_or_default(@_);
1702 my($name,$default,$size,$maxlength,$override,@other) =
1703 rearrange([NAME,[DEFAULT,VALUE,VALUES],SIZE,MAXLENGTH,[OVERRIDE,FORCE]],@p);
1705 my $current = $override ? $default :
1706 (defined($self->param($name)) ? $self->param($name) : $default);
1708 $current = defined($current) ? $self->escapeHTML($current,1) : '';
1709 $name = defined($name) ? $self->escapeHTML($name) : '';
1710 my($s) = defined($size) ? qq/ size="$size"/ : '';
1711 my($m) = defined($maxlength) ? qq/ maxlength="$maxlength"/ : '';
1712 my($other) = @other ? " @other" : '';
1713 # this entered at cristy's request to fix problems with file upload fields
1714 # and WebTV -- not sure it won't break stuff
1715 my($value) = $current ne '' ? qq(value="$current") : '';
1716 return $XHTML ? qq(<input type="$tag" name="$name" $value$s$m$other />)
1717 : qq(<input type="$tag" name="$name" $value$s$m$other>);
1721 #### Method: textfield
1723 # $name -> Name of the text field
1724 # $default -> Optional default value of the field if not
1726 # $size -> Optional width of field in characaters.
1727 # $maxlength -> Optional maximum number of characters.
1729 # A string containing a <input type="text"> field
1731 'textfield' => <<'END_OF_FUNC',
1733 my($self,@p) = self_or_default(@_);
1734 $self->_textfield('text',@p);
1739 #### Method: filefield
1741 # $name -> Name of the file upload field
1742 # $size -> Optional width of field in characaters.
1743 # $maxlength -> Optional maximum number of characters.
1745 # A string containing a <input type="file"> field
1747 'filefield' => <<'END_OF_FUNC',
1749 my($self,@p) = self_or_default(@_);
1750 $self->_textfield('file',@p);
1755 #### Method: password
1756 # Create a "secret password" entry field
1758 # $name -> Name of the field
1759 # $default -> Optional default value of the field if not
1761 # $size -> Optional width of field in characters.
1762 # $maxlength -> Optional maximum characters that can be entered.
1764 # A string containing a <input type="password"> field
1766 'password_field' => <<'END_OF_FUNC',
1767 sub password_field {
1768 my ($self,@p) = self_or_default(@_);
1769 $self->_textfield('password',@p);
1773 #### Method: textarea
1775 # $name -> Name of the text field
1776 # $default -> Optional default value of the field if not
1778 # $rows -> Optional number of rows in text area
1779 # $columns -> Optional number of columns in text area
1781 # A string containing a <textarea></textarea> tag
1783 'textarea' => <<'END_OF_FUNC',
1785 my($self,@p) = self_or_default(@_);
1787 my($name,$default,$rows,$cols,$override,@other) =
1788 rearrange([NAME,[DEFAULT,VALUE],ROWS,[COLS,COLUMNS],[OVERRIDE,FORCE]],@p);
1790 my($current)= $override ? $default :
1791 (defined($self->param($name)) ? $self->param($name) : $default);
1793 $name = defined($name) ? $self->escapeHTML($name) : '';
1794 $current = defined($current) ? $self->escapeHTML($current) : '';
1795 my($r) = $rows ? qq/ rows="$rows"/ : '';
1796 my($c) = $cols ? qq/ cols="$cols"/ : '';
1797 my($other) = @other ? " @other" : '';
1798 return qq{<textarea name="$name"$r$c$other>$current</textarea>};
1804 # Create a javascript button.
1806 # $name -> (optional) Name for the button. (-name)
1807 # $value -> (optional) Value of the button when selected (and visible name) (-value)
1808 # $onclick -> (optional) Text of the JavaScript to run when the button is
1811 # A string containing a <input type="button"> tag
1813 'button' => <<'END_OF_FUNC',
1815 my($self,@p) = self_or_default(@_);
1817 my($label,$value,$script,@other) = rearrange([NAME,[VALUE,LABEL],
1818 [ONCLICK,SCRIPT]],@p);
1820 $label=$self->escapeHTML($label);
1821 $value=$self->escapeHTML($value,1);
1822 $script=$self->escapeHTML($script);
1825 $name = qq/ name="$label"/ if $label;
1826 $value = $value || $label;
1828 $val = qq/ value="$value"/ if $value;
1829 $script = qq/ onclick="$script"/ if $script;
1830 my($other) = @other ? " @other" : '';
1831 return $XHTML ? qq(<input type="button"$name$val$script$other />)
1832 : qq(<input type="button"$name$val$script$other>);
1838 # Create a "submit query" button.
1840 # $name -> (optional) Name for the button.
1841 # $value -> (optional) Value of the button when selected (also doubles as label).
1842 # $label -> (optional) Label printed on the button(also doubles as the value).
1844 # A string containing a <input type="submit"> tag
1846 'submit' => <<'END_OF_FUNC',
1848 my($self,@p) = self_or_default(@_);
1850 my($label,$value,@other) = rearrange([NAME,[VALUE,LABEL]],@p);
1852 $label=$self->escapeHTML($label);
1853 $value=$self->escapeHTML($value,1);
1855 my($name) = ' name=".submit"' unless $NOSTICKY;
1856 $name = qq/ name="$label"/ if defined($label);
1857 $value = defined($value) ? $value : $label;
1859 $val = qq/ value="$value"/ if defined($value);
1860 my($other) = @other ? " @other" : '';
1861 return $XHTML ? qq(<input type="submit"$name$val$other />)
1862 : qq(<input type="submit"$name$val$other>);
1868 # Create a "reset" button.
1870 # $name -> (optional) Name for the button.
1872 # A string containing a <input type="reset"> tag
1874 'reset' => <<'END_OF_FUNC',
1876 my($self,@p) = self_or_default(@_);
1877 my($label,$value,@other) = rearrange(['NAME',['VALUE','LABEL']],@p);
1878 warn "label = $label, value = $value";
1879 $label=$self->escapeHTML($label);
1880 $value=$self->escapeHTML($value,1);
1881 my ($name) = ' name=".reset"';
1882 $name = qq/ name="$label"/ if defined($label);
1883 $value = defined($value) ? $value : $label;
1885 $val = qq/ value="$value"/ if defined($value);
1886 my($other) = @other ? " @other" : '';
1887 return $XHTML ? qq(<input type="reset"$name$val$other />)
1888 : qq(<input type="reset"$name$val$other>);
1893 #### Method: defaults
1894 # Create a "defaults" button.
1896 # $name -> (optional) Name for the button.
1898 # A string containing a <input type="submit" name=".defaults"> tag
1900 # Note: this button has a special meaning to the initialization script,
1901 # and tells it to ERASE the current query string so that your defaults
1904 'defaults' => <<'END_OF_FUNC',
1906 my($self,@p) = self_or_default(@_);
1908 my($label,@other) = rearrange([[NAME,VALUE]],@p);
1910 $label=$self->escapeHTML($label,1);
1911 $label = $label || "Defaults";
1912 my($value) = qq/ value="$label"/;
1913 my($other) = @other ? " @other" : '';
1914 return $XHTML ? qq(<input type="submit" name=".defaults"$value$other />)
1915 : qq/<input type="submit" NAME=".defaults"$value$other>/;
1920 #### Method: comment
1921 # Create an HTML <!-- comment -->
1922 # Parameters: a string
1923 'comment' => <<'END_OF_FUNC',
1925 my($self,@p) = self_or_CGI(@_);
1926 return "<!-- @p -->";
1930 #### Method: checkbox
1931 # Create a checkbox that is not logically linked to any others.
1932 # The field value is "on" when the button is checked.
1934 # $name -> Name of the checkbox
1935 # $checked -> (optional) turned on by default if true
1936 # $value -> (optional) value of the checkbox, 'on' by default
1937 # $label -> (optional) a user-readable label printed next to the box.
1938 # Otherwise the checkbox name is used.
1940 # A string containing a <input type="checkbox"> field
1942 'checkbox' => <<'END_OF_FUNC',
1944 my($self,@p) = self_or_default(@_);
1946 my($name,$checked,$value,$label,$override,@other) =
1947 rearrange([NAME,[CHECKED,SELECTED,ON],VALUE,LABEL,[OVERRIDE,FORCE]],@p);
1949 $value = defined $value ? $value : 'on';
1951 if (!$override && ($self->{'.fieldnames'}->{$name} ||
1952 defined $self->param($name))) {
1953 $checked = grep($_ eq $value,$self->param($name)) ? $self->_checked(1) : '';
1955 $checked = $self->_checked($checked);
1957 my($the_label) = defined $label ? $label : $name;
1958 $name = $self->escapeHTML($name);
1959 $value = $self->escapeHTML($value,1);
1960 $the_label = $self->escapeHTML($the_label);
1961 my($other) = @other ? " @other" : '';
1962 $self->register_parameter($name);
1963 return $XHTML ? qq{<input type="checkbox" name="$name" value="$value"$checked$other />$the_label}
1964 : qq{<input type="checkbox" name="$name" value="$value"$checked$other>$the_label};
1969 #### Method: checkbox_group
1970 # Create a list of logically-linked checkboxes.
1972 # $name -> Common name for all the check boxes
1973 # $values -> A pointer to a regular array containing the
1974 # values for each checkbox in the group.
1975 # $defaults -> (optional)
1976 # 1. If a pointer to a regular array of checkbox values,
1977 # then this will be used to decide which
1978 # checkboxes to turn on by default.
1979 # 2. If a scalar, will be assumed to hold the
1980 # value of a single checkbox in the group to turn on.
1981 # $linebreak -> (optional) Set to true to place linebreaks
1982 # between the buttons.
1983 # $labels -> (optional)
1984 # A pointer to an associative array of labels to print next to each checkbox
1985 # in the form $label{'value'}="Long explanatory label".
1986 # Otherwise the provided values are used as the labels.
1988 # An ARRAY containing a series of <input type="checkbox"> fields
1990 'checkbox_group' => <<'END_OF_FUNC',
1991 sub checkbox_group {
1992 my($self,@p) = self_or_default(@_);
1994 my($name,$values,$defaults,$linebreak,$labels,$attributes,$rows,$columns,
1995 $rowheaders,$colheaders,$override,$nolabels,@other) =
1996 rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT],
1997 LINEBREAK,LABELS,ATTRIBUTES,ROWS,[COLUMNS,COLS],
1998 ROWHEADERS,COLHEADERS,
1999 [OVERRIDE,FORCE],NOLABELS],@p);
2001 my($checked,$break,$result,$label);
2003 my(%checked) = $self->previous_or_default($name,$defaults,$override);
2006 $break = $XHTML ? "<br />" : "<br>";
2011 $name=$self->escapeHTML($name);
2013 # Create the elements
2014 my(@elements,@values);
2016 @values = $self->_set_values_and_labels($values,\$labels,$name);
2018 my($other) = @other ? " @other" : '';
2020 $checked = $self->_checked($checked{$_});
2022 unless (defined($nolabels) && $nolabels) {
2024 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2025 $label = $self->escapeHTML($label);
2027 my $attribs = $self->_set_attributes($_, $attributes);
2028 $_ = $self->escapeHTML($_,1);
2029 push(@elements,$XHTML ? qq(<input type="checkbox" name="$name" value="$_"$checked$other$attribs />${label}${break})
2030 : qq/<input type="checkbox" name="$name" value="$_"$checked$other$attribs>${label}${break}/);
2032 $self->register_parameter($name);
2033 return wantarray ? @elements : join(' ',@elements)
2034 unless defined($columns) || defined($rows);
2035 $rows = 1 if $rows && $rows < 1;
2036 $cols = 1 if $cols && $cols < 1;
2037 return _tableize($rows,$columns,$rowheaders,$colheaders,@elements);
2041 # Escape HTML -- used internally
2042 'escapeHTML' => <<'END_OF_FUNC',
2044 # hack to work around earlier hacks
2045 push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
2046 my ($self,$toencode,$newlinestoo) = CGI::self_or_default(@_);
2047 return undef unless defined($toencode);
2048 return $toencode if ref($self) && !$self->{'escape'};
2049 $toencode =~ s{&}{&}gso;
2050 $toencode =~ s{<}{<}gso;
2051 $toencode =~ s{>}{>}gso;
2052 $toencode =~ s{"}{"}gso;
2053 my $latin = uc $self->{'.charset'} eq 'ISO-8859-1' ||
2054 uc $self->{'.charset'} eq 'WINDOWS-1252';
2055 if ($latin) { # bug in some browsers
2056 $toencode =~ s{'}{'}gso;
2057 $toencode =~ s{\x8b}{‹}gso;
2058 $toencode =~ s{\x9b}{›}gso;
2059 if (defined $newlinestoo && $newlinestoo) {
2060 $toencode =~ s{\012}{ }gso;
2061 $toencode =~ s{\015}{ }gso;
2068 # unescape HTML -- used internally
2069 'unescapeHTML' => <<'END_OF_FUNC',
2071 my ($self,$string) = CGI::self_or_default(@_);
2072 return undef unless defined($string);
2073 my $latin = defined $self->{'.charset'} ? $self->{'.charset'} =~ /^(ISO-8859-1|WINDOWS-1252)$/i
2075 # thanks to Randal Schwartz for the correct solution to this one
2076 $string=~ s[&(.*?);]{
2082 /^#(\d+)$/ && $latin ? chr($1) :
2083 /^#x([0-9a-f]+)$/i && $latin ? chr(hex($1)) :
2090 # Internal procedure - don't use
2091 '_tableize' => <<'END_OF_FUNC',
2093 my($rows,$columns,$rowheaders,$colheaders,@elements) = @_;
2094 $rowheaders = [] unless defined $rowheaders;
2095 $colheaders = [] unless defined $colheaders;
2098 if (defined($columns)) {
2099 $rows = int(0.99 + @elements/$columns) unless defined($rows);
2101 if (defined($rows)) {
2102 $columns = int(0.99 + @elements/$rows) unless defined($columns);
2105 # rearrange into a pretty table
2106 $result = "<table>";
2108 unshift(@$colheaders,'') if @$colheaders && @$rowheaders;
2109 $result .= "<tr>" if @{$colheaders};
2110 foreach (@{$colheaders}) {
2111 $result .= "<th>$_</th>";
2113 for ($row=0;$row<$rows;$row++) {
2115 $result .= "<th>$rowheaders->[$row]</th>" if @$rowheaders;
2116 for ($column=0;$column<$columns;$column++) {
2117 $result .= "<td>" . $elements[$column*$rows + $row] . "</td>"
2118 if defined($elements[$column*$rows + $row]);
2122 $result .= "</table>";
2128 #### Method: radio_group
2129 # Create a list of logically-linked radio buttons.
2131 # $name -> Common name for all the buttons.
2132 # $values -> A pointer to a regular array containing the
2133 # values for each button in the group.
2134 # $default -> (optional) Value of the button to turn on by default. Pass '-'
2135 # to turn _nothing_ on.
2136 # $linebreak -> (optional) Set to true to place linebreaks
2137 # between the buttons.
2138 # $labels -> (optional)
2139 # A pointer to an associative array of labels to print next to each checkbox
2140 # in the form $label{'value'}="Long explanatory label".
2141 # Otherwise the provided values are used as the labels.
2143 # An ARRAY containing a series of <input type="radio"> fields
2145 'radio_group' => <<'END_OF_FUNC',
2147 my($self,@p) = self_or_default(@_);
2149 my($name,$values,$default,$linebreak,$labels,$attributes,
2150 $rows,$columns,$rowheaders,$colheaders,$override,$nolabels,@other) =
2151 rearrange([NAME,[VALUES,VALUE],DEFAULT,LINEBREAK,LABELS,ATTRIBUTES,
2152 ROWS,[COLUMNS,COLS],
2153 ROWHEADERS,COLHEADERS,
2154 [OVERRIDE,FORCE],NOLABELS],@p);
2155 my($result,$checked);
2157 if (!$override && defined($self->param($name))) {
2158 $checked = $self->param($name);
2160 $checked = $default;
2162 my(@elements,@values);
2163 @values = $self->_set_values_and_labels($values,\$labels,$name);
2165 # If no check array is specified, check the first by default
2166 $checked = $values[0] unless defined($checked) && $checked ne '';
2167 $name=$self->escapeHTML($name);
2169 my($other) = @other ? " @other" : '';
2171 my($checkit) = $checked eq $_ ? qq/ checked="checked"/ : '';
2174 $break = $XHTML ? "<br />" : "<br>";
2180 unless (defined($nolabels) && $nolabels) {
2182 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2183 $label = $self->escapeHTML($label,1);
2185 my $attribs = $self->_set_attributes($_, $attributes);
2186 $_=$self->escapeHTML($_);
2187 push(@elements,$XHTML ? qq(<input type="radio" name="$name" value="$_"$checkit$other$attribs />${label}${break})
2188 : qq/<input type="radio" name="$name" value="$_"$checkit$other$attribs>${label}${break}/);
2190 $self->register_parameter($name);
2191 return wantarray ? @elements : join(' ',@elements)
2192 unless defined($columns) || defined($rows);
2193 return _tableize($rows,$columns,$rowheaders,$colheaders,@elements);
2198 #### Method: popup_menu
2199 # Create a popup menu.
2201 # $name -> Name for all the menu
2202 # $values -> A pointer to a regular array containing the
2203 # text of each menu item.
2204 # $default -> (optional) Default item to display
2205 # $labels -> (optional)
2206 # A pointer to an associative array of labels to print next to each checkbox
2207 # in the form $label{'value'}="Long explanatory label".
2208 # Otherwise the provided values are used as the labels.
2210 # A string containing the definition of a popup menu.
2212 'popup_menu' => <<'END_OF_FUNC',
2214 my($self,@p) = self_or_default(@_);
2216 my($name,$values,$default,$labels,$attributes,$override,@other) =
2217 rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LABELS,
2218 ATTRIBUTES,[OVERRIDE,FORCE]],@p);
2219 my($result,$selected);
2221 if (!$override && defined($self->param($name))) {
2222 $selected = $self->param($name);
2224 $selected = $default;
2226 $name=$self->escapeHTML($name);
2227 my($other) = @other ? " @other" : '';
2230 @values = $self->_set_values_and_labels($values,\$labels,$name);
2232 $result = qq/<select name="$name"$other>\n/;
2235 foreach (split(/\n/)) {
2236 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2237 s/(value="$selected")/$selectit $1/ if defined $selected;
2242 my $attribs = $self->_set_attributes($_, $attributes);
2243 my($selectit) = defined($selected) ? $self->_selected($selected eq $_) : '';
2245 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2246 my($value) = $self->escapeHTML($_);
2247 $label=$self->escapeHTML($label,1);
2248 $result .= "<option$selectit$attribs value=\"$value\">$label</option>\n";
2252 $result .= "</select>";
2258 #### Method: optgroup
2259 # Create a optgroup.
2261 # $name -> Label for the group
2262 # $values -> A pointer to a regular array containing the
2263 # values for each option line in the group.
2264 # $labels -> (optional)
2265 # A pointer to an associative array of labels to print next to each item
2266 # in the form $label{'value'}="Long explanatory label".
2267 # Otherwise the provided values are used as the labels.
2268 # $labeled -> (optional)
2269 # A true value indicates the value should be used as the label attribute
2270 # in the option elements.
2271 # The label attribute specifies the option label presented to the user.
2272 # This defaults to the content of the <option> element, but the label
2273 # attribute allows authors to more easily use optgroup without sacrificing
2274 # compatibility with browsers that do not support option groups.
2275 # $novals -> (optional)
2276 # A true value indicates to suppress the val attribute in the option elements
2278 # A string containing the definition of an option group.
2280 'optgroup' => <<'END_OF_FUNC',
2282 my($self,@p) = self_or_default(@_);
2283 my($name,$values,$attributes,$labeled,$noval,$labels,@other)
2284 = rearrange([NAME,[VALUES,VALUE],ATTRIBUTES,LABELED,NOVALS,LABELS],@p);
2286 my($result,@values);
2287 @values = $self->_set_values_and_labels($values,\$labels,$name,$labeled,$novals);
2288 my($other) = @other ? " @other" : '';
2290 $name=$self->escapeHTML($name);
2291 $result = qq/<optgroup label="$name"$other>\n/;
2294 foreach (split(/\n/)) {
2295 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2296 s/(value="$selected")/$selectit $1/ if defined $selected;
2301 my $attribs = $self->_set_attributes($_, $attributes);
2303 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2304 $label=$self->escapeHTML($label);
2305 my($value)=$self->escapeHTML($_,1);
2306 $result .= $labeled ? $novals ? "<option$attribs label=\"$value\">$label</option>\n"
2307 : "<option$attribs label=\"$value\" value=\"$value\">$label</option>\n"
2308 : $novals ? "<option$attribs>$label</option>\n"
2309 : "<option$attribs value=\"$value\">$label</option>\n";
2312 $result .= "</optgroup>";
2318 #### Method: scrolling_list
2319 # Create a scrolling list.
2321 # $name -> name for the list
2322 # $values -> A pointer to a regular array containing the
2323 # values for each option line in the list.
2324 # $defaults -> (optional)
2325 # 1. If a pointer to a regular array of options,
2326 # then this will be used to decide which
2327 # lines to turn on by default.
2328 # 2. Otherwise holds the value of the single line to turn on.
2329 # $size -> (optional) Size of the list.
2330 # $multiple -> (optional) If set, allow multiple selections.
2331 # $labels -> (optional)
2332 # A pointer to an associative array of labels to print next to each checkbox
2333 # in the form $label{'value'}="Long explanatory label".
2334 # Otherwise the provided values are used as the labels.
2336 # A string containing the definition of a scrolling list.
2338 'scrolling_list' => <<'END_OF_FUNC',
2339 sub scrolling_list {
2340 my($self,@p) = self_or_default(@_);
2341 my($name,$values,$defaults,$size,$multiple,$labels,$attributes,$override,@other)
2342 = rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT],
2343 SIZE,MULTIPLE,LABELS,ATTRIBUTES,[OVERRIDE,FORCE]],@p);
2345 my($result,@values);
2346 @values = $self->_set_values_and_labels($values,\$labels,$name);
2348 $size = $size || scalar(@values);
2350 my(%selected) = $self->previous_or_default($name,$defaults,$override);
2351 my($is_multiple) = $multiple ? qq/ multiple="multiple"/ : '';
2352 my($has_size) = $size ? qq/ size="$size"/: '';
2353 my($other) = @other ? " @other" : '';
2355 $name=$self->escapeHTML($name);
2356 $result = qq/<select name="$name"$has_size$is_multiple$other>\n/;
2358 my($selectit) = $self->_selected($selected{$_});
2360 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2361 $label=$self->escapeHTML($label);
2362 my($value)=$self->escapeHTML($_,1);
2363 my $attribs = $self->_set_attributes($_, $attributes);
2364 $result .= "<option$selectit$attribs value=\"$value\">$label</option>\n";
2366 $result .= "</select>";
2367 $self->register_parameter($name);
2375 # $name -> Name of the hidden field
2376 # @default -> (optional) Initial values of field (may be an array)
2378 # $default->[initial values of field]
2380 # A string containing a <input type="hidden" name="name" value="value">
2382 'hidden' => <<'END_OF_FUNC',
2384 my($self,@p) = self_or_default(@_);
2386 # this is the one place where we departed from our standard
2387 # calling scheme, so we have to special-case (darn)
2389 my($name,$default,$override,@other) =
2390 rearrange([NAME,[DEFAULT,VALUE,VALUES],[OVERRIDE,FORCE]],@p);
2392 my $do_override = 0;
2393 if ( ref($p[0]) || substr($p[0],0,1) eq '-') {
2394 @value = ref($default) ? @{$default} : $default;
2395 $do_override = $override;
2397 foreach ($default,$override,@other) {
2398 push(@value,$_) if defined($_);
2402 # use previous values if override is not set
2403 my @prev = $self->param($name);
2404 @value = @prev if !$do_override && @prev;
2406 $name=$self->escapeHTML($name);
2408 $_ = defined($_) ? $self->escapeHTML($_,1) : '';
2409 push @result,$XHTML ? qq(<input type="hidden" name="$name" value="$_" />)
2410 : qq(<input type="hidden" name="$name" value="$_">);
2412 return wantarray ? @result : join('',@result);
2417 #### Method: image_button
2419 # $name -> Name of the button
2420 # $src -> URL of the image source
2421 # $align -> Alignment style (TOP, BOTTOM or MIDDLE)
2423 # A string containing a <input type="image" name="name" src="url" align="alignment">
2425 'image_button' => <<'END_OF_FUNC',
2427 my($self,@p) = self_or_default(@_);
2429 my($name,$src,$alignment,@other) =
2430 rearrange([NAME,SRC,ALIGN],@p);
2432 my($align) = $alignment ? " align=\U\"$alignment\"" : '';
2433 my($other) = @other ? " @other" : '';
2434 $name=$self->escapeHTML($name);
2435 return $XHTML ? qq(<input type="image" name="$name" src="$src"$align$other />)
2436 : qq/<input type="image" name="$name" src="$src"$align$other>/;
2441 #### Method: self_url
2442 # Returns a URL containing the current script and all its
2443 # param/value pairs arranged as a query. You can use this
2444 # to create a link that, when selected, will reinvoke the
2445 # script with all its state information preserved.
2447 'self_url' => <<'END_OF_FUNC',
2449 my($self,@p) = self_or_default(@_);
2450 return $self->url('-path_info'=>1,'-query'=>1,'-full'=>1,@p);
2455 # This is provided as a synonym to self_url() for people unfortunate
2456 # enough to have incorporated it into their programs already!
2457 'state' => <<'END_OF_FUNC',
2465 # Like self_url, but doesn't return the query string part of
2468 'url' => <<'END_OF_FUNC',
2470 my($self,@p) = self_or_default(@_);
2471 my ($relative,$absolute,$full,$path_info,$query,$base) =
2472 rearrange(['RELATIVE','ABSOLUTE','FULL',['PATH','PATH_INFO'],['QUERY','QUERY_STRING'],'BASE'],@p);
2474 $full++ if $base || !($relative || $absolute);
2476 my $path = $self->path_info;
2477 my $script_name = $self->script_name;
2479 # for compatibility with Apache's MultiViews
2480 if (exists($ENV{REQUEST_URI})) {
2482 $script_name = unescape($ENV{REQUEST_URI});
2483 $script_name =~ s/\?.+$//; # strip query string
2485 if (exists($ENV{PATH_INFO})) {
2486 my $encoded_path = quotemeta($ENV{PATH_INFO});
2487 $script_name =~ s/$encoded_path$//i;
2492 my $protocol = $self->protocol();
2493 $url = "$protocol://";
2494 my $vh = http('host');
2498 $url .= server_name();
2499 my $port = $self->server_port;
2501 unless (lc($protocol) eq 'http' && $port == 80)
2502 || (lc($protocol) eq 'https' && $port == 443);
2504 return $url if $base;
2505 $url .= $script_name;
2506 } elsif ($relative) {
2507 ($url) = $script_name =~ m!([^/]+)$!;
2508 } elsif ($absolute) {
2509 $url = $script_name;
2512 $url .= $path if $path_info and defined $path;
2513 $url .= "?" . $self->query_string if $query and $self->query_string;
2514 $url = '' unless defined $url;
2515 $url =~ s/([^a-zA-Z0-9_.%;&?\/\\:+=~-])/sprintf("%%%02X",ord($1))/eg;
2522 # Set or read a cookie from the specified name.
2523 # Cookie can then be passed to header().
2524 # Usual rules apply to the stickiness of -value.
2526 # -name -> name for this cookie (optional)
2527 # -value -> value of this cookie (scalar, array or hash)
2528 # -path -> paths for which this cookie is valid (optional)
2529 # -domain -> internet domain in which this cookie is valid (optional)
2530 # -secure -> if true, cookie only passed through secure channel (optional)
2531 # -expires -> expiry date in format Wdy, DD-Mon-YYYY HH:MM:SS GMT (optional)
2533 'cookie' => <<'END_OF_FUNC',
2535 my($self,@p) = self_or_default(@_);
2536 my($name,$value,$path,$domain,$secure,$expires) =
2537 rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES],@p);
2539 require CGI::Cookie;
2541 # if no value is supplied, then we retrieve the
2542 # value of the cookie, if any. For efficiency, we cache the parsed
2543 # cookies in our state variables.
2544 unless ( defined($value) ) {
2545 $self->{'.cookies'} = CGI::Cookie->fetch
2546 unless $self->{'.cookies'};
2548 # If no name is supplied, then retrieve the names of all our cookies.
2549 return () unless $self->{'.cookies'};
2550 return keys %{$self->{'.cookies'}} unless $name;
2551 return () unless $self->{'.cookies'}->{$name};
2552 return $self->{'.cookies'}->{$name}->value if defined($name) && $name ne '';
2555 # If we get here, we're creating a new cookie
2556 return undef unless defined($name) && $name ne ''; # this is an error
2559 push(@param,'-name'=>$name);
2560 push(@param,'-value'=>$value);
2561 push(@param,'-domain'=>$domain) if $domain;
2562 push(@param,'-path'=>$path) if $path;
2563 push(@param,'-expires'=>$expires) if $expires;
2564 push(@param,'-secure'=>$secure) if $secure;
2566 return new CGI::Cookie(@param);
2570 'parse_keywordlist' => <<'END_OF_FUNC',
2571 sub parse_keywordlist {
2572 my($self,$tosplit) = @_;
2573 $tosplit = unescape($tosplit); # unescape the keywords
2574 $tosplit=~tr/+/ /; # pluses to spaces
2575 my(@keywords) = split(/\s+/,$tosplit);
2580 'param_fetch' => <<'END_OF_FUNC',
2582 my($self,@p) = self_or_default(@_);
2583 my($name) = rearrange([NAME],@p);
2584 unless (exists($self->{$name})) {
2585 $self->add_parameter($name);
2586 $self->{$name} = [];
2589 return $self->{$name};
2593 ###############################################
2594 # OTHER INFORMATION PROVIDED BY THE ENVIRONMENT
2595 ###############################################
2597 #### Method: path_info
2598 # Return the extra virtual path information provided
2599 # after the URL (if any)
2601 'path_info' => <<'END_OF_FUNC',
2603 my ($self,$info) = self_or_default(@_);
2604 if (defined($info)) {
2605 $info = "/$info" if $info ne '' && substr($info,0,1) ne '/';
2606 $self->{'.path_info'} = $info;
2607 } elsif (! defined($self->{'.path_info'}) ) {
2608 $self->{'.path_info'} = defined($ENV{'PATH_INFO'}) ?
2609 $ENV{'PATH_INFO'} : '';
2611 # hack to fix broken path info in IIS
2612 $self->{'.path_info'} =~ s/^\Q$ENV{'SCRIPT_NAME'}\E// if $IIS;
2615 return $self->{'.path_info'};
2620 #### Method: request_method
2621 # Returns 'POST', 'GET', 'PUT' or 'HEAD'
2623 'request_method' => <<'END_OF_FUNC',
2624 sub request_method {
2625 return $ENV{'REQUEST_METHOD'};
2629 #### Method: content_type
2630 # Returns the content_type string
2632 'content_type' => <<'END_OF_FUNC',
2634 return $ENV{'CONTENT_TYPE'};
2638 #### Method: path_translated
2639 # Return the physical path information provided
2640 # by the URL (if any)
2642 'path_translated' => <<'END_OF_FUNC',
2643 sub path_translated {
2644 return $ENV{'PATH_TRANSLATED'};
2649 #### Method: query_string
2650 # Synthesize a query string from our current
2653 'query_string' => <<'END_OF_FUNC',
2655 my($self) = self_or_default(@_);
2656 my($param,$value,@pairs);
2657 foreach $param ($self->param) {
2658 my($eparam) = escape($param);
2659 foreach $value ($self->param($param)) {
2660 $value = escape($value);
2661 next unless defined $value;
2662 push(@pairs,"$eparam=$value");
2665 foreach (keys %{$self->{'.fieldnames'}}) {
2666 push(@pairs,".cgifields=".escape("$_"));
2668 return join($USE_PARAM_SEMICOLONS ? ';' : '&',@pairs);
2674 # Without parameters, returns an array of the
2675 # MIME types the browser accepts.
2676 # With a single parameter equal to a MIME
2677 # type, will return undef if the browser won't
2678 # accept it, 1 if the browser accepts it but
2679 # doesn't give a preference, or a floating point
2680 # value between 0.0 and 1.0 if the browser
2681 # declares a quantitative score for it.
2682 # This handles MIME type globs correctly.
2684 'Accept' => <<'END_OF_FUNC',
2686 my($self,$search) = self_or_CGI(@_);
2687 my(%prefs,$type,$pref,$pat);
2689 my(@accept) = split(',',$self->http('accept'));
2692 ($pref) = /q=(\d\.\d+|\d+)/;
2693 ($type) = m#(\S+/[^;]+)#;
2695 $prefs{$type}=$pref || 1;
2698 return keys %prefs unless $search;
2700 # if a search type is provided, we may need to
2701 # perform a pattern matching operation.
2702 # The MIME types use a glob mechanism, which
2703 # is easily translated into a perl pattern match
2705 # First return the preference for directly supported
2707 return $prefs{$search} if $prefs{$search};
2709 # Didn't get it, so try pattern matching.
2710 foreach (keys %prefs) {
2711 next unless /\*/; # not a pattern match
2712 ($pat = $_) =~ s/([^\w*])/\\$1/g; # escape meta characters
2713 $pat =~ s/\*/.*/g; # turn it into a pattern
2714 return $prefs{$_} if $search=~/$pat/;
2720 #### Method: user_agent
2721 # If called with no parameters, returns the user agent.
2722 # If called with one parameter, does a pattern match (case
2723 # insensitive) on the user agent.
2725 'user_agent' => <<'END_OF_FUNC',
2727 my($self,$match)=self_or_CGI(@_);
2728 return $self->http('user_agent') unless $match;
2729 return $self->http('user_agent') =~ /$match/i;
2734 #### Method: raw_cookie
2735 # Returns the magic cookies for the session.
2736 # The cookies are not parsed or altered in any way, i.e.
2737 # cookies are returned exactly as given in the HTTP
2738 # headers. If a cookie name is given, only that cookie's
2739 # value is returned, otherwise the entire raw cookie
2742 'raw_cookie' => <<'END_OF_FUNC',
2744 my($self,$key) = self_or_CGI(@_);
2746 require CGI::Cookie;
2748 if (defined($key)) {
2749 $self->{'.raw_cookies'} = CGI::Cookie->raw_fetch
2750 unless $self->{'.raw_cookies'};
2752 return () unless $self->{'.raw_cookies'};
2753 return () unless $self->{'.raw_cookies'}->{$key};
2754 return $self->{'.raw_cookies'}->{$key};
2756 return $self->http('cookie') || $ENV{'COOKIE'} || '';
2760 #### Method: virtual_host
2761 # Return the name of the virtual_host, which
2762 # is not always the same as the server
2764 'virtual_host' => <<'END_OF_FUNC',
2766 my $vh = http('host') || server_name();
2767 $vh =~ s/:\d+$//; # get rid of port number
2772 #### Method: remote_host
2773 # Return the name of the remote host, or its IP
2774 # address if unavailable. If this variable isn't
2775 # defined, it returns "localhost" for debugging
2778 'remote_host' => <<'END_OF_FUNC',
2780 return $ENV{'REMOTE_HOST'} || $ENV{'REMOTE_ADDR'}
2786 #### Method: remote_addr
2787 # Return the IP addr of the remote host.
2789 'remote_addr' => <<'END_OF_FUNC',
2791 return $ENV{'REMOTE_ADDR'} || '127.0.0.1';
2796 #### Method: script_name
2797 # Return the partial URL to this script for
2798 # self-referencing scripts. Also see
2799 # self_url(), which returns a URL with all state information
2802 'script_name' => <<'END_OF_FUNC',
2804 return $ENV{'SCRIPT_NAME'} if defined($ENV{'SCRIPT_NAME'});
2805 # These are for debugging
2806 return "/$0" unless $0=~/^\//;
2812 #### Method: referer
2813 # Return the HTTP_REFERER: useful for generating
2816 'referer' => <<'END_OF_FUNC',
2818 my($self) = self_or_CGI(@_);
2819 return $self->http('referer');
2824 #### Method: server_name
2825 # Return the name of the server
2827 'server_name' => <<'END_OF_FUNC',
2829 return $ENV{'SERVER_NAME'} || 'localhost';
2833 #### Method: server_software
2834 # Return the name of the server software
2836 'server_software' => <<'END_OF_FUNC',
2837 sub server_software {
2838 return $ENV{'SERVER_SOFTWARE'} || 'cmdline';
2842 #### Method: server_port
2843 # Return the tcp/ip port the server is running on
2845 'server_port' => <<'END_OF_FUNC',
2847 return $ENV{'SERVER_PORT'} || 80; # for debugging
2851 #### Method: server_protocol
2852 # Return the protocol (usually HTTP/1.0)
2854 'server_protocol' => <<'END_OF_FUNC',
2855 sub server_protocol {
2856 return $ENV{'SERVER_PROTOCOL'} || 'HTTP/1.0'; # for debugging
2861 # Return the value of an HTTP variable, or
2862 # the list of variables if none provided
2864 'http' => <<'END_OF_FUNC',
2866 my ($self,$parameter) = self_or_CGI(@_);
2867 return $ENV{$parameter} if $parameter=~/^HTTP/;
2868 $parameter =~ tr/-/_/;
2869 return $ENV{"HTTP_\U$parameter\E"} if $parameter;
2871 foreach (keys %ENV) {
2872 push(@p,$_) if /^HTTP/;
2879 # Return the value of HTTPS
2881 'https' => <<'END_OF_FUNC',
2884 my ($self,$parameter) = self_or_CGI(@_);
2885 return $ENV{HTTPS} unless $parameter;
2886 return $ENV{$parameter} if $parameter=~/^HTTPS/;
2887 $parameter =~ tr/-/_/;
2888 return $ENV{"HTTPS_\U$parameter\E"} if $parameter;
2890 foreach (keys %ENV) {
2891 push(@p,$_) if /^HTTPS/;
2897 #### Method: protocol
2898 # Return the protocol (http or https currently)
2900 'protocol' => <<'END_OF_FUNC',
2904 return 'https' if uc($self->https()) eq 'ON';
2905 return 'https' if $self->server_port == 443;
2906 my $prot = $self->server_protocol;
2907 my($protocol,$version) = split('/',$prot);
2908 return "\L$protocol\E";
2912 #### Method: remote_ident
2913 # Return the identity of the remote user
2914 # (but only if his host is running identd)
2916 'remote_ident' => <<'END_OF_FUNC',
2918 return $ENV{'REMOTE_IDENT'};
2923 #### Method: auth_type
2924 # Return the type of use verification/authorization in use, if any.
2926 'auth_type' => <<'END_OF_FUNC',
2928 return $ENV{'AUTH_TYPE'};
2933 #### Method: remote_user
2934 # Return the authorization name used for user
2937 'remote_user' => <<'END_OF_FUNC',
2939 return $ENV{'REMOTE_USER'};
2944 #### Method: user_name
2945 # Try to return the remote user's name by hook or by
2948 'user_name' => <<'END_OF_FUNC',
2950 my ($self) = self_or_CGI(@_);
2951 return $self->http('from') || $ENV{'REMOTE_IDENT'} || $ENV{'REMOTE_USER'};
2955 #### Method: nosticky
2956 # Set or return the NOSTICKY global flag
2958 'nosticky' => <<'END_OF_FUNC',
2960 my ($self,$param) = self_or_CGI(@_);
2961 $CGI::NOSTICKY = $param if defined($param);
2962 return $CGI::NOSTICKY;
2967 # Set or return the NPH global flag
2969 'nph' => <<'END_OF_FUNC',
2971 my ($self,$param) = self_or_CGI(@_);
2972 $CGI::NPH = $param if defined($param);
2977 #### Method: private_tempfiles
2978 # Set or return the private_tempfiles global flag
2980 'private_tempfiles' => <<'END_OF_FUNC',
2981 sub private_tempfiles {
2982 my ($self,$param) = self_or_CGI(@_);
2983 $CGI::PRIVATE_TEMPFILES = $param if defined($param);
2984 return $CGI::PRIVATE_TEMPFILES;
2987 #### Method: close_upload_files
2988 # Set or return the close_upload_files global flag
2990 'close_upload_files' => <<'END_OF_FUNC',
2991 sub close_upload_files {
2992 my ($self,$param) = self_or_CGI(@_);
2993 $CGI::CLOSE_UPLOAD_FILES = $param if defined($param);
2994 return $CGI::CLOSE_UPLOAD_FILES;
2999 #### Method: default_dtd
3000 # Set or return the default_dtd global
3002 'default_dtd' => <<'END_OF_FUNC',
3004 my ($self,$param,$param2) = self_or_CGI(@_);
3005 if (defined $param2 && defined $param) {
3006 $CGI::DEFAULT_DTD = [ $param, $param2 ];
3007 } elsif (defined $param) {
3008 $CGI::DEFAULT_DTD = $param;
3010 return $CGI::DEFAULT_DTD;
3014 # -------------- really private subroutines -----------------
3015 'previous_or_default' => <<'END_OF_FUNC',
3016 sub previous_or_default {
3017 my($self,$name,$defaults,$override) = @_;
3020 if (!$override && ($self->{'.fieldnames'}->{$name} ||
3021 defined($self->param($name)) ) ) {
3022 grep($selected{$_}++,$self->param($name));
3023 } elsif (defined($defaults) && ref($defaults) &&
3024 (ref($defaults) eq 'ARRAY')) {
3025 grep($selected{$_}++,@{$defaults});
3027 $selected{$defaults}++ if defined($defaults);
3034 'register_parameter' => <<'END_OF_FUNC',
3035 sub register_parameter {
3036 my($self,$param) = @_;
3037 $self->{'.parametersToAdd'}->{$param}++;
3041 'get_fields' => <<'END_OF_FUNC',
3044 return $self->CGI::hidden('-name'=>'.cgifields',
3045 '-values'=>[keys %{$self->{'.parametersToAdd'}}],
3050 'read_from_cmdline' => <<'END_OF_FUNC',
3051 sub read_from_cmdline {
3054 if ($DEBUG && @ARGV) {
3056 } elsif ($DEBUG > 1) {
3057 require "shellwords.pl";
3058 print STDERR "(offline mode: enter name=value pairs on standard input)\n";
3059 chomp(@lines = <STDIN>); # remove newlines
3060 $input = join(" ",@lines);
3061 @words = &shellwords($input);
3068 if ("@words"=~/=/) {
3069 $query_string = join('&',@words);
3071 $query_string = join('+',@words);
3073 return $query_string;
3078 # subroutine: read_multipart
3080 # Read multipart data and store it into our parameters.
3081 # An interesting feature is that if any of the parts is a file, we
3082 # create a temporary file and open up a filehandle on it so that the
3083 # caller can read from it if necessary.
3085 'read_multipart' => <<'END_OF_FUNC',
3086 sub read_multipart {
3087 my($self,$boundary,$length,$filehandle) = @_;
3088 my($buffer) = $self->new_MultipartBuffer($boundary,$length,$filehandle);
3089 return unless $buffer;
3092 while (!$buffer->eof) {
3093 %header = $buffer->readHeader;
3096 $self->cgi_error("400 Bad request (malformed multipart POST)");
3100 my($param)= $header{'Content-Disposition'}=~/ name="?([^\";]*)"?/;
3103 # Bug: Netscape doesn't escape quotation marks in file names!!!
3104 my($filename) = $header{'Content-Disposition'}=~/ filename="?([^\"]*)"?/;
3105 # Test for Opera's multiple upload feature
3106 my($multipart) = ( defined( $header{'Content-Type'} ) &&
3107 $header{'Content-Type'} =~ /multipart\/mixed/ ) ?
3110 # add this parameter to our list
3111 $self->add_parameter($param);
3113 # If no filename specified, then just read the data and assign it
3114 # to our parameter list.
3115 if ( ( !defined($filename) || $filename eq '' ) && !$multipart ) {
3116 my($value) = $buffer->readBody;
3118 push(@{$self->{$param}},$value);
3122 my ($tmpfile,$tmp,$filehandle);
3124 # If we get here, then we are dealing with a potentially large
3125 # uploaded form. Save the data to a temporary file, then open
3126 # the file for reading.
3128 # skip the file if uploads disabled
3129 if ($DISABLE_UPLOADS) {
3130 while (defined($data = $buffer->read)) { }
3134 # set the filename to some recognizable value
3135 if ( ( !defined($filename) || $filename eq '' ) && $multipart ) {
3136 $filename = "multipart/mixed";
3139 # choose a relatively unpredictable tmpfile sequence number
3140 my $seqno = unpack("%16C*",join('',localtime,values %ENV));
3141 for (my $cnt=10;$cnt>0;$cnt--) {
3142 next unless $tmpfile = new CGITempFile($seqno);
3143 $tmp = $tmpfile->as_string;
3144 last if defined($filehandle = Fh->new($filename,$tmp,$PRIVATE_TEMPFILES));
3145 $seqno += int rand(100);
3147 die "CGI open of tmpfile: $!\n" unless defined $filehandle;
3148 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
3150 # if this is an multipart/mixed attachment, save the header
3151 # together with the body for lateron parsing with an external
3152 # MIME parser module
3154 foreach ( keys %header ) {
3155 print $filehandle "$_: $header{$_}${CRLF}";
3157 print $filehandle "${CRLF}";
3162 while (defined($data = $buffer->read)) {
3163 print $filehandle $data;
3166 # back up to beginning of file
3167 seek($filehandle,0,0);
3169 ## Close the filehandle if requested this allows a multipart MIME
3170 ## upload to contain many files, and we won't die due to too many
3171 ## open file handles. The user can access the files using the hash
3173 close $filehandle if $CLOSE_UPLOAD_FILES;
3174 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
3176 # Save some information about the uploaded file where we can get
3178 $self->{'.tmpfiles'}->{fileno($filehandle)}= {
3182 push(@{$self->{$param}},$filehandle);
3188 'upload' =><<'END_OF_FUNC',
3190 my($self,$param_name) = self_or_default(@_);
3191 my @param = grep(ref && fileno($_), $self->param($param_name));
3192 return unless @param;
3193 return wantarray ? @param : $param[0];
3197 'tmpFileName' => <<'END_OF_FUNC',
3199 my($self,$filename) = self_or_default(@_);
3200 return $self->{'.tmpfiles'}->{fileno($filename)}->{name} ?
3201 $self->{'.tmpfiles'}->{fileno($filename)}->{name}->as_string
3206 'uploadInfo' => <<'END_OF_FUNC',
3208 my($self,$filename) = self_or_default(@_);
3209 return $self->{'.tmpfiles'}->{fileno($filename)}->{info};
3213 # internal routine, don't use
3214 '_set_values_and_labels' => <<'END_OF_FUNC',
3215 sub _set_values_and_labels {
3218 $$l = $v if ref($v) eq 'HASH' && !ref($$l);
3219 return $self->param($n) if !defined($v);
3220 return $v if !ref($v);
3221 return ref($v) eq 'HASH' ? keys %$v : @$v;
3225 # internal routine, don't use
3226 '_set_attributes' => <<'END_OF_FUNC',
3227 sub _set_attributes {
3229 my($element, $attributes) = @_;
3230 return '' unless defined($attributes->{$element});
3232 foreach my $attrib (keys %{$attributes->{$element}}) {
3234 $attribs .= "@{[lc($attrib)]}=\"$attributes->{$element}{$attrib}\" ";
3241 '_compile_all' => <<'END_OF_FUNC',
3244 next if defined(&$_);
3245 $AUTOLOAD = "CGI::$_";
3255 #########################################################
3256 # Globals and stubs for other packages that we use.
3257 #########################################################
3259 ################### Fh -- lightweight filehandle ###############
3268 *Fh::AUTOLOAD = \&CGI::AUTOLOAD;
3270 $AUTOLOADED_ROUTINES = ''; # prevent -w error
3271 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3273 'asString' => <<'END_OF_FUNC',
3276 # get rid of package name
3277 (my $i = $$self) =~ s/^\*(\w+::fh\d{5})+//;
3278 $i =~ s/%(..)/ chr(hex($1)) /eg;
3279 return $i.$CGI::TAINTED;
3281 # This was an extremely clever patch that allowed "use strict refs".
3282 # Unfortunately it relied on another bug that caused leaky file descriptors.
3283 # The underlying bug has been fixed, so this no longer works. However
3284 # "strict refs" still works for some reason.
3286 # return ${*{$self}{SCALAR}};
3291 'compare' => <<'END_OF_FUNC',
3295 return "$self" cmp $value;
3299 'new' => <<'END_OF_FUNC',
3301 my($pack,$name,$file,$delete) = @_;
3302 _setup_symbols(@SAVED_SYMBOLS) if @SAVED_SYMBOLS;
3303 require Fcntl unless defined &Fcntl::O_RDWR;
3304 (my $safename = $name) =~ s/([':%])/ sprintf '%%%02X', ord $1 /eg;
3305 my $fv = ++$FH . $safename;
3306 my $ref = \*{"Fh::$fv"};
3307 $file =~ m!^([a-zA-Z0-9_ \'\":/.\$\\-]+)$! || return;
3309 sysopen($ref,$safe,Fcntl::O_RDWR()|Fcntl::O_CREAT()|Fcntl::O_EXCL(),0600) || return;
3310 unlink($safe) if $delete;
3311 CORE::delete $Fh::{$fv};
3312 return bless $ref,$pack;
3316 'DESTROY' => <<'END_OF_FUNC',
3326 ######################## MultipartBuffer ####################
3327 package MultipartBuffer;
3329 # how many bytes to read at a time. We use
3330 # a 4K buffer by default.
3331 $INITIAL_FILLUNIT = 1024 * 4;
3332 $TIMEOUT = 240*60; # 4 hour timeout for big files
3333 $SPIN_LOOP_MAX = 2000; # bug fix for some Netscape servers
3336 #reuse the autoload function
3337 *MultipartBuffer::AUTOLOAD = \&CGI::AUTOLOAD;
3339 # avoid autoloader warnings
3342 ###############################################################################
3343 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
3344 ###############################################################################
3345 $AUTOLOADED_ROUTINES = ''; # prevent -w error
3346 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3349 'new' => <<'END_OF_FUNC',
3351 my($package,$interface,$boundary,$length,$filehandle) = @_;
3352 $FILLUNIT = $INITIAL_FILLUNIT;
3355 my($package) = caller;
3356 # force into caller's package if necessary
3357 $IN = $filehandle=~/[':]/ ? $filehandle : "$package\:\:$filehandle";
3359 $IN = "main::STDIN" unless $IN;
3361 $CGI::DefaultClass->binmode($IN) if $CGI::needs_binmode;
3363 # If the user types garbage into the file upload field,
3364 # then Netscape passes NOTHING to the server (not good).
3365 # We may hang on this read in that case. So we implement
3366 # a read timeout. If nothing is ready to read
3367 # by then, we return.
3369 # Netscape seems to be a little bit unreliable
3370 # about providing boundary strings.
3371 my $boundary_read = 0;
3374 # Under the MIME spec, the boundary consists of the
3375 # characters "--" PLUS the Boundary string
3377 # BUG: IE 3.01 on the Macintosh uses just the boundary -- not
3378 # the two extra hyphens. We do a special case here on the user-agent!!!!
3379 $boundary = "--$boundary" unless CGI::user_agent('MSIE\s+3\.0[12];\s*Mac|DreamPassport');
3381 } else { # otherwise we find it ourselves
3383 ($old,$/) = ($/,$CRLF); # read a CRLF-delimited line
3384 $boundary = <$IN>; # BUG: This won't work correctly under mod_perl
3385 $length -= length($boundary);
3386 chomp($boundary); # remove the CRLF
3387 $/ = $old; # restore old line separator
3391 my $self = {LENGTH=>$length,
3392 BOUNDARY=>$boundary,
3394 INTERFACE=>$interface,
3398 $FILLUNIT = length($boundary)
3399 if length($boundary) > $FILLUNIT;
3401 my $retval = bless $self,ref $package || $package;
3403 # Read the preamble and the topmost (boundary) line plus the CRLF.
3404 unless ($boundary_read) {
3405 while ($self->read(0)) { }
3407 die "Malformed multipart POST\n" if $self->eof;
3413 'readHeader' => <<'END_OF_FUNC',
3420 local($CRLF) = "\015\012" if $CGI::OS eq 'VMS';
3423 $self->fillBuffer($FILLUNIT);
3424 $ok++ if ($end = index($self->{BUFFER},"${CRLF}${CRLF}")) >= 0;
3425 $ok++ if $self->{BUFFER} eq '';
3426 $bad++ if !$ok && $self->{LENGTH} <= 0;
3427 # this was a bad idea
3428 # $FILLUNIT *= 2 if length($self->{BUFFER}) >= $FILLUNIT;
3429 } until $ok || $bad;
3432 my($header) = substr($self->{BUFFER},0,$end+2);
3433 substr($self->{BUFFER},0,$end+4) = '';
3436 # See RFC 2045 Appendix A and RFC 822 sections 3.4.8
3437 # (Folding Long Header Fields), 3.4.3 (Comments)
3438 # and 3.4.5 (Quoted-Strings).
3440 my $token = '[-\w!\#$%&\'*+.^_\`|{}~]';
3441 $header=~s/$CRLF\s+/ /og; # merge continuation lines
3443 while ($header=~/($token+):\s+([^$CRLF]*)/mgox) {
3444 my ($field_name,$field_value) = ($1,$2);
3445 $field_name =~ s/\b(\w)/uc($1)/eg; #canonicalize
3446 $return{$field_name}=$field_value;
3452 # This reads and returns the body as a single scalar value.
3453 'readBody' => <<'END_OF_FUNC',
3458 while (defined($data = $self->read)) {
3459 $returnval .= $data;
3465 # This will read $bytes or until the boundary is hit, whichever happens
3466 # first. After the boundary is hit, we return undef. The next read will
3467 # skip over the boundary and begin reading again;
3468 'read' => <<'END_OF_FUNC',
3470 my($self,$bytes) = @_;
3472 # default number of bytes to read
3473 $bytes = $bytes || $FILLUNIT;
3475 # Fill up our internal buffer in such a way that the boundary
3476 # is never split between reads.
3477 $self->fillBuffer($bytes);
3479 # Find the boundary in the buffer (it may not be there).
3480 my $start = index($self->{BUFFER},$self->{BOUNDARY});
3481 # protect against malformed multipart POST operations
3482 die "Malformed multipart POST\n" unless ($start >= 0) || ($self->{LENGTH} > 0);
3484 # If the boundary begins the data, then skip past it
3488 # clear us out completely if we've hit the last boundary.
3489 if (index($self->{BUFFER},"$self->{BOUNDARY}--")==0) {
3495 # just remove the boundary.
3496 substr($self->{BUFFER},0,length($self->{BOUNDARY}))='';
3497 $self->{BUFFER} =~ s/^\012\015?//;
3502 if ($start > 0) { # read up to the boundary
3503 $bytesToReturn = $start-2 > $bytes ? $bytes : $start;
3504 } else { # read the requested number of bytes
3505 # leave enough bytes in the buffer to allow us to read
3506 # the boundary. Thanks to Kevin Hendrick for finding
3508 $bytesToReturn = $bytes - (length($self->{BOUNDARY})+1);
3511 my $returnval=substr($self->{BUFFER},0,$bytesToReturn);
3512 substr($self->{BUFFER},0,$bytesToReturn)='';
3514 # If we hit the boundary, remove the CRLF from the end.
3515 return ($bytesToReturn==$start)
3516 ? substr($returnval,0,-2) : $returnval;
3521 # This fills up our internal buffer in such a way that the
3522 # boundary is never split between reads
3523 'fillBuffer' => <<'END_OF_FUNC',
3525 my($self,$bytes) = @_;
3526 return unless $self->{LENGTH};
3528 my($boundaryLength) = length($self->{BOUNDARY});
3529 my($bufferLength) = length($self->{BUFFER});
3530 my($bytesToRead) = $bytes - $bufferLength + $boundaryLength + 2;
3531 $bytesToRead = $self->{LENGTH} if $self->{LENGTH} < $bytesToRead;
3533 # Try to read some data. We may hang here if the browser is screwed up.
3534 my $bytesRead = $self->{INTERFACE}->read_from_client($self->{IN},
3538 $self->{BUFFER} = '' unless defined $self->{BUFFER};
3540 # An apparent bug in the Apache server causes the read()
3541 # to return zero bytes repeatedly without blocking if the
3542 # remote user aborts during a file transfer. I don't know how
3543 # they manage this, but the workaround is to abort if we get
3544 # more than SPIN_LOOP_MAX consecutive zero reads.
3545 if ($bytesRead == 0) {
3546 die "CGI.pm: Server closed socket during multipart read (client aborted?).\n"
3547 if ($self->{ZERO_LOOP_COUNTER}++ >= $SPIN_LOOP_MAX);
3549 $self->{ZERO_LOOP_COUNTER}=0;
3552 $self->{LENGTH} -= $bytesRead;
3557 # Return true when we've finished reading
3558 'eof' => <<'END_OF_FUNC'
3561 return 1 if (length($self->{BUFFER}) == 0)
3562 && ($self->{LENGTH} <= 0);
3570 ####################################################################################
3571 ################################## TEMPORARY FILES #################################
3572 ####################################################################################
3573 package CGITempFile;
3576 $MAC = $CGI::OS eq 'MACINTOSH';
3577 my ($vol) = $MAC ? MacPerl::Volumes() =~ /:(.*)/ : "";
3578 unless ($TMPDIRECTORY) {
3579 @TEMP=("${SL}usr${SL}tmp","${SL}var${SL}tmp",
3580 "C:${SL}temp","${SL}tmp","${SL}temp",
3581 "${vol}${SL}Temporary Items",
3582 "${SL}WWW_ROOT", "${SL}SYS\$SCRATCH",
3583 "C:${SL}system${SL}temp");
3584 unshift(@TEMP,$ENV{'TMPDIR'}) if defined $ENV{'TMPDIR'};
3586 # this feature was supposed to provide per-user tmpfiles, but
3587 # it is problematic.
3588 # unshift(@TEMP,(getpwuid($<))[7].'/tmp') if $CGI::OS eq 'UNIX';
3589 # Rob: getpwuid() is unfortunately UNIX specific. On brain dead OS'es this
3590 # : can generate a 'getpwuid() not implemented' exception, even though
3591 # : it's never called. Found under DOS/Win with the DJGPP perl port.
3592 # : Refer to getpwuid() only at run-time if we're fortunate and have UNIX.
3593 # unshift(@TEMP,(eval {(getpwuid($>))[7]}).'/tmp') if $CGI::OS eq 'UNIX' and $> != 0;
3596 do {$TMPDIRECTORY = $_; last} if -d $_ && -w _;
3600 $TMPDIRECTORY = $MAC ? "" : "." unless $TMPDIRECTORY;
3603 # cute feature, but overload implementation broke it
3604 # %OVERLOAD = ('""'=>'as_string');
3605 *CGITempFile::AUTOLOAD = \&CGI::AUTOLOAD;
3609 $$self =~ m!^([a-zA-Z0-9_ \'\":/.\$\\-]+)$! || return;
3610 my $safe = $1; # untaint operation
3611 unlink $safe; # get rid of the file
3614 ###############################################################################
3615 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
3616 ###############################################################################
3617 $AUTOLOADED_ROUTINES = ''; # prevent -w error
3618 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3621 'new' => <<'END_OF_FUNC',
3623 my($package,$sequence) = @_;
3625 for (my $i = 0; $i < $MAXTRIES; $i++) {
3626 last if ! -f ($filename = sprintf("${TMPDIRECTORY}${SL}CGItemp%d",$sequence++));
3628 # check that it is a more-or-less valid filename
3629 return unless $filename =~ m!^([a-zA-Z0-9_ \'\":/.\$\\-]+)$!;
3630 # this used to untaint, now it doesn't
3632 return bless \$filename;
3636 'as_string' => <<'END_OF_FUNC'
3648 # We get a whole bunch of warnings about "possibly uninitialized variables"
3649 # when running with the -w switch. Touch them all once to get rid of the
3650 # warnings. This is ugly and I hate it.
3655 $MultipartBuffer::SPIN_LOOP_MAX;
3656 $MultipartBuffer::CRLF;
3657 $MultipartBuffer::TIMEOUT;
3658 $MultipartBuffer::INITIAL_FILLUNIT;
3669 CGI - Simple Common Gateway Interface Class
3673 # CGI script that creates a fill-out form
3674 # and echoes back its values.
3676 use CGI qw/:standard/;
3678 start_html('A Simple Example'),
3679 h1('A Simple Example'),
3681 "What's your name? ",textfield('name'),p,
3682 "What's the combination?", p,
3683 checkbox_group(-name=>'words',
3684 -values=>['eenie','meenie','minie','moe'],
3685 -defaults=>['eenie','minie']), p,
3686 "What's your favorite color? ",
3687 popup_menu(-name=>'color',
3688 -values=>['red','green','blue','chartreuse']),p,
3694 print "Your name is",em(param('name')),p,
3695 "The keywords are: ",em(join(", ",param('words'))),p,
3696 "Your favorite color is ",em(param('color')),
3702 This perl library uses perl5 objects to make it easy to create Web
3703 fill-out forms and parse their contents. This package defines CGI
3704 objects, entities that contain the values of the current query string
3705 and other state variables. Using a CGI object's methods, you can
3706 examine keywords and parameters passed to your script, and create
3707 forms whose initial values are taken from the current query (thereby
3708 preserving state information). The module provides shortcut functions
3709 that produce boilerplate HTML, reducing typing and coding errors. It
3710 also provides functionality for some of the more advanced features of
3711 CGI scripting, including support for file uploads, cookies, cascading
3712 style sheets, server push, and frames.
3714 CGI.pm also provides a simple function-oriented programming style for
3715 those who don't need its object-oriented features.
3717 The current version of CGI.pm is available at
3719 http://www.genome.wi.mit.edu/ftp/pub/software/WWW/cgi_docs.html
3720 ftp://ftp-genome.wi.mit.edu/pub/software/WWW/
3724 =head2 PROGRAMMING STYLE
3726 There are two styles of programming with CGI.pm, an object-oriented
3727 style and a function-oriented style. In the object-oriented style you
3728 create one or more CGI objects and then use object methods to create
3729 the various elements of the page. Each CGI object starts out with the
3730 list of named parameters that were passed to your CGI script by the
3731 server. You can modify the objects, save them to a file or database
3732 and recreate them. Because each object corresponds to the "state" of
3733 the CGI script, and because each object's parameter list is
3734 independent of the others, this allows you to save the state of the
3735 script and restore it later.
3737 For example, using the object oriented style, here is how you create
3738 a simple "Hello World" HTML page:
3740 #!/usr/local/bin/perl -w
3741 use CGI; # load CGI routines
3742 $q = new CGI; # create new CGI object
3743 print $q->header, # create the HTTP header
3744 $q->start_html('hello world'), # start the HTML
3745 $q->h1('hello world'), # level 1 header
3746 $q->end_html; # end the HTML
3748 In the function-oriented style, there is one default CGI object that
3749 you rarely deal with directly. Instead you just call functions to
3750 retrieve CGI parameters, create HTML tags, manage cookies, and so
3751 on. This provides you with a cleaner programming interface, but
3752 limits you to using one CGI object at a time. The following example
3753 prints the same page, but uses the function-oriented interface.
3754 The main differences are that we now need to import a set of functions
3755 into our name space (usually the "standard" functions), and we don't
3756 need to create the CGI object.
3758 #!/usr/local/bin/perl
3759 use CGI qw/:standard/; # load standard CGI routines
3760 print header, # create the HTTP header
3761 start_html('hello world'), # start the HTML
3762 h1('hello world'), # level 1 header
3763 end_html; # end the HTML
3765 The examples in this document mainly use the object-oriented style.
3766 See HOW TO IMPORT FUNCTIONS for important information on
3767 function-oriented programming in CGI.pm
3769 =head2 CALLING CGI.PM ROUTINES
3771 Most CGI.pm routines accept several arguments, sometimes as many as 20
3772 optional ones! To simplify this interface, all routines use a named
3773 argument calling style that looks like this:
3775 print $q->header(-type=>'image/gif',-expires=>'+3d');
3777 Each argument name is preceded by a dash. Neither case nor order
3778 matters in the argument list. -type, -Type, and -TYPE are all
3779 acceptable. In fact, only the first argument needs to begin with a
3780 dash. If a dash is present in the first argument, CGI.pm assumes
3781 dashes for the subsequent ones.
3783 Several routines are commonly called with just one argument. In the
3784 case of these routines you can provide the single argument without an
3785 argument name. header() happens to be one of these routines. In this
3786 case, the single argument is the document type.
3788 print $q->header('text/html');
3790 Other such routines are documented below.
3792 Sometimes named arguments expect a scalar, sometimes a reference to an
3793 array, and sometimes a reference to a hash. Often, you can pass any
3794 type of argument and the routine will do whatever is most appropriate.
3795 For example, the param() routine is used to set a CGI parameter to a
3796 single or a multi-valued value. The two cases are shown below:
3798 $q->param(-name=>'veggie',-value=>'tomato');
3799 $q->param(-name=>'veggie',-value=>['tomato','tomahto','potato','potahto']);
3801 A large number of routines in CGI.pm actually aren't specifically
3802 defined in the module, but are generated automatically as needed.
3803 These are the "HTML shortcuts," routines that generate HTML tags for
3804 use in dynamically-generated pages. HTML tags have both attributes
3805 (the attribute="value" pairs within the tag itself) and contents (the
3806 part between the opening and closing pairs.) To distinguish between
3807 attributes and contents, CGI.pm uses the convention of passing HTML
3808 attributes as a hash reference as the first argument, and the
3809 contents, if any, as any subsequent arguments. It works out like
3815 h1('some','contents'); <h1>some contents</h1>
3816 h1({-align=>left}); <h1 align="LEFT">
3817 h1({-align=>left},'contents'); <h1 align="LEFT">contents</h1>
3819 HTML tags are described in more detail later.
3821 Many newcomers to CGI.pm are puzzled by the difference between the
3822 calling conventions for the HTML shortcuts, which require curly braces
3823 around the HTML tag attributes, and the calling conventions for other
3824 routines, which manage to generate attributes without the curly
3825 brackets. Don't be confused. As a convenience the curly braces are
3826 optional in all but the HTML shortcuts. If you like, you can use
3827 curly braces when calling any routine that takes named arguments. For
3830 print $q->header( {-type=>'image/gif',-expires=>'+3d'} );
3832 If you use the B<-w> switch, you will be warned that some CGI.pm argument
3833 names conflict with built-in Perl functions. The most frequent of
3834 these is the -values argument, used to create multi-valued menus,
3835 radio button clusters and the like. To get around this warning, you
3836 have several choices:
3842 Use another name for the argument, if one is available.
3843 For example, -value is an alias for -values.
3847 Change the capitalization, e.g. -Values
3851 Put quotes around the argument name, e.g. '-values'
3855 Many routines will do something useful with a named argument that it
3856 doesn't recognize. For example, you can produce non-standard HTTP
3857 header fields by providing them as named arguments:
3859 print $q->header(-type => 'text/html',
3860 -cost => 'Three smackers',
3861 -annoyance_level => 'high',
3862 -complaints_to => 'bit bucket');
3864 This will produce the following nonstandard HTTP header:
3867 Cost: Three smackers
3868 Annoyance-level: high
3869 Complaints-to: bit bucket
3870 Content-type: text/html
3872 Notice the way that underscores are translated automatically into
3873 hyphens. HTML-generating routines perform a different type of
3876 This feature allows you to keep up with the rapidly changing HTTP and
3879 =head2 CREATING A NEW QUERY OBJECT (OBJECT-ORIENTED STYLE):
3883 This will parse the input (from both POST and GET methods) and store
3884 it into a perl5 object called $query.
3886 =head2 CREATING A NEW QUERY OBJECT FROM AN INPUT FILE
3888 $query = new CGI(INPUTFILE);
3890 If you provide a file handle to the new() method, it will read
3891 parameters from the file (or STDIN, or whatever). The file can be in
3892 any of the forms describing below under debugging (i.e. a series of
3893 newline delimited TAG=VALUE pairs will work). Conveniently, this type
3894 of file is created by the save() method (see below). Multiple records
3895 can be saved and restored.
3897 Perl purists will be pleased to know that this syntax accepts
3898 references to file handles, or even references to filehandle globs,
3899 which is the "official" way to pass a filehandle:
3901 $query = new CGI(\*STDIN);
3903 You can also initialize the CGI object with a FileHandle or IO::File
3906 If you are using the function-oriented interface and want to
3907 initialize CGI state from a file handle, the way to do this is with
3908 B<restore_parameters()>. This will (re)initialize the
3909 default CGI object from the indicated file handle.
3911 open (IN,"test.in") || die;
3912 restore_parameters(IN);
3915 You can also initialize the query object from an associative array
3918 $query = new CGI( {'dinosaur'=>'barney',
3919 'song'=>'I love you',
3920 'friends'=>[qw/Jessica George Nancy/]}
3923 or from a properly formatted, URL-escaped query string:
3925 $query = new CGI('dinosaur=barney&color=purple');
3927 or from a previously existing CGI object (currently this clones the
3928 parameter list, but none of the other object-specific fields, such as
3931 $old_query = new CGI;
3932 $new_query = new CGI($old_query);
3934 To create an empty query, initialize it from an empty string or hash:
3936 $empty_query = new CGI("");
3940 $empty_query = new CGI({});
3942 =head2 FETCHING A LIST OF KEYWORDS FROM THE QUERY:
3944 @keywords = $query->keywords
3946 If the script was invoked as the result of an <ISINDEX> search, the
3947 parsed keywords can be obtained as an array using the keywords() method.
3949 =head2 FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT:
3951 @names = $query->param
3953 If the script was invoked with a parameter list
3954 (e.g. "name1=value1&name2=value2&name3=value3"), the param() method
3955 will return the parameter names as a list. If the script was invoked
3956 as an <ISINDEX> script and contains a string without ampersands
3957 (e.g. "value1+value2+value3") , there will be a single parameter named
3958 "keywords" containing the "+"-delimited keywords.
3960 NOTE: As of version 1.5, the array of parameter names returned will
3961 be in the same order as they were submitted by the browser.
3962 Usually this order is the same as the order in which the
3963 parameters are defined in the form (however, this isn't part
3964 of the spec, and so isn't guaranteed).
3966 =head2 FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER:
3968 @values = $query->param('foo');
3972 $value = $query->param('foo');
3974 Pass the param() method a single argument to fetch the value of the
3975 named parameter. If the parameter is multivalued (e.g. from multiple
3976 selections in a scrolling list), you can ask to receive an array. Otherwise
3977 the method will return a single value.
3979 If a value is not given in the query string, as in the queries
3980 "name1=&name2=" or "name1&name2", it will be returned as an empty
3981 string. This feature is new in 2.63.
3984 If the parameter does not exist at all, then param() will return undef
3985 in a scalar context, and the empty list in a list context.
3988 =head2 SETTING THE VALUE(S) OF A NAMED PARAMETER:
3990 $query->param('foo','an','array','of','values');
3992 This sets the value for the named parameter 'foo' to an array of
3993 values. This is one way to change the value of a field AFTER
3994 the script has been invoked once before. (Another way is with
3995 the -override parameter accepted by all methods that generate
3998 param() also recognizes a named parameter style of calling described
3999 in more detail later:
4001 $query->param(-name=>'foo',-values=>['an','array','of','values']);
4005 $query->param(-name=>'foo',-value=>'the value');
4007 =head2 APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER:
4009 $query->append(-name=>'foo',-values=>['yet','more','values']);
4011 This adds a value or list of values to the named parameter. The
4012 values are appended to the end of the parameter if it already exists.
4013 Otherwise the parameter is created. Note that this method only
4014 recognizes the named argument calling syntax.
4016 =head2 IMPORTING ALL PARAMETERS INTO A NAMESPACE:
4018 $query->import_names('R');
4020 This creates a series of variables in the 'R' namespace. For example,
4021 $R::foo, @R:foo. For keyword lists, a variable @R::keywords will appear.
4022 If no namespace is given, this method will assume 'Q'.
4023 WARNING: don't import anything into 'main'; this is a major security
4026 NOTE 1: Variable names are transformed as necessary into legal Perl
4027 variable names. All non-legal characters are transformed into
4028 underscores. If you need to keep the original names, you should use
4029 the param() method instead to access CGI variables by name.
4031 NOTE 2: In older versions, this method was called B<import()>. As of version 2.20,
4032 this name has been removed completely to avoid conflict with the built-in
4033 Perl module B<import> operator.
4035 =head2 DELETING A PARAMETER COMPLETELY:
4037 $query->delete('foo','bar','baz');
4039 This completely clears a list of parameters. It sometimes useful for
4040 resetting parameters that you don't want passed down between script
4043 If you are using the function call interface, use "Delete()" instead
4044 to avoid conflicts with Perl's built-in delete operator.
4046 =head2 DELETING ALL PARAMETERS:
4048 $query->delete_all();
4050 This clears the CGI object completely. It might be useful to ensure
4051 that all the defaults are taken when you create a fill-out form.
4053 Use Delete_all() instead if you are using the function call interface.
4055 =head2 DIRECT ACCESS TO THE PARAMETER LIST:
4057 $q->param_fetch('address')->[1] = '1313 Mockingbird Lane';
4058 unshift @{$q->param_fetch(-name=>'address')},'George Munster';
4060 If you need access to the parameter list in a way that isn't covered
4061 by the methods above, you can obtain a direct reference to it by
4062 calling the B<param_fetch()> method with the name of the . This
4063 will return an array reference to the named parameters, which you then
4064 can manipulate in any way you like.
4066 You can also use a named argument style using the B<-name> argument.
4068 =head2 FETCHING THE PARAMETER LIST AS A HASH:
4071 print $params->{'address'};
4072 @foo = split("\0",$params->{'foo'});
4078 Many people want to fetch the entire parameter list as a hash in which
4079 the keys are the names of the CGI parameters, and the values are the
4080 parameters' values. The Vars() method does this. Called in a scalar
4081 context, it returns the parameter list as a tied hash reference.
4082 Changing a key changes the value of the parameter in the underlying
4083 CGI parameter list. Called in a list context, it returns the
4084 parameter list as an ordinary hash. This allows you to read the
4085 contents of the parameter list, but not to change it.
4087 When using this, the thing you must watch out for are multivalued CGI
4088 parameters. Because a hash cannot distinguish between scalar and
4089 list context, multivalued parameters will be returned as a packed
4090 string, separated by the "\0" (null) character. You must split this
4091 packed string in order to get at the individual values. This is the
4092 convention introduced long ago by Steve Brenner in his cgi-lib.pl
4093 module for Perl version 4.
4095 If you wish to use Vars() as a function, import the I<:cgi-lib> set of
4096 function calls (also see the section on CGI-LIB compatibility).
4098 =head2 SAVING THE STATE OF THE SCRIPT TO A FILE:
4100 $query->save(FILEHANDLE)
4102 This will write the current state of the form to the provided
4103 filehandle. You can read it back in by providing a filehandle
4104 to the new() method. Note that the filehandle can be a file, a pipe,
4107 The format of the saved file is:
4115 Both name and value are URL escaped. Multi-valued CGI parameters are
4116 represented as repeated names. A session record is delimited by a
4117 single = symbol. You can write out multiple records and read them
4118 back in with several calls to B<new>. You can do this across several
4119 sessions by opening the file in append mode, allowing you to create
4120 primitive guest books, or to keep a history of users' queries. Here's
4121 a short example of creating multiple session records:
4125 open (OUT,">>test.out") || die;
4127 foreach (0..$records) {
4129 $q->param(-name=>'counter',-value=>$_);
4134 # reopen for reading
4135 open (IN,"test.out") || die;
4137 my $q = new CGI(IN);
4138 print $q->param('counter'),"\n";
4141 The file format used for save/restore is identical to that used by the
4142 Whitehead Genome Center's data exchange format "Boulderio", and can be
4143 manipulated and even databased using Boulderio utilities. See
4145 http://stein.cshl.org/boulder/
4147 for further details.
4149 If you wish to use this method from the function-oriented (non-OO)
4150 interface, the exported name for this method is B<save_parameters()>.
4152 =head2 RETRIEVING CGI ERRORS
4154 Errors can occur while processing user input, particularly when
4155 processing uploaded files. When these errors occur, CGI will stop
4156 processing and return an empty parameter list. You can test for
4157 the existence and nature of errors using the I<cgi_error()> function.
4158 The error messages are formatted as HTTP status codes. You can either
4159 incorporate the error text into an HTML page, or use it as the value
4162 my $error = $q->cgi_error;
4164 print $q->header(-status=>$error),
4165 $q->start_html('Problems'),
4166 $q->h2('Request not processed'),
4171 When using the function-oriented interface (see the next section),
4172 errors may only occur the first time you call I<param()>. Be ready
4175 =head2 USING THE FUNCTION-ORIENTED INTERFACE
4177 To use the function-oriented interface, you must specify which CGI.pm
4178 routines or sets of routines to import into your script's namespace.
4179 There is a small overhead associated with this importation, but it
4182 use CGI <list of methods>;
4184 The listed methods will be imported into the current package; you can
4185 call them directly without creating a CGI object first. This example
4186 shows how to import the B<param()> and B<header()>
4187 methods, and then use them directly:
4189 use CGI 'param','header';
4190 print header('text/plain');
4191 $zipcode = param('zipcode');
4193 More frequently, you'll import common sets of functions by referring
4194 to the groups by name. All function sets are preceded with a ":"
4195 character as in ":html3" (for tags defined in the HTML 3 standard).
4197 Here is a list of the function sets you can import:
4203 Import all CGI-handling methods, such as B<param()>, B<path_info()>
4208 Import all fill-out form generating methods, such as B<textfield()>.
4212 Import all methods that generate HTML 2.0 standard elements.
4216 Import all methods that generate HTML 3.0 elements (such as
4217 <table>, <super> and <sub>).
4221 Import all methods that generate HTML 4 elements (such as
4222 <abbrev>, <acronym> and <thead>).
4226 Import all methods that generate Netscape-specific HTML extensions.
4230 Import all HTML-generating shortcuts (i.e. 'html2' + 'html3' +
4235 Import "standard" features, 'html2', 'html3', 'html4', 'form' and 'cgi'.
4239 Import all the available methods. For the full list, see the CGI.pm
4240 code, where the variable %EXPORT_TAGS is defined.
4244 If you import a function name that is not part of CGI.pm, the module
4245 will treat it as a new HTML tag and generate the appropriate
4246 subroutine. You can then use it like any other HTML tag. This is to
4247 provide for the rapidly-evolving HTML "standard." For example, say
4248 Microsoft comes out with a new tag called <gradient> (which causes the
4249 user's desktop to be flooded with a rotating gradient fill until his
4250 machine reboots). You don't need to wait for a new version of CGI.pm
4251 to start using it immediately:
4253 use CGI qw/:standard :html3 gradient/;
4254 print gradient({-start=>'red',-end=>'blue'});
4256 Note that in the interests of execution speed CGI.pm does B<not> use
4257 the standard L<Exporter> syntax for specifying load symbols. This may
4258 change in the future.
4260 If you import any of the state-maintaining CGI or form-generating
4261 methods, a default CGI object will be created and initialized
4262 automatically the first time you use any of the methods that require
4263 one to be present. This includes B<param()>, B<textfield()>,
4264 B<submit()> and the like. (If you need direct access to the CGI
4265 object, you can find it in the global variable B<$CGI::Q>). By
4266 importing CGI.pm methods, you can create visually elegant scripts:
4268 use CGI qw/:standard/;
4271 start_html('Simple Script'),
4272 h1('Simple Script'),
4274 "What's your name? ",textfield('name'),p,
4275 "What's the combination?",
4276 checkbox_group(-name=>'words',
4277 -values=>['eenie','meenie','minie','moe'],
4278 -defaults=>['eenie','moe']),p,
4279 "What's your favorite color?",
4280 popup_menu(-name=>'color',
4281 -values=>['red','green','blue','chartreuse']),p,
4288 "Your name is ",em(param('name')),p,
4289 "The keywords are: ",em(join(", ",param('words'))),p,
4290 "Your favorite color is ",em(param('color')),".\n";
4296 In addition to the function sets, there are a number of pragmas that
4297 you can import. Pragmas, which are always preceded by a hyphen,
4298 change the way that CGI.pm functions in various ways. Pragmas,
4299 function sets, and individual functions can all be imported in the
4300 same use() line. For example, the following use statement imports the
4301 standard set of functions and enables debugging mode (pragma
4304 use CGI qw/:standard -debug/;
4306 The current list of pragmas is as follows:
4312 When you I<use CGI -any>, then any method that the query object
4313 doesn't recognize will be interpreted as a new HTML tag. This allows
4314 you to support the next I<ad hoc> Netscape or Microsoft HTML
4315 extension. This lets you go wild with new and unsupported tags:
4319 print $q->gradient({speed=>'fast',start=>'red',end=>'blue'});
4321 Since using <cite>any</cite> causes any mistyped method name
4322 to be interpreted as an HTML tag, use it with care or not at
4327 This causes the indicated autoloaded methods to be compiled up front,
4328 rather than deferred to later. This is useful for scripts that run
4329 for an extended period of time under FastCGI or mod_perl, and for
4330 those destined to be crunched by Malcom Beattie's Perl compiler. Use
4331 it in conjunction with the methods or method families you plan to use.
4333 use CGI qw(-compile :standard :html3);
4337 use CGI qw(-compile :all);
4339 Note that using the -compile pragma in this way will always have
4340 the effect of importing the compiled functions into the current
4341 namespace. If you want to compile without importing use the
4342 compile() method instead:
4347 This is particularly useful in a mod_perl environment, in which you
4348 might want to precompile all CGI routines in a startup script, and
4349 then import the functions individually in each mod_perl script.
4353 This makes CGI.pm not generating the hidden fields .submit
4354 and .cgifields. It is very useful if you don't want to
4355 have the hidden fields appear in the querystring in a GET method.
4356 For example, a search script generated this way will have
4357 a very nice url with search parameters for bookmarking.
4359 =item -no_undef_params
4361 This keeps CGI.pm from including undef params in the parameter list.
4365 By default, CGI.pm versions 2.69 and higher emit XHTML
4366 (http://www.w3.org/TR/xhtml1/). The -no_xhtml pragma disables this
4367 feature. Thanks to Michalis Kabrianis <kabrianis@hellug.gr> for this
4372 This makes CGI.pm produce a header appropriate for an NPH (no
4373 parsed header) script. You may need to do other things as well
4374 to tell the server that the script is NPH. See the discussion
4375 of NPH scripts below.
4377 =item -newstyle_urls
4379 Separate the name=value pairs in CGI parameter query strings with
4380 semicolons rather than ampersands. For example:
4382 ?name=fred;age=24;favorite_color=3
4384 Semicolon-delimited query strings are always accepted, but will not be
4385 emitted by self_url() and query_string() unless the -newstyle_urls
4386 pragma is specified.
4388 This became the default in version 2.64.
4390 =item -oldstyle_urls
4392 Separate the name=value pairs in CGI parameter query strings with
4393 ampersands rather than semicolons. This is no longer the default.
4397 This overrides the autoloader so that any function in your program
4398 that is not recognized is referred to CGI.pm for possible evaluation.
4399 This allows you to use all the CGI.pm functions without adding them to
4400 your symbol table, which is of concern for mod_perl users who are
4401 worried about memory consumption. I<Warning:> when
4402 I<-autoload> is in effect, you cannot use "poetry mode"
4403 (functions without the parenthesis). Use I<hr()> rather
4404 than I<hr>, or add something like I<use subs qw/hr p header/>
4405 to the top of your script.
4409 This turns off the command-line processing features. If you want to
4410 run a CGI.pm script from the command line to produce HTML, and you
4411 don't want it to read CGI parameters from the command line or STDIN,
4412 then use this pragma:
4414 use CGI qw(-no_debug :standard);
4418 This turns on full debugging. In addition to reading CGI arguments
4419 from the command-line processing, CGI.pm will pause and try to read
4420 arguments from STDIN, producing the message "(offline mode: enter
4421 name=value pairs on standard input)" features.
4423 See the section on debugging for more details.
4425 =item -private_tempfiles
4427 CGI.pm can process uploaded file. Ordinarily it spools the uploaded
4428 file to a temporary directory, then deletes the file when done.
4429 However, this opens the risk of eavesdropping as described in the file
4430 upload section. Another CGI script author could peek at this data
4431 during the upload, even if it is confidential information. On Unix
4432 systems, the -private_tempfiles pragma will cause the temporary file
4433 to be unlinked as soon as it is opened and before any data is written
4434 into it, reducing, but not eliminating the risk of eavesdropping
4435 (there is still a potential race condition). To make life harder for
4436 the attacker, the program chooses tempfile names by calculating a 32
4437 bit checksum of the incoming HTTP headers.
4439 To ensure that the temporary file cannot be read by other CGI scripts,
4440 use suEXEC or a CGI wrapper program to run your script. The temporary
4441 file is created with mode 0600 (neither world nor group readable).
4443 The temporary directory is selected using the following algorithm:
4445 1. if the current user (e.g. "nobody") has a directory named
4446 "tmp" in its home directory, use that (Unix systems only).
4448 2. if the environment variable TMPDIR exists, use the location
4451 3. Otherwise try the locations /usr/tmp, /var/tmp, C:\temp,
4452 /tmp, /temp, ::Temporary Items, and \WWW_ROOT.
4454 Each of these locations is checked that it is a directory and is
4455 writable. If not, the algorithm tries the next choice.
4459 =head2 SPECIAL FORMS FOR IMPORTING HTML-TAG FUNCTIONS
4461 Many of the methods generate HTML tags. As described below, tag
4462 functions automatically generate both the opening and closing tags.
4465 print h1('Level 1 Header');
4469 <h1>Level 1 Header</h1>
4471 There will be some times when you want to produce the start and end
4472 tags yourself. In this case, you can use the form start_I<tag_name>
4473 and end_I<tag_name>, as in:
4475 print start_h1,'Level 1 Header',end_h1;
4477 With a few exceptions (described below), start_I<tag_name> and
4478 end_I<tag_name> functions are not generated automatically when you
4479 I<use CGI>. However, you can specify the tags you want to generate
4480 I<start/end> functions for by putting an asterisk in front of their
4481 name, or, alternatively, requesting either "start_I<tag_name>" or
4482 "end_I<tag_name>" in the import list.
4486 use CGI qw/:standard *table start_ul/;
4488 In this example, the following functions are generated in addition to
4493 =item 1. start_table() (generates a <table> tag)
4495 =item 2. end_table() (generates a </table> tag)
4497 =item 3. start_ul() (generates a <ul> tag)
4499 =item 4. end_ul() (generates a </ul> tag)
4503 =head1 GENERATING DYNAMIC DOCUMENTS
4505 Most of CGI.pm's functions deal with creating documents on the fly.
4506 Generally you will produce the HTTP header first, followed by the
4507 document itself. CGI.pm provides functions for generating HTTP
4508 headers of various types as well as for generating HTML. For creating
4509 GIF images, see the GD.pm module.
4511 Each of these functions produces a fragment of HTML or HTTP which you
4512 can print out directly so that it displays in the browser window,
4513 append to a string, or save to a file for later use.
4515 =head2 CREATING A STANDARD HTTP HEADER:
4517 Normally the first thing you will do in any CGI script is print out an
4518 HTTP header. This tells the browser what type of document to expect,
4519 and gives other optional information, such as the language, expiration
4520 date, and whether to cache the document. The header can also be
4521 manipulated for special purposes, such as server push and pay per view
4524 print $query->header;
4528 print $query->header('image/gif');
4532 print $query->header('text/html','204 No response');
4536 print $query->header(-type=>'image/gif',
4538 -status=>'402 Payment required',
4542 -attachment=>'foo.gif',
4545 header() returns the Content-type: header. You can provide your own
4546 MIME type if you choose, otherwise it defaults to text/html. An
4547 optional second parameter specifies the status code and a human-readable
4548 message. For example, you can specify 204, "No response" to create a
4549 script that tells the browser to do nothing at all.
4551 The last example shows the named argument style for passing arguments
4552 to the CGI methods using named parameters. Recognized parameters are
4553 B<-type>, B<-status>, B<-expires>, and B<-cookie>. Any other named
4554 parameters will be stripped of their initial hyphens and turned into
4555 header fields, allowing you to specify any HTTP header you desire.
4556 Internal underscores will be turned into hyphens:
4558 print $query->header(-Content_length=>3002);
4560 Most browsers will not cache the output from CGI scripts. Every time
4561 the browser reloads the page, the script is invoked anew. You can
4562 change this behavior with the B<-expires> parameter. When you specify
4563 an absolute or relative expiration interval with this parameter, some
4564 browsers and proxy servers will cache the script's output until the
4565 indicated expiration date. The following forms are all valid for the
4568 +30s 30 seconds from now
4569 +10m ten minutes from now
4570 +1h one hour from now
4571 -1d yesterday (i.e. "ASAP!")
4574 +10y in ten years time
4575 Thursday, 25-Apr-1999 00:40:33 GMT at the indicated time & date
4577 The B<-cookie> parameter generates a header that tells the browser to provide
4578 a "magic cookie" during all subsequent transactions with your script.
4579 Netscape cookies have a special format that includes interesting attributes
4580 such as expiration time. Use the cookie() method to create and retrieve
4583 The B<-nph> parameter, if set to a true value, will issue the correct
4584 headers to work with a NPH (no-parse-header) script. This is important
4585 to use with certain servers that expect all their scripts to be NPH.
4587 The B<-charset> parameter can be used to control the character set
4588 sent to the browser. If not provided, defaults to ISO-8859-1. As a
4589 side effect, this sets the charset() method as well.
4591 The B<-attachment> parameter can be used to turn the page into an
4592 attachment. Instead of displaying the page, some browsers will prompt
4593 the user to save it to disk. The value of the argument is the
4594 suggested name for the saved file. In order for this to work, you may
4595 have to set the B<-type> to "application/octet-stream".
4597 The B<-p3p> parameter will add a P3P tag to the outgoing header. The
4598 parameter can be an arrayref or a space-delimited string of P3P tags.
4601 print header(-p3p=>[qw(CAO DSP LAW CURa)]);
4602 print header(-p3p=>'CAO DSP LAW CURa');
4604 In either case, the outgoing header will be formatted as:
4606 P3P: policyref="/w3c/p3p.xml" cp="CAO DSP LAW CURa"
4608 =head2 GENERATING A REDIRECTION HEADER
4610 print $query->redirect('http://somewhere.else/in/movie/land');
4612 Sometimes you don't want to produce a document yourself, but simply
4613 redirect the browser elsewhere, perhaps choosing a URL based on the
4614 time of day or the identity of the user.
4616 The redirect() function redirects the browser to a different URL. If
4617 you use redirection like this, you should B<not> print out a header as
4620 One hint I can offer is that relative links may not work correctly
4621 when you generate a redirection to another document on your site.
4622 This is due to a well-intentioned optimization that some servers use.
4623 The solution to this is to use the full URL (including the http: part)
4624 of the document you are redirecting to.
4626 You can also use named arguments:
4628 print $query->redirect(-uri=>'http://somewhere.else/in/movie/land',
4631 The B<-nph> parameter, if set to a true value, will issue the correct
4632 headers to work with a NPH (no-parse-header) script. This is important
4633 to use with certain servers, such as Microsoft Internet Explorer, which
4634 expect all their scripts to be NPH.
4636 =head2 CREATING THE HTML DOCUMENT HEADER
4638 print $query->start_html(-title=>'Secrets of the Pyramids',
4639 -author=>'fred@capricorn.org',
4642 -meta=>{'keywords'=>'pharaoh secret mummy',
4643 'copyright'=>'copyright 1996 King Tut'},
4644 -style=>{'src'=>'/styles/style1.css'},
4647 After creating the HTTP header, most CGI scripts will start writing
4648 out an HTML document. The start_html() routine creates the top of the
4649 page, along with a lot of optional information that controls the
4650 page's appearance and behavior.
4652 This method returns a canned HTML header and the opening <body> tag.
4653 All parameters are optional. In the named parameter form, recognized
4654 parameters are -title, -author, -base, -xbase, -dtd, -lang and -target
4655 (see below for the explanation). Any additional parameters you
4656 provide, such as the Netscape unofficial BGCOLOR attribute, are added
4657 to the <body> tag. Additional parameters must be proceeded by a
4660 The argument B<-xbase> allows you to provide an HREF for the <base> tag
4661 different from the current location, as in
4663 -xbase=>"http://home.mcom.com/"
4665 All relative links will be interpreted relative to this tag.
4667 The argument B<-target> allows you to provide a default target frame
4668 for all the links and fill-out forms on the page. B<This is a
4669 non-standard HTTP feature which only works with Netscape browsers!>
4670 See the Netscape documentation on frames for details of how to
4673 -target=>"answer_window"
4675 All relative links will be interpreted relative to this tag.
4676 You add arbitrary meta information to the header with the B<-meta>
4677 argument. This argument expects a reference to an associative array
4678 containing name/value pairs of meta information. These will be turned
4679 into a series of header <meta> tags that look something like this:
4681 <meta name="keywords" content="pharaoh secret mummy">
4682 <meta name="description" content="copyright 1996 King Tut">
4684 To create an HTTP-EQUIV type of <meta> tag, use B<-head>, described
4687 The B<-style> argument is used to incorporate cascading stylesheets
4688 into your code. See the section on CASCADING STYLESHEETS for more
4691 The B<-lang> argument is used to incorporate a language attribute into
4692 the <html> tag. The default if not specified is "en-US" for US
4693 English. For example:
4695 print $q->start_html(-lang=>'fr-CA');
4697 To leave off the lang attribute, as you must do if you want to generate
4698 legal HTML 3.2 or earlier, pass the empty string (-lang=>'').
4700 The B<-encoding> argument can be used to specify the character set for
4701 XHTML. It defaults to iso-8859-1 if not specified.
4703 You can place other arbitrary HTML elements to the <head> section with the
4704 B<-head> tag. For example, to place the rarely-used <link> element in the
4705 head section, use this:
4707 print start_html(-head=>Link({-rel=>'next',
4708 -href=>'http://www.capricorn.com/s2.html'}));
4710 To incorporate multiple HTML elements into the <head> section, just pass an
4713 print start_html(-head=>[
4715 -href=>'http://www.capricorn.com/s2.html'}),
4716 Link({-rel=>'previous',
4717 -href=>'http://www.capricorn.com/s1.html'})
4721 And here's how to create an HTTP-EQUIV <meta> tag:
4723 print start_html(-head=>meta({-http_equiv => 'Content-Type',
4724 -content => 'text/html'}))
4727 JAVASCRIPTING: The B<-script>, B<-noScript>, B<-onLoad>,
4728 B<-onMouseOver>, B<-onMouseOut> and B<-onUnload> parameters are used
4729 to add Netscape JavaScript calls to your pages. B<-script> should
4730 point to a block of text containing JavaScript function definitions.
4731 This block will be placed within a <script> block inside the HTML (not
4732 HTTP) header. The block is placed in the header in order to give your
4733 page a fighting chance of having all its JavaScript functions in place
4734 even if the user presses the stop button before the page has loaded
4735 completely. CGI.pm attempts to format the script in such a way that
4736 JavaScript-naive browsers will not choke on the code: unfortunately
4737 there are some browsers, such as Chimera for Unix, that get confused
4740 The B<-onLoad> and B<-onUnload> parameters point to fragments of JavaScript
4741 code to execute when the page is respectively opened and closed by the
4742 browser. Usually these parameters are calls to functions defined in the
4746 print $query->header;
4748 // Ask a silly question
4749 function riddle_me_this() {
4750 var r = prompt("What walks on four legs in the morning, " +
4751 "two legs in the afternoon, " +
4752 "and three legs in the evening?");
4755 // Get a silly answer
4756 function response(answer) {
4757 if (answer == "man")
4758 alert("Right you are!");
4760 alert("Wrong! Guess again.");
4763 print $query->start_html(-title=>'The Riddle of the Sphinx',
4766 Use the B<-noScript> parameter to pass some HTML text that will be displayed on
4767 browsers that do not have JavaScript (or browsers where JavaScript is turned
4770 Netscape 3.0 recognizes several attributes of the <script> tag,
4771 including LANGUAGE and SRC. The latter is particularly interesting,
4772 as it allows you to keep the JavaScript code in a file or CGI script
4773 rather than cluttering up each page with the source. To use these
4774 attributes pass a HASH reference in the B<-script> parameter containing
4775 one or more of -language, -src, or -code:
4777 print $q->start_html(-title=>'The Riddle of the Sphinx',
4778 -script=>{-language=>'JAVASCRIPT',
4779 -src=>'/javascript/sphinx.js'}
4782 print $q->(-title=>'The Riddle of the Sphinx',
4783 -script=>{-language=>'PERLSCRIPT',
4784 -code=>'print "hello world!\n;"'}
4788 A final feature allows you to incorporate multiple <script> sections into the
4789 header. Just pass the list of script sections as an array reference.
4790 this allows you to specify different source files for different dialects
4791 of JavaScript. Example:
4793 print $q->start_html(-title=>'The Riddle of the Sphinx',
4795 { -language => 'JavaScript1.0',
4796 -src => '/javascript/utilities10.js'
4798 { -language => 'JavaScript1.1',
4799 -src => '/javascript/utilities11.js'
4801 { -language => 'JavaScript1.2',
4802 -src => '/javascript/utilities12.js'
4804 { -language => 'JavaScript28.2',
4805 -src => '/javascript/utilities219.js'
4810 If this looks a bit extreme, take my advice and stick with straight CGI scripting.
4814 http://home.netscape.com/eng/mozilla/2.0/handbook/javascript/
4816 for more information about JavaScript.
4818 The old-style positional parameters are as follows:
4822 =item B<Parameters:>
4830 The author's e-mail address (will create a <link rev="MADE"> tag if present
4834 A 'true' flag if you want to include a <base> tag in the header. This
4835 helps resolve relative addresses to absolute ones when the document is moved,
4836 but makes the document hierarchy non-portable. Use with care!
4840 Any other parameters you want to include in the <body> tag. This is a good
4841 place to put Netscape extensions, such as colors and wallpaper patterns.
4845 =head2 ENDING THE HTML DOCUMENT:
4847 print $query->end_html
4849 This ends an HTML document by printing the </body></html> tags.
4851 =head2 CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION:
4853 $myself = $query->self_url;
4854 print q(<a href="$myself">I'm talking to myself.</a>);
4856 self_url() will return a URL, that, when selected, will reinvoke
4857 this script with all its state information intact. This is most
4858 useful when you want to jump around within the document using
4859 internal anchors but you don't want to disrupt the current contents
4860 of the form(s). Something like this will do the trick.
4862 $myself = $query->self_url;
4863 print "<a href=\"$myself#table1\">See table 1</a>";
4864 print "<a href=\"$myself#table2\">See table 2</a>";
4865 print "<a href=\"$myself#yourself\">See for yourself</a>";
4867 If you want more control over what's returned, using the B<url()>
4870 You can also retrieve the unprocessed query string with query_string():
4872 $the_string = $query->query_string;
4874 =head2 OBTAINING THE SCRIPT'S URL
4876 $full_url = $query->url();
4877 $full_url = $query->url(-full=>1); #alternative syntax
4878 $relative_url = $query->url(-relative=>1);
4879 $absolute_url = $query->url(-absolute=>1);
4880 $url_with_path = $query->url(-path_info=>1);
4881 $url_with_path_and_query = $query->url(-path_info=>1,-query=>1);
4882 $netloc = $query->url(-base => 1);
4884 B<url()> returns the script's URL in a variety of formats. Called
4885 without any arguments, it returns the full form of the URL, including
4886 host name and port number
4888 http://your.host.com/path/to/script.cgi
4890 You can modify this format with the following named arguments:
4896 If true, produce an absolute URL, e.g.
4902 Produce a relative URL. This is useful if you want to reinvoke your
4903 script with different parameters. For example:
4909 Produce the full URL, exactly as if called without any arguments.
4910 This overrides the -relative and -absolute arguments.
4912 =item B<-path> (B<-path_info>)
4914 Append the additional path information to the URL. This can be
4915 combined with B<-full>, B<-absolute> or B<-relative>. B<-path_info>
4916 is provided as a synonym.
4918 =item B<-query> (B<-query_string>)
4920 Append the query string to the URL. This can be combined with
4921 B<-full>, B<-absolute> or B<-relative>. B<-query_string> is provided
4926 Generate just the protocol and net location, as in http://www.foo.com:8000
4930 =head2 MIXING POST AND URL PARAMETERS
4932 $color = $query->url_param('color');
4934 It is possible for a script to receive CGI parameters in the URL as
4935 well as in the fill-out form by creating a form that POSTs to a URL
4936 containing a query string (a "?" mark followed by arguments). The
4937 B<param()> method will always return the contents of the POSTed
4938 fill-out form, ignoring the URL's query string. To retrieve URL
4939 parameters, call the B<url_param()> method. Use it in the same way as
4940 B<param()>. The main difference is that it allows you to read the
4941 parameters, but not set them.
4944 Under no circumstances will the contents of the URL query string
4945 interfere with similarly-named CGI parameters in POSTed forms. If you
4946 try to mix a URL query string with a form submitted with the GET
4947 method, the results will not be what you expect.
4949 =head1 CREATING STANDARD HTML ELEMENTS:
4951 CGI.pm defines general HTML shortcut methods for most, if not all of
4952 the HTML 3 and HTML 4 tags. HTML shortcuts are named after a single
4953 HTML element and return a fragment of HTML text that you can then
4954 print or manipulate as you like. Each shortcut returns a fragment of
4955 HTML code that you can append to a string, save to a file, or, most
4956 commonly, print out so that it displays in the browser window.
4958 This example shows how to use the HTML methods:
4961 print $q->blockquote(
4962 "Many years ago on the island of",
4963 $q->a({href=>"http://crete.org/"},"Crete"),
4964 "there lived a Minotaur named",
4965 $q->strong("Fred."),
4969 This results in the following HTML code (extra newlines have been
4970 added for readability):
4973 Many years ago on the island of
4974 <a href="http://crete.org/">Crete</a> there lived
4975 a minotaur named <strong>Fred.</strong>
4979 If you find the syntax for calling the HTML shortcuts awkward, you can
4980 import them into your namespace and dispense with the object syntax
4981 completely (see the next section for more details):
4983 use CGI ':standard';
4985 "Many years ago on the island of",
4986 a({href=>"http://crete.org/"},"Crete"),
4987 "there lived a minotaur named",
4992 =head2 PROVIDING ARGUMENTS TO HTML SHORTCUTS
4994 The HTML methods will accept zero, one or multiple arguments. If you
4995 provide no arguments, you get a single tag:
4999 If you provide one or more string arguments, they are concatenated
5000 together with spaces and placed between opening and closing tags:
5002 print h1("Chapter","1"); # <h1>Chapter 1</h1>"
5004 If the first argument is an associative array reference, then the keys
5005 and values of the associative array become the HTML tag's attributes:
5007 print a({-href=>'fred.html',-target=>'_new'},
5008 "Open a new frame");
5010 <a href="fred.html",target="_new">Open a new frame</a>
5012 You may dispense with the dashes in front of the attribute names if
5015 print img {src=>'fred.gif',align=>'LEFT'};
5017 <img align="LEFT" src="fred.gif">
5019 Sometimes an HTML tag attribute has no argument. For example, ordered
5020 lists can be marked as COMPACT. The syntax for this is an argument that
5021 that points to an undef string:
5023 print ol({compact=>undef},li('one'),li('two'),li('three'));
5025 Prior to CGI.pm version 2.41, providing an empty ('') string as an
5026 attribute argument was the same as providing undef. However, this has
5027 changed in order to accommodate those who want to create tags of the form
5028 <img alt="">. The difference is shown in these two pieces of code:
5031 img({alt=>undef}) <img alt>
5032 img({alt=>''}) <img alt="">
5034 =head2 THE DISTRIBUTIVE PROPERTY OF HTML SHORTCUTS
5036 One of the cool features of the HTML shortcuts is that they are
5037 distributive. If you give them an argument consisting of a
5038 B<reference> to a list, the tag will be distributed across each
5039 element of the list. For example, here's one way to make an ordered
5043 li({-type=>'disc'},['Sneezy','Doc','Sleepy','Happy'])
5046 This example will result in HTML output that looks like this:
5049 <li type="disc">Sneezy</li>
5050 <li type="disc">Doc</li>
5051 <li type="disc">Sleepy</li>
5052 <li type="disc">Happy</li>
5055 This is extremely useful for creating tables. For example:
5057 print table({-border=>undef},
5058 caption('When Should You Eat Your Vegetables?'),
5059 Tr({-align=>CENTER,-valign=>TOP},
5061 th(['Vegetable', 'Breakfast','Lunch','Dinner']),
5062 td(['Tomatoes' , 'no', 'yes', 'yes']),
5063 td(['Broccoli' , 'no', 'no', 'yes']),
5064 td(['Onions' , 'yes','yes', 'yes'])
5069 =head2 HTML SHORTCUTS AND LIST INTERPOLATION
5071 Consider this bit of code:
5073 print blockquote(em('Hi'),'mom!'));
5075 It will ordinarily return the string that you probably expect, namely:
5077 <blockquote><em>Hi</em> mom!</blockquote>
5079 Note the space between the element "Hi" and the element "mom!".
5080 CGI.pm puts the extra space there using array interpolation, which is
5081 controlled by the magic $" variable. Sometimes this extra space is
5082 not what you want, for example, when you are trying to align a series
5083 of images. In this case, you can simply change the value of $" to an
5088 print blockquote(em('Hi'),'mom!'));
5091 I suggest you put the code in a block as shown here. Otherwise the
5092 change to $" will affect all subsequent code until you explicitly
5095 =head2 NON-STANDARD HTML SHORTCUTS
5097 A few HTML tags don't follow the standard pattern for various
5100 B<comment()> generates an HTML comment (<!-- comment -->). Call it
5103 print comment('here is my comment');
5105 Because of conflicts with built-in Perl functions, the following functions
5106 begin with initial caps:
5115 In addition, start_html(), end_html(), start_form(), end_form(),
5116 start_multipart_form() and all the fill-out form tags are special.
5117 See their respective sections.
5119 =head2 AUTOESCAPING HTML
5121 By default, all HTML that is emitted by the form-generating functions
5122 is passed through a function called escapeHTML():
5126 =item $escaped_string = escapeHTML("unescaped string");
5128 Escape HTML formatting characters in a string.
5132 Provided that you have specified a character set of ISO-8859-1 (the
5133 default), the standard HTML escaping rules will be used. The "<"
5134 character becomes "<", ">" becomes ">", "&" becomes "&", and
5135 the quote character becomes """. In addition, the hexadecimal
5136 0x8b and 0x9b characters, which some browsers incorrectly interpret
5137 as the left and right angle-bracket characters, are replaced by their
5138 numeric character entities ("‹" and "›"). If you manually change
5139 the charset, either by calling the charset() method explicitly or by
5140 passing a -charset argument to header(), then B<all> characters will
5141 be replaced by their numeric entities, since CGI.pm has no lookup
5142 table for all the possible encodings.
5144 The automatic escaping does not apply to other shortcuts, such as
5145 h1(). You should call escapeHTML() yourself on untrusted data in
5146 order to protect your pages against nasty tricks that people may enter
5147 into guestbooks, etc.. To change the character set, use charset().
5148 To turn autoescaping off completely, use autoEscape(0):
5152 =item $charset = charset([$charset]);
5154 Get or set the current character set.
5156 =item $flag = autoEscape([$flag]);
5158 Get or set the value of the autoescape flag.
5162 =head2 PRETTY-PRINTING HTML
5164 By default, all the HTML produced by these functions comes out as one
5165 long line without carriage returns or indentation. This is yuck, but
5166 it does reduce the size of the documents by 10-20%. To get
5167 pretty-printed output, please use L<CGI::Pretty>, a subclass
5168 contributed by Brian Paulsen.
5170 =head1 CREATING FILL-OUT FORMS:
5172 I<General note> The various form-creating methods all return strings
5173 to the caller, containing the tag or tags that will create the requested
5174 form element. You are responsible for actually printing out these strings.
5175 It's set up this way so that you can place formatting tags
5176 around the form elements.
5178 I<Another note> The default values that you specify for the forms are only
5179 used the B<first> time the script is invoked (when there is no query
5180 string). On subsequent invocations of the script (when there is a query
5181 string), the former values are used even if they are blank.
5183 If you want to change the value of a field from its previous value, you have two
5186 (1) call the param() method to set it.
5188 (2) use the -override (alias -force) parameter (a new feature in version 2.15).
5189 This forces the default value to be used, regardless of the previous value:
5191 print $query->textfield(-name=>'field_name',
5192 -default=>'starting value',
5197 I<Yet another note> By default, the text and labels of form elements are
5198 escaped according to HTML rules. This means that you can safely use
5199 "<CLICK ME>" as the label for a button. However, it also interferes with
5200 your ability to incorporate special HTML character sequences, such as Á,
5201 into your fields. If you wish to turn off automatic escaping, call the
5202 autoEscape() method with a false value immediately after creating the CGI object:
5205 $query->autoEscape(undef);
5207 =head2 CREATING AN ISINDEX TAG
5209 print $query->isindex(-action=>$action);
5213 print $query->isindex($action);
5215 Prints out an <isindex> tag. Not very exciting. The parameter
5216 -action specifies the URL of the script to process the query. The
5217 default is to process the query with the current script.
5219 =head2 STARTING AND ENDING A FORM
5221 print $query->start_form(-method=>$method,
5223 -enctype=>$encoding);
5224 <... various form stuff ...>
5225 print $query->endform;
5229 print $query->start_form($method,$action,$encoding);
5230 <... various form stuff ...>
5231 print $query->endform;
5233 start_form() will return a <form> tag with the optional method,
5234 action and form encoding that you specify. The defaults are:
5238 enctype: application/x-www-form-urlencoded
5240 endform() returns the closing </form> tag.
5242 Start_form()'s enctype argument tells the browser how to package the various
5243 fields of the form before sending the form to the server. Two
5244 values are possible:
5246 B<Note:> This method was previously named startform(), and startform()
5247 is still recognized as an alias.
5251 =item B<application/x-www-form-urlencoded>
5253 This is the older type of encoding used by all browsers prior to
5254 Netscape 2.0. It is compatible with many CGI scripts and is
5255 suitable for short fields containing text data. For your
5256 convenience, CGI.pm stores the name of this encoding
5257 type in B<&CGI::URL_ENCODED>.
5259 =item B<multipart/form-data>
5261 This is the newer type of encoding introduced by Netscape 2.0.
5262 It is suitable for forms that contain very large fields or that
5263 are intended for transferring binary data. Most importantly,
5264 it enables the "file upload" feature of Netscape 2.0 forms. For
5265 your convenience, CGI.pm stores the name of this encoding type
5266 in B<&CGI::MULTIPART>
5268 Forms that use this type of encoding are not easily interpreted
5269 by CGI scripts unless they use CGI.pm or another library designed
5274 For compatibility, the start_form() method uses the older form of
5275 encoding by default. If you want to use the newer form of encoding
5276 by default, you can call B<start_multipart_form()> instead of
5279 JAVASCRIPTING: The B<-name> and B<-onSubmit> parameters are provided
5280 for use with JavaScript. The -name parameter gives the
5281 form a name so that it can be identified and manipulated by
5282 JavaScript functions. -onSubmit should point to a JavaScript
5283 function that will be executed just before the form is submitted to your
5284 server. You can use this opportunity to check the contents of the form
5285 for consistency and completeness. If you find something wrong, you
5286 can put up an alert box or maybe fix things up yourself. You can
5287 abort the submission by returning false from this function.
5289 Usually the bulk of JavaScript functions are defined in a <script>
5290 block in the HTML header and -onSubmit points to one of these function
5291 call. See start_html() for details.
5293 =head2 CREATING A TEXT FIELD
5295 print $query->textfield(-name=>'field_name',
5296 -default=>'starting value',
5301 print $query->textfield('field_name','starting value',50,80);
5303 textfield() will return a text input field.
5311 The first parameter is the required name for the field (-name).
5315 The optional second parameter is the default starting value for the field
5316 contents (-default).
5320 The optional third parameter is the size of the field in
5325 The optional fourth parameter is the maximum number of characters the
5326 field will accept (-maxlength).
5330 As with all these methods, the field will be initialized with its
5331 previous contents from earlier invocations of the script.
5332 When the form is processed, the value of the text field can be
5335 $value = $query->param('foo');
5337 If you want to reset it from its initial value after the script has been
5338 called once, you can do so like this:
5340 $query->param('foo',"I'm taking over this value!");
5342 NEW AS OF VERSION 2.15: If you don't want the field to take on its previous
5343 value, you can force its current value by using the -override (alias -force)
5346 print $query->textfield(-name=>'field_name',
5347 -default=>'starting value',
5352 JAVASCRIPTING: You can also provide B<-onChange>, B<-onFocus>,
5353 B<-onBlur>, B<-onMouseOver>, B<-onMouseOut> and B<-onSelect>
5354 parameters to register JavaScript event handlers. The onChange
5355 handler will be called whenever the user changes the contents of the
5356 text field. You can do text validation if you like. onFocus and
5357 onBlur are called respectively when the insertion point moves into and
5358 out of the text field. onSelect is called when the user changes the
5359 portion of the text that is selected.
5361 =head2 CREATING A BIG TEXT FIELD
5363 print $query->textarea(-name=>'foo',
5364 -default=>'starting value',
5370 print $query->textarea('foo','starting value',10,50);
5372 textarea() is just like textfield, but it allows you to specify
5373 rows and columns for a multiline text entry box. You can provide
5374 a starting value for the field, which can be long and contain
5377 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur> ,
5378 B<-onMouseOver>, B<-onMouseOut>, and B<-onSelect> parameters are
5379 recognized. See textfield().
5381 =head2 CREATING A PASSWORD FIELD
5383 print $query->password_field(-name=>'secret',
5384 -value=>'starting value',
5389 print $query->password_field('secret','starting value',50,80);
5391 password_field() is identical to textfield(), except that its contents
5392 will be starred out on the web page.
5394 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>,
5395 B<-onMouseOver>, B<-onMouseOut> and B<-onSelect> parameters are
5396 recognized. See textfield().
5398 =head2 CREATING A FILE UPLOAD FIELD
5400 print $query->filefield(-name=>'uploaded_file',
5401 -default=>'starting value',
5406 print $query->filefield('uploaded_file','starting value',50,80);
5408 filefield() will return a file upload field for Netscape 2.0 browsers.
5409 In order to take full advantage of this I<you must use the new
5410 multipart encoding scheme> for the form. You can do this either
5411 by calling B<start_form()> with an encoding type of B<&CGI::MULTIPART>,
5412 or by calling the new method B<start_multipart_form()> instead of
5413 vanilla B<start_form()>.
5421 The first parameter is the required name for the field (-name).
5425 The optional second parameter is the starting value for the field contents
5426 to be used as the default file name (-default).
5428 For security reasons, browsers don't pay any attention to this field,
5429 and so the starting value will always be blank. Worse, the field
5430 loses its "sticky" behavior and forgets its previous contents. The
5431 starting value field is called for in the HTML specification, however,
5432 and possibly some browser will eventually provide support for it.
5436 The optional third parameter is the size of the field in
5441 The optional fourth parameter is the maximum number of characters the
5442 field will accept (-maxlength).
5446 When the form is processed, you can retrieve the entered filename
5449 $filename = $query->param('uploaded_file');
5451 Different browsers will return slightly different things for the
5452 name. Some browsers return the filename only. Others return the full
5453 path to the file, using the path conventions of the user's machine.
5454 Regardless, the name returned is always the name of the file on the
5455 I<user's> machine, and is unrelated to the name of the temporary file
5456 that CGI.pm creates during upload spooling (see below).
5458 The filename returned is also a file handle. You can read the contents
5459 of the file using standard Perl file reading calls:
5461 # Read a text file and print it out
5462 while (<$filename>) {
5466 # Copy a binary file to somewhere safe
5467 open (OUTFILE,">>/usr/local/web/users/feedback");
5468 while ($bytesread=read($filename,$buffer,1024)) {
5469 print OUTFILE $buffer;
5472 However, there are problems with the dual nature of the upload fields.
5473 If you C<use strict>, then Perl will complain when you try to use a
5474 string as a filehandle. You can get around this by placing the file
5475 reading code in a block containing the C<no strict> pragma. More
5476 seriously, it is possible for the remote user to type garbage into the
5477 upload field, in which case what you get from param() is not a
5478 filehandle at all, but a string.
5480 To be safe, use the I<upload()> function (new in version 2.47). When
5481 called with the name of an upload field, I<upload()> returns a
5482 filehandle, or undef if the parameter is not a valid filehandle.
5484 $fh = $query->upload('uploaded_file');
5489 In an array context, upload() will return an array of filehandles.
5490 This makes it possible to create forms that use the same name for
5491 multiple upload fields.
5493 This is the recommended idiom.
5495 When a file is uploaded the browser usually sends along some
5496 information along with it in the format of headers. The information
5497 usually includes the MIME content type. Future browsers may send
5498 other information as well (such as modification date and size). To
5499 retrieve this information, call uploadInfo(). It returns a reference to
5500 an associative array containing all the document headers.
5502 $filename = $query->param('uploaded_file');
5503 $type = $query->uploadInfo($filename)->{'Content-Type'};
5504 unless ($type eq 'text/html') {
5505 die "HTML FILES ONLY!";
5508 If you are using a machine that recognizes "text" and "binary" data
5509 modes, be sure to understand when and how to use them (see the Camel book).
5510 Otherwise you may find that binary files are corrupted during file
5513 There are occasionally problems involving parsing the uploaded file.
5514 This usually happens when the user presses "Stop" before the upload is
5515 finished. In this case, CGI.pm will return undef for the name of the
5516 uploaded file and set I<cgi_error()> to the string "400 Bad request
5517 (malformed multipart POST)". This error message is designed so that
5518 you can incorporate it into a status code to be sent to the browser.
5521 $file = $query->upload('uploaded_file');
5522 if (!$file && $query->cgi_error) {
5523 print $query->header(-status=>$query->cgi_error);
5527 You are free to create a custom HTML page to complain about the error,
5530 If you are using CGI.pm on a Windows platform and find that binary
5531 files get slightly larger when uploaded but that text files remain the
5532 same, then you have forgotten to activate binary mode on the output
5533 filehandle. Be sure to call binmode() on any handle that you create
5534 to write the uploaded file to disk.
5536 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>,
5537 B<-onMouseOver>, B<-onMouseOut> and B<-onSelect> parameters are
5538 recognized. See textfield() for details.
5540 =head2 CREATING A POPUP MENU
5542 print $query->popup_menu('menu_name',
5543 ['eenie','meenie','minie'],
5548 %labels = ('eenie'=>'your first choice',
5549 'meenie'=>'your second choice',
5550 'minie'=>'your third choice');
5551 %attributes = ('eenie'=>{'class'=>'class of first choice'});
5552 print $query->popup_menu('menu_name',
5553 ['eenie','meenie','minie'],
5554 'meenie',\%labels,\%attributes);
5556 -or (named parameter style)-
5558 print $query->popup_menu(-name=>'menu_name',
5559 -values=>['eenie','meenie','minie'],
5562 -attributes=>\%attributes);
5564 popup_menu() creates a menu.
5570 The required first argument is the menu's name (-name).
5574 The required second argument (-values) is an array B<reference>
5575 containing the list of menu items in the menu. You can pass the
5576 method an anonymous array, as shown in the example, or a reference to
5577 a named array, such as "\@foo".
5581 The optional third parameter (-default) is the name of the default
5582 menu choice. If not specified, the first item will be the default.
5583 The values of the previous choice will be maintained across queries.
5587 The optional fourth parameter (-labels) is provided for people who
5588 want to use different values for the user-visible label inside the
5589 popup menu and the value returned to your script. It's a pointer to an
5590 associative array relating menu values to user-visible labels. If you
5591 leave this parameter blank, the menu values will be displayed by
5592 default. (You can also leave a label undefined if you want to).
5596 The optional fifth parameter (-attributes) is provided to assign
5597 any of the common HTML attributes to an individual menu item. It's
5598 a pointer to an associative array relating menu values to another
5599 associative array with the attribute's name as the key and the
5600 attribute's value as the value.
5604 When the form is processed, the selected value of the popup menu can
5607 $popup_menu_value = $query->param('menu_name');
5609 JAVASCRIPTING: popup_menu() recognizes the following event handlers:
5610 B<-onChange>, B<-onFocus>, B<-onMouseOver>, B<-onMouseOut>, and
5611 B<-onBlur>. See the textfield() section for details on when these
5612 handlers are called.
5614 =head2 CREATING AN OPTION GROUP
5616 Named parameter style
5618 print $query->popup_menu(-name=>'menu_name',
5619 -values=>[qw/eenie meenie minie/,
5620 $q->optgroup(-name=>'optgroup_name',
5621 -values ['moe','catch'],
5622 -attributes=>{'catch'=>{'class'=>'red'}}),
5623 -labels=>{'eenie'=>'one',
5626 -default=>'meenie');
5629 print $query->popup_menu('menu_name',
5630 ['eenie','meenie','minie',
5631 $q->optgroup('optgroup_name', ['moe', 'catch'],
5632 {'catch'=>{'class'=>'red'}})],'meenie',
5633 {'eenie'=>'one','meenie'=>'two','minie'=>'three'});
5635 optgroup creates an option group within a popup menu.
5641 The required first argument (B<-name>) is the label attribute of the
5642 optgroup and is B<not> inserted in the parameter list of the query.
5646 The required second argument (B<-values>) is an array reference
5647 containing the list of menu items in the menu. You can pass the
5648 method an anonymous array, as shown in the example, or a reference
5649 to a named array, such as \@foo. If you pass a HASH reference,
5650 the keys will be used for the menu values, and the values will be
5651 used for the menu labels (see -labels below).
5655 The optional third parameter (B<-labels>) allows you to pass a reference
5656 to an associative array containing user-visible labels for one or more
5657 of the menu items. You can use this when you want the user to see one
5658 menu string, but have the browser return your program a different one.
5659 If you don't specify this, the value string will be used instead
5660 ("eenie", "meenie" and "minie" in this example). This is equivalent
5661 to using a hash reference for the -values parameter.
5665 An optional fourth parameter (B<-labeled>) can be set to a true value
5666 and indicates that the values should be used as the label attribute
5667 for each option element within the optgroup.
5671 An optional fifth parameter (-novals) can be set to a true value and
5672 indicates to suppress the val attribut in each option element within
5675 See the discussion on optgroup at W3C
5676 (http://www.w3.org/TR/REC-html40/interact/forms.html#edef-OPTGROUP)
5681 An optional sixth parameter (-attributes) is provided to assign
5682 any of the common HTML attributes to an individual menu item. It's
5683 a pointer to an associative array relating menu values to another
5684 associative array with the attribute's name as the key and the
5685 attribute's value as the value.
5687 =head2 CREATING A SCROLLING LIST
5689 print $query->scrolling_list('list_name',
5690 ['eenie','meenie','minie','moe'],
5691 ['eenie','moe'],5,'true',{'moe'=>{'class'=>'red'}});
5694 print $query->scrolling_list('list_name',
5695 ['eenie','meenie','minie','moe'],
5696 ['eenie','moe'],5,'true',
5697 \%labels,%attributes);
5701 print $query->scrolling_list(-name=>'list_name',
5702 -values=>['eenie','meenie','minie','moe'],
5703 -default=>['eenie','moe'],
5707 -attributes=>\%attributes);
5709 scrolling_list() creates a scrolling list.
5713 =item B<Parameters:>
5717 The first and second arguments are the list name (-name) and values
5718 (-values). As in the popup menu, the second argument should be an
5723 The optional third argument (-default) can be either a reference to a
5724 list containing the values to be selected by default, or can be a
5725 single value to select. If this argument is missing or undefined,
5726 then nothing is selected when the list first appears. In the named
5727 parameter version, you can use the synonym "-defaults" for this
5732 The optional fourth argument is the size of the list (-size).
5736 The optional fifth argument can be set to true to allow multiple
5737 simultaneous selections (-multiple). Otherwise only one selection
5738 will be allowed at a time.
5742 The optional sixth argument is a pointer to an associative array
5743 containing long user-visible labels for the list items (-labels).
5744 If not provided, the values will be displayed.
5748 The optional sixth parameter (-attributes) is provided to assign
5749 any of the common HTML attributes to an individual menu item. It's
5750 a pointer to an associative array relating menu values to another
5751 associative array with the attribute's name as the key and the
5752 attribute's value as the value.
5754 When this form is processed, all selected list items will be returned as
5755 a list under the parameter name 'list_name'. The values of the
5756 selected items can be retrieved with:
5758 @selected = $query->param('list_name');
5762 JAVASCRIPTING: scrolling_list() recognizes the following event
5763 handlers: B<-onChange>, B<-onFocus>, B<-onMouseOver>, B<-onMouseOut>
5764 and B<-onBlur>. See textfield() for the description of when these
5765 handlers are called.
5767 =head2 CREATING A GROUP OF RELATED CHECKBOXES
5769 print $query->checkbox_group(-name=>'group_name',
5770 -values=>['eenie','meenie','minie','moe'],
5771 -default=>['eenie','moe'],
5774 -attributes=>\%attributes);
5776 print $query->checkbox_group('group_name',
5777 ['eenie','meenie','minie','moe'],
5778 ['eenie','moe'],'true',\%labels,
5779 {'moe'=>{'class'=>'red'}});
5781 HTML3-COMPATIBLE BROWSERS ONLY:
5783 print $query->checkbox_group(-name=>'group_name',
5784 -values=>['eenie','meenie','minie','moe'],
5785 -rows=2,-columns=>2);
5788 checkbox_group() creates a list of checkboxes that are related
5793 =item B<Parameters:>
5797 The first and second arguments are the checkbox name and values,
5798 respectively (-name and -values). As in the popup menu, the second
5799 argument should be an array reference. These values are used for the
5800 user-readable labels printed next to the checkboxes as well as for the
5801 values passed to your script in the query string.
5805 The optional third argument (-default) can be either a reference to a
5806 list containing the values to be checked by default, or can be a
5807 single value to checked. If this argument is missing or undefined,
5808 then nothing is selected when the list first appears.
5812 The optional fourth argument (-linebreak) can be set to true to place
5813 line breaks between the checkboxes so that they appear as a vertical
5814 list. Otherwise, they will be strung together on a horizontal line.
5818 The optional fifth argument is a pointer to an associative array
5819 relating the checkbox values to the user-visible labels that will
5820 be printed next to them (-labels). If not provided, the values will
5821 be used as the default.
5825 B<HTML3-compatible browsers> (such as Netscape) can take advantage of
5826 the optional parameters B<-rows>, and B<-columns>. These parameters
5827 cause checkbox_group() to return an HTML3 compatible table containing
5828 the checkbox group formatted with the specified number of rows and
5829 columns. You can provide just the -columns parameter if you wish;
5830 checkbox_group will calculate the correct number of rows for you.
5834 The optional sixth parameter (-attributes) is provided to assign
5835 any of the common HTML attributes to an individual menu item. It's
5836 a pointer to an associative array relating menu values to another
5837 associative array with the attribute's name as the key and the
5838 attribute's value as the value.
5840 To include row and column headings in the returned table, you
5841 can use the B<-rowheaders> and B<-colheaders> parameters. Both
5842 of these accept a pointer to an array of headings to use.
5843 The headings are just decorative. They don't reorganize the
5844 interpretation of the checkboxes -- they're still a single named
5849 When the form is processed, all checked boxes will be returned as
5850 a list under the parameter name 'group_name'. The values of the
5851 "on" checkboxes can be retrieved with:
5853 @turned_on = $query->param('group_name');
5855 The value returned by checkbox_group() is actually an array of button
5856 elements. You can capture them and use them within tables, lists,
5857 or in other creative ways:
5859 @h = $query->checkbox_group(-name=>'group_name',-values=>\@values);
5860 &use_in_creative_way(@h);
5862 JAVASCRIPTING: checkbox_group() recognizes the B<-onClick>
5863 parameter. This specifies a JavaScript code fragment or
5864 function call to be executed every time the user clicks on
5865 any of the buttons in the group. You can retrieve the identity
5866 of the particular button clicked on using the "this" variable.
5868 =head2 CREATING A STANDALONE CHECKBOX
5870 print $query->checkbox(-name=>'checkbox_name',
5873 -label=>'CLICK ME');
5877 print $query->checkbox('checkbox_name','checked','ON','CLICK ME');
5879 checkbox() is used to create an isolated checkbox that isn't logically
5880 related to any others.
5884 =item B<Parameters:>
5888 The first parameter is the required name for the checkbox (-name). It
5889 will also be used for the user-readable label printed next to the
5894 The optional second parameter (-checked) specifies that the checkbox
5895 is turned on by default. Synonyms are -selected and -on.
5899 The optional third parameter (-value) specifies the value of the
5900 checkbox when it is checked. If not provided, the word "on" is
5905 The optional fourth parameter (-label) is the user-readable label to
5906 be attached to the checkbox. If not provided, the checkbox name is
5911 The value of the checkbox can be retrieved using:
5913 $turned_on = $query->param('checkbox_name');
5915 JAVASCRIPTING: checkbox() recognizes the B<-onClick>
5916 parameter. See checkbox_group() for further details.
5918 =head2 CREATING A RADIO BUTTON GROUP
5920 print $query->radio_group(-name=>'group_name',
5921 -values=>['eenie','meenie','minie'],
5925 -attributes=>\%attributes);
5929 print $query->radio_group('group_name',['eenie','meenie','minie'],
5930 'meenie','true',\%labels,\%attributes);
5933 HTML3-COMPATIBLE BROWSERS ONLY:
5935 print $query->radio_group(-name=>'group_name',
5936 -values=>['eenie','meenie','minie','moe'],
5937 -rows=2,-columns=>2);
5939 radio_group() creates a set of logically-related radio buttons
5940 (turning one member of the group on turns the others off)
5944 =item B<Parameters:>
5948 The first argument is the name of the group and is required (-name).
5952 The second argument (-values) is the list of values for the radio
5953 buttons. The values and the labels that appear on the page are
5954 identical. Pass an array I<reference> in the second argument, either
5955 using an anonymous array, as shown, or by referencing a named array as
5960 The optional third parameter (-default) is the name of the default
5961 button to turn on. If not specified, the first item will be the
5962 default. You can provide a nonexistent button name, such as "-" to
5963 start up with no buttons selected.
5967 The optional fourth parameter (-linebreak) can be set to 'true' to put
5968 line breaks between the buttons, creating a vertical list.
5972 The optional fifth parameter (-labels) is a pointer to an associative
5973 array relating the radio button values to user-visible labels to be
5974 used in the display. If not provided, the values themselves are
5979 B<HTML3-compatible browsers> (such as Netscape) can take advantage
5981 parameters B<-rows>, and B<-columns>. These parameters cause
5982 radio_group() to return an HTML3 compatible table containing
5983 the radio group formatted with the specified number of rows
5984 and columns. You can provide just the -columns parameter if you
5985 wish; radio_group will calculate the correct number of rows
5990 The optional sixth parameter (-attributes) is provided to assign
5991 any of the common HTML attributes to an individual menu item. It's
5992 a pointer to an associative array relating menu values to another
5993 associative array with the attribute's name as the key and the
5994 attribute's value as the value.
5996 To include row and column headings in the returned table, you
5997 can use the B<-rowheader> and B<-colheader> parameters. Both
5998 of these accept a pointer to an array of headings to use.
5999 The headings are just decorative. They don't reorganize the
6000 interpretation of the radio buttons -- they're still a single named
6005 When the form is processed, the selected radio button can
6008 $which_radio_button = $query->param('group_name');
6010 The value returned by radio_group() is actually an array of button
6011 elements. You can capture them and use them within tables, lists,
6012 or in other creative ways:
6014 @h = $query->radio_group(-name=>'group_name',-values=>\@values);
6015 &use_in_creative_way(@h);
6017 =head2 CREATING A SUBMIT BUTTON
6019 print $query->submit(-name=>'button_name',
6024 print $query->submit('button_name','value');
6026 submit() will create the query submission button. Every form
6027 should have one of these.
6031 =item B<Parameters:>
6035 The first argument (-name) is optional. You can give the button a
6036 name if you have several submission buttons in your form and you want
6037 to distinguish between them. The name will also be used as the
6038 user-visible label. Be aware that a few older browsers don't deal with this correctly and
6039 B<never> send back a value from a button.
6043 The second argument (-value) is also optional. This gives the button
6044 a value that will be passed to your script in the query string.
6048 You can figure out which button was pressed by using different
6049 values for each one:
6051 $which_one = $query->param('button_name');
6053 JAVASCRIPTING: radio_group() recognizes the B<-onClick>
6054 parameter. See checkbox_group() for further details.
6056 =head2 CREATING A RESET BUTTON
6060 reset() creates the "reset" button. Note that it restores the
6061 form to its value from the last time the script was called,
6062 NOT necessarily to the defaults.
6064 Note that this conflicts with the Perl reset() built-in. Use
6065 CORE::reset() to get the original reset function.
6067 =head2 CREATING A DEFAULT BUTTON
6069 print $query->defaults('button_label')
6071 defaults() creates a button that, when invoked, will cause the
6072 form to be completely reset to its defaults, wiping out all the
6073 changes the user ever made.
6075 =head2 CREATING A HIDDEN FIELD
6077 print $query->hidden(-name=>'hidden_name',
6078 -default=>['value1','value2'...]);
6082 print $query->hidden('hidden_name','value1','value2'...);
6084 hidden() produces a text field that can't be seen by the user. It
6085 is useful for passing state variable information from one invocation
6086 of the script to the next.
6090 =item B<Parameters:>
6094 The first argument is required and specifies the name of this
6099 The second argument is also required and specifies its value
6100 (-default). In the named parameter style of calling, you can provide
6101 a single value here or a reference to a whole list
6105 Fetch the value of a hidden field this way:
6107 $hidden_value = $query->param('hidden_name');
6109 Note, that just like all the other form elements, the value of a
6110 hidden field is "sticky". If you want to replace a hidden field with
6111 some other values after the script has been called once you'll have to
6114 $query->param('hidden_name','new','values','here');
6116 =head2 CREATING A CLICKABLE IMAGE BUTTON
6118 print $query->image_button(-name=>'button_name',
6119 -src=>'/source/URL',
6124 print $query->image_button('button_name','/source/URL','MIDDLE');
6126 image_button() produces a clickable image. When it's clicked on the
6127 position of the click is returned to your script as "button_name.x"
6128 and "button_name.y", where "button_name" is the name you've assigned
6131 JAVASCRIPTING: image_button() recognizes the B<-onClick>
6132 parameter. See checkbox_group() for further details.
6136 =item B<Parameters:>
6140 The first argument (-name) is required and specifies the name of this
6145 The second argument (-src) is also required and specifies the URL
6148 The third option (-align, optional) is an alignment type, and may be
6149 TOP, BOTTOM or MIDDLE
6153 Fetch the value of the button this way:
6154 $x = $query->param('button_name.x');
6155 $y = $query->param('button_name.y');
6157 =head2 CREATING A JAVASCRIPT ACTION BUTTON
6159 print $query->button(-name=>'button_name',
6160 -value=>'user visible label',
6161 -onClick=>"do_something()");
6165 print $query->button('button_name',"do_something()");
6167 button() produces a button that is compatible with Netscape 2.0's
6168 JavaScript. When it's pressed the fragment of JavaScript code
6169 pointed to by the B<-onClick> parameter will be executed. On
6170 non-Netscape browsers this form element will probably not even
6175 Netscape browsers versions 1.1 and higher, and all versions of
6176 Internet Explorer, support a so-called "cookie" designed to help
6177 maintain state within a browser session. CGI.pm has several methods
6178 that support cookies.
6180 A cookie is a name=value pair much like the named parameters in a CGI
6181 query string. CGI scripts create one or more cookies and send
6182 them to the browser in the HTTP header. The browser maintains a list
6183 of cookies that belong to a particular Web server, and returns them
6184 to the CGI script during subsequent interactions.
6186 In addition to the required name=value pair, each cookie has several
6187 optional attributes:
6191 =item 1. an expiration time
6193 This is a time/date string (in a special GMT format) that indicates
6194 when a cookie expires. The cookie will be saved and returned to your
6195 script until this expiration date is reached if the user exits
6196 the browser and restarts it. If an expiration date isn't specified, the cookie
6197 will remain active until the user quits the browser.
6201 This is a partial or complete domain name for which the cookie is
6202 valid. The browser will return the cookie to any host that matches
6203 the partial domain name. For example, if you specify a domain name
6204 of ".capricorn.com", then the browser will return the cookie to
6205 Web servers running on any of the machines "www.capricorn.com",
6206 "www2.capricorn.com", "feckless.capricorn.com", etc. Domain names
6207 must contain at least two periods to prevent attempts to match
6208 on top level domains like ".edu". If no domain is specified, then
6209 the browser will only return the cookie to servers on the host the
6210 cookie originated from.
6214 If you provide a cookie path attribute, the browser will check it
6215 against your script's URL before returning the cookie. For example,
6216 if you specify the path "/cgi-bin", then the cookie will be returned
6217 to each of the scripts "/cgi-bin/tally.pl", "/cgi-bin/order.pl",
6218 and "/cgi-bin/customer_service/complain.pl", but not to the script
6219 "/cgi-private/site_admin.pl". By default, path is set to "/", which
6220 causes the cookie to be sent to any CGI script on your site.
6222 =item 4. a "secure" flag
6224 If the "secure" attribute is set, the cookie will only be sent to your
6225 script if the CGI request is occurring on a secure channel, such as SSL.
6229 The interface to HTTP cookies is the B<cookie()> method:
6231 $cookie = $query->cookie(-name=>'sessionID',
6234 -path=>'/cgi-bin/database',
6235 -domain=>'.capricorn.org',
6237 print $query->header(-cookie=>$cookie);
6239 B<cookie()> creates a new cookie. Its parameters include:
6245 The name of the cookie (required). This can be any string at all.
6246 Although browsers limit their cookie names to non-whitespace
6247 alphanumeric characters, CGI.pm removes this restriction by escaping
6248 and unescaping cookies behind the scenes.
6252 The value of the cookie. This can be any scalar value,
6253 array reference, or even associative array reference. For example,
6254 you can store an entire associative array into a cookie this way:
6256 $cookie=$query->cookie(-name=>'family information',
6257 -value=>\%childrens_ages);
6261 The optional partial path for which this cookie will be valid, as described
6266 The optional partial domain for which this cookie will be valid, as described
6271 The optional expiration date for this cookie. The format is as described
6272 in the section on the B<header()> method:
6274 "+1h" one hour from now
6278 If set to true, this cookie will only be used within a secure
6283 The cookie created by cookie() must be incorporated into the HTTP
6284 header within the string returned by the header() method:
6286 print $query->header(-cookie=>$my_cookie);
6288 To create multiple cookies, give header() an array reference:
6290 $cookie1 = $query->cookie(-name=>'riddle_name',
6291 -value=>"The Sphynx's Question");
6292 $cookie2 = $query->cookie(-name=>'answers',
6294 print $query->header(-cookie=>[$cookie1,$cookie2]);
6296 To retrieve a cookie, request it by name by calling cookie() method
6297 without the B<-value> parameter:
6301 $riddle = $query->cookie('riddle_name');
6302 %answers = $query->cookie('answers');
6304 Cookies created with a single scalar value, such as the "riddle_name"
6305 cookie, will be returned in that form. Cookies with array and hash
6306 values can also be retrieved.
6308 The cookie and CGI namespaces are separate. If you have a parameter
6309 named 'answers' and a cookie named 'answers', the values retrieved by
6310 param() and cookie() are independent of each other. However, it's
6311 simple to turn a CGI parameter into a cookie, and vice-versa:
6313 # turn a CGI parameter into a cookie
6314 $c=$q->cookie(-name=>'answers',-value=>[$q->param('answers')]);
6316 $q->param(-name=>'answers',-value=>[$q->cookie('answers')]);
6318 See the B<cookie.cgi> example script for some ideas on how to use
6319 cookies effectively.
6321 =head1 WORKING WITH FRAMES
6323 It's possible for CGI.pm scripts to write into several browser panels
6324 and windows using the HTML 4 frame mechanism. There are three
6325 techniques for defining new frames programmatically:
6329 =item 1. Create a <Frameset> document
6331 After writing out the HTTP header, instead of creating a standard
6332 HTML document using the start_html() call, create a <frameset>
6333 document that defines the frames on the page. Specify your script(s)
6334 (with appropriate parameters) as the SRC for each of the frames.
6336 There is no specific support for creating <frameset> sections
6337 in CGI.pm, but the HTML is very simple to write. See the frame
6338 documentation in Netscape's home pages for details
6340 http://home.netscape.com/assist/net_sites/frames.html
6342 =item 2. Specify the destination for the document in the HTTP header
6344 You may provide a B<-target> parameter to the header() method:
6346 print $q->header(-target=>'ResultsWindow');
6348 This will tell the browser to load the output of your script into the
6349 frame named "ResultsWindow". If a frame of that name doesn't already
6350 exist, the browser will pop up a new window and load your script's
6351 document into that. There are a number of magic names that you can
6352 use for targets. See the frame documents on Netscape's home pages for
6355 =item 3. Specify the destination for the document in the <form> tag
6357 You can specify the frame to load in the FORM tag itself. With
6358 CGI.pm it looks like this:
6360 print $q->start_form(-target=>'ResultsWindow');
6362 When your script is reinvoked by the form, its output will be loaded
6363 into the frame named "ResultsWindow". If one doesn't already exist
6364 a new window will be created.
6368 The script "frameset.cgi" in the examples directory shows one way to
6369 create pages in which the fill-out form and the response live in
6370 side-by-side frames.
6372 =head1 LIMITED SUPPORT FOR CASCADING STYLE SHEETS
6374 CGI.pm has limited support for HTML3's cascading style sheets (css).
6375 To incorporate a stylesheet into your document, pass the
6376 start_html() method a B<-style> parameter. The value of this
6377 parameter may be a scalar, in which case it is incorporated directly
6378 into a <style> section, or it may be a hash reference. In the latter
6379 case you should provide the hash with one or more of B<-src> or
6380 B<-code>. B<-src> points to a URL where an externally-defined
6381 stylesheet can be found. B<-code> points to a scalar value to be
6382 incorporated into a <style> section. Style definitions in B<-code>
6383 override similarly-named ones in B<-src>, hence the name "cascading."
6385 You may also specify the type of the stylesheet by adding the optional
6386 B<-type> parameter to the hash pointed to by B<-style>. If not
6387 specified, the style defaults to 'text/css'.
6389 To refer to a style within the body of your document, add the
6390 B<-class> parameter to any HTML element:
6392 print h1({-class=>'Fancy'},'Welcome to the Party');
6394 Or define styles on the fly with the B<-style> parameter:
6396 print h1({-style=>'Color: red;'},'Welcome to Hell');
6398 You may also use the new B<span()> element to apply a style to a
6401 print span({-style=>'Color: red;'},
6402 h1('Welcome to Hell'),
6403 "Where did that handbasket get to?"
6406 Note that you must import the ":html3" definitions to have the
6407 B<span()> method available. Here's a quick and dirty example of using
6408 CSS's. See the CSS specification at
6409 http://www.w3.org/pub/WWW/TR/Wd-css-1.html for more information.
6411 use CGI qw/:standard :html3/;
6413 #here's a stylesheet incorporated directly into the page
6423 font-family: sans-serif;
6429 print start_html( -title=>'CGI with Style',
6430 -style=>{-src=>'http://www.capricorn.com/style/st1.css',
6433 print h1('CGI with Style'),
6435 "Better read the cascading style sheet spec before playing with this!"),
6436 span({-style=>'color: magenta'},
6437 "Look Mom, no hands!",
6443 Pass an array reference to B<-style> in order to incorporate multiple
6444 stylesheets into your document.
6446 Should you wish to incorporate a verbatim stylesheet that includes
6447 arbitrary formatting in the header, you may pass a -verbatim tag to
6448 the -style hash, as follows:
6450 print $q->start_html (-STYLE => {-verbatim => '@import
6451 url("/server-common/css/'.$cssFile.'");',
6452 -src => '/server-common/css/core.css'});
6456 This will generate an HTML header that contains this:
6458 <link rel="stylesheet" type="text/css" href="/server-common/css/core.css">
6459 <style type="text/css">
6460 @import url("/server-common/css/main.css");
6465 If you are running the script from the command line or in the perl
6466 debugger, you can pass the script a list of keywords or
6467 parameter=value pairs on the command line or from standard input (you
6468 don't have to worry about tricking your script into reading from
6469 environment variables). You can pass keywords like this:
6471 your_script.pl keyword1 keyword2 keyword3
6475 your_script.pl keyword1+keyword2+keyword3
6479 your_script.pl name1=value1 name2=value2
6483 your_script.pl name1=value1&name2=value2
6485 To turn off this feature, use the -no_debug pragma.
6487 To test the POST method, you may enable full debugging with the -debug
6488 pragma. This will allow you to feed newline-delimited name=value
6489 pairs to the script on standard input.
6491 When debugging, you can use quotes and backslashes to escape
6492 characters in the familiar shell manner, letting you place
6493 spaces and other funny characters in your parameter=value
6496 your_script.pl "name1='I am a long value'" "name2=two\ words"
6498 =head2 DUMPING OUT ALL THE NAME/VALUE PAIRS
6500 The Dump() method produces a string consisting of all the query's
6501 name/value pairs formatted nicely as a nested list. This is useful
6502 for debugging purposes:
6507 Produces something that looks like:
6521 As a shortcut, you can interpolate the entire CGI object into a string
6522 and it will be replaced with the a nice HTML dump shown above:
6525 print "<h2>Current Values</h2> $query\n";
6527 =head1 FETCHING ENVIRONMENT VARIABLES
6529 Some of the more useful environment variables can be fetched
6530 through this interface. The methods are as follows:
6536 Return a list of MIME types that the remote browser accepts. If you
6537 give this method a single argument corresponding to a MIME type, as in
6538 $query->Accept('text/html'), it will return a floating point value
6539 corresponding to the browser's preference for this type from 0.0
6540 (don't want) to 1.0. Glob types (e.g. text/*) in the browser's accept
6541 list are handled correctly.
6543 Note that the capitalization changed between version 2.43 and 2.44 in
6544 order to avoid conflict with Perl's accept() function.
6546 =item B<raw_cookie()>
6548 Returns the HTTP_COOKIE variable, an HTTP extension implemented by
6549 Netscape browsers version 1.1 and higher, and all versions of Internet
6550 Explorer. Cookies have a special format, and this method call just
6551 returns the raw form (?cookie dough). See cookie() for ways of
6552 setting and retrieving cooked cookies.
6554 Called with no parameters, raw_cookie() returns the packed cookie
6555 structure. You can separate it into individual cookies by splitting
6556 on the character sequence "; ". Called with the name of a cookie,
6557 retrieves the B<unescaped> form of the cookie. You can use the
6558 regular cookie() method to get the names, or use the raw_fetch()
6559 method from the CGI::Cookie module.
6561 =item B<user_agent()>
6563 Returns the HTTP_USER_AGENT variable. If you give
6564 this method a single argument, it will attempt to
6565 pattern match on it, allowing you to do something
6566 like $query->user_agent(netscape);
6568 =item B<path_info()>
6570 Returns additional path information from the script URL.
6571 E.G. fetching /cgi-bin/your_script/additional/stuff will result in
6572 $query->path_info() returning "/additional/stuff".
6574 NOTE: The Microsoft Internet Information Server
6575 is broken with respect to additional path information. If
6576 you use the Perl DLL library, the IIS server will attempt to
6577 execute the additional path information as a Perl script.
6578 If you use the ordinary file associations mapping, the
6579 path information will be present in the environment,
6580 but incorrect. The best thing to do is to avoid using additional
6581 path information in CGI scripts destined for use with IIS.
6583 =item B<path_translated()>
6585 As per path_info() but returns the additional
6586 path information translated into a physical path, e.g.
6587 "/usr/local/etc/httpd/htdocs/additional/stuff".
6589 The Microsoft IIS is broken with respect to the translated
6592 =item B<remote_host()>
6594 Returns either the remote host name or IP address.
6595 if the former is unavailable.
6597 =item B<script_name()>
6598 Return the script name as a partial URL, for self-refering
6603 Return the URL of the page the browser was viewing
6604 prior to fetching your script. Not available for all
6607 =item B<auth_type ()>
6609 Return the authorization/verification method in use for this
6612 =item B<server_name ()>
6614 Returns the name of the server, usually the machine's host
6617 =item B<virtual_host ()>
6619 When using virtual hosts, returns the name of the host that
6620 the browser attempted to contact
6622 =item B<server_port ()>
6624 Return the port that the server is listening on.
6626 =item B<server_software ()>
6628 Returns the server software and version number.
6630 =item B<remote_user ()>
6632 Return the authorization/verification name used for user
6633 verification, if this script is protected.
6635 =item B<user_name ()>
6637 Attempt to obtain the remote user's name, using a variety of different
6638 techniques. This only works with older browsers such as Mosaic.
6639 Newer browsers do not report the user name for privacy reasons!
6641 =item B<request_method()>
6643 Returns the method used to access your script, usually
6644 one of 'POST', 'GET' or 'HEAD'.
6646 =item B<content_type()>
6648 Returns the content_type of data submitted in a POST, generally
6649 multipart/form-data or application/x-www-form-urlencoded
6653 Called with no arguments returns the list of HTTP environment
6654 variables, including such things as HTTP_USER_AGENT,
6655 HTTP_ACCEPT_LANGUAGE, and HTTP_ACCEPT_CHARSET, corresponding to the
6656 like-named HTTP header fields in the request. Called with the name of
6657 an HTTP header field, returns its value. Capitalization and the use
6658 of hyphens versus underscores are not significant.
6660 For example, all three of these examples are equivalent:
6662 $requested_language = $q->http('Accept-language');
6663 $requested_language = $q->http('Accept_language');
6664 $requested_language = $q->http('HTTP_ACCEPT_LANGUAGE');
6668 The same as I<http()>, but operates on the HTTPS environment variables
6669 present when the SSL protocol is in effect. Can be used to determine
6670 whether SSL is turned on.
6674 =head1 USING NPH SCRIPTS
6676 NPH, or "no-parsed-header", scripts bypass the server completely by
6677 sending the complete HTTP header directly to the browser. This has
6678 slight performance benefits, but is of most use for taking advantage
6679 of HTTP extensions that are not directly supported by your server,
6680 such as server push and PICS headers.
6682 Servers use a variety of conventions for designating CGI scripts as
6683 NPH. Many Unix servers look at the beginning of the script's name for
6684 the prefix "nph-". The Macintosh WebSTAR server and Microsoft's
6685 Internet Information Server, in contrast, try to decide whether a
6686 program is an NPH script by examining the first line of script output.
6689 CGI.pm supports NPH scripts with a special NPH mode. When in this
6690 mode, CGI.pm will output the necessary extra header information when
6691 the header() and redirect() methods are
6694 The Microsoft Internet Information Server requires NPH mode. As of
6695 version 2.30, CGI.pm will automatically detect when the script is
6696 running under IIS and put itself into this mode. You do not need to
6697 do this manually, although it won't hurt anything if you do. However,
6698 note that if you have applied Service Pack 6, much of the
6699 functionality of NPH scripts, including the ability to redirect while
6700 setting a cookie, b<do not work at all> on IIS without a special patch
6702 http://support.microsoft.com/support/kb/articles/Q280/3/41.ASP:
6703 Non-Parsed Headers Stripped From CGI Applications That Have nph-
6708 =item In the B<use> statement
6710 Simply add the "-nph" pragmato the list of symbols to be imported into
6713 use CGI qw(:standard -nph)
6715 =item By calling the B<nph()> method:
6717 Call B<nph()> with a non-zero parameter at any point after using CGI.pm in your program.
6721 =item By using B<-nph> parameters
6723 in the B<header()> and B<redirect()> statements:
6725 print $q->header(-nph=>1);
6731 CGI.pm provides four simple functions for producing multipart
6732 documents of the type needed to implement server push. These
6733 functions were graciously provided by Ed Jordan <ed@fidalgo.net>. To
6734 import these into your namespace, you must import the ":push" set.
6735 You are also advised to put the script into NPH mode and to set $| to
6736 1 to avoid buffering problems.
6738 Here is a simple script that demonstrates server push:
6740 #!/usr/local/bin/perl
6741 use CGI qw/:push -nph/;
6743 print multipart_init(-boundary=>'----here we go!');
6745 print multipart_start(-type=>'text/plain'),
6746 "The current time is ",scalar(localtime),"\n";
6748 print multipart_end;
6750 print multipart_final;
6755 This script initializes server push by calling B<multipart_init()>.
6756 It then enters a loop in which it begins a new multipart section by
6757 calling B<multipart_start()>, prints the current local time,
6758 and ends a multipart section with B<multipart_end()>. It then sleeps
6759 a second, and begins again. On the final iteration, it ends the
6760 multipart section with B<multipart_final()> rather than with
6765 =item multipart_init()
6767 multipart_init(-boundary=>$boundary);
6769 Initialize the multipart system. The -boundary argument specifies
6770 what MIME boundary string to use to separate parts of the document.
6771 If not provided, CGI.pm chooses a reasonable boundary for you.
6773 =item multipart_start()
6775 multipart_start(-type=>$type)
6777 Start a new part of the multipart document using the specified MIME
6778 type. If not specified, text/html is assumed.
6780 =item multipart_end()
6784 End a part. You must remember to call multipart_end() once for each
6785 multipart_start(), except at the end of the last part of the multipart
6786 document when multipart_final() should be called instead of multipart_end().
6788 =item multipart_final()
6792 End all parts. You should call multipart_final() rather than
6793 multipart_end() at the end of the last part of the multipart document.
6797 Users interested in server push applications should also have a look
6798 at the CGI::Push module.
6800 Only Netscape Navigator supports server push. Internet Explorer
6803 =head1 Avoiding Denial of Service Attacks
6805 A potential problem with CGI.pm is that, by default, it attempts to
6806 process form POSTings no matter how large they are. A wily hacker
6807 could attack your site by sending a CGI script a huge POST of many
6808 megabytes. CGI.pm will attempt to read the entire POST into a
6809 variable, growing hugely in size until it runs out of memory. While
6810 the script attempts to allocate the memory the system may slow down
6811 dramatically. This is a form of denial of service attack.
6813 Another possible attack is for the remote user to force CGI.pm to
6814 accept a huge file upload. CGI.pm will accept the upload and store it
6815 in a temporary directory even if your script doesn't expect to receive
6816 an uploaded file. CGI.pm will delete the file automatically when it
6817 terminates, but in the meantime the remote user may have filled up the
6818 server's disk space, causing problems for other programs.
6820 The best way to avoid denial of service attacks is to limit the amount
6821 of memory, CPU time and disk space that CGI scripts can use. Some Web
6822 servers come with built-in facilities to accomplish this. In other
6823 cases, you can use the shell I<limit> or I<ulimit>
6824 commands to put ceilings on CGI resource usage.
6827 CGI.pm also has some simple built-in protections against denial of
6828 service attacks, but you must activate them before you can use them.
6829 These take the form of two global variables in the CGI name space:
6833 =item B<$CGI::POST_MAX>
6835 If set to a non-negative integer, this variable puts a ceiling
6836 on the size of POSTings, in bytes. If CGI.pm detects a POST
6837 that is greater than the ceiling, it will immediately exit with an error
6838 message. This value will affect both ordinary POSTs and
6839 multipart POSTs, meaning that it limits the maximum size of file
6840 uploads as well. You should set this to a reasonably high
6841 value, such as 1 megabyte.
6843 =item B<$CGI::DISABLE_UPLOADS>
6845 If set to a non-zero value, this will disable file uploads
6846 completely. Other fill-out form values will work as usual.
6850 You can use these variables in either of two ways.
6854 =item B<1. On a script-by-script basis>
6856 Set the variable at the top of the script, right after the "use" statement:
6858 use CGI qw/:standard/;
6859 use CGI::Carp 'fatalsToBrowser';
6860 $CGI::POST_MAX=1024 * 100; # max 100K posts
6861 $CGI::DISABLE_UPLOADS = 1; # no uploads
6863 =item B<2. Globally for all scripts>
6865 Open up CGI.pm, find the definitions for $POST_MAX and
6866 $DISABLE_UPLOADS, and set them to the desired values. You'll
6867 find them towards the top of the file in a subroutine named
6868 initialize_globals().
6872 An attempt to send a POST larger than $POST_MAX bytes will cause
6873 I<param()> to return an empty CGI parameter list. You can test for
6874 this event by checking I<cgi_error()>, either after you create the CGI
6875 object or, if you are using the function-oriented interface, call
6876 <param()> for the first time. If the POST was intercepted, then
6877 cgi_error() will return the message "413 POST too large".
6879 This error message is actually defined by the HTTP protocol, and is
6880 designed to be returned to the browser as the CGI script's status
6883 $uploaded_file = param('upload');
6884 if (!$uploaded_file && cgi_error()) {
6885 print header(-status=>cgi_error());
6889 However it isn't clear that any browser currently knows what to do
6890 with this status code. It might be better just to create an
6891 HTML page that warns the user of the problem.
6893 =head1 COMPATIBILITY WITH CGI-LIB.PL
6895 To make it easier to port existing programs that use cgi-lib.pl the
6896 compatibility routine "ReadParse" is provided. Porting is simple:
6899 require "cgi-lib.pl";
6901 print "The value of the antique is $in{antique}.\n";
6906 print "The value of the antique is $in{antique}.\n";
6908 CGI.pm's ReadParse() routine creates a tied variable named %in,
6909 which can be accessed to obtain the query variables. Like
6910 ReadParse, you can also provide your own variable. Infrequently
6911 used features of ReadParse, such as the creation of @in and $in
6912 variables, are not supported.
6914 Once you use ReadParse, you can retrieve the query object itself
6918 print $q->textfield(-name=>'wow',
6919 -value=>'does this really work?');
6921 This allows you to start using the more interesting features
6922 of CGI.pm without rewriting your old scripts from scratch.
6924 =head1 AUTHOR INFORMATION
6926 Copyright 1995-1998, Lincoln D. Stein. All rights reserved.
6928 This library is free software; you can redistribute it and/or modify
6929 it under the same terms as Perl itself.
6931 Address bug reports and comments to: lstein@cshl.org. When sending
6932 bug reports, please provide the version of CGI.pm, the version of
6933 Perl, the name and version of your Web server, and the name and
6934 version of the operating system you are using. If the problem is even
6935 remotely browser dependent, please provide information about the
6936 affected browers as well.
6940 Thanks very much to:
6944 =item Matt Heffron (heffron@falstaff.css.beckman.com)
6946 =item James Taylor (james.taylor@srs.gov)
6948 =item Scott Anguish <sanguish@digifix.com>
6950 =item Mike Jewell (mlj3u@virginia.edu)
6952 =item Timothy Shimmin (tes@kbs.citri.edu.au)
6954 =item Joergen Haegg (jh@axis.se)
6956 =item Laurent Delfosse (delfosse@delfosse.com)
6958 =item Richard Resnick (applepi1@aol.com)
6960 =item Craig Bishop (csb@barwonwater.vic.gov.au)
6962 =item Tony Curtis (tc@vcpc.univie.ac.at)
6964 =item Tim Bunce (Tim.Bunce@ig.co.uk)
6966 =item Tom Christiansen (tchrist@convex.com)
6968 =item Andreas Koenig (k@franz.ww.TU-Berlin.DE)
6970 =item Tim MacKenzie (Tim.MacKenzie@fulcrum.com.au)
6972 =item Kevin B. Hendricks (kbhend@dogwood.tyler.wm.edu)
6974 =item Stephen Dahmen (joyfire@inxpress.net)
6976 =item Ed Jordan (ed@fidalgo.net)
6978 =item David Alan Pisoni (david@cnation.com)
6980 =item Doug MacEachern (dougm@opengroup.org)
6982 =item Robin Houston (robin@oneworld.org)
6984 =item ...and many many more...
6986 for suggestions and bug fixes.
6990 =head1 A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT
6993 #!/usr/local/bin/perl
6999 print $query->header;
7000 print $query->start_html("Example CGI.pm Form");
7001 print "<h1> Example CGI.pm Form</h1>\n";
7002 &print_prompt($query);
7005 print $query->end_html;
7010 print $query->start_form;
7011 print "<em>What's your name?</em><br>";
7012 print $query->textfield('name');
7013 print $query->checkbox('Not my real name');
7015 print "<p><em>Where can you find English Sparrows?</em><br>";
7016 print $query->checkbox_group(
7017 -name=>'Sparrow locations',
7018 -values=>[England,France,Spain,Asia,Hoboken],
7020 -defaults=>[England,Asia]);
7022 print "<p><em>How far can they fly?</em><br>",
7023 $query->radio_group(
7025 -values=>['10 ft','1 mile','10 miles','real far'],
7026 -default=>'1 mile');
7028 print "<p><em>What's your favorite color?</em> ";
7029 print $query->popup_menu(-name=>'Color',
7030 -values=>['black','brown','red','yellow'],
7033 print $query->hidden('Reference','Monty Python and the Holy Grail');
7035 print "<p><em>What have you got there?</em><br>";
7036 print $query->scrolling_list(
7037 -name=>'possessions',
7038 -values=>['A Coconut','A Grail','An Icon',
7039 'A Sword','A Ticket'],
7043 print "<p><em>Any parting comments?</em><br>";
7044 print $query->textarea(-name=>'Comments',
7048 print "<p>",$query->reset;
7049 print $query->submit('Action','Shout');
7050 print $query->submit('Action','Scream');
7051 print $query->endform;
7059 print "<h2>Here are the current settings in this form</h2>";
7061 foreach $key ($query->param) {
7062 print "<strong>$key</strong> -> ";
7063 @values = $query->param($key);
7064 print join(", ",@values),"<br>\n";
7071 <address>Lincoln D. Stein</address><br>
7072 <a href="/">Home Page</a>
7082 L<CGI::Carp>, L<CGI::Fast>, L<CGI::Pretty>