C4/Log.pm

   1 package C4::Log;
   2
   3 #package to deal with Logging Actions in DB
   4
   5
   6 # Copyright 2000-2002 Katipo Communications
   7 # Copyright 2011 MJ Ray and software.coop
   8 #
   9 # This file is part of Koha.
  10 #
  11 # Koha is free software; you can redistribute it and/or modify it
  12 # under the terms of the GNU General Public License as published by
  13 # the Free Software Foundation; either version 3 of the License, or
  14 # (at your option) any later version.
  15 #
  16 # Koha is distributed in the hope that it will be useful, but
  17 # WITHOUT ANY WARRANTY; without even the implied warranty of
  18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19 # GNU General Public License for more details.
  20 #
  21 # You should have received a copy of the GNU General Public License
  22 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  23
  24 use strict;
  25 use warnings;
  26
  27 use JSON qw( to_json );
  28
  29 use C4::Context;
  30 use Koha::DateUtils;
  31 use Koha::Logger;
  32
  33 use vars qw(@ISA @EXPORT);
  34
  35 BEGIN {
  36         require Exporter;
  37         @ISA = qw(Exporter);
  38         @EXPORT = qw(&logaction &cronlogaction);
  39 }
  40
  41 =head1 NAME
  42
  43 C4::Log - Koha Log Facility functions
  44
  45 =head1 SYNOPSIS
  46
  47   use C4::Log;
  48
  49 =head1 DESCRIPTION
  50
  51 The functions in this module perform various functions in order to log all the operations done on the Database, including deleting and undeleting books, adding/editing members, etc.
  52
  53 =head1 FUNCTIONS
  54
  55 =over 2
  56
  57 =item logaction
  58
  59   &logaction($modulename, $actionname, $objectnumber, $infos, $interface);
  60
  61 Adds a record into action_logs table to report the different changes upon the database.
  62 Each log entry includes the number of the user currently logged in.  For batch
  63 jobs, which operate without authenticating a user and setting up a session, the user
  64 number is set to 0, which is the same as the superlibrarian's number.
  65
  66 =cut
  67
  68 #'
  69 sub logaction {
  70     my ($modulename, $actionname, $objectnumber, $infos, $interface)=@_;
  71
  72     # Get ID of logged in user.  if called from a batch job,
  73     # no user session exists and C4::Context->userenv() returns
  74     # the scalar '0'.
  75     my $userenv = C4::Context->userenv();
  76     my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : 0;
  77     $usernumber ||= 0;
  78     $interface //= C4::Context->interface;
  79
  80     my $dbh = C4::Context->dbh;
  81     my $sth=$dbh->prepare("Insert into action_logs (timestamp,user,module,action,object,info,interface) values (now(),?,?,?,?,?,?)");
  82     $sth->execute($usernumber,$modulename,$actionname,$objectnumber,$infos,$interface);
  83     $sth->finish;
  84
  85     my $logger = Koha::Logger->get(
  86         {
  87             interface => $interface,
  88             category  => "ActionLogs.$modulename.$actionname"
  89         }
  90     );
  91     $logger->debug(
  92         sub {
  93             "ACTION LOG: " . to_json(
  94                 {
  95                     user   => $usernumber,
  96                     module => $modulename,
  97                     action => $actionname,
  98                     object => $objectnumber,
  99                     info   => $infos
 100                 }
 101             );
 102         }
 103     );
 104 }
 105
 106 =item cronlogaction
 107
 108   &cronlogaction($infos);
 109
 110 Convenience routine to add a record into action_logs table from a cron job.
 111 Logs the path and name of the calling script plus the information privided by param $infos.
 112
 113 =cut
 114
 115 #'
 116 sub cronlogaction {
 117     my ($infos)=@_;
 118     my $loginfo = (caller(0))[1];
 119     $loginfo .= ' ' . $infos if $infos;
 120     logaction( 'CRONJOBS', 'Run', undef, $loginfo ) if C4::Context->preference('CronjobLog');
 121 }
 122
 123 1;
 124 __END__
 125
 126 =back
 127
 128 =head1 AUTHOR
 129
 130 Koha Development Team <http://koha-community.org/>
 131
 132 =cut