1 use strict; use warnings;
2 package OpenILS::Application::Cat;
3 use OpenILS::Application::AppUtils;
4 use OpenSRF::Application;
5 use OpenILS::Application::Cat::Utils;
6 use OpenILS::Application::Cat::Merge;
7 use base qw/OpenSRF::Application/;
8 use Time::HiRes qw(time);
9 use OpenSRF::EX qw(:try);
11 use OpenILS::Utils::Fieldmapper;
15 use Unicode::Normalize;
17 use OpenILS::Utils::FlatXML;
18 use OpenILS::Utils::CStoreEditor q/:funcs/;
19 use OpenILS::Utils::Editor;
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 ) = @_;
59 return $marctemplates{$type} if defined($marctemplates{$type});
60 $marctemplates{$type} = _load_marc_template($type);
61 return $marctemplates{$type};
64 sub _load_marc_template {
67 if(!$conf) { $conf = OpenSRF::Utils::SettingsClient->new; }
69 my $template = $conf->config_value(
70 "apps", "open-ils.cat","app_settings", "marctemplates", $type );
71 warn "Opening template file $template\n";
73 open( F, $template ) or
74 throw OpenSRF::EX::ERROR ("Unable to open MARC template file: $template : $@");
78 my $xml = join('', @xml);
80 return XML::LibXML->new->parse_string($xml)->documentElement->toString;
84 sub bib_source_from_name {
86 $logger->debug("searching for bib source: $name");
88 $__bib_sources = new_editor()->retrieve_all_config_bib_source()
89 unless $__bib_sources;
91 my ($s) = grep { lc($_->source) eq lc($name) } @$__bib_sources;
99 __PACKAGE__->register_method(
100 method => "create_record_xml",
101 api_name => "open-ils.cat.biblio.record.xml.create.override",
102 signature => q/@see open-ils.cat.biblio.record.xml.create/);
104 __PACKAGE__->register_method(
105 method => "create_record_xml",
106 api_name => "open-ils.cat.biblio.record.xml.create",
108 Inserts a new biblio with the given XML
112 sub create_record_xml {
113 my( $self, $client, $login, $xml, $source ) = @_;
115 my $override = 1 if $self->api_name =~ /override/;
117 my( $user_obj, $evt ) = $U->checksesperm($login, 'CREATE_MARC');
120 $logger->activity("user ".$user_obj->id." creating new MARC record");
122 my $meth = $self->method_lookup("open-ils.cat.biblio.record.xml.import");
124 $meth = $self->method_lookup(
125 "open-ils.cat.biblio.record.xml.import.override") if $override;
127 my ($s) = $meth->run($login, $xml, $source);
133 __PACKAGE__->register_method(
134 method => "biblio_record_replace_marc",
135 api_name => "open-ils.cat.biblio.record.xml.update",
138 Updates the XML for a given biblio record.
139 This does not change any other aspect of the record entry
140 exception the XML, the editor, and the edit date.
141 @return The update record object
145 __PACKAGE__->register_method(
146 method => 'biblio_record_replace_marc',
147 api_name => 'open-ils.cat.biblio.record.marc.replace',
149 @param auth The authtoken
150 @param recid The record whose MARC we're replacing
151 @param newxml The new xml to use
155 __PACKAGE__->register_method(
156 method => 'biblio_record_replace_marc',
157 api_name => 'open-ils.cat.biblio.record.marc.replace.override',
158 signature => q/@see open-ils.cat.biblio.record.marc.replace/
161 sub biblio_record_replace_marc {
162 my( $self, $conn, $auth, $recid, $newxml, $source ) = @_;
164 my $e = OpenILS::Utils::Editor->new(authtoken=>$auth, xact=>1);
166 return $e->event unless $e->checkauth;
167 return $e->event unless $e->allowed('CREATE_MARC');
169 my $rec = $e->retrieve_biblio_record_entry($recid)
172 my $fixtcn = 1 if $self->api_name =~ /replace/o;
174 # See if there is a different record in the database that has our TCN value
175 # If we're not updating the TCN, all we care about it the marcdoc
176 my $override = $self->api_name =~ /override/;
178 my $storage = OpenSRF::AppSession->create('open-ils.storage');
180 my( $tcn, $tsource, $marcdoc, $evt) =
181 _find_tcn_info($e->session, $newxml, $override, $recid);
186 $rec->tcn_value($tcn);
187 $rec->tcn_source($tsource);
190 $rec->source(bib_source_from_name($source)) if $source;
191 $rec->editor($e->requestor->id);
192 $rec->edit_date('now');
193 $rec->marc( entityize( $marcdoc->documentElement->toString ) );
195 $logger->activity("user ".$e->requestor->id." replacing MARC for record $recid");
197 $e->update_biblio_record_entry($rec) or return $e->event;
202 'open-ils.ingest.full.biblio.record', $recid );
206 #$e->request('open-ils.worm.wormize.biblio', $recid) or return $e->event;
215 __PACKAGE__->register_method(
216 method => "biblio_record_xml_import",
217 api_name => "open-ils.cat.biblio.record.xml.import.override",
218 signature => q/@see open-ils.cat.biblio.record.xml.import/);
220 __PACKAGE__->register_method(
221 method => "biblio_record_xml_import",
222 api_name => "open-ils.cat.biblio.record.xml.import",
223 notes => <<" NOTES");
224 Takes a marcxml record and imports the record into the database. In this
225 case, the marcxml record is assumed to be a complete record (i.e. valid
226 MARC). The title control number is taken from (whichever comes first)
227 tags 001, 039[ab], 020a, 022a, 010, 035a and whichever does not already exist
229 user_session must have IMPORT_MARC permissions
233 sub biblio_record_xml_import {
234 my( $self, $client, $authtoken, $xml, $source) = @_;
237 # XXX Make the source the ID from config.bib_source
239 my $override = 1 if $self->api_name =~ /override/;
241 my( $tcn, $tcn_source, $marcdoc );
242 my( $requestor, $evt ) = $U->checksesperm($authtoken, 'IMPORT_MARC');
245 my $session = $apputils->start_db_session();
247 ( $tcn, $tcn_source, $marcdoc, $evt ) = _find_tcn_info($session, $xml, $override);
250 $logger->activity("user ".$requestor->id.
251 " creating new biblio entry with tcn=$tcn and tcn_source $tcn_source");
253 my $record = Fieldmapper::biblio::record_entry->new;
255 $record->source(bib_source_from_name($source)) if $source;
256 $record->tcn_source($tcn_source);
257 $record->tcn_value($tcn);
258 $record->creator($requestor->id);
259 $record->editor($requestor->id);
260 $record->create_date('now');
261 $record->edit_date('now');
262 $record->marc( entityize( $marcdoc->documentElement->toString ) );
264 my $id = $session->request(
265 "open-ils.storage.direct.biblio.record_entry.create", $record )->gather(1);
267 return $U->DB_UPDATE_FAILED($record) unless $id;
270 $logger->info("marc create/import created new record $id");
272 $apputils->commit_db_session($session);
274 $logger->debug("Sending record off to be wormized");
279 'open-ils.ingest.full.biblio.record', $id );
281 # my $stat = $U->storagereq( 'open-ils.worm.wormize.biblio', $id );
282 # throw OpenSRF::EX::ERROR
283 # ("Unable to wormize imported record") unless $stat;
292 my $override = shift;
293 my $existing_rec = shift || 0;
296 my $marcxml = XML::LibXML->new->parse_string( $xml );
297 $marcxml->documentElement->setNamespace(
298 "http://www.loc.gov/MARC21/slim", "marc", 1 );
300 my $xpath = '//marc:controlfield[@tag="001"]';
301 my $tcn = $marcxml->documentElement->findvalue($xpath);
302 $logger->info("biblio import located 001 (tcn) value of $tcn");
304 $xpath = '//marc:controlfield[@tag="003"]';
305 my $tcn_source = $marcxml->documentElement->findvalue($xpath) || "System Local";
307 if(my $rec = _tcn_exists($session, $tcn, $tcn_source, $existing_rec) ) {
310 $tcn = find_free_tcn( $marcxml, $session, $existing_rec );
312 # if we're overriding, try to find a different TCN to use
315 $logger->activity("tcn value $tcn already exists, attempting to override");
323 'OPEN_TCN_NOT_FOUND',
324 payload => $marcxml->toString())
330 $logger->warn("tcn value $origtcn already exists in import/create");
332 # otherwise, return event
338 'TCN_EXISTS', payload => {
348 return ($tcn, $tcn_source, $marcxml);
355 my $existing_rec = shift;
359 my $xpath = '//marc:datafield[@tag="039"]/subfield[@code="a"]';
360 my ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
361 $xpath = '//marc:datafield[@tag="039"]/subfield[@code="b"]';
362 my $tcn_source = $marcxml->documentElement->findvalue($xpath) || "System Local";
364 if(_tcn_exists($session, $tcn, $tcn_source, $existing_rec)) {
372 $xpath = '//marc:datafield[@tag="020"]/subfield[@code="a"]';
373 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
374 $tcn_source = "ISBN";
375 if(_tcn_exists($session, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
379 $xpath = '//marc:datafield[@tag="022"]/subfield[@code="a"]';
380 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
381 $tcn_source = "ISSN";
382 if(_tcn_exists($session, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
386 $xpath = '//marc:datafield[@tag="010"]';
387 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
388 $tcn_source = "LCCN";
389 if(_tcn_exists($session, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
393 $xpath = '//marc:datafield[@tag="035"]/subfield[@code="a"]';
394 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
395 $tcn_source = "System Legacy";
396 if(_tcn_exists($session, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
399 $marcxml->documentElement->removeChild(
400 $marcxml->documentElement->findnodes( '//datafield[@tag="035"]' )
405 return undef unless $tcn;
408 my $df = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'datafield');
409 $df->setAttribute( tag => '039' );
410 $df->setAttribute( ind1 => ' ' );
411 $df->setAttribute( ind2 => ' ' );
412 $marcxml->documentElement->appendChild( $df );
414 my $sfa = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'subfield');
415 $sfa->setAttribute( code => 'a' );
416 $sfa->appendChild( $marcxml->createTextNode( $tcn ) );
417 $df->appendChild( $sfa );
419 my $sfb = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'subfield');
420 $sfb->setAttribute( code => 'b' );
421 $sfb->appendChild( $marcxml->createTextNode( $tcn_source ) );
422 $df->appendChild( $sfb );
434 my $existing_rec = shift || 0;
436 if(!$tcn) {return 0;}
438 $logger->debug("tcn_exists search for tcn $tcn and source $source and id $existing_rec");
440 # XXX why does the source matter?
441 # my $req = $session->request(
442 # { tcn_value => $tcn, tcn_source => $source, deleted => 'f' } );
444 my $req = $session->request(
445 "open-ils.storage.id_list.biblio.record_entry.search_where.atomic",
446 { tcn_value => $tcn, deleted => 'f', id => {'!=' => $existing_rec} } );
448 my $recs = $req->gather(1);
450 if($recs and $recs->[0]) {
451 $logger->debug("_tcn_exists is true for tcn : $tcn ($source)");
455 $logger->debug("_tcn_exists is false for tcn : $tcn ($source)");
462 # XXX deprecated. Remove me.
466 __PACKAGE__->register_method(
467 method => "biblio_record_tree_retrieve",
468 api_name => "open-ils.cat.biblio.record.tree.retrieve",
471 sub biblio_record_tree_retrieve {
473 my( $self, $client, $recordid ) = @_;
475 my $name = "open-ils.storage.direct.biblio.record_entry.retrieve";
476 my $session = OpenSRF::AppSession->create( "open-ils.storage" );
477 my $request = $session->request( $name, $recordid );
478 my $marcxml = $request->gather(1);
481 throw OpenSRF::EX::ERROR
482 ("No record in database with id $recordid");
485 $session->disconnect();
488 warn "turning into nodeset\n";
489 my $nodes = OpenILS::Utils::FlatXML->new()->xml_to_nodeset( $marcxml->marc );
490 warn "turning nodeset into tree\n";
491 my $tree = $utils->nodeset2tree( $nodes->nodeset );
493 $tree->owner_doc( $marcxml->id() );
495 warn "returning tree\n";
503 __PACKAGE__->register_method(
504 method => "biblio_record_xml_update",
505 api_name => "open-ils.cat.biblio.record.xml.update",
506 argc => 3, #(session_id, biblio_tree )
507 notes => <<' NOTES');
508 Updates the XML of a biblio record entry
509 @param authtoken The session token for the staff updating the record
510 @param docID The record entry ID to update
511 @param xml The new MARCXML record
514 sub biblio_record_xml_update {
516 my( $self, $client, $user_session, $id, $xml ) = @_;
518 my $user_obj = $apputils->check_user_session($user_session);
520 if($apputils->check_user_perms(
521 $user_obj->id, $user_obj->home_ou, "UPDATE_MARC")) {
522 return OpenILS::Perm->new("UPDATE_MARC");
525 $logger->activity("user ".$user_obj->id." updating biblio record $id");
528 my $session = OpenILS::Application::AppUtils->start_db_session();
530 warn "Retrieving biblio record from storage for update\n";
532 my $req1 = $session->request(
533 "open-ils.storage.direct.biblio.record_entry.batch.retrieve", $id );
534 my $biblio = $req1->gather(1);
536 warn "retrieved doc $id\n";
538 my $doc = XML::LibXML->new->parse_string($xml);
539 throw OpenSRF::EX::ERROR ("Invalid XML in record update: $xml") unless $doc;
541 $biblio->marc( entityize( $doc->documentElement->toString ) );
542 $biblio->editor( $user_obj->id );
543 $biblio->edit_date( 'now' );
545 warn "Sending updated doc $id to db with xml ".$biblio->marc. "\n";
547 my $req = $session->request(
548 "open-ils.storage.direct.biblio.record_entry.update", $biblio );
551 my $status = $req->recv();
552 if( !$status || $status->isa("Error") || ! $status->content) {
553 OpenILS::Application::AppUtils->rollback_db_session($session);
554 if($status->isa("Error")) { throw $status ($status); }
555 throw OpenSRF::EX::ERROR ("Error updating biblio record");
559 # Send the doc to the wormer for wormizing
560 warn "Starting worm session\n";
565 my $wreq = $session->request( "open-ils.worm.wormize.biblio", $id );
569 $w = $wreq->gather(1);
573 warn "wormizing failed, rolling back\n";
574 OpenILS::Application::AppUtils->rollback_db_session($session);
576 if($e) { throw $e ($e); }
577 throw OpenSRF::EX::ERROR ("Wormizing Failed for $id" );
580 warn "Committing db session...\n";
581 OpenILS::Application::AppUtils->commit_db_session( $session );
583 # $client->respond_complete($tree);
585 warn "Done wormizing\n";
588 #warn "Returning tree:\n";
599 __PACKAGE__->register_method(
600 method => "biblio_record_record_metadata",
601 api_name => "open-ils.cat.biblio.record.metadata.retrieve",
602 argc => 1, #(session_id, biblio_tree )
603 notes => "Walks the tree and commits any changed nodes " .
604 "adds any new nodes, and deletes any deleted nodes",
607 sub biblio_record_record_metadata {
608 my( $self, $client, $authtoken, $ids ) = @_;
610 return [] unless $ids and @$ids;
612 my $editor = new_editor(authtoken => $authtoken);
613 return $editor->event unless $editor->checkauth;
614 return $editor->event unless $editor->allowed('VIEW_USER');
619 return $editor->event unless
620 my $rec = $editor->retrieve_biblio_record_entry($_);
621 $rec->creator($editor->retrieve_actor_user($rec->creator));
622 $rec->editor($editor->retrieve_actor_user($rec->editor));
623 $rec->clear_marc; # slim the record down
624 push( @results, $rec );
632 __PACKAGE__->register_method(
633 method => "biblio_record_marc_cn",
634 api_name => "open-ils.cat.biblio.record.marc_cn.retrieve",
635 argc => 1, #(bib id )
638 sub biblio_record_marc_cn {
639 my( $self, $client, $id ) = @_;
641 my $session = OpenSRF::AppSession->create("open-ils.cstore");
643 ->request("open-ils.cstore.direct.biblio.record_entry.retrieve", $id )
647 my $doc = XML::LibXML->new->parse_string($marc);
648 $doc->documentElement->setNamespace( "http://www.loc.gov/MARC21/slim", "marc", 1 );
651 for my $tag ( qw/050 055 060 070 080 082 086 088 090 092 096 098 099/ ) {
652 my @node = $doc->findnodes("//marc:datafield[\@tag='$tag']");
654 my $cn = $x->findvalue("marc:subfield[\@code='a' or \@code='b']");
655 push @res, {$tag => $cn} if ($cn);
662 sub _get_id_by_userid {
667 my $session = OpenSRF::AppSession->create( "open-ils.cstore" );
668 my $request = $session->request(
669 "open-ils.cstore.direct.actor.user.search.atomic", { usrname => \@users } );
671 $request->wait_complete;
672 my $response = $request->recv();
673 if(!$request->complete) {
674 throw OpenSRF::EX::ERROR ("no response from cstore on user retrieve");
677 if(UNIVERSAL::isa( $response, "Error")){
678 throw $response ($response);
681 for my $u (@{$response->content}) {
687 $session->disconnect;
694 # commits metadata objects to the db
695 sub _update_record_metadata {
697 my ($session, @docs ) = @_;
699 for my $doc (@docs) {
701 my $user_obj = $doc->{user};
702 my $docid = $doc->{docid};
704 warn "Updating metata for doc $docid\n";
706 my $request = $session->request(
707 "open-ils.storage.direct.biblio.record_entry.retrieve", $docid );
708 my $record = $request->gather(1);
710 warn "retrieved record\n";
711 my ($id) = _get_id_by_userid($user_obj->usrname);
713 warn "got $id from _get_id_by_userid\n";
714 $record->editor($id);
716 warn "Grabbed the record, updating and moving on\n";
718 $request = $session->request(
719 "open-ils.storage.direct.biblio.record_entry.update", $record );
723 warn "committing metarecord update\n";
730 __PACKAGE__->register_method(
731 method => "orgs_for_title",
732 api_name => "open-ils.cat.actor.org_unit.retrieve_by_title"
736 my( $self, $client, $record_id ) = @_;
738 my $vols = $apputils->simple_scalar_request(
740 "open-ils.cstore.direct.asset.call_number.search.atomic",
741 { record => $record_id, deleted => 'f' });
743 my $orgs = { map {$_->owning_lib => 1 } @$vols };
744 return [ keys %$orgs ];
748 __PACKAGE__->register_method(
749 method => "retrieve_copies",
750 api_name => "open-ils.cat.asset.copy_tree.retrieve");
752 __PACKAGE__->register_method(
753 method => "retrieve_copies",
754 api_name => "open-ils.cat.asset.copy_tree.global.retrieve");
756 # user_session may be null/undef
757 sub retrieve_copies {
759 my( $self, $client, $user_session, $docid, @org_ids ) = @_;
761 if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
765 warn " $$ retrieving copy tree for orgs @org_ids and doc $docid at " . time() . "\n";
767 # grabbing copy trees should be available for everyone..
768 if(!@org_ids and $user_session) {
770 OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
771 @org_ids = ($user_obj->home_ou);
774 if( $self->api_name =~ /global/ ) {
775 warn "performing global copy_tree search for $docid\n";
776 return _build_volume_list( { record => $docid } );
781 for my $orgid (@org_ids) {
782 my $vols = _build_volume_list(
783 { record => $docid, owning_lib => $orgid } );
784 warn "Volumes built for org $orgid\n";
785 push( @all_vols, @$vols );
788 warn " $$ Finished copy_tree at " . time() . "\n";
796 sub _build_volume_list {
797 my $search_hash = shift;
799 $search_hash->{deleted} = 'f';
801 my $session = OpenSRF::AppSession->create( "open-ils.cstore" );
804 my $request = $session->request(
805 "open-ils.cstore.direct.asset.call_number.search.atomic", $search_hash );
806 #"open-ils.storage.direct.asset.call_number.search.atomic", $search_hash );
808 my $vols = $request->gather(1);
811 for my $volume (@$vols) {
813 warn "Grabbing copies for volume: " . $volume->id . "\n";
814 my $creq = $session->request(
815 "open-ils.cstore.direct.asset.copy.search.atomic",
816 { call_number => $volume->id , deleted => 'f' });
817 #"open-ils.storage.direct.asset.copy.search.call_number.atomic", $volume->id );
819 my $copies = $creq->gather(1);
821 $copies = [ sort { $a->barcode cmp $b->barcode } @$copies ];
823 $volume->copies($copies);
825 push( @volumes, $volume );
829 $session->disconnect();
835 __PACKAGE__->register_method(
836 method => "fleshed_copy_update",
837 api_name => "open-ils.cat.asset.copy.fleshed.batch.update",);
839 __PACKAGE__->register_method(
840 method => "fleshed_copy_update",
841 api_name => "open-ils.cat.asset.copy.fleshed.batch.update.override",);
844 sub fleshed_copy_update {
845 my( $self, $conn, $auth, $copies, $delete_stats ) = @_;
846 return 1 unless ref $copies;
847 my( $reqr, $evt ) = $U->checkses($auth);
849 my $editor = new_editor(requestor => $reqr, xact => 1);
850 my $override = $self->api_name =~ /override/;
851 $evt = update_fleshed_copies($editor, $override, undef, $copies, $delete_stats);
854 $logger->info("fleshed copy update successfully updated ".scalar(@$copies)." copies");
859 __PACKAGE__->register_method(
861 api_name => 'open-ils.cat.biblio.records.merge',
863 Merges a group of records
864 @param auth The login session key
865 @param master The id of the record all other r
866 ecords should be merged into
867 @param records Array of records to be merged into the master record
868 @return 1 on success, Event on error.
873 my( $self, $conn, $auth, $master, $records ) = @_;
874 my( $reqr, $evt ) = $U->checkses($auth);
876 my $editor = new_editor( requestor => $reqr, xact => 1 );
877 my $v = OpenILS::Application::Cat::Merge::merge_records($editor, $master, $records);
886 # ---------------------------------------------------------------------------
887 # ---------------------------------------------------------------------------
889 # returns true if the given title (id) has no un-deleted
892 my( $editor, $rid ) = @_;
894 my $cnlist = $editor->search_asset_call_number(
895 { record => $rid, deleted => 'f' }, { idlist => 1 } );
896 return 1 unless @$cnlist;
898 for my $cn (@$cnlist) {
899 my $copylist = $editor->search_asset_copy(
900 { call_number => $cn, deleted => 'f' }, { idlist => 1 });
901 return 0 if @$copylist; # false if we find any copies
908 __PACKAGE__->register_method(
909 method => "fleshed_volume_update",
910 api_name => "open-ils.cat.asset.volume.fleshed.batch.update",);
912 __PACKAGE__->register_method(
913 method => "fleshed_volume_update",
914 api_name => "open-ils.cat.asset.volume.fleshed.batch.update.override",);
916 sub fleshed_volume_update {
917 my( $self, $conn, $auth, $volumes, $delete_stats ) = @_;
918 my( $reqr, $evt ) = $U->checkses($auth);
921 my $override = ($self->api_name =~ /override/);
922 my $editor = new_editor( requestor => $reqr, xact => 1 );
924 for my $vol (@$volumes) {
925 $logger->info("vol-update: investigating volume ".$vol->id);
927 $vol->editor($reqr->id);
928 $vol->edit_date('now');
930 my $copies = $vol->copies;
933 $vol->editor($editor->requestor->id);
934 $vol->edit_date('now');
936 if( $vol->isdeleted ) {
938 $logger->info("vol-update: deleting volume");
939 my $cs = $editor->search_asset_copy(
940 { call_number => $vol->id, deleted => 'f' } );
941 return OpenILS::Event->new(
942 'VOLUME_NOT_EMPTY', payload => $vol->id ) if @$cs;
945 return $editor->event unless
946 $editor->update_asset_call_number($vol);
949 } elsif( $vol->isnew ) {
950 $logger->info("vol-update: creating volume");
951 $evt = create_volume( $override, $editor, $vol );
954 } elsif( $vol->ischanged ) {
955 $logger->info("vol-update: update volume");
956 return $editor->event unless
957 $editor->update_asset_call_number($vol);
961 # now update any attached copies
962 if( @$copies and !$vol->isdeleted ) {
963 $_->call_number($vol->id) for @$copies;
964 $evt = update_fleshed_copies( $editor, $override, $vol, $copies, $delete_stats );
970 return scalar(@$volumes);
974 # this does the actual work
975 sub update_fleshed_copies {
976 my( $editor, $override, $vol, $copies, $delete_stats ) = @_;
979 my $fetchvol = ($vol) ? 0 : 1;
982 $cache{$vol->id} = $vol if $vol;
984 for my $copy (@$copies) {
986 my $copyid = $copy->id;
987 $logger->info("vol-update: inspecting copy $copyid");
989 if( !($vol = $cache{$copy->call_number}) ) {
990 $vol = $cache{$copy->call_number} =
991 $editor->retrieve_asset_call_number($copy->call_number);
992 return $editor->event unless $vol;
995 $copy->editor($editor->requestor->id);
996 $copy->edit_date('now');
998 $copy->status( $copy->status->id ) if ref($copy->status);
999 $copy->location( $copy->location->id ) if ref($copy->location);
1000 $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
1002 my $sc_entries = $copy->stat_cat_entries;
1003 $copy->clear_stat_cat_entries;
1005 if( $copy->isdeleted ) {
1006 $evt = delete_copy($editor, $override, $vol, $copy);
1007 return $evt if $evt;
1009 } elsif( $copy->isnew ) {
1010 $evt = create_copy( $editor, $vol, $copy );
1011 return $evt if $evt;
1013 } elsif( $copy->ischanged ) {
1015 $evt = update_copy( $editor, $override, $vol, $copy );
1016 return $evt if $evt;
1019 $copy->stat_cat_entries( $sc_entries );
1020 $evt = update_copy_stat_entries($editor, $copy, $delete_stats);
1021 return $evt if $evt;
1024 $logger->debug("vol-update: done updating copy batch");
1031 my( $editor, $override, $vol, $copy ) = @_;
1033 $logger->info("vol-update: updating copy ".$copy->id);
1034 my $orig_copy = $editor->retrieve_asset_copy($copy->id);
1035 my $orig_vol = $editor->retrieve_asset_call_number($copy->call_number);
1037 $copy->editor($editor->requestor->id);
1038 $copy->edit_date('now');
1039 return $editor->event unless
1040 $editor->update_asset_copy(
1041 $copy, {checkperm=>1, permorg=>$vol->owning_lib});
1043 return remove_empty_objects($editor, $override, $orig_vol);
1047 sub remove_empty_objects {
1048 my( $editor, $override, $vol ) = @_;
1049 if( title_is_empty($editor, $vol->record) ) {
1053 # delete this volume if it's not already marked as deleted
1054 unless( $U->is_true($vol->deleted) || $vol->isdeleted ) {
1056 $vol->editor($editor->requestor->id);
1057 $vol->edit_date('now');
1058 $editor->update_asset_call_number($vol, {checkperm=>0})
1059 or return $editor->event;
1062 # then delete the record this volume points to
1063 my $rec = $editor->retrieve_biblio_record_entry($vol->record)
1064 or return $editor->event;
1066 unless( $U->is_true($rec->deleted) ) {
1069 $editor->update_biblio_record_entry($rec, {checkperm=>0})
1070 or return $editor->event;
1074 return OpenILS::Event->new('TITLE_LAST_COPY', payload => $vol->record );
1083 my( $editor, $override, $vol, $copy ) = @_;
1085 $logger->info("vol-update: deleting copy ".$copy->id);
1086 $copy->deleted('t');
1088 $copy->editor($editor->requestor->id);
1089 $copy->edit_date('now');
1090 $editor->update_asset_copy(
1091 $copy, {checkperm=>1, permorg=>$vol->owning_lib})
1092 or return $editor->event;
1094 # Delete any open transits for this copy
1095 my $transits = $editor->search_action_transit_copy(
1096 { target_copy=>$copy->id, dest_recv_time => undef } );
1098 for my $t (@$transits) {
1099 $editor->delete_action_transit_copy($t)
1100 or return $editor->event;
1103 return remove_empty_objects($editor, $override, $vol);
1108 my( $editor, $vol, $copy ) = @_;
1110 my $existing = $editor->search_asset_copy(
1111 { barcode => $copy->barcode } );
1113 return OpenILS::Event->new('ITEM_BARCODE_EXISTS') if @$existing;
1116 $copy->creator($editor->requestor->id);
1117 $copy->create_date('now');
1119 $editor->create_asset_copy(
1120 $copy, {checkperm=>1, permorg=>$vol->owning_lib})
1121 or return $editor->event;
1126 # if 'delete_stats' is true, the copy->stat_cat_entries data is
1127 # treated as the authoritative list for the copy. existing entries
1128 # that are not in said list will be deleted from the DB
1129 sub update_copy_stat_entries {
1130 my( $editor, $copy, $delete_stats ) = @_;
1133 my $entries = $copy->stat_cat_entries;
1135 if( $delete_stats ) {
1136 $entries = ($entries and @$entries) ? $entries : [];
1138 return undef unless ($entries and @$entries);
1141 my $maps = $editor->search_asset_stat_cat_entry_copy_map({owning_copy=>$copy->id});
1144 # if there is no stat cat entry on the copy who's id matches the
1145 # current map's id, remove the map from the database
1146 for my $map (@$maps) {
1147 if(! grep { $_->id == $map->stat_cat_entry } @$entries ) {
1149 $logger->info("copy update found stale ".
1150 "stat cat entry map ".$map->id. " on copy ".$copy->id);
1152 $editor->delete_asset_stat_cat_entry_copy_map($map)
1153 or return $editor->event;
1158 # go through the stat cat update/create process
1159 for my $entry (@$entries) {
1162 # if this link already exists in the DB, don't attempt to re-create it
1163 next if( grep{$_->stat_cat_entry == $entry->id} @$maps );
1165 my $new_map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
1167 $new_map->stat_cat( $entry->stat_cat );
1168 $new_map->stat_cat_entry( $entry->id );
1169 $new_map->owning_copy( $copy->id );
1171 $editor->create_asset_stat_cat_entry_copy_map($new_map)
1172 or return $editor->event;
1174 $logger->info("copy update created new stat cat entry map ".$editor->data);
1182 my( $override, $editor, $vol ) = @_;
1186 # first lets see if there are any collisions
1187 my $vols = $editor->search_asset_call_number( {
1188 owning_lib => $vol->owning_lib,
1189 record => $vol->record,
1190 label => $vol->label,
1198 $label = $vol->label;
1200 return OpenILS::Event->new(
1201 'VOLUME_LABEL_EXISTS', payload => $vol->id);
1205 # create a temp label so we can create the volume, then de-dup it
1206 $vol->label( '__SYSTEM_TMP_'.time) if $label;
1208 $vol->creator($editor->requestor->id);
1209 $vol->create_date('now');
1210 $vol->editor($editor->requestor->id);
1211 $vol->edit_date('now');
1214 $editor->create_asset_call_number($vol) or return $editor->event;
1217 # now restore the label and merge into the existing record
1218 $vol->label($label);
1220 OpenILS::Application::Cat::Merge::merge_volumes($editor, [$vol], $$vols[0]);
1221 return $evt if $evt;
1228 __PACKAGE__->register_method (
1229 method => 'batch_volume_transfer',
1230 api_name => 'open-ils.cat.asset.volume.batch.transfer',
1233 __PACKAGE__->register_method (
1234 method => 'batch_volume_transfer',
1235 api_name => 'open-ils.cat.asset.volume.batch.transfer.override',
1239 sub batch_volume_transfer {
1240 my( $self, $conn, $auth, $args ) = @_;
1243 my $rec = $$args{docid};
1244 my $o_lib = $$args{lib};
1245 my $vol_ids = $$args{volumes};
1247 my $override = 1 if $self->api_name =~ /override/;
1249 $logger->info("merge: transferring volumes to lib=$o_lib and record=$rec");
1251 my $e = new_editor(authtoken => $auth, xact =>1);
1252 return $e->event unless $e->checkauth;
1253 return $e->event unless $e->allowed('VOLUME_UPDATE');
1255 my $dorg = $e->retrieve_actor_org_unit($o_lib)
1256 or return $e->event;
1258 my $ou_type = $e->retrieve_actor_org_unit_type($dorg->ou_type)
1259 or return $e->event;
1261 return OpenILS::Event->new('ORG_CANNOT_HAVE_VOLS')
1262 unless $U->is_true($ou_type->can_have_vols);
1264 my $vols = $e->batch_retrieve_asset_call_number($vol_ids);
1267 for my $vol (@$vols) {
1269 # if we've already looked at this volume, go to the next
1270 next if !$vol or grep { $vol->id == $_ } @seen;
1272 # grab all of the volumes in the list that have
1273 # the same label so they can be merged
1274 my @all = grep { $_->label eq $vol->label } @$vols;
1276 # take note of the fact that we've looked at this set of volumes
1277 push( @seen, $_->id ) for @all;
1279 # for each volume, see if there are any copies that have a
1280 # remote circ_lib (circ_lib != vol->owning_lib and != $o_lib ).
1282 unless( $override ) {
1285 $logger->debug("merge: searching for copies with remote circ_lib for volume ".$v->id);
1287 call_number => $v->id,
1288 circ_lib => { "!=" => $v->owning_lib },
1292 my $copies = $e->search_asset_copy($args, {idlist=>1});
1294 # if the copy's circ_lib matches the destination lib,
1296 $copies = [ grep { $_->circ_lib ne $o_lib } @$copies ];
1297 return OpenILS::Event->new('COPY_REMOTE_CIRC_LIB') if @$copies;
1301 # see if there is a volume at the destination lib that
1302 # already has the requested label
1303 my $existing_vol = $e->search_asset_call_number(
1305 label => $vol->label,
1307 owning_lib =>$o_lib,
1312 if( $existing_vol ) {
1314 if( grep { $_->id == $existing_vol->id } @all ) {
1315 # this volume is already accounted for in our list of volumes to merge
1316 $existing_vol = undef;
1319 # this volume exists on the destination record/owning_lib and must
1320 # be used as the destination for merging
1321 $logger->debug("merge: volume already exists at destination record: ".
1322 $existing_vol->id.' : '.$existing_vol->label) if $existing_vol;
1326 if( @all > 1 || $existing_vol ) {
1327 $logger->info("merge: found collisions in volume transfer");
1328 my @args = ($e, \@all);
1329 @args = ($e, \@all, $existing_vol) if $existing_vol;
1330 ($vol, $evt) = OpenILS::Application::Cat::Merge::merge_volumes(@args);
1331 return $evt if $evt;
1334 if( !$existing_vol ) {
1336 $vol->owning_lib($o_lib);
1338 $vol->editor($e->requestor->id);
1339 $vol->edit_date('now');
1341 $logger->info("merge: updating volume ".$vol->id);
1342 $e->update_asset_call_number($vol) or return $e->event;
1345 $logger->info("merge: bypassing volume update because existing volume used as target");
1348 # regardless of what volume was used as the destination,
1349 # update any copies that have moved over to the new lib
1350 my $copies = $e->search_asset_copy({call_number=>$vol->id, deleted => 'f'});
1352 # update circ lib on the copies - make this a method flag?
1353 for my $copy (@$copies) {
1354 next if $copy->circ_lib == $o_lib;
1355 $logger->info("merge: transfer moving circ lib on copy ".$copy->id);
1356 $copy->circ_lib($o_lib);
1357 $copy->editor($e->requestor->id);
1358 $copy->edit_date('now');
1359 $e->update_asset_copy($copy) or return $e->event;
1362 # Now see if any empty records need to be deleted after all of this
1364 $evt = remove_empty_objects($e, $override, $_);
1365 return $evt if $evt;
1369 $logger->info("merge: transfer succeeded");