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.251 2008/04/23 13:08:23 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 ebcdic2ascii ascii2ebcdic);
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);
40 $MOD_PERL = 0; # no mod_perl by default
43 $POST_MAX = -1; # no limit to uploaded files
49 # >>>>> Here are some globals that you might want to adjust <<<<<<
50 sub initialize_globals {
51 # Set this to 1 to enable copious autoloader debugging messages
54 # Set this to 1 to generate XTML-compatible output
57 # Change this to the preferred DTD to print in start_html()
58 # or use default_dtd('text of DTD to use');
59 $DEFAULT_DTD = [ '-//W3C//DTD HTML 4.01 Transitional//EN',
60 'http://www.w3.org/TR/html4/loose.dtd' ] ;
62 # Set this to 1 to enable NOSTICKY scripts
64 # 1) use CGI qw(-nosticky)
65 # 2) $CGI::nosticky(1)
68 # Set this to 1 to enable NPH scripts
72 # 3) print header(-nph=>1)
75 # Set this to 1 to enable debugging from @ARGV
76 # Set to 2 to enable debugging from STDIN
79 # Set this to 1 to make the temporary files created
80 # during file uploads safe from prying eyes
82 # 1) use CGI qw(:private_tempfiles)
83 # 2) CGI::private_tempfiles(1);
84 $PRIVATE_TEMPFILES = 0;
86 # Set this to 1 to generate automatic tab indexes
89 # Set this to 1 to cause files uploaded in multipart documents
90 # to be closed, instead of caching the file handle
92 # 1) use CGI qw(:close_upload_files)
93 # 2) $CGI::close_upload_files(1);
94 # Uploads with many files run out of file handles.
95 # Also, for performance, since the file is already on disk,
96 # it can just be renamed, instead of read and written.
97 $CLOSE_UPLOAD_FILES = 0;
99 # Automatically determined -- don't change
102 # Change this to 1 to suppress redundant HTTP headers
105 # separate the name=value pairs by semicolons rather than ampersands
106 $USE_PARAM_SEMICOLONS = 1;
108 # Do not include undefined params parsed from query string
109 # use CGI qw(-no_undef_params);
110 $NO_UNDEF_PARAMS = 0;
112 # return everything as utf-8
115 # Other globals that you shouldn't worry about.
118 $DTD_PUBLIC_IDENTIFIER = "";
121 undef $QUERY_CHARSET;
122 undef %QUERY_FIELDNAMES;
123 undef %QUERY_TMPFILES;
125 # prevent complaints by mod_perl
129 # ------------------ START OF THE LIBRARY ------------
131 *end_form = \&endform;
134 initialize_globals();
136 # FIGURE OUT THE OS WE'RE RUNNING UNDER
137 # Some systems support the $^O variable. If not
138 # available then require() the Config library
142 $OS = $Config::Config{'osname'};
145 if ($OS =~ /^MSWin/i) {
147 } elsif ($OS =~ /^VMS/i) {
149 } elsif ($OS =~ /^dos/i) {
151 } elsif ($OS =~ /^MacOS/i) {
153 } elsif ($OS =~ /^os2/i) {
155 } elsif ($OS =~ /^epoc/i) {
157 } elsif ($OS =~ /^cygwin/i) {
163 # Some OS logic. Binary mode enabled on DOS, NT and VMS
164 $needs_binmode = $OS=~/^(WINDOWS|DOS|OS2|MSWin|CYGWIN)/;
166 # This is the default class for the CGI object to use when all else fails.
167 $DefaultClass = 'CGI' unless defined $CGI::DefaultClass;
169 # This is where to look for autoloaded routines.
170 $AutoloadClass = $DefaultClass unless defined $CGI::AutoloadClass;
172 # The path separator is a slash, backslash or semicolon, depending
175 UNIX => '/', OS2 => '\\', EPOC => '/', CYGWIN => '/',
176 WINDOWS => '\\', DOS => '\\', MACINTOSH => ':', VMS => '/'
179 # This no longer seems to be necessary
180 # Turn on NPH scripts by default when running under IIS server!
181 # $NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
182 $IIS++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
184 # Turn on special checking for Doug MacEachern's modperl
185 if (exists $ENV{MOD_PERL}) {
186 # mod_perl handlers may run system() on scripts using CGI.pm;
187 # Make sure so we don't get fooled by inherited $ENV{MOD_PERL}
188 if (exists $ENV{MOD_PERL_API_VERSION} && $ENV{MOD_PERL_API_VERSION} == 2) {
190 require Apache2::Response;
191 require Apache2::RequestRec;
192 require Apache2::RequestUtil;
193 require Apache2::RequestIO;
201 # Turn on special checking for ActiveState's PerlEx
202 $PERLEX++ if defined($ENV{'GATEWAY_INTERFACE'}) && $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-PerlEx/;
204 # Define the CRLF sequence. I can't use a simple "\r\n" because the meaning
205 # of "\n" is different on different OS's (sometimes it generates CRLF, sometimes LF
206 # and sometimes CR). The most popular VMS web server
207 # doesn't accept CRLF -- instead it wants a LR. EBCDIC machines don't
208 # use ASCII, so \015\012 means something different. I find this all
210 $EBCDIC = "\t" ne "\011";
219 if ($needs_binmode) {
220 $CGI::DefaultClass->binmode(\*main::STDOUT);
221 $CGI::DefaultClass->binmode(\*main::STDIN);
222 $CGI::DefaultClass->binmode(\*main::STDERR);
226 ':html2'=>['h1'..'h6',qw/p br hr ol ul li dl dt dd menu code var strong em
227 tt u i b blockquote pre img a address cite samp dfn html head
228 base body Link nextid title meta kbd start_html end_html
229 input Select option comment charset escapeHTML/],
230 ':html3'=>[qw/div table caption th td TR Tr sup Sub strike applet Param
231 embed basefont style span layer ilayer font frameset frame script small big Area Map/],
232 ':html4'=>[qw/abbr acronym bdo col colgroup del fieldset iframe
233 ins label legend noframes noscript object optgroup Q
235 ':netscape'=>[qw/blink fontsize center/],
236 ':form'=>[qw/textfield textarea filefield password_field hidden checkbox checkbox_group
237 submit reset defaults radio_group popup_menu button autoEscape
238 scrolling_list image_button start_form end_form startform endform
239 start_multipart_form end_multipart_form isindex tmpFileName uploadInfo URL_ENCODED MULTIPART/],
240 ':cgi'=>[qw/param upload path_info path_translated request_uri url self_url script_name
242 raw_cookie request_method query_string Accept user_agent remote_host content_type
243 remote_addr referer server_name server_software server_port server_protocol virtual_port
244 virtual_host remote_ident auth_type http append
245 save_parameters restore_parameters param_fetch
246 remote_user user_name header redirect import_names put
247 Delete Delete_all url_param cgi_error/],
248 ':ssl' => [qw/https/],
249 ':cgi-lib' => [qw/ReadParse PrintHeader HtmlTop HtmlBot SplitParam Vars/],
250 ':html' => [qw/:html2 :html3 :html4 :netscape/],
251 ':standard' => [qw/:html2 :html3 :html4 :form :cgi/],
252 ':push' => [qw/multipart_init multipart_start multipart_end multipart_final/],
253 ':all' => [qw/:html2 :html3 :netscape :form :cgi :internal :html4/]
256 # Custom 'can' method for both autoloaded and non-autoloaded subroutines.
257 # Author: Cees Hek <cees@sitesuite.com.au>
260 my($class, $method) = @_;
262 # See if UNIVERSAL::can finds it.
264 if (my $func = $class -> SUPER::can($method) ){
268 # Try to compile the function.
271 # _compile looks at $AUTOLOAD for the function name.
273 local $AUTOLOAD = join "::", $class, $method;
277 # Now that the function is loaded (if it exists)
278 # just use UNIVERSAL::can again to do the work.
280 return $class -> SUPER::can($method);
283 # to import symbols into caller
287 # This causes modules to clash.
291 $self->_setup_symbols(@_);
292 my ($callpack, $callfile, $callline) = caller;
294 # To allow overriding, search through the packages
295 # Till we find one in which the correct subroutine is defined.
296 my @packages = ($self,@{"$self\:\:ISA"});
297 foreach $sym (keys %EXPORT) {
299 my $def = ${"$self\:\:AutoloadClass"} || $DefaultClass;
300 foreach $pck (@packages) {
301 if (defined(&{"$pck\:\:$sym"})) {
306 *{"${callpack}::$sym"} = \&{"$def\:\:$sym"};
312 $pack->_setup_symbols('-compile',@_);
317 return ("start_$1","end_$1") if $tag=~/^(?:\*|start_|end_)(.+)/;
319 return ($tag) unless $EXPORT_TAGS{$tag};
320 foreach (@{$EXPORT_TAGS{$tag}}) {
321 push(@r,&expand_tags($_));
327 # The new routine. This will check the current environment
328 # for an existing query string, and initialize itself, if so.
331 my($class,@initializer) = @_;
334 bless $self,ref $class || $class || $DefaultClass;
336 # always use a tempfile
337 $self->{'use_tempfile'} = 1;
339 if (ref($initializer[0])
340 && (UNIVERSAL::isa($initializer[0],'Apache')
342 UNIVERSAL::isa($initializer[0],'Apache2::RequestRec')
344 $self->r(shift @initializer);
346 if (ref($initializer[0])
347 && (UNIVERSAL::isa($initializer[0],'CODE'))) {
348 $self->upload_hook(shift @initializer, shift @initializer);
349 $self->{'use_tempfile'} = shift @initializer if (@initializer > 0);
352 if ($MOD_PERL == 1) {
353 $self->r(Apache->request) unless $self->r;
355 $r->register_cleanup(\&CGI::_reset_globals);
356 $self->_setup_symbols(@SAVED_SYMBOLS) if @SAVED_SYMBOLS;
359 # XXX: once we have the new API
360 # will do a real PerlOptions -SetupEnv check
361 $self->r(Apache2::RequestUtil->request) unless $self->r;
363 $r->subprocess_env unless exists $ENV{REQUEST_METHOD};
364 $r->pool->cleanup_register(\&CGI::_reset_globals);
365 $self->_setup_symbols(@SAVED_SYMBOLS) if @SAVED_SYMBOLS;
369 $self->_reset_globals if $PERLEX;
370 $self->init(@initializer);
374 # We provide a DESTROY method so that we can ensure that
375 # temporary files are closed (via Fh->DESTROY) before they
376 # are unlinked (via CGITempFile->DESTROY) because it is not
377 # possible to unlink an open file on Win32. We explicitly
378 # call DESTROY on each, rather than just undefing them and
379 # letting Perl DESTROY them by garbage collection, in case the
380 # user is still holding any reference to them as well.
383 if ($OS eq 'WINDOWS') {
384 foreach my $href (values %{$self->{'.tmpfiles'}}) {
385 $href->{hndl}->DESTROY if defined $href->{hndl};
386 $href->{name}->DESTROY if defined $href->{name};
393 my $r = $self->{'.r'};
394 $self->{'.r'} = shift if @_;
400 if (ref $_[0] eq 'CODE') {
401 $CGI::Q = $self = $CGI::DefaultClass->new(@_);
405 my ($hook,$data,$use_tempfile) = @_;
406 $self->{'.upload_hook'} = $hook;
407 $self->{'.upload_data'} = $data;
408 $self->{'use_tempfile'} = $use_tempfile if defined $use_tempfile;
412 # Returns the value(s)of a named parameter.
413 # If invoked in a list context, returns the
414 # entire list. Otherwise returns the first
415 # member of the list.
416 # If name is not provided, return a list of all
417 # the known parameters names available.
418 # If more than one argument is provided, the
419 # second and subsequent arguments are used to
420 # set the value of the parameter.
423 my($self,@p) = self_or_default(@_);
424 return $self->all_parameters unless @p;
425 my($name,$value,@other);
427 # For compatibility between old calling style and use_named_parameters() style,
428 # we have to special case for a single parameter present.
430 ($name,$value,@other) = rearrange([NAME,[DEFAULT,VALUE,VALUES]],@p);
433 if (substr($p[0],0,1) eq '-') {
434 @values = defined($value) ? (ref($value) && ref($value) eq 'ARRAY' ? @{$value} : $value) : ();
436 foreach ($value,@other) {
437 push(@values,$_) if defined($_);
440 # If values is provided, then we set it.
441 if (@values or defined $value) {
442 $self->add_parameter($name);
443 $self->{$name}=[@values];
449 return unless defined($name) && $self->{$name};
451 my @result = @{$self->{$name}};
454 eval "require Encode; 1;" unless Encode->can('decode'); # bring in these functions
455 @result = map {ref $_ ? $_ : Encode::decode(utf8=>$_) } @result;
458 return wantarray ? @result : $result[0];
461 sub self_or_default {
462 return @_ if defined($_[0]) && (!ref($_[0])) &&($_[0] eq 'CGI');
463 unless (defined($_[0]) &&
464 (ref($_[0]) eq 'CGI' || UNIVERSAL::isa($_[0],'CGI')) # slightly optimized for common case
466 $Q = $CGI::DefaultClass->new unless defined($Q);
469 return wantarray ? @_ : $Q;
473 local $^W=0; # prevent a warning
474 if (defined($_[0]) &&
475 (substr(ref($_[0]),0,3) eq 'CGI'
476 || UNIVERSAL::isa($_[0],'CGI'))) {
479 return ($DefaultClass,@_);
483 ########################################
484 # THESE METHODS ARE MORE OR LESS PRIVATE
485 # GO TO THE __DATA__ SECTION TO SEE MORE
487 ########################################
489 # Initialize the query object from the environment.
490 # If a parameter list is found, this object will be set
491 # to an associative array in which parameter names are keys
492 # and the values are stored as lists
493 # If a keyword list is found, this method creates a bogus
494 # parameter list with the single parameter 'keywords'.
498 my($query_string,$meth,$content_length,$fh,@lines) = ('','','','');
502 my $initializer = shift; # for backward compatibility
505 # set autoescaping on by default
506 $self->{'escape'} = 1;
508 # if we get called more than once, we want to initialize
509 # ourselves from the original query (which may be gone
510 # if it was read from STDIN originally.)
511 if (defined(@QUERY_PARAM) && !defined($initializer)) {
512 for my $name (@QUERY_PARAM) {
513 my $val = $QUERY_PARAM{$name}; # always an arrayref;
514 $self->param('-name'=>$name,'-value'=> $val);
515 if (defined $val and ref $val eq 'ARRAY') {
516 for my $fh (grep {defined(fileno($_))} @$val) {
517 seek($fh,0,0); # reset the filehandle.
522 $self->charset($QUERY_CHARSET);
523 $self->{'.fieldnames'} = {%QUERY_FIELDNAMES};
524 $self->{'.tmpfiles'} = {%QUERY_TMPFILES};
528 $meth=$ENV{'REQUEST_METHOD'} if defined($ENV{'REQUEST_METHOD'});
529 $content_length = defined($ENV{'CONTENT_LENGTH'}) ? $ENV{'CONTENT_LENGTH'} : 0;
531 $fh = to_filehandle($initializer) if $initializer;
533 # set charset to the safe ISO-8859-1
534 $self->charset('ISO-8859-1');
538 # avoid unreasonably large postings
539 if (($POST_MAX > 0) && ($content_length > $POST_MAX)) {
540 #discard the post, unread
541 $self->cgi_error("413 Request entity too large");
545 # Process multipart postings, but only if the initializer is
548 && defined($ENV{'CONTENT_TYPE'})
549 && $ENV{'CONTENT_TYPE'}=~m|^multipart/form-data|
550 && !defined($initializer)
552 my($boundary) = $ENV{'CONTENT_TYPE'} =~ /boundary=\"?([^\";,]+)\"?/;
553 $self->read_multipart($boundary,$content_length);
557 # Process XForms postings. We know that we have XForms in the
559 # method eq 'POST' && content-type eq 'application/xml'
560 # method eq 'POST' && content-type =~ /multipart\/related.+start=/
561 # There are more cases, actually, but for now, we don't support other
562 # methods for XForm posts.
563 # In a XForm POST, the QUERY_STRING is parsed normally.
564 # If the content-type is 'application/xml', we just set the param
565 # XForms:Model (referring to the xml syntax) param containing the
567 # In the case of multipart/related we set XForms:Model as above, but
568 # the other parts are available as uploads with the Content-ID as the
570 # See the URL below for XForms specs on this issue.
571 # http://www.w3.org/TR/2006/REC-xforms-20060314/slice11.html#submit-options
572 if ($meth eq 'POST' && defined($ENV{'CONTENT_TYPE'})) {
573 if ($ENV{'CONTENT_TYPE'} eq 'application/xml') {
574 my($param) = 'XForms:Model';
576 $self->add_parameter($param);
577 $self->read_from_client(\$value,$content_length,0)
578 if $content_length > 0;
579 push (@{$self->{$param}},$value);
581 } elsif ($ENV{'CONTENT_TYPE'} =~ /multipart\/related.+boundary=\"?([^\";,]+)\"?.+start=\"?\<?([^\"\>]+)\>?\"?/) {
582 my($boundary,$start) = ($1,$2);
583 my($param) = 'XForms:Model';
584 $self->add_parameter($param);
585 my($value) = $self->read_multipart_related($start,$boundary,$content_length,0);
586 push (@{$self->{$param}},$value);
588 $query_string = $self->r->args;
590 $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
591 $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'};
598 # If initializer is defined, then read parameters
600 if (!$is_xforms && defined($initializer)) {
601 if (UNIVERSAL::isa($initializer,'CGI')) {
602 $query_string = $initializer->query_string;
605 if (ref($initializer) && ref($initializer) eq 'HASH') {
606 foreach (keys %$initializer) {
607 $self->param('-name'=>$_,'-value'=>$initializer->{$_});
612 if (defined($fh) && ($fh ne '')) {
618 # massage back into standard format
619 if ("@lines" =~ /=/) {
620 $query_string=join("&",@lines);
622 $query_string=join("+",@lines);
627 # last chance -- treat it as a string
628 $initializer = $$initializer if ref($initializer) eq 'SCALAR';
629 $query_string = $initializer;
634 # If method is GET or HEAD, fetch the query from
636 if ($is_xforms || $meth=~/^(GET|HEAD)$/) {
638 $query_string = $self->r->args;
640 $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
641 $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'};
646 if ($meth eq 'POST' || $meth eq 'PUT') {
647 $self->read_from_client(\$query_string,$content_length,0)
648 if $content_length > 0;
649 # Some people want to have their cake and eat it too!
650 # Uncomment this line to have the contents of the query string
651 # APPENDED to the POST data.
652 # $query_string .= (length($query_string) ? '&' : '') . $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
656 # If $meth is not of GET, POST or HEAD, assume we're being debugged offline.
657 # Check the command line and then the standard input for data.
658 # We use the shellwords package in order to behave the way that
659 # UN*X programmers expect.
662 my $cmdline_ret = read_from_cmdline();
663 $query_string = $cmdline_ret->{'query_string'};
664 if (defined($cmdline_ret->{'subpath'}))
666 $self->path_info($cmdline_ret->{'subpath'});
671 # YL: Begin Change for XML handler 10/19/2001
672 if (!$is_xforms && ($meth eq 'POST' || $meth eq 'PUT')
673 && defined($ENV{'CONTENT_TYPE'})
674 && $ENV{'CONTENT_TYPE'} !~ m|^application/x-www-form-urlencoded|
675 && $ENV{'CONTENT_TYPE'} !~ m|^multipart/form-data| ) {
676 my($param) = $meth . 'DATA' ;
677 $self->add_parameter($param) ;
678 push (@{$self->{$param}},$query_string);
679 undef $query_string ;
681 # YL: End Change for XML handler 10/19/2001
683 # We now have the query string in hand. We do slightly
684 # different things for keyword lists and parameter lists.
685 if (defined $query_string && length $query_string) {
686 if ($query_string =~ /[&=;]/) {
687 $self->parse_params($query_string);
689 $self->add_parameter('keywords');
690 $self->{'keywords'} = [$self->parse_keywordlist($query_string)];
694 # Special case. Erase everything if there is a field named
696 if ($self->param('.defaults')) {
700 # Associative array containing our defined fieldnames
701 $self->{'.fieldnames'} = {};
702 foreach ($self->param('.cgifields')) {
703 $self->{'.fieldnames'}->{$_}++;
706 # Clear out our default submission button flag if present
707 $self->delete('.submit');
708 $self->delete('.cgifields');
710 $self->save_request unless defined $initializer;
713 # FUNCTIONS TO OVERRIDE:
714 # Turn a string into a filehandle
717 return undef unless $thingy;
718 return $thingy if UNIVERSAL::isa($thingy,'GLOB');
719 return $thingy if UNIVERSAL::isa($thingy,'FileHandle');
722 while (my $package = caller($caller++)) {
723 my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy";
724 return $tmp if defined(fileno($tmp));
730 # send output to the browser
732 my($self,@p) = self_or_default(@_);
736 # print to standard output (for overriding in mod_perl)
742 # get/set last cgi_error
744 my ($self,$err) = self_or_default(@_);
745 $self->{'.cgi_error'} = $err if defined $err;
746 return $self->{'.cgi_error'};
751 # We're going to play with the package globals now so that if we get called
752 # again, we initialize ourselves in exactly the same way. This allows
753 # us to have several of these objects.
754 @QUERY_PARAM = $self->param; # save list of parameters
755 foreach (@QUERY_PARAM) {
756 next unless defined $_;
757 $QUERY_PARAM{$_}=$self->{$_};
759 $QUERY_CHARSET = $self->charset;
760 %QUERY_FIELDNAMES = %{$self->{'.fieldnames'}};
761 %QUERY_TMPFILES = %{ $self->{'.tmpfiles'} || {} };
765 my($self,$tosplit) = @_;
766 my(@pairs) = split(/[&;]/,$tosplit);
769 ($param,$value) = split('=',$_,2);
770 next unless defined $param;
771 next if $NO_UNDEF_PARAMS and not defined $value;
772 $value = '' unless defined $value;
773 $param = unescape($param);
774 $value = unescape($value);
775 $self->add_parameter($param);
776 push (@{$self->{$param}},$value);
782 return unless defined $param;
783 push (@{$self->{'.parameters'}},$param)
784 unless defined($self->{$param});
789 return () unless defined($self) && $self->{'.parameters'};
790 return () unless @{$self->{'.parameters'}};
791 return @{$self->{'.parameters'}};
794 # put a filehandle into binary mode (DOS)
796 return unless defined($_[1]) && defined fileno($_[1]);
797 CORE::binmode($_[1]);
801 my ($self,$tagname) = @_;
804 my (\$q,\$a,\@rest) = self_or_default(\@_);
806 if (ref(\$a) && ref(\$a) eq 'HASH') {
807 my(\@attr) = make_attributes(\$a,\$q->{'escape'});
808 \$attr = " \@attr" if \@attr;
810 unshift \@rest,\$a if defined \$a;
813 if ($tagname=~/start_(\w+)/i) {
814 $func .= qq! return "<\L$1\E\$attr>";} !;
815 } elsif ($tagname=~/end_(\w+)/i) {
816 $func .= qq! return "<\L/$1\E>"; } !;
819 return \$XHTML ? "\L<$tagname\E\$attr />" : "\L<$tagname\E\$attr>" unless \@rest;
820 my(\$tag,\$untag) = ("\L<$tagname\E\$attr>","\L</$tagname>\E");
821 my \@result = map { "\$tag\$_\$untag" }
822 (ref(\$rest[0]) eq 'ARRAY') ? \@{\$rest[0]} : "\@rest";
830 print STDERR "CGI::AUTOLOAD for $AUTOLOAD\n" if $CGI::AUTOLOAD_DEBUG;
831 my $func = &_compile;
836 my($func) = $AUTOLOAD;
837 my($pack,$func_name);
839 local($1,$2); # this fixes an obscure variable suicide problem.
840 $func=~/(.+)::([^:]+)$/;
841 ($pack,$func_name) = ($1,$2);
842 $pack=~s/::SUPER$//; # fix another obscure problem
843 $pack = ${"$pack\:\:AutoloadClass"} || $CGI::DefaultClass
844 unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"});
846 my($sub) = \%{"$pack\:\:SUBS"};
848 my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"};
850 eval "package $pack; $$auto";
851 croak("$AUTOLOAD: $@") if $@;
852 $$auto = ''; # Free the unneeded storage (but don't undef it!!!)
854 my($code) = $sub->{$func_name};
856 $code = "sub $AUTOLOAD { }" if (!$code and $func_name eq 'DESTROY');
858 (my $base = $func_name) =~ s/^(start_|end_)//i;
859 if ($EXPORT{':any'} ||
862 (%EXPORT_OK || grep(++$EXPORT_OK{$_},&expand_tags(':html')))
863 && $EXPORT_OK{$base}) {
864 $code = $CGI::DefaultClass->_make_tag_func($func_name);
867 croak("Undefined subroutine $AUTOLOAD\n") unless $code;
869 eval "package $pack; $code";
872 croak("$AUTOLOAD: $@");
875 CORE::delete($sub->{$func_name}); #free storage
876 return "$pack\:\:$func_name";
882 return '' unless $value;
883 return $XHTML ? qq(selected="selected" ) : qq(selected );
889 return '' unless $value;
890 return $XHTML ? qq(checked="checked" ) : qq(checked );
893 sub _reset_globals { initialize_globals(); }
899 # to avoid reexporting unwanted variables
903 $HEADERS_ONCE++, next if /^[:-]unique_headers$/;
904 $NPH++, next if /^[:-]nph$/;
905 $NOSTICKY++, next if /^[:-]nosticky$/;
906 $DEBUG=0, next if /^[:-]no_?[Dd]ebug$/;
907 $DEBUG=2, next if /^[:-][Dd]ebug$/;
908 $USE_PARAM_SEMICOLONS++, next if /^[:-]newstyle_urls$/;
909 $PARAM_UTF8++, next if /^[:-]utf8$/;
910 $XHTML++, next if /^[:-]xhtml$/;
911 $XHTML=0, next if /^[:-]no_?xhtml$/;
912 $USE_PARAM_SEMICOLONS=0, next if /^[:-]oldstyle_urls$/;
913 $PRIVATE_TEMPFILES++, next if /^[:-]private_tempfiles$/;
914 $TABINDEX++, next if /^[:-]tabindex$/;
915 $CLOSE_UPLOAD_FILES++, next if /^[:-]close_upload_files$/;
916 $EXPORT{$_}++, next if /^[:-]any$/;
917 $compile++, next if /^[:-]compile$/;
918 $NO_UNDEF_PARAMS++, next if /^[:-]no_undef_params$/;
920 # This is probably extremely evil code -- to be deleted some day.
921 if (/^[-]autoload$/) {
922 my($pkg) = caller(1);
923 *{"${pkg}::AUTOLOAD"} = sub {
924 my($routine) = $AUTOLOAD;
925 $routine =~ s/^.*::/CGI::/;
931 foreach (&expand_tags($_)) {
932 tr/a-zA-Z0-9_//cd; # don't allow weird function names
936 _compile_all(keys %EXPORT) if $compile;
941 my ($self,$charset) = self_or_default(@_);
942 $self->{'.charset'} = $charset if defined $charset;
947 my ($self,$new_value) = self_or_default(@_);
948 $self->{'.elid'} = $new_value if defined $new_value;
949 sprintf('%010d',$self->{'.elid'}++);
953 my ($self,$new_value) = self_or_default(@_);
954 $self->{'.etab'} ||= 1;
955 $self->{'.etab'} = $new_value if defined $new_value;
956 my $tab = $self->{'.etab'}++;
957 return '' unless $TABINDEX or defined $new_value;
958 return qq(tabindex="$tab" );
961 ###############################################################################
962 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
963 ###############################################################################
964 $AUTOLOADED_ROUTINES = ''; # get rid of -w warning
965 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
969 'URL_ENCODED'=> <<'END_OF_FUNC',
970 sub URL_ENCODED { 'application/x-www-form-urlencoded'; }
973 'MULTIPART' => <<'END_OF_FUNC',
974 sub MULTIPART { 'multipart/form-data'; }
977 'SERVER_PUSH' => <<'END_OF_FUNC',
978 sub SERVER_PUSH { 'multipart/x-mixed-replace;boundary="' . shift() . '"'; }
981 'new_MultipartBuffer' => <<'END_OF_FUNC',
982 # Create a new multipart buffer
983 sub new_MultipartBuffer {
984 my($self,$boundary,$length) = @_;
985 return MultipartBuffer->new($self,$boundary,$length);
989 'read_from_client' => <<'END_OF_FUNC',
990 # Read data from a file handle
991 sub read_from_client {
992 my($self, $buff, $len, $offset) = @_;
993 local $^W=0; # prevent a warning
995 ? $self->r->read($$buff, $len, $offset)
996 : read(\*STDIN, $$buff, $len, $offset);
1000 'delete' => <<'END_OF_FUNC',
1002 # Deletes the named parameter entirely.
1005 my($self,@p) = self_or_default(@_);
1006 my(@names) = rearrange([NAME],@p);
1007 my @to_delete = ref($names[0]) eq 'ARRAY' ? @$names[0] : @names;
1009 foreach my $name (@to_delete)
1011 CORE::delete $self->{$name};
1012 CORE::delete $self->{'.fieldnames'}->{$name};
1013 $to_delete{$name}++;
1015 @{$self->{'.parameters'}}=grep { !exists($to_delete{$_}) } $self->param();
1020 #### Method: import_names
1021 # Import all parameters into the given namespace.
1022 # Assumes namespace 'Q' if not specified
1024 'import_names' => <<'END_OF_FUNC',
1026 my($self,$namespace,$delete) = self_or_default(@_);
1027 $namespace = 'Q' unless defined($namespace);
1028 die "Can't import names into \"main\"\n" if \%{"${namespace}::"} == \%::;
1029 if ($delete || $MOD_PERL || exists $ENV{'FCGI_ROLE'}) {
1030 # can anyone find an easier way to do this?
1031 foreach (keys %{"${namespace}::"}) {
1032 local *symbol = "${namespace}::${_}";
1038 my($param,@value,$var);
1039 foreach $param ($self->param) {
1040 # protect against silly names
1041 ($var = $param)=~tr/a-zA-Z0-9_/_/c;
1042 $var =~ s/^(?=\d)/_/;
1043 local *symbol = "${namespace}::$var";
1044 @value = $self->param($param);
1046 $symbol = $value[0];
1051 #### Method: keywords
1052 # Keywords acts a bit differently. Calling it in a list context
1053 # returns the list of keywords.
1054 # Calling it in a scalar context gives you the size of the list.
1056 'keywords' => <<'END_OF_FUNC',
1058 my($self,@values) = self_or_default(@_);
1059 # If values is provided, then we set it.
1060 $self->{'keywords'}=[@values] if @values;
1061 my(@result) = defined($self->{'keywords'}) ? @{$self->{'keywords'}} : ();
1066 # These are some tie() interfaces for compatibility
1067 # with Steve Brenner's cgi-lib.pl routines
1068 'Vars' => <<'END_OF_FUNC',
1073 return %in if wantarray;
1078 # These are some tie() interfaces for compatibility
1079 # with Steve Brenner's cgi-lib.pl routines
1080 'ReadParse' => <<'END_OF_FUNC',
1087 *in=*{"${pkg}::in"};
1090 return scalar(keys %in);
1094 'PrintHeader' => <<'END_OF_FUNC',
1096 my($self) = self_or_default(@_);
1097 return $self->header();
1101 'HtmlTop' => <<'END_OF_FUNC',
1103 my($self,@p) = self_or_default(@_);
1104 return $self->start_html(@p);
1108 'HtmlBot' => <<'END_OF_FUNC',
1110 my($self,@p) = self_or_default(@_);
1111 return $self->end_html(@p);
1115 'SplitParam' => <<'END_OF_FUNC',
1118 my (@params) = split ("\0", $param);
1119 return (wantarray ? @params : $params[0]);
1123 'MethGet' => <<'END_OF_FUNC',
1125 return request_method() eq 'GET';
1129 'MethPost' => <<'END_OF_FUNC',
1131 return request_method() eq 'POST';
1135 'TIEHASH' => <<'END_OF_FUNC',
1139 if (ref($arg) && UNIVERSAL::isa($arg,'CGI')) {
1142 return $Q ||= $class->new(@_);
1146 'STORE' => <<'END_OF_FUNC',
1151 my @vals = index($vals,"\0")!=-1 ? split("\0",$vals) : $vals;
1152 $self->param(-name=>$tag,-value=>\@vals);
1156 'FETCH' => <<'END_OF_FUNC',
1158 return $_[0] if $_[1] eq 'CGI';
1159 return undef unless defined $_[0]->param($_[1]);
1160 return join("\0",$_[0]->param($_[1]));
1164 'FIRSTKEY' => <<'END_OF_FUNC',
1166 $_[0]->{'.iterator'}=0;
1167 $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
1171 'NEXTKEY' => <<'END_OF_FUNC',
1173 $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
1177 'EXISTS' => <<'END_OF_FUNC',
1179 exists $_[0]->{$_[1]};
1183 'DELETE' => <<'END_OF_FUNC',
1185 $_[0]->delete($_[1]);
1189 'CLEAR' => <<'END_OF_FUNC',
1197 # Append a new value to an existing query
1199 'append' => <<'EOF',
1201 my($self,@p) = self_or_default(@_);
1202 my($name,$value) = rearrange([NAME,[VALUE,VALUES]],@p);
1203 my(@values) = defined($value) ? (ref($value) ? @{$value} : $value) : ();
1205 $self->add_parameter($name);
1206 push(@{$self->{$name}},@values);
1208 return $self->param($name);
1212 #### Method: delete_all
1213 # Delete all parameters
1215 'delete_all' => <<'EOF',
1217 my($self) = self_or_default(@_);
1218 my @param = $self->param();
1219 $self->delete(@param);
1223 'Delete' => <<'EOF',
1225 my($self,@p) = self_or_default(@_);
1230 'Delete_all' => <<'EOF',
1232 my($self,@p) = self_or_default(@_);
1233 $self->delete_all(@p);
1237 #### Method: autoescape
1238 # If you want to turn off the autoescaping features,
1239 # call this method with undef as the argument
1240 'autoEscape' => <<'END_OF_FUNC',
1242 my($self,$escape) = self_or_default(@_);
1243 my $d = $self->{'escape'};
1244 $self->{'escape'} = $escape;
1250 #### Method: version
1251 # Return the current version
1253 'version' => <<'END_OF_FUNC',
1259 #### Method: url_param
1260 # Return a parameter in the QUERY_STRING, regardless of
1261 # whether this was a POST or a GET
1263 'url_param' => <<'END_OF_FUNC',
1265 my ($self,@p) = self_or_default(@_);
1266 my $name = shift(@p);
1267 return undef unless exists($ENV{QUERY_STRING});
1268 unless (exists($self->{'.url_param'})) {
1269 $self->{'.url_param'}={}; # empty hash
1270 if ($ENV{QUERY_STRING} =~ /=/) {
1271 my(@pairs) = split(/[&;]/,$ENV{QUERY_STRING});
1274 ($param,$value) = split('=',$_,2);
1275 $param = unescape($param);
1276 $value = unescape($value);
1277 push(@{$self->{'.url_param'}->{$param}},$value);
1280 $self->{'.url_param'}->{'keywords'} = [$self->parse_keywordlist($ENV{QUERY_STRING})];
1283 return keys %{$self->{'.url_param'}} unless defined($name);
1284 return () unless $self->{'.url_param'}->{$name};
1285 return wantarray ? @{$self->{'.url_param'}->{$name}}
1286 : $self->{'.url_param'}->{$name}->[0];
1291 # Returns a string in which all the known parameter/value
1292 # pairs are represented as nested lists, mainly for the purposes
1295 'Dump' => <<'END_OF_FUNC',
1297 my($self) = self_or_default(@_);
1298 my($param,$value,@result);
1299 return '<ul></ul>' unless $self->param;
1300 push(@result,"<ul>");
1301 foreach $param ($self->param) {
1302 my($name)=$self->escapeHTML($param);
1303 push(@result,"<li><strong>$param</strong></li>");
1304 push(@result,"<ul>");
1305 foreach $value ($self->param($param)) {
1306 $value = $self->escapeHTML($value);
1307 $value =~ s/\n/<br \/>\n/g;
1308 push(@result,"<li>$value</li>");
1310 push(@result,"</ul>");
1312 push(@result,"</ul>");
1313 return join("\n",@result);
1317 #### Method as_string
1319 # synonym for "dump"
1321 'as_string' => <<'END_OF_FUNC',
1328 # Write values out to a filehandle in such a way that they can
1329 # be reinitialized by the filehandle form of the new() method
1331 'save' => <<'END_OF_FUNC',
1333 my($self,$filehandle) = self_or_default(@_);
1334 $filehandle = to_filehandle($filehandle);
1336 local($,) = ''; # set print field separator back to a sane value
1337 local($\) = ''; # set output line separator to a sane value
1338 foreach $param ($self->param) {
1339 my($escaped_param) = escape($param);
1341 foreach $value ($self->param($param)) {
1342 print $filehandle "$escaped_param=",escape("$value"),"\n";
1345 foreach (keys %{$self->{'.fieldnames'}}) {
1346 print $filehandle ".cgifields=",escape("$_"),"\n";
1348 print $filehandle "=\n"; # end of record
1353 #### Method: save_parameters
1354 # An alias for save() that is a better name for exportation.
1355 # Only intended to be used with the function (non-OO) interface.
1357 'save_parameters' => <<'END_OF_FUNC',
1358 sub save_parameters {
1360 return save(to_filehandle($fh));
1364 #### Method: restore_parameters
1365 # A way to restore CGI parameters from an initializer.
1366 # Only intended to be used with the function (non-OO) interface.
1368 'restore_parameters' => <<'END_OF_FUNC',
1369 sub restore_parameters {
1370 $Q = $CGI::DefaultClass->new(@_);
1374 #### Method: multipart_init
1375 # Return a Content-Type: style header for server-push
1376 # This has to be NPH on most web servers, and it is advisable to set $| = 1
1378 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1379 # contribution, updated by Andrew Benham (adsb@bigfoot.com)
1381 'multipart_init' => <<'END_OF_FUNC',
1382 sub multipart_init {
1383 my($self,@p) = self_or_default(@_);
1384 my($boundary,@other) = rearrange([BOUNDARY],@p);
1385 $boundary = $boundary || '------- =_aaaaaaaaaa0';
1386 $self->{'separator'} = "$CRLF--$boundary$CRLF";
1387 $self->{'final_separator'} = "$CRLF--$boundary--$CRLF";
1388 $type = SERVER_PUSH($boundary);
1389 return $self->header(
1392 (map { split "=", $_, 2 } @other),
1393 ) . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $self->multipart_end;
1398 #### Method: multipart_start
1399 # Return a Content-Type: style header for server-push, start of section
1401 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1402 # contribution, updated by Andrew Benham (adsb@bigfoot.com)
1404 'multipart_start' => <<'END_OF_FUNC',
1405 sub multipart_start {
1407 my($self,@p) = self_or_default(@_);
1408 my($type,@other) = rearrange([TYPE],@p);
1409 $type = $type || 'text/html';
1410 push(@header,"Content-Type: $type");
1412 # rearrange() was designed for the HTML portion, so we
1413 # need to fix it up a little.
1415 # Don't use \s because of perl bug 21951
1416 next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/;
1417 ($_ = $header) =~ s/^(\w)(.*)/$1 . lc ($2) . ': '.$self->unescapeHTML($value)/e;
1419 push(@header,@other);
1420 my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1426 #### Method: multipart_end
1427 # Return a MIME boundary separator for server-push, end of section
1429 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1432 'multipart_end' => <<'END_OF_FUNC',
1434 my($self,@p) = self_or_default(@_);
1435 return $self->{'separator'};
1440 #### Method: multipart_final
1441 # Return a MIME boundary separator for server-push, end of all sections
1443 # Contributed by Andrew Benham (adsb@bigfoot.com)
1445 'multipart_final' => <<'END_OF_FUNC',
1446 sub multipart_final {
1447 my($self,@p) = self_or_default(@_);
1448 return $self->{'final_separator'} . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $CRLF;
1454 # Return a Content-Type: style header
1457 'header' => <<'END_OF_FUNC',
1459 my($self,@p) = self_or_default(@_);
1462 return "" if $self->{'.header_printed'}++ and $HEADERS_ONCE;
1464 my($type,$status,$cookie,$target,$expires,$nph,$charset,$attachment,$p3p,@other) =
1465 rearrange([['TYPE','CONTENT_TYPE','CONTENT-TYPE'],
1466 'STATUS',['COOKIE','COOKIES'],'TARGET',
1467 'EXPIRES','NPH','CHARSET',
1468 'ATTACHMENT','P3P'],@p);
1472 $type ||= 'text/html' unless defined($type);
1474 if (defined $charset) {
1475 $self->charset($charset);
1477 $charset = $self->charset if $type =~ /^text\//;
1481 # rearrange() was designed for the HTML portion, so we
1482 # need to fix it up a little.
1484 # Don't use \s because of perl bug 21951
1485 next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/;
1486 ($_ = $header) =~ s/^(\w)(.*)/"\u$1\L$2" . ': '.$self->unescapeHTML($value)/e;
1489 $type .= "; charset=$charset"
1491 and $type !~ /\bcharset\b/
1492 and defined $charset
1495 # Maybe future compatibility. Maybe not.
1496 my $protocol = $ENV{SERVER_PROTOCOL} || 'HTTP/1.0';
1497 push(@header,$protocol . ' ' . ($status || '200 OK')) if $nph;
1498 push(@header,"Server: " . &server_software()) if $nph;
1500 push(@header,"Status: $status") if $status;
1501 push(@header,"Window-Target: $target") if $target;
1503 $p3p = join ' ',@$p3p if ref($p3p) eq 'ARRAY';
1504 push(@header,qq(P3P: policyref="/w3c/p3p.xml", CP="$p3p"));
1506 # push all the cookies -- there may be several
1508 my(@cookie) = ref($cookie) && ref($cookie) eq 'ARRAY' ? @{$cookie} : $cookie;
1510 my $cs = UNIVERSAL::isa($_,'CGI::Cookie') ? $_->as_string : $_;
1511 push(@header,"Set-Cookie: $cs") if $cs ne '';
1514 # if the user indicates an expiration time, then we need
1515 # both an Expires and a Date header (so that the browser is
1517 push(@header,"Expires: " . expires($expires,'http'))
1519 push(@header,"Date: " . expires(0,'http')) if $expires || $cookie || $nph;
1520 push(@header,"Pragma: no-cache") if $self->cache();
1521 push(@header,"Content-Disposition: attachment; filename=\"$attachment\"") if $attachment;
1522 push(@header,map {ucfirst $_} @other);
1523 push(@header,"Content-Type: $type") if $type ne '';
1524 my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1525 if (($MOD_PERL >= 1) && !$nph) {
1526 $self->r->send_cgi_header($header);
1535 # Control whether header() will produce the no-cache
1538 'cache' => <<'END_OF_FUNC',
1540 my($self,$new_value) = self_or_default(@_);
1541 $new_value = '' unless $new_value;
1542 if ($new_value ne '') {
1543 $self->{'cache'} = $new_value;
1545 return $self->{'cache'};
1550 #### Method: redirect
1551 # Return a Location: style header
1554 'redirect' => <<'END_OF_FUNC',
1556 my($self,@p) = self_or_default(@_);
1557 my($url,$target,$status,$cookie,$nph,@other) =
1558 rearrange([[LOCATION,URI,URL],TARGET,STATUS,['COOKIE','COOKIES'],NPH],@p);
1559 $status = '302 Found' unless defined $status;
1560 $url ||= $self->self_url;
1562 foreach (@other) { tr/\"//d; push(@o,split("=",$_,2)); }
1564 '-Status' => $status,
1567 unshift(@o,'-Target'=>$target) if $target;
1568 unshift(@o,'-Type'=>'');
1570 unshift(@unescaped,'-Cookie'=>$cookie) if $cookie;
1571 return $self->header((map {$self->unescapeHTML($_)} @o),@unescaped);
1576 #### Method: start_html
1577 # Canned HTML header
1580 # $title -> (optional) The title for this HTML document (-title)
1581 # $author -> (optional) e-mail address of the author (-author)
1582 # $base -> (optional) if set to true, will enter the BASE address of this document
1583 # for resolving relative references (-base)
1584 # $xbase -> (optional) alternative base at some remote location (-xbase)
1585 # $target -> (optional) target window to load all links into (-target)
1586 # $script -> (option) Javascript code (-script)
1587 # $no_script -> (option) Javascript <noscript> tag (-noscript)
1588 # $meta -> (optional) Meta information tags
1589 # $head -> (optional) any other elements you'd like to incorporate into the <head> tag
1590 # (a scalar or array ref)
1591 # $style -> (optional) reference to an external style sheet
1592 # @other -> (optional) any other named parameters you'd like to incorporate into
1595 'start_html' => <<'END_OF_FUNC',
1597 my($self,@p) = &self_or_default(@_);
1598 my($title,$author,$base,$xbase,$script,$noscript,
1599 $target,$meta,$head,$style,$dtd,$lang,$encoding,$declare_xml,@other) =
1600 rearrange([TITLE,AUTHOR,BASE,XBASE,SCRIPT,NOSCRIPT,TARGET,
1601 META,HEAD,STYLE,DTD,LANG,ENCODING,DECLARE_XML],@p);
1603 $self->element_id(0);
1604 $self->element_tab(0);
1606 $encoding = lc($self->charset) unless defined $encoding;
1608 # Need to sort out the DTD before it's okay to call escapeHTML().
1609 my(@result,$xml_dtd);
1611 if (defined(ref($dtd)) and (ref($dtd) eq 'ARRAY')) {
1612 $dtd = $DEFAULT_DTD unless $dtd->[0] =~ m|^-//|;
1614 $dtd = $DEFAULT_DTD unless $dtd =~ m|^-//|;
1617 $dtd = $XHTML ? XHTML_DTD : $DEFAULT_DTD;
1620 $xml_dtd++ if ref($dtd) eq 'ARRAY' && $dtd->[0] =~ /\bXHTML\b/i;
1621 $xml_dtd++ if ref($dtd) eq '' && $dtd =~ /\bXHTML\b/i;
1622 push @result,qq(<?xml version="1.0" encoding="$encoding"?>) if $xml_dtd && $declare_xml;
1624 if (ref($dtd) && ref($dtd) eq 'ARRAY') {
1625 push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd->[0]"\n\t "$dtd->[1]">));
1626 $DTD_PUBLIC_IDENTIFIER = $dtd->[0];
1628 push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd">));
1629 $DTD_PUBLIC_IDENTIFIER = $dtd;
1632 # Now that we know whether we're using the HTML 3.2 DTD or not, it's okay to
1633 # call escapeHTML(). Strangely enough, the title needs to be escaped as
1634 # HTML while the author needs to be escaped as a URL.
1635 $title = $self->escapeHTML($title || 'Untitled Document');
1636 $author = $self->escape($author);
1638 if ($DTD_PUBLIC_IDENTIFIER =~ /[^X]HTML (2\.0|3\.2)/i) {
1639 $lang = "" unless defined $lang;
1643 $lang = 'en-US' unless defined $lang;
1646 my $lang_bits = $lang ne '' ? qq( lang="$lang" xml:lang="$lang") : '';
1647 my $meta_bits = qq(<meta http-equiv="Content-Type" content="text/html; charset=$encoding" />)
1648 if $XHTML && $encoding && !$declare_xml;
1650 push(@result,$XHTML ? qq(<html xmlns="http://www.w3.org/1999/xhtml"$lang_bits>\n<head>\n<title>$title</title>)
1651 : ($lang ? qq(<html lang="$lang">) : "<html>")
1652 . "<head><title>$title</title>");
1653 if (defined $author) {
1654 push(@result,$XHTML ? "<link rev=\"made\" href=\"mailto:$author\" />"
1655 : "<link rev=\"made\" href=\"mailto:$author\">");
1658 if ($base || $xbase || $target) {
1659 my $href = $xbase || $self->url('-path'=>1);
1660 my $t = $target ? qq/ target="$target"/ : '';
1661 push(@result,$XHTML ? qq(<base href="$href"$t />) : qq(<base href="$href"$t>));
1664 if ($meta && ref($meta) && (ref($meta) eq 'HASH')) {
1665 foreach (keys %$meta) { push(@result,$XHTML ? qq(<meta name="$_" content="$meta->{$_}" />)
1666 : qq(<meta name="$_" content="$meta->{$_}">)); }
1669 push(@result,ref($head) ? @$head : $head) if $head;
1671 # handle the infrequently-used -style and -script parameters
1672 push(@result,$self->_style($style)) if defined $style;
1673 push(@result,$self->_script($script)) if defined $script;
1674 push(@result,$meta_bits) if defined $meta_bits;
1676 # handle -noscript parameter
1677 push(@result,<<END) if $noscript;
1683 my($other) = @other ? " @other" : '';
1684 push(@result,"</head>\n<body$other>\n");
1685 return join("\n",@result);
1690 # internal method for generating a CSS style section
1692 '_style' => <<'END_OF_FUNC',
1694 my ($self,$style) = @_;
1697 my $type = 'text/css';
1698 my $rel = 'stylesheet';
1701 my $cdata_start = $XHTML ? "\n<!--/* <![CDATA[ */" : "\n<!-- ";
1702 my $cdata_end = $XHTML ? "\n/* ]]> */-->\n" : " -->\n";
1704 my @s = ref($style) eq 'ARRAY' ? @$style : $style;
1709 my($src,$code,$verbatim,$stype,$alternate,$foo,@other) =
1710 rearrange([qw(SRC CODE VERBATIM TYPE ALTERNATE FOO)],
1712 ref($s) eq 'ARRAY' ? @$s : %$s));
1713 my $type = defined $stype ? $stype : 'text/css';
1714 my $rel = $alternate ? 'alternate stylesheet' : 'stylesheet';
1715 $other = "@other" if @other;
1717 if (ref($src) eq "ARRAY") # Check to see if the $src variable is an array reference
1718 { # If it is, push a LINK tag for each one
1719 foreach $src (@$src)
1721 push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>)
1722 : qq(<link rel="$rel" type="$type" href="$src"$other>)) if $src;
1726 { # Otherwise, push the single -src, if it exists.
1727 push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>)
1728 : qq(<link rel="$rel" type="$type" href="$src"$other>)
1732 my @v = ref($verbatim) eq 'ARRAY' ? @$verbatim : $verbatim;
1733 push(@result, "<style type=\"text/css\">\n$_\n</style>") foreach @v;
1735 my @c = ref($code) eq 'ARRAY' ? @$code : $code if $code;
1736 push(@result,style({'type'=>$type},"$cdata_start\n$_\n$cdata_end")) foreach @c;
1740 push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>)
1741 : qq(<link rel="$rel" type="$type" href="$src"$other>));
1748 '_script' => <<'END_OF_FUNC',
1750 my ($self,$script) = @_;
1753 my (@scripts) = ref($script) eq 'ARRAY' ? @$script : ($script);
1754 foreach $script (@scripts) {
1755 my($src,$code,$language);
1756 if (ref($script)) { # script is a hash
1757 ($src,$code,$type) =
1758 rearrange(['SRC','CODE',['LANGUAGE','TYPE']],
1759 '-foo'=>'bar', # a trick to allow the '-' to be omitted
1760 ref($script) eq 'ARRAY' ? @$script : %$script);
1761 $type ||= 'text/javascript';
1762 unless ($type =~ m!\w+/\w+!) {
1763 $type =~ s/[\d.]+$//;
1764 $type = "text/$type";
1767 ($src,$code,$type) = ('',$script, 'text/javascript');
1770 my $comment = '//'; # javascript by default
1771 $comment = '#' if $type=~/perl|tcl/i;
1772 $comment = "'" if $type=~/vbscript/i;
1774 my ($cdata_start,$cdata_end);
1776 $cdata_start = "$comment<![CDATA[\n";
1777 $cdata_end .= "\n$comment]]>";
1779 $cdata_start = "\n<!-- Hide script\n";
1780 $cdata_end = $comment;
1781 $cdata_end .= " End script hiding -->\n";
1784 push(@satts,'src'=>$src) if $src;
1785 push(@satts,'type'=>$type);
1786 $code = $cdata_start . $code . $cdata_end if defined $code;
1787 push(@result,$self->script({@satts},$code || ''));
1793 #### Method: end_html
1794 # End an HTML document.
1795 # Trivial method for completeness. Just returns "</body>"
1797 'end_html' => <<'END_OF_FUNC',
1799 return "\n</body>\n</html>";
1804 ################################
1805 # METHODS USED IN BUILDING FORMS
1806 ################################
1808 #### Method: isindex
1809 # Just prints out the isindex tag.
1811 # $action -> optional URL of script to run
1813 # A string containing a <isindex> tag
1814 'isindex' => <<'END_OF_FUNC',
1816 my($self,@p) = self_or_default(@_);
1817 my($action,@other) = rearrange([ACTION],@p);
1818 $action = qq/ action="$action"/ if $action;
1819 my($other) = @other ? " @other" : '';
1820 return $XHTML ? "<isindex$action$other />" : "<isindex$action$other>";
1825 #### Method: startform
1828 # $method -> optional submission method to use (GET or POST)
1829 # $action -> optional URL of script to run
1830 # $enctype ->encoding to use (URL_ENCODED or MULTIPART)
1831 'startform' => <<'END_OF_FUNC',
1833 my($self,@p) = self_or_default(@_);
1835 my($method,$action,$enctype,@other) =
1836 rearrange([METHOD,ACTION,ENCTYPE],@p);
1838 $method = $self->escapeHTML(lc($method || 'post'));
1839 $enctype = $self->escapeHTML($enctype || &URL_ENCODED);
1840 if (defined $action) {
1841 $action = $self->escapeHTML($action);
1844 $action = $self->escapeHTML($self->request_uri || $self->self_url);
1846 $action = qq(action="$action");
1847 my($other) = @other ? " @other" : '';
1848 $self->{'.parametersToAdd'}={};
1849 return qq/<form method="$method" $action enctype="$enctype"$other>\n/;
1854 #### Method: start_form
1855 # synonym for startform
1856 'start_form' => <<'END_OF_FUNC',
1858 $XHTML ? &start_multipart_form : &startform;
1862 'end_multipart_form' => <<'END_OF_FUNC',
1863 sub end_multipart_form {
1868 #### Method: start_multipart_form
1869 # synonym for startform
1870 'start_multipart_form' => <<'END_OF_FUNC',
1871 sub start_multipart_form {
1872 my($self,@p) = self_or_default(@_);
1873 if (defined($p[0]) && substr($p[0],0,1) eq '-') {
1874 return $self->startform(-enctype=>&MULTIPART,@p);
1876 my($method,$action,@other) =
1877 rearrange([METHOD,ACTION],@p);
1878 return $self->startform($method,$action,&MULTIPART,@other);
1884 #### Method: endform
1886 'endform' => <<'END_OF_FUNC',
1888 my($self,@p) = self_or_default(@_);
1890 return wantarray ? ("</form>") : "\n</form>";
1892 if (my @fields = $self->get_fields) {
1893 return wantarray ? ("<div>",@fields,"</div>","</form>")
1894 : "<div>".(join '',@fields)."</div>\n</form>";
1903 '_textfield' => <<'END_OF_FUNC',
1905 my($self,$tag,@p) = self_or_default(@_);
1906 my($name,$default,$size,$maxlength,$override,$tabindex,@other) =
1907 rearrange([NAME,[DEFAULT,VALUE,VALUES],SIZE,MAXLENGTH,[OVERRIDE,FORCE],TABINDEX],@p);
1909 my $current = $override ? $default :
1910 (defined($self->param($name)) ? $self->param($name) : $default);
1912 $current = defined($current) ? $self->escapeHTML($current,1) : '';
1913 $name = defined($name) ? $self->escapeHTML($name) : '';
1914 my($s) = defined($size) ? qq/ size="$size"/ : '';
1915 my($m) = defined($maxlength) ? qq/ maxlength="$maxlength"/ : '';
1916 my($other) = @other ? " @other" : '';
1917 # this entered at cristy's request to fix problems with file upload fields
1918 # and WebTV -- not sure it won't break stuff
1919 my($value) = $current ne '' ? qq(value="$current") : '';
1920 $tabindex = $self->element_tab($tabindex);
1921 return $XHTML ? qq(<input type="$tag" name="$name" $tabindex$value$s$m$other />)
1922 : qq(<input type="$tag" name="$name" $value$s$m$other>);
1926 #### Method: textfield
1928 # $name -> Name of the text field
1929 # $default -> Optional default value of the field if not
1931 # $size -> Optional width of field in characaters.
1932 # $maxlength -> Optional maximum number of characters.
1934 # A string containing a <input type="text"> field
1936 'textfield' => <<'END_OF_FUNC',
1938 my($self,@p) = self_or_default(@_);
1939 $self->_textfield('text',@p);
1944 #### Method: filefield
1946 # $name -> Name of the file upload field
1947 # $size -> Optional width of field in characaters.
1948 # $maxlength -> Optional maximum number of characters.
1950 # A string containing a <input type="file"> field
1952 'filefield' => <<'END_OF_FUNC',
1954 my($self,@p) = self_or_default(@_);
1955 $self->_textfield('file',@p);
1960 #### Method: password
1961 # Create a "secret password" entry field
1963 # $name -> Name of the field
1964 # $default -> Optional default value of the field if not
1966 # $size -> Optional width of field in characters.
1967 # $maxlength -> Optional maximum characters that can be entered.
1969 # A string containing a <input type="password"> field
1971 'password_field' => <<'END_OF_FUNC',
1972 sub password_field {
1973 my ($self,@p) = self_or_default(@_);
1974 $self->_textfield('password',@p);
1978 #### Method: textarea
1980 # $name -> Name of the text field
1981 # $default -> Optional default value of the field if not
1983 # $rows -> Optional number of rows in text area
1984 # $columns -> Optional number of columns in text area
1986 # A string containing a <textarea></textarea> tag
1988 'textarea' => <<'END_OF_FUNC',
1990 my($self,@p) = self_or_default(@_);
1991 my($name,$default,$rows,$cols,$override,$tabindex,@other) =
1992 rearrange([NAME,[DEFAULT,VALUE],ROWS,[COLS,COLUMNS],[OVERRIDE,FORCE],TABINDEX],@p);
1994 my($current)= $override ? $default :
1995 (defined($self->param($name)) ? $self->param($name) : $default);
1997 $name = defined($name) ? $self->escapeHTML($name) : '';
1998 $current = defined($current) ? $self->escapeHTML($current) : '';
1999 my($r) = $rows ? qq/ rows="$rows"/ : '';
2000 my($c) = $cols ? qq/ cols="$cols"/ : '';
2001 my($other) = @other ? " @other" : '';
2002 $tabindex = $self->element_tab($tabindex);
2003 return qq{<textarea name="$name" $tabindex$r$c$other>$current</textarea>};
2009 # Create a javascript button.
2011 # $name -> (optional) Name for the button. (-name)
2012 # $value -> (optional) Value of the button when selected (and visible name) (-value)
2013 # $onclick -> (optional) Text of the JavaScript to run when the button is
2016 # A string containing a <input type="button"> tag
2018 'button' => <<'END_OF_FUNC',
2020 my($self,@p) = self_or_default(@_);
2022 my($label,$value,$script,$tabindex,@other) = rearrange([NAME,[VALUE,LABEL],
2023 [ONCLICK,SCRIPT],TABINDEX],@p);
2025 $label=$self->escapeHTML($label);
2026 $value=$self->escapeHTML($value,1);
2027 $script=$self->escapeHTML($script);
2030 $name = qq/ name="$label"/ if $label;
2031 $value = $value || $label;
2033 $val = qq/ value="$value"/ if $value;
2034 $script = qq/ onclick="$script"/ if $script;
2035 my($other) = @other ? " @other" : '';
2036 $tabindex = $self->element_tab($tabindex);
2037 return $XHTML ? qq(<input type="button" $tabindex$name$val$script$other />)
2038 : qq(<input type="button"$name$val$script$other>);
2044 # Create a "submit query" button.
2046 # $name -> (optional) Name for the button.
2047 # $value -> (optional) Value of the button when selected (also doubles as label).
2048 # $label -> (optional) Label printed on the button(also doubles as the value).
2050 # A string containing a <input type="submit"> tag
2052 'submit' => <<'END_OF_FUNC',
2054 my($self,@p) = self_or_default(@_);
2056 my($label,$value,$tabindex,@other) = rearrange([NAME,[VALUE,LABEL],TABINDEX],@p);
2058 $label=$self->escapeHTML($label);
2059 $value=$self->escapeHTML($value,1);
2061 my $name = $NOSTICKY ? '' : 'name=".submit" ';
2062 $name = qq/name="$label" / if defined($label);
2063 $value = defined($value) ? $value : $label;
2065 $val = qq/value="$value" / if defined($value);
2066 $tabindex = $self->element_tab($tabindex);
2067 my($other) = @other ? "@other " : '';
2068 return $XHTML ? qq(<input type="submit" $tabindex$name$val$other/>)
2069 : qq(<input type="submit" $name$val$other>);
2075 # Create a "reset" button.
2077 # $name -> (optional) Name for the button.
2079 # A string containing a <input type="reset"> tag
2081 'reset' => <<'END_OF_FUNC',
2083 my($self,@p) = self_or_default(@_);
2084 my($label,$value,$tabindex,@other) = rearrange(['NAME',['VALUE','LABEL'],TABINDEX],@p);
2085 $label=$self->escapeHTML($label);
2086 $value=$self->escapeHTML($value,1);
2087 my ($name) = ' name=".reset"';
2088 $name = qq/ name="$label"/ if defined($label);
2089 $value = defined($value) ? $value : $label;
2091 $val = qq/ value="$value"/ if defined($value);
2092 my($other) = @other ? " @other" : '';
2093 $tabindex = $self->element_tab($tabindex);
2094 return $XHTML ? qq(<input type="reset" $tabindex$name$val$other />)
2095 : qq(<input type="reset"$name$val$other>);
2100 #### Method: defaults
2101 # Create a "defaults" button.
2103 # $name -> (optional) Name for the button.
2105 # A string containing a <input type="submit" name=".defaults"> tag
2107 # Note: this button has a special meaning to the initialization script,
2108 # and tells it to ERASE the current query string so that your defaults
2111 'defaults' => <<'END_OF_FUNC',
2113 my($self,@p) = self_or_default(@_);
2115 my($label,$tabindex,@other) = rearrange([[NAME,VALUE],TABINDEX],@p);
2117 $label=$self->escapeHTML($label,1);
2118 $label = $label || "Defaults";
2119 my($value) = qq/ value="$label"/;
2120 my($other) = @other ? " @other" : '';
2121 $tabindex = $self->element_tab($tabindex);
2122 return $XHTML ? qq(<input type="submit" name=".defaults" $tabindex$value$other />)
2123 : qq/<input type="submit" NAME=".defaults"$value$other>/;
2128 #### Method: comment
2129 # Create an HTML <!-- comment -->
2130 # Parameters: a string
2131 'comment' => <<'END_OF_FUNC',
2133 my($self,@p) = self_or_CGI(@_);
2134 return "<!-- @p -->";
2138 #### Method: checkbox
2139 # Create a checkbox that is not logically linked to any others.
2140 # The field value is "on" when the button is checked.
2142 # $name -> Name of the checkbox
2143 # $checked -> (optional) turned on by default if true
2144 # $value -> (optional) value of the checkbox, 'on' by default
2145 # $label -> (optional) a user-readable label printed next to the box.
2146 # Otherwise the checkbox name is used.
2148 # A string containing a <input type="checkbox"> field
2150 'checkbox' => <<'END_OF_FUNC',
2152 my($self,@p) = self_or_default(@_);
2154 my($name,$checked,$value,$label,$labelattributes,$override,$tabindex,@other) =
2155 rearrange([NAME,[CHECKED,SELECTED,ON],VALUE,LABEL,LABELATTRIBUTES,
2156 [OVERRIDE,FORCE],TABINDEX],@p);
2158 $value = defined $value ? $value : 'on';
2160 if (!$override && ($self->{'.fieldnames'}->{$name} ||
2161 defined $self->param($name))) {
2162 $checked = grep($_ eq $value,$self->param($name)) ? $self->_checked(1) : '';
2164 $checked = $self->_checked($checked);
2166 my($the_label) = defined $label ? $label : $name;
2167 $name = $self->escapeHTML($name);
2168 $value = $self->escapeHTML($value,1);
2169 $the_label = $self->escapeHTML($the_label);
2170 my($other) = @other ? "@other " : '';
2171 $tabindex = $self->element_tab($tabindex);
2172 $self->register_parameter($name);
2173 return $XHTML ? CGI::label($labelattributes,
2174 qq{<input type="checkbox" name="$name" value="$value" $tabindex$checked$other/>$the_label})
2175 : qq{<input type="checkbox" name="$name" value="$value"$checked$other>$the_label};
2181 # Escape HTML -- used internally
2182 'escapeHTML' => <<'END_OF_FUNC',
2184 # hack to work around earlier hacks
2185 push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
2186 my ($self,$toencode,$newlinestoo) = CGI::self_or_default(@_);
2187 return undef unless defined($toencode);
2188 return $toencode if ref($self) && !$self->{'escape'};
2189 $toencode =~ s{&}{&}gso;
2190 $toencode =~ s{<}{<}gso;
2191 $toencode =~ s{>}{>}gso;
2192 if ($DTD_PUBLIC_IDENTIFIER =~ /[^X]HTML 3\.2/i) {
2193 # $quot; was accidentally omitted from the HTML 3.2 DTD -- see
2194 # <http://validator.w3.org/docs/errors.html#bad-entity> /
2195 # <http://lists.w3.org/Archives/Public/www-html/1997Mar/0003.html>.
2196 $toencode =~ s{"}{"}gso;
2199 $toencode =~ s{"}{"}gso;
2201 # Handle bug in some browsers with Latin charsets
2202 if ($self->{'.charset'} &&
2203 (uc($self->{'.charset'}) eq 'ISO-8859-1' ||
2204 uc($self->{'.charset'}) eq 'WINDOWS-1252'))
2206 $toencode =~ s{'}{'}gso;
2207 $toencode =~ s{\x8b}{‹}gso;
2208 $toencode =~ s{\x9b}{›}gso;
2209 if (defined $newlinestoo && $newlinestoo) {
2210 $toencode =~ s{\012}{ }gso;
2211 $toencode =~ s{\015}{ }gso;
2218 # unescape HTML -- used internally
2219 'unescapeHTML' => <<'END_OF_FUNC',
2221 # hack to work around earlier hacks
2222 push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
2223 my ($self,$string) = CGI::self_or_default(@_);
2224 return undef unless defined($string);
2225 my $latin = defined $self->{'.charset'} ? $self->{'.charset'} =~ /^(ISO-8859-1|WINDOWS-1252)$/i
2227 # thanks to Randal Schwartz for the correct solution to this one
2228 $string=~ s[&(.*?);]{
2234 /^#(\d+)$/ && $latin ? chr($1) :
2235 /^#x([0-9a-f]+)$/i && $latin ? chr(hex($1)) :
2242 # Internal procedure - don't use
2243 '_tableize' => <<'END_OF_FUNC',
2245 my($rows,$columns,$rowheaders,$colheaders,@elements) = @_;
2246 my @rowheaders = $rowheaders ? @$rowheaders : ();
2247 my @colheaders = $colheaders ? @$colheaders : ();
2250 if (defined($columns)) {
2251 $rows = int(0.99 + @elements/$columns) unless defined($rows);
2253 if (defined($rows)) {
2254 $columns = int(0.99 + @elements/$rows) unless defined($columns);
2257 # rearrange into a pretty table
2258 $result = "<table>";
2260 unshift(@colheaders,'') if @colheaders && @rowheaders;
2261 $result .= "<tr>" if @colheaders;
2262 foreach (@colheaders) {
2263 $result .= "<th>$_</th>";
2265 for ($row=0;$row<$rows;$row++) {
2267 $result .= "<th>$rowheaders[$row]</th>" if @rowheaders;
2268 for ($column=0;$column<$columns;$column++) {
2269 $result .= "<td>" . $elements[$column*$rows + $row] . "</td>"
2270 if defined($elements[$column*$rows + $row]);
2274 $result .= "</table>";
2280 #### Method: radio_group
2281 # Create a list of logically-linked radio buttons.
2283 # $name -> Common name for all the buttons.
2284 # $values -> A pointer to a regular array containing the
2285 # values for each button in the group.
2286 # $default -> (optional) Value of the button to turn on by default. Pass '-'
2287 # to turn _nothing_ on.
2288 # $linebreak -> (optional) Set to true to place linebreaks
2289 # between the buttons.
2290 # $labels -> (optional)
2291 # A pointer to an associative array of labels to print next to each checkbox
2292 # in the form $label{'value'}="Long explanatory label".
2293 # Otherwise the provided values are used as the labels.
2295 # An ARRAY containing a series of <input type="radio"> fields
2297 'radio_group' => <<'END_OF_FUNC',
2299 my($self,@p) = self_or_default(@_);
2300 $self->_box_group('radio',@p);
2304 #### Method: checkbox_group
2305 # Create a list of logically-linked checkboxes.
2307 # $name -> Common name for all the check boxes
2308 # $values -> A pointer to a regular array containing the
2309 # values for each checkbox in the group.
2310 # $defaults -> (optional)
2311 # 1. If a pointer to a regular array of checkbox values,
2312 # then this will be used to decide which
2313 # checkboxes to turn on by default.
2314 # 2. If a scalar, will be assumed to hold the
2315 # value of a single checkbox in the group to turn on.
2316 # $linebreak -> (optional) Set to true to place linebreaks
2317 # between the buttons.
2318 # $labels -> (optional)
2319 # A pointer to an associative array of labels to print next to each checkbox
2320 # in the form $label{'value'}="Long explanatory label".
2321 # Otherwise the provided values are used as the labels.
2323 # An ARRAY containing a series of <input type="checkbox"> fields
2326 'checkbox_group' => <<'END_OF_FUNC',
2327 sub checkbox_group {
2328 my($self,@p) = self_or_default(@_);
2329 $self->_box_group('checkbox',@p);
2333 '_box_group' => <<'END_OF_FUNC',
2336 my $box_type = shift;
2338 my($name,$values,$defaults,$linebreak,$labels,$labelattributes,
2339 $attributes,$rows,$columns,$rowheaders,$colheaders,
2340 $override,$nolabels,$tabindex,$disabled,@other) =
2341 rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LINEBREAK,LABELS,LABELATTRIBUTES,
2342 ATTRIBUTES,ROWS,[COLUMNS,COLS],[ROWHEADERS,ROWHEADER],[COLHEADERS,COLHEADER],
2343 [OVERRIDE,FORCE],NOLABELS,TABINDEX,DISABLED
2347 my($result,$checked,@elements,@values);
2349 @values = $self->_set_values_and_labels($values,\$labels,$name);
2350 my %checked = $self->previous_or_default($name,$defaults,$override);
2352 # If no check array is specified, check the first by default
2353 $checked{$values[0]}++ if $box_type eq 'radio' && !%checked;
2355 $name=$self->escapeHTML($name);
2358 if ($TABINDEX && $tabindex) {
2359 if (!ref $tabindex) {
2360 $self->element_tab($tabindex);
2361 } elsif (ref $tabindex eq 'ARRAY') {
2362 %tabs = map {$_=>$self->element_tab} @$tabindex;
2363 } elsif (ref $tabindex eq 'HASH') {
2367 %tabs = map {$_=>$self->element_tab} @values unless %tabs;
2368 my $other = @other ? "@other " : '';
2371 # for disabling groups of radio/checkbox buttons
2373 foreach (@{$disabled}) {
2379 if ($disabled{$_}) {
2380 $disable="disabled='1'";
2383 my $checkit = $self->_checked($box_type eq 'radio' ? ($checked{$_} && !$radio_checked++)
2387 $break = $XHTML ? "<br />" : "<br>";
2393 unless (defined($nolabels) && $nolabels) {
2395 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2396 $label = $self->escapeHTML($label,1);
2397 $label = "<span style=\"color:gray\">$label</span>" if $disabled{$_};
2399 my $attribs = $self->_set_attributes($_, $attributes);
2400 my $tab = $tabs{$_};
2401 $_=$self->escapeHTML($_);
2405 CGI::label($labelattributes,
2406 qq(<input type="$box_type" name="$name" value="$_" $checkit$other$tab$attribs$disable/>$label)).${break};
2408 push(@elements,qq/<input type="$box_type" name="$name" value="$_"$checkit$other$tab$attribs$disable>${label}${break}/);
2411 $self->register_parameter($name);
2412 return wantarray ? @elements : "@elements"
2413 unless defined($columns) || defined($rows);
2414 return _tableize($rows,$columns,$rowheaders,$colheaders,@elements);
2419 #### Method: popup_menu
2420 # Create a popup menu.
2422 # $name -> Name for all the menu
2423 # $values -> A pointer to a regular array containing the
2424 # text of each menu item.
2425 # $default -> (optional) Default item to display
2426 # $labels -> (optional)
2427 # A pointer to an associative array of labels to print next to each checkbox
2428 # in the form $label{'value'}="Long explanatory label".
2429 # Otherwise the provided values are used as the labels.
2431 # A string containing the definition of a popup menu.
2433 'popup_menu' => <<'END_OF_FUNC',
2435 my($self,@p) = self_or_default(@_);
2437 my($name,$values,$default,$labels,$attributes,$override,$tabindex,@other) =
2438 rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LABELS,
2439 ATTRIBUTES,[OVERRIDE,FORCE],TABINDEX],@p);
2440 my($result,$selected);
2442 if (!$override && defined($self->param($name))) {
2443 $selected = $self->param($name);
2445 $selected = $default;
2447 $name=$self->escapeHTML($name);
2448 my($other) = @other ? " @other" : '';
2451 @values = $self->_set_values_and_labels($values,\$labels,$name);
2452 $tabindex = $self->element_tab($tabindex);
2453 $result = qq/<select name="$name" $tabindex$other>\n/;
2456 foreach (split(/\n/)) {
2457 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2458 s/(value="$selected")/$selectit $1/ if defined $selected;
2463 my $attribs = $self->_set_attributes($_, $attributes);
2464 my($selectit) = defined($selected) ? $self->_selected($selected eq $_) : '';
2466 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2467 my($value) = $self->escapeHTML($_);
2468 $label=$self->escapeHTML($label,1);
2469 $result .= "<option${attribs} ${selectit}value=\"$value\">$label</option>\n";
2473 $result .= "</select>";
2479 #### Method: optgroup
2480 # Create a optgroup.
2482 # $name -> Label for the group
2483 # $values -> A pointer to a regular array containing the
2484 # values for each option line in the group.
2485 # $labels -> (optional)
2486 # A pointer to an associative array of labels to print next to each item
2487 # in the form $label{'value'}="Long explanatory label".
2488 # Otherwise the provided values are used as the labels.
2489 # $labeled -> (optional)
2490 # A true value indicates the value should be used as the label attribute
2491 # in the option elements.
2492 # The label attribute specifies the option label presented to the user.
2493 # This defaults to the content of the <option> element, but the label
2494 # attribute allows authors to more easily use optgroup without sacrificing
2495 # compatibility with browsers that do not support option groups.
2496 # $novals -> (optional)
2497 # A true value indicates to suppress the val attribute in the option elements
2499 # A string containing the definition of an option group.
2501 'optgroup' => <<'END_OF_FUNC',
2503 my($self,@p) = self_or_default(@_);
2504 my($name,$values,$attributes,$labeled,$noval,$labels,@other)
2505 = rearrange([NAME,[VALUES,VALUE],ATTRIBUTES,LABELED,NOVALS,LABELS],@p);
2507 my($result,@values);
2508 @values = $self->_set_values_and_labels($values,\$labels,$name,$labeled,$novals);
2509 my($other) = @other ? " @other" : '';
2511 $name=$self->escapeHTML($name);
2512 $result = qq/<optgroup label="$name"$other>\n/;
2515 foreach (split(/\n/)) {
2516 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2517 s/(value="$selected")/$selectit $1/ if defined $selected;
2522 my $attribs = $self->_set_attributes($_, $attributes);
2524 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2525 $label=$self->escapeHTML($label);
2526 my($value)=$self->escapeHTML($_,1);
2527 $result .= $labeled ? $novals ? "<option$attribs label=\"$value\">$label</option>\n"
2528 : "<option$attribs label=\"$value\" value=\"$value\">$label</option>\n"
2529 : $novals ? "<option$attribs>$label</option>\n"
2530 : "<option$attribs value=\"$value\">$label</option>\n";
2533 $result .= "</optgroup>";
2539 #### Method: scrolling_list
2540 # Create a scrolling list.
2542 # $name -> name for the list
2543 # $values -> A pointer to a regular array containing the
2544 # values for each option line in the list.
2545 # $defaults -> (optional)
2546 # 1. If a pointer to a regular array of options,
2547 # then this will be used to decide which
2548 # lines to turn on by default.
2549 # 2. Otherwise holds the value of the single line to turn on.
2550 # $size -> (optional) Size of the list.
2551 # $multiple -> (optional) If set, allow multiple selections.
2552 # $labels -> (optional)
2553 # A pointer to an associative array of labels to print next to each checkbox
2554 # in the form $label{'value'}="Long explanatory label".
2555 # Otherwise the provided values are used as the labels.
2557 # A string containing the definition of a scrolling list.
2559 'scrolling_list' => <<'END_OF_FUNC',
2560 sub scrolling_list {
2561 my($self,@p) = self_or_default(@_);
2562 my($name,$values,$defaults,$size,$multiple,$labels,$attributes,$override,$tabindex,@other)
2563 = rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT],
2564 SIZE,MULTIPLE,LABELS,ATTRIBUTES,[OVERRIDE,FORCE],TABINDEX],@p);
2566 my($result,@values);
2567 @values = $self->_set_values_and_labels($values,\$labels,$name);
2569 $size = $size || scalar(@values);
2571 my(%selected) = $self->previous_or_default($name,$defaults,$override);
2573 my($is_multiple) = $multiple ? qq/ multiple="multiple"/ : '';
2574 my($has_size) = $size ? qq/ size="$size"/: '';
2575 my($other) = @other ? " @other" : '';
2577 $name=$self->escapeHTML($name);
2578 $tabindex = $self->element_tab($tabindex);
2579 $result = qq/<select name="$name" $tabindex$has_size$is_multiple$other>\n/;
2581 my($selectit) = $self->_selected($selected{$_});
2583 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2584 $label=$self->escapeHTML($label);
2585 my($value)=$self->escapeHTML($_,1);
2586 my $attribs = $self->_set_attributes($_, $attributes);
2587 $result .= "<option ${selectit}${attribs}value=\"$value\">$label</option>\n";
2589 $result .= "</select>";
2590 $self->register_parameter($name);
2598 # $name -> Name of the hidden field
2599 # @default -> (optional) Initial values of field (may be an array)
2601 # $default->[initial values of field]
2603 # A string containing a <input type="hidden" name="name" value="value">
2605 'hidden' => <<'END_OF_FUNC',
2607 my($self,@p) = self_or_default(@_);
2609 # this is the one place where we departed from our standard
2610 # calling scheme, so we have to special-case (darn)
2612 my($name,$default,$override,@other) =
2613 rearrange([NAME,[DEFAULT,VALUE,VALUES],[OVERRIDE,FORCE]],@p);
2615 my $do_override = 0;
2616 if ( ref($p[0]) || substr($p[0],0,1) eq '-') {
2617 @value = ref($default) ? @{$default} : $default;
2618 $do_override = $override;
2620 foreach ($default,$override,@other) {
2621 push(@value,$_) if defined($_);
2625 # use previous values if override is not set
2626 my @prev = $self->param($name);
2627 @value = @prev if !$do_override && @prev;
2629 $name=$self->escapeHTML($name);
2631 $_ = defined($_) ? $self->escapeHTML($_,1) : '';
2632 push @result,$XHTML ? qq(<input type="hidden" name="$name" value="$_" @other />)
2633 : qq(<input type="hidden" name="$name" value="$_" @other>);
2635 return wantarray ? @result : join('',@result);
2640 #### Method: image_button
2642 # $name -> Name of the button
2643 # $src -> URL of the image source
2644 # $align -> Alignment style (TOP, BOTTOM or MIDDLE)
2646 # A string containing a <input type="image" name="name" src="url" align="alignment">
2648 'image_button' => <<'END_OF_FUNC',
2650 my($self,@p) = self_or_default(@_);
2652 my($name,$src,$alignment,@other) =
2653 rearrange([NAME,SRC,ALIGN],@p);
2655 my($align) = $alignment ? " align=\L\"$alignment\"" : '';
2656 my($other) = @other ? " @other" : '';
2657 $name=$self->escapeHTML($name);
2658 return $XHTML ? qq(<input type="image" name="$name" src="$src"$align$other />)
2659 : qq/<input type="image" name="$name" src="$src"$align$other>/;
2664 #### Method: self_url
2665 # Returns a URL containing the current script and all its
2666 # param/value pairs arranged as a query. You can use this
2667 # to create a link that, when selected, will reinvoke the
2668 # script with all its state information preserved.
2670 'self_url' => <<'END_OF_FUNC',
2672 my($self,@p) = self_or_default(@_);
2673 return $self->url('-path_info'=>1,'-query'=>1,'-full'=>1,@p);
2678 # This is provided as a synonym to self_url() for people unfortunate
2679 # enough to have incorporated it into their programs already!
2680 'state' => <<'END_OF_FUNC',
2688 # Like self_url, but doesn't return the query string part of
2691 'url' => <<'END_OF_FUNC',
2693 my($self,@p) = self_or_default(@_);
2694 my ($relative,$absolute,$full,$path_info,$query,$base,$rewrite) =
2695 rearrange(['RELATIVE','ABSOLUTE','FULL',['PATH','PATH_INFO'],['QUERY','QUERY_STRING'],'BASE','REWRITE'],@p);
2697 $full++ if $base || !($relative || $absolute);
2698 $rewrite++ unless defined $rewrite;
2700 my $path = $self->path_info;
2701 my $script_name = $self->script_name;
2702 my $request_uri = unescape($self->request_uri) || '';
2703 my $query_str = $self->query_string;
2705 my $rewrite_in_use = $request_uri && $request_uri !~ /^\Q$script_name/;
2706 undef $path if $rewrite_in_use && $rewrite; # path not valid when rewriting active
2708 my $uri = $rewrite && $request_uri ? $request_uri : $script_name;
2709 $uri =~ s/\?.*$//; # remove query string
2710 $uri =~ s/\Q$path\E$// if defined $path; # remove path
2713 my $protocol = $self->protocol();
2714 $url = "$protocol://";
2715 my $vh = http('x_forwarded_host') || http('host') || '';
2716 $vh =~ s/\:\d+$//; # some clients add the port number (incorrectly). Get rid of it.
2720 $url .= server_name();
2722 my $port = $self->server_port;
2724 unless (lc($protocol) eq 'http' && $port == 80)
2725 || (lc($protocol) eq 'https' && $port == 443);
2726 return $url if $base;
2728 } elsif ($relative) {
2729 ($url) = $uri =~ m!([^/]+)$!;
2730 } elsif ($absolute) {
2734 $url .= $path if $path_info and defined $path;
2735 $url .= "?$query_str" if $query and $query_str ne '';
2737 $url =~ s/([^a-zA-Z0-9_.%;&?\/\\:+=~-])/sprintf("%%%02X",ord($1))/eg;
2744 # Set or read a cookie from the specified name.
2745 # Cookie can then be passed to header().
2746 # Usual rules apply to the stickiness of -value.
2748 # -name -> name for this cookie (optional)
2749 # -value -> value of this cookie (scalar, array or hash)
2750 # -path -> paths for which this cookie is valid (optional)
2751 # -domain -> internet domain in which this cookie is valid (optional)
2752 # -secure -> if true, cookie only passed through secure channel (optional)
2753 # -expires -> expiry date in format Wdy, DD-Mon-YYYY HH:MM:SS GMT (optional)
2755 'cookie' => <<'END_OF_FUNC',
2757 my($self,@p) = self_or_default(@_);
2758 my($name,$value,$path,$domain,$secure,$expires,$httponly) =
2759 rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES,HTTPONLY],@p);
2761 require CGI::Cookie;
2763 # if no value is supplied, then we retrieve the
2764 # value of the cookie, if any. For efficiency, we cache the parsed
2765 # cookies in our state variables.
2766 unless ( defined($value) ) {
2767 $self->{'.cookies'} = CGI::Cookie->fetch
2768 unless $self->{'.cookies'};
2770 # If no name is supplied, then retrieve the names of all our cookies.
2771 return () unless $self->{'.cookies'};
2772 return keys %{$self->{'.cookies'}} unless $name;
2773 return () unless $self->{'.cookies'}->{$name};
2774 return $self->{'.cookies'}->{$name}->value if defined($name) && $name ne '';
2777 # If we get here, we're creating a new cookie
2778 return undef unless defined($name) && $name ne ''; # this is an error
2781 push(@param,'-name'=>$name);
2782 push(@param,'-value'=>$value);
2783 push(@param,'-domain'=>$domain) if $domain;
2784 push(@param,'-path'=>$path) if $path;
2785 push(@param,'-expires'=>$expires) if $expires;
2786 push(@param,'-secure'=>$secure) if $secure;
2787 push(@param,'-httponly'=>$httponly) if $httponly;
2789 return new CGI::Cookie(@param);
2793 'parse_keywordlist' => <<'END_OF_FUNC',
2794 sub parse_keywordlist {
2795 my($self,$tosplit) = @_;
2796 $tosplit = unescape($tosplit); # unescape the keywords
2797 $tosplit=~tr/+/ /; # pluses to spaces
2798 my(@keywords) = split(/\s+/,$tosplit);
2803 'param_fetch' => <<'END_OF_FUNC',
2805 my($self,@p) = self_or_default(@_);
2806 my($name) = rearrange([NAME],@p);
2807 unless (exists($self->{$name})) {
2808 $self->add_parameter($name);
2809 $self->{$name} = [];
2812 return $self->{$name};
2816 ###############################################
2817 # OTHER INFORMATION PROVIDED BY THE ENVIRONMENT
2818 ###############################################
2820 #### Method: path_info
2821 # Return the extra virtual path information provided
2822 # after the URL (if any)
2824 'path_info' => <<'END_OF_FUNC',
2826 my ($self,$info) = self_or_default(@_);
2827 if (defined($info)) {
2828 $info = "/$info" if $info ne '' && substr($info,0,1) ne '/';
2829 $self->{'.path_info'} = $info;
2830 } elsif (! defined($self->{'.path_info'}) ) {
2831 my (undef,$path_info) = $self->_name_and_path_from_env;
2832 $self->{'.path_info'} = $path_info || '';
2834 return $self->{'.path_info'};
2838 # WE USE THIS TO COMPENSATE FOR A BUG IN APACHE 2 PRESENT AT LEAST UP THROUGH 2.0.54
2839 '_name_and_path_from_env' => <<'END_OF_FUNC',
2840 sub _name_and_path_from_env {
2842 my $raw_script_name = $ENV{SCRIPT_NAME} || '';
2843 my $raw_path_info = $ENV{PATH_INFO} || '';
2844 my $uri = unescape($self->request_uri) || '';
2846 my $protected = quotemeta($raw_path_info);
2847 $raw_script_name =~ s/$protected$//;
2849 my @uri_double_slashes = $uri =~ m^(/{2,}?)^g;
2850 my @path_double_slashes = "$raw_script_name $raw_path_info" =~ m^(/{2,}?)^g;
2852 my $apache_bug = @uri_double_slashes != @path_double_slashes;
2853 return ($raw_script_name,$raw_path_info) unless $apache_bug;
2855 my $path_info_search = quotemeta($raw_path_info);
2856 $path_info_search =~ s!/!/+!g;
2857 if ($uri =~ m/^(.+)($path_info_search)/) {
2860 return ($raw_script_name,$raw_path_info);
2866 #### Method: request_method
2867 # Returns 'POST', 'GET', 'PUT' or 'HEAD'
2869 'request_method' => <<'END_OF_FUNC',
2870 sub request_method {
2871 return $ENV{'REQUEST_METHOD'};
2875 #### Method: content_type
2876 # Returns the content_type string
2878 'content_type' => <<'END_OF_FUNC',
2880 return $ENV{'CONTENT_TYPE'};
2884 #### Method: path_translated
2885 # Return the physical path information provided
2886 # by the URL (if any)
2888 'path_translated' => <<'END_OF_FUNC',
2889 sub path_translated {
2890 return $ENV{'PATH_TRANSLATED'};
2895 #### Method: request_uri
2896 # Return the literal request URI
2898 'request_uri' => <<'END_OF_FUNC',
2900 return $ENV{'REQUEST_URI'};
2905 #### Method: query_string
2906 # Synthesize a query string from our current
2909 'query_string' => <<'END_OF_FUNC',
2911 my($self) = self_or_default(@_);
2912 my($param,$value,@pairs);
2913 foreach $param ($self->param) {
2914 my($eparam) = escape($param);
2915 foreach $value ($self->param($param)) {
2916 $value = escape($value);
2917 next unless defined $value;
2918 push(@pairs,"$eparam=$value");
2921 foreach (keys %{$self->{'.fieldnames'}}) {
2922 push(@pairs,".cgifields=".escape("$_"));
2924 return join($USE_PARAM_SEMICOLONS ? ';' : '&',@pairs);
2930 # Without parameters, returns an array of the
2931 # MIME types the browser accepts.
2932 # With a single parameter equal to a MIME
2933 # type, will return undef if the browser won't
2934 # accept it, 1 if the browser accepts it but
2935 # doesn't give a preference, or a floating point
2936 # value between 0.0 and 1.0 if the browser
2937 # declares a quantitative score for it.
2938 # This handles MIME type globs correctly.
2940 'Accept' => <<'END_OF_FUNC',
2942 my($self,$search) = self_or_CGI(@_);
2943 my(%prefs,$type,$pref,$pat);
2945 my(@accept) = split(',',$self->http('accept'));
2948 ($pref) = /q=(\d\.\d+|\d+)/;
2949 ($type) = m#(\S+/[^;]+)#;
2951 $prefs{$type}=$pref || 1;
2954 return keys %prefs unless $search;
2956 # if a search type is provided, we may need to
2957 # perform a pattern matching operation.
2958 # The MIME types use a glob mechanism, which
2959 # is easily translated into a perl pattern match
2961 # First return the preference for directly supported
2963 return $prefs{$search} if $prefs{$search};
2965 # Didn't get it, so try pattern matching.
2966 foreach (keys %prefs) {
2967 next unless /\*/; # not a pattern match
2968 ($pat = $_) =~ s/([^\w*])/\\$1/g; # escape meta characters
2969 $pat =~ s/\*/.*/g; # turn it into a pattern
2970 return $prefs{$_} if $search=~/$pat/;
2976 #### Method: user_agent
2977 # If called with no parameters, returns the user agent.
2978 # If called with one parameter, does a pattern match (case
2979 # insensitive) on the user agent.
2981 'user_agent' => <<'END_OF_FUNC',
2983 my($self,$match)=self_or_CGI(@_);
2984 return $self->http('user_agent') unless $match;
2985 return $self->http('user_agent') =~ /$match/i;
2990 #### Method: raw_cookie
2991 # Returns the magic cookies for the session.
2992 # The cookies are not parsed or altered in any way, i.e.
2993 # cookies are returned exactly as given in the HTTP
2994 # headers. If a cookie name is given, only that cookie's
2995 # value is returned, otherwise the entire raw cookie
2998 'raw_cookie' => <<'END_OF_FUNC',
3000 my($self,$key) = self_or_CGI(@_);
3002 require CGI::Cookie;
3004 if (defined($key)) {
3005 $self->{'.raw_cookies'} = CGI::Cookie->raw_fetch
3006 unless $self->{'.raw_cookies'};
3008 return () unless $self->{'.raw_cookies'};
3009 return () unless $self->{'.raw_cookies'}->{$key};
3010 return $self->{'.raw_cookies'}->{$key};
3012 return $self->http('cookie') || $ENV{'COOKIE'} || '';
3016 #### Method: virtual_host
3017 # Return the name of the virtual_host, which
3018 # is not always the same as the server
3020 'virtual_host' => <<'END_OF_FUNC',
3022 my $vh = http('x_forwarded_host') || http('host') || server_name();
3023 $vh =~ s/:\d+$//; # get rid of port number
3028 #### Method: remote_host
3029 # Return the name of the remote host, or its IP
3030 # address if unavailable. If this variable isn't
3031 # defined, it returns "localhost" for debugging
3034 'remote_host' => <<'END_OF_FUNC',
3036 return $ENV{'REMOTE_HOST'} || $ENV{'REMOTE_ADDR'}
3042 #### Method: remote_addr
3043 # Return the IP addr of the remote host.
3045 'remote_addr' => <<'END_OF_FUNC',
3047 return $ENV{'REMOTE_ADDR'} || '127.0.0.1';
3052 #### Method: script_name
3053 # Return the partial URL to this script for
3054 # self-referencing scripts. Also see
3055 # self_url(), which returns a URL with all state information
3058 'script_name' => <<'END_OF_FUNC',
3060 my ($self,@p) = self_or_default(@_);
3062 $self->{'.script_name'} = shift @p;
3063 } elsif (!exists $self->{'.script_name'}) {
3064 my ($script_name,$path_info) = $self->_name_and_path_from_env();
3065 $self->{'.script_name'} = $script_name;
3067 return $self->{'.script_name'};
3072 #### Method: referer
3073 # Return the HTTP_REFERER: useful for generating
3076 'referer' => <<'END_OF_FUNC',
3078 my($self) = self_or_CGI(@_);
3079 return $self->http('referer');
3084 #### Method: server_name
3085 # Return the name of the server
3087 'server_name' => <<'END_OF_FUNC',
3089 return $ENV{'SERVER_NAME'} || 'localhost';
3093 #### Method: server_software
3094 # Return the name of the server software
3096 'server_software' => <<'END_OF_FUNC',
3097 sub server_software {
3098 return $ENV{'SERVER_SOFTWARE'} || 'cmdline';
3102 #### Method: virtual_port
3103 # Return the server port, taking virtual hosts into account
3105 'virtual_port' => <<'END_OF_FUNC',
3107 my($self) = self_or_default(@_);
3108 my $vh = $self->http('x_forwarded_host') || $self->http('host');
3109 my $protocol = $self->protocol;
3111 return ($vh =~ /:(\d+)$/)[0] || ($protocol eq 'https' ? 443 : 80);
3113 return $self->server_port();
3118 #### Method: server_port
3119 # Return the tcp/ip port the server is running on
3121 'server_port' => <<'END_OF_FUNC',
3123 return $ENV{'SERVER_PORT'} || 80; # for debugging
3127 #### Method: server_protocol
3128 # Return the protocol (usually HTTP/1.0)
3130 'server_protocol' => <<'END_OF_FUNC',
3131 sub server_protocol {
3132 return $ENV{'SERVER_PROTOCOL'} || 'HTTP/1.0'; # for debugging
3137 # Return the value of an HTTP variable, or
3138 # the list of variables if none provided
3140 'http' => <<'END_OF_FUNC',
3142 my ($self,$parameter) = self_or_CGI(@_);
3143 return $ENV{$parameter} if $parameter=~/^HTTP/;
3144 $parameter =~ tr/-/_/;
3145 return $ENV{"HTTP_\U$parameter\E"} if $parameter;
3147 foreach (keys %ENV) {
3148 push(@p,$_) if /^HTTP/;
3155 # Return the value of HTTPS
3157 'https' => <<'END_OF_FUNC',
3160 my ($self,$parameter) = self_or_CGI(@_);
3161 return $ENV{HTTPS} unless $parameter;
3162 return $ENV{$parameter} if $parameter=~/^HTTPS/;
3163 $parameter =~ tr/-/_/;
3164 return $ENV{"HTTPS_\U$parameter\E"} if $parameter;
3166 foreach (keys %ENV) {
3167 push(@p,$_) if /^HTTPS/;
3173 #### Method: protocol
3174 # Return the protocol (http or https currently)
3176 'protocol' => <<'END_OF_FUNC',
3180 return 'https' if uc($self->https()) eq 'ON';
3181 return 'https' if $self->server_port == 443;
3182 my $prot = $self->server_protocol;
3183 my($protocol,$version) = split('/',$prot);
3184 return "\L$protocol\E";
3188 #### Method: remote_ident
3189 # Return the identity of the remote user
3190 # (but only if his host is running identd)
3192 'remote_ident' => <<'END_OF_FUNC',
3194 return $ENV{'REMOTE_IDENT'};
3199 #### Method: auth_type
3200 # Return the type of use verification/authorization in use, if any.
3202 'auth_type' => <<'END_OF_FUNC',
3204 return $ENV{'AUTH_TYPE'};
3209 #### Method: remote_user
3210 # Return the authorization name used for user
3213 'remote_user' => <<'END_OF_FUNC',
3215 return $ENV{'REMOTE_USER'};
3220 #### Method: user_name
3221 # Try to return the remote user's name by hook or by
3224 'user_name' => <<'END_OF_FUNC',
3226 my ($self) = self_or_CGI(@_);
3227 return $self->http('from') || $ENV{'REMOTE_IDENT'} || $ENV{'REMOTE_USER'};
3231 #### Method: nosticky
3232 # Set or return the NOSTICKY global flag
3234 'nosticky' => <<'END_OF_FUNC',
3236 my ($self,$param) = self_or_CGI(@_);
3237 $CGI::NOSTICKY = $param if defined($param);
3238 return $CGI::NOSTICKY;
3243 # Set or return the NPH global flag
3245 'nph' => <<'END_OF_FUNC',
3247 my ($self,$param) = self_or_CGI(@_);
3248 $CGI::NPH = $param if defined($param);
3253 #### Method: private_tempfiles
3254 # Set or return the private_tempfiles global flag
3256 'private_tempfiles' => <<'END_OF_FUNC',
3257 sub private_tempfiles {
3258 my ($self,$param) = self_or_CGI(@_);
3259 $CGI::PRIVATE_TEMPFILES = $param if defined($param);
3260 return $CGI::PRIVATE_TEMPFILES;
3263 #### Method: close_upload_files
3264 # Set or return the close_upload_files global flag
3266 'close_upload_files' => <<'END_OF_FUNC',
3267 sub close_upload_files {
3268 my ($self,$param) = self_or_CGI(@_);
3269 $CGI::CLOSE_UPLOAD_FILES = $param if defined($param);
3270 return $CGI::CLOSE_UPLOAD_FILES;
3275 #### Method: default_dtd
3276 # Set or return the default_dtd global
3278 'default_dtd' => <<'END_OF_FUNC',
3280 my ($self,$param,$param2) = self_or_CGI(@_);
3281 if (defined $param2 && defined $param) {
3282 $CGI::DEFAULT_DTD = [ $param, $param2 ];
3283 } elsif (defined $param) {
3284 $CGI::DEFAULT_DTD = $param;
3286 return $CGI::DEFAULT_DTD;
3290 # -------------- really private subroutines -----------------
3291 'previous_or_default' => <<'END_OF_FUNC',
3292 sub previous_or_default {
3293 my($self,$name,$defaults,$override) = @_;
3296 if (!$override && ($self->{'.fieldnames'}->{$name} ||
3297 defined($self->param($name)) ) ) {
3298 $selected{$_}++ for $self->param($name);
3299 } elsif (defined($defaults) && ref($defaults) &&
3300 (ref($defaults) eq 'ARRAY')) {
3301 $selected{$_}++ for @{$defaults};
3303 $selected{$defaults}++ if defined($defaults);
3310 'register_parameter' => <<'END_OF_FUNC',
3311 sub register_parameter {
3312 my($self,$param) = @_;
3313 $self->{'.parametersToAdd'}->{$param}++;
3317 'get_fields' => <<'END_OF_FUNC',
3320 return $self->CGI::hidden('-name'=>'.cgifields',
3321 '-values'=>[keys %{$self->{'.parametersToAdd'}}],
3326 'read_from_cmdline' => <<'END_OF_FUNC',
3327 sub read_from_cmdline {
3331 if ($DEBUG && @ARGV) {
3333 } elsif ($DEBUG > 1) {
3334 require "shellwords.pl";
3335 print STDERR "(offline mode: enter name=value pairs on standard input; press ^D or ^Z when done)\n";
3336 chomp(@lines = <STDIN>); # remove newlines
3337 $input = join(" ",@lines);
3338 @words = &shellwords($input);
3345 if ("@words"=~/=/) {
3346 $query_string = join('&',@words);
3348 $query_string = join('+',@words);
3350 if ($query_string =~ /^(.*?)\?(.*)$/)
3355 return { 'query_string' => $query_string, 'subpath' => $subpath };
3360 # subroutine: read_multipart
3362 # Read multipart data and store it into our parameters.
3363 # An interesting feature is that if any of the parts is a file, we
3364 # create a temporary file and open up a filehandle on it so that the
3365 # caller can read from it if necessary.
3367 'read_multipart' => <<'END_OF_FUNC',
3368 sub read_multipart {
3369 my($self,$boundary,$length) = @_;
3370 my($buffer) = $self->new_MultipartBuffer($boundary,$length);
3371 return unless $buffer;
3374 while (!$buffer->eof) {
3375 %header = $buffer->readHeader;
3378 $self->cgi_error("400 Bad request (malformed multipart POST)");
3382 my($param)= $header{'Content-Disposition'}=~/ name="([^"]*)"/;
3385 # See RFC 1867, 2183, 2045
3386 # NB: File content will be loaded into memory should
3387 # content-disposition parsing fail.
3388 my ($filename) = $header{'Content-Disposition'}
3389 =~/ filename=(("[^"]*")|([a-z\d!\#'\*\+,\.^_\`\{\}\|\~]*))/i;
3390 $filename =~ s/^"([^"]*)"$/$1/;
3391 # Test for Opera's multiple upload feature
3392 my($multipart) = ( defined( $header{'Content-Type'} ) &&
3393 $header{'Content-Type'} =~ /multipart\/mixed/ ) ?
3396 # add this parameter to our list
3397 $self->add_parameter($param);
3399 # If no filename specified, then just read the data and assign it
3400 # to our parameter list.
3401 if ( ( !defined($filename) || $filename eq '' ) && !$multipart ) {
3402 my($value) = $buffer->readBody;
3404 push(@{$self->{$param}},$value);
3408 my ($tmpfile,$tmp,$filehandle);
3410 # If we get here, then we are dealing with a potentially large
3411 # uploaded form. Save the data to a temporary file, then open
3412 # the file for reading.
3414 # skip the file if uploads disabled
3415 if ($DISABLE_UPLOADS) {
3416 while (defined($data = $buffer->read)) { }
3420 # set the filename to some recognizable value
3421 if ( ( !defined($filename) || $filename eq '' ) && $multipart ) {
3422 $filename = "multipart/mixed";
3425 # choose a relatively unpredictable tmpfile sequence number
3426 my $seqno = unpack("%16C*",join('',localtime,grep {defined $_} values %ENV));
3427 for (my $cnt=10;$cnt>0;$cnt--) {
3428 next unless $tmpfile = new CGITempFile($seqno);
3429 $tmp = $tmpfile->as_string;
3430 last if defined($filehandle = Fh->new($filename,$tmp,$PRIVATE_TEMPFILES));
3431 $seqno += int rand(100);
3433 die "CGI open of tmpfile: $!\n" unless defined $filehandle;
3434 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode
3435 && defined fileno($filehandle);
3437 # if this is an multipart/mixed attachment, save the header
3438 # together with the body for later parsing with an external
3439 # MIME parser module
3441 foreach ( keys %header ) {
3442 print $filehandle "$_: $header{$_}${CRLF}";
3444 print $filehandle "${CRLF}";
3450 while (defined($data = $buffer->read)) {
3451 if (defined $self->{'.upload_hook'})
3453 $totalbytes += length($data);
3454 &{$self->{'.upload_hook'}}($filename ,$data, $totalbytes, $self->{'.upload_data'});
3456 print $filehandle $data if ($self->{'use_tempfile'});
3459 # back up to beginning of file
3460 seek($filehandle,0,0);
3462 ## Close the filehandle if requested this allows a multipart MIME
3463 ## upload to contain many files, and we won't die due to too many
3464 ## open file handles. The user can access the files using the hash
3466 close $filehandle if $CLOSE_UPLOAD_FILES;
3467 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
3469 # Save some information about the uploaded file where we can get
3471 # Use the typeglob as the key, as this is guaranteed to be
3472 # unique for each filehandle. Don't use the file descriptor as
3473 # this will be re-used for each filehandle if the
3474 # close_upload_files feature is used.
3475 $self->{'.tmpfiles'}->{$$filehandle}= {
3476 hndl => $filehandle,
3480 push(@{$self->{$param}},$filehandle);
3487 # subroutine: read_multipart_related
3489 # Read multipart/related data and store it into our parameters. The
3490 # first parameter sets the start of the data. The part identified by
3491 # this Content-ID will not be stored as a file upload, but will be
3492 # returned by this method. All other parts will be available as file
3493 # uploads accessible by their Content-ID
3495 'read_multipart_related' => <<'END_OF_FUNC',
3496 sub read_multipart_related {
3497 my($self,$start,$boundary,$length) = @_;
3498 my($buffer) = $self->new_MultipartBuffer($boundary,$length);
3499 return unless $buffer;
3503 while (!$buffer->eof) {
3504 %header = $buffer->readHeader;
3507 $self->cgi_error("400 Bad request (malformed multipart POST)");
3511 my($param) = $header{'Content-ID'}=~/\<([^\>]*)\>/;
3514 # If this is the start part, then just read the data and assign it
3515 # to our return variable.
3516 if ( $param eq $start ) {
3517 $returnvalue = $buffer->readBody;
3518 $returnvalue .= $TAINTED;
3522 # add this parameter to our list
3523 $self->add_parameter($param);
3525 my ($tmpfile,$tmp,$filehandle);
3527 # If we get here, then we are dealing with a potentially large
3528 # uploaded form. Save the data to a temporary file, then open
3529 # the file for reading.
3531 # skip the file if uploads disabled
3532 if ($DISABLE_UPLOADS) {
3533 while (defined($data = $buffer->read)) { }
3537 # choose a relatively unpredictable tmpfile sequence number
3538 my $seqno = unpack("%16C*",join('',localtime,grep {defined $_} values %ENV));
3539 for (my $cnt=10;$cnt>0;$cnt--) {
3540 next unless $tmpfile = new CGITempFile($seqno);
3541 $tmp = $tmpfile->as_string;
3542 last if defined($filehandle = Fh->new($param,$tmp,$PRIVATE_TEMPFILES));
3543 $seqno += int rand(100);
3545 die "CGI open of tmpfile: $!\n" unless defined $filehandle;
3546 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode
3547 && defined fileno($filehandle);
3552 while (defined($data = $buffer->read)) {
3553 if (defined $self->{'.upload_hook'})
3555 $totalbytes += length($data);
3556 &{$self->{'.upload_hook'}}($param ,$data, $totalbytes, $self->{'.upload_data'});
3558 print $filehandle $data if ($self->{'use_tempfile'});
3561 # back up to beginning of file
3562 seek($filehandle,0,0);
3564 ## Close the filehandle if requested this allows a multipart MIME
3565 ## upload to contain many files, and we won't die due to too many
3566 ## open file handles. The user can access the files using the hash
3568 close $filehandle if $CLOSE_UPLOAD_FILES;
3569 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
3571 # Save some information about the uploaded file where we can get
3573 # Use the typeglob as the key, as this is guaranteed to be
3574 # unique for each filehandle. Don't use the file descriptor as
3575 # this will be re-used for each filehandle if the
3576 # close_upload_files feature is used.
3577 $self->{'.tmpfiles'}->{$$filehandle}= {
3578 hndl => $filehandle,
3582 push(@{$self->{$param}},$filehandle);
3585 return $returnvalue;
3590 'upload' =><<'END_OF_FUNC',
3592 my($self,$param_name) = self_or_default(@_);
3593 my @param = grep {ref($_) && defined(fileno($_))} $self->param($param_name);
3594 return unless @param;
3595 return wantarray ? @param : $param[0];
3599 'tmpFileName' => <<'END_OF_FUNC',
3601 my($self,$filename) = self_or_default(@_);
3602 return $self->{'.tmpfiles'}->{$$filename}->{name} ?
3603 $self->{'.tmpfiles'}->{$$filename}->{name}->as_string
3608 'uploadInfo' => <<'END_OF_FUNC',
3610 my($self,$filename) = self_or_default(@_);
3611 return $self->{'.tmpfiles'}->{$$filename}->{info};
3615 # internal routine, don't use
3616 '_set_values_and_labels' => <<'END_OF_FUNC',
3617 sub _set_values_and_labels {
3620 $$l = $v if ref($v) eq 'HASH' && !ref($$l);
3621 return $self->param($n) if !defined($v);
3622 return $v if !ref($v);
3623 return ref($v) eq 'HASH' ? keys %$v : @$v;
3627 # internal routine, don't use
3628 '_set_attributes' => <<'END_OF_FUNC',
3629 sub _set_attributes {
3631 my($element, $attributes) = @_;
3632 return '' unless defined($attributes->{$element});
3634 foreach my $attrib (keys %{$attributes->{$element}}) {
3635 (my $clean_attrib = $attrib) =~ s/^-//;
3636 $attribs .= "@{[lc($clean_attrib)]}=\"$attributes->{$element}{$attrib}\" ";
3643 '_compile_all' => <<'END_OF_FUNC',
3646 next if defined(&$_);
3647 $AUTOLOAD = "CGI::$_";
3657 #########################################################
3658 # Globals and stubs for other packages that we use.
3659 #########################################################
3661 ################### Fh -- lightweight filehandle ###############
3670 *Fh::AUTOLOAD = \&CGI::AUTOLOAD;
3677 $AUTOLOADED_ROUTINES = ''; # prevent -w error
3678 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3680 'asString' => <<'END_OF_FUNC',
3683 # get rid of package name
3684 (my $i = $$self) =~ s/^\*(\w+::fh\d{5})+//;
3685 $i =~ s/%(..)/ chr(hex($1)) /eg;
3686 return $i.$CGI::TAINTED;
3688 # This was an extremely clever patch that allowed "use strict refs".
3689 # Unfortunately it relied on another bug that caused leaky file descriptors.
3690 # The underlying bug has been fixed, so this no longer works. However
3691 # "strict refs" still works for some reason.
3693 # return ${*{$self}{SCALAR}};
3698 'compare' => <<'END_OF_FUNC',
3702 return "$self" cmp $value;
3706 'new' => <<'END_OF_FUNC',
3708 my($pack,$name,$file,$delete) = @_;
3709 _setup_symbols(@SAVED_SYMBOLS) if @SAVED_SYMBOLS;
3710 require Fcntl unless defined &Fcntl::O_RDWR;
3711 (my $safename = $name) =~ s/([':%])/ sprintf '%%%02X', ord $1 /eg;
3712 my $fv = ++$FH . $safename;
3713 my $ref = \*{"Fh::$fv"};
3714 $file =~ m!^([a-zA-Z0-9_\+ \'\":/.\$\\-]+)$! || return;
3716 sysopen($ref,$safe,Fcntl::O_RDWR()|Fcntl::O_CREAT()|Fcntl::O_EXCL(),0600) || return;
3717 unlink($safe) if $delete;
3718 CORE::delete $Fh::{$fv};
3719 return bless $ref,$pack;
3726 ######################## MultipartBuffer ####################
3727 package MultipartBuffer;
3729 use constant DEBUG => 0;
3731 # how many bytes to read at a time. We use
3732 # a 4K buffer by default.
3733 $INITIAL_FILLUNIT = 1024 * 4;
3734 $TIMEOUT = 240*60; # 4 hour timeout for big files
3735 $SPIN_LOOP_MAX = 2000; # bug fix for some Netscape servers
3738 #reuse the autoload function
3739 *MultipartBuffer::AUTOLOAD = \&CGI::AUTOLOAD;
3741 # avoid autoloader warnings
3744 ###############################################################################
3745 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
3746 ###############################################################################
3747 $AUTOLOADED_ROUTINES = ''; # prevent -w error
3748 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3751 'new' => <<'END_OF_FUNC',
3753 my($package,$interface,$boundary,$length) = @_;
3754 $FILLUNIT = $INITIAL_FILLUNIT;
3755 $CGI::DefaultClass->binmode($IN); # if $CGI::needs_binmode; # just do it always
3757 # If the user types garbage into the file upload field,
3758 # then Netscape passes NOTHING to the server (not good).
3759 # We may hang on this read in that case. So we implement
3760 # a read timeout. If nothing is ready to read
3761 # by then, we return.
3763 # Netscape seems to be a little bit unreliable
3764 # about providing boundary strings.
3765 my $boundary_read = 0;
3768 # Under the MIME spec, the boundary consists of the
3769 # characters "--" PLUS the Boundary string
3771 # BUG: IE 3.01 on the Macintosh uses just the boundary -- not
3772 # the two extra hyphens. We do a special case here on the user-agent!!!!
3773 $boundary = "--$boundary" unless CGI::user_agent('MSIE\s+3\.0[12];\s*Mac|DreamPassport');
3775 } else { # otherwise we find it ourselves
3777 ($old,$/) = ($/,$CRLF); # read a CRLF-delimited line
3778 $boundary = <STDIN>; # BUG: This won't work correctly under mod_perl
3779 $length -= length($boundary);
3780 chomp($boundary); # remove the CRLF
3781 $/ = $old; # restore old line separator
3785 my $self = {LENGTH=>$length,
3787 BOUNDARY=>$boundary,
3788 INTERFACE=>$interface,
3792 $FILLUNIT = length($boundary)
3793 if length($boundary) > $FILLUNIT;
3795 my $retval = bless $self,ref $package || $package;
3797 # Read the preamble and the topmost (boundary) line plus the CRLF.
3798 unless ($boundary_read) {
3799 while ($self->read(0)) { }
3801 die "Malformed multipart POST: data truncated\n" if $self->eof;
3807 'readHeader' => <<'END_OF_FUNC',
3814 local($CRLF) = "\015\012" if $CGI::OS eq 'VMS' || $CGI::EBCDIC;
3817 $self->fillBuffer($FILLUNIT);
3818 $ok++ if ($end = index($self->{BUFFER},"${CRLF}${CRLF}")) >= 0;
3819 $ok++ if $self->{BUFFER} eq '';
3820 $bad++ if !$ok && $self->{LENGTH} <= 0;
3821 # this was a bad idea
3822 # $FILLUNIT *= 2 if length($self->{BUFFER}) >= $FILLUNIT;
3823 } until $ok || $bad;
3826 #EBCDIC NOTE: translate header into EBCDIC, but watch out for continuation lines!
3828 my($header) = substr($self->{BUFFER},0,$end+2);
3829 substr($self->{BUFFER},0,$end+4) = '';
3833 warn "untranslated header=$header\n" if DEBUG;
3834 $header = CGI::Util::ascii2ebcdic($header);
3835 warn "translated header=$header\n" if DEBUG;
3838 # See RFC 2045 Appendix A and RFC 822 sections 3.4.8
3839 # (Folding Long Header Fields), 3.4.3 (Comments)
3840 # and 3.4.5 (Quoted-Strings).
3842 my $token = '[-\w!\#$%&\'*+.^_\`|{}~]';
3843 $header=~s/$CRLF\s+/ /og; # merge continuation lines
3845 while ($header=~/($token+):\s+([^$CRLF]*)/mgox) {
3846 my ($field_name,$field_value) = ($1,$2);
3847 $field_name =~ s/\b(\w)/uc($1)/eg; #canonicalize
3848 $return{$field_name}=$field_value;
3854 # This reads and returns the body as a single scalar value.
3855 'readBody' => <<'END_OF_FUNC',
3861 #EBCDIC NOTE: want to translate returnval into EBCDIC HERE
3863 while (defined($data = $self->read)) {
3864 $returnval .= $data;
3868 warn "untranslated body=$returnval\n" if DEBUG;
3869 $returnval = CGI::Util::ascii2ebcdic($returnval);
3870 warn "translated body=$returnval\n" if DEBUG;
3876 # This will read $bytes or until the boundary is hit, whichever happens
3877 # first. After the boundary is hit, we return undef. The next read will
3878 # skip over the boundary and begin reading again;
3879 'read' => <<'END_OF_FUNC',
3881 my($self,$bytes) = @_;
3883 # default number of bytes to read
3884 $bytes = $bytes || $FILLUNIT;
3886 # Fill up our internal buffer in such a way that the boundary
3887 # is never split between reads.
3888 $self->fillBuffer($bytes);
3890 my $boundary_start = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY}) : $self->{BOUNDARY};
3891 my $boundary_end = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY}.'--') : $self->{BOUNDARY}.'--';
3893 # Find the boundary in the buffer (it may not be there).
3894 my $start = index($self->{BUFFER},$boundary_start);
3896 warn "boundary=$self->{BOUNDARY} length=$self->{LENGTH} start=$start\n" if DEBUG;
3898 # protect against malformed multipart POST operations
3899 die "Malformed multipart POST\n" unless $self->{CHUNKED} || ($start >= 0 || $self->{LENGTH} > 0);
3901 #EBCDIC NOTE: want to translate boundary search into ASCII here.
3903 # If the boundary begins the data, then skip past it
3907 # clear us out completely if we've hit the last boundary.
3908 if (index($self->{BUFFER},$boundary_end)==0) {
3914 # just remove the boundary.
3915 substr($self->{BUFFER},0,length($boundary_start))='';
3916 $self->{BUFFER} =~ s/^\012\015?//;
3921 if ($start > 0) { # read up to the boundary
3922 $bytesToReturn = $start-2 > $bytes ? $bytes : $start;
3923 } else { # read the requested number of bytes
3924 # leave enough bytes in the buffer to allow us to read
3925 # the boundary. Thanks to Kevin Hendrick for finding
3927 $bytesToReturn = $bytes - (length($boundary_start)+1);
3930 my $returnval=substr($self->{BUFFER},0,$bytesToReturn);
3931 substr($self->{BUFFER},0,$bytesToReturn)='';
3933 # If we hit the boundary, remove the CRLF from the end.
3934 return ($bytesToReturn==$start)
3935 ? substr($returnval,0,-2) : $returnval;
3940 # This fills up our internal buffer in such a way that the
3941 # boundary is never split between reads
3942 'fillBuffer' => <<'END_OF_FUNC',
3944 my($self,$bytes) = @_;
3945 return unless $self->{CHUNKED} || $self->{LENGTH};
3947 my($boundaryLength) = length($self->{BOUNDARY});
3948 my($bufferLength) = length($self->{BUFFER});
3949 my($bytesToRead) = $bytes - $bufferLength + $boundaryLength + 2;
3950 $bytesToRead = $self->{LENGTH} if !$self->{CHUNKED} && $self->{LENGTH} < $bytesToRead;
3952 # Try to read some data. We may hang here if the browser is screwed up.
3953 my $bytesRead = $self->{INTERFACE}->read_from_client(\$self->{BUFFER},
3956 warn "bytesToRead=$bytesToRead, bufferLength=$bufferLength, buffer=$self->{BUFFER}\n" if DEBUG;
3957 $self->{BUFFER} = '' unless defined $self->{BUFFER};
3959 # An apparent bug in the Apache server causes the read()
3960 # to return zero bytes repeatedly without blocking if the
3961 # remote user aborts during a file transfer. I don't know how
3962 # they manage this, but the workaround is to abort if we get
3963 # more than SPIN_LOOP_MAX consecutive zero reads.
3964 if ($bytesRead <= 0) {
3965 die "CGI.pm: Server closed socket during multipart read (client aborted?).\n"
3966 if ($self->{ZERO_LOOP_COUNTER}++ >= $SPIN_LOOP_MAX);
3968 $self->{ZERO_LOOP_COUNTER}=0;
3971 $self->{LENGTH} -= $bytesRead if !$self->{CHUNKED} && $bytesRead;
3976 # Return true when we've finished reading
3977 'eof' => <<'END_OF_FUNC'
3980 return 1 if (length($self->{BUFFER}) == 0)
3981 && ($self->{LENGTH} <= 0);
3989 ####################################################################################
3990 ################################## TEMPORARY FILES #################################
3991 ####################################################################################
3992 package CGITempFile;
3996 $MAC = $CGI::OS eq 'MACINTOSH';
3997 my ($vol) = $MAC ? MacPerl::Volumes() =~ /:(.*)/ : "";
3998 unless (defined $TMPDIRECTORY) {
3999 @TEMP=("${SL}usr${SL}tmp","${SL}var${SL}tmp",
4000 "C:${SL}temp","${SL}tmp","${SL}temp",
4001 "${vol}${SL}Temporary Items",
4002 "${SL}WWW_ROOT", "${SL}SYS\$SCRATCH",
4003 "C:${SL}system${SL}temp");
4004 unshift(@TEMP,$ENV{'TMPDIR'}) if defined $ENV{'TMPDIR'};
4006 # this feature was supposed to provide per-user tmpfiles, but
4007 # it is problematic.
4008 # unshift(@TEMP,(getpwuid($<))[7].'/tmp') if $CGI::OS eq 'UNIX';
4009 # Rob: getpwuid() is unfortunately UNIX specific. On brain dead OS'es this
4010 # : can generate a 'getpwuid() not implemented' exception, even though
4011 # : it's never called. Found under DOS/Win with the DJGPP perl port.
4012 # : Refer to getpwuid() only at run-time if we're fortunate and have UNIX.
4013 # unshift(@TEMP,(eval {(getpwuid($>))[7]}).'/tmp') if $CGI::OS eq 'UNIX' and $> != 0;
4016 do {$TMPDIRECTORY = $_; last} if -d $_ && -w _;
4019 $TMPDIRECTORY = $MAC ? "" : "." unless $TMPDIRECTORY;
4026 # cute feature, but overload implementation broke it
4027 # %OVERLOAD = ('""'=>'as_string');
4028 *CGITempFile::AUTOLOAD = \&CGI::AUTOLOAD;
4032 $$self =~ m!^([a-zA-Z0-9_ \'\":/.\$\\-]+)$! || return;
4033 my $safe = $1; # untaint operation
4034 unlink $safe; # get rid of the file
4037 ###############################################################################
4038 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
4039 ###############################################################################
4040 $AUTOLOADED_ROUTINES = ''; # prevent -w error
4041 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
4044 'new' => <<'END_OF_FUNC',
4046 my($package,$sequence) = @_;
4048 find_tempdir() unless -w $TMPDIRECTORY;
4049 for (my $i = 0; $i < $MAXTRIES; $i++) {
4050 last if ! -f ($filename = sprintf("\%s${SL}CGItemp%d", $TMPDIRECTORY, $sequence++));
4052 # check that it is a more-or-less valid filename
4053 return unless $filename =~ m!^([a-zA-Z0-9_\+ \'\":/.\$\\-]+)$!;
4054 # this used to untaint, now it doesn't
4056 return bless \$filename;
4060 'as_string' => <<'END_OF_FUNC'
4072 # We get a whole bunch of warnings about "possibly uninitialized variables"
4073 # when running with the -w switch. Touch them all once to get rid of the
4074 # warnings. This is ugly and I hate it.
4079 $MultipartBuffer::SPIN_LOOP_MAX;
4080 $MultipartBuffer::CRLF;
4081 $MultipartBuffer::TIMEOUT;
4082 $MultipartBuffer::INITIAL_FILLUNIT;
4093 CGI - Simple Common Gateway Interface Class
4097 # CGI script that creates a fill-out form
4098 # and echoes back its values.
4100 use CGI qw/:standard/;
4102 start_html('A Simple Example'),
4103 h1('A Simple Example'),
4105 "What's your name? ",textfield('name'),p,
4106 "What's the combination?", p,
4107 checkbox_group(-name=>'words',
4108 -values=>['eenie','meenie','minie','moe'],
4109 -defaults=>['eenie','minie']), p,
4110 "What's your favorite color? ",
4111 popup_menu(-name=>'color',
4112 -values=>['red','green','blue','chartreuse']),p,
4118 my $name = param('name');
4119 my $keywords = join ', ',param('words');
4120 my $color = param('color');
4121 print "Your name is",em(escapeHTML($name)),p,
4122 "The keywords are: ",em(escapeHTML($keywords)),p,
4123 "Your favorite color is ",em(escapeHTML($color)),
4131 This perl library uses perl5 objects to make it easy to create Web
4132 fill-out forms and parse their contents. This package defines CGI
4133 objects, entities that contain the values of the current query string
4134 and other state variables. Using a CGI object's methods, you can
4135 examine keywords and parameters passed to your script, and create
4136 forms whose initial values are taken from the current query (thereby
4137 preserving state information). The module provides shortcut functions
4138 that produce boilerplate HTML, reducing typing and coding errors. It
4139 also provides functionality for some of the more advanced features of
4140 CGI scripting, including support for file uploads, cookies, cascading
4141 style sheets, server push, and frames.
4143 CGI.pm also provides a simple function-oriented programming style for
4144 those who don't need its object-oriented features.
4146 The current version of CGI.pm is available at
4148 http://www.genome.wi.mit.edu/ftp/pub/software/WWW/cgi_docs.html
4149 ftp://ftp-genome.wi.mit.edu/pub/software/WWW/
4153 =head2 PROGRAMMING STYLE
4155 There are two styles of programming with CGI.pm, an object-oriented
4156 style and a function-oriented style. In the object-oriented style you
4157 create one or more CGI objects and then use object methods to create
4158 the various elements of the page. Each CGI object starts out with the
4159 list of named parameters that were passed to your CGI script by the
4160 server. You can modify the objects, save them to a file or database
4161 and recreate them. Because each object corresponds to the "state" of
4162 the CGI script, and because each object's parameter list is
4163 independent of the others, this allows you to save the state of the
4164 script and restore it later.
4166 For example, using the object oriented style, here is how you create
4167 a simple "Hello World" HTML page:
4169 #!/usr/local/bin/perl -w
4170 use CGI; # load CGI routines
4171 $q = new CGI; # create new CGI object
4172 print $q->header, # create the HTTP header
4173 $q->start_html('hello world'), # start the HTML
4174 $q->h1('hello world'), # level 1 header
4175 $q->end_html; # end the HTML
4177 In the function-oriented style, there is one default CGI object that
4178 you rarely deal with directly. Instead you just call functions to
4179 retrieve CGI parameters, create HTML tags, manage cookies, and so
4180 on. This provides you with a cleaner programming interface, but
4181 limits you to using one CGI object at a time. The following example
4182 prints the same page, but uses the function-oriented interface.
4183 The main differences are that we now need to import a set of functions
4184 into our name space (usually the "standard" functions), and we don't
4185 need to create the CGI object.
4187 #!/usr/local/bin/perl
4188 use CGI qw/:standard/; # load standard CGI routines
4189 print header, # create the HTTP header
4190 start_html('hello world'), # start the HTML
4191 h1('hello world'), # level 1 header
4192 end_html; # end the HTML
4194 The examples in this document mainly use the object-oriented style.
4195 See HOW TO IMPORT FUNCTIONS for important information on
4196 function-oriented programming in CGI.pm
4198 =head2 CALLING CGI.PM ROUTINES
4200 Most CGI.pm routines accept several arguments, sometimes as many as 20
4201 optional ones! To simplify this interface, all routines use a named
4202 argument calling style that looks like this:
4204 print $q->header(-type=>'image/gif',-expires=>'+3d');
4206 Each argument name is preceded by a dash. Neither case nor order
4207 matters in the argument list. -type, -Type, and -TYPE are all
4208 acceptable. In fact, only the first argument needs to begin with a
4209 dash. If a dash is present in the first argument, CGI.pm assumes
4210 dashes for the subsequent ones.
4212 Several routines are commonly called with just one argument. In the
4213 case of these routines you can provide the single argument without an
4214 argument name. header() happens to be one of these routines. In this
4215 case, the single argument is the document type.
4217 print $q->header('text/html');
4219 Other such routines are documented below.
4221 Sometimes named arguments expect a scalar, sometimes a reference to an
4222 array, and sometimes a reference to a hash. Often, you can pass any
4223 type of argument and the routine will do whatever is most appropriate.
4224 For example, the param() routine is used to set a CGI parameter to a
4225 single or a multi-valued value. The two cases are shown below:
4227 $q->param(-name=>'veggie',-value=>'tomato');
4228 $q->param(-name=>'veggie',-value=>['tomato','tomahto','potato','potahto']);
4230 A large number of routines in CGI.pm actually aren't specifically
4231 defined in the module, but are generated automatically as needed.
4232 These are the "HTML shortcuts," routines that generate HTML tags for
4233 use in dynamically-generated pages. HTML tags have both attributes
4234 (the attribute="value" pairs within the tag itself) and contents (the
4235 part between the opening and closing pairs.) To distinguish between
4236 attributes and contents, CGI.pm uses the convention of passing HTML
4237 attributes as a hash reference as the first argument, and the
4238 contents, if any, as any subsequent arguments. It works out like
4244 h1('some','contents'); <h1>some contents</h1>
4245 h1({-align=>left}); <h1 align="LEFT">
4246 h1({-align=>left},'contents'); <h1 align="LEFT">contents</h1>
4248 HTML tags are described in more detail later.
4250 Many newcomers to CGI.pm are puzzled by the difference between the
4251 calling conventions for the HTML shortcuts, which require curly braces
4252 around the HTML tag attributes, and the calling conventions for other
4253 routines, which manage to generate attributes without the curly
4254 brackets. Don't be confused. As a convenience the curly braces are
4255 optional in all but the HTML shortcuts. If you like, you can use
4256 curly braces when calling any routine that takes named arguments. For
4259 print $q->header( {-type=>'image/gif',-expires=>'+3d'} );
4261 If you use the B<-w> switch, you will be warned that some CGI.pm argument
4262 names conflict with built-in Perl functions. The most frequent of
4263 these is the -values argument, used to create multi-valued menus,
4264 radio button clusters and the like. To get around this warning, you
4265 have several choices:
4271 Use another name for the argument, if one is available.
4272 For example, -value is an alias for -values.
4276 Change the capitalization, e.g. -Values
4280 Put quotes around the argument name, e.g. '-values'
4284 Many routines will do something useful with a named argument that it
4285 doesn't recognize. For example, you can produce non-standard HTTP
4286 header fields by providing them as named arguments:
4288 print $q->header(-type => 'text/html',
4289 -cost => 'Three smackers',
4290 -annoyance_level => 'high',
4291 -complaints_to => 'bit bucket');
4293 This will produce the following nonstandard HTTP header:
4296 Cost: Three smackers
4297 Annoyance-level: high
4298 Complaints-to: bit bucket
4299 Content-type: text/html
4301 Notice the way that underscores are translated automatically into
4302 hyphens. HTML-generating routines perform a different type of
4305 This feature allows you to keep up with the rapidly changing HTTP and
4308 =head2 CREATING A NEW QUERY OBJECT (OBJECT-ORIENTED STYLE):
4312 This will parse the input (from both POST and GET methods) and store
4313 it into a perl5 object called $query.
4315 Any filehandles from file uploads will have their position reset to
4316 the beginning of the file.
4318 =head2 CREATING A NEW QUERY OBJECT FROM AN INPUT FILE
4320 $query = new CGI(INPUTFILE);
4322 If you provide a file handle to the new() method, it will read
4323 parameters from the file (or STDIN, or whatever). The file can be in
4324 any of the forms describing below under debugging (i.e. a series of
4325 newline delimited TAG=VALUE pairs will work). Conveniently, this type
4326 of file is created by the save() method (see below). Multiple records
4327 can be saved and restored.
4329 Perl purists will be pleased to know that this syntax accepts
4330 references to file handles, or even references to filehandle globs,
4331 which is the "official" way to pass a filehandle:
4333 $query = new CGI(\*STDIN);
4335 You can also initialize the CGI object with a FileHandle or IO::File
4338 If you are using the function-oriented interface and want to
4339 initialize CGI state from a file handle, the way to do this is with
4340 B<restore_parameters()>. This will (re)initialize the
4341 default CGI object from the indicated file handle.
4343 open (IN,"test.in") || die;
4344 restore_parameters(IN);
4347 You can also initialize the query object from an associative array
4350 $query = new CGI( {'dinosaur'=>'barney',
4351 'song'=>'I love you',
4352 'friends'=>[qw/Jessica George Nancy/]}
4355 or from a properly formatted, URL-escaped query string:
4357 $query = new CGI('dinosaur=barney&color=purple');
4359 or from a previously existing CGI object (currently this clones the
4360 parameter list, but none of the other object-specific fields, such as
4363 $old_query = new CGI;
4364 $new_query = new CGI($old_query);
4366 To create an empty query, initialize it from an empty string or hash:
4368 $empty_query = new CGI("");
4372 $empty_query = new CGI({});
4374 =head2 FETCHING A LIST OF KEYWORDS FROM THE QUERY:
4376 @keywords = $query->keywords
4378 If the script was invoked as the result of an <ISINDEX> search, the
4379 parsed keywords can be obtained as an array using the keywords() method.
4381 =head2 FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT:
4383 @names = $query->param
4385 If the script was invoked with a parameter list
4386 (e.g. "name1=value1&name2=value2&name3=value3"), the param() method
4387 will return the parameter names as a list. If the script was invoked
4388 as an <ISINDEX> script and contains a string without ampersands
4389 (e.g. "value1+value2+value3") , there will be a single parameter named
4390 "keywords" containing the "+"-delimited keywords.
4392 NOTE: As of version 1.5, the array of parameter names returned will
4393 be in the same order as they were submitted by the browser.
4394 Usually this order is the same as the order in which the
4395 parameters are defined in the form (however, this isn't part
4396 of the spec, and so isn't guaranteed).
4398 =head2 FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER:
4400 @values = $query->param('foo');
4404 $value = $query->param('foo');
4406 Pass the param() method a single argument to fetch the value of the
4407 named parameter. If the parameter is multivalued (e.g. from multiple
4408 selections in a scrolling list), you can ask to receive an array. Otherwise
4409 the method will return a single value.
4411 If a value is not given in the query string, as in the queries
4412 "name1=&name2=" or "name1&name2", it will be returned as an empty
4413 string. This feature is new in 2.63.
4416 If the parameter does not exist at all, then param() will return undef
4417 in a scalar context, and the empty list in a list context.
4420 =head2 SETTING THE VALUE(S) OF A NAMED PARAMETER:
4422 $query->param('foo','an','array','of','values');
4424 This sets the value for the named parameter 'foo' to an array of
4425 values. This is one way to change the value of a field AFTER
4426 the script has been invoked once before. (Another way is with
4427 the -override parameter accepted by all methods that generate
4430 param() also recognizes a named parameter style of calling described
4431 in more detail later:
4433 $query->param(-name=>'foo',-values=>['an','array','of','values']);
4437 $query->param(-name=>'foo',-value=>'the value');
4439 =head2 APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER:
4441 $query->append(-name=>'foo',-values=>['yet','more','values']);
4443 This adds a value or list of values to the named parameter. The
4444 values are appended to the end of the parameter if it already exists.
4445 Otherwise the parameter is created. Note that this method only
4446 recognizes the named argument calling syntax.
4448 =head2 IMPORTING ALL PARAMETERS INTO A NAMESPACE:
4450 $query->import_names('R');
4452 This creates a series of variables in the 'R' namespace. For example,
4453 $R::foo, @R:foo. For keyword lists, a variable @R::keywords will appear.
4454 If no namespace is given, this method will assume 'Q'.
4455 WARNING: don't import anything into 'main'; this is a major security
4458 NOTE 1: Variable names are transformed as necessary into legal Perl
4459 variable names. All non-legal characters are transformed into
4460 underscores. If you need to keep the original names, you should use
4461 the param() method instead to access CGI variables by name.
4463 NOTE 2: In older versions, this method was called B<import()>. As of version 2.20,
4464 this name has been removed completely to avoid conflict with the built-in
4465 Perl module B<import> operator.
4467 =head2 DELETING A PARAMETER COMPLETELY:
4469 $query->delete('foo','bar','baz');
4471 This completely clears a list of parameters. It sometimes useful for
4472 resetting parameters that you don't want passed down between script
4475 If you are using the function call interface, use "Delete()" instead
4476 to avoid conflicts with Perl's built-in delete operator.
4478 =head2 DELETING ALL PARAMETERS:
4480 $query->delete_all();
4482 This clears the CGI object completely. It might be useful to ensure
4483 that all the defaults are taken when you create a fill-out form.
4485 Use Delete_all() instead if you are using the function call interface.
4487 =head2 HANDLING NON-URLENCODED ARGUMENTS
4490 If POSTed data is not of type application/x-www-form-urlencoded or
4491 multipart/form-data, then the POSTed data will not be processed, but
4492 instead be returned as-is in a parameter named POSTDATA. To retrieve
4493 it, use code like this:
4495 my $data = $query->param('POSTDATA');
4497 Likewise if PUTed data can be retrieved with code like this:
4499 my $data = $query->param('PUTDATA');
4501 (If you don't know what the preceding means, don't worry about it. It
4502 only affects people trying to use CGI for XML processing and other
4506 =head2 DIRECT ACCESS TO THE PARAMETER LIST:
4508 $q->param_fetch('address')->[1] = '1313 Mockingbird Lane';
4509 unshift @{$q->param_fetch(-name=>'address')},'George Munster';
4511 If you need access to the parameter list in a way that isn't covered
4512 by the methods above, you can obtain a direct reference to it by
4513 calling the B<param_fetch()> method with the name of the . This
4514 will return an array reference to the named parameters, which you then
4515 can manipulate in any way you like.
4517 You can also use a named argument style using the B<-name> argument.
4519 =head2 FETCHING THE PARAMETER LIST AS A HASH:
4522 print $params->{'address'};
4523 @foo = split("\0",$params->{'foo'});
4529 Many people want to fetch the entire parameter list as a hash in which
4530 the keys are the names of the CGI parameters, and the values are the
4531 parameters' values. The Vars() method does this. Called in a scalar
4532 context, it returns the parameter list as a tied hash reference.
4533 Changing a key changes the value of the parameter in the underlying
4534 CGI parameter list. Called in a list context, it returns the
4535 parameter list as an ordinary hash. This allows you to read the
4536 contents of the parameter list, but not to change it.
4538 When using this, the thing you must watch out for are multivalued CGI
4539 parameters. Because a hash cannot distinguish between scalar and
4540 list context, multivalued parameters will be returned as a packed
4541 string, separated by the "\0" (null) character. You must split this
4542 packed string in order to get at the individual values. This is the
4543 convention introduced long ago by Steve Brenner in his cgi-lib.pl
4544 module for Perl version 4.
4546 If you wish to use Vars() as a function, import the I<:cgi-lib> set of
4547 function calls (also see the section on CGI-LIB compatibility).
4549 =head2 SAVING THE STATE OF THE SCRIPT TO A FILE:
4551 $query->save(\*FILEHANDLE)
4553 This will write the current state of the form to the provided
4554 filehandle. You can read it back in by providing a filehandle
4555 to the new() method. Note that the filehandle can be a file, a pipe,
4558 The format of the saved file is:
4566 Both name and value are URL escaped. Multi-valued CGI parameters are
4567 represented as repeated names. A session record is delimited by a
4568 single = symbol. You can write out multiple records and read them
4569 back in with several calls to B<new>. You can do this across several
4570 sessions by opening the file in append mode, allowing you to create
4571 primitive guest books, or to keep a history of users' queries. Here's
4572 a short example of creating multiple session records:
4576 open (OUT,">>test.out") || die;
4578 foreach (0..$records) {
4580 $q->param(-name=>'counter',-value=>$_);
4585 # reopen for reading
4586 open (IN,"test.out") || die;
4588 my $q = new CGI(\*IN);
4589 print $q->param('counter'),"\n";
4592 The file format used for save/restore is identical to that used by the
4593 Whitehead Genome Center's data exchange format "Boulderio", and can be
4594 manipulated and even databased using Boulderio utilities. See
4596 http://stein.cshl.org/boulder/
4598 for further details.
4600 If you wish to use this method from the function-oriented (non-OO)
4601 interface, the exported name for this method is B<save_parameters()>.
4603 =head2 RETRIEVING CGI ERRORS
4605 Errors can occur while processing user input, particularly when
4606 processing uploaded files. When these errors occur, CGI will stop
4607 processing and return an empty parameter list. You can test for
4608 the existence and nature of errors using the I<cgi_error()> function.
4609 The error messages are formatted as HTTP status codes. You can either
4610 incorporate the error text into an HTML page, or use it as the value
4613 my $error = $q->cgi_error;
4615 print $q->header(-status=>$error),
4616 $q->start_html('Problems'),
4617 $q->h2('Request not processed'),
4622 When using the function-oriented interface (see the next section),
4623 errors may only occur the first time you call I<param()>. Be ready
4626 =head2 USING THE FUNCTION-ORIENTED INTERFACE
4628 To use the function-oriented interface, you must specify which CGI.pm
4629 routines or sets of routines to import into your script's namespace.
4630 There is a small overhead associated with this importation, but it
4633 use CGI <list of methods>;
4635 The listed methods will be imported into the current package; you can
4636 call them directly without creating a CGI object first. This example
4637 shows how to import the B<param()> and B<header()>
4638 methods, and then use them directly:
4640 use CGI 'param','header';
4641 print header('text/plain');
4642 $zipcode = param('zipcode');
4644 More frequently, you'll import common sets of functions by referring
4645 to the groups by name. All function sets are preceded with a ":"
4646 character as in ":html3" (for tags defined in the HTML 3 standard).
4648 Here is a list of the function sets you can import:
4654 Import all CGI-handling methods, such as B<param()>, B<path_info()>
4659 Import all fill-out form generating methods, such as B<textfield()>.
4663 Import all methods that generate HTML 2.0 standard elements.
4667 Import all methods that generate HTML 3.0 elements (such as
4668 <table>, <super> and <sub>).
4672 Import all methods that generate HTML 4 elements (such as
4673 <abbrev>, <acronym> and <thead>).
4677 Import all methods that generate Netscape-specific HTML extensions.
4681 Import all HTML-generating shortcuts (i.e. 'html2' + 'html3' +
4686 Import "standard" features, 'html2', 'html3', 'html4', 'form' and 'cgi'.
4690 Import all the available methods. For the full list, see the CGI.pm
4691 code, where the variable %EXPORT_TAGS is defined.
4695 If you import a function name that is not part of CGI.pm, the module
4696 will treat it as a new HTML tag and generate the appropriate
4697 subroutine. You can then use it like any other HTML tag. This is to
4698 provide for the rapidly-evolving HTML "standard." For example, say
4699 Microsoft comes out with a new tag called <gradient> (which causes the
4700 user's desktop to be flooded with a rotating gradient fill until his
4701 machine reboots). You don't need to wait for a new version of CGI.pm
4702 to start using it immediately:
4704 use CGI qw/:standard :html3 gradient/;
4705 print gradient({-start=>'red',-end=>'blue'});
4707 Note that in the interests of execution speed CGI.pm does B<not> use
4708 the standard L<Exporter> syntax for specifying load symbols. This may
4709 change in the future.
4711 If you import any of the state-maintaining CGI or form-generating
4712 methods, a default CGI object will be created and initialized
4713 automatically the first time you use any of the methods that require
4714 one to be present. This includes B<param()>, B<textfield()>,
4715 B<submit()> and the like. (If you need direct access to the CGI
4716 object, you can find it in the global variable B<$CGI::Q>). By
4717 importing CGI.pm methods, you can create visually elegant scripts:
4719 use CGI qw/:standard/;
4722 start_html('Simple Script'),
4723 h1('Simple Script'),
4725 "What's your name? ",textfield('name'),p,
4726 "What's the combination?",
4727 checkbox_group(-name=>'words',
4728 -values=>['eenie','meenie','minie','moe'],
4729 -defaults=>['eenie','moe']),p,
4730 "What's your favorite color?",
4731 popup_menu(-name=>'color',
4732 -values=>['red','green','blue','chartreuse']),p,
4739 "Your name is ",em(param('name')),p,
4740 "The keywords are: ",em(join(", ",param('words'))),p,
4741 "Your favorite color is ",em(param('color')),".\n";
4747 In addition to the function sets, there are a number of pragmas that
4748 you can import. Pragmas, which are always preceded by a hyphen,
4749 change the way that CGI.pm functions in various ways. Pragmas,
4750 function sets, and individual functions can all be imported in the
4751 same use() line. For example, the following use statement imports the
4752 standard set of functions and enables debugging mode (pragma
4755 use CGI qw/:standard -debug/;
4757 The current list of pragmas is as follows:
4763 When you I<use CGI -any>, then any method that the query object
4764 doesn't recognize will be interpreted as a new HTML tag. This allows
4765 you to support the next I<ad hoc> Netscape or Microsoft HTML
4766 extension. This lets you go wild with new and unsupported tags:
4770 print $q->gradient({speed=>'fast',start=>'red',end=>'blue'});
4772 Since using <cite>any</cite> causes any mistyped method name
4773 to be interpreted as an HTML tag, use it with care or not at
4778 This causes the indicated autoloaded methods to be compiled up front,
4779 rather than deferred to later. This is useful for scripts that run
4780 for an extended period of time under FastCGI or mod_perl, and for
4781 those destined to be crunched by Malcolm Beattie's Perl compiler. Use
4782 it in conjunction with the methods or method families you plan to use.
4784 use CGI qw(-compile :standard :html3);
4788 use CGI qw(-compile :all);
4790 Note that using the -compile pragma in this way will always have
4791 the effect of importing the compiled functions into the current
4792 namespace. If you want to compile without importing use the
4793 compile() method instead:
4798 This is particularly useful in a mod_perl environment, in which you
4799 might want to precompile all CGI routines in a startup script, and
4800 then import the functions individually in each mod_perl script.
4804 By default the CGI module implements a state-preserving behavior
4805 called "sticky" fields. The way this works is that if you are
4806 regenerating a form, the methods that generate the form field values
4807 will interrogate param() to see if similarly-named parameters are
4808 present in the query string. If they find a like-named parameter, they
4809 will use it to set their default values.
4811 Sometimes this isn't what you want. The B<-nosticky> pragma prevents
4812 this behavior. You can also selectively change the sticky behavior in
4813 each element that you generate.
4817 Automatically add tab index attributes to each form field. With this
4818 option turned off, you can still add tab indexes manually by passing a
4819 -tabindex option to each field-generating method.
4821 =item -no_undef_params
4823 This keeps CGI.pm from including undef params in the parameter list.
4827 By default, CGI.pm versions 2.69 and higher emit XHTML
4828 (http://www.w3.org/TR/xhtml1/). The -no_xhtml pragma disables this
4829 feature. Thanks to Michalis Kabrianis <kabrianis@hellug.gr> for this
4832 If start_html()'s -dtd parameter specifies an HTML 2.0 or 3.2 DTD,
4833 XHTML will automatically be disabled without needing to use this
4838 This makes CGI.pm treat all parameters as UTF-8 strings. Use this with
4839 care, as it will interfere with the processing of binary uploads. It
4840 is better to manually select which fields are expected to return utf-8
4841 strings and convert them using code like this:
4844 my $arg = decode utf8=>param('foo');
4848 This makes CGI.pm produce a header appropriate for an NPH (no
4849 parsed header) script. You may need to do other things as well
4850 to tell the server that the script is NPH. See the discussion
4851 of NPH scripts below.
4853 =item -newstyle_urls
4855 Separate the name=value pairs in CGI parameter query strings with
4856 semicolons rather than ampersands. For example:
4858 ?name=fred;age=24;favorite_color=3
4860 Semicolon-delimited query strings are always accepted, but will not be
4861 emitted by self_url() and query_string() unless the -newstyle_urls
4862 pragma is specified.
4864 This became the default in version 2.64.
4866 =item -oldstyle_urls
4868 Separate the name=value pairs in CGI parameter query strings with
4869 ampersands rather than semicolons. This is no longer the default.
4873 This overrides the autoloader so that any function in your program
4874 that is not recognized is referred to CGI.pm for possible evaluation.
4875 This allows you to use all the CGI.pm functions without adding them to
4876 your symbol table, which is of concern for mod_perl users who are
4877 worried about memory consumption. I<Warning:> when
4878 I<-autoload> is in effect, you cannot use "poetry mode"
4879 (functions without the parenthesis). Use I<hr()> rather
4880 than I<hr>, or add something like I<use subs qw/hr p header/>
4881 to the top of your script.
4885 This turns off the command-line processing features. If you want to
4886 run a CGI.pm script from the command line to produce HTML, and you
4887 don't want it to read CGI parameters from the command line or STDIN,
4888 then use this pragma:
4890 use CGI qw(-no_debug :standard);
4894 This turns on full debugging. In addition to reading CGI arguments
4895 from the command-line processing, CGI.pm will pause and try to read
4896 arguments from STDIN, producing the message "(offline mode: enter
4897 name=value pairs on standard input)" features.
4899 See the section on debugging for more details.
4901 =item -private_tempfiles
4903 CGI.pm can process uploaded file. Ordinarily it spools the uploaded
4904 file to a temporary directory, then deletes the file when done.
4905 However, this opens the risk of eavesdropping as described in the file
4906 upload section. Another CGI script author could peek at this data
4907 during the upload, even if it is confidential information. On Unix
4908 systems, the -private_tempfiles pragma will cause the temporary file
4909 to be unlinked as soon as it is opened and before any data is written
4910 into it, reducing, but not eliminating the risk of eavesdropping
4911 (there is still a potential race condition). To make life harder for
4912 the attacker, the program chooses tempfile names by calculating a 32
4913 bit checksum of the incoming HTTP headers.
4915 To ensure that the temporary file cannot be read by other CGI scripts,
4916 use suEXEC or a CGI wrapper program to run your script. The temporary
4917 file is created with mode 0600 (neither world nor group readable).
4919 The temporary directory is selected using the following algorithm:
4921 1. if the current user (e.g. "nobody") has a directory named
4922 "tmp" in its home directory, use that (Unix systems only).
4924 2. if the environment variable TMPDIR exists, use the location
4927 3. Otherwise try the locations /usr/tmp, /var/tmp, C:\temp,
4928 /tmp, /temp, ::Temporary Items, and \WWW_ROOT.
4930 Each of these locations is checked that it is a directory and is
4931 writable. If not, the algorithm tries the next choice.
4935 =head2 SPECIAL FORMS FOR IMPORTING HTML-TAG FUNCTIONS
4937 Many of the methods generate HTML tags. As described below, tag
4938 functions automatically generate both the opening and closing tags.
4941 print h1('Level 1 Header');
4945 <h1>Level 1 Header</h1>
4947 There will be some times when you want to produce the start and end
4948 tags yourself. In this case, you can use the form start_I<tag_name>
4949 and end_I<tag_name>, as in:
4951 print start_h1,'Level 1 Header',end_h1;
4953 With a few exceptions (described below), start_I<tag_name> and
4954 end_I<tag_name> functions are not generated automatically when you
4955 I<use CGI>. However, you can specify the tags you want to generate
4956 I<start/end> functions for by putting an asterisk in front of their
4957 name, or, alternatively, requesting either "start_I<tag_name>" or
4958 "end_I<tag_name>" in the import list.
4962 use CGI qw/:standard *table start_ul/;
4964 In this example, the following functions are generated in addition to
4969 =item 1. start_table() (generates a <table> tag)
4971 =item 2. end_table() (generates a </table> tag)
4973 =item 3. start_ul() (generates a <ul> tag)
4975 =item 4. end_ul() (generates a </ul> tag)
4979 =head1 GENERATING DYNAMIC DOCUMENTS
4981 Most of CGI.pm's functions deal with creating documents on the fly.
4982 Generally you will produce the HTTP header first, followed by the
4983 document itself. CGI.pm provides functions for generating HTTP
4984 headers of various types as well as for generating HTML. For creating
4985 GIF images, see the GD.pm module.
4987 Each of these functions produces a fragment of HTML or HTTP which you
4988 can print out directly so that it displays in the browser window,
4989 append to a string, or save to a file for later use.
4991 =head2 CREATING A STANDARD HTTP HEADER:
4993 Normally the first thing you will do in any CGI script is print out an
4994 HTTP header. This tells the browser what type of document to expect,
4995 and gives other optional information, such as the language, expiration
4996 date, and whether to cache the document. The header can also be
4997 manipulated for special purposes, such as server push and pay per view
5004 print header('image/gif');
5008 print header('text/html','204 No response');
5012 print header(-type=>'image/gif',
5014 -status=>'402 Payment required',
5018 -attachment=>'foo.gif',
5021 header() returns the Content-type: header. You can provide your own
5022 MIME type if you choose, otherwise it defaults to text/html. An
5023 optional second parameter specifies the status code and a human-readable
5024 message. For example, you can specify 204, "No response" to create a
5025 script that tells the browser to do nothing at all.
5027 The last example shows the named argument style for passing arguments
5028 to the CGI methods using named parameters. Recognized parameters are
5029 B<-type>, B<-status>, B<-expires>, and B<-cookie>. Any other named
5030 parameters will be stripped of their initial hyphens and turned into
5031 header fields, allowing you to specify any HTTP header you desire.
5032 Internal underscores will be turned into hyphens:
5034 print header(-Content_length=>3002);
5036 Most browsers will not cache the output from CGI scripts. Every time
5037 the browser reloads the page, the script is invoked anew. You can
5038 change this behavior with the B<-expires> parameter. When you specify
5039 an absolute or relative expiration interval with this parameter, some
5040 browsers and proxy servers will cache the script's output until the
5041 indicated expiration date. The following forms are all valid for the
5044 +30s 30 seconds from now
5045 +10m ten minutes from now
5046 +1h one hour from now
5047 -1d yesterday (i.e. "ASAP!")
5050 +10y in ten years time
5051 Thursday, 25-Apr-1999 00:40:33 GMT at the indicated time & date
5053 The B<-cookie> parameter generates a header that tells the browser to provide
5054 a "magic cookie" during all subsequent transactions with your script.
5055 Netscape cookies have a special format that includes interesting attributes
5056 such as expiration time. Use the cookie() method to create and retrieve
5059 The B<-nph> parameter, if set to a true value, will issue the correct
5060 headers to work with a NPH (no-parse-header) script. This is important
5061 to use with certain servers that expect all their scripts to be NPH.
5063 The B<-charset> parameter can be used to control the character set
5064 sent to the browser. If not provided, defaults to ISO-8859-1. As a
5065 side effect, this sets the charset() method as well.
5067 The B<-attachment> parameter can be used to turn the page into an
5068 attachment. Instead of displaying the page, some browsers will prompt
5069 the user to save it to disk. The value of the argument is the
5070 suggested name for the saved file. In order for this to work, you may
5071 have to set the B<-type> to "application/octet-stream".
5073 The B<-p3p> parameter will add a P3P tag to the outgoing header. The
5074 parameter can be an arrayref or a space-delimited string of P3P tags.
5077 print header(-p3p=>[qw(CAO DSP LAW CURa)]);
5078 print header(-p3p=>'CAO DSP LAW CURa');
5080 In either case, the outgoing header will be formatted as:
5082 P3P: policyref="/w3c/p3p.xml" cp="CAO DSP LAW CURa"
5084 =head2 GENERATING A REDIRECTION HEADER
5086 print redirect('http://somewhere.else/in/movie/land');
5088 Sometimes you don't want to produce a document yourself, but simply
5089 redirect the browser elsewhere, perhaps choosing a URL based on the
5090 time of day or the identity of the user.
5092 The redirect() function redirects the browser to a different URL. If
5093 you use redirection like this, you should B<not> print out a header as
5096 You should always use full URLs (including the http: or ftp: part) in
5097 redirection requests. Relative URLs will not work correctly.
5099 You can also use named arguments:
5101 print redirect(-uri=>'http://somewhere.else/in/movie/land',
5105 The B<-nph> parameter, if set to a true value, will issue the correct
5106 headers to work with a NPH (no-parse-header) script. This is important
5107 to use with certain servers, such as Microsoft IIS, which
5108 expect all their scripts to be NPH.
5110 The B<-status> parameter will set the status of the redirect. HTTP
5111 defines three different possible redirection status codes:
5113 301 Moved Permanently
5117 The default if not specified is 302, which means "moved temporarily."
5118 You may change the status to another status code if you wish. Be
5119 advised that changing the status to anything other than 301, 302 or
5120 303 will probably break redirection.
5122 =head2 CREATING THE HTML DOCUMENT HEADER
5124 print start_html(-title=>'Secrets of the Pyramids',
5125 -author=>'fred@capricorn.org',
5128 -meta=>{'keywords'=>'pharaoh secret mummy',
5129 'copyright'=>'copyright 1996 King Tut'},
5130 -style=>{'src'=>'/styles/style1.css'},
5133 After creating the HTTP header, most CGI scripts will start writing
5134 out an HTML document. The start_html() routine creates the top of the
5135 page, along with a lot of optional information that controls the
5136 page's appearance and behavior.
5138 This method returns a canned HTML header and the opening <body> tag.
5139 All parameters are optional. In the named parameter form, recognized
5140 parameters are -title, -author, -base, -xbase, -dtd, -lang and -target
5141 (see below for the explanation). Any additional parameters you
5142 provide, such as the Netscape unofficial BGCOLOR attribute, are added
5143 to the <body> tag. Additional parameters must be proceeded by a
5146 The argument B<-xbase> allows you to provide an HREF for the <base> tag
5147 different from the current location, as in
5149 -xbase=>"http://home.mcom.com/"
5151 All relative links will be interpreted relative to this tag.
5153 The argument B<-target> allows you to provide a default target frame
5154 for all the links and fill-out forms on the page. B<This is a
5155 non-standard HTTP feature which only works with Netscape browsers!>
5156 See the Netscape documentation on frames for details of how to
5159 -target=>"answer_window"
5161 All relative links will be interpreted relative to this tag.
5162 You add arbitrary meta information to the header with the B<-meta>
5163 argument. This argument expects a reference to an associative array
5164 containing name/value pairs of meta information. These will be turned
5165 into a series of header <meta> tags that look something like this:
5167 <meta name="keywords" content="pharaoh secret mummy">
5168 <meta name="description" content="copyright 1996 King Tut">
5170 To create an HTTP-EQUIV type of <meta> tag, use B<-head>, described
5173 The B<-style> argument is used to incorporate cascading stylesheets
5174 into your code. See the section on CASCADING STYLESHEETS for more
5177 The B<-lang> argument is used to incorporate a language attribute into
5178 the <html> tag. For example:
5180 print $q->start_html(-lang=>'fr-CA');
5182 The default if not specified is "en-US" for US English, unless the
5183 -dtd parameter specifies an HTML 2.0 or 3.2 DTD, in which case the
5184 lang attribute is left off. You can force the lang attribute to left
5185 off in other cases by passing an empty string (-lang=>'').
5187 The B<-encoding> argument can be used to specify the character set for
5188 XHTML. It defaults to iso-8859-1 if not specified.
5190 The B<-declare_xml> argument, when used in conjunction with XHTML,
5191 will put a <?xml> declaration at the top of the HTML header. The sole
5192 purpose of this declaration is to declare the character set
5193 encoding. In the absence of -declare_xml, the output HTML will contain
5194 a <meta> tag that specifies the encoding, allowing the HTML to pass
5195 most validators. The default for -declare_xml is false.
5197 You can place other arbitrary HTML elements to the <head> section with the
5198 B<-head> tag. For example, to place the rarely-used <link> element in the
5199 head section, use this:
5201 print start_html(-head=>Link({-rel=>'next',
5202 -href=>'http://www.capricorn.com/s2.html'}));
5204 To incorporate multiple HTML elements into the <head> section, just pass an
5207 print start_html(-head=>[
5209 -href=>'http://www.capricorn.com/s2.html'}),
5210 Link({-rel=>'previous',
5211 -href=>'http://www.capricorn.com/s1.html'})
5215 And here's how to create an HTTP-EQUIV <meta> tag:
5217 print start_html(-head=>meta({-http_equiv => 'Content-Type',
5218 -content => 'text/html'}))
5221 JAVASCRIPTING: The B<-script>, B<-noScript>, B<-onLoad>,
5222 B<-onMouseOver>, B<-onMouseOut> and B<-onUnload> parameters are used
5223 to add Netscape JavaScript calls to your pages. B<-script> should
5224 point to a block of text containing JavaScript function definitions.
5225 This block will be placed within a <script> block inside the HTML (not
5226 HTTP) header. The block is placed in the header in order to give your
5227 page a fighting chance of having all its JavaScript functions in place
5228 even if the user presses the stop button before the page has loaded
5229 completely. CGI.pm attempts to format the script in such a way that
5230 JavaScript-naive browsers will not choke on the code: unfortunately
5231 there are some browsers, such as Chimera for Unix, that get confused
5234 The B<-onLoad> and B<-onUnload> parameters point to fragments of JavaScript
5235 code to execute when the page is respectively opened and closed by the
5236 browser. Usually these parameters are calls to functions defined in the
5242 // Ask a silly question
5243 function riddle_me_this() {
5244 var r = prompt("What walks on four legs in the morning, " +
5245 "two legs in the afternoon, " +
5246 "and three legs in the evening?");
5249 // Get a silly answer
5250 function response(answer) {
5251 if (answer == "man")
5252 alert("Right you are!");
5254 alert("Wrong! Guess again.");
5257 print start_html(-title=>'The Riddle of the Sphinx',
5260 Use the B<-noScript> parameter to pass some HTML text that will be displayed on
5261 browsers that do not have JavaScript (or browsers where JavaScript is turned
5264 The <script> tag, has several attributes including "type" and src.
5265 The latter is particularly interesting, as it allows you to keep the
5266 JavaScript code in a file or CGI script rather than cluttering up each
5267 page with the source. To use these attributes pass a HASH reference
5268 in the B<-script> parameter containing one or more of -type, -src, or
5271 print $q->start_html(-title=>'The Riddle of the Sphinx',
5272 -script=>{-type=>'JAVASCRIPT',
5273 -src=>'/javascript/sphinx.js'}
5276 print $q->(-title=>'The Riddle of the Sphinx',
5277 -script=>{-type=>'PERLSCRIPT',
5278 -code=>'print "hello world!\n;"'}
5282 A final feature allows you to incorporate multiple <script> sections into the
5283 header. Just pass the list of script sections as an array reference.
5284 this allows you to specify different source files for different dialects
5285 of JavaScript. Example:
5287 print $q->start_html(-title=>'The Riddle of the Sphinx',
5289 { -type => 'text/javascript',
5290 -src => '/javascript/utilities10.js'
5292 { -type => 'text/javascript',
5293 -src => '/javascript/utilities11.js'
5295 { -type => 'text/jscript',
5296 -src => '/javascript/utilities12.js'
5298 { -type => 'text/ecmascript',
5299 -src => '/javascript/utilities219.js'
5304 The option "-language" is a synonym for -type, and is supported for
5305 backwad compatibility.
5307 The old-style positional parameters are as follows:
5311 =item B<Parameters:>
5319 The author's e-mail address (will create a <link rev="MADE"> tag if present
5323 A 'true' flag if you want to include a <base> tag in the header. This
5324 helps resolve relative addresses to absolute ones when the document is moved,
5325 but makes the document hierarchy non-portable. Use with care!
5329 Any other parameters you want to include in the <body> tag. This is a good
5330 place to put Netscape extensions, such as colors and wallpaper patterns.
5334 =head2 ENDING THE HTML DOCUMENT:
5338 This ends an HTML document by printing the </body></html> tags.
5340 =head2 CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION:
5343 print q(<a href="$myself">I'm talking to myself.</a>);
5345 self_url() will return a URL, that, when selected, will reinvoke
5346 this script with all its state information intact. This is most
5347 useful when you want to jump around within the document using
5348 internal anchors but you don't want to disrupt the current contents
5349 of the form(s). Something like this will do the trick.
5352 print "<a href=\"$myself#table1\">See table 1</a>";
5353 print "<a href=\"$myself#table2\">See table 2</a>";
5354 print "<a href=\"$myself#yourself\">See for yourself</a>";
5356 If you want more control over what's returned, using the B<url()>
5359 You can also retrieve the unprocessed query string with query_string():
5361 $the_string = query_string;
5363 =head2 OBTAINING THE SCRIPT'S URL
5366 $full_url = url(-full=>1); #alternative syntax
5367 $relative_url = url(-relative=>1);
5368 $absolute_url = url(-absolute=>1);
5369 $url_with_path = url(-path_info=>1);
5370 $url_with_path_and_query = url(-path_info=>1,-query=>1);
5371 $netloc = url(-base => 1);
5373 B<url()> returns the script's URL in a variety of formats. Called
5374 without any arguments, it returns the full form of the URL, including
5375 host name and port number
5377 http://your.host.com/path/to/script.cgi
5379 You can modify this format with the following named arguments:
5385 If true, produce an absolute URL, e.g.
5391 Produce a relative URL. This is useful if you want to reinvoke your
5392 script with different parameters. For example:
5398 Produce the full URL, exactly as if called without any arguments.
5399 This overrides the -relative and -absolute arguments.
5401 =item B<-path> (B<-path_info>)
5403 Append the additional path information to the URL. This can be
5404 combined with B<-full>, B<-absolute> or B<-relative>. B<-path_info>
5405 is provided as a synonym.
5407 =item B<-query> (B<-query_string>)
5409 Append the query string to the URL. This can be combined with
5410 B<-full>, B<-absolute> or B<-relative>. B<-query_string> is provided
5415 Generate just the protocol and net location, as in http://www.foo.com:8000
5419 If Apache's mod_rewrite is turned on, then the script name and path
5420 info probably won't match the request that the user sent. Set
5421 -rewrite=>1 (default) to return URLs that match what the user sent
5422 (the original request URI). Set -rewrite=>0 to return URLs that match
5423 the URL after mod_rewrite's rules have run. Because the additional
5424 path information only makes sense in the context of the rewritten URL,
5425 -rewrite is set to false when you request path info in the URL.
5429 =head2 MIXING POST AND URL PARAMETERS
5431 $color = url_param('color');
5433 It is possible for a script to receive CGI parameters in the URL as
5434 well as in the fill-out form by creating a form that POSTs to a URL
5435 containing a query string (a "?" mark followed by arguments). The
5436 B<param()> method will always return the contents of the POSTed
5437 fill-out form, ignoring the URL's query string. To retrieve URL
5438 parameters, call the B<url_param()> method. Use it in the same way as
5439 B<param()>. The main difference is that it allows you to read the
5440 parameters, but not set them.
5443 Under no circumstances will the contents of the URL query string
5444 interfere with similarly-named CGI parameters in POSTed forms. If you
5445 try to mix a URL query string with a form submitted with the GET
5446 method, the results will not be what you expect.
5448 =head1 CREATING STANDARD HTML ELEMENTS:
5450 CGI.pm defines general HTML shortcut methods for most, if not all of
5451 the HTML 3 and HTML 4 tags. HTML shortcuts are named after a single
5452 HTML element and return a fragment of HTML text that you can then
5453 print or manipulate as you like. Each shortcut returns a fragment of
5454 HTML code that you can append to a string, save to a file, or, most
5455 commonly, print out so that it displays in the browser window.
5457 This example shows how to use the HTML methods:
5459 print $q->blockquote(
5460 "Many years ago on the island of",
5461 $q->a({href=>"http://crete.org/"},"Crete"),
5462 "there lived a Minotaur named",
5463 $q->strong("Fred."),
5467 This results in the following HTML code (extra newlines have been
5468 added for readability):
5471 Many years ago on the island of
5472 <a href="http://crete.org/">Crete</a> there lived
5473 a minotaur named <strong>Fred.</strong>
5477 If you find the syntax for calling the HTML shortcuts awkward, you can
5478 import them into your namespace and dispense with the object syntax
5479 completely (see the next section for more details):
5481 use CGI ':standard';
5483 "Many years ago on the island of",
5484 a({href=>"http://crete.org/"},"Crete"),
5485 "there lived a minotaur named",
5490 =head2 PROVIDING ARGUMENTS TO HTML SHORTCUTS
5492 The HTML methods will accept zero, one or multiple arguments. If you
5493 provide no arguments, you get a single tag:
5497 If you provide one or more string arguments, they are concatenated
5498 together with spaces and placed between opening and closing tags:
5500 print h1("Chapter","1"); # <h1>Chapter 1</h1>"
5502 If the first argument is an associative array reference, then the keys
5503 and values of the associative array become the HTML tag's attributes:
5505 print a({-href=>'fred.html',-target=>'_new'},
5506 "Open a new frame");
5508 <a href="fred.html",target="_new">Open a new frame</a>
5510 You may dispense with the dashes in front of the attribute names if
5513 print img {src=>'fred.gif',align=>'LEFT'};
5515 <img align="LEFT" src="fred.gif">
5517 Sometimes an HTML tag attribute has no argument. For example, ordered
5518 lists can be marked as COMPACT. The syntax for this is an argument that
5519 that points to an undef string:
5521 print ol({compact=>undef},li('one'),li('two'),li('three'));
5523 Prior to CGI.pm version 2.41, providing an empty ('') string as an
5524 attribute argument was the same as providing undef. However, this has
5525 changed in order to accommodate those who want to create tags of the form
5526 <img alt="">. The difference is shown in these two pieces of code:
5529 img({alt=>undef}) <img alt>
5530 img({alt=>''}) <img alt="">
5532 =head2 THE DISTRIBUTIVE PROPERTY OF HTML SHORTCUTS
5534 One of the cool features of the HTML shortcuts is that they are
5535 distributive. If you give them an argument consisting of a
5536 B<reference> to a list, the tag will be distributed across each
5537 element of the list. For example, here's one way to make an ordered
5541 li({-type=>'disc'},['Sneezy','Doc','Sleepy','Happy'])
5544 This example will result in HTML output that looks like this:
5547 <li type="disc">Sneezy</li>
5548 <li type="disc">Doc</li>
5549 <li type="disc">Sleepy</li>
5550 <li type="disc">Happy</li>
5553 This is extremely useful for creating tables. For example:
5555 print table({-border=>undef},
5556 caption('When Should You Eat Your Vegetables?'),
5557 Tr({-align=>CENTER,-valign=>TOP},
5559 th(['Vegetable', 'Breakfast','Lunch','Dinner']),
5560 td(['Tomatoes' , 'no', 'yes', 'yes']),
5561 td(['Broccoli' , 'no', 'no', 'yes']),
5562 td(['Onions' , 'yes','yes', 'yes'])
5567 =head2 HTML SHORTCUTS AND LIST INTERPOLATION
5569 Consider this bit of code:
5571 print blockquote(em('Hi'),'mom!'));
5573 It will ordinarily return the string that you probably expect, namely:
5575 <blockquote><em>Hi</em> mom!</blockquote>
5577 Note the space between the element "Hi" and the element "mom!".
5578 CGI.pm puts the extra space there using array interpolation, which is
5579 controlled by the magic $" variable. Sometimes this extra space is
5580 not what you want, for example, when you are trying to align a series
5581 of images. In this case, you can simply change the value of $" to an
5586 print blockquote(em('Hi'),'mom!'));
5589 I suggest you put the code in a block as shown here. Otherwise the
5590 change to $" will affect all subsequent code until you explicitly
5593 =head2 NON-STANDARD HTML SHORTCUTS
5595 A few HTML tags don't follow the standard pattern for various
5598 B<comment()> generates an HTML comment (<!-- comment -->). Call it
5601 print comment('here is my comment');
5603 Because of conflicts with built-in Perl functions, the following functions
5604 begin with initial caps:
5613 In addition, start_html(), end_html(), start_form(), end_form(),
5614 start_multipart_form() and all the fill-out form tags are special.
5615 See their respective sections.
5617 =head2 AUTOESCAPING HTML
5619 By default, all HTML that is emitted by the form-generating functions
5620 is passed through a function called escapeHTML():
5624 =item $escaped_string = escapeHTML("unescaped string");
5626 Escape HTML formatting characters in a string.
5630 Provided that you have specified a character set of ISO-8859-1 (the
5631 default), the standard HTML escaping rules will be used. The "<"
5632 character becomes "<", ">" becomes ">", "&" becomes "&", and
5633 the quote character becomes """. In addition, the hexadecimal
5634 0x8b and 0x9b characters, which some browsers incorrectly interpret
5635 as the left and right angle-bracket characters, are replaced by their
5636 numeric character entities ("‹" and "›"). If you manually change
5637 the charset, either by calling the charset() method explicitly or by
5638 passing a -charset argument to header(), then B<all> characters will
5639 be replaced by their numeric entities, since CGI.pm has no lookup
5640 table for all the possible encodings.
5642 The automatic escaping does not apply to other shortcuts, such as
5643 h1(). You should call escapeHTML() yourself on untrusted data in
5644 order to protect your pages against nasty tricks that people may enter
5645 into guestbooks, etc.. To change the character set, use charset().
5646 To turn autoescaping off completely, use autoEscape(0):
5650 =item $charset = charset([$charset]);
5652 Get or set the current character set.
5654 =item $flag = autoEscape([$flag]);
5656 Get or set the value of the autoescape flag.
5660 =head2 PRETTY-PRINTING HTML
5662 By default, all the HTML produced by these functions comes out as one
5663 long line without carriage returns or indentation. This is yuck, but
5664 it does reduce the size of the documents by 10-20%. To get
5665 pretty-printed output, please use L<CGI::Pretty>, a subclass
5666 contributed by Brian Paulsen.
5668 =head1 CREATING FILL-OUT FORMS:
5670 I<General note> The various form-creating methods all return strings
5671 to the caller, containing the tag or tags that will create the requested
5672 form element. You are responsible for actually printing out these strings.
5673 It's set up this way so that you can place formatting tags
5674 around the form elements.
5676 I<Another note> The default values that you specify for the forms are only
5677 used the B<first> time the script is invoked (when there is no query
5678 string). On subsequent invocations of the script (when there is a query
5679 string), the former values are used even if they are blank.
5681 If you want to change the value of a field from its previous value, you have two
5684 (1) call the param() method to set it.
5686 (2) use the -override (alias -force) parameter (a new feature in version 2.15).
5687 This forces the default value to be used, regardless of the previous value:
5689 print textfield(-name=>'field_name',
5690 -default=>'starting value',
5695 I<Yet another note> By default, the text and labels of form elements are
5696 escaped according to HTML rules. This means that you can safely use
5697 "<CLICK ME>" as the label for a button. However, it also interferes with
5698 your ability to incorporate special HTML character sequences, such as Á,
5699 into your fields. If you wish to turn off automatic escaping, call the
5700 autoEscape() method with a false value immediately after creating the CGI object:
5705 I<A Lurking Trap!> Some of the form-element generating methods return
5706 multiple tags. In a scalar context, the tags will be concatenated
5707 together with spaces, or whatever is the current value of the $"
5708 global. In a list context, the methods will return a list of
5709 elements, allowing you to modify them if you wish. Usually you will
5710 not notice this behavior, but beware of this:
5712 printf("%s\n",end_form())
5714 end_form() produces several tags, and only the first of them will be
5715 printed because the format only expects one value.
5720 =head2 CREATING AN ISINDEX TAG
5722 print isindex(-action=>$action);
5726 print isindex($action);
5728 Prints out an <isindex> tag. Not very exciting. The parameter
5729 -action specifies the URL of the script to process the query. The
5730 default is to process the query with the current script.
5732 =head2 STARTING AND ENDING A FORM
5734 print start_form(-method=>$method,
5736 -enctype=>$encoding);
5737 <... various form stuff ...>
5742 print start_form($method,$action,$encoding);
5743 <... various form stuff ...>
5746 start_form() will return a <form> tag with the optional method,
5747 action and form encoding that you specify. The defaults are:
5751 enctype: application/x-www-form-urlencoded
5753 endform() returns the closing </form> tag.
5755 Start_form()'s enctype argument tells the browser how to package the various
5756 fields of the form before sending the form to the server. Two
5757 values are possible:
5759 B<Note:> This method was previously named startform(), and startform()
5760 is still recognized as an alias.
5764 =item B<application/x-www-form-urlencoded>
5766 This is the older type of encoding used by all browsers prior to
5767 Netscape 2.0. It is compatible with many CGI scripts and is
5768 suitable for short fields containing text data. For your
5769 convenience, CGI.pm stores the name of this encoding
5770 type in B<&CGI::URL_ENCODED>.
5772 =item B<multipart/form-data>
5774 This is the newer type of encoding introduced by Netscape 2.0.
5775 It is suitable for forms that contain very large fields or that
5776 are intended for transferring binary data. Most importantly,
5777 it enables the "file upload" feature of Netscape 2.0 forms. For
5778 your convenience, CGI.pm stores the name of this encoding type
5779 in B<&CGI::MULTIPART>
5781 Forms that use this type of encoding are not easily interpreted
5782 by CGI scripts unless they use CGI.pm or another library designed
5785 If XHTML is activated (the default), then forms will be automatically
5786 created using this type of encoding.
5790 For compatibility, the start_form() method uses the older form of
5791 encoding by default. If you want to use the newer form of encoding
5792 by default, you can call B<start_multipart_form()> instead of
5795 JAVASCRIPTING: The B<-name> and B<-onSubmit> parameters are provided
5796 for use with JavaScript. The -name parameter gives the
5797 form a name so that it can be identified and manipulated by
5798 JavaScript functions. -onSubmit should point to a JavaScript
5799 function that will be executed just before the form is submitted to your
5800 server. You can use this opportunity to check the contents of the form
5801 for consistency and completeness. If you find something wrong, you
5802 can put up an alert box or maybe fix things up yourself. You can
5803 abort the submission by returning false from this function.
5805 Usually the bulk of JavaScript functions are defined in a <script>
5806 block in the HTML header and -onSubmit points to one of these function
5807 call. See start_html() for details.
5809 =head2 FORM ELEMENTS
5811 After starting a form, you will typically create one or more
5812 textfields, popup menus, radio groups and other form elements. Each
5813 of these elements takes a standard set of named arguments. Some
5814 elements also have optional arguments. The standard arguments are as
5821 The name of the field. After submission this name can be used to
5822 retrieve the field's value using the param() method.
5824 =item B<-value>, B<-values>
5826 The initial value of the field which will be returned to the script
5827 after form submission. Some form elements, such as text fields, take
5828 a single scalar -value argument. Others, such as popup menus, take a
5829 reference to an array of values. The two arguments are synonyms.
5833 A numeric value that sets the order in which the form element receives
5834 focus when the user presses the tab key. Elements with lower values
5835 receive focus first.
5839 A string identifier that can be used to identify this element to
5840 JavaScript and DHTML.
5844 A boolean, which, if true, forces the element to take on the value
5845 specified by B<-value>, overriding the sticky behavior described
5846 earlier for the B<-no_sticky> pragma.
5848 =item B<-onChange>, B<-onFocus>, B<-onBlur>, B<-onMouseOver>, B<-onMouseOut>, B<-onSelect>
5850 These are used to assign JavaScript event handlers. See the
5851 JavaScripting section for more details.
5855 Other common arguments are described in the next section. In addition
5856 to these, all attributes described in the HTML specifications are
5859 =head2 CREATING A TEXT FIELD
5861 print textfield(-name=>'field_name',
5862 -value=>'starting value',
5867 print textfield('field_name','starting value',50,80);
5869 textfield() will return a text input field.
5877 The first parameter is the required name for the field (-name).
5881 The optional second parameter is the default starting value for the field
5882 contents (-value, formerly known as -default).
5886 The optional third parameter is the size of the field in
5891 The optional fourth parameter is the maximum number of characters the
5892 field will accept (-maxlength).
5896 As with all these methods, the field will be initialized with its
5897 previous contents from earlier invocations of the script.
5898 When the form is processed, the value of the text field can be
5901 $value = param('foo');
5903 If you want to reset it from its initial value after the script has been
5904 called once, you can do so like this:
5906 param('foo',"I'm taking over this value!");
5908 =head2 CREATING A BIG TEXT FIELD
5910 print textarea(-name=>'foo',
5911 -default=>'starting value',
5917 print textarea('foo','starting value',10,50);
5919 textarea() is just like textfield, but it allows you to specify
5920 rows and columns for a multiline text entry box. You can provide
5921 a starting value for the field, which can be long and contain
5924 =head2 CREATING A PASSWORD FIELD
5926 print password_field(-name=>'secret',
5927 -value=>'starting value',
5932 print password_field('secret','starting value',50,80);
5934 password_field() is identical to textfield(), except that its contents
5935 will be starred out on the web page.
5937 =head2 CREATING A FILE UPLOAD FIELD
5939 print filefield(-name=>'uploaded_file',
5940 -default=>'starting value',
5945 print filefield('uploaded_file','starting value',50,80);
5947 filefield() will return a file upload field for Netscape 2.0 browsers.
5948 In order to take full advantage of this I<you must use the new
5949 multipart encoding scheme> for the form. You can do this either
5950 by calling B<start_form()> with an encoding type of B<&CGI::MULTIPART>,
5951 or by calling the new method B<start_multipart_form()> instead of
5952 vanilla B<start_form()>.
5960 The first parameter is the required name for the field (-name).
5964 The optional second parameter is the starting value for the field contents
5965 to be used as the default file name (-default).
5967 For security reasons, browsers don't pay any attention to this field,
5968 and so the starting value will always be blank. Worse, the field
5969 loses its "sticky" behavior and forgets its previous contents. The
5970 starting value field is called for in the HTML specification, however,
5971 and possibly some browser will eventually provide support for it.
5975 The optional third parameter is the size of the field in
5980 The optional fourth parameter is the maximum number of characters the
5981 field will accept (-maxlength).
5985 When the form is processed, you can retrieve the entered filename
5988 $filename = param('uploaded_file');
5990 Different browsers will return slightly different things for the
5991 name. Some browsers return the filename only. Others return the full
5992 path to the file, using the path conventions of the user's machine.
5993 Regardless, the name returned is always the name of the file on the
5994 I<user's> machine, and is unrelated to the name of the temporary file
5995 that CGI.pm creates during upload spooling (see below).
5997 The filename returned is also a file handle. You can read the contents
5998 of the file using standard Perl file reading calls:
6000 # Read a text file and print it out
6001 while (<$filename>) {
6005 # Copy a binary file to somewhere safe
6006 open (OUTFILE,">>/usr/local/web/users/feedback");
6007 while ($bytesread=read($filename,$buffer,1024)) {
6008 print OUTFILE $buffer;
6011 However, there are problems with the dual nature of the upload fields.
6012 If you C<use strict>, then Perl will complain when you try to use a
6013 string as a filehandle. You can get around this by placing the file
6014 reading code in a block containing the C<no strict> pragma. More
6015 seriously, it is possible for the remote user to type garbage into the
6016 upload field, in which case what you get from param() is not a
6017 filehandle at all, but a string.
6019 To be safe, use the I<upload()> function (new in version 2.47). When
6020 called with the name of an upload field, I<upload()> returns a
6021 filehandle, or undef if the parameter is not a valid filehandle.
6023 $fh = upload('uploaded_file');
6028 In an list context, upload() will return an array of filehandles.
6029 This makes it possible to create forms that use the same name for
6030 multiple upload fields.
6032 This is the recommended idiom.
6034 For robust code, consider reseting the file handle position to beginning of the
6035 file. Inside of larger frameworks, other code may have already used the query
6036 object and changed the filehandle postion:
6038 seek($fh,0,0); # reset postion to beginning of file.
6040 When a file is uploaded the browser usually sends along some
6041 information along with it in the format of headers. The information
6042 usually includes the MIME content type. Future browsers may send
6043 other information as well (such as modification date and size). To
6044 retrieve this information, call uploadInfo(). It returns a reference to
6045 an associative array containing all the document headers.
6047 $filename = param('uploaded_file');
6048 $type = uploadInfo($filename)->{'Content-Type'};
6049 unless ($type eq 'text/html') {
6050 die "HTML FILES ONLY!";
6053 If you are using a machine that recognizes "text" and "binary" data
6054 modes, be sure to understand when and how to use them (see the Camel book).
6055 Otherwise you may find that binary files are corrupted during file
6058 There are occasionally problems involving parsing the uploaded file.
6059 This usually happens when the user presses "Stop" before the upload is
6060 finished. In this case, CGI.pm will return undef for the name of the
6061 uploaded file and set I<cgi_error()> to the string "400 Bad request
6062 (malformed multipart POST)". This error message is designed so that
6063 you can incorporate it into a status code to be sent to the browser.
6066 $file = upload('uploaded_file');
6067 if (!$file && cgi_error) {
6068 print header(-status=>cgi_error);
6072 You are free to create a custom HTML page to complain about the error,
6075 You can set up a callback that will be called whenever a file upload
6076 is being read during the form processing. This is much like the
6077 UPLOAD_HOOK facility available in Apache::Request, with the exception
6078 that the first argument to the callback is an Apache::Upload object,
6079 here it's the remote filename.
6081 $q = CGI->new(\&hook [,$data [,$use_tempfile]]);
6085 my ($filename, $buffer, $bytes_read, $data) = @_;
6086 print "Read $bytes_read bytes of $filename\n";
6089 The $data field is optional; it lets you pass configuration
6090 information (e.g. a database handle) to your hook callback.
6092 The $use_tempfile field is a flag that lets you turn on and off
6093 CGI.pm's use of a temporary disk-based file during file upload. If you
6094 set this to a FALSE value (default true) then param('uploaded_file')
6095 will no longer work, and the only way to get at the uploaded data is
6096 via the hook you provide.
6098 If using the function-oriented interface, call the CGI::upload_hook()
6099 method before calling param() or any other CGI functions:
6101 CGI::upload_hook(\&hook [,$data [,$use_tempfile]]);
6103 This method is not exported by default. You will have to import it
6104 explicitly if you wish to use it without the CGI:: prefix.
6106 If you are using CGI.pm on a Windows platform and find that binary
6107 files get slightly larger when uploaded but that text files remain the
6108 same, then you have forgotten to activate binary mode on the output
6109 filehandle. Be sure to call binmode() on any handle that you create
6110 to write the uploaded file to disk.
6112 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>,
6113 B<-onMouseOver>, B<-onMouseOut> and B<-onSelect> parameters are
6114 recognized. See textfield() for details.
6116 =head2 CREATING A POPUP MENU
6118 print popup_menu('menu_name',
6119 ['eenie','meenie','minie'],
6124 %labels = ('eenie'=>'your first choice',
6125 'meenie'=>'your second choice',
6126 'minie'=>'your third choice');
6127 %attributes = ('eenie'=>{'class'=>'class of first choice'});
6128 print popup_menu('menu_name',
6129 ['eenie','meenie','minie'],
6130 'meenie',\%labels,\%attributes);
6132 -or (named parameter style)-
6134 print popup_menu(-name=>'menu_name',
6135 -values=>['eenie','meenie','minie'],
6138 -attributes=>\%attributes);
6140 popup_menu() creates a menu.
6146 The required first argument is the menu's name (-name).
6150 The required second argument (-values) is an array B<reference>
6151 containing the list of menu items in the menu. You can pass the
6152 method an anonymous array, as shown in the example, or a reference to
6153 a named array, such as "\@foo".
6157 The optional third parameter (-default) is the name of the default
6158 menu choice. If not specified, the first item will be the default.
6159 The values of the previous choice will be maintained across queries.
6163 The optional fourth parameter (-labels) is provided for people who
6164 want to use different values for the user-visible label inside the
6165 popup menu and the value returned to your script. It's a pointer to an
6166 associative array relating menu values to user-visible labels. If you
6167 leave this parameter blank, the menu values will be displayed by
6168 default. (You can also leave a label undefined if you want to).
6172 The optional fifth parameter (-attributes) is provided to assign
6173 any of the common HTML attributes to an individual menu item. It's
6174 a pointer to an associative array relating menu values to another
6175 associative array with the attribute's name as the key and the
6176 attribute's value as the value.
6180 When the form is processed, the selected value of the popup menu can
6183 $popup_menu_value = param('menu_name');
6185 =head2 CREATING AN OPTION GROUP
6187 Named parameter style
6189 print popup_menu(-name=>'menu_name',
6190 -values=>[qw/eenie meenie minie/,
6191 optgroup(-name=>'optgroup_name',
6192 -values => ['moe','catch'],
6193 -attributes=>{'catch'=>{'class'=>'red'}})],
6194 -labels=>{'eenie'=>'one',
6197 -default=>'meenie');
6200 print popup_menu('menu_name',
6201 ['eenie','meenie','minie',
6202 optgroup('optgroup_name', ['moe', 'catch'],
6203 {'catch'=>{'class'=>'red'}})],'meenie',
6204 {'eenie'=>'one','meenie'=>'two','minie'=>'three'});
6206 optgroup() creates an option group within a popup menu.
6212 The required first argument (B<-name>) is the label attribute of the
6213 optgroup and is B<not> inserted in the parameter list of the query.
6217 The required second argument (B<-values>) is an array reference
6218 containing the list of menu items in the menu. You can pass the
6219 method an anonymous array, as shown in the example, or a reference
6220 to a named array, such as \@foo. If you pass a HASH reference,
6221 the keys will be used for the menu values, and the values will be
6222 used for the menu labels (see -labels below).
6226 The optional third parameter (B<-labels>) allows you to pass a reference
6227 to an associative array containing user-visible labels for one or more
6228 of the menu items. You can use this when you want the user to see one
6229 menu string, but have the browser return your program a different one.
6230 If you don't specify this, the value string will be used instead
6231 ("eenie", "meenie" and "minie" in this example). This is equivalent
6232 to using a hash reference for the -values parameter.
6236 An optional fourth parameter (B<-labeled>) can be set to a true value
6237 and indicates that the values should be used as the label attribute
6238 for each option element within the optgroup.
6242 An optional fifth parameter (-novals) can be set to a true value and
6243 indicates to suppress the val attribute in each option element within
6246 See the discussion on optgroup at W3C
6247 (http://www.w3.org/TR/REC-html40/interact/forms.html#edef-OPTGROUP)
6252 An optional sixth parameter (-attributes) is provided to assign
6253 any of the common HTML attributes to an individual menu item. It's
6254 a pointer to an associative array relating menu values to another
6255 associative array with the attribute's name as the key and the
6256 attribute's value as the value.
6260 =head2 CREATING A SCROLLING LIST
6262 print scrolling_list('list_name',
6263 ['eenie','meenie','minie','moe'],
6264 ['eenie','moe'],5,'true',{'moe'=>{'class'=>'red'}});
6267 print scrolling_list('list_name',
6268 ['eenie','meenie','minie','moe'],
6269 ['eenie','moe'],5,'true',
6270 \%labels,%attributes);
6274 print scrolling_list(-name=>'list_name',
6275 -values=>['eenie','meenie','minie','moe'],
6276 -default=>['eenie','moe'],
6280 -attributes=>\%attributes);
6282 scrolling_list() creates a scrolling list.
6286 =item B<Parameters:>
6290 The first and second arguments are the list name (-name) and values
6291 (-values). As in the popup menu, the second argument should be an
6296 The optional third argument (-default) can be either a reference to a
6297 list containing the values to be selected by default, or can be a
6298 single value to select. If this argument is missing or undefined,
6299 then nothing is selected when the list first appears. In the named
6300 parameter version, you can use the synonym "-defaults" for this
6305 The optional fourth argument is the size of the list (-size).
6309 The optional fifth argument can be set to true to allow multiple
6310 simultaneous selections (-multiple). Otherwise only one selection
6311 will be allowed at a time.
6315 The optional sixth argument is a pointer to an associative array
6316 containing long user-visible labels for the list items (-labels).
6317 If not provided, the values will be displayed.
6321 The optional sixth parameter (-attributes) is provided to assign
6322 any of the common HTML attributes to an individual menu item. It's
6323 a pointer to an associative array relating menu values to another
6324 associative array with the attribute's name as the key and the
6325 attribute's value as the value.
6327 When this form is processed, all selected list items will be returned as
6328 a list under the parameter name 'list_name'. The values of the
6329 selected items can be retrieved with:
6331 @selected = param('list_name');
6335 =head2 CREATING A GROUP OF RELATED CHECKBOXES
6337 print checkbox_group(-name=>'group_name',
6338 -values=>['eenie','meenie','minie','moe'],
6339 -default=>['eenie','moe'],
6341 -disabled => ['moe'],
6343 -attributes=>\%attributes);
6345 print checkbox_group('group_name',
6346 ['eenie','meenie','minie','moe'],
6347 ['eenie','moe'],'true',\%labels,
6348 {'moe'=>{'class'=>'red'}});
6350 HTML3-COMPATIBLE BROWSERS ONLY:
6352 print checkbox_group(-name=>'group_name',
6353 -values=>['eenie','meenie','minie','moe'],
6354 -rows=2,-columns=>2);
6357 checkbox_group() creates a list of checkboxes that are related
6362 =item B<Parameters:>
6366 The first and second arguments are the checkbox name and values,
6367 respectively (-name and -values). As in the popup menu, the second
6368 argument should be an array reference. These values are used for the
6369 user-readable labels printed next to the checkboxes as well as for the
6370 values passed to your script in the query string.
6374 The optional third argument (-default) can be either a reference to a
6375 list containing the values to be checked by default, or can be a
6376 single value to checked. If this argument is missing or undefined,
6377 then nothing is selected when the list first appears.
6381 The optional fourth argument (-linebreak) can be set to true to place
6382 line breaks between the checkboxes so that they appear as a vertical
6383 list. Otherwise, they will be strung together on a horizontal line.
6388 The optional b<-labels> argument is a pointer to an associative array
6389 relating the checkbox values to the user-visible labels that will be
6390 printed next to them. If not provided, the values will be used as the
6394 The optional parameters B<-rows>, and B<-columns> cause
6395 checkbox_group() to return an HTML3 compatible table containing the
6396 checkbox group formatted with the specified number of rows and
6397 columns. You can provide just the -columns parameter if you wish;
6398 checkbox_group will calculate the correct number of rows for you.
6400 The option b<-disabled> takes an array of checkbox values and disables
6401 them by greying them out (this may not be supported by all browsers).
6403 The optional B<-attributes> argument is provided to assign any of the
6404 common HTML attributes to an individual menu item. It's a pointer to
6405 an associative array relating menu values to another associative array
6406 with the attribute's name as the key and the attribute's value as the
6409 The optional B<-tabindex> argument can be used to control the order in which
6410 radio buttons receive focus when the user presses the tab button. If
6411 passed a scalar numeric value, the first element in the group will
6412 receive this tab index and subsequent elements will be incremented by
6413 one. If given a reference to an array of radio button values, then
6414 the indexes will be jiggered so that the order specified in the array
6415 will correspond to the tab order. You can also pass a reference to a
6416 hash in which the hash keys are the radio button values and the values
6417 are the tab indexes of each button. Examples:
6419 -tabindex => 100 # this group starts at index 100 and counts up
6420 -tabindex => ['moe','minie','eenie','meenie'] # tab in this order
6421 -tabindex => {meenie=>100,moe=>101,minie=>102,eenie=>200} # tab in this order
6423 The optional B<-labelattributes> argument will contain attributes
6424 attached to the <label> element that surrounds each button.
6426 When the form is processed, all checked boxes will be returned as
6427 a list under the parameter name 'group_name'. The values of the
6428 "on" checkboxes can be retrieved with:
6430 @turned_on = param('group_name');
6432 The value returned by checkbox_group() is actually an array of button
6433 elements. You can capture them and use them within tables, lists,
6434 or in other creative ways:
6436 @h = checkbox_group(-name=>'group_name',-values=>\@values);
6437 &use_in_creative_way(@h);
6439 =head2 CREATING A STANDALONE CHECKBOX
6441 print checkbox(-name=>'checkbox_name',
6444 -label=>'CLICK ME');
6448 print checkbox('checkbox_name','checked','ON','CLICK ME');
6450 checkbox() is used to create an isolated checkbox that isn't logically
6451 related to any others.
6455 =item B<Parameters:>
6459 The first parameter is the required name for the checkbox (-name). It
6460 will also be used for the user-readable label printed next to the
6465 The optional second parameter (-checked) specifies that the checkbox
6466 is turned on by default. Synonyms are -selected and -on.
6470 The optional third parameter (-value) specifies the value of the
6471 checkbox when it is checked. If not provided, the word "on" is
6476 The optional fourth parameter (-label) is the user-readable label to
6477 be attached to the checkbox. If not provided, the checkbox name is
6482 The value of the checkbox can be retrieved using:
6484 $turned_on = param('checkbox_name');
6486 =head2 CREATING A RADIO BUTTON GROUP
6488 print radio_group(-name=>'group_name',
6489 -values=>['eenie','meenie','minie'],
6493 -attributes=>\%attributes);
6497 print radio_group('group_name',['eenie','meenie','minie'],
6498 'meenie','true',\%labels,\%attributes);
6501 HTML3-COMPATIBLE BROWSERS ONLY:
6503 print radio_group(-name=>'group_name',
6504 -values=>['eenie','meenie','minie','moe'],
6505 -rows=2,-columns=>2);
6507 radio_group() creates a set of logically-related radio buttons
6508 (turning one member of the group on turns the others off)
6512 =item B<Parameters:>
6516 The first argument is the name of the group and is required (-name).
6520 The second argument (-values) is the list of values for the radio
6521 buttons. The values and the labels that appear on the page are
6522 identical. Pass an array I<reference> in the second argument, either
6523 using an anonymous array, as shown, or by referencing a named array as
6528 The optional third parameter (-default) is the name of the default
6529 button to turn on. If not specified, the first item will be the
6530 default. You can provide a nonexistent button name, such as "-" to
6531 start up with no buttons selected.
6535 The optional fourth parameter (-linebreak) can be set to 'true' to put
6536 line breaks between the buttons, creating a vertical list.
6540 The optional fifth parameter (-labels) is a pointer to an associative
6541 array relating the radio button values to user-visible labels to be
6542 used in the display. If not provided, the values themselves are
6548 All modern browsers can take advantage of the optional parameters
6549 B<-rows>, and B<-columns>. These parameters cause radio_group() to
6550 return an HTML3 compatible table containing the radio group formatted
6551 with the specified number of rows and columns. You can provide just
6552 the -columns parameter if you wish; radio_group will calculate the
6553 correct number of rows for you.
6555 To include row and column headings in the returned table, you
6556 can use the B<-rowheaders> and B<-colheaders> parameters. Both
6557 of these accept a pointer to an array of headings to use.
6558 The headings are just decorative. They don't reorganize the
6559 interpretation of the radio buttons -- they're still a single named
6562 The optional B<-tabindex> argument can be used to control the order in which
6563 radio buttons receive focus when the user presses the tab button. If
6564 passed a scalar numeric value, the first element in the group will
6565 receive this tab index and subsequent elements will be incremented by
6566 one. If given a reference to an array of radio button values, then
6567 the indexes will be jiggered so that the order specified in the array
6568 will correspond to the tab order. You can also pass a reference to a
6569 hash in which the hash keys are the radio button values and the values
6570 are the tab indexes of each button. Examples:
6572 -tabindex => 100 # this group starts at index 100 and counts up
6573 -tabindex => ['moe','minie','eenie','meenie'] # tab in this order
6574 -tabindex => {meenie=>100,moe=>101,minie=>102,eenie=>200} # tab in this order
6577 The optional B<-attributes> argument is provided to assign any of the
6578 common HTML attributes to an individual menu item. It's a pointer to
6579 an associative array relating menu values to another associative array
6580 with the attribute's name as the key and the attribute's value as the
6583 The optional B<-labelattributes> argument will contain attributes
6584 attached to the <label> element that surrounds each button.
6586 When the form is processed, the selected radio button can
6589 $which_radio_button = param('group_name');
6591 The value returned by radio_group() is actually an array of button
6592 elements. You can capture them and use them within tables, lists,
6593 or in other creative ways:
6595 @h = radio_group(-name=>'group_name',-values=>\@values);
6596 &use_in_creative_way(@h);
6598 =head2 CREATING A SUBMIT BUTTON
6600 print submit(-name=>'button_name',
6605 print submit('button_name','value');
6607 submit() will create the query submission button. Every form
6608 should have one of these.
6612 =item B<Parameters:>
6616 The first argument (-name) is optional. You can give the button a
6617 name if you have several submission buttons in your form and you want
6618 to distinguish between them.
6622 The second argument (-value) is also optional. This gives the button
6623 a value that will be passed to your script in the query string. The
6624 name will also be used as the user-visible label.
6628 You can use -label as an alias for -value. I always get confused
6629 about which of -name and -value changes the user-visible label on the
6634 You can figure out which button was pressed by using different
6635 values for each one:
6637 $which_one = param('button_name');
6639 =head2 CREATING A RESET BUTTON
6643 reset() creates the "reset" button. Note that it restores the
6644 form to its value from the last time the script was called,
6645 NOT necessarily to the defaults.
6647 Note that this conflicts with the Perl reset() built-in. Use
6648 CORE::reset() to get the original reset function.
6650 =head2 CREATING A DEFAULT BUTTON
6652 print defaults('button_label')
6654 defaults() creates a button that, when invoked, will cause the
6655 form to be completely reset to its defaults, wiping out all the
6656 changes the user ever made.
6658 =head2 CREATING A HIDDEN FIELD
6660 print hidden(-name=>'hidden_name',
6661 -default=>['value1','value2'...]);
6665 print hidden('hidden_name','value1','value2'...);
6667 hidden() produces a text field that can't be seen by the user. It
6668 is useful for passing state variable information from one invocation
6669 of the script to the next.
6673 =item B<Parameters:>
6677 The first argument is required and specifies the name of this
6682 The second argument is also required and specifies its value
6683 (-default). In the named parameter style of calling, you can provide
6684 a single value here or a reference to a whole list
6688 Fetch the value of a hidden field this way:
6690 $hidden_value = param('hidden_name');
6692 Note, that just like all the other form elements, the value of a
6693 hidden field is "sticky". If you want to replace a hidden field with
6694 some other values after the script has been called once you'll have to
6697 param('hidden_name','new','values','here');
6699 =head2 CREATING A CLICKABLE IMAGE BUTTON
6701 print image_button(-name=>'button_name',
6702 -src=>'/source/URL',
6707 print image_button('button_name','/source/URL','MIDDLE');
6709 image_button() produces a clickable image. When it's clicked on the
6710 position of the click is returned to your script as "button_name.x"
6711 and "button_name.y", where "button_name" is the name you've assigned
6716 =item B<Parameters:>
6720 The first argument (-name) is required and specifies the name of this
6725 The second argument (-src) is also required and specifies the URL
6728 The third option (-align, optional) is an alignment type, and may be
6729 TOP, BOTTOM or MIDDLE
6733 Fetch the value of the button this way:
6734 $x = param('button_name.x');
6735 $y = param('button_name.y');
6737 =head2 CREATING A JAVASCRIPT ACTION BUTTON
6739 print button(-name=>'button_name',
6740 -value=>'user visible label',
6741 -onClick=>"do_something()");
6745 print button('button_name',"do_something()");
6747 button() produces a button that is compatible with Netscape 2.0's
6748 JavaScript. When it's pressed the fragment of JavaScript code
6749 pointed to by the B<-onClick> parameter will be executed. On
6750 non-Netscape browsers this form element will probably not even
6755 Netscape browsers versions 1.1 and higher, and all versions of
6756 Internet Explorer, support a so-called "cookie" designed to help
6757 maintain state within a browser session. CGI.pm has several methods
6758 that support cookies.
6760 A cookie is a name=value pair much like the named parameters in a CGI
6761 query string. CGI scripts create one or more cookies and send
6762 them to the browser in the HTTP header. The browser maintains a list
6763 of cookies that belong to a particular Web server, and returns them
6764 to the CGI script during subsequent interactions.
6766 In addition to the required name=value pair, each cookie has several
6767 optional attributes:
6771 =item 1. an expiration time
6773 This is a time/date string (in a special GMT format) that indicates
6774 when a cookie expires. The cookie will be saved and returned to your
6775 script until this expiration date is reached if the user exits
6776 the browser and restarts it. If an expiration date isn't specified, the cookie
6777 will remain active until the user quits the browser.
6781 This is a partial or complete domain name for which the cookie is
6782 valid. The browser will return the cookie to any host that matches
6783 the partial domain name. For example, if you specify a domain name
6784 of ".capricorn.com", then the browser will return the cookie to
6785 Web servers running on any of the machines "www.capricorn.com",
6786 "www2.capricorn.com", "feckless.capricorn.com", etc. Domain names
6787 must contain at least two periods to prevent attempts to match
6788 on top level domains like ".edu". If no domain is specified, then
6789 the browser will only return the cookie to servers on the host the
6790 cookie originated from.
6794 If you provide a cookie path attribute, the browser will check it
6795 against your script's URL before returning the cookie. For example,
6796 if you specify the path "/cgi-bin", then the cookie will be returned
6797 to each of the scripts "/cgi-bin/tally.pl", "/cgi-bin/order.pl",
6798 and "/cgi-bin/customer_service/complain.pl", but not to the script
6799 "/cgi-private/site_admin.pl". By default, path is set to "/", which
6800 causes the cookie to be sent to any CGI script on your site.
6802 =item 4. a "secure" flag
6804 If the "secure" attribute is set, the cookie will only be sent to your
6805 script if the CGI request is occurring on a secure channel, such as SSL.
6809 The interface to HTTP cookies is the B<cookie()> method:
6811 $cookie = cookie(-name=>'sessionID',
6814 -path=>'/cgi-bin/database',
6815 -domain=>'.capricorn.org',
6817 print header(-cookie=>$cookie);
6819 B<cookie()> creates a new cookie. Its parameters include:
6825 The name of the cookie (required). This can be any string at all.
6826 Although browsers limit their cookie names to non-whitespace
6827 alphanumeric characters, CGI.pm removes this restriction by escaping
6828 and unescaping cookies behind the scenes.
6832 The value of the cookie. This can be any scalar value,
6833 array reference, or even associative array reference. For example,
6834 you can store an entire associative array into a cookie this way:
6836 $cookie=cookie(-name=>'family information',
6837 -value=>\%childrens_ages);
6841 The optional partial path for which this cookie will be valid, as described
6846 The optional partial domain for which this cookie will be valid, as described
6851 The optional expiration date for this cookie. The format is as described
6852 in the section on the B<header()> method:
6854 "+1h" one hour from now
6858 If set to true, this cookie will only be used within a secure
6863 The cookie created by cookie() must be incorporated into the HTTP
6864 header within the string returned by the header() method:
6866 use CGI ':standard';
6867 print header(-cookie=>$my_cookie);
6869 To create multiple cookies, give header() an array reference:
6871 $cookie1 = cookie(-name=>'riddle_name',
6872 -value=>"The Sphynx's Question");
6873 $cookie2 = cookie(-name=>'answers',
6875 print header(-cookie=>[$cookie1,$cookie2]);
6877 To retrieve a cookie, request it by name by calling cookie() method
6878 without the B<-value> parameter. This example uses the object-oriented
6883 $riddle = $query->cookie('riddle_name');
6884 %answers = $query->cookie('answers');
6886 Cookies created with a single scalar value, such as the "riddle_name"
6887 cookie, will be returned in that form. Cookies with array and hash
6888 values can also be retrieved.
6890 The cookie and CGI namespaces are separate. If you have a parameter
6891 named 'answers' and a cookie named 'answers', the values retrieved by
6892 param() and cookie() are independent of each other. However, it's
6893 simple to turn a CGI parameter into a cookie, and vice-versa:
6895 # turn a CGI parameter into a cookie
6896 $c=cookie(-name=>'answers',-value=>[param('answers')]);
6898 param(-name=>'answers',-value=>[cookie('answers')]);
6900 If you call cookie() without any parameters, it will return a list of
6901 the names of all cookies passed to your script:
6903 @cookies = cookie();
6905 See the B<cookie.cgi> example script for some ideas on how to use
6906 cookies effectively.
6908 =head1 WORKING WITH FRAMES
6910 It's possible for CGI.pm scripts to write into several browser panels
6911 and windows using the HTML 4 frame mechanism. There are three
6912 techniques for defining new frames programmatically:
6916 =item 1. Create a <Frameset> document
6918 After writing out the HTTP header, instead of creating a standard
6919 HTML document using the start_html() call, create a <frameset>
6920 document that defines the frames on the page. Specify your script(s)
6921 (with appropriate parameters) as the SRC for each of the frames.
6923 There is no specific support for creating <frameset> sections
6924 in CGI.pm, but the HTML is very simple to write. See the frame
6925 documentation in Netscape's home pages for details
6927 http://wp.netscape.com/assist/net_sites/frames.html
6929 =item 2. Specify the destination for the document in the HTTP header
6931 You may provide a B<-target> parameter to the header() method:
6933 print header(-target=>'ResultsWindow');
6935 This will tell the browser to load the output of your script into the
6936 frame named "ResultsWindow". If a frame of that name doesn't already
6937 exist, the browser will pop up a new window and load your script's
6938 document into that. There are a number of magic names that you can
6939 use for targets. See the frame documents on Netscape's home pages for
6942 =item 3. Specify the destination for the document in the <form> tag
6944 You can specify the frame to load in the FORM tag itself. With
6945 CGI.pm it looks like this:
6947 print start_form(-target=>'ResultsWindow');
6949 When your script is reinvoked by the form, its output will be loaded
6950 into the frame named "ResultsWindow". If one doesn't already exist
6951 a new window will be created.
6955 The script "frameset.cgi" in the examples directory shows one way to
6956 create pages in which the fill-out form and the response live in
6957 side-by-side frames.
6959 =head1 SUPPORT FOR JAVASCRIPT
6961 Netscape versions 2.0 and higher incorporate an interpreted language
6962 called JavaScript. Internet Explorer, 3.0 and higher, supports a
6963 closely-related dialect called JScript. JavaScript isn't the same as
6964 Java, and certainly isn't at all the same as Perl, which is a great
6965 pity. JavaScript allows you to programmatically change the contents of
6966 fill-out forms, create new windows, and pop up dialog box from within
6967 Netscape itself. From the point of view of CGI scripting, JavaScript
6968 is quite useful for validating fill-out forms prior to submitting
6971 You'll need to know JavaScript in order to use it. There are many good
6972 sources in bookstores and on the web.
6974 The usual way to use JavaScript is to define a set of functions in a
6975 <SCRIPT> block inside the HTML header and then to register event
6976 handlers in the various elements of the page. Events include such
6977 things as the mouse passing over a form element, a button being
6978 clicked, the contents of a text field changing, or a form being
6979 submitted. When an event occurs that involves an element that has
6980 registered an event handler, its associated JavaScript code gets
6983 The elements that can register event handlers include the <BODY> of an
6984 HTML document, hypertext links, all the various elements of a fill-out
6985 form, and the form itself. There are a large number of events, and
6986 each applies only to the elements for which it is relevant. Here is a
6993 The browser is loading the current document. Valid in:
6995 + The HTML <BODY> section only.
6999 The browser is closing the current page or frame. Valid for:
7001 + The HTML <BODY> section only.
7005 The user has pressed the submit button of a form. This event happens
7006 just before the form is submitted, and your function can return a
7007 value of false in order to abort the submission. Valid for:
7013 The mouse has clicked on an item in a fill-out form. Valid for:
7015 + Buttons (including submit, reset, and image buttons)
7021 The user has changed the contents of a field. Valid for:
7032 The user has selected a field to work with. Valid for:
7043 The user has deselected a field (gone to work somewhere else). Valid
7055 The user has changed the part of a text field that is selected. Valid
7063 =item B<onMouseOver>
7065 The mouse has moved over an element.
7076 The mouse has moved off an element.
7087 In order to register a JavaScript event handler with an HTML element,
7088 just use the event name as a parameter when you call the corresponding
7089 CGI method. For example, to have your validateAge() JavaScript code
7090 executed every time the textfield named "age" changes, generate the
7093 print textfield(-name=>'age',-onChange=>"validateAge(this)");
7095 This example assumes that you've already declared the validateAge()
7096 function by incorporating it into a <SCRIPT> block. The CGI.pm
7097 start_html() method provides a convenient way to create this section.
7099 Similarly, you can create a form that checks itself over for
7100 consistency and alerts the user if some essential value is missing by
7101 creating it this way:
7102 print startform(-onSubmit=>"validateMe(this)");
7104 See the javascript.cgi script for a demonstration of how this all
7108 =head1 LIMITED SUPPORT FOR CASCADING STYLE SHEETS
7110 CGI.pm has limited support for HTML3's cascading style sheets (css).
7111 To incorporate a stylesheet into your document, pass the
7112 start_html() method a B<-style> parameter. The value of this
7113 parameter may be a scalar, in which case it is treated as the source
7114 URL for the stylesheet, or it may be a hash reference. In the latter
7115 case you should provide the hash with one or more of B<-src> or
7116 B<-code>. B<-src> points to a URL where an externally-defined
7117 stylesheet can be found. B<-code> points to a scalar value to be
7118 incorporated into a <style> section. Style definitions in B<-code>
7119 override similarly-named ones in B<-src>, hence the name "cascading."
7121 You may also specify the type of the stylesheet by adding the optional
7122 B<-type> parameter to the hash pointed to by B<-style>. If not
7123 specified, the style defaults to 'text/css'.
7125 To refer to a style within the body of your document, add the
7126 B<-class> parameter to any HTML element:
7128 print h1({-class=>'Fancy'},'Welcome to the Party');
7130 Or define styles on the fly with the B<-style> parameter:
7132 print h1({-style=>'Color: red;'},'Welcome to Hell');
7134 You may also use the new B<span()> element to apply a style to a
7137 print span({-style=>'Color: red;'},
7138 h1('Welcome to Hell'),
7139 "Where did that handbasket get to?"
7142 Note that you must import the ":html3" definitions to have the
7143 B<span()> method available. Here's a quick and dirty example of using
7144 CSS's. See the CSS specification at
7145 http://www.w3.org/pub/WWW/TR/Wd-css-1.html for more information.
7147 use CGI qw/:standard :html3/;
7149 #here's a stylesheet incorporated directly into the page
7159 font-family: sans-serif;
7165 print start_html( -title=>'CGI with Style',
7166 -style=>{-src=>'http://www.capricorn.com/style/st1.css',
7169 print h1('CGI with Style'),
7171 "Better read the cascading style sheet spec before playing with this!"),
7172 span({-style=>'color: magenta'},
7173 "Look Mom, no hands!",
7179 Pass an array reference to B<-code> or B<-src> in order to incorporate
7180 multiple stylesheets into your document.
7182 Should you wish to incorporate a verbatim stylesheet that includes
7183 arbitrary formatting in the header, you may pass a -verbatim tag to
7184 the -style hash, as follows:
7186 print start_html (-style => {-verbatim => '@import url("/server-common/css/'.$cssFile.'");',
7187 -src => '/server-common/css/core.css'});
7190 This will generate an HTML header that contains this:
7192 <link rel="stylesheet" type="text/css" href="/server-common/css/core.css">
7193 <style type="text/css">
7194 @import url("/server-common/css/main.css");
7197 Any additional arguments passed in the -style value will be
7198 incorporated into the <link> tag. For example:
7200 start_html(-style=>{-src=>['/styles/print.css','/styles/layout.css'],
7205 <link rel="stylesheet" type="text/css" href="/styles/print.css" media="all"/>
7206 <link rel="stylesheet" type="text/css" href="/styles/layout.css" media="all"/>
7210 To make more complicated <link> tags, use the Link() function
7211 and pass it to start_html() in the -head argument, as in:
7213 @h = (Link({-rel=>'stylesheet',-type=>'text/css',-src=>'/ss/ss.css',-media=>'all'}),
7214 Link({-rel=>'stylesheet',-type=>'text/css',-src=>'/ss/fred.css',-media=>'paper'}));
7215 print start_html({-head=>\@h})
7217 To create primary and "alternate" stylesheet, use the B<-alternate> option:
7219 start_html(-style=>{-src=>[
7220 {-src=>'/styles/print.css'},
7221 {-src=>'/styles/alt.css',-alternate=>1}
7227 If you are running the script from the command line or in the perl
7228 debugger, you can pass the script a list of keywords or
7229 parameter=value pairs on the command line or from standard input (you
7230 don't have to worry about tricking your script into reading from
7231 environment variables). You can pass keywords like this:
7233 your_script.pl keyword1 keyword2 keyword3
7237 your_script.pl keyword1+keyword2+keyword3
7241 your_script.pl name1=value1 name2=value2
7245 your_script.pl name1=value1&name2=value2
7247 To turn off this feature, use the -no_debug pragma.
7249 To test the POST method, you may enable full debugging with the -debug
7250 pragma. This will allow you to feed newline-delimited name=value
7251 pairs to the script on standard input.
7253 When debugging, you can use quotes and backslashes to escape
7254 characters in the familiar shell manner, letting you place
7255 spaces and other funny characters in your parameter=value
7258 your_script.pl "name1='I am a long value'" "name2=two\ words"
7260 Finally, you can set the path info for the script by prefixing the first
7261 name/value parameter with the path followed by a question mark (?):
7263 your_script.pl /your/path/here?name1=value1&name2=value2
7265 =head2 DUMPING OUT ALL THE NAME/VALUE PAIRS
7267 The Dump() method produces a string consisting of all the query's
7268 name/value pairs formatted nicely as a nested list. This is useful
7269 for debugging purposes:
7274 Produces something that looks like:
7288 As a shortcut, you can interpolate the entire CGI object into a string
7289 and it will be replaced with the a nice HTML dump shown above:
7292 print "<h2>Current Values</h2> $query\n";
7294 =head1 FETCHING ENVIRONMENT VARIABLES
7296 Some of the more useful environment variables can be fetched
7297 through this interface. The methods are as follows:
7303 Return a list of MIME types that the remote browser accepts. If you
7304 give this method a single argument corresponding to a MIME type, as in
7305 Accept('text/html'), it will return a floating point value
7306 corresponding to the browser's preference for this type from 0.0
7307 (don't want) to 1.0. Glob types (e.g. text/*) in the browser's accept
7308 list are handled correctly.
7310 Note that the capitalization changed between version 2.43 and 2.44 in
7311 order to avoid conflict with Perl's accept() function.
7313 =item B<raw_cookie()>
7315 Returns the HTTP_COOKIE variable, an HTTP extension implemented by
7316 Netscape browsers version 1.1 and higher, and all versions of Internet
7317 Explorer. Cookies have a special format, and this method call just
7318 returns the raw form (?cookie dough). See cookie() for ways of
7319 setting and retrieving cooked cookies.
7321 Called with no parameters, raw_cookie() returns the packed cookie
7322 structure. You can separate it into individual cookies by splitting
7323 on the character sequence "; ". Called with the name of a cookie,
7324 retrieves the B<unescaped> form of the cookie. You can use the
7325 regular cookie() method to get the names, or use the raw_fetch()
7326 method from the CGI::Cookie module.
7328 =item B<user_agent()>
7330 Returns the HTTP_USER_AGENT variable. If you give
7331 this method a single argument, it will attempt to
7332 pattern match on it, allowing you to do something
7333 like user_agent(netscape);
7335 =item B<path_info()>
7337 Returns additional path information from the script URL.
7338 E.G. fetching /cgi-bin/your_script/additional/stuff will result in
7339 path_info() returning "/additional/stuff".
7341 NOTE: The Microsoft Internet Information Server
7342 is broken with respect to additional path information. If
7343 you use the Perl DLL library, the IIS server will attempt to
7344 execute the additional path information as a Perl script.
7345 If you use the ordinary file associations mapping, the
7346 path information will be present in the environment,
7347 but incorrect. The best thing to do is to avoid using additional
7348 path information in CGI scripts destined for use with IIS.
7350 =item B<path_translated()>
7352 As per path_info() but returns the additional
7353 path information translated into a physical path, e.g.
7354 "/usr/local/etc/httpd/htdocs/additional/stuff".
7356 The Microsoft IIS is broken with respect to the translated
7359 =item B<remote_host()>
7361 Returns either the remote host name or IP address.
7362 if the former is unavailable.
7364 =item B<script_name()>
7365 Return the script name as a partial URL, for self-refering
7370 Return the URL of the page the browser was viewing
7371 prior to fetching your script. Not available for all
7374 =item B<auth_type ()>
7376 Return the authorization/verification method in use for this
7379 =item B<server_name ()>
7381 Returns the name of the server, usually the machine's host
7384 =item B<virtual_host ()>
7386 When using virtual hosts, returns the name of the host that
7387 the browser attempted to contact
7389 =item B<server_port ()>
7391 Return the port that the server is listening on.
7393 =item B<virtual_port ()>
7395 Like server_port() except that it takes virtual hosts into account.
7396 Use this when running with virtual hosts.
7398 =item B<server_software ()>
7400 Returns the server software and version number.
7402 =item B<remote_user ()>
7404 Return the authorization/verification name used for user
7405 verification, if this script is protected.
7407 =item B<user_name ()>
7409 Attempt to obtain the remote user's name, using a variety of different
7410 techniques. This only works with older browsers such as Mosaic.
7411 Newer browsers do not report the user name for privacy reasons!
7413 =item B<request_method()>
7415 Returns the method used to access your script, usually
7416 one of 'POST', 'GET' or 'HEAD'.
7418 =item B<content_type()>
7420 Returns the content_type of data submitted in a POST, generally
7421 multipart/form-data or application/x-www-form-urlencoded
7425 Called with no arguments returns the list of HTTP environment
7426 variables, including such things as HTTP_USER_AGENT,
7427 HTTP_ACCEPT_LANGUAGE, and HTTP_ACCEPT_CHARSET, corresponding to the
7428 like-named HTTP header fields in the request. Called with the name of
7429 an HTTP header field, returns its value. Capitalization and the use
7430 of hyphens versus underscores are not significant.
7432 For example, all three of these examples are equivalent:
7434 $requested_language = http('Accept-language');
7435 $requested_language = http('Accept_language');
7436 $requested_language = http('HTTP_ACCEPT_LANGUAGE');
7440 The same as I<http()>, but operates on the HTTPS environment variables
7441 present when the SSL protocol is in effect. Can be used to determine
7442 whether SSL is turned on.
7446 =head1 USING NPH SCRIPTS
7448 NPH, or "no-parsed-header", scripts bypass the server completely by
7449 sending the complete HTTP header directly to the browser. This has
7450 slight performance benefits, but is of most use for taking advantage
7451 of HTTP extensions that are not directly supported by your server,
7452 such as server push and PICS headers.
7454 Servers use a variety of conventions for designating CGI scripts as
7455 NPH. Many Unix servers look at the beginning of the script's name for
7456 the prefix "nph-". The Macintosh WebSTAR server and Microsoft's
7457 Internet Information Server, in contrast, try to decide whether a
7458 program is an NPH script by examining the first line of script output.
7461 CGI.pm supports NPH scripts with a special NPH mode. When in this
7462 mode, CGI.pm will output the necessary extra header information when
7463 the header() and redirect() methods are
7466 The Microsoft Internet Information Server requires NPH mode. As of
7467 version 2.30, CGI.pm will automatically detect when the script is
7468 running under IIS and put itself into this mode. You do not need to
7469 do this manually, although it won't hurt anything if you do. However,
7470 note that if you have applied Service Pack 6, much of the
7471 functionality of NPH scripts, including the ability to redirect while
7472 setting a cookie, b<do not work at all> on IIS without a special patch
7474 http://support.microsoft.com/support/kb/articles/Q280/3/41.ASP:
7475 Non-Parsed Headers Stripped From CGI Applications That Have nph-
7480 =item In the B<use> statement
7482 Simply add the "-nph" pragmato the list of symbols to be imported into
7485 use CGI qw(:standard -nph)
7487 =item By calling the B<nph()> method:
7489 Call B<nph()> with a non-zero parameter at any point after using CGI.pm in your program.
7493 =item By using B<-nph> parameters
7495 in the B<header()> and B<redirect()> statements:
7497 print header(-nph=>1);
7503 CGI.pm provides four simple functions for producing multipart
7504 documents of the type needed to implement server push. These
7505 functions were graciously provided by Ed Jordan <ed@fidalgo.net>. To
7506 import these into your namespace, you must import the ":push" set.
7507 You are also advised to put the script into NPH mode and to set $| to
7508 1 to avoid buffering problems.
7510 Here is a simple script that demonstrates server push:
7512 #!/usr/local/bin/perl
7513 use CGI qw/:push -nph/;
7515 print multipart_init(-boundary=>'----here we go!');
7517 print multipart_start(-type=>'text/plain'),
7518 "The current time is ",scalar(localtime),"\n";
7520 print multipart_end;
7522 print multipart_final;
7527 This script initializes server push by calling B<multipart_init()>.
7528 It then enters a loop in which it begins a new multipart section by
7529 calling B<multipart_start()>, prints the current local time,
7530 and ends a multipart section with B<multipart_end()>. It then sleeps
7531 a second, and begins again. On the final iteration, it ends the
7532 multipart section with B<multipart_final()> rather than with
7537 =item multipart_init()
7539 multipart_init(-boundary=>$boundary);
7541 Initialize the multipart system. The -boundary argument specifies
7542 what MIME boundary string to use to separate parts of the document.
7543 If not provided, CGI.pm chooses a reasonable boundary for you.
7545 =item multipart_start()
7547 multipart_start(-type=>$type)
7549 Start a new part of the multipart document using the specified MIME
7550 type. If not specified, text/html is assumed.
7552 =item multipart_end()
7556 End a part. You must remember to call multipart_end() once for each
7557 multipart_start(), except at the end of the last part of the multipart
7558 document when multipart_final() should be called instead of multipart_end().
7560 =item multipart_final()
7564 End all parts. You should call multipart_final() rather than
7565 multipart_end() at the end of the last part of the multipart document.
7569 Users interested in server push applications should also have a look
7570 at the CGI::Push module.
7572 Only Netscape Navigator supports server push. Internet Explorer
7575 =head1 Avoiding Denial of Service Attacks
7577 A potential problem with CGI.pm is that, by default, it attempts to
7578 process form POSTings no matter how large they are. A wily hacker
7579 could attack your site by sending a CGI script a huge POST of many
7580 megabytes. CGI.pm will attempt to read the entire POST into a
7581 variable, growing hugely in size until it runs out of memory. While
7582 the script attempts to allocate the memory the system may slow down
7583 dramatically. This is a form of denial of service attack.
7585 Another possible attack is for the remote user to force CGI.pm to
7586 accept a huge file upload. CGI.pm will accept the upload and store it
7587 in a temporary directory even if your script doesn't expect to receive
7588 an uploaded file. CGI.pm will delete the file automatically when it
7589 terminates, but in the meantime the remote user may have filled up the
7590 server's disk space, causing problems for other programs.
7592 The best way to avoid denial of service attacks is to limit the amount
7593 of memory, CPU time and disk space that CGI scripts can use. Some Web
7594 servers come with built-in facilities to accomplish this. In other
7595 cases, you can use the shell I<limit> or I<ulimit>
7596 commands to put ceilings on CGI resource usage.
7599 CGI.pm also has some simple built-in protections against denial of
7600 service attacks, but you must activate them before you can use them.
7601 These take the form of two global variables in the CGI name space:
7605 =item B<$CGI::POST_MAX>
7607 If set to a non-negative integer, this variable puts a ceiling
7608 on the size of POSTings, in bytes. If CGI.pm detects a POST
7609 that is greater than the ceiling, it will immediately exit with an error
7610 message. This value will affect both ordinary POSTs and
7611 multipart POSTs, meaning that it limits the maximum size of file
7612 uploads as well. You should set this to a reasonably high
7613 value, such as 1 megabyte.
7615 =item B<$CGI::DISABLE_UPLOADS>
7617 If set to a non-zero value, this will disable file uploads
7618 completely. Other fill-out form values will work as usual.
7622 You can use these variables in either of two ways.
7626 =item B<1. On a script-by-script basis>
7628 Set the variable at the top of the script, right after the "use" statement:
7630 use CGI qw/:standard/;
7631 use CGI::Carp 'fatalsToBrowser';
7632 $CGI::POST_MAX=1024 * 100; # max 100K posts
7633 $CGI::DISABLE_UPLOADS = 1; # no uploads
7635 =item B<2. Globally for all scripts>
7637 Open up CGI.pm, find the definitions for $POST_MAX and
7638 $DISABLE_UPLOADS, and set them to the desired values. You'll
7639 find them towards the top of the file in a subroutine named
7640 initialize_globals().
7644 An attempt to send a POST larger than $POST_MAX bytes will cause
7645 I<param()> to return an empty CGI parameter list. You can test for
7646 this event by checking I<cgi_error()>, either after you create the CGI
7647 object or, if you are using the function-oriented interface, call
7648 <param()> for the first time. If the POST was intercepted, then
7649 cgi_error() will return the message "413 POST too large".
7651 This error message is actually defined by the HTTP protocol, and is
7652 designed to be returned to the browser as the CGI script's status
7655 $uploaded_file = param('upload');
7656 if (!$uploaded_file && cgi_error()) {
7657 print header(-status=>cgi_error());
7661 However it isn't clear that any browser currently knows what to do
7662 with this status code. It might be better just to create an
7663 HTML page that warns the user of the problem.
7665 =head1 COMPATIBILITY WITH CGI-LIB.PL
7667 To make it easier to port existing programs that use cgi-lib.pl the
7668 compatibility routine "ReadParse" is provided. Porting is simple:
7671 require "cgi-lib.pl";
7673 print "The value of the antique is $in{antique}.\n";
7678 print "The value of the antique is $in{antique}.\n";
7680 CGI.pm's ReadParse() routine creates a tied variable named %in,
7681 which can be accessed to obtain the query variables. Like
7682 ReadParse, you can also provide your own variable. Infrequently
7683 used features of ReadParse, such as the creation of @in and $in
7684 variables, are not supported.
7686 Once you use ReadParse, you can retrieve the query object itself
7690 print textfield(-name=>'wow',
7691 -value=>'does this really work?');
7693 This allows you to start using the more interesting features
7694 of CGI.pm without rewriting your old scripts from scratch.
7696 =head1 AUTHOR INFORMATION
7698 The GD.pm interface is copyright 1995-2007, Lincoln D. Stein. It is
7699 distributed under GPL and the Artistic License 2.0.
7701 Address bug reports and comments to: lstein@cshl.org. When sending
7702 bug reports, please provide the version of CGI.pm, the version of
7703 Perl, the name and version of your Web server, and the name and
7704 version of the operating system you are using. If the problem is even
7705 remotely browser dependent, please provide information about the
7706 affected browers as well.
7710 Thanks very much to:
7714 =item Matt Heffron (heffron@falstaff.css.beckman.com)
7716 =item James Taylor (james.taylor@srs.gov)
7718 =item Scott Anguish <sanguish@digifix.com>
7720 =item Mike Jewell (mlj3u@virginia.edu)
7722 =item Timothy Shimmin (tes@kbs.citri.edu.au)
7724 =item Joergen Haegg (jh@axis.se)
7726 =item Laurent Delfosse (delfosse@delfosse.com)
7728 =item Richard Resnick (applepi1@aol.com)
7730 =item Craig Bishop (csb@barwonwater.vic.gov.au)
7732 =item Tony Curtis (tc@vcpc.univie.ac.at)
7734 =item Tim Bunce (Tim.Bunce@ig.co.uk)
7736 =item Tom Christiansen (tchrist@convex.com)
7738 =item Andreas Koenig (k@franz.ww.TU-Berlin.DE)
7740 =item Tim MacKenzie (Tim.MacKenzie@fulcrum.com.au)
7742 =item Kevin B. Hendricks (kbhend@dogwood.tyler.wm.edu)
7744 =item Stephen Dahmen (joyfire@inxpress.net)
7746 =item Ed Jordan (ed@fidalgo.net)
7748 =item David Alan Pisoni (david@cnation.com)
7750 =item Doug MacEachern (dougm@opengroup.org)
7752 =item Robin Houston (robin@oneworld.org)
7754 =item ...and many many more...
7756 for suggestions and bug fixes.
7760 =head1 A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT
7763 #!/usr/local/bin/perl
7765 use CGI ':standard';
7768 print start_html("Example CGI.pm Form");
7769 print "<h1> Example CGI.pm Form</h1>\n";
7777 print "<em>What's your name?</em><br>";
7778 print textfield('name');
7779 print checkbox('Not my real name');
7781 print "<p><em>Where can you find English Sparrows?</em><br>";
7782 print checkbox_group(
7783 -name=>'Sparrow locations',
7784 -values=>[England,France,Spain,Asia,Hoboken],
7786 -defaults=>[England,Asia]);
7788 print "<p><em>How far can they fly?</em><br>",
7791 -values=>['10 ft','1 mile','10 miles','real far'],
7792 -default=>'1 mile');
7794 print "<p><em>What's your favorite color?</em> ";
7795 print popup_menu(-name=>'Color',
7796 -values=>['black','brown','red','yellow'],
7799 print hidden('Reference','Monty Python and the Holy Grail');
7801 print "<p><em>What have you got there?</em><br>";
7802 print scrolling_list(
7803 -name=>'possessions',
7804 -values=>['A Coconut','A Grail','An Icon',
7805 'A Sword','A Ticket'],
7809 print "<p><em>Any parting comments?</em><br>";
7810 print textarea(-name=>'Comments',
7815 print submit('Action','Shout');
7816 print submit('Action','Scream');
7824 print "<h2>Here are the current settings in this form</h2>";
7826 foreach $key (param) {
7827 print "<strong>$key</strong> -> ";
7828 @values = param($key);
7829 print join(", ",@values),"<br>\n";
7836 <address>Lincoln D. Stein</address><br>
7837 <a href="/">Home Page</a>
7847 L<CGI::Carp>, L<CGI::Fast>, L<CGI::Pretty>