From e13f3c57dfd14b1e45ef0fd18f076be915ea16ee Mon Sep 17 00:00:00 2001 From: sboyette Date: Mon, 18 Aug 2008 19:14:00 +0000 Subject: [PATCH] merging perl CPANification/normalization branch work git-svn-id: svn://svn.open-ils.org/OpenSRF/trunk@1418 9efc2488-bf62-4759-914b-345cdb29e865 --- Makefile.am | 2 +- src/Makefile.am | 21 +- src/gateway/Makefile.am | 4 + src/perl/Changes | 5 + src/perl/MANIFEST | 40 ++ src/perl/Makefile.PL | 26 + src/perl/README | 33 ++ src/perl/inc/Module/Install.pm | 364 +++++++++++++ src/perl/inc/Module/Install/Base.pm | 72 +++ src/perl/inc/Module/Install/Can.pm | 82 +++ src/perl/inc/Module/Install/Fetch.pm | 93 ++++ src/perl/inc/Module/Install/Makefile.pm | 251 +++++++++ src/perl/inc/Module/Install/Metadata.pm | 487 ++++++++++++++++++ src/perl/inc/Module/Install/Win32.pm | 64 +++ src/perl/inc/Module/Install/WriteAll.pm | 40 ++ src/{perlmods => perl/lib}/OpenSRF.pm | 44 +- .../lib}/OpenSRF/AppSession.pm | 21 +- .../lib}/OpenSRF/Application.pm | 13 +- .../lib}/OpenSRF/Application/Client.pm | 0 .../lib}/OpenSRF/Application/Demo/Math.pm | 0 .../lib}/OpenSRF/Application/Demo/MathDB.pm | 0 .../lib}/OpenSRF/Application/Persist.pm | 0 .../lib}/OpenSRF/Application/Settings.pm | 0 .../lib}/OpenSRF/DomainObject/oilsMessage.pm | 0 .../lib}/OpenSRF/DomainObject/oilsMethod.pm | 0 .../lib}/OpenSRF/DomainObject/oilsResponse.pm | 0 src/{perlmods => perl/lib}/OpenSRF/EX.pm | 0 .../lib}/OpenSRF/MultiSession.pm | 0 src/{perlmods => perl/lib}/OpenSRF/System.pm | 0 .../lib}/OpenSRF/Transport.pm | 0 .../lib}/OpenSRF/Transport/Listener.pm | 0 .../lib}/OpenSRF/Transport/PeerHandle.pm | 0 .../lib}/OpenSRF/Transport/SlimJabber.pm | 0 .../OpenSRF/Transport/SlimJabber/Client.pm | 77 ++- .../OpenSRF/Transport/SlimJabber/Inbound.pm | 0 .../Transport/SlimJabber/MessageWrapper.pm | 0 .../Transport/SlimJabber/PeerConnection.pm | 0 .../Transport/SlimJabber/XMPPMessage.pm | 0 .../Transport/SlimJabber/XMPPReader.pm | 0 .../lib}/OpenSRF/UnixServer.pm | 0 src/{perlmods => perl/lib}/OpenSRF/Utils.pm | 0 .../lib}/OpenSRF/Utils/Cache.pm | 59 ++- .../lib}/OpenSRF/Utils/Config.pm | 62 ++- .../lib}/OpenSRF/Utils/JSON.pm | 0 .../lib}/OpenSRF/Utils/LogServer.pm | 0 .../lib}/OpenSRF/Utils/Logger.pm | 0 .../lib}/OpenSRF/Utils/SettingsClient.pm | 0 .../lib}/OpenSRF/Utils/SettingsParser.pm | 0 src/perl/t/00-load.t | 9 + src/perl/t/pod-coverage.t | 21 + src/perl/t/pod.t | 12 + src/perlmods/OpenSRF/Transport/Jabber.pm | 11 - .../OpenSRF/Transport/Jabber/JInbound.pm | 101 ---- .../Transport/Jabber/JMessageWrapper.pm | 91 ---- .../Transport/Jabber/JPeerConnection.pm | 80 --- .../OpenSRF/Transport/Jabber/JabberClient.pm | 277 ---------- 56 files changed, 1812 insertions(+), 650 deletions(-) create mode 100644 src/perl/Changes create mode 100644 src/perl/MANIFEST create mode 100644 src/perl/Makefile.PL create mode 100644 src/perl/README create mode 100644 src/perl/inc/Module/Install.pm create mode 100644 src/perl/inc/Module/Install/Base.pm create mode 100644 src/perl/inc/Module/Install/Can.pm create mode 100644 src/perl/inc/Module/Install/Fetch.pm create mode 100644 src/perl/inc/Module/Install/Makefile.pm create mode 100644 src/perl/inc/Module/Install/Metadata.pm create mode 100644 src/perl/inc/Module/Install/Win32.pm create mode 100644 src/perl/inc/Module/Install/WriteAll.pm rename src/{perlmods => perl/lib}/OpenSRF.pm (66%) rename src/{perlmods => perl/lib}/OpenSRF/AppSession.pm (98%) rename src/{perlmods => perl/lib}/OpenSRF/Application.pm (99%) rename src/{perlmods => perl/lib}/OpenSRF/Application/Client.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Application/Demo/Math.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Application/Demo/MathDB.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Application/Persist.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Application/Settings.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/DomainObject/oilsMessage.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/DomainObject/oilsMethod.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/DomainObject/oilsResponse.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/EX.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/MultiSession.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/System.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Transport.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Transport/Listener.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Transport/PeerHandle.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Transport/SlimJabber.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Transport/SlimJabber/Client.pm (83%) rename src/{perlmods => perl/lib}/OpenSRF/Transport/SlimJabber/Inbound.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Transport/SlimJabber/MessageWrapper.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Transport/SlimJabber/PeerConnection.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Transport/SlimJabber/XMPPMessage.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Transport/SlimJabber/XMPPReader.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/UnixServer.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Utils.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Utils/Cache.pm (88%) rename src/{perlmods => perl/lib}/OpenSRF/Utils/Config.pm (86%) rename src/{perlmods => perl/lib}/OpenSRF/Utils/JSON.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Utils/LogServer.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Utils/Logger.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Utils/SettingsClient.pm (100%) rename src/{perlmods => perl/lib}/OpenSRF/Utils/SettingsParser.pm (100%) create mode 100644 src/perl/t/00-load.t create mode 100644 src/perl/t/pod-coverage.t create mode 100644 src/perl/t/pod.t delete mode 100644 src/perlmods/OpenSRF/Transport/Jabber.pm delete mode 100644 src/perlmods/OpenSRF/Transport/Jabber/JInbound.pm delete mode 100644 src/perlmods/OpenSRF/Transport/Jabber/JMessageWrapper.pm delete mode 100644 src/perlmods/OpenSRF/Transport/Jabber/JPeerConnection.pm delete mode 100644 src/perlmods/OpenSRF/Transport/Jabber/JabberClient.pm diff --git a/Makefile.am b/Makefile.am index 8d1b133..bf334d2 100644 --- a/Makefile.am +++ b/Makefile.am @@ -70,7 +70,7 @@ libosrf_FILES = @srcdir@/src/libopensrf/basic_client.c \ @srcdir@/src/libopensrf/osrfConfig.c -EXTRA_DIST = $(DOC_FILES) $(EXAMPLES_FILES) $(libosrf_FILES) $(strn_compat_FILES) $(python_FILES) $(java_FILES) @srcdir@/autogen.sh @srcdir@/src/extras @srcdir@/DCO-1.1.txt @srcdir@/LICENSE.txt @srcdir@/src/perlmods @srcdir@/src/javascript +EXTRA_DIST = $(DOC_FILES) $(EXAMPLES_FILES) $(libosrf_FILES) $(strn_compat_FILES) $(python_FILES) $(java_FILES) @srcdir@/autogen.sh @srcdir@/src/extras @srcdir@/DCO-1.1.txt @srcdir@/LICENSE.txt @srcdir@/src/perl @srcdir@/src/javascript opensrfincludedir = @includedir@/opensrf diff --git a/src/Makefile.am b/src/Makefile.am index c32950b..c7f0cfd 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -17,7 +17,6 @@ export OPENSRF = opensrf export BINDIR = @bindir@ export LIBDIR = @libdir@ -perldir = $(LIBDIR)/perl5 jsdir = $(LIBDIR)/javascript export OSRF_JAVA_DEPSDIR = @OSRF_JAVA_DEPSDIR@ etcdir = $(ETCDIR) @@ -47,7 +46,7 @@ install-exec-local: mkdir -p $(LOG) mkdir -p $(SOCK) mkdir -p $(jsdir) - mkdir -p $(perldir) + make install-perl install-exec-hook: sed -i 's|LOCALSTATEDIR|$(VAR)|g' '$(DESTDIR)@sysconfdir@/opensrf.xml.example' @@ -60,12 +59,24 @@ install-exec-hook: sed -i 's|LIBDIR|$(LIBDIR)|g' '@abs_top_srcdir@/examples/multisession-test.pl' sed -i 's|SYSCONFDIR|$(ETCDIR)|g' '@abs_top_srcdir@/doc/dokuwiki-doc-stubber.pl' cp -r @srcdir@/javascript/* $(jsdir)/ - sed -i 's|LOCALSTATEDIR|$(VAR)|g' '@srcdir@/perlmods/OpenSRF/Utils/Config.pm' - cp -r @srcdir@/perlmods/* $(perldir)/ +install-perl: + cd ./perl && perl Makefile.PL || make -s install-perl-fail + make -C perl + make -C perl test || make -s install-perl-fail + make -C perl install + +install-perl-fail: + echo + echo ">>> Installation of Perl modules has failed. The most likely" + echo ">>> possibility is that a dependency is not pre-installed" + echo ">>> or that a test has failed." + echo ">>> See the messages above this one for more information." + echo + exit 1 + uninstall-hook: rm @includedir@/opensrf/apachetools.h rm -R $(jsdir) - rm -R $(perldir) diff --git a/src/gateway/Makefile.am b/src/gateway/Makefile.am index f345a00..3fba17c 100644 --- a/src/gateway/Makefile.am +++ b/src/gateway/Makefile.am @@ -18,6 +18,10 @@ AM_CFLAGS = -D_LARGEFILE64_SOURCE -Wall -I@abs_top_srcdir@/include/ -I$(LIBXML2_ AM_LDFLAGS = -L$(LIBDIR) -L@top_builddir@/src/libopensrf install-exec-local: + if [ ! "$$(grep mod_placeholder `apxs2 -q SYSCONFDIR`/httpd.conf)" ]; \ + then echo -e "#\n#LoadModule mod_placeholder /usr/lib/apache2/modules/mod_placeholder.so" \ + >> `apxs2 -q SYSCONFDIR`/httpd.conf; \ + fi $(APXS2) -c $(DEF_LDLIBS) $(AM_CFLAGS) $(AM_LDFLAGS) @srcdir@/osrf_json_gateway.c apachetools.c apachetools.h libopensrf.so $(APXS2) -c $(DEF_LDLIBS) $(AM_CFLAGS) $(AM_LDFLAGS) @srcdir@/osrf_http_translator.c apachetools.c apachetools.h libopensrf.so $(APXS2) -i -a @srcdir@/osrf_json_gateway.la diff --git a/src/perl/Changes b/src/perl/Changes new file mode 100644 index 0000000..c12049f --- /dev/null +++ b/src/perl/Changes @@ -0,0 +1,5 @@ +Revision history for OpenSRF + +0.9 2006/07 + First version, released on an unsuspecting world. + diff --git a/src/perl/MANIFEST b/src/perl/MANIFEST new file mode 100644 index 0000000..931f8b0 --- /dev/null +++ b/src/perl/MANIFEST @@ -0,0 +1,40 @@ +Changes +MANIFEST +Makefile.PL +README +lib/OpenSRF.pm +lib/OpenSRF/Application.pm +lib/OpenSRF/Application/Client.pm +lib/OpenSRF/Application/Persist.pm +lib/OpenSRF/Application/Settings.pm +lib/OpenSRF/Application/Demo/Math.pm +lib/OpenSRF/Application/Demo/MathDB.pm +lib/OpenSRF/AppSession.pm +lib/OpenSRF/DomainObject/oilsMessage.pm +lib/OpenSRF/DomainObject/oilsMethod.pm +lib/OpenSRF/DomainObject/oilsResponse.pm +lib/OpenSRF/EX.pm +lib/OpenSRF/MultiSession.pm +lib/OpenSRF/System.pm +lib/OpenSRF/Transport.pm +lib/OpenSRF/Transport/Listener.pm +lib/OpenSRF/Transport/PeerHandle.pm +lib/OpenSRF/Transport/SlimJabber.pm +lib/OpenSRF/Transport/SlimJabber/Client.pm +lib/OpenSRF/Transport/SlimJabber/Inbound.pm +lib/OpenSRF/Transport/SlimJabber/MessageWrapper.pm +lib/OpenSRF/Transport/SlimJabber/PeerConnection.pm +lib/OpenSRF/Transport/SlimJabber/XMPPMessage.pm +lib/OpenSRF/Transport/SlimJabber/XMPPReader.pm +lib/OpenSRF/UnixServer.pm +lib/OpenSRF/Utils.pm +lib/OpenSRF/Utils/Cache.pm +lib/OpenSRF/Utils/Config.pm +lib/OpenSRF/Utils/JSON.pm +lib/OpenSRF/Utils/Logger.pm +lib/OpenSRF/Utils/LogServer.pm +lib/OpenSRF/Utils/SettingsClient.pm +lib/OpenSRF/Utils/SettingsParser.pm +t/00-load.t +t/pod-coverage.t +t/pod.t diff --git a/src/perl/Makefile.PL b/src/perl/Makefile.PL new file mode 100644 index 0000000..55d5127 --- /dev/null +++ b/src/perl/Makefile.PL @@ -0,0 +1,26 @@ +use inc::Module::Install; + +# Define metadata +name 'OpenSRF'; +all_from 'lib/OpenSRF.pm'; +license 'perl'; + +# Specific dependencies +requires 'Cache::Memcached' => 0; +requires 'Data::Dumper' => 0; +requires 'DateTime' => 0; +requires 'DBI' => 0; +requires 'Digest::MD5' => 0; +requires 'Errno' => 0; +requires 'Error' => 0; +requires 'FreezeThaw' => 0; +requires 'IO' => 0; +requires 'JSON' => 0; +requires 'Net::Domain' => 0; +requires 'Net::Server' => 0; +requires 'Time::HiRes' => 0; +requires 'Time::Local' => 0; +requires 'UNIVERSAL::require' => 0; +requires 'XML::LibXML' => 0; + +WriteAll; diff --git a/src/perl/README b/src/perl/README new file mode 100644 index 0000000..b7015e5 --- /dev/null +++ b/src/perl/README @@ -0,0 +1,33 @@ +OpenSRF + +OpenSRF (Open OpenSRF (Open Scalable Request Framework) is a core +subsystem of the Evergreen ILS. + +INSTALLATION + +To install this module, run the following commands: + + perl Makefile.PL + make + make test + make install + +SUPPORT AND DOCUMENTATION + +After installing, you can find documentation for this module with the +perldoc command. + + perldoc OpenSRF + +You can also look for information at: + + http://svn.open-ils.org/trac/OpenSRF + + +COPYRIGHT AND LICENCE + +Copyright (C) 2008 Equinox Software, Inc. + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + diff --git a/src/perl/inc/Module/Install.pm b/src/perl/inc/Module/Install.pm new file mode 100644 index 0000000..87bed66 --- /dev/null +++ b/src/perl/inc/Module/Install.pm @@ -0,0 +1,364 @@ +#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 +# } + +BEGIN { + require 5.004; +} +use strict 'vars'; + +use vars qw{$VERSION}; +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 = '0.76'; + + *inc::Module::Install::VERSION = *VERSION; + @inc::Module::Install::ISA = __PACKAGE__; + +} + + + + + +# 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 + + + + + +# 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 and (stat($0))[9] > time ) { die <<"END_DIE" } + +Your installer $0 has a modification time in the future. + +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)); + + + + + +use Cwd (); +use File::Find (); +use File::Path (); +use FindBin; + +sub autoload { + my $self = shift; + my $who = $self->_caller; + my $cwd = Cwd::cwd(); + my $sym = "${who}::AUTOLOAD"; + $sym->{$cwd} = sub { + my $pwd = Cwd::cwd(); + if ( my $code = $sym->{$pwd} ) { + # delegate back to parent dirs + goto &$code unless $cwd eq $pwd; + } + $$sym =~ /([^:]+)$/ or die "Cannot autoload $who - $sym"; + unshift @_, ( $self, $1 ); + goto &{$self->can('call')} unless uc($1) eq $1; + }; +} + +sub import { + my $class = shift; + my $self = $class->new(@_); + my $who = $self->_caller; + + unless ( -f $self->{file} ) { + 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"}; + } + + *{"${who}::AUTOLOAD"} = $self->autoload; + $self->preload; + + # Unregister loader and worker packages so subdirs can use them again + delete $INC{"$self->{file}"}; + delete $INC{"$self->{path}.pm"}; + + return 1; +} + +sub preload { + my $self = shift; + unless ( $self->{extensions} ) { + $self->load_extensions( + "$self->{prefix}/$self->{path}", $self + ); + } + + my @exts = @{$self->{extensions}}; + unless ( @exts ) { + my $admin = $self->{admin}; + @exts = $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 ) { + *{"${who}::$name"} = sub { + ${"${who}::AUTOLOAD"} = "${who}::$name"; + goto &{"${who}::AUTOLOAD"}; + }; + } +} + +sub new { + my ($class, %args) = @_; + + # ignore the prefix on extension modules built from top level. + my $base_path = Cwd::abs_path($FindBin::Bin); + unless ( Cwd::abs_path(Cwd::cwd()) 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) = @_; + + unless ( grep { lc $_ eq lc $self->{prefix} } @INC ) { + unshift @INC, $self->{prefix}; + } + + foreach my $rv ( $self->find_extensions($path) ) { + my ($file, $pkg) = @{$rv}; + next if $self->{pathnames}{$pkg}; + + local $@; + my $new = eval { require $file; $pkg->can('new') }; + unless ( $new ) { + warn $@ if $@; + next; + } + $self->{pathnames}{$pkg} = delete $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 //, $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; +} + + + + + +##################################################################### +# Utility Functions + +sub _caller { + my $depth = 0; + my $call = caller($depth); + while ( $call eq __PACKAGE__ ) { + $depth++; + $call = caller($depth); + } + return $call; +} + +sub _read { + local *FH; + open FH, "< $_[0]" or die "open($_[0]): $!"; + my $str = do { local $/; }; + close FH or die "close($_[0]): $!"; + return $str; +} + +sub _write { + local *FH; + open FH, "> $_[0]" or die "open($_[0]): $!"; + foreach ( 1 .. $#_ ) { print FH $_[$_] or die "print($_[0]): $!" } + close FH or die "close($_[0]): $!"; +} + +sub _version ($) { + my $s = shift || 0; + $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; +} + +# Cloned from Params::Util::_CLASS +sub _CLASS ($) { + ( + defined $_[0] + and + ! ref $_[0] + and + $_[0] =~ m/^[^\W\d]\w*(?:::\w+)*$/s + ) ? $_[0] : undef; +} + +1; + +# Copyright 2008 Adam Kennedy. diff --git a/src/perl/inc/Module/Install/Base.pm b/src/perl/inc/Module/Install/Base.pm new file mode 100644 index 0000000..76b32f8 --- /dev/null +++ b/src/perl/inc/Module/Install/Base.pm @@ -0,0 +1,72 @@ +#line 1 +package Module::Install::Base; + +$VERSION = '0.76'; + +# Suspend handler for "redefined" warnings +BEGIN { + my $w = $SIG{__WARN__}; + $SIG{__WARN__} = sub { $w }; +} + +### This is the ONLY module that shouldn't have strict on +# use strict; + +#line 41 + +sub new { + my ($class, %args) = @_; + + foreach my $method ( qw(call load) ) { + *{"$class\::$method"} = sub { + shift()->_top->$method(@_); + } unless defined &{"$class\::$method"}; + } + + bless( \%args, $class ); +} + +#line 61 + +sub AUTOLOAD { + my $self = shift; + local $@; + my $autoload = eval { $self->_top->autoload } or return; + goto &$autoload; +} + +#line 76 + +sub _top { $_[0]->{_top} } + +#line 89 + +sub admin { + $_[0]->_top->{admin} or Module::Install::Base::FakeAdmin->new; +} + +#line 101 + +sub is_admin { + $_[0]->admin->VERSION; +} + +sub DESTROY {} + +package Module::Install::Base::FakeAdmin; + +my $Fake; +sub new { $Fake ||= bless(\@_, $_[0]) } + +sub AUTOLOAD {} + +sub DESTROY {} + +# Restore warning handler +BEGIN { + $SIG{__WARN__} = $SIG{__WARN__}->(); +} + +1; + +#line 146 diff --git a/src/perl/inc/Module/Install/Can.pm b/src/perl/inc/Module/Install/Can.pm new file mode 100644 index 0000000..dd9a81c --- /dev/null +++ b/src/perl/inc/Module/Install/Can.pm @@ -0,0 +1,82 @@ +#line 1 +package Module::Install::Can; + +use strict; +use Module::Install::Base; +use Config (); +### This adds a 5.005 Perl version dependency. +### This is a bug and will be fixed. +use File::Spec (); +use ExtUtils::MakeMaker (); + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.76'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +# 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}), '.') { + my $abs = File::Spec->catfile($dir, $_[1]); + return $abs if (-x $abs or $abs = MM->maybe_command($abs)); + } + + return; +} + +# 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 157 diff --git a/src/perl/inc/Module/Install/Fetch.pm b/src/perl/inc/Module/Install/Fetch.pm new file mode 100644 index 0000000..58df9ff --- /dev/null +++ b/src/perl/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 $ISCORE @ISA}; +BEGIN { + $VERSION = '0.76'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +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@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/src/perl/inc/Module/Install/Makefile.pm b/src/perl/inc/Module/Install/Makefile.pm new file mode 100644 index 0000000..05af6ef --- /dev/null +++ b/src/perl/inc/Module/Install/Makefile.pm @@ -0,0 +1,251 @@ +#line 1 +package Module::Install::Makefile; + +use strict 'vars'; +use Module::Install::Base; +use ExtUtils::MakeMaker (); + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.76'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +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, always use defaults + if ( $ENV{AUTOMATED_TESTING} and ! $ENV{PERL_MM_USE_DEFAULT} ) { + local $ENV{PERL_MM_USE_DEFAULT} = 1; + goto &ExtUtils::MakeMaker::prompt; + } else { + goto &ExtUtils::MakeMaker::prompt; + } +} + +sub makemaker_args { + my $self = shift; + my $args = ( $self->{makemaker_args} ||= {} ); + %$args = ( %$args, @_ ); + return $args; +} + +# For mm args that take multiple space-seperated args, +# append an argument to the current list. +sub makemaker_append { + my $self = sShift; + 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 ); +} + +my %test_dir = (); + +sub _wanted_t { + /\.t$/ and -f $_ and $test_dir{$File::Find::dir} = 1; +} + +sub tests_recursive { + my $self = shift; + if ( $self->tests ) { + die "tests_recursive will not work if tests are already defined"; + } + my $dir = shift || 't'; + unless ( -d $dir ) { + die "tests_recursive dir '$dir' does not exist"; + } + %test_dir = (); + require File::Find; + File::Find::find( \&_wanted_t, $dir ); + $self->tests( join ' ', map { "$_/*.t" } sort keys %test_dir ); +} + +sub write { + my $self = shift; + die "&Makefile->write() takes no arguments\n" if @_; + + # Make sure we have a new enough + require ExtUtils::MakeMaker; + + # MakeMaker can complain about module versions that include + # an underscore, even though its own version may contain one! + # Hence the funny regexp to get rid of it. See RT #35800 + # for details. + + $self->configure_requires( 'ExtUtils::MakeMaker' => $ExtUtils::MakeMaker::VERSION =~ /^(\d+\.\d+)/ ); + + # Generate the + my $args = $self->makemaker_args; + $args->{DISTNAME} = $self->name; + $args->{NAME} = $self->module_name || $self->name; + $args->{VERSION} = $self->version; + $args->{NAME} =~ s/-/::/g; + if ( $self->tests ) { + $args->{test} = { TESTS => $self->tests }; + } + if ($] >= 5.005) { + $args->{ABSTRACT} = $self->abstract; + $args->{AUTHOR} = $self->author; + } + if ( eval($ExtUtils::MakeMaker::VERSION) >= 6.10 ) { + $args->{NO_META} = 1; + } + if ( eval($ExtUtils::MakeMaker::VERSION) > 6.17 and $self->sign ) { + $args->{SIGN} = 1; + } + unless ( $self->is_admin ) { + delete $args->{SIGN}; + } + + # merge both kinds of requires into prereq_pm + my $prereq = ($args->{PREREQ_PM} ||= {}); + %$prereq = ( %$prereq, + map { @$_ } + map { @$_ } + grep $_, + ($self->configure_requires, $self->build_requires, $self->requires) + ); + + # Remove any reference to perl, PREREQ_PM doesn't support it + delete $args->{PREREQ_PM}->{perl}; + + # merge both kinds of requires into prereq_pm + my $subdirs = ($args->{DIR} ||= []); + if ($self->bundles) { + foreach my $bundle (@{ $self->bundles }) { + my ($file, $dir) = @$bundle; + push @$subdirs, $dir if -d $dir; + delete $prereq->{$file}; + } + } + + 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"; + } + + $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)) { + $args{dist} = $preop; + } + + 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: $!"; + my $makefile = do { local $/; }; + close MAKEFILE or die $!; + + $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; + + open MAKEFILE, "> $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!"; + 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 377 diff --git a/src/perl/inc/Module/Install/Metadata.pm b/src/perl/inc/Module/Install/Metadata.pm new file mode 100644 index 0000000..90175f0 --- /dev/null +++ b/src/perl/inc/Module/Install/Metadata.pm @@ -0,0 +1,487 @@ +#line 1 +package Module::Install::Metadata; + +use strict 'vars'; +use Module::Install::Base; + +use vars qw{$VERSION $ISCORE @ISA}; +BEGIN { + $VERSION = '0.76'; + $ISCORE = 1; + @ISA = qw{Module::Install::Base}; +} + +my @scalar_keys = qw{ + name + module_name + abstract + author + version + distribution_type + tests + installdirs +}; + +my @tuple_keys = qw{ + configure_requires + build_requires + requires + recommends + bundles + resources +}; + +my @resource_keys = qw{ + homepage + bugtracker + repository +}; + +sub Meta { shift } +sub Meta_ScalarKeys { @scalar_keys } +sub Meta_TupleKeys { @tuple_keys } +sub Meta_ResourceKeys { @resource_keys } + +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 ( @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; + }; +} + +sub requires { + my $self = shift; + while ( @_ ) { + my $module = shift or last; + my $version = shift || 0; + push @{ $self->{values}{requires} }, [ $module, $version ]; + } + $self->{values}{requires}; +} + +sub build_requires { + my $self = shift; + while ( @_ ) { + my $module = shift or last; + my $version = shift || 0; + push @{ $self->{values}{build_requires} }, [ $module, $version ]; + } + $self->{values}{build_requires}; +} + +sub configure_requires { + my $self = shift; + while ( @_ ) { + my $module = shift or last; + my $version = shift || 0; + push @{ $self->{values}{configure_requires} }, [ $module, $version ]; + } + $self->{values}{configure_requires}; +} + +sub recommends { + my $self = shift; + while ( @_ ) { + my $module = shift or last; + my $version = shift || 0; + push @{ $self->{values}{recommends} }, [ $module, $version ]; + } + $self->{values}{recommends}; +} + +sub bundles { + my $self = shift; + while ( @_ ) { + my $module = shift or last; + my $version = shift || 0; + push @{ $self->{values}{bundles} }, [ $module, $version ]; + } + $self->{values}{bundles}; +} + +# 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 sign { + my $self = shift; + return $self->{values}{sign} if defined wantarray and ! @_; + $self->{values}{sign} = ( @_ ? $_[0] : 1 ); + return $self; +} + +sub dynamic_config { + my $self = shift; + unless ( @_ ) { + warn "You MUST provide an explicit true/false value to dynamic_config\n"; + return $self; + } + $self->{values}{dynamic_config} = $_[0] ? 1 : 0; + return 1; +} + +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()" + ); + $version =~ s/_.+$//; + $version = $version + 0; # Numify + unless ( $version >= 5.005 ) { + die "Module::Install only supports 5.005 or newer (use ExtUtils::MakeMaker)\n"; + } + $self->{values}{perl_version} = $version; + return 1; +} + +sub license { + my $self = shift; + return $self->{values}{license} unless @_; + my $license = shift or die( + 'Did not provide a value to license()' + ); + $self->{values}{license} = $license; + + # Automatically fill in license URLs + if ( $license eq 'perl' ) { + $self->resources( license => 'http://dev.perl.org/licenses/' ); + } + + return 1; +} + +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"); + } + } + + # 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) ); +} + +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 perl_version_from { + my $self = shift; + if ( + Module::Install::_read($_[0]) =~ m/ + ^ + (?:use|require) \s* + v? + ([\d_\.]+) + \s* ; + /ixms + ) { + my $perl_version = $1; + $perl_version =~ s{_}{}g; + $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; + $author =~ s{E}{<}g; + $author =~ s{E}{>}g; + $self->author($author); + } else { + warn "Cannot determine author info from $_[0]\n"; + } +} + +sub license_from { + my $self = shift; + if ( + Module::Install::_read($_[0]) =~ m/ + ( + =head \d \s+ + (?:licen[cs]e|licensing|copyright|legal)\b + .*? + ) + (=head\\d.*|=cut.*|) + \z + /ixms ) { + my $license_text = $1; + my @phrases = ( + 'under the same (?:terms|license) as perl itself' => 'perl', 1, + 'GNU public license' => 'gpl', 1, + 'GNU lesser public license' => 'lgpl', 1, + 'BSD license' => 'bsd', 1, + 'Artistic license' => 'artistic', 1, + 'GPL' => 'gpl', 1, + 'LGPL' => 'lgpl', 1, + 'BSD' => 'bsd', 1, + 'Artistic' => 'artistic', 1, + 'MIT' => 'mit', 1, + 'proprietary' => 'proprietary', 0, + ); + while ( my ($pattern, $license, $osi) = splice(@phrases, 0, 3) ) { + $pattern =~ s{\s+}{\\s+}g; + if ( $license_text =~ /\b$pattern\b/i ) { + if ( $osi and $license_text =~ /All rights reserved/i ) { + print "WARNING: 'All rights reserved' in copyright may invalidate Open Source license.\n"; + } + $self->license($license); + return 1; + } + } + } + + warn "Cannot determine license info from $_[0]\n"; + return 'unknown'; +} + +sub bugtracker_from { + my $self = shift; + my $content = Module::Install::_read($_[0]); + my @links = $content =~ m/L\<(http\:\/\/rt\.cpan\.org\/[^>]+)\>/g; + unless ( @links ) { + warn "Cannot determine bugtracker info from $_[0]\n"; + return 0; + } + if ( @links > 1 ) { + warn "Found more than on rt.cpan.org link in $_[0]\n"; + return 0; + } + + # Set the bugtracker + bugtracker( $links[0] ); + return 1; +} + +sub install_script { + my $self = shift; + my $args = $self->makemaker_args; + my $exe = $args->{EXE_FILES} ||= []; + foreach ( @_ ) { + if ( -f $_ ) { + push @$exe, $_; + } elsif ( -d 'script' and -f "script/$_" ) { + push @$exe, "script/$_"; + } else { + die("Cannot find script '$_'"); + } + } +} + +1; diff --git a/src/perl/inc/Module/Install/Win32.pm b/src/perl/inc/Module/Install/Win32.pm new file mode 100644 index 0000000..f890074 --- /dev/null +++ b/src/perl/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 = '0.76'; + @ISA = qw{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/src/perl/inc/Module/Install/WriteAll.pm b/src/perl/inc/Module/Install/WriteAll.pm new file mode 100644 index 0000000..a50d31e --- /dev/null +++ b/src/perl/inc/Module/Install/WriteAll.pm @@ -0,0 +1,40 @@ +#line 1 +package Module::Install::WriteAll; + +use strict; +use Module::Install::Base; + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '0.76'; + @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->Meta->write if $args{meta}; + $self->admin->WriteAll(%args) if $self->is_admin; + + $self->check_nmake if $args{check_nmake}; + unless ( $self->makemaker_args->{PL_FILES} ) { + $self->makemaker_args( PL_FILES => {} ); + } + + if ( $args{inline} ) { + $self->Inline->write; + } else { + $self->Makefile->write; + } +} + +1; diff --git a/src/perlmods/OpenSRF.pm b/src/perl/lib/OpenSRF.pm similarity index 66% rename from src/perlmods/OpenSRF.pm rename to src/perl/lib/OpenSRF.pm index 865f997..4bb598b 100644 --- a/src/perlmods/OpenSRF.pm +++ b/src/perl/lib/OpenSRF.pm @@ -1,37 +1,40 @@ package OpenSRF; + use strict; +use vars qw/$AUTOLOAD/; + use Error; require UNIVERSAL::require; -use vars qw/$VERSION $AUTOLOAD/; -$VERSION = do { my @r=(q$Revision$=~/\d+/g); sprintf "%d."."%02d"x$#r,@r }; -=head1 OpenSRF +# $Revision$ -=cut +=head1 NAME -=head2 Overview +OpenSRF - Top level class for OpenSRF perl modules. - Top level class for OpenSRF perl modules. +=head1 VERSION + +Version 0.9.1 =cut -# Exception base classes -#use Exception::Class -# ( OpenSRFException => { fields => [ 'errno' ] }); -#push @Exception::Class::ISA, 'Error'; +our $VERSION = 0.9.1; + +=head1 METHODS -=head3 AUTOLOAD() +=head2 AUTOLOAD - Traps methods calls for methods that have not been defined so they - don't propogate up the class hierarchy. +Traps methods calls for methods that have not been defined so they +don't propogate up the class hierarchy. =cut + sub AUTOLOAD { my $self = shift; my $type = ref($self) || $self; my $name = $AUTOLOAD; my $otype = ref $self; - + my ($package, $filename, $line) = caller; my ($package1, $filename1, $line1) = caller(1); my ($package2, $filename2, $line2) = caller(2); @@ -56,12 +59,13 @@ sub AUTOLOAD { -=head3 alert_abstract() +=head2 alert_abstract - This method is called by abstract methods to ensure that - the process dies when an undefined abstract method is called +This method is called by abstract methods to ensure that the process +dies when an undefined abstract method is called. =cut + sub alert_abstract() { my $c = shift; my $class = ref( $c ) || $c; @@ -69,6 +73,12 @@ sub alert_abstract() { die " * Call to abstract method $method at $file, line $line"; } +=head2 class + +Returns the scalar value of its caller. + +=cut + sub class { return scalar(caller); } 1; diff --git a/src/perlmods/OpenSRF/AppSession.pm b/src/perl/lib/OpenSRF/AppSession.pm similarity index 98% rename from src/perlmods/OpenSRF/AppSession.pm rename to src/perl/lib/OpenSRF/AppSession.pm index 9d3e8b4..d6bc91a 100644 --- a/src/perlmods/OpenSRF/AppSession.pm +++ b/src/perl/lib/OpenSRF/AppSession.pm @@ -317,18 +317,17 @@ sub connect { # just using a default for now XXX my $time_remaining = 5; - -=head blah - my $client = OpenSRF::Utils::SettingsClient->new(); - my $trans = $client->config_value("client_connection","transport_host"); - if(!ref($trans)) { - $time_remaining = $trans->{connect_timeout}; - } else { - # XXX for now, just use the first - $time_remaining = $trans->[0]->{connect_timeout}; - } -=cut + +# my $client = OpenSRF::Utils::SettingsClient->new(); +# my $trans = $client->config_value("client_connection","transport_host"); +# +# if(!ref($trans)) { +# $time_remaining = $trans->{connect_timeout}; +# } else { +# # XXX for now, just use the first +# $time_remaining = $trans->[0]->{connect_timeout}; +# } while ( $self->state != CONNECTED and $time_remaining > 0 ) { my $starttime = time; diff --git a/src/perlmods/OpenSRF/Application.pm b/src/perl/lib/OpenSRF/Application.pm similarity index 99% rename from src/perlmods/OpenSRF/Application.pm rename to src/perl/lib/OpenSRF/Application.pm index 3952bfa..0329a02 100644 --- a/src/perlmods/OpenSRF/Application.pm +++ b/src/perl/lib/OpenSRF/Application.pm @@ -36,16 +36,16 @@ sub signature { return $self->{signature}; } -sub argc { - my $self = shift; - return 0 unless ref($self); - return $self->{argc}; +sub strict { + my $self = shift; + return 0 unless ref($self); + return $self->{strict}; } -sub strict { +sub argc { my $self = shift; return 0 unless ref($self); - return $self->{strict}; + return $self->{argc}; } sub api_name { @@ -153,6 +153,7 @@ sub handler { my $resp; try { + # un-if(0) this block to enable param checking based on signature and argc if ($coderef->strict) { if (@args < $coderef->argc) { die "Not enough params passed to ". diff --git a/src/perlmods/OpenSRF/Application/Client.pm b/src/perl/lib/OpenSRF/Application/Client.pm similarity index 100% rename from src/perlmods/OpenSRF/Application/Client.pm rename to src/perl/lib/OpenSRF/Application/Client.pm diff --git a/src/perlmods/OpenSRF/Application/Demo/Math.pm b/src/perl/lib/OpenSRF/Application/Demo/Math.pm similarity index 100% rename from src/perlmods/OpenSRF/Application/Demo/Math.pm rename to src/perl/lib/OpenSRF/Application/Demo/Math.pm diff --git a/src/perlmods/OpenSRF/Application/Demo/MathDB.pm b/src/perl/lib/OpenSRF/Application/Demo/MathDB.pm similarity index 100% rename from src/perlmods/OpenSRF/Application/Demo/MathDB.pm rename to src/perl/lib/OpenSRF/Application/Demo/MathDB.pm diff --git a/src/perlmods/OpenSRF/Application/Persist.pm b/src/perl/lib/OpenSRF/Application/Persist.pm similarity index 100% rename from src/perlmods/OpenSRF/Application/Persist.pm rename to src/perl/lib/OpenSRF/Application/Persist.pm diff --git a/src/perlmods/OpenSRF/Application/Settings.pm b/src/perl/lib/OpenSRF/Application/Settings.pm similarity index 100% rename from src/perlmods/OpenSRF/Application/Settings.pm rename to src/perl/lib/OpenSRF/Application/Settings.pm diff --git a/src/perlmods/OpenSRF/DomainObject/oilsMessage.pm b/src/perl/lib/OpenSRF/DomainObject/oilsMessage.pm similarity index 100% rename from src/perlmods/OpenSRF/DomainObject/oilsMessage.pm rename to src/perl/lib/OpenSRF/DomainObject/oilsMessage.pm diff --git a/src/perlmods/OpenSRF/DomainObject/oilsMethod.pm b/src/perl/lib/OpenSRF/DomainObject/oilsMethod.pm similarity index 100% rename from src/perlmods/OpenSRF/DomainObject/oilsMethod.pm rename to src/perl/lib/OpenSRF/DomainObject/oilsMethod.pm diff --git a/src/perlmods/OpenSRF/DomainObject/oilsResponse.pm b/src/perl/lib/OpenSRF/DomainObject/oilsResponse.pm similarity index 100% rename from src/perlmods/OpenSRF/DomainObject/oilsResponse.pm rename to src/perl/lib/OpenSRF/DomainObject/oilsResponse.pm diff --git a/src/perlmods/OpenSRF/EX.pm b/src/perl/lib/OpenSRF/EX.pm similarity index 100% rename from src/perlmods/OpenSRF/EX.pm rename to src/perl/lib/OpenSRF/EX.pm diff --git a/src/perlmods/OpenSRF/MultiSession.pm b/src/perl/lib/OpenSRF/MultiSession.pm similarity index 100% rename from src/perlmods/OpenSRF/MultiSession.pm rename to src/perl/lib/OpenSRF/MultiSession.pm diff --git a/src/perlmods/OpenSRF/System.pm b/src/perl/lib/OpenSRF/System.pm similarity index 100% rename from src/perlmods/OpenSRF/System.pm rename to src/perl/lib/OpenSRF/System.pm diff --git a/src/perlmods/OpenSRF/Transport.pm b/src/perl/lib/OpenSRF/Transport.pm similarity index 100% rename from src/perlmods/OpenSRF/Transport.pm rename to src/perl/lib/OpenSRF/Transport.pm diff --git a/src/perlmods/OpenSRF/Transport/Listener.pm b/src/perl/lib/OpenSRF/Transport/Listener.pm similarity index 100% rename from src/perlmods/OpenSRF/Transport/Listener.pm rename to src/perl/lib/OpenSRF/Transport/Listener.pm diff --git a/src/perlmods/OpenSRF/Transport/PeerHandle.pm b/src/perl/lib/OpenSRF/Transport/PeerHandle.pm similarity index 100% rename from src/perlmods/OpenSRF/Transport/PeerHandle.pm rename to src/perl/lib/OpenSRF/Transport/PeerHandle.pm diff --git a/src/perlmods/OpenSRF/Transport/SlimJabber.pm b/src/perl/lib/OpenSRF/Transport/SlimJabber.pm similarity index 100% rename from src/perlmods/OpenSRF/Transport/SlimJabber.pm rename to src/perl/lib/OpenSRF/Transport/SlimJabber.pm diff --git a/src/perlmods/OpenSRF/Transport/SlimJabber/Client.pm b/src/perl/lib/OpenSRF/Transport/SlimJabber/Client.pm similarity index 83% rename from src/perlmods/OpenSRF/Transport/SlimJabber/Client.pm rename to src/perl/lib/OpenSRF/Transport/SlimJabber/Client.pm index c136c2c..ed3d5a0 100644 --- a/src/perlmods/OpenSRF/Transport/SlimJabber/Client.pm +++ b/src/perl/lib/OpenSRF/Transport/SlimJabber/Client.pm @@ -1,5 +1,8 @@ package OpenSRF::Transport::SlimJabber::Client; -use strict; use warnings; + +use strict; +use warnings; + use OpenSRF::EX; use OpenSRF::Utils::Config; use OpenSRF::Utils::Logger qw/$logger/; @@ -12,6 +15,26 @@ sub DESTROY{ shift()->disconnect; } +=head1 NAME + +OpenSRF::Transport::SlimJabber::Client + +=head1 SYNOPSIS + + + +=head1 DESCRIPTION + + + +=cut + +=head1 METHODS + +=head2 new + +=cut + sub new { my( $class, %params ) = @_; my $self = bless({}, ref($class) || $class); @@ -19,6 +42,9 @@ sub new { return $self; } +=head2 reader + +=cut sub reader { my($self, $reader) = @_; @@ -26,24 +52,40 @@ sub reader { return $self->{reader}; } +=head2 params + +=cut + sub params { my($self, $params) = @_; $self->{params} = $params if $params; return $self->{params}; } +=head2 socket + +=cut + sub socket { my($self, $socket) = @_; $self->{socket} = $socket if $socket; return $self->{socket}; } +=head2 disconnect + +=cut + sub disconnect { my $self = shift; $self->reader->disconnect if $self->reader; } +=head2 gather + +=cut + sub gather { my $self = shift; $self->process( 0 ); @@ -51,6 +93,10 @@ sub gather { # ------------------------------------------------- +=head2 tcp_connected + +=cut + sub tcp_connected { my $self = shift; return $self->reader->tcp_connected if $self->reader; @@ -59,12 +105,20 @@ sub tcp_connected { +=head2 send + +=cut + sub send { my $self = shift; my $msg = OpenSRF::Transport::SlimJabber::XMPPMessage->new(@_); $self->reader->send($msg->to_xml); } +=head2 initialize + +=cut + sub initialize { my $self = shift; @@ -103,12 +157,20 @@ sub initialize { } +=head2 construct + +=cut + sub construct { my( $class, $app ) = @_; $class->peer_handle($class->new( $app )->initialize()); } +=head2 process + +=cut + sub process { my($self, $timeout) = @_; @@ -124,11 +186,14 @@ sub process { } -# -------------------------------------------------------------- -# Sets the socket to O_NONBLOCK, reads all of the data off of -# the socket, the restores the sockets flags -# Returns 1 on success, 0 if the socket isn't connected -# -------------------------------------------------------------- +=head2 flush_socket + +Sets the socket to O_NONBLOCK, reads all of the data off of the +socket, the restores the sockets flags. Returns 1 on success, 0 if +the socket isn't connected. + +=cut + sub flush_socket { my $self = shift; return $self->reader->flush_socket; diff --git a/src/perlmods/OpenSRF/Transport/SlimJabber/Inbound.pm b/src/perl/lib/OpenSRF/Transport/SlimJabber/Inbound.pm similarity index 100% rename from src/perlmods/OpenSRF/Transport/SlimJabber/Inbound.pm rename to src/perl/lib/OpenSRF/Transport/SlimJabber/Inbound.pm diff --git a/src/perlmods/OpenSRF/Transport/SlimJabber/MessageWrapper.pm b/src/perl/lib/OpenSRF/Transport/SlimJabber/MessageWrapper.pm similarity index 100% rename from src/perlmods/OpenSRF/Transport/SlimJabber/MessageWrapper.pm rename to src/perl/lib/OpenSRF/Transport/SlimJabber/MessageWrapper.pm diff --git a/src/perlmods/OpenSRF/Transport/SlimJabber/PeerConnection.pm b/src/perl/lib/OpenSRF/Transport/SlimJabber/PeerConnection.pm similarity index 100% rename from src/perlmods/OpenSRF/Transport/SlimJabber/PeerConnection.pm rename to src/perl/lib/OpenSRF/Transport/SlimJabber/PeerConnection.pm diff --git a/src/perlmods/OpenSRF/Transport/SlimJabber/XMPPMessage.pm b/src/perl/lib/OpenSRF/Transport/SlimJabber/XMPPMessage.pm similarity index 100% rename from src/perlmods/OpenSRF/Transport/SlimJabber/XMPPMessage.pm rename to src/perl/lib/OpenSRF/Transport/SlimJabber/XMPPMessage.pm diff --git a/src/perlmods/OpenSRF/Transport/SlimJabber/XMPPReader.pm b/src/perl/lib/OpenSRF/Transport/SlimJabber/XMPPReader.pm similarity index 100% rename from src/perlmods/OpenSRF/Transport/SlimJabber/XMPPReader.pm rename to src/perl/lib/OpenSRF/Transport/SlimJabber/XMPPReader.pm diff --git a/src/perlmods/OpenSRF/UnixServer.pm b/src/perl/lib/OpenSRF/UnixServer.pm similarity index 100% rename from src/perlmods/OpenSRF/UnixServer.pm rename to src/perl/lib/OpenSRF/UnixServer.pm diff --git a/src/perlmods/OpenSRF/Utils.pm b/src/perl/lib/OpenSRF/Utils.pm similarity index 100% rename from src/perlmods/OpenSRF/Utils.pm rename to src/perl/lib/OpenSRF/Utils.pm diff --git a/src/perlmods/OpenSRF/Utils/Cache.pm b/src/perl/lib/OpenSRF/Utils/Cache.pm similarity index 88% rename from src/perlmods/OpenSRF/Utils/Cache.pm rename to src/perl/lib/OpenSRF/Utils/Cache.pm index 635a2b3..20f76df 100644 --- a/src/perlmods/OpenSRF/Utils/Cache.pm +++ b/src/perl/lib/OpenSRF/Utils/Cache.pm @@ -10,7 +10,11 @@ use OpenSRF::Utils::JSON; my $log = 'OpenSRF::Utils::Logger'; -=head OpenSRF::Utils::Cache +=head1 NAME + +OpenSRF::Utils::Cache + +=head1 SYNOPSIS This class just subclasses Cache::Memcached. see Cache::Memcached for more options. @@ -41,18 +45,24 @@ my $persist_slot_get_expire; my $persist_slot_find; my $max_persist_time; -my $persist_add_slot_name = "opensrf.persist.slot.create_expirable"; -my $persist_push_stack_name = "opensrf.persist.stack.push"; -my $persist_peek_stack_name = "opensrf.persist.stack.peek"; -my $persist_destroy_slot_name = "opensrf.persist.slot.destroy"; +my $persist_add_slot_name = "opensrf.persist.slot.create_expirable"; +my $persist_push_stack_name = "opensrf.persist.stack.push"; +my $persist_peek_stack_name = "opensrf.persist.stack.peek"; +my $persist_destroy_slot_name = "opensrf.persist.slot.destroy"; my $persist_slot_get_expire_name = "opensrf.persist.slot.get_expire"; -my $persist_slot_find_name = "opensrf.persist.slot.find";; +my $persist_slot_find_name = "opensrf.persist.slot.find";; # ------------------------------------------------------ +=head1 METHODS + +=head2 current + +Return a named cache if it exists + +=cut -# return a named cache if it exists -sub current { +sub current { my ( $class, $c_type ) = @_; return undef unless $c_type; return $caches{$c_type} if exists $caches{$c_type}; @@ -60,23 +70,25 @@ sub current { } -# create a new named memcache object. +=head2 new + +Create a new named memcache object. + +=cut + sub new { my( $class, $cache_type, $persist ) = @_; $cache_type ||= 'global'; $class = ref( $class ) || $class; - return $caches{$cache_type} - if (defined $caches{$cache_type}); + return $caches{$cache_type} if (defined $caches{$cache_type}); my $conf = OpenSRF::Utils::SettingsClient->new; my $servers = $conf->config_value( cache => $cache_type => servers => 'server' ); $max_persist_time = $conf->config_value( cache => $cache_type => 'max_cache_time' ); - if(!ref($servers)){ - $servers = [ $servers ]; - } + $servers = [ $servers ] if(!ref($servers)) my $self = {}; $self->{persist} = $persist || 0; @@ -91,6 +103,9 @@ sub new { } +=head2 put_cache + +=cut sub put_cache { my($self, $key, $value, $expiretime ) = @_; @@ -133,6 +148,11 @@ sub put_cache { return $key; } + +=head2 delete_cache + +=cut + sub delete_cache { my( $self, $key ) = @_; if(!$key) { return undef; } @@ -144,6 +164,11 @@ sub delete_cache { return $key; } + +=head2 get_cache + +=cut + sub get_cache { my($self, $key ) = @_; @@ -163,13 +188,15 @@ sub get_cache { $self->{memcache}->set( $key, $val, $max_persist_time); } return OpenSRF::Utils::JSON->JSON2perl($val); - } + } } return undef; -} +} +=head2 _load_methods +=cut sub _load_methods { diff --git a/src/perlmods/OpenSRF/Utils/Config.pm b/src/perl/lib/OpenSRF/Utils/Config.pm similarity index 86% rename from src/perlmods/OpenSRF/Utils/Config.pm rename to src/perl/lib/OpenSRF/Utils/Config.pm index b01cad2..ca400f7 100755 --- a/src/perlmods/OpenSRF/Utils/Config.pm +++ b/src/perl/lib/OpenSRF/Utils/Config.pm @@ -112,7 +112,6 @@ OpenSRF::Utils::Config =head1 SYNOPSIS - use OpenSRF::Utils::Config; my $config_obj = OpenSRF::Utils::Config->load( config_file => '/config/file.cnf' ); @@ -125,23 +124,24 @@ OpenSRF::Utils::Config print FH $config_obj; close FH; - - =head1 DESCRIPTION - -This module is mainly used by other OpenSRF modules to load an OpenSRF configuration file. -OpenSRF configuration files are XML files that contain a C<< >> root element and an C<< >> -child element (in XPath notation, C). Each child element is converted into a -hash key=>value pair. Elements that contain other XML elements are pushed into arrays and added -as an array reference to the hash. Scalar values have whitespace trimmed from the left and right -sides. +This module is mainly used by other OpenSRF modules to load an OpenSRF +configuration file. OpenSRF configuration files are XML files that +contain a C<< >> root element and an C<< >> child +element (in XPath notation, C). Each child element +is converted into a hash key=>value pair. Elements that contain other +XML elements are pushed into arrays and added as an array reference to +the hash. Scalar values have whitespace trimmed from the left and +right sides. -Child elements of C<< >> other than C<< >> are currently ignored by this module. +Child elements of C<< >> other than C<< >> are +currently ignored by this module. =head1 EXAMPLE - -Given an OpenSRF configuration file named F with the following content: + +Given an OpenSRF configuration file named F with the +following content: @@ -153,32 +153,38 @@ Given an OpenSRF configuration file named F with the following otherhost - LOCALSTATEDIR/log/osrfsys.log + /var/log/osrfsys.log -... calling C<< OpenSRF::Utils::Config->load(config_file => 'opensrf_core.xml') >> will create a hash -with the following structure: +... calling C<< OpenSRF::Utils::Config->load(config_file => +'opensrf_core.xml') >> will create a hash with the following +structure: { router_name => 'router', routers => ['localhost', 'otherhost'], - logfile => 'LOCALSTATEDIR/log/osrfsys.log' + logfile => '/var/log/osrfsys.log' } -You can retrieve any of these values by name from the bootstrap section of C<$config_obj>; for example: +You can retrieve any of these values by name from the bootstrap +section of C<$config_obj>; for example: $config_obj->bootstrap->router_name =head1 NOTES -For compatibility with a previous version of OpenSRF configuration files, the F section -has a hardcoded name of B. However, future iterations of this module may extend the ability -of the module to parse the entire OpenSRF configuration file and provide sections named after the sibling -elements of C. +For compatibility with a previous version of OpenSRF configuration +files, the F section has a hardcoded name of +B. However, future iterations of this module may extend the +ability of the module to parse the entire OpenSRF configuration file +and provide sections named after the sibling elements of +C. -Hashrefs of sections can be returned by calling a method of the object of the same name as the section. -They can be set by passing a hashref back to the same method. Sections will B be autovivicated, though. +Hashrefs of sections can be returned by calling a method of the object +of the same name as the section. They can be set by passing a hashref +back to the same method. Sections will B be autovivicated, +though. =head1 METHODS @@ -192,10 +198,10 @@ $VERSION = do { my @r=(q$Revision$=~/\d+/g); sprintf "%d."."%02d"x$#r,@r }; =head2 OpenSRF::Utils::Config->load( config_file => '/some/config/file.cnf' ) -Returns a OpenSRF::Utils::Config object representing the config file that was loaded. -The most recently loaded config file (hopefully the only one per app) -is stored at $OpenSRF::Utils::ConfigCache. Use OpenSRF::Utils::Config::current() to get at it. - +Returns a OpenSRF::Utils::Config object representing the config file +that was loaded. The most recently loaded config file (hopefully the +only one per app) is stored at $OpenSRF::Utils::ConfigCache. Use +OpenSRF::Utils::Config::current() to get at it. =cut diff --git a/src/perlmods/OpenSRF/Utils/JSON.pm b/src/perl/lib/OpenSRF/Utils/JSON.pm similarity index 100% rename from src/perlmods/OpenSRF/Utils/JSON.pm rename to src/perl/lib/OpenSRF/Utils/JSON.pm diff --git a/src/perlmods/OpenSRF/Utils/LogServer.pm b/src/perl/lib/OpenSRF/Utils/LogServer.pm similarity index 100% rename from src/perlmods/OpenSRF/Utils/LogServer.pm rename to src/perl/lib/OpenSRF/Utils/LogServer.pm diff --git a/src/perlmods/OpenSRF/Utils/Logger.pm b/src/perl/lib/OpenSRF/Utils/Logger.pm similarity index 100% rename from src/perlmods/OpenSRF/Utils/Logger.pm rename to src/perl/lib/OpenSRF/Utils/Logger.pm diff --git a/src/perlmods/OpenSRF/Utils/SettingsClient.pm b/src/perl/lib/OpenSRF/Utils/SettingsClient.pm similarity index 100% rename from src/perlmods/OpenSRF/Utils/SettingsClient.pm rename to src/perl/lib/OpenSRF/Utils/SettingsClient.pm diff --git a/src/perlmods/OpenSRF/Utils/SettingsParser.pm b/src/perl/lib/OpenSRF/Utils/SettingsParser.pm similarity index 100% rename from src/perlmods/OpenSRF/Utils/SettingsParser.pm rename to src/perl/lib/OpenSRF/Utils/SettingsParser.pm diff --git a/src/perl/t/00-load.t b/src/perl/t/00-load.t new file mode 100644 index 0000000..c30401f --- /dev/null +++ b/src/perl/t/00-load.t @@ -0,0 +1,9 @@ +#!perl -T + +use Test::More tests => 1; + +BEGIN { + use_ok( 'OpenSRF' ); +} + +diag( "Testing OpenSRF $OpenSRF::VERSION, Perl $], $^X" ); diff --git a/src/perl/t/pod-coverage.t b/src/perl/t/pod-coverage.t new file mode 100644 index 0000000..5844b85 --- /dev/null +++ b/src/perl/t/pod-coverage.t @@ -0,0 +1,21 @@ +use strict; +use warnings; +use Test::More tests => 1; + +# FIXME SKIPPING POD COVERAGE TESTS FOR NOW +ok(1);exit; + +# Ensure a recent version of Test::Pod::Coverage +my $min_tpc = 1.08; +eval "use Test::Pod::Coverage $min_tpc"; +plan skip_all => "Test::Pod::Coverage $min_tpc required for testing POD coverage" + if $@; + +# Test::Pod::Coverage doesn't require a minimum Pod::Coverage version, +# but older versions don't recognize some common documentation styles +my $min_pc = 0.18; +eval "use Pod::Coverage $min_pc"; +plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage" + if $@; + +all_pod_coverage_ok(); diff --git a/src/perl/t/pod.t b/src/perl/t/pod.t new file mode 100644 index 0000000..ee8b18a --- /dev/null +++ b/src/perl/t/pod.t @@ -0,0 +1,12 @@ +#!perl -T + +use strict; +use warnings; +use Test::More; + +# Ensure a recent version of Test::Pod +my $min_tp = 1.22; +eval "use Test::Pod $min_tp"; +plan skip_all => "Test::Pod $min_tp required for testing POD" if $@; + +all_pod_files_ok(); diff --git a/src/perlmods/OpenSRF/Transport/Jabber.pm b/src/perlmods/OpenSRF/Transport/Jabber.pm deleted file mode 100644 index 3b45ac5..0000000 --- a/src/perlmods/OpenSRF/Transport/Jabber.pm +++ /dev/null @@ -1,11 +0,0 @@ -package OpenSRF::Transport::Jabber; -use base qw/OpenSRF::Transport/; - - -sub get_listener { return "OpenSRF::Transport::Jabber::JInbound"; } - -sub get_peer_client { return "OpenSRF::Transport::Jabber::JPeerConnection"; } - -sub get_msg_envelope { return "OpenSRF::Transport::Jabber::JMessageWrapper"; } - -1; diff --git a/src/perlmods/OpenSRF/Transport/Jabber/JInbound.pm b/src/perlmods/OpenSRF/Transport/Jabber/JInbound.pm deleted file mode 100644 index a381274..0000000 --- a/src/perlmods/OpenSRF/Transport/Jabber/JInbound.pm +++ /dev/null @@ -1,101 +0,0 @@ -package OpenSRF::Transport::Jabber::JInbound; -use strict;use warnings; -use base qw/OpenSRF::Transport::Jabber::JabberClient/; -use OpenSRF::EX; -use OpenSRF::Utils::Config; -use OpenSRF::Utils::Logger qw(:level); - -my $logger = "OpenSRF::Utils::Logger"; - -=head1 Description - -This is the jabber connection where all incoming client requests will be accepted. -This connection takes the data, passes it off to the system then returns to take -more data. Connection params are all taken from the config file and the values -retreived are based on the $app name passed into new(). - -This service should be loaded at system startup. - -=cut - -# XXX This will be overhauled to connect as a component instead of as -# a user. all in good time, though. - -{ - my $unix_sock; - sub unix_sock { return $unix_sock; } - my $instance; - - sub new { - my( $class, $app ) = @_; - $class = ref( $class ) || $class; - if( ! $instance ) { - my $app_state = $app . "_inbound"; - my $config = OpenSRF::Utils::Config->current; - - if( ! $config ) { - throw OpenSRF::EX::Jabber( "No suitable config found" ); - } - - my $host = $config->transport->server->primary; - my $username = $config->transport->users->$app; - my $password = $config->transport->auth->password; - my $debug = $config->transport->llevel->$app_state; - my $log = $config->transport->log->$app_state; - my $resource = "system"; - - - my $self = __PACKAGE__->SUPER::new( - username => $username, - host => $host, - resource => $resource, - password => $password, - log_file => $log, - debug => $debug, - ); - - - my $f = $config->dirs->sock_dir; - $unix_sock = join( "/", $f, $config->unix_sock->$app ); - bless( $self, $class ); - $instance = $self; - } - $instance->SetCallBacks( message => \&handle_message ); - return $instance; - } - -} - -# --- -# All incoming messages are passed untouched to the Unix Server for processing. The -# Unix socket is closed by the Unix Server as soon as it has received all of the -# data. This means we can go back to accepting more incoming connection. -# ----- -sub handle_message { - my $sid = shift; - my $message = shift; - - my $packet = $message->GetXML(); - - $logger->transport( "JInbound $$ received $packet", INTERNAL ); - - # Send the packet to the unix socket for processing. - my $sock = unix_sock(); - my $socket; - my $x = 0; - for( ;$x != 5; $x++ ) { #try 5 times - if( $socket = IO::Socket::UNIX->new( Peer => $sock ) ) { - last; - } - } - if( $x == 5 ) { - throw OpenSRF::EX::Socket( - "Unable to connect to UnixServer: socket-file: $sock \n :=> $! " ); - } - print $socket $packet; - close( $socket ); -} - - -1; - diff --git a/src/perlmods/OpenSRF/Transport/Jabber/JMessageWrapper.pm b/src/perlmods/OpenSRF/Transport/Jabber/JMessageWrapper.pm deleted file mode 100644 index 15a6de5..0000000 --- a/src/perlmods/OpenSRF/Transport/Jabber/JMessageWrapper.pm +++ /dev/null @@ -1,91 +0,0 @@ -package OpenSRF::Transport::Jabber::JMessageWrapper; -use Jabber::NodeFactory; -use Net::Jabber qw(Client); -use Net::Jabber::Message; -use base qw/ Net::Jabber::Message OpenSRF /; -use OpenSRF::Utils::Logger qw(:level); -use strict; use warnings; - -=head1 Description - -OpenSRF::Transport::Jabber::JMessageWrapper - -Provides a means to extract information about a Jabber -message when all you have is the raw XML. The API -implemented here should be implemented by any Transport -helper/MessageWrapper class. - -=cut - -sub DESTROY{} - -my $logger = "OpenSRF::Utils::Logger"; -my $_node_factory = Jabber::NodeFactory->new( fromstr => 1 ); - - -=head2 new( Net::Jabber::Message/$raw_xml ) - -Pass in the raw Jabber message as XML and create a new -JMessageWrapper - -=cut - -sub new { - my( $class, $xml ) = @_; - $class = ref( $class ) || $class; - - return undef unless( $xml ); - - my $self; - - if( ref( $xml ) ) { - $self = $xml; - } else { - $logger->transport( "MWrapper got: " . $xml, INTERNAL ); - my $node = $_node_factory->newNodeFromStr( $xml ); - $self = $class->SUPER::new(); - $self->SetFrom( $node->attr('from') ); - $self->SetThread( $node->getTag('thread')->data ); - $self->SetBody( $node->getTag('body')->data ); - } - - bless( $self, $class ); - - $logger->transport( "MessageWrapper $self after blessing", INTERNAL ); - - return $self; - -} - -=head2 get_remote_id - -Returns the JID (user@host/resource) of the remote user - -=cut -sub get_remote_id { - my( $self ) = @_; - return $self->GetFrom(); -} - -=head2 get_sess_id - -Returns the Jabber thread associated with this message - -=cut -sub get_sess_id { - my( $self ) = @_; - return $self->GetThread(); -} - -=head2 get_body - -Returns the message body of the Jabber message - -=cut -sub get_body { - my( $self ) = @_; - return $self->GetBody(); -} - - -1; diff --git a/src/perlmods/OpenSRF/Transport/Jabber/JPeerConnection.pm b/src/perlmods/OpenSRF/Transport/Jabber/JPeerConnection.pm deleted file mode 100644 index 766de42..0000000 --- a/src/perlmods/OpenSRF/Transport/Jabber/JPeerConnection.pm +++ /dev/null @@ -1,80 +0,0 @@ -package OpenSRF::Transport::Jabber::JPeerConnection; -use strict; -use base qw/OpenSRF::Transport::Jabber::JabberClient/; -use OpenSRF::Utils::Config; -use OpenSRF::Utils::Logger qw(:level); - -=head1 Description - -Represents a single connection to a remote peer. The -Jabber values are loaded from the config file. - -Subclasses OpenSRF::Transport::JabberClient. - -=cut - -=head2 new() - - new( $appname ); - - The $appname parameter tells this class how to find the correct - Jabber username, password, etc to connect to the server. - -=cut - -our $main_instance; -our %apps_hash; - -sub retrieve { - my( $class, $app ) = @_; - my @keys = keys %apps_hash; - OpenSRF::Utils::Logger->transport( - "Requesting peer for $app and we have @keys", INTERNAL ); - return $apps_hash{$app}; -} - - - -sub new { - my( $class, $app ) = @_; - my $config = OpenSRF::Utils::Config->current; - - if( ! $config ) { - throw OpenSRF::EX::Config( "No suitable config found" ); - } - - my $app_stat = $app . "_peer"; - my $host = $config->transport->server->primary; - my $username = $config->transport->users->$app; - my $password = $config->transport->auth->password; - my $debug = $config->transport->llevel->$app_stat; - my $log = $config->transport->log->$app_stat; - my $resource = $config->env->hostname . "_$$"; - - OpenSRF::EX::Config->throw( "JPeer could not load all necesarry values from config" ) - unless ( $host and $username and $password and $resource ); - - - my $self = __PACKAGE__->SUPER::new( - username => $username, - host => $host, - resource => $resource, - password => $password, - log_file => $log, - debug => $debug, - ); - - bless( $self, $class ); - - $self->SetCallBacks( message => sub { - my $msg = $_[1]; - OpenSRF::Utils::Logger->transport( - "JPeer passing \n$msg \n to Transport->handler for $app", INTERNAL ); - OpenSRF::Transport->handler( $app, $msg ); } ); - - $apps_hash{$app} = $self; - return $apps_hash{$app}; -} - -1; - diff --git a/src/perlmods/OpenSRF/Transport/Jabber/JabberClient.pm b/src/perlmods/OpenSRF/Transport/Jabber/JabberClient.pm deleted file mode 100644 index 50eb6ae..0000000 --- a/src/perlmods/OpenSRF/Transport/Jabber/JabberClient.pm +++ /dev/null @@ -1,277 +0,0 @@ -package OpenSRF::Transport::Jabber::JabberClient; -use strict; use warnings; -use OpenSRF::EX; -use Net::Jabber qw( Client ); -use base qw( OpenSRF Net::Jabber::Client ); -use OpenSRF::Utils::Logger qw(:level); - -=head1 Description - -OpenSRF::Transport::Jabber::JabberClient - -Subclasses Net::Jabber::Client and, hence, provides the same -functionality. What it provides in addition is mainly some logging -and exception throwing on the call to 'initialize()', which sets -up the connection and authentication. - -=cut - -my $logger = "OpenSRF::Utils::Logger"; - -sub DESTROY{}; - - -=head2 new() - -Creates a new JabberClient object. The parameters should be self explanatory. -If not, see Net::Jabber::Client for more. - -debug and log_file are not required if you don't care to log the activity, -however all other parameters are. - -%params: - - host - username - resource - password - debug - log_file - -=cut - -sub new { - - my( $class, %params ) = @_; - - $class = ref( $class ) || $class; - - my $host = $params{'host'} || return undef; - my $username = $params{'username'} || return undef; - my $resource = $params{'resource'} || return undef; - my $password = $params{'password'} || return undef; - my $debug = $params{'debug'}; - my $log_file = $params{'log_file'}; - - my $self; - - if( $debug and $log_file ) { - $self = Net::Jabber::Client->new( - debuglevel => $debug, debugfile => $log_file ); - } - else { $self = Net::Jabber::Client->new(); } - - bless( $self, $class ); - - $self->host( $host ); - $self->username( $username ); - $self->resource( $resource ); - $self->password( $password ); - - $logger->transport( "Creating Jabber instance: $host, $username, $resource", - $logger->INFO ); - - $self->SetCallBacks( send => - sub { $logger->transport( "JabberClient in 'send' callback: @_", INTERNAL ); } ); - - - return $self; -} - -# ------------------------------------------------- - -=head2 gather() - -Gathers all Jabber messages sitting in the collection queue -and hands them each to their respective callbacks. This call -does not block (calls Process(0)) - -=cut - -sub gather { my $self = shift; $self->Process( 0 ); } - -# ------------------------------------------------- - -=head2 listen() - -Blocks and gathers incoming messages as they arrive. Does not return -unless an error occurs. - -Throws an OpenSRF::EX::JabberException if the call to Process ever fails. - -=cut -sub listen { - my $self = shift; - while(1) { - my $o = $self->process( -1 ); - if( ! defined( $o ) ) { - throw OpenSRF::EX::Jabber( "Listen Loop failed at 'Process()'" ); - } - } -} - -# ------------------------------------------------- - -sub password { - my( $self, $password ) = @_; - $self->{'oils:password'} = $password if $password; - return $self->{'oils:password'}; -} - -# ------------------------------------------------- - -sub username { - my( $self, $username ) = @_; - $self->{'oils:username'} = $username if $username; - return $self->{'oils:username'}; -} - -# ------------------------------------------------- - -sub resource { - my( $self, $resource ) = @_; - $self->{'oils:resource'} = $resource if $resource; - return $self->{'oils:resource'}; -} - -# ------------------------------------------------- - -sub host { - my( $self, $host ) = @_; - $self->{'oils:host'} = $host if $host; - return $self->{'oils:host'}; -} - -# ------------------------------------------------- - -=head2 send() - - Sends a Jabber message. - - %params: - to - The JID of the recipient - thread - The Jabber thread - body - The body of the message - -=cut - -sub send { - my( $self, %params ) = @_; - - my $to = $params{'to'} || return undef; - my $body = $params{'body'} || return undef; - my $thread = $params{'thread'}; - - my $msg = Net::Jabber::Message->new(); - - $msg->SetTo( $to ); - $msg->SetThread( $thread ) if $thread; - $msg->SetBody( $body ); - - $logger->transport( - "JabberClient Sending message to $to with thread $thread and body: \n$body", INTERNAL ); - - $self->Send( $msg ); -} - - -=head2 inintialize() - -Connect to the server and log in. - -Throws an OpenSRF::EX::JabberException if we cannot connect -to the server or if the authentication fails. - -=cut - -# --- The logging lines have been commented out until we decide -# on which log files we're using. - -sub initialize { - - my $self = shift; - - my $host = $self->host; - my $username = $self->username; - my $resource = $self->resource; - my $password = $self->password; - - my $jid = "$username\@$host\/$resource"; - - # --- 5 tries to connect to the jabber server - my $x = 0; - for( ; $x != 5; $x++ ) { - $logger->transport( "$jid: Attempting to connecto to server...$x", WARN ); - if( $self->Connect( 'hostname' => $host ) ) { - last; - } - else { sleep 3; } - } - - if( $x == 5 ) { - die "could not connect to server $!\n"; - throw OpenSRF::EX::Jabber( " Could not connect to Jabber server" ); - } - - $logger->transport( "Logging into jabber as $jid " . - "from " . ref( $self ), DEBUG ); - - # --- Log in - my @a = $self->AuthSend( 'username' => $username, - 'password' => $password, 'resource' => $resource ); - - if( $a[0] eq "ok" ) { - $logger->transport( " * $jid: Jabber authenticated and connected", DEBUG ); - } - else { - throw OpenSRF::EX::Jabber( " * $jid: Unable to authenticate: @a" ); - } - - return $self; -} - -sub construct { - my( $class, $app ) = @_; - $logger->transport("Constructing new Jabber connection for $app", INTERNAL ); - $class->peer_handle( - $class->new( $app )->initialize() ); -} - -sub process { - - my( $self, $timeout ) = @_; - if( ! $timeout ) { $timeout = 0; } - - unless( $self->Connected() ) { - OpenSRF::EX::Jabber->throw( - "This JabberClient instance is no longer connected to the server", ERROR ); - } - - my $val; - - if( $timeout eq "-1" ) { - $val = $self->Process(); - } - else { $val = $self->Process( $timeout ); } - - if( $timeout eq "-1" ) { $timeout = " "; } - - if( ! defined( $val ) ) { - OpenSRF::EX::Jabber->throw( - "Call to Net::Jabber::Client->Process( $timeout ) failed", ERROR ); - } - elsif( ! $val ) { - $logger->transport( - "Call to Net::Jabber::Client->Process( $timeout ) returned 0 bytes of data", DEBUG ); - } - elsif( $val ) { - $logger->transport( - "Call to Net::Jabber::Client->Process( $timeout ) successfully returned data", INTERNAL ); - } - - return $val; - -} - - -1; -- 2.43.2