2 * "$Id: job.c 7902 2008-09-03 14:20:17Z mike $"
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-V2"))
1962 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
1968 bytes
= sizeof(data
);
1969 httpDecode64_2(data
, &bytes
, value
);
1972 * Assign environment variables...
1975 if (!strcmp(line
, "uid"))
1977 cupsdSetStringf(&job
->auth_uid
, "AUTH_UID=%s", value
);
1980 else if (i
>= (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0])))
1983 if (!strcmp(line
, "username"))
1984 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_USERNAME=%s", data
);
1985 else if (!strcmp(line
, "domain"))
1986 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_DOMAIN=%s", data
);
1987 else if (!strcmp(line
, "password"))
1988 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_PASSWORD=%s", data
);
1989 else if (!strcmp(line
, "negotiate"))
1990 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_NEGOTIATE=%s", data
);
2002 job
->access_time
= time(NULL
);
2006 * If we get here then something bad happened...
2011 ippDelete(job
->attrs
);
2014 remove_job_history(job
);
2015 remove_job_files(job
);
2022 * 'cupsdMoveJob()' - Move the specified job to a different destination.
2026 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
2027 cupsd_printer_t
*p
) /* I - Destination printer or class */
2029 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
2030 const char *olddest
; /* Old destination */
2031 cupsd_printer_t
*oldp
; /* Old pointer */
2035 * Don't move completed jobs...
2038 if (job
->state_value
> IPP_JOB_STOPPED
)
2042 * Get the old destination...
2045 olddest
= job
->dest
;
2048 oldp
= job
->printer
;
2050 oldp
= cupsdFindDest(olddest
);
2053 * Change the destination information...
2056 if (job
->state_value
> IPP_JOB_HELD
)
2057 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2058 "Stopping job prior to move.");
2060 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
2061 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2064 cupsdSetString(&job
->dest
, p
->name
);
2065 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
);
2067 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
2068 IPP_TAG_URI
)) != NULL
)
2069 cupsdSetString(&(attr
->values
[0].string
.text
), p
->uri
);
2071 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
2072 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2076 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2081 * 'cupsdReleaseJob()' - Release the specified job.
2085 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
2087 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
2090 if (job
->state_value
== IPP_JOB_HELD
)
2093 * Add trailing banner as needed...
2096 if (job
->pending_timeout
)
2097 cupsdTimeoutJob(job
);
2099 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2100 "Job released by user.");
2106 * 'cupsdRestartJob()' - Restart the specified job.
2110 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
2112 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
2115 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
2116 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2117 "Job restarted by user.");
2122 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2126 cupsdSaveAllJobs(void)
2128 int i
; /* Looping var */
2129 cups_file_t
*fp
; /* job.cache file */
2130 char filename
[1024], /* job.cache filename */
2131 temp
[1024]; /* Temporary string */
2132 cupsd_job_t
*job
; /* Current job */
2133 time_t curtime
; /* Current time */
2134 struct tm
*curdate
; /* Current date */
2137 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
2138 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
)) == NULL
)
2141 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job.cache...");
2144 * Write a small header to the file...
2147 curtime
= time(NULL
);
2148 curdate
= localtime(&curtime
);
2149 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
2151 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
2152 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
2153 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
2156 * Write each job known to the system...
2159 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2161 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2163 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
2164 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
2165 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
2166 cupsFilePrintf(fp
, "HoldUntil %d\n", (int)job
->hold_until
);
2167 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
2168 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
2169 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
2170 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
2171 for (i
= 0; i
< job
->num_files
; i
++)
2172 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
2173 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
2174 cupsFilePuts(fp
, "</Job>\n");
2177 cupsdCloseCreatedConfFile(fp
, filename
);
2182 * 'cupsdSaveJob()' - Save a job to disk.
2186 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
2188 char filename
[1024]; /* Job control filename */
2189 cups_file_t
*fp
; /* Job file */
2192 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2193 job
, job
->id
, job
->attrs
);
2195 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
2197 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
& 0600)) == NULL
)
2200 fchown(cupsFileNumber(fp
), RunUser
, Group
);
2202 job
->attrs
->state
= IPP_IDLE
;
2204 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
2205 job
->attrs
) != IPP_DATA
)
2207 cupsdLogMessage(CUPSD_LOG_ERROR
,
2208 "[Job %d] Unable to write job control file.", job
->id
);
2213 if (!cupsdCloseCreatedConfFile(fp
, filename
))
2216 * Remove backup file and mark this job as clean...
2219 strlcat(filename
, ".O", sizeof(filename
));
2228 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2232 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
2233 const char *when
, /* I - When to resume */
2234 int update
)/* I - Update job-hold-until attr? */
2236 time_t curtime
; /* Current time */
2237 struct tm
*curdate
; /* Current date */
2238 int hour
; /* Hold hour */
2239 int minute
; /* Hold minute */
2240 int second
= 0; /* Hold second */
2243 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2244 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2245 job
, job
->id
, when
, update
);
2250 * Update the job-hold-until attribute...
2253 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2255 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2256 IPP_TAG_KEYWORD
)) == NULL
)
2257 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2260 cupsdSetString(&(attr
->values
[0].string
.text
), when
);
2262 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2263 "job-hold-until", NULL
, when
);
2267 if (isdigit(when
[0] & 255))
2268 attr
->value_tag
= IPP_TAG_NAME
;
2270 attr
->value_tag
= IPP_TAG_KEYWORD
;
2273 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2276 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-hold-until-specified");
2280 * Update the hold time...
2283 job
->cancel_time
= 0;
2285 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2288 * Hold indefinitely...
2291 job
->hold_until
= 0;
2293 if (MaxHoldTime
> 0)
2294 job
->cancel_time
= time(NULL
) + MaxHoldTime
;
2296 else if (!strcmp(when
, "day-time"))
2299 * Hold to 6am the next morning unless local time is < 6pm.
2302 curtime
= time(NULL
);
2303 curdate
= localtime(&curtime
);
2305 if (curdate
->tm_hour
< 18)
2306 job
->hold_until
= curtime
;
2308 job
->hold_until
= curtime
+
2309 ((29 - curdate
->tm_hour
) * 60 + 59 -
2310 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2312 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2315 * Hold to 6pm unless local time is > 6pm or < 6am.
2318 curtime
= time(NULL
);
2319 curdate
= localtime(&curtime
);
2321 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2322 job
->hold_until
= curtime
;
2324 job
->hold_until
= curtime
+
2325 ((17 - curdate
->tm_hour
) * 60 + 59 -
2326 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2328 else if (!strcmp(when
, "second-shift"))
2331 * Hold to 4pm unless local time is > 4pm.
2334 curtime
= time(NULL
);
2335 curdate
= localtime(&curtime
);
2337 if (curdate
->tm_hour
>= 16)
2338 job
->hold_until
= curtime
;
2340 job
->hold_until
= curtime
+
2341 ((15 - curdate
->tm_hour
) * 60 + 59 -
2342 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2344 else if (!strcmp(when
, "third-shift"))
2347 * Hold to 12am unless local time is < 8am.
2350 curtime
= time(NULL
);
2351 curdate
= localtime(&curtime
);
2353 if (curdate
->tm_hour
< 8)
2354 job
->hold_until
= curtime
;
2356 job
->hold_until
= curtime
+
2357 ((23 - curdate
->tm_hour
) * 60 + 59 -
2358 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2360 else if (!strcmp(when
, "weekend"))
2363 * Hold to weekend unless we are in the weekend.
2366 curtime
= time(NULL
);
2367 curdate
= localtime(&curtime
);
2369 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2370 job
->hold_until
= curtime
;
2372 job
->hold_until
= curtime
+
2373 (((5 - curdate
->tm_wday
) * 24 +
2374 (17 - curdate
->tm_hour
)) * 60 + 59 -
2375 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2377 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2380 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2383 curtime
= time(NULL
);
2384 curdate
= gmtime(&curtime
);
2386 job
->hold_until
= curtime
+
2387 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2388 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2391 * Hold until next day as needed...
2394 if (job
->hold_until
< curtime
)
2395 job
->hold_until
+= 24 * 60 * 60;
2398 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2399 (int)job
->hold_until
);
2404 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2405 * the list as needed.
2409 cupsdSetJobPriority(
2410 cupsd_job_t
*job
, /* I - Job ID */
2411 int priority
) /* I - New priority (0 to 100) */
2413 ipp_attribute_t
*attr
; /* Job attribute */
2417 * Don't change completed jobs...
2420 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2424 * Set the new priority and re-add the job into the active list...
2427 cupsArrayRemove(ActiveJobs
, job
);
2429 job
->priority
= priority
;
2431 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2432 IPP_TAG_INTEGER
)) != NULL
)
2433 attr
->values
[0].integer
= priority
;
2435 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2438 cupsArrayAdd(ActiveJobs
, job
);
2441 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2446 * 'cupsdSetJobState()' - Set the state of the specified print job.
2451 cupsd_job_t
*job
, /* I - Job to cancel */
2452 ipp_jstate_t newstate
, /* I - New job state */
2453 cupsd_jobaction_t action
, /* I - Action to take */
2454 const char *message
, /* I - Message to log */
2455 ...) /* I - Additional arguments as needed */
2457 int i
; /* Looping var */
2458 ipp_jstate_t oldstate
; /* Old state */
2459 char filename
[1024]; /* Job filename */
2460 ipp_attribute_t
*attr
; /* Job attribute */
2463 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2464 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2465 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2466 newstate
, action
, message
? message
: "(null)");
2470 * Make sure we have the job attributes...
2473 if (!cupsdLoadJob(job
))
2477 * Don't do anything if the state is unchanged and we aren't purging the
2481 oldstate
= job
->state_value
;
2482 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2486 * Stop any processes that are working on the current job...
2489 if (oldstate
== IPP_JOB_PROCESSING
)
2490 stop_job(job
, action
);
2493 * Set the new job state...
2496 job
->state_value
= newstate
;
2499 job
->state
->values
[0].integer
= newstate
;
2503 case IPP_JOB_PENDING
:
2505 * Update job-hold-until as needed...
2508 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2509 IPP_TAG_KEYWORD
)) == NULL
)
2510 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2514 attr
->value_tag
= IPP_TAG_KEYWORD
;
2515 cupsdSetString(&(attr
->values
[0].string
.text
), "no-hold");
2521 case IPP_JOB_ABORTED
:
2522 case IPP_JOB_CANCELED
:
2523 case IPP_JOB_COMPLETED
:
2524 set_time(job
, "time-at-completed");
2525 ippSetString(job
->attrs
, &job
->reasons
, 0, "processing-to-stop-point");
2530 * Log message as needed...
2535 char buffer
[2048]; /* Message buffer */
2536 va_list ap
; /* Pointer to additional arguments */
2538 va_start(ap
, message
);
2539 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2542 if (newstate
> IPP_JOB_STOPPED
)
2543 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2545 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2547 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2548 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2550 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2554 * Handle post-state-change actions...
2559 case IPP_JOB_PROCESSING
:
2561 * Add the job to the "printing" list...
2564 if (!cupsArrayFind(PrintingJobs
, job
))
2565 cupsArrayAdd(PrintingJobs
, job
);
2568 * Set the processing time...
2571 set_time(job
, "time-at-processing");
2573 case IPP_JOB_PENDING
:
2575 case IPP_JOB_STOPPED
:
2577 * Make sure the job is in the active list...
2580 if (!cupsArrayFind(ActiveJobs
, job
))
2581 cupsArrayAdd(ActiveJobs
, job
);
2584 * Save the job state to disk...
2588 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2591 case IPP_JOB_ABORTED
:
2592 case IPP_JOB_CANCELED
:
2593 case IPP_JOB_COMPLETED
:
2594 if (newstate
== IPP_JOB_CANCELED
)
2597 * Remove the job from the active list if there are no processes still
2601 for (i
= 0; job
->filters
[i
] < 0; i
++);
2603 if (!job
->filters
[i
] && job
->backend
<= 0)
2604 cupsArrayRemove(ActiveJobs
, job
);
2609 * Otherwise just remove the job from the active list immediately...
2612 cupsArrayRemove(ActiveJobs
, job
);
2616 * Expire job subscriptions since the job is now "completed"...
2619 cupsdExpireSubscriptions(NULL
, job
);
2623 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2624 * sleep to happen immediately...
2627 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2629 #endif /* __APPLE__ */
2632 * Remove any authentication data...
2635 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2636 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2637 cupsdLogMessage(CUPSD_LOG_ERROR
,
2638 "Unable to remove authentication cache: %s",
2642 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
2644 cupsdClearString(job
->auth_env
+ i
);
2646 cupsdClearString(&job
->auth_uid
);
2649 * Remove the print file for good if we aren't preserving jobs or
2653 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2654 remove_job_files(job
);
2656 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2659 * Save job state info...
2663 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2665 else if (!job
->printer
)
2668 * Delete the job immediately if not actively printing...
2671 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2678 * Finalize the job immediately if we forced things...
2681 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2682 finalize_job(job
, 0);
2685 * Update the server "busy" state...
2688 cupsdSetBusyState();
2693 * 'cupsdStopAllJobs()' - Stop all print jobs.
2698 cupsd_jobaction_t action
, /* I - Action */
2699 int kill_delay
) /* I - Number of seconds before we kill */
2701 cupsd_job_t
*job
; /* Current job */
2704 DEBUG_puts("cupsdStopAllJobs()");
2706 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2708 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2711 job
->kill_time
= time(NULL
) + kill_delay
;
2713 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2719 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2723 cupsdUnloadCompletedJobs(void)
2725 cupsd_job_t
*job
; /* Current job */
2726 time_t expire
; /* Expiration time */
2729 expire
= time(NULL
) - 60;
2731 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2733 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2734 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2735 job
->access_time
< expire
)
2746 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2750 cupsdUpdateJobs(void)
2752 cupsd_job_t
*job
; /* Current job */
2753 time_t curtime
; /* Current time */
2754 ipp_attribute_t
*attr
; /* time-at-completed attribute */
2757 curtime
= time(NULL
);
2758 JobHistoryUpdate
= 0;
2760 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2762 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2764 if (job
->state_value
>= IPP_JOB_CANCELED
&&
2765 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
2766 IPP_TAG_INTEGER
)) != NULL
)
2769 * Update history/file expiration times...
2772 if (JobHistory
< INT_MAX
)
2773 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
2775 job
->history_time
= INT_MAX
;
2777 if (job
->history_time
< curtime
)
2779 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2783 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2784 JobHistoryUpdate
= job
->history_time
;
2786 if (JobFiles
< INT_MAX
)
2787 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
2789 job
->file_time
= INT_MAX
;
2791 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2792 JobHistoryUpdate
= job
->file_time
;
2796 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdUpdateAllJobs: JobHistoryUpdate=%ld",
2797 (long)JobHistoryUpdate
);
2802 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2805 static int /* O - Difference */
2806 compare_active_jobs(void *first
, /* I - First job */
2807 void *second
, /* I - Second job */
2808 void *data
) /* I - App data (not used) */
2810 int diff
; /* Difference */
2815 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2816 ((cupsd_job_t
*)first
)->priority
) != 0)
2819 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2824 * 'compare_jobs()' - Compare the job IDs of two jobs.
2827 static int /* O - Difference */
2828 compare_jobs(void *first
, /* I - First job */
2829 void *second
, /* I - Second job */
2830 void *data
) /* I - App data (not used) */
2834 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2839 * 'dump_job_history()' - Dump any debug messages for a job.
2843 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2845 int i
, /* Looping var */
2846 oldsize
; /* Current MaxLogSize */
2847 struct tm
*date
; /* Date/time value */
2848 cupsd_joblog_t
*message
; /* Current message */
2849 char temp
[2048], /* Log message */
2850 *ptr
, /* Pointer into log message */
2851 start
[256], /* Start time */
2852 end
[256]; /* End time */
2853 cupsd_printer_t
*printer
; /* Printer for job */
2857 * See if we have anything to dump...
2864 * Disable log rotation temporarily...
2867 oldsize
= MaxLogSize
;
2871 * Copy the debug messages to the log...
2874 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2875 date
= localtime(&(message
->time
));
2876 strftime(start
, sizeof(start
), "%X", date
);
2878 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2879 date
= localtime(&(message
->time
));
2880 strftime(end
, sizeof(end
), "%X", date
);
2882 snprintf(temp
, sizeof(temp
),
2883 "[Job %d] The following messages were recorded from %s to %s",
2884 job
->id
, start
, end
);
2885 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2887 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2889 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
2890 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
2892 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
2893 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2896 * Log the printer state values...
2899 if ((printer
= job
->printer
) == NULL
)
2900 printer
= cupsdFindDest(job
->dest
);
2904 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
2906 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
2907 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
2909 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2911 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
2912 job
->id
, printer
->state_message
);
2913 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2915 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
2916 ptr
= temp
+ strlen(temp
);
2917 if (printer
->num_reasons
== 0)
2918 strlcpy(ptr
, "none", sizeof(temp
) - (ptr
- temp
));
2922 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
2928 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (ptr
- temp
));
2932 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2936 * Restore log file rotation...
2939 MaxLogSize
= oldsize
;
2942 * Free all messages...
2945 free_job_history(job
);
2950 * 'free_job_history()' - Free any log history.
2954 free_job_history(cupsd_job_t
*job
) /* I - Job */
2956 char *message
; /* Current message */
2962 for (message
= (char *)cupsArrayFirst(job
->history
);
2964 message
= (char *)cupsArrayNext(job
->history
))
2967 cupsArrayDelete(job
->history
);
2968 job
->history
= NULL
;
2973 * 'finalize_job()' - Cleanup after job filter processes and support data.
2977 finalize_job(cupsd_job_t
*job
, /* I - Job */
2978 int set_job_state
) /* I - 1 = set the job state */
2980 ipp_pstate_t printer_state
; /* New printer state value */
2981 ipp_jstate_t job_state
; /* New job state value */
2982 const char *message
; /* Message for job state */
2983 char buffer
[1024]; /* Buffer for formatted messages */
2986 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
2989 * Clear the "connecting-to-device" reason, which is only valid when a printer
2990 * is processing, along with any remote printing job state...
2993 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device,"
2994 "cups-remote-pending,"
2995 "cups-remote-pending-held,"
2996 "cups-remote-processing,"
2997 "cups-remote-stopped,"
2998 "cups-remote-canceled,"
2999 "cups-remote-aborted,"
3000 "cups-remote-completed");
3003 * Similarly, clear the "offline-report" reason for non-USB devices since we
3004 * rarely have current information for network devices...
3007 if (strncmp(job
->printer
->device_uri
, "usb:", 4) &&
3008 strncmp(job
->printer
->device_uri
, "ippusb:", 7))
3009 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
3012 * Free the security profile...
3015 cupsdDestroyProfile(job
->profile
);
3016 job
->profile
= NULL
;
3019 * Clear the unresponsive job watchdog timers...
3022 job
->cancel_time
= 0;
3026 * Close pipes and status buffer...
3029 cupsdClosePipe(job
->print_pipes
);
3030 cupsdClosePipe(job
->back_pipes
);
3031 cupsdClosePipe(job
->side_pipes
);
3033 cupsdRemoveSelect(job
->status_pipes
[0]);
3034 cupsdClosePipe(job
->status_pipes
);
3035 cupsdStatBufDelete(job
->status_buffer
);
3036 job
->status_buffer
= NULL
;
3039 * Process the exit status...
3042 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
3043 printer_state
= IPP_PRINTER_IDLE
;
3045 printer_state
= job
->printer
->state
;
3047 switch (job_state
= job
->state_value
)
3049 case IPP_JOB_PENDING
:
3050 message
= "Job paused.";
3054 message
= "Job held.";
3058 case IPP_JOB_PROCESSING
:
3059 case IPP_JOB_COMPLETED
:
3060 job_state
= IPP_JOB_COMPLETED
;
3061 message
= "Job completed.";
3064 ippSetString(job
->attrs
, &job
->reasons
, 0,
3065 "job-completed-successfully");
3068 case IPP_JOB_STOPPED
:
3069 message
= "Job stopped.";
3071 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-stopped");
3074 case IPP_JOB_CANCELED
:
3075 message
= "Job canceled.";
3077 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-canceled-by-user");
3080 case IPP_JOB_ABORTED
:
3081 message
= "Job aborted.";
3085 if (job
->status
< 0)
3088 * Backend had errors...
3091 int exit_code
; /* Exit code from backend */
3094 * Convert the status to an exit code. Due to the way the W* macros are
3095 * implemented on MacOS X (bug?), we have to store the exit status in a
3096 * variable first and then convert...
3099 exit_code
= -job
->status
;
3100 if (WIFEXITED(exit_code
))
3101 exit_code
= WEXITSTATUS(exit_code
);
3104 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-backend-crashed");
3105 exit_code
= job
->status
;
3108 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
3110 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
3111 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
3112 "authentication required" :
3113 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
3114 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
3115 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
3116 exit_code
== CUPS_BACKEND_RETRY
? "retry job later" :
3117 exit_code
== CUPS_BACKEND_RETRY_CURRENT
? "retry job immediately" :
3118 exit_code
< 0 ? "crashed" : "unknown");
3121 * Do what needs to be done...
3127 case CUPS_BACKEND_FAILED
:
3129 * Backend failure, use the error-policy to determine how to
3133 if (job
->dtype
& CUPS_PRINTER_CLASS
)
3136 * Queued on a class - mark the job as pending and we'll retry on
3137 * another printer...
3140 if (job_state
== IPP_JOB_COMPLETED
)
3142 job_state
= IPP_JOB_PENDING
;
3143 message
= "Retrying job on another printer.";
3145 ippSetString(job
->attrs
, &job
->reasons
, 0,
3146 "resources-are-not-ready");
3149 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
3152 * The error policy is "retry-current-job" - mark the job as pending
3153 * and we'll retry on the same printer...
3156 if (job_state
== IPP_JOB_COMPLETED
)
3158 job_state
= IPP_JOB_PENDING
;
3159 message
= "Retrying job on same printer.";
3161 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3164 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
3165 !strcmp(job
->printer
->error_policy
, "retry-job"))
3167 if (job_state
== IPP_JOB_COMPLETED
)
3170 * The job was queued on a fax or the error policy is "retry-job" -
3171 * hold the job if the number of retries is less than the
3172 * JobRetryLimit, otherwise abort the job.
3177 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3183 snprintf(buffer
, sizeof(buffer
),
3184 "Job aborted after %d unsuccessful attempts.",
3186 job_state
= IPP_JOB_ABORTED
;
3189 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3194 * Try again in N seconds...
3197 snprintf(buffer
, sizeof(buffer
),
3198 "Job held for %d seconds since it could not be sent.",
3201 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3202 job_state
= IPP_JOB_HELD
;
3205 ippSetString(job
->attrs
, &job
->reasons
, 0,
3206 "resources-are-not-ready");
3210 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
3211 job_state
== IPP_JOB_COMPLETED
)
3213 job_state
= IPP_JOB_ABORTED
;
3214 message
= "Job aborted due to backend errors; please consult "
3215 "the error_log file for details.";
3217 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3219 else if (job
->state_value
== IPP_JOB_PROCESSING
)
3221 job_state
= IPP_JOB_PENDING
;
3222 printer_state
= IPP_PRINTER_STOPPED
;
3223 message
= "Printer stopped due to backend errors; please "
3224 "consult the error_log file for details.";
3226 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3230 case CUPS_BACKEND_CANCEL
:
3235 if (job_state
== IPP_JOB_COMPLETED
)
3237 job_state
= IPP_JOB_CANCELED
;
3238 message
= "Job canceled at printer.";
3240 ippSetString(job
->attrs
, &job
->reasons
, 0, "canceled-at-device");
3244 case CUPS_BACKEND_HOLD
:
3245 if (job_state
== IPP_JOB_COMPLETED
)
3251 const char *reason
= ippGetString(job
->reasons
, 0, NULL
);
3253 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-state-reasons=\"%s\"",
3256 if (!reason
|| strncmp(reason
, "account-", 8))
3258 cupsdSetJobHoldUntil(job
, "indefinite", 1);
3260 ippSetString(job
->attrs
, &job
->reasons
, 0,
3261 "job-hold-until-specified");
3262 message
= "Job held indefinitely due to backend errors; please "
3263 "consult the error_log file for details.";
3265 else if (!strcmp(reason
, "account-info-needed"))
3267 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3269 message
= "Job held indefinitely - account information is "
3272 else if (!strcmp(reason
, "account-closed"))
3274 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3276 message
= "Job held indefinitely - account has been closed.";
3278 else if (!strcmp(reason
, "account-limit-reached"))
3280 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3282 message
= "Job held indefinitely - account limit has been "
3287 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3289 message
= "Job held indefinitely - account authorization failed.";
3292 job_state
= IPP_JOB_HELD
;
3296 case CUPS_BACKEND_STOP
:
3298 * Stop the printer...
3301 printer_state
= IPP_PRINTER_STOPPED
;
3302 message
= "Printer stopped due to backend errors; please "
3303 "consult the error_log file for details.";
3305 if (job_state
== IPP_JOB_COMPLETED
)
3307 job_state
= IPP_JOB_PENDING
;
3309 ippSetString(job
->attrs
, &job
->reasons
, 0,
3310 "resources-are-not-ready");
3314 case CUPS_BACKEND_AUTH_REQUIRED
:
3316 * Hold the job for authentication...
3319 if (job_state
== IPP_JOB_COMPLETED
)
3321 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
3323 job_state
= IPP_JOB_HELD
;
3324 message
= "Job held for authentication.";
3326 if (strncmp(job
->reasons
->values
[0].string
.text
, "account-", 8))
3327 ippSetString(job
->attrs
, &job
->reasons
, 0,
3328 "cups-held-for-authentication");
3332 case CUPS_BACKEND_RETRY
:
3333 if (job_state
== IPP_JOB_COMPLETED
)
3336 * Hold the job if the number of retries is less than the
3337 * JobRetryLimit, otherwise abort the job.
3342 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3348 snprintf(buffer
, sizeof(buffer
),
3349 "Job aborted after %d unsuccessful attempts.",
3351 job_state
= IPP_JOB_ABORTED
;
3354 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3359 * Try again in N seconds...
3362 snprintf(buffer
, sizeof(buffer
),
3363 "Job held for %d seconds since it could not be sent.",
3366 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3367 job_state
= IPP_JOB_HELD
;
3370 ippSetString(job
->attrs
, &job
->reasons
, 0,
3371 "resources-are-not-ready");
3376 case CUPS_BACKEND_RETRY_CURRENT
:
3378 * Mark the job as pending and retry on the same printer...
3381 if (job_state
== IPP_JOB_COMPLETED
)
3383 job_state
= IPP_JOB_PENDING
;
3384 message
= "Retrying job on same printer.";
3386 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3391 else if (job
->status
> 0)
3394 * Filter had errors; stop job...
3397 if (job_state
== IPP_JOB_COMPLETED
)
3399 job_state
= IPP_JOB_STOPPED
;
3400 message
= "Job stopped due to filter errors; please consult the "
3401 "error_log file for details.";
3403 if (WIFSIGNALED(job
->status
))
3404 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-filter-crashed");
3406 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-completed-with-errors");
3411 * Update the printer and job state.
3414 if (set_job_state
&& job_state
!= job
->state_value
)
3415 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
3417 cupsdSetPrinterState(job
->printer
, printer_state
,
3418 printer_state
== IPP_PRINTER_STOPPED
);
3419 update_job_attrs(job
, 0);
3424 (job
->state_value
== IPP_JOB_ABORTED
||
3425 job
->state_value
== IPP_JOB_STOPPED
))
3426 dump_job_history(job
);
3428 free_job_history(job
);
3431 cupsArrayRemove(PrintingJobs
, job
);
3434 * Apply any PPD updates...
3437 if (job
->num_keywords
)
3439 if (cupsdUpdatePrinterPPD(job
->printer
, job
->num_keywords
, job
->keywords
))
3440 cupsdSetPrinterAttrs(job
->printer
);
3442 cupsFreeOptions(job
->num_keywords
, job
->keywords
);
3444 job
->num_keywords
= 0;
3445 job
->keywords
= NULL
;
3449 * Clear the printer <-> job association...
3452 job
->printer
->job
= NULL
;
3453 job
->printer
= NULL
;
3456 * Try printing another job...
3459 if (printer_state
!= IPP_PRINTER_STOPPED
)
3465 * 'get_options()' - Get a string containing the job options.
3468 static char * /* O - Options string */
3469 get_options(cupsd_job_t
*job
, /* I - Job */
3470 int banner_page
, /* I - Printing a banner page? */
3471 char *copies
, /* I - Copies buffer */
3472 size_t copies_size
, /* I - Size of copies buffer */
3473 char *title
, /* I - Title buffer */
3474 size_t title_size
) /* I - Size of title buffer */
3476 int i
; /* Looping var */
3477 size_t newlength
; /* New option buffer length */
3478 char *optptr
, /* Pointer to options */
3479 *valptr
; /* Pointer in value string */
3480 ipp_attribute_t
*attr
; /* Current attribute */
3481 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3482 int num_pwgppds
; /* Number of PWG->PPD options */
3483 cups_option_t
*pwgppds
, /* PWG->PPD options */
3484 *pwgppd
, /* Current PWG->PPD option */
3485 *preset
; /* Current preset option */
3486 int print_color_mode
,
3487 /* Output mode (if any) */
3488 print_quality
; /* Print quality (if any) */
3489 const char *ppd
; /* PPD option choice */
3490 int exact
; /* Did we get an exact match? */
3491 static char *options
= NULL
;/* Full list of options */
3492 static size_t optlength
= 0; /* Length of option buffer */
3496 * Building the options string is harder than it needs to be, but for the
3497 * moment we need to pass strings for command-line args and not IPP attribute
3500 * First build an options array for any PWG->PPD mapped option/choice pairs.
3503 pc
= job
->printer
->pc
;
3508 !ippFindAttribute(job
->attrs
,
3509 "com.apple.print.DocumentTicket.PMSpoolFormat",
3511 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3512 (ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) ||
3513 ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
)))
3516 * Map print-color-mode and print-quality to a preset...
3519 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3520 IPP_TAG_KEYWORD
)) != NULL
&&
3521 !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3522 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3524 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3526 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality",
3527 IPP_TAG_ENUM
)) != NULL
&&
3528 attr
->values
[0].integer
>= IPP_QUALITY_DRAFT
&&
3529 attr
->values
[0].integer
<= IPP_QUALITY_HIGH
)
3530 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3532 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3534 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3537 * Try to find a preset that works so that we maximize the chances of us
3538 * getting a good print using IPP attributes.
3541 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3542 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3543 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3544 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3547 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3548 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3552 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3555 * Copy the preset options as long as the corresponding names are not
3556 * already defined in the IPP request...
3559 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3560 preset
= pc
->presets
[print_color_mode
][print_quality
];
3564 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3565 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
,
3573 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3574 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3576 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3577 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3580 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3581 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3582 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3584 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3585 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3586 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3588 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3590 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3591 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3594 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3595 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3596 IPP_TAG_ZERO
)) != NULL
&&
3597 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3598 attr
->value_tag
== IPP_TAG_NAME
) &&
3599 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3602 * Map output-bin to OutputBin option...
3605 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3608 if (pc
->sides_option
&&
3609 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3610 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3613 * Map sides to duplex option...
3616 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3617 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
,
3618 num_pwgppds
, &pwgppds
);
3619 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3620 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
,
3621 num_pwgppds
, &pwgppds
);
3622 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3623 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
,
3624 num_pwgppds
, &pwgppds
);
3628 * Map finishings values...
3631 num_pwgppds
= _ppdCacheGetFinishingOptions(pc
, job
->attrs
,
3632 IPP_FINISHINGS_NONE
, num_pwgppds
,
3637 * Figure out how much room we need...
3640 newlength
= ipp_length(job
->attrs
);
3642 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3643 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3646 * Then allocate/reallocate the option buffer as needed...
3649 if (newlength
== 0) /* This can never happen, but Clang */
3650 newlength
= 1; /* thinks it can... */
3652 if (newlength
> optlength
|| !options
)
3655 optptr
= malloc(newlength
);
3657 optptr
= realloc(options
, newlength
);
3661 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3662 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer.",
3663 CUPS_LLCAST newlength
);
3668 optlength
= newlength
;
3672 * Now loop through the attributes and convert them to the textual
3673 * representation used by the filters...
3679 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3680 strlcpy(copies
, "1", copies_size
);
3682 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3684 if (!strcmp(attr
->name
, "copies") &&
3685 attr
->value_tag
== IPP_TAG_INTEGER
)
3688 * Don't use the # copies attribute if we are printing the job sheets...
3692 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3694 else if (!strcmp(attr
->name
, "job-name") &&
3695 (attr
->value_tag
== IPP_TAG_NAME
||
3696 attr
->value_tag
== IPP_TAG_NAMELANG
))
3697 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3698 else if (attr
->group_tag
== IPP_TAG_JOB
)
3701 * Filter out other unwanted attributes...
3704 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3705 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3706 attr
->value_tag
== IPP_TAG_NAMELANG
||
3707 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3708 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid") &&
3709 strcmp(attr
->name
, "job-authorization-uri")) ||
3710 attr
->value_tag
== IPP_TAG_URISCHEME
||
3711 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3714 if (!strcmp(attr
->name
, "job-hold-until") ||
3715 !strcmp(attr
->name
, "job-id") ||
3716 !strcmp(attr
->name
, "job-k-octets") ||
3717 !strcmp(attr
->name
, "job-media-sheets") ||
3718 !strcmp(attr
->name
, "job-media-sheets-completed") ||
3719 !strcmp(attr
->name
, "job-state") ||
3720 !strcmp(attr
->name
, "job-state-reasons"))
3723 if (!strncmp(attr
->name
, "job-", 4) &&
3724 strcmp(attr
->name
, "job-account-id") &&
3725 strcmp(attr
->name
, "job-accounting-user-id") &&
3726 strcmp(attr
->name
, "job-authorization-uri") &&
3727 strcmp(attr
->name
, "job-billing") &&
3728 strcmp(attr
->name
, "job-impressions") &&
3729 strcmp(attr
->name
, "job-originating-host-name") &&
3730 strcmp(attr
->name
, "job-password") &&
3731 strcmp(attr
->name
, "job-password-encryption") &&
3732 strcmp(attr
->name
, "job-uuid") &&
3733 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3736 if ((!strcmp(attr
->name
, "job-impressions") ||
3737 !strcmp(attr
->name
, "page-label") ||
3738 !strcmp(attr
->name
, "page-border") ||
3739 !strncmp(attr
->name
, "number-up", 9) ||
3740 !strcmp(attr
->name
, "page-ranges") ||
3741 !strcmp(attr
->name
, "page-set") ||
3742 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3743 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3744 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3745 "PMTotalSidesImaged..n.") ||
3746 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3747 "PMTotalBeginPages..n.")) &&
3752 * Otherwise add them to the list...
3755 if (optptr
> options
)
3756 strlcat(optptr
, " ", optlength
- (optptr
- options
));
3758 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3760 strlcat(optptr
, attr
->name
, optlength
- (optptr
- options
));
3761 strlcat(optptr
, "=", optlength
- (optptr
- options
));
3764 for (i
= 0; i
< attr
->num_values
; i
++)
3767 strlcat(optptr
, ",", optlength
- (optptr
- options
));
3769 optptr
+= strlen(optptr
);
3771 switch (attr
->value_tag
)
3773 case IPP_TAG_INTEGER
:
3775 snprintf(optptr
, optlength
- (optptr
- options
),
3776 "%d", attr
->values
[i
].integer
);
3779 case IPP_TAG_BOOLEAN
:
3780 if (!attr
->values
[i
].boolean
)
3781 strlcat(optptr
, "no", optlength
- (optptr
- options
));
3783 strlcat(optptr
, attr
->name
,
3784 optlength
- (optptr
- options
));
3787 case IPP_TAG_RANGE
:
3788 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3789 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3790 "%d", attr
->values
[i
].range
.lower
);
3792 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3793 "%d-%d", attr
->values
[i
].range
.lower
,
3794 attr
->values
[i
].range
.upper
);
3797 case IPP_TAG_RESOLUTION
:
3798 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3799 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
3800 attr
->values
[i
].resolution
.yres
,
3801 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
3805 case IPP_TAG_STRING
:
3808 case IPP_TAG_KEYWORD
:
3809 case IPP_TAG_CHARSET
:
3810 case IPP_TAG_LANGUAGE
:
3812 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
3814 if (strchr(" \t\n\\\'\"", *valptr
))
3816 *optptr
++ = *valptr
++;
3823 break; /* anti-compiler-warning-code */
3827 optptr
+= strlen(optptr
);
3832 * Finally loop through the PWG->PPD mapped options and add them...
3835 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3838 strlcpy(optptr
, pwgppd
->name
, optlength
- (optptr
- options
));
3839 optptr
+= strlen(optptr
);
3841 strlcpy(optptr
, pwgppd
->value
, optlength
- (optptr
- options
));
3842 optptr
+= strlen(optptr
);
3845 cupsFreeOptions(num_pwgppds
, pwgppds
);
3848 * Return the options string...
3856 * 'ipp_length()' - Compute the size of the buffer needed to hold
3857 * the textual IPP attributes.
3860 static size_t /* O - Size of attribute buffer */
3861 ipp_length(ipp_t
*ipp
) /* I - IPP request */
3863 size_t bytes
; /* Number of bytes */
3864 int i
; /* Looping var */
3865 ipp_attribute_t
*attr
; /* Current attribute */
3869 * Loop through all attributes...
3874 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3877 * Skip attributes that won't be sent to filters...
3880 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3881 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3882 attr
->value_tag
== IPP_TAG_NAMELANG
||
3883 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3884 attr
->value_tag
== IPP_TAG_URI
||
3885 attr
->value_tag
== IPP_TAG_URISCHEME
)
3889 * Add space for a leading space and commas between each value.
3890 * For the first attribute, the leading space isn't used, so the
3891 * extra byte can be used as the nul terminator...
3894 bytes
++; /* " " separator */
3895 bytes
+= attr
->num_values
; /* "," separators */
3898 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3899 * other attributes appear as "foo=value1,value2,...,valueN".
3902 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3903 bytes
+= strlen(attr
->name
);
3905 bytes
+= attr
->num_values
* strlen(attr
->name
);
3908 * Now add the size required for each value in the attribute...
3911 switch (attr
->value_tag
)
3913 case IPP_TAG_INTEGER
:
3916 * Minimum value of a signed integer is -2147483647, or 11 digits.
3919 bytes
+= attr
->num_values
* 11;
3922 case IPP_TAG_BOOLEAN
:
3924 * Add two bytes for each false ("no") value...
3927 for (i
= 0; i
< attr
->num_values
; i
++)
3928 if (!attr
->values
[i
].boolean
)
3932 case IPP_TAG_RANGE
:
3934 * A range is two signed integers separated by a hyphen, or
3935 * 23 characters max.
3938 bytes
+= attr
->num_values
* 23;
3941 case IPP_TAG_RESOLUTION
:
3943 * A resolution is two signed integers separated by an "x" and
3944 * suffixed by the units, or 26 characters max.
3947 bytes
+= attr
->num_values
* 26;
3950 case IPP_TAG_STRING
:
3953 case IPP_TAG_KEYWORD
:
3954 case IPP_TAG_CHARSET
:
3955 case IPP_TAG_LANGUAGE
:
3958 * Strings can contain characters that need quoting. We need
3959 * at least 2 * len + 2 characters to cover the quotes and
3960 * any backslashes in the string.
3963 for (i
= 0; i
< attr
->num_values
; i
++)
3964 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
3968 break; /* anti-compiler-warning-code */
3977 * 'load_job_cache()' - Load jobs from the job.cache file.
3981 load_job_cache(const char *filename
) /* I - job.cache filename */
3983 cups_file_t
*fp
; /* job.cache file */
3984 char line
[1024], /* Line buffer */
3985 *value
; /* Value on line */
3986 int linenum
; /* Line number in file */
3987 cupsd_job_t
*job
; /* Current job */
3988 int jobid
; /* Job ID */
3989 char jobfile
[1024]; /* Job filename */
3993 * Open the job.cache file...
3996 if ((fp
= cupsdOpenConfFile(filename
)) == NULL
)
3998 load_request_root();
4003 * Read entries from the job cache file and create jobs as needed.
4006 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
4012 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4014 if (!_cups_strcasecmp(line
, "NextJobId"))
4017 NextJobId
= atoi(value
);
4019 else if (!_cups_strcasecmp(line
, "<Job"))
4023 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d.",
4030 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d.", linenum
);
4034 jobid
= atoi(value
);
4038 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d.", jobid
,
4043 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
4044 if (access(jobfile
, 0))
4046 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d.N", RequestRoot
, jobid
);
4047 if (access(jobfile
, 0))
4049 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away.",
4055 job
= calloc(1, sizeof(cupsd_job_t
));
4058 cupsdLogMessage(CUPSD_LOG_EMERG
,
4059 "[Job %d] Unable to allocate memory for job.", jobid
);
4064 job
->back_pipes
[0] = -1;
4065 job
->back_pipes
[1] = -1;
4066 job
->print_pipes
[0] = -1;
4067 job
->print_pipes
[1] = -1;
4068 job
->side_pipes
[0] = -1;
4069 job
->side_pipes
[1] = -1;
4070 job
->status_pipes
[0] = -1;
4071 job
->status_pipes
[1] = -1;
4073 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading from cache...",
4078 cupsdLogMessage(CUPSD_LOG_ERROR
,
4079 "Missing <Job #> directive on line %d.", linenum
);
4082 else if (!_cups_strcasecmp(line
, "</Job>"))
4084 cupsArrayAdd(Jobs
, job
);
4086 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
4087 cupsArrayAdd(ActiveJobs
, job
);
4093 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d.", linenum
);
4096 else if (!_cups_strcasecmp(line
, "State"))
4098 job
->state_value
= (ipp_jstate_t
)atoi(value
);
4100 if (job
->state_value
< IPP_JOB_PENDING
)
4101 job
->state_value
= IPP_JOB_PENDING
;
4102 else if (job
->state_value
> IPP_JOB_COMPLETED
)
4103 job
->state_value
= IPP_JOB_COMPLETED
;
4105 else if (!_cups_strcasecmp(line
, "HoldUntil"))
4107 job
->hold_until
= atoi(value
);
4109 else if (!_cups_strcasecmp(line
, "Priority"))
4111 job
->priority
= atoi(value
);
4113 else if (!_cups_strcasecmp(line
, "Username"))
4115 cupsdSetString(&job
->username
, value
);
4117 else if (!_cups_strcasecmp(line
, "Destination"))
4119 cupsdSetString(&job
->dest
, value
);
4121 else if (!_cups_strcasecmp(line
, "DestType"))
4123 job
->dtype
= (cups_ptype_t
)atoi(value
);
4125 else if (!_cups_strcasecmp(line
, "NumFiles"))
4127 job
->num_files
= atoi(value
);
4129 if (job
->num_files
< 0)
4131 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d.",
4132 job
->num_files
, linenum
);
4137 if (job
->num_files
> 0)
4139 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
4141 if (access(jobfile
, 0))
4143 cupsdLogMessage(CUPSD_LOG_INFO
, "[Job %d] Data files have gone away.",
4149 job
->filetypes
= calloc(job
->num_files
, sizeof(mime_type_t
*));
4150 job
->compressions
= calloc(job
->num_files
, sizeof(int));
4152 if (!job
->filetypes
|| !job
->compressions
)
4154 cupsdLogMessage(CUPSD_LOG_EMERG
,
4155 "[Job %d] Unable to allocate memory for %d files.",
4156 job
->id
, job
->num_files
);
4161 else if (!_cups_strcasecmp(line
, "File"))
4163 int number
, /* File number */
4164 compression
; /* Compression value */
4165 char super
[MIME_MAX_SUPER
], /* MIME super type */
4166 type
[MIME_MAX_TYPE
]; /* MIME type */
4169 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
4172 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d.", linenum
);
4176 if (number
< 1 || number
> job
->num_files
)
4178 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d.",
4185 job
->compressions
[number
] = compression
;
4186 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
4188 if (!job
->filetypes
[number
])
4191 * If the original MIME type is unknown, auto-type it!
4194 cupsdLogMessage(CUPSD_LOG_ERROR
,
4195 "[Job %d] Unknown MIME type %s/%s for file %d.",
4196 job
->id
, super
, type
, number
+ 1);
4198 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
4199 job
->id
, number
+ 1);
4200 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
4201 job
->compressions
+ number
);
4204 * If that didn't work, assume it is raw...
4207 if (!job
->filetypes
[number
])
4208 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
4213 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d.",
4219 cupsdLogMessage(CUPSD_LOG_ERROR
,
4220 "Missing </Job> directive on line %d.", linenum
);
4221 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
4229 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4233 load_next_job_id(const char *filename
) /* I - job.cache filename */
4235 cups_file_t
*fp
; /* job.cache file */
4236 char line
[1024], /* Line buffer */
4237 *value
; /* Value on line */
4238 int linenum
; /* Line number in file */
4239 int next_job_id
; /* NextJobId value from line */
4243 * Read the NextJobId directive from the job.cache file and use
4244 * the value (if any).
4247 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4249 if (errno
!= ENOENT
)
4250 cupsdLogMessage(CUPSD_LOG_ERROR
,
4251 "Unable to open job cache file \"%s\": %s",
4252 filename
, strerror(errno
));
4257 cupsdLogMessage(CUPSD_LOG_INFO
,
4258 "Loading NextJobId from job cache file \"%s\"...", filename
);
4262 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4264 if (!_cups_strcasecmp(line
, "NextJobId"))
4268 next_job_id
= atoi(value
);
4270 if (next_job_id
> NextJobId
)
4271 NextJobId
= next_job_id
;
4282 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4286 load_request_root(void)
4288 cups_dir_t
*dir
; /* Directory */
4289 cups_dentry_t
*dent
; /* Directory entry */
4290 cupsd_job_t
*job
; /* New job */
4294 * Open the requests directory...
4297 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
4299 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
4301 cupsdLogMessage(CUPSD_LOG_ERROR
,
4302 "Unable to open spool directory \"%s\": %s",
4303 RequestRoot
, strerror(errno
));
4308 * Read all the c##### files...
4311 while ((dent
= cupsDirRead(dir
)) != NULL
)
4312 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
4315 * Allocate memory for the job...
4318 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
4320 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs.");
4326 * Assign the job ID...
4329 job
->id
= atoi(dent
->filename
+ 1);
4330 job
->back_pipes
[0] = -1;
4331 job
->back_pipes
[1] = -1;
4332 job
->print_pipes
[0] = -1;
4333 job
->print_pipes
[1] = -1;
4334 job
->side_pipes
[0] = -1;
4335 job
->side_pipes
[1] = -1;
4336 job
->status_pipes
[0] = -1;
4337 job
->status_pipes
[1] = -1;
4339 if (job
->id
>= NextJobId
)
4340 NextJobId
= job
->id
+ 1;
4346 if (cupsdLoadJob(job
))
4349 * Insert the job into the array, sorting by job priority and ID...
4352 cupsArrayAdd(Jobs
, job
);
4354 if (job
->state_value
<= IPP_JOB_STOPPED
)
4355 cupsArrayAdd(ActiveJobs
, job
);
4368 * 'remove_job_files()' - Remove the document files for a job.
4372 remove_job_files(cupsd_job_t
*job
) /* I - Job */
4374 int i
; /* Looping var */
4375 char filename
[1024]; /* Document filename */
4378 if (job
->num_files
<= 0)
4381 for (i
= 1; i
<= job
->num_files
; i
++)
4383 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
4385 cupsdUnlinkOrRemoveFile(filename
);
4388 free(job
->filetypes
);
4389 free(job
->compressions
);
4393 job
->filetypes
= NULL
;
4394 job
->compressions
= NULL
;
4396 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4401 * 'remove_job_history()' - Remove the control file for a job.
4405 remove_job_history(cupsd_job_t
*job
) /* I - Job */
4407 char filename
[1024]; /* Control filename */
4411 * Remove the job info file...
4414 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
4416 cupsdUnlinkOrRemoveFile(filename
);
4418 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4423 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4427 set_time(cupsd_job_t
*job
, /* I - Job to update */
4428 const char *name
) /* I - Name of attribute */
4430 ipp_attribute_t
*attr
; /* Time attribute */
4431 time_t curtime
; /* Current time */
4434 curtime
= time(NULL
);
4436 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s=%ld", name
, (long)curtime
);
4438 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
4440 attr
->value_tag
= IPP_TAG_INTEGER
;
4441 attr
->values
[0].integer
= curtime
;
4444 if (!strcmp(name
, "time-at-completed"))
4446 if (JobHistory
< INT_MAX
&& attr
)
4447 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
4449 job
->history_time
= INT_MAX
;
4451 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4452 JobHistoryUpdate
= job
->history_time
;
4454 if (JobFiles
< INT_MAX
&& attr
)
4455 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
4457 job
->file_time
= INT_MAX
;
4459 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4460 JobHistoryUpdate
= job
->file_time
;
4462 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "set_time: JobHistoryUpdate=%ld",
4463 (long)JobHistoryUpdate
);
4469 * 'start_job()' - Start a print job.
4473 start_job(cupsd_job_t
*job
, /* I - Job ID */
4474 cupsd_printer_t
*printer
) /* I - Printer to print job */
4476 const char *filename
; /* Support filename */
4479 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
4480 job
, job
->id
, printer
, printer
->name
);
4483 * Make sure we have some files around before we try to print...
4486 if (job
->num_files
== 0)
4488 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
4489 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
4490 "Aborting job because it has no files.");
4495 * Update the printer and job state to "processing"...
4498 if (!cupsdLoadJob(job
))
4501 if (!job
->printer_message
)
4502 job
->printer_message
= ippFindAttribute(job
->attrs
,
4503 "job-printer-state-message",
4505 if (job
->printer_message
)
4506 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
4508 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-printing");
4509 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
4510 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
4511 cupsdSetPrinterReasons(printer
, "-cups-remote-pending,"
4512 "cups-remote-pending-held,"
4513 "cups-remote-processing,"
4514 "cups-remote-stopped,"
4515 "cups-remote-canceled,"
4516 "cups-remote-aborted,"
4517 "cups-remote-completed");
4520 job
->current_file
= 0;
4522 job
->history_time
= 0;
4524 job
->printer
= printer
;
4528 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4530 job
->cancel_time
= 0;
4533 * Check for support files...
4536 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
4537 "cups-insecure-filter-warning");
4541 for (filename
= (const char *)cupsArrayFirst(printer
->pc
->support_files
);
4543 filename
= (const char *)cupsArrayNext(printer
->pc
->support_files
))
4545 if (_cupsFileCheck(filename
, _CUPS_FILE_CHECK_FILE
, !RunUser
,
4546 cupsdLogFCMessage
, printer
))
4552 * Setup the last exit status and security profiles...
4556 job
->profile
= cupsdCreateProfile(job
->id
);
4559 * Create the status pipes and buffer...
4562 if (cupsdOpenPipe(job
->status_pipes
))
4564 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4565 "Unable to create job status pipes - %s.", strerror(errno
));
4567 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4568 "Job stopped because the scheduler could not create the "
4569 "job status pipes.");
4571 cupsdDestroyProfile(job
->profile
);
4572 job
->profile
= NULL
;
4576 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
4577 job
->status_level
= CUPSD_LOG_INFO
;
4580 * Create the backchannel pipes and make them non-blocking...
4583 if (cupsdOpenPipe(job
->back_pipes
))
4585 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4586 "Unable to create back-channel pipes - %s.", strerror(errno
));
4588 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4589 "Job stopped because the scheduler could not create the "
4590 "back-channel pipes.");
4592 cupsdClosePipe(job
->status_pipes
);
4593 cupsdStatBufDelete(job
->status_buffer
);
4594 job
->status_buffer
= NULL
;
4596 cupsdDestroyProfile(job
->profile
);
4597 job
->profile
= NULL
;
4601 fcntl(job
->back_pipes
[0], F_SETFL
,
4602 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4603 fcntl(job
->back_pipes
[1], F_SETFL
,
4604 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4607 * Create the side-channel pipes and make them non-blocking...
4610 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4612 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4613 "Unable to create side-channel pipes - %s.", strerror(errno
));
4615 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4616 "Job stopped because the scheduler could not create the "
4617 "side-channel pipes.");
4619 cupsdClosePipe(job
->back_pipes
);
4621 cupsdClosePipe(job
->status_pipes
);
4622 cupsdStatBufDelete(job
->status_buffer
);
4623 job
->status_buffer
= NULL
;
4625 cupsdDestroyProfile(job
->profile
);
4626 job
->profile
= NULL
;
4630 fcntl(job
->side_pipes
[0], F_SETFL
,
4631 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4632 fcntl(job
->side_pipes
[1], F_SETFL
,
4633 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4635 fcntl(job
->side_pipes
[0], F_SETFD
,
4636 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4637 fcntl(job
->side_pipes
[1], F_SETFD
,
4638 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4641 * Now start the first file in the job...
4644 cupsdContinueJob(job
);
4649 * 'stop_job()' - Stop a print job.
4653 stop_job(cupsd_job_t
*job
, /* I - Job */
4654 cupsd_jobaction_t action
) /* I - Action */
4656 int i
; /* Looping var */
4659 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4662 FilterLevel
-= job
->cost
;
4665 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
)
4666 job
->kill_time
= time(NULL
) + JobKillDelay
;
4667 else if (action
>= CUPSD_JOB_FORCE
)
4670 for (i
= 0; job
->filters
[i
]; i
++)
4671 if (job
->filters
[i
] > 0)
4673 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
4675 if (action
>= CUPSD_JOB_FORCE
)
4676 job
->filters
[i
] = -job
->filters
[i
];
4679 if (job
->backend
> 0)
4681 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
4683 if (action
>= CUPSD_JOB_FORCE
)
4684 job
->backend
= -job
->backend
;
4687 if (action
>= CUPSD_JOB_FORCE
)
4690 * Clear job status...
4699 * 'unload_job()' - Unload a job from memory.
4703 unload_job(cupsd_job_t
*job
) /* I - Job */
4708 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Unloading...", job
->id
);
4710 ippDelete(job
->attrs
);
4714 job
->reasons
= NULL
;
4716 job
->job_sheets
= NULL
;
4717 job
->printer_message
= NULL
;
4718 job
->printer_reasons
= NULL
;
4723 * 'update_job()' - Read a status update from a job's filters.
4727 update_job(cupsd_job_t
*job
) /* I - Job to check */
4729 int i
; /* Looping var */
4730 int copies
; /* Number of copies printed */
4731 char message
[CUPSD_SB_BUFFER_SIZE
],
4733 *ptr
; /* Pointer update... */
4734 int loglevel
, /* Log level for message */
4735 event
= 0; /* Events? */
4736 static const char * const levels
[] = /* Log levels */
4752 * Get the printer associated with this job; if the printer is stopped for
4753 * any reason then job->printer will be reset to NULL, so make sure we have
4754 * a valid pointer...
4757 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
4758 message
, sizeof(message
))) != NULL
)
4761 * Process page and printer state messages as needed...
4764 if (loglevel
== CUPSD_LOG_PAGE
)
4767 * Page message; send the message to the page_log file and update the
4768 * job sheet count...
4771 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
4775 if (!_cups_strncasecmp(message
, "total ", 6))
4778 * Got a total count of pages from a backend or filter...
4781 copies
= atoi(message
+ 6);
4782 copies
-= job
->sheets
->values
[0].integer
; /* Just track the delta */
4784 else if (!sscanf(message
, "%*d%d", &copies
))
4787 job
->sheets
->values
[0].integer
+= copies
;
4789 if (job
->printer
->page_limit
)
4790 cupsdUpdateQuota(job
->printer
, job
->username
, copies
, 0);
4793 cupsdLogPage(job
, message
);
4796 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4797 "Printed %d page(s).", job
->sheets
->values
[0].integer
);
4799 else if (loglevel
== CUPSD_LOG_JOBSTATE
)
4802 * Support "keyword" to set job-state-reasons to the specified keyword.
4803 * This is sufficient for the current paid printing stuff.
4806 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "JOBSTATE: %s", message
);
4808 ippSetString(job
->attrs
, &job
->reasons
, 0, message
);
4810 else if (loglevel
== CUPSD_LOG_STATE
)
4812 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
4814 if (!strcmp(message
, "paused"))
4816 cupsdStopPrinter(job
->printer
, 1);
4819 else if (message
[0] && cupsdSetPrinterReasons(job
->printer
, message
))
4821 event
|= CUPSD_EVENT_PRINTER_STATE
;
4823 if (MaxJobTime
> 0 && strstr(message
, "connecting-to-device") != NULL
)
4826 * Reset cancel time after connecting to the device...
4829 for (i
= 0; i
< job
->printer
->num_reasons
; i
++)
4830 if (!strcmp(job
->printer
->reasons
[i
], "connecting-to-device"))
4833 if (i
>= job
->printer
->num_reasons
)
4834 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4838 update_job_attrs(job
, 0);
4840 else if (loglevel
== CUPSD_LOG_ATTR
)
4843 * Set attribute(s)...
4846 int num_attrs
; /* Number of attributes */
4847 cups_option_t
*attrs
; /* Attributes */
4848 const char *attr
; /* Attribute */
4850 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
4852 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
4854 if ((attr
= cupsGetOption("auth-info-default", num_attrs
,
4857 job
->printer
->num_options
= cupsAddOption("auth-info", attr
,
4858 job
->printer
->num_options
,
4859 &(job
->printer
->options
));
4860 cupsdSetPrinterAttrs(job
->printer
);
4862 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4865 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
4868 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
4869 cupsdSetPrinterAttrs(job
->printer
);
4871 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4874 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
4877 int progress
= atoi(attr
);
4880 if (progress
>= 0 && progress
<= 100)
4882 job
->progress
= progress
;
4885 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4886 "Printing page %d, %d%%",
4887 job
->sheets
->values
[0].integer
, job
->progress
);
4891 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
4893 cupsdSetString(&job
->printer
->alert
, attr
);
4894 event
|= CUPSD_EVENT_PRINTER_STATE
;
4897 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
4900 cupsdSetString(&job
->printer
->alert_description
, attr
);
4901 event
|= CUPSD_EVENT_PRINTER_STATE
;
4904 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
4906 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
4907 job
->printer
->marker_time
= time(NULL
);
4908 event
|= CUPSD_EVENT_PRINTER_STATE
;
4909 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4912 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
4914 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
4915 job
->printer
->marker_time
= time(NULL
);
4916 event
|= CUPSD_EVENT_PRINTER_STATE
;
4917 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4920 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
4922 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
4923 job
->printer
->marker_time
= time(NULL
);
4924 event
|= CUPSD_EVENT_PRINTER_STATE
;
4925 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4928 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
4930 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
4931 job
->printer
->marker_time
= time(NULL
);
4932 event
|= CUPSD_EVENT_PRINTER_STATE
;
4933 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4936 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
4938 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
4939 job
->printer
->marker_time
= time(NULL
);
4940 event
|= CUPSD_EVENT_PRINTER_STATE
;
4941 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4944 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
4946 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
4947 job
->printer
->marker_time
= time(NULL
);
4948 event
|= CUPSD_EVENT_PRINTER_STATE
;
4949 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4952 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
4954 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
4955 job
->printer
->marker_time
= time(NULL
);
4956 event
|= CUPSD_EVENT_PRINTER_STATE
;
4957 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4960 cupsFreeOptions(num_attrs
, attrs
);
4962 else if (loglevel
== CUPSD_LOG_PPD
)
4965 * Set attribute(s)...
4968 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
4970 job
->num_keywords
= cupsParseOptions(message
, job
->num_keywords
,
4976 * Strip legacy message prefix...
4979 if (!strncmp(message
, "recoverable:", 12))
4982 while (isspace(*ptr
& 255))
4985 else if (!strncmp(message
, "recovered:", 10))
4988 while (isspace(*ptr
& 255))
4995 cupsdLogJob(job
, loglevel
, "%s", ptr
);
4997 if (loglevel
< CUPSD_LOG_DEBUG
&&
4998 strcmp(job
->printer
->state_message
, ptr
))
5000 strlcpy(job
->printer
->state_message
, ptr
,
5001 sizeof(job
->printer
->state_message
));
5003 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
5005 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
5008 * Some messages show in the job-printer-state-message attribute...
5011 if (loglevel
!= CUPSD_LOG_NOTICE
)
5012 job
->status_level
= loglevel
;
5014 update_job_attrs(job
, 1);
5016 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
5017 "Set job-printer-state-message to \"%s\", "
5019 job
->printer_message
->values
[0].string
.text
,
5020 levels
[job
->status_level
]);
5025 if (!strchr(job
->status_buffer
->buffer
, '\n'))
5029 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
5030 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5031 "%s", job
->printer
->state_message
);
5032 if (event
& CUPSD_EVENT_PRINTER_STATE
)
5033 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
5034 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
5035 "Class \"%s\" state changed." :
5036 "Printer \"%s\" state changed.",
5037 job
->printer
->name
);
5040 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
5043 * See if all of the filters and the backend have returned their
5047 for (i
= 0; job
->filters
[i
] < 0; i
++);
5049 if (job
->filters
[i
])
5052 * EOF but we haven't collected the exit status of all filters...
5055 cupsdCheckProcess();
5059 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
5062 * EOF but we haven't collected the exit status of the backend...
5065 cupsdCheckProcess();
5070 * Handle the end of job stuff...
5073 finalize_job(job
, 1);
5076 * Check for new jobs...
5085 * 'update_job_attrs()' - Update the job-printer-* attributes.
5089 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
5090 int do_message
)/* I - 1 = copy job-printer-state message */
5092 int i
; /* Looping var */
5093 int num_reasons
; /* Actual number of reasons */
5094 const char * const *reasons
; /* Reasons */
5095 static const char *none
= "none"; /* "none" reason */
5099 * Get/create the job-printer-state-* attributes...
5102 if (!job
->printer_message
)
5104 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
5105 "job-printer-state-message",
5106 IPP_TAG_TEXT
)) == NULL
)
5107 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
5108 "job-printer-state-message",
5112 if (!job
->printer_reasons
)
5113 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
5114 "job-printer-state-reasons",
5118 * Copy or clear the printer-state-message value as needed...
5121 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
5122 job
->status_level
== CUPSD_LOG_INFO
)
5124 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
5127 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5129 else if (job
->printer
->state_message
[0] && do_message
)
5131 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
),
5132 job
->printer
->state_message
);
5135 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5139 * ... and the printer-state-reasons value...
5142 if (job
->printer
->num_reasons
== 0)
5149 num_reasons
= job
->printer
->num_reasons
;
5150 reasons
= (const char * const *)job
->printer
->reasons
;
5153 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
5156 * Replace/create a job-printer-state-reasons attribute...
5159 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
5161 job
->printer_reasons
= ippAddStrings(job
->attrs
,
5162 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
5163 "job-printer-state-reasons",
5164 num_reasons
, NULL
, NULL
);
5169 * Don't bother clearing the reason strings if they are the same...
5172 for (i
= 0; i
< num_reasons
; i
++)
5173 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
5176 if (i
>= num_reasons
)
5180 * Not the same, so free the current strings...
5183 for (i
= 0; i
< num_reasons
; i
++)
5184 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
5188 * Copy the reasons...
5191 for (i
= 0; i
< num_reasons
; i
++)
5192 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
5195 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5200 * End of "$Id: job.c 7902 2008-09-03 14:20:17Z mike $".