summaryrefslogtreecommitdiffstats
path: root/Bugzilla
diff options
context:
space:
mode:
authormkanat%bugzilla.org <>2009-11-24 12:50:26 +0100
committermkanat%bugzilla.org <>2009-11-24 12:50:26 +0100
commit823e59691fc7224ecca6d95076996fe38383bd64 (patch)
treefe3dd11d569075456ab04fc12cc08a56c1ab749f /Bugzilla
parentb04aed85ba343e3dcc74ebde6fc72d5ab129b817 (diff)
downloadbugzilla-823e59691fc7224ecca6d95076996fe38383bd64.tar.gz
bugzilla-823e59691fc7224ecca6d95076996fe38383bd64.tar.xz
Bug 430013: Make extensions load their modules like Bugzilla::Extension::Foo::Bar, where Bar.pm is in extensions/Foo/lib/.
Patch by Max Kanat-Alexander <mkanat@bugzilla.org> (module owner) a=mkanat
Diffstat (limited to 'Bugzilla')
-rw-r--r--Bugzilla/Extension.pm103
-rw-r--r--Bugzilla/Hook.pm5
2 files changed, 96 insertions, 12 deletions
diff --git a/Bugzilla/Extension.pm b/Bugzilla/Extension.pm
index 1046e09ae..08d5c86c3 100644
--- a/Bugzilla/Extension.pm
+++ b/Bugzilla/Extension.pm
@@ -26,7 +26,8 @@ use Bugzilla::Constants;
use Bugzilla::Error;
use Bugzilla::Install::Util qw(extension_code_files);
-use File::Basename qw(basename);
+use File::Basename;
+use File::Spec;
####################
# Subclass Methods #
@@ -45,18 +46,42 @@ sub new {
sub load {
my ($class, $extension_file, $config_file) = @_;
- require $config_file if $config_file;
-
my $package;
+
# This is needed during checksetup.pl, because Extension packages can
# only be loaded once (they return "1" the second time they're loaded,
- # instead of their name). If an extension has only an Extension.pm,
- # and no Config.pm, the Extension.pm gets loaded by
- # Bugzilla::Install::Requirements before this load() method is ever
- # called.
+ # instead of their name). During checksetup.pl, extensions are loaded
+ # once by Bugzilla::Install::Requirements, and then later again via
+ # Bugzilla->extensions (because of hooks).
my $map = Bugzilla->request_cache->{extension_requirement_package_map};
+
+ if ($config_file) {
+ if ($map and defined $map->{$config_file}) {
+ $package = $map->{$config_file};
+ }
+ else {
+ my $name = require $config_file;
+ if ($name =~ /^\d+$/) {
+ ThrowCodeError('extension_must_return_name',
+ { extension => $config_file,
+ returned => $name });
+ }
+ $package = "${class}::$name";
+ }
+
+ # This allows people to override modify_inc in Config.pm, if they
+ # want to.
+ if ($package->can('modify_inc')) {
+ $package->modify_inc($config_file);
+ }
+ else {
+ modify_inc($package, $config_file);
+ }
+ }
+
if ($map and defined $map->{$extension_file}) {
$package = $map->{$extension_file};
+ $package->modify_inc($extension_file) if !$config_file;
}
else {
my $name = require $extension_file;
@@ -65,6 +90,7 @@ sub load {
{ extension => $extension_file, returned => $name });
}
$package = "${class}::$name";
+ $package->modify_inc($extension_file) if !$config_file;
}
if (!eval { $package->NAME }) {
@@ -94,6 +120,45 @@ sub load_all {
return \@packages;
}
+# Modifies @INC so that extensions can use modules like
+# "use Bugzilla::Extension::Foo::Bar", when Bar.pm is in the lib/
+# directory of the extension.
+sub modify_inc {
+ my ($class, $file) = @_;
+ my $lib_dir = File::Spec->catdir(dirname($file), 'lib');
+ # Allow Config.pm to override my_inc, if it wants to.
+ if ($class->can('my_inc')) {
+ unshift(@INC, sub { $class->my_inc($lib_dir, @_); });
+ }
+ else {
+ unshift(@INC, sub { my_inc($class, $lib_dir, @_); });
+ }
+}
+
+# This is what gets put into @INC by modify_inc.
+sub my_inc {
+ my ($class, $lib_dir, undef, $file) = @_;
+ my @class_parts = split('::', $class);
+ my ($vol, $dir, $file_name) = File::Spec->splitpath($file);
+ my @dir_parts = File::Spec->splitdir($dir);
+ # Validate that this is a sub-package of Bugzilla::Extension::Foo ($class).
+ for (my $i = 0; $i < scalar(@class_parts); $i++) {
+ return if !@dir_parts;
+ if (File::Spec->case_tolerant) {
+ return if lc($class_parts[$i]) ne lc($dir_parts[0]);
+ }
+ else {
+ return if $class_parts[$i] ne $dir_parts[0];
+ }
+ shift(@dir_parts);
+ }
+ # For Bugzilla::Extension::Foo::Bar, this would look something like
+ # extensions/Example/lib/Bar.pm
+ my $resolved_path = File::Spec->catfile($lib_dir, @dir_parts, $file_name);
+ open(my $fh, '<', $resolved_path);
+ return $fh;
+}
+
####################
# Instance Methods #
####################
@@ -298,6 +363,30 @@ your extension is a single file named C<Foo.pm>.
If any of this is confusing, just look at the code of the Example extension.
It uses this method to specify requirements.
+=head2 Libraries
+
+Extensions often want to have their own Perl modules. Your extension
+can load any Perl module in its F<lib/> directory. (So, if your extension is
+F<extensions/Foo/>, then your Perl modules go into F<extensions/Foo/lib/>.)
+
+However, the C<package> name of your libraries will not work quite
+like normal Perl modules do. F<extensions/Foo/lib/Bar.pm> is
+loaded as C<Bugzilla::Extension::Foo::Bar>. Or, to say it another way,
+C<use Bugzilla::Extension::Foo::Bar;> loads F<extensions/Foo/lib/Bar.pm>,
+which should have C<package Bugzilla::Extension::Foo::Bar;> as its package
+name.
+
+This allows any place in Bugzilla to load your modules, which is important
+for some hooks. It even allows other extensions to load your modules. It
+even allows you to install your modules into the global Perl install
+as F<Bugzilla/Extension/Foo/Bar.pm>, if you'd like, which helps allow CPAN
+distribution of Bugzilla extensions.
+
+B<Note:> If you want to C<use> or C<require> a module that's in
+F<extensions/Foo/lib/> at the top level of your F<Extension.pm>,
+you must have a F<Config.pm> (see above) with at least the C<NAME>
+constant defined in it.
+
=head2 Disabling Your Extension
If you want your extension to be totally ignored by Bugzilla (it will
diff --git a/Bugzilla/Hook.pm b/Bugzilla/Hook.pm
index 26e3a30e5..d29d4cf86 100644
--- a/Bugzilla/Hook.pm
+++ b/Bugzilla/Hook.pm
@@ -22,15 +22,10 @@
package Bugzilla::Hook;
use strict;
-use Bugzilla::Constants;
sub process {
my ($name, $args) = @_;
foreach my $extension (@{ Bugzilla->extensions }) {
- local @INC = @INC;
- my $ext_dir = bz_locations()->{'extensionsdir'};
- my $ext_name = $extension->NAME;
- unshift(@INC, "$ext_dir/$ext_name/lib");
if ($extension->can($name)) {
$extension->$name($args);
}