LP#1078593 Assorted small Serial.pm fixes
[working/Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / Serial.pm
1 #!/usr/bin/perl
2
3 # This program is free software; you can redistribute it and/or
4 # modify it under the terms of the GNU General Public License
5 # as published by the Free Software Foundation; either version 2
6 # of the License, or (at your option) any later version.
7 #
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 # GNU General Public License for more details.
12 #
13 # You should have received a copy of the GNU General Public License
14 # along with this program; if not, write to the Free Software
15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
16
17 =head1 NAME
18
19 OpenILS::Application::Serial - Performs serials-related tasks such as receiving issues and generating predictions
20
21 =head1 SYNOPSIS
22
23 TBD
24
25 =head1 DESCRIPTION
26
27 TBD
28
29 =head1 AUTHOR
30
31 Dan Wells, dbw2@calvin.edu
32
33 =cut
34
35 package OpenILS::Application::Serial;
36
37 use strict;
38 use warnings;
39
40
41 use OpenILS::Application;
42 use base qw/OpenILS::Application/;
43 use OpenILS::Application::AppUtils;
44 use OpenILS::Event;
45 use OpenSRF::AppSession;
46 use OpenSRF::Utils qw/:datetime/;
47 use OpenSRF::Utils::Logger qw/:logger/;
48 use OpenILS::Utils::CStoreEditor q/:funcs/;
49 use OpenILS::Utils::Fieldmapper;
50 use OpenILS::Utils::MFHD;
51 use DateTime::Format::ISO8601;
52 use MARC::File::XML (BinaryEncoding => 'utf8');
53
54 use OpenILS::Application::Serial::OPAC;
55
56 my $U = 'OpenILS::Application::AppUtils';
57 my @MFHD_NAMES = ('basic','supplement','index');
58 my %MFHD_NAMES_BY_TAG = (  '853' => $MFHD_NAMES[0],
59                         '863' => $MFHD_NAMES[0],
60                         '854' => $MFHD_NAMES[1],
61                         '864' => $MFHD_NAMES[1],
62                         '855' => $MFHD_NAMES[2],
63                         '865' => $MFHD_NAMES[2] );
64 my %MFHD_TAGS_BY_NAME = (  $MFHD_NAMES[0] => '853',
65                         $MFHD_NAMES[1] => '854',
66                         $MFHD_NAMES[2] => '855');
67 my $_strp_date = new DateTime::Format::Strptime(pattern => '%F');
68 my %FM_NAME_TO_ID = (
69     'subscription' => 'ssub',
70     'distribution' => 'sdist',
71     'item' => 'sitem'
72     );
73
74 # helper method for conforming dates to ISO8601
75 sub _cleanse_dates {
76     my $item = shift;
77     my $fields = shift;
78
79     foreach my $field (@$fields) {
80         $item->$field(OpenSRF::Utils::clense_ISO8601($item->$field)) if $item->$field;
81     }
82     return 0;
83 }
84
85 sub _get_mvr {
86     $U->simplereq(
87         "open-ils.search",
88         "open-ils.search.biblio.record.mods_slim.retrieve",
89         @_
90     );
91 }
92
93
94 ##########################################################################
95 # item methods
96 #
97 __PACKAGE__->register_method(
98     method    => "create_item_safely",
99     api_name  => "open-ils.serial.item.create",
100     api_level => 1,
101     stream    => 1,
102     argc      => 3,
103     signature => {
104         desc => q/Creates any number of items, respecting only a few of the
105         submitted fields, as the user shouldn't be able to freely set certain
106         ones/,
107         params => [
108             {name=> "authtoken", desc => "Authtoken for current user session",
109                 type => "string"},
110             {name => "item", desc => "serial item",
111                 type => "object", class => "sitem"},
112             {name => "count",
113                 desc => "optional: how many items to make " .
114                     "(default 1; 1-100 permitted)",
115                 type => "number"}
116         ],
117         return => {
118             desc => "created items (a stream of them)",
119             type => "object", class => "sitem"
120         }
121     }
122 );
123 __PACKAGE__->register_method(
124     method    => "update_item_safely",
125     api_name  => "open-ils.serial.item.update",
126     api_level => 1,
127     stream    => 1,
128     argc      => 2,
129     signature => {
130         desc => q/Edit a serial item, respecting only a few of the
131         submitted fields, as the user shouldn't be able to freely set certain
132         ones/,
133         params => [
134             {name=> "authtoken", desc => "Authtoken for current user session",
135                 type => "string"},
136             {name => "item", desc => "serial item",
137                 type => "object", class => "sitem"},
138         ],
139         return => {
140             desc => "created item", type => "object", class => "sitem"
141         }
142     }
143 );
144
145 sub _set_safe_item_fields {
146     my $dest = shift;
147     my $source = shift;
148     my $requestor_id = shift;
149     # extra fields remain in @_
150
151     $dest->edit_date("now");
152     $dest->editor($requestor_id);
153
154     my @fields = qw/date_expected date_received status/;
155
156     for my $field (@fields, @_) {
157         $dest->$field($source->$field);
158     }
159 }
160
161 sub update_item_safely {
162     my ($self, $client, $auth, $item) = @_;
163
164     my $e = new_editor("xact" => 1, "authtoken" => $auth);
165     $e->checkauth or return $e->die_event;
166
167     my $orig = $e->retrieve_serial_item([
168         $item->id, {
169             "flesh" => 2, "flesh_fields" => {
170                 "sitem" => ["stream"], "sstr" => ["distribution"]
171             }
172         }
173     ]) or return $e->die_event;
174
175     return $e->die_event unless $e->allowed(
176         "ADMIN_SERIAL_ITEM", $orig->stream->distribution->holding_lib
177     );
178
179     _set_safe_item_fields($orig, $item, $e->requestor->id);
180     $e->update_serial_item($orig) or return $e->die_event;
181
182     $client->respond($e->retrieve_serial_item($item->id));
183     $e->commit or return $e->die_event;
184     undef;
185 }
186
187 sub create_item_safely {
188     my ($self, $client, $auth, $item, $count) = @_;
189
190     $count = int $count;
191     $count ||= 1;
192     return new OpenILS::Event(
193         "BAD_PARAMS", note => "Count should be from 1 to 100"
194     ) unless $count >= 1 and $count <= 100;
195
196     my $e = new_editor("xact" => 1, "authtoken" => $auth);
197     $e->checkauth or return $e->die_event;
198
199     my $stream = $e->retrieve_serial_stream([
200         $item->stream, {
201             "flesh" => 1, "flesh_fields" => {"sstr" => ["distribution"]}
202         }
203     ]) or return $e->die_event;
204
205     return $e->die_event unless $e->allowed(
206         "ADMIN_SERIAL_ITEM", $stream->distribution->holding_lib
207     );
208
209     for (my $i = 0; $i < $count; $i++) {
210         my $actual = new Fieldmapper::serial::item;
211         $actual->creator($e->requestor->id);
212         _set_safe_item_fields(
213             $actual, $item, $e->requestor->id, "issuance", "stream"
214         );
215
216         $e->create_serial_item($actual) or return $e->die_event;
217         $client->respond($e->data);
218     }
219
220     $e->commit or return $e->die_event;
221     undef;
222 }
223
224 __PACKAGE__->register_method(
225     method    => 'fleshed_item_alter',
226     api_name  => 'open-ils.serial.item.fleshed.batch.update',
227     api_level => 1,
228     argc      => 2,
229     signature => {
230         desc     => 'Receives an array of one or more items and updates the database as needed',
231         'params' => [ {
232                  name => 'authtoken',
233                  desc => 'Authtoken for current user session',
234                  type => 'string'
235             },
236             {
237                  name => 'items',
238                  desc => 'Array of fleshed items',
239                  type => 'array'
240             }
241
242         ],
243         'return' => {
244             desc => 'Returns 1 if successful, event if failed',
245             type => 'mixed'
246         }
247     }
248 );
249
250 sub fleshed_item_alter {
251     my( $self, $conn, $auth, $items ) = @_;
252     return 1 unless ref $items;
253     my( $reqr, $evt ) = $U->checkses($auth);
254     return $evt if $evt;
255     my $editor = new_editor(requestor => $reqr, xact => 1);
256     my $override = $self->api_name =~ /override/;
257
258     my %found_sdist_ids;
259     my %found_sstr_ids;
260     for my $item (@$items) {
261         my $sstr_id = ref $item->stream ? $item->stream->id : $item->stream;
262         if (!exists($found_sstr_ids{$sstr_id})) {
263             my $sstr;
264             if (ref $item->stream) {
265                 $sstr = $item->stream;
266             } else {
267                 $sstr = $editor->retrieve_serial_stream($item->stream) or return $editor->die_event;
268             }
269             if (!exists($found_sdist_ids{$sstr->distribution})) {
270                 my $sdist = $editor->retrieve_serial_distribution($sstr->distribution) or return $editor->die_event;
271                 return $editor->die_event unless
272                     $editor->allowed("ADMIN_SERIAL_STREAM", $sdist->holding_lib);
273                 $found_sdist_ids{$sstr->distribution} = 1;
274             }
275             $found_sstr_ids{$sstr_id} = 1;
276         }
277
278         $item->editor($editor->requestor->id);
279         $item->edit_date('now');
280
281         if( $item->isdeleted ) {
282             $evt = _delete_sitem( $editor, $override, $item);
283         } elsif( $item->isnew ) {
284             # TODO: reconsider this
285             # if the item has a new issuance, create the issuance first
286             if (ref $item->issuance eq 'Fieldmapper::serial::issuance' and $item->issuance->isnew) {
287                 fleshed_issuance_alter($self, $conn, $auth, [$item->issuance]);
288             }
289             _cleanse_dates($item, ['date_expected','date_received']);
290             $evt = _create_sitem( $editor, $item );
291         } else {
292             _cleanse_dates($item, ['date_expected','date_received']);
293             $evt = _update_sitem( $editor, $override, $item );
294         }
295     }
296
297     if( $evt ) {
298         $logger->info("fleshed item-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
299         $editor->rollback;
300         return $evt;
301     }
302     $logger->debug("item-alter: done updating item batch");
303     $editor->commit;
304     $logger->info("fleshed item-alter successfully updated ".scalar(@$items)." items");
305     return 1;
306 }
307
308 sub _delete_sitem {
309     my ($editor, $override, $item) = @_;
310     $logger->info("item-alter: delete item ".OpenSRF::Utils::JSON->perl2JSON($item));
311     return $editor->event unless $editor->delete_serial_item($item);
312     return 0;
313 }
314
315 sub _create_sitem {
316     my ($editor, $item) = @_;
317
318     $item->creator($editor->requestor->id);
319     $item->create_date('now');
320
321     $logger->info("item-alter: new item ".OpenSRF::Utils::JSON->perl2JSON($item));
322     return $editor->event unless $editor->create_serial_item($item);
323     return 0;
324 }
325
326 sub _update_sitem {
327     my ($editor, $override, $item) = @_;
328
329     $logger->info("item-alter: retrieving item ".$item->id);
330     my $orig_item = $editor->retrieve_serial_item($item->id);
331
332     $logger->info("item-alter: original item ".OpenSRF::Utils::JSON->perl2JSON($orig_item));
333     $logger->info("item-alter: updated item ".OpenSRF::Utils::JSON->perl2JSON($item));
334     return $editor->event unless $editor->update_serial_item($item);
335     return 0;
336 }
337
338 __PACKAGE__->register_method(
339     method  => "fleshed_serial_item_retrieve_batch",
340     authoritative => 1,
341     api_name    => "open-ils.serial.item.fleshed.batch.retrieve"
342 );
343
344 sub fleshed_serial_item_retrieve_batch {
345     my( $self, $client, $ids ) = @_;
346 # FIXME: permissions?
347     $logger->info("Fetching fleshed serial items @$ids");
348     return $U->cstorereq(
349         "open-ils.cstore.direct.serial.item.search.atomic",
350         { id => $ids },
351         { flesh => 2,
352           flesh_fields => {sitem => [ qw/issuance creator editor stream unit notes/ ], sunit => ["call_number"], siss => [qw/creator editor subscription/]}
353         });
354 }
355
356
357 ##########################################################################
358 # issuance methods
359 #
360 __PACKAGE__->register_method(
361     method    => 'fleshed_issuance_alter',
362     api_name  => 'open-ils.serial.issuance.fleshed.batch.update',
363     api_level => 1,
364     argc      => 2,
365     signature => {
366         desc     => 'Receives an array of one or more issuances and updates the database as needed',
367         'params' => [ {
368                  name => 'authtoken',
369                  desc => 'Authtoken for current user session',
370                  type => 'string'
371             },
372             {
373                  name => 'issuances',
374                  desc => 'Array of fleshed issuances',
375                  type => 'array'
376             }
377
378         ],
379         'return' => {
380             desc => 'Returns 1 if successful, event if failed',
381             type => 'mixed'
382         }
383     }
384 );
385
386 sub fleshed_issuance_alter {
387     my( $self, $conn, $auth, $issuances ) = @_;
388     return 1 unless ref $issuances;
389     my( $reqr, $evt ) = $U->checkses($auth);
390     return $evt if $evt;
391     my $editor = new_editor(authtoken => $auth, requestor => $reqr, xact => 1);
392     my $override = $self->api_name =~ /override/;
393
394     my %found_ssub_ids;
395     for my $issuance (@$issuances) {
396         my $ssub_id = ref $issuance->subscription ? $issuance->subscription->id : $issuance->subscription;
397         if (!exists($found_ssub_ids{$ssub_id})) {
398             my $owning_lib_id;
399             if (ref $issuance->subscription) {
400                 $owning_lib_id = $issuance->subscription->owning_lib;
401             } else {
402                 my $ssub = $editor->retrieve_serial_subscription($issuance->subscription) or return $editor->die_event;
403                 $owning_lib_id = $ssub->owning_lib;
404             }
405             return $editor->die_event unless
406                 $editor->allowed("ADMIN_SERIAL_SUBSCRIPTION", $owning_lib_id);
407             $found_ssub_ids{$ssub_id} = 1;
408         }
409
410         my $issuanceid = $issuance->id;
411         $issuance->editor($editor->requestor->id);
412         $issuance->edit_date('now');
413
414         if( $issuance->isdeleted ) {
415             $evt = _delete_siss( $editor, $override, $issuance);
416         } elsif( $issuance->isnew ) {
417             _cleanse_dates($issuance, ['date_published']);
418             $evt = _create_siss( $editor, $issuance );
419         } else {
420             _cleanse_dates($issuance, ['date_published']);
421             $evt = _update_siss( $editor, $override, $issuance );
422         }
423
424         last if $evt;
425     }
426
427     if( $evt ) {
428         $logger->info("fleshed issuance-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
429         $editor->rollback;
430         return $evt;
431     }
432     $logger->debug("issuance-alter: done updating issuance batch");
433     $editor->commit;
434     $logger->info("fleshed issuance-alter successfully updated ".scalar(@$issuances)." issuances");
435     return 1;
436 }
437
438 sub _delete_siss {
439     my ($editor, $override, $issuance) = @_;
440     $logger->info("issuance-alter: delete issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
441     return $editor->event unless $editor->delete_serial_issuance($issuance);
442     return 0;
443 }
444
445 sub _create_siss {
446     my ($editor, $issuance) = @_;
447
448     $issuance->creator($editor->requestor->id);
449     $issuance->create_date('now');
450
451     $logger->info("issuance-alter: new issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
452     return $editor->event unless $editor->create_serial_issuance($issuance);
453     return 0;
454 }
455
456 sub _update_siss {
457     my ($editor, $override, $issuance) = @_;
458
459     $logger->info("issuance-alter: retrieving issuance ".$issuance->id);
460     my $orig_issuance = $editor->retrieve_serial_issuance($issuance->id);
461
462     $logger->info("issuance-alter: original issuance ".OpenSRF::Utils::JSON->perl2JSON($orig_issuance));
463     $logger->info("issuance-alter: updated issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
464     return $editor->event unless $editor->update_serial_issuance($issuance);
465     return 0;
466 }
467
468 __PACKAGE__->register_method(
469     method  => "fleshed_serial_issuance_retrieve_batch",
470     authoritative => 1,
471     api_name    => "open-ils.serial.issuance.fleshed.batch.retrieve"
472 );
473
474 sub fleshed_serial_issuance_retrieve_batch {
475     my( $self, $client, $ids ) = @_;
476 # FIXME: permissions?
477     $logger->info("Fetching fleshed serial issuances @$ids");
478     return $U->cstorereq(
479         "open-ils.cstore.direct.serial.issuance.search.atomic",
480         { id => $ids },
481         { flesh => 1,
482           flesh_fields => {siss => [ qw/creator editor subscription/ ]}
483         });
484 }
485
486 __PACKAGE__->register_method(
487     method  => "pub_fleshed_serial_issuance_retrieve_batch",
488     api_name    => "open-ils.serial.issuance.pub_fleshed.batch.retrieve",
489     signature => {
490         desc => q/
491             Public (i.e. OPAC) call for getting at the sub and 
492             ultimately the record entry from an issuance
493         /,
494         params => [{name => 'ids', desc => 'Array of IDs', type => 'array'}],
495         return => {
496             desc => q/
497                 issuance objects, fleshed with subscriptions
498             /,
499             class => 'siss'
500         }
501     }
502 );
503 sub pub_fleshed_serial_issuance_retrieve_batch {
504     my( $self, $client, $ids ) = @_;
505     return [] unless $ids and @$ids;
506     return new_editor()->search_serial_issuance([
507         { id => $ids },
508         { 
509             flesh => 1,
510             flesh_fields => {siss => [ qw/subscription/ ]}
511         }
512     ]);
513 }
514
515 sub received_siss_by_bib {
516     # XXX this is somewhat wrong in implementation and should not be used in
517     # new places - senator
518     my $self = shift;
519     my $client = shift;
520     my $bib = shift;
521
522     my $args = shift || {};
523     $$args{order} ||= 'asc';
524
525     my $global = $$args{global} == 0 ? 0 : 1;
526
527     my $e = new_editor();
528     my $issuances = $e->json_query({
529         select  => {
530             siss => [
531                 $global ? { transform => "min", column => "id", aggregate => 1 } : "id",
532                 "label",
533                 "date_published"
534             ],
535             "sitem" => [
536                 # We're not really interested in the minimum here.  This is
537                 # just a way to distinguish issuances whose items have units
538                 # from issuances whose items have no units, without altogether
539                 # excluding the latter type of issuances.
540                 {"transform" => "min", "alias" => "has_units",
541                     "column" => "unit", "aggregate" => 1}
542             ]
543         },
544         from => {
545             ssub => {
546                 siss => {
547                     field => 'subscription',
548                     fkey  => 'id',
549                     join  => {
550                         sitem => {
551                             field  => 'issuance',
552                             fkey   => 'id',
553                             $$args{ou} ? ( join  => {
554                                 sstr => {
555                                     field => 'id',
556                                     fkey  => 'stream',
557                                     join  => {
558                                         sdist => {
559                                             field  => 'id',
560                                             fkey   => 'distribution'
561                                         }
562                                     }
563                                 }
564                             }) : ()
565                         }
566                     }
567                 }
568             }
569         },
570         where => {
571             '+ssub'  => { record_entry => $bib },
572             $$args{type} ? ( '+siss' => { 'holding_type' => $$args{type} } ) : (),
573             '+sitem' => {
574                 # XXX should we also take specific item statuses into account?
575                 date_received => { '!=' => undef },
576                 $$args{status} ? ( 'status' => $$args{status} ) : ()
577             },
578             $$args{ou} ? ( '+sdist' => {
579                 holding_lib => {
580                     'in' => $U->get_org_descendants($$args{ou}, $$args{depth})
581                 }
582             }) : ()
583         },
584         $$args{limit}  ? ( limit  => $$args{limit}  ) : (),
585         $$args{offset} ? ( offset => $$args{offset} ) : (),
586         order_by => [{ class => 'siss', field => 'date_published', direction => $$args{order} }],
587         distinct => 1
588     });
589
590     $client->respond({
591         "issuance" => $e->retrieve_serial_issuance($_->{"id"}),
592         "has_units" => $_->{"has_units"} ? 1 : 0
593     }) for @$issuances;
594
595     return undef;
596 }
597 __PACKAGE__->register_method(
598     method    => 'received_siss_by_bib',
599     api_name  => 'open-ils.serial.received_siss.retrieve.by_bib',
600     api_level => 1,
601     argc      => 1,
602     stream    => 1,
603     signature => {
604         desc   => 'Receives a Bib ID and other optional params and returns "siss" (issuance) objects',
605         params => [
606             {   name => 'bibid',
607                 desc => 'id of the bre to which the issuances belong',
608                 type => 'number'
609             },
610             {   name => 'args',
611                 desc =>
612 q/A hash of optional arguments.  Valid keys and their meanings:
613     global := If true, return only one representative version of a conceptual issuance regardless of the number of subscriptions, otherwise return all issuance objects meeting the requested criteria, including conceptual duplicates. Valid values are 0 (false) and 1 (true, default).
614     order  := date_published sort direction, either "asc" (chronological, default) or "desc" (reverse chronological)
615     limit  := Number of issuances to return.  Useful for paging results, or finding the oldest or newest
616     offset := Number of issuance to skip before returning results.  Useful for paging.
617     orgid  := OU id used to scope retrieval, based on distribution.holding_lib
618     depth  := OU depth used to range the scope of orgid
619     type   := Holding type filter. Valid values are "basic", "supplement" and "index". Can be a scalar (one) or arrayref (one or more).
620     status := Item status filter. Valid values are "Bindery", "Bound", "Claimed", "Discarded", "Expected", "Not Held", "Not Published" and "Received". Can be a scalar (one) or arrayref (one or more).
621 /
622             }
623         ]
624     }
625 );
626
627
628 sub scoped_bib_holdings_summary {
629     # XXX this is somewhat wrong in implementation and should not be used in
630     # new places - senator
631     my $self = shift;
632     my $client = shift;
633     my $bibid = shift;
634     my $args = shift || {};
635
636     $args->{order} = 'asc';
637
638     my ($issuances) = $self->method_lookup('open-ils.serial.received_siss.retrieve.by_bib.atomic')->run( $bibid => $args );
639
640     # split into issuance type sets
641     my %type_blob = (basic => [], supplement => [], index => []);
642     push @{ $type_blob{ $_->{"issuance"}->holding_type } }, $_->{"issuance"}
643         for (@$issuances);
644
645     # generate a statement list for each type
646     my %statement_blob;
647     for my $type ( keys %type_blob ) {
648         my ($mfhd,$list) = _summarize_contents(new_editor(), $type_blob{$type});
649
650         return {} if $U->event_code($mfhd); # _summarize_contents() failed, bad data?
651
652         $statement_blob{$type} = $list;
653     }
654
655     return \%statement_blob;
656 }
657 __PACKAGE__->register_method(
658     method    => 'scoped_bib_holdings_summary',
659     api_name  => 'open-ils.serial.bib.summary_statements',
660     api_level => 1,
661     argc      => 1,
662     signature => {
663         desc   => '** DEPRECATED and only used by JSPAC. Somewhat wrong in implementation. *** Receives a Bib ID and other optional params and returns set of holdings statements',
664         params => [
665             {   name => 'bibid',
666                 desc => 'id of the bre to which the issuances belong',
667                 type => 'number'
668             },
669             {   name => 'args',
670                 desc =>
671 q/A hash of optional arguments.  Valid keys and their meanings:
672     orgid  := OU id used to scope retrieval, based on distribution.holding_lib
673     depth  := OU depth used to range the scope of orgid
674     type   := Holding type filter. Valid values are "basic", "supplement" and "index". Can be a scalar (one) or arrayref (one or more).
675     status := Item status filter. Valid values are "Bindery", "Bound", "Claimed", "Discarded", "Expected", "Not Held", "Not Published" and "Received". Can be a scalar (one) or arrayref (one or more).
676 /
677             }
678         ]
679     }
680 );
681
682
683 ##########################################################################
684 # unit methods
685 #
686 __PACKAGE__->register_method(
687     method    => 'fleshed_sunit_alter',
688     api_name  => 'open-ils.serial.sunit.fleshed.batch.update',
689     api_level => 1,
690     argc      => 2,
691     signature => {
692         desc     => 'Receives an array of one or more Units and updates the database as needed',
693         'params' => [ {
694                  name => 'authtoken',
695                  desc => 'Authtoken for current user session',
696                  type => 'string'
697             },
698             {
699                  name => 'sunits',
700                  desc => 'Array of fleshed Units',
701                  type => 'array'
702             }
703
704         ],
705         'return' => {
706             desc => 'Returns 1 if successful, event if failed',
707             type => 'mixed'
708         }
709     }
710 );
711
712 sub fleshed_sunit_alter {
713     my( $self, $conn, $auth, $sunits ) = @_;
714     return 1 unless ref $sunits;
715     my( $reqr, $evt ) = $U->checkses($auth);
716     return $evt if $evt;
717     my $editor = new_editor(requestor => $reqr, xact => 1);
718     my $override = $self->api_name =~ /override/;
719
720     my %found_cn_ids;
721     for my $sunit (@$sunits) {
722         my $cn_id = ref $sunit->call_number ? $sunit->call_number->id : $sunit->call_number;
723         if (!exists($found_cn_ids{$cn_id})) {
724             my $owning_lib_id;
725             if (ref $sunit->call_number) {
726                 $owning_lib_id = $sunit->call_number->owning_lib;
727             } else {
728                 my $cn = $editor->retrieve_asset_call_number($sunit->call_number) or return $editor->die_event;
729                 $owning_lib_id = $cn->owning_lib;
730             }
731             return $editor->die_event unless
732                 $editor->allowed("UPDATE_COPY", $owning_lib_id);
733             $found_cn_ids{$cn_id} = 1;
734         }
735
736         if( $sunit->isdeleted ) {
737             $evt = _delete_sunit( $editor, $override, $sunit );
738         } else {
739             $sunit->default_location( $sunit->default_location->id ) if ref $sunit->default_location;
740
741             if( $sunit->isnew ) {
742                 $evt = _create_sunit( $editor, $sunit );
743             } else {
744                 $evt = _update_sunit( $editor, $override, $sunit );
745             }
746         }
747     }
748
749     if( $evt ) {
750         $logger->info("fleshed sunit-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
751         $editor->rollback;
752         return $evt;
753     }
754     $logger->debug("sunit-alter: done updating sunit batch");
755     $editor->commit;
756     $logger->info("fleshed sunit-alter successfully updated ".scalar(@$sunits)." Units");
757     return 1;
758 }
759
760 sub _delete_sunit {
761     my ($editor, $override, $sunit) = @_;
762     $logger->info("sunit-alter: delete sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
763     return $editor->event unless $editor->delete_serial_unit($sunit);
764     return 0;
765 }
766
767 sub _create_sunit {
768     my ($editor, $sunit) = @_;
769
770     # The unique barcode constraint does not span asset.copy and serial.unit.
771     # ensure the barcode on the new unit does not collide with an existing
772     # asset.copy barcode.
773     my $existing = $editor->search_asset_copy(
774         {deleted => 'f', barcode => $sunit->barcode})->[0];
775
776     if (!$existing) {
777         # The DB will prevent duplicate serial.unit barcodes, but for 
778         # consistency (and a more specific error message for the
779         # user), prevent creation attempts on serial unit barcode
780         # collisions as well.
781         $existing = $editor->search_serial_unit(
782             {deleted => 'f', barcode => $sunit->barcode})->[0];
783     }
784
785     if ($existing) {
786         $editor->rollback;
787         return new OpenILS::Event(
788             'SERIAL_UNIT_BARCODE_COLLISION', note => 
789             'Serial unit barcode collides with existing unit/copy barcode',
790             payload => {barcode => $sunit->barcode}
791         );
792     }
793
794     $logger->info("sunit-alter: new Unit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
795     return $editor->die_event unless $editor->create_serial_unit($sunit);
796     return 0;
797 }
798
799 sub _update_sunit {
800     my ($editor, $override, $sunit) = @_;
801
802     $logger->info("sunit-alter: retrieving sunit ".$sunit->id);
803     my $orig_sunit = $editor->retrieve_serial_unit($sunit->id);
804
805     $logger->info("sunit-alter: original sunit ".OpenSRF::Utils::JSON->perl2JSON($orig_sunit));
806     $logger->info("sunit-alter: updated sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
807     return $editor->event unless $editor->update_serial_unit($sunit);
808     return 0;
809 }
810
811 __PACKAGE__->register_method(
812     method  => "retrieve_unit_list",
813     authoritative => 1,
814     api_name    => "open-ils.serial.unit_list.retrieve"
815 );
816
817 sub retrieve_unit_list {
818
819     my( $self, $client, @sdist_ids ) = @_;
820
821     if(ref($sdist_ids[0])) { @sdist_ids = @{$sdist_ids[0]}; }
822
823     my $e = new_editor();
824
825     my $query = {
826         'select' => 
827             { 'sunit' => [ 'id', 'summary_contents', 'sort_key' ],
828               'sitem' => ['stream'],
829               'sstr' => ['distribution'],
830               'sdist' => [{'column' => 'label', 'alias' => 'sdist_label'}]
831             },
832         'from' =>
833             { 'sdist' =>
834                 { 'sstr' =>
835                     { 'join' =>
836                         { 'sitem' =>
837                             { 'join' => { 'sunit' => {} } }
838                         }
839                     }
840                 }
841             },
842         'distinct' => 'true',
843         'where' => { '+sdist' => {'id' => \@sdist_ids} },
844         'order_by' => [{'class' => 'sunit', 'field' => 'sort_key'}]
845     };
846
847     my $unit_list_entries = $e->json_query($query);
848     
849     my @entries;
850     foreach my $entry (@$unit_list_entries) {
851         my $value = {'sunit' => $entry->{id}, 'sstr' => $entry->{stream}, 'sdist' => $entry->{distribution}};
852         my $label = $entry->{summary_contents};
853         if (length($label) > 100) {
854             $label = substr($label, 0, 100) . '...'; # limited space in dropdown / menu
855         }
856         $label = "[$entry->{sdist_label}/$entry->{stream} #$entry->{id}] " . $label;
857         push (@entries, [$label, OpenSRF::Utils::JSON->perl2JSON($value)]);
858     }
859
860     return \@entries;
861 }
862
863
864
865 ##########################################################################
866 # predict and receive methods
867 #
868 __PACKAGE__->register_method(
869     method    => 'make_predictions',
870     api_name  => 'open-ils.serial.make_predictions',
871     api_level => 1,
872     argc      => 1,
873     signature => {
874         desc     => 'Receives an ssub id and populates the issuance and item tables',
875         'params' => [ {
876                  name => 'ssub_id',
877                  desc => 'Serial Subscription ID',
878                  type => 'int'
879             }
880         ]
881     }
882 );
883
884 sub make_predictions {
885     my ($self, $conn, $authtoken, $args) = @_;
886
887     my $editor = OpenILS::Utils::CStoreEditor->new();
888     my $ssub_id = $args->{ssub_id};
889     my $mfhd = MFHD->new(MARC::Record->new());
890
891     my $ssub = $editor->retrieve_serial_subscription([$ssub_id]);
892     my $scaps = $editor->search_serial_caption_and_pattern({ subscription => $ssub_id, active => 't'});
893     my $sdists = $editor->search_serial_distribution( [{ subscription => $ssub->id }, { flesh => 1, flesh_fields => {sdist => [ qw/ streams / ]} }] ); #TODO: 'deleted' support?
894
895     my $total_streams = 0;
896     foreach (@$sdists) {
897         $total_streams += scalar(@{$_->streams});
898     }
899     if ($total_streams < 1) {
900         $editor->disconnect;
901         # XXX TODO new event type
902         return new OpenILS::Event(
903             "BAD_PARAMS", note =>
904                 "There are no streams to direct items. Can't predict."
905         );
906     }
907
908     unless (@$scaps) {
909         $editor->disconnect;
910         # XXX TODO new event type
911         return new OpenILS::Event(
912             "BAD_PARAMS", note =>
913                 "There are no active caption-and-pattern objects associated " .
914                 "with this subscription. Can't predict."
915         );
916     }
917
918     my @predictions;
919     my $link_id = 1;
920     foreach my $scap (@$scaps) {
921         my $caption_field = _revive_caption($scap);
922         $caption_field->update('8' => $link_id);
923         my $fake_chron_needed = 0;
924         # if we have missing chron pieces, we will add them later for prediction purposes
925         if (!$caption_field->enumeration_is_chronology) {
926             if (!$caption_field->subfield('i') # no year
927                 or !$caption_field->subfield('j')) { # we had a year, but no month or season
928                 $fake_chron_needed = '1';
929             }
930         }
931         $mfhd->append_fields($caption_field);
932         my $options = {
933                 'caption' => $caption_field,
934                 'scap_id' => $scap->id,
935                 'num_to_predict' => $args->{num_to_predict},
936                 'end_date' => defined $args->{end_date} ?
937                     $_strp_date->parse_datetime($args->{end_date}) : undef
938                 };
939         my $predict_from_siss;
940         if ($args->{base_issuance}) { # predict from a given issuance
941             $predict_from_siss = $args->{base_issuance}->holding_code;
942         } else { # default to predicting from last published
943             my $last_published = $editor->search_serial_issuance([
944                     {'caption_and_pattern' => $scap->id,
945                     'subscription' => $ssub_id},
946                 {limit => 1, order_by => { siss => "date_published DESC" }}]
947                 );
948             if ($last_published->[0]) {
949                 $predict_from_siss = $last_published->[0];
950                 unless ($predict_from_siss->holding_code) {
951                     $editor->disconnect;
952                     # XXX TODO new event type
953                     return new OpenILS::Event(
954                         "BAD_PARAMS", note =>
955                             "Last issuance has no holding code. Can't predict."
956                     );
957                 }
958             } else {
959                 $editor->disconnect;
960                 # XXX TODO make a new event type instead of hijacking this one
961                 return new OpenILS::Event(
962                     "BAD_PARAMS", note => "No issuance from which to predict!"
963                 );
964             }
965         }
966         $options->{predict_from} = _revive_holding($predict_from_siss->holding_code, $caption_field, 1); # fresh MFHD Record, so we simply default to 1 for seqno
967         if ($fake_chron_needed) {
968             $options->{faked_chron_date} = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($predict_from_siss->date_published));
969         }
970         push( @predictions, _generate_issuance_values($mfhd, $options) );
971         $link_id++;
972     }
973
974     my @issuances;
975     foreach my $prediction (@predictions) {
976         my $issuance = new Fieldmapper::serial::issuance;
977         $issuance->isnew(1);
978         $issuance->label($prediction->{label});
979         $issuance->date_published($prediction->{date_published}->strftime('%F'));
980         $issuance->holding_code(OpenSRF::Utils::JSON->perl2JSON($prediction->{holding_code}));
981         $issuance->holding_type($prediction->{holding_type});
982         $issuance->caption_and_pattern($prediction->{caption_and_pattern});
983         $issuance->subscription($ssub->id);
984         push (@issuances, $issuance);
985     }
986
987     my $evt = fleshed_issuance_alter($self, $conn, $authtoken, \@issuances);
988     return $evt if ref $evt;
989
990     my @items;
991     for (my $i = 0; $i < @issuances; $i++) {
992         my $date_expected = $predictions[$i]->{date_published}->add(seconds => interval_to_seconds($ssub->expected_date_offset))->strftime('%F');
993         my $issuance = $issuances[$i];
994         #$issuance->label(interval_to_seconds($ssub->expected_date_offset));
995         foreach my $sdist (@$sdists) {
996             my $streams = $sdist->streams;
997             foreach my $stream (@$streams) {
998                 my $item = new Fieldmapper::serial::item;
999                 $item->isnew(1);
1000                 $item->stream($stream->id);
1001                 $item->date_expected($date_expected);
1002                 $item->issuance($issuance->id);
1003                 push (@items, $item);
1004             }
1005         }
1006     }
1007     fleshed_item_alter($self, $conn, $authtoken, \@items); # FIXME: catch events
1008     return \@items;
1009 }
1010
1011 #
1012 # _generate_issuance_values() is an initial attempt at a function which can be used
1013 # to populate an issuance table with a list of predicted issues.  It accepts
1014 # a hash ref of options initially defined as:
1015 # caption : the caption field to predict on
1016 # num_to_predict : the number of issues you wish to predict
1017 # faked_chron_date : if the serial does not actually have a chronology caption (but we need one for prediction's sake), base predictions on this date
1018 #
1019 # The basic method is to first convert to a single holding if compressed, then
1020 # increment the holding and save the resulting values to @issuances.
1021
1022 # returns @issuance_values, an array of hashrefs containing (formatted
1023 # label, formatted chronology date, formatted estimated arrival date, and an
1024 # array ref of holding subfields as (key, value, key, value ...)) (not a hash
1025 # to protect order and possible duplicate keys), and a holding type.
1026 #
1027 sub _generate_issuance_values {
1028     my ($mfhd, $options) = @_;
1029     my $caption = $options->{caption};
1030     my $scap_id = $options->{scap_id};
1031     my $num_to_predict = $options->{num_to_predict};
1032     my $end_date = $options->{end_date};
1033     my $predict_from = $options->{predict_from};   # MFHD::Holding to predict from
1034     my $faked_chron_date = $options->{faked_chron_date};   # serial does not have a (complete) chronology caption, so add one (temporarily) based on this date 
1035
1036
1037 # Only needed for 'real' MFHD records, not our temp records
1038 #    my $link_id = $caption->link_id;
1039 #    if(!$predict_from) {
1040 #        my $htag = $caption->tag;
1041 #        $htag =~ s/^85/86/;
1042 #        my @holdings = $mfhd->holdings($htag, $link_id);
1043 #        my $last_holding = $holdings[-1];
1044 #
1045 #        #if ($last_holding->is_compressed) {
1046 #        #    $last_holding->compressed_to_last; # convert to last in range
1047 #        #}
1048 #        $predict_from = $last_holding;
1049 #    }
1050 #
1051
1052     $predict_from->notes('public',  []);
1053 # add a note marker for system use (?)
1054     $predict_from->notes('private', ['AUTOGEN']);
1055
1056     # our basic method for dealing with 'faked' chronologies will be to add it in, do the predicting, then take it back out
1057     my @faked_subfield_chars;
1058     if ($faked_chron_date) {
1059         my $faked_caption = new MARC::Field($caption->tag, $caption->indicator(1), $caption->indicator(2), $caption->subfields_list);
1060
1061         my %mfhd_chron_labels = ('i' => 'year', 'j' => 'month', 'k' => 'day');
1062         foreach my $subfield_char ('i', 'j', 'k') {
1063             if (!$caption->subfield($subfield_char)) { # if we are missing a piece, add it
1064                 push(@faked_subfield_chars, $subfield_char);
1065                 my $chron_name = $mfhd_chron_labels{$subfield_char};
1066                 $faked_caption->add_subfields($subfield_char => "($chron_name)");
1067                 my $method = $mfhd_chron_labels{$subfield_char};
1068                 $predict_from->add_subfields($subfield_char => $faked_chron_date->$chron_name);
1069             }
1070         }
1071         # because of the way MFHD::Caption and Holding work, it is simplest
1072         # to recreate rather than try to update
1073         $faked_caption = new MFHD::Caption($faked_caption);
1074         $predict_from = new MFHD::Holding($predict_from->seqno, new MARC::Field($predict_from->tag, $predict_from->indicator(1), $predict_from->indicator(2), $predict_from->subfields_list), $faked_caption);
1075     }
1076
1077     my @predictions = $mfhd->generate_predictions({'base_holding' => $predict_from, 'num_to_predict' => $num_to_predict, 'end_date' => $end_date});
1078
1079     my $pub_date;
1080     my @issuance_values;
1081     foreach my $prediction (@predictions) {
1082         $pub_date = $_strp_date->parse_datetime($prediction->chron_to_date);
1083         if ($faked_chron_date) { # get rid of the chronology portions and restore original caption
1084             $prediction->delete_subfield(code => \@faked_subfield_chars);
1085             $prediction = new MFHD::Holding($prediction->seqno, new MARC::Field($prediction->tag, $prediction->indicator(1), $prediction->indicator(2), $prediction->subfields_list), $caption);
1086         }
1087         push(
1088                 @issuance_values,
1089                 {
1090                     #$link_id,
1091                     label => $prediction->format,
1092                     date_published => $pub_date,
1093                     #date_expected => $date_expected->strftime('%F'),
1094                     holding_code => [$prediction->indicator(1),$prediction->indicator(2),$prediction->subfields_list],
1095                     holding_type => $MFHD_NAMES_BY_TAG{$caption->tag},
1096                     caption_and_pattern => $scap_id
1097                 }
1098             );
1099     }
1100
1101     return @issuance_values;
1102 }
1103
1104 sub _revive_caption {
1105     my $scap = shift;
1106
1107     my $pattern_code = $scap->pattern_code;
1108
1109     # build MARC::Field
1110     my $pattern_parts = OpenSRF::Utils::JSON->JSON2perl($pattern_code);
1111     unshift(@$pattern_parts, $MFHD_TAGS_BY_NAME{$scap->type});
1112     my $pattern_field = new MARC::Field(@$pattern_parts);
1113
1114     # build MFHD::Caption
1115     return new MFHD::Caption($pattern_field);
1116 }
1117
1118 sub _revive_holding {
1119     my $holding_code = shift;
1120     my $caption_field = shift;
1121     my $seqno = shift;
1122
1123     # build MARC::Field
1124     my $holding_parts = OpenSRF::Utils::JSON->JSON2perl($holding_code);
1125     my $captag = $caption_field->tag;
1126     $captag =~ s/^85/86/;
1127     unshift(@$holding_parts, $captag);
1128     my $holding_field = new MARC::Field(@$holding_parts);
1129
1130     # build MFHD::Holding
1131     return new MFHD::Holding($seqno, $holding_field, $caption_field);
1132
1133     # TODO(?) the underlying MARC and the Holding object end up in conflict concerning subfield '8'
1134 }
1135
1136 __PACKAGE__->register_method(
1137     method    => 'unitize_items',
1138     api_name  => 'open-ils.serial.receive_items',
1139     api_level => 1,
1140     argc      => 1,
1141     signature => {
1142         desc     => 'Marks an item as received, updates the shelving unit (creating a new shelving unit if needed), and updates the summaries',
1143         'params' => [ {
1144                  name => 'items',
1145                  desc => 'array of serial items',
1146                  type => 'array'
1147             },
1148             {
1149                  name => 'barcodes',
1150                  desc => 'hash of item_ids => barcodes',
1151                  type => 'hash'
1152             },
1153             {
1154                  name => 'call_numbers',
1155                  desc => 'hash of item_ids => call_numbers',
1156                  type => 'hash'
1157             },
1158             {
1159                  name => 'donor_unit_ids',
1160                  desc => 'hash of unit_ids => 1, keyed with ids of any units giving up items',
1161                  type => 'hash'
1162             }
1163         ],
1164         'return' => {
1165             desc => 'Returns number of received items (num_items) and new unit ID, if applicable (new_unit_id)',
1166             type => 'hashref'
1167         }
1168     }
1169 );
1170
1171 __PACKAGE__->register_method(
1172     method    => 'unitize_items',
1173     api_name  => 'open-ils.serial.bind_items',
1174     api_level => 1,
1175     argc      => 1,
1176     signature => {
1177         desc     => 'Marks an item as bound, updates the shelving unit (creating a new shelving unit if needed)',
1178         'params' => [ {
1179                  name => 'items',
1180                  desc => 'array of serial items',
1181                  type => 'array'
1182             },
1183             {
1184                  name => 'barcodes',
1185                  desc => 'hash of item_ids => barcodes',
1186                  type => 'hash'
1187             },
1188             {
1189                  name => 'call_numbers',
1190                  desc => 'hash of item_ids => call_numbers',
1191                  type => 'hash'
1192             },
1193             {
1194                  name => 'donor_unit_ids',
1195                  desc => 'hash of unit_ids => 1, keyed with ids of any units giving up items',
1196                  type => 'hash'
1197             }
1198         ],
1199         'return' => {
1200             desc => 'Returns number of bound items (num_items) and new unit ID, if applicable (new_unit_id)',
1201             type => 'hashref'
1202         }
1203     }
1204 );
1205
1206 # TODO: reset/delete claims information once implemented
1207 # XXX: deal with emptied call numbers here?
1208 __PACKAGE__->register_method(
1209     method    => 'unitize_items',
1210     api_name  => 'open-ils.serial.reset_items',
1211     api_level => 1,
1212     argc      => 1,
1213     signature => {
1214         desc     => 'Resets the items to Expected, updates the shelving unit (deleting the shelving unit if empty), and updates the summaries',
1215         'params' => [ {
1216                  name => 'items',
1217                  desc => 'array of serial items',
1218                  type => 'array'
1219             }
1220         ],
1221         'return' => {
1222             desc => 'Returns number of reset items (num_items)',
1223             type => 'hashref'
1224         }
1225     }
1226 );
1227
1228 sub unitize_items {
1229     my ($self, $conn, $auth, $items, $barcodes, $call_numbers, $donor_unit_ids) = @_;
1230
1231     my $editor = new_editor("authtoken" => $auth, "xact" => 1);
1232     return $editor->die_event unless $editor->checkauth;
1233     return $editor->die_event unless $editor->allowed("RECEIVE_SERIAL");
1234     $self->api_name =~ /serial\.(\w*)_items/;
1235     my $mode = $1;
1236     
1237     my %found_unit_ids;
1238     if ($donor_unit_ids) { # units giving up items need updating as well
1239         %found_unit_ids = %$donor_unit_ids;
1240     }
1241     my %found_stream_ids;
1242     my %found_types;
1243
1244     my %stream_ids_by_unit_id;
1245
1246     my %unit_map;
1247     my %sdist_by_unit_id;
1248     my %call_number_by_unit_id;
1249     my %sdist_by_stream_id;
1250
1251     my $new_unit_id; # id for '-2' units to share
1252     foreach my $item (@$items) {
1253         # for debugging only, TODO: delete
1254         if (!ref $item) { # hopefully we got an id instead
1255             $item = $editor->retrieve_serial_item($item);
1256         }
1257         # get ids
1258         my $unit_id = ref($item->unit) ? $item->unit->id : $item->unit;
1259         my $stream_id = ref($item->stream) ? $item->stream->id : $item->stream;
1260         my $issuance_id = ref($item->issuance) ? $item->issuance->id : $item->issuance;
1261         #TODO: evt on any missing ids
1262
1263         if ($mode eq 'receive') {
1264             $item->date_received('now');
1265             $item->status('Received');
1266         } elsif ($mode eq 'reset') {
1267             # clear date_received
1268             $item->clear_date_received;
1269             # Set status to 'Expected'
1270             $item->status('Expected');
1271             # remove from unit
1272             $item->clear_unit;
1273         }
1274
1275         # check for types to trigger summary updates
1276         my $scap;
1277         if (!ref $item->issuance) {
1278             my $scaps = $editor->search_serial_caption_and_pattern([{"+siss" => {"id" => $issuance_id}}, { "join" => {"siss" => {}} }]);
1279             $scap = $scaps->[0];
1280         } elsif (!ref $item->issuance->caption_and_pattern) {
1281             $scap = $editor->retrieve_serial_caption_and_pattern($item->issuance->caption_and_pattern);
1282         } else {
1283             $scap = $editor->issuance->caption_and_pattern;
1284         }
1285         if (!exists($found_types{$stream_id})) {
1286             $found_types{$stream_id} = {};
1287         }
1288         $found_types{$stream_id}->{$scap->type} = 1;
1289
1290         # create unit if needed
1291         if ($unit_id == -1 or (!$new_unit_id and $unit_id == -2)) { # create unit per item
1292             my $unit;
1293             my $sdists = $editor->search_serial_distribution([
1294                 {"+sstr" => {"id" => $stream_id}},
1295                 {
1296                     "join" => {"sstr" => {}},
1297                     "flesh" => 1,
1298                     "flesh_fields" => {"sdist" => ["subscription"]}
1299                 }]);
1300             $unit = _build_unit($editor, $sdists->[0], $mode);
1301             # if _build_unit fails, $unit is an event, so return it
1302             if ($U->event_code($unit)) {
1303                 $editor->rollback;
1304                 $unit->{"note"} = "Item ID: " . $item->id;
1305                 return $unit;
1306             }
1307             $unit->barcode($barcodes->{$item->id}) if exists($barcodes->{$item->id});
1308             my $evt =  _create_sunit($editor, $unit);
1309             return $evt if $evt;
1310             if ($unit_id == -2) {
1311                 $new_unit_id = $unit->id;
1312                 $unit_id = $new_unit_id;
1313             } else {
1314                 $unit_id = $unit->id;
1315             }
1316             $item->unit($unit_id);
1317             
1318             # get unit with 'DEFAULT's and save unit, sdist, and call number for later use
1319             $unit = $editor->retrieve_serial_unit($unit->id);
1320             $unit_map{$unit_id} = $unit;
1321             $sdist_by_unit_id{$unit_id} = $sdists->[0];
1322             $call_number_by_unit_id{$unit_id} = $call_numbers->{$item->id};
1323             $sdist_by_stream_id{$stream_id} = $sdists->[0];
1324         } elsif ($unit_id == -2) { # create one unit for all '-2' items
1325             $unit_id = $new_unit_id;
1326             $item->unit($unit_id);
1327         }
1328
1329         $found_stream_ids{$stream_id} = 1;
1330
1331         if (defined($unit_id) and $unit_id ne '') {
1332             $found_unit_ids{$unit_id} = 1;
1333             # save the stream_id for this unit_id
1334             # TODO: prevent items from different streams in same unit? (perhaps in interface)
1335             $stream_ids_by_unit_id{$unit_id} = $stream_id;
1336         } else {
1337             $item->clear_unit;
1338         }
1339
1340         my $evt = _update_sitem($editor, undef, $item);
1341         return $evt if $evt;
1342     }
1343
1344     # cleanup 'dead' units (units which are now emptied of their items)
1345     my $dead_units = $editor->search_serial_unit([{'+sitem' => {'id' => undef}, 'deleted' => 'f'}, {'join' => {'sitem' => {'type' => 'left'}}}]);
1346     foreach my $unit (@$dead_units) {
1347         _delete_sunit($editor, undef, $unit);
1348         delete $found_unit_ids{$unit->id};
1349     }
1350
1351     # deal with unit level contents
1352     foreach my $unit_id (keys %found_unit_ids) {
1353
1354         # get all the needed issuances for unit
1355         # TODO remove 'Bindery' from this search (leaving it in for now for backwards compatibility with any current test environment data)
1356         my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"unit" => $unit_id, "status" => ["Received", "Bindery"]}}, {"join" => {"sitem" => {}}, "order_by" => {"siss" => "date_published"}} ]);
1357         #TODO: evt on search failure
1358
1359         # retrieve and update unit contents
1360         my $sunit;
1361         my $sdist;
1362         my $call_number_string;
1363         my $record_id;
1364         # if we just created the unit, we will already have it and the distribution stored, and we will need to assign the call number
1365         if (exists $unit_map{$unit_id}) {
1366             $sunit = $unit_map{$unit_id};
1367             $sdist = $sdist_by_unit_id{$unit_id};
1368             $call_number_string = $call_number_by_unit_id{$unit_id};
1369             $record_id = $sdist->subscription->record_entry;
1370         } else {
1371             # XXX: this code assumes you will not have units which mix streams/distributions, but current code does not enforce this
1372             $sunit = $editor->retrieve_serial_unit($unit_id);
1373             if ($stream_ids_by_unit_id{$unit_id}) {
1374                 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_ids_by_unit_id{$unit_id}}}, { "join" => {"sstr" => {}}, 'limit' => 1 }]);
1375             } else {
1376                 $sdist = $editor->search_serial_distribution([
1377                     {'+sunit' => {'id' => $unit_id}},
1378                     { 'join' =>
1379                         {'sstr' =>
1380                             { 'join' =>
1381                                 { 'sitem' =>
1382                                     { 'join' => 'sunit' }
1383                                 } 
1384                             } 
1385                         },
1386                       'limit' => 1
1387                     }]);
1388             }
1389             $sdist = $sdist->[0];
1390         }
1391
1392         my $evt = _prepare_unit($editor, $sunit, $sdist, $issuances, $call_number_string, $record_id);
1393         if ($U->event_code($evt)) {
1394             $editor->rollback;
1395             return $evt;
1396         }
1397
1398         $evt = _update_sunit($editor, undef, $sunit);
1399         if ($U->event_code($evt)) {
1400             $editor->rollback;
1401             return $evt;
1402         }
1403     }
1404
1405     if ($mode ne 'bind') { # the summary holdings do not change when binding
1406         # deal with stream level summaries
1407         # summaries will be built from the "primary" stream only, that is, the stream with the lowest ID per distribution
1408         # (TODO: consider direct designation)
1409         my %primary_streams_by_sdist;
1410         my %streams_by_sdist;
1411
1412         # see if we have primary streams, and if so, associate them with their distributions
1413         foreach my $stream_id (keys %found_stream_ids) {
1414             my $sdist;
1415             if (exists $sdist_by_stream_id{$stream_id}) {
1416                 $sdist = $sdist_by_stream_id{$stream_id};
1417             } else {
1418                 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
1419                 $sdist = $sdist->[0];
1420                 $sdist_by_stream_id{$stream_id} = $sdist;
1421             }
1422             my $streams;
1423             if (!exists($streams_by_sdist{$sdist->id})) {
1424                 $streams = $editor->search_serial_stream([{"distribution" => $sdist->id}, {"order_by" => {"sstr" => "id"}}]);
1425                 $streams_by_sdist{$sdist->id} = $streams;
1426             } else {
1427                 $streams = $streams_by_sdist{$sdist->id};
1428             }
1429             $primary_streams_by_sdist{$sdist->id} = $streams->[0] if ($stream_id == $streams->[0]->id);
1430         }
1431
1432         # retrieve and update summaries for each affected primary stream's distribution
1433         foreach my $sdist_id (keys %primary_streams_by_sdist) {
1434             my $stream = $primary_streams_by_sdist{$sdist_id};
1435             my $stream_id = $stream->id;
1436             # get all the needed issuances for stream
1437             # FIXME: search in Bindery/Bound/Not Published? as well as Received
1438             foreach my $type (keys %{$found_types{$stream_id}}) {
1439                 my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"stream" => $stream_id, "status" => "Received"}, "+scap" => {"type" => $type}}, {"join" => {"sitem" => {}, "scap" => {}}, "order_by" => {"siss" => "date_published"}} ]);
1440                 #TODO: evt on search failure
1441                 my $evt = _prepare_summaries($editor, $issuances, $sdist_by_stream_id{$stream_id}, $type);
1442                 if ($U->event_code($evt)) {
1443                     $editor->rollback;
1444                     return $evt;
1445                 }
1446             }
1447         }
1448     }
1449
1450     $editor->commit;
1451     return {'num_items' => scalar @$items, 'new_unit_id' => $new_unit_id};
1452 }
1453
1454 sub _find_or_create_call_number {
1455     my ($e, $lib, $cn_string, $record) = @_;
1456
1457     # FIXME: should suffix and prefix come into play here?
1458     my $existing = $e->search_asset_call_number({
1459         "owning_lib" => $lib,
1460         "label" => $cn_string,
1461         "record" => $record,
1462         "deleted" => "f"
1463     }) or return $e->die_event;
1464
1465     if (@$existing) {
1466         return $existing->[0]->id;
1467     } else {
1468         return $e->die_event unless
1469             $e->allowed("CREATE_VOLUME", $lib);
1470
1471         my $acn = new Fieldmapper::asset::call_number;
1472
1473         $acn->creator($e->requestor->id);
1474         $acn->editor($e->requestor->id);
1475         $acn->record($record);
1476         $acn->label($cn_string);
1477         $acn->owning_lib($lib);
1478
1479         $e->create_asset_call_number($acn) or return $e->die_event;
1480         return $e->data->id;
1481     }
1482 }
1483
1484 sub _issuances_received {
1485     # XXX TODO: Add some caching or something. This is getting called
1486     # more often than it has to be.
1487     my ($e, $sitem) = @_;
1488
1489     my $results = $e->json_query({
1490         "select" => {"sitem" => ["issuance"]},
1491         "from" => {"sitem" => {"sstr" => {}, "siss" => {}}},
1492         "where" => {
1493             "+sstr" => {"distribution" => $sitem->stream->distribution->id},
1494             "+siss" => {"holding_type" => $sitem->issuance->holding_type},
1495             "+sitem" => {"date_received" => {"!=" => undef}}
1496         },
1497         "order_by" => {
1498             "siss" => {"date_published" => {"direction" => "asc"}}
1499         }
1500     }) or return $e->die_event;
1501
1502     my %seen;
1503     my $issuances = [];
1504     for my $iss_id (map { $_->{"issuance"} } @$results) {
1505         next if $seen{$iss_id};
1506         $seen{$iss_id} = 1;
1507         push(@$issuances, $e->retrieve_serial_issuance($iss_id));
1508     }
1509     return $issuances;
1510 }
1511
1512 # _prepare_unit populates the detailed_contents, summary_contents, and
1513 # sort_key fields for a given unit based on a given set of issuances
1514 # Also finds/creates call number as needed
1515 sub _prepare_unit {
1516     my ($e, $sunit, $sdist, $issuances, $call_number_string, $record_id) = @_;
1517
1518     # Handle call number first if we have one
1519     if ($call_number_string) {
1520         my $org_unit_id = ref $sdist->holding_lib ? $sdist->holding_lib->id : $sdist->holding_lib;
1521         my $real_cn = _find_or_create_call_number(
1522             $e, $org_unit_id,
1523             $call_number_string, $record_id
1524         );
1525
1526         if ($U->event_code($real_cn)) {
1527             return $real_cn;
1528         } else {
1529             $sunit->call_number($real_cn);
1530         }
1531     }
1532
1533     my ($mfhd, $formatted_parts) = _summarize_contents($e, $issuances);
1534     return $mfhd if $U->event_code($mfhd);
1535
1536     # special case for single formatted_part (may have summarized version)
1537     if (@$formatted_parts == 1) {
1538         #TODO: MFHD.pm should have a 'format_summary' method for this
1539     }
1540
1541     $sunit->detailed_contents(
1542         join(
1543             " ",
1544             $sdist->unit_label_prefix,
1545             join(", ", @$formatted_parts),
1546             $sdist->unit_label_suffix
1547         )
1548     );
1549
1550     # TODO: change this when real summary contents are available
1551     $sunit->summary_contents($sunit->detailed_contents);
1552
1553     # Create sort_key by left padding numbers to 6 digits.
1554     (my $sort_key = $sunit->detailed_contents) =~
1555         s/(\d+)/sprintf '%06d', $1/eg;
1556     $sunit->sort_key($sort_key);
1557 }
1558
1559 # _prepare_summaries populates the generated_coverage field for a given summary 
1560 # type ('basic', 'index', 'supplement') for a given distribution.
1561 # It also creates the summary if it doesn't yet exist.
1562 sub _prepare_summaries {
1563     my ($e, $issuances, $sdist, $type) = @_;
1564
1565     my ($mfhd, $formatted_parts) = _summarize_contents($e, $issuances, $sdist, $type);
1566     return $mfhd if $U->event_code($mfhd);
1567
1568     my $search_method = "search_serial_${type}_summary";
1569     my $summary = $e->$search_method([{"distribution" => $sdist->id}]);
1570
1571     my $cu_method = "update";
1572
1573     if (@$summary) {
1574         $summary = $summary->[0];
1575     } else {
1576         my $class = "Fieldmapper::serial::${type}_summary";
1577         $summary = $class->new;
1578         $summary->distribution($sdist->id);
1579         $cu_method = "create";
1580     }
1581
1582     if (@$formatted_parts) {
1583         $summary->generated_coverage(OpenSRF::Utils::JSON->perl2JSON($formatted_parts));
1584     } else {
1585         # we had no issuances or MFHD data for this type, so clear any
1586         # generated data which may have existed before
1587         $summary->generated_coverage('');
1588     }
1589     my $method = "${cu_method}_serial_${type}_summary";
1590     return $e->die_event unless $e->$method($summary);
1591 }
1592
1593 sub _unit_by_iss_and_str {
1594     my ($e, $issuance, $stream) = @_;
1595
1596     my $unit = $e->json_query({
1597         "select" => {"sunit" => ["id"]},
1598         "from" => {"sitem" => {"sunit" => {}}},
1599         "where" => {
1600             "+sitem" => {
1601                 "issuance" => $issuance->id,
1602                 "stream" => $stream->id
1603             }
1604         }
1605     }) or return $e->die_event;
1606     return 0 if not @$unit;
1607
1608     $e->retrieve_serial_unit($unit->[0]->{"id"}) or $e->die_event;
1609 }
1610
1611 sub move_previous_unit {
1612     my ($e, $prev_iss, $curr_item, $new_loc) = @_;
1613
1614     my $prev_unit = _unit_by_iss_and_str($e,$prev_iss,$curr_item->stream);
1615     return $prev_unit if defined $U->event_code($prev_unit);
1616     return 0 if not $prev_unit;
1617
1618     if ($prev_unit->location != $new_loc) {
1619         $prev_unit->location($new_loc);
1620         $e->update_serial_unit($prev_unit) or return $e->die_event;
1621     }
1622     0;
1623 }
1624
1625 # _previous_issuance() assumes $existing is an ordered array
1626 sub _previous_issuance {
1627     my ($existing, $issuance) = @_;
1628
1629     my $last = $existing->[-1];
1630     return undef unless $last;
1631     return ($last->id == $issuance->id ? $existing->[-2] : $last);
1632 }
1633
1634 __PACKAGE__->register_method(
1635     "method" => "receive_items_one_unit_per",
1636     "api_name" => "open-ils.serial.receive_items.one_unit_per",
1637     "stream" => 1,
1638     "api_level" => 1,
1639     "argc" => 3,
1640     "signature" => {
1641         "desc" => "Marks items in a list as received, creates a new unit for each item if any unit is fleshed on, and updates summaries as needed",
1642         "params" => [
1643             {
1644                  "name" => "auth",
1645                  "desc" => "authtoken",
1646                  "type" => "string"
1647             },
1648             {
1649                  "name" => "items",
1650                  "desc" => "array of serial items, possibly fleshed with units and definitely fleshed with stream->distribution",
1651                  "type" => "array"
1652             },
1653             {
1654                 "name" => "record",
1655                 "desc" => "id of bib record these items are associated with
1656                     (XXX could/should be derived from items)",
1657                 "type" => "number"
1658             }
1659         ],
1660         "return" => {
1661             "desc" => "The item ID for each item successfully received",
1662             "type" => "int"
1663         }
1664     }
1665 );
1666
1667 sub receive_items_one_unit_per {
1668     # XXX This function may be temporary, as it does some of what
1669     # unitize_items() does, just in a different way.
1670     my ($self, $client, $auth, $items, $record) = @_;
1671
1672     my $e = new_editor("authtoken" => $auth, "xact" => 1);
1673     return $e->die_event unless $e->checkauth;
1674     return $e->die_event unless $e->allowed("RECEIVE_SERIAL");
1675
1676     my $prev_loc_setting_map = {};
1677     my $user_id = $e->requestor->id;
1678
1679     # Get a list of all the non-virtual field names in a serial::unit for
1680     # merging given unit objects with template-built units later.
1681     # XXX move this somewhere global so it isn't re-run all the time
1682     my $all_unit_fields =
1683         $Fieldmapper::fieldmap->{"Fieldmapper::serial::unit"}->{"fields"};
1684     my @real_unit_fields = grep {
1685         not $all_unit_fields->{$_}->{"virtual"}
1686     } keys %$all_unit_fields;
1687
1688     foreach my $item (@$items) {
1689         # Note that we expect a certain fleshing on the items we're getting.
1690         my $sdist = $item->stream->distribution;
1691
1692         # Fetch a list of issuances with received copies already existing
1693         # on this distribution (and with the same holding type on the
1694         # issuance).  This will be used in up to two places: once when building
1695         # a summary, once when changing the copy location of the previous
1696         # issuance's copy.
1697         my $issuances_received = _issuances_received($e, $item);
1698         if ($U->event_code($issuances_received)) {
1699             $e->rollback;
1700             return $issuances_received;
1701         }
1702
1703         # Find out if we need to to deal with previous copy location changing.
1704         my $ou = $sdist->holding_lib->id;
1705         unless (exists $prev_loc_setting_map->{$ou}) {
1706             $prev_loc_setting_map->{$ou} = $U->ou_ancestor_setting_value(
1707                 $ou, "serial.prev_issuance_copy_location", $e
1708             );
1709         }
1710
1711         # If there is a previous copy location setting, we need the previous
1712         # issuance, from which we can in turn look up the item attached to the
1713         # same stream we're on now.
1714         if ($prev_loc_setting_map->{$ou}) {
1715             if (my $prev_iss =
1716                 _previous_issuance($issuances_received, $item->issuance)) {
1717
1718                 # Now we can change the copy location of the previous unit,
1719                 # if needed.
1720                 return $e->event if defined $U->event_code(
1721                     move_previous_unit(
1722                         $e, $prev_iss, $item, $prev_loc_setting_map->{$ou}
1723                     )
1724                 );
1725             }
1726         }
1727
1728         # Create unit if given by user
1729         if (ref $item->unit) {
1730             # detach from the item, as we need to create separately
1731             my $user_unit = $item->unit;
1732
1733             # get a unit based on associated template
1734             my $template_unit = _build_unit($e, $sdist, "receive");
1735             if ($U->event_code($template_unit)) {
1736                 $e->rollback;
1737                 $template_unit->{"note"} = "Item ID: " . $item->id;
1738                 return $template_unit;
1739             }
1740
1741             # merge built unit with provided unit from user
1742             foreach (@real_unit_fields) {
1743                 unless ($user_unit->$_) {
1744                     $user_unit->$_($template_unit->$_);
1745                 }
1746             }
1747
1748             # Treat call number specially: the provided value from the
1749             # user will really be a string.
1750             my $call_number_string;
1751             if ($user_unit->call_number) {
1752                 $call_number_string = $user_unit->call_number;
1753                 # clear call number for now (replaced in _prepare_unit)
1754                 $user_unit->clear_call_number;
1755             }
1756
1757             my $evt = _prepare_unit(
1758                 $e, $user_unit, $sdist, [$item->issuance],
1759                 $call_number_string, $record
1760             );
1761             if ($U->event_code($evt)) {
1762                 $e->rollback;
1763                 return $evt;
1764             }
1765
1766             # create/update summary objects related to this distribution
1767             # Make sure @$issuances_received contains current item's issuance
1768             unless (grep { $_->id == $item->issuance->id } @$issuances_received) {
1769                 push @$issuances_received, $item->issuance;
1770             }
1771             $evt = _prepare_summaries($e, $issuances_received, $item->stream->distribution, $item->issuance->holding_type);
1772             if ($U->event_code($evt)) {
1773                 $e->rollback;
1774                 return $evt;
1775             }
1776
1777             # set the incontrovertibles on the unit
1778             $user_unit->edit_date("now");
1779             $user_unit->create_date("now");
1780             $user_unit->editor($user_id);
1781             $user_unit->creator($user_id);
1782
1783             $evt = _create_sunit($e, $user_unit);
1784             return $evt if $evt;
1785
1786             # save reference to new unit
1787             $item->unit($e->data->id);
1788         }
1789
1790         # Create notes if given by user
1791         if (ref($item->notes) and @{$item->notes}) {
1792             foreach my $note (@{$item->notes}) {
1793                 $note->creator($user_id);
1794                 $note->create_date("now");
1795
1796                 return $e->die_event unless $e->create_serial_item_note($note);
1797             }
1798
1799             $item->clear_notes; # They're saved; we no longer want them here.
1800         }
1801
1802         # Set the incontrovertibles on the item
1803         $item->status("Received");
1804         $item->date_received("now");
1805         $item->edit_date("now");
1806         $item->editor($user_id);
1807
1808         return $e->die_event unless $e->update_serial_item($item);
1809
1810         # send client a response
1811         $client->respond($item->id);
1812     }
1813
1814     $e->commit or return $e->die_event;
1815     undef;
1816 }
1817
1818 sub _build_unit {
1819     my $editor = shift;
1820     my $sdist = shift;
1821     my $mode = shift;
1822     #my $skip_call_number = shift;
1823
1824     my $attr = $mode . '_unit_template';
1825     my $template = $editor->retrieve_asset_copy_template($sdist->$attr) or
1826         return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_COPY_TEMPLATE");
1827
1828     my @parts = qw( status location loan_duration fine_level age_protect circulate deposit ref holdable deposit_amount price circ_modifier circ_as_type alert_message opac_visible floating mint_condition );
1829
1830     my $unit = new Fieldmapper::serial::unit;
1831     foreach my $part (@parts) {
1832         my $value = $template->$part;
1833         next if !defined($value);
1834         $unit->$part($value);
1835     }
1836
1837     # ignore circ_lib in template, set to distribution holding_lib
1838     $unit->circ_lib($sdist->holding_lib);
1839     $unit->creator($editor->requestor->id);
1840     $unit->editor($editor->requestor->id);
1841
1842 # XXX: this feature has been pushed back until after 2.0 at least
1843 #    unless ($skip_call_number) {
1844 #        $attr = $mode . '_call_number';
1845 #        my $cn = $sdist->$attr or
1846 #            return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_CALL_NUMBER");
1847 #
1848 #        $unit->call_number($cn);
1849 #    }
1850     $unit->call_number('-1'); # default to the dummy call number
1851     $unit->barcode('@@PLACEHOLDER'); # generic unit will start with a generated placeholder barcode
1852     $unit->sort_key('');
1853     $unit->summary_contents('');
1854     $unit->detailed_contents('');
1855
1856     return $unit;
1857 }
1858
1859 sub _summarize_contents {
1860     my $editor = shift;
1861     my $issuances = shift;
1862     my $sdist = shift;
1863     my $type = shift;
1864
1865     # create or lookup MFHD record
1866     my $mfhd;
1867     if ($sdist and defined($sdist->record_entry) and $sdist->summary_method eq 'merge_with_sre') {
1868         my $sre;
1869         if (ref $sdist->record_entry) {
1870             $sre = $sdist->record_entry; 
1871         } else {
1872             $sre = $editor->retrieve_serial_record_entry($sdist->record_entry);
1873         }
1874         $mfhd = MFHD->new(MARC::Record->new_from_xml($sre->marc)); 
1875     } else {
1876         $logger->info($sdist);
1877         $mfhd = MFHD->new(MARC::Record->new());
1878     }
1879
1880     my %scaps;
1881     my %scap_fields;
1882     my $seqno = 1;
1883     # We keep track of these separately to avoid link_id contamination,
1884     # e.g. a basic issuance, followed by a merging supplement, followed by
1885     # another basic.  If we could be sure that they were not mixed, one
1886     # value could suffice.
1887     my %link_ids = ('basic' => 10000, 'index' => 10000, 'supplement' => 10000);
1888     my %first_scap = ('basic' => 1, 'index' => 1, 'supplement' => 1);
1889     foreach my $issuance (@$issuances) {
1890         my $scap_id = $issuance->caption_and_pattern;
1891         next if (!$scap_id); # skip issuances with no caption/pattern
1892
1893         my $scap;
1894         my $scap_field;
1895         # if this is the first appearance of this scap, retrieve it and add it to the temporary record
1896         if (!exists $scaps{$issuance->caption_and_pattern}) {
1897             $scaps{$scap_id} = $editor->retrieve_serial_caption_and_pattern($scap_id);
1898             $scap = $scaps{$scap_id};
1899             $scap_field = _revive_caption($scap);
1900             my $did_merge = 0;
1901             if ($first_scap{$scap->type}) { # special merge processing
1902                 $first_scap{$MFHD_TAGS_BY_NAME{$scap->type}} = 0;
1903                 if ($sdist and $sdist->summary_method eq 'merge_with_sre') {
1904                     # MFHD Caption objects do not yet have a built-in compare (TODO), so let's do a basic one
1905                     my @field_85xs = $mfhd->field($MFHD_TAGS_BY_NAME{$scap->type});
1906                     if (@field_85xs) {
1907                         my $last_caption_field = $field_85xs[-1];
1908                         my $last_link_id = $last_caption_field->subfield('8');
1909                         # set the link id to match, temporarily, for comparison
1910                         $last_caption_field->update('8' => $scap_field->subfield('8'));
1911                         my $last_caption_json = OpenSRF::Utils::JSON->perl2JSON([$last_caption_field->indicator(1), $last_caption_field->indicator(2), $last_caption_field->subfields_list]);
1912                         if ($last_caption_json eq $scap->pattern_code) { # merge is possible, they match
1913                             # restore link id
1914                             $link_ids{$scap->type} = $last_link_id;
1915                             # set scap_field to last field
1916                             $scap_field = $last_caption_field;
1917                             $did_merge = 1;
1918                         }
1919                     }
1920                 }
1921             }
1922             $scap_fields{$scap_id} = $scap_field;
1923             $scap_field->update('8' => $link_ids{$scap->type});
1924             # TODO: make MFHD/Caption smarter about this
1925             $scap_field->{_mfhdc_LINK_ID} = $link_ids{$scap->type};
1926             $mfhd->append_fields($scap_field) if !$did_merge;
1927             $link_ids{$scap->type}++;
1928         } else {
1929             $scap_field = $scap_fields{$scap_id};
1930         }
1931
1932         $mfhd->append_fields(_revive_holding($issuance->holding_code, $scap_field, $seqno));
1933         $seqno++;
1934     }
1935
1936     my @formatted_parts;
1937     my @scap_fields_ordered = $mfhd->field($MFHD_TAGS_BY_NAME{$type});
1938
1939     foreach my $scap_field (@scap_fields_ordered) { #TODO: use generic MFHD "summarize" method, once available
1940         my @updated_holdings;
1941         eval {
1942             @updated_holdings = $mfhd->get_combined_holdings($scap_field);
1943         };
1944         if ($@) {
1945             my $msg = "get_combined_holdings(): $@ ; using sdist ID #" .
1946                 ($sdist ? $sdist->id : "<NONE>") . " and " .
1947                 scalar(@$issuances) . " issuances, of which one has ID #" .
1948                 $issuances->[0]->id;
1949
1950             $msg =~ s/\n//gm;
1951             $logger->error($msg);
1952             return new OpenILS::Event("BAD_PARAMS", note => $msg);
1953         }
1954
1955         push @formatted_parts, map { $_->format } @updated_holdings;
1956     }
1957
1958     return ($mfhd, \@formatted_parts);
1959 }
1960
1961 ##########################################################################
1962 # note methods
1963 #
1964 __PACKAGE__->register_method(
1965     method      => 'fetch_notes',
1966     api_name        => 'open-ils.serial.item_note.retrieve.all',
1967     signature   => q/
1968         Returns an array of copy note objects.  
1969         @param args A named hash of parameters including:
1970             authtoken   : Required if viewing non-public notes
1971             item_id      : The id of the item whose notes we want to retrieve
1972             pub         : True if all the caller wants are public notes
1973         @return An array of note objects
1974     /
1975 );
1976
1977 __PACKAGE__->register_method(
1978     method      => 'fetch_notes',
1979     api_name        => 'open-ils.serial.subscription_note.retrieve.all',
1980     signature   => q/
1981         Returns an array of copy note objects.  
1982         @param args A named hash of parameters including:
1983             authtoken       : Required if viewing non-public notes
1984             subscription_id : The id of the item whose notes we want to retrieve
1985             pub             : True if all the caller wants are public notes
1986         @return An array of note objects
1987     /
1988 );
1989
1990 __PACKAGE__->register_method(
1991     method      => 'fetch_notes',
1992     api_name        => 'open-ils.serial.distribution_note.retrieve.all',
1993     signature   => q/
1994         Returns an array of copy note objects.  
1995         @param args A named hash of parameters including:
1996             authtoken       : Required if viewing non-public notes
1997             distribution_id : The id of the item whose notes we want to retrieve
1998             pub             : True if all the caller wants are public notes
1999         @return An array of note objects
2000     /
2001 );
2002
2003 # TODO: revisit this method to consider replacing cstore direct calls
2004 sub fetch_notes {
2005     my( $self, $connection, $args ) = @_;
2006     
2007     $self->api_name =~ /serial\.(\w*)_note/;
2008     my $type = $1;
2009
2010     my $id = $$args{object_id};
2011     my $authtoken = $$args{authtoken};
2012     my $order_by = $$args{order_by} || 'create_date';
2013     my( $r, $evt);
2014
2015     if( $$args{pub} ) {
2016         return $U->cstorereq(
2017             'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic',
2018             { $type => $id, pub => 't' }, {'order_by' => {$FM_NAME_TO_ID{$type}.'n' => $order_by}} );
2019     } else {
2020         # FIXME: restore perm check
2021         # ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
2022         # return $evt if $evt;
2023         return $U->cstorereq(
2024             'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic', {$type => $id}, {'order_by' => {$FM_NAME_TO_ID{$type}.'n' => $order_by}} );
2025     }
2026
2027     return undef;
2028 }
2029
2030 __PACKAGE__->register_method(
2031     method      => 'update_note',
2032     api_name        => 'open-ils.serial.item_note.update',
2033     signature   => q/
2034         Updates or creates an item note
2035         @param authtoken The login session key
2036         @param note The note object to update or create
2037         @return The id of the note object
2038     /
2039 );
2040
2041 __PACKAGE__->register_method(
2042     method      => 'update_note',
2043     api_name        => 'open-ils.serial.subscription_note.update',
2044     signature   => q/
2045         Updates or creates a subscription note
2046         @param authtoken The login session key
2047         @param note The note object to update or create
2048         @return The id of the note object
2049     /
2050 );
2051
2052 __PACKAGE__->register_method(
2053     method      => 'update_note',
2054     api_name        => 'open-ils.serial.distribution_note.update',
2055     signature   => q/
2056         Updates or creates a distribution note
2057         @param authtoken The login session key
2058         @param note The note object to update or create
2059         @return The id of the note object
2060     /
2061 );
2062
2063 sub update_note {
2064     my( $self, $connection, $authtoken, $note ) = @_;
2065
2066     $self->api_name =~ /serial\.(\w*)_note/;
2067     my $type = $1;
2068
2069     my $e = new_editor(xact=>1, authtoken=>$authtoken);
2070     return $e->event unless $e->checkauth;
2071
2072     if ($type eq 'item') {
2073         my $sitem = $e->retrieve_serial_item([
2074             $note->item, {
2075                 "flesh" => 2, "flesh_fields" => {
2076                     "sitem" => ["stream"], "sstr" => ["distribution"]
2077                 }
2078             }
2079         ]) or return $e->die_event;
2080
2081         return $e->die_event unless $e->allowed(
2082             "ADMIN_SERIAL_ITEM", $sitem->stream->distribution->holding_lib
2083         );
2084     } elsif ($type eq 'distribution') {
2085         my $sdist = $e->retrieve_serial_distribution($note->distribution)
2086             or return $e->die_event;
2087
2088         return $e->die_event unless
2089             $e->allowed("ADMIN_SERIAL_DISTRIBUTION", $sdist->holding_lib);
2090     } else { # subscription
2091         my $sub = $e->retrieve_serial_subscription($note->subscription)
2092             or return $e->die_event;
2093
2094         return $e->die_event unless
2095             $e->allowed("ADMIN_SERIAL_SUBSCRIPTION", $sub->owning_lib);
2096     }
2097
2098     $note->pub( ($U->is_true($note->pub)) ? 't' : 'f' );
2099     my $method;
2100     if ($note->isnew) {
2101         $note->create_date('now');
2102         $note->creator($e->requestor->id);
2103         $note->clear_id;
2104         $method = "create_serial_${type}_note";
2105     } else {
2106         $method = "update_serial_${type}_note";
2107     }
2108     $e->$method($note) or return $e->event;
2109     $e->commit;
2110     return $note->id;
2111 }
2112
2113 __PACKAGE__->register_method(
2114     method      => 'delete_note',
2115     api_name        =>  'open-ils.serial.item_note.delete',
2116     signature   => q/
2117         Deletes an existing item note
2118         @param authtoken The login session key
2119         @param noteid The id of the note to delete
2120         @return 1 on success - Event otherwise.
2121         /
2122 );
2123
2124 __PACKAGE__->register_method(
2125     method      => 'delete_note',
2126     api_name        =>  'open-ils.serial.subscription_note.delete',
2127     signature   => q/
2128         Deletes an existing subscription note
2129         @param authtoken The login session key
2130         @param noteid The id of the note to delete
2131         @return 1 on success - Event otherwise.
2132         /
2133 );
2134
2135 __PACKAGE__->register_method(
2136     method      => 'delete_note',
2137     api_name        =>  'open-ils.serial.distribution_note.delete',
2138     signature   => q/
2139         Deletes an existing distribution note
2140         @param authtoken The login session key
2141         @param noteid The id of the note to delete
2142         @return 1 on success - Event otherwise.
2143         /
2144 );
2145
2146 sub delete_note {
2147     my( $self, $conn, $authtoken, $noteid ) = @_;
2148
2149     $self->api_name =~ /serial\.(\w*)_note/;
2150     my $type = $1;
2151
2152     my $e = new_editor(xact=>1, authtoken=>$authtoken);
2153     return $e->die_event unless $e->checkauth;
2154
2155     my $method = "retrieve_serial_${type}_note";
2156     my $note = $e->$method([
2157         $noteid,
2158     ]) or return $e->die_event;
2159
2160     if ($type eq 'item') {
2161         my $sitem = $e->retrieve_serial_item([
2162             $note->item, {
2163                 "flesh" => 2, "flesh_fields" => {
2164                     "sitem" => ["stream"], "sstr" => ["distribution"]
2165                 }
2166             }
2167         ]) or return $e->die_event;
2168
2169         return $e->die_event unless $e->allowed(
2170             "ADMIN_SERIAL_ITEM", $sitem->stream->distribution->holding_lib
2171         );
2172     } elsif ($type eq 'distribution') {
2173         my $sdist = $e->retrieve_serial_distribution($note->distribution)
2174             or return $e->die_event;
2175
2176         return $e->die_event unless
2177             $e->allowed("ADMIN_SERIAL_DISTRIBUTION", $sdist->holding_lib);
2178     } else { # subscription
2179         my $sub = $e->retrieve_serial_subscription($note->subscription)
2180             or return $e->die_event;
2181
2182         return $e->die_event unless
2183             $e->allowed("ADMIN_SERIAL_SUBSCRIPTION", $sub->owning_lib);
2184     }
2185
2186     $method = "delete_serial_${type}_note";
2187     $e->$method($note) or return $e->die_event;
2188     $e->commit;
2189     return 1;
2190 }
2191
2192
2193 ##########################################################################
2194 # subscription methods
2195 #
2196 __PACKAGE__->register_method(
2197     method    => 'fleshed_ssub_alter',
2198     api_name  => 'open-ils.serial.subscription.fleshed.batch.update',
2199     api_level => 1,
2200     argc      => 2,
2201     signature => {
2202         desc     => 'Receives an array of one or more subscriptions and updates the database as needed',
2203         'params' => [ {
2204                  name => 'authtoken',
2205                  desc => 'Authtoken for current user session',
2206                  type => 'string'
2207             },
2208             {
2209                  name => 'subscriptions',
2210                  desc => 'Array of fleshed subscriptions',
2211                  type => 'array'
2212             }
2213
2214         ],
2215         'return' => {
2216             desc => 'Returns 1 if successful, event if failed',
2217             type => 'mixed'
2218         }
2219     }
2220 );
2221
2222 sub fleshed_ssub_alter {
2223     my( $self, $conn, $auth, $ssubs ) = @_;
2224     return 1 unless ref $ssubs;
2225     my( $reqr, $evt ) = $U->checkses($auth);
2226     return $evt if $evt;
2227     my $editor = new_editor(requestor => $reqr, xact => 1);
2228     my $override = $self->api_name =~ /override/;
2229
2230     for my $ssub (@$ssubs) {
2231         my $owning_lib_id = ref $ssub->owning_lib ? $ssub->owning_lib->id : $ssub->owning_lib;
2232         return $editor->die_event unless
2233             $editor->allowed("ADMIN_SERIAL_SUBSCRIPTION", $owning_lib_id);
2234
2235         my $ssubid = $ssub->id;
2236
2237         if( $ssub->isdeleted ) {
2238             $evt = _delete_ssub( $editor, $override, $ssub);
2239         } elsif( $ssub->isnew ) {
2240             _cleanse_dates($ssub, ['start_date','end_date']);
2241             $evt = _create_ssub( $editor, $ssub );
2242         } else {
2243             _cleanse_dates($ssub, ['start_date','end_date']);
2244             $evt = _update_ssub( $editor, $override, $ssub );
2245         }
2246     }
2247
2248     if( $evt ) {
2249         $logger->info("fleshed subscription-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2250         $editor->rollback;
2251         return $evt;
2252     }
2253     $logger->debug("subscription-alter: done updating subscription batch");
2254     $editor->commit;
2255     $logger->info("fleshed subscription-alter successfully updated ".scalar(@$ssubs)." subscriptions");
2256     return 1;
2257 }
2258
2259 sub _delete_ssub {
2260     my ($editor, $override, $ssub) = @_;
2261     $logger->info("subscription-alter: delete subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
2262     my $sdists = $editor->search_serial_distribution(
2263             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
2264     my $cps = $editor->search_serial_caption_and_pattern(
2265             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
2266     my $sisses = $editor->search_serial_issuance(
2267             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
2268     return OpenILS::Event->new(
2269             'SERIAL_SUBSCRIPTION_NOT_EMPTY', payload => $ssub->id ) if (@$sdists or @$cps or @$sisses);
2270
2271     return $editor->event unless $editor->delete_serial_subscription($ssub);
2272     return 0;
2273 }
2274
2275 sub _create_ssub {
2276     my ($editor, $ssub) = @_;
2277
2278     $logger->info("subscription-alter: new subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
2279     return $editor->event unless $editor->create_serial_subscription($ssub);
2280     return 0;
2281 }
2282
2283 sub _update_ssub {
2284     my ($editor, $override, $ssub) = @_;
2285
2286     $logger->info("subscription-alter: retrieving subscription ".$ssub->id);
2287     my $orig_ssub = $editor->retrieve_serial_subscription($ssub->id);
2288
2289     $logger->info("subscription-alter: original subscription ".OpenSRF::Utils::JSON->perl2JSON($orig_ssub));
2290     $logger->info("subscription-alter: updated subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
2291     return $editor->event unless $editor->update_serial_subscription($ssub);
2292     return 0;
2293 }
2294
2295 __PACKAGE__->register_method(
2296     method  => "fleshed_serial_subscription_retrieve_batch",
2297     authoritative => 1,
2298     api_name    => "open-ils.serial.subscription.fleshed.batch.retrieve"
2299 );
2300
2301 sub fleshed_serial_subscription_retrieve_batch {
2302     my( $self, $client, $ids ) = @_;
2303 # FIXME: permissions?
2304     $logger->info("Fetching fleshed subscriptions @$ids");
2305     return $U->cstorereq(
2306         "open-ils.cstore.direct.serial.subscription.search.atomic",
2307         { id => $ids },
2308         { flesh => 1,
2309           flesh_fields => {ssub => [ qw/owning_lib notes/ ]}
2310         });
2311 }
2312
2313 __PACKAGE__->register_method(
2314     method  => "retrieve_sub_tree",
2315     authoritative => 1,
2316     api_name    => "open-ils.serial.subscription_tree.retrieve"
2317 );
2318
2319 __PACKAGE__->register_method(
2320     method  => "retrieve_sub_tree",
2321     api_name    => "open-ils.serial.subscription_tree.global.retrieve"
2322 );
2323
2324 sub retrieve_sub_tree {
2325
2326     my( $self, $client, $user_session, $docid, @org_ids ) = @_;
2327
2328     if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
2329
2330     $docid = "$docid";
2331
2332     # TODO: permission support
2333     if(!@org_ids and $user_session) {
2334         my $user_obj = 
2335             OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
2336             @org_ids = ($user_obj->home_ou);
2337     }
2338
2339     if( $self->api_name =~ /global/ ) {
2340         return _build_subs_list( { record_entry => $docid } ); # TODO: filter for !deleted, or active?
2341
2342     } else {
2343
2344         my @all_subs;
2345         for my $orgid (@org_ids) {
2346             my $subs = _build_subs_list( 
2347                     { record_entry => $docid, owning_lib => $orgid } );# TODO: filter for !deleted, or active?
2348             push( @all_subs, @$subs );
2349         }
2350         
2351         return \@all_subs;
2352     }
2353
2354     return undef;
2355 }
2356
2357 sub _build_subs_list {
2358     my $search_hash = shift;
2359
2360     #$search_hash->{deleted} = 'f';
2361     my $e = new_editor();
2362
2363     my $subs = $e->search_serial_subscription([$search_hash, { 'order_by' => {'ssub' => 'id'} }]);
2364
2365     my @built_subs;
2366
2367     for my $sub (@$subs) {
2368
2369         # TODO: filter on !deleted?
2370         my $dists = $e->search_serial_distribution(
2371             [{ subscription => $sub->id }, { 'order_by' => {'sdist' => 'label'} }]
2372             );
2373
2374         #$dists = [ sort { $a->label cmp $b->label } @$dists  ];
2375
2376         $sub->distributions($dists);
2377         
2378         # TODO: filter on !deleted?
2379         my $issuances = $e->search_serial_issuance(
2380             [{ subscription => $sub->id }, { 'order_by' => {'siss' => 'label'} }]
2381             );
2382
2383         #$issuances = [ sort { $a->label cmp $b->label } @$issuances  ];
2384         $sub->issuances($issuances);
2385
2386         # TODO: filter on !deleted?
2387         my $scaps = $e->search_serial_caption_and_pattern(
2388             [{ subscription => $sub->id }, { 'order_by' => {'scap' => 'id'} }]
2389             );
2390
2391         #$scaps = [ sort { $a->id cmp $b->id } @$scaps  ];
2392         $sub->scaps($scaps);
2393         push( @built_subs, $sub );
2394     }
2395
2396     return \@built_subs;
2397
2398 }
2399
2400 __PACKAGE__->register_method(
2401     method  => "subscription_orgs_for_title",
2402     authoritative => 1,
2403     api_name    => "open-ils.serial.subscription.retrieve_orgs_by_title"
2404 );
2405
2406 sub subscription_orgs_for_title {
2407     my( $self, $client, $record_id ) = @_;
2408
2409     my $subs = $U->simple_scalar_request(
2410         "open-ils.cstore",
2411         "open-ils.cstore.direct.serial.subscription.search.atomic",
2412         { record_entry => $record_id }); # TODO: filter on !deleted?
2413
2414     my $orgs = { map {$_->owning_lib => 1 } @$subs };
2415     return [ keys %$orgs ];
2416 }
2417
2418
2419 ##########################################################################
2420 # distribution methods
2421 #
2422 __PACKAGE__->register_method(
2423     method    => 'fleshed_sdist_alter',
2424     api_name  => 'open-ils.serial.distribution.fleshed.batch.update',
2425     api_level => 1,
2426     argc      => 2,
2427     signature => {
2428         desc     => 'Receives an array of one or more distributions and updates the database as needed',
2429         'params' => [ {
2430                  name => 'authtoken',
2431                  desc => 'Authtoken for current user session',
2432                  type => 'string'
2433             },
2434             {
2435                  name => 'distributions',
2436                  desc => 'Array of fleshed distributions',
2437                  type => 'array'
2438             }
2439
2440         ],
2441         'return' => {
2442             desc => 'Returns 1 if successful, event if failed',
2443             type => 'mixed'
2444         }
2445     }
2446 );
2447
2448 sub fleshed_sdist_alter {
2449     my( $self, $conn, $auth, $sdists ) = @_;
2450     return 1 unless ref $sdists;
2451     my( $reqr, $evt ) = $U->checkses($auth);
2452     return $evt if $evt;
2453     my $editor = new_editor(requestor => $reqr, xact => 1);
2454     my $override = $self->api_name =~ /override/;
2455
2456     for my $sdist (@$sdists) {
2457         my $holding_lib_id = ref $sdist->holding_lib ? $sdist->holding_lib->id : $sdist->holding_lib;
2458         return $editor->die_event unless
2459             $editor->allowed("ADMIN_SERIAL_DISTRIBUTION", $holding_lib_id);
2460
2461         if( $sdist->isdeleted ) {
2462             $evt = _delete_sdist( $editor, $override, $sdist);
2463         } elsif( $sdist->isnew ) {
2464             $evt = _create_sdist( $editor, $sdist );
2465         } else {
2466             $evt = _update_sdist( $editor, $override, $sdist );
2467         }
2468     }
2469
2470     if( $evt ) {
2471         $logger->info("fleshed distribution-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2472         $editor->rollback;
2473         return $evt;
2474     }
2475     $logger->debug("distribution-alter: done updating distribution batch");
2476     $editor->commit;
2477     $logger->info("fleshed distribution-alter successfully updated ".scalar(@$sdists)." distributions");
2478     return 1;
2479 }
2480
2481 sub _delete_sdist {
2482     my ($editor, $override, $sdist) = @_;
2483     $logger->info("distribution-alter: delete distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
2484     return $editor->event unless $editor->delete_serial_distribution($sdist);
2485     return 0;
2486 }
2487
2488 sub _create_sdist {
2489     my ($editor, $sdist) = @_;
2490
2491     $logger->info("distribution-alter: new distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
2492     return $editor->event unless $editor->create_serial_distribution($sdist);
2493
2494     # create summaries too
2495     my $summary = new Fieldmapper::serial::basic_summary;
2496     $summary->distribution($sdist->id);
2497     $summary->generated_coverage('');
2498     return $editor->event unless $editor->create_serial_basic_summary($summary);
2499     $summary = new Fieldmapper::serial::supplement_summary;
2500     $summary->distribution($sdist->id);
2501     $summary->generated_coverage('');
2502     return $editor->event unless $editor->create_serial_supplement_summary($summary);
2503     $summary = new Fieldmapper::serial::index_summary;
2504     $summary->distribution($sdist->id);
2505     $summary->generated_coverage('');
2506     return $editor->event unless $editor->create_serial_index_summary($summary);
2507
2508     # create a starter stream (TODO: reconsider this)
2509     my $stream = new Fieldmapper::serial::stream;
2510     $stream->distribution($sdist->id);
2511     return $editor->event unless $editor->create_serial_stream($stream);
2512
2513     return 0;
2514 }
2515
2516 sub _update_sdist {
2517     my ($editor, $override, $sdist) = @_;
2518
2519     $logger->info("distribution-alter: retrieving distribution ".$sdist->id);
2520     my $orig_sdist = $editor->retrieve_serial_distribution($sdist->id);
2521
2522     $logger->info("distribution-alter: original distribution ".OpenSRF::Utils::JSON->perl2JSON($orig_sdist));
2523     $logger->info("distribution-alter: updated distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
2524     return $editor->event unless $editor->update_serial_distribution($sdist);
2525     return 0;
2526 }
2527
2528 __PACKAGE__->register_method(
2529     method  => "fleshed_serial_distribution_retrieve_batch",
2530     authoritative => 1,
2531     api_name    => "open-ils.serial.distribution.fleshed.batch.retrieve"
2532 );
2533
2534 sub fleshed_serial_distribution_retrieve_batch {
2535     my( $self, $client, $ids ) = @_;
2536 # FIXME: permissions?
2537     $logger->info("Fetching fleshed distributions @$ids");
2538     return $U->cstorereq(
2539         "open-ils.cstore.direct.serial.distribution.search.atomic",
2540         { id => $ids },
2541         { flesh => 1,
2542           flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams notes / ]}
2543         });
2544 }
2545
2546 __PACKAGE__->register_method(
2547     method  => "retrieve_dist_tree",
2548     authoritative => 1,
2549     api_name    => "open-ils.serial.distribution_tree.retrieve"
2550 );
2551
2552 __PACKAGE__->register_method(
2553     method  => "retrieve_dist_tree",
2554     api_name    => "open-ils.serial.distribution_tree.global.retrieve"
2555 );
2556
2557 sub retrieve_dist_tree {
2558     my( $self, $client, $user_session, $docid, @org_ids ) = @_;
2559
2560     if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
2561
2562     $docid = "$docid";
2563
2564     # TODO: permission support
2565     if(!@org_ids and $user_session) {
2566         my $user_obj =
2567             OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
2568             @org_ids = ($user_obj->home_ou);
2569     }
2570
2571     my $e = new_editor();
2572
2573     if( $self->api_name =~ /global/ ) {
2574         return $e->search_serial_distribution([{'+ssub' => { record_entry => $docid }},
2575             {   flesh => 1,
2576                 flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams basic_summary supplement_summary index_summary / ]},
2577                 order_by => {'sdist' => 'id'},
2578                 'join' => {'ssub' => {}}
2579             }
2580         ]); # TODO: filter for !deleted?
2581
2582     } else {
2583         my @all_dists;
2584         for my $orgid (@org_ids) {
2585             my $dists = $e->search_serial_distribution([{'+ssub' => { record_entry => $docid }, holding_lib => $orgid},
2586                 {   flesh => 1,
2587                     flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams basic_summary supplement_summary index_summary / ]},
2588                     order_by => {'sdist' => 'id'},
2589                     'join' => {'ssub' => {}}
2590                 }
2591             ]); # TODO: filter for !deleted?
2592             push( @all_dists, @$dists ) if $dists;
2593         }
2594
2595         return \@all_dists;
2596     }
2597
2598     return undef;
2599 }
2600
2601
2602 __PACKAGE__->register_method(
2603     method  => "distribution_orgs_for_title",
2604     authoritative => 1,
2605     api_name    => "open-ils.serial.distribution.retrieve_orgs_by_title"
2606 );
2607
2608 sub distribution_orgs_for_title {
2609     my( $self, $client, $record_id ) = @_;
2610
2611     my $dists = $U->cstorereq(
2612         "open-ils.cstore.direct.serial.distribution.search.atomic",
2613         { '+ssub' => { record_entry => $record_id } },
2614         { 'join' => {'ssub' => {}} }); # TODO: filter on !deleted?
2615
2616     my $orgs = { map {$_->holding_lib => 1 } @$dists };
2617     return [ keys %$orgs ];
2618 }
2619
2620
2621 ##########################################################################
2622 # caption and pattern methods
2623 #
2624 __PACKAGE__->register_method(
2625     method    => 'scap_alter',
2626     api_name  => 'open-ils.serial.caption_and_pattern.batch.update',
2627     api_level => 1,
2628     argc      => 2,
2629     signature => {
2630         desc     => 'Receives an array of one or more caption and patterns and updates the database as needed',
2631         'params' => [ {
2632                  name => 'authtoken',
2633                  desc => 'Authtoken for current user session',
2634                  type => 'string'
2635             },
2636             {
2637                  name => 'scaps',
2638                  desc => 'Array of caption and patterns',
2639                  type => 'array'
2640             }
2641
2642         ],
2643         'return' => {
2644             desc => 'Returns 1 if successful, event if failed',
2645             type => 'mixed'
2646         }
2647     }
2648 );
2649
2650 sub scap_alter {
2651     my( $self, $conn, $auth, $scaps ) = @_;
2652     return 1 unless ref $scaps;
2653     my( $reqr, $evt ) = $U->checkses($auth);
2654     return $evt if $evt;
2655     my $editor = new_editor(requestor => $reqr, xact => 1);
2656     my $override = $self->api_name =~ /override/;
2657
2658     my %found_ssub_ids;
2659     for my $scap (@$scaps) {
2660         if (!exists($found_ssub_ids{$scap->subscription})) {
2661             my $ssub = $editor->retrieve_serial_subscription($scap->subscription) or return $editor->die_event;
2662             return $editor->die_event unless
2663                 $editor->allowed("ADMIN_SERIAL_CAPTION_PATTERN", $ssub->owning_lib);
2664             $found_ssub_ids{$scap->subscription} = 1;
2665         }
2666
2667         if( $scap->isdeleted ) {
2668             $evt = _delete_scap( $editor, $override, $scap);
2669         } elsif( $scap->isnew ) {
2670             $evt = _create_scap( $editor, $scap );
2671         } else {
2672             $evt = _update_scap( $editor, $override, $scap );
2673         }
2674     }
2675
2676     if( $evt ) {
2677         $logger->info("caption_and_pattern-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2678         $editor->rollback;
2679         return $evt;
2680     }
2681     $logger->debug("caption_and_pattern-alter: done updating caption_and_pattern batch");
2682     $editor->commit;
2683     $logger->info("caption_and_pattern-alter successfully updated ".scalar(@$scaps)." caption_and_patterns");
2684     return 1;
2685 }
2686
2687 sub _delete_scap {
2688     my ($editor, $override, $scap) = @_;
2689     $logger->info("caption_and_pattern-alter: delete caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2690     my $sisses = $editor->search_serial_issuance(
2691             { caption_and_pattern => $scap->id }, { limit => 1 } ); #TODO: 'deleted' support?
2692     return OpenILS::Event->new(
2693             'SERIAL_CAPTION_AND_PATTERN_HAS_ISSUANCES', payload => $scap->id ) if (@$sisses);
2694
2695     return $editor->event unless $editor->delete_serial_caption_and_pattern($scap);
2696     return 0;
2697 }
2698
2699 sub _create_scap {
2700     my ($editor, $scap) = @_;
2701
2702     $logger->info("caption_and_pattern-alter: new caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2703     return $editor->event unless $editor->create_serial_caption_and_pattern($scap);
2704     return 0;
2705 }
2706
2707 sub _update_scap {
2708     my ($editor, $override, $scap) = @_;
2709
2710     $logger->info("caption_and_pattern-alter: retrieving caption_and_pattern ".$scap->id);
2711     my $orig_scap = $editor->retrieve_serial_caption_and_pattern($scap->id);
2712
2713     $logger->info("caption_and_pattern-alter: original caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($orig_scap));
2714     $logger->info("caption_and_pattern-alter: updated caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2715     return $editor->event unless $editor->update_serial_caption_and_pattern($scap);
2716     return 0;
2717 }
2718
2719 __PACKAGE__->register_method(
2720     method  => "serial_caption_and_pattern_retrieve_batch",
2721     authoritative => 1,
2722     api_name    => "open-ils.serial.caption_and_pattern.batch.retrieve"
2723 );
2724
2725 sub serial_caption_and_pattern_retrieve_batch {
2726     my( $self, $client, $ids ) = @_;
2727     $logger->info("Fetching caption_and_patterns @$ids");
2728     return $U->cstorereq(
2729         "open-ils.cstore.direct.serial.caption_and_pattern.search.atomic",
2730         { id => $ids }
2731     );
2732 }
2733
2734 ##########################################################################
2735 # stream methods
2736 #
2737 __PACKAGE__->register_method(
2738     method    => 'sstr_alter',
2739     api_name  => 'open-ils.serial.stream.batch.update',
2740     api_level => 1,
2741     argc      => 2,
2742     signature => {
2743         desc     => 'Receives an array of one or more streams and updates the database as needed',
2744         'params' => [ {
2745                  name => 'authtoken',
2746                  desc => 'Authtoken for current user session',
2747                  type => 'string'
2748             },
2749             {
2750                  name => 'sstrs',
2751                  desc => 'Array of streams',
2752                  type => 'array'
2753             }
2754
2755         ],
2756         'return' => {
2757             desc => 'Returns 1 if successful, event if failed',
2758             type => 'mixed'
2759         }
2760     }
2761 );
2762
2763 sub sstr_alter {
2764     my( $self, $conn, $auth, $sstrs ) = @_;
2765     return 1 unless ref $sstrs;
2766     my( $reqr, $evt ) = $U->checkses($auth);
2767     return $evt if $evt;
2768     my $editor = new_editor(requestor => $reqr, xact => 1);
2769     my $override = $self->api_name =~ /override/;
2770
2771     my %found_sdist_ids;
2772     for my $sstr (@$sstrs) {
2773         if (!exists($found_sdist_ids{$sstr->distribution})) {
2774             my $sdist = $editor->retrieve_serial_distribution($sstr->distribution) or return $editor->die_event;
2775             return $editor->die_event unless
2776                 $editor->allowed("ADMIN_SERIAL_STREAM", $sdist->holding_lib);
2777             $found_sdist_ids{$sstr->distribution} = 1;
2778         }
2779
2780         if( $sstr->isdeleted ) {
2781             $evt = _delete_sstr( $editor, $override, $sstr);
2782         } elsif( $sstr->isnew ) {
2783             $evt = _create_sstr( $editor, $sstr );
2784         } else {
2785             $evt = _update_sstr( $editor, $override, $sstr );
2786         }
2787     }
2788
2789     if( $evt ) {
2790         $logger->info("stream-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2791         $editor->rollback;
2792         return $evt;
2793     }
2794     $logger->debug("stream-alter: done updating stream batch");
2795     $editor->commit;
2796     $logger->info("stream-alter successfully updated ".scalar(@$sstrs)." streams");
2797     return 1;
2798 }
2799
2800 sub _delete_sstr {
2801     my ($editor, $override, $sstr) = @_;
2802     $logger->info("stream-alter: delete stream ".OpenSRF::Utils::JSON->perl2JSON($sstr));
2803     my $sitems = $editor->search_serial_item(
2804             { stream => $sstr->id }, { limit => 1 } ); #TODO: 'deleted' support?
2805     return OpenILS::Event->new(
2806             'SERIAL_STREAM_HAS_ITEMS', payload => $sstr->id ) if (@$sitems);
2807
2808     return $editor->event unless $editor->delete_serial_stream($sstr);
2809     return 0;
2810 }
2811
2812 sub _create_sstr {
2813     my ($editor, $sstr) = @_;
2814
2815     $logger->info("stream-alter: new stream ".OpenSRF::Utils::JSON->perl2JSON($sstr));
2816     return $editor->event unless $editor->create_serial_stream($sstr);
2817     return 0;
2818 }
2819
2820 sub _update_sstr {
2821     my ($editor, $override, $sstr) = @_;
2822
2823     $logger->info("stream-alter: retrieving stream ".$sstr->id);
2824     my $orig_sstr = $editor->retrieve_serial_stream($sstr->id);
2825
2826     $logger->info("stream-alter: original stream ".OpenSRF::Utils::JSON->perl2JSON($orig_sstr));
2827     $logger->info("stream-alter: updated stream ".OpenSRF::Utils::JSON->perl2JSON($sstr));
2828     return $editor->event unless $editor->update_serial_stream($sstr);
2829     return 0;
2830 }
2831
2832 __PACKAGE__->register_method(
2833     method  => "serial_stream_retrieve_batch",
2834     authoritative => 1,
2835     api_name    => "open-ils.serial.stream.batch.retrieve"
2836 );
2837
2838 sub serial_stream_retrieve_batch {
2839     my( $self, $client, $ids ) = @_;
2840     $logger->info("Fetching streams @$ids");
2841     return $U->cstorereq(
2842         "open-ils.cstore.direct.serial.stream.search.atomic",
2843         { id => $ids }
2844     );
2845 }
2846
2847
2848 ##########################################################################
2849 # summary methods
2850 #
2851 __PACKAGE__->register_method(
2852     method    => 'sum_alter',
2853     api_name  => 'open-ils.serial.basic_summary.batch.update',
2854     api_level => 1,
2855     argc      => 2,
2856     signature => {
2857         desc     => 'Receives an array of one or more summaries and updates the database as needed',
2858         'params' => [ {
2859                  name => 'authtoken',
2860                  desc => 'Authtoken for current user session',
2861                  type => 'string'
2862             },
2863             {
2864                  name => 'sbsums',
2865                  desc => 'Array of basic summaries',
2866                  type => 'array'
2867             }
2868
2869         ],
2870         'return' => {
2871             desc => 'Returns 1 if successful, event if failed',
2872             type => 'mixed'
2873         }
2874     }
2875 );
2876
2877 __PACKAGE__->register_method(
2878     method    => 'sum_alter',
2879     api_name  => 'open-ils.serial.supplement_summary.batch.update',
2880     api_level => 1,
2881     argc      => 2,
2882     signature => {
2883         desc     => 'Receives an array of one or more summaries and updates the database as needed',
2884         'params' => [ {
2885                  name => 'authtoken',
2886                  desc => 'Authtoken for current user session',
2887                  type => 'string'
2888             },
2889             {
2890                  name => 'sbsums',
2891                  desc => 'Array of supplement summaries',
2892                  type => 'array'
2893             }
2894
2895         ],
2896         'return' => {
2897             desc => 'Returns 1 if successful, event if failed',
2898             type => 'mixed'
2899         }
2900     }
2901 );
2902
2903 __PACKAGE__->register_method(
2904     method    => 'sum_alter',
2905     api_name  => 'open-ils.serial.index_summary.batch.update',
2906     api_level => 1,
2907     argc      => 2,
2908     signature => {
2909         desc     => 'Receives an array of one or more summaries and updates the database as needed',
2910         'params' => [ {
2911                  name => 'authtoken',
2912                  desc => 'Authtoken for current user session',
2913                  type => 'string'
2914             },
2915             {
2916                  name => 'sbsums',
2917                  desc => 'Array of index summaries',
2918                  type => 'array'
2919             }
2920
2921         ],
2922         'return' => {
2923             desc => 'Returns 1 if successful, event if failed',
2924             type => 'mixed'
2925         }
2926     }
2927 );
2928
2929 sub sum_alter {
2930     my( $self, $conn, $auth, $sums ) = @_;
2931     return 1 unless ref $sums;
2932
2933     $self->api_name =~ /serial\.(\w*)_summary/;
2934     my $type = $1;
2935
2936     my( $reqr, $evt ) = $U->checkses($auth);
2937     return $evt if $evt;
2938     my $editor = new_editor(requestor => $reqr, xact => 1);
2939     my $override = $self->api_name =~ /override/;
2940
2941     my %found_sdist_ids;
2942     for my $sum (@$sums) {
2943         if (!exists($found_sdist_ids{$sum->distribution})) {
2944             my $sdist = $editor->retrieve_serial_distribution($sum->distribution) or return $editor->die_event;
2945             return $editor->die_event unless
2946                 $editor->allowed("ADMIN_SERIAL_DISTRIBUTION", $sdist->holding_lib);
2947             $found_sdist_ids{$sum->distribution} = 1;
2948         }
2949
2950         # XXX: (for now, at least) summaries should be created/deleted by the distribution functions
2951         if( $sum->isdeleted ) {
2952             $evt = OpenILS::Event->new('SERIAL_SUMMARIES_NOT_INDEPENDENT');
2953         } elsif( $sum->isnew ) {
2954             $evt = OpenILS::Event->new('SERIAL_SUMMARIES_NOT_INDEPENDENT');
2955         } else {
2956             $evt = _update_sum( $editor, $override, $sum, $type );
2957         }
2958     }
2959
2960     if( $evt ) {
2961         $logger->info("${type}_summary-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2962         $editor->rollback;
2963         return $evt;
2964     }
2965     $logger->debug("${type}_summary-alter: done updating ${type}_summary batch");
2966     $editor->commit;
2967     $logger->info("${type}_summary-alter successfully updated ".scalar(@$sums)." ${type}_summaries");
2968     return 1;
2969 }
2970
2971 sub _update_sum {
2972     my ($editor, $override, $sum, $type) = @_;
2973
2974     $logger->info("${type}_summary-alter: retrieving ${type}_summary ".$sum->id);
2975     my $retrieve_method = "retrieve_serial_${type}_summary";
2976     my $orig_sum = $editor->$retrieve_method($sum->id);
2977
2978     $logger->info("${type}_summary-alter: original ${type}_summary ".OpenSRF::Utils::JSON->perl2JSON($orig_sum));
2979     $logger->info("${type}_summary-alter: updated ${type}_summary ".OpenSRF::Utils::JSON->perl2JSON($sum));
2980     my $update_method = "update_serial_${type}_summary";
2981     return $editor->event unless $editor->$update_method($sum);
2982     return 0;
2983 }
2984
2985 __PACKAGE__->register_method(
2986     method  => "serial_summary_retrieve_batch",
2987     authoritative => 1,
2988     api_name    => "open-ils.serial.basic_summary.batch.retrieve"
2989 );
2990
2991 __PACKAGE__->register_method(
2992     method  => "serial_summary_retrieve_batch",
2993     authoritative => 1,
2994     api_name    => "open-ils.serial.supplement_summary.batch.retrieve"
2995 );
2996
2997 __PACKAGE__->register_method(
2998     method  => "serial_summary_retrieve_batch",
2999     authoritative => 1,
3000     api_name    => "open-ils.serial.index_summary.batch.retrieve"
3001 );
3002
3003 sub serial_summary_retrieve_batch {
3004     my( $self, $client, $ids ) = @_;
3005
3006     $self->api_name =~ /serial\.(\w*)_summary/;
3007     my $type = $1;
3008
3009     $logger->info("Fetching ${type}_summaries @$ids");
3010     return $U->cstorereq(
3011         "open-ils.cstore.direct.serial.".$type."_summary.search.atomic",
3012         { id => $ids }
3013     );
3014 }
3015
3016
3017 ##########################################################################
3018 # other methods
3019 #
3020 __PACKAGE__->register_method(
3021     "method" => "bre_by_identifier",
3022     "api_name" => "open-ils.serial.biblio.record_entry.by_identifier",
3023     "stream" => 1,
3024     "signature" => {
3025         "desc" => "Find instances of biblio.record_entry given a search token" .
3026             " that could be a value for any identifier defined in " .
3027             "config.metabib_field",
3028         "params" => [
3029             {"desc" => "Search token", "type" => "string"},
3030             {"desc" => "Options: require_subscriptions, add_mvr, is_actual_id" .
3031                 ", id_list (all boolean)", "type" => "object"}
3032         ],
3033         "return" => {
3034             "desc" => "Any matching BREs, or if the add_mvr option is true, " .
3035                 "objects with a 'bre' key/value pair, and an 'mvr' " .
3036                 "key-value pair.  BREs have subscriptions fleshed on.",
3037             "type" => "object"
3038         }
3039     }
3040 );
3041
3042 sub bre_by_identifier {
3043     my ($self, $client, $term, $options) = @_;
3044
3045     return new OpenILS::Event("BAD_PARAMS") unless $term;
3046
3047     $options ||= {};
3048     my $e = new_editor();
3049
3050     my @ids;
3051
3052     if ($options->{"is_actual_id"}) {
3053         @ids = ($term);
3054     } else {
3055         my $cmf =
3056             $e->search_config_metabib_field({"field_class" => "identifier"})
3057                 or return $e->die_event;
3058
3059         my @identifiers = map { $_->name } @$cmf;
3060         my $query = join(" || ", map { "id|$_: $term" } @identifiers);
3061
3062         my $search = create OpenSRF::AppSession("open-ils.search");
3063         my $search_result = $search->request(
3064             "open-ils.search.biblio.multiclass.query.staff", {}, $query
3065         )->gather(1);
3066         $search->disconnect;
3067
3068         # Un-nest results. They tend to look like [[1],[2],[3]] for some reason.
3069         @ids = map { @{$_} } @{$search_result->{"ids"}};
3070
3071         unless (@ids) {
3072             $e->disconnect;
3073             return undef;
3074         }
3075
3076         if ($options->{"id_list"}) {
3077             $e->disconnect;
3078             $client->respond($_) foreach (@ids);
3079             return undef;
3080         }