From: Sébastien Aperghis-Tramoni Date: Fri, 6 Jun 2008 01:23:30 +0000 (+0200) Subject: Re: CPAN Upload: S/SA/SAPER/Sys-Syslog-0.25.tar.gz X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=f93f88eb61a94bcdbb547d21f149a2227a5a4d40;p=p5sagit%2Fp5-mst-13.2.git Re: CPAN Upload: S/SA/SAPER/Sys-Syslog-0.25.tar.gz Message-Id: p4raw-id: //depot/perl@34005 --- diff --git a/ext/Sys/Syslog/Changes b/ext/Sys/Syslog/Changes index c780486..3696fa4 100644 --- a/ext/Sys/Syslog/Changes +++ b/ext/Sys/Syslog/Changes @@ -1,5 +1,30 @@ Revision history for Sys-Syslog +0.25 -- 2008.05.17 -- Sebastien Aperghis-Tramoni (SAPER) + [BUGFIX] CPAN-RT#34691: Fixed an incorrect call to sysopen() which + prevented Sys::Syslog from working on some Solaris systems. + Thanks to Paul Townsend. + [BUGFIX] CPAN-RT#34753: Fixed a slowness introduced in v0.19 (which + was to work around OSX syslog own slowness). Thanks to Alex Efros. + [BUGFIX] CPAN-RT#35952: Fixed a bug with the "nofatal" option. + [BUGFIX] Fixed build on Win32, thanks to Adam Kennedy. + [FEATURE] setlogsock() now interprets the second argument as the + hostname for network mechanisms. + [DIST] Add AUTHOR to WriteMakefile() in order to fix the META.yml + generated by ExtUtils::MakeMaker. + [TESTS] Improved t/pod.t with Pod::Checker. + +0.24 -- 2007.12.31 -- Sebastien Aperghis-Tramoni (SAPER) + [BUGFIX] CPANT-RT#32001: Skip the setlogsock('stream') tests when + /dev/log is unavailable (Brendan O'Dea). + +0.23 -- 2007.11.12 -- Sebastien Aperghis-Tramoni (SAPER) + [BUGFIX] Fixed a too liberal test in the "pipe" mechanism, thanks + to Jan Dubois. + [DIST] fallback/syslog.h was missing from MANIFEST (thanks to CPAN + Tester Matthew Musgrove). + [TESTS] Better handling of Perl 5.005, thanks to CPAN Tester Slaven Rezic. + 0.22 -- 2007.11.08 -- Sebastien Aperghis-Tramoni (SAPER) [BUGFIX] CPAN-RT#29875: Added workaround SpamAssassin overzealous logging features. @@ -33,6 +58,8 @@ Revision history for Sys-Syslog via syslog(). [BUGFIX] Rewrote the constants generation code in order to provide fallback value for non-standard macros. + [BUGFIX] Mark Blackman and Edmund von der Burg identified and fixed the + random failures appearing on OSX, caused by a UDP timeout. [FEATURE] Added Win32 event log support thanks to Yves Orton. [FEATURE] Added new macros from modern BSD and IRIX. [FEATURE] Each non-standard macro now fall backs to a standard macro. diff --git a/ext/Sys/Syslog/Makefile.PL b/ext/Sys/Syslog/Makefile.PL index 7c04270..508dfe7 100644 --- a/ext/Sys/Syslog/Makefile.PL +++ b/ext/Sys/Syslog/Makefile.PL @@ -29,11 +29,14 @@ if ($use_eventlog) { print " * Win32::EventLog detected.\n"; my $name = "PerlLog"; - push @extra_prereqs, "Win32::TieRegistry" => 0, "Win32::EventLog" => 0; + push @extra_prereqs, + Win32 => 0, "Win32::TieRegistry" => 0, "Win32::EventLog" => 0; $virtual_path{'win32/Win32.pm' } = '$(INST_LIBDIR)/Syslog/Win32.pm'; $virtual_path{'win32/PerlLog.dll'} = '$(INST_ARCHAUTODIR)/PerlLog.dll'; + push @extra_params, CCFLAGS => "-Ifallback"; + # recreate the DLL from its uuencoded form if it's not here if (! -f File::Spec->catfile("win32", "$name.dll")) { # read the uuencoded data @@ -76,19 +79,31 @@ push @extra_prereqs, "warnings::compat" if $] < 5.006; WriteMakefile( NAME => 'Sys::Syslog', LICENSE => 'perl', + AUTHOR => 'Sebastien Aperghis-Tramoni ', VERSION_FROM => 'Syslog.pm', ABSTRACT_FROM => 'Syslog.pm', INSTALLDIRS => 'perl', XSPROTOARG => '-noprototypes', PM => \%virtual_path, PREREQ_PM => { - 'Test::More' => 0, - 'XSLoader' => 0, + # run prereqs + 'Carp' => 0, + 'Fcntl' => 0, + 'File::Basename' => 0, + 'File::Spec' => 0, + 'POSIX' => 0, + 'Socket' => 0, + 'XSLoader' => 0, @extra_prereqs, + + # build/test prereqs + 'Test::More' => 0, }, dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', }, clean => { FILES => 'Sys-Syslog-*' }, - realclean => { FILES => 'lib const-c.inc const-xs.inc macros.all PerlLog.h *.bak *.bin *.rc' }, + realclean => { FILES => 'lib const-c.inc const-xs.inc macros.all ' + .'PerlLog.h typemap *.bak *.bin *.rc win32/PerlLog_dll' }, + NO_META => 1, @extra_params ); diff --git a/ext/Sys/Syslog/README b/ext/Sys/Syslog/README index e3e693c..68bf1b6 100644 --- a/ext/Sys/Syslog/README +++ b/ext/Sys/Syslog/README @@ -63,5 +63,7 @@ SUPPORT AND DOCUMENTATION COPYRIGHT AND LICENCE + Copyright (C) 1990-2008 by Larry Wall and others. + This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. diff --git a/ext/Sys/Syslog/Syslog.pm b/ext/Sys/Syslog/Syslog.pm index 631f4bc..898e36b 100644 --- a/ext/Sys/Syslog/Syslog.pm +++ b/ext/Sys/Syslog/Syslog.pm @@ -1,16 +1,17 @@ package Sys::Syslog; use strict; +use warnings; use warnings::register; use Carp; +use Exporter (); use Fcntl qw(O_WRONLY); use File::Basename; use POSIX qw(strftime setlocale LC_TIME); use Socket ':all'; require 5.005; -require Exporter; { no strict 'vars'; - $VERSION = '0.24'; + $VERSION = '0.25'; @ISA = qw(Exporter); %EXPORT_TAGS = ( @@ -76,6 +77,11 @@ require Exporter; # use vars qw($host); # host to send syslog messages to (see notes at end) +# +# Prototypes +# +sub silent_eval (&); + # # Global variables # @@ -85,6 +91,7 @@ my $syslog_send; # coderef of the function used to send messages my $syslog_path = undef; # syslog path for "stream" and "unix" mechanisms my $syslog_xobj = undef; # if defined, holds the external object used to send messages my $transmit_ok = 0; # flag to indicate if the last message was transmited +my $sock_timeout = 0; # socket timeout, see below my $current_proto = undef; # current mechanism used to transmit messages my $ident = ''; # identifiant prepended to each message $facility = ''; # current facility @@ -105,15 +112,12 @@ if ($^O =~ /^(freebsd|linux)$/) { @connectMethods = grep { $_ ne 'udp' } @connectMethods; } +# And on Win32 systems, we try to use the native mechanism for this +# platform, the events logger, available through Win32::EventLog. EVENTLOG: { - # use EventLog on Win32 my $is_Win32 = $^O =~ /Win32/i; - # some applications are trying to be too smart - # yes I'm speaking of YOU, SpamAssassin, grr.. - local($SIG{__DIE__}, $SIG{__WARN__}, $@); - - if (eval "use Sys::Syslog::Win32; 1") { + if (can_load("Sys::Syslog::Win32")) { unshift @connectMethods, 'eventlog'; } elsif ($is_Win32) { @@ -124,6 +128,18 @@ EVENTLOG: { my @defaultMethods = @connectMethods; my @fallbackMethods = (); +# The timeout in connection_ok() was pushed up to 0.25 sec in +# Sys::Syslog v0.19 in order to address a heisenbug on MacOSX: +# http://london.pm.org/pipermail/london.pm/Week-of-Mon-20061211/005961.html +# +# However, this also had the effect of slowing this test for +# all other operating systems, which apparently impacted some +# users (cf. CPAN-RT #34753). So, in order to make everybody +# happy, the timeout is now zero by default on all systems +# except on OSX where it is set to 250 msec, and can be set +# with the infamous setlogsock() function. +$sock_timeout = 0.25 if $^O =~ /darwin/; + # coderef for a nicer handling of errors my $err_sub = $options{nofatal} ? \&warnings::warnif : \&croak; @@ -155,7 +171,7 @@ sub openlog { $options{$opt} = 1 if exists $options{$opt} } - $err_sub = $options{nofatal} ? \&warnings::warnif : \&croak; + $err_sub = delete $options{nofatal} ? \&warnings::warnif : \&croak; return 1 unless $options{ndelay}; connect_log(); } @@ -172,8 +188,11 @@ sub setlogmask { } sub setlogsock { - my $setsock = shift; - $syslog_path = shift; + my ($setsock, $setpath, $settime) = @_; + + $syslog_path = $setpath if defined $setpath; + $sock_timeout = $settime if defined $settime; + disconnect_log() if $connected; $transmit_ok = 0; @fallbackMethods = (); @@ -237,7 +256,7 @@ sub setlogsock { @connectMethods = qw(native); } elsif (lc $setsock eq 'eventlog') { - if (eval "use Win32::EventLog; 1") { + if (can_load("Win32::EventLog")) { @connectMethods = qw(eventlog); } else { warnings::warnif "eventlog passed to setlogsock, but no Win32 API available"; @@ -248,6 +267,7 @@ sub setlogsock { } elsif (lc $setsock eq 'tcp') { if (getservbyname('syslog', 'tcp') || getservbyname('syslogng', 'tcp')) { @connectMethods = qw(tcp); + $host = $syslog_path; } else { warnings::warnif "tcp passed to setlogsock, but tcp service unavailable"; return undef; @@ -256,6 +276,7 @@ sub setlogsock { } elsif (lc $setsock eq 'udp') { if (getservbyname('syslog', 'udp')) { @connectMethods = qw(udp); + $host = $syslog_path; } else { warnings::warnif "udp passed to setlogsock, but udp service unavailable"; return undef; @@ -293,25 +314,29 @@ sub syslog { croak "syslog: expecting argument \$priority" unless defined $priority; croak "syslog: expecting argument \$format" unless defined $mask; + croak "syslog: invalid level/facility: $priority" if $priority =~ /^-\d+$/; @words = split(/\W+/, $priority, 2); # Allow "level" or "level|facility". undef $numpri; undef $numfac; - foreach (@words) { - $num = xlate($_); # Translate word to number. - if ($num < 0) { - croak "syslog: invalid level/facility: $_" - } - elsif ($num <= &LOG_PRIMASK) { - croak "syslog: too many levels given: $_" if defined $numpri; - $numpri = $num; - return 0 unless LOG_MASK($numpri) & $maskpri; - } - else { - croak "syslog: too many facilities given: $_" if defined $numfac; - $facility = $_; - $numfac = $num; - } + for my $word (@words) { + next if length $word == 0; + + $num = xlate($word); # Translate word to number. + + if ($num < 0) { + croak "syslog: invalid level/facility: $word" + } + elsif ($num <= &LOG_PRIMASK) { + croak "syslog: too many levels given: $word" if defined $numpri; + $numpri = $num; + return 0 unless LOG_MASK($numpri) & $maskpri; + } + else { + croak "syslog: too many facilities given: $word" if defined $numfac; + $facility = $word; + $numfac = $num; + } } croak "syslog: level must be given" unless defined $numpri; @@ -464,14 +489,14 @@ sub _syslog_send_native { # private function to translate names to numeric values # sub xlate { - my($name) = @_; + my ($name) = @_; + return $name+0 if $name =~ /^\s*\d+\s*$/; $name = uc $name; $name = "LOG_$name" unless $name =~ /^LOG_/; - $name = "Sys::Syslog::$name"; - # Can't have just eval { &$name } || -1 because some LOG_XXX may be zero. - my $value = eval { no strict 'refs'; &$name }; - $@ = ""; + my $value = constant($name); + $value = -1 if $value =~ /not a valid/; + return defined $value ? $value : -1; } @@ -546,11 +571,10 @@ sub connect_tcp { } setsockopt(SYSLOG, SOL_SOCKET, SO_KEEPALIVE, 1); - if (eval { IPPROTO_TCP() }) { + if (silent_eval { IPPROTO_TCP() }) { # These constants don't exist in 5.005. They were added in 1999 setsockopt(SYSLOG, IPPROTO_TCP(), TCP_NODELAY(), 1); } - $@ = ""; if (!connect(SYSLOG, $addr)) { push @$errs, "tcp connect: $!"; return 0; @@ -619,7 +643,7 @@ sub connect_stream { push @$errs, "stream $syslog_path is not writable"; return 0; } - if (!sysopen(SYSLOG, $syslog_path, 0400, O_WRONLY)) { + if (!sysopen(SYSLOG, $syslog_path, O_WRONLY, 0400)) { push @$errs, "stream can't open $syslog_path: $!"; return 0; } @@ -697,12 +721,7 @@ sub connect_native { $logopt += xlate($opt) if $options{$opt} } - eval { openlog_xs($ident, $logopt, xlate($facility)) }; - if ($@) { - push @$errs, $@; - return 0; - } - + openlog_xs($ident, $logopt, xlate($facility)); $syslog_send = \&_syslog_send_native; return 1; @@ -741,7 +760,7 @@ sub connection_ok { my $rin = ''; vec($rin, fileno(SYSLOG), 1) = 1; - my $ret = select $rin, undef, $rin, 0.25; + my $ret = select $rin, undef, $rin, $sock_timeout; return ($ret ? 0 : 1); } @@ -761,7 +780,26 @@ sub disconnect_log { return close SYSLOG; } -1; + +# +# Wrappers around eval() that makes sure that nobody, and I say NOBODY, +# ever knows that I wanted to test if something was here or not. +# It is needed because some applications are trying to be too smart, +# do it wrong, and it ends up in EPIC FAIL. +# Yes I'm speaking of YOU, SpamAssassin. +# +sub silent_eval (&) { + local($SIG{__DIE__}, $SIG{__WARN__}, $@); + return eval $_[0] +} + +sub can_load { + local($SIG{__DIE__}, $SIG{__WARN__}, $@); + return eval "use $_[0]; 1" +} + + +"Eighth Rule: read the documentation." __END__ @@ -771,7 +809,7 @@ Sys::Syslog - Perl interface to the UNIX syslog(3) calls =head1 VERSION -Version 0.24 +Version 0.25 =head1 SYNOPSIS @@ -965,6 +1003,8 @@ Log all messages up to debug: =item B (added in Perl 5.004_02) +=item B (added in 0.25) + Sets the socket type to be used for the next call to C or C and returns true on success, C on failure. The available mechanisms are: @@ -984,15 +1024,18 @@ added in C 0.19). =item * C<"tcp"> - connect to a TCP socket, on the C or C -service. +service. If defined, the second parameter is used as a hostname to connect to. =item * C<"udp"> - connect to a UDP socket, on the C service. +If defined, the second parameter is used as a hostname to connect to, +and the third parameter as the timeout used to check for UDP response. =item * -C<"inet"> - connect to an INET socket, either TCP or UDP, tried in that order. +C<"inet"> - connect to an INET socket, either TCP or UDP, tried in that +order. If defined, the second parameter is used as a hostname to connect to. =item * @@ -1026,7 +1069,8 @@ A reference to an array can also be passed as the first parameter. When this calling method is used, the array should contain a list of mechanisms which are attempted in order. -The default is to try C, C, C, C, C, C. +The default is to try C, C, C, C, C, C, +C. Under systems with the Win32 API, C will be added as the first mechanism to try if C is available. @@ -1113,8 +1157,7 @@ Example of use of C<%m>: Log to UDP port on C<$remotehost> instead of logging locally: - setlogsock('udp'); - $Sys::Syslog::host = $remotehost; + setlogsock("udp", $remotehost); openlog($program, 'ndelay', 'user'); syslog('info', 'something happened over here'); @@ -1342,16 +1385,19 @@ GNU C Library documentation on syslog, L Solaris 10 documentation on syslog, -L +L + +Mac OS X documentation on syslog, +L -IRIX 6.4 documentation on syslog, -L +IRIX 6.5 documentation on syslog, +L AIX 5L 5.3 documentation on syslog, L HP-UX 11i documentation on syslog, -L +L Tru64 5.1 documentation on syslog, L @@ -1455,7 +1501,7 @@ L =head1 COPYRIGHT -Copyright (C) 1990-2007 by Larry Wall and others. +Copyright (C) 1990-2008 by Larry Wall and others. =head1 LICENSE @@ -1518,6 +1564,9 @@ of a bug in Sys::Syslog back then? Links ----- +Linux Fast-STREAMS +- L + II12021: SYSLOGD HOWTO TCPIPINFO (z/OS, OS/390, MVS) - L diff --git a/ext/Sys/Syslog/Syslog.xs b/ext/Sys/Syslog/Syslog.xs index c9d63d5..1786d0a 100644 --- a/ext/Sys/Syslog/Syslog.xs +++ b/ext/Sys/Syslog/Syslog.xs @@ -9,13 +9,13 @@ #define HAVE_SYSLOG 1 #endif -#if defined(I_SYSLOG) || PATCHLEVEL < 6 -#include -#endif - #if defined(_WIN32) && !defined(__CYGWIN__) -#undef HAVE_SYSLOG -#include "fallback/syslog.h" +# undef HAVE_SYSLOG +# include "fallback/syslog.h" +#else +# if defined(I_SYSLOG) || PATCHLEVEL < 6 +# include +# endif #endif static SV *ident_svptr; @@ -126,7 +126,9 @@ setlogmask_xs(mask) INPUT: int mask CODE: - setlogmask(mask); + RETVAL = setlogmask(mask); + OUTPUT: + RETVAL void closelog_xs() diff --git a/ext/Sys/Syslog/t/00-load.t b/ext/Sys/Syslog/t/00-load.t index 3fa291b..bbf2289 100644 --- a/ext/Sys/Syslog/t/00-load.t +++ b/ext/Sys/Syslog/t/00-load.t @@ -2,9 +2,7 @@ use strict; use Test::More tests => 1; -BEGIN { - use_ok( 'Sys::Syslog' ); -} +use_ok( 'Sys::Syslog' ); diag( "Testing Sys::Syslog $Sys::Syslog::VERSION, Perl $], $^X" ) unless $ENV{PERL_CORE}; diff --git a/ext/Sys/Syslog/t/syslog.t b/ext/Sys/Syslog/t/syslog.t index 3b3a5c0..56a83c7 100755 --- a/ext/Sys/Syslog/t/syslog.t +++ b/ext/Sys/Syslog/t/syslog.t @@ -115,35 +115,35 @@ SKIP: { } -BEGIN { $tests += 20 * 8 } +BEGIN { $tests += 22 * 8 } # try to open a syslog using all the available connection methods my @passed = (); for my $sock_type (qw(native eventlog unix pipe stream inet tcp udp)) { SKIP: { - skip "the 'stream' mechanism because a previous mechanism with similar interface succeeded", 20 + skip "the 'stream' mechanism because a previous mechanism with similar interface succeeded", 22 if $sock_type eq 'stream' and grep {/pipe|unix/} @passed; # setlogsock() called with an arrayref $r = eval { setlogsock([$sock_type]) } || 0; - skip "can't use '$sock_type' socket", 20 unless $r; + skip "can't use '$sock_type' socket", 22 unless $r; is( $@, '', "[$sock_type] setlogsock() called with ['$sock_type']" ); ok( $r, "[$sock_type] setlogsock() should return true: '$r'" ); # setlogsock() called with a single argument $r = eval { setlogsock($sock_type) } || 0; - skip "can't use '$sock_type' socket", 18 unless $r; + skip "can't use '$sock_type' socket", 20 unless $r; is( $@, '', "[$sock_type] setlogsock() called with '$sock_type'" ); ok( $r, "[$sock_type] setlogsock() should return true: '$r'" ); # openlog() without option NDELAY $r = eval { openlog('perl', '', 'local0') } || 0; - skip "can't connect to syslog", 16 if $@ =~ /^no connection to syslog available/; + skip "can't connect to syslog", 18 if $@ =~ /^no connection to syslog available/; is( $@, '', "[$sock_type] openlog() called with facility 'local0' and without option 'ndelay'" ); ok( $r, "[$sock_type] openlog() should return true: '$r'" ); # openlog() with the option NDELAY $r = eval { openlog('perl', 'ndelay', 'local0') } || 0; - skip "can't connect to syslog", 14 if $@ =~ /^no connection to syslog available/; + skip "can't connect to syslog", 16 if $@ =~ /^no connection to syslog available/; is( $@, '', "[$sock_type] openlog() called with facility 'local0' with option 'ndelay'" ); ok( $r, "[$sock_type] openlog() should return true: '$r'" ); @@ -152,6 +152,11 @@ for my $sock_type (qw(native eventlog unix pipe stream inet tcp udp)) { like( $@, '/^syslog: invalid level\/facility: /', "[$sock_type] syslog() called with level -1" ); ok( !$r, "[$sock_type] syslog() should return false: '$r'" ); + # syslog() with invalid level, should fail + $r = eval { syslog("plonk", "$test_string by connecting to a $sock_type socket") } || 0; + like( $@, '/^syslog: invalid level\/facility: /', "[$sock_type] syslog() called with level plonk" ); + ok( !$r, "[$sock_type] syslog() should return false: '$r'" ); + # syslog() with levels "info" and "notice" (as a strings), should fail $r = eval { syslog('info,notice', "$test_string by connecting to a $sock_type socket") } || 0; like( $@, '/^syslog: too many levels given: notice/', "[$sock_type] syslog() called with level 'info,notice'" );