]> git.evergreen-ils.org Git - Evergreen.git/blob - Open-ILS/src/perlmods/OpenILS/Application/Cat.pm
fixed variable name - removed some old code
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / Application / Cat.pm
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);
10 use JSON;
11 use OpenILS::Utils::Fieldmapper;
12 use OpenILS::Event;
13 use OpenILS::Const qw/:const/;
14
15 use XML::LibXML;
16 use Unicode::Normalize;
17 use Data::Dumper;
18 use OpenILS::Utils::FlatXML;
19 use OpenILS::Utils::CStoreEditor q/:funcs/;
20 use OpenILS::Utils::Editor;
21 use OpenILS::Perm;
22 use OpenSRF::Utils::SettingsClient;
23 use OpenSRF::Utils::Logger qw($logger);
24 use OpenSRF::AppSession;
25
26 my $apputils = "OpenILS::Application::AppUtils";
27
28 my $utils = "OpenILS::Application::Cat::Utils";
29 my $U = "OpenILS::Application::AppUtils";
30
31 my $conf;
32
33 my %marctemplates;
34
35 sub entityize { 
36         my $stuff = shift;
37         my $form = shift || "";
38
39         if ($form eq 'D') {
40                 $stuff = NFD($stuff);
41         } else {
42                 $stuff = NFC($stuff);
43         }
44
45         $stuff =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
46         return $stuff;
47 }
48
49 __PACKAGE__->register_method(
50         method  => "retrieve_marc_template",
51         api_name        => "open-ils.cat.biblio.marc_template.retrieve",
52         notes           => <<"  NOTES");
53         Returns a MARC 'record tree' based on a set of pre-defined templates.
54         Templates include : book
55         NOTES
56
57 sub retrieve_marc_template {
58         my( $self, $client, $type ) = @_;
59
60         return $marctemplates{$type} if defined($marctemplates{$type});
61         $marctemplates{$type} = _load_marc_template($type);
62         return $marctemplates{$type};
63 }
64
65 sub _load_marc_template {
66         my $type = shift;
67
68         if(!$conf) { $conf = OpenSRF::Utils::SettingsClient->new; }
69
70         my $template = $conf->config_value(                                     
71                 "apps", "open-ils.cat","app_settings", "marctemplates", $type );
72         warn "Opening template file $template\n";
73
74         open( F, $template ) or 
75                 throw OpenSRF::EX::ERROR ("Unable to open MARC template file: $template : $@");
76
77         my @xml = <F>;
78         close(F);
79         my $xml = join('', @xml);
80
81         return XML::LibXML->new->parse_string($xml)->documentElement->toString;
82 }
83
84 my $__bib_sources;
85 sub bib_source_from_name {
86         my $name = shift;
87         $logger->debug("searching for bib source: $name");
88
89         $__bib_sources = new_editor()->retrieve_all_config_bib_source()
90                 unless $__bib_sources;
91
92         my ($s) = grep { lc($_->source) eq lc($name) } @$__bib_sources;
93
94         return $s->id if $s;
95         return undef;
96 }
97
98
99
100 __PACKAGE__->register_method(
101         method  => "create_record_xml",
102         api_name        => "open-ils.cat.biblio.record.xml.create.override",
103         signature       => q/@see open-ils.cat.biblio.record.xml.create/);
104
105 __PACKAGE__->register_method(
106         method          => "create_record_xml",
107         api_name                => "open-ils.cat.biblio.record.xml.create",
108         signature       => q/
109                 Inserts a new biblio with the given XML
110         /
111 );
112
113 sub create_record_xml {
114         my( $self, $client, $login, $xml, $source ) = @_;
115
116         my $override = 1 if $self->api_name =~ /override/;
117
118         my( $user_obj, $evt ) = $U->checksesperm($login, 'CREATE_MARC');
119         return $evt if $evt;
120
121         $logger->activity("user ".$user_obj->id." creating new MARC record");
122
123         my $meth = $self->method_lookup("open-ils.cat.biblio.record.xml.import");
124
125         $meth = $self->method_lookup(
126                 "open-ils.cat.biblio.record.xml.import.override") if $override;
127
128         my ($s) = $meth->run($login, $xml, $source);
129         return $s;
130 }
131
132
133
134 __PACKAGE__->register_method(
135         method  => "biblio_record_replace_marc",
136         api_name        => "open-ils.cat.biblio.record.xml.update",
137         argc            => 3, 
138         signature       => q/
139                 Updates the XML for a given biblio record.
140                 This does not change any other aspect of the record entry
141                 exception the XML, the editor, and the edit date.
142                 @return The update record object
143         /
144 );
145
146 __PACKAGE__->register_method(
147         method          => 'biblio_record_replace_marc',
148         api_name                => 'open-ils.cat.biblio.record.marc.replace',
149         signature       => q/
150                 @param auth The authtoken
151                 @param recid The record whose MARC we're replacing
152                 @param newxml The new xml to use
153         /
154 );
155
156 __PACKAGE__->register_method(
157         method          => 'biblio_record_replace_marc',
158         api_name                => 'open-ils.cat.biblio.record.marc.replace.override',
159         signature       => q/@see open-ils.cat.biblio.record.marc.replace/
160 );
161
162 sub biblio_record_replace_marc  {
163         my( $self, $conn, $auth, $recid, $newxml, $source ) = @_;
164
165         my $e = OpenILS::Utils::Editor->new(authtoken=>$auth, xact=>1);
166
167         return $e->event unless $e->checkauth;
168         return $e->event unless $e->allowed('CREATE_MARC');
169
170         my $rec = $e->retrieve_biblio_record_entry($recid)
171                 or return $e->event;
172
173         my $fixtcn = 1 if $self->api_name =~ /replace/o;
174
175         # See if there is a different record in the database that has our TCN value
176         # If we're not updating the TCN, all we care about it the marcdoc
177         my $override = $self->api_name =~ /override/;
178
179         my $storage = OpenSRF::AppSession->create('open-ils.storage');
180
181         my( $tcn, $tsource, $marcdoc, $evt) = 
182                 _find_tcn_info($e->session, $newxml, $override, $recid);
183
184         return $evt if $evt;
185
186         if( $fixtcn ) {
187                 $rec->tcn_value($tcn);
188                 $rec->tcn_source($tsource);
189         }
190
191         $rec->source(bib_source_from_name($source)) if $source;
192         $rec->editor($e->requestor->id);
193         $rec->edit_date('now');
194         $rec->marc( entityize( $marcdoc->documentElement->toString ) );
195
196         $logger->activity("user ".$e->requestor->id." replacing MARC for record $recid");
197
198         $e->update_biblio_record_entry($rec) or return $e->event;
199         $e->commit;
200
201         $conn->respond_complete($rec);
202
203         $U->simplereq(
204                 'open-ils.ingest',
205                 'open-ils.ingest.full.biblio.record', $recid );
206
207         return undef;
208 }
209
210
211
212
213 __PACKAGE__->register_method(
214         method  => "biblio_record_xml_import",
215         api_name        => "open-ils.cat.biblio.record.xml.import.override",
216         signature       => q/@see open-ils.cat.biblio.record.xml.import/);
217
218 __PACKAGE__->register_method(
219         method  => "biblio_record_xml_import",
220         api_name        => "open-ils.cat.biblio.record.xml.import",
221         notes           => <<"  NOTES");
222         Takes a marcxml record and imports the record into the database.  In this
223         case, the marcxml record is assumed to be a complete record (i.e. valid
224         MARC).  The title control number is taken from (whichever comes first)
225         tags 001, 039[ab], 020a, 022a, 010, 035a and whichever does not already exist
226         in the database.
227         user_session must have IMPORT_MARC permissions
228         NOTES
229
230
231 sub biblio_record_xml_import {
232         my( $self, $client, $authtoken, $xml, $source) = @_;
233
234
235         # XXX Make the source the ID from config.bib_source
236
237         my $override = 1 if $self->api_name =~ /override/;
238
239         my( $tcn, $tcn_source, $marcdoc );
240         my( $requestor, $evt ) = $U->checksesperm($authtoken, 'IMPORT_MARC');
241         return $evt if $evt;
242
243         my $session = $apputils->start_db_session();
244
245         ( $tcn, $tcn_source, $marcdoc, $evt ) = _find_tcn_info($session, $xml, $override);
246         return $evt if $evt;
247
248         $logger->activity("user ".$requestor->id.
249                 " creating new biblio entry with tcn=$tcn and tcn_source $tcn_source");
250
251         my $record = Fieldmapper::biblio::record_entry->new;
252
253         $record->source(bib_source_from_name($source)) if $source;
254         $record->tcn_source($tcn_source);
255         $record->tcn_value($tcn);
256         $record->creator($requestor->id);
257         $record->editor($requestor->id);
258         $record->create_date('now');
259         $record->edit_date('now');
260         $record->marc( entityize( $marcdoc->documentElement->toString ) );
261
262         my $id = $session->request(
263                 "open-ils.storage.direct.biblio.record_entry.create", $record )->gather(1);
264
265         return $U->DB_UPDATE_FAILED($record) unless $id;
266         $record->id( $id );
267
268         $logger->info("marc create/import created new record $id");
269
270         $apputils->commit_db_session($session);
271
272         $logger->debug("Sending record off to be wormized");
273
274         $client->respond_complete($record);
275
276         $U->simplereq(
277                 'open-ils.ingest',
278                 'open-ils.ingest.full.biblio.record', $id );
279
280         return undef;
281 }
282
283
284 sub _find_tcn_info { 
285         my $session             = shift;
286         my $xml                 = shift;
287         my $override    = shift;
288         my $existing_rec        = shift || 0;
289
290         # parse the XML
291         my $marcxml = XML::LibXML->new->parse_string( $xml );
292         $marcxml->documentElement->setNamespace( 
293                 "http://www.loc.gov/MARC21/slim", "marc", 1 );
294
295         my $xpath = '//marc:controlfield[@tag="001"]';
296         my $tcn = $marcxml->documentElement->findvalue($xpath);
297         $logger->info("biblio import located 001 (tcn) value of $tcn");
298
299         $xpath = '//marc:controlfield[@tag="003"]';
300         my $tcn_source = $marcxml->documentElement->findvalue($xpath) || "System Local";
301
302         if(my $rec = _tcn_exists($session, $tcn, $tcn_source, $existing_rec) ) {
303
304                 my $origtcn = $tcn;
305                 $tcn = find_free_tcn( $marcxml, $session, $existing_rec );
306
307                 # if we're overriding, try to find a different TCN to use
308                 if( $override ) {
309
310                         $logger->activity("tcn value $tcn already exists, attempting to override");
311
312                         if(!$tcn) {
313                                 return ( 
314                                         undef, 
315                                         undef, 
316                                         undef,
317                                         OpenILS::Event->new(
318                                                 'OPEN_TCN_NOT_FOUND', 
319                                                         payload => $marcxml->toString())
320                                         );
321                         }
322
323                 } else {
324
325                         $logger->warn("tcn value $origtcn already exists in import/create");
326
327                         # otherwise, return event
328                         return ( 
329                                 undef, 
330                                 undef, 
331                                 undef,
332                                 OpenILS::Event->new( 
333                                         'TCN_EXISTS', payload => { 
334                                                 dup_record      => $rec, 
335                                                 tcn                     => $origtcn,
336                                                 new_tcn         => $tcn
337                                                 }
338                                         )
339                                 );
340                 }
341         }
342
343         return ($tcn, $tcn_source, $marcxml);
344 }
345
346 sub find_free_tcn {
347
348         my $marcxml = shift;
349         my $session = shift;
350         my $existing_rec = shift;
351
352         my $add_039 = 0;
353
354         my $xpath = '//marc:datafield[@tag="039"]/subfield[@code="a"]';
355         my ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
356         $xpath = '//marc:datafield[@tag="039"]/subfield[@code="b"]';
357         my $tcn_source = $marcxml->documentElement->findvalue($xpath) || "System Local";
358
359         if(_tcn_exists($session, $tcn, $tcn_source, $existing_rec)) {
360                 $tcn = undef;
361         } else {
362                 $add_039++;
363         }
364
365
366         if(!$tcn) {
367                 $xpath = '//marc:datafield[@tag="020"]/subfield[@code="a"]';
368                 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
369                 $tcn_source = "ISBN";
370                 if(_tcn_exists($session, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
371         }
372
373         if(!$tcn) { 
374                 $xpath = '//marc:datafield[@tag="022"]/subfield[@code="a"]';
375                 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
376                 $tcn_source = "ISSN";
377                 if(_tcn_exists($session, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
378         }
379
380         if(!$tcn) {
381                 $xpath = '//marc:datafield[@tag="010"]';
382                 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
383                 $tcn_source = "LCCN";
384                 if(_tcn_exists($session, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
385         }
386
387         if(!$tcn) {
388                 $xpath = '//marc:datafield[@tag="035"]/subfield[@code="a"]';
389                 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
390                 $tcn_source = "System Legacy";
391                 if(_tcn_exists($session, $tcn, $tcn_source, $existing_rec)) {$tcn = undef;}
392
393                 if($tcn) {
394                         $marcxml->documentElement->removeChild(
395                                 $marcxml->documentElement->findnodes( '//datafield[@tag="035"]' )
396                         );
397                 }
398         }
399
400         return undef unless $tcn;
401
402         if ($add_039) {
403                 my $df = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'datafield');
404                 $df->setAttribute( tag => '039' );
405                 $df->setAttribute( ind1 => ' ' );
406                 $df->setAttribute( ind2 => ' ' );
407                 $marcxml->documentElement->appendChild( $df );
408
409                 my $sfa = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'subfield');
410                 $sfa->setAttribute( code => 'a' );
411                 $sfa->appendChild( $marcxml->createTextNode( $tcn ) );
412                 $df->appendChild( $sfa );
413
414                 my $sfb = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'subfield');
415                 $sfb->setAttribute( code => 'b' );
416                 $sfb->appendChild( $marcxml->createTextNode( $tcn_source ) );
417                 $df->appendChild( $sfb );
418         }
419
420         return $tcn;
421 }
422
423
424
425 sub _tcn_exists {
426         my $session = shift;
427         my $tcn = shift;
428         my $source = shift;
429         my $existing_rec = shift || 0;
430
431         if(!$tcn) {return 0;}
432
433         $logger->debug("tcn_exists search for tcn $tcn and source $source and id $existing_rec");
434
435         # XXX why does the source matter?
436 #       my $req = $session->request(      
437 #               { tcn_value => $tcn, tcn_source => $source, deleted => 'f' } );
438
439         my $req = $session->request(      
440                 "open-ils.storage.id_list.biblio.record_entry.search_where.atomic",
441                 { tcn_value => $tcn, deleted => 'f', id => {'!=' => $existing_rec} } );
442
443         my $recs = $req->gather(1);
444
445         if($recs and $recs->[0]) {
446                 $logger->debug("_tcn_exists is true for tcn : $tcn ($source)");
447                 return $recs->[0];
448         }
449
450         $logger->debug("_tcn_exists is false for tcn : $tcn ($source)");
451         return 0;
452 }
453
454
455
456
457 # XXX deprecated. Remove me.
458
459 =head deprecated
460
461 __PACKAGE__->register_method(
462         method  => "biblio_record_tree_retrieve",
463         api_name        => "open-ils.cat.biblio.record.tree.retrieve",
464 );
465
466 sub biblio_record_tree_retrieve {
467
468         my( $self, $client, $recordid ) = @_;
469
470         my $name = "open-ils.storage.direct.biblio.record_entry.retrieve";
471         my $session = OpenSRF::AppSession->create( "open-ils.storage" );
472         my $request = $session->request( $name, $recordid );
473         my $marcxml = $request->gather(1);
474
475         if(!$marcxml) {
476                 throw OpenSRF::EX::ERROR 
477                         ("No record in database with id $recordid");
478         }
479
480         $session->disconnect();
481         $session->kill_me();
482
483         warn "turning into nodeset\n";
484         my $nodes = OpenILS::Utils::FlatXML->new()->xml_to_nodeset( $marcxml->marc ); 
485         warn "turning nodeset into tree\n";
486         my $tree = $utils->nodeset2tree( $nodes->nodeset );
487
488         $tree->owner_doc( $marcxml->id() );
489
490         warn "returning tree\n";
491
492         return $tree;
493 }
494 =cut
495
496
497 =head deprecate 
498 __PACKAGE__->register_method(
499         method  => "biblio_record_xml_update",
500         api_name        => "open-ils.cat.biblio.record.xml.update",
501         argc            => 3, #(session_id, biblio_tree ) 
502         notes           => <<'  NOTES');
503         Updates the XML of a biblio record entry
504         @param authtoken The session token for the staff updating the record
505         @param docID The record entry ID to update
506         @param xml The new MARCXML record
507         NOTES
508
509 sub biblio_record_xml_update {
510
511         my( $self, $client, $user_session,  $id, $xml ) = @_;
512
513         my $user_obj = $apputils->check_user_session($user_session); 
514
515         if($apputils->check_user_perms(
516                         $user_obj->id, $user_obj->home_ou, "UPDATE_MARC")) {
517                 return OpenILS::Perm->new("UPDATE_MARC"); 
518         }
519
520         $logger->activity("user ".$user_obj->id." updating biblio record $id");
521
522
523         my $session = OpenILS::Application::AppUtils->start_db_session();
524
525         warn "Retrieving biblio record from storage for update\n";
526
527         my $req1 = $session->request(
528                         "open-ils.storage.direct.biblio.record_entry.batch.retrieve", $id );
529         my $biblio = $req1->gather(1);
530
531         warn "retrieved doc $id\n";
532
533         my $doc = XML::LibXML->new->parse_string($xml);
534         throw OpenSRF::EX::ERROR ("Invalid XML in record update: $xml") unless $doc;
535
536         $biblio->marc( entityize( $doc->documentElement->toString ) );
537         $biblio->editor( $user_obj->id );
538         $biblio->edit_date( 'now' );
539
540         warn "Sending updated doc $id to db with xml ".$biblio->marc. "\n";
541
542         my $req = $session->request( 
543                 "open-ils.storage.direct.biblio.record_entry.update", $biblio );
544
545         $req->wait_complete;
546         my $status = $req->recv();
547         if( !$status || $status->isa("Error") || ! $status->content) {
548                 OpenILS::Application::AppUtils->rollback_db_session($session);
549                 if($status->isa("Error")) { throw $status ($status); }
550                 throw OpenSRF::EX::ERROR ("Error updating biblio record");
551         }
552         $req->finish();
553
554         # Send the doc to the wormer for wormizing
555         warn "Starting worm session\n";
556
557         my $success = 0;
558         my $wresp;
559
560         my $wreq = $session->request( "open-ils.worm.wormize.biblio", $id );
561
562         my $w = 0;
563         try {
564                 $w = $wreq->gather(1);
565
566         } catch Error with {
567                 my $e = shift;
568                 warn "wormizing failed, rolling back\n";
569                 OpenILS::Application::AppUtils->rollback_db_session($session);
570
571                 if($e) { throw $e ($e); }
572                 throw OpenSRF::EX::ERROR ("Wormizing Failed for $id" );
573         };
574
575         warn "Committing db session...\n";
576         OpenILS::Application::AppUtils->commit_db_session( $session );
577
578 #       $client->respond_complete($tree);
579
580         warn "Done wormizing\n";
581
582         #use Data::Dumper;
583         #warn "Returning tree:\n";
584         #warn Dumper $tree;
585
586         return $biblio;
587
588 }
589
590 =cut
591
592
593
594 __PACKAGE__->register_method(
595         method  => "biblio_record_record_metadata",
596         api_name        => "open-ils.cat.biblio.record.metadata.retrieve",
597         argc            => 1, #(session_id, biblio_tree ) 
598         notes           => "Walks the tree and commits any changed nodes " .
599                                         "adds any new nodes, and deletes any deleted nodes",
600 );
601
602 sub biblio_record_record_metadata {
603         my( $self, $client, $authtoken, $ids ) = @_;
604
605         return [] unless $ids and @$ids;
606
607         my $editor = new_editor(authtoken => $authtoken);
608         return $editor->event unless $editor->checkauth;
609         return $editor->event unless $editor->allowed('VIEW_USER');
610
611         my @results;
612
613         for(@$ids) {
614                 return $editor->event unless 
615                         my $rec = $editor->retrieve_biblio_record_entry($_);
616                 $rec->creator($editor->retrieve_actor_user($rec->creator));
617                 $rec->editor($editor->retrieve_actor_user($rec->editor));
618                 $rec->clear_marc; # slim the record down
619                 push( @results, $rec );
620         }
621
622         return \@results;
623 }
624
625
626
627 __PACKAGE__->register_method(
628         method  => "biblio_record_marc_cn",
629         api_name        => "open-ils.cat.biblio.record.marc_cn.retrieve",
630         argc            => 1, #(bib id ) 
631 );
632
633 sub biblio_record_marc_cn {
634         my( $self, $client, $id ) = @_;
635
636         my $session = OpenSRF::AppSession->create("open-ils.cstore");
637         my $marc = $session
638                 ->request("open-ils.cstore.direct.biblio.record_entry.retrieve", $id )
639                 ->gather(1)
640                 ->marc;
641
642         my $doc = XML::LibXML->new->parse_string($marc);
643         $doc->documentElement->setNamespace( "http://www.loc.gov/MARC21/slim", "marc", 1 );
644         
645         my @res;
646         for my $tag ( qw/050 055 060 070 080 082 086 088 090 092 096 098 099/ ) {
647                 my @node = $doc->findnodes("//marc:datafield[\@tag='$tag']");
648                 for my $x (@node) {
649                         my $cn = $x->findvalue("marc:subfield[\@code='a' or \@code='b']");
650                         push @res, {$tag => $cn} if ($cn);
651                 }
652         }
653
654         return \@res
655 }
656
657 sub _get_id_by_userid {
658
659         my @users = @_;
660         my @ids;
661
662         my $session = OpenSRF::AppSession->create( "open-ils.cstore" );
663         my $request = $session->request( 
664                 "open-ils.cstore.direct.actor.user.search.atomic", { usrname => \@users } );
665
666         $request->wait_complete;
667         my $response = $request->recv();
668         if(!$request->complete) { 
669                 throw OpenSRF::EX::ERROR ("no response from cstore on user retrieve");
670         }
671
672         if(UNIVERSAL::isa( $response, "Error")){
673                 throw $response ($response);
674         }
675
676         for my $u (@{$response->content}) {
677                 next unless ref($u);
678                 push @ids, $u->id();
679         }
680
681         $request->finish;
682         $session->disconnect;
683         $session->kill_me();
684
685         return @ids;
686 }
687
688
689 # commits metadata objects to the db
690 sub _update_record_metadata {
691
692         my ($session, @docs ) = @_;
693
694         for my $doc (@docs) {
695
696                 my $user_obj = $doc->{user};
697                 my $docid = $doc->{docid};
698
699                 warn "Updating metata for doc $docid\n";
700
701                 my $request = $session->request( 
702                         "open-ils.storage.direct.biblio.record_entry.retrieve", $docid );
703                 my $record = $request->gather(1);
704
705                 warn "retrieved record\n";
706                 my ($id) = _get_id_by_userid($user_obj->usrname);
707
708                 warn "got $id from _get_id_by_userid\n";
709                 $record->editor($id);
710                 
711                 warn "Grabbed the record, updating and moving on\n";
712
713                 $request = $session->request( 
714                         "open-ils.storage.direct.biblio.record_entry.update", $record );
715                 $request->gather(1);
716         }
717
718         warn "committing metarecord update\n";
719
720         return 1;
721 }
722
723
724
725 __PACKAGE__->register_method(
726         method  => "orgs_for_title",
727         api_name        => "open-ils.cat.actor.org_unit.retrieve_by_title"
728 );
729
730 sub orgs_for_title {
731         my( $self, $client, $record_id ) = @_;
732
733         my $vols = $apputils->simple_scalar_request(
734                 "open-ils.cstore",
735                 "open-ils.cstore.direct.asset.call_number.search.atomic",
736                 { record => $record_id, deleted => 'f' });
737
738         my $orgs = { map {$_->owning_lib => 1 } @$vols };
739         return [ keys %$orgs ];
740 }
741
742
743 __PACKAGE__->register_method(
744         method  => "retrieve_copies",
745         api_name        => "open-ils.cat.asset.copy_tree.retrieve");
746
747 __PACKAGE__->register_method(
748         method  => "retrieve_copies",
749         api_name        => "open-ils.cat.asset.copy_tree.global.retrieve");
750
751 # user_session may be null/undef
752 sub retrieve_copies {
753
754         my( $self, $client, $user_session, $docid, @org_ids ) = @_;
755
756         if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
757
758         $docid = "$docid";
759
760         warn " $$ retrieving copy tree for orgs @org_ids and doc $docid at " . time() . "\n";
761
762         # grabbing copy trees should be available for everyone..
763         if(!@org_ids and $user_session) {
764                 my $user_obj = 
765                         OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
766                         @org_ids = ($user_obj->home_ou);
767         }
768
769         if( $self->api_name =~ /global/ ) {
770                 warn "performing global copy_tree search for $docid\n";
771                 return _build_volume_list( { record => $docid, deleted => 'f' } );
772
773         } else {
774
775                 my @all_vols;
776                 for my $orgid (@org_ids) {
777                         my $vols = _build_volume_list( 
778                                         { record => $docid, owning_lib => $orgid, deleted => 'f' } );
779                         warn "Volumes built for org $orgid\n";
780                         push( @all_vols, @$vols );
781                 }
782                 
783                 warn " $$ Finished copy_tree at " . time() . "\n";
784                 return \@all_vols;
785         }
786
787         return undef;
788 }
789
790
791 sub _build_volume_list {
792         my $search_hash = shift;
793
794         $search_hash->{deleted} = 'f';
795         my $e = new_editor();
796
797         my $vols = $e->search_asset_call_number($search_hash);
798
799         my @volumes;
800
801         for my $volume (@$vols) {
802
803                 my $copies = $e->search_asset_copy(
804                         { call_number => $volume->id , deleted => 'f' });
805
806                 $copies = [ sort { $a->barcode cmp $b->barcode } @$copies  ];
807
808                 for my $c (@$copies) {
809                         if( $c->status == OILS_COPY_STATUS_CHECKED_OUT ) {
810                                 $c->circulations(
811                                         $e->search_action_circulation(
812                                                 [
813                                                         { target_copy => $c->id },
814                                                         {
815                                                                 order_by => { circ => 'xact_start desc' },
816                                                                 limit => 1
817                                                         }
818                                                 ]
819                                         )
820                                 )
821                         }
822                 }
823
824                 $volume->copies($copies);
825                 push( @volumes, $volume );
826         }
827
828         #$session->disconnect();
829         return \@volumes;
830
831 }
832
833
834 __PACKAGE__->register_method(
835         method  => "fleshed_copy_update",
836         api_name        => "open-ils.cat.asset.copy.fleshed.batch.update",);
837
838 __PACKAGE__->register_method(
839         method  => "fleshed_copy_update",
840         api_name        => "open-ils.cat.asset.copy.fleshed.batch.update.override",);
841
842
843 sub fleshed_copy_update {
844         my( $self, $conn, $auth, $copies, $delete_stats ) = @_;
845         return 1 unless ref $copies;
846         my( $reqr, $evt ) = $U->checkses($auth);
847         return $evt if $evt;
848         my $editor = new_editor(requestor => $reqr, xact => 1);
849         my $override = $self->api_name =~ /override/;
850         $evt = update_fleshed_copies($editor, $override, undef, $copies, $delete_stats);
851         return $evt if $evt;
852         $editor->finish;
853         $logger->info("fleshed copy update successfully updated ".scalar(@$copies)." copies");
854         return 1;
855 }
856
857
858 __PACKAGE__->register_method(
859         method => 'merge',
860         api_name        => 'open-ils.cat.biblio.records.merge',
861         signature       => q/
862                 Merges a group of records
863                 @param auth The login session key
864                 @param master The id of the record all other r
865                         ecords should be merged into
866                 @param records Array of records to be merged into the master record
867                 @return 1 on success, Event on error.
868         /
869 );
870
871 sub merge {
872         my( $self, $conn, $auth, $master, $records ) = @_;
873         my( $reqr, $evt ) = $U->checkses($auth);
874         return $evt if $evt;
875         my $editor = new_editor( requestor => $reqr, xact => 1 );
876         my $v = OpenILS::Application::Cat::Merge::merge_records($editor, $master, $records);
877         return $v if $v;
878         $editor->finish;
879         return 1;
880 }
881
882
883
884
885 # ---------------------------------------------------------------------------
886 # ---------------------------------------------------------------------------
887
888 # returns true if the given title (id) has no un-deleted
889 # copies attached
890 sub title_is_empty {
891         my( $editor, $rid ) = @_;
892
893         return 0 if $rid == OILS_PRECAT_RECORD;
894
895         my $cnlist = $editor->search_asset_call_number(
896                 { record => $rid, deleted => 'f' }, { idlist => 1 } );
897         return 1 unless @$cnlist;
898
899         for my $cn (@$cnlist) {
900                 my $copylist = $editor->search_asset_copy(
901                         [
902                                 { call_number => $cn, deleted => 'f' }, 
903                                 { limit => 1 },
904                         ], { idlist => 1 });
905                 return 0 if @$copylist; # false if we find any copies
906         }
907
908         return 1;
909 }
910
911
912 __PACKAGE__->register_method(
913         method  => "fleshed_volume_update",
914         api_name        => "open-ils.cat.asset.volume.fleshed.batch.update",);
915
916 __PACKAGE__->register_method(
917         method  => "fleshed_volume_update",
918         api_name        => "open-ils.cat.asset.volume.fleshed.batch.update.override",);
919
920 sub fleshed_volume_update {
921         my( $self, $conn, $auth, $volumes, $delete_stats ) = @_;
922         my( $reqr, $evt ) = $U->checkses($auth);
923         return $evt if $evt;
924
925         my $override = ($self->api_name =~ /override/);
926         my $editor = new_editor( requestor => $reqr, xact => 1 );
927
928         for my $vol (@$volumes) {
929                 $logger->info("vol-update: investigating volume ".$vol->id);
930
931                 $vol->editor($reqr->id);
932                 $vol->edit_date('now');
933
934                 my $copies = $vol->copies;
935                 $vol->clear_copies;
936
937                 $vol->editor($editor->requestor->id);
938                 $vol->edit_date('now');
939
940                 if( $vol->isdeleted ) {
941
942                         $logger->info("vol-update: deleting volume");
943                         my $cs = $editor->search_asset_copy(
944                                 { call_number => $vol->id, deleted => 'f' } );
945                         return OpenILS::Event->new(
946                                 'VOLUME_NOT_EMPTY', payload => $vol->id ) if @$cs;
947
948                         $vol->deleted('t');
949                         return $editor->event unless
950                                 $editor->update_asset_call_number($vol);
951
952                         
953                 } elsif( $vol->isnew ) {
954                         $logger->info("vol-update: creating volume");
955                         $evt = create_volume( $override, $editor, $vol );
956                         return $evt if $evt;
957
958                 } elsif( $vol->ischanged ) {
959                         $logger->info("vol-update: update volume");
960                         return $editor->event unless
961                                 $editor->update_asset_call_number($vol);
962                         return $evt if $evt;
963                 }
964
965                 # now update any attached copies
966                 if( @$copies and !$vol->isdeleted ) {
967                         $_->call_number($vol->id) for @$copies;
968                         $evt = update_fleshed_copies( $editor, $override, $vol, $copies, $delete_stats );
969                         return $evt if $evt;
970                 }
971         }
972
973         $editor->finish;
974         return scalar(@$volumes);
975 }
976
977
978 # this does the actual work
979 sub update_fleshed_copies {
980         my( $editor, $override, $vol, $copies, $delete_stats ) = @_;
981
982         my $evt;
983         my $fetchvol = ($vol) ? 0 : 1;
984
985         my %cache;
986         $cache{$vol->id} = $vol if $vol;
987
988         for my $copy (@$copies) {
989
990                 my $copyid = $copy->id;
991                 $logger->info("vol-update: inspecting copy $copyid");
992
993                 if( !($vol = $cache{$copy->call_number}) ) {
994                         $vol = $cache{$copy->call_number} = 
995                                 $editor->retrieve_asset_call_number($copy->call_number);
996                         return $editor->event unless $vol;
997                 }
998
999                 $copy->editor($editor->requestor->id);
1000                 $copy->edit_date('now');
1001
1002                 $copy->status( $copy->status->id ) if ref($copy->status);
1003                 $copy->location( $copy->location->id ) if ref($copy->location);
1004                 $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
1005                 
1006                 my $sc_entries = $copy->stat_cat_entries;
1007                 $copy->clear_stat_cat_entries;
1008
1009                 if( $copy->isdeleted ) {
1010                         $evt = delete_copy($editor, $override, $vol, $copy);
1011                         return $evt if $evt;
1012
1013                 } elsif( $copy->isnew ) {
1014                         $evt = create_copy( $editor, $vol, $copy );
1015                         return $evt if $evt;
1016
1017                 } elsif( $copy->ischanged ) {
1018
1019                         $evt = update_copy( $editor, $override, $vol, $copy );
1020                         return $evt if $evt;
1021                 }
1022
1023                 $copy->stat_cat_entries( $sc_entries );
1024                 $evt = update_copy_stat_entries($editor, $copy, $delete_stats);
1025                 return $evt if $evt;
1026         }
1027
1028         $logger->debug("vol-update: done updating copy batch");
1029
1030         return undef;
1031 }
1032
1033 sub fix_copy_price {
1034         my $copy = shift;
1035         my $p = $copy->price || 0;
1036         $p =~ s/\$//og;
1037         $copy->price($p);
1038
1039         my $d = $copy->deposit_amount || 0;
1040         $d =~ s/\$//og;
1041         $copy->deposit_amount($d);
1042 }
1043
1044
1045 sub update_copy {
1046         my( $editor, $override, $vol, $copy ) = @_;
1047
1048         $logger->info("vol-update: updating copy ".$copy->id);
1049         my $orig_copy = $editor->retrieve_asset_copy($copy->id);
1050         my $orig_vol  = $editor->retrieve_asset_call_number($copy->call_number);
1051
1052         $copy->editor($editor->requestor->id);
1053         $copy->edit_date('now');
1054
1055         fix_copy_price($copy);
1056         return $editor->event unless
1057                 $editor->update_asset_copy( 
1058                         $copy, {checkperm=>1, permorg=>$vol->owning_lib});
1059
1060         return remove_empty_objects($editor, $override, $orig_vol);
1061 }
1062
1063
1064 sub remove_empty_objects {
1065         my( $editor, $override, $vol ) = @_; 
1066         if( title_is_empty($editor, $vol->record) ) {
1067
1068                 if( $override ) {
1069
1070                         # delete this volume if it's not already marked as deleted
1071                         unless( $U->is_true($vol->deleted) || $vol->isdeleted ) {
1072                                 $vol->deleted('t');
1073                                 $vol->editor($editor->requestor->id);
1074                                 $vol->edit_date('now');
1075                                 $editor->update_asset_call_number($vol, {checkperm=>0})
1076                                         or return $editor->event;
1077                         }
1078
1079                         # then delete the record this volume points to
1080                         my $rec = $editor->retrieve_biblio_record_entry($vol->record)
1081                                 or return $editor->event;
1082
1083                         unless( $U->is_true($rec->deleted) ) {
1084                                 $rec->deleted('t');
1085                                 $rec->active('f');
1086                                 $editor->update_biblio_record_entry($rec, {checkperm=>0})
1087                                         or return $editor->event;
1088                         }
1089
1090                 } else {
1091                         return OpenILS::Event->new('TITLE_LAST_COPY', payload => $vol->record );
1092                 }
1093         }
1094
1095         return undef;
1096 }
1097
1098
1099 sub delete_copy {
1100         my( $editor, $override, $vol, $copy ) = @_;
1101
1102         $logger->info("vol-update: deleting copy ".$copy->id);
1103         $copy->deleted('t');
1104
1105         $copy->editor($editor->requestor->id);
1106         $copy->edit_date('now');
1107         $editor->update_asset_copy(
1108                 $copy, {checkperm=>1, permorg=>$vol->owning_lib})
1109                 or return $editor->event;
1110
1111         # Delete any open transits for this copy
1112         my $transits = $editor->search_action_transit_copy(
1113                 { target_copy=>$copy->id, dest_recv_time => undef } );
1114
1115         for my $t (@$transits) {
1116                 $editor->delete_action_transit_copy($t)
1117                         or return $editor->event;
1118         }
1119
1120         return remove_empty_objects($editor, $override, $vol);
1121 }
1122
1123
1124 sub create_copy {
1125         my( $editor, $vol, $copy ) = @_;
1126
1127         my $existing = $editor->search_asset_copy(
1128                 { barcode => $copy->barcode, deleted => 'f' } );
1129         
1130         return OpenILS::Event->new('ITEM_BARCODE_EXISTS') if @$existing;
1131
1132         $copy->clear_id;
1133         $copy->creator($editor->requestor->id);
1134         $copy->create_date('now');
1135         fix_copy_price($copy);
1136
1137         $editor->create_asset_copy(
1138                 $copy, {checkperm=>1, permorg=>$vol->owning_lib})
1139                 or return $editor->event;
1140
1141         return undef;
1142 }
1143
1144 # if 'delete_stats' is true, the copy->stat_cat_entries data is 
1145 # treated as the authoritative list for the copy. existing entries
1146 # that are not in said list will be deleted from the DB
1147 sub update_copy_stat_entries {
1148         my( $editor, $copy, $delete_stats ) = @_;
1149
1150         return undef if $copy->isdeleted;
1151
1152         my $evt;
1153         my $entries = $copy->stat_cat_entries;
1154
1155         if( $delete_stats ) {
1156                 $entries = ($entries and @$entries) ? $entries : [];
1157         } else {
1158                 return undef unless ($entries and @$entries);
1159         }
1160
1161         my $maps = $editor->search_asset_stat_cat_entry_copy_map({owning_copy=>$copy->id});
1162
1163         if(!$copy->isnew) {
1164                 # if there is no stat cat entry on the copy who's id matches the
1165                 # current map's id, remove the map from the database
1166                 for my $map (@$maps) {
1167                         if(! grep { $_->id == $map->stat_cat_entry } @$entries ) {
1168
1169                                 $logger->info("copy update found stale ".
1170                                         "stat cat entry map ".$map->id. " on copy ".$copy->id);
1171
1172                                 $editor->delete_asset_stat_cat_entry_copy_map($map)
1173                                         or return $editor->event;
1174                         }
1175                 }
1176         }
1177
1178         # go through the stat cat update/create process
1179         for my $entry (@$entries) { 
1180                 next unless $entry;
1181
1182                 # if this link already exists in the DB, don't attempt to re-create it
1183                 next if( grep{$_->stat_cat_entry == $entry->id} @$maps );
1184         
1185                 my $new_map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
1186
1187                 my $sc = ref($entry->stat_cat) ? $entry->stat_cat->id : $entry->stat_cat;
1188                 
1189                 $new_map->stat_cat( $sc );
1190                 $new_map->stat_cat_entry( $entry->id );
1191                 $new_map->owning_copy( $copy->id );
1192
1193                 $editor->create_asset_stat_cat_entry_copy_map($new_map)
1194                         or return $editor->event;
1195
1196                 $logger->info("copy update created new stat cat entry map ".$editor->data);
1197         }
1198
1199         return undef;
1200 }
1201
1202
1203 sub create_volume {
1204         my( $override, $editor, $vol ) = @_;
1205         my $evt;
1206
1207         # first lets see if there are any collisions
1208         my $vols = $editor->search_asset_call_number( { 
1209                         owning_lib      => $vol->owning_lib,
1210                         record          => $vol->record,
1211                         label                   => $vol->label,
1212                         deleted         => 'f'
1213                 }
1214         );
1215
1216         my $label = undef;
1217         if(@$vols) {
1218                 if($override) { 
1219                         $label = $vol->label;
1220                 } else {
1221                         return OpenILS::Event->new(
1222                                 'VOLUME_LABEL_EXISTS', payload => $vol->id);
1223                 }
1224         }
1225
1226         # create a temp label so we can create the volume, then de-dup it
1227         $vol->label( '__SYSTEM_TMP_'.time) if $label;
1228
1229         $vol->creator($editor->requestor->id);
1230         $vol->create_date('now');
1231         $vol->editor($editor->requestor->id);
1232         $vol->edit_date('now');
1233         $vol->clear_id;
1234
1235         $editor->create_asset_call_number($vol) or return $editor->event;
1236
1237         if($label) {
1238                 # now restore the label and merge into the existing record
1239                 $vol->label($label);
1240                 (undef, $evt) = 
1241                         OpenILS::Application::Cat::Merge::merge_volumes($editor, [$vol], $$vols[0]);
1242                 return $evt if $evt;
1243         }
1244
1245         return undef;
1246 }
1247
1248
1249 __PACKAGE__->register_method (
1250         method => 'batch_volume_transfer',
1251         api_name => 'open-ils.cat.asset.volume.batch.transfer',
1252 );
1253
1254 __PACKAGE__->register_method (
1255         method => 'batch_volume_transfer',
1256         api_name => 'open-ils.cat.asset.volume.batch.transfer.override',
1257 );
1258
1259
1260 sub batch_volume_transfer {
1261         my( $self, $conn, $auth, $args ) = @_;
1262
1263         my $evt;
1264         my $rec         = $$args{docid};
1265         my $o_lib       = $$args{lib};
1266         my $vol_ids = $$args{volumes};
1267
1268         my $override = 1 if $self->api_name =~ /override/;
1269
1270         $logger->info("merge: transferring volumes to lib=$o_lib and record=$rec");
1271
1272         my $e = new_editor(authtoken => $auth, xact =>1);
1273         return $e->event unless $e->checkauth;
1274         return $e->event unless $e->allowed('VOLUME_UPDATE');
1275
1276         my $dorg = $e->retrieve_actor_org_unit($o_lib)
1277                 or return $e->event;
1278
1279         my $ou_type = $e->retrieve_actor_org_unit_type($dorg->ou_type)
1280                 or return $e->event;
1281
1282         return OpenILS::Event->new('ORG_CANNOT_HAVE_VOLS')
1283                 unless $U->is_true($ou_type->can_have_vols);
1284
1285         my $vols = $e->batch_retrieve_asset_call_number($vol_ids);
1286         my @seen;
1287
1288         for my $vol (@$vols) {
1289
1290                 # if we've already looked at this volume, go to the next
1291                 next if !$vol or grep { $vol->id == $_ } @seen;
1292
1293                 # grab all of the volumes in the list that have 
1294                 # the same label so they can be merged
1295                 my @all = grep { $_->label eq $vol->label } @$vols;
1296
1297                 # take note of the fact that we've looked at this set of volumes
1298                 push( @seen, $_->id ) for @all;
1299
1300                 # for each volume, see if there are any copies that have a 
1301                 # remote circ_lib (circ_lib != vol->owning_lib and != $o_lib ).  
1302                 # if so, warn them
1303                 unless( $override ) {
1304                         for my $v (@all) {
1305
1306                                 $logger->debug("merge: searching for copies with remote circ_lib for volume ".$v->id);
1307                                 my $args = { 
1308                                         call_number     => $v->id, 
1309                                         circ_lib                => { "!=" => $v->owning_lib },
1310                                         deleted         => 'f'
1311                                 };
1312
1313                                 my $copies = $e->search_asset_copy($args, {idlist=>1});
1314
1315                                 # if the copy's circ_lib matches the destination lib,
1316                                 # that's ok too
1317                                 $copies = [ grep { $_->circ_lib ne $o_lib } @$copies ];
1318                                 return OpenILS::Event->new('COPY_REMOTE_CIRC_LIB') if @$copies;
1319                         }
1320                 }
1321
1322                 # see if there is a volume at the destination lib that 
1323                 # already has the requested label
1324                 my $existing_vol = $e->search_asset_call_number(
1325                         {
1326                                 label                   => $vol->label, 
1327                                 record          =>$rec, 
1328                                 owning_lib      =>$o_lib,
1329                                 deleted         => 'f'
1330                         }
1331                 )->[0];
1332
1333                 if( $existing_vol ) {
1334
1335                         if( grep { $_->id == $existing_vol->id } @all ) {
1336                                 # this volume is already accounted for in our list of volumes to merge
1337                                 $existing_vol = undef;
1338
1339                         } else {
1340                                 # this volume exists on the destination record/owning_lib and must
1341                                 # be used as the destination for merging
1342                                 $logger->debug("merge: volume already exists at destination record: ".
1343                                         $existing_vol->id.' : '.$existing_vol->label) if $existing_vol;
1344                         }
1345                 } 
1346
1347                 if( @all > 1 || $existing_vol ) {
1348                         $logger->info("merge: found collisions in volume transfer");
1349                         my @args = ($e, \@all);
1350                         @args = ($e, \@all, $existing_vol) if $existing_vol;
1351                         ($vol, $evt) = OpenILS::Application::Cat::Merge::merge_volumes(@args);
1352                         return $evt if $evt;
1353                 } 
1354                 
1355                 if( !$existing_vol ) {
1356
1357                         $vol->owning_lib($o_lib);
1358                         $vol->record($rec);
1359                         $vol->editor($e->requestor->id);
1360                         $vol->edit_date('now');
1361         
1362                         $logger->info("merge: updating volume ".$vol->id);
1363                         $e->update_asset_call_number($vol) or return $e->event;
1364
1365                 } else {
1366                         $logger->info("merge: bypassing volume update because existing volume used as target");
1367                 }
1368
1369                 # regardless of what volume was used as the destination, 
1370                 # update any copies that have moved over to the new lib
1371                 my $copies = $e->search_asset_copy({call_number=>$vol->id, deleted => 'f'});
1372
1373                 # update circ lib on the copies - make this a method flag?
1374                 for my $copy (@$copies) {
1375                         next if $copy->circ_lib == $o_lib;
1376                         $logger->info("merge: transfer moving circ lib on copy ".$copy->id);
1377                         $copy->circ_lib($o_lib);
1378                         $copy->editor($e->requestor->id);
1379                         $copy->edit_date('now');
1380                         $e->update_asset_copy($copy) or return $e->event;
1381                 }
1382
1383                 # Now see if any empty records need to be deleted after all of this
1384                 for(@all) {
1385                         $evt = remove_empty_objects($e, $override, $_);
1386                         return $evt if $evt;
1387                 }
1388         }
1389
1390         $logger->info("merge: transfer succeeded");
1391         $e->commit;
1392         return 1;
1393 }
1394
1395
1396
1397
1398
1399
1400 1;