X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=C4%2FMembers.pm;h=cddbf414d03436889fac6b7ea9fb77adb9004889;hb=b592c3a0f51625da35a37b8334a04eaad6f25549;hp=9007ece8f7b865a9f0212a78eec40fcc618cf6de;hpb=e321fc9184c86fe809376a3a97ff37698d12acda;p=koha.git diff --git a/C4/Members.pm b/C4/Members.pm index 9007ece8f7..cddbf414d0 100644 --- a/C4/Members.pm +++ b/C4/Members.pm @@ -13,12 +13,13 @@ package C4::Members; # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR # A PARTICULAR PURPOSE. See the GNU General Public License for more details. # -# You should have received a copy of the GNU General Public License along with -# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place, -# Suite 330, Boston, MA 02111-1307 USA +# You should have received a copy of the GNU General Public License along +# with Koha; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. use strict; +#use warnings; FIXME - Bug 2505 use C4::Context; use C4::Dates qw(format_date_in_iso); use Digest::MD5 qw(md5_base64); @@ -55,6 +56,8 @@ BEGIN { &getzipnamecity &getidcity + &GetFirstValidEmailAddress + &GetAge &GetCities &GetRoadTypes @@ -132,13 +135,10 @@ This module contains routines for adding, modifying and deleting members/patrons =head1 FUNCTIONS -=over 2 - -=item SearchMember - - ($count, $borrowers) = &SearchMember($searchstring, $type,$category_type,$filter,$showallbranches); +=head2 SearchMember -=back + ($count, $borrowers) = &SearchMember($searchstring, $type, + $category_type, $filter, $showallbranches); Looks up patrons (borrowers) by name. @@ -244,13 +244,10 @@ sub SearchMember { return ( scalar(@$data), $data ); } -=over 2 - -=item Search - - $borrowers_result_array_ref = &Search($filter,$orderby, $limit, $columns_out, $search_on_fields,$searchtype); +=head2 Search -=back + $borrowers_result_array_ref = &Search($filter,$orderby, $limit, + $columns_out, $search_on_fields,$searchtype); Looks up patrons (borrowers) on filter. @@ -377,9 +374,9 @@ sub GetMemberDetails { $flags = &patronflags($patron); - This function is not exported. +This function is not exported. - The following will be set where applicable: +The following will be set where applicable: $flags->{CHARGES}->{amount} Amount of debt $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge) $flags->{CHARGES}->{message} Message -- deprecated @@ -411,17 +408,17 @@ sub GetMemberDetails { $flags->{WAITING}->{message} Message -- deprecated $flags->{WAITING}->{itemlist} ref-to-array: list of available items -=over 4 +=over -C<$flags-E{ODUES}-E{itemlist}> is a reference-to-array listing the +=item C<$flags-E{ODUES}-E{itemlist}> is a reference-to-array listing the overdue items. Its elements are references-to-hash, each describing an overdue item. The keys are selected fields from the issues, biblio, biblioitems, and items tables of the Koha database. -C<$flags-E{ODUES}-E{itemlisttext}> is a string giving a text listing of +=item C<$flags-E{ODUES}-E{itemlisttext}> is a string giving a text listing of the overdue items, one per line. Deprecated. -C<$flags-E{WAITING}-E{itemlist}> is a reference-to-array listing the +=item C<$flags-E{WAITING}-E{itemlist}> is a reference-to-array listing the available items. Each element is a reference-to-hash whose keys are fields from the reserves table of the Koha database. @@ -515,15 +512,19 @@ sub patronflags { $borrower = &GetMember(%information); -Looks up information about a patron (borrower) by either card number -,firstname, or borrower number, depending on $type value. -If C<$type> == 'cardnumber', C<&GetBorrower> -searches by cardnumber then by firstname if not found in cardnumber; -otherwise, it searches by borrowernumber. +Retrieve the first patron record meeting on criteria listed in the +C<%information> hash, which should contain one or more +pairs of borrowers column names and values, e.g., + + $borrower = GetMember(borrowernumber => id); C<&GetBorrower> returns a reference-to-hash whose keys are the fields of the C table in the Koha database. +FIXME: GetMember() is used throughout the code as a lookup +on a unique key such as the borrowernumber, but this meaning is not +enforced in the routine itself. + =cut #' @@ -572,43 +573,40 @@ sub GetMember { =head2 IsMemberBlocked -=over 4 + my ($block_status, $count) = IsMemberBlocked( $borrowernumber ); -my $blocked = IsMemberBlocked( $borrowernumber ); +Returns whether a patron has overdue items that may result +in a block or whether the patron has active fine days +that would block circulation privileges. -return the status, and the number of day or documents, depends his punishment +C<$block_status> can have the following values: -return : --1 if the user have overdue returns -1 if the user is punished X days -0 if the user is authorised to loan +1 if the patron has outstanding fine days, in which case C<$count> is the number of them -=back +-1 if the patron has overdue items, in which case C<$count> is the number of them + +0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0 + +Outstanding fine days are checked before current overdue items +are. + +FIXME: this needs to be split into two functions; a potential block +based on the number of current overdue items could be orthogonal +to a block based on whether the patron has any fine days accrued. =cut sub IsMemberBlocked { my $borrowernumber = shift; my $dbh = C4::Context->dbh; - # if he have late issues - my $sth = $dbh->prepare( - "SELECT COUNT(*) as latedocs - FROM issues - WHERE borrowernumber = ? - AND date_due < now()" - ); - $sth->execute($borrowernumber); - my $latedocs = $sth->fetchrow_hashref->{'latedocs'}; - - return (-1, $latedocs) if $latedocs > 0; + # does patron have current fine days? my $strsth=qq{ SELECT ADDDATE(returndate, finedays * DATEDIFF(returndate,date_due) ) AS blockingdate, DATEDIFF(ADDDATE(returndate, finedays * DATEDIFF(returndate,date_due)),NOW()) AS blockedcount FROM old_issues }; - # or if he must wait to loan if(C4::Context->preference("item-level_itypes")){ $strsth.= qq{ LEFT JOIN items ON (items.itemnumber=old_issues.itemnumber) @@ -625,7 +623,7 @@ sub IsMemberBlocked { AND borrowernumber = ? ORDER BY blockingdate DESC, blockedcount DESC LIMIT 1}; - $sth=$dbh->prepare($strsth); + my $sth=$dbh->prepare($strsth); $sth->execute($borrowernumber); my $row = $sth->fetchrow_hashref; my $blockeddate = $row->{'blockeddate'}; @@ -633,7 +631,19 @@ sub IsMemberBlocked { return (1, $blockedcount) if $blockedcount > 0; - return 0 + # if he have late issues + $sth = $dbh->prepare( + "SELECT COUNT(*) as latedocs + FROM issues + WHERE borrowernumber = ? + AND date_due < curdate()" + ); + $sth->execute($borrowernumber); + my $latedocs = $sth->fetchrow_hashref->{'latedocs'}; + + return (-1, $latedocs) if $latedocs > 0; + + return (0, 0); } =head2 GetMemberIssuesAndFines @@ -664,7 +674,7 @@ sub GetMemberIssuesAndFines { $sth = $dbh->prepare( "SELECT COUNT(*) FROM issues WHERE borrowernumber = ? - AND date_due < now()" + AND date_due < curdate()" ); $sth->execute($borrowernumber); my $overdue_count = $sth->fetchrow_arrayref->[0]; @@ -680,22 +690,18 @@ sub columns(;$) { return @{C4::Context->dbh->selectcol_arrayref("SHOW columns from borrowers")}; } -=head2 - =head2 ModMember -=over 4 - -my $success = ModMember(borrowernumber => $borrowernumber, [ field => value ]... ); + my $success = ModMember(borrowernumber => $borrowernumber, + [ field => value ]... ); Modify borrower's data. All date fields should ALREADY be in ISO format. return : true on success, or false on failure -=back - =cut + sub ModMember { my (%data) = @_; # test to know if you must update or not the borrower password @@ -722,8 +728,6 @@ sub ModMember { } -=head2 - =head2 AddMember $borrowernumber = &AddMember(%borrower); @@ -1011,7 +1015,7 @@ sub GetPendingIssues { =head2 GetAllIssues - ($count, $issues) = &GetAllIssues($borrowernumber, $sortkey, $limit); + $issues = &GetAllIssues($borrowernumber, $sortkey, $limit); Looks up what the patron with the given borrowernumber has borrowed, and sorts the results. @@ -1022,11 +1026,9 @@ C, or C table in the Koha database. C<$limit> is the maximum number of results to return. -C<&GetAllIssues> returns a two-element array. C<$issues> is a -reference-to-array, where each element is a reference-to-hash; the -keys are the fields from the C, C, C, and -C tables of the Koha database. C<$count> is the number of -elements in C<$issues> +C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which +are the fields from the C, C, C, and +C tables of the Koha database. =cut @@ -1036,16 +1038,15 @@ sub GetAllIssues { #FIXME: sanity-check order and limit my $dbh = C4::Context->dbh; - my $count = 0; my $query = - "SELECT *,issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp + "SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp FROM issues LEFT JOIN items on items.itemnumber=issues.itemnumber LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber WHERE borrowernumber=? UNION ALL - SELECT *,old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp + SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp FROM old_issues LEFT JOIN items on items.itemnumber=old_issues.itemnumber LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber @@ -1056,46 +1057,15 @@ sub GetAllIssues { $query .= " limit $limit"; } - #print $query; my $sth = $dbh->prepare($query); $sth->execute($borrowernumber, $borrowernumber); my @result; my $i = 0; while ( my $data = $sth->fetchrow_hashref ) { - $result[$i] = $data; - $i++; - $count++; - } - - # get all issued items for borrowernumber from oldissues table - # large chunk of older issues data put into table oldissues - # to speed up db calls for issuing items - if ( C4::Context->preference("ReadingHistory") ) { - # FIXME oldissues (not to be confused with old_issues) is - # apparently specific to HLT. Not sure if the ReadingHistory - # syspref is still required, as old_issues by design - # is no longer checked with each loan. - my $query2 = "SELECT * FROM oldissues - LEFT JOIN items ON items.itemnumber=oldissues.itemnumber - LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber - LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber - WHERE borrowernumber=? - ORDER BY $order"; - if ( $limit != 0 ) { - $limit = $limit - $count; - $query2 .= " limit $limit"; - } - - my $sth2 = $dbh->prepare($query2); - $sth2->execute($borrowernumber); - - while ( my $data2 = $sth2->fetchrow_hashref ) { - $result[$i] = $data2; - $i++; - } + push @result, $data; } - return ( $i, \@result ); + return \@result; } @@ -1279,6 +1249,33 @@ sub getidcity { return $data; } +=head2 GetFirstValidEmailAddress + + $email = GetFirstValidEmailAddress($borrowernumber); + +Return the first valid email address for a borrower, given the borrowernumber. For now, the order +is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email +addresses. + +=cut + +sub GetFirstValidEmailAddress { + my $borrowernumber = shift; + my $dbh = C4::Context->dbh; + my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? "); + $sth->execute( $borrowernumber ); + my $data = $sth->fetchrow_hashref; + + if ($data->{'email'}) { + return $data->{'email'}; + } elsif ($data->{'emailpro'}) { + return $data->{'emailpro'}; + } elsif ($data->{'B_email'}) { + return $data->{'B_email'}; + } else { + return ''; + } +} =head2 GetExpiryDate @@ -1373,8 +1370,9 @@ sub GetborCatFromCatType { Given the borrower's category code, the function returns the corresponding data hashref for a comprehensive information display. - + $arrayref_hashref = &GetBorrowercategory; + If no category code provided, the function returns all the categories. =cut @@ -1398,7 +1396,7 @@ sub GetBorrowercategory { } # sub getborrowercategory =head2 GetBorrowercategoryList - + $arrayref_hashref = &GetBorrowercategoryList; If no category code provided, the function returns all the categories. @@ -1494,6 +1492,7 @@ sub GetAge{ } # sub get_age =head2 get_institutions + $insitutions = get_institutions(); Just returns a list of all the borrowers of type I, borrownumber and name @@ -1537,48 +1536,31 @@ sub add_member_orgs { } # sub add_member_orgs -=head2 GetCities (OUEST-PROVENCE) +=head2 GetCities - ($id_cityarrayref, $city_hashref) = &GetCities(); + $cityarrayref = GetCities(); -Looks up the different city and zip in the database. Returns two -elements: a reference-to-array, which lists the zip city -codes, and a reference-to-hash, which maps the name of the city. -WHERE =>OUEST PROVENCE OR EXTERIEUR + Returns an array_ref of the entries in the cities table + If there are entries in the table an empty row is returned + This is currently only used to populate a popup in memberentry =cut sub GetCities { - #my ($type_city) = @_; my $dbh = C4::Context->dbh; - my $query = qq|SELECT cityid,city_zipcode,city_name - FROM cities - ORDER BY city_name|; - my $sth = $dbh->prepare($query); - - #$sth->execute($type_city); - $sth->execute(); - my %city; - my @id; - # insert empty value to create a empty choice in cgi popup - push @id, " "; - $city{""} = ""; - while ( my $data = $sth->fetchrow_hashref ) { - push @id, $data->{'city_zipcode'}."|".$data->{'city_name'}; - $city{ $data->{'city_zipcode'}."|".$data->{'city_name'} } = $data->{'city_name'}; - } - -#test to know if the table contain some records if no the function return nothing - my $id = @id; - if ( $id == 1 ) { - # all we have is the one blank row - return (); - } - else { - unshift( @id, "" ); - return ( \@id, \%city ); - } + my $city_arr = $dbh->selectall_arrayref( + q|SELECT cityid,city_zipcode,city_name FROM cities ORDER BY city_name|, + { Slice => {} }); + if ( @{$city_arr} ) { + unshift @{$city_arr}, { + city_zipcode => q{}, + city_name => q{}, + cityid => q{}, + }; + } + + return $city_arr; } =head2 GetSortDetails (OUEST-PROVENCE) @@ -1636,7 +1618,7 @@ sub MoveMemberToDeleted { =head2 DelMember -DelMember($borrowernumber); + DelMember($borrowernumber); This function remove directly a borrower whitout writing it on deleteborrower. + Deletes reserves for the borrower @@ -1846,10 +1828,10 @@ WHERE roadtypeid=?|; =head2 GetBorrowersWhoHaveNotBorrowedSince -&GetBorrowersWhoHaveNotBorrowedSince($date) + &GetBorrowersWhoHaveNotBorrowedSince($date) this function get all borrowers who haven't borrowed since the date given on input arg. - + =cut sub GetBorrowersWhoHaveNotBorrowedSince { @@ -1907,9 +1889,9 @@ sub GetBorrowersWhoHaveNotBorrowedSince { =head2 GetBorrowersWhoHaveNeverBorrowed -$results = &GetBorrowersWhoHaveNeverBorrowed + $results = &GetBorrowersWhoHaveNeverBorrowed -this function get all borrowers who have never borrowed. +This function get all borrowers who have never borrowed. I<$result> is a ref to an array which all elements are a hasref. @@ -1954,7 +1936,7 @@ sub GetBorrowersWhoHaveNeverBorrowed { =head2 GetBorrowersWithIssuesHistoryOlderThan -$results = &GetBorrowersWithIssuesHistoryOlderThan($date) + $results = &GetBorrowersWithIssuesHistoryOlderThan($date) this function get all borrowers who has an issue history older than I<$date> given on input arg. @@ -1999,7 +1981,7 @@ sub GetBorrowersWithIssuesHistoryOlderThan { =head2 GetBorrowersNamesAndLatestIssue -$results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers) + $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers) this function get borrowers Names and surnames and Issue information. @@ -2025,9 +2007,7 @@ sub GetBorrowersNamesAndLatestIssue { =head2 DebarMember -=over 4 - -my $success = DebarMember( $borrowernumber ); + my $success = DebarMember( $borrowernumber ); marks a Member as debarred, and therefore unable to checkout any more items. @@ -2035,8 +2015,6 @@ items. return : true on success, false on failure -=back - =cut sub DebarMember { @@ -2052,9 +2030,7 @@ sub DebarMember { =head2 AddMessage -=over 4 - -AddMessage( $borrowernumber, $message_type, $message, $branchcode ); + AddMessage( $borrowernumber, $message_type, $message, $branchcode ); Adds a message to the messages table for the given borrower. @@ -2062,8 +2038,6 @@ Returns: True on success False on failure -=back - =cut sub AddMessage { @@ -2084,17 +2058,13 @@ sub AddMessage { =head2 GetMessages -=over 4 - -GetMessages( $borrowernumber, $type ); + GetMessages( $borrowernumber, $type ); $type is message type, B for borrower, or L for Librarian. Empty type returns all messages of any type. Returns all messages for the given borrowernumber -=back - =cut sub GetMessages { @@ -2129,17 +2099,13 @@ sub GetMessages { =head2 GetMessages -=over 4 - -GetMessagesCount( $borrowernumber, $type ); + GetMessagesCount( $borrowernumber, $type ); $type is message type, B for borrower, or L for Librarian. Empty type returns all messages of any type. Returns the number of messages for the given borrowernumber -=back - =cut sub GetMessagesCount { @@ -2166,11 +2132,7 @@ sub GetMessagesCount { =head2 DeleteMessage -=over 4 - -DeleteMessage( $message_id ); - -=back + DeleteMessage( $message_id ); =cut