Commit | Line | Data |
a0d0e21e |
1 | package Sys::Syslog; |
2 | require 5.000; |
3 | require Exporter; |
4 | use Carp; |
5 | |
6 | @ISA = qw(Exporter); |
8297ae02 |
7 | @EXPORT = qw(openlog closelog setlogmask setlogsock syslog); |
a0d0e21e |
8 | |
37120919 |
9 | use Socket; |
55497cff |
10 | use Sys::Hostname; |
37120919 |
11 | |
5be1dfc7 |
12 | # adapted from syslog.pl |
a0d0e21e |
13 | # |
5be1dfc7 |
14 | # Tom Christiansen <tchrist@convex.com> |
a0d0e21e |
15 | # modified to use sockets by Larry Wall <lwall@jpl-devvax.jpl.nasa.gov> |
16 | # NOTE: openlog now takes three arguments, just like openlog(3) |
8297ae02 |
17 | # Modified to add UNIX domain sockets by Sean Robinson <robinson_s@sc.maricopa.edu> |
18 | # with support from Tim Bunce <Tim.Bunce@ig.co.uk> and the perl5-porters mailing list |
5be1dfc7 |
19 | |
20 | =head1 NAME |
21 | |
8297ae02 |
22 | Sys::Syslog, openlog, closelog, setlogmask, setlogsock, syslog - Perl interface to the UNIX syslog(3) calls |
5be1dfc7 |
23 | |
24 | =head1 SYNOPSIS |
25 | |
26 | use Sys::Syslog; |
27 | |
8297ae02 |
28 | setlogsock $sock_unix; |
5be1dfc7 |
29 | openlog $ident, $logopt, $facility; |
2eae817d |
30 | syslog $priority, $format, @args; |
5be1dfc7 |
31 | $oldmask = setlogmask $mask_priority; |
32 | closelog; |
33 | |
34 | =head1 DESCRIPTION |
35 | |
36 | Sys::Syslog is an interface to the UNIX C<syslog(3)> program. |
37 | Call C<syslog()> with a string priority and a list of C<printf()> args |
38 | just like C<syslog(3)>. |
39 | |
40 | Syslog provides the functions: |
41 | |
42 | =over |
43 | |
44 | =item openlog $ident, $logopt, $facility |
45 | |
46 | I<$ident> is prepended to every message. |
47 | I<$logopt> contains one or more of the words I<pid>, I<ndelay>, I<cons>, I<nowait>. |
48 | I<$facility> specifies the part of the system |
49 | |
2eae817d |
50 | =item syslog $priority, $format, @args |
5be1dfc7 |
51 | |
2eae817d |
52 | If I<$priority> permits, logs I<($format, @args)> |
5be1dfc7 |
53 | printed as by C<printf(3V)>, with the addition that I<%m> |
54 | is replaced with C<"$!"> (the latest error message). |
55 | |
56 | =item setlogmask $mask_priority |
57 | |
58 | Sets log mask I<$mask_priority> and returns the old mask. |
59 | |
8297ae02 |
60 | =item setlogsock $sock_unix |
61 | |
62 | Defines or undefines the boolean I<$sock_unix>; |
63 | a value equalling C<unix> defines I<$sock_unix>, a value |
64 | equalling C<inet >undefines I<$sock_unix>, and any other |
65 | value croaks. |
66 | The I<$sock_unix> boolean determines whether the next |
67 | call to C<openlog()> or C<syslog()> will connect to the |
68 | UNIX domain socket returned by C<_PATH_LOG> in |
69 | I<syslog.ph> or to the INET socket returned by |
70 | getservbyname(). |
71 | |
72 | The default is for the INET socket to be used. |
73 | |
5be1dfc7 |
74 | =item closelog |
75 | |
76 | Closes the log file. |
77 | |
78 | =back |
79 | |
80 | Note that C<openlog> now takes three arguments, just like C<openlog(3)>. |
81 | |
82 | =head1 EXAMPLES |
83 | |
84 | openlog($program, 'cons,pid', 'user'); |
85 | syslog('info', 'this is another test'); |
86 | syslog('mail|warning', 'this is a better test: %d', time); |
87 | closelog(); |
88 | |
89 | syslog('debug', 'this is the last test'); |
8297ae02 |
90 | |
91 | setlogsock('unix'); |
5be1dfc7 |
92 | openlog("$program $$", 'ndelay', 'user'); |
93 | syslog('notice', 'fooprogram: this is really done'); |
94 | |
8297ae02 |
95 | setlogsock('inet'); |
5be1dfc7 |
96 | $! = 55; |
97 | syslog('info', 'problem was %m'); # %m == $! in syslog(3) |
98 | |
99 | =head1 DEPENDENCIES |
100 | |
101 | B<Sys::Syslog> needs F<syslog.ph>, which can be created with C<h2ph>. |
102 | |
103 | =head1 SEE ALSO |
104 | |
105 | L<syslog(3)> |
106 | |
107 | =head1 AUTHOR |
108 | |
8297ae02 |
109 | Tom Christiansen E<lt>F<tchrist@perl.com>E<gt> and Larry Wall E<lt>F<larry@wall.org>E<gt>. |
110 | UNIX domain sockets added by Sean Robinson E<lt>F<robinson_s@sc.maricopa.edu>E<gt> |
111 | with support from Tim Bunce <Tim.Bunce@ig.co.uk> and the perl5-porters mailing list. |
5be1dfc7 |
112 | |
113 | =cut |
a0d0e21e |
114 | |
a0d0e21e |
115 | require 'syslog.ph'; |
116 | |
117 | $maskpri = &LOG_UPTO(&LOG_DEBUG); |
118 | |
119 | sub openlog { |
120 | ($ident, $logopt, $facility) = @_; # package vars |
121 | $lo_pid = $logopt =~ /\bpid\b/; |
122 | $lo_ndelay = $logopt =~ /\bndelay\b/; |
123 | $lo_cons = $logopt =~ /\bcons\b/; |
124 | $lo_nowait = $logopt =~ /\bnowait\b/; |
125 | &connect if $lo_ndelay; |
126 | } |
127 | |
128 | sub closelog { |
129 | $facility = $ident = ''; |
130 | &disconnect; |
131 | } |
132 | |
133 | sub setlogmask { |
134 | local($oldmask) = $maskpri; |
135 | $maskpri = shift; |
136 | $oldmask; |
137 | } |
138 | |
8297ae02 |
139 | sub setlogsock { |
140 | local($setsock) = shift; |
141 | if (lc($setsock) eq 'unix') { |
142 | $sock_unix = 1; |
143 | } elsif (lc($setsock) eq 'inet') { |
144 | undef($sock_unix); |
145 | } else { |
146 | croak "Invalid argument passed to setlogsock; must be 'unix' or 'inet'"; |
147 | } |
148 | } |
149 | |
a0d0e21e |
150 | sub syslog { |
151 | local($priority) = shift; |
152 | local($mask) = shift; |
153 | local($message, $whoami); |
154 | local(@words, $num, $numpri, $numfac, $sum); |
155 | local($facility) = $facility; # may need to change temporarily. |
156 | |
157 | croak "syslog: expected both priority and mask" unless $mask && $priority; |
158 | |
159 | @words = split(/\W+/, $priority, 2);# Allow "level" or "level|facility". |
160 | undef $numpri; |
161 | undef $numfac; |
162 | foreach (@words) { |
163 | $num = &xlate($_); # Translate word to number. |
164 | if (/^kern$/ || $num < 0) { |
165 | croak "syslog: invalid level/facility: $_"; |
166 | } |
167 | elsif ($num <= &LOG_PRIMASK) { |
168 | croak "syslog: too many levels given: $_" if defined($numpri); |
169 | $numpri = $num; |
170 | return 0 unless &LOG_MASK($numpri) & $maskpri; |
171 | } |
172 | else { |
173 | croak "syslog: too many facilities given: $_" if defined($numfac); |
174 | $facility = $_; |
175 | $numfac = $num; |
176 | } |
177 | } |
178 | |
179 | croak "syslog: level must be given" unless defined($numpri); |
180 | |
181 | if (!defined($numfac)) { # Facility not specified in this call. |
182 | $facility = 'user' unless $facility; |
183 | $numfac = &xlate($facility); |
184 | } |
185 | |
186 | &connect unless $connected; |
187 | |
188 | $whoami = $ident; |
189 | |
5dad0344 |
190 | if (!$whoami && $mask =~ /^(\S.*?):\s?(.*)/) { |
a0d0e21e |
191 | $whoami = $1; |
192 | $mask = $2; |
193 | } |
194 | |
195 | unless ($whoami) { |
196 | ($whoami = getlogin) || |
197 | ($whoami = getpwuid($<)) || |
198 | ($whoami = 'syslog'); |
199 | } |
200 | |
201 | $whoami .= "[$$]" if $lo_pid; |
202 | |
203 | $mask =~ s/%m/$!/g; |
204 | $mask .= "\n" unless $mask =~ /\n$/; |
205 | $message = sprintf ($mask, @_); |
206 | |
207 | $sum = $numpri + $numfac; |
8297ae02 |
208 | unless (send(SYSLOG,"<$sum>$whoami: $message\0",0)) { |
a0d0e21e |
209 | if ($lo_cons) { |
210 | if ($pid = fork) { |
211 | unless ($lo_nowait) { |
cb1a09d0 |
212 | $died = waitpid($pid, 0); |
a0d0e21e |
213 | } |
214 | } |
215 | else { |
216 | open(CONS,">/dev/console"); |
217 | print CONS "<$facility.$priority>$whoami: $message\r"; |
218 | exit if defined $pid; # if fork failed, we're parent |
219 | close CONS; |
220 | } |
221 | } |
222 | } |
223 | } |
224 | |
225 | sub xlate { |
226 | local($name) = @_; |
55497cff |
227 | $name = uc $name; |
a0d0e21e |
228 | $name = "LOG_$name" unless $name =~ /^LOG_/; |
748a9306 |
229 | $name = "Sys::Syslog::$name"; |
36477c24 |
230 | defined &$name ? &$name : -1; |
a0d0e21e |
231 | } |
232 | |
233 | sub connect { |
4fc7577b |
234 | unless ($host) { |
235 | require Sys::Hostname; |
2eae817d |
236 | my($host_uniq) = Sys::Hostname::hostname(); |
3e3baf6d |
237 | ($host) = $host_uniq =~ /([A-Za-z0-9_.-]+)/; # allow FQDN (inc _) |
4fc7577b |
238 | } |
8297ae02 |
239 | unless ( $sock_unix ) { |
240 | my $udp = getprotobyname('udp'); |
241 | my $syslog = getservbyname('syslog','udp'); |
242 | my $this = sockaddr_in($syslog, INADDR_ANY); |
243 | my $that = sockaddr_in($syslog, inet_aton($host) || croak "Can't lookup $host"); |
244 | socket(SYSLOG,AF_INET,SOCK_DGRAM,$udp) || croak "socket: $!"; |
245 | connect(SYSLOG,$that) || croak "connect: $!"; |
246 | } else { |
247 | my $syslog = &_PATH_LOG || croak "_PATH_LOG not found in syslog.ph"; |
248 | my $that = sockaddr_un($syslog) || croak "Can't locate $syslog"; |
249 | socket(SYSLOG,AF_UNIX,SOCK_STREAM,0) || croak "open: $!"; |
250 | connect(SYSLOG,$that) || croak "connect: $!"; |
251 | } |
a0d0e21e |
252 | local($old) = select(SYSLOG); $| = 1; select($old); |
253 | $connected = 1; |
254 | } |
255 | |
256 | sub disconnect { |
257 | close SYSLOG; |
258 | $connected = 0; |
259 | } |
260 | |
261 | 1; |