Bug 33146: Unit tests
[koha-ffzg.git] / C4 / Log.pm
index d4ff988..d16d423 100644 (file)
--- a/C4/Log.pm
+++ b/C4/Log.pm
@@ -24,17 +24,21 @@ package C4::Log;
 use strict;
 use warnings;
 
+use Data::Dumper qw( Dumper );
+use JSON qw( to_json );
+use Scalar::Util qw( blessed );
+use File::Basename qw( basename );
+
 use C4::Context;
-use Koha::DateUtils;
+use Koha::Logger;
+use Koha::ActionLogs;
 
-use vars qw($VERSION @ISA @EXPORT);
+use vars qw(@ISA @EXPORT);
 
 BEGIN {
-    # set the version for version checking
-    $VERSION = 3.07.00.049;
         require Exporter;
         @ISA = qw(Exporter);
-        @EXPORT = qw(&logaction &cronlogaction &GetLogStatus &displaylog &GetLogs);
+        @EXPORT = qw(logaction cronlogaction);
 }
 
 =head1 NAME
@@ -55,7 +59,7 @@ The functions in this module perform various functions in order to log all the o
 
 =item logaction
 
-  &logaction($modulename, $actionname, $objectnumber, $infos);
+  &logaction($modulename, $actionname, $objectnumber, $infos, $interface);
 
 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
@@ -66,7 +70,7 @@ 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
@@ -74,11 +78,73 @@ sub logaction {
     my $userenv = C4::Context->userenv();
     my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : 0;
     $usernumber ||= 0;
+    $interface //= C4::Context->interface;
+
+    if( blessed($infos) && $infos->isa('Koha::Object') ) {
+        $infos = $infos->get_from_storage if $infos->in_storage;
+        local $Data::Dumper::Sortkeys = 1;
 
-    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);
-    $sth->finish;
+        if ( $infos->isa('Koha::Item') && $modulename eq 'CATALOGUING' && $actionname eq 'MODIFY' ) {
+            $infos = "item " . Dumper( $infos->unblessed );
+        } else {
+            $infos = Dumper( $infos->unblessed );
+        }
+    }
+
+    my $script = ( $interface eq 'cron' or $interface eq 'commandline' )
+        ? basename($0)
+        : undef;
+
+    my @trace;
+    my $depth = C4::Context->preference('ActionLogsTraceDepth') || 0;
+    for ( my $i = 0 ; $i < $depth ; $i++ ) {
+        my ( $package, $filename, $line, $subroutine ) = caller($i);
+        last unless defined $line;
+        push(
+            @trace,
+            {
+                package    => $package,
+                filename   => $filename,
+                line       => $line,
+                subroutine => $subroutine,
+            }
+        );
+    }
+    my $trace = @trace ? to_json( \@trace, { utf8 => 1, pretty => 0 } ) : undef;
+
+    Koha::ActionLog->new(
+        {
+            timestamp => \'NOW()',
+            user      => $usernumber,
+            module    => $modulename,
+            action    => $actionname,
+            object    => $objectnumber,
+            info      => $infos,
+            interface => $interface,
+            script    => $script,
+            trace     => $trace,
+        }
+    )->store();
+
+    my $logger = Koha::Logger->get(
+        {
+            interface => $interface,
+            category  => "ActionLogs.$modulename.$actionname"
+        }
+    );
+    $logger->debug(
+        sub {
+            "ACTION LOG: " . to_json(
+                {
+                    user   => $usernumber,
+                    module => $modulename,
+                    action => $actionname,
+                    object => $objectnumber,
+                    info   => $infos
+                }
+            );
+        }
+    );
 }
 
 =item cronlogaction
@@ -92,183 +158,13 @@ Logs the path and name of the calling script plus the information privided by pa
 
 #'
 sub cronlogaction {
-    my ($infos)=@_;
+    my $params = shift;
+    my $info = $params->{info};
+    my $action = $params->{action};
+    $action ||= "Run";
     my $loginfo = (caller(0))[1];
-    $loginfo .= ' ' . $infos if $infos;
-    logaction( 'CRONJOBS', 'Run', undef, $loginfo ) if C4::Context->preference('CronjobLog');
-}
-
-
-=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;
-}
-
-=item displaylog
-
-  &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
-
-returns a table of hash containing who did what on which object at what time
-
-=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} = output_pref({ str => $data->{timestamp} });
-        push @results, $data;
-        $count++;
-        $hilighted = -$hilighted;
-    }
-    return ($count, \@results);
-}
-
-=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
-
-=cut
-
-sub GetLogs {
-    my $datefrom = shift;
-    my $dateto   = shift;
-    my $user     = shift;
-    my $modules  = shift;
-    my $action   = shift;
-    my $object   = shift;
-    my $info     = shift;
-
-    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
-        WHERE 1
-    ";
-
-    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 q{} ) {
-        $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(@parameters);
-
-    my @logs;
-    while ( my $row = $sth->fetchrow_hashref ) {
-        push @logs, $row;
-    }
-    return \@logs;
+    $loginfo .= ' ' . $info if $info;
+    logaction( 'CRONJOBS', $action, $$, $loginfo ) if C4::Context->preference('CronjobLog');
 }
 
 1;