]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/src/perlmods/OpenILS/Application/Cat.pm
removing old code
[working/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
14 use XML::LibXML;
15 use Unicode::Normalize;
16 use Data::Dumper;
17 use OpenILS::Utils::FlatXML;
18 use OpenILS::Utils::Editor;
19 use OpenILS::Perm;
20 use OpenSRF::Utils::SettingsClient;
21 use OpenSRF::Utils::Logger qw($logger);
22
23 my $apputils = "OpenILS::Application::AppUtils";
24
25 my $utils = "OpenILS::Application::Cat::Utils";
26 my $U = "OpenILS::Application::AppUtils";
27
28 my $conf;
29
30 my %marctemplates;
31
32 sub entityize { 
33         my $stuff = shift;
34         my $form = shift || "";
35
36         if ($form eq 'D') {
37                 $stuff = NFD($stuff);
38         } else {
39                 $stuff = NFC($stuff);
40         }
41
42         $stuff =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
43         return $stuff;
44 }
45
46 __PACKAGE__->register_method(
47         method  => "retrieve_marc_template",
48         api_name        => "open-ils.cat.biblio.marc_template.retrieve",
49         notes           => <<"  NOTES");
50         Returns a MARC 'record tree' based on a set of pre-defined templates.
51         Templates include : book
52         NOTES
53
54 sub retrieve_marc_template {
55         my( $self, $client, $type ) = @_;
56
57         return $marctemplates{$type} if defined($marctemplates{$type});
58         $marctemplates{$type} = _load_marc_template($type);
59         return $marctemplates{$type};
60 }
61
62 sub _load_marc_template {
63         my $type = shift;
64
65         if(!$conf) { $conf = OpenSRF::Utils::SettingsClient->new; }
66
67         my $template = $conf->config_value(                                     
68                 "apps", "open-ils.cat","app_settings", "marctemplates", $type );
69         warn "Opening template file $template\n";
70
71         open( F, $template ) or 
72                 throw OpenSRF::EX::ERROR ("Unable to open MARC template file: $template : $@");
73
74         my @xml = <F>;
75         close(F);
76         my $xml = join('', @xml);
77
78         return XML::LibXML->new->parse_string($xml)->documentElement->toString;
79 }
80
81
82
83 __PACKAGE__->register_method(
84         method  => "create_record_xml",
85         api_name        => "open-ils.cat.biblio.record.xml.create.override",
86         signature       => q/@see open-ils.cat.biblio.record.xml.create/);
87
88 __PACKAGE__->register_method(
89         method          => "create_record_xml",
90         api_name                => "open-ils.cat.biblio.record.xml.create",
91         signature       => q/
92                 Inserts a new biblio with the given XML
93         /
94 );
95
96 sub create_record_xml {
97         my( $self, $client, $login, $xml, $source ) = @_;
98         $source ||= 2;
99
100         my $override = 1 if $self->api_name =~ /override/;
101
102         my( $user_obj, $evt ) = $U->checksesperm($login, 'CREATE_MARC');
103         return $evt if $evt;
104
105         $logger->activity("user ".$user_obj->id." creating new MARC record");
106
107         my $meth = $self->method_lookup("open-ils.cat.biblio.record.xml.import");
108
109         $meth = $self->method_lookup(
110                 "open-ils.cat.biblio.record.xml.import.override") if $override;
111
112         my ($s) = $meth->run($login, $xml, 2);
113         return $s;
114 }
115
116
117
118
119 __PACKAGE__->register_method(
120         method  => "biblio_record_xml_import",
121         api_name        => "open-ils.cat.biblio.record.xml.import.override",
122         signature       => q/@see open-ils.cat.biblio.record.xml.import/);
123
124 __PACKAGE__->register_method(
125         method  => "biblio_record_xml_import",
126         api_name        => "open-ils.cat.biblio.record.xml.import",
127         notes           => <<"  NOTES");
128         Takes a marcxml record and imports the record into the database.  In this
129         case, the marcxml record is assumed to be a complete record (i.e. valid
130         MARC).  The title control number is taken from (whichever comes first)
131         tags 001, 039[ab], 020a, 022a, 010, 035a and whichever does not already exist
132         in the database.
133         user_session must have IMPORT_MARC permissions
134         NOTES
135
136
137 sub biblio_record_xml_import {
138         my( $self, $client, $authtoken, $xml, $source) = @_;
139
140         my ($tcn, $tcn_source);
141
142         my $override = 1 if $self->api_name =~ /override/;
143
144         my( $requestor, $evt ) = $U->checksesperm($authtoken, 'IMPORT_MARC');
145         return $evt if $evt;
146
147         my $session = $apputils->start_db_session();
148
149         # parse the XML
150         my $marcxml = XML::LibXML->new->parse_string( $xml );
151         $marcxml->documentElement->setNamespace( 
152                 "http://www.loc.gov/MARC21/slim", "marc", 1 );
153
154         my $xpath = '//marc:controlfield[@tag="001"]';
155         $tcn = $marcxml->documentElement->findvalue($xpath);
156         $logger->info("biblio import located 001 (tcn) value of $tcn");
157
158         $xpath = '//marc:controlfield[@tag="003"]';
159         $tcn_source = $marcxml->documentElement->findvalue($xpath) || "System Local";
160
161         if(my $rec = _tcn_exists($session, $tcn, $tcn_source)) {
162
163                 my $origtcn = $tcn;
164                 $tcn = find_free_tcn( $marcxml, $session );
165
166                 # if we're overriding, try to find a different TCN to use
167                 if( $override ) {
168
169                         $logger->activity("tcn value $tcn already exists, attempting to override");
170
171                         if(!$tcn) {
172                                 return OpenILS::Event->new(
173                                         'OPEN_TCN_NOT_FOUND', payload => $marcxml->toString());
174                         }
175
176                 } else {
177
178                         $logger->warn("tcn value $origtcn already exists in import/create");
179
180                         # otherwise, return event
181                         return OpenILS::Event->new( 
182                                 'TCN_EXISTS', payload => { 
183                                         dup_record      => $rec, 
184                                         tcn                     => $origtcn,
185                                         new_tcn         => $tcn
186                                         } );
187                 }
188
189         } else {
190
191                 $logger->activity("user ".$requestor->id.
192                 " creating new biblio entry with tcn=$tcn and tcn_source $tcn_source");
193         }
194
195
196         my $record = Fieldmapper::biblio::record_entry->new;
197
198         $record->source($source) if ($source);
199         $record->tcn_source($tcn_source);
200         $record->tcn_value($tcn);
201         $record->creator($requestor->id);
202         $record->editor($requestor->id);
203         $record->marc( entityize( $marcxml->documentElement->toString ) );
204
205         my $id = $session->request(
206                 "open-ils.storage.direct.biblio.record_entry.create", $record )->gather(1);
207
208         return $U->DB_UPDATE_FAILED($record) unless $id;
209         $record->id( $id );
210
211         $logger->info("marc create/import created new record $id");
212
213         $apputils->commit_db_session($session);
214
215         $logger->debug("Sending record off to be wormized");
216
217         my $stat = $U->storagereq( 'open-ils.worm.wormize.biblio', $id );
218         throw OpenSRF::EX::ERROR 
219                 ("Unable to wormize imported record") unless $stat;
220
221         return $record;
222 }
223
224 sub find_free_tcn {
225
226         my $marcxml = shift;
227         my $session = shift;
228
229         my $add_039 = 0;
230
231         my $xpath = '//marc:datafield[@tag="039"]/subfield[@code="a"]';
232         my ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
233         $xpath = '//marc:datafield[@tag="039"]/subfield[@code="b"]';
234         my $tcn_source = $marcxml->documentElement->findvalue($xpath) || "System Local";
235
236         if(_tcn_exists($session, $tcn, $tcn_source)) {
237                 $tcn = undef;
238         } else {
239                 $add_039++;
240         }
241
242
243         if(!$tcn) {
244                 $xpath = '//marc:datafield[@tag="020"]/subfield[@code="a"]';
245                 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
246                 $tcn_source = "ISBN";
247                 if(_tcn_exists($session, $tcn, $tcn_source)) {$tcn = undef;}
248         }
249
250         if(!$tcn) { 
251                 $xpath = '//marc:datafield[@tag="022"]/subfield[@code="a"]';
252                 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
253                 $tcn_source = "ISSN";
254                 if(_tcn_exists($session, $tcn, $tcn_source)) {$tcn = undef;}
255         }
256
257         if(!$tcn) {
258                 $xpath = '//marc:datafield[@tag="010"]';
259                 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
260                 $tcn_source = "LCCN";
261                 if(_tcn_exists($session, $tcn, $tcn_source)) {$tcn = undef;}
262         }
263
264         if(!$tcn) {
265                 $xpath = '//marc:datafield[@tag="035"]/subfield[@code="a"]';
266                 ($tcn) = $marcxml->documentElement->findvalue($xpath) =~ /(\w+)\s*$/o;
267                 $tcn_source = "System Legacy";
268                 if(_tcn_exists($session, $tcn, $tcn_source)) {$tcn = undef;}
269
270                 if($tcn) {
271                         $marcxml->documentElement->removeChild(
272                                 $marcxml->documentElement->findnodes( '//datafield[@tag="035"]' )
273                         );
274                 }
275         }
276
277         if ($add_039) {
278                 my $df = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'datafield');
279                 $df->setAttribute( tag => '039' );
280                 $df->setAttribute( ind1 => ' ' );
281                 $df->setAttribute( ind2 => ' ' );
282                 $marcxml->documentElement->appendChild( $df );
283
284                 my $sfa = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'subfield');
285                 $sfa->setAttribute( code => 'a' );
286                 $sfa->appendChild( $marcxml->createTextNode( $tcn ) );
287                 $df->appendChild( $sfa );
288
289                 my $sfb = $marcxml->createElementNS( 'http://www.loc.gov/MARC21/slim', 'subfield');
290                 $sfb->setAttribute( code => 'b' );
291                 $sfb->appendChild( $marcxml->createTextNode( $tcn_source ) );
292                 $df->appendChild( $sfb );
293         }
294
295         return $tcn;
296 }
297
298
299
300 sub _tcn_exists {
301         my $session = shift;
302         my $tcn = shift;
303         my $source = shift;
304
305         if(!$tcn) {return 0;}
306
307         $logger->debug("tcn_exists search for tcn $tcn and source $source");
308
309         my $req = $session->request(      
310                 "open-ils.storage.id_list.biblio.record_entry.search_where.atomic",
311                 { tcn_value => $tcn, tcn_source => $source, deleted => 'f' } );
312
313         my $recs = $req->gather(1);
314
315         if($recs and $recs->[0]) {
316                 $logger->debug("_tcn_exists is true for tcn : $tcn ($source)");
317                 return $recs->[0];
318         }
319
320         $logger->debug("_tcn_exists is false for tcn : $tcn ($source)");
321         return 0;
322 }
323
324
325
326 # XXX deprecated. Remove me.
327
328 __PACKAGE__->register_method(
329         method  => "biblio_record_tree_retrieve",
330         api_name        => "open-ils.cat.biblio.record.tree.retrieve",
331 );
332
333 sub biblio_record_tree_retrieve {
334
335         my( $self, $client, $recordid ) = @_;
336
337         my $name = "open-ils.storage.direct.biblio.record_entry.retrieve";
338         my $session = OpenSRF::AppSession->create( "open-ils.storage" );
339         my $request = $session->request( $name, $recordid );
340         my $marcxml = $request->gather(1);
341
342         if(!$marcxml) {
343                 throw OpenSRF::EX::ERROR 
344                         ("No record in database with id $recordid");
345         }
346
347         $session->disconnect();
348         $session->kill_me();
349
350         warn "turning into nodeset\n";
351         my $nodes = OpenILS::Utils::FlatXML->new()->xml_to_nodeset( $marcxml->marc ); 
352         warn "turning nodeset into tree\n";
353         my $tree = $utils->nodeset2tree( $nodes->nodeset );
354
355         $tree->owner_doc( $marcxml->id() );
356
357         warn "returning tree\n";
358
359         return $tree;
360 }
361
362 __PACKAGE__->register_method(
363         method  => "biblio_record_xml_update",
364         api_name        => "open-ils.cat.biblio.record.xml.update",
365         argc            => 3, #(session_id, biblio_tree ) 
366         notes           => <<'  NOTES');
367         Updates the XML of a biblio record entry
368         @param authtoken The session token for the staff updating the record
369         @param docID The record entry ID to update
370         @param xml The new MARCXML record
371         NOTES
372
373 sub biblio_record_xml_update {
374
375         my( $self, $client, $user_session,  $id, $xml ) = @_;
376
377         my $user_obj = $apputils->check_user_session($user_session); 
378
379         if($apputils->check_user_perms(
380                         $user_obj->id, $user_obj->home_ou, "UPDATE_MARC")) {
381                 return OpenILS::Perm->new("UPDATE_MARC"); 
382         }
383
384         $logger->activity("user ".$user_obj->id." updating biblio record $id");
385
386
387         my $session = OpenILS::Application::AppUtils->start_db_session();
388
389         warn "Retrieving biblio record from storage for update\n";
390
391         my $req1 = $session->request(
392                         "open-ils.storage.direct.biblio.record_entry.batch.retrieve", $id );
393         my $biblio = $req1->gather(1);
394
395         warn "retrieved doc $id\n";
396
397         my $doc = XML::LibXML->new->parse_string($xml);
398         throw OpenSRF::EX::ERROR ("Invalid XML in record update: $xml") unless $doc;
399
400         $biblio->marc( entityize( $doc->documentElement->toString ) );
401         $biblio->editor( $user_obj->id );
402         $biblio->edit_date( 'now' );
403
404         warn "Sending updated doc $id to db with xml ".$biblio->marc. "\n";
405
406         my $req = $session->request( 
407                 "open-ils.storage.direct.biblio.record_entry.update", $biblio );
408
409         $req->wait_complete;
410         my $status = $req->recv();
411         if( !$status || $status->isa("Error") || ! $status->content) {
412                 OpenILS::Application::AppUtils->rollback_db_session($session);
413                 if($status->isa("Error")) { throw $status ($status); }
414                 throw OpenSRF::EX::ERROR ("Error updating biblio record");
415         }
416         $req->finish();
417
418         # Send the doc to the wormer for wormizing
419         warn "Starting worm session\n";
420
421         my $success = 0;
422         my $wresp;
423
424         my $wreq = $session->request( "open-ils.worm.wormize.biblio", $id );
425
426         my $w = 0;
427         try {
428                 $w = $wreq->gather(1);
429
430         } catch Error with {
431                 my $e = shift;
432                 warn "wormizing failed, rolling back\n";
433                 OpenILS::Application::AppUtils->rollback_db_session($session);
434
435                 if($e) { throw $e ($e); }
436                 throw OpenSRF::EX::ERROR ("Wormizing Failed for $id" );
437         };
438
439         warn "Committing db session...\n";
440         OpenILS::Application::AppUtils->commit_db_session( $session );
441
442 #       $client->respond_complete($tree);
443
444         warn "Done wormizing\n";
445
446         #use Data::Dumper;
447         #warn "Returning tree:\n";
448         #warn Dumper $tree;
449
450         return $biblio;
451
452 }
453
454
455
456 __PACKAGE__->register_method(
457         method  => "biblio_record_record_metadata",
458         api_name        => "open-ils.cat.biblio.record.metadata.retrieve",
459         argc            => 1, #(session_id, biblio_tree ) 
460         notes           => "Walks the tree and commits any changed nodes " .
461                                         "adds any new nodes, and deletes any deleted nodes",
462 );
463
464 sub biblio_record_record_metadata {
465         my( $self, $client, $authtoken, $ids ) = @_;
466
467         return [] unless $ids and @$ids;
468
469         my $editor = OpenILS::Utils::Editor->new(authtoken => $authtoken);
470         return $editor->event unless $editor->checkauth;
471         return $editor->event unless $editor->allowed('VIEW_USER');
472
473         my @results;
474
475         for(@$ids) {
476                 return $editor->event unless 
477                         my $rec = $editor->retrieve_biblio_record_entry($_);
478                 $rec->creator($editor->retrieve_actor_user($rec->creator));
479                 $rec->editor($editor->retrieve_actor_user($rec->editor));
480                 $rec->clear_marc; # slim the record down
481                 push( @results, $rec );
482         }
483
484         return \@results;
485 }
486
487
488
489 __PACKAGE__->register_method(
490         method  => "biblio_record_marc_cn",
491         api_name        => "open-ils.cat.biblio.record.marc_cn.retrieve",
492         argc            => 1, #(bib id ) 
493 );
494
495 sub biblio_record_marc_cn {
496         my( $self, $client, $id ) = @_;
497
498         my $session = OpenSRF::AppSession->create("open-ils.storage");
499         my $marc = $session
500                 ->request("open-ils.storage.direct.biblio.record_entry.retrieve", $id )
501                 ->gather(1)
502                 ->marc;
503
504         my $doc = XML::LibXML->new->parse_string($marc);
505         $doc->documentElement->setNamespace( "http://www.loc.gov/MARC21/slim", "marc", 1 );
506         
507         my @res;
508         for my $tag ( qw/050 055 060 070 080 082 086 088 090 092 096 098 099/ ) {
509                 my @node = $doc->findnodes("//marc:datafield[\@tag='$tag']");
510                 for my $x (@node) {
511                         my $cn = $x->findvalue("marc:subfield[\@code='a' or \@code='b']");
512                         push @res, {$tag => $cn} if ($cn);
513                 }
514         }
515
516         return \@res
517 }
518
519 sub _get_id_by_userid {
520
521         my @users = @_;
522         my @ids;
523
524         my $session = OpenSRF::AppSession->create( "open-ils.storage" );
525         my $request = $session->request( 
526                 "open-ils.storage.direct.actor.user.search.usrname.atomic", @users );
527
528         $request->wait_complete;
529         my $response = $request->recv();
530         if(!$request->complete) { 
531                 throw OpenSRF::EX::ERROR ("no response from storage on user retrieve");
532         }
533
534         if(UNIVERSAL::isa( $response, "Error")){
535                 throw $response ($response);
536         }
537
538         for my $u (@{$response->content}) {
539                 next unless ref($u);
540                 push @ids, $u->id();
541         }
542
543         $request->finish;
544         $session->disconnect;
545         $session->kill_me();
546
547         return @ids;
548 }
549
550
551 # commits metadata objects to the db
552 sub _update_record_metadata {
553
554         my ($session, @docs ) = @_;
555
556         for my $doc (@docs) {
557
558                 my $user_obj = $doc->{user};
559                 my $docid = $doc->{docid};
560
561                 warn "Updating metata for doc $docid\n";
562
563                 my $request = $session->request( 
564                         "open-ils.storage.direct.biblio.record_entry.retrieve", $docid );
565                 my $record = $request->gather(1);
566
567                 warn "retrieved record\n";
568                 my ($id) = _get_id_by_userid($user_obj->usrname);
569
570                 warn "got $id from _get_id_by_userid\n";
571                 $record->editor($id);
572                 
573                 warn "Grabbed the record, updating and moving on\n";
574
575                 $request = $session->request( 
576                         "open-ils.storage.direct.biblio.record_entry.update", $record );
577                 $request->gather(1);
578         }
579
580         warn "committing metarecord update\n";
581
582         return 1;
583 }
584
585
586
587 __PACKAGE__->register_method(
588         method  => "orgs_for_title",
589         api_name        => "open-ils.cat.actor.org_unit.retrieve_by_title"
590 );
591
592 sub orgs_for_title {
593         my( $self, $client, $record_id ) = @_;
594
595         my $vols = $apputils->simple_scalar_request(
596                 "open-ils.storage",
597                 "open-ils.storage.direct.asset.call_number.search_where.atomic",
598                 { record => $record_id, deleted => 'f' });
599
600         my $orgs = { map {$_->owning_lib => 1 } @$vols };
601         return [ keys %$orgs ];
602 }
603
604
605 __PACKAGE__->register_method(
606         method  => "retrieve_copies",
607         api_name        => "open-ils.cat.asset.copy_tree.retrieve");
608
609 __PACKAGE__->register_method(
610         method  => "retrieve_copies",
611         api_name        => "open-ils.cat.asset.copy_tree.global.retrieve");
612
613 # user_session may be null/undef
614 sub retrieve_copies {
615
616         my( $self, $client, $user_session, $docid, @org_ids ) = @_;
617
618         if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
619
620         $docid = "$docid";
621
622         warn " $$ retrieving copy tree for orgs @org_ids and doc $docid at " . time() . "\n";
623
624         # grabbing copy trees should be available for everyone..
625         if(!@org_ids and $user_session) {
626                 my $user_obj = 
627                         OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
628                         @org_ids = ($user_obj->home_ou);
629         }
630
631         if( $self->api_name =~ /global/ ) {
632                 warn "performing global copy_tree search for $docid\n";
633                 return _build_volume_list( { record => $docid } );
634
635         } else {
636
637                 my @all_vols;
638                 for my $orgid (@org_ids) {
639                         my $vols = _build_volume_list( 
640                                         { record => $docid, owning_lib => $orgid } );
641                         warn "Volumes built for org $orgid\n";
642                         push( @all_vols, @$vols );
643                 }
644                 
645                 warn " $$ Finished copy_tree at " . time() . "\n";
646                 return \@all_vols;
647         }
648
649         return undef;
650 }
651
652
653 sub _build_volume_list {
654         my $search_hash = shift;
655
656         $search_hash->{deleted} = 'f';
657
658         my      $session = OpenSRF::AppSession->create( "open-ils.storage" );
659         
660
661         my $request = $session->request( 
662                         "open-ils.storage.direct.asset.call_number.search.atomic", $search_hash );
663                         #"open-ils.storage.direct.asset.call_number.search.atomic", $search_hash );
664
665         my $vols = $request->gather(1);
666         my @volumes;
667
668         for my $volume (@$vols) {
669
670                 warn "Grabbing copies for volume: " . $volume->id . "\n";
671                 my $creq = $session->request(
672                         "open-ils.storage.direct.asset.copy.search_where.atomic", 
673                         { call_number => $volume->id , deleted => 'f' });
674                         #"open-ils.storage.direct.asset.copy.search.call_number.atomic", $volume->id );
675
676                 my $copies = $creq->gather(1);
677
678                 $copies = [ sort { $a->barcode cmp $b->barcode } @$copies  ];
679
680                 $volume->copies($copies);
681
682                 push( @volumes, $volume );
683         }
684
685
686         $session->disconnect();
687         return \@volumes;
688
689 }
690
691
692 __PACKAGE__->register_method(
693         method  => "fleshed_copy_update",
694         api_name        => "open-ils.cat.asset.copy.fleshed.batch.update",);
695
696 __PACKAGE__->register_method(
697         method  => "fleshed_copy_update",
698         api_name        => "open-ils.cat.asset.copy.fleshed.batch.update.override",);
699
700 sub fleshed_copy_update {
701         my( $self, $conn, $auth, $copies ) = @_;
702         my( $reqr, $evt ) = $U->checkses($auth);
703         return $evt if $evt;
704         my $editor = OpenILS::Utils::Editor->new(requestor => $reqr, xact => 1);
705         my $override = $self->api_name =~ /override/;
706         $evt = update_fleshed_copies( $editor, $override, undef, $copies);
707         return $evt if $evt;
708         $editor->finish;
709         $logger->info("fleshed copy update successfully updated ".scalar(@$copies)." copies");
710         return 1;
711 }
712
713
714 __PACKAGE__->register_method(
715         method => 'merge',
716         api_name        => 'open-ils.cat.biblio.records.merge',
717         signature       => q/
718                 Merges a group of records
719                 @param auth The login session key
720                 @param master The id of the record all other r
721                         ecords should be merged into
722                 @param records Array of records to be merged into the master record
723                 @return 1 on success, Event on error.
724         /
725 );
726
727 sub merge {
728         my( $self, $conn, $auth, $master, $records ) = @_;
729         my( $reqr, $evt ) = $U->checkses($auth);
730         return $evt if $evt;
731         my %r = map { $_ => 1 } (@$records, $master); # unique the ids
732         $records = [ keys %r ];
733         my $editor = OpenILS::Utils::Editor->new( requestor => $reqr, xact => 1 );
734         my $v = OpenILS::Application::Cat::Merge::merge_records($editor, $master, $records);
735         return $v if $v;
736         $editor->finish;
737         return 1;
738 }
739
740
741
742
743 # ---------------------------------------------------------------------------
744 # ---------------------------------------------------------------------------
745
746 # returns true if the given title (id) has no un-deleted
747 # copies attached
748 sub title_is_empty {
749         my( $editor, $rid ) = @_;
750
751         my $cnlist = $editor->search_asset_call_number(
752                 { record => $rid, deleted => 'f' }, { idlist => 1 } );
753         return 1 unless @$cnlist;
754
755         for my $cn (@$cnlist) {
756                 my $copylist = $editor->search_asset_copy(
757                         { call_number => $cn, deleted => 'f' }, { idlist => 1 });
758                 return 0 if @$copylist; # false if we find any copies
759         }
760
761         return 1;
762 }
763
764
765 __PACKAGE__->register_method(
766         method  => "fleshed_volume_update",
767         api_name        => "open-ils.cat.asset.volume.fleshed.batch.update",);
768
769 __PACKAGE__->register_method(
770         method  => "fleshed_volume_update",
771         api_name        => "open-ils.cat.asset.volume.fleshed.batch.update.override",);
772
773 sub fleshed_volume_update {
774         my( $self, $conn, $auth, $volumes ) = @_;
775         my( $reqr, $evt ) = $U->checkses($auth);
776         return $evt if $evt;
777
778         my $override = ($self->api_name =~ /override/);
779         my $editor = OpenILS::Utils::Editor->new( requestor => $reqr, xact => 1 );
780
781         for my $vol (@$volumes) {
782                 $logger->info("vol-update: investigating volume ".$vol->id);
783
784                 $vol->editor($reqr->id);
785                 $vol->edit_date('now');
786
787                 my $copies = $vol->copies;
788                 $vol->clear_copies;
789
790                 if( $vol->isdeleted ) {
791
792                         $logger->info("vol-update: deleting volume");
793                         my $cs = $editor->search_asset_copy(
794                                 { call_number => $vol->id, deleted => 'f' } );
795                         return OpenILS::Event->new(
796                                 'VOLUME_NOT_EMPTY', payload => $vol->id ) if @$cs;
797
798                         $vol->deleted('t');
799                         return $editor->event unless
800                                 $editor->update_asset_call_number($vol);
801
802                         
803                 } elsif( $vol->isnew ) {
804                         $logger->info("vol-update: creating volume");
805                         $evt = create_volume( $override, $editor, $vol );
806                         return $evt if $evt;
807
808                 } elsif( $vol->ischanged ) {
809                         $logger->info("vol-update: update volume");
810                         return $editor->event unless
811                                 $editor->update_asset_call_number($vol);
812                         return $evt if $evt;
813                 }
814
815                 # now update any attached copies
816                 if( @$copies and !$vol->isdeleted ) {
817                         $_->call_number($vol->id) for @$copies;
818                         $evt = update_fleshed_copies( $editor, $override, $vol, $copies );
819                         return $evt if $evt;
820                 }
821         }
822
823         $editor->finish;
824         return scalar(@$volumes);
825 }
826
827
828 # this does the actual work
829 sub update_fleshed_copies {
830         my( $editor, $override, $vol, $copies ) = @_;
831
832         my $evt;
833         my $fetchvol = ($vol) ? 0 : 1;
834
835         my %cache;
836         $cache{$vol->id} = $vol if $vol;
837
838         for my $copy (@$copies) {
839
840                 my $copyid = $copy->id;
841                 $logger->info("vol-update: inspecting copy $copyid");
842
843                 if( !($vol = $cache{$copy->call_number}) ) {
844                         $vol = $cache{$copy->call_number} = 
845                                 $editor->retrieve_asset_call_number($copy->call_number);
846                         return $editor->event unless $vol;
847                 }
848
849                 $copy->editor($editor->requestor->id);
850                 $copy->edit_date('now');
851
852                 $copy->status( $copy->status->id ) if ref($copy->status);
853                 $copy->location( $copy->location->id ) if ref($copy->location);
854                 $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
855                 
856                 my $sc_entries = $copy->stat_cat_entries;
857                 $copy->clear_stat_cat_entries;
858
859                 if( $copy->isdeleted ) {
860                         $evt = delete_copy($editor, $override, $vol, $copy);
861                         return $evt if $evt;
862
863                 } elsif( $copy->isnew ) {
864                         $evt = create_copy( $editor, $vol, $copy );
865                         return $evt if $evt;
866
867                 } elsif( $copy->ischanged ) {
868
869                         $logger->info("vol-update: updating copy $copyid");
870                         return $editor->event unless
871                                 $editor->update_asset_copy(
872                                         $copy, {checkperm=>1, permorg=>$vol->owning_lib});
873                         return $evt if $evt;
874                 }
875
876                 $copy->stat_cat_entries( $sc_entries );
877                 $evt = update_copy_stat_entries($editor, $copy);
878                 return $evt if $evt;
879         }
880
881         $logger->debug("vol-update: done updating copy batch");
882
883         return undef;
884 }
885
886 sub delete_copy {
887         my( $editor, $override, $vol, $copy ) = @_;
888
889         $logger->info("vol-update: deleting copy ".$copy->id);
890         $copy->deleted('t');
891
892         $editor->update_asset_copy(
893                 $copy, {checkperm=>1, permorg=>$vol->owning_lib})
894                 or return $editor->event;
895
896         if( title_is_empty($editor, $vol->record) ) {
897
898                 if( $override ) {
899
900                         # delete this volume if it's not already marked as deleted
901                         if(!$vol->deleted || $vol->deleted =~ /f/io || ! $vol->isdeleted) {
902                                 $vol->deleted('t');
903                                 $editor->update_asset_call_number($vol, {checkperm=>0})
904                                         or return $editor->event;
905                         }
906
907                         # then delete the record this volume points to
908                         my $rec = $editor->retrieve_biblio_record_entry($vol->record)
909                                 or return $editor->event;
910
911                         if( !$rec->deleted ) {
912                                 $rec->deleted('t');
913                                 $rec->active('f');
914                                 $editor->update_biblio_record_entry($rec, {checkperm=>0})
915                                         or return $editor->event;
916                         }
917
918                 } else {
919                         return OpenILS::Event->new('TITLE_LAST_COPY');
920                 }
921         }
922
923         return undef;
924 }
925
926 sub create_copy {
927         my( $editor, $vol, $copy ) = @_;
928
929         my $existing = $editor->search_asset_copy(
930                 { barcode => $copy->barcode } );
931         
932         return OpenILS::Event->new('ITEM_BARCODE_EXISTS') if @$existing;
933
934         $copy->clear_id;
935         $copy->creator($editor->requestor->id);
936         $copy->create_date('now');
937
938         $editor->create_asset_copy(
939                 $copy, {checkperm=>1, permorg=>$vol->owning_lib})
940                 or return $editor->event;
941
942         return undef;
943 }
944
945 sub update_copy_stat_entries {
946         my( $editor, $copy ) = @_;
947
948         my $evt;
949         my $entries = $copy->stat_cat_entries;
950         return undef unless ($entries and @$entries);
951
952         my $maps = $editor->search_asset_stat_cat_entry_copy_map({owning_copy=>$copy->id});
953
954         if(!$copy->isnew) {
955                 # if there is no stat cat entry on the copy who's id matches the
956                 # current map's id, remove the map from the database
957                 for my $map (@$maps) {
958                         if(! grep { $_->id == $map->stat_cat_entry } @$entries ) {
959
960                                 $logger->info("copy update found stale ".
961                                         "stat cat entry map ".$map->id. " on copy ".$copy->id);
962
963                                 $editor->delete_asset_stat_cat_entry_copy_map($map)
964                                         or return $editor->event;
965                         }
966                 }
967         }
968         
969         # go through the stat cat update/create process
970         for my $entry (@$entries) { 
971
972                 # if this link already exists in the DB, don't attempt to re-create it
973                 next if( grep{$_->stat_cat_entry == $entry->id} @$maps );
974         
975                 my $new_map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
976                 
977                 $new_map->stat_cat( $entry->stat_cat );
978                 $new_map->stat_cat_entry( $entry->id );
979                 $new_map->owning_copy( $copy->id );
980
981                 $editor->create_asset_stat_cat_entry_copy_map($new_map)
982                         or return $editor->event;
983
984                 $logger->info("copy update created new stat cat entry map ".$editor->data);
985         }
986
987         return undef;
988 }
989
990
991 sub create_volume {
992         my( $override, $editor, $vol ) = @_;
993         my $evt;
994
995
996         # first lets see if there are any collisions
997         my $vols = $editor->search_asset_call_number( { 
998                         owning_lib      => $vol->owning_lib,
999                         record          => $vol->record,
1000                         label                   => $vol->label,
1001                         deleted         => 'f'
1002                 }
1003         );
1004
1005         my $label = undef;
1006         if(@$vols) {
1007                 if($override) { 
1008                         $label = $vol->label;
1009                 } else {
1010                         return OpenILS::Event->new(
1011                                 'VOLUME_LABEL_EXISTS', payload => $vol->id);
1012                 }
1013         }
1014
1015         # create a temp label so we can create the volume, then de-dup it
1016         $vol->label( '__SYSTEM_TMP_'.time) if $label;
1017
1018         $vol->creator($editor->requestor->id);
1019         $vol->create_date('now');
1020         $vol->clear_id;
1021
1022         $editor->create_asset_call_number($vol) or return $editor->event;
1023
1024         if($label) {
1025                 # now restore the label and merge into the existing record
1026                 $vol->label($label);
1027                 (undef, $evt) = 
1028                         OpenILS::Application::Cat::Merge::merge_volumes($editor, [$vol], $$vols[0]);
1029                 return $evt if $evt;
1030         }
1031
1032         return undef;
1033 }
1034
1035
1036
1037
1038
1039
1040 1;