Commit | Line | Data |
---|---|---|
54310121 | 1 | package CGI; |
424ec8fa | 2 | require 5.004; |
ba056755 | 3 | use Carp 'croak'; |
54310121 | 4 | |
5 | # See the bottom of this file for the POD documentation. Search for the | |
6 | # string '=head'. | |
7 | ||
8 | # You can run this file through either pod2man or pod2html to produce pretty | |
9 | # documentation in manual or html file format (these utilities are part of the | |
10 | # Perl 5 distribution). | |
11 | ||
424ec8fa | 12 | # Copyright 1995-1998 Lincoln D. Stein. All rights reserved. |
54310121 | 13 | # It may be used and modified freely, but I do request that this copyright |
14 | # notice remain attached to the file. You may modify this module as you | |
15 | # wish, but if you redistribute a modified version, please attach a note | |
16 | # listing the modifications you have made. | |
17 | ||
18 | # The most recent version and complete docs are available at: | |
71f3e297 | 19 | # http://stein.cshl.org/WWW/software/CGI/ |
54310121 | 20 | |
86de2d7d SP |
21 | $CGI::revision = '$Id: CGI.pm,v 1.249 2008/03/25 15:17:55 lstein Exp $'; |
22 | $CGI::VERSION='3.35'; | |
54310121 | 23 | |
24 | # HARD-CODED LOCATION FOR FILE UPLOAD TEMPORARY FILES. | |
25 | # UNCOMMENT THIS ONLY IF YOU KNOW WHAT YOU'RE DOING. | |
ac734d8b | 26 | # $CGITempFile::TMPDIRECTORY = '/usr/tmp'; |
2ed511ec | 27 | use CGI::Util qw(rearrange make_attributes unescape escape expires ebcdic2ascii ascii2ebcdic); |
54310121 | 28 | |
3acbd4f5 JH |
29 | #use constant XHTML_DTD => ['-//W3C//DTD XHTML Basic 1.0//EN', |
30 | # 'http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd']; | |
31 | ||
32 | use constant XHTML_DTD => ['-//W3C//DTD XHTML 1.0 Transitional//EN', | |
33 | 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd']; | |
6b4ac661 | 34 | |
8f3ccfa2 JH |
35 | { |
36 | local $^W = 0; | |
37 | $TAINTED = substr("$0$^X",0,0); | |
38 | } | |
188ba755 | 39 | |
8f3ccfa2 | 40 | $MOD_PERL = 0; # no mod_perl by default |
13548fdf | 41 | @SAVED_SYMBOLS = (); |
8f3ccfa2 | 42 | |
adb86593 | 43 | |
424ec8fa GS |
44 | # >>>>> Here are some globals that you might want to adjust <<<<<< |
45 | sub initialize_globals { | |
46 | # Set this to 1 to enable copious autoloader debugging messages | |
47 | $AUTOLOAD_DEBUG = 0; | |
2371fea9 | 48 | |
6b4ac661 JH |
49 | # Set this to 1 to generate XTML-compatible output |
50 | $XHTML = 1; | |
424ec8fa GS |
51 | |
52 | # Change this to the preferred DTD to print in start_html() | |
53 | # or use default_dtd('text of DTD to use'); | |
3d1a2ec4 GS |
54 | $DEFAULT_DTD = [ '-//W3C//DTD HTML 4.01 Transitional//EN', |
55 | 'http://www.w3.org/TR/html4/loose.dtd' ] ; | |
56 | ||
57 | # Set this to 1 to enable NOSTICKY scripts | |
58 | # or: | |
59 | # 1) use CGI qw(-nosticky) | |
60 | # 2) $CGI::nosticky(1) | |
61 | $NOSTICKY = 0; | |
424ec8fa GS |
62 | |
63 | # Set this to 1 to enable NPH scripts | |
64 | # or: | |
65 | # 1) use CGI qw(-nph) | |
3d1a2ec4 | 66 | # 2) CGI::nph(1) |
424ec8fa GS |
67 | # 3) print header(-nph=>1) |
68 | $NPH = 0; | |
69 | ||
3d1a2ec4 GS |
70 | # Set this to 1 to enable debugging from @ARGV |
71 | # Set to 2 to enable debugging from STDIN | |
72 | $DEBUG = 1; | |
424ec8fa GS |
73 | |
74 | # Set this to 1 to make the temporary files created | |
75 | # during file uploads safe from prying eyes | |
76 | # or do... | |
77 | # 1) use CGI qw(:private_tempfiles) | |
3d1a2ec4 | 78 | # 2) CGI::private_tempfiles(1); |
424ec8fa GS |
79 | $PRIVATE_TEMPFILES = 0; |
80 | ||
0a9bdad4 SP |
81 | # Set this to 1 to generate automatic tab indexes |
82 | $TABINDEX = 0; | |
83 | ||
8f3ccfa2 JH |
84 | # Set this to 1 to cause files uploaded in multipart documents |
85 | # to be closed, instead of caching the file handle | |
86 | # or: | |
87 | # 1) use CGI qw(:close_upload_files) | |
88 | # 2) $CGI::close_upload_files(1); | |
89 | # Uploads with many files run out of file handles. | |
90 | # Also, for performance, since the file is already on disk, | |
91 | # it can just be renamed, instead of read and written. | |
92 | $CLOSE_UPLOAD_FILES = 0; | |
93 | ||
424ec8fa GS |
94 | # Set this to a positive value to limit the size of a POSTing |
95 | # to a certain number of bytes: | |
96 | $POST_MAX = -1; | |
97 | ||
98 | # Change this to 1 to disable uploads entirely: | |
99 | $DISABLE_UPLOADS = 0; | |
100 | ||
3538e1d5 GS |
101 | # Automatically determined -- don't change |
102 | $EBCDIC = 0; | |
103 | ||
71f3e297 JH |
104 | # Change this to 1 to suppress redundant HTTP headers |
105 | $HEADERS_ONCE = 0; | |
106 | ||
107 | # separate the name=value pairs by semicolons rather than ampersands | |
3d1a2ec4 | 108 | $USE_PARAM_SEMICOLONS = 1; |
71f3e297 | 109 | |
2371fea9 JH |
110 | # Do not include undefined params parsed from query string |
111 | # use CGI qw(-no_undef_params); | |
112 | $NO_UNDEF_PARAMS = 0; | |
199d4a26 | 113 | |
bb8b3399 SP |
114 | # return everything as utf-8 |
115 | $PARAM_UTF8 = 0; | |
116 | ||
424ec8fa GS |
117 | # Other globals that you shouldn't worry about. |
118 | undef $Q; | |
119 | $BEEN_THERE = 0; | |
13548fdf | 120 | $DTD_PUBLIC_IDENTIFIER = ""; |
424ec8fa GS |
121 | undef @QUERY_PARAM; |
122 | undef %EXPORT; | |
d45d855d JH |
123 | undef $QUERY_CHARSET; |
124 | undef %QUERY_FIELDNAMES; | |
681699b9 | 125 | undef %QUERY_TMPFILES; |
424ec8fa GS |
126 | |
127 | # prevent complaints by mod_perl | |
128 | 1; | |
129 | } | |
130 | ||
54310121 | 131 | # ------------------ START OF THE LIBRARY ------------ |
132 | ||
13548fdf RGS |
133 | *end_form = \&endform; |
134 | ||
424ec8fa GS |
135 | # make mod_perlhappy |
136 | initialize_globals(); | |
137 | ||
54310121 | 138 | # FIGURE OUT THE OS WE'RE RUNNING UNDER |
139 | # Some systems support the $^O variable. If not | |
140 | # available then require() the Config library | |
141 | unless ($OS) { | |
142 | unless ($OS = $^O) { | |
143 | require Config; | |
144 | $OS = $Config::Config{'osname'}; | |
145 | } | |
146 | } | |
ac1855b3 | 147 | if ($OS =~ /^MSWin/i) { |
3538e1d5 | 148 | $OS = 'WINDOWS'; |
ac1855b3 | 149 | } elsif ($OS =~ /^VMS/i) { |
3538e1d5 | 150 | $OS = 'VMS'; |
ac1855b3 | 151 | } elsif ($OS =~ /^dos/i) { |
3538e1d5 | 152 | $OS = 'DOS'; |
ac1855b3 | 153 | } elsif ($OS =~ /^MacOS/i) { |
54310121 | 154 | $OS = 'MACINTOSH'; |
ac1855b3 | 155 | } elsif ($OS =~ /^os2/i) { |
54310121 | 156 | $OS = 'OS2'; |
ac1855b3 | 157 | } elsif ($OS =~ /^epoc/i) { |
fa6a1c44 | 158 | $OS = 'EPOC'; |
188ba755 JH |
159 | } elsif ($OS =~ /^cygwin/i) { |
160 | $OS = 'CYGWIN'; | |
54310121 | 161 | } else { |
162 | $OS = 'UNIX'; | |
163 | } | |
164 | ||
165 | # Some OS logic. Binary mode enabled on DOS, NT and VMS | |
188ba755 | 166 | $needs_binmode = $OS=~/^(WINDOWS|DOS|OS2|MSWin|CYGWIN)/; |
54310121 | 167 | |
168 | # This is the default class for the CGI object to use when all else fails. | |
169 | $DefaultClass = 'CGI' unless defined $CGI::DefaultClass; | |
424ec8fa | 170 | |
54310121 | 171 | # This is where to look for autoloaded routines. |
172 | $AutoloadClass = $DefaultClass unless defined $CGI::AutoloadClass; | |
173 | ||
174 | # The path separator is a slash, backslash or semicolon, depending | |
175 | # on the paltform. | |
176 | $SL = { | |
8f3ccfa2 JH |
177 | UNIX => '/', OS2 => '\\', EPOC => '/', CYGWIN => '/', |
178 | WINDOWS => '\\', DOS => '\\', MACINTOSH => ':', VMS => '/' | |
54310121 | 179 | }->{$OS}; |
180 | ||
424ec8fa | 181 | # This no longer seems to be necessary |
54310121 | 182 | # Turn on NPH scripts by default when running under IIS server! |
424ec8fa GS |
183 | # $NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/; |
184 | $IIS++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/; | |
54310121 | 185 | |
186 | # Turn on special checking for Doug MacEachern's modperl | |
8f3ccfa2 | 187 | if (exists $ENV{MOD_PERL}) { |
8f3ccfa2 JH |
188 | # mod_perl handlers may run system() on scripts using CGI.pm; |
189 | # Make sure so we don't get fooled by inherited $ENV{MOD_PERL} | |
70194bd6 | 190 | if (exists $ENV{MOD_PERL_API_VERSION} && $ENV{MOD_PERL_API_VERSION} == 2) { |
741ff09d RGS |
191 | $MOD_PERL = 2; |
192 | require Apache2::Response; | |
193 | require Apache2::RequestRec; | |
194 | require Apache2::RequestUtil; | |
70194bd6 | 195 | require Apache2::RequestIO; |
741ff09d RGS |
196 | require APR::Pool; |
197 | } else { | |
198 | $MOD_PERL = 1; | |
199 | require Apache; | |
188ba755 | 200 | } |
8f3ccfa2 | 201 | } |
188ba755 | 202 | |
424ec8fa GS |
203 | # Turn on special checking for ActiveState's PerlEx |
204 | $PERLEX++ if defined($ENV{'GATEWAY_INTERFACE'}) && $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-PerlEx/; | |
205 | ||
206 | # Define the CRLF sequence. I can't use a simple "\r\n" because the meaning | |
207 | # of "\n" is different on different OS's (sometimes it generates CRLF, sometimes LF | |
208 | # and sometimes CR). The most popular VMS web server | |
209 | # doesn't accept CRLF -- instead it wants a LR. EBCDIC machines don't | |
210 | # use ASCII, so \015\012 means something different. I find this all | |
211 | # really annoying. | |
212 | $EBCDIC = "\t" ne "\011"; | |
213 | if ($OS eq 'VMS') { | |
3538e1d5 | 214 | $CRLF = "\n"; |
424ec8fa | 215 | } elsif ($EBCDIC) { |
3538e1d5 | 216 | $CRLF= "\r\n"; |
424ec8fa | 217 | } else { |
3538e1d5 GS |
218 | $CRLF = "\015\012"; |
219 | } | |
220 | ||
54310121 | 221 | if ($needs_binmode) { |
2ed511ec RGS |
222 | $CGI::DefaultClass->binmode(\*main::STDOUT); |
223 | $CGI::DefaultClass->binmode(\*main::STDIN); | |
224 | $CGI::DefaultClass->binmode(\*main::STDERR); | |
54310121 | 225 | } |
226 | ||
54310121 | 227 | %EXPORT_TAGS = ( |
424ec8fa GS |
228 | ':html2'=>['h1'..'h6',qw/p br hr ol ul li dl dt dd menu code var strong em |
229 | tt u i b blockquote pre img a address cite samp dfn html head | |
230 | base body Link nextid title meta kbd start_html end_html | |
3d1a2ec4 | 231 | input Select option comment charset escapeHTML/], |
71f3e297 | 232 | ':html3'=>[qw/div table caption th td TR Tr sup Sub strike applet Param |
1c87da1d | 233 | embed basefont style span layer ilayer font frameset frame script small big Area Map/], |
3acbd4f5 JH |
234 | ':html4'=>[qw/abbr acronym bdo col colgroup del fieldset iframe |
235 | ins label legend noframes noscript object optgroup Q | |
236 | thead tbody tfoot/], | |
424ec8fa GS |
237 | ':netscape'=>[qw/blink fontsize center/], |
238 | ':form'=>[qw/textfield textarea filefield password_field hidden checkbox checkbox_group | |
239 | submit reset defaults radio_group popup_menu button autoEscape | |
240 | scrolling_list image_button start_form end_form startform endform | |
71f3e297 | 241 | start_multipart_form end_multipart_form isindex tmpFileName uploadInfo URL_ENCODED MULTIPART/], |
7dc108d1 SP |
242 | ':cgi'=>[qw/param upload path_info path_translated request_uri url self_url script_name |
243 | cookie Dump | |
3538e1d5 | 244 | raw_cookie request_method query_string Accept user_agent remote_host content_type |
2ed511ec RGS |
245 | remote_addr referer server_name server_software server_port server_protocol virtual_port |
246 | virtual_host remote_ident auth_type http append | |
424ec8fa | 247 | save_parameters restore_parameters param_fetch |
3538e1d5 GS |
248 | remote_user user_name header redirect import_names put |
249 | Delete Delete_all url_param cgi_error/], | |
424ec8fa | 250 | ':ssl' => [qw/https/], |
3538e1d5 | 251 | ':cgi-lib' => [qw/ReadParse PrintHeader HtmlTop HtmlBot SplitParam Vars/], |
3acbd4f5 JH |
252 | ':html' => [qw/:html2 :html3 :html4 :netscape/], |
253 | ':standard' => [qw/:html2 :html3 :html4 :form :cgi/], | |
ba056755 | 254 | ':push' => [qw/multipart_init multipart_start multipart_end multipart_final/], |
3acbd4f5 | 255 | ':all' => [qw/:html2 :html3 :netscape :form :cgi :internal :html4/] |
424ec8fa | 256 | ); |
54310121 | 257 | |
29ddc2a4 RGS |
258 | # Custom 'can' method for both autoloaded and non-autoloaded subroutines. |
259 | # Author: Cees Hek <cees@sitesuite.com.au> | |
260 | ||
261 | sub can { | |
262 | my($class, $method) = @_; | |
263 | ||
264 | # See if UNIVERSAL::can finds it. | |
265 | ||
266 | if (my $func = $class -> SUPER::can($method) ){ | |
267 | return $func; | |
268 | } | |
269 | ||
270 | # Try to compile the function. | |
271 | ||
272 | eval { | |
273 | # _compile looks at $AUTOLOAD for the function name. | |
274 | ||
275 | local $AUTOLOAD = join "::", $class, $method; | |
276 | &_compile; | |
277 | }; | |
278 | ||
279 | # Now that the function is loaded (if it exists) | |
280 | # just use UNIVERSAL::can again to do the work. | |
281 | ||
282 | return $class -> SUPER::can($method); | |
283 | } | |
284 | ||
54310121 | 285 | # to import symbols into caller |
286 | sub import { | |
287 | my $self = shift; | |
424ec8fa | 288 | |
188ba755 | 289 | # This causes modules to clash. |
b2d0d414 JH |
290 | undef %EXPORT_OK; |
291 | undef %EXPORT; | |
424ec8fa GS |
292 | |
293 | $self->_setup_symbols(@_); | |
54310121 | 294 | my ($callpack, $callfile, $callline) = caller; |
424ec8fa | 295 | |
54310121 | 296 | # To allow overriding, search through the packages |
297 | # Till we find one in which the correct subroutine is defined. | |
298 | my @packages = ($self,@{"$self\:\:ISA"}); | |
299 | foreach $sym (keys %EXPORT) { | |
300 | my $pck; | |
301 | my $def = ${"$self\:\:AutoloadClass"} || $DefaultClass; | |
302 | foreach $pck (@packages) { | |
303 | if (defined(&{"$pck\:\:$sym"})) { | |
304 | $def = $pck; | |
305 | last; | |
306 | } | |
307 | } | |
308 | *{"${callpack}::$sym"} = \&{"$def\:\:$sym"}; | |
309 | } | |
310 | } | |
311 | ||
424ec8fa GS |
312 | sub compile { |
313 | my $pack = shift; | |
314 | $pack->_setup_symbols('-compile',@_); | |
315 | } | |
316 | ||
54310121 | 317 | sub expand_tags { |
318 | my($tag) = @_; | |
71f3e297 | 319 | return ("start_$1","end_$1") if $tag=~/^(?:\*|start_|end_)(.+)/; |
54310121 | 320 | my(@r); |
321 | return ($tag) unless $EXPORT_TAGS{$tag}; | |
322 | foreach (@{$EXPORT_TAGS{$tag}}) { | |
323 | push(@r,&expand_tags($_)); | |
324 | } | |
325 | return @r; | |
326 | } | |
327 | ||
328 | #### Method: new | |
329 | # The new routine. This will check the current environment | |
330 | # for an existing query string, and initialize itself, if so. | |
331 | #### | |
332 | sub new { | |
8f3ccfa2 JH |
333 | my($class,@initializer) = @_; |
334 | my $self = {}; | |
2ed511ec | 335 | |
8f3ccfa2 | 336 | bless $self,ref $class || $class || $DefaultClass; |
cb3b230c SP |
337 | |
338 | # always use a tempfile | |
339 | $self->{'use_tempfile'} = 1; | |
340 | ||
8f3ccfa2 JH |
341 | if (ref($initializer[0]) |
342 | && (UNIVERSAL::isa($initializer[0],'Apache') | |
343 | || | |
741ff09d | 344 | UNIVERSAL::isa($initializer[0],'Apache2::RequestRec') |
8f3ccfa2 JH |
345 | )) { |
346 | $self->r(shift @initializer); | |
347 | } | |
efc8e943 NC |
348 | if (ref($initializer[0]) |
349 | && (UNIVERSAL::isa($initializer[0],'CODE'))) { | |
350 | $self->upload_hook(shift @initializer, shift @initializer); | |
cb3b230c | 351 | $self->{'use_tempfile'} = shift @initializer if (@initializer > 0); |
efc8e943 | 352 | } |
8f3ccfa2 | 353 | if ($MOD_PERL) { |
8f3ccfa2 | 354 | if ($MOD_PERL == 1) { |
741ff09d RGS |
355 | $self->r(Apache->request) unless $self->r; |
356 | my $r = $self->r; | |
8f3ccfa2 JH |
357 | $r->register_cleanup(\&CGI::_reset_globals); |
358 | } | |
359 | else { | |
360 | # XXX: once we have the new API | |
361 | # will do a real PerlOptions -SetupEnv check | |
741ff09d RGS |
362 | $self->r(Apache2::RequestUtil->request) unless $self->r; |
363 | my $r = $self->r; | |
8f3ccfa2 JH |
364 | $r->subprocess_env unless exists $ENV{REQUEST_METHOD}; |
365 | $r->pool->cleanup_register(\&CGI::_reset_globals); | |
424ec8fa | 366 | } |
8f3ccfa2 JH |
367 | undef $NPH; |
368 | } | |
369 | $self->_reset_globals if $PERLEX; | |
370 | $self->init(@initializer); | |
371 | return $self; | |
54310121 | 372 | } |
373 | ||
2ed511ec RGS |
374 | # We provide a DESTROY method so that we can ensure that |
375 | # temporary files are closed (via Fh->DESTROY) before they | |
376 | # are unlinked (via CGITempFile->DESTROY) because it is not | |
377 | # possible to unlink an open file on Win32. We explicitly | |
378 | # call DESTROY on each, rather than just undefing them and | |
379 | # letting Perl DESTROY them by garbage collection, in case the | |
380 | # user is still holding any reference to them as well. | |
381 | sub DESTROY { | |
382 | my $self = shift; | |
0a9bdad4 SP |
383 | if ($OS eq 'WINDOWS') { |
384 | foreach my $href (values %{$self->{'.tmpfiles'}}) { | |
385 | $href->{hndl}->DESTROY if defined $href->{hndl}; | |
386 | $href->{name}->DESTROY if defined $href->{name}; | |
387 | } | |
2ed511ec RGS |
388 | } |
389 | } | |
54310121 | 390 | |
8f3ccfa2 JH |
391 | sub r { |
392 | my $self = shift; | |
393 | my $r = $self->{'.r'}; | |
394 | $self->{'.r'} = shift if @_; | |
395 | $r; | |
396 | } | |
397 | ||
2ed511ec | 398 | sub upload_hook { |
0a9bdad4 SP |
399 | my $self; |
400 | if (ref $_[0] eq 'CODE') { | |
401 | $CGI::Q = $self = $CGI::DefaultClass->new(@_); | |
402 | } else { | |
403 | $self = shift; | |
404 | } | |
cb3b230c | 405 | my ($hook,$data,$use_tempfile) = @_; |
2ed511ec RGS |
406 | $self->{'.upload_hook'} = $hook; |
407 | $self->{'.upload_data'} = $data; | |
cb3b230c | 408 | $self->{'use_tempfile'} = $use_tempfile if defined $use_tempfile; |
2ed511ec RGS |
409 | } |
410 | ||
54310121 | 411 | #### Method: param |
412 | # Returns the value(s)of a named parameter. | |
413 | # If invoked in a list context, returns the | |
414 | # entire list. Otherwise returns the first | |
415 | # member of the list. | |
416 | # If name is not provided, return a list of all | |
417 | # the known parameters names available. | |
418 | # If more than one argument is provided, the | |
419 | # second and subsequent arguments are used to | |
420 | # set the value of the parameter. | |
421 | #### | |
422 | sub param { | |
423 | my($self,@p) = self_or_default(@_); | |
424 | return $self->all_parameters unless @p; | |
425 | my($name,$value,@other); | |
426 | ||
427 | # For compatibility between old calling style and use_named_parameters() style, | |
428 | # we have to special case for a single parameter present. | |
429 | if (@p > 1) { | |
3d1a2ec4 | 430 | ($name,$value,@other) = rearrange([NAME,[DEFAULT,VALUE,VALUES]],@p); |
54310121 | 431 | my(@values); |
432 | ||
3d1a2ec4 | 433 | if (substr($p[0],0,1) eq '-') { |
54310121 | 434 | @values = defined($value) ? (ref($value) && ref($value) eq 'ARRAY' ? @{$value} : $value) : (); |
435 | } else { | |
436 | foreach ($value,@other) { | |
437 | push(@values,$_) if defined($_); | |
438 | } | |
439 | } | |
440 | # If values is provided, then we set it. | |
fc786e8b | 441 | if (@values or defined $value) { |
54310121 | 442 | $self->add_parameter($name); |
443 | $self->{$name}=[@values]; | |
444 | } | |
445 | } else { | |
446 | $name = $p[0]; | |
447 | } | |
448 | ||
71f3e297 | 449 | return unless defined($name) && $self->{$name}; |
fc786e8b | 450 | |
bb8b3399 SP |
451 | my @result = @{$self->{$name}}; |
452 | ||
453 | if ($PARAM_UTF8) { | |
454 | eval "require Encode; 1;" unless Encode->can('decode'); # bring in these functions | |
455 | @result = map {ref $_ ? $_ : Encode::decode(utf8=>$_) } @result; | |
fc786e8b | 456 | } |
bb8b3399 SP |
457 | |
458 | return wantarray ? @result : $result[0]; | |
54310121 | 459 | } |
460 | ||
54310121 | 461 | sub self_or_default { |
424ec8fa | 462 | return @_ if defined($_[0]) && (!ref($_[0])) &&($_[0] eq 'CGI'); |
54310121 | 463 | unless (defined($_[0]) && |
424ec8fa GS |
464 | (ref($_[0]) eq 'CGI' || UNIVERSAL::isa($_[0],'CGI')) # slightly optimized for common case |
465 | ) { | |
54310121 | 466 | $Q = $CGI::DefaultClass->new unless defined($Q); |
467 | unshift(@_,$Q); | |
468 | } | |
3d1a2ec4 | 469 | return wantarray ? @_ : $Q; |
54310121 | 470 | } |
471 | ||
54310121 | 472 | sub self_or_CGI { |
473 | local $^W=0; # prevent a warning | |
474 | if (defined($_[0]) && | |
475 | (substr(ref($_[0]),0,3) eq 'CGI' | |
424ec8fa | 476 | || UNIVERSAL::isa($_[0],'CGI'))) { |
54310121 | 477 | return @_; |
478 | } else { | |
479 | return ($DefaultClass,@_); | |
480 | } | |
481 | } | |
482 | ||
54310121 | 483 | ######################################## |
484 | # THESE METHODS ARE MORE OR LESS PRIVATE | |
485 | # GO TO THE __DATA__ SECTION TO SEE MORE | |
486 | # PUBLIC METHODS | |
487 | ######################################## | |
488 | ||
489 | # Initialize the query object from the environment. | |
490 | # If a parameter list is found, this object will be set | |
491 | # to an associative array in which parameter names are keys | |
492 | # and the values are stored as lists | |
493 | # If a keyword list is found, this method creates a bogus | |
494 | # parameter list with the single parameter 'keywords'. | |
495 | ||
496 | sub init { | |
8f3ccfa2 JH |
497 | my $self = shift; |
498 | my($query_string,$meth,$content_length,$fh,@lines) = ('','','',''); | |
499 | ||
8869a4b7 SP |
500 | my $is_xforms; |
501 | ||
8f3ccfa2 JH |
502 | my $initializer = shift; # for backward compatibility |
503 | local($/) = "\n"; | |
504 | ||
505 | # set autoescaping on by default | |
506 | $self->{'escape'} = 1; | |
54310121 | 507 | |
508 | # if we get called more than once, we want to initialize | |
509 | # ourselves from the original query (which may be gone | |
510 | # if it was read from STDIN originally.) | |
d45d855d | 511 | if (defined(@QUERY_PARAM) && !defined($initializer)) { |
681699b9 SP |
512 | for my $name (@QUERY_PARAM) { |
513 | my $val = $QUERY_PARAM{$name}; # always an arrayref; | |
514 | $self->param('-name'=>$name,'-value'=> $val); | |
515 | if (defined $val and ref $val eq 'ARRAY') { | |
516 | for my $fh (grep {defined(fileno($_))} @$val) { | |
517 | seek($fh,0,0); # reset the filehandle. | |
518 | } | |
519 | ||
520 | } | |
521 | } | |
522 | $self->charset($QUERY_CHARSET); | |
523 | $self->{'.fieldnames'} = {%QUERY_FIELDNAMES}; | |
524 | $self->{'.tmpfiles'} = {%QUERY_TMPFILES}; | |
525 | return; | |
54310121 | 526 | } |
527 | ||
528 | $meth=$ENV{'REQUEST_METHOD'} if defined($ENV{'REQUEST_METHOD'}); | |
424ec8fa | 529 | $content_length = defined($ENV{'CONTENT_LENGTH'}) ? $ENV{'CONTENT_LENGTH'} : 0; |
3538e1d5 | 530 | |
424ec8fa | 531 | $fh = to_filehandle($initializer) if $initializer; |
54310121 | 532 | |
a3b3a725 JH |
533 | # set charset to the safe ISO-8859-1 |
534 | $self->charset('ISO-8859-1'); | |
535 | ||
54310121 | 536 | METHOD: { |
54310121 | 537 | |
3538e1d5 GS |
538 | # avoid unreasonably large postings |
539 | if (($POST_MAX > 0) && ($content_length > $POST_MAX)) { | |
fc786e8b SP |
540 | #discard the post, unread |
541 | $self->cgi_error("413 Request entity too large"); | |
542 | last METHOD; | |
543 | } | |
3538e1d5 | 544 | |
424ec8fa GS |
545 | # Process multipart postings, but only if the initializer is |
546 | # not defined. | |
547 | if ($meth eq 'POST' | |
548 | && defined($ENV{'CONTENT_TYPE'}) | |
549 | && $ENV{'CONTENT_TYPE'}=~m|^multipart/form-data| | |
550 | && !defined($initializer) | |
551 | ) { | |
71f3e297 | 552 | my($boundary) = $ENV{'CONTENT_TYPE'} =~ /boundary=\"?([^\";,]+)\"?/; |
424ec8fa GS |
553 | $self->read_multipart($boundary,$content_length); |
554 | last METHOD; | |
555 | } | |
556 | ||
8869a4b7 SP |
557 | # Process XForms postings. We know that we have XForms in the |
558 | # following cases: | |
559 | # method eq 'POST' && content-type eq 'application/xml' | |
560 | # method eq 'POST' && content-type =~ /multipart\/related.+start=/ | |
561 | # There are more cases, actually, but for now, we don't support other | |
562 | # methods for XForm posts. | |
563 | # In a XForm POST, the QUERY_STRING is parsed normally. | |
564 | # If the content-type is 'application/xml', we just set the param | |
565 | # XForms:Model (referring to the xml syntax) param containing the | |
566 | # unparsed XML data. | |
567 | # In the case of multipart/related we set XForms:Model as above, but | |
568 | # the other parts are available as uploads with the Content-ID as the | |
569 | # the key. | |
570 | # See the URL below for XForms specs on this issue. | |
571 | # http://www.w3.org/TR/2006/REC-xforms-20060314/slice11.html#submit-options | |
572 | if ($meth eq 'POST' && defined($ENV{'CONTENT_TYPE'})) { | |
573 | if ($ENV{'CONTENT_TYPE'} eq 'application/xml') { | |
574 | my($param) = 'XForms:Model'; | |
575 | my($value) = ''; | |
576 | $self->add_parameter($param); | |
577 | $self->read_from_client(\$value,$content_length,0) | |
578 | if $content_length > 0; | |
579 | push (@{$self->{$param}},$value); | |
580 | $is_xforms = 1; | |
581 | } elsif ($ENV{'CONTENT_TYPE'} =~ /multipart\/related.+boundary=\"?([^\";,]+)\"?.+start=\"?\<?([^\"\>]+)\>?\"?/) { | |
582 | my($boundary,$start) = ($1,$2); | |
583 | my($param) = 'XForms:Model'; | |
584 | $self->add_parameter($param); | |
585 | my($value) = $self->read_multipart_related($start,$boundary,$content_length,0); | |
586 | push (@{$self->{$param}},$value); | |
587 | if ($MOD_PERL) { | |
588 | $query_string = $self->r->args; | |
589 | } else { | |
590 | $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'}; | |
591 | $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'}; | |
592 | } | |
593 | $is_xforms = 1; | |
594 | } | |
595 | } | |
596 | ||
597 | ||
424ec8fa GS |
598 | # If initializer is defined, then read parameters |
599 | # from it. | |
8869a4b7 | 600 | if (!$is_xforms && defined($initializer)) { |
424ec8fa GS |
601 | if (UNIVERSAL::isa($initializer,'CGI')) { |
602 | $query_string = $initializer->query_string; | |
603 | last METHOD; | |
604 | } | |
54310121 | 605 | if (ref($initializer) && ref($initializer) eq 'HASH') { |
606 | foreach (keys %$initializer) { | |
607 | $self->param('-name'=>$_,'-value'=>$initializer->{$_}); | |
608 | } | |
609 | last METHOD; | |
610 | } | |
424ec8fa | 611 | |
2ed511ec RGS |
612 | if (defined($fh) && ($fh ne '')) { |
613 | while (<$fh>) { | |
614 | chomp; | |
615 | last if /^=/; | |
616 | push(@lines,$_); | |
617 | } | |
618 | # massage back into standard format | |
619 | if ("@lines" =~ /=/) { | |
620 | $query_string=join("&",@lines); | |
621 | } else { | |
622 | $query_string=join("+",@lines); | |
623 | } | |
624 | last METHOD; | |
625 | } | |
626 | ||
424ec8fa GS |
627 | # last chance -- treat it as a string |
628 | $initializer = $$initializer if ref($initializer) eq 'SCALAR'; | |
54310121 | 629 | $query_string = $initializer; |
424ec8fa | 630 | |
54310121 | 631 | last METHOD; |
632 | } | |
54310121 | 633 | |
424ec8fa GS |
634 | # If method is GET or HEAD, fetch the query from |
635 | # the environment. | |
8869a4b7 | 636 | if ($is_xforms || $meth=~/^(GET|HEAD)$/) { |
3538e1d5 | 637 | if ($MOD_PERL) { |
8f3ccfa2 | 638 | $query_string = $self->r->args; |
3538e1d5 GS |
639 | } else { |
640 | $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'}; | |
3d1a2ec4 | 641 | $query_string ||= $ENV{'REDIRECT_QUERY_STRING'} if defined $ENV{'REDIRECT_QUERY_STRING'}; |
3538e1d5 | 642 | } |
424ec8fa GS |
643 | last METHOD; |
644 | } | |
54310121 | 645 | |
bb8b3399 | 646 | if ($meth eq 'POST' || $meth eq 'PUT') { |
2ed511ec | 647 | $self->read_from_client(\$query_string,$content_length,0) |
424ec8fa | 648 | if $content_length > 0; |
54310121 | 649 | # Some people want to have their cake and eat it too! |
650 | # Uncomment this line to have the contents of the query string | |
651 | # APPENDED to the POST data. | |
424ec8fa | 652 | # $query_string .= (length($query_string) ? '&' : '') . $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'}; |
54310121 | 653 | last METHOD; |
654 | } | |
424ec8fa GS |
655 | |
656 | # If $meth is not of GET, POST or HEAD, assume we're being debugged offline. | |
54310121 | 657 | # Check the command line and then the standard input for data. |
658 | # We use the shellwords package in order to behave the way that | |
659 | # UN*X programmers expect. | |
2ed511ec RGS |
660 | if ($DEBUG) |
661 | { | |
662 | my $cmdline_ret = read_from_cmdline(); | |
663 | $query_string = $cmdline_ret->{'query_string'}; | |
664 | if (defined($cmdline_ret->{'subpath'})) | |
665 | { | |
666 | $self->path_info($cmdline_ret->{'subpath'}); | |
667 | } | |
668 | } | |
54310121 | 669 | } |
424ec8fa | 670 | |
8f3ccfa2 | 671 | # YL: Begin Change for XML handler 10/19/2001 |
bb8b3399 | 672 | if (!$is_xforms && ($meth eq 'POST' || $meth eq 'PUT') |
8f3ccfa2 | 673 | && defined($ENV{'CONTENT_TYPE'}) |
1c87da1d JH |
674 | && $ENV{'CONTENT_TYPE'} !~ m|^application/x-www-form-urlencoded| |
675 | && $ENV{'CONTENT_TYPE'} !~ m|^multipart/form-data| ) { | |
bb8b3399 | 676 | my($param) = $meth . 'DATA' ; |
8f3ccfa2 JH |
677 | $self->add_parameter($param) ; |
678 | push (@{$self->{$param}},$query_string); | |
679 | undef $query_string ; | |
680 | } | |
681 | # YL: End Change for XML handler 10/19/2001 | |
682 | ||
54310121 | 683 | # We now have the query string in hand. We do slightly |
684 | # different things for keyword lists and parameter lists. | |
ba056755 | 685 | if (defined $query_string && length $query_string) { |
3d1a2ec4 | 686 | if ($query_string =~ /[&=;]/) { |
54310121 | 687 | $self->parse_params($query_string); |
688 | } else { | |
689 | $self->add_parameter('keywords'); | |
690 | $self->{'keywords'} = [$self->parse_keywordlist($query_string)]; | |
691 | } | |
692 | } | |
693 | ||
694 | # Special case. Erase everything if there is a field named | |
695 | # .defaults. | |
696 | if ($self->param('.defaults')) { | |
e70cb7eb | 697 | $self->delete_all(); |
54310121 | 698 | } |
699 | ||
700 | # Associative array containing our defined fieldnames | |
701 | $self->{'.fieldnames'} = {}; | |
702 | foreach ($self->param('.cgifields')) { | |
703 | $self->{'.fieldnames'}->{$_}++; | |
704 | } | |
705 | ||
706 | # Clear out our default submission button flag if present | |
707 | $self->delete('.submit'); | |
708 | $self->delete('.cgifields'); | |
3d1a2ec4 | 709 | |
8f3ccfa2 | 710 | $self->save_request unless defined $initializer; |
54310121 | 711 | } |
712 | ||
54310121 | 713 | # FUNCTIONS TO OVERRIDE: |
54310121 | 714 | # Turn a string into a filehandle |
715 | sub to_filehandle { | |
424ec8fa GS |
716 | my $thingy = shift; |
717 | return undef unless $thingy; | |
718 | return $thingy if UNIVERSAL::isa($thingy,'GLOB'); | |
719 | return $thingy if UNIVERSAL::isa($thingy,'FileHandle'); | |
720 | if (!ref($thingy)) { | |
721 | my $caller = 1; | |
722 | while (my $package = caller($caller++)) { | |
723 | my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy"; | |
724 | return $tmp if defined(fileno($tmp)); | |
725 | } | |
54310121 | 726 | } |
424ec8fa | 727 | return undef; |
54310121 | 728 | } |
729 | ||
730 | # send output to the browser | |
731 | sub put { | |
732 | my($self,@p) = self_or_default(@_); | |
733 | $self->print(@p); | |
734 | } | |
735 | ||
736 | # print to standard output (for overriding in mod_perl) | |
737 | sub print { | |
738 | shift; | |
739 | CORE::print(@_); | |
740 | } | |
741 | ||
3538e1d5 GS |
742 | # get/set last cgi_error |
743 | sub cgi_error { | |
744 | my ($self,$err) = self_or_default(@_); | |
745 | $self->{'.cgi_error'} = $err if defined $err; | |
746 | return $self->{'.cgi_error'}; | |
747 | } | |
748 | ||
54310121 | 749 | sub save_request { |
750 | my($self) = @_; | |
751 | # We're going to play with the package globals now so that if we get called | |
752 | # again, we initialize ourselves in exactly the same way. This allows | |
753 | # us to have several of these objects. | |
754 | @QUERY_PARAM = $self->param; # save list of parameters | |
755 | foreach (@QUERY_PARAM) { | |
3d1a2ec4 GS |
756 | next unless defined $_; |
757 | $QUERY_PARAM{$_}=$self->{$_}; | |
54310121 | 758 | } |
d45d855d JH |
759 | $QUERY_CHARSET = $self->charset; |
760 | %QUERY_FIELDNAMES = %{$self->{'.fieldnames'}}; | |
681699b9 | 761 | %QUERY_TMPFILES = %{ $self->{'.tmpfiles'} || {} }; |
54310121 | 762 | } |
763 | ||
54310121 | 764 | sub parse_params { |
765 | my($self,$tosplit) = @_; | |
71f3e297 | 766 | my(@pairs) = split(/[&;]/,$tosplit); |
54310121 | 767 | my($param,$value); |
768 | foreach (@pairs) { | |
424ec8fa | 769 | ($param,$value) = split('=',$_,2); |
b2d0d414 | 770 | next unless defined $param; |
69c89ae7 | 771 | next if $NO_UNDEF_PARAMS and not defined $value; |
3d1a2ec4 | 772 | $value = '' unless defined $value; |
424ec8fa GS |
773 | $param = unescape($param); |
774 | $value = unescape($value); | |
54310121 | 775 | $self->add_parameter($param); |
776 | push (@{$self->{$param}},$value); | |
777 | } | |
778 | } | |
779 | ||
780 | sub add_parameter { | |
781 | my($self,$param)=@_; | |
3d1a2ec4 | 782 | return unless defined $param; |
54310121 | 783 | push (@{$self->{'.parameters'}},$param) |
784 | unless defined($self->{$param}); | |
785 | } | |
786 | ||
787 | sub all_parameters { | |
788 | my $self = shift; | |
789 | return () unless defined($self) && $self->{'.parameters'}; | |
790 | return () unless @{$self->{'.parameters'}}; | |
791 | return @{$self->{'.parameters'}}; | |
792 | } | |
793 | ||
424ec8fa GS |
794 | # put a filehandle into binary mode (DOS) |
795 | sub binmode { | |
2ed511ec | 796 | return unless defined($_[1]) && defined fileno($_[1]); |
424ec8fa GS |
797 | CORE::binmode($_[1]); |
798 | } | |
799 | ||
800 | sub _make_tag_func { | |
71f3e297 | 801 | my ($self,$tagname) = @_; |
3538e1d5 | 802 | my $func = qq( |
3d1a2ec4 | 803 | sub $tagname { |
8f3ccfa2 JH |
804 | my (\$q,\$a,\@rest) = self_or_default(\@_); |
805 | my(\$attr) = ''; | |
806 | if (ref(\$a) && ref(\$a) eq 'HASH') { | |
807 | my(\@attr) = make_attributes(\$a,\$q->{'escape'}); | |
808 | \$attr = " \@attr" if \@attr; | |
809 | } else { | |
1c87da1d | 810 | unshift \@rest,\$a if defined \$a; |
8f3ccfa2 | 811 | } |
3538e1d5 | 812 | ); |
71f3e297 | 813 | if ($tagname=~/start_(\w+)/i) { |
6b4ac661 | 814 | $func .= qq! return "<\L$1\E\$attr>";} !; |
71f3e297 | 815 | } elsif ($tagname=~/end_(\w+)/i) { |
6b4ac661 | 816 | $func .= qq! return "<\L/$1\E>"; } !; |
71f3e297 JH |
817 | } else { |
818 | $func .= qq# | |
1c87da1d | 819 | return \$XHTML ? "\L<$tagname\E\$attr />" : "\L<$tagname\E\$attr>" unless \@rest; |
6b4ac661 | 820 | my(\$tag,\$untag) = ("\L<$tagname\E\$attr>","\L</$tagname>\E"); |
3d1a2ec4 | 821 | my \@result = map { "\$tag\$_\$untag" } |
8f3ccfa2 | 822 | (ref(\$rest[0]) eq 'ARRAY') ? \@{\$rest[0]} : "\@rest"; |
424ec8fa | 823 | return "\@result"; |
71f3e297 JH |
824 | }#; |
825 | } | |
826 | return $func; | |
54310121 | 827 | } |
828 | ||
829 | sub AUTOLOAD { | |
830 | print STDERR "CGI::AUTOLOAD for $AUTOLOAD\n" if $CGI::AUTOLOAD_DEBUG; | |
424ec8fa GS |
831 | my $func = &_compile; |
832 | goto &$func; | |
54310121 | 833 | } |
834 | ||
424ec8fa GS |
835 | sub _compile { |
836 | my($func) = $AUTOLOAD; | |
837 | my($pack,$func_name); | |
838 | { | |
839 | local($1,$2); # this fixes an obscure variable suicide problem. | |
840 | $func=~/(.+)::([^:]+)$/; | |
841 | ($pack,$func_name) = ($1,$2); | |
842 | $pack=~s/::SUPER$//; # fix another obscure problem | |
843 | $pack = ${"$pack\:\:AutoloadClass"} || $CGI::DefaultClass | |
844 | unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"}); | |
845 | ||
846 | my($sub) = \%{"$pack\:\:SUBS"}; | |
847 | unless (%$sub) { | |
848 | my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"}; | |
29ddc2a4 | 849 | local ($@,$!); |
424ec8fa | 850 | eval "package $pack; $$auto"; |
ba056755 | 851 | croak("$AUTOLOAD: $@") if $@; |
424ec8fa GS |
852 | $$auto = ''; # Free the unneeded storage (but don't undef it!!!) |
853 | } | |
854 | my($code) = $sub->{$func_name}; | |
855 | ||
856 | $code = "sub $AUTOLOAD { }" if (!$code and $func_name eq 'DESTROY'); | |
857 | if (!$code) { | |
71f3e297 | 858 | (my $base = $func_name) =~ s/^(start_|end_)//i; |
424ec8fa GS |
859 | if ($EXPORT{':any'} || |
860 | $EXPORT{'-any'} || | |
71f3e297 | 861 | $EXPORT{$base} || |
424ec8fa | 862 | (%EXPORT_OK || grep(++$EXPORT_OK{$_},&expand_tags(':html'))) |
71f3e297 JH |
863 | && $EXPORT_OK{$base}) { |
864 | $code = $CGI::DefaultClass->_make_tag_func($func_name); | |
424ec8fa GS |
865 | } |
866 | } | |
ba056755 | 867 | croak("Undefined subroutine $AUTOLOAD\n") unless $code; |
29ddc2a4 | 868 | local ($@,$!); |
424ec8fa GS |
869 | eval "package $pack; $code"; |
870 | if ($@) { | |
871 | $@ =~ s/ at .*\n//; | |
ba056755 | 872 | croak("$AUTOLOAD: $@"); |
424ec8fa GS |
873 | } |
874 | } | |
3538e1d5 | 875 | CORE::delete($sub->{$func_name}); #free storage |
424ec8fa GS |
876 | return "$pack\:\:$func_name"; |
877 | } | |
878 | ||
3acbd4f5 JH |
879 | sub _selected { |
880 | my $self = shift; | |
881 | my $value = shift; | |
882 | return '' unless $value; | |
0a9bdad4 | 883 | return $XHTML ? qq(selected="selected" ) : qq(selected ); |
3acbd4f5 JH |
884 | } |
885 | ||
886 | sub _checked { | |
887 | my $self = shift; | |
888 | my $value = shift; | |
889 | return '' unless $value; | |
0a9bdad4 | 890 | return $XHTML ? qq(checked="checked" ) : qq(checked ); |
3acbd4f5 JH |
891 | } |
892 | ||
424ec8fa GS |
893 | sub _reset_globals { initialize_globals(); } |
894 | ||
895 | sub _setup_symbols { | |
896 | my $self = shift; | |
897 | my $compile = 0; | |
b2d0d414 JH |
898 | |
899 | # to avoid reexporting unwanted variables | |
900 | undef %EXPORT; | |
901 | ||
424ec8fa | 902 | foreach (@_) { |
71f3e297 JH |
903 | $HEADERS_ONCE++, next if /^[:-]unique_headers$/; |
904 | $NPH++, next if /^[:-]nph$/; | |
3d1a2ec4 GS |
905 | $NOSTICKY++, next if /^[:-]nosticky$/; |
906 | $DEBUG=0, next if /^[:-]no_?[Dd]ebug$/; | |
907 | $DEBUG=2, next if /^[:-][Dd]ebug$/; | |
71f3e297 | 908 | $USE_PARAM_SEMICOLONS++, next if /^[:-]newstyle_urls$/; |
bb8b3399 | 909 | $PARAM_UTF8++, next if /^[:-]utf8$/; |
6b4ac661 JH |
910 | $XHTML++, next if /^[:-]xhtml$/; |
911 | $XHTML=0, next if /^[:-]no_?xhtml$/; | |
3d1a2ec4 | 912 | $USE_PARAM_SEMICOLONS=0, next if /^[:-]oldstyle_urls$/; |
71f3e297 | 913 | $PRIVATE_TEMPFILES++, next if /^[:-]private_tempfiles$/; |
0a9bdad4 | 914 | $TABINDEX++, next if /^[:-]tabindex$/; |
13548fdf | 915 | $CLOSE_UPLOAD_FILES++, next if /^[:-]close_upload_files$/; |
71f3e297 JH |
916 | $EXPORT{$_}++, next if /^[:-]any$/; |
917 | $compile++, next if /^[:-]compile$/; | |
199d4a26 | 918 | $NO_UNDEF_PARAMS++, next if /^[:-]no_undef_params$/; |
424ec8fa | 919 | |
71f3e297 | 920 | # This is probably extremely evil code -- to be deleted some day. |
424ec8fa GS |
921 | if (/^[-]autoload$/) { |
922 | my($pkg) = caller(1); | |
923 | *{"${pkg}::AUTOLOAD"} = sub { | |
924 | my($routine) = $AUTOLOAD; | |
925 | $routine =~ s/^.*::/CGI::/; | |
926 | &$routine; | |
927 | }; | |
928 | next; | |
929 | } | |
930 | ||
931 | foreach (&expand_tags($_)) { | |
932 | tr/a-zA-Z0-9_//cd; # don't allow weird function names | |
933 | $EXPORT{$_}++; | |
54310121 | 934 | } |
54310121 | 935 | } |
424ec8fa | 936 | _compile_all(keys %EXPORT) if $compile; |
188ba755 | 937 | @SAVED_SYMBOLS = @_; |
54310121 | 938 | } |
939 | ||
3d1a2ec4 GS |
940 | sub charset { |
941 | my ($self,$charset) = self_or_default(@_); | |
942 | $self->{'.charset'} = $charset if defined $charset; | |
943 | $self->{'.charset'}; | |
944 | } | |
945 | ||
29ddc2a4 RGS |
946 | sub element_id { |
947 | my ($self,$new_value) = self_or_default(@_); | |
948 | $self->{'.elid'} = $new_value if defined $new_value; | |
949 | sprintf('%010d',$self->{'.elid'}++); | |
950 | } | |
951 | ||
952 | sub element_tab { | |
953 | my ($self,$new_value) = self_or_default(@_); | |
70194bd6 | 954 | $self->{'.etab'} ||= 1; |
29ddc2a4 | 955 | $self->{'.etab'} = $new_value if defined $new_value; |
0a9bdad4 SP |
956 | my $tab = $self->{'.etab'}++; |
957 | return '' unless $TABINDEX or defined $new_value; | |
958 | return qq(tabindex="$tab" ); | |
29ddc2a4 RGS |
959 | } |
960 | ||
54310121 | 961 | ############################################################################### |
962 | ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND #################### | |
963 | ############################################################################### | |
964 | $AUTOLOADED_ROUTINES = ''; # get rid of -w warning | |
965 | $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD'; | |
966 | ||
967 | %SUBS = ( | |
968 | ||
969 | 'URL_ENCODED'=> <<'END_OF_FUNC', | |
970 | sub URL_ENCODED { 'application/x-www-form-urlencoded'; } | |
971 | END_OF_FUNC | |
972 | ||
973 | 'MULTIPART' => <<'END_OF_FUNC', | |
974 | sub MULTIPART { 'multipart/form-data'; } | |
975 | END_OF_FUNC | |
976 | ||
424ec8fa | 977 | 'SERVER_PUSH' => <<'END_OF_FUNC', |
ba056755 | 978 | sub SERVER_PUSH { 'multipart/x-mixed-replace;boundary="' . shift() . '"'; } |
424ec8fa GS |
979 | END_OF_FUNC |
980 | ||
424ec8fa GS |
981 | 'new_MultipartBuffer' => <<'END_OF_FUNC', |
982 | # Create a new multipart buffer | |
983 | sub new_MultipartBuffer { | |
2ed511ec RGS |
984 | my($self,$boundary,$length) = @_; |
985 | return MultipartBuffer->new($self,$boundary,$length); | |
424ec8fa GS |
986 | } |
987 | END_OF_FUNC | |
988 | ||
989 | 'read_from_client' => <<'END_OF_FUNC', | |
990 | # Read data from a file handle | |
991 | sub read_from_client { | |
2ed511ec | 992 | my($self, $buff, $len, $offset) = @_; |
424ec8fa | 993 | local $^W=0; # prevent a warning |
2ed511ec RGS |
994 | return $MOD_PERL |
995 | ? $self->r->read($$buff, $len, $offset) | |
996 | : read(\*STDIN, $$buff, $len, $offset); | |
424ec8fa GS |
997 | } |
998 | END_OF_FUNC | |
999 | ||
1000 | 'delete' => <<'END_OF_FUNC', | |
1001 | #### Method: delete | |
1002 | # Deletes the named parameter entirely. | |
1003 | #### | |
1004 | sub delete { | |
6b4ac661 | 1005 | my($self,@p) = self_or_default(@_); |
1c87da1d JH |
1006 | my(@names) = rearrange([NAME],@p); |
1007 | my @to_delete = ref($names[0]) eq 'ARRAY' ? @$names[0] : @names; | |
8f3ccfa2 JH |
1008 | my %to_delete; |
1009 | foreach my $name (@to_delete) | |
1010 | { | |
1011 | CORE::delete $self->{$name}; | |
1012 | CORE::delete $self->{'.fieldnames'}->{$name}; | |
1013 | $to_delete{$name}++; | |
188ba755 | 1014 | } |
8f3ccfa2 | 1015 | @{$self->{'.parameters'}}=grep { !exists($to_delete{$_}) } $self->param(); |
13548fdf | 1016 | return; |
424ec8fa GS |
1017 | } |
1018 | END_OF_FUNC | |
1019 | ||
1020 | #### Method: import_names | |
1021 | # Import all parameters into the given namespace. | |
1022 | # Assumes namespace 'Q' if not specified | |
1023 | #### | |
1024 | 'import_names' => <<'END_OF_FUNC', | |
1025 | sub import_names { | |
1026 | my($self,$namespace,$delete) = self_or_default(@_); | |
1027 | $namespace = 'Q' unless defined($namespace); | |
1028 | die "Can't import names into \"main\"\n" if \%{"${namespace}::"} == \%::; | |
3538e1d5 | 1029 | if ($delete || $MOD_PERL || exists $ENV{'FCGI_ROLE'}) { |
424ec8fa GS |
1030 | # can anyone find an easier way to do this? |
1031 | foreach (keys %{"${namespace}::"}) { | |
1032 | local *symbol = "${namespace}::${_}"; | |
1033 | undef $symbol; | |
1034 | undef @symbol; | |
1035 | undef %symbol; | |
54310121 | 1036 | } |
424ec8fa GS |
1037 | } |
1038 | my($param,@value,$var); | |
1039 | foreach $param ($self->param) { | |
1040 | # protect against silly names | |
1041 | ($var = $param)=~tr/a-zA-Z0-9_/_/c; | |
1042 | $var =~ s/^(?=\d)/_/; | |
1043 | local *symbol = "${namespace}::$var"; | |
1044 | @value = $self->param($param); | |
1045 | @symbol = @value; | |
1046 | $symbol = $value[0]; | |
54310121 | 1047 | } |
1048 | } | |
1049 | END_OF_FUNC | |
1050 | ||
1051 | #### Method: keywords | |
1052 | # Keywords acts a bit differently. Calling it in a list context | |
1053 | # returns the list of keywords. | |
1054 | # Calling it in a scalar context gives you the size of the list. | |
1055 | #### | |
1056 | 'keywords' => <<'END_OF_FUNC', | |
1057 | sub keywords { | |
1058 | my($self,@values) = self_or_default(@_); | |
1059 | # If values is provided, then we set it. | |
475342a6 | 1060 | $self->{'keywords'}=[@values] if @values; |
424ec8fa | 1061 | my(@result) = defined($self->{'keywords'}) ? @{$self->{'keywords'}} : (); |
54310121 | 1062 | @result; |
1063 | } | |
1064 | END_OF_FUNC | |
1065 | ||
1066 | # These are some tie() interfaces for compatibility | |
1067 | # with Steve Brenner's cgi-lib.pl routines | |
3538e1d5 GS |
1068 | 'Vars' => <<'END_OF_FUNC', |
1069 | sub Vars { | |
ffd2dff2 | 1070 | my $q = shift; |
3538e1d5 | 1071 | my %in; |
ffd2dff2 | 1072 | tie(%in,CGI,$q); |
3538e1d5 GS |
1073 | return %in if wantarray; |
1074 | return \%in; | |
1075 | } | |
1076 | END_OF_FUNC | |
1077 | ||
1078 | # These are some tie() interfaces for compatibility | |
1079 | # with Steve Brenner's cgi-lib.pl routines | |
54310121 | 1080 | 'ReadParse' => <<'END_OF_FUNC', |
1081 | sub ReadParse { | |
1082 | local(*in); | |
1083 | if (@_) { | |
1084 | *in = $_[0]; | |
1085 | } else { | |
1086 | my $pkg = caller(); | |
1087 | *in=*{"${pkg}::in"}; | |
1088 | } | |
1089 | tie(%in,CGI); | |
424ec8fa | 1090 | return scalar(keys %in); |
54310121 | 1091 | } |
1092 | END_OF_FUNC | |
1093 | ||
1094 | 'PrintHeader' => <<'END_OF_FUNC', | |
1095 | sub PrintHeader { | |
1096 | my($self) = self_or_default(@_); | |
1097 | return $self->header(); | |
1098 | } | |
1099 | END_OF_FUNC | |
1100 | ||
1101 | 'HtmlTop' => <<'END_OF_FUNC', | |
1102 | sub HtmlTop { | |
1103 | my($self,@p) = self_or_default(@_); | |
1104 | return $self->start_html(@p); | |
1105 | } | |
1106 | END_OF_FUNC | |
1107 | ||
1108 | 'HtmlBot' => <<'END_OF_FUNC', | |
1109 | sub HtmlBot { | |
1110 | my($self,@p) = self_or_default(@_); | |
1111 | return $self->end_html(@p); | |
1112 | } | |
1113 | END_OF_FUNC | |
1114 | ||
1115 | 'SplitParam' => <<'END_OF_FUNC', | |
1116 | sub SplitParam { | |
1117 | my ($param) = @_; | |
1118 | my (@params) = split ("\0", $param); | |
1119 | return (wantarray ? @params : $params[0]); | |
1120 | } | |
1121 | END_OF_FUNC | |
1122 | ||
1123 | 'MethGet' => <<'END_OF_FUNC', | |
1124 | sub MethGet { | |
1125 | return request_method() eq 'GET'; | |
1126 | } | |
1127 | END_OF_FUNC | |
1128 | ||
1129 | 'MethPost' => <<'END_OF_FUNC', | |
1130 | sub MethPost { | |
1131 | return request_method() eq 'POST'; | |
1132 | } | |
1133 | END_OF_FUNC | |
1134 | ||
1135 | 'TIEHASH' => <<'END_OF_FUNC', | |
8f3ccfa2 JH |
1136 | sub TIEHASH { |
1137 | my $class = shift; | |
1138 | my $arg = $_[0]; | |
1139 | if (ref($arg) && UNIVERSAL::isa($arg,'CGI')) { | |
1140 | return $arg; | |
1141 | } | |
1142 | return $Q ||= $class->new(@_); | |
54310121 | 1143 | } |
1144 | END_OF_FUNC | |
1145 | ||
1146 | 'STORE' => <<'END_OF_FUNC', | |
1147 | sub STORE { | |
3d1a2ec4 GS |
1148 | my $self = shift; |
1149 | my $tag = shift; | |
6b4ac661 JH |
1150 | my $vals = shift; |
1151 | my @vals = index($vals,"\0")!=-1 ? split("\0",$vals) : $vals; | |
3d1a2ec4 | 1152 | $self->param(-name=>$tag,-value=>\@vals); |
54310121 | 1153 | } |
1154 | END_OF_FUNC | |
1155 | ||
1156 | 'FETCH' => <<'END_OF_FUNC', | |
1157 | sub FETCH { | |
1158 | return $_[0] if $_[1] eq 'CGI'; | |
1159 | return undef unless defined $_[0]->param($_[1]); | |
1160 | return join("\0",$_[0]->param($_[1])); | |
1161 | } | |
1162 | END_OF_FUNC | |
1163 | ||
1164 | 'FIRSTKEY' => <<'END_OF_FUNC', | |
1165 | sub FIRSTKEY { | |
1166 | $_[0]->{'.iterator'}=0; | |
1167 | $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++]; | |
1168 | } | |
1169 | END_OF_FUNC | |
1170 | ||
1171 | 'NEXTKEY' => <<'END_OF_FUNC', | |
1172 | sub NEXTKEY { | |
1173 | $_[0]->{'.parameters'}->[$_[0]->{'.iterator'}++]; | |
1174 | } | |
1175 | END_OF_FUNC | |
1176 | ||
1177 | 'EXISTS' => <<'END_OF_FUNC', | |
1178 | sub EXISTS { | |
1179 | exists $_[0]->{$_[1]}; | |
1180 | } | |
1181 | END_OF_FUNC | |
1182 | ||
1183 | 'DELETE' => <<'END_OF_FUNC', | |
1184 | sub DELETE { | |
1185 | $_[0]->delete($_[1]); | |
1186 | } | |
1187 | END_OF_FUNC | |
1188 | ||
1189 | 'CLEAR' => <<'END_OF_FUNC', | |
1190 | sub CLEAR { | |
1191 | %{$_[0]}=(); | |
1192 | } | |
1193 | #### | |
1194 | END_OF_FUNC | |
1195 | ||
1196 | #### | |
1197 | # Append a new value to an existing query | |
1198 | #### | |
1199 | 'append' => <<'EOF', | |
1200 | sub append { | |
7dc108d1 | 1201 | my($self,@p) = self_or_default(@_); |
3d1a2ec4 | 1202 | my($name,$value) = rearrange([NAME,[VALUE,VALUES]],@p); |
54310121 | 1203 | my(@values) = defined($value) ? (ref($value) ? @{$value} : $value) : (); |
1204 | if (@values) { | |
1205 | $self->add_parameter($name); | |
1206 | push(@{$self->{$name}},@values); | |
1207 | } | |
1208 | return $self->param($name); | |
1209 | } | |
1210 | EOF | |
1211 | ||
1212 | #### Method: delete_all | |
1213 | # Delete all parameters | |
1214 | #### | |
1215 | 'delete_all' => <<'EOF', | |
1216 | sub delete_all { | |
1217 | my($self) = self_or_default(@_); | |
1c87da1d | 1218 | my @param = $self->param(); |
8f3ccfa2 | 1219 | $self->delete(@param); |
54310121 | 1220 | } |
1221 | EOF | |
1222 | ||
424ec8fa GS |
1223 | 'Delete' => <<'EOF', |
1224 | sub Delete { | |
1225 | my($self,@p) = self_or_default(@_); | |
1226 | $self->delete(@p); | |
1227 | } | |
1228 | EOF | |
1229 | ||
1230 | 'Delete_all' => <<'EOF', | |
1231 | sub Delete_all { | |
1232 | my($self,@p) = self_or_default(@_); | |
1233 | $self->delete_all(@p); | |
1234 | } | |
1235 | EOF | |
1236 | ||
54310121 | 1237 | #### Method: autoescape |
1238 | # If you want to turn off the autoescaping features, | |
1239 | # call this method with undef as the argument | |
1240 | 'autoEscape' => <<'END_OF_FUNC', | |
1241 | sub autoEscape { | |
1242 | my($self,$escape) = self_or_default(@_); | |
188ba755 JH |
1243 | my $d = $self->{'escape'}; |
1244 | $self->{'escape'} = $escape; | |
1245 | $d; | |
54310121 | 1246 | } |
1247 | END_OF_FUNC | |
1248 | ||
1249 | ||
1250 | #### Method: version | |
1251 | # Return the current version | |
1252 | #### | |
1253 | 'version' => <<'END_OF_FUNC', | |
1254 | sub version { | |
1255 | return $VERSION; | |
1256 | } | |
1257 | END_OF_FUNC | |
1258 | ||
424ec8fa GS |
1259 | #### Method: url_param |
1260 | # Return a parameter in the QUERY_STRING, regardless of | |
1261 | # whether this was a POST or a GET | |
1262 | #### | |
1263 | 'url_param' => <<'END_OF_FUNC', | |
1264 | sub url_param { | |
1265 | my ($self,@p) = self_or_default(@_); | |
1266 | my $name = shift(@p); | |
1267 | return undef unless exists($ENV{QUERY_STRING}); | |
1268 | unless (exists($self->{'.url_param'})) { | |
1269 | $self->{'.url_param'}={}; # empty hash | |
1270 | if ($ENV{QUERY_STRING} =~ /=/) { | |
71f3e297 | 1271 | my(@pairs) = split(/[&;]/,$ENV{QUERY_STRING}); |
424ec8fa GS |
1272 | my($param,$value); |
1273 | foreach (@pairs) { | |
1274 | ($param,$value) = split('=',$_,2); | |
1275 | $param = unescape($param); | |
1276 | $value = unescape($value); | |
1277 | push(@{$self->{'.url_param'}->{$param}},$value); | |
1278 | } | |
1279 | } else { | |
1280 | $self->{'.url_param'}->{'keywords'} = [$self->parse_keywordlist($ENV{QUERY_STRING})]; | |
1281 | } | |
1282 | } | |
1283 | return keys %{$self->{'.url_param'}} unless defined($name); | |
1284 | return () unless $self->{'.url_param'}->{$name}; | |
1285 | return wantarray ? @{$self->{'.url_param'}->{$name}} | |
1286 | : $self->{'.url_param'}->{$name}->[0]; | |
1287 | } | |
1288 | END_OF_FUNC | |
1289 | ||
3d1a2ec4 | 1290 | #### Method: Dump |
54310121 | 1291 | # Returns a string in which all the known parameter/value |
1292 | # pairs are represented as nested lists, mainly for the purposes | |
1293 | # of debugging. | |
1294 | #### | |
3d1a2ec4 GS |
1295 | 'Dump' => <<'END_OF_FUNC', |
1296 | sub Dump { | |
54310121 | 1297 | my($self) = self_or_default(@_); |
1298 | my($param,$value,@result); | |
3acbd4f5 JH |
1299 | return '<ul></ul>' unless $self->param; |
1300 | push(@result,"<ul>"); | |
54310121 | 1301 | foreach $param ($self->param) { |
1302 | my($name)=$self->escapeHTML($param); | |
1c87da1d | 1303 | push(@result,"<li><strong>$param</strong></li>"); |
3acbd4f5 | 1304 | push(@result,"<ul>"); |
54310121 | 1305 | foreach $value ($self->param($param)) { |
1306 | $value = $self->escapeHTML($value); | |
58129083 | 1307 | $value =~ s/\n/<br \/>\n/g; |
1c87da1d | 1308 | push(@result,"<li>$value</li>"); |
54310121 | 1309 | } |
3acbd4f5 | 1310 | push(@result,"</ul>"); |
54310121 | 1311 | } |
3acbd4f5 | 1312 | push(@result,"</ul>"); |
54310121 | 1313 | return join("\n",@result); |
1314 | } | |
1315 | END_OF_FUNC | |
1316 | ||
424ec8fa GS |
1317 | #### Method as_string |
1318 | # | |
1319 | # synonym for "dump" | |
1320 | #### | |
1321 | 'as_string' => <<'END_OF_FUNC', | |
1322 | sub as_string { | |
3d1a2ec4 | 1323 | &Dump(@_); |
424ec8fa GS |
1324 | } |
1325 | END_OF_FUNC | |
1326 | ||
1327 | #### Method: save | |
1328 | # Write values out to a filehandle in such a way that they can | |
1329 | # be reinitialized by the filehandle form of the new() method | |
54310121 | 1330 | #### |
1331 | 'save' => <<'END_OF_FUNC', | |
1332 | sub save { | |
1333 | my($self,$filehandle) = self_or_default(@_); | |
54310121 | 1334 | $filehandle = to_filehandle($filehandle); |
424ec8fa GS |
1335 | my($param); |
1336 | local($,) = ''; # set print field separator back to a sane value | |
71f3e297 | 1337 | local($\) = ''; # set output line separator to a sane value |
54310121 | 1338 | foreach $param ($self->param) { |
424ec8fa | 1339 | my($escaped_param) = escape($param); |
54310121 | 1340 | my($value); |
1341 | foreach $value ($self->param($param)) { | |
3538e1d5 | 1342 | print $filehandle "$escaped_param=",escape("$value"),"\n"; |
54310121 | 1343 | } |
1344 | } | |
d45d855d JH |
1345 | foreach (keys %{$self->{'.fieldnames'}}) { |
1346 | print $filehandle ".cgifields=",escape("$_"),"\n"; | |
1347 | } | |
54310121 | 1348 | print $filehandle "=\n"; # end of record |
1349 | } | |
1350 | END_OF_FUNC | |
1351 | ||
1352 | ||
424ec8fa GS |
1353 | #### Method: save_parameters |
1354 | # An alias for save() that is a better name for exportation. | |
1355 | # Only intended to be used with the function (non-OO) interface. | |
1356 | #### | |
1357 | 'save_parameters' => <<'END_OF_FUNC', | |
1358 | sub save_parameters { | |
1359 | my $fh = shift; | |
1360 | return save(to_filehandle($fh)); | |
1361 | } | |
1362 | END_OF_FUNC | |
1363 | ||
1364 | #### Method: restore_parameters | |
1365 | # A way to restore CGI parameters from an initializer. | |
1366 | # Only intended to be used with the function (non-OO) interface. | |
1367 | #### | |
1368 | 'restore_parameters' => <<'END_OF_FUNC', | |
1369 | sub restore_parameters { | |
1370 | $Q = $CGI::DefaultClass->new(@_); | |
1371 | } | |
1372 | END_OF_FUNC | |
1373 | ||
1374 | #### Method: multipart_init | |
1375 | # Return a Content-Type: style header for server-push | |
ba056755 | 1376 | # This has to be NPH on most web servers, and it is advisable to set $| = 1 |
424ec8fa GS |
1377 | # |
1378 | # Many thanks to Ed Jordan <ed@fidalgo.net> for this | |
ba056755 | 1379 | # contribution, updated by Andrew Benham (adsb@bigfoot.com) |
424ec8fa GS |
1380 | #### |
1381 | 'multipart_init' => <<'END_OF_FUNC', | |
1382 | sub multipart_init { | |
1383 | my($self,@p) = self_or_default(@_); | |
3d1a2ec4 | 1384 | my($boundary,@other) = rearrange([BOUNDARY],@p); |
424ec8fa | 1385 | $boundary = $boundary || '------- =_aaaaaaaaaa0'; |
ba056755 JH |
1386 | $self->{'separator'} = "$CRLF--$boundary$CRLF"; |
1387 | $self->{'final_separator'} = "$CRLF--$boundary--$CRLF"; | |
424ec8fa GS |
1388 | $type = SERVER_PUSH($boundary); |
1389 | return $self->header( | |
13548fdf | 1390 | -nph => 0, |
424ec8fa GS |
1391 | -type => $type, |
1392 | (map { split "=", $_, 2 } @other), | |
ba056755 | 1393 | ) . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $self->multipart_end; |
424ec8fa GS |
1394 | } |
1395 | END_OF_FUNC | |
1396 | ||
1397 | ||
1398 | #### Method: multipart_start | |
1399 | # Return a Content-Type: style header for server-push, start of section | |
1400 | # | |
1401 | # Many thanks to Ed Jordan <ed@fidalgo.net> for this | |
ba056755 | 1402 | # contribution, updated by Andrew Benham (adsb@bigfoot.com) |
424ec8fa GS |
1403 | #### |
1404 | 'multipart_start' => <<'END_OF_FUNC', | |
1405 | sub multipart_start { | |
ba056755 | 1406 | my(@header); |
424ec8fa | 1407 | my($self,@p) = self_or_default(@_); |
3d1a2ec4 | 1408 | my($type,@other) = rearrange([TYPE],@p); |
424ec8fa | 1409 | $type = $type || 'text/html'; |
ba056755 JH |
1410 | push(@header,"Content-Type: $type"); |
1411 | ||
1412 | # rearrange() was designed for the HTML portion, so we | |
1413 | # need to fix it up a little. | |
1414 | foreach (@other) { | |
8f3ccfa2 JH |
1415 | # Don't use \s because of perl bug 21951 |
1416 | next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/; | |
ba056755 JH |
1417 | ($_ = $header) =~ s/^(\w)(.*)/$1 . lc ($2) . ': '.$self->unescapeHTML($value)/e; |
1418 | } | |
1419 | push(@header,@other); | |
1420 | my $header = join($CRLF,@header)."${CRLF}${CRLF}"; | |
1421 | return $header; | |
424ec8fa GS |
1422 | } |
1423 | END_OF_FUNC | |
1424 | ||
1425 | ||
1426 | #### Method: multipart_end | |
ba056755 | 1427 | # Return a MIME boundary separator for server-push, end of section |
424ec8fa GS |
1428 | # |
1429 | # Many thanks to Ed Jordan <ed@fidalgo.net> for this | |
1430 | # contribution | |
1431 | #### | |
1432 | 'multipart_end' => <<'END_OF_FUNC', | |
1433 | sub multipart_end { | |
1434 | my($self,@p) = self_or_default(@_); | |
1435 | return $self->{'separator'}; | |
1436 | } | |
1437 | END_OF_FUNC | |
1438 | ||
1439 | ||
ba056755 JH |
1440 | #### Method: multipart_final |
1441 | # Return a MIME boundary separator for server-push, end of all sections | |
1442 | # | |
1443 | # Contributed by Andrew Benham (adsb@bigfoot.com) | |
1444 | #### | |
1445 | 'multipart_final' => <<'END_OF_FUNC', | |
1446 | sub multipart_final { | |
1447 | my($self,@p) = self_or_default(@_); | |
1448 | return $self->{'final_separator'} . "WARNING: YOUR BROWSER DOESN'T SUPPORT THIS SERVER-PUSH TECHNOLOGY." . $CRLF; | |
1449 | } | |
1450 | END_OF_FUNC | |
1451 | ||
1452 | ||
54310121 | 1453 | #### Method: header |
1454 | # Return a Content-Type: style header | |
1455 | # | |
1456 | #### | |
1457 | 'header' => <<'END_OF_FUNC', | |
1458 | sub header { | |
1459 | my($self,@p) = self_or_default(@_); | |
1460 | my(@header); | |
1461 | ||
2ed511ec | 1462 | return "" if $self->{'.header_printed'}++ and $HEADERS_ONCE; |
71f3e297 | 1463 | |
8f3ccfa2 | 1464 | my($type,$status,$cookie,$target,$expires,$nph,$charset,$attachment,$p3p,@other) = |
3d1a2ec4 GS |
1465 | rearrange([['TYPE','CONTENT_TYPE','CONTENT-TYPE'], |
1466 | 'STATUS',['COOKIE','COOKIES'],'TARGET', | |
6b4ac661 | 1467 | 'EXPIRES','NPH','CHARSET', |
8f3ccfa2 | 1468 | 'ATTACHMENT','P3P'],@p); |
3d1a2ec4 GS |
1469 | |
1470 | $nph ||= $NPH; | |
55b5d700 SP |
1471 | |
1472 | $type ||= 'text/html' unless defined($type); | |
1473 | ||
3d1a2ec4 GS |
1474 | if (defined $charset) { |
1475 | $self->charset($charset); | |
1476 | } else { | |
55b5d700 | 1477 | $charset = $self->charset if $type =~ /^text\//; |
3d1a2ec4 | 1478 | } |
cb3b230c | 1479 | $charset ||= ''; |
54310121 | 1480 | |
1481 | # rearrange() was designed for the HTML portion, so we | |
1482 | # need to fix it up a little. | |
1483 | foreach (@other) { | |
8f3ccfa2 JH |
1484 | # Don't use \s because of perl bug 21951 |
1485 | next unless my($header,$value) = /([^ \r\n\t=]+)=\"?(.+?)\"?$/; | |
1486 | ($_ = $header) =~ s/^(\w)(.*)/"\u$1\L$2" . ': '.$self->unescapeHTML($value)/e; | |
54310121 | 1487 | } |
1488 | ||
cd755de4 JJ |
1489 | $type .= "; charset=$charset" |
1490 | if $type ne '' | |
1491 | and $type !~ /\bcharset\b/ | |
1492 | and defined $charset | |
1493 | and $charset ne ''; | |
54310121 | 1494 | |
424ec8fa GS |
1495 | # Maybe future compatibility. Maybe not. |
1496 | my $protocol = $ENV{SERVER_PROTOCOL} || 'HTTP/1.0'; | |
1497 | push(@header,$protocol . ' ' . ($status || '200 OK')) if $nph; | |
ba056755 | 1498 | push(@header,"Server: " . &server_software()) if $nph; |
424ec8fa | 1499 | |
54310121 | 1500 | push(@header,"Status: $status") if $status; |
424ec8fa | 1501 | push(@header,"Window-Target: $target") if $target; |
8f3ccfa2 JH |
1502 | if ($p3p) { |
1503 | $p3p = join ' ',@$p3p if ref($p3p) eq 'ARRAY'; | |
1504 | push(@header,qq(P3P: policyref="/w3c/p3p.xml", CP="$p3p")); | |
1505 | } | |
54310121 | 1506 | # push all the cookies -- there may be several |
1507 | if ($cookie) { | |
424ec8fa | 1508 | my(@cookie) = ref($cookie) && ref($cookie) eq 'ARRAY' ? @{$cookie} : $cookie; |
54310121 | 1509 | foreach (@cookie) { |
71f3e297 JH |
1510 | my $cs = UNIVERSAL::isa($_,'CGI::Cookie') ? $_->as_string : $_; |
1511 | push(@header,"Set-Cookie: $cs") if $cs ne ''; | |
54310121 | 1512 | } |
1513 | } | |
1514 | # if the user indicates an expiration time, then we need | |
1515 | # both an Expires and a Date header (so that the browser is | |
1516 | # uses OUR clock) | |
424ec8fa | 1517 | push(@header,"Expires: " . expires($expires,'http')) |
7d37aa8e | 1518 | if $expires; |
ba056755 | 1519 | push(@header,"Date: " . expires(0,'http')) if $expires || $cookie || $nph; |
54310121 | 1520 | push(@header,"Pragma: no-cache") if $self->cache(); |
6b4ac661 | 1521 | push(@header,"Content-Disposition: attachment; filename=\"$attachment\"") if $attachment; |
69c89ae7 | 1522 | push(@header,map {ucfirst $_} @other); |
71f3e297 | 1523 | push(@header,"Content-Type: $type") if $type ne ''; |
424ec8fa | 1524 | my $header = join($CRLF,@header)."${CRLF}${CRLF}"; |
ead6d9e1 | 1525 | if (($MOD_PERL >= 1) && !$nph) { |
8f3ccfa2 JH |
1526 | $self->r->send_cgi_header($header); |
1527 | return ''; | |
424ec8fa GS |
1528 | } |
1529 | return $header; | |
54310121 | 1530 | } |
1531 | END_OF_FUNC | |
1532 | ||
1533 | ||
1534 | #### Method: cache | |
1535 | # Control whether header() will produce the no-cache | |
1536 | # Pragma directive. | |
1537 | #### | |
1538 | 'cache' => <<'END_OF_FUNC', | |
1539 | sub cache { | |
1540 | my($self,$new_value) = self_or_default(@_); | |
1541 | $new_value = '' unless $new_value; | |
1542 | if ($new_value ne '') { | |
1543 | $self->{'cache'} = $new_value; | |
1544 | } | |
1545 | return $self->{'cache'}; | |
1546 | } | |
1547 | END_OF_FUNC | |
1548 | ||
1549 | ||
1550 | #### Method: redirect | |
1551 | # Return a Location: style header | |
1552 | # | |
1553 | #### | |
1554 | 'redirect' => <<'END_OF_FUNC', | |
1555 | sub redirect { | |
1556 | my($self,@p) = self_or_default(@_); | |
13548fdf RGS |
1557 | my($url,$target,$status,$cookie,$nph,@other) = |
1558 | rearrange([[LOCATION,URI,URL],TARGET,STATUS,['COOKIE','COOKIES'],NPH],@p); | |
55b5d700 | 1559 | $status = '302 Found' unless defined $status; |
6b4ac661 | 1560 | $url ||= $self->self_url; |
54310121 | 1561 | my(@o); |
424ec8fa GS |
1562 | foreach (@other) { tr/\"//d; push(@o,split("=",$_,2)); } |
1563 | unshift(@o, | |
13548fdf | 1564 | '-Status' => $status, |
8f3ccfa2 JH |
1565 | '-Location'=> $url, |
1566 | '-nph' => $nph); | |
424ec8fa | 1567 | unshift(@o,'-Target'=>$target) if $target; |
71f3e297 | 1568 | unshift(@o,'-Type'=>''); |
8f3ccfa2 JH |
1569 | my @unescaped; |
1570 | unshift(@unescaped,'-Cookie'=>$cookie) if $cookie; | |
1571 | return $self->header((map {$self->unescapeHTML($_)} @o),@unescaped); | |
54310121 | 1572 | } |
1573 | END_OF_FUNC | |
1574 | ||
1575 | ||
1576 | #### Method: start_html | |
1577 | # Canned HTML header | |
1578 | # | |
1579 | # Parameters: | |
1580 | # $title -> (optional) The title for this HTML document (-title) | |
1581 | # $author -> (optional) e-mail address of the author (-author) | |
1582 | # $base -> (optional) if set to true, will enter the BASE address of this document | |
1583 | # for resolving relative references (-base) | |
1584 | # $xbase -> (optional) alternative base at some remote location (-xbase) | |
1585 | # $target -> (optional) target window to load all links into (-target) | |
1586 | # $script -> (option) Javascript code (-script) | |
47e3cabd | 1587 | # $no_script -> (option) Javascript <noscript> tag (-noscript) |
54310121 | 1588 | # $meta -> (optional) Meta information tags |
3acbd4f5 | 1589 | # $head -> (optional) any other elements you'd like to incorporate into the <head> tag |
7d37aa8e LS |
1590 | # (a scalar or array ref) |
1591 | # $style -> (optional) reference to an external style sheet | |
54310121 | 1592 | # @other -> (optional) any other named parameters you'd like to incorporate into |
3acbd4f5 | 1593 | # the <body> tag. |
54310121 | 1594 | #### |
1595 | 'start_html' => <<'END_OF_FUNC', | |
1596 | sub start_html { | |
1597 | my($self,@p) = &self_or_default(@_); | |
ac734d8b | 1598 | my($title,$author,$base,$xbase,$script,$noscript, |
29ddc2a4 RGS |
1599 | $target,$meta,$head,$style,$dtd,$lang,$encoding,$declare_xml,@other) = |
1600 | rearrange([TITLE,AUTHOR,BASE,XBASE,SCRIPT,NOSCRIPT,TARGET, | |
1601 | META,HEAD,STYLE,DTD,LANG,ENCODING,DECLARE_XML],@p); | |
1602 | ||
1603 | $self->element_id(0); | |
1604 | $self->element_tab(0); | |
ac734d8b | 1605 | |
55b5d700 | 1606 | $encoding = lc($self->charset) unless defined $encoding; |
54310121 | 1607 | |
13548fdf | 1608 | # Need to sort out the DTD before it's okay to call escapeHTML(). |
ba056755 | 1609 | my(@result,$xml_dtd); |
3d1a2ec4 | 1610 | if ($dtd) { |
6b4ac661 | 1611 | if (defined(ref($dtd)) and (ref($dtd) eq 'ARRAY')) { |
3d1a2ec4 GS |
1612 | $dtd = $DEFAULT_DTD unless $dtd->[0] =~ m|^-//|; |
1613 | } else { | |
1614 | $dtd = $DEFAULT_DTD unless $dtd =~ m|^-//|; | |
1615 | } | |
1616 | } else { | |
6b4ac661 | 1617 | $dtd = $XHTML ? XHTML_DTD : $DEFAULT_DTD; |
3d1a2ec4 | 1618 | } |
ba056755 JH |
1619 | |
1620 | $xml_dtd++ if ref($dtd) eq 'ARRAY' && $dtd->[0] =~ /\bXHTML\b/i; | |
1621 | $xml_dtd++ if ref($dtd) eq '' && $dtd =~ /\bXHTML\b/i; | |
29ddc2a4 | 1622 | push @result,qq(<?xml version="1.0" encoding="$encoding"?>) if $xml_dtd && $declare_xml; |
ba056755 | 1623 | |
3d1a2ec4 | 1624 | if (ref($dtd) && ref($dtd) eq 'ARRAY') { |
b2d0d414 | 1625 | push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd->[0]"\n\t "$dtd->[1]">)); |
13548fdf | 1626 | $DTD_PUBLIC_IDENTIFIER = $dtd->[0]; |
3d1a2ec4 | 1627 | } else { |
03b9648d | 1628 | push(@result,qq(<!DOCTYPE html\n\tPUBLIC "$dtd">)); |
13548fdf RGS |
1629 | $DTD_PUBLIC_IDENTIFIER = $dtd; |
1630 | } | |
1631 | ||
1632 | # Now that we know whether we're using the HTML 3.2 DTD or not, it's okay to | |
1633 | # call escapeHTML(). Strangely enough, the title needs to be escaped as | |
1634 | # HTML while the author needs to be escaped as a URL. | |
1635 | $title = $self->escapeHTML($title || 'Untitled Document'); | |
1636 | $author = $self->escape($author); | |
1637 | ||
1638 | if ($DTD_PUBLIC_IDENTIFIER =~ /[^X]HTML (2\.0|3\.2)/i) { | |
1639 | $lang = "" unless defined $lang; | |
1640 | $XHTML = 0; | |
3d1a2ec4 | 1641 | } |
13548fdf RGS |
1642 | else { |
1643 | $lang = 'en-US' unless defined $lang; | |
1644 | } | |
1645 | ||
29ddc2a4 RGS |
1646 | my $lang_bits = $lang ne '' ? qq( lang="$lang" xml:lang="$lang") : ''; |
1647 | my $meta_bits = qq(<meta http-equiv="Content-Type" content="text/html; charset=$encoding" />) | |
1648 | if $XHTML && $encoding && !$declare_xml; | |
1649 | ||
1650 | push(@result,$XHTML ? qq(<html xmlns="http://www.w3.org/1999/xhtml"$lang_bits>\n<head>\n<title>$title</title>) | |
1651 | : ($lang ? qq(<html lang="$lang">) : "<html>") | |
8f3ccfa2 | 1652 | . "<head><title>$title</title>"); |
6b4ac661 JH |
1653 | if (defined $author) { |
1654 | push(@result,$XHTML ? "<link rev=\"made\" href=\"mailto:$author\" />" | |
29ddc2a4 | 1655 | : "<link rev=\"made\" href=\"mailto:$author\">"); |
6b4ac661 | 1656 | } |
54310121 | 1657 | |
1658 | if ($base || $xbase || $target) { | |
424ec8fa | 1659 | my $href = $xbase || $self->url('-path'=>1); |
6b4ac661 JH |
1660 | my $t = $target ? qq/ target="$target"/ : ''; |
1661 | push(@result,$XHTML ? qq(<base href="$href"$t />) : qq(<base href="$href"$t>)); | |
54310121 | 1662 | } |
1663 | ||
1664 | if ($meta && ref($meta) && (ref($meta) eq 'HASH')) { | |
6b4ac661 JH |
1665 | foreach (keys %$meta) { push(@result,$XHTML ? qq(<meta name="$_" content="$meta->{$_}" />) |
1666 | : qq(<meta name="$_" content="$meta->{$_}">)); } | |
54310121 | 1667 | } |
7d37aa8e LS |
1668 | |
1669 | push(@result,ref($head) ? @$head : $head) if $head; | |
1670 | ||
424ec8fa | 1671 | # handle the infrequently-used -style and -script parameters |
13548fdf | 1672 | push(@result,$self->_style($style)) if defined $style; |
424ec8fa | 1673 | push(@result,$self->_script($script)) if defined $script; |
29ddc2a4 | 1674 | push(@result,$meta_bits) if defined $meta_bits; |
424ec8fa GS |
1675 | |
1676 | # handle -noscript parameter | |
1677 | push(@result,<<END) if $noscript; | |
6b4ac661 | 1678 | <noscript> |
424ec8fa | 1679 | $noscript |
6b4ac661 | 1680 | </noscript> |
424ec8fa GS |
1681 | END |
1682 | ; | |
1683 | my($other) = @other ? " @other" : ''; | |
29ddc2a4 | 1684 | push(@result,"</head>\n<body$other>\n"); |
424ec8fa GS |
1685 | return join("\n",@result); |
1686 | } | |
1687 | END_OF_FUNC | |
1688 | ||
1689 | ### Method: _style | |
1690 | # internal method for generating a CSS style section | |
1691 | #### | |
1692 | '_style' => <<'END_OF_FUNC', | |
1693 | sub _style { | |
1694 | my ($self,$style) = @_; | |
1695 | my (@result); | |
8869a4b7 | 1696 | |
424ec8fa | 1697 | my $type = 'text/css'; |
0664a57d | 1698 | my $rel = 'stylesheet'; |
a3b3a725 | 1699 | |
8869a4b7 | 1700 | |
a3b3a725 JH |
1701 | my $cdata_start = $XHTML ? "\n<!--/* <![CDATA[ */" : "\n<!-- "; |
1702 | my $cdata_end = $XHTML ? "\n/* ]]> */-->\n" : " -->\n"; | |
1703 | ||
13548fdf | 1704 | my @s = ref($style) eq 'ARRAY' ? @$style : $style; |
bb8b3399 | 1705 | my $other = ''; |
13548fdf RGS |
1706 | |
1707 | for my $s (@s) { | |
1708 | if (ref($s)) { | |
0664a57d SP |
1709 | my($src,$code,$verbatim,$stype,$alternate,$foo,@other) = |
1710 | rearrange([qw(SRC CODE VERBATIM TYPE ALTERNATE FOO)], | |
13548fdf RGS |
1711 | ('-foo'=>'bar', |
1712 | ref($s) eq 'ARRAY' ? @$s : %$s)); | |
8869a4b7 SP |
1713 | my $type = defined $stype ? $stype : 'text/css'; |
1714 | my $rel = $alternate ? 'alternate stylesheet' : 'stylesheet'; | |
bb8b3399 | 1715 | $other = "@other" if @other; |
13548fdf RGS |
1716 | |
1717 | if (ref($src) eq "ARRAY") # Check to see if the $src variable is an array reference | |
1718 | { # If it is, push a LINK tag for each one | |
1719 | foreach $src (@$src) | |
1720 | { | |
0664a57d SP |
1721 | push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>) |
1722 | : qq(<link rel="$rel" type="$type" href="$src"$other>)) if $src; | |
13548fdf | 1723 | } |
6b4ac661 | 1724 | } |
13548fdf RGS |
1725 | else |
1726 | { # Otherwise, push the single -src, if it exists. | |
0664a57d SP |
1727 | push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>) |
1728 | : qq(<link rel="$rel" type="$type" href="$src"$other>) | |
13548fdf RGS |
1729 | ) if $src; |
1730 | } | |
1731 | if ($verbatim) { | |
1732 | my @v = ref($verbatim) eq 'ARRAY' ? @$verbatim : $verbatim; | |
1733 | push(@result, "<style type=\"text/css\">\n$_\n</style>") foreach @v; | |
1734 | } | |
1735 | my @c = ref($code) eq 'ARRAY' ? @$code : $code if $code; | |
1736 | push(@result,style({'type'=>$type},"$cdata_start\n$_\n$cdata_end")) foreach @c; | |
1737 | ||
1738 | } else { | |
1739 | my $src = $s; | |
0664a57d SP |
1740 | push(@result,$XHTML ? qq(<link rel="$rel" type="$type" href="$src" $other/>) |
1741 | : qq(<link rel="$rel" type="$type" href="$src"$other>)); | |
13548fdf | 1742 | } |
7d37aa8e | 1743 | } |
424ec8fa GS |
1744 | @result; |
1745 | } | |
1746 | END_OF_FUNC | |
1747 | ||
424ec8fa GS |
1748 | '_script' => <<'END_OF_FUNC', |
1749 | sub _script { | |
1750 | my ($self,$script) = @_; | |
1751 | my (@result); | |
a3b3a725 | 1752 | |
424ec8fa GS |
1753 | my (@scripts) = ref($script) eq 'ARRAY' ? @$script : ($script); |
1754 | foreach $script (@scripts) { | |
7d37aa8e LS |
1755 | my($src,$code,$language); |
1756 | if (ref($script)) { # script is a hash | |
8869a4b7 SP |
1757 | ($src,$code,$type) = |
1758 | rearrange(['SRC','CODE',['LANGUAGE','TYPE']], | |
7d37aa8e | 1759 | '-foo'=>'bar', # a trick to allow the '-' to be omitted |
3538e1d5 | 1760 | ref($script) eq 'ARRAY' ? @$script : %$script); |
8869a4b7 SP |
1761 | $type ||= 'text/javascript'; |
1762 | unless ($type =~ m!\w+/\w+!) { | |
1763 | $type =~ s/[\d.]+$//; | |
1764 | $type = "text/$type"; | |
3d1a2ec4 | 1765 | } |
7d37aa8e | 1766 | } else { |
8869a4b7 | 1767 | ($src,$code,$type) = ('',$script, 'text/javascript'); |
7d37aa8e | 1768 | } |
a3b3a725 JH |
1769 | |
1770 | my $comment = '//'; # javascript by default | |
1771 | $comment = '#' if $type=~/perl|tcl/i; | |
1772 | $comment = "'" if $type=~/vbscript/i; | |
1773 | ||
58129083 JH |
1774 | my ($cdata_start,$cdata_end); |
1775 | if ($XHTML) { | |
1776 | $cdata_start = "$comment<![CDATA[\n"; | |
1777 | $cdata_end .= "\n$comment]]>"; | |
1778 | } else { | |
1779 | $cdata_start = "\n<!-- Hide script\n"; | |
1780 | $cdata_end = $comment; | |
1781 | $cdata_end .= " End script hiding -->\n"; | |
1782 | } | |
1783 | my(@satts); | |
1784 | push(@satts,'src'=>$src) if $src; | |
58129083 | 1785 | push(@satts,'type'=>$type); |
29ddc2a4 RGS |
1786 | $code = $cdata_start . $code . $cdata_end if defined $code; |
1787 | push(@result,$self->script({@satts},$code || '')); | |
7d37aa8e | 1788 | } |
424ec8fa | 1789 | @result; |
54310121 | 1790 | } |
1791 | END_OF_FUNC | |
1792 | ||
54310121 | 1793 | #### Method: end_html |
1794 | # End an HTML document. | |
3acbd4f5 | 1795 | # Trivial method for completeness. Just returns "</body>" |
54310121 | 1796 | #### |
1797 | 'end_html' => <<'END_OF_FUNC', | |
1798 | sub end_html { | |
29ddc2a4 | 1799 | return "\n</body>\n</html>"; |
54310121 | 1800 | } |
1801 | END_OF_FUNC | |
1802 | ||
1803 | ||
1804 | ################################ | |
1805 | # METHODS USED IN BUILDING FORMS | |
1806 | ################################ | |
1807 | ||
1808 | #### Method: isindex | |
1809 | # Just prints out the isindex tag. | |
1810 | # Parameters: | |
1811 | # $action -> optional URL of script to run | |
1812 | # Returns: | |
188ba755 | 1813 | # A string containing a <isindex> tag |
54310121 | 1814 | 'isindex' => <<'END_OF_FUNC', |
1815 | sub isindex { | |
1816 | my($self,@p) = self_or_default(@_); | |
3d1a2ec4 | 1817 | my($action,@other) = rearrange([ACTION],@p); |
188ba755 | 1818 | $action = qq/ action="$action"/ if $action; |
54310121 | 1819 | my($other) = @other ? " @other" : ''; |
188ba755 | 1820 | return $XHTML ? "<isindex$action$other />" : "<isindex$action$other>"; |
54310121 | 1821 | } |
1822 | END_OF_FUNC | |
1823 | ||
1824 | ||
1825 | #### Method: startform | |
1826 | # Start a form | |
1827 | # Parameters: | |
1828 | # $method -> optional submission method to use (GET or POST) | |
1829 | # $action -> optional URL of script to run | |
1830 | # $enctype ->encoding to use (URL_ENCODED or MULTIPART) | |
1831 | 'startform' => <<'END_OF_FUNC', | |
1832 | sub startform { | |
1833 | my($self,@p) = self_or_default(@_); | |
1834 | ||
1835 | my($method,$action,$enctype,@other) = | |
3d1a2ec4 | 1836 | rearrange([METHOD,ACTION,ENCTYPE],@p); |
54310121 | 1837 | |
8c32f149 | 1838 | $method = $self->escapeHTML(lc($method || 'post')); |
13548fdf RGS |
1839 | $enctype = $self->escapeHTML($enctype || &URL_ENCODED); |
1840 | if (defined $action) { | |
1841 | $action = $self->escapeHTML($action); | |
1842 | } | |
1843 | else { | |
0664a57d | 1844 | $action = $self->escapeHTML($self->request_uri || $self->self_url); |
03b9648d JH |
1845 | } |
1846 | $action = qq(action="$action"); | |
54310121 | 1847 | my($other) = @other ? " @other" : ''; |
1848 | $self->{'.parametersToAdd'}={}; | |
6b4ac661 | 1849 | return qq/<form method="$method" $action enctype="$enctype"$other>\n/; |
54310121 | 1850 | } |
1851 | END_OF_FUNC | |
1852 | ||
1853 | ||
1854 | #### Method: start_form | |
1855 | # synonym for startform | |
1856 | 'start_form' => <<'END_OF_FUNC', | |
1857 | sub start_form { | |
29ddc2a4 | 1858 | $XHTML ? &start_multipart_form : &startform; |
54310121 | 1859 | } |
1860 | END_OF_FUNC | |
1861 | ||
71f3e297 JH |
1862 | 'end_multipart_form' => <<'END_OF_FUNC', |
1863 | sub end_multipart_form { | |
1864 | &endform; | |
1865 | } | |
1866 | END_OF_FUNC | |
54310121 | 1867 | |
1868 | #### Method: start_multipart_form | |
1869 | # synonym for startform | |
1870 | 'start_multipart_form' => <<'END_OF_FUNC', | |
1871 | sub start_multipart_form { | |
1872 | my($self,@p) = self_or_default(@_); | |
0a9bdad4 | 1873 | if (defined($p[0]) && substr($p[0],0,1) eq '-') { |
adb86593 | 1874 | return $self->startform(-enctype=>&MULTIPART,@p); |
54310121 | 1875 | } else { |
1876 | my($method,$action,@other) = | |
3d1a2ec4 | 1877 | rearrange([METHOD,ACTION],@p); |
54310121 | 1878 | return $self->startform($method,$action,&MULTIPART,@other); |
1879 | } | |
1880 | } | |
1881 | END_OF_FUNC | |
1882 | ||
1883 | ||
1884 | #### Method: endform | |
1885 | # End a form | |
1886 | 'endform' => <<'END_OF_FUNC', | |
1887 | sub endform { | |
0a9bdad4 | 1888 | my($self,@p) = self_or_default(@_); |
3d1a2ec4 | 1889 | if ( $NOSTICKY ) { |
6b4ac661 | 1890 | return wantarray ? ("</form>") : "\n</form>"; |
3d1a2ec4 | 1891 | } else { |
0a9bdad4 SP |
1892 | if (my @fields = $self->get_fields) { |
1893 | return wantarray ? ("<div>",@fields,"</div>","</form>") | |
1894 | : "<div>".(join '',@fields)."</div>\n</form>"; | |
1895 | } else { | |
1896 | return "</form>"; | |
1897 | } | |
3d1a2ec4 | 1898 | } |
54310121 | 1899 | } |
1900 | END_OF_FUNC | |
1901 | ||
1902 | ||
424ec8fa GS |
1903 | '_textfield' => <<'END_OF_FUNC', |
1904 | sub _textfield { | |
1905 | my($self,$tag,@p) = self_or_default(@_); | |
29ddc2a4 RGS |
1906 | my($name,$default,$size,$maxlength,$override,$tabindex,@other) = |
1907 | rearrange([NAME,[DEFAULT,VALUE,VALUES],SIZE,MAXLENGTH,[OVERRIDE,FORCE],TABINDEX],@p); | |
424ec8fa GS |
1908 | |
1909 | my $current = $override ? $default : | |
1910 | (defined($self->param($name)) ? $self->param($name) : $default); | |
1911 | ||
a3b3a725 | 1912 | $current = defined($current) ? $self->escapeHTML($current,1) : ''; |
424ec8fa | 1913 | $name = defined($name) ? $self->escapeHTML($name) : ''; |
ba056755 JH |
1914 | my($s) = defined($size) ? qq/ size="$size"/ : ''; |
1915 | my($m) = defined($maxlength) ? qq/ maxlength="$maxlength"/ : ''; | |
71f3e297 JH |
1916 | my($other) = @other ? " @other" : ''; |
1917 | # this entered at cristy's request to fix problems with file upload fields | |
1918 | # and WebTV -- not sure it won't break stuff | |
6b4ac661 | 1919 | my($value) = $current ne '' ? qq(value="$current") : ''; |
29ddc2a4 | 1920 | $tabindex = $self->element_tab($tabindex); |
0a9bdad4 | 1921 | return $XHTML ? qq(<input type="$tag" name="$name" $tabindex$value$s$m$other />) |
b2d0d414 | 1922 | : qq(<input type="$tag" name="$name" $value$s$m$other>); |
424ec8fa GS |
1923 | } |
1924 | END_OF_FUNC | |
1925 | ||
54310121 | 1926 | #### Method: textfield |
1927 | # Parameters: | |
1928 | # $name -> Name of the text field | |
1929 | # $default -> Optional default value of the field if not | |
1930 | # already defined. | |
1931 | # $size -> Optional width of field in characaters. | |
1932 | # $maxlength -> Optional maximum number of characters. | |
1933 | # Returns: | |
188ba755 | 1934 | # A string containing a <input type="text"> field |
54310121 | 1935 | # |
1936 | 'textfield' => <<'END_OF_FUNC', | |
1937 | sub textfield { | |
1938 | my($self,@p) = self_or_default(@_); | |
424ec8fa | 1939 | $self->_textfield('text',@p); |
54310121 | 1940 | } |
1941 | END_OF_FUNC | |
1942 | ||
1943 | ||
1944 | #### Method: filefield | |
1945 | # Parameters: | |
1946 | # $name -> Name of the file upload field | |
1947 | # $size -> Optional width of field in characaters. | |
1948 | # $maxlength -> Optional maximum number of characters. | |
1949 | # Returns: | |
188ba755 | 1950 | # A string containing a <input type="file"> field |
54310121 | 1951 | # |
1952 | 'filefield' => <<'END_OF_FUNC', | |
1953 | sub filefield { | |
1954 | my($self,@p) = self_or_default(@_); | |
424ec8fa | 1955 | $self->_textfield('file',@p); |
54310121 | 1956 | } |
1957 | END_OF_FUNC | |
1958 | ||
1959 | ||
1960 | #### Method: password | |
1961 | # Create a "secret password" entry field | |
1962 | # Parameters: | |
1963 | # $name -> Name of the field | |
1964 | # $default -> Optional default value of the field if not | |
1965 | # already defined. | |
1966 | # $size -> Optional width of field in characters. | |
1967 | # $maxlength -> Optional maximum characters that can be entered. | |
1968 | # Returns: | |
188ba755 | 1969 | # A string containing a <input type="password"> field |
54310121 | 1970 | # |
1971 | 'password_field' => <<'END_OF_FUNC', | |
1972 | sub password_field { | |
1973 | my ($self,@p) = self_or_default(@_); | |
424ec8fa | 1974 | $self->_textfield('password',@p); |
54310121 | 1975 | } |
1976 | END_OF_FUNC | |
1977 | ||
54310121 | 1978 | #### Method: textarea |
1979 | # Parameters: | |
1980 | # $name -> Name of the text field | |
1981 | # $default -> Optional default value of the field if not | |
1982 | # already defined. | |
1983 | # $rows -> Optional number of rows in text area | |
1984 | # $columns -> Optional number of columns in text area | |
1985 | # Returns: | |
3acbd4f5 | 1986 | # A string containing a <textarea></textarea> tag |
54310121 | 1987 | # |
1988 | 'textarea' => <<'END_OF_FUNC', | |
1989 | sub textarea { | |
1990 | my($self,@p) = self_or_default(@_); | |
29ddc2a4 RGS |
1991 | my($name,$default,$rows,$cols,$override,$tabindex,@other) = |
1992 | rearrange([NAME,[DEFAULT,VALUE],ROWS,[COLS,COLUMNS],[OVERRIDE,FORCE],TABINDEX],@p); | |
54310121 | 1993 | |
1994 | my($current)= $override ? $default : | |
1995 | (defined($self->param($name)) ? $self->param($name) : $default); | |
1996 | ||
1997 | $name = defined($name) ? $self->escapeHTML($name) : ''; | |
1998 | $current = defined($current) ? $self->escapeHTML($current) : ''; | |
3acbd4f5 JH |
1999 | my($r) = $rows ? qq/ rows="$rows"/ : ''; |
2000 | my($c) = $cols ? qq/ cols="$cols"/ : ''; | |
54310121 | 2001 | my($other) = @other ? " @other" : ''; |
29ddc2a4 | 2002 | $tabindex = $self->element_tab($tabindex); |
0a9bdad4 | 2003 | return qq{<textarea name="$name" $tabindex$r$c$other>$current</textarea>}; |
54310121 | 2004 | } |
2005 | END_OF_FUNC | |
2006 | ||
2007 | ||
2008 | #### Method: button | |
2009 | # Create a javascript button. | |
2010 | # Parameters: | |
2011 | # $name -> (optional) Name for the button. (-name) | |
2012 | # $value -> (optional) Value of the button when selected (and visible name) (-value) | |
2013 | # $onclick -> (optional) Text of the JavaScript to run when the button is | |
2014 | # clicked. | |
2015 | # Returns: | |
188ba755 | 2016 | # A string containing a <input type="button"> tag |
54310121 | 2017 | #### |
2018 | 'button' => <<'END_OF_FUNC', | |
2019 | sub button { | |
2020 | my($self,@p) = self_or_default(@_); | |
2021 | ||
29ddc2a4 RGS |
2022 | my($label,$value,$script,$tabindex,@other) = rearrange([NAME,[VALUE,LABEL], |
2023 | [ONCLICK,SCRIPT],TABINDEX],@p); | |
54310121 | 2024 | |
2025 | $label=$self->escapeHTML($label); | |
a3b3a725 | 2026 | $value=$self->escapeHTML($value,1); |
54310121 | 2027 | $script=$self->escapeHTML($script); |
2028 | ||
2029 | my($name) = ''; | |
ba056755 | 2030 | $name = qq/ name="$label"/ if $label; |
54310121 | 2031 | $value = $value || $label; |
2032 | my($val) = ''; | |
6b4ac661 JH |
2033 | $val = qq/ value="$value"/ if $value; |
2034 | $script = qq/ onclick="$script"/ if $script; | |
54310121 | 2035 | my($other) = @other ? " @other" : ''; |
29ddc2a4 | 2036 | $tabindex = $self->element_tab($tabindex); |
0a9bdad4 | 2037 | return $XHTML ? qq(<input type="button" $tabindex$name$val$script$other />) |
b2d0d414 | 2038 | : qq(<input type="button"$name$val$script$other>); |
54310121 | 2039 | } |
2040 | END_OF_FUNC | |
2041 | ||
2042 | ||
2043 | #### Method: submit | |
2044 | # Create a "submit query" button. | |
2045 | # Parameters: | |
2046 | # $name -> (optional) Name for the button. | |
2047 | # $value -> (optional) Value of the button when selected (also doubles as label). | |
2048 | # $label -> (optional) Label printed on the button(also doubles as the value). | |
2049 | # Returns: | |
188ba755 | 2050 | # A string containing a <input type="submit"> tag |
54310121 | 2051 | #### |
2052 | 'submit' => <<'END_OF_FUNC', | |
2053 | sub submit { | |
2054 | my($self,@p) = self_or_default(@_); | |
2055 | ||
29ddc2a4 | 2056 | my($label,$value,$tabindex,@other) = rearrange([NAME,[VALUE,LABEL],TABINDEX],@p); |
54310121 | 2057 | |
2058 | $label=$self->escapeHTML($label); | |
a3b3a725 | 2059 | $value=$self->escapeHTML($value,1); |
54310121 | 2060 | |
0a9bdad4 SP |
2061 | my $name = $NOSTICKY ? '' : 'name=".submit" '; |
2062 | $name = qq/name="$label" / if defined($label); | |
424ec8fa | 2063 | $value = defined($value) ? $value : $label; |
8f3ccfa2 | 2064 | my $val = ''; |
0a9bdad4 | 2065 | $val = qq/value="$value" / if defined($value); |
29ddc2a4 | 2066 | $tabindex = $self->element_tab($tabindex); |
0a9bdad4 SP |
2067 | my($other) = @other ? "@other " : ''; |
2068 | return $XHTML ? qq(<input type="submit" $tabindex$name$val$other/>) | |
2069 | : qq(<input type="submit" $name$val$other>); | |
54310121 | 2070 | } |
2071 | END_OF_FUNC | |
2072 | ||
2073 | ||
2074 | #### Method: reset | |
2075 | # Create a "reset" button. | |
2076 | # Parameters: | |
2077 | # $name -> (optional) Name for the button. | |
2078 | # Returns: | |
188ba755 | 2079 | # A string containing a <input type="reset"> tag |
54310121 | 2080 | #### |
2081 | 'reset' => <<'END_OF_FUNC', | |
2082 | sub reset { | |
2083 | my($self,@p) = self_or_default(@_); | |
29ddc2a4 | 2084 | my($label,$value,$tabindex,@other) = rearrange(['NAME',['VALUE','LABEL'],TABINDEX],@p); |
54310121 | 2085 | $label=$self->escapeHTML($label); |
8f3ccfa2 JH |
2086 | $value=$self->escapeHTML($value,1); |
2087 | my ($name) = ' name=".reset"'; | |
2088 | $name = qq/ name="$label"/ if defined($label); | |
2089 | $value = defined($value) ? $value : $label; | |
2090 | my($val) = ''; | |
2091 | $val = qq/ value="$value"/ if defined($value); | |
54310121 | 2092 | my($other) = @other ? " @other" : ''; |
29ddc2a4 | 2093 | $tabindex = $self->element_tab($tabindex); |
0a9bdad4 | 2094 | return $XHTML ? qq(<input type="reset" $tabindex$name$val$other />) |
8f3ccfa2 | 2095 | : qq(<input type="reset"$name$val$other>); |
54310121 | 2096 | } |
2097 | END_OF_FUNC | |
2098 | ||
2099 | ||
2100 | #### Method: defaults | |
2101 | # Create a "defaults" button. | |
2102 | # Parameters: | |
2103 | # $name -> (optional) Name for the button. | |
2104 | # Returns: | |
188ba755 | 2105 | # A string containing a <input type="submit" name=".defaults"> tag |
54310121 | 2106 | # |
2107 | # Note: this button has a special meaning to the initialization script, | |
2108 | # and tells it to ERASE the current query string so that your defaults | |
2109 | # are used again! | |
2110 | #### | |
2111 | 'defaults' => <<'END_OF_FUNC', | |
2112 | sub defaults { | |
2113 | my($self,@p) = self_or_default(@_); | |
2114 | ||
29ddc2a4 | 2115 | my($label,$tabindex,@other) = rearrange([[NAME,VALUE],TABINDEX],@p); |
54310121 | 2116 | |
a3b3a725 | 2117 | $label=$self->escapeHTML($label,1); |
54310121 | 2118 | $label = $label || "Defaults"; |
6b4ac661 | 2119 | my($value) = qq/ value="$label"/; |
54310121 | 2120 | my($other) = @other ? " @other" : ''; |
29ddc2a4 | 2121 | $tabindex = $self->element_tab($tabindex); |
0a9bdad4 | 2122 | return $XHTML ? qq(<input type="submit" name=".defaults" $tabindex$value$other />) |
6b4ac661 | 2123 | : qq/<input type="submit" NAME=".defaults"$value$other>/; |
54310121 | 2124 | } |
2125 | END_OF_FUNC | |
2126 | ||
2127 | ||
424ec8fa GS |
2128 | #### Method: comment |
2129 | # Create an HTML <!-- comment --> | |
2130 | # Parameters: a string | |
2131 | 'comment' => <<'END_OF_FUNC', | |
2132 | sub comment { | |
2133 | my($self,@p) = self_or_CGI(@_); | |
2134 | return "<!-- @p -->"; | |
2135 | } | |
2136 | END_OF_FUNC | |
2137 | ||
54310121 | 2138 | #### Method: checkbox |
2139 | # Create a checkbox that is not logically linked to any others. | |
2140 | # The field value is "on" when the button is checked. | |
2141 | # Parameters: | |
2142 | # $name -> Name of the checkbox | |
2143 | # $checked -> (optional) turned on by default if true | |
2144 | # $value -> (optional) value of the checkbox, 'on' by default | |
2145 | # $label -> (optional) a user-readable label printed next to the box. | |
2146 | # Otherwise the checkbox name is used. | |
2147 | # Returns: | |
188ba755 | 2148 | # A string containing a <input type="checkbox"> field |
54310121 | 2149 | #### |
2150 | 'checkbox' => <<'END_OF_FUNC', | |
2151 | sub checkbox { | |
2152 | my($self,@p) = self_or_default(@_); | |
2153 | ||
bb8b3399 SP |
2154 | my($name,$checked,$value,$label,$labelattributes,$override,$tabindex,@other) = |
2155 | rearrange([NAME,[CHECKED,SELECTED,ON],VALUE,LABEL,LABELATTRIBUTES, | |
2156 | [OVERRIDE,FORCE],TABINDEX],@p); | |
29ddc2a4 | 2157 | |
424ec8fa GS |
2158 | $value = defined $value ? $value : 'on'; |
2159 | ||
2160 | if (!$override && ($self->{'.fieldnames'}->{$name} || | |
2161 | defined $self->param($name))) { | |
3acbd4f5 | 2162 | $checked = grep($_ eq $value,$self->param($name)) ? $self->_checked(1) : ''; |
54310121 | 2163 | } else { |
3acbd4f5 | 2164 | $checked = $self->_checked($checked); |
54310121 | 2165 | } |
2166 | my($the_label) = defined $label ? $label : $name; | |
2167 | $name = $self->escapeHTML($name); | |
a3b3a725 | 2168 | $value = $self->escapeHTML($value,1); |
54310121 | 2169 | $the_label = $self->escapeHTML($the_label); |
0a9bdad4 | 2170 | my($other) = @other ? "@other " : ''; |
29ddc2a4 | 2171 | $tabindex = $self->element_tab($tabindex); |
54310121 | 2172 | $self->register_parameter($name); |
bb8b3399 SP |
2173 | return $XHTML ? CGI::label($labelattributes, |
2174 | qq{<input type="checkbox" name="$name" value="$value" $tabindex$checked$other/>$the_label}) | |
6b4ac661 | 2175 | : qq{<input type="checkbox" name="$name" value="$value"$checked$other>$the_label}; |
54310121 | 2176 | } |
2177 | END_OF_FUNC | |
2178 | ||
2179 | ||
54310121 | 2180 | |
54310121 | 2181 | # Escape HTML -- used internally |
2182 | 'escapeHTML' => <<'END_OF_FUNC', | |
2183 | sub escapeHTML { | |
ac734d8b JH |
2184 | # hack to work around earlier hacks |
2185 | push @_,$_[0] if @_==1 && $_[0] eq 'CGI'; | |
a3b3a725 | 2186 | my ($self,$toencode,$newlinestoo) = CGI::self_or_default(@_); |
6b4ac661 | 2187 | return undef unless defined($toencode); |
188ba755 | 2188 | return $toencode if ref($self) && !$self->{'escape'}; |
6b4ac661 JH |
2189 | $toencode =~ s{&}{&}gso; |
2190 | $toencode =~ s{<}{<}gso; | |
2191 | $toencode =~ s{>}{>}gso; | |
13548fdf RGS |
2192 | if ($DTD_PUBLIC_IDENTIFIER =~ /[^X]HTML 3\.2/i) { |
2193 | # $quot; was accidentally omitted from the HTML 3.2 DTD -- see | |
2194 | # <http://validator.w3.org/docs/errors.html#bad-entity> / | |
2195 | # <http://lists.w3.org/Archives/Public/www-html/1997Mar/0003.html>. | |
2196 | $toencode =~ s{"}{"}gso; | |
2197 | } | |
2198 | else { | |
2199 | $toencode =~ s{"}{"}gso; | |
2200 | } | |
89cc8928 JH |
2201 | # Handle bug in some browsers with Latin charsets |
2202 | if ($self->{'.charset'} && | |
2203 | (uc($self->{'.charset'}) eq 'ISO-8859-1' || | |
2204 | uc($self->{'.charset'}) eq 'WINDOWS-1252')) | |
2205 | { | |
ba056755 | 2206 | $toencode =~ s{'}{'}gso; |
188ba755 JH |
2207 | $toencode =~ s{\x8b}{‹}gso; |
2208 | $toencode =~ s{\x9b}{›}gso; | |
a3b3a725 JH |
2209 | if (defined $newlinestoo && $newlinestoo) { |
2210 | $toencode =~ s{\012}{ }gso; | |
2211 | $toencode =~ s{\015}{ }gso; | |
2212 | } | |
2213 | } | |
6b4ac661 | 2214 | return $toencode; |
54310121 | 2215 | } |
2216 | END_OF_FUNC | |
2217 | ||
424ec8fa GS |
2218 | # unescape HTML -- used internally |
2219 | 'unescapeHTML' => <<'END_OF_FUNC', | |
2220 | sub unescapeHTML { | |
efc8e943 NC |
2221 | # hack to work around earlier hacks |
2222 | push @_,$_[0] if @_==1 && $_[0] eq 'CGI'; | |
6b4ac661 | 2223 | my ($self,$string) = CGI::self_or_default(@_); |
424ec8fa | 2224 | return undef unless defined($string); |
a3b3a725 JH |
2225 | my $latin = defined $self->{'.charset'} ? $self->{'.charset'} =~ /^(ISO-8859-1|WINDOWS-1252)$/i |
2226 | : 1; | |
71f3e297 JH |
2227 | # thanks to Randal Schwartz for the correct solution to this one |
2228 | $string=~ s[&(.*?);]{ | |
2229 | local $_ = $1; | |
2230 | /^amp$/i ? "&" : | |
2231 | /^quot$/i ? '"' : | |
2232 | /^gt$/i ? ">" : | |
2233 | /^lt$/i ? "<" : | |
6b4ac661 JH |
2234 | /^#(\d+)$/ && $latin ? chr($1) : |
2235 | /^#x([0-9a-f]+)$/i && $latin ? chr(hex($1)) : | |
71f3e297 JH |
2236 | $_ |
2237 | }gex; | |
424ec8fa GS |
2238 | return $string; |
2239 | } | |
2240 | END_OF_FUNC | |
54310121 | 2241 | |
2242 | # Internal procedure - don't use | |
2243 | '_tableize' => <<'END_OF_FUNC', | |
2244 | sub _tableize { | |
2245 | my($rows,$columns,$rowheaders,$colheaders,@elements) = @_; | |
29ddc2a4 RGS |
2246 | my @rowheaders = $rowheaders ? @$rowheaders : (); |
2247 | my @colheaders = $colheaders ? @$colheaders : (); | |
54310121 | 2248 | my($result); |
2249 | ||
424ec8fa GS |
2250 | if (defined($columns)) { |
2251 | $rows = int(0.99 + @elements/$columns) unless defined($rows); | |
2252 | } | |
2253 | if (defined($rows)) { | |
2254 | $columns = int(0.99 + @elements/$rows) unless defined($columns); | |
2255 | } | |
29ddc2a4 | 2256 | |
54310121 | 2257 | # rearrange into a pretty table |
6b4ac661 | 2258 | $result = "<table>"; |
54310121 | 2259 | my($row,$column); |
29ddc2a4 RGS |
2260 | unshift(@colheaders,'') if @colheaders && @rowheaders; |
2261 | $result .= "<tr>" if @colheaders; | |
2262 | foreach (@colheaders) { | |
6b4ac661 | 2263 | $result .= "<th>$_</th>"; |
54310121 | 2264 | } |
2265 | for ($row=0;$row<$rows;$row++) { | |
6b4ac661 | 2266 | $result .= "<tr>"; |
29ddc2a4 | 2267 | $result .= "<th>$rowheaders[$row]</th>" if @rowheaders; |
54310121 | 2268 | for ($column=0;$column<$columns;$column++) { |
6b4ac661 | 2269 | $result .= "<td>" . $elements[$column*$rows + $row] . "</td>" |
424ec8fa | 2270 | if defined($elements[$column*$rows + $row]); |
54310121 | 2271 | } |
6b4ac661 | 2272 | $result .= "</tr>"; |
54310121 | 2273 | } |
6b4ac661 | 2274 | $result .= "</table>"; |
54310121 | 2275 | return $result; |
2276 | } | |
2277 | END_OF_FUNC | |
2278 | ||
2279 | ||
2280 | #### Method: radio_group | |
2281 | # Create a list of logically-linked radio buttons. | |
2282 | # Parameters: | |
2283 | # $name -> Common name for all the buttons. | |
2284 | # $values -> A pointer to a regular array containing the | |
2285 | # values for each button in the group. | |
2286 | # $default -> (optional) Value of the button to turn on by default. Pass '-' | |
2287 | # to turn _nothing_ on. | |
2288 | # $linebreak -> (optional) Set to true to place linebreaks | |
2289 | # between the buttons. | |
2290 | # $labels -> (optional) | |
2291 | # A pointer to an associative array of labels to print next to each checkbox | |
2292 | # in the form $label{'value'}="Long explanatory label". | |
2293 | # Otherwise the provided values are used as the labels. | |
2294 | # Returns: | |
188ba755 | 2295 | # An ARRAY containing a series of <input type="radio"> fields |
54310121 | 2296 | #### |
2297 | 'radio_group' => <<'END_OF_FUNC', | |
2298 | sub radio_group { | |
2299 | my($self,@p) = self_or_default(@_); | |
29ddc2a4 RGS |
2300 | $self->_box_group('radio',@p); |
2301 | } | |
2302 | END_OF_FUNC | |
2303 | ||
2304 | #### Method: checkbox_group | |
2305 | # Create a list of logically-linked checkboxes. | |
2306 | # Parameters: | |
2307 | # $name -> Common name for all the check boxes | |
2308 | # $values -> A pointer to a regular array containing the | |
2309 | # values for each checkbox in the group. | |
2310 | # $defaults -> (optional) | |
2311 | # 1. If a pointer to a regular array of checkbox values, | |
2312 | # then this will be used to decide which | |
2313 | # checkboxes to turn on by default. | |
2314 | # 2. If a scalar, will be assumed to hold the | |
2315 | # value of a single checkbox in the group to turn on. | |
2316 | # $linebreak -> (optional) Set to true to place linebreaks | |
2317 | # between the buttons. | |
2318 | # $labels -> (optional) | |
2319 | # A pointer to an associative array of labels to print next to each checkbox | |
2320 | # in the form $label{'value'}="Long explanatory label". | |
2321 | # Otherwise the provided values are used as the labels. | |
2322 | # Returns: | |
2323 | # An ARRAY containing a series of <input type="checkbox"> fields | |
2324 | #### | |
2325 | ||
2326 | 'checkbox_group' => <<'END_OF_FUNC', | |
2327 | sub checkbox_group { | |
2328 | my($self,@p) = self_or_default(@_); | |
2329 | $self->_box_group('checkbox',@p); | |
2330 | } | |
2331 | END_OF_FUNC | |
54310121 | 2332 | |
29ddc2a4 RGS |
2333 | '_box_group' => <<'END_OF_FUNC', |
2334 | sub _box_group { | |
2335 | my $self = shift; | |
2336 | my $box_type = shift; | |
2337 | ||
bb8b3399 SP |
2338 | my($name,$values,$defaults,$linebreak,$labels,$labelattributes, |
2339 | $attributes,$rows,$columns,$rowheaders,$colheaders, | |
8869a4b7 | 2340 | $override,$nolabels,$tabindex,$disabled,@other) = |
bb8b3399 SP |
2341 | rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LINEBREAK,LABELS,LABELATTRIBUTES, |
2342 | ATTRIBUTES,ROWS,[COLUMNS,COLS],[ROWHEADERS,ROWHEADER],[COLHEADERS,COLHEADER], | |
2343 | [OVERRIDE,FORCE],NOLABELS,TABINDEX,DISABLED | |
2344 | ],@_); | |
2345 | ||
54310121 | 2346 | |
8869a4b7 | 2347 | my($result,$checked,@elements,@values); |
29ddc2a4 | 2348 | |
424ec8fa | 2349 | @values = $self->_set_values_and_labels($values,\$labels,$name); |
29ddc2a4 | 2350 | my %checked = $self->previous_or_default($name,$defaults,$override); |
424ec8fa | 2351 | |
71f3e297 | 2352 | # If no check array is specified, check the first by default |
29ddc2a4 RGS |
2353 | $checked{$values[0]}++ if $box_type eq 'radio' && !%checked; |
2354 | ||
71f3e297 JH |
2355 | $name=$self->escapeHTML($name); |
2356 | ||
29ddc2a4 | 2357 | my %tabs = (); |
0a9bdad4 | 2358 | if ($TABINDEX && $tabindex) { |
29ddc2a4 RGS |
2359 | if (!ref $tabindex) { |
2360 | $self->element_tab($tabindex); | |
2361 | } elsif (ref $tabindex eq 'ARRAY') { | |
2362 | %tabs = map {$_=>$self->element_tab} @$tabindex; | |
2363 | } elsif (ref $tabindex eq 'HASH') { | |
2364 | %tabs = %$tabindex; | |
2365 | } | |
2366 | } | |
2367 | %tabs = map {$_=>$self->element_tab} @values unless %tabs; | |
0a9bdad4 | 2368 | my $other = @other ? "@other " : ''; |
29ddc2a4 | 2369 | my $radio_checked; |
8869a4b7 SP |
2370 | |
2371 | # for disabling groups of radio/checkbox buttons | |
2372 | my %disabled; | |
2373 | foreach (@{$disabled}) { | |
2374 | $disabled{$_}=1; | |
2375 | } | |
2376 | ||
54310121 | 2377 | foreach (@values) { |
8869a4b7 SP |
2378 | my $disable=""; |
2379 | if ($disabled{$_}) { | |
2380 | $disable="disabled='1'"; | |
2381 | } | |
2382 | ||
29ddc2a4 RGS |
2383 | my $checkit = $self->_checked($box_type eq 'radio' ? ($checked{$_} && !$radio_checked++) |
2384 | : $checked{$_}); | |
6b4ac661 JH |
2385 | my($break); |
2386 | if ($linebreak) { | |
ba056755 | 2387 | $break = $XHTML ? "<br />" : "<br>"; |
6b4ac661 JH |
2388 | } |
2389 | else { | |
ba056755 | 2390 | $break = ''; |
6b4ac661 | 2391 | } |
54310121 | 2392 | my($label)=''; |
2393 | unless (defined($nolabels) && $nolabels) { | |
2394 | $label = $_; | |
424ec8fa | 2395 | $label = $labels->{$_} if defined($labels) && defined($labels->{$_}); |
a3b3a725 | 2396 | $label = $self->escapeHTML($label,1); |
8869a4b7 | 2397 | $label = "<span style=\"color:gray\">$label</span>" if $disabled{$_}; |
54310121 | 2398 | } |
29ddc2a4 | 2399 | my $attribs = $self->_set_attributes($_, $attributes); |
0a9bdad4 | 2400 | my $tab = $tabs{$_}; |
54310121 | 2401 | $_=$self->escapeHTML($_); |
8869a4b7 | 2402 | |
29ddc2a4 RGS |
2403 | if ($XHTML) { |
2404 | push @elements, | |
bb8b3399 | 2405 | CGI::label($labelattributes, |
8869a4b7 | 2406 | qq(<input type="$box_type" name="$name" value="$_" $checkit$other$tab$attribs$disable/>$label)).${break}; |
29ddc2a4 | 2407 | } else { |
8869a4b7 | 2408 | push(@elements,qq/<input type="$box_type" name="$name" value="$_"$checkit$other$tab$attribs$disable>${label}${break}/); |
29ddc2a4 | 2409 | } |
54310121 | 2410 | } |
2411 | $self->register_parameter($name); | |
29ddc2a4 | 2412 | return wantarray ? @elements : "@elements" |
424ec8fa | 2413 | unless defined($columns) || defined($rows); |
54310121 | 2414 | return _tableize($rows,$columns,$rowheaders,$colheaders,@elements); |
2415 | } | |
2416 | END_OF_FUNC | |
2417 | ||
2418 | ||
2419 | #### Method: popup_menu | |
2420 | # Create a popup menu. | |
2421 | # Parameters: | |
2422 | # $name -> Name for all the menu | |
2423 | # $values -> A pointer to a regular array containing the | |
2424 | # text of each menu item. | |
2425 | # $default -> (optional) Default item to display | |
2426 | # $labels -> (optional) | |
2427 | # A pointer to an associative array of labels to print next to each checkbox | |
2428 | # in the form $label{'value'}="Long explanatory label". | |
2429 | # Otherwise the provided values are used as the labels. | |
2430 | # Returns: | |
2431 | # A string containing the definition of a popup menu. | |
2432 | #### | |
2433 | 'popup_menu' => <<'END_OF_FUNC', | |
2434 | sub popup_menu { | |
2435 | my($self,@p) = self_or_default(@_); | |
2436 | ||
29ddc2a4 | 2437 | my($name,$values,$default,$labels,$attributes,$override,$tabindex,@other) = |
188ba755 | 2438 | rearrange([NAME,[VALUES,VALUE],[DEFAULT,DEFAULTS],LABELS, |
29ddc2a4 | 2439 | ATTRIBUTES,[OVERRIDE,FORCE],TABINDEX],@p); |
54310121 | 2440 | my($result,$selected); |
2441 | ||
2442 | if (!$override && defined($self->param($name))) { | |
2443 | $selected = $self->param($name); | |
2444 | } else { | |
2445 | $selected = $default; | |
2446 | } | |
2447 | $name=$self->escapeHTML($name); | |
2448 | my($other) = @other ? " @other" : ''; | |
2449 | ||
424ec8fa GS |
2450 | my(@values); |
2451 | @values = $self->_set_values_and_labels($values,\$labels,$name); | |
29ddc2a4 | 2452 | $tabindex = $self->element_tab($tabindex); |
0a9bdad4 | 2453 | $result = qq/<select name="$name" $tabindex$other>\n/; |
54310121 | 2454 | foreach (@values) { |
188ba755 JH |
2455 | if (/<optgroup/) { |
2456 | foreach (split(/\n/)) { | |
2457 | my $selectit = $XHTML ? 'selected="selected"' : 'selected'; | |
2458 | s/(value="$selected")/$selectit $1/ if defined $selected; | |
2459 | $result .= "$_\n"; | |
2460 | } | |
2461 | } | |
2462 | else { | |
cb3b230c SP |
2463 | my $attribs = $self->_set_attributes($_, $attributes); |
2464 | my($selectit) = defined($selected) ? $self->_selected($selected eq $_) : ''; | |
2465 | my($label) = $_; | |
2466 | $label = $labels->{$_} if defined($labels) && defined($labels->{$_}); | |
2467 | my($value) = $self->escapeHTML($_); | |
2468 | $label=$self->escapeHTML($label,1); | |
2469 | $result .= "<option${attribs} ${selectit}value=\"$value\">$label</option>\n"; | |
188ba755 | 2470 | } |
54310121 | 2471 | } |
2472 | ||
69c89ae7 | 2473 | $result .= "</select>"; |
54310121 | 2474 | return $result; |
2475 | } | |
2476 | END_OF_FUNC | |
2477 | ||
2478 | ||
188ba755 JH |
2479 | #### Method: optgroup |
2480 | # Create a optgroup. | |
2481 | # Parameters: | |
2482 | # $name -> Label for the group | |
2483 | # $values -> A pointer to a regular array containing the | |
2484 | # values for each option line in the group. | |
2485 | # $labels -> (optional) | |
2486 | # A pointer to an associative array of labels to print next to each item | |
2487 | # in the form $label{'value'}="Long explanatory label". | |
2488 | # Otherwise the provided values are used as the labels. | |
2489 | # $labeled -> (optional) | |
2490 | # A true value indicates the value should be used as the label attribute | |
2491 | # in the option elements. | |
2492 | # The label attribute specifies the option label presented to the user. | |
2493 | # This defaults to the content of the <option> element, but the label | |
2494 | # attribute allows authors to more easily use optgroup without sacrificing | |
2495 | # compatibility with browsers that do not support option groups. | |
2496 | # $novals -> (optional) | |
2497 | # A true value indicates to suppress the val attribute in the option elements | |
2498 | # Returns: | |
2499 | # A string containing the definition of an option group. | |
2500 | #### | |
2501 | 'optgroup' => <<'END_OF_FUNC', | |
2502 | sub optgroup { | |
2503 | my($self,@p) = self_or_default(@_); | |
2504 | my($name,$values,$attributes,$labeled,$noval,$labels,@other) | |
2505 | = rearrange([NAME,[VALUES,VALUE],ATTRIBUTES,LABELED,NOVALS,LABELS],@p); | |
2506 | ||
2507 | my($result,@values); | |
2508 | @values = $self->_set_values_and_labels($values,\$labels,$name,$labeled,$novals); | |
2509 | my($other) = @other ? " @other" : ''; | |
2510 | ||
2511 | $name=$self->escapeHTML($name); | |
2512 | $result = qq/<optgroup label="$name"$other>\n/; | |
2513 | foreach (@values) { | |
2514 | if (/<optgroup/) { | |
2515 | foreach (split(/\n/)) { | |
2516 | my $selectit = $XHTML ? 'selected="selected"' : 'selected'; | |
2517 | s/(value="$selected")/$selectit $1/ if defined $selected; | |
2518 | $result .= "$_\n"; | |
2519 | } | |
2520 | } | |
2521 | else { | |
2522 | my $attribs = $self->_set_attributes($_, $attributes); | |
2523 | my($label) = $_; | |
2524 | $label = $labels->{$_} if defined($labels) && defined($labels->{$_}); | |
2525 | $label=$self->escapeHTML($label); | |
2526 | my($value)=$self->escapeHTML($_,1); | |
2527 | $result .= $labeled ? $novals ? "<option$attribs label=\"$value\">$label</option>\n" | |
2528 | : "<option$attribs label=\"$value\" value=\"$value\">$label</option>\n" | |
2529 | : $novals ? "<option$attribs>$label</option>\n" | |
2530 | : "<option$attribs value=\"$value\">$label</option>\n"; | |
2531 | } | |
2532 | } | |
2533 | $result .= "</optgroup>"; | |
2534 | return $result; | |
2535 | } | |
2536 | END_OF_FUNC | |
2537 | ||
2538 | ||
54310121 | 2539 | #### Method: scrolling_list |
2540 | # Create a scrolling list. | |
2541 | # Parameters: | |
2542 | # $name -> name for the list | |
2543 | # $values -> A pointer to a regular array containing the | |
2544 | # values for each option line in the list. | |
2545 | # $defaults -> (optional) | |
2546 | # 1. If a pointer to a regular array of options, | |
2547 | # then this will be used to decide which | |
2548 | # lines to turn on by default. | |
2549 | # 2. Otherwise holds the value of the single line to turn on. | |
2550 | # $size -> (optional) Size of the list. | |
2551 | # $multiple -> (optional) If set, allow multiple selections. | |
2552 | # $labels -> (optional) | |
2553 | # A pointer to an associative array of labels to print next to each checkbox | |
2554 | # in the form $label{'value'}="Long explanatory label". | |
2555 | # Otherwise the provided values are used as the labels. | |
2556 | # Returns: | |
2557 | # A string containing the definition of a scrolling list. | |
2558 | #### | |
2559 | 'scrolling_list' => <<'END_OF_FUNC', | |
2560 | sub scrolling_list { | |
2561 | my($self,@p) = self_or_default(@_); | |
29ddc2a4 | 2562 | my($name,$values,$defaults,$size,$multiple,$labels,$attributes,$override,$tabindex,@other) |
3d1a2ec4 | 2563 | = rearrange([NAME,[VALUES,VALUE],[DEFAULTS,DEFAULT], |
29ddc2a4 | 2564 | SIZE,MULTIPLE,LABELS,ATTRIBUTES,[OVERRIDE,FORCE],TABINDEX],@p); |
54310121 | 2565 | |
424ec8fa GS |
2566 | my($result,@values); |
2567 | @values = $self->_set_values_and_labels($values,\$labels,$name); | |
2568 | ||
54310121 | 2569 | $size = $size || scalar(@values); |
2570 | ||
2571 | my(%selected) = $self->previous_or_default($name,$defaults,$override); | |
86de2d7d | 2572 | |
ac734d8b | 2573 | my($is_multiple) = $multiple ? qq/ multiple="multiple"/ : ''; |
6b4ac661 | 2574 | my($has_size) = $size ? qq/ size="$size"/: ''; |
54310121 | 2575 | my($other) = @other ? " @other" : ''; |
2576 | ||
2577 | $name=$self->escapeHTML($name); | |
29ddc2a4 | 2578 | $tabindex = $self->element_tab($tabindex); |
0a9bdad4 | 2579 | $result = qq/<select name="$name" $tabindex$has_size$is_multiple$other>\n/; |
54310121 | 2580 | foreach (@values) { |
3acbd4f5 | 2581 | my($selectit) = $self->_selected($selected{$_}); |
54310121 | 2582 | my($label) = $_; |
424ec8fa | 2583 | $label = $labels->{$_} if defined($labels) && defined($labels->{$_}); |
54310121 | 2584 | $label=$self->escapeHTML($label); |
a3b3a725 | 2585 | my($value)=$self->escapeHTML($_,1); |
188ba755 | 2586 | my $attribs = $self->_set_attributes($_, $attributes); |
1f426928 | 2587 | $result .= "<option ${selectit}${attribs}value=\"$value\">$label</option>\n"; |
54310121 | 2588 | } |
69c89ae7 | 2589 | $result .= "</select>"; |
54310121 | 2590 | $self->register_parameter($name); |
2591 | return $result; | |
2592 | } | |
2593 | END_OF_FUNC | |
2594 | ||
2595 | ||
2596 | #### Method: hidden | |
2597 | # Parameters: | |
2598 | # $name -> Name of the hidden field | |
2599 | # @default -> (optional) Initial values of field (may be an array) | |
2600 | # or | |
2601 | # $default->[initial values of field] | |
2602 | # Returns: | |
188ba755 | 2603 | # A string containing a <input type="hidden" name="name" value="value"> |
54310121 | 2604 | #### |
2605 | 'hidden' => <<'END_OF_FUNC', | |
2606 | sub hidden { | |
2607 | my($self,@p) = self_or_default(@_); | |
2608 | ||
2609 | # this is the one place where we departed from our standard | |
2610 | # calling scheme, so we have to special-case (darn) | |
2611 | my(@result,@value); | |
2612 | my($name,$default,$override,@other) = | |
3d1a2ec4 | 2613 | rearrange([NAME,[DEFAULT,VALUE,VALUES],[OVERRIDE,FORCE]],@p); |
54310121 | 2614 | |
2615 | my $do_override = 0; | |
3d1a2ec4 | 2616 | if ( ref($p[0]) || substr($p[0],0,1) eq '-') { |
54310121 | 2617 | @value = ref($default) ? @{$default} : $default; |
2618 | $do_override = $override; | |
2619 | } else { | |
2620 | foreach ($default,$override,@other) { | |
2621 | push(@value,$_) if defined($_); | |
2622 | } | |
2623 | } | |
2624 | ||
2625 | # use previous values if override is not set | |
2626 | my @prev = $self->param($name); | |
2627 | @value = @prev if !$do_override && @prev; | |
2628 | ||
2629 | $name=$self->escapeHTML($name); | |
2630 | foreach (@value) { | |
a3b3a725 | 2631 | $_ = defined($_) ? $self->escapeHTML($_,1) : ''; |
13548fdf RGS |
2632 | push @result,$XHTML ? qq(<input type="hidden" name="$name" value="$_" @other />) |
2633 | : qq(<input type="hidden" name="$name" value="$_" @other>); | |
54310121 | 2634 | } |
2635 | return wantarray ? @result : join('',@result); | |
2636 | } | |
2637 | END_OF_FUNC | |
2638 | ||
2639 | ||
2640 | #### Method: image_button | |
2641 | # Parameters: | |
2642 | # $name -> Name of the button | |
2643 | # $src -> URL of the image source | |
2644 | # $align -> Alignment style (TOP, BOTTOM or MIDDLE) | |
2645 | # Returns: | |
188ba755 | 2646 | # A string containing a <input type="image" name="name" src="url" align="alignment"> |
54310121 | 2647 | #### |
2648 | 'image_button' => <<'END_OF_FUNC', | |
2649 | sub image_button { | |
2650 | my($self,@p) = self_or_default(@_); | |
2651 | ||
2652 | my($name,$src,$alignment,@other) = | |
3d1a2ec4 | 2653 | rearrange([NAME,SRC,ALIGN],@p); |
54310121 | 2654 | |
0664a57d | 2655 | my($align) = $alignment ? " align=\L\"$alignment\"" : ''; |
54310121 | 2656 | my($other) = @other ? " @other" : ''; |
2657 | $name=$self->escapeHTML($name); | |
6b4ac661 JH |
2658 | return $XHTML ? qq(<input type="image" name="$name" src="$src"$align$other />) |
2659 | : qq/<input type="image" name="$name" src="$src"$align$other>/; | |
54310121 | 2660 | } |
2661 | END_OF_FUNC | |
2662 | ||
2663 | ||
2664 | #### Method: self_url | |
2665 | # Returns a URL containing the current script and all its | |
2666 | # param/value pairs arranged as a query. You can use this | |
2667 | # to create a link that, when selected, will reinvoke the | |
2668 | # script with all its state information preserved. | |
2669 | #### | |
2670 | 'self_url' => <<'END_OF_FUNC', | |
2671 | sub self_url { | |
424ec8fa GS |
2672 | my($self,@p) = self_or_default(@_); |
2673 | return $self->url('-path_info'=>1,'-query'=>1,'-full'=>1,@p); | |
54310121 | 2674 | } |
2675 | END_OF_FUNC | |
2676 | ||
2677 | ||
2678 | # This is provided as a synonym to self_url() for people unfortunate | |
2679 | # enough to have incorporated it into their programs already! | |
2680 | 'state' => <<'END_OF_FUNC', | |
2681 | sub state { | |
2682 | &self_url; | |
2683 | } | |
2684 | END_OF_FUNC | |
2685 | ||
2686 | ||
2687 | #### Method: url | |
2688 | # Like self_url, but doesn't return the query string part of | |
2689 | # the URL. | |
2690 | #### | |
2691 | 'url' => <<'END_OF_FUNC', | |
2692 | sub url { | |
424ec8fa | 2693 | my($self,@p) = self_or_default(@_); |
0a9bdad4 SP |
2694 | my ($relative,$absolute,$full,$path_info,$query,$base,$rewrite) = |
2695 | rearrange(['RELATIVE','ABSOLUTE','FULL',['PATH','PATH_INFO'],['QUERY','QUERY_STRING'],'BASE','REWRITE'],@p); | |
2696 | my $url = ''; | |
2371fea9 | 2697 | $full++ if $base || !($relative || $absolute); |
0a9bdad4 | 2698 | $rewrite++ unless defined $rewrite; |
424ec8fa | 2699 | |
0a9bdad4 SP |
2700 | my $path = $self->path_info; |
2701 | my $script_name = $self->script_name; | |
cb3b230c | 2702 | my $request_uri = unescape($self->request_uri) || ''; |
0a9bdad4 SP |
2703 | my $query_str = $self->query_string; |
2704 | ||
8c32f149 | 2705 | my $rewrite_in_use = $request_uri && $request_uri !~ /^\Q$script_name/; |
0a9bdad4 SP |
2706 | undef $path if $rewrite_in_use && $rewrite; # path not valid when rewriting active |
2707 | ||
2708 | my $uri = $rewrite && $request_uri ? $request_uri : $script_name; | |
edc47407 | 2709 | $uri =~ s/\?.*$//; # remove query string |
adb86593 | 2710 | $uri =~ s/\Q$path\E$// if defined $path; # remove path |
d45d855d | 2711 | |
424ec8fa GS |
2712 | if ($full) { |
2713 | my $protocol = $self->protocol(); | |
2714 | $url = "$protocol://"; | |
2c454cbd SP |
2715 | my $vh = http('x_forwarded_host') || http('host') || ''; |
2716 | $vh =~ s/\:\d+$//; # some clients add the port number (incorrectly). Get rid of it. | |
424ec8fa GS |
2717 | if ($vh) { |
2718 | $url .= $vh; | |
2719 | } else { | |
2720 | $url .= server_name(); | |
424ec8fa | 2721 | } |
8869a4b7 SP |
2722 | my $port = $self->server_port; |
2723 | $url .= ":" . $port | |
2724 | unless (lc($protocol) eq 'http' && $port == 80) | |
2725 | || (lc($protocol) eq 'https' && $port == 443); | |
03b9648d | 2726 | return $url if $base; |
0a9bdad4 | 2727 | $url .= $uri; |
424ec8fa | 2728 | } elsif ($relative) { |
cb3b230c | 2729 | ($url) = $uri =~ m!([^/]+)$!; |
424ec8fa | 2730 | } elsif ($absolute) { |
0a9bdad4 | 2731 | $url = $uri; |
424ec8fa | 2732 | } |
03b9648d | 2733 | |
0a9bdad4 SP |
2734 | $url .= $path if $path_info and defined $path; |
2735 | $url .= "?$query_str" if $query and $query_str ne ''; | |
c8d66bb3 | 2736 | $url ||= ''; |
2371fea9 | 2737 | $url =~ s/([^a-zA-Z0-9_.%;&?\/\\:+=~-])/sprintf("%%%02X",ord($1))/eg; |
424ec8fa | 2738 | return $url; |
54310121 | 2739 | } |
2740 | ||
2741 | END_OF_FUNC | |
2742 | ||
2743 | #### Method: cookie | |
2744 | # Set or read a cookie from the specified name. | |
2745 | # Cookie can then be passed to header(). | |
2746 | # Usual rules apply to the stickiness of -value. | |
2747 | # Parameters: | |
2748 | # -name -> name for this cookie (optional) | |
2749 | # -value -> value of this cookie (scalar, array or hash) | |
2750 | # -path -> paths for which this cookie is valid (optional) | |
2751 | # -domain -> internet domain in which this cookie is valid (optional) | |
2752 | # -secure -> if true, cookie only passed through secure channel (optional) | |
7d37aa8e | 2753 | # -expires -> expiry date in format Wdy, DD-Mon-YYYY HH:MM:SS GMT (optional) |
54310121 | 2754 | #### |
2755 | 'cookie' => <<'END_OF_FUNC', | |
54310121 | 2756 | sub cookie { |
2757 | my($self,@p) = self_or_default(@_); | |
fc786e8b SP |
2758 | my($name,$value,$path,$domain,$secure,$expires,$httponly) = |
2759 | rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES,HTTPONLY],@p); | |
54310121 | 2760 | |
424ec8fa | 2761 | require CGI::Cookie; |
54310121 | 2762 | |
2763 | # if no value is supplied, then we retrieve the | |
2764 | # value of the cookie, if any. For efficiency, we cache the parsed | |
424ec8fa GS |
2765 | # cookies in our state variables. |
2766 | unless ( defined($value) ) { | |
2767 | $self->{'.cookies'} = CGI::Cookie->fetch | |
2768 | unless $self->{'.cookies'}; | |
54310121 | 2769 | |
2770 | # If no name is supplied, then retrieve the names of all our cookies. | |
2771 | return () unless $self->{'.cookies'}; | |
424ec8fa GS |
2772 | return keys %{$self->{'.cookies'}} unless $name; |
2773 | return () unless $self->{'.cookies'}->{$name}; | |
2774 | return $self->{'.cookies'}->{$name}->value if defined($name) && $name ne ''; | |
54310121 | 2775 | } |
54310121 | 2776 | |
424ec8fa | 2777 | # If we get here, we're creating a new cookie |
ba056755 | 2778 | return undef unless defined($name) && $name ne ''; # this is an error |
54310121 | 2779 | |
424ec8fa GS |
2780 | my @param; |
2781 | push(@param,'-name'=>$name); | |
2782 | push(@param,'-value'=>$value); | |
2783 | push(@param,'-domain'=>$domain) if $domain; | |
2784 | push(@param,'-path'=>$path) if $path; | |
2785 | push(@param,'-expires'=>$expires) if $expires; | |
2786 | push(@param,'-secure'=>$secure) if $secure; | |
fc786e8b | 2787 | push(@param,'-httponly'=>$httponly) if $httponly; |
54310121 | 2788 | |
6b4ac661 | 2789 | return new CGI::Cookie(@param); |
54310121 | 2790 | } |
2791 | END_OF_FUNC | |
2792 | ||
424ec8fa GS |
2793 | 'parse_keywordlist' => <<'END_OF_FUNC', |
2794 | sub parse_keywordlist { | |
2795 | my($self,$tosplit) = @_; | |
2796 | $tosplit = unescape($tosplit); # unescape the keywords | |
2797 | $tosplit=~tr/+/ /; # pluses to spaces | |
2798 | my(@keywords) = split(/\s+/,$tosplit); | |
2799 | return @keywords; | |
2800 | } | |
2801 | END_OF_FUNC | |
2802 | ||
2803 | 'param_fetch' => <<'END_OF_FUNC', | |
2804 | sub param_fetch { | |
2805 | my($self,@p) = self_or_default(@_); | |
3d1a2ec4 | 2806 | my($name) = rearrange([NAME],@p); |
424ec8fa GS |
2807 | unless (exists($self->{$name})) { |
2808 | $self->add_parameter($name); | |
2809 | $self->{$name} = []; | |
2810 | } | |
2811 | ||
2812 | return $self->{$name}; | |
2813 | } | |
2814 | END_OF_FUNC | |
2815 | ||
54310121 | 2816 | ############################################### |
2817 | # OTHER INFORMATION PROVIDED BY THE ENVIRONMENT | |
2818 | ############################################### | |
2819 | ||
2820 | #### Method: path_info | |
2821 | # Return the extra virtual path information provided | |
2822 | # after the URL (if any) | |
2823 | #### | |
2824 | 'path_info' => <<'END_OF_FUNC', | |
2825 | sub path_info { | |
424ec8fa GS |
2826 | my ($self,$info) = self_or_default(@_); |
2827 | if (defined($info)) { | |
2828 | $info = "/$info" if $info ne '' && substr($info,0,1) ne '/'; | |
2829 | $self->{'.path_info'} = $info; | |
2830 | } elsif (! defined($self->{'.path_info'}) ) { | |
7dc108d1 SP |
2831 | my (undef,$path_info) = $self->_name_and_path_from_env; |
2832 | $self->{'.path_info'} = $path_info || ''; | |
424ec8fa GS |
2833 | } |
2834 | return $self->{'.path_info'}; | |
54310121 | 2835 | } |
2836 | END_OF_FUNC | |
2837 | ||
7dc108d1 SP |
2838 | # WE USE THIS TO COMPENSATE FOR A BUG IN APACHE 2 PRESENT AT LEAST UP THROUGH 2.0.54 |
2839 | '_name_and_path_from_env' => <<'END_OF_FUNC', | |
2840 | sub _name_and_path_from_env { | |
2841 | my $self = shift; | |
2842 | my $raw_script_name = $ENV{SCRIPT_NAME} || ''; | |
2843 | my $raw_path_info = $ENV{PATH_INFO} || ''; | |
cb3b230c | 2844 | my $uri = unescape($self->request_uri) || ''; |
7dc108d1 | 2845 | |
adb86593 SP |
2846 | my $protected = quotemeta($raw_path_info); |
2847 | $raw_script_name =~ s/$protected$//; | |
0a9bdad4 | 2848 | |
7dc108d1 SP |
2849 | my @uri_double_slashes = $uri =~ m^(/{2,}?)^g; |
2850 | my @path_double_slashes = "$raw_script_name $raw_path_info" =~ m^(/{2,}?)^g; | |
2851 | ||
2852 | my $apache_bug = @uri_double_slashes != @path_double_slashes; | |
2853 | return ($raw_script_name,$raw_path_info) unless $apache_bug; | |
2854 | ||
cb3b230c | 2855 | my $path_info_search = quotemeta($raw_path_info); |
7dc108d1 SP |
2856 | $path_info_search =~ s!/!/+!g; |
2857 | if ($uri =~ m/^(.+)($path_info_search)/) { | |
2858 | return ($1,$2); | |
2859 | } else { | |
2860 | return ($raw_script_name,$raw_path_info); | |
2861 | } | |
2862 | } | |
2863 | END_OF_FUNC | |
2864 | ||
54310121 | 2865 | |
2866 | #### Method: request_method | |
2867 | # Returns 'POST', 'GET', 'PUT' or 'HEAD' | |
2868 | #### | |
2869 | 'request_method' => <<'END_OF_FUNC', | |
2870 | sub request_method { | |
2871 | return $ENV{'REQUEST_METHOD'}; | |
2872 | } | |
2873 | END_OF_FUNC | |
2874 | ||
3538e1d5 GS |
2875 | #### Method: content_type |
2876 | # Returns the content_type string | |
2877 | #### | |
2878 | 'content_type' => <<'END_OF_FUNC', | |
2879 | sub content_type { | |
2880 | return $ENV{'CONTENT_TYPE'}; | |
2881 | } | |
2882 | END_OF_FUNC | |
2883 | ||
54310121 | 2884 | #### Method: path_translated |
2885 | # Return the physical path information provided | |
2886 | # by the URL (if any) | |
2887 | #### | |
2888 | 'path_translated' => <<'END_OF_FUNC', | |
2889 | sub path_translated { | |
2890 | return $ENV{'PATH_TRANSLATED'}; | |
2891 | } | |
2892 | END_OF_FUNC | |
2893 | ||
2894 | ||
7dc108d1 SP |
2895 | #### Method: request_uri |
2896 | # Return the literal request URI | |
2897 | #### | |
2898 | 'request_uri' => <<'END_OF_FUNC', | |
2899 | sub request_uri { | |
2900 | return $ENV{'REQUEST_URI'}; | |
2901 | } | |
2902 | END_OF_FUNC | |
2903 | ||
2904 | ||
54310121 | 2905 | #### Method: query_string |
2906 | # Synthesize a query string from our current | |
2907 | # parameters | |
2908 | #### | |
2909 | 'query_string' => <<'END_OF_FUNC', | |
2910 | sub query_string { | |
2911 | my($self) = self_or_default(@_); | |
2912 | my($param,$value,@pairs); | |
2913 | foreach $param ($self->param) { | |
424ec8fa | 2914 | my($eparam) = escape($param); |
54310121 | 2915 | foreach $value ($self->param($param)) { |
424ec8fa | 2916 | $value = escape($value); |
3538e1d5 | 2917 | next unless defined $value; |
54310121 | 2918 | push(@pairs,"$eparam=$value"); |
2919 | } | |
2920 | } | |
d45d855d JH |
2921 | foreach (keys %{$self->{'.fieldnames'}}) { |
2922 | push(@pairs,".cgifields=".escape("$_")); | |
2923 | } | |
71f3e297 | 2924 | return join($USE_PARAM_SEMICOLONS ? ';' : '&',@pairs); |
54310121 | 2925 | } |
2926 | END_OF_FUNC | |
2927 | ||
2928 | ||
2929 | #### Method: accept | |
2930 | # Without parameters, returns an array of the | |
2931 | # MIME types the browser accepts. | |
2932 | # With a single parameter equal to a MIME | |
2933 | # type, will return undef if the browser won't | |
2934 | # accept it, 1 if the browser accepts it but | |
2935 | # doesn't give a preference, or a floating point | |
2936 | # value between 0.0 and 1.0 if the browser | |
2937 | # declares a quantitative score for it. | |
2938 | # This handles MIME type globs correctly. | |
2939 | #### | |
71f3e297 JH |
2940 | 'Accept' => <<'END_OF_FUNC', |
2941 | sub Accept { | |
54310121 | 2942 | my($self,$search) = self_or_CGI(@_); |
2943 | my(%prefs,$type,$pref,$pat); | |
2944 | ||
2945 | my(@accept) = split(',',$self->http('accept')); | |
2946 | ||
2947 | foreach (@accept) { | |
2948 | ($pref) = /q=(\d\.\d+|\d+)/; | |
2949 | ($type) = m#(\S+/[^;]+)#; | |
2950 | next unless $type; | |
2951 | $prefs{$type}=$pref || 1; | |
2952 | } | |
2953 | ||
2954 | return keys %prefs unless $search; | |
2955 | ||
2956 | # if a search type is provided, we may need to | |
2957 | # perform a pattern matching operation. | |
2958 | # The MIME types use a glob mechanism, which | |
2959 | # is easily translated into a perl pattern match | |
2960 | ||
2961 | # First return the preference for directly supported | |
2962 | # types: | |
2963 | return $prefs{$search} if $prefs{$search}; | |
2964 | ||
2965 | # Didn't get it, so try pattern matching. | |
2966 | foreach (keys %prefs) { | |
2967 | next unless /\*/; # not a pattern match | |
2968 | ($pat = $_) =~ s/([^\w*])/\\$1/g; # escape meta characters | |
2969 | $pat =~ s/\*/.*/g; # turn it into a pattern | |
2970 | return $prefs{$_} if $search=~/$pat/; | |
2971 | } | |
2972 | } | |
2973 | END_OF_FUNC | |
2974 | ||
2975 | ||
2976 | #### Method: user_agent | |
2977 | # If called with no parameters, returns the user agent. | |
2978 | # If called with one parameter, does a pattern match (case | |
2979 | # insensitive) on the user agent. | |
2980 | #### | |
2981 | 'user_agent' => <<'END_OF_FUNC', | |
2982 | sub user_agent { | |
2983 | my($self,$match)=self_or_CGI(@_); | |
2984 | return $self->http('user_agent') unless $match; | |
2985 | return $self->http('user_agent') =~ /$match/i; | |
2986 | } | |
2987 | END_OF_FUNC | |
2988 | ||
2989 | ||
424ec8fa GS |
2990 | #### Method: raw_cookie |
2991 | # Returns the magic cookies for the session. | |
2992 | # The cookies are not parsed or altered in any way, i.e. | |
2993 | # cookies are returned exactly as given in the HTTP | |
2994 | # headers. If a cookie name is given, only that cookie's | |
2995 | # value is returned, otherwise the entire raw cookie | |
2996 | # is returned. | |
54310121 | 2997 | #### |
2998 | 'raw_cookie' => <<'END_OF_FUNC', | |
2999 | sub raw_cookie { | |
424ec8fa GS |
3000 | my($self,$key) = self_or_CGI(@_); |
3001 | ||
3002 | require CGI::Cookie; | |
3003 | ||
3004 | if (defined($key)) { | |
3005 | $self->{'.raw_cookies'} = CGI::Cookie->raw_fetch | |
3006 | unless $self->{'.raw_cookies'}; | |
3007 | ||
3008 | return () unless $self->{'.raw_cookies'}; | |
3009 | return () unless $self->{'.raw_cookies'}->{$key}; | |
3010 | return $self->{'.raw_cookies'}->{$key}; | |
3011 | } | |
54310121 | 3012 | return $self->http('cookie') || $ENV{'COOKIE'} || ''; |
3013 | } | |
3014 | END_OF_FUNC | |
3015 | ||
3016 | #### Method: virtual_host | |
3017 | # Return the name of the virtual_host, which | |
3018 | # is not always the same as the server | |
3019 | ###### | |
3020 | 'virtual_host' => <<'END_OF_FUNC', | |
3021 | sub virtual_host { | |
13548fdf | 3022 | my $vh = http('x_forwarded_host') || http('host') || server_name(); |
424ec8fa GS |
3023 | $vh =~ s/:\d+$//; # get rid of port number |
3024 | return $vh; | |
54310121 | 3025 | } |
3026 | END_OF_FUNC | |
3027 | ||
3028 | #### Method: remote_host | |
3029 | # Return the name of the remote host, or its IP | |
3030 | # address if unavailable. If this variable isn't | |
3031 | # defined, it returns "localhost" for debugging | |
3032 | # purposes. | |
3033 | #### | |
3034 | 'remote_host' => <<'END_OF_FUNC', | |
3035 | sub remote_host { | |
3036 | return $ENV{'REMOTE_HOST'} || $ENV{'REMOTE_ADDR'} | |
3037 | || 'localhost'; | |
3038 | } | |
3039 | END_OF_FUNC | |
3040 | ||
3041 | ||
3042 | #### Method: remote_addr | |
3043 | # Return the IP addr of the remote host. | |
3044 | #### | |
3045 | 'remote_addr' => <<'END_OF_FUNC', | |
3046 | sub remote_addr { | |
3047 | return $ENV{'REMOTE_ADDR'} || '127.0.0.1'; | |
3048 | } | |
3049 | END_OF_FUNC | |
3050 | ||
3051 | ||
3052 | #### Method: script_name | |
3053 | # Return the partial URL to this script for | |
3054 | # self-referencing scripts. Also see | |
3055 | # self_url(), which returns a URL with all state information | |
3056 | # preserved. | |
3057 | #### | |
3058 | 'script_name' => <<'END_OF_FUNC', | |
3059 | sub script_name { | |
7dc108d1 SP |
3060 | my ($self,@p) = self_or_default(@_); |
3061 | if (@p) { | |
2c454cbd | 3062 | $self->{'.script_name'} = shift @p; |
7dc108d1 SP |
3063 | } elsif (!exists $self->{'.script_name'}) { |
3064 | my ($script_name,$path_info) = $self->_name_and_path_from_env(); | |
3065 | $self->{'.script_name'} = $script_name; | |
3066 | } | |
3067 | return $self->{'.script_name'}; | |
54310121 | 3068 | } |
3069 | END_OF_FUNC | |
3070 | ||
3071 | ||
3072 | #### Method: referer | |
3073 | # Return the HTTP_REFERER: useful for generating | |
3074 | # a GO BACK button. | |
3075 | #### | |
3076 | 'referer' => <<'END_OF_FUNC', | |
3077 | sub referer { | |
3078 | my($self) = self_or_CGI(@_); | |
3079 | return $self->http('referer'); | |
3080 | } | |
3081 | END_OF_FUNC | |
3082 | ||
3083 | ||
3084 | #### Method: server_name | |
3085 | # Return the name of the server | |
3086 | #### | |
3087 | 'server_name' => <<'END_OF_FUNC', | |
3088 | sub server_name { | |
3089 | return $ENV{'SERVER_NAME'} || 'localhost'; | |
3090 | } | |
3091 | END_OF_FUNC | |
3092 | ||
3093 | #### Method: server_software | |
3094 | # Return the name of the server software | |
3095 | #### | |
3096 | 'server_software' => <<'END_OF_FUNC', | |
3097 | sub server_software { | |
3098 | return $ENV{'SERVER_SOFTWARE'} || 'cmdline'; | |
3099 | } | |
3100 | END_OF_FUNC | |
3101 | ||
2ed511ec RGS |
3102 | #### Method: virtual_port |
3103 | # Return the server port, taking virtual hosts into account | |
3104 | #### | |
3105 | 'virtual_port' => <<'END_OF_FUNC', | |
3106 | sub virtual_port { | |
3107 | my($self) = self_or_default(@_); | |
13548fdf | 3108 | my $vh = $self->http('x_forwarded_host') || $self->http('host'); |
0a9bdad4 | 3109 | my $protocol = $self->protocol; |
2ed511ec | 3110 | if ($vh) { |
0a9bdad4 | 3111 | return ($vh =~ /:(\d+)$/)[0] || ($protocol eq 'https' ? 443 : 80); |
2ed511ec RGS |
3112 | } else { |
3113 | return $self->server_port(); | |
3114 | } | |
3115 | } | |
3116 | END_OF_FUNC | |
3117 | ||
54310121 | 3118 | #### Method: server_port |
3119 | # Return the tcp/ip port the server is running on | |
3120 | #### | |
3121 | 'server_port' => <<'END_OF_FUNC', | |
3122 | sub server_port { | |
3123 | return $ENV{'SERVER_PORT'} || 80; # for debugging | |
3124 | } | |
3125 | END_OF_FUNC | |
3126 | ||
3127 | #### Method: server_protocol | |
3128 | # Return the protocol (usually HTTP/1.0) | |
3129 | #### | |
3130 | 'server_protocol' => <<'END_OF_FUNC', | |
3131 | sub server_protocol { | |
3132 | return $ENV{'SERVER_PROTOCOL'} || 'HTTP/1.0'; # for debugging | |
3133 | } | |
3134 | END_OF_FUNC | |
3135 | ||
3136 | #### Method: http | |
3137 | # Return the value of an HTTP variable, or | |
3138 | # the list of variables if none provided | |
3139 | #### | |
3140 | 'http' => <<'END_OF_FUNC', | |
3141 | sub http { | |
3142 | my ($self,$parameter) = self_or_CGI(@_); | |
3143 | return $ENV{$parameter} if $parameter=~/^HTTP/; | |
3538e1d5 | 3144 | $parameter =~ tr/-/_/; |
54310121 | 3145 | return $ENV{"HTTP_\U$parameter\E"} if $parameter; |
3146 | my(@p); | |
3147 | foreach (keys %ENV) { | |
3148 | push(@p,$_) if /^HTTP/; | |
3149 | } | |
3150 | return @p; | |
3151 | } | |
3152 | END_OF_FUNC | |
3153 | ||
3154 | #### Method: https | |
3155 | # Return the value of HTTPS | |
3156 | #### | |
3157 | 'https' => <<'END_OF_FUNC', | |
3158 | sub https { | |
3159 | local($^W)=0; | |
3160 | my ($self,$parameter) = self_or_CGI(@_); | |
3161 | return $ENV{HTTPS} unless $parameter; | |
3162 | return $ENV{$parameter} if $parameter=~/^HTTPS/; | |
3538e1d5 | 3163 | $parameter =~ tr/-/_/; |
54310121 | 3164 | return $ENV{"HTTPS_\U$parameter\E"} if $parameter; |
3165 | my(@p); | |
3166 | foreach (keys %ENV) { | |
3167 | push(@p,$_) if /^HTTPS/; | |
3168 | } | |
3169 | return @p; | |
3170 | } | |
3171 | END_OF_FUNC | |
3172 | ||
3173 | #### Method: protocol | |
3174 | # Return the protocol (http or https currently) | |
3175 | #### | |
3176 | 'protocol' => <<'END_OF_FUNC', | |
3177 | sub protocol { | |
3178 | local($^W)=0; | |
3179 | my $self = shift; | |
424ec8fa | 3180 | return 'https' if uc($self->https()) eq 'ON'; |
54310121 | 3181 | return 'https' if $self->server_port == 443; |
3182 | my $prot = $self->server_protocol; | |
3183 | my($protocol,$version) = split('/',$prot); | |
3184 | return "\L$protocol\E"; | |
3185 | } | |
3186 | END_OF_FUNC | |
3187 | ||
3188 | #### Method: remote_ident | |
3189 | # Return the identity of the remote user | |
3190 | # (but only if his host is running identd) | |
3191 | #### | |
3192 | 'remote_ident' => <<'END_OF_FUNC', | |
3193 | sub remote_ident { | |
3194 | return $ENV{'REMOTE_IDENT'}; | |
3195 | } | |
3196 | END_OF_FUNC | |
3197 | ||
3198 | ||
3199 | #### Method: auth_type | |
3200 | # Return the type of use verification/authorization in use, if any. | |
3201 | #### | |
3202 | 'auth_type' => <<'END_OF_FUNC', | |
3203 | sub auth_type { | |
3204 | return $ENV{'AUTH_TYPE'}; | |
3205 | } | |
3206 | END_OF_FUNC | |
3207 | ||
3208 | ||
3209 | #### Method: remote_user | |
3210 | # Return the authorization name used for user | |
3211 | # verification. | |
3212 | #### | |
3213 | 'remote_user' => <<'END_OF_FUNC', | |
3214 | sub remote_user { | |
3215 | return $ENV{'REMOTE_USER'}; | |
3216 | } | |
3217 | END_OF_FUNC | |
3218 | ||
3219 | ||
3220 | #### Method: user_name | |
3221 | # Try to return the remote user's name by hook or by | |
3222 | # crook | |
3223 | #### | |
3224 | 'user_name' => <<'END_OF_FUNC', | |
3225 | sub user_name { | |
3226 | my ($self) = self_or_CGI(@_); | |
3227 | return $self->http('from') || $ENV{'REMOTE_IDENT'} || $ENV{'REMOTE_USER'}; | |
3228 | } | |
3229 | END_OF_FUNC | |
3230 | ||
3d1a2ec4 GS |
3231 | #### Method: nosticky |
3232 | # Set or return the NOSTICKY global flag | |
3233 | #### | |
3234 | 'nosticky' => <<'END_OF_FUNC', | |
3235 | sub nosticky { | |
3236 | my ($self,$param) = self_or_CGI(@_); | |
3237 | $CGI::NOSTICKY = $param if defined($param); | |
3238 | return $CGI::NOSTICKY; | |
3239 | } | |
3240 | END_OF_FUNC | |
3241 | ||
54310121 | 3242 | #### Method: nph |
3243 | # Set or return the NPH global flag | |
3244 | #### | |
3245 | 'nph' => <<'END_OF_FUNC', | |
3246 | sub nph { | |
3247 | my ($self,$param) = self_or_CGI(@_); | |
7d37aa8e LS |
3248 | $CGI::NPH = $param if defined($param); |
3249 | return $CGI::NPH; | |
3250 | } | |
3251 | END_OF_FUNC | |
3252 | ||
3253 | #### Method: private_tempfiles | |
3254 | # Set or return the private_tempfiles global flag | |
3255 | #### | |
3256 | 'private_tempfiles' => <<'END_OF_FUNC', | |
3257 | sub private_tempfiles { | |
3258 | my ($self,$param) = self_or_CGI(@_); | |
424ec8fa | 3259 | $CGI::PRIVATE_TEMPFILES = $param if defined($param); |
7d37aa8e | 3260 | return $CGI::PRIVATE_TEMPFILES; |
54310121 | 3261 | } |
3262 | END_OF_FUNC | |
8f3ccfa2 JH |
3263 | #### Method: close_upload_files |
3264 | # Set or return the close_upload_files global flag | |
3265 | #### | |
3266 | 'close_upload_files' => <<'END_OF_FUNC', | |
3267 | sub close_upload_files { | |
3268 | my ($self,$param) = self_or_CGI(@_); | |
3269 | $CGI::CLOSE_UPLOAD_FILES = $param if defined($param); | |
3270 | return $CGI::CLOSE_UPLOAD_FILES; | |
3271 | } | |
3272 | END_OF_FUNC | |
3273 | ||
54310121 | 3274 | |
424ec8fa GS |
3275 | #### Method: default_dtd |
3276 | # Set or return the default_dtd global | |
3277 | #### | |
3278 | 'default_dtd' => <<'END_OF_FUNC', | |
3279 | sub default_dtd { | |
3d1a2ec4 GS |
3280 | my ($self,$param,$param2) = self_or_CGI(@_); |
3281 | if (defined $param2 && defined $param) { | |
3282 | $CGI::DEFAULT_DTD = [ $param, $param2 ]; | |
3283 | } elsif (defined $param) { | |
3284 | $CGI::DEFAULT_DTD = $param; | |
3285 | } | |
424ec8fa GS |
3286 | return $CGI::DEFAULT_DTD; |
3287 | } | |
3288 | END_OF_FUNC | |
3289 | ||
54310121 | 3290 | # -------------- really private subroutines ----------------- |
3291 | 'previous_or_default' => <<'END_OF_FUNC', | |
3292 | sub previous_or_default { | |
3293 | my($self,$name,$defaults,$override) = @_; | |
3294 | my(%selected); | |
3295 | ||
3296 | if (!$override && ($self->{'.fieldnames'}->{$name} || | |
3297 | defined($self->param($name)) ) ) { | |
f84167b3 | 3298 | $selected{$_}++ for $self->param($name); |
54310121 | 3299 | } elsif (defined($defaults) && ref($defaults) && |
3300 | (ref($defaults) eq 'ARRAY')) { | |
f84167b3 | 3301 | $selected{$_}++ for @{$defaults}; |
54310121 | 3302 | } else { |
3303 | $selected{$defaults}++ if defined($defaults); | |
3304 | } | |
3305 | ||
3306 | return %selected; | |
3307 | } | |
3308 | END_OF_FUNC | |
3309 | ||
3310 | 'register_parameter' => <<'END_OF_FUNC', | |
3311 | sub register_parameter { | |
3312 | my($self,$param) = @_; | |
3313 | $self->{'.parametersToAdd'}->{$param}++; | |
3314 | } | |
3315 | END_OF_FUNC | |
3316 | ||
3317 | 'get_fields' => <<'END_OF_FUNC', | |
3318 | sub get_fields { | |
3319 | my($self) = @_; | |
424ec8fa GS |
3320 | return $self->CGI::hidden('-name'=>'.cgifields', |
3321 | '-values'=>[keys %{$self->{'.parametersToAdd'}}], | |
3322 | '-override'=>1); | |
54310121 | 3323 | } |
3324 | END_OF_FUNC | |
3325 | ||
3326 | 'read_from_cmdline' => <<'END_OF_FUNC', | |
3327 | sub read_from_cmdline { | |
54310121 | 3328 | my($input,@words); |
3329 | my($query_string); | |
2ed511ec | 3330 | my($subpath); |
3d1a2ec4 | 3331 | if ($DEBUG && @ARGV) { |
424ec8fa | 3332 | @words = @ARGV; |
3d1a2ec4 | 3333 | } elsif ($DEBUG > 1) { |
424ec8fa | 3334 | require "shellwords.pl"; |
2ed511ec | 3335 | print STDERR "(offline mode: enter name=value pairs on standard input; press ^D or ^Z when done)\n"; |
424ec8fa | 3336 | chomp(@lines = <STDIN>); # remove newlines |
54310121 | 3337 | $input = join(" ",@lines); |
424ec8fa GS |
3338 | @words = &shellwords($input); |
3339 | } | |
3340 | foreach (@words) { | |
3341 | s/\\=/%3D/g; | |
3342 | s/\\&/%26/g; | |
54310121 | 3343 | } |
3344 | ||
54310121 | 3345 | if ("@words"=~/=/) { |
3346 | $query_string = join('&',@words); | |
3347 | } else { | |
3348 | $query_string = join('+',@words); | |
3349 | } | |
2ed511ec RGS |
3350 | if ($query_string =~ /^(.*?)\?(.*)$/) |
3351 | { | |
3352 | $query_string = $2; | |
3353 | $subpath = $1; | |
3354 | } | |
3355 | return { 'query_string' => $query_string, 'subpath' => $subpath }; | |
54310121 | 3356 | } |
3357 | END_OF_FUNC | |
3358 | ||
3359 | ##### | |
3360 | # subroutine: read_multipart | |
3361 | # | |
3362 | # Read multipart data and store it into our parameters. | |
3363 | # An interesting feature is that if any of the parts is a file, we | |
3364 | # create a temporary file and open up a filehandle on it so that the | |
3365 | # caller can read from it if necessary. | |
3366 | ##### | |
3367 | 'read_multipart' => <<'END_OF_FUNC', | |
3368 | sub read_multipart { | |
2ed511ec RGS |
3369 | my($self,$boundary,$length) = @_; |
3370 | my($buffer) = $self->new_MultipartBuffer($boundary,$length); | |
54310121 | 3371 | return unless $buffer; |
3372 | my(%header,$body); | |
424ec8fa | 3373 | my $filenumber = 0; |
54310121 | 3374 | while (!$buffer->eof) { |
3375 | %header = $buffer->readHeader; | |
3538e1d5 GS |
3376 | |
3377 | unless (%header) { | |
3378 | $self->cgi_error("400 Bad request (malformed multipart POST)"); | |
3379 | return; | |
3380 | } | |
54310121 | 3381 | |
c29edf6c | 3382 | my($param)= $header{'Content-Disposition'}=~/ name="([^"]*)"/; |
188ba755 | 3383 | $param .= $TAINTED; |
54310121 | 3384 | |
86de2d7d SP |
3385 | # See RFC 1867, 2183, 2045 |
3386 | # NB: File content will be loaded into memory should | |
3387 | # content-disposition parsing fail. | |
3388 | my ($filename) = $header{'Content-Disposition'} | |
3389 | =~/ filename=(("[^"]*")|([a-z\d!\#'\*\+,\.^_\`\{\}\|\~]*))/i; | |
3390 | $filename =~ s/^"([^"]*)"$/$1/; | |
8f3ccfa2 JH |
3391 | # Test for Opera's multiple upload feature |
3392 | my($multipart) = ( defined( $header{'Content-Type'} ) && | |
3393 | $header{'Content-Type'} =~ /multipart\/mixed/ ) ? | |
3394 | 1 : 0; | |
54310121 | 3395 | |
3396 | # add this parameter to our list | |
3397 | $self->add_parameter($param); | |
3398 | ||
3399 | # If no filename specified, then just read the data and assign it | |
3400 | # to our parameter list. | |
8f3ccfa2 | 3401 | if ( ( !defined($filename) || $filename eq '' ) && !$multipart ) { |
54310121 | 3402 | my($value) = $buffer->readBody; |
188ba755 | 3403 | $value .= $TAINTED; |
54310121 | 3404 | push(@{$self->{$param}},$value); |
3405 | next; | |
3406 | } | |
3407 | ||
424ec8fa GS |
3408 | my ($tmpfile,$tmp,$filehandle); |
3409 | UPLOADS: { | |
3410 | # If we get here, then we are dealing with a potentially large | |
3411 | # uploaded form. Save the data to a temporary file, then open | |
3412 | # the file for reading. | |
54310121 | 3413 | |
424ec8fa GS |
3414 | # skip the file if uploads disabled |
3415 | if ($DISABLE_UPLOADS) { | |
3416 | while (defined($data = $buffer->read)) { } | |
3417 | last UPLOADS; | |
3418 | } | |
7d37aa8e | 3419 | |
8f3ccfa2 JH |
3420 | # set the filename to some recognizable value |
3421 | if ( ( !defined($filename) || $filename eq '' ) && $multipart ) { | |
3422 | $filename = "multipart/mixed"; | |
3423 | } | |
3424 | ||
3538e1d5 | 3425 | # choose a relatively unpredictable tmpfile sequence number |
29ddc2a4 | 3426 | my $seqno = unpack("%16C*",join('',localtime,grep {defined $_} values %ENV)); |
3538e1d5 | 3427 | for (my $cnt=10;$cnt>0;$cnt--) { |
ac734d8b | 3428 | next unless $tmpfile = new CGITempFile($seqno); |
3538e1d5 | 3429 | $tmp = $tmpfile->as_string; |
ffd2dff2 | 3430 | last if defined($filehandle = Fh->new($filename,$tmp,$PRIVATE_TEMPFILES)); |
3538e1d5 GS |
3431 | $seqno += int rand(100); |
3432 | } | |
69c89ae7 | 3433 | die "CGI open of tmpfile: $!\n" unless defined $filehandle; |
2ed511ec RGS |
3434 | $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode |
3435 | && defined fileno($filehandle); | |
424ec8fa | 3436 | |
8f3ccfa2 | 3437 | # if this is an multipart/mixed attachment, save the header |
2ed511ec | 3438 | # together with the body for later parsing with an external |
8f3ccfa2 JH |
3439 | # MIME parser module |
3440 | if ( $multipart ) { | |
3441 | foreach ( keys %header ) { | |
3442 | print $filehandle "$_: $header{$_}${CRLF}"; | |
3443 | } | |
3444 | print $filehandle "${CRLF}"; | |
3445 | } | |
3446 | ||
424ec8fa | 3447 | my ($data); |
71f3e297 | 3448 | local($\) = ''; |
bb8b3399 | 3449 | my $totalbytes = 0; |
2ed511ec RGS |
3450 | while (defined($data = $buffer->read)) { |
3451 | if (defined $self->{'.upload_hook'}) | |
3452 | { | |
3453 | $totalbytes += length($data); | |
3454 | &{$self->{'.upload_hook'}}($filename ,$data, $totalbytes, $self->{'.upload_data'}); | |
3455 | } | |
cb3b230c | 3456 | print $filehandle $data if ($self->{'use_tempfile'}); |
2ed511ec | 3457 | } |
424ec8fa GS |
3458 | |
3459 | # back up to beginning of file | |
3460 | seek($filehandle,0,0); | |
8f3ccfa2 JH |
3461 | |
3462 | ## Close the filehandle if requested this allows a multipart MIME | |
3463 | ## upload to contain many files, and we won't die due to too many | |
3464 | ## open file handles. The user can access the files using the hash | |
3465 | ## below. | |
3466 | close $filehandle if $CLOSE_UPLOAD_FILES; | |
424ec8fa GS |
3467 | $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode; |
3468 | ||
3469 | # Save some information about the uploaded file where we can get | |
3470 | # at it later. | |
0a9bdad4 SP |
3471 | # Use the typeglob as the key, as this is guaranteed to be |
3472 | # unique for each filehandle. Don't use the file descriptor as | |
3473 | # this will be re-used for each filehandle if the | |
3474 | # close_upload_files feature is used. | |
3475 | $self->{'.tmpfiles'}->{$$filehandle}= { | |
2ed511ec | 3476 | hndl => $filehandle, |
424ec8fa GS |
3477 | name => $tmpfile, |
3478 | info => {%header}, | |
3479 | }; | |
3480 | push(@{$self->{$param}},$filehandle); | |
3481 | } | |
54310121 | 3482 | } |
3483 | } | |
3484 | END_OF_FUNC | |
3485 | ||
8869a4b7 SP |
3486 | ##### |
3487 | # subroutine: read_multipart_related | |
3488 | # | |
3489 | # Read multipart/related data and store it into our parameters. The | |
3490 | # first parameter sets the start of the data. The part identified by | |
3491 | # this Content-ID will not be stored as a file upload, but will be | |
3492 | # returned by this method. All other parts will be available as file | |
3493 | # uploads accessible by their Content-ID | |
3494 | ##### | |
3495 | 'read_multipart_related' => <<'END_OF_FUNC', | |
3496 | sub read_multipart_related { | |
3497 | my($self,$start,$boundary,$length) = @_; | |
3498 | my($buffer) = $self->new_MultipartBuffer($boundary,$length); | |
3499 | return unless $buffer; | |
3500 | my(%header,$body); | |
3501 | my $filenumber = 0; | |
3502 | my $returnvalue; | |
3503 | while (!$buffer->eof) { | |
3504 | %header = $buffer->readHeader; | |
3505 | ||
3506 | unless (%header) { | |
3507 | $self->cgi_error("400 Bad request (malformed multipart POST)"); | |
3508 | return; | |
3509 | } | |
3510 | ||
3511 | my($param) = $header{'Content-ID'}=~/\<([^\>]*)\>/; | |
3512 | $param .= $TAINTED; | |
3513 | ||
3514 | # If this is the start part, then just read the data and assign it | |
3515 | # to our return variable. | |
3516 | if ( $param eq $start ) { | |
3517 | $returnvalue = $buffer->readBody; | |
3518 | $returnvalue .= $TAINTED; | |
3519 | next; | |
3520 | } | |
3521 | ||
3522 | # add this parameter to our list | |
3523 | $self->add_parameter($param); | |
3524 | ||
3525 | my ($tmpfile,$tmp,$filehandle); | |
3526 | UPLOADS: { | |
3527 | # If we get here, then we are dealing with a potentially large | |
3528 | # uploaded form. Save the data to a temporary file, then open | |
3529 | # the file for reading. | |
3530 | ||
3531 | # skip the file if uploads disabled | |
3532 | if ($DISABLE_UPLOADS) { | |
3533 | while (defined($data = $buffer->read)) { } | |
3534 | last UPLOADS; | |
3535 | } | |
3536 | ||
3537 | # choose a relatively unpredictable tmpfile sequence number | |
3538 | my $seqno = unpack("%16C*",join('',localtime,grep {defined $_} values %ENV)); | |
3539 | for (my $cnt=10;$cnt>0;$cnt--) { | |
3540 | next unless $tmpfile = new CGITempFile($seqno); | |
3541 | $tmp = $tmpfile->as_string; | |
3542 | last if defined($filehandle = Fh->new($param,$tmp,$PRIVATE_TEMPFILES)); | |
3543 | $seqno += int rand(100); | |
3544 | } | |
3545 | die "CGI open of tmpfile: $!\n" unless defined $filehandle; | |
3546 | $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode | |
3547 | && defined fileno($filehandle); | |
3548 | ||
3549 | my ($data); | |
3550 | local($\) = ''; | |
3551 | my $totalbytes; | |
3552 | while (defined($data = $buffer->read)) { | |
3553 | if (defined $self->{'.upload_hook'}) | |
3554 | { | |
3555 | $totalbytes += length($data); | |
3556 | &{$self->{'.upload_hook'}}($param ,$data, $totalbytes, $self->{'.upload_data'}); | |
3557 | } | |
3558 | print $filehandle $data if ($self->{'use_tempfile'}); | |
3559 | } | |
3560 | ||
3561 | # back up to beginning of file | |
3562 | seek($filehandle,0,0); | |
3563 | ||
3564 | ## Close the filehandle if requested this allows a multipart MIME | |
3565 | ## upload to contain many files, and we won't die due to too many | |
3566 | ## open file handles. The user can access the files using the hash | |
3567 | ## below. | |
3568 | close $filehandle if $CLOSE_UPLOAD_FILES; | |
3569 | $CGI::DefaultClass->binmode($filehandle) if $CGI::needs_binmode; | |
3570 | ||
3571 | # Save some information about the uploaded file where we can get | |
3572 | # at it later. | |
3573 | # Use the typeglob as the key, as this is guaranteed to be | |
3574 | # unique for each filehandle. Don't use the file descriptor as | |
3575 | # this will be re-used for each filehandle if the | |
3576 | # close_upload_files feature is used. | |
3577 | $self->{'.tmpfiles'}->{$$filehandle}= { | |
3578 | hndl => $filehandle, | |
3579 | name => $tmpfile, | |
3580 | info => {%header}, | |
3581 | }; | |
3582 | push(@{$self->{$param}},$filehandle); | |
3583 | } | |
3584 | } | |
3585 | return $returnvalue; | |
3586 | } | |
3587 | END_OF_FUNC | |
3588 | ||
3589 | ||
3538e1d5 GS |
3590 | 'upload' =><<'END_OF_FUNC', |
3591 | sub upload { | |
3592 | my($self,$param_name) = self_or_default(@_); | |
0664a57d | 3593 | my @param = grep {ref($_) && defined(fileno($_))} $self->param($param_name); |
199d4a26 JH |
3594 | return unless @param; |
3595 | return wantarray ? @param : $param[0]; | |
3538e1d5 GS |
3596 | } |
3597 | END_OF_FUNC | |
3598 | ||
54310121 | 3599 | 'tmpFileName' => <<'END_OF_FUNC', |
3600 | sub tmpFileName { | |
3601 | my($self,$filename) = self_or_default(@_); | |
0a9bdad4 SP |
3602 | return $self->{'.tmpfiles'}->{$$filename}->{name} ? |
3603 | $self->{'.tmpfiles'}->{$$filename}->{name}->as_string | |
7d37aa8e | 3604 | : ''; |
54310121 | 3605 | } |
3606 | END_OF_FUNC | |
3607 | ||
424ec8fa | 3608 | 'uploadInfo' => <<'END_OF_FUNC', |
54310121 | 3609 | sub uploadInfo { |
3610 | my($self,$filename) = self_or_default(@_); | |
0a9bdad4 | 3611 | return $self->{'.tmpfiles'}->{$$filename}->{info}; |
54310121 | 3612 | } |
3613 | END_OF_FUNC | |
3614 | ||
424ec8fa GS |
3615 | # internal routine, don't use |
3616 | '_set_values_and_labels' => <<'END_OF_FUNC', | |
3617 | sub _set_values_and_labels { | |
3618 | my $self = shift; | |
3619 | my ($v,$l,$n) = @_; | |
3620 | $$l = $v if ref($v) eq 'HASH' && !ref($$l); | |
3621 | return $self->param($n) if !defined($v); | |
3622 | return $v if !ref($v); | |
3623 | return ref($v) eq 'HASH' ? keys %$v : @$v; | |
3624 | } | |
3625 | END_OF_FUNC | |
3626 | ||
188ba755 JH |
3627 | # internal routine, don't use |
3628 | '_set_attributes' => <<'END_OF_FUNC', | |
3629 | sub _set_attributes { | |
3630 | my $self = shift; | |
3631 | my($element, $attributes) = @_; | |
3632 | return '' unless defined($attributes->{$element}); | |
3633 | $attribs = ' '; | |
3634 | foreach my $attrib (keys %{$attributes->{$element}}) { | |
13548fdf RGS |
3635 | (my $clean_attrib = $attrib) =~ s/^-//; |
3636 | $attribs .= "@{[lc($clean_attrib)]}=\"$attributes->{$element}{$attrib}\" "; | |
188ba755 JH |
3637 | } |
3638 | $attribs =~ s/ $//; | |
3639 | return $attribs; | |
3640 | } | |
3641 | END_OF_FUNC | |
3642 | ||
424ec8fa GS |
3643 | '_compile_all' => <<'END_OF_FUNC', |
3644 | sub _compile_all { | |
3645 | foreach (@_) { | |
3646 | next if defined(&$_); | |
3647 | $AUTOLOAD = "CGI::$_"; | |
3648 | _compile(); | |
3649 | } | |
3650 | } | |
3651 | END_OF_FUNC | |
3652 | ||
54310121 | 3653 | ); |
3654 | END_OF_AUTOLOAD | |
3655 | ; | |
3656 | ||
424ec8fa GS |
3657 | ######################################################### |
3658 | # Globals and stubs for other packages that we use. | |
3659 | ######################################################### | |
3660 | ||
3661 | ################### Fh -- lightweight filehandle ############### | |
3662 | package Fh; | |
3663 | use overload | |
3664 | '""' => \&asString, | |
3665 | 'cmp' => \&compare, | |
3666 | 'fallback'=>1; | |
3667 | ||
3668 | $FH='fh00000'; | |
3669 | ||
3670 | *Fh::AUTOLOAD = \&CGI::AUTOLOAD; | |
3671 | ||
29ddc2a4 RGS |
3672 | sub DESTROY { |
3673 | my $self = shift; | |
3674 | close $self; | |
3675 | } | |
3676 | ||
424ec8fa GS |
3677 | $AUTOLOADED_ROUTINES = ''; # prevent -w error |
3678 | $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD'; | |
3679 | %SUBS = ( | |
3680 | 'asString' => <<'END_OF_FUNC', | |
3681 | sub asString { | |
3682 | my $self = shift; | |
71f3e297 | 3683 | # get rid of package name |
ffd2dff2 | 3684 | (my $i = $$self) =~ s/^\*(\w+::fh\d{5})+//; |
ba056755 | 3685 | $i =~ s/%(..)/ chr(hex($1)) /eg; |
188ba755 | 3686 | return $i.$CGI::TAINTED; |
71f3e297 JH |
3687 | # BEGIN DEAD CODE |
3688 | # This was an extremely clever patch that allowed "use strict refs". | |
3689 | # Unfortunately it relied on another bug that caused leaky file descriptors. | |
3690 | # The underlying bug has been fixed, so this no longer works. However | |
3691 | # "strict refs" still works for some reason. | |
3692 | # my $self = shift; | |
3693 | # return ${*{$self}{SCALAR}}; | |
3694 | # END DEAD CODE | |
424ec8fa GS |
3695 | } |
3696 | END_OF_FUNC | |
3697 | ||
3698 | 'compare' => <<'END_OF_FUNC', | |
3699 | sub compare { | |
3700 | my $self = shift; | |
3701 | my $value = shift; | |
3702 | return "$self" cmp $value; | |
3703 | } | |
3704 | END_OF_FUNC | |
3705 | ||
3706 | 'new' => <<'END_OF_FUNC', | |
3707 | sub new { | |
3708 | my($pack,$name,$file,$delete) = @_; | |
188ba755 | 3709 | _setup_symbols(@SAVED_SYMBOLS) if @SAVED_SYMBOLS; |
424ec8fa | 3710 | require Fcntl unless defined &Fcntl::O_RDWR; |
ba056755 JH |
3711 | (my $safename = $name) =~ s/([':%])/ sprintf '%%%02X', ord $1 /eg; |
3712 | my $fv = ++$FH . $safename; | |
6b4ac661 | 3713 | my $ref = \*{"Fh::$fv"}; |
bb8b3399 | 3714 | $file =~ m!^([a-zA-Z0-9_\+ \'\":/.\$\\-]+)$! || return; |
188ba755 JH |
3715 | my $safe = $1; |
3716 | sysopen($ref,$safe,Fcntl::O_RDWR()|Fcntl::O_CREAT()|Fcntl::O_EXCL(),0600) || return; | |
3717 | unlink($safe) if $delete; | |
6b4ac661 | 3718 | CORE::delete $Fh::{$fv}; |
71f3e297 | 3719 | return bless $ref,$pack; |
424ec8fa GS |
3720 | } |
3721 | END_OF_FUNC | |
3722 | ||
424ec8fa GS |
3723 | ); |
3724 | END_OF_AUTOLOAD | |
3725 | ||
3726 | ######################## MultipartBuffer #################### | |
54310121 | 3727 | package MultipartBuffer; |
3728 | ||
2ed511ec RGS |
3729 | use constant DEBUG => 0; |
3730 | ||
54310121 | 3731 | # how many bytes to read at a time. We use |
71f3e297 JH |
3732 | # a 4K buffer by default. |
3733 | $INITIAL_FILLUNIT = 1024 * 4; | |
3734 | $TIMEOUT = 240*60; # 4 hour timeout for big files | |
3735 | $SPIN_LOOP_MAX = 2000; # bug fix for some Netscape servers | |
54310121 | 3736 | $CRLF=$CGI::CRLF; |
3737 | ||
3738 | #reuse the autoload function | |
3739 | *MultipartBuffer::AUTOLOAD = \&CGI::AUTOLOAD; | |
3740 | ||
424ec8fa GS |
3741 | # avoid autoloader warnings |
3742 | sub DESTROY {} | |
3743 | ||
54310121 | 3744 | ############################################################################### |
3745 | ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND #################### | |
3746 | ############################################################################### | |
3747 | $AUTOLOADED_ROUTINES = ''; # prevent -w error | |
3748 | $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD'; | |
3749 | %SUBS = ( | |
3750 | ||
3751 | 'new' => <<'END_OF_FUNC', | |
3752 | sub new { | |
2ed511ec | 3753 | my($package,$interface,$boundary,$length) = @_; |
424ec8fa | 3754 | $FILLUNIT = $INITIAL_FILLUNIT; |
2ed511ec | 3755 | $CGI::DefaultClass->binmode($IN); # if $CGI::needs_binmode; # just do it always |
29ddc2a4 | 3756 | |
54310121 | 3757 | # If the user types garbage into the file upload field, |
3758 | # then Netscape passes NOTHING to the server (not good). | |
3759 | # We may hang on this read in that case. So we implement | |
3760 | # a read timeout. If nothing is ready to read | |
3761 | # by then, we return. | |
3762 | ||
3763 | # Netscape seems to be a little bit unreliable | |
3764 | # about providing boundary strings. | |
3d1a2ec4 | 3765 | my $boundary_read = 0; |
54310121 | 3766 | if ($boundary) { |
3767 | ||
3768 | # Under the MIME spec, the boundary consists of the | |
3769 | # characters "--" PLUS the Boundary string | |
424ec8fa GS |
3770 | |
3771 | # BUG: IE 3.01 on the Macintosh uses just the boundary -- not | |
71f3e297 | 3772 | # the two extra hyphens. We do a special case here on the user-agent!!!! |
69c89ae7 | 3773 | $boundary = "--$boundary" unless CGI::user_agent('MSIE\s+3\.0[12];\s*Mac|DreamPassport'); |
424ec8fa | 3774 | |
54310121 | 3775 | } else { # otherwise we find it ourselves |
3776 | my($old); | |
3777 | ($old,$/) = ($/,$CRLF); # read a CRLF-delimited line | |
2ed511ec | 3778 | $boundary = <STDIN>; # BUG: This won't work correctly under mod_perl |
54310121 | 3779 | $length -= length($boundary); |
3780 | chomp($boundary); # remove the CRLF | |
3781 | $/ = $old; # restore old line separator | |
3d1a2ec4 | 3782 | $boundary_read++; |
54310121 | 3783 | } |
3784 | ||
3785 | my $self = {LENGTH=>$length, | |
29ddc2a4 | 3786 | CHUNKED=>!defined $length, |
54310121 | 3787 | BOUNDARY=>$boundary, |
54310121 | 3788 | INTERFACE=>$interface, |
3789 | BUFFER=>'', | |
3790 | }; | |
3791 | ||
3792 | $FILLUNIT = length($boundary) | |
3793 | if length($boundary) > $FILLUNIT; | |
3794 | ||
424ec8fa GS |
3795 | my $retval = bless $self,ref $package || $package; |
3796 | ||
3797 | # Read the preamble and the topmost (boundary) line plus the CRLF. | |
3d1a2ec4 GS |
3798 | unless ($boundary_read) { |
3799 | while ($self->read(0)) { } | |
3800 | } | |
2ed511ec | 3801 | die "Malformed multipart POST: data truncated\n" if $self->eof; |
424ec8fa GS |
3802 | |
3803 | return $retval; | |
54310121 | 3804 | } |
3805 | END_OF_FUNC | |
3806 | ||
3807 | 'readHeader' => <<'END_OF_FUNC', | |
3808 | sub readHeader { | |
3809 | my($self) = @_; | |
3810 | my($end); | |
3811 | my($ok) = 0; | |
47e3cabd | 3812 | my($bad) = 0; |
424ec8fa | 3813 | |
2ed511ec | 3814 | local($CRLF) = "\015\012" if $CGI::OS eq 'VMS' || $CGI::EBCDIC; |
424ec8fa | 3815 | |
54310121 | 3816 | do { |
3817 | $self->fillBuffer($FILLUNIT); | |
3818 | $ok++ if ($end = index($self->{BUFFER},"${CRLF}${CRLF}")) >= 0; | |
3819 | $ok++ if $self->{BUFFER} eq ''; | |
47e3cabd | 3820 | $bad++ if !$ok && $self->{LENGTH} <= 0; |
424ec8fa GS |
3821 | # this was a bad idea |
3822 | # $FILLUNIT *= 2 if length($self->{BUFFER}) >= $FILLUNIT; | |
47e3cabd LS |
3823 | } until $ok || $bad; |
3824 | return () if $bad; | |
54310121 | 3825 | |
2ed511ec RGS |
3826 | #EBCDIC NOTE: translate header into EBCDIC, but watch out for continuation lines! |
3827 | ||
54310121 | 3828 | my($header) = substr($self->{BUFFER},0,$end+2); |
3829 | substr($self->{BUFFER},0,$end+4) = ''; | |
3830 | my %return; | |
424ec8fa | 3831 | |
2ed511ec RGS |
3832 | if ($CGI::EBCDIC) { |
3833 | warn "untranslated header=$header\n" if DEBUG; | |
3834 | $header = CGI::Util::ascii2ebcdic($header); | |
3835 | warn "translated header=$header\n" if DEBUG; | |
3836 | } | |
3837 | ||
424ec8fa GS |
3838 | # See RFC 2045 Appendix A and RFC 822 sections 3.4.8 |
3839 | # (Folding Long Header Fields), 3.4.3 (Comments) | |
3840 | # and 3.4.5 (Quoted-Strings). | |
3841 | ||
3842 | my $token = '[-\w!\#$%&\'*+.^_\`|{}~]'; | |
3843 | $header=~s/$CRLF\s+/ /og; # merge continuation lines | |
188ba755 | 3844 | |
424ec8fa | 3845 | while ($header=~/($token+):\s+([^$CRLF]*)/mgox) { |
188ba755 | 3846 | my ($field_name,$field_value) = ($1,$2); |
424ec8fa GS |
3847 | $field_name =~ s/\b(\w)/uc($1)/eg; #canonicalize |
3848 | $return{$field_name}=$field_value; | |
54310121 | 3849 | } |
3850 | return %return; | |
3851 | } | |
3852 | END_OF_FUNC | |
3853 | ||
3854 | # This reads and returns the body as a single scalar value. | |
3855 | 'readBody' => <<'END_OF_FUNC', | |
3856 | sub readBody { | |
3857 | my($self) = @_; | |
3858 | my($data); | |
3859 | my($returnval)=''; | |
2ed511ec RGS |
3860 | |
3861 | #EBCDIC NOTE: want to translate returnval into EBCDIC HERE | |
3862 | ||
54310121 | 3863 | while (defined($data = $self->read)) { |
3864 | $returnval .= $data; | |
3865 | } | |
2ed511ec RGS |
3866 | |
3867 | if ($CGI::EBCDIC) { | |
3868 | warn "untranslated body=$returnval\n" if DEBUG; | |
3869 | $returnval = CGI::Util::ascii2ebcdic($returnval); | |
3870 | warn "translated body=$returnval\n" if DEBUG; | |
3871 | } | |
54310121 | 3872 | return $returnval; |
3873 | } | |
3874 | END_OF_FUNC | |
3875 | ||
3876 | # This will read $bytes or until the boundary is hit, whichever happens | |
3877 | # first. After the boundary is hit, we return undef. The next read will | |
3878 | # skip over the boundary and begin reading again; | |
3879 | 'read' => <<'END_OF_FUNC', | |
3880 | sub read { | |
3881 | my($self,$bytes) = @_; | |
3882 | ||
3883 | # default number of bytes to read | |
2ed511ec | 3884 | $bytes = $bytes || $FILLUNIT; |
54310121 | 3885 | |
3886 | # Fill up our internal buffer in such a way that the boundary | |
3887 | # is never split between reads. | |
3888 | $self->fillBuffer($bytes); | |
3889 | ||
2ed511ec RGS |
3890 | my $boundary_start = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY}) : $self->{BOUNDARY}; |
3891 | my $boundary_end = $CGI::EBCDIC ? CGI::Util::ebcdic2ascii($self->{BOUNDARY}.'--') : $self->{BOUNDARY}.'--'; | |
3892 | ||
54310121 | 3893 | # Find the boundary in the buffer (it may not be there). |
2ed511ec RGS |
3894 | my $start = index($self->{BUFFER},$boundary_start); |
3895 | ||
3896 | warn "boundary=$self->{BOUNDARY} length=$self->{LENGTH} start=$start\n" if DEBUG; | |
54310121 | 3897 | |
29ddc2a4 RGS |
3898 | # protect against malformed multipart POST operations |
3899 | die "Malformed multipart POST\n" unless $self->{CHUNKED} || ($start >= 0 || $self->{LENGTH} > 0); | |
2ed511ec RGS |
3900 | |
3901 | #EBCDIC NOTE: want to translate boundary search into ASCII here. | |
3902 | ||
54310121 | 3903 | # If the boundary begins the data, then skip past it |
03b9648d | 3904 | # and return undef. |
54310121 | 3905 | if ($start == 0) { |
3906 | ||
3907 | # clear us out completely if we've hit the last boundary. | |
2ed511ec | 3908 | if (index($self->{BUFFER},$boundary_end)==0) { |
54310121 | 3909 | $self->{BUFFER}=''; |
3910 | $self->{LENGTH}=0; | |
3911 | return undef; | |
3912 | } | |
3913 | ||
3914 | # just remove the boundary. | |
2ed511ec | 3915 | substr($self->{BUFFER},0,length($boundary_start))=''; |
03b9648d | 3916 | $self->{BUFFER} =~ s/^\012\015?//; |
54310121 | 3917 | return undef; |
3918 | } | |
3919 | ||
8f3ccfa2 | 3920 | my $bytesToReturn; |
54310121 | 3921 | if ($start > 0) { # read up to the boundary |
8f3ccfa2 | 3922 | $bytesToReturn = $start-2 > $bytes ? $bytes : $start; |
54310121 | 3923 | } else { # read the requested number of bytes |
3924 | # leave enough bytes in the buffer to allow us to read | |
3925 | # the boundary. Thanks to Kevin Hendrick for finding | |
3926 | # this one. | |
2ed511ec | 3927 | $bytesToReturn = $bytes - (length($boundary_start)+1); |
54310121 | 3928 | } |
3929 | ||
3930 | my $returnval=substr($self->{BUFFER},0,$bytesToReturn); | |
3931 | substr($self->{BUFFER},0,$bytesToReturn)=''; | |
3932 | ||
3933 | # If we hit the boundary, remove the CRLF from the end. | |
8f3ccfa2 | 3934 | return ($bytesToReturn==$start) |
ac734d8b | 3935 | ? substr($returnval,0,-2) : $returnval; |
54310121 | 3936 | } |
3937 | END_OF_FUNC | |
3938 | ||
3939 | ||
3940 | # This fills up our internal buffer in such a way that the | |
3941 | # boundary is never split between reads | |
3942 | 'fillBuffer' => <<'END_OF_FUNC', | |
3943 | sub fillBuffer { | |
3944 | my($self,$bytes) = @_; | |
29ddc2a4 | 3945 | return unless $self->{CHUNKED} || $self->{LENGTH}; |
54310121 | 3946 | |
3947 | my($boundaryLength) = length($self->{BOUNDARY}); | |
3948 | my($bufferLength) = length($self->{BUFFER}); | |
3949 | my($bytesToRead) = $bytes - $bufferLength + $boundaryLength + 2; | |
29ddc2a4 | 3950 | $bytesToRead = $self->{LENGTH} if !$self->{CHUNKED} && $self->{LENGTH} < $bytesToRead; |
54310121 | 3951 | |
2ed511ec RGS |
3952 | # Try to read some data. We may hang here if the browser is screwed up. |
3953 | my $bytesRead = $self->{INTERFACE}->read_from_client(\$self->{BUFFER}, | |
54310121 | 3954 | $bytesToRead, |
3955 | $bufferLength); | |
2ed511ec | 3956 | warn "bytesToRead=$bytesToRead, bufferLength=$bufferLength, buffer=$self->{BUFFER}\n" if DEBUG; |
71f3e297 | 3957 | $self->{BUFFER} = '' unless defined $self->{BUFFER}; |
54310121 | 3958 | |
47e3cabd | 3959 | # An apparent bug in the Apache server causes the read() |
54310121 | 3960 | # to return zero bytes repeatedly without blocking if the |
3961 | # remote user aborts during a file transfer. I don't know how | |
3962 | # they manage this, but the workaround is to abort if we get | |
3963 | # more than SPIN_LOOP_MAX consecutive zero reads. | |
29ddc2a4 | 3964 | if ($bytesRead <= 0) { |
54310121 | 3965 | die "CGI.pm: Server closed socket during multipart read (client aborted?).\n" |
3966 | if ($self->{ZERO_LOOP_COUNTER}++ >= $SPIN_LOOP_MAX); | |
3967 | } else { | |
3968 | $self->{ZERO_LOOP_COUNTER}=0; | |
3969 | } | |
3970 | ||
29ddc2a4 | 3971 | $self->{LENGTH} -= $bytesRead if !$self->{CHUNKED} && $bytesRead; |
54310121 | 3972 | } |
3973 | END_OF_FUNC | |
3974 | ||
3975 | ||
3976 | # Return true when we've finished reading | |
3977 | 'eof' => <<'END_OF_FUNC' | |
3978 | sub eof { | |
3979 | my($self) = @_; | |
3980 | return 1 if (length($self->{BUFFER}) == 0) | |
3981 | && ($self->{LENGTH} <= 0); | |
3982 | undef; | |
3983 | } | |
3984 | END_OF_FUNC | |
3985 | ||
3986 | ); | |
3987 | END_OF_AUTOLOAD | |
3988 | ||
3989 | #################################################################################### | |
3990 | ################################## TEMPORARY FILES ################################# | |
3991 | #################################################################################### | |
ac734d8b | 3992 | package CGITempFile; |
54310121 | 3993 | |
cff99809 | 3994 | sub find_tempdir { |
cff99809 JH |
3995 | $SL = $CGI::SL; |
3996 | $MAC = $CGI::OS eq 'MACINTOSH'; | |
3997 | my ($vol) = $MAC ? MacPerl::Volumes() =~ /:(.*)/ : ""; | |
0a9bdad4 | 3998 | unless (defined $TMPDIRECTORY) { |
424ec8fa | 3999 | @TEMP=("${SL}usr${SL}tmp","${SL}var${SL}tmp", |
3538e1d5 | 4000 | "C:${SL}temp","${SL}tmp","${SL}temp", |
3d1a2ec4 | 4001 | "${vol}${SL}Temporary Items", |
ba056755 JH |
4002 | "${SL}WWW_ROOT", "${SL}SYS\$SCRATCH", |
4003 | "C:${SL}system${SL}temp"); | |
188ba755 | 4004 | unshift(@TEMP,$ENV{'TMPDIR'}) if defined $ENV{'TMPDIR'}; |
3538e1d5 | 4005 | |
3d1a2ec4 GS |
4006 | # this feature was supposed to provide per-user tmpfiles, but |
4007 | # it is problematic. | |
3538e1d5 GS |
4008 | # unshift(@TEMP,(getpwuid($<))[7].'/tmp') if $CGI::OS eq 'UNIX'; |
4009 | # Rob: getpwuid() is unfortunately UNIX specific. On brain dead OS'es this | |
4010 | # : can generate a 'getpwuid() not implemented' exception, even though | |
4011 | # : it's never called. Found under DOS/Win with the DJGPP perl port. | |
4012 | # : Refer to getpwuid() only at run-time if we're fortunate and have UNIX. | |
3d1a2ec4 | 4013 | # unshift(@TEMP,(eval {(getpwuid($>))[7]}).'/tmp') if $CGI::OS eq 'UNIX' and $> != 0; |
3538e1d5 | 4014 | |
54310121 | 4015 | foreach (@TEMP) { |
cff99809 | 4016 | do {$TMPDIRECTORY = $_; last} if -d $_ && -w _; |
54310121 | 4017 | } |
cff99809 JH |
4018 | } |
4019 | $TMPDIRECTORY = $MAC ? "" : "." unless $TMPDIRECTORY; | |
54310121 | 4020 | } |
4021 | ||
cff99809 JH |
4022 | find_tempdir(); |
4023 | ||
424ec8fa | 4024 | $MAXTRIES = 5000; |
54310121 | 4025 | |
4026 | # cute feature, but overload implementation broke it | |
4027 | # %OVERLOAD = ('""'=>'as_string'); | |
ac734d8b | 4028 | *CGITempFile::AUTOLOAD = \&CGI::AUTOLOAD; |
54310121 | 4029 | |
2371fea9 JH |
4030 | sub DESTROY { |
4031 | my($self) = @_; | |
188ba755 JH |
4032 | $$self =~ m!^([a-zA-Z0-9_ \'\":/.\$\\-]+)$! || return; |
4033 | my $safe = $1; # untaint operation | |
4034 | unlink $safe; # get rid of the file | |
2371fea9 JH |
4035 | } |
4036 | ||
54310121 | 4037 | ############################################################################### |
4038 | ################# THESE FUNCTIONS ARE AUTOLOADED ON DEMAND #################### | |
4039 | ############################################################################### | |
4040 | $AUTOLOADED_ROUTINES = ''; # prevent -w error | |
4041 | $AUTOLOADED_ROUTINES=<<'END_OF_AUTOLOAD'; | |
4042 | %SUBS = ( | |
4043 | ||
4044 | 'new' => <<'END_OF_FUNC', | |
4045 | sub new { | |
3538e1d5 GS |
4046 | my($package,$sequence) = @_; |
4047 | my $filename; | |
cff99809 | 4048 | find_tempdir() unless -w $TMPDIRECTORY; |
3538e1d5 | 4049 | for (my $i = 0; $i < $MAXTRIES; $i++) { |
8c32f149 | 4050 | last if ! -f ($filename = sprintf("\%s${SL}CGItemp%d", $TMPDIRECTORY, $sequence++)); |
424ec8fa | 4051 | } |
188ba755 | 4052 | # check that it is a more-or-less valid filename |
bb8b3399 | 4053 | return unless $filename =~ m!^([a-zA-Z0-9_\+ \'\":/.\$\\-]+)$!; |
188ba755 JH |
4054 | # this used to untaint, now it doesn't |
4055 | # $filename = $1; | |
3538e1d5 | 4056 | return bless \$filename; |
54310121 | 4057 | } |
4058 | END_OF_FUNC | |
4059 | ||
54310121 | 4060 | 'as_string' => <<'END_OF_FUNC' |
4061 | sub as_string { | |
4062 | my($self) = @_; | |
4063 | return $$self; | |
4064 | } | |
4065 | END_OF_FUNC | |
4066 | ||
4067 | ); | |
4068 | END_OF_AUTOLOAD | |
4069 | ||
4070 | package CGI; | |
4071 | ||
4072 | # We get a whole bunch of warnings about "possibly uninitialized variables" | |
4073 | # when running with the -w switch. Touch them all once to get rid of the | |
4074 | # warnings. This is ugly and I hate it. | |
4075 | if ($^W) { | |
4076 | $CGI::CGI = ''; | |
4077 | $CGI::CGI=<<EOF; | |
4078 | $CGI::VERSION; | |
4079 | $MultipartBuffer::SPIN_LOOP_MAX; | |
4080 | $MultipartBuffer::CRLF; | |
4081 | $MultipartBuffer::TIMEOUT; | |
424ec8fa | 4082 | $MultipartBuffer::INITIAL_FILLUNIT; |
54310121 | 4083 | EOF |
4084 | ; | |
4085 | } | |
4086 | ||
424ec8fa | 4087 | 1; |
54310121 | 4088 | |
4089 | __END__ | |
4090 | ||
4091 | =head1 NAME | |
4092 | ||
4093 | CGI - Simple Common Gateway Interface Class | |
4094 | ||
dc848c6f | 4095 | =head1 SYNOPSIS |
4096 | ||
424ec8fa GS |
4097 | # CGI script that creates a fill-out form |
4098 | # and echoes back its values. | |
4099 | ||
4100 | use CGI qw/:standard/; | |
4101 | print header, | |
4102 | start_html('A Simple Example'), | |
4103 | h1('A Simple Example'), | |
4104 | start_form, | |
4105 | "What's your name? ",textfield('name'),p, | |
4106 | "What's the combination?", p, | |
4107 | checkbox_group(-name=>'words', | |
4108 | -values=>['eenie','meenie','minie','moe'], | |
4109 | -defaults=>['eenie','minie']), p, | |
4110 | "What's your favorite color? ", | |
4111 | popup_menu(-name=>'color', | |
4112 | -values=>['red','green','blue','chartreuse']),p, | |
4113 | submit, | |
4114 | end_form, | |
4115 | hr; | |
4116 | ||
4117 | if (param()) { | |
7dc108d1 SP |
4118 | my $name = param('name'); |
4119 | my $keywords = join ', ',param('words'); | |
4120 | my $color = param('color'); | |
4121 | print "Your name is",em(escapeHTML($name)),p, | |
4122 | "The keywords are: ",em(escapeHTML($keywords)),p, | |
4123 | "Your favorite color is ",em(escapeHTML($color)), | |
424ec8fa GS |
4124 | hr; |
4125 | } | |
dc848c6f | 4126 | |
384f06ae SP |
4127 | print end_html; |
4128 | ||
54310121 | 4129 | =head1 ABSTRACT |
4130 | ||
424ec8fa GS |
4131 | This perl library uses perl5 objects to make it easy to create Web |
4132 | fill-out forms and parse their contents. This package defines CGI | |
4133 | objects, entities that contain the values of the current query string | |
4134 | and other state variables. Using a CGI object's methods, you can | |
4135 | examine keywords and parameters passed to your script, and create | |
4136 | forms whose initial values are taken from the current query (thereby | |
4137 | preserving state information). The module provides shortcut functions | |
4138 | that produce boilerplate HTML, reducing typing and coding errors. It | |
4139 | also provides functionality for some of the more advanced features of | |
4140 | CGI scripting, including support for file uploads, cookies, cascading | |
4141 | style sheets, server push, and frames. | |
4142 | ||
4143 | CGI.pm also provides a simple function-oriented programming style for | |
4144 | those who don't need its object-oriented features. | |
54310121 | 4145 | |
4146 | The current version of CGI.pm is available at | |
4147 | ||
4148 | http://www.genome.wi.mit.edu/ftp/pub/software/WWW/cgi_docs.html | |
4149 | ftp://ftp-genome.wi.mit.edu/pub/software/WWW/ | |
4150 | ||
424ec8fa | 4151 | =head1 DESCRIPTION |
47e3cabd | 4152 | |
424ec8fa GS |
4153 | =head2 PROGRAMMING STYLE |
4154 | ||
4155 | There are two styles of programming with CGI.pm, an object-oriented | |
4156 | style and a function-oriented style. In the object-oriented style you | |
4157 | create one or more CGI objects and then use object methods to create | |
4158 | the various elements of the page. Each CGI object starts out with the | |
4159 | list of named parameters that were passed to your CGI script by the | |
4160 | server. You can modify the objects, save them to a file or database | |
4161 | and recreate them. Because each object corresponds to the "state" of | |
4162 | the CGI script, and because each object's parameter list is | |
4163 | independent of the others, this allows you to save the state of the | |
4164 | script and restore it later. | |
4165 | ||
f610777f | 4166 | For example, using the object oriented style, here is how you create |
424ec8fa GS |
4167 | a simple "Hello World" HTML page: |
4168 | ||
3538e1d5 | 4169 | #!/usr/local/bin/perl -w |
424ec8fa GS |
4170 | use CGI; # load CGI routines |
4171 | $q = new CGI; # create new CGI object | |
4172 | print $q->header, # create the HTTP header | |
4173 | $q->start_html('hello world'), # start the HTML | |
4174 | $q->h1('hello world'), # level 1 header | |
4175 | $q->end_html; # end the HTML | |
4176 | ||
4177 | In the function-oriented style, there is one default CGI object that | |
4178 | you rarely deal with directly. Instead you just call functions to | |
4179 | retrieve CGI parameters, create HTML tags, manage cookies, and so | |
4180 | on. This provides you with a cleaner programming interface, but | |
4181 | limits you to using one CGI object at a time. The following example | |
4182 | prints the same page, but uses the function-oriented interface. | |
4183 | The main differences are that we now need to import a set of functions | |
4184 | into our name space (usually the "standard" functions), and we don't | |
4185 | need to create the CGI object. | |
4186 | ||
71f3e297 | 4187 | #!/usr/local/bin/perl |
424ec8fa GS |
4188 | use CGI qw/:standard/; # load standard CGI routines |
4189 | print header, # create the HTTP header | |
4190 | start_html('hello world'), # start the HTML | |
4191 | h1('hello world'), # level 1 header | |
4192 | end_html; # end the HTML | |
4193 | ||
4194 | The examples in this document mainly use the object-oriented style. | |
4195 | See HOW TO IMPORT FUNCTIONS for important information on | |
4196 | function-oriented programming in CGI.pm | |
4197 | ||
4198 | =head2 CALLING CGI.PM ROUTINES | |
4199 | ||
4200 | Most CGI.pm routines accept several arguments, sometimes as many as 20 | |
4201 | optional ones! To simplify this interface, all routines use a named | |
4202 | argument calling style that looks like this: | |
4203 | ||
4204 | print $q->header(-type=>'image/gif',-expires=>'+3d'); | |
4205 | ||
4206 | Each argument name is preceded by a dash. Neither case nor order | |
4207 | matters in the argument list. -type, -Type, and -TYPE are all | |
4208 | acceptable. In fact, only the first argument needs to begin with a | |
4209 | dash. If a dash is present in the first argument, CGI.pm assumes | |
4210 | dashes for the subsequent ones. | |
4211 | ||
424ec8fa GS |
4212 | Several routines are commonly called with just one argument. In the |
4213 | case of these routines you can provide the single argument without an | |
4214 | argument name. header() happens to be one of these routines. In this | |
4215 | case, the single argument is the document type. | |
4216 | ||
4217 | print $q->header('text/html'); | |
4218 | ||
4219 | Other such routines are documented below. | |
4220 | ||
4221 | Sometimes named arguments expect a scalar, sometimes a reference to an | |
4222 | array, and sometimes a reference to a hash. Often, you can pass any | |
4223 | type of argument and the routine will do whatever is most appropriate. | |
4224 | For example, the param() routine is used to set a CGI parameter to a | |
4225 | single or a multi-valued value. The two cases are shown below: | |
4226 | ||
4227 | $q->param(-name=>'veggie',-value=>'tomato'); | |
3d1a2ec4 | 4228 | $q->param(-name=>'veggie',-value=>['tomato','tomahto','potato','potahto']); |
424ec8fa GS |
4229 | |
4230 | A large number of routines in CGI.pm actually aren't specifically | |
4231 | defined in the module, but are generated automatically as needed. | |
4232 | These are the "HTML shortcuts," routines that generate HTML tags for | |
4233 | use in dynamically-generated pages. HTML tags have both attributes | |
4234 | (the attribute="value" pairs within the tag itself) and contents (the | |
4235 | part between the opening and closing pairs.) To distinguish between | |
4236 | attributes and contents, CGI.pm uses the convention of passing HTML | |
4237 | attributes as a hash reference as the first argument, and the | |
4238 | contents, if any, as any subsequent arguments. It works out like | |
4239 | this: | |
4240 | ||
4241 | Code Generated HTML | |
4242 | ---- -------------- | |
3acbd4f5 JH |
4243 | h1() <h1> |
4244 | h1('some','contents'); <h1>some contents</h1> | |
188ba755 JH |
4245 | h1({-align=>left}); <h1 align="LEFT"> |
4246 | h1({-align=>left},'contents'); <h1 align="LEFT">contents</h1> | |
424ec8fa | 4247 | |
188ba755 | 4248 | HTML tags are described in more detail later. |
424ec8fa GS |
4249 | |
4250 | Many newcomers to CGI.pm are puzzled by the difference between the | |
4251 | calling conventions for the HTML shortcuts, which require curly braces | |
4252 | around the HTML tag attributes, and the calling conventions for other | |
4253 | routines, which manage to generate attributes without the curly | |
4254 | brackets. Don't be confused. As a convenience the curly braces are | |
4255 | optional in all but the HTML shortcuts. If you like, you can use | |
4256 | curly braces when calling any routine that takes named arguments. For | |
4257 | example: | |
4258 | ||
4259 | print $q->header( {-type=>'image/gif',-expires=>'+3d'} ); | |
4260 | ||
4261 | If you use the B<-w> switch, you will be warned that some CGI.pm argument | |
4262 | names conflict with built-in Perl functions. The most frequent of | |
4263 | these is the -values argument, used to create multi-valued menus, | |
4264 | radio button clusters and the like. To get around this warning, you | |
4265 | have several choices: | |
54310121 | 4266 | |
424ec8fa | 4267 | =over 4 |
54310121 | 4268 | |
551e1d92 RB |
4269 | =item 1. |
4270 | ||
4271 | Use another name for the argument, if one is available. | |
4272 | For example, -value is an alias for -values. | |
54310121 | 4273 | |
551e1d92 | 4274 | =item 2. |
54310121 | 4275 | |
551e1d92 RB |
4276 | Change the capitalization, e.g. -Values |
4277 | ||
4278 | =item 3. | |
4279 | ||
4280 | Put quotes around the argument name, e.g. '-values' | |
54310121 | 4281 | |
424ec8fa | 4282 | =back |
54310121 | 4283 | |
424ec8fa GS |
4284 | Many routines will do something useful with a named argument that it |
4285 | doesn't recognize. For example, you can produce non-standard HTTP | |
4286 | header fields by providing them as named arguments: | |
54310121 | 4287 | |
424ec8fa GS |
4288 | print $q->header(-type => 'text/html', |
4289 | -cost => 'Three smackers', | |
4290 | -annoyance_level => 'high', | |
4291 | -complaints_to => 'bit bucket'); | |
54310121 | 4292 | |
424ec8fa GS |
4293 | This will produce the following nonstandard HTTP header: |
4294 | ||
4295 | HTTP/1.0 200 OK | |
4296 | Cost: Three smackers | |
4297 | Annoyance-level: high | |
4298 | Complaints-to: bit bucket | |
4299 | Content-type: text/html | |
4300 | ||
4301 | Notice the way that underscores are translated automatically into | |
4302 | hyphens. HTML-generating routines perform a different type of | |
4303 | translation. | |
4304 | ||
4305 | This feature allows you to keep up with the rapidly changing HTTP and | |
4306 | HTML "standards". | |
54310121 | 4307 | |
424ec8fa | 4308 | =head2 CREATING A NEW QUERY OBJECT (OBJECT-ORIENTED STYLE): |
54310121 | 4309 | |
4310 | $query = new CGI; | |
4311 | ||
4312 | This will parse the input (from both POST and GET methods) and store | |
681699b9 SP |
4313 | it into a perl5 object called $query. |
4314 | ||
4315 | Any filehandles from file uploads will have their position reset to | |
4316 | the beginning of the file. | |
54310121 | 4317 | |
4318 | =head2 CREATING A NEW QUERY OBJECT FROM AN INPUT FILE | |
4319 | ||
4320 | $query = new CGI(INPUTFILE); | |
4321 | ||
424ec8fa GS |
4322 | If you provide a file handle to the new() method, it will read |
4323 | parameters from the file (or STDIN, or whatever). The file can be in | |
4324 | any of the forms describing below under debugging (i.e. a series of | |
4325 | newline delimited TAG=VALUE pairs will work). Conveniently, this type | |
4326 | of file is created by the save() method (see below). Multiple records | |
4327 | can be saved and restored. | |
54310121 | 4328 | |
4329 | Perl purists will be pleased to know that this syntax accepts | |
4330 | references to file handles, or even references to filehandle globs, | |
4331 | which is the "official" way to pass a filehandle: | |
4332 | ||
4333 | $query = new CGI(\*STDIN); | |
4334 | ||
424ec8fa GS |
4335 | You can also initialize the CGI object with a FileHandle or IO::File |
4336 | object. | |
4337 | ||
4338 | If you are using the function-oriented interface and want to | |
4339 | initialize CGI state from a file handle, the way to do this is with | |
4340 | B<restore_parameters()>. This will (re)initialize the | |
4341 | default CGI object from the indicated file handle. | |
4342 | ||
4343 | open (IN,"test.in") || die; | |
4344 | restore_parameters(IN); | |
4345 | close IN; | |
4346 | ||
54310121 | 4347 | You can also initialize the query object from an associative array |
4348 | reference: | |
4349 | ||
4350 | $query = new CGI( {'dinosaur'=>'barney', | |
4351 | 'song'=>'I love you', | |
4352 | 'friends'=>[qw/Jessica George Nancy/]} | |
4353 | ); | |
4354 | ||
4355 | or from a properly formatted, URL-escaped query string: | |
4356 | ||
4357 | $query = new CGI('dinosaur=barney&color=purple'); | |
4358 | ||
424ec8fa GS |
4359 | or from a previously existing CGI object (currently this clones the |
4360 | parameter list, but none of the other object-specific fields, such as | |
4361 | autoescaping): | |
4362 | ||
4363 | $old_query = new CGI; | |
4364 | $new_query = new CGI($old_query); | |
4365 | ||
54310121 | 4366 | To create an empty query, initialize it from an empty string or hash: |
4367 | ||
424ec8fa GS |
4368 | $empty_query = new CGI(""); |
4369 | ||
4370 | -or- | |
4371 | ||
4372 | $empty_query = new CGI({}); | |
54310121 | 4373 | |
4374 | =head2 FETCHING A LIST OF KEYWORDS FROM THE QUERY: | |
4375 | ||
4376 | @keywords = $query->keywords | |
4377 | ||
4378 | If the script was invoked as the result of an <ISINDEX> search, the | |
4379 | parsed keywords can be obtained as an array using the keywords() method. | |
4380 | ||
4381 | =head2 FETCHING THE NAMES OF ALL THE PARAMETERS PASSED TO YOUR SCRIPT: | |
4382 | ||
4383 | @names = $query->param | |
4384 | ||
4385 | If the script was invoked with a parameter list | |
3d1a2ec4 GS |
4386 | (e.g. "name1=value1&name2=value2&name3=value3"), the param() method |
4387 | will return the parameter names as a list. If the script was invoked | |
4388 | as an <ISINDEX> script and contains a string without ampersands | |
4389 | (e.g. "value1+value2+value3") , there will be a single parameter named | |
4390 | "keywords" containing the "+"-delimited keywords. | |
54310121 | 4391 | |
4392 | NOTE: As of version 1.5, the array of parameter names returned will | |
4393 | be in the same order as they were submitted by the browser. | |
4394 | Usually this order is the same as the order in which the | |
4395 | parameters are defined in the form (however, this isn't part | |
4396 | of the spec, and so isn't guaranteed). | |
4397 | ||
4398 | =head2 FETCHING THE VALUE OR VALUES OF A SINGLE NAMED PARAMETER: | |
4399 | ||
4400 | @values = $query->param('foo'); | |
4401 | ||
4402 | -or- | |
4403 | ||
4404 | $value = $query->param('foo'); | |
4405 | ||
4406 | Pass the param() method a single argument to fetch the value of the | |
4407 | named parameter. If the parameter is multivalued (e.g. from multiple | |
4408 | selections in a scrolling list), you can ask to receive an array. Otherwise | |
4409 | the method will return a single value. | |
4410 | ||
3d1a2ec4 GS |
4411 | If a value is not given in the query string, as in the queries |
4412 | "name1=&name2=" or "name1&name2", it will be returned as an empty | |
4413 | string. This feature is new in 2.63. | |
4414 | ||
8f3ccfa2 JH |
4415 | |
4416 | If the parameter does not exist at all, then param() will return undef | |
4417 | in a scalar context, and the empty list in a list context. | |
4418 | ||
4419 | ||
54310121 | 4420 | =head2 SETTING THE VALUE(S) OF A NAMED PARAMETER: |
4421 | ||
4422 | $query->param('foo','an','array','of','values'); | |
4423 | ||
4424 | This sets the value for the named parameter 'foo' to an array of | |
4425 | values. This is one way to change the value of a field AFTER | |
4426 | the script has been invoked once before. (Another way is with | |
4427 | the -override parameter accepted by all methods that generate | |
4428 | form elements.) | |
4429 | ||
4430 | param() also recognizes a named parameter style of calling described | |
4431 | in more detail later: | |
4432 | ||
4433 | $query->param(-name=>'foo',-values=>['an','array','of','values']); | |
4434 | ||
4435 | -or- | |
4436 | ||
4437 | $query->param(-name=>'foo',-value=>'the value'); | |
4438 | ||
4439 | =head2 APPENDING ADDITIONAL VALUES TO A NAMED PARAMETER: | |
4440 | ||
424ec8fa | 4441 | $query->append(-name=>'foo',-values=>['yet','more','values']); |
54310121 | 4442 | |
4443 | This adds a value or list of values to the named parameter. The | |
4444 | values are appended to the end of the parameter if it already exists. | |
4445 | Otherwise the parameter is created. Note that this method only | |
4446 | recognizes the named argument calling syntax. | |
4447 | ||
4448 | =head2 IMPORTING ALL PARAMETERS INTO A NAMESPACE: | |
4449 | ||
4450 | $query->import_names('R'); | |
4451 | ||
4452 | This creates a series of variables in the 'R' namespace. For example, | |
4453 | $R::foo, @R:foo. For keyword lists, a variable @R::keywords will appear. | |
4454 | If no namespace is given, this method will assume 'Q'. | |
4455 | WARNING: don't import anything into 'main'; this is a major security | |
4456 | risk!!!! | |
4457 | ||
8f3ccfa2 JH |
4458 | NOTE 1: Variable names are transformed as necessary into legal Perl |
4459 | variable names. All non-legal characters are transformed into | |
4460 | underscores. If you need to keep the original names, you should use | |
4461 | the param() method instead to access CGI variables by name. | |
4462 | ||
4463 | NOTE 2: In older versions, this method was called B<import()>. As of version 2.20, | |
54310121 | 4464 | this name has been removed completely to avoid conflict with the built-in |
4465 | Perl module B<import> operator. | |
4466 | ||
4467 | =head2 DELETING A PARAMETER COMPLETELY: | |
4468 | ||
188ba755 | 4469 | $query->delete('foo','bar','baz'); |
54310121 | 4470 | |
188ba755 JH |
4471 | This completely clears a list of parameters. It sometimes useful for |
4472 | resetting parameters that you don't want passed down between script | |
4473 | invocations. | |
54310121 | 4474 | |
424ec8fa GS |
4475 | If you are using the function call interface, use "Delete()" instead |
4476 | to avoid conflicts with Perl's built-in delete operator. | |
4477 | ||
54310121 | 4478 | =head2 DELETING ALL PARAMETERS: |
4479 | ||
424ec8fa | 4480 | $query->delete_all(); |
54310121 | 4481 | |
4482 | This clears the CGI object completely. It might be useful to ensure | |
4483 | that all the defaults are taken when you create a fill-out form. | |
4484 | ||
424ec8fa GS |
4485 | Use Delete_all() instead if you are using the function call interface. |
4486 | ||
0a9bdad4 SP |
4487 | =head2 HANDLING NON-URLENCODED ARGUMENTS |
4488 | ||
4489 | ||
4490 | If POSTed data is not of type application/x-www-form-urlencoded or | |
4491 | multipart/form-data, then the POSTed data will not be processed, but | |
4492 | instead be returned as-is in a parameter named POSTDATA. To retrieve | |
4493 | it, use code like this: | |
4494 | ||
4495 | my $data = $query->param('POSTDATA'); | |
4496 | ||
bb8b3399 SP |
4497 | Likewise if PUTed data can be retrieved with code like this: |
4498 | ||
4499 | my $data = $query->param('PUTDATA'); | |
4500 | ||
0a9bdad4 SP |
4501 | (If you don't know what the preceding means, don't worry about it. It |
4502 | only affects people trying to use CGI for XML processing and other | |
4503 | specialized tasks.) | |
4504 | ||
4505 | ||
424ec8fa GS |
4506 | =head2 DIRECT ACCESS TO THE PARAMETER LIST: |
4507 | ||
4508 | $q->param_fetch('address')->[1] = '1313 Mockingbird Lane'; | |
4509 | unshift @{$q->param_fetch(-name=>'address')},'George Munster'; | |
4510 | ||
4511 | If you need access to the parameter list in a way that isn't covered | |
4512 | by the methods above, you can obtain a direct reference to it by | |
4513 | calling the B<param_fetch()> method with the name of the . This | |
4514 | will return an array reference to the named parameters, which you then | |
4515 | can manipulate in any way you like. | |
4516 | ||
4517 | You can also use a named argument style using the B<-name> argument. | |
4518 | ||
3538e1d5 GS |
4519 | =head2 FETCHING THE PARAMETER LIST AS A HASH: |
4520 | ||
4521 | $params = $q->Vars; | |
4522 | print $params->{'address'}; | |
4523 | @foo = split("\0",$params->{'foo'}); | |
4524 | %params = $q->Vars; | |
4525 | ||
4526 | use CGI ':cgi-lib'; | |
4527 | $params = Vars; | |
4528 | ||
4529 | Many people want to fetch the entire parameter list as a hash in which | |
4530 | the keys are the names of the CGI parameters, and the values are the | |
4531 | parameters' values. The Vars() method does this. Called in a scalar | |
4532 | context, it returns the parameter list as a tied hash reference. | |
4533 | Changing a key changes the value of the parameter in the underlying | |
a3b3a725 | 4534 | CGI parameter list. Called in a list context, it returns the |
3538e1d5 GS |
4535 | parameter list as an ordinary hash. This allows you to read the |
4536 | contents of the parameter list, but not to change it. | |
4537 | ||
4538 | When using this, the thing you must watch out for are multivalued CGI | |
4539 | parameters. Because a hash cannot distinguish between scalar and | |
a3b3a725 | 4540 | list context, multivalued parameters will be returned as a packed |
3538e1d5 GS |
4541 | string, separated by the "\0" (null) character. You must split this |
4542 | packed string in order to get at the individual values. This is the | |
4543 | convention introduced long ago by Steve Brenner in his cgi-lib.pl | |
4544 | module for Perl version 4. | |
4545 | ||
4546 | If you wish to use Vars() as a function, import the I<:cgi-lib> set of | |
4547 | function calls (also see the section on CGI-LIB compatibility). | |
4548 | ||
424ec8fa | 4549 | =head2 SAVING THE STATE OF THE SCRIPT TO A FILE: |
54310121 | 4550 | |
29ddc2a4 | 4551 | $query->save(\*FILEHANDLE) |
54310121 | 4552 | |
4553 | This will write the current state of the form to the provided | |
4554 | filehandle. You can read it back in by providing a filehandle | |
4555 | to the new() method. Note that the filehandle can be a file, a pipe, | |
4556 | or whatever! | |
4557 | ||
4558 | The format of the saved file is: | |
4559 | ||
4560 | NAME1=VALUE1 | |
4561 | NAME1=VALUE1' | |
4562 | NAME2=VALUE2 | |
4563 | NAME3=VALUE3 | |
4564 | = | |
4565 | ||
4566 | Both name and value are URL escaped. Multi-valued CGI parameters are | |
4567 | represented as repeated names. A session record is delimited by a | |
4568 | single = symbol. You can write out multiple records and read them | |
4569 | back in with several calls to B<new>. You can do this across several | |
4570 | sessions by opening the file in append mode, allowing you to create | |
4571 | primitive guest books, or to keep a history of users' queries. Here's | |
4572 | a short example of creating multiple session records: | |
4573 | ||
4574 | use CGI; | |
4575 | ||
4576 | open (OUT,">>test.out") || die; | |
4577 | $records = 5; | |
4578 | foreach (0..$records) { | |
4579 | my $q = new CGI; | |
4580 | $q->param(-name=>'counter',-value=>$_); | |
29ddc2a4 | 4581 | $q->save(\*OUT); |
54310121 | 4582 | } |
4583 | close OUT; | |
4584 | ||
4585 | # reopen for reading | |
4586 | open (IN,"test.out") || die; | |
4587 | while (!eof(IN)) { | |
29ddc2a4 | 4588 | my $q = new CGI(\*IN); |
54310121 | 4589 | print $q->param('counter'),"\n"; |
4590 | } | |
4591 | ||
4592 | The file format used for save/restore is identical to that used by the | |
4593 | Whitehead Genome Center's data exchange format "Boulderio", and can be | |
4594 | manipulated and even databased using Boulderio utilities. See | |
3cb6de81 | 4595 | |
3538e1d5 | 4596 | http://stein.cshl.org/boulder/ |
54310121 | 4597 | |
4598 | for further details. | |
4599 | ||
424ec8fa GS |
4600 | If you wish to use this method from the function-oriented (non-OO) |
4601 | interface, the exported name for this method is B<save_parameters()>. | |
54310121 | 4602 | |
3538e1d5 GS |
4603 | =head2 RETRIEVING CGI ERRORS |
4604 | ||
4605 | Errors can occur while processing user input, particularly when | |
4606 | processing uploaded files. When these errors occur, CGI will stop | |
4607 | processing and return an empty parameter list. You can test for | |
4608 | the existence and nature of errors using the I<cgi_error()> function. | |
4609 | The error messages are formatted as HTTP status codes. You can either | |
4610 | incorporate the error text into an HTML page, or use it as the value | |
4611 | of the HTTP status: | |
4612 | ||
4613 | my $error = $q->cgi_error; | |
4614 | if ($error) { | |
4615 | print $q->header(-status=>$error), | |
4616 | $q->start_html('Problems'), | |
4617 | $q->h2('Request not processed'), | |
4618 | $q->strong($error); | |
4619 | exit 0; | |
4620 | } | |
4621 | ||
4622 | When using the function-oriented interface (see the next section), | |
4623 | errors may only occur the first time you call I<param()>. Be ready | |
4624 | for this! | |
4625 | ||
424ec8fa | 4626 | =head2 USING THE FUNCTION-ORIENTED INTERFACE |
54310121 | 4627 | |
424ec8fa GS |
4628 | To use the function-oriented interface, you must specify which CGI.pm |
4629 | routines or sets of routines to import into your script's namespace. | |
4630 | There is a small overhead associated with this importation, but it | |
4631 | isn't much. | |
54310121 | 4632 | |
424ec8fa | 4633 | use CGI <list of methods>; |
54310121 | 4634 | |
424ec8fa GS |
4635 | The listed methods will be imported into the current package; you can |
4636 | call them directly without creating a CGI object first. This example | |
4637 | shows how to import the B<param()> and B<header()> | |
4638 | methods, and then use them directly: | |
54310121 | 4639 | |
424ec8fa GS |
4640 | use CGI 'param','header'; |
4641 | print header('text/plain'); | |
4642 | $zipcode = param('zipcode'); | |
54310121 | 4643 | |
424ec8fa | 4644 | More frequently, you'll import common sets of functions by referring |
f610777f | 4645 | to the groups by name. All function sets are preceded with a ":" |
424ec8fa | 4646 | character as in ":html3" (for tags defined in the HTML 3 standard). |
54310121 | 4647 | |
424ec8fa | 4648 | Here is a list of the function sets you can import: |
54310121 | 4649 | |
424ec8fa | 4650 | =over 4 |
54310121 | 4651 | |
424ec8fa | 4652 | =item B<:cgi> |
54310121 | 4653 | |
424ec8fa GS |
4654 | Import all CGI-handling methods, such as B<param()>, B<path_info()> |
4655 | and the like. | |
54310121 | 4656 | |
424ec8fa | 4657 | =item B<:form> |
54310121 | 4658 | |
424ec8fa | 4659 | Import all fill-out form generating methods, such as B<textfield()>. |
54310121 | 4660 | |
424ec8fa | 4661 | =item B<:html2> |
54310121 | 4662 | |
424ec8fa | 4663 | Import all methods that generate HTML 2.0 standard elements. |
54310121 | 4664 | |
424ec8fa | 4665 | =item B<:html3> |
54310121 | 4666 | |
3acbd4f5 | 4667 | Import all methods that generate HTML 3.0 elements (such as |
424ec8fa | 4668 | <table>, <super> and <sub>). |
54310121 | 4669 | |
3acbd4f5 JH |
4670 | =item B<:html4> |
4671 | ||
4672 | Import all methods that generate HTML 4 elements (such as | |
4673 | <abbrev>, <acronym> and <thead>). | |
4674 | ||
424ec8fa | 4675 | =item B<:netscape> |
54310121 | 4676 | |
424ec8fa | 4677 | Import all methods that generate Netscape-specific HTML extensions. |
54310121 | 4678 | |
424ec8fa | 4679 | =item B<:html> |
54310121 | 4680 | |
424ec8fa GS |
4681 | Import all HTML-generating shortcuts (i.e. 'html2' + 'html3' + |
4682 | 'netscape')... | |
54310121 | 4683 | |
424ec8fa | 4684 | =item B<:standard> |
54310121 | 4685 | |
3acbd4f5 | 4686 | Import "standard" features, 'html2', 'html3', 'html4', 'form' and 'cgi'. |
54310121 | 4687 | |
424ec8fa | 4688 | =item B<:all> |
54310121 | 4689 | |
424ec8fa | 4690 | Import all the available methods. For the full list, see the CGI.pm |
3538e1d5 | 4691 | code, where the variable %EXPORT_TAGS is defined. |
424ec8fa GS |
4692 | |
4693 | =back | |
4694 | ||
4695 | If you import a function name that is not part of CGI.pm, the module | |
4696 | will treat it as a new HTML tag and generate the appropriate | |
4697 | subroutine. You can then use it like any other HTML tag. This is to | |
4698 | provide for the rapidly-evolving HTML "standard." For example, say | |
3acbd4f5 | 4699 | Microsoft comes out with a new tag called <gradient> (which causes the |
424ec8fa GS |
4700 | user's desktop to be flooded with a rotating gradient fill until his |
4701 | machine reboots). You don't need to wait for a new version of CGI.pm | |
d23a249d | 4702 | to start using it immediately: |
424ec8fa GS |
4703 | |
4704 | use CGI qw/:standard :html3 gradient/; | |
4705 | print gradient({-start=>'red',-end=>'blue'}); | |
4706 | ||
4707 | Note that in the interests of execution speed CGI.pm does B<not> use | |
4708 | the standard L<Exporter> syntax for specifying load symbols. This may | |
4709 | change in the future. | |
4710 | ||
4711 | If you import any of the state-maintaining CGI or form-generating | |
4712 | methods, a default CGI object will be created and initialized | |
4713 | automatically the first time you use any of the methods that require | |
4714 | one to be present. This includes B<param()>, B<textfield()>, | |
4715 | B<submit()> and the like. (If you need direct access to the CGI | |
4716 | object, you can find it in the global variable B<$CGI::Q>). By | |
4717 | importing CGI.pm methods, you can create visually elegant scripts: | |
4718 | ||
4719 | use CGI qw/:standard/; | |
4720 | ||
4721 | header, | |
4722 | start_html('Simple Script'), | |
4723 | h1('Simple Script'), | |
4724 | start_form, | |
4725 | "What's your name? ",textfield('name'),p, | |
4726 | "What's the combination?", | |
4727 | checkbox_group(-name=>'words', | |
4728 | -values=>['eenie','meenie','minie','moe'], | |
4729 | -defaults=>['eenie','moe']),p, | |
4730 | "What's your favorite color?", | |
4731 | popup_menu(-name=>'color', | |
4732 | -values=>['red','green','blue','chartreuse']),p, | |
4733 | submit, | |
4734 | end_form, | |
4735 | hr,"\n"; | |
4736 | ||
4737 | if (param) { | |
4738 | ||
4739 | "Your name is ",em(param('name')),p, | |
4740 | "The keywords are: ",em(join(", ",param('words'))),p, | |
4741 | "Your favorite color is ",em(param('color')),".\n"; | |
4742 | } | |
4743 | print end_html; | |
4744 | ||
4745 | =head2 PRAGMAS | |
4746 | ||
4747 | In addition to the function sets, there are a number of pragmas that | |
4748 | you can import. Pragmas, which are always preceded by a hyphen, | |
4749 | change the way that CGI.pm functions in various ways. Pragmas, | |
4750 | function sets, and individual functions can all be imported in the | |
4751 | same use() line. For example, the following use statement imports the | |
3d1a2ec4 GS |
4752 | standard set of functions and enables debugging mode (pragma |
4753 | -debug): | |
424ec8fa | 4754 | |
3d1a2ec4 | 4755 | use CGI qw/:standard -debug/; |
424ec8fa GS |
4756 | |
4757 | The current list of pragmas is as follows: | |
4758 | ||
4759 | =over 4 | |
4760 | ||
4761 | =item -any | |
4762 | ||
4763 | When you I<use CGI -any>, then any method that the query object | |
4764 | doesn't recognize will be interpreted as a new HTML tag. This allows | |
4765 | you to support the next I<ad hoc> Netscape or Microsoft HTML | |
4766 | extension. This lets you go wild with new and unsupported tags: | |
4767 | ||
4768 | use CGI qw(-any); | |
4769 | $q=new CGI; | |
4770 | print $q->gradient({speed=>'fast',start=>'red',end=>'blue'}); | |
4771 | ||
4772 | Since using <cite>any</cite> causes any mistyped method name | |
4773 | to be interpreted as an HTML tag, use it with care or not at | |
4774 | all. | |
54310121 | 4775 | |
424ec8fa | 4776 | =item -compile |
54310121 | 4777 | |
424ec8fa GS |
4778 | This causes the indicated autoloaded methods to be compiled up front, |
4779 | rather than deferred to later. This is useful for scripts that run | |
4780 | for an extended period of time under FastCGI or mod_perl, and for | |
8869a4b7 | 4781 | those destined to be crunched by Malcolm Beattie's Perl compiler. Use |
f610777f | 4782 | it in conjunction with the methods or method families you plan to use. |
424ec8fa GS |
4783 | |
4784 | use CGI qw(-compile :standard :html3); | |
4785 | ||
4786 | or even | |
4787 | ||
4788 | use CGI qw(-compile :all); | |
4789 | ||
4790 | Note that using the -compile pragma in this way will always have | |
4791 | the effect of importing the compiled functions into the current | |
4792 | namespace. If you want to compile without importing use the | |
188ba755 JH |
4793 | compile() method instead: |
4794 | ||
4795 | use CGI(); | |
4796 | CGI->compile(); | |
4797 | ||
4798 | This is particularly useful in a mod_perl environment, in which you | |
4799 | might want to precompile all CGI routines in a startup script, and | |
4800 | then import the functions individually in each mod_perl script. | |
424ec8fa | 4801 | |
3d1a2ec4 GS |
4802 | =item -nosticky |
4803 | ||
29ddc2a4 RGS |
4804 | By default the CGI module implements a state-preserving behavior |
4805 | called "sticky" fields. The way this works is that if you are | |
4806 | regenerating a form, the methods that generate the form field values | |
4807 | will interrogate param() to see if similarly-named parameters are | |
4808 | present in the query string. If they find a like-named parameter, they | |
4809 | will use it to set their default values. | |
4810 | ||
4811 | Sometimes this isn't what you want. The B<-nosticky> pragma prevents | |
4812 | this behavior. You can also selectively change the sticky behavior in | |
4813 | each element that you generate. | |
3d1a2ec4 | 4814 | |
0a9bdad4 SP |
4815 | =item -tabindex |
4816 | ||
4817 | Automatically add tab index attributes to each form field. With this | |
4818 | option turned off, you can still add tab indexes manually by passing a | |
4819 | -tabindex option to each field-generating method. | |
4820 | ||
199d4a26 JH |
4821 | =item -no_undef_params |
4822 | ||
4823 | This keeps CGI.pm from including undef params in the parameter list. | |
4824 | ||
6b4ac661 JH |
4825 | =item -no_xhtml |
4826 | ||
4827 | By default, CGI.pm versions 2.69 and higher emit XHTML | |
4828 | (http://www.w3.org/TR/xhtml1/). The -no_xhtml pragma disables this | |
4829 | feature. Thanks to Michalis Kabrianis <kabrianis@hellug.gr> for this | |
4830 | feature. | |
4831 | ||
13548fdf RGS |
4832 | If start_html()'s -dtd parameter specifies an HTML 2.0 or 3.2 DTD, |
4833 | XHTML will automatically be disabled without needing to use this | |
4834 | pragma. | |
4835 | ||
bb8b3399 SP |
4836 | =item -utf8 |
4837 | ||
4838 | This makes CGI.pm treat all parameters as UTF-8 strings. Use this with | |
4839 | care, as it will interfere with the processing of binary uploads. It | |
4840 | is better to manually select which fields are expected to return utf-8 | |
4841 | strings and convert them using code like this: | |
4842 | ||
4843 | use Encode; | |
4844 | my $arg = decode utf8=>param('foo'); | |
4845 | ||
424ec8fa GS |
4846 | =item -nph |
4847 | ||
4848 | This makes CGI.pm produce a header appropriate for an NPH (no | |
4849 | parsed header) script. You may need to do other things as well | |
4850 | to tell the server that the script is NPH. See the discussion | |
4851 | of NPH scripts below. | |
4852 | ||
71f3e297 JH |
4853 | =item -newstyle_urls |
4854 | ||
4855 | Separate the name=value pairs in CGI parameter query strings with | |
4856 | semicolons rather than ampersands. For example: | |
4857 | ||
4858 | ?name=fred;age=24;favorite_color=3 | |
4859 | ||
4860 | Semicolon-delimited query strings are always accepted, but will not be | |
4861 | emitted by self_url() and query_string() unless the -newstyle_urls | |
4862 | pragma is specified. | |
4863 | ||
3d1a2ec4 GS |
4864 | This became the default in version 2.64. |
4865 | ||
4866 | =item -oldstyle_urls | |
4867 | ||
4868 | Separate the name=value pairs in CGI parameter query strings with | |
4869 | ampersands rather than semicolons. This is no longer the default. | |
4870 | ||
424ec8fa GS |
4871 | =item -autoload |
4872 | ||
4873 | This overrides the autoloader so that any function in your program | |
4874 | that is not recognized is referred to CGI.pm for possible evaluation. | |
4875 | This allows you to use all the CGI.pm functions without adding them to | |
4876 | your symbol table, which is of concern for mod_perl users who are | |
4877 | worried about memory consumption. I<Warning:> when | |
4878 | I<-autoload> is in effect, you cannot use "poetry mode" | |
4879 | (functions without the parenthesis). Use I<hr()> rather | |
4880 | than I<hr>, or add something like I<use subs qw/hr p header/> | |
4881 | to the top of your script. | |
4882 | ||
4883 | =item -no_debug | |
4884 | ||
4885 | This turns off the command-line processing features. If you want to | |
4886 | run a CGI.pm script from the command line to produce HTML, and you | |
3d1a2ec4 GS |
4887 | don't want it to read CGI parameters from the command line or STDIN, |
4888 | then use this pragma: | |
424ec8fa GS |
4889 | |
4890 | use CGI qw(-no_debug :standard); | |
4891 | ||
3d1a2ec4 | 4892 | =item -debug |
424ec8fa | 4893 | |
3d1a2ec4 GS |
4894 | This turns on full debugging. In addition to reading CGI arguments |
4895 | from the command-line processing, CGI.pm will pause and try to read | |
4896 | arguments from STDIN, producing the message "(offline mode: enter | |
4897 | name=value pairs on standard input)" features. | |
3cb6de81 | 4898 | |
424ec8fa GS |
4899 | See the section on debugging for more details. |
4900 | ||
4901 | =item -private_tempfiles | |
4902 | ||
3538e1d5 GS |
4903 | CGI.pm can process uploaded file. Ordinarily it spools the uploaded |
4904 | file to a temporary directory, then deletes the file when done. | |
4905 | However, this opens the risk of eavesdropping as described in the file | |
4906 | upload section. Another CGI script author could peek at this data | |
4907 | during the upload, even if it is confidential information. On Unix | |
4908 | systems, the -private_tempfiles pragma will cause the temporary file | |
4909 | to be unlinked as soon as it is opened and before any data is written | |
4910 | into it, reducing, but not eliminating the risk of eavesdropping | |
4911 | (there is still a potential race condition). To make life harder for | |
4912 | the attacker, the program chooses tempfile names by calculating a 32 | |
4913 | bit checksum of the incoming HTTP headers. | |
4914 | ||
4915 | To ensure that the temporary file cannot be read by other CGI scripts, | |
4916 | use suEXEC or a CGI wrapper program to run your script. The temporary | |
4917 | file is created with mode 0600 (neither world nor group readable). | |
4918 | ||
4919 | The temporary directory is selected using the following algorithm: | |
4920 | ||
4921 | 1. if the current user (e.g. "nobody") has a directory named | |
4922 | "tmp" in its home directory, use that (Unix systems only). | |
4923 | ||
4924 | 2. if the environment variable TMPDIR exists, use the location | |
4925 | indicated. | |
4926 | ||
4927 | 3. Otherwise try the locations /usr/tmp, /var/tmp, C:\temp, | |
4928 | /tmp, /temp, ::Temporary Items, and \WWW_ROOT. | |
4929 | ||
4930 | Each of these locations is checked that it is a directory and is | |
4931 | writable. If not, the algorithm tries the next choice. | |
71f3e297 JH |
4932 | |
4933 | =back | |
4934 | ||
4935 | =head2 SPECIAL FORMS FOR IMPORTING HTML-TAG FUNCTIONS | |
4936 | ||
4937 | Many of the methods generate HTML tags. As described below, tag | |
4938 | functions automatically generate both the opening and closing tags. | |
4939 | For example: | |
4940 | ||
4941 | print h1('Level 1 Header'); | |
4942 | ||
4943 | produces | |
4944 | ||
3acbd4f5 | 4945 | <h1>Level 1 Header</h1> |
71f3e297 JH |
4946 | |
4947 | There will be some times when you want to produce the start and end | |
4948 | tags yourself. In this case, you can use the form start_I<tag_name> | |
4949 | and end_I<tag_name>, as in: | |
4950 | ||
4951 | print start_h1,'Level 1 Header',end_h1; | |
4952 | ||
4953 | With a few exceptions (described below), start_I<tag_name> and | |
4954 | end_I<tag_name> functions are not generated automatically when you | |
4955 | I<use CGI>. However, you can specify the tags you want to generate | |
4956 | I<start/end> functions for by putting an asterisk in front of their | |
4957 | name, or, alternatively, requesting either "start_I<tag_name>" or | |
4958 | "end_I<tag_name>" in the import list. | |
4959 | ||
4960 | Example: | |
4961 | ||
4962 | use CGI qw/:standard *table start_ul/; | |
4963 | ||
4964 | In this example, the following functions are generated in addition to | |
4965 | the standard ones: | |
4966 | ||
4967 | =over 4 | |
4968 | ||
3acbd4f5 | 4969 | =item 1. start_table() (generates a <table> tag) |
71f3e297 | 4970 | |
3acbd4f5 | 4971 | =item 2. end_table() (generates a </table> tag) |
71f3e297 | 4972 | |
3acbd4f5 | 4973 | =item 3. start_ul() (generates a <ul> tag) |
71f3e297 | 4974 | |
3acbd4f5 | 4975 | =item 4. end_ul() (generates a </ul> tag) |
71f3e297 | 4976 | |
424ec8fa GS |
4977 | =back |
4978 | ||
4979 | =head1 GENERATING DYNAMIC DOCUMENTS | |
4980 | ||
4981 | Most of CGI.pm's functions deal with creating documents on the fly. | |
4982 | Generally you will produce the HTTP header first, followed by the | |
4983 | document itself. CGI.pm provides functions for generating HTTP | |
4984 | headers of various types as well as for generating HTML. For creating | |
4985 | GIF images, see the GD.pm module. | |
4986 | ||
4987 | Each of these functions produces a fragment of HTML or HTTP which you | |
4988 | can print out directly so that it displays in the browser window, | |
4989 | append to a string, or save to a file for later use. | |
4990 | ||
4991 | =head2 CREATING A STANDARD HTTP HEADER: | |
4992 | ||
4993 | Normally the first thing you will do in any CGI script is print out an | |
4994 | HTTP header. This tells the browser what type of document to expect, | |
4995 | and gives other optional information, such as the language, expiration | |
4996 | date, and whether to cache the document. The header can also be | |
4997 | manipulated for special purposes, such as server push and pay per view | |
4998 | pages. | |
54310121 | 4999 | |
29ddc2a4 | 5000 | print header; |
54310121 | 5001 | |
5002 | -or- | |
5003 | ||
29ddc2a4 | 5004 | print header('image/gif'); |
54310121 | 5005 | |
5006 | -or- | |
5007 | ||
29ddc2a4 | 5008 | print header('text/html','204 No response'); |
54310121 | 5009 | |
5010 | -or- | |
5011 | ||
29ddc2a4 | 5012 | print header(-type=>'image/gif', |
54310121 | 5013 | -nph=>1, |
5014 | -status=>'402 Payment required', | |
5015 | -expires=>'+3d', | |
5016 | -cookie=>$cookie, | |
3d1a2ec4 | 5017 | -charset=>'utf-7', |
6b4ac661 | 5018 | -attachment=>'foo.gif', |
54310121 | 5019 | -Cost=>'$2.00'); |
5020 | ||
5021 | header() returns the Content-type: header. You can provide your own | |
5022 | MIME type if you choose, otherwise it defaults to text/html. An | |
5023 | optional second parameter specifies the status code and a human-readable | |
5024 | message. For example, you can specify 204, "No response" to create a | |
424ec8fa | 5025 | script that tells the browser to do nothing at all. |
54310121 | 5026 | |
5027 | The last example shows the named argument style for passing arguments | |
5028 | to the CGI methods using named parameters. Recognized parameters are | |
424ec8fa | 5029 | B<-type>, B<-status>, B<-expires>, and B<-cookie>. Any other named |
54310121 | 5030 | parameters will be stripped of their initial hyphens and turned into |
5031 | header fields, allowing you to specify any HTTP header you desire. | |
424ec8fa GS |
5032 | Internal underscores will be turned into hyphens: |
5033 | ||
29ddc2a4 | 5034 | print header(-Content_length=>3002); |
54310121 | 5035 | |
5036 | Most browsers will not cache the output from CGI scripts. Every time | |
5037 | the browser reloads the page, the script is invoked anew. You can | |
5038 | change this behavior with the B<-expires> parameter. When you specify | |
5039 | an absolute or relative expiration interval with this parameter, some | |
5040 | browsers and proxy servers will cache the script's output until the | |
5041 | indicated expiration date. The following forms are all valid for the | |
5042 | -expires field: | |
5043 | ||
5044 | +30s 30 seconds from now | |
5045 | +10m ten minutes from now | |
5046 | +1h one hour from now | |
5047 | -1d yesterday (i.e. "ASAP!") | |
5048 | now immediately | |
5049 | +3M in three months | |
5050 | +10y in ten years time | |
424ec8fa | 5051 | Thursday, 25-Apr-1999 00:40:33 GMT at the indicated time & date |
54310121 | 5052 | |
5053 | The B<-cookie> parameter generates a header that tells the browser to provide | |
5054 | a "magic cookie" during all subsequent transactions with your script. | |
5055 | Netscape cookies have a special format that includes interesting attributes | |
5056 | such as expiration time. Use the cookie() method to create and retrieve | |
5057 | session cookies. | |
5058 | ||
5059 | The B<-nph> parameter, if set to a true value, will issue the correct | |
8f3ccfa2 | 5060 | headers to work with a NPH (no-parse-header) script. This is important |
3d1a2ec4 GS |
5061 | to use with certain servers that expect all their scripts to be NPH. |
5062 | ||
5063 | The B<-charset> parameter can be used to control the character set | |
5064 | sent to the browser. If not provided, defaults to ISO-8859-1. As a | |
5065 | side effect, this sets the charset() method as well. | |
54310121 | 5066 | |
6b4ac661 JH |
5067 | The B<-attachment> parameter can be used to turn the page into an |
5068 | attachment. Instead of displaying the page, some browsers will prompt | |
5069 | the user to save it to disk. The value of the argument is the | |
5070 | suggested name for the saved file. In order for this to work, you may | |
5071 | have to set the B<-type> to "application/octet-stream". | |
5072 | ||
8f3ccfa2 JH |
5073 | The B<-p3p> parameter will add a P3P tag to the outgoing header. The |
5074 | parameter can be an arrayref or a space-delimited string of P3P tags. | |
5075 | For example: | |
5076 | ||
5077 | print header(-p3p=>[qw(CAO DSP LAW CURa)]); | |
5078 | print header(-p3p=>'CAO DSP LAW CURa'); | |
5079 | ||
5080 | In either case, the outgoing header will be formatted as: | |
5081 | ||
5082 | P3P: policyref="/w3c/p3p.xml" cp="CAO DSP LAW CURa" | |
5083 | ||
424ec8fa | 5084 | =head2 GENERATING A REDIRECTION HEADER |
54310121 | 5085 | |
29ddc2a4 | 5086 | print redirect('http://somewhere.else/in/movie/land'); |
54310121 | 5087 | |
424ec8fa GS |
5088 | Sometimes you don't want to produce a document yourself, but simply |
5089 | redirect the browser elsewhere, perhaps choosing a URL based on the | |
5090 | time of day or the identity of the user. | |
5091 | ||
5092 | The redirect() function redirects the browser to a different URL. If | |
5093 | you use redirection like this, you should B<not> print out a header as | |
6b4ac661 | 5094 | well. |
54310121 | 5095 | |
2ed511ec RGS |
5096 | You should always use full URLs (including the http: or ftp: part) in |
5097 | redirection requests. Relative URLs will not work correctly. | |
54310121 | 5098 | |
424ec8fa | 5099 | You can also use named arguments: |
54310121 | 5100 | |
29ddc2a4 | 5101 | print redirect(-uri=>'http://somewhere.else/in/movie/land', |
13548fdf RGS |
5102 | -nph=>1, |
5103 | -status=>301); | |
54310121 | 5104 | |
5105 | The B<-nph> parameter, if set to a true value, will issue the correct | |
8f3ccfa2 | 5106 | headers to work with a NPH (no-parse-header) script. This is important |
58129083 | 5107 | to use with certain servers, such as Microsoft IIS, which |
54310121 | 5108 | expect all their scripts to be NPH. |
5109 | ||
13548fdf RGS |
5110 | The B<-status> parameter will set the status of the redirect. HTTP |
5111 | defines three different possible redirection status codes: | |
5112 | ||
5113 | 301 Moved Permanently | |
5114 | 302 Found | |
5115 | 303 See Other | |
5116 | ||
5117 | The default if not specified is 302, which means "moved temporarily." | |
5118 | You may change the status to another status code if you wish. Be | |
5119 | advised that changing the status to anything other than 301, 302 or | |
5120 | 303 will probably break redirection. | |
5121 | ||
424ec8fa | 5122 | =head2 CREATING THE HTML DOCUMENT HEADER |
54310121 | 5123 | |
29ddc2a4 | 5124 | print start_html(-title=>'Secrets of the Pyramids', |
54310121 | 5125 | -author=>'fred@capricorn.org', |
5126 | -base=>'true', | |
5127 | -target=>'_blank', | |
5128 | -meta=>{'keywords'=>'pharaoh secret mummy', | |
5129 | 'copyright'=>'copyright 1996 King Tut'}, | |
7d37aa8e | 5130 | -style=>{'src'=>'/styles/style1.css'}, |
54310121 | 5131 | -BGCOLOR=>'blue'); |
5132 | ||
424ec8fa GS |
5133 | After creating the HTTP header, most CGI scripts will start writing |
5134 | out an HTML document. The start_html() routine creates the top of the | |
5135 | page, along with a lot of optional information that controls the | |
5136 | page's appearance and behavior. | |
54310121 | 5137 | |
3acbd4f5 | 5138 | This method returns a canned HTML header and the opening <body> tag. |
424ec8fa | 5139 | All parameters are optional. In the named parameter form, recognized |
6b4ac661 JH |
5140 | parameters are -title, -author, -base, -xbase, -dtd, -lang and -target |
5141 | (see below for the explanation). Any additional parameters you | |
5142 | provide, such as the Netscape unofficial BGCOLOR attribute, are added | |
3acbd4f5 | 5143 | to the <body> tag. Additional parameters must be proceeded by a |
6b4ac661 | 5144 | hyphen. |
54310121 | 5145 | |
3acbd4f5 | 5146 | The argument B<-xbase> allows you to provide an HREF for the <base> tag |
54310121 | 5147 | different from the current location, as in |
5148 | ||
5149 | -xbase=>"http://home.mcom.com/" | |
5150 | ||
5151 | All relative links will be interpreted relative to this tag. | |
5152 | ||
5153 | The argument B<-target> allows you to provide a default target frame | |
3d1a2ec4 GS |
5154 | for all the links and fill-out forms on the page. B<This is a |
5155 | non-standard HTTP feature which only works with Netscape browsers!> | |
5156 | See the Netscape documentation on frames for details of how to | |
5157 | manipulate this. | |
54310121 | 5158 | |
5159 | -target=>"answer_window" | |
5160 | ||
5161 | All relative links will be interpreted relative to this tag. | |
5162 | You add arbitrary meta information to the header with the B<-meta> | |
5163 | argument. This argument expects a reference to an associative array | |
5164 | containing name/value pairs of meta information. These will be turned | |
3acbd4f5 | 5165 | into a series of header <meta> tags that look something like this: |
54310121 | 5166 | |
3acbd4f5 JH |
5167 | <meta name="keywords" content="pharaoh secret mummy"> |
5168 | <meta name="description" content="copyright 1996 King Tut"> | |
424ec8fa | 5169 | |
3acbd4f5 | 5170 | To create an HTTP-EQUIV type of <meta> tag, use B<-head>, described |
6b4ac661 | 5171 | below. |
424ec8fa | 5172 | |
6b4ac661 JH |
5173 | The B<-style> argument is used to incorporate cascading stylesheets |
5174 | into your code. See the section on CASCADING STYLESHEETS for more | |
5175 | information. | |
424ec8fa | 5176 | |
6b4ac661 | 5177 | The B<-lang> argument is used to incorporate a language attribute into |
13548fdf | 5178 | the <html> tag. For example: |
6b4ac661 | 5179 | |
ba056755 | 5180 | print $q->start_html(-lang=>'fr-CA'); |
424ec8fa | 5181 | |
13548fdf RGS |
5182 | The default if not specified is "en-US" for US English, unless the |
5183 | -dtd parameter specifies an HTML 2.0 or 3.2 DTD, in which case the | |
5184 | lang attribute is left off. You can force the lang attribute to left | |
5185 | off in other cases by passing an empty string (-lang=>''). | |
8f3ccfa2 | 5186 | |
ac734d8b | 5187 | The B<-encoding> argument can be used to specify the character set for |
b2d0d414 | 5188 | XHTML. It defaults to iso-8859-1 if not specified. |
ac734d8b | 5189 | |
29ddc2a4 RGS |
5190 | The B<-declare_xml> argument, when used in conjunction with XHTML, |
5191 | will put a <?xml> declaration at the top of the HTML header. The sole | |
5192 | purpose of this declaration is to declare the character set | |
5193 | encoding. In the absence of -declare_xml, the output HTML will contain | |
5194 | a <meta> tag that specifies the encoding, allowing the HTML to pass | |
5195 | most validators. The default for -declare_xml is false. | |
5196 | ||
3acbd4f5 JH |
5197 | You can place other arbitrary HTML elements to the <head> section with the |
5198 | B<-head> tag. For example, to place the rarely-used <link> element in the | |
424ec8fa GS |
5199 | head section, use this: |
5200 | ||
3538e1d5 | 5201 | print start_html(-head=>Link({-rel=>'next', |
6b4ac661 | 5202 | -href=>'http://www.capricorn.com/s2.html'})); |
424ec8fa | 5203 | |
3acbd4f5 | 5204 | To incorporate multiple HTML elements into the <head> section, just pass an |
424ec8fa GS |
5205 | array reference: |
5206 | ||
3538e1d5 GS |
5207 | print start_html(-head=>[ |
5208 | Link({-rel=>'next', | |
5209 | -href=>'http://www.capricorn.com/s2.html'}), | |
5210 | Link({-rel=>'previous', | |
5211 | -href=>'http://www.capricorn.com/s1.html'}) | |
424ec8fa GS |
5212 | ] |
5213 | ); | |
5214 | ||
3acbd4f5 | 5215 | And here's how to create an HTTP-EQUIV <meta> tag: |
6b4ac661 | 5216 | |
ba056755 JH |
5217 | print start_html(-head=>meta({-http_equiv => 'Content-Type', |
5218 | -content => 'text/html'})) | |
6b4ac661 JH |
5219 | |
5220 | ||
424ec8fa GS |
5221 | JAVASCRIPTING: The B<-script>, B<-noScript>, B<-onLoad>, |
5222 | B<-onMouseOver>, B<-onMouseOut> and B<-onUnload> parameters are used | |
5223 | to add Netscape JavaScript calls to your pages. B<-script> should | |
5224 | point to a block of text containing JavaScript function definitions. | |
3acbd4f5 | 5225 | This block will be placed within a <script> block inside the HTML (not |
424ec8fa GS |
5226 | HTTP) header. The block is placed in the header in order to give your |
5227 | page a fighting chance of having all its JavaScript functions in place | |
5228 | even if the user presses the stop button before the page has loaded | |
5229 | completely. CGI.pm attempts to format the script in such a way that | |
5230 | JavaScript-naive browsers will not choke on the code: unfortunately | |
5231 | there are some browsers, such as Chimera for Unix, that get confused | |
5232 | by it nevertheless. | |
5233 | ||
5234 | The B<-onLoad> and B<-onUnload> parameters point to fragments of JavaScript | |
5235 | code to execute when the page is respectively opened and closed by the | |
5236 | browser. Usually these parameters are calls to functions defined in the | |
5237 | B<-script> field: | |
5238 | ||
5239 | $query = new CGI; | |
29ddc2a4 | 5240 | print header; |
424ec8fa GS |
5241 | $JSCRIPT=<<END; |
5242 | // Ask a silly question | |
5243 | function riddle_me_this() { | |
5244 | var r = prompt("What walks on four legs in the morning, " + | |
5245 | "two legs in the afternoon, " + | |
5246 | "and three legs in the evening?"); | |
5247 | response(r); | |
5248 | } | |
5249 | // Get a silly answer | |
5250 | function response(answer) { | |
5251 | if (answer == "man") | |
5252 | alert("Right you are!"); | |
5253 | else | |
5254 | alert("Wrong! Guess again."); | |
5255 | } | |
5256 | END | |
29ddc2a4 | 5257 | print start_html(-title=>'The Riddle of the Sphinx', |
424ec8fa GS |
5258 | -script=>$JSCRIPT); |
5259 | ||
5260 | Use the B<-noScript> parameter to pass some HTML text that will be displayed on | |
5261 | browsers that do not have JavaScript (or browsers where JavaScript is turned | |
5262 | off). | |
5263 | ||
8869a4b7 SP |
5264 | The <script> tag, has several attributes including "type" and src. |
5265 | The latter is particularly interesting, as it allows you to keep the | |
5266 | JavaScript code in a file or CGI script rather than cluttering up each | |
5267 | page with the source. To use these attributes pass a HASH reference | |
5268 | in the B<-script> parameter containing one or more of -type, -src, or | |
5269 | -code: | |
424ec8fa GS |
5270 | |
5271 | print $q->start_html(-title=>'The Riddle of the Sphinx', | |
8869a4b7 | 5272 | -script=>{-type=>'JAVASCRIPT', |
424ec8fa GS |
5273 | -src=>'/javascript/sphinx.js'} |
5274 | ); | |
5275 | ||
5276 | print $q->(-title=>'The Riddle of the Sphinx', | |
8869a4b7 | 5277 | -script=>{-type=>'PERLSCRIPT', |
3538e1d5 | 5278 | -code=>'print "hello world!\n;"'} |
424ec8fa GS |
5279 | ); |
5280 | ||
5281 | ||
3acbd4f5 | 5282 | A final feature allows you to incorporate multiple <script> sections into the |
424ec8fa GS |
5283 | header. Just pass the list of script sections as an array reference. |
5284 | this allows you to specify different source files for different dialects | |
8869a4b7 | 5285 | of JavaScript. Example: |
424ec8fa | 5286 | |
3538e1d5 GS |
5287 | print $q->start_html(-title=>'The Riddle of the Sphinx', |
5288 | -script=>[ | |
8869a4b7 | 5289 | { -type => 'text/javascript', |
3538e1d5 | 5290 | -src => '/javascript/utilities10.js' |
424ec8fa | 5291 | }, |
8869a4b7 | 5292 | { -type => 'text/javascript', |
3538e1d5 | 5293 | -src => '/javascript/utilities11.js' |
424ec8fa | 5294 | }, |
8869a4b7 | 5295 | { -type => 'text/jscript', |
3538e1d5 | 5296 | -src => '/javascript/utilities12.js' |
424ec8fa | 5297 | }, |
8869a4b7 | 5298 | { -type => 'text/ecmascript', |
3538e1d5 | 5299 | -src => '/javascript/utilities219.js' |
424ec8fa GS |
5300 | } |
5301 | ] | |
5302 | ); | |
424ec8fa | 5303 | |
8869a4b7 SP |
5304 | The option "-language" is a synonym for -type, and is supported for |
5305 | backwad compatibility. | |
424ec8fa GS |
5306 | |
5307 | The old-style positional parameters are as follows: | |
5308 | ||
5309 | =over 4 | |
5310 | ||
5311 | =item B<Parameters:> | |
5312 | ||
5313 | =item 1. | |
5314 | ||
5315 | The title | |
5316 | ||
5317 | =item 2. | |
5318 | ||
3acbd4f5 | 5319 | The author's e-mail address (will create a <link rev="MADE"> tag if present |
424ec8fa GS |
5320 | |
5321 | =item 3. | |
5322 | ||
3acbd4f5 | 5323 | A 'true' flag if you want to include a <base> tag in the header. This |
424ec8fa GS |
5324 | helps resolve relative addresses to absolute ones when the document is moved, |
5325 | but makes the document hierarchy non-portable. Use with care! | |
5326 | ||
5327 | =item 4, 5, 6... | |
5328 | ||
3acbd4f5 | 5329 | Any other parameters you want to include in the <body> tag. This is a good |
424ec8fa GS |
5330 | place to put Netscape extensions, such as colors and wallpaper patterns. |
5331 | ||
5332 | =back | |
5333 | ||
5334 | =head2 ENDING THE HTML DOCUMENT: | |
5335 | ||
29ddc2a4 | 5336 | print end_html |
424ec8fa | 5337 | |
3acbd4f5 | 5338 | This ends an HTML document by printing the </body></html> tags. |
424ec8fa GS |
5339 | |
5340 | =head2 CREATING A SELF-REFERENCING URL THAT PRESERVES STATE INFORMATION: | |
5341 | ||
29ddc2a4 | 5342 | $myself = self_url; |
3acbd4f5 | 5343 | print q(<a href="$myself">I'm talking to myself.</a>); |
424ec8fa GS |
5344 | |
5345 | self_url() will return a URL, that, when selected, will reinvoke | |
5346 | this script with all its state information intact. This is most | |
5347 | useful when you want to jump around within the document using | |
5348 | internal anchors but you don't want to disrupt the current contents | |
5349 | of the form(s). Something like this will do the trick. | |
5350 | ||
29ddc2a4 | 5351 | $myself = self_url; |
188ba755 JH |
5352 | print "<a href=\"$myself#table1\">See table 1</a>"; |
5353 | print "<a href=\"$myself#table2\">See table 2</a>"; | |
5354 | print "<a href=\"$myself#yourself\">See for yourself</a>"; | |
424ec8fa GS |
5355 | |
5356 | If you want more control over what's returned, using the B<url()> | |
5357 | method instead. | |
5358 | ||
5359 | You can also retrieve the unprocessed query string with query_string(): | |
5360 | ||
29ddc2a4 | 5361 | $the_string = query_string; |
424ec8fa GS |
5362 | |
5363 | =head2 OBTAINING THE SCRIPT'S URL | |
5364 | ||
29ddc2a4 RGS |
5365 | $full_url = url(); |
5366 | $full_url = url(-full=>1); #alternative syntax | |
5367 | $relative_url = url(-relative=>1); | |
5368 | $absolute_url = url(-absolute=>1); | |
5369 | $url_with_path = url(-path_info=>1); | |
5370 | $url_with_path_and_query = url(-path_info=>1,-query=>1); | |
5371 | $netloc = url(-base => 1); | |
424ec8fa GS |
5372 | |
5373 | B<url()> returns the script's URL in a variety of formats. Called | |
5374 | without any arguments, it returns the full form of the URL, including | |
5375 | host name and port number | |
5376 | ||
5377 | http://your.host.com/path/to/script.cgi | |
5378 | ||
5379 | You can modify this format with the following named arguments: | |
5380 | ||
5381 | =over 4 | |
5382 | ||
5383 | =item B<-absolute> | |
5384 | ||
5385 | If true, produce an absolute URL, e.g. | |
5386 | ||
5387 | /path/to/script.cgi | |
5388 | ||
5389 | =item B<-relative> | |
5390 | ||
5391 | Produce a relative URL. This is useful if you want to reinvoke your | |
5392 | script with different parameters. For example: | |
5393 | ||
5394 | script.cgi | |
5395 | ||
5396 | =item B<-full> | |
5397 | ||
5398 | Produce the full URL, exactly as if called without any arguments. | |
5399 | This overrides the -relative and -absolute arguments. | |
5400 | ||
5401 | =item B<-path> (B<-path_info>) | |
5402 | ||
5403 | Append the additional path information to the URL. This can be | |
5404 | combined with B<-full>, B<-absolute> or B<-relative>. B<-path_info> | |
5405 | is provided as a synonym. | |
5406 | ||
5407 | =item B<-query> (B<-query_string>) | |
5408 | ||
5409 | Append the query string to the URL. This can be combined with | |
5410 | B<-full>, B<-absolute> or B<-relative>. B<-query_string> is provided | |
5411 | as a synonym. | |
5412 | ||
03b9648d JH |
5413 | =item B<-base> |
5414 | ||
5415 | Generate just the protocol and net location, as in http://www.foo.com:8000 | |
5416 | ||
0a9bdad4 SP |
5417 | =item B<-rewrite> |
5418 | ||
5419 | If Apache's mod_rewrite is turned on, then the script name and path | |
5420 | info probably won't match the request that the user sent. Set | |
5421 | -rewrite=>1 (default) to return URLs that match what the user sent | |
384f06ae | 5422 | (the original request URI). Set -rewrite=>0 to return URLs that match |
0a9bdad4 SP |
5423 | the URL after mod_rewrite's rules have run. Because the additional |
5424 | path information only makes sense in the context of the rewritten URL, | |
5425 | -rewrite is set to false when you request path info in the URL. | |
5426 | ||
424ec8fa GS |
5427 | =back |
5428 | ||
71f3e297 JH |
5429 | =head2 MIXING POST AND URL PARAMETERS |
5430 | ||
29ddc2a4 | 5431 | $color = url_param('color'); |
71f3e297 JH |
5432 | |
5433 | It is possible for a script to receive CGI parameters in the URL as | |
5434 | well as in the fill-out form by creating a form that POSTs to a URL | |
5435 | containing a query string (a "?" mark followed by arguments). The | |
5436 | B<param()> method will always return the contents of the POSTed | |
5437 | fill-out form, ignoring the URL's query string. To retrieve URL | |
5438 | parameters, call the B<url_param()> method. Use it in the same way as | |
5439 | B<param()>. The main difference is that it allows you to read the | |
5440 | parameters, but not set them. | |
5441 | ||
5442 | ||
5443 | Under no circumstances will the contents of the URL query string | |
5444 | interfere with similarly-named CGI parameters in POSTed forms. If you | |
5445 | try to mix a URL query string with a form submitted with the GET | |
5446 | method, the results will not be what you expect. | |
5447 | ||
424ec8fa GS |
5448 | =head1 CREATING STANDARD HTML ELEMENTS: |
5449 | ||
5450 | CGI.pm defines general HTML shortcut methods for most, if not all of | |
5451 | the HTML 3 and HTML 4 tags. HTML shortcuts are named after a single | |
5452 | HTML element and return a fragment of HTML text that you can then | |
5453 | print or manipulate as you like. Each shortcut returns a fragment of | |
5454 | HTML code that you can append to a string, save to a file, or, most | |
5455 | commonly, print out so that it displays in the browser window. | |
5456 | ||
5457 | This example shows how to use the HTML methods: | |
5458 | ||
424ec8fa GS |
5459 | print $q->blockquote( |
5460 | "Many years ago on the island of", | |
5461 | $q->a({href=>"http://crete.org/"},"Crete"), | |
3538e1d5 | 5462 | "there lived a Minotaur named", |
424ec8fa GS |
5463 | $q->strong("Fred."), |
5464 | ), | |
5465 | $q->hr; | |
5466 | ||
5467 | This results in the following HTML code (extra newlines have been | |
5468 | added for readability): | |
5469 | ||
5470 | <blockquote> | |
5471 | Many years ago on the island of | |
3acbd4f5 | 5472 | <a href="http://crete.org/">Crete</a> there lived |
424ec8fa GS |
5473 | a minotaur named <strong>Fred.</strong> |
5474 | </blockquote> | |
5475 | <hr> | |
5476 | ||
5477 | If you find the syntax for calling the HTML shortcuts awkward, you can | |
5478 | import them into your namespace and dispense with the object syntax | |
5479 | completely (see the next section for more details): | |
5480 | ||
5481 | use CGI ':standard'; | |
5482 | print blockquote( | |
5483 | "Many years ago on the island of", | |
5484 | a({href=>"http://crete.org/"},"Crete"), | |
5485 | "there lived a minotaur named", | |
5486 | strong("Fred."), | |
5487 | ), | |
5488 | hr; | |
54310121 | 5489 | |
424ec8fa | 5490 | =head2 PROVIDING ARGUMENTS TO HTML SHORTCUTS |
7d37aa8e | 5491 | |
424ec8fa GS |
5492 | The HTML methods will accept zero, one or multiple arguments. If you |
5493 | provide no arguments, you get a single tag: | |
7d37aa8e | 5494 | |
3acbd4f5 | 5495 | print hr; # <hr> |
7d37aa8e | 5496 | |
424ec8fa GS |
5497 | If you provide one or more string arguments, they are concatenated |
5498 | together with spaces and placed between opening and closing tags: | |
7d37aa8e | 5499 | |
3acbd4f5 | 5500 | print h1("Chapter","1"); # <h1>Chapter 1</h1>" |
7d37aa8e | 5501 | |
424ec8fa GS |
5502 | If the first argument is an associative array reference, then the keys |
5503 | and values of the associative array become the HTML tag's attributes: | |
7d37aa8e | 5504 | |
424ec8fa GS |
5505 | print a({-href=>'fred.html',-target=>'_new'}, |
5506 | "Open a new frame"); | |
7d37aa8e | 5507 | |
3acbd4f5 | 5508 | <a href="fred.html",target="_new">Open a new frame</a> |
3cb6de81 | 5509 | |
424ec8fa GS |
5510 | You may dispense with the dashes in front of the attribute names if |
5511 | you prefer: | |
54310121 | 5512 | |
424ec8fa | 5513 | print img {src=>'fred.gif',align=>'LEFT'}; |
54310121 | 5514 | |
3acbd4f5 | 5515 | <img align="LEFT" src="fred.gif"> |
54310121 | 5516 | |
424ec8fa | 5517 | Sometimes an HTML tag attribute has no argument. For example, ordered |
8f3ccfa2 | 5518 | lists can be marked as COMPACT. The syntax for this is an argument that |
424ec8fa | 5519 | that points to an undef string: |
54310121 | 5520 | |
424ec8fa | 5521 | print ol({compact=>undef},li('one'),li('two'),li('three')); |
47e3cabd | 5522 | |
424ec8fa GS |
5523 | Prior to CGI.pm version 2.41, providing an empty ('') string as an |
5524 | attribute argument was the same as providing undef. However, this has | |
8f3ccfa2 | 5525 | changed in order to accommodate those who want to create tags of the form |
3acbd4f5 | 5526 | <img alt="">. The difference is shown in these two pieces of code: |
3cb6de81 | 5527 | |
8f3ccfa2 JH |
5528 | CODE RESULT |
5529 | img({alt=>undef}) <img alt> | |
5530 | img({alt=>''}) <img alt=""> | |
7d37aa8e | 5531 | |
424ec8fa | 5532 | =head2 THE DISTRIBUTIVE PROPERTY OF HTML SHORTCUTS |
7d37aa8e | 5533 | |
424ec8fa GS |
5534 | One of the cool features of the HTML shortcuts is that they are |
5535 | distributive. If you give them an argument consisting of a | |
5536 | B<reference> to a list, the tag will be distributed across each | |
5537 | element of the list. For example, here's one way to make an ordered | |
5538 | list: | |
7d37aa8e | 5539 | |
424ec8fa | 5540 | print ul( |
6b4ac661 | 5541 | li({-type=>'disc'},['Sneezy','Doc','Sleepy','Happy']) |
424ec8fa | 5542 | ); |
7d37aa8e | 5543 | |
424ec8fa | 5544 | This example will result in HTML output that looks like this: |
54310121 | 5545 | |
3acbd4f5 JH |
5546 | <ul> |
5547 | <li type="disc">Sneezy</li> | |
5548 | <li type="disc">Doc</li> | |
5549 | <li type="disc">Sleepy</li> | |
5550 | <li type="disc">Happy</li> | |
5551 | </ul> | |
54310121 | 5552 | |
424ec8fa | 5553 | This is extremely useful for creating tables. For example: |
54310121 | 5554 | |
424ec8fa GS |
5555 | print table({-border=>undef}, |
5556 | caption('When Should You Eat Your Vegetables?'), | |
5557 | Tr({-align=>CENTER,-valign=>TOP}, | |
5558 | [ | |
5559 | th(['Vegetable', 'Breakfast','Lunch','Dinner']), | |
5560 | td(['Tomatoes' , 'no', 'yes', 'yes']), | |
5561 | td(['Broccoli' , 'no', 'no', 'yes']), | |
5562 | td(['Onions' , 'yes','yes', 'yes']) | |
5563 | ] | |
5564 | ) | |
5565 | ); | |
54310121 | 5566 | |
424ec8fa | 5567 | =head2 HTML SHORTCUTS AND LIST INTERPOLATION |
54310121 | 5568 | |
424ec8fa | 5569 | Consider this bit of code: |
54310121 | 5570 | |
424ec8fa | 5571 | print blockquote(em('Hi'),'mom!')); |
54310121 | 5572 | |
424ec8fa | 5573 | It will ordinarily return the string that you probably expect, namely: |
54310121 | 5574 | |
3acbd4f5 | 5575 | <blockquote><em>Hi</em> mom!</blockquote> |
54310121 | 5576 | |
424ec8fa GS |
5577 | Note the space between the element "Hi" and the element "mom!". |
5578 | CGI.pm puts the extra space there using array interpolation, which is | |
5579 | controlled by the magic $" variable. Sometimes this extra space is | |
5580 | not what you want, for example, when you are trying to align a series | |
5581 | of images. In this case, you can simply change the value of $" to an | |
5582 | empty string. | |
54310121 | 5583 | |
424ec8fa GS |
5584 | { |
5585 | local($") = ''; | |
5586 | print blockquote(em('Hi'),'mom!')); | |
5587 | } | |
54310121 | 5588 | |
424ec8fa GS |
5589 | I suggest you put the code in a block as shown here. Otherwise the |
5590 | change to $" will affect all subsequent code until you explicitly | |
5591 | reset it. | |
54310121 | 5592 | |
424ec8fa | 5593 | =head2 NON-STANDARD HTML SHORTCUTS |
54310121 | 5594 | |
424ec8fa GS |
5595 | A few HTML tags don't follow the standard pattern for various |
5596 | reasons. | |
54310121 | 5597 | |
424ec8fa GS |
5598 | B<comment()> generates an HTML comment (<!-- comment -->). Call it |
5599 | like | |
54310121 | 5600 | |
424ec8fa | 5601 | print comment('here is my comment'); |
54310121 | 5602 | |
424ec8fa GS |
5603 | Because of conflicts with built-in Perl functions, the following functions |
5604 | begin with initial caps: | |
54310121 | 5605 | |
424ec8fa GS |
5606 | Select |
5607 | Tr | |
5608 | Link | |
5609 | Delete | |
71f3e297 JH |
5610 | Accept |
5611 | Sub | |
54310121 | 5612 | |
424ec8fa GS |
5613 | In addition, start_html(), end_html(), start_form(), end_form(), |
5614 | start_multipart_form() and all the fill-out form tags are special. | |
5615 | See their respective sections. | |
5616 | ||
3d1a2ec4 GS |
5617 | =head2 AUTOESCAPING HTML |
5618 | ||
5619 | By default, all HTML that is emitted by the form-generating functions | |
5620 | is passed through a function called escapeHTML(): | |
5621 | ||
5622 | =over 4 | |
5623 | ||
5624 | =item $escaped_string = escapeHTML("unescaped string"); | |
5625 | ||
5626 | Escape HTML formatting characters in a string. | |
5627 | ||
5628 | =back | |
5629 | ||
5630 | Provided that you have specified a character set of ISO-8859-1 (the | |
5631 | default), the standard HTML escaping rules will be used. The "<" | |
5632 | character becomes "<", ">" becomes ">", "&" becomes "&", and | |
5633 | the quote character becomes """. In addition, the hexadecimal | |
188ba755 | 5634 | 0x8b and 0x9b characters, which some browsers incorrectly interpret |
3d1a2ec4 | 5635 | as the left and right angle-bracket characters, are replaced by their |
188ba755 | 5636 | numeric character entities ("‹" and "›"). If you manually change |
3d1a2ec4 GS |
5637 | the charset, either by calling the charset() method explicitly or by |
5638 | passing a -charset argument to header(), then B<all> characters will | |
5639 | be replaced by their numeric entities, since CGI.pm has no lookup | |
5640 | table for all the possible encodings. | |
5641 | ||
5642 | The automatic escaping does not apply to other shortcuts, such as | |
5643 | h1(). You should call escapeHTML() yourself on untrusted data in | |
5644 | order to protect your pages against nasty tricks that people may enter | |
5645 | into guestbooks, etc.. To change the character set, use charset(). | |
188ba755 | 5646 | To turn autoescaping off completely, use autoEscape(0): |
3d1a2ec4 GS |
5647 | |
5648 | =over 4 | |
5649 | ||
5650 | =item $charset = charset([$charset]); | |
5651 | ||
5652 | Get or set the current character set. | |
5653 | ||
5654 | =item $flag = autoEscape([$flag]); | |
5655 | ||
5656 | Get or set the value of the autoescape flag. | |
5657 | ||
5658 | =back | |
5659 | ||
71f3e297 JH |
5660 | =head2 PRETTY-PRINTING HTML |
5661 | ||
5662 | By default, all the HTML produced by these functions comes out as one | |
5663 | long line without carriage returns or indentation. This is yuck, but | |
5664 | it does reduce the size of the documents by 10-20%. To get | |
5665 | pretty-printed output, please use L<CGI::Pretty>, a subclass | |
5666 | contributed by Brian Paulsen. | |
5667 | ||
424ec8fa | 5668 | =head1 CREATING FILL-OUT FORMS: |
54310121 | 5669 | |
5670 | I<General note> The various form-creating methods all return strings | |
5671 | to the caller, containing the tag or tags that will create the requested | |
5672 | form element. You are responsible for actually printing out these strings. | |
5673 | It's set up this way so that you can place formatting tags | |
5674 | around the form elements. | |
5675 | ||
5676 | I<Another note> The default values that you specify for the forms are only | |
5677 | used the B<first> time the script is invoked (when there is no query | |
5678 | string). On subsequent invocations of the script (when there is a query | |
5679 | string), the former values are used even if they are blank. | |
5680 | ||
5681 | If you want to change the value of a field from its previous value, you have two | |
5682 | choices: | |
5683 | ||
5684 | (1) call the param() method to set it. | |
5685 | ||
5686 | (2) use the -override (alias -force) parameter (a new feature in version 2.15). | |
5687 | This forces the default value to be used, regardless of the previous value: | |
5688 | ||
29ddc2a4 | 5689 | print textfield(-name=>'field_name', |
54310121 | 5690 | -default=>'starting value', |
5691 | -override=>1, | |
5692 | -size=>50, | |
5693 | -maxlength=>80); | |
5694 | ||
5695 | I<Yet another note> By default, the text and labels of form elements are | |
5696 | escaped according to HTML rules. This means that you can safely use | |
5697 | "<CLICK ME>" as the label for a button. However, it also interferes with | |
5698 | your ability to incorporate special HTML character sequences, such as Á, | |
5699 | into your fields. If you wish to turn off automatic escaping, call the | |
5700 | autoEscape() method with a false value immediately after creating the CGI object: | |
5701 | ||
5702 | $query = new CGI; | |
29ddc2a4 | 5703 | autoEscape(undef); |
3cb6de81 | 5704 | |
13548fdf RGS |
5705 | I<A Lurking Trap!> Some of the form-element generating methods return |
5706 | multiple tags. In a scalar context, the tags will be concatenated | |
5707 | together with spaces, or whatever is the current value of the $" | |
5708 | global. In a list context, the methods will return a list of | |
5709 | elements, allowing you to modify them if you wish. Usually you will | |
5710 | not notice this behavior, but beware of this: | |
5711 | ||
29ddc2a4 | 5712 | printf("%s\n",end_form()) |
13548fdf RGS |
5713 | |
5714 | end_form() produces several tags, and only the first of them will be | |
5715 | printed because the format only expects one value. | |
5716 | ||
5717 | <p> | |
5718 | ||
5719 | ||
54310121 | 5720 | =head2 CREATING AN ISINDEX TAG |
5721 | ||
29ddc2a4 | 5722 | print isindex(-action=>$action); |
54310121 | 5723 | |
5724 | -or- | |
5725 | ||
29ddc2a4 | 5726 | print isindex($action); |
54310121 | 5727 | |
3acbd4f5 | 5728 | Prints out an <isindex> tag. Not very exciting. The parameter |
54310121 | 5729 | -action specifies the URL of the script to process the query. The |
5730 | default is to process the query with the current script. | |
5731 | ||
5732 | =head2 STARTING AND ENDING A FORM | |
5733 | ||
29ddc2a4 RGS |
5734 | print start_form(-method=>$method, |
5735 | -action=>$action, | |
5736 | -enctype=>$encoding); | |
54310121 | 5737 | <... various form stuff ...> |
29ddc2a4 | 5738 | print endform; |
54310121 | 5739 | |
5740 | -or- | |
5741 | ||
29ddc2a4 | 5742 | print start_form($method,$action,$encoding); |
54310121 | 5743 | <... various form stuff ...> |
29ddc2a4 | 5744 | print endform; |
54310121 | 5745 | |
3acbd4f5 | 5746 | start_form() will return a <form> tag with the optional method, |
54310121 | 5747 | action and form encoding that you specify. The defaults are: |
3cb6de81 | 5748 | |
54310121 | 5749 | method: POST |
5750 | action: this script | |
71f3e297 | 5751 | enctype: application/x-www-form-urlencoded |
54310121 | 5752 | |
3acbd4f5 | 5753 | endform() returns the closing </form> tag. |
54310121 | 5754 | |
3d1a2ec4 | 5755 | Start_form()'s enctype argument tells the browser how to package the various |
54310121 | 5756 | fields of the form before sending the form to the server. Two |
5757 | values are possible: | |
5758 | ||
3d1a2ec4 GS |
5759 | B<Note:> This method was previously named startform(), and startform() |
5760 | is still recognized as an alias. | |
5761 | ||
54310121 | 5762 | =over 4 |
5763 | ||
5764 | =item B<application/x-www-form-urlencoded> | |
5765 | ||
5766 | This is the older type of encoding used by all browsers prior to | |
5767 | Netscape 2.0. It is compatible with many CGI scripts and is | |
5768 | suitable for short fields containing text data. For your | |
5769 | convenience, CGI.pm stores the name of this encoding | |
6b4ac661 | 5770 | type in B<&CGI::URL_ENCODED>. |
54310121 | 5771 | |
5772 | =item B<multipart/form-data> | |
5773 | ||
5774 | This is the newer type of encoding introduced by Netscape 2.0. | |
5775 | It is suitable for forms that contain very large fields or that | |
5776 | are intended for transferring binary data. Most importantly, | |
5777 | it enables the "file upload" feature of Netscape 2.0 forms. For | |
5778 | your convenience, CGI.pm stores the name of this encoding type | |
424ec8fa | 5779 | in B<&CGI::MULTIPART> |
54310121 | 5780 | |
5781 | Forms that use this type of encoding are not easily interpreted | |
5782 | by CGI scripts unless they use CGI.pm or another library designed | |
5783 | to handle them. | |
5784 | ||
29ddc2a4 RGS |
5785 | If XHTML is activated (the default), then forms will be automatically |
5786 | created using this type of encoding. | |
5787 | ||
54310121 | 5788 | =back |
5789 | ||
3d1a2ec4 | 5790 | For compatibility, the start_form() method uses the older form of |
54310121 | 5791 | encoding by default. If you want to use the newer form of encoding |
5792 | by default, you can call B<start_multipart_form()> instead of | |
3d1a2ec4 | 5793 | B<start_form()>. |
54310121 | 5794 | |
5795 | JAVASCRIPTING: The B<-name> and B<-onSubmit> parameters are provided | |
5796 | for use with JavaScript. The -name parameter gives the | |
5797 | form a name so that it can be identified and manipulated by | |
5798 | JavaScript functions. -onSubmit should point to a JavaScript | |
5799 | function that will be executed just before the form is submitted to your | |
5800 | server. You can use this opportunity to check the contents of the form | |
5801 | for consistency and completeness. If you find something wrong, you | |
5802 | can put up an alert box or maybe fix things up yourself. You can | |
5803 | abort the submission by returning false from this function. | |
5804 | ||
3acbd4f5 | 5805 | Usually the bulk of JavaScript functions are defined in a <script> |
54310121 | 5806 | block in the HTML header and -onSubmit points to one of these function |
5807 | call. See start_html() for details. | |
5808 | ||
29ddc2a4 RGS |
5809 | =head2 FORM ELEMENTS |
5810 | ||
5811 | After starting a form, you will typically create one or more | |
5812 | textfields, popup menus, radio groups and other form elements. Each | |
5813 | of these elements takes a standard set of named arguments. Some | |
5814 | elements also have optional arguments. The standard arguments are as | |
5815 | follows: | |
5816 | ||
5817 | =over 4 | |
5818 | ||
5819 | =item B<-name> | |
5820 | ||
5821 | The name of the field. After submission this name can be used to | |
5822 | retrieve the field's value using the param() method. | |
5823 | ||
5824 | =item B<-value>, B<-values> | |
5825 | ||
5826 | The initial value of the field which will be returned to the script | |
5827 | after form submission. Some form elements, such as text fields, take | |
5828 | a single scalar -value argument. Others, such as popup menus, take a | |
5829 | reference to an array of values. The two arguments are synonyms. | |
5830 | ||
5831 | =item B<-tabindex> | |
5832 | ||
5833 | A numeric value that sets the order in which the form element receives | |
5834 | focus when the user presses the tab key. Elements with lower values | |
5835 | receive focus first. | |
5836 | ||
5837 | =item B<-id> | |
5838 | ||
5839 | A string identifier that can be used to identify this element to | |
5840 | JavaScript and DHTML. | |
5841 | ||
5842 | =item B<-override> | |
5843 | ||
5844 | A boolean, which, if true, forces the element to take on the value | |
5845 | specified by B<-value>, overriding the sticky behavior described | |
5846 | earlier for the B<-no_sticky> pragma. | |
5847 | ||
5848 | =item B<-onChange>, B<-onFocus>, B<-onBlur>, B<-onMouseOver>, B<-onMouseOut>, B<-onSelect> | |
5849 | ||
5850 | These are used to assign JavaScript event handlers. See the | |
5851 | JavaScripting section for more details. | |
5852 | ||
5853 | =back | |
5854 | ||
5855 | Other common arguments are described in the next section. In addition | |
5856 | to these, all attributes described in the HTML specifications are | |
5857 | supported. | |
5858 | ||
54310121 | 5859 | =head2 CREATING A TEXT FIELD |
5860 | ||
29ddc2a4 RGS |
5861 | print textfield(-name=>'field_name', |
5862 | -value=>'starting value', | |
5863 | -size=>50, | |
5864 | -maxlength=>80); | |
54310121 | 5865 | -or- |
5866 | ||
29ddc2a4 | 5867 | print textfield('field_name','starting value',50,80); |
54310121 | 5868 | |
29ddc2a4 | 5869 | textfield() will return a text input field. |
54310121 | 5870 | |
5871 | =over 4 | |
5872 | ||
5873 | =item B<Parameters> | |
5874 | ||
5875 | =item 1. | |
5876 | ||
29ddc2a4 | 5877 | The first parameter is the required name for the field (-name). |
54310121 | 5878 | |
5879 | =item 2. | |
5880 | ||
5881 | The optional second parameter is the default starting value for the field | |
29ddc2a4 | 5882 | contents (-value, formerly known as -default). |
54310121 | 5883 | |
5884 | =item 3. | |
5885 | ||
5886 | The optional third parameter is the size of the field in | |
5887 | characters (-size). | |
5888 | ||
5889 | =item 4. | |
5890 | ||
5891 | The optional fourth parameter is the maximum number of characters the | |
5892 | field will accept (-maxlength). | |
5893 | ||
5894 | =back | |
5895 | ||
5896 | As with all these methods, the field will be initialized with its | |
5897 | previous contents from earlier invocations of the script. | |
5898 | When the form is processed, the value of the text field can be | |
5899 | retrieved with: | |
5900 | ||
29ddc2a4 | 5901 | $value = param('foo'); |
54310121 | 5902 | |
5903 | If you want to reset it from its initial value after the script has been | |
5904 | called once, you can do so like this: | |
5905 | ||
29ddc2a4 | 5906 | param('foo',"I'm taking over this value!"); |
54310121 | 5907 | |
5908 | =head2 CREATING A BIG TEXT FIELD | |
5909 | ||
29ddc2a4 | 5910 | print textarea(-name=>'foo', |
54310121 | 5911 | -default=>'starting value', |
5912 | -rows=>10, | |
5913 | -columns=>50); | |
5914 | ||
5915 | -or | |
5916 | ||
29ddc2a4 | 5917 | print textarea('foo','starting value',10,50); |
54310121 | 5918 | |
5919 | textarea() is just like textfield, but it allows you to specify | |
5920 | rows and columns for a multiline text entry box. You can provide | |
5921 | a starting value for the field, which can be long and contain | |
5922 | multiple lines. | |
5923 | ||
54310121 | 5924 | =head2 CREATING A PASSWORD FIELD |
5925 | ||
29ddc2a4 | 5926 | print password_field(-name=>'secret', |
54310121 | 5927 | -value=>'starting value', |
5928 | -size=>50, | |
5929 | -maxlength=>80); | |
5930 | -or- | |
5931 | ||
29ddc2a4 | 5932 | print password_field('secret','starting value',50,80); |
54310121 | 5933 | |
5934 | password_field() is identical to textfield(), except that its contents | |
5935 | will be starred out on the web page. | |
5936 | ||
54310121 | 5937 | =head2 CREATING A FILE UPLOAD FIELD |
5938 | ||
29ddc2a4 | 5939 | print filefield(-name=>'uploaded_file', |
54310121 | 5940 | -default=>'starting value', |
5941 | -size=>50, | |
5942 | -maxlength=>80); | |
5943 | -or- | |
5944 | ||
29ddc2a4 | 5945 | print filefield('uploaded_file','starting value',50,80); |
54310121 | 5946 | |
5947 | filefield() will return a file upload field for Netscape 2.0 browsers. | |
5948 | In order to take full advantage of this I<you must use the new | |
5949 | multipart encoding scheme> for the form. You can do this either | |
6b4ac661 | 5950 | by calling B<start_form()> with an encoding type of B<&CGI::MULTIPART>, |
54310121 | 5951 | or by calling the new method B<start_multipart_form()> instead of |
3d1a2ec4 | 5952 | vanilla B<start_form()>. |
54310121 | 5953 | |
5954 | =over 4 | |
5955 | ||
5956 | =item B<Parameters> | |
5957 | ||
5958 | =item 1. | |
5959 | ||
5960 | The first parameter is the required name for the field (-name). | |
5961 | ||
5962 | =item 2. | |
5963 | ||
5964 | The optional second parameter is the starting value for the field contents | |
5965 | to be used as the default file name (-default). | |
5966 | ||
71f3e297 JH |
5967 | For security reasons, browsers don't pay any attention to this field, |
5968 | and so the starting value will always be blank. Worse, the field | |
5969 | loses its "sticky" behavior and forgets its previous contents. The | |
5970 | starting value field is called for in the HTML specification, however, | |
5971 | and possibly some browser will eventually provide support for it. | |
54310121 | 5972 | |
5973 | =item 3. | |
5974 | ||
5975 | The optional third parameter is the size of the field in | |
5976 | characters (-size). | |
5977 | ||
5978 | =item 4. | |
5979 | ||
5980 | The optional fourth parameter is the maximum number of characters the | |
5981 | field will accept (-maxlength). | |
5982 | ||
5983 | =back | |
5984 | ||
5985 | When the form is processed, you can retrieve the entered filename | |
3538e1d5 | 5986 | by calling param(): |
54310121 | 5987 | |
29ddc2a4 | 5988 | $filename = param('uploaded_file'); |
54310121 | 5989 | |
3538e1d5 GS |
5990 | Different browsers will return slightly different things for the |
5991 | name. Some browsers return the filename only. Others return the full | |
5992 | path to the file, using the path conventions of the user's machine. | |
5993 | Regardless, the name returned is always the name of the file on the | |
5994 | I<user's> machine, and is unrelated to the name of the temporary file | |
5995 | that CGI.pm creates during upload spooling (see below). | |
54310121 | 5996 | |
5997 | The filename returned is also a file handle. You can read the contents | |
5998 | of the file using standard Perl file reading calls: | |
5999 | ||
6000 | # Read a text file and print it out | |
6001 | while (<$filename>) { | |
6002 | print; | |
6003 | } | |
6004 | ||
6005 | # Copy a binary file to somewhere safe | |
6006 | open (OUTFILE,">>/usr/local/web/users/feedback"); | |
6007 | while ($bytesread=read($filename,$buffer,1024)) { | |
6008 | print OUTFILE $buffer; | |
6009 | } | |
6010 | ||
3538e1d5 GS |
6011 | However, there are problems with the dual nature of the upload fields. |
6012 | If you C<use strict>, then Perl will complain when you try to use a | |
6013 | string as a filehandle. You can get around this by placing the file | |
6014 | reading code in a block containing the C<no strict> pragma. More | |
6015 | seriously, it is possible for the remote user to type garbage into the | |
6016 | upload field, in which case what you get from param() is not a | |
6017 | filehandle at all, but a string. | |
6018 | ||
6019 | To be safe, use the I<upload()> function (new in version 2.47). When | |
6020 | called with the name of an upload field, I<upload()> returns a | |
6021 | filehandle, or undef if the parameter is not a valid filehandle. | |
6022 | ||
29ddc2a4 | 6023 | $fh = upload('uploaded_file'); |
3538e1d5 GS |
6024 | while (<$fh>) { |
6025 | print; | |
6026 | } | |
6027 | ||
13548fdf | 6028 | In an list context, upload() will return an array of filehandles. |
199d4a26 JH |
6029 | This makes it possible to create forms that use the same name for |
6030 | multiple upload fields. | |
6031 | ||
3538e1d5 GS |
6032 | This is the recommended idiom. |
6033 | ||
681699b9 SP |
6034 | For robust code, consider reseting the file handle position to beginning of the |
6035 | file. Inside of larger frameworks, other code may have already used the query | |
6036 | object and changed the filehandle postion: | |
6037 | ||
6038 | seek($fh,0,0); # reset postion to beginning of file. | |
6039 | ||
54310121 | 6040 | When a file is uploaded the browser usually sends along some |
6041 | information along with it in the format of headers. The information | |
6042 | usually includes the MIME content type. Future browsers may send | |
6043 | other information as well (such as modification date and size). To | |
6044 | retrieve this information, call uploadInfo(). It returns a reference to | |
6045 | an associative array containing all the document headers. | |
6046 | ||
29ddc2a4 RGS |
6047 | $filename = param('uploaded_file'); |
6048 | $type = uploadInfo($filename)->{'Content-Type'}; | |
54310121 | 6049 | unless ($type eq 'text/html') { |
6050 | die "HTML FILES ONLY!"; | |
6051 | } | |
6052 | ||
6053 | If you are using a machine that recognizes "text" and "binary" data | |
6054 | modes, be sure to understand when and how to use them (see the Camel book). | |
3538e1d5 GS |
6055 | Otherwise you may find that binary files are corrupted during file |
6056 | uploads. | |
6057 | ||
6058 | There are occasionally problems involving parsing the uploaded file. | |
6059 | This usually happens when the user presses "Stop" before the upload is | |
6060 | finished. In this case, CGI.pm will return undef for the name of the | |
6061 | uploaded file and set I<cgi_error()> to the string "400 Bad request | |
6062 | (malformed multipart POST)". This error message is designed so that | |
6063 | you can incorporate it into a status code to be sent to the browser. | |
6064 | Example: | |
6065 | ||
29ddc2a4 RGS |
6066 | $file = upload('uploaded_file'); |
6067 | if (!$file && cgi_error) { | |
6068 | print header(-status=>cgi_error); | |
3538e1d5 GS |
6069 | exit 0; |
6070 | } | |
6071 | ||
6072 | You are free to create a custom HTML page to complain about the error, | |
6073 | if you wish. | |
54310121 | 6074 | |
2ed511ec RGS |
6075 | You can set up a callback that will be called whenever a file upload |
6076 | is being read during the form processing. This is much like the | |
6077 | UPLOAD_HOOK facility available in Apache::Request, with the exception | |
6078 | that the first argument to the callback is an Apache::Upload object, | |
6079 | here it's the remote filename. | |
6080 | ||
cb3b230c | 6081 | $q = CGI->new(\&hook [,$data [,$use_tempfile]]); |
2ed511ec RGS |
6082 | |
6083 | sub hook | |
6084 | { | |
6085 | my ($filename, $buffer, $bytes_read, $data) = @_; | |
6086 | print "Read $bytes_read bytes of $filename\n"; | |
6087 | } | |
6088 | ||
cb3b230c SP |
6089 | The $data field is optional; it lets you pass configuration |
6090 | information (e.g. a database handle) to your hook callback. | |
6091 | ||
6092 | The $use_tempfile field is a flag that lets you turn on and off | |
6093 | CGI.pm's use of a temporary disk-based file during file upload. If you | |
6094 | set this to a FALSE value (default true) then param('uploaded_file') | |
6095 | will no longer work, and the only way to get at the uploaded data is | |
6096 | via the hook you provide. | |
6097 | ||
2ed511ec RGS |
6098 | If using the function-oriented interface, call the CGI::upload_hook() |
6099 | method before calling param() or any other CGI functions: | |
6100 | ||
cb3b230c | 6101 | CGI::upload_hook(\&hook [,$data [,$use_tempfile]]); |
2ed511ec RGS |
6102 | |
6103 | This method is not exported by default. You will have to import it | |
6104 | explicitly if you wish to use it without the CGI:: prefix. | |
6105 | ||
199d4a26 JH |
6106 | If you are using CGI.pm on a Windows platform and find that binary |
6107 | files get slightly larger when uploaded but that text files remain the | |
6108 | same, then you have forgotten to activate binary mode on the output | |
6109 | filehandle. Be sure to call binmode() on any handle that you create | |
6110 | to write the uploaded file to disk. | |
6111 | ||
424ec8fa GS |
6112 | JAVASCRIPTING: The B<-onChange>, B<-onFocus>, B<-onBlur>, |
6113 | B<-onMouseOver>, B<-onMouseOut> and B<-onSelect> parameters are | |
6114 | recognized. See textfield() for details. | |
54310121 | 6115 | |
6116 | =head2 CREATING A POPUP MENU | |
6117 | ||
29ddc2a4 | 6118 | print popup_menu('menu_name', |
54310121 | 6119 | ['eenie','meenie','minie'], |
6120 | 'meenie'); | |
6121 | ||
6122 | -or- | |
6123 | ||
6124 | %labels = ('eenie'=>'your first choice', | |
6125 | 'meenie'=>'your second choice', | |
6126 | 'minie'=>'your third choice'); | |
188ba755 | 6127 | %attributes = ('eenie'=>{'class'=>'class of first choice'}); |
29ddc2a4 | 6128 | print popup_menu('menu_name', |
54310121 | 6129 | ['eenie','meenie','minie'], |
188ba755 | 6130 | 'meenie',\%labels,\%attributes); |
54310121 | 6131 | |
6132 | -or (named parameter style)- | |
6133 | ||
29ddc2a4 | 6134 | print popup_menu(-name=>'menu_name', |
54310121 | 6135 | -values=>['eenie','meenie','minie'], |
6136 | -default=>'meenie', | |
188ba755 JH |
6137 | -labels=>\%labels, |
6138 | -attributes=>\%attributes); | |
54310121 | 6139 | |
6140 | popup_menu() creates a menu. | |
6141 | ||
6142 | =over 4 | |
6143 | ||
6144 | =item 1. | |
6145 | ||
6146 | The required first argument is the menu's name (-name). | |
6147 | ||
6148 | =item 2. | |
6149 | ||
6150 | The required second argument (-values) is an array B<reference> | |
6151 | containing the list of menu items in the menu. You can pass the | |
6152 | method an anonymous array, as shown in the example, or a reference to | |
6153 | a named array, such as "\@foo". | |
6154 | ||
6155 | =item 3. | |
6156 | ||
6157 | The optional third parameter (-default) is the name of the default | |
6158 | menu choice. If not specified, the first item will be the default. | |
6159 | The values of the previous choice will be maintained across queries. | |
6160 | ||
6161 | =item 4. | |
6162 | ||
6163 | The optional fourth parameter (-labels) is provided for people who | |
6164 | want to use different values for the user-visible label inside the | |
188ba755 | 6165 | popup menu and the value returned to your script. It's a pointer to an |
54310121 | 6166 | associative array relating menu values to user-visible labels. If you |
6167 | leave this parameter blank, the menu values will be displayed by | |
6168 | default. (You can also leave a label undefined if you want to). | |
6169 | ||
188ba755 JH |
6170 | =item 5. |
6171 | ||
6172 | The optional fifth parameter (-attributes) is provided to assign | |
6173 | any of the common HTML attributes to an individual menu item. It's | |
6174 | a pointer to an associative array relating menu values to another | |
6175 | associative array with the attribute's name as the key and the | |
6176 | attribute's value as the value. | |
6177 | ||
54310121 | 6178 | =back |
6179 | ||
6180 | When the form is processed, the selected value of the popup menu can | |
6181 | be retrieved using: | |
6182 | ||
29ddc2a4 | 6183 | $popup_menu_value = param('menu_name'); |
54310121 | 6184 | |
188ba755 JH |
6185 | =head2 CREATING AN OPTION GROUP |
6186 | ||
6187 | Named parameter style | |
6188 | ||
29ddc2a4 | 6189 | print popup_menu(-name=>'menu_name', |
188ba755 | 6190 | -values=>[qw/eenie meenie minie/, |
29ddc2a4 RGS |
6191 | optgroup(-name=>'optgroup_name', |
6192 | -values => ['moe','catch'], | |
6193 | -attributes=>{'catch'=>{'class'=>'red'}})], | |
188ba755 JH |
6194 | -labels=>{'eenie'=>'one', |
6195 | 'meenie'=>'two', | |
6196 | 'minie'=>'three'}, | |
6197 | -default=>'meenie'); | |
6198 | ||
6199 | Old style | |
29ddc2a4 | 6200 | print popup_menu('menu_name', |
188ba755 | 6201 | ['eenie','meenie','minie', |
29ddc2a4 RGS |
6202 | optgroup('optgroup_name', ['moe', 'catch'], |
6203 | {'catch'=>{'class'=>'red'}})],'meenie', | |
188ba755 JH |
6204 | {'eenie'=>'one','meenie'=>'two','minie'=>'three'}); |
6205 | ||
29ddc2a4 | 6206 | optgroup() creates an option group within a popup menu. |
188ba755 JH |
6207 | |
6208 | =over 4 | |
6209 | ||
6210 | =item 1. | |
6211 | ||
6212 | The required first argument (B<-name>) is the label attribute of the | |
6213 | optgroup and is B<not> inserted in the parameter list of the query. | |
6214 | ||
6215 | =item 2. | |
6216 | ||
6217 | The required second argument (B<-values>) is an array reference | |
6218 | containing the list of menu items in the menu. You can pass the | |
6219 | method an anonymous array, as shown in the example, or a reference | |
6220 | to a named array, such as \@foo. If you pass a HASH reference, | |
6221 | the keys will be used for the menu values, and the values will be | |
6222 | used for the menu labels (see -labels below). | |
6223 | ||
6224 | =item 3. | |
6225 | ||
6226 | The optional third parameter (B<-labels>) allows you to pass a reference | |
6227 | to an associative array containing user-visible labels for one or more | |
6228 | of the menu items. You can use this when you want the user to see one | |
6229 | menu string, but have the browser return your program a different one. | |
6230 | If you don't specify this, the value string will be used instead | |
6231 | ("eenie", "meenie" and "minie" in this example). This is equivalent | |
6232 | to using a hash reference for the -values parameter. | |
6233 | ||
6234 | =item 4. | |
6235 | ||
6236 | An optional fourth parameter (B<-labeled>) can be set to a true value | |
6237 | and indicates that the values should be used as the label attribute | |
6238 | for each option element within the optgroup. | |
6239 | ||
6240 | =item 5. | |
6241 | ||
6242 | An optional fifth parameter (-novals) can be set to a true value and | |
3c4b39be | 6243 | indicates to suppress the val attribute in each option element within |
188ba755 JH |
6244 | the optgroup. |
6245 | ||
6246 | See the discussion on optgroup at W3C | |
6247 | (http://www.w3.org/TR/REC-html40/interact/forms.html#edef-OPTGROUP) | |
6248 | for details. | |
6249 | ||
6250 | =item 6. | |
6251 | ||
6252 | An optional sixth parameter (-attributes) is provided to assign | |
6253 | any of the common HTML attributes to an individual menu item. It's | |
6254 | a pointer to an associative array relating menu values to another | |
6255 | associative array with the attribute's name as the key and the | |
6256 | attribute's value as the value. | |
6257 | ||
cff99809 JH |
6258 | =back |
6259 | ||
54310121 | 6260 | =head2 CREATING A SCROLLING LIST |
6261 | ||
29ddc2a4 | 6262 | print scrolling_list('list_name', |
54310121 | 6263 | ['eenie','meenie','minie','moe'], |
188ba755 | 6264 | ['eenie','moe'],5,'true',{'moe'=>{'class'=>'red'}}); |
54310121 | 6265 | -or- |
6266 | ||
29ddc2a4 | 6267 | print scrolling_list('list_name', |
54310121 | 6268 | ['eenie','meenie','minie','moe'], |
6269 | ['eenie','moe'],5,'true', | |
188ba755 | 6270 | \%labels,%attributes); |
54310121 | 6271 | |
6272 | -or- | |
6273 | ||
29ddc2a4 | 6274 | print scrolling_list(-name=>'list_name', |
54310121 | 6275 | -values=>['eenie','meenie','minie','moe'], |
6276 | -default=>['eenie','moe'], | |
6277 | -size=>5, | |
6278 | -multiple=>'true', | |
188ba755 JH |
6279 | -labels=>\%labels, |
6280 | -attributes=>\%attributes); | |
54310121 | 6281 | |
6282 | scrolling_list() creates a scrolling list. | |
6283 | ||
6284 | =over 4 | |
6285 | ||
6286 | =item B<Parameters:> | |
6287 | ||
6288 | =item 1. | |
6289 | ||
6290 | The first and second arguments are the list name (-name) and values | |
6291 | (-values). As in the popup menu, the second argument should be an | |
6292 | array reference. | |
6293 | ||
6294 | =item 2. | |
6295 | ||
6296 | The optional third argument (-default) can be either a reference to a | |
6297 | list containing the values to be selected by default, or can be a | |
6298 | single value to select. If this argument is missing or undefined, | |
6299 | then nothing is selected when the list first appears. In the named | |
6300 | parameter version, you can use the synonym "-defaults" for this | |
6301 | parameter. | |
6302 | ||
6303 | =item 3. | |
6304 | ||
6305 | The optional fourth argument is the size of the list (-size). | |
6306 | ||
6307 | =item 4. | |
6308 | ||
6309 | The optional fifth argument can be set to true to allow multiple | |
6310 | simultaneous selections (-multiple). Otherwise only one selection | |
6311 | will be allowed at a time. | |
6312 | ||
6313 | =item 5. | |
6314 | ||
6315 | The optional sixth argument is a pointer to an associative array | |
6316 | containing long user-visible labels for the list items (-labels). | |
6317 | If not provided, the values will be displayed. | |
6318 | ||
188ba755 JH |
6319 | =item 6. |
6320 | ||
6321 | The optional sixth parameter (-attributes) is provided to assign | |
6322 | any of the common HTML attributes to an individual menu item. It's | |
6323 | a pointer to an associative array relating menu values to another | |
6324 | associative array with the attribute's name as the key and the | |
6325 | attribute's value as the value. | |
6326 | ||
54310121 | 6327 | When this form is processed, all selected list items will be returned as |
6328 | a list under the parameter name 'list_name'. The values of the | |
6329 | selected items can be retrieved with: | |
6330 | ||
29ddc2a4 | 6331 | @selected = param('list_name'); |
54310121 | 6332 | |
6333 | =back | |
6334 | ||
54310121 | 6335 | =head2 CREATING A GROUP OF RELATED CHECKBOXES |
6336 | ||
29ddc2a4 | 6337 | print checkbox_group(-name=>'group_name', |
54310121 | 6338 | -values=>['eenie','meenie','minie','moe'], |
6339 | -default=>['eenie','moe'], | |
6340 | -linebreak=>'true', | |
8869a4b7 | 6341 | -disabled => ['moe'], |
188ba755 JH |
6342 | -labels=>\%labels, |
6343 | -attributes=>\%attributes); | |
54310121 | 6344 | |
29ddc2a4 | 6345 | print checkbox_group('group_name', |
54310121 | 6346 | ['eenie','meenie','minie','moe'], |
188ba755 JH |
6347 | ['eenie','moe'],'true',\%labels, |
6348 | {'moe'=>{'class'=>'red'}}); | |
54310121 | 6349 | |
6350 | HTML3-COMPATIBLE BROWSERS ONLY: | |
6351 | ||
29ddc2a4 | 6352 | print checkbox_group(-name=>'group_name', |
54310121 | 6353 | -values=>['eenie','meenie','minie','moe'], |
6354 | -rows=2,-columns=>2); | |
3cb6de81 | 6355 | |
54310121 | 6356 | |
6357 | checkbox_group() creates a list of checkboxes that are related | |
6358 | by the same name. | |
6359 | ||
6360 | =over 4 | |
6361 | ||
6362 | =item B<Parameters:> | |
6363 | ||
6364 | =item 1. | |
6365 | ||
6366 | The first and second arguments are the checkbox name and values, | |
6367 | respectively (-name and -values). As in the popup menu, the second | |
6368 | argument should be an array reference. These values are used for the | |
6369 | user-readable labels printed next to the checkboxes as well as for the | |
6370 | values passed to your script in the query string. | |
6371 | ||
6372 | =item 2. | |
6373 | ||
6374 | The optional third argument (-default) can be either a reference to a | |
6375 | list containing the values to be checked by default, or can be a | |
6376 | single value to checked. If this argument is missing or undefined, | |
6377 | then nothing is selected when the list first appears. | |
6378 | ||
6379 | =item 3. | |
6380 | ||
6381 | The optional fourth argument (-linebreak) can be set to true to place | |
6382 | line breaks between the checkboxes so that they appear as a vertical | |
6383 | list. Otherwise, they will be strung together on a horizontal line. | |
6384 | ||
29ddc2a4 | 6385 | =back |
54310121 | 6386 | |
54310121 | 6387 | |
29ddc2a4 RGS |
6388 | The optional b<-labels> argument is a pointer to an associative array |
6389 | relating the checkbox values to the user-visible labels that will be | |
6390 | printed next to them. If not provided, the values will be used as the | |
6391 | default. | |
54310121 | 6392 | |
54310121 | 6393 | |
8869a4b7 SP |
6394 | The optional parameters B<-rows>, and B<-columns> cause |
6395 | checkbox_group() to return an HTML3 compatible table containing the | |
6396 | checkbox group formatted with the specified number of rows and | |
6397 | columns. You can provide just the -columns parameter if you wish; | |
6398 | checkbox_group will calculate the correct number of rows for you. | |
188ba755 | 6399 | |
8869a4b7 SP |
6400 | The option b<-disabled> takes an array of checkbox values and disables |
6401 | them by greying them out (this may not be supported by all browsers). | |
188ba755 | 6402 | |
29ddc2a4 RGS |
6403 | The optional B<-attributes> argument is provided to assign any of the |
6404 | common HTML attributes to an individual menu item. It's a pointer to | |
6405 | an associative array relating menu values to another associative array | |
6406 | with the attribute's name as the key and the attribute's value as the | |
6407 | value. | |
54310121 | 6408 | |
29ddc2a4 RGS |
6409 | The optional B<-tabindex> argument can be used to control the order in which |
6410 | radio buttons receive focus when the user presses the tab button. If | |
6411 | passed a scalar numeric value, the first element in the group will | |
6412 | receive this tab index and subsequent elements will be incremented by | |
6413 | one. If given a reference to an array of radio button values, then | |
6414 | the indexes will be jiggered so that the order specified in the array | |
6415 | will correspond to the tab order. You can also pass a reference to a | |
6416 | hash in which the hash keys are the radio button values and the values | |
6417 | are the tab indexes of each button. Examples: | |
6418 | ||
6419 | -tabindex => 100 # this group starts at index 100 and counts up | |
6420 | -tabindex => ['moe','minie','eenie','meenie'] # tab in this order | |
6421 | -tabindex => {meenie=>100,moe=>101,minie=>102,eenie=>200} # tab in this order | |
54310121 | 6422 | |
bb8b3399 SP |
6423 | The optional B<-labelattributes> argument will contain attributes |
6424 | attached to the <label> element that surrounds each button. | |
6425 | ||
54310121 | 6426 | When the form is processed, all checked boxes will be returned as |
6427 | a list under the parameter name 'group_name'. The values of the | |
6428 | "on" checkboxes can be retrieved with: | |
6429 | ||
29ddc2a4 | 6430 | @turned_on = param('group_name'); |
54310121 | 6431 | |
6432 | The value returned by checkbox_group() is actually an array of button | |
6433 | elements. You can capture them and use them within tables, lists, | |
6434 | or in other creative ways: | |
6435 | ||
29ddc2a4 | 6436 | @h = checkbox_group(-name=>'group_name',-values=>\@values); |
54310121 | 6437 | &use_in_creative_way(@h); |
6438 | ||
54310121 | 6439 | =head2 CREATING A STANDALONE CHECKBOX |
6440 | ||
29ddc2a4 | 6441 | print checkbox(-name=>'checkbox_name', |
ac734d8b | 6442 | -checked=>1, |
54310121 | 6443 | -value=>'ON', |
6444 | -label=>'CLICK ME'); | |
6445 | ||
6446 | -or- | |
6447 | ||
29ddc2a4 | 6448 | print checkbox('checkbox_name','checked','ON','CLICK ME'); |
54310121 | 6449 | |
6450 | checkbox() is used to create an isolated checkbox that isn't logically | |
6451 | related to any others. | |
6452 | ||
6453 | =over 4 | |
6454 | ||
6455 | =item B<Parameters:> | |
6456 | ||
6457 | =item 1. | |
6458 | ||
6459 | The first parameter is the required name for the checkbox (-name). It | |
6460 | will also be used for the user-readable label printed next to the | |
6461 | checkbox. | |
6462 | ||
6463 | =item 2. | |
6464 | ||
6465 | The optional second parameter (-checked) specifies that the checkbox | |
6466 | is turned on by default. Synonyms are -selected and -on. | |
6467 | ||
6468 | =item 3. | |
6469 | ||
6470 | The optional third parameter (-value) specifies the value of the | |
6471 | checkbox when it is checked. If not provided, the word "on" is | |
6472 | assumed. | |
6473 | ||
6474 | =item 4. | |
6475 | ||
6476 | The optional fourth parameter (-label) is the user-readable label to | |
6477 | be attached to the checkbox. If not provided, the checkbox name is | |
6478 | used. | |
6479 | ||
6480 | =back | |
6481 | ||
6482 | The value of the checkbox can be retrieved using: | |
6483 | ||
29ddc2a4 | 6484 | $turned_on = param('checkbox_name'); |
54310121 | 6485 | |
6486 | =head2 CREATING A RADIO BUTTON GROUP | |
6487 | ||
29ddc2a4 | 6488 | print radio_group(-name=>'group_name', |
54310121 | 6489 | -values=>['eenie','meenie','minie'], |
6490 | -default=>'meenie', | |
6491 | -linebreak=>'true', | |
188ba755 JH |
6492 | -labels=>\%labels, |
6493 | -attributes=>\%attributes); | |
54310121 | 6494 | |
6495 | -or- | |
6496 | ||
29ddc2a4 | 6497 | print radio_group('group_name',['eenie','meenie','minie'], |
188ba755 | 6498 | 'meenie','true',\%labels,\%attributes); |
54310121 | 6499 | |
6500 | ||
6501 | HTML3-COMPATIBLE BROWSERS ONLY: | |
6502 | ||
29ddc2a4 | 6503 | print radio_group(-name=>'group_name', |
54310121 | 6504 | -values=>['eenie','meenie','minie','moe'], |
6505 | -rows=2,-columns=>2); | |
6506 | ||
6507 | radio_group() creates a set of logically-related radio buttons | |
6508 | (turning one member of the group on turns the others off) | |
6509 | ||
6510 | =over 4 | |
6511 | ||
6512 | =item B<Parameters:> | |
6513 | ||
6514 | =item 1. | |
6515 | ||
6516 | The first argument is the name of the group and is required (-name). | |
6517 | ||
6518 | =item 2. | |
6519 | ||
6520 | The second argument (-values) is the list of values for the radio | |
6521 | buttons. The values and the labels that appear on the page are | |
6522 | identical. Pass an array I<reference> in the second argument, either | |
6523 | using an anonymous array, as shown, or by referencing a named array as | |
6524 | in "\@foo". | |
6525 | ||
6526 | =item 3. | |
6527 | ||
6528 | The optional third parameter (-default) is the name of the default | |
6529 | button to turn on. If not specified, the first item will be the | |
6530 | default. You can provide a nonexistent button name, such as "-" to | |
6531 | start up with no buttons selected. | |
6532 | ||
6533 | =item 4. | |
6534 | ||
6535 | The optional fourth parameter (-linebreak) can be set to 'true' to put | |
6536 | line breaks between the buttons, creating a vertical list. | |
6537 | ||
6538 | =item 5. | |
6539 | ||
6540 | The optional fifth parameter (-labels) is a pointer to an associative | |
6541 | array relating the radio button values to user-visible labels to be | |
6542 | used in the display. If not provided, the values themselves are | |
6543 | displayed. | |
6544 | ||
29ddc2a4 | 6545 | =back |
54310121 | 6546 | |
188ba755 | 6547 | |
29ddc2a4 RGS |
6548 | All modern browsers can take advantage of the optional parameters |
6549 | B<-rows>, and B<-columns>. These parameters cause radio_group() to | |
6550 | return an HTML3 compatible table containing the radio group formatted | |
6551 | with the specified number of rows and columns. You can provide just | |
6552 | the -columns parameter if you wish; radio_group will calculate the | |
6553 | correct number of rows for you. | |
188ba755 | 6554 | |
54310121 | 6555 | To include row and column headings in the returned table, you |
8869a4b7 | 6556 | can use the B<-rowheaders> and B<-colheaders> parameters. Both |
54310121 | 6557 | of these accept a pointer to an array of headings to use. |
6558 | The headings are just decorative. They don't reorganize the | |
f610777f | 6559 | interpretation of the radio buttons -- they're still a single named |
54310121 | 6560 | unit. |
6561 | ||
29ddc2a4 RGS |
6562 | The optional B<-tabindex> argument can be used to control the order in which |
6563 | radio buttons receive focus when the user presses the tab button. If | |
6564 | passed a scalar numeric value, the first element in the group will | |
6565 | receive this tab index and subsequent elements will be incremented by | |
6566 | one. If given a reference to an array of radio button values, then | |
6567 | the indexes will be jiggered so that the order specified in the array | |
6568 | will correspond to the tab order. You can also pass a reference to a | |
6569 | hash in which the hash keys are the radio button values and the values | |
6570 | are the tab indexes of each button. Examples: | |
6571 | ||
6572 | -tabindex => 100 # this group starts at index 100 and counts up | |
6573 | -tabindex => ['moe','minie','eenie','meenie'] # tab in this order | |
6574 | -tabindex => {meenie=>100,moe=>101,minie=>102,eenie=>200} # tab in this order | |
6575 | ||
6576 | ||
6577 | The optional B<-attributes> argument is provided to assign any of the | |
6578 | common HTML attributes to an individual menu item. It's a pointer to | |
6579 | an associative array relating menu values to another associative array | |
6580 | with the attribute's name as the key and the attribute's value as the | |
6581 | value. | |
54310121 | 6582 | |
bb8b3399 SP |
6583 | The optional B<-labelattributes> argument will contain attributes |
6584 | attached to the <label> element that surrounds each button. | |
6585 | ||
54310121 | 6586 | When the form is processed, the selected radio button can |
6587 | be retrieved using: | |
6588 | ||
29ddc2a4 | 6589 | $which_radio_button = param('group_name'); |
54310121 | 6590 | |
6591 | The value returned by radio_group() is actually an array of button | |
6592 | elements. You can capture them and use them within tables, lists, | |
6593 | or in other creative ways: | |
6594 | ||
29ddc2a4 | 6595 | @h = radio_group(-name=>'group_name',-values=>\@values); |
54310121 | 6596 | &use_in_creative_way(@h); |
6597 | ||
6598 | =head2 CREATING A SUBMIT BUTTON | |
6599 | ||
29ddc2a4 | 6600 | print submit(-name=>'button_name', |
54310121 | 6601 | -value=>'value'); |
6602 | ||
6603 | -or- | |
6604 | ||
29ddc2a4 | 6605 | print submit('button_name','value'); |
54310121 | 6606 | |
6607 | submit() will create the query submission button. Every form | |
6608 | should have one of these. | |
6609 | ||
6610 | =over 4 | |
6611 | ||
6612 | =item B<Parameters:> | |
6613 | ||
6614 | =item 1. | |
6615 | ||
6616 | The first argument (-name) is optional. You can give the button a | |
6617 | name if you have several submission buttons in your form and you want | |
13548fdf | 6618 | to distinguish between them. |
54310121 | 6619 | |
6620 | =item 2. | |
6621 | ||
6622 | The second argument (-value) is also optional. This gives the button | |
13548fdf RGS |
6623 | a value that will be passed to your script in the query string. The |
6624 | name will also be used as the user-visible label. | |
6625 | ||
6626 | =item 3. | |
6627 | ||
6628 | You can use -label as an alias for -value. I always get confused | |
6629 | about which of -name and -value changes the user-visible label on the | |
6630 | button. | |
54310121 | 6631 | |
6632 | =back | |
6633 | ||
6634 | You can figure out which button was pressed by using different | |
6635 | values for each one: | |
6636 | ||
29ddc2a4 | 6637 | $which_one = param('button_name'); |
54310121 | 6638 | |
6639 | =head2 CREATING A RESET BUTTON | |
6640 | ||
29ddc2a4 | 6641 | print reset |
54310121 | 6642 | |
6643 | reset() creates the "reset" button. Note that it restores the | |
6644 | form to its value from the last time the script was called, | |
6645 | NOT necessarily to the defaults. | |
6646 | ||
71f3e297 JH |
6647 | Note that this conflicts with the Perl reset() built-in. Use |
6648 | CORE::reset() to get the original reset function. | |
6649 | ||
54310121 | 6650 | =head2 CREATING A DEFAULT BUTTON |
6651 | ||
29ddc2a4 | 6652 | print defaults('button_label') |
54310121 | 6653 | |
6654 | defaults() creates a button that, when invoked, will cause the | |
6655 | form to be completely reset to its defaults, wiping out all the | |
6656 | changes the user ever made. | |
6657 | ||
6658 | =head2 CREATING A HIDDEN FIELD | |
6659 | ||
29ddc2a4 | 6660 | print hidden(-name=>'hidden_name', |
54310121 | 6661 | -default=>['value1','value2'...]); |
6662 | ||
6663 | -or- | |
6664 | ||
29ddc2a4 | 6665 | print hidden('hidden_name','value1','value2'...); |
54310121 | 6666 | |
6667 | hidden() produces a text field that can't be seen by the user. It | |
6668 | is useful for passing state variable information from one invocation | |
6669 | of the script to the next. | |
6670 | ||
6671 | =over 4 | |
6672 | ||
6673 | =item B<Parameters:> | |
6674 | ||
6675 | =item 1. | |
6676 | ||
6677 | The first argument is required and specifies the name of this | |
6678 | field (-name). | |
6679 | ||
6680 | =item 2. | |
6681 | ||
6682 | The second argument is also required and specifies its value | |
6683 | (-default). In the named parameter style of calling, you can provide | |
6684 | a single value here or a reference to a whole list | |
6685 | ||
6686 | =back | |
6687 | ||
6688 | Fetch the value of a hidden field this way: | |
6689 | ||
29ddc2a4 | 6690 | $hidden_value = param('hidden_name'); |
54310121 | 6691 | |
6692 | Note, that just like all the other form elements, the value of a | |
6693 | hidden field is "sticky". If you want to replace a hidden field with | |
6694 | some other values after the script has been called once you'll have to | |
6695 | do it manually: | |
6696 | ||
29ddc2a4 | 6697 | param('hidden_name','new','values','here'); |
54310121 | 6698 | |
6699 | =head2 CREATING A CLICKABLE IMAGE BUTTON | |
6700 | ||
29ddc2a4 | 6701 | print image_button(-name=>'button_name', |
54310121 | 6702 | -src=>'/source/URL', |
6703 | -align=>'MIDDLE'); | |
6704 | ||
6705 | -or- | |
6706 | ||
29ddc2a4 | 6707 | print image_button('button_name','/source/URL','MIDDLE'); |
54310121 | 6708 | |
6709 | image_button() produces a clickable image. When it's clicked on the | |
6710 | position of the click is returned to your script as "button_name.x" | |
6711 | and "button_name.y", where "button_name" is the name you've assigned | |
6712 | to it. | |
6713 | ||
54310121 | 6714 | =over 4 |
6715 | ||
6716 | =item B<Parameters:> | |
6717 | ||
6718 | =item 1. | |
6719 | ||
6720 | The first argument (-name) is required and specifies the name of this | |
6721 | field. | |
6722 | ||
6723 | =item 2. | |
6724 | ||
6725 | The second argument (-src) is also required and specifies the URL | |
6726 | ||
6727 | =item 3. | |
6728 | The third option (-align, optional) is an alignment type, and may be | |
6729 | TOP, BOTTOM or MIDDLE | |
6730 | ||
6731 | =back | |
6732 | ||
6733 | Fetch the value of the button this way: | |
29ddc2a4 RGS |
6734 | $x = param('button_name.x'); |
6735 | $y = param('button_name.y'); | |
54310121 | 6736 | |
6737 | =head2 CREATING A JAVASCRIPT ACTION BUTTON | |
6738 | ||
29ddc2a4 | 6739 | print button(-name=>'button_name', |
54310121 | 6740 | -value=>'user visible label', |
6741 | -onClick=>"do_something()"); | |
6742 | ||
6743 | -or- | |
6744 | ||
29ddc2a4 | 6745 | print button('button_name',"do_something()"); |
54310121 | 6746 | |
6747 | button() produces a button that is compatible with Netscape 2.0's | |
6748 | JavaScript. When it's pressed the fragment of JavaScript code | |
6749 | pointed to by the B<-onClick> parameter will be executed. On | |
6750 | non-Netscape browsers this form element will probably not even | |
6751 | display. | |
6752 | ||
71f3e297 | 6753 | =head1 HTTP COOKIES |
54310121 | 6754 | |
71f3e297 JH |
6755 | Netscape browsers versions 1.1 and higher, and all versions of |
6756 | Internet Explorer, support a so-called "cookie" designed to help | |
6757 | maintain state within a browser session. CGI.pm has several methods | |
6758 | that support cookies. | |
54310121 | 6759 | |
6760 | A cookie is a name=value pair much like the named parameters in a CGI | |
6761 | query string. CGI scripts create one or more cookies and send | |
6762 | them to the browser in the HTTP header. The browser maintains a list | |
6763 | of cookies that belong to a particular Web server, and returns them | |
6764 | to the CGI script during subsequent interactions. | |
6765 | ||
6766 | In addition to the required name=value pair, each cookie has several | |
6767 | optional attributes: | |
6768 | ||
6769 | =over 4 | |
6770 | ||
6771 | =item 1. an expiration time | |
6772 | ||
6773 | This is a time/date string (in a special GMT format) that indicates | |
6774 | when a cookie expires. The cookie will be saved and returned to your | |
6775 | script until this expiration date is reached if the user exits | |
71f3e297 JH |
6776 | the browser and restarts it. If an expiration date isn't specified, the cookie |
6777 | will remain active until the user quits the browser. | |
54310121 | 6778 | |
6779 | =item 2. a domain | |
6780 | ||
6781 | This is a partial or complete domain name for which the cookie is | |
6782 | valid. The browser will return the cookie to any host that matches | |
6783 | the partial domain name. For example, if you specify a domain name | |
71f3e297 | 6784 | of ".capricorn.com", then the browser will return the cookie to |
54310121 | 6785 | Web servers running on any of the machines "www.capricorn.com", |
6786 | "www2.capricorn.com", "feckless.capricorn.com", etc. Domain names | |
6787 | must contain at least two periods to prevent attempts to match | |
6788 | on top level domains like ".edu". If no domain is specified, then | |
6789 | the browser will only return the cookie to servers on the host the | |
6790 | cookie originated from. | |
6791 | ||
6792 | =item 3. a path | |
6793 | ||
6794 | If you provide a cookie path attribute, the browser will check it | |
6795 | against your script's URL before returning the cookie. For example, | |
6796 | if you specify the path "/cgi-bin", then the cookie will be returned | |
6797 | to each of the scripts "/cgi-bin/tally.pl", "/cgi-bin/order.pl", | |
6798 | and "/cgi-bin/customer_service/complain.pl", but not to the script | |
6799 | "/cgi-private/site_admin.pl". By default, path is set to "/", which | |
6800 | causes the cookie to be sent to any CGI script on your site. | |
6801 | ||
6802 | =item 4. a "secure" flag | |
6803 | ||
6804 | If the "secure" attribute is set, the cookie will only be sent to your | |
6805 | script if the CGI request is occurring on a secure channel, such as SSL. | |
6806 | ||
6807 | =back | |
6808 | ||
71f3e297 | 6809 | The interface to HTTP cookies is the B<cookie()> method: |
54310121 | 6810 | |
29ddc2a4 | 6811 | $cookie = cookie(-name=>'sessionID', |
54310121 | 6812 | -value=>'xyzzy', |
6813 | -expires=>'+1h', | |
6814 | -path=>'/cgi-bin/database', | |
6815 | -domain=>'.capricorn.org', | |
6816 | -secure=>1); | |
29ddc2a4 | 6817 | print header(-cookie=>$cookie); |
54310121 | 6818 | |
6819 | B<cookie()> creates a new cookie. Its parameters include: | |
6820 | ||
6821 | =over 4 | |
6822 | ||
6823 | =item B<-name> | |
6824 | ||
6825 | The name of the cookie (required). This can be any string at all. | |
71f3e297 | 6826 | Although browsers limit their cookie names to non-whitespace |
54310121 | 6827 | alphanumeric characters, CGI.pm removes this restriction by escaping |
6828 | and unescaping cookies behind the scenes. | |
6829 | ||
6830 | =item B<-value> | |
6831 | ||
6832 | The value of the cookie. This can be any scalar value, | |
6833 | array reference, or even associative array reference. For example, | |
6834 | you can store an entire associative array into a cookie this way: | |
6835 | ||
29ddc2a4 | 6836 | $cookie=cookie(-name=>'family information', |
54310121 | 6837 | -value=>\%childrens_ages); |
6838 | ||
6839 | =item B<-path> | |
6840 | ||
6841 | The optional partial path for which this cookie will be valid, as described | |
6842 | above. | |
6843 | ||
6844 | =item B<-domain> | |
6845 | ||
6846 | The optional partial domain for which this cookie will be valid, as described | |
6847 | above. | |
6848 | ||
6849 | =item B<-expires> | |
6850 | ||
6851 | The optional expiration date for this cookie. The format is as described | |
6852 | in the section on the B<header()> method: | |
6853 | ||
6854 | "+1h" one hour from now | |
6855 | ||
6856 | =item B<-secure> | |
6857 | ||
6858 | If set to true, this cookie will only be used within a secure | |
6859 | SSL session. | |
6860 | ||
6861 | =back | |
6862 | ||
6863 | The cookie created by cookie() must be incorporated into the HTTP | |
6864 | header within the string returned by the header() method: | |
6865 | ||
0664a57d | 6866 | use CGI ':standard'; |
29ddc2a4 | 6867 | print header(-cookie=>$my_cookie); |
54310121 | 6868 | |
6869 | To create multiple cookies, give header() an array reference: | |
6870 | ||
29ddc2a4 | 6871 | $cookie1 = cookie(-name=>'riddle_name', |
54310121 | 6872 | -value=>"The Sphynx's Question"); |
29ddc2a4 | 6873 | $cookie2 = cookie(-name=>'answers', |
54310121 | 6874 | -value=>\%answers); |
29ddc2a4 | 6875 | print header(-cookie=>[$cookie1,$cookie2]); |
54310121 | 6876 | |
03b9648d | 6877 | To retrieve a cookie, request it by name by calling cookie() method |
0664a57d SP |
6878 | without the B<-value> parameter. This example uses the object-oriented |
6879 | form: | |
54310121 | 6880 | |
6881 | use CGI; | |
6882 | $query = new CGI; | |
0664a57d SP |
6883 | $riddle = $query->cookie('riddle_name'); |
6884 | %answers = $query->cookie('answers'); | |
03b9648d JH |
6885 | |
6886 | Cookies created with a single scalar value, such as the "riddle_name" | |
6887 | cookie, will be returned in that form. Cookies with array and hash | |
6888 | values can also be retrieved. | |
54310121 | 6889 | |
6890 | The cookie and CGI namespaces are separate. If you have a parameter | |
6891 | named 'answers' and a cookie named 'answers', the values retrieved by | |
6892 | param() and cookie() are independent of each other. However, it's | |
6893 | simple to turn a CGI parameter into a cookie, and vice-versa: | |
6894 | ||
6895 | # turn a CGI parameter into a cookie | |
29ddc2a4 | 6896 | $c=cookie(-name=>'answers',-value=>[param('answers')]); |
54310121 | 6897 | # vice-versa |
29ddc2a4 | 6898 | param(-name=>'answers',-value=>[cookie('answers')]); |
54310121 | 6899 | |
55b5d700 SP |
6900 | If you call cookie() without any parameters, it will return a list of |
6901 | the names of all cookies passed to your script: | |
6902 | ||
6903 | @cookies = cookie(); | |
6904 | ||
54310121 | 6905 | See the B<cookie.cgi> example script for some ideas on how to use |
6906 | cookies effectively. | |
6907 | ||
71f3e297 | 6908 | =head1 WORKING WITH FRAMES |
54310121 | 6909 | |
71f3e297 JH |
6910 | It's possible for CGI.pm scripts to write into several browser panels |
6911 | and windows using the HTML 4 frame mechanism. There are three | |
6912 | techniques for defining new frames programmatically: | |
54310121 | 6913 | |
6914 | =over 4 | |
6915 | ||
6916 | =item 1. Create a <Frameset> document | |
6917 | ||
6918 | After writing out the HTTP header, instead of creating a standard | |
3acbd4f5 | 6919 | HTML document using the start_html() call, create a <frameset> |
54310121 | 6920 | document that defines the frames on the page. Specify your script(s) |
6921 | (with appropriate parameters) as the SRC for each of the frames. | |
6922 | ||
3acbd4f5 | 6923 | There is no specific support for creating <frameset> sections |
54310121 | 6924 | in CGI.pm, but the HTML is very simple to write. See the frame |
6925 | documentation in Netscape's home pages for details | |
6926 | ||
0664a57d | 6927 | http://wp.netscape.com/assist/net_sites/frames.html |
54310121 | 6928 | |
6929 | =item 2. Specify the destination for the document in the HTTP header | |
6930 | ||
6931 | You may provide a B<-target> parameter to the header() method: | |
3cb6de81 | 6932 | |
29ddc2a4 | 6933 | print header(-target=>'ResultsWindow'); |
54310121 | 6934 | |
71f3e297 JH |
6935 | This will tell the browser to load the output of your script into the |
6936 | frame named "ResultsWindow". If a frame of that name doesn't already | |
6937 | exist, the browser will pop up a new window and load your script's | |
6938 | document into that. There are a number of magic names that you can | |
6939 | use for targets. See the frame documents on Netscape's home pages for | |
6940 | details. | |
54310121 | 6941 | |
3acbd4f5 | 6942 | =item 3. Specify the destination for the document in the <form> tag |
54310121 | 6943 | |
6944 | You can specify the frame to load in the FORM tag itself. With | |
6945 | CGI.pm it looks like this: | |
6946 | ||
29ddc2a4 | 6947 | print start_form(-target=>'ResultsWindow'); |
54310121 | 6948 | |
6949 | When your script is reinvoked by the form, its output will be loaded | |
6950 | into the frame named "ResultsWindow". If one doesn't already exist | |
6951 | a new window will be created. | |
6952 | ||
6953 | =back | |
6954 | ||
6955 | The script "frameset.cgi" in the examples directory shows one way to | |
6956 | create pages in which the fill-out form and the response live in | |
6957 | side-by-side frames. | |
6958 | ||
29ddc2a4 RGS |
6959 | =head1 SUPPORT FOR JAVASCRIPT |
6960 | ||
6961 | Netscape versions 2.0 and higher incorporate an interpreted language | |
6962 | called JavaScript. Internet Explorer, 3.0 and higher, supports a | |
6963 | closely-related dialect called JScript. JavaScript isn't the same as | |
6964 | Java, and certainly isn't at all the same as Perl, which is a great | |
3c4b39be | 6965 | pity. JavaScript allows you to programmatically change the contents of |
29ddc2a4 RGS |
6966 | fill-out forms, create new windows, and pop up dialog box from within |
6967 | Netscape itself. From the point of view of CGI scripting, JavaScript | |
6968 | is quite useful for validating fill-out forms prior to submitting | |
6969 | them. | |
6970 | ||
6971 | You'll need to know JavaScript in order to use it. There are many good | |
6972 | sources in bookstores and on the web. | |
6973 | ||
6974 | The usual way to use JavaScript is to define a set of functions in a | |
6975 | <SCRIPT> block inside the HTML header and then to register event | |
6976 | handlers in the various elements of the page. Events include such | |
6977 | things as the mouse passing over a form element, a button being | |
6978 | clicked, the contents of a text field changing, or a form being | |
6979 | submitted. When an event occurs that involves an element that has | |
6980 | registered an event handler, its associated JavaScript code gets | |
6981 | called. | |
6982 | ||
6983 | The elements that can register event handlers include the <BODY> of an | |
6984 | HTML document, hypertext links, all the various elements of a fill-out | |
6985 | form, and the form itself. There are a large number of events, and | |
6986 | each applies only to the elements for which it is relevant. Here is a | |
6987 | partial list: | |
6988 | ||
6989 | =over 4 | |
6990 | ||
6991 | =item B<onLoad> | |
6992 | ||
6993 | The browser is loading the current document. Valid in: | |
6994 | ||
6995 | + The HTML <BODY> section only. | |
6996 | ||
6997 | =item B<onUnload> | |
6998 | ||
6999 | The browser is closing the current page or frame. Valid for: | |
7000 | ||
7001 | + The HTML <BODY> section only. | |
7002 | ||
7003 | =item B<onSubmit> | |
7004 | ||
7005 | The user has pressed the submit button of a form. This event happens | |
7006 | just before the form is submitted, and your function can return a | |
7007 | value of false in order to abort the submission. Valid for: | |
7008 | ||
7009 | + Forms only. | |
7010 | ||
7011 | =item B<onClick> | |
7012 | ||
7013 | The mouse has clicked on an item in a fill-out form. Valid for: | |
7014 | ||
7015 | + Buttons (including submit, reset, and image buttons) | |
7016 | + Checkboxes | |
7017 | + Radio buttons | |
7018 | ||
7019 | =item B<onChange> | |
7020 | ||
7021 | The user has changed the contents of a field. Valid for: | |
7022 | ||
7023 | + Text fields | |
7024 | + Text areas | |
7025 | + Password fields | |
7026 | + File fields | |
7027 | + Popup Menus | |
7028 | + Scrolling lists | |
7029 | ||
7030 | =item B<onFocus> | |
7031 | ||
7032 | The user has selected a field to work with. Valid for: | |
7033 | ||
7034 | + Text fields | |
7035 | + Text areas | |
7036 | + Password fields | |
7037 | + File fields | |
7038 | + Popup Menus | |
7039 | + Scrolling lists | |
7040 | ||
7041 | =item B<onBlur> | |
7042 | ||
7043 | The user has deselected a field (gone to work somewhere else). Valid | |
7044 | for: | |
7045 | ||
7046 | + Text fields | |
7047 | + Text areas | |
7048 | + Password fields | |
7049 | + File fields | |
7050 | + Popup Menus | |
7051 | + Scrolling lists | |
7052 | ||
7053 | =item B<onSelect> | |
7054 | ||
7055 | The user has changed the part of a text field that is selected. Valid | |
7056 | for: | |
7057 | ||
7058 | + Text fields | |
7059 | + Text areas | |
7060 | + Password fields | |
7061 | + File fields | |
7062 | ||
7063 | =item B<onMouseOver> | |
7064 | ||
7065 | The mouse has moved over an element. | |
7066 | ||
7067 | + Text fields | |
7068 | + Text areas | |
7069 | + Password fields | |
7070 | + File fields | |
7071 | + Popup Menus | |
7072 | + Scrolling lists | |
7073 | ||
7074 | =item B<onMouseOut> | |
7075 | ||
7076 | The mouse has moved off an element. | |
7077 | ||
7078 | + Text fields | |
7079 | + Text areas | |
7080 | + Password fields | |
7081 | + File fields | |
7082 | + Popup Menus | |
7083 | + Scrolling lists | |
7084 | ||
7085 | =back | |
7086 | ||
7087 | In order to register a JavaScript event handler with an HTML element, | |
7088 | just use the event name as a parameter when you call the corresponding | |
7089 | CGI method. For example, to have your validateAge() JavaScript code | |
7090 | executed every time the textfield named "age" changes, generate the | |
7091 | field like this: | |
7092 | ||
7093 | print textfield(-name=>'age',-onChange=>"validateAge(this)"); | |
7094 | ||
7095 | This example assumes that you've already declared the validateAge() | |
7096 | function by incorporating it into a <SCRIPT> block. The CGI.pm | |
7097 | start_html() method provides a convenient way to create this section. | |
7098 | ||
7099 | Similarly, you can create a form that checks itself over for | |
7100 | consistency and alerts the user if some essential value is missing by | |
7101 | creating it this way: | |
7102 | print startform(-onSubmit=>"validateMe(this)"); | |
7103 | ||
7104 | See the javascript.cgi script for a demonstration of how this all | |
7105 | works. | |
7106 | ||
7107 | ||
7d37aa8e LS |
7108 | =head1 LIMITED SUPPORT FOR CASCADING STYLE SHEETS |
7109 | ||
7110 | CGI.pm has limited support for HTML3's cascading style sheets (css). | |
7111 | To incorporate a stylesheet into your document, pass the | |
7112 | start_html() method a B<-style> parameter. The value of this | |
2ed511ec RGS |
7113 | parameter may be a scalar, in which case it is treated as the source |
7114 | URL for the stylesheet, or it may be a hash reference. In the latter | |
7d37aa8e LS |
7115 | case you should provide the hash with one or more of B<-src> or |
7116 | B<-code>. B<-src> points to a URL where an externally-defined | |
7117 | stylesheet can be found. B<-code> points to a scalar value to be | |
3acbd4f5 | 7118 | incorporated into a <style> section. Style definitions in B<-code> |
7d37aa8e LS |
7119 | override similarly-named ones in B<-src>, hence the name "cascading." |
7120 | ||
424ec8fa GS |
7121 | You may also specify the type of the stylesheet by adding the optional |
7122 | B<-type> parameter to the hash pointed to by B<-style>. If not | |
7123 | specified, the style defaults to 'text/css'. | |
7124 | ||
7d37aa8e LS |
7125 | To refer to a style within the body of your document, add the |
7126 | B<-class> parameter to any HTML element: | |
7127 | ||
7128 | print h1({-class=>'Fancy'},'Welcome to the Party'); | |
7129 | ||
7130 | Or define styles on the fly with the B<-style> parameter: | |
7131 | ||
7132 | print h1({-style=>'Color: red;'},'Welcome to Hell'); | |
7133 | ||
7134 | You may also use the new B<span()> element to apply a style to a | |
7135 | section of text: | |
7136 | ||
7137 | print span({-style=>'Color: red;'}, | |
7138 | h1('Welcome to Hell'), | |
7139 | "Where did that handbasket get to?" | |
7140 | ); | |
7141 | ||
7142 | Note that you must import the ":html3" definitions to have the | |
7143 | B<span()> method available. Here's a quick and dirty example of using | |
7144 | CSS's. See the CSS specification at | |
7145 | http://www.w3.org/pub/WWW/TR/Wd-css-1.html for more information. | |
7146 | ||
7147 | use CGI qw/:standard :html3/; | |
7148 | ||
7149 | #here's a stylesheet incorporated directly into the page | |
7150 | $newStyle=<<END; | |
7151 | <!-- | |
7152 | P.Tip { | |
7153 | margin-right: 50pt; | |
7154 | margin-left: 50pt; | |
7155 | color: red; | |
7156 | } | |
7157 | P.Alert { | |
7158 | font-size: 30pt; | |
7159 | font-family: sans-serif; | |
7160 | color: red; | |
7161 | } | |
7162 | --> | |
7163 | END | |
7164 | print header(); | |
7165 | print start_html( -title=>'CGI with Style', | |
7166 | -style=>{-src=>'http://www.capricorn.com/style/st1.css', | |
7167 | -code=>$newStyle} | |
7168 | ); | |
7169 | print h1('CGI with Style'), | |
7170 | p({-class=>'Tip'}, | |
7171 | "Better read the cascading style sheet spec before playing with this!"), | |
7172 | span({-style=>'color: magenta'}, | |
7173 | "Look Mom, no hands!", | |
7174 | p(), | |
7175 | "Whooo wee!" | |
7176 | ); | |
7177 | print end_html; | |
7178 | ||
13548fdf RGS |
7179 | Pass an array reference to B<-code> or B<-src> in order to incorporate |
7180 | multiple stylesheets into your document. | |
6b4ac661 | 7181 | |
8f3ccfa2 JH |
7182 | Should you wish to incorporate a verbatim stylesheet that includes |
7183 | arbitrary formatting in the header, you may pass a -verbatim tag to | |
7184 | the -style hash, as follows: | |
7185 | ||
8869a4b7 SP |
7186 | print start_html (-style => {-verbatim => '@import url("/server-common/css/'.$cssFile.'");', |
7187 | -src => '/server-common/css/core.css'}); | |
8f3ccfa2 JH |
7188 | |
7189 | ||
7190 | This will generate an HTML header that contains this: | |
7191 | ||
7192 | <link rel="stylesheet" type="text/css" href="/server-common/css/core.css"> | |
7193 | <style type="text/css"> | |
7194 | @import url("/server-common/css/main.css"); | |
7195 | </style> | |
7196 | ||
1c87da1d JH |
7197 | Any additional arguments passed in the -style value will be |
7198 | incorporated into the <link> tag. For example: | |
7199 | ||
7200 | start_html(-style=>{-src=>['/styles/print.css','/styles/layout.css'], | |
7201 | -media => 'all'}); | |
7202 | ||
7203 | This will give: | |
7204 | ||
7205 | <link rel="stylesheet" type="text/css" href="/styles/print.css" media="all"/> | |
7206 | <link rel="stylesheet" type="text/css" href="/styles/layout.css" media="all"/> | |
7207 | ||
7208 | <p> | |
7209 | ||
7210 | To make more complicated <link> tags, use the Link() function | |
7211 | and pass it to start_html() in the -head argument, as in: | |
7212 | ||
7213 | @h = (Link({-rel=>'stylesheet',-type=>'text/css',-src=>'/ss/ss.css',-media=>'all'}), | |
7214 | Link({-rel=>'stylesheet',-type=>'text/css',-src=>'/ss/fred.css',-media=>'paper'})); | |
7215 | print start_html({-head=>\@h}) | |
7216 | ||
0664a57d SP |
7217 | To create primary and "alternate" stylesheet, use the B<-alternate> option: |
7218 | ||
7219 | start_html(-style=>{-src=>[ | |
7220 | {-src=>'/styles/print.css'}, | |
7221 | {-src=>'/styles/alt.css',-alternate=>1} | |
7222 | ] | |
7223 | }); | |
7224 | ||
54310121 | 7225 | =head1 DEBUGGING |
7226 | ||
3d1a2ec4 GS |
7227 | If you are running the script from the command line or in the perl |
7228 | debugger, you can pass the script a list of keywords or | |
7229 | parameter=value pairs on the command line or from standard input (you | |
7230 | don't have to worry about tricking your script into reading from | |
7231 | environment variables). You can pass keywords like this: | |
54310121 | 7232 | |
7233 | your_script.pl keyword1 keyword2 keyword3 | |
7234 | ||
7235 | or this: | |
7236 | ||
7237 | your_script.pl keyword1+keyword2+keyword3 | |
7238 | ||
7239 | or this: | |
7240 | ||
7241 | your_script.pl name1=value1 name2=value2 | |
7242 | ||
7243 | or this: | |
7244 | ||
7245 | your_script.pl name1=value1&name2=value2 | |
7246 | ||
3d1a2ec4 GS |
7247 | To turn off this feature, use the -no_debug pragma. |
7248 | ||
7249 | To test the POST method, you may enable full debugging with the -debug | |
7250 | pragma. This will allow you to feed newline-delimited name=value | |
7251 | pairs to the script on standard input. | |
54310121 | 7252 | |
7253 | When debugging, you can use quotes and backslashes to escape | |
7254 | characters in the familiar shell manner, letting you place | |
7255 | spaces and other funny characters in your parameter=value | |
7256 | pairs: | |
7257 | ||
7258 | your_script.pl "name1='I am a long value'" "name2=two\ words" | |
7259 | ||
2ed511ec RGS |
7260 | Finally, you can set the path info for the script by prefixing the first |
7261 | name/value parameter with the path followed by a question mark (?): | |
7262 | ||
7263 | your_script.pl /your/path/here?name1=value1&name2=value2 | |
7264 | ||
54310121 | 7265 | =head2 DUMPING OUT ALL THE NAME/VALUE PAIRS |
7266 | ||
3d1a2ec4 | 7267 | The Dump() method produces a string consisting of all the query's |
54310121 | 7268 | name/value pairs formatted nicely as a nested list. This is useful |
7269 | for debugging purposes: | |
7270 | ||
29ddc2a4 | 7271 | print Dump |
3cb6de81 | 7272 | |
54310121 | 7273 | |
7274 | Produces something that looks like: | |
7275 | ||
3acbd4f5 JH |
7276 | <ul> |
7277 | <li>name1 | |
7278 | <ul> | |
7279 | <li>value1 | |
7280 | <li>value2 | |
7281 | </ul> | |
7282 | <li>name2 | |
7283 | <ul> | |
7284 | <li>value1 | |
7285 | </ul> | |
7286 | </ul> | |
54310121 | 7287 | |
71f3e297 JH |
7288 | As a shortcut, you can interpolate the entire CGI object into a string |
7289 | and it will be replaced with the a nice HTML dump shown above: | |
54310121 | 7290 | |
7291 | $query=new CGI; | |
3acbd4f5 | 7292 | print "<h2>Current Values</h2> $query\n"; |
54310121 | 7293 | |
7294 | =head1 FETCHING ENVIRONMENT VARIABLES | |
7295 | ||
7296 | Some of the more useful environment variables can be fetched | |
7297 | through this interface. The methods are as follows: | |
7298 | ||
7299 | =over 4 | |
7300 | ||
71f3e297 JH |
7301 | =item B<Accept()> |
7302 | ||
7303 | Return a list of MIME types that the remote browser accepts. If you | |
7304 | give this method a single argument corresponding to a MIME type, as in | |
29ddc2a4 | 7305 | Accept('text/html'), it will return a floating point value |
71f3e297 JH |
7306 | corresponding to the browser's preference for this type from 0.0 |
7307 | (don't want) to 1.0. Glob types (e.g. text/*) in the browser's accept | |
7308 | list are handled correctly. | |
54310121 | 7309 | |
71f3e297 JH |
7310 | Note that the capitalization changed between version 2.43 and 2.44 in |
7311 | order to avoid conflict with Perl's accept() function. | |
54310121 | 7312 | |
7313 | =item B<raw_cookie()> | |
7314 | ||
424ec8fa | 7315 | Returns the HTTP_COOKIE variable, an HTTP extension implemented by |
71f3e297 JH |
7316 | Netscape browsers version 1.1 and higher, and all versions of Internet |
7317 | Explorer. Cookies have a special format, and this method call just | |
7318 | returns the raw form (?cookie dough). See cookie() for ways of | |
7319 | setting and retrieving cooked cookies. | |
424ec8fa GS |
7320 | |
7321 | Called with no parameters, raw_cookie() returns the packed cookie | |
7322 | structure. You can separate it into individual cookies by splitting | |
7323 | on the character sequence "; ". Called with the name of a cookie, | |
7324 | retrieves the B<unescaped> form of the cookie. You can use the | |
7325 | regular cookie() method to get the names, or use the raw_fetch() | |
7326 | method from the CGI::Cookie module. | |
54310121 | 7327 | |
7328 | =item B<user_agent()> | |
7329 | ||
7330 | Returns the HTTP_USER_AGENT variable. If you give | |
7331 | this method a single argument, it will attempt to | |
7332 | pattern match on it, allowing you to do something | |
29ddc2a4 | 7333 | like user_agent(netscape); |
54310121 | 7334 | |
7335 | =item B<path_info()> | |
7336 | ||
7337 | Returns additional path information from the script URL. | |
6b4ac661 | 7338 | E.G. fetching /cgi-bin/your_script/additional/stuff will result in |
29ddc2a4 | 7339 | path_info() returning "/additional/stuff". |
54310121 | 7340 | |
7341 | NOTE: The Microsoft Internet Information Server | |
7342 | is broken with respect to additional path information. If | |
7343 | you use the Perl DLL library, the IIS server will attempt to | |
7344 | execute the additional path information as a Perl script. | |
7345 | If you use the ordinary file associations mapping, the | |
7346 | path information will be present in the environment, | |
7347 | but incorrect. The best thing to do is to avoid using additional | |
7348 | path information in CGI scripts destined for use with IIS. | |
7349 | ||
7350 | =item B<path_translated()> | |
7351 | ||
7352 | As per path_info() but returns the additional | |
7353 | path information translated into a physical path, e.g. | |
7354 | "/usr/local/etc/httpd/htdocs/additional/stuff". | |
7355 | ||
7356 | The Microsoft IIS is broken with respect to the translated | |
7357 | path as well. | |
7358 | ||
7359 | =item B<remote_host()> | |
7360 | ||
7361 | Returns either the remote host name or IP address. | |
7362 | if the former is unavailable. | |
7363 | ||
7364 | =item B<script_name()> | |
7365 | Return the script name as a partial URL, for self-refering | |
7366 | scripts. | |
7367 | ||
7368 | =item B<referer()> | |
7369 | ||
7370 | Return the URL of the page the browser was viewing | |
7371 | prior to fetching your script. Not available for all | |
7372 | browsers. | |
7373 | ||
7374 | =item B<auth_type ()> | |
7375 | ||
7376 | Return the authorization/verification method in use for this | |
7377 | script, if any. | |
7378 | ||
7379 | =item B<server_name ()> | |
7380 | ||
7381 | Returns the name of the server, usually the machine's host | |
7382 | name. | |
7383 | ||
7384 | =item B<virtual_host ()> | |
7385 | ||
7386 | When using virtual hosts, returns the name of the host that | |
7387 | the browser attempted to contact | |
7388 | ||
03b9648d JH |
7389 | =item B<server_port ()> |
7390 | ||
7391 | Return the port that the server is listening on. | |
7392 | ||
2ed511ec RGS |
7393 | =item B<virtual_port ()> |
7394 | ||
7395 | Like server_port() except that it takes virtual hosts into account. | |
7396 | Use this when running with virtual hosts. | |
7397 | ||
54310121 | 7398 | =item B<server_software ()> |
7399 | ||
7400 | Returns the server software and version number. | |
7401 | ||
7402 | =item B<remote_user ()> | |
7403 | ||
7404 | Return the authorization/verification name used for user | |
7405 | verification, if this script is protected. | |
7406 | ||
7407 | =item B<user_name ()> | |
7408 | ||
71f3e297 JH |
7409 | Attempt to obtain the remote user's name, using a variety of different |
7410 | techniques. This only works with older browsers such as Mosaic. | |
7411 | Newer browsers do not report the user name for privacy reasons! | |
54310121 | 7412 | |
7413 | =item B<request_method()> | |
7414 | ||
7415 | Returns the method used to access your script, usually | |
7416 | one of 'POST', 'GET' or 'HEAD'. | |
7417 | ||
3538e1d5 GS |
7418 | =item B<content_type()> |
7419 | ||
7420 | Returns the content_type of data submitted in a POST, generally | |
7421 | multipart/form-data or application/x-www-form-urlencoded | |
7422 | ||
7423 | =item B<http()> | |
7424 | ||
7425 | Called with no arguments returns the list of HTTP environment | |
7426 | variables, including such things as HTTP_USER_AGENT, | |
7427 | HTTP_ACCEPT_LANGUAGE, and HTTP_ACCEPT_CHARSET, corresponding to the | |
7428 | like-named HTTP header fields in the request. Called with the name of | |
7429 | an HTTP header field, returns its value. Capitalization and the use | |
7430 | of hyphens versus underscores are not significant. | |
7431 | ||
7432 | For example, all three of these examples are equivalent: | |
7433 | ||
29ddc2a4 RGS |
7434 | $requested_language = http('Accept-language'); |
7435 | $requested_language = http('Accept_language'); | |
7436 | $requested_language = http('HTTP_ACCEPT_LANGUAGE'); | |
3538e1d5 GS |
7437 | |
7438 | =item B<https()> | |
7439 | ||
7440 | The same as I<http()>, but operates on the HTTPS environment variables | |
7441 | present when the SSL protocol is in effect. Can be used to determine | |
7442 | whether SSL is turned on. | |
7443 | ||
54310121 | 7444 | =back |
7445 | ||
424ec8fa | 7446 | =head1 USING NPH SCRIPTS |
54310121 | 7447 | |
424ec8fa GS |
7448 | NPH, or "no-parsed-header", scripts bypass the server completely by |
7449 | sending the complete HTTP header directly to the browser. This has | |
7450 | slight performance benefits, but is of most use for taking advantage | |
7451 | of HTTP extensions that are not directly supported by your server, | |
7452 | such as server push and PICS headers. | |
54310121 | 7453 | |
424ec8fa GS |
7454 | Servers use a variety of conventions for designating CGI scripts as |
7455 | NPH. Many Unix servers look at the beginning of the script's name for | |
7456 | the prefix "nph-". The Macintosh WebSTAR server and Microsoft's | |
7457 | Internet Information Server, in contrast, try to decide whether a | |
7458 | program is an NPH script by examining the first line of script output. | |
54310121 | 7459 | |
54310121 | 7460 | |
424ec8fa GS |
7461 | CGI.pm supports NPH scripts with a special NPH mode. When in this |
7462 | mode, CGI.pm will output the necessary extra header information when | |
7463 | the header() and redirect() methods are | |
7464 | called. | |
54310121 | 7465 | |
69c89ae7 JH |
7466 | The Microsoft Internet Information Server requires NPH mode. As of |
7467 | version 2.30, CGI.pm will automatically detect when the script is | |
7468 | running under IIS and put itself into this mode. You do not need to | |
7469 | do this manually, although it won't hurt anything if you do. However, | |
7470 | note that if you have applied Service Pack 6, much of the | |
7471 | functionality of NPH scripts, including the ability to redirect while | |
7472 | setting a cookie, b<do not work at all> on IIS without a special patch | |
7473 | from Microsoft. See | |
7474 | http://support.microsoft.com/support/kb/articles/Q280/3/41.ASP: | |
7475 | Non-Parsed Headers Stripped From CGI Applications That Have nph- | |
7476 | Prefix in Name. | |
54310121 | 7477 | |
424ec8fa | 7478 | =over 4 |
54310121 | 7479 | |
424ec8fa | 7480 | =item In the B<use> statement |
54310121 | 7481 | |
424ec8fa GS |
7482 | Simply add the "-nph" pragmato the list of symbols to be imported into |
7483 | your script: | |
54310121 | 7484 | |
424ec8fa | 7485 | use CGI qw(:standard -nph) |
54310121 | 7486 | |
424ec8fa | 7487 | =item By calling the B<nph()> method: |
54310121 | 7488 | |
424ec8fa | 7489 | Call B<nph()> with a non-zero parameter at any point after using CGI.pm in your program. |
54310121 | 7490 | |
424ec8fa | 7491 | CGI->nph(1) |
54310121 | 7492 | |
551e1d92 RB |
7493 | =item By using B<-nph> parameters |
7494 | ||
7495 | in the B<header()> and B<redirect()> statements: | |
54310121 | 7496 | |
29ddc2a4 | 7497 | print header(-nph=>1); |
54310121 | 7498 | |
424ec8fa | 7499 | =back |
54310121 | 7500 | |
424ec8fa GS |
7501 | =head1 Server Push |
7502 | ||
ba056755 | 7503 | CGI.pm provides four simple functions for producing multipart |
424ec8fa GS |
7504 | documents of the type needed to implement server push. These |
7505 | functions were graciously provided by Ed Jordan <ed@fidalgo.net>. To | |
7506 | import these into your namespace, you must import the ":push" set. | |
7507 | You are also advised to put the script into NPH mode and to set $| to | |
7508 | 1 to avoid buffering problems. | |
7509 | ||
7510 | Here is a simple script that demonstrates server push: | |
7511 | ||
7512 | #!/usr/local/bin/perl | |
7513 | use CGI qw/:push -nph/; | |
7514 | $| = 1; | |
ba056755 JH |
7515 | print multipart_init(-boundary=>'----here we go!'); |
7516 | foreach (0 .. 4) { | |
424ec8fa | 7517 | print multipart_start(-type=>'text/plain'), |
ba056755 JH |
7518 | "The current time is ",scalar(localtime),"\n"; |
7519 | if ($_ < 4) { | |
7520 | print multipart_end; | |
7521 | } else { | |
7522 | print multipart_final; | |
7523 | } | |
424ec8fa GS |
7524 | sleep 1; |
7525 | } | |
54310121 | 7526 | |
424ec8fa | 7527 | This script initializes server push by calling B<multipart_init()>. |
ba056755 JH |
7528 | It then enters a loop in which it begins a new multipart section by |
7529 | calling B<multipart_start()>, prints the current local time, | |
424ec8fa | 7530 | and ends a multipart section with B<multipart_end()>. It then sleeps |
ba056755 JH |
7531 | a second, and begins again. On the final iteration, it ends the |
7532 | multipart section with B<multipart_final()> rather than with | |
7533 | B<multipart_end()>. | |
54310121 | 7534 | |
424ec8fa | 7535 | =over 4 |
54310121 | 7536 | |
424ec8fa | 7537 | =item multipart_init() |
3cb6de81 | 7538 | |
424ec8fa | 7539 | multipart_init(-boundary=>$boundary); |
54310121 | 7540 | |
424ec8fa GS |
7541 | Initialize the multipart system. The -boundary argument specifies |
7542 | what MIME boundary string to use to separate parts of the document. | |
7543 | If not provided, CGI.pm chooses a reasonable boundary for you. | |
54310121 | 7544 | |
424ec8fa | 7545 | =item multipart_start() |
54310121 | 7546 | |
424ec8fa | 7547 | multipart_start(-type=>$type) |
54310121 | 7548 | |
424ec8fa GS |
7549 | Start a new part of the multipart document using the specified MIME |
7550 | type. If not specified, text/html is assumed. | |
54310121 | 7551 | |
424ec8fa | 7552 | =item multipart_end() |
54310121 | 7553 | |
424ec8fa | 7554 | multipart_end() |
54310121 | 7555 | |
424ec8fa | 7556 | End a part. You must remember to call multipart_end() once for each |
ba056755 JH |
7557 | multipart_start(), except at the end of the last part of the multipart |
7558 | document when multipart_final() should be called instead of multipart_end(). | |
7559 | ||
7560 | =item multipart_final() | |
7561 | ||
7562 | multipart_final() | |
7563 | ||
7564 | End all parts. You should call multipart_final() rather than | |
7565 | multipart_end() at the end of the last part of the multipart document. | |
54310121 | 7566 | |
424ec8fa | 7567 | =back |
54310121 | 7568 | |
424ec8fa GS |
7569 | Users interested in server push applications should also have a look |
7570 | at the CGI::Push module. | |
54310121 | 7571 | |
ba056755 JH |
7572 | Only Netscape Navigator supports server push. Internet Explorer |
7573 | browsers do not. | |
7574 | ||
424ec8fa | 7575 | =head1 Avoiding Denial of Service Attacks |
54310121 | 7576 | |
424ec8fa GS |
7577 | A potential problem with CGI.pm is that, by default, it attempts to |
7578 | process form POSTings no matter how large they are. A wily hacker | |
7579 | could attack your site by sending a CGI script a huge POST of many | |
7580 | megabytes. CGI.pm will attempt to read the entire POST into a | |
7581 | variable, growing hugely in size until it runs out of memory. While | |
7582 | the script attempts to allocate the memory the system may slow down | |
7583 | dramatically. This is a form of denial of service attack. | |
54310121 | 7584 | |
424ec8fa GS |
7585 | Another possible attack is for the remote user to force CGI.pm to |
7586 | accept a huge file upload. CGI.pm will accept the upload and store it | |
7587 | in a temporary directory even if your script doesn't expect to receive | |
7588 | an uploaded file. CGI.pm will delete the file automatically when it | |
7589 | terminates, but in the meantime the remote user may have filled up the | |
7590 | server's disk space, causing problems for other programs. | |
54310121 | 7591 | |
424ec8fa GS |
7592 | The best way to avoid denial of service attacks is to limit the amount |
7593 | of memory, CPU time and disk space that CGI scripts can use. Some Web | |
7594 | servers come with built-in facilities to accomplish this. In other | |
7595 | cases, you can use the shell I<limit> or I<ulimit> | |
7596 | commands to put ceilings on CGI resource usage. | |
54310121 | 7597 | |
54310121 | 7598 | |
424ec8fa GS |
7599 | CGI.pm also has some simple built-in protections against denial of |
7600 | service attacks, but you must activate them before you can use them. | |
7601 | These take the form of two global variables in the CGI name space: | |
54310121 | 7602 | |
424ec8fa | 7603 | =over 4 |
54310121 | 7604 | |
424ec8fa | 7605 | =item B<$CGI::POST_MAX> |
54310121 | 7606 | |
424ec8fa GS |
7607 | If set to a non-negative integer, this variable puts a ceiling |
7608 | on the size of POSTings, in bytes. If CGI.pm detects a POST | |
7609 | that is greater than the ceiling, it will immediately exit with an error | |
7610 | message. This value will affect both ordinary POSTs and | |
7611 | multipart POSTs, meaning that it limits the maximum size of file | |
7612 | uploads as well. You should set this to a reasonably high | |
7613 | value, such as 1 megabyte. | |
54310121 | 7614 | |
424ec8fa | 7615 | =item B<$CGI::DISABLE_UPLOADS> |
54310121 | 7616 | |
424ec8fa GS |
7617 | If set to a non-zero value, this will disable file uploads |
7618 | completely. Other fill-out form values will work as usual. | |
54310121 | 7619 | |
7620 | =back | |
7621 | ||
424ec8fa | 7622 | You can use these variables in either of two ways. |
54310121 | 7623 | |
424ec8fa | 7624 | =over 4 |
54310121 | 7625 | |
424ec8fa | 7626 | =item B<1. On a script-by-script basis> |
54310121 | 7627 | |
424ec8fa | 7628 | Set the variable at the top of the script, right after the "use" statement: |
54310121 | 7629 | |
424ec8fa GS |
7630 | use CGI qw/:standard/; |
7631 | use CGI::Carp 'fatalsToBrowser'; | |
7632 | $CGI::POST_MAX=1024 * 100; # max 100K posts | |
7633 | $CGI::DISABLE_UPLOADS = 1; # no uploads | |
54310121 | 7634 | |
424ec8fa | 7635 | =item B<2. Globally for all scripts> |
54310121 | 7636 | |
424ec8fa GS |
7637 | Open up CGI.pm, find the definitions for $POST_MAX and |
7638 | $DISABLE_UPLOADS, and set them to the desired values. You'll | |
7639 | find them towards the top of the file in a subroutine named | |
7640 | initialize_globals(). | |
54310121 | 7641 | |
424ec8fa | 7642 | =back |
54310121 | 7643 | |
3538e1d5 GS |
7644 | An attempt to send a POST larger than $POST_MAX bytes will cause |
7645 | I<param()> to return an empty CGI parameter list. You can test for | |
7646 | this event by checking I<cgi_error()>, either after you create the CGI | |
7647 | object or, if you are using the function-oriented interface, call | |
7648 | <param()> for the first time. If the POST was intercepted, then | |
7649 | cgi_error() will return the message "413 POST too large". | |
7650 | ||
7651 | This error message is actually defined by the HTTP protocol, and is | |
7652 | designed to be returned to the browser as the CGI script's status | |
7653 | code. For example: | |
7654 | ||
7655 | $uploaded_file = param('upload'); | |
7656 | if (!$uploaded_file && cgi_error()) { | |
7657 | print header(-status=>cgi_error()); | |
7658 | exit 0; | |
7659 | } | |
7660 | ||
7661 | However it isn't clear that any browser currently knows what to do | |
7662 | with this status code. It might be better just to create an | |
7663 | HTML page that warns the user of the problem. | |
54310121 | 7664 | |
424ec8fa | 7665 | =head1 COMPATIBILITY WITH CGI-LIB.PL |
54310121 | 7666 | |
3538e1d5 GS |
7667 | To make it easier to port existing programs that use cgi-lib.pl the |
7668 | compatibility routine "ReadParse" is provided. Porting is simple: | |
54310121 | 7669 | |
424ec8fa GS |
7670 | OLD VERSION |
7671 | require "cgi-lib.pl"; | |
7672 | &ReadParse; | |
7673 | print "The value of the antique is $in{antique}.\n"; | |
54310121 | 7674 | |
424ec8fa GS |
7675 | NEW VERSION |
7676 | use CGI; | |
5158e96b | 7677 | CGI::ReadParse(); |
424ec8fa | 7678 | print "The value of the antique is $in{antique}.\n"; |
54310121 | 7679 | |
424ec8fa GS |
7680 | CGI.pm's ReadParse() routine creates a tied variable named %in, |
7681 | which can be accessed to obtain the query variables. Like | |
7682 | ReadParse, you can also provide your own variable. Infrequently | |
7683 | used features of ReadParse, such as the creation of @in and $in | |
7684 | variables, are not supported. | |
54310121 | 7685 | |
424ec8fa GS |
7686 | Once you use ReadParse, you can retrieve the query object itself |
7687 | this way: | |
54310121 | 7688 | |
424ec8fa | 7689 | $q = $in{CGI}; |
29ddc2a4 | 7690 | print textfield(-name=>'wow', |
424ec8fa | 7691 | -value=>'does this really work?'); |
54310121 | 7692 | |
424ec8fa GS |
7693 | This allows you to start using the more interesting features |
7694 | of CGI.pm without rewriting your old scripts from scratch. | |
54310121 | 7695 | |
7696 | =head1 AUTHOR INFORMATION | |
7697 | ||
8c32f149 SP |
7698 | The GD.pm interface is copyright 1995-2007, Lincoln D. Stein. It is |
7699 | distributed under GPL and the Artistic License 2.0. | |
54310121 | 7700 | |
71f3e297 JH |
7701 | Address bug reports and comments to: lstein@cshl.org. When sending |
7702 | bug reports, please provide the version of CGI.pm, the version of | |
7703 | Perl, the name and version of your Web server, and the name and | |
7704 | version of the operating system you are using. If the problem is even | |
7705 | remotely browser dependent, please provide information about the | |
7706 | affected browers as well. | |
54310121 | 7707 | |
7708 | =head1 CREDITS | |
7709 | ||
7710 | Thanks very much to: | |
7711 | ||
7712 | =over 4 | |
7713 | ||
7714 | =item Matt Heffron (heffron@falstaff.css.beckman.com) | |
7715 | ||
7716 | =item James Taylor (james.taylor@srs.gov) | |
7717 | ||
7718 | =item Scott Anguish <sanguish@digifix.com> | |
7719 | ||
7720 | =item Mike Jewell (mlj3u@virginia.edu) | |
7721 | ||
7722 | =item Timothy Shimmin (tes@kbs.citri.edu.au) | |
7723 | ||
7724 | =item Joergen Haegg (jh@axis.se) | |
7725 | ||
71f3e297 | 7726 | =item Laurent Delfosse (delfosse@delfosse.com) |
54310121 | 7727 | |
7728 | =item Richard Resnick (applepi1@aol.com) | |
7729 | ||
7730 | =item Craig Bishop (csb@barwonwater.vic.gov.au) | |
7731 | ||
7732 | =item Tony Curtis (tc@vcpc.univie.ac.at) | |
7733 | ||
7734 | =item Tim Bunce (Tim.Bunce@ig.co.uk) | |
7735 | ||
7736 | =item Tom Christiansen (tchrist@convex.com) | |
7737 | ||
7738 | =item Andreas Koenig (k@franz.ww.TU-Berlin.DE) | |
7739 | ||
7740 | =item Tim MacKenzie (Tim.MacKenzie@fulcrum.com.au) | |
7741 | ||
7742 | =item Kevin B. Hendricks (kbhend@dogwood.tyler.wm.edu) | |
7743 | ||
7744 | =item Stephen Dahmen (joyfire@inxpress.net) | |
7745 | ||
7746 | =item Ed Jordan (ed@fidalgo.net) | |
7747 | ||
7748 | =item David Alan Pisoni (david@cnation.com) | |
7749 | ||
424ec8fa GS |
7750 | =item Doug MacEachern (dougm@opengroup.org) |
7751 | ||
7752 | =item Robin Houston (robin@oneworld.org) | |
7753 | ||
54310121 | 7754 | =item ...and many many more... |
7755 | ||
7756 | for suggestions and bug fixes. | |
7757 | ||
7758 | =back | |
7759 | ||
7760 | =head1 A COMPLETE EXAMPLE OF A SIMPLE FORM-BASED SCRIPT | |
7761 | ||
7762 | ||
7763 | #!/usr/local/bin/perl | |
3cb6de81 | 7764 | |
29ddc2a4 | 7765 | use CGI ':standard'; |
3cb6de81 | 7766 | |
29ddc2a4 RGS |
7767 | print header; |
7768 | print start_html("Example CGI.pm Form"); | |
3acbd4f5 | 7769 | print "<h1> Example CGI.pm Form</h1>\n"; |
29ddc2a4 RGS |
7770 | print_prompt(); |
7771 | do_work(); | |
7772 | print_tail(); | |
7773 | print end_html; | |
3cb6de81 | 7774 | |
54310121 | 7775 | sub print_prompt { |
29ddc2a4 | 7776 | print start_form; |
3acbd4f5 | 7777 | print "<em>What's your name?</em><br>"; |
29ddc2a4 RGS |
7778 | print textfield('name'); |
7779 | print checkbox('Not my real name'); | |
3cb6de81 | 7780 | |
3acbd4f5 | 7781 | print "<p><em>Where can you find English Sparrows?</em><br>"; |
29ddc2a4 | 7782 | print checkbox_group( |
54310121 | 7783 | -name=>'Sparrow locations', |
7784 | -values=>[England,France,Spain,Asia,Hoboken], | |
7785 | -linebreak=>'yes', | |
7786 | -defaults=>[England,Asia]); | |
3cb6de81 | 7787 | |
3acbd4f5 | 7788 | print "<p><em>How far can they fly?</em><br>", |
29ddc2a4 | 7789 | radio_group( |
54310121 | 7790 | -name=>'how far', |
7791 | -values=>['10 ft','1 mile','10 miles','real far'], | |
7792 | -default=>'1 mile'); | |
3cb6de81 | 7793 | |
3acbd4f5 | 7794 | print "<p><em>What's your favorite color?</em> "; |
29ddc2a4 | 7795 | print popup_menu(-name=>'Color', |
54310121 | 7796 | -values=>['black','brown','red','yellow'], |
7797 | -default=>'red'); | |
3cb6de81 | 7798 | |
29ddc2a4 | 7799 | print hidden('Reference','Monty Python and the Holy Grail'); |
3cb6de81 | 7800 | |
3acbd4f5 | 7801 | print "<p><em>What have you got there?</em><br>"; |
29ddc2a4 | 7802 | print scrolling_list( |
54310121 | 7803 | -name=>'possessions', |
7804 | -values=>['A Coconut','A Grail','An Icon', | |
7805 | 'A Sword','A Ticket'], | |
7806 | -size=>5, | |
7807 | -multiple=>'true'); | |
3cb6de81 | 7808 | |
3acbd4f5 | 7809 | print "<p><em>Any parting comments?</em><br>"; |
29ddc2a4 | 7810 | print textarea(-name=>'Comments', |
54310121 | 7811 | -rows=>10, |
7812 | -columns=>50); | |
3cb6de81 | 7813 | |
29ddc2a4 RGS |
7814 | print "<p>",reset; |
7815 | print submit('Action','Shout'); | |
7816 | print submit('Action','Scream'); | |
7817 | print endform; | |
3acbd4f5 | 7818 | print "<hr>\n"; |
54310121 | 7819 | } |
3cb6de81 | 7820 | |
54310121 | 7821 | sub do_work { |
54310121 | 7822 | my(@values,$key); |
7823 | ||
3acbd4f5 | 7824 | print "<h2>Here are the current settings in this form</h2>"; |
54310121 | 7825 | |
29ddc2a4 | 7826 | foreach $key (param) { |
3acbd4f5 | 7827 | print "<strong>$key</strong> -> "; |
29ddc2a4 | 7828 | @values = param($key); |
3acbd4f5 | 7829 | print join(", ",@values),"<br>\n"; |
54310121 | 7830 | } |
7831 | } | |
3cb6de81 | 7832 | |
54310121 | 7833 | sub print_tail { |
7834 | print <<END; | |
3acbd4f5 JH |
7835 | <hr> |
7836 | <address>Lincoln D. Stein</address><br> | |
7837 | <a href="/">Home Page</a> | |
54310121 | 7838 | END |
7839 | } | |
7840 | ||
7841 | =head1 BUGS | |
7842 | ||
188ba755 | 7843 | Please report them. |
54310121 | 7844 | |
7845 | =head1 SEE ALSO | |
7846 | ||
b2d0d414 | 7847 | L<CGI::Carp>, L<CGI::Fast>, L<CGI::Pretty> |
54310121 | 7848 | |
7849 | =cut | |
7850 |