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 DateTime::Format::ISO8601;
52 use MARC::File::XML (BinaryEncoding => 'utf8');
54 use OpenILS::Application::Serial::OPAC;
56 my $U = 'OpenILS::Application::AppUtils';
57 my @MFHD_NAMES = ('basic','supplement','index');
58 my %MFHD_NAMES_BY_TAG = ( '853' => $MFHD_NAMES[0],
59 '863' => $MFHD_NAMES[0],
60 '854' => $MFHD_NAMES[1],
61 '864' => $MFHD_NAMES[1],
62 '855' => $MFHD_NAMES[2],
63 '865' => $MFHD_NAMES[2] );
64 my %MFHD_TAGS_BY_NAME = ( $MFHD_NAMES[0] => '853',
65 $MFHD_NAMES[1] => '854',
66 $MFHD_NAMES[2] => '855');
67 my $_strp_date = new DateTime::Format::Strptime(pattern => '%F');
69 'subscription' => 'ssub',
70 'distribution' => 'sdist',
74 # helper method for conforming dates to ISO8601
79 foreach my $field (@$fields) {
80 $item->$field(OpenSRF::Utils::clense_ISO8601($item->$field)) if $item->$field;
88 "open-ils.search.biblio.record.mods_slim.retrieve",
94 ##########################################################################
97 __PACKAGE__->register_method(
98 method => "create_item_safely",
99 api_name => "open-ils.serial.item.create",
104 desc => q/Creates any number of items, respecting only a few of the
105 submitted fields, as the user shouldn't be able to freely set certain
108 {name=> "authtoken", desc => "Authtoken for current user session",
110 {name => "item", desc => "serial item",
111 type => "object", class => "sitem"},
113 desc => "optional: how many items to make " .
114 "(default 1; 1-100 permitted)",
118 desc => "created items (a stream of them)",
119 type => "object", class => "sitem"
123 __PACKAGE__->register_method(
124 method => "update_item_safely",
125 api_name => "open-ils.serial.item.update",
130 desc => q/Edit a serial item, respecting only a few of the
131 submitted fields, as the user shouldn't be able to freely set certain
134 {name=> "authtoken", desc => "Authtoken for current user session",
136 {name => "item", desc => "serial item",
137 type => "object", class => "sitem"},
140 desc => "created item", type => "object", class => "sitem"
145 sub _set_safe_item_fields {
148 my $requestor_id = shift;
149 # extra fields remain in @_
151 $dest->edit_date("now");
152 $dest->editor($requestor_id);
154 my @fields = qw/date_expected date_received status/;
156 for my $field (@fields, @_) {
157 $dest->$field($source->$field);
161 sub update_item_safely {
162 my ($self, $client, $auth, $item) = @_;
164 my $e = new_editor("xact" => 1, "authtoken" => $auth);
165 $e->checkauth or return $e->die_event;
167 my $orig = $e->retrieve_serial_item([
169 "flesh" => 2, "flesh_fields" => {
170 "sitem" => ["stream"], "sstr" => ["distribution"]
173 ]) or return $e->die_event;
175 return $e->die_event unless $e->allowed(
176 "ADMIN_SERIAL_ITEM", $orig->stream->distribution->holding_lib
179 _set_safe_item_fields($orig, $item, $e->requestor->id);
180 $e->update_serial_item($orig) or return $e->die_event;
182 $client->respond($e->retrieve_serial_item($item->id));
183 $e->commit or return $e->die_event;
187 sub create_item_safely {
188 my ($self, $client, $auth, $item, $count) = @_;
192 return new OpenILS::Event(
193 "BAD_PARAMS", note => "Count should be from 1 to 100"
194 ) unless $count >= 1 and $count <= 100;
196 my $e = new_editor("xact" => 1, "authtoken" => $auth);
197 $e->checkauth or return $e->die_event;
199 my $stream = $e->retrieve_serial_stream([
201 "flesh" => 1, "flesh_fields" => {"sstr" => ["distribution"]}
203 ]) or return $e->die_event;
205 return $e->die_event unless $e->allowed(
206 "ADMIN_SERIAL_ITEM", $stream->distribution->holding_lib
209 for (my $i = 0; $i < $count; $i++) {
210 my $actual = new Fieldmapper::serial::item;
211 $actual->creator($e->requestor->id);
212 _set_safe_item_fields(
213 $actual, $item, $e->requestor->id, "issuance", "stream"
216 $e->create_serial_item($actual) or return $e->die_event;
217 $client->respond($e->data);
220 $e->commit or return $e->die_event;
224 __PACKAGE__->register_method(
225 method => 'fleshed_item_alter',
226 api_name => 'open-ils.serial.item.fleshed.batch.update',
230 desc => 'Receives an array of one or more items and updates the database as needed',
233 desc => 'Authtoken for current user session',
238 desc => 'Array of fleshed items',
244 desc => 'Returns 1 if successful, event if failed',
250 sub fleshed_item_alter {
251 my( $self, $conn, $auth, $items ) = @_;
252 return 1 unless ref $items;
253 my( $reqr, $evt ) = $U->checkses($auth);
255 my $editor = new_editor(requestor => $reqr, xact => 1);
256 my $override = $self->api_name =~ /override/;
260 for my $item (@$items) {
261 my $sstr_id = ref $item->stream ? $item->stream->id : $item->stream;
262 if (!exists($found_sstr_ids{$sstr_id})) {
264 if (ref $item->stream) {
265 $sstr = $item->stream;
267 $sstr = $editor->retrieve_serial_stream($item->stream) or return $editor->die_event;
269 if (!exists($found_sdist_ids{$sstr->distribution})) {
270 my $sdist = $editor->retrieve_serial_distribution($sstr->distribution) or return $editor->die_event;
271 return $editor->die_event unless
272 $editor->allowed("ADMIN_SERIAL_STREAM", $sdist->holding_lib);
273 $found_sdist_ids{$sstr->distribution} = 1;
275 $found_sstr_ids{$sstr_id} = 1;
278 $item->editor($editor->requestor->id);
279 $item->edit_date('now');
281 if( $item->isdeleted ) {
282 $evt = _delete_sitem( $editor, $override, $item);
283 } elsif( $item->isnew ) {
284 # TODO: reconsider this
285 # if the item has a new issuance, create the issuance first
286 if (ref $item->issuance eq 'Fieldmapper::serial::issuance' and $item->issuance->isnew) {
287 fleshed_issuance_alter($self, $conn, $auth, [$item->issuance]);
289 _cleanse_dates($item, ['date_expected','date_received']);
290 $evt = _create_sitem( $editor, $item );
292 _cleanse_dates($item, ['date_expected','date_received']);
293 $evt = _update_sitem( $editor, $override, $item );
298 $logger->info("fleshed item-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
302 $logger->debug("item-alter: done updating item batch");
304 $logger->info("fleshed item-alter successfully updated ".scalar(@$items)." items");
309 my ($editor, $override, $item) = @_;
310 $logger->info("item-alter: delete item ".OpenSRF::Utils::JSON->perl2JSON($item));
311 return $editor->event unless $editor->delete_serial_item($item);
316 my ($editor, $item) = @_;
318 $item->creator($editor->requestor->id);
319 $item->create_date('now');
321 $logger->info("item-alter: new item ".OpenSRF::Utils::JSON->perl2JSON($item));
322 return $editor->event unless $editor->create_serial_item($item);
327 my ($editor, $override, $item) = @_;
329 $logger->info("item-alter: retrieving item ".$item->id);
330 my $orig_item = $editor->retrieve_serial_item($item->id);
332 $logger->info("item-alter: original item ".OpenSRF::Utils::JSON->perl2JSON($orig_item));
333 $logger->info("item-alter: updated item ".OpenSRF::Utils::JSON->perl2JSON($item));
334 return $editor->event unless $editor->update_serial_item($item);
338 __PACKAGE__->register_method(
339 method => "fleshed_serial_item_retrieve_batch",
341 api_name => "open-ils.serial.item.fleshed.batch.retrieve"
344 sub fleshed_serial_item_retrieve_batch {
345 my( $self, $client, $ids ) = @_;
346 # FIXME: permissions?
347 $logger->info("Fetching fleshed serial items @$ids");
348 return $U->cstorereq(
349 "open-ils.cstore.direct.serial.item.search.atomic",
352 flesh_fields => {sitem => [ qw/issuance creator editor stream unit notes/ ], sunit => ["call_number"], siss => [qw/creator editor subscription/]}
357 ##########################################################################
360 __PACKAGE__->register_method(
361 method => 'fleshed_issuance_alter',
362 api_name => 'open-ils.serial.issuance.fleshed.batch.update',
366 desc => 'Receives an array of one or more issuances and updates the database as needed',
369 desc => 'Authtoken for current user session',
374 desc => 'Array of fleshed issuances',
380 desc => 'Returns 1 if successful, event if failed',
386 sub fleshed_issuance_alter {
387 my( $self, $conn, $auth, $issuances ) = @_;
388 return 1 unless ref $issuances;
389 my( $reqr, $evt ) = $U->checkses($auth);
391 my $editor = new_editor(authtoken => $auth, requestor => $reqr, xact => 1);
392 my $override = $self->api_name =~ /override/;
396 for my $issuance (@$issuances) {
397 my $ssub_id = ref $issuance->subscription ? $issuance->subscription->id : $issuance->subscription;
398 if (!exists($found_ssub_ids{$ssub_id})) {
400 if (ref $issuance->subscription) {
401 $owning_lib_id = $issuance->subscription->owning_lib;
403 my $ssub = $editor->retrieve_serial_subscription($issuance->subscription) or return $editor->die_event;
404 $owning_lib_id = $ssub->owning_lib;
406 return $editor->die_event unless
407 $editor->allowed("ADMIN_SERIAL_SUBSCRIPTION", $owning_lib_id);
408 $found_ssub_ids{$ssub_id} = 1;
411 my $issuanceid = $issuance->id;
412 $issuance->editor($editor->requestor->id);
413 $issuance->edit_date('now');
415 if( $issuance->isdeleted ) {
416 $evt = _delete_siss( $editor, $override, $issuance);
417 $regen_ssub_ids{$ssub_id} = 1;
418 } elsif( $issuance->isnew ) {
419 _cleanse_dates($issuance, ['date_published']);
420 $evt = _create_siss( $editor, $issuance );
422 _cleanse_dates($issuance, ['date_published']);
423 $evt = _update_siss( $editor, $override, $issuance );
430 # if we deleted any issuances, update the summaries
431 # for all dists in those ssubs
432 my @ssub_ids = keys %regen_ssub_ids;
433 $evt = _regenerate_summaries($editor, {'ssub_ids' => \@ssub_ids}) if @ssub_ids;
437 $logger->info("fleshed issuance-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
442 $logger->debug("issuance-alter: done updating issuance batch");
444 $logger->info("fleshed issuance-alter successfully updated ".scalar(@$issuances)." issuances");
449 my ($editor, $override, $issuance) = @_;
450 $logger->info("issuance-alter: delete issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
451 return $editor->event unless $editor->delete_serial_issuance($issuance);
456 my ($editor, $issuance) = @_;
458 $issuance->creator($editor->requestor->id);
459 $issuance->create_date('now');
461 $logger->info("issuance-alter: new issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
462 return $editor->event unless $editor->create_serial_issuance($issuance);
467 my ($editor, $override, $issuance) = @_;
469 $logger->info("issuance-alter: retrieving issuance ".$issuance->id);
470 my $orig_issuance = $editor->retrieve_serial_issuance($issuance->id);
472 $logger->info("issuance-alter: original issuance ".OpenSRF::Utils::JSON->perl2JSON($orig_issuance));
473 $logger->info("issuance-alter: updated issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
474 return $editor->event unless $editor->update_serial_issuance($issuance);
478 __PACKAGE__->register_method(
479 method => "fleshed_serial_issuance_retrieve_batch",
481 api_name => "open-ils.serial.issuance.fleshed.batch.retrieve"
484 sub fleshed_serial_issuance_retrieve_batch {
485 my( $self, $client, $ids ) = @_;
486 # FIXME: permissions?
487 $logger->info("Fetching fleshed serial issuances @$ids");
488 return $U->cstorereq(
489 "open-ils.cstore.direct.serial.issuance.search.atomic",
492 flesh_fields => {siss => [ qw/creator editor subscription/ ]}
496 __PACKAGE__->register_method(
497 method => "pub_fleshed_serial_issuance_retrieve_batch",
498 api_name => "open-ils.serial.issuance.pub_fleshed.batch.retrieve",
501 Public (i.e. OPAC) call for getting at the sub and
502 ultimately the record entry from an issuance
504 params => [{name => 'ids', desc => 'Array of IDs', type => 'array'}],
507 issuance objects, fleshed with subscriptions
513 sub pub_fleshed_serial_issuance_retrieve_batch {
514 my( $self, $client, $ids ) = @_;
515 return [] unless $ids and @$ids;
516 return new_editor()->search_serial_issuance([
520 flesh_fields => {siss => [ qw/subscription/ ]}
525 sub received_siss_by_bib {
526 # XXX this is somewhat wrong in implementation and should not be used in
527 # new places - senator
532 my $args = shift || {};
533 $$args{order} ||= 'asc';
535 my $global = $$args{global} == 0 ? 0 : 1;
537 my $e = new_editor();
538 my $issuances = $e->json_query({
541 $global ? { transform => "min", column => "id", aggregate => 1 } : "id",
546 # We're not really interested in the minimum here. This is
547 # just a way to distinguish issuances whose items have units
548 # from issuances whose items have no units, without altogether
549 # excluding the latter type of issuances.
550 {"transform" => "min", "alias" => "has_units",
551 "column" => "unit", "aggregate" => 1}
557 field => 'subscription',
563 $$args{ou} ? ( join => {
570 fkey => 'distribution'
581 '+ssub' => { record_entry => $bib },
582 $$args{type} ? ( '+siss' => { 'holding_type' => $$args{type} } ) : (),
584 # XXX should we also take specific item statuses into account?
585 date_received => { '!=' => undef },
586 $$args{status} ? ( 'status' => $$args{status} ) : ()
588 $$args{ou} ? ( '+sdist' => {
590 'in' => $U->get_org_descendants($$args{ou}, $$args{depth})
594 $$args{limit} ? ( limit => $$args{limit} ) : (),
595 $$args{offset} ? ( offset => $$args{offset} ) : (),
596 order_by => [{ class => 'siss', field => 'date_published', direction => $$args{order} }],
601 "issuance" => $e->retrieve_serial_issuance($_->{"id"}),
602 "has_units" => $_->{"has_units"} ? 1 : 0
607 __PACKAGE__->register_method(
608 method => 'received_siss_by_bib',
609 api_name => 'open-ils.serial.received_siss.retrieve.by_bib',
614 desc => 'Receives a Bib ID and other optional params and returns "siss" (issuance) objects',
617 desc => 'id of the bre to which the issuances belong',
622 q/A hash of optional arguments. Valid keys and their meanings:
623 global := If true, return only one representative version of a conceptual issuance regardless of the number of subscriptions, otherwise return all issuance objects meeting the requested criteria, including conceptual duplicates. Valid values are 0 (false) and 1 (true, default).
624 order := date_published sort direction, either "asc" (chronological, default) or "desc" (reverse chronological)
625 limit := Number of issuances to return. Useful for paging results, or finding the oldest or newest
626 offset := Number of issuance to skip before returning results. Useful for paging.
627 orgid := OU id used to scope retrieval, based on distribution.holding_lib
628 depth := OU depth used to range the scope of orgid
629 type := Holding type filter. Valid values are "basic", "supplement" and "index". Can be a scalar (one) or arrayref (one or more).
630 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).
638 sub scoped_bib_holdings_summary {
639 # XXX this is somewhat wrong in implementation and should not be used in
640 # new places - senator
644 my $args = shift || {};
646 $args->{order} = 'asc';
648 my ($issuances) = $self->method_lookup('open-ils.serial.received_siss.retrieve.by_bib.atomic')->run( $bibid => $args );
650 # split into issuance type sets
651 my %type_blob = (basic => [], supplement => [], index => []);
652 push @{ $type_blob{ $_->{"issuance"}->holding_type } }, $_->{"issuance"}
655 # generate a statement list for each type
657 for my $type ( keys %type_blob ) {
658 my ($mfhd,$list) = _summarize_contents(new_editor(), $type_blob{$type});
660 return {} if $U->event_code($mfhd); # _summarize_contents() failed, bad data?
662 $statement_blob{$type} = $list;
665 return \%statement_blob;
667 __PACKAGE__->register_method(
668 method => 'scoped_bib_holdings_summary',
669 api_name => 'open-ils.serial.bib.summary_statements',
673 desc => '** DEPRECATED and only used by JSPAC. Somewhat wrong in implementation. *** Receives a Bib ID and other optional params and returns set of holdings statements',
676 desc => 'id of the bre to which the issuances belong',
681 q/A hash of optional arguments. Valid keys and their meanings:
682 orgid := OU id used to scope retrieval, based on distribution.holding_lib
683 depth := OU depth used to range the scope of orgid
684 type := Holding type filter. Valid values are "basic", "supplement" and "index". Can be a scalar (one) or arrayref (one or more).
685 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).
693 ##########################################################################
696 __PACKAGE__->register_method(
697 method => 'fleshed_sunit_alter',
698 api_name => 'open-ils.serial.sunit.fleshed.batch.update',
702 desc => 'Receives an array of one or more Units and updates the database as needed',
705 desc => 'Authtoken for current user session',
710 desc => 'Array of fleshed Units',
716 desc => 'Returns 1 if successful, event if failed',
722 sub fleshed_sunit_alter {
723 my( $self, $conn, $auth, $sunits ) = @_;
724 return 1 unless ref $sunits;
725 my( $reqr, $evt ) = $U->checkses($auth);
727 my $editor = new_editor(requestor => $reqr, xact => 1);
728 my $override = $self->api_name =~ /override/;
731 for my $sunit (@$sunits) {
732 my $cn_id = ref $sunit->call_number ? $sunit->call_number->id : $sunit->call_number;
733 if (!exists($found_cn_ids{$cn_id})) {
735 if (ref $sunit->call_number) {
736 $owning_lib_id = $sunit->call_number->owning_lib;
738 my $cn = $editor->retrieve_asset_call_number($sunit->call_number) or return $editor->die_event;
739 $owning_lib_id = $cn->owning_lib;
741 return $editor->die_event unless
742 $editor->allowed("UPDATE_COPY", $owning_lib_id);
743 $found_cn_ids{$cn_id} = 1;
746 if( $sunit->isdeleted ) {
747 $evt = _delete_sunit( $editor, $override, $sunit );
749 $sunit->default_location( $sunit->default_location->id ) if ref $sunit->default_location;
751 if( $sunit->isnew ) {
752 $evt = _create_sunit( $editor, $sunit );
754 $evt = _update_sunit( $editor, $override, $sunit );
760 $logger->info("fleshed sunit-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
764 $logger->debug("sunit-alter: done updating sunit batch");
766 $logger->info("fleshed sunit-alter successfully updated ".scalar(@$sunits)." Units");
771 my ($editor, $override, $sunit) = @_;
772 $logger->info("sunit-alter: delete sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
773 return $editor->event unless $editor->delete_serial_unit($sunit);
778 my ($editor, $sunit) = @_;
780 # The unique barcode constraint does not span asset.copy and serial.unit.
781 # ensure the barcode on the new unit does not collide with an existing
782 # asset.copy barcode.
783 my $existing = $editor->search_asset_copy(
784 {deleted => 'f', barcode => $sunit->barcode})->[0];
787 # The DB will prevent duplicate serial.unit barcodes, but for
788 # consistency (and a more specific error message for the
789 # user), prevent creation attempts on serial unit barcode
790 # collisions as well.
791 $existing = $editor->search_serial_unit(
792 {deleted => 'f', barcode => $sunit->barcode})->[0];
797 return new OpenILS::Event(
798 'SERIAL_UNIT_BARCODE_COLLISION', note =>
799 'Serial unit barcode collides with existing unit/copy barcode',
800 payload => {barcode => $sunit->barcode}
804 $logger->info("sunit-alter: new Unit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
805 return $editor->die_event unless $editor->create_serial_unit($sunit);
810 my ($editor, $override, $sunit) = @_;
812 $logger->info("sunit-alter: retrieving sunit ".$sunit->id);
813 my $orig_sunit = $editor->retrieve_serial_unit($sunit->id);
815 $logger->info("sunit-alter: original sunit ".OpenSRF::Utils::JSON->perl2JSON($orig_sunit));
816 $logger->info("sunit-alter: updated sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
817 return $editor->event unless $editor->update_serial_unit($sunit);
821 __PACKAGE__->register_method(
822 method => "retrieve_unit_list",
824 api_name => "open-ils.serial.unit_list.retrieve"
827 sub retrieve_unit_list {
829 my( $self, $client, @sdist_ids ) = @_;
831 if(ref($sdist_ids[0])) { @sdist_ids = @{$sdist_ids[0]}; }
833 my $e = new_editor();
837 { 'sunit' => [ 'id', 'summary_contents', 'sort_key' ],
838 'sitem' => ['stream'],
839 'sstr' => ['distribution'],
840 'sdist' => [{'column' => 'label', 'alias' => 'sdist_label'}]
847 { 'join' => { 'sunit' => {} } }
852 'distinct' => 'true',
853 'where' => { '+sdist' => {'id' => \@sdist_ids} },
854 'order_by' => [{'class' => 'sunit', 'field' => 'sort_key'}]
857 my $unit_list_entries = $e->json_query($query);
860 foreach my $entry (@$unit_list_entries) {
861 my $value = {'sunit' => $entry->{id}, 'sstr' => $entry->{stream}, 'sdist' => $entry->{distribution}};
862 my $label = $entry->{summary_contents};
863 if (length($label) > 100) {
864 $label = substr($label, 0, 100) . '...'; # limited space in dropdown / menu
866 $label = "[$entry->{sdist_label}/$entry->{stream} #$entry->{id}] " . $label;
867 push (@entries, [$label, OpenSRF::Utils::JSON->perl2JSON($value)]);
875 ##########################################################################
876 # predict and receive methods
878 __PACKAGE__->register_method(
879 method => 'make_predictions',
880 api_name => 'open-ils.serial.make_predictions',
884 desc => 'Receives an ssub id and populates the issuance and item tables',
887 desc => 'Serial Subscription ID',
894 sub make_predictions {
895 my ($self, $conn, $authtoken, $args) = @_;
897 my $editor = OpenILS::Utils::CStoreEditor->new();
898 my $ssub_id = $args->{ssub_id};
899 my $mfhd = MFHD->new(MARC::Record->new());
901 my $ssub = $editor->retrieve_serial_subscription([$ssub_id]);
902 my $scaps = $editor->search_serial_caption_and_pattern({ subscription => $ssub_id, active => 't'});
903 my $sdists = $editor->search_serial_distribution( [{ subscription => $ssub->id }, { flesh => 1, flesh_fields => {sdist => [ qw/ streams / ]} }] ); #TODO: 'deleted' support?
905 my $total_streams = 0;
907 $total_streams += scalar(@{$_->streams});
909 if ($total_streams < 1) {
911 # XXX TODO new event type
912 return new OpenILS::Event(
913 "BAD_PARAMS", note =>
914 "There are no streams to direct items. Can't predict."
920 # XXX TODO new event type
921 return new OpenILS::Event(
922 "BAD_PARAMS", note =>
923 "There are no active caption-and-pattern objects associated " .
924 "with this subscription. Can't predict."
930 foreach my $scap (@$scaps) {
931 my $caption_field = _revive_caption($scap);
932 $caption_field->update('8' => $link_id);
933 my $fake_chron_needed = 0;
934 # if we have missing chron pieces, we will add them later for prediction purposes
935 if (!$caption_field->enumeration_is_chronology) {
936 if (!$caption_field->subfield('i') # no year
937 or !$caption_field->subfield('j')) { # we had a year, but no month or season
938 $fake_chron_needed = '1';
941 $mfhd->append_fields($caption_field);
943 'caption' => $caption_field,
944 'scap_id' => $scap->id,
945 'num_to_predict' => $args->{num_to_predict},
946 'end_date' => defined $args->{end_date} ?
947 $_strp_date->parse_datetime($args->{end_date}) : undef
949 my $predict_from_siss;
950 if ($args->{base_issuance}) { # predict from a given issuance
951 $predict_from_siss = $args->{base_issuance}->holding_code;
952 } else { # default to predicting from last published
953 my $last_published = $editor->search_serial_issuance([
954 {'caption_and_pattern' => $scap->id,
955 'subscription' => $ssub_id},
956 {limit => 1, order_by => { siss => "date_published DESC" }}]
958 if ($last_published->[0]) {
959 $predict_from_siss = $last_published->[0];
960 unless ($predict_from_siss->holding_code) {
962 # XXX TODO new event type
963 return new OpenILS::Event(
964 "BAD_PARAMS", note =>
965 "Last issuance has no holding code. Can't predict."
970 # XXX TODO make a new event type instead of hijacking this one
971 return new OpenILS::Event(
972 "BAD_PARAMS", note => "No issuance from which to predict!"
976 $options->{predict_from} = _revive_holding($predict_from_siss->holding_code, $caption_field, 1); # fresh MFHD Record, so we simply default to 1 for seqno
977 if ($fake_chron_needed) {
978 $options->{faked_chron_date} = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($predict_from_siss->date_published));
980 push( @predictions, _generate_issuance_values($mfhd, $options) );
985 foreach my $prediction (@predictions) {
986 my $issuance = new Fieldmapper::serial::issuance;
988 $issuance->label($prediction->{label});
989 $issuance->date_published($prediction->{date_published}->strftime('%F'));
990 $issuance->holding_code(OpenSRF::Utils::JSON->perl2JSON($prediction->{holding_code}));
991 $issuance->holding_type($prediction->{holding_type});
992 $issuance->caption_and_pattern($prediction->{caption_and_pattern});
993 $issuance->subscription($ssub->id);
994 push (@issuances, $issuance);
997 my $evt = fleshed_issuance_alter($self, $conn, $authtoken, \@issuances);
998 return $evt if ref $evt;
1001 for (my $i = 0; $i < @issuances; $i++) {
1002 my $date_expected = $predictions[$i]->{date_published}->add(seconds => interval_to_seconds($ssub->expected_date_offset))->strftime('%F');
1003 my $issuance = $issuances[$i];
1004 #$issuance->label(interval_to_seconds($ssub->expected_date_offset));
1005 foreach my $sdist (@$sdists) {
1006 my $streams = $sdist->streams;
1007 foreach my $stream (@$streams) {
1008 my $item = new Fieldmapper::serial::item;
1010 $item->stream($stream->id);
1011 $item->date_expected($date_expected);
1012 $item->issuance($issuance->id);
1013 push (@items, $item);
1017 fleshed_item_alter($self, $conn, $authtoken, \@items); # FIXME: catch events
1022 # _generate_issuance_values() is an initial attempt at a function which can be used
1023 # to populate an issuance table with a list of predicted issues. It accepts
1024 # a hash ref of options initially defined as:
1025 # caption : the caption field to predict on
1026 # num_to_predict : the number of issues you wish to predict
1027 # faked_chron_date : if the serial does not actually have a chronology caption (but we need one for prediction's sake), base predictions on this date
1029 # The basic method is to first convert to a single holding if compressed, then
1030 # increment the holding and save the resulting values to @issuances.
1032 # returns @issuance_values, an array of hashrefs containing (formatted
1033 # label, formatted chronology date, formatted estimated arrival date, and an
1034 # array ref of holding subfields as (key, value, key, value ...)) (not a hash
1035 # to protect order and possible duplicate keys), and a holding type.
1037 sub _generate_issuance_values {
1038 my ($mfhd, $options) = @_;
1039 my $caption = $options->{caption};
1040 my $scap_id = $options->{scap_id};
1041 my $num_to_predict = $options->{num_to_predict};
1042 my $end_date = $options->{end_date};
1043 my $predict_from = $options->{predict_from}; # MFHD::Holding to predict from
1044 my $faked_chron_date = $options->{faked_chron_date}; # serial does not have a (complete) chronology caption, so add one (temporarily) based on this date
1047 # Only needed for 'real' MFHD records, not our temp records
1048 # my $link_id = $caption->link_id;
1049 # if(!$predict_from) {
1050 # my $htag = $caption->tag;
1051 # $htag =~ s/^85/86/;
1052 # my @holdings = $mfhd->holdings($htag, $link_id);
1053 # my $last_holding = $holdings[-1];
1055 # #if ($last_holding->is_compressed) {
1056 # # $last_holding->compressed_to_last; # convert to last in range
1058 # $predict_from = $last_holding;
1062 $predict_from->notes('public', []);
1063 # add a note marker for system use (?)
1064 $predict_from->notes('private', ['AUTOGEN']);
1066 # our basic method for dealing with 'faked' chronologies will be to add it in, do the predicting, then take it back out
1067 my @faked_subfield_chars;
1068 if ($faked_chron_date) {
1069 my $faked_caption = new MARC::Field($caption->tag, $caption->indicator(1), $caption->indicator(2), $caption->subfields_list);
1071 my %mfhd_chron_labels = ('i' => 'year', 'j' => 'month', 'k' => 'day');
1072 foreach my $subfield_char ('i', 'j', 'k') {
1073 if (!$caption->subfield($subfield_char)) { # if we are missing a piece, add it
1074 push(@faked_subfield_chars, $subfield_char);
1075 my $chron_name = $mfhd_chron_labels{$subfield_char};
1076 $faked_caption->add_subfields($subfield_char => "($chron_name)");
1077 my $method = $mfhd_chron_labels{$subfield_char};
1078 $predict_from->add_subfields($subfield_char => $faked_chron_date->$chron_name);
1081 # because of the way MFHD::Caption and Holding work, it is simplest
1082 # to recreate rather than try to update
1083 $faked_caption = new MFHD::Caption($faked_caption);
1084 $predict_from = new MFHD::Holding($predict_from->seqno, new MARC::Field($predict_from->tag, $predict_from->indicator(1), $predict_from->indicator(2), $predict_from->subfields_list), $faked_caption);
1087 my @predictions = $mfhd->generate_predictions({'base_holding' => $predict_from, 'num_to_predict' => $num_to_predict, 'end_date' => $end_date});
1090 my @issuance_values;
1091 foreach my $prediction (@predictions) {
1092 $pub_date = $_strp_date->parse_datetime($prediction->chron_to_date);
1093 if ($faked_chron_date) { # get rid of the chronology portions and restore original caption
1094 $prediction->delete_subfield(code => \@faked_subfield_chars);
1095 $prediction = new MFHD::Holding($prediction->seqno, new MARC::Field($prediction->tag, $prediction->indicator(1), $prediction->indicator(2), $prediction->subfields_list), $caption);
1101 label => $prediction->format,
1102 date_published => $pub_date,
1103 #date_expected => $date_expected->strftime('%F'),
1104 holding_code => [$prediction->indicator(1),$prediction->indicator(2),$prediction->subfields_list],
1105 holding_type => $MFHD_NAMES_BY_TAG{$caption->tag},
1106 caption_and_pattern => $scap_id
1111 return @issuance_values;
1114 sub _revive_caption {
1117 my $pattern_code = $scap->pattern_code;
1120 my $pattern_parts = OpenSRF::Utils::JSON->JSON2perl($pattern_code);
1121 unshift(@$pattern_parts, $MFHD_TAGS_BY_NAME{$scap->type});
1122 my $pattern_field = new MARC::Field(@$pattern_parts);
1124 # build MFHD::Caption
1125 return new MFHD::Caption($pattern_field);
1128 sub _revive_holding {
1129 my $holding_code = shift;
1130 my $caption_field = shift;
1134 my $holding_parts = OpenSRF::Utils::JSON->JSON2perl($holding_code);
1135 my $captag = $caption_field->tag;
1136 $captag =~ s/^85/86/;
1137 unshift(@$holding_parts, $captag);
1138 my $holding_field = new MARC::Field(@$holding_parts);
1140 # build MFHD::Holding
1141 return new MFHD::Holding($seqno, $holding_field, $caption_field);
1143 # TODO(?) the underlying MARC and the Holding object end up in conflict concerning subfield '8'
1146 __PACKAGE__->register_method(
1147 method => 'unitize_items',
1148 api_name => 'open-ils.serial.receive_items',
1152 desc => 'Marks an item as received, updates the shelving unit (creating a new shelving unit if needed), and updates the summaries',
1155 desc => 'array of serial items',
1160 desc => 'hash of item_ids => barcodes',
1164 name => 'call_numbers',
1165 desc => 'hash of item_ids => call_numbers',
1169 name => 'donor_unit_ids',
1170 desc => 'hash of unit_ids => 1, keyed with ids of any units giving up items',
1175 desc => 'Returns number of received items (num_items) and new unit ID, if applicable (new_unit_id)',
1181 __PACKAGE__->register_method(
1182 method => 'unitize_items',
1183 api_name => 'open-ils.serial.bind_items',
1187 desc => 'Marks an item as bound, updates the shelving unit (creating a new shelving unit if needed)',
1190 desc => 'array of serial items',
1195 desc => 'hash of item_ids => barcodes',
1199 name => 'call_numbers',
1200 desc => 'hash of item_ids => call_numbers',
1204 name => 'donor_unit_ids',
1205 desc => 'hash of unit_ids => 1, keyed with ids of any units giving up items',
1210 desc => 'Returns number of bound items (num_items) and new unit ID, if applicable (new_unit_id)',
1216 # TODO: reset/delete claims information once implemented
1217 # XXX: deal with emptied call numbers here?
1218 __PACKAGE__->register_method(
1219 method => 'unitize_items',
1220 api_name => 'open-ils.serial.reset_items',
1224 desc => 'Resets the items to Expected, updates the shelving unit (deleting the shelving unit if empty), and updates the summaries',
1227 desc => 'array of serial items',
1232 desc => 'Returns number of reset items (num_items)',
1239 my ($self, $conn, $auth, $items, $barcodes, $call_numbers, $donor_unit_ids) = @_;
1241 my $editor = new_editor("authtoken" => $auth, "xact" => 1);
1242 return $editor->die_event unless $editor->checkauth;
1243 return $editor->die_event unless $editor->allowed("RECEIVE_SERIAL");
1244 $self->api_name =~ /serial\.(\w*)_items/;
1248 if ($donor_unit_ids) { # units giving up items need updating as well
1249 %found_unit_ids = %$donor_unit_ids;
1251 my %found_stream_ids;
1254 my %stream_ids_by_unit_id;
1257 my %sdist_by_unit_id;
1258 my %call_number_by_unit_id;
1259 my %sdist_by_stream_id;
1261 my $new_unit_id; # id for '-2' units to share
1262 foreach my $item (@$items) {
1263 # for debugging only, TODO: delete
1264 if (!ref $item) { # hopefully we got an id instead
1265 $item = $editor->retrieve_serial_item($item);
1268 my $unit_id = ref($item->unit) ? $item->unit->id : $item->unit;
1269 my $stream_id = ref($item->stream) ? $item->stream->id : $item->stream;
1270 my $issuance_id = ref($item->issuance) ? $item->issuance->id : $item->issuance;
1271 #TODO: evt on any missing ids
1273 if ($mode eq 'receive') {
1274 $item->date_received('now');
1275 $item->status('Received');
1276 } elsif ($mode eq 'reset') {
1277 # clear date_received
1278 $item->clear_date_received;
1279 # Set status to 'Expected'
1280 $item->status('Expected');
1285 # check for types to trigger summary updates
1287 if (!ref $item->issuance) {
1288 my $scaps = $editor->search_serial_caption_and_pattern([{"+siss" => {"id" => $issuance_id}}, { "join" => {"siss" => {}} }]);
1289 $scap = $scaps->[0];
1290 } elsif (!ref $item->issuance->caption_and_pattern) {
1291 $scap = $editor->retrieve_serial_caption_and_pattern($item->issuance->caption_and_pattern);
1293 $scap = $editor->issuance->caption_and_pattern;
1295 if (!exists($found_types{$stream_id})) {
1296 $found_types{$stream_id} = {};
1298 $found_types{$stream_id}->{$scap->type} = 1;
1300 # create unit if needed
1301 if ($unit_id == -1 or (!$new_unit_id and $unit_id == -2)) { # create unit per item
1303 my $sdists = $editor->search_serial_distribution([
1304 {"+sstr" => {"id" => $stream_id}},
1306 "join" => {"sstr" => {}},
1308 "flesh_fields" => {"sdist" => ["subscription"]}
1310 $unit = _build_unit($editor, $sdists->[0], $mode);
1311 # if _build_unit fails, $unit is an event, so return it
1312 if ($U->event_code($unit)) {
1314 $unit->{"note"} = "Item ID: " . $item->id;
1317 $unit->barcode($barcodes->{$item->id}) if exists($barcodes->{$item->id});
1318 my $evt = _create_sunit($editor, $unit);
1319 return $evt if $evt;
1320 if ($unit_id == -2) {
1321 $new_unit_id = $unit->id;
1322 $unit_id = $new_unit_id;
1324 $unit_id = $unit->id;
1326 $item->unit($unit_id);
1328 # get unit with 'DEFAULT's and save unit, sdist, and call number for later use
1329 $unit = $editor->retrieve_serial_unit($unit->id);
1330 $unit_map{$unit_id} = $unit;
1331 $sdist_by_unit_id{$unit_id} = $sdists->[0];
1332 $call_number_by_unit_id{$unit_id} = $call_numbers->{$item->id};
1333 $sdist_by_stream_id{$stream_id} = $sdists->[0];
1334 } elsif ($unit_id == -2) { # create one unit for all '-2' items
1335 $unit_id = $new_unit_id;
1336 $item->unit($unit_id);
1339 $found_stream_ids{$stream_id} = 1;
1341 if (defined($unit_id) and $unit_id ne '') {
1342 $found_unit_ids{$unit_id} = 1;
1343 # save the stream_id for this unit_id
1344 # TODO: prevent items from different streams in same unit? (perhaps in interface)
1345 $stream_ids_by_unit_id{$unit_id} = $stream_id;
1350 my $evt = _update_sitem($editor, undef, $item);
1351 return $evt if $evt;
1354 # cleanup 'dead' units (units which are now emptied of their items)
1355 my $dead_units = $editor->search_serial_unit([{'+sitem' => {'id' => undef}, 'deleted' => 'f'}, {'join' => {'sitem' => {'type' => 'left'}}}]);
1356 foreach my $unit (@$dead_units) {
1357 _delete_sunit($editor, undef, $unit);
1358 delete $found_unit_ids{$unit->id};
1361 # deal with unit level contents
1362 foreach my $unit_id (keys %found_unit_ids) {
1364 # get all the needed issuances for unit
1365 # TODO remove 'Bindery' from this search (leaving it in for now for backwards compatibility with any current test environment data)
1366 my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"unit" => $unit_id, "status" => ["Received", "Bindery"]}}, {"join" => {"sitem" => {}}, "order_by" => {"siss" => "date_published"}} ]);
1367 #TODO: evt on search failure
1369 # retrieve and update unit contents
1372 my $call_number_string;
1374 # if we just created the unit, we will already have it and the distribution stored, and we will need to assign the call number
1375 if (exists $unit_map{$unit_id}) {
1376 $sunit = $unit_map{$unit_id};
1377 $sdist = $sdist_by_unit_id{$unit_id};
1378 $call_number_string = $call_number_by_unit_id{$unit_id};
1379 $record_id = $sdist->subscription->record_entry;
1381 # XXX: this code assumes you will not have units which mix streams/distributions, but current code does not enforce this
1382 $sunit = $editor->retrieve_serial_unit($unit_id);
1383 if ($stream_ids_by_unit_id{$unit_id}) {
1384 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_ids_by_unit_id{$unit_id}}}, { "join" => {"sstr" => {}}, 'limit' => 1 }]);
1386 $sdist = $editor->search_serial_distribution([
1387 {'+sunit' => {'id' => $unit_id}},
1392 { 'join' => 'sunit' }
1399 $sdist = $sdist->[0];
1402 my $evt = _prepare_unit($editor, $sunit, $sdist, $issuances, $call_number_string, $record_id);
1403 if ($U->event_code($evt)) {
1408 $evt = _update_sunit($editor, undef, $sunit);
1409 if ($U->event_code($evt)) {
1415 if ($mode ne 'bind') { # the summary holdings do not change when binding
1416 # deal with stream level summaries
1417 # summaries will be built from the "primary" stream only, that is, the stream with the lowest ID per distribution
1418 # (TODO: consider direct designation)
1419 my %primary_streams_by_sdist;
1420 my %streams_by_sdist;
1422 # see if we have primary streams, and if so, associate them with their distributions
1423 foreach my $stream_id (keys %found_stream_ids) {
1425 if (exists $sdist_by_stream_id{$stream_id}) {
1426 $sdist = $sdist_by_stream_id{$stream_id};
1428 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
1429 $sdist = $sdist->[0];
1430 $sdist_by_stream_id{$stream_id} = $sdist;
1433 if (!exists($streams_by_sdist{$sdist->id})) {
1434 $streams = $editor->search_serial_stream([{"distribution" => $sdist->id}, {"order_by" => {"sstr" => "id"}}]);
1435 $streams_by_sdist{$sdist->id} = $streams;
1437 $streams = $streams_by_sdist{$sdist->id};
1439 $primary_streams_by_sdist{$sdist->id} = $streams->[0] if ($stream_id == $streams->[0]->id);
1442 # retrieve and update summaries for each affected primary stream's distribution
1443 foreach my $sdist_id (keys %primary_streams_by_sdist) {
1444 my $stream = $primary_streams_by_sdist{$sdist_id};
1445 my $stream_id = $stream->id;
1446 # get all the needed issuances for stream
1447 # FIXME: search in Bindery/Bound/Not Published? as well as Received
1448 foreach my $type (keys %{$found_types{$stream_id}}) {
1449 my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"stream" => $stream_id, "status" => "Received"}, "+scap" => {"type" => $type}}, {"join" => {"sitem" => {}, "scap" => {}}, "order_by" => {"siss" => "date_published"}} ]);
1450 #TODO: evt on search failure
1451 my $evt = _prepare_summaries($editor, $issuances, $sdist_by_stream_id{$stream_id}, $type);
1452 if ($U->event_code($evt)) {
1461 return {'num_items' => scalar @$items, 'new_unit_id' => $new_unit_id};
1464 sub _find_or_create_call_number {
1465 my ($e, $lib, $cn_string, $record) = @_;
1467 # FIXME: should suffix and prefix come into play here?
1468 my $existing = $e->search_asset_call_number({
1469 "owning_lib" => $lib,
1470 "label" => $cn_string,
1471 "record" => $record,
1473 }) or return $e->die_event;
1476 return $existing->[0]->id;
1478 return $e->die_event unless
1479 $e->allowed("CREATE_VOLUME", $lib);
1481 my $acn = new Fieldmapper::asset::call_number;
1483 $acn->creator($e->requestor->id);
1484 $acn->editor($e->requestor->id);
1485 $acn->record($record);
1486 $acn->label($cn_string);
1487 $acn->owning_lib($lib);
1489 $e->create_asset_call_number($acn) or return $e->die_event;
1490 return $e->data->id;
1494 sub _issuances_received {
1495 # XXX TODO: Add some caching or something. This is getting called
1496 # more often than it has to be.
1497 my ($e, $sitem) = @_;
1499 my $results = $e->json_query({
1500 "select" => {"sitem" => ["issuance"]},
1501 "from" => {"sitem" => {"sstr" => {}, "siss" => {}}},
1503 "+sstr" => {"distribution" => $sitem->stream->distribution->id},
1504 "+siss" => {"holding_type" => $sitem->issuance->holding_type},
1505 "+sitem" => {"date_received" => {"!=" => undef}}
1508 "siss" => {"date_published" => {"direction" => "asc"}}
1510 }) or return $e->die_event;
1514 for my $iss_id (map { $_->{"issuance"} } @$results) {
1515 next if $seen{$iss_id};
1517 push(@$issuances, $e->retrieve_serial_issuance($iss_id));
1522 # _prepare_unit populates the detailed_contents, summary_contents, and
1523 # sort_key fields for a given unit based on a given set of issuances
1524 # Also finds/creates call number as needed
1526 my ($e, $sunit, $sdist, $issuances, $call_number_string, $record_id) = @_;
1528 # Handle call number first if we have one
1529 if ($call_number_string) {
1530 my $org_unit_id = ref $sdist->holding_lib ? $sdist->holding_lib->id : $sdist->holding_lib;
1531 my $real_cn = _find_or_create_call_number(
1533 $call_number_string, $record_id
1536 if ($U->event_code($real_cn)) {
1539 $sunit->call_number($real_cn);
1543 my ($mfhd, $formatted_parts) = _summarize_contents($e, $issuances);
1544 return $mfhd if $U->event_code($mfhd);
1546 # special case for single formatted_part (may have summarized version)
1547 if (@$formatted_parts == 1) {
1548 #TODO: MFHD.pm should have a 'format_summary' method for this
1551 $sunit->detailed_contents(
1554 $sdist->unit_label_prefix,
1555 join(", ", @$formatted_parts),
1556 $sdist->unit_label_suffix
1560 # TODO: change this when real summary contents are available
1561 $sunit->summary_contents($sunit->detailed_contents);
1563 # Create sort_key by left padding numbers to 6 digits.
1564 (my $sort_key = $sunit->detailed_contents) =~
1565 s/(\d+)/sprintf '%06d', $1/eg;
1566 $sunit->sort_key($sort_key);
1569 # _prepare_summaries populates the generated_coverage field for a given summary
1570 # type ('basic', 'index', 'supplement') for a given distribution.
1571 # It also creates the summary if it doesn't yet exist.
1572 sub _prepare_summaries {
1573 my ($e, $issuances, $sdist, $type) = @_;
1575 my ($mfhd, $formatted_parts) = _summarize_contents($e, $issuances, $sdist, $type);
1576 return $mfhd if $U->event_code($mfhd);
1578 my $search_method = "search_serial_${type}_summary";
1579 my $summary = $e->$search_method([{"distribution" => $sdist->id}]);
1581 my $cu_method = "update";
1584 $summary = $summary->[0];
1586 my $class = "Fieldmapper::serial::${type}_summary";
1587 $summary = $class->new;
1588 $summary->distribution($sdist->id);
1589 $cu_method = "create";
1592 if (@$formatted_parts) {
1593 $summary->generated_coverage(OpenSRF::Utils::JSON->perl2JSON($formatted_parts));
1595 # we had no issuances or MFHD data for this type, so clear any
1596 # generated data which may have existed before
1597 $summary->generated_coverage('');
1599 my $method = "${cu_method}_serial_${type}_summary";
1600 return $e->die_event unless $e->$method($summary);
1604 __PACKAGE__->register_method(
1605 method => 'regen_summaries',
1606 api_name => 'open-ils.serial.regenerate_summaries',
1610 'desc' => 'Regenerate all the generated_coverage fields for given distributions or subscriptions (depending on params given). Params are expected to be hash members.',
1612 name => 'sdist_ids',
1613 desc => 'IDs of the distribution whose coverage you want to regenerate',
1618 desc => 'IDs of the subscriptions whose coverage you want to regenerate',
1623 desc => 'Returns undef if successful, event if failed',
1626 #TODO: best practices for return values
1630 sub regen_summaries {
1631 my ($self, $conn, $auth, $opts) = @_;
1633 my $e = new_editor("authtoken" => $auth, "xact" => 1);
1634 return $e->die_event unless $e->checkauth;
1635 # Perm checks not necessary since generated_coverage is akin to
1636 # caching of data, not actual editing. XXX This might need more
1638 #return $editor->die_event unless $editor->allowed("RECEIVE_SERIAL");
1640 my $evt = _regenerate_summaries($e, $opts);
1641 if ($U->event_code($evt)) {
1651 sub _regenerate_summaries {
1652 my ($e, $opts) = @_;
1654 $logger->debug('_regenerate_summaries with opts: ' . OpenSRF::Utils::JSON->perl2JSON($opts));
1656 if ($opts->{'ssub_ids'}) {
1657 foreach my $ssub_id (@{$opts->{'ssub_ids'}}) {
1658 my $sdist_ids_temp = $e->search_serial_distribution(
1659 { 'subscription' => $ssub_id },
1662 push(@sdist_ids, @$sdist_ids_temp);
1664 } elsif ($opts->{'sdist_ids'}) {
1665 @sdist_ids = @$opts->{'sdist_ids'};
1668 foreach my $sdist_id (@sdist_ids) {
1670 my $sdist = $e->retrieve_serial_distribution($sdist_id)
1671 or return $e->die_event;
1673 # See large comment below
1674 # my $has_merged_mfhd;
1675 foreach my $type (@MFHD_NAMES) {
1677 my $issuances = $e->search_serial_issuance([
1679 "+sdist" => {"id" => $sdist_id},
1680 "+sitem" => {"status" => "Received"},
1681 "+scap" => {"type" => $type}
1688 "join" => {"sdist" =>{}}
1692 "siss" => "date_published"
1695 ]) or return $e->die_event;
1697 # This level of nuance doesn't appear to be necessary.
1698 # At the moment, we pass down an empty issuance list,
1699 # and the inner methods will "do the right thing" and
1700 # pull in the MFHD if called for, but in some cases not
1701 # ultimately generate any coverage. The code below is
1702 # broken in cases where we delete the last issuance, since
1703 # the now empty summary never gets updated.
1705 # Leaving this code for now (2014/04) in case pushing
1706 # the logic down ends up being too slow or complicates
1707 # the inner methods beyond their scope.
1709 # if (!@$issuances and !$has_merged_mfhd) {
1710 # if (!defined($has_merged_mfhd)) {
1711 # # even without issuances, we can generate a summary
1712 # # from a merged MFHD record, so look for one
1713 # my $mfhd_ids = $e->search_serial_record_entry(
1716 # 'id' => $sdist_id,
1717 # 'summary_method' => 'merge_with_sre'
1721 # 'join' => { 'sdist' => {} },
1725 # if ($mfhd_ids and @$mfhd_ids) {
1726 # $has_merged_mfhd = 1;
1731 # next; # abort to prevent empty summary creation (i.e. '[]')
1734 my $evt = _prepare_summaries($e, $issuances, $sdist, $type);
1735 if ($U->event_code($evt)) {
1745 sub _unit_by_iss_and_str {
1746 my ($e, $issuance, $stream) = @_;
1748 my $unit = $e->json_query({
1749 "select" => {"sunit" => ["id"]},
1750 "from" => {"sitem" => {"sunit" => {}}},
1753 "issuance" => $issuance->id,
1754 "stream" => $stream->id
1757 }) or return $e->die_event;
1758 return 0 if not @$unit;
1760 $e->retrieve_serial_unit($unit->[0]->{"id"}) or $e->die_event;
1763 sub move_previous_unit {
1764 my ($e, $prev_iss, $curr_item, $new_loc) = @_;
1766 my $prev_unit = _unit_by_iss_and_str($e,$prev_iss,$curr_item->stream);
1767 return $prev_unit if defined $U->event_code($prev_unit);
1768 return 0 if not $prev_unit;
1770 if ($prev_unit->location != $new_loc) {
1771 $prev_unit->location($new_loc);
1772 $e->update_serial_unit($prev_unit) or return $e->die_event;
1777 # _previous_issuance() assumes $existing is an ordered array
1778 sub _previous_issuance {
1779 my ($existing, $issuance) = @_;
1781 my $last = $existing->[-1];
1782 return undef unless $last;
1783 return ($last->id == $issuance->id ? $existing->[-2] : $last);
1786 __PACKAGE__->register_method(
1787 "method" => "receive_items_one_unit_per",
1788 "api_name" => "open-ils.serial.receive_items.one_unit_per",
1793 "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",
1797 "desc" => "authtoken",
1802 "desc" => "array of serial items, possibly fleshed with units and definitely fleshed with stream->distribution",
1807 "desc" => "id of bib record these items are associated with
1808 (XXX could/should be derived from items)",
1813 "desc" => "The item ID for each item successfully received",
1819 sub receive_items_one_unit_per {
1820 # XXX This function may be temporary, as it does some of what
1821 # unitize_items() does, just in a different way.
1822 my ($self, $client, $auth, $items, $record) = @_;
1824 my $e = new_editor("authtoken" => $auth, "xact" => 1);
1825 return $e->die_event unless $e->checkauth;
1826 return $e->die_event unless $e->allowed("RECEIVE_SERIAL");
1828 my $prev_loc_setting_map = {};
1829 my $user_id = $e->requestor->id;
1831 # Get a list of all the non-virtual field names in a serial::unit for
1832 # merging given unit objects with template-built units later.
1833 # XXX move this somewhere global so it isn't re-run all the time
1834 my $all_unit_fields =
1835 $Fieldmapper::fieldmap->{"Fieldmapper::serial::unit"}->{"fields"};
1836 my @real_unit_fields = grep {
1837 not $all_unit_fields->{$_}->{"virtual"}
1838 } keys %$all_unit_fields;
1840 foreach my $item (@$items) {
1841 # Note that we expect a certain fleshing on the items we're getting.
1842 my $sdist = $item->stream->distribution;
1844 # Fetch a list of issuances with received copies already existing
1845 # on this distribution (and with the same holding type on the
1846 # issuance). This will be used in up to two places: once when building
1847 # a summary, once when changing the copy location of the previous
1849 my $issuances_received = _issuances_received($e, $item);
1850 if ($U->event_code($issuances_received)) {
1852 return $issuances_received;
1855 # Find out if we need to to deal with previous copy location changing.
1856 my $ou = $sdist->holding_lib->id;
1857 unless (exists $prev_loc_setting_map->{$ou}) {
1858 $prev_loc_setting_map->{$ou} = $U->ou_ancestor_setting_value(
1859 $ou, "serial.prev_issuance_copy_location", $e
1863 # If there is a previous copy location setting, we need the previous
1864 # issuance, from which we can in turn look up the item attached to the
1865 # same stream we're on now.
1866 if ($prev_loc_setting_map->{$ou}) {
1868 _previous_issuance($issuances_received, $item->issuance)) {
1870 # Now we can change the copy location of the previous unit,
1872 return $e->event if defined $U->event_code(
1874 $e, $prev_iss, $item, $prev_loc_setting_map->{$ou}
1880 # Create unit if given by user
1881 if (ref $item->unit) {
1882 # detach from the item, as we need to create separately
1883 my $user_unit = $item->unit;
1885 # get a unit based on associated template
1886 my $template_unit = _build_unit($e, $sdist, "receive");
1887 if ($U->event_code($template_unit)) {
1889 $template_unit->{"note"} = "Item ID: " . $item->id;
1890 return $template_unit;
1893 # merge built unit with provided unit from user
1894 foreach (@real_unit_fields) {
1895 unless ($user_unit->$_) {
1896 $user_unit->$_($template_unit->$_);
1900 # Treat call number specially: the provided value from the
1901 # user will really be a string.
1902 my $call_number_string;
1903 if ($user_unit->call_number) {
1904 $call_number_string = $user_unit->call_number;
1905 # clear call number for now (replaced in _prepare_unit)
1906 $user_unit->clear_call_number;
1909 my $evt = _prepare_unit(
1910 $e, $user_unit, $sdist, [$item->issuance],
1911 $call_number_string, $record
1913 if ($U->event_code($evt)) {
1918 # create/update summary objects related to this distribution
1919 # Make sure @$issuances_received contains current item's issuance
1920 unless (grep { $_->id == $item->issuance->id } @$issuances_received) {
1921 push @$issuances_received, $item->issuance;
1923 $evt = _prepare_summaries($e, $issuances_received, $item->stream->distribution, $item->issuance->holding_type);
1924 if ($U->event_code($evt)) {
1929 # set the incontrovertibles on the unit
1930 $user_unit->edit_date("now");
1931 $user_unit->create_date("now");
1932 $user_unit->editor($user_id);
1933 $user_unit->creator($user_id);
1935 $evt = _create_sunit($e, $user_unit);
1936 return $evt if $evt;
1938 # save reference to new unit
1939 $item->unit($e->data->id);
1942 # Create notes if given by user
1943 if (ref($item->notes) and @{$item->notes}) {
1944 foreach my $note (@{$item->notes}) {
1945 $note->creator($user_id);
1946 $note->create_date("now");
1948 return $e->die_event unless $e->create_serial_item_note($note);
1951 $item->clear_notes; # They're saved; we no longer want them here.
1954 # Set the incontrovertibles on the item
1955 $item->status("Received");
1956 $item->date_received("now");
1957 $item->edit_date("now");
1958 $item->editor($user_id);
1960 return $e->die_event unless $e->update_serial_item($item);
1962 # send client a response
1963 $client->respond($item->id);
1966 $e->commit or return $e->die_event;
1974 #my $skip_call_number = shift;
1976 my $attr = $mode . '_unit_template';
1977 my $template = $editor->retrieve_asset_copy_template($sdist->$attr) or
1978 return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_COPY_TEMPLATE");
1980 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 );
1982 my $unit = new Fieldmapper::serial::unit;
1983 foreach my $part (@parts) {
1984 my $value = $template->$part;
1985 next if !defined($value);
1986 $unit->$part($value);
1989 # ignore circ_lib in template, set to distribution holding_lib
1990 $unit->circ_lib($sdist->holding_lib);
1991 $unit->creator($editor->requestor->id);
1992 $unit->editor($editor->requestor->id);
1994 # XXX: this feature has been pushed back until after 2.0 at least
1995 # unless ($skip_call_number) {
1996 # $attr = $mode . '_call_number';
1997 # my $cn = $sdist->$attr or
1998 # return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_CALL_NUMBER");
2000 # $unit->call_number($cn);
2002 $unit->call_number('-1'); # default to the dummy call number
2003 $unit->barcode('@@PLACEHOLDER'); # generic unit will start with a generated placeholder barcode
2004 $unit->sort_key('');
2005 $unit->summary_contents('');
2006 $unit->detailed_contents('');
2011 sub _summarize_contents {
2013 my $issuances = shift;
2017 # create or lookup MFHD record
2019 if ($sdist and defined($sdist->record_entry) and $sdist->summary_method eq 'merge_with_sre') {
2021 if (ref $sdist->record_entry) {
2022 $sre = $sdist->record_entry;
2024 $sre = $editor->retrieve_serial_record_entry($sdist->record_entry);
2026 $mfhd = MFHD->new(MARC::Record->new_from_xml($sre->marc));
2028 $logger->info($sdist);
2029 $mfhd = MFHD->new(MARC::Record->new());
2035 # We keep track of these separately to avoid link_id contamination,
2036 # e.g. a basic issuance, followed by a merging supplement, followed by
2037 # another basic. If we could be sure that they were not mixed, one
2038 # value could suffice.
2039 my %link_ids = ('basic' => 10000, 'index' => 10000, 'supplement' => 10000);
2040 my %first_scap = ('basic' => 1, 'index' => 1, 'supplement' => 1);
2041 foreach my $issuance (@$issuances) {
2042 my $scap_id = $issuance->caption_and_pattern;
2043 next if (!$scap_id); # skip issuances with no caption/pattern
2047 # if this is the first appearance of this scap, retrieve it and add it to the temporary record
2048 if (!exists $scaps{$issuance->caption_and_pattern}) {
2049 $scaps{$scap_id} = $editor->retrieve_serial_caption_and_pattern($scap_id);
2050 $scap = $scaps{$scap_id};
2051 $scap_field = _revive_caption($scap);
2053 if ($first_scap{$scap->type}) { # special merge processing
2054 $first_scap{$MFHD_TAGS_BY_NAME{$scap->type}} = 0;
2055 if ($sdist and $sdist->summary_method eq 'merge_with_sre') {
2056 # MFHD Caption objects do not yet have a built-in compare (TODO), so let's do a basic one
2057 my @field_85xs = $mfhd->field($MFHD_TAGS_BY_NAME{$scap->type});
2059 my $last_caption_field = $field_85xs[-1];
2060 my $last_link_id = $last_caption_field->subfield('8');
2061 # set the link id to match, temporarily, for comparison
2062 $last_caption_field->update('8' => $scap_field->subfield('8'));
2063 my $last_caption_json = OpenSRF::Utils::JSON->perl2JSON([$last_caption_field->indicator(1), $last_caption_field->indicator(2), $last_caption_field->subfields_list]);
2064 if ($last_caption_json eq $scap->pattern_code) { # merge is possible, they match
2066 $link_ids{$scap->type} = $last_link_id;
2067 # set scap_field to last field
2068 $scap_field = $last_caption_field;
2074 $scap_fields{$scap_id} = $scap_field;
2075 $scap_field->update('8' => $link_ids{$scap->type});
2076 # TODO: make MFHD/Caption smarter about this
2077 $scap_field->{_mfhdc_LINK_ID} = $link_ids{$scap->type};
2078 $mfhd->append_fields($scap_field) if !$did_merge;
2079 $link_ids{$scap->type}++;
2081 $scap_field = $scap_fields{$scap_id};
2084 $mfhd->append_fields(_revive_holding($issuance->holding_code, $scap_field, $seqno));
2088 my @formatted_parts;
2089 my @scap_fields_ordered = $mfhd->field($MFHD_TAGS_BY_NAME{$type});
2091 foreach my $scap_field (@scap_fields_ordered) { #TODO: use generic MFHD "summarize" method, once available
2092 my @updated_holdings;
2094 @updated_holdings = $mfhd->get_combined_holdings($scap_field);
2097 my $msg = "get_combined_holdings(): $@ ; using sdist ID #" .
2098 ($sdist ? $sdist->id : "<NONE>") . " and " .
2099 scalar(@$issuances) . " issuances, of which one has ID #" .
2100 $issuances->[0]->id;
2103 $logger->error($msg);
2104 return new OpenILS::Event("BAD_PARAMS", note => $msg);
2107 push @formatted_parts, map { $_->format } @updated_holdings;
2110 return ($mfhd, \@formatted_parts);
2113 ##########################################################################
2116 __PACKAGE__->register_method(
2117 method => 'fetch_notes',
2118 api_name => 'open-ils.serial.item_note.retrieve.all',
2120 Returns an array of copy note objects.
2121 @param args A named hash of parameters including:
2122 authtoken : Required if viewing non-public notes
2123 item_id : The id of the item whose notes we want to retrieve
2124 pub : True if all the caller wants are public notes
2125 @return An array of note objects
2129 __PACKAGE__->register_method(
2130 method => 'fetch_notes',
2131 api_name => 'open-ils.serial.subscription_note.retrieve.all',
2133 Returns an array of copy note objects.
2134 @param args A named hash of parameters including:
2135 authtoken : Required if viewing non-public notes
2136 subscription_id : The id of the item whose notes we want to retrieve
2137 pub : True if all the caller wants are public notes
2138 @return An array of note objects
2142 __PACKAGE__->register_method(
2143 method => 'fetch_notes',
2144 api_name => 'open-ils.serial.distribution_note.retrieve.all',
2146 Returns an array of copy note objects.
2147 @param args A named hash of parameters including:
2148 authtoken : Required if viewing non-public notes
2149 distribution_id : The id of the item whose notes we want to retrieve
2150 pub : True if all the caller wants are public notes
2151 @return An array of note objects
2155 # TODO: revisit this method to consider replacing cstore direct calls
2157 my( $self, $connection, $args ) = @_;
2159 $self->api_name =~ /serial\.(\w*)_note/;
2162 my $id = $$args{object_id};
2163 my $authtoken = $$args{authtoken};
2164 my $order_by = $$args{order_by} || 'create_date';
2168 return $U->cstorereq(
2169 'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic',
2170 { $type => $id, pub => 't' }, {'order_by' => {$FM_NAME_TO_ID{$type}.'n' => $order_by}} );
2172 # FIXME: restore perm check
2173 # ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
2174 # return $evt if $evt;
2175 return $U->cstorereq(
2176 'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic', {$type => $id}, {'order_by' => {$FM_NAME_TO_ID{$type}.'n' => $order_by}} );
2182 __PACKAGE__->register_method(
2183 method => 'update_note',
2184 api_name => 'open-ils.serial.item_note.update',
2186 Updates or creates an item note
2187 @param authtoken The login session key
2188 @param note The note object to update or create
2189 @return The id of the note object
2193 __PACKAGE__->register_method(
2194 method => 'update_note',
2195 api_name => 'open-ils.serial.subscription_note.update',
2197 Updates or creates a subscription note
2198 @param authtoken The login session key
2199 @param note The note object to update or create
2200 @return The id of the note object
2204 __PACKAGE__->register_method(
2205 method => 'update_note',
2206 api_name => 'open-ils.serial.distribution_note.update',
2208 Updates or creates a distribution note
2209 @param authtoken The login session key
2210 @param note The note object to update or create
2211 @return The id of the note object
2216 my( $self, $connection, $authtoken, $note ) = @_;
2218 $self->api_name =~ /serial\.(\w*)_note/;
2221 my $e = new_editor(xact=>1, authtoken=>$authtoken);
2222 return $e->event unless $e->checkauth;
2224 if ($type eq 'item') {
2225 my $sitem = $e->retrieve_serial_item([
2227 "flesh" => 2, "flesh_fields" => {
2228 "sitem" => ["stream"], "sstr" => ["distribution"]
2231 ]) or return $e->die_event;
2233 return $e->die_event unless $e->allowed(
2234 "ADMIN_SERIAL_ITEM", $sitem->stream->distribution->holding_lib
2236 } elsif ($type eq 'distribution') {
2237 my $sdist = $e->retrieve_serial_distribution($note->distribution)
2238 or return $e->die_event;
2240 return $e->die_event unless
2241 $e->allowed("ADMIN_SERIAL_DISTRIBUTION", $sdist->holding_lib);
2242 } else { # subscription
2243 my $sub = $e->retrieve_serial_subscription($note->subscription)
2244 or return $e->die_event;
2246 return $e->die_event unless
2247 $e->allowed("ADMIN_SERIAL_SUBSCRIPTION", $sub->owning_lib);
2250 $note->pub( ($U->is_true($note->pub)) ? 't' : 'f' );
2253 $note->create_date('now');
2254 $note->creator($e->requestor->id);
2256 $method = "create_serial_${type}_note";
2258 $method = "update_serial_${type}_note";
2260 $e->$method($note) or return $e->event;
2265 __PACKAGE__->register_method(
2266 method => 'delete_note',
2267 api_name => 'open-ils.serial.item_note.delete',
2269 Deletes an existing item note
2270 @param authtoken The login session key
2271 @param noteid The id of the note to delete
2272 @return 1 on success - Event otherwise.
2276 __PACKAGE__->register_method(
2277 method => 'delete_note',
2278 api_name => 'open-ils.serial.subscription_note.delete',
2280 Deletes an existing subscription note
2281 @param authtoken The login session key
2282 @param noteid The id of the note to delete
2283 @return 1 on success - Event otherwise.
2287 __PACKAGE__->register_method(
2288 method => 'delete_note',
2289 api_name => 'open-ils.serial.distribution_note.delete',
2291 Deletes an existing distribution note
2292 @param authtoken The login session key
2293 @param noteid The id of the note to delete
2294 @return 1 on success - Event otherwise.
2299 my( $self, $conn, $authtoken, $noteid ) = @_;
2301 $self->api_name =~ /serial\.(\w*)_note/;
2304 my $e = new_editor(xact=>1, authtoken=>$authtoken);
2305 return $e->die_event unless $e->checkauth;
2307 my $method = "retrieve_serial_${type}_note";
2308 my $note = $e->$method([
2310 ]) or return $e->die_event;
2312 if ($type eq 'item') {
2313 my $sitem = $e->retrieve_serial_item([
2315 "flesh" => 2, "flesh_fields" => {
2316 "sitem" => ["stream"], "sstr" => ["distribution"]
2319 ]) or return $e->die_event;
2321 return $e->die_event unless $e->allowed(
2322 "ADMIN_SERIAL_ITEM", $sitem->stream->distribution->holding_lib
2324 } elsif ($type eq 'distribution') {
2325 my $sdist = $e->retrieve_serial_distribution($note->distribution)
2326 or return $e->die_event;
2328 return $e->die_event unless
2329 $e->allowed("ADMIN_SERIAL_DISTRIBUTION", $sdist->holding_lib);
2330 } else { # subscription
2331 my $sub = $e->retrieve_serial_subscription($note->subscription)
2332 or return $e->die_event;
2334 return $e->die_event unless
2335 $e->allowed("ADMIN_SERIAL_SUBSCRIPTION", $sub->owning_lib);
2338 $method = "delete_serial_${type}_note";
2339 $e->$method($note) or return $e->die_event;
2345 ##########################################################################
2346 # subscription methods
2348 __PACKAGE__->register_method(
2349 method => 'fleshed_ssub_alter',
2350 api_name => 'open-ils.serial.subscription.fleshed.batch.update',
2354 desc => 'Receives an array of one or more subscriptions and updates the database as needed',
2356 name => 'authtoken',
2357 desc => 'Authtoken for current user session',
2361 name => 'subscriptions',
2362 desc => 'Array of fleshed subscriptions',
2368 desc => 'Returns 1 if successful, event if failed',
2374 sub fleshed_ssub_alter {
2375 my( $self, $conn, $auth, $ssubs ) = @_;
2376 return 1 unless ref $ssubs;
2377 my( $reqr, $evt ) = $U->checkses($auth);
2378 return $evt if $evt;
2379 my $editor = new_editor(requestor => $reqr, xact => 1);
2380 my $override = $self->api_name =~ /override/;
2382 for my $ssub (@$ssubs) {
2383 my $owning_lib_id = ref $ssub->owning_lib ? $ssub->owning_lib->id : $ssub->owning_lib;
2384 return $editor->die_event unless
2385 $editor->allowed("ADMIN_SERIAL_SUBSCRIPTION", $owning_lib_id);
2387 my $ssubid = $ssub->id;
2389 if( $ssub->isdeleted ) {
2390 $evt = _delete_ssub( $editor, $override, $ssub);
2391 } elsif( $ssub->isnew ) {
2392 _cleanse_dates($ssub, ['start_date','end_date']);
2393 $evt = _create_ssub( $editor, $ssub );
2395 _cleanse_dates($ssub, ['start_date','end_date']);
2396 $evt = _update_ssub( $editor, $override, $ssub );
2401 $logger->info("fleshed subscription-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2405 $logger->debug("subscription-alter: done updating subscription batch");
2407 $logger->info("fleshed subscription-alter successfully updated ".scalar(@$ssubs)." subscriptions");
2412 my ($editor, $override, $ssub) = @_;
2413 $logger->info("subscription-alter: delete subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
2414 my $sdists = $editor->search_serial_distribution(
2415 { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
2416 my $cps = $editor->search_serial_caption_and_pattern(
2417 { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
2418 my $sisses = $editor->search_serial_issuance(
2419 { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
2420 return OpenILS::Event->new(
2421 'SERIAL_SUBSCRIPTION_NOT_EMPTY', payload => $ssub->id ) if (@$sdists or @$cps or @$sisses);
2423 return $editor->event unless $editor->delete_serial_subscription($ssub);
2428 my ($editor, $ssub) = @_;
2430 $logger->info("subscription-alter: new subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
2431 return $editor->event unless $editor->create_serial_subscription($ssub);
2436 my ($editor, $override, $ssub) = @_;
2438 $logger->info("subscription-alter: retrieving subscription ".$ssub->id);
2439 my $orig_ssub = $editor->retrieve_serial_subscription($ssub->id);
2441 $logger->info("subscription-alter: original subscription ".OpenSRF::Utils::JSON->perl2JSON($orig_ssub));
2442 $logger->info("subscription-alter: updated subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
2443 return $editor->event unless $editor->update_serial_subscription($ssub);
2447 __PACKAGE__->register_method(
2448 method => "fleshed_serial_subscription_retrieve_batch",
2450 api_name => "open-ils.serial.subscription.fleshed.batch.retrieve"
2453 sub fleshed_serial_subscription_retrieve_batch {
2454 my( $self, $client, $ids ) = @_;
2455 # FIXME: permissions?
2456 $logger->info("Fetching fleshed subscriptions @$ids");
2457 return $U->cstorereq(
2458 "open-ils.cstore.direct.serial.subscription.search.atomic",
2461 flesh_fields => {ssub => [ qw/owning_lib notes/ ]}
2465 __PACKAGE__->register_method(
2466 method => "retrieve_sub_tree",
2468 api_name => "open-ils.serial.subscription_tree.retrieve"
2471 __PACKAGE__->register_method(
2472 method => "retrieve_sub_tree",
2473 api_name => "open-ils.serial.subscription_tree.global.retrieve"
2476 sub retrieve_sub_tree {
2478 my( $self, $client, $user_session, $docid, @org_ids ) = @_;
2480 if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
2484 # TODO: permission support
2485 if(!@org_ids and $user_session) {
2487 OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
2488 @org_ids = ($user_obj->home_ou);
2491 if( $self->api_name =~ /global/ ) {
2492 return _build_subs_list( { record_entry => $docid } ); # TODO: filter for !deleted, or active?
2497 for my $orgid (@org_ids) {
2498 my $subs = _build_subs_list(
2499 { record_entry => $docid, owning_lib => $orgid } );# TODO: filter for !deleted, or active?
2500 push( @all_subs, @$subs );
2509 sub _build_subs_list {
2510 my $search_hash = shift;
2512 #$search_hash->{deleted} = 'f';
2513 my $e = new_editor();
2515 my $subs = $e->search_serial_subscription([$search_hash, { 'order_by' => {'ssub' => 'id'} }]);
2519 for my $sub (@$subs) {
2521 # TODO: filter on !deleted?
2522 my $dists = $e->search_serial_distribution(
2523 [{ subscription => $sub->id }, { 'order_by' => {'sdist' => 'label'} }]
2526 #$dists = [ sort { $a->label cmp $b->label } @$dists ];
2528 $sub->distributions($dists);
2530 # TODO: filter on !deleted?
2531 my $issuances = $e->search_serial_issuance(
2532 [{ subscription => $sub->id }, { 'order_by' => {'siss' => 'label'} }]
2535 #$issuances = [ sort { $a->label cmp $b->label } @$issuances ];
2536 $sub->issuances($issuances);
2538 # TODO: filter on !deleted?
2539 my $scaps = $e->search_serial_caption_and_pattern(
2540 [{ subscription => $sub->id }, { 'order_by' => {'scap' => 'id'} }]
2543 #$scaps = [ sort { $a->id cmp $b->id } @$scaps ];
2544 $sub->scaps($scaps);
2545 push( @built_subs, $sub );
2548 return \@built_subs;
2552 __PACKAGE__->register_method(
2553 method => "subscription_orgs_for_title",
2555 api_name => "open-ils.serial.subscription.retrieve_orgs_by_title"
2558 sub subscription_orgs_for_title {
2559 my( $self, $client, $record_id ) = @_;
2561 my $subs = $U->simple_scalar_request(
2563 "open-ils.cstore.direct.serial.subscription.search.atomic",
2564 { record_entry => $record_id }); # TODO: filter on !deleted?
2566 my $orgs = { map {$_->owning_lib => 1 } @$subs };
2567 return [ keys %$orgs ];
2571 ##########################################################################
2572 # distribution methods
2574 __PACKAGE__->register_method(
2575 method => 'fleshed_sdist_alter',
2576 api_name => 'open-ils.serial.distribution.fleshed.batch.update',
2580 desc => 'Receives an array of one or more distributions and updates the database as needed',
2582 name => 'authtoken',
2583 desc => 'Authtoken for current user session',
2587 name => 'distributions',
2588 desc => 'Array of fleshed distributions',
2594 desc => 'Returns 1 if successful, event if failed',
2600 sub fleshed_sdist_alter {
2601 my( $self, $conn, $auth, $sdists ) = @_;
2602 return 1 unless ref $sdists;
2603 my( $reqr, $evt ) = $U->checkses($auth);
2604 return $evt if $evt;
2605 my $editor = new_editor(requestor => $reqr, xact => 1);
2606 my $override = $self->api_name =~ /override/;
2608 for my $sdist (@$sdists) {
2609 my $holding_lib_id = ref $sdist->holding_lib ? $sdist->holding_lib->id : $sdist->holding_lib;
2610 return $editor->die_event unless
2611 $editor->allowed("ADMIN_SERIAL_DISTRIBUTION", $holding_lib_id);
2613 if( $sdist->isdeleted ) {
2614 $evt = _delete_sdist( $editor, $override, $sdist);
2615 } elsif( $sdist->isnew ) {
2616 $evt = _create_sdist( $editor, $sdist );
2618 $evt = _update_sdist( $editor, $override, $sdist );
2623 $logger->info("fleshed distribution-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2627 $logger->debug("distribution-alter: done updating distribution batch");
2629 $logger->info("fleshed distribution-alter successfully updated ".scalar(@$sdists)." distributions");
2634 my ($editor, $override, $sdist) = @_;
2635 $logger->info("distribution-alter: delete distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
2636 return $editor->event unless $editor->delete_serial_distribution($sdist);
2641 my ($editor, $sdist) = @_;
2643 $logger->info("distribution-alter: new distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
2644 return $editor->event unless $editor->create_serial_distribution($sdist);
2646 # create summaries too
2647 my $summary = new Fieldmapper::serial::basic_summary;
2648 $summary->distribution($sdist->id);
2649 $summary->generated_coverage('');
2650 return $editor->event unless $editor->create_serial_basic_summary($summary);
2651 $summary = new Fieldmapper::serial::supplement_summary;
2652 $summary->distribution($sdist->id);
2653 $summary->generated_coverage('');
2654 return $editor->event unless $editor->create_serial_supplement_summary($summary);
2655 $summary = new Fieldmapper::serial::index_summary;
2656 $summary->distribution($sdist->id);
2657 $summary->generated_coverage('');
2658 return $editor->event unless $editor->create_serial_index_summary($summary);
2660 # create a starter stream (TODO: reconsider this)
2661 my $stream = new Fieldmapper::serial::stream;
2662 $stream->distribution($sdist->id);
2663 return $editor->event unless $editor->create_serial_stream($stream);
2669 my ($editor, $override, $sdist) = @_;
2671 $logger->info("distribution-alter: retrieving distribution ".$sdist->id);
2672 my $orig_sdist = $editor->retrieve_serial_distribution($sdist->id);
2674 $logger->info("distribution-alter: original distribution ".OpenSRF::Utils::JSON->perl2JSON($orig_sdist));
2675 $logger->info("distribution-alter: updated distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
2676 return $editor->event unless $editor->update_serial_distribution($sdist);
2680 __PACKAGE__->register_method(
2681 method => "fleshed_serial_distribution_retrieve_batch",
2683 api_name => "open-ils.serial.distribution.fleshed.batch.retrieve"
2686 sub fleshed_serial_distribution_retrieve_batch {
2687 my( $self, $client, $ids ) = @_;
2688 # FIXME: permissions?
2689 $logger->info("Fetching fleshed distributions @$ids");
2690 return $U->cstorereq(
2691 "open-ils.cstore.direct.serial.distribution.search.atomic",
2694 flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams notes / ]}
2698 __PACKAGE__->register_method(
2699 method => "retrieve_dist_tree",
2701 api_name => "open-ils.serial.distribution_tree.retrieve"
2704 __PACKAGE__->register_method(
2705 method => "retrieve_dist_tree",
2706 api_name => "open-ils.serial.distribution_tree.global.retrieve"
2709 sub retrieve_dist_tree {
2710 my( $self, $client, $user_session, $docid, @org_ids ) = @_;
2712 if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
2716 # TODO: permission support
2717 if(!@org_ids and $user_session) {
2719 OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
2720 @org_ids = ($user_obj->home_ou);
2723 my $e = new_editor();
2725 if( $self->api_name =~ /global/ ) {
2726 return $e->search_serial_distribution([{'+ssub' => { record_entry => $docid }},
2728 flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams basic_summary supplement_summary index_summary / ]},
2729 order_by => {'sdist' => 'id'},
2730 'join' => {'ssub' => {}}
2732 ]); # TODO: filter for !deleted?
2736 for my $orgid (@org_ids) {
2737 my $dists = $e->search_serial_distribution([{'+ssub' => { record_entry => $docid }, holding_lib => $orgid},
2739 flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams basic_summary supplement_summary index_summary / ]},
2740 order_by => {'sdist' => 'id'},
2741 'join' => {'ssub' => {}}
2743 ]); # TODO: filter for !deleted?
2744 push( @all_dists, @$dists ) if $dists;
2754 __PACKAGE__->register_method(
2755 method => "distribution_orgs_for_title",
2757 api_name => "open-ils.serial.distribution.retrieve_orgs_by_title"
2760 sub distribution_orgs_for_title {
2761 my( $self, $client, $record_id ) = @_;
2763 my $dists = $U->cstorereq(
2764 "open-ils.cstore.direct.serial.distribution.search.atomic",
2765 { '+ssub' => { record_entry => $record_id } },
2766 { 'join' => {'ssub' => {}} }); # TODO: filter on !deleted?
2768 my $orgs = { map {$_->holding_lib => 1 } @$dists };
2769 return [ keys %$orgs ];
2773 ##########################################################################
2774 # caption and pattern methods
2776 __PACKAGE__->register_method(
2777 method => 'scap_alter',
2778 api_name => 'open-ils.serial.caption_and_pattern.batch.update',
2782 desc => 'Receives an array of one or more caption and patterns and updates the database as needed',
2784 name => 'authtoken',
2785 desc => 'Authtoken for current user session',
2790 desc => 'Array of caption and patterns',
2796 desc => 'Returns 1 if successful, event if failed',
2803 my( $self, $conn, $auth, $scaps ) = @_;
2804 return 1 unless ref $scaps;
2805 my( $reqr, $evt ) = $U->checkses($auth);
2806 return $evt if $evt;
2807 my $editor = new_editor(requestor => $reqr, xact => 1);
2808 my $override = $self->api_name =~ /override/;
2811 for my $scap (@$scaps) {
2812 if (!exists($found_ssub_ids{$scap->subscription})) {
2813 my $ssub = $editor->retrieve_serial_subscription($scap->subscription) or return $editor->die_event;
2814 return $editor->die_event unless
2815 $editor->allowed("ADMIN_SERIAL_CAPTION_PATTERN", $ssub->owning_lib);
2816 $found_ssub_ids{$scap->subscription} = 1;
2819 if( $scap->isdeleted ) {
2820 $evt = _delete_scap( $editor, $override, $scap);
2821 } elsif( $scap->isnew ) {
2822 $evt = _create_scap( $editor, $scap );
2824 $evt = _update_scap( $editor, $override, $scap );
2829 $logger->info("caption_and_pattern-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2833 $logger->debug("caption_and_pattern-alter: done updating caption_and_pattern batch");
2835 $logger->info("caption_and_pattern-alter successfully updated ".scalar(@$scaps)." caption_and_patterns");
2840 my ($editor, $override, $scap) = @_;
2841 $logger->info("caption_and_pattern-alter: delete caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2842 my $sisses = $editor->search_serial_issuance(
2843 { caption_and_pattern => $scap->id }, { limit => 1 } ); #TODO: 'deleted' support?
2844 return OpenILS::Event->new(
2845 'SERIAL_CAPTION_AND_PATTERN_HAS_ISSUANCES', payload => $scap->id ) if (@$sisses);
2847 return $editor->event unless $editor->delete_serial_caption_and_pattern($scap);
2852 my ($editor, $scap) = @_;
2854 $logger->info("caption_and_pattern-alter: new caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2855 return $editor->event unless $editor->create_serial_caption_and_pattern($scap);
2860 my ($editor, $override, $scap) = @_;
2862 $logger->info("caption_and_pattern-alter: retrieving caption_and_pattern ".$scap->id);
2863 my $orig_scap = $editor->retrieve_serial_caption_and_pattern($scap->id);
2865 $logger->info("caption_and_pattern-alter: original caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($orig_scap));
2866 $logger->info("caption_and_pattern-alter: updated caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2867 return $editor->event unless $editor->update_serial_caption_and_pattern($scap);
2871 __PACKAGE__->register_method(
2872 method => "serial_caption_and_pattern_retrieve_batch",
2874 api_name => "open-ils.serial.caption_and_pattern.batch.retrieve"
2877 sub serial_caption_and_pattern_retrieve_batch {
2878 my( $self, $client, $ids ) = @_;
2879 $logger->info("Fetching caption_and_patterns @$ids");
2880 return $U->cstorereq(
2881 "open-ils.cstore.direct.serial.caption_and_pattern.search.atomic",
2886 ##########################################################################
2889 __PACKAGE__->register_method(
2890 method => 'sstr_alter',
2891 api_name => 'open-ils.serial.stream.batch.update',
2895 desc => 'Receives an array of one or more streams and updates the database as needed',
2897 name => 'authtoken',
2898 desc => 'Authtoken for current user session',
2903 desc => 'Array of streams',
2909 desc => 'Returns 1 if successful, event if failed',
2916 my( $self, $conn, $auth, $sstrs ) = @_;
2917 return 1 unless ref $sstrs;
2918 my( $reqr, $evt ) = $U->checkses($auth);
2919 return $evt if $evt;
2920 my $editor = new_editor(requestor => $reqr, xact => 1);
2921 my $override = $self->api_name =~ /override/;
2923 my %found_sdist_ids;
2924 for my $sstr (@$sstrs) {
2925 if (!exists($found_sdist_ids{$sstr->distribution})) {
2926 my $sdist = $editor->retrieve_serial_distribution($sstr->distribution) or return $editor->die_event;
2927 return $editor->die_event unless
2928 $editor->allowed("ADMIN_SERIAL_STREAM", $sdist->holding_lib);
2929 $found_sdist_ids{$sstr->distribution} = 1;
2932 if( $sstr->isdeleted ) {
2933 $evt = _delete_sstr( $editor, $override, $sstr);
2934 } elsif( $sstr->isnew ) {
2935 $evt = _create_sstr( $editor, $sstr );
2937 $evt = _update_sstr( $editor, $override, $sstr );
2942 $logger->info("stream-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2946 $logger->debug("stream-alter: done updating stream batch");
2948 $logger->info("stream-alter successfully updated ".scalar(@$sstrs)." streams");
2953 my ($editor, $override, $sstr) = @_;
2954 $logger->info("stream-alter: delete stream ".OpenSRF::Utils::JSON->perl2JSON($sstr));
2955 my $sitems = $editor->search_serial_item(
2956 { stream => $sstr->id }, { limit => 1 } ); #TODO: 'deleted' support?
2957 return OpenILS::Event->new(
2958 'SERIAL_STREAM_HAS_ITEMS', payload => $sstr->id ) if (@$sitems);
2960 return $editor->event unless $editor->delete_serial_stream($sstr);
2965 my ($editor, $sstr) = @_;
2967 $logger->info("stream-alter: new stream ".OpenSRF::Utils::JSON->perl2JSON($sstr));
2968 return $editor->event unless $editor->create_serial_stream($sstr);
2973 my ($editor, $override, $sstr) = @_;
2975 $logger->info("stream-alter: retrieving stream ".$sstr->id);
2976 my $orig_sstr = $editor->retrieve_serial_stream($sstr->id);
2978 $logger->info("stream-alter: original stream ".OpenSRF::Utils::JSON->perl2JSON($orig_sstr));
2979 $logger->info("stream-alter: updated stream ".OpenSRF::Utils::JSON->perl2JSON($sstr));
2980 return $editor->event unless $editor->update_serial_stream($sstr);
2984 __PACKAGE__->register_method(
2985 method => "serial_stream_retrieve_batch",
2987 api_name => "open-ils.serial.stream.batch.retrieve"
2990 sub serial_stream_retrieve_batch {
2991 my( $self, $client, $ids ) = @_;
2992 $logger->info("Fetching streams @$ids");
2993 return $U->cstorereq(
2994 "open-ils.cstore.direct.serial.stream.search.atomic",
3000 ##########################################################################
3003 __PACKAGE__->register_method(
3004 method => 'sum_alter',
3005 api_name => 'open-ils.serial.basic_summary.batch.update',
3009 desc => 'Receives an array of one or more summaries and updates the database as needed',
3011 name => 'authtoken',
3012 desc => 'Authtoken for current user session',
3017 desc => 'Array of basic summaries',
3023 desc => 'Returns 1 if successful, event if failed',
3029 __PACKAGE__->register_method(
3030 method => 'sum_alter',
3031 api_name => 'open-ils.serial.supplement_summary.batch.update',
3035 desc => 'Receives an array of one or more summaries and updates the database as needed',
3037 name => 'authtoken',
3038 desc => 'Authtoken for current user session',
3043 desc => 'Array of supplement summaries',
3049 desc => 'Returns 1 if successful, event if failed',
3055 __PACKAGE__->register_method(
3056 method => 'sum_alter',
3057 api_name => 'open-ils.serial.index_summary.batch.update',
3061 desc => 'Receives an array of one or more summaries and updates the database as needed',
3063 name => 'authtoken',
3064 desc => 'Authtoken for current user session',
3069 desc => 'Array of index summaries',
3075 desc => 'Returns 1 if successful, event if failed',
3082 my( $self, $conn, $auth, $sums ) = @_;
3083 return 1 unless ref $sums;
3085 $self->api_name =~ /serial\.(\w*)_summary/;
3088 my( $reqr, $evt ) = $U->checkses($auth);
3089 return $evt if $evt;
3090 my $editor = new_editor(requestor => $reqr, xact => 1);
3091 my $override = $self->api_name =~ /override/;
3093 my %found_sdist_ids;
3094 for my $sum (@$sums) {
3095 if (!exists($found_sdist_ids{$sum->distribution})) {
3096 my $sdist = $editor->retrieve_serial_distribution($sum->distribution) or return $editor->die_event;
3097 return $editor->die_event unless
3098 $editor->allowed("ADMIN_SERIAL_DISTRIBUTION", $sdist->holding_lib);
3099 $found_sdist_ids{$sum->distribution} = 1;
3102 # XXX: (for now, at least) summaries should be created/deleted by the distribution functions
3103 if( $sum->isdeleted ) {
3104 $evt = OpenILS::Event->new('SERIAL_SUMMARIES_NOT_INDEPENDENT');
3105 } elsif( $sum->isnew ) {
3106 $evt = OpenILS::Event->new('SERIAL_SUMMARIES_NOT_INDEPENDENT');
3108 $evt = _update_sum( $editor, $override, $sum, $type );
3113 $logger->info("${type}_summary-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
3117 $logger->debug("${type}_summary-alter: done updating ${type}_summary batch");
3119 $logger->info("${type}_summary-alter successfully updated ".scalar(@$sums)." ${type}_summaries");
3124 my ($editor, $override, $sum, $type) = @_;
3126 $logger->info("${type}_summary-alter: retrieving ${type}_summary ".$sum->id);
3127 my $retrieve_method = "retrieve_serial_${type}_summary";
3128 my $orig_sum = $editor->$retrieve_method($sum->id);
3130 $logger->info("${type}_summary-alter: original ${type}_summary ".OpenSRF::Utils::JSON->perl2JSON($orig_sum));
3131 $logger->info("${type}_summary-alter: updated ${type}_summary ".OpenSRF::Utils::JSON->perl2JSON($sum));
3132 my $update_method = "update_serial_${type}_summary";
3133 return $editor->event unless $editor->$update_method($sum);
3137 __PACKAGE__->register_method(
3138 method => "serial_summary_retrieve_batch",
3140 api_name => "open-ils.serial.basic_summary.batch.retrieve"
3143 __PACKAGE__->register_method(
3144 method => "serial_summary_retrieve_batch",
3146 api_name => "open-ils.serial.supplement_summary.batch.retrieve"
3149 __PACKAGE__->register_method(
3150 method => "serial_summary_retrieve_batch",
3152 api_name => "open-ils.serial.index_summary.batch.retrieve"
3155 sub serial_summary_retrieve_batch {
3156 my( $self, $client, $ids ) = @_;
3158 $self->api_name =~ /serial\.(\w*)_summary/;
3161 $logger->info("Fetching ${type}_summaries @$ids");
3162 return $U->cstorereq(
3163 "open-ils.cstore.direct.serial.".$type."_summary.search.atomic",
3169 ##########################################################################
3172 __PACKAGE__->register_method(
3173 "method" => "bre_by_identifier",
3174 "api_name" => "open-ils.serial.biblio.record_entry.by_identifier",
3177 "desc" => "Find instances of biblio.record_entry given a search token" .
3178 " that could be a value for any identifier defined in " .
3179 "config.metabib_field",
3181 {"desc" => "Search token", "type" => "string"},
3182 {"desc" => "Options: require_subscriptions, add_mvr, is_actual_id" .
3183 ", id_list (all boolean)", "type" => "object"}
3186 "desc" => "Any matching BREs, or if the add_mvr option is true, " .
3187 "objects with a 'bre' key/value pair, and an 'mvr' " .
3188 "key-value pair. BREs have subscriptions fleshed on.",
3194 sub bre_by_identifier {
3195 my ($self, $client, $term, $options) = @_;
3197 return new OpenILS::Event("BAD_PARAMS") unless $term;
3200 my $e = new_editor();
3204 if ($options->{"is_actual_id"}) {
3208 $e->search_config_metabib_field({"field_class" => "identifier"})
3209 or return $e->die_event;
3211 my @identifiers = map { $_->name } @$cmf;
3212 my $query = join(" || ", map { "id|$_: $term" } @identifiers);
3214 my $search = create OpenSRF::AppSession("open-ils.search");
3215 my $search_result = $search->request(
3216 "open-ils.search.biblio.multiclass.query.staff", {}, $query
3218 $search->disconnect;
3220 # Un-nest results. They tend to look like [[1],[2],[3]] for some reason.
3221 @ids = map { @{$_} } @{$search_result->{"ids"}};
3228 if ($options->{"id_list"}) {
3230 $client->respond($_) foreach (@ids);
3235 my $bre = $e->search_biblio_record_entry([
3237 "flesh" => 2, "flesh_fields" => {
3238 "bre" => ["subscriptions"],
3239 "ssub" => ["owning_lib"]
3242 ]) or return $e->die_event;
3244 if (@$bre && $options->{"require_subscriptions"}) {
3245 $bre = [ grep { @{$_->subscriptions} } @$bre ];
3250 if (@$bre) { # re-evaluate after possible grep
3251 if ($options->{"add_mvr"}) {
3253 {"bre" => $_, "mvr" => _get_mvr($_->id)}
3256 $client->respond($_) foreach (@$bre);
3263 __PACKAGE__->register_method(
3264 "method" => "get_items_by",
3265 "api_name" => "open-ils.serial.items.receivable.by_subscription",
3268 "desc" => "Return all receivable items under a given subscription",
3270 {"desc" => "Authtoken", "type" => "string"},
3271 {"desc" => "Subscription ID", "type" => "number"},
3274 "desc" => "All receivable items under a given subscription",
3275 "type" => "object", "class" => "sitem"
3280 __PACKAGE__->register_method(
3281 "method" => "get_items_by",
3282 "api_name" => "open-ils.serial.items.receivable.by_issuance",
3285 "desc" => "Return all receivable items under a given issuance",
3287 {"desc" => "Authtoken", "type" => "string"},
3288 {"desc" => "Issuance ID", "type" => "number"},
3291 "desc" => "All receivable items under a given issuance",
3292 "type" => "object", "class" => "sitem"
3297 __PACKAGE__->register_method(
3298 "method" => "get_items_by",
3299 "api_name" => "open-ils.serial.items.by_issuance",
3302 "desc" => "Return all items under a given issuance",
3304 {"desc" => "Authtoken", "type" => "string"},
3305 {"desc" => "Issuance ID", "type" => "number"},
3308 "desc" => "All items under a given issuance",
3309 "type" => "object", "class" => "sitem"
3315 my ($self, $client, $auth, $term, $opts) = @_;
3317 # Not to be used in the json_query, but after limiting by perm check.
3318 $opts = {} unless ref $opts eq "HASH";
3319 $opts->{"limit"} ||= 10000; # some existing users may want all results
3320 $opts->{"offset"} ||= 0;
3321 $opts->{"limit"} = int($opts->{"limit"});
3322 $opts->{"offset"} = int($opts->{"offset"});
3324 my $e = new_editor("authtoken" => $auth);
3325 return $e->die_event unless $e->checkauth;
3327 my $by = ($self->api_name =~ /by_(\w+)$/)[0];
3328 my $receivable = ($self->api_name =~ /receivable/);
3331 "issuance" => {"issuance" => $term},
3332 "subscription" => {"+siss" => {"subscription" => $term}}
3335 my $item_rows = $e->json_query(
3337 "select" => {"sitem" => ["id"], "sdist" => ["holding_lib"]},
3341 "sstr" => {"join" => {"sdist" => {}}}
3345 %{$where{$by}}, $receivable ? ("date_received" => undef) : ()
3347 "order_by" => {"sitem" => ["id"]}
3349 ) or return $e->die_event;
3351 return undef unless @$item_rows;
3355 foreach (@$item_rows) {
3356 last if $returned >= $opts->{"limit"};
3357 next unless $e->allowed("RECEIVE_SERIAL", $_->{"holding_lib"});
3358 if ($skipped < $opts->{"offset"}) {
3364 $e->retrieve_serial_item([
3368 "sitem" => [qw/stream issuance unit creator editor/],
3369 "sstr" => ["distribution"],
3370 "sdist" => ["holding_lib"]
3382 __PACKAGE__->register_method(
3383 "method" => "get_receivable_issuances",
3384 "api_name" => "open-ils.serial.issuances.receivable",
3387 "desc" => "Return all issuances with receivable items given " .
3388 "a subscription ID",
3390 {"desc" => "Authtoken", "type" => "string"},
3391 {"desc" => "Subscription ID", "type" => "number"},
3394 "desc" => "All issuances with receivable items " .
3395 "(but not the items themselves)", "type" => "object"
3400 sub get_receivable_issuances {
3401 my ($self, $client, $auth, $sub_id) = @_;
3403 my $e = new_editor("authtoken" => $auth);
3404 return $e->die_event unless $e->checkauth;
3408 my $issuance_ids = $e->json_query({
3411 {"transform" => "distinct", "column" => "id"},
3415 "from" => {"siss" => "sitem"},
3417 "subscription" => $sub_id,
3418 "+sitem" => {"date_received" => undef}
3421 "siss" => {"date_published" => {"direction" => "asc"}}
3424 }) or return $e->die_event;
3426 $client->respond($e->retrieve_serial_issuance($_->{"id"}))
3427 foreach (@$issuance_ids);
3434 __PACKAGE__->register_method(
3435 "method" => "get_routing_list_users",
3436 "api_name" => "open-ils.serial.routing_list_users.fleshed_and_ordered",
3439 "desc" => "Return all routing list users with reader fleshed " .
3440 "(with card and home_ou) for a given stream ID, sorted by pos",
3442 {"desc" => "Authtoken", "type" => "string"},
3443 {"desc" => "Stream ID (int or array of ints)", "type" => "mixed"},
3446 "desc" => "Stream of routing list users", "type" => "object",
3452 sub get_routing_list_users {
3453 my ($self, $client, $auth, $stream_id) = @_;
3455 my $e = new_editor("authtoken" => $auth);
3456 return $e->die_event unless $e->checkauth;
3458 my $users = $e->search_serial_routing_list_user([
3459 {"stream" => $stream_id}, {
3460 "order_by" => {"srlu" => "pos"},
3463 "srlu" => [qw/reader stream/],
3464 "au" => [qw/card home_ou mailing_address billing_address/],
3465 "sstr" => ["distribution"]
3468 ]) or return $e->die_event;
3470 return undef unless @$users;
3472 # The ADMIN_SERIAL_STREAM permission is used simply to avoid the
3473 # need for any new permission. The context OU will be the same
3474 # for every result of the above query, so we need only check once.
3475 return $e->die_event unless $e->allowed(
3476 "ADMIN_SERIAL_STREAM", $users->[0]->stream->distribution->holding_lib
3481 my @users = map { $_->stream($_->stream->id); $_ } @$users;
3482 @users = sort { $a->stream cmp $b->stream } @users if
3483 ref $stream_id eq "ARRAY";
3485 $client->respond($_) for @users;
3491 __PACKAGE__->register_method(
3492 "method" => "replace_routing_list_users",
3493 "api_name" => "open-ils.serial.routing_list_users.replace",
3495 "desc" => "Replace all routing list users on the specified streams " .
3496 "with those in the list argument",
3498 {"desc" => "Authtoken", "type" => "string"},
3499 {"desc" => "List of srlu objects", "type" => "array"},
3502 "desc" => "event on failure, undef on success"
3507 sub replace_routing_list_users {
3508 my ($self, $client, $auth, $users) = @_;
3510 return undef unless ref $users eq "ARRAY";
3512 if (grep { ref $_ ne "Fieldmapper::serial::routing_list_user" } @$users) {
3513 return new OpenILS::Event("BAD_PARAMS", "note" => "Only srlu objects");
3516 my $e = new_editor("authtoken" => $auth, "xact" => 1);
3517 return $e->die_event unless $e->checkauth;
3519 my %streams_ok = ();
3522 foreach my $user (@$users) {
3523 unless (exists $streams_ok{$user->stream}) {
3524 my $stream = $e->retrieve_serial_stream([
3527 "flesh_fields" => {"sstr" => ["distribution"]}
3529 ]) or return $e->die_event;
3531 "ADMIN_SERIAL_STREAM", $stream->distribution->holding_lib
3532 ) or return $e->die_event;
3534 my $to_delete = $e->search_serial_routing_list_user(
3535 {"stream" => $user->stream}
3536 ) or return $e->die_event;
3539 "Deleting srlu: [" .
3540 join(", ", map { $_->id; } @$to_delete) .
3544 foreach (@$to_delete) {
3545 $e->delete_serial_routing_list_user($_) or
3546 return $e->die_event;
3549 $streams_ok{$user->stream} = 1;
3552 next if $user->isdeleted;
3556 $e->create_serial_routing_list_user($user) or return $e->die_event;
3559 $e->commit or return $e->die_event;
3563 __PACKAGE__->register_method(
3564 "method" => "get_records_with_marc_85x",
3565 "api_name"=>"open-ils.serial.caption_and_pattern.find_legacy_by_bib_record",
3568 "desc" => "Return the specified BRE itself and/or any related SRE ".
3569 "whenever they have 853-855 tags",
3571 {"desc" => "Authtoken", "type" => "string"},
3572 {"desc" => "bib record ID", "type" => "number"},
3575 "desc" => "objects, either bre or sre", "type" => "object"
3580 sub get_records_with_marc_85x { # specifically, 853-855
3581 my ($self, $client, $auth, $bre_id) = @_;
3583 my $e = new_editor("authtoken" => $auth);
3584 return $e->die_event unless $e->checkauth;
3586 my $bre = $e->search_biblio_record_entry([
3587 {"id" => $bre_id, "deleted" => "f"}, {
3589 "flesh_fields" => {"bre" => [qw/creator editor owner/]}
3591 ]) or return $e->die_event;
3593 return undef unless @$bre;
3596 my $record = MARC::Record->new_from_xml($bre->marc);
3597 $client->respond($bre) if $record->field("85[3-5]");
3598 # XXX Is passing a regex to ->field() an abuse of MARC::Record ?
3600 my $sres = $e->search_serial_record_entry([
3601 {"record" => $bre_id, "deleted" => "f"}, {
3603 "flesh_fields" => {"sre" => [qw/creator editor owning_lib/]}
3605 ]) or return $e->die_event;
3609 foreach my $sre (@$sres) {
3610 $client->respond($sre) if
3611 MARC::Record->new_from_xml($sre->marc)->field("85[3-5]");
3617 __PACKAGE__->register_method(
3618 "method" => "create_scaps_from_marcxml",
3619 "api_name" => "open-ils.serial.caption_and_pattern.create_from_records",
3622 "desc" => "Create caption and pattern objects from 853-855 tags " .
3623 "in MARCXML documents",
3625 {"desc" => "Authtoken", "type" => "string"},
3626 {"desc" => "Subscription ID", "type" => "number"},
3627 {"desc" => "list of MARCXML documents as strings",
3631 "desc" => "Newly created caption and pattern objects",
3632 "type" => "object", "class" => "scap"
3637 sub create_scaps_from_marcxml {
3638 my ($self, $client, $auth, $sub_id, $docs) = @_;
3640 return undef unless ref $docs eq "ARRAY";
3642 my $e = new_editor("authtoken" => $auth, "xact" => 1);
3643 return $e->die_event unless $e->checkauth;
3645 # Retrieve the subscription just for perm checking (whether we can create
3646 # scaps at the owning lib).
3647 my $sub = $e->retrieve_serial_subscription($sub_id) or return $e->die_event;
3648 return $e->die_event unless
3649 $e->allowed("ADMIN_SERIAL_CAPTION_PATTERN", $sub->owning_lib);
3651 foreach my $record (map { MARC::Record->new_from_xml($_) } @$docs) {
3652 foreach my $field ($record->field("85[3-5]")) {
3653 my $scap = new Fieldmapper::serial::caption_and_pattern;
3654 $scap->subscription($sub_id);
3655 $scap->type($MFHD_NAMES_BY_TAG{$field->tag});
3656 $scap->pattern_code(
3657 OpenSRF::Utils::JSON->perl2JSON(
3658 [ $field->indicator(1), $field->indicator(2),
3659 map { @$_ } $field->subfields ] # flattens nested array
3662 $e->create_serial_caption_and_pattern($scap) or
3663 return $e->die_event;
3664 $client->respond($e->data);
3668 $e->commit or return $e->die_event;
3672 # All these _clone_foo() functions could possibly have been consolidated into
3673 # one clever function, but it's faster to get things working this way.
3674 sub _clone_subscription {
3675 my ($sub, $bib_id, $e) = @_;
3678 my $new_sub = $sub->clone;
3679 $new_sub->record_entry(int $bib_id) if $bib_id;
3681 $new_sub->clear_distributions;
3682 $new_sub->clear_notes;
3683 $new_sub->clear_scaps;
3685 $e->create_serial_subscription($new_sub) or return $e->die_event;
3687 my $new_sub_id = $e->data->id;
3689 foreach my $dist (@{$sub->distributions}) {
3690 my $r = _clone_distribution($dist, $new_sub_id, $e);
3691 return $r if $U->event_code($r);
3695 foreach my $note (@{$sub->notes}) {
3696 my $r = _clone_subscription_note($note, $new_sub_id, $e);
3697 return $r if $U->event_code($r);
3701 foreach my $scap (@{$sub->scaps}) {
3702 my $r = _clone_caption_and_pattern($scap, $new_sub_id, $e);
3703 return $r if $U->event_code($r);
3709 sub _clone_distribution {
3710 my ($dist, $sub_id, $e) = @_;
3712 my $new_dist = $dist->clone;
3713 $new_dist->clear_id;
3714 $new_dist->clear_notes;
3715 $new_dist->clear_streams;
3716 $new_dist->subscription($sub_id);
3718 $e->create_serial_distribution($new_dist) or return $e->die_event;
3719 my $new_dist_id = $e->data->id;
3722 foreach my $stream (@{$dist->streams}) {
3723 my $r = _clone_stream($stream, $new_dist_id, $e);
3724 return $r if $U->event_code($r);
3727 # clone distribution notes
3728 foreach my $note (@{$dist->notes}) {
3729 my $r = _clone_distribution_note($note, $new_dist_id, $e);
3730 return $r if $U->event_code($r);
3733 return $new_dist_id;
3736 sub _clone_subscription_note {
3737 my ($note, $sub_id, $e) = @_;
3739 my $new_note = $note->clone;
3740 $new_note->clear_id;
3741 $new_note->creator($e->requestor->id);
3742 $new_note->create_date("now");
3743 $new_note->subscription($sub_id);
3745 $e->create_serial_subscription_note($new_note) or return $e->die_event;
3746 return $e->data->id;
3749 sub _clone_caption_and_pattern {
3750 my ($scap, $sub_id, $e) = @_;
3752 my $new_scap = $scap->clone;
3753 $new_scap->clear_id;
3754 $new_scap->subscription($sub_id);
3756 $e->create_serial_caption_and_pattern($new_scap) or return $e->die_event;
3757 return $e->data->id;
3760 sub _clone_distribution_note {
3761 my ($note, $dist_id, $e) = @_;
3763 my $new_note = $note->clone;
3764 $new_note->clear_id;
3765 $new_note->creator($e->requestor->id);
3766 $new_note->create_date("now");
3767 $new_note->distribution($dist_id);
3769 $e->create_serial_distribution_note($new_note) or return $e->die_event;
3770 return $e->data->id;
3774 my ($stream, $dist_id, $e) = @_;
3776 my $new_stream = $stream->clone;
3777 $new_stream->clear_id;
3778 $new_stream->clear_routing_list_users;
3779 $new_stream->distribution($dist_id);
3781 $e->create_serial_stream($new_stream) or return $e->die_event;
3782 my $new_stream_id = $e->data->id;
3784 # clone routing list users
3785 foreach my $user (@{$stream->routing_list_users}) {
3786 my $r = _clone_routing_list_user($user, $new_stream_id, $e);
3787 return $r if $U->event_code($r);
3790 return $new_stream_id;
3793 sub _clone_routing_list_user {
3794 my ($user, $stream_id, $e) = @_;
3796 my $new_user = $user->clone;
3797 $new_user->clear_id;
3798 $new_user->stream($stream_id);
3800 $e->create_serial_routing_list_user($new_user) or return $e->die_event;
3801 return $e->data->id;
3804 __PACKAGE__->register_method(
3805 "method" => "clone_subscription",
3806 "api_name" => "open-ils.serial.subscription.clone",
3808 "desc" => q{Clone a subscription, including its attending distributions,
3809 streams, captions and patterns, routing list users, distribution
3810 notes and subscription notes. Do not include holdings-specific
3811 things, like issuances, items, units, summaries. Attach the
3812 clone either to the same bib record as the original, or to one
3815 {"desc" => "Authtoken", "type" => "string"},
3816 {"desc" => "Subscription ID", "type" => "number"},
3817 {"desc" => "Bib Record ID (optional)", "type" => "number"}
3820 "desc" => "ID of the new subscription", "type" => "number"
3825 sub clone_subscription {
3826 my ($self, $client, $auth, $sub_id, $bib_id) = @_;
3828 my $e = new_editor("authtoken" => $auth, "xact" => 1);
3829 return $e->die_event unless $e->checkauth;
3831 my $sub = $e->retrieve_serial_subscription([
3835 "ssub" => [qw/distributions notes scaps/],
3836 "sdist" => [qw/streams notes/],
3837 "sstr" => ["routing_list_users"]
3840 ]) or return $e->die_event;
3842 # ADMIN_SERIAL_SUBSCRIPTION will have to be good enough as a
3843 # catch-all permisison for this operation.
3844 return $e->die_event unless
3845 $e->allowed("ADMIN_SERIAL_SUBSCRIPTION", $sub->owning_lib);
3847 my $result = _clone_subscription($sub, $bib_id, $e);
3849 return $e->die_event($result) if $U->event_code($result);
3851 $e->commit or return $e->die_event;
3855 __PACKAGE__->register_method(
3856 "method" => "summary_test",
3857 "api_name" => "open-ils.serial.summary_test",
3863 # This crummy little test method allows quicker reproduction of certain
3864 # failures (e.g. at item receive time) of the holdings summarization code.
3865 # Pass it an authtoken, an array of issuance IDs, and a single sdist ID
3867 my ($self, $conn, $authtoken, $iss_id_list, $sdist_id) = @_;
3869 my $e = new_editor(authtoken => $authtoken, xact => 1);
3870 return $e->die_event unless $e->checkauth;
3871 return $e->die_event unless $e->allowed("RECEIVE_SERIAL");
3874 foreach my $id (@$iss_id_list) {
3875 my $iss = $e->retrieve_serial_issuance($id) or return $e->die_event;
3876 push @issuances, $iss;
3879 my $dist = $e->retrieve_serial_distribution($sdist_id) or return $e->die_event;
3881 $conn->respond(_summarize_contents($e, \@issuances, $dist));