11 use File::Basename ();
17 our $VERSION = '3.20';
19 # Subs in this package:
20 # _default_error($plain, $html) Default error handler
21 # clean Reset variables
22 # error($error, $type) Handle errors
23 # everything Do everything: CGI
24 # handler($r) Do everything: mod_perl
25 # sendheaders Send headers
26 # source($path, $level, $linespec) Read and parse .plp files
27 # start Start the initialized PLP script
29 # The _init subs do the following:
30 # Set $PLP::code to the initial code
31 # Set $ENV{PLP_*} and make PATH_INFO if needed
34 # This gets referenced as the initial $PLP::ERROR
36 my ($plain, $html) = @_;
37 print qq{<table border=1 class="PLPerror"><tr><td>},
38 qq{<b>Debug information:</b><br>$html</td></tr></table>};
41 # This cleans up from previous requests, and sets the default $PLP::DEBUG
45 $PLP::sentheaders = 0;
48 delete @ENV{ grep /^PLP_/, keys %ENV };
51 # Handles errors, uses subref $PLP::ERROR (default: \&_default_error)
53 my ($error, $type) = @_;
54 if (not defined $type or $type < 100) {
55 return undef unless $PLP::DEBUG & 1;
57 (my $html = $plain) =~ s/([<&>])/'&#' . ord($1) . ';'/ge;
58 PLP::sendheaders() unless $PLP::sentheaders;
59 $PLP::ERROR->($plain, $html);
62 my ($short, $long) = @{
66 "The requested URL $ENV{REQUEST_URI} was not found " .
71 "You don't have permission to access $ENV{REQUEST_URI} " .
76 print "Status: $type\nContent-Type: text/html\n\n",
77 qq{<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">\n<html>},
78 "<head>\n<title>$type $short</title>\n</head></body>\n<h1>$short",
79 "</h1>\n$long<p>\n<hr>\n$ENV{SERVER_SIGNATURE}</body></html>";
83 # Wrap old request handlers.
85 require PLP::Backend::CGI;
86 PLP::Backend::CGI::everything();
89 require PLP::Backend::Apache;
90 PLP::Backend::Apache::handler(@_);
93 # Sends the headers waiting in %PLP::Script::header
95 $PLP::sentheaders ||= [ caller 1 ? (caller 1)[1, 2] : (caller)[1, 2] ];
96 print STDOUT "Content-Type: text/plain\n\n" if $PLP::DEBUG & 2;
97 while (my ($header, $values) = each %PLP::Script::header) {
98 print STDOUT "$header: $_\n" for split /\n/, $values;
104 my %cached; # Conceal cached sources: ( path => [ [ deps ], source, -M ] )
106 # Given a filename and optional level (level should be 0 if the caller isn't
107 # source() itself), and optional linespec (used by PLP::Functions::Include),
108 # this function parses a PLP file and returns Perl code, ready to be eval'ed
110 my ($file, $level, $linespec, $path) = @_;
113 # $file is displayed, $path is used. $path is constructed from $file if
116 $level = 0 unless defined $level;
117 $linespec = '1' unless defined $linespec;
122 ? qq{\cQ; die qq[Include recursion detected]; print q\cQ}
123 : qq{\n#line $linespec\ndie qq[Include recursion detected];};
126 my $in_block = 0; # 1 => "<:", 2 => "<:="
128 $path ||= File::Spec->rel2abs($file);
130 my $source_start = $level
131 ? qq/\cQ;\n#line 1 "$file"\n$PLP::print q\cQ/
132 : qq/\n#line 1 "$file"\n$PLP::print q\cQ/;
134 if ($use_cache and exists $cached{$path}) {
136 my @checkstack = ($path);
139 while (defined(my $item = shift @checkstack)) {
140 next if $checked{$item};
141 last BREAKOUT if $cached{$item}[2] > -M $item;
143 push @checkstack, @{ $cached{$item}[0] }
144 if @{ $cached{$item}[0] };
147 ? $source_start . $cached{$path}[1]
148 : $source_start . $cached{$path}[1] . "\cQ";
152 $cached{$path} = [ [ ], undef, undef ] if $use_cache;
158 open SOURCE, '<', $path or return $level
159 ? qq{\cQ; die qq[Can't open "\Q$path\E" (\Q$!\E)]; print q\cQ}
160 : qq{\n#line $linespec\ndie qq[Can't open "\Q$path\E" (\Q$!\E)];};
163 while (defined (my $line = <SOURCE>)) {
167 \G # Begin where left off
169 | <:=? | :> # PLP tags <:= ... :> <: ... :>
170 | <\([^)]*\)> # Include tags <(...)>
171 | <[^:(][^<:]* # Normal text
172 | :[^>][^<:]* # Normal text
173 | [^<:]* # Normal text
176 next LINE unless length $1;
178 if ($part eq '<:=' and not $in_block) {
181 } elsif ($part eq '<:' and not $in_block) {
184 } elsif ($part eq ':>' and $in_block) {
188 : "; $PLP::print q\cQ" # 1
191 } elsif ($part =~ /^<\((.*?)\)>\z/ and not $in_block) {
192 my $ipath = File::Spec->rel2abs(
193 $1, File::Basename::dirname($path)
195 $source .= source($1, $level + 1, undef, $ipath) .
196 qq/\cQ, \n#line $linenr "$file"\nq\cQ/;
197 push @{ $cached{$path}[0] }, $ipath;
199 $part =~ s/\\/\\\\/ unless $in_block;
209 : "; $PLP::print q\cQ" # 1
214 $cached{$path}[1] = $source;
215 $cached{$path}[2] = -M $path;
219 ? $source_start . $source
220 : $source_start . $source . "\cQ";
225 # Let the games begin! No lexicals may exist at this point.
228 tie *PLPOUT, 'PLP::Tie::Print';
230 $PLP::ERROR = \&_default_error;
235 use vars qw(%headers %header %cookies %cookie %get %post %fields);
238 PLP::Functions->import();
240 # No lexicals may exist at this point.
242 eval qq{ package PLP::Script; $PLP::code; };
243 PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/;
245 eval { package PLP::Script; $_->() for reverse @PLP::END };
246 PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/;
248 PLP::sendheaders() unless $PLP::sentheaders;
250 undef *{"PLP::Script::$_"} for keys %PLP::Script::;
251 # Symbol::delete_package('PLP::Script');
252 # The above does not work. TODO - find out why not.
259 PLP - Perl in HTML pages
263 =head2 Lighttpd installation
265 F<lighttpd.conf> configuration using L<mod_fastcgi|PLP::Backend::FastCGI>:
267 server.modules += ("mod_fastcgi")
268 fastcgi.server += (".plp" => ((
269 "bin-path" => "/usr/bin/perl -MPLP::Backend::FastCGI",
270 "socket" => "/tmp/fcgi-plp.socket",
273 =head2 Apache installation
275 F<httpd.conf> for a L<mod_perl|PLP::Backend::Apache> setup:
278 SetHandler perl-script
279 PerlHandler PLP::Backend::Apache
283 =head2 Test script (test.plp)
287 print "Hurrah, it works!<br>" for 1..10;
293 PLP is yet another Perl embedder, primarily for HTML documents. Unlike with
294 other Perl embedders, there is no need to learn a meta-syntax or object
295 model: one can just use the normal Perl constructs. PLP runs under
296 L<FastCGI|PLP::Backend::FastCGI> and L<mod_perl|PLP::Backend::Apache>
297 for speeds comparable to those of PHP, but can also be run as a standard
298 L<CGI|PLP::Backend::CGI> script.
303 L<CGI|PLP::Backend::CGI>,
304 L<FastCGI|PLP::Backend::FastCGI> (recommended)
305 or L<Apache|PLP::Backend::Apache>.
306 At least the following servers are supported:
312 With L<mod_fastcgi|PLP::Backend::FastCGI> or L<mod_cgi|PLP::Backend::CGI>.
316 Either version 1 or 2. Using
317 L<mod_fcgid, mod_fastcgi|PLP::Backend::FastCGI>,
318 L<mod_perl|PLP::Backend::Apache>,
319 or L<mod_action|PLP::Backend::CGI>.
327 =item C<< <: perl_code(); :> >>
329 With C<< <: >> and C<< :> >>, you can add Perl code to your document. This is
330 what PLP is all about. All code outside of these tags is printed. It is
331 possible to mix perl language constructs with normal HTML parts of the document:
333 <: unless ($ENV{REMOTE_USER}) { :>
334 You are not logged in.
337 C<< :> >> always stops a code block, even when it is found in a string literal.
339 =item C<< <:= $expression :> >>
341 Includes a dynamic expression in your document. The expression is evaluated in
342 list context. Please note that the expression should not end a statement: avoid
343 semi-colons. No whitespace may be between C<< <: >> and the equal sign.
345 C<< foo <:= $bar :> $baz >> is like C<< <: print 'foo ', $bar, ' $baz'; :> >>.
347 =item C<< <(filename)> >>
349 Includes another file before the PLP code is executed. The file is included
350 literally, so it shares lexical variables. Because this is a compile-time tag,
351 it's fast, but you can't use a variable as the filename. You can create
352 recursive includes, so beware! (PLP will catch simple recursion: the maximum
353 depth is 128.) Whitespace in the filename is not ignored so C<< <( foo.txt)> >>
354 includes the file named C< foo.txt>, including the space in its name. A
355 compile-time alternative is include(), which is described in L<PLP::Functions>.
361 These are described in L<PLP::Functions>.
367 =item $ENV{SCRIPT_NAME}
369 The URI of the PLP document, without the query string. (Example: C</foo.plp>)
371 Used to be renamed to C<$ENV{PLP_NAME}>, which is still provided but deprecated.
373 =item $ENV{SCRIPT_FILENAME}
375 The filename of the PLP document. (Example: C</var/www/index.plp>)
377 C<$ENV{PLP_SCRIPT}> also still provided but deprecated.
385 Controls debugging output, and should be treated as a bitmask. The least
386 significant bit (1) controls if run-time error messages are reported to the
387 browser, the second bit (2) controls if headers are sent twice, so they get
388 displayed in the browser. A value of 3 means both features are enabled. The
393 Contains a reference to the code that is used to report run-time errors. You
394 can override this to have it in your own design, and you could even make it
395 report errors by e-mail. The sub reference gets two arguments: the error message
396 as plain text and the error message with special characters encoded with HTML
399 =item %header, %cookie, %get, %post, %fields
401 These are described in L<PLP::Fields>.
405 =head2 Things that you should know about
407 Not only syntax is important, you should also be aware of some other important
408 features. Your script runs inside the package C<PLP::Script> and shouldn't
409 leave it. This is because when your script ends, all global variables in the
410 C<PLP::Script> package are destroyed, which is very important if you run under
411 mod_perl (they would retain their values if they weren't explicitly destroyed).
413 Until your first output, you are printing to a tied filehandle C<PLPOUT>. On
414 first output, headers are sent to the browser and C<STDOUT> is selected for
415 efficiency. To set headers, you must assign to C<$header{ $header_name}> before
416 any output. This means the opening C<< <: >> have to be the first characters in
417 your document, without any whitespace in front of them. If you start output and
418 try to set headers later, an error message will appear telling you on which
419 line your output started. An alternative way of setting headers is using Perl's
420 BEGIN blocks. BEGIN blocks are executed as soon as possible, before anything
423 Because the interpreter that mod_perl uses never ends, C<END { }> blocks won't
424 work properly. You should use C<PLP_END { };> instead. Note that this is a not
425 a built-in construct, so it needs proper termination with a semi-colon (as do
428 Under mod_perl, modules are loaded only once. A good modular design can improve
429 performance because of this, but you will have to B<reload> the modules
430 yourself when there are newer versions.
432 The special hashes are tied hashes and do not always behave the way you expect,
433 especially when mixed with modules that expect normal CGI environments, like
434 CGI.pm. Read L<PLP::Fields> for information more about this.
438 A lot of questions are asked often, so before asking yours, please read the
439 FAQ at L<PLP::FAQ>. Some examples can be found at L<PLP::HowTo>.
443 Currently maintained by Mischa POSLAWSKY <perl@shiar.org>
445 Originally by Juerd Waalboer <juerd@cpan.org>
449 Copyright (c) 2000-2002 Juerd Waalboer, 2005-2008 Mischa POSLAWSKY.
452 This software is free software;
453 you can redistribute and/or modify it under the terms of the MIT/X11 license.
457 L<PLP::Functions>, L<PLP::Fields>, L<PLP::FAQ>, L<PLP::HowTo>
463 # About the #S lines:
464 # I wanted to implement Safe.pm so that scripts were run inside a
465 # configurable compartment. This needed for XS modules to be pre-loaded,
466 # hence the PLPsafe_* Apache directives. However, $safe->reval() lets
467 # Apache segfault. End of fun. The lines are still here so that I can
468 # s/^#S //g to re-implement them whenever this has been fixed.
470 #S # For PLPsafe scripts
472 #S my ($r, $code) = @_;
473 #S $r->send_http_header('text/plain');
475 #S unless ($PLP::safe) {
476 #S $PLP::safe = Safe->new('PLP::Script');
477 #S for ( map split, $r->dir_config->get('PLPsafe_module') ) {
478 #S $PLP::safe->share('*' . $_ . '::');
480 #S require $_ . '.pm';
482 #S $PLP::safe->permit(Opcode::full_opset());
483 #S $PLP::safe->deny(Opcode::opset(':dangerous'));
485 #S $PLP::safe->reval($code);
490 #S if ($PLP::use_safe) {
491 #S PLP::safe_eval($r, $PLP::code);
493 # eval qq{ package PLP::Script; $PLP::code; };
495 # PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/;
496 #S if ($PLP::use_safe) {
497 #S PLP::safe_eval($r, '$_->() for reverse @PLP::END');
499 # eval { package PLP::Script; $_->() for reverse @PLP::END };
501 # PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/;