C4/ILSDI/Services.pm

   1 package C4::ILSDI::Services;
   2
   3 # Copyright 2009 SARL Biblibre
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use strict;
  21 use warnings;
  22
  23 use C4::Members;
  24 use C4::Items;
  25 use C4::Circulation;
  26 use C4::Accounts;
  27 use C4::Biblio;
  28 use C4::Reserves qw(AddReserve CanBookBeReserved CanItemBeReserved IsAvailableForItemLevelRequest);
  29 use C4::Context;
  30 use C4::AuthoritiesMarc;
  31 use XML::Simple;
  32 use HTML::Entities;
  33 use CGI qw ( -utf8 );
  34 use DateTime;
  35 use C4::Auth;
  36 use C4::Members::Attributes qw(GetBorrowerAttributes);
  37 use Koha::DateUtils;
  38
  39 use Koha::Biblios;
  40 use Koha::Checkouts;
  41 use Koha::Libraries;
  42 use Koha::Patrons;
  43
  44 =head1 NAME
  45
  46 C4::ILS-DI::Services - ILS-DI Services
  47
  48 =head1 DESCRIPTION
  49
  50 Each function in this module represents an ILS-DI service.
  51 They all takes a CGI instance as argument and most of them return a
  52 hashref that will be printed by XML::Simple in opac/ilsdi.pl
  53
  54 =head1 SYNOPSIS
  55
  56         use C4::ILSDI::Services;
  57         use XML::Simple;
  58         use CGI qw ( -utf8 );
  59
  60         my $cgi = new CGI;
  61
  62         $out = LookupPatron($cgi);
  63
  64         print CGI::header('text/xml');
  65         print XMLout($out,
  66                 noattr => 1,
  67                 noescape => 1,
  68                 nosort => 1,
  69                 xmldecl => '<?xml version="1.0" encoding="UTF-8" ?>',
  70                 RootName => 'LookupPatron',
  71                 SuppressEmpty => 1);
  72
  73 =cut
  74
  75 =head1 FUNCTIONS
  76
  77 =head2 GetAvailability
  78
  79 Given a set of biblionumbers or itemnumbers, returns a list with
  80 availability of the items associated with the identifiers.
  81
  82 Parameters:
  83
  84 =head3 id (Required)
  85
  86 list of either biblionumbers or itemnumbers
  87
  88 =head3 id_type (Required)
  89
  90 defines the type of record identifier being used in the request,
  91 possible values:
  92
  93   - bib
  94   - item
  95
  96 =head3 return_type (Optional)
  97
  98 requests a particular level of detail in reporting availability,
  99 possible values:
 100
 101   - bib
 102   - item
 103
 104 =head3 return_fmt (Optional)
 105
 106 requests a particular format or set of formats in reporting
 107 availability
 108
 109 =cut
 110
 111 sub GetAvailability {
 112     my ($cgi) = @_;
 113
 114     my $out = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n";
 115     $out .= "<dlf:collection\n";
 116     $out .= "  xmlns:dlf=\"http://diglib.org/ilsdi/1.1\"\n";
 117     $out .= "  xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n";
 118     $out .= "  xsi:schemaLocation=\"http://diglib.org/ilsdi/1.1\n";
 119     $out .= "    http://diglib.org/architectures/ilsdi/schemas/1.1/dlfexpanded.xsd\">\n";
 120
 121     foreach my $id ( split( / /, $cgi->param('id') ) ) {
 122         if ( $cgi->param('id_type') eq "item" ) {
 123             my ( $biblionumber, $status, $msg, $location ) = _availability($id);
 124
 125             $out .= "  <dlf:record>\n";
 126             $out .= "    <dlf:bibliographic id=\"" . ( $biblionumber || $id ) . "\" />\n";
 127             $out .= "    <dlf:items>\n";
 128             $out .= "      <dlf:item id=\"" . $id . "\">\n";
 129             $out .= "        <dlf:simpleavailability>\n";
 130             $out .= "          <dlf:identifier>" . $id . "</dlf:identifier>\n";
 131             $out .= "          <dlf:availabilitystatus>" . $status . "</dlf:availabilitystatus>\n";
 132             if ($msg)      { $out .= "          <dlf:availabilitymsg>" . $msg . "</dlf:availabilitymsg>\n"; }
 133             if ($location) { $out .= "          <dlf:location>" . $location . "</dlf:location>\n"; }
 134             $out .= "        </dlf:simpleavailability>\n";
 135             $out .= "      </dlf:item>\n";
 136             $out .= "    </dlf:items>\n";
 137             $out .= "  </dlf:record>\n";
 138         } else {
 139             my $status;
 140             my $msg;
 141             my $items = GetItemnumbersForBiblio($id);
 142             if ($items) {
 143                 # Open XML
 144                 $out .= "  <dlf:record>\n";
 145                 $out .= "    <dlf:bibliographic id=\"" .$id. "\" />\n";
 146                 $out .= "    <dlf:items>\n";
 147                 # We loop over the items to clean them
 148                 foreach my $itemnumber (@$items) {
 149                     my ( $biblionumber, $status, $msg, $location ) = _availability($itemnumber);
 150                     $out .= "      <dlf:item id=\"" . $itemnumber . "\">\n";
 151                     $out .= "        <dlf:simpleavailability>\n";
 152                     $out .= "          <dlf:identifier>" . $itemnumber . "</dlf:identifier>\n";
 153                     $out .= "          <dlf:availabilitystatus>" . $status . "</dlf:availabilitystatus>\n";
 154                     if ($msg)      { $out .= "          <dlf:availabilitymsg>" . $msg . "</dlf:availabilitymsg>\n"; }
 155                     if ($location) { $out .= "          <dlf:location>" . $location . "</dlf:location>\n"; }
 156                     $out .= "        </dlf:simpleavailability>\n";
 157                     $out .= "      </dlf:item>\n";
 158                 }
 159                 # Close XML
 160                 $out .= "    </dlf:items>\n";
 161                 $out .= "  </dlf:record>\n";
 162             } else {
 163                 $status = "unknown";
 164                 $msg    = "Error: could not retrieve availability for this ID";
 165             }
 166         }
 167     }
 168     $out .= "</dlf:collection>\n";
 169
 170     return $out;
 171 }
 172
 173 =head2 GetRecords
 174
 175 Given a list of biblionumbers, returns a list of record objects that
 176 contain bibliographic information, as well as associated holdings and item
 177 information. The caller may request a specific metadata schema for the
 178 record objects to be returned.
 179
 180 This function behaves similarly to HarvestBibliographicRecords and
 181 HarvestExpandedRecords in Data Aggregation, but allows quick, real time
 182 lookup by bibliographic identifier.
 183
 184 You can use OAI-PMH ListRecords instead of this service.
 185
 186 Parameters:
 187
 188   - id (Required)
 189         list of system record identifiers
 190   - id_type (Optional)
 191         Defines the metadata schema in which the records are returned,
 192         possible values:
 193           - MARCXML
 194
 195 =cut
 196
 197 sub GetRecords {
 198     my ($cgi) = @_;
 199
 200     # Check if the schema is supported. For now, GetRecords only supports MARCXML
 201     if ( $cgi->param('schema') and $cgi->param('schema') ne "MARCXML" ) {
 202         return { code => 'UnsupportedSchema' };
 203     }
 204
 205     my @records;
 206
 207     # Loop over biblionumbers
 208     foreach my $biblionumber ( split( / /, $cgi->param('id') ) ) {
 209
 210         # Get the biblioitem from the biblionumber
 211         my $biblioitem = ( GetBiblioItemByBiblioNumber( $biblionumber, undef ) )[0];
 212         if ( not $biblioitem->{'biblionumber'} ) {
 213             $biblioitem->{code} = "RecordNotFound";
 214         }
 215
 216         my $embed_items = 1;
 217         my $record = GetMarcBiblio($biblionumber, $embed_items);
 218         if ($record) {
 219             $biblioitem->{marcxml} = $record->as_xml_record();
 220         }
 221
 222         # Get most of the needed data
 223         my $biblioitemnumber = $biblioitem->{'biblioitemnumber'};
 224         my $biblio = Koha::Biblios->find( $biblionumber );
 225         my $holds  = $biblio->current_holds->unblessed;
 226         my $issues           = GetBiblioIssues($biblionumber);
 227         my $items            = GetItemsByBiblioitemnumber($biblioitemnumber);
 228
 229         # We loop over the items to clean them
 230         foreach my $item (@$items) {
 231
 232             # This hides additionnal XML subfields, we don't need these info
 233             delete $item->{'more_subfields_xml'};
 234
 235             # Display branch names instead of branch codes
 236             my $home_library    = Koha::Libraries->find( $item->{homebranch} );
 237             my $holding_library = Koha::Libraries->find( $item->{holdingbranch} );
 238             $item->{'homebranchname'}    = $home_library    ? $home_library->branchname    : '';
 239             $item->{'holdingbranchname'} = $holding_library ? $holding_library->branchname : '';
 240         }
 241
 242         # Hashref building...
 243         $biblioitem->{'items'}->{'item'}       = $items;
 244         $biblioitem->{'reserves'}->{'reserve'} = $holds;
 245         $biblioitem->{'issues'}->{'issue'}     = $issues;
 246
 247         push @records, $biblioitem;
 248     }
 249
 250     return { record => \@records };
 251 }
 252
 253 =head2 GetAuthorityRecords
 254
 255 Given a list of authority record identifiers, returns a list of record
 256 objects that contain the authority records. The function user may request
 257 a specific metadata schema for the record objects.
 258
 259 Parameters:
 260
 261   - id (Required)
 262     list of authority record identifiers
 263   - schema (Optional)
 264     specifies the metadata schema of records to be returned, possible values:
 265       - MARCXML
 266
 267 =cut
 268
 269 sub GetAuthorityRecords {
 270     my ($cgi) = @_;
 271
 272     # If the user asks for an unsupported schema, return an error code
 273     if ( $cgi->param('schema') and $cgi->param('schema') ne "MARCXML" ) {
 274         return { code => 'UnsupportedSchema' };
 275     }
 276
 277     my @records;
 278
 279     # Let's loop over the authority IDs
 280     foreach my $authid ( split( / /, $cgi->param('id') ) ) {
 281
 282         # Get the record as XML string, or error code
 283         push @records, GetAuthorityXML($authid) || { code => 'RecordNotFound' };
 284     }
 285
 286     return { record => \@records };
 287 }
 288
 289 =head2 LookupPatron
 290
 291 Looks up a patron in the ILS by an identifier, and returns the borrowernumber.
 292
 293 Parameters:
 294
 295   - id (Required)
 296         an identifier used to look up the patron in Koha
 297   - id_type (Optional)
 298         the type of the identifier, possible values:
 299         - cardnumber
 300         - firstname
 301         - userid
 302         - borrowernumber
 303
 304 =cut
 305
 306 sub LookupPatron {
 307     my ($cgi) = @_;
 308
 309     # Get the borrower...
 310     my $borrower = GetMember($cgi->param('id_type') => $cgi->param('id'));
 311     if ( not $borrower->{'borrowernumber'} ) {
 312         return { message => 'PatronNotFound' };
 313     }
 314
 315     # Build the hashref
 316     my $patron->{'id'} = $borrower->{'borrowernumber'};
 317     return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
 318
 319     # ...and return his ID
 320     return $patron;
 321 }
 322
 323 =head2 AuthenticatePatron
 324
 325 Authenticates a user's login credentials and returns the identifier for
 326 the patron.
 327
 328 Parameters:
 329
 330   - username (Required)
 331     user's login identifier (userid or cardnumber)
 332   - password (Required)
 333     user's password
 334
 335 =cut
 336
 337 sub AuthenticatePatron {
 338     my ($cgi) = @_;
 339     my $username = $cgi->param('username');
 340     my $password = $cgi->param('password');
 341     my ($status, $cardnumber, $userid) = C4::Auth::checkpw( C4::Context->dbh, $username, $password );
 342     if ( $status ) {
 343         # Get the borrower
 344         my $borrower = GetMember( cardnumber => $cardnumber );
 345         my $patron->{'id'} = $borrower->{'borrowernumber'};
 346         return $patron;
 347     }
 348     else {
 349         return { code => 'PatronNotFound' };
 350     }
 351 }
 352
 353 =head2 GetPatronInfo
 354
 355 Returns specified information about the patron, based on options in the
 356 request. This function can optionally return patron's contact information,
 357 fine information, hold request information, and loan information.
 358
 359 Parameters:
 360
 361   - patron_id (Required)
 362         the borrowernumber
 363   - show_contact (Optional, default 1)
 364         whether or not to return patron's contact information in the response
 365   - show_fines (Optional, default 0)
 366         whether or not to return fine information in the response
 367   - show_holds (Optional, default 0)
 368         whether or not to return hold request information in the response
 369   - show_loans (Optional, default 0)
 370         whether or not to return loan information request information in the response
 371
 372 =cut
 373
 374 sub GetPatronInfo {
 375     my ($cgi) = @_;
 376
 377     # Get Member details
 378     my $borrowernumber = $cgi->param('patron_id');
 379     my $borrower = GetMember( borrowernumber => $borrowernumber );
 380     return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
 381     my $patron = Koha::Patrons->find( $borrowernumber );
 382
 383     # Cleaning the borrower hashref
 384     my $flags = C4::Members::patronflags( $borrower );
 385     $borrower->{'charges'} = $flags->{'CHARGES'}->{'amount'};
 386     my $library = Koha::Libraries->find( $borrower->{branchcode} );
 387     $borrower->{'branchname'} = $library ? $library->branchname : '';
 388     delete $borrower->{'userid'};
 389     delete $borrower->{'password'};
 390
 391     # Contact fields management
 392     if ( defined $cgi->param('show_contact') && $cgi->param('show_contact') eq "0" ) {
 393
 394         # Define contact fields
 395         my @contactfields = (
 396             'email',              'emailpro',           'fax',                 'mobile',          'phone',             'phonepro',
 397             'streetnumber',       'zipcode',            'city',                'streettype',      'B_address',         'B_city',
 398             'B_email',            'B_phone',            'B_zipcode',           'address',         'address2',          'altcontactaddress1',
 399             'altcontactaddress2', 'altcontactaddress3', 'altcontactfirstname', 'altcontactphone', 'altcontactsurname', 'altcontactzipcode'
 400         );
 401
 402         # and delete them
 403         foreach my $field (@contactfields) {
 404             delete $borrower->{$field};
 405         }
 406     }
 407
 408     # Fines management
 409     if ( $cgi->param('show_fines') && $cgi->param('show_fines') eq "1" ) {
 410         my @charges;
 411         for ( my $i = 1 ; my @charge = getcharges( $borrowernumber, undef, $i ) ; $i++ ) {
 412             push( @charges, @charge );
 413         }
 414         $borrower->{'fines'}->{'fine'} = \@charges;
 415     }
 416
 417     # Reserves management
 418     if ( $cgi->param('show_holds') && $cgi->param('show_holds') eq "1" ) {
 419
 420         # Get borrower's reserves
 421         my $holds = $patron->holds;
 422         while ( my $hold = $holds->next ) {
 423
 424             my $unblessed_hold = $hold->unblessed;
 425             # Get additional informations
 426             my $item = GetBiblioFromItemNumber( $hold->itemnumber, undef );
 427             my $library = Koha::Libraries->find( $hold->branchcode ); # Should $hold->get_library
 428             my $branchname = $library ? $library->branchname : '';
 429
 430             # Remove unwanted fields
 431             delete $item->{'more_subfields_xml'};
 432
 433             # Add additional fields
 434             $unblessed_hold->{item}       = $item;
 435             $unblessed_hold->{branchname} = $branchname;
 436             $unblessed_hold->{title}      = GetBiblio( $hold->biblionumber )->{'title'}; # Should be $hold->get_biblio
 437
 438             push @{ $borrower->{holds}{hold} }, $unblessed_hold;
 439         }
 440     }
 441
 442     # Issues management
 443     if ( $cgi->param('show_loans') && $cgi->param('show_loans') eq "1" ) {
 444         my $issues = GetPendingIssues($borrowernumber);
 445         foreach my $issue ( @$issues ){
 446             $issue->{'issuedate'} = $issue->{'issuedate'}->strftime('%Y-%m-%d %H:%M');
 447             $issue->{'date_due'} = $issue->{'date_due'}->strftime('%Y-%m-%d %H:%M');
 448         }
 449         $borrower->{'loans'}->{'loan'} = $issues;
 450     }
 451
 452     if ( $cgi->param('show_attributes') eq "1" ) {
 453         my $attrs = GetBorrowerAttributes( $borrowernumber, 0, 1 );
 454         $borrower->{'attributes'} = $attrs;
 455     }
 456
 457     return $borrower;
 458 }
 459
 460 =head2 GetPatronStatus
 461
 462 Returns a patron's status information.
 463
 464 Parameters:
 465
 466   - patron_id (Required)
 467         the borrower ID
 468
 469 =cut
 470
 471 sub GetPatronStatus {
 472     my ($cgi) = @_;
 473
 474     # Get Member details
 475     my $borrowernumber = $cgi->param('patron_id');
 476     my $borrower = GetMember( borrowernumber => $borrowernumber );
 477     return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
 478
 479     # Return the results
 480     return {
 481         type   => $$borrower{categorycode},
 482         status => 0, # TODO
 483         expiry => $$borrower{dateexpiry},
 484     };
 485 }
 486
 487 =head2 GetServices
 488
 489 Returns information about the services available on a particular item for
 490 a particular patron.
 491
 492 Parameters:
 493
 494   - patron_id (Required)
 495         a borrowernumber
 496   - item_id (Required)
 497         an itemnumber
 498
 499 =cut
 500
 501 sub GetServices {
 502     my ($cgi) = @_;
 503
 504     # Get the member, or return an error code if not found
 505     my $borrowernumber = $cgi->param('patron_id');
 506     my $borrower = GetMember( borrowernumber => $borrowernumber );
 507     return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
 508
 509     my $patron = Koha::Patrons->find( $borrowernumber );
 510
 511     # Get the item, or return an error code if not found
 512     my $itemnumber = $cgi->param('item_id');
 513     my $item = GetItem( $itemnumber );
 514     return { code => 'RecordNotFound' } unless $$item{itemnumber};
 515
 516     my @availablefor;
 517
 518     # Reserve level management
 519     my $biblionumber = $item->{'biblionumber'};
 520     my $canbookbereserved = CanBookBeReserved( $borrower, $biblionumber );
 521     if ($canbookbereserved eq 'OK') {
 522         push @availablefor, 'title level hold';
 523         my $canitembereserved = IsAvailableForItemLevelRequest($item, $borrower);
 524         if ($canitembereserved) {
 525             push @availablefor, 'item level hold';
 526         }
 527     }
 528
 529     # Reserve cancellation management
 530     my $holds = $patron->holds;
 531     my @reserveditems;
 532     while ( my $hold = $holds->next ) { # FIXME This could be improved
 533         push @reserveditems, $hold->itemnumber;
 534     }
 535     if ( grep { $itemnumber eq $_ } @reserveditems ) {
 536         push @availablefor, 'hold cancellation';
 537     }
 538
 539     # Renewal management
 540     my @renewal = CanBookBeRenewed( $borrowernumber, $itemnumber );
 541     if ( $renewal[0] ) {
 542         push @availablefor, 'loan renewal';
 543     }
 544
 545     # Issuing management
 546     my $barcode = $item->{'barcode'} || '';
 547     $barcode = barcodedecode($barcode) if ( $barcode && C4::Context->preference('itemBarcodeInputFilter') );
 548     if ($barcode) {
 549         my ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower, $barcode );
 550
 551         # TODO push @availablefor, 'loan';
 552     }
 553
 554     my $out;
 555     $out->{'AvailableFor'} = \@availablefor;
 556
 557     return $out;
 558 }
 559
 560 =head2 RenewLoan
 561
 562 Extends the due date for a borrower's existing issue.
 563
 564 Parameters:
 565
 566   - patron_id (Required)
 567         a borrowernumber
 568   - item_id (Required)
 569         an itemnumber
 570   - desired_due_date (Required)
 571         the date the patron would like the item returned by
 572
 573 =cut
 574
 575 sub RenewLoan {
 576     my ($cgi) = @_;
 577
 578     # Get borrower infos or return an error code
 579     my $borrowernumber = $cgi->param('patron_id');
 580     my $borrower = GetMember( borrowernumber => $borrowernumber );
 581     return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
 582
 583     # Get the item, or return an error code
 584     my $itemnumber = $cgi->param('item_id');
 585     my $item = GetItem( $itemnumber );
 586     return { code => 'RecordNotFound' } unless $$item{itemnumber};
 587
 588     # Add renewal if possible
 589     my @renewal = CanBookBeRenewed( $borrowernumber, $itemnumber );
 590     if ( $renewal[0] ) { AddRenewal( $borrowernumber, $itemnumber ); }
 591
 592     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return; # FIXME should be handled
 593
 594     # Hashref building
 595     my $out;
 596     $out->{'renewals'} = $issue->renewals;
 597     $out->{date_due}   = dt_from_string($issue->date_due)->strftime('%Y-%m-%d %H:%S');
 598     $out->{'success'}  = $renewal[0];
 599     $out->{'error'}    = $renewal[1];
 600
 601     return $out;
 602 }
 603
 604 =head2 HoldTitle
 605
 606 Creates, for a borrower, a biblio-level hold reserve.
 607
 608 Parameters:
 609
 610   - patron_id (Required)
 611         a borrowernumber
 612   - bib_id (Required)
 613         a biblionumber
 614   - request_location (Required)
 615         IP address where the end user request is being placed
 616   - pickup_location (Optional)
 617         a branch code indicating the location to which to deliver the item for pickup
 618   - needed_before_date (Optional)
 619         date after which hold request is no longer needed
 620   - pickup_expiry_date (Optional)
 621         date after which item returned to shelf if item is not picked up
 622
 623 =cut
 624
 625 sub HoldTitle {
 626     my ($cgi) = @_;
 627
 628     # Get the borrower or return an error code
 629     my $borrowernumber = $cgi->param('patron_id');
 630     my $borrower = GetMember( borrowernumber => $borrowernumber );
 631     return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
 632
 633     # Get the biblio record, or return an error code
 634     my $biblionumber = $cgi->param('bib_id');
 635     my $biblio = GetBiblio( $biblionumber );
 636     return { code => 'RecordNotFound' } unless $$biblio{biblionumber};
 637
 638     my $title = $$biblio{title};
 639
 640     # Check if the biblio can be reserved
 641     return { code => 'NotHoldable' } unless CanBookBeReserved( $borrowernumber, $biblionumber ) eq 'OK';
 642
 643     my $branch;
 644
 645     # Pickup branch management
 646     if ( $cgi->param('pickup_location') ) {
 647         $branch = $cgi->param('pickup_location');
 648         return { code => 'LocationNotFound' } unless Koha::Libraries->find($branch);
 649     } else { # if the request provide no branch, use the borrower's branch
 650         $branch = $$borrower{branchcode};
 651     }
 652
 653     # Add the reserve
 654     #    $branch,    $borrowernumber, $biblionumber,
 655     #    $constraint, $bibitems,  $priority, $resdate, $expdate, $notes,
 656     #    $title,      $checkitem, $found
 657     my $priority= C4::Reserves::CalculatePriority( $biblionumber );
 658     AddReserve( $branch, $borrowernumber, $biblionumber, undef, $priority, undef, undef, undef, $title, undef, undef );
 659
 660     # Hashref building
 661     my $out;
 662     $out->{'title'}           = $title;
 663     my $library = Koha::Libraries->find( $branch );
 664     $out->{'pickup_location'} = $library ? $library->branchname : '';
 665
 666     # TODO $out->{'date_available'}  = '';
 667
 668     return $out;
 669 }
 670
 671 =head2 HoldItem
 672
 673 Creates, for a borrower, an item-level hold request on a specific item of
 674 a bibliographic record in Koha.
 675
 676 Parameters:
 677
 678   - patron_id (Required)
 679         a borrowernumber
 680   - bib_id (Required)
 681         a biblionumber
 682   - item_id (Required)
 683         an itemnumber
 684   - pickup_location (Optional)
 685         a branch code indicating the location to which to deliver the item for pickup
 686   - needed_before_date (Optional)
 687         date after which hold request is no longer needed
 688   - pickup_expiry_date (Optional)
 689         date after which item returned to shelf if item is not picked up
 690
 691 =cut
 692
 693 sub HoldItem {
 694     my ($cgi) = @_;
 695
 696     # Get the borrower or return an error code
 697     my $borrowernumber = $cgi->param('patron_id');
 698     my $borrower = GetMember( borrowernumber => $borrowernumber );
 699     return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
 700
 701     # Get the biblio or return an error code
 702     my $biblionumber = $cgi->param('bib_id');
 703     my $biblio = GetBiblio($biblionumber);
 704     return { code => 'RecordNotFound' } unless $$biblio{biblionumber};
 705
 706     my $title = $$biblio{title};
 707
 708     # Get the item or return an error code
 709     my $itemnumber = $cgi->param('item_id');
 710     my $item = GetItem( $itemnumber );
 711     return { code => 'RecordNotFound' } unless $$item{itemnumber};
 712
 713     # If the biblio does not match the item, return an error code
 714     return { code => 'RecordNotFound' } if $$item{biblionumber} ne $$biblio{biblionumber};
 715
 716     # Check for item disponibility
 717     my $canitembereserved = C4::Reserves::CanItemBeReserved( $borrowernumber, $itemnumber );
 718     my $canbookbereserved = C4::Reserves::CanBookBeReserved( $borrowernumber, $biblionumber );
 719     return { code => 'NotHoldable' } unless $canbookbereserved eq 'OK' and $canitembereserved eq 'OK';
 720
 721     # Pickup branch management
 722     my $branch;
 723     if ( $cgi->param('pickup_location') ) {
 724         $branch = $cgi->param('pickup_location');
 725         return { code => 'LocationNotFound' } unless Koha::Libraries->find($branch);
 726     } else { # if the request provide no branch, use the borrower's branch
 727         $branch = $$borrower{branchcode};
 728     }
 729
 730     # Add the reserve
 731     #    $branch,    $borrowernumber, $biblionumber,
 732     #    $constraint, $bibitems,  $priority, $resdate, $expdate, $notes,
 733     #    $title,      $checkitem, $found
 734     my $priority= C4::Reserves::CalculatePriority( $biblionumber );
 735     AddReserve( $branch, $borrowernumber, $biblionumber, undef, $priority, undef, undef, undef, $title, $itemnumber, undef );
 736
 737     # Hashref building
 738     my $out;
 739     my $library = Koha::Libraries->find( $branch );
 740     $out->{'pickup_location'} = $library ? $library->branchname : '';
 741
 742     # TODO $out->{'date_available'} = '';
 743
 744     return $out;
 745 }
 746
 747 =head2 CancelHold
 748
 749 Cancels an active reserve request for the borrower.
 750
 751 Parameters:
 752
 753   - patron_id (Required)
 754         a borrowernumber
 755   - item_id (Required)
 756         a reserve_id
 757
 758 =cut
 759
 760 sub CancelHold {
 761     my ($cgi) = @_;
 762
 763     # Get the borrower or return an error code
 764     my $borrowernumber = $cgi->param('patron_id');
 765     my $borrower = GetMember( borrowernumber => $borrowernumber );
 766     return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
 767
 768     # Get the reserve or return an error code
 769     my $reserve_id = $cgi->param('item_id');
 770     my $reserve = C4::Reserves::GetReserve($reserve_id);
 771     return { code => 'RecordNotFound' } unless $reserve;
 772     return { code => 'RecordNotFound' } unless ($reserve->{borrowernumber} == $borrowernumber);
 773
 774     C4::Reserves::CancelReserve({reserve_id => $reserve_id});
 775
 776     return { code => 'Canceled' };
 777 }
 778
 779 =head2 _availability
 780
 781 Returns, for an itemnumber, an array containing availability information.
 782
 783  my ($biblionumber, $status, $msg, $location) = _availability($id);
 784
 785 =cut
 786
 787 sub _availability {
 788     my ($itemnumber) = @_;
 789     my $item = GetItem( $itemnumber, undef, undef );
 790
 791     if ( not $item->{'itemnumber'} ) {
 792         return ( undef, 'unknown', 'Error: could not retrieve availability for this ID', undef );
 793     }
 794
 795     my $biblionumber = $item->{'biblioitemnumber'};
 796     my $library = Koha::Libraries->find( $item->{holdingbranch} );
 797     my $location = $library ? $library->branchname : '';
 798
 799     if ( $item->{'notforloan'} ) {
 800         return ( $biblionumber, 'not available', 'Not for loan', $location );
 801     } elsif ( $item->{'onloan'} ) {
 802         return ( $biblionumber, 'not available', 'Checked out', $location );
 803     } elsif ( $item->{'itemlost'} ) {
 804         return ( $biblionumber, 'not available', 'Item lost', $location );
 805     } elsif ( $item->{'withdrawn'} ) {
 806         return ( $biblionumber, 'not available', 'Item withdrawn', $location );
 807     } elsif ( $item->{'damaged'} ) {
 808         return ( $biblionumber, 'not available', 'Item damaged', $location );
 809     } else {
 810         return ( $biblionumber, 'available', undef, $location );
 811     }
 812 }
 813
 814 1;