1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
(* syslog(3) routines for ocaml
This library is based on Shawn Wagner's original syslog
library as included in annexlib, with significant modifications
by by Eric Stokes <eric.stokes@csun.edu>.
Copyright (C) 2002 Shawn Wagner <raevnos@pennmush.org>
Copyright (C) 2005 Eric Stokes <eric.stokes@csun.edu>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*)
open Unix
(** The assorted logging facilities. The default is [`LOG_USER]. You
can set a new default with openlog, or give a specific facility per
syslog call. *)
type facility =
[ `LOG_KERN | `LOG_USER | `LOG_MAIL | `LOG_DAEMON | `LOG_AUTH
| `LOG_SYSLOG | `LOG_LPR | `LOG_NEWS | `LOG_UUCP | `LOG_CRON
| `LOG_AUTHPRIV | `LOG_FTP | `LOG_NTP | `LOG_SECURITY
| `LOG_CONSOLE | `LOG_LOCAL0 | `LOG_LOCAL1 | `LOG_LOCAL2
| `LOG_LOCAL3 | `LOG_LOCAL4 | `LOG_LOCAL5 | `LOG_LOCAL6
| `LOG_LOCAL7 ]
(** Flags to pass to openlog. [`LOG_CONS] isn't implemented yet. *)
type flag = [ `LOG_CONS | `LOG_PERROR | `LOG_PID ]
(** The priority of the error. *)
type level = [ `LOG_EMERG | `LOG_ALERT | `LOG_CRIT | `LOG_ERR | `LOG_WARNING
| `LOG_NOTICE | `LOG_INFO | `LOG_DEBUG ]
exception Syslog_error of string
let facility_of_string s =
match String.lowercase s with
"kern" -> `LOG_KERN
| "user" -> `LOG_USER
| "mail" -> `LOG_MAIL
| "daemon" -> `LOG_DAEMON
| "auth" -> `LOG_AUTH
| "syslog" -> `LOG_SYSLOG
| "lpr" -> `LOG_LPR
| "news" -> `LOG_NEWS
| "uucp" -> `LOG_UUCP
| "cron" -> `LOG_CRON
| "authpriv" -> `LOG_AUTHPRIV
| "ftp" -> `LOG_FTP
| "ntp" -> `LOG_NTP
| "security" -> `LOG_SECURITY
| "console" -> `LOG_CONSOLE
| "local0" -> `LOG_LOCAL0
| "local1" -> `LOG_LOCAL1
| "local2" -> `LOG_LOCAL2
| "local3" -> `LOG_LOCAL3
| "local4" -> `LOG_LOCAL4
| "local5" -> `LOG_LOCAL5
| "local6" -> `LOG_LOCAL6
| "local7" -> `LOG_LOCAL7
| invalid -> raise
(Syslog_error
("facility_of_string: invalid facility, " ^
invalid))
let facility_to_num fac =
Int32.of_int (match fac with
| `LOG_KERN -> 0 lsl 3
| `LOG_USER -> 1 lsl 3
| `LOG_MAIL -> 2 lsl 3
| `LOG_DAEMON -> 3 lsl 3
| `LOG_AUTH -> 4 lsl 3
| `LOG_SYSLOG -> 5 lsl 3
| `LOG_LPR -> 6 lsl 3
| `LOG_NEWS -> 7 lsl 3
| `LOG_UUCP -> 8 lsl 3
| `LOG_CRON -> 9 lsl 3
| `LOG_AUTHPRIV -> 10 lsl 3
| `LOG_FTP -> 11 lsl 3
| `LOG_NTP -> 12 lsl 3
| `LOG_SECURITY -> 13 lsl 3
| `LOG_CONSOLE -> 14 lsl 3
| `LOG_LOCAL0 -> 16 lsl 3
| `LOG_LOCAL1 -> 17 lsl 3
| `LOG_LOCAL2 -> 18 lsl 3
| `LOG_LOCAL3 -> 19 lsl 3
| `LOG_LOCAL4 -> 20 lsl 3
| `LOG_LOCAL5 -> 21 lsl 3
| `LOG_LOCAL6 -> 22 lsl 3
| `LOG_LOCAL7 -> 23 lsl 3)
let level_to_num lev =
Int32.of_int (match lev with
| `LOG_EMERG -> 0
| `LOG_ALERT -> 1
| `LOG_CRIT -> 2
| `LOG_ERR -> 3
| `LOG_WARNING -> 4
| `LOG_NOTICE -> 5
| `LOG_INFO -> 6
| `LOG_DEBUG -> 7)
let level_mask = 0x07
let facility_mask = 0x03f8
type t = {
mutable fd: Unix.file_descr;
mutable connected: bool;
mutable flags: flag list;
mutable tag: string;
mutable fac: int32;
mutable logpath: string;
}
let open_connection loginfo =
match loginfo.logpath with
"" -> raise (Syslog_error "unable to find the syslog socket or pipe, is syslogd running?")
| logpath ->
(match (Unix.stat logpath).Unix.st_kind with
Unix.S_SOCK ->
let logaddr = Unix.ADDR_UNIX logpath in
(try
loginfo.fd <- Unix.socket Unix.PF_UNIX SOCK_DGRAM 0;
Unix.connect loginfo.fd logaddr
with Unix.Unix_error (Unix.EPROTOTYPE, _, _) ->
(* try again with a stream socket for syslog-ng *)
loginfo.fd <- Unix.socket Unix.PF_UNIX SOCK_STREAM 0;
Unix.connect loginfo.fd logaddr);
loginfo.connected <- true;
| Unix.S_FIFO ->
loginfo.fd <- Unix.openfile logpath [Unix.O_WRONLY] 0o666;
loginfo.connected <- true;
| _ -> raise (Syslog_error "invalid log path, not a socket or pipe"))
let openlog
?(logpath=(try ignore (Unix.stat "/dev/log");"/dev/log"
with Unix.Unix_error (Unix.ENOENT, _, _) ->
(try ignore (Unix.stat "/var/run/syslog");"/var/run/syslog"
with Unix.Unix_error (Unix.ENOENT, _, _) -> "")))
?(facility=`LOG_USER)
?(flags=[])
ident =
let loginfo = {fd = Unix.stderr;
connected = false;
flags = flags;
tag = ident;
fac = facility_to_num facility;
logpath = logpath}
in
open_connection loginfo;
loginfo
let log_console msg = ()
let ascdate {tm_sec=sec;tm_min=min;tm_hour=hour;
tm_mday=mday;tm_mon=mon;tm_year=year;
tm_wday=wday;tm_yday=yday;tm_isdst=isdst} =
let asc_mon =
match mon with
0 -> "Jan"
| 1 -> "Feb"
| 2 -> "Mar"
| 3 -> "Apr"
| 4 -> "May"
| 5 -> "Jun"
| 6 -> "Jul"
| 7 -> "Aug"
| 8 -> "Sep"
| 9 -> "Oct"
| 10 -> "Nov"
| 11 -> "Dec"
| _ -> raise (Syslog_error "invalid month")
in
(Printf.sprintf "%s %02d %02d:%02d:%02d" asc_mon mday hour min sec)
let protected_write loginfo str =
let fallback _ =
(try close loginfo.fd with _ -> ());
loginfo.connected <- false;
(try open_connection loginfo with _ -> ());
if List.mem `LOG_CONS loginfo.flags then log_console str
in
try
ignore (Aux.send loginfo.fd str 0 (String.length str) [Aux.MSG_NOSIGNAL])
with Unix_error (_, _, _) ->
(* on error, attempt to reconnect *)
fallback ()
let syslog ?fac loginfo lev str =
let msg = Buffer.create 64 in
let realfac = match fac with
| Some f -> facility_to_num f
| None -> loginfo.fac in
let levfac = Int32.logor realfac (level_to_num lev)
and now = ascdate (localtime (Unix.time ())) in
Printf.bprintf msg "<%ld>%.15s " levfac now;
let len1 = Buffer.length msg
and len2 = String.length loginfo.tag in
if len1 + len2 < 64 then
Buffer.add_string msg loginfo.tag
else
Buffer.add_substring msg loginfo.tag 0 (64 - len1);
if List.mem `LOG_PID loginfo.flags then
Printf.bprintf msg "[%d]" (Unix.getpid());
if String.length loginfo.tag > 0 then
Buffer.add_string msg ": ";
Buffer.add_string msg str;
let realmsg = ref (Buffer.contents msg) in
if String.length !realmsg > 1024 then begin
realmsg := String.sub !realmsg 0 1024;
String.blit "<truncated>" 0 !realmsg 1012 11
end;
protected_write loginfo !realmsg;
if List.mem `LOG_PERROR loginfo.flags then begin
try
ignore (Unix.write Unix.stderr !realmsg 0 (String.length !realmsg));
ignore (Unix.write Unix.stderr "\n" 0 1)
with _ -> ()
end
let closelog loginfo =
if loginfo.connected then
begin
Unix.close loginfo.fd;
loginfo.connected <- false
end;
loginfo.flags <- [];
loginfo.tag <- "";
loginfo.fac <- facility_to_num `LOG_USER
|
