Adding MARC preview to acqui screens
[koha_fer] / C4 / Stats.pm
index 921b049..6c2be74 100644 (file)
-package C4::Stats; #assumes C4/Stats
+package C4::Stats;
+
+
+# Copyright 2000-2002 Katipo Communications
+#
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# 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
 
 use strict;
 require Exporter;
-use DBI;
-use C4::Database;
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+use C4::Context;
+use vars qw($VERSION @ISA @EXPORT);
 
 # set the version for version checking
-$VERSION = 0.01;
+$VERSION = 3.00;
 
-@ISA = qw(Exporter);
-@EXPORT = qw(&UpdateStats &statsreport &Count &Overdues &TotalOwing
-&TotalPaid &getcharges &Getpaidbranch &unfilledreserves);
+=head1 NAME
 
-sub UpdateStats {
-  #module to insert stats data into stats table
-  my ($env,$branch,$type,$amount,$other,$itemnum,$itemtype,$borrowernumber)=@_;
-  my $dbh=C4Connect();
-  if ($branch eq ''){
-    $branch=$env->{'branchcode'};
-  }
-  my $user = $env->{'usercode'};
-  print $borrowernumber;
-  my $sth=$dbh->prepare("Insert into statistics
-  (datetime,branch,type,usercode,value,
-  other,itemnumber,itemtype,borrowernumber) 
-  values (now(),'$branch','$type','$user','$amount',
-  '$other','$itemnum','$itemtype','$borrowernumber')");
-  $sth->execute;
-  $sth->finish;
-  $dbh->disconnect;
-}
+C4::Stats - Update Koha statistics (log)
 
-sub statsreport {
-  #module to return a list of stats for a given day,time,branch type
-  #or to return search stats
-  my ($type,$time)=@_;
-  my @data;
-#  print "here";
-#  if ($type eq 'issue'){
-    @data=circrep($time,$type);
-#  }
-  return(@data);
-}
+=head1 SYNOPSIS
 
-sub circrep {
-  my ($time,$type)=@_;
-  my $dbh=C4Connect;
-  my $query="Select * from statistics";
-  if ($time eq 'today'){
-    $query=$query." where type='$type' and datetime
-    >=datetime('yesterday'::date)";
-  }
-  my $sth=$dbh->prepare($query);
-  $sth->execute;
-  my $i=0;
-  my @results;
-  while (my $data=$sth->fetchrow_hashref){
-    $results[$i]="$data->{'datetime'}\t$data->{'branch'}";
-    $i++;
-  }
-  $sth->finish;
-#  print $query;
-  $dbh->disconnect;
-  return(@results);
+  use C4::Stats;
 
-}
+=head1 DESCRIPTION
 
-sub Count {
-  my ($type,$branch,$time,$time2)=@_;
-  my $dbh=C4Connect;
-  my $query="Select count(*) from statistics where type='$type'";
-  $query.=" and datetime >= '$time' and datetime< '$time2' and branch='$branch'";
-  my $sth=$dbh->prepare($query);
-  $sth->execute;
-  my $data=$sth->fetchrow_hashref;
-  $sth->finish;
-#  print $query;
-  $dbh->disconnect;
-  return($data->{'count(*)'});
-}
+The C<&UpdateStats> function adds an entry to the statistics table in
+the Koha database, which acts as an activity log.
 
-sub Overdues{
-  my $dbh=C4Connect;
-  my $query="Select count(*) from issues where date_due >= now()";
-  my $sth=$dbh->prepare($query);
-  $sth->execute;
-  my $count=$sth->fetchrow_hashref;
-  $sth->finish;
-  $dbh->disconnect;
-  return($count->{'count(*)'});  
-}
+=head1 FUNCTIONS
+
+=over 2
+
+=cut
+
+@ISA    = qw(Exporter);
+@EXPORT = qw(
+    &UpdateStats
+    &TotalPaid
+);
+
+=item UpdateStats
 
-sub TotalOwing{
-  my ($type)=@_;
-  my $dbh=C4Connect;
-  my $query="Select sum(amountoutstanding) from accountlines";
-  if ($type eq 'fine'){
-    $query=$query." where accounttype='F' or accounttype='FN'";
-  }
-  my $sth=$dbh->prepare($query);
-#  print $query;
-  $sth->execute;
-   my $total=$sth->fetchrow_hashref;
-   $sth->finish;
-  $dbh->disconnect; 
-  return($total->{'sum(amountoutstanding)'});
+  &UpdateStats($branch, $type, $value, $other, $itemnumber,
+               $itemtype, $borrowernumber);
+
+Adds a line to the statistics table of the Koha database. In effect,
+it logs an event.
+
+C<$branch>, C<$type>, C<$value>, C<$other>, C<$itemnumber>,
+C<$itemtype>, and C<$borrowernumber> correspond to the fields of the
+statistics table in the Koha database.
+
+=cut
+
+#'
+sub UpdateStats {
+
+    #module to insert stats data into stats table
+    my (
+        $branch,         $type,
+        $amount,   $other,          $itemnum,
+        $itemtype, $borrowernumber
+      )
+      = @_;
+    my $dbh = C4::Context->dbh;
+    # FIXME - Use $dbh->do() instead
+    my $sth = $dbh->prepare(
+        "Insert into statistics (datetime,branch,type,value,
+                                        other,itemnumber,itemtype,borrowernumber) values (now(),?,?,?,?,?,?,?)"
+    );
+    $sth->execute(
+        $branch,    $type,    $amount,
+        $other,     $itemnum, $itemtype, $borrowernumber,
+    );
+    $sth->finish;
 }
 
+# Otherwise, it'd need a POD.
 sub TotalPaid {
-  my ($time)=@_;
-  my $dbh=C4Connect;
-  my $query="Select * from accountlines,borrowers where (accounttype = 'Pay'
-or accounttype ='W')
-  and accountlines.borrowernumber = borrowers.borrowernumber";
-  if ($time eq 'today'){
-    $query=$query." and date = now()";
-  } else {
-    $query.=" and date='$time'";
-  }
-#  my $query="Select * from statistics,borrowers
-#  where statistics.borrowernumber= borrowers.borrowernumber
-#  and (statistics.type='payment' or statistics.type='writeoff') ";
-#  if ($time eq 'today'){
-#    $query=$query." and datetime = now()";
-#  } else {
-#    $query.=" and datetime > '$time'";
-#  }
-  $query.=" order by timestamp";
-#  print $query;
-  my $sth=$dbh->prepare($query);
-  $sth->execute;
-  my @results;
-  my $i=0;
-  while (my $data=$sth->fetchrow_hashref){
-    $results[$i]=$data;
-    $i++;
-  }
-   $sth->finish;
-  $dbh->disconnect; 
-#  print $query;
-  return(@results);
+    my ( $time, $time2, $spreadsheet ) = @_;
+    $time2 = $time unless $time2;
+    my $dbh   = C4::Context->dbh;
+    my $query = "SELECT * FROM statistics 
+  LEFT JOIN borrowers ON statistics.borrowernumber= borrowers.borrowernumber
+  WHERE (statistics.type='payment' OR statistics.type='writeoff') ";
+    if ( $time eq 'today' ) {
+        $query = $query . " AND datetime = now()";
+    }
+    else {
+        $query .= " AND datetime > '$time'";
+    }
+    if ( $time2 ne '' ) {
+        $query .= " AND datetime < '$time2'";
+    }
+    if ($spreadsheet) {
+        $query .= " ORDER BY branch, type";
+    }
+    my $sth = $dbh->prepare($query);
+    $sth->execute();
+    my @results;
+    while ( my $data = $sth->fetchrow_hashref ) {
+        push @results, $data;
+    }
+    $sth->finish;
+    return (@results);
 }
 
-sub getcharges{
-  my($borrowerno,$timestamp)=@_;
-  my $dbh=C4Connect;
-  my $timestamp2=$timestamp-1;
-  my $query="Select * from accountlines where borrowernumber=$borrowerno
-  and timestamp = '$timestamp' and accounttype <> 'Pay' and
-  accounttype <> 'W'";
-  my $sth=$dbh->prepare($query);
-#  print $query,"<br>";
-  $sth->execute;
-  my $i=0;
-  my @results;
-  while (my $data=$sth->fetchrow_hashref){
-#    if ($data->{'timestamp'} == $timestamp){
-      $results[$i]=$data;
-      $i++;
-#    }
-  }
-  $dbh->disconnect;
-  return(@results);
-}
+1;
+__END__
 
-sub Getpaidbranch{
-  my($date,$borrno)=@_;
-  my $dbh=C4Connect;
-  my $query="select * from statistics where type='payment' and datetime
-  >'$date' and  borrowernumber='$borrno'";
-  my $sth=$dbh->prepare($query);
-  $sth->execute;
-#  print $query;
-  my $data=$sth->fetchrow_hashref;
-  $sth->finish;
-  $dbh->disconnect;
-  return($data->{'branch'});
-}
+=back
 
-sub unfilledreserves {
-  my $dbh=C4Connect;
-  my $query="select *,biblio.title from reserves,reserveconstraints,biblio,borrowers,biblioitems where found <> 'F' and cancellationdate
-is NULL and biblio.biblionumber=reserves.biblionumber and
-reserves.constrainttype='o'
-and (reserves.biblionumber=reserveconstraints.biblionumber
-and reserves.borrowernumber=reserveconstraints.borrowernumber)
-and
-reserves.borrowernumber=borrowers.borrowernumber and
-biblioitems.biblioitemnumber=reserveconstraints.biblioitemnumber order by
-biblio.title,reserves.reservedate";
-  my $sth=$dbh->prepare($query);
-  $sth->execute;
-  my $i=0;
-  my @results;
-  while (my $data=$sth->fetchrow_hashref){
-    $results[$i]=$data;
-    $i++;
-  }
-  $sth->finish;
-  $query="select *,biblio.title from reserves,biblio,borrowers where found <> 'F' and cancellationdate
-is NULL and biblio.biblionumber=reserves.biblionumber and reserves.constrainttype='a' and
-reserves.borrowernumber=borrowers.borrowernumber
-order by
-biblio.title,reserves.reservedate";
-  $sth=$dbh->prepare($query);
-  $sth->execute;
-  while (my $data=$sth->fetchrow_hashref){
-    $results[$i]=$data;
-    $i++;
-  }
-  $sth->finish;
-  $dbh->disconnect;
-  return($i,\@results);
-}
+=head1 AUTHOR
+
+Koha Developement team <info@koha.org>
+
+=cut
 
-END { }       # module clean-up code here (global destructor)
-  
-