Bug 9044: (follow-up) fix merge conflict typo that broke this script
[koha.git] / C4 / Log.pm
index c6ee750..671fcdb 100644 (file)
--- a/C4/Log.pm
+++ b/C4/Log.pm
@@ -1,9 +1,10 @@
-package C4::Log; #assumes C4/Log
+package C4::Log;
 
 #package to deal with Logging Actions in DB
 
 
 # Copyright 2000-2002 Katipo Communications
+# Copyright 2011 MJ Ray and software.coop
 #
 # This file is part of Koha.
 #
@@ -16,20 +17,25 @@ package C4::Log; #assumes C4/Log
 # 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;
+
 use C4::Context;
 use C4::Dates qw(format_date);
 
-require Exporter;
-
 use vars qw($VERSION @ISA @EXPORT);
 
-# set the version for version checking
-$VERSION = 3.01;
+BEGIN {
+       # set the version for version checking
+    $VERSION = 3.07.00.049;
+       require Exporter;
+       @ISA = qw(Exporter);
+       @EXPORT = qw(&logaction &GetLogStatus &displaylog &GetLogs);
+}
 
 =head1 NAME
 
@@ -47,23 +53,28 @@ The functions in this module perform various functions in order to log all the o
 
 =over 2
 
-=cut
-
-@ISA = qw(Exporter);
-@EXPORT = qw(&logaction &GetLogStatus &displaylog &GetLogs);
-
 =item logaction
 
-  &logaction($usernumber, $modulename, $actionname, $objectnumber, $infos);
+  &logaction($modulename, $actionname, $objectnumber, $infos);
 
-Adds a record into action_logs table to report the different changes upon the database
+Adds a record into action_logs table to report the different changes upon the database.
+Each log entry includes the number of the user currently logged in.  For batch
+jobs, which operate without authenticating a user and setting up a session, the user
+number is set to 0, which is the same as the superlibrarian's number.
 
 =cut
 
 #'
 sub logaction {
-  my ($usernumber,$modulename, $actionname, $objectnumber, $infos)=@_;
-    $usernumber='' unless $usernumber;
+    my ($modulename, $actionname, $objectnumber, $infos)=@_;
+
+    # Get ID of logged in user.  if called from a batch job,
+    # no user session exists and C4::Context->userenv() returns
+    # the scalar '0'.
+    my $userenv = C4::Context->userenv();
+    my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : 0;
+    $usernumber ||= 0;
+
     my $dbh = C4::Context->dbh;
     my $sth=$dbh->prepare("Insert into action_logs (timestamp,user,module,action,object,info) values (now(),?,?,?,?,?)");
     $sth->execute($usernumber,$modulename,$actionname,$objectnumber,$infos);
@@ -173,9 +184,9 @@ sub displaylog {
     return ($count, \@results);
 }
 
-=head2 GetLogs
+=item GetLogs
 
-$logs = GetLogs($datefrom,$dateto,$user,$module,$action,$object,$info);
+$logs = GetLogs($datefrom,$dateto,$user,\@modules,$action,$object,$info);
 
 Return: 
 C<$logs> is a ref to a hash which containts all columns from action_logs
@@ -186,27 +197,47 @@ sub GetLogs {
     my $datefrom = shift;
     my $dateto   = shift;
     my $user     = shift;
-    my $module   = shift;
+    my $modules   = shift;
     my $action   = shift;
     my $object   = shift;
     my $info     = shift;
-    
+   
+    my $iso_datefrom = C4::Dates->new($datefrom,C4::Context->preference("dateformat"))->output('iso');
+    my $iso_dateto = C4::Dates->new($dateto,C4::Context->preference("dateformat"))->output('iso');
+
     my $dbh = C4::Context->dbh;
     my $query = "
         SELECT *
         FROM   action_logs
         WHERE 1
     ";
-    $query .= " AND DATE_FORMAT(timestamp, '%Y-%m-%d') >= \"".$datefrom."\" " if $datefrom;
-    $query .= " AND DATE_FORMAT(timestamp, '%Y-%m-%d') <= \"".$dateto."\" " if $dateto;
-    $query .= " AND user LIKE \"%".$user."%\" "     if $user;
-    $query .= " AND module LIKE \"%".$module."%\" " if $module;
-    $query .= " AND action LIKE \"%".$action."%\" " if $action;
-    $query .= " AND object LIKE \"%".$object."%\" " if $object;
-    $query .= " AND info LIKE \"%".$info."%\" "     if $info;
-    
+
+    my @parameters;
+    $query .= " AND DATE_FORMAT(timestamp, '%Y-%m-%d') >= \"".$iso_datefrom."\" " if $iso_datefrom;   #fix me - mysql specific
+    $query .= " AND DATE_FORMAT(timestamp, '%Y-%m-%d') <= \"".$iso_dateto."\" " if $iso_dateto;
+    if($user ne "") {
+       $query .= " AND user = ? ";
+       push(@parameters,$user);
+    }
+    if($modules && scalar(@$modules)) {
+       $query .= " AND module IN (".join(",",map {"?"} @$modules).") ";
+       push(@parameters,@$modules);
+    }
+    if($action && scalar(@$action)) {
+       $query .= " AND action IN (".join(",",map {"?"} @$action).") ";
+       push(@parameters,@$action);
+    }
+    if($object) {
+       $query .= " AND object = ? ";
+       push(@parameters,$object);
+    }
+    if($info) {
+       $query .= " AND info LIKE ? ";
+       push(@parameters,"%".$info."%");
+    }
+   
     my $sth = $dbh->prepare($query);
-    $sth->execute;
+    $sth->execute(@parameters);
     
     my @logs;
     while( my $row = $sth->fetchrow_hashref ) {
@@ -216,8 +247,6 @@ sub GetLogs {
     return \@logs;
 }
 
-END { }       # module clean-up code here (global destructor)
-
 1;
 __END__
 
@@ -225,6 +254,6 @@ __END__
 
 =head1 AUTHOR
 
-Koha Developement team <info@koha.org>
+Koha Development Team <http://koha-community.org/>
 
 =cut