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