perl-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ryan Gies <r...@livesite.net>
Subject [Patch] Apache2::Reload
Date Fri, 28 Aug 2009 12:35:28 GMT
This patch for Apache2::Reload does two things:

  A) ignores require-hooks which exist in %INC. (fix)
  B) reloads by file, not module name (fix?)

I consider B) to be a fix because I cannot imagine why anyone would
want the previous functionality.  As such, the accompanying
configuration variable 'ReloadByModuleName' is used to enabled the old
behavior (as opposed to enabling the new behavior).

I was asked to include this patch inline in this email, however I know
the line-breaks will clobber the diff output, so I have attached it as
well.

Cheers,
-Ryan

--- Apache2/Reload.pm	2009-08-12 10:35:04.000000000 -0400
+++ Apache2/Reload.pm.v0.11	2009-08-28 08:28:25.000000000 -0400
@@ -20,7 +20,7 @@
 
 use mod_perl2;
 
-our $VERSION = '0.10';
+our $VERSION = '0.11';
 
 use Apache2::Const -compile => qw(OK);
 
@@ -86,6 +86,8 @@
 
     my $DEBUG = ref($o) && (lc($o->dir_config("ReloadDebug") || '') eq
'on'); 
+    my $ReloadByModuleName = ref($o) &&
(lc($o->dir_config("ReloadByModuleName") || '') eq 'on'); +
     my $TouchFile = ref($o) && $o->dir_config("ReloadTouchFile");
 
     my $ConstantRedefineWarnings = ref($o) && 
@@ -138,6 +140,9 @@
         my $file = $Apache2::Reload::INCS{$key};
 
         next unless defined $file;
+        # TODO when $file is a hook, call the hook like require does
to 
+        # determine the path (obtain a file handle). See %INC in
perlvar.
+        next if ref $file;
         next if @watch_dirs && !grep { $file =~ /^$_/ } @watch_dirs;
         warn "Apache2::Reload: Checking mtime of $key\n" if $DEBUG;
 
@@ -158,24 +163,27 @@
         }
 
         if ($mtime > $Stat{$file}) {
-            push @changed, $key;
+            push @changed, [$key, $file];
         }
         $Stat{$file} = $mtime;
     }
     
     #First, let's unload all changed modules
-    foreach my $module (@changed) {
-        my $package = module_to_package($module);
+    foreach my $kvpair (@changed) {
+        my $package = module_to_package($kvpair->[0]);
         ModPerl::Util::unload_package($package);
     }
-    
-    #Then, let's reload them all, so that module dependencies can
satisfy
-    #themselves in the correct order.
-    foreach my $module (@changed) {
-        my $package = module_to_package($module);
-        require $module;
-        warn("Apache2::Reload: process $$ reloading $package from
$module\n")
-            if $DEBUG;
+
+    #Then, let's reload each changed file, so that module dependencies
can 
+    #satisfy themselves in the correct order.
+    foreach my $kvpair (@changed) {
+        my $name = $ReloadByModuleName ? $kvpair->[0] : $kvpair->[1];
+        require $name;
+        if ($DEBUG) {
+          my $package = module_to_package($kvpair->[0]);
+          warn sprintf("Apache2::Reload: process %d reloading %s from
%s\n",
+            $$, $package, $kvpair->[1]);
+        }
     }
 
     return Apache2::Const::OK;
@@ -206,6 +214,7 @@
   PerlSetVar ReloadAll Off
   PerlSetVar ReloadModules "ModPerl::* Apache2::*"
   #PerlSetVar ReloadDebug On
+  #PerlSetVar ReloadByModuleName On
   
   # Reload a single module from within itself:
   package My::Apache2::Module;
@@ -226,16 +235,28 @@
 also do the check for modified modules, when a special touch-file has
 been modified.
 
-Note that C<Apache2::Reload> operates on the current context of
-C<@INC>.  Which means, when called as a C<Perl*Handler> it will not
-see C<@INC> paths added or removed by C<ModPerl::Registry> scripts, as
-the value of C<@INC> is saved on server startup and restored to that
-value after each request.  In other words, if you want
-C<Apache2::Reload> to work with modules that live in custom C<@INC>
-paths, you should modify C<@INC> when the server is started.  Besides,
-C<'use lib'> in the startup script, you can also set the C<PERL5LIB>
-variable in the httpd's environment to include any non-standard 'lib'
-directories that you choose.  For example, to accomplish that you can
+Require-hooks, i.e., entries in %INC which are references, are
ignored.  The +hook should modify %INC itself, adding the path to the
module file, for it to +be reloaded.
+
+C<Apache2::Reload> inspects and reloads the B<file> associated with a
given +module.  Changes to @INC are not recognized, as it is the file
which is +being re-required, not the module name.
+
+In version 0.10 and earlier the B<module name>, not the file, is
re-required. +Meaning it operated on the the current context of @INC.
If you still want this +behavior set this environment variable in
I<httpd.conf>: +
+  PerlSetVar ReloadByModuleName On
+
+This means, when called as a C<Perl*Handler>, C<Apache2::Reload> will
not see +C<@INC> paths added or removed by C<ModPerl::Registry>
scripts, as the value of +C<@INC> is saved on server startup and
restored to that value after each +request.  In other words, if you
want C<Apache2::Reload> to work with modules +that live in custom
C<@INC> paths, you should modify C<@INC> when the server is +started.
Besides, C<'use lib'> in the startup script, you can also set the
+C<PERL5LIB> variable in the httpd's environment to include any
non-standard +'lib' directories that you choose.  For example, to
accomplish that you can include a line: 
   PERL5LIB=/home/httpd/perl/extra; export PERL5LIB
Mime
View raw message