Open-ILS/src/perlmods/lib/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 DateTime::Format::ISO8601;
  52 use MARC::File::XML (BinaryEncoding => 'utf8');
  53
  54 use OpenILS::Application::Serial::OPAC;
  55
  56 my $U = 'OpenILS::Application::AppUtils';
  57 my @MFHD_NAMES = ('basic','supplement','index');
  58 my %MFHD_NAMES_BY_TAG = (  '853' => $MFHD_NAMES[0],
  59                         '863' => $MFHD_NAMES[0],
  60                         '854' => $MFHD_NAMES[1],
  61                         '864' => $MFHD_NAMES[1],
  62                         '855' => $MFHD_NAMES[2],
  63                         '865' => $MFHD_NAMES[2] );
  64 my %MFHD_TAGS_BY_NAME = (  $MFHD_NAMES[0] => '853',
  65                         $MFHD_NAMES[1] => '854',
  66                         $MFHD_NAMES[2] => '855');
  67 my $_strp_date = new DateTime::Format::Strptime(pattern => '%F');
  68 my %FM_NAME_TO_ID = (
  69     'subscription' => 'ssub',
  70     'distribution' => 'sdist',
  71     'item' => 'sitem'
  72     );
  73
  74 # helper method for conforming dates to ISO8601
  75 sub _cleanse_dates {
  76     my $item = shift;
  77     my $fields = shift;
  78
  79     foreach my $field (@$fields) {
  80         $item->$field(OpenSRF::Utils::clense_ISO8601($item->$field)) if $item->$field;
  81     }
  82     return 0;
  83 }
  84
  85 sub _get_mvr {
  86     $U->simplereq(
  87         "open-ils.search",
  88         "open-ils.search.biblio.record.mods_slim.retrieve",
  89         @_
  90     );
  91 }
  92
  93
  94 ##########################################################################
  95 # item methods
  96 #
  97 __PACKAGE__->register_method(
  98     method    => "create_item_safely",
  99     api_name  => "open-ils.serial.item.create",
 100     api_level => 1,
 101     stream    => 1,
 102     argc      => 3,
 103     signature => {
 104         desc => q/Creates any number of items, respecting only a few of the
 105         submitted fields, as the user shouldn't be able to freely set certain
 106         ones/,
 107         params => [
 108             {name=> "authtoken", desc => "Authtoken for current user session",
 109                 type => "string"},
 110             {name => "item", desc => "serial item",
 111                 type => "object", class => "sitem"},
 112             {name => "count",
 113                 desc => "optional: how many items to make " .
 114                     "(default 1; 1-100 permitted)",
 115                 type => "number"}
 116         ],
 117         return => {
 118             desc => "created items (a stream of them)",
 119             type => "object", class => "sitem"
 120         }
 121     }
 122 );
 123 __PACKAGE__->register_method(
 124     method    => "update_item_safely",
 125     api_name  => "open-ils.serial.item.update",
 126     api_level => 1,
 127     stream    => 1,
 128     argc      => 2,
 129     signature => {
 130         desc => q/Edit a serial item, respecting only a few of the
 131         submitted fields, as the user shouldn't be able to freely set certain
 132         ones/,
 133         params => [
 134             {name=> "authtoken", desc => "Authtoken for current user session",
 135                 type => "string"},
 136             {name => "item", desc => "serial item",
 137                 type => "object", class => "sitem"},
 138         ],
 139         return => {
 140             desc => "created item", type => "object", class => "sitem"
 141         }
 142     }
 143 );
 144
 145 sub _set_safe_item_fields {
 146     my $dest = shift;
 147     my $source = shift;
 148     my $requestor_id = shift;
 149     # extra fields remain in @_
 150
 151     $dest->edit_date("now");
 152     $dest->editor($requestor_id);
 153
 154     my @fields = qw/date_expected date_received status/;
 155
 156     for my $field (@fields, @_) {
 157         $dest->$field($source->$field);
 158     }
 159 }
 160
 161 sub update_item_safely {
 162     my ($self, $client, $auth, $item) = @_;
 163
 164     my $e = new_editor("xact" => 1, "authtoken" => $auth);
 165     $e->checkauth or return $e->die_event;
 166
 167     my $orig = $e->retrieve_serial_item([
 168         $item->id, {
 169             "flesh" => 2, "flesh_fields" => {
 170                 "sitem" => ["stream"], "sstr" => ["distribution"]
 171             }
 172         }
 173     ]) or return $e->die_event;
 174
 175     return $e->die_event unless $e->allowed(
 176         "ADMIN_SERIAL_ITEM", $orig->stream->distribution->holding_lib
 177     );
 178
 179     _set_safe_item_fields($orig, $item, $e->requestor->id);
 180     $e->update_serial_item($orig) or return $e->die_event;
 181
 182     $client->respond($e->retrieve_serial_item($item->id));
 183     $e->commit or return $e->die_event;
 184     undef;
 185 }
 186
 187 sub create_item_safely {
 188     my ($self, $client, $auth, $item, $count) = @_;
 189
 190     $count = int $count;
 191     $count ||= 1;
 192     return new OpenILS::Event(
 193         "BAD_PARAMS", note => "Count should be from 1 to 100"
 194     ) unless $count >= 1 and $count <= 100;
 195
 196     my $e = new_editor("xact" => 1, "authtoken" => $auth);
 197     $e->checkauth or return $e->die_event;
 198
 199     my $stream = $e->retrieve_serial_stream([
 200         $item->stream, {
 201             "flesh" => 1, "flesh_fields" => {"sstr" => ["distribution"]}
 202         }
 203     ]) or return $e->die_event;
 204
 205     return $e->die_event unless $e->allowed(
 206         "ADMIN_SERIAL_ITEM", $stream->distribution->holding_lib
 207     );
 208
 209     for (my $i = 0; $i < $count; $i++) {
 210         my $actual = new Fieldmapper::serial::item;
 211         $actual->creator($e->requestor->id);
 212         _set_safe_item_fields(
 213             $actual, $item, $e->requestor->id, "issuance", "stream"
 214         );
 215
 216         $e->create_serial_item($actual) or return $e->die_event;
 217         $client->respond($e->data);
 218     }
 219
 220     $e->commit or return $e->die_event;
 221     undef;
 222 }
 223
 224 __PACKAGE__->register_method(
 225     method    => 'fleshed_item_alter',
 226     api_name  => 'open-ils.serial.item.fleshed.batch.update',
 227     api_level => 1,
 228     argc      => 2,
 229     signature => {
 230         desc     => 'Receives an array of one or more items and updates the database as needed',
 231         'params' => [ {
 232                  name => 'authtoken',
 233                  desc => 'Authtoken for current user session',
 234                  type => 'string'
 235             },
 236             {
 237                  name => 'items',
 238                  desc => 'Array of fleshed items',
 239                  type => 'array'
 240             }
 241
 242         ],
 243         'return' => {
 244             desc => 'Returns 1 if successful, event if failed',
 245             type => 'mixed'
 246         }
 247     }
 248 );
 249
 250 sub fleshed_item_alter {
 251     my( $self, $conn, $auth, $items ) = @_;
 252     return 1 unless ref $items;
 253     my( $reqr, $evt ) = $U->checkses($auth);
 254     return $evt if $evt;
 255     my $editor = new_editor(requestor => $reqr, xact => 1);
 256     my $override = $self->api_name =~ /override/;
 257
 258     my %found_sdist_ids;
 259     my %found_sstr_ids;
 260     for my $item (@$items) {
 261         my $sstr_id = ref $item->stream ? $item->stream->id : $item->stream;
 262         if (!exists($found_sstr_ids{$sstr_id})) {
 263             my $sstr;
 264             if (ref $item->stream) {
 265                 $sstr = $item->stream;
 266             } else {
 267                 $sstr = $editor->retrieve_serial_stream($item->stream) or return $editor->die_event;
 268             }
 269             if (!exists($found_sdist_ids{$sstr->distribution})) {
 270                 my $sdist = $editor->retrieve_serial_distribution($sstr->distribution) or return $editor->die_event;
 271                 return $editor->die_event unless
 272                     $editor->allowed("ADMIN_SERIAL_STREAM", $sdist->holding_lib);
 273                 $found_sdist_ids{$sstr->distribution} = 1;
 274             }
 275             $found_sstr_ids{$sstr_id} = 1;
 276         }
 277
 278         $item->editor($editor->requestor->id);
 279         $item->edit_date('now');
 280
 281         if( $item->isdeleted ) {
 282             $evt = _delete_sitem( $editor, $override, $item);
 283         } elsif( $item->isnew ) {
 284             # TODO: reconsider this
 285             # if the item has a new issuance, create the issuance first
 286             if (ref $item->issuance eq 'Fieldmapper::serial::issuance' and $item->issuance->isnew) {
 287                 fleshed_issuance_alter($self, $conn, $auth, [$item->issuance]);
 288             }
 289             _cleanse_dates($item, ['date_expected','date_received']);
 290             $evt = _create_sitem( $editor, $item );
 291         } else {
 292             _cleanse_dates($item, ['date_expected','date_received']);
 293             $evt = _update_sitem( $editor, $override, $item );
 294         }
 295     }
 296
 297     if( $evt ) {
 298         $logger->info("fleshed item-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
 299         $editor->rollback;
 300         return $evt;
 301     }
 302     $logger->debug("item-alter: done updating item batch");
 303     $editor->commit;
 304     $logger->info("fleshed item-alter successfully updated ".scalar(@$items)." items");
 305     return 1;
 306 }
 307
 308 sub _delete_sitem {
 309     my ($editor, $override, $item) = @_;
 310     $logger->info("item-alter: delete item ".OpenSRF::Utils::JSON->perl2JSON($item));
 311     return $editor->event unless $editor->delete_serial_item($item);
 312     return 0;
 313 }
 314
 315 sub _create_sitem {
 316     my ($editor, $item) = @_;
 317
 318     $item->creator($editor->requestor->id);
 319     $item->create_date('now');
 320
 321     $logger->info("item-alter: new item ".OpenSRF::Utils::JSON->perl2JSON($item));
 322     return $editor->event unless $editor->create_serial_item($item);
 323     return 0;
 324 }
 325
 326 sub _update_sitem {
 327     my ($editor, $override, $item) = @_;
 328
 329     $logger->info("item-alter: retrieving item ".$item->id);
 330     my $orig_item = $editor->retrieve_serial_item($item->id);
 331
 332     $logger->info("item-alter: original item ".OpenSRF::Utils::JSON->perl2JSON($orig_item));
 333     $logger->info("item-alter: updated item ".OpenSRF::Utils::JSON->perl2JSON($item));
 334     return $editor->event unless $editor->update_serial_item($item);
 335     return 0;
 336 }
 337
 338 __PACKAGE__->register_method(
 339     method  => "fleshed_serial_item_retrieve_batch",
 340     authoritative => 1,
 341     api_name    => "open-ils.serial.item.fleshed.batch.retrieve"
 342 );
 343
 344 sub fleshed_serial_item_retrieve_batch {
 345     my( $self, $client, $ids ) = @_;
 346 # FIXME: permissions?
 347     $logger->info("Fetching fleshed serial items @$ids");
 348     return $U->cstorereq(
 349         "open-ils.cstore.direct.serial.item.search.atomic",
 350         { id => $ids },
 351         { flesh => 2,
 352           flesh_fields => {sitem => [ qw/issuance creator editor stream unit notes/ ], sunit => ["call_number"], siss => [qw/creator editor subscription/]}
 353         });
 354 }
 355
 356
 357 ##########################################################################
 358 # issuance methods
 359 #
 360 __PACKAGE__->register_method(
 361     method    => 'fleshed_issuance_alter',
 362     api_name  => 'open-ils.serial.issuance.fleshed.batch.update',
 363     api_level => 1,
 364     argc      => 2,
 365     signature => {
 366         desc     => 'Receives an array of one or more issuances and updates the database as needed',
 367         'params' => [ {
 368                  name => 'authtoken',
 369                  desc => 'Authtoken for current user session',
 370                  type => 'string'
 371             },
 372             {
 373                  name => 'issuances',
 374                  desc => 'Array of fleshed issuances',
 375                  type => 'array'
 376             }
 377
 378         ],
 379         'return' => {
 380             desc => 'Returns 1 if successful, event if failed',
 381             type => 'mixed'
 382         }
 383     }
 384 );
 385
 386 sub fleshed_issuance_alter {
 387     my( $self, $conn, $auth, $issuances ) = @_;
 388     return 1 unless ref $issuances;
 389     my( $reqr, $evt ) = $U->checkses($auth);
 390     return $evt if $evt;
 391     my $editor = new_editor(requestor => $reqr, xact => 1);
 392     my $override = $self->api_name =~ /override/;
 393
 394     my %found_ssub_ids;
 395     for my $issuance (@$issuances) {
 396         my $ssub_id = ref $issuance->subscription ? $issuance->subscription->id : $issuance->subscription;
 397         if (!exists($found_ssub_ids{$ssub_id})) {
 398             my $owning_lib_id;
 399             if (ref $issuance->subscription) {
 400                 $owning_lib_id = $issuance->subscription->owning_lib;
 401             } else {
 402                 my $ssub = $editor->retrieve_serial_subscription($issuance->subscription) or return $editor->die_event;
 403                 $owning_lib_id = $ssub->owning_lib;
 404             }
 405             return $editor->die_event unless
 406                 $editor->allowed("ADMIN_SERIAL_SUBSCRIPTION", $owning_lib_id);
 407             $found_ssub_ids{$ssub_id} = 1;
 408         }
 409
 410         my $issuanceid = $issuance->id;
 411         $issuance->editor($editor->requestor->id);
 412         $issuance->edit_date('now');
 413
 414         if( $issuance->isdeleted ) {
 415             $evt = _delete_siss( $editor, $override, $issuance);
 416         } elsif( $issuance->isnew ) {
 417             _cleanse_dates($issuance, ['date_published']);
 418             $evt = _create_siss( $editor, $issuance );
 419         } else {
 420             _cleanse_dates($issuance, ['date_published']);
 421             $evt = _update_siss( $editor, $override, $issuance );
 422         }
 423     }
 424
 425     if( $evt ) {
 426         $logger->info("fleshed issuance-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
 427         $editor->rollback;
 428         return $evt;
 429     }
 430     $logger->debug("issuance-alter: done updating issuance batch");
 431     $editor->commit;
 432     $logger->info("fleshed issuance-alter successfully updated ".scalar(@$issuances)." issuances");
 433     return 1;
 434 }
 435
 436 sub _delete_siss {
 437     my ($editor, $override, $issuance) = @_;
 438     $logger->info("issuance-alter: delete issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
 439     return $editor->event unless $editor->delete_serial_issuance($issuance);
 440     return 0;
 441 }
 442
 443 sub _create_siss {
 444     my ($editor, $issuance) = @_;
 445
 446     $issuance->creator($editor->requestor->id);
 447     $issuance->create_date('now');
 448
 449     $logger->info("issuance-alter: new issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
 450     return $editor->event unless $editor->create_serial_issuance($issuance);
 451     return 0;
 452 }
 453
 454 sub _update_siss {
 455     my ($editor, $override, $issuance) = @_;
 456
 457     $logger->info("issuance-alter: retrieving issuance ".$issuance->id);
 458     my $orig_issuance = $editor->retrieve_serial_issuance($issuance->id);
 459
 460     $logger->info("issuance-alter: original issuance ".OpenSRF::Utils::JSON->perl2JSON($orig_issuance));
 461     $logger->info("issuance-alter: updated issuance ".OpenSRF::Utils::JSON->perl2JSON($issuance));
 462     return $editor->event unless $editor->update_serial_issuance($issuance);
 463     return 0;
 464 }
 465
 466 __PACKAGE__->register_method(
 467     method  => "fleshed_serial_issuance_retrieve_batch",
 468     authoritative => 1,
 469     api_name    => "open-ils.serial.issuance.fleshed.batch.retrieve"
 470 );
 471
 472 sub fleshed_serial_issuance_retrieve_batch {
 473     my( $self, $client, $ids ) = @_;
 474 # FIXME: permissions?
 475     $logger->info("Fetching fleshed serial issuances @$ids");
 476     return $U->cstorereq(
 477         "open-ils.cstore.direct.serial.issuance.search.atomic",
 478         { id => $ids },
 479         { flesh => 1,
 480           flesh_fields => {siss => [ qw/creator editor subscription/ ]}
 481         });
 482 }
 483
 484 __PACKAGE__->register_method(
 485     method  => "pub_fleshed_serial_issuance_retrieve_batch",
 486     api_name    => "open-ils.serial.issuance.pub_fleshed.batch.retrieve",
 487     signature => {
 488         desc => q/
 489             Public (i.e. OPAC) call for getting at the sub and
 490             ultimately the record entry from an issuance
 491         /,
 492         params => [{name => 'ids', desc => 'Array of IDs', type => 'array'}],
 493         return => {
 494             desc => q/
 495                 issuance objects, fleshed with subscriptions
 496             /,
 497             class => 'siss'
 498         }
 499     }
 500 );
 501 sub pub_fleshed_serial_issuance_retrieve_batch {
 502     my( $self, $client, $ids ) = @_;
 503     return [] unless $ids and @$ids;
 504     return new_editor()->search_serial_issuance([
 505         { id => $ids },
 506         {
 507             flesh => 1,
 508             flesh_fields => {siss => [ qw/subscription/ ]}
 509         }
 510     ]);
 511 }
 512
 513 sub received_siss_by_bib {
 514     # XXX this is somewhat wrong in implementation and should not be used in
 515     # new places - senator
 516     my $self = shift;
 517     my $client = shift;
 518     my $bib = shift;
 519
 520     my $args = shift || {};
 521     $$args{order} ||= 'asc';
 522
 523     my $global = $$args{global} == 0 ? 0 : 1;
 524
 525     my $e = new_editor();
 526     my $issuances = $e->json_query({
 527         select  => {
 528             siss => [
 529                 $global ? { transform => "min", column => "id", aggregate => 1 } : "id",
 530                 "label",
 531                 "date_published"
 532             ],
 533             "sitem" => [
 534                 # We're not really interested in the minimum here.  This is
 535                 # just a way to distinguish issuances whose items have units
 536                 # from issuances whose items have no units, without altogether
 537                 # excluding the latter type of issuances.
 538                 {"transform" => "min", "alias" => "has_units",
 539                     "column" => "unit", "aggregate" => 1}
 540             ]
 541         },
 542         from => {
 543             ssub => {
 544                 siss => {
 545                     field => 'subscription',
 546                     fkey  => 'id',
 547                     join  => {
 548                         sitem => {
 549                             field  => 'issuance',
 550                             fkey   => 'id',
 551                             $$args{ou} ? ( join  => {
 552                                 sstr => {
 553                                     field => 'id',
 554                                     fkey  => 'stream',
 555                                     join  => {
 556                                         sdist => {
 557                                             field  => 'id',
 558                                             fkey   => 'distribution'
 559                                         }
 560                                     }
 561                                 }
 562                             }) : ()
 563                         }
 564                     }
 565                 }
 566             }
 567         },
 568         where => {
 569             '+ssub'  => { record_entry => $bib },
 570             $$args{type} ? ( '+siss' => { 'holding_type' => $$args{type} } ) : (),
 571             '+sitem' => {
 572                 # XXX should we also take specific item statuses into account?
 573                 date_received => { '!=' => undef },
 574                 $$args{status} ? ( 'status' => $$args{status} ) : ()
 575             },
 576             $$args{ou} ? ( '+sdist' => {
 577                 holding_lib => {
 578                     'in' => $U->get_org_descendants($$args{ou}, $$args{depth})
 579                 }
 580             }) : ()
 581         },
 582         $$args{limit}  ? ( limit  => $$args{limit}  ) : (),
 583         $$args{offset} ? ( offset => $$args{offset} ) : (),
 584         order_by => [{ class => 'siss', field => 'date_published', direction => $$args{order} }],
 585         distinct => 1
 586     });
 587
 588     $client->respond({
 589         "issuance" => $e->retrieve_serial_issuance($_->{"id"}),
 590         "has_units" => $_->{"has_units"} ? 1 : 0
 591     }) for @$issuances;
 592
 593     return undef;
 594 }
 595 __PACKAGE__->register_method(
 596     method    => 'received_siss_by_bib',
 597     api_name  => 'open-ils.serial.received_siss.retrieve.by_bib',
 598     api_level => 1,
 599     argc      => 1,
 600     stream    => 1,
 601     signature => {
 602         desc   => 'Receives a Bib ID and other optional params and returns "siss" (issuance) objects',
 603         params => [
 604             {   name => 'bibid',
 605                 desc => 'id of the bre to which the issuances belong',
 606                 type => 'number'
 607             },
 608             {   name => 'args',
 609                 desc =>
 610 q/A hash of optional arguments.  Valid keys and their meanings:
 611     global := If true, return only one representative version of a conceptual issuance regardless of the number of subscriptions, otherwise return all issuance objects meeting the requested criteria, including conceptual duplicates. Valid values are 0 (false) and 1 (true, default).
 612     order  := date_published sort direction, either "asc" (chronological, default) or "desc" (reverse chronological)
 613     limit  := Number of issuances to return.  Useful for paging results, or finding the oldest or newest
 614     offset := Number of issuance to skip before returning results.  Useful for paging.
 615     orgid  := OU id used to scope retrieval, based on distribution.holding_lib
 616     depth  := OU depth used to range the scope of orgid
 617     type   := Holding type filter. Valid values are "basic", "supplement" and "index". Can be a scalar (one) or arrayref (one or more).
 618     status := Item status filter. Valid values are "Bindery", "Bound", "Claimed", "Discarded", "Expected", "Not Held", "Not Published" and "Received". Can be a scalar (one) or arrayref (one or more).
 619 /
 620             }
 621         ]
 622     }
 623 );
 624
 625
 626 sub scoped_bib_holdings_summary {
 627     # XXX this is somewhat wrong in implementation and should not be used in
 628     # new places - senator
 629     my $self = shift;
 630     my $client = shift;
 631     my $bibid = shift;
 632     my $args = shift || {};
 633
 634     $args->{order} = 'asc';
 635
 636     my ($issuances) = $self->method_lookup('open-ils.serial.received_siss.retrieve.by_bib.atomic')->run( $bibid => $args );
 637
 638     # split into issuance type sets
 639     my %type_blob = (basic => [], supplement => [], index => []);
 640     push @{ $type_blob{ $_->{"issuance"}->holding_type } }, $_->{"issuance"}
 641         for (@$issuances);
 642
 643     # generate a statement list for each type
 644     my %statement_blob;
 645     for my $type ( keys %type_blob ) {
 646         my ($mfhd,$list) = _summarize_contents(new_editor(), $type_blob{$type});
 647
 648         return {} if $U->event_code($mfhd); # _summarize_contents() failed, bad data?
 649
 650         $statement_blob{$type} = $list;
 651     }
 652
 653     return \%statement_blob;
 654 }
 655 __PACKAGE__->register_method(
 656     method    => 'scoped_bib_holdings_summary',
 657     api_name  => 'open-ils.serial.bib.summary_statements',
 658     api_level => 1,
 659     argc      => 1,
 660     signature => {
 661         desc   => '** DEPRECATED and only used by JSPAC. Somewhat wrong in implementation. *** Receives a Bib ID and other optional params and returns set of holdings statements',
 662         params => [
 663             {   name => 'bibid',
 664                 desc => 'id of the bre to which the issuances belong',
 665                 type => 'number'
 666             },
 667             {   name => 'args',
 668                 desc =>
 669 q/A hash of optional arguments.  Valid keys and their meanings:
 670     orgid  := OU id used to scope retrieval, based on distribution.holding_lib
 671     depth  := OU depth used to range the scope of orgid
 672     type   := Holding type filter. Valid values are "basic", "supplement" and "index". Can be a scalar (one) or arrayref (one or more).
 673     status := Item status filter. Valid values are "Bindery", "Bound", "Claimed", "Discarded", "Expected", "Not Held", "Not Published" and "Received". Can be a scalar (one) or arrayref (one or more).
 674 /
 675             }
 676         ]
 677     }
 678 );
 679
 680
 681 ##########################################################################
 682 # unit methods
 683 #
 684 __PACKAGE__->register_method(
 685     method    => 'fleshed_sunit_alter',
 686     api_name  => 'open-ils.serial.sunit.fleshed.batch.update',
 687     api_level => 1,
 688     argc      => 2,
 689     signature => {
 690         desc     => 'Receives an array of one or more Units and updates the database as needed',
 691         'params' => [ {
 692                  name => 'authtoken',
 693                  desc => 'Authtoken for current user session',
 694                  type => 'string'
 695             },
 696             {
 697                  name => 'sunits',
 698                  desc => 'Array of fleshed Units',
 699                  type => 'array'
 700             }
 701
 702         ],
 703         'return' => {
 704             desc => 'Returns 1 if successful, event if failed',
 705             type => 'mixed'
 706         }
 707     }
 708 );
 709
 710 sub fleshed_sunit_alter {
 711     my( $self, $conn, $auth, $sunits ) = @_;
 712     return 1 unless ref $sunits;
 713     my( $reqr, $evt ) = $U->checkses($auth);
 714     return $evt if $evt;
 715     my $editor = new_editor(requestor => $reqr, xact => 1);
 716     my $override = $self->api_name =~ /override/;
 717
 718     my %found_cn_ids;
 719     for my $sunit (@$sunits) {
 720         my $cn_id = ref $sunit->call_number ? $sunit->call_number->id : $sunit->call_number;
 721         if (!exists($found_cn_ids{$cn_id})) {
 722             my $owning_lib_id;
 723             if (ref $sunit->call_number) {
 724                 $owning_lib_id = $sunit->call_number->owning_lib;
 725             } else {
 726                 my $cn = $editor->retrieve_asset_call_number($sunit->call_number) or return $editor->die_event;
 727                 $owning_lib_id = $cn->owning_lib;
 728             }
 729             return $editor->die_event unless
 730                 $editor->allowed("UPDATE_COPY", $owning_lib_id);
 731             $found_cn_ids{$cn_id} = 1;
 732         }
 733
 734         if( $sunit->isdeleted ) {
 735             $evt = _delete_sunit( $editor, $override, $sunit );
 736         } else {
 737             $sunit->default_location( $sunit->default_location->id ) if ref $sunit->default_location;
 738
 739             if( $sunit->isnew ) {
 740                 $evt = _create_sunit( $editor, $sunit );
 741             } else {
 742                 $evt = _update_sunit( $editor, $override, $sunit );
 743             }
 744         }
 745     }
 746
 747     if( $evt ) {
 748         $logger->info("fleshed sunit-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
 749         $editor->rollback;
 750         return $evt;
 751     }
 752     $logger->debug("sunit-alter: done updating sunit batch");
 753     $editor->commit;
 754     $logger->info("fleshed sunit-alter successfully updated ".scalar(@$sunits)." Units");
 755     return 1;
 756 }
 757
 758 sub _delete_sunit {
 759     my ($editor, $override, $sunit) = @_;
 760     $logger->info("sunit-alter: delete sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
 761     return $editor->event unless $editor->delete_serial_unit($sunit);
 762     return 0;
 763 }
 764
 765 sub _create_sunit {
 766     my ($editor, $sunit) = @_;
 767
 768     # The unique barcode constraint does not span asset.copy and serial.unit.
 769     # ensure the barcode on the new unit does not collide with an existing
 770     # asset.copy barcode.
 771     my $existing = $editor->search_asset_copy(
 772         {deleted => 'f', barcode => $sunit->barcode})->[0];
 773
 774     if (!$existing) {
 775         # The DB will prevent duplicate serial.unit barcodes, but for
 776         # consistency (and a more specific error message for the
 777         # user), prevent creation attempts on serial unit barcode
 778         # collisions as well.
 779         $existing = $editor->search_serial_unit(
 780             {deleted => 'f', barcode => $sunit->barcode})->[0];
 781     }
 782
 783     if ($existing) {
 784         $editor->rollback;
 785         return new OpenILS::Event(
 786             'SERIAL_UNIT_BARCODE_COLLISION', note =>
 787             'Serial unit barcode collides with existing unit/copy barcode',
 788             payload => {barcode => $sunit->barcode}
 789         );
 790     }
 791
 792     $logger->info("sunit-alter: new Unit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
 793     return $editor->die_event unless $editor->create_serial_unit($sunit);
 794     return 0;
 795 }
 796
 797 sub _update_sunit {
 798     my ($editor, $override, $sunit) = @_;
 799
 800     $logger->info("sunit-alter: retrieving sunit ".$sunit->id);
 801     my $orig_sunit = $editor->retrieve_serial_unit($sunit->id);
 802
 803     $logger->info("sunit-alter: original sunit ".OpenSRF::Utils::JSON->perl2JSON($orig_sunit));
 804     $logger->info("sunit-alter: updated sunit ".OpenSRF::Utils::JSON->perl2JSON($sunit));
 805     return $editor->event unless $editor->update_serial_unit($sunit);
 806     return 0;
 807 }
 808
 809 __PACKAGE__->register_method(
 810     method  => "retrieve_unit_list",
 811     authoritative => 1,
 812     api_name    => "open-ils.serial.unit_list.retrieve"
 813 );
 814
 815 sub retrieve_unit_list {
 816
 817     my( $self, $client, @sdist_ids ) = @_;
 818
 819     if(ref($sdist_ids[0])) { @sdist_ids = @{$sdist_ids[0]}; }
 820
 821     my $e = new_editor();
 822
 823     my $query = {
 824         'select' =>
 825             { 'sunit' => [ 'id', 'summary_contents', 'sort_key' ],
 826               'sitem' => ['stream'],
 827               'sstr' => ['distribution'],
 828               'sdist' => [{'column' => 'label', 'alias' => 'sdist_label'}]
 829             },
 830         'from' =>
 831             { 'sdist' =>
 832                 { 'sstr' =>
 833                     { 'join' =>
 834                         { 'sitem' =>
 835                             { 'join' => { 'sunit' => {} } }
 836                         }
 837                     }
 838                 }
 839             },
 840         'distinct' => 'true',
 841         'where' => { '+sdist' => {'id' => \@sdist_ids} },
 842         'order_by' => [{'class' => 'sunit', 'field' => 'sort_key'}]
 843     };
 844
 845     my $unit_list_entries = $e->json_query($query);
 846
 847     my @entries;
 848     foreach my $entry (@$unit_list_entries) {
 849         my $value = {'sunit' => $entry->{id}, 'sstr' => $entry->{stream}, 'sdist' => $entry->{distribution}};
 850         my $label = $entry->{summary_contents};
 851         if (length($label) > 100) {
 852             $label = substr($label, 0, 100) . '...'; # limited space in dropdown / menu
 853         }
 854         $label = "[$entry->{sdist_label}/$entry->{stream} #$entry->{id}] " . $label;
 855         push (@entries, [$label, OpenSRF::Utils::JSON->perl2JSON($value)]);
 856     }
 857
 858     return \@entries;
 859 }
 860
 861
 862
 863 ##########################################################################
 864 # predict and receive methods
 865 #
 866 __PACKAGE__->register_method(
 867     method    => 'make_predictions',
 868     api_name  => 'open-ils.serial.make_predictions',
 869     api_level => 1,
 870     argc      => 1,
 871     signature => {
 872         desc     => 'Receives an ssub id and populates the issuance and item tables',
 873         'params' => [ {
 874                  name => 'ssub_id',
 875                  desc => 'Serial Subscription ID',
 876                  type => 'int'
 877             }
 878         ]
 879     }
 880 );
 881
 882 sub make_predictions {
 883     my ($self, $conn, $authtoken, $args) = @_;
 884
 885     my $editor = OpenILS::Utils::CStoreEditor->new();
 886     my $ssub_id = $args->{ssub_id};
 887     my $mfhd = MFHD->new(MARC::Record->new());
 888
 889     my $ssub = $editor->retrieve_serial_subscription([$ssub_id]);
 890     my $scaps = $editor->search_serial_caption_and_pattern({ subscription => $ssub_id, active => 't'});
 891     my $sdists = $editor->search_serial_distribution( [{ subscription => $ssub->id }, { flesh => 1, flesh_fields => {sdist => [ qw/ streams / ]} }] ); #TODO: 'deleted' support?
 892
 893     my $total_streams = 0;
 894     foreach (@$sdists) {
 895         $total_streams += scalar(@{$_->streams});
 896     }
 897     if ($total_streams < 1) {
 898         $editor->disconnect;
 899         # XXX TODO new event type
 900         return new OpenILS::Event(
 901             "BAD_PARAMS", note =>
 902                 "There are no streams to direct items. Can't predict."
 903         );
 904     }
 905
 906     unless (@$scaps) {
 907         $editor->disconnect;
 908         # XXX TODO new event type
 909         return new OpenILS::Event(
 910             "BAD_PARAMS", note =>
 911                 "There are no active caption-and-pattern objects associated " .
 912                 "with this subscription. Can't predict."
 913         );
 914     }
 915
 916     my @predictions;
 917     my $link_id = 1;
 918     foreach my $scap (@$scaps) {
 919         my $caption_field = _revive_caption($scap);
 920         $caption_field->update('8' => $link_id);
 921         my $fake_chron_needed = 0;
 922         # if we have missing chron pieces, we will add them later for prediction purposes
 923         if (!$caption_field->enumeration_is_chronology) {
 924             if (!$caption_field->subfield('i') # no year
 925                 or !$caption_field->subfield('j')) { # we had a year, but no month or season
 926                 $fake_chron_needed = '1';
 927             }
 928         }
 929         $mfhd->append_fields($caption_field);
 930         my $options = {
 931                 'caption' => $caption_field,
 932                 'scap_id' => $scap->id,
 933                 'num_to_predict' => $args->{num_to_predict},
 934                 'end_date' => defined $args->{end_date} ?
 935                     $_strp_date->parse_datetime($args->{end_date}) : undef
 936                 };
 937         my $predict_from_siss;
 938         if ($args->{base_issuance}) { # predict from a given issuance
 939             $predict_from_siss = $args->{base_issuance}->holding_code;
 940         } else { # default to predicting from last published
 941             my $last_published = $editor->search_serial_issuance([
 942                     {'caption_and_pattern' => $scap->id,
 943                     'subscription' => $ssub_id},
 944                 {limit => 1, order_by => { siss => "date_published DESC" }}]
 945                 );
 946             if ($last_published->[0]) {
 947                 $predict_from_siss = $last_published->[0];
 948                 unless ($predict_from_siss->holding_code) {
 949                     $editor->disconnect;
 950                     # XXX TODO new event type
 951                     return new OpenILS::Event(
 952                         "BAD_PARAMS", note =>
 953                             "Last issuance has no holding code. Can't predict."
 954                     );
 955                 }
 956             } else {
 957                 $editor->disconnect;
 958                 # XXX TODO make a new event type instead of hijacking this one
 959                 return new OpenILS::Event(
 960                     "BAD_PARAMS", note => "No issuance from which to predict!"
 961                 );
 962             }
 963         }
 964         $options->{predict_from} = _revive_holding($predict_from_siss->holding_code, $caption_field, 1); # fresh MFHD Record, so we simply default to 1 for seqno
 965         if ($fake_chron_needed) {
 966             $options->{faked_chron_date} = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($predict_from_siss->date_published));
 967         }
 968         push( @predictions, _generate_issuance_values($mfhd, $options) );
 969         $link_id++;
 970     }
 971
 972     my @issuances;
 973     foreach my $prediction (@predictions) {
 974         my $issuance = new Fieldmapper::serial::issuance;
 975         $issuance->isnew(1);
 976         $issuance->label($prediction->{label});
 977         $issuance->date_published($prediction->{date_published}->strftime('%F'));
 978         $issuance->holding_code(OpenSRF::Utils::JSON->perl2JSON($prediction->{holding_code}));
 979         $issuance->holding_type($prediction->{holding_type});
 980         $issuance->caption_and_pattern($prediction->{caption_and_pattern});
 981         $issuance->subscription($ssub->id);
 982         push (@issuances, $issuance);
 983     }
 984
 985     my $evt = fleshed_issuance_alter($self, $conn, $authtoken, \@issuances);
 986     return $evt if ref $evt;
 987
 988     my @items;
 989     for (my $i = 0; $i < @issuances; $i++) {
 990         my $date_expected = $predictions[$i]->{date_published}->add(seconds => interval_to_seconds($ssub->expected_date_offset))->strftime('%F');
 991         my $issuance = $issuances[$i];
 992         #$issuance->label(interval_to_seconds($ssub->expected_date_offset));
 993         foreach my $sdist (@$sdists) {
 994             my $streams = $sdist->streams;
 995             foreach my $stream (@$streams) {
 996                 my $item = new Fieldmapper::serial::item;
 997                 $item->isnew(1);
 998                 $item->stream($stream->id);
 999                 $item->date_expected($date_expected);
1000                 $item->issuance($issuance->id);
1001                 push (@items, $item);
1002             }
1003         }
1004     }
1005     fleshed_item_alter($self, $conn, $authtoken, \@items); # FIXME: catch events
1006     return \@items;
1007 }
1008
1009 #
1010 # _generate_issuance_values() is an initial attempt at a function which can be used
1011 # to populate an issuance table with a list of predicted issues.  It accepts
1012 # a hash ref of options initially defined as:
1013 # caption : the caption field to predict on
1014 # num_to_predict : the number of issues you wish to predict
1015 # faked_chron_date : if the serial does not actually have a chronology caption (but we need one for prediction's sake), base predictions on this date
1016 #
1017 # The basic method is to first convert to a single holding if compressed, then
1018 # increment the holding and save the resulting values to @issuances.
1019 #
1020 # returns @issuance_values, an array of hashrefs containing (formatted
1021 # label, formatted chronology date, formatted estimated arrival date, and an
1022 # array ref of holding subfields as (key, value, key, value ...)) (not a hash
1023 # to protect order and possible duplicate keys), and a holding type.
1024 #
1025 sub _generate_issuance_values {
1026     my ($mfhd, $options) = @_;
1027     my $caption = $options->{caption};
1028     my $scap_id = $options->{scap_id};
1029     my $num_to_predict = $options->{num_to_predict};
1030     my $end_date = $options->{end_date};
1031     my $predict_from = $options->{predict_from};   # MFHD::Holding to predict from
1032     my $faked_chron_date = $options->{faked_chron_date};   # serial does not have a (complete) chronology caption, so add one (temporarily) based on this date
1033
1034
1035 # Only needed for 'real' MFHD records, not our temp records
1036 #    my $link_id = $caption->link_id;
1037 #    if(!$predict_from) {
1038 #        my $htag = $caption->tag;
1039 #        $htag =~ s/^85/86/;
1040 #        my @holdings = $mfhd->holdings($htag, $link_id);
1041 #        my $last_holding = $holdings[-1];
1042 #
1043 #        #if ($last_holding->is_compressed) {
1044 #        #    $last_holding->compressed_to_last; # convert to last in range
1045 #        #}
1046 #        $predict_from = $last_holding;
1047 #    }
1048 #
1049
1050     $predict_from->notes('public',  []);
1051 # add a note marker for system use (?)
1052     $predict_from->notes('private', ['AUTOGEN']);
1053
1054     # our basic method for dealing with 'faked' chronologies will be to add it in, do the predicting, then take it back out
1055     my @faked_subfield_chars;
1056     if ($faked_chron_date) {
1057         my $faked_caption = new MARC::Field($caption->tag, $caption->indicator(1), $caption->indicator(2), $caption->subfields_list);
1058
1059         my %mfhd_chron_labels = ('i' => 'year', 'j' => 'month', 'k' => 'day');
1060         foreach my $subfield_char ('i', 'j', 'k') {
1061             if (!$caption->subfield($subfield_char)) { # if we are missing a piece, add it
1062                 push(@faked_subfield_chars, $subfield_char);
1063                 my $chron_name = $mfhd_chron_labels{$subfield_char};
1064                 $faked_caption->add_subfields($subfield_char => "($chron_name)");
1065                 my $method = $mfhd_chron_labels{$subfield_char};
1066                 $predict_from->add_subfields($subfield_char => $faked_chron_date->$chron_name);
1067             }
1068         }
1069         # because of the way MFHD::Caption and Holding work, it is simplest
1070         # to recreate rather than try to update
1071         $faked_caption = new MFHD::Caption($faked_caption);
1072         $predict_from = new MFHD::Holding($predict_from->seqno, new MARC::Field($predict_from->tag, $predict_from->indicator(1), $predict_from->indicator(2), $predict_from->subfields_list), $faked_caption);
1073     }
1074
1075     my @predictions = $mfhd->generate_predictions({'base_holding' => $predict_from, 'num_to_predict' => $num_to_predict, 'end_date' => $end_date});
1076
1077     my $pub_date;
1078     my @issuance_values;
1079     foreach my $prediction (@predictions) {
1080         $pub_date = $_strp_date->parse_datetime($prediction->chron_to_date);
1081         if ($faked_chron_date) { # get rid of the chronology portions and restore original caption
1082             $prediction->delete_subfield(code => \@faked_subfield_chars);
1083             $prediction = new MFHD::Holding($prediction->seqno, new MARC::Field($prediction->tag, $prediction->indicator(1), $prediction->indicator(2), $prediction->subfields_list), $caption);
1084         }
1085         push(
1086                 @issuance_values,
1087                 {
1088                     #$link_id,
1089                     label => $prediction->format,
1090                     date_published => $pub_date,
1091                     #date_expected => $date_expected->strftime('%F'),
1092                     holding_code => [$prediction->indicator(1),$prediction->indicator(2),$prediction->subfields_list],
1093                     holding_type => $MFHD_NAMES_BY_TAG{$caption->tag},
1094                     caption_and_pattern => $scap_id
1095                 }
1096             );
1097     }
1098
1099     return @issuance_values;
1100 }
1101
1102 sub _revive_caption {
1103     my $scap = shift;
1104
1105     my $pattern_code = $scap->pattern_code;
1106
1107     # build MARC::Field
1108     my $pattern_parts = OpenSRF::Utils::JSON->JSON2perl($pattern_code);
1109     unshift(@$pattern_parts, $MFHD_TAGS_BY_NAME{$scap->type});
1110     my $pattern_field = new MARC::Field(@$pattern_parts);
1111
1112     # build MFHD::Caption
1113     return new MFHD::Caption($pattern_field);
1114 }
1115
1116 sub _revive_holding {
1117     my $holding_code = shift;
1118     my $caption_field = shift;
1119     my $seqno = shift;
1120
1121     # build MARC::Field
1122     my $holding_parts = OpenSRF::Utils::JSON->JSON2perl($holding_code);
1123     my $captag = $caption_field->tag;
1124     $captag =~ s/^85/86/;
1125     unshift(@$holding_parts, $captag);
1126     my $holding_field = new MARC::Field(@$holding_parts);
1127
1128     # build MFHD::Holding
1129     return new MFHD::Holding($seqno, $holding_field, $caption_field);
1130
1131     # TODO(?) the underlying MARC and the Holding object end up in conflict concerning subfield '8'
1132 }
1133
1134 __PACKAGE__->register_method(
1135     method    => 'unitize_items',
1136     api_name  => 'open-ils.serial.receive_items',
1137     api_level => 1,
1138     argc      => 1,
1139     signature => {
1140         desc     => 'Marks an item as received, updates the shelving unit (creating a new shelving unit if needed), and updates the summaries',
1141         'params' => [ {
1142                  name => 'items',
1143                  desc => 'array of serial items',
1144                  type => 'array'
1145             },
1146             {
1147                  name => 'barcodes',
1148                  desc => 'hash of item_ids => barcodes',
1149                  type => 'hash'
1150             },
1151             {
1152                  name => 'call_numbers',
1153                  desc => 'hash of item_ids => call_numbers',
1154                  type => 'hash'
1155             },
1156             {
1157                  name => 'donor_unit_ids',
1158                  desc => 'hash of unit_ids => 1, keyed with ids of any units giving up items',
1159                  type => 'hash'
1160             }
1161         ],
1162         'return' => {
1163             desc => 'Returns number of received items (num_items) and new unit ID, if applicable (new_unit_id)',
1164             type => 'hashref'
1165         }
1166     }
1167 );
1168
1169 __PACKAGE__->register_method(
1170     method    => 'unitize_items',
1171     api_name  => 'open-ils.serial.bind_items',
1172     api_level => 1,
1173     argc      => 1,
1174     signature => {
1175         desc     => 'Marks an item as bound, updates the shelving unit (creating a new shelving unit if needed)',
1176         'params' => [ {
1177                  name => 'items',
1178                  desc => 'array of serial items',
1179                  type => 'array'
1180             },
1181             {
1182                  name => 'barcodes',
1183                  desc => 'hash of item_ids => barcodes',
1184                  type => 'hash'
1185             },
1186             {
1187                  name => 'call_numbers',
1188                  desc => 'hash of item_ids => call_numbers',
1189                  type => 'hash'
1190             },
1191             {
1192                  name => 'donor_unit_ids',
1193                  desc => 'hash of unit_ids => 1, keyed with ids of any units giving up items',
1194                  type => 'hash'
1195             }
1196         ],
1197         'return' => {
1198             desc => 'Returns number of bound items (num_items) and new unit ID, if applicable (new_unit_id)',
1199             type => 'hashref'
1200         }
1201     }
1202 );
1203
1204 # TODO: reset/delete claims information once implemented
1205 # XXX: deal with emptied call numbers here?
1206 __PACKAGE__->register_method(
1207     method    => 'unitize_items',
1208     api_name  => 'open-ils.serial.reset_items',
1209     api_level => 1,
1210     argc      => 1,
1211     signature => {
1212         desc     => 'Resets the items to Expected, updates the shelving unit (deleting the shelving unit if empty), and updates the summaries',
1213         'params' => [ {
1214                  name => 'items',
1215                  desc => 'array of serial items',
1216                  type => 'array'
1217             }
1218         ],
1219         'return' => {
1220             desc => 'Returns number of reset items (num_items)',
1221             type => 'hashref'
1222         }
1223     }
1224 );
1225
1226 sub unitize_items {
1227     my ($self, $conn, $auth, $items, $barcodes, $call_numbers, $donor_unit_ids) = @_;
1228
1229     my $editor = new_editor("authtoken" => $auth, "xact" => 1);
1230     return $editor->die_event unless $editor->checkauth;
1231     return $editor->die_event unless $editor->allowed("RECEIVE_SERIAL");
1232     $self->api_name =~ /serial\.(\w*)_items/;
1233     my $mode = $1;
1234
1235     my %found_unit_ids;
1236     if ($donor_unit_ids) { # units giving up items need updating as well
1237         %found_unit_ids = %$donor_unit_ids;
1238     }
1239     my %found_stream_ids;
1240     my %found_types;
1241
1242     my %stream_ids_by_unit_id;
1243
1244     my %unit_map;
1245     my %sdist_by_unit_id;
1246     my %call_number_by_unit_id;
1247     my %sdist_by_stream_id;
1248
1249     my $new_unit_id; # id for '-2' units to share
1250     foreach my $item (@$items) {
1251         # for debugging only, TODO: delete
1252         if (!ref $item) { # hopefully we got an id instead
1253             $item = $editor->retrieve_serial_item($item);
1254         }
1255         # get ids
1256         my $unit_id = ref($item->unit) ? $item->unit->id : $item->unit;
1257         my $stream_id = ref($item->stream) ? $item->stream->id : $item->stream;
1258         my $issuance_id = ref($item->issuance) ? $item->issuance->id : $item->issuance;
1259         #TODO: evt on any missing ids
1260
1261         if ($mode eq 'receive') {
1262             $item->date_received('now');
1263             $item->status('Received');
1264         } elsif ($mode eq 'reset') {
1265             # clear date_received
1266             $item->clear_date_received;
1267             # Set status to 'Expected'
1268             $item->status('Expected');
1269             # remove from unit
1270             $item->clear_unit;
1271         }
1272
1273         # check for types to trigger summary updates
1274         my $scap;
1275         if (!ref $item->issuance) {
1276             my $scaps = $editor->search_serial_caption_and_pattern([{"+siss" => {"id" => $issuance_id}}, { "join" => {"siss" => {}} }]);
1277             $scap = $scaps->[0];
1278         } elsif (!ref $item->issuance->caption_and_pattern) {
1279             $scap = $editor->retrieve_serial_caption_and_pattern($item->issuance->caption_and_pattern);
1280         } else {
1281             $scap = $editor->issuance->caption_and_pattern;
1282         }
1283         if (!exists($found_types{$stream_id})) {
1284             $found_types{$stream_id} = {};
1285         }
1286         $found_types{$stream_id}->{$scap->type} = 1;
1287
1288         # create unit if needed
1289         if ($unit_id == -1 or (!$new_unit_id and $unit_id == -2)) { # create unit per item
1290             my $unit;
1291             my $sdists = $editor->search_serial_distribution([
1292                 {"+sstr" => {"id" => $stream_id}},
1293                 {
1294                     "join" => {"sstr" => {}},
1295                     "flesh" => 1,
1296                     "flesh_fields" => {"sdist" => ["subscription"]}
1297                 }]);
1298             $unit = _build_unit($editor, $sdists->[0], $mode);
1299             # if _build_unit fails, $unit is an event, so return it
1300             if ($U->event_code($unit)) {
1301                 $editor->rollback;
1302                 $unit->{"note"} = "Item ID: " . $item->id;
1303                 return $unit;
1304             }
1305             $unit->barcode($barcodes->{$item->id}) if exists($barcodes->{$item->id});
1306             my $evt =  _create_sunit($editor, $unit);
1307             return $evt if $evt;
1308             if ($unit_id == -2) {
1309                 $new_unit_id = $unit->id;
1310                 $unit_id = $new_unit_id;
1311             } else {
1312                 $unit_id = $unit->id;
1313             }
1314             $item->unit($unit_id);
1315
1316             # get unit with 'DEFAULT's and save unit, sdist, and call number for later use
1317             $unit = $editor->retrieve_serial_unit($unit->id);
1318             $unit_map{$unit_id} = $unit;
1319             $sdist_by_unit_id{$unit_id} = $sdists->[0];
1320             $call_number_by_unit_id{$unit_id} = $call_numbers->{$item->id};
1321             $sdist_by_stream_id{$stream_id} = $sdists->[0];
1322         } elsif ($unit_id == -2) { # create one unit for all '-2' items
1323             $unit_id = $new_unit_id;
1324             $item->unit($unit_id);
1325         }
1326
1327         $found_stream_ids{$stream_id} = 1;
1328
1329         if (defined($unit_id) and $unit_id ne '') {
1330             $found_unit_ids{$unit_id} = 1;
1331             # save the stream_id for this unit_id
1332             # TODO: prevent items from different streams in same unit? (perhaps in interface)
1333             $stream_ids_by_unit_id{$unit_id} = $stream_id;
1334         } else {
1335             $item->clear_unit;
1336         }
1337
1338         my $evt = _update_sitem($editor, undef, $item);
1339         return $evt if $evt;
1340     }
1341
1342     # cleanup 'dead' units (units which are now emptied of their items)
1343     my $dead_units = $editor->search_serial_unit([{'+sitem' => {'id' => undef}, 'deleted' => 'f'}, {'join' => {'sitem' => {'type' => 'left'}}}]);
1344     foreach my $unit (@$dead_units) {
1345         _delete_sunit($editor, undef, $unit);
1346         delete $found_unit_ids{$unit->id};
1347     }
1348
1349     # deal with unit level contents
1350     foreach my $unit_id (keys %found_unit_ids) {
1351
1352         # get all the needed issuances for unit
1353         # TODO remove 'Bindery' from this search (leaving it in for now for backwards compatibility with any current test environment data)
1354         my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"unit" => $unit_id, "status" => ["Received", "Bindery"]}}, {"join" => {"sitem" => {}}, "order_by" => {"siss" => "date_published"}} ]);
1355         #TODO: evt on search failure
1356
1357         # retrieve and update unit contents
1358         my $sunit;
1359         my $sdist;
1360         my $call_number_string;
1361         my $record_id;
1362         # if we just created the unit, we will already have it and the distribution stored, and we will need to assign the call number
1363         if (exists $unit_map{$unit_id}) {
1364             $sunit = $unit_map{$unit_id};
1365             $sdist = $sdist_by_unit_id{$unit_id};
1366             $call_number_string = $call_number_by_unit_id{$unit_id};
1367             $record_id = $sdist->subscription->record_entry;
1368         } else {
1369             # XXX: this code assumes you will not have units which mix streams/distributions, but current code does not enforce this
1370             $sunit = $editor->retrieve_serial_unit($unit_id);
1371             if ($stream_ids_by_unit_id{$unit_id}) {
1372                 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_ids_by_unit_id{$unit_id}}}, { "join" => {"sstr" => {}}, 'limit' => 1 }]);
1373             } else {
1374                 $sdist = $editor->search_serial_distribution([
1375                     {'+sunit' => {'id' => $unit_id}},
1376                     { 'join' =>
1377                         {'sstr' =>
1378                             { 'join' =>
1379                                 { 'sitem' =>
1380                                     { 'join' => 'sunit' }
1381                                 }
1382                             }
1383                         },
1384                       'limit' => 1
1385                     }]);
1386             }
1387             $sdist = $sdist->[0];
1388         }
1389
1390         my $evt = _prepare_unit($editor, $sunit, $sdist, $issuances, $call_number_string, $record_id);
1391         if ($U->event_code($evt)) {
1392             $editor->rollback;
1393             return $evt;
1394         }
1395
1396         $evt = _update_sunit($editor, undef, $sunit);
1397         if ($U->event_code($evt)) {
1398             $editor->rollback;
1399             return $evt;
1400         }
1401     }
1402
1403     if ($mode ne 'bind') { # the summary holdings do not change when binding
1404         # deal with stream level summaries
1405         # summaries will be built from the "primary" stream only, that is, the stream with the lowest ID per distribution
1406         # (TODO: consider direct designation)
1407         my %primary_streams_by_sdist;
1408         my %streams_by_sdist;
1409
1410         # see if we have primary streams, and if so, associate them with their distributions
1411         foreach my $stream_id (keys %found_stream_ids) {
1412             my $sdist;
1413             if (exists $sdist_by_stream_id{$stream_id}) {
1414                 $sdist = $sdist_by_stream_id{$stream_id};
1415             } else {
1416                 $sdist = $editor->search_serial_distribution([{"+sstr" => {"id" => $stream_id}}, { "join" => {"sstr" => {}} }]);
1417                 $sdist = $sdist->[0];
1418                 $sdist_by_stream_id{$stream_id} = $sdist;
1419             }
1420             my $streams;
1421             if (!exists($streams_by_sdist{$sdist->id})) {
1422                 $streams = $editor->search_serial_stream([{"distribution" => $sdist->id}, {"order_by" => {"sstr" => "id"}}]);
1423                 $streams_by_sdist{$sdist->id} = $streams;
1424             } else {
1425                 $streams = $streams_by_sdist{$sdist->id};
1426             }
1427             $primary_streams_by_sdist{$sdist->id} = $streams->[0] if ($stream_id == $streams->[0]->id);
1428         }
1429
1430         # retrieve and update summaries for each affected primary stream's distribution
1431         foreach my $sdist_id (keys %primary_streams_by_sdist) {
1432             my $stream = $primary_streams_by_sdist{$sdist_id};
1433             my $stream_id = $stream->id;
1434             # get all the needed issuances for stream
1435             # FIXME: search in Bindery/Bound/Not Published? as well as Received
1436             foreach my $type (keys %{$found_types{$stream_id}}) {
1437                 my $issuances = $editor->search_serial_issuance([ {"+sitem" => {"stream" => $stream_id, "status" => "Received"}, "+scap" => {"type" => $type}}, {"join" => {"sitem" => {}, "scap" => {}}, "order_by" => {"siss" => "date_published"}} ]);
1438                 #TODO: evt on search failure
1439                 my $evt = _prepare_summaries($editor, $issuances, $sdist_by_stream_id{$stream_id}, $type);
1440                 if ($U->event_code($evt)) {
1441                     $editor->rollback;
1442                     return $evt;
1443                 }
1444             }
1445         }
1446     }
1447
1448     $editor->commit;
1449     return {'num_items' => scalar @$items, 'new_unit_id' => $new_unit_id};
1450 }
1451
1452 sub _find_or_create_call_number {
1453     my ($e, $lib, $cn_string, $record) = @_;
1454
1455     # FIXME: should suffix and prefix come into play here?
1456     my $existing = $e->search_asset_call_number({
1457         "owning_lib" => $lib,
1458         "label" => $cn_string,
1459         "record" => $record,
1460         "deleted" => "f"
1461     }) or return $e->die_event;
1462
1463     if (@$existing) {
1464         return $existing->[0]->id;
1465     } else {
1466         return $e->die_event unless
1467             $e->allowed("CREATE_VOLUME", $lib);
1468
1469         my $acn = new Fieldmapper::asset::call_number;
1470
1471         $acn->creator($e->requestor->id);
1472         $acn->editor($e->requestor->id);
1473         $acn->record($record);
1474         $acn->label($cn_string);
1475         $acn->owning_lib($lib);
1476
1477         $e->create_asset_call_number($acn) or return $e->die_event;
1478         return $e->data->id;
1479     }
1480 }
1481
1482 sub _issuances_received {
1483     # XXX TODO: Add some caching or something. This is getting called
1484     # more often than it has to be.
1485     my ($e, $sitem) = @_;
1486
1487     my $results = $e->json_query({
1488         "select" => {"sitem" => ["issuance"]},
1489         "from" => {"sitem" => {"sstr" => {}, "siss" => {}}},
1490         "where" => {
1491             "+sstr" => {"distribution" => $sitem->stream->distribution->id},
1492             "+siss" => {"holding_type" => $sitem->issuance->holding_type},
1493             "+sitem" => {"date_received" => {"!=" => undef}}
1494         },
1495         "order_by" => {
1496             "siss" => {"date_published" => {"direction" => "asc"}}
1497         }
1498     }) or return $e->die_event;
1499
1500     my $uniq = +{map { $_->{"issuance"} => 1 } @$results};
1501     return [ map { $e->retrieve_serial_issuance($_) } keys %$uniq ];
1502 }
1503
1504 # _prepare_unit populates the detailed_contents, summary_contents, and
1505 # sort_key fields for a given unit based on a given set of issuances
1506 # Also finds/creates call number as needed
1507 sub _prepare_unit {
1508     my ($e, $sunit, $sdist, $issuances, $call_number_string, $record_id) = @_;
1509
1510     # Handle call number first if we have one
1511     if ($call_number_string) {
1512         my $org_unit_id = ref $sdist->holding_lib ? $sdist->holding_lib->id : $sdist->holding_lib;
1513         my $real_cn = _find_or_create_call_number(
1514             $e, $org_unit_id,
1515             $call_number_string, $record_id
1516         );
1517
1518         if ($U->event_code($real_cn)) {
1519             return $real_cn;
1520         } else {
1521             $sunit->call_number($real_cn);
1522         }
1523     }
1524
1525     my ($mfhd, $formatted_parts) = _summarize_contents($e, $issuances);
1526     return $mfhd if $U->event_code($mfhd);
1527
1528     # special case for single formatted_part (may have summarized version)
1529     if (@$formatted_parts == 1) {
1530         #TODO: MFHD.pm should have a 'format_summary' method for this
1531     }
1532
1533     $sunit->detailed_contents(
1534         join(
1535             " ",
1536             $sdist->unit_label_prefix,
1537             join(", ", @$formatted_parts),
1538             $sdist->unit_label_suffix
1539         )
1540     );
1541
1542     # TODO: change this when real summary contents are available
1543     $sunit->summary_contents($sunit->detailed_contents);
1544
1545     # Create sort_key by left padding numbers to 6 digits.
1546     (my $sort_key = $sunit->detailed_contents) =~
1547         s/(\d+)/sprintf '%06d', $1/eg;
1548     $sunit->sort_key($sort_key);
1549 }
1550
1551 # _prepare_summaries populates the generated_coverage field for a given summary
1552 # type ('basic', 'index', 'supplement') for a given distribution.
1553 # It also creates the summary if it doesn't yet exist.
1554 sub _prepare_summaries {
1555     my ($e, $issuances, $sdist, $type) = @_;
1556
1557     my ($mfhd, $formatted_parts) = _summarize_contents($e, $issuances, $sdist);
1558     return $mfhd if $U->event_code($mfhd);
1559
1560     my $search_method = "search_serial_${type}_summary";
1561     my $summary = $e->$search_method([{"distribution" => $sdist->id}]);
1562
1563     my $cu_method = "update";
1564
1565     if (@$summary) {
1566         $summary = $summary->[0];
1567     } else {
1568         my $class = "Fieldmapper::serial::${type}_summary";
1569         $summary = $class->new;
1570         $summary->distribution($sdist->id);
1571         $cu_method = "create";
1572     }
1573
1574     $summary->generated_coverage(OpenSRF::Utils::JSON->perl2JSON($formatted_parts));
1575     my $method = "${cu_method}_serial_${type}_summary";
1576     return $e->die_event unless $e->$method($summary);
1577 }
1578
1579 sub _unit_by_iss_and_str {
1580     my ($e, $issuance, $stream) = @_;
1581
1582     my $unit = $e->json_query({
1583         "select" => {"sunit" => ["id"]},
1584         "from" => {"sitem" => {"sunit" => {}}},
1585         "where" => {
1586             "+sitem" => {
1587                 "issuance" => $issuance->id,
1588                 "stream" => $stream->id
1589             }
1590         }
1591     }) or return $e->die_event;
1592     return 0 if not @$unit;
1593
1594     $e->retrieve_serial_unit($unit->[0]->{"id"}) or $e->die_event;
1595 }
1596
1597 sub move_previous_unit {
1598     my ($e, $prev_iss, $curr_item, $new_loc) = @_;
1599
1600     my $prev_unit = _unit_by_iss_and_str($e,$prev_iss,$curr_item->stream);
1601     return $prev_unit if defined $U->event_code($prev_unit);
1602     return 0 if not $prev_unit;
1603
1604     if ($prev_unit->location != $new_loc) {
1605         $prev_unit->location($new_loc);
1606         $e->update_serial_unit($prev_unit) or return $e->die_event;
1607     }
1608     0;
1609 }
1610
1611 # _previous_issuance() assumes $existing is an ordered array
1612 sub _previous_issuance {
1613     my ($existing, $issuance) = @_;
1614
1615     my $last = $existing->[-1];
1616     return undef unless $last;
1617     return ($last->id == $issuance->id ? $existing->[-2] : $last);
1618 }
1619
1620 __PACKAGE__->register_method(
1621     "method" => "receive_items_one_unit_per",
1622     "api_name" => "open-ils.serial.receive_items.one_unit_per",
1623     "stream" => 1,
1624     "api_level" => 1,
1625     "argc" => 3,
1626     "signature" => {
1627         "desc" => "Marks items in a list as received, creates a new unit for each item if any unit is fleshed on, and updates summaries as needed",
1628         "params" => [
1629             {
1630                  "name" => "auth",
1631                  "desc" => "authtoken",
1632                  "type" => "string"
1633             },
1634             {
1635                  "name" => "items",
1636                  "desc" => "array of serial items, possibly fleshed with units and definitely fleshed with stream->distribution",
1637                  "type" => "array"
1638             },
1639             {
1640                 "name" => "record",
1641                 "desc" => "id of bib record these items are associated with
1642                     (XXX could/should be derived from items)",
1643                 "type" => "number"
1644             }
1645         ],
1646         "return" => {
1647             "desc" => "The item ID for each item successfully received",
1648             "type" => "int"
1649         }
1650     }
1651 );
1652
1653 sub receive_items_one_unit_per {
1654     # XXX This function may be temporary, as it does some of what
1655     # unitize_items() does, just in a different way.
1656     my ($self, $client, $auth, $items, $record) = @_;
1657
1658     my $e = new_editor("authtoken" => $auth, "xact" => 1);
1659     return $e->die_event unless $e->checkauth;
1660     return $e->die_event unless $e->allowed("RECEIVE_SERIAL");
1661
1662     my $prev_loc_setting_map = {};
1663     my $user_id = $e->requestor->id;
1664
1665     # Get a list of all the non-virtual field names in a serial::unit for
1666     # merging given unit objects with template-built units later.
1667     # XXX move this somewhere global so it isn't re-run all the time
1668     my $all_unit_fields =
1669         $Fieldmapper::fieldmap->{"Fieldmapper::serial::unit"}->{"fields"};
1670     my @real_unit_fields = grep {
1671         not $all_unit_fields->{$_}->{"virtual"}
1672     } keys %$all_unit_fields;
1673
1674     foreach my $item (@$items) {
1675         # Note that we expect a certain fleshing on the items we're getting.
1676         my $sdist = $item->stream->distribution;
1677
1678         # Fetch a list of issuances with received copies already existing
1679         # on this distribution (and with the same holding type on the
1680         # issuance).  This will be used in up to two places: once when building
1681         # a summary, once when changing the copy location of the previous
1682         # issuance's copy.
1683         my $issuances_received = _issuances_received($e, $item);
1684         if ($U->event_code($issuances_received)) {
1685             $e->rollback;
1686             return $issuances_received;
1687         }
1688
1689         # Find out if we need to to deal with previous copy location changing.
1690         my $ou = $sdist->holding_lib->id;
1691         unless (exists $prev_loc_setting_map->{$ou}) {
1692             $prev_loc_setting_map->{$ou} = $U->ou_ancestor_setting_value(
1693                 $ou, "serial.prev_issuance_copy_location", $e
1694             );
1695         }
1696
1697         # If there is a previous copy location setting, we need the previous
1698         # issuance, from which we can in turn look up the item attached to the
1699         # same stream we're on now.
1700         if ($prev_loc_setting_map->{$ou}) {
1701             if (my $prev_iss =
1702                 _previous_issuance($issuances_received, $item->issuance)) {
1703
1704                 # Now we can change the copy location of the previous unit,
1705                 # if needed.
1706                 return $e->event if defined $U->event_code(
1707                     move_previous_unit(
1708                         $e, $prev_iss, $item, $prev_loc_setting_map->{$ou}
1709                     )
1710                 );
1711             }
1712         }
1713
1714         # Create unit if given by user
1715         if (ref $item->unit) {
1716             # detach from the item, as we need to create separately
1717             my $user_unit = $item->unit;
1718
1719             # get a unit based on associated template
1720             my $template_unit = _build_unit($e, $sdist, "receive");
1721             if ($U->event_code($template_unit)) {
1722                 $e->rollback;
1723                 $template_unit->{"note"} = "Item ID: " . $item->id;
1724                 return $template_unit;
1725             }
1726
1727             # merge built unit with provided unit from user
1728             foreach (@real_unit_fields) {
1729                 unless ($user_unit->$_) {
1730                     $user_unit->$_($template_unit->$_);
1731                 }
1732             }
1733
1734             # Treat call number specially: the provided value from the
1735             # user will really be a string.
1736             my $call_number_string;
1737             if ($user_unit->call_number) {
1738                 $call_number_string = $user_unit->call_number;
1739                 # clear call number for now (replaced in _prepare_unit)
1740                 $user_unit->clear_call_number;
1741             }
1742
1743             my $evt = _prepare_unit(
1744                 $e, $user_unit, $sdist, [$item->issuance],
1745                 $call_number_string, $record
1746             );
1747             if ($U->event_code($evt)) {
1748                 $e->rollback;
1749                 return $evt;
1750             }
1751
1752             # create/update summary objects related to this distribution
1753             # Make sure @$issuances_received contains current item's issuance
1754             unless (grep { $_->id == $item->issuance->id } @$issuances_received) {
1755                 push @$issuances_received, $item->issuance;
1756             }
1757             $evt = _prepare_summaries($e, $issuances_received, $item->stream->distribution, $item->issuance->holding_type);
1758             if ($U->event_code($evt)) {
1759                 $e->rollback;
1760                 return $evt;
1761             }
1762
1763             # set the incontrovertibles on the unit
1764             $user_unit->edit_date("now");
1765             $user_unit->create_date("now");
1766             $user_unit->editor($user_id);
1767             $user_unit->creator($user_id);
1768
1769             $evt = _create_sunit($e, $user_unit);
1770             return $evt if $evt;
1771
1772             # save reference to new unit
1773             $item->unit($e->data->id);
1774         }
1775
1776         # Create notes if given by user
1777         if (ref($item->notes) and @{$item->notes}) {
1778             foreach my $note (@{$item->notes}) {
1779                 $note->creator($user_id);
1780                 $note->create_date("now");
1781
1782                 return $e->die_event unless $e->create_serial_item_note($note);
1783             }
1784
1785             $item->clear_notes; # They're saved; we no longer want them here.
1786         }
1787
1788         # Set the incontrovertibles on the item
1789         $item->status("Received");
1790         $item->date_received("now");
1791         $item->edit_date("now");
1792         $item->editor($user_id);
1793
1794         return $e->die_event unless $e->update_serial_item($item);
1795
1796         # send client a response
1797         $client->respond($item->id);
1798     }
1799
1800     $e->commit or return $e->die_event;
1801     undef;
1802 }
1803
1804 sub _build_unit {
1805     my $editor = shift;
1806     my $sdist = shift;
1807     my $mode = shift;
1808     #my $skip_call_number = shift;
1809
1810     my $attr = $mode . '_unit_template';
1811     my $template = $editor->retrieve_asset_copy_template($sdist->$attr) or
1812         return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_COPY_TEMPLATE");
1813
1814     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 );
1815
1816     my $unit = new Fieldmapper::serial::unit;
1817     foreach my $part (@parts) {
1818         my $value = $template->$part;
1819         next if !defined($value);
1820         $unit->$part($value);
1821     }
1822
1823     # ignore circ_lib in template, set to distribution holding_lib
1824     $unit->circ_lib($sdist->holding_lib);
1825     $unit->creator($editor->requestor->id);
1826     $unit->editor($editor->requestor->id);
1827
1828 # XXX: this feature has been pushed back until after 2.0 at least
1829 #    unless ($skip_call_number) {
1830 #        $attr = $mode . '_call_number';
1831 #        my $cn = $sdist->$attr or
1832 #            return new OpenILS::Event("SERIAL_DISTRIBUTION_HAS_NO_CALL_NUMBER");
1833 #
1834 #        $unit->call_number($cn);
1835 #    }
1836     $unit->call_number('-1'); # default to the dummy call number
1837     $unit->barcode('@@PLACEHOLDER'); # generic unit will start with a generated placeholder barcode
1838     $unit->sort_key('');
1839     $unit->summary_contents('');
1840     $unit->detailed_contents('');
1841
1842     return $unit;
1843 }
1844
1845 sub _summarize_contents {
1846     my $editor = shift;
1847     my $issuances = shift;
1848     my $sdist = shift;
1849
1850     # create or lookup MFHD record
1851     my $mfhd;
1852     if ($sdist and defined($sdist->record_entry) and $sdist->summary_method eq 'merge_with_sre') {
1853         my $sre;
1854         if (ref $sdist->record_entry) {
1855             $sre = $sdist->record_entry;
1856         } else {
1857             $sre = $editor->retrieve_serial_record_entry($sdist->record_entry);
1858         }
1859         $mfhd = MFHD->new(MARC::Record->new_from_xml($sre->marc));
1860     } else {
1861         $logger->info($sdist);
1862         $mfhd = MFHD->new(MARC::Record->new());
1863     }
1864
1865     my %scaps;
1866     my %scap_fields;
1867     my $seqno = 1;
1868     # We keep track of these separately to avoid link_id contamination,
1869     # e.g. a basic issuance, followed by a merging supplement, followed by
1870     # another basic.  If we could be sure that they were not mixed, one
1871     # value could suffice.
1872     my %link_ids = ('basic' => 10000, 'index' => 10000, 'supplement' => 10000);
1873     my %first_scap = ('basic' => 1, 'index' => 1, 'supplement' => 1);
1874     foreach my $issuance (@$issuances) {
1875         my $scap_id = $issuance->caption_and_pattern;
1876         next if (!$scap_id); # skip issuances with no caption/pattern
1877
1878         my $scap;
1879         my $scap_field;
1880         # if this is the first appearance of this scap, retrieve it and add it to the temporary record
1881         if (!exists $scaps{$issuance->caption_and_pattern}) {
1882             $scaps{$scap_id} = $editor->retrieve_serial_caption_and_pattern($scap_id);
1883             $scap = $scaps{$scap_id};
1884             $scap_field = _revive_caption($scap);
1885             my $did_merge = 0;
1886             if ($first_scap{$scap->type}) { # special merge processing
1887                 $first_scap{$MFHD_TAGS_BY_NAME{$scap->type}} = 0;
1888                 if ($sdist and $sdist->summary_method eq 'merge_with_sre') {
1889                     # MFHD Caption objects do not yet have a built-in compare (TODO), so let's do a basic one
1890                     my @field_85xs = $mfhd->field($MFHD_TAGS_BY_NAME{$scap->type});
1891                     if (@field_85xs) {
1892                         my $last_caption_field = $field_85xs[-1];
1893                         my $last_link_id = $last_caption_field->subfield('8');
1894                         # set the link id to match, temporarily, for comparison
1895                         $last_caption_field->update('8' => $scap_field->subfield('8'));
1896                         my $last_caption_json = OpenSRF::Utils::JSON->perl2JSON([$last_caption_field->indicator(1), $last_caption_field->indicator(2), $last_caption_field->subfields_list]);
1897                         if ($last_caption_json eq $scap->pattern_code) { # merge is possible, they match
1898                             # restore link id
1899                             $link_ids{$scap->type} = $last_link_id;
1900                             # set scap_field to last field
1901                             $scap_field = $last_caption_field;
1902                             $did_merge = 1;
1903                         }
1904                     }
1905                 }
1906             }
1907             $scap_fields{$scap_id} = $scap_field;
1908             $scap_field->update('8' => $link_ids{$scap->type});
1909             # TODO: make MFHD/Caption smarter about this
1910             $scap_field->{_mfhdc_LINK_ID} = $link_ids{$scap->type};
1911             $mfhd->append_fields($scap_field) if !$did_merge;
1912             $link_ids{$scap->type}++;
1913         } else {
1914             $scap_field = $scap_fields{$scap_id};
1915         }
1916
1917         $mfhd->append_fields(_revive_holding($issuance->holding_code, $scap_field, $seqno));
1918         $seqno++;
1919     }
1920
1921     my @formatted_parts;
1922     my @scap_fields_ordered = $mfhd->field('85[345]');
1923
1924     foreach my $scap_field (@scap_fields_ordered) { #TODO: use generic MFHD "summarize" method, once available
1925         my @updated_holdings;
1926         eval {
1927             @updated_holdings = $mfhd->get_combined_holdings($scap_field);
1928         };
1929         if ($@) {
1930             my $msg = "get_combined_holdings(): $@ ; using sdist ID #" .
1931                 ($sdist ? $sdist->id : "<NONE>") . " and " .
1932                 scalar(@$issuances) . " issuances, of which one has ID #" .
1933                 $issuances->[0]->id;
1934
1935             $msg =~ s/\n//gm;
1936             $logger->error($msg);
1937             return new OpenILS::Event("BAD_PARAMS", note => $msg);
1938         }
1939
1940         push @formatted_parts, map { $_->format } @updated_holdings;
1941     }
1942
1943     return ($mfhd, \@formatted_parts);
1944 }
1945
1946 ##########################################################################
1947 # note methods
1948 #
1949 __PACKAGE__->register_method(
1950     method      => 'fetch_notes',
1951     api_name        => 'open-ils.serial.item_note.retrieve.all',
1952     signature   => q/
1953         Returns an array of copy note objects.
1954         @param args A named hash of parameters including:
1955             authtoken   : Required if viewing non-public notes
1956             item_id      : The id of the item whose notes we want to retrieve
1957             pub         : True if all the caller wants are public notes
1958         @return An array of note objects
1959     /
1960 );
1961
1962 __PACKAGE__->register_method(
1963     method      => 'fetch_notes',
1964     api_name        => 'open-ils.serial.subscription_note.retrieve.all',
1965     signature   => q/
1966         Returns an array of copy note objects.
1967         @param args A named hash of parameters including:
1968             authtoken       : Required if viewing non-public notes
1969             subscription_id : The id of the item whose notes we want to retrieve
1970             pub             : True if all the caller wants are public notes
1971         @return An array of note objects
1972     /
1973 );
1974
1975 __PACKAGE__->register_method(
1976     method      => 'fetch_notes',
1977     api_name        => 'open-ils.serial.distribution_note.retrieve.all',
1978     signature   => q/
1979         Returns an array of copy note objects.
1980         @param args A named hash of parameters including:
1981             authtoken       : Required if viewing non-public notes
1982             distribution_id : The id of the item whose notes we want to retrieve
1983             pub             : True if all the caller wants are public notes
1984         @return An array of note objects
1985     /
1986 );
1987
1988 # TODO: revisit this method to consider replacing cstore direct calls
1989 sub fetch_notes {
1990     my( $self, $connection, $args ) = @_;
1991
1992     $self->api_name =~ /serial\.(\w*)_note/;
1993     my $type = $1;
1994
1995     my $id = $$args{object_id};
1996     my $authtoken = $$args{authtoken};
1997     my $order_by = $$args{order_by} || 'create_date';
1998     my( $r, $evt);
1999
2000     if( $$args{pub} ) {
2001         return $U->cstorereq(
2002             'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic',
2003             { $type => $id, pub => 't' }, {'order_by' => {$FM_NAME_TO_ID{$type}.'n' => $order_by}} );
2004     } else {
2005         # FIXME: restore perm check
2006         # ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
2007         # return $evt if $evt;
2008         return $U->cstorereq(
2009             'open-ils.cstore.direct.serial.'.$type.'_note.search.atomic', {$type => $id}, {'order_by' => {$FM_NAME_TO_ID{$type}.'n' => $order_by}} );
2010     }
2011
2012     return undef;
2013 }
2014
2015 __PACKAGE__->register_method(
2016     method      => 'update_note',
2017     api_name        => 'open-ils.serial.item_note.update',
2018     signature   => q/
2019         Updates or creates an item note
2020         @param authtoken The login session key
2021         @param note The note object to update or create
2022         @return The id of the note object
2023     /
2024 );
2025
2026 __PACKAGE__->register_method(
2027     method      => 'update_note',
2028     api_name        => 'open-ils.serial.subscription_note.update',
2029     signature   => q/
2030         Updates or creates a subscription note
2031         @param authtoken The login session key
2032         @param note The note object to update or create
2033         @return The id of the note object
2034     /
2035 );
2036
2037 __PACKAGE__->register_method(
2038     method      => 'update_note',
2039     api_name        => 'open-ils.serial.distribution_note.update',
2040     signature   => q/
2041         Updates or creates a distribution note
2042         @param authtoken The login session key
2043         @param note The note object to update or create
2044         @return The id of the note object
2045     /
2046 );
2047
2048 sub update_note {
2049     my( $self, $connection, $authtoken, $note ) = @_;
2050
2051     $self->api_name =~ /serial\.(\w*)_note/;
2052     my $type = $1;
2053
2054     my $e = new_editor(xact=>1, authtoken=>$authtoken);
2055     return $e->event unless $e->checkauth;
2056
2057     if ($type eq 'item') {
2058         my $sitem = $e->retrieve_serial_item([
2059             $note->item, {
2060                 "flesh" => 2, "flesh_fields" => {
2061                     "sitem" => ["stream"], "sstr" => ["distribution"]
2062                 }
2063             }
2064         ]) or return $e->die_event;
2065
2066         return $e->die_event unless $e->allowed(
2067             "ADMIN_SERIAL_ITEM", $sitem->stream->distribution->holding_lib
2068         );
2069     } elsif ($type eq 'distribution') {
2070         my $sdist = $e->retrieve_serial_distribution($note->distribution)
2071             or return $e->die_event;
2072
2073         return $e->die_event unless
2074             $e->allowed("ADMIN_SERIAL_DISTRIBUTION", $sdist->holding_lib);
2075     } else { # subscription
2076         my $sub = $e->retrieve_serial_subscription($note->subscription)
2077             or return $e->die_event;
2078
2079         return $e->die_event unless
2080             $e->allowed("ADMIN_SERIAL_SUBSCRIPTION", $sub->owning_lib);
2081     }
2082
2083     $note->pub( ($U->is_true($note->pub)) ? 't' : 'f' );
2084     my $method;
2085     if ($note->isnew) {
2086         $note->create_date('now');
2087         $note->creator($e->requestor->id);
2088         $note->clear_id;
2089         $method = "create_serial_${type}_note";
2090     } else {
2091         $method = "update_serial_${type}_note";
2092     }
2093     $e->$method($note) or return $e->event;
2094     $e->commit;
2095     return $note->id;
2096 }
2097
2098 __PACKAGE__->register_method(
2099     method      => 'delete_note',
2100     api_name        =>  'open-ils.serial.item_note.delete',
2101     signature   => q/
2102         Deletes an existing item note
2103         @param authtoken The login session key
2104         @param noteid The id of the note to delete
2105         @return 1 on success - Event otherwise.
2106         /
2107 );
2108
2109 __PACKAGE__->register_method(
2110     method      => 'delete_note',
2111     api_name        =>  'open-ils.serial.subscription_note.delete',
2112     signature   => q/
2113         Deletes an existing subscription note
2114         @param authtoken The login session key
2115         @param noteid The id of the note to delete
2116         @return 1 on success - Event otherwise.
2117         /
2118 );
2119
2120 __PACKAGE__->register_method(
2121     method      => 'delete_note',
2122     api_name        =>  'open-ils.serial.distribution_note.delete',
2123     signature   => q/
2124         Deletes an existing distribution note
2125         @param authtoken The login session key
2126         @param noteid The id of the note to delete
2127         @return 1 on success - Event otherwise.
2128         /
2129 );
2130
2131 sub delete_note {
2132     my( $self, $conn, $authtoken, $noteid ) = @_;
2133
2134     $self->api_name =~ /serial\.(\w*)_note/;
2135     my $type = $1;
2136
2137     my $e = new_editor(xact=>1, authtoken=>$authtoken);
2138     return $e->die_event unless $e->checkauth;
2139
2140     my $method = "retrieve_serial_${type}_note";
2141     my $note = $e->$method([
2142         $noteid,
2143     ]) or return $e->die_event;
2144
2145     if ($type eq 'item') {
2146         my $sitem = $e->retrieve_serial_item([
2147             $note->item, {
2148                 "flesh" => 2, "flesh_fields" => {
2149                     "sitem" => ["stream"], "sstr" => ["distribution"]
2150                 }
2151             }
2152         ]) or return $e->die_event;
2153
2154         return $e->die_event unless $e->allowed(
2155             "ADMIN_SERIAL_ITEM", $sitem->stream->distribution->holding_lib
2156         );
2157     } elsif ($type eq 'distribution') {
2158         my $sdist = $e->retrieve_serial_distribution($note->distribution)
2159             or return $e->die_event;
2160
2161         return $e->die_event unless
2162             $e->allowed("ADMIN_SERIAL_DISTRIBUTION", $sdist->holding_lib);
2163     } else { # subscription
2164         my $sub = $e->retrieve_serial_subscription($note->subscription)
2165             or return $e->die_event;
2166
2167         return $e->die_event unless
2168             $e->allowed("ADMIN_SERIAL_SUBSCRIPTION", $sub->owning_lib);
2169     }
2170
2171     $method = "delete_serial_${type}_note";
2172     $e->$method($note) or return $e->die_event;
2173     $e->commit;
2174     return 1;
2175 }
2176
2177
2178 ##########################################################################
2179 # subscription methods
2180 #
2181 __PACKAGE__->register_method(
2182     method    => 'fleshed_ssub_alter',
2183     api_name  => 'open-ils.serial.subscription.fleshed.batch.update',
2184     api_level => 1,
2185     argc      => 2,
2186     signature => {
2187         desc     => 'Receives an array of one or more subscriptions and updates the database as needed',
2188         'params' => [ {
2189                  name => 'authtoken',
2190                  desc => 'Authtoken for current user session',
2191                  type => 'string'
2192             },
2193             {
2194                  name => 'subscriptions',
2195                  desc => 'Array of fleshed subscriptions',
2196                  type => 'array'
2197             }
2198
2199         ],
2200         'return' => {
2201             desc => 'Returns 1 if successful, event if failed',
2202             type => 'mixed'
2203         }
2204     }
2205 );
2206
2207 sub fleshed_ssub_alter {
2208     my( $self, $conn, $auth, $ssubs ) = @_;
2209     return 1 unless ref $ssubs;
2210     my( $reqr, $evt ) = $U->checkses($auth);
2211     return $evt if $evt;
2212     my $editor = new_editor(requestor => $reqr, xact => 1);
2213     my $override = $self->api_name =~ /override/;
2214
2215     for my $ssub (@$ssubs) {
2216         my $owning_lib_id = ref $ssub->owning_lib ? $ssub->owning_lib->id : $ssub->owning_lib;
2217         return $editor->die_event unless
2218             $editor->allowed("ADMIN_SERIAL_SUBSCRIPTION", $owning_lib_id);
2219
2220         my $ssubid = $ssub->id;
2221
2222         if( $ssub->isdeleted ) {
2223             $evt = _delete_ssub( $editor, $override, $ssub);
2224         } elsif( $ssub->isnew ) {
2225             _cleanse_dates($ssub, ['start_date','end_date']);
2226             $evt = _create_ssub( $editor, $ssub );
2227         } else {
2228             _cleanse_dates($ssub, ['start_date','end_date']);
2229             $evt = _update_ssub( $editor, $override, $ssub );
2230         }
2231     }
2232
2233     if( $evt ) {
2234         $logger->info("fleshed subscription-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2235         $editor->rollback;
2236         return $evt;
2237     }
2238     $logger->debug("subscription-alter: done updating subscription batch");
2239     $editor->commit;
2240     $logger->info("fleshed subscription-alter successfully updated ".scalar(@$ssubs)." subscriptions");
2241     return 1;
2242 }
2243
2244 sub _delete_ssub {
2245     my ($editor, $override, $ssub) = @_;
2246     $logger->info("subscription-alter: delete subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
2247     my $sdists = $editor->search_serial_distribution(
2248             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
2249     my $cps = $editor->search_serial_caption_and_pattern(
2250             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
2251     my $sisses = $editor->search_serial_issuance(
2252             { subscription => $ssub->id }, { limit => 1 } ); #TODO: 'deleted' support?
2253     return OpenILS::Event->new(
2254             'SERIAL_SUBSCRIPTION_NOT_EMPTY', payload => $ssub->id ) if (@$sdists or @$cps or @$sisses);
2255
2256     return $editor->event unless $editor->delete_serial_subscription($ssub);
2257     return 0;
2258 }
2259
2260 sub _create_ssub {
2261     my ($editor, $ssub) = @_;
2262
2263     $logger->info("subscription-alter: new subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
2264     return $editor->event unless $editor->create_serial_subscription($ssub);
2265     return 0;
2266 }
2267
2268 sub _update_ssub {
2269     my ($editor, $override, $ssub) = @_;
2270
2271     $logger->info("subscription-alter: retrieving subscription ".$ssub->id);
2272     my $orig_ssub = $editor->retrieve_serial_subscription($ssub->id);
2273
2274     $logger->info("subscription-alter: original subscription ".OpenSRF::Utils::JSON->perl2JSON($orig_ssub));
2275     $logger->info("subscription-alter: updated subscription ".OpenSRF::Utils::JSON->perl2JSON($ssub));
2276     return $editor->event unless $editor->update_serial_subscription($ssub);
2277     return 0;
2278 }
2279
2280 __PACKAGE__->register_method(
2281     method  => "fleshed_serial_subscription_retrieve_batch",
2282     authoritative => 1,
2283     api_name    => "open-ils.serial.subscription.fleshed.batch.retrieve"
2284 );
2285
2286 sub fleshed_serial_subscription_retrieve_batch {
2287     my( $self, $client, $ids ) = @_;
2288 # FIXME: permissions?
2289     $logger->info("Fetching fleshed subscriptions @$ids");
2290     return $U->cstorereq(
2291         "open-ils.cstore.direct.serial.subscription.search.atomic",
2292         { id => $ids },
2293         { flesh => 1,
2294           flesh_fields => {ssub => [ qw/owning_lib notes/ ]}
2295         });
2296 }
2297
2298 __PACKAGE__->register_method(
2299     method  => "retrieve_sub_tree",
2300     authoritative => 1,
2301     api_name    => "open-ils.serial.subscription_tree.retrieve"
2302 );
2303
2304 __PACKAGE__->register_method(
2305     method  => "retrieve_sub_tree",
2306     api_name    => "open-ils.serial.subscription_tree.global.retrieve"
2307 );
2308
2309 sub retrieve_sub_tree {
2310
2311     my( $self, $client, $user_session, $docid, @org_ids ) = @_;
2312
2313     if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
2314
2315     $docid = "$docid";
2316
2317     # TODO: permission support
2318     if(!@org_ids and $user_session) {
2319         my $user_obj =
2320             OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
2321             @org_ids = ($user_obj->home_ou);
2322     }
2323
2324     if( $self->api_name =~ /global/ ) {
2325         return _build_subs_list( { record_entry => $docid } ); # TODO: filter for !deleted, or active?
2326
2327     } else {
2328
2329         my @all_subs;
2330         for my $orgid (@org_ids) {
2331             my $subs = _build_subs_list(
2332                     { record_entry => $docid, owning_lib => $orgid } );# TODO: filter for !deleted, or active?
2333             push( @all_subs, @$subs );
2334         }
2335
2336         return \@all_subs;
2337     }
2338
2339     return undef;
2340 }
2341
2342 sub _build_subs_list {
2343     my $search_hash = shift;
2344
2345     #$search_hash->{deleted} = 'f';
2346     my $e = new_editor();
2347
2348     my $subs = $e->search_serial_subscription([$search_hash, { 'order_by' => {'ssub' => 'id'} }]);
2349
2350     my @built_subs;
2351
2352     for my $sub (@$subs) {
2353
2354         # TODO: filter on !deleted?
2355         my $dists = $e->search_serial_distribution(
2356             [{ subscription => $sub->id }, { 'order_by' => {'sdist' => 'label'} }]
2357             );
2358
2359         #$dists = [ sort { $a->label cmp $b->label } @$dists  ];
2360
2361         $sub->distributions($dists);
2362
2363         # TODO: filter on !deleted?
2364         my $issuances = $e->search_serial_issuance(
2365             [{ subscription => $sub->id }, { 'order_by' => {'siss' => 'label'} }]
2366             );
2367
2368         #$issuances = [ sort { $a->label cmp $b->label } @$issuances  ];
2369         $sub->issuances($issuances);
2370
2371         # TODO: filter on !deleted?
2372         my $scaps = $e->search_serial_caption_and_pattern(
2373             [{ subscription => $sub->id }, { 'order_by' => {'scap' => 'id'} }]
2374             );
2375
2376         #$scaps = [ sort { $a->id cmp $b->id } @$scaps  ];
2377         $sub->scaps($scaps);
2378         push( @built_subs, $sub );
2379     }
2380
2381     return \@built_subs;
2382
2383 }
2384
2385 __PACKAGE__->register_method(
2386     method  => "subscription_orgs_for_title",
2387     authoritative => 1,
2388     api_name    => "open-ils.serial.subscription.retrieve_orgs_by_title"
2389 );
2390
2391 sub subscription_orgs_for_title {
2392     my( $self, $client, $record_id ) = @_;
2393
2394     my $subs = $U->simple_scalar_request(
2395         "open-ils.cstore",
2396         "open-ils.cstore.direct.serial.subscription.search.atomic",
2397         { record_entry => $record_id }); # TODO: filter on !deleted?
2398
2399     my $orgs = { map {$_->owning_lib => 1 } @$subs };
2400     return [ keys %$orgs ];
2401 }
2402
2403
2404 ##########################################################################
2405 # distribution methods
2406 #
2407 __PACKAGE__->register_method(
2408     method    => 'fleshed_sdist_alter',
2409     api_name  => 'open-ils.serial.distribution.fleshed.batch.update',
2410     api_level => 1,
2411     argc      => 2,
2412     signature => {
2413         desc     => 'Receives an array of one or more distributions and updates the database as needed',
2414         'params' => [ {
2415                  name => 'authtoken',
2416                  desc => 'Authtoken for current user session',
2417                  type => 'string'
2418             },
2419             {
2420                  name => 'distributions',
2421                  desc => 'Array of fleshed distributions',
2422                  type => 'array'
2423             }
2424
2425         ],
2426         'return' => {
2427             desc => 'Returns 1 if successful, event if failed',
2428             type => 'mixed'
2429         }
2430     }
2431 );
2432
2433 sub fleshed_sdist_alter {
2434     my( $self, $conn, $auth, $sdists ) = @_;
2435     return 1 unless ref $sdists;
2436     my( $reqr, $evt ) = $U->checkses($auth);
2437     return $evt if $evt;
2438     my $editor = new_editor(requestor => $reqr, xact => 1);
2439     my $override = $self->api_name =~ /override/;
2440
2441     for my $sdist (@$sdists) {
2442         my $holding_lib_id = ref $sdist->holding_lib ? $sdist->holding_lib->id : $sdist->holding_lib;
2443         return $editor->die_event unless
2444             $editor->allowed("ADMIN_SERIAL_DISTRIBUTION", $holding_lib_id);
2445
2446         if( $sdist->isdeleted ) {
2447             $evt = _delete_sdist( $editor, $override, $sdist);
2448         } elsif( $sdist->isnew ) {
2449             $evt = _create_sdist( $editor, $sdist );
2450         } else {
2451             $evt = _update_sdist( $editor, $override, $sdist );
2452         }
2453     }
2454
2455     if( $evt ) {
2456         $logger->info("fleshed distribution-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2457         $editor->rollback;
2458         return $evt;
2459     }
2460     $logger->debug("distribution-alter: done updating distribution batch");
2461     $editor->commit;
2462     $logger->info("fleshed distribution-alter successfully updated ".scalar(@$sdists)." distributions");
2463     return 1;
2464 }
2465
2466 sub _delete_sdist {
2467     my ($editor, $override, $sdist) = @_;
2468     $logger->info("distribution-alter: delete distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
2469     return $editor->event unless $editor->delete_serial_distribution($sdist);
2470     return 0;
2471 }
2472
2473 sub _create_sdist {
2474     my ($editor, $sdist) = @_;
2475
2476     $logger->info("distribution-alter: new distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
2477     return $editor->event unless $editor->create_serial_distribution($sdist);
2478
2479     # create summaries too
2480     my $summary = new Fieldmapper::serial::basic_summary;
2481     $summary->distribution($sdist->id);
2482     $summary->generated_coverage('');
2483     return $editor->event unless $editor->create_serial_basic_summary($summary);
2484     $summary = new Fieldmapper::serial::supplement_summary;
2485     $summary->distribution($sdist->id);
2486     $summary->generated_coverage('');
2487     return $editor->event unless $editor->create_serial_supplement_summary($summary);
2488     $summary = new Fieldmapper::serial::index_summary;
2489     $summary->distribution($sdist->id);
2490     $summary->generated_coverage('');
2491     return $editor->event unless $editor->create_serial_index_summary($summary);
2492
2493     # create a starter stream (TODO: reconsider this)
2494     my $stream = new Fieldmapper::serial::stream;
2495     $stream->distribution($sdist->id);
2496     return $editor->event unless $editor->create_serial_stream($stream);
2497
2498     return 0;
2499 }
2500
2501 sub _update_sdist {
2502     my ($editor, $override, $sdist) = @_;
2503
2504     $logger->info("distribution-alter: retrieving distribution ".$sdist->id);
2505     my $orig_sdist = $editor->retrieve_serial_distribution($sdist->id);
2506
2507     $logger->info("distribution-alter: original distribution ".OpenSRF::Utils::JSON->perl2JSON($orig_sdist));
2508     $logger->info("distribution-alter: updated distribution ".OpenSRF::Utils::JSON->perl2JSON($sdist));
2509     return $editor->event unless $editor->update_serial_distribution($sdist);
2510     return 0;
2511 }
2512
2513 __PACKAGE__->register_method(
2514     method  => "fleshed_serial_distribution_retrieve_batch",
2515     authoritative => 1,
2516     api_name    => "open-ils.serial.distribution.fleshed.batch.retrieve"
2517 );
2518
2519 sub fleshed_serial_distribution_retrieve_batch {
2520     my( $self, $client, $ids ) = @_;
2521 # FIXME: permissions?
2522     $logger->info("Fetching fleshed distributions @$ids");
2523     return $U->cstorereq(
2524         "open-ils.cstore.direct.serial.distribution.search.atomic",
2525         { id => $ids },
2526         { flesh => 1,
2527           flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams notes / ]}
2528         });
2529 }
2530
2531 __PACKAGE__->register_method(
2532     method  => "retrieve_dist_tree",
2533     authoritative => 1,
2534     api_name    => "open-ils.serial.distribution_tree.retrieve"
2535 );
2536
2537 __PACKAGE__->register_method(
2538     method  => "retrieve_dist_tree",
2539     api_name    => "open-ils.serial.distribution_tree.global.retrieve"
2540 );
2541
2542 sub retrieve_dist_tree {
2543     my( $self, $client, $user_session, $docid, @org_ids ) = @_;
2544
2545     if(ref($org_ids[0])) { @org_ids = @{$org_ids[0]}; }
2546
2547     $docid = "$docid";
2548
2549     # TODO: permission support
2550     if(!@org_ids and $user_session) {
2551         my $user_obj =
2552             OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
2553             @org_ids = ($user_obj->home_ou);
2554     }
2555
2556     my $e = new_editor();
2557
2558     if( $self->api_name =~ /global/ ) {
2559         return $e->search_serial_distribution([{'+ssub' => { record_entry => $docid }},
2560             {   flesh => 1,
2561                 flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams basic_summary supplement_summary index_summary / ]},
2562                 order_by => {'sdist' => 'id'},
2563                 'join' => {'ssub' => {}}
2564             }
2565         ]); # TODO: filter for !deleted?
2566
2567     } else {
2568         my @all_dists;
2569         for my $orgid (@org_ids) {
2570             my $dists = $e->search_serial_distribution([{'+ssub' => { record_entry => $docid }, holding_lib => $orgid},
2571                 {   flesh => 1,
2572                     flesh_fields => {sdist => [ qw/ holding_lib receive_call_number receive_unit_template bind_call_number bind_unit_template streams basic_summary supplement_summary index_summary / ]},
2573                     order_by => {'sdist' => 'id'},
2574                     'join' => {'ssub' => {}}
2575                 }
2576             ]); # TODO: filter for !deleted?
2577             push( @all_dists, @$dists ) if $dists;
2578         }
2579
2580         return \@all_dists;
2581     }
2582
2583     return undef;
2584 }
2585
2586
2587 __PACKAGE__->register_method(
2588     method  => "distribution_orgs_for_title",
2589     authoritative => 1,
2590     api_name    => "open-ils.serial.distribution.retrieve_orgs_by_title"
2591 );
2592
2593 sub distribution_orgs_for_title {
2594     my( $self, $client, $record_id ) = @_;
2595
2596     my $dists = $U->cstorereq(
2597         "open-ils.cstore.direct.serial.distribution.search.atomic",
2598         { '+ssub' => { record_entry => $record_id } },
2599         { 'join' => {'ssub' => {}} }); # TODO: filter on !deleted?
2600
2601     my $orgs = { map {$_->holding_lib => 1 } @$dists };
2602     return [ keys %$orgs ];
2603 }
2604
2605
2606 ##########################################################################
2607 # caption and pattern methods
2608 #
2609 __PACKAGE__->register_method(
2610     method    => 'scap_alter',
2611     api_name  => 'open-ils.serial.caption_and_pattern.batch.update',
2612     api_level => 1,
2613     argc      => 2,
2614     signature => {
2615         desc     => 'Receives an array of one or more caption and patterns and updates the database as needed',
2616         'params' => [ {
2617                  name => 'authtoken',
2618                  desc => 'Authtoken for current user session',
2619                  type => 'string'
2620             },
2621             {
2622                  name => 'scaps',
2623                  desc => 'Array of caption and patterns',
2624                  type => 'array'
2625             }
2626
2627         ],
2628         'return' => {
2629             desc => 'Returns 1 if successful, event if failed',
2630             type => 'mixed'
2631         }
2632     }
2633 );
2634
2635 sub scap_alter {
2636     my( $self, $conn, $auth, $scaps ) = @_;
2637     return 1 unless ref $scaps;
2638     my( $reqr, $evt ) = $U->checkses($auth);
2639     return $evt if $evt;
2640     my $editor = new_editor(requestor => $reqr, xact => 1);
2641     my $override = $self->api_name =~ /override/;
2642
2643     my %found_ssub_ids;
2644     for my $scap (@$scaps) {
2645         if (!exists($found_ssub_ids{$scap->subscription})) {
2646             my $ssub = $editor->retrieve_serial_subscription($scap->subscription) or return $editor->die_event;
2647             return $editor->die_event unless
2648                 $editor->allowed("ADMIN_SERIAL_CAPTION_PATTERN", $ssub->owning_lib);
2649             $found_ssub_ids{$scap->subscription} = 1;
2650         }
2651
2652         if( $scap->isdeleted ) {
2653             $evt = _delete_scap( $editor, $override, $scap);
2654         } elsif( $scap->isnew ) {
2655             $evt = _create_scap( $editor, $scap );
2656         } else {
2657             $evt = _update_scap( $editor, $override, $scap );
2658         }
2659     }
2660
2661     if( $evt ) {
2662         $logger->info("caption_and_pattern-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2663         $editor->rollback;
2664         return $evt;
2665     }
2666     $logger->debug("caption_and_pattern-alter: done updating caption_and_pattern batch");
2667     $editor->commit;
2668     $logger->info("caption_and_pattern-alter successfully updated ".scalar(@$scaps)." caption_and_patterns");
2669     return 1;
2670 }
2671
2672 sub _delete_scap {
2673     my ($editor, $override, $scap) = @_;
2674     $logger->info("caption_and_pattern-alter: delete caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2675     my $sisses = $editor->search_serial_issuance(
2676             { caption_and_pattern => $scap->id }, { limit => 1 } ); #TODO: 'deleted' support?
2677     return OpenILS::Event->new(
2678             'SERIAL_CAPTION_AND_PATTERN_HAS_ISSUANCES', payload => $scap->id ) if (@$sisses);
2679
2680     return $editor->event unless $editor->delete_serial_caption_and_pattern($scap);
2681     return 0;
2682 }
2683
2684 sub _create_scap {
2685     my ($editor, $scap) = @_;
2686
2687     $logger->info("caption_and_pattern-alter: new caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2688     return $editor->event unless $editor->create_serial_caption_and_pattern($scap);
2689     return 0;
2690 }
2691
2692 sub _update_scap {
2693     my ($editor, $override, $scap) = @_;
2694
2695     $logger->info("caption_and_pattern-alter: retrieving caption_and_pattern ".$scap->id);
2696     my $orig_scap = $editor->retrieve_serial_caption_and_pattern($scap->id);
2697
2698     $logger->info("caption_and_pattern-alter: original caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($orig_scap));
2699     $logger->info("caption_and_pattern-alter: updated caption_and_pattern ".OpenSRF::Utils::JSON->perl2JSON($scap));
2700     return $editor->event unless $editor->update_serial_caption_and_pattern($scap);
2701     return 0;
2702 }
2703
2704 __PACKAGE__->register_method(
2705     method  => "serial_caption_and_pattern_retrieve_batch",
2706     authoritative => 1,
2707     api_name    => "open-ils.serial.caption_and_pattern.batch.retrieve"
2708 );
2709
2710 sub serial_caption_and_pattern_retrieve_batch {
2711     my( $self, $client, $ids ) = @_;
2712     $logger->info("Fetching caption_and_patterns @$ids");
2713     return $U->cstorereq(
2714         "open-ils.cstore.direct.serial.caption_and_pattern.search.atomic",
2715         { id => $ids }
2716     );
2717 }
2718
2719 ##########################################################################
2720 # stream methods
2721 #
2722 __PACKAGE__->register_method(
2723     method    => 'sstr_alter',
2724     api_name  => 'open-ils.serial.stream.batch.update',
2725     api_level => 1,
2726     argc      => 2,
2727     signature => {
2728         desc     => 'Receives an array of one or more streams and updates the database as needed',
2729         'params' => [ {
2730                  name => 'authtoken',
2731                  desc => 'Authtoken for current user session',
2732                  type => 'string'
2733             },
2734             {
2735                  name => 'sstrs',
2736                  desc => 'Array of streams',
2737                  type => 'array'
2738             }
2739
2740         ],
2741         'return' => {
2742             desc => 'Returns 1 if successful, event if failed',
2743             type => 'mixed'
2744         }
2745     }
2746 );
2747
2748 sub sstr_alter {
2749     my( $self, $conn, $auth, $sstrs ) = @_;
2750     return 1 unless ref $sstrs;
2751     my( $reqr, $evt ) = $U->checkses($auth);
2752     return $evt if $evt;
2753     my $editor = new_editor(requestor => $reqr, xact => 1);
2754     my $override = $self->api_name =~ /override/;
2755
2756     my %found_sdist_ids;
2757     for my $sstr (@$sstrs) {
2758         if (!exists($found_sdist_ids{$sstr->distribution})) {
2759             my $sdist = $editor->retrieve_serial_distribution($sstr->distribution) or return $editor->die_event;
2760             return $editor->die_event unless
2761                 $editor->allowed("ADMIN_SERIAL_STREAM", $sdist->holding_lib);
2762             $found_sdist_ids{$sstr->distribution} = 1;
2763         }
2764
2765         if( $sstr->isdeleted ) {
2766             $evt = _delete_sstr( $editor, $override, $sstr);
2767         } elsif( $sstr->isnew ) {
2768             $evt = _create_sstr( $editor, $sstr );
2769         } else {
2770             $evt = _update_sstr( $editor, $override, $sstr );
2771         }
2772     }
2773
2774     if( $evt ) {
2775         $logger->info("stream-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2776         $editor->rollback;
2777         return $evt;
2778     }
2779     $logger->debug("stream-alter: done updating stream batch");
2780     $editor->commit;
2781     $logger->info("stream-alter successfully updated ".scalar(@$sstrs)." streams");
2782     return 1;
2783 }
2784
2785 sub _delete_sstr {
2786     my ($editor, $override, $sstr) = @_;
2787     $logger->info("stream-alter: delete stream ".OpenSRF::Utils::JSON->perl2JSON($sstr));
2788     my $sitems = $editor->search_serial_item(
2789             { stream => $sstr->id }, { limit => 1 } ); #TODO: 'deleted' support?
2790     return OpenILS::Event->new(
2791             'SERIAL_STREAM_HAS_ITEMS', payload => $sstr->id ) if (@$sitems);
2792
2793     return $editor->event unless $editor->delete_serial_stream($sstr);
2794     return 0;
2795 }
2796
2797 sub _create_sstr {
2798     my ($editor, $sstr) = @_;
2799
2800     $logger->info("stream-alter: new stream ".OpenSRF::Utils::JSON->perl2JSON($sstr));
2801     return $editor->event unless $editor->create_serial_stream($sstr);
2802     return 0;
2803 }
2804
2805 sub _update_sstr {
2806     my ($editor, $override, $sstr) = @_;
2807
2808     $logger->info("stream-alter: retrieving stream ".$sstr->id);
2809     my $orig_sstr = $editor->retrieve_serial_stream($sstr->id);
2810
2811     $logger->info("stream-alter: original stream ".OpenSRF::Utils::JSON->perl2JSON($orig_sstr));
2812     $logger->info("stream-alter: updated stream ".OpenSRF::Utils::JSON->perl2JSON($sstr));
2813     return $editor->event unless $editor->update_serial_stream($sstr);
2814     return 0;
2815 }
2816
2817 __PACKAGE__->register_method(
2818     method  => "serial_stream_retrieve_batch",
2819     authoritative => 1,
2820     api_name    => "open-ils.serial.stream.batch.retrieve"
2821 );
2822
2823 sub serial_stream_retrieve_batch {
2824     my( $self, $client, $ids ) = @_;
2825     $logger->info("Fetching streams @$ids");
2826     return $U->cstorereq(
2827         "open-ils.cstore.direct.serial.stream.search.atomic",
2828         { id => $ids }
2829     );
2830 }
2831
2832
2833 ##########################################################################
2834 # summary methods
2835 #
2836 __PACKAGE__->register_method(
2837     method    => 'sum_alter',
2838     api_name  => 'open-ils.serial.basic_summary.batch.update',
2839     api_level => 1,
2840     argc      => 2,
2841     signature => {
2842         desc     => 'Receives an array of one or more summaries and updates the database as needed',
2843         'params' => [ {
2844                  name => 'authtoken',
2845                  desc => 'Authtoken for current user session',
2846                  type => 'string'
2847             },
2848             {
2849                  name => 'sbsums',
2850                  desc => 'Array of basic summaries',
2851                  type => 'array'
2852             }
2853
2854         ],
2855         'return' => {
2856             desc => 'Returns 1 if successful, event if failed',
2857             type => 'mixed'
2858         }
2859     }
2860 );
2861
2862 __PACKAGE__->register_method(
2863     method    => 'sum_alter',
2864     api_name  => 'open-ils.serial.supplement_summary.batch.update',
2865     api_level => 1,
2866     argc      => 2,
2867     signature => {
2868         desc     => 'Receives an array of one or more summaries and updates the database as needed',
2869         'params' => [ {
2870                  name => 'authtoken',
2871                  desc => 'Authtoken for current user session',
2872                  type => 'string'
2873             },
2874             {
2875                  name => 'sbsums',
2876                  desc => 'Array of supplement summaries',
2877                  type => 'array'
2878             }
2879
2880         ],
2881         'return' => {
2882             desc => 'Returns 1 if successful, event if failed',
2883             type => 'mixed'
2884         }
2885     }
2886 );
2887
2888 __PACKAGE__->register_method(
2889     method    => 'sum_alter',
2890     api_name  => 'open-ils.serial.index_summary.batch.update',
2891     api_level => 1,
2892     argc      => 2,
2893     signature => {
2894         desc     => 'Receives an array of one or more summaries and updates the database as needed',
2895         'params' => [ {
2896                  name => 'authtoken',
2897                  desc => 'Authtoken for current user session',
2898                  type => 'string'
2899             },
2900             {
2901                  name => 'sbsums',
2902                  desc => 'Array of index summaries',
2903                  type => 'array'
2904             }
2905
2906         ],
2907         'return' => {
2908             desc => 'Returns 1 if successful, event if failed',
2909             type => 'mixed'
2910         }
2911     }
2912 );
2913
2914 sub sum_alter {
2915     my( $self, $conn, $auth, $sums ) = @_;
2916     return 1 unless ref $sums;
2917
2918     $self->api_name =~ /serial\.(\w*)_summary/;
2919     my $type = $1;
2920
2921     my( $reqr, $evt ) = $U->checkses($auth);
2922     return $evt if $evt;
2923     my $editor = new_editor(requestor => $reqr, xact => 1);
2924     my $override = $self->api_name =~ /override/;
2925
2926     my %found_sdist_ids;
2927     for my $sum (@$sums) {
2928         if (!exists($found_sdist_ids{$sum->distribution})) {
2929             my $sdist = $editor->retrieve_serial_distribution($sum->distribution) or return $editor->die_event;
2930             return $editor->die_event unless
2931                 $editor->allowed("ADMIN_SERIAL_DISTRIBUTION", $sdist->holding_lib);
2932             $found_sdist_ids{$sum->distribution} = 1;
2933         }
2934
2935         # XXX: (for now, at least) summaries should be created/deleted by the distribution functions
2936         if( $sum->isdeleted ) {
2937             $evt = OpenILS::Event->new('SERIAL_SUMMARIES_NOT_INDEPENDENT');
2938         } elsif( $sum->isnew ) {
2939             $evt = OpenILS::Event->new('SERIAL_SUMMARIES_NOT_INDEPENDENT');
2940         } else {
2941             $evt = _update_sum( $editor, $override, $sum, $type );
2942         }
2943     }
2944
2945     if( $evt ) {
2946         $logger->info("${type}_summary-alter failed with event: ".OpenSRF::Utils::JSON->perl2JSON($evt));
2947         $editor->rollback;
2948         return $evt;
2949     }
2950     $logger->debug("${type}_summary-alter: done updating ${type}_summary batch");
2951     $editor->commit;
2952     $logger->info("${type}_summary-alter successfully updated ".scalar(@$sums)." ${type}_summaries");
2953     return 1;
2954 }
2955
2956 sub _update_sum {
2957     my ($editor, $override, $sum, $type) = @_;
2958
2959     $logger->info("${type}_summary-alter: retrieving ${type}_summary ".$sum->id);
2960     my $retrieve_method = "retrieve_serial_${type}_summary";
2961     my $orig_sum = $editor->$retrieve_method($sum->id);
2962
2963     $logger->info("${type}_summary-alter: original ${type}_summary ".OpenSRF::Utils::JSON->perl2JSON($orig_sum));
2964     $logger->info("${type}_summary-alter: updated ${type}_summary ".OpenSRF::Utils::JSON->perl2JSON($sum));
2965     my $update_method = "update_serial_${type}_summary";
2966     return $editor->event unless $editor->$update_method($sum);
2967     return 0;
2968 }
2969
2970 __PACKAGE__->register_method(
2971     method  => "serial_summary_retrieve_batch",
2972     authoritative => 1,
2973     api_name    => "open-ils.serial.basic_summary.batch.retrieve"
2974 );
2975
2976 __PACKAGE__->register_method(
2977     method  => "serial_summary_retrieve_batch",
2978     authoritative => 1,
2979     api_name    => "open-ils.serial.supplement_summary.batch.retrieve"
2980 );
2981
2982 __PACKAGE__->register_method(
2983     method  => "serial_summary_retrieve_batch",
2984     authoritative => 1,
2985     api_name    => "open-ils.serial.index_summary.batch.retrieve"
2986 );
2987
2988 sub serial_summary_retrieve_batch {
2989     my( $self, $client, $ids ) = @_;
2990
2991     $self->api_name =~ /serial\.(\w*)_summary/;
2992     my $type = $1;
2993
2994     $logger->info("Fetching ${type}_summaries @$ids");
2995     return $U->cstorereq(
2996         "open-ils.cstore.direct.serial.".$type."_summary.search.atomic",
2997         { id => $ids }
2998     );
2999 }
3000
3001
3002 ##########################################################################
3003 # other methods
3004 #
3005 __PACKAGE__->register_method(
3006     "method" => "bre_by_identifier",
3007     "api_name" => "open-ils.serial.biblio.record_entry.by_identifier",
3008     "stream" => 1,
3009     "signature" => {
3010         "desc" => "Find instances of biblio.record_entry given a search token" .
3011             " that could be a value for any identifier defined in " .
3012             "config.metabib_field",
3013         "params" => [
3014             {"desc" => "Search token", "type" => "string"},
3015             {"desc" => "Options: require_subscriptions, add_mvr, is_actual_id" .
3016                 ", id_list (all boolean)", "type" => "object"}
3017         ],
3018         "return" => {
3019             "desc" => "Any matching BREs, or if the add_mvr option is true, " .
3020                 "objects with a 'bre' key/value pair, and an 'mvr' " .
3021                 "key-value pair.  BREs have subscriptions fleshed on.",
3022             "type" => "object"
3023         }
3024     }
3025 );
3026
3027 sub bre_by_identifier {
3028     my ($self, $client, $term, $options) = @_;
3029
3030     return new OpenILS::Event("BAD_PARAMS") unless $term;
3031
3032     $options ||= {};
3033     my $e = new_editor();
3034
3035     my @ids;
3036
3037     if ($options->{"is_actual_id"}) {
3038         @ids = ($term);
3039     } else {
3040         my $cmf =
3041             $e->search_config_metabib_field({"field_class" => "identifier"})
3042                 or return $e->die_event;
3043
3044         my @identifiers = map { $_->name } @$cmf;
3045         my $query = join(" || ", map { "id|$_: $term" } @identifiers);
3046
3047         my $search = create OpenSRF::AppSession("open-ils.search");
3048         my $search_result = $search->request(
3049             "open-ils.search.biblio.multiclass.query.staff", {}, $query
3050         )->gather(1);
3051         $search->disconnect;
3052
3053         # Un-nest results. They tend to look like [[1],[2],[3]] for some reason.
3054         @ids = map { @{$_} } @{$search_result->{"ids"}};
3055
3056         unless (@ids) {
3057             $e->disconnect;
3058             return undef;
3059         }
3060
3061         if ($options->{"id_list"}) {
3062             $e->disconnect;
3063             $client->respond($_) foreach (@ids);
3064             return undef;
3065         }
3066     }
3067
3068     my $bre = $e->search_biblio_record_entry([
3069         {"id" => \@ids}, {
3070             "flesh" => 2, "flesh_fields" => {
3071                 "bre" => ["subscriptions"],
3072                 "ssub" => ["owning_lib"]
3073             }
3074         }
3075     ]) or return $e->die_event;
3076
3077     if (@$bre && $options->{"require_subscriptions"}) {
3078         $bre = [ grep { @{$_->subscriptions} } @$bre ];
3079     }
3080
3081     $e->disconnect;
3082
3083     if (@$bre) { # re-evaluate after possible grep
3084         if ($options->{"add_mvr"}) {
3085             $client->respond(
3086                 {"bre" => $_, "mvr" => _get_mvr($_->id)}
3087             ) foreach (@$bre);
3088         } else {
3089             $client->respond($_) foreach (@$bre);
3090         }
3091     }
3092
3093     undef;
3094 }
3095
3096 __PACKAGE__->register_method(
3097     "method" => "get_items_by",
3098     "api_name" => "open-ils.serial.items.receivable.by_subscription",
3099     "stream" => 1,
3100     "signature" => {
3101         "desc" => "Return all receivable items under a given subscription",
3102         "params" => [
3103             {"desc" => "Authtoken", "type" => "string"},
3104             {"desc" => "Subscription ID", "type" => "number"},
3105         ],
3106         "return" => {
3107             "desc" => "All receivable items under a given subscription",
3108             "type" => "object", "class" => "sitem"
3109         }
3110     }
3111 );
3112
3113 __PACKAGE__->register_method(
3114     "method" => "get_items_by",
3115     "api_name" => "open-ils.serial.items.receivable.by_issuance",
3116     "stream" => 1,
3117     "signature" => {
3118         "desc" => "Return all receivable items under a given issuance",
3119         "params" => [
3120             {"desc" => "Authtoken", "type" => "string"},
3121             {"desc" => "Issuance ID", "type" => "number"},
3122         ],
3123         "return" => {
3124             "desc" => "All receivable items under a given issuance",
3125             "type" => "object", "class" => "sitem"
3126         }
3127     }
3128 );
3129
3130 __PACKAGE__->register_method(
3131     "method" => "get_items_by",
3132     "api_name" => "open-ils.serial.items.by_issuance",
3133     "stream" => 1,
3134     "signature" => {
3135         "desc" => "Return all items under a given issuance",
3136         "params" => [
3137             {"desc" => "Authtoken", "type" => "string"},
3138             {"desc" => "Issuance ID", "type" => "number"},
3139         ],
3140         "return" => {
3141             "desc" => "All items under a given issuance",
3142             "type" => "object", "class" => "sitem"
3143         }
3144     }
3145 );
3146
3147 sub get_items_by {
3148     my ($self, $client, $auth, $term, $opts)  = @_;
3149
3150     # Not to be used in the json_query, but after limiting by perm check.
3151     $opts = {} unless ref $opts eq "HASH";
3152     $opts->{"limit"} ||= 10000;    # some existing users may want all results
3153     $opts->{"offset"} ||= 0;
3154     $opts->{"limit"} = int($opts->{"limit"});
3155     $opts->{"offset"} = int($opts->{"offset"});
3156
3157     my $e = new_editor("authtoken" => $auth);
3158     return $e->die_event unless $e->checkauth;
3159
3160     my $by = ($self->api_name =~ /by_(\w+)$/)[0];
3161     my $receivable = ($self->api_name =~ /receivable/);
3162
3163     my %where = (
3164         "issuance" => {"issuance" => $term},
3165         "subscription" => {"+siss" => {"subscription" => $term}}
3166     );
3167
3168     my $item_rows = $e->json_query(
3169         {
3170             "select" => {"sitem" => ["id"], "sdist" => ["holding_lib"]},
3171             "from" => {
3172                 "sitem" => {
3173                     "siss" => {},
3174                     "sstr" => {"join" => {"sdist" => {}}}
3175                 }
3176             },
3177             "where" => {
3178                 %{$where{$by}}, $receivable ? ("date_received" => undef) : ()
3179             },
3180             "order_by" => {"sitem" => ["id"]}
3181         }
3182     ) or return $e->die_event;
3183
3184     return undef unless @$item_rows;
3185
3186     my $skipped = 0;
3187     my $returned = 0;
3188     foreach (@$item_rows) {
3189         last if $returned >= $opts->{"limit"};
3190         next unless $e->allowed("RECEIVE_SERIAL", $_->{"holding_lib"});
3191         if ($skipped < $opts->{"offset"}) {
3192             $skipped++;
3193             next;
3194         }
3195
3196         $client->respond(
3197             $e->retrieve_serial_item([
3198                 $_->{"id"}, {
3199                     "flesh" => 3,
3200                     "flesh_fields" => {
3201                         "sitem" => [qw/stream issuance unit creator editor/],
3202                         "sstr" => ["distribution"],
3203                         "sdist" => ["holding_lib"]
3204                     }
3205                 }
3206             ])
3207         );
3208         $returned++;
3209     }
3210
3211     $e->disconnect;
3212     undef;
3213 }
3214
3215 __PACKAGE__->register_method(
3216     "method" => "get_receivable_issuances",
3217     "api_name" => "open-ils.serial.issuances.receivable",
3218     "stream" => 1,
3219     "signature" => {
3220         "desc" => "Return all issuances with receivable items given " .
3221             "a subscription ID",
3222         "params" => [
3223             {"desc" => "Authtoken", "type" => "string"},
3224             {"desc" => "Subscription ID", "type" => "number"},
3225         ],
3226         "return" => {
3227             "desc" => "All issuances with receivable items " .
3228                 "(but not the items themselves)", "type" => "object"
3229         }
3230     }
3231 );
3232
3233 sub get_receivable_issuances {
3234     my ($self, $client, $auth, $sub_id) = @_;
3235
3236     my $e = new_editor("authtoken" => $auth);
3237     return $e->die_event unless $e->checkauth;
3238
3239     # XXX permissions
3240
3241     my $issuance_ids = $e->json_query({
3242         "select" => {
3243             "siss" => [
3244                 {"transform" => "distinct", "column" => "id"},
3245                 "date_published"
3246             ]
3247         },
3248         "from" => {"siss" => "sitem"},
3249         "where" => {
3250             "subscription" => $sub_id,
3251             "+sitem" => {"date_received" => undef}
3252         },
3253         "order_by" => {
3254             "siss" => {"date_published" => {"direction" => "asc"}}
3255         }
3256
3257     }) or return $e->die_event;
3258
3259     $client->respond($e->retrieve_serial_issuance($_->{"id"}))
3260         foreach (@$issuance_ids);
3261
3262     $e->disconnect;
3263     undef;
3264 }
3265
3266
3267 __PACKAGE__->register_method(
3268     "method" => "get_routing_list_users",
3269     "api_name" => "open-ils.serial.routing_list_users.fleshed_and_ordered",
3270     "stream" => 1,
3271     "signature" => {
3272         "desc" => "Return all routing list users with reader fleshed " .
3273             "(with card and home_ou) for a given stream ID, sorted by pos",
3274         "params" => [
3275             {"desc" => "Authtoken", "type" => "string"},
3276             {"desc" => "Stream ID (int or array of ints)", "type" => "mixed"},
3277         ],
3278         "return" => {
3279             "desc" => "Stream of routing list users", "type" => "object",
3280                 "class" => "srlu"
3281         }
3282     }
3283 );
3284
3285 sub get_routing_list_users {
3286     my ($self, $client, $auth, $stream_id) = @_;
3287
3288     my $e = new_editor("authtoken" => $auth);
3289     return $e->die_event unless $e->checkauth;
3290
3291     my $users = $e->search_serial_routing_list_user([
3292         {"stream" => $stream_id}, {
3293             "order_by" => {"srlu" => "pos"},
3294             "flesh" => 2,
3295             "flesh_fields" => {
3296                 "srlu" => [qw/reader stream/],
3297                 "au" => [qw/card home_ou mailing_address billing_address/],
3298                 "sstr" => ["distribution"]
3299             }
3300         }
3301     ]) or return $e->die_event;
3302
3303     return undef unless @$users;
3304
3305     # The ADMIN_SERIAL_STREAM permission is used simply to avoid the
3306     # need for any new permission.  The context OU will be the same
3307     # for every result of the above query, so we need only check once.
3308     return $e->die_event unless $e->allowed(
3309         "ADMIN_SERIAL_STREAM", $users->[0]->stream->distribution->holding_lib
3310     );
3311
3312     $e->disconnect;
3313
3314     my @users = map { $_->stream($_->stream->id); $_ } @$users;
3315     @users = sort { $a->stream cmp $b->stream } @users if
3316         ref $stream_id eq "ARRAY";
3317
3318     $client->respond($_) for @users;
3319
3320     undef;
3321 }
3322
3323
3324 __PACKAGE__->register_method(
3325     "method" => "replace_routing_list_users",
3326     "api_name" => "open-ils.serial.routing_list_users.replace",
3327     "signature" => {
3328         "desc" => "Replace all routing list users on the specified streams " .
3329             "with those in the list argument",
3330         "params" => [
3331             {"desc" => "Authtoken", "type" => "string"},
3332             {"desc" => "List of srlu objects", "type" => "array"},
3333         ],
3334         "return" => {
3335             "desc" => "event on failure, undef on success"
3336         }
3337     }
3338 );
3339
3340 sub replace_routing_list_users {
3341     my ($self, $client, $auth, $users) = @_;
3342
3343     return undef unless ref $users eq "ARRAY";
3344
3345     if (grep { ref $_ ne "Fieldmapper::serial::routing_list_user" } @$users) {
3346         return new OpenILS::Event("BAD_PARAMS", "note" => "Only srlu objects");
3347     }
3348
3349     my $e = new_editor("authtoken" => $auth, "xact" => 1);
3350     return $e->die_event unless $e->checkauth;
3351
3352     my %streams_ok = ();
3353     my $pos = 0;
3354
3355     foreach my $user (@$users) {
3356         unless (exists $streams_ok{$user->stream}) {
3357             my $stream = $e->retrieve_serial_stream([
3358                 $user->stream, {
3359                     "flesh" => 1,
3360                     "flesh_fields" => {"sstr" => ["distribution"]}
3361                 }
3362             ]) or return $e->die_event;
3363             $e->allowed(
3364                 "ADMIN_SERIAL_STREAM", $stream->distribution->holding_lib
3365             ) or return $e->die_event;
3366
3367             my $to_delete = $e->search_serial_routing_list_user(
3368                 {"stream" => $user->stream}
3369             ) or return $e->die_event;
3370
3371             $logger->info(
3372                 "Deleting srlu: [" .
3373                 join(", ", map { $_->id; } @$to_delete) .
3374                 "]"
3375             );
3376
3377             foreach (@$to_delete) {
3378                 $e->delete_serial_routing_list_user($_) or
3379                     return $e->die_event;
3380             }
3381
3382             $streams_ok{$user->stream} = 1;
3383         }
3384
3385         next if $user->isdeleted;
3386
3387         $user->clear_id;
3388         $user->pos($pos++);
3389         $e->create_serial_routing_list_user($user) or return $e->die_event;
3390     }
3391
3392     $e->commit or return $e->die_event;
3393     undef;
3394 }
3395
3396 __PACKAGE__->register_method(
3397     "method" => "get_records_with_marc_85x",
3398     "api_name"=>"open-ils.serial.caption_and_pattern.find_legacy_by_bib_record",
3399     "stream" => 1,
3400     "signature" => {
3401         "desc" => "Return the specified BRE itself and/or any related SRE ".
3402             "whenever they have 853-855 tags",
3403         "params" => [
3404             {"desc" => "Authtoken", "type" => "string"},
3405             {"desc" => "bib record ID", "type" => "number"},
3406         ],
3407         "return" => {
3408             "desc" => "objects, either bre or sre", "type" => "object"
3409         }
3410     }
3411 );
3412
3413 sub get_records_with_marc_85x { # specifically, 853-855
3414     my ($self, $client, $auth, $bre_id) = @_;
3415
3416     my $e = new_editor("authtoken" => $auth);
3417     return $e->die_event unless $e->checkauth;
3418
3419     my $bre = $e->search_biblio_record_entry([
3420         {"id" => $bre_id, "deleted" => "f"}, {
3421             "flesh" => 1,
3422             "flesh_fields" => {"bre" => [qw/creator editor owner/]}
3423         }
3424     ]) or return $e->die_event;
3425
3426     return undef unless @$bre;
3427     $bre = $bre->[0];
3428
3429     my $record = MARC::Record->new_from_xml($bre->marc);
3430     $client->respond($bre) if $record->field("85[3-5]");
3431     # XXX Is passing a regex to ->field() an abuse of MARC::Record ?
3432
3433     my $sres = $e->search_serial_record_entry([
3434         {"record" => $bre_id, "deleted" => "f"}, {
3435             "flesh" => 1,
3436             "flesh_fields" => {"sre" => [qw/creator editor owning_lib/]}
3437         }
3438     ]) or return $e->die_event;
3439
3440     $e->disconnect;
3441
3442     foreach my $sre (@$sres) {
3443         $client->respond($sre) if
3444             MARC::Record->new_from_xml($sre->marc)->field("85[3-5]");
3445     }
3446
3447     undef;
3448 }
3449
3450 __PACKAGE__->register_method(
3451     "method" => "create_scaps_from_marcxml",
3452     "api_name" => "open-ils.serial.caption_and_pattern.create_from_records",
3453     "stream" => 1,
3454     "signature" => {
3455         "desc" => "Create caption and pattern objects from 853-855 tags " .
3456             "in MARCXML documents",
3457         "params" => [
3458             {"desc" => "Authtoken", "type" => "string"},
3459             {"desc" => "Subscription ID", "type" => "number"},
3460             {"desc" => "list of MARCXML documents as strings",
3461                 "type" => "array"},
3462         ],
3463         "return" => {
3464             "desc" => "Newly created caption and pattern objects",
3465             "type" => "object", "class" => "scap"
3466         }
3467     }
3468 );
3469
3470 sub create_scaps_from_marcxml {
3471     my ($self, $client, $auth, $sub_id, $docs) = @_;
3472
3473     return undef unless ref $docs eq "ARRAY";
3474
3475     my $e = new_editor("authtoken" => $auth, "xact" => 1);
3476     return $e->die_event unless $e->checkauth;
3477
3478     # Retrieve the subscription just for perm checking (whether we can create
3479     # scaps at the owning lib).
3480     my $sub = $e->retrieve_serial_subscription($sub_id) or return $e->die_event;
3481     return $e->die_event unless
3482         $e->allowed("ADMIN_SERIAL_CAPTION_PATTERN", $sub->owning_lib);
3483
3484     foreach my $record (map { MARC::Record->new_from_xml($_) } @$docs) {
3485         foreach my $field ($record->field("85[3-5]")) {
3486             my $scap = new Fieldmapper::serial::caption_and_pattern;
3487             $scap->subscription($sub_id);
3488             $scap->type($MFHD_NAMES_BY_TAG{$field->tag});
3489             $scap->pattern_code(
3490                 OpenSRF::Utils::JSON->perl2JSON(
3491                     [ $field->indicator(1), $field->indicator(2),
3492                         map { @$_ } $field->subfields ] # flattens nested array
3493                 )
3494             );
3495             $e->create_serial_caption_and_pattern($scap) or
3496                 return $e->die_event;
3497             $client->respond($e->data);
3498         }
3499     }
3500
3501     $e->commit or return $e->die_event;
3502     undef;
3503 }
3504
3505 # All these _clone_foo() functions could possibly have been consolidated into
3506 # one clever function, but it's faster to get things working this way.
3507 sub _clone_subscription {
3508     my ($sub, $bib_id, $e) = @_;
3509
3510     # clone sub itself
3511     my $new_sub = $sub->clone;
3512     $new_sub->record_entry(int $bib_id) if $bib_id;
3513     $new_sub->clear_id;
3514     $new_sub->clear_distributions;
3515     $new_sub->clear_notes;
3516     $new_sub->clear_scaps;
3517
3518     $e->create_serial_subscription($new_sub) or return $e->die_event;
3519
3520     my $new_sub_id = $e->data->id;
3521     # clone dists
3522     foreach my $dist (@{$sub->distributions}) {
3523         my $r = _clone_distribution($dist, $new_sub_id, $e);
3524         return $r if $U->event_code($r);
3525     }
3526
3527     # clone sub notes
3528     foreach my $note (@{$sub->notes}) {
3529         my $r = _clone_subscription_note($note, $new_sub_id, $e);
3530         return $r if $U->event_code($r);
3531     }
3532
3533     # clone scaps
3534     foreach my $scap (@{$sub->scaps}) {
3535         my $r = _clone_caption_and_pattern($scap, $new_sub_id, $e);
3536         return $r if $U->event_code($r);
3537     }
3538
3539     return $new_sub_id;
3540 }
3541
3542 sub _clone_distribution {
3543     my ($dist, $sub_id, $e) = @_;
3544
3545     my $new_dist = $dist->clone;
3546     $new_dist->clear_id;
3547     $new_dist->clear_notes;
3548     $new_dist->clear_streams;
3549     $new_dist->subscription($sub_id);
3550
3551     $e->create_serial_distribution($new_dist) or return $e->die_event;
3552     my $new_dist_id = $e->data->id;
3553
3554     # clone streams
3555     foreach my $stream (@{$dist->streams}) {
3556         my $r = _clone_stream($stream, $new_dist_id, $e);
3557         return $r if $U->event_code($r);
3558     }
3559
3560     # clone distribution notes
3561     foreach my $note (@{$dist->notes}) {
3562         my $r = _clone_distribution_note($note, $new_dist_id, $e);
3563         return $r if $U->event_code($r);
3564     }
3565
3566     return $new_dist_id;
3567 }
3568
3569 sub _clone_subscription_note {
3570     my ($note, $sub_id, $e) = @_;
3571
3572     my $new_note = $note->clone;
3573     $new_note->clear_id;
3574     $new_note->creator($e->requestor->id);
3575     $new_note->create_date("now");
3576     $new_note->subscription($sub_id);
3577
3578     $e->create_serial_subscription_note($new_note) or return $e->die_event;
3579     return $e->data->id;
3580 }
3581
3582 sub _clone_caption_and_pattern {
3583     my ($scap, $sub_id, $e) = @_;
3584
3585     my $new_scap = $scap->clone;
3586     $new_scap->clear_id;
3587     $new_scap->subscription($sub_id);
3588
3589     $e->create_serial_caption_and_pattern($new_scap) or return $e->die_event;
3590     return $e->data->id;
3591 }
3592
3593 sub _clone_distribution_note {
3594     my ($note, $dist_id, $e) = @_;
3595
3596     my $new_note = $note->clone;
3597     $new_note->clear_id;
3598     $new_note->creator($e->requestor->id);
3599     $new_note->create_date("now");
3600     $new_note->distribution($dist_id);
3601
3602     $e->create_serial_distribution_note($new_note) or return $e->die_event;
3603     return $e->data->id;
3604 }
3605
3606 sub _clone_stream {
3607     my ($stream, $dist_id, $e) = @_;
3608
3609     my $new_stream = $stream->clone;
3610     $new_stream->clear_id;
3611     $new_stream->clear_routing_list_users;
3612     $new_stream->distribution($dist_id);
3613
3614     $e->create_serial_stream($new_stream) or return $e->die_event;
3615     my $new_stream_id = $e->data->id;
3616
3617     # clone routing list users
3618     foreach my $user (@{$stream->routing_list_users}) {
3619         my $r = _clone_routing_list_user($user, $new_stream_id, $e);
3620         return $r if $U->event_code($r);
3621     }
3622
3623     return $new_stream_id;
3624 }
3625
3626 sub _clone_routing_list_user {
3627     my ($user, $stream_id, $e) = @_;
3628
3629     my $new_user = $user->clone;
3630     $new_user->clear_id;
3631     $new_user->stream($stream_id);
3632
3633     $e->create_serial_routing_list_user($new_user) or return $e->die_event;
3634     return $e->data->id;
3635 }
3636
3637 __PACKAGE__->register_method(
3638     "method" => "clone_subscription",
3639     "api_name" => "open-ils.serial.subscription.clone",
3640     "signature" => {
3641         "desc" => q{Clone a subscription, including its attending distributions,
3642             streams, captions and patterns, routing list users, distribution
3643             notes and subscription notes. Do not include holdings-specific
3644             things, like issuances, items, units, summaries. Attach the
3645             clone either to the same bib record as the original, or to one
3646             specified by ID.},
3647         "params" => [
3648             {"desc" => "Authtoken", "type" => "string"},
3649             {"desc" => "Subscription ID", "type" => "number"},
3650             {"desc" => "Bib Record ID (optional)", "type" => "number"}
3651         ],
3652         "return" => {
3653             "desc" => "ID of the new subscription", "type" => "number"
3654         }
3655     }
3656 );
3657
3658 sub clone_subscription {
3659     my ($self, $client, $auth, $sub_id, $bib_id) = @_;
3660
3661     my $e = new_editor("authtoken" => $auth, "xact" => 1);
3662     return $e->die_event unless $e->checkauth;
3663
3664     my $sub = $e->retrieve_serial_subscription([
3665         int $sub_id, {
3666             "flesh" => 3,
3667             "flesh_fields" => {
3668                 "ssub" => [qw/distributions notes scaps/],
3669                 "sdist" => [qw/streams notes/],
3670                 "sstr" => ["routing_list_users"]
3671             }
3672         }
3673     ]) or return $e->die_event;
3674
3675     # ADMIN_SERIAL_SUBSCRIPTION will have to be good enough as a
3676     # catch-all permisison for this operation.
3677     return $e->die_event unless
3678         $e->allowed("ADMIN_SERIAL_SUBSCRIPTION", $sub->owning_lib);
3679
3680     my $result = _clone_subscription($sub, $bib_id, $e);
3681
3682     return $e->die_event($result) if $U->event_code($result);
3683
3684     $e->commit or return $e->die_event;
3685     return $result;
3686 }
3687
3688 __PACKAGE__->register_method(
3689     "method" => "summary_test",
3690     "api_name" => "open-ils.serial.summary_test",
3691     "stream" => 1,
3692     "api_level" => 1,
3693     "argc" => 3
3694 );
3695
3696 # This crummy little test method allows quicker reproduction of certain
3697 # failures (e.g. at item receive time) of the holdings summarization code.
3698 # Pass it an authtoken, an array of issuance IDs, and a single sdist ID
3699 sub summary_test {
3700     my ($self, $conn, $authtoken, $iss_id_list, $sdist_id) = @_;
3701
3702     my $e = new_editor(authtoken => $authtoken, xact => 1);
3703     return $e->die_event unless $e->checkauth;
3704     return $e->die_event unless $e->allowed("RECEIVE_SERIAL");
3705
3706     my @issuances;
3707     foreach my $id (@$iss_id_list) {
3708         my $iss = $e->retrieve_serial_issuance($id) or return $e->die_event;
3709         push @issuances, $iss;
3710     }
3711
3712     my $dist = $e->retrieve_serial_distribution($sdist_id) or return $e->die_event;
3713
3714     $conn->respond(_summarize_contents($e, \@issuances, $dist));
3715     $e->rollback;
3716     return;
3717 }
3718
3719 1;