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