When working with Apache::Registry it is very easy to create accidental closures.
This is due to the way Apache::Registry makes a fake package for your script, as I'll demonstrate in this tutorial.
The only indication that something is amiss (other than the unpredictable behaviour) will be the following line in your error log: Variable "$foo" will not stay shared at ...
The following code demonstrates the problem with accidental closures when using Apache::Registry.
use strict;
use warnings;
my $foo = 5;
print "Content-type: text/plain\n";
print "Content-disposition: inline; filename=foo.txt\n\n";
printf "Package: %s\n", __PACKAGE__;
printf "[%s] Before: %s\n", $$, $foo;
badness(5);
printf "[%s] After: %s\n", $$, $foo;
sub badness {
my $val = shift;
printf "[%s] badness: %s\n", $$, $foo;
$foo += $val;
}
Apache::Registry will take the above code and create a new package for it based on the ServerName and the name of the script,
and then wrap the code in a sub handler {} block.
If your script is running on "foo.com" and is named "test.pl", then this is what the above code will look like after Apache::Registry is done:
package Apache::ROOTfoo_2ecom::test_2epl;
use Apache qw(exit);
sub handler {
#line 1 /www/foo.com/test.pl
use strict;
use warnings;
my $foo = 5;
print "Content-type: text/plain\n";
print "Content-disposition: inline; filename=foo.txt\n\n";
printf "Package: %s\n", __PACKAGE__;
printf "[%s] Before: %s\n", $$, $foo;
badness(5);
printf "[%s] After: %s\n", $$, $foo;
sub badness {
my $val = shift;
printf "[%s] badness: %s\n", $$, $foo;
$foo += $val;
}
}
First run:
Package: Apache::ROOTfoo_2ecom::test_2epl
[13520] Before: 5
[13520] badness: 5
[13520] After: 10
Second:
Package: Apache::ROOTfoo_2ecom::test_2epl
[19331] Before: 5
[19331] badness: 5
[19331] After: 10
Third:
Package: Apache::ROOTfoo_2ecom::test_2epl
[19331] Before: 5
[19331] badness: 10
[19331] After: 5
Fourth:
Package: Apache::ROOTfoo_2ecom::test_2epl
[19331] Before: 5
[19331] badness: 15
[19331] After: 5
Notice how the number within the badness sub is increasing for each process, but the $foo that is seen by the instance script is never modified after 'badness' after the first execution for that process.
This is because the badness function is actually an inner function now,
and it keeps a reference to the instance of $foo that was created for the
first run.
Edit - example of how to avoid this issue added, per rhesa's suggestion
Thankfully it is easy to avoid these problems once you know why they occur.
Tips:
- Keep your toplevel script minimal
- Subroutines should only use the variables that were passed
- Encapsulate behaviour in supporting objects
Example of a working alternative:
use strict;
use warnings;
my $foo = 5;
print "Content-type: text/plain\n";
print "Content-disposition: inline; filename=foo.txt\n\n";
printf "Package: %s\n", __PACKAGE__;
printf "[%s] Before: %s\n", $$, $foo;
badness(\$foo, 5);
badness(\$foo, 5);
printf "[%s] After: %s\n", $$, $foo;
sub badness {
my ($foo,$val) = @_;
printf "[%s] badness: %s\n", $$, $$foo;
$$foo += $val;
}
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.