2 * "$Id: log.c 6649 2007-07-11 21:46:42Z mike $"
4 * Log file routines for the Common UNIX Printing System (CUPS).
6 * Copyright 2007 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
9 * These coded instructions, statements, and computer programs are the
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/".
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.
26 * Include necessary headers...
38 static int check_log_file(cups_file_t
**, const char *);
42 * 'cupsdGetDateTime()' - Returns a pointer to a date/time string.
45 char * /* O - Date/time string */
46 cupsdGetDateTime(time_t t
) /* I - Time value */
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 */
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!
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.
83 * (*BSD and Darwin store the timezone offset in the tm structure)
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
,
92 date
->tm_gmtoff
/ 3600, (date
->tm_gmtoff
/ 60) % 60);
94 timezone
/ 3600, (timezone
/ 60) % 60);
95 #endif /* HAVE_TM_GMTOFF */
104 * 'cupsdLogGSSMessage()' - Log a GSSAPI error...
107 int /* O - 1 on success, 0 on error */
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 */
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 */
126 err_major_status
= gss_display_status(&err_minor_status
,
131 &major_status_string
);
133 if (!GSS_ERROR(err_major_status
))
134 err_major_status
= gss_display_status(&err_minor_status
,
139 &minor_status_string
);
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
);
149 #endif /* HAVE_GSSAPI */
153 * 'cupsdLogMessage()' - Log a message to the error log file.
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 */
161 int len
; /* Length of message */
162 va_list ap
; /* Argument pointer */
163 static const char levels
[] = /* Log levels... */
177 static const int syslevels
[] = /* SYSLOG levels... */
190 #endif /* HAVE_VSYSLOG */
191 static int linesize
= 0; /* Size of line for output file */
192 static char *line
= NULL
; /* Line for output file */
196 * See if we want to log this message...
199 if (level
> LogLevel
|| !ErrorLog
)
204 * See if we are logging errors via syslog...
207 if (!strcmp(ErrorLog
, "syslog"))
209 va_start(ap
, message
);
210 vsyslog(syslevels
[level
], message
, ap
);
215 #endif /* HAVE_VSYSLOG */
218 * Not using syslog; check the log file...
221 if (!check_log_file(&ErrorFile
, ErrorLog
))
225 * Print the log level and date/time...
228 cupsFilePrintf(ErrorFile
, "%c %s ", levels
[level
], cupsdGetDateTime(time(NULL
)));
231 * Allocate the line buffer as needed...
237 line
= malloc(linesize
);
241 cupsFilePrintf(ErrorFile
,
242 "ERROR: Unable to allocate memory for line - %s\n",
244 cupsFileFlush(ErrorFile
);
251 * Format the log message...
254 va_start(ap
, message
);
255 len
= vsnprintf(line
, linesize
, message
, ap
);
259 * Resize the buffer as needed...
268 else if (len
> 65536)
271 line
= realloc(line
, len
);
277 cupsFilePrintf(ErrorFile
,
278 "ERROR: Unable to allocate memory for line - %s\n",
280 cupsFileFlush(ErrorFile
);
285 va_start(ap
, message
);
286 len
= vsnprintf(line
, linesize
, message
, ap
);
294 * Then the log message...
297 cupsFilePuts(ErrorFile
, line
);
303 if (len
> 0 && line
[len
- 1] != '\n')
304 cupsFilePutChar(ErrorFile
, '\n');
307 * Flush the line to the file and return...
310 cupsFileFlush(ErrorFile
);
317 * 'cupsdLogPage()' - Log a page to the page log file.
320 int /* O - 1 on success, 0 on error */
321 cupsdLogPage(cupsd_job_t
*job
, /* I - Job being printed */
322 const char *page
) /* I - Page being printed */
324 ipp_attribute_t
*billing
, /* job-billing attribute */
325 *hostname
; /* job-originating-host-name attribute */
328 billing
= ippFindAttribute(job
->attrs
, "job-billing", IPP_TAG_ZERO
);
329 hostname
= ippFindAttribute(job
->attrs
, "job-originating-host-name",
334 * See if we are logging pages via syslog...
337 if (!strcmp(PageLog
, "syslog"))
339 syslog(LOG_INFO
, "PAGE %s %s %d %s %s %s", job
->printer
->name
,
340 job
->username
? job
->username
: "-",
341 job
->id
, page
, billing
? billing
->values
[0].string
.text
: "-",
342 hostname
->values
[0].string
.text
);
346 #endif /* HAVE_VSYSLOG */
349 * Not using syslog; check the log file...
352 if (!check_log_file(&PageFile
, PageLog
))
356 * Print a page log entry of the form:
358 * printer job-id user [DD/MON/YYYY:HH:MM:SS +TTTT] page num-copies \
362 cupsFilePrintf(PageFile
, "%s %s %d %s %s %s %s\n", job
->printer
->name
,
363 job
->username
? job
->username
: "-",
364 job
->id
, cupsdGetDateTime(time(NULL
)), page
,
365 billing
? billing
->values
[0].string
.text
: "-",
366 hostname
->values
[0].string
.text
);
367 cupsFileFlush(PageFile
);
374 * 'cupsdLogRequest()' - Log an HTTP request in Common Log Format.
377 int /* O - 1 on success, 0 on error */
378 cupsdLogRequest(cupsd_client_t
*con
, /* I - Request to log */
379 http_status_t code
) /* I - Response code */
381 static const char * const states
[] = /* HTTP client states... */
402 * See if we are logging accesses via syslog...
405 if (!strcmp(AccessLog
, "syslog"))
408 "REQUEST %s - %s \"%s %s HTTP/%d.%d\" %d " CUPS_LLFMT
" %s %s\n",
409 con
->http
.hostname
, con
->username
[0] != '\0' ? con
->username
: "-",
410 states
[con
->operation
], con
->uri
,
411 con
->http
.version
/ 100, con
->http
.version
% 100,
412 code
, CUPS_LLCAST con
->bytes
,
414 ippOpString(con
->request
->request
.op
.operation_id
) : "-",
416 ippErrorString(con
->response
->request
.status
.status_code
) : "-");
420 #endif /* HAVE_VSYSLOG */
423 * Not using syslog; check the log file...
426 if (!check_log_file(&AccessFile
, AccessLog
))
430 * Write a log of the request in "common log format"...
433 cupsFilePrintf(AccessFile
,
434 "%s - %s %s \"%s %s HTTP/%d.%d\" %d " CUPS_LLFMT
" %s %s\n",
435 con
->http
.hostname
, con
->username
[0] != '\0' ? con
->username
: "-",
436 cupsdGetDateTime(con
->start
), states
[con
->operation
], con
->uri
,
437 con
->http
.version
/ 100, con
->http
.version
% 100,
438 code
, CUPS_LLCAST con
->bytes
,
440 ippOpString(con
->request
->request
.op
.operation_id
) : "-",
442 ippErrorString(con
->response
->request
.status
.status_code
) :
445 cupsFileFlush(AccessFile
);
452 * 'check_log_file()' - Open/rotate a log file if it needs it.
455 static int /* O - 1 if log file open */
456 check_log_file(cups_file_t
**lf
, /* IO - Log file */
457 const char *logname
) /* I - Log filename */
459 char backname
[1024], /* Backup log filename */
460 filename
[1024], /* Formatted log filename */
461 *ptr
; /* Pointer into filename */
462 const char *logptr
; /* Pointer into log filename */
466 * See if we have a log file to check...
469 if (!lf
|| !logname
|| !logname
[0])
473 * Format the filename as needed...
477 (strncmp(logname
, "/dev/", 5) && cupsFileTell(*lf
) > MaxLogSize
&&
481 * Handle format strings...
484 filename
[sizeof(filename
) - 1] = '\0';
486 if (logname
[0] != '/')
488 strlcpy(filename
, ServerRoot
, sizeof(filename
));
489 strlcat(filename
, "/", sizeof(filename
));
494 for (logptr
= logname
, ptr
= filename
+ strlen(filename
);
495 *logptr
&& ptr
< (filename
+ sizeof(filename
) - 1);
507 * Insert the server name...
510 strlcpy(ptr
, ServerName
, sizeof(filename
) - (ptr
- filename
));
516 * Otherwise just insert the character...
529 * See if the log file is open...
535 * Nope, open the log file...
538 if ((*lf
= cupsFileOpen(filename
, "a")) == NULL
)
541 * If the file is in CUPS_LOGDIR then try to create a missing directory...
544 if (!strncmp(filename
, CUPS_LOGDIR
, strlen(CUPS_LOGDIR
)))
546 cupsdCheckPermissions(CUPS_LOGDIR
, NULL
, 0755, RunUser
, Group
, 1, -1);
548 *lf
= cupsFileOpen(filename
, "a");
553 syslog(LOG_ERR
, "Unable to open log file \"%s\" - %s", filename
,
559 if (strncmp(filename
, "/dev/", 5))
562 * Change ownership and permissions of non-device logs...
565 fchown(cupsFileNumber(*lf
), RunUser
, Group
);
566 fchmod(cupsFileNumber(*lf
), LogFilePerm
);
571 * Do we need to rotate the log?
574 if (strncmp(logname
, "/dev/", 5) && cupsFileTell(*lf
) > MaxLogSize
&&
583 strcpy(backname
, filename
);
584 strlcat(backname
, ".O", sizeof(backname
));
587 rename(filename
, backname
);
589 if ((*lf
= cupsFileOpen(filename
, "a")) == NULL
)
591 syslog(LOG_ERR
, "Unable to open log file \"%s\" - %s", filename
,
598 * Change ownership and permissions of non-device logs...
601 fchown(cupsFileNumber(*lf
), RunUser
, Group
);
602 fchmod(cupsFileNumber(*lf
), LogFilePerm
);
610 * End of "$Id: log.c 6649 2007-07-11 21:46:42Z mike $".