]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/src/perlmods/OpenILS/Application/Serial.pm
How about one more permission check for serials here? Need more comprehensive
[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 MARC::File::XML (BinaryEncoding => 'utf8');
52 my $U = 'OpenILS::Application::AppUtils';
53 my @MFHD_NAMES = ('basic','supplement','index');
54 my %MFHD_NAMES_BY_TAG = (  '853' => $MFHD_NAMES[0],
55                         '863' => $MFHD_NAMES[0],
56                         '854' => $MFHD_NAMES[1],
57                         '864' => $MFHD_NAMES[1],
58                         '855' => $MFHD_NAMES[2],
59                         '865' => $MFHD_NAMES[2] );
60 my %MFHD_TAGS_BY_NAME = (  $MFHD_NAMES[0] => '853',
61                         $MFHD_NAMES[1] => '854',
62                         $MFHD_NAMES[2] => '855');
63 my $_strp_date = new DateTime::Format::Strptime(pattern => '%F');
64
65 # helper method for conforming dates to ISO8601
66 sub _cleanse_dates {
67     my $item = shift;
68     my $fields = shift;
69
70     foreach my $field (@$fields) {
71         $item->$field(OpenSRF::Utils::clense_ISO8601($item->$field)) if $item->$field;
72     }
73     return 0;
74 }
75
76 sub _get_mvr {
77     $U->simplereq(
78         "open-ils.search",
79         "open-ils.search.biblio.record.mods_slim.retrieve",
80         @_
81     );
82 }
83
84
85 ##########################################################################
86 # item methods
87 #
88 __PACKAGE__->register_method(
89     method    => 'fleshed_item_alter',
90     api_name  => 'open-ils.serial.item.fleshed.batch.update',
91     api_level => 1,
92     argc      => 2,
93     signature => {
94         desc     => 'Receives an array of one or more items and updates the database as needed',
95         'params' => [ {
96                  name => 'authtoken',
97                  desc => 'Authtoken for current user session',
98                  type => 'string'
99             },
100             {
101                  name => 'items',
102                  desc => 'Array of fleshed items',
103                  type => 'array'
104             }
105
106         ],
107         'return' => {
108             desc => 'Returns 1 if successful, event if failed',
109             type => 'mixed'
110         }
111     }
112 );
113
114 sub fleshed_item_alter {
115     my( $self, $conn, $auth, $items ) = @_;
116     return 1 unless ref $items;
117     my( $reqr, $evt ) = $U->checkses($auth);
118     return $evt if $evt;
119     my $editor = new_editor(requestor => $reqr, xact => 1);
120     my $override = $self->api_name =~ /override/;
121
122 # TODO: permission check
123 #        return $editor->event unless
124 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
125
126     for my $item (@$items) {
127
128         my $itemid = $item->id;
129         $item->editor($editor->requestor->id);
130         $item->edit_date('now');
131
132         if( $item->isdeleted ) {
133             $evt = _delete_sitem( $editor, $override, $item);
134         } elsif( $item->isnew ) {
135             # TODO: reconsider this
136             # if the item has a new issuance, create the issuance first
137             if (ref $item->issuance eq 'Fieldmapper::serial::issuance' and $item->issuance->isnew) {
138                 fleshed_issuance_alter($self, $conn, $auth, [$item->issuance]);
139             }
140             _cleanse_dates($item, ['date_expected','date_received']);
141             $evt = _create_sitem( $editor, $item );
142         } else {
143             _cleanse_dates($item, ['date_expected','date_received']);
144             $evt = _update_sitem( $editor, $override, $item );
145         }
146     }
147
148     if( $evt ) {
149         $logger->info("fleshed item-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
150         $editor->rollback;
151         return $evt;
152     }
153     $logger->debug("item-alter: done updating item batch");
154     $editor->commit;
155     $logger->info("fleshed item-alter successfully updated ".scalar(@$items)." items");
156     return 1;
157 }
158
159 sub _delete_sitem {
160     my ($editor, $override, $item) = @_;
161     $logger->info("item-alter: delete item ".OpenSRF::Utils::JSON->perl2JSON($item));
162     return $editor->event unless $editor->delete_serial_item($item);
163     return 0;
164 }
165
166 sub _create_sitem {
167     my ($editor, $item) = @_;
168
169     $item->creator($editor->requestor->id);
170     $item->create_date('now');
171
172     $logger->info("item-alter: new item ".OpenSRF::Utils::JSON->perl2JSON($item));
173     return $editor->event unless $editor->create_serial_item($item);
174     return 0;
175 }
176
177 sub _update_sitem {
178     my ($editor, $override, $item) = @_;
179
180     $logger->info("item-alter: retrieving item ".$item->id);
181     my $orig_item = $editor->retrieve_serial_item($item->id);
182
183     $logger->info("item-alter: original item ".OpenSRF::Utils::JSON->perl2JSON($orig_item));
184     $logger->info("item-alter: updated item ".OpenSRF::Utils::JSON->perl2JSON($item));
185     return $editor->event unless $editor->update_serial_item($item);
186     return 0;
187 }
188
189 __PACKAGE__->register_method(
190     method  => "fleshed_serial_item_retrieve_batch",
191     authoritative => 1,
192     api_name    => "open-ils.serial.item.fleshed.batch.retrieve"
193 );
194
195 sub fleshed_serial_item_retrieve_batch {
196     my( $self, $client, $ids ) = @_;
197 # FIXME: permissions?
198     $logger->info("Fetching fleshed serial items @$ids");
199     return $U->cstorereq(
200         "open-ils.cstore.direct.serial.item.search.atomic",
201         { id => $ids },
202         { flesh => 2,
203           flesh_fields => {sitem => [ qw/issuance creator editor stream unit notes/ ], sstr => ["distribution"], sunit => ["call_number"], siss => [qw/creator editor subscription/]}
204         });
205 }
206
207
208 ##########################################################################
209 # issuance methods
210 #
211 __PACKAGE__->register_method(
212     method    => 'fleshed_issuance_alter',
213     api_name  => 'open-ils.serial.issuance.fleshed.batch.update',
214     api_level => 1,
215     argc      => 2,
216     signature => {
217         desc     => 'Receives an array of one or more issuances and updates the database as needed',
218         'params' => [ {
219                  name => 'authtoken',
220                  desc => 'Authtoken for current user session',
221                  type => 'string'
222             },
223             {
224                  name => 'issuances',
225                  desc => 'Array of fleshed issuances',
226                  type => 'array'
227             }
228
229         ],
230         'return' => {
231             desc => 'Returns 1 if successful, event if failed',
232             type => 'mixed'
233         }
234     }
235 );
236
237 sub fleshed_issuance_alter {
238     my( $self, $conn, $auth, $issuances ) = @_;
239     return 1 unless ref $issuances;
240     my( $reqr, $evt ) = $U->checkses($auth);
241     return $evt if $evt;
242     my $editor = new_editor(requestor => $reqr, xact => 1);
243     my $override = $self->api_name =~ /override/;
244
245 # TODO: permission support
246 #        return $editor->event unless
247 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
248
249     for my $issuance (@$issuances) {
250         my $issuanceid = $issuance->id;
251         $issuance->editor($editor->requestor->id);
252         $issuance->edit_date('now');
253
254         if( $issuance->isdeleted ) {
255             $evt = _delete_siss( $editor, $override, $issuance);
256         } elsif( $issuance->isnew ) {
257             _cleanse_dates($issuance, ['date_published']);
258             $evt = _create_siss( $editor, $issuance );
259         } else {
260             _cleanse_dates($issuance, ['date_published']);
261             $evt = _update_siss( $editor, $override, $issuance );
262         }
263     }
264
265     if( $evt ) {
266         $logger->info("fleshed issuance-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
267         $editor->rollback;
268         return $evt;
269     }
270     $logger->debug("issuance-alter: done updating issuance batch");
271     $editor->commit;
272     $logger->info("fleshed issuance-alter successfully updated ".scalar(@$issuances)." issuances");
273     return 1;
274 }
275
276 sub _delete_siss {
277     my ($editor, $override, $issuance) = @_;
278     $logger->info("issuance-alter: delete issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
279     return $editor->event unless $editor->delete_serial_issuance($issuance);
280     return 0;
281 }
282
283 sub _create_siss {
284     my ($editor, $issuance) = @_;
285
286     $issuance->creator($editor->requestor->id);
287     $issuance->create_date('now');
288
289     $logger->info("issuance-alter: new issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
290     return $editor->event unless $editor->create_serial_issuance($issuance);
291     return 0;
292 }
293
294 sub _update_siss {
295     my ($editor, $override, $issuance) = @_;
296
297     $logger->info("issuance-alter: retrieving issuance ".$issuance->id);
298     my $orig_issuance = $editor->retrieve_serial_issuance($issuance->id);
299
300     $logger->info("issuance-alter: original issuance ".OpenSRF::Utils::JSON->perl2JSON($orig_issuance));
301     $logger->info("issuance-alter: updated issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
302     return $editor->event unless $editor->update_serial_issuance($issuance);
303     return 0;
304 }
305
306 __PACKAGE__->register_method(
307     method  => "fleshed_serial_issuance_retrieve_batch",
308     authoritative => 1,
309     api_name    => "open-ils.serial.issuance.fleshed.batch.retrieve"
310 );
311
312 sub fleshed_serial_issuance_retrieve_batch {
313     my( $self, $client, $ids ) = @_;
314 # FIXME: permissions?
315     $logger->info("Fetching fleshed serial issuances @$ids");
316     return $U->cstorereq(
317         "open-ils.cstore.direct.serial.issuance.search.atomic",
318         { id => $ids },
319         { flesh => 1,
320           flesh_fields => {siss => [ qw/creator editor subscription/ ]}
321         });
322 }
323
324 __PACKAGE__->register_method(
325     method  => "pub_fleshed_serial_issuance_retrieve_batch",
326     api_name    => "open-ils.serial.issuance.pub_fleshed.batch.retrieve",
327     signature => {
328         desc => q/
329             Public (i.e. OPAC) call for getting at the sub and 
330             ultimately the record entry from an issuance
331         /,
332         params => [{name => 'ids', desc => 'Array of IDs', type => 'array'}],
333         return => {
334             desc => q/
335                 issuance objects, fleshed with subscriptions
336             /,
337             class => 'siss'
338         }
339     }
340 );
341 sub pub_fleshed_serial_issuance_retrieve_batch {
342     my( $self, $client, $ids ) = @_;
343     return [] unless $ids and @$ids;
344     return new_editor()->search_serial_issuance([
345         { id => $ids },
346         { 
347             flesh => 1,
348             flesh_fields => {siss => [ qw/subscription/ ]}
349         }
350     ]);
351 }
352
353 sub received_siss_by_bib {
354     my $self = shift;
355     my $client = shift;
356     my $bib = shift;
357
358     my $args = shift || {};
359     $$args{order} ||= 'asc';
360
361     my $global = $$args{global} == 0 ? 0 : 1;
362
363     my $e = new_editor();
364     my $issuances = $e->json_query({
365         select  => {
366             siss => [
367                 $global ? { transform => "min", column => "id", aggregate => 1 } : "id",
368                 "label",
369                 "date_published"
370         ]},
371         from => {
372             ssub => {
373                 siss => {
374                     field => 'subscription',
375                     fkey  => 'id',
376                     join  => {
377                         sitem => {
378                             field  => 'issuance',
379                             fkey   => 'id',
380                             $$args{ou} ? ( join  => {
381                                 sstr => {
382                                     field => 'id',
383                                     fkey  => 'stream',
384                                     join  => {
385                                         sdist => {
386                                             field  => 'id',
387                                             fkey   => 'distribution'
388                                         }
389                                     }
390                                 }
391                             }) : ()
392                         }
393                     }
394                 }
395             }
396         },
397         where => {
398             '+ssub'  => { record_entry => $bib },
399             $$args{type} ? ( '+siss' => { 'holding_type' => $$args{type} } ) : (),
400             '+sitem' => {
401                 # XXX should we also take specific item statuses into account?
402                 date_received => { '!=' => undef },
403                 $$args{status} ? ( 'status' => $$args{status} ) : ()
404             },
405             $$args{ou} ? ( '+sdist' => {
406                 holding_lib => {
407                     'in' => $U->get_org_descendants($$args{ou}, $$args{depth})
408                 }
409             }) : ()
410         },
411         $$args{limit}  ? ( limit  => $$args{limit}  ) : (),
412         $$args{offset} ? ( offset => $$args{offset} ) : (),
413         order_by => [{ class => 'siss', field => 'date_published', direction => $$args{order} }],
414         distinct => 1
415     });
416
417     $client->respond($e->retrieve_serial_issuance($_->{id})) for @$issuances;
418     return undef;
419 }
420 __PACKAGE__->register_method(
421     method    => 'received_siss_by_bib',
422     api_name  => 'open-ils.serial.received_siss.retrieve.by_bib',
423     api_level => 1,
424     argc      => 1,
425     stream    => 1,
426     signature => {
427         desc   => 'Receives a Bib ID and other optional params and returns "siss" (issuance) objects',
428         params => [
429             {   name => 'bibid',
430                 desc => 'id of the bre to which the issuances belong',
431                 type => 'number'
432             },
433             {   name => 'args',
434                 desc =>
435 q/A hash of optional arguments.  Valid keys and their meanings:
436     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).
437     order  := date_published sort direction, either "asc" (chronological, default) or "desc" (reverse chronological)
438     limit  := Number of issuances to return.  Useful for paging results, or finding the oldest or newest
439     offest := Number of issuance to skip before returning results.  Useful for paging.
440     orgid  := OU id used to scope retrieval, based on distribution.holding_lib
441     depth  := OU depth used to range the scope of orgid
442     type   := Holding type filter. Valid values are "basic", "supplement" and "index". Can be a scalar (one) or arrayref (one or more).
443     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).
444 /
445             }
446         ]
447     }
448 );
449
450
451 sub scoped_bib_holdings_summary {
452     my $self = shift;
453     my $client = shift;
454     my $bibid = shift;
455     my $args = shift || {};
456
457     $args->{order} = 'asc';
458
459     my ($issuances) = $self->method_lookup('open-ils.serial.received_siss.retrieve.by_bib.atomic')->run( $bibid => $args );
460
461     # split into issuance type sets
462     my %type_blob = (basic => [], supplement => [], index => []);
463     push @{ $type_blob{ $_->holding_type } }, $_ for (@$issuances);
464
465     # generate a statement list for each type
466     my %statement_blob;
467     for my $type ( keys %type_blob ) {
468         my ($mfhd,$list) = _summarize_contents(new_editor(), $type_blob{$type});
469         $statement_blob{$type} = $list;
470     }
471
472     return \%statement_blob;
473 }
474 __PACKAGE__->register_method(
475     method    => 'scoped_bib_holdings_summary',
476     api_name  => 'open-ils.serial.bib.summary_statements',
477     api_level => 1,
478     argc      => 1,
479     signature => {
480         desc   => 'Receives a Bib ID and other optional params and returns set of holdings statements',
481         params => [
482             {   name => 'bibid',
483                 desc => 'id of the bre to which the issuances belong',
484                 type => 'number'
485             },
486             {   name => 'args',
487                 desc =>
488 q/A hash of optional arguments.  Valid keys and their meanings:
489     orgid  := OU id used to scope retrieval, based on distribution.holding_lib
490     depth  := OU depth used to range the scope of orgid
491     type   := Holding type filter. Valid values are "basic", "supplement" and "index". Can be a scalar (one) or arrayref (one or more).
492     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).
493 /
494             }
495         ]
496     }
497 );
498
499
500 ##########################################################################
501 # unit methods
502 #
503 __PACKAGE__->register_method(
504     method    => 'fleshed_sunit_alter',
505     api_name  => 'open-ils.serial.sunit.fleshed.batch.update',
506     api_level => 1,
507     argc      => 2,
508     signature => {
509         desc     => 'Receives an array of one or more Units and updates the database as needed',
510         'params' => [ {
511                  name => 'authtoken',
512                  desc => 'Authtoken for current user session',
513                  type => 'string'
514             },
515             {
516                  name => 'sunits',
517                  desc => 'Array of fleshed Units',
518                  type => 'array'
519             }
520
521         ],
522         'return' => {
523             desc => 'Returns 1 if successful, event if failed',
524             type => 'mixed'
525         }
526     }
527 );
528
529 sub fleshed_sunit_alter {
530     my( $self, $conn, $auth, $sunits ) = @_;
531     return 1 unless ref $sunits;
532     my( $reqr, $evt ) = $U->checkses($auth);
533     return $evt if $evt;
534     my $editor = new_editor(requestor => $reqr, xact => 1);
535     my $override = $self->api_name =~ /override/;
536
537 # TODO: permission support
538 #        return $editor->event unless
539 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
540
541     for my $sunit (@$sunits) {
542         if( $sunit->isdeleted ) {
543             $evt = _delete_sunit( $editor, $override, $sunit );
544         } else {
545             $sunit->default_location( $sunit->default_location->id ) if ref $sunit->default_location;
546
547             if( $sunit->isnew ) {
548                 $evt = _create_sunit( $editor, $sunit );
549             } else {
550                 $evt = _update_sunit( $editor, $override, $sunit );
551             }
552         }
553     }
554
555     if( $evt ) {
556         $logger->info("fleshed sunit-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
557         $editor->rollback;
558         return $evt;
559     }
560     $logger->debug("sunit-alter: done updating sunit batch");
561     $editor->commit;
562     $logger->info("fleshed sunit-alter successfully updated ".scalar(@$sunits)." Units");
563     return 1;
564 }
565
566 sub _delete_sunit {
567     my ($editor, $override, $sunit) = @_;
568     $logger->info("sunit-alter: delete sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
569     return $editor->event unless $editor->delete_serial_unit($sunit);
570     return 0;
571 }
572
573 sub _create_sunit {
574     my ($editor, $sunit) = @_;
575
576     $logger->info("sunit-alter: new Unit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
577     return $editor->event unless $editor->create_serial_unit($sunit);
578     return 0;
579 }
580
581 sub _update_sunit {
582     my ($editor, $override, $sunit) = @_;
583
584     $logger->info("sunit-alter: retrieving sunit ".$sunit->id);
585     my $orig_sunit = $editor->retrieve_serial_unit($sunit->id);
586
587     $logger->info("sunit-alter: original sunit ".OpenSRF::Utils::JSON->perl2JSON($orig_sunit));
588     $logger->info("sunit-alter: updated sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
589     return $editor->event unless $editor->update_serial_unit($sunit);
590     return 0;
591 }
592
593 __PACKAGE__->register_method(
594         method  => "retrieve_unit_list",
595     authoritative => 1,
596         api_name        => "open-ils.serial.unit_list.retrieve"
597 );
598
599 sub retrieve_unit_list {
600
601         my( $self, $client, @sdist_ids ) = @_;
602
603         if(ref($sdist_ids[0])) { @sdist_ids = @{$sdist_ids[0]}; }
604
605         my $e = new_editor();
606
607     my $query = {
608         'select' => 
609             { 'sunit' => [ 'id', 'summary_contents', 'sort_key' ],
610               'sitem' => ['stream'],
611               'sstr' => ['distribution'],
612               'sdist' => [{'column' => 'label', 'alias' => 'sdist_label'}]
613             },
614         'from' =>
615             { 'sdist' =>
616                 { 'sstr' =>
617                     { 'join' =>
618                         { 'sitem' =>
619                             { 'join' => { 'sunit' => {} } }
620                         }
621                     }
622                 }
623             },
624         'distinct' => 'true',
625         'where' => { '+sdist' => {'id' => \@sdist_ids} },
626         'order_by' => [{'class' => 'sunit', 'field' => 'sort_key'}]
627     };
628
629     my $unit_list_entries = $e->json_query($query);
630     
631     my @entries;
632     foreach my $entry (@$unit_list_entries) {
633         my $value = {'sunit' => $entry->{id}, 'sstr' => $entry->{stream}, 'sdist' => $entry->{distribution}};
634         my $label = $entry->{summary_contents};
635         if (length($label) > 100) {
636             $label = substr($label, 0, 100) . '...'; # limited space in dropdown / menu
637         }
638         $label = "[$entry->{sdist_label}/$entry->{stream} #$entry->{id}] " . $label;
639         push (@entries, [$label, OpenSRF::Utils::JSON->perl2JSON($value)]);
640     }
641
642     return \@entries;
643 }
644
645
646
647 ##########################################################################
648 # predict and receive methods
649 #
650 __PACKAGE__->register_method(
651     method    => 'make_predictions',
652     api_name  => 'open-ils.serial.make_predictions',
653     api_level => 1,
654     argc      => 1,
655     signature => {
656         desc     => 'Receives an ssub id and populates the issuance and item tables',
657         'params' => [ {
658                  name => 'ssub_id',
659                  desc => 'Serial Subscription ID',
660                  type => 'int'
661             }
662         ]
663     }
664 );
665
666 sub make_predictions {
667     my ($self, $conn, $authtoken, $args) = @_;
668
669     my $editor = OpenILS::Utils::CStoreEditor->new();
670     my $ssub_id = $args->{ssub_id};
671     my $all_dists = $args->{all_dists};
672     my $mfhd = MFHD->new(MARC::Record->new());
673
674     my $ssub = $editor->retrieve_serial_subscription([$ssub_id]);
675     my $scaps = $editor->search_serial_caption_and_pattern({ subscription => $ssub_id, active => 't'});
676     my $sdists = $editor->search_serial_distribution( [{ subscription => $ssub->id }, {  flesh => 1,
677               flesh_fields => {sdist => [ qw/ streams / ]}, $all_dists ? () : (limit => 1) }] ); #TODO: 'deleted' support?
678
679     if ($all_dists) {
680         my $total_streams = 0;
681         foreach (@$sdists) {
682             $total_streams += scalar(@{$_->streams});
683         }
684         if ($total_streams < 1) {
685             $editor->disconnect;
686             # XXX TODO new event type
687             return new OpenILS::Event(
688                 "BAD_PARAMS", note =>
689                     "There are no streams to direct items. Can't predict."
690             );
691         }
692     }
693
694     unless (@$scaps) {
695         $editor->disconnect;
696         # XXX TODO new event type
697         return new OpenILS::Event(
698             "BAD_PARAMS", note =>
699                 "There are no active caption-and-pattern objects associated " .
700                 "with this subscription. Can't predict."
701         );
702     }
703
704     my @predictions;
705     my $link_id = 1;
706     foreach my $scap (@$scaps) {
707         my $caption_field = _revive_caption($scap);
708         $caption_field->update('8' => $link_id);
709         $mfhd->append_fields($caption_field);
710         my $options = {
711                 'caption' => $caption_field,
712                 'scap_id' => $scap->id,
713                 'num_to_predict' => $args->{num_to_predict},
714                 'end_date' => defined $args->{end_date} ?
715                     $_strp_date->parse_datetime($args->{end_date}) : undef
716                 };
717         if ($args->{base_issuance}) { # predict from a given issuance
718             $options->{predict_from} = _revive_holding($args->{base_issuance}->holding_code, $caption_field, 1); # fresh MFHD Record, so we simply default to 1 for seqno
719         } else { # default to predicting from last published
720             my $last_published = $editor->search_serial_issuance([
721                     {'caption_and_pattern' => $scap->id,
722                     'subscription' => $ssub_id},
723                 {limit => 1, order_by => { siss => "date_published DESC" }}]
724                 );
725             if ($last_published->[0]) {
726                 my $last_siss = $last_published->[0];
727                 unless ($last_siss->holding_code) {
728                     $editor->disconnect;
729                     # XXX TODO new event type
730                     return new OpenILS::Event(
731                         "BAD_PARAMS", note =>
732                             "Last issuance has no holding code. Can't predict."
733                     );
734                 }
735                 $options->{predict_from} = _revive_holding($last_siss->holding_code, $caption_field, 1);
736             } else {
737                 $editor->disconnect;
738                 # XXX TODO make a new event type instead of hijacking this one
739                 return new OpenILS::Event(
740                     "BAD_PARAMS", note => "No issuance from which to predict!"
741                 );
742             }
743         }
744         push( @predictions, _generate_issuance_values($mfhd, $options) );
745         $link_id++;
746     }
747
748     my @issuances;
749     foreach my $prediction (@predictions) {
750         my $issuance = new Fieldmapper::serial::issuance;
751         $issuance->isnew(1);
752         $issuance->label($prediction->{label});
753         $issuance->date_published($prediction->{date_published}->strftime('%F'));
754         $issuance->holding_code(OpenSRF::Utils::JSON->perl2JSON($prediction->{holding_code}));
755         $issuance->holding_type($prediction->{holding_type});
756         $issuance->caption_and_pattern($prediction->{caption_and_pattern});
757         $issuance->subscription($ssub->id);
758         push (@issuances, $issuance);
759     }
760
761     fleshed_issuance_alter($self, $conn, $authtoken, \@issuances); # FIXME: catch events
762
763     my @items;
764     for (my $i = 0; $i < @issuances; $i++) {
765         my $date_expected = $predictions[$i]->{date_published}->add(seconds => interval_to_seconds($ssub->expected_date_offset))->strftime('%F');
766         my $issuance = $issuances[$i];
767         #$issuance->label(interval_to_seconds($ssub->expected_date_offset));
768         foreach my $sdist (@$sdists) {
769             my $streams = $sdist->streams;
770             foreach my $stream (@$streams) {
771                 my $item = new Fieldmapper::serial::item;
772                 $item->isnew(1);
773                 $item->stream($stream->id);
774                 $item->date_expected($date_expected);
775                 $item->issuance($issuance->id);
776                 push (@items, $item);
777             }
778         }
779     }
780     fleshed_item_alter($self, $conn, $authtoken, \@items); # FIXME: catch events
781     return \@items;
782 }
783
784 #
785 # _generate_issuance_values() is an initial attempt at a function which can be used
786 # to populate an issuance table with a list of predicted issues.  It accepts
787 # a hash ref of options initially defined as:
788 # caption : the caption field to predict on
789 # num_to_predict : the number of issues you wish to predict
790 # last_rec_date : the date of the last received issue, to be used as an offset
791 #                 for predicting future issues
792 #
793 # The basic method is to first convert to a single holding if compressed, then
794 # increment the holding and save the resulting values to @issuances.
795
796 # returns @issuance_values, an array of hashrefs containing (formatted
797 # label, formatted chronology date, formatted estimated arrival date, and an
798 # array ref of holding subfields as (key, value, key, value ...)) (not a hash
799 # to protect order and possible duplicate keys), and a holding type.
800 #
801 sub _generate_issuance_values {
802     my ($mfhd, $options) = @_;
803     my $caption = $options->{caption};
804     my $scap_id = $options->{scap_id};
805     my $num_to_predict = $options->{num_to_predict};
806     my $end_date = $options->{end_date};
807     my $predict_from = $options->{predict_from};   # issuance to predict from
808     #my $last_rec_date = $options->{last_rec_date};   # expected or actual
809
810     # TODO: add support for predicting serials with no chronology by passing in
811     # a last_pub_date option?
812
813
814 # Only needed for 'real' MFHD records, not our temp records
815 #    my $link_id = $caption->link_id;
816 #    if(!$predict_from) {
817 #        my $htag = $caption->tag;
818 #        $htag =~ s/^85/86/;
819 #        my @holdings = $mfhd->holdings($htag, $link_id);
820 #        my $last_holding = $holdings[-1];
821 #
822 #        #if ($last_holding->is_compressed) {
823 #        #    $last_holding->compressed_to_last; # convert to last in range
824 #        #}
825 #        $predict_from = $last_holding;
826 #    }
827 #
828
829     $predict_from->notes('public',  []);
830 # add a note marker for system use (?)
831     $predict_from->notes('private', ['AUTOGEN']);
832
833     my $pub_date;
834     my @issuance_values;
835     my @predictions = $mfhd->generate_predictions({'base_holding' => $predict_from, 'num_to_predict' => $num_to_predict, 'end_date' => $end_date});
836     foreach my $prediction (@predictions) {
837         $pub_date = $_strp_date->parse_datetime($prediction->chron_to_date);
838         push(
839                 @issuance_values,
840                 {
841                     #$link_id,
842                     label => $prediction->format,
843                     date_published => $pub_date,
844                     #date_expected => $date_expected->strftime('%F'),
845                     holding_code => [$prediction->indicator(1),$prediction->indicator(2),$prediction->subfields_list],
846                     holding_type => $MFHD_NAMES_BY_TAG{$caption->tag},
847                     caption_and_pattern => $scap_id
848                 }
849             );
850     }
851
852     return @issuance_values;
853 }
854
855 sub _revive_caption {
856     my $scap = shift;
857
858     my $pattern_code = $scap->pattern_code;
859
860     # build MARC::Field
861     my $pattern_parts = OpenSRF::Utils::JSON->JSON2perl($pattern_code);
862     unshift(@$pattern_parts, $MFHD_TAGS_BY_NAME{$scap->type});
863     my $pattern_field = new MARC::Field(@$pattern_parts);
864
865     # build MFHD::Caption
866     return new MFHD::Caption($pattern_field);
867 }
868
869 sub _revive_holding {
870     my $holding_code = shift;
871     my $caption_field = shift;
872     my $seqno = shift;
873
874     # build MARC::Field
875     my $holding_parts = OpenSRF::Utils::JSON->JSON2perl($holding_code);
876     my $captag = $caption_field->tag;
877     $captag =~ s/^85/86/;
878     unshift(@$holding_parts, $captag);
879     my $holding_field = new MARC::Field(@$holding_parts);
880
881     # build MFHD::Holding
882     return new MFHD::Holding($seqno, $holding_field, $caption_field);
883 }
884
885 __PACKAGE__->register_method(
886     method    => 'unitize_items',
887     api_name  => 'open-ils.serial.receive_items',
888     api_level => 1,
889     argc      => 1,
890     signature => {
891         desc     => 'Marks an item as received, updates the shelving unit (creating a new shelving unit if needed), and updates the summaries',
892         'params' => [ {
893                  name => 'items',
894                  desc => 'array of serial items',
895                  type => 'array'
896             }
897         ],
898         'return' => {
899             desc => 'Returns number of received items',
900             type => 'int'
901         }
902     }
903 );
904
905 sub unitize_items {
906     my ($self, $conn, $auth, $items) = @_;
907
908     my( $reqr, $evt ) = $U->checkses($auth);
909     return $evt if $evt;
910     my $editor = new_editor(requestor => $reqr, xact => 1);
911     $self->api_name =~ /serial\.(\w*)_items/;
912     my $mode = $1;
913     
914     my %found_unit_ids;
915     my %found_stream_ids;
916     my %found_types;
917
918     my %stream_ids_by_unit_id;
919
920     my %unit_map;
921     my %sdist_by_unit_id;
922     my %sdist_by_stream_id;
923
924     my $new_unit_id; # id for '-2' units to share
925     foreach my $item (@$items) {
926         # for debugging only, TODO: delete
927         if (!ref $item) { # hopefully we got an id instead
928             $item = $editor->retrieve_serial_item($item);
929         }
930         # get ids
931         my $unit_id = ref($item->unit) ? $item->unit->id : $item->unit;
932         my $stream_id = ref($item->stream) ? $item->stream->id : $item->stream;
933         my $issuance_id = ref($item->issuance) ? $item->issuance->id : $item->issuance;
934         #TODO: evt on any missing ids
935
936         if ($mode eq 'receive') {
937             $item->date_received('now');
938             $item->status('Received');
939         } else {
940             $item->status('Bindery');
941         }
942
943         # check for types to trigger summary updates
944         my $scap;
945         if (!ref $item->issuance) {
946             my $scaps = $editor->search_serial_caption_and_pattern([{"+siss" => {"id" => $issuance_id}}, { "join" => {"siss" => {}} }]);
947             $scap = $scaps->[0];
948         } elsif (!ref $item->issuance->caption_and_pattern) {
949             $scap = $editor->retrieve_serial_caption_and_pattern($item->issuance->caption_and_pattern);
950         } else {
951             $scap = $editor->issuance->caption_and_pattern;
952         }
953         if (!exists($found_types{$stream_id})) {
954             $found_types{$stream_id} = {};
955         }
956         $found_types{$stream_id}->{$scap->type} = 1;
957
958         # create unit if needed
959         if ($unit_id == -1 or (!$new_unit_id and $unit_id == -2)) { # create unit per item
960             my $unit;
961             my $sdists = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
962             $unit = _build_unit($editor, $sdists->[0], $mode);
963             my $evt =  _create_sunit($editor, $unit);
964             return $evt if $evt;
965             if ($unit_id == -2) {
966                 $new_unit_id = $unit->id;
967                 $unit_id = $new_unit_id;
968             } else {
969                 $unit_id = $unit->id;
970             }
971             $item->unit($unit_id);
972             
973             # get unit with 'DEFAULT's and save unit and sdist for later use
974             $unit = $editor->retrieve_serial_unit($unit->id);
975             $unit_map{$unit_id} = $unit;
976             $sdist_by_unit_id{$unit_id} = $sdists->[0];
977             $sdist_by_stream_id{$stream_id} = $sdists->[0];
978         } elsif ($unit_id == -2) { # create one unit for all '-2' items
979             $unit_id = $new_unit_id;
980             $item->unit($unit_id);
981         }
982
983         $found_unit_ids{$unit_id} = 1;
984         $found_stream_ids{$stream_id} = 1;
985
986         # save the stream_id for this unit_id
987         # TODO: prevent items from different streams in same unit? (perhaps in interface)
988         $stream_ids_by_unit_id{$unit_id} = $stream_id;
989
990         my $evt = _update_sitem($editor, undef, $item);
991         return $evt if $evt;
992     }
993
994     # deal with unit level labels
995     foreach my $unit_id (keys %found_unit_ids) {
996
997         # get all the needed issuances for unit
998         my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"unit" => $unit_id, "status" => "Received"}}, {"join" => {"sitem" => {}}, "order_by" => {"siss" => "date_published"}} ]);
999         #TODO: evt on search failure
1000
1001         my ($mfhd, $formatted_parts) = _summarize_contents($editor, $issuances);
1002
1003         # special case for single formatted_part (may have summarized version)
1004         if (@$formatted_parts == 1) {
1005             #TODO: MFHD.pm should have a 'format_summary' method for this
1006         }
1007
1008         # retrieve and update unit contents
1009         my $sunit;
1010         my $sdist;
1011
1012         # if we just created the unit, we will already have it and the distribution stored
1013         if (exists $unit_map{$unit_id}) {
1014             $sunit = $unit_map{$unit_id};
1015             $sdist = $sdist_by_unit_id{$unit_id};
1016         } else {
1017             $sunit = $editor->retrieve_serial_unit($unit_id);
1018             $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_ids_by_unit_id{$unit_id}}}, { "join" => {"sstr" => {}} }]);
1019             $sdist = $sdist->[0];
1020         }
1021
1022         $sunit->detailed_contents($sdist->unit_label_prefix . ' '
1023                     . join(', ', @$formatted_parts) . ' '
1024                     . $sdist->unit_label_suffix);
1025
1026         $sunit->summary_contents($sunit->detailed_contents); #TODO: change this when real summary contents are available
1027
1028         # create sort_key by left padding numbers to 6 digits
1029         my $sort_key = $sunit->detailed_contents;
1030         $sort_key =~ s/(\d+)/sprintf '%06d', $1/eg; # this may need improvement
1031         $sunit->sort_key($sort_key);
1032         
1033         if ($mode eq 'bind') {
1034             $sunit->status(2); # set to 'Bindery' status
1035         }
1036
1037         my $evt = _update_sunit($editor, undef, $sunit);
1038         return $evt if $evt;
1039     }
1040
1041     # TODO: cleanup 'dead' units (units which are now emptied of their items)
1042
1043     if ($mode eq 'receive') { # the summary holdings do not change when binding
1044         # deal with stream level summaries
1045         # summaries will be built from the "primary" stream only, that is, the stream with the lowest ID per distribution
1046         # (TODO: consider direct designation)
1047         my %primary_streams_by_sdist;
1048         my %streams_by_sdist;
1049
1050         # see if we have primary streams, and if so, associate them with their distributions
1051         foreach my $stream_id (keys %found_stream_ids) {
1052             my $sdist;
1053             if (exists $sdist_by_stream_id{$stream_id}) {
1054                 $sdist = $sdist_by_stream_id{$stream_id};
1055             } else {
1056                 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
1057                 $sdist = $sdist->[0];
1058             }
1059             my $streams;
1060             if (!exists($streams_by_sdist{$sdist->id})) {
1061                 $streams = $editor->search_serial_stream([{"distribution" => $sdist->id}, {"order_by" => {"sstr" => "id"}}]);
1062                 $streams_by_sdist{$sdist->id} = $streams;
1063             } else {
1064                 $streams = $streams_by_sdist{$sdist->id};
1065             }
1066             $primary_streams_by_sdist{$sdist->id} = $streams->[0] if ($stream_id == $streams->[0]->id);
1067         }
1068
1069         # retrieve and update summaries for each affected primary stream's distribution
1070         foreach my $sdist_id (keys %primary_streams_by_sdist) {
1071             my $stream = $primary_streams_by_sdist{$sdist_id};
1072             my $stream_id = $stream->id;
1073             # get all the needed issuances for stream
1074             # FIXME: search in Bindery/Bound/Not Published? as well as Received
1075             foreach my $type (keys %{$found_types{$stream_id}}) {
1076                 my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"stream" => $stream_id, "status" => "Received"}, "+scap" => {"type" => $type}}, {"join" => {"sitem" => {}, "scap" => {}}, "order_by" => {"siss" => "date_published"}} ]);
1077                 #TODO: evt on search failure
1078
1079                 my ($mfhd, $formatted_parts) = _summarize_contents($editor, $issuances);
1080
1081                 # retrieve and update the generated_coverage of the summary
1082                 my $search_method = "search_serial_${type}_summary";
1083                 my $summary = $editor->$search_method([{"distribution" => $sdist_id}]);
1084                 $summary = $summary->[0];
1085                 $summary->generated_coverage(join(', ', @$formatted_parts));
1086                 my $update_method = "update_serial_${type}_summary";
1087                 return $editor->event unless $editor->$update_method($summary);
1088             }
1089         }
1090     }
1091
1092     $editor->commit;
1093     return {'num_items_received' => scalar @$items, 'new_unit_id' => $new_unit_id};
1094 }
1095
1096 sub _find_or_create_call_number {
1097     my ($e, $lib, $cn_string, $record) = @_;
1098
1099     my $existing = $e->search_asset_call_number({
1100         "owning_lib" => $lib,
1101         "label" => $cn_string,
1102         "record" => $record,
1103         "deleted" => "f"
1104     }) or return $e->die_event;
1105
1106     if (@$existing) {
1107         return $existing->[0]->id;
1108     } else {
1109         return $e->die_event unless
1110             $e->allowed("CREATE_VOLUME", $lib);
1111
1112         my $acn = new Fieldmapper::asset::call_number;
1113
1114         $acn->creator($e->requestor->id);
1115         $acn->editor($e->requestor->id);
1116         $acn->record($record);
1117         $acn->label($cn_string);
1118         $acn->owning_lib($lib);
1119
1120         $e->create_asset_call_number($acn) or return $e->die_event;
1121         return $e->data->id;
1122     }
1123 }
1124
1125 sub _issuances_received {
1126     my ($e, $sitem) = @_;
1127
1128     my $results = $e->json_query({
1129         "select" => {
1130             "sitem" => [
1131                 {"transform" => "distinct", "column" => "issuance"}
1132             ]
1133         },
1134         "from" => {"sitem" => {"sstr" => {}, "siss" => {}}},
1135         "where" => {
1136             "+sstr" => {"distribution" => $sitem->stream->distribution->id},
1137             "+siss" => {"holding_type" => $sitem->issuance->holding_type},
1138             "+sitem" => {"date_received" => {"!=" => undef}}
1139         }
1140     }) or return $e->die_event;
1141
1142     return [ map { $e->retrieve_serial_issuance($_->{"issuance"}) } @$results ];
1143 }
1144
1145 # XXX _prepare_unit_label() duplicates some code from unitize_items().
1146 # Hopefully we can unify code paths down the road.
1147 sub _prepare_unit_label {
1148     my ($e, $sunit, $sdist, $issuance) = @_;
1149
1150     my ($mfhd, $formatted_parts) = _summarize_contents($e, [$issuance]);
1151
1152     # special case for single formatted_part (may have summarized version)
1153     if (@$formatted_parts == 1) {
1154         #TODO: MFHD.pm should have a 'format_summary' method for this
1155     }
1156
1157     $sunit->detailed_contents(
1158         join(
1159             " ",
1160             $sdist->unit_label_prefix,
1161             join(", ", @$formatted_parts),
1162             $sdist->unit_label_suffix
1163         )
1164     );
1165
1166     # TODO: change this when real summary contents are available
1167     $sunit->summary_contents($sunit->detailed_contents);
1168
1169     # Create sort_key by left padding numbers to 6 digits.
1170     (my $sort_key = $sunit->detailed_contents) =~
1171         s/(\d+)/sprintf '%06d', $1/eg;
1172     $sunit->sort_key($sort_key);
1173 }
1174
1175 # XXX duplicates a block of code from unitize_items().  Once I fully understand
1176 # what's going on and I'm sure it's working right, I'd like to have
1177 # unitize_items() just use this, keeping the logic in one place.
1178 sub _prepare_summaries {
1179     my ($e, $sitem, $issuances) = @_;
1180
1181     my $dist_id = $sitem->stream->distribution->id;
1182     my $type = $sitem->issuance->holding_type;
1183
1184     # Make sure @$issuances contains the new issuance from sitem.
1185     unless (grep { $_->id == $sitem->issuance->id } @$issuances) {
1186         push @$issuances, $sitem->issuance;
1187     }
1188
1189     my ($mfhd, $formatted_parts) = _summarize_contents($e, $issuances);
1190
1191     my $search_method = "search_serial_${type}_summary";
1192     my $summary = $e->$search_method([{"distribution" => $dist_id}]);
1193
1194     my $cu_method = "update";
1195
1196     if (@$summary) {
1197         $summary = $summary->[0];
1198     } else {
1199         my $class = "Fieldmapper::serial::${type}_summary";
1200         $summary = $class->new;
1201         $summary->distribution($dist_id);
1202         $cu_method = "create";
1203     }
1204
1205     $summary->generated_coverage(join(", ", @$formatted_parts));
1206     my $method = "${cu_method}_serial_${type}_summary";
1207     return $e->die_event unless $e->$method($summary);
1208 }
1209
1210 __PACKAGE__->register_method(
1211     "method" => "receive_items_one_unit_per",
1212     "api_name" => "open-ils.serial.receive_items.one_unit_per",
1213     "stream" => 1,
1214     "api_level" => 1,
1215     "argc" => 3,
1216     "signature" => {
1217         "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",
1218         "params" => [
1219             {
1220                  "name" => "auth",
1221                  "desc" => "authtoken",
1222                  "type" => "string"
1223             },
1224             {
1225                  "name" => "items",
1226                  "desc" => "array of serial items, possibly fleshed with units and definitely fleshed with stream->distribution",
1227                  "type" => "array"
1228             },
1229             {
1230                 "name" => "record",
1231                 "desc" => "id of bib record these items are associated with
1232                     (XXX could/should be derived from items)",
1233                 "type" => "number"
1234             }
1235         ],
1236         "return" => {
1237             "desc" => "The item ID for each item successfully received",
1238             "type" => "int"
1239         }
1240     }
1241 );
1242
1243 sub receive_items_one_unit_per {
1244     # XXX This function may be temporary, as it does some of what
1245     # unitize_items() does, just in a different way.
1246     my ($self, $client, $auth, $items, $record) = @_;
1247
1248     my $e = new_editor("authtoken" => $auth, "xact" => 1);
1249     return $e->die_event unless $e->checkauth;
1250     return $e->die_event unless $e->allowed("RECEIVE_SERIAL");
1251
1252     my $user_id = $e->requestor->id;
1253
1254     # Get a list of all the non-virtual field names in a serial::unit for
1255     # merging given unit objects with template-built units later.
1256     # XXX move this somewhere global so it isn't re-run all the time
1257     my $all_unit_fields =
1258         $Fieldmapper::fieldmap->{"Fieldmapper::serial::unit"}->{"fields"};
1259     my @real_unit_fields = grep {
1260         not $all_unit_fields->{$_}->{"virtual"}
1261     } keys %$all_unit_fields;
1262
1263     foreach my $item (@$items) {
1264         # Note that we expect a certain fleshing on the items we're getting.
1265         my $sdist = $item->stream->distribution;
1266
1267         # Create unit if given by user
1268         if (ref $item->unit) {
1269             # detach from the item, as we need to create separately
1270             my $user_unit = $item->unit;
1271
1272             # get a unit based on associated template
1273             my $template_unit = _build_unit($e, $sdist, "receive", 1);
1274             if ($U->event_code($template_unit)) {
1275                 $e->rollback;
1276                 $template_unit->{"note"} = "Item ID: " . $item->id;
1277                 return $template_unit;
1278             }
1279
1280             # merge built unit with provided unit from user
1281             foreach (@real_unit_fields) {
1282                 unless ($user_unit->$_) {
1283                     $user_unit->$_($template_unit->$_);
1284                 }
1285             }
1286
1287             # Treat call number specially: the provided value from the
1288             # user will really be a string.
1289             if ($user_unit->call_number) {
1290                 my $real_cn = _find_or_create_call_number(
1291                     $e, $sdist->holding_lib->id,
1292                     $user_unit->call_number, $record
1293                 );
1294
1295                 if ($U->event_code($real_cn)) {
1296                     $e->rollback;
1297                     return $real_cn;
1298                 } else {
1299                     $user_unit->call_number($real_cn);
1300                 }
1301             }
1302
1303             my $evt = _prepare_unit_label(
1304                 $e, $user_unit, $sdist, $item->issuance
1305             );
1306             if ($U->event_code($evt)) {
1307                 $e->rollback;
1308                 return $evt;
1309             }
1310
1311             # fetch a list of issuances with received copies already existing
1312             # on this distribution.
1313             my $issuances = _issuances_received($e, $item); #XXX optimize later
1314             if ($U->event_code($issuances)) {
1315                 $e->rollback;
1316                 return $issuances;
1317             }
1318
1319             # create/update summary objects related to this distribution
1320             $evt = _prepare_summaries($e, $item, $issuances);
1321             if ($U->event_code($evt)) {
1322                 $e->rollback;
1323                 return $evt;
1324             }
1325
1326             # set the incontrovertibles on the unit
1327             $user_unit->edit_date("now");
1328             $user_unit->create_date("now");
1329             $user_unit->editor($user_id);
1330             $user_unit->creator($user_id);
1331
1332             return $e->die_event unless $e->create_serial_unit($user_unit);
1333
1334             # save reference to new unit
1335             $item->unit($e->data->id);
1336         }
1337
1338         # Create notes if given by user
1339         if (ref($item->notes) and @{$item->notes}) {
1340             foreach my $note (@{$item->notes}) {
1341                 $note->creator($user_id);
1342                 $note->create_date("now");
1343
1344                 return $e->die_event unless $e->create_serial_item_note($note);
1345             }
1346
1347             $item->clear_notes; # They're saved; we no longer want them here.
1348         }
1349
1350         # Set the incontrovertibles on the item
1351         $item->status("Received");
1352         $item->date_received("now");
1353         $item->edit_date("now");
1354         $item->editor($user_id);
1355
1356         return $e->die_event unless $e->update_serial_item($item);
1357
1358         # send client a response
1359         $client->respond($item->id);
1360     }
1361
1362     $e->commit or return $e->die_event;
1363     undef;
1364 }
1365
1366 sub _build_unit {
1367     my $editor = shift;
1368     my $sdist = shift;
1369     my $mode = shift;
1370     my $skip_call_number = shift;
1371
1372     my $attr = $mode . '_unit_template';
1373     my $template = $editor->retrieve_asset_copy_template($sdist->$attr) or
1374         return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_COPY_TEMPLATE");
1375
1376     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 );
1377
1378     my $unit = new Fieldmapper::serial::unit;
1379     foreach my $part (@parts) {
1380         my $value = $template->$part;
1381         next if !defined($value);
1382         $unit->$part($value);
1383     }
1384
1385     # ignore circ_lib in template, set to distribution holding_lib
1386     $unit->circ_lib($sdist->holding_lib);
1387     $unit->creator($editor->requestor->id);
1388     $unit->editor($editor->requestor->id);
1389
1390     unless ($skip_call_number) {
1391         $attr = $mode . '_call_number';
1392         my $cn = $sdist->$attr or
1393             return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_CALL_NUMBER");
1394
1395         $unit->call_number($cn);
1396     }
1397
1398     $unit->barcode('AUTO');
1399     $unit->sort_key('');
1400     $unit->summary_contents('');
1401     $unit->detailed_contents('');
1402
1403     return $unit;
1404 }
1405
1406
1407 sub _summarize_contents {
1408     my $editor = shift;
1409     my $issuances = shift;
1410
1411     # create MFHD record
1412     my $mfhd = MFHD->new(MARC::Record->new());
1413     my %scaps;
1414     my %scap_fields;
1415     my @scap_fields_ordered;
1416     my $seqno = 1;
1417     my $link_id = 1;
1418     foreach my $issuance (@$issuances) {
1419         my $scap_id = $issuance->caption_and_pattern;
1420         next if (!$scap_id); # skip issuances with no caption/pattern
1421
1422         my $scap;
1423         my $scap_field;
1424         # if this is the first appearance of this scap, retrieve it and add it to the temporary record
1425         if (!exists $scaps{$issuance->caption_and_pattern}) {
1426             $scaps{$scap_id} = $editor->retrieve_serial_caption_and_pattern($scap_id);
1427             $scap = $scaps{$scap_id};
1428             $scap_field = _revive_caption($scap);
1429             $scap_fields{$scap_id} = $scap_field;
1430             push(@scap_fields_ordered, $scap_field);
1431             $scap_field->update('8' => $link_id);
1432             $mfhd->append_fields($scap_field);
1433             $link_id++;
1434         } else {
1435             $scap = $scaps{$scap_id};
1436             $scap_field = $scap_fields{$scap_id};
1437         }
1438
1439         $mfhd->append_fields(_revive_holding($issuance->holding_code, $scap_field, $seqno));
1440         $seqno++;
1441     }
1442
1443     my @formatted_parts;
1444     foreach my $scap_field (@scap_fields_ordered) { #TODO: use generic MFHD "summarize" method, once available
1445        my @updated_holdings = $mfhd->get_compressed_holdings($scap_field);
1446        foreach my $holding (@updated_holdings) {
1447            push(@formatted_parts, $holding->format);
1448        }
1449     }
1450
1451     return ($mfhd, \@formatted_parts);
1452 }
1453
1454 ##########################################################################
1455 # note methods
1456 #
1457 __PACKAGE__->register_method(
1458     method      => 'fetch_notes',
1459     api_name        => 'open-ils.serial.item_note.retrieve.all',
1460     signature   => q/
1461         Returns an array of copy note objects.  
1462         @param args A named hash of parameters including:
1463             authtoken   : Required if viewing non-public notes
1464             item_id      : The id of the item whose notes we want to retrieve
1465             pub         : True if all the caller wants are public notes
1466         @return An array of note objects
1467     /
1468 );
1469
1470 __PACKAGE__->register_method(
1471     method      => 'fetch_notes',
1472     api_name        => 'open-ils.serial.subscription_note.retrieve.all',
1473     signature   => q/
1474         Returns an array of copy note objects.  
1475         @param args A named hash of parameters including:
1476             authtoken       : Required if viewing non-public notes
1477             subscription_id : The id of the item whose notes we want to retrieve
1478             pub             : True if all the caller wants are public notes
1479         @return An array of note objects
1480     /
1481 );
1482
1483 __PACKAGE__->register_method(
1484     method      => 'fetch_notes',
1485     api_name        => 'open-ils.serial.distribution_note.retrieve.all',
1486     signature   => q/
1487         Returns an array of copy note objects.  
1488         @param args A named hash of parameters including:
1489             authtoken       : Required if viewing non-public notes
1490             distribution_id : The id of the item whose notes we want to retrieve
1491             pub             : True if all the caller wants are public notes
1492         @return An array of note objects
1493     /
1494 );
1495
1496 # TODO: revisit this method to consider replacing cstore direct calls
1497 sub fetch_notes {
1498     my( $self, $connection, $args ) = @_;
1499     
1500     $self->api_name =~ /serial\.(\w*)_note/;
1501     my $type = $1;
1502
1503     my $id = $$args{object_id};
1504     my $authtoken = $$args{authtoken};
1505     my( $r, $evt);
1506
1507     if( $$args{pub} ) {
1508         return $U->cstorereq(
1509             'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic',
1510             { $type => $id, pub => 't' } );
1511     } else {
1512         # FIXME: restore perm check
1513         # ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
1514         # return $evt if $evt;
1515         return $U->cstorereq(
1516             'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic', {$type => $id} );
1517     }
1518
1519     return undef;
1520 }
1521
1522 __PACKAGE__->register_method(
1523     method      => 'create_note',
1524     api_name        => 'open-ils.serial.item_note.create',
1525     signature   => q/
1526         Creates a new item note
1527         @param authtoken The login session key
1528         @param note The note object to create
1529         @return The id of the new note object
1530     /
1531 );
1532
1533 __PACKAGE__->register_method(
1534     method      => 'create_note',
1535     api_name        => 'open-ils.serial.subscription_note.create',
1536     signature   => q/
1537         Creates a new subscription note
1538         @param authtoken The login session key
1539         @param note The note object to create
1540         @return The id of the new note object
1541     /
1542 );
1543
1544 __PACKAGE__->register_method(
1545     method      => 'create_note',
1546     api_name        => 'open-ils.serial.distribution_note.create',
1547     signature   => q/
1548         Creates a new distribution note
1549         @param authtoken The login session key
1550         @param note The note object to create
1551         @return The id of the new note object
1552     /
1553 );
1554
1555 sub create_note {
1556     my( $self, $connection, $authtoken, $note ) = @_;
1557
1558     $self->api_name =~ /serial\.(\w*)_note/;
1559     my $type = $1;
1560
1561     my $e = new_editor(xact=>1, authtoken=>$authtoken);
1562     return $e->event unless $e->checkauth;
1563
1564     # FIXME: restore permission support
1565 #    my $item = $e->retrieve_serial_item(
1566 #        [
1567 #            $note->item
1568 #        ]
1569 #    );
1570 #
1571 #    return $e->event unless
1572 #        $e->allowed('CREATE_COPY_NOTE', $item->call_number->owning_lib);
1573
1574     $note->create_date('now');
1575     $note->creator($e->requestor->id);
1576     $note->pub( ($U->is_true($note->pub)) ? 't' : 'f' );
1577     $note->clear_id;
1578
1579     my $method = "create_serial_${type}_note";
1580     $e->$method($note) or return $e->event;
1581     $e->commit;
1582     return $note->id;
1583 }
1584
1585 __PACKAGE__->register_method(
1586     method      => 'delete_note',
1587     api_name        =>  'open-ils.serial.item_note.delete',
1588     signature   => q/
1589         Deletes an existing item note
1590         @param authtoken The login session key
1591         @param noteid The id of the note to delete
1592         @return 1 on success - Event otherwise.
1593         /
1594 );
1595
1596 __PACKAGE__->register_method(
1597     method      => 'delete_note',
1598     api_name        =>  'open-ils.serial.subscription_note.delete',
1599     signature   => q/
1600         Deletes an existing subscription note
1601         @param authtoken The login session key
1602         @param noteid The id of the note to delete
1603         @return 1 on success - Event otherwise.
1604         /
1605 );
1606
1607 __PACKAGE__->register_method(
1608     method      => 'delete_note',
1609     api_name        =>  'open-ils.serial.distribution_note.delete',
1610     signature   => q/
1611         Deletes an existing distribution note
1612         @param authtoken The login session key
1613         @param noteid The id of the note to delete
1614         @return 1 on success - Event otherwise.
1615         /
1616 );
1617
1618 sub delete_note {
1619     my( $self, $conn, $authtoken, $noteid ) = @_;
1620
1621     $self->api_name =~ /serial\.(\w*)_note/;
1622     my $type = $1;
1623
1624     my $e = new_editor(xact=>1, authtoken=>$authtoken);
1625     return $e->die_event unless $e->checkauth;
1626
1627     my $method = "retrieve_serial_${type}_note";
1628     my $note = $e->$method([
1629         $noteid,
1630     ]) or return $e->die_event;
1631
1632 # FIXME: restore permissions check
1633 #    if( $note->creator ne $e->requestor->id ) {
1634 #        return $e->die_event unless
1635 #            $e->allowed('DELETE_COPY_NOTE', $note->item->call_number->owning_lib);
1636 #    }
1637
1638     $method = "delete_serial_${type}_note";
1639     $e->$method($note) or return $e->die_event;
1640     $e->commit;
1641     return 1;
1642 }
1643
1644
1645 ##########################################################################
1646 # subscription methods
1647 #
1648 __PACKAGE__->register_method(
1649     method    => 'fleshed_ssub_alter',
1650     api_name  => 'open-ils.serial.subscription.fleshed.batch.update',
1651     api_level => 1,
1652     argc      => 2,
1653     signature => {
1654         desc     => 'Receives an array of one or more subscriptions and updates the database as needed',
1655         'params' => [ {
1656                  name => 'authtoken',
1657                  desc => 'Authtoken for current user session',
1658                  type => 'string'
1659             },
1660             {
1661                  name => 'subscriptions',
1662                  desc => 'Array of fleshed subscriptions',
1663                  type => 'array'
1664             }
1665
1666         ],
1667         'return' => {
1668             desc => 'Returns 1 if successful, event if failed',
1669             type => 'mixed'
1670         }
1671     }
1672 );
1673
1674 sub fleshed_ssub_alter {
1675     my( $self, $conn, $auth, $ssubs ) = @_;
1676     return 1 unless ref $ssubs;
1677     my( $reqr, $evt ) = $U->checkses($auth);
1678     return $evt if $evt;
1679     my $editor = new_editor(requestor => $reqr, xact => 1);
1680     my $override = $self->api_name =~ /override/;
1681
1682 # TODO: permission check
1683 #        return $editor->event unless
1684 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
1685
1686     for my $ssub (@$ssubs) {
1687
1688         my $ssubid = $ssub->id;
1689
1690         if( $ssub->isdeleted ) {
1691             $evt = _delete_ssub( $editor, $override, $ssub);
1692         } elsif( $ssub->isnew ) {
1693             _cleanse_dates($ssub, ['start_date','end_date']);
1694             $evt = _create_ssub( $editor, $ssub );
1695         } else {
1696             _cleanse_dates($ssub, ['start_date','end_date']);
1697             $evt = _update_ssub( $editor, $override, $ssub );
1698         }
1699     }
1700
1701     if( $evt ) {
1702         $logger->info("fleshed subscription-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
1703         $editor->rollback;
1704         return $evt;
1705     }
1706     $logger->debug("subscription-alter: done updating subscription batch");
1707     $editor->commit;
1708     $logger->info("fleshed subscription-alter successfully updated ".scalar(@$ssubs)." subscriptions");
1709     return 1;
1710 }
1711
1712 sub _delete_ssub {
1713     my ($editor, $override, $ssub) = @_;
1714     $logger->info("subscription-alter: delete subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1715     my $sdists = $editor->search_serial_distribution(
1716             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1717     my $cps = $editor->search_serial_caption_and_pattern(
1718             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1719     my $sisses = $editor->search_serial_issuance(
1720             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1721     return OpenILS::Event->new(
1722             'SERIAL_SUBSCRIPTION_NOT_EMPTY', payload => $ssub->id ) if (@$sdists or @$cps or @$sisses);
1723
1724     return $editor->event unless $editor->delete_serial_subscription($ssub);
1725     return 0;
1726 }
1727
1728 sub _create_ssub {
1729     my ($editor, $ssub) = @_;
1730
1731     $logger->info("subscription-alter: new subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1732     return $editor->event unless $editor->create_serial_subscription($ssub);
1733     return 0;
1734 }
1735
1736 sub _update_ssub {
1737     my ($editor, $override, $ssub) = @_;
1738
1739     $logger->info("subscription-alter: retrieving subscription ".$ssub->id);
1740     my $orig_ssub = $editor->retrieve_serial_subscription($ssub->id);
1741
1742     $logger->info("subscription-alter: original subscription ".OpenSRF::Utils::JSON->perl2JSON($orig_ssub));
1743     $logger->info("subscription-alter: updated subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1744     return $editor->event unless $editor->update_serial_subscription($ssub);
1745     return 0;
1746 }
1747
1748 __PACKAGE__->register_method(
1749     method  => "fleshed_serial_subscription_retrieve_batch",
1750     authoritative => 1,
1751     api_name    => "open-ils.serial.subscription.fleshed.batch.retrieve"
1752 );
1753
1754 sub fleshed_serial_subscription_retrieve_batch {
1755     my( $self, $client, $ids ) = @_;
1756 # FIXME: permissions?
1757     $logger->info("Fetching fleshed subscriptions @$ids");
1758     return $U->cstorereq(
1759         "open-ils.cstore.direct.serial.subscription.search.atomic",
1760         { id => $ids },
1761         { flesh => 1,
1762           flesh_fields => {ssub => [ qw/owning_lib notes/ ]}
1763         });
1764 }
1765
1766 __PACKAGE__->register_method(
1767         method  => "retrieve_sub_tree",
1768     authoritative => 1,
1769         api_name        => "open-ils.serial.subscription_tree.retrieve"
1770 );
1771
1772 __PACKAGE__->register_method(
1773         method  => "retrieve_sub_tree",
1774         api_name        => "open-ils.serial.subscription_tree.global.retrieve"
1775 );
1776
1777 sub retrieve_sub_tree {
1778
1779         my( $self, $client, $user_session, $docid, @org_ids ) = @_;
1780
1781         if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
1782
1783         $docid = "$docid";
1784
1785         # TODO: permission support
1786         if(!@org_ids and $user_session) {
1787                 my $user_obj = 
1788                         OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
1789                         @org_ids = ($user_obj->home_ou);
1790         }
1791
1792         if( $self->api_name =~ /global/ ) {
1793                 return _build_subs_list( { record_entry => $docid } ); # TODO: filter for !deleted, or active?
1794
1795         } else {
1796
1797                 my @all_subs;
1798                 for my $orgid (@org_ids) {
1799                         my $subs = _build_subs_list( 
1800                                         { record_entry => $docid, owning_lib => $orgid } );# TODO: filter for !deleted, or active?
1801                         push( @all_subs, @$subs );
1802                 }
1803                 
1804                 return \@all_subs;
1805         }
1806
1807         return undef;
1808 }
1809
1810 sub _build_subs_list {
1811         my $search_hash = shift;
1812
1813         #$search_hash->{deleted} = 'f';
1814         my $e = new_editor();
1815
1816         my $subs = $e->search_serial_subscription([$search_hash, { 'order_by' => {'ssub' => 'id'} }]);
1817
1818         my @built_subs;
1819
1820         for my $sub (@$subs) {
1821
1822         # TODO: filter on !deleted?
1823                 my $dists = $e->search_serial_distribution(
1824             [{ subscription => $sub->id }, { 'order_by' => {'sdist' => 'label'} }]
1825             );
1826
1827                 #$dists = [ sort { $a->label cmp $b->label } @$dists  ];
1828
1829                 $sub->distributions($dists);
1830         
1831         # TODO: filter on !deleted?
1832                 my $issuances = $e->search_serial_issuance(
1833                         [{ subscription => $sub->id }, { 'order_by' => {'siss' => 'label'} }]
1834             );
1835
1836                 #$issuances = [ sort { $a->label cmp $b->label } @$issuances  ];
1837                 $sub->issuances($issuances);
1838
1839         # TODO: filter on !deleted?
1840                 my $scaps = $e->search_serial_caption_and_pattern(
1841                         [{ subscription => $sub->id }, { 'order_by' => {'scap' => 'id'} }]
1842             );
1843
1844                 #$scaps = [ sort { $a->id cmp $b->id } @$scaps  ];
1845                 $sub->scaps($scaps);
1846                 push( @built_subs, $sub );
1847         }
1848
1849         return \@built_subs;
1850
1851 }
1852
1853 __PACKAGE__->register_method(
1854     method  => "subscription_orgs_for_title",
1855     authoritative => 1,
1856     api_name    => "open-ils.serial.subscription.retrieve_orgs_by_title"
1857 );
1858
1859 sub subscription_orgs_for_title {
1860     my( $self, $client, $record_id ) = @_;
1861
1862     my $subs = $U->simple_scalar_request(
1863         "open-ils.cstore",
1864         "open-ils.cstore.direct.serial.subscription.search.atomic",
1865         { record_entry => $record_id }); # TODO: filter on !deleted?
1866
1867     my $orgs = { map {$_->owning_lib => 1 } @$subs };
1868     return [ keys %$orgs ];
1869 }
1870
1871
1872 ##########################################################################
1873 # distribution methods
1874 #
1875 __PACKAGE__->register_method(
1876     method    => 'fleshed_sdist_alter',
1877     api_name  => 'open-ils.serial.distribution.fleshed.batch.update',
1878     api_level => 1,
1879     argc      => 2,
1880     signature => {
1881         desc     => 'Receives an array of one or more distributions and updates the database as needed',
1882         'params' => [ {
1883                  name => 'authtoken',
1884                  desc => 'Authtoken for current user session',
1885                  type => 'string'
1886             },
1887             {
1888                  name => 'distributions',
1889                  desc => 'Array of fleshed distributions',
1890                  type => 'array'
1891             }
1892
1893         ],
1894         'return' => {
1895             desc => 'Returns 1 if successful, event if failed',
1896             type => 'mixed'
1897         }
1898     }
1899 );
1900
1901 sub fleshed_sdist_alter {
1902     my( $self, $conn, $auth, $sdists ) = @_;
1903     return 1 unless ref $sdists;
1904     my( $reqr, $evt ) = $U->checkses($auth);
1905     return $evt if $evt;
1906     my $editor = new_editor(requestor => $reqr, xact => 1);
1907     my $override = $self->api_name =~ /override/;
1908
1909 # TODO: permission check
1910 #        return $editor->event unless
1911 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
1912
1913     for my $sdist (@$sdists) {
1914         my $sdistid = $sdist->id;
1915
1916         if( $sdist->isdeleted ) {
1917             $evt = _delete_sdist( $editor, $override, $sdist);
1918         } elsif( $sdist->isnew ) {
1919             $evt = _create_sdist( $editor, $sdist );
1920         } else {
1921             $evt = _update_sdist( $editor, $override, $sdist );
1922         }
1923     }
1924
1925     if( $evt ) {
1926         $logger->info("fleshed distribution-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
1927         $editor->rollback;
1928         return $evt;
1929     }
1930     $logger->debug("distribution-alter: done updating distribution batch");
1931     $editor->commit;
1932     $logger->info("fleshed distribution-alter successfully updated ".scalar(@$sdists)." distributions");
1933     return 1;
1934 }
1935
1936 sub _delete_sdist {
1937     my ($editor, $override, $sdist) = @_;
1938     $logger->info("distribution-alter: delete distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1939     return $editor->event unless $editor->delete_serial_distribution($sdist);
1940     return 0;
1941 }
1942
1943 sub _create_sdist {
1944     my ($editor, $sdist) = @_;
1945
1946     $logger->info("distribution-alter: new distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1947     return $editor->event unless $editor->create_serial_distribution($sdist);
1948
1949     # create summaries too
1950     my $summary = new Fieldmapper::serial::basic_summary;
1951     $summary->distribution($sdist->id);
1952     $summary->generated_coverage('');
1953     return $editor->event unless $editor->create_serial_basic_summary($summary);
1954     $summary = new Fieldmapper::serial::supplement_summary;
1955     $summary->distribution($sdist->id);
1956     $summary->generated_coverage('');
1957     return $editor->event unless $editor->create_serial_supplement_summary($summary);
1958     $summary = new Fieldmapper::serial::index_summary;
1959     $summary->distribution($sdist->id);
1960     $summary->generated_coverage('');
1961     return $editor->event unless $editor->create_serial_index_summary($summary);
1962
1963     # create a starter stream (TODO: reconsider this)
1964     my $stream = new Fieldmapper::serial::stream;
1965     $stream->distribution($sdist->id);
1966     return $editor->event unless $editor->create_serial_stream($stream);
1967
1968     return 0;
1969 }
1970
1971 sub _update_sdist {
1972     my ($editor, $override, $sdist) = @_;
1973
1974     $logger->info("distribution-alter: retrieving distribution ".$sdist->id);
1975     my $orig_sdist = $editor->retrieve_serial_distribution($sdist->id);
1976
1977     $logger->info("distribution-alter: original distribution ".OpenSRF::Utils::JSON->perl2JSON($orig_sdist));
1978     $logger->info("distribution-alter: updated distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1979     return $editor->event unless $editor->update_serial_distribution($sdist);
1980     return 0;
1981 }
1982
1983 __PACKAGE__->register_method(
1984     method  => "fleshed_serial_distribution_retrieve_batch",
1985     authoritative => 1,
1986     api_name    => "open-ils.serial.distribution.fleshed.batch.retrieve"
1987 );
1988
1989 sub fleshed_serial_distribution_retrieve_batch {
1990     my( $self, $client, $ids ) = @_;
1991 # FIXME: permissions?
1992     $logger->info("Fetching fleshed distributions @$ids");
1993     return $U->cstorereq(
1994         "open-ils.cstore.direct.serial.distribution.search.atomic",
1995         { id => $ids },
1996         { flesh => 1,
1997           flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams / ]}
1998         });
1999 }
2000
2001 ##########################################################################
2002 # caption and pattern methods
2003 #
2004 __PACKAGE__->register_method(
2005     method    => 'scap_alter',
2006     api_name  => 'open-ils.serial.caption_and_pattern.batch.update',
2007     api_level => 1,
2008     argc      => 2,
2009     signature => {
2010         desc     => 'Receives an array of one or more caption and patterns and updates the database as needed',
2011         'params' => [ {
2012                  name => 'authtoken',
2013                  desc => 'Authtoken for current user session',
2014                  type => 'string'
2015             },
2016             {
2017                  name => 'scaps',
2018                  desc => 'Array of caption and patterns',
2019                  type => 'array'
2020             }
2021
2022         ],
2023         'return' => {
2024             desc => 'Returns 1 if successful, event if failed',
2025             type => 'mixed'
2026         }
2027     }
2028 );
2029
2030 sub scap_alter {
2031     my( $self, $conn, $auth, $scaps ) = @_;
2032     return 1 unless ref $scaps;
2033     my( $reqr, $evt ) = $U->checkses($auth);
2034     return $evt if $evt;
2035     my $editor = new_editor(requestor => $reqr, xact => 1);
2036     my $override = $self->api_name =~ /override/;
2037
2038 # TODO: permission check
2039 #        return $editor->event unless
2040 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
2041
2042     for my $scap (@$scaps) {
2043         my $scapid = $scap->id;
2044
2045         if( $scap->isdeleted ) {
2046             $evt = _delete_scap( $editor, $override, $scap);
2047         } elsif( $scap->isnew ) {
2048             $evt = _create_scap( $editor, $scap );
2049         } else {
2050             $evt = _update_scap( $editor, $override, $scap );
2051         }
2052     }
2053
2054     if( $evt ) {
2055         $logger->info("caption_and_pattern-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2056         $editor->rollback;
2057         return $evt;
2058     }
2059     $logger->debug("caption_and_pattern-alter: done updating caption_and_pattern batch");
2060     $editor->commit;
2061     $logger->info("caption_and_pattern-alter successfully updated ".scalar(@$scaps)." caption_and_patterns");
2062     return 1;
2063 }
2064
2065 sub _delete_scap {
2066     my ($editor, $override, $scap) = @_;
2067     $logger->info("caption_and_pattern-alter: delete caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2068     my $sisses = $editor->search_serial_issuance(
2069             { caption_and_pattern => $scap->id }, { limit => 1 } ); #TODO: 'deleted' support?
2070     return OpenILS::Event->new(
2071             'SERIAL_CAPTION_AND_PATTERN_HAS_ISSUANCES', payload => $scap->id ) if (@$sisses);
2072
2073     return $editor->event unless $editor->delete_serial_caption_and_pattern($scap);
2074     return 0;
2075 }
2076
2077 sub _create_scap {
2078     my ($editor, $scap) = @_;
2079
2080     $logger->info("caption_and_pattern-alter: new caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2081     return $editor->event unless $editor->create_serial_caption_and_pattern($scap);
2082     return 0;
2083 }
2084
2085 sub _update_scap {
2086     my ($editor, $override, $scap) = @_;
2087
2088     $logger->info("caption_and_pattern-alter: retrieving caption_and_pattern ".$scap->id);
2089     my $orig_scap = $editor->retrieve_serial_caption_and_pattern($scap->id);
2090
2091     $logger->info("caption_and_pattern-alter: original caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($orig_scap));
2092     $logger->info("caption_and_pattern-alter: updated caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2093     return $editor->event unless $editor->update_serial_caption_and_pattern($scap);
2094     return 0;
2095 }
2096
2097 __PACKAGE__->register_method(
2098     method  => "serial_caption_and_pattern_retrieve_batch",
2099     authoritative => 1,
2100     api_name    => "open-ils.serial.caption_and_pattern.batch.retrieve"
2101 );
2102
2103 sub serial_caption_and_pattern_retrieve_batch {
2104     my( $self, $client, $ids ) = @_;
2105     $logger->info("Fetching caption_and_patterns @$ids");
2106     return $U->cstorereq(
2107         "open-ils.cstore.direct.serial.caption_and_pattern.search.atomic",
2108         { id => $ids }
2109     );
2110 }
2111
2112 __PACKAGE__->register_method(
2113     "method" => "bre_by_identifier",
2114     "api_name" => "open-ils.serial.biblio.record_entry.by_identifier",
2115     "stream" => 1,
2116     "signature" => {
2117         "desc" => "Find instances of biblio.record_entry given a search token" .
2118             " that could be a value for any identifier defined in " .
2119             "config.metabib_field",
2120         "params" => [
2121             {"desc" => "Search token", "type" => "string"},
2122             {"desc" => "Options: require_subscriptions, add_mvr, is_actual_id" .
2123                 " (all boolean)", "type" => "object"}
2124         ],
2125         "return" => {
2126             "desc" => "Any matching BREs, or if the add_mvr option is true, " .
2127                 "objects with a 'bre' key/value pair, and an 'mvr' " .
2128                 "key-value pair.  BREs have subscriptions fleshed on.",
2129             "type" => "object"
2130         }
2131     }
2132 );
2133
2134 sub bre_by_identifier {
2135     my ($self, $client, $term, $options) = @_;
2136
2137     return new OpenILS::Event("BAD_PARAMS") unless $term;
2138
2139     $options ||= {};
2140     my $e = new_editor();
2141
2142     my @ids;
2143
2144     if ($options->{"is_actual_id"}) {
2145         @ids = ($term);
2146     } else {
2147         my $cmf =
2148             $e->search_config_metabib_field({"field_class" => "identifier"})
2149                 or return $e->die_event;
2150
2151         my @identifiers = map { $_->name } @$cmf;
2152         my $query = join(" || ", map { "id|$_: $term" } @identifiers);
2153
2154         my $search = create OpenSRF::AppSession("open-ils.search");
2155         my $search_result = $search->request(
2156             "open-ils.search.biblio.multiclass.query.staff", {}, $query
2157         )->gather(1);
2158         $search->disconnect;
2159
2160         # Un-nest results. They tend to look like [[1],[2],[3]] for some reason.
2161         @ids = map { @{$_} } @{$search_result->{"ids"}};
2162
2163         unless (@ids) {
2164             $e->disconnect;
2165             return undef;
2166         }
2167     }
2168
2169     my $bre = $e->search_biblio_record_entry([
2170         {"id" => \@ids}, {
2171             "flesh" => 2, "flesh_fields" => {
2172                 "bre" => ["subscriptions"],
2173                 "ssub" => ["owning_lib"]
2174             }
2175         }
2176     ]) or return $e->die_event;
2177
2178     if (@$bre && $options->{"require_subscriptions"}) {
2179         $bre = [ grep { @{$_->subscriptions} } @$bre ];
2180     }
2181
2182     $e->disconnect;
2183
2184     if (@$bre) { # re-evaluate after possible grep
2185         if ($options->{"add_mvr"}) {
2186             $client->respond(
2187                 {"bre" => $_, "mvr" => _get_mvr($_->id)}
2188             ) foreach (@$bre);
2189         } else {
2190             $client->respond($_) foreach (@$bre);
2191         }
2192     }
2193
2194     undef;
2195 }
2196
2197 __PACKAGE__->register_method(
2198     "method" => "get_receivable_items",
2199     "api_name" => "open-ils.serial.items.receivable.by_subscription",
2200     "stream" => 1,
2201     "signature" => {
2202         "desc" => "Return all receivable items under a given subscription",
2203         "params" => [
2204             {"desc" => "Authtoken", "type" => "string"},
2205             {"desc" => "Subscription ID", "type" => "number"},
2206         ],
2207         "return" => {
2208             "desc" => "All receivable items under a given subscription",
2209             "type" => "object"
2210         }
2211     }
2212 );
2213
2214 __PACKAGE__->register_method(
2215     "method" => "get_receivable_items",
2216     "api_name" => "open-ils.serial.items.receivable.by_issuance",
2217     "stream" => 1,
2218     "signature" => {
2219         "desc" => "Return all receivable items under a given issuance",
2220         "params" => [
2221             {"desc" => "Authtoken", "type" => "string"},
2222             {"desc" => "Issuance ID", "type" => "number"},
2223         ],
2224         "return" => {
2225             "desc" => "All receivable items under a given issuance",
2226             "type" => "object"
2227         }
2228     }
2229 );
2230
2231 sub get_receivable_items {
2232     my ($self, $client, $auth, $term)  = @_;
2233
2234     my $e = new_editor("authtoken" => $auth);
2235     return $e->die_event unless $e->checkauth;
2236
2237     # XXX permissions
2238
2239     my $by = ($self->api_name =~ /by_(\w+)$/)[0];
2240
2241     my %where = (
2242         "issuance" => {"issuance" => $term},
2243         "subscription" => {"+siss" => {"subscription" => $term}}
2244     );
2245
2246     my $item_ids = $e->json_query(
2247         {
2248             "select" => {"sitem" => ["id"]},
2249             "from" => {"sitem" => "siss"},
2250             "where" => {
2251                 %{$where{$by}}, "date_received" => undef
2252             },
2253             "order_by" => {"sitem" => ["id"]}
2254         }
2255     ) or return $e->die_event;
2256
2257     return undef unless @$item_ids;
2258
2259     foreach (map { $_->{"id"} } @$item_ids) {
2260         $client->respond(
2261             $e->retrieve_serial_item([
2262                 $_, {
2263                     "flesh" => 3,
2264                     "flesh_fields" => {
2265                         "sitem" => ["stream", "issuance"],
2266                         "sstr" => ["distribution"],
2267                         "sdist" => ["holding_lib"]
2268                     }
2269                 }
2270             ])
2271         );
2272     }
2273
2274     $e->disconnect;
2275     undef;
2276 }
2277
2278 __PACKAGE__->register_method(
2279     "method" => "get_receivable_issuances",
2280     "api_name" => "open-ils.serial.issuances.receivable",
2281     "stream" => 1,
2282     "signature" => {
2283         "desc" => "Return all issuances with receivable items given " .
2284             "a subscription ID",
2285         "params" => [
2286             {"desc" => "Authtoken", "type" => "string"},
2287             {"desc" => "Subscription ID", "type" => "number"},
2288         ],
2289         "return" => {
2290             "desc" => "All issuances with receivable items " .
2291                 "(but not the items themselves)", "type" => "object"
2292         }
2293     }
2294 );
2295
2296 sub get_receivable_issuances {
2297     my ($self, $client, $auth, $sub_id) = @_;
2298
2299     my $e = new_editor("authtoken" => $auth);
2300     return $e->die_event unless $e->checkauth;
2301
2302     # XXX permissions
2303
2304     my $issuance_ids = $e->json_query({
2305         "select" => {
2306             "siss" => [
2307                 {"transform" => "distinct", "column" => "id"},
2308                 "date_published"
2309             ]
2310         },
2311         "from" => {"siss" => "sitem"},
2312         "where" => {
2313             "subscription" => $sub_id,
2314             "+sitem" => {"date_received" => undef}
2315         },
2316         "order_by" => {
2317             "siss" => {"date_published" => {"direction" => "asc"}}
2318         }
2319
2320     }) or return $e->die_event;
2321
2322     $client->respond($e->retrieve_serial_issuance($_->{"id"}))
2323         foreach (@$issuance_ids);
2324
2325     $e->disconnect;
2326     undef;
2327 }
2328
2329 1;