lib/Sys/Syslog.pm

   1 package Sys::Syslog;
   2 require 5.000;
   3 require Exporter;
   4 use Carp;
   5
   6 @ISA = qw(Exporter);
   7 @EXPORT = qw(openlog closelog setlogmask syslog);
   8
   9 use Socket;
  10 use Sys::Hostname;
  11
  12 #
  13 # syslog.pl
  14 #
  15 # $Log: syslog.pl,v $
  16 #
  17 # tom christiansen <tchrist@convex.com>
  18 # modified to use sockets by Larry Wall <lwall@jpl-devvax.jpl.nasa.gov>
  19 # NOTE: openlog now takes three arguments, just like openlog(3)
  20 #
  21 # call syslog() with a string priority and a list of printf() args
  22 # like syslog(3)
  23 #
  24 #  usage: use Syslog;
  25 #
  26 #  then (put these all in a script to test function)
  27 #
  28 #       openlog($program,'cons,pid','user');
  29 #       syslog('info','this is another test');
  30 #       syslog('mail|warning','this is a better test: %d', time);
  31 #       closelog();
  32 #
  33 #       syslog('debug','this is the last test');
  34 #       openlog("$program $$",'ndelay','user');
  35 #       syslog('notice','fooprogram: this is really done');
  36 #
  37 #       $! = 55;
  38 #       syslog('info','problem was %m'); # %m == $! in syslog(3)
  39
  40 $host = hostname() unless $host;        # set $Syslog::host to change
  41
  42 require 'syslog.ph';
  43
  44 $maskpri = &LOG_UPTO(&LOG_DEBUG);
  45
  46 sub openlog {
  47     ($ident, $logopt, $facility) = @_;  # package vars
  48     $lo_pid = $logopt =~ /\bpid\b/;
  49     $lo_ndelay = $logopt =~ /\bndelay\b/;
  50     $lo_cons = $logopt =~ /\bcons\b/;
  51     $lo_nowait = $logopt =~ /\bnowait\b/;
  52     &connect if $lo_ndelay;
  53 }
  54
  55 sub closelog {
  56     $facility = $ident = '';
  57     &disconnect;
  58 }
  59
  60 sub setlogmask {
  61     local($oldmask) = $maskpri;
  62     $maskpri = shift;
  63     $oldmask;
  64 }
  65
  66 sub syslog {
  67     local($priority) = shift;
  68     local($mask) = shift;
  69     local($message, $whoami);
  70     local(@words, $num, $numpri, $numfac, $sum);
  71     local($facility) = $facility;       # may need to change temporarily.
  72
  73     croak "syslog: expected both priority and mask" unless $mask && $priority;
  74
  75     @words = split(/\W+/, $priority, 2);# Allow "level" or "level|facility".
  76     undef $numpri;
  77     undef $numfac;
  78     foreach (@words) {
  79         $num = &xlate($_);              # Translate word to number.
  80         if (/^kern$/ || $num < 0) {
  81             croak "syslog: invalid level/facility: $_";
  82         }
  83         elsif ($num <= &LOG_PRIMASK) {
  84             croak "syslog: too many levels given: $_" if defined($numpri);
  85             $numpri = $num;
  86             return 0 unless &LOG_MASK($numpri) & $maskpri;
  87         }
  88         else {
  89             croak "syslog: too many facilities given: $_" if defined($numfac);
  90             $facility = $_;
  91             $numfac = $num;
  92         }
  93     }
  94
  95     croak "syslog: level must be given" unless defined($numpri);
  96
  97     if (!defined($numfac)) {    # Facility not specified in this call.
  98         $facility = 'user' unless $facility;
  99         $numfac = &xlate($facility);
 100     }
 101
 102     &connect unless $connected;
 103
 104     $whoami = $ident;
 105
 106     if (!$ident && $mask =~ /^(\S.*):\s?(.*)/) {
 107         $whoami = $1;
 108         $mask = $2;
 109     }
 110
 111     unless ($whoami) {
 112         ($whoami = getlogin) ||
 113             ($whoami = getpwuid($<)) ||
 114                 ($whoami = 'syslog');
 115     }
 116
 117     $whoami .= "[$$]" if $lo_pid;
 118
 119     $mask =~ s/%m/$!/g;
 120     $mask .= "\n" unless $mask =~ /\n$/;
 121     $message = sprintf ($mask, @_);
 122
 123     $sum = $numpri + $numfac;
 124     unless (send(SYSLOG,"<$sum>$whoami: $message",0)) {
 125         if ($lo_cons) {
 126             if ($pid = fork) {
 127                 unless ($lo_nowait) {
 128                     do {$died = wait;} until $died == $pid || $died < 0;
 129                 }
 130             }
 131             else {
 132                 open(CONS,">/dev/console");
 133                 print CONS "<$facility.$priority>$whoami: $message\r";
 134                 exit if defined $pid;           # if fork failed, we're parent
 135                 close CONS;
 136             }
 137         }
 138     }
 139 }
 140
 141 sub xlate {
 142     local($name) = @_;
 143     $name =~ y/a-z/A-Z/;
 144     $name = "LOG_$name" unless $name =~ /^LOG_/;
 145     $name = "Sys::Syslog::$name";
 146     eval(&$name) || -1;
 147 }
 148
 149 sub connect {
 150     $pat = 'S n C4 x8';
 151
 152     $af_unix = AF_UNIX();
 153     $af_inet = AF_INET();
 154
 155     $stream = SOCK_STREAM();
 156     $datagram = SOCK_DGRAM();
 157
 158     ($name,$aliases,$proto) = getprotobyname('udp');
 159     $udp = $proto;
 160
 161     ($name,$aliase,$port,$proto) = getservbyname('syslog','udp');
 162     $syslog = $port;
 163
 164     if ($myname = hostname()) {
 165         ($name,$aliases,$addrtype,$length,@addrs) = gethostbyname($myname);
 166         croak "Can't lookup $myname" unless $name;
 167         @bytes = unpack("C4",$addrs[0]);
 168     }
 169     else {
 170         @bytes = (0,0,0,0);
 171     }
 172     $this = pack($pat, $af_inet, 0, @bytes);
 173
 174     if ($host =~ /^\d+\./) {
 175         @bytes = split(/\./,$host);
 176     }
 177     else {
 178         ($name,$aliases,$addrtype,$length,@addrs) = gethostbyname($host);
 179         croak "Can't lookup $host" unless $name;
 180         @bytes = unpack("C4",$addrs[0]);
 181     }
 182     $that = pack($pat,$af_inet,$syslog,@bytes);
 183
 184     socket(SYSLOG,$af_inet,$datagram,$udp) || croak "socket: $!";
 185     bind(SYSLOG,$this) || croak "bind: $!";
 186     connect(SYSLOG,$that) || croak "connect: $!";
 187
 188     local($old) = select(SYSLOG); $| = 1; select($old);
 189     $connected = 1;
 190 }
 191
 192 sub disconnect {
 193     close SYSLOG;
 194     $connected = 0;
 195 }
 196
 197 1;
 198