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