X-Git-Url: http://git.shiar.net/perl/plp/.git/blobdiff_plain/956a50913196bbb7bb8db7d53ccd07c198cac5bc..abb75f21cf3b32cb4989a4058729071ac6f0fc7c:/PLP.pm diff --git a/PLP.pm b/PLP.pm index 3e5baf5..10747fd 100644 --- a/PLP.pm +++ b/PLP.pm @@ -1,6 +1,6 @@ package PLP; -use v5.6; +use 5.006; use PLP::Functions (); use PLP::Fields; @@ -8,103 +8,96 @@ use PLP::Tie::Headers; use PLP::Tie::Delay; use PLP::Tie::Print; +use File::Basename (); +use File::Spec; +#use Cwd (); + use strict; -our $VERSION = '3.11'; +our $VERSION = '3.19'; -# subs in this package: -# sendheaders Send headers -# source($path, $level, $linespec) Read and parse .plp files -# error($error, $type) Handle errors +# Subs in this package: # _default_error($plain, $html) Default error handler -# clean Reset variables # cgi_init Initialization for CGI -# mod_perl_init($r) Initialization for mod_perl -# start Start the initialized PLP script +# clean Reset variables +# error($error, $type) Handle errors # everything Do everything: CGI # handler($r) Do everything: mod_perl +# mod_perl_init($r) Initialization for mod_perl +# mod_perl_print Faster printing for mod_perl +# sendheaders Send headers +# source($path, $level, $linespec) Read and parse .plp files +# start Start the initialized PLP script +# The _init subs do the following: +# Set $PLP::code to the initial code +# Set $ENV{PLP_*} and makes PATH_INFO if needed +# Change the CWD -# Sends the headers waiting in %PLP::Script::header -sub sendheaders () { - our $sentheaders = 1; - print STDOUT "Content-Type: text/plain\n\n" if $PLP::DEBUG & 2; - print STDOUT map("$_: $PLP::Script::header{$_}\n", keys %PLP::Script::header), "\n"; -}; - -# Given a filename and optional level (level should be 0 if the caller isn't -# source() itself), and optional linespec (used by PLP::Functions::Include), -# this function parses a PLP file and returns Perl code, ready to be eval'ed -sub source { - my ($path, $level, $linespec) = @_; - $level = 0 if not defined $level; - $linespec = '1' if not defined $linespec; - - our ($inA, $inB); - - (my $file = $path) =~ s[.*/][]; - - my $source = $level - ? qq/\cQ;\n#line 1 "$file"\nprint q\cQ/ - : qq/\n#line 1 "$file"\nprint q\cQ/; - my $linenr = 0; - - local *SOURCE; - open SOURCE, '<', $path or return $level - ? qq{\cQ; die qq[Can't open "\Q$path\E" (\Q$!\E)]; print q\cQ} - : qq{\n#line $linespec\ndie qq[Can't open "\Q$path\E" (\Q$!\E)];}; +# This gets referenced as the initial $PLP::ERROR +sub _default_error { + my ($plain, $html) = @_; + print qq{
}, + qq{Debug information:
$html
}; +} + +# CGI initializer: parses PATH_TRANSLATED +sub cgi_init { + + $PLP::print = 'print'; - LINE: - while (defined (my $line = )) { - $linenr++; - for (;;) { - $line =~ / - \G # Begin where left off - ( \z # End - | <:=? | :> # PLP tags <:= ... :> <: ... :> - | <\(.*?\)> # Include tags <(...)> - | <[^:(][^<:]* # Normal text - | :[^>][^<:]* # Normal text - | [^<:]* # Normal text - ) - /gxs; - next LINE unless length $1; - my $part = $1; - if ($part eq '<:=' and not $inA || $inB) { - $inA = 1; - $source .= "\cQ, "; - } elsif ($part eq '<:' and not $inA || $inB) { - $inB = 1; - $source .= "\cQ; "; - } elsif ($part eq ':>' and $inA) { - $inA = 0; - $source .= ", q\cQ"; - } elsif ($part eq ':>' and $inB) { - $inB = 0; - $source .= "; print q\cQ"; - } elsif ($part =~ /^<\((.*?)\)>\z/ and not $inA || $inB) { - $source .= source($1, $level + 1) . - qq/\cQ, \n#line $linenr "$file"\nq\cQ/; - } else { - $part =~ s/\\/\\\\/ if not $inA || $inB; - $source .= $part; - } + my $path = $ENV{PATH_TRANSLATED}; + $ENV{PLP_NAME} = $ENV{PATH_INFO}; + my $path_info; + while (not -f $path) { + if (not $path =~ s/(\/+[^\/]*)$//) { + print STDERR "PLP: Not found: $ENV{PATH_TRANSLATED} ($ENV{REQUEST_URI})\n"; + PLP::error(undef, 404); + exit; } + my $pi = $1; + $ENV{PLP_NAME} =~ s/\Q$pi\E$//; + $path_info = $pi . $path_info; + } + + if (not -r $path) { + print STDERR "PLP: Can't read: $ENV{PATH_TRANSLATED} ($ENV{REQUEST_URI})\n"; + PLP::error(undef, 403); + exit; } - $source .= "\cQ" unless $level; - return $source; + delete @ENV{ + qw(PATH_TRANSLATED SCRIPT_NAME SCRIPT_FILENAME PATH_INFO), + grep /^REDIRECT_/, keys %ENV + }; + + $ENV{PATH_INFO} = $path_info if defined $path_info; + $ENV{PLP_FILENAME} = $path; + my ($file, $dir) = File::Basename::fileparse($path); + chdir $dir; + + $PLP::code = PLP::source($file, 0, undef, $path); } -# Handles errors, uses the sub reference $PLP::ERROR that gets two arguments: -# the error message in plain text, and the error message with html entities +# This cleans up from previous requests, and sets the default $PLP::DEBUG +sub clean { + @PLP::END = (); + $PLP::code = ''; + $PLP::sentheaders = 0; + $PLP::DEBUG = 1; + $PLP::print = ''; + $PLP::r = undef; + delete @ENV{ grep /^PLP_/, keys %ENV }; +} + +# Handles errors, uses subref $PLP::ERROR (default: \&_default_error) sub error { my ($error, $type) = @_; if (not defined $type or $type < 100) { return undef unless $PLP::DEBUG & 1; my $plain = $error; (my $html = $plain) =~ s/([<&>])/'&#' . ord($1) . ';'/ge; - PLP::sendheaders unless $PLP::sentheaders; + PLP::sendheaders() unless $PLP::sentheaders; $PLP::ERROR->($plain, $html); } else { select STDOUT; @@ -112,84 +105,48 @@ sub error { +{ 404 => [ 'Not Found', - "The requested URL $ENV{REQUEST_URI} was not found on this server." + "The requested URL $ENV{REQUEST_URI} was not found " . + "on this server." ], 403 => [ 'Forbidden', - "You don't have permission to access $ENV{REQUEST_URI} on this server." + "You don't have permission to access $ENV{REQUEST_URI} " . + "on this server." ], }->{$type} }; print "Status: $type\nContent-Type: text/html\n\n", - qq{\n}, - "\n--$type $short\n\n", - "

$short

\n$long

\n

\n$ENV{SERVER_SIGNATURE}"; + qq{\n}, + "\n$type $short\n\n

$short", + "

\n$long

\n

\n$ENV{SERVER_SIGNATURE}"; } } -# This gets referenced as the initial $PLP::ERROR -sub _default_error { - my ($plain, $html) = @_; - print qq{
}, - qq{Debug information:
$html
}; -} - -# This cleans up from previous requests, and sets the default $PLP::DEBUG -sub clean { - @PLP::END = (); - $PLP::code = ''; - $PLP::sentheaders = 0; - $PLP::inA = 0; - $PLP::inB = 0; - $PLP::DEBUG = 1; - delete @ENV{ grep /^PLP_/, keys %ENV }; +# This is run by the CGI script. (#!perl \n use PLP; PLP::everything;) +sub everything { + clean(); + cgi_init(); + start(); } -# The *_init subs do the following: -# o Set $PLP::code to the initial code -# o Set $ENV{PLP_*} and makes PATH_INFO if needed -# o Change the CWD - -# This sub is meant for CGI requests only, and takes apart PATH_TRANSLATED -# to find the file. -sub cgi_init { - my $file = defined $_[0] ? $_[0] : $ENV{PATH_TRANSLATED}; - $ENV{PLP_NAME} = $ENV{PATH_INFO}; - my $path_info; - while (not -f $file) { - if (not $file =~ s/(\/+[^\/]*)$//) { - print STDERR "PLP: Not found: $ENV{PATH_TRANSLATED} ($ENV{REQUEST_URI})\n"; - PLP::error(undef, 404); - exit; - } - my $pi = $1; - $ENV{PLP_NAME} =~ s/\Q$pi\E$//; - $path_info = $pi . $path_info; - } - - if (not -r $file) { - print STDERR "PLP: Can't read: $ENV{PATH_TRANSLATED} ($ENV{REQUEST_URI})\n"; - PLP::error(undef, 403); - exit; +# This is the mod_perl handler. +sub handler { + require Apache::Constants; + clean(); + if (my $ret = mod_perl_init($_[0])) { + return $ret; } - - delete @ENV{ - qw(PATH_TRANSLATED SCRIPT_NAME SCRIPT_FILENAME PATH_INFO), - grep { /^REDIRECT_/ } keys %ENV - }; - - $ENV{PATH_INFO} = $path_info if defined $path_info; - $ENV{PLP_FILENAME} = $file; - (my $dir = $file) =~ s{/[^/]+$}[]; - chdir $dir; - - $PLP::code = PLP::source($file, 0); + #S start($_[0]); + start(); + no strict 'subs'; + return Apache::Constants::OK(); } -# This is the mod_perl initializer. -# Returns 0 on success. +# mod_perl initializer: returns 0 on success, Apache error code on failure sub mod_perl_init { - my $r = shift; + our $r = shift; + + $PLP::print = 'PLP::mod_perl_print'; $ENV{PLP_FILENAME} = my $filename = $r->filename; @@ -200,16 +157,156 @@ sub mod_perl_init { return Apache::Constants::FORBIDDEN(); } - (my $dir) = $filename =~ m!(.*)/!s; - chdir $dir; $ENV{PLP_NAME} = $r->uri; - $PLP::code = PLP::source($r->filename); + + our $use_cache = $r->dir_config('PLPcache') !~ /^off$/i; +#S our $use_safe = $r->dir_config('PLPsafe') =~ /^on$/i; + my $path = $r->filename(); + my ($file, $dir) = File::Basename::fileparse($path); + chdir $dir; + + $PLP::code = PLP::source($file, 0, undef, $path); return 0; # OK } -# Let the games begin! -# No lexicals may exist at this point. +# FAST printing under mod_perl +sub mod_perl_print { + return unless grep length, @_; + PLP::sendheaders() unless $PLP::sentheaders; + $PLP::r->print(@_); +} + +# Sends the headers waiting in %PLP::Script::header +sub sendheaders () { + $PLP::sentheaders ||= [ caller 1 ? (caller 1)[1, 2] : (caller)[1, 2] ]; + print STDOUT "Content-Type: text/plain\n\n" if $PLP::DEBUG & 2; + print STDOUT map("$_: $PLP::Script::header{$_}\n", keys %PLP::Script::header), "\n"; +} + +{ + my %cached; # Conceal cached sources: ( path => [ [ deps ], source, -M ] ) + + # Given a filename and optional level (level should be 0 if the caller isn't + # source() itself), and optional linespec (used by PLP::Functions::Include), + # this function parses a PLP file and returns Perl code, ready to be eval'ed + sub source { + my ($file, $level, $linespec, $path) = @_; + our $use_cache; + + # $file is displayed, $path is used. $path is constructed from $file if + # not given. + + $level = 0 unless defined $level; + $linespec = '1' unless defined $linespec; + + if ($level > 128) { + %cached = (); + return $level + ? qq{\cQ; die qq[Include recursion detected]; print q\cQ} + : qq{\n#line $linespec\ndie qq[Include recursion detected];}; + } + + my $in_block = 0; # 1 => "<:", 2 => "<:=" + + $path ||= File::Spec->rel2abs($file); + + my $source_start = $level + ? qq/\cQ;\n#line 1 "$file"\n$PLP::print q\cQ/ + : qq/\n#line 1 "$file"\n$PLP::print q\cQ/; + + if ($use_cache and exists $cached{$path}) { + BREAKOUT: { + my @checkstack = ($path); + my $item; + my %checked; + while (defined(my $item = shift @checkstack)) { + next if $checked{$item}; + last BREAKOUT if $cached{$item}[2] > -M $item; + $checked{$item} = 1; + push @checkstack, @{ $cached{$item}[0] } + if @{ $cached{$item}[0] }; + } + return $level + ? $source_start . $cached{$path}[1] + : $source_start . $cached{$path}[1] . "\cQ"; + } + } + + $cached{$path} = [ [ ], undef, undef ] if $use_cache; + + my $linenr = 0; + my $source = ''; + + local *SOURCE; + open SOURCE, '<', $path or return $level + ? qq{\cQ; die qq[Can't open "\Q$path\E" (\Q$!\E)]; print q\cQ} + : qq{\n#line $linespec\ndie qq[Can't open "\Q$path\E" (\Q$!\E)];}; + + LINE: + while (defined (my $line = )) { + $linenr++; + for (;;) { + $line =~ / + \G # Begin where left off + ( \z # End + | <:=? | :> # PLP tags <:= ... :> <: ... :> + | <\([^)]*\)> # Include tags <(...)> + | <[^:(][^<:]* # Normal text + | :[^>][^<:]* # Normal text + | [^<:]* # Normal text + ) + /gxs; + next LINE unless length $1; + my $part = $1; + if ($part eq '<:=' and not $in_block) { + $in_block = 2; + $source .= "\cQ, ("; + } elsif ($part eq '<:' and not $in_block) { + $in_block = 1; + $source .= "\cQ; "; + } elsif ($part eq ':>' and $in_block) { + $source .= ( + $in_block == 2 + ? "), q\cQ" # 2 + : "; $PLP::print q\cQ" # 1 + ); + $in_block = 0; + } elsif ($part =~ /^<\((.*?)\)>\z/ and not $in_block) { + my $ipath = File::Spec->rel2abs( + $1, File::Basename::dirname($path) + ); + $source .= source($1, $level + 1, undef, $ipath) . + qq/\cQ, \n#line $linenr "$file"\nq\cQ/; + push @{ $cached{$path}[0] }, $ipath; + } else { + $part =~ s/\\/\\\\/ unless $in_block; + $source .= $part; + } + } + } + + if ($in_block) { + $source .= ( + $in_block == 2 + ? "), q\cQ" # 2 + : "; $PLP::print q\cQ" # 1 + ); + } + + if ($use_cache) { + $cached{$path}[1] = $source; + $cached{$path}[2] = -M $path; + } + + return $level + ? $source_start . $source + : $source_start . $source . "\cQ"; + } +} + + +# Let the games begin! No lexicals may exist at this point. sub start { no strict; tie *PLPOUT, 'PLP::Tie::Print'; @@ -219,43 +316,24 @@ sub start { PLP::Fields::doit(); { package PLP::Script; + use vars qw(%headers %header %cookies %cookie %get %post %fields); *headers = \%header; *cookies = \%cookie; PLP::Functions->import(); + # No lexicals may exist at this point. + eval qq{ package PLP::Script; $PLP::code; }; PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/; + eval { package PLP::Script; $_->() for reverse @PLP::END }; PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/; } PLP::sendheaders() unless $PLP::sentheaders; select STDOUT; undef *{"PLP::Script::$_"} for keys %PLP::Script::; -# Symbol::delete_package('PLP::Script'); -# The above does not work. TODO - find out why not. -} - -# This is run by the CGI script. -# The CGI script is just: -# #!/usr/bin/perl -# use PLP; -# PLP::everything(); -sub everything { - clean(); - cgi_init(); - start(); -} - -# This is the mod_perl handler. -sub handler { - require Apache::Constants; - clean(); - if (my $ret = mod_perl_init(shift)) { - return $ret; - } - start(); - no strict 'subs'; - return Apache::Constants::OK(); + # Symbol::delete_package('PLP::Script'); + # The above does not work. TODO - find out why not. } 1; @@ -276,6 +354,7 @@ PLP - Perl in HTML pages SetHandler perl-script PerlHandler PLP PerlSendHeader On + PerlSetVar PLPcache On # Who said CGI was easier to set up? :) @@ -296,10 +375,10 @@ PLP - Perl in HTML pages ScriptAlias /foo/bar/ /PLP_COMMON/ - AllowOverride None - Options +ExecCGI - Order allow,deny - Allow from all + AllowOverride None + Options +ExecCGI + Order allow,deny + Allow from all AddHandler plp-document plp Action plp-document /PLP_COMMON/plp.cgi @@ -321,19 +400,191 @@ other Perl embedders, there is no need to learn a meta-syntax or object model: one can just use the normal Perl constructs. PLP runs under mod_perl for speeds comparable to those of PHP, but can also be run as a CGI script. -=head1 WEBSITE +=head2 PLP Syntax + +=over 22 + +=item C<< <: perl_code(); :> >> + +With C<< <: >> and C<< :> >>, you can add Perl code to your document. This is +what PLP is all about. All code outside of these tags is printed. It is +possible to mix perl language constructs with normal HTML parts of the document: + + <: unless ($ENV{REMOTE_USER}) { :> + You are not logged in. + <: } :> + +C<< :> >> always stops a code block, even when it is found in a string literal. + +=item C<< <:= $expression :> >> + +Includes a dynamic expression in your document. The expression is evaluated in +list context. Please note that the expression should not end a statement: avoid +semi-colons. No whitespace may be between C<< <: >> and the equal sign. + +C<< foo <:= $bar :> $baz >> is like C<< <: print 'foo ', $bar, ' baz'; :> >>. + +=item C<< <(filename)> >> + +Includes another file before the PLP code is executed. The file is included +literally, so it shares lexical variables. Because this is a compile-time tag, +it's fast, but you can't use a variable as the filename. You can create +recursive includes, so beware! (PLP will catch simple recursion: the maximum +depth is 128.) Whitespace in the filename is not ignored so C<< <( foo.txt)> >> +includes the file named C< foo.txt>, including the space in its name. A +compile-time alternative is include(), which is described in L. + +=back + +=head2 PLP Functions + +These are described in L. + +=head2 PLP Variables + +=over 22 + +=item $ENV{PLP_NAME} + +The URI of the PLP document, without the query string. (Example: C) + +=item $ENV{PLP_FILENAME} + +The filename of the PLP document. (Example: C) + +=item $PLP::VERSION + +The version of PLP. -For now, all documentation is on the website. Everything will be POD one day, -but until that day, you will need to visit http://plp.juerd.nl/ +=item $PLP::DEBUG + +Controls debugging output, and should be treated as a bitmask. The least +significant bit (1) controls if run-time error messages are reported to the +browser, the second bit (2) controls if headers are sent twice, so they get +displayed in the browser. A value of 3 means both features are enabled. The +default value is 1. + +=item $PLP::ERROR + +Contains a reference to the code that is used to report run-time errors. You +can override this to have it in your own design, and you could even make it +report errors by e-mail. The sub reference gets two arguments: the error message +as plain text and the error message with special characters encoded with HTML +entities. + +=item %header, %cookie, %get, %post, %fields + +These are described in L. + +=back + +=head2 (mod_perl only) PerlSetVar configuration directives + +=over 22 + +=item PLPcache + +Sets caching B/B. When caching, PLP saves your script in memory and +doesn't re-read and re-parse it if it hasn't changed. PLP will use more memory, +but will also run 50% faster. + +B is default, anything that isn't =~ /^off$/i is considered On. + +=back + +=head2 Things that you should know about + +Not only syntax is important, you should also be aware of some other important +features. Your script runs inside the package C and shouldn't +leave it. This is because when your script ends, all global variables in the +C package are destroyed, which is very important if you run under +mod_perl (they would retain their values if they weren't explicitly destroyed). + +Until your first output, you are printing to a tied filehandle C. On +first output, headers are sent to the browser and C is selected for +efficiency. To set headers, you must assign to C<$header{ $header_name}> before +any output. This means the opening C<< <: >> have to be the first characters in +your document, without any whitespace in front of them. If you start output and +try to set headers later, an error message will appear telling you on which +line your output started. An alternative way of setting headers is using Perl's +BEGIN blocks. BEGIN blocks are executed as soon as possible, before anything +else. + +Because the interpreter that mod_perl uses never ends, C blocks won't +work properly. You should use C instead. Note that this is a not +a built-in construct, so it needs proper termination with a semi-colon (as do + and ). + +Under mod_perl, modules are loaded only once. A good modular design can improve +performance because of this, but you will have to B the modules +yourself when there are newer versions. + +The special hashes are tied hashes and do not always behave the way you expect, +especially when mixed with modules that expect normal CGI environments, like +CGI.pm. Read L for information more about this. + +=head1 FAQ and HowTo + +A lot of questions are asked often, so before asking yours, please read the +FAQ at L. Some examples can be found at L. =head1 NO WARRANTY No warranty, no guarantees. Use PLP at your own risk, as I disclaim all responsibility. -=head1 AUTHOR +=head1 AUTHORS + +Currently maintained by Mischa POSLAWSKY + +Originally by Juerd Waalboer + +=head1 SEE ALSO -Juerd Waalboer +L, L, L, L =cut +### Garbage bin + +# About the #S lines: +# I wanted to implement Safe.pm so that scripts were run inside a +# configurable compartment. This needed for XS modules to be pre-loaded, +# hence the PLPsafe_* Apache directives. However, $safe->reval() lets +# Apache segfault. End of fun. The lines are still here so that I can +# s/^#S //g to re-implement them whenever this has been fixed. + +#S # For PLPsafe scripts +#S sub safe_eval { +#S my ($r, $code) = @_; +#S $r->send_http_header('text/plain'); +#S require Safe; +#S unless ($PLP::safe) { +#S $PLP::safe = Safe->new('PLP::Script'); +#S for ( map split, $r->dir_config->get('PLPsafe_module') ) { +#S $PLP::safe->share('*' . $_ . '::'); +#S s!::!/!g; +#S require $_ . '.pm'; +#S } +#S $PLP::safe->permit(Opcode::full_opset()); +#S $PLP::safe->deny(Opcode::opset(':dangerous')); +#S } +#S $PLP::safe->reval($code); +#S } +#S my ($r) = @_; + +# start() +#S if ($PLP::use_safe) { +#S PLP::safe_eval($r, $PLP::code); +#S } else { +# eval qq{ package PLP::Script; $PLP::code; }; +#S } +# PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/; +#S if ($PLP::use_safe) { +#S PLP::safe_eval($r, '$_->() for reverse @PLP::END'); +#S } else { +# eval { package PLP::Script; $_->() for reverse @PLP::END }; +#S } +# PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/; + +###