C4/Members.pm

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