3 #package to deal with Logging Actions in DB
6 # Copyright 2000-2002 Katipo Communications
7 # Copyright 2011 MJ Ray and software.coop
9 # This file is part of Koha.
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.
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.
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>.
27 use Data::Dumper qw( Dumper );
28 use JSON qw( to_json );
29 use Scalar::Util qw( blessed );
30 use File::Basename qw( basename );
35 use vars qw(@ISA @EXPORT);
40 @EXPORT = qw(logaction cronlogaction);
45 C4::Log - Koha Log Facility functions
53 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.
61 &logaction($modulename, $actionname, $objectnumber, $infos, $interface);
63 Adds a record into action_logs table to report the different changes upon the database.
64 Each log entry includes the number of the user currently logged in. For batch
65 jobs, which operate without authenticating a user and setting up a session, the user
66 number is set to 0, which is the same as the superlibrarian's number.
72 my ($modulename, $actionname, $objectnumber, $infos, $interface)=@_;
74 # Get ID of logged in user. if called from a batch job,
75 # no user session exists and C4::Context->userenv() returns
77 my $userenv = C4::Context->userenv();
78 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : 0;
80 $interface //= C4::Context->interface;
82 if( blessed($infos) && $infos->isa('Koha::Object') ) {
83 $infos = $infos->get_from_storage if $infos->in_storage;
84 local $Data::Dumper::Sortkeys = 1;
86 if ( $infos->isa('Koha::Item') && $modulename eq 'CATALOGUING' && $actionname eq 'MODIFY' ) {
87 $infos = "item " . Dumper( $infos->unblessed );
89 $infos = Dumper( $infos->unblessed );
93 my $script = ( $interface eq 'cron' or $interface eq 'commandline' )
97 my $dbh = C4::Context->dbh;
98 my $sth=$dbh->prepare("Insert into action_logs (timestamp,user,module,action,object,info,interface,script) values (now(),?,?,?,?,?,?,?)");
99 $sth->execute($usernumber,$modulename,$actionname,$objectnumber,$infos,$interface,$script);
102 my $logger = Koha::Logger->get(
104 interface => $interface,
105 category => "ActionLogs.$modulename.$actionname"
110 "ACTION LOG: " . to_json(
113 module => $modulename,
114 action => $actionname,
115 object => $objectnumber,
125 &cronlogaction($infos);
127 Convenience routine to add a record into action_logs table from a cron job.
128 Logs the path and name of the calling script plus the information privided by param $infos.
135 my $info = $params->{info};
136 my $action = $params->{action};
138 my $loginfo = (caller(0))[1];
139 $loginfo .= ' ' . $info if $info;
140 logaction( 'CRONJOBS', $action, $$, $loginfo ) if C4::Context->preference('CronjobLog');
150 Koha Development Team <http://koha-community.org/>