]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | /* |
2e4ff8af | 2 | * "$Id: log.c 6875 2007-08-27 23:25:06Z mike $" |
ef416fc2 | 3 | * |
4 | * Log file routines for the Common UNIX Printing System (CUPS). | |
5 | * | |
bc44d920 | 6 | * Copyright 2007 by Apple Inc. |
b94498cf | 7 | * Copyright 1997-2007 by Easy Software Products, all rights reserved. |
ef416fc2 | 8 | * |
9 | * These coded instructions, statements, and computer programs are the | |
bc44d920 | 10 | * property of Apple Inc. and are protected by Federal copyright |
11 | * law. Distribution and use rights are outlined in the file "LICENSE.txt" | |
12 | * which should have been included with this file. If this file is | |
13 | * file is missing or damaged, see the license at "http://www.cups.org/". | |
ef416fc2 | 14 | * |
15 | * Contents: | |
16 | * | |
f7deaa1a | 17 | * cupsdGetDateTime() - Returns a pointer to a date/time string. |
18 | * cupsdLogGSSMessage() - Log a GSSAPI error... | |
19 | * cupsdLogMessage() - Log a message to the error log file. | |
20 | * cupsdLogPage() - Log a page to the page log file. | |
21 | * cupsdLogRequest() - Log an HTTP request in Common Log Format. | |
22 | * check_log_file() - Open/rotate a log file if it needs it. | |
ef416fc2 | 23 | */ |
24 | ||
25 | /* | |
26 | * Include necessary headers... | |
27 | */ | |
28 | ||
29 | #include "cupsd.h" | |
30 | #include <stdarg.h> | |
b423cd4c | 31 | #include <syslog.h> |
ef416fc2 | 32 | |
33 | ||
34 | /* | |
35 | * Local functions... | |
36 | */ | |
37 | ||
38 | static int check_log_file(cups_file_t **, const char *); | |
39 | ||
40 | ||
41 | /* | |
42 | * 'cupsdGetDateTime()' - Returns a pointer to a date/time string. | |
43 | */ | |
44 | ||
45 | char * /* O - Date/time string */ | |
46 | cupsdGetDateTime(time_t t) /* I - Time value */ | |
47 | { | |
48 | struct tm *date; /* Date/time value */ | |
49 | static time_t last_time = -1; /* Last time value */ | |
50 | static char s[1024]; /* Date/time string */ | |
51 | static const char * const months[12] =/* Months */ | |
52 | { | |
53 | "Jan", | |
54 | "Feb", | |
55 | "Mar", | |
56 | "Apr", | |
57 | "May", | |
58 | "Jun", | |
59 | "Jul", | |
60 | "Aug", | |
61 | "Sep", | |
62 | "Oct", | |
63 | "Nov", | |
64 | "Dec" | |
65 | }; | |
66 | ||
67 | ||
68 | if (t != last_time) | |
69 | { | |
70 | last_time = t; | |
71 | ||
72 | /* | |
73 | * Get the date and time from the UNIX time value, and then format it | |
74 | * into a string. Note that we *can't* use the strftime() function since | |
75 | * it is localized and will seriously confuse automatic programs if the | |
76 | * month names are in the wrong language! | |
77 | * | |
78 | * Also, we use the "timezone" variable that contains the current timezone | |
79 | * offset from GMT in seconds so that we are reporting local time in the | |
80 | * log files. If you want GMT, set the TZ environment variable accordingly | |
81 | * before starting the scheduler. | |
82 | * | |
83 | * (*BSD and Darwin store the timezone offset in the tm structure) | |
84 | */ | |
85 | ||
86 | date = localtime(&t); | |
87 | ||
88 | snprintf(s, sizeof(s), "[%02d/%s/%04d:%02d:%02d:%02d %+03ld%02ld]", | |
89 | date->tm_mday, months[date->tm_mon], 1900 + date->tm_year, | |
90 | date->tm_hour, date->tm_min, date->tm_sec, | |
91 | #ifdef HAVE_TM_GMTOFF | |
92 | date->tm_gmtoff / 3600, (date->tm_gmtoff / 60) % 60); | |
93 | #else | |
94 | timezone / 3600, (timezone / 60) % 60); | |
95 | #endif /* HAVE_TM_GMTOFF */ | |
96 | } | |
97 | ||
98 | return (s); | |
99 | } | |
100 | ||
101 | ||
f7deaa1a | 102 | #ifdef HAVE_GSSAPI |
103 | /* | |
104 | * 'cupsdLogGSSMessage()' - Log a GSSAPI error... | |
105 | */ | |
106 | ||
107 | int /* O - 1 on success, 0 on error */ | |
108 | cupsdLogGSSMessage( | |
109 | int level, /* I - Log level */ | |
110 | int major_status, /* I - Major GSSAPI status */ | |
111 | int minor_status, /* I - Minor GSSAPI status */ | |
112 | const char *message, /* I - printf-style message string */ | |
113 | ...) /* I - Additional args as needed */ | |
114 | { | |
115 | OM_uint32 err_major_status, /* Major status code for display */ | |
116 | err_minor_status; /* Minor status code for display */ | |
117 | OM_uint32 msg_ctx; /* Message context */ | |
118 | gss_buffer_desc major_status_string = GSS_C_EMPTY_BUFFER, | |
119 | /* Major status message */ | |
120 | minor_status_string = GSS_C_EMPTY_BUFFER; | |
121 | /* Minor status message */ | |
122 | int ret; /* Return value */ | |
123 | ||
124 | ||
125 | msg_ctx = 0; | |
126 | err_major_status = gss_display_status(&err_minor_status, | |
127 | major_status, | |
128 | GSS_C_GSS_CODE, | |
129 | GSS_C_NO_OID, | |
130 | &msg_ctx, | |
131 | &major_status_string); | |
132 | ||
133 | if (!GSS_ERROR(err_major_status)) | |
134 | err_major_status = gss_display_status(&err_minor_status, | |
135 | minor_status, | |
136 | GSS_C_MECH_CODE, | |
137 | GSS_C_NULL_OID, | |
138 | &msg_ctx, | |
139 | &minor_status_string); | |
140 | ||
141 | ret = cupsdLogMessage(level, "%s: %s, %s", message, | |
142 | (char *)major_status_string.value, | |
143 | (char *)minor_status_string.value); | |
144 | gss_release_buffer(&err_minor_status, &major_status_string); | |
145 | gss_release_buffer(&err_minor_status, &minor_status_string); | |
146 | ||
147 | return (ret); | |
148 | } | |
149 | #endif /* HAVE_GSSAPI */ | |
150 | ||
151 | ||
ef416fc2 | 152 | /* |
153 | * 'cupsdLogMessage()' - Log a message to the error log file. | |
154 | */ | |
155 | ||
156 | int /* O - 1 on success, 0 on error */ | |
157 | cupsdLogMessage(int level, /* I - Log level */ | |
158 | const char *message, /* I - printf-style message string */ | |
159 | ...) /* I - Additional args as needed */ | |
160 | { | |
161 | int len; /* Length of message */ | |
162 | va_list ap; /* Argument pointer */ | |
163 | static const char levels[] = /* Log levels... */ | |
164 | { | |
165 | ' ', | |
166 | 'X', | |
167 | 'A', | |
168 | 'C', | |
169 | 'E', | |
170 | 'W', | |
171 | 'N', | |
172 | 'I', | |
173 | 'D', | |
174 | 'd' | |
175 | }; | |
176 | #ifdef HAVE_VSYSLOG | |
177 | static const int syslevels[] = /* SYSLOG levels... */ | |
178 | { | |
179 | 0, | |
180 | LOG_EMERG, | |
181 | LOG_ALERT, | |
182 | LOG_CRIT, | |
183 | LOG_ERR, | |
184 | LOG_WARNING, | |
185 | LOG_NOTICE, | |
186 | LOG_INFO, | |
187 | LOG_DEBUG, | |
188 | LOG_DEBUG | |
189 | }; | |
190 | #endif /* HAVE_VSYSLOG */ | |
191 | static int linesize = 0; /* Size of line for output file */ | |
192 | static char *line = NULL; /* Line for output file */ | |
193 | ||
194 | ||
195 | /* | |
196 | * See if we want to log this message... | |
197 | */ | |
198 | ||
2e4ff8af MS |
199 | if (TestConfigFile) |
200 | { | |
201 | if (level <= CUPSD_LOG_WARN) | |
202 | { | |
203 | va_start(ap, message); | |
204 | vfprintf(stderr, message, ap); | |
205 | putc('\n', stderr); | |
206 | va_end(ap); | |
207 | } | |
208 | ||
209 | return (1); | |
210 | } | |
211 | ||
ef416fc2 | 212 | if (level > LogLevel || !ErrorLog) |
213 | return (1); | |
214 | ||
215 | #ifdef HAVE_VSYSLOG | |
216 | /* | |
217 | * See if we are logging errors via syslog... | |
218 | */ | |
219 | ||
220 | if (!strcmp(ErrorLog, "syslog")) | |
221 | { | |
222 | va_start(ap, message); | |
223 | vsyslog(syslevels[level], message, ap); | |
224 | va_end(ap); | |
225 | ||
226 | return (1); | |
227 | } | |
228 | #endif /* HAVE_VSYSLOG */ | |
229 | ||
230 | /* | |
231 | * Not using syslog; check the log file... | |
232 | */ | |
233 | ||
234 | if (!check_log_file(&ErrorFile, ErrorLog)) | |
235 | return (0); | |
236 | ||
237 | /* | |
238 | * Print the log level and date/time... | |
239 | */ | |
240 | ||
241 | cupsFilePrintf(ErrorFile, "%c %s ", levels[level], cupsdGetDateTime(time(NULL))); | |
242 | ||
243 | /* | |
244 | * Allocate the line buffer as needed... | |
245 | */ | |
246 | ||
247 | if (!linesize) | |
248 | { | |
249 | linesize = 8192; | |
250 | line = malloc(linesize); | |
251 | ||
252 | if (!line) | |
253 | { | |
254 | cupsFilePrintf(ErrorFile, | |
255 | "ERROR: Unable to allocate memory for line - %s\n", | |
256 | strerror(errno)); | |
257 | cupsFileFlush(ErrorFile); | |
258 | ||
259 | return (0); | |
260 | } | |
261 | } | |
262 | ||
263 | /* | |
264 | * Format the log message... | |
265 | */ | |
266 | ||
267 | va_start(ap, message); | |
268 | len = vsnprintf(line, linesize, message, ap); | |
269 | va_end(ap); | |
270 | ||
271 | /* | |
272 | * Resize the buffer as needed... | |
273 | */ | |
274 | ||
275 | if (len >= linesize) | |
276 | { | |
277 | len ++; | |
278 | ||
279 | if (len < 8192) | |
280 | len = 8192; | |
281 | else if (len > 65536) | |
282 | len = 65536; | |
283 | ||
284 | line = realloc(line, len); | |
285 | ||
286 | if (line) | |
287 | linesize = len; | |
288 | else | |
289 | { | |
290 | cupsFilePrintf(ErrorFile, | |
291 | "ERROR: Unable to allocate memory for line - %s\n", | |
292 | strerror(errno)); | |
293 | cupsFileFlush(ErrorFile); | |
294 | ||
295 | return (0); | |
296 | } | |
297 | ||
298 | va_start(ap, message); | |
299 | len = vsnprintf(line, linesize, message, ap); | |
300 | va_end(ap); | |
301 | } | |
302 | ||
303 | if (len >= linesize) | |
304 | len = linesize - 1; | |
305 | ||
306 | /* | |
307 | * Then the log message... | |
308 | */ | |
309 | ||
310 | cupsFilePuts(ErrorFile, line); | |
311 | ||
312 | /* | |
313 | * Then a newline... | |
314 | */ | |
315 | ||
316 | if (len > 0 && line[len - 1] != '\n') | |
317 | cupsFilePutChar(ErrorFile, '\n'); | |
318 | ||
319 | /* | |
320 | * Flush the line to the file and return... | |
321 | */ | |
322 | ||
323 | cupsFileFlush(ErrorFile); | |
324 | ||
325 | return (1); | |
326 | } | |
327 | ||
328 | ||
329 | /* | |
330 | * 'cupsdLogPage()' - Log a page to the page log file. | |
331 | */ | |
332 | ||
333 | int /* O - 1 on success, 0 on error */ | |
334 | cupsdLogPage(cupsd_job_t *job, /* I - Job being printed */ | |
335 | const char *page) /* I - Page being printed */ | |
336 | { | |
337 | ipp_attribute_t *billing, /* job-billing attribute */ | |
338 | *hostname; /* job-originating-host-name attribute */ | |
339 | ||
340 | ||
341 | billing = ippFindAttribute(job->attrs, "job-billing", IPP_TAG_ZERO); | |
342 | hostname = ippFindAttribute(job->attrs, "job-originating-host-name", | |
343 | IPP_TAG_ZERO); | |
344 | ||
345 | #ifdef HAVE_VSYSLOG | |
346 | /* | |
347 | * See if we are logging pages via syslog... | |
348 | */ | |
349 | ||
350 | if (!strcmp(PageLog, "syslog")) | |
351 | { | |
352 | syslog(LOG_INFO, "PAGE %s %s %d %s %s %s", job->printer->name, | |
353 | job->username ? job->username : "-", | |
354 | job->id, page, billing ? billing->values[0].string.text : "-", | |
355 | hostname->values[0].string.text); | |
356 | ||
357 | return (1); | |
358 | } | |
359 | #endif /* HAVE_VSYSLOG */ | |
360 | ||
361 | /* | |
362 | * Not using syslog; check the log file... | |
363 | */ | |
364 | ||
365 | if (!check_log_file(&PageFile, PageLog)) | |
366 | return (0); | |
367 | ||
368 | /* | |
369 | * Print a page log entry of the form: | |
370 | * | |
371 | * printer job-id user [DD/MON/YYYY:HH:MM:SS +TTTT] page num-copies \ | |
372 | * billing hostname | |
373 | */ | |
374 | ||
375 | cupsFilePrintf(PageFile, "%s %s %d %s %s %s %s\n", job->printer->name, | |
376 | job->username ? job->username : "-", | |
377 | job->id, cupsdGetDateTime(time(NULL)), page, | |
378 | billing ? billing->values[0].string.text : "-", | |
379 | hostname->values[0].string.text); | |
380 | cupsFileFlush(PageFile); | |
381 | ||
382 | return (1); | |
383 | } | |
384 | ||
385 | ||
386 | /* | |
387 | * 'cupsdLogRequest()' - Log an HTTP request in Common Log Format. | |
388 | */ | |
389 | ||
390 | int /* O - 1 on success, 0 on error */ | |
391 | cupsdLogRequest(cupsd_client_t *con, /* I - Request to log */ | |
392 | http_status_t code) /* I - Response code */ | |
393 | { | |
394 | static const char * const states[] = /* HTTP client states... */ | |
395 | { | |
396 | "WAITING", | |
397 | "OPTIONS", | |
398 | "GET", | |
399 | "GET", | |
400 | "HEAD", | |
401 | "POST", | |
402 | "POST", | |
403 | "POST", | |
404 | "PUT", | |
405 | "PUT", | |
406 | "DELETE", | |
407 | "TRACE", | |
408 | "CLOSE", | |
409 | "STATUS" | |
410 | }; | |
411 | ||
412 | ||
413 | #ifdef HAVE_VSYSLOG | |
414 | /* | |
415 | * See if we are logging accesses via syslog... | |
416 | */ | |
417 | ||
418 | if (!strcmp(AccessLog, "syslog")) | |
419 | { | |
2abf387c | 420 | syslog(LOG_INFO, |
421 | "REQUEST %s - %s \"%s %s HTTP/%d.%d\" %d " CUPS_LLFMT " %s %s\n", | |
ef416fc2 | 422 | con->http.hostname, con->username[0] != '\0' ? con->username : "-", |
423 | states[con->operation], con->uri, | |
424 | con->http.version / 100, con->http.version % 100, | |
2abf387c | 425 | code, CUPS_LLCAST con->bytes, |
426 | con->request ? | |
427 | ippOpString(con->request->request.op.operation_id) : "-", | |
428 | con->response ? | |
429 | ippErrorString(con->response->request.status.status_code) : "-"); | |
ef416fc2 | 430 | |
431 | return (1); | |
432 | } | |
433 | #endif /* HAVE_VSYSLOG */ | |
434 | ||
435 | /* | |
436 | * Not using syslog; check the log file... | |
437 | */ | |
438 | ||
439 | if (!check_log_file(&AccessFile, AccessLog)) | |
440 | return (0); | |
441 | ||
442 | /* | |
443 | * Write a log of the request in "common log format"... | |
444 | */ | |
445 | ||
446 | cupsFilePrintf(AccessFile, | |
447 | "%s - %s %s \"%s %s HTTP/%d.%d\" %d " CUPS_LLFMT " %s %s\n", | |
448 | con->http.hostname, con->username[0] != '\0' ? con->username : "-", | |
449 | cupsdGetDateTime(con->start), states[con->operation], con->uri, | |
450 | con->http.version / 100, con->http.version % 100, | |
451 | code, CUPS_LLCAST con->bytes, | |
452 | con->request ? | |
453 | ippOpString(con->request->request.op.operation_id) : "-", | |
454 | con->response ? | |
455 | ippErrorString(con->response->request.status.status_code) : | |
456 | "-"); | |
457 | ||
458 | cupsFileFlush(AccessFile); | |
459 | ||
460 | return (1); | |
461 | } | |
462 | ||
463 | ||
464 | /* | |
465 | * 'check_log_file()' - Open/rotate a log file if it needs it. | |
466 | */ | |
467 | ||
468 | static int /* O - 1 if log file open */ | |
469 | check_log_file(cups_file_t **lf, /* IO - Log file */ | |
470 | const char *logname) /* I - Log filename */ | |
471 | { | |
f7deaa1a | 472 | char backname[1024], /* Backup log filename */ |
473 | filename[1024], /* Formatted log filename */ | |
474 | *ptr; /* Pointer into filename */ | |
475 | const char *logptr; /* Pointer into log filename */ | |
ef416fc2 | 476 | |
477 | ||
478 | /* | |
479 | * See if we have a log file to check... | |
480 | */ | |
481 | ||
482 | if (!lf || !logname || !logname[0]) | |
483 | return (1); | |
484 | ||
485 | /* | |
486 | * Format the filename as needed... | |
487 | */ | |
488 | ||
a74454a7 | 489 | if (!*lf || |
490 | (strncmp(logname, "/dev/", 5) && cupsFileTell(*lf) > MaxLogSize && | |
491 | MaxLogSize > 0)) | |
ef416fc2 | 492 | { |
493 | /* | |
494 | * Handle format strings... | |
495 | */ | |
496 | ||
497 | filename[sizeof(filename) - 1] = '\0'; | |
498 | ||
499 | if (logname[0] != '/') | |
500 | { | |
501 | strlcpy(filename, ServerRoot, sizeof(filename)); | |
502 | strlcat(filename, "/", sizeof(filename)); | |
503 | } | |
504 | else | |
505 | filename[0] = '\0'; | |
506 | ||
f7deaa1a | 507 | for (logptr = logname, ptr = filename + strlen(filename); |
508 | *logptr && ptr < (filename + sizeof(filename) - 1); | |
509 | logptr ++) | |
510 | if (*logptr == '%') | |
ef416fc2 | 511 | { |
512 | /* | |
513 | * Format spec... | |
514 | */ | |
515 | ||
f7deaa1a | 516 | logptr ++; |
517 | if (*logptr == 's') | |
ef416fc2 | 518 | { |
519 | /* | |
520 | * Insert the server name... | |
521 | */ | |
522 | ||
523 | strlcpy(ptr, ServerName, sizeof(filename) - (ptr - filename)); | |
524 | ptr += strlen(ptr); | |
525 | } | |
526 | else | |
527 | { | |
528 | /* | |
529 | * Otherwise just insert the character... | |
530 | */ | |
531 | ||
f7deaa1a | 532 | *ptr++ = *logptr; |
ef416fc2 | 533 | } |
534 | } | |
535 | else | |
f7deaa1a | 536 | *ptr++ = *logptr; |
ef416fc2 | 537 | |
538 | *ptr = '\0'; | |
539 | } | |
540 | ||
541 | /* | |
542 | * See if the log file is open... | |
543 | */ | |
544 | ||
545 | if (!*lf) | |
546 | { | |
547 | /* | |
548 | * Nope, open the log file... | |
549 | */ | |
550 | ||
551 | if ((*lf = cupsFileOpen(filename, "a")) == NULL) | |
552 | { | |
b94498cf | 553 | /* |
554 | * If the file is in CUPS_LOGDIR then try to create a missing directory... | |
555 | */ | |
ef416fc2 | 556 | |
b94498cf | 557 | if (!strncmp(filename, CUPS_LOGDIR, strlen(CUPS_LOGDIR))) |
558 | { | |
559 | cupsdCheckPermissions(CUPS_LOGDIR, NULL, 0755, RunUser, Group, 1, -1); | |
560 | ||
561 | *lf = cupsFileOpen(filename, "a"); | |
562 | } | |
563 | ||
564 | if (*lf == NULL) | |
565 | { | |
566 | syslog(LOG_ERR, "Unable to open log file \"%s\" - %s", filename, | |
567 | strerror(errno)); | |
568 | return (0); | |
569 | } | |
ef416fc2 | 570 | } |
571 | ||
572 | if (strncmp(filename, "/dev/", 5)) | |
573 | { | |
574 | /* | |
575 | * Change ownership and permissions of non-device logs... | |
576 | */ | |
577 | ||
578 | fchown(cupsFileNumber(*lf), RunUser, Group); | |
579 | fchmod(cupsFileNumber(*lf), LogFilePerm); | |
580 | } | |
581 | } | |
582 | ||
583 | /* | |
584 | * Do we need to rotate the log? | |
585 | */ | |
586 | ||
a74454a7 | 587 | if (strncmp(logname, "/dev/", 5) && cupsFileTell(*lf) > MaxLogSize && |
588 | MaxLogSize > 0) | |
ef416fc2 | 589 | { |
590 | /* | |
591 | * Rotate log file... | |
592 | */ | |
593 | ||
594 | cupsFileClose(*lf); | |
595 | ||
596 | strcpy(backname, filename); | |
597 | strlcat(backname, ".O", sizeof(backname)); | |
598 | ||
599 | unlink(backname); | |
600 | rename(filename, backname); | |
601 | ||
602 | if ((*lf = cupsFileOpen(filename, "a")) == NULL) | |
603 | { | |
604 | syslog(LOG_ERR, "Unable to open log file \"%s\" - %s", filename, | |
605 | strerror(errno)); | |
606 | ||
607 | return (0); | |
608 | } | |
609 | ||
a74454a7 | 610 | /* |
611 | * Change ownership and permissions of non-device logs... | |
612 | */ | |
ef416fc2 | 613 | |
a74454a7 | 614 | fchown(cupsFileNumber(*lf), RunUser, Group); |
615 | fchmod(cupsFileNumber(*lf), LogFilePerm); | |
ef416fc2 | 616 | } |
617 | ||
618 | return (1); | |
619 | } | |
620 | ||
621 | ||
622 | /* | |
2e4ff8af | 623 | * End of "$Id: log.c 6875 2007-08-27 23:25:06Z mike $". |
ef416fc2 | 624 | */ |