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