4 * Job management routines for the CUPS scheduler.
6 * Copyright 2007-2012 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
17 * cupsdAddJob() - Add a new job to the job queue.
18 * cupsdCancelJobs() - Cancel all jobs for the given
20 * cupsdCheckJobs() - Check the pending jobs and start any if the
21 * destination is available.
22 * cupsdCleanJobs() - Clean out old jobs.
23 * cupsdContinueJob() - Continue printing with the next file in a
25 * cupsdDeleteJob() - Free all memory used by a job.
26 * cupsdFreeAllJobs() - Free all jobs from memory.
27 * cupsdFindJob() - Find the specified job.
28 * cupsdGetPrinterJobCount() - Get the number of pending, processing, or
29 * held jobs in a printer or class.
30 * cupsdGetUserJobCount() - Get the number of pending, processing, or
31 * held jobs for a user.
32 * cupsdLoadAllJobs() - Load all jobs from disk.
33 * cupsdLoadJob() - Load a single job.
34 * cupsdMoveJob() - Move the specified job to a different
36 * cupsdReleaseJob() - Release the specified job.
37 * cupsdRestartJob() - Restart the specified job.
38 * cupsdSaveAllJobs() - Save a summary of all jobs to disk.
39 * cupsdSaveJob() - Save a job to disk.
40 * cupsdSetJobHoldUntil() - Set the hold time for a job.
41 * cupsdSetJobPriority() - Set the priority of a job, moving it up/down
42 * in the list as needed.
43 * cupsdSetJobState() - Set the state of the specified print job.
44 * cupsdStopAllJobs() - Stop all print jobs.
45 * cupsdUnloadCompletedJobs() - Flush completed job history from memory.
46 * cupsdUpdateJobs() - Update the history/file files for all jobs.
47 * compare_active_jobs() - Compare the job IDs and priorities of two
49 * compare_jobs() - Compare the job IDs of two jobs.
50 * dump_job_history() - Dump any debug messages for a job.
51 * free_job_history() - Free any log history.
52 * finalize_job() - Cleanup after job filter processes and
54 * get_options() - Get a string containing the job options.
55 * ipp_length() - Compute the size of the buffer needed to hold
56 * the textual IPP attributes.
57 * load_job_cache() - Load jobs from the job.cache file.
58 * load_next_job_id() - Load the NextJobId value from the job.cache
60 * load_request_root() - Load jobs from the RequestRoot directory.
61 * remove_job_files() - Remove the document files for a job.
62 * remove_job_history() - Remove the control file for a job.
63 * set_time() - Set one of the "time-at-xyz" attributes.
64 * start_job() - Start a print job.
65 * stop_job() - Stop a print job.
66 * unload_job() - Unload a job from memory.
67 * update_job() - Read a status update from a job's filters.
68 * update_job_attrs() - Update the job-printer-* attributes.
72 * Include necessary headers...
77 #include <cups/backend.h>
80 # include <IOKit/pwr_mgt/IOPMLib.h>
81 # ifdef HAVE_IOKIT_PWR_MGT_IOPMLIBPRIVATE_H
82 # include <IOKit/pwr_mgt/IOPMLibPrivate.h>
83 # endif /* HAVE_IOKIT_PWR_MGT_IOPMLIBPRIVATE_H */
84 #endif /* __APPLE__ */
88 * Design Notes for Job Management
89 * -------------------------------
93 * pending Do nothing/check jobs
94 * pending-held Send SIGTERM to filters and backend
95 * processing Do nothing/start job
96 * stopped Send SIGKILL to filters and backend
97 * canceled Send SIGTERM to filters and backend
101 * Finalize clears the printer <-> job association, deletes the status
102 * buffer, closes all of the pipes, etc. and doesn't get run until all of
103 * the print processes are finished.
105 * UNLOADING OF JOBS (cupsdUnloadCompletedJobs)
107 * We unload the job attributes when they are not needed to reduce overall
108 * memory consumption. We don't unload jobs where job->state_value <
109 * IPP_JOB_STOPPED, job->printer != NULL, or job->access_time is recent.
111 * STARTING OF JOBS (start_job)
113 * When a job is started, a status buffer, several pipes, a security
114 * profile, and a backend process are created for the life of that job.
115 * These are shared for every file in a job. For remote print jobs, the
116 * IPP backend is provided with every file in the job and no filters are
119 * The job->printer member tracks which printer is printing a job, which
120 * can be different than the destination in job->dest for classes. The
121 * printer object also has a job pointer to track which job is being
124 * PRINTING OF JOB FILES (cupsdContinueJob)
126 * Each file in a job is filtered by 0 or more programs. After getting the
127 * list of filters needed and the total cost, the job is either passed or
128 * put back to the processing state until the current FilterLevel comes down
129 * enough to allow printing.
131 * If we can print, we build a string for the print options and run each of
132 * the filters, piping the output from one into the next.
134 * JOB STATUS UPDATES (update_job)
136 * The update_job function gets called whenever there are pending messages
137 * on the status pipe. These generally are updates to the marker-*,
138 * printer-state-message, or printer-state-reasons attributes. On EOF,
139 * finalize_job is called to clean up.
141 * FINALIZING JOBS (finalize_job)
143 * When all filters and the backend are done, we set the job state to
144 * completed (no errors), aborted (filter errors or abort-job policy),
145 * pending-held (auth required or retry-job policy), or pending
146 * (retry-current-job or stop-printer policies) as appropriate.
148 * Then we close the pipes and free the status buffers and profiles.
150 * JOB FILE COMPLETION (process_children in main.c)
152 * For multiple-file jobs, process_children (in main.c) sees that all
153 * filters have exited and calls in to print the next file if there are
154 * more files in the job, otherwise it waits for the backend to exit and
155 * update_job to do the cleanup.
163 static mime_filter_t gziptoany_filter
=
165 NULL
, /* Source type */
166 NULL
, /* Destination type */
168 "gziptoany" /* Filter program to run */
176 static int compare_active_jobs(void *first
, void *second
, void *data
);
177 static int compare_jobs(void *first
, void *second
, void *data
);
178 static void dump_job_history(cupsd_job_t
*job
);
179 static void finalize_job(cupsd_job_t
*job
, int set_job_state
);
180 static void free_job_history(cupsd_job_t
*job
);
181 static char *get_options(cupsd_job_t
*job
, int banner_page
, char *copies
,
182 size_t copies_size
, char *title
,
184 static size_t ipp_length(ipp_t
*ipp
);
185 static void load_job_cache(const char *filename
);
186 static void load_next_job_id(const char *filename
);
187 static void load_request_root(void);
188 static void remove_job_files(cupsd_job_t
*job
);
189 static void remove_job_history(cupsd_job_t
*job
);
190 static void set_time(cupsd_job_t
*job
, const char *name
);
191 static void start_job(cupsd_job_t
*job
, cupsd_printer_t
*printer
);
192 static void stop_job(cupsd_job_t
*job
, cupsd_jobaction_t action
);
193 static void unload_job(cupsd_job_t
*job
);
194 static void update_job(cupsd_job_t
*job
);
195 static void update_job_attrs(cupsd_job_t
*job
, int do_message
);
199 * 'cupsdAddJob()' - Add a new job to the job queue.
202 cupsd_job_t
* /* O - New job record */
203 cupsdAddJob(int priority
, /* I - Job priority */
204 const char *dest
) /* I - Job destination */
206 cupsd_job_t
*job
; /* New job record */
209 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
212 job
->id
= NextJobId
++;
213 job
->priority
= priority
;
214 job
->back_pipes
[0] = -1;
215 job
->back_pipes
[1] = -1;
216 job
->print_pipes
[0] = -1;
217 job
->print_pipes
[1] = -1;
218 job
->side_pipes
[0] = -1;
219 job
->side_pipes
[1] = -1;
220 job
->status_pipes
[0] = -1;
221 job
->status_pipes
[1] = -1;
223 cupsdSetString(&job
->dest
, dest
);
226 * Add the new job to the "all jobs" and "active jobs" lists...
229 cupsArrayAdd(Jobs
, job
);
230 cupsArrayAdd(ActiveJobs
, job
);
237 * 'cupsdCancelJobs()' - Cancel all jobs for the given destination/user.
241 cupsdCancelJobs(const char *dest
, /* I - Destination to cancel */
242 const char *username
, /* I - Username or NULL */
243 int purge
) /* I - Purge jobs? */
245 cupsd_job_t
*job
; /* Current job */
248 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
250 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
252 if ((!job
->dest
|| !job
->username
) && !cupsdLoadJob(job
))
255 if ((!dest
|| !strcmp(job
->dest
, dest
)) &&
256 (!username
|| !strcmp(job
->username
, username
)))
259 * Cancel all jobs matching this destination/user...
263 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_PURGE
,
264 "Job purged by user.");
265 else if (job
->state_value
< IPP_JOB_CANCELED
)
266 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
,
267 "Job canceled by user.");
276 * 'cupsdCheckJobs()' - Check the pending jobs and start any if the destination
283 cupsd_job_t
*job
; /* Current job in queue */
284 cupsd_printer_t
*printer
, /* Printer destination */
285 *pclass
; /* Printer class destination */
286 ipp_attribute_t
*attr
; /* Job attribute */
287 time_t curtime
; /* Current time */
290 curtime
= time(NULL
);
292 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
293 "cupsdCheckJobs: %d active jobs, sleeping=%d, reload=%d, "
294 "curtime=%ld", cupsArrayCount(ActiveJobs
), Sleeping
,
295 NeedReload
, (long)curtime
);
297 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
);
299 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
301 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
302 "cupsdCheckJobs: Job %d - dest=\"%s\", printer=%p, "
303 "state=%d, cancel_time=%ld, hold_until=%ld, kill_time=%ld, "
304 "pending_cost=%d, pending_timeout=%ld", job
->id
, job
->dest
,
305 job
->printer
, job
->state_value
, (long)job
->cancel_time
,
306 (long)job
->hold_until
, (long)job
->kill_time
,
307 job
->pending_cost
, (long)job
->pending_timeout
);
310 * Kill jobs if they are unresponsive...
313 if (job
->kill_time
&& job
->kill_time
<= curtime
)
315 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Stopping unresponsive job.",
318 stop_job(job
, CUPSD_JOB_FORCE
);
323 * Cancel stuck jobs...
326 if (job
->cancel_time
&& job
->cancel_time
<= curtime
)
328 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
,
329 "Canceling stuck job after %d seconds.", MaxJobTime
);
334 * Start held jobs if they are ready...
337 if (job
->state_value
== IPP_JOB_HELD
&&
339 job
->hold_until
< curtime
)
341 if (job
->pending_timeout
)
344 * This job is pending; check that we don't have an active Send-Document
345 * operation in progress on any of the client connections, then timeout
346 * the job so we can start printing...
349 cupsd_client_t
*con
; /* Current client connection */
351 for (con
= (cupsd_client_t
*)cupsArrayFirst(Clients
);
353 con
= (cupsd_client_t
*)cupsArrayNext(Clients
))
355 con
->request
->request
.op
.operation_id
== IPP_SEND_DOCUMENT
)
361 if (cupsdTimeoutJob(job
))
365 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
366 "Job submission timed out.");
370 * Continue jobs that are waiting on the FilterLimit...
373 if (job
->pending_cost
> 0 &&
374 ((FilterLevel
+ job
->pending_cost
) < FilterLimit
|| FilterLevel
== 0))
375 cupsdContinueJob(job
);
378 * Start pending jobs if the destination is available...
381 if (job
->state_value
== IPP_JOB_PENDING
&& !NeedReload
&&
382 #ifndef kIOPMAssertionTypeDenySystemSleep
384 #endif /* !kIOPMAssertionTypeDenySystemSleep */
385 !DoingShutdown
&& !job
->printer
)
387 printer
= cupsdFindDest(job
->dest
);
390 while (printer
&& (printer
->type
& CUPS_PRINTER_CLASS
))
393 * If the class is remote, just pass it to the remote server...
398 if (pclass
->state
== IPP_PRINTER_STOPPED
)
400 else if (pclass
->type
& CUPS_PRINTER_REMOTE
)
403 printer
= cupsdFindAvailablePrinter(printer
->name
);
406 if (!printer
&& !pclass
)
409 * Whoa, the printer and/or class for this destination went away;
413 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_PURGE
,
414 "Job aborted because the destination printer/class "
417 else if (printer
&& !printer
->holding_new_jobs
)
420 * See if the printer is available or remote and not printing a job;
421 * if so, start the job...
427 * Add/update a job-actual-printer-uri attribute for this job
428 * so that we know which printer actually printed the job...
431 if ((attr
= ippFindAttribute(job
->attrs
, "job-actual-printer-uri",
432 IPP_TAG_URI
)) != NULL
)
433 cupsdSetString(&attr
->values
[0].string
.text
, printer
->uri
);
435 ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_URI
,
436 "job-actual-printer-uri", NULL
, printer
->uri
);
439 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
442 if (!printer
->job
&& printer
->state
== IPP_PRINTER_IDLE
)
448 start_job(job
, printer
);
457 * 'cupsdCleanJobs()' - Clean out old jobs.
463 cupsd_job_t
*job
; /* Current job */
464 time_t curtime
; /* Current time */
467 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
468 "cupsdCleanJobs: MaxJobs=%d, JobHistory=%d, JobFiles=%d",
469 MaxJobs
, JobHistory
, JobFiles
);
471 if (MaxJobs
<= 0 && JobHistory
== INT_MAX
&& JobFiles
== INT_MAX
)
474 curtime
= time(NULL
);
475 JobHistoryUpdate
= 0;
477 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
479 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
481 if (job
->state_value
>= IPP_JOB_CANCELED
&& !job
->printer
)
484 * Expire old jobs (or job files)...
487 if ((MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
) ||
488 (job
->history_time
&& job
->history_time
<= curtime
))
490 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Removing from history.");
491 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
493 else if (job
->file_time
&& job
->file_time
<= curtime
)
495 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Removing document files.");
496 remove_job_files(job
);
498 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
499 JobHistoryUpdate
= job
->history_time
;
503 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
504 JobHistoryUpdate
= job
->history_time
;
506 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
507 JobHistoryUpdate
= job
->file_time
;
512 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCleanJobs: JobHistoryUpdate=%ld",
513 (long)JobHistoryUpdate
);
518 * 'cupsdContinueJob()' - Continue printing with the next file in a job.
522 cupsdContinueJob(cupsd_job_t
*job
) /* I - Job */
524 int i
; /* Looping var */
525 int slot
; /* Pipe slot */
526 cups_array_t
*filters
= NULL
,/* Filters for job */
527 *prefilters
; /* Filters with prefilters */
528 mime_filter_t
*filter
, /* Current filter */
529 *prefilter
, /* Prefilter */
530 port_monitor
; /* Port monitor filter */
531 char scheme
[255]; /* Device URI scheme */
532 ipp_attribute_t
*attr
; /* Current attribute */
533 const char *ptr
, /* Pointer into value */
534 *abort_message
; /* Abort message */
535 ipp_jstate_t abort_state
= IPP_JOB_STOPPED
;
536 /* New job state on abort */
537 struct stat backinfo
; /* Backend file information */
538 int backroot
; /* Run backend as root? */
539 int pid
; /* Process ID of new filter process */
540 int banner_page
; /* 1 if banner page, 0 otherwise */
541 int filterfds
[2][2] = { { -1, -1 }, { -1, -1 } };
542 /* Pipes used between filters */
543 int envc
; /* Number of environment variables */
544 struct stat fileinfo
; /* Job file information */
545 char **argv
= NULL
, /* Filter command-line arguments */
546 filename
[1024], /* Job filename */
547 command
[1024], /* Full path to command */
548 jobid
[255], /* Job ID string */
550 /* Job title string */
551 copies
[255], /* # copies string */
552 *options
, /* Options string */
554 /* Environment variables */
555 charset
[255], /* CHARSET env variable */
556 class_name
[255],/* CLASS env variable */
557 classification
[1024],
558 /* CLASSIFICATION env variable */
560 /* CONTENT_TYPE env variable */
562 /* DEVICE_URI env variable */
563 final_content_type
[1024] = "",
564 /* FINAL_CONTENT_TYPE env variable */
565 lang
[255], /* LANG env variable */
568 /* APPLE_LANGUAGE env variable */
569 #endif /* __APPLE__ */
570 auth_info_required
[255],
571 /* AUTH_INFO_REQUIRED env variable */
572 ppd
[1024], /* PPD env variable */
574 /* PRINTER_INFO env variable */
575 printer_location
[255],
576 /* PRINTER_LOCATION env variable */
578 /* PRINTER env variable */
579 *printer_state_reasons
= NULL
,
580 /* PRINTER_STATE_REASONS env var */
582 /* RIP_MAX_CACHE env variable */
585 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
586 "cupsdContinueJob(job=%p(%d)): current_file=%d, num_files=%d",
587 job
, job
->id
, job
->current_file
, job
->num_files
);
590 * Figure out what filters are required to convert from
591 * the source to the destination type...
594 FilterLevel
-= job
->cost
;
597 job
->pending_cost
= 0;
599 memset(job
->filters
, 0, sizeof(job
->filters
));
601 if (job
->printer
->raw
)
604 * Remote jobs and raw queues go directly to the printer without
608 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Sending job to queue tagged as raw...");
613 * Local jobs get filtered...
616 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
617 job
->id
, job
->current_file
+ 1);
618 if (stat(filename
, &fileinfo
))
619 fileinfo
.st_size
= 0;
621 filters
= mimeFilter2(MimeDatabase
, job
->filetypes
[job
->current_file
],
622 fileinfo
.st_size
, job
->printer
->filetype
,
627 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
628 "Unable to convert file %d to printable format.",
631 abort_message
= "Aborting job because it cannot be printed.";
632 abort_state
= IPP_JOB_ABORTED
;
634 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
639 * Figure out the final content type...
642 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%d filters for job:",
643 cupsArrayCount(filters
));
644 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
646 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
647 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s (%s/%s to %s/%s, cost %d)",
649 filter
->src
? filter
->src
->super
: "???",
650 filter
->src
? filter
->src
->type
: "???",
651 filter
->dst
? filter
->dst
->super
: "???",
652 filter
->dst
? filter
->dst
->type
: "???",
655 if (!job
->printer
->remote
)
657 for (filter
= (mime_filter_t
*)cupsArrayLast(filters
);
658 filter
&& filter
->dst
;
659 filter
= (mime_filter_t
*)cupsArrayPrev(filters
))
660 if (strcmp(filter
->dst
->super
, "printer") ||
661 strcmp(filter
->dst
->type
, job
->printer
->name
))
664 if (filter
&& filter
->dst
)
666 if ((ptr
= strchr(filter
->dst
->type
, '/')) != NULL
)
667 snprintf(final_content_type
, sizeof(final_content_type
),
668 "FINAL_CONTENT_TYPE=%s", ptr
+ 1);
670 snprintf(final_content_type
, sizeof(final_content_type
),
671 "FINAL_CONTENT_TYPE=%s/%s", filter
->dst
->super
,
677 * Remove NULL ("-") filters...
680 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
682 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
683 if (!strcmp(filter
->filter
, "-"))
684 cupsArrayRemove(filters
, filter
);
686 if (cupsArrayCount(filters
) == 0)
688 cupsArrayDelete(filters
);
693 * If this printer has any pre-filters, insert the required pre-filter
694 * in the filters array...
697 if (job
->printer
->prefiltertype
&& filters
)
699 prefilters
= cupsArrayNew(NULL
, NULL
);
701 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
703 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
705 if ((prefilter
= mimeFilterLookup(MimeDatabase
, filter
->src
,
706 job
->printer
->prefiltertype
)))
708 cupsArrayAdd(prefilters
, prefilter
);
709 job
->cost
+= prefilter
->cost
;
712 cupsArrayAdd(prefilters
, filter
);
715 cupsArrayDelete(filters
);
716 filters
= prefilters
;
721 * Set a minimum cost of 100 for all jobs so that FilterLimit
722 * works with raw queues and other low-cost paths.
729 * See if the filter cost is too high...
732 if ((FilterLevel
+ job
->cost
) > FilterLimit
&& FilterLevel
> 0 &&
736 * Don't print this job quite yet...
739 cupsArrayDelete(filters
);
741 cupsdLogJob(job
, CUPSD_LOG_INFO
,
742 "Holding because filter limit has been reached.");
743 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
,
744 "cupsdContinueJob: file=%d, cost=%d, level=%d, limit=%d",
745 job
->current_file
, job
->cost
, FilterLevel
,
748 job
->pending_cost
= job
->cost
;
753 FilterLevel
+= job
->cost
;
756 * Add decompression/raw filter as needed...
759 if ((!job
->printer
->raw
&& job
->compressions
[job
->current_file
]) ||
760 (!filters
&& !job
->printer
->remote
&&
761 (job
->num_files
> 1 || !strncmp(job
->printer
->device_uri
, "file:", 5))))
764 * Add gziptoany filter to the front of the list...
768 filters
= cupsArrayNew(NULL
, NULL
);
770 if (!cupsArrayInsert(filters
, &gziptoany_filter
))
772 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
773 "Unable to add decompression filter - %s", strerror(errno
));
775 cupsArrayDelete(filters
);
777 abort_message
= "Stopping job because the scheduler ran out of memory.";
784 * Add port monitor, if any...
787 if (job
->printer
->port_monitor
)
790 * Add port monitor to the end of the list...
794 filters
= cupsArrayNew(NULL
, NULL
);
796 port_monitor
.src
= NULL
;
797 port_monitor
.dst
= NULL
;
798 port_monitor
.cost
= 0;
800 snprintf(port_monitor
.filter
, sizeof(port_monitor
.filter
),
801 "%s/monitor/%s", ServerBin
, job
->printer
->port_monitor
);
803 if (!cupsArrayAdd(filters
, &port_monitor
))
805 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
806 "Unable to add port monitor - %s", strerror(errno
));
808 abort_message
= "Stopping job because the scheduler ran out of memory.";
815 * Make sure we don't go over the "MAX_FILTERS" limit...
818 if (cupsArrayCount(filters
) > MAX_FILTERS
)
820 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
821 "Too many filters (%d > %d), unable to print.",
822 cupsArrayCount(filters
), MAX_FILTERS
);
824 abort_message
= "Aborting job because it needs too many filters to print.";
825 abort_state
= IPP_JOB_ABORTED
;
827 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
833 * Determine if we are printing a banner page or not...
836 if (job
->job_sheets
== NULL
)
838 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "No job-sheets attribute.");
839 if ((job
->job_sheets
=
840 ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_ZERO
)) != NULL
)
841 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
842 "... but someone added one without setting job_sheets.");
844 else if (job
->job_sheets
->num_values
== 1)
845 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s",
846 job
->job_sheets
->values
[0].string
.text
);
848 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s,%s",
849 job
->job_sheets
->values
[0].string
.text
,
850 job
->job_sheets
->values
[1].string
.text
);
852 if (job
->printer
->type
& CUPS_PRINTER_REMOTE
)
854 else if (job
->job_sheets
== NULL
)
856 else if (_cups_strcasecmp(job
->job_sheets
->values
[0].string
.text
, "none") != 0 &&
857 job
->current_file
== 0)
859 else if (job
->job_sheets
->num_values
> 1 &&
860 _cups_strcasecmp(job
->job_sheets
->values
[1].string
.text
, "none") != 0 &&
861 job
->current_file
== (job
->num_files
- 1))
866 if ((options
= get_options(job
, banner_page
, copies
, sizeof(copies
), title
,
867 sizeof(title
))) == NULL
)
869 abort_message
= "Stopping job because the scheduler ran out of memory.";
875 * Build the command-line arguments for the filters. Each filter
876 * has 6 or 7 arguments:
884 * argv[6] = filename (optional; normally stdin)
886 * This allows legacy printer drivers that use the old System V
887 * printing interface to be used by CUPS.
889 * For remote jobs, we send all of the files in the argument list.
892 if (job
->printer
->remote
)
893 argv
= calloc(7 + job
->num_files
, sizeof(char *));
895 argv
= calloc(8, sizeof(char *));
899 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Unable to allocate argument array - %s",
902 abort_message
= "Stopping job because the scheduler ran out of memory.";
907 sprintf(jobid
, "%d", job
->id
);
909 argv
[0] = job
->printer
->name
;
911 argv
[2] = job
->username
;
916 if (job
->printer
->remote
&& job
->num_files
> 1)
918 for (i
= 0; i
< job
->num_files
; i
++)
920 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
922 argv
[6 + i
] = strdup(filename
);
927 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
928 job
->id
, job
->current_file
+ 1);
932 for (i
= 0; argv
[i
]; i
++)
933 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "argv[%d]=\"%s\"", i
, argv
[i
]);
936 * Create environment variable strings for the filters...
939 attr
= ippFindAttribute(job
->attrs
, "attributes-natural-language",
943 strlcpy(apple_language
, "APPLE_LANGUAGE=", sizeof(apple_language
));
944 _cupsAppleLanguage(attr
->values
[0].string
.text
,
945 apple_language
+ 15, sizeof(apple_language
) - 15);
946 #endif /* __APPLE__ */
948 switch (strlen(attr
->values
[0].string
.text
))
952 * This is an unknown or badly formatted language code; use
953 * the POSIX locale...
956 strlcpy(lang
, "LANG=C", sizeof(lang
));
961 * Just the language code (ll)...
964 snprintf(lang
, sizeof(lang
), "LANG=%s.UTF-8",
965 attr
->values
[0].string
.text
);
970 * Language and country code (ll-cc)...
973 snprintf(lang
, sizeof(lang
), "LANG=%c%c_%c%c.UTF-8",
974 attr
->values
[0].string
.text
[0],
975 attr
->values
[0].string
.text
[1],
976 toupper(attr
->values
[0].string
.text
[3] & 255),
977 toupper(attr
->values
[0].string
.text
[4] & 255));
981 if ((attr
= ippFindAttribute(job
->attrs
, "document-format",
982 IPP_TAG_MIMETYPE
)) != NULL
&&
983 (ptr
= strstr(attr
->values
[0].string
.text
, "charset=")) != NULL
)
984 snprintf(charset
, sizeof(charset
), "CHARSET=%s", ptr
+ 8);
986 strlcpy(charset
, "CHARSET=utf-8", sizeof(charset
));
988 snprintf(content_type
, sizeof(content_type
), "CONTENT_TYPE=%s/%s",
989 job
->filetypes
[job
->current_file
]->super
,
990 job
->filetypes
[job
->current_file
]->type
);
991 snprintf(device_uri
, sizeof(device_uri
), "DEVICE_URI=%s",
992 job
->printer
->device_uri
);
993 snprintf(ppd
, sizeof(ppd
), "PPD=%s/ppd/%s.ppd", ServerRoot
,
995 snprintf(printer_info
, sizeof(printer_name
), "PRINTER_INFO=%s",
996 job
->printer
->info
? job
->printer
->info
: "");
997 snprintf(printer_location
, sizeof(printer_name
), "PRINTER_LOCATION=%s",
998 job
->printer
->location
? job
->printer
->location
: "");
999 snprintf(printer_name
, sizeof(printer_name
), "PRINTER=%s", job
->printer
->name
);
1000 if (job
->printer
->num_reasons
> 0)
1002 char *psrptr
; /* Pointer into PRINTER_STATE_REASONS */
1003 size_t psrlen
; /* Size of PRINTER_STATE_REASONS */
1005 for (psrlen
= 22, i
= 0; i
< job
->printer
->num_reasons
; i
++)
1006 psrlen
+= strlen(job
->printer
->reasons
[i
]) + 1;
1008 if ((printer_state_reasons
= malloc(psrlen
)) != NULL
)
1011 * All of these strcpy's are safe because we allocated the psr string...
1014 strlcpy(printer_state_reasons
, "PRINTER_STATE_REASONS=", psrlen
);
1015 for (psrptr
= printer_state_reasons
+ 22, i
= 0;
1016 i
< job
->printer
->num_reasons
;
1021 strlcpy(psrptr
, job
->printer
->reasons
[i
],
1022 psrlen
- (psrptr
- printer_state_reasons
));
1023 psrptr
+= strlen(psrptr
);
1027 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
1029 if (job
->printer
->num_auth_info_required
== 1)
1030 snprintf(auth_info_required
, sizeof(auth_info_required
),
1031 "AUTH_INFO_REQUIRED=%s",
1032 job
->printer
->auth_info_required
[0]);
1033 else if (job
->printer
->num_auth_info_required
== 2)
1034 snprintf(auth_info_required
, sizeof(auth_info_required
),
1035 "AUTH_INFO_REQUIRED=%s,%s",
1036 job
->printer
->auth_info_required
[0],
1037 job
->printer
->auth_info_required
[1]);
1038 else if (job
->printer
->num_auth_info_required
== 3)
1039 snprintf(auth_info_required
, sizeof(auth_info_required
),
1040 "AUTH_INFO_REQUIRED=%s,%s,%s",
1041 job
->printer
->auth_info_required
[0],
1042 job
->printer
->auth_info_required
[1],
1043 job
->printer
->auth_info_required
[2]);
1044 else if (job
->printer
->num_auth_info_required
== 4)
1045 snprintf(auth_info_required
, sizeof(auth_info_required
),
1046 "AUTH_INFO_REQUIRED=%s,%s,%s,%s",
1047 job
->printer
->auth_info_required
[0],
1048 job
->printer
->auth_info_required
[1],
1049 job
->printer
->auth_info_required
[2],
1050 job
->printer
->auth_info_required
[3]);
1052 strlcpy(auth_info_required
, "AUTH_INFO_REQUIRED=none",
1053 sizeof(auth_info_required
));
1055 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
1057 envp
[envc
++] = charset
;
1058 envp
[envc
++] = lang
;
1060 envp
[envc
++] = apple_language
;
1061 #endif /* __APPLE__ */
1062 envp
[envc
++] = ppd
;
1063 envp
[envc
++] = rip_max_cache
;
1064 envp
[envc
++] = content_type
;
1065 envp
[envc
++] = device_uri
;
1066 envp
[envc
++] = printer_info
;
1067 envp
[envc
++] = printer_location
;
1068 envp
[envc
++] = printer_name
;
1069 envp
[envc
++] = printer_state_reasons
? printer_state_reasons
:
1070 "PRINTER_STATE_REASONS=none";
1071 envp
[envc
++] = banner_page
? "CUPS_FILETYPE=job-sheet" :
1072 "CUPS_FILETYPE=document";
1074 if (final_content_type
[0])
1075 envp
[envc
++] = final_content_type
;
1077 if (Classification
&& !banner_page
)
1079 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
1080 IPP_TAG_NAME
)) == NULL
)
1081 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1083 else if (attr
->num_values
> 1 &&
1084 strcmp(attr
->values
[1].string
.text
, "none") != 0)
1085 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1086 attr
->values
[1].string
.text
);
1088 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1089 attr
->values
[0].string
.text
);
1091 envp
[envc
++] = classification
;
1094 if (job
->dtype
& CUPS_PRINTER_CLASS
)
1096 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
1097 envp
[envc
++] = class_name
;
1100 envp
[envc
++] = auth_info_required
;
1103 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1105 if (job
->auth_env
[i
])
1106 envp
[envc
++] = job
->auth_env
[i
];
1111 envp
[envc
++] = job
->auth_uid
;
1115 for (i
= 0; i
< envc
; i
++)
1116 if (!strncmp(envp
[i
], "AUTH_", 5))
1117 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"AUTH_%c****\"", i
,
1119 else if (strncmp(envp
[i
], "DEVICE_URI=", 11))
1120 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"%s\"", i
, envp
[i
]);
1122 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"DEVICE_URI=%s\"", i
,
1123 job
->printer
->sanitized_device_uri
);
1125 if (job
->printer
->remote
)
1126 job
->current_file
= job
->num_files
;
1128 job
->current_file
++;
1131 * Now create processes for all of the filters...
1134 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
1136 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
1138 if (filter
->filter
[0] != '/')
1139 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
1142 strlcpy(command
, filter
->filter
, sizeof(command
));
1144 if (i
< (cupsArrayCount(filters
) - 1))
1146 if (cupsdOpenPipe(filterfds
[slot
]))
1148 abort_message
= "Stopping job because the scheduler could not create "
1149 "the filter pipes.";
1156 if (job
->current_file
== 1 ||
1157 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1159 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1161 if (cupsdOpenPipe(job
->print_pipes
))
1163 abort_message
= "Stopping job because the scheduler could not "
1164 "create the backend pipes.";
1171 job
->print_pipes
[0] = -1;
1172 if (!strcmp(job
->printer
->device_uri
, "file:/dev/null") ||
1173 !strcmp(job
->printer
->device_uri
, "file:///dev/null"))
1174 job
->print_pipes
[1] = -1;
1177 if (!strncmp(job
->printer
->device_uri
, "file:/dev/", 10))
1178 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1180 else if (!strncmp(job
->printer
->device_uri
, "file:///dev/", 12))
1181 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1183 else if (!strncmp(job
->printer
->device_uri
, "file:///", 8))
1184 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1185 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1187 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1188 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1190 if (job
->print_pipes
[1] < 0)
1192 abort_message
= "Stopping job because the scheduler could not "
1193 "open the output file.";
1198 fcntl(job
->print_pipes
[1], F_SETFD
,
1199 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
1204 filterfds
[slot
][0] = job
->print_pipes
[0];
1205 filterfds
[slot
][1] = job
->print_pipes
[1];
1208 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1209 filterfds
[slot
][1], job
->status_pipes
[1],
1210 job
->back_pipes
[0], job
->side_pipes
[0], 0,
1211 job
->profile
, job
, job
->filters
+ i
);
1213 cupsdClosePipe(filterfds
[!slot
]);
1217 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
1218 filter
->filter
, strerror(errno
));
1220 abort_message
= "Stopping job because the scheduler could not execute a "
1226 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started filter %s (PID %d)", command
,
1233 cupsArrayDelete(filters
);
1237 * Finally, pipe the final output into a backend process if needed...
1240 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1242 if (job
->current_file
== 1 || job
->printer
->remote
||
1243 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1245 sscanf(job
->printer
->device_uri
, "%254[^:]", scheme
);
1246 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, scheme
);
1249 * See if the backend needs to run as root...
1254 else if (stat(command
, &backinfo
))
1257 backroot
= !(backinfo
.st_mode
& (S_IRWXG
| S_IRWXO
));
1259 argv
[0] = job
->printer
->sanitized_device_uri
;
1261 filterfds
[slot
][0] = -1;
1262 filterfds
[slot
][1] = -1;
1264 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1265 filterfds
[slot
][1], job
->status_pipes
[1],
1266 job
->back_pipes
[1], job
->side_pipes
[1],
1267 backroot
, job
->profile
, job
, &(job
->backend
));
1271 abort_message
= "Stopping job because the sheduler could not execute "
1278 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started backend %s (PID %d)",
1283 if (job
->current_file
== job
->num_files
||
1284 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1285 cupsdClosePipe(job
->print_pipes
);
1287 if (job
->current_file
== job
->num_files
)
1289 cupsdClosePipe(job
->back_pipes
);
1290 cupsdClosePipe(job
->side_pipes
);
1292 close(job
->status_pipes
[1]);
1293 job
->status_pipes
[1] = -1;
1298 filterfds
[slot
][0] = -1;
1299 filterfds
[slot
][1] = -1;
1301 if (job
->current_file
== job
->num_files
||
1302 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1303 cupsdClosePipe(job
->print_pipes
);
1305 if (job
->current_file
== job
->num_files
)
1307 close(job
->status_pipes
[1]);
1308 job
->status_pipes
[1] = -1;
1312 cupsdClosePipe(filterfds
[slot
]);
1314 if (job
->printer
->remote
&& job
->num_files
> 1)
1316 for (i
= 0; i
< job
->num_files
; i
++)
1321 if (printer_state_reasons
)
1322 free(printer_state_reasons
);
1324 cupsdAddSelect(job
->status_buffer
->fd
, (cupsd_selfunc_t
)update_job
, NULL
,
1327 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
1334 * If we get here, we need to abort the current job and close out all
1335 * files and pipes...
1340 FilterLevel
-= job
->cost
;
1343 for (slot
= 0; slot
< 2; slot
++)
1344 cupsdClosePipe(filterfds
[slot
]);
1346 cupsArrayDelete(filters
);
1350 if (job
->printer
->remote
&& job
->num_files
> 1)
1352 for (i
= 0; i
< job
->num_files
; i
++)
1359 if (printer_state_reasons
)
1360 free(printer_state_reasons
);
1362 cupsdClosePipe(job
->print_pipes
);
1363 cupsdClosePipe(job
->back_pipes
);
1364 cupsdClosePipe(job
->side_pipes
);
1366 cupsdRemoveSelect(job
->status_pipes
[0]);
1367 cupsdClosePipe(job
->status_pipes
);
1368 cupsdStatBufDelete(job
->status_buffer
);
1369 job
->status_buffer
= NULL
;
1372 * Update the printer and job state.
1375 cupsdSetJobState(job
, abort_state
, CUPSD_JOB_DEFAULT
, "%s", abort_message
);
1376 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_IDLE
, 0);
1377 update_job_attrs(job
, 0);
1380 free_job_history(job
);
1382 cupsArrayRemove(PrintingJobs
, job
);
1385 * Clear the printer <-> job association...
1388 job
->printer
->job
= NULL
;
1389 job
->printer
= NULL
;
1394 * 'cupsdDeleteJob()' - Free all memory used by a job.
1398 cupsdDeleteJob(cupsd_job_t
*job
, /* I - Job */
1399 cupsd_jobaction_t action
)/* I - Action */
1401 int i
; /* Looping var */
1405 finalize_job(job
, 1);
1407 if (action
== CUPSD_JOB_PURGE
)
1408 remove_job_history(job
);
1410 cupsdClearString(&job
->username
);
1411 cupsdClearString(&job
->dest
);
1413 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1415 cupsdClearString(job
->auth_env
+ i
);
1416 cupsdClearString(&job
->auth_uid
);
1418 if (action
== CUPSD_JOB_PURGE
)
1419 remove_job_files(job
);
1420 else if (job
->num_files
> 0)
1422 free(job
->compressions
);
1423 free(job
->filetypes
);
1429 free_job_history(job
);
1433 cupsArrayRemove(Jobs
, job
);
1434 cupsArrayRemove(ActiveJobs
, job
);
1435 cupsArrayRemove(PrintingJobs
, job
);
1442 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1446 cupsdFreeAllJobs(void)
1448 cupsd_job_t
*job
; /* Current job */
1456 cupsdStopAllJobs(CUPSD_JOB_FORCE
, 0);
1459 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1461 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1462 cupsdDeleteJob(job
, CUPSD_JOB_DEFAULT
);
1464 cupsdReleaseSignals();
1469 * 'cupsdFindJob()' - Find the specified job.
1472 cupsd_job_t
* /* O - Job data */
1473 cupsdFindJob(int id
) /* I - Job ID */
1475 cupsd_job_t key
; /* Search key */
1480 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
1485 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1486 * or held jobs in a printer or class.
1489 int /* O - Job count */
1490 cupsdGetPrinterJobCount(
1491 const char *dest
) /* I - Printer or class name */
1493 int count
; /* Job count */
1494 cupsd_job_t
*job
; /* Current job */
1497 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1499 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1500 if (job
->dest
&& !_cups_strcasecmp(job
->dest
, dest
))
1508 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1509 * or held jobs for a user.
1512 int /* O - Job count */
1513 cupsdGetUserJobCount(
1514 const char *username
) /* I - Username */
1516 int count
; /* Job count */
1517 cupsd_job_t
*job
; /* Current job */
1520 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1522 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1523 if (!_cups_strcasecmp(job
->username
, username
))
1531 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1535 cupsdLoadAllJobs(void)
1537 char filename
[1024]; /* Full filename of job.cache file */
1538 struct stat fileinfo
, /* Information on job.cache file */
1539 dirinfo
; /* Information on RequestRoot dir */
1544 * Create the job arrays as needed...
1548 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1551 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1554 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1557 * See whether the job.cache file is older than the RequestRoot directory...
1560 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1562 if (stat(filename
, &fileinfo
))
1564 fileinfo
.st_mtime
= 0;
1566 if (errno
!= ENOENT
)
1567 cupsdLogMessage(CUPSD_LOG_ERROR
,
1568 "Unable to get file information for \"%s\" - %s",
1569 filename
, strerror(errno
));
1572 if (stat(RequestRoot
, &dirinfo
))
1574 dirinfo
.st_mtime
= 0;
1576 if (errno
!= ENOENT
)
1577 cupsdLogMessage(CUPSD_LOG_ERROR
,
1578 "Unable to get directory information for \"%s\" - %s",
1579 RequestRoot
, strerror(errno
));
1583 * Load the most recent source for job data...
1586 if (dirinfo
.st_mtime
> fileinfo
.st_mtime
)
1588 load_request_root();
1590 load_next_job_id(filename
);
1593 load_job_cache(filename
);
1596 * Clean out old jobs as needed...
1599 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1605 * 'cupsdLoadJob()' - Load a single job.
1608 int /* O - 1 on success, 0 on failure */
1609 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1611 int i
; /* Looping var */
1612 char jobfile
[1024]; /* Job filename */
1613 cups_file_t
*fp
; /* Job file */
1614 int fileid
; /* Current file ID */
1615 ipp_attribute_t
*attr
; /* Job attribute */
1616 const char *dest
; /* Destination name */
1617 cupsd_printer_t
*destptr
; /* Pointer to destination */
1618 mime_type_t
**filetypes
; /* New filetypes array */
1619 int *compressions
; /* New compressions array */
1624 if (job
->state_value
> IPP_JOB_STOPPED
)
1625 job
->access_time
= time(NULL
);
1630 if ((job
->attrs
= ippNew()) == NULL
)
1632 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes.");
1637 * Load job attributes...
1640 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading attributes...", job
->id
);
1642 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1643 if ((fp
= cupsdOpenConfFile(jobfile
)) == NULL
)
1646 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1648 cupsdLogMessage(CUPSD_LOG_ERROR
,
1649 "[Job %d] Unable to read job control file \"%s\".", job
->id
,
1658 * Copy attribute data to the job object...
1661 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1663 cupsdLogMessage(CUPSD_LOG_ERROR
,
1664 "[Job %d] Missing or bad time-at-creation attribute in "
1665 "control file.", job
->id
);
1669 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1670 IPP_TAG_ENUM
)) == NULL
)
1672 cupsdLogMessage(CUPSD_LOG_ERROR
,
1673 "[Job %d] Missing or bad job-state attribute in control "
1678 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1680 job
->history_time
= 0;
1682 if (job
->state_value
>= IPP_JOB_CANCELED
&&
1683 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
1684 IPP_TAG_INTEGER
)) != NULL
)
1686 if (JobHistory
< INT_MAX
)
1687 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
1689 job
->history_time
= INT_MAX
;
1691 if (job
->history_time
< time(NULL
))
1692 goto error
; /* Expired, remove from history */
1694 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1695 JobHistoryUpdate
= job
->history_time
;
1697 if (JobFiles
< INT_MAX
)
1698 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
1700 job
->file_time
= INT_MAX
;
1702 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1703 JobHistoryUpdate
= job
->file_time
;
1705 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdLoadJob: JobHistoryUpdate=%ld",
1706 (long)JobHistoryUpdate
);
1711 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1712 IPP_TAG_URI
)) == NULL
)
1714 cupsdLogMessage(CUPSD_LOG_ERROR
,
1715 "[Job %d] No job-printer-uri attribute in control file.",
1720 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1723 cupsdLogMessage(CUPSD_LOG_ERROR
,
1724 "[Job %d] Unable to queue job for destination \"%s\".",
1725 job
->id
, attr
->values
[0].string
.text
);
1729 cupsdSetString(&job
->dest
, dest
);
1731 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1733 cupsdLogMessage(CUPSD_LOG_ERROR
,
1734 "[Job %d] Unable to queue job for destination \"%s\".",
1735 job
->id
, job
->dest
);
1739 if ((job
->reasons
= ippFindAttribute(job
->attrs
, "job-state-reasons",
1740 IPP_TAG_KEYWORD
)) == NULL
)
1742 const char *reason
; /* job-state-reason keyword */
1744 cupsdLogMessage(CUPSD_LOG_DEBUG
,
1745 "[Job %d] Adding missing job-state-reasons attribute to "
1746 " control file.", job
->id
);
1748 switch (job
->state_value
)
1751 case IPP_JOB_PENDING
:
1752 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1753 reason
= "printer-stopped";
1759 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1760 IPP_TAG_ZERO
)) != NULL
&&
1761 (attr
->value_tag
== IPP_TAG_NAME
||
1762 attr
->value_tag
== IPP_TAG_NAMELANG
||
1763 attr
->value_tag
== IPP_TAG_KEYWORD
) &&
1764 strcmp(attr
->values
[0].string
.text
, "no-hold"))
1765 reason
= "job-hold-until-specified";
1767 reason
= "job-incoming";
1770 case IPP_JOB_PROCESSING
:
1771 reason
= "job-printing";
1774 case IPP_JOB_STOPPED
:
1775 reason
= "job-stopped";
1778 case IPP_JOB_CANCELED
:
1779 reason
= "job-canceled-by-user";
1782 case IPP_JOB_ABORTED
:
1783 reason
= "aborted-by-system";
1786 case IPP_JOB_COMPLETED
:
1787 reason
= "job-completed-successfully";
1791 job
->reasons
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
1792 "job-state-reasons", NULL
, reason
);
1794 else if (job
->state_value
== IPP_JOB_PENDING
)
1796 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1797 ippSetString(job
->attrs
, &job
->reasons
, 0, "printer-stopped");
1799 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
1802 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed",
1804 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1808 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1809 IPP_TAG_INTEGER
)) == NULL
)
1811 cupsdLogMessage(CUPSD_LOG_ERROR
,
1812 "[Job %d] Missing or bad job-priority attribute in "
1813 "control file.", job
->id
);
1817 job
->priority
= attr
->values
[0].integer
;
1822 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1823 IPP_TAG_NAME
)) == NULL
)
1825 cupsdLogMessage(CUPSD_LOG_ERROR
,
1826 "[Job %d] Missing or bad job-originating-user-name "
1827 "attribute in control file.", job
->id
);
1831 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1835 * Set the job hold-until time and state...
1838 if (job
->state_value
== IPP_JOB_HELD
)
1840 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1841 IPP_TAG_KEYWORD
)) == NULL
)
1842 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1845 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1848 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1849 job
->state_value
= IPP_JOB_PENDING
;
1852 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1854 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1855 job
->state_value
= IPP_JOB_PENDING
;
1858 if (!job
->num_files
)
1861 * Find all the d##### files...
1864 for (fileid
= 1; fileid
< 10000; fileid
++)
1866 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1869 if (access(jobfile
, 0))
1872 cupsdLogMessage(CUPSD_LOG_DEBUG
,
1873 "[Job %d] Auto-typing document file \"%s\"...", job
->id
,
1876 if (fileid
> job
->num_files
)
1878 if (job
->num_files
== 0)
1880 compressions
= (int *)calloc(fileid
, sizeof(int));
1881 filetypes
= (mime_type_t
**)calloc(fileid
, sizeof(mime_type_t
*));
1885 compressions
= (int *)realloc(job
->compressions
,
1886 sizeof(int) * fileid
);
1887 filetypes
= (mime_type_t
**)realloc(job
->filetypes
,
1888 sizeof(mime_type_t
*) *
1893 job
->compressions
= compressions
;
1896 job
->filetypes
= filetypes
;
1898 if (!compressions
|| !filetypes
)
1900 cupsdLogMessage(CUPSD_LOG_ERROR
,
1901 "[Job %d] Ran out of memory for job file types.",
1904 ippDelete(job
->attrs
);
1907 if (job
->compressions
)
1909 free(job
->compressions
);
1910 job
->compressions
= NULL
;
1915 free(job
->filetypes
);
1916 job
->filetypes
= NULL
;
1923 job
->num_files
= fileid
;
1926 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1927 job
->compressions
+ fileid
- 1);
1929 if (!job
->filetypes
[fileid
- 1])
1930 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1936 * Load authentication information as needed...
1939 if (job
->state_value
< IPP_JOB_STOPPED
)
1941 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1944 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1946 cupsdClearString(job
->auth_env
+ i
);
1947 cupsdClearString(&job
->auth_uid
);
1949 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
1951 int bytes
, /* Size of auth data */
1952 linenum
= 1; /* Current line number */
1953 char line
[65536], /* Line from file */
1954 *value
, /* Value from line */
1955 data
[65536]; /* Decoded data */
1958 if (cupsFileGets(fp
, line
, sizeof(line
)) &&
1959 !strcmp(line
, "CUPSD-AUTH-V3"))
1962 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
1968 if (strcmp(line
, "negotiate") && strcmp(line
, "uid"))
1970 bytes
= sizeof(data
);
1971 httpDecode64_2(data
, &bytes
, value
);
1975 * Assign environment variables...
1978 if (!strcmp(line
, "uid"))
1980 cupsdSetStringf(&job
->auth_uid
, "AUTH_UID=%s", value
);
1983 else if (i
>= (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0])))
1986 if (!strcmp(line
, "username"))
1987 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_USERNAME=%s", data
);
1988 else if (!strcmp(line
, "domain"))
1989 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_DOMAIN=%s", data
);
1990 else if (!strcmp(line
, "password"))
1991 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_PASSWORD=%s", data
);
1992 else if (!strcmp(line
, "negotiate"))
1993 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_NEGOTIATE=%s", value
);
2005 job
->access_time
= time(NULL
);
2009 * If we get here then something bad happened...
2014 ippDelete(job
->attrs
);
2017 remove_job_history(job
);
2018 remove_job_files(job
);
2025 * 'cupsdMoveJob()' - Move the specified job to a different destination.
2029 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
2030 cupsd_printer_t
*p
) /* I - Destination printer or class */
2032 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
2033 const char *olddest
; /* Old destination */
2034 cupsd_printer_t
*oldp
; /* Old pointer */
2038 * Don't move completed jobs...
2041 if (job
->state_value
> IPP_JOB_STOPPED
)
2045 * Get the old destination...
2048 olddest
= job
->dest
;
2051 oldp
= job
->printer
;
2053 oldp
= cupsdFindDest(olddest
);
2056 * Change the destination information...
2059 if (job
->state_value
> IPP_JOB_HELD
)
2060 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2061 "Stopping job prior to move.");
2063 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
2064 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2067 cupsdSetString(&job
->dest
, p
->name
);
2068 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
);
2070 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
2071 IPP_TAG_URI
)) != NULL
)
2072 cupsdSetString(&(attr
->values
[0].string
.text
), p
->uri
);
2074 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
2075 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2079 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2084 * 'cupsdReleaseJob()' - Release the specified job.
2088 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
2090 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
2093 if (job
->state_value
== IPP_JOB_HELD
)
2096 * Add trailing banner as needed...
2099 if (job
->pending_timeout
)
2100 cupsdTimeoutJob(job
);
2102 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2103 "Job released by user.");
2109 * 'cupsdRestartJob()' - Restart the specified job.
2113 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
2115 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
2118 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
2119 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2120 "Job restarted by user.");
2125 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2129 cupsdSaveAllJobs(void)
2131 int i
; /* Looping var */
2132 cups_file_t
*fp
; /* job.cache file */
2133 char filename
[1024], /* job.cache filename */
2134 temp
[1024]; /* Temporary string */
2135 cupsd_job_t
*job
; /* Current job */
2136 time_t curtime
; /* Current time */
2137 struct tm
*curdate
; /* Current date */
2140 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
2141 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
)) == NULL
)
2144 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job.cache...");
2147 * Write a small header to the file...
2150 curtime
= time(NULL
);
2151 curdate
= localtime(&curtime
);
2152 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
2154 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
2155 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
2156 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
2159 * Write each job known to the system...
2162 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2164 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2166 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
2167 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
2168 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
2169 cupsFilePrintf(fp
, "HoldUntil %d\n", (int)job
->hold_until
);
2170 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
2171 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
2172 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
2173 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
2174 for (i
= 0; i
< job
->num_files
; i
++)
2175 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
2176 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
2177 cupsFilePuts(fp
, "</Job>\n");
2180 cupsdCloseCreatedConfFile(fp
, filename
);
2185 * 'cupsdSaveJob()' - Save a job to disk.
2189 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
2191 char filename
[1024]; /* Job control filename */
2192 cups_file_t
*fp
; /* Job file */
2195 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2196 job
, job
->id
, job
->attrs
);
2198 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
2200 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
& 0600)) == NULL
)
2203 fchown(cupsFileNumber(fp
), RunUser
, Group
);
2205 job
->attrs
->state
= IPP_IDLE
;
2207 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
2208 job
->attrs
) != IPP_DATA
)
2210 cupsdLogMessage(CUPSD_LOG_ERROR
,
2211 "[Job %d] Unable to write job control file.", job
->id
);
2216 if (!cupsdCloseCreatedConfFile(fp
, filename
))
2219 * Remove backup file and mark this job as clean...
2222 strlcat(filename
, ".O", sizeof(filename
));
2231 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2235 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
2236 const char *when
, /* I - When to resume */
2237 int update
)/* I - Update job-hold-until attr? */
2239 time_t curtime
; /* Current time */
2240 struct tm
*curdate
; /* Current date */
2241 int hour
; /* Hold hour */
2242 int minute
; /* Hold minute */
2243 int second
= 0; /* Hold second */
2246 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2247 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2248 job
, job
->id
, when
, update
);
2253 * Update the job-hold-until attribute...
2256 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2258 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2259 IPP_TAG_KEYWORD
)) == NULL
)
2260 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2263 cupsdSetString(&(attr
->values
[0].string
.text
), when
);
2265 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2266 "job-hold-until", NULL
, when
);
2270 if (isdigit(when
[0] & 255))
2271 attr
->value_tag
= IPP_TAG_NAME
;
2273 attr
->value_tag
= IPP_TAG_KEYWORD
;
2276 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2279 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-hold-until-specified");
2283 * Update the hold time...
2286 job
->cancel_time
= 0;
2288 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2291 * Hold indefinitely...
2294 job
->hold_until
= 0;
2296 if (MaxHoldTime
> 0)
2297 job
->cancel_time
= time(NULL
) + MaxHoldTime
;
2299 else if (!strcmp(when
, "day-time"))
2302 * Hold to 6am the next morning unless local time is < 6pm.
2305 curtime
= time(NULL
);
2306 curdate
= localtime(&curtime
);
2308 if (curdate
->tm_hour
< 18)
2309 job
->hold_until
= curtime
;
2311 job
->hold_until
= curtime
+
2312 ((29 - curdate
->tm_hour
) * 60 + 59 -
2313 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2315 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2318 * Hold to 6pm unless local time is > 6pm or < 6am.
2321 curtime
= time(NULL
);
2322 curdate
= localtime(&curtime
);
2324 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2325 job
->hold_until
= curtime
;
2327 job
->hold_until
= curtime
+
2328 ((17 - curdate
->tm_hour
) * 60 + 59 -
2329 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2331 else if (!strcmp(when
, "second-shift"))
2334 * Hold to 4pm unless local time is > 4pm.
2337 curtime
= time(NULL
);
2338 curdate
= localtime(&curtime
);
2340 if (curdate
->tm_hour
>= 16)
2341 job
->hold_until
= curtime
;
2343 job
->hold_until
= curtime
+
2344 ((15 - curdate
->tm_hour
) * 60 + 59 -
2345 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2347 else if (!strcmp(when
, "third-shift"))
2350 * Hold to 12am unless local time is < 8am.
2353 curtime
= time(NULL
);
2354 curdate
= localtime(&curtime
);
2356 if (curdate
->tm_hour
< 8)
2357 job
->hold_until
= curtime
;
2359 job
->hold_until
= curtime
+
2360 ((23 - curdate
->tm_hour
) * 60 + 59 -
2361 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2363 else if (!strcmp(when
, "weekend"))
2366 * Hold to weekend unless we are in the weekend.
2369 curtime
= time(NULL
);
2370 curdate
= localtime(&curtime
);
2372 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2373 job
->hold_until
= curtime
;
2375 job
->hold_until
= curtime
+
2376 (((5 - curdate
->tm_wday
) * 24 +
2377 (17 - curdate
->tm_hour
)) * 60 + 59 -
2378 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2380 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2383 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2386 curtime
= time(NULL
);
2387 curdate
= gmtime(&curtime
);
2389 job
->hold_until
= curtime
+
2390 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2391 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2394 * Hold until next day as needed...
2397 if (job
->hold_until
< curtime
)
2398 job
->hold_until
+= 24 * 60 * 60;
2401 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2402 (int)job
->hold_until
);
2407 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2408 * the list as needed.
2412 cupsdSetJobPriority(
2413 cupsd_job_t
*job
, /* I - Job ID */
2414 int priority
) /* I - New priority (0 to 100) */
2416 ipp_attribute_t
*attr
; /* Job attribute */
2420 * Don't change completed jobs...
2423 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2427 * Set the new priority and re-add the job into the active list...
2430 cupsArrayRemove(ActiveJobs
, job
);
2432 job
->priority
= priority
;
2434 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2435 IPP_TAG_INTEGER
)) != NULL
)
2436 attr
->values
[0].integer
= priority
;
2438 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2441 cupsArrayAdd(ActiveJobs
, job
);
2444 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2449 * 'cupsdSetJobState()' - Set the state of the specified print job.
2454 cupsd_job_t
*job
, /* I - Job to cancel */
2455 ipp_jstate_t newstate
, /* I - New job state */
2456 cupsd_jobaction_t action
, /* I - Action to take */
2457 const char *message
, /* I - Message to log */
2458 ...) /* I - Additional arguments as needed */
2460 int i
; /* Looping var */
2461 ipp_jstate_t oldstate
; /* Old state */
2462 char filename
[1024]; /* Job filename */
2463 ipp_attribute_t
*attr
; /* Job attribute */
2466 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2467 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2468 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2469 newstate
, action
, message
? message
: "(null)");
2473 * Make sure we have the job attributes...
2476 if (!cupsdLoadJob(job
))
2480 * Don't do anything if the state is unchanged and we aren't purging the
2484 oldstate
= job
->state_value
;
2485 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2489 * Stop any processes that are working on the current job...
2492 if (oldstate
== IPP_JOB_PROCESSING
)
2493 stop_job(job
, action
);
2496 * Set the new job state...
2499 job
->state_value
= newstate
;
2502 job
->state
->values
[0].integer
= newstate
;
2506 case IPP_JOB_PENDING
:
2508 * Update job-hold-until as needed...
2511 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2512 IPP_TAG_KEYWORD
)) == NULL
)
2513 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2517 attr
->value_tag
= IPP_TAG_KEYWORD
;
2518 cupsdSetString(&(attr
->values
[0].string
.text
), "no-hold");
2524 case IPP_JOB_ABORTED
:
2525 case IPP_JOB_CANCELED
:
2526 case IPP_JOB_COMPLETED
:
2527 set_time(job
, "time-at-completed");
2528 ippSetString(job
->attrs
, &job
->reasons
, 0, "processing-to-stop-point");
2533 * Log message as needed...
2538 char buffer
[2048]; /* Message buffer */
2539 va_list ap
; /* Pointer to additional arguments */
2541 va_start(ap
, message
);
2542 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2545 if (newstate
> IPP_JOB_STOPPED
)
2546 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2548 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2550 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2551 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2553 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2557 * Handle post-state-change actions...
2562 case IPP_JOB_PROCESSING
:
2564 * Add the job to the "printing" list...
2567 if (!cupsArrayFind(PrintingJobs
, job
))
2568 cupsArrayAdd(PrintingJobs
, job
);
2571 * Set the processing time...
2574 set_time(job
, "time-at-processing");
2576 case IPP_JOB_PENDING
:
2578 case IPP_JOB_STOPPED
:
2580 * Make sure the job is in the active list...
2583 if (!cupsArrayFind(ActiveJobs
, job
))
2584 cupsArrayAdd(ActiveJobs
, job
);
2587 * Save the job state to disk...
2591 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2594 case IPP_JOB_ABORTED
:
2595 case IPP_JOB_CANCELED
:
2596 case IPP_JOB_COMPLETED
:
2597 if (newstate
== IPP_JOB_CANCELED
)
2600 * Remove the job from the active list if there are no processes still
2604 for (i
= 0; job
->filters
[i
] < 0; i
++);
2606 if (!job
->filters
[i
] && job
->backend
<= 0)
2607 cupsArrayRemove(ActiveJobs
, job
);
2612 * Otherwise just remove the job from the active list immediately...
2615 cupsArrayRemove(ActiveJobs
, job
);
2619 * Expire job subscriptions since the job is now "completed"...
2622 cupsdExpireSubscriptions(NULL
, job
);
2626 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2627 * sleep to happen immediately...
2630 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2632 #endif /* __APPLE__ */
2635 * Remove any authentication data...
2638 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2639 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2640 cupsdLogMessage(CUPSD_LOG_ERROR
,
2641 "Unable to remove authentication cache: %s",
2645 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
2647 cupsdClearString(job
->auth_env
+ i
);
2649 cupsdClearString(&job
->auth_uid
);
2652 * Remove the print file for good if we aren't preserving jobs or
2656 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2657 remove_job_files(job
);
2659 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2662 * Save job state info...
2666 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2668 else if (!job
->printer
)
2671 * Delete the job immediately if not actively printing...
2674 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2681 * Finalize the job immediately if we forced things...
2684 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2685 finalize_job(job
, 0);
2688 * Update the server "busy" state...
2691 cupsdSetBusyState();
2696 * 'cupsdStopAllJobs()' - Stop all print jobs.
2701 cupsd_jobaction_t action
, /* I - Action */
2702 int kill_delay
) /* I - Number of seconds before we kill */
2704 cupsd_job_t
*job
; /* Current job */
2707 DEBUG_puts("cupsdStopAllJobs()");
2709 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2711 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2714 job
->kill_time
= time(NULL
) + kill_delay
;
2716 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2722 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2726 cupsdUnloadCompletedJobs(void)
2728 cupsd_job_t
*job
; /* Current job */
2729 time_t expire
; /* Expiration time */
2732 expire
= time(NULL
) - 60;
2734 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2736 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2737 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2738 job
->access_time
< expire
)
2749 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2753 cupsdUpdateJobs(void)
2755 cupsd_job_t
*job
; /* Current job */
2756 time_t curtime
; /* Current time */
2757 ipp_attribute_t
*attr
; /* time-at-completed attribute */
2760 curtime
= time(NULL
);
2761 JobHistoryUpdate
= 0;
2763 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2765 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2767 if (job
->state_value
>= IPP_JOB_CANCELED
&&
2768 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
2769 IPP_TAG_INTEGER
)) != NULL
)
2772 * Update history/file expiration times...
2775 if (JobHistory
< INT_MAX
)
2776 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
2778 job
->history_time
= INT_MAX
;
2780 if (job
->history_time
< curtime
)
2782 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2786 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2787 JobHistoryUpdate
= job
->history_time
;
2789 if (JobFiles
< INT_MAX
)
2790 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
2792 job
->file_time
= INT_MAX
;
2794 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2795 JobHistoryUpdate
= job
->file_time
;
2799 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdUpdateAllJobs: JobHistoryUpdate=%ld",
2800 (long)JobHistoryUpdate
);
2805 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2808 static int /* O - Difference */
2809 compare_active_jobs(void *first
, /* I - First job */
2810 void *second
, /* I - Second job */
2811 void *data
) /* I - App data (not used) */
2813 int diff
; /* Difference */
2818 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2819 ((cupsd_job_t
*)first
)->priority
) != 0)
2822 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2827 * 'compare_jobs()' - Compare the job IDs of two jobs.
2830 static int /* O - Difference */
2831 compare_jobs(void *first
, /* I - First job */
2832 void *second
, /* I - Second job */
2833 void *data
) /* I - App data (not used) */
2837 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2842 * 'dump_job_history()' - Dump any debug messages for a job.
2846 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2848 int i
, /* Looping var */
2849 oldsize
; /* Current MaxLogSize */
2850 struct tm
*date
; /* Date/time value */
2851 cupsd_joblog_t
*message
; /* Current message */
2852 char temp
[2048], /* Log message */
2853 *ptr
, /* Pointer into log message */
2854 start
[256], /* Start time */
2855 end
[256]; /* End time */
2856 cupsd_printer_t
*printer
; /* Printer for job */
2860 * See if we have anything to dump...
2867 * Disable log rotation temporarily...
2870 oldsize
= MaxLogSize
;
2874 * Copy the debug messages to the log...
2877 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2878 date
= localtime(&(message
->time
));
2879 strftime(start
, sizeof(start
), "%X", date
);
2881 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2882 date
= localtime(&(message
->time
));
2883 strftime(end
, sizeof(end
), "%X", date
);
2885 snprintf(temp
, sizeof(temp
),
2886 "[Job %d] The following messages were recorded from %s to %s",
2887 job
->id
, start
, end
);
2888 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2890 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2892 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
2893 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
2895 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
2896 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2899 * Log the printer state values...
2902 if ((printer
= job
->printer
) == NULL
)
2903 printer
= cupsdFindDest(job
->dest
);
2907 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
2909 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
2910 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
2912 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2914 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
2915 job
->id
, printer
->state_message
);
2916 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2918 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
2919 ptr
= temp
+ strlen(temp
);
2920 if (printer
->num_reasons
== 0)
2921 strlcpy(ptr
, "none", sizeof(temp
) - (ptr
- temp
));
2925 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
2931 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (ptr
- temp
));
2935 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2939 * Restore log file rotation...
2942 MaxLogSize
= oldsize
;
2945 * Free all messages...
2948 free_job_history(job
);
2953 * 'free_job_history()' - Free any log history.
2957 free_job_history(cupsd_job_t
*job
) /* I - Job */
2959 char *message
; /* Current message */
2965 for (message
= (char *)cupsArrayFirst(job
->history
);
2967 message
= (char *)cupsArrayNext(job
->history
))
2970 cupsArrayDelete(job
->history
);
2971 job
->history
= NULL
;
2976 * 'finalize_job()' - Cleanup after job filter processes and support data.
2980 finalize_job(cupsd_job_t
*job
, /* I - Job */
2981 int set_job_state
) /* I - 1 = set the job state */
2983 ipp_pstate_t printer_state
; /* New printer state value */
2984 ipp_jstate_t job_state
; /* New job state value */
2985 const char *message
; /* Message for job state */
2986 char buffer
[1024]; /* Buffer for formatted messages */
2989 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
2992 * Clear the "connecting-to-device" reason, which is only valid when a printer
2993 * is processing, along with any remote printing job state...
2996 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device,"
2997 "cups-remote-pending,"
2998 "cups-remote-pending-held,"
2999 "cups-remote-processing,"
3000 "cups-remote-stopped,"
3001 "cups-remote-canceled,"
3002 "cups-remote-aborted,"
3003 "cups-remote-completed");
3006 * Similarly, clear the "offline-report" reason for non-USB devices since we
3007 * rarely have current information for network devices...
3010 if (strncmp(job
->printer
->device_uri
, "usb:", 4) &&
3011 strncmp(job
->printer
->device_uri
, "ippusb:", 7))
3012 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
3015 * Free the security profile...
3018 cupsdDestroyProfile(job
->profile
);
3019 job
->profile
= NULL
;
3022 * Clear the unresponsive job watchdog timers...
3025 job
->cancel_time
= 0;
3029 * Close pipes and status buffer...
3032 cupsdClosePipe(job
->print_pipes
);
3033 cupsdClosePipe(job
->back_pipes
);
3034 cupsdClosePipe(job
->side_pipes
);
3036 cupsdRemoveSelect(job
->status_pipes
[0]);
3037 cupsdClosePipe(job
->status_pipes
);
3038 cupsdStatBufDelete(job
->status_buffer
);
3039 job
->status_buffer
= NULL
;
3042 * Process the exit status...
3045 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
3046 printer_state
= IPP_PRINTER_IDLE
;
3048 printer_state
= job
->printer
->state
;
3050 switch (job_state
= job
->state_value
)
3052 case IPP_JOB_PENDING
:
3053 message
= "Job paused.";
3057 message
= "Job held.";
3061 case IPP_JOB_PROCESSING
:
3062 case IPP_JOB_COMPLETED
:
3063 job_state
= IPP_JOB_COMPLETED
;
3064 message
= "Job completed.";
3067 ippSetString(job
->attrs
, &job
->reasons
, 0,
3068 "job-completed-successfully");
3071 case IPP_JOB_STOPPED
:
3072 message
= "Job stopped.";
3074 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-stopped");
3077 case IPP_JOB_CANCELED
:
3078 message
= "Job canceled.";
3080 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-canceled-by-user");
3083 case IPP_JOB_ABORTED
:
3084 message
= "Job aborted.";
3088 if (job
->status
< 0)
3091 * Backend had errors...
3094 int exit_code
; /* Exit code from backend */
3097 * Convert the status to an exit code. Due to the way the W* macros are
3098 * implemented on MacOS X (bug?), we have to store the exit status in a
3099 * variable first and then convert...
3102 exit_code
= -job
->status
;
3103 if (WIFEXITED(exit_code
))
3104 exit_code
= WEXITSTATUS(exit_code
);
3107 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-backend-crashed");
3108 exit_code
= job
->status
;
3111 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
3113 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
3114 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
3115 "authentication required" :
3116 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
3117 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
3118 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
3119 exit_code
== CUPS_BACKEND_RETRY
? "retry job later" :
3120 exit_code
== CUPS_BACKEND_RETRY_CURRENT
? "retry job immediately" :
3121 exit_code
< 0 ? "crashed" : "unknown");
3124 * Do what needs to be done...
3130 case CUPS_BACKEND_FAILED
:
3132 * Backend failure, use the error-policy to determine how to
3136 if (job
->dtype
& CUPS_PRINTER_CLASS
)
3139 * Queued on a class - mark the job as pending and we'll retry on
3140 * another printer...
3143 if (job_state
== IPP_JOB_COMPLETED
)
3145 job_state
= IPP_JOB_PENDING
;
3146 message
= "Retrying job on another printer.";
3148 ippSetString(job
->attrs
, &job
->reasons
, 0,
3149 "resources-are-not-ready");
3152 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
3155 * The error policy is "retry-current-job" - mark the job as pending
3156 * and we'll retry on the same printer...
3159 if (job_state
== IPP_JOB_COMPLETED
)
3161 job_state
= IPP_JOB_PENDING
;
3162 message
= "Retrying job on same printer.";
3164 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3167 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
3168 !strcmp(job
->printer
->error_policy
, "retry-job"))
3170 if (job_state
== IPP_JOB_COMPLETED
)
3173 * The job was queued on a fax or the error policy is "retry-job" -
3174 * hold the job if the number of retries is less than the
3175 * JobRetryLimit, otherwise abort the job.
3180 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3186 snprintf(buffer
, sizeof(buffer
),
3187 "Job aborted after %d unsuccessful attempts.",
3189 job_state
= IPP_JOB_ABORTED
;
3192 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3197 * Try again in N seconds...
3200 snprintf(buffer
, sizeof(buffer
),
3201 "Job held for %d seconds since it could not be sent.",
3204 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3205 job_state
= IPP_JOB_HELD
;
3208 ippSetString(job
->attrs
, &job
->reasons
, 0,
3209 "resources-are-not-ready");
3213 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
3214 job_state
== IPP_JOB_COMPLETED
)
3216 job_state
= IPP_JOB_ABORTED
;
3217 message
= "Job aborted due to backend errors; please consult "
3218 "the error_log file for details.";
3220 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3222 else if (job
->state_value
== IPP_JOB_PROCESSING
)
3224 job_state
= IPP_JOB_PENDING
;
3225 printer_state
= IPP_PRINTER_STOPPED
;
3226 message
= "Printer stopped due to backend errors; please "
3227 "consult the error_log file for details.";
3229 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3233 case CUPS_BACKEND_CANCEL
:
3238 if (job_state
== IPP_JOB_COMPLETED
)
3240 job_state
= IPP_JOB_CANCELED
;
3241 message
= "Job canceled at printer.";
3243 ippSetString(job
->attrs
, &job
->reasons
, 0, "canceled-at-device");
3247 case CUPS_BACKEND_HOLD
:
3248 if (job_state
== IPP_JOB_COMPLETED
)
3254 const char *reason
= ippGetString(job
->reasons
, 0, NULL
);
3256 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-state-reasons=\"%s\"",
3259 if (!reason
|| strncmp(reason
, "account-", 8))
3261 cupsdSetJobHoldUntil(job
, "indefinite", 1);
3263 ippSetString(job
->attrs
, &job
->reasons
, 0,
3264 "job-hold-until-specified");
3265 message
= "Job held indefinitely due to backend errors; please "
3266 "consult the error_log file for details.";
3268 else if (!strcmp(reason
, "account-info-needed"))
3270 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3272 message
= "Job held indefinitely - account information is "
3275 else if (!strcmp(reason
, "account-closed"))
3277 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3279 message
= "Job held indefinitely - account has been closed.";
3281 else if (!strcmp(reason
, "account-limit-reached"))
3283 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3285 message
= "Job held indefinitely - account limit has been "
3290 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3292 message
= "Job held indefinitely - account authorization failed.";
3295 job_state
= IPP_JOB_HELD
;
3299 case CUPS_BACKEND_STOP
:
3301 * Stop the printer...
3304 printer_state
= IPP_PRINTER_STOPPED
;
3305 message
= "Printer stopped due to backend errors; please "
3306 "consult the error_log file for details.";
3308 if (job_state
== IPP_JOB_COMPLETED
)
3310 job_state
= IPP_JOB_PENDING
;
3312 ippSetString(job
->attrs
, &job
->reasons
, 0,
3313 "resources-are-not-ready");
3317 case CUPS_BACKEND_AUTH_REQUIRED
:
3319 * Hold the job for authentication...
3322 if (job_state
== IPP_JOB_COMPLETED
)
3324 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
3326 job_state
= IPP_JOB_HELD
;
3327 message
= "Job held for authentication.";
3329 if (strncmp(job
->reasons
->values
[0].string
.text
, "account-", 8))
3330 ippSetString(job
->attrs
, &job
->reasons
, 0,
3331 "cups-held-for-authentication");
3335 case CUPS_BACKEND_RETRY
:
3336 if (job_state
== IPP_JOB_COMPLETED
)
3339 * Hold the job if the number of retries is less than the
3340 * JobRetryLimit, otherwise abort the job.
3345 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3351 snprintf(buffer
, sizeof(buffer
),
3352 "Job aborted after %d unsuccessful attempts.",
3354 job_state
= IPP_JOB_ABORTED
;
3357 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3362 * Try again in N seconds...
3365 snprintf(buffer
, sizeof(buffer
),
3366 "Job held for %d seconds since it could not be sent.",
3369 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3370 job_state
= IPP_JOB_HELD
;
3373 ippSetString(job
->attrs
, &job
->reasons
, 0,
3374 "resources-are-not-ready");
3379 case CUPS_BACKEND_RETRY_CURRENT
:
3381 * Mark the job as pending and retry on the same printer...
3384 if (job_state
== IPP_JOB_COMPLETED
)
3386 job_state
= IPP_JOB_PENDING
;
3387 message
= "Retrying job on same printer.";
3389 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3394 else if (job
->status
> 0)
3397 * Filter had errors; stop job...
3400 if (job_state
== IPP_JOB_COMPLETED
)
3402 job_state
= IPP_JOB_STOPPED
;
3403 message
= "Job stopped due to filter errors; please consult the "
3404 "error_log file for details.";
3406 if (WIFSIGNALED(job
->status
))
3407 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-filter-crashed");
3409 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-completed-with-errors");
3414 * Update the printer and job state.
3417 if (set_job_state
&& job_state
!= job
->state_value
)
3418 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
3420 cupsdSetPrinterState(job
->printer
, printer_state
,
3421 printer_state
== IPP_PRINTER_STOPPED
);
3422 update_job_attrs(job
, 0);
3427 (job
->state_value
== IPP_JOB_ABORTED
||
3428 job
->state_value
== IPP_JOB_STOPPED
))
3429 dump_job_history(job
);
3431 free_job_history(job
);
3434 cupsArrayRemove(PrintingJobs
, job
);
3437 * Apply any PPD updates...
3440 if (job
->num_keywords
)
3442 if (cupsdUpdatePrinterPPD(job
->printer
, job
->num_keywords
, job
->keywords
))
3443 cupsdSetPrinterAttrs(job
->printer
);
3445 cupsFreeOptions(job
->num_keywords
, job
->keywords
);
3447 job
->num_keywords
= 0;
3448 job
->keywords
= NULL
;
3452 * Clear the printer <-> job association...
3455 job
->printer
->job
= NULL
;
3456 job
->printer
= NULL
;
3459 * Try printing another job...
3462 if (printer_state
!= IPP_PRINTER_STOPPED
)
3468 * 'get_options()' - Get a string containing the job options.
3471 static char * /* O - Options string */
3472 get_options(cupsd_job_t
*job
, /* I - Job */
3473 int banner_page
, /* I - Printing a banner page? */
3474 char *copies
, /* I - Copies buffer */
3475 size_t copies_size
, /* I - Size of copies buffer */
3476 char *title
, /* I - Title buffer */
3477 size_t title_size
) /* I - Size of title buffer */
3479 int i
; /* Looping var */
3480 size_t newlength
; /* New option buffer length */
3481 char *optptr
, /* Pointer to options */
3482 *valptr
; /* Pointer in value string */
3483 ipp_attribute_t
*attr
; /* Current attribute */
3484 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3485 int num_pwgppds
; /* Number of PWG->PPD options */
3486 cups_option_t
*pwgppds
, /* PWG->PPD options */
3487 *pwgppd
, /* Current PWG->PPD option */
3488 *preset
; /* Current preset option */
3489 int print_color_mode
,
3490 /* Output mode (if any) */
3491 print_quality
; /* Print quality (if any) */
3492 const char *ppd
; /* PPD option choice */
3493 int exact
; /* Did we get an exact match? */
3494 static char *options
= NULL
;/* Full list of options */
3495 static size_t optlength
= 0; /* Length of option buffer */
3499 * Building the options string is harder than it needs to be, but for the
3500 * moment we need to pass strings for command-line args and not IPP attribute
3503 * First build an options array for any PWG->PPD mapped option/choice pairs.
3506 pc
= job
->printer
->pc
;
3511 !ippFindAttribute(job
->attrs
,
3512 "com.apple.print.DocumentTicket.PMSpoolFormat",
3514 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3515 (ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) ||
3516 ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
)))
3519 * Map print-color-mode and print-quality to a preset...
3522 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3523 IPP_TAG_KEYWORD
)) != NULL
&&
3524 !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3525 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3527 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3529 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality",
3530 IPP_TAG_ENUM
)) != NULL
&&
3531 attr
->values
[0].integer
>= IPP_QUALITY_DRAFT
&&
3532 attr
->values
[0].integer
<= IPP_QUALITY_HIGH
)
3533 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3535 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3537 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3540 * Try to find a preset that works so that we maximize the chances of us
3541 * getting a good print using IPP attributes.
3544 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3545 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3546 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3547 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3550 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3551 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3555 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3558 * Copy the preset options as long as the corresponding names are not
3559 * already defined in the IPP request...
3562 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3563 preset
= pc
->presets
[print_color_mode
][print_quality
];
3567 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3568 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
,
3576 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3577 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3579 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3580 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3583 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3584 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3585 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3587 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3588 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3589 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3591 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3593 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3594 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3597 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3598 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3599 IPP_TAG_ZERO
)) != NULL
&&
3600 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3601 attr
->value_tag
== IPP_TAG_NAME
) &&
3602 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3605 * Map output-bin to OutputBin option...
3608 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3611 if (pc
->sides_option
&&
3612 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3613 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3616 * Map sides to duplex option...
3619 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3620 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
,
3621 num_pwgppds
, &pwgppds
);
3622 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3623 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
,
3624 num_pwgppds
, &pwgppds
);
3625 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3626 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
,
3627 num_pwgppds
, &pwgppds
);
3631 * Map finishings values...
3634 num_pwgppds
= _ppdCacheGetFinishingOptions(pc
, job
->attrs
,
3635 IPP_FINISHINGS_NONE
, num_pwgppds
,
3640 * Figure out how much room we need...
3643 newlength
= ipp_length(job
->attrs
);
3645 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3646 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3649 * Then allocate/reallocate the option buffer as needed...
3652 if (newlength
== 0) /* This can never happen, but Clang */
3653 newlength
= 1; /* thinks it can... */
3655 if (newlength
> optlength
|| !options
)
3658 optptr
= malloc(newlength
);
3660 optptr
= realloc(options
, newlength
);
3664 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3665 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer.",
3666 CUPS_LLCAST newlength
);
3671 optlength
= newlength
;
3675 * Now loop through the attributes and convert them to the textual
3676 * representation used by the filters...
3682 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3683 strlcpy(copies
, "1", copies_size
);
3685 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3687 if (!strcmp(attr
->name
, "copies") &&
3688 attr
->value_tag
== IPP_TAG_INTEGER
)
3691 * Don't use the # copies attribute if we are printing the job sheets...
3695 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3697 else if (!strcmp(attr
->name
, "job-name") &&
3698 (attr
->value_tag
== IPP_TAG_NAME
||
3699 attr
->value_tag
== IPP_TAG_NAMELANG
))
3700 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3701 else if (attr
->group_tag
== IPP_TAG_JOB
)
3704 * Filter out other unwanted attributes...
3707 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3708 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3709 attr
->value_tag
== IPP_TAG_NAMELANG
||
3710 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3711 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid") &&
3712 strcmp(attr
->name
, "job-authorization-uri")) ||
3713 attr
->value_tag
== IPP_TAG_URISCHEME
||
3714 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3717 if (!strcmp(attr
->name
, "job-hold-until") ||
3718 !strcmp(attr
->name
, "job-id") ||
3719 !strcmp(attr
->name
, "job-k-octets") ||
3720 !strcmp(attr
->name
, "job-media-sheets") ||
3721 !strcmp(attr
->name
, "job-media-sheets-completed") ||
3722 !strcmp(attr
->name
, "job-state") ||
3723 !strcmp(attr
->name
, "job-state-reasons"))
3726 if (!strncmp(attr
->name
, "job-", 4) &&
3727 strcmp(attr
->name
, "job-account-id") &&
3728 strcmp(attr
->name
, "job-accounting-user-id") &&
3729 strcmp(attr
->name
, "job-authorization-uri") &&
3730 strcmp(attr
->name
, "job-billing") &&
3731 strcmp(attr
->name
, "job-impressions") &&
3732 strcmp(attr
->name
, "job-originating-host-name") &&
3733 strcmp(attr
->name
, "job-password") &&
3734 strcmp(attr
->name
, "job-password-encryption") &&
3735 strcmp(attr
->name
, "job-uuid") &&
3736 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3739 if ((!strcmp(attr
->name
, "job-impressions") ||
3740 !strcmp(attr
->name
, "page-label") ||
3741 !strcmp(attr
->name
, "page-border") ||
3742 !strncmp(attr
->name
, "number-up", 9) ||
3743 !strcmp(attr
->name
, "page-ranges") ||
3744 !strcmp(attr
->name
, "page-set") ||
3745 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3746 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3747 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3748 "PMTotalSidesImaged..n.") ||
3749 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3750 "PMTotalBeginPages..n.")) &&
3755 * Otherwise add them to the list...
3758 if (optptr
> options
)
3759 strlcat(optptr
, " ", optlength
- (optptr
- options
));
3761 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3763 strlcat(optptr
, attr
->name
, optlength
- (optptr
- options
));
3764 strlcat(optptr
, "=", optlength
- (optptr
- options
));
3767 for (i
= 0; i
< attr
->num_values
; i
++)
3770 strlcat(optptr
, ",", optlength
- (optptr
- options
));
3772 optptr
+= strlen(optptr
);
3774 switch (attr
->value_tag
)
3776 case IPP_TAG_INTEGER
:
3778 snprintf(optptr
, optlength
- (optptr
- options
),
3779 "%d", attr
->values
[i
].integer
);
3782 case IPP_TAG_BOOLEAN
:
3783 if (!attr
->values
[i
].boolean
)
3784 strlcat(optptr
, "no", optlength
- (optptr
- options
));
3786 strlcat(optptr
, attr
->name
,
3787 optlength
- (optptr
- options
));
3790 case IPP_TAG_RANGE
:
3791 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3792 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3793 "%d", attr
->values
[i
].range
.lower
);
3795 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3796 "%d-%d", attr
->values
[i
].range
.lower
,
3797 attr
->values
[i
].range
.upper
);
3800 case IPP_TAG_RESOLUTION
:
3801 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3802 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
3803 attr
->values
[i
].resolution
.yres
,
3804 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
3808 case IPP_TAG_STRING
:
3811 case IPP_TAG_KEYWORD
:
3812 case IPP_TAG_CHARSET
:
3813 case IPP_TAG_LANGUAGE
:
3815 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
3817 if (strchr(" \t\n\\\'\"", *valptr
))
3819 *optptr
++ = *valptr
++;
3826 break; /* anti-compiler-warning-code */
3830 optptr
+= strlen(optptr
);
3835 * Finally loop through the PWG->PPD mapped options and add them...
3838 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3841 strlcpy(optptr
, pwgppd
->name
, optlength
- (optptr
- options
));
3842 optptr
+= strlen(optptr
);
3844 strlcpy(optptr
, pwgppd
->value
, optlength
- (optptr
- options
));
3845 optptr
+= strlen(optptr
);
3848 cupsFreeOptions(num_pwgppds
, pwgppds
);
3851 * Return the options string...
3859 * 'ipp_length()' - Compute the size of the buffer needed to hold
3860 * the textual IPP attributes.
3863 static size_t /* O - Size of attribute buffer */
3864 ipp_length(ipp_t
*ipp
) /* I - IPP request */
3866 size_t bytes
; /* Number of bytes */
3867 int i
; /* Looping var */
3868 ipp_attribute_t
*attr
; /* Current attribute */
3872 * Loop through all attributes...
3877 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3880 * Skip attributes that won't be sent to filters...
3883 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3884 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3885 attr
->value_tag
== IPP_TAG_NAMELANG
||
3886 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3887 attr
->value_tag
== IPP_TAG_URI
||
3888 attr
->value_tag
== IPP_TAG_URISCHEME
)
3892 * Add space for a leading space and commas between each value.
3893 * For the first attribute, the leading space isn't used, so the
3894 * extra byte can be used as the nul terminator...
3897 bytes
++; /* " " separator */
3898 bytes
+= attr
->num_values
; /* "," separators */
3901 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3902 * other attributes appear as "foo=value1,value2,...,valueN".
3905 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3906 bytes
+= strlen(attr
->name
);
3908 bytes
+= attr
->num_values
* strlen(attr
->name
);
3911 * Now add the size required for each value in the attribute...
3914 switch (attr
->value_tag
)
3916 case IPP_TAG_INTEGER
:
3919 * Minimum value of a signed integer is -2147483647, or 11 digits.
3922 bytes
+= attr
->num_values
* 11;
3925 case IPP_TAG_BOOLEAN
:
3927 * Add two bytes for each false ("no") value...
3930 for (i
= 0; i
< attr
->num_values
; i
++)
3931 if (!attr
->values
[i
].boolean
)
3935 case IPP_TAG_RANGE
:
3937 * A range is two signed integers separated by a hyphen, or
3938 * 23 characters max.
3941 bytes
+= attr
->num_values
* 23;
3944 case IPP_TAG_RESOLUTION
:
3946 * A resolution is two signed integers separated by an "x" and
3947 * suffixed by the units, or 26 characters max.
3950 bytes
+= attr
->num_values
* 26;
3953 case IPP_TAG_STRING
:
3956 case IPP_TAG_KEYWORD
:
3957 case IPP_TAG_CHARSET
:
3958 case IPP_TAG_LANGUAGE
:
3961 * Strings can contain characters that need quoting. We need
3962 * at least 2 * len + 2 characters to cover the quotes and
3963 * any backslashes in the string.
3966 for (i
= 0; i
< attr
->num_values
; i
++)
3967 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
3971 break; /* anti-compiler-warning-code */
3980 * 'load_job_cache()' - Load jobs from the job.cache file.
3984 load_job_cache(const char *filename
) /* I - job.cache filename */
3986 cups_file_t
*fp
; /* job.cache file */
3987 char line
[1024], /* Line buffer */
3988 *value
; /* Value on line */
3989 int linenum
; /* Line number in file */
3990 cupsd_job_t
*job
; /* Current job */
3991 int jobid
; /* Job ID */
3992 char jobfile
[1024]; /* Job filename */
3996 * Open the job.cache file...
3999 if ((fp
= cupsdOpenConfFile(filename
)) == NULL
)
4001 load_request_root();
4006 * Read entries from the job cache file and create jobs as needed.
4009 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
4015 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4017 if (!_cups_strcasecmp(line
, "NextJobId"))
4020 NextJobId
= atoi(value
);
4022 else if (!_cups_strcasecmp(line
, "<Job"))
4026 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d.",
4033 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d.", linenum
);
4037 jobid
= atoi(value
);
4041 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d.", jobid
,
4046 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
4047 if (access(jobfile
, 0))
4049 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d.N", RequestRoot
, jobid
);
4050 if (access(jobfile
, 0))
4052 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away.",
4058 job
= calloc(1, sizeof(cupsd_job_t
));
4061 cupsdLogMessage(CUPSD_LOG_EMERG
,
4062 "[Job %d] Unable to allocate memory for job.", jobid
);
4067 job
->back_pipes
[0] = -1;
4068 job
->back_pipes
[1] = -1;
4069 job
->print_pipes
[0] = -1;
4070 job
->print_pipes
[1] = -1;
4071 job
->side_pipes
[0] = -1;
4072 job
->side_pipes
[1] = -1;
4073 job
->status_pipes
[0] = -1;
4074 job
->status_pipes
[1] = -1;
4076 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading from cache...",
4081 cupsdLogMessage(CUPSD_LOG_ERROR
,
4082 "Missing <Job #> directive on line %d.", linenum
);
4085 else if (!_cups_strcasecmp(line
, "</Job>"))
4087 cupsArrayAdd(Jobs
, job
);
4089 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
4090 cupsArrayAdd(ActiveJobs
, job
);
4096 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d.", linenum
);
4099 else if (!_cups_strcasecmp(line
, "State"))
4101 job
->state_value
= (ipp_jstate_t
)atoi(value
);
4103 if (job
->state_value
< IPP_JOB_PENDING
)
4104 job
->state_value
= IPP_JOB_PENDING
;
4105 else if (job
->state_value
> IPP_JOB_COMPLETED
)
4106 job
->state_value
= IPP_JOB_COMPLETED
;
4108 else if (!_cups_strcasecmp(line
, "HoldUntil"))
4110 job
->hold_until
= atoi(value
);
4112 else if (!_cups_strcasecmp(line
, "Priority"))
4114 job
->priority
= atoi(value
);
4116 else if (!_cups_strcasecmp(line
, "Username"))
4118 cupsdSetString(&job
->username
, value
);
4120 else if (!_cups_strcasecmp(line
, "Destination"))
4122 cupsdSetString(&job
->dest
, value
);
4124 else if (!_cups_strcasecmp(line
, "DestType"))
4126 job
->dtype
= (cups_ptype_t
)atoi(value
);
4128 else if (!_cups_strcasecmp(line
, "NumFiles"))
4130 job
->num_files
= atoi(value
);
4132 if (job
->num_files
< 0)
4134 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d.",
4135 job
->num_files
, linenum
);
4140 if (job
->num_files
> 0)
4142 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
4144 if (access(jobfile
, 0))
4146 cupsdLogMessage(CUPSD_LOG_INFO
, "[Job %d] Data files have gone away.",
4152 job
->filetypes
= calloc(job
->num_files
, sizeof(mime_type_t
*));
4153 job
->compressions
= calloc(job
->num_files
, sizeof(int));
4155 if (!job
->filetypes
|| !job
->compressions
)
4157 cupsdLogMessage(CUPSD_LOG_EMERG
,
4158 "[Job %d] Unable to allocate memory for %d files.",
4159 job
->id
, job
->num_files
);
4164 else if (!_cups_strcasecmp(line
, "File"))
4166 int number
, /* File number */
4167 compression
; /* Compression value */
4168 char super
[MIME_MAX_SUPER
], /* MIME super type */
4169 type
[MIME_MAX_TYPE
]; /* MIME type */
4172 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
4175 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d.", linenum
);
4179 if (number
< 1 || number
> job
->num_files
)
4181 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d.",
4188 job
->compressions
[number
] = compression
;
4189 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
4191 if (!job
->filetypes
[number
])
4194 * If the original MIME type is unknown, auto-type it!
4197 cupsdLogMessage(CUPSD_LOG_ERROR
,
4198 "[Job %d] Unknown MIME type %s/%s for file %d.",
4199 job
->id
, super
, type
, number
+ 1);
4201 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
4202 job
->id
, number
+ 1);
4203 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
4204 job
->compressions
+ number
);
4207 * If that didn't work, assume it is raw...
4210 if (!job
->filetypes
[number
])
4211 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
4216 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d.",
4222 cupsdLogMessage(CUPSD_LOG_ERROR
,
4223 "Missing </Job> directive on line %d.", linenum
);
4224 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
4232 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4236 load_next_job_id(const char *filename
) /* I - job.cache filename */
4238 cups_file_t
*fp
; /* job.cache file */
4239 char line
[1024], /* Line buffer */
4240 *value
; /* Value on line */
4241 int linenum
; /* Line number in file */
4242 int next_job_id
; /* NextJobId value from line */
4246 * Read the NextJobId directive from the job.cache file and use
4247 * the value (if any).
4250 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4252 if (errno
!= ENOENT
)
4253 cupsdLogMessage(CUPSD_LOG_ERROR
,
4254 "Unable to open job cache file \"%s\": %s",
4255 filename
, strerror(errno
));
4260 cupsdLogMessage(CUPSD_LOG_INFO
,
4261 "Loading NextJobId from job cache file \"%s\"...", filename
);
4265 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4267 if (!_cups_strcasecmp(line
, "NextJobId"))
4271 next_job_id
= atoi(value
);
4273 if (next_job_id
> NextJobId
)
4274 NextJobId
= next_job_id
;
4285 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4289 load_request_root(void)
4291 cups_dir_t
*dir
; /* Directory */
4292 cups_dentry_t
*dent
; /* Directory entry */
4293 cupsd_job_t
*job
; /* New job */
4297 * Open the requests directory...
4300 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
4302 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
4304 cupsdLogMessage(CUPSD_LOG_ERROR
,
4305 "Unable to open spool directory \"%s\": %s",
4306 RequestRoot
, strerror(errno
));
4311 * Read all the c##### files...
4314 while ((dent
= cupsDirRead(dir
)) != NULL
)
4315 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
4318 * Allocate memory for the job...
4321 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
4323 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs.");
4329 * Assign the job ID...
4332 job
->id
= atoi(dent
->filename
+ 1);
4333 job
->back_pipes
[0] = -1;
4334 job
->back_pipes
[1] = -1;
4335 job
->print_pipes
[0] = -1;
4336 job
->print_pipes
[1] = -1;
4337 job
->side_pipes
[0] = -1;
4338 job
->side_pipes
[1] = -1;
4339 job
->status_pipes
[0] = -1;
4340 job
->status_pipes
[1] = -1;
4342 if (job
->id
>= NextJobId
)
4343 NextJobId
= job
->id
+ 1;
4349 if (cupsdLoadJob(job
))
4352 * Insert the job into the array, sorting by job priority and ID...
4355 cupsArrayAdd(Jobs
, job
);
4357 if (job
->state_value
<= IPP_JOB_STOPPED
)
4358 cupsArrayAdd(ActiveJobs
, job
);
4371 * 'remove_job_files()' - Remove the document files for a job.
4375 remove_job_files(cupsd_job_t
*job
) /* I - Job */
4377 int i
; /* Looping var */
4378 char filename
[1024]; /* Document filename */
4381 if (job
->num_files
<= 0)
4384 for (i
= 1; i
<= job
->num_files
; i
++)
4386 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
4388 cupsdUnlinkOrRemoveFile(filename
);
4391 free(job
->filetypes
);
4392 free(job
->compressions
);
4396 job
->filetypes
= NULL
;
4397 job
->compressions
= NULL
;
4399 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4404 * 'remove_job_history()' - Remove the control file for a job.
4408 remove_job_history(cupsd_job_t
*job
) /* I - Job */
4410 char filename
[1024]; /* Control filename */
4414 * Remove the job info file...
4417 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
4419 cupsdUnlinkOrRemoveFile(filename
);
4421 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4426 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4430 set_time(cupsd_job_t
*job
, /* I - Job to update */
4431 const char *name
) /* I - Name of attribute */
4433 ipp_attribute_t
*attr
; /* Time attribute */
4434 time_t curtime
; /* Current time */
4437 curtime
= time(NULL
);
4439 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s=%ld", name
, (long)curtime
);
4441 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
4443 attr
->value_tag
= IPP_TAG_INTEGER
;
4444 attr
->values
[0].integer
= curtime
;
4447 if (!strcmp(name
, "time-at-completed"))
4449 if (JobHistory
< INT_MAX
&& attr
)
4450 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
4452 job
->history_time
= INT_MAX
;
4454 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4455 JobHistoryUpdate
= job
->history_time
;
4457 if (JobFiles
< INT_MAX
&& attr
)
4458 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
4460 job
->file_time
= INT_MAX
;
4462 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4463 JobHistoryUpdate
= job
->file_time
;
4465 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "set_time: JobHistoryUpdate=%ld",
4466 (long)JobHistoryUpdate
);
4472 * 'start_job()' - Start a print job.
4476 start_job(cupsd_job_t
*job
, /* I - Job ID */
4477 cupsd_printer_t
*printer
) /* I - Printer to print job */
4479 const char *filename
; /* Support filename */
4482 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
4483 job
, job
->id
, printer
, printer
->name
);
4486 * Make sure we have some files around before we try to print...
4489 if (job
->num_files
== 0)
4491 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
4492 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
4493 "Aborting job because it has no files.");
4498 * Update the printer and job state to "processing"...
4501 if (!cupsdLoadJob(job
))
4504 if (!job
->printer_message
)
4505 job
->printer_message
= ippFindAttribute(job
->attrs
,
4506 "job-printer-state-message",
4508 if (job
->printer_message
)
4509 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
4511 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-printing");
4512 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
4513 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
4514 cupsdSetPrinterReasons(printer
, "-cups-remote-pending,"
4515 "cups-remote-pending-held,"
4516 "cups-remote-processing,"
4517 "cups-remote-stopped,"
4518 "cups-remote-canceled,"
4519 "cups-remote-aborted,"
4520 "cups-remote-completed");
4523 job
->current_file
= 0;
4525 job
->history_time
= 0;
4527 job
->printer
= printer
;
4531 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4533 job
->cancel_time
= 0;
4536 * Check for support files...
4539 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
4540 "cups-insecure-filter-warning");
4544 for (filename
= (const char *)cupsArrayFirst(printer
->pc
->support_files
);
4546 filename
= (const char *)cupsArrayNext(printer
->pc
->support_files
))
4548 if (_cupsFileCheck(filename
, _CUPS_FILE_CHECK_FILE
, !RunUser
,
4549 cupsdLogFCMessage
, printer
))
4555 * Setup the last exit status and security profiles...
4559 job
->profile
= cupsdCreateProfile(job
->id
);
4562 * Create the status pipes and buffer...
4565 if (cupsdOpenPipe(job
->status_pipes
))
4567 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4568 "Unable to create job status pipes - %s.", strerror(errno
));
4570 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4571 "Job stopped because the scheduler could not create the "
4572 "job status pipes.");
4574 cupsdDestroyProfile(job
->profile
);
4575 job
->profile
= NULL
;
4579 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
4580 job
->status_level
= CUPSD_LOG_INFO
;
4583 * Create the backchannel pipes and make them non-blocking...
4586 if (cupsdOpenPipe(job
->back_pipes
))
4588 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4589 "Unable to create back-channel pipes - %s.", strerror(errno
));
4591 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4592 "Job stopped because the scheduler could not create the "
4593 "back-channel pipes.");
4595 cupsdClosePipe(job
->status_pipes
);
4596 cupsdStatBufDelete(job
->status_buffer
);
4597 job
->status_buffer
= NULL
;
4599 cupsdDestroyProfile(job
->profile
);
4600 job
->profile
= NULL
;
4604 fcntl(job
->back_pipes
[0], F_SETFL
,
4605 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4606 fcntl(job
->back_pipes
[1], F_SETFL
,
4607 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4610 * Create the side-channel pipes and make them non-blocking...
4613 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4615 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4616 "Unable to create side-channel pipes - %s.", strerror(errno
));
4618 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4619 "Job stopped because the scheduler could not create the "
4620 "side-channel pipes.");
4622 cupsdClosePipe(job
->back_pipes
);
4624 cupsdClosePipe(job
->status_pipes
);
4625 cupsdStatBufDelete(job
->status_buffer
);
4626 job
->status_buffer
= NULL
;
4628 cupsdDestroyProfile(job
->profile
);
4629 job
->profile
= NULL
;
4633 fcntl(job
->side_pipes
[0], F_SETFL
,
4634 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4635 fcntl(job
->side_pipes
[1], F_SETFL
,
4636 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4638 fcntl(job
->side_pipes
[0], F_SETFD
,
4639 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4640 fcntl(job
->side_pipes
[1], F_SETFD
,
4641 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4644 * Now start the first file in the job...
4647 cupsdContinueJob(job
);
4652 * 'stop_job()' - Stop a print job.
4656 stop_job(cupsd_job_t
*job
, /* I - Job */
4657 cupsd_jobaction_t action
) /* I - Action */
4659 int i
; /* Looping var */
4662 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4665 FilterLevel
-= job
->cost
;
4668 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
)
4669 job
->kill_time
= time(NULL
) + JobKillDelay
;
4670 else if (action
>= CUPSD_JOB_FORCE
)
4673 for (i
= 0; job
->filters
[i
]; i
++)
4674 if (job
->filters
[i
] > 0)
4676 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
4678 if (action
>= CUPSD_JOB_FORCE
)
4679 job
->filters
[i
] = -job
->filters
[i
];
4682 if (job
->backend
> 0)
4684 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
4686 if (action
>= CUPSD_JOB_FORCE
)
4687 job
->backend
= -job
->backend
;
4690 if (action
>= CUPSD_JOB_FORCE
)
4693 * Clear job status...
4702 * 'unload_job()' - Unload a job from memory.
4706 unload_job(cupsd_job_t
*job
) /* I - Job */
4711 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Unloading...", job
->id
);
4713 ippDelete(job
->attrs
);
4717 job
->reasons
= NULL
;
4719 job
->job_sheets
= NULL
;
4720 job
->printer_message
= NULL
;
4721 job
->printer_reasons
= NULL
;
4726 * 'update_job()' - Read a status update from a job's filters.
4730 update_job(cupsd_job_t
*job
) /* I - Job to check */
4732 int i
; /* Looping var */
4733 int copies
; /* Number of copies printed */
4734 char message
[CUPSD_SB_BUFFER_SIZE
],
4736 *ptr
; /* Pointer update... */
4737 int loglevel
, /* Log level for message */
4738 event
= 0; /* Events? */
4739 static const char * const levels
[] = /* Log levels */
4755 * Get the printer associated with this job; if the printer is stopped for
4756 * any reason then job->printer will be reset to NULL, so make sure we have
4757 * a valid pointer...
4760 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
4761 message
, sizeof(message
))) != NULL
)
4764 * Process page and printer state messages as needed...
4767 if (loglevel
== CUPSD_LOG_PAGE
)
4770 * Page message; send the message to the page_log file and update the
4771 * job sheet count...
4774 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
4778 if (!_cups_strncasecmp(message
, "total ", 6))
4781 * Got a total count of pages from a backend or filter...
4784 copies
= atoi(message
+ 6);
4785 copies
-= job
->sheets
->values
[0].integer
; /* Just track the delta */
4787 else if (!sscanf(message
, "%*d%d", &copies
))
4790 job
->sheets
->values
[0].integer
+= copies
;
4792 if (job
->printer
->page_limit
)
4793 cupsdUpdateQuota(job
->printer
, job
->username
, copies
, 0);
4796 cupsdLogPage(job
, message
);
4799 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4800 "Printed %d page(s).", job
->sheets
->values
[0].integer
);
4802 else if (loglevel
== CUPSD_LOG_JOBSTATE
)
4805 * Support "keyword" to set job-state-reasons to the specified keyword.
4806 * This is sufficient for the current paid printing stuff.
4809 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "JOBSTATE: %s", message
);
4811 ippSetString(job
->attrs
, &job
->reasons
, 0, message
);
4813 else if (loglevel
== CUPSD_LOG_STATE
)
4815 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
4817 if (!strcmp(message
, "paused"))
4819 cupsdStopPrinter(job
->printer
, 1);
4822 else if (message
[0] && cupsdSetPrinterReasons(job
->printer
, message
))
4824 event
|= CUPSD_EVENT_PRINTER_STATE
;
4826 if (MaxJobTime
> 0 && strstr(message
, "connecting-to-device") != NULL
)
4829 * Reset cancel time after connecting to the device...
4832 for (i
= 0; i
< job
->printer
->num_reasons
; i
++)
4833 if (!strcmp(job
->printer
->reasons
[i
], "connecting-to-device"))
4836 if (i
>= job
->printer
->num_reasons
)
4837 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4841 update_job_attrs(job
, 0);
4843 else if (loglevel
== CUPSD_LOG_ATTR
)
4846 * Set attribute(s)...
4849 int num_attrs
; /* Number of attributes */
4850 cups_option_t
*attrs
; /* Attributes */
4851 const char *attr
; /* Attribute */
4853 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
4855 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
4857 if ((attr
= cupsGetOption("auth-info-default", num_attrs
,
4860 job
->printer
->num_options
= cupsAddOption("auth-info", attr
,
4861 job
->printer
->num_options
,
4862 &(job
->printer
->options
));
4863 cupsdSetPrinterAttrs(job
->printer
);
4865 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4868 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
4871 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
4872 cupsdSetPrinterAttrs(job
->printer
);
4874 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4877 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
4880 int progress
= atoi(attr
);
4883 if (progress
>= 0 && progress
<= 100)
4885 job
->progress
= progress
;
4888 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4889 "Printing page %d, %d%%",
4890 job
->sheets
->values
[0].integer
, job
->progress
);
4894 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
4896 cupsdSetString(&job
->printer
->alert
, attr
);
4897 event
|= CUPSD_EVENT_PRINTER_STATE
;
4900 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
4903 cupsdSetString(&job
->printer
->alert_description
, attr
);
4904 event
|= CUPSD_EVENT_PRINTER_STATE
;
4907 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
4909 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
4910 job
->printer
->marker_time
= time(NULL
);
4911 event
|= CUPSD_EVENT_PRINTER_STATE
;
4912 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4915 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
4917 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
4918 job
->printer
->marker_time
= time(NULL
);
4919 event
|= CUPSD_EVENT_PRINTER_STATE
;
4920 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4923 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
4925 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
4926 job
->printer
->marker_time
= time(NULL
);
4927 event
|= CUPSD_EVENT_PRINTER_STATE
;
4928 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4931 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
4933 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
4934 job
->printer
->marker_time
= time(NULL
);
4935 event
|= CUPSD_EVENT_PRINTER_STATE
;
4936 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4939 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
4941 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
4942 job
->printer
->marker_time
= time(NULL
);
4943 event
|= CUPSD_EVENT_PRINTER_STATE
;
4944 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4947 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
4949 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
4950 job
->printer
->marker_time
= time(NULL
);
4951 event
|= CUPSD_EVENT_PRINTER_STATE
;
4952 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4955 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
4957 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
4958 job
->printer
->marker_time
= time(NULL
);
4959 event
|= CUPSD_EVENT_PRINTER_STATE
;
4960 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4963 cupsFreeOptions(num_attrs
, attrs
);
4965 else if (loglevel
== CUPSD_LOG_PPD
)
4968 * Set attribute(s)...
4971 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
4973 job
->num_keywords
= cupsParseOptions(message
, job
->num_keywords
,
4979 * Strip legacy message prefix...
4982 if (!strncmp(message
, "recoverable:", 12))
4985 while (isspace(*ptr
& 255))
4988 else if (!strncmp(message
, "recovered:", 10))
4991 while (isspace(*ptr
& 255))
4998 cupsdLogJob(job
, loglevel
, "%s", ptr
);
5000 if (loglevel
< CUPSD_LOG_DEBUG
&&
5001 strcmp(job
->printer
->state_message
, ptr
))
5003 strlcpy(job
->printer
->state_message
, ptr
,
5004 sizeof(job
->printer
->state_message
));
5006 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
5008 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
5011 * Some messages show in the job-printer-state-message attribute...
5014 if (loglevel
!= CUPSD_LOG_NOTICE
)
5015 job
->status_level
= loglevel
;
5017 update_job_attrs(job
, 1);
5019 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
5020 "Set job-printer-state-message to \"%s\", "
5022 job
->printer_message
->values
[0].string
.text
,
5023 levels
[job
->status_level
]);
5028 if (!strchr(job
->status_buffer
->buffer
, '\n'))
5032 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
5033 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5034 "%s", job
->printer
->state_message
);
5035 if (event
& CUPSD_EVENT_PRINTER_STATE
)
5036 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
5037 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
5038 "Class \"%s\" state changed." :
5039 "Printer \"%s\" state changed.",
5040 job
->printer
->name
);
5043 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
5046 * See if all of the filters and the backend have returned their
5050 for (i
= 0; job
->filters
[i
] < 0; i
++);
5052 if (job
->filters
[i
])
5055 * EOF but we haven't collected the exit status of all filters...
5058 cupsdCheckProcess();
5062 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
5065 * EOF but we haven't collected the exit status of the backend...
5068 cupsdCheckProcess();
5073 * Handle the end of job stuff...
5076 finalize_job(job
, 1);
5079 * Check for new jobs...
5088 * 'update_job_attrs()' - Update the job-printer-* attributes.
5092 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
5093 int do_message
)/* I - 1 = copy job-printer-state message */
5095 int i
; /* Looping var */
5096 int num_reasons
; /* Actual number of reasons */
5097 const char * const *reasons
; /* Reasons */
5098 static const char *none
= "none"; /* "none" reason */
5102 * Get/create the job-printer-state-* attributes...
5105 if (!job
->printer_message
)
5107 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
5108 "job-printer-state-message",
5109 IPP_TAG_TEXT
)) == NULL
)
5110 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
5111 "job-printer-state-message",
5115 if (!job
->printer_reasons
)
5116 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
5117 "job-printer-state-reasons",
5121 * Copy or clear the printer-state-message value as needed...
5124 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
5125 job
->status_level
== CUPSD_LOG_INFO
)
5127 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
5130 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5132 else if (job
->printer
->state_message
[0] && do_message
)
5134 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
),
5135 job
->printer
->state_message
);
5138 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5142 * ... and the printer-state-reasons value...
5145 if (job
->printer
->num_reasons
== 0)
5152 num_reasons
= job
->printer
->num_reasons
;
5153 reasons
= (const char * const *)job
->printer
->reasons
;
5156 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
5159 * Replace/create a job-printer-state-reasons attribute...
5162 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
5164 job
->printer_reasons
= ippAddStrings(job
->attrs
,
5165 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
5166 "job-printer-state-reasons",
5167 num_reasons
, NULL
, NULL
);
5172 * Don't bother clearing the reason strings if they are the same...
5175 for (i
= 0; i
< num_reasons
; i
++)
5176 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
5179 if (i
>= num_reasons
)
5183 * Not the same, so free the current strings...
5186 for (i
= 0; i
< num_reasons
; i
++)
5187 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
5191 * Copy the reasons...
5194 for (i
= 0; i
< num_reasons
; i
++)
5195 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
5198 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);