4 * Log file routines for the CUPS scheduler.
6 * Copyright 2007-2015 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 * Include necessary headers...
24 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
25 # define SD_JOURNAL_SUPPRESS_LOCATION
26 # include <systemd/sd-journal.h>
27 #endif /* HAVE_ASL_H */
32 * Constants for log keys from PWG 5110.3 (PWG Common Log Format)...
35 #define PWG_DeviceUUID "DUU"
37 #define PWG_LogNaturalLanguage "NL"
38 #define PWG_Status "S"
39 #define PWG_ServiceURI "URI"
40 #define PWG_UserHost "UH"
41 #define PWG_UserName "UN"
42 #define PWG_UserURI "UU"
43 #define PWG_ServiceIsAcceptingJobs "IAJ"
44 #define PWG_ServiceState "ST"
45 #define PWG_ServiceStateReasons "SR"
46 #define PWG_ServiceUUID "SUU"
47 #define PWG_JobID "JID"
48 #define PWG_JobUUID "JUU"
49 #define PWG_JobImagesCompleted "JIM"
50 #define PWG_JobImpressionsCompleted "JIC"
51 #define PWG_JobDestinationURI "JD"
52 #define PWG_JobState "JS"
53 #define PWG_JobStateReasons "JR"
54 #define PWG_JobAccountingID "JA"
55 #define PWG_JobAcountingUserName "JAUN"
56 #define PWG_JobAccountingUserURI "JAUU"
63 static _cups_mutex_t log_mutex
= _CUPS_MUTEX_INITIALIZER
;
64 /* Mutex for logging */
65 static size_t log_linesize
= 0; /* Size of line for output file */
66 static char *log_line
= NULL
; /* Line for output file */
69 static const int log_levels
[] = /* ASL levels... */
82 #elif defined(HAVE_VSYSLOG) || defined(HAVE_SYSTEMD_SD_JOURNAL_H)
83 static const int log_levels
[] = /* SYSLOG levels... */
96 #endif /* HAVE_ASL_H */
103 static int format_log_line(const char *message
, va_list ap
);
107 * 'cupsdCheckLogFile()' - Open/rotate a log file if it needs it.
110 int /* O - 1 if log file open */
111 cupsdCheckLogFile(cups_file_t
**lf
, /* IO - Log file */
112 const char *logname
) /* I - Log filename */
114 char backname
[1024], /* Backup log filename */
115 filename
[1024], /* Formatted log filename */
116 *ptr
; /* Pointer into filename */
117 const char *logptr
; /* Pointer into log filename */
121 * See if we have a log file to check...
124 if (!lf
|| !logname
|| !logname
[0])
128 * Handle logging to stderr...
131 if (!strcmp(logname
, "stderr"))
138 * Format the filename as needed...
142 (strncmp(logname
, "/dev/", 5) && cupsFileTell(*lf
) > MaxLogSize
&&
146 * Handle format strings...
149 filename
[sizeof(filename
) - 1] = '\0';
151 if (logname
[0] != '/')
153 strlcpy(filename
, ServerRoot
, sizeof(filename
));
154 strlcat(filename
, "/", sizeof(filename
));
159 for (logptr
= logname
, ptr
= filename
+ strlen(filename
);
160 *logptr
&& ptr
< (filename
+ sizeof(filename
) - 1);
172 * Insert the server name...
175 strlcpy(ptr
, ServerName
, sizeof(filename
) - (size_t)(ptr
- filename
));
181 * Otherwise just insert the character...
194 * See if the log file is open...
200 * Nope, open the log file...
203 if ((*lf
= cupsFileOpen(filename
, "a")) == NULL
)
206 * If the file is in CUPS_LOGDIR then try to create a missing directory...
209 if (!strncmp(filename
, CUPS_LOGDIR
, strlen(CUPS_LOGDIR
)))
212 * Try updating the permissions of the containing log directory, using
213 * the log file permissions as a basis...
216 mode_t log_dir_perm
= (mode_t
)(0300 | LogFilePerm
);
217 /* LogFilePerm + owner write/search */
218 if (log_dir_perm
& 0040)
219 log_dir_perm
|= 0010; /* Add group search */
220 if (log_dir_perm
& 0004)
221 log_dir_perm
|= 0001; /* Add other search */
223 cupsdCheckPermissions(CUPS_LOGDIR
, NULL
, log_dir_perm
, RunUser
, Group
, 1, -1);
225 *lf
= cupsFileOpen(filename
, "a");
231 asl_object_t m
; /* Log message */
233 m
= asl_new(ASL_TYPE_MSG
);
234 asl_set(m
, ASL_KEY_FACILITY
, "org.cups.cupsd");
235 asl_log(NULL
, m
, ASL_LEVEL_ERR
, "Unable to open log file \"%s\" - %s", filename
, strerror(errno
));
238 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
239 sd_journal_print(LOG_ERR
, "Unable to open log file \"%s\" - %s", filename
, strerror(errno
));
242 syslog(LOG_ERR
, "Unable to open log file \"%s\" - %s", filename
, strerror(errno
));
243 #endif /* HAVE_ASL_H */
245 if (FatalErrors
& CUPSD_FATAL_LOG
)
246 cupsdEndProcess(getpid(), 0);
252 if (strncmp(filename
, "/dev/", 5))
255 * Change ownership and permissions of non-device logs...
258 fchown(cupsFileNumber(*lf
), RunUser
, Group
);
259 fchmod(cupsFileNumber(*lf
), LogFilePerm
);
264 * Do we need to rotate the log?
267 if (strncmp(logname
, "/dev/", 5) && cupsFileTell(*lf
) > MaxLogSize
&&
276 strlcpy(backname
, filename
, sizeof(backname
));
277 strlcat(backname
, ".O", sizeof(backname
));
280 rename(filename
, backname
);
282 if ((*lf
= cupsFileOpen(filename
, "a")) == NULL
)
285 asl_object_t m
; /* Log message */
287 m
= asl_new(ASL_TYPE_MSG
);
288 asl_set(m
, ASL_KEY_FACILITY
, "org.cups.cupsd");
289 asl_log(NULL
, m
, ASL_LEVEL_ERR
, "Unable to open log file \"%s\" - %s", filename
, strerror(errno
));
292 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
293 sd_journal_print(LOG_ERR
, "Unable to open log file \"%s\" - %s", filename
, strerror(errno
));
296 syslog(LOG_ERR
, "Unable to open log file \"%s\" - %s", filename
, strerror(errno
));
297 #endif /* HAVE_ASL_H */
299 if (FatalErrors
& CUPSD_FATAL_LOG
)
300 cupsdEndProcess(getpid(), 0);
306 * Change ownership and permissions of non-device logs...
309 fchown(cupsFileNumber(*lf
), RunUser
, Group
);
310 fchmod(cupsFileNumber(*lf
), LogFilePerm
);
318 * 'cupsdGetDateTime()' - Returns a pointer to a date/time string.
321 char * /* O - Date/time string */
322 cupsdGetDateTime(struct timeval
*t
, /* I - Time value or NULL for current */
323 cupsd_time_t format
) /* I - Format to use */
325 struct timeval curtime
; /* Current time value */
326 struct tm
*date
; /* Date/time value */
327 static struct timeval last_time
= { 0, 0 };
328 /* Last time we formatted */
329 static char s
[1024]; /* Date/time string */
330 static const char * const months
[12] =/* Months */
348 * Make sure we have a valid time...
353 gettimeofday(&curtime
, NULL
);
357 if (t
->tv_sec
!= last_time
.tv_sec
||
358 (LogTimeFormat
== CUPSD_TIME_USECS
&& t
->tv_usec
!= last_time
.tv_usec
))
363 * Get the date and time from the UNIX time value, and then format it
364 * into a string. Note that we *can't* use the strftime() function since
365 * it is localized and will seriously confuse automatic programs if the
366 * month names are in the wrong language!
368 * Also, we use the "timezone" variable that contains the current timezone
369 * offset from GMT in seconds so that we are reporting local time in the
370 * log files. If you want GMT, set the TZ environment variable accordingly
371 * before starting the scheduler.
373 * (*BSD and Darwin store the timezone offset in the tm structure)
376 date
= localtime(&(t
->tv_sec
));
378 if (format
== CUPSD_TIME_STANDARD
)
379 snprintf(s
, sizeof(s
), "[%02d/%s/%04d:%02d:%02d:%02d %+03ld%02ld]",
380 date
->tm_mday
, months
[date
->tm_mon
], 1900 + date
->tm_year
,
381 date
->tm_hour
, date
->tm_min
, date
->tm_sec
,
382 #ifdef HAVE_TM_GMTOFF
383 date
->tm_gmtoff
/ 3600, (date
->tm_gmtoff
/ 60) % 60);
385 timezone
/ 3600, (timezone
/ 60) % 60);
386 #endif /* HAVE_TM_GMTOFF */
388 snprintf(s
, sizeof(s
), "[%02d/%s/%04d:%02d:%02d:%02d.%06d %+03ld%02ld]",
389 date
->tm_mday
, months
[date
->tm_mon
], 1900 + date
->tm_year
,
390 date
->tm_hour
, date
->tm_min
, date
->tm_sec
, (int)t
->tv_usec
,
391 #ifdef HAVE_TM_GMTOFF
392 date
->tm_gmtoff
/ 3600, (date
->tm_gmtoff
/ 60) % 60);
394 timezone
/ 3600, (timezone
/ 60) % 60);
395 #endif /* HAVE_TM_GMTOFF */
403 * 'cupsdLogFCMessage()' - Log a file checking message.
408 void *context
, /* I - Printer (if any) */
409 _cups_fc_result_t result
, /* I - Check result */
410 const char *message
) /* I - Message to log */
412 cupsd_printer_t
*p
= (cupsd_printer_t
*)context
;
414 cupsd_loglevel_t level
; /* Log level */
417 if (result
== _CUPS_FILE_CHECK_OK
)
418 level
= CUPSD_LOG_DEBUG2
;
420 level
= CUPSD_LOG_ERROR
;
424 cupsdLogMessage(level
, "%s: %s", p
->name
, message
);
426 if (result
== _CUPS_FILE_CHECK_MISSING
||
427 result
== _CUPS_FILE_CHECK_WRONG_TYPE
)
429 strlcpy(p
->state_message
, message
, sizeof(p
->state_message
));
431 if (cupsdSetPrinterReasons(p
, "+cups-missing-filter-warning"))
432 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, p
, NULL
, "%s", message
);
434 else if (result
== _CUPS_FILE_CHECK_PERMISSIONS
||
435 result
== _CUPS_FILE_CHECK_RELATIVE_PATH
)
437 strlcpy(p
->state_message
, message
, sizeof(p
->state_message
));
439 if (cupsdSetPrinterReasons(p
, "+cups-insecure-filter-warning"))
440 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, p
, NULL
, "%s", message
);
444 cupsdLogMessage(level
, "%s", message
);
450 * 'cupsdLogGSSMessage()' - Log a GSSAPI error...
453 int /* O - 1 on success, 0 on error */
455 int level
, /* I - Log level */
456 OM_uint32 major_status
, /* I - Major GSSAPI status */
457 OM_uint32 minor_status
, /* I - Minor GSSAPI status */
458 const char *message
, /* I - printf-style message string */
459 ...) /* I - Additional args as needed */
461 OM_uint32 err_major_status
, /* Major status code for display */
462 err_minor_status
; /* Minor status code for display */
463 OM_uint32 msg_ctx
; /* Message context */
464 gss_buffer_desc major_status_string
= GSS_C_EMPTY_BUFFER
,
465 /* Major status message */
466 minor_status_string
= GSS_C_EMPTY_BUFFER
;
467 /* Minor status message */
468 int ret
; /* Return value */
469 char buffer
[8192]; /* Buffer for vsnprintf */
472 if (strchr(message
, '%'))
475 * Format the message string...
478 va_list ap
; /* Pointer to arguments */
480 va_start(ap
, message
);
481 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
488 err_major_status
= gss_display_status(&err_minor_status
,
493 &major_status_string
);
495 if (!GSS_ERROR(err_major_status
))
496 gss_display_status(&err_minor_status
, minor_status
, GSS_C_MECH_CODE
,
497 GSS_C_NULL_OID
, &msg_ctx
, &minor_status_string
);
499 ret
= cupsdLogMessage(level
, "%s: %s, %s", message
,
500 (char *)major_status_string
.value
,
501 (char *)minor_status_string
.value
);
502 gss_release_buffer(&err_minor_status
, &major_status_string
);
503 gss_release_buffer(&err_minor_status
, &minor_status_string
);
507 #endif /* HAVE_GSSAPI */
511 * 'cupsdLogClient()' - Log a client message.
514 int /* O - 1 on success, 0 on error */
515 cupsdLogClient(cupsd_client_t
*con
, /* I - Client connection */
516 int level
, /* I - Log level */
517 const char *message
, /* I - Printf-style message string */
518 ...) /* I - Additional arguments as needed */
520 va_list ap
, ap2
; /* Argument pointers */
521 char clientmsg
[1024];/* Format string for client message */
522 int status
; /* Formatting status */
526 * See if we want to log this message...
529 if (TestConfigFile
|| !ErrorLog
)
532 if (level
> LogLevel
)
536 * Format and write the log message...
540 snprintf(clientmsg
, sizeof(clientmsg
), "[Client %d] %s", con
->number
,
543 strlcpy(clientmsg
, message
, sizeof(clientmsg
));
545 va_start(ap
, message
);
550 status
= format_log_line(clientmsg
, ap2
);
558 return (cupsdWriteErrorLog(level
, log_line
));
560 return (cupsdWriteErrorLog(CUPSD_LOG_ERROR
,
561 "Unable to allocate memory for log line."));
566 * 'cupsdLogJob()' - Log a job message.
569 int /* O - 1 on success, 0 on error */
570 cupsdLogJob(cupsd_job_t
*job
, /* I - Job */
571 int level
, /* I - Log level */
572 const char *message
, /* I - Printf-style message string */
573 ...) /* I - Additional arguments as needed */
575 va_list ap
, ap2
; /* Argument pointers */
576 char jobmsg
[1024]; /* Format string for job message */
577 int status
; /* Formatting status */
581 * See if we want to log this message...
584 if (TestConfigFile
|| !ErrorLog
)
587 if ((level
> LogLevel
||
588 (level
== CUPSD_LOG_INFO
&& LogLevel
< CUPSD_LOG_DEBUG
)) &&
589 LogDebugHistory
<= 0)
593 if (!strcmp(ErrorLog
, "syslog"))
595 asl_object_t m
; /* Log message */
596 char job_id
[32], /* job-id string */
597 completed
[32]; /* job-impressions-completed string */
598 static const char * const job_states
[] =
599 { /* job-state strings */
609 snprintf(job_id
, sizeof(job_id
), "%d", job
->id
);
611 m
= asl_new(ASL_TYPE_MSG
);
612 asl_set(m
, ASL_KEY_FACILITY
, "org.cups.cupsd");
613 asl_set(m
, PWG_Event
, "JobStateChanged");
614 asl_set(m
, PWG_ServiceURI
, job
->printer
->uri
);
615 asl_set(m
, PWG_JobID
, job_id
);
616 asl_set(m
, PWG_JobState
, job_states
[job
->state_value
- IPP_JSTATE_PENDING
]);
618 if (job
->impressions
)
620 snprintf(completed
, sizeof(completed
), "%d", ippGetInteger(job
->impressions
, 0));
621 asl_set(m
, PWG_JobImpressionsCompleted
, completed
);
624 va_start(ap
, message
);
625 asl_vlog(NULL
, m
, log_levels
[level
], message
, ap
);
632 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
633 if (!strcmp(ErrorLog
, "syslog"))
635 static const char * const job_states
[] =
636 { /* job-state strings */
646 va_start(ap
, message
);
651 status
= format_log_line(message
, ap2
);
658 sd_journal_send("MESSAGE=%s", log_line
,
659 "PRIORITY=%i", log_levels
[level
],
660 PWG_Event
"=JobStateChanged",
661 PWG_ServiceURI
"=%s", job
->printer
->uri
,
662 PWG_JobID
"=%d", job
->id
,
663 PWG_JobState
"=%s", job_states
[job
->state_value
- IPP_JSTATE_PENDING
],
664 PWG_JobImpressionsCompleted
"=%d", ippGetInteger(job
->impressions
, 0),
669 #endif /* HAVE_ASL_H */
672 * Format and write the log message...
676 snprintf(jobmsg
, sizeof(jobmsg
), "[Job %d] %s", job
->id
, message
);
678 strlcpy(jobmsg
, message
, sizeof(jobmsg
));
680 va_start(ap
, message
);
685 status
= format_log_line(jobmsg
, ap2
);
696 (level
== CUPSD_LOG_INFO
&& LogLevel
< CUPSD_LOG_DEBUG
)) &&
700 * Add message to the job history...
703 cupsd_joblog_t
*temp
; /* Copy of log message */
704 size_t log_len
= strlen(log_line
);
705 /* Length of log message */
707 if ((temp
= malloc(sizeof(cupsd_joblog_t
) + log_len
)) != NULL
)
709 temp
->time
= time(NULL
);
710 memcpy(temp
->message
, log_line
, log_len
+ 1);
714 job
->history
= cupsArrayNew(NULL
, NULL
);
716 if (job
->history
&& temp
)
718 cupsArrayAdd(job
->history
, temp
);
720 if (cupsArrayCount(job
->history
) > LogDebugHistory
)
723 * Remove excess messages...
726 temp
= cupsArrayFirst(job
->history
);
727 cupsArrayRemove(job
->history
, temp
);
736 else if (level
<= LogLevel
&&
737 (level
!= CUPSD_LOG_INFO
|| LogLevel
>= CUPSD_LOG_DEBUG
))
738 return (cupsdWriteErrorLog(level
, log_line
));
743 return (cupsdWriteErrorLog(CUPSD_LOG_ERROR
,
744 "Unable to allocate memory for log line."));
749 * 'cupsdLogMessage()' - Log a message to the error log file.
752 int /* O - 1 on success, 0 on error */
753 cupsdLogMessage(int level
, /* I - Log level */
754 const char *message
, /* I - printf-style message string */
755 ...) /* I - Additional args as needed */
757 va_list ap
, ap2
; /* Argument pointers */
758 int status
; /* Formatting status */
762 * See if we want to log this message...
765 if ((TestConfigFile
|| !ErrorLog
) && level
<= CUPSD_LOG_WARN
)
767 va_start(ap
, message
);
770 asl_object_t m
; /* Log message */
772 m
= asl_new(ASL_TYPE_MSG
);
773 asl_set(m
, ASL_KEY_FACILITY
, "org.cups.cupsd");
774 asl_vlog(NULL
, m
, log_levels
[level
], message
, ap
);
777 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
778 sd_journal_printv(log_levels
[level
], message
, ap
);
780 #elif defined(HAVE_VSYSLOG)
781 vsyslog(LOG_LPR
| log_levels
[level
], message
, ap
);
784 vfprintf(stderr
, message
, ap
);
786 #endif /* HAVE_VSYSLOG */
793 if (level
> LogLevel
|| !ErrorLog
)
797 if (!strcmp(ErrorLog
, "syslog"))
799 asl_object_t m
; /* Log message */
801 m
= asl_new(ASL_TYPE_MSG
);
802 asl_set(m
, ASL_KEY_FACILITY
, "org.cups.cupsd");
804 va_start(ap
, message
);
805 asl_vlog(NULL
, m
, log_levels
[level
], message
, ap
);
812 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
813 if (!strcmp(ErrorLog
, "syslog"))
815 sd_journal_printv(log_levels
[level
], message
, ap
);
818 #endif /* HAVE_ASL_H */
821 * Format and write the log message...
824 va_start(ap
, message
);
829 status
= format_log_line(message
, ap2
);
837 return (cupsdWriteErrorLog(level
, log_line
));
839 return (cupsdWriteErrorLog(CUPSD_LOG_ERROR
,
840 "Unable to allocate memory for log line!"));
845 * 'cupsdLogPage()' - Log a page to the page log file.
848 int /* O - 1 on success, 0 on error */
849 cupsdLogPage(cupsd_job_t
*job
, /* I - Job being printed */
850 const char *page
) /* I - Page being printed */
852 int i
; /* Looping var */
853 char buffer
[2048], /* Buffer for page log */
854 *bufptr
, /* Pointer into buffer */
855 name
[256]; /* Attribute name */
856 const char *format
, /* Pointer into PageLogFormat */
857 *nameend
; /* End of attribute name */
858 ipp_attribute_t
*attr
; /* Current attribute */
859 char number
[256]; /* Page number */
860 int copies
; /* Number of copies */
864 * Format the line going into the page log...
870 strlcpy(number
, "1", sizeof(number
));
872 sscanf(page
, "%255s%d", number
, &copies
);
874 for (format
= PageLogFormat
, bufptr
= buffer
; *format
; format
++)
882 case '%' : /* Literal % */
883 if (bufptr
< (buffer
+ sizeof(buffer
) - 1))
887 case 'p' : /* Printer name */
888 strlcpy(bufptr
, job
->printer
->name
, sizeof(buffer
) - (size_t)(bufptr
- buffer
));
889 bufptr
+= strlen(bufptr
);
892 case 'j' : /* Job ID */
893 snprintf(bufptr
, sizeof(buffer
) - (size_t)(bufptr
- buffer
), "%d", job
->id
);
894 bufptr
+= strlen(bufptr
);
897 case 'u' : /* Username */
898 strlcpy(bufptr
, job
->username
? job
->username
: "-", sizeof(buffer
) - (size_t)(bufptr
- buffer
));
899 bufptr
+= strlen(bufptr
);
902 case 'T' : /* Date and time */
903 strlcpy(bufptr
, cupsdGetDateTime(NULL
, LogTimeFormat
), sizeof(buffer
) - (size_t)(bufptr
- buffer
));
904 bufptr
+= strlen(bufptr
);
907 case 'P' : /* Page number */
908 strlcpy(bufptr
, number
, sizeof(buffer
) - (size_t)(bufptr
- buffer
));
909 bufptr
+= strlen(bufptr
);
912 case 'C' : /* Number of copies */
913 snprintf(bufptr
, sizeof(buffer
) - (size_t)(bufptr
- buffer
), "%d", copies
);
914 bufptr
+= strlen(bufptr
);
917 case '{' : /* {attribute} */
918 if ((nameend
= strchr(format
, '}')) != NULL
&& (size_t)(nameend
- format
- 2) < (sizeof(name
) - 1))
921 * Pull the name from inside the brackets...
924 memcpy(name
, format
+ 1, (size_t)(nameend
- format
- 1));
925 name
[nameend
- format
- 1] = '\0';
929 attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
);
930 if (!attr
&& !strcmp(name
, "job-billing"))
933 * Handle alias "job-account-id" (which was standardized after
934 * "job-billing" was defined for CUPS...
937 attr
= ippFindAttribute(job
->attrs
, "job-account-id", IPP_TAG_ZERO
);
939 else if (!attr
&& !strcmp(name
, "media"))
942 * Handle alias "media-col" which uses dimensions instead of
946 attr
= ippFindAttribute(job
->attrs
, "media-col/media-size", IPP_TAG_BEGIN_COLLECTION
);
952 * Add the attribute value...
956 i
< attr
->num_values
&&
957 bufptr
< (buffer
+ sizeof(buffer
) - 1);
963 switch (attr
->value_tag
)
965 case IPP_TAG_INTEGER
:
967 snprintf(bufptr
, sizeof(buffer
) - (size_t)(bufptr
- buffer
), "%d", attr
->values
[i
].integer
);
968 bufptr
+= strlen(bufptr
);
971 case IPP_TAG_BOOLEAN
:
972 snprintf(bufptr
, sizeof(buffer
) - (size_t)(bufptr
- buffer
), "%d", attr
->values
[i
].boolean
);
973 bufptr
+= strlen(bufptr
);
976 case IPP_TAG_TEXTLANG
:
977 case IPP_TAG_NAMELANG
:
980 case IPP_TAG_KEYWORD
:
982 case IPP_TAG_URISCHEME
:
983 case IPP_TAG_CHARSET
:
984 case IPP_TAG_LANGUAGE
:
985 case IPP_TAG_MIMETYPE
:
986 strlcpy(bufptr
, attr
->values
[i
].string
.text
, sizeof(buffer
) - (size_t)(bufptr
- buffer
));
987 bufptr
+= strlen(bufptr
);
990 case IPP_TAG_BEGIN_COLLECTION
:
991 if (!strcmp(attr
->name
, "media-size"))
993 ipp_attribute_t
*x_dimension
= ippFindAttribute(ippGetCollection(attr
, 0), "x-dimension", IPP_TAG_INTEGER
);
994 ipp_attribute_t
*y_dimension
= ippFindAttribute(ippGetCollection(attr
, 0), "y-dimension", IPP_TAG_INTEGER
);
995 /* Media dimensions */
997 if (x_dimension
&& y_dimension
)
999 pwg_media_t
*pwg
= pwgMediaForSize(ippGetInteger(x_dimension
, 0), ippGetInteger(y_dimension
, 0));
1000 /* PWG media name */
1001 strlcpy(bufptr
, pwg
->pwg
, sizeof(buffer
) - (size_t)(bufptr
- buffer
));
1007 strlcpy(bufptr
, "???", sizeof(buffer
) - (size_t)(bufptr
- buffer
));
1008 bufptr
+= strlen(bufptr
);
1013 else if (bufptr
< (buffer
+ sizeof(buffer
) - 1))
1019 if (bufptr
< (buffer
+ sizeof(buffer
) - 2))
1022 *bufptr
++ = *format
;
1027 else if (bufptr
< (buffer
+ sizeof(buffer
) - 1))
1028 *bufptr
++ = *format
;
1034 if (!strcmp(ErrorLog
, "syslog"))
1036 asl_object_t m
; /* Log message */
1037 char job_id
[32], /* job-id string */
1038 completed
[32]; /* job-impressions-completed string */
1039 static const char * const job_states
[] =
1040 { /* job-state strings */
1044 "ProcessingStopped",
1050 snprintf(job_id
, sizeof(job_id
), "%d", job
->id
);
1052 m
= asl_new(ASL_TYPE_MSG
);
1053 asl_set(m
, ASL_KEY_FACILITY
, "org.cups.cupsd");
1054 asl_set(m
, PWG_Event
, "JobStateChanged");
1055 asl_set(m
, PWG_ServiceURI
, job
->printer
->uri
);
1056 asl_set(m
, PWG_JobID
, job_id
);
1057 asl_set(m
, PWG_JobState
, job_states
[job
->state_value
- IPP_JSTATE_PENDING
]);
1059 if (job
->impressions
)
1061 snprintf(completed
, sizeof(completed
), "%d", ippGetInteger(job
->impressions
, 0));
1062 asl_set(m
, PWG_JobImpressionsCompleted
, completed
);
1065 asl_log(NULL
, m
, ASL_LEVEL_INFO
, "%s", buffer
);
1071 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
1072 if (!strcmp(ErrorLog
, "syslog"))
1074 static const char * const job_states
[] =
1075 { /* job-state strings */
1079 "ProcessingStopped",
1085 sd_journal_send("MESSAGE=%s", buffer
,
1086 "PRIORITY=%i", LOG_INFO
,
1087 PWG_Event
"=JobStateChanged",
1088 PWG_ServiceURI
"=%s", job
->printer
->uri
,
1089 PWG_JobID
"=%d", job
->id
,
1090 PWG_JobState
"=%s", job_states
[job
->state_value
- IPP_JSTATE_PENDING
],
1091 PWG_JobImpressionsCompleted
"=%d", ippGetInteger(job
->impressions
, 0),
1096 #elif defined(HAVE_VSYSLOG)
1098 * See if we are logging pages via syslog...
1101 if (!strcmp(PageLog
, "syslog"))
1103 syslog(LOG_INFO
, "%s", buffer
);
1107 #endif /* HAVE_ASL_H */
1110 * Not using syslog; check the log file...
1113 if (!cupsdCheckLogFile(&PageFile
, PageLog
))
1117 * Print a page log entry of the form:
1119 * printer user job-id [DD/MON/YYYY:HH:MM:SS +TTTT] page num-copies \
1123 cupsFilePrintf(PageFile
, "%s\n", buffer
);
1124 cupsFileFlush(PageFile
);
1131 * 'cupsdLogRequest()' - Log an HTTP request in Common Log Format.
1134 int /* O - 1 on success, 0 on error */
1135 cupsdLogRequest(cupsd_client_t
*con
, /* I - Request to log */
1136 http_status_t code
) /* I - Response code */
1138 char temp
[2048]; /* Temporary string for URI */
1139 static const char * const states
[] = /* HTTP client states... */
1159 * Filter requests as needed...
1162 if (AccessLogLevel
== CUPSD_ACCESSLOG_NONE
)
1164 else if (AccessLogLevel
< CUPSD_ACCESSLOG_ALL
)
1167 * Eliminate simple GET, POST, and PUT requests...
1170 if ((con
->operation
== HTTP_GET
&&
1171 strncmp(con
->uri
, "/admin/conf", 11) &&
1172 strncmp(con
->uri
, "/admin/log", 10)) ||
1173 (con
->operation
== HTTP_POST
&& !con
->request
&&
1174 strncmp(con
->uri
, "/admin", 6)) ||
1175 (con
->operation
!= HTTP_GET
&& con
->operation
!= HTTP_POST
&&
1176 con
->operation
!= HTTP_PUT
))
1179 if (con
->request
&& con
->response
&&
1180 (con
->response
->request
.status
.status_code
< IPP_REDIRECTION_OTHER_SITE
||
1181 con
->response
->request
.status
.status_code
== IPP_NOT_FOUND
))
1184 * Check successful requests...
1187 ipp_op_t op
= con
->request
->request
.op
.operation_id
;
1188 static cupsd_accesslog_t standard_ops
[] =
1190 CUPSD_ACCESSLOG_ALL
, /* reserved */
1191 CUPSD_ACCESSLOG_ALL
, /* reserved */
1192 CUPSD_ACCESSLOG_ACTIONS
,/* Print-Job */
1193 CUPSD_ACCESSLOG_ACTIONS
,/* Print-URI */
1194 CUPSD_ACCESSLOG_ACTIONS
,/* Validate-Job */
1195 CUPSD_ACCESSLOG_ACTIONS
,/* Create-Job */
1196 CUPSD_ACCESSLOG_ACTIONS
,/* Send-Document */
1197 CUPSD_ACCESSLOG_ACTIONS
,/* Send-URI */
1198 CUPSD_ACCESSLOG_ACTIONS
,/* Cancel-Job */
1199 CUPSD_ACCESSLOG_ALL
, /* Get-Job-Attributes */
1200 CUPSD_ACCESSLOG_ALL
, /* Get-Jobs */
1201 CUPSD_ACCESSLOG_ALL
, /* Get-Printer-Attributes */
1202 CUPSD_ACCESSLOG_ACTIONS
,/* Hold-Job */
1203 CUPSD_ACCESSLOG_ACTIONS
,/* Release-Job */
1204 CUPSD_ACCESSLOG_ACTIONS
,/* Restart-Job */
1205 CUPSD_ACCESSLOG_ALL
, /* reserved */
1206 CUPSD_ACCESSLOG_CONFIG
, /* Pause-Printer */
1207 CUPSD_ACCESSLOG_CONFIG
, /* Resume-Printer */
1208 CUPSD_ACCESSLOG_CONFIG
, /* Purge-Jobs */
1209 CUPSD_ACCESSLOG_CONFIG
, /* Set-Printer-Attributes */
1210 CUPSD_ACCESSLOG_ACTIONS
,/* Set-Job-Attributes */
1211 CUPSD_ACCESSLOG_CONFIG
, /* Get-Printer-Supported-Values */
1212 CUPSD_ACCESSLOG_ACTIONS
,/* Create-Printer-Subscription */
1213 CUPSD_ACCESSLOG_ACTIONS
,/* Create-Job-Subscription */
1214 CUPSD_ACCESSLOG_ALL
, /* Get-Subscription-Attributes */
1215 CUPSD_ACCESSLOG_ALL
, /* Get-Subscriptions */
1216 CUPSD_ACCESSLOG_ACTIONS
,/* Renew-Subscription */
1217 CUPSD_ACCESSLOG_ACTIONS
,/* Cancel-Subscription */
1218 CUPSD_ACCESSLOG_ALL
, /* Get-Notifications */
1219 CUPSD_ACCESSLOG_ACTIONS
,/* Send-Notifications */
1220 CUPSD_ACCESSLOG_ALL
, /* reserved */
1221 CUPSD_ACCESSLOG_ALL
, /* reserved */
1222 CUPSD_ACCESSLOG_ALL
, /* reserved */
1223 CUPSD_ACCESSLOG_ALL
, /* Get-Print-Support-Files */
1224 CUPSD_ACCESSLOG_CONFIG
, /* Enable-Printer */
1225 CUPSD_ACCESSLOG_CONFIG
, /* Disable-Printer */
1226 CUPSD_ACCESSLOG_CONFIG
, /* Pause-Printer-After-Current-Job */
1227 CUPSD_ACCESSLOG_ACTIONS
,/* Hold-New-Jobs */
1228 CUPSD_ACCESSLOG_ACTIONS
,/* Release-Held-New-Jobs */
1229 CUPSD_ACCESSLOG_CONFIG
, /* Deactivate-Printer */
1230 CUPSD_ACCESSLOG_CONFIG
, /* Activate-Printer */
1231 CUPSD_ACCESSLOG_CONFIG
, /* Restart-Printer */
1232 CUPSD_ACCESSLOG_CONFIG
, /* Shutdown-Printer */
1233 CUPSD_ACCESSLOG_CONFIG
, /* Startup-Printer */
1234 CUPSD_ACCESSLOG_ACTIONS
,/* Reprocess-Job */
1235 CUPSD_ACCESSLOG_ACTIONS
,/* Cancel-Current-Job */
1236 CUPSD_ACCESSLOG_ACTIONS
,/* Suspend-Current-Job */
1237 CUPSD_ACCESSLOG_ACTIONS
,/* Resume-Job */
1238 CUPSD_ACCESSLOG_ACTIONS
,/* Promote-Job */
1239 CUPSD_ACCESSLOG_ACTIONS
/* Schedule-Job-After */
1241 static cupsd_accesslog_t cups_ops
[] =
1243 CUPSD_ACCESSLOG_ALL
, /* CUPS-Get-Default */
1244 CUPSD_ACCESSLOG_ALL
, /* CUPS-Get-Printers */
1245 CUPSD_ACCESSLOG_CONFIG
, /* CUPS-Add-Modify-Printer */
1246 CUPSD_ACCESSLOG_CONFIG
, /* CUPS-Delete-Printer */
1247 CUPSD_ACCESSLOG_ALL
, /* CUPS-Get-Classes */
1248 CUPSD_ACCESSLOG_CONFIG
, /* CUPS-Add-Modify-Class */
1249 CUPSD_ACCESSLOG_CONFIG
, /* CUPS-Delete-Class */
1250 CUPSD_ACCESSLOG_CONFIG
, /* CUPS-Accept-Jobs */
1251 CUPSD_ACCESSLOG_CONFIG
, /* CUPS-Reject-Jobs */
1252 CUPSD_ACCESSLOG_CONFIG
, /* CUPS-Set-Default */
1253 CUPSD_ACCESSLOG_CONFIG
, /* CUPS-Get-Devices */
1254 CUPSD_ACCESSLOG_CONFIG
, /* CUPS-Get-PPDs */
1255 CUPSD_ACCESSLOG_ACTIONS
,/* CUPS-Move-Job */
1256 CUPSD_ACCESSLOG_ACTIONS
,/* CUPS-Authenticate-Job */
1257 CUPSD_ACCESSLOG_ALL
/* CUPS-Get-PPD */
1261 if ((op
<= IPP_SCHEDULE_JOB_AFTER
&& standard_ops
[op
] > AccessLogLevel
) ||
1262 (op
>= CUPS_GET_DEFAULT
&& op
<= CUPS_GET_PPD
&&
1263 cups_ops
[op
- CUPS_GET_DEFAULT
] > AccessLogLevel
))
1269 if (!strcmp(ErrorLog
, "syslog"))
1271 asl_object_t m
; /* Log message */
1273 m
= asl_new(ASL_TYPE_MSG
);
1274 asl_set(m
, ASL_KEY_FACILITY
, "org.cups.cupsd");
1276 asl_log(NULL
, m
, ASL_LEVEL_INFO
, "REQUEST %s - %s \"%s %s HTTP/%d.%d\" %d " CUPS_LLFMT
" %s %s\n",
1277 con
->http
->hostname
, con
->username
[0] != '\0' ? con
->username
: "-",
1278 states
[con
->operation
], _httpEncodeURI(temp
, con
->uri
, sizeof(temp
)),
1279 con
->http
->version
/ 100, con
->http
->version
% 100,
1280 code
, CUPS_LLCAST con
->bytes
,
1282 ippOpString(con
->request
->request
.op
.operation_id
) : "-",
1284 ippErrorString(con
->response
->request
.status
.status_code
) : "-");
1290 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
1291 if (!strcmp(ErrorLog
, "syslog"))
1293 sd_journal_print(LOG_INFO
, "REQUEST %s - %s \"%s %s HTTP/%d.%d\" %d " CUPS_LLFMT
" %s %s", con
->http
->hostname
, con
->username
[0] != '\0' ? con
->username
: "-", states
[con
->operation
], _httpEncodeURI(temp
, con
->uri
, sizeof(temp
)), con
->http
->version
/ 100, con
->http
->version
% 100, code
, CUPS_LLCAST con
->bytes
, con
->request
? ippOpString(con
->request
->request
.op
.operation_id
) : "-", con
->response
? ippErrorString(con
->response
->request
.status
.status_code
) : "-");
1297 #elif defined(HAVE_VSYSLOG)
1299 * See if we are logging accesses via syslog...
1302 if (!strcmp(AccessLog
, "syslog"))
1305 "REQUEST %s - %s \"%s %s HTTP/%d.%d\" %d " CUPS_LLFMT
" %s %s\n",
1306 con
->http
->hostname
, con
->username
[0] != '\0' ? con
->username
: "-",
1307 states
[con
->operation
], _httpEncodeURI(temp
, con
->uri
, sizeof(temp
)),
1308 con
->http
->version
/ 100, con
->http
->version
% 100,
1309 code
, CUPS_LLCAST con
->bytes
,
1311 ippOpString(con
->request
->request
.op
.operation_id
) : "-",
1313 ippErrorString(con
->response
->request
.status
.status_code
) : "-");
1317 #endif /* HAVE_ASL_H */
1320 * Not using syslog; check the log file...
1323 if (!cupsdCheckLogFile(&AccessFile
, AccessLog
))
1327 * Write a log of the request in "common log format"...
1330 cupsFilePrintf(AccessFile
,
1331 "%s - %s %s \"%s %s HTTP/%d.%d\" %d " CUPS_LLFMT
" %s %s\n",
1332 con
->http
->hostname
,
1333 con
->username
[0] != '\0' ? con
->username
: "-",
1334 cupsdGetDateTime(&(con
->start
), LogTimeFormat
),
1335 states
[con
->operation
],
1336 _httpEncodeURI(temp
, con
->uri
, sizeof(temp
)),
1337 con
->http
->version
/ 100, con
->http
->version
% 100,
1338 code
, CUPS_LLCAST con
->bytes
,
1340 ippOpString(con
->request
->request
.op
.operation_id
) : "-",
1342 ippErrorString(con
->response
->request
.status
.status_code
) :
1345 cupsFileFlush(AccessFile
);
1352 * 'cupsdWriteErrorLog()' - Write a line to the ErrorLog.
1355 int /* O - 1 on success, 0 on failure */
1356 cupsdWriteErrorLog(int level
, /* I - Log level */
1357 const char *message
) /* I - Message string */
1359 int ret
= 1; /* Return value */
1360 static const char levels
[] = /* Log levels... */
1376 if (!strcmp(ErrorLog
, "syslog"))
1378 asl_object_t m
; /* Log message */
1380 m
= asl_new(ASL_TYPE_MSG
);
1381 asl_set(m
, ASL_KEY_FACILITY
, "org.cups.cupsd");
1382 asl_log(NULL
, m
, ASL_LEVEL_INFO
, "%s", message
);
1388 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
1389 if (!strcmp(ErrorLog
, "syslog"))
1391 sd_journal_print(log_levels
[level
], "%s", message
);
1395 #elif defined(HAVE_VSYSLOG)
1397 * See if we are logging errors via syslog...
1400 if (!strcmp(ErrorLog
, "syslog"))
1402 syslog(log_levels
[level
], "%s", message
);
1405 #endif /* HAVE_ASL_H */
1408 * Not using syslog; check the log file...
1411 _cupsMutexLock(&log_mutex
);
1413 if (!cupsdCheckLogFile(&ErrorFile
, ErrorLog
))
1420 * Write the log message...
1423 cupsFilePrintf(ErrorFile
, "%c %s %s\n", levels
[level
],
1424 cupsdGetDateTime(NULL
, LogTimeFormat
), message
);
1425 cupsFileFlush(ErrorFile
);
1428 _cupsMutexUnlock(&log_mutex
);
1435 * 'format_log_line()' - Format a line for a log file.
1437 * This function resizes a global string buffer as needed. Each call returns
1438 * a pointer to this buffer, so the contents are only good until the next call
1439 * to format_log_line()...
1442 static int /* O - -1 for fatal, 0 for retry, 1 for success */
1443 format_log_line(const char *message
, /* I - Printf-style format string */
1444 va_list ap
) /* I - Argument list */
1446 ssize_t len
; /* Length of formatted line */
1450 * Allocate the line buffer as needed...
1455 log_linesize
= 8192;
1456 log_line
= malloc(log_linesize
);
1463 * Format the log message...
1466 len
= vsnprintf(log_line
, log_linesize
, message
, ap
);
1469 * Resize the buffer as needed...
1472 if ((size_t)len
>= log_linesize
&& log_linesize
< 65536)
1474 char *temp
; /* Temporary string pointer */
1481 else if (len
> 65536)
1484 temp
= realloc(log_line
, (size_t)len
);
1489 log_linesize
= (size_t)len
;