C4/Members.pm

   1 package C4::Members;
   2
   3 # Copyright 2000-2003 Katipo Communications
   4 # Copyright 2010 BibLibre
   5 # Parts Copyright 2010 Catalyst IT
   6 #
   7 # This file is part of Koha.
   8 #
   9 # Koha is free software; you can redistribute it and/or modify it
  10 # under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation; either version 3 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but
  15 # WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  21
  22
  23 use strict;
  24 #use warnings; FIXME - Bug 2505
  25 use C4::Context;
  26 use String::Random qw( random_string );
  27 use Scalar::Util qw( looks_like_number );
  28 use Date::Calc qw/Today check_date Date_to_Days/;
  29 use C4::Log; # logaction
  30 use C4::Overdues;
  31 use C4::Reserves;
  32 use C4::Accounts;
  33 use C4::Biblio;
  34 use C4::Letters;
  35 use C4::Members::Attributes qw(SearchIdMatchingAttribute UpdateBorrowerAttribute);
  36 use C4::NewsChannels; #get slip news
  37 use DateTime;
  38 use Koha::Database;
  39 use Koha::DateUtils;
  40 use Text::Unaccent qw( unac_string );
  41 use Koha::AuthUtils qw(hash_password);
  42 use Koha::Database;
  43 use Koha::Holds;
  44 use Koha::List::Patron;
  45 use Koha::Patrons;
  46 use Koha::Patron::Categories;
  47
  48 our (@ISA,@EXPORT,@EXPORT_OK,$debug);
  49
  50 use Module::Load::Conditional qw( can_load );
  51 if ( ! can_load( modules => { 'Koha::NorwegianPatronDB' => undef } ) ) {
  52    $debug && warn "Unable to load Koha::NorwegianPatronDB";
  53 }
  54
  55
  56 BEGIN {
  57     $debug = $ENV{DEBUG} || 0;
  58     require Exporter;
  59     @ISA = qw(Exporter);
  60     #Get data
  61     push @EXPORT, qw(
  62         &GetMemberDetails
  63         &GetMember
  64
  65         &GetMemberIssuesAndFines
  66         &GetPendingIssues
  67         &GetAllIssues
  68
  69         &GetFirstValidEmailAddress
  70         &GetNoticeEmailAddress
  71
  72         &GetAge
  73
  74         &GetHideLostItemsPreference
  75
  76         &GetMemberAccountRecords
  77         &GetBorNotifyAcctRecord
  78
  79         &GetBorrowersToExpunge
  80         &GetBorrowersWhoHaveNeverBorrowed
  81         &GetBorrowersWithIssuesHistoryOlderThan
  82
  83         &GetUpcomingMembershipExpires
  84
  85         &IssueSlip
  86         GetBorrowersWithEmail
  87
  88         GetOverduesForPatron
  89     );
  90
  91     #Modify data
  92     push @EXPORT, qw(
  93         &ModMember
  94         &changepassword
  95     );
  96
  97     #Insert data
  98     push @EXPORT, qw(
  99         &AddMember
 100         &AddMember_Opac
 101     );
 102
 103     #Check data
 104     push @EXPORT, qw(
 105         &checkuniquemember
 106         &checkuserpassword
 107         &Check_Userid
 108         &Generate_Userid
 109         &fixup_cardnumber
 110         &checkcardnumber
 111     );
 112 }
 113
 114 =head1 NAME
 115
 116 C4::Members - Perl Module containing convenience functions for member handling
 117
 118 =head1 SYNOPSIS
 119
 120 use C4::Members;
 121
 122 =head1 DESCRIPTION
 123
 124 This module contains routines for adding, modifying and deleting members/patrons/borrowers
 125
 126 =head1 FUNCTIONS
 127
 128 =head2 GetMemberDetails
 129
 130 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
 131
 132 Looks up a patron and returns information about him or her. If
 133 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
 134 up the borrower by number; otherwise, it looks up the borrower by card
 135 number.
 136
 137 C<$borrower> is a reference-to-hash whose keys are the fields of the
 138 borrowers table in the Koha database. In addition,
 139 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
 140 about the patron. Its keys act as flags :
 141
 142     if $borrower->{flags}->{LOST} {
 143         # Patron's card was reported lost
 144     }
 145
 146 If the state of a flag means that the patron should not be
 147 allowed to borrow any more books, then it will have a C<noissues> key
 148 with a true value.
 149
 150 See patronflags for more details.
 151
 152 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
 153 about the top-level permissions flags set for the borrower.  For example,
 154 if a user has the "editcatalogue" permission,
 155 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
 156 the value "1".
 157
 158 =cut
 159
 160 sub GetMemberDetails {
 161     my ( $borrowernumber, $cardnumber ) = @_;
 162     my $dbh = C4::Context->dbh;
 163     my $query;
 164     my $sth;
 165     if ($borrowernumber) {
 166         $sth = $dbh->prepare("
 167             SELECT borrowers.*,
 168                    category_type,
 169                    categories.description,
 170                    categories.BlockExpiredPatronOpacActions,
 171                    reservefee,
 172                    enrolmentperiod
 173             FROM borrowers
 174             LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
 175             WHERE borrowernumber = ?
 176         ");
 177         $sth->execute($borrowernumber);
 178     }
 179     elsif ($cardnumber) {
 180         $sth = $dbh->prepare("
 181             SELECT borrowers.*,
 182                    category_type,
 183                    categories.description,
 184                    categories.BlockExpiredPatronOpacActions,
 185                    reservefee,
 186                    enrolmentperiod
 187             FROM borrowers
 188             LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
 189             WHERE cardnumber = ?
 190         ");
 191         $sth->execute($cardnumber);
 192     }
 193     else {
 194         return;
 195     }
 196     my $borrower = $sth->fetchrow_hashref;
 197     return unless $borrower;
 198     my ($amount) = GetMemberAccountRecords($borrower->{borrowernumber});
 199     $borrower->{'amountoutstanding'} = $amount;
 200     # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
 201     my $flags = patronflags( $borrower);
 202     my $accessflagshash;
 203
 204     $sth = $dbh->prepare("select bit,flag from userflags");
 205     $sth->execute;
 206     while ( my ( $bit, $flag ) = $sth->fetchrow ) {
 207         if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
 208             $accessflagshash->{$flag} = 1;
 209         }
 210     }
 211     $borrower->{'flags'}     = $flags;
 212     $borrower->{'authflags'} = $accessflagshash;
 213
 214     # Handle setting the true behavior for BlockExpiredPatronOpacActions
 215     $borrower->{'BlockExpiredPatronOpacActions'} =
 216       C4::Context->preference('BlockExpiredPatronOpacActions')
 217       if ( $borrower->{'BlockExpiredPatronOpacActions'} == -1 );
 218
 219     $borrower->{'is_expired'} = 0;
 220     $borrower->{'is_expired'} = 1 if
 221       defined($borrower->{dateexpiry}) &&
 222       $borrower->{'dateexpiry'} ne '0000-00-00' &&
 223       Date_to_Days( Today() ) >
 224       Date_to_Days( split /-/, $borrower->{'dateexpiry'} );
 225
 226     return ($borrower);    #, $flags, $accessflagshash);
 227 }
 228
 229 =head2 patronflags
 230
 231  $flags = &patronflags($patron);
 232
 233 This function is not exported.
 234
 235 The following will be set where applicable:
 236  $flags->{CHARGES}->{amount}        Amount of debt
 237  $flags->{CHARGES}->{noissues}      Set if debt amount >$5.00 (or syspref noissuescharge)
 238  $flags->{CHARGES}->{message}       Message -- deprecated
 239
 240  $flags->{CREDITS}->{amount}        Amount of credit
 241  $flags->{CREDITS}->{message}       Message -- deprecated
 242
 243  $flags->{  GNA  }                  Patron has no valid address
 244  $flags->{  GNA  }->{noissues}      Set for each GNA
 245  $flags->{  GNA  }->{message}       "Borrower has no valid address" -- deprecated
 246
 247  $flags->{ LOST  }                  Patron's card reported lost
 248  $flags->{ LOST  }->{noissues}      Set for each LOST
 249  $flags->{ LOST  }->{message}       Message -- deprecated
 250
 251  $flags->{DBARRED}                  Set if patron debarred, no access
 252  $flags->{DBARRED}->{noissues}      Set for each DBARRED
 253  $flags->{DBARRED}->{message}       Message -- deprecated
 254
 255  $flags->{ NOTES }
 256  $flags->{ NOTES }->{message}       The note itself.  NOT deprecated
 257
 258  $flags->{ ODUES }                  Set if patron has overdue books.
 259  $flags->{ ODUES }->{message}       "Yes"  -- deprecated
 260  $flags->{ ODUES }->{itemlist}      ref-to-array: list of overdue books
 261  $flags->{ ODUES }->{itemlisttext}  Text list of overdue items -- deprecated
 262
 263  $flags->{WAITING}                  Set if any of patron's reserves are available
 264  $flags->{WAITING}->{message}       Message -- deprecated
 265  $flags->{WAITING}->{itemlist}      ref-to-array: list of available items
 266
 267 =over
 268
 269 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
 270 overdue items. Its elements are references-to-hash, each describing an
 271 overdue item. The keys are selected fields from the issues, biblio,
 272 biblioitems, and items tables of the Koha database.
 273
 274 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
 275 the overdue items, one per line.  Deprecated.
 276
 277 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
 278 available items. Each element is a reference-to-hash whose keys are
 279 fields from the reserves table of the Koha database.
 280
 281 =back
 282
 283 All the "message" fields that include language generated in this function are deprecated,
 284 because such strings belong properly in the display layer.
 285
 286 The "message" field that comes from the DB is OK.
 287
 288 =cut
 289
 290 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
 291 # FIXME rename this function.
 292 sub patronflags {
 293     my %flags;
 294     my ( $patroninformation) = @_;
 295     my $dbh=C4::Context->dbh;
 296     my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
 297     if ( $owing > 0 ) {
 298         my %flaginfo;
 299         my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
 300         $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
 301         $flaginfo{'amount'}  = sprintf "%.02f", $owing;
 302         if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
 303             $flaginfo{'noissues'} = 1;
 304         }
 305         $flags{'CHARGES'} = \%flaginfo;
 306     }
 307     elsif ( $balance < 0 ) {
 308         my %flaginfo;
 309         $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
 310         $flaginfo{'amount'}  = sprintf "%.02f", $balance;
 311         $flags{'CREDITS'} = \%flaginfo;
 312     }
 313
 314     # Check the debt of the guarntees of this patron
 315     my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
 316     $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
 317     if ( defined $no_issues_charge_guarantees ) {
 318         my $p = Koha::Patrons->find( $patroninformation->{borrowernumber} );
 319         my @guarantees = $p->guarantees();
 320         my $guarantees_non_issues_charges;
 321         foreach my $g ( @guarantees ) {
 322             my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
 323             $guarantees_non_issues_charges += $n;
 324         }
 325
 326         if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
 327             my %flaginfo;
 328             $flaginfo{'message'} = sprintf 'patron guarantees owe %.02f', $guarantees_non_issues_charges;
 329             $flaginfo{'amount'}  = $guarantees_non_issues_charges;
 330             $flaginfo{'noissues'} = 1 unless C4::Context->preference("allowfineoverride");
 331             $flags{'CHARGES_GUARANTEES'} = \%flaginfo;
 332         }
 333     }
 334
 335     if (   $patroninformation->{'gonenoaddress'}
 336         && $patroninformation->{'gonenoaddress'} == 1 )
 337     {
 338         my %flaginfo;
 339         $flaginfo{'message'}  = 'Borrower has no valid address.';
 340         $flaginfo{'noissues'} = 1;
 341         $flags{'GNA'}         = \%flaginfo;
 342     }
 343     if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
 344         my %flaginfo;
 345         $flaginfo{'message'}  = 'Borrower\'s card reported lost.';
 346         $flaginfo{'noissues'} = 1;
 347         $flags{'LOST'}        = \%flaginfo;
 348     }
 349     if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
 350         if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
 351             my %flaginfo;
 352             $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
 353             $flaginfo{'message'}         = $patroninformation->{'debarredcomment'};
 354             $flaginfo{'noissues'}        = 1;
 355             $flaginfo{'dateend'}         = $patroninformation->{'debarred'};
 356             $flags{'DBARRED'}           = \%flaginfo;
 357         }
 358     }
 359     if (   $patroninformation->{'borrowernotes'}
 360         && $patroninformation->{'borrowernotes'} )
 361     {
 362         my %flaginfo;
 363         $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
 364         $flags{'NOTES'}      = \%flaginfo;
 365     }
 366     my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
 367     if ( $odues && $odues > 0 ) {
 368         my %flaginfo;
 369         $flaginfo{'message'}  = "Yes";
 370         $flaginfo{'itemlist'} = $itemsoverdue;
 371         foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
 372             @$itemsoverdue )
 373         {
 374             $flaginfo{'itemlisttext'} .=
 375               "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n";  # newline is display layer
 376         }
 377         $flags{'ODUES'} = \%flaginfo;
 378     }
 379     my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
 380     my $nowaiting = scalar @itemswaiting;
 381     if ( $nowaiting > 0 ) {
 382         my %flaginfo;
 383         $flaginfo{'message'}  = "Reserved items available";
 384         $flaginfo{'itemlist'} = \@itemswaiting;
 385         $flags{'WAITING'}     = \%flaginfo;
 386     }
 387     return ( \%flags );
 388 }
 389
 390
 391 =head2 GetMember
 392
 393   $borrower = &GetMember(%information);
 394
 395 Retrieve the first patron record meeting on criteria listed in the
 396 C<%information> hash, which should contain one or more
 397 pairs of borrowers column names and values, e.g.,
 398
 399    $borrower = GetMember(borrowernumber => id);
 400
 401 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
 402 the C<borrowers> table in the Koha database.
 403
 404 FIXME: GetMember() is used throughout the code as a lookup
 405 on a unique key such as the borrowernumber, but this meaning is not
 406 enforced in the routine itself.
 407
 408 =cut
 409
 410 #'
 411 sub GetMember {
 412     my ( %information ) = @_;
 413     if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
 414         #passing mysql's kohaadmin?? Makes no sense as a query
 415         return;
 416     }
 417     my $dbh = C4::Context->dbh;
 418     my $select =
 419     q{SELECT borrowers.*, categories.category_type, categories.description
 420     FROM borrowers
 421     LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
 422     my $more_p = 0;
 423     my @values = ();
 424     for (keys %information ) {
 425         if ($more_p) {
 426             $select .= ' AND ';
 427         }
 428         else {
 429             $more_p++;
 430         }
 431
 432         if (defined $information{$_}) {
 433             $select .= "$_ = ?";
 434             push @values, $information{$_};
 435         }
 436         else {
 437             $select .= "$_ IS NULL";
 438         }
 439     }
 440     $debug && warn $select, " ",values %information;
 441     my $sth = $dbh->prepare("$select");
 442     $sth->execute(@values);
 443     my $data = $sth->fetchall_arrayref({});
 444     #FIXME interface to this routine now allows generation of a result set
 445     #so whole array should be returned but bowhere in the current code expects this
 446     if (@{$data} ) {
 447         return $data->[0];
 448     }
 449
 450     return;
 451 }
 452
 453 =head2 GetMemberIssuesAndFines
 454
 455   ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
 456
 457 Returns aggregate data about items borrowed by the patron with the
 458 given borrowernumber.
 459
 460 C<&GetMemberIssuesAndFines> returns a three-element array.  C<$overdue_count> is the
 461 number of overdue items the patron currently has borrowed. C<$issue_count> is the
 462 number of books the patron currently has borrowed.  C<$total_fines> is
 463 the total fine currently due by the borrower.
 464
 465 =cut
 466
 467 #'
 468 sub GetMemberIssuesAndFines {
 469     my ( $borrowernumber ) = @_;
 470     my $dbh   = C4::Context->dbh;
 471     my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
 472
 473     $debug and warn $query."\n";
 474     my $sth = $dbh->prepare($query);
 475     $sth->execute($borrowernumber);
 476     my $issue_count = $sth->fetchrow_arrayref->[0];
 477
 478     $sth = $dbh->prepare(
 479         "SELECT COUNT(*) FROM issues
 480          WHERE borrowernumber = ?
 481          AND date_due < now()"
 482     );
 483     $sth->execute($borrowernumber);
 484     my $overdue_count = $sth->fetchrow_arrayref->[0];
 485
 486     $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
 487     $sth->execute($borrowernumber);
 488     my $total_fines = $sth->fetchrow_arrayref->[0];
 489
 490     return ($overdue_count, $issue_count, $total_fines);
 491 }
 492
 493
 494 =head2 ModMember
 495
 496   my $success = ModMember(borrowernumber => $borrowernumber,
 497                                             [ field => value ]... );
 498
 499 Modify borrower's data.  All date fields should ALREADY be in ISO format.
 500
 501 return :
 502 true on success, or false on failure
 503
 504 =cut
 505
 506 sub ModMember {
 507     my (%data) = @_;
 508     # test to know if you must update or not the borrower password
 509     if (exists $data{password}) {
 510         if ($data{password} eq '****' or $data{password} eq '') {
 511             delete $data{password};
 512         } else {
 513             if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
 514                 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
 515                 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
 516             }
 517             $data{password} = hash_password($data{password});
 518         }
 519     }
 520
 521     my $old_categorycode = Koha::Patrons->find( $data{borrowernumber} )->categorycode;
 522
 523     # get only the columns of a borrower
 524     my $schema = Koha::Database->new()->schema;
 525     my @columns = $schema->source('Borrower')->columns;
 526     my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
 527     delete $new_borrower->{flags};
 528
 529     $new_borrower->{dateofbirth}     ||= undef if exists $new_borrower->{dateofbirth};
 530     $new_borrower->{dateenrolled}    ||= undef if exists $new_borrower->{dateenrolled};
 531     $new_borrower->{dateexpiry}      ||= undef if exists $new_borrower->{dateexpiry};
 532     $new_borrower->{debarred}        ||= undef if exists $new_borrower->{debarred};
 533     $new_borrower->{sms_provider_id} ||= undef if exists $new_borrower->{sms_provider_id};
 534     $new_borrower->{guarantorid}     ||= undef if exists $new_borrower->{guarantorid};
 535
 536     my $patron = Koha::Patrons->find( $new_borrower->{borrowernumber} );
 537
 538     delete $new_borrower->{userid} if exists $new_borrower->{userid} and not $new_borrower->{userid};
 539
 540     my $execute_success = $patron->store if $patron->set($new_borrower);
 541
 542     if ($execute_success) { # only proceed if the update was a success
 543         # If the patron changes to a category with enrollment fee, we add a fee
 544         if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
 545             if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
 546                 $patron->add_enrolment_fee_if_needed;
 547             }
 548         }
 549
 550         # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
 551         # cronjob will use for syncing with NL
 552         if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
 553             my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
 554                 'synctype'       => 'norwegianpatrondb',
 555                 'borrowernumber' => $data{'borrowernumber'}
 556             });
 557             # Do not set to "edited" if syncstatus is "new". We need to sync as new before
 558             # we can sync as changed. And the "new sync" will pick up all changes since
 559             # the patron was created anyway.
 560             if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
 561                 $borrowersync->update( { 'syncstatus' => 'edited' } );
 562             }
 563             # Set the value of 'sync'
 564             $borrowersync->update( { 'sync' => $data{'sync'} } );
 565             # Try to do the live sync
 566             Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
 567         }
 568
 569         logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
 570     }
 571     return $execute_success;
 572 }
 573
 574 =head2 AddMember
 575
 576   $borrowernumber = &AddMember(%borrower);
 577
 578 insert new borrower into table
 579
 580 (%borrower keys are database columns. Database columns could be
 581 different in different versions. Please look into database for correct
 582 column names.)
 583
 584 Returns the borrowernumber upon success
 585
 586 Returns as undef upon any db error without further processing
 587
 588 =cut
 589
 590 #'
 591 sub AddMember {
 592     my (%data) = @_;
 593     my $dbh = C4::Context->dbh;
 594     my $schema = Koha::Database->new()->schema;
 595
 596     # generate a proper login if none provided
 597     $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
 598       if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
 599
 600     # add expiration date if it isn't already there
 601     $data{dateexpiry} ||= Koha::Patron::Categories->find( $data{categorycode} )->get_expiry_date;
 602
 603     # add enrollment date if it isn't already there
 604     unless ( $data{'dateenrolled'} ) {
 605         $data{'dateenrolled'} = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
 606     }
 607
 608     my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
 609     $data{'privacy'} =
 610         $patron_category->default_privacy() eq 'default' ? 1
 611       : $patron_category->default_privacy() eq 'never'   ? 2
 612       : $patron_category->default_privacy() eq 'forever' ? 0
 613       :                                                    undef;
 614
 615     $data{'privacy_guarantor_checkouts'} = 0 unless defined( $data{'privacy_guarantor_checkouts'} );
 616
 617     # Make a copy of the plain text password for later use
 618     my $plain_text_password = $data{'password'};
 619
 620     # create a disabled account if no password provided
 621     $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
 622
 623     # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
 624     $data{'dateofbirth'}     = undef if ( not $data{'dateofbirth'} );
 625     $data{'debarred'}        = undef if ( not $data{'debarred'} );
 626     $data{'sms_provider_id'} = undef if ( not $data{'sms_provider_id'} );
 627
 628     # get only the columns of Borrower
 629     # FIXME Do we really need this check?
 630     my @columns = $schema->source('Borrower')->columns;
 631     my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} )  : () } keys(%data) } ;
 632
 633     delete $new_member->{borrowernumber};
 634
 635     my $patron = Koha::Patron->new( $new_member )->store;
 636     $data{borrowernumber} = $patron->borrowernumber;
 637
 638     # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
 639     # cronjob will use for syncing with NL
 640     if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
 641         Koha::Database->new->schema->resultset('BorrowerSync')->create({
 642             'borrowernumber' => $data{'borrowernumber'},
 643             'synctype'       => 'norwegianpatrondb',
 644             'sync'           => 1,
 645             'syncstatus'     => 'new',
 646             'hashed_pin'     => Koha::NorwegianPatronDB::NLEncryptPIN( $plain_text_password ),
 647         });
 648     }
 649
 650     logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
 651
 652     $patron->add_enrolment_fee_if_needed;
 653
 654     return $data{borrowernumber};
 655 }
 656
 657 =head2 Check_Userid
 658
 659     my $uniqueness = Check_Userid($userid,$borrowernumber);
 660
 661     $borrowernumber is optional (i.e. it can contain a blank value). If $userid is passed with a blank $borrowernumber variable, the database will be checked for all instances of that userid (i.e. userid=? AND borrowernumber != '').
 662
 663     If $borrowernumber is provided, the database will be checked for every instance of that userid coupled with a different borrower(number) than the one provided.
 664
 665     return :
 666         0 for not unique (i.e. this $userid already exists)
 667         1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
 668
 669 =cut
 670
 671 sub Check_Userid {
 672     my ( $uid, $borrowernumber ) = @_;
 673
 674     return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
 675
 676     return 0 if ( $uid eq C4::Context->config('user') );
 677
 678     my $rs = Koha::Database->new()->schema()->resultset('Borrower');
 679
 680     my $params;
 681     $params->{userid} = $uid;
 682     $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
 683
 684     my $count = $rs->count( $params );
 685
 686     return $count ? 0 : 1;
 687 }
 688
 689 =head2 Generate_Userid
 690
 691     my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
 692
 693     Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
 694
 695     $borrowernumber is optional (i.e. it can contain a blank value). A value is passed when generating a new userid for an existing borrower. When a new userid is created for a new borrower, a blank value is passed to this sub.
 696
 697     return :
 698         new userid ($firstname.$surname if there is a $firstname, or $surname if there is no value in $firstname) plus offset (0 if the $newuid is unique, or a higher numeric value if Check_Userid finds an existing match for the $newuid in the database).
 699
 700 =cut
 701
 702 sub Generate_Userid {
 703   my ($borrowernumber, $firstname, $surname) = @_;
 704   my $newuid;
 705   my $offset = 0;
 706   #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
 707   do {
 708     $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
 709     $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
 710     $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
 711     $newuid = unac_string('utf-8',$newuid);
 712     $newuid .= $offset unless $offset == 0;
 713     $offset++;
 714
 715    } while (!Check_Userid($newuid,$borrowernumber));
 716
 717    return $newuid;
 718 }
 719
 720 =head2 fixup_cardnumber
 721
 722 Warning: The caller is responsible for locking the members table in write
 723 mode, to avoid database corruption.
 724
 725 =cut
 726
 727 use vars qw( @weightings );
 728 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
 729
 730 sub fixup_cardnumber {
 731     my ($cardnumber) = @_;
 732     my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
 733
 734     # Find out whether member numbers should be generated
 735     # automatically. Should be either "1" or something else.
 736     # Defaults to "0", which is interpreted as "no".
 737
 738     #     if ($cardnumber !~ /\S/ && $autonumber_members) {
 739     ($autonumber_members) or return $cardnumber;
 740     my $checkdigit = C4::Context->preference('checkdigit');
 741     my $dbh = C4::Context->dbh;
 742     if ( $checkdigit and $checkdigit eq 'katipo' ) {
 743
 744         # if checkdigit is selected, calculate katipo-style cardnumber.
 745         # otherwise, just use the max()
 746         # purpose: generate checksum'd member numbers.
 747         # We'll assume we just got the max value of digits 2-8 of member #'s
 748         # from the database and our job is to increment that by one,
 749         # determine the 1st and 9th digits and return the full string.
 750         my $sth = $dbh->prepare(
 751             "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
 752         );
 753         $sth->execute;
 754         my $data = $sth->fetchrow_hashref;
 755         $cardnumber = $data->{new_num};
 756         if ( !$cardnumber ) {    # If DB has no values,
 757             $cardnumber = 1000000;    # start at 1000000
 758         } else {
 759             $cardnumber += 1;
 760         }
 761
 762         my $sum = 0;
 763         for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
 764             # read weightings, left to right, 1 char at a time
 765             my $temp1 = $weightings[$i];
 766
 767             # sequence left to right, 1 char at a time
 768             my $temp2 = substr( $cardnumber, $i, 1 );
 769
 770             # mult each char 1-7 by its corresponding weighting
 771             $sum += $temp1 * $temp2;
 772         }
 773
 774         my $rem = ( $sum % 11 );
 775         $rem = 'X' if $rem == 10;
 776
 777         return "V$cardnumber$rem";
 778      } else {
 779
 780         my $sth = $dbh->prepare(
 781             'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
 782         );
 783         $sth->execute;
 784         my ($result) = $sth->fetchrow;
 785         return $result + 1;
 786     }
 787     return $cardnumber;     # just here as a fallback/reminder
 788 }
 789
 790 =head2 GetPendingIssues
 791
 792   my $issues = &GetPendingIssues(@borrowernumber);
 793
 794 Looks up what the patron with the given borrowernumber has borrowed.
 795
 796 C<&GetPendingIssues> returns a
 797 reference-to-array where each element is a reference-to-hash; the
 798 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
 799 The keys include C<biblioitems> fields except marc and marcxml.
 800
 801 =cut
 802
 803 sub GetPendingIssues {
 804     my @borrowernumbers = @_;
 805
 806     unless (@borrowernumbers ) { # return a ref_to_array
 807         return \@borrowernumbers; # to not cause surprise to caller
 808     }
 809
 810     # Borrowers part of the query
 811     my $bquery = '';
 812     for (my $i = 0; $i < @borrowernumbers; $i++) {
 813         $bquery .= ' issues.borrowernumber = ?';
 814         if ($i < $#borrowernumbers ) {
 815             $bquery .= ' OR';
 816         }
 817     }
 818
 819     # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
 820     # FIXME: namespace collision: each table has "timestamp" fields.  Which one is "timestamp" ?
 821     # FIXME: circ/ciculation.pl tries to sort by timestamp!
 822     # FIXME: namespace collision: other collisions possible.
 823     # FIXME: most of this data isn't really being used by callers.
 824     my $query =
 825    "SELECT issues.*,
 826             items.*,
 827            biblio.*,
 828            biblioitems.volume,
 829            biblioitems.number,
 830            biblioitems.itemtype,
 831            biblioitems.isbn,
 832            biblioitems.issn,
 833            biblioitems.publicationyear,
 834            biblioitems.publishercode,
 835            biblioitems.volumedate,
 836            biblioitems.volumedesc,
 837            biblioitems.lccn,
 838            biblioitems.url,
 839            borrowers.firstname,
 840            borrowers.surname,
 841            borrowers.cardnumber,
 842            issues.timestamp AS timestamp,
 843            issues.renewals  AS renewals,
 844            issues.borrowernumber AS borrowernumber,
 845             items.renewals  AS totalrenewals
 846     FROM   issues
 847     LEFT JOIN items       ON items.itemnumber       =      issues.itemnumber
 848     LEFT JOIN biblio      ON items.biblionumber     =      biblio.biblionumber
 849     LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
 850     LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
 851     WHERE
 852       $bquery
 853     ORDER BY issues.issuedate"
 854     ;
 855
 856     my $sth = C4::Context->dbh->prepare($query);
 857     $sth->execute(@borrowernumbers);
 858     my $data = $sth->fetchall_arrayref({});
 859     my $today = dt_from_string;
 860     foreach (@{$data}) {
 861         if ($_->{issuedate}) {
 862             $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
 863         }
 864         $_->{date_due_sql} = $_->{date_due};
 865         # FIXME no need to have this value
 866         $_->{date_due} or next;
 867         $_->{date_due_sql} = $_->{date_due};
 868         # FIXME no need to have this value
 869         $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
 870         if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
 871             $_->{overdue} = 1;
 872         }
 873     }
 874     return $data;
 875 }
 876
 877 =head2 GetAllIssues
 878
 879   $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
 880
 881 Looks up what the patron with the given borrowernumber has borrowed,
 882 and sorts the results.
 883
 884 C<$sortkey> is the name of a field on which to sort the results. This
 885 should be the name of a field in the C<issues>, C<biblio>,
 886 C<biblioitems>, or C<items> table in the Koha database.
 887
 888 C<$limit> is the maximum number of results to return.
 889
 890 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
 891 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
 892 C<items> tables of the Koha database.
 893
 894 =cut
 895
 896 #'
 897 sub GetAllIssues {
 898     my ( $borrowernumber, $order, $limit ) = @_;
 899
 900     return unless $borrowernumber;
 901     $order = 'date_due desc' unless $order;
 902
 903     my $dbh = C4::Context->dbh;
 904     my $query =
 905 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
 906   FROM issues
 907   LEFT JOIN items on items.itemnumber=issues.itemnumber
 908   LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
 909   LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
 910   WHERE borrowernumber=?
 911   UNION ALL
 912   SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
 913   FROM old_issues
 914   LEFT JOIN items on items.itemnumber=old_issues.itemnumber
 915   LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
 916   LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
 917   WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
 918   order by ' . $order;
 919     if ($limit) {
 920         $query .= " limit $limit";
 921     }
 922
 923     my $sth = $dbh->prepare($query);
 924     $sth->execute( $borrowernumber, $borrowernumber );
 925     return $sth->fetchall_arrayref( {} );
 926 }
 927
 928
 929 =head2 GetMemberAccountRecords
 930
 931   ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
 932
 933 Looks up accounting data for the patron with the given borrowernumber.
 934
 935 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
 936 reference-to-array, where each element is a reference-to-hash; the
 937 keys are the fields of the C<accountlines> table in the Koha database.
 938 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
 939 total amount outstanding for all of the account lines.
 940
 941 =cut
 942
 943 sub GetMemberAccountRecords {
 944     my ($borrowernumber) = @_;
 945     my $dbh = C4::Context->dbh;
 946     my @acctlines;
 947     my $numlines = 0;
 948     my $strsth      = qq(
 949                         SELECT *
 950                         FROM accountlines
 951                         WHERE borrowernumber=?);
 952     $strsth.=" ORDER BY accountlines_id desc";
 953     my $sth= $dbh->prepare( $strsth );
 954     $sth->execute( $borrowernumber );
 955
 956     my $total = 0;
 957     while ( my $data = $sth->fetchrow_hashref ) {
 958         if ( $data->{itemnumber} ) {
 959             my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
 960             $data->{biblionumber} = $biblio->{biblionumber};
 961             $data->{title}        = $biblio->{title};
 962         }
 963         $acctlines[$numlines] = $data;
 964         $numlines++;
 965         $total += sprintf "%.0f", 1000*$data->{amountoutstanding}; # convert float to integer to avoid round-off errors
 966     }
 967     $total /= 1000;
 968     return ( $total, \@acctlines,$numlines);
 969 }
 970
 971 =head2 GetMemberAccountBalance
 972
 973   ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
 974
 975 Calculates amount immediately owing by the patron - non-issue charges.
 976 Based on GetMemberAccountRecords.
 977 Charges exempt from non-issue are:
 978 * Res (reserves)
 979 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
 980 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
 981
 982 =cut
 983
 984 sub GetMemberAccountBalance {
 985     my ($borrowernumber) = @_;
 986
 987     my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
 988
 989     my @not_fines;
 990     push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
 991     push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
 992     unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
 993         my $dbh = C4::Context->dbh;
 994         my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
 995         push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
 996     }
 997     my %not_fine = map {$_ => 1} @not_fines;
 998
 999     my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1000     my $other_charges = 0;
1001     foreach (@$acctlines) {
1002         $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1003     }
1004
1005     return ( $total, $total - $other_charges, $other_charges);
1006 }
1007
1008 =head2 GetBorNotifyAcctRecord
1009
1010   ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1011
1012 Looks up accounting data for the patron with the given borrowernumber per file number.
1013
1014 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1015 reference-to-array, where each element is a reference-to-hash; the
1016 keys are the fields of the C<accountlines> table in the Koha database.
1017 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1018 total amount outstanding for all of the account lines.
1019
1020 =cut
1021
1022 sub GetBorNotifyAcctRecord {
1023     my ( $borrowernumber, $notifyid ) = @_;
1024     my $dbh = C4::Context->dbh;
1025     my @acctlines;
1026     my $numlines = 0;
1027     my $sth = $dbh->prepare(
1028             "SELECT *
1029                 FROM accountlines
1030                 WHERE borrowernumber=?
1031                     AND notify_id=?
1032                     AND amountoutstanding != '0'
1033                 ORDER BY notify_id,accounttype
1034                 ");
1035
1036     $sth->execute( $borrowernumber, $notifyid );
1037     my $total = 0;
1038     while ( my $data = $sth->fetchrow_hashref ) {
1039         if ( $data->{itemnumber} ) {
1040             my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1041             $data->{biblionumber} = $biblio->{biblionumber};
1042             $data->{title}        = $biblio->{title};
1043         }
1044         $acctlines[$numlines] = $data;
1045         $numlines++;
1046         $total += int(100 * $data->{'amountoutstanding'});
1047     }
1048     $total /= 100;
1049     return ( $total, \@acctlines, $numlines );
1050 }
1051
1052 sub checkcardnumber {
1053     my ( $cardnumber, $borrowernumber ) = @_;
1054
1055     # If cardnumber is null, we assume they're allowed.
1056     return 0 unless defined $cardnumber;
1057
1058     my $dbh = C4::Context->dbh;
1059     my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1060     $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1061     my $sth = $dbh->prepare($query);
1062     $sth->execute(
1063         $cardnumber,
1064         ( $borrowernumber ? $borrowernumber : () )
1065     );
1066
1067     return 1 if $sth->fetchrow_hashref;
1068
1069     my ( $min_length, $max_length ) = get_cardnumber_length();
1070     return 2
1071         if length $cardnumber > $max_length
1072         or length $cardnumber < $min_length;
1073
1074     return 0;
1075 }
1076
1077 =head2 get_cardnumber_length
1078
1079     my ($min, $max) = C4::Members::get_cardnumber_length()
1080
1081 Returns the minimum and maximum length for patron cardnumbers as
1082 determined by the CardnumberLength system preference, the
1083 BorrowerMandatoryField system preference, and the width of the
1084 database column.
1085
1086 =cut
1087
1088 sub get_cardnumber_length {
1089     my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1090     $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1091     if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1092         # Is integer and length match
1093         if ( $cardnumber_length =~ m|^\d+$| ) {
1094             $min = $max = $cardnumber_length
1095                 if $cardnumber_length >= $min
1096                     and $cardnumber_length <= $max;
1097         }
1098         # Else assuming it is a range
1099         elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1100             $min = $1 if $1 and $min < $1;
1101             $max = $2 if $2 and $max > $2;
1102         }
1103
1104     }
1105     $min = 16 if $min > 16;
1106     return ( $min, $max );
1107 }
1108
1109 =head2 GetFirstValidEmailAddress
1110
1111   $email = GetFirstValidEmailAddress($borrowernumber);
1112
1113 Return the first valid email address for a borrower, given the borrowernumber.  For now, the order
1114 is defined as email, emailpro, B_email.  Returns the empty string if the borrower has no email
1115 addresses.
1116
1117 =cut
1118
1119 sub GetFirstValidEmailAddress {
1120     my $borrowernumber = shift;
1121     my $dbh = C4::Context->dbh;
1122     my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1123     $sth->execute( $borrowernumber );
1124     my $data = $sth->fetchrow_hashref;
1125
1126     if ($data->{'email'}) {
1127        return $data->{'email'};
1128     } elsif ($data->{'emailpro'}) {
1129        return $data->{'emailpro'};
1130     } elsif ($data->{'B_email'}) {
1131        return $data->{'B_email'};
1132     } else {
1133        return '';
1134     }
1135 }
1136
1137 =head2 GetNoticeEmailAddress
1138
1139   $email = GetNoticeEmailAddress($borrowernumber);
1140
1141 Return the email address of borrower used for notices, given the borrowernumber.
1142 Returns the empty string if no email address.
1143
1144 =cut
1145
1146 sub GetNoticeEmailAddress {
1147     my $borrowernumber = shift;
1148
1149     my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1150     # if syspref is set to 'first valid' (value == OFF), look up email address
1151     if ( $which_address eq 'OFF' ) {
1152         return GetFirstValidEmailAddress($borrowernumber);
1153     }
1154     # specified email address field
1155     my $dbh = C4::Context->dbh;
1156     my $sth = $dbh->prepare( qq{
1157         SELECT $which_address AS primaryemail
1158         FROM borrowers
1159         WHERE borrowernumber=?
1160     } );
1161     $sth->execute($borrowernumber);
1162     my $data = $sth->fetchrow_hashref;
1163     return $data->{'primaryemail'} || '';
1164 }
1165
1166 =head2 GetUpcomingMembershipExpires
1167
1168     my $expires = GetUpcomingMembershipExpires({
1169         branch => $branch, before => $before, after => $after,
1170     });
1171
1172     $branch is an optional branch code.
1173     $before/$after is an optional number of days before/after the date that
1174     is set by the preference MembershipExpiryDaysNotice.
1175     If the pref would be 14, before 2 and after 3, you will get all expires
1176     from 12 to 17 days.
1177
1178 =cut
1179
1180 sub GetUpcomingMembershipExpires {
1181     my ( $params ) = @_;
1182     my $before = $params->{before} || 0;
1183     my $after  = $params->{after} || 0;
1184     my $branch = $params->{branch};
1185
1186     my $dbh = C4::Context->dbh;
1187     my $days = C4::Context->preference("MembershipExpiryDaysNotice") || 0;
1188     my $date1 = dt_from_string->add( days => $days - $before );
1189     my $date2 = dt_from_string->add( days => $days + $after );
1190     $date1= output_pref({ dt => $date1, dateformat => 'iso', dateonly => 1 });
1191     $date2= output_pref({ dt => $date2, dateformat => 'iso', dateonly => 1 });
1192
1193     my $query = q|
1194         SELECT borrowers.*, categories.description,
1195         branches.branchname, branches.branchemail FROM borrowers
1196         LEFT JOIN branches USING (branchcode)
1197         LEFT JOIN categories USING (categorycode)
1198     |;
1199     if( $branch ) {
1200         $query.= 'WHERE branchcode=? AND dateexpiry BETWEEN ? AND ?';
1201     } else {
1202         $query.= 'WHERE dateexpiry BETWEEN ? AND ?';
1203     }
1204
1205     my $sth = $dbh->prepare( $query );
1206     my @pars = $branch? ( $branch ): ();
1207     push @pars, $date1, $date2;
1208     $sth->execute( @pars );
1209     my $results = $sth->fetchall_arrayref( {} );
1210     return $results;
1211 }
1212
1213 =head2 GetAge
1214
1215   $dateofbirth,$date = &GetAge($date);
1216
1217 this function return the borrowers age with the value of dateofbirth
1218
1219 =cut
1220
1221 #'
1222 sub GetAge{
1223     my ( $date, $date_ref ) = @_;
1224
1225     if ( not defined $date_ref ) {
1226         $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1227     }
1228
1229     my ( $year1, $month1, $day1 ) = split /-/, $date;
1230     my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1231
1232     my $age = $year2 - $year1;
1233     if ( $month1 . $day1 > $month2 . $day2 ) {
1234         $age--;
1235     }
1236
1237     return $age;
1238 }    # sub get_age
1239
1240 =head2 SetAge
1241
1242   $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1243   $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1244   $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1245
1246   eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1247   if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1248
1249 This function sets the borrower's dateofbirth to match the given age.
1250 Optionally relative to the given $datetime_reference.
1251
1252 @PARAM1 koha.borrowers-object
1253 @PARAM2 DateTime::Duration-object as the desired age
1254         OR a ISO 8601 Date. (To make the API more pleasant)
1255 @PARAM3 DateTime-object as the relative date, defaults to now().
1256 RETURNS The given borrower reference @PARAM1.
1257 DIES    If there was an error with the ISO Date handling.
1258
1259 =cut
1260
1261 #'
1262 sub SetAge{
1263     my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1264     $datetime_ref = DateTime->now() unless $datetime_ref;
1265
1266     if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1267         if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1268             $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1269         }
1270         else {
1271             die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1272         }
1273     }
1274
1275     my $new_datetime_ref = $datetime_ref->clone();
1276     $new_datetime_ref->subtract_duration( $datetimeduration );
1277
1278     $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1279
1280     return $borrower;
1281 }    # sub SetAge
1282
1283 =head2 GetHideLostItemsPreference
1284
1285   $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1286
1287 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1288 C<&$hidelostitemspref>return value of function, 0 or 1
1289
1290 =cut
1291
1292 sub GetHideLostItemsPreference {
1293     my ($borrowernumber) = @_;
1294     my $dbh = C4::Context->dbh;
1295     my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1296     my $sth = $dbh->prepare($query);
1297     $sth->execute($borrowernumber);
1298     my $hidelostitems = $sth->fetchrow;
1299     return $hidelostitems;
1300 }
1301
1302 =head2 GetBorrowersToExpunge
1303
1304   $borrowers = &GetBorrowersToExpunge(
1305       not_borrowed_since => $not_borrowed_since,
1306       expired_before       => $expired_before,
1307       category_code        => $category_code,
1308       patron_list_id       => $patron_list_id,
1309       branchcode           => $branchcode
1310   );
1311
1312   This function get all borrowers based on the given criteria.
1313
1314 =cut
1315
1316 sub GetBorrowersToExpunge {
1317
1318     my $params = shift;
1319     my $filterdate       = $params->{'not_borrowed_since'};
1320     my $filterexpiry     = $params->{'expired_before'};
1321     my $filterlastseen   = $params->{'last_seen'};
1322     my $filtercategory   = $params->{'category_code'};
1323     my $filterbranch     = $params->{'branchcode'} ||
1324                         ((C4::Context->preference('IndependentBranches')
1325                              && C4::Context->userenv
1326                              && !C4::Context->IsSuperLibrarian()
1327                              && C4::Context->userenv->{branch})
1328                          ? C4::Context->userenv->{branch}
1329                          : "");
1330     my $filterpatronlist = $params->{'patron_list_id'};
1331
1332     my $dbh   = C4::Context->dbh;
1333     my $query = q|
1334         SELECT borrowers.borrowernumber,
1335                MAX(old_issues.timestamp) AS latestissue,
1336                MAX(issues.timestamp) AS currentissue
1337         FROM   borrowers
1338         JOIN   categories USING (categorycode)
1339         LEFT JOIN (
1340             SELECT guarantorid
1341             FROM borrowers
1342             WHERE guarantorid IS NOT NULL
1343                 AND guarantorid <> 0
1344         ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
1345         LEFT JOIN old_issues USING (borrowernumber)
1346         LEFT JOIN issues USING (borrowernumber)|;
1347     if ( $filterpatronlist  ){
1348         $query .= q| LEFT JOIN patron_list_patrons USING (borrowernumber)|;
1349     }
1350     $query .= q| WHERE  category_type <> 'S'
1351         AND tmp.guarantorid IS NULL
1352    |;
1353     my @query_params;
1354     if ( $filterbranch && $filterbranch ne "" ) {
1355         $query.= " AND borrowers.branchcode = ? ";
1356         push( @query_params, $filterbranch );
1357     }
1358     if ( $filterexpiry ) {
1359         $query .= " AND dateexpiry < ? ";
1360         push( @query_params, $filterexpiry );
1361     }
1362     if ( $filterlastseen ) {
1363         $query .= ' AND lastseen < ? ';
1364         push @query_params, $filterlastseen;
1365     }
1366     if ( $filtercategory ) {
1367         $query .= " AND categorycode = ? ";
1368         push( @query_params, $filtercategory );
1369     }
1370     if ( $filterpatronlist ){
1371         $query.=" AND patron_list_id = ? ";
1372         push( @query_params, $filterpatronlist );
1373     }
1374     $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
1375     if ( $filterdate ) {
1376         $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
1377         push @query_params,$filterdate;
1378     }
1379     warn $query if $debug;
1380
1381     my $sth = $dbh->prepare($query);
1382     if (scalar(@query_params)>0){
1383         $sth->execute(@query_params);
1384     }
1385     else {
1386         $sth->execute;
1387     }
1388
1389     my @results;
1390     while ( my $data = $sth->fetchrow_hashref ) {
1391         push @results, $data;
1392     }
1393     return \@results;
1394 }
1395
1396 =head2 GetBorrowersWhoHaveNeverBorrowed
1397
1398   $results = &GetBorrowersWhoHaveNeverBorrowed
1399
1400 This function get all borrowers who have never borrowed.
1401
1402 I<$result> is a ref to an array which all elements are a hasref.
1403
1404 =cut
1405
1406 sub GetBorrowersWhoHaveNeverBorrowed {
1407     my $filterbranch = shift ||
1408                         ((C4::Context->preference('IndependentBranches')
1409                              && C4::Context->userenv
1410                              && !C4::Context->IsSuperLibrarian()
1411                              && C4::Context->userenv->{branch})
1412                          ? C4::Context->userenv->{branch}
1413                          : "");
1414     my $dbh   = C4::Context->dbh;
1415     my $query = "
1416         SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1417         FROM   borrowers
1418           LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1419         WHERE issues.borrowernumber IS NULL
1420    ";
1421     my @query_params;
1422     if ($filterbranch && $filterbranch ne ""){
1423         $query.=" AND borrowers.branchcode= ?";
1424         push @query_params,$filterbranch;
1425     }
1426     warn $query if $debug;
1427
1428     my $sth = $dbh->prepare($query);
1429     if (scalar(@query_params)>0){
1430         $sth->execute(@query_params);
1431     }
1432     else {
1433         $sth->execute;
1434     }
1435
1436     my @results;
1437     while ( my $data = $sth->fetchrow_hashref ) {
1438         push @results, $data;
1439     }
1440     return \@results;
1441 }
1442
1443 =head2 GetBorrowersWithIssuesHistoryOlderThan
1444
1445   $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1446
1447 this function get all borrowers who has an issue history older than I<$date> given on input arg.
1448
1449 I<$result> is a ref to an array which all elements are a hashref.
1450 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1451
1452 =cut
1453
1454 sub GetBorrowersWithIssuesHistoryOlderThan {
1455     my $dbh  = C4::Context->dbh;
1456     my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
1457     my $filterbranch = shift ||
1458                         ((C4::Context->preference('IndependentBranches')
1459                              && C4::Context->userenv
1460                              && !C4::Context->IsSuperLibrarian()
1461                              && C4::Context->userenv->{branch})
1462                          ? C4::Context->userenv->{branch}
1463                          : "");
1464     my $query = "
1465        SELECT count(borrowernumber) as n,borrowernumber
1466        FROM old_issues
1467        WHERE returndate < ?
1468          AND borrowernumber IS NOT NULL
1469     ";
1470     my @query_params;
1471     push @query_params, $date;
1472     if ($filterbranch){
1473         $query.="   AND branchcode = ?";
1474         push @query_params, $filterbranch;
1475     }
1476     $query.=" GROUP BY borrowernumber ";
1477     warn $query if $debug;
1478     my $sth = $dbh->prepare($query);
1479     $sth->execute(@query_params);
1480     my @results;
1481
1482     while ( my $data = $sth->fetchrow_hashref ) {
1483         push @results, $data;
1484     }
1485     return \@results;
1486 }
1487
1488 =head2 IssueSlip
1489
1490   IssueSlip($branchcode, $borrowernumber, $quickslip)
1491
1492   Returns letter hash ( see C4::Letters::GetPreparedLetter )
1493
1494   $quickslip is boolean, to indicate whether we want a quick slip
1495
1496   IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
1497
1498   Both slips:
1499
1500       <<branches.*>>
1501       <<borrowers.*>>
1502
1503   ISSUESLIP:
1504
1505       <checkedout>
1506          <<biblio.*>>
1507          <<items.*>>
1508          <<biblioitems.*>>
1509          <<issues.*>>
1510       </checkedout>
1511
1512       <overdue>
1513          <<biblio.*>>
1514          <<items.*>>
1515          <<biblioitems.*>>
1516          <<issues.*>>
1517       </overdue>
1518
1519       <news>
1520          <<opac_news.*>>
1521       </news>
1522
1523   ISSUEQSLIP:
1524
1525       <checkedout>
1526          <<biblio.*>>
1527          <<items.*>>
1528          <<biblioitems.*>>
1529          <<issues.*>>
1530       </checkedout>
1531
1532   NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
1533
1534 =cut
1535
1536 sub IssueSlip {
1537     my ($branch, $borrowernumber, $quickslip) = @_;
1538
1539     # FIXME Check callers before removing this statement
1540     #return unless $borrowernumber;
1541
1542     my @issues = @{ GetPendingIssues($borrowernumber) };
1543
1544     for my $issue (@issues) {
1545         $issue->{date_due} = $issue->{date_due_sql};
1546         if ($quickslip) {
1547             my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
1548             if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
1549                 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
1550                   $issue->{now} = 1;
1551             };
1552         }
1553     }
1554
1555     # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
1556     @issues = sort {
1557         my $s = $b->{timestamp} <=> $a->{timestamp};
1558         $s == 0 ?
1559              $b->{issuedate} <=> $a->{issuedate} : $s;
1560     } @issues;
1561
1562     my ($letter_code, %repeat);
1563     if ( $quickslip ) {
1564         $letter_code = 'ISSUEQSLIP';
1565         %repeat =  (
1566             'checkedout' => [ map {
1567                 'biblio'       => $_,
1568                 'items'        => $_,
1569                 'biblioitems'  => $_,
1570                 'issues'       => $_,
1571             }, grep { $_->{'now'} } @issues ],
1572         );
1573     }
1574     else {
1575         $letter_code = 'ISSUESLIP';
1576         %repeat =  (
1577             'checkedout' => [ map {
1578                 'biblio'       => $_,
1579                 'items'        => $_,
1580                 'biblioitems'  => $_,
1581                 'issues'       => $_,
1582             }, grep { !$_->{'overdue'} } @issues ],
1583
1584             'overdue' => [ map {
1585                 'biblio'       => $_,
1586                 'items'        => $_,
1587                 'biblioitems'  => $_,
1588                 'issues'       => $_,
1589             }, grep { $_->{'overdue'} } @issues ],
1590
1591             'news' => [ map {
1592                 $_->{'timestamp'} = $_->{'newdate'};
1593                 { opac_news => $_ }
1594             } @{ GetNewsToDisplay("slip",$branch) } ],
1595         );
1596     }
1597
1598     return  C4::Letters::GetPreparedLetter (
1599         module => 'circulation',
1600         letter_code => $letter_code,
1601         branchcode => $branch,
1602         tables => {
1603             'branches'    => $branch,
1604             'borrowers'   => $borrowernumber,
1605         },
1606         repeat => \%repeat,
1607     );
1608 }
1609
1610 =head2 GetBorrowersWithEmail
1611
1612     ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
1613
1614 This gets a list of users and their basic details from their email address.
1615 As it's possible for multiple user to have the same email address, it provides
1616 you with all of them. If there is no userid for the user, there will be an
1617 C<undef> there. An empty list will be returned if there are no matches.
1618
1619 =cut
1620
1621 sub GetBorrowersWithEmail {
1622     my $email = shift;
1623
1624     my $dbh = C4::Context->dbh;
1625
1626     my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
1627     my $sth=$dbh->prepare($query);
1628     $sth->execute($email);
1629     my @result = ();
1630     while (my $ref = $sth->fetch) {
1631         push @result, $ref;
1632     }
1633     die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
1634     return @result;
1635 }
1636
1637 =head2 AddMember_Opac
1638
1639 =cut
1640
1641 sub AddMember_Opac {
1642     my ( %borrower ) = @_;
1643
1644     $borrower{'categorycode'} //= C4::Context->preference('PatronSelfRegistrationDefaultCategory');
1645     if (not defined $borrower{'password'}){
1646         my $sr = new String::Random;
1647         $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
1648         my $password = $sr->randpattern("AAAAAAAAAA");
1649         $borrower{'password'} = $password;
1650     }
1651
1652     $borrower{'cardnumber'} = fixup_cardnumber( $borrower{'cardnumber'} );
1653
1654     my $borrowernumber = AddMember(%borrower);
1655
1656     return ( $borrowernumber, $borrower{'password'} );
1657 }
1658
1659 =head2 DeleteExpiredOpacRegistrations
1660
1661     Delete accounts that haven't been upgraded from the 'temporary' category
1662     Returns the number of removed patrons
1663
1664 =cut
1665
1666 sub DeleteExpiredOpacRegistrations {
1667
1668     my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
1669     my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
1670
1671     return 0 if not $category_code or not defined $delay or $delay eq q||;
1672
1673     my $query = qq|
1674 SELECT borrowernumber
1675 FROM borrowers
1676 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
1677
1678     my $dbh = C4::Context->dbh;
1679     my $sth = $dbh->prepare($query);
1680     $sth->execute( $category_code, $delay );
1681     my $cnt=0;
1682     while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
1683         Koha::Patrons->find($borrowernumber)->delete;
1684         $cnt++;
1685     }
1686     return $cnt;
1687 }
1688
1689 =head2 DeleteUnverifiedOpacRegistrations
1690
1691     Delete all unverified self registrations in borrower_modifications,
1692     older than the specified number of days.
1693
1694 =cut
1695
1696 sub DeleteUnverifiedOpacRegistrations {
1697     my ( $days ) = @_;
1698     my $dbh = C4::Context->dbh;
1699     my $sql=qq|
1700 DELETE FROM borrower_modifications
1701 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
1702     my $cnt=$dbh->do($sql, undef, ($days) );
1703     return $cnt eq '0E0'? 0: $cnt;
1704 }
1705
1706 sub GetOverduesForPatron {
1707     my ( $borrowernumber ) = @_;
1708
1709     my $sql = "
1710         SELECT *
1711         FROM issues, items, biblio, biblioitems
1712         WHERE items.itemnumber=issues.itemnumber
1713           AND biblio.biblionumber   = items.biblionumber
1714           AND biblio.biblionumber   = biblioitems.biblionumber
1715           AND issues.borrowernumber = ?
1716           AND date_due < NOW()
1717     ";
1718
1719     my $sth = C4::Context->dbh->prepare( $sql );
1720     $sth->execute( $borrowernumber );
1721
1722     return $sth->fetchall_arrayref({});
1723 }
1724
1725 END { }    # module clean-up code here (global destructor)
1726
1727 1;
1728
1729 __END__
1730
1731 =head1 AUTHOR
1732
1733 Koha Team
1734
1735 =cut