Open-ILS/src/perlmods/OpenILS/Event.pm

   1 package OpenILS::Event;
   2 # vim:noet:ts=4
   3 use strict; use warnings;
   4 use XML::LibXML;
   5 use OpenSRF::Utils::SettingsClient;
   6 use OpenSRF::Utils::Logger;
   7 my $logger = "OpenSRF::Utils::Logger";
   8
   9
  10 # Returns a new Event data hash (not a blessed object)
  11 # The first param is the event name
  12 # Following the first param is an optional hash of params:
  13 #               perm => the name of the permission error for permimssion errors
  14 #               permloc => the location of the permission error for permission errors
  15 #               payload => the payload to be returned on successfull events
  16
  17
  18 my $events = undef;
  19 my $descs  = undef;
  20
  21 sub new {
  22     my( $class, $event, %params ) = @_;
  23     _load_events() unless $events;
  24
  25     throw OpenSRF::EX ("Bad event name: $event") unless $event;
  26     my $e = $events->{$event} || '';
  27
  28     my(   $m,   $f,   $l ) = caller(0);
  29     my(  $mm,  $ff,  $ll ) = caller(1);
  30     my( $mmm, $fff, $lll ) = caller(2);
  31
  32     $f   ||= "";
  33     $l   ||= "";
  34     $ff  ||= "";
  35     $ll  ||= "";
  36     $fff ||= "";
  37     $lll ||= "";
  38
  39     my $lang = 'en-US'; # assume english for now
  40
  41     my $t = CORE::localtime();
  42
  43     return {
  44         ilsevent   => $e,
  45         textcode   => $event,
  46         stacktrace => "$f:$l $ff:$ll $fff:$lll",
  47         desc       => $descs->{$lang}->{$e || ''} || '',
  48         servertime => $t,
  49         pid        => $$, %params
  50     };
  51 }
  52
  53 sub _load_events {
  54         my $settings_client = OpenSRF::Utils::SettingsClient->new();
  55         my $eventsxml =  $settings_client->config_value( "ils_events" );
  56
  57         if(!$eventsxml) {
  58                 throw OpenSRF::EX ("No ils_events file found in settings config");
  59         }
  60
  61         $logger->info("Loading events xml file $eventsxml");
  62
  63         my $doc = XML::LibXML->new->parse_file($eventsxml);
  64
  65         my @nodes = $doc->documentElement->findnodes('//event');
  66         for my $node (@nodes) {
  67                 $events->{$node->getAttribute('textcode')} =
  68                         $node->getAttribute('code');
  69         }
  70
  71         $descs = {};
  72         my @desc = $doc->documentElement->findnodes('//desc');
  73         for my $d (@desc) {
  74                 my $lang = $d->getAttributeNS('http://www.w3.org/XML/1998/namespace', 'lang');
  75                 my $code = $d->parentNode->getAttribute('code');
  76                 unless ($descs && $lang && exists $descs->{$lang}) {
  77                         $descs->{$lang} = {};
  78                         if (!$descs) {
  79                                 $logger->error("No error description nodes found in $eventsxml.");
  80                         }
  81                         if (!$lang) {
  82                                 $logger->error("No xml:lang attribute found for node in $eventsxml.");
  83                         }
  84                 }
  85                 $descs->{$lang}->{$code} = $d->textContent;
  86         }
  87 }
  88
  89
  90 1;