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