1 use strict; use warnings;
2 package OpenILS::Application::Cat;
3 use OpenILS::Application::AppUtils;
4 use OpenILS::Application;
5 use OpenILS::Application::Cat::Utils;
6 use OpenILS::Application::Cat::Merge;
7 use base qw/OpenILS::Application/;
8 use Time::HiRes qw(time);
9 use OpenSRF::EX qw(:try);
10 use OpenSRF::Utils::JSON;
11 use OpenILS::Utils::Fieldmapper;
13 use OpenILS::Const qw/:const/;
16 use Unicode::Normalize;
18 use OpenILS::Utils::FlatXML;
19 use OpenILS::Utils::CStoreEditor q/:funcs/;
21 use OpenSRF::Utils::SettingsClient;
22 use OpenSRF::Utils::Logger qw($logger);
23 use OpenSRF::AppSession;
25 my $apputils = "OpenILS::Application::AppUtils";
27 my $utils = "OpenILS::Application::Cat::Utils";
28 my $U = "OpenILS::Application::AppUtils";
36 my $form = shift || "";
44 $stuff =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
48 __PACKAGE__->register_method(
49 method => "retrieve_marc_template",
50 api_name => "open-ils.cat.biblio.marc_template.retrieve",
52 Returns a MARC 'record tree' based on a set of pre-defined templates.
53 Templates include : book
56 sub retrieve_marc_template {
57 my( $self, $client, $type ) = @_;
58 return $marctemplates{$type} if defined($marctemplates{$type});
59 $marctemplates{$type} = _load_marc_template($type);
60 return $marctemplates{$type};
63 __PACKAGE__->register_method(
64 method => 'fetch_marc_template_types',
65 api_name => 'open-ils.cat.marc_template.types.retrieve'
68 my $marc_template_files;
70 sub fetch_marc_template_types {
71 my( $self, $conn ) = @_;
72 __load_marc_templates();
73 return [ keys %$marc_template_files ];
76 sub __load_marc_templates {
77 return if $marc_template_files;
78 if(!$conf) { $conf = OpenSRF::Utils::SettingsClient->new; }
80 $marc_template_files = $conf->config_value(
81 "apps", "open-ils.cat","app_settings", "marctemplates" );
83 $logger->info("Loaded marc templates: " . Dumper($marc_template_files));
86 sub _load_marc_template {
89 __load_marc_templates();
91 my $template = $$marc_template_files{$type};
92 open( F, $template ) or
93 throw OpenSRF::EX::ERROR ("Unable to open MARC template file: $template : $@");
97 my $xml = join('', @xml);
99 return XML::LibXML->new->parse_string($xml)->documentElement->toString;
103 sub bib_source_from_name {
105 $logger->debug("searching for bib source: $name");
109 my ($s) = grep { lc($_->source) eq lc($name) } @$__bib_sources;
116 __PACKAGE__->register_method(
117 method => 'fetch_bib_sources',
118 api_name => 'open-ils.cat.bib_sources.retrieve.all');
120 sub fetch_bib_sources {
121 $__bib_sources = new_editor()->retrieve_all_config_bib_source()
122 unless $__bib_sources;
123 return $__bib_sources;
128 __PACKAGE__->register_method(
129 method => "create_record_xml",
130 api_name => "open-ils.cat.biblio.record.xml.create.override",
131 signature => q/@see open-ils.cat.biblio.record.xml.create/);
133 __PACKAGE__->register_method(
134 method => "create_record_xml",
135 api_name => "open-ils.cat.biblio.record.xml.create",
137 Inserts a new biblio with the given XML
141 sub create_record_xml {
142 my( $self, $client, $login, $xml, $source ) = @_;
144 my $override = 1 if $self->api_name =~ /override/;
146 my( $user_obj, $evt ) = $U->checksesperm($login, 'CREATE_MARC');
149 $logger->activity("user ".$user_obj->id." creating new MARC record");
151 my $meth = $self->method_lookup("open-ils.cat.biblio.record.xml.import");
153 $meth = $self->method_lookup(
154 "open-ils.cat.biblio.record.xml.import.override") if $override;
156 my ($s) = $meth->run($login, $xml, $source);
162 __PACKAGE__->register_method(
163 method => "biblio_record_replace_marc",
164 api_name => "open-ils.cat.biblio.record.xml.update",
167 Updates the XML for a given biblio record.
168 This does not change any other aspect of the record entry
169 exception the XML, the editor, and the edit date.
170 @return The update record object
174 __PACKAGE__->register_method(
175 method => 'biblio_record_replace_marc',
176 api_name => 'open-ils.cat.biblio.record.marc.replace',
178 @param auth The authtoken
179 @param recid The record whose MARC we're replacing
180 @param newxml The new xml to use
184 __PACKAGE__->register_method(
185 method => 'biblio_record_replace_marc',
186 api_name => 'open-ils.cat.biblio.record.marc.replace.override',
187 signature => q/@see open-ils.cat.biblio.record.marc.replace/
190 sub biblio_record_replace_marc {
191 my( $self, $conn, $auth, $recid, $newxml, $source ) = @_;
193 warn "Updating MARC with xml\n$newxml\n";
195 my $e = new_editor(authtoken=>$auth, xact=>1);
196 return $e->die_event unless $e->checkauth;
197 return $e->die_event unless $e->allowed('CREATE_MARC', $e->requestor->ws_ou);
199 my $rec = $e->retrieve_biblio_record_entry($recid)
200 or return $e->die_event;
202 my $fixtcn = 1 if $self->api_name =~ /replace/o;
204 # See if there is a different record in the database that has our TCN value
205 # If we're not updating the TCN, all we care about it the marcdoc
206 my $override = $self->api_name =~ /override/;
208 # XXX should .update even bother with the tcn_info if it's not going to replace it?
209 # there is the potential for returning a TCN_EXISTS event, even though no replacement happens
211 my( $tcn, $tsource, $marcdoc, $evt);
213 if($fixtcn or $override) {
215 ($tcn, $tsource, $marcdoc, $evt) =
216 _find_tcn_info($e, $newxml, $override, $recid);
220 $rec->tcn_value($tcn) if ($tcn);
221 $rec->tcn_source($tsource);
225 $marcdoc = __make_marc_doc($newxml);
230 $rec->source(bib_source_from_name($source)) if $source;
231 $rec->editor($e->requestor->id);
232 $rec->edit_date('now');
233 $rec->marc( entityize( $marcdoc->documentElement->toString ) );
235 $logger->activity("user ".$e->requestor->id." replacing MARC for record $recid");
237 $e->update_biblio_record_entry($rec) or return $e->event;
240 $conn->respond_complete($rec);
244 'open-ils.ingest.full.biblio.record', $recid );
252 __PACKAGE__->register_method(
253 method => "biblio_record_xml_import",
254 api_name => "open-ils.cat.biblio.record.xml.import.override",
255 signature => q/@see open-ils.cat.biblio.record.xml.import/);
257 __PACKAGE__->register_method(
258 method => "biblio_record_xml_import",
259 api_name => "open-ils.cat.biblio.record.xml.import",
260 notes => <<" NOTES");
261 Takes a marcxml record and imports the record into the database. In this
262 case, the marcxml record is assumed to be a complete record (i.e. valid
263 MARC). The title control number is taken from (whichever comes first)
264 tags 001, 039[ab], 020a, 022a, 010, 035a and whichever does not already exist
266 user_session must have IMPORT_MARC permissions
270 sub biblio_record_xml_import {
271 my( $self, $client, $authtoken, $xml, $source, $auto_tcn) = @_;
273 my $override = 1 if $self->api_name =~ /override/;
274 my $e = new_editor(xact=>1, authtoken=>$authtoken);
275 return $e->die_event unless $e->checkauth;
276 return $e->die_event unless $e->allowed('IMPORT_MARC', $e->requestor->ws_ou);
278 my( $evt, $tcn, $tcn_source, $marcdoc );
281 # auto_tcn forces a blank TCN value so the DB will have to generate one for us
282 $marcdoc = __make_marc_doc($xml);
284 ( $tcn, $tcn_source, $marcdoc, $evt ) = _find_tcn_info($e, $xml, $override);
288 $logger->info("user ".$e->requestor->id.
289 " creating new biblio entry with tcn=$tcn and tcn_source $tcn_source");
291 my $record = Fieldmapper::biblio::record_entry->new;
293 $record->source(bib_source_from_name($source)) if $source;
294 $record->tcn_source($tcn_source);
295 $record->tcn_value($tcn) if ($tcn);
296 $record->creator($e->requestor->id);
297 $record->editor($e->requestor->id);
298 $record->create_date('now');
299 $record->edit_date('now');
300 $record->marc( entityize( $marcdoc->documentElement->toString ) );
302 $record = $e->create_biblio_record_entry($record) or return $e->die_event;
303 $logger->info("marc create/import created new record ".$record->id);
307 $logger->debug("Sending record off to be ingested and indexed");
309 $client->respond_complete($record);
313 'open-ils.ingest.full.biblio.record', $record->id );
318 sub __make_marc_doc {
320 my $marcxml = XML::LibXML->new->parse_string( $xml );
321 $marcxml->documentElement->setNamespace(
322 "http://www.loc.gov/MARC21/slim", "marc", 1 );
323 $marcxml->documentElement->setNamespace("http://www.loc.gov/MARC21/slim");
331 my $override = shift;
332 my $existing_rec = shift || 0;
335 my $marcxml = __make_marc_doc($xml);
337 my $xpath = '//marc:controlfield[@tag="001"]';
338 my $tcn = $marcxml->documentElement->findvalue($xpath);
339 $logger->info("biblio import located 001 (tcn) value of $tcn");
341 $xpath = '//marc:controlfield[@tag="003"]';
342 my $tcn_source = $marcxml->documentElement->findvalue($xpath) || "System Local";
344 if(my $rec = _tcn_exists($editor, $tcn, $tcn_source, $existing_rec) ) {
347 $tcn = find_free_tcn( $marcxml, $editor, $existing_rec );
349 # if we're overriding, try to find a different TCN to use
352 # XXX Create ALLOW_ALT_TCN permission check support
354 $logger->info("tcn value $tcn already exists, attempting to override");
362 'OPEN_TCN_NOT_FOUND',
363 payload => $marcxml->toString())
369 $logger->warn("tcn value $origtcn already exists in import/create");
371 # otherwise, return event
377 'TCN_EXISTS', payload => {
387 return ($tcn, $tcn_source, $marcxml);
394 my $existing_rec = shift;
398 my $xpath = '//marc:datafield[@tag="039"]/subfield[@code="a"]';
399 my ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
400 $xpath = '//marc:datafield[@tag="039"]/subfield[@code="b"]';
401 my $tcn_source = $marcxml->documentElement->findvalue($xpath) || "System Local";
403 if(_tcn_exists($editor, $tcn, $tcn_source, $existing_rec)) {
411 $xpath = '//marc:datafield[@tag="020"]/subfield[@code="a"]';
412 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
413 $tcn_source = "ISBN";
414 if(_tcn_exists($editor, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
418 $xpath = '//marc:datafield[@tag="022"]/subfield[@code="a"]';
419 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
420 $tcn_source = "ISSN";
421 if(_tcn_exists($editor, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
425 $xpath = '//marc:datafield[@tag="010"]';
426 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
427 $tcn_source = "LCCN";
428 if(_tcn_exists($editor, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
432 $xpath = '//marc:datafield[@tag="035"]/subfield[@code="a"]';
433 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
434 $tcn_source = "System Legacy";
435 if(_tcn_exists($editor, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
438 $marcxml->documentElement->removeChild(
439 $marcxml->documentElement->findnodes( '//datafield[@tag="035"]' )
444 return undef unless $tcn;
447 my $df = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'datafield');
448 $df->setAttribute( tag => '039' );
449 $df->setAttribute( ind1 => ' ' );
450 $df->setAttribute( ind2 => ' ' );
451 $marcxml->documentElement->appendChild( $df );
453 my $sfa = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'subfield');
454 $sfa->setAttribute( code => 'a' );
455 $sfa->appendChild( $marcxml->createTextNode( $tcn ) );
456 $df->appendChild( $sfa );
458 my $sfb = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'subfield');
459 $sfb->setAttribute( code => 'b' );
460 $sfb->appendChild( $marcxml->createTextNode( $tcn_source ) );
461 $df->appendChild( $sfb );
473 my $existing_rec = shift || 0;
475 if(!$tcn) {return 0;}
477 $logger->debug("tcn_exists search for tcn $tcn and source $source and id $existing_rec");
479 # XXX why does the source matter?
480 # my $req = $session->request(
481 # { tcn_value => $tcn, tcn_source => $source, deleted => 'f' } );
483 my $recs = $editor->search_biblio_record_entry(
484 {tcn_value => $tcn, deleted => 'f', id => {'!=' => $existing_rec}}, {idlist =>1});
487 $logger->debug("_tcn_exists is true for tcn : $tcn ($source)");
491 $logger->debug("_tcn_exists is false for tcn : $tcn ($source)");
496 __PACKAGE__->register_method(
497 method => "biblio_record_record_metadata",
498 api_name => "open-ils.cat.biblio.record.metadata.retrieve",
500 argc => 1, #(session_id, biblio_tree )
501 notes => "Walks the tree and commits any changed nodes " .
502 "adds any new nodes, and deletes any deleted nodes",
505 sub biblio_record_record_metadata {
506 my( $self, $client, $authtoken, $ids ) = @_;
508 return [] unless $ids and @$ids;
510 my $editor = new_editor(authtoken => $authtoken);
511 return $editor->event unless $editor->checkauth;
512 return $editor->event unless $editor->allowed('VIEW_USER');
517 return $editor->event unless
518 my $rec = $editor->retrieve_biblio_record_entry($_);
519 $rec->creator($editor->retrieve_actor_user($rec->creator));
520 $rec->editor($editor->retrieve_actor_user($rec->editor));
521 $rec->clear_marc; # slim the record down
522 push( @results, $rec );
530 __PACKAGE__->register_method(
531 method => "biblio_record_marc_cn",
532 api_name => "open-ils.cat.biblio.record.marc_cn.retrieve",
533 argc => 1, #(bib id )
536 sub biblio_record_marc_cn {
537 my( $self, $client, $id ) = @_;
539 my $session = OpenSRF::AppSession->create("open-ils.cstore");
541 ->request("open-ils.cstore.direct.biblio.record_entry.retrieve", $id )
545 my $doc = XML::LibXML->new->parse_string($marc);
546 $doc->documentElement->setNamespace( "http://www.loc.gov/MARC21/slim", "marc", 1 );
549 for my $tag ( qw/050 055 060 070 080 082 086 088 090 092 096 098 099/ ) {
550 my @node = $doc->findnodes("//marc:datafield[\@tag='$tag']");
552 my $cn = $x->findvalue("marc:subfield[\@code='a' or \@code='b']");
553 push @res, {$tag => $cn} if ($cn);
560 sub _get_id_by_userid {
565 my $session = OpenSRF::AppSession->create( "open-ils.cstore" );
566 my $request = $session->request(
567 "open-ils.cstore.direct.actor.user.search.atomic", { usrname => \@users } );
569 $request->wait_complete;
570 my $response = $request->recv();
571 if(!$request->complete) {
572 throw OpenSRF::EX::ERROR ("no response from cstore on user retrieve");
575 if(UNIVERSAL::isa( $response, "Error")){
576 throw $response ($response);
579 for my $u (@{$response->content}) {
585 $session->disconnect;
592 # commits metadata objects to the db
593 sub _update_record_metadata {
595 my ($session, @docs ) = @_;
597 for my $doc (@docs) {
599 my $user_obj = $doc->{user};
600 my $docid = $doc->{docid};
602 warn "Updating metata for doc $docid\n";
604 my $request = $session->request(
605 "open-ils.storage.direct.biblio.record_entry.retrieve", $docid );
606 my $record = $request->gather(1);
608 warn "retrieved record\n";
609 my ($id) = _get_id_by_userid($user_obj->usrname);
611 warn "got $id from _get_id_by_userid\n";
612 $record->editor($id);
614 warn "Grabbed the record, updating and moving on\n";
616 $request = $session->request(
617 "open-ils.storage.direct.biblio.record_entry.update", $record );
621 warn "committing metarecord update\n";
628 __PACKAGE__->register_method(
629 method => "orgs_for_title",
631 api_name => "open-ils.cat.actor.org_unit.retrieve_by_title"
635 my( $self, $client, $record_id ) = @_;
637 my $vols = $apputils->simple_scalar_request(
639 "open-ils.cstore.direct.asset.call_number.search.atomic",
640 { record => $record_id, deleted => 'f' });
642 my $orgs = { map {$_->owning_lib => 1 } @$vols };
643 return [ keys %$orgs ];
647 __PACKAGE__->register_method(
648 method => "retrieve_copies",
650 api_name => "open-ils.cat.asset.copy_tree.retrieve");
652 __PACKAGE__->register_method(
653 method => "retrieve_copies",
654 api_name => "open-ils.cat.asset.copy_tree.global.retrieve");
656 # user_session may be null/undef
657 sub retrieve_copies {
659 my( $self, $client, $user_session, $docid, @org_ids ) = @_;
661 if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
665 warn " $$ retrieving copy tree for orgs @org_ids and doc $docid at " . time() . "\n";
667 # grabbing copy trees should be available for everyone..
668 if(!@org_ids and $user_session) {
670 OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
671 @org_ids = ($user_obj->home_ou);
674 if( $self->api_name =~ /global/ ) {
675 warn "performing global copy_tree search for $docid\n";
676 return _build_volume_list( { record => $docid, deleted => 'f' } );
681 for my $orgid (@org_ids) {
682 my $vols = _build_volume_list(
683 { record => $docid, owning_lib => $orgid, deleted => 'f' } );
684 warn "Volumes built for org $orgid\n";
685 push( @all_vols, @$vols );
688 warn " $$ Finished copy_tree at " . time() . "\n";
696 sub _build_volume_list {
697 my $search_hash = shift;
699 $search_hash->{deleted} = 'f';
700 my $e = new_editor();
702 my $vols = $e->search_asset_call_number($search_hash);
706 for my $volume (@$vols) {
708 my $copies = $e->search_asset_copy(
709 { call_number => $volume->id , deleted => 'f' });
711 $copies = [ sort { $a->barcode cmp $b->barcode } @$copies ];
713 for my $c (@$copies) {
714 if( $c->status == OILS_COPY_STATUS_CHECKED_OUT ) {
716 $e->search_action_circulation(
718 { target_copy => $c->id },
720 order_by => { circ => 'xact_start desc' },
729 $volume->copies($copies);
730 push( @volumes, $volume );
733 #$session->disconnect();
739 __PACKAGE__->register_method(
740 method => "fleshed_copy_update",
741 api_name => "open-ils.cat.asset.copy.fleshed.batch.update",);
743 __PACKAGE__->register_method(
744 method => "fleshed_copy_update",
745 api_name => "open-ils.cat.asset.copy.fleshed.batch.update.override",);
748 sub fleshed_copy_update {
749 my( $self, $conn, $auth, $copies, $delete_stats ) = @_;
750 return 1 unless ref $copies;
751 my( $reqr, $evt ) = $U->checkses($auth);
753 my $editor = new_editor(requestor => $reqr, xact => 1);
754 my $override = $self->api_name =~ /override/;
755 $evt = update_fleshed_copies($editor, $override, undef, $copies, $delete_stats);
757 $logger->info("fleshed copy update failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
762 $logger->info("fleshed copy update successfully updated ".scalar(@$copies)." copies");
767 __PACKAGE__->register_method(
769 api_name => 'open-ils.cat.biblio.records.merge',
771 Merges a group of records
772 @param auth The login session key
773 @param master The id of the record all other records should be merged into
774 @param records Array of records to be merged into the master record
775 @return 1 on success, Event on error.
780 my( $self, $conn, $auth, $master, $records ) = @_;
781 my( $reqr, $evt ) = $U->checkses($auth);
783 my $editor = new_editor( requestor => $reqr, xact => 1 );
784 my $v = OpenILS::Application::Cat::Merge::merge_records($editor, $master, $records);
787 # tell the client the merge is complete, then merge the holds
788 $conn->respond_complete(1);
789 merge_holds($master, $records);
794 my($master, $records) = @_;
795 return unless $master and @$records;
796 return if @$records == 1 and $master == $$records[0];
798 my $e = new_editor(xact=>1);
799 my $holds = $e->search_action_hold_request(
800 { cancel_time => undef,
801 fulfillment_time => undef,
808 for my $hold_id (@$holds) {
810 my $hold = $e->retrieve_action_hold_request($hold_id);
812 $logger->info("Changing hold ".$hold->id.
813 " target from ".$hold->target." to $master in record merge");
815 $hold->target($master);
816 unless($e->update_action_hold_request($hold)) {
818 $logger->error("Error updating hold ". $evt->textcode .":". $evt->desc .":". $evt->stacktrace);
829 # ---------------------------------------------------------------------------
830 # ---------------------------------------------------------------------------
832 # returns true if the given title (id) has no un-deleted
835 my( $editor, $rid ) = @_;
837 return 0 if $rid == OILS_PRECAT_RECORD;
839 my $cnlist = $editor->search_asset_call_number(
840 { record => $rid, deleted => 'f' }, { idlist => 1 } );
841 return 1 unless @$cnlist;
843 for my $cn (@$cnlist) {
844 my $copylist = $editor->search_asset_copy(
846 { call_number => $cn, deleted => 'f' },
849 return 0 if @$copylist; # false if we find any copies
856 __PACKAGE__->register_method(
857 method => "fleshed_volume_update",
858 api_name => "open-ils.cat.asset.volume.fleshed.batch.update",);
860 __PACKAGE__->register_method(
861 method => "fleshed_volume_update",
862 api_name => "open-ils.cat.asset.volume.fleshed.batch.update.override",);
864 sub fleshed_volume_update {
865 my( $self, $conn, $auth, $volumes, $delete_stats ) = @_;
866 my( $reqr, $evt ) = $U->checkses($auth);
869 my $override = ($self->api_name =~ /override/);
870 my $editor = new_editor( requestor => $reqr, xact => 1 );
872 for my $vol (@$volumes) {
873 $logger->info("vol-update: investigating volume ".$vol->id);
875 $vol->editor($reqr->id);
876 $vol->edit_date('now');
878 my $copies = $vol->copies;
881 $vol->editor($editor->requestor->id);
882 $vol->edit_date('now');
884 if( $vol->isdeleted ) {
886 $logger->info("vol-update: deleting volume");
887 my $cs = $editor->search_asset_copy(
888 { call_number => $vol->id, deleted => 'f' } );
889 return OpenILS::Event->new(
890 'VOLUME_NOT_EMPTY', payload => $vol->id ) if @$cs;
893 return $editor->event unless
894 $editor->update_asset_call_number($vol);
897 } elsif( $vol->isnew ) {
898 $logger->info("vol-update: creating volume");
899 $evt = create_volume( $override, $editor, $vol );
902 } elsif( $vol->ischanged ) {
903 $logger->info("vol-update: update volume");
904 $evt = update_volume($vol, $editor);
908 # now update any attached copies
909 if( $copies and @$copies and !$vol->isdeleted ) {
910 $_->call_number($vol->id) for @$copies;
911 $evt = update_fleshed_copies( $editor, $override, $vol, $copies, $delete_stats );
917 return scalar(@$volumes);
926 return $evt if ( $evt = org_cannot_have_vols($editor, $vol->owning_lib) );
928 my $vols = $editor->search_asset_call_number( {
929 owning_lib => $vol->owning_lib,
930 record => $vol->record,
931 label => $vol->label,
936 # There exists a different volume in the DB with the same properties
937 return OpenILS::Event->new('VOLUME_LABEL_EXISTS', payload => $vol->id)
938 if grep { $_->id ne $vol->id } @$vols;
940 return $editor->event unless $editor->update_asset_call_number($vol);
947 my( $vol, $copy ) = @_;
948 my $org = $vol->owning_lib;
949 if( $vol->id == OILS_PRECAT_CALL_NUMBER ) {
950 $org = ref($copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
952 $logger->debug("using copy perm org $org");
957 # this does the actual work
958 sub update_fleshed_copies {
959 my( $editor, $override, $vol, $copies, $delete_stats ) = @_;
962 my $fetchvol = ($vol) ? 0 : 1;
965 $cache{$vol->id} = $vol if $vol;
967 for my $copy (@$copies) {
969 my $copyid = $copy->id;
970 $logger->info("vol-update: inspecting copy $copyid");
972 if( !($vol = $cache{$copy->call_number}) ) {
973 $vol = $cache{$copy->call_number} =
974 $editor->retrieve_asset_call_number($copy->call_number);
975 return $editor->event unless $vol;
978 return $editor->event unless
979 $editor->allowed('UPDATE_COPY', copy_perm_org($vol, $copy));
981 $copy->editor($editor->requestor->id);
982 $copy->edit_date('now');
984 $copy->status( $copy->status->id ) if ref($copy->status);
985 $copy->location( $copy->location->id ) if ref($copy->location);
986 $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
988 my $sc_entries = $copy->stat_cat_entries;
989 $copy->clear_stat_cat_entries;
991 if( $copy->isdeleted ) {
992 $evt = delete_copy($editor, $override, $vol, $copy);
995 } elsif( $copy->isnew ) {
996 $evt = create_copy( $editor, $vol, $copy );
999 } elsif( $copy->ischanged ) {
1001 $evt = update_copy( $editor, $override, $vol, $copy );
1002 return $evt if $evt;
1005 $copy->stat_cat_entries( $sc_entries );
1006 $evt = update_copy_stat_entries($editor, $copy, $delete_stats);
1007 return $evt if $evt;
1010 $logger->debug("vol-update: done updating copy batch");
1015 sub fix_copy_price {
1018 if(defined $copy->price) {
1019 my $p = $copy->price || 0;
1024 my $d = $copy->deposit_amount || 0;
1026 $copy->deposit_amount($d);
1031 my( $editor, $override, $vol, $copy ) = @_;
1034 my $org = (ref $copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
1035 return $evt if ( $evt = org_cannot_have_vols($editor, $org) );
1037 $logger->info("vol-update: updating copy ".$copy->id);
1038 my $orig_copy = $editor->retrieve_asset_copy($copy->id);
1039 my $orig_vol = $editor->retrieve_asset_call_number($copy->call_number);
1041 $copy->editor($editor->requestor->id);
1042 $copy->edit_date('now');
1044 $copy->age_protect( $copy->age_protect->id )
1045 if ref $copy->age_protect;
1047 fix_copy_price($copy);
1049 return $editor->event unless $editor->update_asset_copy($copy);
1050 return remove_empty_objects($editor, $override, $orig_vol);
1054 sub remove_empty_objects {
1055 my( $editor, $override, $vol ) = @_;
1057 my $koe = $U->ou_ancestor_setting_value(
1058 $editor->requestor->ws_ou, 'cat.bib.keep_on_empty', $editor);
1059 my $aoe = $U->ou_ancestor_setting_value(
1060 $editor->requestor->ws_ou, 'cat.bib.alert_on_empty', $editor);
1062 if( title_is_empty($editor, $vol->record) ) {
1064 # delete this volume if it's not already marked as deleted
1065 unless( $U->is_true($vol->deleted) || $vol->isdeleted ) {
1067 $vol->editor($editor->requestor->id);
1068 $vol->edit_date('now');
1069 $editor->update_asset_call_number($vol) or return $editor->event;
1073 # delete the bib record if the keep-on-empty setting is not set
1074 my $evt = delete_rec($editor, $vol->record);
1075 return $evt if $evt;
1078 # return the empty alert if the alert-on-empty setting is set
1079 return OpenILS::Event->new('TITLE_LAST_COPY', payload => $vol->record ) if $aoe;
1086 __PACKAGE__->register_method (
1087 method => 'delete_bib_record',
1088 api_name => 'open-ils.cat.biblio.record_entry.delete');
1090 sub delete_bib_record {
1091 my($self, $conn, $auth, $rec_id) = @_;
1092 my $e = new_editor(xact=>1, authtoken=>$auth);
1093 return $e->die_event unless $e->checkauth;
1094 return $e->die_event unless $e->allowed('DELETE_RECORD', $e->requestor->ws_ou);
1095 my $vols = $e->search_asset_call_number({record=>$rec_id, deleted=>'f'});
1096 return OpenILS::Event->new('RECORD_NOT_EMPTY', payload=>$rec_id) if @$vols;
1097 my $evt = delete_rec($e, $rec_id);
1098 if($evt) { $e->rollback; return $evt; }
1104 # marks a record as deleted
1106 my( $editor, $rec_id ) = @_;
1108 my $rec = $editor->retrieve_biblio_record_entry($rec_id)
1109 or return $editor->event;
1111 return undef if $U->is_true($rec->deleted);
1115 $rec->editor( $editor->requestor->id );
1116 $rec->edit_date('now');
1117 $editor->update_biblio_record_entry($rec) or return $editor->event;
1124 my( $editor, $override, $vol, $copy ) = @_;
1126 return $editor->event unless
1127 $editor->allowed('DELETE_COPY',copy_perm_org($vol, $copy));
1129 my $stat = $U->copy_status($copy->status)->id;
1132 return OpenILS::Event->new('COPY_DELETE_WARNING', payload => $copy->id )
1133 if $stat == OILS_COPY_STATUS_CHECKED_OUT or
1134 $stat == OILS_COPY_STATUS_IN_TRANSIT or
1135 $stat == OILS_COPY_STATUS_ON_HOLDS_SHELF or
1136 $stat == OILS_COPY_STATUS_ILL;
1139 $logger->info("vol-update: deleting copy ".$copy->id);
1140 $copy->deleted('t');
1142 $copy->editor($editor->requestor->id);
1143 $copy->edit_date('now');
1144 $editor->update_asset_copy($copy) or return $editor->event;
1146 # Delete any open transits for this copy
1147 my $transits = $editor->search_action_transit_copy(
1148 { target_copy=>$copy->id, dest_recv_time => undef } );
1150 for my $t (@$transits) {
1151 $editor->delete_action_transit_copy($t)
1152 or return $editor->event;
1155 return remove_empty_objects($editor, $override, $vol);
1160 my( $editor, $vol, $copy ) = @_;
1162 my $existing = $editor->search_asset_copy(
1163 { barcode => $copy->barcode, deleted => 'f' } );
1165 return OpenILS::Event->new('ITEM_BARCODE_EXISTS') if @$existing;
1167 # see if the volume this copy references is marked as deleted
1168 my $evol = $editor->retrieve_asset_call_number($copy->call_number)
1169 or return $editor->event;
1170 return OpenILS::Event->new('VOLUME_DELETED', vol => $evol->id)
1171 if $U->is_true($evol->deleted);
1174 my $org = (ref $copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
1175 return $evt if ( $evt = org_cannot_have_vols($editor, $org) );
1178 $copy->creator($editor->requestor->id);
1179 $copy->create_date('now');
1180 fix_copy_price($copy);
1182 $editor->create_asset_copy($copy) or return $editor->event;
1186 # if 'delete_stats' is true, the copy->stat_cat_entries data is
1187 # treated as the authoritative list for the copy. existing entries
1188 # that are not in said list will be deleted from the DB
1189 sub update_copy_stat_entries {
1190 my( $editor, $copy, $delete_stats ) = @_;
1192 return undef if $copy->isdeleted;
1193 return undef unless $copy->ischanged or $copy->isnew;
1196 my $entries = $copy->stat_cat_entries;
1198 if( $delete_stats ) {
1199 $entries = ($entries and @$entries) ? $entries : [];
1201 return undef unless ($entries and @$entries);
1204 my $maps = $editor->search_asset_stat_cat_entry_copy_map({owning_copy=>$copy->id});
1207 # if there is no stat cat entry on the copy who's id matches the
1208 # current map's id, remove the map from the database
1209 for my $map (@$maps) {
1210 if(! grep { $_->id == $map->stat_cat_entry } @$entries ) {
1212 $logger->info("copy update found stale ".
1213 "stat cat entry map ".$map->id. " on copy ".$copy->id);
1215 $editor->delete_asset_stat_cat_entry_copy_map($map)
1216 or return $editor->event;
1221 # go through the stat cat update/create process
1222 for my $entry (@$entries) {
1225 # if this link already exists in the DB, don't attempt to re-create it
1226 next if( grep{$_->stat_cat_entry == $entry->id} @$maps );
1228 my $new_map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
1230 my $sc = ref($entry->stat_cat) ? $entry->stat_cat->id : $entry->stat_cat;
1232 $new_map->stat_cat( $sc );
1233 $new_map->stat_cat_entry( $entry->id );
1234 $new_map->owning_copy( $copy->id );
1236 $editor->create_asset_stat_cat_entry_copy_map($new_map)
1237 or return $editor->event;
1239 $logger->info("copy update created new stat cat entry map ".$editor->data);
1247 my( $override, $editor, $vol ) = @_;
1250 return $evt if ( $evt = org_cannot_have_vols($editor, $vol->owning_lib) );
1252 # see if the record this volume references is marked as deleted
1253 my $rec = $editor->retrieve_biblio_record_entry($vol->record)
1254 or return $editor->event;
1255 return OpenILS::Event->new('BIB_RECORD_DELETED', rec => $rec->id)
1256 if $U->is_true($rec->deleted);
1258 # first lets see if there are any collisions
1259 my $vols = $editor->search_asset_call_number( {
1260 owning_lib => $vol->owning_lib,
1261 record => $vol->record,
1262 label => $vol->label,
1269 # we've found an exising volume
1271 $label = $vol->label;
1273 return OpenILS::Event->new(
1274 'VOLUME_LABEL_EXISTS', payload => $vol->id);
1278 # create a temp label so we can create the new volume,
1279 # then de-dup it with the existing volume
1280 $vol->label( "__SYSTEM_TMP_$$".time) if $label;
1282 $vol->creator($editor->requestor->id);
1283 $vol->create_date('now');
1284 $vol->editor($editor->requestor->id);
1285 $vol->edit_date('now');
1288 $editor->create_asset_call_number($vol) or return $editor->event;
1291 # now restore the label and merge into the existing record
1292 $vol->label($label);
1294 OpenILS::Application::Cat::Merge::merge_volumes($editor, [$vol], $$vols[0]);
1295 return $evt if $evt;
1302 __PACKAGE__->register_method (
1303 method => 'batch_volume_transfer',
1304 api_name => 'open-ils.cat.asset.volume.batch.transfer',
1307 __PACKAGE__->register_method (
1308 method => 'batch_volume_transfer',
1309 api_name => 'open-ils.cat.asset.volume.batch.transfer.override',
1313 sub batch_volume_transfer {
1314 my( $self, $conn, $auth, $args ) = @_;
1317 my $rec = $$args{docid};
1318 my $o_lib = $$args{lib};
1319 my $vol_ids = $$args{volumes};
1321 my $override = 1 if $self->api_name =~ /override/;
1323 $logger->info("merge: transferring volumes to lib=$o_lib and record=$rec");
1325 my $e = new_editor(authtoken => $auth, xact =>1);
1326 return $e->event unless $e->checkauth;
1327 return $e->event unless $e->allowed('UPDATE_VOLUME', $o_lib);
1329 my $dorg = $e->retrieve_actor_org_unit($o_lib)
1330 or return $e->event;
1332 my $ou_type = $e->retrieve_actor_org_unit_type($dorg->ou_type)
1333 or return $e->event;
1335 return $evt if ( $evt = org_cannot_have_vols($e, $o_lib) );
1337 my $vols = $e->batch_retrieve_asset_call_number($vol_ids);
1342 for my $vol (@$vols) {
1344 # if we've already looked at this volume, go to the next
1345 next if !$vol or grep { $vol->id == $_ } @seen;
1347 # grab all of the volumes in the list that have
1348 # the same label so they can be merged
1349 my @all = grep { $_->label eq $vol->label } @$vols;
1351 # take note of the fact that we've looked at this set of volumes
1352 push( @seen, $_->id ) for @all;
1353 push( @rec_ids, $_->record ) for @all;
1355 # for each volume, see if there are any copies that have a
1356 # remote circ_lib (circ_lib != vol->owning_lib and != $o_lib ).
1358 unless( $override ) {
1361 $logger->debug("merge: searching for copies with remote circ_lib for volume ".$v->id);
1363 call_number => $v->id,
1364 circ_lib => { "not in" => [ $o_lib, $v->owning_lib ] },
1368 my $copies = $e->search_asset_copy($args, {idlist=>1});
1370 # if the copy's circ_lib matches the destination lib,
1372 return OpenILS::Event->new('COPY_REMOTE_CIRC_LIB') if @$copies;
1376 # see if there is a volume at the destination lib that
1377 # already has the requested label
1378 my $existing_vol = $e->search_asset_call_number(
1380 label => $vol->label,
1382 owning_lib =>$o_lib,
1387 if( $existing_vol ) {
1389 if( grep { $_->id == $existing_vol->id } @all ) {
1390 # this volume is already accounted for in our list of volumes to merge
1391 $existing_vol = undef;
1394 # this volume exists on the destination record/owning_lib and must
1395 # be used as the destination for merging
1396 $logger->debug("merge: volume already exists at destination record: ".
1397 $existing_vol->id.' : '.$existing_vol->label) if $existing_vol;
1401 if( @all > 1 || $existing_vol ) {
1402 $logger->info("merge: found collisions in volume transfer");
1403 my @args = ($e, \@all);
1404 @args = ($e, \@all, $existing_vol) if $existing_vol;
1405 ($vol, $evt) = OpenILS::Application::Cat::Merge::merge_volumes(@args);
1406 return $evt if $evt;
1409 if( !$existing_vol ) {
1411 $vol->owning_lib($o_lib);
1413 $vol->editor($e->requestor->id);
1414 $vol->edit_date('now');
1416 $logger->info("merge: updating volume ".$vol->id);
1417 $e->update_asset_call_number($vol) or return $e->event;
1420 $logger->info("merge: bypassing volume update because existing volume used as target");
1423 # regardless of what volume was used as the destination,
1424 # update any copies that have moved over to the new lib
1425 my $copies = $e->search_asset_copy({call_number=>$vol->id, deleted => 'f'});
1427 # update circ lib on the copies - make this a method flag?
1428 for my $copy (@$copies) {
1429 next if $copy->circ_lib == $o_lib;
1430 $logger->info("merge: transfer moving circ lib on copy ".$copy->id);
1431 $copy->circ_lib($o_lib);
1432 $copy->editor($e->requestor->id);
1433 $copy->edit_date('now');
1434 $e->update_asset_copy($copy) or return $e->event;
1437 # Now see if any empty records need to be deleted after all of this
1440 $logger->debug("merge: seeing if we should delete record $_...");
1441 $evt = delete_rec($e, $_) if title_is_empty($e, $_);
1442 return $evt if $evt;
1446 # $evt = remove_empty_objects($e, $override, $_);
1450 $logger->info("merge: transfer succeeded");
1457 sub org_cannot_have_vols {
1461 my $org = $e->retrieve_actor_org_unit($org_id)
1462 or return $e->event;
1464 my $ou_type = $e->retrieve_actor_org_unit_type($org->ou_type)
1465 or return $e->event;
1467 return OpenILS::Event->new('ORG_CANNOT_HAVE_VOLS')
1468 unless $U->is_true($ou_type->can_have_vols);
1476 __PACKAGE__->register_method(
1477 api_name => 'open-ils.cat.call_number.find_or_create',
1478 method => 'find_or_create_volume',
1481 sub find_or_create_volume {
1482 my( $self, $conn, $auth, $label, $record_id, $org_id ) = @_;
1483 my $e = new_editor(authtoken=>$auth, xact=>1);
1484 return $e->die_event unless $e->checkauth;
1488 if($record_id == OILS_PRECAT_RECORD) {
1490 $vol = $e->retrieve_asset_call_number(OILS_PRECAT_CALL_NUMBER)
1491 or return $e->die_event;
1495 $vol = $e->search_asset_call_number(
1496 {label => $label, record => $record_id, owning_lib => $org_id, deleted => 'f'},
1501 # If the volume exists, return the ID
1502 if( $vol ) { $e->rollback; return $vol; }
1504 # -----------------------------------------------------------------
1505 # Otherwise, create a new volume with the given attributes
1506 # -----------------------------------------------------------------
1508 return $e->die_event unless $e->allowed('UPDATE_VOLUME', $org_id);
1510 $vol = Fieldmapper::asset::call_number->new;
1511 $vol->owning_lib($org_id);
1512 $vol->label($label);
1513 $vol->record($record_id);
1515 my $evt = create_volume( 0, $e, $vol );
1516 return $evt if $evt;