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