4 # See the bottom of this file for the POD documentation. Search for the
7 # You can run this file through either pod2man or pod2html to produce pretty
8 # documentation in manual or html file format (these utilities are part of the
9 # Perl 5 distribution).
11 # Copyright 1995-1997 Lincoln D. Stein. All rights reserved.
12 # It may be used and modified freely, but I do request that this copyright
13 # notice remain attached to the file. You may modify this module as you
14 # wish, but if you redistribute a modified version, please attach a note
15 # listing the modifications you have made.
17 # The most recent version and complete docs are available at:
18 # http://www.genome.wi.mit.edu/ftp/pub/software/WWW/cgi_docs.html
19 # ftp://ftp-genome.wi.mit.edu/pub/software/WWW/
21 # Set this to 1 to enable copious autoloader debugging messages
24 # Set this to 1 to enable NPH scripts
28 # 3) print header(-nph=>1)
31 $CGI::revision = '$Id: CGI.pm,v 2.35 1997/4/20 20:19 lstein Exp $';
34 # OVERRIDE THE OS HERE IF CGI.pm GUESSES WRONG
41 # HARD-CODED LOCATION FOR FILE UPLOAD TEMPORARY FILES.
42 # UNCOMMENT THIS ONLY IF YOU KNOW WHAT YOU'RE DOING.
43 # $TempFile::TMPDIRECTORY = '/usr/tmp';
45 # ------------------ START OF THE LIBRARY ------------
47 # FIGURE OUT THE OS WE'RE RUNNING UNDER
48 # Some systems support the $^O variable. If not
49 # available then require() the Config library
53 $OS = $Config::Config{'osname'};
58 } elsif ($OS=~/vms/i) {
60 } elsif ($OS=~/Mac/i) {
62 } elsif ($OS=~/os2/i) {
68 # Some OS logic. Binary mode enabled on DOS, NT and VMS
69 $needs_binmode = $OS=~/^(WINDOWS|VMS|OS2)/;
71 # This is the default class for the CGI object to use when all else fails.
72 $DefaultClass = 'CGI' unless defined $CGI::DefaultClass;
73 # This is where to look for autoloaded routines.
74 $AutoloadClass = $DefaultClass unless defined $CGI::AutoloadClass;
76 # The path separator is a slash, backslash or semicolon, depending
86 # Turn on NPH scripts by default when running under IIS server!
87 $NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/;
89 # Turn on special checking for Doug MacEachern's modperl
90 if (defined($ENV{'GATEWAY_INTERFACE'}) && ($MOD_PERL = $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-Perl/)) {
96 # This is really "\r\n", but the meaning of \n is different
97 # in MacPerl, so we resort to octal here.
100 if ($needs_binmode) {
101 $CGI::DefaultClass->binmode(main::STDOUT);
102 $CGI::DefaultClass->binmode(main::STDIN);
103 $CGI::DefaultClass->binmode(main::STDERR);
106 # Cute feature, but it broke when the overload mechanism changed...
107 # %OVERLOAD = ('""'=>'as_string');
110 ':html2'=>[h1..h6,qw/p br hr ol ul li dl dt dd menu code var strong em
111 tt i b blockquote pre img a address cite samp dfn html head
112 base body link nextid title meta kbd start_html end_html
113 input Select option/],
114 ':html3'=>[qw/div table caption th td TR Tr super sub strike applet PARAM embed basefont/],
115 ':netscape'=>[qw/blink frameset frame script font fontsize center/],
116 ':form'=>[qw/textfield textarea filefield password_field hidden checkbox checkbox_group
117 submit reset defaults radio_group popup_menu button autoEscape
118 scrolling_list image_button start_form end_form startform endform
119 start_multipart_form isindex tmpFileName uploadInfo URL_ENCODED MULTIPART/],
120 ':cgi'=>[qw/param path_info path_translated url self_url script_name cookie dump
121 raw_cookie request_method query_string accept user_agent remote_host
122 remote_addr referer server_name server_software server_port server_protocol
123 virtual_host remote_ident auth_type http
124 remote_user user_name header redirect import_names put/],
125 ':ssl' => [qw/https/],
126 ':cgi-lib' => [qw/ReadParse PrintHeader HtmlTop HtmlBot SplitParam/],
127 ':html' => [qw/:html2 :html3 :netscape/],
128 ':standard' => [qw/:html2 :form :cgi/],
129 ':all' => [qw/:html2 :html3 :netscape :form :cgi/]
132 # to import symbols into caller
135 my ($callpack, $callfile, $callline) = caller;
137 $NPH++, next if $_ eq ':nph';
138 foreach (&expand_tags($_)) {
139 tr/a-zA-Z0-9_//cd; # don't allow weird function names
143 # To allow overriding, search through the packages
144 # Till we find one in which the correct subroutine is defined.
145 my @packages = ($self,@{"$self\:\:ISA"});
146 foreach $sym (keys %EXPORT) {
148 my $def = ${"$self\:\:AutoloadClass"} || $DefaultClass;
149 foreach $pck (@packages) {
150 if (defined(&{"$pck\:\:$sym"})) {
155 *{"${callpack}::$sym"} = \&{"$def\:\:$sym"};
162 return ($tag) unless $EXPORT_TAGS{$tag};
163 foreach (@{$EXPORT_TAGS{$tag}}) {
164 push(@r,&expand_tags($_));
170 # The new routine. This will check the current environment
171 # for an existing query string, and initialize itself, if so.
174 my($class,$initializer) = @_;
176 bless $self,ref $class || $class || $DefaultClass;
177 $CGI::DefaultClass->_reset_globals() if $MOD_PERL;
178 $initializer = to_filehandle($initializer) if $initializer;
179 $self->init($initializer);
183 # We provide a DESTROY method so that the autoloader
184 # doesn't bother trying to find it.
188 # Returns the value(s)of a named parameter.
189 # If invoked in a list context, returns the
190 # entire list. Otherwise returns the first
191 # member of the list.
192 # If name is not provided, return a list of all
193 # the known parameters names available.
194 # If more than one argument is provided, the
195 # second and subsequent arguments are used to
196 # set the value of the parameter.
199 my($self,@p) = self_or_default(@_);
200 return $self->all_parameters unless @p;
201 my($name,$value,@other);
203 # For compatibility between old calling style and use_named_parameters() style,
204 # we have to special case for a single parameter present.
206 ($name,$value,@other) = $self->rearrange([NAME,[DEFAULT,VALUE,VALUES]],@p);
209 if (substr($p[0],0,1) eq '-' || $self->use_named_parameters) {
210 @values = defined($value) ? (ref($value) && ref($value) eq 'ARRAY' ? @{$value} : $value) : ();
212 foreach ($value,@other) {
213 push(@values,$_) if defined($_);
216 # If values is provided, then we set it.
218 $self->add_parameter($name);
219 $self->{$name}=[@values];
225 return () unless defined($name) && $self->{$name};
226 return wantarray ? @{$self->{$name}} : $self->{$name}->[0];
230 # Deletes the named parameter entirely.
233 my($self,$name) = self_or_default(@_);
234 delete $self->{$name};
235 delete $self->{'.fieldnames'}->{$name};
236 @{$self->{'.parameters'}}=grep($_ ne $name,$self->param());
237 return wantarray ? () : undef;
240 sub self_or_default {
241 return @_ if defined($_[0]) && !ref($_[0]) && ($_[0] eq 'CGI');
242 unless (defined($_[0]) &&
244 (ref($_[0]) eq 'CGI' ||
245 eval "\$_[0]->isaCGI()")) { # optimize for the common case
246 $CGI::DefaultClass->_reset_globals()
247 if defined($Q) && $MOD_PERL && $CGI::DefaultClass->_new_request();
248 $Q = $CGI::DefaultClass->new unless defined($Q);
255 return undef unless (defined(Apache->seqno()) or eval { require Apache });
256 if (Apache->seqno() != $SEQNO) {
257 $SEQNO = Apache->seqno();
270 local $^W=0; # prevent a warning
271 if (defined($_[0]) &&
272 (substr(ref($_[0]),0,3) eq 'CGI'
273 || eval "\$_[0]->isaCGI()")) {
276 return ($DefaultClass,@_);
284 #### Method: import_names
285 # Import all parameters into the given namespace.
286 # Assumes namespace 'Q' if not specified
289 my($self,$namespace) = self_or_default(@_);
290 $namespace = 'Q' unless defined($namespace);
291 die "Can't import names into 'main'\n"
292 if $namespace eq 'main';
293 my($param,@value,$var);
294 foreach $param ($self->param) {
295 # protect against silly names
296 ($var = $param)=~tr/a-zA-Z0-9_/_/c;
297 $var = "${namespace}::$var";
298 @value = $self->param($param);
304 #### Method: use_named_parameters
305 # Force CGI.pm to use named parameter-style method calls
306 # rather than positional parameters. The same effect
307 # will happen automatically if the first parameter
309 sub use_named_parameters {
310 my($self,$use_named) = self_or_default(@_);
311 return $self->{'.named'} unless defined ($use_named);
313 # stupidity to avoid annoying warnings
314 return $self->{'.named'}=$use_named;
317 ########################################
318 # THESE METHODS ARE MORE OR LESS PRIVATE
319 # GO TO THE __DATA__ SECTION TO SEE MORE
321 ########################################
323 # Initialize the query object from the environment.
324 # If a parameter list is found, this object will be set
325 # to an associative array in which parameter names are keys
326 # and the values are stored as lists
327 # If a keyword list is found, this method creates a bogus
328 # parameter list with the single parameter 'keywords'.
331 my($self,$initializer) = @_;
332 my($query_string,@lines);
335 # if we get called more than once, we want to initialize
336 # ourselves from the original query (which may be gone
337 # if it was read from STDIN originally.)
338 if (defined(@QUERY_PARAM) && !defined($initializer)) {
340 foreach (@QUERY_PARAM) {
341 $self->param('-name'=>$_,'-value'=>$QUERY_PARAM{$_});
346 $meth=$ENV{'REQUEST_METHOD'} if defined($ENV{'REQUEST_METHOD'});
348 # If initializer is defined, then read parameters
351 if (defined($initializer)) {
353 if (ref($initializer) && ref($initializer) eq 'HASH') {
354 foreach (keys %$initializer) {
355 $self->param('-name'=>$_,'-value'=>$initializer->{$_});
360 $initializer = $$initializer if ref($initializer);
361 if (defined(fileno($initializer))) {
362 while (<$initializer>) {
367 # massage back into standard format
368 if ("@lines" =~ /=/) {
369 $query_string=join("&",@lines);
371 $query_string=join("+",@lines);
375 $query_string = $initializer;
378 # If method is GET or HEAD, fetch the query from
380 if ($meth=~/^(GET|HEAD)$/) {
381 $query_string = $ENV{'QUERY_STRING'};
385 # If the method is POST, fetch the query from standard
387 if ($meth eq 'POST') {
389 if (defined($ENV{'CONTENT_TYPE'})
391 $ENV{'CONTENT_TYPE'}=~m|^multipart/form-data|) {
392 my($boundary) = $ENV{'CONTENT_TYPE'}=~/boundary=(\S+)/;
393 $self->read_multipart($boundary,$ENV{'CONTENT_LENGTH'});
397 $self->read_from_client(\*STDIN,\$query_string,$ENV{'CONTENT_LENGTH'},0)
398 if $ENV{'CONTENT_LENGTH'} > 0;
401 # Some people want to have their cake and eat it too!
402 # Uncomment this line to have the contents of the query string
403 # APPENDED to the POST data.
404 # $query_string .= ($query_string ? '&' : '') . $ENV{'QUERY_STRING'} if $ENV{'QUERY_STRING'};
408 # If neither is set, assume we're being debugged offline.
409 # Check the command line and then the standard input for data.
410 # We use the shellwords package in order to behave the way that
411 # UN*X programmers expect.
412 $query_string = &read_from_cmdline;
415 # We now have the query string in hand. We do slightly
416 # different things for keyword lists and parameter lists.
418 if ($query_string =~ /=/) {
419 $self->parse_params($query_string);
421 $self->add_parameter('keywords');
422 $self->{'keywords'} = [$self->parse_keywordlist($query_string)];
426 # Special case. Erase everything if there is a field named
428 if ($self->param('.defaults')) {
432 # Associative array containing our defined fieldnames
433 $self->{'.fieldnames'} = {};
434 foreach ($self->param('.cgifields')) {
435 $self->{'.fieldnames'}->{$_}++;
438 # Clear out our default submission button flag if present
439 $self->delete('.submit');
440 $self->delete('.cgifields');
441 $self->save_request unless $initializer;
446 # FUNCTIONS TO OVERRIDE:
448 # Turn a string into a filehandle
451 if ($string && !ref($string)) {
452 my($package) = caller(1);
453 my($tmp) = $string=~/[':]/ ? $string : "$package\:\:$string";
454 return $tmp if defined(fileno($tmp));
459 # Create a new multipart buffer
460 sub new_MultipartBuffer {
461 my($self,$boundary,$length,$filehandle) = @_;
462 return MultipartBuffer->new($self,$boundary,$length,$filehandle);
465 # Read data from a file handle
466 sub read_from_client {
467 my($self, $fh, $buff, $len, $offset) = @_;
468 local $^W=0; # prevent a warning
469 return read($fh, $$buff, $len, $offset);
472 # put a filehandle into binary mode (DOS)
477 # send output to the browser
479 my($self,@p) = self_or_default(@_);
483 # print to standard output (for overriding in mod_perl)
489 # unescape URL-encoded data
492 $todecode =~ tr/+/ /; # pluses become spaces
493 $todecode =~ s/%([0-9a-fA-F]{2})/pack("c",hex($1))/ge;
500 $toencode=~s/([^a-zA-Z0-9_\-.])/uc sprintf("%%%02x",ord($1))/eg;
506 # We're going to play with the package globals now so that if we get called
507 # again, we initialize ourselves in exactly the same way. This allows
508 # us to have several of these objects.
509 @QUERY_PARAM = $self->param; # save list of parameters
510 foreach (@QUERY_PARAM) {
511 $QUERY_PARAM{$_}=$self->{$_};
515 sub parse_keywordlist {
516 my($self,$tosplit) = @_;
517 $tosplit = &unescape($tosplit); # unescape the keywords
518 $tosplit=~tr/+/ /; # pluses to spaces
519 my(@keywords) = split(/\s+/,$tosplit);
524 my($self,$tosplit) = @_;
525 my(@pairs) = split('&',$tosplit);
528 ($param,$value) = split('=');
529 $param = &unescape($param);
530 $value = &unescape($value);
531 $self->add_parameter($param);
532 push (@{$self->{$param}},$value);
538 push (@{$self->{'.parameters'}},$param)
539 unless defined($self->{$param});
544 return () unless defined($self) && $self->{'.parameters'};
545 return () unless @{$self->{'.parameters'}};
546 return @{$self->{'.parameters'}};
549 #### Method as_string
558 print STDERR "CGI::AUTOLOAD for $AUTOLOAD\n" if $CGI::AUTOLOAD_DEBUG;
559 my($func) = $AUTOLOAD;
560 my($pack,$func_name) = $func=~/(.+)::([^:]+)$/;
561 $pack = ${"$pack\:\:AutoloadClass"} || $CGI::DefaultClass
562 unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"});
564 my($sub) = \%{"$pack\:\:SUBS"};
566 my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"};
567 eval "package $pack; $$auto";
570 my($code) = $sub->{$func_name};
572 $code = "sub $AUTOLOAD { }" if (!$code and $func_name eq 'DESTROY');
574 if ($EXPORT{':any'} ||
575 $EXPORT{$func_name} ||
576 (%EXPORT_OK || grep(++$EXPORT_OK{$_},&expand_tags(':html')))
577 && $EXPORT_OK{$func_name}) {
578 $code = $sub->{'HTML_FUNC'};
579 $code=~s/func_name/$func_name/mg;
582 die "Undefined subroutine $AUTOLOAD\n" unless $code;
583 eval "package $pack; $code";
588 goto &{"$pack\:\:$func_name"};
592 # Smart rearrangement of parameters to allow named parameter
593 # calling. We do the rearangement if:
594 # 1. The first parameter begins with a -
595 # 2. The use_named_parameters() method returns true
597 my($self,$order,@param) = @_;
598 return () unless @param;
600 return @param unless (defined($param[0]) && substr($param[0],0,1) eq '-')
601 || $self->use_named_parameters;
604 for ($i=0;$i<@param;$i+=2) {
605 $param[$i]=~s/^\-//; # get rid of initial - if present
606 $param[$i]=~tr/a-z/A-Z/; # parameters are upper case
609 my(%param) = @param; # convert into associative array
613 foreach $key (@$order) {
615 # this is an awful hack to fix spurious warnings when the
617 if (ref($key) && ref($key) eq 'ARRAY') {
619 last if defined($value);
624 $value = $param{$key};
627 push(@return_array,$value);
629 push (@return_array,$self->make_attributes(\%param)) if %param;
630 return (@return_array);
633 ###############################################################################
634 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
635 ###############################################################################
636 $AUTOLOADED_ROUTINES = ''; # get rid of -w warning
637 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
641 'URL_ENCODED'=> <<'END_OF_FUNC',
642 sub URL_ENCODED { 'application/x-www-form-urlencoded'; }
645 'MULTIPART' => <<'END_OF_FUNC',
646 sub MULTIPART { 'multipart/form-data'; }
649 'HTML_FUNC' => <<'END_OF_FUNC',
652 # handle various cases in which we're called
653 # most of this bizarre stuff is to avoid -w errors
655 (!ref($_[0]) && $_[0] eq $CGI::DefaultClass) ||
657 (substr(ref($_[0]),0,3) eq 'CGI' ||
658 eval "\$_[0]->isaCGI()"));
661 if (ref($_[0]) && ref($_[0]) eq 'HASH') {
662 my(@attr) = CGI::make_attributes('',shift);
663 $attr = " @attr" if @attr;
665 my($tag,$untag) = ("\U<func_name\E$attr>","\U</func_name>\E");
666 return $tag unless @_;
667 if (ref($_[0]) eq 'ARRAY') {
670 push(@r,"$tag$_$untag");
674 return "$tag@_$untag";
679 #### Method: keywords
680 # Keywords acts a bit differently. Calling it in a list context
681 # returns the list of keywords.
682 # Calling it in a scalar context gives you the size of the list.
684 'keywords' => <<'END_OF_FUNC',
686 my($self,@values) = self_or_default(@_);
687 # If values is provided, then we set it.
688 $self->{'keywords'}=[@values] if @values;
689 my(@result) = @{$self->{'keywords'}};
694 # These are some tie() interfaces for compatibility
695 # with Steve Brenner's cgi-lib.pl routines
696 'ReadParse' => <<'END_OF_FUNC',
709 'PrintHeader' => <<'END_OF_FUNC',
711 my($self) = self_or_default(@_);
712 return $self->header();
716 'HtmlTop' => <<'END_OF_FUNC',
718 my($self,@p) = self_or_default(@_);
719 return $self->start_html(@p);
723 'HtmlBot' => <<'END_OF_FUNC',
725 my($self,@p) = self_or_default(@_);
726 return $self->end_html(@p);
730 'SplitParam' => <<'END_OF_FUNC',
733 my (@params) = split ("\0", $param);
734 return (wantarray ? @params : $params[0]);
738 'MethGet' => <<'END_OF_FUNC',
740 return request_method() eq 'GET';
744 'MethPost' => <<'END_OF_FUNC',
746 return request_method() eq 'POST';
750 'TIEHASH' => <<'END_OF_FUNC',
756 'STORE' => <<'END_OF_FUNC',
758 $_[0]->param($_[1],split("\0",$_[2]));
762 'FETCH' => <<'END_OF_FUNC',
764 return $_[0] if $_[1] eq 'CGI';
765 return undef unless defined $_[0]->param($_[1]);
766 return join("\0",$_[0]->param($_[1]));
770 'FIRSTKEY' => <<'END_OF_FUNC',
772 $_[0]->{'.iterator'}=0;
773 $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
777 'NEXTKEY' => <<'END_OF_FUNC',
779 $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++];
783 'EXISTS' => <<'END_OF_FUNC',
785 exists $_[0]->{$_[1]};
789 'DELETE' => <<'END_OF_FUNC',
791 $_[0]->delete($_[1]);
795 'CLEAR' => <<'END_OF_FUNC',
803 # Append a new value to an existing query
808 my($name,$value) = $self->rearrange([NAME,[VALUE,VALUES]],@p);
809 my(@values) = defined($value) ? (ref($value) ? @{$value} : $value) : ();
811 $self->add_parameter($name);
812 push(@{$self->{$name}},@values);
814 return $self->param($name);
818 #### Method: delete_all
819 # Delete all parameters
821 'delete_all' => <<'EOF',
823 my($self) = self_or_default(@_);
828 #### Method: autoescape
829 # If you want to turn off the autoescaping features,
830 # call this method with undef as the argument
831 'autoEscape' => <<'END_OF_FUNC',
833 my($self,$escape) = self_or_default(@_);
834 $self->{'dontescape'}=!$escape;
840 # Return the current version
842 'version' => <<'END_OF_FUNC',
848 'make_attributes' => <<'END_OF_FUNC',
849 sub make_attributes {
850 my($self,$attr) = @_;
851 return () unless $attr && ref($attr) && ref($attr) eq 'HASH';
853 foreach (keys %{$attr}) {
855 $key=~s/^\-//; # get rid of initial - if present
856 $key=~tr/a-z/A-Z/; # parameters are upper case
857 push(@att,$attr->{$_} ne '' ? qq/$key="$attr->{$_}"/ : qq/$key/);
864 # Returns a string in which all the known parameter/value
865 # pairs are represented as nested lists, mainly for the purposes
868 'dump' => <<'END_OF_FUNC',
870 my($self) = self_or_default(@_);
871 my($param,$value,@result);
872 return '<UL></UL>' unless $self->param;
873 push(@result,"<UL>");
874 foreach $param ($self->param) {
875 my($name)=$self->escapeHTML($param);
876 push(@result,"<LI><STRONG>$param</STRONG>");
877 push(@result,"<UL>");
878 foreach $value ($self->param($param)) {
879 $value = $self->escapeHTML($value);
880 push(@result,"<LI>$value");
882 push(@result,"</UL>");
884 push(@result,"</UL>\n");
885 return join("\n",@result);
891 # Write values out to a filehandle in such a way that they can
892 # be reinitialized by the filehandle form of the new() method
894 'save' => <<'END_OF_FUNC',
896 my($self,$filehandle) = self_or_default(@_);
898 my($package) = caller;
899 # Check that this still works!
900 # $filehandle = $filehandle=~/[':]/ ? $filehandle : "$package\:\:$filehandle";
901 $filehandle = to_filehandle($filehandle);
902 foreach $param ($self->param) {
903 my($escaped_param) = &escape($param);
905 foreach $value ($self->param($param)) {
906 print $filehandle "$escaped_param=",escape($value),"\n";
909 print $filehandle "=\n"; # end of record
915 # Return a Content-Type: style header
918 'header' => <<'END_OF_FUNC',
920 my($self,@p) = self_or_default(@_);
923 my($type,$status,$cookie,$target,$expires,$nph,@other) =
924 $self->rearrange([TYPE,STATUS,[COOKIE,COOKIES],TARGET,EXPIRES,NPH],@p);
926 # rearrange() was designed for the HTML portion, so we
927 # need to fix it up a little.
929 next unless my($header,$value) = /([^\s=]+)=(.+)/;
930 substr($header,1,1000)=~tr/A-Z/a-z/;
931 ($value)=$value=~/^"(.*)"$/;
932 $_ = "$header: $value";
935 $type = $type || 'text/html';
937 push(@header,'HTTP/1.0 ' . ($status || '200 OK')) if $nph || $NPH;
938 push(@header,"Status: $status") if $status;
939 push(@header,"Window-target: $target") if $target;
940 # push all the cookies -- there may be several
942 my(@cookie) = ref($cookie) ? @{$cookie} : $cookie;
944 push(@header,"Set-cookie: $_");
947 # if the user indicates an expiration time, then we need
948 # both an Expires and a Date header (so that the browser is
950 push(@header,"Expires: " . &expires($expires)) if $expires;
951 push(@header,"Date: " . &expires(0)) if $expires;
952 push(@header,"Pragma: no-cache") if $self->cache();
953 push(@header,@other);
954 push(@header,"Content-type: $type");
956 my $header = join($CRLF,@header);
957 return $header . "${CRLF}${CRLF}";
963 # Control whether header() will produce the no-cache
966 'cache' => <<'END_OF_FUNC',
968 my($self,$new_value) = self_or_default(@_);
969 $new_value = '' unless $new_value;
970 if ($new_value ne '') {
971 $self->{'cache'} = $new_value;
973 return $self->{'cache'};
978 #### Method: redirect
979 # Return a Location: style header
982 'redirect' => <<'END_OF_FUNC',
984 my($self,@p) = self_or_default(@_);
985 my($url,$target,$cookie,$nph,@other) = $self->rearrange([[URI,URL],TARGET,COOKIE,NPH],@p);
986 $url = $url || $self->self_url;
988 foreach (@other) { push(@o,split("=")); }
989 if($MOD_PERL or exists $self->{'.req'}) {
990 my $r = $self->{'.req'} || Apache->request;
991 $r->header_out(Location => $url);
992 $r->err_header_out(Location => $url);
997 '-Status'=>'302 Found',
1000 '-nph'=>($nph||$NPH));
1001 push(@o,'-Target'=>$target) if $target;
1002 push(@o,'-Cookie'=>$cookie) if $cookie;
1003 return $self->header(@o);
1008 #### Method: start_html
1009 # Canned HTML header
1012 # $title -> (optional) The title for this HTML document (-title)
1013 # $author -> (optional) e-mail address of the author (-author)
1014 # $base -> (optional) if set to true, will enter the BASE address of this document
1015 # for resolving relative references (-base)
1016 # $xbase -> (optional) alternative base at some remote location (-xbase)
1017 # $target -> (optional) target window to load all links into (-target)
1018 # $script -> (option) Javascript code (-script)
1019 # $no_script -> (option) Javascript <noscript> tag (-noscript)
1020 # $meta -> (optional) Meta information tags
1021 # @other -> (optional) any other named parameters you'd like to incorporate into
1024 'start_html' => <<'END_OF_FUNC',
1026 my($self,@p) = &self_or_default(@_);
1027 my($title,$author,$base,$xbase,$script,$noscript,$target,$meta,@other) =
1028 $self->rearrange([TITLE,AUTHOR,BASE,XBASE,SCRIPT,NOSCRIPT,TARGET,META],@p);
1030 # strangely enough, the title needs to be escaped as HTML
1031 # while the author needs to be escaped as a URL
1032 $title = $self->escapeHTML($title || 'Untitled Document');
1033 $author = $self->escapeHTML($author);
1035 push(@result,'<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">');
1036 push(@result,"<HTML><HEAD><TITLE>$title</TITLE>");
1037 push(@result,"<LINK REV=MADE HREF=\"mailto:$author\">") if $author;
1039 if ($base || $xbase || $target) {
1040 my $href = $xbase || $self->url();
1041 my $t = $target ? qq/ TARGET="$target"/ : '';
1042 push(@result,qq/<BASE HREF="$href"$t>/);
1045 if ($meta && ref($meta) && (ref($meta) eq 'HASH')) {
1046 foreach (keys %$meta) { push(@result,qq(<META NAME="$_" CONTENT="$meta->{$_}">)); }
1048 push(@result,<<END) if $script;
1050 <!-- Hide script from HTML-compliant browsers
1052 // End script hiding. -->
1056 push(@result,<<END) if $noscript;
1062 my($other) = @other ? " @other" : '';
1063 push(@result,"</HEAD><BODY$other>");
1064 return join("\n",@result);
1069 #### Method: end_html
1070 # End an HTML document.
1071 # Trivial method for completeness. Just returns "</BODY>"
1073 'end_html' => <<'END_OF_FUNC',
1075 return "</BODY></HTML>";
1080 ################################
1081 # METHODS USED IN BUILDING FORMS
1082 ################################
1084 #### Method: isindex
1085 # Just prints out the isindex tag.
1087 # $action -> optional URL of script to run
1089 # A string containing a <ISINDEX> tag
1090 'isindex' => <<'END_OF_FUNC',
1092 my($self,@p) = self_or_default(@_);
1093 my($action,@other) = $self->rearrange([ACTION],@p);
1094 $action = qq/ACTION="$action"/ if $action;
1095 my($other) = @other ? " @other" : '';
1096 return "<ISINDEX $action$other>";
1101 #### Method: startform
1104 # $method -> optional submission method to use (GET or POST)
1105 # $action -> optional URL of script to run
1106 # $enctype ->encoding to use (URL_ENCODED or MULTIPART)
1107 'startform' => <<'END_OF_FUNC',
1109 my($self,@p) = self_or_default(@_);
1111 my($method,$action,$enctype,@other) =
1112 $self->rearrange([METHOD,ACTION,ENCTYPE],@p);
1114 $method = $method || 'POST';
1115 $enctype = $enctype || &URL_ENCODED;
1116 $action = $action ? qq/ACTION="$action"/ : $method eq 'GET' ?
1117 'ACTION="'.$self->script_name.'"' : '';
1118 my($other) = @other ? " @other" : '';
1119 $self->{'.parametersToAdd'}={};
1120 return qq/<FORM METHOD="$method" $action ENCTYPE="$enctype"$other>\n/;
1125 #### Method: start_form
1126 # synonym for startform
1127 'start_form' => <<'END_OF_FUNC',
1134 #### Method: start_multipart_form
1135 # synonym for startform
1136 'start_multipart_form' => <<'END_OF_FUNC',
1137 sub start_multipart_form {
1138 my($self,@p) = self_or_default(@_);
1139 if ($self->use_named_parameters ||
1140 (defined($param[0]) && substr($param[0],0,1) eq '-')) {
1142 $p{'-enctype'}=&MULTIPART;
1143 return $self->startform(%p);
1145 my($method,$action,@other) =
1146 $self->rearrange([METHOD,ACTION],@p);
1147 return $self->startform($method,$action,&MULTIPART,@other);
1153 #### Method: endform
1155 'endform' => <<'END_OF_FUNC',
1157 my($self,@p) = self_or_default(@_);
1158 return ($self->get_fields,"</FORM>");
1163 #### Method: end_form
1164 # synonym for endform
1165 'end_form' => <<'END_OF_FUNC',
1172 #### Method: textfield
1174 # $name -> Name of the text field
1175 # $default -> Optional default value of the field if not
1177 # $size -> Optional width of field in characaters.
1178 # $maxlength -> Optional maximum number of characters.
1180 # A string containing a <INPUT TYPE="text"> field
1182 'textfield' => <<'END_OF_FUNC',
1184 my($self,@p) = self_or_default(@_);
1185 my($name,$default,$size,$maxlength,$override,@other) =
1186 $self->rearrange([NAME,[DEFAULT,VALUE],SIZE,MAXLENGTH,[OVERRIDE,FORCE]],@p);
1188 my $current = $override ? $default :
1189 (defined($self->param($name)) ? $self->param($name) : $default);
1191 $current = defined($current) ? $self->escapeHTML($current) : '';
1192 $name = defined($name) ? $self->escapeHTML($name) : '';
1193 my($s) = defined($size) ? qq/ SIZE=$size/ : '';
1194 my($m) = defined($maxlength) ? qq/ MAXLENGTH=$maxlength/ : '';
1195 my($other) = @other ? " @other" : '';
1196 return qq/<INPUT TYPE="text" NAME="$name" VALUE="$current"$s$m$other>/;
1201 #### Method: filefield
1203 # $name -> Name of the file upload field
1204 # $size -> Optional width of field in characaters.
1205 # $maxlength -> Optional maximum number of characters.
1207 # A string containing a <INPUT TYPE="text"> field
1209 'filefield' => <<'END_OF_FUNC',
1211 my($self,@p) = self_or_default(@_);
1213 my($name,$default,$size,$maxlength,$override,@other) =
1214 $self->rearrange([NAME,[DEFAULT,VALUE],SIZE,MAXLENGTH,[OVERRIDE,FORCE]],@p);
1216 $current = $override ? $default :
1217 (defined($self->param($name)) ? $self->param($name) : $default);
1219 $name = defined($name) ? $self->escapeHTML($name) : '';
1220 my($s) = defined($size) ? qq/ SIZE=$size/ : '';
1221 my($m) = defined($maxlength) ? qq/ MAXLENGTH=$maxlength/ : '';
1222 $current = defined($current) ? $self->escapeHTML($current) : '';
1223 $other = ' ' . join(" ",@other);
1224 return qq/<INPUT TYPE="file" NAME="$name" VALUE="$current"$s$m$other>/;
1229 #### Method: password
1230 # Create a "secret password" entry field
1232 # $name -> Name of the field
1233 # $default -> Optional default value of the field if not
1235 # $size -> Optional width of field in characters.
1236 # $maxlength -> Optional maximum characters that can be entered.
1238 # A string containing a <INPUT TYPE="password"> field
1240 'password_field' => <<'END_OF_FUNC',
1241 sub password_field {
1242 my ($self,@p) = self_or_default(@_);
1244 my($name,$default,$size,$maxlength,$override,@other) =
1245 $self->rearrange([NAME,[DEFAULT,VALUE],SIZE,MAXLENGTH,[OVERRIDE,FORCE]],@p);
1247 my($current) = $override ? $default :
1248 (defined($self->param($name)) ? $self->param($name) : $default);
1250 $name = defined($name) ? $self->escapeHTML($name) : '';
1251 $current = defined($current) ? $self->escapeHTML($current) : '';
1252 my($s) = defined($size) ? qq/ SIZE=$size/ : '';
1253 my($m) = defined($maxlength) ? qq/ MAXLENGTH=$maxlength/ : '';
1254 my($other) = @other ? " @other" : '';
1255 return qq/<INPUT TYPE="password" NAME="$name" VALUE="$current"$s$m$other>/;
1260 #### Method: textarea
1262 # $name -> Name of the text field
1263 # $default -> Optional default value of the field if not
1265 # $rows -> Optional number of rows in text area
1266 # $columns -> Optional number of columns in text area
1268 # A string containing a <TEXTAREA></TEXTAREA> tag
1270 'textarea' => <<'END_OF_FUNC',
1272 my($self,@p) = self_or_default(@_);
1274 my($name,$default,$rows,$cols,$override,@other) =
1275 $self->rearrange([NAME,[DEFAULT,VALUE],ROWS,[COLS,COLUMNS],[OVERRIDE,FORCE]],@p);
1277 my($current)= $override ? $default :
1278 (defined($self->param($name)) ? $self->param($name) : $default);
1280 $name = defined($name) ? $self->escapeHTML($name) : '';
1281 $current = defined($current) ? $self->escapeHTML($current) : '';
1282 my($r) = $rows ? " ROWS=$rows" : '';
1283 my($c) = $cols ? " COLS=$cols" : '';
1284 my($other) = @other ? " @other" : '';
1285 return qq{<TEXTAREA NAME="$name"$r$c$other>$current</TEXTAREA>};
1291 # Create a javascript button.
1293 # $name -> (optional) Name for the button. (-name)
1294 # $value -> (optional) Value of the button when selected (and visible name) (-value)
1295 # $onclick -> (optional) Text of the JavaScript to run when the button is
1298 # A string containing a <INPUT TYPE="button"> tag
1300 'button' => <<'END_OF_FUNC',
1302 my($self,@p) = self_or_default(@_);
1304 my($label,$value,$script,@other) = $self->rearrange([NAME,[VALUE,LABEL],
1305 [ONCLICK,SCRIPT]],@p);
1307 $label=$self->escapeHTML($label);
1308 $value=$self->escapeHTML($value);
1309 $script=$self->escapeHTML($script);
1312 $name = qq/ NAME="$label"/ if $label;
1313 $value = $value || $label;
1315 $val = qq/ VALUE="$value"/ if $value;
1316 $script = qq/ ONCLICK="$script"/ if $script;
1317 my($other) = @other ? " @other" : '';
1318 return qq/<INPUT TYPE="button"$name$val$script$other>/;
1324 # Create a "submit query" button.
1326 # $name -> (optional) Name for the button.
1327 # $value -> (optional) Value of the button when selected (also doubles as label).
1328 # $label -> (optional) Label printed on the button(also doubles as the value).
1330 # A string containing a <INPUT TYPE="submit"> tag
1332 'submit' => <<'END_OF_FUNC',
1334 my($self,@p) = self_or_default(@_);
1336 my($label,$value,@other) = $self->rearrange([NAME,[VALUE,LABEL]],@p);
1338 $label=$self->escapeHTML($label);
1339 $value=$self->escapeHTML($value);
1341 my($name) = ' NAME=".submit"';
1342 $name = qq/ NAME="$label"/ if $label;
1343 $value = $value || $label;
1345 $val = qq/ VALUE="$value"/ if defined($value);
1346 my($other) = @other ? " @other" : '';
1347 return qq/<INPUT TYPE="submit"$name$val$other>/;
1353 # Create a "reset" button.
1355 # $name -> (optional) Name for the button.
1357 # A string containing a <INPUT TYPE="reset"> tag
1359 'reset' => <<'END_OF_FUNC',
1361 my($self,@p) = self_or_default(@_);
1362 my($label,@other) = $self->rearrange([NAME],@p);
1363 $label=$self->escapeHTML($label);
1364 my($value) = defined($label) ? qq/ VALUE="$label"/ : '';
1365 my($other) = @other ? " @other" : '';
1366 return qq/<INPUT TYPE="reset"$value$other>/;
1371 #### Method: defaults
1372 # Create a "defaults" button.
1374 # $name -> (optional) Name for the button.
1376 # A string containing a <INPUT TYPE="submit" NAME=".defaults"> tag
1378 # Note: this button has a special meaning to the initialization script,
1379 # and tells it to ERASE the current query string so that your defaults
1382 'defaults' => <<'END_OF_FUNC',
1384 my($self,@p) = self_or_default(@_);
1386 my($label,@other) = $self->rearrange([[NAME,VALUE]],@p);
1388 $label=$self->escapeHTML($label);
1389 $label = $label || "Defaults";
1390 my($value) = qq/ VALUE="$label"/;
1391 my($other) = @other ? " @other" : '';
1392 return qq/<INPUT TYPE="submit" NAME=".defaults"$value$other>/;
1397 #### Method: checkbox
1398 # Create a checkbox that is not logically linked to any others.
1399 # The field value is "on" when the button is checked.
1401 # $name -> Name of the checkbox
1402 # $checked -> (optional) turned on by default if true
1403 # $value -> (optional) value of the checkbox, 'on' by default
1404 # $label -> (optional) a user-readable label printed next to the box.
1405 # Otherwise the checkbox name is used.
1407 # A string containing a <INPUT TYPE="checkbox"> field
1409 'checkbox' => <<'END_OF_FUNC',
1411 my($self,@p) = self_or_default(@_);
1413 my($name,$checked,$value,$label,$override,@other) =
1414 $self->rearrange([NAME,[CHECKED,SELECTED,ON],VALUE,LABEL,[OVERRIDE,FORCE]],@p);
1416 if (!$override && defined($self->param($name))) {
1417 $value = $self->param($name) unless defined $value;
1418 $checked = $self->param($name) eq $value ? ' CHECKED' : '';
1420 $checked = $checked ? ' CHECKED' : '';
1421 $value = defined $value ? $value : 'on';
1423 my($the_label) = defined $label ? $label : $name;
1424 $name = $self->escapeHTML($name);
1425 $value = $self->escapeHTML($value);
1426 $the_label = $self->escapeHTML($the_label);
1427 my($other) = @other ? " @other" : '';
1428 $self->register_parameter($name);
1430 <INPUT TYPE="checkbox" NAME="$name" VALUE="$value"$checked$other>$the_label
1436 #### Method: checkbox_group
1437 # Create a list of logically-linked checkboxes.
1439 # $name -> Common name for all the check boxes
1440 # $values -> A pointer to a regular array containing the
1441 # values for each checkbox in the group.
1442 # $defaults -> (optional)
1443 # 1. If a pointer to a regular array of checkbox values,
1444 # then this will be used to decide which
1445 # checkboxes to turn on by default.
1446 # 2. If a scalar, will be assumed to hold the
1447 # value of a single checkbox in the group to turn on.
1448 # $linebreak -> (optional) Set to true to place linebreaks
1449 # between the buttons.
1450 # $labels -> (optional)
1451 # A pointer to an associative array of labels to print next to each checkbox
1452 # in the form $label{'value'}="Long explanatory label".
1453 # Otherwise the provided values are used as the labels.
1455 # An ARRAY containing a series of <INPUT TYPE="checkbox"> fields
1457 'checkbox_group' => <<'END_OF_FUNC',
1458 sub checkbox_group {
1459 my($self,@p) = self_or_default(@_);
1461 my($name,$values,$defaults,$linebreak,$labels,$rows,$columns,
1462 $rowheaders,$colheaders,$override,$nolabels,@other) =
1463 $self->rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT],
1464 LINEBREAK,LABELS,ROWS,[COLUMNS,COLS],
1465 ROWHEADERS,COLHEADERS,
1466 [OVERRIDE,FORCE],NOLABELS],@p);
1468 my($checked,$break,$result,$label);
1470 my(%checked) = $self->previous_or_default($name,$defaults,$override);
1472 $break = $linebreak ? "<BR>" : '';
1473 $name=$self->escapeHTML($name);
1475 # Create the elements
1477 my(@values) = $values ? @$values : $self->param($name);
1478 my($other) = @other ? " @other" : '';
1480 $checked = $checked{$_} ? ' CHECKED' : '';
1482 unless (defined($nolabels) && $nolabels) {
1484 $label = $labels->{$_} if defined($labels) && $labels->{$_};
1485 $label = $self->escapeHTML($label);
1487 $_ = $self->escapeHTML($_);
1488 push(@elements,qq/<INPUT TYPE="checkbox" NAME="$name" VALUE="$_"$checked$other>${label} ${break}/);
1490 $self->register_parameter($name);
1491 return wantarray ? @elements : join('',@elements) unless $columns;
1492 return _tableize($rows,$columns,$rowheaders,$colheaders,@elements);
1497 # Escape HTML -- used internally
1498 'escapeHTML' => <<'END_OF_FUNC',
1500 my($self,$toencode) = @_;
1501 return undef unless defined($toencode);
1502 return $toencode if $self->{'dontescape'};
1503 $toencode=~s/&/&/g;
1504 $toencode=~s/\"/"/g;
1505 $toencode=~s/>/>/g;
1506 $toencode=~s/</</g;
1512 # Internal procedure - don't use
1513 '_tableize' => <<'END_OF_FUNC',
1515 my($rows,$columns,$rowheaders,$colheaders,@elements) = @_;
1518 $rows = int(0.99 + @elements/$columns) unless $rows;
1519 # rearrange into a pretty table
1520 $result = "<TABLE>";
1522 unshift(@$colheaders,'') if @$colheaders && @$rowheaders;
1523 $result .= "<TR>" if @{$colheaders};
1524 foreach (@{$colheaders}) {
1525 $result .= "<TH>$_</TH>";
1527 for ($row=0;$row<$rows;$row++) {
1529 $result .= "<TH>$rowheaders->[$row]</TH>" if @$rowheaders;
1530 for ($column=0;$column<$columns;$column++) {
1531 $result .= "<TD>" . $elements[$column*$rows + $row] . "</TD>";
1535 $result .= "</TABLE>";
1541 #### Method: radio_group
1542 # Create a list of logically-linked radio buttons.
1544 # $name -> Common name for all the buttons.
1545 # $values -> A pointer to a regular array containing the
1546 # values for each button in the group.
1547 # $default -> (optional) Value of the button to turn on by default. Pass '-'
1548 # to turn _nothing_ on.
1549 # $linebreak -> (optional) Set to true to place linebreaks
1550 # between the buttons.
1551 # $labels -> (optional)
1552 # A pointer to an associative array of labels to print next to each checkbox
1553 # in the form $label{'value'}="Long explanatory label".
1554 # Otherwise the provided values are used as the labels.
1556 # An ARRAY containing a series of <INPUT TYPE="radio"> fields
1558 'radio_group' => <<'END_OF_FUNC',
1560 my($self,@p) = self_or_default(@_);
1562 my($name,$values,$default,$linebreak,$labels,
1563 $rows,$columns,$rowheaders,$colheaders,$override,$nolabels,@other) =
1564 $self->rearrange([NAME,[VALUES,VALUE],DEFAULT,LINEBREAK,LABELS,
1565 ROWS,[COLUMNS,COLS],
1566 ROWHEADERS,COLHEADERS,
1567 [OVERRIDE,FORCE],NOLABELS],@p);
1568 my($result,$checked);
1570 if (!$override && defined($self->param($name))) {
1571 $checked = $self->param($name);
1573 $checked = $default;
1575 # If no check array is specified, check the first by default
1576 $checked = $values->[0] unless $checked;
1577 $name=$self->escapeHTML($name);
1580 my(@values) = $values ? @$values : $self->param($name);
1581 my($other) = @other ? " @other" : '';
1583 my($checkit) = $checked eq $_ ? ' CHECKED' : '';
1584 my($break) = $linebreak ? '<BR>' : '';
1586 unless (defined($nolabels) && $nolabels) {
1588 $label = $labels->{$_} if defined($labels) && $labels->{$_};
1589 $label = $self->escapeHTML($label);
1591 $_=$self->escapeHTML($_);
1592 push(@elements,qq/<INPUT TYPE="radio" NAME="$name" VALUE="$_"$checkit$other>${label} ${break}/);
1594 $self->register_parameter($name);
1595 return wantarray ? @elements : join('',@elements) unless $columns;
1596 return _tableize($rows,$columns,$rowheaders,$colheaders,@elements);
1601 #### Method: popup_menu
1602 # Create a popup menu.
1604 # $name -> Name for all the menu
1605 # $values -> A pointer to a regular array containing the
1606 # text of each menu item.
1607 # $default -> (optional) Default item to display
1608 # $labels -> (optional)
1609 # A pointer to an associative array of labels to print next to each checkbox
1610 # in the form $label{'value'}="Long explanatory label".
1611 # Otherwise the provided values are used as the labels.
1613 # A string containing the definition of a popup menu.
1615 'popup_menu' => <<'END_OF_FUNC',
1617 my($self,@p) = self_or_default(@_);
1619 my($name,$values,$default,$labels,$override,@other) =
1620 $self->rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LABELS,[OVERRIDE,FORCE]],@p);
1621 my($result,$selected);
1623 if (!$override && defined($self->param($name))) {
1624 $selected = $self->param($name);
1626 $selected = $default;
1628 $name=$self->escapeHTML($name);
1629 my($other) = @other ? " @other" : '';
1631 my(@values) = $values ? @$values : $self->param($name);
1632 $result = qq/<SELECT NAME="$name"$other>\n/;
1634 my($selectit) = defined($selected) ? ($selected eq $_ ? 'SELECTED' : '' ) : '';
1636 $label = $labels->{$_} if defined($labels) && $labels->{$_};
1637 my($value) = $self->escapeHTML($_);
1638 $label=$self->escapeHTML($label);
1639 $result .= "<OPTION $selectit VALUE=\"$value\">$label\n";
1642 $result .= "</SELECT>\n";
1648 #### Method: scrolling_list
1649 # Create a scrolling list.
1651 # $name -> name for the list
1652 # $values -> A pointer to a regular array containing the
1653 # values for each option line in the list.
1654 # $defaults -> (optional)
1655 # 1. If a pointer to a regular array of options,
1656 # then this will be used to decide which
1657 # lines to turn on by default.
1658 # 2. Otherwise holds the value of the single line to turn on.
1659 # $size -> (optional) Size of the list.
1660 # $multiple -> (optional) If set, allow multiple selections.
1661 # $labels -> (optional)
1662 # A pointer to an associative array of labels to print next to each checkbox
1663 # in the form $label{'value'}="Long explanatory label".
1664 # Otherwise the provided values are used as the labels.
1666 # A string containing the definition of a scrolling list.
1668 'scrolling_list' => <<'END_OF_FUNC',
1669 sub scrolling_list {
1670 my($self,@p) = self_or_default(@_);
1671 my($name,$values,$defaults,$size,$multiple,$labels,$override,@other)
1672 = $self->rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT],
1673 SIZE,MULTIPLE,LABELS,[OVERRIDE,FORCE]],@p);
1676 my(@values) = $values ? @$values : $self->param($name);
1677 $size = $size || scalar(@values);
1679 my(%selected) = $self->previous_or_default($name,$defaults,$override);
1680 my($is_multiple) = $multiple ? ' MULTIPLE' : '';
1681 my($has_size) = $size ? " SIZE=$size" : '';
1682 my($other) = @other ? " @other" : '';
1684 $name=$self->escapeHTML($name);
1685 $result = qq/<SELECT NAME="$name"$has_size$is_multiple$other>\n/;
1687 my($selectit) = $selected{$_} ? 'SELECTED' : '';
1689 $label = $labels->{$_} if defined($labels) && $labels->{$_};
1690 $label=$self->escapeHTML($label);
1691 my($value)=$self->escapeHTML($_);
1692 $result .= "<OPTION $selectit VALUE=\"$value\">$label\n";
1694 $result .= "</SELECT>\n";
1695 $self->register_parameter($name);
1703 # $name -> Name of the hidden field
1704 # @default -> (optional) Initial values of field (may be an array)
1706 # $default->[initial values of field]
1708 # A string containing a <INPUT TYPE="hidden" NAME="name" VALUE="value">
1710 'hidden' => <<'END_OF_FUNC',
1712 my($self,@p) = self_or_default(@_);
1714 # this is the one place where we departed from our standard
1715 # calling scheme, so we have to special-case (darn)
1717 my($name,$default,$override,@other) =
1718 $self->rearrange([NAME,[DEFAULT,VALUE,VALUES],[OVERRIDE,FORCE]],@p);
1720 my $do_override = 0;
1721 if ( substr($p[0],0,1) eq '-' || $self->use_named_parameters ) {
1722 @value = ref($default) ? @{$default} : $default;
1723 $do_override = $override;
1725 foreach ($default,$override,@other) {
1726 push(@value,$_) if defined($_);
1730 # use previous values if override is not set
1731 my @prev = $self->param($name);
1732 @value = @prev if !$do_override && @prev;
1734 $name=$self->escapeHTML($name);
1736 $_=$self->escapeHTML($_);
1737 push(@result,qq/<INPUT TYPE="hidden" NAME="$name" VALUE="$_">/);
1739 return wantarray ? @result : join('',@result);
1744 #### Method: image_button
1746 # $name -> Name of the button
1747 # $src -> URL of the image source
1748 # $align -> Alignment style (TOP, BOTTOM or MIDDLE)
1750 # A string containing a <INPUT TYPE="image" NAME="name" SRC="url" ALIGN="alignment">
1752 'image_button' => <<'END_OF_FUNC',
1754 my($self,@p) = self_or_default(@_);
1756 my($name,$src,$alignment,@other) =
1757 $self->rearrange([NAME,SRC,ALIGN],@p);
1759 my($align) = $alignment ? " ALIGN=\U$alignment" : '';
1760 my($other) = @other ? " @other" : '';
1761 $name=$self->escapeHTML($name);
1762 return qq/<INPUT TYPE="image" NAME="$name" SRC="$src"$align$other>/;
1767 #### Method: self_url
1768 # Returns a URL containing the current script and all its
1769 # param/value pairs arranged as a query. You can use this
1770 # to create a link that, when selected, will reinvoke the
1771 # script with all its state information preserved.
1773 'self_url' => <<'END_OF_FUNC',
1775 my($self) = self_or_default(@_);
1776 my($query_string) = $self->query_string;
1777 my $protocol = $self->protocol();
1778 my $name = "$protocol://" . $self->server_name;
1779 $name .= ":" . $self->server_port
1780 unless $self->server_port == 80;
1781 $name .= $self->script_name;
1782 $name .= $self->path_info if $self->path_info;
1783 return $name unless $query_string;
1784 return "$name?$query_string";
1789 # This is provided as a synonym to self_url() for people unfortunate
1790 # enough to have incorporated it into their programs already!
1791 'state' => <<'END_OF_FUNC',
1799 # Like self_url, but doesn't return the query string part of
1802 'url' => <<'END_OF_FUNC',
1804 my($self) = self_or_default(@_);
1805 my $protocol = $self->protocol();
1806 my $name = "$protocol://" . $self->server_name;
1807 $name .= ":" . $self->server_port
1808 unless $self->server_port == 80;
1809 $name .= $self->script_name;
1816 # Set or read a cookie from the specified name.
1817 # Cookie can then be passed to header().
1818 # Usual rules apply to the stickiness of -value.
1820 # -name -> name for this cookie (optional)
1821 # -value -> value of this cookie (scalar, array or hash)
1822 # -path -> paths for which this cookie is valid (optional)
1823 # -domain -> internet domain in which this cookie is valid (optional)
1824 # -secure -> if true, cookie only passed through secure channel (optional)
1825 # -expires -> expiry date in format Wdy, DD-Mon-YY HH:MM:SS GMT (optional)
1827 'cookie' => <<'END_OF_FUNC',
1828 # temporary, for debugging.
1830 my($self,@p) = self_or_default(@_);
1831 my($name,$value,$path,$domain,$secure,$expires) =
1832 $self->rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES],@p);
1835 # if no value is supplied, then we retrieve the
1836 # value of the cookie, if any. For efficiency, we cache the parsed
1837 # cookie in our state variables.
1838 unless (defined($value)) {
1839 unless ($self->{'.cookies'}) {
1840 my(@pairs) = split("; ",$self->raw_cookie);
1842 my($key,$value) = split("=");
1843 my(@values) = map unescape($_),split('&',$value);
1844 $self->{'.cookies'}->{unescape($key)} = [@values];
1848 # If no name is supplied, then retrieve the names of all our cookies.
1849 return () unless $self->{'.cookies'};
1850 return wantarray ? @{$self->{'.cookies'}->{$name}} : $self->{'.cookies'}->{$name}->[0]
1851 if defined($name) && $name ne '';
1852 return keys %{$self->{'.cookies'}};
1856 # Pull out our parameters.
1858 if (ref($value) eq 'ARRAY') {
1860 } elsif (ref($value) eq 'HASH') {
1866 @values = map escape($_),@values;
1868 # I.E. requires the path to be present.
1869 ($path = $ENV{'SCRIPT_NAME'})=~s![^/]+$!! unless $path;
1871 my(@constant_values);
1872 push(@constant_values,"domain=$domain") if $domain;
1873 push(@constant_values,"path=$path") if $path;
1874 push(@constant_values,"expires=".&expires($expires)) if $expires;
1875 push(@constant_values,'secure') if $secure;
1877 my($key) = &escape($name);
1878 my($cookie) = join("=",$key,join("&",@values));
1879 return join("; ",$cookie,@constant_values);
1884 # This internal routine creates an expires string exactly some number of
1885 # hours from the current time in GMT. This is the format
1886 # required by Netscape cookies, and I think it works for the HTTP
1887 # Expires: header as well.
1888 'expires' => <<'END_OF_FUNC',
1891 my(@MON)=qw/Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec/;
1892 my(@WDAY) = qw/Sunday Monday Tuesday Wednesday Thursday Friday Saturday/;
1893 my(%mult) = ('s'=>1,
1899 # format for time can be in any of the forms...
1900 # "now" -- expire immediately
1901 # "+180s" -- in 180 seconds
1902 # "+2m" -- in 2 minutes
1903 # "+12h" -- in 12 hours
1905 # "+3M" -- in 3 months
1906 # "+2y" -- in 2 years
1907 # "-3m" -- 3 minutes ago(!)
1908 # If you don't supply one of these forms, we assume you are
1909 # specifying the date yourself
1911 if (!$time || ($time eq 'now')) {
1913 } elsif ($time=~/^([+-]?\d+)([mhdMy]?)/) {
1914 $offset = ($mult{$2} || 1)*$1;
1918 my($sec,$min,$hour,$mday,$mon,$year,$wday) = gmtime(time+$offset);
1919 $year += 1900 unless $year < 100;
1920 return sprintf("%s, %02d-%s-%02d %02d:%02d:%02d GMT",
1921 $WDAY[$wday],$mday,$MON[$mon],$year,$hour,$min,$sec);
1926 ###############################################
1927 # OTHER INFORMATION PROVIDED BY THE ENVIRONMENT
1928 ###############################################
1930 #### Method: path_info
1931 # Return the extra virtual path information provided
1932 # after the URL (if any)
1934 'path_info' => <<'END_OF_FUNC',
1936 return $ENV{'PATH_INFO'};
1941 #### Method: request_method
1942 # Returns 'POST', 'GET', 'PUT' or 'HEAD'
1944 'request_method' => <<'END_OF_FUNC',
1945 sub request_method {
1946 return $ENV{'REQUEST_METHOD'};
1950 #### Method: path_translated
1951 # Return the physical path information provided
1952 # by the URL (if any)
1954 'path_translated' => <<'END_OF_FUNC',
1955 sub path_translated {
1956 return $ENV{'PATH_TRANSLATED'};
1961 #### Method: query_string
1962 # Synthesize a query string from our current
1965 'query_string' => <<'END_OF_FUNC',
1967 my($self) = self_or_default(@_);
1968 my($param,$value,@pairs);
1969 foreach $param ($self->param) {
1970 my($eparam) = &escape($param);
1971 foreach $value ($self->param($param)) {
1972 $value = &escape($value);
1973 push(@pairs,"$eparam=$value");
1976 return join("&",@pairs);
1982 # Without parameters, returns an array of the
1983 # MIME types the browser accepts.
1984 # With a single parameter equal to a MIME
1985 # type, will return undef if the browser won't
1986 # accept it, 1 if the browser accepts it but
1987 # doesn't give a preference, or a floating point
1988 # value between 0.0 and 1.0 if the browser
1989 # declares a quantitative score for it.
1990 # This handles MIME type globs correctly.
1992 'accept' => <<'END_OF_FUNC',
1994 my($self,$search) = self_or_CGI(@_);
1995 my(%prefs,$type,$pref,$pat);
1997 my(@accept) = split(',',$self->http('accept'));
2000 ($pref) = /q=(\d\.\d+|\d+)/;
2001 ($type) = m#(\S+/[^;]+)#;
2003 $prefs{$type}=$pref || 1;
2006 return keys %prefs unless $search;
2008 # if a search type is provided, we may need to
2009 # perform a pattern matching operation.
2010 # The MIME types use a glob mechanism, which
2011 # is easily translated into a perl pattern match
2013 # First return the preference for directly supported
2015 return $prefs{$search} if $prefs{$search};
2017 # Didn't get it, so try pattern matching.
2018 foreach (keys %prefs) {
2019 next unless /\*/; # not a pattern match
2020 ($pat = $_) =~ s/([^\w*])/\\$1/g; # escape meta characters
2021 $pat =~ s/\*/.*/g; # turn it into a pattern
2022 return $prefs{$_} if $search=~/$pat/;
2028 #### Method: user_agent
2029 # If called with no parameters, returns the user agent.
2030 # If called with one parameter, does a pattern match (case
2031 # insensitive) on the user agent.
2033 'user_agent' => <<'END_OF_FUNC',
2035 my($self,$match)=self_or_CGI(@_);
2036 return $self->http('user_agent') unless $match;
2037 return $self->http('user_agent') =~ /$match/i;
2043 # Returns the magic cookie for the session.
2044 # To set the magic cookie for new transations,
2045 # try print $q->header('-Set-cookie'=>'my cookie')
2047 'raw_cookie' => <<'END_OF_FUNC',
2049 my($self) = self_or_CGI(@_);
2050 return $self->http('cookie') || $ENV{'COOKIE'} || '';
2054 #### Method: virtual_host
2055 # Return the name of the virtual_host, which
2056 # is not always the same as the server
2058 'virtual_host' => <<'END_OF_FUNC',
2060 return http('host') || server_name();
2064 #### Method: remote_host
2065 # Return the name of the remote host, or its IP
2066 # address if unavailable. If this variable isn't
2067 # defined, it returns "localhost" for debugging
2070 'remote_host' => <<'END_OF_FUNC',
2072 return $ENV{'REMOTE_HOST'} || $ENV{'REMOTE_ADDR'}
2078 #### Method: remote_addr
2079 # Return the IP addr of the remote host.
2081 'remote_addr' => <<'END_OF_FUNC',
2083 return $ENV{'REMOTE_ADDR'} || '127.0.0.1';
2088 #### Method: script_name
2089 # Return the partial URL to this script for
2090 # self-referencing scripts. Also see
2091 # self_url(), which returns a URL with all state information
2094 'script_name' => <<'END_OF_FUNC',
2096 return $ENV{'SCRIPT_NAME'} if $ENV{'SCRIPT_NAME'};
2097 # These are for debugging
2098 return "/$0" unless $0=~/^\//;
2104 #### Method: referer
2105 # Return the HTTP_REFERER: useful for generating
2108 'referer' => <<'END_OF_FUNC',
2110 my($self) = self_or_CGI(@_);
2111 return $self->http('referer');
2116 #### Method: server_name
2117 # Return the name of the server
2119 'server_name' => <<'END_OF_FUNC',
2121 return $ENV{'SERVER_NAME'} || 'localhost';
2125 #### Method: server_software
2126 # Return the name of the server software
2128 'server_software' => <<'END_OF_FUNC',
2129 sub server_software {
2130 return $ENV{'SERVER_SOFTWARE'} || 'cmdline';
2134 #### Method: server_port
2135 # Return the tcp/ip port the server is running on
2137 'server_port' => <<'END_OF_FUNC',
2139 return $ENV{'SERVER_PORT'} || 80; # for debugging
2143 #### Method: server_protocol
2144 # Return the protocol (usually HTTP/1.0)
2146 'server_protocol' => <<'END_OF_FUNC',
2147 sub server_protocol {
2148 return $ENV{'SERVER_PROTOCOL'} || 'HTTP/1.0'; # for debugging
2153 # Return the value of an HTTP variable, or
2154 # the list of variables if none provided
2156 'http' => <<'END_OF_FUNC',
2158 my ($self,$parameter) = self_or_CGI(@_);
2159 return $ENV{$parameter} if $parameter=~/^HTTP/;
2160 return $ENV{"HTTP_\U$parameter\E"} if $parameter;
2162 foreach (keys %ENV) {
2163 push(@p,$_) if /^HTTP/;
2170 # Return the value of HTTPS
2172 'https' => <<'END_OF_FUNC',
2175 my ($self,$parameter) = self_or_CGI(@_);
2176 return $ENV{HTTPS} unless $parameter;
2177 return $ENV{$parameter} if $parameter=~/^HTTPS/;
2178 return $ENV{"HTTPS_\U$parameter\E"} if $parameter;
2180 foreach (keys %ENV) {
2181 push(@p,$_) if /^HTTPS/;
2187 #### Method: protocol
2188 # Return the protocol (http or https currently)
2190 'protocol' => <<'END_OF_FUNC',
2194 return 'https' if $self->https() eq 'ON';
2195 return 'https' if $self->server_port == 443;
2196 my $prot = $self->server_protocol;
2197 my($protocol,$version) = split('/',$prot);
2198 return "\L$protocol\E";
2202 #### Method: remote_ident
2203 # Return the identity of the remote user
2204 # (but only if his host is running identd)
2206 'remote_ident' => <<'END_OF_FUNC',
2208 return $ENV{'REMOTE_IDENT'};
2213 #### Method: auth_type
2214 # Return the type of use verification/authorization in use, if any.
2216 'auth_type' => <<'END_OF_FUNC',
2218 return $ENV{'AUTH_TYPE'};
2223 #### Method: remote_user
2224 # Return the authorization name used for user
2227 'remote_user' => <<'END_OF_FUNC',
2229 return $ENV{'REMOTE_USER'};
2234 #### Method: user_name
2235 # Try to return the remote user's name by hook or by
2238 'user_name' => <<'END_OF_FUNC',
2240 my ($self) = self_or_CGI(@_);
2241 return $self->http('from') || $ENV{'REMOTE_IDENT'} || $ENV{'REMOTE_USER'};
2246 # Set or return the NPH global flag
2248 'nph' => <<'END_OF_FUNC',
2250 my ($self,$param) = self_or_CGI(@_);
2251 $CGI::nph = $param if defined($param);
2256 # -------------- really private subroutines -----------------
2257 'previous_or_default' => <<'END_OF_FUNC',
2258 sub previous_or_default {
2259 my($self,$name,$defaults,$override) = @_;
2262 if (!$override && ($self->{'.fieldnames'}->{$name} ||
2263 defined($self->param($name)) ) ) {
2264 grep($selected{$_}++,$self->param($name));
2265 } elsif (defined($defaults) && ref($defaults) &&
2266 (ref($defaults) eq 'ARRAY')) {
2267 grep($selected{$_}++,@{$defaults});
2269 $selected{$defaults}++ if defined($defaults);
2276 'register_parameter' => <<'END_OF_FUNC',
2277 sub register_parameter {
2278 my($self,$param) = @_;
2279 $self->{'.parametersToAdd'}->{$param}++;
2283 'get_fields' => <<'END_OF_FUNC',
2286 return $self->hidden('-name'=>'.cgifields',
2287 '-values'=>[keys %{$self->{'.parametersToAdd'}}],
2292 'read_from_cmdline' => <<'END_OF_FUNC',
2293 sub read_from_cmdline {
2294 require "shellwords.pl";
2298 $input = join(" ",@ARGV);
2300 print STDERR "(offline mode: enter name=value pairs on standard input)\n";
2301 chomp(@lines = <>); # remove newlines
2302 $input = join(" ",@lines);
2305 # minimal handling of escape characters
2306 $input=~s/\\=/%3D/g;
2307 $input=~s/\\&/%26/g;
2309 @words = &shellwords($input);
2310 if ("@words"=~/=/) {
2311 $query_string = join('&',@words);
2313 $query_string = join('+',@words);
2315 return $query_string;
2320 # subroutine: read_multipart
2322 # Read multipart data and store it into our parameters.
2323 # An interesting feature is that if any of the parts is a file, we
2324 # create a temporary file and open up a filehandle on it so that the
2325 # caller can read from it if necessary.
2327 'read_multipart' => <<'END_OF_FUNC',
2328 sub read_multipart {
2329 my($self,$boundary,$length) = @_;
2330 my($buffer) = $self->new_MultipartBuffer($boundary,$length);
2331 return unless $buffer;
2333 while (!$buffer->eof) {
2334 %header = $buffer->readHeader;
2335 die "Malformed multipart POST\n" unless %header;
2337 # In beta1 it was "Content-disposition". In beta2 it's "Content-Disposition"
2339 my($key) = $header{'Content-disposition'} ? 'Content-disposition' : 'Content-Disposition';
2340 my($param)= $header{$key}=~/ name="([^\"]*)"/;
2342 # possible bug: our regular expression expects the filename= part to fall
2343 # at the end of the line. Netscape doesn't escape quotation marks in file names!!!
2344 my($filename) = $header{$key}=~/ filename="(.*)"$/;
2346 # add this parameter to our list
2347 $self->add_parameter($param);
2349 # If no filename specified, then just read the data and assign it
2350 # to our parameter list.
2351 unless ($filename) {
2352 my($value) = $buffer->readBody;
2353 push(@{$self->{$param}},$value);
2357 # If we get here, then we are dealing with a potentially large
2358 # uploaded form. Save the data to a temporary file, then open
2359 # the file for reading.
2360 my($tmpfile) = new TempFile;
2361 my $tmp = $tmpfile->as_string;
2363 open (OUT,">$tmp") || die "CGI open of $tmpfile: $!\n";
2364 $CGI::DefaultClass->binmode(OUT) if $CGI::needs_binmode;
2365 chmod 0666,$tmp; # make sure anyone can delete it.
2367 while ($data = $buffer->read) {
2372 # Now create a new filehandle in the caller's namespace.
2373 # The name of this filehandle just happens to be identical
2374 # to the original filename (NOT the name of the temporary
2375 # file, which is hidden!)
2377 if ($filename=~/^[a-zA-Z_]/) {
2379 do { $cp = caller($frame++); } until !eval("'$cp'->isaCGI()");
2380 $filehandle = "$cp\:\:$filename";
2382 $filehandle = "\:\:$filename";
2385 open($filehandle,$tmp) || die "CGI open of $tmp: $!\n";
2386 $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode;
2388 push(@{$self->{$param}},$filename);
2390 # Under Unix, it would be safe to let the temporary file
2391 # be deleted immediately. However, I fear that other operating
2392 # systems are not so forgiving. Therefore we save a reference
2393 # to the temporary file in the CGI object so that the file
2394 # isn't unlinked until the CGI object itself goes out of
2395 # scope. This is a bit hacky, but it has the interesting side
2396 # effect that one can access the name of the tmpfile by
2397 # asking for $query->{$query->param('foo')}, where 'foo'
2398 # is the name of the file upload field.
2399 $self->{'.tmpfiles'}->{$filename}= {
2407 'tmpFileName' => <<'END_OF_FUNC',
2409 my($self,$filename) = self_or_default(@_);
2410 return $self->{'.tmpfiles'}->{$filename}->{name}->as_string;
2414 'uploadInfo' => <<'END_OF_FUNC'
2416 my($self,$filename) = self_or_default(@_);
2417 return $self->{'.tmpfiles'}->{$filename}->{info};
2425 # Globals and stubs for other packages that we use
2426 package MultipartBuffer;
2428 # how many bytes to read at a time. We use
2429 # a 5K buffer by default.
2430 $FILLUNIT = 1024 * 5;
2431 $TIMEOUT = 10*60; # 10 minute timeout
2432 $SPIN_LOOP_MAX = 1000; # bug fix for some Netscape servers
2435 #reuse the autoload function
2436 *MultipartBuffer::AUTOLOAD = \&CGI::AUTOLOAD;
2438 ###############################################################################
2439 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
2440 ###############################################################################
2441 $AUTOLOADED_ROUTINES = ''; # prevent -w error
2442 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
2445 'new' => <<'END_OF_FUNC',
2447 my($package,$interface,$boundary,$length,$filehandle) = @_;
2450 my($package) = caller;
2451 # force into caller's package if necessary
2452 $IN = $filehandle=~/[':]/ ? $filehandle : "$package\:\:$filehandle";
2454 $IN = "main::STDIN" unless $IN;
2456 $CGI::DefaultClass->binmode($IN) if $CGI::needs_binmode;
2458 # If the user types garbage into the file upload field,
2459 # then Netscape passes NOTHING to the server (not good).
2460 # We may hang on this read in that case. So we implement
2461 # a read timeout. If nothing is ready to read
2462 # by then, we return.
2464 # Netscape seems to be a little bit unreliable
2465 # about providing boundary strings.
2468 # Under the MIME spec, the boundary consists of the
2469 # characters "--" PLUS the Boundary string
2470 $boundary = "--$boundary";
2471 # Read the topmost (boundary) line plus the CRLF
2473 $length -= $interface->read_from_client($IN,\$null,length($boundary)+2,0);
2474 } else { # otherwise we find it ourselves
2476 ($old,$/) = ($/,$CRLF); # read a CRLF-delimited line
2477 $boundary = <$IN>; # BUG: This won't work correctly under mod_perl
2478 $length -= length($boundary);
2479 chomp($boundary); # remove the CRLF
2480 $/ = $old; # restore old line separator
2483 my $self = {LENGTH=>$length,
2484 BOUNDARY=>$boundary,
2486 INTERFACE=>$interface,
2490 $FILLUNIT = length($boundary)
2491 if length($boundary) > $FILLUNIT;
2493 return bless $self,ref $package || $package;
2497 'readHeader' => <<'END_OF_FUNC',
2504 $self->fillBuffer($FILLUNIT);
2505 $ok++ if ($end = index($self->{BUFFER},"${CRLF}${CRLF}")) >= 0;
2506 $ok++ if $self->{BUFFER} eq '';
2507 $bad++ if !$ok && $self->{LENGTH} <= 0;
2508 $FILLUNIT *= 2 if length($self->{BUFFER}) >= $FILLUNIT;
2509 } until $ok || $bad;
2512 my($header) = substr($self->{BUFFER},0,$end+2);
2513 substr($self->{BUFFER},0,$end+4) = '';
2515 while ($header=~/^([\w-]+): (.*)$CRLF/mog) {
2522 # This reads and returns the body as a single scalar value.
2523 'readBody' => <<'END_OF_FUNC',
2528 while (defined($data = $self->read)) {
2529 $returnval .= $data;
2535 # This will read $bytes or until the boundary is hit, whichever happens
2536 # first. After the boundary is hit, we return undef. The next read will
2537 # skip over the boundary and begin reading again;
2538 'read' => <<'END_OF_FUNC',
2540 my($self,$bytes) = @_;
2542 # default number of bytes to read
2543 $bytes = $bytes || $FILLUNIT;
2545 # Fill up our internal buffer in such a way that the boundary
2546 # is never split between reads.
2547 $self->fillBuffer($bytes);
2549 # Find the boundary in the buffer (it may not be there).
2550 my $start = index($self->{BUFFER},$self->{BOUNDARY});
2551 # protect against malformed multipart POST operations
2552 die "Malformed multipart POST\n" unless ($start >= 0) || ($self->{LENGTH} > 0);
2554 # If the boundary begins the data, then skip past it
2555 # and return undef. The +2 here is a fiendish plot to
2556 # remove the CR/LF pair at the end of the boundary.
2559 # clear us out completely if we've hit the last boundary.
2560 if (index($self->{BUFFER},"$self->{BOUNDARY}--")==0) {
2566 # just remove the boundary.
2567 substr($self->{BUFFER},0,length($self->{BOUNDARY})+2)='';
2572 if ($start > 0) { # read up to the boundary
2573 $bytesToReturn = $start > $bytes ? $bytes : $start;
2574 } else { # read the requested number of bytes
2575 # leave enough bytes in the buffer to allow us to read
2576 # the boundary. Thanks to Kevin Hendrick for finding
2578 $bytesToReturn = $bytes - (length($self->{BOUNDARY})+1);
2581 my $returnval=substr($self->{BUFFER},0,$bytesToReturn);
2582 substr($self->{BUFFER},0,$bytesToReturn)='';
2584 # If we hit the boundary, remove the CRLF from the end.
2585 return ($start > 0) ? substr($returnval,0,-2) : $returnval;
2590 # This fills up our internal buffer in such a way that the
2591 # boundary is never split between reads
2592 'fillBuffer' => <<'END_OF_FUNC',
2594 my($self,$bytes) = @_;
2595 return unless $self->{LENGTH};
2597 my($boundaryLength) = length($self->{BOUNDARY});
2598 my($bufferLength) = length($self->{BUFFER});
2599 my($bytesToRead) = $bytes - $bufferLength + $boundaryLength + 2;
2600 $bytesToRead = $self->{LENGTH} if $self->{LENGTH} < $bytesToRead;
2602 # Try to read some data. We may hang here if the browser is screwed up.
2603 my $bytesRead = $self->{INTERFACE}->read_from_client($self->{IN},
2608 # An apparent bug in the Apache server causes the read()
2609 # to return zero bytes repeatedly without blocking if the
2610 # remote user aborts during a file transfer. I don't know how
2611 # they manage this, but the workaround is to abort if we get
2612 # more than SPIN_LOOP_MAX consecutive zero reads.
2613 if ($bytesRead == 0) {
2614 die "CGI.pm: Server closed socket during multipart read (client aborted?).\n"
2615 if ($self->{ZERO_LOOP_COUNTER}++ >= $SPIN_LOOP_MAX);
2617 $self->{ZERO_LOOP_COUNTER}=0;
2620 $self->{LENGTH} -= $bytesRead;
2625 # Return true when we've finished reading
2626 'eof' => <<'END_OF_FUNC'
2629 return 1 if (length($self->{BUFFER}) == 0)
2630 && ($self->{LENGTH} <= 0);
2638 ####################################################################################
2639 ################################## TEMPORARY FILES #################################
2640 ####################################################################################
2644 unless ($TMPDIRECTORY) {
2645 @TEMP=("${SL}usr${SL}tmp","${SL}var${SL}tmp","${SL}tmp","${SL}temp","${SL}Temporary Items");
2647 do {$TMPDIRECTORY = $_; last} if -d $_ && -w _;
2651 $TMPDIRECTORY = "." unless $TMPDIRECTORY;
2652 $SEQUENCE="CGItemp${$}0000";
2654 # cute feature, but overload implementation broke it
2655 # %OVERLOAD = ('""'=>'as_string');
2656 *TempFile::AUTOLOAD = \&CGI::AUTOLOAD;
2658 ###############################################################################
2659 ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND ####################
2660 ###############################################################################
2661 $AUTOLOADED_ROUTINES = ''; # prevent -w error
2662 $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD';
2665 'new' => <<'END_OF_FUNC',
2669 my $directory = "${TMPDIRECTORY}${SL}${SEQUENCE}";
2670 return bless \$directory;
2674 'DESTROY' => <<'END_OF_FUNC',
2677 unlink $$self; # get rid of the file
2681 'as_string' => <<'END_OF_FUNC'
2693 # We get a whole bunch of warnings about "possibly uninitialized variables"
2694 # when running with the -w switch. Touch them all once to get rid of the
2695 # warnings. This is ugly and I hate it.
2700 $MultipartBuffer::SPIN_LOOP_MAX;
2701 $MultipartBuffer::CRLF;
2702 $MultipartBuffer::TIMEOUT;
2703 $MultipartBuffer::FILLUNIT;
2704 $TempFile::SEQUENCE;
2715 CGI - Simple Common Gateway Interface Class
2720 # the rest is too complicated for a synopsis; keep reading
2724 This perl library uses perl5 objects to make it easy to create
2725 Web fill-out forms and parse their contents. This package
2726 defines CGI objects, entities that contain the values of the
2727 current query string and other state variables.
2728 Using a CGI object's methods, you can examine keywords and parameters
2729 passed to your script, and create forms whose initial values
2730 are taken from the current query (thereby preserving state
2733 The current version of CGI.pm is available at
2735 http://www.genome.wi.mit.edu/ftp/pub/software/WWW/cgi_docs.html
2736 ftp://ftp-genome.wi.mit.edu/pub/software/WWW/
2740 CGI is a part of the base Perl installation. However, you may need
2741 to install a newer version someday. Therefore:
2743 To install this package, just change to the directory in which this
2744 file is found and type the following:
2750 This will copy CGI.pm to your perl library directory for use by all
2751 perl scripts. You probably must be root to do this. Now you can
2752 load the CGI routines in your Perl scripts with the line:
2756 If you don't have sufficient privileges to install CGI.pm in the Perl
2757 library directory, you can put CGI.pm into some convenient spot, such
2758 as your home directory, or in cgi-bin itself and prefix all Perl
2759 scripts that call it with something along the lines of the following
2762 use lib '/home/davis/lib';
2765 If you are using a version of perl earlier than 5.002 (such as NT perl), use
2769 unshift(@INC,'/home/davis/lib');
2773 The CGI distribution also comes with a cute module called L<CGI::Carp>.
2774 It redefines the die(), warn(), confess() and croak() error routines
2775 so that they write nicely formatted error messages into the server's
2776 error log (or to the output stream of your choice). This avoids long
2777 hours of groping through the error and access logs, trying to figure
2778 out which CGI script is generating error messages. If you choose,
2779 you can even have fatal error messages echoed to the browser to avoid
2780 the annoying and uninformative "Server Error" message.
2784 =head2 CREATING A NEW QUERY OBJECT:
2788 This will parse the input (from both POST and GET methods) and store
2789 it into a perl5 object called $query.
2791 =head2 CREATING A NEW QUERY OBJECT FROM AN INPUT FILE
2793 $query = new CGI(INPUTFILE);
2795 If you provide a file handle to the new() method, it
2796 will read parameters from the file (or STDIN, or whatever). The
2797 file can be in any of the forms describing below under debugging
2798 (i.e. a series of newline delimited TAG=VALUE pairs will work).
2799 Conveniently, this type of file is created by the save() method
2800 (see below). Multiple records can be saved and restored.
2802 Perl purists will be pleased to know that this syntax accepts
2803 references to file handles, or even references to filehandle globs,
2804 which is the "official" way to pass a filehandle:
2806 $query = new CGI(\*STDIN);
2808 You can also initialize the query object from an associative array
2811 $query = new CGI( {'dinosaur'=>'barney',
2812 'song'=>'I love you',
2813 'friends'=>[qw/Jessica George Nancy/]}
2816 or from a properly formatted, URL-escaped query string:
2818 $query = new CGI('dinosaur=barney&color=purple');
2820 To create an empty query, initialize it from an empty string or hash:
2822 $empty_query = new CGI("");
2824 $empty_query = new CGI({});
2826 =head2 FETCHING A LIST OF KEYWORDS FROM THE QUERY:
2828 @keywords = $query->keywords
2830 If the script was invoked as the result of an <ISINDEX> search, the
2831 parsed keywords can be obtained as an array using the keywords() method.
2833 =head2 FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT:
2835 @names = $query->param
2837 If the script was invoked with a parameter list
2838 (e.g. "name1=value1&name2=value2&name3=value3"), the param()
2839 method will return the parameter names as a list. If the
2840 script was invoked as an <ISINDEX> script, there will be a
2841 single parameter named 'keywords'.
2843 NOTE: As of version 1.5, the array of parameter names returned will
2844 be in the same order as they were submitted by the browser.
2845 Usually this order is the same as the order in which the
2846 parameters are defined in the form (however, this isn't part
2847 of the spec, and so isn't guaranteed).
2849 =head2 FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER:
2851 @values = $query->param('foo');
2855 $value = $query->param('foo');
2857 Pass the param() method a single argument to fetch the value of the
2858 named parameter. If the parameter is multivalued (e.g. from multiple
2859 selections in a scrolling list), you can ask to receive an array. Otherwise
2860 the method will return a single value.
2862 =head2 SETTING THE VALUE(S) OF A NAMED PARAMETER:
2864 $query->param('foo','an','array','of','values');
2866 This sets the value for the named parameter 'foo' to an array of
2867 values. This is one way to change the value of a field AFTER
2868 the script has been invoked once before. (Another way is with
2869 the -override parameter accepted by all methods that generate
2872 param() also recognizes a named parameter style of calling described
2873 in more detail later:
2875 $query->param(-name=>'foo',-values=>['an','array','of','values']);
2879 $query->param(-name=>'foo',-value=>'the value');
2881 =head2 APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER:
2883 $query->append(-name=>;'foo',-values=>['yet','more','values']);
2885 This adds a value or list of values to the named parameter. The
2886 values are appended to the end of the parameter if it already exists.
2887 Otherwise the parameter is created. Note that this method only
2888 recognizes the named argument calling syntax.
2890 =head2 IMPORTING ALL PARAMETERS INTO A NAMESPACE:
2892 $query->import_names('R');
2894 This creates a series of variables in the 'R' namespace. For example,
2895 $R::foo, @R:foo. For keyword lists, a variable @R::keywords will appear.
2896 If no namespace is given, this method will assume 'Q'.
2897 WARNING: don't import anything into 'main'; this is a major security
2900 In older versions, this method was called B<import()>. As of version 2.20,
2901 this name has been removed completely to avoid conflict with the built-in
2902 Perl module B<import> operator.
2904 =head2 DELETING A PARAMETER COMPLETELY:
2906 $query->delete('foo');
2908 This completely clears a parameter. It sometimes useful for
2909 resetting parameters that you don't want passed down between
2912 =head2 DELETING ALL PARAMETERS:
2914 $query->delete_all();
2916 This clears the CGI object completely. It might be useful to ensure
2917 that all the defaults are taken when you create a fill-out form.
2919 =head2 SAVING THE STATE OF THE FORM TO A FILE:
2921 $query->save(FILEHANDLE)
2923 This will write the current state of the form to the provided
2924 filehandle. You can read it back in by providing a filehandle
2925 to the new() method. Note that the filehandle can be a file, a pipe,
2928 The format of the saved file is:
2936 Both name and value are URL escaped. Multi-valued CGI parameters are
2937 represented as repeated names. A session record is delimited by a
2938 single = symbol. You can write out multiple records and read them
2939 back in with several calls to B<new>. You can do this across several
2940 sessions by opening the file in append mode, allowing you to create
2941 primitive guest books, or to keep a history of users' queries. Here's
2942 a short example of creating multiple session records:
2946 open (OUT,">>test.out") || die;
2948 foreach (0..$records) {
2950 $q->param(-name=>'counter',-value=>$_);
2955 # reopen for reading
2956 open (IN,"test.out") || die;
2958 my $q = new CGI(IN);
2959 print $q->param('counter'),"\n";
2962 The file format used for save/restore is identical to that used by the
2963 Whitehead Genome Center's data exchange format "Boulderio", and can be
2964 manipulated and even databased using Boulderio utilities. See
2966 http://www.genome.wi.mit.edu/genome_software/other/boulder.html
2968 for further details.
2970 =head2 CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION:
2972 $myself = $query->self_url;
2973 print "<A HREF=$myself>I'm talking to myself.</A>";
2975 self_url() will return a URL, that, when selected, will reinvoke
2976 this script with all its state information intact. This is most
2977 useful when you want to jump around within the document using
2978 internal anchors but you don't want to disrupt the current contents
2979 of the form(s). Something like this will do the trick.
2981 $myself = $query->self_url;
2982 print "<A HREF=$myself#table1>See table 1</A>";
2983 print "<A HREF=$myself#table2>See table 2</A>";
2984 print "<A HREF=$myself#yourself>See for yourself</A>";
2986 If you don't want to get the whole query string, call
2987 the method url() to return just the URL for the script:
2989 $myself = $query->url;
2990 print "<A HREF=$myself>No query string in this baby!</A>\n";
2992 You can also retrieve the unprocessed query string with query_string():
2994 $the_string = $query->query_string;
2996 =head2 COMPATIBILITY WITH CGI-LIB.PL
2998 To make it easier to port existing programs that use cgi-lib.pl
2999 the compatibility routine "ReadParse" is provided. Porting is
3003 require "cgi-lib.pl";
3005 print "The value of the antique is $in{antique}.\n";
3010 print "The value of the antique is $in{antique}.\n";
3012 CGI.pm's ReadParse() routine creates a tied variable named %in,
3013 which can be accessed to obtain the query variables. Like
3014 ReadParse, you can also provide your own variable. Infrequently
3015 used features of ReadParse, such as the creation of @in and $in
3016 variables, are not supported.
3018 Once you use ReadParse, you can retrieve the query object itself
3022 print $q->textfield(-name=>'wow',
3023 -value=>'does this really work?');
3025 This allows you to start using the more interesting features
3026 of CGI.pm without rewriting your old scripts from scratch.
3028 =head2 CALLING CGI FUNCTIONS THAT TAKE MULTIPLE ARGUMENTS
3030 In versions of CGI.pm prior to 2.0, it could get difficult to remember
3031 the proper order of arguments in CGI function calls that accepted five
3032 or six different arguments. As of 2.0, there's a better way to pass
3033 arguments to the various CGI functions. In this style, you pass a
3034 series of name=>argument pairs, like this:
3036 $field = $query->radio_group(-name=>'OS',
3037 -values=>[Unix,Windows,Macintosh],
3040 The advantages of this style are that you don't have to remember the
3041 exact order of the arguments, and if you leave out a parameter, in
3042 most cases it will default to some reasonable value. If you provide
3043 a parameter that the method doesn't recognize, it will usually do
3044 something useful with it, such as incorporating it into the HTML form
3045 tag. For example if Netscape decides next week to add a new
3046 JUSTIFICATION parameter to the text field tags, you can start using
3047 the feature without waiting for a new version of CGI.pm:
3049 $field = $query->textfield(-name=>'State',
3050 -default=>'gaseous',
3051 -justification=>'RIGHT');
3053 This will result in an HTML tag that looks like this:
3055 <INPUT TYPE="textfield" NAME="State" VALUE="gaseous"
3056 JUSTIFICATION="RIGHT">
3058 Parameter names are case insensitive: you can use -name, or -Name or
3059 -NAME. You don't have to use the hyphen if you don't want to. After
3060 creating a CGI object, call the B<use_named_parameters()> method with
3061 a nonzero value. This will tell CGI.pm that you intend to use named
3062 parameters exclusively:
3065 $query->use_named_parameters(1);
3066 $field = $query->radio_group('name'=>'OS',
3067 'values'=>['Unix','Windows','Macintosh'],
3070 Actually, CGI.pm only looks for a hyphen in the first parameter. So
3071 you can leave it off subsequent parameters if you like. Something to
3072 be wary of is the potential that a string constant like "values" will
3073 collide with a keyword (and in fact it does!) While Perl usually
3074 figures out when you're referring to a function and when you're
3075 referring to a string, you probably should put quotation marks around
3076 all string constants just to play it safe.
3078 =head2 CREATING THE HTTP HEADER:
3080 print $query->header;
3084 print $query->header('image/gif');
3088 print $query->header('text/html','204 No response');
3092 print $query->header(-type=>'image/gif',
3094 -status=>'402 Payment required',
3099 header() returns the Content-type: header. You can provide your own
3100 MIME type if you choose, otherwise it defaults to text/html. An
3101 optional second parameter specifies the status code and a human-readable
3102 message. For example, you can specify 204, "No response" to create a
3103 script that tells the browser to do nothing at all. If you want to
3104 add additional fields to the header, just tack them on to the end:
3106 print $query->header('text/html','200 OK','Content-Length: 3002');
3108 The last example shows the named argument style for passing arguments
3109 to the CGI methods using named parameters. Recognized parameters are
3110 B<-type>, B<-status>, B<-expires>, and B<-cookie>. Any other
3111 parameters will be stripped of their initial hyphens and turned into
3112 header fields, allowing you to specify any HTTP header you desire.
3114 Most browsers will not cache the output from CGI scripts. Every time
3115 the browser reloads the page, the script is invoked anew. You can
3116 change this behavior with the B<-expires> parameter. When you specify
3117 an absolute or relative expiration interval with this parameter, some
3118 browsers and proxy servers will cache the script's output until the
3119 indicated expiration date. The following forms are all valid for the
3122 +30s 30 seconds from now
3123 +10m ten minutes from now
3124 +1h one hour from now
3125 -1d yesterday (i.e. "ASAP!")
3128 +10y in ten years time
3129 Thursday, 25-Apr-96 00:40:33 GMT at the indicated time & date
3131 (CGI::expires() is the static function call used internally that turns
3132 relative time intervals into HTTP dates. You can call it directly if
3135 The B<-cookie> parameter generates a header that tells the browser to provide
3136 a "magic cookie" during all subsequent transactions with your script.
3137 Netscape cookies have a special format that includes interesting attributes
3138 such as expiration time. Use the cookie() method to create and retrieve
3141 The B<-nph> parameter, if set to a true value, will issue the correct
3142 headers to work with a NPH (no-parse-header) script. This is important
3143 to use with certain servers, such as Microsoft Internet Explorer, which
3144 expect all their scripts to be NPH.
3146 =head2 GENERATING A REDIRECTION INSTRUCTION
3148 print $query->redirect('http://somewhere.else/in/movie/land');
3150 redirects the browser elsewhere. If you use redirection like this,
3151 you should B<not> print out a header as well. As of version 2.0, we
3152 produce both the unofficial Location: header and the official URI:
3153 header. This should satisfy most servers and browsers.
3155 One hint I can offer is that relative links may not work correctly
3156 when you generate a redirection to another document on your site.
3157 This is due to a well-intentioned optimization that some servers use.
3158 The solution to this is to use the full URL (including the http: part)
3159 of the document you are redirecting to.
3161 You can use named parameters:
3163 print $query->redirect(-uri=>'http://somewhere.else/in/movie/land',
3166 The B<-nph> parameter, if set to a true value, will issue the correct
3167 headers to work with a NPH (no-parse-header) script. This is important
3168 to use with certain servers, such as Microsoft Internet Explorer, which
3169 expect all their scripts to be NPH.
3172 =head2 CREATING THE HTML HEADER:
3174 print $query->start_html(-title=>'Secrets of the Pyramids',
3175 -author=>'fred@capricorn.org',
3178 -meta=>{'keywords'=>'pharaoh secret mummy',
3179 'copyright'=>'copyright 1996 King Tut'},
3184 print $query->start_html('Secrets of the Pyramids',
3185 'fred@capricorn.org','true',
3188 This will return a canned HTML header and the opening <BODY> tag.
3189 All parameters are optional. In the named parameter form, recognized
3190 parameters are -title, -author, -base, -xbase and -target (see below for the
3191 explanation). Any additional parameters you provide, such as the
3192 Netscape unofficial BGCOLOR attribute, are added to the <BODY> tag.
3194 The argument B<-xbase> allows you to provide an HREF for the <BASE> tag
3195 different from the current location, as in
3197 -xbase=>"http://home.mcom.com/"
3199 All relative links will be interpreted relative to this tag.
3201 The argument B<-target> allows you to provide a default target frame
3202 for all the links and fill-out forms on the page. See the Netscape
3203 documentation on frames for details of how to manipulate this.
3205 -target=>"answer_window"
3207 All relative links will be interpreted relative to this tag.
3208 You add arbitrary meta information to the header with the B<-meta>
3209 argument. This argument expects a reference to an associative array
3210 containing name/value pairs of meta information. These will be turned
3211 into a series of header <META> tags that look something like this:
3213 <META NAME="keywords" CONTENT="pharaoh secret mummy">
3214 <META NAME="description" CONTENT="copyright 1996 King Tut">
3216 There is no support for the HTTP-EQUIV type of <META> tag. This is
3217 because you can modify the HTTP header directly with the B<header()>
3220 JAVASCRIPTING: The B<-script>, B<-noScript>, B<-onLoad> and B<-onUnload> parameters
3221 are used to add Netscape JavaScript calls to your pages. B<-script>
3222 should point to a block of text containing JavaScript function
3223 definitions. This block will be placed within a <SCRIPT> block inside
3224 the HTML (not HTTP) header. The block is placed in the header in
3225 order to give your page a fighting chance of having all its JavaScript
3226 functions in place even if the user presses the stop button before the
3227 page has loaded completely. CGI.pm attempts to format the script in
3228 such a way that JavaScript-naive browsers will not choke on the code:
3229 unfortunately there are some browsers, such as Chimera for Unix, that
3230 get confused by it nevertheless.
3232 The B<-onLoad> and B<-onUnload> parameters point to fragments of JavaScript
3233 code to execute when the page is respectively opened and closed by the
3234 browser. Usually these parameters are calls to functions defined in the
3238 print $query->header;
3240 // Ask a silly question
3241 function riddle_me_this() {
3242 var r = prompt("What walks on four legs in the morning, " +
3243 "two legs in the afternoon, " +
3244 "and three legs in the evening?");
3247 // Get a silly answer
3248 function response(answer) {
3249 if (answer == "man")
3250 alert("Right you are!");
3252 alert("Wrong! Guess again.");
3255 print $query->start_html(-title=>'The Riddle of the Sphinx',
3258 Use the B<-noScript> parameter to pass some HTML text that will be displayed on
3259 browsers that do not have JavaScript (or browsers where JavaScript is turned
3264 http://home.netscape.com/eng/mozilla/2.0/handbook/javascript/
3266 for more information about JavaScript.
3268 The old-style positional parameters are as follows:
3272 =item B<Parameters:>
3280 The author's e-mail address (will create a <LINK REV="MADE"> tag if present
3284 A 'true' flag if you want to include a <BASE> tag in the header. This
3285 helps resolve relative addresses to absolute ones when the document is moved,
3286 but makes the document hierarchy non-portable. Use with care!
3290 Any other parameters you want to include in the <BODY> tag. This is a good
3291 place to put Netscape extensions, such as colors and wallpaper patterns.
3295 =head2 ENDING THE HTML DOCUMENT:
3297 print $query->end_html
3299 This ends an HTML document by printing the </BODY></HTML> tags.
3301 =head1 CREATING FORMS
3303 I<General note> The various form-creating methods all return strings
3304 to the caller, containing the tag or tags that will create the requested
3305 form element. You are responsible for actually printing out these strings.
3306 It's set up this way so that you can place formatting tags
3307 around the form elements.
3309 I<Another note> The default values that you specify for the forms are only
3310 used the B<first> time the script is invoked (when there is no query
3311 string). On subsequent invocations of the script (when there is a query
3312 string), the former values are used even if they are blank.
3314 If you want to change the value of a field from its previous value, you have two
3317 (1) call the param() method to set it.
3319 (2) use the -override (alias -force) parameter (a new feature in version 2.15).
3320 This forces the default value to be used, regardless of the previous value:
3322 print $query->textfield(-name=>'field_name',
3323 -default=>'starting value',
3328 I<Yet another note> By default, the text and labels of form elements are
3329 escaped according to HTML rules. This means that you can safely use
3330 "<CLICK ME>" as the label for a button. However, it also interferes with
3331 your ability to incorporate special HTML character sequences, such as Á,
3332 into your fields. If you wish to turn off automatic escaping, call the
3333 autoEscape() method with a false value immediately after creating the CGI object:
3336 $query->autoEscape(undef);
3339 =head2 CREATING AN ISINDEX TAG
3341 print $query->isindex(-action=>$action);
3345 print $query->isindex($action);
3347 Prints out an <ISINDEX> tag. Not very exciting. The parameter
3348 -action specifies the URL of the script to process the query. The
3349 default is to process the query with the current script.
3351 =head2 STARTING AND ENDING A FORM
3353 print $query->startform(-method=>$method,
3355 -encoding=>$encoding);
3356 <... various form stuff ...>
3357 print $query->endform;
3361 print $query->startform($method,$action,$encoding);
3362 <... various form stuff ...>
3363 print $query->endform;
3365 startform() will return a <FORM> tag with the optional method,
3366 action and form encoding that you specify. The defaults are:
3370 encoding: application/x-www-form-urlencoded
3372 endform() returns the closing </FORM> tag.
3374 Startform()'s encoding method tells the browser how to package the various
3375 fields of the form before sending the form to the server. Two
3376 values are possible:
3380 =item B<application/x-www-form-urlencoded>
3382 This is the older type of encoding used by all browsers prior to
3383 Netscape 2.0. It is compatible with many CGI scripts and is
3384 suitable for short fields containing text data. For your
3385 convenience, CGI.pm stores the name of this encoding
3386 type in B<$CGI::URL_ENCODED>.
3388 =item B<multipart/form-data>
3390 This is the newer type of encoding introduced by Netscape 2.0.
3391 It is suitable for forms that contain very large fields or that
3392 are intended for transferring binary data. Most importantly,
3393 it enables the "file upload" feature of Netscape 2.0 forms. For
3394 your convenience, CGI.pm stores the name of this encoding type
3395 in B<$CGI::MULTIPART>
3397 Forms that use this type of encoding are not easily interpreted
3398 by CGI scripts unless they use CGI.pm or another library designed
3403 For compatibility, the startform() method uses the older form of
3404 encoding by default. If you want to use the newer form of encoding
3405 by default, you can call B<start_multipart_form()> instead of
3408 JAVASCRIPTING: The B<-name> and B<-onSubmit> parameters are provided
3409 for use with JavaScript. The -name parameter gives the
3410 form a name so that it can be identified and manipulated by
3411 JavaScript functions. -onSubmit should point to a JavaScript
3412 function that will be executed just before the form is submitted to your
3413 server. You can use this opportunity to check the contents of the form
3414 for consistency and completeness. If you find something wrong, you
3415 can put up an alert box or maybe fix things up yourself. You can
3416 abort the submission by returning false from this function.
3418 Usually the bulk of JavaScript functions are defined in a <SCRIPT>
3419 block in the HTML header and -onSubmit points to one of these function
3420 call. See start_html() for details.
3422 =head2 CREATING A TEXT FIELD
3424 print $query->textfield(-name=>'field_name',
3425 -default=>'starting value',
3430 print $query->textfield('field_name','starting value',50,80);
3432 textfield() will return a text input field.
3440 The first parameter is the required name for the field (-name).
3444 The optional second parameter is the default starting value for the field
3445 contents (-default).
3449 The optional third parameter is the size of the field in
3454 The optional fourth parameter is the maximum number of characters the
3455 field will accept (-maxlength).
3459 As with all these methods, the field will be initialized with its
3460 previous contents from earlier invocations of the script.
3461 When the form is processed, the value of the text field can be
3464 $value = $query->param('foo');
3466 If you want to reset it from its initial value after the script has been
3467 called once, you can do so like this:
3469 $query->param('foo',"I'm taking over this value!");
3471 NEW AS OF VERSION 2.15: If you don't want the field to take on its previous
3472 value, you can force its current value by using the -override (alias -force)
3475 print $query->textfield(-name=>'field_name',
3476 -default=>'starting value',
3481 JAVASCRIPTING: You can also provide B<-onChange>, B<-onFocus>, B<-onBlur>
3482 and B<-onSelect> parameters to register JavaScript event handlers.
3483 The onChange handler will be called whenever the user changes the
3484 contents of the text field. You can do text validation if you like.
3485 onFocus and onBlur are called respectively when the insertion point
3486 moves into and out of the text field. onSelect is called when the
3487 user changes the portion of the text that is selected.
3489 =head2 CREATING A BIG TEXT FIELD
3491 print $query->textarea(-name=>'foo',
3492 -default=>'starting value',
3498 print $query->textarea('foo','starting value',10,50);
3500 textarea() is just like textfield, but it allows you to specify
3501 rows and columns for a multiline text entry box. You can provide
3502 a starting value for the field, which can be long and contain
3505 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>
3506 and B<-onSelect> parameters are recognized. See textfield().
3508 =head2 CREATING A PASSWORD FIELD
3510 print $query->password_field(-name=>'secret',
3511 -value=>'starting value',
3516 print $query->password_field('secret','starting value',50,80);
3518 password_field() is identical to textfield(), except that its contents
3519 will be starred out on the web page.
3521 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>
3522 and B<-onSelect> parameters are recognized. See textfield().
3524 =head2 CREATING A FILE UPLOAD FIELD
3526 print $query->filefield(-name=>'uploaded_file',
3527 -default=>'starting value',
3532 print $query->filefield('uploaded_file','starting value',50,80);
3534 filefield() will return a file upload field for Netscape 2.0 browsers.
3535 In order to take full advantage of this I<you must use the new
3536 multipart encoding scheme> for the form. You can do this either
3537 by calling B<startform()> with an encoding type of B<$CGI::MULTIPART>,
3538 or by calling the new method B<start_multipart_form()> instead of
3539 vanilla B<startform()>.
3547 The first parameter is the required name for the field (-name).
3551 The optional second parameter is the starting value for the field contents
3552 to be used as the default file name (-default).
3554 The beta2 version of Netscape 2.0 currently doesn't pay any attention
3555 to this field, and so the starting value will always be blank. Worse,
3556 the field loses its "sticky" behavior and forgets its previous
3557 contents. The starting value field is called for in the HTML
3558 specification, however, and possibly later versions of Netscape will
3563 The optional third parameter is the size of the field in
3568 The optional fourth parameter is the maximum number of characters the
3569 field will accept (-maxlength).
3573 When the form is processed, you can retrieve the entered filename
3576 $filename = $query->param('uploaded_file');
3578 In Netscape Gold, the filename that gets returned is the full local filename
3579 on the B<remote user's> machine. If the remote user is on a Unix
3580 machine, the filename will follow Unix conventions:
3584 On an MS-DOS/Windows and OS/2 machines, the filename will follow DOS conventions:
3586 C:\PATH\TO\THE\FILE.MSW
3588 On a Macintosh machine, the filename will follow Mac conventions:
3590 HD 40:Desktop Folder:Sort Through:Reminders
3592 The filename returned is also a file handle. You can read the contents
3593 of the file using standard Perl file reading calls:
3595 # Read a text file and print it out
3596 while (<$filename>) {
3600 # Copy a binary file to somewhere safe
3601 open (OUTFILE,">>/usr/local/web/users/feedback");
3602 while ($bytesread=read($filename,$buffer,1024)) {
3603 print OUTFILE $buffer;
3606 When a file is uploaded the browser usually sends along some
3607 information along with it in the format of headers. The information
3608 usually includes the MIME content type. Future browsers may send
3609 other information as well (such as modification date and size). To
3610 retrieve this information, call uploadInfo(). It returns a reference to
3611 an associative array containing all the document headers.
3613 $filename = $query->param('uploaded_file');
3614 $type = $query->uploadInfo($filename)->{'Content-Type'};
3615 unless ($type eq 'text/html') {
3616 die "HTML FILES ONLY!";
3619 If you are using a machine that recognizes "text" and "binary" data
3620 modes, be sure to understand when and how to use them (see the Camel book).
3621 Otherwise you may find that binary files are corrupted during file uploads.
3623 JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>
3624 and B<-onSelect> parameters are recognized. See textfield()
3627 =head2 CREATING A POPUP MENU
3629 print $query->popup_menu('menu_name',
3630 ['eenie','meenie','minie'],
3635 %labels = ('eenie'=>'your first choice',
3636 'meenie'=>'your second choice',
3637 'minie'=>'your third choice');
3638 print $query->popup_menu('menu_name',
3639 ['eenie','meenie','minie'],
3642 -or (named parameter style)-
3644 print $query->popup_menu(-name=>'menu_name',
3645 -values=>['eenie','meenie','minie'],
3649 popup_menu() creates a menu.
3655 The required first argument is the menu's name (-name).
3659 The required second argument (-values) is an array B<reference>
3660 containing the list of menu items in the menu. You can pass the
3661 method an anonymous array, as shown in the example, or a reference to
3662 a named array, such as "\@foo".
3666 The optional third parameter (-default) is the name of the default
3667 menu choice. If not specified, the first item will be the default.
3668 The values of the previous choice will be maintained across queries.
3672 The optional fourth parameter (-labels) is provided for people who
3673 want to use different values for the user-visible label inside the
3674 popup menu nd the value returned to your script. It's a pointer to an
3675 associative array relating menu values to user-visible labels. If you
3676 leave this parameter blank, the menu values will be displayed by
3677 default. (You can also leave a label undefined if you want to).
3681 When the form is processed, the selected value of the popup menu can
3684 $popup_menu_value = $query->param('menu_name');
3686 JAVASCRIPTING: popup_menu() recognizes the following event handlers:
3687 B<-onChange>, B<-onFocus>, and B<-onBlur>. See the textfield()
3688 section for details on when these handlers are called.
3690 =head2 CREATING A SCROLLING LIST
3692 print $query->scrolling_list('list_name',
3693 ['eenie','meenie','minie','moe'],
3694 ['eenie','moe'],5,'true');
3697 print $query->scrolling_list('list_name',
3698 ['eenie','meenie','minie','moe'],
3699 ['eenie','moe'],5,'true',
3704 print $query->scrolling_list(-name=>'list_name',
3705 -values=>['eenie','meenie','minie','moe'],
3706 -default=>['eenie','moe'],
3711 scrolling_list() creates a scrolling list.
3715 =item B<Parameters:>
3719 The first and second arguments are the list name (-name) and values
3720 (-values). As in the popup menu, the second argument should be an
3725 The optional third argument (-default) can be either a reference to a
3726 list containing the values to be selected by default, or can be a
3727 single value to select. If this argument is missing or undefined,
3728 then nothing is selected when the list first appears. In the named
3729 parameter version, you can use the synonym "-defaults" for this
3734 The optional fourth argument is the size of the list (-size).
3738 The optional fifth argument can be set to true to allow multiple
3739 simultaneous selections (-multiple). Otherwise only one selection
3740 will be allowed at a time.
3744 The optional sixth argument is a pointer to an associative array
3745 containing long user-visible labels for the list items (-labels).
3746 If not provided, the values will be displayed.
3748 When this form is processed, all selected list items will be returned as
3749 a list under the parameter name 'list_name'. The values of the
3750 selected items can be retrieved with:
3752 @selected = $query->param('list_name');
3756 JAVASCRIPTING: scrolling_list() recognizes the following event handlers:
3757 B<-onChange>, B<-onFocus>, and B<-onBlur>. See textfield() for
3758 the description of when these handlers are called.
3760 =head2 CREATING A GROUP OF RELATED CHECKBOXES
3762 print $query->checkbox_group(-name=>'group_name',
3763 -values=>['eenie','meenie','minie','moe'],
3764 -default=>['eenie','moe'],
3768 print $query->checkbox_group('group_name',
3769 ['eenie','meenie','minie','moe'],
3770 ['eenie','moe'],'true',\%labels);
3772 HTML3-COMPATIBLE BROWSERS ONLY:
3774 print $query->checkbox_group(-name=>'group_name',
3775 -values=>['eenie','meenie','minie','moe'],
3776 -rows=2,-columns=>2);
3779 checkbox_group() creates a list of checkboxes that are related
3784 =item B<Parameters:>
3788 The first and second arguments are the checkbox name and values,
3789 respectively (-name and -values). As in the popup menu, the second
3790 argument should be an array reference. These values are used for the
3791 user-readable labels printed next to the checkboxes as well as for the
3792 values passed to your script in the query string.
3796 The optional third argument (-default) can be either a reference to a
3797 list containing the values to be checked by default, or can be a
3798 single value to checked. If this argument is missing or undefined,
3799 then nothing is selected when the list first appears.
3803 The optional fourth argument (-linebreak) can be set to true to place
3804 line breaks between the checkboxes so that they appear as a vertical
3805 list. Otherwise, they will be strung together on a horizontal line.
3809 The optional fifth argument is a pointer to an associative array
3810 relating the checkbox values to the user-visible labels that will
3811 be printed next to them (-labels). If not provided, the values will
3812 be used as the default.
3816 B<HTML3-compatible browsers> (such as Netscape) can take advantage
3818 parameters B<-rows>, and B<-columns>. These parameters cause
3819 checkbox_group() to return an HTML3 compatible table containing
3820 the checkbox group formatted with the specified number of rows
3821 and columns. You can provide just the -columns parameter if you
3822 wish; checkbox_group will calculate the correct number of rows
3825 To include row and column headings in the returned table, you
3826 can use the B<-rowheader> and B<-colheader> parameters. Both
3827 of these accept a pointer to an array of headings to use.
3828 The headings are just decorative. They don't reorganize the
3829 interpretation of the checkboxes -- they're still a single named
3834 When the form is processed, all checked boxes will be returned as
3835 a list under the parameter name 'group_name'. The values of the
3836 "on" checkboxes can be retrieved with:
3838 @turned_on = $query->param('group_name');
3840 The value returned by checkbox_group() is actually an array of button
3841 elements. You can capture them and use them within tables, lists,
3842 or in other creative ways:
3844 @h = $query->checkbox_group(-name=>'group_name',-values=>\@values);
3845 &use_in_creative_way(@h);
3847 JAVASCRIPTING: checkbox_group() recognizes the B<-onClick>
3848 parameter. This specifies a JavaScript code fragment or
3849 function call to be executed every time the user clicks on
3850 any of the buttons in the group. You can retrieve the identity
3851 of the particular button clicked on using the "this" variable.
3853 =head2 CREATING A STANDALONE CHECKBOX
3855 print $query->checkbox(-name=>'checkbox_name',
3856 -checked=>'checked',
3858 -label=>'CLICK ME');
3862 print $query->checkbox('checkbox_name','checked','ON','CLICK ME');
3864 checkbox() is used to create an isolated checkbox that isn't logically
3865 related to any others.
3869 =item B<Parameters:>
3873 The first parameter is the required name for the checkbox (-name). It
3874 will also be used for the user-readable label printed next to the
3879 The optional second parameter (-checked) specifies that the checkbox
3880 is turned on by default. Synonyms are -selected and -on.
3884 The optional third parameter (-value) specifies the value of the
3885 checkbox when it is checked. If not provided, the word "on" is
3890 The optional fourth parameter (-label) is the user-readable label to
3891 be attached to the checkbox. If not provided, the checkbox name is
3896 The value of the checkbox can be retrieved using:
3898 $turned_on = $query->param('checkbox_name');
3900 JAVASCRIPTING: checkbox() recognizes the B<-onClick>
3901 parameter. See checkbox_group() for further details.
3903 =head2 CREATING A RADIO BUTTON GROUP
3905 print $query->radio_group(-name=>'group_name',
3906 -values=>['eenie','meenie','minie'],
3913 print $query->radio_group('group_name',['eenie','meenie','minie'],
3914 'meenie','true',\%labels);
3917 HTML3-COMPATIBLE BROWSERS ONLY:
3919 print $query->radio_group(-name=>'group_name',
3920 -values=>['eenie','meenie','minie','moe'],
3921 -rows=2,-columns=>2);
3923 radio_group() creates a set of logically-related radio buttons
3924 (turning one member of the group on turns the others off)
3928 =item B<Parameters:>
3932 The first argument is the name of the group and is required (-name).
3936 The second argument (-values) is the list of values for the radio
3937 buttons. The values and the labels that appear on the page are
3938 identical. Pass an array I<reference> in the second argument, either
3939 using an anonymous array, as shown, or by referencing a named array as
3944 The optional third parameter (-default) is the name of the default
3945 button to turn on. If not specified, the first item will be the
3946 default. You can provide a nonexistent button name, such as "-" to
3947 start up with no buttons selected.
3951 The optional fourth parameter (-linebreak) can be set to 'true' to put
3952 line breaks between the buttons, creating a vertical list.
3956 The optional fifth parameter (-labels) is a pointer to an associative
3957 array relating the radio button values to user-visible labels to be
3958 used in the display. If not provided, the values themselves are
3963 B<HTML3-compatible browsers> (such as Netscape) can take advantage
3965 parameters B<-rows>, and B<-columns>. These parameters cause
3966 radio_group() to return an HTML3 compatible table containing
3967 the radio group formatted with the specified number of rows
3968 and columns. You can provide just the -columns parameter if you
3969 wish; radio_group will calculate the correct number of rows
3972 To include row and column headings in the returned table, you
3973 can use the B<-rowheader> and B<-colheader> parameters. Both
3974 of these accept a pointer to an array of headings to use.
3975 The headings are just decorative. They don't reorganize the
3976 interpetation of the radio buttons -- they're still a single named
3981 When the form is processed, the selected radio button can
3984 $which_radio_button = $query->param('group_name');
3986 The value returned by radio_group() is actually an array of button
3987 elements. You can capture them and use them within tables, lists,
3988 or in other creative ways:
3990 @h = $query->radio_group(-name=>'group_name',-values=>\@values);
3991 &use_in_creative_way(@h);
3993 =head2 CREATING A SUBMIT BUTTON
3995 print $query->submit(-name=>'button_name',
4000 print $query->submit('button_name','value');
4002 submit() will create the query submission button. Every form
4003 should have one of these.
4007 =item B<Parameters:>
4011 The first argument (-name) is optional. You can give the button a
4012 name if you have several submission buttons in your form and you want
4013 to distinguish between them. The name will also be used as the
4014 user-visible label. Be aware that a few older browsers don't deal with this correctly and
4015 B<never> send back a value from a button.
4019 The second argument (-value) is also optional. This gives the button
4020 a value that will be passed to your script in the query string.
4024 You can figure out which button was pressed by using different
4025 values for each one:
4027 $which_one = $query->param('button_name');
4029 JAVASCRIPTING: radio_group() recognizes the B<-onClick>
4030 parameter. See checkbox_group() for further details.
4032 =head2 CREATING A RESET BUTTON
4036 reset() creates the "reset" button. Note that it restores the
4037 form to its value from the last time the script was called,
4038 NOT necessarily to the defaults.
4040 =head2 CREATING A DEFAULT BUTTON
4042 print $query->defaults('button_label')
4044 defaults() creates a button that, when invoked, will cause the
4045 form to be completely reset to its defaults, wiping out all the
4046 changes the user ever made.
4048 =head2 CREATING A HIDDEN FIELD
4050 print $query->hidden(-name=>'hidden_name',
4051 -default=>['value1','value2'...]);
4055 print $query->hidden('hidden_name','value1','value2'...);
4057 hidden() produces a text field that can't be seen by the user. It
4058 is useful for passing state variable information from one invocation
4059 of the script to the next.
4063 =item B<Parameters:>
4067 The first argument is required and specifies the name of this
4072 The second argument is also required and specifies its value
4073 (-default). In the named parameter style of calling, you can provide
4074 a single value here or a reference to a whole list
4078 Fetch the value of a hidden field this way:
4080 $hidden_value = $query->param('hidden_name');
4082 Note, that just like all the other form elements, the value of a
4083 hidden field is "sticky". If you want to replace a hidden field with
4084 some other values after the script has been called once you'll have to
4087 $query->param('hidden_name','new','values','here');
4089 =head2 CREATING A CLICKABLE IMAGE BUTTON
4091 print $query->image_button(-name=>'button_name',
4092 -src=>'/source/URL',
4097 print $query->image_button('button_name','/source/URL','MIDDLE');
4099 image_button() produces a clickable image. When it's clicked on the
4100 position of the click is returned to your script as "button_name.x"
4101 and "button_name.y", where "button_name" is the name you've assigned
4104 JAVASCRIPTING: image_button() recognizes the B<-onClick>
4105 parameter. See checkbox_group() for further details.
4109 =item B<Parameters:>
4113 The first argument (-name) is required and specifies the name of this
4118 The second argument (-src) is also required and specifies the URL
4121 The third option (-align, optional) is an alignment type, and may be
4122 TOP, BOTTOM or MIDDLE
4126 Fetch the value of the button this way:
4127 $x = $query->param('button_name.x');
4128 $y = $query->param('button_name.y');
4130 =head2 CREATING A JAVASCRIPT ACTION BUTTON
4132 print $query->button(-name=>'button_name',
4133 -value=>'user visible label',
4134 -onClick=>"do_something()");
4138 print $query->button('button_name',"do_something()");
4140 button() produces a button that is compatible with Netscape 2.0's
4141 JavaScript. When it's pressed the fragment of JavaScript code
4142 pointed to by the B<-onClick> parameter will be executed. On
4143 non-Netscape browsers this form element will probably not even
4146 =head1 NETSCAPE COOKIES
4148 Netscape browsers versions 1.1 and higher support a so-called
4149 "cookie" designed to help maintain state within a browser session.
4150 CGI.pm has several methods that support cookies.
4152 A cookie is a name=value pair much like the named parameters in a CGI
4153 query string. CGI scripts create one or more cookies and send
4154 them to the browser in the HTTP header. The browser maintains a list
4155 of cookies that belong to a particular Web server, and returns them
4156 to the CGI script during subsequent interactions.
4158 In addition to the required name=value pair, each cookie has several
4159 optional attributes:
4163 =item 1. an expiration time
4165 This is a time/date string (in a special GMT format) that indicates
4166 when a cookie expires. The cookie will be saved and returned to your
4167 script until this expiration date is reached if the user exits
4168 Netscape and restarts it. If an expiration date isn't specified, the cookie
4169 will remain active until the user quits Netscape.
4173 This is a partial or complete domain name for which the cookie is
4174 valid. The browser will return the cookie to any host that matches
4175 the partial domain name. For example, if you specify a domain name
4176 of ".capricorn.com", then Netscape will return the cookie to
4177 Web servers running on any of the machines "www.capricorn.com",
4178 "www2.capricorn.com", "feckless.capricorn.com", etc. Domain names
4179 must contain at least two periods to prevent attempts to match
4180 on top level domains like ".edu". If no domain is specified, then
4181 the browser will only return the cookie to servers on the host the
4182 cookie originated from.
4186 If you provide a cookie path attribute, the browser will check it
4187 against your script's URL before returning the cookie. For example,
4188 if you specify the path "/cgi-bin", then the cookie will be returned
4189 to each of the scripts "/cgi-bin/tally.pl", "/cgi-bin/order.pl",
4190 and "/cgi-bin/customer_service/complain.pl", but not to the script
4191 "/cgi-private/site_admin.pl". By default, path is set to "/", which
4192 causes the cookie to be sent to any CGI script on your site.
4194 =item 4. a "secure" flag
4196 If the "secure" attribute is set, the cookie will only be sent to your
4197 script if the CGI request is occurring on a secure channel, such as SSL.
4201 The interface to Netscape cookies is the B<cookie()> method:
4203 $cookie = $query->cookie(-name=>'sessionID',
4206 -path=>'/cgi-bin/database',
4207 -domain=>'.capricorn.org',
4209 print $query->header(-cookie=>$cookie);
4211 B<cookie()> creates a new cookie. Its parameters include:
4217 The name of the cookie (required). This can be any string at all.
4218 Although Netscape limits its cookie names to non-whitespace
4219 alphanumeric characters, CGI.pm removes this restriction by escaping
4220 and unescaping cookies behind the scenes.
4224 The value of the cookie. This can be any scalar value,
4225 array reference, or even associative array reference. For example,
4226 you can store an entire associative array into a cookie this way:
4228 $cookie=$query->cookie(-name=>'family information',
4229 -value=>\%childrens_ages);
4233 The optional partial path for which this cookie will be valid, as described
4238 The optional partial domain for which this cookie will be valid, as described
4243 The optional expiration date for this cookie. The format is as described
4244 in the section on the B<header()> method:
4246 "+1h" one hour from now
4250 If set to true, this cookie will only be used within a secure
4255 The cookie created by cookie() must be incorporated into the HTTP
4256 header within the string returned by the header() method:
4258 print $query->header(-cookie=>$my_cookie);
4260 To create multiple cookies, give header() an array reference:
4262 $cookie1 = $query->cookie(-name=>'riddle_name',
4263 -value=>"The Sphynx's Question");
4264 $cookie2 = $query->cookie(-name=>'answers',
4266 print $query->header(-cookie=>[$cookie1,$cookie2]);
4268 To retrieve a cookie, request it by name by calling cookie()
4269 method without the B<-value> parameter:
4273 %answers = $query->cookie(-name=>'answers');
4274 # $query->cookie('answers') will work too!
4276 The cookie and CGI namespaces are separate. If you have a parameter
4277 named 'answers' and a cookie named 'answers', the values retrieved by
4278 param() and cookie() are independent of each other. However, it's
4279 simple to turn a CGI parameter into a cookie, and vice-versa:
4281 # turn a CGI parameter into a cookie
4282 $c=$q->cookie(-name=>'answers',-value=>[$q->param('answers')]);
4284 $q->param(-name=>'answers',-value=>[$q->cookie('answers')]);
4286 See the B<cookie.cgi> example script for some ideas on how to use
4287 cookies effectively.
4289 B<NOTE:> There appear to be some (undocumented) restrictions on
4290 Netscape cookies. In Netscape 2.01, at least, I haven't been able to
4291 set more than three cookies at a time. There may also be limits on
4292 the length of cookies. If you need to store a lot of information,
4293 it's probably better to create a unique session ID, store it in a
4294 cookie, and use the session ID to locate an external file/database
4295 saved on the server's side of the connection.
4297 =head1 WORKING WITH NETSCAPE FRAMES
4299 It's possible for CGI.pm scripts to write into several browser
4300 panels and windows using Netscape's frame mechanism.
4301 There are three techniques for defining new frames programmatically:
4305 =item 1. Create a <Frameset> document
4307 After writing out the HTTP header, instead of creating a standard
4308 HTML document using the start_html() call, create a <FRAMESET>
4309 document that defines the frames on the page. Specify your script(s)
4310 (with appropriate parameters) as the SRC for each of the frames.
4312 There is no specific support for creating <FRAMESET> sections
4313 in CGI.pm, but the HTML is very simple to write. See the frame
4314 documentation in Netscape's home pages for details
4316 http://home.netscape.com/assist/net_sites/frames.html
4318 =item 2. Specify the destination for the document in the HTTP header
4320 You may provide a B<-target> parameter to the header() method:
4322 print $q->header(-target=>'ResultsWindow');
4324 This will tell Netscape to load the output of your script into the
4325 frame named "ResultsWindow". If a frame of that name doesn't
4326 already exist, Netscape will pop up a new window and load your
4327 script's document into that. There are a number of magic names
4328 that you can use for targets. See the frame documents on Netscape's
4329 home pages for details.
4331 =item 3. Specify the destination for the document in the <FORM> tag
4333 You can specify the frame to load in the FORM tag itself. With
4334 CGI.pm it looks like this:
4336 print $q->startform(-target=>'ResultsWindow');
4338 When your script is reinvoked by the form, its output will be loaded
4339 into the frame named "ResultsWindow". If one doesn't already exist
4340 a new window will be created.
4344 The script "frameset.cgi" in the examples directory shows one way to
4345 create pages in which the fill-out form and the response live in
4346 side-by-side frames.
4350 If you are running the script
4351 from the command line or in the perl debugger, you can pass the script
4352 a list of keywords or parameter=value pairs on the command line or
4353 from standard input (you don't have to worry about tricking your
4354 script into reading from environment variables).
4355 You can pass keywords like this:
4357 your_script.pl keyword1 keyword2 keyword3
4361 your_script.pl keyword1+keyword2+keyword3
4365 your_script.pl name1=value1 name2=value2
4369 your_script.pl name1=value1&name2=value2
4371 or even as newline-delimited parameters on standard input.
4373 When debugging, you can use quotes and backslashes to escape
4374 characters in the familiar shell manner, letting you place
4375 spaces and other funny characters in your parameter=value
4378 your_script.pl "name1='I am a long value'" "name2=two\ words"
4380 =head2 DUMPING OUT ALL THE NAME/VALUE PAIRS
4382 The dump() method produces a string consisting of all the query's
4383 name/value pairs formatted nicely as a nested list. This is useful
4384 for debugging purposes:
4389 Produces something that looks like:
4403 You can pass a value of 'true' to dump() in order to get it to
4404 print the results out as plain text, suitable for incorporating
4405 into a <PRE> section.
4407 As a shortcut, as of version 1.56 you can interpolate the entire CGI
4408 object into a string and it will be replaced with the a nice HTML dump
4412 print "<H2>Current Values</H2> $query\n";
4414 =head1 FETCHING ENVIRONMENT VARIABLES
4416 Some of the more useful environment variables can be fetched
4417 through this interface. The methods are as follows:
4423 Return a list of MIME types that the remote browser
4424 accepts. If you give this method a single argument
4425 corresponding to a MIME type, as in
4426 $query->accept('text/html'), it will return a
4427 floating point value corresponding to the browser's
4428 preference for this type from 0.0 (don't want) to 1.0.
4429 Glob types (e.g. text/*) in the browser's accept list
4430 are handled correctly.
4432 =item B<raw_cookie()>
4434 Returns the HTTP_COOKIE variable, an HTTP extension
4435 implemented by Netscape browsers version 1.1
4436 and higher. Cookies have a special format, and this
4437 method call just returns the raw form (?cookie dough).
4438 See cookie() for ways of setting and retrieving
4441 =item B<user_agent()>
4443 Returns the HTTP_USER_AGENT variable. If you give
4444 this method a single argument, it will attempt to
4445 pattern match on it, allowing you to do something
4446 like $query->user_agent(netscape);
4448 =item B<path_info()>
4450 Returns additional path information from the script URL.
4451 E.G. fetching /cgi-bin/your_script/additional/stuff will
4452 result in $query->path_info() returning
4455 NOTE: The Microsoft Internet Information Server
4456 is broken with respect to additional path information. If
4457 you use the Perl DLL library, the IIS server will attempt to
4458 execute the additional path information as a Perl script.
4459 If you use the ordinary file associations mapping, the
4460 path information will be present in the environment,
4461 but incorrect. The best thing to do is to avoid using additional
4462 path information in CGI scripts destined for use with IIS.
4464 =item B<path_translated()>
4466 As per path_info() but returns the additional
4467 path information translated into a physical path, e.g.
4468 "/usr/local/etc/httpd/htdocs/additional/stuff".
4470 The Microsoft IIS is broken with respect to the translated
4473 =item B<remote_host()>
4475 Returns either the remote host name or IP address.
4476 if the former is unavailable.
4478 =item B<script_name()>
4479 Return the script name as a partial URL, for self-refering
4484 Return the URL of the page the browser was viewing
4485 prior to fetching your script. Not available for all
4488 =item B<auth_type ()>
4490 Return the authorization/verification method in use for this
4493 =item B<server_name ()>
4495 Returns the name of the server, usually the machine's host
4498 =item B<virtual_host ()>
4500 When using virtual hosts, returns the name of the host that
4501 the browser attempted to contact
4503 =item B<server_software ()>
4505 Returns the server software and version number.
4507 =item B<remote_user ()>
4509 Return the authorization/verification name used for user
4510 verification, if this script is protected.
4512 =item B<user_name ()>
4514 Attempt to obtain the remote user's name, using a variety
4515 of different techniques. This only works with older browsers
4516 such as Mosaic. Netscape does not reliably report the user
4519 =item B<request_method()>
4521 Returns the method used to access your script, usually
4522 one of 'POST', 'GET' or 'HEAD'.
4526 =head1 CREATING HTML ELEMENTS
4528 In addition to its shortcuts for creating form elements, CGI.pm
4529 defines general HTML shortcut methods as well. HTML shortcuts are
4530 named after a single HTML element and return a fragment of HTML text
4531 that you can then print or manipulate as you like.
4533 This example shows how to use the HTML methods:
4536 print $q->blockquote(
4537 "Many years ago on the island of",
4538 $q->a({href=>"http://crete.org/"},"Crete"),
4539 "there lived a minotaur named",
4540 $q->strong("Fred."),
4544 This results in the following HTML code (extra newlines have been
4545 added for readability):
4548 Many years ago on the island of
4549 <a HREF="http://crete.org/">Crete</a> there lived
4550 a minotaur named <strong>Fred.</strong>
4554 If you find the syntax for calling the HTML shortcuts awkward, you can
4555 import them into your namespace and dispense with the object syntax
4556 completely (see the next section for more details):
4558 use CGI shortcuts; # IMPORT HTML SHORTCUTS
4560 "Many years ago on the island of",
4561 a({href=>"http://crete.org/"},"Crete"),
4562 "there lived a minotaur named",
4567 =head2 PROVIDING ARGUMENTS TO HTML SHORTCUTS
4569 The HTML methods will accept zero, one or multiple arguments. If you
4570 provide no arguments, you get a single tag:
4575 If you provide one or more string arguments, they are concatenated
4576 together with spaces and placed between opening and closing tags:
4578 print h1("Chapter","1");
4579 # gives "<h1>Chapter 1</h1>"
4581 If the first argument is an associative array reference, then the keys
4582 and values of the associative array become the HTML tag's attributes:
4584 print a({href=>'fred.html',target=>'_new'},
4585 "Open a new frame");
4586 # gives <a href="fred.html",target="_new">Open a new frame</a>
4588 You are free to use CGI.pm-style dashes in front of the attribute
4589 names if you prefer:
4591 print img {-src=>'fred.gif',-align=>'LEFT'};
4592 # gives <img ALIGN="LEFT" SRC="fred.gif">
4594 =head2 Generating new HTML tags
4596 Since no mere mortal can keep up with Netscape and Microsoft as they
4597 battle it out for control of HTML, the code that generates HTML tags
4598 is general and extensible. You can create new HTML tags freely just
4599 by referring to them on the import line:
4601 use CGI shortcuts,winkin,blinkin,nod;
4603 Now, in addition to the standard CGI shortcuts, you've created HTML
4604 tags named "winkin", "blinkin" and "nod". You can use them like this:
4606 print blinkin {color=>'blue',rate=>'fast'},"Yahoo!";
4607 # <blinkin COLOR="blue" RATE="fast">Yahoo!</blinkin>
4609 =head1 IMPORTING CGI METHOD CALLS INTO YOUR NAME SPACE
4611 As a convenience, you can import most of the CGI method calls directly
4612 into your name space. The syntax for doing this is:
4614 use CGI <list of methods>;
4616 The listed methods will be imported into the current package; you can
4617 call them directly without creating a CGI object first. This example
4618 shows how to import the B<param()> and B<header()>
4619 methods, and then use them directly:
4621 use CGI param,header;
4622 print header('text/plain');
4623 $zipcode = param('zipcode');
4625 You can import groups of methods by referring to a number of special
4632 Import all CGI-handling methods, such as B<param()>, B<path_info()>
4637 Import all fill-out form generating methods, such as B<textfield()>.
4641 Import all methods that generate HTML 2.0 standard elements.
4645 Import all methods that generate HTML 3.0 proposed elements (such as
4646 <table>, <super> and <sub>).
4650 Import all methods that generate Netscape-specific HTML extensions.
4654 Import all HTML-generating shortcuts (i.e. 'html2' + 'html3' +
4659 Import "standard" features, 'html2', 'form' and 'cgi'.
4663 Import all the available methods. For the full list, see the CGI.pm
4664 code, where the variable %TAGS is defined.
4668 Note that in the interests of execution speed CGI.pm does B<not> use
4669 the standard L<Exporter> syntax for specifying load symbols. This may
4670 change in the future.
4672 If you import any of the state-maintaining CGI or form-generating
4673 methods, a default CGI object will be created and initialized
4674 automatically the first time you use any of the methods that require
4675 one to be present. This includes B<param()>, B<textfield()>,
4676 B<submit()> and the like. (If you need direct access to the CGI
4677 object, you can find it in the global variable B<$CGI::Q>). By
4678 importing CGI.pm methods, you can create visually elegant scripts:
4680 use CGI standard,html2;
4683 start_html('Simple Script'),
4684 h1('Simple Script'),
4686 "What's your name? ",textfield('name'),p,
4687 "What's the combination?",
4688 checkbox_group(-name=>'words',
4689 -values=>['eenie','meenie','minie','moe'],
4690 -defaults=>['eenie','moe']),p,
4691 "What's your favorite color?",
4692 popup_menu(-name=>'color',
4693 -values=>['red','green','blue','chartreuse']),p,
4700 "Your name is ",em(param('name')),p,
4701 "The keywords are: ",em(join(", ",param('words'))),p,
4702 "Your favorite color is ",em(param('color')),".\n";
4706 =head1 USING NPH SCRIPTS
4708 NPH, or "no-parsed-header", scripts bypass the server completely by
4709 sending the complete HTTP header directly to the browser. This has
4710 slight performance benefits, but is of most use for taking advantage
4711 of HTTP extensions that are not directly supported by your server,
4712 such as server push and PICS headers.
4714 Servers use a variety of conventions for designating CGI scripts as
4715 NPH. Many Unix servers look at the beginning of the script's name for
4716 the prefix "nph-". The Macintosh WebSTAR server and Microsoft's
4717 Internet Information Server, in contrast, try to decide whether a
4718 program is an NPH script by examining the first line of script output.
4721 CGI.pm supports NPH scripts with a special NPH mode. When in this
4722 mode, CGI.pm will output the necessary extra header information when
4723 the header() and redirect() methods are
4726 The Microsoft Internet Information Server requires NPH mode. As of version
4727 2.30, CGI.pm will automatically detect when the script is running under IIS
4728 and put itself into this mode. You do not need to do this manually, although
4729 it won't hurt anything if you do.
4731 There are a number of ways to put CGI.pm into NPH mode:
4735 =item In the B<use> statement
4736 Simply add ":nph" to the list of symbols to be imported into your script:
4738 use CGI qw(:standard :nph)
4740 =item By calling the B<nph()> method:
4742 Call B<nph()> with a non-zero parameter at any point after using CGI.pm in your program.
4746 =item By using B<-nph> parameters in the B<header()> and B<redirect()> statements:
4748 print $q->header(-nph=>1);
4752 =head1 AUTHOR INFORMATION
4754 Copyright 1995,1996, Lincoln D. Stein. All rights reserved. It may
4755 be used and modified freely, but I do request that this copyright
4756 notice remain attached to the file. You may modify this module as you
4757 wish, but if you redistribute a modified version, please attach a note
4758 listing the modifications you have made.
4760 Address bug reports and comments to:
4761 lstein@genome.wi.mit.edu
4765 Thanks very much to:
4769 =item Matt Heffron (heffron@falstaff.css.beckman.com)
4771 =item James Taylor (james.taylor@srs.gov)
4773 =item Scott Anguish <sanguish@digifix.com>
4775 =item Mike Jewell (mlj3u@virginia.edu)
4777 =item Timothy Shimmin (tes@kbs.citri.edu.au)
4779 =item Joergen Haegg (jh@axis.se)
4781 =item Laurent Delfosse (delfosse@csgrad1.cs.wvu.edu)
4783 =item Richard Resnick (applepi1@aol.com)
4785 =item Craig Bishop (csb@barwonwater.vic.gov.au)
4787 =item Tony Curtis (tc@vcpc.univie.ac.at)
4789 =item Tim Bunce (Tim.Bunce@ig.co.uk)
4791 =item Tom Christiansen (tchrist@convex.com)
4793 =item Andreas Koenig (k@franz.ww.TU-Berlin.DE)
4795 =item Tim MacKenzie (Tim.MacKenzie@fulcrum.com.au)
4797 =item Kevin B. Hendricks (kbhend@dogwood.tyler.wm.edu)
4799 =item Stephen Dahmen (joyfire@inxpress.net)
4801 =item Ed Jordan (ed@fidalgo.net)
4803 =item David Alan Pisoni (david@cnation.com)
4805 =item ...and many many more...
4807 for suggestions and bug fixes.
4811 =head1 A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT
4814 #!/usr/local/bin/perl
4820 print $query->header;
4821 print $query->start_html("Example CGI.pm Form");
4822 print "<H1> Example CGI.pm Form</H1>\n";
4823 &print_prompt($query);
4826 print $query->end_html;
4831 print $query->startform;
4832 print "<EM>What's your name?</EM><BR>";
4833 print $query->textfield('name');
4834 print $query->checkbox('Not my real name');
4836 print "<P><EM>Where can you find English Sparrows?</EM><BR>";
4837 print $query->checkbox_group(
4838 -name=>'Sparrow locations',
4839 -values=>[England,France,Spain,Asia,Hoboken],
4841 -defaults=>[England,Asia]);
4843 print "<P><EM>How far can they fly?</EM><BR>",
4844 $query->radio_group(
4846 -values=>['10 ft','1 mile','10 miles','real far'],
4847 -default=>'1 mile');
4849 print "<P><EM>What's your favorite color?</EM> ";
4850 print $query->popup_menu(-name=>'Color',
4851 -values=>['black','brown','red','yellow'],
4854 print $query->hidden('Reference','Monty Python and the Holy Grail');
4856 print "<P><EM>What have you got there?</EM><BR>";
4857 print $query->scrolling_list(
4858 -name=>'possessions',
4859 -values=>['A Coconut','A Grail','An Icon',
4860 'A Sword','A Ticket'],
4864 print "<P><EM>Any parting comments?</EM><BR>";
4865 print $query->textarea(-name=>'Comments',
4869 print "<P>",$query->reset;
4870 print $query->submit('Action','Shout');
4871 print $query->submit('Action','Scream');
4872 print $query->endform;
4880 print "<H2>Here are the current settings in this form</H2>";
4882 foreach $key ($query->param) {
4883 print "<STRONG>$key</STRONG> -> ";
4884 @values = $query->param($key);
4885 print join(", ",@values),"<BR>\n";
4892 <ADDRESS>Lincoln D. Stein</ADDRESS><BR>
4893 <A HREF="/">Home Page</A>
4899 This module has grown large and monolithic. Furthermore it's doing many
4900 things, such as handling URLs, parsing CGI input, writing HTML, etc., that
4901 are also done in the LWP modules. It should be discarded in favor of
4902 the CGI::* modules, but somehow I continue to work on it.
4904 Note that the code is truly contorted in order to avoid spurious
4905 warnings when programs are run with the B<-w> switch.
4909 L<CGI::Carp>, L<URI::URL>, L<CGI::Request>, L<CGI::MiniSvr>,
4910 L<CGI::Base>, L<CGI::Form>, L<CGI::Apache>, L<CGI::Switch>,
4911 L<CGI::Push>, L<CGI::Fast>