Bug 2346: Remove C4::Overdues::UpdateBorrowerDebarred in favour of C4::Members::Debar...
[koha.git] / C4 / Overdues.pm
index 04520b2..4897b41 100644 (file)
@@ -2,6 +2,7 @@ package C4::Overdues;
 
 
 # Copyright 2000-2002 Katipo Communications
+# copyright 2010 BibLibre
 #
 # This file is part of Koha.
 #
@@ -14,11 +15,12 @@ package C4::Overdues;
 # 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 Date::Calc qw/Today Date_to_Days/;
 use Date::Manip qw/UnixDate/;
 use C4::Circulation;
@@ -77,7 +79,6 @@ BEGIN {
        # subs to move to Members.pm
        push @EXPORT, qw(
         &CheckBorrowerDebarred
-        &UpdateBorrowerDebarred
        );
        # subs to move to Biblio.pm
        push @EXPORT, qw(
@@ -155,7 +156,7 @@ LEFT JOIN biblioitems USING (biblioitemnumber)
 
 =head2 checkoverdues
 
-($count, $overdueitems) = checkoverdues($borrowernumber);
+    ($count, $overdueitems) = checkoverdues($borrowernumber);
 
 Returns a count and a list of overdueitems for a given borrowernumber
 
@@ -163,8 +164,37 @@ Returns a count and a list of overdueitems for a given borrowernumber
 
 sub checkoverdues {
     my $borrowernumber = shift or return;
+    # don't select biblioitems.marc or biblioitems.marcxml... too slow on large systems
     my $sth = C4::Context->dbh->prepare(
-        "SELECT * FROM issues
+        "SELECT biblio.*, items.*, issues.*,
+                biblioitems.volume,
+                biblioitems.number,
+                biblioitems.itemtype,
+                biblioitems.isbn,
+                biblioitems.issn,
+                biblioitems.publicationyear,
+                biblioitems.publishercode,
+                biblioitems.volumedate,
+                biblioitems.volumedesc,
+                biblioitems.collectiontitle,
+                biblioitems.collectionissn,
+                biblioitems.collectionvolume,
+                biblioitems.editionstatement,
+                biblioitems.editionresponsibility,
+                biblioitems.illus,
+                biblioitems.pages,
+                biblioitems.notes,
+                biblioitems.size,
+                biblioitems.place,
+                biblioitems.lccn,
+                biblioitems.url,
+                biblioitems.cn_source,
+                biblioitems.cn_class,
+                biblioitems.cn_item,
+                biblioitems.cn_suffix,
+                biblioitems.cn_sort,
+                biblioitems.totalissues
+         FROM issues
          LEFT JOIN items       ON issues.itemnumber      = items.itemnumber
          LEFT JOIN biblio      ON items.biblionumber     = biblio.biblionumber
          LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
@@ -179,8 +209,9 @@ sub checkoverdues {
 
 =head2 CalcFine
 
-  ($amount, $chargename, $daycount, $daycounttotal) =
-    &CalcFine($item, $categorycode, $branch, $days_overdue, $description, $start_date, $end_date );
+    ($amount, $chargename, $daycount, $daycounttotal) = &CalcFine($item, 
+                                  $categorycode, $branch, $days_overdue, 
+                                  $description, $start_date, $end_date );
 
 Calculates the fine for a book.
 
@@ -276,7 +307,7 @@ sub CalcFine {
 
 =head2 GetSpecialHolidays
 
-&GetSpecialHolidays($date_dues,$itemnumber);
+    &GetSpecialHolidays($date_dues,$itemnumber);
 
 return number of special days  between date of the day and date due
 
@@ -334,7 +365,7 @@ AND branchcode=?
 
 =head2 GetRepeatableHolidays
 
-&GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
+    &GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
 
 return number of day closed between date of the day and date due
 
@@ -372,7 +403,7 @@ sub GetRepeatableHolidays {
 
 =head2 GetWayFromItemnumber
 
-&Getwdayfromitemnumber($itemnumber);
+    &Getwdayfromitemnumber($itemnumber);
 
 return the different week day from repeatable_holidays table
 
@@ -400,7 +431,7 @@ sub GetWdayFromItemnumber {
 
 =head2 GetIssuesIteminfo
 
-&GetIssuesIteminfo($itemnumber);
+    &GetIssuesIteminfo($itemnumber);
 
 return all data from issues about item
 
@@ -424,7 +455,7 @@ sub GetIssuesIteminfo {
 
 =head2 UpdateFine
 
-  &UpdateFine($itemnumber, $borrowernumber, $amount, $type, $description);
+    &UpdateFine($itemnumber, $borrowernumber, $amount, $type, $description);
 
 (Note: the following is mostly conjecture and guesswork.)
 
@@ -486,12 +517,12 @@ sub UpdateFine {
 
     if ( my $data = $sth->fetchrow_hashref ) {
 
-               # we're updating an existing fine.  Only modify if we're adding to the charge.
+               # we're updating an existing fine.  Only modify if amount changed
         # Note that in the current implementation, you cannot pay against an accruing fine
         # (i.e. , of accounttype 'FU').  Doing so will break accrual.
        if ( $data->{'amount'} != $amount ) {
             my $diff = $amount - $data->{'amount'};
-            $diff = 0 if ( $data->{amount} > $amount);
+           #3341: diff could be positive or negative!
             my $out  = $data->{'amountoutstanding'} + $diff;
             my $query = "
                 UPDATE accountlines
@@ -551,7 +582,7 @@ sub UpdateFine {
 
 =head2 BorType
 
-  $borrower = &BorType($borrowernumber);
+    $borrower = &BorType($borrowernumber);
 
 Looks up a patron by borrower number.
 
@@ -577,7 +608,7 @@ sub BorType {
 
 =head2 ReplacementCost
 
-  $cost = &ReplacementCost($itemnumber);
+    $cost = &ReplacementCost($itemnumber);
 
 Returns the replacement cost of the item with the given item number.
 
@@ -598,7 +629,7 @@ sub ReplacementCost {
 
 =head2 GetFine
 
-$data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
+    $data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
 
 return the total of fine
 
@@ -627,7 +658,7 @@ sub GetFine {
 FIXME - This sub should be deprecated and removed.
 It ignores branch and defaults.
 
-$data = &GetIssuingRules($itemtype,$categorycode);
+    $data = &GetIssuingRules($itemtype,$categorycode);
 
 Looks up for all issuingrules an item info 
 
@@ -674,7 +705,7 @@ sub ReplacementCost2 {
 
 =head2 GetNextIdNotify
 
-($result) = &GetNextIdNotify($reference);
+    ($result) = &GetNextIdNotify($reference);
 
 Returns the new file number
 
@@ -713,7 +744,7 @@ sub GetNextIdNotify {
 
 =head2 NumberNotifyId
 
-(@notify) = &NumberNotifyId($borrowernumber);
+    (@notify) = &NumberNotifyId($borrowernumber);
 
 Returns amount for all file per borrowers
 C<@notify> array contains all file per borrowers
@@ -739,7 +770,7 @@ sub NumberNotifyId{
 
 =head2 AmountNotify
 
-($totalnotify) = &AmountNotify($notifyid);
+    ($totalnotify) = &AmountNotify($notifyid);
 
 Returns amount for all file per borrowers
 C<$notifyid> is the file number
@@ -766,7 +797,7 @@ sub AmountNotify{
 
 =head2 GetNotifyId
 
-($notify_id) = &GetNotifyId($borrowernumber,$itemnumber);
+    ($notify_id) = &GetNotifyId($borrowernumber,$itemnumber);
 
 Returns the file number per borrower and itemnumber
 
@@ -796,7 +827,9 @@ sub GetNotifyId {
 
 =head2 CreateItemAccountLine
 
-() = &CreateItemAccountLine($borrowernumber,$itemnumber,$date,$amount,$description,$accounttype,$amountoutstanding,$timestamp,$notify_id,$level);
+    () = &CreateItemAccountLine($borrowernumber, $itemnumber, $date, $amount,
+                               $description, $accounttype, $amountoutstanding, 
+                               $timestamp, $notify_id, $level);
 
 update the account lines with file number or with file level
 
@@ -849,7 +882,7 @@ sub CreateItemAccountLine {
 
 =head2 UpdateAccountLines
 
-() = &UpdateAccountLines($notify_id,$notify_level,$borrowernumber,$itemnumber);
+    () = &UpdateAccountLines($notify_id,$notify_level,$borrowernumber,$itemnumber);
 
 update the account lines with file number or with file level
 
@@ -892,7 +925,7 @@ sub UpdateAccountLines {
 
 =head2 GetItems
 
-($items) = &GetItems($itemnumber);
+    ($items) = &GetItems($itemnumber);
 
 Returns the list of all delays from overduerules.
 
@@ -921,7 +954,7 @@ sub GetItems {
 
 =head2 GetOverdueDelays
 
-(@delays) = &GetOverdueDelays($categorycode);
+    (@delays) = &GetOverdueDelays($categorycode);
 
 Returns the list of all delays from overduerules.
 
@@ -944,27 +977,27 @@ sub GetOverdueDelays {
 
 =head2 GetBranchcodesWithOverdueRules
 
-=over 4
-
-my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
+    my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
 
 returns a list of branch codes for branches with overdue rules defined.
 
-=back
-
 =cut
 
 sub GetBranchcodesWithOverdueRules {
     my $dbh               = C4::Context->dbh;
-    my $rqoverduebranches = $dbh->prepare("SELECT DISTINCT branchcode FROM overduerules WHERE delay1 IS NOT NULL AND branchcode <> ''");
+    my $rqoverduebranches = $dbh->prepare("SELECT DISTINCT branchcode FROM overduerules WHERE delay1 IS NOT NULL AND branchcode <> '' ORDER BY branchcode");
     $rqoverduebranches->execute;
     my @branches = map { shift @$_ } @{ $rqoverduebranches->fetchall_arrayref };
+    if (!$branches[0]) {
+       my $availbranches = C4::Branch::GetBranches();
+       @branches = keys %$availbranches;
+    }
     return @branches;
 }
 
 =head2 CheckAccountLineLevelInfo
 
-($exist) = &CheckAccountLineLevelInfo($borrowernumber,$itemnumber,$accounttype,notify_level);
+    ($exist) = &CheckAccountLineLevelInfo($borrowernumber,$itemnumber,$accounttype,notify_level);
 
 Check and Returns the list of all overdue books.
 
@@ -998,7 +1031,7 @@ sub CheckAccountLineLevelInfo {
 
 =head2 GetOverduerules
 
-($overduerules) = &GetOverduerules($categorycode);
+    ($overduerules) = &GetOverduerules($categorycode);
 
 Returns the value of borrowers (debarred or not) with notify level
 
@@ -1025,7 +1058,7 @@ sub GetOverduerules {
 
 =head2 CheckBorrowerDebarred
 
-($debarredstatus) = &CheckBorrowerDebarred($borrowernumber);
+    ($debarredstatus) = &CheckBorrowerDebarred($borrowernumber);
 
 Check if the borrowers is already debarred
 
@@ -1043,39 +1076,18 @@ sub CheckBorrowerDebarred {
         SELECT debarred
         FROM borrowers
         WHERE borrowernumber=?
+        AND debarred > NOW()
     |;
     my $sth = $dbh->prepare($query);
     $sth->execute($borrowernumber);
-    my ($debarredstatus) = $sth->fetchrow;
-    return ( $debarredstatus eq '1' ? 1 : 0 );
+    my $debarredstatus = $sth->fetchrow;
+    return $debarredstatus;
 }
 
-=head2 UpdateBorrowerDebarred
-
-($borrowerstatut) = &UpdateBorrowerDebarred($borrowernumber);
-
-update status of borrowers in borrowers table (field debarred)
-
-C<$borrowernumber> borrower number
-
-=cut
-
-sub UpdateBorrowerDebarred{
-    my($borrowernumber) = @_;
-    my $dbh = C4::Context->dbh;
-        my $query=qq|UPDATE borrowers
-             SET debarred='1'
-                     WHERE borrowernumber=?
-            |;
-    my $sth=$dbh->prepare($query);
-        $sth->execute($borrowernumber);
-        $sth->finish;
-        return 1;
-}
 
 =head2 CheckExistantNotifyid
 
-  ($exist) = &CheckExistantNotifyid($borrowernumber,$itemnumber,$accounttype,$notify_id);
+    ($exist) = &CheckExistantNotifyid($borrowernumber,$itemnumber,$accounttype,$notify_id);
 
 Check and Returns the notify id if exist else return 0.
 
@@ -1102,7 +1114,7 @@ sub CheckExistantNotifyid {
 
 =head2 CheckAccountLineItemInfo
 
-  ($exist) = &CheckAccountLineItemInfo($borrowernumber,$itemnumber,$accounttype,$notify_id);
+    ($exist) = &CheckAccountLineItemInfo($borrowernumber,$itemnumber,$accounttype,$notify_id);
 
 Check and Returns the list of all overdue items from the same file number(notify_id).
 
@@ -1176,12 +1188,14 @@ sub GetOverduesForBranch {
             borrowers.phone,
             borrowers.email,
                biblio.title,
+               biblio.author,
                biblio.biblionumber,
                issues.date_due,
                issues.returndate,
                issues.branchcode,
              branches.branchname,
                 items.barcode,
+                items.homebranch,
                 items.itemcallnumber,
                 items.location,
                 items.itemnumber,
@@ -1227,9 +1241,9 @@ sub GetOverduesForBranch {
 
 =head2 AddNotifyLine
 
-&AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
+    &AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
 
-Creat a line into notify, if the method is phone, the notification_send_date is implemented to
+Create a line into notify, if the method is phone, the notification_send_date is implemented to
 
 =cut
 
@@ -1257,7 +1271,7 @@ sub AddNotifyLine {
 
 =head2 RemoveNotifyLine
 
-&RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
+    &RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
 
 Cancel a notification
 
@@ -1282,6 +1296,6 @@ __END__
 
 =head1 AUTHOR
 
-Koha Developement team <info@koha.org>
+Koha Development Team <http://koha-community.org/>
 
 =cut