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 print STDOUT map("$_: $PLP::Script::header{$_}\n", keys %PLP::Script::header), "\n";
101 my %cached; # Conceal cached sources: ( path => [ [ deps ], source, -M ] )
103 # Given a filename and optional level (level should be 0 if the caller isn't
104 # source() itself), and optional linespec (used by PLP::Functions::Include),
105 # this function parses a PLP file and returns Perl code, ready to be eval'ed
107 my ($file, $level, $linespec, $path) = @_;
110 # $file is displayed, $path is used. $path is constructed from $file if
113 $level = 0 unless defined $level;
114 $linespec = '1' unless defined $linespec;
119 ? qq{\cQ; die qq[Include recursion detected]; print q\cQ}
120 : qq{\n#line $linespec\ndie qq[Include recursion detected];};
123 my $in_block = 0; # 1 => "<:", 2 => "<:="
125 $path ||= File::Spec->rel2abs($file);
127 my $source_start = $level
128 ? qq/\cQ;\n#line 1 "$file"\n$PLP::print q\cQ/
129 : qq/\n#line 1 "$file"\n$PLP::print q\cQ/;
131 if ($use_cache and exists $cached{$path}) {
133 my @checkstack = ($path);
136 while (defined(my $item = shift @checkstack)) {
137 next if $checked{$item};
138 last BREAKOUT if $cached{$item}[2] > -M $item;
140 push @checkstack, @{ $cached{$item}[0] }
141 if @{ $cached{$item}[0] };
144 ? $source_start . $cached{$path}[1]
145 : $source_start . $cached{$path}[1] . "\cQ";
149 $cached{$path} = [ [ ], undef, undef ] if $use_cache;
155 open SOURCE, '<', $path or return $level
156 ? qq{\cQ; die qq[Can't open "\Q$path\E" (\Q$!\E)]; print q\cQ}
157 : qq{\n#line $linespec\ndie qq[Can't open "\Q$path\E" (\Q$!\E)];};
160 while (defined (my $line = <SOURCE>)) {
164 \G # Begin where left off
166 | <:=? | :> # PLP tags <:= ... :> <: ... :>
167 | <\([^)]*\)> # Include tags <(...)>
168 | <[^:(][^<:]* # Normal text
169 | :[^>][^<:]* # Normal text
170 | [^<:]* # Normal text
173 next LINE unless length $1;
175 if ($part eq '<:=' and not $in_block) {
178 } elsif ($part eq '<:' and not $in_block) {
181 } elsif ($part eq ':>' and $in_block) {
185 : "; $PLP::print q\cQ" # 1
188 } elsif ($part =~ /^<\((.*?)\)>\z/ and not $in_block) {
189 my $ipath = File::Spec->rel2abs(
190 $1, File::Basename::dirname($path)
192 $source .= source($1, $level + 1, undef, $ipath) .
193 qq/\cQ, \n#line $linenr "$file"\nq\cQ/;
194 push @{ $cached{$path}[0] }, $ipath;
196 $part =~ s/\\/\\\\/ unless $in_block;
206 : "; $PLP::print q\cQ" # 1
211 $cached{$path}[1] = $source;
212 $cached{$path}[2] = -M $path;
216 ? $source_start . $source
217 : $source_start . $source . "\cQ";
222 # Let the games begin! No lexicals may exist at this point.
225 tie *PLPOUT, 'PLP::Tie::Print';
227 $PLP::ERROR = \&_default_error;
232 use vars qw(%headers %header %cookies %cookie %get %post %fields);
235 PLP::Functions->import();
237 # No lexicals may exist at this point.
239 eval qq{ package PLP::Script; $PLP::code; };
240 PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/;
242 eval { package PLP::Script; $_->() for reverse @PLP::END };
243 PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/;
245 PLP::sendheaders() unless $PLP::sentheaders;
247 undef *{"PLP::Script::$_"} for keys %PLP::Script::;
248 # Symbol::delete_package('PLP::Script');
249 # The above does not work. TODO - find out why not.
256 PLP - Perl in HTML pages
260 =head2 Lighttpd installation
262 F<lighttpd.conf> configuration using L<mod_fastcgi|PLP::Backend::FastCGI>:
264 server.modules += ("mod_fastcgi")
265 fastcgi.server += (".plp" => ((
266 "bin-path" => "/usr/bin/perl -MPLP::Backend::FastCGI",
267 "socket" => "/tmp/fcgi-plp.socket",
270 =head2 Apache installation
272 F<httpd.conf> for a L<mod_perl|PLP::Backend::Apache> setup:
275 SetHandler perl-script
276 PerlHandler PLP::Backend::Apache
280 =head2 Test script (test.plp)
284 print "Hurrah, it works!<br>" for 1..10;
290 PLP is yet another Perl embedder, primarily for HTML documents. Unlike with
291 other Perl embedders, there is no need to learn a meta-syntax or object
292 model: one can just use the normal Perl constructs. PLP runs under
293 L<FastCGI|PLP::Backend::FastCGI> and L<mod_perl|PLP::Backend::Apache>
294 for speeds comparable to those of PHP, but can also be run as a standard
295 L<CGI|PLP::Backend::CGI> script.
300 L<CGI|PLP::Backend::CGI>,
301 L<FastCGI|PLP::Backend::FastCGI> (recommended)
302 or L<Apache|PLP::Backend::Apache>.
303 At least the following servers are supported:
309 With L<mod_fastcgi|PLP::Backend::FastCGI> or L<mod_cgi|PLP::Backend::CGI>.
313 Either version 1 or 2. Using
314 L<mod_fcgid, mod_fastcgi|PLP::Backend::FastCGI>,
315 L<mod_perl|PLP::Backend::Apache>,
316 or L<mod_action|PLP::Backend::CGI>.
324 =item C<< <: perl_code(); :> >>
326 With C<< <: >> and C<< :> >>, you can add Perl code to your document. This is
327 what PLP is all about. All code outside of these tags is printed. It is
328 possible to mix perl language constructs with normal HTML parts of the document:
330 <: unless ($ENV{REMOTE_USER}) { :>
331 You are not logged in.
334 C<< :> >> always stops a code block, even when it is found in a string literal.
336 =item C<< <:= $expression :> >>
338 Includes a dynamic expression in your document. The expression is evaluated in
339 list context. Please note that the expression should not end a statement: avoid
340 semi-colons. No whitespace may be between C<< <: >> and the equal sign.
342 C<< foo <:= $bar :> $baz >> is like C<< <: print 'foo ', $bar, ' $baz'; :> >>.
344 =item C<< <(filename)> >>
346 Includes another file before the PLP code is executed. The file is included
347 literally, so it shares lexical variables. Because this is a compile-time tag,
348 it's fast, but you can't use a variable as the filename. You can create
349 recursive includes, so beware! (PLP will catch simple recursion: the maximum
350 depth is 128.) Whitespace in the filename is not ignored so C<< <( foo.txt)> >>
351 includes the file named C< foo.txt>, including the space in its name. A
352 compile-time alternative is include(), which is described in L<PLP::Functions>.
358 These are described in L<PLP::Functions>.
364 =item $ENV{SCRIPT_NAME}
366 The URI of the PLP document, without the query string. (Example: C</foo.plp>)
368 Used to be renamed to C<$ENV{PLP_NAME}>, which is still provided but deprecated.
370 =item $ENV{SCRIPT_FILENAME}
372 The filename of the PLP document. (Example: C</var/www/index.plp>)
374 C<$ENV{PLP_SCRIPT}> also still provided but deprecated.
382 Controls debugging output, and should be treated as a bitmask. The least
383 significant bit (1) controls if run-time error messages are reported to the
384 browser, the second bit (2) controls if headers are sent twice, so they get
385 displayed in the browser. A value of 3 means both features are enabled. The
390 Contains a reference to the code that is used to report run-time errors. You
391 can override this to have it in your own design, and you could even make it
392 report errors by e-mail. The sub reference gets two arguments: the error message
393 as plain text and the error message with special characters encoded with HTML
396 =item %header, %cookie, %get, %post, %fields
398 These are described in L<PLP::Fields>.
402 =head2 Things that you should know about
404 Not only syntax is important, you should also be aware of some other important
405 features. Your script runs inside the package C<PLP::Script> and shouldn't
406 leave it. This is because when your script ends, all global variables in the
407 C<PLP::Script> package are destroyed, which is very important if you run under
408 mod_perl (they would retain their values if they weren't explicitly destroyed).
410 Until your first output, you are printing to a tied filehandle C<PLPOUT>. On
411 first output, headers are sent to the browser and C<STDOUT> is selected for
412 efficiency. To set headers, you must assign to C<$header{ $header_name}> before
413 any output. This means the opening C<< <: >> have to be the first characters in
414 your document, without any whitespace in front of them. If you start output and
415 try to set headers later, an error message will appear telling you on which
416 line your output started. An alternative way of setting headers is using Perl's
417 BEGIN blocks. BEGIN blocks are executed as soon as possible, before anything
420 Because the interpreter that mod_perl uses never ends, C<END { }> blocks won't
421 work properly. You should use C<PLP_END { };> instead. Note that this is a not
422 a built-in construct, so it needs proper termination with a semi-colon (as do
425 Under mod_perl, modules are loaded only once. A good modular design can improve
426 performance because of this, but you will have to B<reload> the modules
427 yourself when there are newer versions.
429 The special hashes are tied hashes and do not always behave the way you expect,
430 especially when mixed with modules that expect normal CGI environments, like
431 CGI.pm. Read L<PLP::Fields> for information more about this.
435 A lot of questions are asked often, so before asking yours, please read the
436 FAQ at L<PLP::FAQ>. Some examples can be found at L<PLP::HowTo>.
440 Currently maintained by Mischa POSLAWSKY <perl@shiar.org>
442 Originally by Juerd Waalboer <juerd@cpan.org>
446 Copyright (c) 2000-2002 Juerd Waalboer, 2005-2008 Mischa POSLAWSKY.
449 This software is free software;
450 you can redistribute and/or modify it under the terms of the MIT/X11 license.
454 L<PLP::Functions>, L<PLP::Fields>, L<PLP::FAQ>, L<PLP::HowTo>
460 # About the #S lines:
461 # I wanted to implement Safe.pm so that scripts were run inside a
462 # configurable compartment. This needed for XS modules to be pre-loaded,
463 # hence the PLPsafe_* Apache directives. However, $safe->reval() lets
464 # Apache segfault. End of fun. The lines are still here so that I can
465 # s/^#S //g to re-implement them whenever this has been fixed.
467 #S # For PLPsafe scripts
469 #S my ($r, $code) = @_;
470 #S $r->send_http_header('text/plain');
472 #S unless ($PLP::safe) {
473 #S $PLP::safe = Safe->new('PLP::Script');
474 #S for ( map split, $r->dir_config->get('PLPsafe_module') ) {
475 #S $PLP::safe->share('*' . $_ . '::');
477 #S require $_ . '.pm';
479 #S $PLP::safe->permit(Opcode::full_opset());
480 #S $PLP::safe->deny(Opcode::opset(':dangerous'));
482 #S $PLP::safe->reval($code);
487 #S if ($PLP::use_safe) {
488 #S PLP::safe_eval($r, $PLP::code);
490 # eval qq{ package PLP::Script; $PLP::code; };
492 # PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/;
493 #S if ($PLP::use_safe) {
494 #S PLP::safe_eval($r, '$_->() for reverse @PLP::END');
496 # eval { package PLP::Script; $_->() for reverse @PLP::END };
498 # PLP::error($@, 1) if $@ and $@ !~ /\cS\cT\cO\cP/;