This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
deae4f3d6a0a358b4d60a9cfd813c11f0fab1226
[perl5.git] / cpan / Sys-Syslog / Syslog.pm
1 package Sys::Syslog;
2 use strict;
3 use warnings;
4 use warnings::register;
5 use Carp;
6 use Exporter        ();
7 use Fcntl           qw< O_WRONLY >;
8 use File::Basename;
9 use POSIX           qw< strftime setlocale LC_TIME >;
10 use Socket          qw< :all >;
11 require 5.005;
12
13
14 {   no strict 'vars';
15     $VERSION = '0.32';
16     @ISA     = qw< Exporter >;
17
18     %EXPORT_TAGS = (
19         standard => [qw(openlog syslog closelog setlogmask)],
20         extended => [qw(setlogsock)],
21         macros => [
22             # levels
23             qw(
24                 LOG_ALERT LOG_CRIT LOG_DEBUG LOG_EMERG LOG_ERR 
25                 LOG_INFO LOG_NOTICE LOG_WARNING
26             ), 
27
28             # standard facilities
29             qw(
30                 LOG_AUTH LOG_AUTHPRIV LOG_CRON LOG_DAEMON LOG_FTP LOG_KERN
31                 LOG_LOCAL0 LOG_LOCAL1 LOG_LOCAL2 LOG_LOCAL3 LOG_LOCAL4
32                 LOG_LOCAL5 LOG_LOCAL6 LOG_LOCAL7 LOG_LPR LOG_MAIL LOG_NEWS
33                 LOG_SYSLOG LOG_USER LOG_UUCP
34             ),
35             # Mac OS X specific facilities
36             qw( LOG_INSTALL LOG_LAUNCHD LOG_NETINFO LOG_RAS LOG_REMOTEAUTH ),
37             # modern BSD specific facilities
38             qw( LOG_CONSOLE LOG_NTP LOG_SECURITY ),
39             # IRIX specific facilities
40             qw( LOG_AUDIT LOG_LFMT ),
41
42             # options
43             qw(
44                 LOG_CONS LOG_PID LOG_NDELAY LOG_NOWAIT LOG_ODELAY LOG_PERROR 
45             ), 
46
47             # others macros
48             qw(
49                 LOG_FACMASK LOG_NFACILITIES LOG_PRIMASK 
50                 LOG_MASK LOG_UPTO
51             ), 
52         ],
53     );
54
55     @EXPORT = (
56         @{$EXPORT_TAGS{standard}}, 
57     );
58
59     @EXPORT_OK = (
60         @{$EXPORT_TAGS{extended}}, 
61         @{$EXPORT_TAGS{macros}}, 
62     );
63
64     eval {
65         require XSLoader;
66         XSLoader::load('Sys::Syslog', $VERSION);
67         1
68     } or do {
69         require DynaLoader;
70         push @ISA, 'DynaLoader';
71         bootstrap Sys::Syslog $VERSION;
72     };
73 }
74
75
76
77 # Public variables
78
79 use vars qw($host);             # host to send syslog messages to (see notes at end)
80
81 #
82 # Prototypes
83 #
84 sub silent_eval (&);
85
86
87 # Global variables
88
89 use vars qw($facility);
90 my $connected       = 0;        # flag to indicate if we're connected or not
91 my $syslog_send;                # coderef of the function used to send messages
92 my $syslog_path     = undef;    # syslog path for "stream" and "unix" mechanisms
93 my $syslog_xobj     = undef;    # if defined, holds the external object used to send messages
94 my $transmit_ok     = 0;        # flag to indicate if the last message was transmitted
95 my $sock_port       = undef;    # socket port
96 my $sock_timeout    = 0;        # socket timeout, see below
97 my $current_proto   = undef;    # current mechanism used to transmit messages
98 my $ident           = '';       # identifiant prepended to each message
99 $facility           = '';       # current facility
100 my $maskpri         = LOG_UPTO(&LOG_DEBUG);     # current log mask
101
102 my %options = (
103     ndelay  => 0, 
104     noeol   => 0,
105     nofatal => 0, 
106     nonul   => 0,
107     nowait  => 0, 
108     perror  => 0, 
109     pid     => 0, 
110 );
111
112 # Default is now to first use the native mechanism, so Perl programs 
113 # behave like other normal Unix programs, then try other mechanisms.
114 my @connectMethods = qw(native tcp udp unix pipe stream console);
115 if ($^O eq "freebsd" or $^O eq "linux") {
116     @connectMethods = grep { $_ ne 'udp' } @connectMethods;
117 }
118
119 # And on Win32 systems, we try to use the native mechanism for this 
120 # platform, the events logger, available through Win32::EventLog.
121 EVENTLOG: {
122     my $is_Win32 = $^O =~ /Win32/i;
123
124     if (can_load("Sys::Syslog::Win32", $is_Win32)) {
125         unshift @connectMethods, 'eventlog';
126     }
127 }
128
129 my @defaultMethods = @connectMethods;
130 my @fallbackMethods = ();
131
132 # The timeout in connection_ok() was pushed up to 0.25 sec in 
133 # Sys::Syslog v0.19 in order to address a heisenbug on MacOSX:
134 # http://london.pm.org/pipermail/london.pm/Week-of-Mon-20061211/005961.html
135
136 # However, this also had the effect of slowing this test for 
137 # all other operating systems, which apparently impacted some 
138 # users (cf. CPAN-RT #34753). So, in order to make everybody 
139 # happy, the timeout is now zero by default on all systems 
140 # except on OSX where it is set to 250 msec, and can be set 
141 # with the infamous setlogsock() function.
142 #
143 # Update 2011-08: this issue is also been seen on multiprocessor
144 # Debian GNU/kFreeBSD systems. See http://bugs.debian.org/627821
145 # and https://rt.cpan.org/Ticket/Display.html?id=69997
146 # Also, lowering the delay to 1 ms, which should be enough.
147
148 $sock_timeout = 0.001 if $^O =~ /darwin|gnukfreebsd/;
149
150
151 # Perl 5.6.0's warnings.pm doesn't have warnings::warnif()
152 if (not defined &warnings::warnif) {
153     *warnings::warnif = sub {
154         goto &warnings::warn if warnings::enabled(__PACKAGE__)
155     }
156 }
157
158 # coderef for a nicer handling of errors
159 my $err_sub = $options{nofatal} ? \&warnings::warnif : \&croak;
160
161
162 sub AUTOLOAD {
163     # This AUTOLOAD is used to 'autoload' constants from the constant()
164     # XS function.
165     no strict 'vars';
166     my $constname;
167     ($constname = $AUTOLOAD) =~ s/.*:://;
168     croak "Sys::Syslog::constant() not defined" if $constname eq 'constant';
169     my ($error, $val) = constant($constname);
170     croak $error if $error;
171     no strict 'refs';
172     *$AUTOLOAD = sub { $val };
173     goto &$AUTOLOAD;
174 }
175
176
177 sub openlog {
178     ($ident, my $logopt, $facility) = @_;
179
180     # default values
181     $ident    ||= basename($0) || getlogin() || getpwuid($<) || 'syslog';
182     $logopt   ||= '';
183     $facility ||= LOG_USER();
184
185     for my $opt (split /\b/, $logopt) {
186         $options{$opt} = 1 if exists $options{$opt}
187     }
188
189     $err_sub = delete $options{nofatal} ? \&warnings::warnif : \&croak;
190     return 1 unless $options{ndelay};
191     connect_log();
192
193
194 sub closelog {
195     disconnect_log() if $connected;
196     $options{$_} = 0 for keys %options;
197     $facility = $ident = "";
198     $connected = 0;
199     return 1
200
201
202 sub setlogmask {
203     my $oldmask = $maskpri;
204     $maskpri = shift unless $_[0] == 0;
205     $oldmask;
206 }
207
208
209 my %mechanism = (
210     console => {
211         check   => sub { 1 },
212     },
213     eventlog => {
214         check   => sub { return can_load("Win32::EventLog") },
215         err_msg => "no Win32 API available",
216     },
217     inet => {
218         check   => sub { 1 },
219     },
220     native => {
221         check   => sub { 1 },
222     },
223     pipe => {
224         check   => sub {
225             ($syslog_path) = grep { defined && length && -p && -w _ }
226                                 $syslog_path, &_PATH_LOG, "/dev/log";
227             return $syslog_path ? 1 : 0
228         },
229         err_msg => "path not available",
230     },
231     stream => {
232         check   => sub {
233             if (not defined $syslog_path) {
234                 my @try = qw(/dev/log /dev/conslog);
235                 unshift @try, &_PATH_LOG  if length &_PATH_LOG;
236                 ($syslog_path) = grep { -w } @try;
237             }
238             return defined $syslog_path && -w $syslog_path
239         },
240         err_msg => "could not find any writable device",
241     },
242     tcp => {
243         check   => sub {
244             return 1 if defined $sock_port;
245
246             if (getservbyname('syslog', 'tcp') || getservbyname('syslogng', 'tcp')) {
247                 $host = $syslog_path;
248                 return 1
249             }
250             else {
251                 return
252             }
253         },
254         err_msg => "TCP service unavailable",
255     },
256     udp => {
257         check   => sub {
258             return 1 if defined $sock_port;
259
260             if (getservbyname('syslog', 'udp')) {
261                 $host = $syslog_path;
262                 return 1
263             }
264             else {
265                 return
266             }
267         },
268         err_msg => "UDP service unavailable",
269     },
270     unix => {
271         check   => sub {
272             my @try = ($syslog_path, &_PATH_LOG);
273             ($syslog_path) = grep { defined && length && -w } @try;
274             return defined $syslog_path && -w $syslog_path
275         },
276         err_msg => "path not available",
277     },
278 );
279  
280 sub setlogsock {
281     my %opt;
282
283     # handle arguments
284     # - old API: setlogsock($sock_type, $sock_path, $sock_timeout)
285     # - new API: setlogsock(\%options)
286     croak "setlogsock(): Invalid number of arguments"
287         unless @_ >= 1 and @_ <= 3;
288
289     if (my $ref = ref $_[0]) {
290         if ($ref eq "HASH") {
291             %opt = %{ $_[0] };
292             croak "setlogsock(): No argument given" unless keys %opt;
293         }
294         elsif ($ref eq "ARRAY") {
295             @opt{qw< type path timeout >} = @_;
296         }
297         else {
298             croak "setlogsock(): Unexpected \L$ref\E reference"
299         }
300     }
301     else {
302         @opt{qw< type path timeout >} = @_;
303     }
304
305     # check socket type, remove invalid ones
306     my $diag_invalid_type = "setlogsock(): Invalid type%s; must be one of "
307                           . join ", ", map { "'$_'" } sort keys %mechanism;
308     croak sprintf $diag_invalid_type, "" unless defined $opt{type};
309     my @sock_types = ref $opt{type} eq "ARRAY" ? @{$opt{type}} : ($opt{type});
310     my @tmp;
311
312     for my $sock_type (@sock_types) {
313         carp sprintf $diag_invalid_type, " '$sock_type'" and next
314             unless exists $mechanism{$sock_type};
315         push @tmp, "tcp", "udp" and next  if $sock_type eq "inet";
316         push @tmp, $sock_type;
317     }
318
319     @sock_types = @tmp;
320
321     # set global options
322     $syslog_path  = $opt{path}    if defined $opt{path};
323     $host         = $opt{host}    if defined $opt{host};
324     $sock_timeout = $opt{timeout} if defined $opt{timeout};
325     $sock_port    = $opt{port}    if defined $opt{port};
326
327     disconnect_log() if $connected;
328     $transmit_ok = 0;
329     @fallbackMethods = ();
330     @connectMethods = ();
331     my $found = 0;
332
333     # check each given mechanism and test if it can be used on the current system
334     for my $sock_type (@sock_types) {
335         if ( $mechanism{$sock_type}{check}->() ) {
336             push @connectMethods, $sock_type;
337             $found = 1;
338         }
339         else {
340             warnings::warnif("setlogsock(): type='$sock_type': "
341                            . $mechanism{$sock_type}{err_msg});
342         }
343     }
344
345     # if no mechanism worked from the given ones, use the default ones
346     @connectMethods = @defaultMethods unless @connectMethods;
347
348     return $found;
349 }
350
351 sub syslog {
352     my ($priority, $mask, @args) = @_;
353     my ($message, $buf);
354     my (@words, $num, $numpri, $numfac, $sum);
355     my $failed = undef;
356     my $fail_time = undef;
357     my $error = $!;
358
359     # if $ident is undefined, it means openlog() wasn't previously called
360     # so do it now in order to have sensible defaults
361     openlog() unless $ident;
362
363     local $facility = $facility;    # may need to change temporarily.
364
365     croak "syslog: expecting argument \$priority" unless defined $priority;
366     croak "syslog: expecting argument \$format"   unless defined $mask;
367
368     if ($priority =~ /^\d+$/) {
369         $numpri = LOG_PRI($priority);
370         $numfac = LOG_FAC($priority) << 3;
371     }
372     elsif ($priority =~ /^\w+/) {
373         # Allow "level" or "level|facility".
374         @words = split /\W+/, $priority, 2;
375
376         undef $numpri;
377         undef $numfac;
378
379         for my $word (@words) {
380             next if length $word == 0;
381
382             # Translate word to number.
383             $num = xlate($word);
384
385             if ($num < 0) {
386                 croak "syslog: invalid level/facility: $word"
387             }
388             elsif ($num <= LOG_PRIMASK() and $word ne "kern") {
389                 croak "syslog: too many levels given: $word"
390                     if defined $numpri;
391                 $numpri = $num;
392             }
393             else {
394                 croak "syslog: too many facilities given: $word"
395                     if defined $numfac;
396                 $facility = $word if $word =~ /^[A-Za-z]/;
397                 $numfac = $num;
398             }
399         }
400     }
401     else {
402         croak "syslog: invalid level/facility: $priority"
403     }
404
405     croak "syslog: level must be given" unless defined $numpri;
406
407     # don't log if priority is below mask level
408     return 0 unless LOG_MASK($numpri) & $maskpri;
409
410     if (not defined $numfac) {  # Facility not specified in this call.
411         $facility = 'user' unless $facility;
412         $numfac = xlate($facility);
413     }
414
415     connect_log() unless $connected;
416
417     if ($mask =~ /%m/) {
418         # escape percent signs for sprintf()
419         $error =~ s/%/%%/g if @args;
420         # replace %m with $error, if preceded by an even number of percent signs
421         $mask =~ s/(?<!%)((?:%%)*)%m/$1$error/g;
422     }
423
424     $mask .= "\n" unless $mask =~ /\n$/;
425     $message = @args ? sprintf($mask, @args) : $mask;
426
427     if ($current_proto eq 'native') {
428         $buf = $message;
429     }
430     elsif ($current_proto eq 'eventlog') {
431         $buf = $message;
432     }
433     else {
434         my $whoami = $ident;
435         $whoami .= "[$$]" if $options{pid};
436
437         $sum = $numpri + $numfac;
438         my $oldlocale = setlocale(LC_TIME);
439         setlocale(LC_TIME, 'C');
440         my $timestamp = strftime "%b %d %H:%M:%S", localtime;
441         setlocale(LC_TIME, $oldlocale);
442
443         # construct the stream that will be transmitted
444         $buf = "<$sum>$timestamp $whoami: $message";
445
446         # add (or not) a newline
447         $buf .= "\n" if !$options{noeol} and rindex($buf, "\n") == -1;
448
449         # add (or not) a NUL character
450         $buf .= "\0" if !$options{nonul};
451     }
452
453     # handle PERROR option
454     # "native" mechanism already handles it by itself
455     if ($options{perror} and $current_proto ne 'native') {
456         my $whoami = $ident;
457         $whoami .= "[$$]" if $options{pid};
458         print STDERR "$whoami: $message\n";
459     }
460
461     # it's possible that we'll get an error from sending
462     # (e.g. if method is UDP and there is no UDP listener,
463     # then we'll get ECONNREFUSED on the send). So what we
464     # want to do at this point is to fallback onto a different
465     # connection method.
466     while (scalar @fallbackMethods || $syslog_send) {
467         if ($failed && (time - $fail_time) > 60) {
468             # it's been a while... maybe things have been fixed
469             @fallbackMethods = ();
470             disconnect_log();
471             $transmit_ok = 0; # make it look like a fresh attempt
472             connect_log();
473         }
474
475         if ($connected && !connection_ok()) {
476             # Something was OK, but has now broken. Remember coz we'll
477             # want to go back to what used to be OK.
478             $failed = $current_proto unless $failed;
479             $fail_time = time;
480             disconnect_log();
481         }
482
483         connect_log() unless $connected;
484         $failed = undef if ($current_proto && $failed && $current_proto eq $failed);
485
486         if ($syslog_send) {
487             if ($syslog_send->($buf, $numpri, $numfac)) {
488                 $transmit_ok++;
489                 return 1;
490             }
491             # typically doesn't happen, since errors are rare from write().
492             disconnect_log();
493         }
494     }
495     # could not send, could not fallback onto a working
496     # connection method. Lose.
497     return 0;
498 }
499
500 sub _syslog_send_console {
501     my ($buf) = @_;
502
503     # The console print is a method which could block
504     # so we do it in a child process and always return success
505     # to the caller.
506     if (my $pid = fork) {
507
508         if ($options{nowait}) {
509             return 1;
510         } else {
511             if (waitpid($pid, 0) >= 0) {
512                 return ($? >> 8);
513             } else {
514                 # it's possible that the caller has other
515                 # plans for SIGCHLD, so let's not interfere
516                 return 1;
517             }
518         }
519     } else {
520         if (open(CONS, ">/dev/console")) {
521             my $ret = print CONS $buf . "\r";  # XXX: should this be \x0A ?
522             POSIX::_exit $ret if defined $pid;
523             close CONS;
524         }
525
526         POSIX::_exit if defined $pid;
527     }
528 }
529
530 sub _syslog_send_stream {
531     my ($buf) = @_;
532     # XXX: this only works if the OS stream implementation makes a write 
533     # look like a putmsg() with simple header. For instance it works on 
534     # Solaris 8 but not Solaris 7.
535     # To be correct, it should use a STREAMS API, but perl doesn't have one.
536     return syswrite(SYSLOG, $buf, length($buf));
537 }
538
539 sub _syslog_send_pipe {
540     my ($buf) = @_;
541     return print SYSLOG $buf;
542 }
543
544 sub _syslog_send_socket {
545     my ($buf) = @_;
546     return syswrite(SYSLOG, $buf, length($buf));
547     #return send(SYSLOG, $buf, 0);
548 }
549
550 sub _syslog_send_native {
551     my ($buf, $numpri, $numfac) = @_;
552     syslog_xs($numpri|$numfac, $buf);
553     return 1;
554 }
555
556
557 # xlate()
558 # -----
559 # private function to translate names to numeric values
560
561 sub xlate {
562     my ($name) = @_;
563
564     return $name+0 if $name =~ /^\s*\d+\s*$/;
565     $name = uc $name;
566     $name = "LOG_$name" unless $name =~ /^LOG_/;
567
568     # ExtUtils::Constant 0.20 introduced a new way to implement
569     # constants, called ProxySubs.  When it was used to generate
570     # the C code, the constant() function no longer returns the 
571     # correct value.  Therefore, we first try a direct call to 
572     # constant(), and if the value is an error we try to call the 
573     # constant by its full name. 
574     my $value = constant($name);
575
576     if (index($value, "not a valid") >= 0) {
577         $name = "Sys::Syslog::$name";
578         $value = eval { no strict "refs"; &$name };
579         $value = $@ unless defined $value;
580     }
581
582     $value = -1 if index($value, "not a valid") >= 0;
583
584     return defined $value ? $value : -1;
585 }
586
587
588 # connect_log()
589 # -----------
590 # This function acts as a kind of front-end: it tries to connect to 
591 # a syslog service using the selected methods, trying each one in the 
592 # selected order. 
593
594 sub connect_log {
595     @fallbackMethods = @connectMethods unless scalar @fallbackMethods;
596
597     if ($transmit_ok && $current_proto) {
598         # Retry what we were on, because it has worked in the past.
599         unshift(@fallbackMethods, $current_proto);
600     }
601
602     $connected = 0;
603     my @errs = ();
604     my $proto = undef;
605
606     while ($proto = shift @fallbackMethods) {
607         no strict 'refs';
608         my $fn = "connect_$proto";
609         $connected = &$fn(\@errs) if defined &$fn;
610         last if $connected;
611     }
612
613     $transmit_ok = 0;
614     if ($connected) {
615         $current_proto = $proto;
616         my ($old) = select(SYSLOG); $| = 1; select($old);
617     } else {
618         @fallbackMethods = ();
619         $err_sub->(join "\n\t- ", "no connection to syslog available", @errs);
620         return undef;
621     }
622 }
623
624 sub connect_tcp {
625     my ($errs) = @_;
626
627     my $proto = getprotobyname('tcp');
628     if (!defined $proto) {
629         push @$errs, "getprotobyname failed for tcp";
630         return 0;
631     }
632
633     my $port = $sock_port || getservbyname('syslog', 'tcp');
634     $port = getservbyname('syslogng', 'tcp') unless defined $port;
635     if (!defined $port) {
636         push @$errs, "getservbyname failed for syslog/tcp and syslogng/tcp";
637         return 0;
638     }
639
640     my $addr;
641     if (defined $host) {
642         $addr = inet_aton($host);
643         if (!$addr) {
644             push @$errs, "can't lookup $host";
645             return 0;
646         }
647     } else {
648         $addr = INADDR_LOOPBACK;
649     }
650     $addr = sockaddr_in($port, $addr);
651
652     if (!socket(SYSLOG, AF_INET, SOCK_STREAM, $proto)) {
653         push @$errs, "tcp socket: $!";
654         return 0;
655     }
656
657     setsockopt(SYSLOG, SOL_SOCKET, SO_KEEPALIVE, 1);
658     if (silent_eval { IPPROTO_TCP() }) {
659         # These constants don't exist in 5.005. They were added in 1999
660         setsockopt(SYSLOG, IPPROTO_TCP(), TCP_NODELAY(), 1);
661     }
662     if (!connect(SYSLOG, $addr)) {
663         push @$errs, "tcp connect: $!";
664         return 0;
665     }
666
667     $syslog_send = \&_syslog_send_socket;
668
669     return 1;
670 }
671
672 sub connect_udp {
673     my ($errs) = @_;
674
675     my $proto = getprotobyname('udp');
676     if (!defined $proto) {
677         push @$errs, "getprotobyname failed for udp";
678         return 0;
679     }
680
681     my $port = $sock_port || getservbyname('syslog', 'udp');
682     if (!defined $port) {
683         push @$errs, "getservbyname failed for syslog/udp";
684         return 0;
685     }
686
687     my $addr;
688     if (defined $host) {
689         $addr = inet_aton($host);
690         if (!$addr) {
691             push @$errs, "can't lookup $host";
692             return 0;
693         }
694     } else {
695         $addr = INADDR_LOOPBACK;
696     }
697     $addr = sockaddr_in($port, $addr);
698
699     if (!socket(SYSLOG, AF_INET, SOCK_DGRAM, $proto)) {
700         push @$errs, "udp socket: $!";
701         return 0;
702     }
703     if (!connect(SYSLOG, $addr)) {
704         push @$errs, "udp connect: $!";
705         return 0;
706     }
707
708     # We want to check that the UDP connect worked. However the only
709     # way to do that is to send a message and see if an ICMP is returned
710     _syslog_send_socket("");
711     if (!connection_ok()) {
712         push @$errs, "udp connect: nobody listening";
713         return 0;
714     }
715
716     $syslog_send = \&_syslog_send_socket;
717
718     return 1;
719 }
720
721 sub connect_stream {
722     my ($errs) = @_;
723     # might want syslog_path to be variable based on syslog.h (if only
724     # it were in there!)
725     $syslog_path = '/dev/conslog' unless defined $syslog_path; 
726     if (!-w $syslog_path) {
727         push @$errs, "stream $syslog_path is not writable";
728         return 0;
729     }
730     if (!sysopen(SYSLOG, $syslog_path, O_WRONLY, 0400)) {
731         push @$errs, "stream can't open $syslog_path: $!";
732         return 0;
733     }
734     $syslog_send = \&_syslog_send_stream;
735     return 1;
736 }
737
738 sub connect_pipe {
739     my ($errs) = @_;
740
741     $syslog_path ||= &_PATH_LOG || "/dev/log";
742
743     if (not -w $syslog_path) {
744         push @$errs, "$syslog_path is not writable";
745         return 0;
746     }
747
748     if (not open(SYSLOG, ">$syslog_path")) {
749         push @$errs, "can't write to $syslog_path: $!";
750         return 0;
751     }
752
753     $syslog_send = \&_syslog_send_pipe;
754
755     return 1;
756 }
757
758 sub connect_unix {
759     my ($errs) = @_;
760
761     $syslog_path ||= _PATH_LOG() if length _PATH_LOG();
762
763     if (not defined $syslog_path) {
764         push @$errs, "_PATH_LOG not available in syslog.h and no user-supplied socket path";
765         return 0;
766     }
767
768     if (not (-S $syslog_path or -c _)) {
769         push @$errs, "$syslog_path is not a socket";
770         return 0;
771     }
772
773     my $addr = sockaddr_un($syslog_path);
774     if (!$addr) {
775         push @$errs, "can't locate $syslog_path";
776         return 0;
777     }
778     if (!socket(SYSLOG, AF_UNIX, SOCK_STREAM, 0)) {
779         push @$errs, "unix stream socket: $!";
780         return 0;
781     }
782
783     if (!connect(SYSLOG, $addr)) {
784         if (!socket(SYSLOG, AF_UNIX, SOCK_DGRAM, 0)) {
785             push @$errs, "unix dgram socket: $!";
786             return 0;
787         }
788         if (!connect(SYSLOG, $addr)) {
789             push @$errs, "unix dgram connect: $!";
790             return 0;
791         }
792     }
793
794     $syslog_send = \&_syslog_send_socket;
795
796     return 1;
797 }
798
799 sub connect_native {
800     my ($errs) = @_;
801     my $logopt = 0;
802
803     # reconstruct the numeric equivalent of the options
804     for my $opt (keys %options) {
805         $logopt += xlate($opt) if $options{$opt}
806     }
807
808     openlog_xs($ident, $logopt, xlate($facility));
809     $syslog_send = \&_syslog_send_native;
810
811     return 1;
812 }
813
814 sub connect_eventlog {
815     my ($errs) = @_;
816
817     $syslog_xobj = Sys::Syslog::Win32::_install();
818     $syslog_send = \&Sys::Syslog::Win32::_syslog_send;
819
820     return 1;
821 }
822
823 sub connect_console {
824     my ($errs) = @_;
825     if (!-w '/dev/console') {
826         push @$errs, "console is not writable";
827         return 0;
828     }
829     $syslog_send = \&_syslog_send_console;
830     return 1;
831 }
832
833 # To test if the connection is still good, we need to check if any
834 # errors are present on the connection. The errors will not be raised
835 # by a write. Instead, sockets are made readable and the next read
836 # would cause the error to be returned. Unfortunately the syslog 
837 # 'protocol' never provides anything for us to read. But with 
838 # judicious use of select(), we can see if it would be readable...
839 sub connection_ok {
840     return 1 if defined $current_proto and (
841         $current_proto eq 'native' or $current_proto eq 'console'
842         or $current_proto eq 'eventlog'
843     );
844
845     my $rin = '';
846     vec($rin, fileno(SYSLOG), 1) = 1;
847     my $ret = select $rin, undef, $rin, $sock_timeout;
848     return ($ret ? 0 : 1);
849 }
850
851 sub disconnect_log {
852     $connected = 0;
853     $syslog_send = undef;
854
855     if (defined $current_proto and $current_proto eq 'native') {
856         closelog_xs();
857         unshift @fallbackMethods, $current_proto;
858         $current_proto = undef;
859         return 1;
860     }
861     elsif (defined $current_proto and $current_proto eq 'eventlog') {
862         $syslog_xobj->Close();
863         unshift @fallbackMethods, $current_proto;
864         $current_proto = undef;
865         return 1;
866     }
867
868     return close SYSLOG;
869 }
870
871
872 #
873 # Wrappers around eval() that makes sure that nobody, and I say NOBODY, 
874 # ever knows that I wanted to test if something was here or not. 
875 # It is needed because some applications are trying to be too smart,
876 # do it wrong, and it ends up in EPIC FAIL. 
877 # Yes I'm speaking of YOU, SpamAssassin.
878 #
879 sub silent_eval (&) {
880     local($SIG{__DIE__}, $SIG{__WARN__}, $@);
881     return eval { $_[0]->() }
882 }
883
884 sub can_load {
885     my ($module, $verbose) = @_;
886     local($SIG{__DIE__}, $SIG{__WARN__}, $@);
887     my $loaded = eval "use $module; 1";
888     warn $@ if not $loaded and $verbose;
889     return $loaded
890 }
891
892
893 "Eighth Rule: read the documentation."
894
895 __END__
896
897 =head1 NAME
898
899 Sys::Syslog - Perl interface to the UNIX syslog(3) calls
900
901 =head1 VERSION
902
903 This is the documentation of version 0.32
904
905 =head1 SYNOPSIS
906
907     use Sys::Syslog;                        # all except setlogsock()
908     use Sys::Syslog qw(:standard :macros);  # standard functions & macros
909
910     openlog($ident, $logopt, $facility);    # don't forget this
911     syslog($priority, $format, @args);
912     $oldmask = setlogmask($mask_priority);
913     closelog();
914
915
916 =head1 DESCRIPTION
917
918 C<Sys::Syslog> is an interface to the UNIX C<syslog(3)> program.
919 Call C<syslog()> with a string priority and a list of C<printf()> args
920 just like C<syslog(3)>.
921
922
923 =head1 EXPORTS
924
925 C<Sys::Syslog> exports the following C<Exporter> tags: 
926
927 =over 4
928
929 =item *
930
931 C<:standard> exports the standard C<syslog(3)> functions: 
932
933     openlog closelog setlogmask syslog
934
935 =item *
936
937 C<:extended> exports the Perl specific functions for C<syslog(3)>: 
938
939     setlogsock
940
941 =item *
942
943 C<:macros> exports the symbols corresponding to most of your C<syslog(3)> 
944 macros and the C<LOG_UPTO()> and C<LOG_MASK()> functions. 
945 See L<"CONSTANTS"> for the supported constants and their meaning. 
946
947 =back
948
949 By default, C<Sys::Syslog> exports the symbols from the C<:standard> tag. 
950
951
952 =head1 FUNCTIONS
953
954 =over 4
955
956 =item B<openlog($ident, $logopt, $facility)>
957
958 Opens the syslog.
959 C<$ident> is prepended to every message.  C<$logopt> contains zero or
960 more of the options detailed below.  C<$facility> specifies the part 
961 of the system to report about, for example C<LOG_USER> or C<LOG_LOCAL0>:
962 see L<"Facilities"> for a list of well-known facilities, and your 
963 C<syslog(3)> documentation for the facilities available in your system. 
964 Check L<"SEE ALSO"> for useful links. Facility can be given as a string 
965 or a numeric macro. 
966
967 This function will croak if it can't connect to the syslog daemon.
968
969 Note that C<openlog()> now takes three arguments, just like C<openlog(3)>.
970
971 B<You should use C<openlog()> before calling C<syslog()>.>
972
973 B<Options>
974
975 =over 4
976
977 =item *
978
979 C<cons> - This option is ignored, since the failover mechanism will drop 
980 down to the console automatically if all other media fail.
981
982 =item *
983
984 C<ndelay> - Open the connection immediately (normally, the connection is
985 opened when the first message is logged).
986
987 =item *
988
989 C<noeol> - When set to true, no end of line character (C<\n>) will be
990 appended to the message. This can be useful for some buggy syslog daemons.
991
992 =item *
993
994 C<nofatal> - When set to true, C<openlog()> and C<syslog()> will only 
995 emit warnings instead of dying if the connection to the syslog can't 
996 be established. 
997
998 =item *
999
1000 C<nonul> - When set to true, no C<NUL> character (C<\0>) will be
1001 appended to the message. This can be useful for some buggy syslog daemons.
1002
1003 =item *
1004
1005 C<nowait> - Don't wait for child processes that may have been created 
1006 while logging the message.  (The GNU C library does not create a child
1007 process, so this option has no effect on Linux.)
1008
1009 =item *
1010
1011 C<perror> - Write the message to standard error output as well to the
1012 system log (added in C<Sys::Syslo> 0.22).
1013
1014 =item *
1015
1016 C<pid> - Include PID with each message.
1017
1018 =back
1019
1020 B<Examples>
1021
1022 Open the syslog with options C<ndelay> and C<pid>, and with facility C<LOCAL0>: 
1023
1024     openlog($name, "ndelay,pid", "local0");
1025
1026 Same thing, but this time using the macro corresponding to C<LOCAL0>: 
1027
1028     openlog($name, "ndelay,pid", LOG_LOCAL0);
1029
1030
1031 =item B<syslog($priority, $message)>
1032
1033 =item B<syslog($priority, $format, @args)>
1034
1035 If C<$priority> permits, logs C<$message> or C<sprintf($format, @args)>
1036 with the addition that C<%m> in $message or C<$format> is replaced with
1037 C<"$!"> (the latest error message). 
1038
1039 C<$priority> can specify a level, or a level and a facility.  Levels and 
1040 facilities can be given as strings or as macros.  When using the C<eventlog>
1041 mechanism, priorities C<DEBUG> and C<INFO> are mapped to event type 
1042 C<informational>, C<NOTICE> and C<WARNING> to C<warning> and C<ERR> to 
1043 C<EMERG> to C<error>.
1044
1045 If you didn't use C<openlog()> before using C<syslog()>, C<syslog()> will 
1046 try to guess the C<$ident> by extracting the shortest prefix of 
1047 C<$format> that ends in a C<":">.
1048
1049 B<Examples>
1050
1051     # informational level
1052     syslog("info", $message);
1053     syslog(LOG_INFO, $message);
1054
1055     # information level, Local0 facility
1056     syslog("info|local0", $message);
1057     syslog(LOG_INFO|LOG_LOCAL0, $message);
1058
1059 =over 4
1060
1061 =item B<Note>
1062
1063 C<Sys::Syslog> version v0.07 and older passed the C<$message> as the 
1064 formatting string to C<sprintf()> even when no formatting arguments
1065 were provided.  If the code calling C<syslog()> might execute with 
1066 older versions of this module, make sure to call the function as
1067 C<syslog($priority, "%s", $message)> instead of C<syslog($priority,
1068 $message)>.  This protects against hostile formatting sequences that
1069 might show up if $message contains tainted data.
1070
1071 =back
1072
1073
1074 =item B<setlogmask($mask_priority)>
1075
1076 Sets the log mask for the current process to C<$mask_priority> and 
1077 returns the old mask.  If the mask argument is 0, the current log mask 
1078 is not modified.  See L<"Levels"> for the list of available levels. 
1079 You can use the C<LOG_UPTO()> function to allow all levels up to a 
1080 given priority (but it only accept the numeric macros as arguments).
1081
1082 B<Examples>
1083
1084 Only log errors: 
1085
1086     setlogmask( LOG_MASK(LOG_ERR) );
1087
1088 Log everything except informational messages: 
1089
1090     setlogmask( ~(LOG_MASK(LOG_INFO)) );
1091
1092 Log critical messages, errors and warnings: 
1093
1094     setlogmask( LOG_MASK(LOG_CRIT)
1095               | LOG_MASK(LOG_ERR)
1096               | LOG_MASK(LOG_WARNING) );
1097
1098 Log all messages up to debug: 
1099
1100     setlogmask( LOG_UPTO(LOG_DEBUG) );
1101
1102
1103 =item B<setlogsock()>
1104
1105 Sets the socket type and options to be used for the next call to C<openlog()>
1106 or C<syslog()>.  Returns true on success, C<undef> on failure.
1107
1108 Being Perl-specific, this function has evolved along time.  It can currently
1109 be called as follow:
1110
1111 =over
1112
1113 =item *
1114
1115 C<setlogsock($sock_type)>
1116
1117 =item *
1118
1119 C<setlogsock($sock_type, $stream_location)> (added in Perl 5.004_02)
1120
1121 =item *
1122
1123 C<setlogsock($sock_type, $stream_location, $sock_timeout)> (added in
1124 C<Sys::Syslog> 0.25)
1125
1126 =item *
1127
1128 C<setlogsock(\%options)> (added in C<Sys::Syslog> 0.28)
1129
1130 =back
1131
1132 The available options are:
1133
1134 =over
1135
1136 =item *
1137
1138 C<type> - equivalent to C<$sock_type>, selects the socket type (or
1139 "mechanism").  An array reference can be passed to specify several
1140 mechanisms to try, in the given order.
1141
1142 =item *
1143
1144 C<path> - equivalent to C<$stream_location>, sets the stream location.
1145 Defaults to standard Unix location, or C<_PATH_LOG>.
1146
1147 =item *
1148
1149 C<timeout> - equivalent to C<$sock_timeout>, sets the socket timeout
1150 in seconds.  Defaults to 0 on all systems except S<Mac OS X> where it
1151 is set to 0.25 sec.
1152
1153 =item *
1154
1155 C<host> - sets the hostname to send the messages to.  Defaults to 
1156 the local host.
1157
1158 =item *
1159
1160 C<port> - sets the TCP or UDP port to connect to.  Defaults to the
1161 first standard syslog port available on the system.
1162
1163 =back
1164
1165
1166 The available mechanisms are: 
1167
1168 =over
1169
1170 =item *
1171
1172 C<"native"> - use the native C functions from your C<syslog(3)> library
1173 (added in C<Sys::Syslog> 0.15).
1174
1175 =item *
1176
1177 C<"eventlog"> - send messages to the Win32 events logger (Win32 only; 
1178 added in C<Sys::Syslog> 0.19).
1179
1180 =item *
1181
1182 C<"tcp"> - connect to a TCP socket, on the C<syslog/tcp> or C<syslogng/tcp> 
1183 service.  See also the C<host>, C<port> and C<timeout> options.
1184
1185 =item *
1186
1187 C<"udp"> - connect to a UDP socket, on the C<syslog/udp> service.
1188 See also the C<host>, C<port> and C<timeout> options.
1189
1190 =item *
1191
1192 C<"inet"> - connect to an INET socket, either TCP or UDP, tried in that 
1193 order.  See also the C<host>, C<port> and C<timeout> options.
1194
1195 =item *
1196
1197 C<"unix"> - connect to a UNIX domain socket (in some systems a character 
1198 special device).  The name of that socket is given by the C<path> option
1199 or, if omitted, the value returned by the C<_PATH_LOG> macro (if your
1200 system defines it), F</dev/log> or F</dev/conslog>, whichever is writable.
1201
1202 =item *
1203
1204 C<"stream"> - connect to the stream indicated by the C<path> option, or,
1205 if omitted, the value returned by the C<_PATH_LOG> macro (if your system
1206 defines it), F</dev/log> or F</dev/conslog>, whichever is writable.  For
1207 example Solaris and IRIX system may prefer C<"stream"> instead of C<"unix">. 
1208
1209 =item *
1210
1211 C<"pipe"> - connect to the named pipe indicated by the C<path> option,
1212 or, if omitted, to the value returned by the C<_PATH_LOG> macro (if your
1213 system defines it), or F</dev/log> (added in C<Sys::Syslog> 0.21).
1214 HP-UX is a system which uses such a named pipe.
1215
1216 =item *
1217
1218 C<"console"> - send messages directly to the console, as for the C<"cons"> 
1219 option of C<openlog()>.
1220
1221 =back
1222
1223 The default is to try C<native>, C<tcp>, C<udp>, C<unix>, C<pipe>, C<stream>, 
1224 C<console>.
1225 Under systems with the Win32 API, C<eventlog> will be added as the first 
1226 mechanism to try if C<Win32::EventLog> is available.
1227
1228 Giving an invalid value for C<$sock_type> will C<croak>.
1229
1230 B<Examples>
1231
1232 Select the UDP socket mechanism:
1233
1234     setlogsock("udp");
1235
1236 Send messages using the TCP socket mechanism on a custom port:
1237
1238     setlogsock({ type => "tcp", port => 2486 });
1239
1240 Send messages to a remote host using the TCP socket mechanism:
1241
1242     setlogsock({ type => "tcp", host => $loghost });
1243
1244 Try the native, UDP socket then UNIX domain socket mechanisms: 
1245
1246     setlogsock(["native", "udp", "unix"]);
1247
1248 =over
1249
1250 =item B<Note>
1251
1252 Now that the "native" mechanism is supported by C<Sys::Syslog> and selected 
1253 by default, the use of the C<setlogsock()> function is discouraged because 
1254 other mechanisms are less portable across operating systems.  Authors of 
1255 modules and programs that use this function, especially its cargo-cult form 
1256 C<setlogsock("unix")>, are advised to remove any occurence of it unless they 
1257 specifically want to use a given mechanism (like TCP or UDP to connect to 
1258 a remote host).
1259
1260 =back
1261
1262 =item B<closelog()>
1263
1264 Closes the log file and returns true on success.
1265
1266 =back
1267
1268
1269 =head1 THE RULES OF SYS::SYSLOG
1270
1271 I<The First Rule of Sys::Syslog is:>
1272 You do not call C<setlogsock>.
1273
1274 I<The Second Rule of Sys::Syslog is:>
1275 You B<do not> call C<setlogsock>.
1276
1277 I<The Third Rule of Sys::Syslog is:>
1278 The program crashes, C<die>s, calls C<closelog>, the log is over.
1279
1280 I<The Fourth Rule of Sys::Syslog is:>
1281 One facility, one priority.
1282
1283 I<The Fifth Rule of Sys::Syslog is:>
1284 One log at a time.
1285
1286 I<The Sixth Rule of Sys::Syslog is:>
1287 No C<syslog> before C<openlog>.
1288
1289 I<The Seventh Rule of Sys::Syslog is:>
1290 Logs will go on as long as they have to. 
1291
1292 I<The Eighth, and Final Rule of Sys::Syslog is:>
1293 If this is your first use of Sys::Syslog, you must read the doc.
1294
1295
1296 =head1 EXAMPLES
1297
1298 An example:
1299
1300     openlog($program, 'cons,pid', 'user');
1301     syslog('info', '%s', 'this is another test');
1302     syslog('mail|warning', 'this is a better test: %d', time);
1303     closelog();
1304
1305     syslog('debug', 'this is the last test');
1306
1307 Another example:
1308
1309     openlog("$program $$", 'ndelay', 'user');
1310     syslog('notice', 'fooprogram: this is really done');
1311
1312 Example of use of C<%m>:
1313
1314     $! = 55;
1315     syslog('info', 'problem was %m');   # %m == $! in syslog(3)
1316
1317 Log to UDP port on C<$remotehost> instead of logging locally:
1318
1319     setlogsock("udp", $remotehost);
1320     openlog($program, 'ndelay', 'user');
1321     syslog('info', 'something happened over here');
1322
1323
1324 =head1 CONSTANTS
1325
1326 =head2 Facilities
1327
1328 =over 4
1329
1330 =item *
1331
1332 C<LOG_AUDIT> - audit daemon (IRIX); falls back to C<LOG_AUTH>
1333
1334 =item *
1335
1336 C<LOG_AUTH> - security/authorization messages
1337
1338 =item *
1339
1340 C<LOG_AUTHPRIV> - security/authorization messages (private)
1341
1342 =item *
1343
1344 C<LOG_CONSOLE> - C</dev/console> output (FreeBSD); falls back to C<LOG_USER>
1345
1346 =item *
1347
1348 C<LOG_CRON> - clock daemons (B<cron> and B<at>)
1349
1350 =item *
1351
1352 C<LOG_DAEMON> - system daemons without separate facility value
1353
1354 =item *
1355
1356 C<LOG_FTP> - FTP daemon
1357
1358 =item *
1359
1360 C<LOG_KERN> - kernel messages
1361
1362 =item *
1363
1364 C<LOG_INSTALL> - installer subsystem (Mac OS X); falls back to C<LOG_USER>
1365
1366 =item *
1367
1368 C<LOG_LAUNCHD> - launchd - general bootstrap daemon (Mac OS X);
1369 falls back to C<LOG_DAEMON>
1370
1371 =item *
1372
1373 C<LOG_LFMT> - logalert facility; falls back to C<LOG_USER>
1374
1375 =item *
1376
1377 C<LOG_LOCAL0> through C<LOG_LOCAL7> - reserved for local use
1378
1379 =item *
1380
1381 C<LOG_LPR> - line printer subsystem
1382
1383 =item *
1384
1385 C<LOG_MAIL> - mail subsystem
1386
1387 =item *
1388
1389 C<LOG_NETINFO> - NetInfo subsystem (Mac OS X); falls back to C<LOG_DAEMON>
1390
1391 =item *
1392
1393 C<LOG_NEWS> - USENET news subsystem
1394
1395 =item *
1396
1397 C<LOG_NTP> - NTP subsystem (FreeBSD, NetBSD); falls back to C<LOG_DAEMON>
1398
1399 =item *
1400
1401 C<LOG_RAS> - Remote Access Service (VPN / PPP) (Mac OS X);
1402 falls back to C<LOG_AUTH>
1403
1404 =item *
1405
1406 C<LOG_REMOTEAUTH> - remote authentication/authorization (Mac OS X);
1407 falls back to C<LOG_AUTH>
1408
1409 =item *
1410
1411 C<LOG_SECURITY> - security subsystems (firewalling, etc.) (FreeBSD);
1412 falls back to C<LOG_AUTH>
1413
1414 =item *
1415
1416 C<LOG_SYSLOG> - messages generated internally by B<syslogd>
1417
1418 =item *
1419
1420 C<LOG_USER> (default) - generic user-level messages
1421
1422 =item *
1423
1424 C<LOG_UUCP> - UUCP subsystem
1425
1426 =back
1427
1428
1429 =head2 Levels
1430
1431 =over 4
1432
1433 =item *
1434
1435 C<LOG_EMERG> - system is unusable
1436
1437 =item *
1438
1439 C<LOG_ALERT> - action must be taken immediately
1440
1441 =item *
1442
1443 C<LOG_CRIT> - critical conditions
1444
1445 =item *
1446
1447 C<LOG_ERR> - error conditions
1448
1449 =item *
1450
1451 C<LOG_WARNING> - warning conditions
1452
1453 =item *
1454
1455 C<LOG_NOTICE> - normal, but significant, condition
1456
1457 =item *
1458
1459 C<LOG_INFO> - informational message
1460
1461 =item *
1462
1463 C<LOG_DEBUG> - debug-level message
1464
1465 =back
1466
1467
1468 =head1 DIAGNOSTICS
1469
1470 =over
1471
1472 =item C<Invalid argument passed to setlogsock>
1473
1474 B<(F)> You gave C<setlogsock()> an invalid value for C<$sock_type>. 
1475
1476 =item C<eventlog passed to setlogsock, but no Win32 API available>
1477
1478 B<(W)> You asked C<setlogsock()> to use the Win32 event logger but the 
1479 operating system running the program isn't Win32 or does not provides Win32
1480 compatible facilities.
1481
1482 =item C<no connection to syslog available>
1483
1484 B<(F)> C<syslog()> failed to connect to the specified socket.
1485
1486 =item C<stream passed to setlogsock, but %s is not writable>
1487
1488 B<(W)> You asked C<setlogsock()> to use a stream socket, but the given 
1489 path is not writable. 
1490
1491 =item C<stream passed to setlogsock, but could not find any device>
1492
1493 B<(W)> You asked C<setlogsock()> to use a stream socket, but didn't 
1494 provide a path, and C<Sys::Syslog> was unable to find an appropriate one.
1495
1496 =item C<tcp passed to setlogsock, but tcp service unavailable>
1497
1498 B<(W)> You asked C<setlogsock()> to use a TCP socket, but the service 
1499 is not available on the system. 
1500
1501 =item C<syslog: expecting argument %s>
1502
1503 B<(F)> You forgot to give C<syslog()> the indicated argument.
1504
1505 =item C<syslog: invalid level/facility: %s>
1506
1507 B<(F)> You specified an invalid level or facility.
1508
1509 =item C<syslog: too many levels given: %s>
1510
1511 B<(F)> You specified too many levels. 
1512
1513 =item C<syslog: too many facilities given: %s>
1514
1515 B<(F)> You specified too many facilities. 
1516
1517 =item C<syslog: level must be given>
1518
1519 B<(F)> You forgot to specify a level.
1520
1521 =item C<udp passed to setlogsock, but udp service unavailable>
1522
1523 B<(W)> You asked C<setlogsock()> to use a UDP socket, but the service 
1524 is not available on the system. 
1525
1526 =item C<unix passed to setlogsock, but path not available>
1527
1528 B<(W)> You asked C<setlogsock()> to use a UNIX socket, but C<Sys::Syslog> 
1529 was unable to find an appropriate an appropriate device.
1530
1531 =back
1532
1533
1534 =head1 HISTORY
1535
1536 C<Sys::Syslog> is a core module, part of the standard Perl distribution
1537 since 1990.  At this time, modules as we know them didn't exist, the
1538 Perl library was a collection of F<.pl> files, and the one for sending
1539 syslog messages with was simply F<lib/syslog.pl>, included with Perl 3.0.
1540 It was converted as a module with Perl 5.0, but had a version number
1541 only starting with Perl 5.6.  Here is a small table with the matching
1542 Perl and C<Sys::Syslog> versions.
1543
1544     Sys::Syslog     Perl
1545     -----------     ----
1546        undef        5.0.0 ~ 5.5.4
1547        0.01         5.6.*
1548        0.03         5.8.0
1549        0.04         5.8.1, 5.8.2, 5.8.3
1550        0.05         5.8.4, 5.8.5, 5.8.6
1551        0.06         5.8.7
1552        0.13         5.8.8
1553        0.22         5.10.0
1554        0.27         5.8.9, 5.10.1 ~ 5.14.2
1555        0.29         5.16.0, 5.16.1
1556
1557
1558 =head1 SEE ALSO
1559
1560 =head2 Manual Pages
1561
1562 L<syslog(3)>
1563
1564 SUSv3 issue 6, IEEE Std 1003.1, 2004 edition, 
1565 L<http://www.opengroup.org/onlinepubs/000095399/basedefs/syslog.h.html>
1566
1567 GNU C Library documentation on syslog, 
1568 L<http://www.gnu.org/software/libc/manual/html_node/Syslog.html>
1569
1570 Solaris 10 documentation on syslog, 
1571 L<http://docs.sun.com/app/docs/doc/816-5168/syslog-3c?a=view>
1572
1573 Mac OS X documentation on syslog,
1574 L<http://developer.apple.com/documentation/Darwin/Reference/ManPages/man3/syslog.3.html>
1575
1576 IRIX 6.5 documentation on syslog,
1577 L<http://techpubs.sgi.com/library/tpl/cgi-bin/getdoc.cgi?coll=0650&db=man&fname=3c+syslog>
1578
1579 AIX 5L 5.3 documentation on syslog, 
1580 L<http://publib.boulder.ibm.com/infocenter/pseries/v5r3/index.jsp?topic=/com.ibm.aix.basetechref/doc/basetrf2/syslog.htm>
1581
1582 HP-UX 11i documentation on syslog, 
1583 L<http://docs.hp.com/en/B2355-60130/syslog.3C.html>
1584
1585 Tru64 5.1 documentation on syslog, 
1586 L<http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/V51_HTML/MAN/MAN3/0193____.HTM>
1587
1588 Stratus VOS 15.1, 
1589 L<http://stratadoc.stratus.com/vos/15.1.1/r502-01/wwhelp/wwhimpl/js/html/wwhelp.htm?context=r502-01&file=ch5r502-01bi.html>
1590
1591 =head2 RFCs
1592
1593 I<RFC 3164 - The BSD syslog Protocol>, L<http://www.faqs.org/rfcs/rfc3164.html>
1594 -- Please note that this is an informational RFC, and therefore does not 
1595 specify a standard of any kind.
1596
1597 I<RFC 3195 - Reliable Delivery for syslog>, L<http://www.faqs.org/rfcs/rfc3195.html>
1598
1599 =head2 Articles
1600
1601 I<Syslogging with Perl>, L<http://lexington.pm.org/meetings/022001.html>
1602
1603 =head2 Event Log
1604
1605 Windows Event Log,
1606 L<http://msdn.microsoft.com/library/default.asp?url=/library/en-us/wes/wes/windows_event_log.asp>
1607
1608
1609 =head1 AUTHORS & ACKNOWLEDGEMENTS
1610
1611 Tom Christiansen E<lt>F<tchrist (at) perl.com>E<gt> and Larry Wall
1612 E<lt>F<larry (at) wall.org>E<gt>.
1613
1614 UNIX domain sockets added by Sean Robinson
1615 E<lt>F<robinson_s (at) sc.maricopa.edu>E<gt> with support from Tim Bunce 
1616 E<lt>F<Tim.Bunce (at) ig.co.uk>E<gt> and the C<perl5-porters> mailing list.
1617
1618 Dependency on F<syslog.ph> replaced with XS code by Tom Hughes
1619 E<lt>F<tom (at) compton.nu>E<gt>.
1620
1621 Code for C<constant()>s regenerated by Nicholas Clark E<lt>F<nick (at) ccl4.org>E<gt>.
1622
1623 Failover to different communication modes by Nick Williams
1624 E<lt>F<Nick.Williams (at) morganstanley.com>E<gt>.
1625
1626 Extracted from core distribution for publishing on the CPAN by 
1627 SE<eacute>bastien Aperghis-Tramoni E<lt>sebastien (at) aperghis.netE<gt>.
1628
1629 XS code for using native C functions borrowed from C<L<Unix::Syslog>>, 
1630 written by Marcus Harnisch E<lt>F<marcus.harnisch (at) gmx.net>E<gt>.
1631
1632 Yves Orton suggested and helped for making C<Sys::Syslog> use the native 
1633 event logger under Win32 systems.
1634
1635 Jerry D. Hedden and Reini Urban provided greatly appreciated help to 
1636 debug and polish C<Sys::Syslog> under Cygwin.
1637
1638
1639 =head1 BUGS
1640
1641 Please report any bugs or feature requests to
1642 C<bug-sys-syslog (at) rt.cpan.org>, or through the web interface at
1643 L<http://rt.cpan.org/Public/Dist/Display.html?Name=Sys-Syslog>.
1644 I will be notified, and then you'll automatically be notified of progress on
1645 your bug as I make changes.
1646
1647
1648 =head1 SUPPORT
1649
1650 You can find documentation for this module with the perldoc command.
1651
1652     perldoc Sys::Syslog
1653
1654 You can also look for information at:
1655
1656 =over 4
1657
1658 =item * AnnoCPAN: Annotated CPAN documentation
1659
1660 L<http://annocpan.org/dist/Sys-Syslog>
1661
1662 =item * CPAN Ratings
1663
1664 L<http://cpanratings.perl.org/d/Sys-Syslog>
1665
1666 =item * RT: CPAN's request tracker
1667
1668 L<http://rt.cpan.org/Dist/Display.html?Queue=Sys-Syslog>
1669
1670 =item * Search CPAN
1671
1672 L<http://search.cpan.org/dist/Sys-Syslog/>
1673
1674 =item * MetaCPAN
1675
1676 L<https://metacpan.org/module/Sys::Syslog>
1677
1678 =item * Perl Documentation
1679
1680 L<http://perldoc.perl.org/Sys/Syslog.html>
1681
1682 =back
1683
1684
1685 =head1 COPYRIGHT
1686
1687 Copyright (C) 1990-2012 by Larry Wall and others.
1688
1689
1690 =head1 LICENSE
1691
1692 This program is free software; you can redistribute it and/or modify it
1693 under the same terms as Perl itself.
1694
1695 =cut
1696
1697 =begin comment
1698
1699 Notes for the future maintainer (even if it's still me..)
1700 - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1701
1702 Using Google Code Search, I search who on Earth was relying on $host being 
1703 public. It found 5 hits: 
1704
1705 * First was inside Indigo Star Perl2exe documentation. Just an old version 
1706 of Sys::Syslog. 
1707
1708
1709 * One real hit was inside DalWeathDB, a weather related program. It simply 
1710 does a 
1711
1712     $Sys::Syslog::host = '127.0.0.1';
1713
1714 - L<http://www.gallistel.net/nparker/weather/code/>
1715
1716
1717 * Two hits were in TPC, a fax server thingy. It does a 
1718
1719     $Sys::Syslog::host = $TPC::LOGHOST;
1720
1721 but also has this strange piece of code:
1722
1723     # work around perl5.003 bug
1724     sub Sys::Syslog::hostname {}
1725
1726 I don't know what bug the author referred to.
1727
1728 - L<http://www.tpc.int/>
1729 - L<ftp://ftp-usa.tpc.int/pub/tpc/server/UNIX/>
1730
1731
1732 * Last hit was in Filefix, which seems to be a FIDOnet mail program (!).
1733 This one does not use $host, but has the following piece of code:
1734
1735     sub Sys::Syslog::hostname
1736     {
1737         use Sys::Hostname;
1738         return hostname;
1739     }
1740
1741 I guess this was a more elaborate form of the previous bit, maybe because 
1742 of a bug in Sys::Syslog back then?
1743
1744 - L<ftp://ftp.kiae.su/pub/unix/fido/>
1745
1746
1747 Links
1748 -----
1749 Linux Fast-STREAMS
1750 - L<http://www.openss7.org/streams.html>
1751
1752 II12021: SYSLOGD HOWTO TCPIPINFO (z/OS, OS/390, MVS)
1753 - L<http://www-1.ibm.com/support/docview.wss?uid=isg1II12021>
1754
1755 Getting the most out of the Event Viewer
1756 - L<http://www.codeproject.com/dotnet/evtvwr.asp?print=true>
1757
1758 Log events to the Windows NT Event Log with JNI
1759 - L<http://www.javaworld.com/javaworld/jw-09-2001/jw-0928-ntmessages.html>
1760
1761 =end comment
1762