LP#1367926: various improvements and bugfixes
[Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / SuperCat.pm
1 # We'll be working with XML, so...
2 use XML::LibXML;
3 use XML::LibXSLT;
4 use Unicode::Normalize;
5
6 # ... and this has some handy common methods
7 use OpenILS::Application::AppUtils;
8
9 my $parser = new XML::LibXML;
10 my $U = 'OpenILS::Application::AppUtils';
11
12
13 package OpenILS::Application::SuperCat;
14
15 use strict;
16 use warnings;
17 use OpenILS::Utils::Normalize qw( naco_normalize );
18
19 # All OpenSRF applications must be based on OpenSRF::Application or
20 # a subclass thereof.  Makes sense, eh?
21 use OpenILS::Application;
22 use base qw/OpenILS::Application/;
23
24 # This is the client class, used for connecting to open-ils.storage
25 use OpenSRF::AppSession;
26
27 # This is an extension of Error.pm that supplies some error types to throw
28 use OpenSRF::EX qw(:try);
29
30 # This is a helper class for querying the OpenSRF Settings application ...
31 use OpenSRF::Utils::SettingsClient;
32
33 # ... and here we have the built in logging helper ...
34 use OpenSRF::Utils::Logger qw($logger);
35
36 # ... and this is our OpenILS object (en|de)coder and psuedo-ORM package.
37 use OpenILS::Utils::Fieldmapper;
38
39 use OpenILS::Utils::CStoreEditor q/:funcs/;
40 use OpenILS::Utils::TagURI;
41
42
43 our (
44   $_parser,
45   $_xslt,
46   %record_xslt,
47   %metarecord_xslt,
48   %holdings_data_cache,
49   %authority_browse_axis_cache,
50 );
51
52 sub child_init {
53     # we need an XML parser
54     $_parser = new XML::LibXML;
55
56     # and an xslt parser
57     $_xslt = new XML::LibXSLT;
58
59     # parse the MODS xslt ...
60     my $mods33_xslt = $_parser->parse_file(
61         OpenSRF::Utils::SettingsClient
62             ->new
63             ->config_value( dirs => 'xsl' ).
64         "/MARC21slim2MODS33.xsl"
65     );
66     # and stash a transformer
67     $record_xslt{mods33}{xslt} = $_xslt->parse_stylesheet( $mods33_xslt );
68     $record_xslt{mods33}{namespace_uri} = 'http://www.loc.gov/mods/v3';
69     $record_xslt{mods33}{docs} = 'http://www.loc.gov/mods/';
70     $record_xslt{mods33}{schema_location} = 'http://www.loc.gov/standards/mods/v3/mods-3-3.xsd';
71
72     # parse the MODS xslt ...
73     my $mods32_xslt = $_parser->parse_file(
74         OpenSRF::Utils::SettingsClient
75             ->new
76             ->config_value( dirs => 'xsl' ).
77         "/MARC21slim2MODS32.xsl"
78     );
79     # and stash a transformer
80     $record_xslt{mods32}{xslt} = $_xslt->parse_stylesheet( $mods32_xslt );
81     $record_xslt{mods32}{namespace_uri} = 'http://www.loc.gov/mods/v3';
82     $record_xslt{mods32}{docs} = 'http://www.loc.gov/mods/';
83     $record_xslt{mods32}{schema_location} = 'http://www.loc.gov/standards/mods/v3/mods-3-2.xsd';
84
85     # parse the MODS xslt ...
86     my $mods3_xslt = $_parser->parse_file(
87         OpenSRF::Utils::SettingsClient
88             ->new
89             ->config_value( dirs => 'xsl' ).
90         "/MARC21slim2MODS3.xsl"
91     );
92     # and stash a transformer
93     $record_xslt{mods3}{xslt} = $_xslt->parse_stylesheet( $mods3_xslt );
94     $record_xslt{mods3}{namespace_uri} = 'http://www.loc.gov/mods/v3';
95     $record_xslt{mods3}{docs} = 'http://www.loc.gov/mods/';
96     $record_xslt{mods3}{schema_location} = 'http://www.loc.gov/standards/mods/v3/mods-3-1.xsd';
97
98     # parse the MODS xslt ...
99     my $mods_xslt = $_parser->parse_file(
100         OpenSRF::Utils::SettingsClient
101             ->new
102             ->config_value( dirs => 'xsl' ).
103         "/MARC21slim2MODS.xsl"
104     );
105     # and stash a transformer
106     $record_xslt{mods}{xslt} = $_xslt->parse_stylesheet( $mods_xslt );
107     $record_xslt{mods}{namespace_uri} = 'http://www.loc.gov/mods/';
108     $record_xslt{mods}{docs} = 'http://www.loc.gov/mods/';
109     $record_xslt{mods}{schema_location} = 'http://www.loc.gov/standards/mods/mods.xsd';
110
111     # parse the ATOM entry xslt ...
112     my $atom_xslt = $_parser->parse_file(
113         OpenSRF::Utils::SettingsClient
114             ->new
115             ->config_value( dirs => 'xsl' ).
116         "/MARC21slim2ATOM.xsl"
117     );
118     # and stash a transformer
119     $record_xslt{atom}{xslt} = $_xslt->parse_stylesheet( $atom_xslt );
120     $record_xslt{atom}{namespace_uri} = 'http://www.w3.org/2005/Atom';
121     $record_xslt{atom}{docs} = 'http://www.ietf.org/rfc/rfc4287.txt';
122
123     # parse the RDFDC xslt ...
124     my $rdf_dc_xslt = $_parser->parse_file(
125         OpenSRF::Utils::SettingsClient
126             ->new
127             ->config_value( dirs => 'xsl' ).
128         "/MARC21slim2RDFDC.xsl"
129     );
130     # and stash a transformer
131     $record_xslt{rdf_dc}{xslt} = $_xslt->parse_stylesheet( $rdf_dc_xslt );
132     $record_xslt{rdf_dc}{namespace_uri} = 'http://purl.org/dc/elements/1.1/';
133     $record_xslt{rdf_dc}{schema_location} = 'http://purl.org/dc/elements/1.1/';
134
135     # parse the SRWDC xslt ...
136     my $srw_dc_xslt = $_parser->parse_file(
137         OpenSRF::Utils::SettingsClient
138             ->new
139             ->config_value( dirs => 'xsl' ).
140         "/MARC21slim2SRWDC.xsl"
141     );
142     # and stash a transformer
143     $record_xslt{srw_dc}{xslt} = $_xslt->parse_stylesheet( $srw_dc_xslt );
144     $record_xslt{srw_dc}{namespace_uri} = 'info:srw/schema/1/dc-schema';
145     $record_xslt{srw_dc}{schema_location} = 'http://www.loc.gov/z3950/agency/zing/srw/dc-schema.xsd';
146
147     # parse the OAIDC xslt ...
148     my $oai_dc_xslt = $_parser->parse_file(
149         OpenSRF::Utils::SettingsClient
150             ->new
151             ->config_value( dirs => 'xsl' ).
152         "/MARC21slim2OAIDC.xsl"
153     );
154     # and stash a transformer
155     $record_xslt{oai_dc}{xslt} = $_xslt->parse_stylesheet( $oai_dc_xslt );
156     $record_xslt{oai_dc}{namespace_uri} = 'http://www.openarchives.org/OAI/2.0/oai_dc/';
157     $record_xslt{oai_dc}{schema_location} = 'http://www.openarchives.org/OAI/2.0/oai_dc.xsd';
158
159     # parse the RSS xslt ...
160     my $rss_xslt = $_parser->parse_file(
161         OpenSRF::Utils::SettingsClient
162             ->new
163             ->config_value( dirs => 'xsl' ).
164         "/MARC21slim2RSS2.xsl"
165     );
166     # and stash a transformer
167     $record_xslt{rss2}{xslt} = $_xslt->parse_stylesheet( $rss_xslt );
168
169     # parse the FGDC xslt ...
170     my $fgdc_xslt = $_parser->parse_file(
171         OpenSRF::Utils::SettingsClient
172             ->new
173             ->config_value( dirs => 'xsl' ).
174         "/MARC21slim2FGDC.xsl"
175     );
176     # and stash a transformer
177     $record_xslt{fgdc}{xslt} = $_xslt->parse_stylesheet( $fgdc_xslt );
178     $record_xslt{fgdc}{docs} = 'http://www.fgdc.gov/metadata/csdgm/index_html';
179     $record_xslt{fgdc}{schema_location} = 'http://www.fgdc.gov/metadata/fgdc-std-001-1998.xsd';
180
181     register_record_transforms();
182
183     register_new_authorities_methods();
184
185     return 1;
186 }
187
188 sub register_record_transforms {
189     for my $type ( keys %record_xslt ) {
190         __PACKAGE__->register_method(
191             method    => 'retrieve_record_transform',
192             api_name  => "open-ils.supercat.record.$type.retrieve",
193             api_level => 1,
194             argc      => 1,
195             signature =>
196                 { desc     => "Returns the \U$type\E representation ".
197                               "of the requested bibliographic record",
198                   params   =>
199                     [
200                         { name => 'bibId',
201                           desc => 'An OpenILS biblio::record_entry id',
202                           type => 'number' },
203                     ],
204                 'return' =>
205                     { desc => "The bib record in \U$type\E",
206                       type => 'string' }
207                 }
208         );
209
210         __PACKAGE__->register_method(
211             method    => 'retrieve_isbn_transform',
212             api_name  => "open-ils.supercat.isbn.$type.retrieve",
213             api_level => 1,
214             argc      => 1,
215             signature =>
216                 { desc     => "Returns the \U$type\E representation ".
217                               "of the requested bibliographic record",
218                   params   =>
219                     [
220                         { name => 'isbn',
221                           desc => 'An ISBN',
222                           type => 'string' },
223                     ],
224                 'return' =>
225                     { desc => "The bib record in \U$type\E",
226                       type => 'string' }
227                 }
228         );
229     }
230 }
231
232 sub register_new_authorities_methods {
233     my %register_args = (
234         method    => "generic_new_authorities_method",
235         api_level => 1,
236         argc      => 1,
237         signature => {
238             desc => q/Generated method/,
239             params => [
240                 {name => "what",
241                     desc => "An axis, an authority tag number, or a bibliographic tag number, depending on invocation",
242                     type => "string"},
243                 {name => "term",
244                     desc => "A search term",
245                     type => "string"},
246                 {name => "page",
247                     desc => "zero-based page number of results",
248                     type => "number"},
249                 {name => "page size",
250                     desc => "number of results per page",
251                     type => "number"}
252             ],
253             return => {
254                 desc => "A list of authority record IDs", type => "array"
255             }
256         }
257     );
258
259     foreach my $how (qw/axis atag btag/) {
260         foreach my $action (qw/browse_center browse_top
261             search_rank search_heading/) {
262
263             $register_args{api_name} =
264                 "open-ils.supercat.authority.$action.by_$how";
265             __PACKAGE__->register_method(%register_args);
266
267             $register_args{api_name} =
268                 "open-ils.supercat.authority.$action.by_$how.refs";
269             __PACKAGE__->register_method(%register_args);
270
271         }
272     }
273 }
274
275 sub generic_new_authorities_method {
276     my $self = shift;
277     my $client = shift;
278
279     # We want to be extra careful with these arguments, since the next
280     # thing we're doing with them is passing them to a DB procedure.
281     my $what = ''.shift;
282     my $term = ''.shift;
283     my $page = int(shift || 0);
284     my $page_size = shift;
285     my $thesauruses = shift;
286
287     # undef ok, but other non numbers not ok
288     $page_size = int($page_size) if defined $page_size;
289
290     # Figure out how we were called and what DB procedure we'll call in turn.
291     $self->api_name =~ /\.by_(\w+)($|\.)/;
292     my $metaaxis = $1;
293     my $refs = $2;
294
295     $self->api_name =~ /authority\.(\w+)\./;
296     my $action = $1;
297
298     my $method = "${metaaxis}_$action";
299     $method .= "_refs" if $refs;
300
301     # Match authority.full_rec normalization
302     # XXX don't know whether we need second arg 'subfield'?
303     $term = naco_normalize($term);
304
305     my $storage = create OpenSRF::AppSession("open-ils.storage");
306     my $list = $storage->request(
307         "open-ils.storage.authority.in_db.browse_or_search",
308         $method, $what, $term, $page, $page_size, $thesauruses
309     )->gather(1);
310
311     $storage->kill_me;
312
313     return $list;
314 }
315
316
317 sub tree_walker {
318     my $tree = shift;
319     my $field = shift;
320     my $filter = shift;
321
322     return unless ($tree && ref($tree->$field));
323
324     my @things = $filter->($tree);
325     for my $v ( @{$tree->$field} ){
326         push @things, $filter->($v);
327         push @things, tree_walker($v, $field, $filter);
328     }
329     return @things
330 }
331
332 # find a label_sortkey for a call number with a label which is equal
333 # (or close to) a given label value
334 sub _label_sortkey_from_label {
335     my ($label, $_storage, $ou_ids, $cp_filter) = @_;
336
337     my $closest_cn = $_storage->request(
338             "open-ils.cstore.direct.asset.call_number.search.atomic",
339             { label      => { ">=" => { transform => "oils_text_as_bytea", value => ["oils_text_as_bytea", $label] } },
340               (scalar(@$ou_ids) ? (owning_lib => $ou_ids) : ()),
341               deleted    => 'f',
342               @$cp_filter
343             },
344             { flesh     => 1,
345               flesh_fields  => { acn => [qw/label_class/] },
346               limit     => 1,
347               order_by  => { acn => "oils_text_as_bytea(label), id" }
348             }
349         )->gather(1);
350     if (@$closest_cn) {
351         if ($closest_cn->[0]->label eq $label) {
352             # we found an exact match stop here
353             return $closest_cn->[0]->label_sortkey;
354         } else {
355             # we got as close as we could by label alone, let's try to
356             # normalize and get closer
357             $closest_cn = $_storage->request(
358                 "open-ils.cstore.direct.asset.call_number.search.atomic",
359                 { label_sortkey
360                              => { ">=" => [$closest_cn->[0]->label_class->normalizer, $label] },
361                   (scalar(@$ou_ids) ? (owning_lib => $ou_ids) : ()),
362                   deleted    => 'f',
363                   @$cp_filter
364                 },
365                 { limit     => 1,
366                   order_by  => { acn => "label_sortkey, id" }
367                 }
368             )->gather(1);
369             if (@$closest_cn) {
370                 return $closest_cn->[0]->label_sortkey;
371             }
372         }
373     }
374
375     return '~~~'; #fallback to high ascii value, we are at the end of the range
376 }
377
378 sub cn_browse {
379     my $self = shift;
380     my $client = shift;
381
382     my $label = shift;
383     my $ou = shift;
384     my $page_size = shift || 9;
385     my $page = shift || 0;
386     my $statuses = shift || [];
387     my $copy_locations = shift || [];
388
389     my ($before_limit,$after_limit) = (0,0);
390     my ($before_offset,$after_offset) = (0,0);
391
392     if (!$page) {
393         $before_limit = $after_limit = int($page_size / 2);
394         $after_limit += 1 if ($page_size % 2);
395     } else {
396         $before_offset = $after_offset = int($page_size / 2);
397         $before_offset += 1 if ($page_size % 2);
398         $before_limit = $after_limit = $page_size;
399     }
400
401     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
402
403     my @ou_ids;
404     # if OU is not specified, or if '-' is specified, do not enter the block
405     unless (!$ou || $ou eq '-') {
406         # check if the shortname of the top org_unit is specified
407             my $top_org = $_storage->request(
408             "open-ils.cstore.direct.actor.org_unit.search",
409              { parent_ou => undef }
410             )->gather(1);
411
412         if ($ou eq $top_org->shortname) {
413                 $logger->debug("Searching for CNs at top org $ou");
414             } else {
415             my $o_search = { shortname => $ou };
416
417             my $orgs = $_storage->request(
418                 "open-ils.cstore.direct.actor.org_unit.search",
419                 $o_search,
420                 { flesh     => 100,
421                 flesh_fields  => { aou    => [qw/children/] }
422                 }
423             )->gather(1);
424
425             @ou_ids = tree_walker($orgs, 'children', sub {shift->id}) if $orgs;
426
427             $logger->debug("Searching for CNs at orgs [".join(',',@ou_ids)."], based on $ou");
428         }
429     }
430
431     my @list = ();
432
433     my @cp_filter = ();
434     if (@$statuses || @$copy_locations) {
435         @cp_filter = (
436             '-exists' => {
437                 limit => 1,
438                 from  => 'acp',
439                 where => {
440                     call_number => { '=' => { '+acn' => 'id' } },
441                     deleted     => 'f',
442                     ((@$statuses)       ? ( status   => $statuses)       : ()),
443                     ((@$copy_locations) ? ( location => $copy_locations) : ())
444                 }
445             }
446         );
447     }
448
449     my $label_sortkey = _label_sortkey_from_label($label, $_storage, \@ou_ids, \@cp_filter);
450
451     if ($page <= 0) {
452         my $before = $_storage->request(
453             "open-ils.cstore.direct.asset.call_number.search.atomic",
454             { label_sortkey => { "<" => { transform => "oils_text_as_bytea", value => ["oils_text_as_bytea", $label_sortkey] } },
455               (scalar(@ou_ids) ? (owning_lib => \@ou_ids) : ()),
456               deleted => 'f',
457               @cp_filter
458             },
459             { flesh     => 1,
460               flesh_fields  => { acn => [qw/record owning_lib prefix suffix/] },
461               order_by  => { acn => "oils_text_as_bytea(label_sortkey) desc, oils_text_as_bytea(label) desc, id desc, owning_lib desc" },
462               limit     => $before_limit,
463               offset    => abs($page) * $page_size - $before_offset,
464             }
465         )->gather(1);
466         push @list, reverse(@$before);
467     }
468
469     if ($page >= 0) {
470         my $after = $_storage->request(
471             "open-ils.cstore.direct.asset.call_number.search.atomic",
472             { label_sortkey => { ">=" => { transform => "oils_text_as_bytea", value => ["oils_text_as_bytea", $label_sortkey] } },
473               (scalar(@ou_ids) ? (owning_lib => \@ou_ids) : ()),
474               deleted => 'f',
475               @cp_filter
476             },
477             { flesh     => 1,
478               flesh_fields  => { acn => [qw/record owning_lib prefix suffix/] },
479               order_by  => { acn => "oils_text_as_bytea(label_sortkey), oils_text_as_bytea(label), id, owning_lib" },
480               limit     => $after_limit,
481               offset    => abs($page) * $page_size - $after_offset,
482             }
483         )->gather(1);
484         push @list, @$after;
485     }
486
487     return \@list;
488 }
489 __PACKAGE__->register_method(
490     method    => 'cn_browse',
491     api_name  => 'open-ils.supercat.call_number.browse',
492     api_level => 1,
493     argc      => 1,
494     signature =>
495         { desc     => <<"          DESC",
496 Returns the XML representation of the requested bibliographic record's holdings
497           DESC
498           params   =>
499             [
500                 { name => 'label',
501                   desc => 'The target call number label',
502                   type => 'string' },
503                 { name => 'org_unit',
504                   desc => 'The org unit shortname (or "-" or undef for global) to browse',
505                   type => 'string' },
506                 { name => 'page_size',
507                   desc => 'Count of call numbers to retrieve, default is 9',
508                   type => 'number' },
509                 { name => 'page',
510                   desc => 'The page of call numbers to retrieve, calculated based on page_size.  Can be positive, negative or 0.',
511                   type => 'number' },
512                 { name => 'statuses',
513                   desc => 'Array of statuses to filter copies by, optional and can be undef.',
514                   type => 'array' },
515                 { name => 'locations',
516                   desc => 'Array of copy locations to filter copies by, optional and can be undef.',
517                   type => 'array' },
518             ],
519           'return' =>
520             { desc => 'Call numbers with owning_lib and record fleshed',
521               type => 'array' }
522         }
523 );
524
525 sub cn_startwith {
526     my $self = shift;
527     my $client = shift;
528
529     my $label = shift;
530     my $ou = shift;
531     my $limit = shift || 10;
532     my $page = shift || 0;
533     my $statuses = shift || [];
534     my $copy_locations = shift || [];
535
536
537     my $offset = abs($page) * $limit;
538     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
539
540     my $o_search = { shortname => $ou };
541     if (!$ou || $ou eq '-') {
542         $o_search = { parent_ou => undef };
543     }
544
545     my $orgs = $_storage->request(
546         "open-ils.cstore.direct.actor.org_unit.search",
547         $o_search,
548         { flesh     => 100,
549           flesh_fields  => { aou    => [qw/children/] }
550         }
551     )->gather(1);
552
553     my @ou_ids = tree_walker($orgs, 'children', sub {shift->id}) if $orgs;
554
555     $logger->debug("Searching for CNs at orgs [".join(',',@ou_ids)."], based on $ou");
556
557     my @list = ();
558
559     my @cp_filter = ();
560     if (@$statuses || @$copy_locations) {
561         @cp_filter = (
562             '-exists' => {
563                 limit => 1,
564                 from  => 'acp',
565                 where => {
566                     call_number => { '=' => { '+acn' => 'id' } },
567                     deleted     => 'f',
568                     ((@$statuses)       ? ( status   => $statuses)       : ()),
569                     ((@$copy_locations) ? ( location => $copy_locations) : ())
570                 }
571             }
572         );
573     }
574
575     my $label_sortkey = _label_sortkey_from_label($label, $_storage, \@ou_ids, \@cp_filter);
576
577     if ($page < 0) {
578         my $before = $_storage->request(
579             "open-ils.cstore.direct.asset.call_number.search.atomic",
580             { label_sortkey => { "<" => { transform => "oils_text_as_bytea", value => ["oils_text_as_bytea", $label_sortkey] } },
581               owning_lib    => \@ou_ids,
582               deleted => 'f',
583               @cp_filter
584             },
585             { flesh     => 1,
586               flesh_fields  => { acn => [qw/record owning_lib prefix suffix/] },
587               order_by  => { acn => "oils_text_as_bytea(label_sortkey) desc, oils_text_as_bytea(label) desc, id desc, owning_lib desc" },
588               limit     => $limit,
589               offset    => $offset,
590             }
591         )->gather(1);
592         push @list, reverse(@$before);
593     }
594
595     if ($page >= 0) {
596         my $after = $_storage->request(
597             "open-ils.cstore.direct.asset.call_number.search.atomic",
598             { label_sortkey => { ">=" => { transform => "oils_text_as_bytea", value => ["oils_text_as_bytea", $label_sortkey] } },
599               owning_lib    => \@ou_ids,
600               deleted => 'f',
601               @cp_filter
602             },
603             { flesh     => 1,
604               flesh_fields  => { acn => [qw/record owning_lib prefix suffix/] },
605               order_by  => { acn => "oils_text_as_bytea(label_sortkey), oils_text_as_bytea(label), id, owning_lib" },
606               limit     => $limit,
607               offset    => $offset,
608             }
609         )->gather(1);
610         push @list, @$after;
611     }
612
613     return \@list;
614 }
615 __PACKAGE__->register_method(
616     method    => 'cn_startwith',
617     api_name  => 'open-ils.supercat.call_number.startwith',
618     api_level => 1,
619     argc      => 1,
620     signature =>
621         { desc     => <<"          DESC",
622 Returns the XML representation of the requested bibliographic record's holdings
623           DESC
624           params   =>
625             [
626                 { name => 'label',
627                   desc => 'The target call number label',
628                   type => 'string' },
629                 { name => 'org_unit',
630                   desc => 'The org unit shortname (or "-" or undef for global) to browse',
631                   type => 'string' },
632                 { name => 'page_size',
633                   desc => 'Count of call numbers to retrieve, default is 9',
634                   type => 'number' },
635                 { name => 'page',
636                   desc => 'The page of call numbers to retrieve, calculated based on page_size.  Can be positive, negative or 0.',
637                   type => 'number' },
638                 { name => 'statuses',
639                   desc => 'Array of statuses to filter copies by, optional and can be undef.',
640                   type => 'array' },
641                 { name => 'locations',
642                   desc => 'Array of copy locations to filter copies by, optional and can be undef.',
643                   type => 'array' },
644             ],
645           'return' =>
646             { desc => 'Call numbers with owning_lib and record fleshed',
647               type => 'array' }
648         }
649 );
650
651
652 sub new_books_by_item {
653     my $self = shift;
654     my $client = shift;
655
656     my $ou = shift;
657     my $page_size = shift || 10;
658     my $page = shift || 1;
659     my $statuses = shift || [];
660     my $copy_locations = shift || [];
661
662     my $offset = $page_size * ($page - 1);
663
664     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
665
666     my @ou_ids;
667     if ($ou && $ou ne '-') {
668         my $orgs = $_storage->request(
669             "open-ils.cstore.direct.actor.org_unit.search",
670             { shortname => $ou },
671             { flesh     => 100,
672               flesh_fields  => { aou    => [qw/children/] }
673             }
674         )->gather(1);
675         @ou_ids = tree_walker($orgs, 'children', sub {shift->id}) if $orgs;
676     }
677
678     $logger->debug("Searching for records with new copies at orgs [".join(',',@ou_ids)."], based on $ou");
679     my $cns = $_storage->request(
680         "open-ils.cstore.json_query.atomic",
681         { select    => { acn => ['record'],
682                          acp => [{ aggregate => 1 => transform => max => column => create_date => alias => 'create_date'}]
683                        },
684           from      => { 'acn' => { 'acp' => { field => call_number => fkey => 'id' } } },
685           where     =>
686             { '+acp' =>
687                 { deleted => 'f',
688                   ((@ou_ids)          ? ( circ_lib => \@ou_ids)        : ()),
689                   ((@$statuses)       ? ( status   => $statuses)       : ()),
690                   ((@$copy_locations) ? ( location => $copy_locations) : ())
691                 }, 
692               '+acn' => { record => { '>' => 0 } },
693             }, 
694           order_by  => { acp => { create_date => { transform => 'max', direction => 'desc' } } },
695           limit     => $page_size,
696           offset    => $offset
697         }
698     )->gather(1);
699
700     return [ map { $_->{record} } @$cns ];
701 }
702 __PACKAGE__->register_method(
703     method    => 'new_books_by_item',
704     api_name  => 'open-ils.supercat.new_book_list',
705     api_level => 1,
706     argc      => 1,
707     signature =>
708         { desc     => <<"          DESC",
709 Returns the XML representation of the requested bibliographic record's holdings
710           DESC
711           params   =>
712             [
713                 { name => 'org_unit',
714                   desc => 'The org unit shortname (or "-" or undef for global) to list',
715                   type => 'string' },
716                 { name => 'page_size',
717                   desc => 'Count of records to retrieve, default is 10',
718                   type => 'number' },
719                 { name => 'page',
720                   desc => 'The page of records to retrieve, calculated based on page_size.  Starts at 1.',
721                   type => 'number' },
722                 { name => 'statuses',
723                   desc => 'Array of statuses to filter copies by, optional and can be undef.',
724                   type => 'array' },
725                 { name => 'locations',
726                   desc => 'Array of copy locations to filter copies by, optional and can be undef.',
727                   type => 'array' },
728             ],
729           'return' =>
730             { desc => 'Record IDs',
731               type => 'array' }
732         }
733 );
734
735 sub u2 {
736     my $self = shift;
737     my $client = shift;
738
739     my $u2 = shift;
740     my $format = shift || 'xml';
741
742     $u2 = OpenILS::Utils::TagURI->new($u2);
743     return '' unless $u2;
744
745     # Use pathinfo on acp as a lookup type specifier.
746     if ($u2->classname eq 'acp' and $u2->pathinfo =~ /\bbarcode\b/) {
747         my( $copy, $evt ) = $U->fetch_copy_by_barcode( $u2->id );
748         $u2->id( $copy->id );
749     }
750
751     if ($u2->classname eq 'biblio_record_entry_feed') {
752         $u2->id( '{' . $u2->id . '}' );
753     }
754     my $args = [
755         'unapi.' . $u2->classname,
756         $u2->id,
757         $format,
758     ];
759     push @$args, $u2->classname unless $u2->classname eq 'biblio_record_entry_feed';
760     push @$args, '{' . ( $u2->includes ? join( ',', keys %{ $u2->includes } ) : '' ) . '}';
761     push @$args, ($u2->location || undef);
762     push @$args, ($u2->depth || undef);
763
764     return OpenSRF::AppSession->create('open-ils.cstore')->request(
765         "open-ils.cstore.json_query.atomic",
766         { from => $args }
767     )->gather(1)->[0]{'unapi.'. $u2->classname};
768 }
769 __PACKAGE__->register_method(
770     method    => 'u2',
771     api_name  => 'open-ils.supercat.u2',
772     api_level => 1,
773     argc      => 2,
774     signature =>
775         { desc     => <<"          DESC",
776 Returns the XML representation of the requested object
777           DESC
778           params   =>
779             [
780                 { name => 'u2',
781                   desc => 'The U2 Tag URI (OpenILS::Utils::TagURI)',
782                   type => 'object' },
783                 { name => 'format',
784                   desc => 'For bre and bre feeds, the xml transform format',
785                   type => 'string' }
786             ],
787           'return' =>
788             { desc => 'XML (or transformed) object data',
789               type => 'string' }
790         }
791 );
792
793
794 sub general_browse {
795     my $self = shift;
796     my $client = shift;
797     return tag_sf_browse($self, $client, $self->{tag}, $self->{subfield}, @_);
798 }
799 __PACKAGE__->register_method(
800     method    => 'general_browse',
801     api_name  => 'open-ils.supercat.title.browse',
802     tag       => 'tnf', subfield => 'a',
803     api_level => 1,
804     argc      => 1,
805     signature =>
806         { desc     => "Returns a list of the requested org-scoped record IDs held",
807           params   =>
808             [ { name => 'value', desc => 'The target title', type => 'string' },
809               { name => 'org_unit', desc => 'The org unit shortname (or "-" or undef for global) to browse', type => 'string' },
810               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
811               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' },
812               { name => 'statuses', desc => 'Array of statuses to filter copies by, optional and can be undef.', type => 'array' },
813               { name => 'locations', desc => 'Array of copy locations to filter copies by, optional and can be undef.', type => 'array' }, ],
814           'return' => { desc => 'Record IDs that have copies at the relevant org units', type => 'array' }
815         }
816 );
817 __PACKAGE__->register_method(
818     method    => 'general_browse',
819     api_name  => 'open-ils.supercat.author.browse',
820     tag       => [qw/100 110 111/], subfield => 'a',
821     api_level => 1,
822     argc      => 1,
823     signature =>
824         { desc     => "Returns a list of the requested org-scoped record IDs held",
825           params   =>
826             [ { name => 'value', desc => 'The target author', type => 'string' },
827               { name => 'org_unit', desc => 'The org unit shortname (or "-" or undef for global) to browse', type => 'string' },
828               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
829               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' },
830               { name => 'statuses', desc => 'Array of statuses to filter copies by, optional and can be undef.', type => 'array' },
831               { name => 'locations', desc => 'Array of copy locations to filter copies by, optional and can be undef.', type => 'array' }, ],
832           'return' => { desc => 'Record IDs that have copies at the relevant org units', type => 'array' }
833         }
834 );
835 __PACKAGE__->register_method(
836     method    => 'general_browse',
837     api_name  => 'open-ils.supercat.subject.browse',
838     tag       => [qw/600 610 611 630 648 650 651 653 655 656 662 690 691 696 697 698 699/], subfield => 'a',
839     api_level => 1,
840     argc      => 1,
841     signature =>
842         { desc     => "Returns a list of the requested org-scoped record IDs held",
843           params   =>
844             [ { name => 'value', desc => 'The target subject', type => 'string' },
845               { name => 'org_unit', desc => 'The org unit shortname (or "-" or undef for global) to browse', type => 'string' },
846               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
847               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' },
848               { name => 'statuses', desc => 'Array of statuses to filter copies by, optional and can be undef.', type => 'array' },
849               { name => 'locations', desc => 'Array of copy locations to filter copies by, optional and can be undef.', type => 'array' }, ],
850           'return' => { desc => 'Record IDs that have copies at the relevant org units', type => 'array' }
851         }
852 );
853 __PACKAGE__->register_method(
854     method    => 'general_browse',
855     api_name  => 'open-ils.supercat.topic.browse',
856     tag       => [qw/650 690/], subfield => 'a',
857     api_level => 1,
858     argc      => 1,
859     signature =>
860         { desc     => "Returns a list of the requested org-scoped record IDs held",
861           params   =>
862             [ { name => 'value', desc => 'The target topical subject', type => 'string' },
863               { name => 'org_unit', desc => 'The org unit shortname (or "-" or undef for global) to browse', type => 'string' },
864               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
865               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' },
866               { name => 'statuses', desc => 'Array of statuses to filter copies by, optional and can be undef.', type => 'array' },
867               { name => 'locations', desc => 'Array of copy locations to filter copies by, optional and can be undef.', type => 'array' }, ],
868           'return' => { desc => 'Record IDs that have copies at the relevant org units', type => 'array' }
869         }
870 );
871 __PACKAGE__->register_method(
872     method    => 'general_browse',
873     api_name  => 'open-ils.supercat.series.browse',
874     tag       => [qw/440 490 800 810 811 830/], subfield => 'a',
875     api_level => 1,
876     argc      => 1,
877     signature =>
878         { desc     => "Returns a list of the requested org-scoped record IDs held",
879           params   =>
880             [ { name => 'value', desc => 'The target series', type => 'string' },
881               { name => 'org_unit', desc => 'The org unit shortname (or "-" or undef for global) to browse', type => 'string' },
882               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
883               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' },
884               { name => 'statuses', desc => 'Array of statuses to filter copies by, optional and can be undef.', type => 'array' },
885               { name => 'locations', desc => 'Array of copy locations to filter copies by, optional and can be undef.', type => 'array' }, ],
886           'return' => { desc => 'Record IDs that have copies at the relevant org units', type => 'array' }
887         }
888 );
889
890
891 sub tag_sf_browse {
892     my $self = shift;
893     my $client = shift;
894
895     my $tag = shift;
896     my $subfield = shift;
897     my $value = shift;
898     my $ou = shift;
899     my $page_size = shift || 9;
900     my $page = shift || 0;
901     my $statuses = shift || [];
902     my $copy_locations = shift || [];
903
904     my ($before_limit,$after_limit) = (0,0);
905     my ($before_offset,$after_offset) = (0,0);
906
907     if (!$page) {
908         $before_limit = $after_limit = int($page_size / 2);
909         $after_limit += 1 if ($page_size % 2);
910     } else {
911         $before_offset = $after_offset = int($page_size / 2);
912         $before_offset += 1 if ($page_size % 2);
913         $before_limit = $after_limit = $page_size;
914     }
915
916     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
917
918     my @ou_ids;
919     if ($ou && $ou ne '-') {
920         my $orgs = $_storage->request(
921             "open-ils.cstore.direct.actor.org_unit.search",
922             { shortname => $ou },
923             { flesh     => 100,
924               flesh_fields  => { aou    => [qw/children/] }
925             }
926         )->gather(1);
927         @ou_ids = tree_walker($orgs, 'children', sub {shift->id}) if $orgs;
928     }
929
930     $logger->debug("Searching for records at orgs [".join(',',@ou_ids)."], based on $ou");
931
932     my @list = ();
933
934     if ($page <= 0) {
935         my $before = $_storage->request(
936             "open-ils.cstore.json_query.atomic",
937             { select    => { mfr => [qw/record value/] },
938               from      => 'mfr',
939               where     =>
940                 { '+mfr'    =>
941                     { tag   => $tag,
942                       subfield => $subfield,
943                       value => { '<' => lc($value) }
944                     },
945                   '-or' => [
946                     { '-exists' =>
947                         { select=> { acp => [ 'id' ] },
948                           from  => { acn => { acp => { field => 'call_number', fkey => 'id' } } },
949                           where =>
950                             { '+acn' => { record => { '=' => { '+mfr' => 'record' } } },
951                               '+acp' =>
952                                 { deleted => 'f',
953                                   ((@ou_ids)          ? ( circ_lib => \@ou_ids)        : ()),
954                                   ((@$statuses)       ? ( status   => $statuses)       : ()),
955                                   ((@$copy_locations) ? ( location => $copy_locations) : ())
956                                 }
957                             },
958                           limit => 1
959                         }
960                     },
961                     { '-exists' =>
962                         { select=> { auri => [ 'id' ] },
963                           from  => { acn => { auricnm => { field => 'call_number', fkey => 'id', join => { auri => { field => 'id', fkey => 'uri' } } } } },
964                           where =>
965                             { '+acn' => { record => { '=' => { '+mfr' => 'record' } }, (@ou_ids) ? ( owning_lib => \@ou_ids) : () },
966                               '+auri' => { active => 't' }
967                             },
968                           limit => 1
969                         }
970                     }
971                   ]
972                 }, 
973               order_by  => { mfr => { value => 'desc' } },
974               limit     => $before_limit,
975               offset    => abs($page) * $page_size - $before_offset,
976             }
977         )->gather(1);
978         push @list, map { $_->{record} } reverse(@$before);
979     }
980
981     if ($page >= 0) {
982         my $after = $_storage->request(
983             "open-ils.cstore.json_query.atomic",
984             { select    => { mfr => [qw/record value/] },
985               from      => 'mfr',
986               where     =>
987                 { '+mfr'    =>
988                     { tag   => $tag,
989                       subfield => $subfield,
990                       value => { '>=' => lc($value) }
991                     },
992                   '-or' => [
993                     { '-exists' =>
994                         { select=> { acp => [ 'id' ] },
995                           from  => { acn => { acp => { field => 'call_number', fkey => 'id' } } },
996                           where =>
997                             { '+acn' => { record => { '=' => { '+mfr' => 'record' } } },
998                               '+acp' =>
999                                 { deleted => 'f',
1000                                   ((@ou_ids)          ? ( circ_lib => \@ou_ids)        : ()),
1001                                   ((@$statuses)       ? ( status   => $statuses)       : ()),
1002                                   ((@$copy_locations) ? ( location => $copy_locations) : ())
1003                                 }
1004                             },
1005                           limit => 1
1006                         }
1007                     },
1008                     { '-exists' =>
1009                         { select=> { auri => [ 'id' ] },
1010                           from  => { acn => { auricnm => { field => 'call_number', fkey => 'id', join => { auri => { field => 'id', fkey => 'uri' } } } } },
1011                           where =>
1012                             { '+acn' => { record => { '=' => { '+mfr' => 'record' } }, (@ou_ids) ? ( owning_lib => \@ou_ids) : () },
1013                               '+auri' => { active => 't' }
1014                             },
1015                           limit => 1
1016                         },
1017                     }
1018                   ]
1019                 }, 
1020               order_by  => { mfr => { value => 'asc' } },
1021               limit     => $after_limit,
1022               offset    => abs($page) * $page_size - $after_offset,
1023             }
1024         )->gather(1);
1025         push @list, map { $_->{record} } @$after;
1026     }
1027
1028     return \@list;
1029 }
1030 __PACKAGE__->register_method(
1031     method    => 'tag_sf_browse',
1032     api_name  => 'open-ils.supercat.tag.browse',
1033     api_level => 1,
1034     argc      => 1,
1035     signature =>
1036         { desc     => <<"          DESC",
1037 Returns a list of the requested org-scoped record IDs held
1038           DESC
1039           params   =>
1040             [
1041                 { name => 'tag',
1042                   desc => 'The target MARC tag',
1043                   type => 'string' },
1044                 { name => 'subfield',
1045                   desc => 'The target MARC subfield',
1046                   type => 'string' },
1047                 { name => 'value',
1048                   desc => 'The target string',
1049                   type => 'string' },
1050                 { name => 'org_unit',
1051                   desc => 'The org unit shortname (or "-" or undef for global) to browse',
1052                   type => 'string' },
1053                 { name => 'page_size',
1054                   desc => 'Count of call numbers to retrieve, default is 9',
1055                   type => 'number' },
1056                 { name => 'page',
1057                   desc => 'The page of call numbers to retrieve, calculated based on page_size.  Can be positive, negative or 0.',
1058                   type => 'number' },
1059                 { name => 'statuses',
1060                   desc => 'Array of statuses to filter copies by, optional and can be undef.',
1061                   type => 'array' },
1062                 { name => 'locations',
1063                   desc => 'Array of copy locations to filter copies by, optional and can be undef.',
1064                   type => 'array' },
1065             ],
1066           'return' =>
1067             { desc => 'Record IDs that have copies at the relevant org units',
1068               type => 'array' }
1069         }
1070 );
1071
1072 sub grab_authority_browse_axes {
1073     my ($self, $client, $full) = @_;
1074
1075     unless(scalar(keys(%authority_browse_axis_cache))) {
1076         my $axes = new_editor->search_authority_browse_axis([
1077             { code => { '<>' => undef } },
1078             { flesh => 2, flesh_fields => { aba => ['fields'], acsaf => ['bib_fields','sub_entries'] } }
1079         ]);
1080         $authority_browse_axis_cache{$_->code} = $_ for (@$axes);
1081     }
1082
1083     if ($full) {
1084         return [
1085             map { $authority_browse_axis_cache{$_} } sort keys %authority_browse_axis_cache
1086         ];
1087     } else {
1088         return [keys %authority_browse_axis_cache];
1089     }
1090 }
1091 __PACKAGE__->register_method(
1092     method    => 'grab_authority_browse_axes',
1093     api_name  => 'open-ils.supercat.authority.browse_axis_list',
1094     api_level => 1,
1095     argc      => 1,
1096     signature =>
1097         { desc     => "Returns a list of valid authority browse/startswith axes",
1098           params   => [
1099               { name => 'full', desc => 'Optional. If true, return array containing the full object for each axis, sorted by code. Otherwise just return an array of the codes.', type => 'number' }
1100           ],
1101           'return' => { desc => 'Axis codes or whole axes, see "full" param', type => 'array' }
1102         }
1103 );
1104
1105 sub axis_authority_browse {
1106     my $self = shift;
1107     my $client = shift;
1108     my $axis = shift;
1109
1110     $axis =~ s/^authority\.//;
1111     $axis =~ s/(\.refs)$//;
1112     my $refs = $1;
1113
1114     return undef unless ( grep { /$axis/ } @{ grab_authority_browse_axes() } );
1115
1116     my @tags;
1117     for my $f (@{$authority_browse_axis_cache{$axis}->fields}) {
1118         push @tags, $f->tag;
1119         if ($refs) {
1120             push @tags, $_->tag for @{$f->sub_entries};
1121         }
1122     }
1123
1124     return authority_tag_sf_browse($self, $client, \@tags, 'a', @_); # XXX TODO figure out something more correct for the subfield param
1125 }
1126 __PACKAGE__->register_method(
1127     method    => 'axis_authority_browse',
1128     api_name  => 'open-ils.supercat.authority.browse.by_axis',
1129     api_level => 1,
1130     argc      => 2,
1131     signature =>
1132         { desc     => "Returns a list of the requested authority record IDs held",
1133           params   =>
1134             [ { name => 'axis', desc => 'The target axis', type => 'string' },
1135               { name => 'value', desc => 'The target value', type => 'string' },
1136               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1137               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1138           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1139         }
1140 );
1141
1142 =pod
1143
1144 sub general_authority_browse {
1145     my $self = shift;
1146     my $client = shift;
1147     return authority_tag_sf_browse($self, $client, $self->{tag}, $self->{subfield}, @_);
1148 }
1149 __PACKAGE__->register_method(
1150     method    => 'general_authority_browse',
1151     api_name  => 'open-ils.supercat.authority.title.browse',
1152     tag       => ['130'], subfield => 'a',
1153     api_level => 1,
1154     argc      => 1,
1155     signature =>
1156         { desc     => "Returns a list of the requested authority record IDs held",
1157           params   =>
1158             [ { name => 'value', desc => 'The target title', type => 'string' },
1159               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1160               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1161           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1162         }
1163 );
1164 __PACKAGE__->register_method(
1165     method    => 'general_authority_browse',
1166     api_name  => 'open-ils.supercat.authority.author.browse',
1167     tag       => [qw/100 110 111/], subfield => 'a',
1168     api_level => 1,
1169     argc      => 1,
1170     signature =>
1171         { desc     => "Returns a list of the requested authority record IDs held",
1172           params   =>
1173             [ { name => 'value', desc => 'The target author', type => 'string' },
1174               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1175               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1176           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1177         }
1178 );
1179 __PACKAGE__->register_method(
1180     method    => 'general_authority_browse',
1181     api_name  => 'open-ils.supercat.authority.subject.browse',
1182     tag       => [qw/148 150 151 155/], subfield => 'a',
1183     api_level => 1,
1184     argc      => 1,
1185     signature =>
1186         { desc     => "Returns a list of the requested authority record IDs held",
1187           params   =>
1188             [ { name => 'value', desc => 'The target subject', type => 'string' },
1189               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1190               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1191           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1192         }
1193 );
1194 __PACKAGE__->register_method(
1195     method    => 'general_authority_browse',
1196     api_name  => 'open-ils.supercat.authority.topic.browse',
1197     tag       => ['150'], subfield => 'a',
1198     api_level => 1,
1199     argc      => 1,
1200     signature =>
1201         { desc     => "Returns a list of the requested authority record IDs held",
1202           params   =>
1203             [ { name => 'value', desc => 'The target topical subject', type => 'string' },
1204               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1205               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1206           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1207         }
1208 );
1209 __PACKAGE__->register_method(
1210     method    => 'general_authority_browse',
1211     api_name  => 'open-ils.supercat.authority.title.refs.browse',
1212     tag       => ['130'], subfield => 'a',
1213     api_level => 1,
1214     argc      => 1,
1215     signature =>
1216         { desc     => "Returns a list of the requested authority record IDs held, including see (4xx) and see also (5xx) references",
1217           params   =>
1218             [ { name => 'value', desc => 'The target title', type => 'string' },
1219               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1220               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1221           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1222         }
1223 );
1224 __PACKAGE__->register_method(
1225     method    => 'general_authority_browse',
1226     api_name  => 'open-ils.supercat.authority.author.refs.browse',
1227     tag       => [qw/100 110 111/], subfield => 'a',
1228     api_level => 1,
1229     argc      => 1,
1230     signature =>
1231         { desc     => "Returns a list of the requested authority record IDs held, including see (4xx) and see also (5xx) references",
1232           params   =>
1233             [ { name => 'value', desc => 'The target author', type => 'string' },
1234               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1235               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1236           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1237         }
1238 );
1239 __PACKAGE__->register_method(
1240     method    => 'general_authority_browse',
1241     api_name  => 'open-ils.supercat.authority.subject.refs.browse',
1242     tag       => [qw/148 150 151 155/], subfield => 'a',
1243     api_level => 1,
1244     argc      => 1,
1245     signature =>
1246         { desc     => "Returns a list of the requested authority record IDs held, including see (4xx) and see also (5xx) references",
1247           params   =>
1248             [ { name => 'value', desc => 'The target subject', type => 'string' },
1249               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1250               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1251           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1252         }
1253 );
1254 __PACKAGE__->register_method(
1255     method    => 'general_authority_browse',
1256     api_name  => 'open-ils.supercat.authority.topic.refs.browse',
1257     tag       => ['150'], subfield => 'a',
1258     api_level => 1,
1259     argc      => 1,
1260     signature =>
1261         { desc     => "Returns a list of the requested authority record IDs held, including see (4xx) and see also (5xx) references",
1262           params   =>
1263             [ { name => 'value', desc => 'The target topical subject', type => 'string' },
1264               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1265               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1266           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1267         }
1268 );
1269
1270 =cut
1271
1272 sub authority_tag_sf_browse {
1273     my $self = shift;
1274     my $client = shift;
1275
1276     my $tag = shift;
1277     my $subfield = shift;
1278     my $value = shift;
1279     my $page_size = shift || 9;
1280     my $page = shift || 0;
1281
1282     # Match authority.full_rec normalization
1283     $value = naco_normalize($value, $subfield);
1284
1285     my ($before_limit,$after_limit) = (0,0);
1286     my ($before_offset,$after_offset) = (0,0);
1287
1288     if (!$page) {
1289         $before_limit = $after_limit = int($page_size / 2);
1290         $after_limit += 1 if ($page_size % 2);
1291     } else {
1292         $before_offset = $after_offset = int($page_size / 2);
1293         $before_offset += 1 if ($page_size % 2);
1294         $before_limit = $after_limit = $page_size;
1295     }
1296
1297     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
1298
1299     # .refs variant includes 4xx and 5xx variants for see / see also
1300     my @ref_tags = ();
1301     foreach my $tagname (@$tag) {
1302         push(@ref_tags, $tagname);
1303         if ($self->api_name =~ /\.refs\./) {
1304             push(@ref_tags, '4' . substr($tagname, 1, 2));
1305             push(@ref_tags, '5' . substr($tagname, 1, 2));
1306         }
1307     }
1308     my @list = ();
1309
1310     if ($page <= 0) {
1311         my $before = $_storage->request(
1312             "open-ils.cstore.json_query.atomic",
1313             { select    => { afr => [qw/record value/] },
1314               from      => 'afr',
1315               where     => { tag => \@ref_tags, subfield => $subfield, value => { '<' => $value } },
1316               order_by  => { afr => { value => 'desc' } },
1317               limit     => $before_limit,
1318               offset    => abs($page) * $page_size - $before_offset,
1319             }
1320         )->gather(1);
1321         push @list, map { $_->{record} } reverse(@$before);
1322     }
1323
1324     if ($page >= 0) {
1325         my $after = $_storage->request(
1326             "open-ils.cstore.json_query.atomic",
1327             { select    => { afr => [qw/record value/] },
1328               from      => 'afr',
1329               where     => { tag => \@ref_tags, subfield => $subfield, value => { '>=' => $value } },
1330               order_by  => { afr => { value => 'asc' } },
1331               limit     => $after_limit,
1332               offset    => abs($page) * $page_size - $after_offset,
1333             }
1334         )->gather(1);
1335         push @list, map { $_->{record} } @$after;
1336     }
1337
1338     # If we're not pulling in see/see also references, just return the raw list
1339     if ($self->api_name !~ /\.refs\./) {
1340         return \@list;
1341     } 
1342
1343     # Remove dupe record IDs that turn up due to 4xx and 5xx matches
1344     my @retlist = ();
1345     my %seen;
1346     foreach my $record (@list) {
1347         next if exists $seen{$record};
1348         push @retlist, int($record);
1349         $seen{$record} = 1;
1350     }
1351
1352     return \@retlist;
1353 }
1354 __PACKAGE__->register_method(
1355     method    => 'authority_tag_sf_browse',
1356     api_name  => 'open-ils.supercat.authority.tag.browse',
1357     api_level => 1,
1358     argc      => 1,
1359     signature =>
1360         { desc     => <<"          DESC",
1361 Returns a list of the requested authority record IDs held
1362           DESC
1363           params   =>
1364             [
1365                 { name => 'tag',
1366                   desc => 'The target Authority MARC tag',
1367                   type => 'string' },
1368                 { name => 'subfield',
1369                   desc => 'The target Authority MARC subfield',
1370                   type => 'string' },
1371                 { name => 'value',
1372                   desc => 'The target string',
1373                   type => 'string' },
1374                 { name => 'page_size',
1375                   desc => 'Count of call numbers to retrieve, default is 9',
1376                   type => 'number' },
1377                 { name => 'page',
1378                   desc => 'The page of call numbers to retrieve, calculated based on page_size.  Can be positive, negative or 0.',
1379                   type => 'number' },
1380             ],
1381           'return' =>
1382             { desc => 'Authority Record IDs that are near the target string',
1383               type => 'array' }
1384         }
1385 );
1386
1387 sub general_startwith {
1388     my $self = shift;
1389     my $client = shift;
1390     return tag_sf_startwith($self, $client, $self->{tag}, $self->{subfield}, @_);
1391 }
1392 __PACKAGE__->register_method(
1393     method    => 'general_startwith',
1394     api_name  => 'open-ils.supercat.title.startwith',
1395     tag       => 'tnf', subfield => 'a',
1396     api_level => 1,
1397     argc      => 1,
1398     signature =>
1399         { desc     => "Returns a list of the requested org-scoped record IDs held",
1400           params   =>
1401             [ { name => 'value', desc => 'The target title', type => 'string' },
1402               { name => 'org_unit', desc => 'The org unit shortname (or "-" or undef for global) to browse', type => 'string' },
1403               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1404               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' },
1405               { name => 'statuses', desc => 'Array of statuses to filter copies by, optional and can be undef.', type => 'array' },
1406               { name => 'locations', desc => 'Array of copy locations to filter copies by, optional and can be undef.', type => 'array' }, ],
1407           'return' => { desc => 'Record IDs that have copies at the relevant org units', type => 'array' }
1408         }
1409 );
1410 __PACKAGE__->register_method(
1411     method    => 'general_startwith',
1412     api_name  => 'open-ils.supercat.author.startwith',
1413     tag       => [qw/100 110 111/], subfield => 'a',
1414     api_level => 1,
1415     argc      => 1,
1416     signature =>
1417         { desc     => "Returns a list of the requested org-scoped record IDs held",
1418           params   =>
1419             [ { name => 'value', desc => 'The target author', type => 'string' },
1420               { name => 'org_unit', desc => 'The org unit shortname (or "-" or undef for global) to browse', type => 'string' },
1421               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1422               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' },
1423               { name => 'statuses', desc => 'Array of statuses to filter copies by, optional and can be undef.', type => 'array' },
1424               { name => 'locations', desc => 'Array of copy locations to filter copies by, optional and can be undef.', type => 'array' }, ],
1425           'return' => { desc => 'Record IDs that have copies at the relevant org units', type => 'array' }
1426         }
1427 );
1428 __PACKAGE__->register_method(
1429     method    => 'general_startwith',
1430     api_name  => 'open-ils.supercat.subject.startwith',
1431     tag       => [qw/600 610 611 630 648 650 651 653 655 656 662 690 691 696 697 698 699/], subfield => 'a',
1432     api_level => 1,
1433     argc      => 1,
1434     signature =>
1435         { desc     => "Returns a list of the requested org-scoped record IDs held",
1436           params   =>
1437             [ { name => 'value', desc => 'The target subject', type => 'string' },
1438               { name => 'org_unit', desc => 'The org unit shortname (or "-" or undef for global) to browse', type => 'string' },
1439               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1440               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' },
1441               { name => 'statuses', desc => 'Array of statuses to filter copies by, optional and can be undef.', type => 'array' },
1442               { name => 'locations', desc => 'Array of copy locations to filter copies by, optional and can be undef.', type => 'array' }, ],
1443           'return' => { desc => 'Record IDs that have copies at the relevant org units', type => 'array' }
1444         }
1445 );
1446 __PACKAGE__->register_method(
1447     method    => 'general_startwith',
1448     api_name  => 'open-ils.supercat.topic.startwith',
1449     tag       => [qw/650 690/], subfield => 'a',
1450     api_level => 1,
1451     argc      => 1,
1452     signature =>
1453         { desc     => "Returns a list of the requested org-scoped record IDs held",
1454           params   =>
1455             [ { name => 'value', desc => 'The target topical subject', type => 'string' },
1456               { name => 'org_unit', desc => 'The org unit shortname (or "-" or undef for global) to browse', type => 'string' },
1457               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1458               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' },
1459               { name => 'statuses', desc => 'Array of statuses to filter copies by, optional and can be undef.', type => 'array' },
1460               { name => 'locations', desc => 'Array of copy locations to filter copies by, optional and can be undef.', type => 'array' }, ],
1461           'return' => { desc => 'Record IDs that have copies at the relevant org units', type => 'array' }
1462         }
1463 );
1464 __PACKAGE__->register_method(
1465     method    => 'general_startwith',
1466     api_name  => 'open-ils.supercat.series.startwith',
1467     tag       => [qw/440 490 800 810 811 830/], subfield => 'a',
1468     api_level => 1,
1469     argc      => 1,
1470     signature =>
1471         { desc     => "Returns a list of the requested org-scoped record IDs held",
1472           params   =>
1473             [ { name => 'value', desc => 'The target series', type => 'string' },
1474               { name => 'org_unit', desc => 'The org unit shortname (or "-" or undef for global) to browse', type => 'string' },
1475               { name => 'page_size', desc => 'Count of records to retrieve, default is 9', type => 'number' },
1476               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' },
1477               { name => 'statuses', desc => 'Array of statuses to filter copies by, optional and can be undef.', type => 'array' },
1478               { name => 'locations', desc => 'Array of copy locations to filter copies by, optional and can be undef.', type => 'array' }, ],
1479           'return' => { desc => 'Record IDs that have copies at the relevant org units', type => 'array' }
1480         }
1481 );
1482
1483
1484 sub tag_sf_startwith {
1485     my $self = shift;
1486     my $client = shift;
1487
1488     my $tag = shift;
1489     my $subfield = shift;
1490     my $value = shift;
1491     my $ou = shift;
1492     my $limit = shift || 10;
1493     my $page = shift || 0;
1494     my $statuses = shift || [];
1495     my $copy_locations = shift || [];
1496
1497     my $offset = $limit * abs($page);
1498     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
1499
1500     my @ou_ids;
1501     if ($ou && $ou ne '-') {
1502         my $orgs = $_storage->request(
1503             "open-ils.cstore.direct.actor.org_unit.search",
1504             { shortname => $ou },
1505             { flesh     => 100,
1506               flesh_fields  => { aou    => [qw/children/] }
1507             }
1508         )->gather(1);
1509         @ou_ids = tree_walker($orgs, 'children', sub {shift->id}) if $orgs;
1510     }
1511
1512     $logger->debug("Searching for records at orgs [".join(',',@ou_ids)."], based on $ou");
1513
1514     my @list = ();
1515
1516     if ($page < 0) {
1517         my $before = $_storage->request(
1518             "open-ils.cstore.json_query.atomic",
1519             { select    => { mfr => [qw/record value/] },
1520               from      => 'mfr',
1521               where     =>
1522                 { '+mfr'    =>
1523                     { tag   => $tag,
1524                       subfield => $subfield,
1525                       value => { '<' => lc($value) }
1526                     },
1527                   '-or' => [
1528                     { '-exists' =>
1529                         { select=> { acp => [ 'id' ] },
1530                           from  => { acn => { acp => { field => 'call_number', fkey => 'id' } } },
1531                           where =>
1532                             { '+acn' => { record => { '=' => { '+mfr' => 'record' } } },
1533                               '+acp' =>
1534                                 { deleted => 'f',
1535                                   ((@ou_ids)          ? ( circ_lib => \@ou_ids)        : ()),
1536                                   ((@$statuses)       ? ( status   => $statuses)       : ()),
1537                                   ((@$copy_locations) ? ( location => $copy_locations) : ())
1538                                 }
1539                             },
1540                           limit => 1
1541                         }
1542                     },
1543                     { '-exists' =>
1544                         { select=> { auri => [ 'id' ] },
1545                           from  => { acn => { auricnm => { field => 'call_number', fkey => 'id', join => { auri => { field => 'id', fkey => 'uri' } } } } },
1546                           where =>
1547                             { '+acn' => { record => { '=' => { '+mfr' => 'record' } }, (@ou_ids) ? ( owning_lib => \@ou_ids) : () },
1548                               '+auri' => { active => 't' }
1549                             },
1550                           limit => 1
1551                         }
1552                     }
1553                   ]
1554                 }, 
1555               order_by  => { mfr => { value => 'desc' } },
1556               limit     => $limit,
1557               offset    => $offset
1558             }
1559         )->gather(1);
1560         push @list, map { $_->{record} } reverse(@$before);
1561     }
1562
1563     if ($page >= 0) {
1564         my $after = $_storage->request(
1565             "open-ils.cstore.json_query.atomic",
1566             { select    => { mfr => [qw/record value/] },
1567               from      => 'mfr',
1568               where     =>
1569                 { '+mfr'    =>
1570                     { tag   => $tag,
1571                       subfield => $subfield,
1572                       value => { '>=' => lc($value) }
1573                     },
1574                   '-or' => [
1575                     { '-exists' =>
1576                         { select=> { acp => [ 'id' ] },
1577                           from  => { acn => { acp => { field => 'call_number', fkey => 'id' } } },
1578                           where =>
1579                             { '+acn' => { record => { '=' => { '+mfr' => 'record' } } },
1580                               '+acp' =>
1581                                 { deleted => 'f',
1582                                   ((@ou_ids)          ? ( circ_lib => \@ou_ids)        : ()),
1583                                   ((@$statuses)       ? ( status   => $statuses)       : ()),
1584                                   ((@$copy_locations) ? ( location => $copy_locations) : ())
1585                                 }
1586                             },
1587                           limit => 1
1588                         }
1589                     },
1590                     { '-exists' =>
1591                         { select=> { auri => [ 'id' ] },
1592                           from  => { acn => { auricnm => { field => 'call_number', fkey => 'id', join => { auri => { field => 'id', fkey => 'uri' } } } } },
1593                           where =>
1594                             { '+acn' => { record => { '=' => { '+mfr' => 'record' } }, (@ou_ids) ? ( owning_lib => \@ou_ids) : () },
1595                               '+auri' => { active => 't' }
1596                             },
1597                           limit => 1
1598                         },
1599                     }
1600                   ]
1601                 }, 
1602               order_by  => { mfr => { value => 'asc' } },
1603               limit     => $limit,
1604               offset    => $offset
1605             }
1606         )->gather(1);
1607         push @list, map { $_->{record} } @$after;
1608     }
1609
1610     return \@list;
1611 }
1612 __PACKAGE__->register_method(
1613     method    => 'tag_sf_startwith',
1614     api_name  => 'open-ils.supercat.tag.startwith',
1615     api_level => 1,
1616     argc      => 1,
1617     signature =>
1618         { desc     => <<"          DESC",
1619 Returns a list of the requested org-scoped record IDs held
1620           DESC
1621           params   =>
1622             [
1623                 { name => 'tag',
1624                   desc => 'The target MARC tag',
1625                   type => 'string' },
1626                 { name => 'subfield',
1627                   desc => 'The target MARC subfield',
1628                   type => 'string' },
1629                 { name => 'value',
1630                   desc => 'The target string',
1631                   type => 'string' },
1632                 { name => 'org_unit',
1633                   desc => 'The org unit shortname (or "-" or undef for global) to browse',
1634                   type => 'string' },
1635                 { name => 'page_size',
1636                   desc => 'Count of call numbers to retrieve, default is 9',
1637                   type => 'number' },
1638                 { name => 'page',
1639                   desc => 'The page of call numbers to retrieve, calculated based on page_size.  Can be positive, negative or 0.',
1640                   type => 'number' },
1641                 { name => 'statuses',
1642                   desc => 'Array of statuses to filter copies by, optional and can be undef.',
1643                   type => 'array' },
1644                 { name => 'locations',
1645                   desc => 'Array of copy locations to filter copies by, optional and can be undef.',
1646                   type => 'array' },
1647             ],
1648           'return' =>
1649             { desc => 'Record IDs that have copies at the relevant org units',
1650               type => 'array' }
1651         }
1652 );
1653
1654 sub axis_authority_startwith {
1655     my $self = shift;
1656     my $client = shift;
1657     my $axis = shift;
1658
1659     $axis =~ s/^authority\.//;
1660     $axis =~ s/(\.refs)$//;
1661     my $refs = $1;
1662
1663     return undef unless ( grep { /$axis/ } @{ grab_authority_browse_axes() } );
1664
1665     my @tags;
1666     for my $f (@{$authority_browse_axis_cache{$axis}->fields}) {
1667         push @tags, $f->tag;
1668         if ($refs) {
1669             push @tags, $_->tag for @{$f->sub_entries};
1670         }
1671     }
1672
1673     return authority_tag_sf_startwith($self, $client, \@tags, 'a', @_); # XXX TODO figure out something more correct for the subfield param
1674 }
1675 __PACKAGE__->register_method(
1676     method    => 'axis_authority_startwith',
1677     api_name  => 'open-ils.supercat.authority.startwith.by_axis',
1678     api_level => 1,
1679     argc      => 2,
1680     signature =>
1681         { desc     => "Returns a list of the requested authority record IDs held",
1682           params   =>
1683             [ { name => 'axis', desc => 'The target axis', type => 'string' },
1684               { name => 'value', desc => 'The target value', type => 'string' },
1685               { name => 'page_size', desc => 'Count of records to retrieve, default is 10', type => 'number' },
1686               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1687           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1688         }
1689 );
1690
1691 =pod
1692
1693 sub general_authority_startwith {
1694     my $self = shift;
1695     my $client = shift;
1696     return authority_tag_sf_startwith($self, $client, $self->{tag}, $self->{subfield}, @_);
1697 }
1698 __PACKAGE__->register_method(
1699     method    => 'general_authority_startwith',
1700     api_name  => 'open-ils.supercat.authority.title.startwith',
1701     tag       => ['130'], subfield => 'a',
1702     api_level => 1,
1703     argc      => 1,
1704     signature =>
1705         { desc     => "Returns a list of the requested authority record IDs held",
1706           params   =>
1707             [ { name => 'value', desc => 'The target title', type => 'string' },
1708               { name => 'page_size', desc => 'Count of records to retrieve, default is 10', type => 'number' },
1709               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1710           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1711         }
1712 );
1713 __PACKAGE__->register_method(
1714     method    => 'general_authority_startwith',
1715     api_name  => 'open-ils.supercat.authority.author.startwith',
1716     tag       => [qw/100 110 111/], subfield => 'a',
1717     api_level => 1,
1718     argc      => 1,
1719     signature =>
1720         { desc     => "Returns a list of the requested authority record IDs held",
1721           params   =>
1722             [ { name => 'value', desc => 'The target author', type => 'string' },
1723               { name => 'page_size', desc => 'Count of records to retrieve, default is 10', type => 'number' },
1724               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1725           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1726         }
1727 );
1728 __PACKAGE__->register_method(
1729     method    => 'general_authority_startwith',
1730     api_name  => 'open-ils.supercat.authority.subject.startwith',
1731     tag       => [qw/148 150 151 155/], subfield => 'a',
1732     api_level => 1,
1733     argc      => 1,
1734     signature =>
1735         { desc     => "Returns a list of the requested authority record IDs held",
1736           params   =>
1737             [ { name => 'value', desc => 'The target subject', type => 'string' },
1738               { name => 'page_size', desc => 'Count of records to retrieve, default is 10', type => 'number' },
1739               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1740           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1741         }
1742 );
1743 __PACKAGE__->register_method(
1744     method    => 'general_authority_startwith',
1745     api_name  => 'open-ils.supercat.authority.topic.startwith',
1746     tag       => ['150'], subfield => 'a',
1747     api_level => 1,
1748     argc      => 1,
1749     signature =>
1750         { desc     => "Returns a list of the requested authority record IDs held",
1751           params   =>
1752             [ { name => 'value', desc => 'The target topical subject', type => 'string' },
1753               { name => 'page_size', desc => 'Count of records to retrieve, default is 10', type => 'number' },
1754               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1755           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1756         }
1757 );
1758 __PACKAGE__->register_method(
1759     method    => 'general_authority_startwith',
1760     api_name  => 'open-ils.supercat.authority.title.refs.startwith',
1761     tag       => ['130'], subfield => 'a',
1762     api_level => 1,
1763     argc      => 1,
1764     signature =>
1765         { desc     => "Returns a list of the requested authority record IDs held, including see (4xx) and see also (5xx) references",
1766           params   =>
1767             [ { name => 'value', desc => 'The target title', type => 'string' },
1768               { name => 'page_size', desc => 'Count of records to retrieve, default is 10', type => 'number' },
1769               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1770           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1771         }
1772 );
1773 __PACKAGE__->register_method(
1774     method    => 'general_authority_startwith',
1775     api_name  => 'open-ils.supercat.authority.author.refs.startwith',
1776     tag       => [qw/100 110 111/], subfield => 'a',
1777     api_level => 1,
1778     argc      => 1,
1779     signature =>
1780         { desc     => "Returns a list of the requested authority record IDs held, including see (4xx) and see also (5xx) references",
1781           params   =>
1782             [ { name => 'value', desc => 'The target author', type => 'string' },
1783               { name => 'page_size', desc => 'Count of records to retrieve, default is 10', type => 'number' },
1784               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1785           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1786         }
1787 );
1788 __PACKAGE__->register_method(
1789     method    => 'general_authority_startwith',
1790     api_name  => 'open-ils.supercat.authority.subject.refs.startwith',
1791     tag       => [qw/148 150 151 155/], subfield => 'a',
1792     api_level => 1,
1793     argc      => 1,
1794     signature =>
1795         { desc     => "Returns a list of the requested authority record IDs held, including see (4xx) and see also (5xx) references",
1796           params   =>
1797             [ { name => 'value', desc => 'The target subject', type => 'string' },
1798               { name => 'page_size', desc => 'Count of records to retrieve, default is 10', type => 'number' },
1799               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1800           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1801         }
1802 );
1803 __PACKAGE__->register_method(
1804     method    => 'general_authority_startwith',
1805     api_name  => 'open-ils.supercat.authority.topic.refs.startwith',
1806     tag       => ['150'], subfield => 'a',
1807     api_level => 1,
1808     argc      => 1,
1809     signature =>
1810         { desc     => "Returns a list of the requested authority record IDs held, including see (4xx) and see also (5xx) references",
1811           params   =>
1812             [ { name => 'value', desc => 'The target topical subject', type => 'string' },
1813               { name => 'page_size', desc => 'Count of records to retrieve, default is 10', type => 'number' },
1814               { name => 'page', desc => 'The page of records retrieved, calculated based on page_size.  Can be positive, negative or 0.', type => 'number' }, ],
1815           'return' => { desc => 'Authority Record IDs that are near the target string', type => 'array' }
1816         }
1817 );
1818
1819 =cut
1820
1821 sub authority_tag_sf_startwith {
1822     my $self = shift;
1823     my $client = shift;
1824
1825     my $tag = shift;
1826     my $subfield = shift;
1827
1828     my $value = shift;
1829     my $limit = shift || 10;
1830     my $page = shift || 0;
1831
1832     # Match authority.full_rec normalization
1833     $value = naco_normalize($value, $subfield);
1834
1835     my $ref_limit = $limit;
1836     my $offset = $limit * abs($page);
1837     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
1838
1839     my @ref_tags = ();
1840     # .refs variant includes 4xx and 5xx variants for see / see also
1841     foreach my $tagname (@$tag) {
1842         push(@ref_tags, $tagname);
1843         if ($self->api_name =~ /\.refs\./) {
1844             push(@ref_tags, '4' . substr($tagname, 1, 2));
1845             push(@ref_tags, '5' . substr($tagname, 1, 2));
1846         }
1847     }
1848
1849     my @list = ();
1850
1851     if ($page < 0) {
1852         # Don't skip the first actual page of results in descending order
1853         $offset = $offset - $limit;
1854
1855         my $before = $_storage->request(
1856             "open-ils.cstore.json_query.atomic",
1857             { select    => { afr => [qw/record value/] },
1858               from      => 'afr',
1859               where     => { tag => \@ref_tags, subfield => $subfield, value => { '<' => $value } },
1860               order_by  => { afr => { value => 'desc' } },
1861               limit     => $ref_limit,
1862               offset    => $offset,
1863             }
1864         )->gather(1);
1865         push @list, map { $_->{record} } reverse(@$before);
1866     }
1867
1868     if ($page >= 0) {
1869         my $after = $_storage->request(
1870             "open-ils.cstore.json_query.atomic",
1871             { select    => { afr => [qw/record value/] },
1872               from      => 'afr',
1873               where     => { tag => \@ref_tags, subfield => $subfield, value => { '>=' => $value } },
1874               order_by  => { afr => { value => 'asc' } },
1875               limit     => $ref_limit,
1876               offset    => $offset,
1877             }
1878         )->gather(1);
1879         push @list, map { $_->{record} } @$after;
1880     }
1881
1882     # If we're not pulling in see/see also references, just return the raw list
1883     if ($self->api_name !~ /\.refs\./) {
1884         return \@list;
1885     }
1886
1887     # Remove dupe record IDs that turn up due to 4xx and 5xx matches
1888     my @retlist = ();
1889     my %seen;
1890     foreach my $record (@list) {
1891         next if exists $seen{$record};
1892         push @retlist, int($record);
1893         $seen{$record} = 1;
1894     }
1895
1896     return \@retlist;
1897 }
1898 __PACKAGE__->register_method(
1899     method    => 'authority_tag_sf_startwith',
1900     api_name  => 'open-ils.supercat.authority.tag.startwith',
1901     api_level => 1,
1902     argc      => 1,
1903     signature =>
1904         { desc     => <<"          DESC",
1905 Returns a list of the requested authority record IDs held
1906           DESC
1907           params   =>
1908             [
1909                 { name => 'tag',
1910                   desc => 'The target Authority MARC tag',
1911                   type => 'string' },
1912                 { name => 'subfield',
1913                   desc => 'The target Authority MARC subfield',
1914                   type => 'string' },
1915                 { name => 'value',
1916                   desc => 'The target string',
1917                   type => 'string' },
1918                 { name => 'page_size',
1919                   desc => 'Count of call numbers to retrieve, default is 10',
1920                   type => 'number' },
1921                 { name => 'page',
1922                   desc => 'The page of call numbers to retrieve, calculated based on page_size.  Can be positive, negative or 0.',
1923                   type => 'number' },
1924             ],
1925           'return' =>
1926             { desc => 'Authority Record IDs that are near the target string',
1927               type => 'array' }
1928         }
1929 );
1930
1931
1932 sub holding_data_formats {
1933     return [{
1934         marcxml => {
1935             namespace_uri     => 'http://www.loc.gov/MARC21/slim',
1936             docs          => 'http://www.loc.gov/marcxml/',
1937             schema_location => 'http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd',
1938         }
1939     }];
1940 }
1941 __PACKAGE__->register_method( method => 'holding_data_formats', api_name => 'open-ils.supercat.acn.formats', api_level => 1 );
1942 __PACKAGE__->register_method( method => 'holding_data_formats', api_name => 'open-ils.supercat.acp.formats', api_level => 1 );
1943 __PACKAGE__->register_method( method => 'holding_data_formats', api_name => 'open-ils.supercat.auri.formats', api_level => 1 );
1944
1945
1946 __PACKAGE__->register_method(
1947     method    => 'retrieve_uri',
1948     api_name  => 'open-ils.supercat.auri.marcxml.retrieve',
1949     api_level => 1,
1950     argc      => 1,
1951     signature =>
1952         { desc     => <<"          DESC",
1953 Returns a fleshed call number object
1954           DESC
1955           params   =>
1956             [
1957                 { name => 'uri_id',
1958                   desc => 'An OpenILS asset::uri id',
1959                   type => 'number' },
1960             ],
1961           'return' =>
1962             { desc => 'fleshed uri',
1963               type => 'object' }
1964         }
1965 );
1966 sub retrieve_uri {
1967     my $self = shift;
1968     my $client = shift;
1969     my $cpid = shift;
1970     my $args = shift || {};
1971
1972     return OpenILS::Application::SuperCat::unAPI
1973         ->new(OpenSRF::AppSession
1974             ->create( 'open-ils.cstore' )
1975             ->request(
1976                 "open-ils.cstore.direct.asset.uri.retrieve",
1977                 $cpid,
1978                 { flesh     => 10,
1979                   flesh_fields  => {
1980                             auri    => [qw/call_number_maps/],
1981                             auricnm => [qw/call_number/],
1982                             acn     => [qw/owning_lib record prefix suffix/],
1983                     }
1984                 })
1985             ->gather(1))
1986         ->as_xml($args);
1987 }
1988
1989 __PACKAGE__->register_method(
1990     method    => 'retrieve_copy',
1991     api_name  => 'open-ils.supercat.acp.marcxml.retrieve',
1992     api_level => 1,
1993     argc      => 1,
1994     signature =>
1995         { desc     => <<"          DESC",
1996 Returns a fleshed call number object
1997           DESC
1998           params   =>
1999             [
2000                 { name => 'cn_id',
2001                   desc => 'An OpenILS asset::copy id',
2002                   type => 'number' },
2003             ],
2004           'return' =>
2005             { desc => 'fleshed copy',
2006               type => 'object' }
2007         }
2008 );
2009 sub retrieve_copy {
2010     my $self = shift;
2011     my $client = shift;
2012     my $cpid = shift;
2013     my $args = shift || {};
2014
2015     return OpenILS::Application::SuperCat::unAPI
2016         ->new(OpenSRF::AppSession
2017             ->create( 'open-ils.cstore' )
2018             ->request(
2019                 "open-ils.cstore.direct.asset.copy.retrieve",
2020                 $cpid,
2021                 { flesh     => 2,
2022                   flesh_fields  => {
2023                             acn => [qw/owning_lib record prefix suffix/],
2024                             acp => [qw/call_number location status circ_lib stat_cat_entries notes parts/],
2025                     }
2026                 })
2027             ->gather(1))
2028         ->as_xml($args);
2029 }
2030
2031 __PACKAGE__->register_method(
2032     method    => 'retrieve_callnumber',
2033     api_name  => 'open-ils.supercat.acn.marcxml.retrieve',
2034     api_level => 1,
2035     argc      => 1,
2036     stream    => 1,
2037     signature =>
2038         { desc     => <<"          DESC",
2039 Returns a fleshed call number object
2040           DESC
2041           params   =>
2042             [
2043                 { name => 'cn_id',
2044                   desc => 'An OpenILS asset::call_number id',
2045                   type => 'number' },
2046             ],
2047           'return' =>
2048             { desc => 'call number with copies',
2049               type => 'object' }
2050         }
2051 );
2052 sub retrieve_callnumber {
2053     my $self = shift;
2054     my $client = shift;
2055     my $cnid = shift;
2056     my $args = shift || {};
2057
2058     return OpenILS::Application::SuperCat::unAPI
2059         ->new(OpenSRF::AppSession
2060             ->create( 'open-ils.cstore' )
2061             ->request(
2062                 "open-ils.cstore.direct.asset.call_number.retrieve",
2063                 $cnid,
2064                 { flesh     => 5,
2065                   flesh_fields  => {
2066                             acn => [qw/owning_lib record copies uri_maps prefix suffix/],
2067                             auricnm => [qw/uri/],
2068                             acp => [qw/location status circ_lib stat_cat_entries notes parts/],
2069                     }
2070                 })
2071             ->gather(1))
2072         ->as_xml($args);
2073
2074 }
2075
2076 __PACKAGE__->register_method(
2077     method    => 'basic_record_holdings',
2078     api_name  => 'open-ils.supercat.record.basic_holdings.retrieve',
2079     api_level => 1,
2080     argc      => 1,
2081     stream    => 1,
2082     signature =>
2083         { desc     => <<"          DESC",
2084 Returns a basic hash representation of the requested bibliographic record's holdings
2085           DESC
2086           params   =>
2087             [
2088                 { name => 'bibId',
2089                   desc => 'An OpenILS biblio::record_entry id',
2090                   type => 'number' },
2091             ],
2092           'return' =>
2093             { desc => 'Hash of bib record holdings hierarchy (call numbers and copies)',
2094               type => 'string' }
2095         }
2096 );
2097 sub basic_record_holdings {
2098     my $self = shift;
2099     my $client = shift;
2100     my $bib = shift;
2101     my $ou = shift;
2102
2103     #  holdings hold an array of call numbers, which hold an array of copies
2104     #  holdings => [ label: { library, [ copies: { barcode, location, status, circ_lib } ] } ]
2105     my %holdings;
2106
2107     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2108
2109     my $tree = $_storage->request(
2110         "open-ils.cstore.direct.biblio.record_entry.retrieve",
2111         $bib,
2112         { flesh     => 5,
2113           flesh_fields  => {
2114                     bre => [qw/call_numbers/],
2115                     acn => [qw/copies owning_lib prefix suffix/],
2116                     acp => [qw/location status circ_lib parts/],
2117                 }
2118         }
2119     )->gather(1);
2120
2121     my $o_search = { shortname => uc($ou) };
2122     if (!$ou || $ou eq '-') {
2123         $o_search = { parent_ou => undef };
2124     }
2125
2126     my $orgs = $_storage->request(
2127         "open-ils.cstore.direct.actor.org_unit.search",
2128         $o_search,
2129         { flesh     => 100,
2130           flesh_fields  => { aou    => [qw/children/] }
2131         }
2132     )->gather(1);
2133
2134     my @ou_ids = tree_walker($orgs, 'children', sub {shift->id}) if $orgs;
2135
2136     $logger->debug("Searching for holdings at orgs [".join(',',@ou_ids)."], based on $ou");
2137
2138     for my $cn (@{$tree->call_numbers}) {
2139         next unless ( $cn->deleted eq 'f' || !$cn->deleted );
2140
2141         my $found = 0;
2142         for my $c (@{$cn->copies}) {
2143             next unless grep {$c->circ_lib->id == $_} @ou_ids;
2144             next unless _cp_is_visible($cn, $c);
2145             $found = 1;
2146             last;
2147         }
2148         next unless $found;
2149
2150         $holdings{$cn->label}{'owning_lib'} = $cn->owning_lib->shortname;
2151
2152         for my $cp (@{$cn->copies}) {
2153
2154             next unless grep { $cp->circ_lib->id == $_ } @ou_ids;
2155             next unless _cp_is_visible($cn, $cp);
2156
2157             push @{$holdings{$cn->label}{'copies'}}, {
2158                 barcode => $cp->barcode,
2159                 status => $cp->status->name,
2160                 location => $cp->location->name,
2161                 circlib => $cp->circ_lib->shortname
2162             };
2163
2164         }
2165     }
2166
2167     return \%holdings;
2168 }
2169
2170 sub _cp_is_visible {
2171     my $cn = shift;
2172     my $cp = shift;
2173
2174     my $visible = 0;
2175     if ( ($cp->deleted eq 'f' || !$cp->deleted) &&
2176          $cp->location->opac_visible eq 't' && 
2177          $cp->status->opac_visible eq 't' &&
2178          $cp->opac_visible eq 't' &&
2179          $cp->circ_lib->opac_visible eq 't' &&
2180          $cn->owning_lib->opac_visible eq 't'
2181     ) {
2182         $visible = 1;
2183     }
2184
2185     return $visible;
2186 }
2187
2188 #__PACKAGE__->register_method(
2189 #   method    => 'new_record_holdings',
2190 #   api_name  => 'open-ils.supercat.record.holdings_xml.retrieve',
2191 #   api_level => 1,
2192 #   argc      => 1,
2193 #   stream    => 1,
2194 #   signature =>
2195 #        { desc     => <<"          DESC",
2196 #Returns the XML representation of the requested bibliographic record's holdings
2197 #         DESC
2198 #         params   =>
2199 #           [
2200 #               { name => 'bibId',
2201 #                 desc => 'An OpenILS biblio::record_entry id',
2202 #                 type => 'number' },
2203 #           ],
2204 #         'return' =>
2205 #           { desc => 'Stream of bib record holdings hierarchy in XML',
2206 #             type => 'string' }
2207 #       }
2208 #);
2209 #
2210
2211 sub new_record_holdings {
2212     my $self = shift;
2213     my $client = shift;
2214     my $bib = shift;
2215     my $ou = shift;
2216     my $depth = shift;
2217     my $flesh = shift;
2218     my $paging = shift;
2219
2220     $paging = [-1,0] if (!$paging or !ref($paging) or @$paging == 0);
2221     my $limit = $$paging[0];
2222     my $offset = $$paging[1] || 0;
2223
2224     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2225     my $_search = OpenSRF::AppSession->create( 'open-ils.search' );
2226
2227     my $o_search = { shortname => uc($ou) };
2228     if (!$ou || $ou eq '-') {
2229         $o_search = { parent_ou => undef };
2230     }
2231
2232     my $one_org = $_storage->request(
2233         "open-ils.cstore.direct.actor.org_unit.search",
2234         $o_search
2235     )->gather(1);
2236
2237     my $count_req = $_search->request('open-ils.search.biblio.record.copy_count' => $one_org->id => $bib);
2238     my $staff_count_req = $_search->request('open-ils.search.biblio.record.copy_count.staff' => $one_org->id => $bib);
2239
2240     my $orgs = $_storage->request(
2241         'open-ils.cstore.json_query.atomic',
2242         { from => [ 'actor.org_unit_descendants', defined($depth) ? ( $one_org->id, $depth ) :  ( $one_org->id ) ] }
2243     )->gather(1);
2244
2245
2246     my @ou_ids = map { $_->{id} } @$orgs;
2247
2248     $logger->info("Searching for holdings at orgs [".join(',',@ou_ids)."], based on $ou");
2249
2250     my %subselect = ( '-or' => [
2251         { owning_lib => \@ou_ids },
2252         { '-exists'  =>
2253             { from  => 'acp',
2254               where => {
2255                 call_number => { '=' => {'+acn'=>'id'} },
2256                 deleted => 'f',
2257                 circ_lib => \@ou_ids
2258               },
2259               limit => 1
2260             }
2261         }
2262     ]);
2263
2264     # we are dealing with -full or -uris, so we need to flesh things out
2265     if ($flesh) {
2266
2267         # either way we're going to need uris
2268         # get all the uris up the tree (see also ba47ecc6196)
2269
2270         my $uri_orgs = $_storage->request(
2271             'open-ils.cstore.json_query.atomic',
2272             { from => [ 'actor.org_unit_ancestors', $one_org->id ] }
2273         )->gather(1);
2274
2275         my @uri_ou_ids = map { $_->{id} } @$uri_orgs;
2276
2277         # we have a -uris, just get the uris
2278         if ($flesh == 2) {
2279             %subselect = (
2280                 owning_lib => \@uri_ou_ids,
2281                 '-exists'  => {
2282                     limit => 1,
2283                     from  => { auricnm => 'auri' },
2284                     where => {
2285                         call_number => { '=' => {'+acn'=>'id'} },
2286                         '+auri' => { active => 't' }
2287                     }
2288                 }
2289             );
2290         # we have a -full, get all the things
2291         } elsif ($flesh == 1) {
2292             %subselect = ( '-or' => [
2293                 { owning_lib => \@ou_ids },
2294                 { '-exists'  =>
2295                     { from  => 'acp',
2296                       where => {
2297                         call_number => { '=' => {'+acn'=>'id'} },
2298                         deleted => 'f',
2299                         circ_lib => \@ou_ids
2300                       },
2301                       limit => 1
2302                     }
2303                 },
2304                 { '-and' => [
2305                     { owning_lib => \@uri_ou_ids },
2306                     { '-exists'  => {
2307                         from  => { auricnm => 'auri' },
2308                         where => {
2309                             call_number => { '=' => {'+acn'=>'id'} },
2310                             '+auri' => { active => 't' }
2311                         },
2312                         limit => 1
2313                     }}
2314                 ]}
2315             ]);
2316         }
2317     }
2318
2319     my $cns = $_storage->request(
2320         "open-ils.cstore.direct.asset.call_number.search.atomic",
2321         { record  => $bib,
2322           deleted => 'f',
2323           %subselect
2324         },
2325         { flesh     => 5,
2326           flesh_fields  => {
2327                     acn => [qw/copies owning_lib uri_maps prefix suffix/],
2328                     auricnm => [qw/uri/],
2329                     acp => [qw/circ_lib location status stat_cat_entries notes parts/],
2330                     asce    => [qw/stat_cat/],
2331                 },
2332           ( $limit > -1 ? ( limit  => $limit  ) : () ),
2333           ( $offset     ? ( offset => $offset ) : () ),
2334           order_by  => { acn => { label_sortkey => {} } }
2335         }
2336     )->gather(1);
2337
2338     my ($year,$month,$day) = reverse( (localtime)[3,4,5] );
2339     $year += 1900;
2340     $month += 1;
2341
2342     $client->respond("<holdings xmlns='http://open-ils.org/spec/holdings/v1'><counts>\n");
2343
2344     my $copy_counts = $count_req->gather(1);
2345     my $staff_copy_counts = $staff_count_req->gather(1);
2346
2347     for my $c (@$copy_counts) {
2348         $$c{transcendant} ||= 0;
2349         my $out = "<count type='public'";
2350         $out .= " $_='$$c{$_}'" for (qw/count available unshadow transcendant org_unit depth/);
2351         $client->respond("$out/>\n")
2352     }
2353
2354     for my $c (@$staff_copy_counts) {
2355         $$c{transcendant} ||= 0;
2356         my $out = "<count type='staff'";
2357         $out .= " $_='$$c{$_}'" for (qw/count available unshadow transcendant org_unit depth/);
2358         $client->respond("$out/>\n")
2359     }
2360
2361     $client->respond("</counts><volumes>\n");
2362     
2363     for my $cn (@$cns) {
2364         next unless (@{$cn->copies} > 0 or (ref($cn->uri_maps) and @{$cn->uri_maps}));
2365
2366         # We don't want O:A:S:unAPI::acn to return the record, we've got that already
2367         # In the context of BibTemplate, copies aren't necessary because we pull those
2368         # in a separate call
2369         $client->respond(
2370             OpenILS::Application::SuperCat::unAPI::acn
2371                 ->new( $cn )
2372                 ->as_xml( {no_record => 1, no_copies => ($flesh ? 0 : 1)} )
2373         );
2374     }
2375
2376     $client->respond("</volumes><subscriptions>\n");
2377
2378     $logger->info("Searching for serial holdings at orgs [".join(',',@ou_ids)."], based on $ou");
2379
2380     %subselect = ( '-or' => [
2381         { owning_lib => \@ou_ids },
2382         { '-exists'  =>
2383             { from  => 'sdist',
2384               where => { holding_lib => \@ou_ids },
2385               limit => 1
2386             }
2387         }
2388     ]);
2389
2390     my $ssubs = $_storage->request(
2391         "open-ils.cstore.direct.serial.subscription.search.atomic",
2392         { record_entry  => $bib,
2393           %subselect
2394         },
2395         { flesh     => 7,
2396           flesh_fields  => {
2397                     ssub    => [qw/distributions issuances scaps owning_lib/],
2398                     sdist   => [qw/basic_summary supplement_summary index_summary streams holding_lib/],
2399                     sstr    => [qw/items/],
2400                     sitem   => [qw/notes unit/],
2401                     sunit   => [qw/notes location status circ_lib stat_cat_entries call_number/],
2402                     acn => [qw/owning_lib prefix suffix/],
2403                 },
2404           ( $limit > -1 ? ( limit  => $limit  ) : () ),
2405           ( $offset     ? ( offset => $offset ) : () ),
2406           order_by  => {
2407             ssub => {
2408                 start_date => {},
2409                 owning_lib => {},
2410                 id => {}
2411             },
2412             sdist => {
2413                 label => {},
2414                 owning_lib => {},
2415             },
2416             sunit => {
2417                 date_expected => {},
2418             }
2419           }
2420         }
2421     )->gather(1);
2422
2423
2424     for my $ssub (@$ssubs) {
2425         next unless (@{$ssub->distributions} or @{$ssub->issuances} or @{$ssub->scaps});
2426
2427         # We don't want O:A:S:unAPI::ssub to return the record, we've got that already
2428         # In the context of BibTemplate, copies aren't necessary because we pull those
2429         # in a separate call
2430         $client->respond(
2431             OpenILS::Application::SuperCat::unAPI::ssub
2432                 ->new( $ssub )
2433                 ->as_xml( {no_record => 1, no_items => ($flesh ? 0 : 1)} )
2434         );
2435     }
2436
2437
2438     return "</subscriptions></holdings>\n";
2439 }
2440 __PACKAGE__->register_method(
2441     method    => 'new_record_holdings',
2442     api_name  => 'open-ils.supercat.record.holdings_xml.retrieve',
2443     api_level => 1,
2444     argc      => 1,
2445     stream    => 1,
2446     signature =>
2447         { desc     => <<"          DESC",
2448 Returns the XML representation of the requested bibliographic record's holdings
2449           DESC
2450           params   =>
2451             [
2452                 { name => 'bibId',
2453                   desc => 'An OpenILS biblio::record_entry ID',
2454                   type => 'number' },
2455                 { name => 'orgUnit',
2456                   desc => 'An OpenILS actor::org_unit short name that limits the scope of returned holdings',
2457                   type => 'text' },
2458                 { name => 'depth',
2459                   desc => 'An OpenILS actor::org_unit_type depththat limits the scope of returned holdings',
2460                   type => 'number' },
2461                 { name => 'hideCopies',
2462                   desc => 'Flag that prevents the inclusion of copies in the returned holdings',
2463                   type => 'boolean' },
2464                 { name => 'paging',
2465                   desc => 'Arry of limit and offset for holdings paging',
2466                   type => 'array' },
2467             ],
2468           'return' =>
2469             { desc => 'Stream of bib record holdings hierarchy in XML',
2470               type => 'string' }
2471         }
2472 );
2473
2474 sub isbn_holdings {
2475     my $self = shift;
2476     my $client = shift;
2477     my $isbn = shift;
2478
2479     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2480
2481     my $recs = $_storage->request(
2482             'open-ils.cstore.direct.metabib.full_rec.search.atomic',
2483             { tag => { like => '02%'}, value => {like => "$isbn\%"}}
2484     )->gather(1);
2485
2486     return undef unless (@$recs);
2487
2488     return ($self->method_lookup( 'open-ils.supercat.record.holdings_xml.retrieve')->run( $recs->[0]->record ))[0];
2489 }
2490 __PACKAGE__->register_method(
2491     method    => 'isbn_holdings',
2492     api_name  => 'open-ils.supercat.isbn.holdings_xml.retrieve',
2493     api_level => 1,
2494     argc      => 1,
2495     signature =>
2496         { desc     => <<"          DESC",
2497 Returns the XML representation of the requested bibliographic record's holdings
2498           DESC
2499           params   =>
2500             [
2501                 { name => 'isbn',
2502                   desc => 'An isbn',
2503                   type => 'string' },
2504             ],
2505           'return' =>
2506             { desc => 'The bib record holdings hierarchy in XML',
2507               type => 'string' }
2508         }
2509 );
2510
2511 sub escape {
2512     my $self = shift;
2513     my $text = shift;
2514     return '' unless $text;
2515     $text =~ s/&/&amp;/gsom;
2516     $text =~ s/</&lt;/gsom;
2517     $text =~ s/>/&gt;/gsom;
2518     $text =~ s/"/&quot;/gsom;
2519     $text =~ s/'/&apos;/gsom;
2520     return $text;
2521 }
2522
2523 sub recent_changes {
2524     my $self = shift;
2525     my $client = shift;
2526     my $when = shift || '1-01-01';
2527     my $limit = shift;
2528
2529     my $type = 'biblio';
2530     my $hint = 'bre';
2531
2532     if ($self->api_name =~ /authority/o) {
2533         $type = 'authority';
2534         $hint = 'are';
2535     }
2536
2537     my $axis = 'create_date';
2538     $axis = 'edit_date' if ($self->api_name =~ /edit/o);
2539
2540     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2541
2542     return $_storage->request(
2543         "open-ils.cstore.direct.$type.record_entry.id_list.atomic",
2544         { $axis => { ">" => $when }, id => { '>' => 0 }, deleted => 'f', active => 't' },
2545         { order_by => { $hint => "$axis desc" }, limit => $limit }
2546     )->gather(1);
2547 }
2548
2549 for my $t ( qw/biblio authority/ ) {
2550     for my $a ( qw/import edit/ ) {
2551
2552         __PACKAGE__->register_method(
2553             method    => 'recent_changes',
2554             api_name  => "open-ils.supercat.$t.record.$a.recent",
2555             api_level => 1,
2556             argc      => 0,
2557             signature =>
2558                 { desc     => "Returns a list of recently ${a}ed $t records",
2559                   params   =>
2560                     [
2561                         { name => 'when',
2562                           desc => "Date to start looking for ${a}ed records",
2563                           default => '1-01-01',
2564                           type => 'string' },
2565
2566                         { name => 'limit',
2567                           desc => "Maximum count to retrieve",
2568                           type => 'number' },
2569                     ],
2570                   'return' =>
2571                     { desc => "An id list of $t records",
2572                       type => 'array' }
2573                 },
2574         );
2575     }
2576 }
2577
2578
2579 sub retrieve_authority_marcxml {
2580     my $self = shift;
2581     my $client = shift;
2582     my $rid = shift;
2583
2584     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2585
2586     my $record = $_storage->request( 'open-ils.cstore.direct.authority.record_entry.retrieve' => $rid )->gather(1);
2587     return $U->entityize( $record->marc ) if ($record);
2588     return undef;
2589 }
2590
2591 __PACKAGE__->register_method(
2592     method    => 'retrieve_authority_marcxml',
2593     api_name  => 'open-ils.supercat.authority.marcxml.retrieve',
2594     api_level => 1,
2595     argc      => 1,
2596     signature =>
2597         { desc     => <<"          DESC",
2598 Returns the MARCXML representation of the requested authority record
2599           DESC
2600           params   =>
2601             [
2602                 { name => 'authorityId',
2603                   desc => 'An OpenILS authority::record_entry id',
2604                   type => 'number' },
2605             ],
2606           'return' =>
2607             { desc => 'The authority record in MARCXML',
2608               type => 'string' }
2609         }
2610 );
2611
2612 sub retrieve_record_marcxml {
2613     my $self = shift;
2614     my $client = shift;
2615     my $rid = shift;
2616
2617     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2618
2619     my $record = $_storage->request( 'open-ils.cstore.direct.biblio.record_entry.retrieve' => $rid )->gather(1);
2620     return $U->entityize( $record->marc ) if ($record);
2621     return undef;
2622 }
2623
2624 __PACKAGE__->register_method(
2625     method    => 'retrieve_record_marcxml',
2626     api_name  => 'open-ils.supercat.record.marcxml.retrieve',
2627     api_level => 1,
2628     argc      => 1,
2629     signature =>
2630         { desc     => <<"          DESC",
2631 Returns the MARCXML representation of the requested bibliographic record
2632           DESC
2633           params   =>
2634             [
2635                 { name => 'bibId',
2636                   desc => 'An OpenILS biblio::record_entry id',
2637                   type => 'number' },
2638             ],
2639           'return' =>
2640             { desc => 'The bib record in MARCXML',
2641               type => 'string' }
2642         }
2643 );
2644
2645 sub retrieve_isbn_marcxml {
2646     my $self = shift;
2647     my $client = shift;
2648     my $isbn = shift;
2649
2650     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2651
2652     my $recs = $_storage->request(
2653             'open-ils.cstore.direct.metabib.full_rec.search.atomic',
2654             { tag => { like => '02%'}, value => {like => "$isbn\%"}}
2655     )->gather(1);
2656
2657     return undef unless (@$recs);
2658
2659     my $record = $_storage->request( 'open-ils.cstore.direct.biblio.record_entry.retrieve' => $recs->[0]->record )->gather(1);
2660     return $U->entityize( $record->marc ) if ($record);
2661     return undef;
2662 }
2663
2664 __PACKAGE__->register_method(
2665     method    => 'retrieve_isbn_marcxml',
2666     api_name  => 'open-ils.supercat.isbn.marcxml.retrieve',
2667     api_level => 1,
2668     argc      => 1,
2669     signature =>
2670         { desc     => <<"          DESC",
2671 Returns the MARCXML representation of the requested ISBN
2672           DESC
2673           params   =>
2674             [
2675                 { name => 'ISBN',
2676                   desc => 'An ... um ... ISBN',
2677                   type => 'string' },
2678             ],
2679           'return' =>
2680             { desc => 'The bib record in MARCXML',
2681               type => 'string' }
2682         }
2683 );
2684
2685 sub retrieve_record_transform {
2686     my $self = shift;
2687     my $client = shift;
2688     my $rid = shift;
2689
2690     (my $transform = $self->api_name) =~ s/^.+record\.([^\.]+)\.retrieve$/$1/o;
2691
2692     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2693     #$_storage->connect;
2694
2695     my $record = $_storage->request(
2696         'open-ils.cstore.direct.biblio.record_entry.retrieve',
2697         $rid
2698     )->gather(1);
2699
2700     return undef unless ($record);
2701
2702     return $U->entityize($record_xslt{$transform}{xslt}->transform( $_parser->parse_string( $record->marc ) )->toString);
2703 }
2704
2705 sub retrieve_isbn_transform {
2706     my $self = shift;
2707     my $client = shift;
2708     my $isbn = shift;
2709
2710     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2711
2712     my $recs = $_storage->request(
2713             'open-ils.cstore.direct.metabib.full_rec.search.atomic',
2714             { tag => { like => '02%'}, value => {like => "$isbn\%"}}
2715     )->gather(1);
2716
2717     return undef unless (@$recs);
2718
2719     (my $transform = $self->api_name) =~ s/^.+isbn\.([^\.]+)\.retrieve$/$1/o;
2720
2721     my $record = $_storage->request( 'open-ils.cstore.direct.biblio.record_entry.retrieve' => $recs->[0]->record )->gather(1);
2722
2723     return undef unless ($record);
2724
2725     return $U->entityize($record_xslt{$transform}{xslt}->transform( $_parser->parse_string( $record->marc ) )->toString);
2726 }
2727
2728 sub retrieve_record_objects {
2729     my $self = shift;
2730     my $client = shift;
2731     my $ids = shift;
2732
2733     my $type = 'biblio';
2734
2735     if ($self->api_name =~ /authority/) {
2736         $type = 'authority';
2737     }
2738
2739     $ids = [$ids] unless (ref $ids);
2740     $ids = [grep {$_} @$ids];
2741
2742     return [] unless (@$ids);
2743
2744     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2745     return $_storage->request("open-ils.cstore.direct.$type.record_entry.search.atomic" => { id => [grep {$_} @$ids] })->gather(1);
2746 }
2747 __PACKAGE__->register_method(
2748     method    => 'retrieve_record_objects',
2749     api_name  => 'open-ils.supercat.record.object.retrieve',
2750     api_level => 1,
2751     argc      => 1,
2752     signature =>
2753         { desc     => <<"          DESC",
2754 Returns the Fieldmapper object representation of the requested bibliographic records
2755           DESC
2756           params   =>
2757             [
2758                 { name => 'bibIds',
2759                   desc => 'OpenILS biblio::record_entry ids',
2760                   type => 'array' },
2761             ],
2762           'return' =>
2763             { desc => 'The bib records',
2764               type => 'array' }
2765         }
2766 );
2767
2768 __PACKAGE__->register_method(
2769     method    => 'retrieve_record_objects',
2770     api_name  => 'open-ils.supercat.authority.object.retrieve',
2771     api_level => 1,
2772     argc      => 1,
2773     signature =>
2774         { desc     => <<"          DESC",
2775 Returns the Fieldmapper object representation of the requested authority records
2776           DESC
2777           params   =>
2778             [
2779                 { name => 'authIds',
2780                   desc => 'OpenILS authority::record_entry ids',
2781                   type => 'array' },
2782             ],
2783           'return' =>
2784             { desc => 'The authority records',
2785               type => 'array' }
2786         }
2787 );
2788
2789 sub retrieve_isbn_object {
2790     my $self = shift;
2791     my $client = shift;
2792     my $isbn = shift;
2793
2794     return undef unless ($isbn);
2795
2796     my $_storage = OpenSRF::AppSession->create( 'open-ils.cstore' );
2797     my $recs = $_storage->request(
2798             'open-ils.cstore.direct.metabib.full_rec.search.atomic',
2799             { tag => { like => '02%'}, value => {like => "$isbn\%"}}
2800     )->gather(1);
2801
2802     return undef unless (@$recs);
2803
2804     return $_storage->request(
2805         'open-ils.cstore.direct.biblio.record_entry.search.atomic',
2806         { id => $recs->[0]->record }
2807     )->gather(1);
2808 }
2809 __PACKAGE__->register_method(
2810     method    => 'retrieve_isbn_object',
2811     api_name  => 'open-ils.supercat.isbn.object.retrieve',
2812     api_level => 1,
2813     argc      => 1,
2814     signature =>
2815         { desc     => <<"          DESC",
2816 Returns the Fieldmapper object representation of the requested bibliographic record
2817           DESC
2818           params   =>
2819             [
2820                 { name => 'isbn',
2821                   desc => 'an ISBN',
2822                   type => 'string' },
2823             ],
2824           'return' =>
2825             { desc => 'The bib record',
2826               type => 'object' }
2827         }
2828 );
2829
2830
2831
2832 sub retrieve_metarecord_mods {
2833     my $self = shift;
2834     my $client = shift;
2835     my $rid = shift;
2836
2837     my $_storage = OpenSRF::AppSession->connect( 'open-ils.cstore' );
2838
2839     # Get the metarecord in question
2840     my $mr =
2841     $_storage->request(
2842         'open-ils.cstore.direct.metabib.metarecord.retrieve' => $rid
2843     )->gather(1);
2844
2845     # Now get the map of all bib records for the metarecord
2846     my $recs =
2847     $_storage->request(
2848         'open-ils.cstore.direct.metabib.metarecord_source_map.search.atomic',
2849         {metarecord => $rid}
2850     )->gather(1);
2851
2852     $logger->debug("Adding ".scalar(@$recs)." bib record to the MODS of the metarecord");
2853
2854     # and retrieve the lead (master) record as MODS
2855     my ($master) =
2856         $self   ->method_lookup('open-ils.supercat.record.mods.retrieve')
2857             ->run($mr->master_record);
2858     my $master_mods = $_parser->parse_string($master)->documentElement;
2859     $master_mods->setNamespace( "http://www.loc.gov/mods/", "mods" );
2860     $master_mods->setNamespace( "http://www.loc.gov/mods/", undef, 1 );
2861
2862     # ... and a MODS clone to populate, with guts removed.
2863     my $mods = $_parser->parse_string($master)->documentElement;
2864     $mods->setNamespace( "http://www.loc.gov/mods/", "mods" ); # modsCollection element
2865     $mods->setNamespace('http://www.loc.gov/mods/', undef, 1);
2866     ($mods) = $mods->findnodes('//mods:mods');
2867     #$mods->setNamespace( "http://www.loc.gov/mods/", "mods" ); # mods element
2868     $mods->removeChildNodes;
2869     $mods->setNamespace('http://www.loc.gov/mods/', undef, 1);
2870
2871     # Add the metarecord ID as a (locally defined) info URI
2872     my $recordInfo = $mods
2873         ->ownerDocument
2874         ->createElement("recordInfo");
2875
2876     my $recordIdentifier = $mods
2877         ->ownerDocument
2878         ->createElement("recordIdentifier");
2879
2880     my ($year,$month,$day) = reverse( (localtime)[3,4,5] );
2881     $year += 1900;
2882     $month += 1;
2883
2884     my $id = $mr->id;
2885     $recordIdentifier->appendTextNode(
2886         sprintf("tag:open-ils.org,$year-\%0.2d-\%0.2d:metabib-metarecord/$id", $month, $day)
2887     );
2888
2889     $recordInfo->appendChild($recordIdentifier);
2890     $mods->appendChild($recordInfo);
2891
2892     # Grab the title, author and ISBN for the master record and populate the metarecord
2893     my ($title) = $master_mods->findnodes( './mods:titleInfo[not(@type)]' );
2894     
2895     if ($title) {
2896         $title->setNamespace( "http://www.loc.gov/mods/", "mods" );
2897         $title->setNamespace( "http://www.loc.gov/mods/", undef, 1 );
2898         $title = $mods->ownerDocument->importNode($title);
2899         $mods->appendChild($title);
2900     }
2901
2902     my ($author) = $master_mods->findnodes( './mods:name[mods:role/mods:text[text()="creator"]]' );
2903     if ($author) {
2904         $author->setNamespace( "http://www.loc.gov/mods/", "mods" );
2905         $author->setNamespace( "http://www.loc.gov/mods/", undef, 1 );
2906         $author = $mods->ownerDocument->importNode($author);
2907         $mods->appendChild($author);
2908     }
2909
2910     my ($isbn) = $master_mods->findnodes( './mods:identifier[@type="isbn"]' );
2911     if ($isbn) {
2912         $isbn->setNamespace( "http://www.loc.gov/mods/", "mods" );
2913         $isbn->setNamespace( "http://www.loc.gov/mods/", undef, 1 );
2914         $isbn = $mods->ownerDocument->importNode($isbn);
2915         $mods->appendChild($isbn);
2916     }
2917
2918     # ... and loop over the constituent records
2919     for my $map ( @$recs ) {
2920
2921         # get the MODS
2922         my ($rec) =
2923             $self   ->method_lookup('open-ils.supercat.record.mods.retrieve')
2924                 ->run($map->source);
2925
2926         my $part_mods = $_parser->parse_string($rec);
2927         $part_mods->documentElement->setNamespace( "http://www.loc.gov/mods/", "mods" );
2928         $part_mods->documentElement->setNamespace( "http://www.loc.gov/mods/", undef, 1 );
2929         ($part_mods) = $part_mods->findnodes('//mods:mods');
2930
2931         for my $node ( ($part_mods->findnodes( './mods:subject' )) ) {
2932             $node->setNamespace( "http://www.loc.gov/mods/", "mods" );
2933             $node->setNamespace( "http://www.loc.gov/mods/", undef, 1 );
2934             $node = $mods->ownerDocument->importNode($node);
2935             $mods->appendChild( $node );
2936         }
2937
2938         my $relatedItem = $mods
2939             ->ownerDocument
2940             ->createElement("relatedItem");
2941
2942         $relatedItem->setAttribute( type => 'constituent' );
2943
2944         my $identifier = $mods
2945             ->ownerDocument
2946             ->createElement("identifier");
2947
2948         $identifier->setAttribute( type => 'uri' );
2949
2950         my $subRecordInfo = $mods
2951             ->ownerDocument
2952             ->createElement("recordInfo");
2953
2954         my $subRecordIdentifier = $mods
2955             ->ownerDocument
2956             ->createElement("recordIdentifier");
2957
2958         my $subid = $map->source;
2959         $subRecordIdentifier->appendTextNode(
2960             sprintf("tag:open-ils.org,$year-\%0.2d-\%0.2d:biblio-record_entry/$subid",
2961                 $month,
2962                 $day