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 sub scoped_bib_holdings_summary {
444 my $args = shift || {};
446 $args->{order} = 'asc';
448 my ($issuances) = $self->method_lookup('open-ils.serial.received_siss.retrieve.by_bib.atomic')->run( $bibid => $args );
450 # split into issuance type sets
451 my %type_blob = (basic => [], supplement => [], index => []);
452 push @{ $type_blob{ $_->holding_type } }, $_ for (@$issuances);
454 # generate a statement list for each type
456 for my $type ( keys %type_blob ) {
457 my ($mfhd,$list) = _summarize_contents(new_editor(), $type_blob{$type});
458 $statement_blob{$type} = $list;
461 return \%statement_blob;
463 __PACKAGE__->register_method(
464 method => 'scoped_bib_holdings_summary',
465 api_name => 'open-ils.serial.bib.summary_statements',
469 desc => 'Receives a Bib ID and other optional params and returns set of holdings statements',
472 desc => 'id of the bre to which the issuances belong',
477 q/A hash of optional arguments. Valid keys and their meanings:
478 orgid := OU id used to scope retrieval, based on distribution.holding_lib
479 depth := OU depth used to range the scope of orgid
480 type := Holding type filter. Valid values are "basic", "supplement" and "index". Can be a scalar (one) or arrayref (one or more).
481 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).
489 ##########################################################################
492 __PACKAGE__->register_method(
493 method => 'fleshed_sunit_alter',
494 api_name => 'open-ils.serial.sunit.fleshed.batch.update',
498 desc => 'Receives an array of one or more Units and updates the database as needed',
501 desc => 'Authtoken for current user session',
506 desc => 'Array of fleshed Units',
512 desc => 'Returns 1 if successful, event if failed',
518 sub fleshed_sunit_alter {
519 my( $self, $conn, $auth, $sunits ) = @_;
520 return 1 unless ref $sunits;
521 my( $reqr, $evt ) = $U->checkses($auth);
523 my $editor = new_editor(requestor => $reqr, xact => 1);
524 my $override = $self->api_name =~ /override/;
526 # TODO: permission support
527 # return $editor->event unless
528 # $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
530 for my $sunit (@$sunits) {
531 if( $sunit->isdeleted ) {
532 $evt = _delete_sunit( $editor, $override, $sunit );
534 $sunit->default_location( $sunit->default_location->id ) if ref $sunit->default_location;
536 if( $sunit->isnew ) {
537 $evt = _create_sunit( $editor, $sunit );
539 $evt = _update_sunit( $editor, $override, $sunit );
545 $logger->info("fleshed sunit-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
549 $logger->debug("sunit-alter: done updating sunit batch");
551 $logger->info("fleshed sunit-alter successfully updated ".scalar(@$sunits)." Units");
556 my ($editor, $override, $sunit) = @_;
557 $logger->info("sunit-alter: delete sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
558 return $editor->event unless $editor->delete_serial_unit($sunit);
563 my ($editor, $sunit) = @_;
565 $logger->info("sunit-alter: new Unit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
566 return $editor->event unless $editor->create_serial_unit($sunit);
571 my ($editor, $override, $sunit) = @_;
573 $logger->info("sunit-alter: retrieving sunit ".$sunit->id);
574 my $orig_sunit = $editor->retrieve_serial_unit($sunit->id);
576 $logger->info("sunit-alter: original sunit ".OpenSRF::Utils::JSON->perl2JSON($orig_sunit));
577 $logger->info("sunit-alter: updated sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
578 return $editor->event unless $editor->update_serial_unit($sunit);
582 __PACKAGE__->register_method(
583 method => "retrieve_unit_list",
585 api_name => "open-ils.serial.unit_list.retrieve"
588 sub retrieve_unit_list {
590 my( $self, $client, @sdist_ids ) = @_;
592 if(ref($sdist_ids[0])) { @sdist_ids = @{$sdist_ids[0]}; }
594 my $e = new_editor();
598 { 'sunit' => [ 'id', 'summary_contents', 'sort_key' ],
599 'sitem' => ['stream'],
600 'sstr' => ['distribution'],
601 'sdist' => [{'column' => 'label', 'alias' => 'sdist_label'}]
608 { 'join' => { 'sunit' => {} } }
613 'distinct' => 'true',
614 'where' => { '+sdist' => {'id' => \@sdist_ids} },
615 'order_by' => [{'class' => 'sunit', 'field' => 'sort_key'}]
618 my $unit_list_entries = $e->json_query($query);
621 foreach my $entry (@$unit_list_entries) {
622 my $value = {'sunit' => $entry->{id}, 'sstr' => $entry->{stream}, 'sdist' => $entry->{distribution}};
623 my $label = $entry->{summary_contents};
624 if (length($label) > 100) {
625 $label = substr($label, 0, 100) . '...'; # limited space in dropdown / menu
627 $label = "[$entry->{sdist_label}/$entry->{stream} #$entry->{id}] " . $label;
628 push (@entries, [$label, OpenSRF::Utils::JSON->perl2JSON($value)]);
636 ##########################################################################
637 # predict and receive methods
639 __PACKAGE__->register_method(
640 method => 'make_predictions',
641 api_name => 'open-ils.serial.make_predictions',
645 desc => 'Receives an ssub id and populates the issuance and item tables',
648 desc => 'Serial Subscription ID',
655 sub make_predictions {
656 my ($self, $conn, $authtoken, $args) = @_;
658 my $editor = OpenILS::Utils::CStoreEditor->new();
659 my $ssub_id = $args->{ssub_id};
660 my $all_dists = $args->{all_dists};
661 my $mfhd = MFHD->new(MARC::Record->new());
663 my $ssub = $editor->retrieve_serial_subscription([$ssub_id]);
664 my $scaps = $editor->search_serial_caption_and_pattern({ subscription => $ssub_id, active => 't'});
665 my $sdists = $editor->search_serial_distribution( [{ subscription => $ssub->id }, { flesh => 1,
666 flesh_fields => {sdist => [ qw/ streams / ]}, $all_dists ? () : (limit => 1) }] ); #TODO: 'deleted' support?
669 my $total_streams = 0;
671 $total_streams += scalar(@{$_->streams});
673 if ($total_streams < 1) {
675 # XXX TODO new event type
676 return new OpenILS::Event(
677 "BAD_PARAMS", note =>
678 "There are no streams to direct items. Can't predict."
685 # XXX TODO new event type
686 return new OpenILS::Event(
687 "BAD_PARAMS", note =>
688 "There are no active caption-and-pattern objects associated " .
689 "with this subscription. Can't predict."
695 foreach my $scap (@$scaps) {
696 my $caption_field = _revive_caption($scap);
697 $caption_field->update('8' => $link_id);
698 $mfhd->append_fields($caption_field);
700 'caption' => $caption_field,
701 'scap_id' => $scap->id,
702 'num_to_predict' => $args->{num_to_predict},
703 'end_date' => defined $args->{end_date} ?
704 $_strp_date->parse_datetime($args->{end_date}) : undef
706 if ($args->{base_issuance}) { # predict from a given issuance
707 $options->{predict_from} = _revive_holding($args->{base_issuance}->holding_code, $caption_field, 1); # fresh MFHD Record, so we simply default to 1 for seqno
708 } else { # default to predicting from last published
709 my $last_published = $editor->search_serial_issuance([
710 {'caption_and_pattern' => $scap->id,
711 'subscription' => $ssub_id},
712 {limit => 1, order_by => { siss => "date_published DESC" }}]
714 if ($last_published->[0]) {
715 my $last_siss = $last_published->[0];
716 unless ($last_siss->holding_code) {
718 # XXX TODO new event type
719 return new OpenILS::Event(
720 "BAD_PARAMS", note =>
721 "Last issuance has no holding code. Can't predict."
724 $options->{predict_from} = _revive_holding($last_siss->holding_code, $caption_field, 1);
727 # XXX TODO make a new event type instead of hijacking this one
728 return new OpenILS::Event(
729 "BAD_PARAMS", note => "No issuance from which to predict!"
733 push( @predictions, _generate_issuance_values($mfhd, $options) );
738 foreach my $prediction (@predictions) {
739 my $issuance = new Fieldmapper::serial::issuance;
741 $issuance->label($prediction->{label});
742 $issuance->date_published($prediction->{date_published}->strftime('%F'));
743 $issuance->holding_code(OpenSRF::Utils::JSON->perl2JSON($prediction->{holding_code}));
744 $issuance->holding_type($prediction->{holding_type});
745 $issuance->caption_and_pattern($prediction->{caption_and_pattern});
746 $issuance->subscription($ssub->id);
747 push (@issuances, $issuance);
750 fleshed_issuance_alter($self, $conn, $authtoken, \@issuances); # FIXME: catch events
753 for (my $i = 0; $i < @issuances; $i++) {
754 my $date_expected = $predictions[$i]->{date_published}->add(seconds => interval_to_seconds($ssub->expected_date_offset))->strftime('%F');
755 my $issuance = $issuances[$i];
756 #$issuance->label(interval_to_seconds($ssub->expected_date_offset));
757 foreach my $sdist (@$sdists) {
758 my $streams = $sdist->streams;
759 foreach my $stream (@$streams) {
760 my $item = new Fieldmapper::serial::item;
762 $item->stream($stream->id);
763 $item->date_expected($date_expected);
764 $item->issuance($issuance->id);
765 push (@items, $item);
769 fleshed_item_alter($self, $conn, $authtoken, \@items); # FIXME: catch events
774 # _generate_issuance_values() is an initial attempt at a function which can be used
775 # to populate an issuance table with a list of predicted issues. It accepts
776 # a hash ref of options initially defined as:
777 # caption : the caption field to predict on
778 # num_to_predict : the number of issues you wish to predict
779 # last_rec_date : the date of the last received issue, to be used as an offset
780 # for predicting future issues
782 # The basic method is to first convert to a single holding if compressed, then
783 # increment the holding and save the resulting values to @issuances.
785 # returns @issuance_values, an array of hashrefs containing (formatted
786 # label, formatted chronology date, formatted estimated arrival date, and an
787 # array ref of holding subfields as (key, value, key, value ...)) (not a hash
788 # to protect order and possible duplicate keys), and a holding type.
790 sub _generate_issuance_values {
791 my ($mfhd, $options) = @_;
792 my $caption = $options->{caption};
793 my $scap_id = $options->{scap_id};
794 my $num_to_predict = $options->{num_to_predict};
795 my $end_date = $options->{end_date};
796 my $predict_from = $options->{predict_from}; # issuance to predict from
797 #my $last_rec_date = $options->{last_rec_date}; # expected or actual
799 # TODO: add support for predicting serials with no chronology by passing in
800 # a last_pub_date option?
803 # Only needed for 'real' MFHD records, not our temp records
804 # my $link_id = $caption->link_id;
805 # if(!$predict_from) {
806 # my $htag = $caption->tag;
807 # $htag =~ s/^85/86/;
808 # my @holdings = $mfhd->holdings($htag, $link_id);
809 # my $last_holding = $holdings[-1];
811 # #if ($last_holding->is_compressed) {
812 # # $last_holding->compressed_to_last; # convert to last in range
814 # $predict_from = $last_holding;
818 $predict_from->notes('public', []);
819 # add a note marker for system use (?)
820 $predict_from->notes('private', ['AUTOGEN']);
824 my @predictions = $mfhd->generate_predictions({'base_holding' => $predict_from, 'num_to_predict' => $num_to_predict, 'end_date' => $end_date});
825 foreach my $prediction (@predictions) {
826 $pub_date = $_strp_date->parse_datetime($prediction->chron_to_date);
831 label => $prediction->format,
832 date_published => $pub_date,
833 #date_expected => $date_expected->strftime('%F'),
834 holding_code => [$prediction->indicator(1),$prediction->indicator(2),$prediction->subfields_list],
835 holding_type => $MFHD_NAMES_BY_TAG{$caption->tag},
836 caption_and_pattern => $scap_id
841 return @issuance_values;
844 sub _revive_caption {
847 my $pattern_code = $scap->pattern_code;
850 my $pattern_parts = OpenSRF::Utils::JSON->JSON2perl($pattern_code);
851 unshift(@$pattern_parts, $MFHD_TAGS_BY_NAME{$scap->type});
852 my $pattern_field = new MARC::Field(@$pattern_parts);
854 # build MFHD::Caption
855 return new MFHD::Caption($pattern_field);
858 sub _revive_holding {
859 my $holding_code = shift;
860 my $caption_field = shift;
864 my $holding_parts = OpenSRF::Utils::JSON->JSON2perl($holding_code);
865 my $captag = $caption_field->tag;
866 $captag =~ s/^85/86/;
867 unshift(@$holding_parts, $captag);
868 my $holding_field = new MARC::Field(@$holding_parts);
870 # build MFHD::Holding
871 return new MFHD::Holding($seqno, $holding_field, $caption_field);
874 __PACKAGE__->register_method(
875 method => 'unitize_items',
876 api_name => 'open-ils.serial.receive_items',
880 desc => 'Marks an item as received, updates the shelving unit (creating a new shelving unit if needed), and updates the summaries',
883 desc => 'array of serial items',
888 desc => 'Returns number of received items',
895 my ($self, $conn, $auth, $items) = @_;
897 my( $reqr, $evt ) = $U->checkses($auth);
899 my $editor = new_editor(requestor => $reqr, xact => 1);
900 $self->api_name =~ /serial\.(\w*)_items/;
904 my %found_stream_ids;
907 my %stream_ids_by_unit_id;
910 my %sdist_by_unit_id;
911 my %sdist_by_stream_id;
913 my $new_unit_id; # id for '-2' units to share
914 foreach my $item (@$items) {
915 # for debugging only, TODO: delete
916 if (!ref $item) { # hopefully we got an id instead
917 $item = $editor->retrieve_serial_item($item);
920 my $unit_id = ref($item->unit) ? $item->unit->id : $item->unit;
921 my $stream_id = ref($item->stream) ? $item->stream->id : $item->stream;
922 my $issuance_id = ref($item->issuance) ? $item->issuance->id : $item->issuance;
923 #TODO: evt on any missing ids
925 if ($mode eq 'receive') {
926 $item->date_received('now');
927 $item->status('Received');
929 $item->status('Bindery');
932 # check for types to trigger summary updates
934 if (!ref $item->issuance) {
935 my $scaps = $editor->search_serial_caption_and_pattern([{"+siss" => {"id" => $issuance_id}}, { "join" => {"siss" => {}} }]);
937 } elsif (!ref $item->issuance->caption_and_pattern) {
938 $scap = $editor->retrieve_serial_caption_and_pattern($item->issuance->caption_and_pattern);
940 $scap = $editor->issuance->caption_and_pattern;
942 if (!exists($found_types{$stream_id})) {
943 $found_types{$stream_id} = {};
945 $found_types{$stream_id}->{$scap->type} = 1;
947 # create unit if needed
948 if ($unit_id == -1 or (!$new_unit_id and $unit_id == -2)) { # create unit per item
950 my $sdists = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
951 $unit = _build_unit($editor, $sdists->[0], $mode);
952 my $evt = _create_sunit($editor, $unit);
954 if ($unit_id == -2) {
955 $new_unit_id = $unit->id;
956 $unit_id = $new_unit_id;
958 $unit_id = $unit->id;
960 $item->unit($unit_id);
962 # get unit with 'DEFAULT's and save unit and sdist for later use
963 $unit = $editor->retrieve_serial_unit($unit->id);
964 $unit_map{$unit_id} = $unit;
965 $sdist_by_unit_id{$unit_id} = $sdists->[0];
966 $sdist_by_stream_id{$stream_id} = $sdists->[0];
967 } elsif ($unit_id == -2) { # create one unit for all '-2' items
968 $unit_id = $new_unit_id;
969 $item->unit($unit_id);
972 $found_unit_ids{$unit_id} = 1;
973 $found_stream_ids{$stream_id} = 1;
975 # save the stream_id for this unit_id
976 # TODO: prevent items from different streams in same unit? (perhaps in interface)
977 $stream_ids_by_unit_id{$unit_id} = $stream_id;
979 my $evt = _update_sitem($editor, undef, $item);
983 # deal with unit level labels
984 foreach my $unit_id (keys %found_unit_ids) {
986 # get all the needed issuances for unit
987 my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"unit" => $unit_id, "status" => "Received"}}, {"join" => {"sitem" => {}}, "order_by" => {"siss" => "date_published"}} ]);
988 #TODO: evt on search failure
990 my ($mfhd, $formatted_parts) = _summarize_contents($editor, $issuances);
992 # special case for single formatted_part (may have summarized version)
993 if (@$formatted_parts == 1) {
994 #TODO: MFHD.pm should have a 'format_summary' method for this
997 # retrieve and update unit contents
1001 # if we just created the unit, we will already have it and the distribution stored
1002 if (exists $unit_map{$unit_id}) {
1003 $sunit = $unit_map{$unit_id};
1004 $sdist = $sdist_by_unit_id{$unit_id};
1006 $sunit = $editor->retrieve_serial_unit($unit_id);
1007 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_ids_by_unit_id{$unit_id}}}, { "join" => {"sstr" => {}} }]);
1008 $sdist = $sdist->[0];
1011 $sunit->detailed_contents($sdist->unit_label_prefix . ' '
1012 . join(', ', @$formatted_parts) . ' '
1013 . $sdist->unit_label_suffix);
1015 $sunit->summary_contents($sunit->detailed_contents); #TODO: change this when real summary contents are available
1017 # create sort_key by left padding numbers to 6 digits
1018 my $sort_key = $sunit->detailed_contents;
1019 $sort_key =~ s/(\d+)/sprintf '%06d', $1/eg; # this may need improvement
1020 $sunit->sort_key($sort_key);
1022 if ($mode eq 'bind') {
1023 $sunit->status(2); # set to 'Bindery' status
1026 my $evt = _update_sunit($editor, undef, $sunit);
1027 return $evt if $evt;
1030 # TODO: cleanup 'dead' units (units which are now emptied of their items)
1032 if ($mode eq 'receive') { # the summary holdings do not change when binding
1033 # deal with stream level summaries
1034 # summaries will be built from the "primary" stream only, that is, the stream with the lowest ID per distribution
1035 # (TODO: consider direct designation)
1036 my %primary_streams_by_sdist;
1037 my %streams_by_sdist;
1039 # see if we have primary streams, and if so, associate them with their distributions
1040 foreach my $stream_id (keys %found_stream_ids) {
1042 if (exists $sdist_by_stream_id{$stream_id}) {
1043 $sdist = $sdist_by_stream_id{$stream_id};
1045 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
1046 $sdist = $sdist->[0];
1049 if (!exists($streams_by_sdist{$sdist->id})) {
1050 $streams = $editor->search_serial_stream([{"distribution" => $sdist->id}, {"order_by" => {"sstr" => "id"}}]);
1051 $streams_by_sdist{$sdist->id} = $streams;
1053 $streams = $streams_by_sdist{$sdist->id};
1055 $primary_streams_by_sdist{$sdist->id} = $streams->[0] if ($stream_id == $streams->[0]->id);
1058 # retrieve and update summaries for each affected primary stream's distribution
1059 foreach my $sdist_id (keys %primary_streams_by_sdist) {
1060 my $stream = $primary_streams_by_sdist{$sdist_id};
1061 my $stream_id = $stream->id;
1062 # get all the needed issuances for stream
1063 # FIXME: search in Bindery/Bound/Not Published? as well as Received
1064 foreach my $type (keys %{$found_types{$stream_id}}) {
1065 my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"stream" => $stream_id, "status" => "Received"}, "+scap" => {"type" => $type}}, {"join" => {"sitem" => {}, "scap" => {}}, "order_by" => {"siss" => "date_published"}} ]);
1066 #TODO: evt on search failure
1068 my ($mfhd, $formatted_parts) = _summarize_contents($editor, $issuances);
1070 # retrieve and update the generated_coverage of the summary
1071 my $search_method = "search_serial_${type}_summary";
1072 my $summary = $editor->$search_method([{"distribution" => $sdist_id}]);
1073 $summary = $summary->[0];
1074 $summary->generated_coverage(join(', ', @$formatted_parts));
1075 my $update_method = "update_serial_${type}_summary";
1076 return $editor->event unless $editor->$update_method($summary);
1082 return {'num_items_received' => scalar @$items, 'new_unit_id' => $new_unit_id};
1085 sub _find_or_create_call_number {
1086 my ($e, $lib, $cn_string, $record) = @_;
1088 my $existing = $e->search_asset_call_number({
1089 "owning_lib" => $lib,
1090 "label" => $cn_string,
1091 "record" => $record,
1093 }) or return $e->die_event;
1096 return $existing->[0]->id;
1098 return $e->die_event unless
1099 $e->allowed("CREATE_VOLUME", $lib);
1101 my $acn = new Fieldmapper::asset::call_number;
1103 $acn->creator($e->requestor->id);
1104 $acn->editor($e->requestor->id);
1105 $acn->record($record);
1106 $acn->label($cn_string);
1107 $acn->owning_lib($lib);
1109 $e->create_asset_call_number($acn) or return $e->die_event;
1110 return $e->data->id;
1114 sub _issuances_received {
1115 my ($e, $sitem) = @_;
1117 my $results = $e->json_query({
1120 {"transform" => "distinct", "column" => "issuance"}
1123 "from" => {"sitem" => {"sstr" => {}, "siss" => {}}},
1125 "+sstr" => {"distribution" => $sitem->stream->distribution->id},
1126 "+siss" => {"holding_type" => $sitem->issuance->holding_type},
1127 "+sitem" => {"date_received" => {"!=" => undef}}
1129 }) or return $e->die_event;
1131 return [ map { $e->retrieve_serial_issuance($_->{"issuance"}) } @$results ];
1134 # XXX _prepare_unit_label() duplicates some code from unitize_items().
1135 # Hopefully we can unify code paths down the road.
1136 sub _prepare_unit_label {
1137 my ($e, $sunit, $sdist, $issuance) = @_;
1139 my ($mfhd, $formatted_parts) = _summarize_contents($e, [$issuance]);
1141 # special case for single formatted_part (may have summarized version)
1142 if (@$formatted_parts == 1) {
1143 #TODO: MFHD.pm should have a 'format_summary' method for this
1146 $sunit->detailed_contents(
1149 $sdist->unit_label_prefix,
1150 join(", ", @$formatted_parts),
1151 $sdist->unit_label_suffix
1155 # TODO: change this when real summary contents are available
1156 $sunit->summary_contents($sunit->detailed_contents);
1158 # Create sort_key by left padding numbers to 6 digits.
1159 (my $sort_key = $sunit->detailed_contents) =~
1160 s/(\d+)/sprintf '%06d', $1/eg;
1161 $sunit->sort_key($sort_key);
1164 # XXX duplicates a block of code from unitize_items(). Once I fully understand
1165 # what's going on and I'm sure it's working right, I'd like to have
1166 # unitize_items() just use this, keeping the logic in one place.
1167 sub _prepare_summaries {
1168 my ($e, $sitem, $issuances) = @_;
1170 my $dist_id = $sitem->stream->distribution->id;
1171 my $type = $sitem->issuance->holding_type;
1173 # Make sure @$issuances contains the new issuance from sitem.
1174 unless (grep { $_->id == $sitem->issuance->id } @$issuances) {
1175 push @$issuances, $sitem->issuance;
1178 my ($mfhd, $formatted_parts) = _summarize_contents($e, $issuances);
1180 my $search_method = "search_serial_${type}_summary";
1181 my $summary = $e->$search_method([{"distribution" => $dist_id}]);
1183 my $cu_method = "update";
1186 $summary = $summary->[0];
1188 my $class = "Fieldmapper::serial::${type}_summary";
1189 $summary = $class->new;
1190 $summary->distribution($dist_id);
1191 $cu_method = "create";
1194 $summary->generated_coverage(join(", ", @$formatted_parts));
1195 my $method = "${cu_method}_serial_${type}_summary";
1196 return $e->die_event unless $e->$method($summary);
1199 __PACKAGE__->register_method(
1200 "method" => "receive_items_one_unit_per",
1201 "api_name" => "open-ils.serial.receive_items.one_unit_per",
1206 "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",
1210 "desc" => "authtoken",
1215 "desc" => "array of serial items, possibly fleshed with units and definitely fleshed with stream->distribution",
1220 "desc" => "id of bib record these items are associated with
1221 (XXX could/should be derived from items)",
1226 "desc" => "The item ID for each item successfully received",
1232 sub receive_items_one_unit_per {
1233 # XXX This function may be temporary, as it does some of what
1234 # unitize_items() does, just in a different way.
1235 my ($self, $client, $auth, $items, $record) = @_;
1237 my $e = new_editor("authtoken" => $auth, "xact" => 1);
1238 return $e->die_event unless $e->checkauth;
1240 my $user_id = $e->requestor->id;
1242 # Get a list of all the non-virtual field names in a serial::unit for
1243 # merging given unit objects with template-built units later.
1244 # XXX move this somewhere global so it isn't re-run all the time
1245 my $all_unit_fields =
1246 $Fieldmapper::fieldmap->{"Fieldmapper::serial::unit"}->{"fields"};
1247 my @real_unit_fields = grep {
1248 not $all_unit_fields->{$_}->{"virtual"}
1249 } keys %$all_unit_fields;
1251 foreach my $item (@$items) {
1252 # Note that we expect a certain fleshing on the items we're getting.
1253 my $sdist = $item->stream->distribution;
1255 # Create unit if given by user
1256 if (ref $item->unit) {
1257 # detach from the item, as we need to create separately
1258 my $user_unit = $item->unit;
1260 # get a unit based on associated template
1261 my $template_unit = _build_unit($e, $sdist, "receive", 1);
1262 if ($U->event_code($template_unit)) {
1264 $template_unit->{"note"} = "Item ID: " . $item->id;
1265 return $template_unit;
1268 # merge built unit with provided unit from user
1269 foreach (@real_unit_fields) {
1270 unless ($user_unit->$_) {
1271 $user_unit->$_($template_unit->$_);
1275 # Treat call number specially: the provided value from the
1276 # user will really be a string.
1277 if ($user_unit->call_number) {
1278 my $real_cn = _find_or_create_call_number(
1279 $e, $sdist->holding_lib->id,
1280 $user_unit->call_number, $record
1283 if ($U->event_code($real_cn)) {
1287 $user_unit->call_number($real_cn);
1291 my $evt = _prepare_unit_label(
1292 $e, $user_unit, $sdist, $item->issuance
1294 if ($U->event_code($evt)) {
1299 # fetch a list of issuances with received copies already existing
1300 # on this distribution.
1301 my $issuances = _issuances_received($e, $item); #XXX optimize later
1302 if ($U->event_code($issuances)) {
1307 # create/update summary objects related to this distribution
1308 $evt = _prepare_summaries($e, $item, $issuances);
1309 if ($U->event_code($evt)) {
1314 # set the incontrovertibles on the unit
1315 $user_unit->edit_date("now");
1316 $user_unit->create_date("now");
1317 $user_unit->editor($user_id);
1318 $user_unit->creator($user_id);
1320 return $e->die_event unless $e->create_serial_unit($user_unit);
1322 # save reference to new unit
1323 $item->unit($e->data->id);
1326 # Create notes if given by user
1327 if (ref($item->notes) and @{$item->notes}) {
1328 foreach my $note (@{$item->notes}) {
1329 $note->creator($user_id);
1330 $note->create_date("now");
1332 return $e->die_event unless $e->create_serial_item_note($note);
1335 $item->clear_notes; # They're saved; we no longer want them here.
1338 # Set the incontrovertibles on the item
1339 $item->status("Received");
1340 $item->date_received("now");
1341 $item->edit_date("now");
1342 $item->editor($user_id);
1344 return $e->die_event unless $e->update_serial_item($item);
1346 # send client a response
1347 $client->respond($item->id);
1350 $e->commit or return $e->die_event;
1358 my $skip_call_number = shift;
1360 my $attr = $mode . '_unit_template';
1361 my $template = $editor->retrieve_asset_copy_template($sdist->$attr) or
1362 return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_COPY_TEMPLATE");
1364 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 );
1366 my $unit = new Fieldmapper::serial::unit;
1367 foreach my $part (@parts) {
1368 my $value = $template->$part;
1369 next if !defined($value);
1370 $unit->$part($value);
1373 # ignore circ_lib in template, set to distribution holding_lib
1374 $unit->circ_lib($sdist->holding_lib);
1375 $unit->creator($editor->requestor->id);
1376 $unit->editor($editor->requestor->id);
1378 unless ($skip_call_number) {
1379 $attr = $mode . '_call_number';
1380 my $cn = $sdist->$attr or
1381 return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_CALL_NUMBER");
1383 $unit->call_number($cn);
1386 $unit->barcode('AUTO');
1387 $unit->sort_key('');
1388 $unit->summary_contents('');
1389 $unit->detailed_contents('');
1395 sub _summarize_contents {
1397 my $issuances = shift;
1399 # create MFHD record
1400 my $mfhd = MFHD->new(MARC::Record->new());
1403 my @scap_fields_ordered;
1406 foreach my $issuance (@$issuances) {
1407 my $scap_id = $issuance->caption_and_pattern;
1408 next if (!$scap_id); # skip issuances with no caption/pattern
1412 # if this is the first appearance of this scap, retrieve it and add it to the temporary record
1413 if (!exists $scaps{$issuance->caption_and_pattern}) {
1414 $scaps{$scap_id} = $editor->retrieve_serial_caption_and_pattern($scap_id);
1415 $scap = $scaps{$scap_id};
1416 $scap_field = _revive_caption($scap);
1417 $scap_fields{$scap_id} = $scap_field;
1418 push(@scap_fields_ordered, $scap_field);
1419 $scap_field->update('8' => $link_id);
1420 $mfhd->append_fields($scap_field);
1423 $scap = $scaps{$scap_id};
1424 $scap_field = $scap_fields{$scap_id};
1427 $mfhd->append_fields(_revive_holding($issuance->holding_code, $scap_field, $seqno));
1431 my @formatted_parts;
1432 foreach my $scap_field (@scap_fields_ordered) { #TODO: use generic MFHD "summarize" method, once available
1433 my @updated_holdings = $mfhd->get_compressed_holdings($scap_field);
1434 foreach my $holding (@updated_holdings) {
1435 push(@formatted_parts, $holding->format);
1439 return ($mfhd, \@formatted_parts);
1442 ##########################################################################
1445 __PACKAGE__->register_method(
1446 method => 'fetch_notes',
1447 api_name => 'open-ils.serial.item_note.retrieve.all',
1449 Returns an array of copy note objects.
1450 @param args A named hash of parameters including:
1451 authtoken : Required if viewing non-public notes
1452 item_id : The id of the item whose notes we want to retrieve
1453 pub : True if all the caller wants are public notes
1454 @return An array of note objects
1458 __PACKAGE__->register_method(
1459 method => 'fetch_notes',
1460 api_name => 'open-ils.serial.subscription_note.retrieve.all',
1462 Returns an array of copy note objects.
1463 @param args A named hash of parameters including:
1464 authtoken : Required if viewing non-public notes
1465 subscription_id : The id of the item whose notes we want to retrieve
1466 pub : True if all the caller wants are public notes
1467 @return An array of note objects
1471 __PACKAGE__->register_method(
1472 method => 'fetch_notes',
1473 api_name => 'open-ils.serial.distribution_note.retrieve.all',
1475 Returns an array of copy note objects.
1476 @param args A named hash of parameters including:
1477 authtoken : Required if viewing non-public notes
1478 distribution_id : The id of the item whose notes we want to retrieve
1479 pub : True if all the caller wants are public notes
1480 @return An array of note objects
1484 # TODO: revisit this method to consider replacing cstore direct calls
1486 my( $self, $connection, $args ) = @_;
1488 $self->api_name =~ /serial\.(\w*)_note/;
1491 my $id = $$args{object_id};
1492 my $authtoken = $$args{authtoken};
1496 return $U->cstorereq(
1497 'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic',
1498 { $type => $id, pub => 't' } );
1500 # FIXME: restore perm check
1501 # ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
1502 # return $evt if $evt;
1503 return $U->cstorereq(
1504 'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic', {$type => $id} );
1510 __PACKAGE__->register_method(
1511 method => 'create_note',
1512 api_name => 'open-ils.serial.item_note.create',
1514 Creates a new item note
1515 @param authtoken The login session key
1516 @param note The note object to create
1517 @return The id of the new note object
1521 __PACKAGE__->register_method(
1522 method => 'create_note',
1523 api_name => 'open-ils.serial.subscription_note.create',
1525 Creates a new subscription note
1526 @param authtoken The login session key
1527 @param note The note object to create
1528 @return The id of the new note object
1532 __PACKAGE__->register_method(
1533 method => 'create_note',
1534 api_name => 'open-ils.serial.distribution_note.create',
1536 Creates a new distribution note
1537 @param authtoken The login session key
1538 @param note The note object to create
1539 @return The id of the new note object
1544 my( $self, $connection, $authtoken, $note ) = @_;
1546 $self->api_name =~ /serial\.(\w*)_note/;
1549 my $e = new_editor(xact=>1, authtoken=>$authtoken);
1550 return $e->event unless $e->checkauth;
1552 # FIXME: restore permission support
1553 # my $item = $e->retrieve_serial_item(
1559 # return $e->event unless
1560 # $e->allowed('CREATE_COPY_NOTE', $item->call_number->owning_lib);
1562 $note->create_date('now');
1563 $note->creator($e->requestor->id);
1564 $note->pub( ($U->is_true($note->pub)) ? 't' : 'f' );
1567 my $method = "create_serial_${type}_note";
1568 $e->$method($note) or return $e->event;
1573 __PACKAGE__->register_method(
1574 method => 'delete_note',
1575 api_name => 'open-ils.serial.item_note.delete',
1577 Deletes an existing item note
1578 @param authtoken The login session key
1579 @param noteid The id of the note to delete
1580 @return 1 on success - Event otherwise.
1584 __PACKAGE__->register_method(
1585 method => 'delete_note',
1586 api_name => 'open-ils.serial.subscription_note.delete',
1588 Deletes an existing subscription note
1589 @param authtoken The login session key
1590 @param noteid The id of the note to delete
1591 @return 1 on success - Event otherwise.
1595 __PACKAGE__->register_method(
1596 method => 'delete_note',
1597 api_name => 'open-ils.serial.distribution_note.delete',
1599 Deletes an existing distribution note
1600 @param authtoken The login session key
1601 @param noteid The id of the note to delete
1602 @return 1 on success - Event otherwise.
1607 my( $self, $conn, $authtoken, $noteid ) = @_;
1609 $self->api_name =~ /serial\.(\w*)_note/;
1612 my $e = new_editor(xact=>1, authtoken=>$authtoken);
1613 return $e->die_event unless $e->checkauth;
1615 my $method = "retrieve_serial_${type}_note";
1616 my $note = $e->$method([
1618 ]) or return $e->die_event;
1620 # FIXME: restore permissions check
1621 # if( $note->creator ne $e->requestor->id ) {
1622 # return $e->die_event unless
1623 # $e->allowed('DELETE_COPY_NOTE', $note->item->call_number->owning_lib);
1626 $method = "delete_serial_${type}_note";
1627 $e->$method($note) or return $e->die_event;
1633 ##########################################################################
1634 # subscription methods
1636 __PACKAGE__->register_method(
1637 method => 'fleshed_ssub_alter',
1638 api_name => 'open-ils.serial.subscription.fleshed.batch.update',
1642 desc => 'Receives an array of one or more subscriptions and updates the database as needed',
1644 name => 'authtoken',
1645 desc => 'Authtoken for current user session',
1649 name => 'subscriptions',
1650 desc => 'Array of fleshed subscriptions',
1656 desc => 'Returns 1 if successful, event if failed',
1662 sub fleshed_ssub_alter {
1663 my( $self, $conn, $auth, $ssubs ) = @_;
1664 return 1 unless ref $ssubs;
1665 my( $reqr, $evt ) = $U->checkses($auth);
1666 return $evt if $evt;
1667 my $editor = new_editor(requestor => $reqr, xact => 1);
1668 my $override = $self->api_name =~ /override/;
1670 # TODO: permission check
1671 # return $editor->event unless
1672 # $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
1674 for my $ssub (@$ssubs) {
1676 my $ssubid = $ssub->id;
1678 if( $ssub->isdeleted ) {
1679 $evt = _delete_ssub( $editor, $override, $ssub);
1680 } elsif( $ssub->isnew ) {
1681 _cleanse_dates($ssub, ['start_date','end_date']);
1682 $evt = _create_ssub( $editor, $ssub );
1684 _cleanse_dates($ssub, ['start_date','end_date']);
1685 $evt = _update_ssub( $editor, $override, $ssub );
1690 $logger->info("fleshed subscription-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
1694 $logger->debug("subscription-alter: done updating subscription batch");
1696 $logger->info("fleshed subscription-alter successfully updated ".scalar(@$ssubs)." subscriptions");
1701 my ($editor, $override, $ssub) = @_;
1702 $logger->info("subscription-alter: delete subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1703 my $sdists = $editor->search_serial_distribution(
1704 { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1705 my $cps = $editor->search_serial_caption_and_pattern(
1706 { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1707 my $sisses = $editor->search_serial_issuance(
1708 { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1709 return OpenILS::Event->new(
1710 'SERIAL_SUBSCRIPTION_NOT_EMPTY', payload => $ssub->id ) if (@$sdists or @$cps or @$sisses);
1712 return $editor->event unless $editor->delete_serial_subscription($ssub);
1717 my ($editor, $ssub) = @_;
1719 $logger->info("subscription-alter: new subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1720 return $editor->event unless $editor->create_serial_subscription($ssub);
1725 my ($editor, $override, $ssub) = @_;
1727 $logger->info("subscription-alter: retrieving subscription ".$ssub->id);
1728 my $orig_ssub = $editor->retrieve_serial_subscription($ssub->id);
1730 $logger->info("subscription-alter: original subscription ".OpenSRF::Utils::JSON->perl2JSON($orig_ssub));
1731 $logger->info("subscription-alter: updated subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1732 return $editor->event unless $editor->update_serial_subscription($ssub);
1736 __PACKAGE__->register_method(
1737 method => "fleshed_serial_subscription_retrieve_batch",
1739 api_name => "open-ils.serial.subscription.fleshed.batch.retrieve"
1742 sub fleshed_serial_subscription_retrieve_batch {
1743 my( $self, $client, $ids ) = @_;
1744 # FIXME: permissions?
1745 $logger->info("Fetching fleshed subscriptions @$ids");
1746 return $U->cstorereq(
1747 "open-ils.cstore.direct.serial.subscription.search.atomic",
1750 flesh_fields => {ssub => [ qw/owning_lib notes/ ]}
1754 __PACKAGE__->register_method(
1755 method => "retrieve_sub_tree",
1757 api_name => "open-ils.serial.subscription_tree.retrieve"
1760 __PACKAGE__->register_method(
1761 method => "retrieve_sub_tree",
1762 api_name => "open-ils.serial.subscription_tree.global.retrieve"
1765 sub retrieve_sub_tree {
1767 my( $self, $client, $user_session, $docid, @org_ids ) = @_;
1769 if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
1773 # TODO: permission support
1774 if(!@org_ids and $user_session) {
1776 OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
1777 @org_ids = ($user_obj->home_ou);
1780 if( $self->api_name =~ /global/ ) {
1781 return _build_subs_list( { record_entry => $docid } ); # TODO: filter for !deleted, or active?
1786 for my $orgid (@org_ids) {
1787 my $subs = _build_subs_list(
1788 { record_entry => $docid, owning_lib => $orgid } );# TODO: filter for !deleted, or active?
1789 push( @all_subs, @$subs );
1798 sub _build_subs_list {
1799 my $search_hash = shift;
1801 #$search_hash->{deleted} = 'f';
1802 my $e = new_editor();
1804 my $subs = $e->search_serial_subscription([$search_hash, { 'order_by' => {'ssub' => 'id'} }]);
1808 for my $sub (@$subs) {
1810 # TODO: filter on !deleted?
1811 my $dists = $e->search_serial_distribution(
1812 [{ subscription => $sub->id }, { 'order_by' => {'sdist' => 'label'} }]
1815 #$dists = [ sort { $a->label cmp $b->label } @$dists ];
1817 $sub->distributions($dists);
1819 # TODO: filter on !deleted?
1820 my $issuances = $e->search_serial_issuance(
1821 [{ subscription => $sub->id }, { 'order_by' => {'siss' => 'label'} }]
1824 #$issuances = [ sort { $a->label cmp $b->label } @$issuances ];
1825 $sub->issuances($issuances);
1827 # TODO: filter on !deleted?
1828 my $scaps = $e->search_serial_caption_and_pattern(
1829 [{ subscription => $sub->id }, { 'order_by' => {'scap' => 'id'} }]
1832 #$scaps = [ sort { $a->id cmp $b->id } @$scaps ];
1833 $sub->scaps($scaps);
1834 push( @built_subs, $sub );
1837 return \@built_subs;
1841 __PACKAGE__->register_method(
1842 method => "subscription_orgs_for_title",
1844 api_name => "open-ils.serial.subscription.retrieve_orgs_by_title"
1847 sub subscription_orgs_for_title {
1848 my( $self, $client, $record_id ) = @_;
1850 my $subs = $U->simple_scalar_request(
1852 "open-ils.cstore.direct.serial.subscription.search.atomic",
1853 { record_entry => $record_id }); # TODO: filter on !deleted?
1855 my $orgs = { map {$_->owning_lib => 1 } @$subs };
1856 return [ keys %$orgs ];
1860 ##########################################################################
1861 # distribution methods
1863 __PACKAGE__->register_method(
1864 method => 'fleshed_sdist_alter',
1865 api_name => 'open-ils.serial.distribution.fleshed.batch.update',
1869 desc => 'Receives an array of one or more distributions and updates the database as needed',
1871 name => 'authtoken',
1872 desc => 'Authtoken for current user session',
1876 name => 'distributions',
1877 desc => 'Array of fleshed distributions',
1883 desc => 'Returns 1 if successful, event if failed',
1889 sub fleshed_sdist_alter {
1890 my( $self, $conn, $auth, $sdists ) = @_;
1891 return 1 unless ref $sdists;
1892 my( $reqr, $evt ) = $U->checkses($auth);
1893 return $evt if $evt;
1894 my $editor = new_editor(requestor => $reqr, xact => 1);
1895 my $override = $self->api_name =~ /override/;
1897 # TODO: permission check
1898 # return $editor->event unless
1899 # $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
1901 for my $sdist (@$sdists) {
1902 my $sdistid = $sdist->id;
1904 if( $sdist->isdeleted ) {
1905 $evt = _delete_sdist( $editor, $override, $sdist);
1906 } elsif( $sdist->isnew ) {
1907 $evt = _create_sdist( $editor, $sdist );
1909 $evt = _update_sdist( $editor, $override, $sdist );
1914 $logger->info("fleshed distribution-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
1918 $logger->debug("distribution-alter: done updating distribution batch");
1920 $logger->info("fleshed distribution-alter successfully updated ".scalar(@$sdists)." distributions");
1925 my ($editor, $override, $sdist) = @_;
1926 $logger->info("distribution-alter: delete distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1927 return $editor->event unless $editor->delete_serial_distribution($sdist);
1932 my ($editor, $sdist) = @_;
1934 $logger->info("distribution-alter: new distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1935 return $editor->event unless $editor->create_serial_distribution($sdist);
1937 # create summaries too
1938 my $summary = new Fieldmapper::serial::basic_summary;
1939 $summary->distribution($sdist->id);
1940 $summary->generated_coverage('');
1941 return $editor->event unless $editor->create_serial_basic_summary($summary);
1942 $summary = new Fieldmapper::serial::supplement_summary;
1943 $summary->distribution($sdist->id);
1944 $summary->generated_coverage('');
1945 return $editor->event unless $editor->create_serial_supplement_summary($summary);
1946 $summary = new Fieldmapper::serial::index_summary;
1947 $summary->distribution($sdist->id);
1948 $summary->generated_coverage('');
1949 return $editor->event unless $editor->create_serial_index_summary($summary);
1951 # create a starter stream (TODO: reconsider this)
1952 my $stream = new Fieldmapper::serial::stream;
1953 $stream->distribution($sdist->id);
1954 return $editor->event unless $editor->create_serial_stream($stream);
1960 my ($editor, $override, $sdist) = @_;
1962 $logger->info("distribution-alter: retrieving distribution ".$sdist->id);
1963 my $orig_sdist = $editor->retrieve_serial_distribution($sdist->id);
1965 $logger->info("distribution-alter: original distribution ".OpenSRF::Utils::JSON->perl2JSON($orig_sdist));
1966 $logger->info("distribution-alter: updated distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1967 return $editor->event unless $editor->update_serial_distribution($sdist);
1971 __PACKAGE__->register_method(
1972 method => "fleshed_serial_distribution_retrieve_batch",
1974 api_name => "open-ils.serial.distribution.fleshed.batch.retrieve"
1977 sub fleshed_serial_distribution_retrieve_batch {
1978 my( $self, $client, $ids ) = @_;
1979 # FIXME: permissions?
1980 $logger->info("Fetching fleshed distributions @$ids");
1981 return $U->cstorereq(
1982 "open-ils.cstore.direct.serial.distribution.search.atomic",
1985 flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams / ]}
1989 ##########################################################################
1990 # caption and pattern methods
1992 __PACKAGE__->register_method(
1993 method => 'scap_alter',
1994 api_name => 'open-ils.serial.caption_and_pattern.batch.update',
1998 desc => 'Receives an array of one or more caption and patterns and updates the database as needed',
2000 name => 'authtoken',
2001 desc => 'Authtoken for current user session',
2006 desc => 'Array of caption and patterns',
2012 desc => 'Returns 1 if successful, event if failed',
2019 my( $self, $conn, $auth, $scaps ) = @_;
2020 return 1 unless ref $scaps;
2021 my( $reqr, $evt ) = $U->checkses($auth);
2022 return $evt if $evt;
2023 my $editor = new_editor(requestor => $reqr, xact => 1);
2024 my $override = $self->api_name =~ /override/;
2026 # TODO: permission check
2027 # return $editor->event unless
2028 # $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
2030 for my $scap (@$scaps) {
2031 my $scapid = $scap->id;
2033 if( $scap->isdeleted ) {
2034 $evt = _delete_scap( $editor, $override, $scap);
2035 } elsif( $scap->isnew ) {
2036 $evt = _create_scap( $editor, $scap );
2038 $evt = _update_scap( $editor, $override, $scap );
2043 $logger->info("caption_and_pattern-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2047 $logger->debug("caption_and_pattern-alter: done updating caption_and_pattern batch");
2049 $logger->info("caption_and_pattern-alter successfully updated ".scalar(@$scaps)." caption_and_patterns");
2054 my ($editor, $override, $scap) = @_;
2055 $logger->info("caption_and_pattern-alter: delete caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2056 my $sisses = $editor->search_serial_issuance(
2057 { caption_and_pattern => $scap->id }, { limit => 1 } ); #TODO: 'deleted' support?
2058 return OpenILS::Event->new(
2059 'SERIAL_CAPTION_AND_PATTERN_HAS_ISSUANCES', payload => $scap->id ) if (@$sisses);
2061 return $editor->event unless $editor->delete_serial_caption_and_pattern($scap);
2066 my ($editor, $scap) = @_;
2068 $logger->info("caption_and_pattern-alter: new caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2069 return $editor->event unless $editor->create_serial_caption_and_pattern($scap);
2074 my ($editor, $override, $scap) = @_;
2076 $logger->info("caption_and_pattern-alter: retrieving caption_and_pattern ".$scap->id);
2077 my $orig_scap = $editor->retrieve_serial_caption_and_pattern($scap->id);
2079 $logger->info("caption_and_pattern-alter: original caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($orig_scap));
2080 $logger->info("caption_and_pattern-alter: updated caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2081 return $editor->event unless $editor->update_serial_caption_and_pattern($scap);
2085 __PACKAGE__->register_method(
2086 method => "serial_caption_and_pattern_retrieve_batch",
2088 api_name => "open-ils.serial.caption_and_pattern.batch.retrieve"
2091 sub serial_caption_and_pattern_retrieve_batch {
2092 my( $self, $client, $ids ) = @_;
2093 $logger->info("Fetching caption_and_patterns @$ids");
2094 return $U->cstorereq(
2095 "open-ils.cstore.direct.serial.caption_and_pattern.search.atomic",
2100 __PACKAGE__->register_method(
2101 "method" => "bre_by_identifier",
2102 "api_name" => "open-ils.serial.biblio.record_entry.by_identifier",
2105 "desc" => "Find instances of biblio.record_entry given a search token" .
2106 " that could be a value for any identifier defined in " .
2107 "config.metabib_field",
2109 {"desc" => "Search token", "type" => "string"},
2110 {"desc" => "Options: require_subscriptions, add_mvr, is_actual_id" .
2111 " (all boolean)", "type" => "object"}
2114 "desc" => "Any matching BREs, or if the add_mvr option is true, " .
2115 "objects with a 'bre' key/value pair, and an 'mvr' " .
2116 "key-value pair. BREs have subscriptions fleshed on.",
2122 sub bre_by_identifier {
2123 my ($self, $client, $term, $options) = @_;
2125 return new OpenILS::Event("BAD_PARAMS") unless $term;
2128 my $e = new_editor();
2132 if ($options->{"is_actual_id"}) {
2136 $e->search_config_metabib_field({"field_class" => "identifier"})
2137 or return $e->die_event;
2139 my @identifiers = map { $_->name } @$cmf;
2140 my $query = join(" || ", map { "id|$_: $term" } @identifiers);
2142 my $search = create OpenSRF::AppSession("open-ils.search");
2143 my $search_result = $search->request(
2144 "open-ils.search.biblio.multiclass.query.staff", {}, $query
2146 $search->disconnect;
2148 # Un-nest results. They tend to look like [[1],[2],[3]] for some reason.
2149 @ids = map { @{$_} } @{$search_result->{"ids"}};
2157 my $bre = $e->search_biblio_record_entry([
2159 "flesh" => 2, "flesh_fields" => {
2160 "bre" => ["subscriptions"],
2161 "ssub" => ["owning_lib"]
2164 ]) or return $e->die_event;
2166 if (@$bre && $options->{"require_subscriptions"}) {
2167 $bre = [ grep { @{$_->subscriptions} } @$bre ];
2172 if (@$bre) { # re-evaluate after possible grep
2173 if ($options->{"add_mvr"}) {
2175 {"bre" => $_, "mvr" => _get_mvr($_->id)}
2178 $client->respond($_) foreach (@$bre);
2185 __PACKAGE__->register_method(
2186 "method" => "get_receivable_items",
2187 "api_name" => "open-ils.serial.items.receivable.by_subscription",
2190 "desc" => "Return all receivable items under a given subscription",
2192 {"desc" => "Authtoken", "type" => "string"},
2193 {"desc" => "Subscription ID", "type" => "number"},
2196 "desc" => "All receivable items under a given subscription",
2202 __PACKAGE__->register_method(
2203 "method" => "get_receivable_items",
2204 "api_name" => "open-ils.serial.items.receivable.by_issuance",
2207 "desc" => "Return all receivable items under a given issuance",
2209 {"desc" => "Authtoken", "type" => "string"},
2210 {"desc" => "Issuance ID", "type" => "number"},
2213 "desc" => "All receivable items under a given issuance",
2219 sub get_receivable_items {
2220 my ($self, $client, $auth, $term) = @_;
2222 my $e = new_editor("authtoken" => $auth);
2223 return $e->die_event unless $e->checkauth;
2227 my $by = ($self->api_name =~ /by_(\w+)$/)[0];
2230 "issuance" => {"issuance" => $term},
2231 "subscription" => {"+siss" => {"subscription" => $term}}
2234 my $item_ids = $e->json_query(
2236 "select" => {"sitem" => ["id"]},
2237 "from" => {"sitem" => "siss"},
2239 %{$where{$by}}, "date_received" => undef
2241 "order_by" => {"sitem" => ["id"]}
2243 ) or return $e->die_event;
2245 return undef unless @$item_ids;
2247 foreach (map { $_->{"id"} } @$item_ids) {
2249 $e->retrieve_serial_item([
2253 "sitem" => ["stream", "issuance"],
2254 "sstr" => ["distribution"],
2255 "sdist" => ["holding_lib"]
2266 __PACKAGE__->register_method(
2267 "method" => "get_receivable_issuances",
2268 "api_name" => "open-ils.serial.issuances.receivable",
2271 "desc" => "Return all issuances with receivable items given " .
2272 "a subscription ID",
2274 {"desc" => "Authtoken", "type" => "string"},
2275 {"desc" => "Subscription ID", "type" => "number"},
2278 "desc" => "All issuances with receivable items " .
2279 "(but not the items themselves)", "type" => "object"
2284 sub get_receivable_issuances {
2285 my ($self, $client, $auth, $sub_id) = @_;
2287 my $e = new_editor("authtoken" => $auth);
2288 return $e->die_event unless $e->checkauth;
2292 my $issuance_ids = $e->json_query({
2295 {"transform" => "distinct", "column" => "id"},
2299 "from" => {"siss" => "sitem"},
2301 "subscription" => $sub_id,
2302 "+sitem" => {"date_received" => undef}
2305 "siss" => {"date_published" => {"direction" => "asc"}}
2308 }) or return $e->die_event;
2310 $client->respond($e->retrieve_serial_issuance($_->{"id"}))
2311 foreach (@$issuance_ids);