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