Koha/Logger.pm

   1 package Koha::Logger;
   2
   3 # Copyright 2015 ByWater Solutions
   4 # kyle@bywatersolutions.com
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it under the
   9 # terms of the GNU General Public License as published by the Free Software
  10 # Foundation; either version 3 of the License, or (at your option) any later
  11 # version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  15 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License along
  18 # with Koha; if not, write to the Free Software Foundation, Inc.,
  19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20
  21 =head1 NAME
  22
  23 Koha::Log
  24
  25 =head1 SYNOPSIS
  26
  27   use Koha::Log;
  28
  29 =head1 FUNCTIONS
  30
  31 =cut
  32
  33 use Modern::Perl;
  34
  35 use Log::Log4perl;
  36 use Carp;
  37
  38 use C4::Context;
  39
  40 BEGIN {
  41     Log::Log4perl->wrapper_register(__PACKAGE__);
  42
  43     if ( exists $ENV{"LOG4PERL_CONF"} and $ENV{'LOG4PERL_CONF'} and -s $ENV{"LOG4PERL_CONF"} ) {
  44         # Check for web server level configuration first
  45         Log::Log4perl->init_once( $ENV{"LOG4PERL_CONF"} );
  46     }
  47     elsif ( C4::Context->config("log4perl_conf") ) {
  48         # If no web server level config exists, look in the koha conf file for one
  49         Log::Log4perl->init_once( C4::Context->config("log4perl_conf") );
  50     } else {
  51         my $logdir = C4::Context->config("logdir");
  52         my $conf = qq(
  53             log4perl.logger.intranet = WARN, INTRANET
  54             log4perl.appender.INTRANET=Log::Log4perl::Appender::File
  55             log4perl.appender.INTRANET.filename=$logdir/intranet-error.log
  56             log4perl.appender.INTRANET.mode=append
  57             log4perl.appender.INTRANET.layout=PatternLayout
  58             log4perl.appender.INTRANET.layout.ConversionPattern=[%d] [%p] %m %l %n
  59
  60             log4perl.logger.opac = WARN, OPAC
  61             log4perl.appender.OPAC=Log::Log4perl::Appender::File
  62             log4perl.appender.OPAC.filename=$logdir/opac-error.log
  63             log4perl.appender.OPAC.mode=append
  64             log4perl.appender.OPAC.layout=PatternLayout
  65             log4perl.appender.OPAC.layout.ConversionPattern=[%d] [%p] %m %l %n
  66         );
  67         Log::Log4perl->init_once(\$conf);
  68     }
  69 }
  70
  71 =head2 get
  72
  73     Returns a log4perl object.
  74     Category and interface parameter are optional.
  75     Normally, the category should follow the current package and the interface
  76     should be set correctly via C4::Context.
  77
  78 =cut
  79
  80 sub get {
  81     my ( $class, $category, $interface ) = @_;
  82     $interface ||= C4::Context->interface();
  83     $category = caller if !$category;
  84     return Log::Log4perl->get_logger( $interface. '.'. $category );
  85 }
  86
  87 =head1 AUTHOR
  88
  89 Kyle M Hall, E<lt>kyle@bywatersolutions.comE<gt>
  90
  91 =cut
  92
  93 1;
  94
  95 __END__