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.
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.
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.
19 OpenILS::Application::Serial - Performs serials-related tasks such as receiving issues and generating predictions
31 Dan Wells, dbw2@calvin.edu
35 package OpenILS::Application::Serial;
41 use OpenILS::Application;
42 use base qw/OpenILS::Application/;
43 use OpenILS::Application::AppUtils;
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');
65 # helper method for conforming dates to ISO8601
70 foreach my $field (@$fields) {
71 $item->$field(OpenSRF::Utils::clense_ISO8601($item->$field)) if $item->$field;
79 "open-ils.search.biblio.record.mods_slim.retrieve",
85 ##########################################################################
88 __PACKAGE__->register_method(
89 method => 'fleshed_item_alter',
90 api_name => 'open-ils.serial.item.fleshed.batch.update',
94 desc => 'Receives an array of one or more items and updates the database as needed',
97 desc => 'Authtoken for current user session',
102 desc => 'Array of fleshed items',
108 desc => 'Returns 1 if successful, event if failed',
114 sub fleshed_item_alter {
115 my( $self, $conn, $auth, $items ) = @_;
116 return 1 unless ref $items;
117 my( $reqr, $evt ) = $U->checkses($auth);
119 my $editor = new_editor(requestor => $reqr, xact => 1);
120 my $override = $self->api_name =~ /override/;
122 # TODO: permission check
123 # return $editor->event unless
124 # $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
126 for my $item (@$items) {
128 my $itemid = $item->id;
129 $item->editor($editor->requestor->id);
130 $item->edit_date('now');
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]);
140 _cleanse_dates($item, ['date_expected','date_received']);
141 $evt = _create_sitem( $editor, $item );
143 _cleanse_dates($item, ['date_expected','date_received']);
144 $evt = _update_sitem( $editor, $override, $item );
149 $logger->info("fleshed item-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
153 $logger->debug("item-alter: done updating item batch");
155 $logger->info("fleshed item-alter successfully updated ".scalar(@$items)." items");
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);
167 my ($editor, $item) = @_;
169 $item->creator($editor->requestor->id);
170 $item->create_date('now');
172 $logger->info("item-alter: new item ".OpenSRF::Utils::JSON->perl2JSON($item));
173 return $editor->event unless $editor->create_serial_item($item);
178 my ($editor, $override, $item) = @_;
180 $logger->info("item-alter: retrieving item ".$item->id);
181 my $orig_item = $editor->retrieve_serial_item($item->id);
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);
189 __PACKAGE__->register_method(
190 method => "fleshed_serial_item_retrieve_batch",
192 api_name => "open-ils.serial.item.fleshed.batch.retrieve"
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",
203 flesh_fields => {sitem => [ qw/issuance creator editor stream unit notes/ ], sstr => ["distribution"], sunit => ["call_number"], siss => [qw/creator editor subscription/]}
208 ##########################################################################
211 __PACKAGE__->register_method(
212 method => 'fleshed_issuance_alter',
213 api_name => 'open-ils.serial.issuance.fleshed.batch.update',
217 desc => 'Receives an array of one or more issuances and updates the database as needed',
220 desc => 'Authtoken for current user session',
225 desc => 'Array of fleshed issuances',
231 desc => 'Returns 1 if successful, event if failed',
237 sub fleshed_issuance_alter {
238 my( $self, $conn, $auth, $issuances ) = @_;
239 return 1 unless ref $issuances;
240 my( $reqr, $evt ) = $U->checkses($auth);
242 my $editor = new_editor(requestor => $reqr, xact => 1);
243 my $override = $self->api_name =~ /override/;
245 # TODO: permission support
246 # return $editor->event unless
247 # $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
249 for my $issuance (@$issuances) {
250 my $issuanceid = $issuance->id;
251 $issuance->editor($editor->requestor->id);
252 $issuance->edit_date('now');
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 );
260 _cleanse_dates($issuance, ['date_published']);
261 $evt = _update_siss( $editor, $override, $issuance );
266 $logger->info("fleshed issuance-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
270 $logger->debug("issuance-alter: done updating issuance batch");
272 $logger->info("fleshed issuance-alter successfully updated ".scalar(@$issuances)." issuances");
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);
284 my ($editor, $issuance) = @_;
286 $issuance->creator($editor->requestor->id);
287 $issuance->create_date('now');
289 $logger->info("issuance-alter: new issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
290 return $editor->event unless $editor->create_serial_issuance($issuance);
295 my ($editor, $override, $issuance) = @_;
297 $logger->info("issuance-alter: retrieving issuance ".$issuance->id);
298 my $orig_issuance = $editor->retrieve_serial_issuance($issuance->id);
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);
306 __PACKAGE__->register_method(
307 method => "fleshed_serial_issuance_retrieve_batch",
309 api_name => "open-ils.serial.issuance.fleshed.batch.retrieve"
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",
320 flesh_fields => {siss => [ qw/creator editor subscription/ ]}
324 __PACKAGE__->register_method(
325 method => "pub_fleshed_serial_issuance_retrieve_batch",
326 api_name => "open-ils.serial.issuance.pub_fleshed.batch.retrieve",
329 Public (i.e. OPAC) call for getting at the sub and
330 ultimately the record entry from an issuance
332 params => [{name => 'ids', desc => 'Array of IDs', type => 'array'}],
335 issuance objects, fleshed with subscriptions
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([
348 flesh_fields => {siss => [ qw/subscription/ ]}
353 sub received_siss_by_bib {
358 my $args = shift || {};
359 $$args{order} ||= 'asc';
361 my $e = new_editor();
362 my $issuances = $e->json_query({
363 select => {'siss' => [{"transform" => "distinct", "column" => "id"}, "date_published"]},
368 fkey => 'subscription'
373 $$args{ou} ? ( join => {
380 fkey => 'distribution'
389 $$args{type} ? ( 'holding_type' => $$args{type} ) : (),
390 '+ssub' => { record_entry => $bib },
392 # XXX should we also take specific item statuses into account?
393 date_received => { '!=' => undef },
394 $$args{status} ? ( 'status' => $$args{status} ) : ()
396 $$args{ou} ? ( '+sdist' => {
398 'in' => $U->get_org_descendants($$args{ou}, $$args{depth})
402 $$args{limit} ? ( limit => $$args{limit} ) : (),
403 $$args{offset} ? ( offset => $$args{offset} ) : (),
404 order_by => [{ class => 'siss', field => 'date_published', direction => $$args{order} }]
407 $client->respond($e->retrieve_serial_issuance($_->{id})) for @$issuances;
410 __PACKAGE__->register_method(
411 method => 'received_siss_by_bib',
412 api_name => 'open-ils.serial.received_siss.retrieve.by_bib',
417 desc => 'Receives a Bib ID and other optional params and returns "siss" (issuance) objects',
420 desc => 'id of the bre to which the issuances belong',
425 q/A hash of optional arguments. Valid keys and their meanings:
426 order := date_published sort direction, either "asc" (chronological, default) or "desc" (reverse chronological)
427 limit := Number of issuances to return. Useful for paging results, or finding the oldest or newest
428 offest := Number of issuance to skip before returning results. Useful for paging.
429 orgid := OU id used to scope retrieval, based on distribution.holding_lib
430 depth := OU depth used to range the scope of orgid
431 type := Holding type filter. Valid values are "basic", "supplement" and "index". Can be a scalar (one) or arrayref (one or more).
432 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).
440 ##########################################################################
443 __PACKAGE__->register_method(
444 method => 'fleshed_sunit_alter',
445 api_name => 'open-ils.serial.sunit.fleshed.batch.update',
449 desc => 'Receives an array of one or more Units and updates the database as needed',
452 desc => 'Authtoken for current user session',
457 desc => 'Array of fleshed Units',
463 desc => 'Returns 1 if successful, event if failed',
469 sub fleshed_sunit_alter {
470 my( $self, $conn, $auth, $sunits ) = @_;
471 return 1 unless ref $sunits;
472 my( $reqr, $evt ) = $U->checkses($auth);
474 my $editor = new_editor(requestor => $reqr, xact => 1);
475 my $override = $self->api_name =~ /override/;
477 # TODO: permission support
478 # return $editor->event unless
479 # $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
481 for my $sunit (@$sunits) {
482 if( $sunit->isdeleted ) {
483 $evt = _delete_sunit( $editor, $override, $sunit );
485 $sunit->default_location( $sunit->default_location->id ) if ref $sunit->default_location;
487 if( $sunit->isnew ) {
488 $evt = _create_sunit( $editor, $sunit );
490 $evt = _update_sunit( $editor, $override, $sunit );
496 $logger->info("fleshed sunit-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
500 $logger->debug("sunit-alter: done updating sunit batch");
502 $logger->info("fleshed sunit-alter successfully updated ".scalar(@$sunits)." Units");
507 my ($editor, $override, $sunit) = @_;
508 $logger->info("sunit-alter: delete sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
509 return $editor->event unless $editor->delete_serial_unit($sunit);
514 my ($editor, $sunit) = @_;
516 $logger->info("sunit-alter: new Unit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
517 return $editor->event unless $editor->create_serial_unit($sunit);
522 my ($editor, $override, $sunit) = @_;
524 $logger->info("sunit-alter: retrieving sunit ".$sunit->id);
525 my $orig_sunit = $editor->retrieve_serial_unit($sunit->id);
527 $logger->info("sunit-alter: original sunit ".OpenSRF::Utils::JSON->perl2JSON($orig_sunit));
528 $logger->info("sunit-alter: updated sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
529 return $editor->event unless $editor->update_serial_unit($sunit);
533 __PACKAGE__->register_method(
534 method => "retrieve_unit_list",
536 api_name => "open-ils.serial.unit_list.retrieve"
539 sub retrieve_unit_list {
541 my( $self, $client, @sdist_ids ) = @_;
543 if(ref($sdist_ids[0])) { @sdist_ids = @{$sdist_ids[0]}; }
545 my $e = new_editor();
549 { 'sunit' => [ 'id', 'summary_contents', 'sort_key' ],
550 'sitem' => ['stream'],
551 'sstr' => ['distribution'],
552 'sdist' => [{'column' => 'label', 'alias' => 'sdist_label'}]
559 { 'join' => { 'sunit' => {} } }
564 'distinct' => 'true',
565 'where' => { '+sdist' => {'id' => \@sdist_ids} },
566 'order_by' => [{'class' => 'sunit', 'field' => 'sort_key'}]
569 my $unit_list_entries = $e->json_query($query);
572 foreach my $entry (@$unit_list_entries) {
573 my $value = {'sunit' => $entry->{id}, 'sstr' => $entry->{stream}, 'sdist' => $entry->{distribution}};
574 my $label = $entry->{summary_contents};
575 if (length($label) > 100) {
576 $label = substr($label, 0, 100) . '...'; # limited space in dropdown / menu
578 $label = "[$entry->{sdist_label}/$entry->{stream} #$entry->{id}] " . $label;
579 push (@entries, [$label, OpenSRF::Utils::JSON->perl2JSON($value)]);
587 ##########################################################################
588 # predict and receive methods
590 __PACKAGE__->register_method(
591 method => 'make_predictions',
592 api_name => 'open-ils.serial.make_predictions',
596 desc => 'Receives an ssub id and populates the issuance and item tables',
599 desc => 'Serial Subscription ID',
606 sub make_predictions {
607 my ($self, $conn, $authtoken, $args) = @_;
609 my $editor = OpenILS::Utils::CStoreEditor->new();
610 my $ssub_id = $args->{ssub_id};
611 my $all_dists = $args->{all_dists};
612 my $mfhd = MFHD->new(MARC::Record->new());
614 my $ssub = $editor->retrieve_serial_subscription([$ssub_id]);
615 my $scaps = $editor->search_serial_caption_and_pattern({ subscription => $ssub_id, active => 't'});
616 my $sdists = $editor->search_serial_distribution( [{ subscription => $ssub->id }, { flesh => 1,
617 flesh_fields => {sdist => [ qw/ streams / ]}, $all_dists ? () : (limit => 1) }] ); #TODO: 'deleted' support?
620 my $total_streams = 0;
622 $total_streams += scalar(@{$_->streams});
624 if ($total_streams < 1) {
626 # XXX TODO new event type
627 return new OpenILS::Event(
628 "BAD_PARAMS", note =>
629 "There are no streams to direct items. Can't predict."
636 # XXX TODO new event type
637 return new OpenILS::Event(
638 "BAD_PARAMS", note =>
639 "There are no active caption-and-pattern objects associated " .
640 "with this subscription. Can't predict."
646 foreach my $scap (@$scaps) {
647 my $caption_field = _revive_caption($scap);
648 $caption_field->update('8' => $link_id);
649 $mfhd->append_fields($caption_field);
651 'caption' => $caption_field,
652 'scap_id' => $scap->id,
653 'num_to_predict' => $args->{num_to_predict},
654 'end_date' => defined $args->{end_date} ?
655 $_strp_date->parse_datetime($args->{end_date}) : undef
657 if ($args->{base_issuance}) { # predict from a given issuance
658 $options->{predict_from} = _revive_holding($args->{base_issuance}->holding_code, $caption_field, 1); # fresh MFHD Record, so we simply default to 1 for seqno
659 } else { # default to predicting from last published
660 my $last_published = $editor->search_serial_issuance([
661 {'caption_and_pattern' => $scap->id,
662 'subscription' => $ssub_id},
663 {limit => 1, order_by => { siss => "date_published DESC" }}]
665 if ($last_published->[0]) {
666 my $last_siss = $last_published->[0];
667 unless ($last_siss->holding_code) {
669 # XXX TODO new event type
670 return new OpenILS::Event(
671 "BAD_PARAMS", note =>
672 "Last issuance has no holding code. Can't predict."
675 $options->{predict_from} = _revive_holding($last_siss->holding_code, $caption_field, 1);
678 # XXX TODO make a new event type instead of hijacking this one
679 return new OpenILS::Event(
680 "BAD_PARAMS", note => "No issuance from which to predict!"
684 push( @predictions, _generate_issuance_values($mfhd, $options) );
689 foreach my $prediction (@predictions) {
690 my $issuance = new Fieldmapper::serial::issuance;
692 $issuance->label($prediction->{label});
693 $issuance->date_published($prediction->{date_published}->strftime('%F'));
694 $issuance->holding_code(OpenSRF::Utils::JSON->perl2JSON($prediction->{holding_code}));
695 $issuance->holding_type($prediction->{holding_type});
696 $issuance->caption_and_pattern($prediction->{caption_and_pattern});
697 $issuance->subscription($ssub->id);
698 push (@issuances, $issuance);
701 fleshed_issuance_alter($self, $conn, $authtoken, \@issuances); # FIXME: catch events
704 for (my $i = 0; $i < @issuances; $i++) {
705 my $date_expected = $predictions[$i]->{date_published}->add(seconds => interval_to_seconds($ssub->expected_date_offset))->strftime('%F');
706 my $issuance = $issuances[$i];
707 #$issuance->label(interval_to_seconds($ssub->expected_date_offset));
708 foreach my $sdist (@$sdists) {
709 my $streams = $sdist->streams;
710 foreach my $stream (@$streams) {
711 my $item = new Fieldmapper::serial::item;
713 $item->stream($stream->id);
714 $item->date_expected($date_expected);
715 $item->issuance($issuance->id);
716 push (@items, $item);
720 fleshed_item_alter($self, $conn, $authtoken, \@items); # FIXME: catch events
725 # _generate_issuance_values() is an initial attempt at a function which can be used
726 # to populate an issuance table with a list of predicted issues. It accepts
727 # a hash ref of options initially defined as:
728 # caption : the caption field to predict on
729 # num_to_predict : the number of issues you wish to predict
730 # last_rec_date : the date of the last received issue, to be used as an offset
731 # for predicting future issues
733 # The basic method is to first convert to a single holding if compressed, then
734 # increment the holding and save the resulting values to @issuances.
736 # returns @issuance_values, an array of hashrefs containing (formatted
737 # label, formatted chronology date, formatted estimated arrival date, and an
738 # array ref of holding subfields as (key, value, key, value ...)) (not a hash
739 # to protect order and possible duplicate keys), and a holding type.
741 sub _generate_issuance_values {
742 my ($mfhd, $options) = @_;
743 my $caption = $options->{caption};
744 my $scap_id = $options->{scap_id};
745 my $num_to_predict = $options->{num_to_predict};
746 my $end_date = $options->{end_date};
747 my $predict_from = $options->{predict_from}; # issuance to predict from
748 #my $last_rec_date = $options->{last_rec_date}; # expected or actual
750 # TODO: add support for predicting serials with no chronology by passing in
751 # a last_pub_date option?
754 # Only needed for 'real' MFHD records, not our temp records
755 # my $link_id = $caption->link_id;
756 # if(!$predict_from) {
757 # my $htag = $caption->tag;
758 # $htag =~ s/^85/86/;
759 # my @holdings = $mfhd->holdings($htag, $link_id);
760 # my $last_holding = $holdings[-1];
762 # #if ($last_holding->is_compressed) {
763 # # $last_holding->compressed_to_last; # convert to last in range
765 # $predict_from = $last_holding;
769 $predict_from->notes('public', []);
770 # add a note marker for system use (?)
771 $predict_from->notes('private', ['AUTOGEN']);
775 my @predictions = $mfhd->generate_predictions({'base_holding' => $predict_from, 'num_to_predict' => $num_to_predict, 'end_date' => $end_date});
776 foreach my $prediction (@predictions) {
777 $pub_date = $_strp_date->parse_datetime($prediction->chron_to_date);
782 label => $prediction->format,
783 date_published => $pub_date,
784 #date_expected => $date_expected->strftime('%F'),
785 holding_code => [$prediction->indicator(1),$prediction->indicator(2),$prediction->subfields_list],
786 holding_type => $MFHD_NAMES_BY_TAG{$caption->tag},
787 caption_and_pattern => $scap_id
792 return @issuance_values;
795 sub _revive_caption {
798 my $pattern_code = $scap->pattern_code;
801 my $pattern_parts = OpenSRF::Utils::JSON->JSON2perl($pattern_code);
802 unshift(@$pattern_parts, $MFHD_TAGS_BY_NAME{$scap->type});
803 my $pattern_field = new MARC::Field(@$pattern_parts);
805 # build MFHD::Caption
806 return new MFHD::Caption($pattern_field);
809 sub _revive_holding {
810 my $holding_code = shift;
811 my $caption_field = shift;
815 my $holding_parts = OpenSRF::Utils::JSON->JSON2perl($holding_code);
816 my $captag = $caption_field->tag;
817 $captag =~ s/^85/86/;
818 unshift(@$holding_parts, $captag);
819 my $holding_field = new MARC::Field(@$holding_parts);
821 # build MFHD::Holding
822 return new MFHD::Holding($seqno, $holding_field, $caption_field);
825 __PACKAGE__->register_method(
826 method => 'unitize_items',
827 api_name => 'open-ils.serial.receive_items',
831 desc => 'Marks an item as received, updates the shelving unit (creating a new shelving unit if needed), and updates the summaries',
834 desc => 'array of serial items',
839 desc => 'Returns number of received items',
846 my ($self, $conn, $auth, $items) = @_;
848 my( $reqr, $evt ) = $U->checkses($auth);
850 my $editor = new_editor(requestor => $reqr, xact => 1);
851 $self->api_name =~ /serial\.(\w*)_items/;
855 my %found_stream_ids;
858 my %stream_ids_by_unit_id;
861 my %sdist_by_unit_id;
862 my %sdist_by_stream_id;
864 my $new_unit_id; # id for '-2' units to share
865 foreach my $item (@$items) {
866 # for debugging only, TODO: delete
867 if (!ref $item) { # hopefully we got an id instead
868 $item = $editor->retrieve_serial_item($item);
871 my $unit_id = ref($item->unit) ? $item->unit->id : $item->unit;
872 my $stream_id = ref($item->stream) ? $item->stream->id : $item->stream;
873 my $issuance_id = ref($item->issuance) ? $item->issuance->id : $item->issuance;
874 #TODO: evt on any missing ids
876 if ($mode eq 'receive') {
877 $item->date_received('now');
878 $item->status('Received');
880 $item->status('Bindery');
883 # check for types to trigger summary updates
885 if (!ref $item->issuance) {
886 my $scaps = $editor->search_serial_caption_and_pattern([{"+siss" => {"id" => $issuance_id}}, { "join" => {"siss" => {}} }]);
888 } elsif (!ref $item->issuance->caption_and_pattern) {
889 $scap = $editor->retrieve_serial_caption_and_pattern($item->issuance->caption_and_pattern);
891 $scap = $editor->issuance->caption_and_pattern;
893 if (!exists($found_types{$stream_id})) {
894 $found_types{$stream_id} = {};
896 $found_types{$stream_id}->{$scap->type} = 1;
898 # create unit if needed
899 if ($unit_id == -1 or (!$new_unit_id and $unit_id == -2)) { # create unit per item
901 my $sdists = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
902 $unit = _build_unit($editor, $sdists->[0], $mode);
903 my $evt = _create_sunit($editor, $unit);
905 if ($unit_id == -2) {
906 $new_unit_id = $unit->id;
907 $unit_id = $new_unit_id;
909 $unit_id = $unit->id;
911 $item->unit($unit_id);
913 # get unit with 'DEFAULT's and save unit and sdist for later use
914 $unit = $editor->retrieve_serial_unit($unit->id);
915 $unit_map{$unit_id} = $unit;
916 $sdist_by_unit_id{$unit_id} = $sdists->[0];
917 $sdist_by_stream_id{$stream_id} = $sdists->[0];
918 } elsif ($unit_id == -2) { # create one unit for all '-2' items
919 $unit_id = $new_unit_id;
920 $item->unit($unit_id);
923 $found_unit_ids{$unit_id} = 1;
924 $found_stream_ids{$stream_id} = 1;
926 # save the stream_id for this unit_id
927 # TODO: prevent items from different streams in same unit? (perhaps in interface)
928 $stream_ids_by_unit_id{$unit_id} = $stream_id;
930 my $evt = _update_sitem($editor, undef, $item);
934 # deal with unit level labels
935 foreach my $unit_id (keys %found_unit_ids) {
937 # get all the needed issuances for unit
938 my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"unit" => $unit_id, "status" => "Received"}}, {"join" => {"sitem" => {}}, "order_by" => {"siss" => "date_published"}} ]);
939 #TODO: evt on search failure
941 my ($mfhd, $formatted_parts) = _summarize_contents($editor, $issuances);
943 # special case for single formatted_part (may have summarized version)
944 if (@$formatted_parts == 1) {
945 #TODO: MFHD.pm should have a 'format_summary' method for this
948 # retrieve and update unit contents
952 # if we just created the unit, we will already have it and the distribution stored
953 if (exists $unit_map{$unit_id}) {
954 $sunit = $unit_map{$unit_id};
955 $sdist = $sdist_by_unit_id{$unit_id};
957 $sunit = $editor->retrieve_serial_unit($unit_id);
958 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_ids_by_unit_id{$unit_id}}}, { "join" => {"sstr" => {}} }]);
959 $sdist = $sdist->[0];
962 $sunit->detailed_contents($sdist->unit_label_prefix . ' '
963 . join(', ', @$formatted_parts) . ' '
964 . $sdist->unit_label_suffix);
966 $sunit->summary_contents($sunit->detailed_contents); #TODO: change this when real summary contents are available
968 # create sort_key by left padding numbers to 6 digits
969 my $sort_key = $sunit->detailed_contents;
970 $sort_key =~ s/(\d+)/sprintf '%06d', $1/eg; # this may need improvement
971 $sunit->sort_key($sort_key);
973 if ($mode eq 'bind') {
974 $sunit->status(2); # set to 'Bindery' status
977 my $evt = _update_sunit($editor, undef, $sunit);
981 # TODO: cleanup 'dead' units (units which are now emptied of their items)
983 if ($mode eq 'receive') { # the summary holdings do not change when binding
984 # deal with stream level summaries
985 # summaries will be built from the "primary" stream only, that is, the stream with the lowest ID per distribution
986 # (TODO: consider direct designation)
987 my %primary_streams_by_sdist;
988 my %streams_by_sdist;
990 # see if we have primary streams, and if so, associate them with their distributions
991 foreach my $stream_id (keys %found_stream_ids) {
993 if (exists $sdist_by_stream_id{$stream_id}) {
994 $sdist = $sdist_by_stream_id{$stream_id};
996 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
997 $sdist = $sdist->[0];
1000 if (!exists($streams_by_sdist{$sdist->id})) {
1001 $streams = $editor->search_serial_stream([{"distribution" => $sdist->id}, {"order_by" => {"sstr" => "id"}}]);
1002 $streams_by_sdist{$sdist->id} = $streams;
1004 $streams = $streams_by_sdist{$sdist->id};
1006 $primary_streams_by_sdist{$sdist->id} = $streams->[0] if ($stream_id == $streams->[0]->id);
1009 # retrieve and update summaries for each affected primary stream's distribution
1010 foreach my $sdist_id (keys %primary_streams_by_sdist) {
1011 my $stream = $primary_streams_by_sdist{$sdist_id};
1012 my $stream_id = $stream->id;
1013 # get all the needed issuances for stream
1014 # FIXME: search in Bindery/Bound/Not Published? as well as Received
1015 foreach my $type (keys %{$found_types{$stream_id}}) {
1016 my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"stream" => $stream_id, "status" => "Received"}, "+scap" => {"type" => $type}}, {"join" => {"sitem" => {}, "scap" => {}}, "order_by" => {"siss" => "date_published"}} ]);
1017 #TODO: evt on search failure
1019 my ($mfhd, $formatted_parts) = _summarize_contents($editor, $issuances);
1021 # retrieve and update the generated_coverage of the summary
1022 my $search_method = "search_serial_${type}_summary";
1023 my $summary = $editor->$search_method([{"distribution" => $sdist_id}]);
1024 $summary = $summary->[0];
1025 $summary->generated_coverage(join(', ', @$formatted_parts));
1026 my $update_method = "update_serial_${type}_summary";
1027 return $editor->event unless $editor->$update_method($summary);
1033 return {'num_items_received' => scalar @$items, 'new_unit_id' => $new_unit_id};
1036 sub _find_or_create_call_number {
1037 my ($e, $lib, $cn_string, $record) = @_;
1039 my $existing = $e->search_asset_call_number({
1040 "owning_lib" => $lib,
1041 "label" => $cn_string,
1042 "record" => $record,
1044 }) or return $e->die_event;
1047 return $existing->[0]->id;
1049 return $e->die_event unless
1050 $e->allowed("CREATE_VOLUME", $lib);
1052 my $acn = new Fieldmapper::asset::call_number;
1054 $acn->creator($e->requestor->id);
1055 $acn->editor($e->requestor->id);
1056 $acn->record($record);
1057 $acn->label($cn_string);
1058 $acn->owning_lib($lib);
1060 $e->create_asset_call_number($acn) or return $e->die_event;
1061 return $e->data->id;
1065 sub _issuances_received {
1066 my ($e, $sitem) = @_;
1068 my $results = $e->json_query({
1071 {"transform" => "distinct", "column" => "issuance"}
1074 "from" => {"sitem" => {"sstr" => {}, "siss" => {}}},
1076 "+sstr" => {"distribution" => $sitem->stream->distribution->id},
1077 "+siss" => {"holding_type" => $sitem->issuance->holding_type},
1078 "+sitem" => {"date_received" => {"!=" => undef}}
1080 }) or return $e->die_event;
1082 return [ map { $e->retrieve_serial_issuance($_->{"issuance"}) } @$results ];
1085 # XXX _prepare_unit_label() duplicates some code from unitize_items().
1086 # Hopefully we can unify code paths down the road.
1087 sub _prepare_unit_label {
1088 my ($e, $sunit, $sdist, $issuance) = @_;
1090 my ($mfhd, $formatted_parts) = _summarize_contents($e, [$issuance]);
1092 # special case for single formatted_part (may have summarized version)
1093 if (@$formatted_parts == 1) {
1094 #TODO: MFHD.pm should have a 'format_summary' method for this
1097 $sunit->detailed_contents(
1100 $sdist->unit_label_prefix,
1101 join(", ", @$formatted_parts),
1102 $sdist->unit_label_suffix
1106 # TODO: change this when real summary contents are available
1107 $sunit->summary_contents($sunit->detailed_contents);
1109 # Create sort_key by left padding numbers to 6 digits.
1110 (my $sort_key = $sunit->detailed_contents) =~
1111 s/(\d+)/sprintf '%06d', $1/eg;
1112 $sunit->sort_key($sort_key);
1115 # XXX duplicates a block of code from unitize_items(). Once I fully understand
1116 # what's going on and I'm sure it's working right, I'd like to have
1117 # unitize_items() just use this, keeping the logic in one place.
1118 sub _prepare_summaries {
1119 my ($e, $sitem, $issuances) = @_;
1121 my $dist_id = $sitem->stream->distribution->id;
1122 my $type = $sitem->issuance->holding_type;
1124 # Make sure @$issuances contains the new issuance from sitem.
1125 unless (grep { $_->id == $sitem->issuance->id } @$issuances) {
1126 push @$issuances, $sitem->issuance;
1129 my ($mfhd, $formatted_parts) = _summarize_contents($e, $issuances);
1131 my $search_method = "search_serial_${type}_summary";
1132 my $summary = $e->$search_method([{"distribution" => $dist_id}]);
1134 my $cu_method = "update";
1137 $summary = $summary->[0];
1139 my $class = "Fieldmapper::serial::${type}_summary";
1140 $summary = $class->new;
1141 $summary->distribution($dist_id);
1142 $cu_method = "create";
1145 $summary->generated_coverage(join(", ", @$formatted_parts));
1146 my $method = "${cu_method}_serial_${type}_summary";
1147 return $e->die_event unless $e->$method($summary);
1150 __PACKAGE__->register_method(
1151 "method" => "receive_items_one_unit_per",
1152 "api_name" => "open-ils.serial.receive_items.one_unit_per",
1157 "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",
1161 "desc" => "authtoken",
1166 "desc" => "array of serial items, possibly fleshed with units and definitely fleshed with stream->distribution",
1171 "desc" => "id of bib record these items are associated with
1172 (XXX could/should be derived from items)",
1177 "desc" => "The item ID for each item successfully received",
1183 sub receive_items_one_unit_per {
1184 # XXX This function may be temporary, as it does some of what
1185 # unitize_items() does, just in a different way.
1186 my ($self, $client, $auth, $items, $record) = @_;
1188 my $e = new_editor("authtoken" => $auth, "xact" => 1);
1189 return $e->die_event unless $e->checkauth;
1191 my $user_id = $e->requestor->id;
1193 # Get a list of all the non-virtual field names in a serial::unit for
1194 # merging given unit objects with template-built units later.
1195 # XXX move this somewhere global so it isn't re-run all the time
1196 my $all_unit_fields =
1197 $Fieldmapper::fieldmap->{"Fieldmapper::serial::unit"}->{"fields"};
1198 my @real_unit_fields = grep {
1199 not $all_unit_fields->{$_}->{"virtual"}
1200 } keys %$all_unit_fields;
1202 foreach my $item (@$items) {
1203 # Note that we expect a certain fleshing on the items we're getting.
1204 my $sdist = $item->stream->distribution;
1206 # Create unit if given by user
1207 if (ref $item->unit) {
1208 # detach from the item, as we need to create separately
1209 my $user_unit = $item->unit;
1211 # get a unit based on associated template
1212 my $template_unit = _build_unit($e, $sdist, "receive", 1);
1213 if ($U->event_code($template_unit)) {
1215 $template_unit->{"note"} = "Item ID: " . $item->id;
1216 return $template_unit;
1219 # merge built unit with provided unit from user
1220 foreach (@real_unit_fields) {
1221 unless ($user_unit->$_) {
1222 $user_unit->$_($template_unit->$_);
1226 # Treat call number specially: the provided value from the
1227 # user will really be a string.
1228 if ($user_unit->call_number) {
1229 my $real_cn = _find_or_create_call_number(
1230 $e, $sdist->holding_lib->id,
1231 $user_unit->call_number, $record
1234 if ($U->event_code($real_cn)) {
1238 $user_unit->call_number($real_cn);
1242 my $evt = _prepare_unit_label(
1243 $e, $user_unit, $sdist, $item->issuance
1245 if ($U->event_code($evt)) {
1250 # fetch a list of issuances with received copies already existing
1251 # on this distribution.
1252 my $issuances = _issuances_received($e, $item); #XXX optimize later
1253 if ($U->event_code($issuances)) {
1258 # create/update summary objects related to this distribution
1259 $evt = _prepare_summaries($e, $item, $issuances);
1260 if ($U->event_code($evt)) {
1265 # set the incontrovertibles on the unit
1266 $user_unit->edit_date("now");
1267 $user_unit->create_date("now");
1268 $user_unit->editor($user_id);
1269 $user_unit->creator($user_id);
1271 return $e->die_event unless $e->create_serial_unit($user_unit);
1273 # save reference to new unit
1274 $item->unit($e->data->id);
1277 # Create notes if given by user
1278 if (ref($item->notes) and @{$item->notes}) {
1279 foreach my $note (@{$item->notes}) {
1280 $note->creator($user_id);
1281 $note->create_date("now");
1283 return $e->die_event unless $e->create_serial_item_note($note);
1286 $item->clear_notes; # They're saved; we no longer want them here.
1289 # Set the incontrovertibles on the item
1290 $item->status("Received");
1291 $item->date_received("now");
1292 $item->edit_date("now");
1293 $item->editor($user_id);
1295 return $e->die_event unless $e->update_serial_item($item);
1297 # send client a response
1298 $client->respond($item->id);
1301 $e->commit or return $e->die_event;
1309 my $skip_call_number = shift;
1311 my $attr = $mode . '_unit_template';
1312 my $template = $editor->retrieve_asset_copy_template($sdist->$attr) or
1313 return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_COPY_TEMPLATE");
1315 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 );
1317 my $unit = new Fieldmapper::serial::unit;
1318 foreach my $part (@parts) {
1319 my $value = $template->$part;
1320 next if !defined($value);
1321 $unit->$part($value);
1324 # ignore circ_lib in template, set to distribution holding_lib
1325 $unit->circ_lib($sdist->holding_lib);
1326 $unit->creator($editor->requestor->id);
1327 $unit->editor($editor->requestor->id);
1329 unless ($skip_call_number) {
1330 $attr = $mode . '_call_number';
1331 my $cn = $sdist->$attr or
1332 return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_CALL_NUMBER");
1334 $unit->call_number($cn);
1337 $unit->barcode('AUTO');
1338 $unit->sort_key('');
1339 $unit->summary_contents('');
1340 $unit->detailed_contents('');
1346 sub _summarize_contents {
1348 my $issuances = shift;
1350 # create MFHD record
1351 my $mfhd = MFHD->new(MARC::Record->new());
1354 my @scap_fields_ordered;
1357 foreach my $issuance (@$issuances) {
1358 my $scap_id = $issuance->caption_and_pattern;
1359 next if (!$scap_id); # skip issuances with no caption/pattern
1363 # if this is the first appearance of this scap, retrieve it and add it to the temporary record
1364 if (!exists $scaps{$issuance->caption_and_pattern}) {
1365 $scaps{$scap_id} = $editor->retrieve_serial_caption_and_pattern($scap_id);
1366 $scap = $scaps{$scap_id};
1367 $scap_field = _revive_caption($scap);
1368 $scap_fields{$scap_id} = $scap_field;
1369 push(@scap_fields_ordered, $scap_field);
1370 $scap_field->update('8' => $link_id);
1371 $mfhd->append_fields($scap_field);
1374 $scap = $scaps{$scap_id};
1375 $scap_field = $scap_fields{$scap_id};
1378 $mfhd->append_fields(_revive_holding($issuance->holding_code, $scap_field, $seqno));
1382 my @formatted_parts;
1383 foreach my $scap_field (@scap_fields_ordered) { #TODO: use generic MFHD "summarize" method, once available
1384 my @updated_holdings = $mfhd->get_compressed_holdings($scap_field);
1385 foreach my $holding (@updated_holdings) {
1386 push(@formatted_parts, $holding->format);
1390 return ($mfhd, \@formatted_parts);
1393 ##########################################################################
1396 __PACKAGE__->register_method(
1397 method => 'fetch_notes',
1398 api_name => 'open-ils.serial.item_note.retrieve.all',
1400 Returns an array of copy note objects.
1401 @param args A named hash of parameters including:
1402 authtoken : Required if viewing non-public notes
1403 item_id : The id of the item whose notes we want to retrieve
1404 pub : True if all the caller wants are public notes
1405 @return An array of note objects
1409 __PACKAGE__->register_method(
1410 method => 'fetch_notes',
1411 api_name => 'open-ils.serial.subscription_note.retrieve.all',
1413 Returns an array of copy note objects.
1414 @param args A named hash of parameters including:
1415 authtoken : Required if viewing non-public notes
1416 subscription_id : The id of the item whose notes we want to retrieve
1417 pub : True if all the caller wants are public notes
1418 @return An array of note objects
1422 __PACKAGE__->register_method(
1423 method => 'fetch_notes',
1424 api_name => 'open-ils.serial.distribution_note.retrieve.all',
1426 Returns an array of copy note objects.
1427 @param args A named hash of parameters including:
1428 authtoken : Required if viewing non-public notes
1429 distribution_id : The id of the item whose notes we want to retrieve
1430 pub : True if all the caller wants are public notes
1431 @return An array of note objects
1435 # TODO: revisit this method to consider replacing cstore direct calls
1437 my( $self, $connection, $args ) = @_;
1439 $self->api_name =~ /serial\.(\w*)_note/;
1442 my $id = $$args{object_id};
1443 my $authtoken = $$args{authtoken};
1447 return $U->cstorereq(
1448 'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic',
1449 { $type => $id, pub => 't' } );
1451 # FIXME: restore perm check
1452 # ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
1453 # return $evt if $evt;
1454 return $U->cstorereq(
1455 'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic', {$type => $id} );
1461 __PACKAGE__->register_method(
1462 method => 'create_note',
1463 api_name => 'open-ils.serial.item_note.create',
1465 Creates a new item note
1466 @param authtoken The login session key
1467 @param note The note object to create
1468 @return The id of the new note object
1472 __PACKAGE__->register_method(
1473 method => 'create_note',
1474 api_name => 'open-ils.serial.subscription_note.create',
1476 Creates a new subscription note
1477 @param authtoken The login session key
1478 @param note The note object to create
1479 @return The id of the new note object
1483 __PACKAGE__->register_method(
1484 method => 'create_note',
1485 api_name => 'open-ils.serial.distribution_note.create',
1487 Creates a new distribution note
1488 @param authtoken The login session key
1489 @param note The note object to create
1490 @return The id of the new note object
1495 my( $self, $connection, $authtoken, $note ) = @_;
1497 $self->api_name =~ /serial\.(\w*)_note/;
1500 my $e = new_editor(xact=>1, authtoken=>$authtoken);
1501 return $e->event unless $e->checkauth;
1503 # FIXME: restore permission support
1504 # my $item = $e->retrieve_serial_item(
1510 # return $e->event unless
1511 # $e->allowed('CREATE_COPY_NOTE', $item->call_number->owning_lib);
1513 $note->create_date('now');
1514 $note->creator($e->requestor->id);
1515 $note->pub( ($U->is_true($note->pub)) ? 't' : 'f' );
1518 my $method = "create_serial_${type}_note";
1519 $e->$method($note) or return $e->event;
1524 __PACKAGE__->register_method(
1525 method => 'delete_note',
1526 api_name => 'open-ils.serial.item_note.delete',
1528 Deletes an existing item note
1529 @param authtoken The login session key
1530 @param noteid The id of the note to delete
1531 @return 1 on success - Event otherwise.
1535 __PACKAGE__->register_method(
1536 method => 'delete_note',
1537 api_name => 'open-ils.serial.subscription_note.delete',
1539 Deletes an existing subscription note
1540 @param authtoken The login session key
1541 @param noteid The id of the note to delete
1542 @return 1 on success - Event otherwise.
1546 __PACKAGE__->register_method(
1547 method => 'delete_note',
1548 api_name => 'open-ils.serial.distribution_note.delete',
1550 Deletes an existing distribution note
1551 @param authtoken The login session key
1552 @param noteid The id of the note to delete
1553 @return 1 on success - Event otherwise.
1558 my( $self, $conn, $authtoken, $noteid ) = @_;
1560 $self->api_name =~ /serial\.(\w*)_note/;
1563 my $e = new_editor(xact=>1, authtoken=>$authtoken);
1564 return $e->die_event unless $e->checkauth;
1566 my $method = "retrieve_serial_${type}_note";
1567 my $note = $e->$method([
1569 ]) or return $e->die_event;
1571 # FIXME: restore permissions check
1572 # if( $note->creator ne $e->requestor->id ) {
1573 # return $e->die_event unless
1574 # $e->allowed('DELETE_COPY_NOTE', $note->item->call_number->owning_lib);
1577 $method = "delete_serial_${type}_note";
1578 $e->$method($note) or return $e->die_event;
1584 ##########################################################################
1585 # subscription methods
1587 __PACKAGE__->register_method(
1588 method => 'fleshed_ssub_alter',
1589 api_name => 'open-ils.serial.subscription.fleshed.batch.update',
1593 desc => 'Receives an array of one or more subscriptions and updates the database as needed',
1595 name => 'authtoken',
1596 desc => 'Authtoken for current user session',
1600 name => 'subscriptions',
1601 desc => 'Array of fleshed subscriptions',
1607 desc => 'Returns 1 if successful, event if failed',
1613 sub fleshed_ssub_alter {
1614 my( $self, $conn, $auth, $ssubs ) = @_;
1615 return 1 unless ref $ssubs;
1616 my( $reqr, $evt ) = $U->checkses($auth);
1617 return $evt if $evt;
1618 my $editor = new_editor(requestor => $reqr, xact => 1);
1619 my $override = $self->api_name =~ /override/;
1621 # TODO: permission check
1622 # return $editor->event unless
1623 # $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
1625 for my $ssub (@$ssubs) {
1627 my $ssubid = $ssub->id;
1629 if( $ssub->isdeleted ) {
1630 $evt = _delete_ssub( $editor, $override, $ssub);
1631 } elsif( $ssub->isnew ) {
1632 _cleanse_dates($ssub, ['start_date','end_date']);
1633 $evt = _create_ssub( $editor, $ssub );
1635 _cleanse_dates($ssub, ['start_date','end_date']);
1636 $evt = _update_ssub( $editor, $override, $ssub );
1641 $logger->info("fleshed subscription-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
1645 $logger->debug("subscription-alter: done updating subscription batch");
1647 $logger->info("fleshed subscription-alter successfully updated ".scalar(@$ssubs)." subscriptions");
1652 my ($editor, $override, $ssub) = @_;
1653 $logger->info("subscription-alter: delete subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1654 my $sdists = $editor->search_serial_distribution(
1655 { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1656 my $cps = $editor->search_serial_caption_and_pattern(
1657 { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1658 my $sisses = $editor->search_serial_issuance(
1659 { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1660 return OpenILS::Event->new(
1661 'SERIAL_SUBSCRIPTION_NOT_EMPTY', payload => $ssub->id ) if (@$sdists or @$cps or @$sisses);
1663 return $editor->event unless $editor->delete_serial_subscription($ssub);
1668 my ($editor, $ssub) = @_;
1670 $logger->info("subscription-alter: new subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1671 return $editor->event unless $editor->create_serial_subscription($ssub);
1676 my ($editor, $override, $ssub) = @_;
1678 $logger->info("subscription-alter: retrieving subscription ".$ssub->id);
1679 my $orig_ssub = $editor->retrieve_serial_subscription($ssub->id);
1681 $logger->info("subscription-alter: original subscription ".OpenSRF::Utils::JSON->perl2JSON($orig_ssub));
1682 $logger->info("subscription-alter: updated subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1683 return $editor->event unless $editor->update_serial_subscription($ssub);
1687 __PACKAGE__->register_method(
1688 method => "fleshed_serial_subscription_retrieve_batch",
1690 api_name => "open-ils.serial.subscription.fleshed.batch.retrieve"
1693 sub fleshed_serial_subscription_retrieve_batch {
1694 my( $self, $client, $ids ) = @_;
1695 # FIXME: permissions?
1696 $logger->info("Fetching fleshed subscriptions @$ids");
1697 return $U->cstorereq(
1698 "open-ils.cstore.direct.serial.subscription.search.atomic",
1701 flesh_fields => {ssub => [ qw/owning_lib notes/ ]}
1705 __PACKAGE__->register_method(
1706 method => "retrieve_sub_tree",
1708 api_name => "open-ils.serial.subscription_tree.retrieve"
1711 __PACKAGE__->register_method(
1712 method => "retrieve_sub_tree",
1713 api_name => "open-ils.serial.subscription_tree.global.retrieve"
1716 sub retrieve_sub_tree {
1718 my( $self, $client, $user_session, $docid, @org_ids ) = @_;
1720 if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
1724 # TODO: permission support
1725 if(!@org_ids and $user_session) {
1727 OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
1728 @org_ids = ($user_obj->home_ou);
1731 if( $self->api_name =~ /global/ ) {
1732 return _build_subs_list( { record_entry => $docid } ); # TODO: filter for !deleted, or active?
1737 for my $orgid (@org_ids) {
1738 my $subs = _build_subs_list(
1739 { record_entry => $docid, owning_lib => $orgid } );# TODO: filter for !deleted, or active?
1740 push( @all_subs, @$subs );
1749 sub _build_subs_list {
1750 my $search_hash = shift;
1752 #$search_hash->{deleted} = 'f';
1753 my $e = new_editor();
1755 my $subs = $e->search_serial_subscription([$search_hash, { 'order_by' => {'ssub' => 'id'} }]);
1759 for my $sub (@$subs) {
1761 # TODO: filter on !deleted?
1762 my $dists = $e->search_serial_distribution(
1763 [{ subscription => $sub->id }, { 'order_by' => {'sdist' => 'label'} }]
1766 #$dists = [ sort { $a->label cmp $b->label } @$dists ];
1768 $sub->distributions($dists);
1770 # TODO: filter on !deleted?
1771 my $issuances = $e->search_serial_issuance(
1772 [{ subscription => $sub->id }, { 'order_by' => {'siss' => 'label'} }]
1775 #$issuances = [ sort { $a->label cmp $b->label } @$issuances ];
1776 $sub->issuances($issuances);
1778 # TODO: filter on !deleted?
1779 my $scaps = $e->search_serial_caption_and_pattern(
1780 [{ subscription => $sub->id }, { 'order_by' => {'scap' => 'id'} }]
1783 #$scaps = [ sort { $a->id cmp $b->id } @$scaps ];
1784 $sub->scaps($scaps);
1785 push( @built_subs, $sub );
1788 return \@built_subs;
1792 __PACKAGE__->register_method(
1793 method => "subscription_orgs_for_title",
1795 api_name => "open-ils.serial.subscription.retrieve_orgs_by_title"
1798 sub subscription_orgs_for_title {
1799 my( $self, $client, $record_id ) = @_;
1801 my $subs = $U->simple_scalar_request(
1803 "open-ils.cstore.direct.serial.subscription.search.atomic",
1804 { record_entry => $record_id }); # TODO: filter on !deleted?
1806 my $orgs = { map {$_->owning_lib => 1 } @$subs };
1807 return [ keys %$orgs ];
1811 ##########################################################################
1812 # distribution methods
1814 __PACKAGE__->register_method(
1815 method => 'fleshed_sdist_alter',
1816 api_name => 'open-ils.serial.distribution.fleshed.batch.update',
1820 desc => 'Receives an array of one or more distributions and updates the database as needed',
1822 name => 'authtoken',
1823 desc => 'Authtoken for current user session',
1827 name => 'distributions',
1828 desc => 'Array of fleshed distributions',
1834 desc => 'Returns 1 if successful, event if failed',
1840 sub fleshed_sdist_alter {
1841 my( $self, $conn, $auth, $sdists ) = @_;
1842 return 1 unless ref $sdists;
1843 my( $reqr, $evt ) = $U->checkses($auth);
1844 return $evt if $evt;
1845 my $editor = new_editor(requestor => $reqr, xact => 1);
1846 my $override = $self->api_name =~ /override/;
1848 # TODO: permission check
1849 # return $editor->event unless
1850 # $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
1852 for my $sdist (@$sdists) {
1853 my $sdistid = $sdist->id;
1855 if( $sdist->isdeleted ) {
1856 $evt = _delete_sdist( $editor, $override, $sdist);
1857 } elsif( $sdist->isnew ) {
1858 $evt = _create_sdist( $editor, $sdist );
1860 $evt = _update_sdist( $editor, $override, $sdist );
1865 $logger->info("fleshed distribution-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
1869 $logger->debug("distribution-alter: done updating distribution batch");
1871 $logger->info("fleshed distribution-alter successfully updated ".scalar(@$sdists)." distributions");
1876 my ($editor, $override, $sdist) = @_;
1877 $logger->info("distribution-alter: delete distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1878 return $editor->event unless $editor->delete_serial_distribution($sdist);
1883 my ($editor, $sdist) = @_;
1885 $logger->info("distribution-alter: new distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1886 return $editor->event unless $editor->create_serial_distribution($sdist);
1888 # create summaries too
1889 my $summary = new Fieldmapper::serial::basic_summary;
1890 $summary->distribution($sdist->id);
1891 $summary->generated_coverage('');
1892 return $editor->event unless $editor->create_serial_basic_summary($summary);
1893 $summary = new Fieldmapper::serial::supplement_summary;
1894 $summary->distribution($sdist->id);
1895 $summary->generated_coverage('');
1896 return $editor->event unless $editor->create_serial_supplement_summary($summary);
1897 $summary = new Fieldmapper::serial::index_summary;
1898 $summary->distribution($sdist->id);
1899 $summary->generated_coverage('');
1900 return $editor->event unless $editor->create_serial_index_summary($summary);
1902 # create a starter stream (TODO: reconsider this)
1903 my $stream = new Fieldmapper::serial::stream;
1904 $stream->distribution($sdist->id);
1905 return $editor->event unless $editor->create_serial_stream($stream);
1911 my ($editor, $override, $sdist) = @_;
1913 $logger->info("distribution-alter: retrieving distribution ".$sdist->id);
1914 my $orig_sdist = $editor->retrieve_serial_distribution($sdist->id);
1916 $logger->info("distribution-alter: original distribution ".OpenSRF::Utils::JSON->perl2JSON($orig_sdist));
1917 $logger->info("distribution-alter: updated distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1918 return $editor->event unless $editor->update_serial_distribution($sdist);
1922 __PACKAGE__->register_method(
1923 method => "fleshed_serial_distribution_retrieve_batch",
1925 api_name => "open-ils.serial.distribution.fleshed.batch.retrieve"
1928 sub fleshed_serial_distribution_retrieve_batch {
1929 my( $self, $client, $ids ) = @_;
1930 # FIXME: permissions?
1931 $logger->info("Fetching fleshed distributions @$ids");
1932 return $U->cstorereq(
1933 "open-ils.cstore.direct.serial.distribution.search.atomic",
1936 flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams / ]}
1940 ##########################################################################
1941 # caption and pattern methods
1943 __PACKAGE__->register_method(
1944 method => 'scap_alter',
1945 api_name => 'open-ils.serial.caption_and_pattern.batch.update',
1949 desc => 'Receives an array of one or more caption and patterns and updates the database as needed',
1951 name => 'authtoken',
1952 desc => 'Authtoken for current user session',
1957 desc => 'Array of caption and patterns',
1963 desc => 'Returns 1 if successful, event if failed',
1970 my( $self, $conn, $auth, $scaps ) = @_;
1971 return 1 unless ref $scaps;
1972 my( $reqr, $evt ) = $U->checkses($auth);
1973 return $evt if $evt;
1974 my $editor = new_editor(requestor => $reqr, xact => 1);
1975 my $override = $self->api_name =~ /override/;
1977 # TODO: permission check
1978 # return $editor->event unless
1979 # $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
1981 for my $scap (@$scaps) {
1982 my $scapid = $scap->id;
1984 if( $scap->isdeleted ) {
1985 $evt = _delete_scap( $editor, $override, $scap);
1986 } elsif( $scap->isnew ) {
1987 $evt = _create_scap( $editor, $scap );
1989 $evt = _update_scap( $editor, $override, $scap );
1994 $logger->info("caption_and_pattern-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
1998 $logger->debug("caption_and_pattern-alter: done updating caption_and_pattern batch");
2000 $logger->info("caption_and_pattern-alter successfully updated ".scalar(@$scaps)." caption_and_patterns");
2005 my ($editor, $override, $scap) = @_;
2006 $logger->info("caption_and_pattern-alter: delete caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2007 my $sisses = $editor->search_serial_issuance(
2008 { caption_and_pattern => $scap->id }, { limit => 1 } ); #TODO: 'deleted' support?
2009 return OpenILS::Event->new(
2010 'SERIAL_CAPTION_AND_PATTERN_HAS_ISSUANCES', payload => $scap->id ) if (@$sisses);
2012 return $editor->event unless $editor->delete_serial_caption_and_pattern($scap);
2017 my ($editor, $scap) = @_;
2019 $logger->info("caption_and_pattern-alter: new caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2020 return $editor->event unless $editor->create_serial_caption_and_pattern($scap);
2025 my ($editor, $override, $scap) = @_;
2027 $logger->info("caption_and_pattern-alter: retrieving caption_and_pattern ".$scap->id);
2028 my $orig_scap = $editor->retrieve_serial_caption_and_pattern($scap->id);
2030 $logger->info("caption_and_pattern-alter: original caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($orig_scap));
2031 $logger->info("caption_and_pattern-alter: updated caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2032 return $editor->event unless $editor->update_serial_caption_and_pattern($scap);
2036 __PACKAGE__->register_method(
2037 method => "serial_caption_and_pattern_retrieve_batch",
2039 api_name => "open-ils.serial.caption_and_pattern.batch.retrieve"
2042 sub serial_caption_and_pattern_retrieve_batch {
2043 my( $self, $client, $ids ) = @_;
2044 $logger->info("Fetching caption_and_patterns @$ids");
2045 return $U->cstorereq(
2046 "open-ils.cstore.direct.serial.caption_and_pattern.search.atomic",
2051 __PACKAGE__->register_method(
2052 "method" => "bre_by_identifier",
2053 "api_name" => "open-ils.serial.biblio.record_entry.by_identifier",
2056 "desc" => "Find instances of biblio.record_entry given a search token" .
2057 " that could be a value for any identifier defined in " .
2058 "config.metabib_field",
2060 {"desc" => "Search token", "type" => "string"},
2061 {"desc" => "Options: require_subscriptions, add_mvr, is_actual_id" .
2062 " (all boolean)", "type" => "object"}
2065 "desc" => "Any matching BREs, or if the add_mvr option is true, " .
2066 "objects with a 'bre' key/value pair, and an 'mvr' " .
2067 "key-value pair. BREs have subscriptions fleshed on.",
2073 sub bre_by_identifier {
2074 my ($self, $client, $term, $options) = @_;
2076 return new OpenILS::Event("BAD_PARAMS") unless $term;
2079 my $e = new_editor();
2083 if ($options->{"is_actual_id"}) {
2087 $e->search_config_metabib_field({"field_class" => "identifier"})
2088 or return $e->die_event;
2090 my @identifiers = map { $_->name } @$cmf;
2091 my $query = join(" || ", map { "id|$_: $term" } @identifiers);
2093 my $search = create OpenSRF::AppSession("open-ils.search");
2094 my $search_result = $search->request(
2095 "open-ils.search.biblio.multiclass.query.staff", {}, $query
2097 $search->disconnect;
2099 # Un-nest results. They tend to look like [[1],[2],[3]] for some reason.
2100 @ids = map { @{$_} } @{$search_result->{"ids"}};
2108 my $bre = $e->search_biblio_record_entry([
2110 "flesh" => 2, "flesh_fields" => {
2111 "bre" => ["subscriptions"],
2112 "ssub" => ["owning_lib"]
2115 ]) or return $e->die_event;
2117 if (@$bre && $options->{"require_subscriptions"}) {
2118 $bre = [ grep { @{$_->subscriptions} } @$bre ];
2123 if (@$bre) { # re-evaluate after possible grep
2124 if ($options->{"add_mvr"}) {
2126 {"bre" => $_, "mvr" => _get_mvr($_->id)}
2129 $client->respond($_) foreach (@$bre);
2136 __PACKAGE__->register_method(
2137 "method" => "get_receivable_items",
2138 "api_name" => "open-ils.serial.items.receivable.by_subscription",
2141 "desc" => "Return all receivable items under a given subscription",
2143 {"desc" => "Authtoken", "type" => "string"},
2144 {"desc" => "Subscription ID", "type" => "number"},
2147 "desc" => "All receivable items under a given subscription",
2153 __PACKAGE__->register_method(
2154 "method" => "get_receivable_items",
2155 "api_name" => "open-ils.serial.items.receivable.by_issuance",
2158 "desc" => "Return all receivable items under a given issuance",
2160 {"desc" => "Authtoken", "type" => "string"},
2161 {"desc" => "Issuance ID", "type" => "number"},
2164 "desc" => "All receivable items under a given issuance",
2170 sub get_receivable_items {
2171 my ($self, $client, $auth, $term) = @_;
2173 my $e = new_editor("authtoken" => $auth);
2174 return $e->die_event unless $e->checkauth;
2178 my $by = ($self->api_name =~ /by_(\w+)$/)[0];
2181 "issuance" => {"issuance" => $term},
2182 "subscription" => {"+siss" => {"subscription" => $term}}
2185 my $item_ids = $e->json_query(
2187 "select" => {"sitem" => ["id"]},
2188 "from" => {"sitem" => "siss"},
2190 %{$where{$by}}, "date_received" => undef
2192 "order_by" => {"sitem" => ["id"]}
2194 ) or return $e->die_event;
2196 return undef unless @$item_ids;
2198 foreach (map { $_->{"id"} } @$item_ids) {
2200 $e->retrieve_serial_item([
2204 "sitem" => ["stream", "issuance"],
2205 "sstr" => ["distribution"],
2206 "sdist" => ["holding_lib"]
2217 __PACKAGE__->register_method(
2218 "method" => "get_receivable_issuances",
2219 "api_name" => "open-ils.serial.issuances.receivable",
2222 "desc" => "Return all issuances with receivable items given " .
2223 "a subscription ID",
2225 {"desc" => "Authtoken", "type" => "string"},
2226 {"desc" => "Subscription ID", "type" => "number"},
2229 "desc" => "All issuances with receivable items " .
2230 "(but not the items themselves)", "type" => "object"
2235 sub get_receivable_issuances {
2236 my ($self, $client, $auth, $sub_id) = @_;
2238 my $e = new_editor("authtoken" => $auth);
2239 return $e->die_event unless $e->checkauth;
2243 my $issuance_ids = $e->json_query({
2246 {"transform" => "distinct", "column" => "id"},
2250 "from" => {"siss" => "sitem"},
2252 "subscription" => $sub_id,
2253 "+sitem" => {"date_received" => undef}
2256 "siss" => {"date_published" => {"direction" => "asc"}}
2259 }) or return $e->die_event;
2261 $client->respond($e->retrieve_serial_issuance($_->{"id"}))
2262 foreach (@$issuance_ids);