[Koha-cvs] CVS: koha/C4 Log.pm,NONE,1.4.2.2

[Henri-Damien LAURENT]

Update of /cvsroot/koha/koha/C4
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29531/C4

Added Files:
      Tag: rel_2_2
        Log.pm 
Log Message:
Adding Log Facility for Biblio management.
Note that a javascript will soon be written for action type management and that 
viewlog.pl is fully functionnal (tested) only for Catalogue.


--- NEW FILE ---
package C4::Log; #assumes C4/Log

#package to deal with Logging Actions in DB


# Copyright 2000-2002 Katipo Communications
#
# 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 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., 59 Temple Place,
# Suite 330, Boston, MA  02111-1307 USA

use strict;
use C4::Context;
use C4::Date;

require Exporter;

use vars qw($VERSION @ISA @EXPORT);

# set the version for version checking
$VERSION = 0.01;

=head1 NAME

C4::Log - Koha Log Facility functions

=head1 SYNOPSIS

  use C4::Log;

=head1 DESCRIPTION

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.

=head1 FUNCTIONS

=over 2

=cut

@ISA = qw(Exporter);
@EXPORT = qw(&logaction &logstatus &displaylog);

=item logaction

  &logaction($usernumber, $modulename, $actionname, $infos);

Adds a record into action_logs table to report the different changes upon the 
database

=cut
#'
sub logaction{
  my ($usernumber,$modulename, $actionname, $objectnumber, 
$infos)address@hidden;
        my $dbh = C4::Context->dbh;
        warn "logactions :$usernumber,$modulename, $actionname, $objectnumber, 
$infos";
        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;
}

=item logstatus

  &logstatus;

returns True If Activate_Log variable is equal to On
Activate_Log is a system preference Variable
=cut
#'
sub logstatus{
        return C4::Context->preference("Activate_Log");
}

=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)address@hidden;
        my $dbh = C4::Context->dbh;
        my $strsth;
        if ($modulename eq "catalogue"){
                $strsth="select action_logs.timestamp, action_logs.action, 
action_logs.info, borrowers.cardnumber, borrowers.surname, borrowers.firstname, 
borrowers.userid,";
                $strsth .= "biblio.biblionumber, biblio.title, biblio.author" 
;#if ($modulename eq "acqui.simple");
                $strsth .= " FROM action_logs LEFT JOIN borrowers ON 
borrowers.borrowernumber=action_logs.user";
                $strsth .= ",biblio " ;#if ($modulename eq "acqui.simple");
        
                $strsth .=" WHERE 1";
                $strsth .=" AND action_logs.module = 'acqui.simple' AND 
action_logs.object=biblio.biblionumber ";# if ($modulename eq "acqui.simple");
                if (@filters){
                        foreach my $filter (@filters){
                                if ($filter->{name} =~ /user/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND ((borrowers.surname 
like '".$filter->{value}."') OR (borrowers.cardnumber like 
'".$filter->{value}."') OR (borrowers.firstname like '".$filter->{value}."')) ";
                                }elsif ($filter->{name} =~ /action/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND action_logs.action 
like ".$dbh->quote($filter->{value});
                                }elsif ($filter->{name} =~ /from/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND 
action_logs.timestamp>".$dbh->quote($filter->{value});
                                }elsif ($filter->{name} =~ /to/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND 
action_logs.timestamp<".$dbh->quote($filter->{value});
                                }elsif ($filter->{name} =~ /title/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND biblio.title like 
".$filter->{value};
                                }elsif ($filter->{name} =~ /author/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND biblio.author like 
".$filter->{value};
                                }
                        }
                }
        } elsif ($modulename eq "acqui")  {
                $strsth="select action_logs.timestamp, action_logs.action, 
action_logs.info, borrowers.cardnumber, borrowers.surname, borrowers.firstname, 
borrowers.userid,";
                $strsth .= "biblio.biblionumber, biblio.title, biblio.author" 
;#if ($modulename eq "acqui.simple");
                $strsth .= "FROM borrowers,action_logs ";
                $strsth .= ",biblio " ;#if ($modulename eq "acqui.simple");
        
                $strsth .=" WHERE borrowers.borrowernumber=action_logs.user";
                $strsth .= "AND action_logs.module = 'acqui.simple' AND 
action_logs.object=biblio.biblionumber ";# if ($modulename eq "acqui.simple");
                if (@filters){
                        foreach my $filter (@filters){
                                if ($filter->{name} =~ /user/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND borrowers.surname like 
".$filter->{value};
                                }elsif ($filter->{name} =~ /title/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND biblio.title like 
".$filter->{value};
                                }elsif ($filter->{name} =~ /author/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND biblio.author like 
".$filter->{value};
                                }
                        }
                }
        } elsif ($modulename eq "members"){
                $strsth="select action_logs.timestamp, action_logs.action, 
action_logs.info, borrowers.cardnumber, borrowers.surname, borrowers.firstname, 
borrowers.userid,";
                $strsth .= "bor2.cardnumber, bor2.surname, bor2.firstname, 
bor2.userid,";
                $strsth .= "FROM borrowers,action_logs,borrowers as bor2 ";
        
                $strsth .=" WHERE borrowers.borrowernumber=action_logs.user";
                $strsth .= "AND action_logs.module = 'members' AND 
action_logs.object=bor2.borrowernumber ";# if ($modulename eq "acqui.simple");
                if (@filters){
                        foreach my $filter (@filters){
                                if ($filter->{name} =~ /user/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND borrowers.surname like 
".$filter->{value};
                                }elsif ($filter->{name} =~ /surname/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND bor2.surname like 
".$filter->{value};
                                }elsif ($filter->{name} =~ /firstname/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND bor2.firsntame like 
".$filter->{value};
                                }elsif ($filter->{name} =~ /cardnumber/){
                                        $filter->{value}=~s/\*/%/g;
                                        $strsth .= " AND bor2.cardnumber like 
".$filter->{value};
                                }
                        }
                }
        }
        warn "displaylog :".$strsth;
        if ($strsth){
                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, address@hidden);
        } else {return 0;}
}
END { }       # module clean-up code here (global destructor)

1;
__END__

=back

=head1 AUTHOR

Koha Developement team <address@hidden>

=cut