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