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