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