=pod =head1 NAME Embperl FAQ - embed Perl code in your HTML docs =head1 CONTENTS =over 4 =item L<"Downloading, Compiling & Installing"> =item L<"Common Problems"> =item L<"Common Questions"> =item L<"Escaping & Unescaping"> =item L<"Debugging"> =item L<"Customizing"> =item L<"Optimizing & Fine Tuning"> =item L<"Additional Help"> =back =head1 Downloading, Compiling & Installing For basics on downloading, compiling, and installing, please see the L in the Embperl documentation. Please be sure to load Embperl at server startup - if you do not, various problems may result. =head2 Is there a binary distribution of Embperl? No. =head2 Is there a binary distribution of Embperl for Win32? Not at the present time, but this may change. =head2 I want to run Embperl with mod_perl under Apache. In what order should I do the compiling? First mod_perl and Apache, then Embperl. =head2 I'm getting: ../apache_1.3.0/src/include/conf.h:916: regex.h: No such file or directory Try compiling Embperl again, like this: make DEFS=-DUSE_HSREGEX =head2 I'm trying to build HTML::Embperl, and while running 'make' i get: cc: Internal compiler error: program cc1 got fatal signal 11 make: *** [epmain.o] Error 1 GCC croaking with signal 11 frequently indicates hardware problems. See http://www.bitwizard.nl/sig11/ =head2 I have a lot of errors in 'make test' from mod_perl when using Embperl Try recompiling Perl and all modules -- this can sometimes make those annoying error messages disappear! =head2 Running 'make test' fails with an error message at loading of Embperl (even though mod_perl compiled and tested cleanly!) This can happen when symbols in the Apache binary can not be found or are not being resolved correctly. Some OS do this (for instance bsdos), and it can also happen if your Apache binary is set to strip symbol information out from binaries. Try: =over 4 =item 1.) make clean =item 2.) perl Makefile.PL NOTE: answer _no_ to mod_perl support. (This is important!) =item 3.) make test =back If that works, it means that your installation of Embperl is OK, but is having problems resolving symbols with Apache. Try rebuilding Apache and mod_perl from scratch, and make sure you do not strip symbols out of either. If you don't succeed with this approach, try statically linking Embperl to Apache/mod_perl (please see the next question for step-by-step instructions on how to do this). =head2 How can I build a statically-linked copy of Embperl with mod_perl support? =over 4 =item 1.) go to your mod_perl directory, change to src/modules/perl and edit the Makefile so that it contains the line #STATIC_EXTS = Apache Apache::Constants HTML::Embperl =item 2.) add a definition for EPDIR and change the ONJ= line so that it looks like this: EPDIR=/usr/msrc/embperl OBJS=$(PERLSRC:.c=.o) $(EPDIR)/Embperl.o $(EPDIR)/epmain.o $(EPDIR)/epio.o (EP DIR)/epeval.o $(EPDIR)/epcmd.o $(EPDIR)/epchar.o $(EPDIR)/eputil.o =item 3.) go to the mod_perl directory and run perl Makefile.PL =item 4.) go to the Embperl directory and do make clean perl Makefule.PL make (to compile in mod_perl support) =item 5.) go back to the mod_perl directory and remake Apache by typing make Now you have successfully built a httpd with statically-linked Embperl. NOTE: If you want to stop here, you can skip to step 11. and run a 'make install' in the Embperl directory to finish. But if you want to run Embperl tests and/or if you want to be able to use Embperl in offline or "vanilla" CGI mode, we need to continue: =item 6.) go back to the Embperl directory =item 7.) backup the file test/conf/config.pl =item 8.) now build Embperl again but _without_ mod_perl support make clean perl Makefile.PL make =item 9.) restore your saved config.pl to test/conf/config.pl (without this step, only the offline mode would be tested) =item 10.) run 'make test' for Embperl =item 11.) do 'make install' for Embperl =back NOTE: You should do it in this order, or it may not work. NOTE: It seems to be necessary to load Embperl at server startup, either by PerlModule or in a PerlScript. See next question on how to do this. =head2 How do I load Embperl at server startup? You can load Embperl at server startup by PerlModule or in a startup.pl: =over 4 =item 1.) edit your srm.conf file to read: PerlModule HTML::Embperl =item 2.) edit your startup.pl file to read: use HTML::Embperl =back NOTE: Either of these approaches can often 'fix' SIGSEVs in any mod_perl handler, not just Embperl. =head1 Common Problems The most common problems of all involve Escaping and Unescaping. They are so common, that an entire section on L<"Escaping & Unescaping"> is devoted to them. =head2 Why doesn't the following line work? [+ $var . "". $foo . "". $bar +] See what we mean? This is an Escaping & Unescaping problem for sure. You need to escape as ' <b> ' and you probably also need to read the section on L<"Escaping & Unescaping">... =head2 I'm getting: "Glob not terminated at ..." This might be a problem with L<"Escaping & Unescaping"> as well. =head2 My HTML is getting stripped out. Sounds like a problem with Escaping & Unescaping again! Unless, of course, you have already read the section on Escaping & Unescaping, and it is still happening... Like if you are using optRawInput and your HTML is _still_ being stripped out... =head2 I _am_ using optRawInput, and my HTML _is_ still being stripped out! Aha! Well that's different! Never mind.. It can be easy to accidentally set optRawInput too late in your code... Try setting it in an extra Perl block S<( [- $optRawInput = 1 -] )> earlier in the code, or in the server config, and see if that doesn't solve the problem... (optRawInput must be set before the block that uses it begins, as the block which uses it shouldn't be translated). =head2 Help! I got a SIGSEGV! Ack! If Embperl is not compiled at server startup, it can cause error messages, SEGfaults, core dumps, buffer overflow, etc - especially if you are using another module inside an Embperl page. As far as anyone can tell, this seems to be a Perl/mod_perl problem - but maybe not. If you have any ideas, let me know. To see the steps for loading Embperl at server startup, please see the section L<"Downloading, Compiling & Installing">. =head2 I am having troubles with using Embperl in combination with Apache::Include and Apache::Registry. This is a known problem, but it is a problem with mod_perl rather than with Embperl. It looks like mod_perl clears the request_rec after the first subrequest, so that it later doesn't know which subrequest was intended (unless it's explicitly specified). Try using: Apache::Include->virtual("test.epl", $r); (instead of just Apache::Include->virtual("test.epl"); where $r is the apache request rec) =head2 I can't get PerlSendHeader to work under Embperl? You don't need PerlSendHeader when using Embperl - Embperl always sends its own httpd header. =head2 But how do I customize the header that Embperl is sending? You'll find the answer to this and many other header issues in the L<"Common Questions"> section. =head2 I can't figure out how to split a 'while' statement across two [--] segments That isn't surprising, as you cannot split Perl statements across multiple blocks in Embperl :) You need to use a metacommand for that. The [$while$] metacommand comes to mind... :) For a list of all possible metacommands, see the section on L in the Embperl documentation. =head2 My HTML tags like '<' '>' and '"' are being translated to <, > !!! Hey! Not you again!? I thought we already sent you to the L<"Escaping & Unescaping"> section of the FAQ?!?! ;) =head2 Netscape asks to reload the document If you have something like this in your source, it may be the problem: Netscape seems to have a problem in such cases, because the http header is only content-type text/html, while the META HTTP-EQUIV has an additional charset specified. If you turn optEarlyHttpHeader off, Embperl will automatically set the http header to be the same as the META HTTP-EQUIV. =head1 Common Questions The most common questions of all deal with L<"Escaping & Unescaping"> - they are so common that the whole next section is devoted to them. Less common questions are addressed here: =head2 What is the difference between Embperl and ePerl (and ASP, etc)? ePerl also embeds Perl code in documents, but it doesn't know anything about HTML. Embperl's strongest features (the ones which have received the most attention during development so far) are probably: =over 4 =item - Dynamic Tables =item - Formfields Processing =item - Escaping/Unescaping =item - Safe Namespaces =back =head2 How can I get my HTML files to be converted into Perl code which, as a whole, could then be compiled as function named munge(URL) so that I could, for instance, fetch Perl docs from the Formatter table and compile them the way AUTOLOAD does. This is a very good example of a very long run-on sentence, and it is also a very good example of a thing that ePerl would do better than Embperl. See ePerl, by Ralf Engelschalls, at http://www.engelschall.com. See also the previous question, "What is the difference between Embperl and ePerl?" =head2 I have an HTML page which is dynamically generated at runtime and should be post-processed by Embperl. How can I do this? =over 4 =item 1.) Generate the page within a normal CGI/Apache::Registry script and put the result into a scalar - then you can call HTML::Embperl::Execute to post-process your document. Execute can either send the document to the browser or put it into another scalar for further processing. =item 2.) Use EMBPERL_INPUT_FUNC (1.1b1 and above). With this configuration directive, you can specify a custom input function which reads the HTML source from the disk or even from a database. Embperl also provides the function ProxyInput, which allows you to get input from another web server altogether. =back =head2 How can I customise the header that Embperl is sending? You can write it as (Embperl will automatically insert all meta http-equiv tags into the http header) or you can use [- $req_rec -> content_type ('text/html') -] =head2 Can I use Embperl to send cookies? Yes. Embperl sends its own headers, so all you have to do to send cookies is to remember to print an additional header. Example Code: =over 4 =item 1.) in documents, add =item 2.) or - using mod_perl's functionality - use [- $req_rec -> header_out("Set-Cookie" => "$cookie=$value"); -] =back =head2 Can I do REDIRECT with Embperl? The function you want to call is Apache::header_out. Example Code: [- use Apache; use Apache::Constants qw(REDIRECT); $req_rec->header_out("Location" => "http://$ENV{SERVER_NAME}/specials/"); $req_rec->status(REDIRECT); -] =head2 Can I serve random GIFs with Embperl? (Will Leonard Stein's GD.pm module work with Embperl??) As always, there is more than one way to do this - especially as this is more of a question of how you are coding your HTML than how you are coding your Embperl. Here are some ideas: =over 4 =item 1.) You could include an IMG tag which points to your cgi-bin, where a regular CGI script serves the graphics. =item 2.) You could be running Apache::Registry, which can generate on-the-fly GIFs using GD. (This is just the same as if you were including the GD image from a static page or from another CGI script, but it allows all of the appropriate logic to live in a single document, which might be appropriate for some Embperl users). =back If you think of another way, or come up with some sample code, I'd love to hear from you, so that I could add it to the FAQ... =head2 Can I use Embperl as a template for forms? Can I make form values persist (like with "vanilla" CGI)? Does Embperl rewrite my template file so that parameters of things like INPUT/TEXTAREA/SELECT persist? Yes. Your page design staff should just be able to say and let the default attributes of "foo" be defined elsewhere - for instance in a settings file. In this case, %fdat should be pre-set with your default values. Setting $fdat{foo} = "abc" will cause Embperl to change the above code to . =head2 Does Embperl automatically add HIDDEN fields? The [$hidden$] metacommand creates hidden fields for every entry in %fdat which was not used by any other input tag so far. You can also try something like this: [- $fdat{foo} = "abc" ; $fdat{bar} = "xyz" ; -] [$hidden$] and Embperl will create: For a list of all possible metacommands, see the section on L in the Embperl documentation. =head2 What about security? Is Embperl Secure? Just like anything else, Embperl is as secure as you make it. Embperl incorporates Safe.pm, which will make it impossible to accidentally access other Packages - it also permits the Administrator to disable Perl opcodes, etc. For more on security, please see L in the Embperl documentation. =head2 Is there any plan to make Embperl an Object so someone could subclass it and override certain of its methods? (For example, I'd like to let it parse the file for me, but then let me control the manipulation of the form tags.) Embperl will be converted to an Object in the near future. This will, among other things, make it re-entrant, so that you will be able to call Execute from within an Embperl page. It will also mean that Embperl will come with hooks, which will allow you to alter or change the way Embperl processes code. The details have not all been worked out yet, but I'm working on it... :) =head2 Are Embperl routines currently pre-compiled or even cached, or are only fragments cached? All embedded Perl code is compiled the first time it is executed and cached for later use. The second time the code is executed, only the precompiled p-code is called. Every code block is compiled as a single subroutine. The HTML text between the Perl block is still read from the file. =head2 Why are Perl blocks broken up into single subroutines? =over 4 =item 1.) It makes it easier to process the HTML tags between the Perl blocks - this gives you more control over what's happening =item 2.) If you compiled _everything_ to Perl, you would hold all of the HTML text in memory, and your Apache child processes would grow and grow... But often-accessed documents are still held in memory by your os disk cache, which is much more memory-efficient. =item 3.) There is only so far that you can go with precompiling until you reach the point of diminishing returns. My guess is that converting dynamic tables and other HTML processing to Perl at this point in Embperl's development would actually slow down operation. =back =head2 Can I pass QUERY_STRING information to an HTML::Embperl::Execute call? With Embperl 1.0 and higher, you can do this. QUERY_STRING is set as $ENV{QUERY_STRING} by default. Alternatively, you can use the fdat parameter to pass values to %fdat. =head1 Escaping & Unescaping =head2 Escaping & Unescaping Input By default, Embperl removes all HTML tags from the Perl source. It does this because many high-end WYSIWYG HTML Editors (like MS Front Page) insert HTML tags like and in rather random places (like in the middle of your Perl code). This Embperl feature keeps things like [- $var = 1;
$foo = 2 -] permissable, so that you can enter Perl code while you mark up pages in an editor, all at once. In this example, Embperl would remove the unnecessary
tag and, therefore, make Perl happy. And if Perl is happy, we are all happy. It is not difficult to change this behavior, if you are the kind of person who codes HTML in an ascii editor (like vi or emacs). If you use a high-level HTML editor, you shouldn't have any problems with input escaping, because the editor will, for example, write a '<' as '<' in the HTML code. Embperl translates this back to '<' and therefore it knows that this wasn't an HTML tag which should be removed. Problems with input escaping only occur if you use an ascii editor. Then you will need to escape input (see the next section for details on how to do this). To see the exact steps taken by Embperl to process a Perl-laden document, please see the section L in the Embperl documentation. =head2 Ways To Escape Input: =over 4 =item 1. Escape it -> \

NOTE: Inside double quotes you will need to use \\ (double backslash), since Perl will remove the first Escape itself. Example: In most cases '\' but inside double-quotes "\\" =item 2. Turn off Escaping for all input by setting the optRawInput in EMBPERL_OPTIONS =item 3. Learn to avoid using HTML tags inside Perl code. Once you get the hang of it, you'll love it. =back Here is one example of how to do it: [- $output = "Hello world" -] [+ $output +] write [- $output = "Hello world" -] this outputs Hello world or [+ $output +] this outputs Hello world And here is another example of how to do it: [- @a = ('a', 'b', 'c') ; foreach $i (0..2) { $output. = "Row $a[$i]" ; } -] [+ $output +]
The output here would be: Row aRow bRow c
The Embperl version is [- @a = ('a', 'b', 'c') ; -] " ;
Row $a[$row]
The output will be " ; " ; " ;
Row a
Row b
Row c
And another: This elegant solution shows you how to take advantage of Embperl's ability to create dynamic tables: [- use DBI; my $dbh = DBI->connect("DBI:mysql:database:localhost","Username","Password") || die($!); $hstmt = $dbh->prepare("select ID, Heading from Shops order by Heading"); $hstmt->execute(); $dat = $hstmt->fetchall_arrayref() ; $hstmt->finish(); $dbh->disconnect(); -]
[+ $$dat[$row][$col] +]
This HTML code will then display the contents of the whole array. =head2 Escaping & Unescaping Output Embperl will also escape the output - so

will be translated to <H1> To see the exact steps taken by Embperl to process a Perl-laden document, please see L in the Embperl documentation. =head2 Ways To Escape Output: =over 4 =item 1.) Escape it -> \\

(You need a double backslash \\, because the first one is removed by Perl and the second by Embperl. =item 2.) set $escmode = 0 -> [- $escmode = 0 ; -] =item 3.) set SetEnv EMBPERL_ESCMODE 0 in your srm.conf =back =head1 Debugging =head2 I am having a hard time debugging Embperl code Have you, umm, checked the error log? ;) Have you tried setting debug flags higher by resetting EMBPERL_DEBUG in the server config files? (And still higher? :) dbgMem isn't usually very useful as it always outputs a lot of allocation. dbgFlushLog and dbgFlushOutput should be used if (and only if) you are debugging SIGSEGVs. For easy debugging, you can tell Embperl to display a link at the top of each page to your log file. Then every error displayed in an error page is a link to the corresponding position in the logfile, so you can easily find the place where something is going wrong For more on using HTML links to the Embperl error log, see L in the Embperldocs. =head2 Embperl is running slow. There are some debugging settings which may cause Embperl to drastically slow down. If you are done with debugging, set debugging bits back to normal. Also, using dbgFlushLog and dbgFlushOutput will make execution much slower. These are only intended for debugging SIGSEGVs. Never set all debugging bits! =head2 How can I improve Embperl's performance? =over 4 =item 1.) Load Embperl at server startup. This will cause UNIX systems to only allocate memory once, and not for each child process. This reduces memory use, especially the need to swap additional memory. =item 2.) Disable all unneeded debugging flags. You should never set dbgFlushLog dbgFlushOutput, dbgMem and dbgEvalNoCache in a production environment. =back =head1 Customizing =head2 How can I fiddle with the default values? How can I override or alter this or that behavior? Usually, defaults are set in a way that is likely to make most sense for a majority of users. As of version 1.0, Embperl allows much more flexibility in tweaking your own default values than before. =head2 I'd like to (temporarily) disable some of Embperl's features. What can be customized? =over 4 =item 1.) Use optDisableHtmlScan to disable processing of html tags. If this is set, Embperl will only pay attention to these types of constructs: S<[+/-/!/$ .... $/!/-/+]> =item 2.) optDisableTableScan, optDisableInputScan and optDisableMetaScan can be used to disable individual parts of HTML processing. You may set these flags in your server config, or at runtime: [+ $optDisableHtmlScan = 1 +] foo
[+ $optDisableHtmlScan = 0 +] =back =head2 How can I disable auto-tables? Set optDisableTableScan in EMBPERL_OPTIONS =head2 How can I change predefined values like $escmode from my Toolbox module? $HTML::Embperl::escmode = 0 ; Predefined values in Embperl are simply aliases for $HTML::Embperl::foo (for instance, $Z<>escmode is an alias for $HTML::Embperl::escmode) =head2 How can I customize the header that Embperl is sending? You'll find the answer to this and many other header issues in the L<"Common Questions"> section. =head2 How can I use a different character set? ASCII values over 128 are showing up as ? (question marks)! This is caused by the translation of characters to HTML escapes. Embperl translates them to escapes which are then sometimes not understood by the browser, which may display a "?" instead, because it is using the wrong character set. If you want to use the escaping features of Embperl in this case, you have to adapt the file epchar.c to your character set. This file contains three tables: Char2Html [] Convert characters to html escape Char2Url [] Convert characters to url escapes (do not change this one!!) Html2Char [] Convert html escapes to characters You need to change the first and the last tables. Do not change the second table!! Please make sure Char2Html contains one entry (and only one entry) for each of the 256 ascii codes (with none left undefined) in the right order, and that Html2Char is sorted by html escape. If somebody generates new tables for national character sets, please send a copy to the author, so it can be included it in future versions of Embperl. =head1 Optimizing & Fine-Tuning =head2 How can I be sure that Embperl is re-compiling my page template (and the Perl blocks contained in it) only when needed, and not each time? As long as your input file's time stamp stays the same, Embperl will only compile the script the first time it's called. When you use the Execute function, Embperl will recompile the script only if the input file and mtime paramenters have changed since the last time the script was called. You can verfiy this by setting dbgDefEval. Now, every time a Perl block is compiled, Embperl logs a line starting with DEF:. You will see this line only on the first request. The cached Perl blocks are stored as a set of subroutines in the namespace of the document. (HTML::Embperl::DOC::_ is the default) Look at the logfile to see the actual name. =head2 How can I pre-compile pages, so that each httpd child doesn't have to have its own separate copies of the pre-compiled pages? To pre-compile pages, just call Execute once for every file at server startup in your startup.pl file. =head2 In what namespace does Embperl store pre-compiled data? The cached Perl blocks are stored as a set of subroutines in the namespace of the document. (HTML::Embperl::DOC::_ for default) Look at the logfile to see the actual name. =head2 I have both Embperl and ordinary Perl processes running. The docs say that Embperl uses a CGI.pm instance in its own internal processing, but they don't say how to control it. How can I get Embperl to use *my* CGI.pm object instead of creating its own? Embperl only creates a CGI objects to process multipart form data (from fileupload). In all other cases Embperl doesn't use CGI.pm =head1 Additional Help =head2 Where can I get more help? You can get free support on the mod_perl mailing list. If you need commercial support (with a guarantee for response time or a solution) for Embperl, or if you want a web site where you can run your Embperl/mod_perl scripts without setting up your own web server, please send email to info@ecos.de. Please also see the section L in the Embperl documentation. =head1 SEE ALSO some links here =head1 AUTHOR Gerald Richter Edited by Nora Mikes