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>.
30 use vars
qw($VERSION @ISA @EXPORT);
33 # set the version for version checking
34 $VERSION = 3.07.00.049;
37 @EXPORT = qw(&logaction &cronlogaction &GetLogStatus &displaylog &GetLogs);
42 C4::Log - Koha Log Facility functions
50 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.
58 &logaction($modulename, $actionname, $objectnumber, $infos);
60 Adds a record into action_logs table to report the different changes upon the database.
61 Each log entry includes the number of the user currently logged in. For batch
62 jobs, which operate without authenticating a user and setting up a session, the user
63 number is set to 0, which is the same as the superlibrarian's number.
69 my ($modulename, $actionname, $objectnumber, $infos)=@_;
71 # Get ID of logged in user. if called from a batch job,
72 # no user session exists and C4::Context->userenv() returns
74 my $userenv = C4
::Context
->userenv();
75 my $usernumber = (ref($userenv) eq 'HASH') ?
$userenv->{'number'} : 0;
78 my $dbh = C4
::Context
->dbh;
79 my $sth=$dbh->prepare("Insert into action_logs (timestamp,user,module,action,object,info) values (now(),?,?,?,?,?)");
80 $sth->execute($usernumber,$modulename,$actionname,$objectnumber,$infos);
86 &cronlogaction($infos);
88 Convenience routine to add a record into action_logs table from a cron job.
89 Logs the path and name of the calling script plus the information privided by param $infos.
96 my $loginfo = (caller(0))[1];
97 $loginfo .= ' ' . $infos if $infos;
98 logaction
( 'CRONJOBS', 'Run', undef, $loginfo ) if C4
::Context
->preference('CronjobLog');
104 $status = GetLogStatus;
106 C<$status> is a hasref like this example:
119 $hash{BorrowersLog
} = C4
::Context
->preference("BorrowersLog");
120 $hash{CataloguingLog
} = C4
::Context
->preference("CataloguingLog");
121 $hash{IssueLog
} = C4
::Context
->preference("IssueLog");
122 $hash{ReturnLog
} = C4
::Context
->preference("ReturnLog");
123 $hash{SubscriptionLog
} = C4
::Context
->preference("SubscriptionLog");
124 $hash{LetterLog
} = C4
::Context
->preference("LetterLog");
125 $hash{FinesLog
} = C4
::Context
->preference("FinesLog");
131 &displaylog($modulename, @filters);
132 $modulename is the name of the module on which the user wants to display logs
133 @filters is an optional table of hash containing :
134 - name : the name of the variable to filter
135 - value : the value of the filter.... May be with * joker
137 returns a table of hash containing who did what on which object at what time
143 my ($modulename, @filters) = @_;
144 my $dbh = C4
::Context
->dbh;
146 SELECT action_logs
.timestamp
, action_logs
.action
, action_logs
.info
,
147 borrowers
.cardnumber
, borrowers
.surname
, borrowers
.firstname
, borrowers
.userid
,
148 biblio
.biblionumber
, biblio
.title
, biblio
.author
150 LEFT JOIN borrowers ON borrowers
.borrowernumber
=action_logs
.user
151 LEFT JOIN biblio ON action_logs
.object
=biblio
.biblionumber
152 WHERE action_logs
.module
= 'cataloguing'
155 if ($modulename eq "catalogue" or $modulename eq "acqui") {
157 user
=> 'borrowers.surname',
158 title
=> 'biblio.title',
159 author
=> 'biblio.author',
161 } elsif ($modulename eq "members") {
163 SELECT action_logs
.timestamp
, action_logs
.action
, action_logs
.info
,
164 borrowers
.cardnumber
, borrowers
.surname
, borrowers
.firstname
, borrowers
.userid
,
165 bor2
.cardnumber
, bor2
.surname
, bor2
.firstname
, bor2
.userid
167 LEFT JOIN borrowers ON borrowers
.borrowernumber
=action_logs
.user
168 LEFT JOIN borrowers as bor2 ON action_logs
.object
=bor2
.borrowernumber
169 WHERE action_logs
.module
= 'members'
172 user
=> 'borrowers.surname',
173 surname
=> 'bor2.surname',
174 firstname
=> 'bor2.firstname',
175 cardnumber
=> 'bor2.cardnumber',
182 foreach my $filter (@filters) {
183 my $tempname = $filter->{name
} or next;
184 (grep {/^$tempname$/} keys %filtermap) or next;
185 $filter->{value
} =~ s/\*/%/g;
186 $strsth .= " AND " . $filtermap{$tempname} . " LIKE " . $filter->{value
};
189 my $sth=$dbh->prepare($strsth);
194 while (my $data = $sth->fetchrow_hashref){
195 $data->{hilighted
} = ($hilighted>0);
196 $data->{info
} =~ s/\n/<br\/>/g
;
197 $data->{day
} = output_pref
({ str
=> $data->{timestamp
} });
198 push @results, $data;
200 $hilighted = -$hilighted;
202 return ($count, \
@results);
207 $logs = GetLogs($datefrom,$dateto,$user,\@modules,$action,$object,$info);
210 C<$logs> is a ref to a hash which containts all columns from action_logs
215 my $datefrom = shift;
223 my $iso_datefrom = output_pref
({ dt
=> dt_from_string
( $datefrom ), dateformat
=> 'iso', dateonly
=> 1 });
224 my $iso_dateto = output_pref
({ dt
=> dt_from_string
( $dateto ), dateformat
=> 'iso', dateonly
=> 1 });
226 my $dbh = C4
::Context
->dbh;
234 $query .= " AND DATE_FORMAT(timestamp, '%Y-%m-%d') >= \"".$iso_datefrom."\" " if $iso_datefrom; #fix me - mysql specific
235 $query .= " AND DATE_FORMAT(timestamp, '%Y-%m-%d') <= \"".$iso_dateto."\" " if $iso_dateto;
237 $query .= " AND user = ? ";
238 push(@parameters,$user);
240 if($modules && scalar(@
$modules)) {
241 $query .= " AND module IN (".join(",",map {"?"} @
$modules).") ";
242 push(@parameters,@
$modules);
244 if($action && scalar(@
$action)) {
245 $query .= " AND action IN (".join(",",map {"?"} @
$action).") ";
246 push(@parameters,@
$action);
249 $query .= " AND object = ? ";
250 push(@parameters,$object);
253 $query .= " AND info LIKE ? ";
254 push(@parameters,"%".$info."%");
257 my $sth = $dbh->prepare($query);
258 $sth->execute(@parameters);
261 while( my $row = $sth->fetchrow_hashref ) {
274 Koha Development Team <http://koha-community.org/>