WWW-OpenSearch-0.17/0000755000175000017500000000000012076325306013446 5ustar bricasbricasWWW-OpenSearch-0.17/Changes0000644000175000017500000000506712076324646014757 0ustar bricasbricasRevision history for Perl extension WWW::OpenSearch 0.17 2013-01-18 - Avoid hash randomization problem in test (RT #82796) 0.16 2010-05-25 - Fix tests for Test::More 0.95_02 0.15 2009-11-19 - repackaged with a new version of Module::Install 0.14 2008-04-17 - Handle broken LWP 5.810 in Makefile.PL 0.13 2007-12-21 - Fix pod coverage (Ian Beckwith) 0.12 2007-05-01 - switch from ||= to a "defined" idiom for some params - switch to Module::Install 0.11 2007-04-17 - added a simple OSD parsing test 0.10_02 2007-01-23 - fix Request.pm to clone the extra attributes we've added (Marc Tobias) 0.10_01 2007-01-22 - use URI::Template for parsing OSD uri templates - added opensearch-specific Request and Agent classes - un-break get_best_url() - you can now pass a WWW::OpenSearch::Url to WWW::OpenSearch's search() method - added ns() (namespace) field to Url.pm - re-worked paging to use the new Request object [THINGS THAT MAY BREAK YOUR CODE] - using URI::Template means some methods are now proxied to that class - removed agent argument in new() in OpenSearch.pm - handling of POST requests in prepare_query() in Url.pm now returns data suitable for passing to HTTP::Request - un-link Response.pm and the parent WWW::OpenSearch object -- a Response is now in the context of whatever WWW::OpenSearch::Url was used 0.09 2006-12-07 - fix link fetching from atom feeds 0.08 2006-09-13 - fix optional attributes for Image - added strict to Url object 0.07 2006-09-11 - inflate query and image fields to objects for OSD 1.1 - pod updates 0.06_02 2006-07-20 - added tests - updated available description info - try to handle POST urls better - update XML::Atom calls to latest release API - added option to override the useragent from new() - fix undef warning - turn utf8 flag off for queries 0.06_01 2006-05-18 - Complete re-write to handle OpenSearch 1.1/Atom - Now uses XML::Feed to abstract RSS and Atom - Improved OpenSearch Description/Url handling - Encapsulate returns in a Response object 0.05 2006-01-09 - Added partial support of OpenSearch 1.1. There's no API change and old elements just work as before, with 1.1 OpenSearch document as well. See http://opensearch.a9.com/docs/upgrading10.jsp (Thanks to Masaaki Hirose) 0.04 2005-07-29 - Drop off XML::Simple for efficiency. LibXMLify everything. Now you need XML::RSS::LibXML 0.03 2005-07-24 - Hacked current_page so you can specify page number correctly (Thanks to Naoya Ito) 0.02 2005-03-26 - Added accessors for attributes - Fixed POD 0.01 2005-03-17 - original version WWW-OpenSearch-0.17/Makefile.PL0000644000175000017500000000114212076324765015426 0ustar bricasbricasuse inc::Module::Install 1.00; if ( -e 'MANIFEST.SKIP' ) { system( 'pod2text lib/WWW/OpenSearch.pm > README' ); } perl_version '5.008001'; name 'WWW-OpenSearch'; all_from 'lib/WWW/OpenSearch.pm'; # handle broken LWP 5.810 my $broken_lwp = eval { require LWP; LWP->VERSION eq '5.810'; }; requires 'Data::Page' => 2.00; requires 'LWP' => ( $broken_lwp ? '5.811' : '5.60' ); requires 'XML::Feed' => 0.08; requires 'XML::LibXML' => 1.58; requires 'Encode'; requires 'URI'; requires 'URI::Template'; test_requires 'Test::More'; repository 'http://github.com/bricas/www-opensearch'; WriteAll; WWW-OpenSearch-0.17/inc/0000755000175000017500000000000012076325306014217 5ustar bricasbricasWWW-OpenSearch-0.17/inc/Module/0000755000175000017500000000000012076325306015444 5ustar bricasbricasWWW-OpenSearch-0.17/inc/Module/Install.pm0000644000175000017500000003013512076325126017412 0ustar bricasbricas#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.005; 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.06'; # 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::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; } 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::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) = @_; 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 //, $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]): $!"; my $string = do { local $/; }; close FH or die "close($_[0]): $!"; return $string; } END_NEW sub _read { local *FH; open( FH, "< $_[0]" ) or die "open($_[0]): $!"; my $string = do { local $/; }; 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]): $!"; 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]): $!"; 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. WWW-OpenSearch-0.17/inc/Module/Install/0000755000175000017500000000000012076325306017052 5ustar bricasbricasWWW-OpenSearch-0.17/inc/Module/Install/Can.pm0000644000175000017500000000615712076325127020123 0ustar bricasbricas#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.06'; @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 WWW-OpenSearch-0.17/inc/Module/Install/Makefile.pm0000644000175000017500000002743712076325127021143 0ustar bricasbricas#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.06'; @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-seperated 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 =~ 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 WWW-OpenSearch-0.17/inc/Module/Install/Base.pm0000644000175000017500000000214712076325127020267 0ustar bricasbricas#line 1 package Module::Install::Base; use strict 'vars'; use vars qw{$VERSION}; BEGIN { $VERSION = '1.06'; } # 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 WWW-OpenSearch-0.17/inc/Module/Install/Win32.pm0000644000175000017500000000340312076325127020313 0ustar bricasbricas#line 1 package Module::Install::Win32; use strict; use Module::Install::Base (); use vars qw{$VERSION @ISA $ISCORE}; BEGIN { $VERSION = '1.06'; @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; WWW-OpenSearch-0.17/inc/Module/Install/Fetch.pm0000644000175000017500000000462712076325127020453 0ustar bricasbricas#line 1 package Module::Install::Fetch; use strict; use Module::Install::Base (); use vars qw{$VERSION @ISA $ISCORE}; BEGIN { $VERSION = '1.06'; @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@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; WWW-OpenSearch-0.17/inc/Module/Install/WriteAll.pm0000644000175000017500000000237612076325127021144 0ustar bricasbricas#line 1 package Module::Install::WriteAll; use strict; use Module::Install::Base (); use vars qw{$VERSION @ISA $ISCORE}; BEGIN { $VERSION = '1.06'; @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; WWW-OpenSearch-0.17/inc/Module/Install/Metadata.pm0000644000175000017500000004327712076325127021146 0ustar bricasbricas#line 1 package Module::Install::Metadata; use strict 'vars'; use Module::Install::Base (); use vars qw{$VERSION @ISA $ISCORE}; BEGIN { $VERSION = '1.06'; @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}{<}g; $author =~ s{E}{>}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 hashs 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; WWW-OpenSearch-0.17/META.yml0000644000175000017500000000131212076325127014715 0ustar bricasbricas--- abstract: 'Search A9 OpenSearch compatible engines' author: - 'Brian Cassidy ' build_requires: ExtUtils::MakeMaker: 6.59 Test::More: 0 configure_requires: ExtUtils::MakeMaker: 6.59 distribution_type: module dynamic_config: 1 generated_by: 'Module::Install version 1.06' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 name: WWW-OpenSearch no_index: directory: - inc - t requires: Data::Page: 2 Encode: 0 LWP: 5.60 URI: 0 URI::Template: 0 XML::Feed: 0.08 XML::LibXML: 1.58 perl: 5.8.1 resources: license: http://dev.perl.org/licenses/ repository: http://github.com/bricas/www-opensearch version: 0.17 WWW-OpenSearch-0.17/README0000644000175000017500000000417212076325127014333 0ustar bricasbricasNAME WWW::OpenSearch - Search A9 OpenSearch compatible engines SYNOPSIS use WWW::OpenSearch; my $url = "http://bulkfeeds.net/opensearch.xml"; my $engine = WWW::OpenSearch->new($url); my $name = $engine->description->ShortName; my $tags = $engine->description->Tags; # Perform search for "iPod" my $response = $engine->search("iPod"); for my $item (@{$response->feed->items}) { print $item->{description}; } # Retrieve the next page of results my $next_page = $response->next_page; for my $item (@{$next_page->feed->items}) { print $item->{description}; } DESCRIPTION WWW::OpenSearch is a module to search A9's OpenSearch compatible search engines. See http://opensearch.a9.com/ for details. CONSTRUCTOR new( $url ) Constructs a new instance of WWW::OpenSearch using the given URL as the location of the engine's OpenSearch Description document (retrievable via the description_url accessor). METHODS fetch_description( [ $url ] ) Fetches the OpenSearch Descsription found either at the given URL or at the URL specified by the description_url accessor. Fetched description may be accessed via the description accessor. search( $query [, \%params] ) Searches the engine for the given query using the given search parameters. Valid search parameters include: * startPage * totalResults * startIndex * itemsPerPage See http://opensearch.a9.com/spec/1.1/response/#elements for details. do_search( $url [, $method] ) Performs a request for the given URL and returns a WWW::OpenSearch::Response object. Method defaults to 'GET'. ACCESSORS description_url( [$description_url] ) agent( [$agent] ) description( [$description] ) AUTHOR Brian Cassidy Tatsuhiko Miyagawa COPYRIGHT AND LICENSE Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. WWW-OpenSearch-0.17/t/0000755000175000017500000000000012076325306013711 5ustar bricasbricasWWW-OpenSearch-0.17/t/13-request.t0000644000175000017500000000330012076271172016004 0ustar bricasbricasuse Test::More tests => 9; use strict; use warnings; use_ok( 'WWW::OpenSearch::Description' ); use_ok( 'WWW::OpenSearch::Request' ); { my $description = q( ); my $osd = WWW::OpenSearch::Description->new( $description ); { my $req = WWW::OpenSearch::Request->new( $osd->url->[ 2 ], { searchTerms => 'iPod' } ); isa_ok( $req, 'WWW::OpenSearch::Request' ); is( lc $req->method, 'post', 'method' ); is( $req->uri, 'https://intranet/search?format=html', 'uri' ); is( _sort_result( $req->content ), 'c=&l=*&o=1&s=iPod', 'content' ); } { my $req = WWW::OpenSearch::Request->new( $osd->url->[ 1 ], { searchTerms => 'iPod' } ); isa_ok( $req, 'WWW::OpenSearch::Request' ); is( lc $req->method, 'get', 'method' ); is( $req->uri, 'http://example.com/?q=iPod&pw=1&format=atom', 'uri' ); } } sub _sort_result { my $s = shift; return join( '&', sort { substr( $a, 0, 1 ) cmp substr( $b, 0, 1 ) } split( /\&/, $s ) ); } WWW-OpenSearch-0.17/t/12-response.t0000644000175000017500000000013611761435302016152 0ustar bricasbricasuse strict; use warnings; use Test::More tests => 1; use_ok( 'WWW::OpenSearch::Response' ); WWW-OpenSearch-0.17/t/98_pod.t0000644000175000017500000000020111761435302015167 0ustar bricasbricasuse Test::More; eval "use Test::Pod 1.00"; plan skip_all => "Test::Pod 1.00 required for testing POD" if $@; all_pod_files_ok(); WWW-OpenSearch-0.17/t/01_live.t0000644000175000017500000000123011761435302015327 0ustar bricasbricasuse strict; use Test::More; my $url = $ENV{ OPENSEARCH_URL }; unless ( $url ) { Test::More->import( skip_all => "OPENSEARCH_URL not set" ); exit; } # XXX This is not testing, but for debugging :) plan 'no_plan'; use WWW::OpenSearch; my $engine = WWW::OpenSearch->new( $url ); ok $engine; ok $engine->description->shortname, $engine->description->shortname; my $res = $engine->search( "iPod" ); ok $res; ok $res->feed->title, $res->feed->title; ok $res->feed->link, $res->feed->link; ok $res->pager->entries_per_page, "items per page " . $res->pager->entries_per_page; ok $res->pager->total_entries, "total entries " . $res->pager->total_entries; WWW-OpenSearch-0.17/t/09-opensearch.t0000644000175000017500000000031511761435302016450 0ustar bricasbricasuse Test::More tests => 2; use_ok( 'WWW::OpenSearch' ); use URI::file; my $uri = URI::file->new_abs( 't/data/osd.xml' ); my $engine = WWW::OpenSearch->new( $uri ); isa_ok( $engine, 'WWW::OpenSearch' ); WWW-OpenSearch-0.17/t/99_pod_coverage.t0000644000175000017500000000024511761435302017053 0ustar bricasbricasuse Test::More; eval "use Test::Pod::Coverage 1.00"; plan skip_all => "Test::Pod::Coverage 1.00 required for testing POD coverage" if $@; all_pod_coverage_ok(); WWW-OpenSearch-0.17/t/data/0000755000175000017500000000000012076325306014622 5ustar bricasbricasWWW-OpenSearch-0.17/t/data/osd.xml0000644000175000017500000000263011761435302016130 0ustar bricasbricas Web Search Use Example.com to search the Web. example web admin@example.com Example.com Web Search http://example.com/websearch.png http://example.com/websearch.ico Example.com Development Team Search data &copy; 2005, Example.com, Inc., All Rights Reserved open false en-us UTF-8 UTF-8 WWW-OpenSearch-0.17/t/00_compile.t0000644000175000017500000000053411761435302016025 0ustar bricasbricasuse strict; use Test::More tests => 8; BEGIN { use_ok 'WWW::OpenSearch'; use_ok 'WWW::OpenSearch::Description'; use_ok 'WWW::OpenSearch::Response'; use_ok 'WWW::OpenSearch::Url'; use_ok 'WWW::OpenSearch::Query'; use_ok 'WWW::OpenSearch::Image'; use_ok 'WWW::OpenSearch::Agent'; use_ok 'WWW::OpenSearch::Request'; } WWW-OpenSearch-0.17/t/10-description.t0000644000175000017500000001456511761435302016650 0ustar bricasbricasuse strict; use warnings; use Test::More tests => 48; use_ok( 'WWW::OpenSearch::Description' ); # simple 1.1 OSD { my $description = q( Web Search Use Example.com to search the Web. example web admin@example.com ); my $osd = WWW::OpenSearch::Description->new( $description ); isa_ok( $osd, 'WWW::OpenSearch::Description' ); is( $osd->shortname, 'Web Search', 'shortname' ); ok( !defined $osd->longname, 'longname' ); is( $osd->description, 'Use Example.com to search the Web.', 'description' ); is( $osd->tags, 'example web', 'tags' ); is( $osd->contact, 'admin@example.com', 'contact' ); # count the urls is( $osd->urls, 1, 'number of url objects' ); } # complex 1.1 OSD { my $description = q( Web Search Use Example.com to search the Web. example web admin@example.com Example.com Web Search http://example.com/websearch.png http://example.com/websearch.ico Example.com Development Team Search data &copy; 2005, Example.com, Inc., All Rights Reserved open false en-us UTF-8 UTF-8 ); my $osd = WWW::OpenSearch::Description->new( $description ); isa_ok( $osd, 'WWW::OpenSearch::Description' ); is( $osd->shortname, 'Web Search', 'shortname' ); is( $osd->longname, 'Example.com Web Search', 'longname' ); is( $osd->description, 'Use Example.com to search the Web.', 'description' ); is( $osd->tags, 'example web', 'tags' ); is( $osd->contact, 'admin@example.com', 'contact' ); is( $osd->developer, 'Example.com Development Team', 'developer' ); is( $osd->attribution, ' Search data © 2005, Example.com, Inc., All Rights Reserved ', 'attribution' ); is( $osd->inputencoding, 'UTF-8', 'inputencoding' ); is( $osd->outputencoding, 'UTF-8', 'outputencoding' ); is( $osd->language, 'en-us', 'language' ); is( $osd->adultcontent, 'false', 'adultcontent' ); is( $osd->syndicationright, 'open', 'syndicationright' ); my $queries = $osd->query; is( scalar @$queries, 1, 'number of query objects' ); is( $queries->[ 0 ]->role, 'example', 'role' ); is( $queries->[ 0 ]->searchTerms, 'cat', 'searchTerms' ); my $images = $osd->image; is( scalar @$images, 2, 'number of image objects' ); is( $images->[ 0 ]->height, 64, 'height' ); is( $images->[ 0 ]->width, 64, 'width' ); is( $images->[ 0 ]->type, 'image/png', 'content type' ); is( $images->[ 0 ]->url, 'http://example.com/websearch.png', 'url' ); is( $images->[ 1 ]->height, 16, 'height' ); is( $images->[ 1 ]->width, 16, 'width' ); is( $images->[ 1 ]->type, 'image/vnd.microsoft.icon', 'content type' ); is( $images->[ 1 ]->url, 'http://example.com/websearch.ico', 'url' ); # count the urls is( $osd->urls, 3, 'number of url objects' ); } # 1.0 OSD { my $description = q( http://www.unto.net/aws?q={searchTerms}&searchindex=Electronics &flavor=osrss&itempage={startPage} http://a9.com/-/spec/opensearchrss/1.0/ Electronics Amazon Electronics Search for electronics on Amazon.com. amazon electronics http://www.unto.net/search/amazon_electronics.gif ipod DeWitt Clinton dewitt@unto.net Product and search data &copy; 2005, Amazon, Inc., All Rights Reserved open false ); my $osd = WWW::OpenSearch::Description->new( $description ); isa_ok( $osd, 'WWW::OpenSearch::Description' ); is( $osd->shortname, 'Electronics', 'shortname' ); is( $osd->longname, 'Amazon Electronics', 'longname' ); is( $osd->description, 'Search for electronics on Amazon.com.', 'descrpiton' ); is( $osd->tags, 'amazon electronics', 'tags' ); is( $osd->contact, 'dewitt@unto.net', 'contact' ); is( $osd->format, 'http://a9.com/-/spec/opensearchrss/1.0/', 'format' ); is( $osd->image, 'http://www.unto.net/search/amazon_electronics.gif', 'image' ); is( $osd->samplesearch, 'ipod', 'samplesearch' ); is( $osd->developer, 'DeWitt Clinton', 'developer' ); is( $osd->attribution, 'Product and search data © 2005, Amazon, Inc., All Rights Reserved', 'attribution' ); is( $osd->syndicationright, 'open', 'syndicationright' ); is( $osd->adultcontent, 'false', 'adultcontent' ); # count the urls is( $osd->urls, 1, 'urls' ); } WWW-OpenSearch-0.17/t/11-url.t0000644000175000017500000001121111761435302015111 0ustar bricasbricasuse strict; use warnings; use Test::More tests => 36; use_ok( 'WWW::OpenSearch::Description' ); use_ok( 'WWW::OpenSearch::Url' ); { my $description = q( ); my $osd = WWW::OpenSearch::Description->new( $description ); isa_ok( $osd, 'WWW::OpenSearch::Description' ); is( $osd->version, '1.1', 'version' ); is( $osd->ns, 'http://a9.com/-/spec/opensearch/1.1/', 'namespace' ); is( $osd->urls, 1, 'number of urls' ); my ( $url ) = $osd->urls; isa_ok( $url, 'WWW::OpenSearch::Url' ); is( $url->type, 'application/rss+xml', 'content type' ); is( lc $url->method, 'get', 'method' ); is( $url->template->template, 'http://example.com/?q={searchTerms}&pw={startPage}&format=rss', 'template' ); my $result = $url->prepare_query( { searchTerms => 'x', startPage => 1 } ); is( $result, 'http://example.com/?q=x&pw=1&format=rss', 'prepare_query' ); } { my $description = q( ); my $osd = WWW::OpenSearch::Description->new( $description ); isa_ok( $osd, 'WWW::OpenSearch::Description' ); is( $osd->urls, 3, 'number of urls' ); is( $osd->get_best_url, $osd->url->[ 1 ], 'get_best_url' ); { my $url = $osd->url->[ 0 ]; isa_ok( $url, 'WWW::OpenSearch::Url' ); is( $url->type, 'application/rss+xml', 'content type' ); is( lc $url->method, 'get', 'method' ); is( $url->template->template, 'http://example.com/?q={searchTerms}&pw={startPage}&format=rss', 'template' ); } { my $url = $osd->url->[ 1 ]; isa_ok( $url, 'WWW::OpenSearch::Url' ); is( $url->type, 'application/atom+xml', 'content type' ); is( lc $url->method, 'get', 'method' ); is( $url->template->template, 'http://example.com/?q={searchTerms}&pw={startPage}&format=atom', 'template' ); } { my $url = $osd->url->[ 2 ]; isa_ok( $url, 'WWW::OpenSearch::Url' ); is( $url->type, 'text/html', 'content type' ); is( lc $url->method, 'post', 'method' ); is( $url->template->template, 'https://intranet/search?format=html', 'template' ); is_deeply( $url->params, { s => '{searchTerms}', o => '{startIndex}', c => '{itemsPerPage}', l => '{language}' }, 'params' ); my ( $result, $post ) = $url->prepare_query( { searchTerms => 'x', startIndex => '1', itemsPerPage => 1, language => 'en' } ); is( $result, 'https://intranet/search?format=html', 'prepare_query (uri)' ); $post = { @$post }; is_deeply( $post, { s => 'x', o => 1, c => 1, l => 'en' }, 'prepare_query (params)' ); } } { my $description = q( http://www.unto.net/aws?q={searchTerms}&searchindex=Electronics&flavor=osrss&itempage={startPage} ); my $osd = WWW::OpenSearch::Description->new( $description ); isa_ok( $osd, 'WWW::OpenSearch::Description' ); is( $osd->version, '1.0', 'version' ); is( $osd->ns, 'http://a9.com/-/spec/opensearchrss/1.0/', 'namespace' ); is( $osd->urls, 1, 'number of urls' ); my ( $url ) = $osd->urls; isa_ok( $url, 'WWW::OpenSearch::Url' ); is( lc $url->method, 'get', 'method' ); is( $url->template->template, 'http://www.unto.net/aws?q={searchTerms}&searchindex=Electronics&flavor=osrss&itempage={startPage}', 'template' ); } WWW-OpenSearch-0.17/MANIFEST0000644000175000017500000000123512076325262014601 0ustar bricasbricasChanges inc/Module/Install.pm inc/Module/Install/Base.pm inc/Module/Install/Can.pm inc/Module/Install/Fetch.pm inc/Module/Install/Makefile.pm inc/Module/Install/Metadata.pm inc/Module/Install/Win32.pm inc/Module/Install/WriteAll.pm lib/WWW/OpenSearch.pm lib/WWW/OpenSearch/Agent.pm lib/WWW/OpenSearch/Description.pm lib/WWW/OpenSearch/Image.pm lib/WWW/OpenSearch/Query.pm lib/WWW/OpenSearch/Request.pm lib/WWW/OpenSearch/Response.pm lib/WWW/OpenSearch/Url.pm Makefile.PL MANIFEST This list of files META.yml README t/00_compile.t t/01_live.t t/09-opensearch.t t/10-description.t t/11-url.t t/12-response.t t/13-request.t t/98_pod.t t/99_pod_coverage.t t/data/osd.xml WWW-OpenSearch-0.17/lib/0000755000175000017500000000000012076325306014214 5ustar bricasbricasWWW-OpenSearch-0.17/lib/WWW/0000755000175000017500000000000012076325306014700 5ustar bricasbricasWWW-OpenSearch-0.17/lib/WWW/OpenSearch/0000755000175000017500000000000012076325306016727 5ustar bricasbricasWWW-OpenSearch-0.17/lib/WWW/OpenSearch/Description.pm0000644000175000017500000001601612076324725021560 0ustar bricasbricaspackage WWW::OpenSearch::Description; use strict; use warnings; use base qw( Class::Accessor::Fast ); use Carp; use XML::LibXML; use WWW::OpenSearch::Url; use WWW::OpenSearch::Query; use WWW::OpenSearch::Image; my @columns = qw( AdultContent Contact Description Developer Format Image LongName Query SampleSearch ShortName SyndicationRight Tags Url Attribution InputEncoding OutputEncoding Language ); __PACKAGE__->mk_accessors( qw( version ns ), map { lc } @columns ); =head1 NAME WWW::OpenSearch::Description - Encapsulate an OpenSearch Description provided by an A9 OpenSearch compatible engine =head1 SYNOPSIS use WWW::OpenSearch; my $url = "http://bulkfeeds.net/opensearch.xml"; my $engine = WWW::OpenSearch->new($url); my $description = $engine->description; my $format = $description->Format; # or $description->format my $longname = $description->LongName; # or $description->longname =head1 DESCRIPTION WWW::OpenSearch::Description is a module designed to encapsulate an OpenSearch Description provided by an A9 OpenSearch compatible engine. See http://opensearch.a9.com/spec/1.1/description/ for details. =head1 CONSTRUCTOR =head2 new( [ $xml ] ) Constructs a new instance of WWW::OpenSearch::Description. If scalar parameter $xml is provided, data will be automatically loaded from it using load( $xml ). =head1 METHODS =head2 load( $xml ) Loads description data by parsing provided argument using XML::LibXML. =head2 urls( ) Return all of the urls associated with this description in an array. =head2 get_best_url( ) Attempts to retrieve the best URL associated with this description, based on the following content types (from most preferred to least preferred): =over 4 =item * application/atom+xml =item * application/rss+xml =item * text/xml =back =head2 get_url_by_type( $type ) Retrieves the first WWW::OpenSearch::URL associated with this description whose type is equal to $type. =head1 ACCESSORS =head2 version( ) =head2 ns( ) =head2 AdultContent( ) =head2 Attribution( ) =head2 Contact( ) =head2 Description( ) =head2 Developer( ) =head2 Format( ) =head2 InputEncoding( ) =head2 Image( ) =head2 Language( ) =head2 LongName( ) =head2 OutputEncoding( ) =head2 Query( ) =head2 SampleSearch( ) =head2 ShortName( ) =head2 SyndicationRight( ) =head2 Tags( ) =head2 Url( ) =head1 AUTHOR =over 4 =item * Tatsuhiko Miyagawa Emiyagawa@bulknews.netE =item * Brian Cassidy Ebricas@cpan.orgE =back =head1 COPYRIGHT AND LICENSE Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut for ( @columns ) { no strict 'refs'; my $col = lc; *$_ = \&$col; } sub new { my $class = shift; my $xml = shift; my $self = $class->SUPER::new; eval { $self->load( $xml ); } if $xml; if ( $@ ) { croak "Error while parsing Description XML: $@"; } return $self; } sub load { my $self = shift; my $xml = shift; my $parser = XML::LibXML->new; my $doc = $parser->parse_string( $xml ); my $element = $doc->documentElement; my $nodename = $element->nodeName; croak "Node should be OpenSearchDescription: $nodename" if $nodename ne 'OpenSearchDescription'; my $ns = $element->getNamespace->value; my $version; if ( $ns eq 'http://a9.com/-/spec/opensearchdescription/1.0/' ) { $self->ns( 'http://a9.com/-/spec/opensearchrss/1.0/' ); $version = '1.0'; } else { $self->ns( $ns ); ( $version ) = $ns =~ m{([^/]+)/?$}; } $self->version( $version ); for my $column ( @columns ) { my $node = $doc->documentElement->getChildrenByTagName( $column ) or next; if ( $column eq 'Url' ) { if ( $version eq '1.0' ) { $self->Url( [ WWW::OpenSearch::Url->new( template => $node->string_value, type => 'application/rss+xml', ns => $self->ns ) ] ); next; } my @url; for my $urlnode ( $node->get_nodelist ) { my $type = $urlnode->getAttributeNode( 'type' )->value; my $url = $urlnode->getAttributeNode( 'template' )->value; $url =~ s/\?}/}/g; # optional my $method = $urlnode->getAttributeNode( 'method' ); $method = $method->value if $method; my %params; for ( $urlnode->getChildrenByTagName( 'Param' ) ) { my $param = $_->getAttributeNode( 'name' )->value; my $value = $_->getAttributeNode( 'value' )->value; $value =~ s/\?}/}/g; # optional $params{ $param } = $value; } push @url, WWW::OpenSearch::Url->new( template => $url, type => $type, method => $method, params => \%params, ns => $self->ns ); } $self->Url( \@url ); } elsif ( $version eq '1.1' and $column eq 'Query' ) { my $queries = $self->query || []; for my $node ( $node->get_nodelist ) { my $query = WWW::OpenSearch::Query->new( { map { $_ => $node->getAttributeNode( $_ )->value } qw( role searchTerms ) } ); push @$queries, $query; } $self->query( $queries ); } elsif ( $version eq '1.1' and $column eq 'Image' ) { my $images = $self->image || []; for my $node ( $node->get_nodelist ) { my $image = WWW::OpenSearch::Image->new( { ( map { my $attr = $node->getAttributeNode( $_ ); $attr ? ( $_ => $attr->value ) : () } qw( height width type ) ), url => $node->string_value } ); push @$images, $image; } $self->image( $images ); } else { $self->$column( $node->string_value ); } } } sub get_best_url { my $self = shift; return $self->get_url_by_type( 'application/atom+xml' ) || $self->get_url_by_type( 'application/rss+xml' ) || $self->get_url_by_type( 'text/xml' ) || $self->url->[ 0 ]; } sub get_url_by_type { my $self = shift; my $type = shift; for ( $self->urls ) { return $_ if $_->type eq $type; } return; } sub urls { my $self = shift; return @{ $self->url }; } 1; WWW-OpenSearch-0.17/lib/WWW/OpenSearch/Url.pm0000644000175000017500000000331512076324744020036 0ustar bricasbricaspackage WWW::OpenSearch::Url; use strict; use warnings; use base qw( Class::Accessor::Fast ); use URI::Template; __PACKAGE__->mk_accessors( qw( type template method params ns ) ); =head1 NAME WWW::OpenSearch::Url - Object to represent a target URL =head1 SYNOPSIS =head1 DESCRIPTION =head1 CONSTRUCTOR =head2 new( [%options] ) =head1 METHODS =head2 prepare_query( [ \%params ] ) =head1 ACCESSORS =over 4 =item * type =item * template =item * method =item * params =item * ns =back =head1 AUTHOR =over 4 =item * Tatsuhiko Miyagawa Emiyagawa@bulknews.netE =item * Brian Cassidy Ebricas@cpan.orgE =back =head1 COPYRIGHT AND LICENSE Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut sub new { my ( $class, %options ) = @_; $options{ method } ||= 'GET'; $options{ template } = URI::Template->new( $options{ template } ); my $self = $class->SUPER::new( \%options ); return $self; } sub prepare_query { my ( $self, $params ) = @_; my $tmpl = $self->template; for ( qw( startIndex startPage ) ) { $params->{ $_ } = 1 if !defined $params->{ $_ }; } $params->{ language } ||= '*'; $params->{ outputEncoding } ||= 'UTF-8'; $params->{ inputEncoding } ||= 'UTF-8'; # fill the uri template my $url = $tmpl->process( %$params ); # attempt to handle POST if ( $self->method eq 'post' ) { my $post = $self->params; for my $key ( keys %$post ) { $post->{ $key } =~ s/{(.+)}/$params->{ $1 } || ''/eg; } return $url, [ %$post ]; } return $url; } 1; WWW-OpenSearch-0.17/lib/WWW/OpenSearch/Image.pm0000644000175000017500000000136012076324734020313 0ustar bricasbricaspackage WWW::OpenSearch::Image; use strict; use warnings; use base qw( Class::Accessor::Fast ); __PACKAGE__->mk_accessors( qw( height width type url ) ); =head1 NAME WWW::OpenSearch::Image - Object to represent an image =head1 SYNOPSIS =head1 DESCRIPTION =head1 CONSTRUCTOR =head2 new( [%options] ) =head1 ACCESSORS =over 4 =item * height =item * width =item * type =item * url =back =head1 AUTHOR =over 4 =item * Tatsuhiko Miyagawa Emiyagawa@bulknews.netE =item * Brian Cassidy Ebricas@cpan.orgE =back =head1 COPYRIGHT AND LICENSE Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut 1; WWW-OpenSearch-0.17/lib/WWW/OpenSearch/Query.pm0000644000175000017500000000133212076325072020371 0ustar bricasbricaspackage WWW::OpenSearch::Query; use strict; use warnings; use base qw( Class::Accessor::Fast ); __PACKAGE__->mk_accessors( qw( role searchTerms ) ); =head1 NAME WWW::OpenSearch::Query - Object to represent a sample query =head1 SYNOPSIS =head1 DESCRIPTION =head1 CONSTRUCTOR =head2 new( [%options] ) =head1 ACCESSORS =over 4 =item * role =item * searchTerms =back =head1 AUTHOR =over 4 =item * Tatsuhiko Miyagawa Emiyagawa@bulknews.netE =item * Brian Cassidy Ebricas@cpan.orgE =back =head1 COPYRIGHT AND LICENSE Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut 1; WWW-OpenSearch-0.17/lib/WWW/OpenSearch/Request.pm0000644000175000017500000000266512076325064020727 0ustar bricasbricaspackage WWW::OpenSearch::Request; use strict; use warnings; use base qw( HTTP::Request Class::Accessor::Fast ); use HTTP::Request::Common (); __PACKAGE__->mk_accessors( qw( opensearch_url opensearch_params ) ); =head1 NAME WWW::OpenSearch::Request - Encapsulate an opensearch request =head1 SYNOPSIS =head1 DESCRIPTION =head1 CONSTRUCTOR =head2 new( $url, \%params ) =head1 METHODS =head2 clone( ) =head1 ACCESSORS =over 4 =item * opensearch_url =item * opensearch_params =back =head1 AUTHOR =over 4 =item * Brian Cassidy Ebricas@cpan.orgE =back =head1 COPYRIGHT AND LICENSE Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut sub new { my ( $class, $os_url, $params ) = @_; my ( $uri, $post ) = $os_url->prepare_query( $params ); my $self; if ( lc $os_url->method eq 'post' ) { $self = HTTP::Request::Common::POST( $uri, $post ); bless $self, $class; } else { $self = $class->SUPER::new( $os_url->method => $uri ); } $self->opensearch_url( $os_url ); $self->opensearch_params( $params ); return $self; } sub clone { my $self = shift; my $clone = bless $self->SUPER::clone, ref( $self ); $clone->opensearch_url( $self->opensearch_url ); $clone->opensearch_params( $self->opensearch_params ); return $clone; } 1; WWW-OpenSearch-0.17/lib/WWW/OpenSearch/Response.pm0000644000175000017500000001410712076324754021074 0ustar bricasbricaspackage WWW::OpenSearch::Response; use strict; use warnings; use base qw( HTTP::Response Class::Accessor::Fast ); use XML::Feed; use Data::Page; use WWW::OpenSearch::Agent; use WWW::OpenSearch::Request; __PACKAGE__->mk_accessors( qw( feed pager ) ); =head1 NAME WWW::OpenSearch::Response - Encapsulate a response received from an A9 OpenSearch compatible engine =head1 SYNOPSIS use WWW::OpenSearch; my $url = "http://bulkfeeds.net/opensearch.xml"; my $engine = WWW::OpenSearch->new($url); # Retrieve page 4 of search results for "iPod" my $response = $engine->search("iPod",{ startPage => 4 }); for my $item (@{$response->feed->items}) { print $item->{description}; } # Retrieve page 3 of results $response = $response->previous_page; # Retrieve page 5 of results $response = $response->next_page; =head1 DESCRIPTION WWW::OpenSearch::Response is a module designed to encapsulate a response received from an A9 OpenSearch compatible engine. See http://opensearch.a9.com/spec/1.1/response/ for details. =head1 CONSTRUCTOR =head2 new( $response ) Constructs a new instance of WWW::OpenSearch::Response from the WWWW::OpenSearch:Response returned by the search request. =head1 METHODS =head2 parse_response( ) Parses the content of the HTTP response using XML::Feed. If successful, parse_feed( ) is also called. =head2 parse_feed( ) Parses the XML::Feed originally parsed from the HTTP response content. Sets the pager object appropriately. =head2 previous_page( ) / next_page( ) Performs another search on the parent object, returning a WWW::OpenSearch::Response instance containing the previous/next page of results. If the current response includes a <link rel="previous/next" href="..." /> tag, the page will simply be the parsed content of the URL specified by the tag's href attribute. However, if the current response does not include the appropriate link, a new query is constructed using the startPage or startIndex query arguments. =head2 _get_link( $type ) Gets the href attribute of the first link whose rel attribute is equal to $type. =head1 ACCESSORS =head2 feed( ) =head2 pager( ) =head1 AUTHOR =over 4 =item * Tatsuhiko Miyagawa Emiyagawa@bulknews.netE =item * Brian Cassidy Ebricas@cpan.orgE =back =head1 COPYRIGHT AND LICENSE Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut sub new { my $class = shift; my $response = shift; my $self = bless $response, $class; return $self unless $self->is_success; $self->parse_response; return $self; } sub parse_response { my $self = shift; my $content = $self->content; my $feed = XML::Feed->parse( \$content ); return if XML::Feed->errstr; $self->feed( $feed ); $self->parse_feed; } sub parse_feed { my $self = shift; my $pager = Data::Page->new; my $feed = $self->feed; my $format = $feed->format; my $ns = $self->request->opensearch_url->ns; # TODO # adapt these for any number of opensearch elements in # the feed or in each entry if ( my $atom = $feed->{ atom } ) { my $total = $atom->get( $ns, 'totalResults' ); my $perpage = $atom->get( $ns, 'itemsPerPage' ); my $start = $atom->get( $ns, 'startIndex' ); $pager->total_entries( $total ); $pager->entries_per_page( $perpage ); $pager->current_page( $start ? ( $start - 1 ) / $perpage + 1 : 0 ); } elsif ( my $rss = $feed->{ rss } ) { if ( my $page = $rss->channel->{ $ns } ) { $pager->total_entries( $page->{ totalResults } ); $pager->entries_per_page( $page->{ itemsPerPage } ); my $start = $page->{ startIndex }; $pager->current_page( $start ? ( $start - 1 ) / $page->{ itemsPerPage } + 1 : 0 ); } } $self->pager( $pager ); } sub next_page { my $self = shift; return $self->_get_page( 'next' ); } sub previous_page { my $self = shift; return $self->_get_page( 'previous' ); } sub _get_page { my ( $self, $direction ) = @_; my $pager = $self->pager; my $pagermethod = "${direction}_page"; my $page = $pager->$pagermethod; return unless $page; my $params; my $osu = $self->request->opensearch_url; # this code is too fragile -- deparse depends on the order of query # params and the like. best just to use the last query params and # do the paging from there. # # if( lc $osu->method ne 'post' ) { # force query build on POST # my $link = $self->_get_link( $direction ); # if( $link ) { # $params = $osu->deparse( $link ); # } # } # rebuild the query if ( !$params ) { $params = $self->request->opensearch_params; # handle paging via a page # $params->{ startPage } = $page; # handle paging via an index if ( exists $params->{ startIndex } ) { # start index is pre-existing if ( $params->{ startIndex } ) { if ( $direction eq 'previous' ) { $params->{ startIndex } -= $pager->entries_per_page; } else { $params->{ startIndex } += $pager->entries_per_page; } } # start index did not exist previously else { if ( $direction eq 'previous' ) { $params->{ startIndex } = 1; } else { $params->{ startIndex } = $pager->entries_per_page + 1; } } } } my $agent = WWW::OpenSearch::Agent->new; return $agent->search( WWW::OpenSearch::Request->new( $osu, $params ) ); } sub _get_link { my $self = shift; my $type = shift; my $feed = $self->feed->{ atom }; return unless $feed; for ( $feed->link ) { return $_->href if $_->rel eq $type; } return; } 1; WWW-OpenSearch-0.17/lib/WWW/OpenSearch/Agent.pm0000644000175000017500000000225512076324707020333 0ustar bricasbricaspackage WWW::OpenSearch::Agent; use strict; use warnings; use base qw( LWP::UserAgent ); use WWW::OpenSearch; use WWW::OpenSearch::Response; =head1 NAME WWW::OpenSearch::Agent - An agent for doing OpenSearch requests =head1 SYNOPSIS =head1 DESCRIPTION =head1 CONSTRUCTOR =head2 new( [%options] ) =head1 METHODS =head2 request( $request | $url, \%params ) =head2 search( ) An alias for request() =head1 AUTHOR =over 4 =item * Brian Cassidy Ebricas@cpan.orgE =back =head1 COPYRIGHT AND LICENSE Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut sub new { my ( $class, @rest ) = @_; return $class->SUPER::new( agent => join( '/', __PACKAGE__, $WWW::OpenSearch::VERSION ), @rest, ); } *search = \&request; sub request { my $self = shift; my $request = shift; my $response = $self->SUPER::request( $request, @_ ); # allow regular HTTP::Requests to flow through return $response unless $request->isa( 'WWW::OpenSearch::Request' ); return WWW::OpenSearch::Response->new( $response ); } 1; WWW-OpenSearch-0.17/lib/WWW/OpenSearch.pm0000644000175000017500000000661512076324674017304 0ustar bricasbricaspackage WWW::OpenSearch; use strict; use warnings; use base qw( Class::Accessor::Fast ); use Carp; use WWW::OpenSearch::Agent; use WWW::OpenSearch::Request; use WWW::OpenSearch::Description; use Encode (); __PACKAGE__->mk_accessors( qw( description_url agent description ) ); our $VERSION = '0.17'; =head1 NAME WWW::OpenSearch - Search A9 OpenSearch compatible engines =head1 SYNOPSIS use WWW::OpenSearch; my $url = "http://bulkfeeds.net/opensearch.xml"; my $engine = WWW::OpenSearch->new($url); my $name = $engine->description->ShortName; my $tags = $engine->description->Tags; # Perform search for "iPod" my $response = $engine->search("iPod"); for my $item (@{$response->feed->items}) { print $item->{description}; } # Retrieve the next page of results my $next_page = $response->next_page; for my $item (@{$next_page->feed->items}) { print $item->{description}; } =head1 DESCRIPTION WWW::OpenSearch is a module to search A9's OpenSearch compatible search engines. See http://opensearch.a9.com/ for details. =head1 CONSTRUCTOR =head2 new( $url ) Constructs a new instance of WWW::OpenSearch using the given URL as the location of the engine's OpenSearch Description document (retrievable via the description_url accessor). =head1 METHODS =head2 fetch_description( [ $url ] ) Fetches the OpenSearch Descsription found either at the given URL or at the URL specified by the description_url accessor. Fetched description may be accessed via the description accessor. =head2 search( $query [, \%params] ) Searches the engine for the given query using the given search parameters. Valid search parameters include: =over 4 =item * startPage =item * totalResults =item * startIndex =item * itemsPerPage =back See http://opensearch.a9.com/spec/1.1/response/#elements for details. =head2 do_search( $url [, $method] ) Performs a request for the given URL and returns a WWW::OpenSearch::Response object. Method defaults to 'GET'. =head1 ACCESSORS =head2 description_url( [$description_url] ) =head2 agent( [$agent] ) =head2 description( [$description] ) =head1 AUTHOR Brian Cassidy Ebricas@cpan.orgE Tatsuhiko Miyagawa Emiyagawa@bulknews.netE =head1 COPYRIGHT AND LICENSE Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut sub new { my ( $class, $url ) = @_; croak( "No OpenSearch Description url provided" ) unless $url; my $self = $class->SUPER::new; $self->description_url( $url ); $self->agent( WWW::OpenSearch::Agent->new() ); $self->fetch_description; return $self; } sub fetch_description { my ( $self, $url ) = @_; $url ||= $self->description_url; $self->description_url( $url ); my $response = $self->agent->get( $url ); unless ( $response->is_success ) { croak "Error while fetching $url: " . $response->status_line; } $self->description( WWW::OpenSearch::Description->new( $response->content ) ); } sub search { my ( $self, $query, $params, $url ) = @_; $params ||= {}; $params->{ searchTerms } = $query; Encode::_utf8_off( $params->{ searchTerms } ); $url ||= $self->description->get_best_url; return $self->agent->search( WWW::OpenSearch::Request->new( $url, $params ) ); } 1;