diff options
author | Mason James <mtj@kohaaloha.com> | 2023-01-26 18:53:22 +1300 |
---|---|---|
committer | Mason James <mtj@kohaaloha.com> | 2023-01-26 18:53:22 +1300 |
commit | e3573a4fdbd4a9cf2fa30285e380b05b985adcea (patch) | |
tree | 53305bc1bd296feb9fd32660574d59ac2b1f5352 |
Import original source of Catmandu-Z3950 0.06
-rw-r--r-- | Build.PL | 61 | ||||
-rw-r--r-- | Changes | 22 | ||||
-rw-r--r-- | LICENSE | 379 | ||||
-rw-r--r-- | MANIFEST | 19 | ||||
-rw-r--r-- | META.json | 85 | ||||
-rw-r--r-- | META.yml | 47 | ||||
-rw-r--r-- | README | 34 | ||||
-rw-r--r-- | bin/example.txt | 10 | ||||
-rwxr-xr-x | bin/z3950_importer.pl | 181 | ||||
-rw-r--r-- | cpanfile | 14 | ||||
-rw-r--r-- | dist.ini | 3 | ||||
-rw-r--r-- | lib/Catmandu/Importer/Z3950.pm | 298 | ||||
-rw-r--r-- | lib/Catmandu/Importer/Z3950/Parser/UNIMARC.pm | 28 | ||||
-rw-r--r-- | lib/Catmandu/Importer/Z3950/Parser/USMARC.pm | 63 | ||||
-rw-r--r-- | lib/Catmandu/Z3950.pm | 55 | ||||
-rwxr-xr-x | t/00-load.t | 15 | ||||
-rw-r--r-- | t/01-post-load.t | 30 | ||||
-rw-r--r-- | t/author-pod-syntax.t | 15 |
18 files changed, 1359 insertions, 0 deletions
diff --git a/Build.PL b/Build.PL new file mode 100644 index 0000000..520ca4b --- /dev/null +++ b/Build.PL @@ -0,0 +1,61 @@ + +# This file was automatically generated by Dist::Zilla::Plugin::ModuleBuild v6.008. +use strict; +use warnings; + +use Module::Build 0.28; + + +my %module_build_args = ( + "build_requires" => { + "Module::Build" => "0.28" + }, + "configure_requires" => { + "Module::Build" => "0.28" + }, + "dist_abstract" => "Catmandu module for working with Z3950 data", + "dist_author" => [ + "=over" + ], + "dist_name" => "Catmandu-Z3950", + "dist_version" => "0.06", + "license" => "perl", + "module_name" => "Catmandu::Z3950", + "recursive_test_files" => 1, + "requires" => { + "Catmandu" => ">= 0.94, != 0.9502, != 0.9503", + "Catmandu::MARC" => 0, + "ZOOM" => 0, + "perl" => "v5.10.1" + }, + "test_requires" => { + "Pod::Simple::HTML" => "3.23", + "Test::Deep" => 0, + "Test::More" => "1.001003", + "Test::Pod" => 0, + "Test::Simple" => "1.001003", + "XML::XPath" => "1.13" + } +); + + +my %fallback_build_requires = ( + "Module::Build" => "0.28", + "Pod::Simple::HTML" => "3.23", + "Test::Deep" => 0, + "Test::More" => "1.001003", + "Test::Pod" => 0, + "Test::Simple" => "1.001003", + "XML::XPath" => "1.13" +); + + +unless ( eval { Module::Build->VERSION(0.4004) } ) { + delete $module_build_args{test_requires}; + $module_build_args{build_requires} = \%fallback_build_requires; +} + +my $build = Module::Build->new(%module_build_args); + + +$build->create_build_script; @@ -0,0 +1,22 @@ +Revision history for Catmandu-Z3950 + +0.06 2019-01-08 09:41:10 CET + - fixing UNIMARC processing (edipretoro) + - fixing authentication issues (edipretoro) + +0.05 2016-05-26 16:02:24 CEST + - adding support for default MARC parsed output + - adding support adding Z3950 parser + - more POD + +0.04 2013-11-12 + - fix depdencies + +0.03 2012-10-25 + - fixed server connection bug + +0.02 2012-10-25 + - fixed end-of-resultset bug + +0.01 2012-08-02 + - initial release @@ -0,0 +1,379 @@ +This software is copyright (c) 2019 by Patrick Hochstenbach. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +Terms of the Perl programming language system itself + +a) the GNU General Public License as published by the Free + Software Foundation; either version 1, or (at your option) any + later version, or +b) the "Artistic License" + +--- The GNU General Public License, Version 1, February 1989 --- + +This software is Copyright (c) 2019 by Patrick Hochstenbach. + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free +programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of a such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must tell them their rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work based +on the Program" means either the Program or any work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 1. You may copy and distribute verbatim copies of the Program's source +code as you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual way, to print or display an + announcement including an appropriate copyright notice and a notice + that there is no warranty (or else, saying that you provide a + warranty) and that users may redistribute the program under these + conditions, and telling the user how to view a copy of this General + Public License. + + d) You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 1 and 2 above provided that you also do one of the following: + + a) accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying the Program (or any work based +on the Program) you indicate your acceptance of this license to do so, +and all its terms and conditions. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the original +licensor to copy, distribute or modify the Program subject to these +terms and conditions. You may not impose any further restrictions on the +recipients' exercise of the rights granted herein. + + 7. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of the license which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2019 by Patrick Hochstenbach. + +This is free software, licensed under: + + The Artistic License 1.0 + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of +the package the right to use and distribute the Package in a more-or-less +customary fashion, plus the right to make reasonable modifications. + +Definitions: + + - "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through + textual modification. + - "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. + - "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. + - "You" is you, if you're thinking about copying or distributing this Package. + - "Reasonable copying fee" is whatever you can justify on the basis of media + cost, duplication charges, time of people involved, and so on. (You will + not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) + - "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you +duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived +from the Public Domain or from the Copyright Holder. A Package modified in such +a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that +you insert a prominent notice in each changed file stating how and when you +changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or an + equivalent medium, or placing the modifications on a major archive site + such as ftp.uu.net, or by allowing the Copyright Holder to include your + modifications in the Standard Version of the Package. + + b) use the modified Package only within your corporation or organization. + + c) rename any non-standard executables so the names do not conflict with + standard executables, which must also be provided, and provide a separate + manual page for each non-standard executable that clearly documents how it + differs from the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on where to + get the Standard Version. + + b) accompany the distribution with the machine-readable source of the Package + with your modifications. + + c) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting the differences in manual pages (or + equivalent), together with instructions on where to get the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this Package. You +may not charge a fee for this Package itself. However, you may distribute this +Package in aggregate with other (possibly commercial) programs as part of a +larger (possibly commercial) software distribution provided that you do not +advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output +from the programs of this Package do not automatically fall under the copyright +of this Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..47d1075 --- /dev/null +++ b/MANIFEST @@ -0,0 +1,19 @@ +# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.008. +Build.PL +Changes +LICENSE +MANIFEST +META.json +META.yml +README +bin/example.txt +bin/z3950_importer.pl +cpanfile +dist.ini +lib/Catmandu/Importer/Z3950.pm +lib/Catmandu/Importer/Z3950/Parser/UNIMARC.pm +lib/Catmandu/Importer/Z3950/Parser/USMARC.pm +lib/Catmandu/Z3950.pm +t/00-load.t +t/01-post-load.t +t/author-pod-syntax.t diff --git a/META.json b/META.json new file mode 100644 index 0000000..ce84d31 --- /dev/null +++ b/META.json @@ -0,0 +1,85 @@ +{ + "abstract" : "Catmandu module for working with Z3950 data", + "author" : [ + "=over" + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Milla version v1.0.17, Dist::Zilla version 6.008, CPAN::Meta::Converter version 2.150005", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : 2 + }, + "name" : "Catmandu-Z3950", + "no_index" : { + "directory" : [ + "eg", + "examples", + "inc", + "share", + "t", + "xt" + ] + }, + "prereqs" : { + "build" : { + "requires" : { + "Module::Build" : "0.28" + } + }, + "configure" : { + "requires" : { + "Module::Build" : "0.28" + } + }, + "develop" : { + "requires" : { + "Dist::Milla" : "v1.0.17", + "Test::Pod" : "1.41" + } + }, + "runtime" : { + "requires" : { + "Catmandu" : ">= 0.94, != 0.9502, != 0.9503", + "Catmandu::MARC" : "0", + "ZOOM" : "0", + "perl" : "v5.10.1" + } + }, + "test" : { + "requires" : { + "Pod::Simple::HTML" : "3.23", + "Test::Deep" : "0", + "Test::More" : "1.001003", + "Test::Pod" : "0", + "Test::Simple" : "1.001003", + "XML::XPath" : "1.13" + } + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "https://github.com/LibreCat/Catmandu-Z3950/issues" + }, + "homepage" : "https://github.com/LibreCat/Catmandu-Z3950", + "repository" : { + "type" : "git", + "url" : "https://github.com/LibreCat/Catmandu-Z3950.git", + "web" : "https://github.com/LibreCat/Catmandu-Z3950" + } + }, + "version" : "0.06", + "x_contributors" : [ + "Christian Pietsch <christian.pietsch@uni-bielefeld.de>", + "Emmanuel Di Pretoro <edipretoro@gmail.com>", + "Fedora Application User <fedora@gide.ugent.be>", + "Nicolas Steenlant <nicolas.steenlant@ugent.be>", + "Patrick Hochstenbach <Patrick.Hochstenbach@UGent.be>", + "wouterw <wouter.willaert@gmail.com>" + ], + "x_serialization_backend" : "Cpanel::JSON::XS version 4.08" +} + diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..5f49938 --- /dev/null +++ b/META.yml @@ -0,0 +1,47 @@ +--- +abstract: 'Catmandu module for working with Z3950 data' +author: + - =over +build_requires: + Module::Build: '0.28' + Pod::Simple::HTML: '3.23' + Test::Deep: '0' + Test::More: '1.001003' + Test::Pod: '0' + Test::Simple: '1.001003' + XML::XPath: '1.13' +configure_requires: + Module::Build: '0.28' +dynamic_config: 0 +generated_by: 'Dist::Milla version v1.0.17, Dist::Zilla version 6.008, CPAN::Meta::Converter version 2.150005' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: '1.4' +name: Catmandu-Z3950 +no_index: + directory: + - eg + - examples + - inc + - share + - t + - xt +requires: + Catmandu: '>= 0.94, != 0.9502, != 0.9503' + Catmandu::MARC: '0' + ZOOM: '0' + perl: v5.10.1 +resources: + bugtracker: https://github.com/LibreCat/Catmandu-Z3950/issues + homepage: https://github.com/LibreCat/Catmandu-Z3950 + repository: https://github.com/LibreCat/Catmandu-Z3950.git +version: '0.06' +x_contributors: + - 'Christian Pietsch <christian.pietsch@uni-bielefeld.de>' + - 'Emmanuel Di Pretoro <edipretoro@gmail.com>' + - 'Fedora Application User <fedora@gide.ugent.be>' + - 'Nicolas Steenlant <nicolas.steenlant@ugent.be>' + - 'Patrick Hochstenbach <Patrick.Hochstenbach@UGent.be>' + - 'wouterw <wouter.willaert@gmail.com>' +x_serialization_backend: 'YAML::Tiny version 1.69' @@ -0,0 +1,34 @@ +NAME + + Catmandu::Z3950 - Catmandu module for working with Z3950 data + +VERSION + + Version 0.04 + +SYNOPSIS + + $ catmandu convert Z3950 --host z3950.loc.gov --port 7090 --databaseName Voyager --query "(title = dinosaur)" + +MODULES + + * Catmandu::Importer::Z3950 + +AUTHOR + + * Wouter Willaert, wouterw at inuits.eu> + + * Patrick Hochstenbach, patrick.hochstenbach at ugent.be> + +CONTRIBUTORS + + * Emmanuel Di Pretoro, edipretoro at gmail.com + +LICENSE AND COPYRIGHT + + This program is free software; you can redistribute it and/or modify it + under the terms of either: the GNU General Public License as published + by the Free Software Foundation; or the Artistic License. + + See http://dev.perl.org/licenses/ for more information. + diff --git a/bin/example.txt b/bin/example.txt new file mode 100644 index 0000000..fe6c4dc --- /dev/null +++ b/bin/example.txt @@ -0,0 +1,10 @@ +000001921 @attr 1=7 0387111573 +000001922 @attr 1=7 3593329840 +000001923 @attr 1=7 9783540783541 +000001924 @attr 1=7 3540783547 +000001925 @attr 1=7 9783540783558 +000001926 @attr 1=7 3540783555 +000001927 @attr 1=7 9781888569902 +000001928 @attr 1=7 1888569905 +000001929 @attr 1=7 9783832956677 +000002000 @attr 1=7 3832956670 diff --git a/bin/z3950_importer.pl b/bin/z3950_importer.pl new file mode 100755 index 0000000..3975ac0 --- /dev/null +++ b/bin/z3950_importer.pl @@ -0,0 +1,181 @@ +#!/usr/bin/env perl +$|++; + +use Catmandu::Importer::Z3950; +use Data::Dumper; +use MARC::Record; +use Getopt::Long; + +my $host; +my $port; +my $databaseName; +my $preferredRecordSyntax; +my $queryType; +my $user; +my $password; +my $num; +my $help; +my $query; +my $sleep; +my $verbose; +my $conf = 'loc'; + +my $std_conf = { + 'loc' => { host => 'lx2.loc.gov' , port => 210 , databaseName => 'lcdb' , preferredRecordSyntax => 'USMARC' , queryType => 'PQF'} , + 'ugent' => { host => 'aleph.ugent.be' , port => 9991 , databaseName => 'RUG01' , preferredRecordSyntax => 'USMARC' , queryType => 'PQF'} , + 'innopac' => { host => 'library.anu.edu.au' , port => 210 , databaseName => 'INNOPAC' , preferredRecordSyntax => 'USMARC' , queryType => 'PQF'} , +}; + +GetOptions( "h" => \$help , + "conf=s" => \$conf , + "host=s" => \$host , + "port=i" => \$port , + "base=s" => \$databaseName , + "syntax=s" => \$preferredRecordSyntax , + "type=s" => \$queryType , + "sleep=i" => \$sleep , + "verbose" => \$verbose , + "user" => \$user , + "password" => \$password , + "num=i" => \$num); + +&usage if $help; + +binmode(STDOUT,':encoding(UTF-8)'); + +if (@ARGV) { + my $query = shift; + + my $importer = &importer; + $importer->query($query); + + my $n = $importer->slice(0,$num)->each(sub { + process_record(0,$_[0]); + }); + + print STDERR "processed: $n record\n"; +} +else { + my $count = 0; + my $results = 0; + my $importer = &importer; + + while (<STDIN>) { + chomp; + my ($prefix,$query) = split(/\s+/,$_,2); + my $n; + + my $error = 0; + do { + $importer->query($query); + + $count++; + print STDERR "executing: $prefix\t$query hits: " if $verbose; + + eval { + $n = $importer->slice(0,$num)->each(sub { + process_record($prefix,$_[0]); + }); + }; + + if ($@) { + print STDERR "caught: $@ sleeping 10 seconds " if $verbose; + sleep 10; + $n = 0; + print STDERR "reconnecting " if $verbose; + $importer = &importer; + } + else { $error = 0 } + } while ($error == 1); + + $results += 1 if $n > 0; + + printf STDERR "$n queries with results: $results/$count %-3.1f %%\n", 100 * $results/$count if $verbose; + + sleep($sleep) if $sleep; + } +} + +sub importer { + my $std = $std_conf->{$conf} || {}; + $std->{host} = $host if $host; + $std->{port} = $port if $port; + $std->{user} = $user if $user; + $std->{password} = $password if $password; + $std->{databaseName} = $databaseName if $databaseName; + $std->{preferredRecordSyntax} = $preferredRecordSyntax if $preferredRecordSyntax; + $std->{queryType} = $queryType if $queryType; + return Catmandu::Importer::Z3950->new(%$std); +} + +sub process_record { + my ($prefix,$ref) = @_; + my $marc = MARC::Record->new_from_usmarc($ref); + + printf "%-9.9d %-3.3s L BK\n" , $prefix, 'FMT'; + + for my $field ($marc->fields) { + my $tag = $field->tag; + my $ind1 = $field->indicator(1) // ' '; + my $ind2 = $field->indicator(2) // ' '; + + printf "%-9.9d %-3.3s%s%s L " , $prefix, $tag, $ind1, $ind2; + + if ($field->is_control_field) { + printf "%s" , $field->data; + } + else { + for my $subfield ($field->subfields) { + printf "\$\$%s%s" , $subfield->[0], $subfield->[1]; + } + } + + print "\n"; + } +} + +sub usage { + print STDERR <<EOF; +usage: + + $0 [options] query + $0 [options] < file + +where: file like + prefix query + prefix query + prefix query + . + . + . + +options: + -h + --conf=(loc|ugent) + --host=$host + --port=$port + --user=XXXX + --password=XXXX + --base=$databaseName + --syntax=$preferredRecordSyntax + --type=$queryType + --num=<max_number_of_records> + --sleep=<seconds> + --prefix=$prefix + +example: + + --host lx2.loc.gov --port 210 --base lcdb --type PQF + + query: \@attr 1=7 9781615300068 (search for 9781615300068 in ISBN-keyword) + query: \@attr 1=8 0028-0836 (search for 0028-0836 in ISSN) + + Use: http://www.loc.gov/z3950/lcdbz3950.xml for more options + +usage: + + $0 "\@attr 1=7 9781615300068" + $0 < example.txt +EOF + exit 1; +} diff --git a/cpanfile b/cpanfile new file mode 100644 index 0000000..f2bbc49 --- /dev/null +++ b/cpanfile @@ -0,0 +1,14 @@ +requires 'perl', 'v5.10.1'; + +on 'test', sub { + requires 'Test::Simple', '1.001003'; + requires 'Test::More', '1.001003'; + requires 'Test::Deep', '0'; + requires 'XML::XPath', '1.13'; + requires 'Pod::Simple::HTML', '>=3.23'; + requires 'Test::Pod' , '0'; +}; + +requires 'Catmandu', '>=0.94,!=0.9502,!=0.9503'; +requires 'Catmandu::MARC', '0'; +requires 'ZOOM' , '0';
\ No newline at end of file diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..3fa3000 --- /dev/null +++ b/dist.ini @@ -0,0 +1,3 @@ +name = Catmandu-Z3950 +[@Milla] +installer = ModuleBuild
\ No newline at end of file diff --git a/lib/Catmandu/Importer/Z3950.pm b/lib/Catmandu/Importer/Z3950.pm new file mode 100644 index 0000000..0120fb0 --- /dev/null +++ b/lib/Catmandu/Importer/Z3950.pm @@ -0,0 +1,298 @@ +package Catmandu::Importer::Z3950; + +use Catmandu::Sane; +use Catmandu::Util qw(:is); +use Scalar::Util qw(blessed); +use Carp; +use Moo; +use ZOOM; + +our $VERSION = '0.06'; + +with 'Catmandu::Importer'; + +# INFO: +# http://www.loc.gov/z3950/ + +# Constants. ------------------------------------------------------------------- + +use constant PREFERREDRECORDSYNTAX => 'USMARC'; +use constant PORT => 210; +use constant QUERYTYPE => 'CQL'; + +# Properties. ------------------------------------------------------------------ + +# required. +has host => (is => 'ro', required => 1); +has databaseName => (is => 'ro', required => 1); +has query => (is => 'rw'); + +# optional. +has port => (is => 'ro', default => sub { return PORT; }); +has preferredRecordSyntax => (is => 'ro', default => sub { return PREFERREDRECORDSYNTAX; }); +has user => (is => 'ro'); +has password => (is => 'ro'); +has queryType => (is =>'ro', default => sub { return QUERYTYPE; }); # <CQL | PQF> +has handler => (is => 'rw', lazy => 1 , builder => 1, coerce => \&_coerce_handler ); + +# internal stuff. +has _conn => (is => 'ro'); +has _qry => (is => 'ro'); +has _currentRecordSet => (is => 'ro'); +has _n => (is => 'ro', default => sub { 0 }); + +# Internal Methods. ------------------------------------------------------------ + +sub _build_handler { + my ($self) = @_; + + if ($self->preferredRecordSyntax eq 'USMARC') { + Catmandu::Util::require_package('Catmandu::Importer::Z3950::Parser::USMARC')->new; + } + else { + return sub { return { record => $_[0] } }; + } +} + +sub _coerce_handler { + my ($handler) = @_; + + return $handler if is_invocant($handler) or is_code_ref($handler); + + if ($handler eq 'RAW') { + return sub { return { record => $_[0] } }; + } + elsif (is_string($handler) && !is_number($handler)) { + my $class = $handler =~ /^\+(.+)/ ? $1 + : "Catmandu::Importer::Z3950::Parser::$handler"; + + my $handler; + eval { + $handler = Catmandu::Util::require_package($class)->new; + }; + if ($@) { + croak $@; + } else { + return $handler; + } + } + else { + die "unknown handler type $handler"; + } +} + +sub _setup_connection { + my ($self) = @_; + + my $opts = ZOOM::Options->new(); + $opts->option(databaseName => $self->databaseName); + $opts->option(preferredRecordSyntax => $self->preferredRecordSyntax) if $self->preferredRecordSyntax; + $opts->option(user => $self->user) if $self->user; + $opts->option(password => $self->password) if $self->password; + + my $conn = ZOOM::Connection->create($opts); + $conn->connect( + $self->host, + $self->port, + ); + + return $conn; +} + +sub _get_query { + my ($self) = @_; + my $qry; + + if ($self->queryType eq 'CQL') { + $qry = ZOOM::Query::CQL->new($self->query); # 'title=dinosaur' + } + elsif ($self->queryType eq 'PQF') { + $qry = ZOOM::Query::PQF->new($self->query); # '@attr 1=4 dinosaur' + } + + return $qry; +} + +sub _nextRecord { + my ($self) = @_; + + unless ($self->_conn) { + $self->_clean; + $self->{_conn} = $self->_setup_connection; + } + + unless ($self->_qry) { + $self->_clean; + $self->{_qry} = $self->_get_query; + } + + unless ($self->_currentRecordSet) { + $self->{_currentRecordSet} = $self->{_conn}->search($self->{_qry}); + $self->{_n} = 0; + } + + my $size = $self->_currentRecordSet->size() || 0; + + if ($self->{_n} < $size) { + my $rec = $self->_currentRecordSet->record($self->{_n}++)->get("raw"); + return blessed($self->handler) + ? $self->handler->parse($rec) + : $self->handler->($rec); + } + else { + $self->_clean; + return undef; + } +} + +sub _clean { + my ($self) = @_; + $self->{_currentRecordSet}->destroy() if $self->{_currentRecordSet}; + $self->{_qry}->destroy() if $self->{_qry}; + $self->{_currentRecordSet} = undef; + $self->{_qry} = undef; + $self->{_n} = 0; +} + +sub DESTROY { + my ($self) = @_; + + if ($self->_conn) { + $self->_conn->destroy(); + } +} + + +# Public Methods. -------------------------------------------------------------- + +sub generator { + my ($self) = @_; + + return sub { + $self->_nextRecord; + }; +} + + +# PerlDoc. --------------------------------------------------------------------- + +=head1 NAME + + Catmandu::Importer::Z3950 - Package that imports Z3950 data + +=head1 SYNOPSIS + + # On the command line + + $ catmandu convert Z3950 --host z3950.loc.gov --port 7090 --databaseName Voyager --query "(title = dinosaur)" + + # From Perl + + use Catmandu; + + my $importer = Catmandu->importer('Z3950' + host => 'z3950.loc.gov', + port => 7090, + databaseName => "Voyager", + preferredRecordSyntax => "USMARC", + queryType => 'PQF', # CQL or PQF + query => '@attr 1=4 dinosaur' + ); + + my $n = $importer->each(sub { + my $hashref = $_[0]; + ... + }); + +=cut + +=head1 CONFIGURAION + +=over + +=item host + +The Z3950 host name + +=item port + +The Z3950 port + +=item user + +A user name + +=item password + +A password + +=item databaseName + +The database to connect to + +=item preferredRecordSyntax + +The preferred response format (default: USMARC) + +=item queryType + +The queryType (CQL or PQF) + +=item query + +The query + +=item handler + +The Perl handler to parse the response content. Examples are 'USMARC' and 'UNIMARC' + + $ catmandu convert Z3950 \ + --user 'XXX' \ + --password 'XXX' \ + --host z3950.bnf.fr \ + --port 2211 \ + --databaseName TOUT-ANA1-UTF8 \ + --preferredRecordSyntax Unimarc \ + --queryType PQF \ + --query '@attr 1=7 9782744024191' \ + --handler UNIMARC + +=back + +=head1 REQUIREMENTS + +This package uses the ZOOM package internally. +For more info visit: http://search.cpan.org/~mirk/Net-Z3950-ZOOM-1.28/lib/ZOOM.pod + +The ZOOM package has a hard dependency on YAZ toolkit. +For more info about YAZ, visit: https://www.indexdata.com/yaz + +Installing YAZ: +- (osx, using homebrew): brew install yaz +- (linux, using yum): yum install yaz libyaz + +=head1 AUTHOR + +=over + +=item * Wouter Willaert, C<< <wouterw@inuits.eu> >> + +=item * Patrick Hochstenbach, C<< <patrick.hochstenbach@ugent.be> >> + +=back + +=head1 CONTRIBUTORS + +=over + +=item * Emmanuel Di Pretoro, C<< edipretoro at gmail.com >> + +=back + +=head1 SEE ALSO + +L<Catmandu::Iterable> + +=cut + +1; diff --git a/lib/Catmandu/Importer/Z3950/Parser/UNIMARC.pm b/lib/Catmandu/Importer/Z3950/Parser/UNIMARC.pm new file mode 100644 index 0000000..ff7bb5f --- /dev/null +++ b/lib/Catmandu/Importer/Z3950/Parser/UNIMARC.pm @@ -0,0 +1,28 @@ +package Catmandu::Importer::Z3950::Parser::UNIMARC; + +use Catmandu::Sane; +use MARC::Parser::RAW; +use Moo; + +our $VERSION = '0.06'; + +has 'id' => (is => 'ro' , default => sub { '001'} ); + +sub parse { + my ($self,$str) = @_; + my $sysid = undef; + + return undef unless defined $str; + + my $record = MARC::Parser::RAW->new(\$str)->next(); + + foreach my $field (@$record) { + if ($field->[0] eq '001') { + $sysid = $field->[4]; + } + } + + return { _id => $sysid , record => $record }; +} + +1; diff --git a/lib/Catmandu/Importer/Z3950/Parser/USMARC.pm b/lib/Catmandu/Importer/Z3950/Parser/USMARC.pm new file mode 100644 index 0000000..c6e2cde --- /dev/null +++ b/lib/Catmandu/Importer/Z3950/Parser/USMARC.pm @@ -0,0 +1,63 @@ +package Catmandu::Importer::Z3950::Parser::USMARC; + +use Catmandu::Sane; +use MARC::File::USMARC; +use Moo; + +our $VERSION = '0.06'; + +has 'id' => (is => 'ro' , default => sub { '001'} ); + +sub parse { + my ($self,$str) = @_; + + return undef unless defined $str; + + my $record = MARC::File::USMARC->decode($str); + + $self->decode_marc($record); +} + +sub decode_marc { + my ($self, $record) = @_; + return unless eval { $record->isa('MARC::Record') }; + my @result = (); + + push @result , [ 'LDR' , undef, undef, '_' , $record->leader ]; + + for my $field ($record->fields()) { + my $tag = $field->tag; + my $ind1 = $field->indicator(1); + my $ind2 = $field->indicator(2); + + my @sf = (); + + if ($field->is_control_field) { + push @sf , '_', $field->data; + } + + for my $subfield ($field->subfields) { + push @sf , @$subfield; + } + + push @result, [$tag,$ind1,$ind2,@sf]; + } + + my $sysid = undef; + my $id = $self->id; + + if ($id =~ /^00/ && $record->field($id)) { + $sysid = $record->field($id)->data(); + } + elsif ($id =~ /^(\d{3})([\da-zA-Z])$/) { + my $field = $record->field($1); + $sysid = $field->subfield($2) if ($field); + } + elsif (defined $id && $record->field($id)) { + $sysid = $record->field($id)->subfield("a"); + } + + return { _id => $sysid , record => \@result }; +} + +1; diff --git a/lib/Catmandu/Z3950.pm b/lib/Catmandu/Z3950.pm new file mode 100644 index 0000000..934acd2 --- /dev/null +++ b/lib/Catmandu/Z3950.pm @@ -0,0 +1,55 @@ +package Catmandu::Z3950; + +=head1 NAME + +Catmandu::Z3950 - Catmandu module for working with Z3950 data + +=head1 VERSION + +Version 0.04 + +=head1 SYNOPSIS + + $ catmandu convert Z3950 --host z3950.loc.gov --port 7090 --databaseName Voyager --query "(title = dinosaur)" + +=cut + +our $VERSION = '0.06'; + +=head1 MODULES + +=over + +=item * L<Catmandu::Importer::Z3950> + +=back + +=head1 AUTHOR + +=over + +=item * Wouter Willaert, C<< wouterw at inuits.eu> >> + +=item * Patrick Hochstenbach, C<< patrick.hochstenbach at ugent.be> >> + +=back + +=head1 CONTRIBUTORS + +=over + +=item * Emmanuel Di Pretoro, C<< edipretoro at gmail.com >> + +=back + +=head1 LICENSE AND COPYRIGHT + +This program is free software; you can redistribute it and/or modify it +under the terms of either: the GNU General Public License as published +by the Free Software Foundation; or the Artistic License. + +See http://dev.perl.org/licenses/ for more information. + +=cut + +1; diff --git a/t/00-load.t b/t/00-load.t new file mode 100755 index 0000000..6e0aa36 --- /dev/null +++ b/t/00-load.t @@ -0,0 +1,15 @@ +#!perl -T + +use strict; +use warnings; +use Test::More; + +my $pkg; +BEGIN { + $pkg = 'Catmandu::Importer::Z3950'; + use_ok $pkg; +} + +require_ok $pkg; + +done_testing 2; diff --git a/t/01-post-load.t b/t/01-post-load.t new file mode 100644 index 0000000..4747908 --- /dev/null +++ b/t/01-post-load.t @@ -0,0 +1,30 @@ +#!/usr/bin/env perl + +use strict; +use warnings; +use Test::More; +use Test::Exception; + +my $pkg; +BEGIN { + $pkg = 'Catmandu::Importer::Z3950'; + use_ok($pkg); +} +require_ok($pkg); + +my %attrs = ( + host => 'z3950.loc.gov', + port => 7090, + databaseName => "Voyager", + preferredRecordSyntax => "USMARC", + queryType => 'PQF', + query => '@attr 1=4 dinosaur' +); + +my $importer = Catmandu::Importer::Z3950->new(%attrs); + +isa_ok($importer, $pkg); + +can_ok($importer, 'each'); + +done_testing 4; diff --git a/t/author-pod-syntax.t b/t/author-pod-syntax.t new file mode 100644 index 0000000..2233af0 --- /dev/null +++ b/t/author-pod-syntax.t @@ -0,0 +1,15 @@ +#!perl + +BEGIN { + unless ($ENV{AUTHOR_TESTING}) { + print qq{1..0 # SKIP these tests are for testing by the author\n}; + exit + } +} + +# This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. +use strict; use warnings; +use Test::More; +use Test::Pod 1.41; + +all_pod_files_ok(); |