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.266 2009/07/30 16:32:34 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 rearrange_header 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 '-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) {
159 } elsif ($OS =~ /^NetWare/i) {
165 # Some OS logic. Binary mode enabled on DOS, NT and VMS
166 $needs_binmode = $OS=~/^(WINDOWS|DOS|OS2|MSWin|CYGWIN|NETWARE)/;
168 # This is the default class for the CGI object to use when all else fails.
169 $DefaultClass = 'CGI' unless defined $CGI::DefaultClass;
171 # This is where to look for autoloaded routines.
172 $AutoloadClass = $DefaultClass unless defined $CGI::AutoloadClass;
174 # The path separator is a slash, backslash or semicolon, depending
177 UNIX => '/', OS2 => '\\', EPOC => '/', CYGWIN => '/', NETWARE => '/',
178 WINDOWS => '\\', DOS => '\\', MACINTOSH => ':', VMS => '/'
181 # This no longer seems to be necessary
182 # Turn on NPH scripts by default when running under IIS server!
183 # $NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
184 $IIS++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
186 # Turn on special checking for ActiveState's PerlEx
187 $PERLEX++ if defined($ENV{'GATEWAY_INTERFACE'}) && $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-PerlEx/;
189 # Turn on special checking for Doug MacEachern's modperl
190 # PerlEx::DBI tries to fool DBI by setting MOD_PERL
191 if (exists $ENV{MOD_PERL} && ! $PERLEX) {
192 # mod_perl handlers may run system() on scripts using CGI.pm;
193 # Make sure so we don't get fooled by inherited $ENV{MOD_PERL}
194 if (exists $ENV{MOD_PERL_API_VERSION} && $ENV{MOD_PERL_API_VERSION} == 2) {
196 require Apache2::Response;
197 require Apache2::RequestRec;
198 require Apache2::RequestUtil;
199 require Apache2::RequestIO;
207 # Define the CRLF sequence. I can't use a simple "\r\n" because the meaning
208 # of "\n" is different on different OS's (sometimes it generates CRLF, sometimes LF
209 # and sometimes CR). The most popular VMS web server
210 # doesn't accept CRLF -- instead it wants a LR. EBCDIC machines don't
211 # use ASCII, so \015\012 means something different. I find this all
213 $EBCDIC = "\t" ne "\011";
222 if ($needs_binmode) {
223 $CGI::DefaultClass->binmode(\*main::STDOUT);
224 $CGI::DefaultClass->binmode(\*main::STDIN);
225 $CGI::DefaultClass->binmode(\*main::STDERR);
229 ':html2'=>['h1'..'h6',qw/p br hr ol ul li dl dt dd menu code var strong em
230 tt u i b blockquote pre img a address cite samp dfn html head
231 base body Link nextid title meta kbd start_html end_html
232 input Select option comment charset escapeHTML/],
233 ':html3'=>[qw/div table caption th td TR Tr sup Sub strike applet Param nobr
234 embed basefont style span layer ilayer font frameset frame script small big Area Map/],
235 ':html4'=>[qw/abbr acronym bdo col colgroup del fieldset iframe
236 ins label legend noframes noscript object optgroup Q
238 ':netscape'=>[qw/blink fontsize center/],
239 ':form'=>[qw/textfield textarea filefield password_field hidden checkbox checkbox_group
240 submit reset defaults radio_group popup_menu button autoEscape
241 scrolling_list image_button start_form end_form startform endform
242 start_multipart_form end_multipart_form isindex tmpFileName uploadInfo URL_ENCODED MULTIPART/],
243 ':cgi'=>[qw/param upload path_info path_translated request_uri url self_url script_name
245 raw_cookie request_method query_string Accept user_agent remote_host content_type
246 remote_addr referer server_name server_software server_port server_protocol virtual_port
247 virtual_host remote_ident auth_type http append
248 save_parameters restore_parameters param_fetch
249 remote_user user_name header redirect import_names put
250 Delete Delete_all url_param cgi_error/],
251 ':ssl' => [qw/https/],
252 ':cgi-lib' => [qw/ReadParse PrintHeader HtmlTop HtmlBot SplitParam Vars/],
253 ':html' => [qw/:html2 :html3 :html4 :netscape/],
254 ':standard' => [qw/:html2 :html3 :html4 :form :cgi/],
255 ':push' => [qw/multipart_init multipart_start multipart_end multipart_final/],
256 ':all' => [qw/:html2 :html3 :netscape :form :cgi :internal :html4/]
259 # Custom 'can' method for both autoloaded and non-autoloaded subroutines.
260 # Author: Cees Hek <cees@sitesuite.com.au>
263 my($class, $method) = @_;
265 # See if UNIVERSAL::can finds it.
267 if (my $func = $class -> SUPER::can($method) ){
271 # Try to compile the function.
274 # _compile looks at $AUTOLOAD for the function name.
276 local $AUTOLOAD = join "::", $class, $method;
280 # Now that the function is loaded (if it exists)
281 # just use UNIVERSAL::can again to do the work.
283 return $class -> SUPER::can($method);
286 # to import symbols into caller
290 # This causes modules to clash.
294 $self->_setup_symbols(@_);
295 my ($callpack, $callfile, $callline) = caller;
297 # To allow overriding, search through the packages
298 # Till we find one in which the correct subroutine is defined.
299 my @packages = ($self,@{"$self\:\:ISA"});
300 for $sym (keys %EXPORT) {
302 my $def = ${"$self\:\:AutoloadClass"} || $DefaultClass;
303 for $pck (@packages) {
304 if (defined(&{"$pck\:\:$sym"})) {
309 *{"${callpack}::$sym"} = \&{"$def\:\:$sym"};
315 $pack->_setup_symbols('-compile',@_);
320 return ("start_$1","end_$1") if $tag=~/^(?:\*|start_|end_)(.+)/;
322 return ($tag) unless $EXPORT_TAGS{$tag};
323 for (@{$EXPORT_TAGS{$tag}}) {
324 push(@r,&expand_tags($_));
330 # The new routine. This will check the current environment
331 # for an existing query string, and initialize itself, if so.
334 my($class,@initializer) = @_;
337 bless $self,ref $class || $class || $DefaultClass;
339 # always use a tempfile
340 $self->{'use_tempfile'} = 1;
342 if (ref($initializer[0])
343 && (UNIVERSAL::isa($initializer[0],'Apache')
345 UNIVERSAL::isa($initializer[0],'Apache2::RequestRec')
347 $self->r(shift @initializer);
349 if (ref($initializer[0])
350 && (UNIVERSAL::isa($initializer[0],'CODE'))) {
351 $self->upload_hook(shift @initializer, shift @initializer);
352 $self->{'use_tempfile'} = shift @initializer if (@initializer > 0);
355 if ($MOD_PERL == 1) {
356 $self->r(Apache->request) unless $self->r;
358 $r->register_cleanup(\&CGI::_reset_globals);
359 $self->_setup_symbols(@SAVED_SYMBOLS) if @SAVED_SYMBOLS;
362 # XXX: once we have the new API
363 # will do a real PerlOptions -SetupEnv check
364 $self->r(Apache2::RequestUtil->request) unless $self->r;
366 $r->subprocess_env unless exists $ENV{REQUEST_METHOD};
367 $r->pool->cleanup_register(\&CGI::_reset_globals);
368 $self->_setup_symbols(@SAVED_SYMBOLS) if @SAVED_SYMBOLS;
372 $self->_reset_globals if $PERLEX;
373 $self->init(@initializer);
377 # We provide a DESTROY method so that we can ensure that
378 # temporary files are closed (via Fh->DESTROY) before they
379 # are unlinked (via CGITempFile->DESTROY) because it is not
380 # possible to unlink an open file on Win32. We explicitly
381 # call DESTROY on each, rather than just undefing them and
382 # letting Perl DESTROY them by garbage collection, in case the
383 # user is still holding any reference to them as well.
386 if ($OS eq 'WINDOWS') {
387 for my $href (values %{$self->{'.tmpfiles'}}) {
388 $href->{hndl}->DESTROY if defined $href->{hndl};
389 $href->{name}->DESTROY if defined $href->{name};
396 my $r = $self->{'.r'};
397 $self->{'.r'} = shift if @_;
403 if (ref $_[0] eq 'CODE') {
404 $CGI::Q = $self = $CGI::DefaultClass->new(@_);
408 my ($hook,$data,$use_tempfile) = @_;
409 $self->{'.upload_hook'} = $hook;
410 $self->{'.upload_data'} = $data;
411 $self->{'use_tempfile'} = $use_tempfile if defined $use_tempfile;
415 # Returns the value(s)of a named parameter.
416 # If invoked in a list context, returns the
417 # entire list. Otherwise returns the first
418 # member of the list.
419 # If name is not provided, return a list of all
420 # the known parameters names available.
421 # If more than one argument is provided, the
422 # second and subsequent arguments are used to
423 # set the value of the parameter.
426 my($self,@p) = self_or_default(@_);
427 return $self->all_parameters unless @p;
428 my($name,$value,@other);
430 # For compatibility between old calling style and use_named_parameters() style,
431 # we have to special case for a single parameter present.
433 ($name,$value,@other) = rearrange([NAME,[DEFAULT,VALUE,VALUES]],@p);
436 if (substr($p[0],0,1) eq '-') {
437 @values = defined($value) ? (ref($value) && ref($value) eq 'ARRAY' ? @{$value} : $value) : ();
439 for ($value,@other) {
440 push(@values,$_) if defined($_);
443 # If values is provided, then we set it.
444 if (@values or defined $value) {
445 $self->add_parameter($name);
446 $self->{param}{$name}=[@values];
452 return unless defined($name) && $self->{param}{$name};
454 my @result = @{$self->{param}{$name}};
457 eval "require Encode; 1;" unless Encode->can('decode'); # bring in these functions
458 @result = map {ref $_ ? $_ : Encode::decode(utf8=>$_) } @result;
461 return wantarray ? @result : $result[0];
464 sub self_or_default {
465 return @_ if defined($_[0]) && (!ref($_[0])) &&($_[0] eq 'CGI');
466 unless (defined($_[0]) &&
467 (ref($_[0]) eq 'CGI' || UNIVERSAL::isa($_[0],'CGI')) # slightly optimized for common case
469 $Q = $CGI::DefaultClass->new unless defined($Q);
472 return wantarray ? @_ : $Q;
476 local $^W=0; # prevent a warning
477 if (defined($_[0]) &&
478 (substr(ref($_[0]),0,3) eq 'CGI'
479 || UNIVERSAL::isa($_[0],'CGI'))) {
482 return ($DefaultClass,@_);
486 ########################################
487 # THESE METHODS ARE MORE OR LESS PRIVATE
488 # GO TO THE __DATA__ SECTION TO SEE MORE
490 ########################################
492 # Initialize the query object from the environment.
493 # If a parameter list is found, this object will be set
494 # to a hash in which parameter names are keys
495 # and the values are stored as lists
496 # If a keyword list is found, this method creates a bogus
497 # parameter list with the single parameter 'keywords'.
501 my($query_string,$meth,$content_length,$fh,@lines) = ('','','','');
505 my $initializer = shift; # for backward compatibility
508 # set autoescaping on by default
509 $self->{'escape'} = 1;
511 # if we get called more than once, we want to initialize
512 # ourselves from the original query (which may be gone
513 # if it was read from STDIN originally.)
514 if (defined(@QUERY_PARAM) && !defined($initializer)) {
515 for my $name (@QUERY_PARAM) {
516 my $val = $QUERY_PARAM{$name}; # always an arrayref;
517 $self->param('-name'=>$name,'-value'=> $val);
518 if (defined $val and ref $val eq 'ARRAY') {
519 for my $fh (grep {defined(fileno($_))} @$val) {
520 seek($fh,0,0); # reset the filehandle.
525 $self->charset($QUERY_CHARSET);
526 $self->{'.fieldnames'} = {%QUERY_FIELDNAMES};
527 $self->{'.tmpfiles'} = {%QUERY_TMPFILES};
531 $meth=$ENV{'REQUEST_METHOD'} if defined($ENV{'REQUEST_METHOD'});
532 $content_length = defined($ENV{'CONTENT_LENGTH'}) ? $ENV{'CONTENT_LENGTH'} : 0;
534 $fh = to_filehandle($initializer) if $initializer;
536 # set charset to the safe ISO-8859-1
537 $self->charset('ISO-8859-1');
541 # avoid unreasonably large postings
542 if (($POST_MAX > 0) && ($content_length > $POST_MAX)) {
543 #discard the post, unread
544 $self->cgi_error("413 Request entity too large");
548 # Process multipart postings, but only if the initializer is
551 && defined($ENV{'CONTENT_TYPE'})
552 && $ENV{'CONTENT_TYPE'}=~m|^multipart/form-data|
553 && !defined($initializer)
555 my($boundary) = $ENV{'CONTENT_TYPE'} =~ /boundary=\"?([^\";,]+)\"?/;
556 $self->read_multipart($boundary,$content_length);
560 # Process XForms postings. We know that we have XForms in the
562 # method eq 'POST' && content-type eq 'application/xml'
563 # method eq 'POST' && content-type =~ /multipart\/related.+start=/
564 # There are more cases, actually, but for now, we don't support other
565 # methods for XForm posts.
566 # In a XForm POST, the QUERY_STRING is parsed normally.
567 # If the content-type is 'application/xml', we just set the param
568 # XForms:Model (referring to the xml syntax) param containing the
570 # In the case of multipart/related we set XForms:Model as above, but
571 # the other parts are available as uploads with the Content-ID as the
573 # See the URL below for XForms specs on this issue.
574 # http://www.w3.org/TR/2006/REC-xforms-20060314/slice11.html#submit-options
575 if ($meth eq 'POST' && defined($ENV{'CONTENT_TYPE'})) {
576 if ($ENV{'CONTENT_TYPE'} eq 'application/xml') {
577 my($param) = 'XForms:Model';
579 $self->add_parameter($param);
580 $self->read_from_client(\$value,$content_length,0)
581 if $content_length > 0;
582 push (@{$self->{param}{$param}},$value);
584 } elsif ($ENV{'CONTENT_TYPE'} =~ /multipart\/related.+boundary=\"?([^\";,]+)\"?.+start=\"?\<?([^\"\>]+)\>?\"?/) {
585 my($boundary,$start) = ($1,$2);
586 my($param) = 'XForms:Model';
587 $self->add_parameter($param);
588 my($value) = $self->read_multipart_related($start,$boundary,$content_length,0);
589 push (@{$self->{param}{$param}},$value);
591 $query_string = $self->r->args;
593 $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
594 $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'};
601 # If initializer is defined, then read parameters
603 if (!$is_xforms && defined($initializer)) {
604 if (UNIVERSAL::isa($initializer,'CGI')) {
605 $query_string = $initializer->query_string;
608 if (ref($initializer) && ref($initializer) eq 'HASH') {
609 for (keys %$initializer) {
610 $self->param('-name'=>$_,'-value'=>$initializer->{$_});
615 if (defined($fh) && ($fh ne '')) {
621 # massage back into standard format
622 if ("@lines" =~ /=/) {
623 $query_string=join("&",@lines);
625 $query_string=join("+",@lines);
630 # last chance -- treat it as a string
631 $initializer = $$initializer if ref($initializer) eq 'SCALAR';
632 $query_string = $initializer;
637 # If method is GET or HEAD, fetch the query from
639 if ($is_xforms || $meth=~/^(GET|HEAD)$/) {
641 $query_string = $self->r->args;
643 $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
644 $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'};
649 if ($meth eq 'POST' || $meth eq 'PUT') {
650 if ( $content_length > 0 ) {
651 $self->read_from_client(\$query_string,$content_length,0);
654 $self->read_from_stdin(\$query_string);
655 # should this be PUTDATA in case of PUT ?
656 my($param) = $meth . 'DATA' ;
657 $self->add_parameter($param) ;
658 push (@{$self->{param}{$param}},$query_string);
659 undef $query_string ;
661 # Some people want to have their cake and eat it too!
662 # Uncomment this line to have the contents of the query string
663 # APPENDED to the POST data.
664 # $query_string .= (length($query_string) ? '&' : '') . $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'};
668 # If $meth is not of GET, POST, PUT or HEAD, assume we're
669 # being debugged offline.
670 # Check the command line and then the standard input for data.
671 # We use the shellwords package in order to behave the way that
672 # UN*X programmers expect.
675 my $cmdline_ret = read_from_cmdline();
676 $query_string = $cmdline_ret->{'query_string'};
677 if (defined($cmdline_ret->{'subpath'}))
679 $self->path_info($cmdline_ret->{'subpath'});
684 # YL: Begin Change for XML handler 10/19/2001
685 if (!$is_xforms && ($meth eq 'POST' || $meth eq 'PUT')
686 && defined($ENV{'CONTENT_TYPE'})
687 && $ENV{'CONTENT_TYPE'} !~ m|^application/x-www-form-urlencoded|
688 && $ENV{'CONTENT_TYPE'} !~ m|^multipart/form-data| ) {
689 my($param) = $meth . 'DATA' ;
690 $self->add_parameter($param) ;
691 push (@{$self->{param}{$param}},$query_string);
692 undef $query_string ;
694 # YL: End Change for XML handler 10/19/2001
696 # We now have the query string in hand. We do slightly
697 # different things for keyword lists and parameter lists.
698 if (defined $query_string && length $query_string) {
699 if ($query_string =~ /[&=;]/) {
700 $self->parse_params($query_string);
702 $self->add_parameter('keywords');
703 $self->{param}{'keywords'} = [$self->parse_keywordlist($query_string)];
707 # Special case. Erase everything if there is a field named
709 if ($self->param('.defaults')) {
713 # hash containing our defined fieldnames
714 $self->{'.fieldnames'} = {};
715 for ($self->param('.cgifields')) {
716 $self->{'.fieldnames'}->{$_}++;
719 # Clear out our default submission button flag if present
720 $self->delete('.submit');
721 $self->delete('.cgifields');
723 $self->save_request unless defined $initializer;
726 # FUNCTIONS TO OVERRIDE:
727 # Turn a string into a filehandle
730 return undef unless $thingy;
731 return $thingy if UNIVERSAL::isa($thingy,'GLOB');
732 return $thingy if UNIVERSAL::isa($thingy,'FileHandle');
735 while (my $package = caller($caller++)) {
736 my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy";
737 return $tmp if defined(fileno($tmp));
743 # send output to the browser
745 my($self,@p) = self_or_default(@_);
749 # print to standard output (for overriding in mod_perl)
755 # get/set last cgi_error
757 my ($self,$err) = self_or_default(@_);
758 $self->{'.cgi_error'} = $err if defined $err;
759 return $self->{'.cgi_error'};
764 # We're going to play with the package globals now so that if we get called
765 # again, we initialize ourselves in exactly the same way. This allows
766 # us to have several of these objects.
767 @QUERY_PARAM = $self->param; # save list of parameters
769 next unless defined $_;
770 $QUERY_PARAM{$_}=$self->{param}{$_};
772 $QUERY_CHARSET = $self->charset;
773 %QUERY_FIELDNAMES = %{$self->{'.fieldnames'}};
774 %QUERY_TMPFILES = %{ $self->{'.tmpfiles'} || {} };
778 my($self,$tosplit) = @_;
779 my(@pairs) = split(/[&;]/,$tosplit);
782 ($param,$value) = split('=',$_,2);
783 next unless defined $param;
784 next if $NO_UNDEF_PARAMS and not defined $value;
785 $value = '' unless defined $value;
786 $param = unescape($param);
787 $value = unescape($value);
788 $self->add_parameter($param);
789 push (@{$self->{param}{$param}},$value);
795 return unless defined $param;
796 push (@{$self->{'.parameters'}},$param)
797 unless defined($self->{param}{$param});
802 return () unless defined($self) && $self->{'.parameters'};
803 return () unless @{$self->{'.parameters'}};
804 return @{$self->{'.parameters'}};
807 # put a filehandle into binary mode (DOS)
809 return unless defined($_[1]) && defined fileno($_[1]);
810 CORE::binmode($_[1]);
814 my ($self,$tagname) = @_;
817 my (\$q,\$a,\@rest) = self_or_default(\@_);
819 if (ref(\$a) && ref(\$a) eq 'HASH') {
820 my(\@attr) = make_attributes(\$a,\$q->{'escape'});
821 \$attr = " \@attr" if \@attr;
823 unshift \@rest,\$a if defined \$a;
826 if ($tagname=~/start_(\w+)/i) {
827 $func .= qq! return "<\L$1\E\$attr>";} !;
828 } elsif ($tagname=~/end_(\w+)/i) {
829 $func .= qq! return "<\L/$1\E>"; } !;
832 return \$XHTML ? "\L<$tagname\E\$attr />" : "\L<$tagname\E\$attr>" unless \@rest;
833 my(\$tag,\$untag) = ("\L<$tagname\E\$attr>","\L</$tagname>\E");
834 my \@result = map { "\$tag\$_\$untag" }
835 (ref(\$rest[0]) eq 'ARRAY') ? \@{\$rest[0]} : "\@rest";
843 print STDERR "CGI::AUTOLOAD for $AUTOLOAD\n" if $CGI::AUTOLOAD_DEBUG;
844 my $func = &_compile;
849 my($func) = $AUTOLOAD;
850 my($pack,$func_name);
852 local($1,$2); # this fixes an obscure variable suicide problem.
853 $func=~/(.+)::([^:]+)$/;
854 ($pack,$func_name) = ($1,$2);
855 $pack=~s/::SUPER$//; # fix another obscure problem
856 $pack = ${"$pack\:\:AutoloadClass"} || $CGI::DefaultClass
857 unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"});
859 my($sub) = \%{"$pack\:\:SUBS"};
861 my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"};
863 eval "package $pack; $$auto";
864 croak("$AUTOLOAD: $@") if $@;
865 $$auto = ''; # Free the unneeded storage (but don't undef it!!!)
867 my($code) = $sub->{$func_name};
869 $code = "sub $AUTOLOAD { }" if (!$code and $func_name eq 'DESTROY');
871 (my $base = $func_name) =~ s/^(start_|end_)//i;
872 if ($EXPORT{':any'} ||
875 (%EXPORT_OK || grep(++$EXPORT_OK{$_},&expand_tags(':html')))
876 && $EXPORT_OK{$base}) {
877 $code = $CGI::DefaultClass->_make_tag_func($func_name);
880 croak("Undefined subroutine $AUTOLOAD\n") unless $code;
882 eval "package $pack; $code";
885 croak("$AUTOLOAD: $@");
888 CORE::delete($sub->{$func_name}); #free storage
889 return "$pack\:\:$func_name";
895 return '' unless $value;
896 return $XHTML ? qq(selected="selected" ) : qq(selected );
902 return '' unless $value;
903 return $XHTML ? qq(checked="checked" ) : qq(checked );
906 sub _reset_globals { initialize_globals(); }
912 # to avoid reexporting unwanted variables
916 $HEADERS_ONCE++, next if /^[:-]unique_headers$/;
917 $NPH++, next if /^[:-]nph$/;
918 $NOSTICKY++, next if /^[:-]nosticky$/;
919 $DEBUG=0, next if /^[:-]no_?[Dd]ebug$/;
920 $DEBUG=2, next if /^[:-][Dd]ebug$/;
921 $USE_PARAM_SEMICOLONS++, next if /^[:-]newstyle_urls$/;
922 $PARAM_UTF8++, next if /^[:-]utf8$/;
923 $XHTML++, next if /^[:-]xhtml$/;
924 $XHTML=0, next if /^[:-]no_?xhtml$/;
925 $USE_PARAM_SEMICOLONS=0, next if /^[:-]oldstyle_urls$/;
926 $PRIVATE_TEMPFILES++, next if /^[:-]private_tempfiles$/;
927 $TABINDEX++, next if /^[:-]tabindex$/;
928 $CLOSE_UPLOAD_FILES++, next if /^[:-]close_upload_files$/;
929 $EXPORT{$_}++, next if /^[:-]any$/;
930 $compile++, next if /^[:-]compile$/;
931 $NO_UNDEF_PARAMS++, next if /^[:-]no_undef_params$/;
933 # This is probably extremely evil code -- to be deleted some day.
934 if (/^[-]autoload$/) {
935 my($pkg) = caller(1);
936 *{"${pkg}::AUTOLOAD"} = sub {
937 my($routine) = $AUTOLOAD;
938 $routine =~ s/^.*::/CGI::/;
944 for (&expand_tags($_)) {
945 tr/a-zA-Z0-9_//cd; # don't allow weird function names
949 _compile_all(keys %EXPORT) if $compile;
954 my ($self,$charset) = self_or_default(@_);
955 $self->{'.charset'} = $charset if defined $charset;
960 my ($self,$new_value) = self_or_default(@_);
961 $self->{'.elid'} = $new_value if defined $new_value;
962 sprintf('%010d',$self->{'.elid'}++);
966 my ($self,$new_value) = self_or_default(@_);
967 $self->{'.etab'} ||= 1;
968 $self->{'.etab'} = $new_value if defined $new_value;
969 my $tab = $self->{'.etab'}++;
970 return '' unless $TABINDEX or defined $new_value;
971 return qq(tabindex="$tab" );
974 ###############################################################################
975 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
976 ###############################################################################
977 $AUTOLOADED_ROUTINES = ''; # get rid of -w warning
978 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
982 'URL_ENCODED'=> <<'END_OF_FUNC',
983 sub URL_ENCODED { 'application/x-www-form-urlencoded'; }
986 'MULTIPART' => <<'END_OF_FUNC',
987 sub MULTIPART { 'multipart/form-data'; }
990 'SERVER_PUSH' => <<'END_OF_FUNC',
991 sub SERVER_PUSH { 'multipart/x-mixed-replace;boundary="' . shift() . '"'; }
994 'new_MultipartBuffer' => <<'END_OF_FUNC',
995 # Create a new multipart buffer
996 sub new_MultipartBuffer {
997 my($self,$boundary,$length) = @_;
998 return MultipartBuffer->new($self,$boundary,$length);
1002 'read_from_client' => <<'END_OF_FUNC',
1003 # Read data from a file handle
1004 sub read_from_client {
1005 my($self, $buff, $len, $offset) = @_;
1006 local $^W=0; # prevent a warning
1008 ? $self->r->read($$buff, $len, $offset)
1009 : read(\*STDIN, $$buff, $len, $offset);
1013 'read_from_stdin' => <<'END_OF_FUNC',
1014 # Read data from stdin until all is read
1015 sub read_from_stdin {
1016 my($self, $buff) = @_;
1017 local $^W=0; # prevent a warning
1020 # TODO: loop over STDIN until all is read
1028 while ($eoffound == 0) {
1030 $res = $self->r->read($tempbuf, $bufsiz, 0)
1033 $res = read(\*STDIN, $tempbuf, $bufsiz);
1036 if ( !defined($res) ) {
1037 # TODO: how to do error reporting ?
1045 $localbuf .= $tempbuf;
1054 'delete' => <<'END_OF_FUNC',
1056 # Deletes the named parameter entirely.
1059 my($self,@p) = self_or_default(@_);
1060 my(@names) = rearrange([NAME],@p);
1061 my @to_delete = ref($names[0]) eq 'ARRAY' ? @$names[0] : @names;
1063 for my $name (@to_delete)
1065 CORE::delete $self->{param}{$name};
1066 CORE::delete $self->{'.fieldnames'}->{$name};
1067 $to_delete{$name}++;
1069 @{$self->{'.parameters'}}=grep { !exists($to_delete{$_}) } $self->param();
1074 #### Method: import_names
1075 # Import all parameters into the given namespace.
1076 # Assumes namespace 'Q' if not specified
1078 'import_names' => <<'END_OF_FUNC',
1080 my($self,$namespace,$delete) = self_or_default(@_);
1081 $namespace = 'Q' unless defined($namespace);
1082 die "Can't import names into \"main\"\n" if \%{"${namespace}::"} == \%::;
1083 if ($delete || $MOD_PERL || exists $ENV{'FCGI_ROLE'}) {
1084 # can anyone find an easier way to do this?
1085 for (keys %{"${namespace}::"}) {
1086 local *symbol = "${namespace}::${_}";
1092 my($param,@value,$var);
1093 for $param ($self->param) {
1094 # protect against silly names
1095 ($var = $param)=~tr/a-zA-Z0-9_/_/c;
1096 $var =~ s/^(?=\d)/_/;
1097 local *symbol = "${namespace}::$var";
1098 @value = $self->param($param);
1100 $symbol = $value[0];
1105 #### Method: keywords
1106 # Keywords acts a bit differently. Calling it in a list context
1107 # returns the list of keywords.
1108 # Calling it in a scalar context gives you the size of the list.
1110 'keywords' => <<'END_OF_FUNC',
1112 my($self,@values) = self_or_default(@_);
1113 # If values is provided, then we set it.
1114 $self->{param}{'keywords'}=[@values] if @values;
1115 my(@result) = defined($self->{param}{'keywords'}) ? @{$self->{param}{'keywords'}} : ();
1120 # These are some tie() interfaces for compatibility
1121 # with Steve Brenner's cgi-lib.pl routines
1122 'Vars' => <<'END_OF_FUNC',
1127 return %in if wantarray;
1132 # These are some tie() interfaces for compatibility
1133 # with Steve Brenner's cgi-lib.pl routines
1134 'ReadParse' => <<'END_OF_FUNC',
1141 *in=*{"${pkg}::in"};
1144 return scalar(keys %in);
1148 'PrintHeader' => <<'END_OF_FUNC',
1150 my($self) = self_or_default(@_);
1151 return $self->header();
1155 'HtmlTop' => <<'END_OF_FUNC',
1157 my($self,@p) = self_or_default(@_);
1158 return $self->start_html(@p);
1162 'HtmlBot' => <<'END_OF_FUNC',
1164 my($self,@p) = self_or_default(@_);
1165 return $self->end_html(@p);
1169 'SplitParam' => <<'END_OF_FUNC',
1172 my (@params) = split ("\0", $param);
1173 return (wantarray ? @params : $params[0]);
1177 'MethGet' => <<'END_OF_FUNC',
1179 return request_method() eq 'GET';
1183 'MethPost' => <<'END_OF_FUNC',
1185 return request_method() eq 'POST';
1189 'MethPut' => <<'END_OF_FUNC',
1191 return request_method() eq 'PUT';
1195 'TIEHASH' => <<'END_OF_FUNC',
1199 if (ref($arg) && UNIVERSAL::isa($arg,'CGI')) {
1202 return $Q ||= $class->new(@_);
1206 'STORE' => <<'END_OF_FUNC',
1211 my @vals = index($vals,"\0")!=-1 ? split("\0",$vals) : $vals;
1212 $self->param(-name=>$tag,-value=>\@vals);
1216 'FETCH' => <<'END_OF_FUNC',
1218 return $_[0] if $_[1] eq 'CGI';
1219 return undef unless defined $_[0]->param($_[1]);
1220 return join("\0",$_[0]->param($_[1]));
1224 'FIRSTKEY' => <<'END_OF_FUNC',
1226 $_[0]->{'.iterator'}=0;
1227 $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
1231 'NEXTKEY' => <<'END_OF_FUNC',
1233 $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
1237 'EXISTS' => <<'END_OF_FUNC',
1239 exists $_[0]->{param}{$_[1]};
1243 'DELETE' => <<'END_OF_FUNC',
1245 $_[0]->delete($_[1]);
1249 'CLEAR' => <<'END_OF_FUNC',
1257 # Append a new value to an existing query
1259 'append' => <<'EOF',
1261 my($self,@p) = self_or_default(@_);
1262 my($name,$value) = rearrange([NAME,[VALUE,VALUES]],@p);
1263 my(@values) = defined($value) ? (ref($value) ? @{$value} : $value) : ();
1265 $self->add_parameter($name);
1266 push(@{$self->{param}{$name}},@values);
1268 return $self->param($name);
1272 #### Method: delete_all
1273 # Delete all parameters
1275 'delete_all' => <<'EOF',
1277 my($self) = self_or_default(@_);
1278 my @param = $self->param();
1279 $self->delete(@param);
1283 'Delete' => <<'EOF',
1285 my($self,@p) = self_or_default(@_);
1290 'Delete_all' => <<'EOF',
1292 my($self,@p) = self_or_default(@_);
1293 $self->delete_all(@p);
1297 #### Method: autoescape
1298 # If you want to turn off the autoescaping features,
1299 # call this method with undef as the argument
1300 'autoEscape' => <<'END_OF_FUNC',
1302 my($self,$escape) = self_or_default(@_);
1303 my $d = $self->{'escape'};
1304 $self->{'escape'} = $escape;
1310 #### Method: version
1311 # Return the current version
1313 'version' => <<'END_OF_FUNC',
1319 #### Method: url_param
1320 # Return a parameter in the QUERY_STRING, regardless of
1321 # whether this was a POST or a GET
1323 'url_param' => <<'END_OF_FUNC',
1325 my ($self,@p) = self_or_default(@_);
1326 my $name = shift(@p);
1327 return undef unless exists($ENV{QUERY_STRING});
1328 unless (exists($self->{'.url_param'})) {
1329 $self->{'.url_param'}={}; # empty hash
1330 if ($ENV{QUERY_STRING} =~ /=/) {
1331 my(@pairs) = split(/[&;]/,$ENV{QUERY_STRING});
1334 ($param,$value) = split('=',$_,2);
1335 $param = unescape($param);
1336 $value = unescape($value);
1337 push(@{$self->{'.url_param'}->{$param}},$value);
1340 $self->{'.url_param'}->{'keywords'} = [$self->parse_keywordlist($ENV{QUERY_STRING})];
1343 return keys %{$self->{'.url_param'}} unless defined($name);
1344 return () unless $self->{'.url_param'}->{$name};
1345 return wantarray ? @{$self->{'.url_param'}->{$name}}
1346 : $self->{'.url_param'}->{$name}->[0];
1351 # Returns a string in which all the known parameter/value
1352 # pairs are represented as nested lists, mainly for the purposes
1355 'Dump' => <<'END_OF_FUNC',
1357 my($self) = self_or_default(@_);
1358 my($param,$value,@result);
1359 return '<ul></ul>' unless $self->param;
1360 push(@result,"<ul>");
1361 for $param ($self->param) {
1362 my($name)=$self->escapeHTML($param);
1363 push(@result,"<li><strong>$name</strong></li>");
1364 push(@result,"<ul>");
1365 for $value ($self->param($param)) {
1366 $value = $self->escapeHTML($value);
1367 $value =~ s/\n/<br \/>\n/g;
1368 push(@result,"<li>$value</li>");
1370 push(@result,"</ul>");
1372 push(@result,"</ul>");
1373 return join("\n",@result);
1377 #### Method as_string
1379 # synonym for "dump"
1381 'as_string' => <<'END_OF_FUNC',
1388 # Write values out to a filehandle in such a way that they can
1389 # be reinitialized by the filehandle form of the new() method
1391 'save' => <<'END_OF_FUNC',
1393 my($self,$filehandle) = self_or_default(@_);
1394 $filehandle = to_filehandle($filehandle);
1396 local($,) = ''; # set print field separator back to a sane value
1397 local($\) = ''; # set output line separator to a sane value
1398 for $param ($self->param) {
1399 my($escaped_param) = escape($param);
1401 for $value ($self->param($param)) {
1402 print $filehandle "$escaped_param=",escape("$value"),"\n";
1405 for (keys %{$self->{'.fieldnames'}}) {
1406 print $filehandle ".cgifields=",escape("$_"),"\n";
1408 print $filehandle "=\n"; # end of record
1413 #### Method: save_parameters
1414 # An alias for save() that is a better name for exportation.
1415 # Only intended to be used with the function (non-OO) interface.
1417 'save_parameters' => <<'END_OF_FUNC',
1418 sub save_parameters {
1420 return save(to_filehandle($fh));
1424 #### Method: restore_parameters
1425 # A way to restore CGI parameters from an initializer.
1426 # Only intended to be used with the function (non-OO) interface.
1428 'restore_parameters' => <<'END_OF_FUNC',
1429 sub restore_parameters {
1430 $Q = $CGI::DefaultClass->new(@_);
1434 #### Method: multipart_init
1435 # Return a Content-Type: style header for server-push
1436 # This has to be NPH on most web servers, and it is advisable to set $| = 1
1438 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1439 # contribution, updated by Andrew Benham (adsb@bigfoot.com)
1441 'multipart_init' => <<'END_OF_FUNC',
1442 sub multipart_init {
1443 my($self,@p) = self_or_default(@_);
1444 my($boundary,@other) = rearrange_header([BOUNDARY],@p);
1445 $boundary = $boundary || '------- =_aaaaaaaaaa0';
1446 $self->{'separator'} = "$CRLF--$boundary$CRLF";
1447 $self->{'final_separator'} = "$CRLF--$boundary--$CRLF";
1448 $type = SERVER_PUSH($boundary);
1449 return $self->header(
1452 (map { split "=", $_, 2 } @other),
1453 ) . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $self->multipart_end;
1458 #### Method: multipart_start
1459 # Return a Content-Type: style header for server-push, start of section
1461 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1462 # contribution, updated by Andrew Benham (adsb@bigfoot.com)
1464 'multipart_start' => <<'END_OF_FUNC',
1465 sub multipart_start {
1467 my($self,@p) = self_or_default(@_);
1468 my($type,@other) = rearrange([TYPE],@p);
1469 $type = $type || 'text/html';
1470 push(@header,"Content-Type: $type");
1472 # rearrange() was designed for the HTML portion, so we
1473 # need to fix it up a little.
1475 # Don't use \s because of perl bug 21951
1476 next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/;
1477 ($_ = $header) =~ s/^(\w)(.*)/$1 . lc ($2) . ': '.$self->unescapeHTML($value)/e;
1479 push(@header,@other);
1480 my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1486 #### Method: multipart_end
1487 # Return a MIME boundary separator for server-push, end of section
1489 # Many thanks to Ed Jordan <ed@fidalgo.net> for this
1492 'multipart_end' => <<'END_OF_FUNC',
1494 my($self,@p) = self_or_default(@_);
1495 return $self->{'separator'};
1500 #### Method: multipart_final
1501 # Return a MIME boundary separator for server-push, end of all sections
1503 # Contributed by Andrew Benham (adsb@bigfoot.com)
1505 'multipart_final' => <<'END_OF_FUNC',
1506 sub multipart_final {
1507 my($self,@p) = self_or_default(@_);
1508 return $self->{'final_separator'} . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $CRLF;
1514 # Return a Content-Type: style header
1517 'header' => <<'END_OF_FUNC',
1519 my($self,@p) = self_or_default(@_);
1522 return "" if $self->{'.header_printed'}++ and $HEADERS_ONCE;
1524 my($type,$status,$cookie,$target,$expires,$nph,$charset,$attachment,$p3p,@other) =
1525 rearrange([['TYPE','CONTENT_TYPE','CONTENT-TYPE'],
1526 'STATUS',['COOKIE','COOKIES'],'TARGET',
1527 'EXPIRES','NPH','CHARSET',
1528 'ATTACHMENT','P3P'],@p);
1532 $type ||= 'text/html' unless defined($type);
1534 if (defined $charset) {
1535 $self->charset($charset);
1537 $charset = $self->charset if $type =~ /^text\//;
1541 # rearrange() was designed for the HTML portion, so we
1542 # need to fix it up a little.
1544 # Don't use \s because of perl bug 21951
1545 next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/;
1546 ($_ = $header) =~ s/^(\w)(.*)/"\u$1\L$2" . ': '.$self->unescapeHTML($value)/e;
1549 $type .= "; charset=$charset"
1551 and $type !~ /\bcharset\b/
1552 and defined $charset
1555 # Maybe future compatibility. Maybe not.
1556 my $protocol = $ENV{SERVER_PROTOCOL} || 'HTTP/1.0';
1557 push(@header,$protocol . ' ' . ($status || '200 OK')) if $nph;
1558 push(@header,"Server: " . &server_software()) if $nph;
1560 push(@header,"Status: $status") if $status;
1561 push(@header,"Window-Target: $target") if $target;
1563 $p3p = join ' ',@$p3p if ref($p3p) eq 'ARRAY';
1564 push(@header,qq(P3P: policyref="/w3c/p3p.xml", CP="$p3p"));
1566 # push all the cookies -- there may be several
1568 my(@cookie) = ref($cookie) && ref($cookie) eq 'ARRAY' ? @{$cookie} : $cookie;
1570 my $cs = UNIVERSAL::isa($_,'CGI::Cookie') ? $_->as_string : $_;
1571 push(@header,"Set-Cookie: $cs") if $cs ne '';
1574 # if the user indicates an expiration time, then we need
1575 # both an Expires and a Date header (so that the browser is
1577 push(@header,"Expires: " . expires($expires,'http'))
1579 push(@header,"Date: " . expires(0,'http')) if $expires || $cookie || $nph;
1580 push(@header,"Pragma: no-cache") if $self->cache();
1581 push(@header,"Content-Disposition: attachment; filename=\"$attachment\"") if $attachment;
1582 push(@header,map {ucfirst $_} @other);
1583 push(@header,"Content-Type: $type") if $type ne '';
1584 my $header = join($CRLF,@header)."${CRLF}${CRLF}";
1585 if (($MOD_PERL >= 1) && !$nph) {
1586 $self->r->send_cgi_header($header);
1595 # Control whether header() will produce the no-cache
1598 'cache' => <<'END_OF_FUNC',
1600 my($self,$new_value) = self_or_default(@_);
1601 $new_value = '' unless $new_value;
1602 if ($new_value ne '') {
1603 $self->{'cache'} = $new_value;
1605 return $self->{'cache'};
1610 #### Method: redirect
1611 # Return a Location: style header
1614 'redirect' => <<'END_OF_FUNC',
1616 my($self,@p) = self_or_default(@_);
1617 my($url,$target,$status,$cookie,$nph,@other) =
1618 rearrange([[LOCATION,URI,URL],TARGET,STATUS,['COOKIE','COOKIES'],NPH],@p);
1619 $status = '302 Found' unless defined $status;
1620 $url ||= $self->self_url;
1622 for (@other) { tr/\"//d; push(@o,split("=",$_,2)); }
1624 '-Status' => $status,
1627 unshift(@o,'-Target'=>$target) if $target;
1628 unshift(@o,'-Type'=>'');
1630 unshift(@unescaped,'-Cookie'=>$cookie) if $cookie;
1631 return $self->header((map {$self->unescapeHTML($_)} @o),@unescaped);
1636 #### Method: start_html
1637 # Canned HTML header
1640 # $title -> (optional) The title for this HTML document (-title)
1641 # $author -> (optional) e-mail address of the author (-author)
1642 # $base -> (optional) if set to true, will enter the BASE address of this document
1643 # for resolving relative references (-base)
1644 # $xbase -> (optional) alternative base at some remote location (-xbase)
1645 # $target -> (optional) target window to load all links into (-target)
1646 # $script -> (option) Javascript code (-script)
1647 # $no_script -> (option) Javascript <noscript> tag (-noscript)
1648 # $meta -> (optional) Meta information tags
1649 # $head -> (optional) any other elements you'd like to incorporate into the <head> tag
1650 # (a scalar or array ref)
1651 # $style -> (optional) reference to an external style sheet
1652 # @other -> (optional) any other named parameters you'd like to incorporate into
1655 'start_html' => <<'END_OF_FUNC',
1657 my($self,@p) = &self_or_default(@_);
1658 my($title,$author,$base,$xbase,$script,$noscript,
1659 $target,$meta,$head,$style,$dtd,$lang,$encoding,$declare_xml,@other) =
1660 rearrange([TITLE,AUTHOR,BASE,XBASE,SCRIPT,NOSCRIPT,TARGET,
1661 META,HEAD,STYLE,DTD,LANG,ENCODING,DECLARE_XML],@p);
1663 $self->element_id(0);
1664 $self->element_tab(0);
1666 $encoding = lc($self->charset) unless defined $encoding;
1668 # Need to sort out the DTD before it's okay to call escapeHTML().
1669 my(@result,$xml_dtd);
1671 if (defined(ref($dtd)) and (ref($dtd) eq 'ARRAY')) {
1672 $dtd = $DEFAULT_DTD unless $dtd->[0] =~ m|^-//|;
1674 $dtd = $DEFAULT_DTD unless $dtd =~ m|^-//|;
1677 $dtd = $XHTML ? XHTML_DTD : $DEFAULT_DTD;
1680 $xml_dtd++ if ref($dtd) eq 'ARRAY' && $dtd->[0] =~ /\bXHTML\b/i;
1681 $xml_dtd++ if ref($dtd) eq '' && $dtd =~ /\bXHTML\b/i;
1682 push @result,qq(<?xml version="1.0" encoding="$encoding"?>) if $xml_dtd && $declare_xml;
1684 if (ref($dtd) && ref($dtd) eq 'ARRAY') {
1685 push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd->[0]"\n\t "$dtd->[1]">));
1686 $DTD_PUBLIC_IDENTIFIER = $dtd->[0];
1688 push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd">));
1689 $DTD_PUBLIC_IDENTIFIER = $dtd;
1692 # Now that we know whether we're using the HTML 3.2 DTD or not, it's okay to
1693 # call escapeHTML(). Strangely enough, the title needs to be escaped as
1694 # HTML while the author needs to be escaped as a URL.
1695 $title = $self->escapeHTML($title || 'Untitled Document');
1696 $author = $self->escape($author);
1698 if ($DTD_PUBLIC_IDENTIFIER =~ /[^X]HTML (2\.0|3\.2)/i) {
1699 $lang = "" unless defined $lang;
1703 $lang = 'en-US' unless defined $lang;
1706 my $lang_bits = $lang ne '' ? qq( lang="$lang" xml:lang="$lang") : '';
1707 my $meta_bits = qq(<meta http-equiv="Content-Type" content="text/html; charset=$encoding" />)
1708 if $XHTML && $encoding && !$declare_xml;
1710 push(@result,$XHTML ? qq(<html xmlns="http://www.w3.org/1999/xhtml"$lang_bits>\n<head>\n<title>$title</title>)
1711 : ($lang ? qq(<html lang="$lang">) : "<html>")
1712 . "<head><title>$title</title>");
1713 if (defined $author) {
1714 push(@result,$XHTML ? "<link rev=\"made\" href=\"mailto:$author\" />"
1715 : "<link rev=\"made\" href=\"mailto:$author\">");
1718 if ($base || $xbase || $target) {
1719 my $href = $xbase || $self->url('-path'=>1);
1720 my $t = $target ? qq/ target="$target"/ : '';
1721 push(@result,$XHTML ? qq(<base href="$href"$t />) : qq(<base href="$href"$t>));
1724 if ($meta && ref($meta) && (ref($meta) eq 'HASH')) {
1725 for (keys %$meta) { push(@result,$XHTML ? qq(<meta name="$_" content="$meta->{$_}" />)
1726 : qq(<meta name="$_" content="$meta->{$_}">)); }
1729 my $meta_bits_set = 0;
1732 push @result, @$head;
1733 $meta_bits_set = 1 if grep { /http-equiv=["']Content-Type/i }@$head;
1736 push @result, $head;
1737 $meta_bits_set = 1 if $head =~ /http-equiv=["']Content-Type/i;
1741 # handle the infrequently-used -style and -script parameters
1742 push(@result,$self->_style($style)) if defined $style;
1743 push(@result,$self->_script($script)) if defined $script;
1744 push(@result,$meta_bits) if defined $meta_bits and !$meta_bits_set;
1746 # handle -noscript parameter
1747 push(@result,<<END) if $noscript;
1753 my($other) = @other ? " @other" : '';
1754 push(@result,"</head>\n<body$other>\n");
1755 return join("\n",@result);
1760 # internal method for generating a CSS style section
1762 '_style' => <<'END_OF_FUNC',
1764 my ($self,$style) = @_;
1767 my $type = 'text/css';
1768 my $rel = 'stylesheet';
1771 my $cdata_start = $XHTML ? "\n<!--/* <![CDATA[ */" : "\n<!-- ";
1772 my $cdata_end = $XHTML ? "\n/* ]]> */-->\n" : " -->\n";
1774 my @s = ref($style) eq 'ARRAY' ? @$style : $style;
1779 my($src,$code,$verbatim,$stype,$alternate,$foo,@other) =
1780 rearrange([qw(SRC CODE VERBATIM TYPE ALTERNATE FOO)],
1782 ref($s) eq 'ARRAY' ? @$s : %$s));
1783 my $type = defined $stype ? $stype : 'text/css';
1784 my $rel = $alternate ? 'alternate stylesheet' : 'stylesheet';
1785 $other = "@other" if @other;
1787 if (ref($src) eq "ARRAY") # Check to see if the $src variable is an array reference
1788 { # If it is, push a LINK tag for each one
1791 push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>)
1792 : qq(<link rel="$rel" type="$type" href="$src"$other>)) if $src;
1796 { # Otherwise, push the single -src, if it exists.
1797 push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>)
1798 : qq(<link rel="$rel" type="$type" href="$src"$other>)
1802 my @v = ref($verbatim) eq 'ARRAY' ? @$verbatim : $verbatim;
1803 push(@result, "<style type=\"text/css\">\n$_\n</style>") for @v;
1805 my @c = ref($code) eq 'ARRAY' ? @$code : $code if $code;
1806 push(@result,style({'type'=>$type},"$cdata_start\n$_\n$cdata_end")) for @c;
1810 push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>)
1811 : qq(<link rel="$rel" type="$type" href="$src"$other>));
1818 '_script' => <<'END_OF_FUNC',
1820 my ($self,$script) = @_;
1823 my (@scripts) = ref($script) eq 'ARRAY' ? @$script : ($script);
1824 for $script (@scripts) {
1825 my($src,$code,$language);
1826 if (ref($script)) { # script is a hash
1827 ($src,$code,$type) =
1828 rearrange(['SRC','CODE',['LANGUAGE','TYPE']],
1829 '-foo'=>'bar', # a trick to allow the '-' to be omitted
1830 ref($script) eq 'ARRAY' ? @$script : %$script);
1831 $type ||= 'text/javascript';
1832 unless ($type =~ m!\w+/\w+!) {
1833 $type =~ s/[\d.]+$//;
1834 $type = "text/$type";
1837 ($src,$code,$type) = ('',$script, 'text/javascript');
1840 my $comment = '//'; # javascript by default
1841 $comment = '#' if $type=~/perl|tcl/i;
1842 $comment = "'" if $type=~/vbscript/i;
1844 my ($cdata_start,$cdata_end);
1846 $cdata_start = "$comment<![CDATA[\n";
1847 $cdata_end .= "\n$comment]]>";
1849 $cdata_start = "\n<!-- Hide script\n";
1850 $cdata_end = $comment;
1851 $cdata_end .= " End script hiding -->\n";
1854 push(@satts,'src'=>$src) if $src;
1855 push(@satts,'type'=>$type);
1856 $code = $cdata_start . $code . $cdata_end if defined $code;
1857 push(@result,$self->script({@satts},$code || ''));
1863 #### Method: end_html
1864 # End an HTML document.
1865 # Trivial method for completeness. Just returns "</body>"
1867 'end_html' => <<'END_OF_FUNC',
1869 return "\n</body>\n</html>";
1874 ################################
1875 # METHODS USED IN BUILDING FORMS
1876 ################################
1878 #### Method: isindex
1879 # Just prints out the isindex tag.
1881 # $action -> optional URL of script to run
1883 # A string containing a <isindex> tag
1884 'isindex' => <<'END_OF_FUNC',
1886 my($self,@p) = self_or_default(@_);
1887 my($action,@other) = rearrange([ACTION],@p);
1888 $action = qq/ action="$action"/ if $action;
1889 my($other) = @other ? " @other" : '';
1890 return $XHTML ? "<isindex$action$other />" : "<isindex$action$other>";
1895 #### Method: startform
1898 # $method -> optional submission method to use (GET or POST)
1899 # $action -> optional URL of script to run
1900 # $enctype ->encoding to use (URL_ENCODED or MULTIPART)
1901 'startform' => <<'END_OF_FUNC',
1903 my($self,@p) = self_or_default(@_);
1905 my($method,$action,$enctype,@other) =
1906 rearrange([METHOD,ACTION,ENCTYPE],@p);
1908 $method = $self->escapeHTML(lc($method || 'post'));
1909 $enctype = $self->escapeHTML($enctype || &URL_ENCODED);
1910 if (defined $action) {
1911 $action = $self->escapeHTML($action);
1914 $action = $self->escapeHTML($self->request_uri || $self->self_url);
1916 $action = qq(action="$action");
1917 my($other) = @other ? " @other" : '';
1918 $self->{'.parametersToAdd'}={};
1919 return qq/<form method="$method" $action enctype="$enctype"$other>\n/;
1924 #### Method: start_form
1925 # synonym for startform
1926 'start_form' => <<'END_OF_FUNC',
1928 $XHTML ? &start_multipart_form : &startform;
1932 'end_multipart_form' => <<'END_OF_FUNC',
1933 sub end_multipart_form {
1938 #### Method: start_multipart_form
1939 # synonym for startform
1940 'start_multipart_form' => <<'END_OF_FUNC',
1941 sub start_multipart_form {
1942 my($self,@p) = self_or_default(@_);
1943 if (defined($p[0]) && substr($p[0],0,1) eq '-') {
1944 return $self->startform(-enctype=>&MULTIPART,@p);
1946 my($method,$action,@other) =
1947 rearrange([METHOD,ACTION],@p);
1948 return $self->startform($method,$action,&MULTIPART,@other);
1954 #### Method: endform
1956 'endform' => <<'END_OF_FUNC',
1958 my($self,@p) = self_or_default(@_);
1960 return wantarray ? ("</form>") : "\n</form>";
1962 if (my @fields = $self->get_fields) {
1963 return wantarray ? ("<div>",@fields,"</div>","</form>")
1964 : "<div>".(join '',@fields)."</div>\n</form>";
1973 '_textfield' => <<'END_OF_FUNC',
1975 my($self,$tag,@p) = self_or_default(@_);
1976 my($name,$default,$size,$maxlength,$override,$tabindex,@other) =
1977 rearrange([NAME,[DEFAULT,VALUE,VALUES],SIZE,MAXLENGTH,[OVERRIDE,FORCE],TABINDEX],@p);
1979 my $current = $override ? $default :
1980 (defined($self->param($name)) ? $self->param($name) : $default);
1982 $current = defined($current) ? $self->escapeHTML($current,1) : '';
1983 $name = defined($name) ? $self->escapeHTML($name) : '';
1984 my($s) = defined($size) ? qq/ size="$size"/ : '';
1985 my($m) = defined($maxlength) ? qq/ maxlength="$maxlength"/ : '';
1986 my($other) = @other ? " @other" : '';
1987 # this entered at cristy's request to fix problems with file upload fields
1988 # and WebTV -- not sure it won't break stuff
1989 my($value) = $current ne '' ? qq(value="$current") : '';
1990 $tabindex = $self->element_tab($tabindex);
1991 return $XHTML ? qq(<input type="$tag" name="$name" $tabindex$value$s$m$other />)
1992 : qq(<input type="$tag" name="$name" $value$s$m$other>);
1996 #### Method: textfield
1998 # $name -> Name of the text field
1999 # $default -> Optional default value of the field if not
2001 # $size -> Optional width of field in characaters.
2002 # $maxlength -> Optional maximum number of characters.
2004 # A string containing a <input type="text"> field
2006 'textfield' => <<'END_OF_FUNC',
2008 my($self,@p) = self_or_default(@_);
2009 $self->_textfield('text',@p);
2014 #### Method: filefield
2016 # $name -> Name of the file upload field
2017 # $size -> Optional width of field in characaters.
2018 # $maxlength -> Optional maximum number of characters.
2020 # A string containing a <input type="file"> field
2022 'filefield' => <<'END_OF_FUNC',
2024 my($self,@p) = self_or_default(@_);
2025 $self->_textfield('file',@p);
2030 #### Method: password
2031 # Create a "secret password" entry field
2033 # $name -> Name of the field
2034 # $default -> Optional default value of the field if not
2036 # $size -> Optional width of field in characters.
2037 # $maxlength -> Optional maximum characters that can be entered.
2039 # A string containing a <input type="password"> field
2041 'password_field' => <<'END_OF_FUNC',
2042 sub password_field {
2043 my ($self,@p) = self_or_default(@_);
2044 $self->_textfield('password',@p);
2048 #### Method: textarea
2050 # $name -> Name of the text field
2051 # $default -> Optional default value of the field if not
2053 # $rows -> Optional number of rows in text area
2054 # $columns -> Optional number of columns in text area
2056 # A string containing a <textarea></textarea> tag
2058 'textarea' => <<'END_OF_FUNC',
2060 my($self,@p) = self_or_default(@_);
2061 my($name,$default,$rows,$cols,$override,$tabindex,@other) =
2062 rearrange([NAME,[DEFAULT,VALUE],ROWS,[COLS,COLUMNS],[OVERRIDE,FORCE],TABINDEX],@p);
2064 my($current)= $override ? $default :
2065 (defined($self->param($name)) ? $self->param($name) : $default);
2067 $name = defined($name) ? $self->escapeHTML($name) : '';
2068 $current = defined($current) ? $self->escapeHTML($current) : '';
2069 my($r) = $rows ? qq/ rows="$rows"/ : '';
2070 my($c) = $cols ? qq/ cols="$cols"/ : '';
2071 my($other) = @other ? " @other" : '';
2072 $tabindex = $self->element_tab($tabindex);
2073 return qq{<textarea name="$name" $tabindex$r$c$other>$current</textarea>};
2079 # Create a javascript button.
2081 # $name -> (optional) Name for the button. (-name)
2082 # $value -> (optional) Value of the button when selected (and visible name) (-value)
2083 # $onclick -> (optional) Text of the JavaScript to run when the button is
2086 # A string containing a <input type="button"> tag
2088 'button' => <<'END_OF_FUNC',
2090 my($self,@p) = self_or_default(@_);
2092 my($label,$value,$script,$tabindex,@other) = rearrange([NAME,[VALUE,LABEL],
2093 [ONCLICK,SCRIPT],TABINDEX],@p);
2095 $label=$self->escapeHTML($label);
2096 $value=$self->escapeHTML($value,1);
2097 $script=$self->escapeHTML($script);
2100 $name = qq/ name="$label"/ if $label;
2101 $value = $value || $label;
2103 $val = qq/ value="$value"/ if $value;
2104 $script = qq/ onclick="$script"/ if $script;
2105 my($other) = @other ? " @other" : '';
2106 $tabindex = $self->element_tab($tabindex);
2107 return $XHTML ? qq(<input type="button" $tabindex$name$val$script$other />)
2108 : qq(<input type="button"$name$val$script$other>);
2114 # Create a "submit query" button.
2116 # $name -> (optional) Name for the button.
2117 # $value -> (optional) Value of the button when selected (also doubles as label).
2118 # $label -> (optional) Label printed on the button(also doubles as the value).
2120 # A string containing a <input type="submit"> tag
2122 'submit' => <<'END_OF_FUNC',
2124 my($self,@p) = self_or_default(@_);
2126 my($label,$value,$tabindex,@other) = rearrange([NAME,[VALUE,LABEL],TABINDEX],@p);
2128 $label=$self->escapeHTML($label);
2129 $value=$self->escapeHTML($value,1);
2131 my $name = $NOSTICKY ? '' : 'name=".submit" ';
2132 $name = qq/name="$label" / if defined($label);
2133 $value = defined($value) ? $value : $label;
2135 $val = qq/value="$value" / if defined($value);
2136 $tabindex = $self->element_tab($tabindex);
2137 my($other) = @other ? "@other " : '';
2138 return $XHTML ? qq(<input type="submit" $tabindex$name$val$other/>)
2139 : qq(<input type="submit" $name$val$other>);
2145 # Create a "reset" button.
2147 # $name -> (optional) Name for the button.
2149 # A string containing a <input type="reset"> tag
2151 'reset' => <<'END_OF_FUNC',
2153 my($self,@p) = self_or_default(@_);
2154 my($label,$value,$tabindex,@other) = rearrange(['NAME',['VALUE','LABEL'],TABINDEX],@p);
2155 $label=$self->escapeHTML($label);
2156 $value=$self->escapeHTML($value,1);
2157 my ($name) = ' name=".reset"';
2158 $name = qq/ name="$label"/ if defined($label);
2159 $value = defined($value) ? $value : $label;
2161 $val = qq/ value="$value"/ if defined($value);
2162 my($other) = @other ? " @other" : '';
2163 $tabindex = $self->element_tab($tabindex);
2164 return $XHTML ? qq(<input type="reset" $tabindex$name$val$other />)
2165 : qq(<input type="reset"$name$val$other>);
2170 #### Method: defaults
2171 # Create a "defaults" button.
2173 # $name -> (optional) Name for the button.
2175 # A string containing a <input type="submit" name=".defaults"> tag
2177 # Note: this button has a special meaning to the initialization script,
2178 # and tells it to ERASE the current query string so that your defaults
2181 'defaults' => <<'END_OF_FUNC',
2183 my($self,@p) = self_or_default(@_);
2185 my($label,$tabindex,@other) = rearrange([[NAME,VALUE],TABINDEX],@p);
2187 $label=$self->escapeHTML($label,1);
2188 $label = $label || "Defaults";
2189 my($value) = qq/ value="$label"/;
2190 my($other) = @other ? " @other" : '';
2191 $tabindex = $self->element_tab($tabindex);
2192 return $XHTML ? qq(<input type="submit" name=".defaults" $tabindex$value$other />)
2193 : qq/<input type="submit" NAME=".defaults"$value$other>/;
2198 #### Method: comment
2199 # Create an HTML <!-- comment -->
2200 # Parameters: a string
2201 'comment' => <<'END_OF_FUNC',
2203 my($self,@p) = self_or_CGI(@_);
2204 return "<!-- @p -->";
2208 #### Method: checkbox
2209 # Create a checkbox that is not logically linked to any others.
2210 # The field value is "on" when the button is checked.
2212 # $name -> Name of the checkbox
2213 # $checked -> (optional) turned on by default if true
2214 # $value -> (optional) value of the checkbox, 'on' by default
2215 # $label -> (optional) a user-readable label printed next to the box.
2216 # Otherwise the checkbox name is used.
2218 # A string containing a <input type="checkbox"> field
2220 'checkbox' => <<'END_OF_FUNC',
2222 my($self,@p) = self_or_default(@_);
2224 my($name,$checked,$value,$label,$labelattributes,$override,$tabindex,@other) =
2225 rearrange([NAME,[CHECKED,SELECTED,ON],VALUE,LABEL,LABELATTRIBUTES,
2226 [OVERRIDE,FORCE],TABINDEX],@p);
2228 $value = defined $value ? $value : 'on';
2230 if (!$override && ($self->{'.fieldnames'}->{$name} ||
2231 defined $self->param($name))) {
2232 $checked = grep($_ eq $value,$self->param($name)) ? $self->_checked(1) : '';
2234 $checked = $self->_checked($checked);
2236 my($the_label) = defined $label ? $label : $name;
2237 $name = $self->escapeHTML($name);
2238 $value = $self->escapeHTML($value,1);
2239 $the_label = $self->escapeHTML($the_label);
2240 my($other) = @other ? "@other " : '';
2241 $tabindex = $self->element_tab($tabindex);
2242 $self->register_parameter($name);
2243 return $XHTML ? CGI::label($labelattributes,
2244 qq{<input type="checkbox" name="$name" value="$value" $tabindex$checked$other/>$the_label})
2245 : qq{<input type="checkbox" name="$name" value="$value"$checked$other>$the_label};
2251 # Escape HTML -- used internally
2252 'escapeHTML' => <<'END_OF_FUNC',
2254 # hack to work around earlier hacks
2255 push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
2256 my ($self,$toencode,$newlinestoo) = CGI::self_or_default(@_);
2257 return undef unless defined($toencode);
2258 return $toencode if ref($self) && !$self->{'escape'};
2259 $toencode =~ s{&}{&}gso;
2260 $toencode =~ s{<}{<}gso;
2261 $toencode =~ s{>}{>}gso;
2262 if ($DTD_PUBLIC_IDENTIFIER =~ /[^X]HTML 3\.2/i) {
2263 # $quot; was accidentally omitted from the HTML 3.2 DTD -- see
2264 # <http://validator.w3.org/docs/errors.html#bad-entity> /
2265 # <http://lists.w3.org/Archives/Public/www-html/1997Mar/0003.html>.
2266 $toencode =~ s{"}{"}gso;
2269 $toencode =~ s{"}{"}gso;
2271 # Handle bug in some browsers with Latin charsets
2272 if ($self->{'.charset'} &&
2273 (uc($self->{'.charset'}) eq 'ISO-8859-1' ||
2274 uc($self->{'.charset'}) eq 'WINDOWS-1252'))
2276 $toencode =~ s{'}{'}gso;
2277 $toencode =~ s{\x8b}{‹}gso;
2278 $toencode =~ s{\x9b}{›}gso;
2279 if (defined $newlinestoo && $newlinestoo) {
2280 $toencode =~ s{\012}{ }gso;
2281 $toencode =~ s{\015}{ }gso;
2288 # unescape HTML -- used internally
2289 'unescapeHTML' => <<'END_OF_FUNC',
2291 # hack to work around earlier hacks
2292 push @_,$_[0] if @_==1 && $_[0] eq 'CGI';
2293 my ($self,$string) = CGI::self_or_default(@_);
2294 return undef unless defined($string);
2295 my $latin = defined $self->{'.charset'} ? $self->{'.charset'} =~ /^(ISO-8859-1|WINDOWS-1252)$/i
2297 # thanks to Randal Schwartz for the correct solution to this one
2298 $string=~ s[&(.*?);]{
2304 /^#(\d+)$/ && $latin ? chr($1) :
2305 /^#x([0-9a-f]+)$/i && $latin ? chr(hex($1)) :
2312 # Internal procedure - don't use
2313 '_tableize' => <<'END_OF_FUNC',
2315 my($rows,$columns,$rowheaders,$colheaders,@elements) = @_;
2316 my @rowheaders = $rowheaders ? @$rowheaders : ();
2317 my @colheaders = $colheaders ? @$colheaders : ();
2320 if (defined($columns)) {
2321 $rows = int(0.99 + @elements/$columns) unless defined($rows);
2323 if (defined($rows)) {
2324 $columns = int(0.99 + @elements/$rows) unless defined($columns);
2327 # rearrange into a pretty table
2328 $result = "<table>";
2330 unshift(@colheaders,'') if @colheaders && @rowheaders;
2331 $result .= "<tr>" if @colheaders;
2333 $result .= "<th>$_</th>";
2335 for ($row=0;$row<$rows;$row++) {
2337 $result .= "<th>$rowheaders[$row]</th>" if @rowheaders;
2338 for ($column=0;$column<$columns;$column++) {
2339 $result .= "<td>" . $elements[$column*$rows + $row] . "</td>"
2340 if defined($elements[$column*$rows + $row]);
2344 $result .= "</table>";
2350 #### Method: radio_group
2351 # Create a list of logically-linked radio buttons.
2353 # $name -> Common name for all the buttons.
2354 # $values -> A pointer to a regular array containing the
2355 # values for each button in the group.
2356 # $default -> (optional) Value of the button to turn on by default. Pass '-'
2357 # to turn _nothing_ on.
2358 # $linebreak -> (optional) Set to true to place linebreaks
2359 # between the buttons.
2360 # $labels -> (optional)
2361 # A pointer to a hash of labels to print next to each checkbox
2362 # in the form $label{'value'}="Long explanatory label".
2363 # Otherwise the provided values are used as the labels.
2365 # An ARRAY containing a series of <input type="radio"> fields
2367 'radio_group' => <<'END_OF_FUNC',
2369 my($self,@p) = self_or_default(@_);
2370 $self->_box_group('radio',@p);
2374 #### Method: checkbox_group
2375 # Create a list of logically-linked checkboxes.
2377 # $name -> Common name for all the check boxes
2378 # $values -> A pointer to a regular array containing the
2379 # values for each checkbox in the group.
2380 # $defaults -> (optional)
2381 # 1. If a pointer to a regular array of checkbox values,
2382 # then this will be used to decide which
2383 # checkboxes to turn on by default.
2384 # 2. If a scalar, will be assumed to hold the
2385 # value of a single checkbox in the group to turn on.
2386 # $linebreak -> (optional) Set to true to place linebreaks
2387 # between the buttons.
2388 # $labels -> (optional)
2389 # A pointer to a hash of labels to print next to each checkbox
2390 # in the form $label{'value'}="Long explanatory label".
2391 # Otherwise the provided values are used as the labels.
2393 # An ARRAY containing a series of <input type="checkbox"> fields
2396 'checkbox_group' => <<'END_OF_FUNC',
2397 sub checkbox_group {
2398 my($self,@p) = self_or_default(@_);
2399 $self->_box_group('checkbox',@p);
2403 '_box_group' => <<'END_OF_FUNC',
2406 my $box_type = shift;
2408 my($name,$values,$defaults,$linebreak,$labels,$labelattributes,
2409 $attributes,$rows,$columns,$rowheaders,$colheaders,
2410 $override,$nolabels,$tabindex,$disabled,@other) =
2411 rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LINEBREAK,LABELS,LABELATTRIBUTES,
2412 ATTRIBUTES,ROWS,[COLUMNS,COLS],[ROWHEADERS,ROWHEADER],[COLHEADERS,COLHEADER],
2413 [OVERRIDE,FORCE],NOLABELS,TABINDEX,DISABLED
2417 my($result,$checked,@elements,@values);
2419 @values = $self->_set_values_and_labels($values,\$labels,$name);
2420 my %checked = $self->previous_or_default($name,$defaults,$override);
2422 # If no check array is specified, check the first by default
2423 $checked{$values[0]}++ if $box_type eq 'radio' && !%checked;
2425 $name=$self->escapeHTML($name);
2428 if ($TABINDEX && $tabindex) {
2429 if (!ref $tabindex) {
2430 $self->element_tab($tabindex);
2431 } elsif (ref $tabindex eq 'ARRAY') {
2432 %tabs = map {$_=>$self->element_tab} @$tabindex;
2433 } elsif (ref $tabindex eq 'HASH') {
2437 %tabs = map {$_=>$self->element_tab} @values unless %tabs;
2438 my $other = @other ? "@other " : '';
2441 # for disabling groups of radio/checkbox buttons
2443 for (@{$disabled}) {
2449 if ($disabled{$_}) {
2450 $disable="disabled='1'";
2453 my $checkit = $self->_checked($box_type eq 'radio' ? ($checked{$_} && !$radio_checked++)
2457 $break = $XHTML ? "<br />" : "<br>";
2463 unless (defined($nolabels) && $nolabels) {
2465 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2466 $label = $self->escapeHTML($label,1);
2467 $label = "<span style=\"color:gray\">$label</span>" if $disabled{$_};
2469 my $attribs = $self->_set_attributes($_, $attributes);
2470 my $tab = $tabs{$_};
2471 $_=$self->escapeHTML($_);
2475 CGI::label($labelattributes,
2476 qq(<input type="$box_type" name="$name" value="$_" $checkit$other$tab$attribs$disable/>$label)).${break};
2478 push(@elements,qq/<input type="$box_type" name="$name" value="$_"$checkit$other$tab$attribs$disable>${label}${break}/);
2481 $self->register_parameter($name);
2482 return wantarray ? @elements : "@elements"
2483 unless defined($columns) || defined($rows);
2484 return _tableize($rows,$columns,$rowheaders,$colheaders,@elements);
2489 #### Method: popup_menu
2490 # Create a popup menu.
2492 # $name -> Name for all the menu
2493 # $values -> A pointer to a regular array containing the
2494 # text of each menu item.
2495 # $default -> (optional) Default item to display
2496 # $labels -> (optional)
2497 # A pointer to a hash of labels to print next to each checkbox
2498 # in the form $label{'value'}="Long explanatory label".
2499 # Otherwise the provided values are used as the labels.
2501 # A string containing the definition of a popup menu.
2503 'popup_menu' => <<'END_OF_FUNC',
2505 my($self,@p) = self_or_default(@_);
2507 my($name,$values,$default,$labels,$attributes,$override,$tabindex,@other) =
2508 rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LABELS,
2509 ATTRIBUTES,[OVERRIDE,FORCE],TABINDEX],@p);
2510 my($result,%selected);
2512 if (!$override && defined($self->param($name))) {
2513 $selected{$self->param($name)}++;
2514 } elsif (defined $default) {
2515 %selected = map {$_=>1} ref($default) eq 'ARRAY'
2519 $name=$self->escapeHTML($name);
2520 my($other) = @other ? " @other" : '';
2523 @values = $self->_set_values_and_labels($values,\$labels,$name);
2524 $tabindex = $self->element_tab($tabindex);
2525 $result = qq/<select name="$name" $tabindex$other>\n/;
2528 for my $v (split(/\n/)) {
2529 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2530 for my $selected (keys %selected) {
2531 $v =~ s/(value="$selected")/$selectit $1/;
2537 my $attribs = $self->_set_attributes($_, $attributes);
2538 my($selectit) = $self->_selected($selected{$_});
2540 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2541 my($value) = $self->escapeHTML($_);
2542 $label = $self->escapeHTML($label,1);
2543 $result .= "<option${attribs} ${selectit}value=\"$value\">$label</option>\n";
2547 $result .= "</select>";
2553 #### Method: optgroup
2554 # Create a optgroup.
2556 # $name -> Label for the group
2557 # $values -> A pointer to a regular array containing the
2558 # values for each option line in the group.
2559 # $labels -> (optional)
2560 # A pointer to a hash of labels to print next to each item
2561 # in the form $label{'value'}="Long explanatory label".
2562 # Otherwise the provided values are used as the labels.
2563 # $labeled -> (optional)
2564 # A true value indicates the value should be used as the label attribute
2565 # in the option elements.
2566 # The label attribute specifies the option label presented to the user.
2567 # This defaults to the content of the <option> element, but the label
2568 # attribute allows authors to more easily use optgroup without sacrificing
2569 # compatibility with browsers that do not support option groups.
2570 # $novals -> (optional)
2571 # A true value indicates to suppress the val attribute in the option elements
2573 # A string containing the definition of an option group.
2575 'optgroup' => <<'END_OF_FUNC',
2577 my($self,@p) = self_or_default(@_);
2578 my($name,$values,$attributes,$labeled,$noval,$labels,@other)
2579 = rearrange([NAME,[VALUES,VALUE],ATTRIBUTES,LABELED,NOVALS,LABELS],@p);
2581 my($result,@values);
2582 @values = $self->_set_values_and_labels($values,\$labels,$name,$labeled,$novals);
2583 my($other) = @other ? " @other" : '';
2585 $name=$self->escapeHTML($name);
2586 $result = qq/<optgroup label="$name"$other>\n/;
2590 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2591 s/(value="$selected")/$selectit $1/ if defined $selected;
2596 my $attribs = $self->_set_attributes($_, $attributes);
2598 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2599 $label=$self->escapeHTML($label);
2600 my($value)=$self->escapeHTML($_,1);
2601 $result .= $labeled ? $novals ? "<option$attribs label=\"$value\">$label</option>\n"
2602 : "<option$attribs label=\"$value\" value=\"$value\">$label</option>\n"
2603 : $novals ? "<option$attribs>$label</option>\n"
2604 : "<option$attribs value=\"$value\">$label</option>\n";
2607 $result .= "</optgroup>";
2613 #### Method: scrolling_list
2614 # Create a scrolling list.
2616 # $name -> name for the list
2617 # $values -> A pointer to a regular array containing the
2618 # values for each option line in the list.
2619 # $defaults -> (optional)
2620 # 1. If a pointer to a regular array of options,
2621 # then this will be used to decide which
2622 # lines to turn on by default.
2623 # 2. Otherwise holds the value of the single line to turn on.
2624 # $size -> (optional) Size of the list.
2625 # $multiple -> (optional) If set, allow multiple selections.
2626 # $labels -> (optional)
2627 # A pointer to a hash of labels to print next to each checkbox
2628 # in the form $label{'value'}="Long explanatory label".
2629 # Otherwise the provided values are used as the labels.
2631 # A string containing the definition of a scrolling list.
2633 'scrolling_list' => <<'END_OF_FUNC',
2634 sub scrolling_list {
2635 my($self,@p) = self_or_default(@_);
2636 my($name,$values,$defaults,$size,$multiple,$labels,$attributes,$override,$tabindex,@other)
2637 = rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT],
2638 SIZE,MULTIPLE,LABELS,ATTRIBUTES,[OVERRIDE,FORCE],TABINDEX],@p);
2640 my($result,@values);
2641 @values = $self->_set_values_and_labels($values,\$labels,$name);
2643 $size = $size || scalar(@values);
2645 my(%selected) = $self->previous_or_default($name,$defaults,$override);
2647 my($is_multiple) = $multiple ? qq/ multiple="multiple"/ : '';
2648 my($has_size) = $size ? qq/ size="$size"/: '';
2649 my($other) = @other ? " @other" : '';
2651 $name=$self->escapeHTML($name);
2652 $tabindex = $self->element_tab($tabindex);
2653 $result = qq/<select name="$name" $tabindex$has_size$is_multiple$other>\n/;
2656 for my $v (split(/\n/)) {
2657 my $selectit = $XHTML ? 'selected="selected"' : 'selected';
2658 for my $selected (keys %selected) {
2659 $v =~ s/(value="$selected")/$selectit $1/;
2665 my $attribs = $self->_set_attributes($_, $attributes);
2666 my($selectit) = $self->_selected($selected{$_});
2668 $label = $labels->{$_} if defined($labels) && defined($labels->{$_});
2669 my($value) = $self->escapeHTML($_);
2670 $label = $self->escapeHTML($label,1);
2671 $result .= "<option${attribs} ${selectit}value=\"$value\">$label</option>\n";
2675 $result .= "</select>";
2676 $self->register_parameter($name);
2684 # $name -> Name of the hidden field
2685 # @default -> (optional) Initial values of field (may be an array)
2687 # $default->[initial values of field]
2689 # A string containing a <input type="hidden" name="name" value="value">
2691 'hidden' => <<'END_OF_FUNC',
2693 my($self,@p) = self_or_default(@_);
2695 # this is the one place where we departed from our standard
2696 # calling scheme, so we have to special-case (darn)
2698 my($name,$default,$override,@other) =
2699 rearrange([NAME,[DEFAULT,VALUE,VALUES],[OVERRIDE,FORCE]],@p);
2701 my $do_override = 0;
2702 if ( ref($p[0]) || substr($p[0],0,1) eq '-') {
2703 @value = ref($default) ? @{$default} : $default;
2704 $do_override = $override;
2706 for ($default,$override,@other) {
2707 push(@value,$_) if defined($_);
2711 # use previous values if override is not set
2712 my @prev = $self->param($name);
2713 @value = @prev if !$do_override && @prev;
2715 $name=$self->escapeHTML($name);
2717 $_ = defined($_) ? $self->escapeHTML($_,1) : '';
2718 push @result,$XHTML ? qq(<input type="hidden" name="$name" value="$_" @other />)
2719 : qq(<input type="hidden" name="$name" value="$_" @other>);
2721 return wantarray ? @result : join('',@result);
2726 #### Method: image_button
2728 # $name -> Name of the button
2729 # $src -> URL of the image source
2730 # $align -> Alignment style (TOP, BOTTOM or MIDDLE)
2732 # A string containing a <input type="image" name="name" src="url" align="alignment">
2734 'image_button' => <<'END_OF_FUNC',
2736 my($self,@p) = self_or_default(@_);
2738 my($name,$src,$alignment,@other) =
2739 rearrange([NAME,SRC,ALIGN],@p);
2741 my($align) = $alignment ? " align=\L\"$alignment\"" : '';
2742 my($other) = @other ? " @other" : '';
2743 $name=$self->escapeHTML($name);
2744 return $XHTML ? qq(<input type="image" name="$name" src="$src"$align$other />)
2745 : qq/<input type="image" name="$name" src="$src"$align$other>/;
2750 #### Method: self_url
2751 # Returns a URL containing the current script and all its
2752 # param/value pairs arranged as a query. You can use this
2753 # to create a link that, when selected, will reinvoke the
2754 # script with all its state information preserved.
2756 'self_url' => <<'END_OF_FUNC',
2758 my($self,@p) = self_or_default(@_);
2759 return $self->url('-path_info'=>1,'-query'=>1,'-full'=>1,@p);
2764 # This is provided as a synonym to self_url() for people unfortunate
2765 # enough to have incorporated it into their programs already!
2766 'state' => <<'END_OF_FUNC',
2774 # Like self_url, but doesn't return the query string part of
2777 'url' => <<'END_OF_FUNC',
2779 my($self,@p) = self_or_default(@_);
2780 my ($relative,$absolute,$full,$path_info,$query,$base,$rewrite) =
2781 rearrange(['RELATIVE','ABSOLUTE','FULL',['PATH','PATH_INFO'],['QUERY','QUERY_STRING'],'BASE','REWRITE'],@p);
2783 $full++ if $base || !($relative || $absolute);
2784 $rewrite++ unless defined $rewrite;
2786 my $path = $self->path_info;
2787 my $script_name = $self->script_name;
2788 my $request_uri = unescape($self->request_uri) || '';
2789 my $query_str = $self->query_string;
2791 my $rewrite_in_use = $request_uri && $request_uri !~ /^\Q$script_name/;
2792 undef $path if $rewrite_in_use && $rewrite; # path not valid when rewriting active
2794 my $uri = $rewrite && $request_uri ? $request_uri : $script_name;
2795 $uri =~ s/\?.*$//s; # remove query string
2796 $uri =~ s/\Q$ENV{PATH_INFO}\E$// if defined $ENV{PATH_INFO};
2797 # $uri =~ s/\Q$path\E$// if defined $path; # remove path
2800 my $protocol = $self->protocol();
2801 $url = "$protocol://";
2802 my $vh = http('x_forwarded_host') || http('host') || '';
2803 $vh =~ s/\:\d+$//; # some clients add the port number (incorrectly). Get rid of it.
2807 $url .= server_name();
2809 my $port = $self->server_port;
2811 unless (lc($protocol) eq 'http' && $port == 80)
2812 || (lc($protocol) eq 'https' && $port == 443);
2813 return $url if $base;
2815 } elsif ($relative) {
2816 ($url) = $uri =~ m!([^/]+)$!;
2817 } elsif ($absolute) {
2821 $url .= $path if $path_info and defined $path;
2822 $url .= "?$query_str" if $query and $query_str ne '';
2824 $url =~ s/([^a-zA-Z0-9_.%;&?\/\\:+=~-])/sprintf("%%%02X",ord($1))/eg;
2831 # Set or read a cookie from the specified name.
2832 # Cookie can then be passed to header().
2833 # Usual rules apply to the stickiness of -value.
2835 # -name -> name for this cookie (optional)
2836 # -value -> value of this cookie (scalar, array or hash)
2837 # -path -> paths for which this cookie is valid (optional)
2838 # -domain -> internet domain in which this cookie is valid (optional)
2839 # -secure -> if true, cookie only passed through secure channel (optional)
2840 # -expires -> expiry date in format Wdy, DD-Mon-YYYY HH:MM:SS GMT (optional)
2842 'cookie' => <<'END_OF_FUNC',
2844 my($self,@p) = self_or_default(@_);
2845 my($name,$value,$path,$domain,$secure,$expires,$httponly) =
2846 rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES,HTTPONLY],@p);
2848 require CGI::Cookie;
2850 # if no value is supplied, then we retrieve the
2851 # value of the cookie, if any. For efficiency, we cache the parsed
2852 # cookies in our state variables.
2853 unless ( defined($value) ) {
2854 $self->{'.cookies'} = CGI::Cookie->fetch;
2856 # If no name is supplied, then retrieve the names of all our cookies.
2857 return () unless $self->{'.cookies'};
2858 return keys %{$self->{'.cookies'}} unless $name;
2859 return () unless $self->{'.cookies'}->{$name};
2860 return $self->{'.cookies'}->{$name}->value if defined($name) && $name ne '';
2863 # If we get here, we're creating a new cookie
2864 return undef unless defined($name) && $name ne ''; # this is an error
2867 push(@param,'-name'=>$name);
2868 push(@param,'-value'=>$value);
2869 push(@param,'-domain'=>$domain) if $domain;
2870 push(@param,'-path'=>$path) if $path;
2871 push(@param,'-expires'=>$expires) if $expires;
2872 push(@param,'-secure'=>$secure) if $secure;
2873 push(@param,'-httponly'=>$httponly) if $httponly;
2875 return new CGI::Cookie(@param);
2879 'parse_keywordlist' => <<'END_OF_FUNC',
2880 sub parse_keywordlist {
2881 my($self,$tosplit) = @_;
2882 $tosplit = unescape($tosplit); # unescape the keywords
2883 $tosplit=~tr/+/ /; # pluses to spaces
2884 my(@keywords) = split(/\s+/,$tosplit);
2889 'param_fetch' => <<'END_OF_FUNC',
2891 my($self,@p) = self_or_default(@_);
2892 my($name) = rearrange([NAME],@p);
2893 unless (exists($self->{param}{$name})) {
2894 $self->add_parameter($name);
2895 $self->{param}{$name} = [];
2898 return $self->{param}{$name};
2902 ###############################################
2903 # OTHER INFORMATION PROVIDED BY THE ENVIRONMENT
2904 ###############################################
2906 #### Method: path_info
2907 # Return the extra virtual path information provided
2908 # after the URL (if any)
2910 'path_info' => <<'END_OF_FUNC',
2912 my ($self,$info) = self_or_default(@_);
2913 if (defined($info)) {
2914 $info = "/$info" if $info ne '' && substr($info,0,1) ne '/';
2915 $self->{'.path_info'} = $info;
2916 } elsif (! defined($self->{'.path_info'}) ) {
2917 my (undef,$path_info) = $self->_name_and_path_from_env;
2918 $self->{'.path_info'} = $path_info || '';
2920 return $self->{'.path_info'};
2924 # This function returns a potentially modified version of SCRIPT_NAME
2925 # and PATH_INFO. Some HTTP servers do sanitise the paths in those
2926 # variables. It is the case of at least Apache 2. If for instance the
2927 # user requests: /path/./to/script.cgi/x//y/z/../x?y, Apache will set:
2928 # REQUEST_URI=/path/./to/script.cgi/x//y/z/../x?y
2929 # SCRIPT_NAME=/path/to/env.cgi
2932 # This is all fine except that some bogus CGI scripts expect
2933 # PATH_INFO=/http://foo when the user requests
2934 # http://xxx/script.cgi/http://foo
2936 # Old versions of this module used to accomodate with those scripts, so
2937 # this is why we do this here to keep those scripts backward compatible.
2938 # Basically, we accomodate with those scripts but within limits, that is
2939 # we only try to preserve the number of / that were provided by the user
2940 # if $REQUEST_URI and "$SCRIPT_NAME$PATH_INFO" only differ by the number
2943 # So for instance, in: http://foo/x//y/script.cgi/a//b, we'll return a
2944 # script_name of /x//y/script.cgi and a path_info of /a//b, but in:
2945 # http://foo/./x//z/script.cgi/a/../b//c, we'll return the versions
2946 # possibly sanitised by the HTTP server, so in the case of Apache 2:
2947 # script_name == /foo/x/z/script.cgi and path_info == /b/c.
2949 # Future versions of this module may no longer do that, so one should
2950 # avoid relying on the browser, proxy, server, and CGI.pm preserving the
2951 # number of consecutive slashes as no guarantee can be made there.
2952 '_name_and_path_from_env' => <<'END_OF_FUNC',
2953 sub _name_and_path_from_env {
2955 my $script_name = $ENV{SCRIPT_NAME} || '';
2956 my $path_info = $ENV{PATH_INFO} || '';
2957 my $uri = $self->request_uri || '';
2960 $uri = unescape($uri);
2962 if ($uri ne "$script_name$path_info") {
2963 my $script_name_pattern = quotemeta($script_name);
2964 my $path_info_pattern = quotemeta($path_info);
2965 $script_name_pattern =~ s{(?:\\/)+}{/+}g;
2966 $path_info_pattern =~ s{(?:\\/)+}{/+}g;
2968 if ($uri =~ /^($script_name_pattern)($path_info_pattern)$/s) {
2969 # REQUEST_URI and SCRIPT_NAME . PATH_INFO only differ by the
2970 # numer of consecutive slashes, so we can extract the info from
2972 ($script_name, $path_info) = ($1, $2);
2975 return ($script_name,$path_info);
2980 #### Method: request_method
2981 # Returns 'POST', 'GET', 'PUT' or 'HEAD'
2983 'request_method' => <<'END_OF_FUNC',
2984 sub request_method {
2985 return (defined $ENV{'REQUEST_METHOD'}) ? $ENV{'REQUEST_METHOD'} : undef;
2989 #### Method: content_type
2990 # Returns the content_type string
2992 'content_type' => <<'END_OF_FUNC',
2994 return (defined $ENV{'CONTENT_TYPE'}) ? $ENV{'CONTENT_TYPE'} : undef;
2998 #### Method: path_translated
2999 # Return the physical path information provided
3000 # by the URL (if any)
3002 'path_translated' => <<'END_OF_FUNC',
3003 sub path_translated {
3004 return (defined $ENV{'PATH_TRANSLATED'}) ? $ENV{'PATH_TRANSLATED'} : undef;
3009 #### Method: request_uri
3010 # Return the literal request URI
3012 'request_uri' => <<'END_OF_FUNC',
3014 return (defined $ENV{'REQUEST_URI'}) ? $ENV{'REQUEST_URI'} : undef;
3019 #### Method: query_string
3020 # Synthesize a query string from our current
3023 'query_string' => <<'END_OF_FUNC',
3025 my($self) = self_or_default(@_);
3026 my($param,$value,@pairs);
3027 for $param ($self->param) {
3028 my($eparam) = escape($param);
3029 for $value ($self->param($param)) {
3030 $value = escape($value);
3031 next unless defined $value;
3032 push(@pairs,"$eparam=$value");
3035 for (keys %{$self->{'.fieldnames'}}) {
3036 push(@pairs,".cgifields=".escape("$_"));
3038 return join($USE_PARAM_SEMICOLONS ? ';' : '&',@pairs);
3044 # Without parameters, returns an array of the
3045 # MIME types the browser accepts.
3046 # With a single parameter equal to a MIME
3047 # type, will return undef if the browser won't
3048 # accept it, 1 if the browser accepts it but
3049 # doesn't give a preference, or a floating point
3050 # value between 0.0 and 1.0 if the browser
3051 # declares a quantitative score for it.
3052 # This handles MIME type globs correctly.
3054 'Accept' => <<'END_OF_FUNC',
3056 my($self,$search) = self_or_CGI(@_);
3057 my(%prefs,$type,$pref,$pat);
3059 my(@accept) = defined $self->http('accept')
3060 ? split(',',$self->http('accept'))
3064 ($pref) = /q=(\d\.\d+|\d+)/;
3065 ($type) = m#(\S+/[^;]+)#;
3067 $prefs{$type}=$pref || 1;
3070 return keys %prefs unless $search;
3072 # if a search type is provided, we may need to
3073 # perform a pattern matching operation.
3074 # The MIME types use a glob mechanism, which
3075 # is easily translated into a perl pattern match
3077 # First return the preference for directly supported
3079 return $prefs{$search} if $prefs{$search};
3081 # Didn't get it, so try pattern matching.
3083 next unless /\*/; # not a pattern match
3084 ($pat = $_) =~ s/([^\w*])/\\$1/g; # escape meta characters
3085 $pat =~ s/\*/.*/g; # turn it into a pattern
3086 return $prefs{$_} if $search=~/$pat/;
3092 #### Method: user_agent
3093 # If called with no parameters, returns the user agent.
3094 # If called with one parameter, does a pattern match (case
3095 # insensitive) on the user agent.
3097 'user_agent' => <<'END_OF_FUNC',
3099 my($self,$match)=self_or_CGI(@_);
3100 my $user_agent = $self->http('user_agent');
3101 return $user_agent unless $match && $user_agent;
3102 return $user_agent =~ /$match/i;
3107 #### Method: raw_cookie
3108 # Returns the magic cookies for the session.
3109 # The cookies are not parsed or altered in any way, i.e.
3110 # cookies are returned exactly as given in the HTTP
3111 # headers. If a cookie name is given, only that cookie's
3112 # value is returned, otherwise the entire raw cookie
3115 'raw_cookie' => <<'END_OF_FUNC',
3117 my($self,$key) = self_or_CGI(@_);
3119 require CGI::Cookie;
3121 if (defined($key)) {
3122 $self->{'.raw_cookies'} = CGI::Cookie->raw_fetch
3123 unless $self->{'.raw_cookies'};
3125 return () unless $self->{'.raw_cookies'};
3126 return () unless $self->{'.raw_cookies'}->{$key};
3127 return $self->{'.raw_cookies'}->{$key};
3129 return $self->http('cookie') || $ENV{'COOKIE'} || '';
3133 #### Method: virtual_host
3134 # Return the name of the virtual_host, which
3135 # is not always the same as the server
3137 'virtual_host' => <<'END_OF_FUNC',
3139 my $vh = http('x_forwarded_host') || http('host') || server_name();
3140 $vh =~ s/:\d+$//; # get rid of port number
3145 #### Method: remote_host
3146 # Return the name of the remote host, or its IP
3147 # address if unavailable. If this variable isn't
3148 # defined, it returns "localhost" for debugging
3151 'remote_host' => <<'END_OF_FUNC',
3153 return $ENV{'REMOTE_HOST'} || $ENV{'REMOTE_ADDR'}
3159 #### Method: remote_addr
3160 # Return the IP addr of the remote host.
3162 'remote_addr' => <<'END_OF_FUNC',
3164 return $ENV{'REMOTE_ADDR'} || '127.0.0.1';
3169 #### Method: script_name
3170 # Return the partial URL to this script for
3171 # self-referencing scripts. Also see
3172 # self_url(), which returns a URL with all state information
3175 'script_name' => <<'END_OF_FUNC',
3177 my ($self,@p) = self_or_default(@_);
3179 $self->{'.script_name'} = shift @p;
3180 } elsif (!exists $self->{'.script_name'}) {
3181 my ($script_name,$path_info) = $self->_name_and_path_from_env();
3182 $self->{'.script_name'} = $script_name;
3184 return $self->{'.script_name'};
3189 #### Method: referer
3190 # Return the HTTP_REFERER: useful for generating
3193 'referer' => <<'END_OF_FUNC',
3195 my($self) = self_or_CGI(@_);
3196 return $self->http('referer');
3201 #### Method: server_name
3202 # Return the name of the server
3204 'server_name' => <<'END_OF_FUNC',
3206 return $ENV{'SERVER_NAME'} || 'localhost';
3210 #### Method: server_software
3211 # Return the name of the server software
3213 'server_software' => <<'END_OF_FUNC',
3214 sub server_software {
3215 return $ENV{'SERVER_SOFTWARE'} || 'cmdline';
3219 #### Method: virtual_port
3220 # Return the server port, taking virtual hosts into account
3222 'virtual_port' => <<'END_OF_FUNC',
3224 my($self) = self_or_default(@_);
3225 my $vh = $self->http('x_forwarded_host') || $self->http('host');
3226 my $protocol = $self->protocol;
3228 return ($vh =~ /:(\d+)$/)[0] || ($protocol eq 'https' ? 443 : 80);
3230 return $self->server_port();
3235 #### Method: server_port
3236 # Return the tcp/ip port the server is running on
3238 'server_port' => <<'END_OF_FUNC',
3240 return $ENV{'SERVER_PORT'} || 80; # for debugging
3244 #### Method: server_protocol
3245 # Return the protocol (usually HTTP/1.0)
3247 'server_protocol' => <<'END_OF_FUNC',
3248 sub server_protocol {
3249 return $ENV{'SERVER_PROTOCOL'} || 'HTTP/1.0'; # for debugging
3254 # Return the value of an HTTP variable, or
3255 # the list of variables if none provided
3257 'http' => <<'END_OF_FUNC',
3259 my ($self,$parameter) = self_or_CGI(@_);
3260 if ( defined($parameter) ) {
3261 if ( $parameter =~ /^HTTP/ ) {
3262 return $ENV{$parameter};
3264 $parameter =~ tr/-/_/;
3266 return $ENV{"HTTP_\U$parameter\E"} if $parameter;
3269 push(@p,$_) if /^HTTP/;
3276 # Return the value of HTTPS
3278 'https' => <<'END_OF_FUNC',
3281 my ($self,$parameter) = self_or_CGI(@_);
3282 return $ENV{HTTPS} unless $parameter;
3283 return $ENV{$parameter} if $parameter=~/^HTTPS/;
3284 $parameter =~ tr/-/_/;
3285 return $ENV{"HTTPS_\U$parameter\E"} if $parameter;
3288 push(@p,$_) if /^HTTPS/;
3294 #### Method: protocol
3295 # Return the protocol (http or https currently)
3297 'protocol' => <<'END_OF_FUNC',
3301 return 'https' if uc($self->https()) eq 'ON';
3302 return 'https' if $self->server_port == 443;
3303 my $prot = $self->server_protocol;
3304 my($protocol,$version) = split('/',$prot);
3305 return "\L$protocol\E";
3309 #### Method: remote_ident
3310 # Return the identity of the remote user
3311 # (but only if his host is running identd)
3313 'remote_ident' => <<'END_OF_FUNC',
3315 return (defined $ENV{'REMOTE_IDENT'}) ? $ENV{'REMOTE_IDENT'} : undef;
3320 #### Method: auth_type
3321 # Return the type of use verification/authorization in use, if any.
3323 'auth_type' => <<'END_OF_FUNC',
3325 return (defined $ENV{'AUTH_TYPE'}) ? $ENV{'AUTH_TYPE'} : undef;
3330 #### Method: remote_user
3331 # Return the authorization name used for user
3334 'remote_user' => <<'END_OF_FUNC',
3336 return (defined $ENV{'REMOTE_USER'}) ? $ENV{'REMOTE_USER'} : undef;
3341 #### Method: user_name
3342 # Try to return the remote user's name by hook or by
3345 'user_name' => <<'END_OF_FUNC',
3347 my ($self) = self_or_CGI(@_);
3348 return $self->http('from') || $ENV{'REMOTE_IDENT'} || $ENV{'REMOTE_USER'};
3352 #### Method: nosticky
3353 # Set or return the NOSTICKY global flag
3355 'nosticky' => <<'END_OF_FUNC',
3357 my ($self,$param) = self_or_CGI(@_);
3358 $CGI::NOSTICKY = $param if defined($param);
3359 return $CGI::NOSTICKY;
3364 # Set or return the NPH global flag
3366 'nph' => <<'END_OF_FUNC',
3368 my ($self,$param) = self_or_CGI(@_);
3369 $CGI::NPH = $param if defined($param);
3374 #### Method: private_tempfiles
3375 # Set or return the private_tempfiles global flag
3377 'private_tempfiles' => <<'END_OF_FUNC',
3378 sub private_tempfiles {
3379 my ($self,$param) = self_or_CGI(@_);
3380 $CGI::PRIVATE_TEMPFILES = $param if defined($param);
3381 return $CGI::PRIVATE_TEMPFILES;
3384 #### Method: close_upload_files
3385 # Set or return the close_upload_files global flag
3387 'close_upload_files' => <<'END_OF_FUNC',
3388 sub close_upload_files {
3389 my ($self,$param) = self_or_CGI(@_);
3390 $CGI::CLOSE_UPLOAD_FILES = $param if defined($param);
3391 return $CGI::CLOSE_UPLOAD_FILES;
3396 #### Method: default_dtd
3397 # Set or return the default_dtd global
3399 'default_dtd' => <<'END_OF_FUNC',
3401 my ($self,$param,$param2) = self_or_CGI(@_);
3402 if (defined $param2 && defined $param) {
3403 $CGI::DEFAULT_DTD = [ $param, $param2 ];
3404 } elsif (defined $param) {
3405 $CGI::DEFAULT_DTD = $param;
3407 return $CGI::DEFAULT_DTD;
3411 # -------------- really private subroutines -----------------
3412 'previous_or_default' => <<'END_OF_FUNC',
3413 sub previous_or_default {
3414 my($self,$name,$defaults,$override) = @_;
3417 if (!$override && ($self->{'.fieldnames'}->{$name} ||
3418 defined($self->param($name)) ) ) {
3419 $selected{$_}++ for $self->param($name);
3420 } elsif (defined($defaults) && ref($defaults) &&
3421 (ref($defaults) eq 'ARRAY')) {
3422 $selected{$_}++ for @{$defaults};
3424 $selected{$defaults}++ if defined($defaults);
3431 'register_parameter' => <<'END_OF_FUNC',
3432 sub register_parameter {
3433 my($self,$param) = @_;
3434 $self->{'.parametersToAdd'}->{$param}++;
3438 'get_fields' => <<'END_OF_FUNC',
3441 return $self->CGI::hidden('-name'=>'.cgifields',
3442 '-values'=>[keys %{$self->{'.parametersToAdd'}}],
3447 'read_from_cmdline' => <<'END_OF_FUNC',
3448 sub read_from_cmdline {
3452 if ($DEBUG && @ARGV) {
3454 } elsif ($DEBUG > 1) {
3455 require "shellwords.pl";
3456 print STDERR "(offline mode: enter name=value pairs on standard input; press ^D or ^Z when done)\n";
3457 chomp(@lines = <STDIN>); # remove newlines
3458 $input = join(" ",@lines);
3459 @words = &shellwords($input);
3466 if ("@words"=~/=/) {
3467 $query_string = join('&',@words);
3469 $query_string = join('+',@words);
3471 if ($query_string =~ /^(.*?)\?(.*)$/)
3476 return { 'query_string' => $query_string, 'subpath' => $subpath };
3481 # subroutine: read_multipart
3483 # Read multipart data and store it into our parameters.
3484 # An interesting feature is that if any of the parts is a file, we
3485 # create a temporary file and open up a filehandle on it so that the
3486 # caller can read from it if necessary.
3488 'read_multipart' => <<'END_OF_FUNC',
3489 sub read_multipart {
3490 my($self,$boundary,$length) = @_;
3491 my($buffer) = $self->new_MultipartBuffer($boundary,$length);
3492 return unless $buffer;
3495 while (!$buffer->eof) {
3496 %header = $buffer->readHeader;
3499 $self->cgi_error("400 Bad request (malformed multipart POST)");
3503 $header{'Content-Disposition'} ||= ''; # quench uninit variable warning
3505 my($param)= $header{'Content-Disposition'}=~/[\s;]name="([^"]*)"/;
3508 # See RFC 1867, 2183, 2045
3509 # NB: File content will be loaded into memory should
3510 # content-disposition parsing fail.
3511 my ($filename) = $header{'Content-Disposition'}
3512 =~/ filename=(("[^"]*")|([a-z\d!\#'\*\+,\.^_\`\{\}\|\~]*))/i;
3514 $filename ||= ''; # quench uninit variable warning
3516 $filename =~ s/^"([^"]*)"$/$1/;
3517 # Test for Opera's multiple upload feature
3518 my($multipart) = ( defined( $header{'Content-Type'} ) &&
3519 $header{'Content-Type'} =~ /multipart\/mixed/ ) ?
3522 # add this parameter to our list
3523 $self->add_parameter($param);
3525 # If no filename specified, then just read the data and assign it
3526 # to our parameter list.
3527 if ( ( !defined($filename) || $filename eq '' ) && !$multipart ) {
3528 my($value) = $buffer->readBody;
3530 push(@{$self->{param}{$param}},$value);
3534 my ($tmpfile,$tmp,$filehandle);
3536 # If we get here, then we are dealing with a potentially large
3537 # uploaded form. Save the data to a temporary file, then open
3538 # the file for reading.
3540 # skip the file if uploads disabled
3541 if ($DISABLE_UPLOADS) {
3542 while (defined($data = $buffer->read)) { }
3546 # set the filename to some recognizable value
3547 if ( ( !defined($filename) || $filename eq '' ) && $multipart ) {
3548 $filename = "multipart/mixed";
3551 # choose a relatively unpredictable tmpfile sequence number
3552 my $seqno = unpack("%16C*",join('',localtime,grep {defined $_} values %ENV));
3553 for (my $cnt=10;$cnt>0;$cnt--) {
3554 next unless $tmpfile = new CGITempFile($seqno);
3555 $tmp = $tmpfile->as_string;
3556 last if defined($filehandle = Fh->new($filename,$tmp,$PRIVATE_TEMPFILES));
3557 $seqno += int rand(100);
3559 die "CGI open of tmpfile: $!\n" unless defined $filehandle;
3560 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode
3561 && defined fileno($filehandle);
3563 # if this is an multipart/mixed attachment, save the header
3564 # together with the body for later parsing with an external
3565 # MIME parser module
3567 for ( keys %header ) {
3568 print $filehandle "$_: $header{$_}${CRLF}";
3570 print $filehandle "${CRLF}";
3576 while (defined($data = $buffer->read)) {
3577 if (defined $self->{'.upload_hook'})
3579 $totalbytes += length($data);
3580 &{$self->{'.upload_hook'}}($filename ,$data, $totalbytes, $self->{'.upload_data'});
3582 print $filehandle $data if ($self->{'use_tempfile'});
3585 # back up to beginning of file
3586 seek($filehandle,0,0);
3588 ## Close the filehandle if requested this allows a multipart MIME
3589 ## upload to contain many files, and we won't die due to too many
3590 ## open file handles. The user can access the files using the hash
3592 close $filehandle if $CLOSE_UPLOAD_FILES;
3593 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
3595 # Save some information about the uploaded file where we can get
3597 # Use the typeglob as the key, as this is guaranteed to be
3598 # unique for each filehandle. Don't use the file descriptor as
3599 # this will be re-used for each filehandle if the
3600 # close_upload_files feature is used.
3601 $self->{'.tmpfiles'}->{$$filehandle}= {
3602 hndl => $filehandle,
3606 push(@{$self->{param}{$param}},$filehandle);
3613 # subroutine: read_multipart_related
3615 # Read multipart/related data and store it into our parameters. The
3616 # first parameter sets the start of the data. The part identified by
3617 # this Content-ID will not be stored as a file upload, but will be
3618 # returned by this method. All other parts will be available as file
3619 # uploads accessible by their Content-ID
3621 'read_multipart_related' => <<'END_OF_FUNC',
3622 sub read_multipart_related {
3623 my($self,$start,$boundary,$length) = @_;
3624 my($buffer) = $self->new_MultipartBuffer($boundary,$length);
3625 return unless $buffer;
3629 while (!$buffer->eof) {
3630 %header = $buffer->readHeader;
3633 $self->cgi_error("400 Bad request (malformed multipart POST)");
3637 my($param) = $header{'Content-ID'}=~/\<([^\>]*)\>/;
3640 # If this is the start part, then just read the data and assign it
3641 # to our return variable.
3642 if ( $param eq $start ) {
3643 $returnvalue = $buffer->readBody;
3644 $returnvalue .= $TAINTED;
3648 # add this parameter to our list
3649 $self->add_parameter($param);
3651 my ($tmpfile,$tmp,$filehandle);
3653 # If we get here, then we are dealing with a potentially large
3654 # uploaded form. Save the data to a temporary file, then open
3655 # the file for reading.
3657 # skip the file if uploads disabled
3658 if ($DISABLE_UPLOADS) {
3659 while (defined($data = $buffer->read)) { }
3663 # choose a relatively unpredictable tmpfile sequence number
3664 my $seqno = unpack("%16C*",join('',localtime,grep {defined $_} values %ENV));
3665 for (my $cnt=10;$cnt>0;$cnt--) {
3666 next unless $tmpfile = new CGITempFile($seqno);
3667 $tmp = $tmpfile->as_string;
3668 last if defined($filehandle = Fh->new($param,$tmp,$PRIVATE_TEMPFILES));
3669 $seqno += int rand(100);
3671 die "CGI open of tmpfile: $!\n" unless defined $filehandle;
3672 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode
3673 && defined fileno($filehandle);
3678 while (defined($data = $buffer->read)) {
3679 if (defined $self->{'.upload_hook'})
3681 $totalbytes += length($data);
3682 &{$self->{'.upload_hook'}}($param ,$data, $totalbytes, $self->{'.upload_data'});
3684 print $filehandle $data if ($self->{'use_tempfile'});
3687 # back up to beginning of file
3688 seek($filehandle,0,0);
3690 ## Close the filehandle if requested this allows a multipart MIME
3691 ## upload to contain many files, and we won't die due to too many
3692 ## open file handles. The user can access the files using the hash
3694 close $filehandle if $CLOSE_UPLOAD_FILES;
3695 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
3697 # Save some information about the uploaded file where we can get
3699 # Use the typeglob as the key, as this is guaranteed to be
3700 # unique for each filehandle. Don't use the file descriptor as
3701 # this will be re-used for each filehandle if the
3702 # close_upload_files feature is used.
3703 $self->{'.tmpfiles'}->{$$filehandle}= {
3704 hndl => $filehandle,
3708 push(@{$self->{param}{$param}},$filehandle);
3711 return $returnvalue;
3716 'upload' =><<'END_OF_FUNC',
3718 my($self,$param_name) = self_or_default(@_);
3719 my @param = grep {ref($_) && defined(fileno($_))} $self->param($param_name);
3720 return unless @param;
3721 return wantarray ? @param : $param[0];
3725 'tmpFileName' => <<'END_OF_FUNC',
3727 my($self,$filename) = self_or_default(@_);
3728 return $self->{'.tmpfiles'}->{$$filename}->{name} ?
3729 $self->{'.tmpfiles'}->{$$filename}->{name}->as_string
3734 'uploadInfo' => <<'END_OF_FUNC',
3736 my($self,$filename) = self_or_default(@_);
3737 return $self->{'.tmpfiles'}->{$$filename}->{info};
3741 # internal routine, don't use
3742 '_set_values_and_labels' => <<'END_OF_FUNC',
3743 sub _set_values_and_labels {
3746 $$l = $v if ref($v) eq 'HASH' && !ref($$l);
3747 return $self->param($n) if !defined($v);
3748 return $v if !ref($v);
3749 return ref($v) eq 'HASH' ? keys %$v : @$v;
3753 # internal routine, don't use
3754 '_set_attributes' => <<'END_OF_FUNC',
3755 sub _set_attributes {
3757 my($element, $attributes) = @_;
3758 return '' unless defined($attributes->{$element});
3760 for my $attrib (keys %{$attributes->{$element}}) {
3761 (my $clean_attrib = $attrib) =~ s/^-//;
3762 $attribs .= "@{[lc($clean_attrib)]}=\"$attributes->{$element}{$attrib}\" ";
3769 '_compile_all' => <<'END_OF_FUNC',
3772 next if defined(&$_);
3773 $AUTOLOAD = "CGI::$_";
3783 #########################################################
3784 # Globals and stubs for other packages that we use.
3785 #########################################################
3787 ################### Fh -- lightweight filehandle ###############
3797 *Fh::AUTOLOAD = \&CGI::AUTOLOAD;
3804 $AUTOLOADED_ROUTINES = ''; # prevent -w error
3805 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3807 'asString' => <<'END_OF_FUNC',
3810 # get rid of package name
3811 (my $i = $$self) =~ s/^\*(\w+::fh\d{5})+//;
3812 $i =~ s/%(..)/ chr(hex($1)) /eg;
3813 return $i.$CGI::TAINTED;
3815 # This was an extremely clever patch that allowed "use strict refs".
3816 # Unfortunately it relied on another bug that caused leaky file descriptors.
3817 # The underlying bug has been fixed, so this no longer works. However
3818 # "strict refs" still works for some reason.
3820 # return ${*{$self}{SCALAR}};
3825 'compare' => <<'END_OF_FUNC',
3829 return "$self" cmp $value;
3833 'new' => <<'END_OF_FUNC',
3835 my($pack,$name,$file,$delete) = @_;
3836 _setup_symbols(@SAVED_SYMBOLS) if @SAVED_SYMBOLS;
3837 require Fcntl unless defined &Fcntl::O_RDWR;
3838 (my $safename = $name) =~ s/([':%])/ sprintf '%%%02X', ord $1 /eg;
3839 my $fv = ++$FH . $safename;
3840 my $ref = \*{"Fh::$fv"};
3842 # Note this same regex is also used elsewhere in the same file for CGITempFile::new
3843 $file =~ m!^([a-zA-Z0-9_ \'\":/.\$\\\+-]+)$! || return;
3845 sysopen($ref,$safe,Fcntl::O_RDWR()|Fcntl::O_CREAT()|Fcntl::O_EXCL(),0600) || return;
3846 unlink($safe) if $delete;
3847 CORE::delete $Fh::{$fv};
3848 return bless $ref,$pack;
3852 'handle' => <<'END_OF_FUNC',
3855 eval "require IO::Handle" unless IO::Handle->can('new_from_fd');
3856 return IO::Handle->new_from_fd(fileno $self,"<");
3863 ######################## MultipartBuffer ####################
3864 package MultipartBuffer;
3866 use constant DEBUG => 0;
3868 # how many bytes to read at a time. We use
3869 # a 4K buffer by default.
3870 $INITIAL_FILLUNIT = 1024 * 4;
3871 $TIMEOUT = 240*60; # 4 hour timeout for big files
3872 $SPIN_LOOP_MAX = 2000; # bug fix for some Netscape servers
3875 #reuse the autoload function
3876 *MultipartBuffer::AUTOLOAD = \&CGI::AUTOLOAD;
3878 # avoid autoloader warnings
3881 ###############################################################################
3882 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
3883 ###############################################################################
3884 $AUTOLOADED_ROUTINES = ''; # prevent -w error
3885 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
3888 'new' => <<'END_OF_FUNC',
3890 my($package,$interface,$boundary,$length) = @_;
3891 $FILLUNIT = $INITIAL_FILLUNIT;
3892 $CGI::DefaultClass->binmode($IN); # if $CGI::needs_binmode; # just do it always
3894 # If the user types garbage into the file upload field,
3895 # then Netscape passes NOTHING to the server (not good).
3896 # We may hang on this read in that case. So we implement
3897 # a read timeout. If nothing is ready to read
3898 # by then, we return.
3900 # Netscape seems to be a little bit unreliable
3901 # about providing boundary strings.
3902 my $boundary_read = 0;
3905 # Under the MIME spec, the boundary consists of the
3906 # characters "--" PLUS the Boundary string
3908 # BUG: IE 3.01 on the Macintosh uses just the boundary -- not
3909 # the two extra hyphens. We do a special case here on the user-agent!!!!
3910 $boundary = "--$boundary" unless CGI::user_agent('MSIE\s+3\.0[12];\s*Mac|DreamPassport');
3912 } else { # otherwise we find it ourselves
3914 ($old,$/) = ($/,$CRLF); # read a CRLF-delimited line
3915 $boundary = <STDIN>; # BUG: This won't work correctly under mod_perl
3916 $length -= length($boundary);
3917 chomp($boundary); # remove the CRLF
3918 $/ = $old; # restore old line separator
3922 my $self = {LENGTH=>$length,
3924 BOUNDARY=>$boundary,
3925 INTERFACE=>$interface,
3929 $FILLUNIT = length($boundary)
3930 if length($boundary) > $FILLUNIT;
3932 my $retval = bless $self,ref $package || $package;
3934 # Read the preamble and the topmost (boundary) line plus the CRLF.
3935 unless ($boundary_read) {
3936 while ($self->read(0)) { }
3938 die "Malformed multipart POST: data truncated\n" if $self->eof;
3944 'readHeader' => <<'END_OF_FUNC',
3951 local($CRLF) = "\015\012" if $CGI::OS eq 'VMS' || $CGI::EBCDIC;
3954 $self->fillBuffer($FILLUNIT);
3955 $ok++ if ($end = index($self->{BUFFER},"${CRLF}${CRLF}")) >= 0;
3956 $ok++ if $self->{BUFFER} eq '';
3957 $bad++ if !$ok && $self->{LENGTH} <= 0;
3958 # this was a bad idea
3959 # $FILLUNIT *= 2 if length($self->{BUFFER}) >= $FILLUNIT;
3960 } until $ok || $bad;
3963 #EBCDIC NOTE: translate header into EBCDIC, but watch out for continuation lines!
3965 my($header) = substr($self->{BUFFER},0,$end+2);
3966 substr($self->{BUFFER},0,$end+4) = '';
3970 warn "untranslated header=$header\n" if DEBUG;
3971 $header = CGI::Util::ascii2ebcdic($header);
3972 warn "translated header=$header\n" if DEBUG;
3975 # See RFC 2045 Appendix A and RFC 822 sections 3.4.8
3976 # (Folding Long Header Fields), 3.4.3 (Comments)
3977 # and 3.4.5 (Quoted-Strings).
3979 my $token = '[-\w!\#$%&\'*+.^_\`|{}~]';
3980 $header=~s/$CRLF\s+/ /og; # merge continuation lines
3982 while ($header=~/($token+):\s+([^$CRLF]*)/mgox) {
3983 my ($field_name,$field_value) = ($1,$2);
3984 $field_name =~ s/\b(\w)/uc($1)/eg; #canonicalize
3985 $return{$field_name}=$field_value;
3991 # This reads and returns the body as a single scalar value.
3992 'readBody' => <<'END_OF_FUNC',
3998 #EBCDIC NOTE: want to translate returnval into EBCDIC HERE
4000 while (defined($data = $self->read)) {
4001 $returnval .= $data;
4005 warn "untranslated body=$returnval\n" if DEBUG;
4006 $returnval = CGI::Util::ascii2ebcdic($returnval);
4007 warn "translated body=$returnval\n" if DEBUG;
4013 # This will read $bytes or until the boundary is hit, whichever happens
4014 # first. After the boundary is hit, we return undef. The next read will
4015 # skip over the boundary and begin reading again;
4016 'read' => <<'END_OF_FUNC',
4018 my($self,$bytes) = @_;
4020 # default number of bytes to read
4021 $bytes = $bytes || $FILLUNIT;
4023 # Fill up our internal buffer in such a way that the boundary
4024 # is never split between reads.
4025 $self->fillBuffer($bytes);
4027 my $boundary_start = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY}) : $self->{BOUNDARY};
4028 my $boundary_end = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY}.'--') : $self->{BOUNDARY}.'--';
4030 # Find the boundary in the buffer (it may not be there).
4031 my $start = index($self->{BUFFER},$boundary_start);
4033 warn "boundary=$self->{BOUNDARY} length=$self->{LENGTH} start=$start\n" if DEBUG;
4035 # protect against malformed multipart POST operations
4036 die "Malformed multipart POST\n" unless $self->{CHUNKED} || ($start >= 0 || $self->{LENGTH} > 0);
4038 #EBCDIC NOTE: want to translate boundary search into ASCII here.
4040 # If the boundary begins the data, then skip past it
4044 # clear us out completely if we've hit the last boundary.
4045 if (index($self->{BUFFER},$boundary_end)==0) {
4051 # just remove the boundary.
4052 substr($self->{BUFFER},0,length($boundary_start))='';
4053 $self->{BUFFER} =~ s/^\012\015?//;
4058 if ($start > 0) { # read up to the boundary
4059 $bytesToReturn = $start-2 > $bytes ? $bytes : $start;
4060 } else { # read the requested number of bytes
4061 # leave enough bytes in the buffer to allow us to read
4062 # the boundary. Thanks to Kevin Hendrick for finding
4064 $bytesToReturn = $bytes - (length($boundary_start)+1);
4067 my $returnval=substr($self->{BUFFER},0,$bytesToReturn);
4068 substr($self->{BUFFER},0,$bytesToReturn)='';
4070 # If we hit the boundary, remove the CRLF from the end.
4071 return ($bytesToReturn==$start)
4072 ? substr($returnval,0,-2) : $returnval;
4077 # This fills up our internal buffer in such a way that the
4078 # boundary is never split between reads
4079 'fillBuffer' => <<'END_OF_FUNC',
4081 my($self,$bytes) = @_;
4082 return unless $self->{CHUNKED} || $self->{LENGTH};
4084 my($boundaryLength) = length($self->{BOUNDARY});
4085 my($bufferLength) = length($self->{BUFFER});
4086 my($bytesToRead) = $bytes - $bufferLength + $boundaryLength + 2;
4087 $bytesToRead = $self->{LENGTH} if !$self->{CHUNKED} && $self->{LENGTH} < $bytesToRead;
4089 # Try to read some data. We may hang here if the browser is screwed up.
4090 my $bytesRead = $self->{INTERFACE}->read_from_client(\$self->{BUFFER},
4093 warn "bytesToRead=$bytesToRead, bufferLength=$bufferLength, buffer=$self->{BUFFER}\n" if DEBUG;
4094 $self->{BUFFER} = '' unless defined $self->{BUFFER};
4096 # An apparent bug in the Apache server causes the read()
4097 # to return zero bytes repeatedly without blocking if the
4098 # remote user aborts during a file transfer. I don't know how
4099 # they manage this, but the workaround is to abort if we get
4100 # more than SPIN_LOOP_MAX consecutive zero reads.
4101 if ($bytesRead <= 0) {
4102 die "CGI.pm: Server closed socket during multipart read (client aborted?).\n"
4103 if ($self->{ZERO_LOOP_COUNTER}++ >= $SPIN_LOOP_MAX);
4105 $self->{ZERO_LOOP_COUNTER}=0;
4108 $self->{LENGTH} -= $bytesRead if !$self->{CHUNKED} && $bytesRead;
4113 # Return true when we've finished reading
4114 'eof' => <<'END_OF_FUNC'
4117 return 1 if (length($self->{BUFFER}) == 0)
4118 && ($self->{LENGTH} <= 0);
4126 ####################################################################################
4127 ################################## TEMPORARY FILES #################################
4128 ####################################################################################
4129 package CGITempFile;
4133 $MAC = $CGI::OS eq 'MACINTOSH';
4134 my ($vol) = $MAC ? MacPerl::Volumes() =~ /:(.*)/ : "";
4135 unless (defined $TMPDIRECTORY) {
4136 @TEMP=("${SL}usr${SL}tmp","${SL}var${SL}tmp",
4137 "C:${SL}temp","${SL}tmp","${SL}temp",
4138 "${vol}${SL}Temporary Items",
4139 "${SL}WWW_ROOT", "${SL}SYS\$SCRATCH",
4140 "C:${SL}system${SL}temp");
4142 if( $CGI::OS eq 'WINDOWS' ){
4143 # PeterH: These evars may not exist if this is invoked within a service and untainting
4144 # is in effect - with 'use warnings' the undefined array entries causes Perl to die
4145 unshift(@TEMP,$ENV{TEMP}) if defined $ENV{TEMP};
4146 unshift(@TEMP,$ENV{TMP}) if defined $ENV{TMP};
4147 unshift(@TEMP,$ENV{WINDIR} . $SL . 'TEMP') if defined $ENV{WINDIR};
4150 unshift(@TEMP,$ENV{'TMPDIR'}) if defined $ENV{'TMPDIR'};
4152 # this feature was supposed to provide per-user tmpfiles, but
4153 # it is problematic.
4154 # unshift(@TEMP,(getpwuid($<))[7].'/tmp') if $CGI::OS eq 'UNIX';
4155 # Rob: getpwuid() is unfortunately UNIX specific. On brain dead OS'es this
4156 # : can generate a 'getpwuid() not implemented' exception, even though
4157 # : it's never called. Found under DOS/Win with the DJGPP perl port.
4158 # : Refer to getpwuid() only at run-time if we're fortunate and have UNIX.
4159 # unshift(@TEMP,(eval {(getpwuid($>))[7]}).'/tmp') if $CGI::OS eq 'UNIX' and $> != 0;
4162 do {$TMPDIRECTORY = $_; last} if -d $_ && -w _;
4165 $TMPDIRECTORY = $MAC ? "" : "." unless $TMPDIRECTORY;
4172 # cute feature, but overload implementation broke it
4173 # %OVERLOAD = ('""'=>'as_string');
4174 *CGITempFile::AUTOLOAD = \&CGI::AUTOLOAD;
4178 $$self =~ m!^([a-zA-Z0-9_ \'\":/.\$\\~-]+)$! || return;
4179 my $safe = $1; # untaint operation
4180 unlink $safe; # get rid of the file
4183 ###############################################################################
4184 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
4185 ###############################################################################
4186 $AUTOLOADED_ROUTINES = ''; # prevent -w error
4187 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
4190 'new' => <<'END_OF_FUNC',
4192 my($package,$sequence) = @_;
4194 find_tempdir() unless -w $TMPDIRECTORY;
4195 for (my $i = 0; $i < $MAXTRIES; $i++) {
4196 last if ! -f ($filename = sprintf("\%s${SL}CGItemp%d", $TMPDIRECTORY, $sequence++));
4198 # check that it is a more-or-less valid filename
4199 # Note this same regex is also used elsewhere in the same file for Fh::new
4200 return unless $filename =~ m!^([a-zA-Z0-9_ \'\":/.\$\\\+-]+)$!;
4201 # this used to untaint, now it doesn't
4203 return bless \$filename;
4207 'as_string' => <<'END_OF_FUNC'
4219 # We get a whole bunch of warnings about "possibly uninitialized variables"
4220 # when running with the -w switch. Touch them all once to get rid of the
4221 # warnings. This is ugly and I hate it.
4226 $MultipartBuffer::SPIN_LOOP_MAX;
4227 $MultipartBuffer::CRLF;
4228 $MultipartBuffer::TIMEOUT;
4229 $MultipartBuffer::INITIAL_FILLUNIT;
4240 CGI - Handle Common Gateway Interface requests and responses
4248 # Process an HTTP request
4249 @values = $q->param('form_field');
4251 $fh = $q->upload('file_field');
4253 $riddle = $query->cookie('riddle_name');
4254 %answers = $query->cookie('answers');
4256 # Prepare various HTTP responses
4258 print $q->header('application/json');
4260 $cookie1 = $q->cookie(-name=>'riddle_name', -value=>"The Sphynx's Question");
4261 $cookie2 = $q->cookie(-name=>'answers', -value=>\%answers);
4263 -type => 'image/gif',
4265 -cookie => [$cookie1,$cookie2]
4268 print $q->redirect('http://somewhere.else/in/movie/land');
4272 CGI.pm is a stable, complete and mature solution for processing and preparing
4273 HTTP requests and responses. Major features including processing form
4274 submissions, file uploads, reading and writing cookies, query string generation
4275 and manipulation, and processing and preparing HTTP headers. Some HTML
4276 generation utilities are included as well.
4278 CGI.pm performs very well in in a vanilla CGI.pm environment and also comes
4279 with built-in support for mod_perl and mod_perl2 as well as FastCGI.
4281 It has the benefit of having developed and refined over 10 years with input
4282 from dozens of contributors and being deployed on thousands of websites.
4283 CGI.pm has been included in the Perl distribution since Perl 5.4, and has
4284 become a de-facto standard.
4286 =head2 PROGRAMMING STYLE
4288 There are two styles of programming with CGI.pm, an object-oriented
4289 style and a function-oriented style. In the object-oriented style you
4290 create one or more CGI objects and then use object methods to create
4291 the various elements of the page. Each CGI object starts out with the
4292 list of named parameters that were passed to your CGI script by the
4293 server. You can modify the objects, save them to a file or database
4294 and recreate them. Because each object corresponds to the "state" of
4295 the CGI script, and because each object's parameter list is
4296 independent of the others, this allows you to save the state of the
4297 script and restore it later.
4299 For example, using the object oriented style, here is how you create
4300 a simple "Hello World" HTML page:
4302 #!/usr/local/bin/perl -w
4303 use CGI; # load CGI routines
4304 $q = new CGI; # create new CGI object
4305 print $q->header, # create the HTTP header
4306 $q->start_html('hello world'), # start the HTML
4307 $q->h1('hello world'), # level 1 header
4308 $q->end_html; # end the HTML
4310 In the function-oriented style, there is one default CGI object that
4311 you rarely deal with directly. Instead you just call functions to
4312 retrieve CGI parameters, create HTML tags, manage cookies, and so
4313 on. This provides you with a cleaner programming interface, but
4314 limits you to using one CGI object at a time. The following example
4315 prints the same page, but uses the function-oriented interface.
4316 The main differences are that we now need to import a set of functions
4317 into our name space (usually the "standard" functions), and we don't
4318 need to create the CGI object.
4320 #!/usr/local/bin/perl
4321 use CGI qw/:standard/; # load standard CGI routines
4322 print header, # create the HTTP header
4323 start_html('hello world'), # start the HTML
4324 h1('hello world'), # level 1 header
4325 end_html; # end the HTML
4327 The examples in this document mainly use the object-oriented style.
4328 See HOW TO IMPORT FUNCTIONS for important information on
4329 function-oriented programming in CGI.pm
4331 =head2 CALLING CGI.PM ROUTINES
4333 Most CGI.pm routines accept several arguments, sometimes as many as 20
4334 optional ones! To simplify this interface, all routines use a named
4335 argument calling style that looks like this:
4337 print $q->header(-type=>'image/gif',-expires=>'+3d');
4339 Each argument name is preceded by a dash. Neither case nor order
4340 matters in the argument list. -type, -Type, and -TYPE are all
4341 acceptable. In fact, only the first argument needs to begin with a
4342 dash. If a dash is present in the first argument, CGI.pm assumes
4343 dashes for the subsequent ones.
4345 Several routines are commonly called with just one argument. In the
4346 case of these routines you can provide the single argument without an
4347 argument name. header() happens to be one of these routines. In this
4348 case, the single argument is the document type.
4350 print $q->header('text/html');
4352 Other such routines are documented below.
4354 Sometimes named arguments expect a scalar, sometimes a reference to an
4355 array, and sometimes a reference to a hash. Often, you can pass any
4356 type of argument and the routine will do whatever is most appropriate.
4357 For example, the param() routine is used to set a CGI parameter to a
4358 single or a multi-valued value. The two cases are shown below:
4360 $q->param(-name=>'veggie',-value=>'tomato');
4361 $q->param(-name=>'veggie',-value=>['tomato','tomahto','potato','potahto']);
4363 A large number of routines in CGI.pm actually aren't specifically
4364 defined in the module, but are generated automatically as needed.
4365 These are the "HTML shortcuts," routines that generate HTML tags for
4366 use in dynamically-generated pages. HTML tags have both attributes
4367 (the attribute="value" pairs within the tag itself) and contents (the
4368 part between the opening and closing pairs.) To distinguish between
4369 attributes and contents, CGI.pm uses the convention of passing HTML
4370 attributes as a hash reference as the first argument, and the
4371 contents, if any, as any subsequent arguments. It works out like
4377 h1('some','contents'); <h1>some contents</h1>
4378 h1({-align=>left}); <h1 align="LEFT">
4379 h1({-align=>left},'contents'); <h1 align="LEFT">contents</h1>
4381 HTML tags are described in more detail later.
4383 Many newcomers to CGI.pm are puzzled by the difference between the
4384 calling conventions for the HTML shortcuts, which require curly braces
4385 around the HTML tag attributes, and the calling conventions for other
4386 routines, which manage to generate attributes without the curly
4387 brackets. Don't be confused. As a convenience the curly braces are
4388 optional in all but the HTML shortcuts. If you like, you can use
4389 curly braces when calling any routine that takes named arguments. For
4392 print $q->header( {-type=>'image/gif',-expires=>'+3d'} );
4394 If you use the B<-w> switch, you will be warned that some CGI.pm argument
4395 names conflict with built-in Perl functions. The most frequent of
4396 these is the -values argument, used to create multi-valued menus,
4397 radio button clusters and the like. To get around this warning, you
4398 have several choices:
4404 Use another name for the argument, if one is available.
4405 For example, -value is an alias for -values.
4409 Change the capitalization, e.g. -Values
4413 Put quotes around the argument name, e.g. '-values'
4417 Many routines will do something useful with a named argument that it
4418 doesn't recognize. For example, you can produce non-standard HTTP
4419 header fields by providing them as named arguments:
4421 print $q->header(-type => 'text/html',
4422 -cost => 'Three smackers',
4423 -annoyance_level => 'high',
4424 -complaints_to => 'bit bucket');
4426 This will produce the following nonstandard HTTP header:
4429 Cost: Three smackers
4430 Annoyance-level: high
4431 Complaints-to: bit bucket
4432 Content-type: text/html
4434 Notice the way that underscores are translated automatically into
4435 hyphens. HTML-generating routines perform a different type of
4438 This feature allows you to keep up with the rapidly changing HTTP and
4441 =head2 CREATING A NEW QUERY OBJECT (OBJECT-ORIENTED STYLE):
4445 This will parse the input (from both POST and GET methods) and store
4446 it into a perl5 object called $query.
4448 Any filehandles from file uploads will have their position reset to
4449 the beginning of the file.
4451 =head2 CREATING A NEW QUERY OBJECT FROM AN INPUT FILE
4453 $query = new CGI(INPUTFILE);
4455 If you provide a file handle to the new() method, it will read
4456 parameters from the file (or STDIN, or whatever). The file can be in
4457 any of the forms describing below under debugging (i.e. a series of
4458 newline delimited TAG=VALUE pairs will work). Conveniently, this type
4459 of file is created by the save() method (see below). Multiple records
4460 can be saved and restored.
4462 Perl purists will be pleased to know that this syntax accepts
4463 references to file handles, or even references to filehandle globs,
4464 which is the "official" way to pass a filehandle:
4466 $query = new CGI(\*STDIN);
4468 You can also initialize the CGI object with a FileHandle or IO::File
4471 If you are using the function-oriented interface and want to
4472 initialize CGI state from a file handle, the way to do this is with
4473 B<restore_parameters()>. This will (re)initialize the
4474 default CGI object from the indicated file handle.
4476 open (IN,"test.in") || die;
4477 restore_parameters(IN);
4480 You can also initialize the query object from a hash
4483 $query = new CGI( {'dinosaur'=>'barney',
4484 'song'=>'I love you',
4485 'friends'=>[qw/Jessica George Nancy/]}
4488 or from a properly formatted, URL-escaped query string:
4490 $query = new CGI('dinosaur=barney&color=purple');
4492 or from a previously existing CGI object (currently this clones the
4493 parameter list, but none of the other object-specific fields, such as
4496 $old_query = new CGI;
4497 $new_query = new CGI($old_query);
4499 To create an empty query, initialize it from an empty string or hash:
4501 $empty_query = new CGI("");
4505 $empty_query = new CGI({});
4507 =head2 FETCHING A LIST OF KEYWORDS FROM THE QUERY:
4509 @keywords = $query->keywords
4511 If the script was invoked as the result of an <ISINDEX> search, the
4512 parsed keywords can be obtained as an array using the keywords() method.
4514 =head2 FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT:
4516 @names = $query->param
4518 If the script was invoked with a parameter list
4519 (e.g. "name1=value1&name2=value2&name3=value3"), the param() method
4520 will return the parameter names as a list. If the script was invoked
4521 as an <ISINDEX> script and contains a string without ampersands
4522 (e.g. "value1+value2+value3") , there will be a single parameter named
4523 "keywords" containing the "+"-delimited keywords.
4525 NOTE: As of version 1.5, the array of parameter names returned will
4526 be in the same order as they were submitted by the browser.
4527 Usually this order is the same as the order in which the
4528 parameters are defined in the form (however, this isn't part
4529 of the spec, and so isn't guaranteed).
4531 =head2 FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER:
4533 @values = $query->param('foo');
4537 $value = $query->param('foo');
4539 Pass the param() method a single argument to fetch the value of the
4540 named parameter. If the parameter is multivalued (e.g. from multiple
4541 selections in a scrolling list), you can ask to receive an array. Otherwise
4542 the method will return a single value.
4544 If a value is not given in the query string, as in the queries
4545 "name1=&name2=", it will be returned as an empty string.
4548 If the parameter does not exist at all, then param() will return undef
4549 in a scalar context, and the empty list in a list context.
4552 =head2 SETTING THE VALUE(S) OF A NAMED PARAMETER:
4554 $query->param('foo','an','array','of','values');
4556 This sets the value for the named parameter 'foo' to an array of
4557 values. This is one way to change the value of a field AFTER
4558 the script has been invoked once before. (Another way is with
4559 the -override parameter accepted by all methods that generate
4562 param() also recognizes a named parameter style of calling described
4563 in more detail later:
4565 $query->param(-name=>'foo',-values=>['an','array','of','values']);
4569 $query->param(-name=>'foo',-value=>'the value');
4571 =head2 APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER:
4573 $query->append(-name=>'foo',-values=>['yet','more','values']);
4575 This adds a value or list of values to the named parameter. The
4576 values are appended to the end of the parameter if it already exists.
4577 Otherwise the parameter is created. Note that this method only
4578 recognizes the named argument calling syntax.
4580 =head2 IMPORTING ALL PARAMETERS INTO A NAMESPACE:
4582 $query->import_names('R');
4584 This creates a series of variables in the 'R' namespace. For example,
4585 $R::foo, @R:foo. For keyword lists, a variable @R::keywords will appear.
4586 If no namespace is given, this method will assume 'Q'.
4587 WARNING: don't import anything into 'main'; this is a major security
4590 NOTE 1: Variable names are transformed as necessary into legal Perl
4591 variable names. All non-legal characters are transformed into
4592 underscores. If you need to keep the original names, you should use
4593 the param() method instead to access CGI variables by name.
4595 NOTE 2: In older versions, this method was called B<import()>. As of version 2.20,
4596 this name has been removed completely to avoid conflict with the built-in
4597 Perl module B<import> operator.
4599 =head2 DELETING A PARAMETER COMPLETELY:
4601 $query->delete('foo','bar','baz');
4603 This completely clears a list of parameters. It sometimes useful for
4604 resetting parameters that you don't want passed down between script
4607 If you are using the function call interface, use "Delete()" instead
4608 to avoid conflicts with Perl's built-in delete operator.
4610 =head2 DELETING ALL PARAMETERS:
4612 $query->delete_all();
4614 This clears the CGI object completely. It might be useful to ensure
4615 that all the defaults are taken when you create a fill-out form.
4617 Use Delete_all() instead if you are using the function call interface.
4619 =head2 HANDLING NON-URLENCODED ARGUMENTS
4622 If POSTed data is not of type application/x-www-form-urlencoded or
4623 multipart/form-data, then the POSTed data will not be processed, but
4624 instead be returned as-is in a parameter named POSTDATA. To retrieve
4625 it, use code like this:
4627 my $data = $query->param('POSTDATA');
4629 Likewise if PUTed data can be retrieved with code like this:
4631 my $data = $query->param('PUTDATA');
4633 (If you don't know what the preceding means, don't worry about it. It
4634 only affects people trying to use CGI for XML processing and other
4638 =head2 DIRECT ACCESS TO THE PARAMETER LIST:
4640 $q->param_fetch('address')->[1] = '1313 Mockingbird Lane';
4641 unshift @{$q->param_fetch(-name=>'address')},'George Munster';
4643 If you need access to the parameter list in a way that isn't covered
4644 by the methods above, you can obtain a direct reference to it by
4645 calling the B<param_fetch()> method with the name of the . This
4646 will return an array reference to the named parameters, which you then
4647 can manipulate in any way you like.
4649 You can also use a named argument style using the B<-name> argument.
4651 =head2 FETCHING THE PARAMETER LIST AS A HASH:
4654 print $params->{'address'};
4655 @foo = split("\0",$params->{'foo'});
4661 Many people want to fetch the entire parameter list as a hash in which
4662 the keys are the names of the CGI parameters, and the values are the
4663 parameters' values. The Vars() method does this. Called in a scalar
4664 context, it returns the parameter list as a tied hash reference.
4665 Changing a key changes the value of the parameter in the underlying
4666 CGI parameter list. Called in a list context, it returns the
4667 parameter list as an ordinary hash. This allows you to read the
4668 contents of the parameter list, but not to change it.
4670 When using this, the thing you must watch out for are multivalued CGI
4671 parameters. Because a hash cannot distinguish between scalar and
4672 list context, multivalued parameters will be returned as a packed
4673 string, separated by the "\0" (null) character. You must split this
4674 packed string in order to get at the individual values. This is the
4675 convention introduced long ago by Steve Brenner in his cgi-lib.pl
4676 module for Perl version 4.
4678 If you wish to use Vars() as a function, import the I<:cgi-lib> set of
4679 function calls (also see the section on CGI-LIB compatibility).
4681 =head2 SAVING THE STATE OF THE SCRIPT TO A FILE:
4683 $query->save(\*FILEHANDLE)
4685 This will write the current state of the form to the provided
4686 filehandle. You can read it back in by providing a filehandle
4687 to the new() method. Note that the filehandle can be a file, a pipe,
4690 The format of the saved file is:
4698 Both name and value are URL escaped. Multi-valued CGI parameters are
4699 represented as repeated names. A session record is delimited by a
4700 single = symbol. You can write out multiple records and read them
4701 back in with several calls to B<new>. You can do this across several
4702 sessions by opening the file in append mode, allowing you to create
4703 primitive guest books, or to keep a history of users' queries. Here's
4704 a short example of creating multiple session records:
4708 open (OUT,">>test.out") || die;
4712 $q->param(-name=>'counter',-value=>$_);
4717 # reopen for reading
4718 open (IN,"test.out") || die;
4720 my $q = new CGI(\*IN);
4721 print $q->param('counter'),"\n";
4724 The file format used for save/restore is identical to that used by the
4725 Whitehead Genome Center's data exchange format "Boulderio", and can be
4726 manipulated and even databased using Boulderio utilities. See
4728 http://stein.cshl.org/boulder/
4730 for further details.
4732 If you wish to use this method from the function-oriented (non-OO)
4733 interface, the exported name for this method is B<save_parameters()>.
4735 =head2 RETRIEVING CGI ERRORS
4737 Errors can occur while processing user input, particularly when
4738 processing uploaded files. When these errors occur, CGI will stop
4739 processing and return an empty parameter list. You can test for
4740 the existence and nature of errors using the I<cgi_error()> function.
4741 The error messages are formatted as HTTP status codes. You can either
4742 incorporate the error text into an HTML page, or use it as the value
4745 my $error = $q->cgi_error;
4747 print $q->header(-status=>$error),
4748 $q->start_html('Problems'),
4749 $q->h2('Request not processed'),
4754 When using the function-oriented interface (see the next section),
4755 errors may only occur the first time you call I<param()>. Be ready
4758 =head2 USING THE FUNCTION-ORIENTED INTERFACE
4760 To use the function-oriented interface, you must specify which CGI.pm
4761 routines or sets of routines to import into your script's namespace.
4762 There is a small overhead associated with this importation, but it
4765 use CGI <list of methods>;
4767 The listed methods will be imported into the current package; you can
4768 call them directly without creating a CGI object first. This example
4769 shows how to import the B<param()> and B<header()>
4770 methods, and then use them directly:
4772 use CGI 'param','header';
4773 print header('text/plain');
4774 $zipcode = param('zipcode');
4776 More frequently, you'll import common sets of functions by referring
4777 to the groups by name. All function sets are preceded with a ":"
4778 character as in ":html3" (for tags defined in the HTML 3 standard).
4780 Here is a list of the function sets you can import:
4786 Import all CGI-handling methods, such as B<param()>, B<path_info()>
4791 Import all fill-out form generating methods, such as B<textfield()>.
4795 Import all methods that generate HTML 2.0 standard elements.
4799 Import all methods that generate HTML 3.0 elements (such as
4800 <table>, <super> and <sub>).
4804 Import all methods that generate HTML 4 elements (such as
4805 <abbrev>, <acronym> and <thead>).
4809 Import all methods that generate Netscape-specific HTML extensions.
4813 Import all HTML-generating shortcuts (i.e. 'html2' + 'html3' +
4818 Import "standard" features, 'html2', 'html3', 'html4', 'form' and 'cgi'.
4822 Import all the available methods. For the full list, see the CGI.pm
4823 code, where the variable %EXPORT_TAGS is defined.
4827 If you import a function name that is not part of CGI.pm, the module
4828 will treat it as a new HTML tag and generate the appropriate
4829 subroutine. You can then use it like any other HTML tag. This is to
4830 provide for the rapidly-evolving HTML "standard." For example, say
4831 Microsoft comes out with a new tag called <gradient> (which causes the
4832 user's desktop to be flooded with a rotating gradient fill until his
4833 machine reboots). You don't need to wait for a new version of CGI.pm
4834 to start using it immediately:
4836 use CGI qw/:standard :html3 gradient/;
4837 print gradient({-start=>'red',-end=>'blue'});
4839 Note that in the interests of execution speed CGI.pm does B<not> use
4840 the standard L<Exporter> syntax for specifying load symbols. This may
4841 change in the future.
4843 If you import any of the state-maintaining CGI or form-generating
4844 methods, a default CGI object will be created and initialized
4845 automatically the first time you use any of the methods that require
4846 one to be present. This includes B<param()>, B<textfield()>,
4847 B<submit()> and the like. (If you need direct access to the CGI
4848 object, you can find it in the global variable B<$CGI::Q>). By
4849 importing CGI.pm methods, you can create visually elegant scripts:
4851 use CGI qw/:standard/;
4854 start_html('Simple Script'),
4855 h1('Simple Script'),
4857 "What's your name? ",textfield('name'),p,
4858 "What's the combination?",
4859 checkbox_group(-name=>'words',
4860 -values=>['eenie','meenie','minie','moe'],
4861 -defaults=>['eenie','moe']),p,
4862 "What's your favorite color?",
4863 popup_menu(-name=>'color',
4864 -values=>['red','green','blue','chartreuse']),p,
4871 "Your name is ",em(param('name')),p,
4872 "The keywords are: ",em(join(", ",param('words'))),p,
4873 "Your favorite color is ",em(param('color')),".\n";
4879 In addition to the function sets, there are a number of pragmas that
4880 you can import. Pragmas, which are always preceded by a hyphen,
4881 change the way that CGI.pm functions in various ways. Pragmas,
4882 function sets, and individual functions can all be imported in the
4883 same use() line. For example, the following use statement imports the
4884 standard set of functions and enables debugging mode (pragma
4887 use CGI qw/:standard -debug/;
4889 The current list of pragmas is as follows:
4895 When you I<use CGI -any>, then any method that the query object
4896 doesn't recognize will be interpreted as a new HTML tag. This allows
4897 you to support the next I<ad hoc> Netscape or Microsoft HTML
4898 extension. This lets you go wild with new and unsupported tags:
4902 print $q->gradient({speed=>'fast',start=>'red',end=>'blue'});
4904 Since using <cite>any</cite> causes any mistyped method name
4905 to be interpreted as an HTML tag, use it with care or not at
4910 This causes the indicated autoloaded methods to be compiled up front,
4911 rather than deferred to later. This is useful for scripts that run
4912 for an extended period of time under FastCGI or mod_perl, and for
4913 those destined to be crunched by Malcolm Beattie's Perl compiler. Use
4914 it in conjunction with the methods or method families you plan to use.
4916 use CGI qw(-compile :standard :html3);
4920 use CGI qw(-compile :all);
4922 Note that using the -compile pragma in this way will always have
4923 the effect of importing the compiled functions into the current
4924 namespace. If you want to compile without importing use the
4925 compile() method instead:
4930 This is particularly useful in a mod_perl environment, in which you
4931 might want to precompile all CGI routines in a startup script, and
4932 then import the functions individually in each mod_perl script.
4936 By default the CGI module implements a state-preserving behavior
4937 called "sticky" fields. The way this works is that if you are
4938 regenerating a form, the methods that generate the form field values
4939 will interrogate param() to see if similarly-named parameters are
4940 present in the query string. If they find a like-named parameter, they
4941 will use it to set their default values.
4943 Sometimes this isn't what you want. The B<-nosticky> pragma prevents
4944 this behavior. You can also selectively change the sticky behavior in
4945 each element that you generate.
4949 Automatically add tab index attributes to each form field. With this
4950 option turned off, you can still add tab indexes manually by passing a
4951 -tabindex option to each field-generating method.
4953 =item -no_undef_params
4955 This keeps CGI.pm from including undef params in the parameter list.
4959 By default, CGI.pm versions 2.69 and higher emit XHTML
4960 (http://www.w3.org/TR/xhtml1/). The -no_xhtml pragma disables this
4961 feature. Thanks to Michalis Kabrianis <kabrianis@hellug.gr> for this
4964 If start_html()'s -dtd parameter specifies an HTML 2.0 or 3.2 DTD,
4965 XHTML will automatically be disabled without needing to use this
4970 This makes CGI.pm treat all parameters as UTF-8 strings. Use this with
4971 care, as it will interfere with the processing of binary uploads. It
4972 is better to manually select which fields are expected to return utf-8
4973 strings and convert them using code like this:
4976 my $arg = decode utf8=>param('foo');
4980 This makes CGI.pm produce a header appropriate for an NPH (no
4981 parsed header) script. You may need to do other things as well
4982 to tell the server that the script is NPH. See the discussion
4983 of NPH scripts below.
4985 =item -newstyle_urls
4987 Separate the name=value pairs in CGI parameter query strings with
4988 semicolons rather than ampersands. For example:
4990 ?name=fred;age=24;favorite_color=3
4992 Semicolon-delimited query strings are always accepted, but will not be
4993 emitted by self_url() and query_string() unless the -newstyle_urls
4994 pragma is specified.
4996 This became the default in version 2.64.
4998 =item -oldstyle_urls
5000 Separate the name=value pairs in CGI parameter query strings with
5001 ampersands rather than semicolons. This is no longer the default.
5005 This overrides the autoloader so that any function in your program
5006 that is not recognized is referred to CGI.pm for possible evaluation.
5007 This allows you to use all the CGI.pm functions without adding them to
5008 your symbol table, which is of concern for mod_perl users who are
5009 worried about memory consumption. I<Warning:> when
5010 I<-autoload> is in effect, you cannot use "poetry mode"
5011 (functions without the parenthesis). Use I<hr()> rather
5012 than I<hr>, or add something like I<use subs qw/hr p header/>
5013 to the top of your script.
5017 This turns off the command-line processing features. If you want to
5018 run a CGI.pm script from the command line to produce HTML, and you
5019 don't want it to read CGI parameters from the command line or STDIN,
5020 then use this pragma:
5022 use CGI qw(-no_debug :standard);
5026 This turns on full debugging. In addition to reading CGI arguments
5027 from the command-line processing, CGI.pm will pause and try to read
5028 arguments from STDIN, producing the message "(offline mode: enter
5029 name=value pairs on standard input)" features.
5031 See the section on debugging for more details.
5033 =item -private_tempfiles
5035 CGI.pm can process uploaded file. Ordinarily it spools the uploaded
5036 file to a temporary directory, then deletes the file when done.
5037 However, this opens the risk of eavesdropping as described in the file
5038 upload section. Another CGI script author could peek at this data
5039 during the upload, even if it is confidential information. On Unix
5040 systems, the -private_tempfiles pragma will cause the temporary file
5041 to be unlinked as soon as it is opened and before any data is written
5042 into it, reducing, but not eliminating the risk of eavesdropping
5043 (there is still a potential race condition). To make life harder for
5044 the attacker, the program chooses tempfile names by calculating a 32
5045 bit checksum of the incoming HTTP headers.
5047 To ensure that the temporary file cannot be read by other CGI scripts,
5048 use suEXEC or a CGI wrapper program to run your script. The temporary
5049 file is created with mode 0600 (neither world nor group readable).
5051 The temporary directory is selected using the following algorithm:
5053 1. if the current user (e.g. "nobody") has a directory named
5054 "tmp" in its home directory, use that (Unix systems only).
5056 2. if the environment variable TMPDIR exists, use the location
5059 3. Otherwise try the locations /usr/tmp, /var/tmp, C:\temp,
5060 /tmp, /temp, ::Temporary Items, and \WWW_ROOT.
5062 Each of these locations is checked that it is a directory and is
5063 writable. If not, the algorithm tries the next choice.
5067 =head2 SPECIAL FORMS FOR IMPORTING HTML-TAG FUNCTIONS
5069 Many of the methods generate HTML tags. As described below, tag
5070 functions automatically generate both the opening and closing tags.
5073 print h1('Level 1 Header');
5077 <h1>Level 1 Header</h1>
5079 There will be some times when you want to produce the start and end
5080 tags yourself. In this case, you can use the form start_I<tag_name>
5081 and end_I<tag_name>, as in:
5083 print start_h1,'Level 1 Header',end_h1;
5085 With a few exceptions (described below), start_I<tag_name> and
5086 end_I<tag_name> functions are not generated automatically when you
5087 I<use CGI>. However, you can specify the tags you want to generate
5088 I<start/end> functions for by putting an asterisk in front of their
5089 name, or, alternatively, requesting either "start_I<tag_name>" or
5090 "end_I<tag_name>" in the import list.
5094 use CGI qw/:standard *table start_ul/;
5096 In this example, the following functions are generated in addition to
5101 =item 1. start_table() (generates a <table> tag)
5103 =item 2. end_table() (generates a </table> tag)
5105 =item 3. start_ul() (generates a <ul> tag)
5107 =item 4. end_ul() (generates a </ul> tag)
5111 =head1 GENERATING DYNAMIC DOCUMENTS
5113 Most of CGI.pm's functions deal with creating documents on the fly.
5114 Generally you will produce the HTTP header first, followed by the
5115 document itself. CGI.pm provides functions for generating HTTP
5116 headers of various types as well as for generating HTML. For creating
5117 GIF images, see the GD.pm module.
5119 Each of these functions produces a fragment of HTML or HTTP which you
5120 can print out directly so that it displays in the browser window,
5121 append to a string, or save to a file for later use.
5123 =head2 CREATING A STANDARD HTTP HEADER:
5125 Normally the first thing you will do in any CGI script is print out an
5126 HTTP header. This tells the browser what type of document to expect,
5127 and gives other optional information, such as the language, expiration
5128 date, and whether to cache the document. The header can also be
5129 manipulated for special purposes, such as server push and pay per view
5136 print header('image/gif');
5140 print header('text/html','204 No response');
5144 print header(-type=>'image/gif',
5146 -status=>'402 Payment required',
5150 -attachment=>'foo.gif',
5153 header() returns the Content-type: header. You can provide your own
5154 MIME type if you choose, otherwise it defaults to text/html. An
5155 optional second parameter specifies the status code and a human-readable
5156 message. For example, you can specify 204, "No response" to create a
5157 script that tells the browser to do nothing at all.
5159 The last example shows the named argument style for passing arguments
5160 to the CGI methods using named parameters. Recognized parameters are
5161 B<-type>, B<-status>, B<-expires>, and B<-cookie>. Any other named
5162 parameters will be stripped of their initial hyphens and turned into
5163 header fields, allowing you to specify any HTTP header you desire.
5164 Internal underscores will be turned into hyphens:
5166 print header(-Content_length=>3002);
5168 Most browsers will not cache the output from CGI scripts. Every time
5169 the browser reloads the page, the script is invoked anew. You can
5170 change this behavior with the B<-expires> parameter. When you specify
5171 an absolute or relative expiration interval with this parameter, some
5172 browsers and proxy servers will cache the script's output until the
5173 indicated expiration date. The following forms are all valid for the
5176 +30s 30 seconds from now
5177 +10m ten minutes from now
5178 +1h one hour from now
5179 -1d yesterday (i.e. "ASAP!")
5182 +10y in ten years time
5183 Thursday, 25-Apr-1999 00:40:33 GMT at the indicated time & date
5185 The B<-cookie> parameter generates a header that tells the browser to provide
5186 a "magic cookie" during all subsequent transactions with your script.
5187 Netscape cookies have a special format that includes interesting attributes
5188 such as expiration time. Use the cookie() method to create and retrieve
5191 The B<-nph> parameter, if set to a true value, will issue the correct
5192 headers to work with a NPH (no-parse-header) script. This is important
5193 to use with certain servers that expect all their scripts to be NPH.
5195 The B<-charset> parameter can be used to control the character set
5196 sent to the browser. If not provided, defaults to ISO-8859-1. As a
5197 side effect, this sets the charset() method as well.
5199 The B<-attachment> parameter can be used to turn the page into an
5200 attachment. Instead of displaying the page, some browsers will prompt
5201 the user to save it to disk. The value of the argument is the
5202 suggested name for the saved file. In order for this to work, you may
5203 have to set the B<-type> to "application/octet-stream".
5205 The B<-p3p> parameter will add a P3P tag to the outgoing header. The
5206 parameter can be an arrayref or a space-delimited string of P3P tags.
5209 print header(-p3p=>[qw(CAO DSP LAW CURa)]);
5210 print header(-p3p=>'CAO DSP LAW CURa');
5212 In either case, the outgoing header will be formatted as:
5214 P3P: policyref="/w3c/p3p.xml" cp="CAO DSP LAW CURa"
5216 =head2 GENERATING A REDIRECTION HEADER
5218 print $q->redirect('http://somewhere.else/in/movie/land');
5220 Sometimes you don't want to produce a document yourself, but simply
5221 redirect the browser elsewhere, perhaps choosing a URL based on the
5222 time of day or the identity of the user.
5224 The redirect() method redirects the browser to a different URL. If
5225 you use redirection like this, you should B<not> print out a header as
5228 You should always use full URLs (including the http: or ftp: part) in
5229 redirection requests. Relative URLs will not work correctly.
5231 You can also use named arguments:
5234 -uri=>'http://somewhere.else/in/movie/land',
5238 All names arguments recognized by header() are also recognized by
5239 redirect(). However, most HTTP headers, including those generated by
5240 -cookie and -target, are ignored by the browser.
5242 The B<-nph> parameter, if set to a true value, will issue the correct
5243 headers to work with a NPH (no-parse-header) script. This is important
5244 to use with certain servers, such as Microsoft IIS, which
5245 expect all their scripts to be NPH.
5247 The B<-status> parameter will set the status of the redirect. HTTP
5248 defines three different possible redirection status codes:
5250 301 Moved Permanently
5254 The default if not specified is 302, which means "moved temporarily."
5255 You may change the status to another status code if you wish. Be
5256 advised that changing the status to anything other than 301, 302 or
5257 303 will probably break redirection.
5259 =head2 CREATING THE HTML DOCUMENT HEADER
5261 print start_html(-title=>'Secrets of the Pyramids',
5262 -author=>'fred@capricorn.org',
5265 -meta=>{'keywords'=>'pharaoh secret mummy',
5266 'copyright'=>'copyright 1996 King Tut'},
5267 -style=>{'src'=>'/styles/style1.css'},
5270 After creating the HTTP header, most CGI scripts will start writing
5271 out an HTML document. The start_html() routine creates the top of the
5272 page, along with a lot of optional information that controls the
5273 page's appearance and behavior.
5275 This method returns a canned HTML header and the opening <body> tag.
5276 All parameters are optional. In the named parameter form, recognized
5277 parameters are -title, -author, -base, -xbase, -dtd, -lang and -target
5278 (see below for the explanation). Any additional parameters you
5279 provide, such as the Netscape unofficial BGCOLOR attribute, are added
5280 to the <body> tag. Additional parameters must be proceeded by a
5283 The argument B<-xbase> allows you to provide an HREF for the <base> tag
5284 different from the current location, as in
5286 -xbase=>"http://home.mcom.com/"
5288 All relative links will be interpreted relative to this tag.
5290 The argument B<-target> allows you to provide a default target frame
5291 for all the links and fill-out forms on the page. B<This is a
5292 non-standard HTTP feature which only works with Netscape browsers!>
5293 See the Netscape documentation on frames for details of how to
5296 -target=>"answer_window"
5298 All relative links will be interpreted relative to this tag.
5299 You add arbitrary meta information to the header with the B<-meta>
5300 argument. This argument expects a reference to a hash
5301 containing name/value pairs of meta information. These will be turned
5302 into a series of header <meta> tags that look something like this:
5304 <meta name="keywords" content="pharaoh secret mummy">
5305 <meta name="description" content="copyright 1996 King Tut">
5307 To create an HTTP-EQUIV type of <meta> tag, use B<-head>, described
5310 The B<-style> argument is used to incorporate cascading stylesheets
5311 into your code. See the section on CASCADING STYLESHEETS for more
5314 The B<-lang> argument is used to incorporate a language attribute into
5315 the <html> tag. For example:
5317 print $q->start_html(-lang=>'fr-CA');
5319 The default if not specified is "en-US" for US English, unless the
5320 -dtd parameter specifies an HTML 2.0 or 3.2 DTD, in which case the
5321 lang attribute is left off. You can force the lang attribute to left
5322 off in other cases by passing an empty string (-lang=>'').
5324 The B<-encoding> argument can be used to specify the character set for
5325 XHTML. It defaults to iso-8859-1 if not specified.
5327 The B<-declare_xml> argument, when used in conjunction with XHTML,
5328 will put a <?xml> declaration at the top of the HTML header. The sole
5329 purpose of this declaration is to declare the character set
5330 encoding. In the absence of -declare_xml, the output HTML will contain
5331 a <meta> tag that specifies the encoding, allowing the HTML to pass
5332 most validators. The default for -declare_xml is false.
5334 You can place other arbitrary HTML elements to the <head> section with the
5335 B<-head> tag. For example, to place the rarely-used <link> element in the
5336 head section, use this:
5338 print start_html(-head=>Link({-rel=>'next',
5339 -href=>'http://www.capricorn.com/s2.html'}));
5341 To incorporate multiple HTML elements into the <head> section, just pass an
5344 print start_html(-head=>[
5346 -href=>'http://www.capricorn.com/s2.html'}),
5347 Link({-rel=>'previous',
5348 -href=>'http://www.capricorn.com/s1.html'})
5352 And here's how to create an HTTP-EQUIV <meta> tag:
5354 print start_html(-head=>meta({-http_equiv => 'Content-Type',
5355 -content => 'text/html'}))
5358 JAVASCRIPTING: The B<-script>, B<-noScript>, B<-onLoad>,
5359 B<-onMouseOver>, B<-onMouseOut> and B<-onUnload> parameters are used
5360 to add Netscape JavaScript calls to your pages. B<-script> should
5361 point to a block of text containing JavaScript function definitions.
5362 This block will be placed within a <script> block inside the HTML (not
5363 HTTP) header. The block is placed in the header in order to give your
5364 page a fighting chance of having all its JavaScript functions in place
5365 even if the user presses the stop button before the page has loaded
5366 completely. CGI.pm attempts to format the script in such a way that
5367 JavaScript-naive browsers will not choke on the code: unfortunately
5368 there are some browsers, such as Chimera for Unix, that get confused
5371 The B<-onLoad> and B<-onUnload> parameters point to fragments of JavaScript
5372 code to execute when the page is respectively opened and closed by the
5373 browser. Usually these parameters are calls to functions defined in the
5379 // Ask a silly question
5380 function riddle_me_this() {
5381 var r = prompt("What walks on four legs in the morning, " +
5382 "two legs in the afternoon, " +
5383 "and three legs in the evening?");
5386 // Get a silly answer
5387 function response(answer) {
5388 if (answer == "man")
5389 alert("Right you are!");
5391 alert("Wrong! Guess again.");
5394 print start_html(-title=>'The Riddle of the Sphinx',
5397 Use the B<-noScript> parameter to pass some HTML text that will be displayed on
5398 browsers that do not have JavaScript (or browsers where JavaScript is turned
5401 The <script> tag, has several attributes including "type" and src.
5402 The latter is particularly interesting, as it allows you to keep the
5403 JavaScript code in a file or CGI script rather than cluttering up each
5404 page with the source. To use these attributes pass a HASH reference
5405 in the B<-script> parameter containing one or more of -type, -src, or
5408 print $q->start_html(-title=>'The Riddle of the Sphinx',
5409 -script=>{-type=>'JAVASCRIPT',
5410 -src=>'/javascript/sphinx.js'}
5413 print $q->(-title=>'The Riddle of the Sphinx',
5414 -script=>{-type=>'PERLSCRIPT',
5415 -code=>'print "hello world!\n;"'}
5419 A final feature allows you to incorporate multiple <script> sections into the
5420 header. Just pass the list of script sections as an array reference.
5421 this allows you to specify different source files for different dialects
5422 of JavaScript. Example:
5424 print $q->start_html(-title=>'The Riddle of the Sphinx',
5426 { -type => 'text/javascript',
5427 -src => '/javascript/utilities10.js'
5429 { -type => 'text/javascript',
5430 -src => '/javascript/utilities11.js'
5432 { -type => 'text/jscript',
5433 -src => '/javascript/utilities12.js'
5435 { -type => 'text/ecmascript',
5436 -src => '/javascript/utilities219.js'
5441 The option "-language" is a synonym for -type, and is supported for
5442 backwad compatibility.
5444 The old-style positional parameters are as follows:
5448 =item B<Parameters:>
5456 The author's e-mail address (will create a <link rev="MADE"> tag if present
5460 A 'true' flag if you want to include a <base> tag in the header. This
5461 helps resolve relative addresses to absolute ones when the document is moved,
5462 but makes the document hierarchy non-portable. Use with care!
5466 Any other parameters you want to include in the <body> tag. This is a good
5467 place to put Netscape extensions, such as colors and wallpaper patterns.
5471 =head2 ENDING THE HTML DOCUMENT:
5475 This ends an HTML document by printing the </body></html> tags.
5477 =head2 CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION:
5480 print q(<a href="$myself">I'm talking to myself.</a>);
5482 self_url() will return a URL, that, when selected, will reinvoke
5483 this script with all its state information intact. This is most
5484 useful when you want to jump around within the document using
5485 internal anchors but you don't want to disrupt the current contents
5486 of the form(s). Something like this will do the trick.
5489 print "<a href=\"$myself#table1\">See table 1</a>";
5490 print "<a href=\"$myself#table2\">See table 2</a>";
5491 print "<a href=\"$myself#yourself\">See for yourself</a>";
5493 If you want more control over what's returned, using the B<url()>
5496 You can also retrieve the unprocessed query string with query_string():
5498 $the_string = query_string;
5500 =head2 OBTAINING THE SCRIPT'S URL
5503 $full_url = url(-full=>1); #alternative syntax
5504 $relative_url = url(-relative=>1);
5505 $absolute_url = url(-absolute=>1);
5506 $url_with_path = url(-path_info=>1);
5507 $url_with_path_and_query = url(-path_info=>1,-query=>1);
5508 $netloc = url(-base => 1);
5510 B<url()> returns the script's URL in a variety of formats. Called
5511 without any arguments, it returns the full form of the URL, including
5512 host name and port number
5514 http://your.host.com/path/to/script.cgi
5516 You can modify this format with the following named arguments:
5522 If true, produce an absolute URL, e.g.
5528 Produce a relative URL. This is useful if you want to reinvoke your
5529 script with different parameters. For example:
5535 Produce the full URL, exactly as if called without any arguments.
5536 This overrides the -relative and -absolute arguments.
5538 =item B<-path> (B<-path_info>)
5540 Append the additional path information to the URL. This can be
5541 combined with B<-full>, B<-absolute> or B<-relative>. B<-path_info>
5542 is provided as a synonym.
5544 =item B<-query> (B<-query_string>)
5546 Append the query string to the URL. This can be combined with
5547 B<-full>, B<-absolute> or B<-relative>. B<-query_string> is provided
5552 Generate just the protocol and net location, as in http://www.foo.com:8000
5556 If Apache's mod_rewrite is turned on, then the script name and path
5557 info probably won't match the request that the user sent. Set
5558 -rewrite=>1 (default) to return URLs that match what the user sent
5559 (the original request URI). Set -rewrite=>0 to return URLs that match
5560 the URL after mod_rewrite's rules have run. Because the additional
5561 path information only makes sense in the context of the rewritten URL,
5562 -rewrite is set to false when you request path info in the URL.
5566 =head2 MIXING POST AND URL PARAMETERS
5568 $color = url_param('color');
5570 It is possible for a script to receive CGI parameters in the URL as
5571 well as in the fill-out form by creating a form that POSTs to a URL
5572 containing a query string (a "?" mark followed by arguments). The
5573 B<param()> method will always return the contents of the POSTed
5574 fill-out form, ignoring the URL's query string. To retrieve URL
5575 parameters, call the B<url_param()> method. Use it in the same way as
5576 B<param()>. The main difference is that it allows you to read the
5577 parameters, but not set them.
5580 Under no circumstances will the contents of the URL query string
5581 interfere with similarly-named CGI parameters in POSTed forms. If you
5582 try to mix a URL query string with a form submitted with the GET
5583 method, the results will not be what you expect.
5585 =head1 CREATING STANDARD HTML ELEMENTS:
5587 CGI.pm defines general HTML shortcut methods for most, if not all of
5588 the HTML 3 and HTML 4 tags. HTML shortcuts are named after a single
5589 HTML element and return a fragment of HTML text that you can then
5590 print or manipulate as you like. Each shortcut returns a fragment of
5591 HTML code that you can append to a string, save to a file, or, most
5592 commonly, print out so that it displays in the browser window.
5594 This example shows how to use the HTML methods:
5596 print $q->blockquote(
5597 "Many years ago on the island of",
5598 $q->a({href=>"http://crete.org/"},"Crete"),
5599 "there lived a Minotaur named",
5600 $q->strong("Fred."),
5604 This results in the following HTML code (extra newlines have been
5605 added for readability):
5608 Many years ago on the island of
5609 <a href="http://crete.org/">Crete</a> there lived
5610 a minotaur named <strong>Fred.</strong>
5614 If you find the syntax for calling the HTML shortcuts awkward, you can
5615 import them into your namespace and dispense with the object syntax
5616 completely (see the next section for more details):
5618 use CGI ':standard';
5620 "Many years ago on the island of",
5621 a({href=>"http://crete.org/"},"Crete"),
5622 "there lived a minotaur named",
5627 =head2 PROVIDING ARGUMENTS TO HTML SHORTCUTS
5629 The HTML methods will accept zero, one or multiple arguments. If you
5630 provide no arguments, you get a single tag:
5634 If you provide one or more string arguments, they are concatenated
5635 together with spaces and placed between opening and closing tags:
5637 print h1("Chapter","1"); # <h1>Chapter 1</h1>"
5639 If the first argument is a hash reference, then the keys
5640 and values of the hash become the HTML tag's attributes:
5642 print a({-href=>'fred.html',-target=>'_new'},
5643 "Open a new frame");
5645 <a href="fred.html",target="_new">Open a new frame</a>
5647 You may dispense with the dashes in front of the attribute names if
5650 print img {src=>'fred.gif',align=>'LEFT'};
5652 <img align="LEFT" src="fred.gif">
5654 Sometimes an HTML tag attribute has no argument. For example, ordered
5655 lists can be marked as COMPACT. The syntax for this is an argument that
5656 that points to an undef string:
5658 print ol({compact=>undef},li('one'),li('two'),li('three'));
5660 Prior to CGI.pm version 2.41, providing an empty ('') string as an
5661 attribute argument was the same as providing undef. However, this has
5662 changed in order to accommodate those who want to create tags of the form
5663 <img alt="">. The difference is shown in these two pieces of code:
5666 img({alt=>undef}) <img alt>
5667 img({alt=>''}) <img alt="">
5669 =head2 THE DISTRIBUTIVE PROPERTY OF HTML SHORTCUTS
5671 One of the cool features of the HTML shortcuts is that they are
5672 distributive. If you give them an argument consisting of a
5673 B<reference> to a list, the tag will be distributed across each
5674 element of the list. For example, here's one way to make an ordered
5678 li({-type=>'disc'},['Sneezy','Doc','Sleepy','Happy'])
5681 This example will result in HTML output that looks like this:
5684 <li type="disc">Sneezy</li>
5685 <li type="disc">Doc</li>
5686 <li type="disc">Sleepy</li>
5687 <li type="disc">Happy</li>
5690 This is extremely useful for creating tables. For example:
5692 print table({-border=>undef},
5693 caption('When Should You Eat Your Vegetables?'),
5694 Tr({-align=>'CENTER',-valign=>'TOP'},
5696 th(['Vegetable', 'Breakfast','Lunch','Dinner']),
5697 td(['Tomatoes' , 'no', 'yes', 'yes']),
5698 td(['Broccoli' , 'no', 'no', 'yes']),
5699 td(['Onions' , 'yes','yes', 'yes'])
5704 =head2 HTML SHORTCUTS AND LIST INTERPOLATION
5706 Consider this bit of code:
5708 print blockquote(em('Hi'),'mom!'));
5710 It will ordinarily return the string that you probably expect, namely:
5712 <blockquote><em>Hi</em> mom!</blockquote>
5714 Note the space between the element "Hi" and the element "mom!".
5715 CGI.pm puts the extra space there using array interpolation, which is
5716 controlled by the magic $" variable. Sometimes this extra space is
5717 not what you want, for example, when you are trying to align a series
5718 of images. In this case, you can simply change the value of $" to an
5723 print blockquote(em('Hi'),'mom!'));
5726 I suggest you put the code in a block as shown here. Otherwise the
5727 change to $" will affect all subsequent code until you explicitly
5730 =head2 NON-STANDARD HTML SHORTCUTS
5732 A few HTML tags don't follow the standard pattern for various
5735 B<comment()> generates an HTML comment (<!-- comment -->). Call it
5738 print comment('here is my comment');
5740 Because of conflicts with built-in Perl functions, the following functions
5741 begin with initial caps:
5750 In addition, start_html(), end_html(), start_form(), end_form(),
5751 start_multipart_form() and all the fill-out form tags are special.
5752 See their respective sections.
5754 =head2 AUTOESCAPING HTML
5756 By default, all HTML that is emitted by the form-generating functions
5757 is passed through a function called escapeHTML():
5761 =item $escaped_string = escapeHTML("unescaped string");
5763 Escape HTML formatting characters in a string.
5767 Provided that you have specified a character set of ISO-8859-1 (the
5768 default), the standard HTML escaping rules will be used. The "<"
5769 character becomes "<", ">" becomes ">", "&" becomes "&", and
5770 the quote character becomes """. In addition, the hexadecimal
5771 0x8b and 0x9b characters, which some browsers incorrectly interpret
5772 as the left and right angle-bracket characters, are replaced by their
5773 numeric character entities ("‹" and "›"). If you manually change
5774 the charset, either by calling the charset() method explicitly or by
5775 passing a -charset argument to header(), then B<all> characters will
5776 be replaced by their numeric entities, since CGI.pm has no lookup
5777 table for all the possible encodings.
5779 The automatic escaping does not apply to other shortcuts, such as
5780 h1(). You should call escapeHTML() yourself on untrusted data in
5781 order to protect your pages against nasty tricks that people may enter
5782 into guestbooks, etc.. To change the character set, use charset().
5783 To turn autoescaping off completely, use autoEscape(0):
5787 =item $charset = charset([$charset]);
5789 Get or set the current character set.
5791 =item $flag = autoEscape([$flag]);
5793 Get or set the value of the autoescape flag.
5797 =head2 PRETTY-PRINTING HTML
5799 By default, all the HTML produced by these functions comes out as one
5800 long line without carriage returns or indentation. This is yuck, but
5801 it does reduce the size of the documents by 10-20%. To get
5802 pretty-printed output, please use L<CGI::Pretty>, a subclass
5803 contributed by Brian Paulsen.
5805 =head1 CREATING FILL-OUT FORMS:
5807 I<General note> The various form-creating methods all return strings
5808 to the caller, containing the tag or tags that will create the requested
5809 form element. You are responsible for actually printing out these strings.
5810 It's set up this way so that you can place formatting tags
5811 around the form elements.
5813 I<Another note> The default values that you specify for the forms are only
5814 used the B<first> time the script is invoked (when there is no query
5815 string). On subsequent invocations of the script (when there is a query
5816 string), the former values are used even if they are blank.
5818 If you want to change the value of a field from its previous value, you have two
5821 (1) call the param() method to set it.
5823 (2) use the -override (alias -force) parameter (a new feature in version 2.15).
5824 This forces the default value to be used, regardless of the previous value:
5826 print textfield(-name=>'field_name',
5827 -default=>'starting value',
5832 I<Yet another note> By default, the text and labels of form elements are
5833 escaped according to HTML rules. This means that you can safely use
5834 "<CLICK ME>" as the label for a button. However, it also interferes with
5835 your ability to incorporate special HTML character sequences, such as Á,
5836 into your fields. If you wish to turn off automatic escaping, call the
5837 autoEscape() method with a false value immediately after creating the CGI object:
5842 I<A Lurking Trap!> Some of the form-element generating methods return
5843 multiple tags. In a scalar context, the tags will be concatenated
5844 together with spaces, or whatever is the current value of the $"
5845 global. In a list context, the methods will return a list of
5846 elements, allowing you to modify them if you wish. Usually you will
5847 not notice this behavior, but beware of this:
5849 printf("%s\n",end_form())
5851 end_form() produces several tags, and only the first of them will be
5852 printed because the format only expects one value.
5857 =head2 CREATING AN ISINDEX TAG
5859 print isindex(-action=>$action);
5863 print isindex($action);
5865 Prints out an <isindex> tag. Not very exciting. The parameter
5866 -action specifies the URL of the script to process the query. The
5867 default is to process the query with the current script.
5869 =head2 STARTING AND ENDING A FORM
5871 print start_form(-method=>$method,
5873 -enctype=>$encoding);
5874 <... various form stuff ...>
5879 print start_form($method,$action,$encoding);
5880 <... various form stuff ...>
5883 start_form() will return a <form> tag with the optional method,
5884 action and form encoding that you specify. The defaults are:
5888 enctype: application/x-www-form-urlencoded
5890 end_form() returns the closing </form> tag.
5892 Start_form()'s enctype argument tells the browser how to package the various
5893 fields of the form before sending the form to the server. Two
5894 values are possible:
5896 B<Note:> These methods were previously named startform() and endform(), and they
5897 are still recognized as aliases of start_form() and end_form().
5901 =item B<application/x-www-form-urlencoded>
5903 This is the older type of encoding used by all browsers prior to
5904 Netscape 2.0. It is compatible with many CGI scripts and is
5905 suitable for short fields containing text data. For your
5906 convenience, CGI.pm stores the name of this encoding
5907 type in B<&CGI::URL_ENCODED>.
5909 =item B<multipart/form-data>
5911 This is the newer type of encoding introduced by Netscape 2.0.
5912 It is suitable for forms that contain very large fields or that
5913 are intended for transferring binary data. Most importantly,
5914 it enables the "file upload" feature of Netscape 2.0 forms. For
5915 your convenience, CGI.pm stores the name of this encoding type
5916 in B<&CGI::MULTIPART>
5918 Forms that use this type of encoding are not easily interpreted
5919 by CGI scripts unless they use CGI.pm or another library designed
5922 If XHTML is activated (the default), then forms will be automatically
5923 created using this type of encoding.
5927 For compatibility, the start_form() method uses the older form of
5928 encoding by default. If you want to use the newer form of encoding
5929 by default, you can call B<start_multipart_form()> instead of
5932 JAVASCRIPTING: The B<-name> and B<-onSubmit> parameters are provided
5933 for use with JavaScript. The -name parameter gives the
5934 form a name so that it can be identified and manipulated by
5935 JavaScript functions. -onSubmit should point to a JavaScript
5936 function that will be executed just before the form is submitted to your
5937 server. You can use this opportunity to check the contents of the form
5938 for consistency and completeness. If you find something wrong, you
5939 can put up an alert box or maybe fix things up yourself. You can
5940 abort the submission by returning false from this function.
5942 Usually the bulk of JavaScript functions are defined in a <script>
5943 block in the HTML header and -onSubmit points to one of these function
5944 call. See start_html() for details.
5946 =head2 FORM ELEMENTS
5948 After starting a form, you will typically create one or more
5949 textfields, popup menus, radio groups and other form elements. Each
5950 of these elements takes a standard set of named arguments. Some
5951 elements also have optional arguments. The standard arguments are as
5958 The name of the field. After submission this name can be used to
5959 retrieve the field's value using the param() method.
5961 =item B<-value>, B<-values>
5963 The initial value of the field which will be returned to the script
5964 after form submission. Some form elements, such as text fields, take
5965 a single scalar -value argument. Others, such as popup menus, take a
5966 reference to an array of values. The two arguments are synonyms.
5970 A numeric value that sets the order in which the form element receives
5971 focus when the user presses the tab key. Elements with lower values
5972 receive focus first.
5976 A string identifier that can be used to identify this element to
5977 JavaScript and DHTML.
5981 A boolean, which, if true, forces the element to take on the value
5982 specified by B<-value>, overriding the sticky behavior described
5983 earlier for the B<-nosticky> pragma.
5985 =item B<-onChange>, B<-onFocus>, B<-onBlur>, B<-onMouseOver>, B<-onMouseOut>, B<-onSelect>
5987 These are used to assign JavaScript event handlers. See the
5988 JavaScripting section for more details.
5992 Other common arguments are described in the next section. In addition
5993 to these, all attributes described in the HTML specifications are
5996 =head2 CREATING A TEXT FIELD
5998 print textfield(-name=>'field_name',
5999 -value=>'starting value',
6004 print textfield('field_name','starting value',50,80);
6006 textfield() will return a text input field.
6014 The first parameter is the required name for the field (-name).
6018 The optional second parameter is the default starting value for the field
6019 contents (-value, formerly known as -default).
6023 The optional third parameter is the size of the field in
6028 The optional fourth parameter is the maximum number of characters the
6029 field will accept (-maxlength).
6033 As with all these methods, the field will be initialized with its
6034 previous contents from earlier invocations of the script.
6035 When the form is processed, the value of the text field can be
6038 $value = param('foo');
6040 If you want to reset it from its initial value after the script has been
6041 called once, you can do so like this:
6043 param('foo',"I'm taking over this value!");
6045 =head2 CREATING A BIG TEXT FIELD
6047 print textarea(-name=>'foo',
6048 -default=>'starting value',
6054 print textarea('foo','starting value',10,50);
6056 textarea() is just like textfield, but it allows you to specify
6057 rows and columns for a multiline text entry box. You can provide
6058 a starting value for the field, which can be long and contain
6061 =head2 CREATING A PASSWORD FIELD
6063 print password_field(-name=>'secret',
6064 -value=>'starting value',
6069 print password_field('secret','starting value',50,80);
6071 password_field() is identical to textfield(), except that its contents
6072 will be starred out on the web page.
6074 =head2 CREATING A FILE UPLOAD FIELD
6076 print filefield(-name=>'uploaded_file',
6077 -default=>'starting value',
6082 print filefield('uploaded_file','starting value',50,80);
6084 filefield() will return a file upload field for Netscape 2.0 browsers.
6085 In order to take full advantage of this I<you must use the new
6086 multipart encoding scheme> for the form. You can do this either
6087 by calling B<start_form()> with an encoding type of B<&CGI::MULTIPART>,
6088 or by calling the new method B<start_multipart_form()> instead of
6089 vanilla B<start_form()>.
6097 The first parameter is the required name for the field (-name).
6101 The optional second parameter is the starting value for the field contents
6102 to be used as the default file name (-default).
6104 For security reasons, browsers don't pay any attention to this field,
6105 and so the starting value will always be blank. Worse, the field
6106 loses its "sticky" behavior and forgets its previous contents. The
6107 starting value field is called for in the HTML specification, however,
6108 and possibly some browser will eventually provide support for it.
6112 The optional third parameter is the size of the field in
6117 The optional fourth parameter is the maximum number of characters the
6118 field will accept (-maxlength).
6122 When the form is processed, you can retrieve the entered filename
6125 $filename = param('uploaded_file');
6127 Different browsers will return slightly different things for the
6128 name. Some browsers return the filename only. Others return the full
6129 path to the file, using the path conventions of the user's machine.
6130 Regardless, the name returned is always the name of the file on the
6131 I<user's> machine, and is unrelated to the name of the temporary file
6132 that CGI.pm creates during upload spooling (see below).
6134 The filename returned is also a file handle. You can read the contents
6135 of the file using standard Perl file reading calls:
6137 # Read a text file and print it out
6138 while (<$filename>) {
6142 # Copy a binary file to somewhere safe
6143 open (OUTFILE,">>/usr/local/web/users/feedback");
6144 while ($bytesread=read($filename,$buffer,1024)) {
6145 print OUTFILE $buffer;
6148 However, there are problems with the dual nature of the upload fields.
6149 If you C<use strict>, then Perl will complain when you try to use a
6150 string as a filehandle. You can get around this by placing the file
6151 reading code in a block containing the C<no strict> pragma. More
6152 seriously, it is possible for the remote user to type garbage into the
6153 upload field, in which case what you get from param() is not a
6154 filehandle at all, but a string.
6156 To be safe, use the I<upload()> function (new in version 2.47). When
6157 called with the name of an upload field, I<upload()> returns a
6158 filehandle-like object, or undef if the parameter is not a valid
6161 $fh = upload('uploaded_file');
6166 In a list context, upload() will return an array of filehandles.
6167 This makes it possible to create forms that use the same name for
6168 multiple upload fields.
6170 This is the recommended idiom.
6172 The lightweight filehandle returned by CGI.pm is not compatible with
6173 IO::Handle; for example, it does not have read() or getline()
6174 functions, but instead must be manipulated using read($fh) or
6175 <$fh>. To get a compatible IO::Handle object, call the handle's
6178 my $real_io_handle = upload('uploaded_file')->handle;
6180 When a file is uploaded the browser usually sends along some
6181 information along with it in the format of headers. The information
6182 usually includes the MIME content type. Future browsers may send
6183 other information as well (such as modification date and size). To
6184 retrieve this information, call uploadInfo(). It returns a reference to
6185 a hash containing all the document headers.
6187 $filename = param('uploaded_file');
6188 $type = uploadInfo($filename)->{'Content-Type'};
6189 unless ($type eq 'text/html') {
6190 die "HTML FILES ONLY!";
6193 If you are using a machine that recognizes "text" and "binary" data
6194 modes, be sure to understand when and how to use them (see the Camel book).
6195 Otherwise you may find that binary files are corrupted during file
6198 There are occasionally problems involving parsing the uploaded file.
6199 This usually happens when the user presses "Stop" before the upload is
6200 finished. In this case, CGI.pm will return undef for the name of the
6201 uploaded file and set I<cgi_error()> to the string "400 Bad request
6202 (malformed multipart POST)". This error message is designed so that
6203 you can incorporate it into a status code to be sent to the browser.
6206 $file = upload('uploaded_file');
6207 if (!$file && cgi_error) {
6208 print header(-status=>cgi_error);
6212 You are free to create a custom HTML page to complain about the error,
6215 You can set up a callback that will be called whenever a file upload
6216 is being read during the form processing. This is much like the
6217 UPLOAD_HOOK facility available in Apache::Request, with the exception
6218 that the first argument to the callback is an Apache::Upload object,
6219 here it's the remote filename.
6221 $q = CGI->new(\&hook [,$data [,$use_tempfile]]);
6225 my ($filename, $buffer, $bytes_read, $data) = @_;
6226 print "Read $bytes_read bytes of $filename\n";
6229 The $data field is optional; it lets you pass configuration
6230 information (e.g. a database handle) to your hook callback.
6232 The $use_tempfile field is a flag that lets you turn on and off
6233 CGI.pm's use of a temporary disk-based file during file upload. If you
6234 set this to a FALSE value (default true) then param('uploaded_file')
6235 will no longer work, and the only way to get at the uploaded data is
6236 via the hook you provide.
6238 If using the function-oriented interface, call the CGI::upload_hook()
6239 method before calling param() or any other CGI functions:
6241 CGI::upload_hook(\&hook [,$data [,$use_tempfile]]);
6243 This method is not exported by default. You will have to import it
6244 explicitly if you wish to use it without the CGI:: prefix.
6246 If you are using CGI.pm on a Windows platform and find that binary
6247 files get slightly larger when uploaded but that text files remain the
6248 same, then you have forgotten to activate binary mode on the output
6249 filehandle. Be sure to call binmode() on any handle that you create
6250 to write the uploaded file to disk.
6252 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>,
6253 B<-onMouseOver>, B<-onMouseOut> and B<-onSelect> parameters are
6254 recognized. See textfield() for details.
6256 =head2 CREATING A POPUP MENU
6258 print popup_menu('menu_name',
6259 ['eenie','meenie','minie'],
6264 %labels = ('eenie'=>'your first choice',
6265 'meenie'=>'your second choice',
6266 'minie'=>'your third choice');
6267 %attributes = ('eenie'=>{'class'=>'class of first choice'});
6268 print popup_menu('menu_name',
6269 ['eenie','meenie','minie'],
6270 'meenie',\%labels,\%attributes);
6272 -or (named parameter style)-
6274 print popup_menu(-name=>'menu_name',
6275 -values=>['eenie','meenie','minie'],
6276 -default=>['meenie','minie'],
6278 -attributes=>\%attributes);
6280 popup_menu() creates a menu.
6286 The required first argument is the menu's name (-name).
6290 The required second argument (-values) is an array B<reference>
6291 containing the list of menu items in the menu. You can pass the
6292 method an anonymous array, as shown in the example, or a reference to
6293 a named array, such as "\@foo".
6297 The optional third parameter (-default) is the name of the default
6298 menu choice. If not specified, the first item will be the default.
6299 The values of the previous choice will be maintained across
6300 queries. Pass an array reference to select multiple defaults.
6304 The optional fourth parameter (-labels) is provided for people who
6305 want to use different values for the user-visible label inside the
6306 popup menu and the value returned to your script. It's a pointer to an
6307 hash relating menu values to user-visible labels. If you
6308 leave this parameter blank, the menu values will be displayed by
6309 default. (You can also leave a label undefined if you want to).
6313 The optional fifth parameter (-attributes) is provided to assign
6314 any of the common HTML attributes to an individual menu item. It's
6315 a pointer to a hash relating menu values to another
6316 hash with the attribute's name as the key and the
6317 attribute's value as the value.
6321 When the form is processed, the selected value of the popup menu can
6324 $popup_menu_value = param('menu_name');
6326 =head2 CREATING AN OPTION GROUP
6328 Named parameter style
6330 print popup_menu(-name=>'menu_name',
6331 -values=>[qw/eenie meenie minie/,
6332 optgroup(-name=>'optgroup_name',
6333 -values => ['moe','catch'],
6334 -attributes=>{'catch'=>{'class'=>'red'}})],
6335 -labels=>{'eenie'=>'one',
6338 -default=>'meenie');
6341 print popup_menu('menu_name',
6342 ['eenie','meenie','minie',
6343 optgroup('optgroup_name', ['moe', 'catch'],
6344 {'catch'=>{'class'=>'red'}})],'meenie',
6345 {'eenie'=>'one','meenie'=>'two','minie'=>'three'});
6347 optgroup() creates an option group within a popup menu.
6353 The required first argument (B<-name>) is the label attribute of the
6354 optgroup and is B<not> inserted in the parameter list of the query.
6358 The required second argument (B<-values>) is an array reference
6359 containing the list of menu items in the menu. You can pass the
6360 method an anonymous array, as shown in the example, or a reference
6361 to a named array, such as \@foo. If you pass a HASH reference,
6362 the keys will be used for the menu values, and the values will be
6363 used for the menu labels (see -labels below).
6367 The optional third parameter (B<-labels>) allows you to pass a reference
6368 to a hash containing user-visible labels for one or more
6369 of the menu items. You can use this when you want the user to see one
6370 menu string, but have the browser return your program a different one.
6371 If you don't specify this, the value string will be used instead
6372 ("eenie", "meenie" and "minie" in this example). This is equivalent
6373 to using a hash reference for the -values parameter.
6377 An optional fourth parameter (B<-labeled>) can be set to a true value
6378 and indicates that the values should be used as the label attribute
6379 for each option element within the optgroup.
6383 An optional fifth parameter (-novals) can be set to a true value and
6384 indicates to suppress the val attribute in each option element within
6387 See the discussion on optgroup at W3C
6388 (http://www.w3.org/TR/REC-html40/interact/forms.html#edef-OPTGROUP)
6393 An optional sixth parameter (-attributes) is provided to assign
6394 any of the common HTML attributes to an individual menu item. It's
6395 a pointer to a hash relating menu values to another
6396 hash with the attribute's name as the key and the
6397 attribute's value as the value.
6401 =head2 CREATING A SCROLLING LIST
6403 print scrolling_list('list_name',
6404 ['eenie','meenie','minie','moe'],
6405 ['eenie','moe'],5,'true',{'moe'=>{'class'=>'red'}});
6408 print scrolling_list('list_name',
6409 ['eenie','meenie','minie','moe'],
6410 ['eenie','moe'],5,'true',
6411 \%labels,%attributes);
6415 print scrolling_list(-name=>'list_name',
6416 -values=>['eenie','meenie','minie','moe'],
6417 -default=>['eenie','moe'],
6421 -attributes=>\%attributes);
6423 scrolling_list() creates a scrolling list.
6427 =item B<Parameters:>
6431 The first and second arguments are the list name (-name) and values
6432 (-values). As in the popup menu, the second argument should be an
6437 The optional third argument (-default) can be either a reference to a
6438 list containing the values to be selected by default, or can be a
6439 single value to select. If this argument is missing or undefined,
6440 then nothing is selected when the list first appears. In the named
6441 parameter version, you can use the synonym "-defaults" for this
6446 The optional fourth argument is the size of the list (-size).
6450 The optional fifth argument can be set to true to allow multiple
6451 simultaneous selections (-multiple). Otherwise only one selection
6452 will be allowed at a time.
6456 The optional sixth argument is a pointer to a hash
6457 containing long user-visible labels for the list items (-labels).
6458 If not provided, the values will be displayed.
6462 The optional sixth parameter (-attributes) is provided to assign
6463 any of the common HTML attributes to an individual menu item. It's
6464 a pointer to a hash relating menu values to another
6465 hash with the attribute's name as the key and the
6466 attribute's value as the value.
6468 When this form is processed, all selected list items will be returned as
6469 a list under the parameter name 'list_name'. The values of the
6470 selected items can be retrieved with:
6472 @selected = param('list_name');
6476 =head2 CREATING A GROUP OF RELATED CHECKBOXES
6478 print checkbox_group(-name=>'group_name',
6479 -values=>['eenie','meenie','minie','moe'],
6480 -default=>['eenie','moe'],
6482 -disabled => ['moe'],
6484 -attributes=>\%attributes);
6486 print checkbox_group('group_name',
6487 ['eenie','meenie','minie','moe'],
6488 ['eenie','moe'],'true',\%labels,
6489 {'moe'=>{'class'=>'red'}});
6491 HTML3-COMPATIBLE BROWSERS ONLY:
6493 print checkbox_group(-name=>'group_name',
6494 -values=>['eenie','meenie','minie','moe'],
6495 -rows=2,-columns=>2);
6498 checkbox_group() creates a list of checkboxes that are related
6503 =item B<Parameters:>
6507 The first and second arguments are the checkbox name and values,
6508 respectively (-name and -values). As in the popup menu, the second
6509 argument should be an array reference. These values are used for the
6510 user-readable labels printed next to the checkboxes as well as for the
6511 values passed to your script in the query string.
6515 The optional third argument (-default) can be either a reference to a
6516 list containing the values to be checked by default, or can be a
6517 single value to checked. If this argument is missing or undefined,
6518 then nothing is selected when the list first appears.
6522 The optional fourth argument (-linebreak) can be set to true to place
6523 line breaks between the checkboxes so that they appear as a vertical
6524 list. Otherwise, they will be strung together on a horizontal line.
6529 The optional b<-labels> argument is a pointer to a hash
6530 relating the checkbox values to the user-visible labels that will be
6531 printed next to them. If not provided, the values will be used as the
6535 The optional parameters B<-rows>, and B<-columns> cause
6536 checkbox_group() to return an HTML3 compatible table containing the
6537 checkbox group formatted with the specified number of rows and
6538 columns. You can provide just the -columns parameter if you wish;
6539 checkbox_group will calculate the correct number of rows for you.
6541 The option b<-disabled> takes an array of checkbox values and disables
6542 them by greying them out (this may not be supported by all browsers).
6544 The optional B<-attributes> argument is provided to assign any of the
6545 common HTML attributes to an individual menu item. It's a pointer to
6546 a hash relating menu values to another hash
6547 with the attribute's name as the key and the attribute's value as the
6550 The optional B<-tabindex> argument can be used to control the order in which
6551 radio buttons receive focus when the user presses the tab button. If
6552 passed a scalar numeric value, the first element in the group will
6553 receive this tab index and subsequent elements will be incremented by
6554 one. If given a reference to an array of radio button values, then
6555 the indexes will be jiggered so that the order specified in the array
6556 will correspond to the tab order. You can also pass a reference to a
6557 hash in which the hash keys are the radio button values and the values
6558 are the tab indexes of each button. Examples:
6560 -tabindex => 100 # this group starts at index 100 and counts up
6561 -tabindex => ['moe','minie','eenie','meenie'] # tab in this order
6562 -tabindex => {meenie=>100,moe=>101,minie=>102,eenie=>200} # tab in this order
6564 The optional B<-labelattributes> argument will contain attributes
6565 attached to the <label> element that surrounds each button.
6567 When the form is processed, all checked boxes will be returned as
6568 a list under the parameter name 'group_name'. The values of the
6569 "on" checkboxes can be retrieved with:
6571 @turned_on = param('group_name');
6573 The value returned by checkbox_group() is actually an array of button
6574 elements. You can capture them and use them within tables, lists,
6575 or in other creative ways:
6577 @h = checkbox_group(-name=>'group_name',-values=>\@values);
6578 &use_in_creative_way(@h);
6580 =head2 CREATING A STANDALONE CHECKBOX
6582 print checkbox(-name=>'checkbox_name',
6585 -label=>'CLICK ME');
6589 print checkbox('checkbox_name','checked','ON','CLICK ME');
6591 checkbox() is used to create an isolated checkbox that isn't logically
6592 related to any others.
6596 =item B<Parameters:>
6600 The first parameter is the required name for the checkbox (-name). It
6601 will also be used for the user-readable label printed next to the
6606 The optional second parameter (-checked) specifies that the checkbox
6607 is turned on by default. Synonyms are -selected and -on.
6611 The optional third parameter (-value) specifies the value of the
6612 checkbox when it is checked. If not provided, the word "on" is
6617 The optional fourth parameter (-label) is the user-readable label to
6618 be attached to the checkbox. If not provided, the checkbox name is
6623 The value of the checkbox can be retrieved using:
6625 $turned_on = param('checkbox_name');
6627 =head2 CREATING A RADIO BUTTON GROUP
6629 print radio_group(-name=>'group_name',
6630 -values=>['eenie','meenie','minie'],
6634 -attributes=>\%attributes);
6638 print radio_group('group_name',['eenie','meenie','minie'],
6639 'meenie','true',\%labels,\%attributes);
6642 HTML3-COMPATIBLE BROWSERS ONLY:
6644 print radio_group(-name=>'group_name',
6645 -values=>['eenie','meenie','minie','moe'],
6646 -rows=2,-columns=>2);
6648 radio_group() creates a set of logically-related radio buttons
6649 (turning one member of the group on turns the others off)
6653 =item B<Parameters:>
6657 The first argument is the name of the group and is required (-name).
6661 The second argument (-values) is the list of values for the radio
6662 buttons. The values and the labels that appear on the page are
6663 identical. Pass an array I<reference> in the second argument, either
6664 using an anonymous array, as shown, or by referencing a named array as
6669 The optional third parameter (-default) is the name of the default
6670 button to turn on. If not specified, the first item will be the
6671 default. You can provide a nonexistent button name, such as "-" to
6672 start up with no buttons selected.
6676 The optional fourth parameter (-linebreak) can be set to 'true' to put
6677 line breaks between the buttons, creating a vertical list.
6681 The optional fifth parameter (-labels) is a pointer to an associative
6682 array relating the radio button values to user-visible labels to be
6683 used in the display. If not provided, the values themselves are
6689 All modern browsers can take advantage of the optional parameters
6690 B<-rows>, and B<-columns>. These parameters cause radio_group() to
6691 return an HTML3 compatible table containing the radio group formatted
6692 with the specified number of rows and columns. You can provide just
6693 the -columns parameter if you wish; radio_group will calculate the
6694 correct number of rows for you.
6696 To include row and column headings in the returned table, you
6697 can use the B<-rowheaders> and B<-colheaders> parameters. Both
6698 of these accept a pointer to an array of headings to use.
6699 The headings are just decorative. They don't reorganize the
6700 interpretation of the radio buttons -- they're still a single named
6703 The optional B<-tabindex> argument can be used to control the order in which
6704 radio buttons receive focus when the user presses the tab button. If
6705 passed a scalar numeric value, the first element in the group will
6706 receive this tab index and subsequent elements will be incremented by
6707 one. If given a reference to an array of radio button values, then
6708 the indexes will be jiggered so that the order specified in the array
6709 will correspond to the tab order. You can also pass a reference to a
6710 hash in which the hash keys are the radio button values and the values
6711 are the tab indexes of each button. Examples:
6713 -tabindex => 100 # this group starts at index 100 and counts up
6714 -tabindex => ['moe','minie','eenie','meenie'] # tab in this order
6715 -tabindex => {meenie=>100,moe=>101,minie=>102,eenie=>200} # tab in this order
6718 The optional B<-attributes> argument is provided to assign any of the
6719 common HTML attributes to an individual menu item. It's a pointer to
6720 a hash relating menu values to another hash
6721 with the attribute's name as the key and the attribute's value as the
6724 The optional B<-labelattributes> argument will contain attributes
6725 attached to the <label> element that surrounds each button.
6727 When the form is processed, the selected radio button can
6730 $which_radio_button = param('group_name');
6732 The value returned by radio_group() is actually an array of button
6733 elements. You can capture them and use them within tables, lists,
6734 or in other creative ways:
6736 @h = radio_group(-name=>'group_name',-values=>\@values);
6737 &use_in_creative_way(@h);
6739 =head2 CREATING A SUBMIT BUTTON
6741 print submit(-name=>'button_name',
6746 print submit('button_name','value');
6748 submit() will create the query submission button. Every form
6749 should have one of these.
6753 =item B<Parameters:>
6757 The first argument (-name) is optional. You can give the button a
6758 name if you have several submission buttons in your form and you want
6759 to distinguish between them.
6763 The second argument (-value) is also optional. This gives the button
6764 a value that will be passed to your script in the query string. The
6765 name will also be used as the user-visible label.
6769 You can use -label as an alias for -value. I always get confused
6770 about which of -name and -value changes the user-visible label on the
6775 You can figure out which button was pressed by using different
6776 values for each one:
6778 $which_one = param('button_name');
6780 =head2 CREATING A RESET BUTTON
6784 reset() creates the "reset" button. Note that it restores the
6785 form to its value from the last time the script was called,
6786 NOT necessarily to the defaults.
6788 Note that this conflicts with the Perl reset() built-in. Use
6789 CORE::reset() to get the original reset function.
6791 =head2 CREATING A DEFAULT BUTTON
6793 print defaults('button_label')
6795 defaults() creates a button that, when invoked, will cause the
6796 form to be completely reset to its defaults, wiping out all the
6797 changes the user ever made.
6799 =head2 CREATING A HIDDEN FIELD
6801 print hidden(-name=>'hidden_name',
6802 -default=>['value1','value2'...]);
6806 print hidden('hidden_name','value1','value2'...);
6808 hidden() produces a text field that can't be seen by the user. It
6809 is useful for passing state variable information from one invocation
6810 of the script to the next.
6814 =item B<Parameters:>
6818 The first argument is required and specifies the name of this
6823 The second argument is also required and specifies its value
6824 (-default). In the named parameter style of calling, you can provide
6825 a single value here or a reference to a whole list
6829 Fetch the value of a hidden field this way:
6831 $hidden_value = param('hidden_name');
6833 Note, that just like all the other form elements, the value of a
6834 hidden field is "sticky". If you want to replace a hidden field with
6835 some other values after the script has been called once you'll have to
6838 param('hidden_name','new','values','here');
6840 =head2 CREATING A CLICKABLE IMAGE BUTTON
6842 print image_button(-name=>'button_name',
6843 -src=>'/source/URL',
6848 print image_button('button_name','/source/URL','MIDDLE');
6850 image_button() produces a clickable image. When it's clicked on the
6851 position of the click is returned to your script as "button_name.x"
6852 and "button_name.y", where "button_name" is the name you've assigned
6857 =item B<Parameters:>
6861 The first argument (-name) is required and specifies the name of this
6866 The second argument (-src) is also required and specifies the URL
6869 The third option (-align, optional) is an alignment type, and may be
6870 TOP, BOTTOM or MIDDLE
6874 Fetch the value of the button this way:
6875 $x = param('button_name.x');
6876 $y = param('button_name.y');
6878 =head2 CREATING A JAVASCRIPT ACTION BUTTON
6880 print button(-name=>'button_name',
6881 -value=>'user visible label',
6882 -onClick=>"do_something()");
6886 print button('button_name',"do_something()");
6888 button() produces a button that is compatible with Netscape 2.0's
6889 JavaScript. When it's pressed the fragment of JavaScript code
6890 pointed to by the B<-onClick> parameter will be executed.
6894 Browsers support a so-called "cookie" designed to help maintain state
6895 within a browser session. CGI.pm has several methods that support
6898 A cookie is a name=value pair much like the named parameters in a CGI
6899 query string. CGI scripts create one or more cookies and send
6900 them to the browser in the HTTP header. The browser maintains a list
6901 of cookies that belong to a particular Web server, and returns them
6902 to the CGI script during subsequent interactions.
6904 In addition to the required name=value pair, each cookie has several
6905 optional attributes:
6909 =item 1. an expiration time
6911 This is a time/date string (in a special GMT format) that indicates
6912 when a cookie expires. The cookie will be saved and returned to your
6913 script until this expiration date is reached if the user exits
6914 the browser and restarts it. If an expiration date isn't specified, the cookie
6915 will remain active until the user quits the browser.
6919 This is a partial or complete domain name for which the cookie is
6920 valid. The browser will return the cookie to any host that matches
6921 the partial domain name. For example, if you specify a domain name
6922 of ".capricorn.com", then the browser will return the cookie to
6923 Web servers running on any of the machines "www.capricorn.com",
6924 "www2.capricorn.com", "feckless.capricorn.com", etc. Domain names
6925 must contain at least two periods to prevent attempts to match
6926 on top level domains like ".edu". If no domain is specified, then
6927 the browser will only return the cookie to servers on the host the
6928 cookie originated from.
6932 If you provide a cookie path attribute, the browser will check it
6933 against your script's URL before returning the cookie. For example,
6934 if you specify the path "/cgi-bin", then the cookie will be returned
6935 to each of the scripts "/cgi-bin/tally.pl", "/cgi-bin/order.pl",
6936 and "/cgi-bin/customer_service/complain.pl", but not to the script
6937 "/cgi-private/site_admin.pl". By default, path is set to "/", which
6938 causes the cookie to be sent to any CGI script on your site.
6940 =item 4. a "secure" flag
6942 If the "secure" attribute is set, the cookie will only be sent to your
6943 script if the CGI request is occurring on a secure channel, such as SSL.
6947 The interface to HTTP cookies is the B<cookie()> method:
6949 $cookie = cookie(-name=>'sessionID',
6952 -path=>'/cgi-bin/database',
6953 -domain=>'.capricorn.org',
6955 print header(-cookie=>$cookie);
6957 B<cookie()> creates a new cookie. Its parameters include:
6963 The name of the cookie (required). This can be any string at all.
6964 Although browsers limit their cookie names to non-whitespace
6965 alphanumeric characters, CGI.pm removes this restriction by escaping
6966 and unescaping cookies behind the scenes.
6970 The value of the cookie. This can be any scalar value,
6971 array reference, or even hash reference. For example,
6972 you can store an entire hash into a cookie this way:
6974 $cookie=cookie(-name=>'family information',
6975 -value=>\%childrens_ages);
6979 The optional partial path for which this cookie will be valid, as described
6984 The optional partial domain for which this cookie will be valid, as described
6989 The optional expiration date for this cookie. The format is as described
6990 in the section on the B<header()> method:
6992 "+1h" one hour from now
6996 If set to true, this cookie will only be used within a secure
7001 The cookie created by cookie() must be incorporated into the HTTP
7002 header within the string returned by the header() method:
7004 use CGI ':standard';
7005 print header(-cookie=>$my_cookie);
7007 To create multiple cookies, give header() an array reference:
7009 $cookie1 = cookie(-name=>'riddle_name',
7010 -value=>"The Sphynx's Question");
7011 $cookie2 = cookie(-name=>'answers',
7013 print header(-cookie=>[$cookie1,$cookie2]);
7015 To retrieve a cookie, request it by name by calling cookie() method
7016 without the B<-value> parameter. This example uses the object-oriented
7021 $riddle = $query->cookie('riddle_name');
7022 %answers = $query->cookie('answers');
7024 Cookies created with a single scalar value, such as the "riddle_name"
7025 cookie, will be returned in that form. Cookies with array and hash
7026 values can also be retrieved.
7028 The cookie and CGI namespaces are separate. If you have a parameter
7029 named 'answers' and a cookie named 'answers', the values retrieved by
7030 param() and cookie() are independent of each other. However, it's
7031 simple to turn a CGI parameter into a cookie, and vice-versa:
7033 # turn a CGI parameter into a cookie
7034 $c=cookie(-name=>'answers',-value=>[param('answers')]);
7036 param(-name=>'answers',-value=>[cookie('answers')]);
7038 If you call cookie() without any parameters, it will return a list of
7039 the names of all cookies passed to your script:
7041 @cookies = cookie();
7043 See the B<cookie.cgi> example script for some ideas on how to use
7044 cookies effectively.
7046 =head1 WORKING WITH FRAMES
7048 It's possible for CGI.pm scripts to write into several browser panels
7049 and windows using the HTML 4 frame mechanism. There are three
7050 techniques for defining new frames programmatically:
7054 =item 1. Create a <Frameset> document
7056 After writing out the HTTP header, instead of creating a standard
7057 HTML document using the start_html() call, create a <frameset>
7058 document that defines the frames on the page. Specify your script(s)
7059 (with appropriate parameters) as the SRC for each of the frames.
7061 There is no specific support for creating <frameset> sections
7062 in CGI.pm, but the HTML is very simple to write. See the frame
7063 documentation in Netscape's home pages for details
7065 http://wp.netscape.com/assist/net_sites/frames.html
7067 =item 2. Specify the destination for the document in the HTTP header
7069 You may provide a B<-target> parameter to the header() method:
7071 print header(-target=>'ResultsWindow');
7073 This will tell the browser to load the output of your script into the
7074 frame named "ResultsWindow". If a frame of that name doesn't already
7075 exist, the browser will pop up a new window and load your script's
7076 document into that. There are a number of magic names that you can
7077 use for targets. See the frame documents on Netscape's home pages for
7080 =item 3. Specify the destination for the document in the <form> tag
7082 You can specify the frame to load in the FORM tag itself. With
7083 CGI.pm it looks like this:
7085 print start_form(-target=>'ResultsWindow');
7087 When your script is reinvoked by the form, its output will be loaded
7088 into the frame named "ResultsWindow". If one doesn't already exist
7089 a new window will be created.
7093 The script "frameset.cgi" in the examples directory shows one way to
7094 create pages in which the fill-out form and the response live in
7095 side-by-side frames.
7097 =head1 SUPPORT FOR JAVASCRIPT
7099 The usual way to use JavaScript is to define a set of functions in a
7100 <SCRIPT> block inside the HTML header and then to register event
7101 handlers in the various elements of the page. Events include such
7102 things as the mouse passing over a form element, a button being
7103 clicked, the contents of a text field changing, or a form being
7104 submitted. When an event occurs that involves an element that has
7105 registered an event handler, its associated JavaScript code gets
7108 The elements that can register event handlers include the <BODY> of an
7109 HTML document, hypertext links, all the various elements of a fill-out
7110 form, and the form itself. There are a large number of events, and
7111 each applies only to the elements for which it is relevant. Here is a
7118 The browser is loading the current document. Valid in:
7120 + The HTML <BODY> section only.
7124 The browser is closing the current page or frame. Valid for:
7126 + The HTML <BODY> section only.
7130 The user has pressed the submit button of a form. This event happens
7131 just before the form is submitted, and your function can return a
7132 value of false in order to abort the submission. Valid for:
7138 The mouse has clicked on an item in a fill-out form. Valid for:
7140 + Buttons (including submit, reset, and image buttons)
7146 The user has changed the contents of a field. Valid for:
7157 The user has selected a field to work with. Valid for:
7168 The user has deselected a field (gone to work somewhere else). Valid
7180 The user has changed the part of a text field that is selected. Valid
7188 =item B<onMouseOver>
7190 The mouse has moved over an element.
7201 The mouse has moved off an element.
7212 In order to register a JavaScript event handler with an HTML element,
7213 just use the event name as a parameter when you call the corresponding
7214 CGI method. For example, to have your validateAge() JavaScript code
7215 executed every time the textfield named "age" changes, generate the
7218 print textfield(-name=>'age',-onChange=>"validateAge(this)");
7220 This example assumes that you've already declared the validateAge()
7221 function by incorporating it into a <SCRIPT> block. The CGI.pm
7222 start_html() method provides a convenient way to create this section.
7224 Similarly, you can create a form that checks itself over for
7225 consistency and alerts the user if some essential value is missing by
7226 creating it this way:
7227 print startform(-onSubmit=>"validateMe(this)");
7229 See the javascript.cgi script for a demonstration of how this all
7233 =head1 LIMITED SUPPORT FOR CASCADING STYLE SHEETS
7235 CGI.pm has limited support for HTML3's cascading style sheets (css).
7236 To incorporate a stylesheet into your document, pass the
7237 start_html() method a B<-style> parameter. The value of this
7238 parameter may be a scalar, in which case it is treated as the source
7239 URL for the stylesheet, or it may be a hash reference. In the latter
7240 case you should provide the hash with one or more of B<-src> or
7241 B<-code>. B<-src> points to a URL where an externally-defined
7242 stylesheet can be found. B<-code> points to a scalar value to be
7243 incorporated into a <style> section. Style definitions in B<-code>
7244 override similarly-named ones in B<-src>, hence the name "cascading."
7246 You may also specify the type of the stylesheet by adding the optional
7247 B<-type> parameter to the hash pointed to by B<-style>. If not
7248 specified, the style defaults to 'text/css'.
7250 To refer to a style within the body of your document, add the
7251 B<-class> parameter to any HTML element:
7253 print h1({-class=>'Fancy'},'Welcome to the Party');
7255 Or define styles on the fly with the B<-style> parameter:
7257 print h1({-style=>'Color: red;'},'Welcome to Hell');
7259 You may also use the new B<span()> element to apply a style to a
7262 print span({-style=>'Color: red;'},
7263 h1('Welcome to Hell'),
7264 "Where did that handbasket get to?"
7267 Note that you must import the ":html3" definitions to have the
7268 B<span()> method available. Here's a quick and dirty example of using
7269 CSS's. See the CSS specification at
7270 http://www.w3.org/pub/WWW/TR/Wd-css-1.html for more information.
7272 use CGI qw/:standard :html3/;
7274 #here's a stylesheet incorporated directly into the page
7284 font-family: sans-serif;
7290 print start_html( -title=>'CGI with Style',
7291 -style=>{-src=>'http://www.capricorn.com/style/st1.css',
7294 print h1('CGI with Style'),
7296 "Better read the cascading style sheet spec before playing with this!"),
7297 span({-style=>'color: magenta'},
7298 "Look Mom, no hands!",
7304 Pass an array reference to B<-code> or B<-src> in order to incorporate
7305 multiple stylesheets into your document.
7307 Should you wish to incorporate a verbatim stylesheet that includes
7308 arbitrary formatting in the header, you may pass a -verbatim tag to
7309 the -style hash, as follows:
7311 print start_html (-style => {-verbatim => '@import url("/server-common/css/'.$cssFile.'");',
7312 -src => '/server-common/css/core.css'});
7315 This will generate an HTML header that contains this:
7317 <link rel="stylesheet" type="text/css" href="/server-common/css/core.css">
7318 <style type="text/css">
7319 @import url("/server-common/css/main.css");
7322 Any additional arguments passed in the -style value will be
7323 incorporated into the <link> tag. For example:
7325 start_html(-style=>{-src=>['/styles/print.css','/styles/layout.css'],
7330 <link rel="stylesheet" type="text/css" href="/styles/print.css" media="all"/>
7331 <link rel="stylesheet" type="text/css" href="/styles/layout.css" media="all"/>
7335 To make more complicated <link> tags, use the Link() function
7336 and pass it to start_html() in the -head argument, as in:
7338 @h = (Link({-rel=>'stylesheet',-type=>'text/css',-src=>'/ss/ss.css',-media=>'all'}),
7339 Link({-rel=>'stylesheet',-type=>'text/css',-src=>'/ss/fred.css',-media=>'paper'}));
7340 print start_html({-head=>\@h})
7342 To create primary and "alternate" stylesheet, use the B<-alternate> option:
7344 start_html(-style=>{-src=>[
7345 {-src=>'/styles/print.css'},
7346 {-src=>'/styles/alt.css',-alternate=>1}
7352 If you are running the script from the command line or in the perl
7353 debugger, you can pass the script a list of keywords or
7354 parameter=value pairs on the command line or from standard input (you
7355 don't have to worry about tricking your script into reading from
7356 environment variables). You can pass keywords like this:
7358 your_script.pl keyword1 keyword2 keyword3
7362 your_script.pl keyword1+keyword2+keyword3
7366 your_script.pl name1=value1 name2=value2
7370 your_script.pl name1=value1&name2=value2
7372 To turn off this feature, use the -no_debug pragma.
7374 To test the POST method, you may enable full debugging with the -debug
7375 pragma. This will allow you to feed newline-delimited name=value
7376 pairs to the script on standard input.
7378 When debugging, you can use quotes and backslashes to escape
7379 characters in the familiar shell manner, letting you place
7380 spaces and other funny characters in your parameter=value
7383 your_script.pl "name1='I am a long value'" "name2=two\ words"
7385 Finally, you can set the path info for the script by prefixing the first
7386 name/value parameter with the path followed by a question mark (?):
7388 your_script.pl /your/path/here?name1=value1&name2=value2
7390 =head2 DUMPING OUT ALL THE NAME/VALUE PAIRS
7392 The Dump() method produces a string consisting of all the query's
7393 name/value pairs formatted nicely as a nested list. This is useful
7394 for debugging purposes:
7399 Produces something that looks like:
7413 As a shortcut, you can interpolate the entire CGI object into a string
7414 and it will be replaced with the a nice HTML dump shown above:
7417 print "<h2>Current Values</h2> $query\n";
7419 =head1 FETCHING ENVIRONMENT VARIABLES
7421 Some of the more useful environment variables can be fetched
7422 through this interface. The methods are as follows:
7428 Return a list of MIME types that the remote browser accepts. If you
7429 give this method a single argument corresponding to a MIME type, as in
7430 Accept('text/html'), it will return a floating point value
7431 corresponding to the browser's preference for this type from 0.0
7432 (don't want) to 1.0. Glob types (e.g. text/*) in the browser's accept
7433 list are handled correctly.
7435 Note that the capitalization changed between version 2.43 and 2.44 in
7436 order to avoid conflict with Perl's accept() function.
7438 =item B<raw_cookie()>
7440 Returns the HTTP_COOKIE variable. Cookies have a special format, and
7441 this method call just returns the raw form (?cookie dough). See
7442 cookie() for ways of setting and retrieving cooked cookies.
7444 Called with no parameters, raw_cookie() returns the packed cookie
7445 structure. You can separate it into individual cookies by splitting
7446 on the character sequence "; ". Called with the name of a cookie,
7447 retrieves the B<unescaped> form of the cookie. You can use the
7448 regular cookie() method to get the names, or use the raw_fetch()
7449 method from the CGI::Cookie module.
7451 =item B<user_agent()>
7453 Returns the HTTP_USER_AGENT variable. If you give
7454 this method a single argument, it will attempt to
7455 pattern match on it, allowing you to do something
7456 like user_agent(Mozilla);
7458 =item B<path_info()>
7460 Returns additional path information from the script URL.
7461 E.G. fetching /cgi-bin/your_script/additional/stuff will result in
7462 path_info() returning "/additional/stuff".
7464 NOTE: The Microsoft Internet Information Server
7465 is broken with respect to additional path information. If
7466 you use the Perl DLL library, the IIS server will attempt to
7467 execute the additional path information as a Perl script.
7468 If you use the ordinary file associations mapping, the
7469 path information will be present in the environment,
7470 but incorrect. The best thing to do is to avoid using additional
7471 path information in CGI scripts destined for use with IIS.
7473 =item B<path_translated()>
7475 As per path_info() but returns the additional
7476 path information translated into a physical path, e.g.
7477 "/usr/local/etc/httpd/htdocs/additional/stuff".
7479 The Microsoft IIS is broken with respect to the translated
7482 =item B<remote_host()>
7484 Returns either the remote host name or IP address.
7485 if the former is unavailable.
7487 =item B<script_name()>
7488 Return the script name as a partial URL, for self-refering
7493 Return the URL of the page the browser was viewing
7494 prior to fetching your script. Not available for all
7497 =item B<auth_type ()>
7499 Return the authorization/verification method in use for this
7502 =item B<server_name ()>
7504 Returns the name of the server, usually the machine's host
7507 =item B<virtual_host ()>
7509 When using virtual hosts, returns the name of the host that
7510 the browser attempted to contact
7512 =item B<server_port ()>
7514 Return the port that the server is listening on.
7516 =item B<virtual_port ()>
7518 Like server_port() except that it takes virtual hosts into account.
7519 Use this when running with virtual hosts.
7521 =item B<server_software ()>
7523 Returns the server software and version number.
7525 =item B<remote_user ()>
7527 Return the authorization/verification name used for user
7528 verification, if this script is protected.
7530 =item B<user_name ()>
7532 Attempt to obtain the remote user's name, using a variety of different
7533 techniques. This only works with older browsers such as Mosaic.
7534 Newer browsers do not report the user name for privacy reasons!
7536 =item B<request_method()>
7538 Returns the method used to access your script, usually
7539 one of 'POST', 'GET' or 'HEAD'.
7541 =item B<content_type()>
7543 Returns the content_type of data submitted in a POST, generally
7544 multipart/form-data or application/x-www-form-urlencoded
7548 Called with no arguments returns the list of HTTP environment
7549 variables, including such things as HTTP_USER_AGENT,
7550 HTTP_ACCEPT_LANGUAGE, and HTTP_ACCEPT_CHARSET, corresponding to the
7551 like-named HTTP header fields in the request. Called with the name of
7552 an HTTP header field, returns its value. Capitalization and the use
7553 of hyphens versus underscores are not significant.
7555 For example, all three of these examples are equivalent:
7557 $requested_language = http('Accept-language');
7558 $requested_language = http('Accept_language');
7559 $requested_language = http('HTTP_ACCEPT_LANGUAGE');
7563 The same as I<http()>, but operates on the HTTPS environment variables
7564 present when the SSL protocol is in effect. Can be used to determine
7565 whether SSL is turned on.
7569 =head1 USING NPH SCRIPTS
7571 NPH, or "no-parsed-header", scripts bypass the server completely by
7572 sending the complete HTTP header directly to the browser. This has
7573 slight performance benefits, but is of most use for taking advantage
7574 of HTTP extensions that are not directly supported by your server,
7575 such as server push and PICS headers.
7577 Servers use a variety of conventions for designating CGI scripts as
7578 NPH. Many Unix servers look at the beginning of the script's name for
7579 the prefix "nph-". The Macintosh WebSTAR server and Microsoft's
7580 Internet Information Server, in contrast, try to decide whether a
7581 program is an NPH script by examining the first line of script output.
7584 CGI.pm supports NPH scripts with a special NPH mode. When in this
7585 mode, CGI.pm will output the necessary extra header information when
7586 the header() and redirect() methods are
7589 The Microsoft Internet Information Server requires NPH mode. As of
7590 version 2.30, CGI.pm will automatically detect when the script is
7591 running under IIS and put itself into this mode. You do not need to
7592 do this manually, although it won't hurt anything if you do. However,
7593 note that if you have applied Service Pack 6, much of the
7594 functionality of NPH scripts, including the ability to redirect while
7595 setting a cookie, b<do not work at all> on IIS without a special patch
7597 http://support.microsoft.com/support/kb/articles/Q280/3/41.ASP:
7598 Non-Parsed Headers Stripped From CGI Applications That Have nph-
7603 =item In the B<use> statement
7605 Simply add the "-nph" pragmato the list of symbols to be imported into
7608 use CGI qw(:standard -nph)
7610 =item By calling the B<nph()> method:
7612 Call B<nph()> with a non-zero parameter at any point after using CGI.pm in your program.
7616 =item By using B<-nph> parameters
7618 in the B<header()> and B<redirect()> statements:
7620 print header(-nph=>1);
7626 CGI.pm provides four simple functions for producing multipart
7627 documents of the type needed to implement server push. These
7628 functions were graciously provided by Ed Jordan <ed@fidalgo.net>. To
7629 import these into your namespace, you must import the ":push" set.
7630 You are also advised to put the script into NPH mode and to set $| to
7631 1 to avoid buffering problems.
7633 Here is a simple script that demonstrates server push:
7635 #!/usr/local/bin/perl
7636 use CGI qw/:push -nph/;
7638 print multipart_init(-boundary=>'----here we go!');
7640 print multipart_start(-type=>'text/plain'),
7641 "The current time is ",scalar(localtime),"\n";
7643 print multipart_end;
7645 print multipart_final;
7650 This script initializes server push by calling B<multipart_init()>.
7651 It then enters a loop in which it begins a new multipart section by
7652 calling B<multipart_start()>, prints the current local time,
7653 and ends a multipart section with B<multipart_end()>. It then sleeps
7654 a second, and begins again. On the final iteration, it ends the
7655 multipart section with B<multipart_final()> rather than with
7660 =item multipart_init()
7662 multipart_init(-boundary=>$boundary);
7664 Initialize the multipart system. The -boundary argument specifies
7665 what MIME boundary string to use to separate parts of the document.
7666 If not provided, CGI.pm chooses a reasonable boundary for you.
7668 =item multipart_start()
7670 multipart_start(-type=>$type)
7672 Start a new part of the multipart document using the specified MIME
7673 type. If not specified, text/html is assumed.
7675 =item multipart_end()
7679 End a part. You must remember to call multipart_end() once for each
7680 multipart_start(), except at the end of the last part of the multipart
7681 document when multipart_final() should be called instead of multipart_end().
7683 =item multipart_final()
7687 End all parts. You should call multipart_final() rather than
7688 multipart_end() at the end of the last part of the multipart document.
7692 Users interested in server push applications should also have a look
7693 at the CGI::Push module.
7695 =head1 Avoiding Denial of Service Attacks
7697 A potential problem with CGI.pm is that, by default, it attempts to
7698 process form POSTings no matter how large they are. A wily hacker
7699 could attack your site by sending a CGI script a huge POST of many
7700 megabytes. CGI.pm will attempt to read the entire POST into a
7701 variable, growing hugely in size until it runs out of memory. While
7702 the script attempts to allocate the memory the system may slow down
7703 dramatically. This is a form of denial of service attack.
7705 Another possible attack is for the remote user to force CGI.pm to
7706 accept a huge file upload. CGI.pm will accept the upload and store it
7707 in a temporary directory even if your script doesn't expect to receive
7708 an uploaded file. CGI.pm will delete the file automatically when it
7709 terminates, but in the meantime the remote user may have filled up the
7710 server's disk space, causing problems for other programs.
7712 The best way to avoid denial of service attacks is to limit the amount
7713 of memory, CPU time and disk space that CGI scripts can use. Some Web
7714 servers come with built-in facilities to accomplish this. In other
7715 cases, you can use the shell I<limit> or I<ulimit>
7716 commands to put ceilings on CGI resource usage.
7719 CGI.pm also has some simple built-in protections against denial of
7720 service attacks, but you must activate them before you can use them.
7721 These take the form of two global variables in the CGI name space:
7725 =item B<$CGI::POST_MAX>
7727 If set to a non-negative integer, this variable puts a ceiling
7728 on the size of POSTings, in bytes. If CGI.pm detects a POST
7729 that is greater than the ceiling, it will immediately exit with an error
7730 message. This value will affect both ordinary POSTs and
7731 multipart POSTs, meaning that it limits the maximum size of file
7732 uploads as well. You should set this to a reasonably high
7733 value, such as 1 megabyte.
7735 =item B<$CGI::DISABLE_UPLOADS>
7737 If set to a non-zero value, this will disable file uploads
7738 completely. Other fill-out form values will work as usual.
7742 You can use these variables in either of two ways.
7746 =item B<1. On a script-by-script basis>
7748 Set the variable at the top of the script, right after the "use" statement:
7750 use CGI qw/:standard/;
7751 use CGI::Carp 'fatalsToBrowser';
7752 $CGI::POST_MAX=1024 * 100; # max 100K posts
7753 $CGI::DISABLE_UPLOADS = 1; # no uploads
7755 =item B<2. Globally for all scripts>
7757 Open up CGI.pm, find the definitions for $POST_MAX and
7758 $DISABLE_UPLOADS, and set them to the desired values. You'll
7759 find them towards the top of the file in a subroutine named
7760 initialize_globals().
7764 An attempt to send a POST larger than $POST_MAX bytes will cause
7765 I<param()> to return an empty CGI parameter list. You can test for
7766 this event by checking I<cgi_error()>, either after you create the CGI
7767 object or, if you are using the function-oriented interface, call
7768 <param()> for the first time. If the POST was intercepted, then
7769 cgi_error() will return the message "413 POST too large".
7771 This error message is actually defined by the HTTP protocol, and is
7772 designed to be returned to the browser as the CGI script's status
7775 $uploaded_file = param('upload');
7776 if (!$uploaded_file && cgi_error()) {
7777 print header(-status=>cgi_error());
7781 However it isn't clear that any browser currently knows what to do
7782 with this status code. It might be better just to create an
7783 HTML page that warns the user of the problem.
7785 =head1 COMPATIBILITY WITH CGI-LIB.PL
7787 To make it easier to port existing programs that use cgi-lib.pl the
7788 compatibility routine "ReadParse" is provided. Porting is simple:
7791 require "cgi-lib.pl";
7793 print "The value of the antique is $in{antique}.\n";
7798 print "The value of the antique is $in{antique}.\n";
7800 CGI.pm's ReadParse() routine creates a tied variable named %in,
7801 which can be accessed to obtain the query variables. Like
7802 ReadParse, you can also provide your own variable. Infrequently
7803 used features of ReadParse, such as the creation of @in and $in
7804 variables, are not supported.
7806 Once you use ReadParse, you can retrieve the query object itself
7810 print textfield(-name=>'wow',
7811 -value=>'does this really work?');
7813 This allows you to start using the more interesting features
7814 of CGI.pm without rewriting your old scripts from scratch.
7816 =head1 AUTHOR INFORMATION
7818 The CGI.pm distribution is copyright 1995-2007, Lincoln D. Stein. It is
7819 distributed under GPL and the Artistic License 2.0.
7821 Address bug reports and comments to: lstein@cshl.org. When sending
7822 bug reports, please provide the version of CGI.pm, the version of
7823 Perl, the name and version of your Web server, and the name and
7824 version of the operating system you are using. If the problem is even
7825 remotely browser dependent, please provide information about the
7826 affected browers as well.
7830 Thanks very much to:
7834 =item Matt Heffron (heffron@falstaff.css.beckman.com)
7836 =item James Taylor (james.taylor@srs.gov)
7838 =item Scott Anguish <sanguish@digifix.com>
7840 =item Mike Jewell (mlj3u@virginia.edu)
7842 =item Timothy Shimmin (tes@kbs.citri.edu.au)
7844 =item Joergen Haegg (jh@axis.se)
7846 =item Laurent Delfosse (delfosse@delfosse.com)
7848 =item Richard Resnick (applepi1@aol.com)
7850 =item Craig Bishop (csb@barwonwater.vic.gov.au)
7852 =item Tony Curtis (tc@vcpc.univie.ac.at)
7854 =item Tim Bunce (Tim.Bunce@ig.co.uk)
7856 =item Tom Christiansen (tchrist@convex.com)
7858 =item Andreas Koenig (k@franz.ww.TU-Berlin.DE)
7860 =item Tim MacKenzie (Tim.MacKenzie@fulcrum.com.au)
7862 =item Kevin B. Hendricks (kbhend@dogwood.tyler.wm.edu)
7864 =item Stephen Dahmen (joyfire@inxpress.net)
7866 =item Ed Jordan (ed@fidalgo.net)
7868 =item David Alan Pisoni (david@cnation.com)
7870 =item Doug MacEachern (dougm@opengroup.org)
7872 =item Robin Houston (robin@oneworld.org)
7874 =item ...and many many more...
7876 for suggestions and bug fixes.
7880 =head1 A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT
7883 #!/usr/local/bin/perl
7885 use CGI ':standard';
7888 print start_html("Example CGI.pm Form");
7889 print "<h1> Example CGI.pm Form</h1>\n";
7897 print "<em>What's your name?</em><br>";
7898 print textfield('name');
7899 print checkbox('Not my real name');
7901 print "<p><em>Where can you find English Sparrows?</em><br>";
7902 print checkbox_group(
7903 -name=>'Sparrow locations',
7904 -values=>[England,France,Spain,Asia,Hoboken],
7906 -defaults=>[England,Asia]);
7908 print "<p><em>How far can they fly?</em><br>",
7911 -values=>['10 ft','1 mile','10 miles','real far'],
7912 -default=>'1 mile');
7914 print "<p><em>What's your favorite color?</em> ";
7915 print popup_menu(-name=>'Color',
7916 -values=>['black','brown','red','yellow'],
7919 print hidden('Reference','Monty Python and the Holy Grail');
7921 print "<p><em>What have you got there?</em><br>";
7922 print scrolling_list(
7923 -name=>'possessions',
7924 -values=>['A Coconut','A Grail','An Icon',
7925 'A Sword','A Ticket'],
7929 print "<p><em>Any parting comments?</em><br>";
7930 print textarea(-name=>'Comments',
7935 print submit('Action','Shout');
7936 print submit('Action','Scream');
7944 print "<h2>Here are the current settings in this form</h2>";
7947 print "<strong>$key</strong> -> ";
7948 @values = param($key);
7949 print join(", ",@values),"<br>\n";
7956 <address>Lincoln D. Stein</address><br>
7957 <a href="/">Home Page</a>
7967 L<CGI::Carp>, L<CGI::Fast>, L<CGI::Pretty>