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 Add_Delta_YM 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
  47 our (@ISA,@EXPORT,@EXPORT_OK,$debug);
  48
  49 use Module::Load::Conditional qw( can_load );
  50 if ( ! can_load( modules => { 'Koha::NorwegianPatronDB' => undef } ) ) {
  51    $debug && warn "Unable to load Koha::NorwegianPatronDB";
  52 }
  53
  54
  55 BEGIN {
  56     $debug = $ENV{DEBUG} || 0;
  57     require Exporter;
  58     @ISA = qw(Exporter);
  59     #Get data
  60     push @EXPORT, qw(
  61         &Search
  62         &GetMemberDetails
  63         &GetMember
  64
  65         &GetMemberIssuesAndFines
  66         &GetPendingIssues
  67         &GetAllIssues
  68
  69         &GetFirstValidEmailAddress
  70         &GetNoticeEmailAddress
  71
  72         &GetAge
  73         &GetSortDetails
  74         &GetTitles
  75
  76         &GetHideLostItemsPreference
  77
  78         &IsMemberBlocked
  79         &GetMemberAccountRecords
  80         &GetBorNotifyAcctRecord
  81
  82         &GetborCatFromCatType
  83         &GetBorrowercategory
  84         GetBorrowerCategorycode
  85         &GetBorrowercategoryList
  86
  87         &GetBorrowersToExpunge
  88         &GetBorrowersWhoHaveNeverBorrowed
  89         &GetBorrowersWithIssuesHistoryOlderThan
  90
  91         &GetExpiryDate
  92         &GetUpcomingMembershipExpires
  93
  94         &IssueSlip
  95         GetBorrowersWithEmail
  96
  97         HasOverdues
  98         GetOverduesForPatron
  99     );
 100
 101     #Modify data
 102     push @EXPORT, qw(
 103         &ModMember
 104         &changepassword
 105     );
 106
 107     #Delete data
 108     push @EXPORT, qw(
 109         &DelMember
 110     );
 111
 112     #Insert data
 113     push @EXPORT, qw(
 114         &AddMember
 115         &AddMember_Opac
 116         &MoveMemberToDeleted
 117         &ExtendMemberSubscriptionTo
 118     );
 119
 120     #Check data
 121     push @EXPORT, qw(
 122         &checkuniquemember
 123         &checkuserpassword
 124         &Check_Userid
 125         &Generate_Userid
 126         &fixup_cardnumber
 127         &checkcardnumber
 128     );
 129 }
 130
 131 =head1 NAME
 132
 133 C4::Members - Perl Module containing convenience functions for member handling
 134
 135 =head1 SYNOPSIS
 136
 137 use C4::Members;
 138
 139 =head1 DESCRIPTION
 140
 141 This module contains routines for adding, modifying and deleting members/patrons/borrowers
 142
 143 =head1 FUNCTIONS
 144
 145 =head2 GetMemberDetails
 146
 147 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
 148
 149 Looks up a patron and returns information about him or her. If
 150 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
 151 up the borrower by number; otherwise, it looks up the borrower by card
 152 number.
 153
 154 C<$borrower> is a reference-to-hash whose keys are the fields of the
 155 borrowers table in the Koha database. In addition,
 156 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
 157 about the patron. Its keys act as flags :
 158
 159     if $borrower->{flags}->{LOST} {
 160         # Patron's card was reported lost
 161     }
 162
 163 If the state of a flag means that the patron should not be
 164 allowed to borrow any more books, then it will have a C<noissues> key
 165 with a true value.
 166
 167 See patronflags for more details.
 168
 169 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
 170 about the top-level permissions flags set for the borrower.  For example,
 171 if a user has the "editcatalogue" permission,
 172 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
 173 the value "1".
 174
 175 =cut
 176
 177 sub GetMemberDetails {
 178     my ( $borrowernumber, $cardnumber ) = @_;
 179     my $dbh = C4::Context->dbh;
 180     my $query;
 181     my $sth;
 182     if ($borrowernumber) {
 183         $sth = $dbh->prepare("
 184             SELECT borrowers.*,
 185                    category_type,
 186                    categories.description,
 187                    categories.BlockExpiredPatronOpacActions,
 188                    reservefee,
 189                    enrolmentperiod
 190             FROM borrowers
 191             LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
 192             WHERE borrowernumber = ?
 193         ");
 194         $sth->execute($borrowernumber);
 195     }
 196     elsif ($cardnumber) {
 197         $sth = $dbh->prepare("
 198             SELECT borrowers.*,
 199                    category_type,
 200                    categories.description,
 201                    categories.BlockExpiredPatronOpacActions,
 202                    reservefee,
 203                    enrolmentperiod
 204             FROM borrowers
 205             LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
 206             WHERE cardnumber = ?
 207         ");
 208         $sth->execute($cardnumber);
 209     }
 210     else {
 211         return;
 212     }
 213     my $borrower = $sth->fetchrow_hashref;
 214     return unless $borrower;
 215     my ($amount) = GetMemberAccountRecords($borrower->{borrowernumber});
 216     $borrower->{'amountoutstanding'} = $amount;
 217     # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
 218     my $flags = patronflags( $borrower);
 219     my $accessflagshash;
 220
 221     $sth = $dbh->prepare("select bit,flag from userflags");
 222     $sth->execute;
 223     while ( my ( $bit, $flag ) = $sth->fetchrow ) {
 224         if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
 225             $accessflagshash->{$flag} = 1;
 226         }
 227     }
 228     $borrower->{'flags'}     = $flags;
 229     $borrower->{'authflags'} = $accessflagshash;
 230
 231     # Handle setting the true behavior for BlockExpiredPatronOpacActions
 232     $borrower->{'BlockExpiredPatronOpacActions'} =
 233       C4::Context->preference('BlockExpiredPatronOpacActions')
 234       if ( $borrower->{'BlockExpiredPatronOpacActions'} == -1 );
 235
 236     $borrower->{'is_expired'} = 0;
 237     $borrower->{'is_expired'} = 1 if
 238       defined($borrower->{dateexpiry}) &&
 239       $borrower->{'dateexpiry'} ne '0000-00-00' &&
 240       Date_to_Days( Today() ) >
 241       Date_to_Days( split /-/, $borrower->{'dateexpiry'} );
 242
 243     return ($borrower);    #, $flags, $accessflagshash);
 244 }
 245
 246 =head2 patronflags
 247
 248  $flags = &patronflags($patron);
 249
 250 This function is not exported.
 251
 252 The following will be set where applicable:
 253  $flags->{CHARGES}->{amount}        Amount of debt
 254  $flags->{CHARGES}->{noissues}      Set if debt amount >$5.00 (or syspref noissuescharge)
 255  $flags->{CHARGES}->{message}       Message -- deprecated
 256
 257  $flags->{CREDITS}->{amount}        Amount of credit
 258  $flags->{CREDITS}->{message}       Message -- deprecated
 259
 260  $flags->{  GNA  }                  Patron has no valid address
 261  $flags->{  GNA  }->{noissues}      Set for each GNA
 262  $flags->{  GNA  }->{message}       "Borrower has no valid address" -- deprecated
 263
 264  $flags->{ LOST  }                  Patron's card reported lost
 265  $flags->{ LOST  }->{noissues}      Set for each LOST
 266  $flags->{ LOST  }->{message}       Message -- deprecated
 267
 268  $flags->{DBARRED}                  Set if patron debarred, no access
 269  $flags->{DBARRED}->{noissues}      Set for each DBARRED
 270  $flags->{DBARRED}->{message}       Message -- deprecated
 271
 272  $flags->{ NOTES }
 273  $flags->{ NOTES }->{message}       The note itself.  NOT deprecated
 274
 275  $flags->{ ODUES }                  Set if patron has overdue books.
 276  $flags->{ ODUES }->{message}       "Yes"  -- deprecated
 277  $flags->{ ODUES }->{itemlist}      ref-to-array: list of overdue books
 278  $flags->{ ODUES }->{itemlisttext}  Text list of overdue items -- deprecated
 279
 280  $flags->{WAITING}                  Set if any of patron's reserves are available
 281  $flags->{WAITING}->{message}       Message -- deprecated
 282  $flags->{WAITING}->{itemlist}      ref-to-array: list of available items
 283
 284 =over
 285
 286 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
 287 overdue items. Its elements are references-to-hash, each describing an
 288 overdue item. The keys are selected fields from the issues, biblio,
 289 biblioitems, and items tables of the Koha database.
 290
 291 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
 292 the overdue items, one per line.  Deprecated.
 293
 294 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
 295 available items. Each element is a reference-to-hash whose keys are
 296 fields from the reserves table of the Koha database.
 297
 298 =back
 299
 300 All the "message" fields that include language generated in this function are deprecated,
 301 because such strings belong properly in the display layer.
 302
 303 The "message" field that comes from the DB is OK.
 304
 305 =cut
 306
 307 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
 308 # FIXME rename this function.
 309 sub patronflags {
 310     my %flags;
 311     my ( $patroninformation) = @_;
 312     my $dbh=C4::Context->dbh;
 313     my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
 314     if ( $owing > 0 ) {
 315         my %flaginfo;
 316         my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
 317         $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
 318         $flaginfo{'amount'}  = sprintf "%.02f", $owing;
 319         if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
 320             $flaginfo{'noissues'} = 1;
 321         }
 322         $flags{'CHARGES'} = \%flaginfo;
 323     }
 324     elsif ( $balance < 0 ) {
 325         my %flaginfo;
 326         $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
 327         $flaginfo{'amount'}  = sprintf "%.02f", $balance;
 328         $flags{'CREDITS'} = \%flaginfo;
 329     }
 330
 331     # Check the debt of the guarntees of this patron
 332     my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
 333     $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
 334     if ( defined $no_issues_charge_guarantees ) {
 335         my $p = Koha::Patrons->find( $patroninformation->{borrowernumber} );
 336         my @guarantees = $p->guarantees();
 337         my $guarantees_non_issues_charges;
 338         foreach my $g ( @guarantees ) {
 339             my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
 340             $guarantees_non_issues_charges += $n;
 341         }
 342
 343         if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
 344             my %flaginfo;
 345             $flaginfo{'message'} = sprintf 'patron guarantees owe %.02f', $guarantees_non_issues_charges;
 346             $flaginfo{'amount'}  = $guarantees_non_issues_charges;
 347             $flaginfo{'noissues'} = 1 unless C4::Context->preference("allowfineoverride");
 348             $flags{'CHARGES_GUARANTEES'} = \%flaginfo;
 349         }
 350     }
 351
 352     if (   $patroninformation->{'gonenoaddress'}
 353         && $patroninformation->{'gonenoaddress'} == 1 )
 354     {
 355         my %flaginfo;
 356         $flaginfo{'message'}  = 'Borrower has no valid address.';
 357         $flaginfo{'noissues'} = 1;
 358         $flags{'GNA'}         = \%flaginfo;
 359     }
 360     if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
 361         my %flaginfo;
 362         $flaginfo{'message'}  = 'Borrower\'s card reported lost.';
 363         $flaginfo{'noissues'} = 1;
 364         $flags{'LOST'}        = \%flaginfo;
 365     }
 366     if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
 367         if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
 368             my %flaginfo;
 369             $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
 370             $flaginfo{'message'}         = $patroninformation->{'debarredcomment'};
 371             $flaginfo{'noissues'}        = 1;
 372             $flaginfo{'dateend'}         = $patroninformation->{'debarred'};
 373             $flags{'DBARRED'}           = \%flaginfo;
 374         }
 375     }
 376     if (   $patroninformation->{'borrowernotes'}
 377         && $patroninformation->{'borrowernotes'} )
 378     {
 379         my %flaginfo;
 380         $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
 381         $flags{'NOTES'}      = \%flaginfo;
 382     }
 383     my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
 384     if ( $odues && $odues > 0 ) {
 385         my %flaginfo;
 386         $flaginfo{'message'}  = "Yes";
 387         $flaginfo{'itemlist'} = $itemsoverdue;
 388         foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
 389             @$itemsoverdue )
 390         {
 391             $flaginfo{'itemlisttext'} .=
 392               "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n";  # newline is display layer
 393         }
 394         $flags{'ODUES'} = \%flaginfo;
 395     }
 396     my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
 397     my $nowaiting = scalar @itemswaiting;
 398     if ( $nowaiting > 0 ) {
 399         my %flaginfo;
 400         $flaginfo{'message'}  = "Reserved items available";
 401         $flaginfo{'itemlist'} = \@itemswaiting;
 402         $flags{'WAITING'}     = \%flaginfo;
 403     }
 404     return ( \%flags );
 405 }
 406
 407
 408 =head2 GetMember
 409
 410   $borrower = &GetMember(%information);
 411
 412 Retrieve the first patron record meeting on criteria listed in the
 413 C<%information> hash, which should contain one or more
 414 pairs of borrowers column names and values, e.g.,
 415
 416    $borrower = GetMember(borrowernumber => id);
 417
 418 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
 419 the C<borrowers> table in the Koha database.
 420
 421 FIXME: GetMember() is used throughout the code as a lookup
 422 on a unique key such as the borrowernumber, but this meaning is not
 423 enforced in the routine itself.
 424
 425 =cut
 426
 427 #'
 428 sub GetMember {
 429     my ( %information ) = @_;
 430     if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
 431         #passing mysql's kohaadmin?? Makes no sense as a query
 432         return;
 433     }
 434     my $dbh = C4::Context->dbh;
 435     my $select =
 436     q{SELECT borrowers.*, categories.category_type, categories.description
 437     FROM borrowers
 438     LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
 439     my $more_p = 0;
 440     my @values = ();
 441     for (keys %information ) {
 442         if ($more_p) {
 443             $select .= ' AND ';
 444         }
 445         else {
 446             $more_p++;
 447         }
 448
 449         if (defined $information{$_}) {
 450             $select .= "$_ = ?";
 451             push @values, $information{$_};
 452         }
 453         else {
 454             $select .= "$_ IS NULL";
 455         }
 456     }
 457     $debug && warn $select, " ",values %information;
 458     my $sth = $dbh->prepare("$select");
 459     $sth->execute(@values);
 460     my $data = $sth->fetchall_arrayref({});
 461     #FIXME interface to this routine now allows generation of a result set
 462     #so whole array should be returned but bowhere in the current code expects this
 463     if (@{$data} ) {
 464         return $data->[0];
 465     }
 466
 467     return;
 468 }
 469
 470 =head2 IsMemberBlocked
 471
 472   my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
 473
 474 Returns whether a patron is restricted or has overdue items that may result
 475 in a block of circulation privileges.
 476
 477 C<$block_status> can have the following values:
 478
 479 1 if the patron is currently restricted, in which case
 480 C<$count> is the expiration date (9999-12-31 for indefinite)
 481
 482 -1 if the patron has overdue items, in which case C<$count> is the number of them
 483
 484 0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
 485
 486 Existing active restrictions are checked before current overdue items.
 487
 488 =cut
 489
 490 sub IsMemberBlocked {
 491     my $borrowernumber = shift;
 492     my $dbh            = C4::Context->dbh;
 493
 494     my $blockeddate = Koha::Patrons->find( $borrowernumber )->is_debarred;
 495
 496     return ( 1, $blockeddate ) if $blockeddate;
 497
 498     # if he have late issues
 499     my $sth = $dbh->prepare(
 500         "SELECT COUNT(*) as latedocs
 501          FROM issues
 502          WHERE borrowernumber = ?
 503          AND date_due < now()"
 504     );
 505     $sth->execute($borrowernumber);
 506     my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
 507
 508     return ( -1, $latedocs ) if $latedocs > 0;
 509
 510     return ( 0, 0 );
 511 }
 512
 513 =head2 GetMemberIssuesAndFines
 514
 515   ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
 516
 517 Returns aggregate data about items borrowed by the patron with the
 518 given borrowernumber.
 519
 520 C<&GetMemberIssuesAndFines> returns a three-element array.  C<$overdue_count> is the
 521 number of overdue items the patron currently has borrowed. C<$issue_count> is the
 522 number of books the patron currently has borrowed.  C<$total_fines> is
 523 the total fine currently due by the borrower.
 524
 525 =cut
 526
 527 #'
 528 sub GetMemberIssuesAndFines {
 529     my ( $borrowernumber ) = @_;
 530     my $dbh   = C4::Context->dbh;
 531     my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
 532
 533     $debug and warn $query."\n";
 534     my $sth = $dbh->prepare($query);
 535     $sth->execute($borrowernumber);
 536     my $issue_count = $sth->fetchrow_arrayref->[0];
 537
 538     $sth = $dbh->prepare(
 539         "SELECT COUNT(*) FROM issues
 540          WHERE borrowernumber = ?
 541          AND date_due < now()"
 542     );
 543     $sth->execute($borrowernumber);
 544     my $overdue_count = $sth->fetchrow_arrayref->[0];
 545
 546     $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
 547     $sth->execute($borrowernumber);
 548     my $total_fines = $sth->fetchrow_arrayref->[0];
 549
 550     return ($overdue_count, $issue_count, $total_fines);
 551 }
 552
 553
 554 =head2 columns
 555
 556   my @columns = C4::Member::columns();
 557
 558 Returns an array of borrowers' table columns on success,
 559 and an empty array on failure.
 560
 561 =cut
 562
 563 sub columns {
 564
 565     # Pure ANSI SQL goodness.
 566     my $sql = 'SELECT * FROM borrowers WHERE 1=0;';
 567
 568     # Get the database handle.
 569     my $dbh = C4::Context->dbh;
 570
 571     # Run the SQL statement to load STH's readonly properties.
 572     my $sth = $dbh->prepare($sql);
 573     my $rv = $sth->execute();
 574
 575     # This only fails if the table doesn't exist.
 576     # This will always be called AFTER an install or upgrade,
 577     # so borrowers will exist!
 578     my @data;
 579     if ($sth->{NUM_OF_FIELDS}>0) {
 580         @data = @{$sth->{NAME}};
 581     }
 582     else {
 583         @data = ();
 584     }
 585     return @data;
 586 }
 587
 588
 589 =head2 ModMember
 590
 591   my $success = ModMember(borrowernumber => $borrowernumber,
 592                                             [ field => value ]... );
 593
 594 Modify borrower's data.  All date fields should ALREADY be in ISO format.
 595
 596 return :
 597 true on success, or false on failure
 598
 599 =cut
 600
 601 sub ModMember {
 602     my (%data) = @_;
 603     # test to know if you must update or not the borrower password
 604     if (exists $data{password}) {
 605         if ($data{password} eq '****' or $data{password} eq '') {
 606             delete $data{password};
 607         } else {
 608             if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
 609                 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
 610                 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
 611             }
 612             $data{password} = hash_password($data{password});
 613         }
 614     }
 615
 616     my $old_categorycode = GetBorrowerCategorycode( $data{borrowernumber} );
 617
 618     # get only the columns of a borrower
 619     my $schema = Koha::Database->new()->schema;
 620     my @columns = $schema->source('Borrower')->columns;
 621     my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
 622     delete $new_borrower->{flags};
 623
 624     $new_borrower->{dateofbirth}     ||= undef if exists $new_borrower->{dateofbirth};
 625     $new_borrower->{dateenrolled}    ||= undef if exists $new_borrower->{dateenrolled};
 626     $new_borrower->{dateexpiry}      ||= undef if exists $new_borrower->{dateexpiry};
 627     $new_borrower->{debarred}        ||= undef if exists $new_borrower->{debarred};
 628     $new_borrower->{sms_provider_id} ||= undef if exists $new_borrower->{sms_provider_id};
 629
 630     my $rs = $schema->resultset('Borrower')->search({
 631         borrowernumber => $new_borrower->{borrowernumber},
 632      });
 633
 634     delete $new_borrower->{userid} if exists $new_borrower->{userid} and not $new_borrower->{userid};
 635
 636     my $execute_success = $rs->update($new_borrower);
 637     if ($execute_success ne '0E0') { # only proceed if the update was a success
 638         # If the patron changes to a category with enrollment fee, we add a fee
 639         if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
 640             if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
 641                 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
 642             }
 643         }
 644
 645         # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
 646         # cronjob will use for syncing with NL
 647         if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
 648             my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
 649                 'synctype'       => 'norwegianpatrondb',
 650                 'borrowernumber' => $data{'borrowernumber'}
 651             });
 652             # Do not set to "edited" if syncstatus is "new". We need to sync as new before
 653             # we can sync as changed. And the "new sync" will pick up all changes since
 654             # the patron was created anyway.
 655             if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
 656                 $borrowersync->update( { 'syncstatus' => 'edited' } );
 657             }
 658             # Set the value of 'sync'
 659             $borrowersync->update( { 'sync' => $data{'sync'} } );
 660             # Try to do the live sync
 661             Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
 662         }
 663
 664         logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
 665     }
 666     return $execute_success;
 667 }
 668
 669 =head2 AddMember
 670
 671   $borrowernumber = &AddMember(%borrower);
 672
 673 insert new borrower into table
 674
 675 (%borrower keys are database columns. Database columns could be
 676 different in different versions. Please look into database for correct
 677 column names.)
 678
 679 Returns the borrowernumber upon success
 680
 681 Returns as undef upon any db error without further processing
 682
 683 =cut
 684
 685 #'
 686 sub AddMember {
 687     my (%data) = @_;
 688     my $dbh = C4::Context->dbh;
 689     my $schema = Koha::Database->new()->schema;
 690
 691     # generate a proper login if none provided
 692     $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
 693       if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
 694
 695     # add expiration date if it isn't already there
 696     unless ( $data{'dateexpiry'} ) {
 697         $data{'dateexpiry'} = GetExpiryDate( $data{'categorycode'}, output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } ) );
 698     }
 699
 700     # add enrollment date if it isn't already there
 701     unless ( $data{'dateenrolled'} ) {
 702         $data{'dateenrolled'} = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
 703     }
 704
 705     my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
 706     $data{'privacy'} =
 707         $patron_category->default_privacy() eq 'default' ? 1
 708       : $patron_category->default_privacy() eq 'never'   ? 2
 709       : $patron_category->default_privacy() eq 'forever' ? 0
 710       :                                                    undef;
 711
 712     $data{'privacy_guarantor_checkouts'} = 0 unless defined( $data{'privacy_guarantor_checkouts'} );
 713
 714     # Make a copy of the plain text password for later use
 715     my $plain_text_password = $data{'password'};
 716
 717     # create a disabled account if no password provided
 718     $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
 719
 720     # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
 721     $data{'dateofbirth'}     = undef if ( not $data{'dateofbirth'} );
 722     $data{'debarred'}        = undef if ( not $data{'debarred'} );
 723     $data{'sms_provider_id'} = undef if ( not $data{'sms_provider_id'} );
 724
 725     # get only the columns of Borrower
 726     my @columns = $schema->source('Borrower')->columns;
 727     my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} )  : () } keys(%data) } ;
 728     $new_member->{checkprevcheckout} ||= 'inherit';
 729     delete $new_member->{borrowernumber};
 730
 731     my $rs = $schema->resultset('Borrower');
 732     $data{borrowernumber} = $rs->create($new_member)->id;
 733
 734     # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
 735     # cronjob will use for syncing with NL
 736     if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
 737         Koha::Database->new->schema->resultset('BorrowerSync')->create({
 738             'borrowernumber' => $data{'borrowernumber'},
 739             'synctype'       => 'norwegianpatrondb',
 740             'sync'           => 1,
 741             'syncstatus'     => 'new',
 742             'hashed_pin'     => Koha::NorwegianPatronDB::NLEncryptPIN( $plain_text_password ),
 743         });
 744     }
 745
 746     # mysql_insertid is probably bad.  not necessarily accurate and mysql-specific at best.
 747     logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
 748
 749     AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
 750
 751     return $data{borrowernumber};
 752 }
 753
 754 =head2 Check_Userid
 755
 756     my $uniqueness = Check_Userid($userid,$borrowernumber);
 757
 758     $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 != '').
 759
 760     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.
 761
 762     return :
 763         0 for not unique (i.e. this $userid already exists)
 764         1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
 765
 766 =cut
 767
 768 sub Check_Userid {
 769     my ( $uid, $borrowernumber ) = @_;
 770
 771     return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
 772
 773     return 0 if ( $uid eq C4::Context->config('user') );
 774
 775     my $rs = Koha::Database->new()->schema()->resultset('Borrower');
 776
 777     my $params;
 778     $params->{userid} = $uid;
 779     $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
 780
 781     my $count = $rs->count( $params );
 782
 783     return $count ? 0 : 1;
 784 }
 785
 786 =head2 Generate_Userid
 787
 788     my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
 789
 790     Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
 791
 792     $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.
 793
 794     return :
 795         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).
 796
 797 =cut
 798
 799 sub Generate_Userid {
 800   my ($borrowernumber, $firstname, $surname) = @_;
 801   my $newuid;
 802   my $offset = 0;
 803   #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
 804   do {
 805     $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
 806     $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
 807     $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
 808     $newuid = unac_string('utf-8',$newuid);
 809     $newuid .= $offset unless $offset == 0;
 810     $offset++;
 811
 812    } while (!Check_Userid($newuid,$borrowernumber));
 813
 814    return $newuid;
 815 }
 816
 817 =head2 fixup_cardnumber
 818
 819 Warning: The caller is responsible for locking the members table in write
 820 mode, to avoid database corruption.
 821
 822 =cut
 823
 824 use vars qw( @weightings );
 825 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
 826
 827 sub fixup_cardnumber {
 828     my ($cardnumber) = @_;
 829     my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
 830
 831     # Find out whether member numbers should be generated
 832     # automatically. Should be either "1" or something else.
 833     # Defaults to "0", which is interpreted as "no".
 834
 835     #     if ($cardnumber !~ /\S/ && $autonumber_members) {
 836     ($autonumber_members) or return $cardnumber;
 837     my $checkdigit = C4::Context->preference('checkdigit');
 838     my $dbh = C4::Context->dbh;
 839     if ( $checkdigit and $checkdigit eq 'katipo' ) {
 840
 841         # if checkdigit is selected, calculate katipo-style cardnumber.
 842         # otherwise, just use the max()
 843         # purpose: generate checksum'd member numbers.
 844         # We'll assume we just got the max value of digits 2-8 of member #'s
 845         # from the database and our job is to increment that by one,
 846         # determine the 1st and 9th digits and return the full string.
 847         my $sth = $dbh->prepare(
 848             "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
 849         );
 850         $sth->execute;
 851         my $data = $sth->fetchrow_hashref;
 852         $cardnumber = $data->{new_num};
 853         if ( !$cardnumber ) {    # If DB has no values,
 854             $cardnumber = 1000000;    # start at 1000000
 855         } else {
 856             $cardnumber += 1;
 857         }
 858
 859         my $sum = 0;
 860         for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
 861             # read weightings, left to right, 1 char at a time
 862             my $temp1 = $weightings[$i];
 863
 864             # sequence left to right, 1 char at a time
 865             my $temp2 = substr( $cardnumber, $i, 1 );
 866
 867             # mult each char 1-7 by its corresponding weighting
 868             $sum += $temp1 * $temp2;
 869         }
 870
 871         my $rem = ( $sum % 11 );
 872         $rem = 'X' if $rem == 10;
 873
 874         return "V$cardnumber$rem";
 875      } else {
 876
 877         my $sth = $dbh->prepare(
 878             'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
 879         );
 880         $sth->execute;
 881         my ($result) = $sth->fetchrow;
 882         return $result + 1;
 883     }
 884     return $cardnumber;     # just here as a fallback/reminder
 885 }
 886
 887 =head2 GetPendingIssues
 888
 889   my $issues = &GetPendingIssues(@borrowernumber);
 890
 891 Looks up what the patron with the given borrowernumber has borrowed.
 892
 893 C<&GetPendingIssues> returns a
 894 reference-to-array where each element is a reference-to-hash; the
 895 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
 896 The keys include C<biblioitems> fields except marc and marcxml.
 897
 898 =cut
 899
 900 sub GetPendingIssues {
 901     my @borrowernumbers = @_;
 902
 903     unless (@borrowernumbers ) { # return a ref_to_array
 904         return \@borrowernumbers; # to not cause surprise to caller
 905     }
 906
 907     # Borrowers part of the query
 908     my $bquery = '';
 909     for (my $i = 0; $i < @borrowernumbers; $i++) {
 910         $bquery .= ' issues.borrowernumber = ?';
 911         if ($i < $#borrowernumbers ) {
 912             $bquery .= ' OR';
 913         }
 914     }
 915
 916     # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
 917     # FIXME: namespace collision: each table has "timestamp" fields.  Which one is "timestamp" ?
 918     # FIXME: circ/ciculation.pl tries to sort by timestamp!
 919     # FIXME: namespace collision: other collisions possible.
 920     # FIXME: most of this data isn't really being used by callers.
 921     my $query =
 922    "SELECT issues.*,
 923             items.*,
 924            biblio.*,
 925            biblioitems.volume,
 926            biblioitems.number,
 927            biblioitems.itemtype,
 928            biblioitems.isbn,
 929            biblioitems.issn,
 930            biblioitems.publicationyear,
 931            biblioitems.publishercode,
 932            biblioitems.volumedate,
 933            biblioitems.volumedesc,
 934            biblioitems.lccn,
 935            biblioitems.url,
 936            borrowers.firstname,
 937            borrowers.surname,
 938            borrowers.cardnumber,
 939            issues.timestamp AS timestamp,
 940            issues.renewals  AS renewals,
 941            issues.borrowernumber AS borrowernumber,
 942             items.renewals  AS totalrenewals
 943     FROM   issues
 944     LEFT JOIN items       ON items.itemnumber       =      issues.itemnumber
 945     LEFT JOIN biblio      ON items.biblionumber     =      biblio.biblionumber
 946     LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
 947     LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
 948     WHERE
 949       $bquery
 950     ORDER BY issues.issuedate"
 951     ;
 952
 953     my $sth = C4::Context->dbh->prepare($query);
 954     $sth->execute(@borrowernumbers);
 955     my $data = $sth->fetchall_arrayref({});
 956     my $today = dt_from_string;
 957     foreach (@{$data}) {
 958         if ($_->{issuedate}) {
 959             $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
 960         }
 961         $_->{date_due_sql} = $_->{date_due};
 962         # FIXME no need to have this value
 963         $_->{date_due} or next;
 964         $_->{date_due_sql} = $_->{date_due};
 965         # FIXME no need to have this value
 966         $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
 967         if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
 968             $_->{overdue} = 1;
 969         }
 970     }
 971     return $data;
 972 }
 973
 974 =head2 GetAllIssues
 975
 976   $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
 977
 978 Looks up what the patron with the given borrowernumber has borrowed,
 979 and sorts the results.
 980
 981 C<$sortkey> is the name of a field on which to sort the results. This
 982 should be the name of a field in the C<issues>, C<biblio>,
 983 C<biblioitems>, or C<items> table in the Koha database.
 984
 985 C<$limit> is the maximum number of results to return.
 986
 987 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
 988 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
 989 C<items> tables of the Koha database.
 990
 991 =cut
 992
 993 #'
 994 sub GetAllIssues {
 995     my ( $borrowernumber, $order, $limit ) = @_;
 996
 997     return unless $borrowernumber;
 998     $order = 'date_due desc' unless $order;
 999
1000     my $dbh = C4::Context->dbh;
1001     my $query =
1002 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1003   FROM issues
1004   LEFT JOIN items on items.itemnumber=issues.itemnumber
1005   LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1006   LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1007   WHERE borrowernumber=?
1008   UNION ALL
1009   SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1010   FROM old_issues
1011   LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1012   LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1013   LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1014   WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1015   order by ' . $order;
1016     if ($limit) {
1017         $query .= " limit $limit";
1018     }
1019
1020     my $sth = $dbh->prepare($query);
1021     $sth->execute( $borrowernumber, $borrowernumber );
1022     return $sth->fetchall_arrayref( {} );
1023 }
1024
1025
1026 =head2 GetMemberAccountRecords
1027
1028   ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1029
1030 Looks up accounting data for the patron with the given borrowernumber.
1031
1032 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1033 reference-to-array, where each element is a reference-to-hash; the
1034 keys are the fields of the C<accountlines> table in the Koha database.
1035 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1036 total amount outstanding for all of the account lines.
1037
1038 =cut
1039
1040 sub GetMemberAccountRecords {
1041     my ($borrowernumber) = @_;
1042     my $dbh = C4::Context->dbh;
1043     my @acctlines;
1044     my $numlines = 0;
1045     my $strsth      = qq(
1046                         SELECT *
1047                         FROM accountlines
1048                         WHERE borrowernumber=?);
1049     $strsth.=" ORDER BY accountlines_id desc";
1050     my $sth= $dbh->prepare( $strsth );
1051     $sth->execute( $borrowernumber );
1052
1053     my $total = 0;
1054     while ( my $data = $sth->fetchrow_hashref ) {
1055         if ( $data->{itemnumber} ) {
1056             my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1057             $data->{biblionumber} = $biblio->{biblionumber};
1058             $data->{title}        = $biblio->{title};
1059         }
1060         $acctlines[$numlines] = $data;
1061         $numlines++;
1062         $total += sprintf "%.0f", 1000*$data->{amountoutstanding}; # convert float to integer to avoid round-off errors
1063     }
1064     $total /= 1000;
1065     return ( $total, \@acctlines,$numlines);
1066 }
1067
1068 =head2 GetMemberAccountBalance
1069
1070   ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
1071
1072 Calculates amount immediately owing by the patron - non-issue charges.
1073 Based on GetMemberAccountRecords.
1074 Charges exempt from non-issue are:
1075 * Res (reserves)
1076 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
1077 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
1078
1079 =cut
1080
1081 sub GetMemberAccountBalance {
1082     my ($borrowernumber) = @_;
1083
1084     my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
1085
1086     my @not_fines;
1087     push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
1088     push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
1089     unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
1090         my $dbh = C4::Context->dbh;
1091         my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
1092         push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
1093     }
1094     my %not_fine = map {$_ => 1} @not_fines;
1095
1096     my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1097     my $other_charges = 0;
1098     foreach (@$acctlines) {
1099         $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1100     }
1101
1102     return ( $total, $total - $other_charges, $other_charges);
1103 }
1104
1105 =head2 GetBorNotifyAcctRecord
1106
1107   ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1108
1109 Looks up accounting data for the patron with the given borrowernumber per file number.
1110
1111 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1112 reference-to-array, where each element is a reference-to-hash; the
1113 keys are the fields of the C<accountlines> table in the Koha database.
1114 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1115 total amount outstanding for all of the account lines.
1116
1117 =cut
1118
1119 sub GetBorNotifyAcctRecord {
1120     my ( $borrowernumber, $notifyid ) = @_;
1121     my $dbh = C4::Context->dbh;
1122     my @acctlines;
1123     my $numlines = 0;
1124     my $sth = $dbh->prepare(
1125             "SELECT *
1126                 FROM accountlines
1127                 WHERE borrowernumber=?
1128                     AND notify_id=?
1129                     AND amountoutstanding != '0'
1130                 ORDER BY notify_id,accounttype
1131                 ");
1132
1133     $sth->execute( $borrowernumber, $notifyid );
1134     my $total = 0;
1135     while ( my $data = $sth->fetchrow_hashref ) {
1136         if ( $data->{itemnumber} ) {
1137             my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1138             $data->{biblionumber} = $biblio->{biblionumber};
1139             $data->{title}        = $biblio->{title};
1140         }
1141         $acctlines[$numlines] = $data;
1142         $numlines++;
1143         $total += int(100 * $data->{'amountoutstanding'});
1144     }
1145     $total /= 100;
1146     return ( $total, \@acctlines, $numlines );
1147 }
1148
1149 =head2 checkuniquemember (OUEST-PROVENCE)
1150
1151   ($result,$categorycode)  = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1152
1153 Checks that a member exists or not in the database.
1154
1155 C<&result> is nonzero (=exist) or 0 (=does not exist)
1156 C<&categorycode> is from categorycode table
1157 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1158 C<&surname> is the surname
1159 C<&firstname> is the firstname (only if collectivity=0)
1160 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1161
1162 =cut
1163
1164 # FIXME: This function is not legitimate.  Multiple patrons might have the same first/last name and birthdate.
1165 # This is especially true since first name is not even a required field.
1166
1167 sub checkuniquemember {
1168     my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1169     my $dbh = C4::Context->dbh;
1170     my $request = ($collectivity) ?
1171         "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1172             ($dateofbirth) ?
1173             "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?  and dateofbirth=?" :
1174             "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1175     my $sth = $dbh->prepare($request);
1176     if ($collectivity) {
1177         $sth->execute( uc($surname) );
1178     } elsif($dateofbirth){
1179         $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1180     }else{
1181         $sth->execute( uc($surname), ucfirst($firstname));
1182     }
1183     my @data = $sth->fetchrow;
1184     ( $data[0] ) and return $data[0], $data[1];
1185     return 0;
1186 }
1187
1188 sub checkcardnumber {
1189     my ( $cardnumber, $borrowernumber ) = @_;
1190
1191     # If cardnumber is null, we assume they're allowed.
1192     return 0 unless defined $cardnumber;
1193
1194     my $dbh = C4::Context->dbh;
1195     my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1196     $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1197     my $sth = $dbh->prepare($query);
1198     $sth->execute(
1199         $cardnumber,
1200         ( $borrowernumber ? $borrowernumber : () )
1201     );
1202
1203     return 1 if $sth->fetchrow_hashref;
1204
1205     my ( $min_length, $max_length ) = get_cardnumber_length();
1206     return 2
1207         if length $cardnumber > $max_length
1208         or length $cardnumber < $min_length;
1209
1210     return 0;
1211 }
1212
1213 =head2 get_cardnumber_length
1214
1215     my ($min, $max) = C4::Members::get_cardnumber_length()
1216
1217 Returns the minimum and maximum length for patron cardnumbers as
1218 determined by the CardnumberLength system preference, the
1219 BorrowerMandatoryField system preference, and the width of the
1220 database column.
1221
1222 =cut
1223
1224 sub get_cardnumber_length {
1225     my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1226     $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1227     if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1228         # Is integer and length match
1229         if ( $cardnumber_length =~ m|^\d+$| ) {
1230             $min = $max = $cardnumber_length
1231                 if $cardnumber_length >= $min
1232                     and $cardnumber_length <= $max;
1233         }
1234         # Else assuming it is a range
1235         elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1236             $min = $1 if $1 and $min < $1;
1237             $max = $2 if $2 and $max > $2;
1238         }
1239
1240     }
1241     return ( $min, $max );
1242 }
1243
1244 =head2 GetFirstValidEmailAddress
1245
1246   $email = GetFirstValidEmailAddress($borrowernumber);
1247
1248 Return the first valid email address for a borrower, given the borrowernumber.  For now, the order
1249 is defined as email, emailpro, B_email.  Returns the empty string if the borrower has no email
1250 addresses.
1251
1252 =cut
1253
1254 sub GetFirstValidEmailAddress {
1255     my $borrowernumber = shift;
1256     my $dbh = C4::Context->dbh;
1257     my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1258     $sth->execute( $borrowernumber );
1259     my $data = $sth->fetchrow_hashref;
1260
1261     if ($data->{'email'}) {
1262        return $data->{'email'};
1263     } elsif ($data->{'emailpro'}) {
1264        return $data->{'emailpro'};
1265     } elsif ($data->{'B_email'}) {
1266        return $data->{'B_email'};
1267     } else {
1268        return '';
1269     }
1270 }
1271
1272 =head2 GetNoticeEmailAddress
1273
1274   $email = GetNoticeEmailAddress($borrowernumber);
1275
1276 Return the email address of borrower used for notices, given the borrowernumber.
1277 Returns the empty string if no email address.
1278
1279 =cut
1280
1281 sub GetNoticeEmailAddress {
1282     my $borrowernumber = shift;
1283
1284     my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1285     # if syspref is set to 'first valid' (value == OFF), look up email address
1286     if ( $which_address eq 'OFF' ) {
1287         return GetFirstValidEmailAddress($borrowernumber);
1288     }
1289     # specified email address field
1290     my $dbh = C4::Context->dbh;
1291     my $sth = $dbh->prepare( qq{
1292         SELECT $which_address AS primaryemail
1293         FROM borrowers
1294         WHERE borrowernumber=?
1295     } );
1296     $sth->execute($borrowernumber);
1297     my $data = $sth->fetchrow_hashref;
1298     return $data->{'primaryemail'} || '';
1299 }
1300
1301 =head2 GetExpiryDate
1302
1303   $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1304
1305 Calculate expiry date given a categorycode and starting date.  Date argument must be in ISO format.
1306 Return date is also in ISO format.
1307
1308 =cut
1309
1310 sub GetExpiryDate {
1311     my ( $categorycode, $dateenrolled ) = @_;
1312     my $enrolments;
1313     if ($categorycode) {
1314         my $dbh = C4::Context->dbh;
1315         my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1316         $sth->execute($categorycode);
1317         $enrolments = $sth->fetchrow_hashref;
1318     }
1319     # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1320     my @date = split (/-/,$dateenrolled);
1321     if($enrolments->{enrolmentperiod}){
1322         return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1323     }else{
1324         return $enrolments->{enrolmentperioddate};
1325     }
1326 }
1327
1328 =head2 GetUpcomingMembershipExpires
1329
1330     my $expires = GetUpcomingMembershipExpires({
1331         branch => $branch, before => $before, after => $after,
1332     });
1333
1334     $branch is an optional branch code.
1335     $before/$after is an optional number of days before/after the date that
1336     is set by the preference MembershipExpiryDaysNotice.
1337     If the pref would be 14, before 2 and after 3, you will get all expires
1338     from 12 to 17 days.
1339
1340 =cut
1341
1342 sub GetUpcomingMembershipExpires {
1343     my ( $params ) = @_;
1344     my $before = $params->{before} || 0;
1345     my $after  = $params->{after} || 0;
1346     my $branch = $params->{branch};
1347
1348     my $dbh = C4::Context->dbh;
1349     my $days = C4::Context->preference("MembershipExpiryDaysNotice") || 0;
1350     my $date1 = dt_from_string->add( days => $days - $before );
1351     my $date2 = dt_from_string->add( days => $days + $after );
1352     $date1= output_pref({ dt => $date1, dateformat => 'iso', dateonly => 1 });
1353     $date2= output_pref({ dt => $date2, dateformat => 'iso', dateonly => 1 });
1354
1355     my $query = q|
1356         SELECT borrowers.*, categories.description,
1357         branches.branchname, branches.branchemail FROM borrowers
1358         LEFT JOIN branches USING (branchcode)
1359         LEFT JOIN categories USING (categorycode)
1360     |;
1361     if( $branch ) {
1362         $query.= 'WHERE branchcode=? AND dateexpiry BETWEEN ? AND ?';
1363     } else {
1364         $query.= 'WHERE dateexpiry BETWEEN ? AND ?';
1365     }
1366
1367     my $sth = $dbh->prepare( $query );
1368     my @pars = $branch? ( $branch ): ();
1369     push @pars, $date1, $date2;
1370     $sth->execute( @pars );
1371     my $results = $sth->fetchall_arrayref( {} );
1372     return $results;
1373 }
1374
1375 =head2 GetborCatFromCatType
1376
1377   ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1378
1379 Looks up the different types of borrowers in the database. Returns two
1380 elements: a reference-to-array, which lists the borrower category
1381 codes, and a reference-to-hash, which maps the borrower category codes
1382 to category descriptions.
1383
1384 =cut
1385
1386 #'
1387 sub GetborCatFromCatType {
1388     my ( $category_type, $action, $no_branch_limit ) = @_;
1389
1390     my $branch_limit = $no_branch_limit
1391         ? 0
1392         : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1393
1394     # FIXME - This API  seems both limited and dangerous.
1395     my $dbh     = C4::Context->dbh;
1396
1397     my $request = qq{
1398         SELECT categories.categorycode, categories.description
1399         FROM categories
1400     };
1401     $request .= qq{
1402         LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1403     } if $branch_limit;
1404     if($action) {
1405         $request .= " $action ";
1406         $request .= " AND (branchcode = ? OR branchcode IS NULL) GROUP BY description" if $branch_limit;
1407     } else {
1408         $request .= " WHERE branchcode = ? OR branchcode IS NULL GROUP BY description" if $branch_limit;
1409     }
1410     $request .= " ORDER BY categorycode";
1411
1412     my $sth = $dbh->prepare($request);
1413     $sth->execute(
1414         $action ? $category_type : (),
1415         $branch_limit ? $branch_limit : ()
1416     );
1417
1418     my %labels;
1419     my @codes;
1420
1421     while ( my $data = $sth->fetchrow_hashref ) {
1422         push @codes, $data->{'categorycode'};
1423         $labels{ $data->{'categorycode'} } = $data->{'description'};
1424     }
1425     $sth->finish;
1426     return ( \@codes, \%labels );
1427 }
1428
1429 =head2 GetBorrowercategory
1430
1431   $hashref = &GetBorrowercategory($categorycode);
1432
1433 Given the borrower's category code, the function returns the corresponding
1434 data hashref for a comprehensive information display.
1435
1436 =cut
1437
1438 sub GetBorrowercategory {
1439     my ($catcode) = @_;
1440     my $dbh       = C4::Context->dbh;
1441     if ($catcode){
1442         my $sth       =
1443         $dbh->prepare(
1444     "SELECT description,dateofbirthrequired,upperagelimit,category_type
1445     FROM categories
1446     WHERE categorycode = ?"
1447         );
1448         $sth->execute($catcode);
1449         my $data =
1450         $sth->fetchrow_hashref;
1451         return $data;
1452     }
1453     return;
1454 }    # sub getborrowercategory
1455
1456
1457 =head2 GetBorrowerCategorycode
1458
1459     $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
1460
1461 Given the borrowernumber, the function returns the corresponding categorycode
1462
1463 =cut
1464
1465 sub GetBorrowerCategorycode {
1466     my ( $borrowernumber ) = @_;
1467     my $dbh = C4::Context->dbh;
1468     my $sth = $dbh->prepare( qq{
1469         SELECT categorycode
1470         FROM borrowers
1471         WHERE borrowernumber = ?
1472     } );
1473     $sth->execute( $borrowernumber );
1474     return $sth->fetchrow;
1475 }
1476
1477 =head2 GetBorrowercategoryList
1478
1479   $arrayref_hashref = &GetBorrowercategoryList;
1480 If no category code provided, the function returns all the categories.
1481
1482 =cut
1483
1484 sub GetBorrowercategoryList {
1485     my $no_branch_limit = @_ ? shift : 0;
1486     my $branch_limit = $no_branch_limit
1487         ? 0
1488         : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1489     my $dbh       = C4::Context->dbh;
1490     my $query = "SELECT categories.* FROM categories";
1491     $query .= qq{
1492         LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1493         WHERE branchcode = ? OR branchcode IS NULL GROUP BY description
1494     } if $branch_limit;
1495     $query .= " ORDER BY description";
1496     my $sth = $dbh->prepare( $query );
1497     $sth->execute( $branch_limit ? $branch_limit : () );
1498     my $data = $sth->fetchall_arrayref( {} );
1499     $sth->finish;
1500     return $data;
1501 }    # sub getborrowercategory
1502
1503 =head2 GetAge
1504
1505   $dateofbirth,$date = &GetAge($date);
1506
1507 this function return the borrowers age with the value of dateofbirth
1508
1509 =cut
1510
1511 #'
1512 sub GetAge{
1513     my ( $date, $date_ref ) = @_;
1514
1515     if ( not defined $date_ref ) {
1516         $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1517     }
1518
1519     my ( $year1, $month1, $day1 ) = split /-/, $date;
1520     my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1521
1522     my $age = $year2 - $year1;
1523     if ( $month1 . $day1 > $month2 . $day2 ) {
1524         $age--;
1525     }
1526
1527     return $age;
1528 }    # sub get_age
1529
1530 =head2 SetAge
1531
1532   $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1533   $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1534   $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1535
1536   eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1537   if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1538
1539 This function sets the borrower's dateofbirth to match the given age.
1540 Optionally relative to the given $datetime_reference.
1541
1542 @PARAM1 koha.borrowers-object
1543 @PARAM2 DateTime::Duration-object as the desired age
1544         OR a ISO 8601 Date. (To make the API more pleasant)
1545 @PARAM3 DateTime-object as the relative date, defaults to now().
1546 RETURNS The given borrower reference @PARAM1.
1547 DIES    If there was an error with the ISO Date handling.
1548
1549 =cut
1550
1551 #'
1552 sub SetAge{
1553     my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1554     $datetime_ref = DateTime->now() unless $datetime_ref;
1555
1556     if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1557         if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1558             $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1559         }
1560         else {
1561             die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1562         }
1563     }
1564
1565     my $new_datetime_ref = $datetime_ref->clone();
1566     $new_datetime_ref->subtract_duration( $datetimeduration );
1567
1568     $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1569
1570     return $borrower;
1571 }    # sub SetAge
1572
1573 =head2 GetSortDetails (OUEST-PROVENCE)
1574
1575   ($lib) = &GetSortDetails($category,$sortvalue);
1576
1577 Returns the authorized value  details
1578 C<&$lib>return value of authorized value details
1579 C<&$sortvalue>this is the value of authorized value
1580 C<&$category>this is the value of authorized value category
1581
1582 =cut
1583
1584 sub GetSortDetails {
1585     my ( $category, $sortvalue ) = @_;
1586     my $dbh   = C4::Context->dbh;
1587     my $query = qq|SELECT lib
1588         FROM authorised_values
1589         WHERE category=?
1590         AND authorised_value=? |;
1591     my $sth = $dbh->prepare($query);
1592     $sth->execute( $category, $sortvalue );
1593     my $lib = $sth->fetchrow;
1594     return ($lib) if ($lib);
1595     return ($sortvalue) unless ($lib);
1596 }
1597
1598 =head2 MoveMemberToDeleted
1599
1600   $result = &MoveMemberToDeleted($borrowernumber);
1601
1602 Copy the record from borrowers to deletedborrowers table.
1603 The routine returns 1 for success, undef for failure.
1604
1605 =cut
1606
1607 sub MoveMemberToDeleted {
1608     my ($member) = shift or return;
1609
1610     my $schema       = Koha::Database->new()->schema();
1611     my $borrowers_rs = $schema->resultset('Borrower');
1612     $borrowers_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
1613     my $borrower = $borrowers_rs->find($member);
1614     return unless $borrower;
1615
1616     my $deleted = $schema->resultset('Deletedborrower')->create($borrower);
1617
1618     return $deleted ? 1 : undef;
1619 }
1620
1621 =head2 DelMember
1622
1623     DelMember($borrowernumber);
1624
1625 This function remove directly a borrower whitout writing it on deleteborrower.
1626 + Deletes reserves for the borrower
1627
1628 =cut
1629
1630 sub DelMember {
1631     my $dbh            = C4::Context->dbh;
1632     my $borrowernumber = shift;
1633     #warn "in delmember with $borrowernumber";
1634     return unless $borrowernumber;    # borrowernumber is mandatory.
1635     # Delete Patron's holds
1636     my @holds = Koha::Holds->search({ borrowernumber => $borrowernumber });
1637     $_->delete for @holds;
1638
1639     my $query = "
1640        DELETE
1641        FROM borrowers
1642        WHERE borrowernumber = ?
1643    ";
1644     my $sth = $dbh->prepare($query);
1645     $sth->execute($borrowernumber);
1646     logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1647     return $sth->rows;
1648 }
1649
1650 =head2 HandleDelBorrower
1651
1652      HandleDelBorrower($borrower);
1653
1654 When a member is deleted (DelMember in Members.pm), you should call me first.
1655 This routine deletes/moves lists and entries for the deleted member/borrower.
1656 Lists owned by the borrower are deleted, but entries from the borrower to
1657 other lists are kept.
1658
1659 =cut
1660
1661 sub HandleDelBorrower {
1662     my ($borrower)= @_;
1663     my $query;
1664     my $dbh = C4::Context->dbh;
1665
1666     #Delete all lists and all shares of this borrower
1667     #Consistent with the approach Koha uses on deleting individual lists
1668     #Note that entries in virtualshelfcontents added by this borrower to
1669     #lists of others will be handled by a table constraint: the borrower
1670     #is set to NULL in those entries.
1671     $query="DELETE FROM virtualshelves WHERE owner=?";
1672     $dbh->do($query,undef,($borrower));
1673
1674     #NOTE:
1675     #We could handle the above deletes via a constraint too.
1676     #But a new BZ report 11889 has been opened to discuss another approach.
1677     #Instead of deleting we could also disown lists (based on a pref).
1678     #In that way we could save shared and public lists.
1679     #The current table constraints support that idea now.
1680     #This pref should then govern the results of other routines/methods such as
1681     #Koha::Virtualshelf->new->delete too.
1682 }
1683
1684 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1685
1686     $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1687
1688 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1689 Returns ISO date.
1690
1691 =cut
1692
1693 sub ExtendMemberSubscriptionTo {
1694     my ( $borrowerid,$date) = @_;
1695     my $dbh = C4::Context->dbh;
1696     my $borrower = GetMember('borrowernumber'=>$borrowerid);
1697     unless ($date){
1698       $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1699                                         eval { output_pref( { dt => dt_from_string( $borrower->{'dateexpiry'}  ), dateonly => 1, dateformat => 'iso' } ); }
1700                                         :
1701                                         output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
1702       $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1703     }
1704     my $sth = $dbh->do(<<EOF);
1705 UPDATE borrowers
1706 SET  dateexpiry='$date'
1707 WHERE borrowernumber='$borrowerid'
1708 EOF
1709
1710     AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
1711
1712     logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1713     return $date if ($sth);
1714     return 0;
1715 }
1716
1717 =head2 GetTitles (OUEST-PROVENCE)
1718
1719   ($borrowertitle)= &GetTitles();
1720
1721 Looks up the different title . Returns array  with all borrowers title
1722
1723 =cut
1724
1725 sub GetTitles {
1726     my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1727     unshift( @borrowerTitle, "" );
1728     my $count=@borrowerTitle;
1729     if ($count == 1){
1730         return ();
1731     }
1732     else {
1733         return ( \@borrowerTitle);
1734     }
1735 }
1736
1737 =head2 GetHideLostItemsPreference
1738
1739   $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1740
1741 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1742 C<&$hidelostitemspref>return value of function, 0 or 1
1743
1744 =cut
1745
1746 sub GetHideLostItemsPreference {
1747     my ($borrowernumber) = @_;
1748     my $dbh = C4::Context->dbh;
1749     my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1750     my $sth = $dbh->prepare($query);
1751     $sth->execute($borrowernumber);
1752     my $hidelostitems = $sth->fetchrow;
1753     return $hidelostitems;
1754 }
1755
1756 =head2 GetBorrowersToExpunge
1757
1758   $borrowers = &GetBorrowersToExpunge(
1759       not_borrowed_since => $not_borrowed_since,
1760       expired_before       => $expired_before,
1761       category_code        => $category_code,
1762       patron_list_id       => $patron_list_id,
1763       branchcode           => $branchcode
1764   );
1765
1766   This function get all borrowers based on the given criteria.
1767
1768 =cut
1769
1770 sub GetBorrowersToExpunge {
1771
1772     my $params = shift;
1773     my $filterdate       = $params->{'not_borrowed_since'};
1774     my $filterexpiry     = $params->{'expired_before'};
1775     my $filtercategory   = $params->{'category_code'};
1776     my $filterbranch     = $params->{'branchcode'} ||
1777                         ((C4::Context->preference('IndependentBranches')
1778                              && C4::Context->userenv
1779                              && !C4::Context->IsSuperLibrarian()
1780                              && C4::Context->userenv->{branch})
1781                          ? C4::Context->userenv->{branch}
1782                          : "");
1783     my $filterpatronlist = $params->{'patron_list_id'};
1784
1785     my $dbh   = C4::Context->dbh;
1786     my $query = q|
1787         SELECT borrowers.borrowernumber,
1788                MAX(old_issues.timestamp) AS latestissue,
1789                MAX(issues.timestamp) AS currentissue
1790         FROM   borrowers
1791         JOIN   categories USING (categorycode)
1792         LEFT JOIN (
1793             SELECT guarantorid
1794             FROM borrowers
1795             WHERE guarantorid IS NOT NULL
1796                 AND guarantorid <> 0
1797         ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
1798         LEFT JOIN old_issues USING (borrowernumber)
1799         LEFT JOIN issues USING (borrowernumber)|;
1800     if ( $filterpatronlist  ){
1801         $query .= q| LEFT JOIN patron_list_patrons USING (borrowernumber)|;
1802     }
1803     $query .= q| WHERE  category_type <> 'S'
1804         AND tmp.guarantorid IS NULL
1805    |;
1806     my @query_params;
1807     if ( $filterbranch && $filterbranch ne "" ) {
1808         $query.= " AND borrowers.branchcode = ? ";
1809         push( @query_params, $filterbranch );
1810     }
1811     if ( $filterexpiry ) {
1812         $query .= " AND dateexpiry < ? ";
1813         push( @query_params, $filterexpiry );
1814     }
1815     if ( $filtercategory ) {
1816         $query .= " AND categorycode = ? ";
1817         push( @query_params, $filtercategory );
1818     }
1819     if ( $filterpatronlist ){
1820         $query.=" AND patron_list_id = ? ";
1821         push( @query_params, $filterpatronlist );
1822     }
1823     $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
1824     if ( $filterdate ) {
1825         $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
1826         push @query_params,$filterdate;
1827     }
1828     warn $query if $debug;
1829
1830     my $sth = $dbh->prepare($query);
1831     if (scalar(@query_params)>0){
1832         $sth->execute(@query_params);
1833     }
1834     else {
1835         $sth->execute;
1836     }
1837
1838     my @results;
1839     while ( my $data = $sth->fetchrow_hashref ) {
1840         push @results, $data;
1841     }
1842     return \@results;
1843 }
1844
1845 =head2 GetBorrowersWhoHaveNeverBorrowed
1846
1847   $results = &GetBorrowersWhoHaveNeverBorrowed
1848
1849 This function get all borrowers who have never borrowed.
1850
1851 I<$result> is a ref to an array which all elements are a hasref.
1852
1853 =cut
1854
1855 sub GetBorrowersWhoHaveNeverBorrowed {
1856     my $filterbranch = shift ||
1857                         ((C4::Context->preference('IndependentBranches')
1858                              && C4::Context->userenv
1859                              && !C4::Context->IsSuperLibrarian()
1860                              && C4::Context->userenv->{branch})
1861                          ? C4::Context->userenv->{branch}
1862                          : "");
1863     my $dbh   = C4::Context->dbh;
1864     my $query = "
1865         SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1866         FROM   borrowers
1867           LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1868         WHERE issues.borrowernumber IS NULL
1869    ";
1870     my @query_params;
1871     if ($filterbranch && $filterbranch ne ""){
1872         $query.=" AND borrowers.branchcode= ?";
1873         push @query_params,$filterbranch;
1874     }
1875     warn $query if $debug;
1876
1877     my $sth = $dbh->prepare($query);
1878     if (scalar(@query_params)>0){
1879         $sth->execute(@query_params);
1880     }
1881     else {
1882         $sth->execute;
1883     }
1884
1885     my @results;
1886     while ( my $data = $sth->fetchrow_hashref ) {
1887         push @results, $data;
1888     }
1889     return \@results;
1890 }
1891
1892 =head2 GetBorrowersWithIssuesHistoryOlderThan
1893
1894   $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1895
1896 this function get all borrowers who has an issue history older than I<$date> given on input arg.
1897
1898 I<$result> is a ref to an array which all elements are a hashref.
1899 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1900
1901 =cut
1902
1903 sub GetBorrowersWithIssuesHistoryOlderThan {
1904     my $dbh  = C4::Context->dbh;
1905     my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
1906     my $filterbranch = shift ||
1907                         ((C4::Context->preference('IndependentBranches')
1908                              && C4::Context->userenv
1909                              && !C4::Context->IsSuperLibrarian()
1910                              && C4::Context->userenv->{branch})
1911                          ? C4::Context->userenv->{branch}
1912                          : "");
1913     my $query = "
1914        SELECT count(borrowernumber) as n,borrowernumber
1915        FROM old_issues
1916        WHERE returndate < ?
1917          AND borrowernumber IS NOT NULL
1918     ";
1919     my @query_params;
1920     push @query_params, $date;
1921     if ($filterbranch){
1922         $query.="   AND branchcode = ?";
1923         push @query_params, $filterbranch;
1924     }
1925     $query.=" GROUP BY borrowernumber ";
1926     warn $query if $debug;
1927     my $sth = $dbh->prepare($query);
1928     $sth->execute(@query_params);
1929     my @results;
1930
1931     while ( my $data = $sth->fetchrow_hashref ) {
1932         push @results, $data;
1933     }
1934     return \@results;
1935 }
1936
1937 =head2 GetBorrowersNamesAndLatestIssue
1938
1939   $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
1940
1941 this function get borrowers Names and surnames and Issue information.
1942
1943 I<@borrowernumbers> is an array which all elements are borrowernumbers.
1944 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1945
1946 =cut
1947
1948 sub GetBorrowersNamesAndLatestIssue {
1949     my $dbh  = C4::Context->dbh;
1950     my @borrowernumbers=@_;
1951     my $query = "
1952        SELECT surname,lastname, phone, email,max(timestamp)
1953        FROM borrowers
1954          LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
1955        GROUP BY borrowernumber
1956    ";
1957     my $sth = $dbh->prepare($query);
1958     $sth->execute;
1959     my $results = $sth->fetchall_arrayref({});
1960     return $results;
1961 }
1962
1963 =head2 IssueSlip
1964
1965   IssueSlip($branchcode, $borrowernumber, $quickslip)
1966
1967   Returns letter hash ( see C4::Letters::GetPreparedLetter )
1968
1969   $quickslip is boolean, to indicate whether we want a quick slip
1970
1971   IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
1972
1973   Both slips:
1974
1975       <<branches.*>>
1976       <<borrowers.*>>
1977
1978   ISSUESLIP:
1979
1980       <checkedout>
1981          <<biblio.*>>
1982          <<items.*>>
1983          <<biblioitems.*>>
1984          <<issues.*>>
1985       </checkedout>
1986
1987       <overdue>
1988          <<biblio.*>>
1989          <<items.*>>
1990          <<biblioitems.*>>
1991          <<issues.*>>
1992       </overdue>
1993
1994       <news>
1995          <<opac_news.*>>
1996       </news>
1997
1998   ISSUEQSLIP:
1999
2000       <checkedout>
2001          <<biblio.*>>
2002          <<items.*>>
2003          <<biblioitems.*>>
2004          <<issues.*>>
2005       </checkedout>
2006
2007   NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
2008
2009 =cut
2010
2011 sub IssueSlip {
2012     my ($branch, $borrowernumber, $quickslip) = @_;
2013
2014     # FIXME Check callers before removing this statement
2015     #return unless $borrowernumber;
2016
2017     my @issues = @{ GetPendingIssues($borrowernumber) };
2018
2019     for my $issue (@issues) {
2020         $issue->{date_due} = $issue->{date_due_sql};
2021         if ($quickslip) {
2022             my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2023             if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
2024                 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
2025                   $issue->{now} = 1;
2026             };
2027         }
2028     }
2029
2030     # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
2031     @issues = sort {
2032         my $s = $b->{timestamp} <=> $a->{timestamp};
2033         $s == 0 ?
2034              $b->{issuedate} <=> $a->{issuedate} : $s;
2035     } @issues;
2036
2037     my ($letter_code, %repeat);
2038     if ( $quickslip ) {
2039         $letter_code = 'ISSUEQSLIP';
2040         %repeat =  (
2041             'checkedout' => [ map {
2042                 'biblio'       => $_,
2043                 'items'        => $_,
2044                 'biblioitems'  => $_,
2045                 'issues'       => $_,
2046             }, grep { $_->{'now'} } @issues ],
2047         );
2048     }
2049     else {
2050         $letter_code = 'ISSUESLIP';
2051         %repeat =  (
2052             'checkedout' => [ map {
2053                 'biblio'       => $_,
2054                 'items'        => $_,
2055                 'biblioitems'  => $_,
2056                 'issues'       => $_,
2057             }, grep { !$_->{'overdue'} } @issues ],
2058
2059             'overdue' => [ map {
2060                 'biblio'       => $_,
2061                 'items'        => $_,
2062                 'biblioitems'  => $_,
2063                 'issues'       => $_,
2064             }, grep { $_->{'overdue'} } @issues ],
2065
2066             'news' => [ map {
2067                 $_->{'timestamp'} = $_->{'newdate'};
2068                 { opac_news => $_ }
2069             } @{ GetNewsToDisplay("slip",$branch) } ],
2070         );
2071     }
2072
2073     return  C4::Letters::GetPreparedLetter (
2074         module => 'circulation',
2075         letter_code => $letter_code,
2076         branchcode => $branch,
2077         tables => {
2078             'branches'    => $branch,
2079             'borrowers'   => $borrowernumber,
2080         },
2081         repeat => \%repeat,
2082     );
2083 }
2084
2085 =head2 GetBorrowersWithEmail
2086
2087     ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2088
2089 This gets a list of users and their basic details from their email address.
2090 As it's possible for multiple user to have the same email address, it provides
2091 you with all of them. If there is no userid for the user, there will be an
2092 C<undef> there. An empty list will be returned if there are no matches.
2093
2094 =cut
2095
2096 sub GetBorrowersWithEmail {
2097     my $email = shift;
2098
2099     my $dbh = C4::Context->dbh;
2100
2101     my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2102     my $sth=$dbh->prepare($query);
2103     $sth->execute($email);
2104     my @result = ();
2105     while (my $ref = $sth->fetch) {
2106         push @result, $ref;
2107     }
2108     die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2109     return @result;
2110 }
2111
2112 =head2 AddMember_Opac
2113
2114 =cut
2115
2116 sub AddMember_Opac {
2117     my ( %borrower ) = @_;
2118
2119     $borrower{'categorycode'} //= C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2120     if (not defined $borrower{'password'}){
2121         my $sr = new String::Random;
2122         $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
2123         my $password = $sr->randpattern("AAAAAAAAAA");
2124         $borrower{'password'} = $password;
2125     }
2126
2127     $borrower{'cardnumber'} = fixup_cardnumber( $borrower{'cardnumber'} );
2128
2129     my $borrowernumber = AddMember(%borrower);
2130
2131     return ( $borrowernumber, $borrower{'password'} );
2132 }
2133
2134 =head2 AddEnrolmentFeeIfNeeded
2135
2136     AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
2137
2138 Add enrolment fee for a patron if needed.
2139
2140 =cut
2141
2142 sub AddEnrolmentFeeIfNeeded {
2143     my ( $categorycode, $borrowernumber ) = @_;
2144     # check for enrollment fee & add it if needed
2145     my $dbh = C4::Context->dbh;
2146     my $sth = $dbh->prepare(q{
2147         SELECT enrolmentfee
2148         FROM categories
2149         WHERE categorycode=?
2150     });
2151     $sth->execute( $categorycode );
2152     if ( $sth->err ) {
2153         warn sprintf('Database returned the following error: %s', $sth->errstr);
2154         return;
2155     }
2156     my ($enrolmentfee) = $sth->fetchrow;
2157     if ($enrolmentfee && $enrolmentfee > 0) {
2158         # insert fee in patron debts
2159         C4::Accounts::manualinvoice( $borrowernumber, '', '', 'A', $enrolmentfee );
2160     }
2161 }
2162
2163 =head2 HasOverdues
2164
2165 =cut
2166
2167 sub HasOverdues {
2168     my ( $borrowernumber ) = @_;
2169
2170     my $sql = "SELECT COUNT(*) FROM issues WHERE date_due < NOW() AND borrowernumber = ?";
2171     my $sth = C4::Context->dbh->prepare( $sql );
2172     $sth->execute( $borrowernumber );
2173     my ( $count ) = $sth->fetchrow_array();
2174
2175     return $count;
2176 }
2177
2178 =head2 DeleteExpiredOpacRegistrations
2179
2180     Delete accounts that haven't been upgraded from the 'temporary' category
2181     Returns the number of removed patrons
2182
2183 =cut
2184
2185 sub DeleteExpiredOpacRegistrations {
2186
2187     my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
2188     my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2189
2190     return 0 if not $category_code or not defined $delay or $delay eq q||;
2191
2192     my $query = qq|
2193 SELECT borrowernumber
2194 FROM borrowers
2195 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
2196
2197     my $dbh = C4::Context->dbh;
2198     my $sth = $dbh->prepare($query);
2199     $sth->execute( $category_code, $delay );
2200     my $cnt=0;
2201     while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
2202         DelMember($borrowernumber);
2203         $cnt++;
2204     }
2205     return $cnt;
2206 }
2207
2208 =head2 DeleteUnverifiedOpacRegistrations
2209
2210     Delete all unverified self registrations in borrower_modifications,
2211     older than the specified number of days.
2212
2213 =cut
2214
2215 sub DeleteUnverifiedOpacRegistrations {
2216     my ( $days ) = @_;
2217     my $dbh = C4::Context->dbh;
2218     my $sql=qq|
2219 DELETE FROM borrower_modifications
2220 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
2221     my $cnt=$dbh->do($sql, undef, ($days) );
2222     return $cnt eq '0E0'? 0: $cnt;
2223 }
2224
2225 sub GetOverduesForPatron {
2226     my ( $borrowernumber ) = @_;
2227
2228     my $sql = "
2229         SELECT *
2230         FROM issues, items, biblio, biblioitems
2231         WHERE items.itemnumber=issues.itemnumber
2232           AND biblio.biblionumber   = items.biblionumber
2233           AND biblio.biblionumber   = biblioitems.biblionumber
2234           AND issues.borrowernumber = ?
2235           AND date_due < NOW()
2236     ";
2237
2238     my $sth = C4::Context->dbh->prepare( $sql );
2239     $sth->execute( $borrowernumber );
2240
2241     return $sth->fetchall_arrayref({});
2242 }
2243
2244 END { }    # module clean-up code here (global destructor)
2245
2246 1;
2247
2248 __END__
2249
2250 =head1 AUTHOR
2251
2252 Koha Team
2253
2254 =cut