Open-ILS/src/perlmods/OpenILS/Application/Serial.pm

   1 #!/usr/bin/perl
   2
   3 # This program is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU General Public License
   5 # as published by the Free Software Foundation; either version 2
   6 # of the License, or (at your option) any later version.
   7 #
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License
  14 # along with this program; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  16
  17 =head1 NAME
  18
  19 OpenILS::Application::Serial - Performs serials-related tasks such as receiving issues and generating predictions
  20
  21 =head1 SYNOPSIS
  22
  23 TBD
  24
  25 =head1 DESCRIPTION
  26
  27 TBD
  28
  29 =head1 AUTHOR
  30
  31 Dan Wells, dbw2@calvin.edu
  32
  33 =cut
  34
  35 package OpenILS::Application::Serial;
  36
  37 use strict;
  38 use warnings;
  39
  40
  41 use OpenILS::Application;
  42 use base qw/OpenILS::Application/;
  43 use OpenILS::Application::AppUtils;
  44 use OpenILS::Event;
  45 use OpenSRF::AppSession;
  46 use OpenSRF::Utils qw/:datetime/;
  47 use OpenSRF::Utils::Logger qw/:logger/;
  48 use OpenILS::Utils::CStoreEditor q/:funcs/;
  49 use OpenILS::Utils::Fieldmapper;
  50 use OpenILS::Utils::MFHD;
  51 use MARC::File::XML (BinaryEncoding => 'utf8');
  52 my $U = 'OpenILS::Application::AppUtils';
  53 my @MFHD_NAMES = ('basic','supplement','index');
  54 my %MFHD_NAMES_BY_TAG = (  '853' => $MFHD_NAMES[0],
  55                         '863' => $MFHD_NAMES[0],
  56                         '854' => $MFHD_NAMES[1],
  57                         '864' => $MFHD_NAMES[1],
  58                         '855' => $MFHD_NAMES[2],
  59                         '865' => $MFHD_NAMES[2] );
  60 my %MFHD_TAGS_BY_NAME = (  $MFHD_NAMES[0] => '853',
  61                         $MFHD_NAMES[1] => '854',
  62                         $MFHD_NAMES[2] => '855');
  63
  64 # helper method for conforming dates to ISO8601
  65 sub _cleanse_dates {
  66     my $item = shift;
  67     my $fields = shift;
  68
  69     foreach my $field (@$fields) {
  70         $item->$field(OpenSRF::Utils::clense_ISO8601($item->$field)) if $item->$field;
  71     }
  72     return 0;
  73 }
  74
  75 sub _get_mvr {
  76     $U->simplereq(
  77         "open-ils.search",
  78         "open-ils.search.biblio.record.mods_slim.retrieve",
  79         @_
  80     );
  81 }
  82
  83
  84 ##########################################################################
  85 # item methods
  86 #
  87 __PACKAGE__->register_method(
  88     method    => 'fleshed_item_alter',
  89     api_name  => 'open-ils.serial.item.fleshed.batch.update',
  90     api_level => 1,
  91     argc      => 2,
  92     signature => {
  93         desc     => 'Receives an array of one or more items and updates the database as needed',
  94         'params' => [ {
  95                  name => 'authtoken',
  96                  desc => 'Authtoken for current user session',
  97                  type => 'string'
  98             },
  99             {
 100                  name => 'items',
 101                  desc => 'Array of fleshed items',
 102                  type => 'array'
 103             }
 104
 105         ],
 106         'return' => {
 107             desc => 'Returns 1 if successful, event if failed',
 108             type => 'mixed'
 109         }
 110     }
 111 );
 112
 113 sub fleshed_item_alter {
 114     my( $self, $conn, $auth, $items ) = @_;
 115     return 1 unless ref $items;
 116     my( $reqr, $evt ) = $U->checkses($auth);
 117     return $evt if $evt;
 118     my $editor = new_editor(requestor => $reqr, xact => 1);
 119     my $override = $self->api_name =~ /override/;
 120
 121 # TODO: permission check
 122 #        return $editor->event unless
 123 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
 124
 125     for my $item (@$items) {
 126
 127         my $itemid = $item->id;
 128         $item->editor($editor->requestor->id);
 129         $item->edit_date('now');
 130
 131         if( $item->isdeleted ) {
 132             $evt = _delete_sitem( $editor, $override, $item);
 133         } elsif( $item->isnew ) {
 134             # TODO: reconsider this
 135             # if the item has a new issuance, create the issuance first
 136             if (ref $item->issuance eq 'Fieldmapper::serial::issuance' and $item->issuance->isnew) {
 137                 fleshed_issuance_alter($self, $conn, $auth, [$item->issuance]);
 138             }
 139             _cleanse_dates($item, ['date_expected','date_received']);
 140             $evt = _create_sitem( $editor, $item );
 141         } else {
 142             _cleanse_dates($item, ['date_expected','date_received']);
 143             $evt = _update_sitem( $editor, $override, $item );
 144         }
 145     }
 146
 147     if( $evt ) {
 148         $logger->info("fleshed item-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
 149         $editor->rollback;
 150         return $evt;
 151     }
 152     $logger->debug("item-alter: done updating item batch");
 153     $editor->commit;
 154     $logger->info("fleshed item-alter successfully updated ".scalar(@$items)." items");
 155     return 1;
 156 }
 157
 158 sub _delete_sitem {
 159     my ($editor, $override, $item) = @_;
 160     $logger->info("item-alter: delete item ".OpenSRF::Utils::JSON->perl2JSON($item));
 161     return $editor->event unless $editor->delete_serial_item($item);
 162     return 0;
 163 }
 164
 165 sub _create_sitem {
 166     my ($editor, $item) = @_;
 167
 168     $item->creator($editor->requestor->id);
 169     $item->create_date('now');
 170
 171     $logger->info("item-alter: new item ".OpenSRF::Utils::JSON->perl2JSON($item));
 172     return $editor->event unless $editor->create_serial_item($item);
 173     return 0;
 174 }
 175
 176 sub _update_sitem {
 177     my ($editor, $override, $item) = @_;
 178
 179     $logger->info("item-alter: retrieving item ".$item->id);
 180     my $orig_item = $editor->retrieve_serial_item($item->id);
 181
 182     $logger->info("item-alter: original item ".OpenSRF::Utils::JSON->perl2JSON($orig_item));
 183     $logger->info("item-alter: updated item ".OpenSRF::Utils::JSON->perl2JSON($item));
 184     return $editor->event unless $editor->update_serial_item($item);
 185     return 0;
 186 }
 187
 188 __PACKAGE__->register_method(
 189     method  => "fleshed_serial_item_retrieve_batch",
 190     authoritative => 1,
 191     api_name    => "open-ils.serial.item.fleshed.batch.retrieve"
 192 );
 193
 194 sub fleshed_serial_item_retrieve_batch {
 195     my( $self, $client, $ids ) = @_;
 196 # FIXME: permissions?
 197     $logger->info("Fetching fleshed serial items @$ids");
 198     return $U->cstorereq(
 199         "open-ils.cstore.direct.serial.item.search.atomic",
 200         { id => $ids },
 201         { flesh => 2,
 202           flesh_fields => {sitem => [ qw/issuance creator editor stream unit notes/ ], sstr => ["distribution"], sunit => ["call_number"], siss => [qw/creator editor subscription/]}
 203         });
 204 }
 205
 206
 207 ##########################################################################
 208 # issuance methods
 209 #
 210 __PACKAGE__->register_method(
 211     method    => 'fleshed_issuance_alter',
 212     api_name  => 'open-ils.serial.issuance.fleshed.batch.update',
 213     api_level => 1,
 214     argc      => 2,
 215     signature => {
 216         desc     => 'Receives an array of one or more issuances and updates the database as needed',
 217         'params' => [ {
 218                  name => 'authtoken',
 219                  desc => 'Authtoken for current user session',
 220                  type => 'string'
 221             },
 222             {
 223                  name => 'issuances',
 224                  desc => 'Array of fleshed issuances',
 225                  type => 'array'
 226             }
 227
 228         ],
 229         'return' => {
 230             desc => 'Returns 1 if successful, event if failed',
 231             type => 'mixed'
 232         }
 233     }
 234 );
 235
 236 sub fleshed_issuance_alter {
 237     my( $self, $conn, $auth, $issuances ) = @_;
 238     return 1 unless ref $issuances;
 239     my( $reqr, $evt ) = $U->checkses($auth);
 240     return $evt if $evt;
 241     my $editor = new_editor(requestor => $reqr, xact => 1);
 242     my $override = $self->api_name =~ /override/;
 243
 244 # TODO: permission support
 245 #        return $editor->event unless
 246 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
 247
 248     for my $issuance (@$issuances) {
 249         my $issuanceid = $issuance->id;
 250         $issuance->editor($editor->requestor->id);
 251         $issuance->edit_date('now');
 252
 253         if( $issuance->isdeleted ) {
 254             $evt = _delete_siss( $editor, $override, $issuance);
 255         } elsif( $issuance->isnew ) {
 256             _cleanse_dates($issuance, ['date_published']);
 257             $evt = _create_siss( $editor, $issuance );
 258         } else {
 259             _cleanse_dates($issuance, ['date_published']);
 260             $evt = _update_siss( $editor, $override, $issuance );
 261         }
 262     }
 263
 264     if( $evt ) {
 265         $logger->info("fleshed issuance-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
 266         $editor->rollback;
 267         return $evt;
 268     }
 269     $logger->debug("issuance-alter: done updating issuance batch");
 270     $editor->commit;
 271     $logger->info("fleshed issuance-alter successfully updated ".scalar(@$issuances)." issuances");
 272     return 1;
 273 }
 274
 275 sub _delete_siss {
 276     my ($editor, $override, $issuance) = @_;
 277     $logger->info("issuance-alter: delete issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
 278     return $editor->event unless $editor->delete_serial_issuance($issuance);
 279     return 0;
 280 }
 281
 282 sub _create_siss {
 283     my ($editor, $issuance) = @_;
 284
 285     $issuance->creator($editor->requestor->id);
 286     $issuance->create_date('now');
 287
 288     $logger->info("issuance-alter: new issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
 289     return $editor->event unless $editor->create_serial_issuance($issuance);
 290     return 0;
 291 }
 292
 293 sub _update_siss {
 294     my ($editor, $override, $issuance) = @_;
 295
 296     $logger->info("issuance-alter: retrieving issuance ".$issuance->id);
 297     my $orig_issuance = $editor->retrieve_serial_issuance($issuance->id);
 298
 299     $logger->info("issuance-alter: original issuance ".OpenSRF::Utils::JSON->perl2JSON($orig_issuance));
 300     $logger->info("issuance-alter: updated issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
 301     return $editor->event unless $editor->update_serial_issuance($issuance);
 302     return 0;
 303 }
 304
 305 __PACKAGE__->register_method(
 306     method  => "fleshed_serial_issuance_retrieve_batch",
 307     authoritative => 1,
 308     api_name    => "open-ils.serial.issuance.fleshed.batch.retrieve"
 309 );
 310
 311 sub fleshed_serial_issuance_retrieve_batch {
 312     my( $self, $client, $ids ) = @_;
 313 # FIXME: permissions?
 314     $logger->info("Fetching fleshed serial issuances @$ids");
 315     return $U->cstorereq(
 316         "open-ils.cstore.direct.serial.issuance.search.atomic",
 317         { id => $ids },
 318         { flesh => 1,
 319           flesh_fields => {siss => [ qw/creator editor subscription/ ]}
 320         });
 321 }
 322
 323
 324 ##########################################################################
 325 # unit methods
 326 #
 327 __PACKAGE__->register_method(
 328     method    => 'fleshed_sunit_alter',
 329     api_name  => 'open-ils.serial.sunit.fleshed.batch.update',
 330     api_level => 1,
 331     argc      => 2,
 332     signature => {
 333         desc     => 'Receives an array of one or more Units and updates the database as needed',
 334         'params' => [ {
 335                  name => 'authtoken',
 336                  desc => 'Authtoken for current user session',
 337                  type => 'string'
 338             },
 339             {
 340                  name => 'sunits',
 341                  desc => 'Array of fleshed Units',
 342                  type => 'array'
 343             }
 344
 345         ],
 346         'return' => {
 347             desc => 'Returns 1 if successful, event if failed',
 348             type => 'mixed'
 349         }
 350     }
 351 );
 352
 353 sub fleshed_sunit_alter {
 354     my( $self, $conn, $auth, $sunits ) = @_;
 355     return 1 unless ref $sunits;
 356     my( $reqr, $evt ) = $U->checkses($auth);
 357     return $evt if $evt;
 358     my $editor = new_editor(requestor => $reqr, xact => 1);
 359     my $override = $self->api_name =~ /override/;
 360
 361 # TODO: permission support
 362 #        return $editor->event unless
 363 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
 364
 365     for my $sunit (@$sunits) {
 366         if( $sunit->isdeleted ) {
 367             $evt = _delete_sunit( $editor, $override, $sunit );
 368         } else {
 369             $sunit->default_location( $sunit->default_location->id ) if ref $sunit->default_location;
 370
 371             if( $sunit->isnew ) {
 372                 $evt = _create_sunit( $editor, $sunit );
 373             } else {
 374                 $evt = _update_sunit( $editor, $override, $sunit );
 375             }
 376         }
 377     }
 378
 379     if( $evt ) {
 380         $logger->info("fleshed sunit-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
 381         $editor->rollback;
 382         return $evt;
 383     }
 384     $logger->debug("sunit-alter: done updating sunit batch");
 385     $editor->commit;
 386     $logger->info("fleshed sunit-alter successfully updated ".scalar(@$sunits)." Units");
 387     return 1;
 388 }
 389
 390 sub _delete_sunit {
 391     my ($editor, $override, $sunit) = @_;
 392     $logger->info("sunit-alter: delete sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
 393     return $editor->event unless $editor->delete_serial_unit($sunit);
 394     return 0;
 395 }
 396
 397 sub _create_sunit {
 398     my ($editor, $sunit) = @_;
 399
 400     $logger->info("sunit-alter: new Unit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
 401     return $editor->event unless $editor->create_serial_unit($sunit);
 402     return 0;
 403 }
 404
 405 sub _update_sunit {
 406     my ($editor, $override, $sunit) = @_;
 407
 408     $logger->info("sunit-alter: retrieving sunit ".$sunit->id);
 409     my $orig_sunit = $editor->retrieve_serial_unit($sunit->id);
 410
 411     $logger->info("sunit-alter: original sunit ".OpenSRF::Utils::JSON->perl2JSON($orig_sunit));
 412     $logger->info("sunit-alter: updated sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
 413     return $editor->event unless $editor->update_serial_unit($sunit);
 414     return 0;
 415 }
 416
 417 __PACKAGE__->register_method(
 418         method  => "retrieve_unit_list",
 419     authoritative => 1,
 420         api_name        => "open-ils.serial.unit_list.retrieve"
 421 );
 422
 423 sub retrieve_unit_list {
 424
 425         my( $self, $client, @sdist_ids ) = @_;
 426
 427         if(ref($sdist_ids[0])) { @sdist_ids = @{$sdist_ids[0]}; }
 428
 429         my $e = new_editor();
 430
 431     my $query = {
 432         'select' =>
 433             { 'sunit' => [ 'id', 'summary_contents', 'sort_key' ],
 434               'sitem' => ['stream'],
 435               'sstr' => ['distribution'],
 436               'sdist' => [{'column' => 'label', 'alias' => 'sdist_label'}]
 437             },
 438         'from' =>
 439             { 'sdist' =>
 440                 { 'sstr' =>
 441                     { 'join' =>
 442                         { 'sitem' =>
 443                             { 'join' => { 'sunit' => {} } }
 444                         }
 445                     }
 446                 }
 447             },
 448         'distinct' => 'true',
 449         'where' => { '+sdist' => {'id' => \@sdist_ids} },
 450         'order_by' => [{'class' => 'sunit', 'field' => 'sort_key'}]
 451     };
 452
 453     my $unit_list_entries = $e->json_query($query);
 454
 455     my @entries;
 456     foreach my $entry (@$unit_list_entries) {
 457         my $value = {'sunit' => $entry->{id}, 'sstr' => $entry->{stream}, 'sdist' => $entry->{distribution}};
 458         my $label = $entry->{summary_contents};
 459         if (length($label) > 100) {
 460             $label = substr($label, 0, 100) . '...'; # limited space in dropdown / menu
 461         }
 462         $label = "[$entry->{sdist_label}/$entry->{stream} #$entry->{id}] " . $label;
 463         push (@entries, [$label, OpenSRF::Utils::JSON->perl2JSON($value)]);
 464     }
 465
 466     return \@entries;
 467 }
 468
 469
 470
 471 ##########################################################################
 472 # predict and receive methods
 473 #
 474 __PACKAGE__->register_method(
 475     method    => 'make_predictions',
 476     api_name  => 'open-ils.serial.make_predictions',
 477     api_level => 1,
 478     argc      => 1,
 479     signature => {
 480         desc     => 'Receives an ssub id and populates the issuance and item tables',
 481         'params' => [ {
 482                  name => 'ssub_id',
 483                  desc => 'Serial Subscription ID',
 484                  type => 'int'
 485             }
 486         ]
 487     }
 488 );
 489
 490 sub make_predictions {
 491     my ($self, $conn, $authtoken, $args) = @_;
 492
 493     my $editor = OpenILS::Utils::CStoreEditor->new();
 494     my $ssub_id = $args->{ssub_id};
 495     my $mfhd = MFHD->new(MARC::Record->new());
 496
 497     my $ssub = $editor->retrieve_serial_subscription([$ssub_id]);
 498     my $scaps = $editor->search_serial_caption_and_pattern({ subscription => $ssub_id, active => 't'});
 499     my $sdists = $editor->search_serial_distribution( [{ subscription => $ssub->id }, {  flesh => 1,
 500               flesh_fields => {sdist => [ qw/ streams / ]}, limit => 1 }] ); #TODO: 'deleted' support?
 501
 502     my @predictions;
 503     my $link_id = 1;
 504     foreach my $scap (@$scaps) {
 505         my $caption_field = _revive_caption($scap);
 506         $caption_field->update('8' => $link_id);
 507         $mfhd->append_fields($caption_field);
 508         my $options = {
 509                 'caption' => $caption_field,
 510                 'scap_id' => $scap->id,
 511                 'num_to_predict' => $args->{num_to_predict}
 512                 };
 513         if ($args->{base_issuance}) { # predict from a given issuance
 514             $options->{predict_from} = _revive_holding($args->{base_issuance}->holding_code, $caption_field, 1); # fresh MFHD Record, so we simply default to 1 for seqno
 515         } else { # default to predicting from last published
 516             my $last_published = $editor->search_serial_issuance([
 517                     {'caption_and_pattern' => $scap->id,
 518                     'subscription' => $ssub_id},
 519                 {limit => 1, order_by => { siss => "date_published DESC" }}]
 520                 );
 521             if ($last_published->[0]) {
 522                 my $last_siss = $last_published->[0];
 523                 $options->{predict_from} = _revive_holding($last_siss->holding_code, $caption_field, 1);
 524             } else {
 525                 #TODO: throw event (can't predict from nothing!)
 526             }
 527         }
 528         push( @predictions, _generate_issuance_values($mfhd, $options) );
 529         $link_id++;
 530     }
 531
 532     my @issuances;
 533     foreach my $prediction (@predictions) {
 534         my $issuance = new Fieldmapper::serial::issuance;
 535         $issuance->isnew(1);
 536         $issuance->label($prediction->{label});
 537         $issuance->date_published($prediction->{date_published}->strftime('%F'));
 538         $issuance->holding_code(OpenSRF::Utils::JSON->perl2JSON($prediction->{holding_code}));
 539         $issuance->holding_type($prediction->{holding_type});
 540         $issuance->caption_and_pattern($prediction->{caption_and_pattern});
 541         $issuance->subscription($ssub->id);
 542         push (@issuances, $issuance);
 543     }
 544
 545     fleshed_issuance_alter($self, $conn, $authtoken, \@issuances); # FIXME: catch events
 546
 547     my @items;
 548     for (my $i = 0; $i < @issuances; $i++) {
 549         my $date_expected = $predictions[$i]->{date_published}->add(seconds => interval_to_seconds($ssub->expected_date_offset))->strftime('%F');
 550         my $issuance = $issuances[$i];
 551         #$issuance->label(interval_to_seconds($ssub->expected_date_offset));
 552         foreach my $sdist (@$sdists) {
 553             my $streams = $sdist->streams;
 554             foreach my $stream (@$streams) {
 555                 my $item = new Fieldmapper::serial::item;
 556                 $item->isnew(1);
 557                 $item->stream($stream->id);
 558                 $item->date_expected($date_expected);
 559                 $item->issuance($issuance->id);
 560                 push (@items, $item);
 561             }
 562         }
 563     }
 564     fleshed_item_alter($self, $conn, $authtoken, \@items); # FIXME: catch events
 565     return \@items;
 566 }
 567
 568 #
 569 # _generate_issuance_values() is an initial attempt at a function which can be used
 570 # to populate an issuance table with a list of predicted issues.  It accepts
 571 # a hash ref of options initially defined as:
 572 # caption : the caption field to predict on
 573 # num_to_predict : the number of issues you wish to predict
 574 # last_rec_date : the date of the last received issue, to be used as an offset
 575 #                 for predicting future issues
 576 #
 577 # The basic method is to first convert to a single holding if compressed, then
 578 # increment the holding and save the resulting values to @issuances.
 579 #
 580 # returns @issuance_values, an array of hashrefs containing (formatted
 581 # label, formatted chronology date, formatted estimated arrival date, and an
 582 # array ref of holding subfields as (key, value, key, value ...)) (not a hash
 583 # to protect order and possible duplicate keys), and a holding type.
 584 #
 585 sub _generate_issuance_values {
 586     my ($mfhd, $options) = @_;
 587     my $caption = $options->{caption};
 588     my $scap_id = $options->{scap_id};
 589     my $num_to_predict = $options->{num_to_predict};
 590     my $predict_from = $options->{predict_from};   # issuance to predict from
 591     #my $last_rec_date = $options->{last_rec_date};   # expected or actual
 592
 593     # TODO: add support for predicting serials with no chronology by passing in
 594     # a last_pub_date option?
 595
 596
 597 # Only needed for 'real' MFHD records, not our temp records
 598 #    my $link_id = $caption->link_id;
 599 #    if(!$predict_from) {
 600 #        my $htag = $caption->tag;
 601 #        $htag =~ s/^85/86/;
 602 #        my @holdings = $mfhd->holdings($htag, $link_id);
 603 #        my $last_holding = $holdings[-1];
 604 #
 605 #        #if ($last_holding->is_compressed) {
 606 #        #    $last_holding->compressed_to_last; # convert to last in range
 607 #        #}
 608 #        $predict_from = $last_holding;
 609 #    }
 610 #
 611
 612     $predict_from->notes('public',  []);
 613 # add a note marker for system use (?)
 614     $predict_from->notes('private', ['AUTOGEN']);
 615
 616     my $strp = new DateTime::Format::Strptime(pattern => '%F');
 617     my $pub_date;
 618     my @issuance_values;
 619     my @predictions = $mfhd->generate_predictions({'base_holding' => $predict_from, 'num_to_predict' => $num_to_predict});
 620     foreach my $prediction (@predictions) {
 621         $pub_date = $strp->parse_datetime($prediction->chron_to_date);
 622         push(
 623                 @issuance_values,
 624                 {
 625                     #$link_id,
 626                     label => $prediction->format,
 627                     date_published => $pub_date,
 628                     #date_expected => $date_expected->strftime('%F'),
 629                     holding_code => [$prediction->indicator(1),$prediction->indicator(2),$prediction->subfields_list],
 630                     holding_type => $MFHD_NAMES_BY_TAG{$caption->tag},
 631                     caption_and_pattern => $scap_id
 632                 }
 633             );
 634     }
 635
 636     return @issuance_values;
 637 }
 638
 639 sub _revive_caption {
 640     my $scap = shift;
 641
 642     my $pattern_code = $scap->pattern_code;
 643
 644     # build MARC::Field
 645     my $pattern_parts = OpenSRF::Utils::JSON->JSON2perl($pattern_code);
 646     unshift(@$pattern_parts, $MFHD_TAGS_BY_NAME{$scap->type});
 647     my $pattern_field = new MARC::Field(@$pattern_parts);
 648
 649     # build MFHD::Caption
 650     return new MFHD::Caption($pattern_field);
 651 }
 652
 653 sub _revive_holding {
 654     my $holding_code = shift;
 655     my $caption_field = shift;
 656     my $seqno = shift;
 657
 658     # build MARC::Field
 659     my $holding_parts = OpenSRF::Utils::JSON->JSON2perl($holding_code);
 660     my $captag = $caption_field->tag;
 661     $captag =~ s/^85/86/;
 662     unshift(@$holding_parts, $captag);
 663     my $holding_field = new MARC::Field(@$holding_parts);
 664
 665     # build MFHD::Holding
 666     return new MFHD::Holding($seqno, $holding_field, $caption_field);
 667 }
 668
 669 __PACKAGE__->register_method(
 670     method    => 'unitize_items',
 671     api_name  => 'open-ils.serial.receive_items',
 672     api_level => 1,
 673     argc      => 1,
 674     signature => {
 675         desc     => 'Marks an item as received, updates the shelving unit (creating a new shelving unit if needed), and updates the summaries',
 676         'params' => [ {
 677                  name => 'items',
 678                  desc => 'array of serial items',
 679                  type => 'array'
 680             }
 681         ],
 682         'return' => {
 683             desc => 'Returns number of received items',
 684             type => 'int'
 685         }
 686     }
 687 );
 688
 689 sub unitize_items {
 690     my ($self, $conn, $auth, $items) = @_;
 691
 692     my( $reqr, $evt ) = $U->checkses($auth);
 693     return $evt if $evt;
 694     my $editor = new_editor(requestor => $reqr, xact => 1);
 695     $self->api_name =~ /serial\.(\w*)_items/;
 696     my $mode = $1;
 697
 698     my %found_unit_ids;
 699     my %found_stream_ids;
 700     my %found_types;
 701
 702     my %stream_ids_by_unit_id;
 703
 704     my %unit_map;
 705     my %sdist_by_unit_id;
 706     my %sdist_by_stream_id;
 707
 708     my $new_unit_id; # id for '-2' units to share
 709     foreach my $item (@$items) {
 710         # for debugging only, TODO: delete
 711         if (!ref $item) { # hopefully we got an id instead
 712             $item = $editor->retrieve_serial_item($item);
 713         }
 714         # get ids
 715         my $unit_id = ref($item->unit) ? $item->unit->id : $item->unit;
 716         my $stream_id = ref($item->stream) ? $item->stream->id : $item->stream;
 717         my $issuance_id = ref($item->issuance) ? $item->issuance->id : $item->issuance;
 718         #TODO: evt on any missing ids
 719
 720         if ($mode eq 'receive') {
 721             $item->date_received('now');
 722             $item->status('Received');
 723         } else {
 724             $item->status('Bindery');
 725         }
 726
 727         # check for types to trigger summary updates
 728         my $scap;
 729         if (!ref $item->issuance) {
 730             my $scaps = $editor->search_serial_caption_and_pattern([{"+siss" => {"id" => $issuance_id}}, { "join" => {"siss" => {}} }]);
 731             $scap = $scaps->[0];
 732         } elsif (!ref $item->issuance->caption_and_pattern) {
 733             $scap = $editor->retrieve_serial_caption_and_pattern($item->issuance->caption_and_pattern);
 734         } else {
 735             $scap = $editor->issuance->caption_and_pattern;
 736         }
 737         if (!exists($found_types{$stream_id})) {
 738             $found_types{$stream_id} = {};
 739         }
 740         $found_types{$stream_id}->{$scap->type} = 1;
 741
 742         # create unit if needed
 743         if ($unit_id == -1 or (!$new_unit_id and $unit_id == -2)) { # create unit per item
 744             my $unit;
 745             my $sdists = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
 746             $unit = _build_unit($editor, $sdists->[0], $mode);
 747             my $evt =  _create_sunit($editor, $unit);
 748             return $evt if $evt;
 749             if ($unit_id == -2) {
 750                 $new_unit_id = $unit->id;
 751                 $unit_id = $new_unit_id;
 752             } else {
 753                 $unit_id = $unit->id;
 754             }
 755             $item->unit($unit_id);
 756
 757             # get unit with 'DEFAULT's and save unit and sdist for later use
 758             $unit = $editor->retrieve_serial_unit($unit->id);
 759             $unit_map{$unit_id} = $unit;
 760             $sdist_by_unit_id{$unit_id} = $sdists->[0];
 761             $sdist_by_stream_id{$stream_id} = $sdists->[0];
 762         } elsif ($unit_id == -2) { # create one unit for all '-2' items
 763             $unit_id = $new_unit_id;
 764             $item->unit($unit_id);
 765         }
 766
 767         $found_unit_ids{$unit_id} = 1;
 768         $found_stream_ids{$stream_id} = 1;
 769
 770         # save the stream_id for this unit_id
 771         # TODO: prevent items from different streams in same unit? (perhaps in interface)
 772         $stream_ids_by_unit_id{$unit_id} = $stream_id;
 773
 774         my $evt = _update_sitem($editor, undef, $item);
 775         return $evt if $evt;
 776     }
 777
 778     # deal with unit level labels
 779     foreach my $unit_id (keys %found_unit_ids) {
 780
 781         # get all the needed issuances for unit
 782         my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"unit" => $unit_id, "status" => "Received"}}, {"join" => {"sitem" => {}}, "order_by" => {"siss" => "date_published"}} ]);
 783         #TODO: evt on search failure
 784
 785         my ($mfhd, $formatted_parts) = _summarize_contents($editor, $issuances);
 786
 787         # special case for single formatted_part (may have summarized version)
 788         if (@$formatted_parts == 1) {
 789             #TODO: MFHD.pm should have a 'format_summary' method for this
 790         }
 791
 792         # retrieve and update unit contents
 793         my $sunit;
 794         my $sdist;
 795
 796         # if we just created the unit, we will already have it and the distribution stored
 797         if (exists $unit_map{$unit_id}) {
 798             $sunit = $unit_map{$unit_id};
 799             $sdist = $sdist_by_unit_id{$unit_id};
 800         } else {
 801             $sunit = $editor->retrieve_serial_unit($unit_id);
 802             $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_ids_by_unit_id{$unit_id}}}, { "join" => {"sstr" => {}} }]);
 803             $sdist = $sdist->[0];
 804         }
 805
 806         $sunit->detailed_contents($sdist->unit_label_prefix . ' '
 807                     . join(', ', @$formatted_parts) . ' '
 808                     . $sdist->unit_label_suffix);
 809
 810         $sunit->summary_contents($sunit->detailed_contents); #TODO: change this when real summary contents are available
 811
 812         # create sort_key by left padding numbers to 6 digits
 813         my $sort_key = $sunit->detailed_contents;
 814         $sort_key =~ s/(\d+)/sprintf '%06d', $1/eg; # this may need improvement
 815         $sunit->sort_key($sort_key);
 816
 817         if ($mode eq 'bind') {
 818             $sunit->status(2); # set to 'Bindery' status
 819         }
 820
 821         my $evt = _update_sunit($editor, undef, $sunit);
 822         return $evt if $evt;
 823     }
 824
 825     # TODO: cleanup 'dead' units (units which are now emptied of their items)
 826
 827     if ($mode eq 'receive') { # the summary holdings do not change when binding
 828         # deal with stream level summaries
 829         # summaries will be built from the "primary" stream only, that is, the stream with the lowest ID per distribution
 830         # (TODO: consider direct designation)
 831         my %primary_streams_by_sdist;
 832         my %streams_by_sdist;
 833
 834         # see if we have primary streams, and if so, associate them with their distributions
 835         foreach my $stream_id (keys %found_stream_ids) {
 836             my $sdist;
 837             if (exists $sdist_by_stream_id{$stream_id}) {
 838                 $sdist = $sdist_by_stream_id{$stream_id};
 839             } else {
 840                 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
 841                 $sdist = $sdist->[0];
 842             }
 843             my $streams;
 844             if (!exists($streams_by_sdist{$sdist->id})) {
 845                 $streams = $editor->search_serial_stream([{"distribution" => $sdist->id}, {"order_by" => {"sstr" => "id"}}]);
 846                 $streams_by_sdist{$sdist->id} = $streams;
 847             } else {
 848                 $streams = $streams_by_sdist{$sdist->id};
 849             }
 850             $primary_streams_by_sdist{$sdist->id} = $streams->[0] if ($stream_id == $streams->[0]->id);
 851         }
 852
 853         # retrieve and update summaries for each affected primary stream's distribution
 854         foreach my $sdist_id (keys %primary_streams_by_sdist) {
 855             my $stream = $primary_streams_by_sdist{$sdist_id};
 856             my $stream_id = $stream->id;
 857             # get all the needed issuances for stream
 858             # FIXME: search in Bindery/Bound/Not Published? as well as Received
 859             foreach my $type (keys %{$found_types{$stream_id}}) {
 860                 my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"stream" => $stream_id, "status" => "Received"}, "+scap" => {"type" => $type}}, {"join" => {"sitem" => {}, "scap" => {}}, "order_by" => {"siss" => "date_published"}} ]);
 861                 #TODO: evt on search failure
 862
 863                 my ($mfhd, $formatted_parts) = _summarize_contents($editor, $issuances);
 864
 865                 # retrieve and update the generated_coverage of the summary
 866                 my $search_method = "search_serial_${type}_summary";
 867                 my $summary = $editor->$search_method([{"distribution" => $sdist_id}]);
 868                 $summary = $summary->[0];
 869                 $summary->generated_coverage(join(', ', @$formatted_parts));
 870                 my $update_method = "update_serial_${type}_summary";
 871                 return $editor->event unless $editor->$update_method($summary);
 872             }
 873         }
 874     }
 875
 876     $editor->commit;
 877     return {'num_items_received' => scalar @$items, 'new_unit_id' => $new_unit_id};
 878 }
 879
 880 __PACKAGE__->register_method(
 881     "method" => "receive_items_one_unit_per",
 882     "api_name" => "open-ils.serial.receive_items.one_unit_per",
 883     "stream" => 1,
 884     "api_level" => 1,
 885     "argc" => 3,
 886     "signature" => {
 887         "desc" => "Marks items in a list as received, creates a new unit for each item if any unit is fleshed on",
 888         "params" => [
 889             {
 890                  "name" => "auth",
 891                  "desc" => "authtoken",
 892                  "type" => "string"
 893             },
 894             {
 895                  "name" => "items",
 896                  "desc" => "array of serial items, possibly fleshed with units and definitely fleshed with stream->distribution",
 897                  "type" => "array"
 898             },
 899             {
 900                 "name" => "record",
 901                 "desc" => "id of bib record these items are associated with
 902                     (XXX could/should be derived from items)",
 903                 "type" => "number"
 904             }
 905         ],
 906         "return" => {
 907             "desc" => "The item ID for each item successfully received",
 908             "type" => "int"
 909         }
 910     }
 911 );
 912
 913 sub receive_items_one_unit_per {
 914     # XXX This function may be temporary. unitize_items() would seem to aim to
 915     # accomodate what this function does as well as other variations on the
 916     # operation (binding multiple items into one unit, etc.?) plus generating
 917     # summaries.  This is just a minimal get-it-working-now implementation.
 918     # In the future, when unitize_items() is ready, perhaps any registered
 919     # method names that point to this function can be repointed at
 920     # unitize_items()
 921
 922     my ($self, $client, $auth, $items, $record) = @_;
 923
 924     my $e = new_editor("authtoken" => $auth, "xact" => 1);
 925     return $e->die_event unless $e->checkauth;
 926
 927     my $user_id = $e->requestor->id;
 928
 929     # Get a list of all the non-virtual field names in a serial::unit for
 930     # merging given unit objects with template-built units later.
 931     # XXX move this somewhere global so it isn't re-run all the time
 932     my $all_unit_fields =
 933         $Fieldmapper::fieldmap->{"Fieldmapper::serial::unit"}->{"fields"};
 934     my @real_unit_fields = grep {
 935         not $all_unit_fields->{$_}->{"virtual"}
 936     } keys %$all_unit_fields;
 937
 938     foreach my $item (@$items) {
 939         # Note that we expect a certain fleshing on the items we're getting.
 940         my $sdist = $item->stream->distribution;
 941
 942         # Create unit if given by user
 943         if (ref $item->unit) {
 944             # detach from the item, as we need to create separately
 945             my $user_unit = $item->unit;
 946
 947             # get a unit based on associated template
 948             my $template_unit = _build_unit($e, $sdist, "receive", 1);
 949             if ($U->event_code($template_unit)) {
 950                 $e->rollback;
 951                 $template_unit->{"note"} = "Item ID: " . $item->id;
 952                 return $template_unit;
 953             }
 954
 955             # merge built unit with provided unit from user
 956             foreach (@real_unit_fields) {
 957                 unless ($user_unit->$_) {
 958                     $user_unit->$_($template_unit->$_);
 959                 }
 960             }
 961
 962             if ($user_unit->call_number) {
 963                 # call_number passed in will actually be a string representing
 964                 # a call_number label, not an actual acn object or even an ID.
 965                 # Therefore we must lookup the call_number requested, or
 966                 # create a new one if it does not exist for the given lib.
 967
 968                 my $existing = $e->search_asset_call_number({
 969                     "owning_lib" => $sdist->holding_lib->id,
 970                     "label" => $user_unit->call_number,
 971                     "record" => $record,
 972                     "deleted" => "f"
 973                 }) or return $e->die_event;
 974
 975                 if (@$existing) {
 976                     $user_unit->call_number($existing->[0]->id);
 977                 } else {
 978                     return $e->die_event unless
 979                         $e->allowed("CREATE_VOLUME", $sdist->holding_lib->id);
 980
 981                     my $acn = new Fieldmapper::asset::call_number;
 982
 983                     $acn->creator($user_id);
 984                     $acn->editor($user_id);
 985                     $acn->record($record);
 986                     $acn->label($user_unit->call_number);
 987                     $acn->owning_lib($sdist->holding_lib->id);
 988
 989                     $e->create_asset_call_number($acn) or return $e->die_event;
 990
 991                     $user_unit->call_number($e->data->id);
 992                 }
 993             }
 994
 995             # set the incontrovertibles on the unit
 996             $user_unit->edit_date("now");
 997             $user_unit->create_date("now");
 998             $user_unit->editor($user_id);
 999             $user_unit->creator($user_id);
1000
1001             return $e->die_event unless $e->create_serial_unit($user_unit);
1002
1003             # save reference to new unit
1004             $item->unit($e->data->id);
1005         }
1006
1007         # Create notes if given by user
1008         if (ref($item->notes) and @{$item->notes}) {
1009             foreach my $note (@{$item->notes}) {
1010                 $note->creator($user_id);
1011                 $note->create_date("now");
1012
1013                 return $e->die_event unless $e->create_serial_item_note($note);
1014             }
1015
1016             $item->clear_notes; # They're saved; we no longer want them here.
1017         }
1018
1019         # Set the incontrovertibles on the item
1020         $item->date_received("now");
1021         $item->edit_date("now");
1022         $item->editor($user_id);
1023
1024         return $e->die_event unless $e->update_serial_item($item);
1025
1026         # send client a response
1027         $client->respond($item->id);
1028     }
1029
1030     # XXX TODO update basic/supplementary/index summaries
1031
1032     $e->commit or return $e->die_event;
1033     undef;
1034 }
1035
1036 sub _build_unit {
1037     my $editor = shift;
1038     my $sdist = shift;
1039     my $mode = shift;
1040     my $skip_call_number = shift;
1041
1042     my $attr = $mode . '_unit_template';
1043     my $template = $editor->retrieve_asset_copy_template($sdist->$attr) or
1044         return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_COPY_TEMPLATE");
1045
1046     my @parts = qw( status location loan_duration fine_level age_protect circulate deposit ref holdable deposit_amount price circ_modifier circ_as_type alert_message opac_visible floating mint_condition );
1047
1048     my $unit = new Fieldmapper::serial::unit;
1049     foreach my $part (@parts) {
1050         my $value = $template->$part;
1051         next if !defined($value);
1052         $unit->$part($value);
1053     }
1054
1055     # ignore circ_lib in template, set to distribution holding_lib
1056     $unit->circ_lib($sdist->holding_lib);
1057     $unit->creator($editor->requestor->id);
1058     $unit->editor($editor->requestor->id);
1059
1060     unless ($skip_call_number) {
1061         $attr = $mode . '_call_number';
1062         my $cn = $sdist->$attr or
1063             return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_CALL_NUMBER");
1064
1065         $unit->call_number($cn);
1066     }
1067
1068     $unit->barcode('AUTO');
1069     $unit->sort_key('');
1070     $unit->summary_contents('');
1071     $unit->detailed_contents('');
1072
1073     return $unit;
1074 }
1075
1076
1077 sub _summarize_contents {
1078     my $editor = shift;
1079     my $issuances = shift;
1080
1081     # create MFHD record
1082     my $mfhd = MFHD->new(MARC::Record->new());
1083     my %scaps;
1084     my %scap_fields;
1085     my @scap_fields_ordered;
1086     my $seqno = 1;
1087     my $link_id = 1;
1088     foreach my $issuance (@$issuances) {
1089         my $scap_id = $issuance->caption_and_pattern;
1090         next if (!$scap_id); # skip issuances with no caption/pattern
1091
1092         my $scap;
1093         my $scap_field;
1094         # if this is the first appearance of this scap, retrieve it and add it to the temporary record
1095         if (!exists $scaps{$issuance->caption_and_pattern}) {
1096             $scaps{$scap_id} = $editor->retrieve_serial_caption_and_pattern($scap_id);
1097             $scap = $scaps{$scap_id};
1098             $scap_field = _revive_caption($scap);
1099             $scap_fields{$scap_id} = $scap_field;
1100             push(@scap_fields_ordered, $scap_field);
1101             $scap_field->update('8' => $link_id);
1102             $mfhd->append_fields($scap_field);
1103             $link_id++;
1104         } else {
1105             $scap = $scaps{$scap_id};
1106             $scap_field = $scap_fields{$scap_id};
1107         }
1108
1109         $mfhd->append_fields(_revive_holding($issuance->holding_code, $scap_field, $seqno));
1110         $seqno++;
1111     }
1112
1113     my @formatted_parts;
1114     foreach my $scap_field (@scap_fields_ordered) { #TODO: use generic MFHD "summarize" method, once available
1115        my @updated_holdings = $mfhd->get_compressed_holdings($scap_field);
1116        foreach my $holding (@updated_holdings) {
1117            push(@formatted_parts, $holding->format);
1118        }
1119     }
1120
1121     return ($mfhd, \@formatted_parts);
1122 }
1123
1124 ##########################################################################
1125 # note methods
1126 #
1127 __PACKAGE__->register_method(
1128     method      => 'fetch_notes',
1129     api_name        => 'open-ils.serial.item_note.retrieve.all',
1130     signature   => q/
1131         Returns an array of copy note objects.
1132         @param args A named hash of parameters including:
1133             authtoken   : Required if viewing non-public notes
1134             item_id      : The id of the item whose notes we want to retrieve
1135             pub         : True if all the caller wants are public notes
1136         @return An array of note objects
1137     /
1138 );
1139
1140 __PACKAGE__->register_method(
1141     method      => 'fetch_notes',
1142     api_name        => 'open-ils.serial.subscription_note.retrieve.all',
1143     signature   => q/
1144         Returns an array of copy note objects.
1145         @param args A named hash of parameters including:
1146             authtoken       : Required if viewing non-public notes
1147             subscription_id : The id of the item whose notes we want to retrieve
1148             pub             : True if all the caller wants are public notes
1149         @return An array of note objects
1150     /
1151 );
1152
1153 __PACKAGE__->register_method(
1154     method      => 'fetch_notes',
1155     api_name        => 'open-ils.serial.distribution_note.retrieve.all',
1156     signature   => q/
1157         Returns an array of copy note objects.
1158         @param args A named hash of parameters including:
1159             authtoken       : Required if viewing non-public notes
1160             distribution_id : The id of the item whose notes we want to retrieve
1161             pub             : True if all the caller wants are public notes
1162         @return An array of note objects
1163     /
1164 );
1165
1166 # TODO: revisit this method to consider replacing cstore direct calls
1167 sub fetch_notes {
1168     my( $self, $connection, $args ) = @_;
1169
1170     $self->api_name =~ /serial\.(\w*)_note/;
1171     my $type = $1;
1172
1173     my $id = $$args{object_id};
1174     my $authtoken = $$args{authtoken};
1175     my( $r, $evt);
1176
1177     if( $$args{pub} ) {
1178         return $U->cstorereq(
1179             'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic',
1180             { $type => $id, pub => 't' } );
1181     } else {
1182         # FIXME: restore perm check
1183         # ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
1184         # return $evt if $evt;
1185         return $U->cstorereq(
1186             'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic', {$type => $id} );
1187     }
1188
1189     return undef;
1190 }
1191
1192 __PACKAGE__->register_method(
1193     method      => 'create_note',
1194     api_name        => 'open-ils.serial.item_note.create',
1195     signature   => q/
1196         Creates a new item note
1197         @param authtoken The login session key
1198         @param note The note object to create
1199         @return The id of the new note object
1200     /
1201 );
1202
1203 __PACKAGE__->register_method(
1204     method      => 'create_note',
1205     api_name        => 'open-ils.serial.subscription_note.create',
1206     signature   => q/
1207         Creates a new subscription note
1208         @param authtoken The login session key
1209         @param note The note object to create
1210         @return The id of the new note object
1211     /
1212 );
1213
1214 __PACKAGE__->register_method(
1215     method      => 'create_note',
1216     api_name        => 'open-ils.serial.distribution_note.create',
1217     signature   => q/
1218         Creates a new distribution note
1219         @param authtoken The login session key
1220         @param note The note object to create
1221         @return The id of the new note object
1222     /
1223 );
1224
1225 sub create_note {
1226     my( $self, $connection, $authtoken, $note ) = @_;
1227
1228     $self->api_name =~ /serial\.(\w*)_note/;
1229     my $type = $1;
1230
1231     my $e = new_editor(xact=>1, authtoken=>$authtoken);
1232     return $e->event unless $e->checkauth;
1233
1234     # FIXME: restore permission support
1235 #    my $item = $e->retrieve_serial_item(
1236 #        [
1237 #            $note->item
1238 #        ]
1239 #    );
1240 #
1241 #    return $e->event unless
1242 #        $e->allowed('CREATE_COPY_NOTE', $item->call_number->owning_lib);
1243
1244     $note->create_date('now');
1245     $note->creator($e->requestor->id);
1246     $note->pub( ($U->is_true($note->pub)) ? 't' : 'f' );
1247     $note->clear_id;
1248
1249     my $method = "create_serial_${type}_note";
1250     $e->$method($note) or return $e->event;
1251     $e->commit;
1252     return $note->id;
1253 }
1254
1255 __PACKAGE__->register_method(
1256     method      => 'delete_note',
1257     api_name        =>  'open-ils.serial.item_note.delete',
1258     signature   => q/
1259         Deletes an existing item note
1260         @param authtoken The login session key
1261         @param noteid The id of the note to delete
1262         @return 1 on success - Event otherwise.
1263         /
1264 );
1265
1266 __PACKAGE__->register_method(
1267     method      => 'delete_note',
1268     api_name        =>  'open-ils.serial.subscription_note.delete',
1269     signature   => q/
1270         Deletes an existing subscription note
1271         @param authtoken The login session key
1272         @param noteid The id of the note to delete
1273         @return 1 on success - Event otherwise.
1274         /
1275 );
1276
1277 __PACKAGE__->register_method(
1278     method      => 'delete_note',
1279     api_name        =>  'open-ils.serial.distribution_note.delete',
1280     signature   => q/
1281         Deletes an existing distribution note
1282         @param authtoken The login session key
1283         @param noteid The id of the note to delete
1284         @return 1 on success - Event otherwise.
1285         /
1286 );
1287
1288 sub delete_note {
1289     my( $self, $conn, $authtoken, $noteid ) = @_;
1290
1291     $self->api_name =~ /serial\.(\w*)_note/;
1292     my $type = $1;
1293
1294     my $e = new_editor(xact=>1, authtoken=>$authtoken);
1295     return $e->die_event unless $e->checkauth;
1296
1297     my $method = "retrieve_serial_${type}_note";
1298     my $note = $e->$method([
1299         $noteid,
1300     ]) or return $e->die_event;
1301
1302 # FIXME: restore permissions check
1303 #    if( $note->creator ne $e->requestor->id ) {
1304 #        return $e->die_event unless
1305 #            $e->allowed('DELETE_COPY_NOTE', $note->item->call_number->owning_lib);
1306 #    }
1307
1308     $method = "delete_serial_${type}_note";
1309     $e->$method($note) or return $e->die_event;
1310     $e->commit;
1311     return 1;
1312 }
1313
1314
1315 ##########################################################################
1316 # subscription methods
1317 #
1318 __PACKAGE__->register_method(
1319     method    => 'fleshed_ssub_alter',
1320     api_name  => 'open-ils.serial.subscription.fleshed.batch.update',
1321     api_level => 1,
1322     argc      => 2,
1323     signature => {
1324         desc     => 'Receives an array of one or more subscriptions and updates the database as needed',
1325         'params' => [ {
1326                  name => 'authtoken',
1327                  desc => 'Authtoken for current user session',
1328                  type => 'string'
1329             },
1330             {
1331                  name => 'subscriptions',
1332                  desc => 'Array of fleshed subscriptions',
1333                  type => 'array'
1334             }
1335
1336         ],
1337         'return' => {
1338             desc => 'Returns 1 if successful, event if failed',
1339             type => 'mixed'
1340         }
1341     }
1342 );
1343
1344 sub fleshed_ssub_alter {
1345     my( $self, $conn, $auth, $ssubs ) = @_;
1346     return 1 unless ref $ssubs;
1347     my( $reqr, $evt ) = $U->checkses($auth);
1348     return $evt if $evt;
1349     my $editor = new_editor(requestor => $reqr, xact => 1);
1350     my $override = $self->api_name =~ /override/;
1351
1352 # TODO: permission check
1353 #        return $editor->event unless
1354 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
1355
1356     for my $ssub (@$ssubs) {
1357
1358         my $ssubid = $ssub->id;
1359
1360         if( $ssub->isdeleted ) {
1361             $evt = _delete_ssub( $editor, $override, $ssub);
1362         } elsif( $ssub->isnew ) {
1363             _cleanse_dates($ssub, ['start_date','end_date']);
1364             $evt = _create_ssub( $editor, $ssub );
1365         } else {
1366             _cleanse_dates($ssub, ['start_date','end_date']);
1367             $evt = _update_ssub( $editor, $override, $ssub );
1368         }
1369     }
1370
1371     if( $evt ) {
1372         $logger->info("fleshed subscription-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
1373         $editor->rollback;
1374         return $evt;
1375     }
1376     $logger->debug("subscription-alter: done updating subscription batch");
1377     $editor->commit;
1378     $logger->info("fleshed subscription-alter successfully updated ".scalar(@$ssubs)." subscriptions");
1379     return 1;
1380 }
1381
1382 sub _delete_ssub {
1383     my ($editor, $override, $ssub) = @_;
1384     $logger->info("subscription-alter: delete subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1385     my $sdists = $editor->search_serial_distribution(
1386             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1387     my $cps = $editor->search_serial_caption_and_pattern(
1388             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1389     my $sisses = $editor->search_serial_issuance(
1390             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
1391     return OpenILS::Event->new(
1392             'SERIAL_SUBSCRIPTION_NOT_EMPTY', payload => $ssub->id ) if (@$sdists or @$cps or @$sisses);
1393
1394     return $editor->event unless $editor->delete_serial_subscription($ssub);
1395     return 0;
1396 }
1397
1398 sub _create_ssub {
1399     my ($editor, $ssub) = @_;
1400
1401     $logger->info("subscription-alter: new subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1402     return $editor->event unless $editor->create_serial_subscription($ssub);
1403     return 0;
1404 }
1405
1406 sub _update_ssub {
1407     my ($editor, $override, $ssub) = @_;
1408
1409     $logger->info("subscription-alter: retrieving subscription ".$ssub->id);
1410     my $orig_ssub = $editor->retrieve_serial_subscription($ssub->id);
1411
1412     $logger->info("subscription-alter: original subscription ".OpenSRF::Utils::JSON->perl2JSON($orig_ssub));
1413     $logger->info("subscription-alter: updated subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
1414     return $editor->event unless $editor->update_serial_subscription($ssub);
1415     return 0;
1416 }
1417
1418 __PACKAGE__->register_method(
1419     method  => "fleshed_serial_subscription_retrieve_batch",
1420     authoritative => 1,
1421     api_name    => "open-ils.serial.subscription.fleshed.batch.retrieve"
1422 );
1423
1424 sub fleshed_serial_subscription_retrieve_batch {
1425     my( $self, $client, $ids ) = @_;
1426 # FIXME: permissions?
1427     $logger->info("Fetching fleshed subscriptions @$ids");
1428     return $U->cstorereq(
1429         "open-ils.cstore.direct.serial.subscription.search.atomic",
1430         { id => $ids },
1431         { flesh => 1,
1432           flesh_fields => {ssub => [ qw/owning_lib notes/ ]}
1433         });
1434 }
1435
1436 __PACKAGE__->register_method(
1437         method  => "retrieve_sub_tree",
1438     authoritative => 1,
1439         api_name        => "open-ils.serial.subscription_tree.retrieve"
1440 );
1441
1442 __PACKAGE__->register_method(
1443         method  => "retrieve_sub_tree",
1444         api_name        => "open-ils.serial.subscription_tree.global.retrieve"
1445 );
1446
1447 sub retrieve_sub_tree {
1448
1449         my( $self, $client, $user_session, $docid, @org_ids ) = @_;
1450
1451         if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
1452
1453         $docid = "$docid";
1454
1455         # TODO: permission support
1456         if(!@org_ids and $user_session) {
1457                 my $user_obj =
1458                         OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
1459                         @org_ids = ($user_obj->home_ou);
1460         }
1461
1462         if( $self->api_name =~ /global/ ) {
1463                 return _build_subs_list( { record_entry => $docid } ); # TODO: filter for !deleted, or active?
1464
1465         } else {
1466
1467                 my @all_subs;
1468                 for my $orgid (@org_ids) {
1469                         my $subs = _build_subs_list(
1470                                         { record_entry => $docid, owning_lib => $orgid } );# TODO: filter for !deleted, or active?
1471                         push( @all_subs, @$subs );
1472                 }
1473
1474                 return \@all_subs;
1475         }
1476
1477         return undef;
1478 }
1479
1480 sub _build_subs_list {
1481         my $search_hash = shift;
1482
1483         #$search_hash->{deleted} = 'f';
1484         my $e = new_editor();
1485
1486         my $subs = $e->search_serial_subscription([$search_hash, { 'order_by' => {'ssub' => 'id'} }]);
1487
1488         my @built_subs;
1489
1490         for my $sub (@$subs) {
1491
1492         # TODO: filter on !deleted?
1493                 my $dists = $e->search_serial_distribution(
1494             [{ subscription => $sub->id }, { 'order_by' => {'sdist' => 'label'} }]
1495             );
1496
1497                 #$dists = [ sort { $a->label cmp $b->label } @$dists  ];
1498
1499                 $sub->distributions($dists);
1500
1501         # TODO: filter on !deleted?
1502                 my $issuances = $e->search_serial_issuance(
1503                         [{ subscription => $sub->id }, { 'order_by' => {'siss' => 'label'} }]
1504             );
1505
1506                 #$issuances = [ sort { $a->label cmp $b->label } @$issuances  ];
1507                 $sub->issuances($issuances);
1508
1509         # TODO: filter on !deleted?
1510                 my $scaps = $e->search_serial_caption_and_pattern(
1511                         [{ subscription => $sub->id }, { 'order_by' => {'scap' => 'id'} }]
1512             );
1513
1514                 #$scaps = [ sort { $a->id cmp $b->id } @$scaps  ];
1515                 $sub->scaps($scaps);
1516                 push( @built_subs, $sub );
1517         }
1518
1519         return \@built_subs;
1520
1521 }
1522
1523 __PACKAGE__->register_method(
1524     method  => "subscription_orgs_for_title",
1525     authoritative => 1,
1526     api_name    => "open-ils.serial.subscription.retrieve_orgs_by_title"
1527 );
1528
1529 sub subscription_orgs_for_title {
1530     my( $self, $client, $record_id ) = @_;
1531
1532     my $subs = $U->simple_scalar_request(
1533         "open-ils.cstore",
1534         "open-ils.cstore.direct.serial.subscription.search.atomic",
1535         { record_entry => $record_id }); # TODO: filter on !deleted?
1536
1537     my $orgs = { map {$_->owning_lib => 1 } @$subs };
1538     return [ keys %$orgs ];
1539 }
1540
1541
1542 ##########################################################################
1543 # distribution methods
1544 #
1545 __PACKAGE__->register_method(
1546     method    => 'fleshed_sdist_alter',
1547     api_name  => 'open-ils.serial.distribution.fleshed.batch.update',
1548     api_level => 1,
1549     argc      => 2,
1550     signature => {
1551         desc     => 'Receives an array of one or more distributions and updates the database as needed',
1552         'params' => [ {
1553                  name => 'authtoken',
1554                  desc => 'Authtoken for current user session',
1555                  type => 'string'
1556             },
1557             {
1558                  name => 'distributions',
1559                  desc => 'Array of fleshed distributions',
1560                  type => 'array'
1561             }
1562
1563         ],
1564         'return' => {
1565             desc => 'Returns 1 if successful, event if failed',
1566             type => 'mixed'
1567         }
1568     }
1569 );
1570
1571 sub fleshed_sdist_alter {
1572     my( $self, $conn, $auth, $sdists ) = @_;
1573     return 1 unless ref $sdists;
1574     my( $reqr, $evt ) = $U->checkses($auth);
1575     return $evt if $evt;
1576     my $editor = new_editor(requestor => $reqr, xact => 1);
1577     my $override = $self->api_name =~ /override/;
1578
1579 # TODO: permission check
1580 #        return $editor->event unless
1581 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
1582
1583     for my $sdist (@$sdists) {
1584         my $sdistid = $sdist->id;
1585
1586         if( $sdist->isdeleted ) {
1587             $evt = _delete_sdist( $editor, $override, $sdist);
1588         } elsif( $sdist->isnew ) {
1589             $evt = _create_sdist( $editor, $sdist );
1590         } else {
1591             $evt = _update_sdist( $editor, $override, $sdist );
1592         }
1593     }
1594
1595     if( $evt ) {
1596         $logger->info("fleshed distribution-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
1597         $editor->rollback;
1598         return $evt;
1599     }
1600     $logger->debug("distribution-alter: done updating distribution batch");
1601     $editor->commit;
1602     $logger->info("fleshed distribution-alter successfully updated ".scalar(@$sdists)." distributions");
1603     return 1;
1604 }
1605
1606 sub _delete_sdist {
1607     my ($editor, $override, $sdist) = @_;
1608     $logger->info("distribution-alter: delete distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1609     return $editor->event unless $editor->delete_serial_distribution($sdist);
1610     return 0;
1611 }
1612
1613 sub _create_sdist {
1614     my ($editor, $sdist) = @_;
1615
1616     $logger->info("distribution-alter: new distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1617     return $editor->event unless $editor->create_serial_distribution($sdist);
1618
1619     # create summaries too
1620     my $summary = new Fieldmapper::serial::basic_summary;
1621     $summary->distribution($sdist->id);
1622     $summary->generated_coverage('');
1623     return $editor->event unless $editor->create_serial_basic_summary($summary);
1624     $summary = new Fieldmapper::serial::supplement_summary;
1625     $summary->distribution($sdist->id);
1626     $summary->generated_coverage('');
1627     return $editor->event unless $editor->create_serial_supplement_summary($summary);
1628     $summary = new Fieldmapper::serial::index_summary;
1629     $summary->distribution($sdist->id);
1630     $summary->generated_coverage('');
1631     return $editor->event unless $editor->create_serial_index_summary($summary);
1632
1633     # create a starter stream (TODO: reconsider this)
1634     my $stream = new Fieldmapper::serial::stream;
1635     $stream->distribution($sdist->id);
1636     return $editor->event unless $editor->create_serial_stream($stream);
1637
1638     return 0;
1639 }
1640
1641 sub _update_sdist {
1642     my ($editor, $override, $sdist) = @_;
1643
1644     $logger->info("distribution-alter: retrieving distribution ".$sdist->id);
1645     my $orig_sdist = $editor->retrieve_serial_distribution($sdist->id);
1646
1647     $logger->info("distribution-alter: original distribution ".OpenSRF::Utils::JSON->perl2JSON($orig_sdist));
1648     $logger->info("distribution-alter: updated distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
1649     return $editor->event unless $editor->update_serial_distribution($sdist);
1650     return 0;
1651 }
1652
1653 __PACKAGE__->register_method(
1654     method  => "fleshed_serial_distribution_retrieve_batch",
1655     authoritative => 1,
1656     api_name    => "open-ils.serial.distribution.fleshed.batch.retrieve"
1657 );
1658
1659 sub fleshed_serial_distribution_retrieve_batch {
1660     my( $self, $client, $ids ) = @_;
1661 # FIXME: permissions?
1662     $logger->info("Fetching fleshed distributions @$ids");
1663     return $U->cstorereq(
1664         "open-ils.cstore.direct.serial.distribution.search.atomic",
1665         { id => $ids },
1666         { flesh => 1,
1667           flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams / ]}
1668         });
1669 }
1670
1671 ##########################################################################
1672 # caption and pattern methods
1673 #
1674 __PACKAGE__->register_method(
1675     method    => 'scap_alter',
1676     api_name  => 'open-ils.serial.caption_and_pattern.batch.update',
1677     api_level => 1,
1678     argc      => 2,
1679     signature => {
1680         desc     => 'Receives an array of one or more caption and patterns and updates the database as needed',
1681         'params' => [ {
1682                  name => 'authtoken',
1683                  desc => 'Authtoken for current user session',
1684                  type => 'string'
1685             },
1686             {
1687                  name => 'scaps',
1688                  desc => 'Array of caption and patterns',
1689                  type => 'array'
1690             }
1691
1692         ],
1693         'return' => {
1694             desc => 'Returns 1 if successful, event if failed',
1695             type => 'mixed'
1696         }
1697     }
1698 );
1699
1700 sub scap_alter {
1701     my( $self, $conn, $auth, $scaps ) = @_;
1702     return 1 unless ref $scaps;
1703     my( $reqr, $evt ) = $U->checkses($auth);
1704     return $evt if $evt;
1705     my $editor = new_editor(requestor => $reqr, xact => 1);
1706     my $override = $self->api_name =~ /override/;
1707
1708 # TODO: permission check
1709 #        return $editor->event unless
1710 #            $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
1711
1712     for my $scap (@$scaps) {
1713         my $scapid = $scap->id;
1714
1715         if( $scap->isdeleted ) {
1716             $evt = _delete_scap( $editor, $override, $scap);
1717         } elsif( $scap->isnew ) {
1718             $evt = _create_scap( $editor, $scap );
1719         } else {
1720             $evt = _update_scap( $editor, $override, $scap );
1721         }
1722     }
1723
1724     if( $evt ) {
1725         $logger->info("caption_and_pattern-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
1726         $editor->rollback;
1727         return $evt;
1728     }
1729     $logger->debug("caption_and_pattern-alter: done updating caption_and_pattern batch");
1730     $editor->commit;
1731     $logger->info("caption_and_pattern-alter successfully updated ".scalar(@$scaps)." caption_and_patterns");
1732     return 1;
1733 }
1734
1735 sub _delete_scap {
1736     my ($editor, $override, $scap) = @_;
1737     $logger->info("caption_and_pattern-alter: delete caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
1738     my $sisses = $editor->search_serial_issuance(
1739             { caption_and_pattern => $scap->id }, { limit => 1 } ); #TODO: 'deleted' support?
1740     return OpenILS::Event->new(
1741             'SERIAL_CAPTION_AND_PATTERN_HAS_ISSUANCES', payload => $scap->id ) if (@$sisses);
1742
1743     return $editor->event unless $editor->delete_serial_caption_and_pattern($scap);
1744     return 0;
1745 }
1746
1747 sub _create_scap {
1748     my ($editor, $scap) = @_;
1749
1750     $logger->info("caption_and_pattern-alter: new caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
1751     return $editor->event unless $editor->create_serial_caption_and_pattern($scap);
1752     return 0;
1753 }
1754
1755 sub _update_scap {
1756     my ($editor, $override, $scap) = @_;
1757
1758     $logger->info("caption_and_pattern-alter: retrieving caption_and_pattern ".$scap->id);
1759     my $orig_scap = $editor->retrieve_serial_caption_and_pattern($scap->id);
1760
1761     $logger->info("caption_and_pattern-alter: original caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($orig_scap));
1762     $logger->info("caption_and_pattern-alter: updated caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
1763     return $editor->event unless $editor->update_serial_caption_and_pattern($scap);
1764     return 0;
1765 }
1766
1767 __PACKAGE__->register_method(
1768     method  => "serial_caption_and_pattern_retrieve_batch",
1769     authoritative => 1,
1770     api_name    => "open-ils.serial.caption_and_pattern.batch.retrieve"
1771 );
1772
1773 sub serial_caption_and_pattern_retrieve_batch {
1774     my( $self, $client, $ids ) = @_;
1775     $logger->info("Fetching caption_and_patterns @$ids");
1776     return $U->cstorereq(
1777         "open-ils.cstore.direct.serial.caption_and_pattern.search.atomic",
1778         { id => $ids }
1779     );
1780 }
1781
1782 __PACKAGE__->register_method(
1783     "method" => "bre_by_identifier",
1784     "api_name" => "open-ils.serial.biblio.record_entry.by_identifier",
1785     "stream" => 1,
1786     "signature" => {
1787         "desc" => "Find instances of biblio.record_entry given a search token" .
1788             " that could be a value for any identifier defined in " .
1789             "config.metabib_field",
1790         "params" => [
1791             {"desc" => "Search token", "type" => "string"},
1792             {"desc" => "Options: require_subscriptions, add_mvr, is_actual_id" .
1793                 " (all boolean)", "type" => "object"}
1794         ],
1795         "return" => {
1796             "desc" => "Any matching BREs, or if the add_mvr option is true, " .
1797                 "objects with a 'bre' key/value pair, and an 'mvr' " .
1798                 "key-value pair.  BREs have subscriptions fleshed on.",
1799             "type" => "object"
1800         }
1801     }
1802 );
1803
1804 sub bre_by_identifier {
1805     my ($self, $client, $term, $options) = @_;
1806
1807     return new OpenILS::Event("BAD_PARAMS") unless $term;
1808
1809     $options ||= {};
1810     my $e = new_editor();
1811
1812     my @ids;
1813
1814     if ($options->{"is_actual_id"}) {
1815         @ids = ($term);
1816     } else {
1817         my $cmf =
1818             $e->search_config_metabib_field({"field_class" => "identifier"})
1819                 or return $e->die_event;
1820
1821         my @identifiers = map { $_->name } @$cmf;
1822         my $query = join(" || ", map { "id|$_: $term" } @identifiers);
1823
1824         my $search = create OpenSRF::AppSession("open-ils.search");
1825         my $search_result = $search->request(
1826             "open-ils.search.biblio.multiclass.query.staff", {}, $query
1827         )->gather(1);
1828         $search->disconnect;
1829
1830         # Un-nest results. They tend to look like [[1],[2],[3]] for some reason.
1831         @ids = map { @{$_} } @{$search_result->{"ids"}};
1832
1833         unless (@ids) {
1834             $e->disconnect;
1835             return undef;
1836         }
1837     }
1838
1839     my $bre = $e->search_biblio_record_entry([
1840         {"id" => \@ids}, {
1841             "flesh" => 2, "flesh_fields" => {
1842                 "bre" => ["subscriptions"],
1843                 "ssub" => ["owning_lib"]
1844             }
1845         }
1846     ]) or return $e->die_event;
1847
1848     if (@$bre && $options->{"require_subscriptions"}) {
1849         $bre = [ grep { @{$_->subscriptions} } @$bre ];
1850     }
1851
1852     $e->disconnect;
1853
1854     if (@$bre) { # re-evaluate after possible grep
1855         if ($options->{"add_mvr"}) {
1856             $client->respond(
1857                 {"bre" => $_, "mvr" => _get_mvr($_->id)}
1858             ) foreach (@$bre);
1859         } else {
1860             $client->respond($_) foreach (@$bre);
1861         }
1862     }
1863
1864     undef;
1865 }
1866
1867 __PACKAGE__->register_method(
1868     "method" => "get_receivable_items",
1869     "api_name" => "open-ils.serial.items.receivable.by_subscription",
1870     "stream" => 1,
1871     "signature" => {
1872         "desc" => "Return all receivable items under a given subscription",
1873         "params" => [
1874             {"desc" => "Authtoken", "type" => "string"},
1875             {"desc" => "Subscription ID", "type" => "number"},
1876         ],
1877         "return" => {
1878             "desc" => "All receivable items under a given subscription",
1879             "type" => "object"
1880         }
1881     }
1882 );
1883
1884 __PACKAGE__->register_method(
1885     "method" => "get_receivable_items",
1886     "api_name" => "open-ils.serial.items.receivable.by_issuance",
1887     "stream" => 1,
1888     "signature" => {
1889         "desc" => "Return all receivable items under a given issuance",
1890         "params" => [
1891             {"desc" => "Authtoken", "type" => "string"},
1892             {"desc" => "Issuance ID", "type" => "number"},
1893         ],
1894         "return" => {
1895             "desc" => "All receivable items under a given issuance",
1896             "type" => "object"
1897         }
1898     }
1899 );
1900
1901 sub get_receivable_items {
1902     my ($self, $client, $auth, $term)  = @_;
1903
1904     my $e = new_editor("authtoken" => $auth);
1905     return $e->die_event unless $e->checkauth;
1906
1907     # XXX permissions
1908
1909     my $by = ($self->api_name =~ /by_(\w+)$/)[0];
1910
1911     my %where = (
1912         "issuance" => {"issuance" => $term},
1913         "subscription" => {"+siss" => {"subscription" => $term}}
1914     );
1915
1916     my $item_ids = $e->json_query(
1917         {
1918             "select" => {"sitem" => ["id"]},
1919             "from" => {"sitem" => "siss"},
1920             "where" => {
1921                 %{$where{$by}}, "date_received" => undef
1922             },
1923             "order_by" => {"sitem" => ["id"]}
1924         }
1925     ) or return $e->die_event;
1926
1927     return undef unless @$item_ids;
1928
1929     foreach (map { $_->{"id"} } @$item_ids) {
1930         $client->respond(
1931             $e->retrieve_serial_item([
1932                 $_, {
1933                     "flesh" => 3,
1934                     "flesh_fields" => {
1935                         "sitem" => ["stream", "issuance"],
1936                         "sstr" => ["distribution"],
1937                         "sdist" => ["holding_lib"]
1938                     }
1939                 }
1940             ])
1941         );
1942     }
1943
1944     $e->disconnect;
1945     undef;
1946 }
1947
1948 __PACKAGE__->register_method(
1949     "method" => "get_receivable_issuances",
1950     "api_name" => "open-ils.serial.issuances.receivable",
1951     "stream" => 1,
1952     "signature" => {
1953         "desc" => "Return all issuances with receivable items given " .
1954             "a subscription ID",
1955         "params" => [
1956             {"desc" => "Authtoken", "type" => "string"},
1957             {"desc" => "Subscription ID", "type" => "number"},
1958         ],
1959         "return" => {
1960             "desc" => "All issuances with receivable items " .
1961                 "(but not the items themselves)", "type" => "object"
1962         }
1963     }
1964 );
1965
1966 sub get_receivable_issuances {
1967     my ($self, $client, $auth, $sub_id) = @_;
1968
1969     my $e = new_editor("authtoken" => $auth);
1970     return $e->die_event unless $e->checkauth;
1971
1972     # XXX permissions
1973
1974     my $issuance_ids = $e->json_query({
1975         "select" => {
1976             "siss" => [
1977                 {"transform" => "distinct", "column" => "id"},
1978                 "date_published"
1979             ]
1980         },
1981         "from" => {"siss" => "sitem"},
1982         "where" => {
1983             "subscription" => $sub_id,
1984             "+sitem" => {"date_received" => undef}
1985         },
1986         "order_by" => {
1987             "siss" => {"date_published" => {"direction" => "asc"}}
1988         }
1989
1990     }) or return $e->die_event;
1991
1992     $client->respond($e->retrieve_serial_issuance($_->{"id"}))
1993         foreach (@$issuance_ids);
1994
1995     $e->disconnect;
1996     undef;
1997 }
1998
1999 __PACKAGE__->register_method(
2000     "method" => "receive_items_by_id",
2001     "api_name" => "open-ils.serial.items.receive_by_id",
2002     "stream" => 1,
2003     "signature" => {
2004         "desc" => "Given sitem IDs, just set their date_received to now()",
2005         "params" => [
2006             {"desc" => "Authtoken", "type" => "string"},
2007             {"desc" => "Serial Item IDs", "type" => "array"},
2008         ],
2009         "return" => {
2010             "desc" => "Stream of updated items", "type" => "object"
2011         }
2012     }
2013 );
2014
2015 sub receive_items_by_id {
2016     my ($self, $client, $auth, $id_list) = @_;
2017
2018     my $e = new_editor("authtoken" => $auth, "xact" => 1);
2019     return $e->die_event unless $e->checkauth;
2020
2021     # XXX permissions
2022
2023     # for now this function doesn't do nearly enough. simply sets
2024     # date_received to now()
2025
2026     my @results = ();
2027     foreach (@$id_list) {
2028         my $sitem = $e->retrieve_serial_item($_) or return $e->die_event;
2029
2030         $sitem->date_received("now");
2031         $e->update_serial_item($sitem) or return $e->die_event;
2032
2033         push @results, $sitem;
2034     }
2035
2036     $e->commit;
2037     $client->respond($_) foreach @results;
2038     undef;
2039 }
2040
2041 1;