[Bps-public-commit] RT-Extension-ListAllEmailRecipients branch, master, created. a4dd4734e3a3ec418c34e090b1e6c00e3b54a5e6
Shawn Moore
shawn at bestpractical.com
Fri Mar 10 13:47:21 EST 2017
The branch, master has been created
at a4dd4734e3a3ec418c34e090b1e6c00e3b54a5e6 (commit)
- Log -----------------------------------------------------------------
commit 6d599aa5446985834f6ea4c4774941b0eae9361d
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Tue Nov 29 16:35:54 2016 -0500
Copy of ListEmailRecipients
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..3fd5259
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,14 @@
+blib*
+Makefile
+Makefile.old
+pm_to_blib*
+*.tar.gz
+.lwpcookies
+cover_db
+pod2htm*.tmp
+/RT-Extension-ListAllEmailRecipients*
+*.bak
+*.swp
+/MYMETA.*
+/t/tmp
+/xt/tmp
diff --git a/Changes b/Changes
new file mode 100644
index 0000000..55e3faa
--- /dev/null
+++ b/Changes
@@ -0,0 +1,4 @@
+Revision history for RT-Extension-ListAllEmailRecipients
+
+0.01
+ - Initial version
diff --git a/MANIFEST b/MANIFEST
new file mode 100644
index 0000000..b1a8da2
--- /dev/null
+++ b/MANIFEST
@@ -0,0 +1,24 @@
+Changes
+inc/Module/Install.pm
+inc/Module/Install/Base.pm
+inc/Module/Install/Can.pm
+inc/Module/Install/Fetch.pm
+inc/Module/Install/Include.pm
+inc/Module/Install/Makefile.pm
+inc/Module/Install/Metadata.pm
+inc/Module/Install/ReadmeFromPod.pm
+inc/Module/Install/RTx.pm
+inc/Module/Install/RTx/Runtime.pm
+inc/Module/Install/Substitute.pm
+inc/Module/Install/Win32.pm
+inc/Module/Install/WriteAll.pm
+inc/YAML/Tiny.pm
+lib/RT/Action/Notify_Vendor.pm
+lib/RT/Extension/ListAllEmailRecipients.pm
+lib/RT/Extension/ListAllEmailRecipients/Test.pm
+lib/RT/Extension/ListAllEmailRecipients/Test.pm.in
+Makefile.PL
+MANIFEST This list of files
+META.yml
+README
+xt/basic.t
diff --git a/META.yml b/META.yml
new file mode 100644
index 0000000..d3c4fc6
--- /dev/null
+++ b/META.yml
@@ -0,0 +1,28 @@
+---
+abstract: 'RT-Extension-ListAllEmailRecipients Extension'
+author:
+ - 'Best Practical Solutions, LLC <modules at bestpractical.com>'
+build_requires:
+ ExtUtils::MakeMaker: 6.59
+configure_requires:
+ ExtUtils::MakeMaker: 6.59
+distribution_type: module
+dynamic_config: 1
+generated_by: 'Module::Install version 1.16'
+license: gplv2
+meta-spec:
+ url: http://module-build.sourceforge.net/META-spec-v1.4.html
+ version: 1.4
+name: RT-Extension-ListAllEmailRecipients
+no_index:
+ directory:
+ - inc
+ - xt
+requires:
+ perl: 5.10.1
+resources:
+ license: http://opensource.org/licenses/gpl-license.php
+ repository: https://github.com/bestpractical/rt-extension-listemailrecipients
+version: '0.03'
+x_module_install_rtx_version: '0.38'
+x_requires_rt: 4.2.0
diff --git a/Makefile.PL b/Makefile.PL
new file mode 100644
index 0000000..3146ddb
--- /dev/null
+++ b/Makefile.PL
@@ -0,0 +1,30 @@
+use inc::Module::Install;
+
+RTx 'RT-Extension-ListAllEmailRecipients';
+license 'gplv2';
+
+requires_rt '4.2.0';
+
+my ($lp) = ($INC{'RT.pm'} =~ /^(.*)[\\\/]/);
+my $lib_path = join( ' ', "$RT::LocalPath/lib", $lp );
+
+# Straight from perldoc perlvar
+use Config;
+my $secure_perl_path = $Config{perlpath};
+if ($^O ne 'VMS') {
+ $secure_perl_path .= $Config{_exe}
+ unless $secure_perl_path =~ m/$Config{_exe}$/i;
+}
+
+substitute(
+ {
+ RT_LIB_PATH => $lib_path,
+ PERL => $ENV{PERL} || $secure_perl_path,
+ },
+ {
+ sufix => '.in'
+ },
+ qw(lib/RT/Extension/ListAllEmailRecipients/Test.pm),
+);
+
+WriteAll;
diff --git a/README b/README
new file mode 100644
index 0000000..ecc4b46
--- /dev/null
+++ b/README
@@ -0,0 +1,60 @@
+NAME
+ RT-Extension-ListAllEmailRecipients - List email recipients in the body of
+ RT email
+
+DESCRIPTION
+ ListAllEmailRecipients searches for recipients in the headers on email
+ messages generated by RT and replaces a template placeholder with the
+ comma-delimited list of email recipients in the email message body.
+
+RT VERSION
+ Works with RT 4.2
+
+INSTALLATION
+ perl Makefile.PL
+ make
+ make install
+ May need root permissions
+
+ Edit your /opt/rt4/etc/RT_SiteConfig.pm
+ If you are using RT 4.2 or greater, add this line:
+
+ Plugin('RT::Extension::ListAllEmailRecipients');
+
+ Clear your mason cache
+ rm -rf /opt/rt4/var/mason_data/obj
+
+ Restart your webserver
+ Modify your templates as described below.
+
+USAGE
+ ListEmailReceipients adds functionality to any RT scrip that uses the
+ default 'Notify' action. For these notification scrips, you can add the
+ placeholder RT-INSERT-RECIPIENTS to your existing notification template
+ and it will be replace with a list of all recipients on that email when
+ RT sends out the notification.
+
+ For example, you could add this to your Correspondence template:
+
+ The following people received this email:
+ RT-INSERT-RECIPIENTS
+
+ and the resulting email will look like:
+
+ The following people received this email:
+ user1 at example.com, user2 at example.com
+
+AUTHOR
+ Best Practical Solutions, LLC <modules at bestpractical.com>
+
+BUGS
+ Contact Best Practical Solutions at contact at bestpractical.com with
+ questions about this extension.
+
+LICENSE AND COPYRIGHT
+ This software is Copyright (c) 2016 by Best Practical Solutions, LLC
+
+ This is free software, licensed under:
+
+ The GNU General Public License, Version 2, June 1991
+
diff --git a/inc/Module/Install.pm b/inc/Module/Install.pm
new file mode 100644
index 0000000..f44ab4d
--- /dev/null
+++ b/inc/Module/Install.pm
@@ -0,0 +1,474 @@
+#line 1
+package Module::Install;
+
+# For any maintainers:
+# The load order for Module::Install is a bit magic.
+# It goes something like this...
+#
+# IF ( host has Module::Install installed, creating author mode ) {
+# 1. Makefile.PL calls "use inc::Module::Install"
+# 2. $INC{inc/Module/Install.pm} set to installed version of inc::Module::Install
+# 3. The installed version of inc::Module::Install loads
+# 4. inc::Module::Install calls "require Module::Install"
+# 5. The ./inc/ version of Module::Install loads
+# } ELSE {
+# 1. Makefile.PL calls "use inc::Module::Install"
+# 2. $INC{inc/Module/Install.pm} set to ./inc/ version of Module::Install
+# 3. The ./inc/ version of Module::Install loads
+# }
+
+use 5.006;
+use strict 'vars';
+use Cwd ();
+use File::Find ();
+use File::Path ();
+
+use vars qw{$VERSION $MAIN};
+BEGIN {
+ # All Module::Install core packages now require synchronised versions.
+ # This will be used to ensure we don't accidentally load old or
+ # different versions of modules.
+ # This is not enforced yet, but will be some time in the next few
+ # releases once we can make sure it won't clash with custom
+ # Module::Install extensions.
+ $VERSION = '1.16';
+
+ # Storage for the pseudo-singleton
+ $MAIN = undef;
+
+ *inc::Module::Install::VERSION = *VERSION;
+ @inc::Module::Install::ISA = __PACKAGE__;
+
+}
+
+sub import {
+ my $class = shift;
+ my $self = $class->new(@_);
+ my $who = $self->_caller;
+
+ #-------------------------------------------------------------
+ # all of the following checks should be included in import(),
+ # to allow "eval 'require Module::Install; 1' to test
+ # installation of Module::Install. (RT #51267)
+ #-------------------------------------------------------------
+
+ # Whether or not inc::Module::Install is actually loaded, the
+ # $INC{inc/Module/Install.pm} is what will still get set as long as
+ # the caller loaded module this in the documented manner.
+ # If not set, the caller may NOT have loaded the bundled version, and thus
+ # they may not have a MI version that works with the Makefile.PL. This would
+ # result in false errors or unexpected behaviour. And we don't want that.
+ my $file = join( '/', 'inc', split /::/, __PACKAGE__ ) . '.pm';
+ unless ( $INC{$file} ) { die <<"END_DIE" }
+
+Please invoke ${\__PACKAGE__} with:
+
+ use inc::${\__PACKAGE__};
+
+not:
+
+ use ${\__PACKAGE__};
+
+END_DIE
+
+ # This reportedly fixes a rare Win32 UTC file time issue, but
+ # as this is a non-cross-platform XS module not in the core,
+ # we shouldn't really depend on it. See RT #24194 for detail.
+ # (Also, this module only supports Perl 5.6 and above).
+ eval "use Win32::UTCFileTime" if $^O eq 'MSWin32' && $] >= 5.006;
+
+ # If the script that is loading Module::Install is from the future,
+ # then make will detect this and cause it to re-run over and over
+ # again. This is bad. Rather than taking action to touch it (which
+ # is unreliable on some platforms and requires write permissions)
+ # for now we should catch this and refuse to run.
+ if ( -f $0 ) {
+ my $s = (stat($0))[9];
+
+ # If the modification time is only slightly in the future,
+ # sleep briefly to remove the problem.
+ my $a = $s - time;
+ if ( $a > 0 and $a < 5 ) { sleep 5 }
+
+ # Too far in the future, throw an error.
+ my $t = time;
+ if ( $s > $t ) { die <<"END_DIE" }
+
+Your installer $0 has a modification time in the future ($s > $t).
+
+This is known to create infinite loops in make.
+
+Please correct this, then run $0 again.
+
+END_DIE
+ }
+
+
+ # Build.PL was formerly supported, but no longer is due to excessive
+ # difficulty in implementing every single feature twice.
+ if ( $0 =~ /Build.PL$/i ) { die <<"END_DIE" }
+
+Module::Install no longer supports Build.PL.
+
+It was impossible to maintain duel backends, and has been deprecated.
+
+Please remove all Build.PL files and only use the Makefile.PL installer.
+
+END_DIE
+
+ #-------------------------------------------------------------
+
+ # To save some more typing in Module::Install installers, every...
+ # use inc::Module::Install
+ # ...also acts as an implicit use strict.
+ $^H |= strict::bits(qw(refs subs vars));
+
+ #-------------------------------------------------------------
+
+ unless ( -f $self->{file} ) {
+ foreach my $key (keys %INC) {
+ delete $INC{$key} if $key =~ /Module\/Install/;
+ }
+
+ local $^W;
+ require "$self->{path}/$self->{dispatch}.pm";
+ File::Path::mkpath("$self->{prefix}/$self->{author}");
+ $self->{admin} = "$self->{name}::$self->{dispatch}"->new( _top => $self );
+ $self->{admin}->init;
+ @_ = ($class, _self => $self);
+ goto &{"$self->{name}::import"};
+ }
+
+ local $^W;
+ *{"${who}::AUTOLOAD"} = $self->autoload;
+ $self->preload;
+
+ # Unregister loader and worker packages so subdirs can use them again
+ delete $INC{'inc/Module/Install.pm'};
+ delete $INC{'Module/Install.pm'};
+
+ # Save to the singleton
+ $MAIN = $self;
+
+ return 1;
+}
+
+sub autoload {
+ my $self = shift;
+ my $who = $self->_caller;
+ my $cwd = Cwd::getcwd();
+ my $sym = "${who}::AUTOLOAD";
+ $sym->{$cwd} = sub {
+ my $pwd = Cwd::getcwd();
+ if ( my $code = $sym->{$pwd} ) {
+ # Delegate back to parent dirs
+ goto &$code unless $cwd eq $pwd;
+ }
+ unless ($$sym =~ s/([^:]+)$//) {
+ # XXX: it looks like we can't retrieve the missing function
+ # via $$sym (usually $main::AUTOLOAD) in this case.
+ # I'm still wondering if we should slurp Makefile.PL to
+ # get some context or not ...
+ my ($package, $file, $line) = caller;
+ die <<"EOT";
+Unknown function is found at $file line $line.
+Execution of $file aborted due to runtime errors.
+
+If you're a contributor to a project, you may need to install
+some Module::Install extensions from CPAN (or other repository).
+If you're a user of a module, please contact the author.
+EOT
+ }
+ my $method = $1;
+ if ( uc($method) eq $method ) {
+ # Do nothing
+ return;
+ } elsif ( $method =~ /^_/ and $self->can($method) ) {
+ # Dispatch to the root M:I class
+ return $self->$method(@_);
+ }
+
+ # Dispatch to the appropriate plugin
+ unshift @_, ( $self, $1 );
+ goto &{$self->can('call')};
+ };
+}
+
+sub preload {
+ my $self = shift;
+ unless ( $self->{extensions} ) {
+ $self->load_extensions(
+ "$self->{prefix}/$self->{path}", $self
+ );
+ }
+
+ my @exts = @{$self->{extensions}};
+ unless ( @exts ) {
+ @exts = $self->{admin}->load_all_extensions;
+ }
+
+ my %seen;
+ foreach my $obj ( @exts ) {
+ while (my ($method, $glob) = each %{ref($obj) . '::'}) {
+ next unless $obj->can($method);
+ next if $method =~ /^_/;
+ next if $method eq uc($method);
+ $seen{$method}++;
+ }
+ }
+
+ my $who = $self->_caller;
+ foreach my $name ( sort keys %seen ) {
+ local $^W;
+ *{"${who}::$name"} = sub {
+ ${"${who}::AUTOLOAD"} = "${who}::$name";
+ goto &{"${who}::AUTOLOAD"};
+ };
+ }
+}
+
+sub new {
+ my ($class, %args) = @_;
+
+ delete $INC{'FindBin.pm'};
+ {
+ # to suppress the redefine warning
+ local $SIG{__WARN__} = sub {};
+ require FindBin;
+ }
+
+ # ignore the prefix on extension modules built from top level.
+ my $base_path = Cwd::abs_path($FindBin::Bin);
+ unless ( Cwd::abs_path(Cwd::getcwd()) eq $base_path ) {
+ delete $args{prefix};
+ }
+ return $args{_self} if $args{_self};
+
+ $args{dispatch} ||= 'Admin';
+ $args{prefix} ||= 'inc';
+ $args{author} ||= ($^O eq 'VMS' ? '_author' : '.author');
+ $args{bundle} ||= 'inc/BUNDLES';
+ $args{base} ||= $base_path;
+ $class =~ s/^\Q$args{prefix}\E:://;
+ $args{name} ||= $class;
+ $args{version} ||= $class->VERSION;
+ unless ( $args{path} ) {
+ $args{path} = $args{name};
+ $args{path} =~ s!::!/!g;
+ }
+ $args{file} ||= "$args{base}/$args{prefix}/$args{path}.pm";
+ $args{wrote} = 0;
+
+ bless( \%args, $class );
+}
+
+sub call {
+ my ($self, $method) = @_;
+ my $obj = $self->load($method) or return;
+ splice(@_, 0, 2, $obj);
+ goto &{$obj->can($method)};
+}
+
+sub load {
+ my ($self, $method) = @_;
+
+ $self->load_extensions(
+ "$self->{prefix}/$self->{path}", $self
+ ) unless $self->{extensions};
+
+ foreach my $obj (@{$self->{extensions}}) {
+ return $obj if $obj->can($method);
+ }
+
+ my $admin = $self->{admin} or die <<"END_DIE";
+The '$method' method does not exist in the '$self->{prefix}' path!
+Please remove the '$self->{prefix}' directory and run $0 again to load it.
+END_DIE
+
+ my $obj = $admin->load($method, 1);
+ push @{$self->{extensions}}, $obj;
+
+ $obj;
+}
+
+sub load_extensions {
+ my ($self, $path, $top) = @_;
+
+ my $should_reload = 0;
+ unless ( grep { ! ref $_ and lc $_ eq lc $self->{prefix} } @INC ) {
+ unshift @INC, $self->{prefix};
+ $should_reload = 1;
+ }
+
+ foreach my $rv ( $self->find_extensions($path) ) {
+ my ($file, $pkg) = @{$rv};
+ next if $self->{pathnames}{$pkg};
+
+ local $@;
+ my $new = eval { local $^W; require $file; $pkg->can('new') };
+ unless ( $new ) {
+ warn $@ if $@;
+ next;
+ }
+ $self->{pathnames}{$pkg} =
+ $should_reload ? delete $INC{$file} : $INC{$file};
+ push @{$self->{extensions}}, &{$new}($pkg, _top => $top );
+ }
+
+ $self->{extensions} ||= [];
+}
+
+sub find_extensions {
+ my ($self, $path) = @_;
+
+ my @found;
+ File::Find::find( sub {
+ my $file = $File::Find::name;
+ return unless $file =~ m!^\Q$path\E/(.+)\.pm\Z!is;
+ my $subpath = $1;
+ return if lc($subpath) eq lc($self->{dispatch});
+
+ $file = "$self->{path}/$subpath.pm";
+ my $pkg = "$self->{name}::$subpath";
+ $pkg =~ s!/!::!g;
+
+ # If we have a mixed-case package name, assume case has been preserved
+ # correctly. Otherwise, root through the file to locate the case-preserved
+ # version of the package name.
+ if ( $subpath eq lc($subpath) || $subpath eq uc($subpath) ) {
+ my $content = Module::Install::_read($subpath . '.pm');
+ my $in_pod = 0;
+ foreach ( split /\n/, $content ) {
+ $in_pod = 1 if /^=\w/;
+ $in_pod = 0 if /^=cut/;
+ next if ($in_pod || /^=cut/); # skip pod text
+ next if /^\s*#/; # and comments
+ if ( m/^\s*package\s+($pkg)\s*;/i ) {
+ $pkg = $1;
+ last;
+ }
+ }
+ }
+
+ push @found, [ $file, $pkg ];
+ }, $path ) if -d $path;
+
+ @found;
+}
+
+
+
+
+
+#####################################################################
+# Common Utility Functions
+
+sub _caller {
+ my $depth = 0;
+ my $call = caller($depth);
+ while ( $call eq __PACKAGE__ ) {
+ $depth++;
+ $call = caller($depth);
+ }
+ return $call;
+}
+
+# Done in evals to avoid confusing Perl::MinimumVersion
+eval( $] >= 5.006 ? <<'END_NEW' : <<'END_OLD' ); die $@ if $@;
+sub _read {
+ local *FH;
+ open( FH, '<', $_[0] ) or die "open($_[0]): $!";
+ binmode FH;
+ my $string = do { local $/; <FH> };
+ close FH or die "close($_[0]): $!";
+ return $string;
+}
+END_NEW
+sub _read {
+ local *FH;
+ open( FH, "< $_[0]" ) or die "open($_[0]): $!";
+ binmode FH;
+ my $string = do { local $/; <FH> };
+ close FH or die "close($_[0]): $!";
+ return $string;
+}
+END_OLD
+
+sub _readperl {
+ my $string = Module::Install::_read($_[0]);
+ $string =~ s/(?:\015{1,2}\012|\015|\012)/\n/sg;
+ $string =~ s/(\n)\n*__(?:DATA|END)__\b.*\z/$1/s;
+ $string =~ s/\n\n=\w+.+?\n\n=cut\b.+?\n+/\n\n/sg;
+ return $string;
+}
+
+sub _readpod {
+ my $string = Module::Install::_read($_[0]);
+ $string =~ s/(?:\015{1,2}\012|\015|\012)/\n/sg;
+ return $string if $_[0] =~ /\.pod\z/;
+ $string =~ s/(^|\n=cut\b.+?\n+)[^=\s].+?\n(\n=\w+|\z)/$1$2/sg;
+ $string =~ s/\n*=pod\b[^\n]*\n+/\n\n/sg;
+ $string =~ s/\n*=cut\b[^\n]*\n+/\n\n/sg;
+ $string =~ s/^\n+//s;
+ return $string;
+}
+
+# Done in evals to avoid confusing Perl::MinimumVersion
+eval( $] >= 5.006 ? <<'END_NEW' : <<'END_OLD' ); die $@ if $@;
+sub _write {
+ local *FH;
+ open( FH, '>', $_[0] ) or die "open($_[0]): $!";
+ binmode FH;
+ foreach ( 1 .. $#_ ) {
+ print FH $_[$_] or die "print($_[0]): $!";
+ }
+ close FH or die "close($_[0]): $!";
+}
+END_NEW
+sub _write {
+ local *FH;
+ open( FH, "> $_[0]" ) or die "open($_[0]): $!";
+ binmode FH;
+ foreach ( 1 .. $#_ ) {
+ print FH $_[$_] or die "print($_[0]): $!";
+ }
+ close FH or die "close($_[0]): $!";
+}
+END_OLD
+
+# _version is for processing module versions (eg, 1.03_05) not
+# Perl versions (eg, 5.8.1).
+sub _version {
+ my $s = shift || 0;
+ my $d =()= $s =~ /(\.)/g;
+ if ( $d >= 2 ) {
+ # Normalise multipart versions
+ $s =~ s/(\.)(\d{1,3})/sprintf("$1%03d",$2)/eg;
+ }
+ $s =~ s/^(\d+)\.?//;
+ my $l = $1 || 0;
+ my @v = map {
+ $_ . '0' x (3 - length $_)
+ } $s =~ /(\d{1,3})\D?/g;
+ $l = $l . '.' . join '', @v if @v;
+ return $l + 0;
+}
+
+sub _cmp {
+ _version($_[1]) <=> _version($_[2]);
+}
+
+# Cloned from Params::Util::_CLASS
+sub _CLASS {
+ (
+ defined $_[0]
+ and
+ ! ref $_[0]
+ and
+ $_[0] =~ m/^[^\W\d]\w*(?:::\w+)*\z/s
+ ) ? $_[0] : undef;
+}
+
+1;
+
+# Copyright 2008 - 2012 Adam Kennedy.
diff --git a/inc/Module/Install/Base.pm b/inc/Module/Install/Base.pm
new file mode 100644
index 0000000..5762a74
--- /dev/null
+++ b/inc/Module/Install/Base.pm
@@ -0,0 +1,83 @@
+#line 1
+package Module::Install::Base;
+
+use strict 'vars';
+use vars qw{$VERSION};
+BEGIN {
+ $VERSION = '1.16';
+}
+
+# Suspend handler for "redefined" warnings
+BEGIN {
+ my $w = $SIG{__WARN__};
+ $SIG{__WARN__} = sub { $w };
+}
+
+#line 42
+
+sub new {
+ my $class = shift;
+ unless ( defined &{"${class}::call"} ) {
+ *{"${class}::call"} = sub { shift->_top->call(@_) };
+ }
+ unless ( defined &{"${class}::load"} ) {
+ *{"${class}::load"} = sub { shift->_top->load(@_) };
+ }
+ bless { @_ }, $class;
+}
+
+#line 61
+
+sub AUTOLOAD {
+ local $@;
+ my $func = eval { shift->_top->autoload } or return;
+ goto &$func;
+}
+
+#line 75
+
+sub _top {
+ $_[0]->{_top};
+}
+
+#line 90
+
+sub admin {
+ $_[0]->_top->{admin}
+ or
+ Module::Install::Base::FakeAdmin->new;
+}
+
+#line 106
+
+sub is_admin {
+ ! $_[0]->admin->isa('Module::Install::Base::FakeAdmin');
+}
+
+sub DESTROY {}
+
+package Module::Install::Base::FakeAdmin;
+
+use vars qw{$VERSION};
+BEGIN {
+ $VERSION = $Module::Install::Base::VERSION;
+}
+
+my $fake;
+
+sub new {
+ $fake ||= bless(\@_, $_[0]);
+}
+
+sub AUTOLOAD {}
+
+sub DESTROY {}
+
+# Restore warning handler
+BEGIN {
+ $SIG{__WARN__} = $SIG{__WARN__}->();
+}
+
+1;
+
+#line 159
diff --git a/inc/Module/Install/Can.pm b/inc/Module/Install/Can.pm
new file mode 100644
index 0000000..d859276
--- /dev/null
+++ b/inc/Module/Install/Can.pm
@@ -0,0 +1,154 @@
+#line 1
+package Module::Install::Can;
+
+use strict;
+use Config ();
+use ExtUtils::MakeMaker ();
+use Module::Install::Base ();
+
+use vars qw{$VERSION @ISA $ISCORE};
+BEGIN {
+ $VERSION = '1.16';
+ @ISA = 'Module::Install::Base';
+ $ISCORE = 1;
+}
+
+# check if we can load some module
+### Upgrade this to not have to load the module if possible
+sub can_use {
+ my ($self, $mod, $ver) = @_;
+ $mod =~ s{::|\\}{/}g;
+ $mod .= '.pm' unless $mod =~ /\.pm$/i;
+
+ my $pkg = $mod;
+ $pkg =~ s{/}{::}g;
+ $pkg =~ s{\.pm$}{}i;
+
+ local $@;
+ eval { require $mod; $pkg->VERSION($ver || 0); 1 };
+}
+
+# Check if we can run some command
+sub can_run {
+ my ($self, $cmd) = @_;
+
+ my $_cmd = $cmd;
+ return $_cmd if (-x $_cmd or $_cmd = MM->maybe_command($_cmd));
+
+ for my $dir ((split /$Config::Config{path_sep}/, $ENV{PATH}), '.') {
+ next if $dir eq '';
+ require File::Spec;
+ my $abs = File::Spec->catfile($dir, $cmd);
+ return $abs if (-x $abs or $abs = MM->maybe_command($abs));
+ }
+
+ return;
+}
+
+# Can our C compiler environment build XS files
+sub can_xs {
+ my $self = shift;
+
+ # Ensure we have the CBuilder module
+ $self->configure_requires( 'ExtUtils::CBuilder' => 0.27 );
+
+ # Do we have the configure_requires checker?
+ local $@;
+ eval "require ExtUtils::CBuilder;";
+ if ( $@ ) {
+ # They don't obey configure_requires, so it is
+ # someone old and delicate. Try to avoid hurting
+ # them by falling back to an older simpler test.
+ return $self->can_cc();
+ }
+
+ # Do we have a working C compiler
+ my $builder = ExtUtils::CBuilder->new(
+ quiet => 1,
+ );
+ unless ( $builder->have_compiler ) {
+ # No working C compiler
+ return 0;
+ }
+
+ # Write a C file representative of what XS becomes
+ require File::Temp;
+ my ( $FH, $tmpfile ) = File::Temp::tempfile(
+ "compilexs-XXXXX",
+ SUFFIX => '.c',
+ );
+ binmode $FH;
+ print $FH <<'END_C';
+#include "EXTERN.h"
+#include "perl.h"
+#include "XSUB.h"
+
+int main(int argc, char **argv) {
+ return 0;
+}
+
+int boot_sanexs() {
+ return 1;
+}
+
+END_C
+ close $FH;
+
+ # Can the C compiler access the same headers XS does
+ my @libs = ();
+ my $object = undef;
+ eval {
+ local $^W = 0;
+ $object = $builder->compile(
+ source => $tmpfile,
+ );
+ @libs = $builder->link(
+ objects => $object,
+ module_name => 'sanexs',
+ );
+ };
+ my $result = $@ ? 0 : 1;
+
+ # Clean up all the build files
+ foreach ( $tmpfile, $object, @libs ) {
+ next unless defined $_;
+ 1 while unlink;
+ }
+
+ return $result;
+}
+
+# Can we locate a (the) C compiler
+sub can_cc {
+ my $self = shift;
+ my @chunks = split(/ /, $Config::Config{cc}) or return;
+
+ # $Config{cc} may contain args; try to find out the program part
+ while (@chunks) {
+ return $self->can_run("@chunks") || (pop(@chunks), next);
+ }
+
+ return;
+}
+
+# Fix Cygwin bug on maybe_command();
+if ( $^O eq 'cygwin' ) {
+ require ExtUtils::MM_Cygwin;
+ require ExtUtils::MM_Win32;
+ if ( ! defined(&ExtUtils::MM_Cygwin::maybe_command) ) {
+ *ExtUtils::MM_Cygwin::maybe_command = sub {
+ my ($self, $file) = @_;
+ if ($file =~ m{^/cygdrive/}i and ExtUtils::MM_Win32->can('maybe_command')) {
+ ExtUtils::MM_Win32->maybe_command($file);
+ } else {
+ ExtUtils::MM_Unix->maybe_command($file);
+ }
+ }
+ }
+}
+
+1;
+
+__END__
+
+#line 236
diff --git a/inc/Module/Install/Fetch.pm b/inc/Module/Install/Fetch.pm
new file mode 100644
index 0000000..41d3517
--- /dev/null
+++ b/inc/Module/Install/Fetch.pm
@@ -0,0 +1,93 @@
+#line 1
+package Module::Install::Fetch;
+
+use strict;
+use Module::Install::Base ();
+
+use vars qw{$VERSION @ISA $ISCORE};
+BEGIN {
+ $VERSION = '1.16';
+ @ISA = 'Module::Install::Base';
+ $ISCORE = 1;
+}
+
+sub get_file {
+ my ($self, %args) = @_;
+ my ($scheme, $host, $path, $file) =
+ $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return;
+
+ if ( $scheme eq 'http' and ! eval { require LWP::Simple; 1 } ) {
+ $args{url} = $args{ftp_url}
+ or (warn("LWP support unavailable!\n"), return);
+ ($scheme, $host, $path, $file) =
+ $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return;
+ }
+
+ $|++;
+ print "Fetching '$file' from $host... ";
+
+ unless (eval { require Socket; Socket::inet_aton($host) }) {
+ warn "'$host' resolve failed!\n";
+ return;
+ }
+
+ return unless $scheme eq 'ftp' or $scheme eq 'http';
+
+ require Cwd;
+ my $dir = Cwd::getcwd();
+ chdir $args{local_dir} or return if exists $args{local_dir};
+
+ if (eval { require LWP::Simple; 1 }) {
+ LWP::Simple::mirror($args{url}, $file);
+ }
+ elsif (eval { require Net::FTP; 1 }) { eval {
+ # use Net::FTP to get past firewall
+ my $ftp = Net::FTP->new($host, Passive => 1, Timeout => 600);
+ $ftp->login("anonymous", 'anonymous at example.com');
+ $ftp->cwd($path);
+ $ftp->binary;
+ $ftp->get($file) or (warn("$!\n"), return);
+ $ftp->quit;
+ } }
+ elsif (my $ftp = $self->can_run('ftp')) { eval {
+ # no Net::FTP, fallback to ftp.exe
+ require FileHandle;
+ my $fh = FileHandle->new;
+
+ local $SIG{CHLD} = 'IGNORE';
+ unless ($fh->open("|$ftp -n")) {
+ warn "Couldn't open ftp: $!\n";
+ chdir $dir; return;
+ }
+
+ my @dialog = split(/\n/, <<"END_FTP");
+open $host
+user anonymous anonymous\@example.com
+cd $path
+binary
+get $file $file
+quit
+END_FTP
+ foreach (@dialog) { $fh->print("$_\n") }
+ $fh->close;
+ } }
+ else {
+ warn "No working 'ftp' program available!\n";
+ chdir $dir; return;
+ }
+
+ unless (-f $file) {
+ warn "Fetching failed: $@\n";
+ chdir $dir; return;
+ }
+
+ return if exists $args{size} and -s $file != $args{size};
+ system($args{run}) if exists $args{run};
+ unlink($file) if $args{remove};
+
+ print(((!exists $args{check_for} or -e $args{check_for})
+ ? "done!" : "failed! ($!)"), "\n");
+ chdir $dir; return !$?;
+}
+
+1;
diff --git a/inc/Module/Install/Include.pm b/inc/Module/Install/Include.pm
new file mode 100644
index 0000000..2eb1d1f
--- /dev/null
+++ b/inc/Module/Install/Include.pm
@@ -0,0 +1,34 @@
+#line 1
+package Module::Install::Include;
+
+use strict;
+use Module::Install::Base ();
+
+use vars qw{$VERSION @ISA $ISCORE};
+BEGIN {
+ $VERSION = '1.16';
+ @ISA = 'Module::Install::Base';
+ $ISCORE = 1;
+}
+
+sub include {
+ shift()->admin->include(@_);
+}
+
+sub include_deps {
+ shift()->admin->include_deps(@_);
+}
+
+sub auto_include {
+ shift()->admin->auto_include(@_);
+}
+
+sub auto_include_deps {
+ shift()->admin->auto_include_deps(@_);
+}
+
+sub auto_include_dependent_dists {
+ shift()->admin->auto_include_dependent_dists(@_);
+}
+
+1;
diff --git a/inc/Module/Install/Makefile.pm b/inc/Module/Install/Makefile.pm
new file mode 100644
index 0000000..e9918d2
--- /dev/null
+++ b/inc/Module/Install/Makefile.pm
@@ -0,0 +1,418 @@
+#line 1
+package Module::Install::Makefile;
+
+use strict 'vars';
+use ExtUtils::MakeMaker ();
+use Module::Install::Base ();
+use Fcntl qw/:flock :seek/;
+
+use vars qw{$VERSION @ISA $ISCORE};
+BEGIN {
+ $VERSION = '1.16';
+ @ISA = 'Module::Install::Base';
+ $ISCORE = 1;
+}
+
+sub Makefile { $_[0] }
+
+my %seen = ();
+
+sub prompt {
+ shift;
+
+ # Infinite loop protection
+ my @c = caller();
+ if ( ++$seen{"$c[1]|$c[2]|$_[0]"} > 3 ) {
+ die "Caught an potential prompt infinite loop ($c[1]|$c[2]|$_[0])";
+ }
+
+ # In automated testing or non-interactive session, always use defaults
+ if ( ($ENV{AUTOMATED_TESTING} or -! -t STDIN) and ! $ENV{PERL_MM_USE_DEFAULT} ) {
+ local $ENV{PERL_MM_USE_DEFAULT} = 1;
+ goto &ExtUtils::MakeMaker::prompt;
+ } else {
+ goto &ExtUtils::MakeMaker::prompt;
+ }
+}
+
+# Store a cleaned up version of the MakeMaker version,
+# since we need to behave differently in a variety of
+# ways based on the MM version.
+my $makemaker = eval $ExtUtils::MakeMaker::VERSION;
+
+# If we are passed a param, do a "newer than" comparison.
+# Otherwise, just return the MakeMaker version.
+sub makemaker {
+ ( @_ < 2 or $makemaker >= eval($_[1]) ) ? $makemaker : 0
+}
+
+# Ripped from ExtUtils::MakeMaker 6.56, and slightly modified
+# as we only need to know here whether the attribute is an array
+# or a hash or something else (which may or may not be appendable).
+my %makemaker_argtype = (
+ C => 'ARRAY',
+ CONFIG => 'ARRAY',
+# CONFIGURE => 'CODE', # ignore
+ DIR => 'ARRAY',
+ DL_FUNCS => 'HASH',
+ DL_VARS => 'ARRAY',
+ EXCLUDE_EXT => 'ARRAY',
+ EXE_FILES => 'ARRAY',
+ FUNCLIST => 'ARRAY',
+ H => 'ARRAY',
+ IMPORTS => 'HASH',
+ INCLUDE_EXT => 'ARRAY',
+ LIBS => 'ARRAY', # ignore ''
+ MAN1PODS => 'HASH',
+ MAN3PODS => 'HASH',
+ META_ADD => 'HASH',
+ META_MERGE => 'HASH',
+ PL_FILES => 'HASH',
+ PM => 'HASH',
+ PMLIBDIRS => 'ARRAY',
+ PMLIBPARENTDIRS => 'ARRAY',
+ PREREQ_PM => 'HASH',
+ CONFIGURE_REQUIRES => 'HASH',
+ SKIP => 'ARRAY',
+ TYPEMAPS => 'ARRAY',
+ XS => 'HASH',
+# VERSION => ['version',''], # ignore
+# _KEEP_AFTER_FLUSH => '',
+
+ clean => 'HASH',
+ depend => 'HASH',
+ dist => 'HASH',
+ dynamic_lib=> 'HASH',
+ linkext => 'HASH',
+ macro => 'HASH',
+ postamble => 'HASH',
+ realclean => 'HASH',
+ test => 'HASH',
+ tool_autosplit => 'HASH',
+
+ # special cases where you can use makemaker_append
+ CCFLAGS => 'APPENDABLE',
+ DEFINE => 'APPENDABLE',
+ INC => 'APPENDABLE',
+ LDDLFLAGS => 'APPENDABLE',
+ LDFROM => 'APPENDABLE',
+);
+
+sub makemaker_args {
+ my ($self, %new_args) = @_;
+ my $args = ( $self->{makemaker_args} ||= {} );
+ foreach my $key (keys %new_args) {
+ if ($makemaker_argtype{$key}) {
+ if ($makemaker_argtype{$key} eq 'ARRAY') {
+ $args->{$key} = [] unless defined $args->{$key};
+ unless (ref $args->{$key} eq 'ARRAY') {
+ $args->{$key} = [$args->{$key}]
+ }
+ push @{$args->{$key}},
+ ref $new_args{$key} eq 'ARRAY'
+ ? @{$new_args{$key}}
+ : $new_args{$key};
+ }
+ elsif ($makemaker_argtype{$key} eq 'HASH') {
+ $args->{$key} = {} unless defined $args->{$key};
+ foreach my $skey (keys %{ $new_args{$key} }) {
+ $args->{$key}{$skey} = $new_args{$key}{$skey};
+ }
+ }
+ elsif ($makemaker_argtype{$key} eq 'APPENDABLE') {
+ $self->makemaker_append($key => $new_args{$key});
+ }
+ }
+ else {
+ if (defined $args->{$key}) {
+ warn qq{MakeMaker attribute "$key" is overriden; use "makemaker_append" to append values\n};
+ }
+ $args->{$key} = $new_args{$key};
+ }
+ }
+ return $args;
+}
+
+# For mm args that take multiple space-separated args,
+# append an argument to the current list.
+sub makemaker_append {
+ my $self = shift;
+ my $name = shift;
+ my $args = $self->makemaker_args;
+ $args->{$name} = defined $args->{$name}
+ ? join( ' ', $args->{$name}, @_ )
+ : join( ' ', @_ );
+}
+
+sub build_subdirs {
+ my $self = shift;
+ my $subdirs = $self->makemaker_args->{DIR} ||= [];
+ for my $subdir (@_) {
+ push @$subdirs, $subdir;
+ }
+}
+
+sub clean_files {
+ my $self = shift;
+ my $clean = $self->makemaker_args->{clean} ||= {};
+ %$clean = (
+ %$clean,
+ FILES => join ' ', grep { length $_ } ($clean->{FILES} || (), @_),
+ );
+}
+
+sub realclean_files {
+ my $self = shift;
+ my $realclean = $self->makemaker_args->{realclean} ||= {};
+ %$realclean = (
+ %$realclean,
+ FILES => join ' ', grep { length $_ } ($realclean->{FILES} || (), @_),
+ );
+}
+
+sub libs {
+ my $self = shift;
+ my $libs = ref $_[0] ? shift : [ shift ];
+ $self->makemaker_args( LIBS => $libs );
+}
+
+sub inc {
+ my $self = shift;
+ $self->makemaker_args( INC => shift );
+}
+
+sub _wanted_t {
+}
+
+sub tests_recursive {
+ my $self = shift;
+ my $dir = shift || 't';
+ unless ( -d $dir ) {
+ die "tests_recursive dir '$dir' does not exist";
+ }
+ my %tests = map { $_ => 1 } split / /, ($self->tests || '');
+ require File::Find;
+ File::Find::find(
+ sub { /\.t$/ and -f $_ and $tests{"$File::Find::dir/*.t"} = 1 },
+ $dir
+ );
+ $self->tests( join ' ', sort keys %tests );
+}
+
+sub write {
+ my $self = shift;
+ die "&Makefile->write() takes no arguments\n" if @_;
+
+ # Check the current Perl version
+ my $perl_version = $self->perl_version;
+ if ( $perl_version ) {
+ eval "use $perl_version; 1"
+ or die "ERROR: perl: Version $] is installed, "
+ . "but we need version >= $perl_version";
+ }
+
+ # Make sure we have a new enough MakeMaker
+ require ExtUtils::MakeMaker;
+
+ if ( $perl_version and $self->_cmp($perl_version, '5.006') >= 0 ) {
+ # This previous attempted to inherit the version of
+ # ExtUtils::MakeMaker in use by the module author, but this
+ # was found to be untenable as some authors build releases
+ # using future dev versions of EU:MM that nobody else has.
+ # Instead, #toolchain suggests we use 6.59 which is the most
+ # stable version on CPAN at time of writing and is, to quote
+ # ribasushi, "not terminally fucked, > and tested enough".
+ # TODO: We will now need to maintain this over time to push
+ # the version up as new versions are released.
+ $self->build_requires( 'ExtUtils::MakeMaker' => 6.59 );
+ $self->configure_requires( 'ExtUtils::MakeMaker' => 6.59 );
+ } else {
+ # Allow legacy-compatibility with 5.005 by depending on the
+ # most recent EU:MM that supported 5.005.
+ $self->build_requires( 'ExtUtils::MakeMaker' => 6.36 );
+ $self->configure_requires( 'ExtUtils::MakeMaker' => 6.36 );
+ }
+
+ # Generate the MakeMaker params
+ my $args = $self->makemaker_args;
+ $args->{DISTNAME} = $self->name;
+ $args->{NAME} = $self->module_name || $self->name;
+ $args->{NAME} =~ s/-/::/g;
+ $args->{VERSION} = $self->version or die <<'EOT';
+ERROR: Can't determine distribution version. Please specify it
+explicitly via 'version' in Makefile.PL, or set a valid $VERSION
+in a module, and provide its file path via 'version_from' (or
+'all_from' if you prefer) in Makefile.PL.
+EOT
+
+ if ( $self->tests ) {
+ my @tests = split ' ', $self->tests;
+ my %seen;
+ $args->{test} = {
+ TESTS => (join ' ', grep {!$seen{$_}++} @tests),
+ };
+ } elsif ( $Module::Install::ExtraTests::use_extratests ) {
+ # Module::Install::ExtraTests doesn't set $self->tests and does its own tests via harness.
+ # So, just ignore our xt tests here.
+ } elsif ( -d 'xt' and ($Module::Install::AUTHOR or $ENV{RELEASE_TESTING}) ) {
+ $args->{test} = {
+ TESTS => join( ' ', map { "$_/*.t" } grep { -d $_ } qw{ t xt } ),
+ };
+ }
+ if ( $] >= 5.005 ) {
+ $args->{ABSTRACT} = $self->abstract;
+ $args->{AUTHOR} = join ', ', @{$self->author || []};
+ }
+ if ( $self->makemaker(6.10) ) {
+ $args->{NO_META} = 1;
+ #$args->{NO_MYMETA} = 1;
+ }
+ if ( $self->makemaker(6.17) and $self->sign ) {
+ $args->{SIGN} = 1;
+ }
+ unless ( $self->is_admin ) {
+ delete $args->{SIGN};
+ }
+ if ( $self->makemaker(6.31) and $self->license ) {
+ $args->{LICENSE} = $self->license;
+ }
+
+ my $prereq = ($args->{PREREQ_PM} ||= {});
+ %$prereq = ( %$prereq,
+ map { @$_ } # flatten [module => version]
+ map { @$_ }
+ grep $_,
+ ($self->requires)
+ );
+
+ # Remove any reference to perl, PREREQ_PM doesn't support it
+ delete $args->{PREREQ_PM}->{perl};
+
+ # Merge both kinds of requires into BUILD_REQUIRES
+ my $build_prereq = ($args->{BUILD_REQUIRES} ||= {});
+ %$build_prereq = ( %$build_prereq,
+ map { @$_ } # flatten [module => version]
+ map { @$_ }
+ grep $_,
+ ($self->configure_requires, $self->build_requires)
+ );
+
+ # Remove any reference to perl, BUILD_REQUIRES doesn't support it
+ delete $args->{BUILD_REQUIRES}->{perl};
+
+ # Delete bundled dists from prereq_pm, add it to Makefile DIR
+ my $subdirs = ($args->{DIR} || []);
+ if ($self->bundles) {
+ my %processed;
+ foreach my $bundle (@{ $self->bundles }) {
+ my ($mod_name, $dist_dir) = @$bundle;
+ delete $prereq->{$mod_name};
+ $dist_dir = File::Basename::basename($dist_dir); # dir for building this module
+ if (not exists $processed{$dist_dir}) {
+ if (-d $dist_dir) {
+ # List as sub-directory to be processed by make
+ push @$subdirs, $dist_dir;
+ }
+ # Else do nothing: the module is already present on the system
+ $processed{$dist_dir} = undef;
+ }
+ }
+ }
+
+ unless ( $self->makemaker('6.55_03') ) {
+ %$prereq = (%$prereq,%$build_prereq);
+ delete $args->{BUILD_REQUIRES};
+ }
+
+ if ( my $perl_version = $self->perl_version ) {
+ eval "use $perl_version; 1"
+ or die "ERROR: perl: Version $] is installed, "
+ . "but we need version >= $perl_version";
+
+ if ( $self->makemaker(6.48) ) {
+ $args->{MIN_PERL_VERSION} = $perl_version;
+ }
+ }
+
+ if ($self->installdirs) {
+ warn qq{old INSTALLDIRS (probably set by makemaker_args) is overriden by installdirs\n} if $args->{INSTALLDIRS};
+ $args->{INSTALLDIRS} = $self->installdirs;
+ }
+
+ my %args = map {
+ ( $_ => $args->{$_} ) } grep {defined($args->{$_} )
+ } keys %$args;
+
+ my $user_preop = delete $args{dist}->{PREOP};
+ if ( my $preop = $self->admin->preop($user_preop) ) {
+ foreach my $key ( keys %$preop ) {
+ $args{dist}->{$key} = $preop->{$key};
+ }
+ }
+
+ my $mm = ExtUtils::MakeMaker::WriteMakefile(%args);
+ $self->fix_up_makefile($mm->{FIRST_MAKEFILE} || 'Makefile');
+}
+
+sub fix_up_makefile {
+ my $self = shift;
+ my $makefile_name = shift;
+ my $top_class = ref($self->_top) || '';
+ my $top_version = $self->_top->VERSION || '';
+
+ my $preamble = $self->preamble
+ ? "# Preamble by $top_class $top_version\n"
+ . $self->preamble
+ : '';
+ my $postamble = "# Postamble by $top_class $top_version\n"
+ . ($self->postamble || '');
+
+ local *MAKEFILE;
+ open MAKEFILE, "+< $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!";
+ eval { flock MAKEFILE, LOCK_EX };
+ my $makefile = do { local $/; <MAKEFILE> };
+
+ $makefile =~ s/\b(test_harness\(\$\(TEST_VERBOSE\), )/$1'inc', /;
+ $makefile =~ s/( -I\$\(INST_ARCHLIB\))/ -Iinc$1/g;
+ $makefile =~ s/( "-I\$\(INST_LIB\)")/ "-Iinc"$1/g;
+ $makefile =~ s/^(FULLPERL = .*)/$1 "-Iinc"/m;
+ $makefile =~ s/^(PERL = .*)/$1 "-Iinc"/m;
+
+ # Module::Install will never be used to build the Core Perl
+ # Sometimes PERL_LIB and PERL_ARCHLIB get written anyway, which breaks
+ # PREFIX/PERL5LIB, and thus, install_share. Blank them if they exist
+ $makefile =~ s/^PERL_LIB = .+/PERL_LIB =/m;
+ #$makefile =~ s/^PERL_ARCHLIB = .+/PERL_ARCHLIB =/m;
+
+ # Perl 5.005 mentions PERL_LIB explicitly, so we have to remove that as well.
+ $makefile =~ s/(\"?)-I\$\(PERL_LIB\)\1//g;
+
+ # XXX - This is currently unused; not sure if it breaks other MM-users
+ # $makefile =~ s/^pm_to_blib\s+:\s+/pm_to_blib :: /mg;
+
+ seek MAKEFILE, 0, SEEK_SET;
+ truncate MAKEFILE, 0;
+ print MAKEFILE "$preamble$makefile$postamble" or die $!;
+ close MAKEFILE or die $!;
+
+ 1;
+}
+
+sub preamble {
+ my ($self, $text) = @_;
+ $self->{preamble} = $text . $self->{preamble} if defined $text;
+ $self->{preamble};
+}
+
+sub postamble {
+ my ($self, $text) = @_;
+ $self->{postamble} ||= $self->admin->postamble;
+ $self->{postamble} .= $text if defined $text;
+ $self->{postamble}
+}
+
+1;
+
+__END__
+
+#line 544
diff --git a/inc/Module/Install/Metadata.pm b/inc/Module/Install/Metadata.pm
new file mode 100644
index 0000000..9792685
--- /dev/null
+++ b/inc/Module/Install/Metadata.pm
@@ -0,0 +1,722 @@
+#line 1
+package Module::Install::Metadata;
+
+use strict 'vars';
+use Module::Install::Base ();
+
+use vars qw{$VERSION @ISA $ISCORE};
+BEGIN {
+ $VERSION = '1.16';
+ @ISA = 'Module::Install::Base';
+ $ISCORE = 1;
+}
+
+my @boolean_keys = qw{
+ sign
+};
+
+my @scalar_keys = qw{
+ name
+ module_name
+ abstract
+ version
+ distribution_type
+ tests
+ installdirs
+};
+
+my @tuple_keys = qw{
+ configure_requires
+ build_requires
+ requires
+ recommends
+ bundles
+ resources
+};
+
+my @resource_keys = qw{
+ homepage
+ bugtracker
+ repository
+};
+
+my @array_keys = qw{
+ keywords
+ author
+};
+
+*authors = \&author;
+
+sub Meta { shift }
+sub Meta_BooleanKeys { @boolean_keys }
+sub Meta_ScalarKeys { @scalar_keys }
+sub Meta_TupleKeys { @tuple_keys }
+sub Meta_ResourceKeys { @resource_keys }
+sub Meta_ArrayKeys { @array_keys }
+
+foreach my $key ( @boolean_keys ) {
+ *$key = sub {
+ my $self = shift;
+ if ( defined wantarray and not @_ ) {
+ return $self->{values}->{$key};
+ }
+ $self->{values}->{$key} = ( @_ ? $_[0] : 1 );
+ return $self;
+ };
+}
+
+foreach my $key ( @scalar_keys ) {
+ *$key = sub {
+ my $self = shift;
+ return $self->{values}->{$key} if defined wantarray and !@_;
+ $self->{values}->{$key} = shift;
+ return $self;
+ };
+}
+
+foreach my $key ( @array_keys ) {
+ *$key = sub {
+ my $self = shift;
+ return $self->{values}->{$key} if defined wantarray and !@_;
+ $self->{values}->{$key} ||= [];
+ push @{$self->{values}->{$key}}, @_;
+ return $self;
+ };
+}
+
+foreach my $key ( @resource_keys ) {
+ *$key = sub {
+ my $self = shift;
+ unless ( @_ ) {
+ return () unless $self->{values}->{resources};
+ return map { $_->[1] }
+ grep { $_->[0] eq $key }
+ @{ $self->{values}->{resources} };
+ }
+ return $self->{values}->{resources}->{$key} unless @_;
+ my $uri = shift or die(
+ "Did not provide a value to $key()"
+ );
+ $self->resources( $key => $uri );
+ return 1;
+ };
+}
+
+foreach my $key ( grep { $_ ne "resources" } @tuple_keys) {
+ *$key = sub {
+ my $self = shift;
+ return $self->{values}->{$key} unless @_;
+ my @added;
+ while ( @_ ) {
+ my $module = shift or last;
+ my $version = shift || 0;
+ push @added, [ $module, $version ];
+ }
+ push @{ $self->{values}->{$key} }, @added;
+ return map {@$_} @added;
+ };
+}
+
+# Resource handling
+my %lc_resource = map { $_ => 1 } qw{
+ homepage
+ license
+ bugtracker
+ repository
+};
+
+sub resources {
+ my $self = shift;
+ while ( @_ ) {
+ my $name = shift or last;
+ my $value = shift or next;
+ if ( $name eq lc $name and ! $lc_resource{$name} ) {
+ die("Unsupported reserved lowercase resource '$name'");
+ }
+ $self->{values}->{resources} ||= [];
+ push @{ $self->{values}->{resources} }, [ $name, $value ];
+ }
+ $self->{values}->{resources};
+}
+
+# Aliases for build_requires that will have alternative
+# meanings in some future version of META.yml.
+sub test_requires { shift->build_requires(@_) }
+sub install_requires { shift->build_requires(@_) }
+
+# Aliases for installdirs options
+sub install_as_core { $_[0]->installdirs('perl') }
+sub install_as_cpan { $_[0]->installdirs('site') }
+sub install_as_site { $_[0]->installdirs('site') }
+sub install_as_vendor { $_[0]->installdirs('vendor') }
+
+sub dynamic_config {
+ my $self = shift;
+ my $value = @_ ? shift : 1;
+ if ( $self->{values}->{dynamic_config} ) {
+ # Once dynamic we never change to static, for safety
+ return 0;
+ }
+ $self->{values}->{dynamic_config} = $value ? 1 : 0;
+ return 1;
+}
+
+# Convenience command
+sub static_config {
+ shift->dynamic_config(0);
+}
+
+sub perl_version {
+ my $self = shift;
+ return $self->{values}->{perl_version} unless @_;
+ my $version = shift or die(
+ "Did not provide a value to perl_version()"
+ );
+
+ # Normalize the version
+ $version = $self->_perl_version($version);
+
+ # We don't support the really old versions
+ unless ( $version >= 5.005 ) {
+ die "Module::Install only supports 5.005 or newer (use ExtUtils::MakeMaker)\n";
+ }
+
+ $self->{values}->{perl_version} = $version;
+}
+
+sub all_from {
+ my ( $self, $file ) = @_;
+
+ unless ( defined($file) ) {
+ my $name = $self->name or die(
+ "all_from called with no args without setting name() first"
+ );
+ $file = join('/', 'lib', split(/-/, $name)) . '.pm';
+ $file =~ s{.*/}{} unless -e $file;
+ unless ( -e $file ) {
+ die("all_from cannot find $file from $name");
+ }
+ }
+ unless ( -f $file ) {
+ die("The path '$file' does not exist, or is not a file");
+ }
+
+ $self->{values}{all_from} = $file;
+
+ # Some methods pull from POD instead of code.
+ # If there is a matching .pod, use that instead
+ my $pod = $file;
+ $pod =~ s/\.pm$/.pod/i;
+ $pod = $file unless -e $pod;
+
+ # Pull the different values
+ $self->name_from($file) unless $self->name;
+ $self->version_from($file) unless $self->version;
+ $self->perl_version_from($file) unless $self->perl_version;
+ $self->author_from($pod) unless @{$self->author || []};
+ $self->license_from($pod) unless $self->license;
+ $self->abstract_from($pod) unless $self->abstract;
+
+ return 1;
+}
+
+sub provides {
+ my $self = shift;
+ my $provides = ( $self->{values}->{provides} ||= {} );
+ %$provides = (%$provides, @_) if @_;
+ return $provides;
+}
+
+sub auto_provides {
+ my $self = shift;
+ return $self unless $self->is_admin;
+ unless (-e 'MANIFEST') {
+ warn "Cannot deduce auto_provides without a MANIFEST, skipping\n";
+ return $self;
+ }
+ # Avoid spurious warnings as we are not checking manifest here.
+ local $SIG{__WARN__} = sub {1};
+ require ExtUtils::Manifest;
+ local *ExtUtils::Manifest::manicheck = sub { return };
+
+ require Module::Build;
+ my $build = Module::Build->new(
+ dist_name => $self->name,
+ dist_version => $self->version,
+ license => $self->license,
+ );
+ $self->provides( %{ $build->find_dist_packages || {} } );
+}
+
+sub feature {
+ my $self = shift;
+ my $name = shift;
+ my $features = ( $self->{values}->{features} ||= [] );
+ my $mods;
+
+ if ( @_ == 1 and ref( $_[0] ) ) {
+ # The user used ->feature like ->features by passing in the second
+ # argument as a reference. Accomodate for that.
+ $mods = $_[0];
+ } else {
+ $mods = \@_;
+ }
+
+ my $count = 0;
+ push @$features, (
+ $name => [
+ map {
+ ref($_) ? ( ref($_) eq 'HASH' ) ? %$_ : @$_ : $_
+ } @$mods
+ ]
+ );
+
+ return @$features;
+}
+
+sub features {
+ my $self = shift;
+ while ( my ( $name, $mods ) = splice( @_, 0, 2 ) ) {
+ $self->feature( $name, @$mods );
+ }
+ return $self->{values}->{features}
+ ? @{ $self->{values}->{features} }
+ : ();
+}
+
+sub no_index {
+ my $self = shift;
+ my $type = shift;
+ push @{ $self->{values}->{no_index}->{$type} }, @_ if $type;
+ return $self->{values}->{no_index};
+}
+
+sub read {
+ my $self = shift;
+ $self->include_deps( 'YAML::Tiny', 0 );
+
+ require YAML::Tiny;
+ my $data = YAML::Tiny::LoadFile('META.yml');
+
+ # Call methods explicitly in case user has already set some values.
+ while ( my ( $key, $value ) = each %$data ) {
+ next unless $self->can($key);
+ if ( ref $value eq 'HASH' ) {
+ while ( my ( $module, $version ) = each %$value ) {
+ $self->can($key)->($self, $module => $version );
+ }
+ } else {
+ $self->can($key)->($self, $value);
+ }
+ }
+ return $self;
+}
+
+sub write {
+ my $self = shift;
+ return $self unless $self->is_admin;
+ $self->admin->write_meta;
+ return $self;
+}
+
+sub version_from {
+ require ExtUtils::MM_Unix;
+ my ( $self, $file ) = @_;
+ $self->version( ExtUtils::MM_Unix->parse_version($file) );
+
+ # for version integrity check
+ $self->makemaker_args( VERSION_FROM => $file );
+}
+
+sub abstract_from {
+ require ExtUtils::MM_Unix;
+ my ( $self, $file ) = @_;
+ $self->abstract(
+ bless(
+ { DISTNAME => $self->name },
+ 'ExtUtils::MM_Unix'
+ )->parse_abstract($file)
+ );
+}
+
+# Add both distribution and module name
+sub name_from {
+ my ($self, $file) = @_;
+ if (
+ Module::Install::_read($file) =~ m/
+ ^ \s*
+ package \s*
+ ([\w:]+)
+ [\s|;]*
+ /ixms
+ ) {
+ my ($name, $module_name) = ($1, $1);
+ $name =~ s{::}{-}g;
+ $self->name($name);
+ unless ( $self->module_name ) {
+ $self->module_name($module_name);
+ }
+ } else {
+ die("Cannot determine name from $file\n");
+ }
+}
+
+sub _extract_perl_version {
+ if (
+ $_[0] =~ m/
+ ^\s*
+ (?:use|require) \s*
+ v?
+ ([\d_\.]+)
+ \s* ;
+ /ixms
+ ) {
+ my $perl_version = $1;
+ $perl_version =~ s{_}{}g;
+ return $perl_version;
+ } else {
+ return;
+ }
+}
+
+sub perl_version_from {
+ my $self = shift;
+ my $perl_version=_extract_perl_version(Module::Install::_read($_[0]));
+ if ($perl_version) {
+ $self->perl_version($perl_version);
+ } else {
+ warn "Cannot determine perl version info from $_[0]\n";
+ return;
+ }
+}
+
+sub author_from {
+ my $self = shift;
+ my $content = Module::Install::_read($_[0]);
+ if ($content =~ m/
+ =head \d \s+ (?:authors?)\b \s*
+ ([^\n]*)
+ |
+ =head \d \s+ (?:licen[cs]e|licensing|copyright|legal)\b \s*
+ .*? copyright .*? \d\d\d[\d.]+ \s* (?:\bby\b)? \s*
+ ([^\n]*)
+ /ixms) {
+ my $author = $1 || $2;
+
+ # XXX: ugly but should work anyway...
+ if (eval "require Pod::Escapes; 1") {
+ # Pod::Escapes has a mapping table.
+ # It's in core of perl >= 5.9.3, and should be installed
+ # as one of the Pod::Simple's prereqs, which is a prereq
+ # of Pod::Text 3.x (see also below).
+ $author =~ s{ E<( (\d+) | ([A-Za-z]+) )> }
+ {
+ defined $2
+ ? chr($2)
+ : defined $Pod::Escapes::Name2character_number{$1}
+ ? chr($Pod::Escapes::Name2character_number{$1})
+ : do {
+ warn "Unknown escape: E<$1>";
+ "E<$1>";
+ };
+ }gex;
+ }
+ elsif (eval "require Pod::Text; 1" && $Pod::Text::VERSION < 3) {
+ # Pod::Text < 3.0 has yet another mapping table,
+ # though the table name of 2.x and 1.x are different.
+ # (1.x is in core of Perl < 5.6, 2.x is in core of
+ # Perl < 5.9.3)
+ my $mapping = ($Pod::Text::VERSION < 2)
+ ? \%Pod::Text::HTML_Escapes
+ : \%Pod::Text::ESCAPES;
+ $author =~ s{ E<( (\d+) | ([A-Za-z]+) )> }
+ {
+ defined $2
+ ? chr($2)
+ : defined $mapping->{$1}
+ ? $mapping->{$1}
+ : do {
+ warn "Unknown escape: E<$1>";
+ "E<$1>";
+ };
+ }gex;
+ }
+ else {
+ $author =~ s{E<lt>}{<}g;
+ $author =~ s{E<gt>}{>}g;
+ }
+ $self->author($author);
+ } else {
+ warn "Cannot determine author info from $_[0]\n";
+ }
+}
+
+#Stolen from M::B
+my %license_urls = (
+ perl => 'http://dev.perl.org/licenses/',
+ apache => 'http://apache.org/licenses/LICENSE-2.0',
+ apache_1_1 => 'http://apache.org/licenses/LICENSE-1.1',
+ artistic => 'http://opensource.org/licenses/artistic-license.php',
+ artistic_2 => 'http://opensource.org/licenses/artistic-license-2.0.php',
+ lgpl => 'http://opensource.org/licenses/lgpl-license.php',
+ lgpl2 => 'http://opensource.org/licenses/lgpl-2.1.php',
+ lgpl3 => 'http://opensource.org/licenses/lgpl-3.0.html',
+ bsd => 'http://opensource.org/licenses/bsd-license.php',
+ gpl => 'http://opensource.org/licenses/gpl-license.php',
+ gpl2 => 'http://opensource.org/licenses/gpl-2.0.php',
+ gpl3 => 'http://opensource.org/licenses/gpl-3.0.html',
+ mit => 'http://opensource.org/licenses/mit-license.php',
+ mozilla => 'http://opensource.org/licenses/mozilla1.1.php',
+ open_source => undef,
+ unrestricted => undef,
+ restrictive => undef,
+ unknown => undef,
+);
+
+sub license {
+ my $self = shift;
+ return $self->{values}->{license} unless @_;
+ my $license = shift or die(
+ 'Did not provide a value to license()'
+ );
+ $license = __extract_license($license) || lc $license;
+ $self->{values}->{license} = $license;
+
+ # Automatically fill in license URLs
+ if ( $license_urls{$license} ) {
+ $self->resources( license => $license_urls{$license} );
+ }
+
+ return 1;
+}
+
+sub _extract_license {
+ my $pod = shift;
+ my $matched;
+ return __extract_license(
+ ($matched) = $pod =~ m/
+ (=head \d \s+ L(?i:ICEN[CS]E|ICENSING)\b.*?)
+ (=head \d.*|=cut.*|)\z
+ /xms
+ ) || __extract_license(
+ ($matched) = $pod =~ m/
+ (=head \d \s+ (?:C(?i:OPYRIGHTS?)|L(?i:EGAL))\b.*?)
+ (=head \d.*|=cut.*|)\z
+ /xms
+ );
+}
+
+sub __extract_license {
+ my $license_text = shift or return;
+ my @phrases = (
+ '(?:under )?the same (?:terms|license) as (?:perl|the perl (?:\d )?programming language)' => 'perl', 1,
+ '(?:under )?the terms of (?:perl|the perl programming language) itself' => 'perl', 1,
+ 'Artistic and GPL' => 'perl', 1,
+ 'GNU general public license' => 'gpl', 1,
+ 'GNU public license' => 'gpl', 1,
+ 'GNU lesser general public license' => 'lgpl', 1,
+ 'GNU lesser public license' => 'lgpl', 1,
+ 'GNU library general public license' => 'lgpl', 1,
+ 'GNU library public license' => 'lgpl', 1,
+ 'GNU Free Documentation license' => 'unrestricted', 1,
+ 'GNU Affero General Public License' => 'open_source', 1,
+ '(?:Free)?BSD license' => 'bsd', 1,
+ 'Artistic license 2\.0' => 'artistic_2', 1,
+ 'Artistic license' => 'artistic', 1,
+ 'Apache (?:Software )?license' => 'apache', 1,
+ 'GPL' => 'gpl', 1,
+ 'LGPL' => 'lgpl', 1,
+ 'BSD' => 'bsd', 1,
+ 'Artistic' => 'artistic', 1,
+ 'MIT' => 'mit', 1,
+ 'Mozilla Public License' => 'mozilla', 1,
+ 'Q Public License' => 'open_source', 1,
+ 'OpenSSL License' => 'unrestricted', 1,
+ 'SSLeay License' => 'unrestricted', 1,
+ 'zlib License' => 'open_source', 1,
+ 'proprietary' => 'proprietary', 0,
+ );
+ while ( my ($pattern, $license, $osi) = splice(@phrases, 0, 3) ) {
+ $pattern =~ s#\s+#\\s+#gs;
+ if ( $license_text =~ /\b$pattern\b/i ) {
+ return $license;
+ }
+ }
+ return '';
+}
+
+sub license_from {
+ my $self = shift;
+ if (my $license=_extract_license(Module::Install::_read($_[0]))) {
+ $self->license($license);
+ } else {
+ warn "Cannot determine license info from $_[0]\n";
+ return 'unknown';
+ }
+}
+
+sub _extract_bugtracker {
+ my @links = $_[0] =~ m#L<(
+ https?\Q://rt.cpan.org/\E[^>]+|
+ https?\Q://github.com/\E[\w_]+/[\w_]+/issues|
+ https?\Q://code.google.com/p/\E[\w_\-]+/issues/list
+ )>#gx;
+ my %links;
+ @links{@links}=();
+ @links=keys %links;
+ return @links;
+}
+
+sub bugtracker_from {
+ my $self = shift;
+ my $content = Module::Install::_read($_[0]);
+ my @links = _extract_bugtracker($content);
+ unless ( @links ) {
+ warn "Cannot determine bugtracker info from $_[0]\n";
+ return 0;
+ }
+ if ( @links > 1 ) {
+ warn "Found more than one bugtracker link in $_[0]\n";
+ return 0;
+ }
+
+ # Set the bugtracker
+ bugtracker( $links[0] );
+ return 1;
+}
+
+sub requires_from {
+ my $self = shift;
+ my $content = Module::Install::_readperl($_[0]);
+ my @requires = $content =~ m/^use\s+([^\W\d]\w*(?:::\w+)*)\s+(v?[\d\.]+)/mg;
+ while ( @requires ) {
+ my $module = shift @requires;
+ my $version = shift @requires;
+ $self->requires( $module => $version );
+ }
+}
+
+sub test_requires_from {
+ my $self = shift;
+ my $content = Module::Install::_readperl($_[0]);
+ my @requires = $content =~ m/^use\s+([^\W\d]\w*(?:::\w+)*)\s+([\d\.]+)/mg;
+ while ( @requires ) {
+ my $module = shift @requires;
+ my $version = shift @requires;
+ $self->test_requires( $module => $version );
+ }
+}
+
+# Convert triple-part versions (eg, 5.6.1 or 5.8.9) to
+# numbers (eg, 5.006001 or 5.008009).
+# Also, convert double-part versions (eg, 5.8)
+sub _perl_version {
+ my $v = $_[-1];
+ $v =~ s/^([1-9])\.([1-9]\d?\d?)$/sprintf("%d.%03d",$1,$2)/e;
+ $v =~ s/^([1-9])\.([1-9]\d?\d?)\.(0|[1-9]\d?\d?)$/sprintf("%d.%03d%03d",$1,$2,$3 || 0)/e;
+ $v =~ s/(\.\d\d\d)000$/$1/;
+ $v =~ s/_.+$//;
+ if ( ref($v) ) {
+ # Numify
+ $v = $v + 0;
+ }
+ return $v;
+}
+
+sub add_metadata {
+ my $self = shift;
+ my %hash = @_;
+ for my $key (keys %hash) {
+ warn "add_metadata: $key is not prefixed with 'x_'.\n" .
+ "Use appopriate function to add non-private metadata.\n" unless $key =~ /^x_/;
+ $self->{values}->{$key} = $hash{$key};
+ }
+}
+
+
+######################################################################
+# MYMETA Support
+
+sub WriteMyMeta {
+ die "WriteMyMeta has been deprecated";
+}
+
+sub write_mymeta_yaml {
+ my $self = shift;
+
+ # We need YAML::Tiny to write the MYMETA.yml file
+ unless ( eval { require YAML::Tiny; 1; } ) {
+ return 1;
+ }
+
+ # Generate the data
+ my $meta = $self->_write_mymeta_data or return 1;
+
+ # Save as the MYMETA.yml file
+ print "Writing MYMETA.yml\n";
+ YAML::Tiny::DumpFile('MYMETA.yml', $meta);
+}
+
+sub write_mymeta_json {
+ my $self = shift;
+
+ # We need JSON to write the MYMETA.json file
+ unless ( eval { require JSON; 1; } ) {
+ return 1;
+ }
+
+ # Generate the data
+ my $meta = $self->_write_mymeta_data or return 1;
+
+ # Save as the MYMETA.yml file
+ print "Writing MYMETA.json\n";
+ Module::Install::_write(
+ 'MYMETA.json',
+ JSON->new->pretty(1)->canonical->encode($meta),
+ );
+}
+
+sub _write_mymeta_data {
+ my $self = shift;
+
+ # If there's no existing META.yml there is nothing we can do
+ return undef unless -f 'META.yml';
+
+ # We need Parse::CPAN::Meta to load the file
+ unless ( eval { require Parse::CPAN::Meta; 1; } ) {
+ return undef;
+ }
+
+ # Merge the perl version into the dependencies
+ my $val = $self->Meta->{values};
+ my $perl = delete $val->{perl_version};
+ if ( $perl ) {
+ $val->{requires} ||= [];
+ my $requires = $val->{requires};
+
+ # Canonize to three-dot version after Perl 5.6
+ if ( $perl >= 5.006 ) {
+ $perl =~ s{^(\d+)\.(\d\d\d)(\d*)}{join('.', $1, int($2||0), int($3||0))}e
+ }
+ unshift @$requires, [ perl => $perl ];
+ }
+
+ # Load the advisory META.yml file
+ my @yaml = Parse::CPAN::Meta::LoadFile('META.yml');
+ my $meta = $yaml[0];
+
+ # Overwrite the non-configure dependency hashes
+ delete $meta->{requires};
+ delete $meta->{build_requires};
+ delete $meta->{recommends};
+ if ( exists $val->{requires} ) {
+ $meta->{requires} = { map { @$_ } @{ $val->{requires} } };
+ }
+ if ( exists $val->{build_requires} ) {
+ $meta->{build_requires} = { map { @$_ } @{ $val->{build_requires} } };
+ }
+
+ return $meta;
+}
+
+1;
diff --git a/inc/Module/Install/RTx.pm b/inc/Module/Install/RTx.pm
new file mode 100644
index 0000000..80538d3
--- /dev/null
+++ b/inc/Module/Install/RTx.pm
@@ -0,0 +1,282 @@
+#line 1
+package Module::Install::RTx;
+
+use 5.008;
+use strict;
+use warnings;
+no warnings 'once';
+
+use Module::Install::Base;
+use base 'Module::Install::Base';
+our $VERSION = '0.38';
+
+use FindBin;
+use File::Glob ();
+use File::Basename ();
+
+my @DIRS = qw(etc lib html static bin sbin po var);
+my @INDEX_DIRS = qw(lib bin sbin);
+
+sub RTx {
+ my ( $self, $name, $extra_args ) = @_;
+ $extra_args ||= {};
+
+ # Set up names
+ my $fname = $name;
+ $fname =~ s!-!/!g;
+
+ $self->name( $name )
+ unless $self->name;
+ $self->all_from( "lib/$fname.pm" )
+ unless $self->version;
+ $self->abstract("$name Extension")
+ unless $self->abstract;
+ unless ( $extra_args->{no_readme_generation} ) {
+ $self->readme_from( "lib/$fname.pm",
+ { options => [ quotes => "none" ] } );
+ }
+ $self->add_metadata("x_module_install_rtx_version", $VERSION );
+
+ my $installdirs = $ENV{INSTALLDIRS};
+ for ( @ARGV ) {
+ if ( /INSTALLDIRS=(.*)/ ) {
+ $installdirs = $1;
+ }
+ }
+
+ # Try to find RT.pm
+ my @prefixes = qw( /opt /usr/local /home /usr /sw /usr/share/request-tracker4);
+ $ENV{RTHOME} =~ s{/RT\.pm$}{} if defined $ENV{RTHOME};
+ $ENV{RTHOME} =~ s{/lib/?$}{} if defined $ENV{RTHOME};
+ my @try = $ENV{RTHOME} ? ($ENV{RTHOME}, "$ENV{RTHOME}/lib") : ();
+ while (1) {
+ my @look = @INC;
+ unshift @look, grep {defined and -d $_} @try;
+ push @look, grep {defined and -d $_}
+ map { ( "$_/rt4/lib", "$_/lib/rt4", "$_/lib" ) } @prefixes;
+ last if eval {local @INC = @look; require RT; $RT::LocalLibPath};
+
+ warn
+ "Cannot find the location of RT.pm that defines \$RT::LocalPath in: @look\n";
+ my $given = $self->prompt("Path to directory containing your RT.pm:") or exit;
+ $given =~ s{/RT\.pm$}{};
+ $given =~ s{/lib/?$}{};
+ @try = ($given, "$given/lib");
+ }
+
+ print "Using RT configuration from $INC{'RT.pm'}:\n";
+
+ my $local_lib_path = $RT::LocalLibPath;
+ unshift @INC, $local_lib_path;
+ my $lib_path = File::Basename::dirname( $INC{'RT.pm'} );
+ unshift @INC, $lib_path;
+
+ # Set a baseline minimum version
+ unless ( $extra_args->{deprecated_rt} ) {
+ $self->requires_rt('4.0.0');
+ }
+
+ # Installation locations
+ my %path;
+ my $plugin_path;
+ if ( $installdirs && $installdirs eq 'vendor' ) {
+ $plugin_path = $RT::PluginPath;
+ } else {
+ $plugin_path = $RT::LocalPluginPath;
+ }
+ $path{$_} = $plugin_path . "/$name/$_"
+ foreach @DIRS;
+
+ # Copy RT 4.2.0 static files into NoAuth; insufficient for
+ # images, but good enough for css and js.
+ $path{static} = "$path{html}/NoAuth/"
+ unless $RT::StaticPath;
+
+ # Delete the ones we don't need
+ delete $path{$_} for grep {not -d "$FindBin::Bin/$_"} keys %path;
+
+ my %index = map { $_ => 1 } @INDEX_DIRS;
+ $self->no_index( directory => $_ ) foreach grep !$index{$_}, @DIRS;
+
+ my $args = join ', ', map "q($_)", map { ($_, "\$(DESTDIR)$path{$_}") }
+ sort keys %path;
+
+ printf "%-10s => %s\n", $_, $path{$_} for sort keys %path;
+
+ if ( my @dirs = map { ( -D => $_ ) } grep $path{$_}, qw(bin html sbin etc) ) {
+ my @po = map { ( -o => $_ ) }
+ grep -f,
+ File::Glob::bsd_glob("po/*.po");
+ $self->postamble(<< ".") if @po;
+lexicons ::
+\t\$(NOECHO) \$(PERL) -MLocale::Maketext::Extract::Run=xgettext -e \"xgettext(qw(@dirs @po))\"
+.
+ }
+
+ $self->include('Module::Install::RTx::Runtime') if $self->admin;
+ $self->include_deps( 'YAML::Tiny', 0 ) if $self->admin;
+ my $postamble = << ".";
+install ::
+\t\$(NOECHO) \$(PERL) -Ilib -I"$local_lib_path" -I"$lib_path" -Iinc -MModule::Install::RTx::Runtime -e"RTxPlugin()"
+\t\$(NOECHO) \$(PERL) -MExtUtils::Install -e \"install({$args})\"
+.
+
+ if ( $path{var} and -d $RT::MasonDataDir ) {
+ my ( $uid, $gid ) = ( stat($RT::MasonDataDir) )[ 4, 5 ];
+ $postamble .= << ".";
+\t\$(NOECHO) chown -R $uid:$gid $path{var}
+.
+ }
+
+ my %has_etc;
+ if ( File::Glob::bsd_glob("$FindBin::Bin/etc/schema.*") ) {
+ $has_etc{schema}++;
+ }
+ if ( File::Glob::bsd_glob("$FindBin::Bin/etc/acl.*") ) {
+ $has_etc{acl}++;
+ }
+ if ( -e 'etc/initialdata' ) { $has_etc{initialdata}++; }
+ if ( grep { /\d+\.\d+\.\d+.*$/ } glob('etc/upgrade/*.*.*') ) {
+ $has_etc{upgrade}++;
+ }
+
+ $self->postamble("$postamble\n");
+ if ( $path{lib} ) {
+ $self->makemaker_args( INSTALLSITELIB => $path{'lib'} );
+ $self->makemaker_args( INSTALLARCHLIB => $path{'lib'} );
+ $self->makemaker_args( INSTALLVENDORLIB => $path{'lib'} )
+ } else {
+ $self->makemaker_args( PM => { "" => "" }, );
+ }
+
+ $self->makemaker_args( INSTALLSITEMAN1DIR => "$RT::LocalPath/man/man1" );
+ $self->makemaker_args( INSTALLSITEMAN3DIR => "$RT::LocalPath/man/man3" );
+ $self->makemaker_args( INSTALLSITEARCH => "$RT::LocalPath/man" );
+
+ # INSTALLDIRS=vendor should install manpages into /usr/share/man.
+ # That is the default path in most distributions. Need input from
+ # Redhat, Centos etc.
+ $self->makemaker_args( INSTALLVENDORMAN1DIR => "/usr/share/man/man1" );
+ $self->makemaker_args( INSTALLVENDORMAN3DIR => "/usr/share/man/man3" );
+ $self->makemaker_args( INSTALLVENDORARCH => "/usr/share/man" );
+
+ if (%has_etc) {
+ print "For first-time installation, type 'make initdb'.\n";
+ my $initdb = '';
+ $initdb .= <<"." if $has_etc{schema};
+\t\$(NOECHO) \$(PERL) -Ilib -I"$local_lib_path" -I"$lib_path" -Iinc -MModule::Install::RTx::Runtime -e"RTxDatabase(qw(schema \$(NAME) \$(VERSION)))"
+.
+ $initdb .= <<"." if $has_etc{acl};
+\t\$(NOECHO) \$(PERL) -Ilib -I"$local_lib_path" -I"$lib_path" -Iinc -MModule::Install::RTx::Runtime -e"RTxDatabase(qw(acl \$(NAME) \$(VERSION)))"
+.
+ $initdb .= <<"." if $has_etc{initialdata};
+\t\$(NOECHO) \$(PERL) -Ilib -I"$local_lib_path" -I"$lib_path" -Iinc -MModule::Install::RTx::Runtime -e"RTxDatabase(qw(insert \$(NAME) \$(VERSION)))"
+.
+ $self->postamble("initdb ::\n$initdb\n");
+ $self->postamble("initialize-database ::\n$initdb\n");
+ if ($has_etc{upgrade}) {
+ print "To upgrade from a previous version of this extension, use 'make upgrade-database'\n";
+ my $upgradedb = qq|\t\$(NOECHO) \$(PERL) -Ilib -I"$local_lib_path" -I"$lib_path" -Iinc -MModule::Install::RTx::Runtime -e"RTxDatabase(qw(upgrade \$(NAME) \$(VERSION)))"\n|;
+ $self->postamble("upgrade-database ::\n$upgradedb\n");
+ $self->postamble("upgradedb ::\n$upgradedb\n");
+ }
+ }
+
+}
+
+sub requires_rt {
+ my ($self,$version) = @_;
+
+ _load_rt_handle();
+
+ if ($self->is_admin) {
+ $self->add_metadata("x_requires_rt", $version);
+ my @sorted = sort RT::Handle::cmp_version $version,'4.0.0';
+ $self->perl_version('5.008003') if $sorted[0] eq '4.0.0'
+ and (not $self->perl_version or '5.008003' > $self->perl_version);
+ @sorted = sort RT::Handle::cmp_version $version,'4.2.0';
+ $self->perl_version('5.010001') if $sorted[0] eq '4.2.0'
+ and (not $self->perl_version or '5.010001' > $self->perl_version);
+ }
+
+ # if we're exactly the same version as what we want, silently return
+ return if ($version eq $RT::VERSION);
+
+ my @sorted = sort RT::Handle::cmp_version $version,$RT::VERSION;
+
+ if ($sorted[-1] eq $version) {
+ die <<"EOT";
+
+**** Error: This extension requires RT $version. Your installed version
+ of RT ($RT::VERSION) is too old.
+
+EOT
+ }
+}
+
+sub requires_rt_plugin {
+ my $self = shift;
+ my ( $plugin ) = @_;
+
+ if ($self->is_admin) {
+ my $plugins = $self->Meta->{values}{"x_requires_rt_plugins"} || [];
+ push @{$plugins}, $plugin;
+ $self->add_metadata("x_requires_rt_plugins", $plugins);
+ }
+
+ my $path = $plugin;
+ $path =~ s{\:\:}{-}g;
+ $path = "$RT::LocalPluginPath/$path/lib";
+ if ( -e $path ) {
+ unshift @INC, $path;
+ } else {
+ my $name = $self->name;
+ warn <<"EOT";
+
+**** Warning: $name requires that the $plugin plugin be installed and
+ enabled; it does not appear to be installed.
+
+EOT
+ }
+ $self->requires(@_);
+}
+
+sub rt_too_new {
+ my ($self,$version,$msg) = @_;
+ my $name = $self->name;
+ $msg ||= <<EOT;
+
+**** Error: Your installed version of RT (%s) is too new; this extension
+ only works with versions older than %s.
+
+EOT
+ $self->add_metadata("x_rt_too_new", $version) if $self->is_admin;
+
+ _load_rt_handle();
+ my @sorted = sort RT::Handle::cmp_version $version,$RT::VERSION;
+
+ if ($sorted[0] eq $version) {
+ die sprintf($msg,$RT::VERSION,$version);
+ }
+}
+
+# RT::Handle runs FinalizeDatabaseType which calls RT->Config->Get
+# On 3.8, this dies. On 4.0/4.2 ->Config transparently runs LoadConfig.
+# LoadConfig requires being able to read RT_SiteConfig.pm (root) so we'd
+# like to avoid pushing that on users.
+# Fake up just enough Config to let FinalizeDatabaseType finish, and
+# anyone later calling LoadConfig will overwrite our shenanigans.
+sub _load_rt_handle {
+ unless ($RT::Config) {
+ require RT::Config;
+ $RT::Config = RT::Config->new;
+ RT->Config->Set('DatabaseType','mysql');
+ }
+ require RT::Handle;
+}
+
+1;
+
+__END__
+
+#line 428
diff --git a/inc/Module/Install/RTx/Runtime.pm b/inc/Module/Install/RTx/Runtime.pm
new file mode 100644
index 0000000..937949f
--- /dev/null
+++ b/inc/Module/Install/RTx/Runtime.pm
@@ -0,0 +1,79 @@
+#line 1
+package Module::Install::RTx::Runtime;
+
+use base 'Exporter';
+our @EXPORT = qw/RTxDatabase RTxPlugin/;
+
+use strict;
+use File::Basename ();
+
+sub _rt_runtime_load {
+ require RT;
+
+ eval { RT::LoadConfig(); };
+ if (my $err = $@) {
+ die $err unless $err =~ /^RT couldn't load RT config file/m;
+ my $warn = <<EOT;
+This usually means that your current user cannot read the file. You
+will likely need to run this installation step as root, or some user
+with more permissions.
+EOT
+ $err =~ s/This usually means.*/$warn/s;
+ die $err;
+ }
+}
+
+sub RTxDatabase {
+ my ($action, $name, $version) = @_;
+
+ _rt_runtime_load();
+
+ require RT::System;
+ my $has_upgrade = RT::System->can('AddUpgradeHistory');
+
+ my $lib_path = File::Basename::dirname($INC{'RT.pm'});
+ my @args = (
+ "-Ilib",
+ "-I$RT::LocalLibPath",
+ "-I$lib_path",
+ "$RT::SbinPath/rt-setup-database",
+ "--action" => $action,
+ ($action eq 'upgrade' ? () : ("--datadir" => "etc")),
+ (($action eq 'insert') ? ("--datafile" => "etc/initialdata") : ()),
+ "--dba" => $RT::DatabaseAdmin || $RT::DatabaseUser,
+ "--prompt-for-dba-password" => '',
+ ($has_upgrade ? ("--package" => $name, "--ext-version" => $version) : ()),
+ );
+ # If we're upgrading against an RT which isn't at least 4.2 (has
+ # AddUpgradeHistory) then pass --package. Upgrades against later RT
+ # releases will pick up --package from AddUpgradeHistory.
+ if ($action eq 'upgrade' and not $has_upgrade) {
+ push @args, "--package" => $name;
+ }
+
+ print "$^X @args\n";
+ (system($^X, @args) == 0) or die "...returned with error: $?\n";
+}
+
+sub RTxPlugin {
+ my ($name) = @_;
+
+ _rt_runtime_load();
+ require YAML::Tiny;
+ my $data = YAML::Tiny::LoadFile('META.yml');
+ my $name = $data->{name};
+
+ my @enabled = RT->Config->Get('Plugins');
+ for my $required (@{$data->{x_requires_rt_plugins} || []}) {
+ next if grep {$required eq $_} @enabled;
+
+ warn <<"EOT";
+
+**** Warning: $name requires that the $required plugin be installed and
+ enabled; it is not currently in \@Plugins.
+
+EOT
+ }
+}
+
+1;
diff --git a/inc/Module/Install/ReadmeFromPod.pm b/inc/Module/Install/ReadmeFromPod.pm
new file mode 100644
index 0000000..3634ee0
--- /dev/null
+++ b/inc/Module/Install/ReadmeFromPod.pm
@@ -0,0 +1,184 @@
+#line 1
+package Module::Install::ReadmeFromPod;
+
+use 5.006;
+use strict;
+use warnings;
+use base qw(Module::Install::Base);
+use vars qw($VERSION);
+
+$VERSION = '0.26';
+
+{
+
+ # these aren't defined until after _require_admin is run, so
+ # define them so prototypes are available during compilation.
+ sub io;
+ sub capture(&;@);
+
+#line 28
+
+ my $done = 0;
+
+ sub _require_admin {
+
+ # do this once to avoid redefinition warnings from IO::All
+ return if $done;
+
+ require IO::All;
+ IO::All->import( '-binary' );
+
+ require Capture::Tiny;
+ Capture::Tiny->import ( 'capture' );
+
+ return;
+ }
+
+}
+
+sub readme_from {
+ my $self = shift;
+ return unless $self->is_admin;
+
+ _require_admin;
+
+ # Input file
+ my $in_file = shift || $self->_all_from
+ or die "Can't determine file to make readme_from";
+
+ # Get optional arguments
+ my ($clean, $format, $out_file, $options);
+ my $args = shift;
+ if ( ref $args ) {
+ # Arguments are in a hashref
+ if ( ref($args) ne 'HASH' ) {
+ die "Expected a hashref but got a ".ref($args)."\n";
+ } else {
+ $clean = $args->{'clean'};
+ $format = $args->{'format'};
+ $out_file = $args->{'output_file'};
+ $options = $args->{'options'};
+ }
+ } else {
+ # Arguments are in a list
+ $clean = $args;
+ $format = shift;
+ $out_file = shift;
+ $options = \@_;
+ }
+
+ # Default values;
+ $clean ||= 0;
+ $format ||= 'txt';
+
+ # Generate README
+ print "readme_from $in_file to $format\n";
+ if ($format =~ m/te?xt/) {
+ $out_file = $self->_readme_txt($in_file, $out_file, $options);
+ } elsif ($format =~ m/html?/) {
+ $out_file = $self->_readme_htm($in_file, $out_file, $options);
+ } elsif ($format eq 'man') {
+ $out_file = $self->_readme_man($in_file, $out_file, $options);
+ } elsif ($format eq 'md') {
+ $out_file = $self->_readme_md($in_file, $out_file, $options);
+ } elsif ($format eq 'pdf') {
+ $out_file = $self->_readme_pdf($in_file, $out_file, $options);
+ }
+
+ if ($clean) {
+ $self->clean_files($out_file);
+ }
+
+ return 1;
+}
+
+
+sub _readme_txt {
+ my ($self, $in_file, $out_file, $options) = @_;
+ $out_file ||= 'README';
+ require Pod::Text;
+ my $parser = Pod::Text->new( @$options );
+ my $io = io->file($out_file)->open(">");
+ my $out_fh = $io->io_handle;
+ $parser->output_fh( *$out_fh );
+ $parser->parse_file( $in_file );
+ return $out_file;
+}
+
+
+sub _readme_htm {
+ my ($self, $in_file, $out_file, $options) = @_;
+ $out_file ||= 'README.htm';
+ require Pod::Html;
+ my ($o) = capture {
+ Pod::Html::pod2html(
+ "--infile=$in_file",
+ "--outfile=-",
+ @$options,
+ );
+ };
+ io->file($out_file)->print($o);
+ # Remove temporary files if needed
+ for my $file ('pod2htmd.tmp', 'pod2htmi.tmp') {
+ if (-e $file) {
+ unlink $file or warn "Warning: Could not remove file '$file'.\n$!\n";
+ }
+ }
+ return $out_file;
+}
+
+
+sub _readme_man {
+ my ($self, $in_file, $out_file, $options) = @_;
+ $out_file ||= 'README.1';
+ require Pod::Man;
+ my $parser = Pod::Man->new( @$options );
+ my $io = io->file($out_file)->open(">");
+ my $out_fh = $io->io_handle;
+ $parser->output_fh( *$out_fh );
+ $parser->parse_file( $in_file );
+ return $out_file;
+}
+
+
+sub _readme_pdf {
+ my ($self, $in_file, $out_file, $options) = @_;
+ $out_file ||= 'README.pdf';
+ eval { require App::pod2pdf; }
+ or die "Could not generate $out_file because pod2pdf could not be found\n";
+ my $parser = App::pod2pdf->new( @$options );
+ $parser->parse_from_file($in_file);
+ my ($o) = capture { $parser->output };
+ io->file($out_file)->print($o);
+ return $out_file;
+}
+
+sub _readme_md {
+ my ($self, $in_file, $out_file, $options) = @_;
+ $out_file ||= 'README.md';
+ require Pod::Markdown;
+ my $parser = Pod::Markdown->new( @$options );
+ my $io = io->file($out_file)->open(">");
+ my $out_fh = $io->io_handle;
+ $parser->output_fh( *$out_fh );
+ $parser->parse_file( $in_file );
+ return $out_file;
+}
+
+
+sub _all_from {
+ my $self = shift;
+ return unless $self->admin->{extensions};
+ my ($metadata) = grep {
+ ref($_) eq 'Module::Install::Metadata';
+ } @{$self->admin->{extensions}};
+ return unless $metadata;
+ return $metadata->{values}{all_from} || '';
+}
+
+'Readme!';
+
+__END__
+
+#line 316
+
diff --git a/inc/Module/Install/Substitute.pm b/inc/Module/Install/Substitute.pm
new file mode 100644
index 0000000..56af7fe
--- /dev/null
+++ b/inc/Module/Install/Substitute.pm
@@ -0,0 +1,131 @@
+#line 1
+package Module::Install::Substitute;
+
+use strict;
+use warnings;
+use 5.008; # I don't care much about earlier versions
+
+use Module::Install::Base;
+our @ISA = qw(Module::Install::Base);
+
+our $VERSION = '0.03';
+
+require File::Temp;
+require File::Spec;
+require Cwd;
+
+#line 89
+
+sub substitute
+{
+ my $self = shift;
+ $self->{__subst} = shift;
+ $self->{__option} = {};
+ if( UNIVERSAL::isa( $_[0], 'HASH' ) ) {
+ my $opts = shift;
+ while( my ($k,$v) = each( %$opts ) ) {
+ $self->{__option}->{ lc( $k ) } = $v || '';
+ }
+ }
+ $self->_parse_options;
+
+ my @file = @_;
+ foreach my $f (@file) {
+ $self->_rewrite_file( $f );
+ }
+
+ return;
+}
+
+sub _parse_options
+{
+ my $self = shift;
+ my $cwd = Cwd::getcwd();
+ foreach my $t ( qw(from to) ) {
+ $self->{__option}->{$t} = $cwd unless $self->{__option}->{$t};
+ my $d = $self->{__option}->{$t};
+ die "Couldn't read directory '$d'" unless -d $d && -r _;
+ }
+}
+
+sub _rewrite_file
+{
+ my ($self, $file) = @_;
+ my $source = File::Spec->catfile( $self->{__option}{from}, $file );
+ $source .= $self->{__option}{sufix} if $self->{__option}{sufix};
+ unless( -f $source && -r _ ) {
+ print STDERR "Couldn't find file '$source'\n";
+ return;
+ }
+ my $dest = File::Spec->catfile( $self->{__option}{to}, $file );
+ return $self->__rewrite_file( $source, $dest );
+}
+
+sub __rewrite_file
+{
+ my ($self, $source, $dest) = @_;
+
+ my $mode = (stat($source))[2];
+
+ open my $sfh, "<$source" or die "Couldn't open '$source' for read";
+ print "Open input '$source' file for substitution\n";
+
+ my ($tmpfh, $tmpfname) = File::Temp::tempfile('mi-subst-XXXX', UNLINK => 1);
+ $self->__process_streams( $sfh, $tmpfh, ($source eq $dest)? 1: 0 );
+ close $sfh;
+
+ seek $tmpfh, 0, 0 or die "Couldn't seek in tmp file";
+
+ open my $dfh, ">$dest" or die "Couldn't open '$dest' for write";
+ print "Open output '$dest' file for substitution\n";
+
+ while( <$tmpfh> ) {
+ print $dfh $_;
+ }
+ close $dfh;
+ chmod $mode, $dest or "Couldn't change mode on '$dest'";
+}
+
+sub __process_streams
+{
+ my ($self, $in, $out, $replace) = @_;
+
+ my @queue = ();
+ my $subst = $self->{'__subst'};
+ my $re_subst = join('|', map {"\Q$_"} keys %{ $subst } );
+
+ while( my $str = <$in> ) {
+ if( $str =~ /^###\s*(before|replace|after)\:\s?(.*)$/s ) {
+ my ($action, $nstr) = ($1,$2);
+ $nstr =~ s/\@($re_subst)\@/$subst->{$1}/ge;
+
+ die "Replace action is bad idea for situations when dest is equal to source"
+ if $replace && $action eq 'replace';
+ if( $action eq 'before' ) {
+ die "no line before 'before' action" unless @queue;
+ # overwrite prev line;
+ pop @queue;
+ push @queue, $nstr;
+ push @queue, $str;
+ } elsif( $action eq 'replace' ) {
+ push @queue, $nstr;
+ } elsif( $action eq 'after' ) {
+ push @queue, $str;
+ push @queue, $nstr;
+ # skip one line;
+ <$in>;
+ }
+ } else {
+ push @queue, $str;
+ }
+ while( @queue > 3 ) {
+ print $out shift(@queue);
+ }
+ }
+ while( scalar @queue ) {
+ print $out shift(@queue);
+ }
+}
+
+1;
+
diff --git a/inc/Module/Install/Win32.pm b/inc/Module/Install/Win32.pm
new file mode 100644
index 0000000..218a66b
--- /dev/null
+++ b/inc/Module/Install/Win32.pm
@@ -0,0 +1,64 @@
+#line 1
+package Module::Install::Win32;
+
+use strict;
+use Module::Install::Base ();
+
+use vars qw{$VERSION @ISA $ISCORE};
+BEGIN {
+ $VERSION = '1.16';
+ @ISA = 'Module::Install::Base';
+ $ISCORE = 1;
+}
+
+# determine if the user needs nmake, and download it if needed
+sub check_nmake {
+ my $self = shift;
+ $self->load('can_run');
+ $self->load('get_file');
+
+ require Config;
+ return unless (
+ $^O eq 'MSWin32' and
+ $Config::Config{make} and
+ $Config::Config{make} =~ /^nmake\b/i and
+ ! $self->can_run('nmake')
+ );
+
+ print "The required 'nmake' executable not found, fetching it...\n";
+
+ require File::Basename;
+ my $rv = $self->get_file(
+ url => 'http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe',
+ ftp_url => 'ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe',
+ local_dir => File::Basename::dirname($^X),
+ size => 51928,
+ run => 'Nmake15.exe /o > nul',
+ check_for => 'Nmake.exe',
+ remove => 1,
+ );
+
+ die <<'END_MESSAGE' unless $rv;
+
+-------------------------------------------------------------------------------
+
+Since you are using Microsoft Windows, you will need the 'nmake' utility
+before installation. It's available at:
+
+ http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe
+ or
+ ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe
+
+Please download the file manually, save it to a directory in %PATH% (e.g.
+C:\WINDOWS\COMMAND\), then launch the MS-DOS command line shell, "cd" to
+that directory, and run "Nmake15.exe" from there; that will create the
+'nmake.exe' file needed by this module.
+
+You may then resume the installation process described in README.
+
+-------------------------------------------------------------------------------
+END_MESSAGE
+
+}
+
+1;
diff --git a/inc/Module/Install/WriteAll.pm b/inc/Module/Install/WriteAll.pm
new file mode 100644
index 0000000..530749b
--- /dev/null
+++ b/inc/Module/Install/WriteAll.pm
@@ -0,0 +1,63 @@
+#line 1
+package Module::Install::WriteAll;
+
+use strict;
+use Module::Install::Base ();
+
+use vars qw{$VERSION @ISA $ISCORE};
+BEGIN {
+ $VERSION = '1.16';
+ @ISA = qw{Module::Install::Base};
+ $ISCORE = 1;
+}
+
+sub WriteAll {
+ my $self = shift;
+ my %args = (
+ meta => 1,
+ sign => 0,
+ inline => 0,
+ check_nmake => 1,
+ @_,
+ );
+
+ $self->sign(1) if $args{sign};
+ $self->admin->WriteAll(%args) if $self->is_admin;
+
+ $self->check_nmake if $args{check_nmake};
+ unless ( $self->makemaker_args->{PL_FILES} ) {
+ # XXX: This still may be a bit over-defensive...
+ unless ($self->makemaker(6.25)) {
+ $self->makemaker_args( PL_FILES => {} ) if -f 'Build.PL';
+ }
+ }
+
+ # Until ExtUtils::MakeMaker support MYMETA.yml, make sure
+ # we clean it up properly ourself.
+ $self->realclean_files('MYMETA.yml');
+
+ if ( $args{inline} ) {
+ $self->Inline->write;
+ } else {
+ $self->Makefile->write;
+ }
+
+ # The Makefile write process adds a couple of dependencies,
+ # so write the META.yml files after the Makefile.
+ if ( $args{meta} ) {
+ $self->Meta->write;
+ }
+
+ # Experimental support for MYMETA
+ if ( $ENV{X_MYMETA} ) {
+ if ( $ENV{X_MYMETA} eq 'JSON' ) {
+ $self->Meta->write_mymeta_json;
+ } else {
+ $self->Meta->write_mymeta_yaml;
+ }
+ }
+
+ return 1;
+}
+
+1;
diff --git a/inc/YAML/Tiny.pm b/inc/YAML/Tiny.pm
new file mode 100644
index 0000000..aa539f7
--- /dev/null
+++ b/inc/YAML/Tiny.pm
@@ -0,0 +1,874 @@
+#line 1
+use 5.008001; # sane UTF-8 support
+use strict;
+use warnings;
+package YAML::Tiny; # git description: v1.68-2-gcc5324e
+# XXX-INGY is 5.8.1 too old/broken for utf8?
+# XXX-XDG Lancaster consensus was that it was sufficient until
+# proven otherwise
+
+our $VERSION = '1.69';
+
+#####################################################################
+# The YAML::Tiny API.
+#
+# These are the currently documented API functions/methods and
+# exports:
+
+use Exporter;
+our @ISA = qw{ Exporter };
+our @EXPORT = qw{ Load Dump };
+our @EXPORT_OK = qw{ LoadFile DumpFile freeze thaw };
+
+###
+# Functional/Export API:
+
+sub Dump {
+ return YAML::Tiny->new(@_)->_dump_string;
+}
+
+# XXX-INGY Returning last document seems a bad behavior.
+# XXX-XDG I think first would seem more natural, but I don't know
+# that it's worth changing now
+sub Load {
+ my $self = YAML::Tiny->_load_string(@_);
+ if ( wantarray ) {
+ return @$self;
+ } else {
+ # To match YAML.pm, return the last document
+ return $self->[-1];
+ }
+}
+
+# XXX-INGY Do we really need freeze and thaw?
+# XXX-XDG I don't think so. I'd support deprecating them.
+BEGIN {
+ *freeze = \&Dump;
+ *thaw = \&Load;
+}
+
+sub DumpFile {
+ my $file = shift;
+ return YAML::Tiny->new(@_)->_dump_file($file);
+}
+
+sub LoadFile {
+ my $file = shift;
+ my $self = YAML::Tiny->_load_file($file);
+ if ( wantarray ) {
+ return @$self;
+ } else {
+ # Return only the last document to match YAML.pm,
+ return $self->[-1];
+ }
+}
+
+
+###
+# Object Oriented API:
+
+# Create an empty YAML::Tiny object
+# XXX-INGY Why do we use ARRAY object?
+# NOTE: I get it now, but I think it's confusing and not needed.
+# Will change it on a branch later, for review.
+#
+# XXX-XDG I don't support changing it yet. It's a very well-documented
+# "API" of YAML::Tiny. I'd support deprecating it, but Adam suggested
+# we not change it until YAML.pm's own OO API is established so that
+# users only have one API change to digest, not two
+sub new {
+ my $class = shift;
+ bless [ @_ ], $class;
+}
+
+# XXX-INGY It probably doesn't matter, and it's probably too late to
+# change, but 'read/write' are the wrong names. Read and Write
+# are actions that take data from storage to memory
+# characters/strings. These take the data to/from storage to native
+# Perl objects, which the terms dump and load are meant. As long as
+# this is a legacy quirk to YAML::Tiny it's ok, but I'd prefer not
+# to add new {read,write}_* methods to this API.
+
+sub read_string {
+ my $self = shift;
+ $self->_load_string(@_);
+}
+
+sub write_string {
+ my $self = shift;
+ $self->_dump_string(@_);
+}
+
+sub read {
+ my $self = shift;
+ $self->_load_file(@_);
+}
+
+sub write {
+ my $self = shift;
+ $self->_dump_file(@_);
+}
+
+
+
+
+#####################################################################
+# Constants
+
+# Printed form of the unprintable characters in the lowest range
+# of ASCII characters, listed by ASCII ordinal position.
+my @UNPRINTABLE = qw(
+ 0 x01 x02 x03 x04 x05 x06 a
+ b t n v f r x0E x0F
+ x10 x11 x12 x13 x14 x15 x16 x17
+ x18 x19 x1A e x1C x1D x1E x1F
+);
+
+# Printable characters for escapes
+my %UNESCAPES = (
+ 0 => "\x00", z => "\x00", N => "\x85",
+ a => "\x07", b => "\x08", t => "\x09",
+ n => "\x0a", v => "\x0b", f => "\x0c",
+ r => "\x0d", e => "\x1b", '\\' => '\\',
+);
+
+# XXX-INGY
+# I(ngy) need to decide if these values should be quoted in
+# YAML::Tiny or not. Probably yes.
+
+# These 3 values have special meaning when unquoted and using the
+# default YAML schema. They need quotes if they are strings.
+my %QUOTE = map { $_ => 1 } qw{
+ null true false
+};
+
+# The commented out form is simpler, but overloaded the Perl regex
+# engine due to recursion and backtracking problems on strings
+# larger than 32,000ish characters. Keep it for reference purposes.
+# qr/\"((?:\\.|[^\"])*)\"/
+my $re_capture_double_quoted = qr/\"([^\\"]*(?:\\.[^\\"]*)*)\"/;
+my $re_capture_single_quoted = qr/\'([^\']*(?:\'\'[^\']*)*)\'/;
+# unquoted re gets trailing space that needs to be stripped
+my $re_capture_unquoted_key = qr/([^:]+(?::+\S(?:[^:]*|.*?(?=:)))*)(?=\s*\:(?:\s+|$))/;
+my $re_trailing_comment = qr/(?:\s+\#.*)?/;
+my $re_key_value_separator = qr/\s*:(?:\s+(?:\#.*)?|$)/;
+
+
+
+
+
+#####################################################################
+# YAML::Tiny Implementation.
+#
+# These are the private methods that do all the work. They may change
+# at any time.
+
+
+###
+# Loader functions:
+
+# Create an object from a file
+sub _load_file {
+ my $class = ref $_[0] ? ref shift : shift;
+
+ # Check the file
+ my $file = shift or $class->_error( 'You did not specify a file name' );
+ $class->_error( "File '$file' does not exist" )
+ unless -e $file;
+ $class->_error( "'$file' is a directory, not a file" )
+ unless -f _;
+ $class->_error( "Insufficient permissions to read '$file'" )
+ unless -r _;
+
+ # Open unbuffered with strict UTF-8 decoding and no translation layers
+ open( my $fh, "<:unix:encoding(UTF-8)", $file );
+ unless ( $fh ) {
+ $class->_error("Failed to open file '$file': $!");
+ }
+
+ # flock if available (or warn if not possible for OS-specific reasons)
+ if ( _can_flock() ) {
+ flock( $fh, Fcntl::LOCK_SH() )
+ or warn "Couldn't lock '$file' for reading: $!";
+ }
+
+ # slurp the contents
+ my $contents = eval {
+ use warnings FATAL => 'utf8';
+ local $/;
+ <$fh>
+ };
+ if ( my $err = $@ ) {
+ $class->_error("Error reading from file '$file': $err");
+ }
+
+ # close the file (release the lock)
+ unless ( close $fh ) {
+ $class->_error("Failed to close file '$file': $!");
+ }
+
+ $class->_load_string( $contents );
+}
+
+# Create an object from a string
+sub _load_string {
+ my $class = ref $_[0] ? ref shift : shift;
+ my $self = bless [], $class;
+ my $string = $_[0];
+ eval {
+ unless ( defined $string ) {
+ die \"Did not provide a string to load";
+ }
+
+ # Check if Perl has it marked as characters, but it's internally
+ # inconsistent. E.g. maybe latin1 got read on a :utf8 layer
+ if ( utf8::is_utf8($string) && ! utf8::valid($string) ) {
+ die \<<'...';
+Read an invalid UTF-8 string (maybe mixed UTF-8 and 8-bit character set).
+Did you decode with lax ":utf8" instead of strict ":encoding(UTF-8)"?
+...
+ }
+
+ # Ensure Unicode character semantics, even for 0x80-0xff
+ utf8::upgrade($string);
+
+ # Check for and strip any leading UTF-8 BOM
+ $string =~ s/^\x{FEFF}//;
+
+ # Check for some special cases
+ return $self unless length $string;
+
+ # Split the file into lines
+ my @lines = grep { ! /^\s*(?:\#.*)?\z/ }
+ split /(?:\015{1,2}\012|\015|\012)/, $string;
+
+ # Strip the initial YAML header
+ @lines and $lines[0] =~ /^\%YAML[: ][\d\.]+.*\z/ and shift @lines;
+
+ # A nibbling parser
+ my $in_document = 0;
+ while ( @lines ) {
+ # Do we have a document header?
+ if ( $lines[0] =~ /^---\s*(?:(.+)\s*)?\z/ ) {
+ # Handle scalar documents
+ shift @lines;
+ if ( defined $1 and $1 !~ /^(?:\#.+|\%YAML[: ][\d\.]+)\z/ ) {
+ push @$self,
+ $self->_load_scalar( "$1", [ undef ], \@lines );
+ next;
+ }
+ $in_document = 1;
+ }
+
+ if ( ! @lines or $lines[0] =~ /^(?:---|\.\.\.)/ ) {
+ # A naked document
+ push @$self, undef;
+ while ( @lines and $lines[0] !~ /^---/ ) {
+ shift @lines;
+ }
+ $in_document = 0;
+
+ # XXX The final '-+$' is to look for -- which ends up being an
+ # error later.
+ } elsif ( ! $in_document && @$self ) {
+ # only the first document can be explicit
+ die \"YAML::Tiny failed to classify the line '$lines[0]'";
+ } elsif ( $lines[0] =~ /^\s*\-(?:\s|$|-+$)/ ) {
+ # An array at the root
+ my $document = [ ];
+ push @$self, $document;
+ $self->_load_array( $document, [ 0 ], \@lines );
+
+ } elsif ( $lines[0] =~ /^(\s*)\S/ ) {
+ # A hash at the root
+ my $document = { };
+ push @$self, $document;
+ $self->_load_hash( $document, [ length($1) ], \@lines );
+
+ } else {
+ # Shouldn't get here. @lines have whitespace-only lines
+ # stripped, and previous match is a line with any
+ # non-whitespace. So this clause should only be reachable via
+ # a perlbug where \s is not symmetric with \S
+
+ # uncoverable statement
+ die \"YAML::Tiny failed to classify the line '$lines[0]'";
+ }
+ }
+ };
+ my $err = $@;
+ if ( ref $err eq 'SCALAR' ) {
+ $self->_error(${$err});
+ } elsif ( $err ) {
+ $self->_error($err);
+ }
+
+ return $self;
+}
+
+sub _unquote_single {
+ my ($self, $string) = @_;
+ return '' unless length $string;
+ $string =~ s/\'\'/\'/g;
+ return $string;
+}
+
+sub _unquote_double {
+ my ($self, $string) = @_;
+ return '' unless length $string;
+ $string =~ s/\\"/"/g;
+ $string =~
+ s{\\([Nnever\\fartz0b]|x([0-9a-fA-F]{2}))}
+ {(length($1)>1)?pack("H2",$2):$UNESCAPES{$1}}gex;
+ return $string;
+}
+
+# Load a YAML scalar string to the actual Perl scalar
+sub _load_scalar {
+ my ($self, $string, $indent, $lines) = @_;
+
+ # Trim trailing whitespace
+ $string =~ s/\s*\z//;
+
+ # Explitic null/undef
+ return undef if $string eq '~';
+
+ # Single quote
+ if ( $string =~ /^$re_capture_single_quoted$re_trailing_comment\z/ ) {
+ return $self->_unquote_single($1);
+ }
+
+ # Double quote.
+ if ( $string =~ /^$re_capture_double_quoted$re_trailing_comment\z/ ) {
+ return $self->_unquote_double($1);
+ }
+
+ # Special cases
+ if ( $string =~ /^[\'\"!&]/ ) {
+ die \"YAML::Tiny does not support a feature in line '$string'";
+ }
+ return {} if $string =~ /^{}(?:\s+\#.*)?\z/;
+ return [] if $string =~ /^\[\](?:\s+\#.*)?\z/;
+
+ # Regular unquoted string
+ if ( $string !~ /^[>|]/ ) {
+ die \"YAML::Tiny found illegal characters in plain scalar: '$string'"
+ if $string =~ /^(?:-(?:\s|$)|[\@\%\`])/ or
+ $string =~ /:(?:\s|$)/;
+ $string =~ s/\s+#.*\z//;
+ return $string;
+ }
+
+ # Error
+ die \"YAML::Tiny failed to find multi-line scalar content" unless @$lines;
+
+ # Check the indent depth
+ $lines->[0] =~ /^(\s*)/;
+ $indent->[-1] = length("$1");
+ if ( defined $indent->[-2] and $indent->[-1] <= $indent->[-2] ) {
+ die \"YAML::Tiny found bad indenting in line '$lines->[0]'";
+ }
+
+ # Pull the lines
+ my @multiline = ();
+ while ( @$lines ) {
+ $lines->[0] =~ /^(\s*)/;
+ last unless length($1) >= $indent->[-1];
+ push @multiline, substr(shift(@$lines), length($1));
+ }
+
+ my $j = (substr($string, 0, 1) eq '>') ? ' ' : "\n";
+ my $t = (substr($string, 1, 1) eq '-') ? '' : "\n";
+ return join( $j, @multiline ) . $t;
+}
+
+# Load an array
+sub _load_array {
+ my ($self, $array, $indent, $lines) = @_;
+
+ while ( @$lines ) {
+ # Check for a new document
+ if ( $lines->[0] =~ /^(?:---|\.\.\.)/ ) {
+ while ( @$lines and $lines->[0] !~ /^---/ ) {
+ shift @$lines;
+ }
+ return 1;
+ }
+
+ # Check the indent level
+ $lines->[0] =~ /^(\s*)/;
+ if ( length($1) < $indent->[-1] ) {
+ return 1;
+ } elsif ( length($1) > $indent->[-1] ) {
+ die \"YAML::Tiny found bad indenting in line '$lines->[0]'";
+ }
+
+ if ( $lines->[0] =~ /^(\s*\-\s+)[^\'\"]\S*\s*:(?:\s+|$)/ ) {
+ # Inline nested hash
+ my $indent2 = length("$1");
+ $lines->[0] =~ s/-/ /;
+ push @$array, { };
+ $self->_load_hash( $array->[-1], [ @$indent, $indent2 ], $lines );
+
+ } elsif ( $lines->[0] =~ /^\s*\-\s*\z/ ) {
+ shift @$lines;
+ unless ( @$lines ) {
+ push @$array, undef;
+ return 1;
+ }
+ if ( $lines->[0] =~ /^(\s*)\-/ ) {
+ my $indent2 = length("$1");
+ if ( $indent->[-1] == $indent2 ) {
+ # Null array entry
+ push @$array, undef;
+ } else {
+ # Naked indenter
+ push @$array, [ ];
+ $self->_load_array(
+ $array->[-1], [ @$indent, $indent2 ], $lines
+ );
+ }
+
+ } elsif ( $lines->[0] =~ /^(\s*)\S/ ) {
+ push @$array, { };
+ $self->_load_hash(
+ $array->[-1], [ @$indent, length("$1") ], $lines
+ );
+
+ } else {
+ die \"YAML::Tiny failed to classify line '$lines->[0]'";
+ }
+
+ } elsif ( $lines->[0] =~ /^\s*\-(\s*)(.+?)\s*\z/ ) {
+ # Array entry with a value
+ shift @$lines;
+ push @$array, $self->_load_scalar(
+ "$2", [ @$indent, undef ], $lines
+ );
+
+ } elsif ( defined $indent->[-2] and $indent->[-1] == $indent->[-2] ) {
+ # This is probably a structure like the following...
+ # ---
+ # foo:
+ # - list
+ # bar: value
+ #
+ # ... so lets return and let the hash parser handle it
+ return 1;
+
+ } else {
+ die \"YAML::Tiny failed to classify line '$lines->[0]'";
+ }
+ }
+
+ return 1;
+}
+
+# Load a hash
+sub _load_hash {
+ my ($self, $hash, $indent, $lines) = @_;
+
+ while ( @$lines ) {
+ # Check for a new document
+ if ( $lines->[0] =~ /^(?:---|\.\.\.)/ ) {
+ while ( @$lines and $lines->[0] !~ /^---/ ) {
+ shift @$lines;
+ }
+ return 1;
+ }
+
+ # Check the indent level
+ $lines->[0] =~ /^(\s*)/;
+ if ( length($1) < $indent->[-1] ) {
+ return 1;
+ } elsif ( length($1) > $indent->[-1] ) {
+ die \"YAML::Tiny found bad indenting in line '$lines->[0]'";
+ }
+
+ # Find the key
+ my $key;
+
+ # Quoted keys
+ if ( $lines->[0] =~
+ s/^\s*$re_capture_single_quoted$re_key_value_separator//
+ ) {
+ $key = $self->_unquote_single($1);
+ }
+ elsif ( $lines->[0] =~
+ s/^\s*$re_capture_double_quoted$re_key_value_separator//
+ ) {
+ $key = $self->_unquote_double($1);
+ }
+ elsif ( $lines->[0] =~
+ s/^\s*$re_capture_unquoted_key$re_key_value_separator//
+ ) {
+ $key = $1;
+ $key =~ s/\s+$//;
+ }
+ elsif ( $lines->[0] =~ /^\s*\?/ ) {
+ die \"YAML::Tiny does not support a feature in line '$lines->[0]'";
+ }
+ else {
+ die \"YAML::Tiny failed to classify line '$lines->[0]'";
+ }
+
+ if ( exists $hash->{$key} ) {
+ warn "YAML::Tiny found a duplicate key '$key' in line '$lines->[0]'";
+ }
+
+ # Do we have a value?
+ if ( length $lines->[0] ) {
+ # Yes
+ $hash->{$key} = $self->_load_scalar(
+ shift(@$lines), [ @$indent, undef ], $lines
+ );
+ } else {
+ # An indent
+ shift @$lines;
+ unless ( @$lines ) {
+ $hash->{$key} = undef;
+ return 1;
+ }
+ if ( $lines->[0] =~ /^(\s*)-/ ) {
+ $hash->{$key} = [];
+ $self->_load_array(
+ $hash->{$key}, [ @$indent, length($1) ], $lines
+ );
+ } elsif ( $lines->[0] =~ /^(\s*)./ ) {
+ my $indent2 = length("$1");
+ if ( $indent->[-1] >= $indent2 ) {
+ # Null hash entry
+ $hash->{$key} = undef;
+ } else {
+ $hash->{$key} = {};
+ $self->_load_hash(
+ $hash->{$key}, [ @$indent, length($1) ], $lines
+ );
+ }
+ }
+ }
+ }
+
+ return 1;
+}
+
+
+###
+# Dumper functions:
+
+# Save an object to a file
+sub _dump_file {
+ my $self = shift;
+
+ require Fcntl;
+
+ # Check the file
+ my $file = shift or $self->_error( 'You did not specify a file name' );
+
+ my $fh;
+ # flock if available (or warn if not possible for OS-specific reasons)
+ if ( _can_flock() ) {
+ # Open without truncation (truncate comes after lock)
+ my $flags = Fcntl::O_WRONLY()|Fcntl::O_CREAT();
+ sysopen( $fh, $file, $flags );
+ unless ( $fh ) {
+ $self->_error("Failed to open file '$file' for writing: $!");
+ }
+
+ # Use no translation and strict UTF-8
+ binmode( $fh, ":raw:encoding(UTF-8)");
+
+ flock( $fh, Fcntl::LOCK_EX() )
+ or warn "Couldn't lock '$file' for reading: $!";
+
+ # truncate and spew contents
+ truncate $fh, 0;
+ seek $fh, 0, 0;
+ }
+ else {
+ open $fh, ">:unix:encoding(UTF-8)", $file;
+ }
+
+ # serialize and spew to the handle
+ print {$fh} $self->_dump_string;
+
+ # close the file (release the lock)
+ unless ( close $fh ) {
+ $self->_error("Failed to close file '$file': $!");
+ }
+
+ return 1;
+}
+
+# Save an object to a string
+sub _dump_string {
+ my $self = shift;
+ return '' unless ref $self && @$self;
+
+ # Iterate over the documents
+ my $indent = 0;
+ my @lines = ();
+
+ eval {
+ foreach my $cursor ( @$self ) {
+ push @lines, '---';
+
+ # An empty document
+ if ( ! defined $cursor ) {
+ # Do nothing
+
+ # A scalar document
+ } elsif ( ! ref $cursor ) {
+ $lines[-1] .= ' ' . $self->_dump_scalar( $cursor );
+
+ # A list at the root
+ } elsif ( ref $cursor eq 'ARRAY' ) {
+ unless ( @$cursor ) {
+ $lines[-1] .= ' []';
+ next;
+ }
+ push @lines, $self->_dump_array( $cursor, $indent, {} );
+
+ # A hash at the root
+ } elsif ( ref $cursor eq 'HASH' ) {
+ unless ( %$cursor ) {
+ $lines[-1] .= ' {}';
+ next;
+ }
+ push @lines, $self->_dump_hash( $cursor, $indent, {} );
+
+ } else {
+ die \("Cannot serialize " . ref($cursor));
+ }
+ }
+ };
+ if ( ref $@ eq 'SCALAR' ) {
+ $self->_error(${$@});
+ } elsif ( $@ ) {
+ $self->_error($@);
+ }
+
+ join '', map { "$_\n" } @lines;
+}
+
+sub _has_internal_string_value {
+ my $value = shift;
+ my $b_obj = B::svref_2object(\$value); # for round trip problem
+ return $b_obj->FLAGS & B::SVf_POK();
+}
+
+sub _dump_scalar {
+ my $string = $_[1];
+ my $is_key = $_[2];
+ # Check this before checking length or it winds up looking like a string!
+ my $has_string_flag = _has_internal_string_value($string);
+ return '~' unless defined $string;
+ return "''" unless length $string;
+ if (Scalar::Util::looks_like_number($string)) {
+ # keys and values that have been used as strings get quoted
+ if ( $is_key || $has_string_flag ) {
+ return qq['$string'];
+ }
+ else {
+ return $string;
+ }
+ }
+ if ( $string =~ /[\x00-\x09\x0b-\x0d\x0e-\x1f\x7f-\x9f\'\n]/ ) {
+ $string =~ s/\\/\\\\/g;
+ $string =~ s/"/\\"/g;
+ $string =~ s/\n/\\n/g;
+ $string =~ s/[\x85]/\\N/g;
+ $string =~ s/([\x00-\x1f])/\\$UNPRINTABLE[ord($1)]/g;
+ $string =~ s/([\x7f-\x9f])/'\x' . sprintf("%X",ord($1))/ge;
+ return qq|"$string"|;
+ }
+ if ( $string =~ /(?:^[~!@#%&*|>?:,'"`{}\[\]]|^-+$|\s|:\z)/ or
+ $QUOTE{$string}
+ ) {
+ return "'$string'";
+ }
+ return $string;
+}
+
+sub _dump_array {
+ my ($self, $array, $indent, $seen) = @_;
+ if ( $seen->{refaddr($array)}++ ) {
+ die \"YAML::Tiny does not support circular references";
+ }
+ my @lines = ();
+ foreach my $el ( @$array ) {
+ my $line = (' ' x $indent) . '-';
+ my $type = ref $el;
+ if ( ! $type ) {
+ $line .= ' ' . $self->_dump_scalar( $el );
+ push @lines, $line;
+
+ } elsif ( $type eq 'ARRAY' ) {
+ if ( @$el ) {
+ push @lines, $line;
+ push @lines, $self->_dump_array( $el, $indent + 1, $seen );
+ } else {
+ $line .= ' []';
+ push @lines, $line;
+ }
+
+ } elsif ( $type eq 'HASH' ) {
+ if ( keys %$el ) {
+ push @lines, $line;
+ push @lines, $self->_dump_hash( $el, $indent + 1, $seen );
+ } else {
+ $line .= ' {}';
+ push @lines, $line;
+ }
+
+ } else {
+ die \"YAML::Tiny does not support $type references";
+ }
+ }
+
+ @lines;
+}
+
+sub _dump_hash {
+ my ($self, $hash, $indent, $seen) = @_;
+ if ( $seen->{refaddr($hash)}++ ) {
+ die \"YAML::Tiny does not support circular references";
+ }
+ my @lines = ();
+ foreach my $name ( sort keys %$hash ) {
+ my $el = $hash->{$name};
+ my $line = (' ' x $indent) . $self->_dump_scalar($name, 1) . ":";
+ my $type = ref $el;
+ if ( ! $type ) {
+ $line .= ' ' . $self->_dump_scalar( $el );
+ push @lines, $line;
+
+ } elsif ( $type eq 'ARRAY' ) {
+ if ( @$el ) {
+ push @lines, $line;
+ push @lines, $self->_dump_array( $el, $indent + 1, $seen );
+ } else {
+ $line .= ' []';
+ push @lines, $line;
+ }
+
+ } elsif ( $type eq 'HASH' ) {
+ if ( keys %$el ) {
+ push @lines, $line;
+ push @lines, $self->_dump_hash( $el, $indent + 1, $seen );
+ } else {
+ $line .= ' {}';
+ push @lines, $line;
+ }
+
+ } else {
+ die \"YAML::Tiny does not support $type references";
+ }
+ }
+
+ @lines;
+}
+
+
+
+#####################################################################
+# DEPRECATED API methods:
+
+# Error storage (DEPRECATED as of 1.57)
+our $errstr = '';
+
+# Set error
+sub _error {
+ require Carp;
+ $errstr = $_[1];
+ $errstr =~ s/ at \S+ line \d+.*//;
+ Carp::croak( $errstr );
+}
+
+# Retrieve error
+my $errstr_warned;
+sub errstr {
+ require Carp;
+ Carp::carp( "YAML::Tiny->errstr and \$YAML::Tiny::errstr is deprecated" )
+ unless $errstr_warned++;
+ $errstr;
+}
+
+
+
+
+#####################################################################
+# Helper functions. Possibly not needed.
+
+
+# Use to detect nv or iv
+use B;
+
+# XXX-INGY Is flock YAML::Tiny's responsibility?
+# Some platforms can't flock :-(
+# XXX-XDG I think it is. When reading and writing files, we ought
+# to be locking whenever possible. People (foolishly) use YAML
+# files for things like session storage, which has race issues.
+my $HAS_FLOCK;
+sub _can_flock {
+ if ( defined $HAS_FLOCK ) {
+ return $HAS_FLOCK;
+ }
+ else {
+ require Config;
+ my $c = \%Config::Config;
+ $HAS_FLOCK = grep { $c->{$_} } qw/d_flock d_fcntl_can_lock d_lockf/;
+ require Fcntl if $HAS_FLOCK;
+ return $HAS_FLOCK;
+ }
+}
+
+
+# XXX-INGY Is this core in 5.8.1? Can we remove this?
+# XXX-XDG Scalar::Util 1.18 didn't land until 5.8.8, so we need this
+#####################################################################
+# Use Scalar::Util if possible, otherwise emulate it
+
+use Scalar::Util ();
+BEGIN {
+ local $@;
+ if ( eval { Scalar::Util->VERSION(1.18); } ) {
+ *refaddr = *Scalar::Util::refaddr;
+ }
+ else {
+ eval <<'END_PERL';
+# Scalar::Util failed to load or too old
+sub refaddr {
+ my $pkg = ref($_[0]) or return undef;
+ if ( !! UNIVERSAL::can($_[0], 'can') ) {
+ bless $_[0], 'Scalar::Util::Fake';
+ } else {
+ $pkg = undef;
+ }
+ "$_[0]" =~ /0x(\w+)/;
+ my $i = do { no warnings 'portable'; hex $1 };
+ bless $_[0], $pkg if defined $pkg;
+ $i;
+}
+END_PERL
+ }
+}
+
+delete $YAML::Tiny::{refaddr};
+
+1;
+
+# XXX-INGY Doc notes I'm putting up here. Changing the doc when it's wrong
+# but leaving grey area stuff up here.
+#
+# I would like to change Read/Write to Load/Dump below without
+# changing the actual API names.
+#
+# It might be better to put Load/Dump API in the SYNOPSIS instead of the
+# dubious OO API.
+#
+# null and bool explanations may be outdated.
+
+__END__
+
+#line 1489
diff --git a/lib/RT/Action/Notify_Vendor.pm b/lib/RT/Action/Notify_Vendor.pm
new file mode 100644
index 0000000..e893cd5
--- /dev/null
+++ b/lib/RT/Action/Notify_Vendor.pm
@@ -0,0 +1,107 @@
+package RT::Action::Notify;
+
+use strict;
+use warnings;
+no warnings 'redefine';
+
+=head1 Prepare
+
+After the default Notify.pm SetRecipients and the SendEmail
+prepare, the MIME object is created and populated. Use it to
+pull email headers and add to the message body the list of
+email addresses who will receive the email.
+
+=cut
+
+sub Prepare {
+ my $self = shift;
+ $self->SetRecipients();
+ my $return = $self->SUPER::Prepare();
+
+ # Now that the template is prepared, check for recipients and
+ # add them to the template if needed.
+ $self->AddRecipientsToEmail();
+ return $return;
+}
+
+=head1 AddRecipientsToEmail
+
+Inspect the created MIME object, pull out To and Cc headers,
+and add the list of emails to the body of the email, replacing
+the RT-INSERT-RECIPIENTS placeholder.
+
+=cut
+
+sub AddRecipientsToEmail {
+ my $self = shift;
+ my $ent = $self->TemplateObj->MIMEObj;
+ my @parts;
+
+ # Could be one plain text part or multiple parts with plain
+ # text and html. Handle both.
+ if ( $ent->mime_type and $ent->mime_type eq 'text/plain' ){
+ push @parts, $ent;
+ }
+ else{
+ ExtractParts({ Parts => \@parts, Entity => $ent });
+ }
+
+ foreach my $part (@parts){
+ $RT::Logger->info("Working on email part with type: " . $part->mime_type)
+ if $part->mime_type;
+ next unless $part->mime_type eq 'text/plain'
+ or $part->mime_type eq 'text/html';
+
+ # Read the (unencoded) body data
+ my @original;
+ if ( my $io = $part->open("r") ) {
+ while ( my $line = $io->getline ) {
+ push @original, $line if defined $line;
+ }
+ $io->close;
+ }
+
+ # Write back the message, replacing the recipient
+ # placeholder with the actual recipient list.
+ if ( my $io = $part->open("w") ) {
+ foreach my $line (@original) {
+
+ if ( $line =~ /RT-INSERT-RECIPIENTS/ ){
+ # Replace with list of recipients and write to email
+ my $emails = '';
+ $emails = join ', ', $self->AddressesFromHeader('To'),
+ $self->AddressesFromHeader('Cc');
+
+ $RT::Logger->info("Replacing RT-INSERT-RECIPIENTS with $emails");
+ $line =~ s/(RT\-INSERT\-RECIPIENTS)/$emails/;
+ }
+
+ $io->print($line);
+ }
+ $io->close;
+ }
+ }
+
+ return;
+}
+
+sub ExtractParts {
+ my $args_ref = shift;
+ my $parts_ref = $args_ref->{'Parts'};
+ my $ent = $args_ref->{'Entity'};
+
+ # Drill down into multipart message until there are no more parts
+ foreach my $part ($ent->parts){
+ if ( $part->parts ){
+ ExtractParts({ Parts => $parts_ref, Entity => $part });
+ }
+ else{
+ push @{$parts_ref}, $part
+ if ($part->mime_type eq 'text/plain' or
+ $part->mime_type eq 'text/html');
+ }
+ }
+ return;
+}
+
+1;
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
new file mode 100644
index 0000000..460b2a9
--- /dev/null
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -0,0 +1,88 @@
+use strict;
+use warnings;
+package RT::Extension::ListAllEmailRecipients;
+
+our $VERSION = '0.03';
+
+=head1 NAME
+
+RT-Extension-ListAllEmailRecipients - List email recipients in the
+body of RT email
+
+=head1 DESCRIPTION
+
+ListAllEmailRecipients searches for recipients in the headers on email
+messages generated by RT and replaces a template placeholder with
+the comma-delimited list of email recipients in the email message
+body.
+
+=head1 RT VERSION
+
+Works with RT 4.2
+
+=head1 INSTALLATION
+
+=over
+
+=item C<perl Makefile.PL>
+
+=item C<make>
+
+=item C<make install>
+
+May need root permissions
+
+=item Edit your F</opt/rt4/etc/RT_SiteConfig.pm>
+
+If you are using RT 4.2 or greater, add this line:
+
+ Plugin('RT::Extension::ListAllEmailRecipients');
+
+=item Clear your mason cache
+
+ rm -rf /opt/rt4/var/mason_data/obj
+
+=item Restart your webserver
+
+=item Modify your templates as described below.
+
+=back
+
+=head1 USAGE
+
+ListEmailReceipients adds functionality to any RT scrip that uses
+the default 'Notify' action. For these notification scrips, you
+can add the placeholder C<RT-INSERT-RECIPIENTS> to your existing
+notification template and it will be replace with a list of all
+recipients on that email when RT sends out the notification.
+
+For example, you could add this to your C<Correspondence> template:
+
+ The following people received this email:
+ RT-INSERT-RECIPIENTS
+
+and the resulting email will look like:
+
+ The following people received this email:
+ user1 at example.com, user2 at example.com
+
+=head1 AUTHOR
+
+Best Practical Solutions, LLC E<lt>modules at bestpractical.comE<gt>
+
+=head1 BUGS
+
+Contact Best Practical Solutions at contact at bestpractical.com with
+questions about this extension.
+
+=head1 LICENSE AND COPYRIGHT
+
+This software is Copyright (c) 2016 by Best Practical Solutions, LLC
+
+This is free software, licensed under:
+
+ The GNU General Public License, Version 2, June 1991
+
+=cut
+
+1;
diff --git a/lib/RT/Extension/ListAllEmailRecipients/Test.pm b/lib/RT/Extension/ListAllEmailRecipients/Test.pm
new file mode 100644
index 0000000..d9e2a62
--- /dev/null
+++ b/lib/RT/Extension/ListAllEmailRecipients/Test.pm
@@ -0,0 +1,40 @@
+use strict;
+use warnings;
+
+### after: use lib qw(@RT_LIB_PATH@);
+use lib qw(/opt/rt4/local/lib /opt/rt4/lib);
+
+package RT::Extension::ListAllEmailRecipients::Test;
+
+our @ISA;
+BEGIN {
+ local $@;
+ eval { require RT::Test; 1 } or do {
+ require Test::More;
+ Test::More::BAIL_OUT(
+ "requires 3.8 to run tests. Error:\n$@\n"
+ ."You may need to set PERL5LIB=/path/to/rt/lib"
+ );
+ };
+ push @ISA, 'RT::Test';
+}
+
+sub import {
+ my $class = shift;
+ my %args = @_;
+
+ $args{'requires'} ||= [];
+ if ( $args{'testing'} ) {
+ unshift @{ $args{'requires'} }, 'RT::Extension::ListAllEmailRecipients';
+ } else {
+ $args{'testing'} = 'RT::Extension::ListAllEmailRecipients';
+ }
+
+ $class->SUPER::import( %args );
+ $class->export_to_level(1);
+
+ require RT::Extension::ListAllEmailRecipients;
+}
+
+
+1;
diff --git a/lib/RT/Extension/ListAllEmailRecipients/Test.pm.in b/lib/RT/Extension/ListAllEmailRecipients/Test.pm.in
new file mode 100644
index 0000000..d9e2a62
--- /dev/null
+++ b/lib/RT/Extension/ListAllEmailRecipients/Test.pm.in
@@ -0,0 +1,40 @@
+use strict;
+use warnings;
+
+### after: use lib qw(@RT_LIB_PATH@);
+use lib qw(/opt/rt4/local/lib /opt/rt4/lib);
+
+package RT::Extension::ListAllEmailRecipients::Test;
+
+our @ISA;
+BEGIN {
+ local $@;
+ eval { require RT::Test; 1 } or do {
+ require Test::More;
+ Test::More::BAIL_OUT(
+ "requires 3.8 to run tests. Error:\n$@\n"
+ ."You may need to set PERL5LIB=/path/to/rt/lib"
+ );
+ };
+ push @ISA, 'RT::Test';
+}
+
+sub import {
+ my $class = shift;
+ my %args = @_;
+
+ $args{'requires'} ||= [];
+ if ( $args{'testing'} ) {
+ unshift @{ $args{'requires'} }, 'RT::Extension::ListAllEmailRecipients';
+ } else {
+ $args{'testing'} = 'RT::Extension::ListAllEmailRecipients';
+ }
+
+ $class->SUPER::import( %args );
+ $class->export_to_level(1);
+
+ require RT::Extension::ListAllEmailRecipients;
+}
+
+
+1;
diff --git a/xt/basic.t b/xt/basic.t
new file mode 100644
index 0000000..480845b
--- /dev/null
+++ b/xt/basic.t
@@ -0,0 +1,61 @@
+use strict;
+use warnings;
+use Email::Abstract;
+
+use RT::Extension::ListAllEmailRecipients::Test tests => undef;
+
+use_ok('RT::Extension::ListAllEmailRecipients');
+my ($baseurl, $m) = RT::Test->started_ok;
+diag "Base url is $baseurl";
+
+# Update template with placeholder
+my $template = RT::Template->new(RT->SystemUser);
+ok($template->Load('Correspondence in HTML'), 'Loaded Correspondence template');
+$template->SetContent(q{
+ RT-Attach-Message: yes
+
+ The following people received a copy of this email:
+ RT-INSERT-RECIPIENTS
+
+ {$Transaction->Content()}
+});
+
+
+my $ticket = RT::Test->create_ticket(
+ Subject => 'Test adding recipients',
+ Queue => 'General',
+);
+
+my $ticket_id = $ticket->Id();
+diag "Test new ticket creation with message id";
+{
+ my $text = <<EOF;
+From: root\@localhost
+To: rt\@@{[RT->Config->Get('rtname')]}
+RT-Send-CC: user1\@example.com
+Subject: [example.com #$ticket_id] Test adding recipients
+
+This is a reply.
+EOF
+
+ RT::Test->clean_caught_mails;
+ my $status;
+ ($status, $ticket_id) = RT::Test->send_via_mailgate($text);
+ is ($status >> 8, 0, "The mail gateway exited normally");
+ ok ($ticket_id, "Replied to ticket");
+
+ my $tick = RT::Test->last_ticket;
+ isa_ok ($tick, 'RT::Ticket');
+ is ($tick->Id, $ticket_id, "correct ticket id: $ticket_id");
+
+ my @mail = map {Email::Abstract->new($_)->cast('MIME::Entity')}
+ RT::Test->fetch_caught_mails;
+ my $message_as_string = $mail[0]->bodyhandle->as_string();
+ like( $message_as_string, qr/The following people received a copy of this email/,
+ "Found 'received a copy' message in email");
+ like( $message_as_string, qr/user1\@example\.com/, 'user1 listed as receiving email');
+}
+
+
+undef $m;
+done_testing;
commit 0d405f68f801eeb3c0b1d7d24272b8f766d39e24
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Wed Dec 7 14:35:45 2016 -0500
Recipients list moved to template variables
diff --git a/lib/RT/Action/Notify_Vendor.pm b/lib/RT/Action/Notify_Vendor.pm
deleted file mode 100644
index e893cd5..0000000
--- a/lib/RT/Action/Notify_Vendor.pm
+++ /dev/null
@@ -1,107 +0,0 @@
-package RT::Action::Notify;
-
-use strict;
-use warnings;
-no warnings 'redefine';
-
-=head1 Prepare
-
-After the default Notify.pm SetRecipients and the SendEmail
-prepare, the MIME object is created and populated. Use it to
-pull email headers and add to the message body the list of
-email addresses who will receive the email.
-
-=cut
-
-sub Prepare {
- my $self = shift;
- $self->SetRecipients();
- my $return = $self->SUPER::Prepare();
-
- # Now that the template is prepared, check for recipients and
- # add them to the template if needed.
- $self->AddRecipientsToEmail();
- return $return;
-}
-
-=head1 AddRecipientsToEmail
-
-Inspect the created MIME object, pull out To and Cc headers,
-and add the list of emails to the body of the email, replacing
-the RT-INSERT-RECIPIENTS placeholder.
-
-=cut
-
-sub AddRecipientsToEmail {
- my $self = shift;
- my $ent = $self->TemplateObj->MIMEObj;
- my @parts;
-
- # Could be one plain text part or multiple parts with plain
- # text and html. Handle both.
- if ( $ent->mime_type and $ent->mime_type eq 'text/plain' ){
- push @parts, $ent;
- }
- else{
- ExtractParts({ Parts => \@parts, Entity => $ent });
- }
-
- foreach my $part (@parts){
- $RT::Logger->info("Working on email part with type: " . $part->mime_type)
- if $part->mime_type;
- next unless $part->mime_type eq 'text/plain'
- or $part->mime_type eq 'text/html';
-
- # Read the (unencoded) body data
- my @original;
- if ( my $io = $part->open("r") ) {
- while ( my $line = $io->getline ) {
- push @original, $line if defined $line;
- }
- $io->close;
- }
-
- # Write back the message, replacing the recipient
- # placeholder with the actual recipient list.
- if ( my $io = $part->open("w") ) {
- foreach my $line (@original) {
-
- if ( $line =~ /RT-INSERT-RECIPIENTS/ ){
- # Replace with list of recipients and write to email
- my $emails = '';
- $emails = join ', ', $self->AddressesFromHeader('To'),
- $self->AddressesFromHeader('Cc');
-
- $RT::Logger->info("Replacing RT-INSERT-RECIPIENTS with $emails");
- $line =~ s/(RT\-INSERT\-RECIPIENTS)/$emails/;
- }
-
- $io->print($line);
- }
- $io->close;
- }
- }
-
- return;
-}
-
-sub ExtractParts {
- my $args_ref = shift;
- my $parts_ref = $args_ref->{'Parts'};
- my $ent = $args_ref->{'Entity'};
-
- # Drill down into multipart message until there are no more parts
- foreach my $part ($ent->parts){
- if ( $part->parts ){
- ExtractParts({ Parts => $parts_ref, Entity => $part });
- }
- else{
- push @{$parts_ref}, $part
- if ($part->mime_type eq 'text/plain' or
- $part->mime_type eq 'text/html');
- }
- }
- return;
-}
-
-1;
commit ede7242f5b9926abc0a414b014418112445c41d7
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Wed Dec 7 14:39:04 2016 -0500
Test.pm is a generated file
diff --git a/.gitignore b/.gitignore
index 3fd5259..cef98ee 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,3 +12,4 @@ pod2htm*.tmp
/MYMETA.*
/t/tmp
/xt/tmp
+/lib/RT/Extension/ListAllEmailRecipients/Test.pm
\ No newline at end of file
diff --git a/lib/RT/Extension/ListAllEmailRecipients/Test.pm b/lib/RT/Extension/ListAllEmailRecipients/Test.pm
deleted file mode 100644
index d9e2a62..0000000
--- a/lib/RT/Extension/ListAllEmailRecipients/Test.pm
+++ /dev/null
@@ -1,40 +0,0 @@
-use strict;
-use warnings;
-
-### after: use lib qw(@RT_LIB_PATH@);
-use lib qw(/opt/rt4/local/lib /opt/rt4/lib);
-
-package RT::Extension::ListAllEmailRecipients::Test;
-
-our @ISA;
-BEGIN {
- local $@;
- eval { require RT::Test; 1 } or do {
- require Test::More;
- Test::More::BAIL_OUT(
- "requires 3.8 to run tests. Error:\n$@\n"
- ."You may need to set PERL5LIB=/path/to/rt/lib"
- );
- };
- push @ISA, 'RT::Test';
-}
-
-sub import {
- my $class = shift;
- my %args = @_;
-
- $args{'requires'} ||= [];
- if ( $args{'testing'} ) {
- unshift @{ $args{'requires'} }, 'RT::Extension::ListAllEmailRecipients';
- } else {
- $args{'testing'} = 'RT::Extension::ListAllEmailRecipients';
- }
-
- $class->SUPER::import( %args );
- $class->export_to_level(1);
-
- require RT::Extension::ListAllEmailRecipients;
-}
-
-
-1;
commit 3d1a82a555e92f1b1075b0e39d20edfbb939f71a
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Thu Dec 8 08:21:43 2016 -0500
Process recipients for a web update
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index 460b2a9..e155b01 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -11,14 +11,14 @@ body of RT email
=head1 DESCRIPTION
-ListAllEmailRecipients searches for recipients in the headers on email
-messages generated by RT and replaces a template placeholder with
-the comma-delimited list of email recipients in the email message
-body.
+ListAllEmailRecipients does a dry run of all scrips configured for a
+transaction to determine the full list of email receipients. This
+list is then made available to templates when the actual notification
+scrips are subsequently run to send email.
=head1 RT VERSION
-Works with RT 4.2
+Works with RT 4.4
=head1 INSTALLATION
@@ -34,7 +34,7 @@ May need root permissions
=item Edit your F</opt/rt4/etc/RT_SiteConfig.pm>
-If you are using RT 4.2 or greater, add this line:
+Add this line:
Plugin('RT::Extension::ListAllEmailRecipients');
@@ -50,21 +50,13 @@ If you are using RT 4.2 or greater, add this line:
=head1 USAGE
-ListEmailReceipients adds functionality to any RT scrip that uses
-the default 'Notify' action. For these notification scrips, you
-can add the placeholder C<RT-INSERT-RECIPIENTS> to your existing
-notification template and it will be replace with a list of all
-recipients on that email when RT sends out the notification.
+ListEmailReceipients adds the following template variables containing
+a list of all recipients for that type for the current transaction
+(comment, correspond, etc.).
-For example, you could add this to your C<Correspondence> template:
-
- The following people received this email:
- RT-INSERT-RECIPIENTS
-
-and the resulting email will look like:
-
- The following people received this email:
- user1 at example.com, user2 at example.com
+ $NotificationRecipientsTo
+ $NotificationRecipientsCc
+ $NotificationRecipientsBcc
=head1 AUTHOR
@@ -85,4 +77,95 @@ This is free software, licensed under:
=cut
+our $NotificationRecipientsTo;
+our $NotificationRecipientsCc;
+our $NotificationRecipientsBcc;
+
+sub FindNotificationRecipients {
+ my %args = (
+ TicketId => undef,
+ @_
+ );
+
+ my $recipients_ref = ProcessScripDryRun(%args);
+ $NotificationRecipientsTo = join ', ', @{$recipients_ref->{'To'}} if $recipients_ref->{'To'};
+ $NotificationRecipientsCc = join ', ', @{$recipients_ref->{'Cc'}} if $recipients_ref->{'Cc'};
+ $NotificationRecipientsBcc = join ', ', @{$recipients_ref->{'Bcc'}} if $recipients_ref->{'Bcc'};
+
+ return;
+}
+
+# Code copied from ShowSimplifiedRecipients and modified
+
+sub ProcessScripDryRun {
+ my %args = (@_);
+
+ my $TicketObj = RT::Ticket->new($args{'CurrentUser'});
+ my ($ret, $msg) = $TicketObj->Load($args{'TicketId'});
+
+ unless ( $ret ){
+ RT::Logger->error("Unable to load ticket " . $args{'TicketId'} . ". Skipping dry run.");
+ return;
+ }
+
+ RT::Logger->debug("Starting dry run to gather recipients");
+
+ my @dryrun = $TicketObj->DryRun(
+ sub {
+ local $args{UpdateContent} ||= "Content";
+ HTML::Mason::Commands::ProcessUpdateMessage(ARGSRef => \%args, TicketObj => $TicketObj, KeepAttachments => 1 );
+ HTML::Mason::Commands::ProcessTicketWatchers(ARGSRef => \%args, TicketObj => $TicketObj );
+ HTML::Mason::Commands::ProcessTicketBasics( ARGSRef => \%args, TicketObj => $TicketObj );
+ HTML::Mason::Commands::ProcessTicketLinks( ARGSRef => \%args, TicketObj => $TicketObj );
+ HTML::Mason::Commands::ProcessTicketDates( ARGSRef => \%args, TicketObj => $TicketObj );
+ HTML::Mason::Commands::ProcessObjectCustomFieldUpdates(ARGSRef => \%args, TicketObj => $TicketObj );
+ HTML::Mason::Commands::ProcessTicketReminders( ARGSRef => \%args, TicketObj => $TicketObj );
+ }
+ );
+ return unless @dryrun;
+
+ my %headers = (To => {}, Cc => {}, Bcc => {});
+ my %no_squelch = (To => {}, Cc => {}, Bcc => {});
+ my @scrips = map {@{$_->Scrips->Prepared}} @dryrun;
+ if (@scrips) {
+ for my $scrip (grep $_->ActionObj->Action->isa('RT::Action::SendEmail'), @scrips) {
+ my $action = $scrip->ActionObj->Action;
+ warn "Argument is: " . $action->Argument;
+ for my $type (qw(To Cc Bcc)) {
+ for my $addr ($action->$type()) {
+ if (grep {$addr->address eq $_} @{$action->{NoSquelch}{$type} || []}) {
+ $no_squelch{$type}{$addr->address} = $addr;
+ } else {
+ $headers{$type}{$addr->address} = $addr;
+ }
+ }
+ }
+ }
+ }
+
+ my %squelched = HTML::Mason::Commands::ProcessTransactionSquelching( \%args );
+ my $squelched_config = !( RT->Config->Get('SquelchedRecipients', $args{'CurrentUser'}) );
+
+ # Unpack the addresses found and save
+ my %recipients;
+ for my $type (qw(To Cc Bcc)) {
+ next unless keys %{$headers{$type}} or keys %{$no_squelch{$type}};
+
+ for my $addr (sort {$a->address cmp $b->address} values %{$headers{$type}}) {
+ push @{$recipients{$type}}, $addr->address;
+ }
+ }
+
+ # One-time Ccs and Bccs are processed through email headers, so they won't be picked up
+ # by running the action To, Cc, Bcc methods above. If passed, add them here.
+ foreach my $one_time ( qw(Cc Bcc) ){
+ my @addresses = Email::Address->parse($args{"Update" . $one_time}) if $args{"Update" . $one_time};
+ push @{$recipients{$one_time}}, @addresses;
+ }
+
+ RT::Logger->debug("Found some recipients") if %recipients;
+
+ return \%recipients;
+}
+
1;
diff --git a/lib/RT/Template_Vendor.pm b/lib/RT/Template_Vendor.pm
new file mode 100644
index 0000000..f3d9552
--- /dev/null
+++ b/lib/RT/Template_Vendor.pm
@@ -0,0 +1,43 @@
+package RT::Template;
+
+use strict;
+use warnings;
+no warnings qw(redefine);
+
+# Copied from RT's core RT::Template::Parse to add a variable to the template.
+sub Parse {
+ my $self = shift;
+ my ($rv, $msg);
+
+ my @more_template_args = $self->AddTemplateArgs(@_);
+
+ if (not $self->IsEmpty and $self->Content =~ m{^Content-Type:\s+text/html\b}im) {
+ local $RT::Transaction::PreferredContentType = 'text/html';
+ ($rv, $msg) = $self->_Parse(@_, @more_template_args);
+ }
+ else {
+ ($rv, $msg) = $self->_Parse(@_, @more_template_args);
+ }
+
+ return ($rv, $msg) unless $rv;
+
+ my $mime_type = $self->MIMEObj->mime_type;
+ if (defined $mime_type and $mime_type eq 'text/html') {
+ $self->_DowngradeFromHTML(@_, @more_template_args);
+ }
+
+ return ($rv, $msg);
+}
+
+sub AddTemplateArgs {
+ my $self = shift;
+ my @more_template_args;
+ push @more_template_args,
+ 'NotificationRecipientsTo' => $RT::Extension::ListAllEmailRecipients::NotificationRecipientsTo,
+ 'NotificationRecipientsCc' => $RT::Extension::ListAllEmailRecipients::NotificationRecipientsCc,
+ 'NotificationRecipientsBcc' => $RT::Extension::ListAllEmailRecipients::NotificationRecipientsBcc;
+
+ return @more_template_args;
+}
+
+1;
commit 5c028b46fc95e4dce6c25747737c90336b63564c
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Thu Dec 8 13:19:28 2016 -0500
Populate recipients from email
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index e155b01..6d81df2 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -6,16 +6,20 @@ our $VERSION = '0.03';
=head1 NAME
-RT-Extension-ListAllEmailRecipients - List email recipients in the
-body of RT email
+RT-Extension-ListAllEmailRecipients - Determine all recipients for a
+notification and provide emails via template variables
=head1 DESCRIPTION
ListAllEmailRecipients does a dry run of all scrips configured for a
-transaction to determine the full list of email receipients. This
+notification to determine the full list of email receipients. This
list is then made available to templates when the actual notification
scrips are subsequently run to send email.
+The current version calculates emails for comments and replies on
+existing tickets via the web UI and email. It does not calculate
+recipients on create.
+
=head1 RT VERSION
Works with RT 4.4
@@ -52,7 +56,7 @@ Add this line:
ListEmailReceipients adds the following template variables containing
a list of all recipients for that type for the current transaction
-(comment, correspond, etc.).
+(comment, correspond, etc.) across all enabled notification scrips.
$NotificationRecipientsTo
$NotificationRecipientsCc
@@ -110,18 +114,30 @@ sub ProcessScripDryRun {
RT::Logger->debug("Starting dry run to gather recipients");
- my @dryrun = $TicketObj->DryRun(
- sub {
- local $args{UpdateContent} ||= "Content";
- HTML::Mason::Commands::ProcessUpdateMessage(ARGSRef => \%args, TicketObj => $TicketObj, KeepAttachments => 1 );
- HTML::Mason::Commands::ProcessTicketWatchers(ARGSRef => \%args, TicketObj => $TicketObj );
- HTML::Mason::Commands::ProcessTicketBasics( ARGSRef => \%args, TicketObj => $TicketObj );
- HTML::Mason::Commands::ProcessTicketLinks( ARGSRef => \%args, TicketObj => $TicketObj );
- HTML::Mason::Commands::ProcessTicketDates( ARGSRef => \%args, TicketObj => $TicketObj );
- HTML::Mason::Commands::ProcessObjectCustomFieldUpdates(ARGSRef => \%args, TicketObj => $TicketObj );
- HTML::Mason::Commands::ProcessTicketReminders( ARGSRef => \%args, TicketObj => $TicketObj );
- }
- );
+ my @dryrun;
+
+ if ( $args{'UpdateInterface'} eq 'Email' ){
+ my $action = ucfirst $args{Action};
+ @dryrun = $args{'Ticket'}->DryRun(
+ sub {
+ my ( $status, $msg ) = $args{Ticket}->$action( MIMEObj => $args{Message} );
+ }
+ );
+ }
+ else{
+ @dryrun = $TicketObj->DryRun(
+ sub {
+ local $args{UpdateContent} ||= "Content";
+ HTML::Mason::Commands::ProcessUpdateMessage(ARGSRef => \%args, TicketObj => $TicketObj, KeepAttachments => 1 );
+ HTML::Mason::Commands::ProcessTicketWatchers(ARGSRef => \%args, TicketObj => $TicketObj );
+ HTML::Mason::Commands::ProcessTicketBasics( ARGSRef => \%args, TicketObj => $TicketObj );
+ HTML::Mason::Commands::ProcessTicketLinks( ARGSRef => \%args, TicketObj => $TicketObj );
+ HTML::Mason::Commands::ProcessTicketDates( ARGSRef => \%args, TicketObj => $TicketObj );
+ HTML::Mason::Commands::ProcessObjectCustomFieldUpdates(ARGSRef => \%args, TicketObj => $TicketObj );
+ HTML::Mason::Commands::ProcessTicketReminders( ARGSRef => \%args, TicketObj => $TicketObj );
+ }
+ );
+ }
return unless @dryrun;
my %headers = (To => {}, Cc => {}, Bcc => {});
diff --git a/lib/RT/Interface/Email/Action/Defaults_Vendor.pm b/lib/RT/Interface/Email/Action/Defaults_Vendor.pm
new file mode 100644
index 0000000..1b59f25
--- /dev/null
+++ b/lib/RT/Interface/Email/Action/Defaults_Vendor.pm
@@ -0,0 +1,37 @@
+package RT::Interface::Email::Action::Defaults;
+
+use strict;
+use warnings;
+no warnings qw(redefine);
+
+sub _HandleEither {
+ my %args = (
+ Action => undef,
+ Message => undef,
+ Subject => undef,
+ Ticket => undef,
+ TicketId => undef,
+ Queue => undef,
+ @_,
+ );
+
+ return _HandleCreate(@_) unless $args{TicketId};
+
+ unless ( $args{Ticket}->Id ) {
+ MailError(
+ Subject => "Message not recorded: $args{Subject}",
+ Explanation => "Could not find a ticket with id " . $args{TicketId},
+ FAILURE => 1,
+ );
+ }
+
+ RT::Extension::ListAllEmailRecipients::FindNotificationRecipients(
+ @_,
+ UpdateInterface => 'Email');
+
+ my $action = ucfirst $args{Action};
+ my ( $status, $msg ) = $args{Ticket}->$action( MIMEObj => $args{Message} );
+ return if $status;
+}
+
+1;
commit cf39e17a4d2dce0dfce52ec6ce38c87939b21e5a
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Thu Dec 8 15:30:09 2016 -0500
Tests came over from ListEmailRecipients
diff --git a/xt/basic.t b/xt/basic.t
deleted file mode 100644
index 480845b..0000000
--- a/xt/basic.t
+++ /dev/null
@@ -1,61 +0,0 @@
-use strict;
-use warnings;
-use Email::Abstract;
-
-use RT::Extension::ListAllEmailRecipients::Test tests => undef;
-
-use_ok('RT::Extension::ListAllEmailRecipients');
-my ($baseurl, $m) = RT::Test->started_ok;
-diag "Base url is $baseurl";
-
-# Update template with placeholder
-my $template = RT::Template->new(RT->SystemUser);
-ok($template->Load('Correspondence in HTML'), 'Loaded Correspondence template');
-$template->SetContent(q{
- RT-Attach-Message: yes
-
- The following people received a copy of this email:
- RT-INSERT-RECIPIENTS
-
- {$Transaction->Content()}
-});
-
-
-my $ticket = RT::Test->create_ticket(
- Subject => 'Test adding recipients',
- Queue => 'General',
-);
-
-my $ticket_id = $ticket->Id();
-diag "Test new ticket creation with message id";
-{
- my $text = <<EOF;
-From: root\@localhost
-To: rt\@@{[RT->Config->Get('rtname')]}
-RT-Send-CC: user1\@example.com
-Subject: [example.com #$ticket_id] Test adding recipients
-
-This is a reply.
-EOF
-
- RT::Test->clean_caught_mails;
- my $status;
- ($status, $ticket_id) = RT::Test->send_via_mailgate($text);
- is ($status >> 8, 0, "The mail gateway exited normally");
- ok ($ticket_id, "Replied to ticket");
-
- my $tick = RT::Test->last_ticket;
- isa_ok ($tick, 'RT::Ticket');
- is ($tick->Id, $ticket_id, "correct ticket id: $ticket_id");
-
- my @mail = map {Email::Abstract->new($_)->cast('MIME::Entity')}
- RT::Test->fetch_caught_mails;
- my $message_as_string = $mail[0]->bodyhandle->as_string();
- like( $message_as_string, qr/The following people received a copy of this email/,
- "Found 'received a copy' message in email");
- like( $message_as_string, qr/user1\@example\.com/, 'user1 listed as receiving email');
-}
-
-
-undef $m;
-done_testing;
commit 86f7a88bcdfcebb8f5f18ac1233609094dee29ad
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Thu Dec 8 15:31:22 2016 -0500
Add default value to fix undef warnings
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index 6d81df2..6b6f9df 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -102,7 +102,9 @@ sub FindNotificationRecipients {
# Code copied from ShowSimplifiedRecipients and modified
sub ProcessScripDryRun {
- my %args = (@_);
+ my %args = (
+ UpdateInterface => 'Web',
+ @_);
my $TicketObj = RT::Ticket->new($args{'CurrentUser'});
my ($ret, $msg) = $TicketObj->Load($args{'TicketId'});
commit a314610f22fe729de2d81625c37b716a02a73162
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Thu Dec 8 15:37:17 2016 -0500
Callback to process recipients from web updates
diff --git a/html/Callbacks/RT-Extension-ListAllEmailRecipients/Ticket/Display.html/ProcessArguments b/html/Callbacks/RT-Extension-ListAllEmailRecipients/Ticket/Display.html/ProcessArguments
new file mode 100644
index 0000000..5910f5f
--- /dev/null
+++ b/html/Callbacks/RT-Extension-ListAllEmailRecipients/Ticket/Display.html/ProcessArguments
@@ -0,0 +1,14 @@
+<%init>
+# Only run on an actual update.
+return unless $ARGSRef->{'UpdateType'};
+RT::Extension::ListAllEmailRecipients::FindNotificationRecipients(
+ %{$ARGSRef},
+ Actions => $Actions,
+ TicketId => $Ticket->Id,
+ CurrentUser => $Ticket->CurrentUser);
+</%init>
+<%args>
+$Ticket
+$ARGSRef
+$Actions
+</%args>
\ No newline at end of file
commit 655d99ba350892ed6155a68934abdd4040bae570
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Fri Dec 9 09:30:07 2016 -0500
Move email handling to an email plugin
RT expects custom email handling to be provided as a plugin,
so the default libraries don't pull in overrides like RT's other
standard libraries. Move email handling to a plugin to properly
pull in the customization to process recipients.
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index 6b6f9df..8e47d35 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -38,9 +38,10 @@ May need root permissions
=item Edit your F</opt/rt4/etc/RT_SiteConfig.pm>
-Add this line:
+Add these lines, both are required:
Plugin('RT::Extension::ListAllEmailRecipients');
+ Set(@MailPlugins, qw(Auth::MailFrom Action::ListAllEmailRecipients));
=item Clear your mason cache
diff --git a/lib/RT/Interface/Email/Action/Defaults_Vendor.pm b/lib/RT/Interface/Email/Action/Defaults_Vendor.pm
deleted file mode 100644
index 1b59f25..0000000
--- a/lib/RT/Interface/Email/Action/Defaults_Vendor.pm
+++ /dev/null
@@ -1,37 +0,0 @@
-package RT::Interface::Email::Action::Defaults;
-
-use strict;
-use warnings;
-no warnings qw(redefine);
-
-sub _HandleEither {
- my %args = (
- Action => undef,
- Message => undef,
- Subject => undef,
- Ticket => undef,
- TicketId => undef,
- Queue => undef,
- @_,
- );
-
- return _HandleCreate(@_) unless $args{TicketId};
-
- unless ( $args{Ticket}->Id ) {
- MailError(
- Subject => "Message not recorded: $args{Subject}",
- Explanation => "Could not find a ticket with id " . $args{TicketId},
- FAILURE => 1,
- );
- }
-
- RT::Extension::ListAllEmailRecipients::FindNotificationRecipients(
- @_,
- UpdateInterface => 'Email');
-
- my $action = ucfirst $args{Action};
- my ( $status, $msg ) = $args{Ticket}->$action( MIMEObj => $args{Message} );
- return if $status;
-}
-
-1;
diff --git a/lib/RT/Interface/Email/Action/ListAllEmailRecipients.pm b/lib/RT/Interface/Email/Action/ListAllEmailRecipients.pm
new file mode 100644
index 0000000..444bd6e
--- /dev/null
+++ b/lib/RT/Interface/Email/Action/ListAllEmailRecipients.pm
@@ -0,0 +1,108 @@
+package RT::Interface::Email::Action::ListAllEmailRecipients;
+
+use strict;
+use warnings;
+
+use Role::Basic 'with';
+with 'RT::Interface::Email::Role';
+
+use RT::Interface::Email;
+
+=head1 NAME
+
+RT::Interface::Email::Action::ListAllEmailRecipeints
+
+=head1 SYNOPSIS
+
+This is a copy of RT's Action/Defaults.pm email plugin which is the
+default handler for comment and correspond. This version adds the
+call to process all email recipients and make the list available as
+a template variable. Otherwise, it is the same.
+
+=cut
+
+sub _HandleCreate {
+ my %args = (
+ Subject => undef,
+ Message => undef,
+ Ticket => undef,
+ Queue => undef,
+ @_,
+ );
+
+ my $head = $args{Message}->head;
+
+ my @Cc;
+ my @Requestors = ( $args{Ticket}->CurrentUser->id );
+ if (RT->Config->Get('ParseNewMessageForTicketCcs')) {
+ my $user = $args{Ticket}->CurrentUser->UserObj;
+ my $current_address = lc $user->EmailAddress;
+
+ @Cc =
+ grep $_ ne $current_address && !RT::EmailParser->IsRTAddress( $_ ),
+ map lc $user->CanonicalizeEmailAddress( $_->address ),
+ map RT::EmailParser->CleanupAddresses( Email::Address->parse(
+ Encode::decode( "UTF-8", $head->get( $_ ) ) ) ),
+ qw(To Cc);
+ }
+
+ # ExtractTicketId may have been overridden, and edited the Subject
+ my $subject = Encode::decode( "UTF-8", $head->get('Subject') );
+ chomp $subject;
+
+ my ( $id, $Transaction, $ErrStr ) = $args{Ticket}->Create(
+ Queue => $args{Queue}->Id,
+ Subject => $subject,
+ Requestor => \@Requestors,
+ Cc => \@Cc,
+ MIMEObj => $args{Message},
+ );
+ return if $id;
+
+ MailError(
+ Subject => "Ticket creation failed: $args{Subject}",
+ Explanation => $ErrStr,
+ FAILURE => 1,
+ );
+}
+
+sub HandleComment {
+ _HandleEither( @_, Action => "Comment" );
+}
+
+sub HandleCorrespond {
+ _HandleEither( @_, Action => "Correspond" );
+}
+
+
+sub _HandleEither {
+ my %args = (
+ Action => undef,
+ Message => undef,
+ Subject => undef,
+ Ticket => undef,
+ TicketId => undef,
+ Queue => undef,
+ @_,
+ );
+
+ return _HandleCreate(@_) unless $args{TicketId};
+
+ unless ( $args{Ticket}->Id ) {
+ MailError(
+ Subject => "Message not recorded: $args{Subject}",
+ Explanation => "Could not find a ticket with id " . $args{TicketId},
+ FAILURE => 1,
+ );
+ }
+
+ RT::Extension::ListAllEmailRecipients::FindNotificationRecipients(
+ @_,
+ UpdateInterface => 'Email');
+
+ my $action = ucfirst $args{Action};
+ my ( $status, $msg ) = $args{Ticket}->$action( MIMEObj => $args{Message} );
+ return if $status;
+}
+
+1;
commit 8c241e909df3e979e1fc6ca94ba66836d1bf89ae
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Fri Dec 9 09:32:32 2016 -0500
Add tests
diff --git a/lib/RT/Extension/ListAllEmailRecipients/Test.pm.in b/lib/RT/Extension/ListAllEmailRecipients/Test.pm.in
index d9e2a62..a4e85c9 100644
--- a/lib/RT/Extension/ListAllEmailRecipients/Test.pm.in
+++ b/lib/RT/Extension/ListAllEmailRecipients/Test.pm.in
@@ -36,5 +36,14 @@ sub import {
require RT::Extension::ListAllEmailRecipients;
}
+sub bootstrap_more_config{
+ my $self = shift;
+ my $config = shift;
+ my $args_ref = shift;
+
+ print $config "Set( \@MailPlugins, qw(Auth::MailFrom Action::ListAllEmailRecipients));\n";
+
+ return;
+}
1;
diff --git a/xt/basic.t b/xt/basic.t
new file mode 100644
index 0000000..0f19a44
--- /dev/null
+++ b/xt/basic.t
@@ -0,0 +1,81 @@
+use strict;
+use warnings;
+use Email::Abstract;
+
+use RT::Extension::ListAllEmailRecipients::Test tests => undef;
+
+use_ok('RT::Extension::ListAllEmailRecipients');
+my ($baseurl, $m) = RT::Test->started_ok;
+diag "Base url is $baseurl";
+
+my $user1 = RT::Test->load_or_create_user( EmailAddress => 'user1 at example.com' );
+my $user2 = RT::Test->load_or_create_user( EmailAddress => 'user2 at example.com' );
+my $user3 = RT::Test->load_or_create_user( EmailAddress => 'user3 at example.com' );
+
+# Update template with new variables
+my $template = RT::Template->new(RT->SystemUser);
+ok($template->Load('Correspondence in HTML'), 'Loaded Correspondence template');
+$template->SetContent(q{
+ RT-Attach-Message: yes
+
+ The following people received a copy of this email:
+
+ To: {$NotificationRecipientsTo}
+ Cc: {$NotificationRecipientsCc}
+ Bcc: {$NotificationRecipientsBcc}
+
+ {$Transaction->Content()}
+});
+
+ok( RT::Test->add_rights({ Principal => 'Everyone', Right => [qw(ReplyToTicket Watch ShowTicket)] }), 'add ReplyToTicket rights');
+
+my $ticket = RT::Test->create_ticket(
+ Subject => 'Test adding recipients',
+ Queue => 'General',
+);
+
+$ticket->AddWatcher( Type => 'Requestor', Email => 'user1 at example.com');
+$ticket->AddWatcher( Type => 'Cc', Email => 'user2 at example.com');
+$ticket->AddWatcher( Type => 'AdminCc', Email => 'root at localhost');
+
+my $ticket_id = $ticket->Id();
+diag "Reply to ticket";
+{
+ my $text = <<EOF;
+From: user3\@example.com
+To: rt\@@{[RT->Config->Get('rtname')]}
+Subject: [example.com #$ticket_id] Test adding recipients
+
+This is a reply.
+EOF
+
+ RT::Test->clean_caught_mails;
+ my $status;
+ ($status, $ticket_id) = RT::Test->send_via_mailgate_and_http($text);
+ is ($status >> 8, 0, "The mail gateway exited normally");
+ ok ($ticket_id, "Replied to ticket");
+
+ my $tick = RT::Test->last_ticket;
+ isa_ok ($tick, 'RT::Ticket');
+ is ($tick->Id, $ticket_id, "correct ticket id: $ticket_id");
+
+ my $transactions = $tick->Transactions;
+ $transactions->OrderByCols({ FIELD => 'id', ORDER => 'DESC' });
+ $transactions->Limit(
+ FIELD => 'Type',
+ OPERATOR => 'ENDSWITH',
+ VALUE => 'EmailRecord',
+ ENTRYAGGREGATOR => 'AND',
+ );
+ my $txn = $transactions->First;
+ my $content = $txn->Content;
+
+ like( $content, qr/The following people received a copy of this email/,
+ "Found 'received a copy' message in email");
+ like( $content, qr/To\: user1\@example\.com/, 'user1 listed as To:');
+ like( $content, qr/Cc\: user2\@example\.com/, 'user2 listed as Cc:');
+ like( $content, qr/Bcc\: root\@localhost/, 'root listed as Bcc:');
+}
+
+undef $m;
+done_testing;
commit 693ec5926f425168c9d378932e4aa895123f16c7
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Fri Dec 9 09:35:23 2016 -0500
Prep for 0.01 release
diff --git a/MANIFEST b/MANIFEST
index b1a8da2..4f41d40 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -1,4 +1,5 @@
Changes
+html/Callbacks/RT-Extension-ListAllEmailRecipients/Ticket/Display.html/ProcessArguments
inc/Module/Install.pm
inc/Module/Install/Base.pm
inc/Module/Install/Can.pm
@@ -13,10 +14,11 @@ inc/Module/Install/Substitute.pm
inc/Module/Install/Win32.pm
inc/Module/Install/WriteAll.pm
inc/YAML/Tiny.pm
-lib/RT/Action/Notify_Vendor.pm
lib/RT/Extension/ListAllEmailRecipients.pm
lib/RT/Extension/ListAllEmailRecipients/Test.pm
lib/RT/Extension/ListAllEmailRecipients/Test.pm.in
+lib/RT/Interface/Email/Action/ListAllEmailRecipients.pm
+lib/RT/Template_Vendor.pm
Makefile.PL
MANIFEST This list of files
META.yml
diff --git a/META.yml b/META.yml
index d3c4fc6..40305d5 100644
--- a/META.yml
+++ b/META.yml
@@ -16,13 +16,13 @@ meta-spec:
name: RT-Extension-ListAllEmailRecipients
no_index:
directory:
+ - html
- inc
- xt
requires:
perl: 5.10.1
resources:
license: http://opensource.org/licenses/gpl-license.php
- repository: https://github.com/bestpractical/rt-extension-listemailrecipients
-version: '0.03'
+version: '0.01'
x_module_install_rtx_version: '0.38'
x_requires_rt: 4.2.0
diff --git a/README b/README
index ecc4b46..198b698 100644
--- a/README
+++ b/README
@@ -1,14 +1,19 @@
NAME
- RT-Extension-ListAllEmailRecipients - List email recipients in the body of
- RT email
+ RT-Extension-ListAllEmailRecipients - Determine all recipients for a
+ notification and provide emails via template variables
DESCRIPTION
- ListAllEmailRecipients searches for recipients in the headers on email
- messages generated by RT and replaces a template placeholder with the
- comma-delimited list of email recipients in the email message body.
+ ListAllEmailRecipients does a dry run of all scrips configured for a
+ notification to determine the full list of email receipients. This list
+ is then made available to templates when the actual notification scrips
+ are subsequently run to send email.
+
+ The current version calculates emails for comments and replies on
+ existing tickets via the web UI and email. It does not calculate
+ recipients on create.
RT VERSION
- Works with RT 4.2
+ Works with RT 4.4
INSTALLATION
perl Makefile.PL
@@ -17,9 +22,10 @@ INSTALLATION
May need root permissions
Edit your /opt/rt4/etc/RT_SiteConfig.pm
- If you are using RT 4.2 or greater, add this line:
+ Add these lines, both are required:
Plugin('RT::Extension::ListAllEmailRecipients');
+ Set(@MailPlugins, qw(Auth::MailFrom Action::ListAllEmailRecipients));
Clear your mason cache
rm -rf /opt/rt4/var/mason_data/obj
@@ -28,21 +34,23 @@ INSTALLATION
Modify your templates as described below.
USAGE
- ListEmailReceipients adds functionality to any RT scrip that uses the
- default 'Notify' action. For these notification scrips, you can add the
- placeholder RT-INSERT-RECIPIENTS to your existing notification template
- and it will be replace with a list of all recipients on that email when
- RT sends out the notification.
+ ListEmailReceipients adds the following template variables containing a
+ list of all recipients for that type for the current transaction
+ (comment, correspond, etc.) across all enabled notification scrips.
- For example, you could add this to your Correspondence template:
+ $NotificationRecipientsTo
+ $NotificationRecipientsCc
+ $NotificationRecipientsBcc
- The following people received this email:
- RT-INSERT-RECIPIENTS
+ To include these in an outgoing email, like the Admin email to AdminCcs
+ on a ticket, add something like the following to the appropriate
+ template:
- and the resulting email will look like:
+ <p>Email was sent to the following addresses:</p>
- The following people received this email:
- user1 at example.com, user2 at example.com
+ <p>To: {$NotificationRecipientsTo} </p>
+ <p>Cc: {$NotificationRecipientsCc} </p>
+ <p>Bcc: {$NotificationRecipientsBcc} </p>
AUTHOR
Best Practical Solutions, LLC <modules at bestpractical.com>
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index 8e47d35..dd83a7c 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -2,7 +2,7 @@ use strict;
use warnings;
package RT::Extension::ListAllEmailRecipients;
-our $VERSION = '0.03';
+our $VERSION = '0.01';
=head1 NAME
@@ -63,6 +63,15 @@ a list of all recipients for that type for the current transaction
$NotificationRecipientsCc
$NotificationRecipientsBcc
+To include these in an outgoing email, like the Admin email to AdminCcs
+on a ticket, add something like the following to the appropriate template:
+
+ <p>Email was sent to the following addresses:</p>
+
+ <p>To: {$NotificationRecipientsTo} </p>
+ <p>Cc: {$NotificationRecipientsCc} </p>
+ <p>Bcc: {$NotificationRecipientsBcc} </p>
+
=head1 AUTHOR
Best Practical Solutions, LLC E<lt>modules at bestpractical.comE<gt>
@@ -149,7 +158,6 @@ sub ProcessScripDryRun {
if (@scrips) {
for my $scrip (grep $_->ActionObj->Action->isa('RT::Action::SendEmail'), @scrips) {
my $action = $scrip->ActionObj->Action;
- warn "Argument is: " . $action->Argument;
for my $type (qw(To Cc Bcc)) {
for my $addr ($action->$type()) {
if (grep {$addr->address eq $_} @{$action->{NoSquelch}{$type} || []}) {
commit 0f01f22ebf72f9e6cca3a9d8e148e6eac8fba39a
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Mon Dec 19 11:20:50 2016 -0500
Add UpdateTo to the list of headers to check for
Add To to the list of headers to check to provide compatibility
with the extension RT::Extension::OneTimeTo.
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index dd83a7c..77fe118 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -185,7 +185,7 @@ sub ProcessScripDryRun {
# One-time Ccs and Bccs are processed through email headers, so they won't be picked up
# by running the action To, Cc, Bcc methods above. If passed, add them here.
- foreach my $one_time ( qw(Cc Bcc) ){
+ foreach my $one_time ( qw(To Cc Bcc) ){
my @addresses = Email::Address->parse($args{"Update" . $one_time}) if $args{"Update" . $one_time};
push @{$recipients{$one_time}}, @addresses;
}
commit e7b635763b7a0f419c45cac1b2ebe63e1d9bf143
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Mon Dec 19 12:51:07 2016 -0500
Provide recipients on create via web UI
diff --git a/html/Callbacks/RT-Extension-ListAllEmailRecipients/Ticket/Display.html/Initial b/html/Callbacks/RT-Extension-ListAllEmailRecipients/Ticket/Display.html/Initial
new file mode 100644
index 0000000..b1d3f38
--- /dev/null
+++ b/html/Callbacks/RT-Extension-ListAllEmailRecipients/Ticket/Display.html/Initial
@@ -0,0 +1,19 @@
+<%init>
+# Only run for new ticket create
+return unless $ARGSRef->{'id'} and $ARGSRef->{'id'} eq 'new';
+
+# Duplicate the checks in Display.html since they haven't run yet
+my $Queue = RT::Queue->new( $session{'CurrentUser'} );
+$Queue->Load($ARGSRef->{'Queue'});
+return unless $Queue->Id;
+return unless $Queue->CurrentUserHasRight('CreateTicket');
+$ARGSRef->{'TicketObj'} ||= RT::Ticket->new($session{'CurrentUser'});
+
+RT::Extension::ListAllEmailRecipients::FindNotificationRecipients(
+ %{$ARGSRef},);
+
+</%init>
+<%args>
+$TicketObj
+$ARGSRef
+</%args>
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index 77fe118..c5fe577 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -116,14 +116,6 @@ sub ProcessScripDryRun {
UpdateInterface => 'Web',
@_);
- my $TicketObj = RT::Ticket->new($args{'CurrentUser'});
- my ($ret, $msg) = $TicketObj->Load($args{'TicketId'});
-
- unless ( $ret ){
- RT::Logger->error("Unable to load ticket " . $args{'TicketId'} . ". Skipping dry run.");
- return;
- }
-
RT::Logger->debug("Starting dry run to gather recipients");
my @dryrun;
@@ -136,7 +128,27 @@ sub ProcessScripDryRun {
}
);
}
+ elsif ( $args{'id'} and $args{'id'} eq 'new' ){
+ my $TicketObj = $args{'TicketObj'};
+ return unless $TicketObj;
+
+ @dryrun = $TicketObj->DryRun(
+ sub {
+ local $args{UpdateContent} ||= "Content";
+ HTML::Mason::Commands::CreateTicket( %args );
+ }
+ );
+
+ }
else{
+ my $TicketObj = RT::Ticket->new($args{'CurrentUser'});
+ my ($ret, $msg) = $TicketObj->Load($args{'TicketId'});
+
+ unless ( $ret ){
+ RT::Logger->error("Unable to load ticket " . $args{'TicketId'} . ". Skipping dry run.");
+ return;
+ }
+
@dryrun = $TicketObj->DryRun(
sub {
local $args{UpdateContent} ||= "Content";
commit 5a9659cec2f907d0d2bbddd5910c87709edf63df
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Mon Dec 19 13:45:56 2016 -0500
Add recipients on email create
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index c5fe577..f3445d2 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -120,7 +120,20 @@ sub ProcessScripDryRun {
my @dryrun;
- if ( $args{'UpdateInterface'} eq 'Email' ){
+ if ( $args{'UpdateInterface'} eq 'EmailCreate' ) {
+ @dryrun = $args{'Ticket'}->DryRun(
+ sub {
+ $args{Ticket}->Create(
+ Queue => $args{'Queue'},
+ Subject => $args{'Subject'},
+ Requestor => $args{'Requestor'},
+ Cc => $args{'Cc'},
+ MIMEObj => $args{'MIMEObj'},
+ );
+ }
+ );
+ }
+ elsif ( $args{'UpdateInterface'} eq 'Email' ){
my $action = ucfirst $args{Action};
@dryrun = $args{'Ticket'}->DryRun(
sub {
diff --git a/lib/RT/Interface/Email/Action/ListAllEmailRecipients.pm b/lib/RT/Interface/Email/Action/ListAllEmailRecipients.pm
index 444bd6e..9960d67 100644
--- a/lib/RT/Interface/Email/Action/ListAllEmailRecipients.pm
+++ b/lib/RT/Interface/Email/Action/ListAllEmailRecipients.pm
@@ -50,6 +50,15 @@ sub _HandleCreate {
my $subject = Encode::decode( "UTF-8", $head->get('Subject') );
chomp $subject;
+ RT::Extension::ListAllEmailRecipients::FindNotificationRecipients(
+ Ticket => $args{'Ticket'},
+ Queue => $args{Queue}->Id,
+ Subject => $subject,
+ Requestor => \@Requestors,
+ Cc => \@Cc,
+ MIMEObj => $args{Message},
+ UpdateInterface => 'EmailCreate');
+
my ( $id, $Transaction, $ErrStr ) = $args{Ticket}->Create(
Queue => $args{Queue}->Id,
Subject => $subject,
commit bd0a830e58d5b6e2723fb477d4374654827acb59
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Mon Dec 19 13:47:11 2016 -0500
Clear recipients variables to avoid carryover from other updates
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index f3445d2..a065658 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -101,6 +101,10 @@ sub FindNotificationRecipients {
@_
);
+ $NotificationRecipientsTo = '';
+ $NotificationRecipientsCc = '';
+ $NotificationRecipientsBcc = '';
+
my $recipients_ref = ProcessScripDryRun(%args);
$NotificationRecipientsTo = join ', ', @{$recipients_ref->{'To'}} if $recipients_ref->{'To'};
$NotificationRecipientsCc = join ', ', @{$recipients_ref->{'Cc'}} if $recipients_ref->{'Cc'};
commit 736e9bcb54aa21759d417fa1837b7d3d421877b5
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Wed Dec 21 09:57:35 2016 -0500
Prep for 0.02 release
diff --git a/Changes b/Changes
index 55e3faa..03e158e 100644
--- a/Changes
+++ b/Changes
@@ -1,4 +1,9 @@
Revision history for RT-Extension-ListAllEmailRecipients
+0.02 2016-12-21
+ - Populate recipients on create as well as update
+ - Add compatibility with RT::Extension::OneTimeTo
+ - Clear recipient values to avoid possible retention of values from previous notification
+
0.01
- Initial version
diff --git a/MANIFEST b/MANIFEST
index 4f41d40..de4fac7 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -1,4 +1,5 @@
Changes
+html/Callbacks/RT-Extension-ListAllEmailRecipients/Ticket/Display.html/Initial
html/Callbacks/RT-Extension-ListAllEmailRecipients/Ticket/Display.html/ProcessArguments
inc/Module/Install.pm
inc/Module/Install/Base.pm
diff --git a/META.yml b/META.yml
index 40305d5..45a5e81 100644
--- a/META.yml
+++ b/META.yml
@@ -23,6 +23,6 @@ requires:
perl: 5.10.1
resources:
license: http://opensource.org/licenses/gpl-license.php
-version: '0.01'
+version: '0.02'
x_module_install_rtx_version: '0.38'
x_requires_rt: 4.2.0
diff --git a/README b/README
index 198b698..859e64b 100644
--- a/README
+++ b/README
@@ -8,10 +8,6 @@ DESCRIPTION
is then made available to templates when the actual notification scrips
are subsequently run to send email.
- The current version calculates emails for comments and replies on
- existing tickets via the web UI and email. It does not calculate
- recipients on create.
-
RT VERSION
Works with RT 4.4
@@ -52,6 +48,17 @@ USAGE
<p>Cc: {$NotificationRecipientsCc} </p>
<p>Bcc: {$NotificationRecipientsBcc} </p>
+ Ticket and Transaction IDs
+ This extension generates the recipient lists by doing a trial run of the
+ incoming action (create, comment, or reply). In doing so, it doesn't
+ actually make any changes, but it does increment the ids in the ticket
+ and transaction tables and possibly others depending on your scrips.
+ This shouldn't matter for most users since ticket ids are arbitrary, but
+ some users depend on ticket ids for various reasons. If you have
+ processes that depend on specific ticket ids, be aware that using this
+ extension will create gaps between ticket and other ids in your
+ database.
+
AUTHOR
Best Practical Solutions, LLC <modules at bestpractical.com>
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index a065658..9832870 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -2,7 +2,7 @@ use strict;
use warnings;
package RT::Extension::ListAllEmailRecipients;
-our $VERSION = '0.01';
+our $VERSION = '0.02';
=head1 NAME
@@ -16,10 +16,6 @@ notification to determine the full list of email receipients. This
list is then made available to templates when the actual notification
scrips are subsequently run to send email.
-The current version calculates emails for comments and replies on
-existing tickets via the web UI and email. It does not calculate
-recipients on create.
-
=head1 RT VERSION
Works with RT 4.4
@@ -72,6 +68,17 @@ on a ticket, add something like the following to the appropriate template:
<p>Cc: {$NotificationRecipientsCc} </p>
<p>Bcc: {$NotificationRecipientsBcc} </p>
+=head2 Ticket and Transaction IDs
+
+This extension generates the recipient lists by doing a trial run of the
+incoming action (create, comment, or reply). In doing so, it doesn't actually
+make any changes, but it does increment the ids in the ticket and transaction
+tables and possibly others depending on your scrips. This shouldn't matter for
+most users since ticket ids are arbitrary, but some users depend on ticket ids
+for various reasons. If you have processes that depend on specific ticket ids,
+be aware that using this extension will create gaps between ticket and other
+ids in your database.
+
=head1 AUTHOR
Best Practical Solutions, LLC E<lt>modules at bestpractical.comE<gt>
commit 6edefc1bb015c2dedf4b2c35498f4ec8b89eb613
Author: Shawn M Moore <shawn at bestpractical.com>
Date: Fri Jan 27 17:45:16 2017 +0000
Load separate ticket obj for dry-run
This way the RanTransactionBatch flag doesn't interfere with the "real"
ticket create/update.
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index 9832870..77b58e1 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -132,9 +132,11 @@ sub ProcessScripDryRun {
my @dryrun;
if ( $args{'UpdateInterface'} eq 'EmailCreate' ) {
- @dryrun = $args{'Ticket'}->DryRun(
+ # load separate ticket obj for dry-run
+ my $TicketObj = RT::Ticket->new($args{'Ticket'}->CurrentUser);
+ @dryrun = $TicketObj->DryRun(
sub {
- $args{Ticket}->Create(
+ $TicketObj->Create(
Queue => $args{'Queue'},
Subject => $args{'Subject'},
Requestor => $args{'Requestor'},
@@ -145,16 +147,21 @@ sub ProcessScripDryRun {
);
}
elsif ( $args{'UpdateInterface'} eq 'Email' ){
+ # load separate ticket obj for dry-run
+ my $TicketObj = RT::Ticket->new($args{'CurrentUser'});
+ my ($ret, $msg) = $TicketObj->Load($args{Ticket}->Id);
+
my $action = ucfirst $args{Action};
- @dryrun = $args{'Ticket'}->DryRun(
+ @dryrun = $TicketObj->DryRun(
sub {
- my ( $status, $msg ) = $args{Ticket}->$action( MIMEObj => $args{Message} );
+ my ( $status, $msg ) = $TicketObj->$action( MIMEObj => $args{Message} );
}
);
}
elsif ( $args{'id'} and $args{'id'} eq 'new' ){
- my $TicketObj = $args{'TicketObj'};
- return unless $TicketObj;
+ return unless $args{'TicketObj'};
+ # load separate ticket obj for dry-run
+ my $TicketObj = RT::Ticket->new($args{CurrentUser});
@dryrun = $TicketObj->DryRun(
sub {
@@ -165,6 +172,7 @@ sub ProcessScripDryRun {
}
else{
+ # load separate ticket obj for dry-run
my $TicketObj = RT::Ticket->new($args{'CurrentUser'});
my ($ret, $msg) = $TicketObj->Load($args{'TicketId'});
commit 3f66999550a7a1006f7685ca2397c8416df869b7
Author: Shawn M Moore <shawn at bestpractical.com>
Date: Fri Mar 10 18:47:01 2017 +0000
Add error for failing to load ticket
This parallels what the other update-ticket codepath does
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index 77b58e1..ddc8ee6 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -151,6 +151,11 @@ sub ProcessScripDryRun {
my $TicketObj = RT::Ticket->new($args{'CurrentUser'});
my ($ret, $msg) = $TicketObj->Load($args{Ticket}->Id);
+ unless ( $ret ){
+ RT::Logger->error("Unable to load ticket " . $args{'Ticket'}->Id . ". Skipping dry run.");
+ return;
+ }
+
my $action = ucfirst $args{Action};
@dryrun = $TicketObj->DryRun(
sub {
commit a4dd4734e3a3ec418c34e090b1e6c00e3b54a5e6
Author: Shawn M Moore <shawn at bestpractical.com>
Date: Tue Jan 31 22:38:38 2017 +0000
0.03 release
diff --git a/Changes b/Changes
index 03e158e..6e7d781 100644
--- a/Changes
+++ b/Changes
@@ -1,5 +1,8 @@
Revision history for RT-Extension-ListAllEmailRecipients
+0.03 2017-01-31
+ - Fix issues with TransactionBatch scrips
+
0.02 2016-12-21
- Populate recipients on create as well as update
- Add compatibility with RT::Extension::OneTimeTo
diff --git a/META.yml b/META.yml
index 45a5e81..d42b534 100644
--- a/META.yml
+++ b/META.yml
@@ -23,6 +23,6 @@ requires:
perl: 5.10.1
resources:
license: http://opensource.org/licenses/gpl-license.php
-version: '0.02'
+version: '0.03'
x_module_install_rtx_version: '0.38'
x_requires_rt: 4.2.0
diff --git a/lib/RT/Extension/ListAllEmailRecipients.pm b/lib/RT/Extension/ListAllEmailRecipients.pm
index ddc8ee6..10246f3 100644
--- a/lib/RT/Extension/ListAllEmailRecipients.pm
+++ b/lib/RT/Extension/ListAllEmailRecipients.pm
@@ -2,7 +2,7 @@ use strict;
use warnings;
package RT::Extension::ListAllEmailRecipients;
-our $VERSION = '0.02';
+our $VERSION = '0.03';
=head1 NAME
-----------------------------------------------------------------------
More information about the Bps-public-commit
mailing list