From: Gurusamy Sarathy Date: Sun, 28 Jun 1998 16:33:32 +0000 (+0000) Subject: add CGI-2.42, its and testsuite X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=424ec8fa43885c75adde62690957af43a6537c02;p=p5sagit%2Fp5-mst-13.2.git add CGI-2.42, its and testsuite p4raw-id: //depot/perl@1223 --- diff --git a/MANIFEST b/MANIFEST index a97d60a..d343c6d 100644 --- a/MANIFEST +++ b/MANIFEST @@ -72,11 +72,13 @@ dump.c Debugging output eg/ADB An adb wrapper to put in your crash dir eg/README Intro to example perl scripts eg/cgi/RunMeFirst Setup script for CGI examples +eg/cgi/caution.xbm CGI example eg/cgi/clickable_image.cgi CGI example eg/cgi/cookie.cgi CGI example eg/cgi/crash.cgi CGI example eg/cgi/customize.cgi CGI example eg/cgi/diff_upload.cgi CGI example +eg/cgi/dna.small.gif.uu Small image for CGI examples eg/cgi/file_upload.cgi CGI example eg/cgi/frameset.cgi CGI example eg/cgi/index.html Index page for CGI examples @@ -85,6 +87,7 @@ eg/cgi/javascript.cgi CGI example eg/cgi/monty.cgi CGI example eg/cgi/multiple_forms.cgi CGI example eg/cgi/nph-clock.cgi CGI example +eg/cgi/nph-multipart.cgi CGI example eg/cgi/popup.cgi CGI example eg/cgi/save_state.cgi CGI example eg/cgi/tryit.cgi CGI example @@ -418,6 +421,7 @@ lib/Bundle/CPAN.pm The CPAN bundle lib/CGI.pm Web server interface ("Common Gateway Interface") lib/CGI/Apache.pm Support for Apache's Perl module lib/CGI/Carp.pm Log server errors with helpful context +lib/CGI/Cookie.pm Interface to Netscape Cookies lib/CGI/Fast.pm Support for FastCGI (persistent server process) lib/CGI/Push.pm Support for server push lib/CGI/Switch.pm Simple interface for multiple server types @@ -776,6 +780,10 @@ t/lib/autoloader.t See if AutoLoader works t/lib/basename.t See if File::Basename works t/lib/bigint.t See if bigint.pl works t/lib/bigintpm.t See if BigInt.pm works +t/lib/cgi-form.t See if CGI.pm works +t/lib/cgi-function.t See if CGI.pm works +t/lib/cgi-html.t See if CGI.pm works +t/lib/cgi-request.t See if CGI.pm works t/lib/checktree.t See if File::CheckTree works t/lib/complex.t See if Math::Complex works t/lib/db-btree.t See if DB_File works diff --git a/eg/cgi/RunMeFirst b/eg/cgi/RunMeFirst index c96d79e..018b11b 100755 --- a/eg/cgi/RunMeFirst +++ b/eg/cgi/RunMeFirst @@ -9,10 +9,17 @@ unless (-w $ww) { } # Decode the sample image. -for $bin (qw(wilogo.gif)) { - unless (open UU, "$bin.uu") { warn "Can't open $bin.uu: $!\n"; next } +for $uu (<*.uu>) { + unless (open UU, "<$uu") { warn "Can't open $uu: $!\n"; next } + while () { + chomp; + if (/^begin\s+\d+\s+(.+)$/) { + $bin = $1; + last; + } + } unless (open BIN, "> $bin") { warn "Can't create $bin: $!\n"; next } - $_ = ; + binmode BIN; while () { chomp; last if /^end/; @@ -24,6 +31,6 @@ for $bin (qw(wilogo.gif)) { # Create symlinks from *.txt to *.cgi for documentation purposes. foreach (<*.cgi>) { - ($target = $_) =~ s/cgi$/txt/; + ($target = $_) =~ s/cgi$/txt/i; symlink $_, $target unless -e $target; } diff --git a/eg/cgi/caution.xbm b/eg/cgi/caution.xbm new file mode 100644 index 0000000..87fcdbef --- /dev/null +++ b/eg/cgi/caution.xbm @@ -0,0 +1,12 @@ +#define caution_width 32 +#define caution_height 32 +static char caution_bits[] = { + 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0xe0,0x00,0x00,0x00,0x10,0x01, + 0x00,0x00,0x08,0x07,0x00,0x00,0x08,0x0e,0x00,0x00,0x04,0x0e,0x00,0x00,0x04, + 0x1c,0x00,0x00,0x02,0x1c,0x00,0x00,0xe2,0x38,0x00,0x00,0xf1,0x39,0x00,0x00, + 0xf1,0x71,0x00,0x80,0xf0,0x71,0x00,0x80,0xf0,0xe1,0x00,0x40,0xf0,0xe1,0x00, + 0x40,0xf0,0xc1,0x01,0x20,0xf0,0xc1,0x01,0x20,0xf0,0x81,0x03,0x10,0xe0,0x80, + 0x03,0x10,0xe0,0x00,0x07,0x08,0xe0,0x00,0x07,0x08,0xe0,0x00,0x0e,0x04,0x00, + 0x00,0x0e,0x04,0xe0,0x00,0x1c,0x02,0xf0,0x01,0x1c,0x02,0xf0,0x01,0x38,0x01, + 0xe0,0x00,0x38,0x01,0x00,0x00,0x70,0x01,0x00,0x00,0x70,0xff,0xff,0xff,0x7f, + 0xf8,0xff,0xff,0x3f,0x00,0x00,0x00,0x00}; diff --git a/eg/cgi/dna.small.gif.uu b/eg/cgi/dna.small.gif.uu new file mode 100644 index 0000000..d3ce24c --- /dev/null +++ b/eg/cgi/dna.small.gif.uu @@ -0,0 +1,63 @@ +begin 444 dna.small.gif +M1TE&.#=A)0`J`.<``+9%&Y@_&A$_5`Y#3$=2"=#59M((H88,GP\/]X^&+$R +M$"(79"DF33(93"$86=%;&"T4/=Y"&\\A$Q4Z4!`62*T4-Q4B9+X1*BH96SP? +M1<0D/3(F<-TM$!`=5:H.(!<64C$W?#8J3*`S(S<@3=8V%K$](QT.6Q`43AL4 +M1:$D,;<0,\X9&,8])\@=$A(U244S5U,D6Q=/#YH> +M08$I1B,09S$35R(:4C0?<19$75!()-;4702M`=;56)A`25,0K%"X< +M83`N>K`H'HDS*1`40,M&%!<@7M,_$AE+#%0>0S0/:4PJ9I,F-6DG420Y<"@09R,0 +M-V$R/R4M<:\H0!(H410Z:AT27&4Q9"L@;=1%(MA-$M5+#RL4+M8Z&AT<7[<: +M(-QA&2,36R$++B(84!0:5ALO:K$A.]X?&!$84V@;/SX<6Q`;2$(B2QD21W4J +M1=TW&@```````````````"P`````)0`J```(_@!]:(N'18\W%15T$1N'C)V? +M0_HH,<$G9YBX!C6<3;+T@AZ-)K@\O*"!KP^$>"KVA`L3*8P3)^5ZA)@B:AH+ +M9];F7.$Q+!`!0=*.%",&P7J"9XB82L5,48F5K,:" +M'94FU='6;!*R3T->E"%&95DR"`/6P,I0PDF)0SG8($$RJN0R`FI(H7$A2]VD +M*^^L_6(T3U*V%XH"_AB:HDS8H$AO5@R:P,8.I%^.:*AC(>Z!'":6RC`1L@W- +M%1Q/,%(.'5+1``/"*]=90`PD.F'3SR@-AG)`&_A=3'"**#[J(P<0^C0&S/#1""(ZI)'&*6,,$842N%Q!@3NK +M"R'%%4KP0D(Q?"`S!3)BVE(/$+)#-80 +M<+,`-[QH$LP+0_P!1C>=S("!,N>8XP<8H6131!B;3`#&#)"DTH(L5#P0S#W+ +MQ)*`$K1HHD4^;E!2QP%:B``&4H$,/Y2C$Y*(1%0(00A)@```77B"*$0@#3>P +MP&PU4`,^H!","P!!$')0P^H6((I5L"$'.;``';[Q!@-\PP"$0?)M$`<92!%OG8Q3#@(`U2C*)%9-!`&`K`!!EP0@80 +M2,0M;I$.:"C#"D.@P#UJ``]GT"*,K%B&*0+!@TFH8VV*0$(:_/`)?7@#'.'0 +M@R[H8``\:&`,=NC"*"B@!2TTHP5]N((TEH&`<)B"!PU`0RQ(P8MNS``9K6@% +M'W31AG%$(BZ2&((PA-&#'I"A&`F8!DD\\`H6-,.,X'B'%,+R#FX4`PS&_L!$ +M.4R0#7W<0@%O2,07$($#9@C3"%C8P!5H88\]J$,"-E!;(.X@C5T<`!65V,40 +M,'&(0C!"`1JP@"3TH`T9=&,5JRC$-]+1`U%TP@@[^,$>Z$&*0%1A%XFK`BFD +MX0L6Y"(#A_A$#[JPC@%\@1@02`(SJ#&&.`A@'\&$!AALX(4Y="`/TA"",UA! +M@%W<8!*\$`$@C%""+G1A"9AP!"<>9@ME*)$0F\C!$I8`B3\TP@%'@$(QH$`" +M)8@#'(B0ACB`P`,@%&,'9"##)S`1!&)\`0)^&,,^+$`("QC"#D\X!":HX0!< +ML(`&-O!%,&H@BS#F0AI'`!LO^"`,/OS!%KJ0_H0HEA`E27Q#%T%X0"%"@`1E +M2,`!:F!%+Q#A!G)40A!HP`4OFK`#-13#`?I(QCW38(Q/9&``%0#!);01BE>$ +M@!TZNL81$G`!-]2!&&5@A1N&T0Q<,$$$%*!``BR1A5$PPPH<74$%]*`#$.RA +M`(VP@#`X$(`7``(%T=@`.5Q`C@:0`P[)D$4'$H`."MB#"908Q=X@,01B9$(7 +MG'A%`#8!"QSL@PUAL,0==M"")CQCP4)0QQUDP806H&,!T]A!`EH@AC2P`P,^ +MT`,*NN%-&&T!&L@X!!Y^<(4.D(,%E>A`,T20C#IXL`6-:,`5F+"#!W"@'%OH +MA`IJ$5(#;`(;AV/'FA103(EV+(,>GHB&&ZJ`!D'P!57`X1F9D`4<0!]FB({'Content-Type'} || ''; print hr(), h2($file), - h3($tmpfile); + h3($tmpfile), + h4("MIME Type:",em($mimetype)); + my($lines,$words,$characters,@words) = (0,0,0,0); while (<$file>) { $lines++; @@ -52,6 +56,8 @@ if ($file = param('filename')) { } } +# print cite("URL parameters: "),url_param(); + print hr(), a({href=>"../cgi_docs.html"},"CGI documentation"), hr, diff --git a/eg/cgi/index.html b/eg/cgi/index.html index 9eafd5f..75e2d30 100644 --- a/eg/cgi/index.html +++ b/eg/cgi/index.html @@ -23,6 +23,12 @@
  • Look at its source code +

    Server Push

    + +

    Read the coordinates from a clickable image map

    Echo fatal script errors to the browser

    +This script deliberately generates a compile-time error. -

    Permanently customize the appearance of a page

    +

    Permanently customize the appearance of a page with a cookie

    • Try the script
    • Look at its source code @@ -100,12 +107,12 @@
    • CGI.pm documentation -
    • Download the CGI.pm distribution +
    • Download the CGI.pm distribution

    • Lincoln D. Stein, lstein@genome.wi.mit.edu
      Whitehead Institute/MIT Center for Genome Research
      -Last modified: Mon Dec 2 06:23:25 EST 1996 +Last modified: Tue May 19 22:16:43 EDT 1998 diff --git a/eg/cgi/monty.cgi b/eg/cgi/monty.cgi index b7c0f6a..693c258 100644 --- a/eg/cgi/monty.cgi +++ b/eg/cgi/monty.cgi @@ -1,6 +1,7 @@ #!/usr/local/bin/perl use CGI; +use CGI::Carp qw/fatalsToBrowser/; $query = new CGI; @@ -15,7 +16,7 @@ print $query->end_html; sub print_prompt { my($query) = @_; - print $query->start_multipart_form; + print $query->start_form; print "What's your name?
      "; print $query->textfield('name'); print $query->checkbox('Not my real name'); @@ -23,19 +24,19 @@ sub print_prompt { print "

      Where can you find English Sparrows?
      "; print $query->checkbox_group( -name=>'Sparrow locations', - -values=>[England,France,Spain,Asia,Hoboken], + -Values=>[England,France,Spain,Asia,Hoboken], -linebreak=>'yes', -defaults=>[England,Asia]); print "

      How far can they fly?
      ", $query->radio_group( -name=>'how far', - -values=>['10 ft','1 mile','10 miles','real far'], + -Values=>['10 ft','1 mile','10 miles','real far'], -default=>'1 mile'); print "

      What's your favorite color? "; print $query->popup_menu(-name=>'Color', - -values=>['black','brown','red','yellow'], + -Values=>['black','brown','red','yellow'], -default=>'red'); print $query->hidden('Reference','Monty Python and the Holy Grail'); @@ -43,7 +44,7 @@ sub print_prompt { print "

      What have you got there?
      "; print $query->scrolling_list( -name=>'possessions', - -values=>['A Coconut','A Grail','An Icon', + -Values=>['A Coconut','A Grail','An Icon', 'A Sword','A Ticket'], -size=>5, -multiple=>'true'); diff --git a/eg/cgi/nph-multipart.cgi b/eg/cgi/nph-multipart.cgi new file mode 100755 index 0000000..f8cea59 --- /dev/null +++ b/eg/cgi/nph-multipart.cgi @@ -0,0 +1,10 @@ +#!/usr/local/bin/perl +use CGI qw/:push -nph/; +$| = 1; +print multipart_init(-boundary=>'----------------here we go!'); +while (1) { + print multipart_start(-type=>'text/plain'), + "The current time is ",scalar(localtime),"\n", + multipart_end; + sleep 1; +} diff --git a/eg/cgi/save_state.cgi b/eg/cgi/save_state.cgi index be79051..85bacaf 100644 --- a/eg/cgi/save_state.cgi +++ b/eg/cgi/save_state.cgi @@ -12,7 +12,7 @@ print "

      Save and Restore Example

      \n"; $query = &restore_parameters($query) if $query->param('action') eq 'RESTORE'; # Here's where we create the form -print $query->startform; +print $query->start_multipart_form; print "Popup 1: ",$query->popup_menu('popup1',[qw{red green purple magenta orange chartreuse brown}]),"\n"; print "Popup 2: ",$query->popup_menu('popup2',[qw{lion tiger bear zebra potto wildebeest frog emu gazelle}]),"\n"; print "

      "; diff --git a/eg/cgi/wilogo.gif.uu b/eg/cgi/wilogo.gif.uu index a183bc0..c5d1042 100644 --- a/eg/cgi/wilogo.gif.uu +++ b/eg/cgi/wilogo.gif.uu @@ -1,4 +1,4 @@ -begin 644 wilogo.gif +begin 444 wilogo.gif M1TE&.#=A7@!$`(```'X2F?___RP`````7@!$```"_D2.J<#MKF)ZU,A3,[OO M(IUY']A%9"6AW$F)+#2]Y:BNLF6_\;WMH/D@8R.DZ-+*E0CQ:9JJ5JU!SQ MR&BU2D.;E*4'ER0TNY%G2A/Y.G[=VG%81+5K_UG$21-GQW55;$8L\RW6J8-9>QM7<^A/SMZK!ESY$,+ (KPA.EJ```#L` -` end diff --git a/lib/CGI.pm b/lib/CGI.pm index e53c957..22d91a4 100644 --- a/lib/CGI.pm +++ b/lib/CGI.pm @@ -1,5 +1,5 @@ package CGI; -require 5.001; +require 5.004; # See the bottom of this file for the POD documentation. Search for the # string '=head'. @@ -8,7 +8,7 @@ require 5.001; # documentation in manual or html file format (these utilities are part of the # Perl 5 distribution). -# Copyright 1995-1997 Lincoln D. Stein. All rights reserved. +# Copyright 1995-1998 Lincoln D. Stein. All rights reserved. # It may be used and modified freely, but I do request that this copyright # notice remain attached to the file. You may modify this module as you # wish, but if you redistribute a modified version, please attach a note @@ -18,39 +18,62 @@ require 5.001; # http://www.genome.wi.mit.edu/ftp/pub/software/WWW/cgi_docs.html # ftp://ftp-genome.wi.mit.edu/pub/software/WWW/ -# Set this to 1 to enable copious autoloader debugging messages -$AUTOLOAD_DEBUG=0; - -# Set this to 1 to enable NPH scripts -# or: -# 1) use CGI qw(:nph) -# 2) $CGI::nph(1) -# 3) print header(-nph=>1) -$NPH=0; - -# Set this to 1 to make the temporary files created -# during file uploads safe from prying eyes -# or do... -# 1) use CGI qw(:private_tempfiles) -# 2) $CGI::private_tempfiles(1); -$PRIVATE_TEMPFILES=0; - -$CGI::revision = '$Id: CGI.pm,v 2.36 1997/5/10 8:22 lstein Exp $'; -$CGI::VERSION='2.36'; - -# OVERRIDE THE OS HERE IF CGI.pm GUESSES WRONG -# $OS = 'UNIX'; -# $OS = 'MACINTOSH'; -# $OS = 'WINDOWS'; -# $OS = 'VMS'; -# $OS = 'OS2'; +$CGI::revision = '$Id: CGI.pm,v 1.32 1998/05/28 21:55:43 lstein Exp lstein $'; +$CGI::VERSION='2.42'; # HARD-CODED LOCATION FOR FILE UPLOAD TEMPORARY FILES. # UNCOMMENT THIS ONLY IF YOU KNOW WHAT YOU'RE DOING. # $TempFile::TMPDIRECTORY = '/usr/tmp'; +# >>>>> Here are some globals that you might want to adjust <<<<<< +sub initialize_globals { + # Set this to 1 to enable copious autoloader debugging messages + $AUTOLOAD_DEBUG = 0; + + # Change this to the preferred DTD to print in start_html() + # or use default_dtd('text of DTD to use'); + $DEFAULT_DTD = '-//IETF//DTD HTML//EN'; + + # Set this to 1 to enable NPH scripts + # or: + # 1) use CGI qw(-nph) + # 2) $CGI::nph(1) + # 3) print header(-nph=>1) + $NPH = 0; + + # Set this to 1 to disable debugging from the + # command line + $NO_DEBUG = 0; + + # Set this to 1 to make the temporary files created + # during file uploads safe from prying eyes + # or do... + # 1) use CGI qw(:private_tempfiles) + # 2) $CGI::private_tempfiles(1); + $PRIVATE_TEMPFILES = 0; + + # Set this to a positive value to limit the size of a POSTing + # to a certain number of bytes: + $POST_MAX = -1; + + # Change this to 1 to disable uploads entirely: + $DISABLE_UPLOADS = 0; + + # Other globals that you shouldn't worry about. + undef $Q; + $BEEN_THERE = 0; + undef @QUERY_PARAM; + undef %EXPORT; + + # prevent complaints by mod_perl + 1; +} + # ------------------ START OF THE LIBRARY ------------ +# make mod_perlhappy +initialize_globals(); + # FIGURE OUT THE OS WE'RE RUNNING UNDER # Some systems support the $^O variable. If not # available then require() the Config library @@ -64,7 +87,7 @@ if ($OS=~/Win/i) { $OS = 'WINDOWS'; } elsif ($OS=~/vms/i) { $OS = 'VMS'; -} elsif ($OS=~/Mac/i) { +} elsif ($OS=~/^MacOS$/i) { $OS = 'MACINTOSH'; } elsif ($OS=~/os2/i) { $OS = 'OS2'; @@ -77,77 +100,89 @@ $needs_binmode = $OS=~/^(WINDOWS|VMS|OS2)/; # This is the default class for the CGI object to use when all else fails. $DefaultClass = 'CGI' unless defined $CGI::DefaultClass; + # This is where to look for autoloaded routines. $AutoloadClass = $DefaultClass unless defined $CGI::AutoloadClass; # The path separator is a slash, backslash or semicolon, depending # on the paltform. $SL = { - UNIX=>'/', - OS2=>'\\', - WINDOWS=>'\\', - MACINTOSH=>':', - VMS=>'\\' + UNIX=>'/', OS2=>'\\', WINDOWS=>'\\', MACINTOSH=>':', VMS=>'/' }->{$OS}; +# This no longer seems to be necessary # Turn on NPH scripts by default when running under IIS server! -$NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/; +# $NPH++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/; +$IIS++ if defined($ENV{'SERVER_SOFTWARE'}) && $ENV{'SERVER_SOFTWARE'}=~/IIS/; # Turn on special checking for Doug MacEachern's modperl -if (defined($ENV{'GATEWAY_INTERFACE'}) && ($MOD_PERL = $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-Perl/)) { - $NPH++; +if (defined($ENV{'GATEWAY_INTERFACE'}) && + ($MOD_PERL = $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-Perl\//)) +{ $| = 1; - $SEQNO = 1; + require Apache; +} +# Turn on special checking for ActiveState's PerlEx +$PERLEX++ if defined($ENV{'GATEWAY_INTERFACE'}) && $ENV{'GATEWAY_INTERFACE'} =~ /^CGI-PerlEx/; + +# Define the CRLF sequence. I can't use a simple "\r\n" because the meaning +# of "\n" is different on different OS's (sometimes it generates CRLF, sometimes LF +# and sometimes CR). The most popular VMS web server +# doesn't accept CRLF -- instead it wants a LR. EBCDIC machines don't +# use ASCII, so \015\012 means something different. I find this all +# really annoying. +$EBCDIC = "\t" ne "\011"; +if ($OS eq 'VMS') { + $CRLF = "\n"; +} elsif ($EBCDIC) { + $CRLF= "\r\n"; +} else { + $CRLF = "\015\012"; } -# This is really "\r\n", but the meaning of \n is different -# in MacPerl, so we resort to octal here. -$CRLF = "\015\012"; - if ($needs_binmode) { $CGI::DefaultClass->binmode(main::STDOUT); $CGI::DefaultClass->binmode(main::STDIN); $CGI::DefaultClass->binmode(main::STDERR); } -# Cute feature, but it broke when the overload mechanism changed... -# %OVERLOAD = ('""'=>'as_string'); - %EXPORT_TAGS = ( - ':html2'=>[h1..h6,qw/p br hr ol ul li dl dt dd menu code var strong em - tt i b blockquote pre img a address cite samp dfn html head - base body link nextid title meta kbd start_html end_html - input Select option/], - ':html3'=>[qw/div table caption th td TR Tr super sub strike applet PARAM embed basefont style span/], - ':netscape'=>[qw/blink frameset frame script font fontsize center/], - ':form'=>[qw/textfield textarea filefield password_field hidden checkbox checkbox_group - submit reset defaults radio_group popup_menu button autoEscape - scrolling_list image_button start_form end_form startform endform - start_multipart_form isindex tmpFileName uploadInfo URL_ENCODED MULTIPART/], - ':cgi'=>[qw/param path_info path_translated url self_url script_name cookie dump - raw_cookie request_method query_string accept user_agent remote_host - remote_addr referer server_name server_software server_port server_protocol - virtual_host remote_ident auth_type http use_named_parameters - remote_user user_name header redirect import_names put/], - ':ssl' => [qw/https/], - ':cgi-lib' => [qw/ReadParse PrintHeader HtmlTop HtmlBot SplitParam/], - ':html' => [qw/:html2 :html3 :netscape/], - ':standard' => [qw/:html2 :form :cgi/], - ':all' => [qw/:html2 :html3 :netscape :form :cgi/] - ); + ':html2'=>['h1'..'h6',qw/p br hr ol ul li dl dt dd menu code var strong em + tt u i b blockquote pre img a address cite samp dfn html head + base body Link nextid title meta kbd start_html end_html + input Select option comment/], + ':html3'=>[qw/div table caption th td TR Tr sup sub strike applet Param + embed basefont style span layer ilayer font frameset frame script small big/], + ':netscape'=>[qw/blink fontsize center/], + ':form'=>[qw/textfield textarea filefield password_field hidden checkbox checkbox_group + submit reset defaults radio_group popup_menu button autoEscape + scrolling_list image_button start_form end_form startform endform + start_multipart_form isindex tmpFileName uploadInfo URL_ENCODED MULTIPART/], + ':cgi'=>[qw/param path_info path_translated url self_url script_name cookie dump + raw_cookie request_method query_string accept user_agent remote_host + remote_addr referer server_name server_software server_port server_protocol + virtual_host remote_ident auth_type http use_named_parameters + save_parameters restore_parameters param_fetch + remote_user user_name header redirect import_names put Delete Delete_all url_param/], + ':ssl' => [qw/https/], + ':cgi-lib' => [qw/ReadParse PrintHeader HtmlTop HtmlBot SplitParam/], + ':html' => [qw/:html2 :html3 :netscape/], + ':standard' => [qw/:html2 :html3 :form :cgi/], + ':push' => [qw/multipart_init multipart_start multipart_end/], + ':all' => [qw/:html2 :html3 :netscape :form :cgi :internal/] + ); # to import symbols into caller sub import { my $self = shift; + +# This causes modules to clash. +# undef %EXPORT_OK; +# undef %EXPORT; + + $self->_setup_symbols(@_); my ($callpack, $callfile, $callline) = caller; - foreach (@_) { - $NPH++, next if $_ eq ':nph'; - $PRIVATE_TEMPFILES++, next if $_ eq ':private_tempfiles'; - foreach (&expand_tags($_)) { - tr/a-zA-Z0-9_//cd; # don't allow weird function names - $EXPORT{$_}++; - } - } + # To allow overriding, search through the packages # Till we find one in which the correct subroutine is defined. my @packages = ($self,@{"$self\:\:ISA"}); @@ -164,6 +199,11 @@ sub import { } } +sub compile { + my $pack = shift; + $pack->_setup_symbols('-compile',@_); +} + sub expand_tags { my($tag) = @_; my(@r); @@ -182,8 +222,11 @@ sub new { my($class,$initializer) = @_; my $self = {}; bless $self,ref $class || $class || $DefaultClass; - $CGI::DefaultClass->_reset_globals() if $MOD_PERL; - $initializer = to_filehandle($initializer) if $initializer; + if ($MOD_PERL) { + Apache->request->register_cleanup(\&CGI::_reset_globals); + undef $NPH; + } + $self->_reset_globals if $PERLEX; $self->init($initializer); return $self; } @@ -234,94 +277,28 @@ sub param { return wantarray ? @{$self->{$name}} : $self->{$name}->[0]; } -#### Method: delete -# Deletes the named parameter entirely. -#### -sub delete { - my($self,$name) = self_or_default(@_); - delete $self->{$name}; - delete $self->{'.fieldnames'}->{$name}; - @{$self->{'.parameters'}}=grep($_ ne $name,$self->param()); - return wantarray ? () : undef; -} - sub self_or_default { - return @_ if defined($_[0]) && !ref($_[0]) && ($_[0] eq 'CGI'); + return @_ if defined($_[0]) && (!ref($_[0])) &&($_[0] eq 'CGI'); unless (defined($_[0]) && - ref($_[0]) && - (ref($_[0]) eq 'CGI' || - eval "\$_[0]->isaCGI()")) { # optimize for the common case - $CGI::DefaultClass->_reset_globals() - if defined($Q) && $MOD_PERL && $CGI::DefaultClass->_new_request(); + (ref($_[0]) eq 'CGI' || UNIVERSAL::isa($_[0],'CGI')) # slightly optimized for common case + ) { $Q = $CGI::DefaultClass->new unless defined($Q); unshift(@_,$Q); } return @_; } -sub _new_request { - return undef unless (defined(Apache->seqno()) or eval { require Apache }); - if (Apache->seqno() != $SEQNO) { - $SEQNO = Apache->seqno(); - return 1; - } else { - return undef; - } -} - -sub _reset_globals { - undef $Q; - undef @QUERY_PARAM; -} - sub self_or_CGI { local $^W=0; # prevent a warning if (defined($_[0]) && (substr(ref($_[0]),0,3) eq 'CGI' - || eval "\$_[0]->isaCGI()")) { + || UNIVERSAL::isa($_[0],'CGI'))) { return @_; } else { return ($DefaultClass,@_); } } -sub isaCGI { - return 1; -} - -#### Method: import_names -# Import all parameters into the given namespace. -# Assumes namespace 'Q' if not specified -#### -sub import_names { - my($self,$namespace) = self_or_default(@_); - $namespace = 'Q' unless defined($namespace); - die "Can't import names into 'main'\n" - if $namespace eq 'main'; - my($param,@value,$var); - foreach $param ($self->param) { - # protect against silly names - ($var = $param)=~tr/a-zA-Z0-9_/_/c; - $var = "${namespace}::$var"; - @value = $self->param($param); - @{$var} = @value; - ${$var} = $value[0]; - } -} - -#### Method: use_named_parameters -# Force CGI.pm to use named parameter-style method calls -# rather than positional parameters. The same effect -# will happen automatically if the first parameter -# begins with a -. -sub use_named_parameters { - my($self,$use_named) = self_or_default(@_); - return $self->{'.named'} unless defined ($use_named); - - # stupidity to avoid annoying warnings - return $self->{'.named'}=$use_named; -} - ######################################## # THESE METHODS ARE MORE OR LESS PRIVATE # GO TO THE __DATA__ SECTION TO SEE MORE @@ -337,14 +314,12 @@ sub use_named_parameters { sub init { my($self,$initializer) = @_; - my($query_string,@lines); - my($meth) = ''; + my($query_string,$meth,$content_length,$fh,@lines) = ('','','',''); # if we get called more than once, we want to initialize # ourselves from the original query (which may be gone # if it was read from STDIN originally.) if (defined(@QUERY_PARAM) && !defined($initializer)) { - foreach (@QUERY_PARAM) { $self->param('-name'=>$_,'-value'=>$QUERY_PARAM{$_}); } @@ -352,12 +327,32 @@ sub init { } $meth=$ENV{'REQUEST_METHOD'} if defined($ENV{'REQUEST_METHOD'}); + $content_length = defined($ENV{'CONTENT_LENGTH'}) ? $ENV{'CONTENT_LENGTH'} : 0; + die "Client attempted to POST $content_length bytes, but POSTs are limited to $POST_MAX" + if ($POST_MAX > 0) && ($content_length > $POST_MAX); + $fh = to_filehandle($initializer) if $initializer; - # If initializer is defined, then read parameters - # from it. METHOD: { - if (defined($initializer)) { + # Process multipart postings, but only if the initializer is + # not defined. + if ($meth eq 'POST' + && defined($ENV{'CONTENT_TYPE'}) + && $ENV{'CONTENT_TYPE'}=~m|^multipart/form-data| + && !defined($initializer) + ) { + my($boundary) = $ENV{'CONTENT_TYPE'} =~ /boundary=\"?([^\";]+)\"?/; + $self->read_multipart($boundary,$content_length); + last METHOD; + } + + # If initializer is defined, then read parameters + # from it. + if (defined($initializer)) { + if (UNIVERSAL::isa($initializer,'CGI')) { + $query_string = $initializer->query_string; + last METHOD; + } if (ref($initializer) && ref($initializer) eq 'HASH') { foreach (keys %$initializer) { $self->param('-name'=>$_,'-value'=>$initializer->{$_}); @@ -365,9 +360,8 @@ sub init { last METHOD; } - $initializer = $$initializer if ref($initializer); - if (defined(fileno($initializer))) { - while (<$initializer>) { + if (defined($fh) && ($fh ne '')) { + while (<$fh>) { chomp; last if /^=/; push(@lines,$_); @@ -380,49 +374,41 @@ sub init { } last METHOD; } + + # last chance -- treat it as a string + $initializer = $$initializer if ref($initializer) eq 'SCALAR'; $query_string = $initializer; + last METHOD; } - # If method is GET or HEAD, fetch the query from - # the environment. - if ($meth=~/^(GET|HEAD)$/) { - $query_string = $ENV{'QUERY_STRING'}; - last METHOD; - } - - # If the method is POST, fetch the query from standard - # input. - if ($meth eq 'POST') { - - if (defined($ENV{'CONTENT_TYPE'}) - && - $ENV{'CONTENT_TYPE'}=~m|^multipart/form-data|) { - my($boundary) = $ENV{'CONTENT_TYPE'}=~/boundary=(\S+)/; - $self->read_multipart($boundary,$ENV{'CONTENT_LENGTH'}); - } else { - - $self->read_from_client(\*STDIN,\$query_string,$ENV{'CONTENT_LENGTH'},0) - if $ENV{'CONTENT_LENGTH'} > 0; + # If method is GET or HEAD, fetch the query from + # the environment. + if ($meth=~/^(GET|HEAD)$/) { + $query_string = $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'}; + last METHOD; + } - } + if ($meth eq 'POST') { + $self->read_from_client(\*STDIN,\$query_string,$content_length,0) + if $content_length > 0; # Some people want to have their cake and eat it too! # Uncomment this line to have the contents of the query string # APPENDED to the POST data. - # $query_string .= ($query_string ? '&' : '') . $ENV{'QUERY_STRING'} if $ENV{'QUERY_STRING'}; + # $query_string .= (length($query_string) ? '&' : '') . $ENV{'QUERY_STRING'} if defined $ENV{'QUERY_STRING'}; last METHOD; } - - # If neither is set, assume we're being debugged offline. + + # If $meth is not of GET, POST or HEAD, assume we're being debugged offline. # Check the command line and then the standard input for data. # We use the shellwords package in order to behave the way that # UN*X programmers expect. - $query_string = &read_from_cmdline; + $query_string = read_from_cmdline() unless $NO_DEBUG; } - + # We now have the query string in hand. We do slightly # different things for keyword lists and parameter lists. - if ($query_string) { + if ($query_string ne '') { if ($query_string =~ /=/) { $self->parse_params($query_string); } else { @@ -447,39 +433,23 @@ sub init { $self->delete('.submit'); $self->delete('.cgifields'); $self->save_request unless $initializer; - } - # FUNCTIONS TO OVERRIDE: - # Turn a string into a filehandle sub to_filehandle { - my $string = shift; - if ($string && !ref($string)) { - my($package) = caller(1); - my($tmp) = $string=~/[':]/ ? $string : "$package\:\:$string"; - return $tmp if defined(fileno($tmp)); + my $thingy = shift; + return undef unless $thingy; + return $thingy if UNIVERSAL::isa($thingy,'GLOB'); + return $thingy if UNIVERSAL::isa($thingy,'FileHandle'); + if (!ref($thingy)) { + my $caller = 1; + while (my $package = caller($caller++)) { + my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy"; + return $tmp if defined(fileno($tmp)); + } } - return $string; -} - -# Create a new multipart buffer -sub new_MultipartBuffer { - my($self,$boundary,$length,$filehandle) = @_; - return MultipartBuffer->new($self,$boundary,$length,$filehandle); -} - -# Read data from a file handle -sub read_from_client { - my($self, $fh, $buff, $len, $offset) = @_; - local $^W=0; # prevent a warning - return read($fh, $$buff, $len, $offset); -} - -# put a filehandle into binary mode (DOS) -sub binmode { - binmode($_[1]); + return undef; } # send output to the browser @@ -496,7 +466,9 @@ sub print { # unescape URL-encoded data sub unescape { - my($todecode) = @_; + shift() if ref($_[0]); + my $todecode = shift; + return undef unless defined($todecode); $todecode =~ tr/+/ /; # pluses become spaces $todecode =~ s/%([0-9a-fA-F]{2})/pack("c",hex($1))/ge; return $todecode; @@ -504,8 +476,10 @@ sub unescape { # URL-encode data sub escape { - my($toencode) = @_; - $toencode=~s/([^a-zA-Z0-9_\-.])/uc sprintf("%%%02x",ord($1))/eg; + shift() if ref($_[0]) || $_[0] eq $DefaultClass; + my $toencode = shift; + return undef unless defined($toencode); + $toencode=~s/([^a-zA-Z0-9_.-])/uc sprintf("%%%02x",ord($1))/eg; return $toencode; } @@ -520,22 +494,14 @@ sub save_request { } } -sub parse_keywordlist { - my($self,$tosplit) = @_; - $tosplit = &unescape($tosplit); # unescape the keywords - $tosplit=~tr/+/ /; # pluses to spaces - my(@keywords) = split(/\s+/,$tosplit); - return @keywords; -} - sub parse_params { my($self,$tosplit) = @_; my(@pairs) = split('&',$tosplit); my($param,$value); foreach (@pairs) { - ($param,$value) = split('='); - $param = &unescape($param); - $value = &unescape($value); + ($param,$value) = split('=',$_,2); + $param = unescape($param); + $value = unescape($value); $self->add_parameter($param); push (@{$self->{$param}},$value); } @@ -554,46 +520,40 @@ sub all_parameters { return @{$self->{'.parameters'}}; } -#### Method as_string -# -# synonym for "dump" -#### -sub as_string { - &dump(@_); +# put a filehandle into binary mode (DOS) +sub binmode { + CORE::binmode($_[1]); +} + +sub _make_tag_func { + my $tagname = shift; + return qq{ + sub $tagname { + # handle various cases in which we're called + # most of this bizarre stuff is to avoid -w errors + shift if \$_[0] && + (!ref(\$_[0]) && \$_[0] eq \$CGI::DefaultClass) || + (ref(\$_[0]) && + (substr(ref(\$_[0]),0,3) eq 'CGI' || + UNIVERSAL::isa(\$_[0],'CGI'))); + + my(\$attr) = ''; + if (ref(\$_[0]) && ref(\$_[0]) eq 'HASH') { + my(\@attr) = make_attributes( '',shift() ); + \$attr = " \@attr" if \@attr; + } + my(\$tag,\$untag) = ("\U<$tagname\E\$attr>","\U\E"); + return \$tag unless \@_; + my \@result = map { "\$tag\$_\$untag" } (ref(\$_[0]) eq 'ARRAY') ? \@{\$_[0]} : "\@_"; + return "\@result"; + } +} } sub AUTOLOAD { print STDERR "CGI::AUTOLOAD for $AUTOLOAD\n" if $CGI::AUTOLOAD_DEBUG; - my($func) = $AUTOLOAD; - my($pack,$func_name) = $func=~/(.+)::([^:]+)$/; - $pack = ${"$pack\:\:AutoloadClass"} || $CGI::DefaultClass - unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"}); - - my($sub) = \%{"$pack\:\:SUBS"}; - unless (%$sub) { - my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"}; - eval "package $pack; $$auto"; - die $@ if $@; - } - my($code) = $sub->{$func_name}; - - $code = "sub $AUTOLOAD { }" if (!$code and $func_name eq 'DESTROY'); - if (!$code) { - if ($EXPORT{':any'} || - $EXPORT{$func_name} || - (%EXPORT_OK || grep(++$EXPORT_OK{$_},&expand_tags(':html'))) - && $EXPORT_OK{$func_name}) { - $code = $sub->{'HTML_FUNC'}; - $code=~s/func_name/$func_name/mg; - } - } - die "Undefined subroutine $AUTOLOAD\n" unless $code; - eval "package $pack; $code"; - if ($@) { - $@ =~ s/ at .*\n//; - die $@; - } - goto &{"$pack\:\:$func_name"}; + my $func = &_compile; + goto &$func; } # PRIVATE SUBROUTINE @@ -604,38 +564,110 @@ sub AUTOLOAD { sub rearrange { my($self,$order,@param) = @_; return () unless @param; - - return @param unless (defined($param[0]) && substr($param[0],0,1) eq '-') - || $self->use_named_parameters; - my $i; - for ($i=0;$i<@param;$i+=2) { - $param[$i]=~s/^\-//; # get rid of initial - if present - $param[$i]=~tr/a-z/A-Z/; # parameters are upper case + if (ref($param[0]) eq 'HASH') { + @param = %{$param[0]}; + } else { + return @param + unless (defined($param[0]) && substr($param[0],0,1) eq '-') + || $self->use_named_parameters; } - - my(%param) = @param; # convert into associative array - my(@return_array); - - my($key)=''; - foreach $key (@$order) { - my($value); - # this is an awful hack to fix spurious warnings when the - # -w switch is set. - if (ref($key) && ref($key) eq 'ARRAY') { - foreach (@$key) { - last if defined($value); - $value = $param{$_}; - delete $param{$_}; - } + + # map parameters into positional indices + my ($i,%pos); + $i = 0; + foreach (@$order) { + foreach (ref($_) eq 'ARRAY' ? @$_ : $_) { $pos{$_} = $i; } + $i++; + } + + my (@result,%leftover); + $#result = $#$order; # preextend + while (@param) { + my $key = uc(shift(@param)); + $key =~ s/^\-//; + if (exists $pos{$key}) { + $result[$pos{$key}] = shift(@param); } else { - $value = $param{$key}; - delete $param{$key}; + $leftover{$key} = shift(@param); + } + } + + push (@result,$self->make_attributes(\%leftover)) if %leftover; + @result; +} + +sub _compile { + my($func) = $AUTOLOAD; + my($pack,$func_name); + { + local($1,$2); # this fixes an obscure variable suicide problem. + $func=~/(.+)::([^:]+)$/; + ($pack,$func_name) = ($1,$2); + $pack=~s/::SUPER$//; # fix another obscure problem + $pack = ${"$pack\:\:AutoloadClass"} || $CGI::DefaultClass + unless defined(${"$pack\:\:AUTOLOADED_ROUTINES"}); + + my($sub) = \%{"$pack\:\:SUBS"}; + unless (%$sub) { + my($auto) = \${"$pack\:\:AUTOLOADED_ROUTINES"}; + eval "package $pack; $$auto"; + die $@ if $@; + $$auto = ''; # Free the unneeded storage (but don't undef it!!!) + } + my($code) = $sub->{$func_name}; + + $code = "sub $AUTOLOAD { }" if (!$code and $func_name eq 'DESTROY'); + if (!$code) { + if ($EXPORT{':any'} || + $EXPORT{'-any'} || + $EXPORT{$func_name} || + (%EXPORT_OK || grep(++$EXPORT_OK{$_},&expand_tags(':html'))) + && $EXPORT_OK{$func_name}) { + $code = _make_tag_func($func_name); + } + } + die "Undefined subroutine $AUTOLOAD\n" unless $code; + eval "package $pack; $code"; + if ($@) { + $@ =~ s/ at .*\n//; + die $@; + } + } + delete($sub->{$func_name}); #free storage + return "$pack\:\:$func_name"; +} + +sub _reset_globals { initialize_globals(); } + +sub _setup_symbols { + my $self = shift; + my $compile = 0; + foreach (@_) { + $NPH++, next if /^[:-]nph$/; + $NO_DEBUG++, next if /^[:-]no_?[Dd]ebug$/; + $PRIVATE_TEMPFILES++, next if /^[:-]private_tempfiles$/; + $EXPORT{$_}++, next if /^[:-]any$/; + $compile++, next if /^[:-]compile$/; + + # This is probably extremely evil code -- to be deleted + # some day. + if (/^[-]autoload$/) { + my($pkg) = caller(1); + *{"${pkg}::AUTOLOAD"} = sub { + my($routine) = $AUTOLOAD; + $routine =~ s/^.*::/CGI::/; + &$routine; + }; + next; + } + + foreach (&expand_tags($_)) { + tr/a-zA-Z0-9_//cd; # don't allow weird function names + $EXPORT{$_}++; } - push(@return_array,$value); } - push (@return_array,$self->make_attributes(\%param)) if %param; - return (@return_array); + _compile_all(keys %EXPORT) if $compile; } ############################################################################### @@ -654,32 +686,83 @@ END_OF_FUNC sub MULTIPART { 'multipart/form-data'; } END_OF_FUNC -'HTML_FUNC' => <<'END_OF_FUNC', -sub func_name { - - # handle various cases in which we're called - # most of this bizarre stuff is to avoid -w errors - shift if $_[0] && - (!ref($_[0]) && $_[0] eq $CGI::DefaultClass) || - (ref($_[0]) && - (substr(ref($_[0]),0,3) eq 'CGI' || - eval "\$_[0]->isaCGI()")); - - my($attr) = ''; - if (ref($_[0]) && ref($_[0]) eq 'HASH') { - my(@attr) = CGI::make_attributes('',shift); - $attr = " @attr" if @attr; - } - my($tag,$untag) = ("\U","\U\E"); - return $tag unless @_; - if (ref($_[0]) eq 'ARRAY') { - my(@r); - foreach (@{$_[0]}) { - push(@r,"$tag$_$untag"); +'SERVER_PUSH' => <<'END_OF_FUNC', +sub SERVER_PUSH { 'multipart/x-mixed-replace; boundary="' . shift() . '"'; } +END_OF_FUNC + +'use_named_parameters' => <<'END_OF_FUNC', +#### Method: use_named_parameters +# Force CGI.pm to use named parameter-style method calls +# rather than positional parameters. The same effect +# will happen automatically if the first parameter +# begins with a -. +sub use_named_parameters { + my($self,$use_named) = self_or_default(@_); + return $self->{'.named'} unless defined ($use_named); + + # stupidity to avoid annoying warnings + return $self->{'.named'}=$use_named; +} +END_OF_FUNC + +'new_MultipartBuffer' => <<'END_OF_FUNC', +# Create a new multipart buffer +sub new_MultipartBuffer { + my($self,$boundary,$length,$filehandle) = @_; + return MultipartBuffer->new($self,$boundary,$length,$filehandle); +} +END_OF_FUNC + +'read_from_client' => <<'END_OF_FUNC', +# Read data from a file handle +sub read_from_client { + my($self, $fh, $buff, $len, $offset) = @_; + local $^W=0; # prevent a warning + return undef unless defined($fh); + return read($fh, $$buff, $len, $offset); +} +END_OF_FUNC + +'delete' => <<'END_OF_FUNC', +#### Method: delete +# Deletes the named parameter entirely. +#### +sub delete { + my($self,$name) = self_or_default(@_); + delete $self->{$name}; + delete $self->{'.fieldnames'}->{$name}; + @{$self->{'.parameters'}}=grep($_ ne $name,$self->param()); + return wantarray ? () : undef; +} +END_OF_FUNC + +#### Method: import_names +# Import all parameters into the given namespace. +# Assumes namespace 'Q' if not specified +#### +'import_names' => <<'END_OF_FUNC', +sub import_names { + my($self,$namespace,$delete) = self_or_default(@_); + $namespace = 'Q' unless defined($namespace); + die "Can't import names into \"main\"\n" if \%{"${namespace}::"} == \%::; + if ($delete || $MOD_PERL) { + # can anyone find an easier way to do this? + foreach (keys %{"${namespace}::"}) { + local *symbol = "${namespace}::${_}"; + undef $symbol; + undef @symbol; + undef %symbol; } - return "@r"; - } else { - return "$tag@_$untag"; + } + my($param,@value,$var); + foreach $param ($self->param) { + # protect against silly names + ($var = $param)=~tr/a-zA-Z0-9_/_/c; + $var =~ s/^(?=\d)/_/; + local *symbol = "${namespace}::$var"; + @value = $self->param($param); + @symbol = @value; + $symbol = $value[0]; } } END_OF_FUNC @@ -693,8 +776,8 @@ END_OF_FUNC sub keywords { my($self,@values) = self_or_default(@_); # If values is provided, then we set it. - $self->{'keywords'}=[@values] if @values; - my(@result) = @{$self->{'keywords'}}; + $self->{'keywords'}=[@values] if defined(@values); + my(@result) = defined($self->{'keywords'}) ? @{$self->{'keywords'}} : (); @result; } END_OF_FUNC @@ -711,6 +794,7 @@ sub ReadParse { *in=*{"${pkg}::in"}; } tie(%in,CGI); + return scalar(keys %in); } END_OF_FUNC @@ -757,7 +841,7 @@ END_OF_FUNC 'TIEHASH' => <<'END_OF_FUNC', sub TIEHASH { - return new CGI; + return $Q || new CGI; } END_OF_FUNC @@ -833,6 +917,20 @@ sub delete_all { } EOF +'Delete' => <<'EOF', +sub Delete { + my($self,@p) = self_or_default(@_); + $self->delete(@p); +} +EOF + +'Delete_all' => <<'EOF', +sub Delete_all { + my($self,@p) = self_or_default(@_); + $self->delete_all(@p); +} +EOF + #### Method: autoescape # If you want to turn off the autoescaping features, # call this method with undef as the argument @@ -861,13 +959,44 @@ sub make_attributes { foreach (keys %{$attr}) { my($key) = $_; $key=~s/^\-//; # get rid of initial - if present - $key=~tr/a-z/A-Z/; # parameters are upper case - push(@att,$attr->{$_} ne '' ? qq/$key="$attr->{$_}"/ : qq/$key/); + $key=~tr/a-z_/A-Z-/; # parameters are upper case, use dashes + push(@att,defined($attr->{$_}) ? qq/$key="$attr->{$_}"/ : qq/$key/); } return @att; } END_OF_FUNC +#### Method: url_param +# Return a parameter in the QUERY_STRING, regardless of +# whether this was a POST or a GET +#### +'url_param' => <<'END_OF_FUNC', +sub url_param { + my ($self,@p) = self_or_default(@_); + my $name = shift(@p); + return undef unless exists($ENV{QUERY_STRING}); + unless (exists($self->{'.url_param'})) { + $self->{'.url_param'}={}; # empty hash + if ($ENV{QUERY_STRING} =~ /=/) { + my(@pairs) = split('&',$ENV{QUERY_STRING}); + my($param,$value); + foreach (@pairs) { + ($param,$value) = split('=',$_,2); + $param = unescape($param); + $value = unescape($value); + push(@{$self->{'.url_param'}->{$param}},$value); + } + } else { + $self->{'.url_param'}->{'keywords'} = [$self->parse_keywordlist($ENV{QUERY_STRING})]; + } + } + return keys %{$self->{'.url_param'}} unless defined($name); + return () unless $self->{'.url_param'}->{$name}; + return wantarray ? @{$self->{'.url_param'}->{$name}} + : $self->{'.url_param'}->{$name}->[0]; +} +END_OF_FUNC + #### Method: dump # Returns a string in which all the known parameter/value # pairs are represented as nested lists, mainly for the purposes @@ -894,21 +1023,28 @@ sub dump { } END_OF_FUNC - -#### Method: save -# Write values out to a filehandle in such a way that they can -# be reinitialized by the filehandle form of the new() method +#### Method as_string +# +# synonym for "dump" +#### +'as_string' => <<'END_OF_FUNC', +sub as_string { + &dump(@_); +} +END_OF_FUNC + +#### Method: save +# Write values out to a filehandle in such a way that they can +# be reinitialized by the filehandle form of the new() method #### 'save' => <<'END_OF_FUNC', sub save { my($self,$filehandle) = self_or_default(@_); - my($param); - my($package) = caller; -# Check that this still works! -# $filehandle = $filehandle=~/[':]/ ? $filehandle : "$package\:\:$filehandle"; $filehandle = to_filehandle($filehandle); + my($param); + local($,) = ''; # set print field separator back to a sane value foreach $param ($self->param) { - my($escaped_param) = &escape($param); + my($escaped_param) = escape($param); my($value); foreach $value ($self->param($param)) { print $filehandle "$escaped_param=",escape($value),"\n"; @@ -919,6 +1055,83 @@ sub save { END_OF_FUNC +#### Method: save_parameters +# An alias for save() that is a better name for exportation. +# Only intended to be used with the function (non-OO) interface. +#### +'save_parameters' => <<'END_OF_FUNC', +sub save_parameters { + my $fh = shift; + return save(to_filehandle($fh)); +} +END_OF_FUNC + +#### Method: restore_parameters +# A way to restore CGI parameters from an initializer. +# Only intended to be used with the function (non-OO) interface. +#### +'restore_parameters' => <<'END_OF_FUNC', +sub restore_parameters { + $Q = $CGI::DefaultClass->new(@_); +} +END_OF_FUNC + +#### Method: multipart_init +# Return a Content-Type: style header for server-push +# This has to be NPH, and it is advisable to set $| = 1 +# +# Many thanks to Ed Jordan for this +# contribution +#### +'multipart_init' => <<'END_OF_FUNC', +sub multipart_init { + my($self,@p) = self_or_default(@_); + my($boundary,@other) = $self->rearrange([BOUNDARY],@p); + $boundary = $boundary || '------- =_aaaaaaaaaa0'; + $self->{'separator'} = "\n--$boundary\n"; + $type = SERVER_PUSH($boundary); + return $self->header( + -nph => 1, + -type => $type, + (map { split "=", $_, 2 } @other), + ) . $self->multipart_end; +} +END_OF_FUNC + + +#### Method: multipart_start +# Return a Content-Type: style header for server-push, start of section +# +# Many thanks to Ed Jordan for this +# contribution +#### +'multipart_start' => <<'END_OF_FUNC', +sub multipart_start { + my($self,@p) = self_or_default(@_); + my($type,@other) = $self->rearrange([TYPE],@p); + $type = $type || 'text/html'; + return $self->header( + -type => $type, + (map { split "=", $_, 2 } @other), + ); +} +END_OF_FUNC + + +#### Method: multipart_end +# Return a Content-Type: style header for server-push, end of section +# +# Many thanks to Ed Jordan for this +# contribution +#### +'multipart_end' => <<'END_OF_FUNC', +sub multipart_end { + my($self,@p) = self_or_default(@_); + return $self->{'separator'}; +} +END_OF_FUNC + + #### Method: header # Return a Content-Type: style header # @@ -931,39 +1144,46 @@ sub header { my($type,$status,$cookie,$target,$expires,$nph,@other) = $self->rearrange([TYPE,STATUS,[COOKIE,COOKIES],TARGET,EXPIRES,NPH],@p); + $nph ||= $NPH; # rearrange() was designed for the HTML portion, so we # need to fix it up a little. foreach (@other) { - next unless my($header,$value) = /([^\s=]+)=(.+)/; - substr($header,1,1000)=~tr/A-Z/a-z/; - ($value)=$value=~/^"(.*)"$/; - $_ = "$header: $value"; + next unless my($header,$value) = /([^\s=]+)=\"?([^\"]+)\"?/; + ($_ = $header) =~ s/^(\w)(.*)/$1 . lc ($2) . ": $value"/e; } $type = $type || 'text/html'; - push(@header,'HTTP/1.0 ' . ($status || '200 OK')) if $nph || $NPH; + # Maybe future compatibility. Maybe not. + my $protocol = $ENV{SERVER_PROTOCOL} || 'HTTP/1.0'; + push(@header,$protocol . ' ' . ($status || '200 OK')) if $nph; + push(@header,"Status: $status") if $status; - push(@header,"Window-target: $target") if $target; + push(@header,"Window-Target: $target") if $target; # push all the cookies -- there may be several if ($cookie) { - my(@cookie) = ref($cookie) ? @{$cookie} : $cookie; + my(@cookie) = ref($cookie) && ref($cookie) eq 'ARRAY' ? @{$cookie} : $cookie; foreach (@cookie) { - push(@header,"Set-cookie: $_"); + push(@header,"Set-Cookie: " . (UNIVERSAL::isa($_,'CGI::Cookie') ? $_->as_string : $_)); } } # if the user indicates an expiration time, then we need # both an Expires and a Date header (so that the browser is # uses OUR clock) - push(@header,"Expires: " . &date(&expire_calc($expires),'http')) + push(@header,"Expires: " . expires($expires,'http')) if $expires; - push(@header,"Date: " . &date(&expire_calc(0),'http')) if $expires || $cookie; + push(@header,"Date: " . expires(0,'http')) if $expires || $cookie; push(@header,"Pragma: no-cache") if $self->cache(); push(@header,@other); - push(@header,"Content-type: $type"); + push(@header,"Content-Type: $type"); - my $header = join($CRLF,@header); - return $header . "${CRLF}${CRLF}"; + my $header = join($CRLF,@header)."${CRLF}${CRLF}"; + if ($MOD_PERL and not $nph) { + my $r = Apache->request; + $r->send_cgi_header($header); + return ''; + } + return $header; } END_OF_FUNC @@ -991,24 +1211,16 @@ END_OF_FUNC 'redirect' => <<'END_OF_FUNC', sub redirect { my($self,@p) = self_or_default(@_); - my($url,$target,$cookie,$nph,@other) = $self->rearrange([[URI,URL],TARGET,COOKIE,NPH],@p); + my($url,$target,$cookie,$nph,@other) = $self->rearrange([[LOCATION,URI,URL],TARGET,COOKIE,NPH],@p); $url = $url || $self->self_url; my(@o); - foreach (@other) { push(@o,split("=")); } - if($MOD_PERL or exists $self->{'.req'}) { - my $r = $self->{'.req'} || Apache->request; - $r->header_out(Location => $url); - $r->err_header_out(Location => $url); - $r->status(302); - return; - } - push(@o, - '-Status'=>'302 Found', + foreach (@other) { tr/\"//d; push(@o,split("=",$_,2)); } + unshift(@o, + '-Status'=>'302 Moved', '-Location'=>$url, - '-URI'=>$url, - '-nph'=>($nph||$NPH)); - push(@o,'-Target'=>$target) if $target; - push(@o,'-Cookie'=>$cookie) if $cookie; + '-nph'=>$nph); + unshift(@o,'-Target'=>$target) if $target; + unshift(@o,'-Cookie'=>$cookie) if $cookie; return $self->header(@o); } END_OF_FUNC @@ -1036,20 +1248,21 @@ END_OF_FUNC 'start_html' => <<'END_OF_FUNC', sub start_html { my($self,@p) = &self_or_default(@_); - my($title,$author,$base,$xbase,$script,$noscript,$target,$meta,$head,$style,@other) = - $self->rearrange([TITLE,AUTHOR,BASE,XBASE,SCRIPT,NOSCRIPT,TARGET,META,HEAD,STYLE],@p); + my($title,$author,$base,$xbase,$script,$noscript,$target,$meta,$head,$style,$dtd,@other) = + $self->rearrange([TITLE,AUTHOR,BASE,XBASE,SCRIPT,NOSCRIPT,TARGET,META,HEAD,STYLE,DTD],@p); # strangely enough, the title needs to be escaped as HTML # while the author needs to be escaped as a URL $title = $self->escapeHTML($title || 'Untitled Document'); - $author = $self->escapeHTML($author); + $author = $self->escape($author); my(@result); - push(@result,''); + $dtd = $DEFAULT_DTD unless $dtd && $dtd =~ m|^-//|; + push(@result,qq()) if $dtd; push(@result,"$title"); - push(@result,"") if $author; + push(@result,"") if defined $author; if ($base || $xbase || $target) { - my $href = $xbase || $self->url(); + my $href = $xbase || $self->url('-path'=>1); my $t = $target ? qq/ TARGET="$target"/ : ''; push(@result,qq//); } @@ -1060,29 +1273,60 @@ sub start_html { push(@result,ref($head) ? @$head : $head) if $head; - # handle various types of -style parameters - if ($style) { - if (ref($style)) { - my($src,$code,@other) = - $self->rearrange([SRC,CODE], - '-foo'=>'bar', # a trick to allow the '-' to be omitted - ref($style) eq 'ARRAY' ? @$style : %$style); - push(@result,qq//) if $src; - push(@result,style($code)) if $code; - } else { - push(@result,style($style)) - } + # handle the infrequently-used -style and -script parameters + push(@result,$self->_style($style)) if defined $style; + push(@result,$self->_script($script)) if defined $script; + + # handle -noscript parameter + push(@result,< +$noscript + +END + ; + my($other) = @other ? " @other" : ''; + push(@result,""); + return join("\n",@result); +} +END_OF_FUNC + +### Method: _style +# internal method for generating a CSS style section +#### +'_style' => <<'END_OF_FUNC', +sub _style { + my ($self,$style) = @_; + my (@result); + my $type = 'text/css'; + if (ref($style)) { + my($src,$code,$stype,@other) = + $self->rearrange([SRC,CODE,TYPE], + '-foo'=>'bar', # a trick to allow the '-' to be omitted + ref($style) eq 'ARRAY' ? @$style : %$style); + $type = $stype if $stype; + push(@result,qq//) if $src; + push(@result,style({'type'=>$type},"")) if $code; + } else { + push(@result,style({'type'=>$type},"")); } + @result; +} +END_OF_FUNC + - # handle -script parameter - if ($script) { +'_script' => <<'END_OF_FUNC', +sub _script { + my ($self,$script) = @_; + my (@result); + my (@scripts) = ref($script) eq 'ARRAY' ? @$script : ($script); + foreach $script (@scripts) { my($src,$code,$language); if (ref($script)) { # script is a hash ($src,$code,$language) = $self->rearrange([SRC,CODE,LANGUAGE], '-foo'=>'bar', # a trick to allow the '-' to be omitted ref($style) eq 'ARRAY' ? @$script : %$script); - + } else { ($src,$code,$language) = ('',$script,'JavaScript'); } @@ -1095,21 +1339,10 @@ sub start_html { if $code && $language=~/perl/i; push(@result,script({@satts},$code)); } - - # handle -noscript parameter - push(@result,< -$noscript - -END - ; - my($other) = @other ? " @other" : ''; - push(@result,""); - return join("\n",@result); + @result; } END_OF_FUNC - #### Method: end_html # End an HTML document. # Trivial method for completeness. Just returns "" @@ -1213,6 +1446,24 @@ sub end_form { END_OF_FUNC +'_textfield' => <<'END_OF_FUNC', +sub _textfield { + my($self,$tag,@p) = self_or_default(@_); + my($name,$default,$size,$maxlength,$override,@other) = + $self->rearrange([NAME,[DEFAULT,VALUE],SIZE,MAXLENGTH,[OVERRIDE,FORCE]],@p); + + my $current = $override ? $default : + (defined($self->param($name)) ? $self->param($name) : $default); + + $current = defined($current) ? $self->escapeHTML($current) : ''; + $name = defined($name) ? $self->escapeHTML($name) : ''; + my($s) = defined($size) ? qq/ SIZE=$size/ : ''; + my($m) = defined($maxlength) ? qq/ MAXLENGTH=$maxlength/ : ''; + my($other) = @other ? " @other" : ''; + return qq//; +} +END_OF_FUNC + #### Method: textfield # Parameters: # $name -> Name of the text field @@ -1226,18 +1477,7 @@ END_OF_FUNC 'textfield' => <<'END_OF_FUNC', sub textfield { my($self,@p) = self_or_default(@_); - my($name,$default,$size,$maxlength,$override,@other) = - $self->rearrange([NAME,[DEFAULT,VALUE],SIZE,MAXLENGTH,[OVERRIDE,FORCE]],@p); - - my $current = $override ? $default : - (defined($self->param($name)) ? $self->param($name) : $default); - - $current = defined($current) ? $self->escapeHTML($current) : ''; - $name = defined($name) ? $self->escapeHTML($name) : ''; - my($s) = defined($size) ? qq/ SIZE=$size/ : ''; - my($m) = defined($maxlength) ? qq/ MAXLENGTH=$maxlength/ : ''; - my($other) = @other ? " @other" : ''; - return qq//; + $self->_textfield('text',@p); } END_OF_FUNC @@ -1253,19 +1493,7 @@ END_OF_FUNC 'filefield' => <<'END_OF_FUNC', sub filefield { my($self,@p) = self_or_default(@_); - - my($name,$default,$size,$maxlength,$override,@other) = - $self->rearrange([NAME,[DEFAULT,VALUE],SIZE,MAXLENGTH,[OVERRIDE,FORCE]],@p); - - $current = $override ? $default : - (defined($self->param($name)) ? $self->param($name) : $default); - - $name = defined($name) ? $self->escapeHTML($name) : ''; - my($s) = defined($size) ? qq/ SIZE=$size/ : ''; - my($m) = defined($maxlength) ? qq/ MAXLENGTH=$maxlength/ : ''; - $current = defined($current) ? $self->escapeHTML($current) : ''; - $other = ' ' . join(" ",@other); - return qq//; + $self->_textfield('file',@p); } END_OF_FUNC @@ -1284,23 +1512,10 @@ END_OF_FUNC 'password_field' => <<'END_OF_FUNC', sub password_field { my ($self,@p) = self_or_default(@_); - - my($name,$default,$size,$maxlength,$override,@other) = - $self->rearrange([NAME,[DEFAULT,VALUE],SIZE,MAXLENGTH,[OVERRIDE,FORCE]],@p); - - my($current) = $override ? $default : - (defined($self->param($name)) ? $self->param($name) : $default); - - $name = defined($name) ? $self->escapeHTML($name) : ''; - $current = defined($current) ? $self->escapeHTML($current) : ''; - my($s) = defined($size) ? qq/ SIZE=$size/ : ''; - my($m) = defined($maxlength) ? qq/ MAXLENGTH=$maxlength/ : ''; - my($other) = @other ? " @other" : ''; - return qq//; + $self->_textfield('password',@p); } END_OF_FUNC - #### Method: textarea # Parameters: # $name -> Name of the text field @@ -1383,8 +1598,8 @@ sub submit { $value=$self->escapeHTML($value); my($name) = ' NAME=".submit"'; - $name = qq/ NAME="$label"/ if $label; - $value = $value || $label; + $name = qq/ NAME="$label"/ if defined($label); + $value = defined($value) ? $value : $label; my($val) = ''; $val = qq/ VALUE="$value"/ if defined($value); my($other) = @other ? " @other" : ''; @@ -1438,6 +1653,16 @@ sub defaults { END_OF_FUNC +#### Method: comment +# Create an HTML +# Parameters: a string +'comment' => <<'END_OF_FUNC', +sub comment { + my($self,@p) = self_or_CGI(@_); + return ""; +} +END_OF_FUNC + #### Method: checkbox # Create a checkbox that is not logically linked to any others. # The field value is "on" when the button is checked. @@ -1457,12 +1682,13 @@ sub checkbox { my($name,$checked,$value,$label,$override,@other) = $self->rearrange([NAME,[CHECKED,SELECTED,ON],VALUE,LABEL,[OVERRIDE,FORCE]],@p); - if (!$override && defined($self->param($name))) { - $value = $self->param($name) unless defined $value; - $checked = $self->param($name) eq $value ? ' CHECKED' : ''; + $value = defined $value ? $value : 'on'; + + if (!$override && ($self->{'.fieldnames'}->{$name} || + defined $self->param($name))) { + $checked = grep($_ eq $value,$self->param($name)) ? ' CHECKED' : ''; } else { $checked = $checked ? ' CHECKED' : ''; - $value = defined $value ? $value : 'on'; } my($the_label) = defined $label ? $label : $name; $name = $self->escapeHTML($name); @@ -1517,33 +1743,37 @@ sub checkbox_group { $name=$self->escapeHTML($name); # Create the elements - my(@elements); - my(@values) = $values ? @$values : $self->param($name); + my(@elements,@values); + + @values = $self->_set_values_and_labels($values,\$labels,$name); + my($other) = @other ? " @other" : ''; foreach (@values) { $checked = $checked{$_} ? ' CHECKED' : ''; $label = ''; unless (defined($nolabels) && $nolabels) { $label = $_; - $label = $labels->{$_} if defined($labels) && $labels->{$_}; + $label = $labels->{$_} if defined($labels) && defined($labels->{$_}); $label = $self->escapeHTML($label); } $_ = $self->escapeHTML($_); - push(@elements,qq/${label} ${break}/); + push(@elements,qq/${label}${break}/); } $self->register_parameter($name); - return wantarray ? @elements : join('',@elements) unless $columns; + return wantarray ? @elements : join(' ',@elements) + unless defined($columns) || defined($rows); return _tableize($rows,$columns,$rowheaders,$colheaders,@elements); } END_OF_FUNC - # Escape HTML -- used internally 'escapeHTML' => <<'END_OF_FUNC', sub escapeHTML { my($self,$toencode) = @_; + $toencode = $self unless ref($self); return undef unless defined($toencode); - return $toencode if $self->{'dontescape'}; + return $toencode if ref($self) && $self->{'dontescape'}; + $toencode=~s/&/&/g; $toencode=~s/\"/"/g; $toencode=~s/>/>/g; @@ -1552,6 +1782,20 @@ sub escapeHTML { } END_OF_FUNC +# unescape HTML -- used internally +'unescapeHTML' => <<'END_OF_FUNC', +sub unescapeHTML { + my $string = ref($_[0]) ? $_[1] : $_[0]; + return undef unless defined($string); + $string=~s/&/&/ig; + $string=~s/"/\"/ig; + $string=~s/>/>/ig; + $string=~s/</ <<'END_OF_FUNC', @@ -1559,20 +1803,27 @@ sub _tableize { my($rows,$columns,$rowheaders,$colheaders,@elements) = @_; my($result); - $rows = int(0.99 + @elements/$columns) unless $rows; + if (defined($columns)) { + $rows = int(0.99 + @elements/$columns) unless defined($rows); + } + if (defined($rows)) { + $columns = int(0.99 + @elements/$rows) unless defined($columns); + } + # rearrange into a pretty table $result = ""; my($row,$column); - unshift(@$colheaders,'') if @$colheaders && @$rowheaders; - $result .= "" if @{$colheaders}; + unshift(@$colheaders,'') if defined(@$colheaders) && defined(@$rowheaders); + $result .= "" if defined(@{$colheaders}); foreach (@{$colheaders}) { $result .= ""; } for ($row=0;$row<$rows;$row++) { $result .= ""; - $result .= "" if @$rowheaders; + $result .= "" if defined(@$rowheaders); for ($column=0;$column<$columns;$column++) { - $result .= ""; + $result .= "" + if defined($elements[$column*$rows + $row]); } $result .= ""; } @@ -1617,11 +1868,13 @@ sub radio_group { $checked = $default; } # If no check array is specified, check the first by default - $checked = $values->[0] unless $checked; + $checked = $values->[0] unless defined($checked) && $checked ne ''; $name=$self->escapeHTML($name); - my(@elements); - my(@values) = $values ? @$values : $self->param($name); + my(@elements,@values); + + @values = $self->_set_values_and_labels($values,\$labels,$name); + my($other) = @other ? " @other" : ''; foreach (@values) { my($checkit) = $checked eq $_ ? ' CHECKED' : ''; @@ -1629,14 +1882,15 @@ sub radio_group { my($label)=''; unless (defined($nolabels) && $nolabels) { $label = $_; - $label = $labels->{$_} if defined($labels) && $labels->{$_}; + $label = $labels->{$_} if defined($labels) && defined($labels->{$_}); $label = $self->escapeHTML($label); } $_=$self->escapeHTML($_); - push(@elements,qq/${label} ${break}/); + push(@elements,qq/${label}${break}/); } $self->register_parameter($name); - return wantarray ? @elements : join('',@elements) unless $columns; + return wantarray ? @elements : join(' ',@elements) + unless defined($columns) || defined($rows); return _tableize($rows,$columns,$rowheaders,$colheaders,@elements); } END_OF_FUNC @@ -1672,12 +1926,14 @@ sub popup_menu { $name=$self->escapeHTML($name); my($other) = @other ? " @other" : ''; - my(@values) = $values ? @$values : $self->param($name); + my(@values); + @values = $self->_set_values_and_labels($values,\$labels,$name); + $result = qq/
      $_
      $rowheaders->[$row]$rowheaders->[$row]" . $elements[$column*$rows + $row] . "" . $elements[$column*$rows + $row] . "
      , and ). -In versions of CGI.pm prior to 2.0, it could get difficult to remember -the proper order of arguments in CGI function calls that accepted five -or six different arguments. As of 2.0, there's a better way to pass -arguments to the various CGI functions. In this style, you pass a -series of name=>argument pairs, like this: +=item B<:netscape> - $field = $query->radio_group(-name=>'OS', - -values=>[Unix,Windows,Macintosh], - -default=>'Unix'); +Import all methods that generate Netscape-specific HTML extensions. -The advantages of this style are that you don't have to remember the -exact order of the arguments, and if you leave out a parameter, in -most cases it will default to some reasonable value. If you provide -a parameter that the method doesn't recognize, it will usually do -something useful with it, such as incorporating it into the HTML form -tag. For example if Netscape decides next week to add a new -JUSTIFICATION parameter to the text field tags, you can start using -the feature without waiting for a new version of CGI.pm: +=item B<:html> - $field = $query->textfield(-name=>'State', - -default=>'gaseous', - -justification=>'RIGHT'); +Import all HTML-generating shortcuts (i.e. 'html2' + 'html3' + +'netscape')... -This will result in an HTML tag that looks like this: +=item B<:standard> - +Import "standard" features, 'html2', 'html3', 'form' and 'cgi'. -Parameter names are case insensitive: you can use -name, or -Name or --NAME. You don't have to use the hyphen if you don't want to. After -creating a CGI object, call the B method with -a nonzero value. This will tell CGI.pm that you intend to use named -parameters exclusively: +=item B<:all> - $query = new CGI; - $query->use_named_parameters(1); - $field = $query->radio_group('name'=>'OS', - 'values'=>['Unix','Windows','Macintosh'], - 'default'=>'Unix'); +Import all the available methods. For the full list, see the CGI.pm +code, where the variable %TAGS is defined. + +=back + +If you import a function name that is not part of CGI.pm, the module +will treat it as a new HTML tag and generate the appropriate +subroutine. You can then use it like any other HTML tag. This is to +provide for the rapidly-evolving HTML "standard." For example, say +Microsoft comes out with a new tag called (which causes the +user's desktop to be flooded with a rotating gradient fill until his +machine reboots). You don't need to wait for a new version of CGI.pm +to start using it immeidately: + + use CGI qw/:standard :html3 gradient/; + print gradient({-start=>'red',-end=>'blue'}); + +Note that in the interests of execution speed CGI.pm does B use +the standard L syntax for specifying load symbols. This may +change in the future. + +If you import any of the state-maintaining CGI or form-generating +methods, a default CGI object will be created and initialized +automatically the first time you use any of the methods that require +one to be present. This includes B, B, +B and the like. (If you need direct access to the CGI +object, you can find it in the global variable B<$CGI::Q>). By +importing CGI.pm methods, you can create visually elegant scripts: + + use CGI qw/:standard/; + print + header, + start_html('Simple Script'), + h1('Simple Script'), + start_form, + "What's your name? ",textfield('name'),p, + "What's the combination?", + checkbox_group(-name=>'words', + -values=>['eenie','meenie','minie','moe'], + -defaults=>['eenie','moe']),p, + "What's your favorite color?", + popup_menu(-name=>'color', + -values=>['red','green','blue','chartreuse']),p, + submit, + end_form, + hr,"\n"; + + if (param) { + print + "Your name is ",em(param('name')),p, + "The keywords are: ",em(join(", ",param('words'))),p, + "Your favorite color is ",em(param('color')),".\n"; + } + print end_html; + +=head2 PRAGMAS + +In addition to the function sets, there are a number of pragmas that +you can import. Pragmas, which are always preceded by a hyphen, +change the way that CGI.pm functions in various ways. Pragmas, +function sets, and individual functions can all be imported in the +same use() line. For example, the following use statement imports the +standard set of functions and disables debugging mode (pragma +-no_debug): + + use CGI qw/:standard -no_debug/; + +The current list of pragmas is as follows: + +=over 4 + +=item -any + +When you I, then any method that the query object +doesn't recognize will be interpreted as a new HTML tag. This allows +you to support the next I Netscape or Microsoft HTML +extension. This lets you go wild with new and unsupported tags: + + use CGI qw(-any); + $q=new CGI; + print $q->gradient({speed=>'fast',start=>'red',end=>'blue'}); + +Since using any causes any mistyped method name +to be interpreted as an HTML tag, use it with care or not at +all. -Actually, CGI.pm only looks for a hyphen in the first parameter. So -you can leave it off subsequent parameters if you like. Something to -be wary of is the potential that a string constant like "values" will -collide with a keyword (and in fact it does!) While Perl usually -figures out when you're referring to a function and when you're -referring to a string, you probably should put quotation marks around -all string constants just to play it safe. +=item -compile -=head2 CREATING THE HTTP HEADER: +This causes the indicated autoloaded methods to be compiled up front, +rather than deferred to later. This is useful for scripts that run +for an extended period of time under FastCGI or mod_perl, and for +those destined to be crunched by Malcom Beattie's Perl compiler. Use +it in conjunction with the methods or method familes you plan to use. + + use CGI qw(-compile :standard :html3); + +or even + + use CGI qw(-compile :all); + +Note that using the -compile pragma in this way will always have +the effect of importing the compiled functions into the current +namespace. If you want to compile without importing use the +compile() method instead (see below). + +=item -nph + +This makes CGI.pm produce a header appropriate for an NPH (no +parsed header) script. You may need to do other things as well +to tell the server that the script is NPH. See the discussion +of NPH scripts below. + +=item -autoload + +This overrides the autoloader so that any function in your program +that is not recognized is referred to CGI.pm for possible evaluation. +This allows you to use all the CGI.pm functions without adding them to +your symbol table, which is of concern for mod_perl users who are +worried about memory consumption. I when +I<-autoload> is in effect, you cannot use "poetry mode" +(functions without the parenthesis). Use I rather +than I
      , or add something like I +to the top of your script. + +=item -no_debug + +This turns off the command-line processing features. If you want to +run a CGI.pm script from the command line to produce HTML, and you +don't want it pausing to request CGI parameters from standard input or +the command line, then use this pragma: + + use CGI qw(-no_debug :standard); + +If you'd like to process the command-line parameters but not standard +input, this should work: + + use CGI qw(-no_debug :standard); + restore_parameters(join('&',@ARGV)); + +See the section on debugging for more details. + +=item -private_tempfiles + +CGI.pm can process uploaded file. Ordinarily it spools the +uploaded file to a temporary directory, then deletes the file +when done. However, this opens the risk of eavesdropping as +described in the file upload section. +Another CGI script author could peek at this data during the +upload, even if it is confidential information. On Unix systems, +the -private_tempfiles pragma will cause the temporary file to be unlinked as soon +as it is opened and before any data is written into it, +eliminating the risk of eavesdropping. +n +=back + +=head1 GENERATING DYNAMIC DOCUMENTS + +Most of CGI.pm's functions deal with creating documents on the fly. +Generally you will produce the HTTP header first, followed by the +document itself. CGI.pm provides functions for generating HTTP +headers of various types as well as for generating HTML. For creating +GIF images, see the GD.pm module. + +Each of these functions produces a fragment of HTML or HTTP which you +can print out directly so that it displays in the browser window, +append to a string, or save to a file for later use. + +=head2 CREATING A STANDARD HTTP HEADER: + +Normally the first thing you will do in any CGI script is print out an +HTTP header. This tells the browser what type of document to expect, +and gives other optional information, such as the language, expiration +date, and whether to cache the document. The header can also be +manipulated for special purposes, such as server push and pay per view +pages. print $query->header; @@ -3184,16 +3906,16 @@ header() returns the Content-type: header. You can provide your own MIME type if you choose, otherwise it defaults to text/html. An optional second parameter specifies the status code and a human-readable message. For example, you can specify 204, "No response" to create a -script that tells the browser to do nothing at all. If you want to -add additional fields to the header, just tack them on to the end: - - print $query->header('text/html','200 OK','Content-Length: 3002'); +script that tells the browser to do nothing at all. The last example shows the named argument style for passing arguments to the CGI methods using named parameters. Recognized parameters are -B<-type>, B<-status>, B<-expires>, and B<-cookie>. Any other +B<-type>, B<-status>, B<-expires>, and B<-cookie>. Any other named parameters will be stripped of their initial hyphens and turned into header fields, allowing you to specify any HTTP header you desire. +Internal underscores will be turned into hyphens: + + print $query->header(-Content_length=>3002); Most browsers will not cache the output from CGI scripts. Every time the browser reloads the page, the script is invoked anew. You can @@ -3210,11 +3932,7 @@ indicated expiration date. The following forms are all valid for the now immediately +3M in three months +10y in ten years time - Thursday, 25-Apr-96 00:40:33 GMT at the indicated time & date - -(CGI::expires() is the static function call used internally that turns -relative time intervals into HTTP dates. You can call it directly if -you wish.) + Thursday, 25-Apr-1999 00:40:33 GMT at the indicated time & date The B<-cookie> parameter generates a header that tells the browser to provide a "magic cookie" during all subsequent transactions with your script. @@ -3227,14 +3945,19 @@ headers to work with a NPH (no-parse-header) script. This is important to use with certain servers, such as Microsoft Internet Explorer, which expect all their scripts to be NPH. -=head2 GENERATING A REDIRECTION INSTRUCTION +=head2 GENERATING A REDIRECTION HEADER print $query->redirect('http://somewhere.else/in/movie/land'); -redirects the browser elsewhere. If you use redirection like this, -you should B print out a header as well. As of version 2.0, we -produce both the unofficial Location: header and the official URI: -header. This should satisfy most servers and browsers. +Sometimes you don't want to produce a document yourself, but simply +redirect the browser elsewhere, perhaps choosing a URL based on the +time of day or the identity of the user. + +The redirect() function redirects the browser to a different URL. If +you use redirection like this, you should B print out a header as +well. As of version 2.0, we produce both the unofficial Location: +header and the official URI: header. This should satisfy most servers +and browsers. One hint I can offer is that relative links may not work correctly when you generate a redirection to another document on your site. @@ -3242,7 +3965,7 @@ This is due to a well-intentioned optimization that some servers use. The solution to this is to use the full URL (including the http: part) of the document you are redirecting to. -You can use named parameters: +You can also use named arguments: print $query->redirect(-uri=>'http://somewhere.else/in/movie/land', -nph=>1); @@ -3252,8 +3975,7 @@ headers to work with a NPH (no-parse-header) script. This is important to use with certain servers, such as Microsoft Internet Explorer, which expect all their scripts to be NPH. - -=head2 CREATING THE HTML HEADER: +=head2 CREATING THE HTML DOCUMENT HEADER print $query->start_html(-title=>'Secrets of the Pyramids', -author=>'fred@capricorn.org', @@ -3264,17 +3986,17 @@ expect all their scripts to be NPH. -style=>{'src'=>'/styles/style1.css'}, -BGCOLOR=>'blue'); - -or- - - print $query->start_html('Secrets of the Pyramids', - 'fred@capricorn.org','true', - 'BGCOLOR="blue"'); +After creating the HTTP header, most CGI scripts will start writing +out an HTML document. The start_html() routine creates the top of the +page, along with a lot of optional information that controls the +page's appearance and behavior. -This will return a canned HTML header and the opening tag. -All parameters are optional. In the named parameter form, recognized -parameters are -title, -author, -base, -xbase and -target (see below for the -explanation). Any additional parameters you provide, such as the -Netscape unofficial BGCOLOR attribute, are added to the tag. +This method returns a canned HTML header and the opening tag. +All parameters are optional. In the named parameter form, recognized +parameters are -title, -author, -base, -xbase and -target (see below +for the explanation). Any additional parameters you provide, such as +the Netscape unofficial BGCOLOR attribute, are added to the +tag. Additional parameters must be proceeded by a hyphen. The argument B<-xbase> allows you to provide an HREF for the tag different from the current location, as in @@ -3295,137 +4017,405 @@ argument. This argument expects a reference to an associative array containing name/value pairs of meta information. These will be turned into a series of header tags that look something like this: - - + + + +There is no support for the HTTP-EQUIV type of tag. This is +because you can modify the HTTP header directly with the B +method. For example, if you want to send the Refresh: header, do it +in the header() method: + + print $q->header(-Refresh=>'10; URL=http://www.capricorn.com'); + +The B<-style> tag is used to incorporate cascading stylesheets into +your code. See the section on CASCADING STYLESHEETS for more information. + +You can place other arbitrary HTML elements to the section with the +B<-head> tag. For example, to place the rarely-used element in the +head section, use this: + + print $q->start_html(-head=>Link({-rel=>'next', + -href=>'http://www.capricorn.com/s2.html'})); + +To incorporate multiple HTML elements into the section, just pass an +array reference: + + print $q->start_html(-head=>[ + Link({-rel=>'next', + -href=>'http://www.capricorn.com/s2.html'}), + Link({-rel=>'previous', + -href=>'http://www.capricorn.com/s1.html'}) + ] + ); + +JAVASCRIPTING: The B<-script>, B<-noScript>, B<-onLoad>, +B<-onMouseOver>, B<-onMouseOut> and B<-onUnload> parameters are used +to add Netscape JavaScript calls to your pages. B<-script> should +point to a block of text containing JavaScript function definitions. +This block will be placed within a