2 * Job management routines for the CUPS scheduler.
4 * Copyright © 2007-2019 by Apple Inc.
5 * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
12 * Include necessary headers...
17 #include <cups/backend.h>
20 # include <IOKit/pwr_mgt/IOPMLib.h>
21 # ifdef HAVE_IOKIT_PWR_MGT_IOPMLIBPRIVATE_H
22 # include <IOKit/pwr_mgt/IOPMLibPrivate.h>
23 # endif /* HAVE_IOKIT_PWR_MGT_IOPMLIBPRIVATE_H */
24 #endif /* __APPLE__ */
28 * Design Notes for Job Management
29 * -------------------------------
33 * pending Do nothing/check jobs
34 * pending-held Send SIGTERM to filters and backend
35 * processing Do nothing/start job
36 * stopped Send SIGKILL to filters and backend
37 * canceled Send SIGTERM to filters and backend
41 * Finalize clears the printer <-> job association, deletes the status
42 * buffer, closes all of the pipes, etc. and doesn't get run until all of
43 * the print processes are finished.
45 * UNLOADING OF JOBS (cupsdUnloadCompletedJobs)
47 * We unload the job attributes when they are not needed to reduce overall
48 * memory consumption. We don't unload jobs where job->state_value <
49 * IPP_JOB_STOPPED, job->printer != NULL, or job->access_time is recent.
51 * STARTING OF JOBS (start_job)
53 * When a job is started, a status buffer, several pipes, a security
54 * profile, and a backend process are created for the life of that job.
55 * These are shared for every file in a job. For remote print jobs, the
56 * IPP backend is provided with every file in the job and no filters are
59 * The job->printer member tracks which printer is printing a job, which
60 * can be different than the destination in job->dest for classes. The
61 * printer object also has a job pointer to track which job is being
64 * PRINTING OF JOB FILES (cupsdContinueJob)
66 * Each file in a job is filtered by 0 or more programs. After getting the
67 * list of filters needed and the total cost, the job is either passed or
68 * put back to the processing state until the current FilterLevel comes down
69 * enough to allow printing.
71 * If we can print, we build a string for the print options and run each of
72 * the filters, piping the output from one into the next.
74 * JOB STATUS UPDATES (update_job)
76 * The update_job function gets called whenever there are pending messages
77 * on the status pipe. These generally are updates to the marker-*,
78 * printer-state-message, or printer-state-reasons attributes. On EOF,
79 * finalize_job is called to clean up.
81 * FINALIZING JOBS (finalize_job)
83 * When all filters and the backend are done, we set the job state to
84 * completed (no errors), aborted (filter errors or abort-job policy),
85 * pending-held (auth required or retry-job policy), or pending
86 * (retry-current-job or stop-printer policies) as appropriate.
88 * Then we close the pipes and free the status buffers and profiles.
90 * JOB FILE COMPLETION (process_children in main.c)
92 * For multiple-file jobs, process_children (in main.c) sees that all
93 * filters have exited and calls in to print the next file if there are
94 * more files in the job, otherwise it waits for the backend to exit and
95 * update_job to do the cleanup.
103 static mime_filter_t gziptoany_filter
=
105 NULL
, /* Source type */
106 NULL
, /* Destination type */
108 "gziptoany" /* Filter program to run */
116 static int compare_active_jobs(void *first
, void *second
, void *data
);
117 static int compare_completed_jobs(void *first
, void *second
, void *data
);
118 static int compare_jobs(void *first
, void *second
, void *data
);
119 static void dump_job_history(cupsd_job_t
*job
);
120 static void finalize_job(cupsd_job_t
*job
, int set_job_state
);
121 static void free_job_history(cupsd_job_t
*job
);
122 static char *get_options(cupsd_job_t
*job
, int banner_page
, char *copies
,
123 size_t copies_size
, char *title
,
125 static size_t ipp_length(ipp_t
*ipp
);
126 static void load_job_cache(const char *filename
);
127 static void load_next_job_id(const char *filename
);
128 static void load_request_root(void);
129 static void remove_job_files(cupsd_job_t
*job
);
130 static void remove_job_history(cupsd_job_t
*job
);
131 static void set_time(cupsd_job_t
*job
, const char *name
);
132 static void start_job(cupsd_job_t
*job
, cupsd_printer_t
*printer
);
133 static void stop_job(cupsd_job_t
*job
, cupsd_jobaction_t action
);
134 static void unload_job(cupsd_job_t
*job
);
135 static void update_job(cupsd_job_t
*job
);
136 static void update_job_attrs(cupsd_job_t
*job
, int do_message
);
140 * 'cupsdAddJob()' - Add a new job to the job queue.
143 cupsd_job_t
* /* O - New job record */
144 cupsdAddJob(int priority
, /* I - Job priority */
145 const char *dest
) /* I - Job destination */
147 cupsd_job_t
*job
; /* New job record */
150 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
153 job
->id
= NextJobId
++;
154 job
->priority
= priority
;
155 job
->back_pipes
[0] = -1;
156 job
->back_pipes
[1] = -1;
157 job
->print_pipes
[0] = -1;
158 job
->print_pipes
[1] = -1;
159 job
->side_pipes
[0] = -1;
160 job
->side_pipes
[1] = -1;
161 job
->status_pipes
[0] = -1;
162 job
->status_pipes
[1] = -1;
164 cupsdSetString(&job
->dest
, dest
);
167 * Add the new job to the "all jobs" and "active jobs" lists...
170 cupsArrayAdd(Jobs
, job
);
171 cupsArrayAdd(ActiveJobs
, job
);
178 * 'cupsdCancelJobs()' - Cancel all jobs for the given destination/user.
182 cupsdCancelJobs(const char *dest
, /* I - Destination to cancel */
183 const char *username
, /* I - Username or NULL */
184 int purge
) /* I - Purge jobs? */
186 cupsd_job_t
*job
; /* Current job */
189 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
191 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
193 if ((!job
->dest
|| !job
->username
) && !cupsdLoadJob(job
))
196 if ((!dest
|| !strcmp(job
->dest
, dest
)) &&
197 (!username
|| !strcmp(job
->username
, username
)))
200 * Cancel all jobs matching this destination/user...
204 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_PURGE
,
205 "Job purged by user.");
206 else if (job
->state_value
< IPP_JOB_CANCELED
)
207 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
,
208 "Job canceled by user.");
215 * 'cupsdCheckJobs()' - Check the pending jobs and start any if the destination
222 cupsd_job_t
*job
; /* Current job in queue */
223 cupsd_printer_t
*printer
, /* Printer destination */
224 *pclass
; /* Printer class destination */
225 ipp_attribute_t
*attr
; /* Job attribute */
226 time_t curtime
; /* Current time */
227 const char *reasons
; /* job-state-reasons value */
230 curtime
= time(NULL
);
232 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCheckJobs: %d active jobs, sleeping=%d, ac-power=%d, reload=%d, curtime=%ld", cupsArrayCount(ActiveJobs
), Sleeping
, ACPower
, NeedReload
, (long)curtime
);
234 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
);
236 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
238 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
239 "cupsdCheckJobs: Job %d - dest=\"%s\", printer=%p, "
240 "state=%d, cancel_time=%ld, hold_until=%ld, kill_time=%ld, "
241 "pending_cost=%d, pending_timeout=%ld", job
->id
, job
->dest
,
242 job
->printer
, job
->state_value
, (long)job
->cancel_time
,
243 (long)job
->hold_until
, (long)job
->kill_time
,
244 job
->pending_cost
, (long)job
->pending_timeout
);
247 * Kill jobs if they are unresponsive...
250 if (job
->kill_time
&& job
->kill_time
<= curtime
)
253 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Stopping unresponsive job.");
255 stop_job(job
, CUPSD_JOB_FORCE
);
260 * Cancel stuck jobs...
263 if (job
->cancel_time
&& job
->cancel_time
<= curtime
)
265 int cancel_after
; /* job-cancel-after value */
267 attr
= ippFindAttribute(job
->attrs
, "job-cancel-after", IPP_TAG_INTEGER
);
268 cancel_after
= attr
? ippGetInteger(attr
, 0) : MaxJobTime
;
271 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_FORCE
, "Marking stuck job as completed after %d seconds.", cancel_after
);
273 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
, "Canceling stuck job after %d seconds.", cancel_after
);
278 * Start held jobs if they are ready...
281 if (job
->state_value
== IPP_JOB_HELD
&&
283 job
->hold_until
< curtime
)
285 if (job
->pending_timeout
)
288 * This job is pending; check that we don't have an active Send-Document
289 * operation in progress on any of the client connections, then timeout
290 * the job so we can start printing...
293 cupsd_client_t
*con
; /* Current client connection */
295 for (con
= (cupsd_client_t
*)cupsArrayFirst(Clients
);
297 con
= (cupsd_client_t
*)cupsArrayNext(Clients
))
299 con
->request
->request
.op
.operation_id
== IPP_SEND_DOCUMENT
)
305 if (cupsdTimeoutJob(job
))
309 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
310 "Job submission timed out.");
314 * Continue jobs that are waiting on the FilterLimit...
317 if (job
->pending_cost
> 0 &&
318 ((FilterLevel
+ job
->pending_cost
) < FilterLimit
|| FilterLevel
== 0))
319 cupsdContinueJob(job
);
322 * Skip jobs that where held-on-create
325 reasons
= ippGetString(job
->reasons
, 0, NULL
);
326 if (reasons
&& !strcmp(reasons
, "job-held-on-create"))
329 * Check whether the printer is still holding new jobs...
332 printer
= cupsdFindDest(job
->dest
);
334 if (printer
->holding_new_jobs
)
337 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
341 * Start pending jobs if the destination is available...
344 if (job
->state_value
== IPP_JOB_PENDING
&& !NeedReload
&&
345 (!Sleeping
|| ACPower
) && !DoingShutdown
&& !job
->printer
)
347 printer
= cupsdFindDest(job
->dest
);
350 while (printer
&& (printer
->type
& CUPS_PRINTER_CLASS
))
353 * If the class is remote, just pass it to the remote server...
358 if (pclass
->state
== IPP_PRINTER_STOPPED
)
360 else if (pclass
->type
& CUPS_PRINTER_REMOTE
)
363 printer
= cupsdFindAvailablePrinter(printer
->name
);
366 if (!printer
&& !pclass
)
369 * Whoa, the printer and/or class for this destination went away;
373 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_PURGE
,
374 "Job aborted because the destination printer/class "
380 * See if the printer is available or remote and not printing a job;
381 * if so, start the job...
387 * Add/update a job-printer-uri-actual attribute for this job
388 * so that we know which printer actually printed the job...
391 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri-actual", IPP_TAG_URI
)) != NULL
)
392 ippSetString(job
->attrs
, &attr
, 0, printer
->uri
);
394 ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_URI
, "job-printer-uri-actual", NULL
, printer
->uri
);
397 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
400 if (!printer
->job
&& printer
->state
== IPP_PRINTER_IDLE
)
406 cupsArraySave(ActiveJobs
);
407 start_job(job
, printer
);
408 cupsArrayRestore(ActiveJobs
);
417 * 'cupsdCleanJobs()' - Clean out old jobs.
423 cupsd_job_t
*job
; /* Current job */
424 time_t curtime
; /* Current time */
427 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
428 "cupsdCleanJobs: MaxJobs=%d, JobHistory=%d, JobFiles=%d",
429 MaxJobs
, JobHistory
, JobFiles
);
431 if (MaxJobs
<= 0 && JobHistory
== INT_MAX
&& JobFiles
== INT_MAX
)
434 curtime
= time(NULL
);
435 JobHistoryUpdate
= 0;
437 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCleanJobs: curtime=%d", (int)curtime
);
439 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
441 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
443 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCleanJobs: Job %d, state=%d, printer=%p, history_time=%d, file_time=%d", job
->id
, (int)job
->state_value
, (void *)job
->printer
, (int)job
->history_time
, (int)job
->file_time
);
445 if ((job
->history_time
&& job
->history_time
) < JobHistoryUpdate
|| !JobHistoryUpdate
)
446 JobHistoryUpdate
= job
->history_time
;
448 if ((job
->file_time
&& job
->file_time
< JobHistoryUpdate
) || !JobHistoryUpdate
)
449 JobHistoryUpdate
= job
->file_time
;
451 if (job
->state_value
>= IPP_JOB_CANCELED
&& !job
->printer
)
454 * Expire old jobs (or job files)...
457 if ((MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
) ||
458 (job
->history_time
&& job
->history_time
<= curtime
))
460 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Removing from history.");
461 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
463 else if (job
->file_time
&& job
->file_time
<= curtime
)
465 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Removing document files.");
466 remove_job_files(job
);
468 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
473 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCleanJobs: JobHistoryUpdate=%ld",
474 (long)JobHistoryUpdate
);
479 * 'cupsdContinueJob()' - Continue printing with the next file in a job.
483 cupsdContinueJob(cupsd_job_t
*job
) /* I - Job */
485 int i
; /* Looping var */
486 int slot
; /* Pipe slot */
487 cups_array_t
*filters
= NULL
,/* Filters for job */
488 *prefilters
; /* Filters with prefilters */
489 mime_filter_t
*filter
, /* Current filter */
490 *prefilter
, /* Prefilter */
491 port_monitor
; /* Port monitor filter */
492 char scheme
[255]; /* Device URI scheme */
493 ipp_attribute_t
*attr
; /* Current attribute */
494 const char *ptr
, /* Pointer into value */
495 *abort_message
; /* Abort message */
496 ipp_jstate_t abort_state
= IPP_JOB_STOPPED
;
497 /* New job state on abort */
498 struct stat backinfo
; /* Backend file information */
499 int backroot
; /* Run backend as root? */
500 int pid
; /* Process ID of new filter process */
501 int banner_page
; /* 1 if banner page, 0 otherwise */
502 int filterfds
[2][2] = { { -1, -1 }, { -1, -1 } };
503 /* Pipes used between filters */
504 int envc
; /* Number of environment variables */
505 struct stat fileinfo
; /* Job file information */
506 int argc
= 0; /* Number of arguments */
507 char **argv
= NULL
, /* Filter command-line arguments */
508 filename
[1024], /* Job filename */
509 command
[1024], /* Full path to command */
510 jobid
[255], /* Job ID string */
512 /* Job title string */
513 copies
[255], /* # copies string */
514 *options
, /* Options string */
516 /* Environment variables */
517 charset
[255], /* CHARSET env variable */
518 class_name
[255],/* CLASS env variable */
519 classification
[1024],
520 /* CLASSIFICATION env variable */
522 /* CONTENT_TYPE env variable */
524 /* DEVICE_URI env variable */
525 final_content_type
[1024] = "",
526 /* FINAL_CONTENT_TYPE env variable */
527 lang
[255], /* LANG env variable */
530 /* APPLE_LANGUAGE env variable */
531 #endif /* __APPLE__ */
532 auth_info_required
[255],
533 /* AUTH_INFO_REQUIRED env variable */
534 ppd
[1024], /* PPD env variable */
536 /* PRINTER_INFO env variable */
537 printer_location
[255],
538 /* PRINTER_LOCATION env variable */
540 /* PRINTER env variable */
541 *printer_state_reasons
= NULL
,
542 /* PRINTER_STATE_REASONS env var */
544 /* RIP_MAX_CACHE env variable */
547 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
548 "cupsdContinueJob(job=%p(%d)): current_file=%d, num_files=%d",
549 job
, job
->id
, job
->current_file
, job
->num_files
);
552 * Figure out what filters are required to convert from
553 * the source to the destination type...
556 FilterLevel
-= job
->cost
;
559 job
->pending_cost
= 0;
561 memset(job
->filters
, 0, sizeof(job
->filters
));
563 if (job
->printer
->raw
)
566 * Remote jobs and raw queues go directly to the printer without
570 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Sending job to queue tagged as raw...");
575 * Local jobs get filtered...
578 mime_type_t
*dst
= job
->printer
->filetype
;
579 /* Destination file type */
581 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
582 job
->id
, job
->current_file
+ 1);
583 if (stat(filename
, &fileinfo
))
584 fileinfo
.st_size
= 0;
586 if (job
->retry_as_raster
)
589 * Need to figure out whether the printer supports image/pwg-raster or
590 * image/urf, and use the corresponding type...
593 char type
[MIME_MAX_TYPE
]; /* MIME media type for printer */
595 snprintf(type
, sizeof(type
), "%s/image/urf", job
->printer
->name
);
596 if ((dst
= mimeType(MimeDatabase
, "printer", type
)) == NULL
)
598 snprintf(type
, sizeof(type
), "%s/image/pwg-raster", job
->printer
->name
);
599 dst
= mimeType(MimeDatabase
, "printer", type
);
603 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Retrying job as \"%s\".", strchr(dst
->type
, '/') + 1);
605 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to retry job using a supported raster format.");
608 filters
= mimeFilter2(MimeDatabase
, job
->filetypes
[job
->current_file
], (size_t)fileinfo
.st_size
, dst
, &(job
->cost
));
612 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
613 "Unable to convert file %d to printable format.",
616 abort_message
= "Aborting job because it cannot be printed.";
617 abort_state
= IPP_JOB_ABORTED
;
619 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
624 * Figure out the final content type...
627 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%d filters for job:",
628 cupsArrayCount(filters
));
629 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
631 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
632 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s (%s/%s to %s/%s, cost %d)",
634 filter
->src
? filter
->src
->super
: "???",
635 filter
->src
? filter
->src
->type
: "???",
636 filter
->dst
? filter
->dst
->super
: "???",
637 filter
->dst
? filter
->dst
->type
: "???",
640 if (!job
->printer
->remote
)
642 for (filter
= (mime_filter_t
*)cupsArrayLast(filters
);
643 filter
&& filter
->dst
;
644 filter
= (mime_filter_t
*)cupsArrayPrev(filters
))
645 if (strcmp(filter
->dst
->super
, "printer") ||
646 strcmp(filter
->dst
->type
, job
->printer
->name
))
649 if (filter
&& filter
->dst
)
651 if ((ptr
= strchr(filter
->dst
->type
, '/')) != NULL
)
652 snprintf(final_content_type
, sizeof(final_content_type
),
653 "FINAL_CONTENT_TYPE=%s", ptr
+ 1);
655 snprintf(final_content_type
, sizeof(final_content_type
),
656 "FINAL_CONTENT_TYPE=%s/%s", filter
->dst
->super
,
660 snprintf(final_content_type
, sizeof(final_content_type
),
661 "FINAL_CONTENT_TYPE=printer/%s", job
->printer
->name
);
665 * Remove NULL ("-") filters...
668 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
670 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
671 if (!strcmp(filter
->filter
, "-"))
672 cupsArrayRemove(filters
, filter
);
674 if (cupsArrayCount(filters
) == 0)
676 cupsArrayDelete(filters
);
681 * If this printer has any pre-filters, insert the required pre-filter
682 * in the filters array...
685 if (job
->printer
->prefiltertype
&& filters
)
687 prefilters
= cupsArrayNew(NULL
, NULL
);
689 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
691 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
693 if ((prefilter
= mimeFilterLookup(MimeDatabase
, filter
->src
,
694 job
->printer
->prefiltertype
)))
696 cupsArrayAdd(prefilters
, prefilter
);
697 job
->cost
+= prefilter
->cost
;
700 cupsArrayAdd(prefilters
, filter
);
703 cupsArrayDelete(filters
);
704 filters
= prefilters
;
709 * Set a minimum cost of 100 for all jobs so that FilterLimit
710 * works with raw queues and other low-cost paths.
717 * See if the filter cost is too high...
720 if ((FilterLevel
+ job
->cost
) > FilterLimit
&& FilterLevel
> 0 &&
724 * Don't print this job quite yet...
727 cupsArrayDelete(filters
);
729 cupsdLogJob(job
, CUPSD_LOG_INFO
,
730 "Holding because filter limit has been reached.");
731 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
,
732 "cupsdContinueJob: file=%d, cost=%d, level=%d, limit=%d",
733 job
->current_file
, job
->cost
, FilterLevel
,
736 job
->pending_cost
= job
->cost
;
741 FilterLevel
+= job
->cost
;
744 * Add decompression/raw filter as needed...
747 if ((job
->compressions
[job
->current_file
] && (!job
->printer
->remote
|| job
->num_files
== 1)) ||
748 (!job
->printer
->remote
&& job
->printer
->raw
&& job
->num_files
> 1))
751 * Add gziptoany filter to the front of the list...
755 filters
= cupsArrayNew(NULL
, NULL
);
757 if (!cupsArrayInsert(filters
, &gziptoany_filter
))
759 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
760 "Unable to add decompression filter - %s", strerror(errno
));
762 cupsArrayDelete(filters
);
764 abort_message
= "Stopping job because the scheduler ran out of memory.";
771 * Add port monitor, if any...
774 if (job
->printer
->port_monitor
)
777 * Add port monitor to the end of the list...
781 filters
= cupsArrayNew(NULL
, NULL
);
783 port_monitor
.src
= NULL
;
784 port_monitor
.dst
= NULL
;
785 port_monitor
.cost
= 0;
787 snprintf(port_monitor
.filter
, sizeof(port_monitor
.filter
),
788 "%s/monitor/%s", ServerBin
, job
->printer
->port_monitor
);
790 if (!cupsArrayAdd(filters
, &port_monitor
))
792 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
793 "Unable to add port monitor - %s", strerror(errno
));
795 abort_message
= "Stopping job because the scheduler ran out of memory.";
802 * Make sure we don't go over the "MAX_FILTERS" limit...
805 if (cupsArrayCount(filters
) > MAX_FILTERS
)
807 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
808 "Too many filters (%d > %d), unable to print.",
809 cupsArrayCount(filters
), MAX_FILTERS
);
811 abort_message
= "Aborting job because it needs too many filters to print.";
812 abort_state
= IPP_JOB_ABORTED
;
814 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
820 * Determine if we are printing a banner page or not...
823 if (job
->job_sheets
== NULL
)
825 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "No job-sheets attribute.");
826 if ((job
->job_sheets
=
827 ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_ZERO
)) != NULL
)
828 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
829 "... but someone added one without setting job_sheets.");
831 else if (job
->job_sheets
->num_values
== 1)
832 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s",
833 job
->job_sheets
->values
[0].string
.text
);
835 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s,%s",
836 job
->job_sheets
->values
[0].string
.text
,
837 job
->job_sheets
->values
[1].string
.text
);
839 if (job
->printer
->type
& CUPS_PRINTER_REMOTE
)
841 else if (job
->job_sheets
== NULL
)
843 else if (_cups_strcasecmp(job
->job_sheets
->values
[0].string
.text
, "none") != 0 &&
844 job
->current_file
== 0)
846 else if (job
->job_sheets
->num_values
> 1 &&
847 _cups_strcasecmp(job
->job_sheets
->values
[1].string
.text
, "none") != 0 &&
848 job
->current_file
== (job
->num_files
- 1))
853 if ((options
= get_options(job
, banner_page
, copies
, sizeof(copies
), title
,
854 sizeof(title
))) == NULL
)
856 abort_message
= "Stopping job because the scheduler ran out of memory.";
862 * Build the command-line arguments for the filters. Each filter
863 * has 6 or 7 arguments:
871 * argv[6] = filename (optional; normally stdin)
873 * This allows legacy printer drivers that use the old System V
874 * printing interface to be used by CUPS.
876 * For remote jobs, we send all of the files in the argument list.
879 if (job
->printer
->remote
)
880 argc
= 6 + job
->num_files
;
884 if ((argv
= calloc((size_t)argc
+ 1, sizeof(char *))) == NULL
)
886 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Unable to allocate argument array - %s",
889 abort_message
= "Stopping job because the scheduler ran out of memory.";
894 sprintf(jobid
, "%d", job
->id
);
896 argv
[0] = job
->printer
->name
;
898 argv
[2] = job
->username
;
903 if (job
->printer
->remote
&& job
->num_files
> 1)
905 for (i
= 0; i
< job
->num_files
; i
++)
907 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
909 argv
[6 + i
] = strdup(filename
);
914 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
915 job
->id
, job
->current_file
+ 1);
916 argv
[6] = strdup(filename
);
919 for (i
= 0; argv
[i
]; i
++)
920 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "argv[%d]=\"%s\"", i
, argv
[i
]);
923 * Create environment variable strings for the filters...
926 attr
= ippFindAttribute(job
->attrs
, "attributes-natural-language",
930 strlcpy(apple_language
, "APPLE_LANGUAGE=", sizeof(apple_language
));
931 _cupsAppleLanguage(attr
->values
[0].string
.text
,
932 apple_language
+ 15, sizeof(apple_language
) - 15);
933 #endif /* __APPLE__ */
935 switch (strlen(attr
->values
[0].string
.text
))
939 * This is an unknown or badly formatted language code; use
940 * the POSIX locale...
943 strlcpy(lang
, "LANG=C", sizeof(lang
));
948 * Just the language code (ll)...
951 snprintf(lang
, sizeof(lang
), "LANG=%s.UTF-8",
952 attr
->values
[0].string
.text
);
957 * Language and country code (ll-cc)...
960 snprintf(lang
, sizeof(lang
), "LANG=%c%c_%c%c.UTF-8",
961 attr
->values
[0].string
.text
[0],
962 attr
->values
[0].string
.text
[1],
963 toupper(attr
->values
[0].string
.text
[3] & 255),
964 toupper(attr
->values
[0].string
.text
[4] & 255));
968 if ((attr
= ippFindAttribute(job
->attrs
, "document-format",
969 IPP_TAG_MIMETYPE
)) != NULL
&&
970 (ptr
= strstr(attr
->values
[0].string
.text
, "charset=")) != NULL
)
971 snprintf(charset
, sizeof(charset
), "CHARSET=%s", ptr
+ 8);
973 strlcpy(charset
, "CHARSET=utf-8", sizeof(charset
));
975 snprintf(content_type
, sizeof(content_type
), "CONTENT_TYPE=%s/%s",
976 job
->filetypes
[job
->current_file
]->super
,
977 job
->filetypes
[job
->current_file
]->type
);
978 snprintf(device_uri
, sizeof(device_uri
), "DEVICE_URI=%s",
979 job
->printer
->device_uri
);
980 snprintf(ppd
, sizeof(ppd
), "PPD=%s/ppd/%s.ppd", ServerRoot
,
982 snprintf(printer_info
, sizeof(printer_name
), "PRINTER_INFO=%s",
983 job
->printer
->info
? job
->printer
->info
: "");
984 snprintf(printer_location
, sizeof(printer_name
), "PRINTER_LOCATION=%s",
985 job
->printer
->location
? job
->printer
->location
: "");
986 snprintf(printer_name
, sizeof(printer_name
), "PRINTER=%s", job
->printer
->name
);
987 if (job
->printer
->num_reasons
> 0)
989 char *psrptr
; /* Pointer into PRINTER_STATE_REASONS */
990 size_t psrlen
; /* Size of PRINTER_STATE_REASONS */
992 for (psrlen
= 22, i
= 0; i
< job
->printer
->num_reasons
; i
++)
993 psrlen
+= strlen(job
->printer
->reasons
[i
]) + 1;
995 if ((printer_state_reasons
= malloc(psrlen
)) != NULL
)
998 * All of these strcpy's are safe because we allocated the psr string...
1001 strlcpy(printer_state_reasons
, "PRINTER_STATE_REASONS=", psrlen
);
1002 for (psrptr
= printer_state_reasons
+ 22, i
= 0;
1003 i
< job
->printer
->num_reasons
;
1008 strlcpy(psrptr
, job
->printer
->reasons
[i
], psrlen
- (size_t)(psrptr
- printer_state_reasons
));
1009 psrptr
+= strlen(psrptr
);
1013 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
1015 if (job
->printer
->num_auth_info_required
== 1)
1016 snprintf(auth_info_required
, sizeof(auth_info_required
),
1017 "AUTH_INFO_REQUIRED=%s",
1018 job
->printer
->auth_info_required
[0]);
1019 else if (job
->printer
->num_auth_info_required
== 2)
1020 snprintf(auth_info_required
, sizeof(auth_info_required
),
1021 "AUTH_INFO_REQUIRED=%s,%s",
1022 job
->printer
->auth_info_required
[0],
1023 job
->printer
->auth_info_required
[1]);
1024 else if (job
->printer
->num_auth_info_required
== 3)
1025 snprintf(auth_info_required
, sizeof(auth_info_required
),
1026 "AUTH_INFO_REQUIRED=%s,%s,%s",
1027 job
->printer
->auth_info_required
[0],
1028 job
->printer
->auth_info_required
[1],
1029 job
->printer
->auth_info_required
[2]);
1030 else if (job
->printer
->num_auth_info_required
== 4)
1031 snprintf(auth_info_required
, sizeof(auth_info_required
),
1032 "AUTH_INFO_REQUIRED=%s,%s,%s,%s",
1033 job
->printer
->auth_info_required
[0],
1034 job
->printer
->auth_info_required
[1],
1035 job
->printer
->auth_info_required
[2],
1036 job
->printer
->auth_info_required
[3]);
1038 strlcpy(auth_info_required
, "AUTH_INFO_REQUIRED=none",
1039 sizeof(auth_info_required
));
1041 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
1043 envp
[envc
++] = charset
;
1044 envp
[envc
++] = lang
;
1046 envp
[envc
++] = apple_language
;
1047 #endif /* __APPLE__ */
1048 envp
[envc
++] = ppd
;
1049 envp
[envc
++] = rip_max_cache
;
1050 envp
[envc
++] = content_type
;
1051 envp
[envc
++] = device_uri
;
1052 envp
[envc
++] = printer_info
;
1053 envp
[envc
++] = printer_location
;
1054 envp
[envc
++] = printer_name
;
1055 envp
[envc
++] = printer_state_reasons
? printer_state_reasons
:
1056 "PRINTER_STATE_REASONS=none";
1057 envp
[envc
++] = banner_page
? "CUPS_FILETYPE=job-sheet" :
1058 "CUPS_FILETYPE=document";
1060 if (final_content_type
[0])
1061 envp
[envc
++] = final_content_type
;
1063 if (Classification
&& !banner_page
)
1065 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
1066 IPP_TAG_NAME
)) == NULL
)
1067 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1069 else if (attr
->num_values
> 1 &&
1070 strcmp(attr
->values
[1].string
.text
, "none") != 0)
1071 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1072 attr
->values
[1].string
.text
);
1074 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1075 attr
->values
[0].string
.text
);
1077 envp
[envc
++] = classification
;
1080 if (job
->dtype
& CUPS_PRINTER_CLASS
)
1082 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
1083 envp
[envc
++] = class_name
;
1086 envp
[envc
++] = auth_info_required
;
1089 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1091 if (job
->auth_env
[i
])
1092 envp
[envc
++] = job
->auth_env
[i
];
1097 envp
[envc
++] = job
->auth_uid
;
1101 for (i
= 0; i
< envc
; i
++)
1102 if (!strncmp(envp
[i
], "AUTH_", 5))
1103 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"AUTH_%c****\"", i
,
1105 else if (strncmp(envp
[i
], "DEVICE_URI=", 11))
1106 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"%s\"", i
, envp
[i
]);
1108 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"DEVICE_URI=%s\"", i
,
1109 job
->printer
->sanitized_device_uri
);
1111 if (job
->printer
->remote
)
1112 job
->current_file
= job
->num_files
;
1114 job
->current_file
++;
1117 * Now create processes for all of the filters...
1120 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
1122 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
1124 if (filter
->filter
[0] != '/')
1125 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
1128 strlcpy(command
, filter
->filter
, sizeof(command
));
1130 if (i
< (cupsArrayCount(filters
) - 1))
1132 if (cupsdOpenPipe(filterfds
[slot
]))
1134 abort_message
= "Stopping job because the scheduler could not create "
1135 "the filter pipes.";
1142 if (job
->current_file
== 1 ||
1143 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1145 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1147 if (cupsdOpenPipe(job
->print_pipes
))
1149 abort_message
= "Stopping job because the scheduler could not "
1150 "create the backend pipes.";
1157 job
->print_pipes
[0] = -1;
1158 if (!strcmp(job
->printer
->device_uri
, "file:/dev/null") ||
1159 !strcmp(job
->printer
->device_uri
, "file:///dev/null"))
1160 job
->print_pipes
[1] = -1;
1163 if (!strncmp(job
->printer
->device_uri
, "file:/dev/", 10))
1164 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1166 else if (!strncmp(job
->printer
->device_uri
, "file:///dev/", 12))
1167 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1169 else if (!strncmp(job
->printer
->device_uri
, "file:///", 8))
1170 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1171 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1173 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1174 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1176 if (job
->print_pipes
[1] < 0)
1178 abort_message
= "Stopping job because the scheduler could not "
1179 "open the output file.";
1184 fcntl(job
->print_pipes
[1], F_SETFD
,
1185 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
1190 filterfds
[slot
][0] = job
->print_pipes
[0];
1191 filterfds
[slot
][1] = job
->print_pipes
[1];
1194 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1195 filterfds
[slot
][1], job
->status_pipes
[1],
1196 job
->back_pipes
[0], job
->side_pipes
[0], 0,
1197 job
->profile
, job
, job
->filters
+ i
);
1199 cupsdClosePipe(filterfds
[!slot
]);
1203 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
1204 filter
->filter
, strerror(errno
));
1206 abort_message
= "Stopping job because the scheduler could not execute a "
1212 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started filter %s (PID %d)", command
,
1224 cupsArrayDelete(filters
);
1228 * Finally, pipe the final output into a backend process if needed...
1231 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1233 if (job
->current_file
== 1 || job
->printer
->remote
||
1234 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1236 sscanf(job
->printer
->device_uri
, "%254[^:]", scheme
);
1237 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, scheme
);
1240 * See if the backend needs to run as root...
1245 else if (stat(command
, &backinfo
))
1248 backroot
= !(backinfo
.st_mode
& (S_IWGRP
| S_IRWXO
));
1250 argv
[0] = job
->printer
->sanitized_device_uri
;
1252 filterfds
[slot
][0] = -1;
1253 filterfds
[slot
][1] = -1;
1255 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1256 filterfds
[slot
][1], job
->status_pipes
[1],
1257 job
->back_pipes
[1], job
->side_pipes
[1],
1258 backroot
, job
->bprofile
, job
, &(job
->backend
));
1262 abort_message
= "Stopping job because the sheduler could not execute "
1269 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started backend %s (PID %d)",
1274 if (job
->current_file
== job
->num_files
||
1275 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1276 cupsdClosePipe(job
->print_pipes
);
1278 if (job
->current_file
== job
->num_files
)
1280 cupsdClosePipe(job
->back_pipes
);
1281 cupsdClosePipe(job
->side_pipes
);
1283 close(job
->status_pipes
[1]);
1284 job
->status_pipes
[1] = -1;
1289 filterfds
[slot
][0] = -1;
1290 filterfds
[slot
][1] = -1;
1292 if (job
->current_file
== job
->num_files
||
1293 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1294 cupsdClosePipe(job
->print_pipes
);
1296 if (job
->current_file
== job
->num_files
)
1298 close(job
->status_pipes
[1]);
1299 job
->status_pipes
[1] = -1;
1303 cupsdClosePipe(filterfds
[slot
]);
1305 for (i
= 6; i
< argc
; i
++)
1309 if (printer_state_reasons
)
1310 free(printer_state_reasons
);
1312 cupsdAddSelect(job
->status_buffer
->fd
, (cupsd_selfunc_t
)update_job
, NULL
,
1315 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
1322 * If we get here, we need to abort the current job and close out all
1323 * files and pipes...
1328 FilterLevel
-= job
->cost
;
1331 for (slot
= 0; slot
< 2; slot
++)
1332 cupsdClosePipe(filterfds
[slot
]);
1334 cupsArrayDelete(filters
);
1338 for (i
= 6; i
< argc
; i
++)
1344 if (printer_state_reasons
)
1345 free(printer_state_reasons
);
1347 cupsdClosePipe(job
->print_pipes
);
1348 cupsdClosePipe(job
->back_pipes
);
1349 cupsdClosePipe(job
->side_pipes
);
1351 cupsdRemoveSelect(job
->status_pipes
[0]);
1352 cupsdClosePipe(job
->status_pipes
);
1353 cupsdStatBufDelete(job
->status_buffer
);
1354 job
->status_buffer
= NULL
;
1357 * Update the printer and job state.
1360 cupsdSetJobState(job
, abort_state
, CUPSD_JOB_DEFAULT
, "%s", abort_message
);
1361 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_IDLE
, 0);
1362 update_job_attrs(job
, 0);
1365 free_job_history(job
);
1367 cupsArrayRemove(PrintingJobs
, job
);
1370 * Clear the printer <-> job association...
1373 job
->printer
->job
= NULL
;
1374 job
->printer
= NULL
;
1379 * 'cupsdDeleteJob()' - Free all memory used by a job.
1383 cupsdDeleteJob(cupsd_job_t
*job
, /* I - Job */
1384 cupsd_jobaction_t action
)/* I - Action */
1386 int i
; /* Looping var */
1390 finalize_job(job
, 1);
1392 if (action
== CUPSD_JOB_PURGE
)
1393 remove_job_history(job
);
1395 cupsdClearString(&job
->username
);
1396 cupsdClearString(&job
->dest
);
1398 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1400 cupsdClearString(job
->auth_env
+ i
);
1401 cupsdClearString(&job
->auth_uid
);
1403 if (action
== CUPSD_JOB_PURGE
)
1404 remove_job_files(job
);
1405 else if (job
->num_files
> 0)
1407 free(job
->compressions
);
1408 free(job
->filetypes
);
1414 free_job_history(job
);
1418 cupsArrayRemove(Jobs
, job
);
1419 cupsArrayRemove(ActiveJobs
, job
);
1420 cupsArrayRemove(PrintingJobs
, job
);
1427 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1431 cupsdFreeAllJobs(void)
1433 cupsd_job_t
*job
; /* Current job */
1441 cupsdStopAllJobs(CUPSD_JOB_FORCE
, 0);
1444 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1446 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1447 cupsdDeleteJob(job
, CUPSD_JOB_DEFAULT
);
1449 cupsdReleaseSignals();
1454 * 'cupsdFindJob()' - Find the specified job.
1457 cupsd_job_t
* /* O - Job data */
1458 cupsdFindJob(int id
) /* I - Job ID */
1460 cupsd_job_t key
; /* Search key */
1465 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
1470 * 'cupsdGetCompletedJobs()'- Generate a completed jobs list.
1473 cups_array_t
* /* O - Array of jobs */
1474 cupsdGetCompletedJobs(
1475 cupsd_printer_t
*p
) /* I - Printer */
1477 cups_array_t
*list
; /* Array of jobs */
1478 cupsd_job_t
*job
; /* Current job */
1481 list
= cupsArrayNew(compare_completed_jobs
, NULL
);
1483 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1485 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1486 if ((!p
|| !_cups_strcasecmp(p
->name
, job
->dest
)) && job
->state_value
>= IPP_JOB_STOPPED
&& job
->completed_time
)
1487 cupsArrayAdd(list
, job
);
1494 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1495 * or held jobs in a printer or class.
1498 int /* O - Job count */
1499 cupsdGetPrinterJobCount(
1500 const char *dest
) /* I - Printer or class name */
1502 int count
; /* Job count */
1503 cupsd_job_t
*job
; /* Current job */
1506 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1508 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1509 if (job
->dest
&& !_cups_strcasecmp(job
->dest
, dest
))
1517 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1518 * or held jobs for a user.
1521 int /* O - Job count */
1522 cupsdGetUserJobCount(
1523 const char *username
) /* I - Username */
1525 int count
; /* Job count */
1526 cupsd_job_t
*job
; /* Current job */
1529 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1531 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1532 if (!_cups_strcasecmp(job
->username
, username
))
1540 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1544 cupsdLoadAllJobs(void)
1546 char filename
[1024]; /* Full filename of job.cache file */
1547 struct stat fileinfo
; /* Information on job.cache file */
1548 cups_dir_t
*dir
; /* RequestRoot dir */
1549 cups_dentry_t
*dent
; /* Entry in RequestRoot */
1550 int load_cache
= 1; /* Load the job.cache file? */
1554 * Create the job arrays as needed...
1558 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1561 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1564 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1567 * See whether the job.cache file is older than the RequestRoot directory...
1570 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1572 if (stat(filename
, &fileinfo
))
1575 * No job.cache file...
1580 if (errno
!= ENOENT
)
1581 cupsdLogMessage(CUPSD_LOG_ERROR
,
1582 "Unable to get file information for \"%s\" - %s",
1583 filename
, strerror(errno
));
1585 else if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
1588 * No spool directory...
1595 while ((dent
= cupsDirRead(dir
)) != NULL
)
1597 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c' && dent
->fileinfo
.st_mtime
> fileinfo
.st_mtime
)
1600 * Job history file is newer than job.cache file...
1612 * Load the most recent source for job data...
1618 * Load the job.cache file...
1621 load_job_cache(filename
);
1626 * Load the job history files...
1629 load_request_root();
1631 load_next_job_id(filename
);
1635 * Clean out old jobs as needed...
1638 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1644 * 'cupsdLoadJob()' - Load a single job.
1647 int /* O - 1 on success, 0 on failure */
1648 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1650 int i
; /* Looping var */
1651 char jobfile
[1024]; /* Job filename */
1652 cups_file_t
*fp
; /* Job file */
1653 int fileid
; /* Current file ID */
1654 ipp_attribute_t
*attr
; /* Job attribute */
1655 const char *dest
; /* Destination name */
1656 cupsd_printer_t
*destptr
; /* Pointer to destination */
1657 mime_type_t
**filetypes
; /* New filetypes array */
1658 int *compressions
; /* New compressions array */
1663 if (job
->state_value
> IPP_JOB_STOPPED
)
1664 job
->access_time
= time(NULL
);
1669 if ((job
->attrs
= ippNew()) == NULL
)
1671 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes.");
1676 * Load job attributes...
1679 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading attributes...");
1681 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1682 if ((fp
= cupsdOpenConfFile(jobfile
)) == NULL
)
1685 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1687 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1688 "Unable to read job control file \"%s\".", jobfile
);
1696 * Copy attribute data to the job object...
1699 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1701 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1702 "Missing or bad time-at-creation attribute in control file.");
1706 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1707 IPP_TAG_ENUM
)) == NULL
)
1709 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1710 "Missing or bad job-state attribute in control file.");
1714 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1716 job
->history_time
= 0;
1718 if ((attr
= ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
)) != NULL
)
1719 job
->creation_time
= attr
->values
[0].integer
;
1721 if (job
->state_value
>= IPP_JOB_CANCELED
&& (attr
= ippFindAttribute(job
->attrs
, "time-at-completed", IPP_TAG_INTEGER
)) != NULL
)
1723 job
->completed_time
= attr
->values
[0].integer
;
1725 if (JobHistory
< INT_MAX
)
1726 job
->history_time
= job
->completed_time
+ JobHistory
;
1728 job
->history_time
= INT_MAX
;
1730 if (job
->history_time
< time(NULL
))
1731 goto error
; /* Expired, remove from history */
1733 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1734 JobHistoryUpdate
= job
->history_time
;
1736 if (JobFiles
< INT_MAX
)
1737 job
->file_time
= job
->completed_time
+ JobFiles
;
1739 job
->file_time
= INT_MAX
;
1741 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "cupsdLoadJob: job->file_time=%ld, time-at-completed=%ld, JobFiles=%d", (long)job
->file_time
, (long)attr
->values
[0].integer
, JobFiles
);
1743 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1744 JobHistoryUpdate
= job
->file_time
;
1746 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdLoadJob: JobHistoryUpdate=%ld",
1747 (long)JobHistoryUpdate
);
1752 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1753 IPP_TAG_URI
)) == NULL
)
1755 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1756 "No job-printer-uri attribute in control file.");
1760 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1763 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1764 "Unable to queue job for destination \"%s\".",
1765 attr
->values
[0].string
.text
);
1769 cupsdSetString(&job
->dest
, dest
);
1771 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1773 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1774 "Unable to queue job for destination \"%s\".",
1779 if ((job
->reasons
= ippFindAttribute(job
->attrs
, "job-state-reasons",
1780 IPP_TAG_KEYWORD
)) == NULL
)
1782 const char *reason
; /* job-state-reason keyword */
1784 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1785 "Adding missing job-state-reasons attribute to control file.");
1787 switch (job
->state_value
)
1790 case IPP_JOB_PENDING
:
1791 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1792 reason
= "printer-stopped";
1798 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1799 IPP_TAG_ZERO
)) != NULL
&&
1800 (attr
->value_tag
== IPP_TAG_NAME
||
1801 attr
->value_tag
== IPP_TAG_NAMELANG
||
1802 attr
->value_tag
== IPP_TAG_KEYWORD
) &&
1803 strcmp(attr
->values
[0].string
.text
, "no-hold"))
1804 reason
= "job-hold-until-specified";
1806 reason
= "job-incoming";
1809 case IPP_JOB_PROCESSING
:
1810 reason
= "job-printing";
1813 case IPP_JOB_STOPPED
:
1814 reason
= "job-stopped";
1817 case IPP_JOB_CANCELED
:
1818 reason
= "job-canceled-by-user";
1821 case IPP_JOB_ABORTED
:
1822 reason
= "aborted-by-system";
1825 case IPP_JOB_COMPLETED
:
1826 reason
= "job-completed-successfully";
1830 job
->reasons
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
1831 "job-state-reasons", NULL
, reason
);
1833 else if (job
->state_value
== IPP_JOB_PENDING
)
1835 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1836 ippSetString(job
->attrs
, &job
->reasons
, 0, "printer-stopped");
1838 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
1841 job
->impressions
= ippFindAttribute(job
->attrs
, "job-impressions-completed", IPP_TAG_INTEGER
);
1842 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed", IPP_TAG_INTEGER
);
1843 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1845 if (!job
->impressions
)
1846 job
->impressions
= ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-impressions-completed", 0);
1848 job
->sheets
= ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-media-sheets-completed", 0);
1852 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1853 IPP_TAG_INTEGER
)) == NULL
)
1855 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1856 "Missing or bad job-priority attribute in control file.");
1860 job
->priority
= attr
->values
[0].integer
;
1865 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1866 IPP_TAG_NAME
)) == NULL
)
1868 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1869 "Missing or bad job-originating-user-name "
1870 "attribute in control file.");
1874 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1879 if ((attr
= ippFindAttribute(job
->attrs
, "job-name", IPP_TAG_NAME
)) != NULL
)
1880 cupsdSetString(&job
->name
, attr
->values
[0].string
.text
);
1884 * Set the job hold-until time and state...
1887 if (job
->state_value
== IPP_JOB_HELD
)
1889 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1890 IPP_TAG_KEYWORD
)) == NULL
)
1891 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1894 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1897 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1898 job
->state_value
= IPP_JOB_PENDING
;
1901 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1903 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1904 job
->state_value
= IPP_JOB_PENDING
;
1907 if ((attr
= ippFindAttribute(job
->attrs
, "job-k-octets", IPP_TAG_INTEGER
)) != NULL
)
1908 job
->koctets
= attr
->values
[0].integer
;
1910 if (!job
->num_files
)
1913 * Find all the d##### files...
1916 for (fileid
= 1; fileid
< 10000; fileid
++)
1918 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1921 if (access(jobfile
, 0))
1924 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1925 "Auto-typing document file \"%s\"...", jobfile
);
1927 if (fileid
> job
->num_files
)
1929 if (job
->num_files
== 0)
1931 compressions
= (int *)calloc((size_t)fileid
, sizeof(int));
1932 filetypes
= (mime_type_t
**)calloc((size_t)fileid
, sizeof(mime_type_t
*));
1936 compressions
= (int *)realloc(job
->compressions
, sizeof(int) * (size_t)fileid
);
1937 filetypes
= (mime_type_t
**)realloc(job
->filetypes
, sizeof(mime_type_t
*) * (size_t)fileid
);
1941 job
->compressions
= compressions
;
1944 job
->filetypes
= filetypes
;
1946 if (!compressions
|| !filetypes
)
1948 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1949 "Ran out of memory for job file types.");
1951 ippDelete(job
->attrs
);
1954 if (job
->compressions
)
1956 free(job
->compressions
);
1957 job
->compressions
= NULL
;
1962 free(job
->filetypes
);
1963 job
->filetypes
= NULL
;
1970 job
->num_files
= fileid
;
1973 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1974 job
->compressions
+ fileid
- 1);
1976 if (!job
->filetypes
[fileid
- 1])
1977 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1983 * Load authentication information as needed...
1986 if (job
->state_value
< IPP_JOB_STOPPED
)
1988 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1991 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1993 cupsdClearString(job
->auth_env
+ i
);
1994 cupsdClearString(&job
->auth_uid
);
1996 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
1998 int bytes
, /* Size of auth data */
1999 linenum
= 1; /* Current line number */
2000 char line
[65536], /* Line from file */
2001 *value
, /* Value from line */
2002 data
[65536]; /* Decoded data */
2005 if (cupsFileGets(fp
, line
, sizeof(line
)) &&
2006 !strcmp(line
, "CUPSD-AUTH-V3"))
2009 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
2015 if (strcmp(line
, "negotiate") && strcmp(line
, "uid"))
2017 bytes
= sizeof(data
);
2018 httpDecode64_2(data
, &bytes
, value
);
2022 * Assign environment variables...
2025 if (!strcmp(line
, "uid"))
2027 cupsdSetStringf(&job
->auth_uid
, "AUTH_UID=%s", value
);
2030 else if (i
>= (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0])))
2033 if (!strcmp(line
, "username"))
2034 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_USERNAME=%s", data
);
2035 else if (!strcmp(line
, "domain"))
2036 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_DOMAIN=%s", data
);
2037 else if (!strcmp(line
, "password"))
2038 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_PASSWORD=%s", data
);
2039 else if (!strcmp(line
, "negotiate"))
2040 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_NEGOTIATE=%s", value
);
2052 job
->access_time
= time(NULL
);
2056 * If we get here then something bad happened...
2061 ippDelete(job
->attrs
);
2064 remove_job_history(job
);
2065 remove_job_files(job
);
2072 * 'cupsdMoveJob()' - Move the specified job to a different destination.
2076 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
2077 cupsd_printer_t
*p
) /* I - Destination printer or class */
2079 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
2080 const char *olddest
; /* Old destination */
2081 cupsd_printer_t
*oldp
; /* Old pointer */
2085 * Don't move completed jobs...
2088 if (job
->state_value
> IPP_JOB_STOPPED
)
2092 * Get the old destination...
2095 olddest
= job
->dest
;
2098 oldp
= job
->printer
;
2100 oldp
= cupsdFindDest(olddest
);
2103 * Change the destination information...
2106 if (job
->state_value
> IPP_JOB_HELD
)
2107 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2108 "Stopping job prior to move.");
2110 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
2111 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2114 cupsdSetString(&job
->dest
, p
->name
);
2115 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
);
2117 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
2118 IPP_TAG_URI
)) != NULL
)
2119 ippSetString(job
->attrs
, &attr
, 0, p
->uri
);
2121 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
2122 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2126 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2131 * 'cupsdReleaseJob()' - Release the specified job.
2135 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
2137 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
2140 if (job
->state_value
== IPP_JOB_HELD
)
2143 * Add trailing banner as needed...
2146 if (job
->pending_timeout
)
2147 cupsdTimeoutJob(job
);
2149 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2150 "Job released by user.");
2156 * 'cupsdRestartJob()' - Restart the specified job.
2160 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
2162 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
2165 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
2166 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2167 "Job restarted by user.");
2172 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2176 cupsdSaveAllJobs(void)
2178 int i
; /* Looping var */
2179 cups_file_t
*fp
; /* job.cache file */
2180 char filename
[1024], /* job.cache filename */
2181 temp
[1024]; /* Temporary string */
2182 cupsd_job_t
*job
; /* Current job */
2183 time_t curtime
; /* Current time */
2184 struct tm
*curdate
; /* Current date */
2187 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
2188 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
)) == NULL
)
2191 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job.cache...");
2194 * Write a small header to the file...
2197 curtime
= time(NULL
);
2198 curdate
= localtime(&curtime
);
2199 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
2201 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
2202 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
2203 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
2206 * Write each job known to the system...
2209 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2211 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2213 if (job
->printer
&& job
->printer
->temporary
)
2216 * Don't save jobs on temporary printers...
2222 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
2223 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
2224 cupsFilePrintf(fp
, "Created %ld\n", (long)job
->creation_time
);
2225 if (job
->completed_time
)
2226 cupsFilePrintf(fp
, "Completed %ld\n", (long)job
->completed_time
);
2227 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
2228 if (job
->hold_until
)
2229 cupsFilePrintf(fp
, "HoldUntil %ld\n", (long)job
->hold_until
);
2230 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
2232 cupsFilePutConf(fp
, "Name", job
->name
);
2233 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
2234 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
2235 cupsFilePrintf(fp
, "KOctets %d\n", job
->koctets
);
2236 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
2237 for (i
= 0; i
< job
->num_files
; i
++)
2238 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
2239 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
2240 cupsFilePuts(fp
, "</Job>\n");
2243 cupsdCloseCreatedConfFile(fp
, filename
);
2248 * 'cupsdSaveJob()' - Save a job to disk.
2252 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
2254 char filename
[1024]; /* Job control filename */
2255 cups_file_t
*fp
; /* Job file */
2258 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2259 job
, job
->id
, job
->attrs
);
2261 if (job
->printer
&& job
->printer
->temporary
)
2264 * Don't save jobs on temporary printers...
2271 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
2273 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
& 0600)) == NULL
)
2276 fchown(cupsFileNumber(fp
), RunUser
, Group
);
2278 job
->attrs
->state
= IPP_IDLE
;
2280 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
2281 job
->attrs
) != IPP_DATA
)
2283 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to write job control file.");
2288 if (!cupsdCloseCreatedConfFile(fp
, filename
))
2291 * Remove backup file and mark this job as clean...
2294 strlcat(filename
, ".O", sizeof(filename
));
2303 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2307 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
2308 const char *when
, /* I - When to resume */
2309 int update
)/* I - Update job-hold-until attr? */
2311 time_t curtime
; /* Current time */
2312 struct tm
*curdate
; /* Current date */
2313 int hour
; /* Hold hour */
2314 int minute
; /* Hold minute */
2315 int second
= 0; /* Hold second */
2318 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2319 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2320 job
, job
->id
, when
, update
);
2325 * Update the job-hold-until attribute...
2328 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2330 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2331 IPP_TAG_KEYWORD
)) == NULL
)
2332 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2335 ippSetString(job
->attrs
, &attr
, 0, when
);
2337 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2338 "job-hold-until", NULL
, when
);
2342 if (isdigit(when
[0] & 255))
2343 attr
->value_tag
= IPP_TAG_NAME
;
2345 attr
->value_tag
= IPP_TAG_KEYWORD
;
2348 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2353 if (strcmp(when
, "no-hold"))
2354 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-hold-until-specified");
2356 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
2359 * Update the hold time...
2362 job
->cancel_time
= 0;
2364 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2367 * Hold indefinitely...
2370 job
->hold_until
= 0;
2372 if (MaxHoldTime
> 0)
2373 job
->cancel_time
= time(NULL
) + MaxHoldTime
;
2375 else if (!strcmp(when
, "day-time"))
2378 * Hold to 6am the next morning unless local time is < 6pm.
2381 curtime
= time(NULL
);
2382 curdate
= localtime(&curtime
);
2384 if (curdate
->tm_hour
< 18)
2385 job
->hold_until
= curtime
;
2387 job
->hold_until
= curtime
+
2388 ((29 - curdate
->tm_hour
) * 60 + 59 -
2389 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2391 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2394 * Hold to 6pm unless local time is > 6pm or < 6am.
2397 curtime
= time(NULL
);
2398 curdate
= localtime(&curtime
);
2400 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2401 job
->hold_until
= curtime
;
2403 job
->hold_until
= curtime
+
2404 ((17 - curdate
->tm_hour
) * 60 + 59 -
2405 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2407 else if (!strcmp(when
, "second-shift"))
2410 * Hold to 4pm unless local time is > 4pm.
2413 curtime
= time(NULL
);
2414 curdate
= localtime(&curtime
);
2416 if (curdate
->tm_hour
>= 16)
2417 job
->hold_until
= curtime
;
2419 job
->hold_until
= curtime
+
2420 ((15 - curdate
->tm_hour
) * 60 + 59 -
2421 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2423 else if (!strcmp(when
, "third-shift"))
2426 * Hold to 12am unless local time is < 8am.
2429 curtime
= time(NULL
);
2430 curdate
= localtime(&curtime
);
2432 if (curdate
->tm_hour
< 8)
2433 job
->hold_until
= curtime
;
2435 job
->hold_until
= curtime
+
2436 ((23 - curdate
->tm_hour
) * 60 + 59 -
2437 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2439 else if (!strcmp(when
, "weekend"))
2442 * Hold to weekend unless we are in the weekend.
2445 curtime
= time(NULL
);
2446 curdate
= localtime(&curtime
);
2448 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2449 job
->hold_until
= curtime
;
2451 job
->hold_until
= curtime
+
2452 (((5 - curdate
->tm_wday
) * 24 +
2453 (17 - curdate
->tm_hour
)) * 60 + 59 -
2454 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2456 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2459 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2462 curtime
= time(NULL
);
2463 curdate
= gmtime(&curtime
);
2465 job
->hold_until
= curtime
+
2466 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2467 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2470 * Hold until next day as needed...
2473 if (job
->hold_until
< curtime
)
2474 job
->hold_until
+= 24 * 60 * 60;
2477 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2478 (int)job
->hold_until
);
2483 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2484 * the list as needed.
2488 cupsdSetJobPriority(
2489 cupsd_job_t
*job
, /* I - Job ID */
2490 int priority
) /* I - New priority (0 to 100) */
2492 ipp_attribute_t
*attr
; /* Job attribute */
2496 * Don't change completed jobs...
2499 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2503 * Set the new priority and re-add the job into the active list...
2506 cupsArrayRemove(ActiveJobs
, job
);
2508 job
->priority
= priority
;
2510 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2511 IPP_TAG_INTEGER
)) != NULL
)
2512 attr
->values
[0].integer
= priority
;
2514 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2517 cupsArrayAdd(ActiveJobs
, job
);
2520 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2525 * 'cupsdSetJobState()' - Set the state of the specified print job.
2530 cupsd_job_t
*job
, /* I - Job to cancel */
2531 ipp_jstate_t newstate
, /* I - New job state */
2532 cupsd_jobaction_t action
, /* I - Action to take */
2533 const char *message
, /* I - Message to log */
2534 ...) /* I - Additional arguments as needed */
2536 int i
; /* Looping var */
2537 ipp_jstate_t oldstate
; /* Old state */
2538 char filename
[1024]; /* Job filename */
2539 ipp_attribute_t
*attr
; /* Job attribute */
2542 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2543 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2544 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2545 newstate
, action
, message
? message
: "(null)");
2549 * Make sure we have the job attributes...
2552 if (!cupsdLoadJob(job
))
2556 * Don't do anything if the state is unchanged and we aren't purging the
2560 oldstate
= job
->state_value
;
2561 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2565 * Stop any processes that are working on the current job...
2568 if (oldstate
== IPP_JOB_PROCESSING
)
2569 stop_job(job
, action
);
2572 * Set the new job state...
2575 job
->state_value
= newstate
;
2578 job
->state
->values
[0].integer
= newstate
;
2582 case IPP_JOB_PENDING
:
2584 * Update job-hold-until as needed...
2587 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2588 IPP_TAG_KEYWORD
)) == NULL
)
2589 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2593 ippSetValueTag(job
->attrs
, &attr
, IPP_TAG_KEYWORD
);
2594 ippSetString(job
->attrs
, &attr
, 0, "no-hold");
2600 case IPP_JOB_ABORTED
:
2601 case IPP_JOB_CANCELED
:
2602 case IPP_JOB_COMPLETED
:
2603 set_time(job
, "time-at-completed");
2604 ippSetString(job
->attrs
, &job
->reasons
, 0, "processing-to-stop-point");
2609 * Log message as needed...
2614 char buffer
[2048]; /* Message buffer */
2615 va_list ap
; /* Pointer to additional arguments */
2617 va_start(ap
, message
);
2618 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2621 if (newstate
> IPP_JOB_STOPPED
)
2622 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2624 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2626 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2627 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2629 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2633 * Handle post-state-change actions...
2638 case IPP_JOB_PROCESSING
:
2640 * Add the job to the "printing" list...
2643 if (!cupsArrayFind(PrintingJobs
, job
))
2644 cupsArrayAdd(PrintingJobs
, job
);
2647 * Set the processing time...
2650 set_time(job
, "time-at-processing");
2652 case IPP_JOB_PENDING
:
2654 case IPP_JOB_STOPPED
:
2656 * Make sure the job is in the active list...
2659 if (!cupsArrayFind(ActiveJobs
, job
))
2660 cupsArrayAdd(ActiveJobs
, job
);
2663 * Save the job state to disk...
2667 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2670 case IPP_JOB_ABORTED
:
2671 case IPP_JOB_CANCELED
:
2672 case IPP_JOB_COMPLETED
:
2673 if (newstate
== IPP_JOB_CANCELED
)
2676 * Remove the job from the active list if there are no processes still
2680 for (i
= 0; job
->filters
[i
] < 0; i
++);
2682 if (!job
->filters
[i
] && job
->backend
<= 0)
2683 cupsArrayRemove(ActiveJobs
, job
);
2688 * Otherwise just remove the job from the active list immediately...
2691 cupsArrayRemove(ActiveJobs
, job
);
2695 * Expire job subscriptions since the job is now "completed"...
2698 cupsdExpireSubscriptions(NULL
, job
);
2702 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2703 * sleep to happen immediately...
2706 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2708 #endif /* __APPLE__ */
2711 * Remove any authentication data...
2714 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2715 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2716 cupsdLogMessage(CUPSD_LOG_ERROR
,
2717 "Unable to remove authentication cache: %s",
2721 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
2723 cupsdClearString(job
->auth_env
+ i
);
2725 cupsdClearString(&job
->auth_uid
);
2728 * Remove the print file for good if we aren't preserving jobs or
2732 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2733 remove_job_files(job
);
2735 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2738 * Save job state info...
2742 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2744 else if (!job
->printer
)
2747 * Delete the job immediately if not actively printing...
2750 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2757 * Finalize the job immediately if we forced things...
2760 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2761 finalize_job(job
, 0);
2764 * Update the server "busy" state...
2767 cupsdSetBusyState(0);
2772 * 'cupsdStopAllJobs()' - Stop all print jobs.
2777 cupsd_jobaction_t action
, /* I - Action */
2778 int kill_delay
) /* I - Number of seconds before we kill */
2780 cupsd_job_t
*job
; /* Current job */
2783 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2785 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2789 cupsdSetJobState(job
, IPP_JOB_COMPLETED
, CUPSD_JOB_FORCE
, NULL
);
2794 job
->kill_time
= time(NULL
) + kill_delay
;
2796 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2803 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2807 cupsdUnloadCompletedJobs(void)
2809 cupsd_job_t
*job
; /* Current job */
2810 time_t expire
; /* Expiration time */
2813 expire
= time(NULL
) - 60;
2815 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2817 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2818 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2819 job
->access_time
< expire
)
2831 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2835 cupsdUpdateJobs(void)
2837 cupsd_job_t
*job
; /* Current job */
2838 time_t curtime
; /* Current time */
2839 ipp_attribute_t
*attr
; /* time-at-completed attribute */
2842 curtime
= time(NULL
);
2843 JobHistoryUpdate
= 0;
2845 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2847 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2849 if (job
->state_value
>= IPP_JOB_CANCELED
&&
2850 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
2851 IPP_TAG_INTEGER
)) != NULL
)
2854 * Update history/file expiration times...
2857 job
->completed_time
= attr
->values
[0].integer
;
2859 if (JobHistory
< INT_MAX
)
2860 job
->history_time
= job
->completed_time
+ JobHistory
;
2862 job
->history_time
= INT_MAX
;
2864 if (job
->history_time
< curtime
)
2866 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2870 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2871 JobHistoryUpdate
= job
->history_time
;
2873 if (JobFiles
< INT_MAX
)
2874 job
->file_time
= job
->completed_time
+ JobFiles
;
2876 job
->file_time
= INT_MAX
;
2878 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "cupsdUpdateJobs: job->file_time=%ld, time-at-completed=%ld, JobFiles=%d", (long)job
->file_time
, (long)attr
->values
[0].integer
, JobFiles
);
2880 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2881 JobHistoryUpdate
= job
->file_time
;
2885 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdUpdateJobs: JobHistoryUpdate=%ld",
2886 (long)JobHistoryUpdate
);
2891 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2894 static int /* O - Difference */
2895 compare_active_jobs(void *first
, /* I - First job */
2896 void *second
, /* I - Second job */
2897 void *data
) /* I - App data (not used) */
2899 int diff
; /* Difference */
2904 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2905 ((cupsd_job_t
*)first
)->priority
) != 0)
2908 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2913 * 'compare_completed_jobs()' - Compare the job IDs and completion times of two jobs.
2916 static int /* O - Difference */
2917 compare_completed_jobs(void *first
, /* I - First job */
2918 void *second
, /* I - Second job */
2919 void *data
) /* I - App data (not used) */
2921 int diff
; /* Difference */
2926 if ((diff
= ((cupsd_job_t
*)second
)->completed_time
-
2927 ((cupsd_job_t
*)first
)->completed_time
) != 0)
2930 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2935 * 'compare_jobs()' - Compare the job IDs of two jobs.
2938 static int /* O - Difference */
2939 compare_jobs(void *first
, /* I - First job */
2940 void *second
, /* I - Second job */
2941 void *data
) /* I - App data (not used) */
2945 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2950 * 'dump_job_history()' - Dump any debug messages for a job.
2954 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2956 int i
, /* Looping var */
2957 oldsize
; /* Current MaxLogSize */
2958 struct tm
*date
; /* Date/time value */
2959 cupsd_joblog_t
*message
; /* Current message */
2960 char temp
[2048], /* Log message */
2961 *ptr
, /* Pointer into log message */
2962 start
[256], /* Start time */
2963 end
[256]; /* End time */
2964 cupsd_printer_t
*printer
; /* Printer for job */
2968 * See if we have anything to dump...
2975 * Disable log rotation temporarily...
2978 oldsize
= MaxLogSize
;
2982 * Copy the debug messages to the log...
2985 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2986 date
= localtime(&(message
->time
));
2987 strftime(start
, sizeof(start
), "%X", date
);
2989 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2990 date
= localtime(&(message
->time
));
2991 strftime(end
, sizeof(end
), "%X", date
);
2993 snprintf(temp
, sizeof(temp
),
2994 "[Job %d] The following messages were recorded from %s to %s",
2995 job
->id
, start
, end
);
2996 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2998 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
3000 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
3001 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
3003 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
3004 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3007 * Log the printer state values...
3010 if ((printer
= job
->printer
) == NULL
)
3011 printer
= cupsdFindDest(job
->dest
);
3015 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
3017 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
3018 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
3020 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3022 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
3023 job
->id
, printer
->state_message
);
3024 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3026 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
3027 ptr
= temp
+ strlen(temp
);
3028 if (printer
->num_reasons
== 0)
3029 strlcpy(ptr
, "none", sizeof(temp
) - (size_t)(ptr
- temp
));
3033 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
3039 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (size_t)(ptr
- temp
));
3043 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3047 * Restore log file rotation...
3050 MaxLogSize
= oldsize
;
3053 * Free all messages...
3056 free_job_history(job
);
3061 * 'free_job_history()' - Free any log history.
3065 free_job_history(cupsd_job_t
*job
) /* I - Job */
3067 char *message
; /* Current message */
3073 for (message
= (char *)cupsArrayFirst(job
->history
);
3075 message
= (char *)cupsArrayNext(job
->history
))
3078 cupsArrayDelete(job
->history
);
3079 job
->history
= NULL
;
3084 * 'finalize_job()' - Cleanup after job filter processes and support data.
3088 finalize_job(cupsd_job_t
*job
, /* I - Job */
3089 int set_job_state
) /* I - 1 = set the job state */
3091 ipp_pstate_t printer_state
; /* New printer state value */
3092 ipp_jstate_t job_state
; /* New job state value */
3093 const char *message
; /* Message for job state */
3094 char buffer
[1024]; /* Buffer for formatted messages */
3097 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
3100 * Clear the "connecting-to-device" and "cups-waiting-for-job-completed"
3101 * reasons, which are only valid when a printer is processing, along with any
3102 * remote printing job state...
3105 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device,"
3106 "cups-waiting-for-job-completed,"
3107 "cups-remote-pending,"
3108 "cups-remote-pending-held,"
3109 "cups-remote-processing,"
3110 "cups-remote-stopped,"
3111 "cups-remote-canceled,"
3112 "cups-remote-aborted,"
3113 "cups-remote-completed");
3116 * Similarly, clear the "offline-report" reason for non-USB devices since we
3117 * rarely have current information for network devices...
3120 if (strncmp(job
->printer
->device_uri
, "usb:", 4) &&
3121 strncmp(job
->printer
->device_uri
, "ippusb:", 7))
3122 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
3125 * Free the security profile...
3128 cupsdDestroyProfile(job
->profile
);
3129 job
->profile
= NULL
;
3130 cupsdDestroyProfile(job
->bprofile
);
3131 job
->bprofile
= NULL
;
3134 * Clear the unresponsive job watchdog timers...
3137 job
->cancel_time
= 0;
3141 * Close pipes and status buffer...
3144 cupsdClosePipe(job
->print_pipes
);
3145 cupsdClosePipe(job
->back_pipes
);
3146 cupsdClosePipe(job
->side_pipes
);
3148 cupsdRemoveSelect(job
->status_pipes
[0]);
3149 cupsdClosePipe(job
->status_pipes
);
3150 cupsdStatBufDelete(job
->status_buffer
);
3151 job
->status_buffer
= NULL
;
3154 * Log the final impression (page) count...
3157 snprintf(buffer
, sizeof(buffer
), "total %d", ippGetInteger(job
->impressions
, 0));
3158 cupsdLogPage(job
, buffer
);
3161 * Process the exit status...
3164 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
3165 printer_state
= IPP_PRINTER_IDLE
;
3167 printer_state
= job
->printer
->state
;
3169 switch (job_state
= job
->state_value
)
3171 case IPP_JOB_PENDING
:
3172 message
= "Job paused.";
3176 message
= "Job held.";
3180 case IPP_JOB_PROCESSING
:
3181 case IPP_JOB_COMPLETED
:
3182 job_state
= IPP_JOB_COMPLETED
;
3183 message
= "Job completed.";
3186 ippSetString(job
->attrs
, &job
->reasons
, 0,
3187 "job-completed-successfully");
3190 case IPP_JOB_STOPPED
:
3191 message
= "Job stopped.";
3193 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-stopped");
3196 case IPP_JOB_CANCELED
:
3197 message
= "Job canceled.";
3199 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-canceled-by-user");
3202 case IPP_JOB_ABORTED
:
3203 message
= "Job aborted.";
3207 if (job
->status
< 0)
3210 * Backend had errors...
3213 int exit_code
; /* Exit code from backend */
3216 * Convert the status to an exit code. Due to the way the W* macros are
3217 * implemented on macOS (bug?), we have to store the exit status in a
3218 * variable first and then convert...
3221 exit_code
= -job
->status
;
3222 if (WIFEXITED(exit_code
))
3223 exit_code
= WEXITSTATUS(exit_code
);
3226 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-backend-crashed");
3227 exit_code
= job
->status
;
3230 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
3232 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
3233 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
3234 "authentication required" :
3235 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
3236 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
3237 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
3238 exit_code
== CUPS_BACKEND_RETRY
? "retry job later" :
3239 exit_code
== CUPS_BACKEND_RETRY_CURRENT
? "retry job immediately" :
3240 exit_code
< 0 ? "crashed" : "unknown");
3243 * Do what needs to be done...
3249 case CUPS_BACKEND_FAILED
:
3251 * Backend failure, use the error-policy to determine how to
3255 if (job
->dtype
& CUPS_PRINTER_CLASS
)
3258 * Queued on a class - mark the job as pending and we'll retry on
3259 * another printer...
3262 if (job_state
== IPP_JOB_COMPLETED
)
3264 job_state
= IPP_JOB_PENDING
;
3265 message
= "Retrying job on another printer.";
3267 ippSetString(job
->attrs
, &job
->reasons
, 0,
3268 "resources-are-not-ready");
3271 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
3274 * The error policy is "retry-current-job" - mark the job as pending
3275 * and we'll retry on the same printer...
3278 if (job_state
== IPP_JOB_COMPLETED
)
3280 job_state
= IPP_JOB_PENDING
;
3281 message
= "Retrying job on same printer.";
3283 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3286 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
3287 !strcmp(job
->printer
->error_policy
, "retry-job"))
3289 if (job_state
== IPP_JOB_COMPLETED
)
3292 * The job was queued on a fax or the error policy is "retry-job" -
3293 * hold the job if the number of retries is less than the
3294 * JobRetryLimit, otherwise abort the job.
3299 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3305 snprintf(buffer
, sizeof(buffer
),
3306 "Job aborted after %d unsuccessful attempts.",
3308 job_state
= IPP_JOB_ABORTED
;
3311 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3316 * Try again in N seconds...
3319 snprintf(buffer
, sizeof(buffer
),
3320 "Job held for %d seconds since it could not be sent.",
3323 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3324 job_state
= IPP_JOB_HELD
;
3327 ippSetString(job
->attrs
, &job
->reasons
, 0,
3328 "resources-are-not-ready");
3332 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
3333 job_state
== IPP_JOB_COMPLETED
)
3335 job_state
= IPP_JOB_ABORTED
;
3339 snprintf(buffer
, sizeof(buffer
), "Job aborted due to backend errors; please consult the %s file for details.", ErrorLog
);
3343 message
= "Job aborted due to backend errors.";
3345 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3347 else if (job
->state_value
== IPP_JOB_PROCESSING
)
3349 job_state
= IPP_JOB_PENDING
;
3350 printer_state
= IPP_PRINTER_STOPPED
;
3354 snprintf(buffer
, sizeof(buffer
), "Printer stopped due to backend errors; please consult the %s file for details.", ErrorLog
);
3358 message
= "Printer stopped due to backend errors.";
3360 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3364 case CUPS_BACKEND_CANCEL
:
3369 if (job_state
== IPP_JOB_COMPLETED
)
3371 job_state
= IPP_JOB_CANCELED
;
3372 message
= "Job canceled at printer.";
3374 ippSetString(job
->attrs
, &job
->reasons
, 0, "canceled-at-device");
3378 case CUPS_BACKEND_HOLD
:
3379 if (job_state
== IPP_JOB_COMPLETED
)
3385 const char *reason
= ippGetString(job
->reasons
, 0, NULL
);
3387 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-state-reasons=\"%s\"",
3390 if (!reason
|| strncmp(reason
, "account-", 8))
3392 cupsdSetJobHoldUntil(job
, "indefinite", 1);
3394 ippSetString(job
->attrs
, &job
->reasons
, 0,
3395 "job-hold-until-specified");
3399 snprintf(buffer
, sizeof(buffer
), "Job held indefinitely due to backend errors; please consult the %s file for details.", ErrorLog
);
3403 message
= "Job held indefinitely due to backend errors.";
3405 else if (!strcmp(reason
, "account-info-needed"))
3407 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3409 message
= "Job held indefinitely - account information is required.";
3411 else if (!strcmp(reason
, "account-closed"))
3413 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3415 message
= "Job held indefinitely - account has been closed.";
3417 else if (!strcmp(reason
, "account-limit-reached"))
3419 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3421 message
= "Job held indefinitely - account limit has been reached.";
3425 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3427 message
= "Job held indefinitely - account authorization failed.";
3430 job_state
= IPP_JOB_HELD
;
3434 case CUPS_BACKEND_STOP
:
3436 * Stop the printer...
3439 if (job_state
== IPP_JSTATE_CANCELED
|| job_state
== IPP_JSTATE_ABORTED
)
3441 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Ignored STOP from backend since the job is %s.", job_state
== IPP_JSTATE_CANCELED
? "canceled" : "aborted");
3445 printer_state
= IPP_PRINTER_STOPPED
;
3449 snprintf(buffer
, sizeof(buffer
), "Printer stopped due to backend errors; please consult the %s file for details.", ErrorLog
);
3453 message
= "Printer stopped due to backend errors.";
3455 if (job_state
== IPP_JOB_COMPLETED
)
3457 job_state
= IPP_JOB_PENDING
;
3459 ippSetString(job
->attrs
, &job
->reasons
, 0, "resources-are-not-ready");
3463 case CUPS_BACKEND_AUTH_REQUIRED
:
3465 * Hold the job for authentication...
3468 if (job_state
== IPP_JOB_COMPLETED
)
3470 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
3472 job_state
= IPP_JOB_HELD
;
3473 message
= "Job held for authentication.";
3475 if (strncmp(job
->reasons
->values
[0].string
.text
, "account-", 8))
3476 ippSetString(job
->attrs
, &job
->reasons
, 0,
3477 "cups-held-for-authentication");
3481 case CUPS_BACKEND_RETRY
:
3482 if (job_state
== IPP_JOB_COMPLETED
)
3485 * Hold the job if the number of retries is less than the
3486 * JobRetryLimit, otherwise abort the job.
3491 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3497 snprintf(buffer
, sizeof(buffer
),
3498 "Job aborted after %d unsuccessful attempts.",
3500 job_state
= IPP_JOB_ABORTED
;
3503 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3508 * Try again in N seconds...
3511 snprintf(buffer
, sizeof(buffer
),
3512 "Job held for %d seconds since it could not be sent.",
3515 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3516 job_state
= IPP_JOB_HELD
;
3519 ippSetString(job
->attrs
, &job
->reasons
, 0,
3520 "resources-are-not-ready");
3525 case CUPS_BACKEND_RETRY_CURRENT
:
3527 * Mark the job as pending and retry on the same printer...
3530 if (job_state
== IPP_JOB_COMPLETED
)
3532 job_state
= IPP_JOB_PENDING
;
3533 message
= "Retrying job on same printer.";
3535 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3540 else if (job
->status
> 0)
3543 * Filter had errors; stop job...
3546 if (job_state
== IPP_JOB_COMPLETED
)
3548 job_state
= IPP_JOB_STOPPED
;
3552 snprintf(buffer
, sizeof(buffer
), "Job stopped due to filter errors; please consult the %s file for details.", ErrorLog
);
3556 message
= "Job stopped due to filter errors.";
3558 if (WIFSIGNALED(job
->status
))
3559 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-filter-crashed");
3561 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-completed-with-errors");
3566 * Update the printer and job state.
3569 if (set_job_state
&& job_state
!= job
->state_value
)
3570 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
3572 cupsdSetPrinterState(job
->printer
, printer_state
,
3573 printer_state
== IPP_PRINTER_STOPPED
);
3574 update_job_attrs(job
, 0);
3579 (job
->state_value
== IPP_JOB_ABORTED
||
3580 job
->state_value
== IPP_JOB_STOPPED
))
3581 dump_job_history(job
);
3583 free_job_history(job
);
3586 cupsArrayRemove(PrintingJobs
, job
);
3589 * Clear informational messages...
3592 if (job
->status_level
> CUPSD_LOG_ERROR
)
3593 job
->printer
->state_message
[0] = '\0';
3596 * Apply any PPD updates...
3599 if (job
->num_keywords
)
3601 if (cupsdUpdatePrinterPPD(job
->printer
, job
->num_keywords
, job
->keywords
))
3602 cupsdSetPrinterAttrs(job
->printer
);
3604 cupsFreeOptions(job
->num_keywords
, job
->keywords
);
3606 job
->num_keywords
= 0;
3607 job
->keywords
= NULL
;
3611 * Clear the printer <-> job association...
3614 job
->printer
->job
= NULL
;
3615 job
->printer
= NULL
;
3620 * 'get_options()' - Get a string containing the job options.
3623 static char * /* O - Options string */
3624 get_options(cupsd_job_t
*job
, /* I - Job */
3625 int banner_page
, /* I - Printing a banner page? */
3626 char *copies
, /* I - Copies buffer */
3627 size_t copies_size
, /* I - Size of copies buffer */
3628 char *title
, /* I - Title buffer */
3629 size_t title_size
) /* I - Size of title buffer */
3631 int i
; /* Looping var */
3632 size_t newlength
; /* New option buffer length */
3633 char *optptr
, /* Pointer to options */
3634 *valptr
; /* Pointer in value string */
3635 ipp_attribute_t
*attr
; /* Current attribute */
3636 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3637 int num_pwgppds
; /* Number of PWG->PPD options */
3638 cups_option_t
*pwgppds
, /* PWG->PPD options */
3639 *pwgppd
, /* Current PWG->PPD option */
3640 *preset
; /* Current preset option */
3641 int print_color_mode
,
3642 /* Output mode (if any) */
3643 print_quality
; /* Print quality (if any) */
3644 const char *ppd
; /* PPD option choice */
3645 int exact
; /* Did we get an exact match? */
3646 static char *options
= NULL
;/* Full list of options */
3647 static size_t optlength
= 0; /* Length of option buffer */
3651 * Building the options string is harder than it needs to be, but for the
3652 * moment we need to pass strings for command-line args and not IPP attribute
3655 * First build an options array for any PWG->PPD mapped option/choice pairs.
3658 pc
= job
->printer
->pc
;
3663 !ippFindAttribute(job
->attrs
, "com.apple.print.DocumentTicket.PMSpoolFormat", IPP_TAG_ZERO
) &&
3664 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3665 (ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) || ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
) || ippFindAttribute(job
->attrs
, "cupsPrintQuality", IPP_TAG_ZERO
)))
3668 * Map print-color-mode and print-quality to a preset...
3671 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3672 IPP_TAG_KEYWORD
)) != NULL
&&
3673 !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3674 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3676 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3678 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ENUM
)) != NULL
)
3680 ipp_quality_t pq
= (ipp_quality_t
)ippGetInteger(attr
, 0);
3682 if (pq
>= IPP_QUALITY_DRAFT
&& pq
<= IPP_QUALITY_HIGH
)
3683 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3685 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3687 else if ((attr
= ippFindAttribute(job
->attrs
, "cupsPrintQuality", IPP_TAG_NAME
)) != NULL
)
3689 const char *pq
= ippGetString(attr
, 0, NULL
);
3691 if (!_cups_strcasecmp(pq
, "draft"))
3692 print_quality
= _PWG_PRINT_QUALITY_DRAFT
;
3693 else if (!_cups_strcasecmp(pq
, "high"))
3694 print_quality
= _PWG_PRINT_QUALITY_HIGH
;
3696 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3698 if (!ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ENUM
))
3700 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping cupsPrintQuality=%s to print-quality=%d", pq
, print_quality
+ IPP_QUALITY_DRAFT
);
3701 num_pwgppds
= cupsAddIntegerOption("print-quality", print_quality
+ IPP_QUALITY_DRAFT
, num_pwgppds
, &pwgppds
);
3706 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3709 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3712 * Try to find a preset that works so that we maximize the chances of us
3713 * getting a good print using IPP attributes.
3716 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3717 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3718 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3719 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3722 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3723 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3727 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3730 * Copy the preset options as long as the corresponding names are not
3731 * already defined in the IPP request...
3734 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3735 preset
= pc
->presets
[print_color_mode
][print_quality
];
3739 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3741 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Adding preset option %s=%s", preset
->name
, preset
->value
);
3743 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
, &pwgppds
);
3751 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ENUM
)) != NULL
)
3753 int pq
= ippGetInteger(attr
, 0);
3754 static const char * const pqs
[] = { "Draft", "Normal", "High" };
3756 if (pq
>= IPP_QUALITY_DRAFT
&& pq
<= IPP_QUALITY_HIGH
)
3758 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping print-quality=%d to cupsPrintQuality=%s", pq
, pqs
[pq
- IPP_QUALITY_DRAFT
]);
3760 num_pwgppds
= cupsAddOption("cupsPrintQuality", pqs
[pq
- IPP_QUALITY_DRAFT
], num_pwgppds
, &pwgppds
);
3764 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3765 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3767 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3768 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3771 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3772 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3774 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping media to MediaType=%s", ppd
);
3776 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3779 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3780 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3781 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3783 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping media to Pagesize=%s", ppd
);
3785 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3787 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3789 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Adding media=%s", ppd
);
3791 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3795 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3796 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3797 IPP_TAG_ZERO
)) != NULL
&&
3798 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3799 attr
->value_tag
== IPP_TAG_NAME
) &&
3800 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3803 * Map output-bin to OutputBin option...
3806 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping output-bin to OutputBin=%s", ppd
);
3808 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3811 if (pc
->sides_option
&&
3812 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3813 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3816 * Map sides to duplex option...
3819 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3821 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping sizes to Duplex=%s", pc
->sides_1sided
);
3823 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
, num_pwgppds
, &pwgppds
);
3825 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3827 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping sizes to Duplex=%s", pc
->sides_2sided_long
);
3829 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
, num_pwgppds
, &pwgppds
);
3831 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3833 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping sizes to Duplex=%s", pc
->sides_2sided_short
);
3835 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
, num_pwgppds
, &pwgppds
);
3840 * Map finishings values...
3843 num_pwgppds
= _ppdCacheGetFinishingOptions(pc
, job
->attrs
, IPP_FINISHINGS_NONE
, num_pwgppds
, &pwgppds
);
3845 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3846 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "After mapping finishings %s=%s", pwgppd
->name
, pwgppd
->value
);
3850 * Map page-delivery values...
3853 if ((attr
= ippFindAttribute(job
->attrs
, "page-delivery", IPP_TAG_KEYWORD
)) != NULL
&& !ippFindAttribute(job
->attrs
, "outputorder", IPP_TAG_ZERO
))
3855 const char *page_delivery
= ippGetString(attr
, 0, NULL
);
3857 if (!strncmp(page_delivery
, "same-order", 10))
3858 num_pwgppds
= cupsAddOption("OutputOrder", "Normal", num_pwgppds
, &pwgppds
);
3859 else if (!strncmp(page_delivery
, "reverse-order", 13))
3860 num_pwgppds
= cupsAddOption("OutputOrder", "Reverse", num_pwgppds
, &pwgppds
);
3864 * Figure out how much room we need...
3867 newlength
= ipp_length(job
->attrs
);
3869 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3870 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3873 * Then allocate/reallocate the option buffer as needed...
3876 if (newlength
== 0) /* This can never happen, but Clang */
3877 newlength
= 1; /* thinks it can... */
3879 if (newlength
> optlength
|| !options
)
3882 optptr
= malloc(newlength
);
3884 optptr
= realloc(options
, newlength
);
3888 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3889 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer.",
3890 CUPS_LLCAST newlength
);
3895 optlength
= newlength
;
3899 * Now loop through the attributes and convert them to the textual
3900 * representation used by the filters...
3906 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3907 strlcpy(copies
, "1", copies_size
);
3909 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3911 if (!strcmp(attr
->name
, "copies") &&
3912 attr
->value_tag
== IPP_TAG_INTEGER
)
3915 * Don't use the # copies attribute if we are printing the job sheets...
3919 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3921 else if (!strcmp(attr
->name
, "job-name") &&
3922 (attr
->value_tag
== IPP_TAG_NAME
||
3923 attr
->value_tag
== IPP_TAG_NAMELANG
))
3924 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3925 else if (attr
->group_tag
== IPP_TAG_JOB
)
3928 * Filter out other unwanted attributes...
3931 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3932 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3933 attr
->value_tag
== IPP_TAG_NAMELANG
||
3934 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3935 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid") &&
3936 strcmp(attr
->name
, "job-authorization-uri")) ||
3937 attr
->value_tag
== IPP_TAG_URISCHEME
||
3938 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3941 if (!strcmp(attr
->name
, "job-hold-until") ||
3942 !strcmp(attr
->name
, "job-id") ||
3943 !strcmp(attr
->name
, "job-k-octets") ||
3944 !strcmp(attr
->name
, "job-media-sheets") ||
3945 !strcmp(attr
->name
, "job-media-sheets-completed") ||
3946 !strcmp(attr
->name
, "job-state") ||
3947 !strcmp(attr
->name
, "job-state-reasons"))
3950 if (!strncmp(attr
->name
, "job-", 4) &&
3951 strcmp(attr
->name
, "job-account-id") &&
3952 strcmp(attr
->name
, "job-accounting-user-id") &&
3953 strcmp(attr
->name
, "job-authorization-uri") &&
3954 strcmp(attr
->name
, "job-billing") &&
3955 strcmp(attr
->name
, "job-impressions") &&
3956 strcmp(attr
->name
, "job-originating-host-name") &&
3957 strcmp(attr
->name
, "job-password") &&
3958 strcmp(attr
->name
, "job-password-encryption") &&
3959 strcmp(attr
->name
, "job-uuid") &&
3960 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3963 if ((!strcmp(attr
->name
, "job-impressions") ||
3964 !strcmp(attr
->name
, "page-label") ||
3965 !strcmp(attr
->name
, "page-border") ||
3966 !strncmp(attr
->name
, "number-up", 9) ||
3967 !strcmp(attr
->name
, "page-ranges") ||
3968 !strcmp(attr
->name
, "page-set") ||
3969 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3970 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3971 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3972 "PMTotalSidesImaged..n.") ||
3973 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3974 "PMTotalBeginPages..n.")) &&
3979 * Otherwise add them to the list...
3982 if (optptr
> options
)
3983 strlcat(optptr
, " ", optlength
- (size_t)(optptr
- options
));
3985 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3987 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
3988 strlcat(optptr
, "=", optlength
- (size_t)(optptr
- options
));
3991 for (i
= 0; i
< attr
->num_values
; i
++)
3994 strlcat(optptr
, ",", optlength
- (size_t)(optptr
- options
));
3996 optptr
+= strlen(optptr
);
3998 switch (attr
->value_tag
)
4000 case IPP_TAG_INTEGER
:
4002 snprintf(optptr
, optlength
- (size_t)(optptr
- options
),
4003 "%d", attr
->values
[i
].integer
);
4006 case IPP_TAG_BOOLEAN
:
4007 if (!attr
->values
[i
].boolean
)
4008 strlcat(optptr
, "no", optlength
- (size_t)(optptr
- options
));
4010 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
4013 case IPP_TAG_RANGE
:
4014 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
4015 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
4016 "%d", attr
->values
[i
].range
.lower
);
4018 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
4019 "%d-%d", attr
->values
[i
].range
.lower
,
4020 attr
->values
[i
].range
.upper
);
4023 case IPP_TAG_RESOLUTION
:
4024 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
4025 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
4026 attr
->values
[i
].resolution
.yres
,
4027 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
4031 case IPP_TAG_STRING
:
4033 int length
= attr
->values
[i
].unknown
.length
;
4035 for (valptr
= attr
->values
[i
].unknown
.data
; length
> 0; length
--)
4037 if ((*valptr
& 255) < 0x20 || *valptr
== 0x7f)
4044 * Encode this string as hex characters...
4049 for (valptr
= attr
->values
[i
].unknown
.data
, length
= attr
->values
[i
].unknown
.length
; length
> 0; length
--)
4051 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1, "%02X", *valptr
& 255);
4059 for (valptr
= attr
->values
[i
].unknown
.data
, length
= attr
->values
[i
].unknown
.length
; length
> 0; length
--)
4061 if (strchr(" \t\n\\\'\"", *valptr
))
4063 *optptr
++ = *valptr
++;
4073 case IPP_TAG_KEYWORD
:
4074 case IPP_TAG_CHARSET
:
4075 case IPP_TAG_LANGUAGE
:
4077 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
4079 if (strchr(" \t\n\\\'\"", *valptr
))
4081 *optptr
++ = *valptr
++;
4088 break; /* anti-compiler-warning-code */
4092 optptr
+= strlen(optptr
);
4097 * Finally loop through the PWG->PPD mapped options and add them...
4100 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
4103 strlcpy(optptr
, pwgppd
->name
, optlength
- (size_t)(optptr
- options
));
4104 optptr
+= strlen(optptr
);
4106 strlcpy(optptr
, pwgppd
->value
, optlength
- (size_t)(optptr
- options
));
4107 optptr
+= strlen(optptr
);
4110 cupsFreeOptions(num_pwgppds
, pwgppds
);
4113 * Return the options string...
4121 * 'ipp_length()' - Compute the size of the buffer needed to hold
4122 * the textual IPP attributes.
4125 static size_t /* O - Size of attribute buffer */
4126 ipp_length(ipp_t
*ipp
) /* I - IPP request */
4128 size_t bytes
; /* Number of bytes */
4129 int i
; /* Looping var */
4130 ipp_attribute_t
*attr
; /* Current attribute */
4134 * Loop through all attributes...
4139 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
4142 * Skip attributes that won't be sent to filters...
4145 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
4146 attr
->value_tag
== IPP_TAG_MIMETYPE
||
4147 attr
->value_tag
== IPP_TAG_NAMELANG
||
4148 attr
->value_tag
== IPP_TAG_TEXTLANG
||
4149 attr
->value_tag
== IPP_TAG_URI
||
4150 attr
->value_tag
== IPP_TAG_URISCHEME
)
4154 * Add space for a leading space and commas between each value.
4155 * For the first attribute, the leading space isn't used, so the
4156 * extra byte can be used as the nul terminator...
4159 bytes
++; /* " " separator */
4160 bytes
+= (size_t)attr
->num_values
; /* "," separators */
4163 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
4164 * other attributes appear as "foo=value1,value2,...,valueN".
4167 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
4168 bytes
+= strlen(attr
->name
);
4170 bytes
+= (size_t)attr
->num_values
* strlen(attr
->name
);
4173 * Now add the size required for each value in the attribute...
4176 switch (attr
->value_tag
)
4178 case IPP_TAG_INTEGER
:
4181 * Minimum value of a signed integer is -2147483647, or 11 digits.
4184 bytes
+= (size_t)attr
->num_values
* 11;
4187 case IPP_TAG_BOOLEAN
:
4189 * Add two bytes for each false ("no") value...
4192 for (i
= 0; i
< attr
->num_values
; i
++)
4193 if (!attr
->values
[i
].boolean
)
4197 case IPP_TAG_RANGE
:
4199 * A range is two signed integers separated by a hyphen, or
4200 * 23 characters max.
4203 bytes
+= (size_t)attr
->num_values
* 23;
4206 case IPP_TAG_RESOLUTION
:
4208 * A resolution is two signed integers separated by an "x" and
4209 * suffixed by the units, or 26 characters max.
4212 bytes
+= (size_t)attr
->num_values
* 26;
4215 case IPP_TAG_STRING
:
4217 * Octet strings can contain characters that need quoting. We need
4218 * at least 2 * len + 2 characters to cover the quotes and any
4219 * backslashes in the string.
4222 for (i
= 0; i
< attr
->num_values
; i
++)
4223 bytes
+= 2 * (size_t)attr
->values
[i
].unknown
.length
+ 2;
4228 case IPP_TAG_KEYWORD
:
4229 case IPP_TAG_CHARSET
:
4230 case IPP_TAG_LANGUAGE
:
4233 * Strings can contain characters that need quoting. We need
4234 * at least 2 * len + 2 characters to cover the quotes and
4235 * any backslashes in the string.
4238 for (i
= 0; i
< attr
->num_values
; i
++)
4239 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
4243 break; /* anti-compiler-warning-code */
4252 * 'load_job_cache()' - Load jobs from the job.cache file.
4256 load_job_cache(const char *filename
) /* I - job.cache filename */
4258 cups_file_t
*fp
; /* job.cache file */
4259 char line
[1024], /* Line buffer */
4260 *value
; /* Value on line */
4261 int linenum
; /* Line number in file */
4262 cupsd_job_t
*job
; /* Current job */
4263 int jobid
; /* Job ID */
4264 char jobfile
[1024]; /* Job filename */
4268 * Open the job.cache file...
4271 if ((fp
= cupsdOpenConfFile(filename
)) == NULL
)
4273 load_request_root();
4278 * Read entries from the job cache file and create jobs as needed.
4281 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
4287 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4289 if (!_cups_strcasecmp(line
, "NextJobId"))
4292 NextJobId
= atoi(value
);
4294 else if (!_cups_strcasecmp(line
, "<Job"))
4298 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d of %s.", linenum
, filename
);
4304 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d of %s.", linenum
, filename
);
4308 jobid
= atoi(value
);
4312 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d of %s.", jobid
, linenum
, filename
);
4316 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
4317 if (access(jobfile
, 0))
4319 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d.N", RequestRoot
, jobid
);
4320 if (access(jobfile
, 0))
4322 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away.",
4326 * job.cache file is out-of-date compared to spool directory; load
4331 load_request_root();
4336 job
= calloc(1, sizeof(cupsd_job_t
));
4339 cupsdLogMessage(CUPSD_LOG_EMERG
,
4340 "[Job %d] Unable to allocate memory for job.", jobid
);
4345 job
->back_pipes
[0] = -1;
4346 job
->back_pipes
[1] = -1;
4347 job
->print_pipes
[0] = -1;
4348 job
->print_pipes
[1] = -1;
4349 job
->side_pipes
[0] = -1;
4350 job
->side_pipes
[1] = -1;
4351 job
->status_pipes
[0] = -1;
4352 job
->status_pipes
[1] = -1;
4354 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading from cache...");
4358 cupsdLogMessage(CUPSD_LOG_ERROR
,
4359 "Missing <Job #> directive on line %d of %s.", linenum
, filename
);
4362 else if (!_cups_strcasecmp(line
, "</Job>"))
4364 cupsArrayAdd(Jobs
, job
);
4366 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
4367 cupsArrayAdd(ActiveJobs
, job
);
4368 else if (job
->state_value
> IPP_JOB_STOPPED
)
4370 if (!job
->completed_time
|| !job
->creation_time
|| !job
->name
|| !job
->koctets
)
4381 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d of %s.", linenum
, filename
);
4384 else if (!_cups_strcasecmp(line
, "State"))
4386 job
->state_value
= (ipp_jstate_t
)atoi(value
);
4388 if (job
->state_value
< IPP_JOB_PENDING
)
4389 job
->state_value
= IPP_JOB_PENDING
;
4390 else if (job
->state_value
> IPP_JOB_COMPLETED
)
4391 job
->state_value
= IPP_JOB_COMPLETED
;
4393 else if (!_cups_strcasecmp(line
, "Name"))
4395 cupsdSetString(&(job
->name
), value
);
4397 else if (!_cups_strcasecmp(line
, "Created"))
4399 job
->creation_time
= strtol(value
, NULL
, 10);
4401 else if (!_cups_strcasecmp(line
, "Completed"))
4403 job
->completed_time
= strtol(value
, NULL
, 10);
4405 else if (!_cups_strcasecmp(line
, "HoldUntil"))
4407 job
->hold_until
= strtol(value
, NULL
, 10);
4409 else if (!_cups_strcasecmp(line
, "Priority"))
4411 job
->priority
= atoi(value
);
4413 else if (!_cups_strcasecmp(line
, "Username"))
4415 cupsdSetString(&job
->username
, value
);
4417 else if (!_cups_strcasecmp(line
, "Destination"))
4419 cupsdSetString(&job
->dest
, value
);
4421 else if (!_cups_strcasecmp(line
, "DestType"))
4423 job
->dtype
= (cups_ptype_t
)atoi(value
);
4425 else if (!_cups_strcasecmp(line
, "KOctets"))
4427 job
->koctets
= atoi(value
);
4429 else if (!_cups_strcasecmp(line
, "NumFiles"))
4431 job
->num_files
= atoi(value
);
4433 if (job
->num_files
< 0)
4435 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d of %s.", job
->num_files
, linenum
, filename
);
4440 if (job
->num_files
> 0)
4442 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
4444 if (access(jobfile
, 0))
4446 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Data files have gone away.");
4451 job
->filetypes
= calloc((size_t)job
->num_files
, sizeof(mime_type_t
*));
4452 job
->compressions
= calloc((size_t)job
->num_files
, sizeof(int));
4454 if (!job
->filetypes
|| !job
->compressions
)
4456 cupsdLogJob(job
, CUPSD_LOG_EMERG
,
4457 "Unable to allocate memory for %d files.",
4463 else if (!_cups_strcasecmp(line
, "File"))
4465 int number
, /* File number */
4466 compression
; /* Compression value */
4467 char super
[MIME_MAX_SUPER
], /* MIME super type */
4468 type
[MIME_MAX_TYPE
]; /* MIME type */
4471 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
4474 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d of %s.", linenum
, filename
);
4478 if (number
< 1 || number
> job
->num_files
)
4480 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d of %s.", number
, linenum
, filename
);
4486 job
->compressions
[number
] = compression
;
4487 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
4489 if (!job
->filetypes
[number
])
4492 * If the original MIME type is unknown, auto-type it!
4495 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
4496 "Unknown MIME type %s/%s for file %d.",
4497 super
, type
, number
+ 1);
4499 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
4500 job
->id
, number
+ 1);
4501 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
4502 job
->compressions
+ number
);
4505 * If that didn't work, assume it is raw...
4508 if (!job
->filetypes
[number
])
4509 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
4514 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d of %s.", line
, linenum
, filename
);
4519 cupsdLogMessage(CUPSD_LOG_ERROR
,
4520 "Missing </Job> directive on line %d of %s.", linenum
, filename
);
4521 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
4529 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4533 load_next_job_id(const char *filename
) /* I - job.cache filename */
4535 cups_file_t
*fp
; /* job.cache file */
4536 char line
[1024], /* Line buffer */
4537 *value
; /* Value on line */
4538 int linenum
; /* Line number in file */
4539 int next_job_id
; /* NextJobId value from line */
4543 * Read the NextJobId directive from the job.cache file and use
4544 * the value (if any).
4547 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4549 if (errno
!= ENOENT
)
4550 cupsdLogMessage(CUPSD_LOG_ERROR
,
4551 "Unable to open job cache file \"%s\": %s",
4552 filename
, strerror(errno
));
4557 cupsdLogMessage(CUPSD_LOG_INFO
,
4558 "Loading NextJobId from job cache file \"%s\"...", filename
);
4562 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4564 if (!_cups_strcasecmp(line
, "NextJobId"))
4568 next_job_id
= atoi(value
);
4570 if (next_job_id
> NextJobId
)
4571 NextJobId
= next_job_id
;
4582 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4586 load_request_root(void)
4588 cups_dir_t
*dir
; /* Directory */
4589 cups_dentry_t
*dent
; /* Directory entry */
4590 cupsd_job_t
*job
; /* New job */
4594 * Open the requests directory...
4597 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
4599 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
4601 cupsdLogMessage(CUPSD_LOG_ERROR
,
4602 "Unable to open spool directory \"%s\": %s",
4603 RequestRoot
, strerror(errno
));
4608 * Read all the c##### files...
4611 while ((dent
= cupsDirRead(dir
)) != NULL
)
4612 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
4615 * Allocate memory for the job...
4618 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
4620 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs.");
4626 * Assign the job ID...
4629 job
->id
= atoi(dent
->filename
+ 1);
4630 job
->back_pipes
[0] = -1;
4631 job
->back_pipes
[1] = -1;
4632 job
->print_pipes
[0] = -1;
4633 job
->print_pipes
[1] = -1;
4634 job
->side_pipes
[0] = -1;
4635 job
->side_pipes
[1] = -1;
4636 job
->status_pipes
[0] = -1;
4637 job
->status_pipes
[1] = -1;
4639 if (job
->id
>= NextJobId
)
4640 NextJobId
= job
->id
+ 1;
4646 if (cupsdLoadJob(job
))
4649 * Insert the job into the array, sorting by job priority and ID...
4652 cupsArrayAdd(Jobs
, job
);
4654 if (job
->state_value
<= IPP_JOB_STOPPED
)
4655 cupsArrayAdd(ActiveJobs
, job
);
4668 * 'remove_job_files()' - Remove the document files for a job.
4672 remove_job_files(cupsd_job_t
*job
) /* I - Job */
4674 int i
; /* Looping var */
4675 char filename
[1024]; /* Document filename */
4678 if (job
->num_files
<= 0)
4681 for (i
= 1; i
<= job
->num_files
; i
++)
4683 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
4685 cupsdUnlinkOrRemoveFile(filename
);
4688 free(job
->filetypes
);
4689 free(job
->compressions
);
4693 job
->filetypes
= NULL
;
4694 job
->compressions
= NULL
;
4696 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4701 * 'remove_job_history()' - Remove the control file for a job.
4705 remove_job_history(cupsd_job_t
*job
) /* I - Job */
4707 char filename
[1024]; /* Control filename */
4711 * Remove the job info file...
4714 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
4716 cupsdUnlinkOrRemoveFile(filename
);
4718 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4723 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4727 set_time(cupsd_job_t
*job
, /* I - Job to update */
4728 const char *name
) /* I - Name of attribute */
4730 char date_name
[128]; /* date-time-at-xxx */
4731 ipp_attribute_t
*attr
; /* Time attribute */
4732 time_t curtime
; /* Current time */
4735 curtime
= time(NULL
);
4737 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s=%ld", name
, (long)curtime
);
4739 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
4741 attr
->value_tag
= IPP_TAG_INTEGER
;
4742 attr
->values
[0].integer
= curtime
;
4745 snprintf(date_name
, sizeof(date_name
), "date-%s", name
);
4747 if ((attr
= ippFindAttribute(job
->attrs
, date_name
, IPP_TAG_ZERO
)) != NULL
)
4749 attr
->value_tag
= IPP_TAG_DATE
;
4750 ippSetDate(job
->attrs
, &attr
, 0, ippTimeToDate(curtime
));
4753 if (!strcmp(name
, "time-at-completed"))
4755 job
->completed_time
= curtime
;
4757 if (JobHistory
< INT_MAX
&& attr
)
4758 job
->history_time
= job
->completed_time
+ JobHistory
;
4760 job
->history_time
= INT_MAX
;
4762 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4763 JobHistoryUpdate
= job
->history_time
;
4765 if (JobFiles
< INT_MAX
&& attr
)
4766 job
->file_time
= job
->completed_time
+ JobFiles
;
4768 job
->file_time
= INT_MAX
;
4770 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4771 JobHistoryUpdate
= job
->file_time
;
4773 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "set_time: JobHistoryUpdate=%ld",
4774 (long)JobHistoryUpdate
);
4780 * 'start_job()' - Start a print job.
4784 start_job(cupsd_job_t
*job
, /* I - Job ID */
4785 cupsd_printer_t
*printer
) /* I - Printer to print job */
4787 const char *filename
; /* Support filename */
4788 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
4791 /* job-cancel-after attribute */
4794 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
4795 job
, job
->id
, printer
, printer
->name
);
4798 * Make sure we have some files around before we try to print...
4801 if (job
->num_files
== 0)
4803 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
4804 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
4805 "Aborting job because it has no files.");
4810 * Update the printer and job state to "processing"...
4813 if (!cupsdLoadJob(job
))
4816 if (!job
->printer_message
)
4817 job
->printer_message
= ippFindAttribute(job
->attrs
,
4818 "job-printer-state-message",
4820 if (job
->printer_message
)
4821 ippSetString(job
->attrs
, &job
->printer_message
, 0, "");
4823 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-printing");
4824 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
4825 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
4826 cupsdSetPrinterReasons(printer
, "-cups-remote-pending,"
4827 "cups-remote-pending-held,"
4828 "cups-remote-processing,"
4829 "cups-remote-stopped,"
4830 "cups-remote-canceled,"
4831 "cups-remote-aborted,"
4832 "cups-remote-completed");
4835 job
->current_file
= 0;
4837 job
->history_time
= 0;
4839 job
->printer
= printer
;
4843 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
4844 else if (MaxJobTime
> 0)
4845 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4847 job
->cancel_time
= 0;
4850 * Check for support files...
4853 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
4854 "cups-insecure-filter-warning");
4858 for (filename
= (const char *)cupsArrayFirst(printer
->pc
->support_files
);
4860 filename
= (const char *)cupsArrayNext(printer
->pc
->support_files
))
4862 if (_cupsFileCheck(filename
, _CUPS_FILE_CHECK_FILE
, !RunUser
,
4863 cupsdLogFCMessage
, printer
))
4869 * Setup the last exit status and security profiles...
4873 job
->profile
= cupsdCreateProfile(job
->id
, 0);
4874 job
->bprofile
= cupsdCreateProfile(job
->id
, 1);
4876 #ifdef HAVE_SANDBOX_H
4877 if ((!job
->profile
|| !job
->bprofile
) && UseSandboxing
&& Sandboxing
!= CUPSD_SANDBOXING_OFF
)
4880 * Failure to create the sandbox profile means something really bad has
4881 * happened and we need to shutdown immediately.
4886 #endif /* HAVE_SANDBOX_H */
4889 * Create the status pipes and buffer...
4892 if (cupsdOpenPipe(job
->status_pipes
))
4894 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4895 "Unable to create job status pipes - %s.", strerror(errno
));
4897 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4898 "Job stopped because the scheduler could not create the "
4899 "job status pipes.");
4901 cupsdDestroyProfile(job
->profile
);
4902 job
->profile
= NULL
;
4903 cupsdDestroyProfile(job
->bprofile
);
4904 job
->bprofile
= NULL
;
4908 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
4909 job
->status_level
= CUPSD_LOG_INFO
;
4912 * Create the backchannel pipes and make them non-blocking...
4915 if (cupsdOpenPipe(job
->back_pipes
))
4917 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4918 "Unable to create back-channel pipes - %s.", strerror(errno
));
4920 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4921 "Job stopped because the scheduler could not create the "
4922 "back-channel pipes.");
4924 cupsdClosePipe(job
->status_pipes
);
4925 cupsdStatBufDelete(job
->status_buffer
);
4926 job
->status_buffer
= NULL
;
4928 cupsdDestroyProfile(job
->profile
);
4929 job
->profile
= NULL
;
4930 cupsdDestroyProfile(job
->bprofile
);
4931 job
->bprofile
= NULL
;
4935 fcntl(job
->back_pipes
[0], F_SETFL
,
4936 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4937 fcntl(job
->back_pipes
[1], F_SETFL
,
4938 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4941 * Create the side-channel pipes and make them non-blocking...
4944 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4946 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4947 "Unable to create side-channel pipes - %s.", strerror(errno
));
4949 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4950 "Job stopped because the scheduler could not create the "
4951 "side-channel pipes.");
4953 cupsdClosePipe(job
->back_pipes
);
4955 cupsdClosePipe(job
->status_pipes
);
4956 cupsdStatBufDelete(job
->status_buffer
);
4957 job
->status_buffer
= NULL
;
4959 cupsdDestroyProfile(job
->profile
);
4960 job
->profile
= NULL
;
4961 cupsdDestroyProfile(job
->bprofile
);
4962 job
->bprofile
= NULL
;
4966 fcntl(job
->side_pipes
[0], F_SETFL
,
4967 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4968 fcntl(job
->side_pipes
[1], F_SETFL
,
4969 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4971 fcntl(job
->side_pipes
[0], F_SETFD
,
4972 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4973 fcntl(job
->side_pipes
[1], F_SETFD
,
4974 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4977 * Now start the first file in the job...
4980 cupsdContinueJob(job
);
4985 * 'stop_job()' - Stop a print job.
4989 stop_job(cupsd_job_t
*job
, /* I - Job */
4990 cupsd_jobaction_t action
) /* I - Action */
4992 int i
; /* Looping var */
4995 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4998 FilterLevel
-= job
->cost
;
5001 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
&& job
->backend
> 0)
5002 job
->kill_time
= time(NULL
) + JobKillDelay
;
5003 else if (action
>= CUPSD_JOB_FORCE
)
5006 for (i
= 0; job
->filters
[i
]; i
++)
5007 if (job
->filters
[i
] > 0)
5009 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
5011 if (action
>= CUPSD_JOB_FORCE
)
5012 job
->filters
[i
] = -job
->filters
[i
];
5015 if (job
->backend
> 0)
5017 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
5019 if (action
>= CUPSD_JOB_FORCE
)
5020 job
->backend
= -job
->backend
;
5023 if (action
>= CUPSD_JOB_FORCE
)
5026 * Clear job status...
5035 * 'unload_job()' - Unload a job from memory.
5039 unload_job(cupsd_job_t
*job
) /* I - Job */
5044 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Unloading...");
5046 ippDelete(job
->attrs
);
5050 job
->reasons
= NULL
;
5051 job
->impressions
= NULL
;
5053 job
->job_sheets
= NULL
;
5054 job
->printer_message
= NULL
;
5055 job
->printer_reasons
= NULL
;
5060 * 'update_job()' - Read a status update from a job's filters.
5064 update_job(cupsd_job_t
*job
) /* I - Job to check */
5066 int i
; /* Looping var */
5067 char message
[CUPSD_SB_BUFFER_SIZE
],
5069 *ptr
; /* Pointer update... */
5070 int loglevel
, /* Log level for message */
5071 event
= 0; /* Events? */
5072 cupsd_printer_t
*printer
= job
->printer
;
5074 static const char * const levels
[] = /* Log levels */
5090 * Get the printer associated with this job; if the printer is stopped for
5091 * any reason then job->printer will be reset to NULL, so make sure we have
5092 * a valid pointer...
5095 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
5096 message
, sizeof(message
))) != NULL
)
5099 * Process page and printer state messages as needed...
5102 if (loglevel
== CUPSD_LOG_PAGE
)
5104 int impressions
= ippGetInteger(job
->impressions
, 0);
5105 /* Number of impressions printed */
5106 int delta
; /* Number of impressions added */
5109 * Page message; send the message to the page_log file and update the
5110 * job sheet count...
5113 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
5115 if (!_cups_strncasecmp(message
, "total ", 6))
5118 * Got a total count of pages from a backend or filter...
5121 int total
= atoi(message
+ 6); /* Total impressions */
5123 if (total
> impressions
)
5125 delta
= total
- impressions
;
5126 impressions
= total
;
5134 * Add the number of copies to the impression count...
5137 int copies
; /* Number of copies */
5139 if (!sscanf(message
, "%*d%d", &copies
) || copies
<= 0)
5143 impressions
+= copies
;
5146 if (job
->impressions
)
5147 ippSetInteger(job
->attrs
, &job
->impressions
, 0, impressions
);
5151 const char *sides
= ippGetString(ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
), 0, NULL
);
5153 if (sides
&& strcmp(sides
, "one-sided"))
5154 ippSetInteger(job
->attrs
, &job
->sheets
, 0, impressions
/ 2);
5156 ippSetInteger(job
->attrs
, &job
->sheets
, 0, impressions
);
5158 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
, "Printed %d page(s).", ippGetInteger(job
->sheets
, 0));
5162 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5164 if (job
->printer
->page_limit
)
5165 cupsdUpdateQuota(job
->printer
, job
->username
, delta
, 0);
5167 else if (loglevel
== CUPSD_LOG_JOBSTATE
)
5170 * Support "keyword" to set job-state-reasons to the specified keyword.
5171 * This is sufficient for the current paid printing stuff.
5174 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "JOBSTATE: %s", message
);
5176 if (!strcmp(message
, "cups-retry-as-raster"))
5177 job
->retry_as_raster
= 1;
5179 ippSetString(job
->attrs
, &job
->reasons
, 0, message
);
5181 else if (loglevel
== CUPSD_LOG_STATE
)
5183 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
5185 if (!strcmp(message
, "paused"))
5187 cupsdStopPrinter(job
->printer
, 1);
5190 else if (message
[0] && cupsdSetPrinterReasons(job
->printer
, message
))
5192 event
|= CUPSD_EVENT_PRINTER_STATE
;
5197 * Reset cancel time after connecting to the device...
5200 for (i
= 0; i
< job
->printer
->num_reasons
; i
++)
5201 if (!strcmp(job
->printer
->reasons
[i
], "connecting-to-device"))
5204 if (i
>= job
->printer
->num_reasons
)
5206 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
5209 /* job-cancel-after attribute */
5212 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
5213 else if (MaxJobTime
> 0)
5214 job
->cancel_time
= time(NULL
) + MaxJobTime
;
5216 job
->cancel_time
= 0;
5221 update_job_attrs(job
, 0);
5223 else if (loglevel
== CUPSD_LOG_ATTR
)
5226 * Set attribute(s)...
5229 int num_attrs
; /* Number of attributes */
5230 cups_option_t
*attrs
; /* Attributes */
5231 const char *attr
; /* Attribute */
5233 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
5235 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
5237 if ((attr
= cupsGetOption("auth-info-default", num_attrs
,
5240 job
->printer
->num_options
= cupsAddOption("auth-info", attr
,
5241 job
->printer
->num_options
,
5242 &(job
->printer
->options
));
5243 cupsdSetPrinterAttrs(job
->printer
);
5245 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5248 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
5251 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
5252 cupsdSetPrinterAttrs(job
->printer
);
5254 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5257 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
5260 int progress
= atoi(attr
);
5263 if (progress
>= 0 && progress
<= 100)
5265 job
->progress
= progress
;
5268 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5269 "Printing page %d, %d%%",
5270 job
->sheets
->values
[0].integer
, job
->progress
);
5274 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
5276 cupsdSetString(&job
->printer
->alert
, attr
);
5277 event
|= CUPSD_EVENT_PRINTER_STATE
;
5280 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
5283 cupsdSetString(&job
->printer
->alert_description
, attr
);
5284 event
|= CUPSD_EVENT_PRINTER_STATE
;
5287 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
5289 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
5290 job
->printer
->marker_time
= time(NULL
);
5291 event
|= CUPSD_EVENT_PRINTER_STATE
;
5292 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5295 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
5297 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
5298 job
->printer
->marker_time
= time(NULL
);
5299 event
|= CUPSD_EVENT_PRINTER_STATE
;
5300 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5303 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
5305 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
5306 job
->printer
->marker_time
= time(NULL
);
5307 event
|= CUPSD_EVENT_PRINTER_STATE
;
5308 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5311 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
5313 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
5314 job
->printer
->marker_time
= time(NULL
);
5315 event
|= CUPSD_EVENT_PRINTER_STATE
;
5316 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5319 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
5321 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
5322 job
->printer
->marker_time
= time(NULL
);
5323 event
|= CUPSD_EVENT_PRINTER_STATE
;
5324 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5327 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
5329 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
5330 job
->printer
->marker_time
= time(NULL
);
5331 event
|= CUPSD_EVENT_PRINTER_STATE
;
5332 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5335 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
5337 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
5338 job
->printer
->marker_time
= time(NULL
);
5339 event
|= CUPSD_EVENT_PRINTER_STATE
;
5340 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5343 cupsFreeOptions(num_attrs
, attrs
);
5345 else if (loglevel
== CUPSD_LOG_PPD
)
5348 * Set attribute(s)...
5351 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
5353 job
->num_keywords
= cupsParseOptions(message
, job
->num_keywords
,
5359 * Strip legacy message prefix...
5362 if (!strncmp(message
, "recoverable:", 12))
5365 while (isspace(*ptr
& 255))
5368 else if (!strncmp(message
, "recovered:", 10))
5371 while (isspace(*ptr
& 255))
5378 cupsdLogJob(job
, loglevel
== CUPSD_LOG_INFO
? CUPSD_LOG_DEBUG
: loglevel
, "%s", ptr
);
5380 if (loglevel
< CUPSD_LOG_DEBUG
&&
5381 strcmp(job
->printer
->state_message
, ptr
))
5383 strlcpy(job
->printer
->state_message
, ptr
,
5384 sizeof(job
->printer
->state_message
));
5386 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
5388 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
5391 * Some messages show in the job-printer-state-message attribute...
5394 if (loglevel
!= CUPSD_LOG_NOTICE
)
5395 job
->status_level
= loglevel
;
5397 update_job_attrs(job
, 1);
5399 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
5400 "Set job-printer-state-message to \"%s\", "
5402 job
->printer_message
->values
[0].string
.text
,
5403 levels
[job
->status_level
]);
5408 if (!strchr(job
->status_buffer
->buffer
, '\n'))
5412 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
5413 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5414 "%s", job
->printer
->state_message
);
5415 if (event
& CUPSD_EVENT_PRINTER_STATE
)
5416 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
5417 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
5418 "Class \"%s\" state changed." :
5419 "Printer \"%s\" state changed.",
5420 job
->printer
->name
);
5423 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
5426 * See if all of the filters and the backend have returned their
5430 for (i
= 0; job
->filters
[i
] < 0; i
++);
5432 if (job
->filters
[i
])
5435 * EOF but we haven't collected the exit status of all filters...
5438 cupsdCheckProcess();
5442 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
5445 * EOF but we haven't collected the exit status of the backend...
5448 cupsdCheckProcess();
5453 * Handle the end of job stuff...
5456 finalize_job(job
, 1);
5459 * Try printing another job...
5462 if (printer
->state
!= IPP_PRINTER_STOPPED
)
5469 * 'update_job_attrs()' - Update the job-printer-* attributes.
5473 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
5474 int do_message
)/* I - 1 = copy job-printer-state message */
5476 int i
; /* Looping var */
5477 int num_reasons
; /* Actual number of reasons */
5478 const char * const *reasons
; /* Reasons */
5479 static const char *none
= "none"; /* "none" reason */
5483 * Get/create the job-printer-state-* attributes...
5486 if (!job
->printer_message
)
5488 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
5489 "job-printer-state-message",
5490 IPP_TAG_TEXT
)) == NULL
)
5491 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
5492 "job-printer-state-message",
5496 if (!job
->printer_reasons
)
5497 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
5498 "job-printer-state-reasons",
5502 * Copy or clear the printer-state-message value as needed...
5505 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
5506 job
->status_level
== CUPSD_LOG_INFO
)
5508 ippSetString(job
->attrs
, &job
->printer_message
, 0, "");
5511 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5513 else if (job
->printer
->state_message
[0] && do_message
)
5515 ippSetString(job
->attrs
, &job
->printer_message
, 0, job
->printer
->state_message
);
5518 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5522 * ... and the printer-state-reasons value...
5525 if (job
->printer
->num_reasons
== 0)
5532 num_reasons
= job
->printer
->num_reasons
;
5533 reasons
= (const char * const *)job
->printer
->reasons
;
5536 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
5539 * Replace/create a job-printer-state-reasons attribute...
5542 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
5544 job
->printer_reasons
= ippAddStrings(job
->attrs
,
5545 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
5546 "job-printer-state-reasons",
5547 num_reasons
, NULL
, NULL
);
5552 * Don't bother clearing the reason strings if they are the same...
5555 for (i
= 0; i
< num_reasons
; i
++)
5556 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
5559 if (i
>= num_reasons
)
5563 * Not the same, so free the current strings...
5566 for (i
= 0; i
< num_reasons
; i
++)
5567 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
5571 * Copy the reasons...
5574 for (i
= 0; i
< num_reasons
; i
++)
5575 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
5578 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);