Bug 10676: Fix behaviour of OpacHiddenItems for items.restricted
[koha.git] / C4 / Log.pm
index 6b8ff17..3a1e93e 100644 (file)
--- a/C4/Log.pm
+++ b/C4/Log.pm
@@ -8,33 +8,34 @@ package C4::Log;
 #
 # 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 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 3 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.
+# 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.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use strict;
 use warnings;
 
+use JSON qw( to_json );
+
 use C4::Context;
-use C4::Dates qw(format_date);
+use Koha::DateUtils;
+use Koha::Logger;
 
-use vars qw($VERSION @ISA @EXPORT);
+use vars qw(@ISA @EXPORT);
 
 BEGIN {
-       # set the version for version checking
-       $VERSION = 3.01;
-       require Exporter;
-       @ISA = qw(Exporter);
-       @EXPORT = qw(&logaction &GetLogStatus &displaylog &GetLogs);
+        require Exporter;
+        @ISA = qw(Exporter);
+        @EXPORT = qw(&logaction &cronlogaction &GetLogs);
 }
 
 =head1 NAME
@@ -66,129 +67,65 @@ number is set to 0, which is the same as the superlibrarian's number.
 
 #'
 sub logaction {
-    my ($modulename, $actionname, $objectnumber, $infos)=@_;
+    my ($modulename, $actionname, $objectnumber, $infos, $interface)=@_;
 
     # 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;
+    $interface //= C4::Context->interface;
 
     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);
+    my $sth=$dbh->prepare("Insert into action_logs (timestamp,user,module,action,object,info,interface) values (now(),?,?,?,?,?,?)");
+    $sth->execute($usernumber,$modulename,$actionname,$objectnumber,$infos,$interface);
     $sth->finish;
-}
-
-=item GetLogStatus
 
-  $status = GetLogStatus;
-
-C<$status> is a hasref like this example:
-    $hash = {
-        BorrowersLog   => 1,
-        CataloguingLog => 0,
-        IssueLog       => 0,
-        ...
-    }
-
-=cut
-
-#'
-sub GetLogStatus {
-    my %hash;
-    $hash{BorrowersLog}    = C4::Context->preference("BorrowersLog");
-    $hash{CataloguingLog}  = C4::Context->preference("CataloguingLog");
-    $hash{IssueLog}        = C4::Context->preference("IssueLog");
-    $hash{ReturnLog}       = C4::Context->preference("ReturnLog");
-    $hash{SubscriptionLog} = C4::Context->preference("SubscriptionLog");
-    $hash{LetterLog}       = C4::Context->preference("LetterLog");
-    $hash{FinesLog}        = C4::Context->preference("FinesLog");
-    return \%hash;
+    my $logger = Koha::Logger->get(
+        {
+            interface => 'intranet',
+            category  => "ActionLogs.$modulename.$actionname"
+        }
+    );
+    $logger->debug(
+        sub {
+            "ACTION LOG: " . to_json(
+                {
+                    user   => $usernumber,
+                    module => $modulename,
+                    action => $actionname,
+                    object => $objectnumber,
+                    info   => $infos
+                }
+            );
+        }
+    );
 }
 
-=item displaylog
+=item cronlogaction
 
-  &displaylog($modulename, @filters);
-  $modulename is the name of the module on which the user wants to display logs
-  @filters is an optional table of hash containing :
-      - name : the name of the variable to filter
-    - value : the value of the filter.... May be with * joker
+  &cronlogaction($infos);
 
-returns a table of hash containing who did what on which object at what time
+Convenience routine to add a record into action_logs table from a cron job.
+Logs the path and name of the calling script plus the information privided by param $infos.
 
 =cut
 
 #'
-sub displaylog {
-  my ($modulename, @filters) = @_;
-    my $dbh = C4::Context->dbh;
-    my $strsth=qq|
-               SELECT action_logs.timestamp, action_logs.action, action_logs.info,
-                               borrowers.cardnumber, borrowers.surname, borrowers.firstname, borrowers.userid,
-                       biblio.biblionumber, biblio.title, biblio.author
-        FROM action_logs 
-               LEFT JOIN borrowers ON borrowers.borrowernumber=action_logs.user 
-        LEFT JOIN  biblio   ON action_logs.object=biblio.biblionumber
-        WHERE action_logs.module = 'cataloguing' 
-       |;
-       my %filtermap = ();
-    if ($modulename eq "catalogue" or $modulename eq "acqui") {
-               %filtermap = (
-                         user => 'borrowers.surname',
-                        title => 'biblio.title',
-                       author => 'biblio.author',
-               );
-    } elsif ($modulename eq "members") {
-        $strsth=qq|
-               SELECT action_logs.timestamp, action_logs.action, action_logs.info, 
-                       borrowers.cardnumber, borrowers.surname, borrowers.firstname, borrowers.userid,
-                       bor2.cardnumber, bor2.surname, bor2.firstname, bor2.userid
-        FROM action_logs 
-               LEFT JOIN borrowers ON borrowers.borrowernumber=action_logs.user 
-               LEFT JOIN borrowers as bor2 ON action_logs.object=bor2.borrowernumber
-        WHERE action_logs.module = 'members' 
-               |;
-               %filtermap = (
-                      user => 'borrowers.surname',
-                   surname => 'bor2.surname',
-                 firstname => 'bor2.firstname',
-                cardnumber => 'bor2.cardnumber',
-               );
-    } else {
-               return 0;
-       }
-
-    if (@filters) {
-               foreach my $filter (@filters) {
-                       my $tempname = $filter->{name}         or next;
-                       (grep {/^$tempname$/} keys %filtermap) or next;
-                       $filter->{value} =~ s/\*/%/g;
-                       $strsth .= " AND " . $filtermap{$tempname} . " LIKE " . $filter->{value};
-               }
-       }
-    my $sth=$dbh->prepare($strsth);
-    $sth->execute;
-    my @results;
-    my $count;
-    my $hilighted=1;
-    while (my $data = $sth->fetchrow_hashref){
-       $data->{hilighted} = ($hilighted>0);
-        $data->{info} =~ s/\n/<br\/>/g;
-        $data->{day} = format_date($data->{timestamp});
-        push @results, $data;
-        $count++;
-        $hilighted = -$hilighted;
-    }
-    return ($count, \@results);
+sub cronlogaction {
+    my ($infos)=@_;
+    my $loginfo = (caller(0))[1];
+    $loginfo .= ' ' . $infos if $infos;
+    logaction( 'CRONJOBS', 'Run', undef, $loginfo ) if C4::Context->preference('CronjobLog');
 }
 
 =item GetLogs
 
 $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
+Return:
+C<$logs> is a ref to a hash which contains all columns from action_logs
 
 =cut
 
@@ -196,15 +133,18 @@ sub GetLogs {
     my $datefrom = shift;
     my $dateto   = shift;
     my $user     = shift;
-    my $modules   = 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 $interfaces = shift;
 
-    my $dbh = C4::Context->dbh;
+    my $iso_datefrom = $datefrom ? output_pref({ dt => dt_from_string( $datefrom ), dateformat => 'iso', dateonly => 1 }) : undef;
+    my $iso_dateto = $dateto ? output_pref({ dt => dt_from_string( $dateto ), dateformat => 'iso', dateonly => 1 }) : undef;
+
+    $user ||= q{};
+
+    my $dbh   = C4::Context->dbh;
     my $query = "
         SELECT *
         FROM   action_logs
@@ -212,36 +152,45 @@ sub GetLogs {
     ";
 
     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);
+    $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 q{} ) {
+        $query .= " AND user = ? ";
+        push( @parameters, $user );
+    }
+    if ( $modules && scalar(@$modules) ) {
+        $query .=
+          " AND module IN (" . join( ",", map { "?" } @$modules ) . ") ";
+        push( @parameters, @$modules );
     }
-    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($action && scalar(@$action)) {
-       $query .= " AND action IN (".join(",",map {"?"} @$action).") ";
-       push(@parameters,@$action);
+    if ($object) {
+        $query .= " AND object = ? ";
+        push( @parameters, $object );
     }
-    if($object) {
-       $query .= " AND object = ? ";
-       push(@parameters,$object);
+    if ($info) {
+        $query .= " AND info LIKE ? ";
+        push( @parameters, "%" . $info . "%" );
     }
-    if($info) {
-       $query .= " AND info LIKE ? ";
-       push(@parameters,"%".$info."%");
+    if ( $interfaces && scalar(@$interfaces) ) {
+        $query .=
+          " AND interface IN (" . join( ",", map { "?" } @$interfaces ) . ") ";
+        push( @parameters, @$interfaces );
     }
-   
+
     my $sth = $dbh->prepare($query);
     $sth->execute(@parameters);
-    
+
     my @logs;
-    while( my $row = $sth->fetchrow_hashref ) {
-        $row->{$row->{module}} = 1;
-        push @logs , $row;
+    while ( my $row = $sth->fetchrow_hashref ) {
+        push @logs, $row;
     }
     return \@logs;
 }