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 Koha::Patron::Debarments qw(IsDebarred);
  41 use Text::Unaccent qw( unac_string );
  42 use Koha::AuthUtils qw(hash_password);
  43 use Koha::Database;
  44 use Koha::List::Patron;
  45
  46 our (@ISA,@EXPORT,@EXPORT_OK,$debug);
  47
  48 use Module::Load::Conditional qw( can_load );
  49 if ( ! can_load( modules => { 'Koha::NorwegianPatronDB' => undef } ) ) {
  50    $debug && warn "Unable to load Koha::NorwegianPatronDB";
  51 }
  52
  53
  54 BEGIN {
  55     $debug = $ENV{DEBUG} || 0;
  56     require Exporter;
  57     @ISA = qw(Exporter);
  58     #Get data
  59     push @EXPORT, qw(
  60         &Search
  61         &GetMemberDetails
  62         &GetMemberRelatives
  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::Patron::Debarments::IsDebarred($borrowernumber);
 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     delete $new_member->{borrowernumber};
 729
 730     my $rs = $schema->resultset('Borrower');
 731     $data{borrowernumber} = $rs->create($new_member)->id;
 732
 733     # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
 734     # cronjob will use for syncing with NL
 735     if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
 736         Koha::Database->new->schema->resultset('BorrowerSync')->create({
 737             'borrowernumber' => $data{'borrowernumber'},
 738             'synctype'       => 'norwegianpatrondb',
 739             'sync'           => 1,
 740             'syncstatus'     => 'new',
 741             'hashed_pin'     => Koha::NorwegianPatronDB::NLEncryptPIN( $plain_text_password ),
 742         });
 743     }
 744
 745     # mysql_insertid is probably bad.  not necessarily accurate and mysql-specific at best.
 746     logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
 747
 748     AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
 749
 750     return $data{borrowernumber};
 751 }
 752
 753 =head2 Check_Userid
 754
 755     my $uniqueness = Check_Userid($userid,$borrowernumber);
 756
 757     $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 != '').
 758
 759     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.
 760
 761     return :
 762         0 for not unique (i.e. this $userid already exists)
 763         1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
 764
 765 =cut
 766
 767 sub Check_Userid {
 768     my ( $uid, $borrowernumber ) = @_;
 769
 770     return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
 771
 772     return 0 if ( $uid eq C4::Context->config('user') );
 773
 774     my $rs = Koha::Database->new()->schema()->resultset('Borrower');
 775
 776     my $params;
 777     $params->{userid} = $uid;
 778     $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
 779
 780     my $count = $rs->count( $params );
 781
 782     return $count ? 0 : 1;
 783 }
 784
 785 =head2 Generate_Userid
 786
 787     my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
 788
 789     Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
 790
 791     $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.
 792
 793     return :
 794         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).
 795
 796 =cut
 797
 798 sub Generate_Userid {
 799   my ($borrowernumber, $firstname, $surname) = @_;
 800   my $newuid;
 801   my $offset = 0;
 802   #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
 803   do {
 804     $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
 805     $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
 806     $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
 807     $newuid = unac_string('utf-8',$newuid);
 808     $newuid .= $offset unless $offset == 0;
 809     $offset++;
 810
 811    } while (!Check_Userid($newuid,$borrowernumber));
 812
 813    return $newuid;
 814 }
 815
 816 sub changepassword {
 817     my ( $uid, $member, $digest ) = @_;
 818     my $dbh = C4::Context->dbh;
 819
 820 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
 821 #Then we need to tell the user and have them create a new one.
 822     my $resultcode;
 823     my $sth =
 824       $dbh->prepare(
 825         "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
 826     $sth->execute( $uid, $member );
 827     if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
 828         $resultcode=0;
 829     }
 830     else {
 831         #Everything is good so we can update the information.
 832         $sth =
 833           $dbh->prepare(
 834             "update borrowers set userid=?, password=? where borrowernumber=?");
 835         $sth->execute( $uid, $digest, $member );
 836         $resultcode=1;
 837     }
 838
 839     logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
 840     return $resultcode;
 841 }
 842
 843
 844
 845 =head2 fixup_cardnumber
 846
 847 Warning: The caller is responsible for locking the members table in write
 848 mode, to avoid database corruption.
 849
 850 =cut
 851
 852 use vars qw( @weightings );
 853 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
 854
 855 sub fixup_cardnumber {
 856     my ($cardnumber) = @_;
 857     my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
 858
 859     # Find out whether member numbers should be generated
 860     # automatically. Should be either "1" or something else.
 861     # Defaults to "0", which is interpreted as "no".
 862
 863     #     if ($cardnumber !~ /\S/ && $autonumber_members) {
 864     ($autonumber_members) or return $cardnumber;
 865     my $checkdigit = C4::Context->preference('checkdigit');
 866     my $dbh = C4::Context->dbh;
 867     if ( $checkdigit and $checkdigit eq 'katipo' ) {
 868
 869         # if checkdigit is selected, calculate katipo-style cardnumber.
 870         # otherwise, just use the max()
 871         # purpose: generate checksum'd member numbers.
 872         # We'll assume we just got the max value of digits 2-8 of member #'s
 873         # from the database and our job is to increment that by one,
 874         # determine the 1st and 9th digits and return the full string.
 875         my $sth = $dbh->prepare(
 876             "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
 877         );
 878         $sth->execute;
 879         my $data = $sth->fetchrow_hashref;
 880         $cardnumber = $data->{new_num};
 881         if ( !$cardnumber ) {    # If DB has no values,
 882             $cardnumber = 1000000;    # start at 1000000
 883         } else {
 884             $cardnumber += 1;
 885         }
 886
 887         my $sum = 0;
 888         for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
 889             # read weightings, left to right, 1 char at a time
 890             my $temp1 = $weightings[$i];
 891
 892             # sequence left to right, 1 char at a time
 893             my $temp2 = substr( $cardnumber, $i, 1 );
 894
 895             # mult each char 1-7 by its corresponding weighting
 896             $sum += $temp1 * $temp2;
 897         }
 898
 899         my $rem = ( $sum % 11 );
 900         $rem = 'X' if $rem == 10;
 901
 902         return "V$cardnumber$rem";
 903      } else {
 904
 905         my $sth = $dbh->prepare(
 906             'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
 907         );
 908         $sth->execute;
 909         my ($result) = $sth->fetchrow;
 910         return $result + 1;
 911     }
 912     return $cardnumber;     # just here as a fallback/reminder
 913 }
 914
 915 =head2 GetPendingIssues
 916
 917   my $issues = &GetPendingIssues(@borrowernumber);
 918
 919 Looks up what the patron with the given borrowernumber has borrowed.
 920
 921 C<&GetPendingIssues> returns a
 922 reference-to-array where each element is a reference-to-hash; the
 923 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
 924 The keys include C<biblioitems> fields except marc and marcxml.
 925
 926 =cut
 927
 928 sub GetPendingIssues {
 929     my @borrowernumbers = @_;
 930
 931     unless (@borrowernumbers ) { # return a ref_to_array
 932         return \@borrowernumbers; # to not cause surprise to caller
 933     }
 934
 935     # Borrowers part of the query
 936     my $bquery = '';
 937     for (my $i = 0; $i < @borrowernumbers; $i++) {
 938         $bquery .= ' issues.borrowernumber = ?';
 939         if ($i < $#borrowernumbers ) {
 940             $bquery .= ' OR';
 941         }
 942     }
 943
 944     # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
 945     # FIXME: namespace collision: each table has "timestamp" fields.  Which one is "timestamp" ?
 946     # FIXME: circ/ciculation.pl tries to sort by timestamp!
 947     # FIXME: namespace collision: other collisions possible.
 948     # FIXME: most of this data isn't really being used by callers.
 949     my $query =
 950    "SELECT issues.*,
 951             items.*,
 952            biblio.*,
 953            biblioitems.volume,
 954            biblioitems.number,
 955            biblioitems.itemtype,
 956            biblioitems.isbn,
 957            biblioitems.issn,
 958            biblioitems.publicationyear,
 959            biblioitems.publishercode,
 960            biblioitems.volumedate,
 961            biblioitems.volumedesc,
 962            biblioitems.lccn,
 963            biblioitems.url,
 964            borrowers.firstname,
 965            borrowers.surname,
 966            borrowers.cardnumber,
 967            issues.timestamp AS timestamp,
 968            issues.renewals  AS renewals,
 969            issues.borrowernumber AS borrowernumber,
 970             items.renewals  AS totalrenewals
 971     FROM   issues
 972     LEFT JOIN items       ON items.itemnumber       =      issues.itemnumber
 973     LEFT JOIN biblio      ON items.biblionumber     =      biblio.biblionumber
 974     LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
 975     LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
 976     WHERE
 977       $bquery
 978     ORDER BY issues.issuedate"
 979     ;
 980
 981     my $sth = C4::Context->dbh->prepare($query);
 982     $sth->execute(@borrowernumbers);
 983     my $data = $sth->fetchall_arrayref({});
 984     my $today = dt_from_string;
 985     foreach (@{$data}) {
 986         if ($_->{issuedate}) {
 987             $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
 988         }
 989         $_->{date_due_sql} = $_->{date_due};
 990         # FIXME no need to have this value
 991         $_->{date_due} or next;
 992         $_->{date_due_sql} = $_->{date_due};
 993         # FIXME no need to have this value
 994         $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
 995         if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
 996             $_->{overdue} = 1;
 997         }
 998     }
 999     return $data;
1000 }
1001
1002 =head2 GetAllIssues
1003
1004   $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
1005
1006 Looks up what the patron with the given borrowernumber has borrowed,
1007 and sorts the results.
1008
1009 C<$sortkey> is the name of a field on which to sort the results. This
1010 should be the name of a field in the C<issues>, C<biblio>,
1011 C<biblioitems>, or C<items> table in the Koha database.
1012
1013 C<$limit> is the maximum number of results to return.
1014
1015 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
1016 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1017 C<items> tables of the Koha database.
1018
1019 =cut
1020
1021 #'
1022 sub GetAllIssues {
1023     my ( $borrowernumber, $order, $limit ) = @_;
1024
1025     return unless $borrowernumber;
1026     $order = 'date_due desc' unless $order;
1027
1028     my $dbh = C4::Context->dbh;
1029     my $query =
1030 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1031   FROM issues
1032   LEFT JOIN items on items.itemnumber=issues.itemnumber
1033   LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1034   LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1035   WHERE borrowernumber=?
1036   UNION ALL
1037   SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1038   FROM old_issues
1039   LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1040   LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1041   LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1042   WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1043   order by ' . $order;
1044     if ($limit) {
1045         $query .= " limit $limit";
1046     }
1047
1048     my $sth = $dbh->prepare($query);
1049     $sth->execute( $borrowernumber, $borrowernumber );
1050     return $sth->fetchall_arrayref( {} );
1051 }
1052
1053
1054 =head2 GetMemberAccountRecords
1055
1056   ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1057
1058 Looks up accounting data for the patron with the given borrowernumber.
1059
1060 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1061 reference-to-array, where each element is a reference-to-hash; the
1062 keys are the fields of the C<accountlines> table in the Koha database.
1063 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1064 total amount outstanding for all of the account lines.
1065
1066 =cut
1067
1068 sub GetMemberAccountRecords {
1069     my ($borrowernumber) = @_;
1070     my $dbh = C4::Context->dbh;
1071     my @acctlines;
1072     my $numlines = 0;
1073     my $strsth      = qq(
1074                         SELECT *
1075                         FROM accountlines
1076                         WHERE borrowernumber=?);
1077     $strsth.=" ORDER BY accountlines_id desc";
1078     my $sth= $dbh->prepare( $strsth );
1079     $sth->execute( $borrowernumber );
1080
1081     my $total = 0;
1082     while ( my $data = $sth->fetchrow_hashref ) {
1083         if ( $data->{itemnumber} ) {
1084             my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1085             $data->{biblionumber} = $biblio->{biblionumber};
1086             $data->{title}        = $biblio->{title};
1087         }
1088         $acctlines[$numlines] = $data;
1089         $numlines++;
1090         $total += sprintf "%.0f", 1000*$data->{amountoutstanding}; # convert float to integer to avoid round-off errors
1091     }
1092     $total /= 1000;
1093     return ( $total, \@acctlines,$numlines);
1094 }
1095
1096 =head2 GetMemberAccountBalance
1097
1098   ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
1099
1100 Calculates amount immediately owing by the patron - non-issue charges.
1101 Based on GetMemberAccountRecords.
1102 Charges exempt from non-issue are:
1103 * Res (reserves)
1104 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
1105 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
1106
1107 =cut
1108
1109 sub GetMemberAccountBalance {
1110     my ($borrowernumber) = @_;
1111
1112     my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
1113
1114     my @not_fines;
1115     push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
1116     push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
1117     unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
1118         my $dbh = C4::Context->dbh;
1119         my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
1120         push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
1121     }
1122     my %not_fine = map {$_ => 1} @not_fines;
1123
1124     my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1125     my $other_charges = 0;
1126     foreach (@$acctlines) {
1127         $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1128     }
1129
1130     return ( $total, $total - $other_charges, $other_charges);
1131 }
1132
1133 =head2 GetBorNotifyAcctRecord
1134
1135   ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1136
1137 Looks up accounting data for the patron with the given borrowernumber per file number.
1138
1139 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1140 reference-to-array, where each element is a reference-to-hash; the
1141 keys are the fields of the C<accountlines> table in the Koha database.
1142 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1143 total amount outstanding for all of the account lines.
1144
1145 =cut
1146
1147 sub GetBorNotifyAcctRecord {
1148     my ( $borrowernumber, $notifyid ) = @_;
1149     my $dbh = C4::Context->dbh;
1150     my @acctlines;
1151     my $numlines = 0;
1152     my $sth = $dbh->prepare(
1153             "SELECT *
1154                 FROM accountlines
1155                 WHERE borrowernumber=?
1156                     AND notify_id=?
1157                     AND amountoutstanding != '0'
1158                 ORDER BY notify_id,accounttype
1159                 ");
1160
1161     $sth->execute( $borrowernumber, $notifyid );
1162     my $total = 0;
1163     while ( my $data = $sth->fetchrow_hashref ) {
1164         if ( $data->{itemnumber} ) {
1165             my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1166             $data->{biblionumber} = $biblio->{biblionumber};
1167             $data->{title}        = $biblio->{title};
1168         }
1169         $acctlines[$numlines] = $data;
1170         $numlines++;
1171         $total += int(100 * $data->{'amountoutstanding'});
1172     }
1173     $total /= 100;
1174     return ( $total, \@acctlines, $numlines );
1175 }
1176
1177 =head2 checkuniquemember (OUEST-PROVENCE)
1178
1179   ($result,$categorycode)  = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1180
1181 Checks that a member exists or not in the database.
1182
1183 C<&result> is nonzero (=exist) or 0 (=does not exist)
1184 C<&categorycode> is from categorycode table
1185 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1186 C<&surname> is the surname
1187 C<&firstname> is the firstname (only if collectivity=0)
1188 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1189
1190 =cut
1191
1192 # FIXME: This function is not legitimate.  Multiple patrons might have the same first/last name and birthdate.
1193 # This is especially true since first name is not even a required field.
1194
1195 sub checkuniquemember {
1196     my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1197     my $dbh = C4::Context->dbh;
1198     my $request = ($collectivity) ?
1199         "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1200             ($dateofbirth) ?
1201             "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?  and dateofbirth=?" :
1202             "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1203     my $sth = $dbh->prepare($request);
1204     if ($collectivity) {
1205         $sth->execute( uc($surname) );
1206     } elsif($dateofbirth){
1207         $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1208     }else{
1209         $sth->execute( uc($surname), ucfirst($firstname));
1210     }
1211     my @data = $sth->fetchrow;
1212     ( $data[0] ) and return $data[0], $data[1];
1213     return 0;
1214 }
1215
1216 sub checkcardnumber {
1217     my ( $cardnumber, $borrowernumber ) = @_;
1218
1219     # If cardnumber is null, we assume they're allowed.
1220     return 0 unless defined $cardnumber;
1221
1222     my $dbh = C4::Context->dbh;
1223     my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1224     $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1225     my $sth = $dbh->prepare($query);
1226     $sth->execute(
1227         $cardnumber,
1228         ( $borrowernumber ? $borrowernumber : () )
1229     );
1230
1231     return 1 if $sth->fetchrow_hashref;
1232
1233     my ( $min_length, $max_length ) = get_cardnumber_length();
1234     return 2
1235         if length $cardnumber > $max_length
1236         or length $cardnumber < $min_length;
1237
1238     return 0;
1239 }
1240
1241 =head2 get_cardnumber_length
1242
1243     my ($min, $max) = C4::Members::get_cardnumber_length()
1244
1245 Returns the minimum and maximum length for patron cardnumbers as
1246 determined by the CardnumberLength system preference, the
1247 BorrowerMandatoryField system preference, and the width of the
1248 database column.
1249
1250 =cut
1251
1252 sub get_cardnumber_length {
1253     my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1254     $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1255     if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1256         # Is integer and length match
1257         if ( $cardnumber_length =~ m|^\d+$| ) {
1258             $min = $max = $cardnumber_length
1259                 if $cardnumber_length >= $min
1260                     and $cardnumber_length <= $max;
1261         }
1262         # Else assuming it is a range
1263         elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1264             $min = $1 if $1 and $min < $1;
1265             $max = $2 if $2 and $max > $2;
1266         }
1267
1268     }
1269     return ( $min, $max );
1270 }
1271
1272 =head2 GetFirstValidEmailAddress
1273
1274   $email = GetFirstValidEmailAddress($borrowernumber);
1275
1276 Return the first valid email address for a borrower, given the borrowernumber.  For now, the order
1277 is defined as email, emailpro, B_email.  Returns the empty string if the borrower has no email
1278 addresses.
1279
1280 =cut
1281
1282 sub GetFirstValidEmailAddress {
1283     my $borrowernumber = shift;
1284     my $dbh = C4::Context->dbh;
1285     my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1286     $sth->execute( $borrowernumber );
1287     my $data = $sth->fetchrow_hashref;
1288
1289     if ($data->{'email'}) {
1290        return $data->{'email'};
1291     } elsif ($data->{'emailpro'}) {
1292        return $data->{'emailpro'};
1293     } elsif ($data->{'B_email'}) {
1294        return $data->{'B_email'};
1295     } else {
1296        return '';
1297     }
1298 }
1299
1300 =head2 GetNoticeEmailAddress
1301
1302   $email = GetNoticeEmailAddress($borrowernumber);
1303
1304 Return the email address of borrower used for notices, given the borrowernumber.
1305 Returns the empty string if no email address.
1306
1307 =cut
1308
1309 sub GetNoticeEmailAddress {
1310     my $borrowernumber = shift;
1311
1312     my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1313     # if syspref is set to 'first valid' (value == OFF), look up email address
1314     if ( $which_address eq 'OFF' ) {
1315         return GetFirstValidEmailAddress($borrowernumber);
1316     }
1317     # specified email address field
1318     my $dbh = C4::Context->dbh;
1319     my $sth = $dbh->prepare( qq{
1320         SELECT $which_address AS primaryemail
1321         FROM borrowers
1322         WHERE borrowernumber=?
1323     } );
1324     $sth->execute($borrowernumber);
1325     my $data = $sth->fetchrow_hashref;
1326     return $data->{'primaryemail'} || '';
1327 }
1328
1329 =head2 GetExpiryDate
1330
1331   $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1332
1333 Calculate expiry date given a categorycode and starting date.  Date argument must be in ISO format.
1334 Return date is also in ISO format.
1335
1336 =cut
1337
1338 sub GetExpiryDate {
1339     my ( $categorycode, $dateenrolled ) = @_;
1340     my $enrolments;
1341     if ($categorycode) {
1342         my $dbh = C4::Context->dbh;
1343         my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1344         $sth->execute($categorycode);
1345         $enrolments = $sth->fetchrow_hashref;
1346     }
1347     # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1348     my @date = split (/-/,$dateenrolled);
1349     if($enrolments->{enrolmentperiod}){
1350         return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1351     }else{
1352         return $enrolments->{enrolmentperioddate};
1353     }
1354 }
1355
1356 =head2 GetUpcomingMembershipExpires
1357
1358     my $expires = GetUpcomingMembershipExpires({
1359         branch => $branch, before => $before, after => $after,
1360     });
1361
1362     $branch is an optional branch code.
1363     $before/$after is an optional number of days before/after the date that
1364     is set by the preference MembershipExpiryDaysNotice.
1365     If the pref would be 14, before 2 and after 3, you will get all expires
1366     from 12 to 17 days.
1367
1368 =cut
1369
1370 sub GetUpcomingMembershipExpires {
1371     my ( $params ) = @_;
1372     my $before = $params->{before} || 0;
1373     my $after  = $params->{after} || 0;
1374     my $branch = $params->{branch};
1375
1376     my $dbh = C4::Context->dbh;
1377     my $days = C4::Context->preference("MembershipExpiryDaysNotice") || 0;
1378     my $date1 = dt_from_string->add( days => $days - $before );
1379     my $date2 = dt_from_string->add( days => $days + $after );
1380     $date1= output_pref({ dt => $date1, dateformat => 'iso', dateonly => 1 });
1381     $date2= output_pref({ dt => $date2, dateformat => 'iso', dateonly => 1 });
1382
1383     my $query = q|
1384         SELECT borrowers.*, categories.description,
1385         branches.branchname, branches.branchemail FROM borrowers
1386         LEFT JOIN branches USING (branchcode)
1387         LEFT JOIN categories USING (categorycode)
1388     |;
1389     if( $branch ) {
1390         $query.= 'WHERE branchcode=? AND dateexpiry BETWEEN ? AND ?';
1391     } else {
1392         $query.= 'WHERE dateexpiry BETWEEN ? AND ?';
1393     }
1394
1395     my $sth = $dbh->prepare( $query );
1396     my @pars = $branch? ( $branch ): ();
1397     push @pars, $date1, $date2;
1398     $sth->execute( @pars );
1399     my $results = $sth->fetchall_arrayref( {} );
1400     return $results;
1401 }
1402
1403 =head2 GetborCatFromCatType
1404
1405   ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1406
1407 Looks up the different types of borrowers in the database. Returns two
1408 elements: a reference-to-array, which lists the borrower category
1409 codes, and a reference-to-hash, which maps the borrower category codes
1410 to category descriptions.
1411
1412 =cut
1413
1414 #'
1415 sub GetborCatFromCatType {
1416     my ( $category_type, $action, $no_branch_limit ) = @_;
1417
1418     my $branch_limit = $no_branch_limit
1419         ? 0
1420         : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1421
1422     # FIXME - This API  seems both limited and dangerous.
1423     my $dbh     = C4::Context->dbh;
1424
1425     my $request = qq{
1426         SELECT categories.categorycode, categories.description
1427         FROM categories
1428     };
1429     $request .= qq{
1430         LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1431     } if $branch_limit;
1432     if($action) {
1433         $request .= " $action ";
1434         $request .= " AND (branchcode = ? OR branchcode IS NULL) GROUP BY description" if $branch_limit;
1435     } else {
1436         $request .= " WHERE branchcode = ? OR branchcode IS NULL GROUP BY description" if $branch_limit;
1437     }
1438     $request .= " ORDER BY categorycode";
1439
1440     my $sth = $dbh->prepare($request);
1441     $sth->execute(
1442         $action ? $category_type : (),
1443         $branch_limit ? $branch_limit : ()
1444     );
1445
1446     my %labels;
1447     my @codes;
1448
1449     while ( my $data = $sth->fetchrow_hashref ) {
1450         push @codes, $data->{'categorycode'};
1451         $labels{ $data->{'categorycode'} } = $data->{'description'};
1452     }
1453     $sth->finish;
1454     return ( \@codes, \%labels );
1455 }
1456
1457 =head2 GetBorrowercategory
1458
1459   $hashref = &GetBorrowercategory($categorycode);
1460
1461 Given the borrower's category code, the function returns the corresponding
1462 data hashref for a comprehensive information display.
1463
1464 =cut
1465
1466 sub GetBorrowercategory {
1467     my ($catcode) = @_;
1468     my $dbh       = C4::Context->dbh;
1469     if ($catcode){
1470         my $sth       =
1471         $dbh->prepare(
1472     "SELECT description,dateofbirthrequired,upperagelimit,category_type
1473     FROM categories
1474     WHERE categorycode = ?"
1475         );
1476         $sth->execute($catcode);
1477         my $data =
1478         $sth->fetchrow_hashref;
1479         return $data;
1480     }
1481     return;
1482 }    # sub getborrowercategory
1483
1484
1485 =head2 GetBorrowerCategorycode
1486
1487     $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
1488
1489 Given the borrowernumber, the function returns the corresponding categorycode
1490
1491 =cut
1492
1493 sub GetBorrowerCategorycode {
1494     my ( $borrowernumber ) = @_;
1495     my $dbh = C4::Context->dbh;
1496     my $sth = $dbh->prepare( qq{
1497         SELECT categorycode
1498         FROM borrowers
1499         WHERE borrowernumber = ?
1500     } );
1501     $sth->execute( $borrowernumber );
1502     return $sth->fetchrow;
1503 }
1504
1505 =head2 GetBorrowercategoryList
1506
1507   $arrayref_hashref = &GetBorrowercategoryList;
1508 If no category code provided, the function returns all the categories.
1509
1510 =cut
1511
1512 sub GetBorrowercategoryList {
1513     my $no_branch_limit = @_ ? shift : 0;
1514     my $branch_limit = $no_branch_limit
1515         ? 0
1516         : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1517     my $dbh       = C4::Context->dbh;
1518     my $query = "SELECT categories.* FROM categories";
1519     $query .= qq{
1520         LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1521         WHERE branchcode = ? OR branchcode IS NULL GROUP BY description
1522     } if $branch_limit;
1523     $query .= " ORDER BY description";
1524     my $sth = $dbh->prepare( $query );
1525     $sth->execute( $branch_limit ? $branch_limit : () );
1526     my $data = $sth->fetchall_arrayref( {} );
1527     $sth->finish;
1528     return $data;
1529 }    # sub getborrowercategory
1530
1531 =head2 GetAge
1532
1533   $dateofbirth,$date = &GetAge($date);
1534
1535 this function return the borrowers age with the value of dateofbirth
1536
1537 =cut
1538
1539 #'
1540 sub GetAge{
1541     my ( $date, $date_ref ) = @_;
1542
1543     if ( not defined $date_ref ) {
1544         $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1545     }
1546
1547     my ( $year1, $month1, $day1 ) = split /-/, $date;
1548     my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1549
1550     my $age = $year2 - $year1;
1551     if ( $month1 . $day1 > $month2 . $day2 ) {
1552         $age--;
1553     }
1554
1555     return $age;
1556 }    # sub get_age
1557
1558 =head2 SetAge
1559
1560   $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1561   $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1562   $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1563
1564   eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1565   if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1566
1567 This function sets the borrower's dateofbirth to match the given age.
1568 Optionally relative to the given $datetime_reference.
1569
1570 @PARAM1 koha.borrowers-object
1571 @PARAM2 DateTime::Duration-object as the desired age
1572         OR a ISO 8601 Date. (To make the API more pleasant)
1573 @PARAM3 DateTime-object as the relative date, defaults to now().
1574 RETURNS The given borrower reference @PARAM1.
1575 DIES    If there was an error with the ISO Date handling.
1576
1577 =cut
1578
1579 #'
1580 sub SetAge{
1581     my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1582     $datetime_ref = DateTime->now() unless $datetime_ref;
1583
1584     if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1585         if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1586             $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1587         }
1588         else {
1589             die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1590         }
1591     }
1592
1593     my $new_datetime_ref = $datetime_ref->clone();
1594     $new_datetime_ref->subtract_duration( $datetimeduration );
1595
1596     $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1597
1598     return $borrower;
1599 }    # sub SetAge
1600
1601 =head2 GetSortDetails (OUEST-PROVENCE)
1602
1603   ($lib) = &GetSortDetails($category,$sortvalue);
1604
1605 Returns the authorized value  details
1606 C<&$lib>return value of authorized value details
1607 C<&$sortvalue>this is the value of authorized value
1608 C<&$category>this is the value of authorized value category
1609
1610 =cut
1611
1612 sub GetSortDetails {
1613     my ( $category, $sortvalue ) = @_;
1614     my $dbh   = C4::Context->dbh;
1615     my $query = qq|SELECT lib
1616         FROM authorised_values
1617         WHERE category=?
1618         AND authorised_value=? |;
1619     my $sth = $dbh->prepare($query);
1620     $sth->execute( $category, $sortvalue );
1621     my $lib = $sth->fetchrow;
1622     return ($lib) if ($lib);
1623     return ($sortvalue) unless ($lib);
1624 }
1625
1626 =head2 MoveMemberToDeleted
1627
1628   $result = &MoveMemberToDeleted($borrowernumber);
1629
1630 Copy the record from borrowers to deletedborrowers table.
1631 The routine returns 1 for success, undef for failure.
1632
1633 =cut
1634
1635 sub MoveMemberToDeleted {
1636     my ($member) = shift or return;
1637
1638     my $schema       = Koha::Database->new()->schema();
1639     my $borrowers_rs = $schema->resultset('Borrower');
1640     $borrowers_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
1641     my $borrower = $borrowers_rs->find($member);
1642     return unless $borrower;
1643
1644     my $deleted = $schema->resultset('Deletedborrower')->create($borrower);
1645
1646     return $deleted ? 1 : undef;
1647 }
1648
1649 =head2 DelMember
1650
1651     DelMember($borrowernumber);
1652
1653 This function remove directly a borrower whitout writing it on deleteborrower.
1654 + Deletes reserves for the borrower
1655
1656 =cut
1657
1658 sub DelMember {
1659     my $dbh            = C4::Context->dbh;
1660     my $borrowernumber = shift;
1661     #warn "in delmember with $borrowernumber";
1662     return unless $borrowernumber;    # borrowernumber is mandatory.
1663
1664     my $query = qq|DELETE
1665           FROM  reserves
1666           WHERE borrowernumber=?|;
1667     my $sth = $dbh->prepare($query);
1668     $sth->execute($borrowernumber);
1669     $query = "
1670        DELETE
1671        FROM borrowers
1672        WHERE borrowernumber = ?
1673    ";
1674     $sth = $dbh->prepare($query);
1675     $sth->execute($borrowernumber);
1676     logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1677     return $sth->rows;
1678 }
1679
1680 =head2 HandleDelBorrower
1681
1682      HandleDelBorrower($borrower);
1683
1684 When a member is deleted (DelMember in Members.pm), you should call me first.
1685 This routine deletes/moves lists and entries for the deleted member/borrower.
1686 Lists owned by the borrower are deleted, but entries from the borrower to
1687 other lists are kept.
1688
1689 =cut
1690
1691 sub HandleDelBorrower {
1692     my ($borrower)= @_;
1693     my $query;
1694     my $dbh = C4::Context->dbh;
1695
1696     #Delete all lists and all shares of this borrower
1697     #Consistent with the approach Koha uses on deleting individual lists
1698     #Note that entries in virtualshelfcontents added by this borrower to
1699     #lists of others will be handled by a table constraint: the borrower
1700     #is set to NULL in those entries.
1701     $query="DELETE FROM virtualshelves WHERE owner=?";
1702     $dbh->do($query,undef,($borrower));
1703
1704     #NOTE:
1705     #We could handle the above deletes via a constraint too.
1706     #But a new BZ report 11889 has been opened to discuss another approach.
1707     #Instead of deleting we could also disown lists (based on a pref).
1708     #In that way we could save shared and public lists.
1709     #The current table constraints support that idea now.
1710     #This pref should then govern the results of other routines/methods such as
1711     #Koha::Virtualshelf->new->delete too.
1712 }
1713
1714 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1715
1716     $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1717
1718 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1719 Returns ISO date.
1720
1721 =cut
1722
1723 sub ExtendMemberSubscriptionTo {
1724     my ( $borrowerid,$date) = @_;
1725     my $dbh = C4::Context->dbh;
1726     my $borrower = GetMember('borrowernumber'=>$borrowerid);
1727     unless ($date){
1728       $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1729                                         eval { output_pref( { dt => dt_from_string( $borrower->{'dateexpiry'}  ), dateonly => 1, dateformat => 'iso' } ); }
1730                                         :
1731                                         output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
1732       $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1733     }
1734     my $sth = $dbh->do(<<EOF);
1735 UPDATE borrowers
1736 SET  dateexpiry='$date'
1737 WHERE borrowernumber='$borrowerid'
1738 EOF
1739
1740     AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
1741
1742     logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1743     return $date if ($sth);
1744     return 0;
1745 }
1746
1747 =head2 GetTitles (OUEST-PROVENCE)
1748
1749   ($borrowertitle)= &GetTitles();
1750
1751 Looks up the different title . Returns array  with all borrowers title
1752
1753 =cut
1754
1755 sub GetTitles {
1756     my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1757     unshift( @borrowerTitle, "" );
1758     my $count=@borrowerTitle;
1759     if ($count == 1){
1760         return ();
1761     }
1762     else {
1763         return ( \@borrowerTitle);
1764     }
1765 }
1766
1767 =head2 GetHideLostItemsPreference
1768
1769   $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1770
1771 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1772 C<&$hidelostitemspref>return value of function, 0 or 1
1773
1774 =cut
1775
1776 sub GetHideLostItemsPreference {
1777     my ($borrowernumber) = @_;
1778     my $dbh = C4::Context->dbh;
1779     my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1780     my $sth = $dbh->prepare($query);
1781     $sth->execute($borrowernumber);
1782     my $hidelostitems = $sth->fetchrow;
1783     return $hidelostitems;
1784 }
1785
1786 =head2 GetBorrowersToExpunge
1787
1788   $borrowers = &GetBorrowersToExpunge(
1789       not_borrowed_since => $not_borrowed_since,
1790       expired_before       => $expired_before,
1791       category_code        => $category_code,
1792       patron_list_id       => $patron_list_id,
1793       branchcode           => $branchcode
1794   );
1795
1796   This function get all borrowers based on the given criteria.
1797
1798 =cut
1799
1800 sub GetBorrowersToExpunge {
1801
1802     my $params = shift;
1803     my $filterdate       = $params->{'not_borrowed_since'};
1804     my $filterexpiry     = $params->{'expired_before'};
1805     my $filtercategory   = $params->{'category_code'};
1806     my $filterbranch     = $params->{'branchcode'} ||
1807                         ((C4::Context->preference('IndependentBranches')
1808                              && C4::Context->userenv
1809                              && !C4::Context->IsSuperLibrarian()
1810                              && C4::Context->userenv->{branch})
1811                          ? C4::Context->userenv->{branch}
1812                          : "");
1813     my $filterpatronlist = $params->{'patron_list_id'};
1814
1815     my $dbh   = C4::Context->dbh;
1816     my $query = q|
1817         SELECT borrowers.borrowernumber,
1818                MAX(old_issues.timestamp) AS latestissue,
1819                MAX(issues.timestamp) AS currentissue
1820         FROM   borrowers
1821         JOIN   categories USING (categorycode)
1822         LEFT JOIN (
1823             SELECT guarantorid
1824             FROM borrowers
1825             WHERE guarantorid IS NOT NULL
1826                 AND guarantorid <> 0
1827         ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
1828         LEFT JOIN old_issues USING (borrowernumber)
1829         LEFT JOIN issues USING (borrowernumber)|;
1830     if ( $filterpatronlist  ){
1831         $query .= q| LEFT JOIN patron_list_patrons USING (borrowernumber)|;
1832     }
1833     $query .= q| WHERE  category_type <> 'S'
1834         AND tmp.guarantorid IS NULL
1835    |;
1836     my @query_params;
1837     if ( $filterbranch && $filterbranch ne "" ) {
1838         $query.= " AND borrowers.branchcode = ? ";
1839         push( @query_params, $filterbranch );
1840     }
1841     if ( $filterexpiry ) {
1842         $query .= " AND dateexpiry < ? ";
1843         push( @query_params, $filterexpiry );
1844     }
1845     if ( $filtercategory ) {
1846         $query .= " AND categorycode = ? ";
1847         push( @query_params, $filtercategory );
1848     }
1849     if ( $filterpatronlist ){
1850         $query.=" AND patron_list_id = ? ";
1851         push( @query_params, $filterpatronlist );
1852     }
1853     $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
1854     if ( $filterdate ) {
1855         $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
1856         push @query_params,$filterdate;
1857     }
1858     warn $query if $debug;
1859
1860     my $sth = $dbh->prepare($query);
1861     if (scalar(@query_params)>0){
1862         $sth->execute(@query_params);
1863     }
1864     else {
1865         $sth->execute;
1866     }
1867
1868     my @results;
1869     while ( my $data = $sth->fetchrow_hashref ) {
1870         push @results, $data;
1871     }
1872     return \@results;
1873 }
1874
1875 =head2 GetBorrowersWhoHaveNeverBorrowed
1876
1877   $results = &GetBorrowersWhoHaveNeverBorrowed
1878
1879 This function get all borrowers who have never borrowed.
1880
1881 I<$result> is a ref to an array which all elements are a hasref.
1882
1883 =cut
1884
1885 sub GetBorrowersWhoHaveNeverBorrowed {
1886     my $filterbranch = shift ||
1887                         ((C4::Context->preference('IndependentBranches')
1888                              && C4::Context->userenv
1889                              && !C4::Context->IsSuperLibrarian()
1890                              && C4::Context->userenv->{branch})
1891                          ? C4::Context->userenv->{branch}
1892                          : "");
1893     my $dbh   = C4::Context->dbh;
1894     my $query = "
1895         SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1896         FROM   borrowers
1897           LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1898         WHERE issues.borrowernumber IS NULL
1899    ";
1900     my @query_params;
1901     if ($filterbranch && $filterbranch ne ""){
1902         $query.=" AND borrowers.branchcode= ?";
1903         push @query_params,$filterbranch;
1904     }
1905     warn $query if $debug;
1906
1907     my $sth = $dbh->prepare($query);
1908     if (scalar(@query_params)>0){
1909         $sth->execute(@query_params);
1910     }
1911     else {
1912         $sth->execute;
1913     }
1914
1915     my @results;
1916     while ( my $data = $sth->fetchrow_hashref ) {
1917         push @results, $data;
1918     }
1919     return \@results;
1920 }
1921
1922 =head2 GetBorrowersWithIssuesHistoryOlderThan
1923
1924   $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1925
1926 this function get all borrowers who has an issue history older than I<$date> given on input arg.
1927
1928 I<$result> is a ref to an array which all elements are a hashref.
1929 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1930
1931 =cut
1932
1933 sub GetBorrowersWithIssuesHistoryOlderThan {
1934     my $dbh  = C4::Context->dbh;
1935     my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
1936     my $filterbranch = shift ||
1937                         ((C4::Context->preference('IndependentBranches')
1938                              && C4::Context->userenv
1939                              && !C4::Context->IsSuperLibrarian()
1940                              && C4::Context->userenv->{branch})
1941                          ? C4::Context->userenv->{branch}
1942                          : "");
1943     my $query = "
1944        SELECT count(borrowernumber) as n,borrowernumber
1945        FROM old_issues
1946        WHERE returndate < ?
1947          AND borrowernumber IS NOT NULL
1948     ";
1949     my @query_params;
1950     push @query_params, $date;
1951     if ($filterbranch){
1952         $query.="   AND branchcode = ?";
1953         push @query_params, $filterbranch;
1954     }
1955     $query.=" GROUP BY borrowernumber ";
1956     warn $query if $debug;
1957     my $sth = $dbh->prepare($query);
1958     $sth->execute(@query_params);
1959     my @results;
1960
1961     while ( my $data = $sth->fetchrow_hashref ) {
1962         push @results, $data;
1963     }
1964     return \@results;
1965 }
1966
1967 =head2 GetBorrowersNamesAndLatestIssue
1968
1969   $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
1970
1971 this function get borrowers Names and surnames and Issue information.
1972
1973 I<@borrowernumbers> is an array which all elements are borrowernumbers.
1974 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1975
1976 =cut
1977
1978 sub GetBorrowersNamesAndLatestIssue {
1979     my $dbh  = C4::Context->dbh;
1980     my @borrowernumbers=@_;
1981     my $query = "
1982        SELECT surname,lastname, phone, email,max(timestamp)
1983        FROM borrowers
1984          LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
1985        GROUP BY borrowernumber
1986    ";
1987     my $sth = $dbh->prepare($query);
1988     $sth->execute;
1989     my $results = $sth->fetchall_arrayref({});
1990     return $results;
1991 }
1992
1993 =head2 ModPrivacy
1994
1995   my $success = ModPrivacy( $borrowernumber, $privacy );
1996
1997 Update the privacy of a patron.
1998
1999 return :
2000 true on success, false on failure
2001
2002 =cut
2003
2004 sub ModPrivacy {
2005     my $borrowernumber = shift;
2006     my $privacy = shift;
2007     return unless defined $borrowernumber;
2008     return unless $borrowernumber =~ /^\d+$/;
2009
2010     return ModMember( borrowernumber => $borrowernumber,
2011                       privacy        => $privacy );
2012 }
2013
2014 =head2 IssueSlip
2015
2016   IssueSlip($branchcode, $borrowernumber, $quickslip)
2017
2018   Returns letter hash ( see C4::Letters::GetPreparedLetter )
2019
2020   $quickslip is boolean, to indicate whether we want a quick slip
2021
2022   IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
2023
2024   Both slips:
2025
2026       <<branches.*>>
2027       <<borrowers.*>>
2028
2029   ISSUESLIP:
2030
2031       <checkedout>
2032          <<biblio.*>>
2033          <<items.*>>
2034          <<biblioitems.*>>
2035          <<issues.*>>
2036       </checkedout>
2037
2038       <overdue>
2039          <<biblio.*>>
2040          <<items.*>>
2041          <<biblioitems.*>>
2042          <<issues.*>>
2043       </overdue>
2044
2045       <news>
2046          <<opac_news.*>>
2047       </news>
2048
2049   ISSUEQSLIP:
2050
2051       <checkedout>
2052          <<biblio.*>>
2053          <<items.*>>
2054          <<biblioitems.*>>
2055          <<issues.*>>
2056       </checkedout>
2057
2058   NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
2059
2060 =cut
2061
2062 sub IssueSlip {
2063     my ($branch, $borrowernumber, $quickslip) = @_;
2064
2065     # FIXME Check callers before removing this statement
2066     #return unless $borrowernumber;
2067
2068     my @issues = @{ GetPendingIssues($borrowernumber) };
2069
2070     for my $issue (@issues) {
2071         $issue->{date_due} = $issue->{date_due_sql};
2072         if ($quickslip) {
2073             my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2074             if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
2075                 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
2076                   $issue->{now} = 1;
2077             };
2078         }
2079     }
2080
2081     # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
2082     @issues = sort {
2083         my $s = $b->{timestamp} <=> $a->{timestamp};
2084         $s == 0 ?
2085              $b->{issuedate} <=> $a->{issuedate} : $s;
2086     } @issues;
2087
2088     my ($letter_code, %repeat);
2089     if ( $quickslip ) {
2090         $letter_code = 'ISSUEQSLIP';
2091         %repeat =  (
2092             'checkedout' => [ map {
2093                 'biblio'       => $_,
2094                 'items'        => $_,
2095                 'biblioitems'  => $_,
2096                 'issues'       => $_,
2097             }, grep { $_->{'now'} } @issues ],
2098         );
2099     }
2100     else {
2101         $letter_code = 'ISSUESLIP';
2102         %repeat =  (
2103             'checkedout' => [ map {
2104                 'biblio'       => $_,
2105                 'items'        => $_,
2106                 'biblioitems'  => $_,
2107                 'issues'       => $_,
2108             }, grep { !$_->{'overdue'} } @issues ],
2109
2110             'overdue' => [ map {
2111                 'biblio'       => $_,
2112                 'items'        => $_,
2113                 'biblioitems'  => $_,
2114                 'issues'       => $_,
2115             }, grep { $_->{'overdue'} } @issues ],
2116
2117             'news' => [ map {
2118                 $_->{'timestamp'} = $_->{'newdate'};
2119                 { opac_news => $_ }
2120             } @{ GetNewsToDisplay("slip",$branch) } ],
2121         );
2122     }
2123
2124     return  C4::Letters::GetPreparedLetter (
2125         module => 'circulation',
2126         letter_code => $letter_code,
2127         branchcode => $branch,
2128         tables => {
2129             'branches'    => $branch,
2130             'borrowers'   => $borrowernumber,
2131         },
2132         repeat => \%repeat,
2133     );
2134 }
2135
2136 =head2 GetBorrowersWithEmail
2137
2138     ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2139
2140 This gets a list of users and their basic details from their email address.
2141 As it's possible for multiple user to have the same email address, it provides
2142 you with all of them. If there is no userid for the user, there will be an
2143 C<undef> there. An empty list will be returned if there are no matches.
2144
2145 =cut
2146
2147 sub GetBorrowersWithEmail {
2148     my $email = shift;
2149
2150     my $dbh = C4::Context->dbh;
2151
2152     my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2153     my $sth=$dbh->prepare($query);
2154     $sth->execute($email);
2155     my @result = ();
2156     while (my $ref = $sth->fetch) {
2157         push @result, $ref;
2158     }
2159     die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2160     return @result;
2161 }
2162
2163 =head2 AddMember_Opac
2164
2165 =cut
2166
2167 sub AddMember_Opac {
2168     my ( %borrower ) = @_;
2169
2170     $borrower{'categorycode'} //= C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2171     if (not defined $borrower{'password'}){
2172         my $sr = new String::Random;
2173         $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
2174         my $password = $sr->randpattern("AAAAAAAAAA");
2175         $borrower{'password'} = $password;
2176     }
2177
2178     $borrower{'cardnumber'} = fixup_cardnumber( $borrower{'cardnumber'} );
2179
2180     my $borrowernumber = AddMember(%borrower);
2181
2182     return ( $borrowernumber, $borrower{'password'} );
2183 }
2184
2185 =head2 AddEnrolmentFeeIfNeeded
2186
2187     AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
2188
2189 Add enrolment fee for a patron if needed.
2190
2191 =cut
2192
2193 sub AddEnrolmentFeeIfNeeded {
2194     my ( $categorycode, $borrowernumber ) = @_;
2195     # check for enrollment fee & add it if needed
2196     my $dbh = C4::Context->dbh;
2197     my $sth = $dbh->prepare(q{
2198         SELECT enrolmentfee
2199         FROM categories
2200         WHERE categorycode=?
2201     });
2202     $sth->execute( $categorycode );
2203     if ( $sth->err ) {
2204         warn sprintf('Database returned the following error: %s', $sth->errstr);
2205         return;
2206     }
2207     my ($enrolmentfee) = $sth->fetchrow;
2208     if ($enrolmentfee && $enrolmentfee > 0) {
2209         # insert fee in patron debts
2210         C4::Accounts::manualinvoice( $borrowernumber, '', '', 'A', $enrolmentfee );
2211     }
2212 }
2213
2214 =head2 HasOverdues
2215
2216 =cut
2217
2218 sub HasOverdues {
2219     my ( $borrowernumber ) = @_;
2220
2221     my $sql = "SELECT COUNT(*) FROM issues WHERE date_due < NOW() AND borrowernumber = ?";
2222     my $sth = C4::Context->dbh->prepare( $sql );
2223     $sth->execute( $borrowernumber );
2224     my ( $count ) = $sth->fetchrow_array();
2225
2226     return $count;
2227 }
2228
2229 =head2 DeleteExpiredOpacRegistrations
2230
2231     Delete accounts that haven't been upgraded from the 'temporary' category
2232     Returns the number of removed patrons
2233
2234 =cut
2235
2236 sub DeleteExpiredOpacRegistrations {
2237
2238     my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
2239     my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2240
2241     return 0 if not $category_code or not defined $delay or $delay eq q||;
2242
2243     my $query = qq|
2244 SELECT borrowernumber
2245 FROM borrowers
2246 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
2247
2248     my $dbh = C4::Context->dbh;
2249     my $sth = $dbh->prepare($query);
2250     $sth->execute( $category_code, $delay );
2251     my $cnt=0;
2252     while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
2253         DelMember($borrowernumber);
2254         $cnt++;
2255     }
2256     return $cnt;
2257 }
2258
2259 =head2 DeleteUnverifiedOpacRegistrations
2260
2261     Delete all unverified self registrations in borrower_modifications,
2262     older than the specified number of days.
2263
2264 =cut
2265
2266 sub DeleteUnverifiedOpacRegistrations {
2267     my ( $days ) = @_;
2268     my $dbh = C4::Context->dbh;
2269     my $sql=qq|
2270 DELETE FROM borrower_modifications
2271 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
2272     my $cnt=$dbh->do($sql, undef, ($days) );
2273     return $cnt eq '0E0'? 0: $cnt;
2274 }
2275
2276 sub GetOverduesForPatron {
2277     my ( $borrowernumber ) = @_;
2278
2279     my $sql = "
2280         SELECT *
2281         FROM issues, items, biblio, biblioitems
2282         WHERE items.itemnumber=issues.itemnumber
2283           AND biblio.biblionumber   = items.biblionumber
2284           AND biblio.biblionumber   = biblioitems.biblionumber
2285           AND issues.borrowernumber = ?
2286           AND date_due < NOW()
2287     ";
2288
2289     my $sth = C4::Context->dbh->prepare( $sql );
2290     $sth->execute( $borrowernumber );
2291
2292     return $sth->fetchall_arrayref({});
2293 }
2294
2295 END { }    # module clean-up code here (global destructor)
2296
2297 1;
2298
2299 __END__
2300
2301 =head1 AUTHOR
2302
2303 Koha Team
2304
2305 =cut