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
));
602 if (job
->printer
->raw
)
605 * Remote jobs and raw queues go directly to the printer without
609 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Sending job to queue tagged as raw...");
614 * Local jobs get filtered...
617 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
618 job
->id
, job
->current_file
+ 1);
619 if (stat(filename
, &fileinfo
))
620 fileinfo
.st_size
= 0;
622 filters
= mimeFilter2(MimeDatabase
, job
->filetypes
[job
->current_file
],
623 fileinfo
.st_size
, job
->printer
->filetype
,
628 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
629 "Unable to convert file %d to printable format.",
632 abort_message
= "Aborting job because it cannot be printed.";
633 abort_state
= IPP_JOB_ABORTED
;
635 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
640 * Remove NULL ("-") filters...
643 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
645 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
646 if (!strcmp(filter
->filter
, "-"))
647 cupsArrayRemove(filters
, filter
);
649 if (cupsArrayCount(filters
) == 0)
651 cupsArrayDelete(filters
);
656 * If this printer has any pre-filters, insert the required pre-filter
657 * in the filters array...
660 if (job
->printer
->prefiltertype
&& filters
)
662 prefilters
= cupsArrayNew(NULL
, NULL
);
664 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
666 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
668 if ((prefilter
= mimeFilterLookup(MimeDatabase
, filter
->src
,
669 job
->printer
->prefiltertype
)))
671 cupsArrayAdd(prefilters
, prefilter
);
672 job
->cost
+= prefilter
->cost
;
675 cupsArrayAdd(prefilters
, filter
);
678 cupsArrayDelete(filters
);
679 filters
= prefilters
;
684 * Set a minimum cost of 100 for all jobs so that FilterLimit
685 * works with raw queues and other low-cost paths.
692 * See if the filter cost is too high...
695 if ((FilterLevel
+ job
->cost
) > FilterLimit
&& FilterLevel
> 0 &&
699 * Don't print this job quite yet...
702 cupsArrayDelete(filters
);
704 cupsdLogJob(job
, CUPSD_LOG_INFO
,
705 "Holding because filter limit has been reached.");
706 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
,
707 "cupsdContinueJob: file=%d, cost=%d, level=%d, limit=%d",
708 job
->current_file
, job
->cost
, FilterLevel
,
711 job
->pending_cost
= job
->cost
;
716 FilterLevel
+= job
->cost
;
719 * Add decompression/raw filter as needed...
722 if ((!job
->printer
->raw
&& job
->compressions
[job
->current_file
]) ||
723 (!filters
&& !job
->printer
->remote
&&
724 (job
->num_files
> 1 || !strncmp(job
->printer
->device_uri
, "file:", 5))))
727 * Add gziptoany filter to the front of the list...
731 filters
= cupsArrayNew(NULL
, NULL
);
733 if (!cupsArrayInsert(filters
, &gziptoany_filter
))
735 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
736 "Unable to add decompression filter - %s", strerror(errno
));
738 cupsArrayDelete(filters
);
740 abort_message
= "Stopping job because the scheduler ran out of memory.";
747 * Add port monitor, if any...
750 if (job
->printer
->port_monitor
)
753 * Add port monitor to the end of the list...
757 filters
= cupsArrayNew(NULL
, NULL
);
759 port_monitor
.src
= NULL
;
760 port_monitor
.dst
= NULL
;
761 port_monitor
.cost
= 0;
763 snprintf(port_monitor
.filter
, sizeof(port_monitor
.filter
),
764 "%s/monitor/%s", ServerBin
, job
->printer
->port_monitor
);
766 if (!cupsArrayAdd(filters
, &port_monitor
))
768 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
769 "Unable to add port monitor - %s", strerror(errno
));
771 abort_message
= "Stopping job because the scheduler ran out of memory.";
778 * Make sure we don't go over the "MAX_FILTERS" limit...
781 if (cupsArrayCount(filters
) > MAX_FILTERS
)
783 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
784 "Too many filters (%d > %d), unable to print.",
785 cupsArrayCount(filters
), MAX_FILTERS
);
787 abort_message
= "Aborting job because it needs too many filters to print.";
788 abort_state
= IPP_JOB_ABORTED
;
790 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
796 * Determine if we are printing a banner page or not...
799 if (job
->job_sheets
== NULL
)
801 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "No job-sheets attribute.");
802 if ((job
->job_sheets
=
803 ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_ZERO
)) != NULL
)
804 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
805 "... but someone added one without setting job_sheets.");
807 else if (job
->job_sheets
->num_values
== 1)
808 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s",
809 job
->job_sheets
->values
[0].string
.text
);
811 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s,%s",
812 job
->job_sheets
->values
[0].string
.text
,
813 job
->job_sheets
->values
[1].string
.text
);
815 if (job
->printer
->type
& CUPS_PRINTER_REMOTE
)
817 else if (job
->job_sheets
== NULL
)
819 else if (_cups_strcasecmp(job
->job_sheets
->values
[0].string
.text
, "none") != 0 &&
820 job
->current_file
== 0)
822 else if (job
->job_sheets
->num_values
> 1 &&
823 _cups_strcasecmp(job
->job_sheets
->values
[1].string
.text
, "none") != 0 &&
824 job
->current_file
== (job
->num_files
- 1))
829 if ((options
= get_options(job
, banner_page
, copies
, sizeof(copies
), title
,
830 sizeof(title
))) == NULL
)
832 abort_message
= "Stopping job because the scheduler ran out of memory.";
838 * Build the command-line arguments for the filters. Each filter
839 * has 6 or 7 arguments:
847 * argv[6] = filename (optional; normally stdin)
849 * This allows legacy printer drivers that use the old System V
850 * printing interface to be used by CUPS.
852 * For remote jobs, we send all of the files in the argument list.
855 if (job
->printer
->remote
)
856 argv
= calloc(7 + job
->num_files
, sizeof(char *));
858 argv
= calloc(8, sizeof(char *));
862 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Unable to allocate argument array - %s",
865 abort_message
= "Stopping job because the scheduler ran out of memory.";
870 sprintf(jobid
, "%d", job
->id
);
872 argv
[0] = job
->printer
->name
;
874 argv
[2] = job
->username
;
879 if (job
->printer
->remote
&& job
->num_files
> 1)
881 for (i
= 0; i
< job
->num_files
; i
++)
883 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
885 argv
[6 + i
] = strdup(filename
);
890 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
891 job
->id
, job
->current_file
+ 1);
895 for (i
= 0; argv
[i
]; i
++)
896 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "argv[%d]=\"%s\"", i
, argv
[i
]);
899 * Create environment variable strings for the filters...
902 attr
= ippFindAttribute(job
->attrs
, "attributes-natural-language",
906 strlcpy(apple_language
, "APPLE_LANGUAGE=", sizeof(apple_language
));
907 _cupsAppleLanguage(attr
->values
[0].string
.text
,
908 apple_language
+ 15, sizeof(apple_language
) - 15);
909 #endif /* __APPLE__ */
911 switch (strlen(attr
->values
[0].string
.text
))
915 * This is an unknown or badly formatted language code; use
916 * the POSIX locale...
919 strlcpy(lang
, "LANG=C", sizeof(lang
));
924 * Just the language code (ll)...
927 snprintf(lang
, sizeof(lang
), "LANG=%s.UTF-8",
928 attr
->values
[0].string
.text
);
933 * Language and country code (ll-cc)...
936 snprintf(lang
, sizeof(lang
), "LANG=%c%c_%c%c.UTF-8",
937 attr
->values
[0].string
.text
[0],
938 attr
->values
[0].string
.text
[1],
939 toupper(attr
->values
[0].string
.text
[3] & 255),
940 toupper(attr
->values
[0].string
.text
[4] & 255));
944 if ((attr
= ippFindAttribute(job
->attrs
, "document-format",
945 IPP_TAG_MIMETYPE
)) != NULL
&&
946 (ptr
= strstr(attr
->values
[0].string
.text
, "charset=")) != NULL
)
947 snprintf(charset
, sizeof(charset
), "CHARSET=%s", ptr
+ 8);
949 strlcpy(charset
, "CHARSET=utf-8", sizeof(charset
));
951 snprintf(content_type
, sizeof(content_type
), "CONTENT_TYPE=%s/%s",
952 job
->filetypes
[job
->current_file
]->super
,
953 job
->filetypes
[job
->current_file
]->type
);
954 snprintf(device_uri
, sizeof(device_uri
), "DEVICE_URI=%s",
955 job
->printer
->device_uri
);
956 snprintf(ppd
, sizeof(ppd
), "PPD=%s/ppd/%s.ppd", ServerRoot
,
958 snprintf(printer_info
, sizeof(printer_name
), "PRINTER_INFO=%s",
959 job
->printer
->info
? job
->printer
->info
: "");
960 snprintf(printer_location
, sizeof(printer_name
), "PRINTER_LOCATION=%s",
961 job
->printer
->location
? job
->printer
->location
: "");
962 snprintf(printer_name
, sizeof(printer_name
), "PRINTER=%s", job
->printer
->name
);
963 if (job
->printer
->num_reasons
> 0)
965 char *psrptr
; /* Pointer into PRINTER_STATE_REASONS */
966 size_t psrlen
; /* Size of PRINTER_STATE_REASONS */
968 for (psrlen
= 22, i
= 0; i
< job
->printer
->num_reasons
; i
++)
969 psrlen
+= strlen(job
->printer
->reasons
[i
]) + 1;
971 if ((printer_state_reasons
= malloc(psrlen
)) != NULL
)
974 * All of these strcpy's are safe because we allocated the psr string...
977 strlcpy(printer_state_reasons
, "PRINTER_STATE_REASONS=", psrlen
);
978 for (psrptr
= printer_state_reasons
+ 22, i
= 0;
979 i
< job
->printer
->num_reasons
;
984 strlcpy(psrptr
, job
->printer
->reasons
[i
],
985 psrlen
- (psrptr
- printer_state_reasons
));
986 psrptr
+= strlen(psrptr
);
990 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
992 if (job
->printer
->num_auth_info_required
== 1)
993 snprintf(auth_info_required
, sizeof(auth_info_required
),
994 "AUTH_INFO_REQUIRED=%s",
995 job
->printer
->auth_info_required
[0]);
996 else if (job
->printer
->num_auth_info_required
== 2)
997 snprintf(auth_info_required
, sizeof(auth_info_required
),
998 "AUTH_INFO_REQUIRED=%s,%s",
999 job
->printer
->auth_info_required
[0],
1000 job
->printer
->auth_info_required
[1]);
1001 else if (job
->printer
->num_auth_info_required
== 3)
1002 snprintf(auth_info_required
, sizeof(auth_info_required
),
1003 "AUTH_INFO_REQUIRED=%s,%s,%s",
1004 job
->printer
->auth_info_required
[0],
1005 job
->printer
->auth_info_required
[1],
1006 job
->printer
->auth_info_required
[2]);
1007 else if (job
->printer
->num_auth_info_required
== 4)
1008 snprintf(auth_info_required
, sizeof(auth_info_required
),
1009 "AUTH_INFO_REQUIRED=%s,%s,%s,%s",
1010 job
->printer
->auth_info_required
[0],
1011 job
->printer
->auth_info_required
[1],
1012 job
->printer
->auth_info_required
[2],
1013 job
->printer
->auth_info_required
[3]);
1015 strlcpy(auth_info_required
, "AUTH_INFO_REQUIRED=none",
1016 sizeof(auth_info_required
));
1018 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
1020 envp
[envc
++] = charset
;
1021 envp
[envc
++] = lang
;
1023 envp
[envc
++] = apple_language
;
1024 #endif /* __APPLE__ */
1025 envp
[envc
++] = ppd
;
1026 envp
[envc
++] = rip_max_cache
;
1027 envp
[envc
++] = content_type
;
1028 envp
[envc
++] = device_uri
;
1029 envp
[envc
++] = printer_info
;
1030 envp
[envc
++] = printer_location
;
1031 envp
[envc
++] = printer_name
;
1032 envp
[envc
++] = printer_state_reasons
? printer_state_reasons
:
1033 "PRINTER_STATE_REASONS=none";
1034 envp
[envc
++] = banner_page
? "CUPS_FILETYPE=job-sheet" :
1035 "CUPS_FILETYPE=document";
1037 if (!job
->printer
->remote
&& !job
->printer
->raw
)
1039 filter
= (mime_filter_t
*)cupsArrayLast(filters
);
1041 if (job
->printer
->port_monitor
)
1042 filter
= (mime_filter_t
*)cupsArrayPrev(filters
);
1044 if (filter
&& filter
->dst
)
1046 if ((ptr
= strchr(filter
->dst
->type
, '/')) != NULL
)
1047 snprintf(final_content_type
, sizeof(final_content_type
),
1048 "FINAL_CONTENT_TYPE=%s", ptr
+ 1);
1050 snprintf(final_content_type
, sizeof(final_content_type
),
1051 "FINAL_CONTENT_TYPE=%s/%s", filter
->dst
->super
,
1053 envp
[envc
++] = final_content_type
;
1057 if (Classification
&& !banner_page
)
1059 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
1060 IPP_TAG_NAME
)) == NULL
)
1061 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1063 else if (attr
->num_values
> 1 &&
1064 strcmp(attr
->values
[1].string
.text
, "none") != 0)
1065 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1066 attr
->values
[1].string
.text
);
1068 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1069 attr
->values
[0].string
.text
);
1071 envp
[envc
++] = classification
;
1074 if (job
->dtype
& CUPS_PRINTER_CLASS
)
1076 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
1077 envp
[envc
++] = class_name
;
1080 envp
[envc
++] = auth_info_required
;
1083 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1085 if (job
->auth_env
[i
])
1086 envp
[envc
++] = job
->auth_env
[i
];
1091 envp
[envc
++] = job
->auth_uid
;
1095 for (i
= 0; i
< envc
; i
++)
1096 if (!strncmp(envp
[i
], "AUTH_", 5))
1097 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"AUTH_%c****\"", i
,
1099 else if (strncmp(envp
[i
], "DEVICE_URI=", 11))
1100 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"%s\"", i
, envp
[i
]);
1102 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"DEVICE_URI=%s\"", i
,
1103 job
->printer
->sanitized_device_uri
);
1105 if (job
->printer
->remote
)
1106 job
->current_file
= job
->num_files
;
1108 job
->current_file
++;
1111 * Now create processes for all of the filters...
1114 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
1115 "cups-insecure-filter-warning");
1117 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
1119 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
1121 if (filter
->filter
[0] != '/')
1122 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
1125 strlcpy(command
, filter
->filter
, sizeof(command
));
1127 if (i
< (cupsArrayCount(filters
) - 1))
1129 if (cupsdOpenPipe(filterfds
[slot
]))
1131 abort_message
= "Stopping job because the scheduler could not create "
1132 "the filter pipes.";
1139 if (job
->current_file
== 1 ||
1140 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1142 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1144 if (cupsdOpenPipe(job
->print_pipes
))
1146 abort_message
= "Stopping job because the scheduler could not "
1147 "create the backend pipes.";
1154 job
->print_pipes
[0] = -1;
1155 if (!strcmp(job
->printer
->device_uri
, "file:/dev/null") ||
1156 !strcmp(job
->printer
->device_uri
, "file:///dev/null"))
1157 job
->print_pipes
[1] = -1;
1160 if (!strncmp(job
->printer
->device_uri
, "file:/dev/", 10))
1161 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1163 else if (!strncmp(job
->printer
->device_uri
, "file:///dev/", 12))
1164 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1166 else if (!strncmp(job
->printer
->device_uri
, "file:///", 8))
1167 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1168 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1170 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1171 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1173 if (job
->print_pipes
[1] < 0)
1175 abort_message
= "Stopping job because the scheduler could not "
1176 "open the output file.";
1181 fcntl(job
->print_pipes
[1], F_SETFD
,
1182 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
1187 filterfds
[slot
][0] = job
->print_pipes
[0];
1188 filterfds
[slot
][1] = job
->print_pipes
[1];
1191 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1192 filterfds
[slot
][1], job
->status_pipes
[1],
1193 job
->back_pipes
[0], job
->side_pipes
[0], 0,
1194 job
->profile
, job
, job
->filters
+ i
);
1196 cupsdClosePipe(filterfds
[!slot
]);
1200 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
1201 filter
->filter
, strerror(errno
));
1203 abort_message
= "Stopping job because the scheduler could not execute a "
1209 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started filter %s (PID %d)", command
,
1216 cupsArrayDelete(filters
);
1220 * Finally, pipe the final output into a backend process if needed...
1223 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1225 if (job
->current_file
== 1 || job
->printer
->remote
||
1226 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1228 sscanf(job
->printer
->device_uri
, "%254[^:]", scheme
);
1229 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, scheme
);
1232 * See if the backend needs to run as root...
1237 else if (stat(command
, &backinfo
))
1240 backroot
= !(backinfo
.st_mode
& (S_IRWXG
| S_IRWXO
));
1242 argv
[0] = job
->printer
->sanitized_device_uri
;
1244 filterfds
[slot
][0] = -1;
1245 filterfds
[slot
][1] = -1;
1247 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1248 filterfds
[slot
][1], job
->status_pipes
[1],
1249 job
->back_pipes
[1], job
->side_pipes
[1],
1250 backroot
, job
->profile
, job
, &(job
->backend
));
1254 abort_message
= "Stopping job because the sheduler could not execute "
1261 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started backend %s (PID %d)",
1266 if (job
->current_file
== job
->num_files
||
1267 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1268 cupsdClosePipe(job
->print_pipes
);
1270 if (job
->current_file
== job
->num_files
)
1272 cupsdClosePipe(job
->back_pipes
);
1273 cupsdClosePipe(job
->side_pipes
);
1275 close(job
->status_pipes
[1]);
1276 job
->status_pipes
[1] = -1;
1281 filterfds
[slot
][0] = -1;
1282 filterfds
[slot
][1] = -1;
1284 if (job
->current_file
== job
->num_files
||
1285 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1286 cupsdClosePipe(job
->print_pipes
);
1288 if (job
->current_file
== job
->num_files
)
1290 close(job
->status_pipes
[1]);
1291 job
->status_pipes
[1] = -1;
1295 cupsdClosePipe(filterfds
[slot
]);
1297 if (job
->printer
->remote
&& job
->num_files
> 1)
1299 for (i
= 0; i
< job
->num_files
; i
++)
1304 if (printer_state_reasons
)
1305 free(printer_state_reasons
);
1307 cupsdAddSelect(job
->status_buffer
->fd
, (cupsd_selfunc_t
)update_job
, NULL
,
1310 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
1317 * If we get here, we need to abort the current job and close out all
1318 * files and pipes...
1323 FilterLevel
-= job
->cost
;
1326 for (slot
= 0; slot
< 2; slot
++)
1327 cupsdClosePipe(filterfds
[slot
]);
1329 cupsArrayDelete(filters
);
1333 if (job
->printer
->remote
&& job
->num_files
> 1)
1335 for (i
= 0; i
< job
->num_files
; i
++)
1342 if (printer_state_reasons
)
1343 free(printer_state_reasons
);
1345 cupsdClosePipe(job
->print_pipes
);
1346 cupsdClosePipe(job
->back_pipes
);
1347 cupsdClosePipe(job
->side_pipes
);
1349 cupsdRemoveSelect(job
->status_pipes
[0]);
1350 cupsdClosePipe(job
->status_pipes
);
1351 cupsdStatBufDelete(job
->status_buffer
);
1352 job
->status_buffer
= NULL
;
1355 * Update the printer and job state.
1358 cupsdSetJobState(job
, abort_state
, CUPSD_JOB_DEFAULT
, "%s", abort_message
);
1359 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_IDLE
, 0);
1360 update_job_attrs(job
, 0);
1363 free_job_history(job
);
1365 cupsArrayRemove(PrintingJobs
, job
);
1368 * Clear the printer <-> job association...
1371 job
->printer
->job
= NULL
;
1372 job
->printer
= NULL
;
1377 * 'cupsdDeleteJob()' - Free all memory used by a job.
1381 cupsdDeleteJob(cupsd_job_t
*job
, /* I - Job */
1382 cupsd_jobaction_t action
)/* I - Action */
1384 int i
; /* Looping var */
1388 finalize_job(job
, 1);
1390 if (action
== CUPSD_JOB_PURGE
)
1391 remove_job_history(job
);
1393 cupsdClearString(&job
->username
);
1394 cupsdClearString(&job
->dest
);
1396 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1398 cupsdClearString(job
->auth_env
+ i
);
1399 cupsdClearString(&job
->auth_uid
);
1401 if (action
== CUPSD_JOB_PURGE
)
1402 remove_job_files(job
);
1403 else if (job
->num_files
> 0)
1405 free(job
->compressions
);
1406 free(job
->filetypes
);
1412 free_job_history(job
);
1416 cupsArrayRemove(Jobs
, job
);
1417 cupsArrayRemove(ActiveJobs
, job
);
1418 cupsArrayRemove(PrintingJobs
, job
);
1425 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1429 cupsdFreeAllJobs(void)
1431 cupsd_job_t
*job
; /* Current job */
1439 cupsdStopAllJobs(CUPSD_JOB_FORCE
, 0);
1442 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1444 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1445 cupsdDeleteJob(job
, CUPSD_JOB_DEFAULT
);
1447 cupsdReleaseSignals();
1452 * 'cupsdFindJob()' - Find the specified job.
1455 cupsd_job_t
* /* O - Job data */
1456 cupsdFindJob(int id
) /* I - Job ID */
1458 cupsd_job_t key
; /* Search key */
1463 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
1468 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1469 * or held jobs in a printer or class.
1472 int /* O - Job count */
1473 cupsdGetPrinterJobCount(
1474 const char *dest
) /* I - Printer or class name */
1476 int count
; /* Job count */
1477 cupsd_job_t
*job
; /* Current job */
1480 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1482 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1483 if (job
->dest
&& !_cups_strcasecmp(job
->dest
, dest
))
1491 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1492 * or held jobs for a user.
1495 int /* O - Job count */
1496 cupsdGetUserJobCount(
1497 const char *username
) /* I - Username */
1499 int count
; /* Job count */
1500 cupsd_job_t
*job
; /* Current job */
1503 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1505 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1506 if (!_cups_strcasecmp(job
->username
, username
))
1514 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1518 cupsdLoadAllJobs(void)
1520 char filename
[1024]; /* Full filename of job.cache file */
1521 struct stat fileinfo
, /* Information on job.cache file */
1522 dirinfo
; /* Information on RequestRoot dir */
1527 * Create the job arrays as needed...
1531 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1534 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1537 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1540 * See whether the job.cache file is older than the RequestRoot directory...
1543 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1545 if (stat(filename
, &fileinfo
))
1547 fileinfo
.st_mtime
= 0;
1549 if (errno
!= ENOENT
)
1550 cupsdLogMessage(CUPSD_LOG_ERROR
,
1551 "Unable to get file information for \"%s\" - %s",
1552 filename
, strerror(errno
));
1555 if (stat(RequestRoot
, &dirinfo
))
1557 dirinfo
.st_mtime
= 0;
1559 if (errno
!= ENOENT
)
1560 cupsdLogMessage(CUPSD_LOG_ERROR
,
1561 "Unable to get directory information for \"%s\" - %s",
1562 RequestRoot
, strerror(errno
));
1566 * Load the most recent source for job data...
1569 if (dirinfo
.st_mtime
> fileinfo
.st_mtime
)
1571 load_request_root();
1573 load_next_job_id(filename
);
1576 load_job_cache(filename
);
1579 * Clean out old jobs as needed...
1582 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1588 * 'cupsdLoadJob()' - Load a single job.
1591 int /* O - 1 on success, 0 on failure */
1592 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1594 int i
; /* Looping var */
1595 char jobfile
[1024]; /* Job filename */
1596 cups_file_t
*fp
; /* Job file */
1597 int fileid
; /* Current file ID */
1598 ipp_attribute_t
*attr
; /* Job attribute */
1599 const char *dest
; /* Destination name */
1600 cupsd_printer_t
*destptr
; /* Pointer to destination */
1601 mime_type_t
**filetypes
; /* New filetypes array */
1602 int *compressions
; /* New compressions array */
1607 if (job
->state_value
> IPP_JOB_STOPPED
)
1608 job
->access_time
= time(NULL
);
1613 if ((job
->attrs
= ippNew()) == NULL
)
1615 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes.");
1620 * Load job attributes...
1623 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading attributes...", job
->id
);
1625 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1626 if ((fp
= cupsdOpenConfFile(jobfile
)) == NULL
)
1629 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1631 cupsdLogMessage(CUPSD_LOG_ERROR
,
1632 "[Job %d] Unable to read job control file \"%s\".", job
->id
,
1641 * Copy attribute data to the job object...
1644 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1646 cupsdLogMessage(CUPSD_LOG_ERROR
,
1647 "[Job %d] Missing or bad time-at-creation attribute in "
1648 "control file.", job
->id
);
1652 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1653 IPP_TAG_ENUM
)) == NULL
)
1655 cupsdLogMessage(CUPSD_LOG_ERROR
,
1656 "[Job %d] Missing or bad job-state attribute in control "
1661 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1663 job
->history_time
= 0;
1665 if (job
->state_value
>= IPP_JOB_CANCELED
&&
1666 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
1667 IPP_TAG_INTEGER
)) != NULL
)
1669 if (JobHistory
< INT_MAX
)
1670 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
1672 job
->history_time
= INT_MAX
;
1674 if (job
->history_time
< time(NULL
))
1675 goto error
; /* Expired, remove from history */
1677 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1678 JobHistoryUpdate
= job
->history_time
;
1680 if (JobFiles
< INT_MAX
)
1681 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
1683 job
->file_time
= INT_MAX
;
1685 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1686 JobHistoryUpdate
= job
->file_time
;
1688 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdLoadJob: JobHistoryUpdate=%ld",
1689 (long)JobHistoryUpdate
);
1694 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1695 IPP_TAG_URI
)) == NULL
)
1697 cupsdLogMessage(CUPSD_LOG_ERROR
,
1698 "[Job %d] No job-printer-uri attribute in control file.",
1703 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1706 cupsdLogMessage(CUPSD_LOG_ERROR
,
1707 "[Job %d] Unable to queue job for destination \"%s\".",
1708 job
->id
, attr
->values
[0].string
.text
);
1712 cupsdSetString(&job
->dest
, dest
);
1714 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1716 cupsdLogMessage(CUPSD_LOG_ERROR
,
1717 "[Job %d] Unable to queue job for destination \"%s\".",
1718 job
->id
, job
->dest
);
1722 if ((job
->reasons
= ippFindAttribute(job
->attrs
, "job-state-reasons",
1723 IPP_TAG_KEYWORD
)) == NULL
)
1725 const char *reason
; /* job-state-reason keyword */
1727 cupsdLogMessage(CUPSD_LOG_DEBUG
,
1728 "[Job %d] Adding missing job-state-reasons attribute to "
1729 " control file.", job
->id
);
1731 switch (job
->state_value
)
1734 case IPP_JOB_PENDING
:
1735 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1736 reason
= "printer-stopped";
1742 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1743 IPP_TAG_ZERO
)) != NULL
&&
1744 (attr
->value_tag
== IPP_TAG_NAME
||
1745 attr
->value_tag
== IPP_TAG_NAMELANG
||
1746 attr
->value_tag
== IPP_TAG_KEYWORD
) &&
1747 strcmp(attr
->values
[0].string
.text
, "no-hold"))
1748 reason
= "job-hold-until-specified";
1750 reason
= "job-incoming";
1753 case IPP_JOB_PROCESSING
:
1754 reason
= "job-printing";
1757 case IPP_JOB_STOPPED
:
1758 reason
= "job-stopped";
1761 case IPP_JOB_CANCELED
:
1762 reason
= "job-canceled-by-user";
1765 case IPP_JOB_ABORTED
:
1766 reason
= "aborted-by-system";
1769 case IPP_JOB_COMPLETED
:
1770 reason
= "job-completed-successfully";
1774 job
->reasons
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
1775 "job-state-reasons", NULL
, reason
);
1777 else if (job
->state_value
== IPP_JOB_PENDING
)
1779 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1780 ippSetString(job
->attrs
, &job
->reasons
, 0, "printer-stopped");
1782 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
1785 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed",
1787 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1791 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1792 IPP_TAG_INTEGER
)) == NULL
)
1794 cupsdLogMessage(CUPSD_LOG_ERROR
,
1795 "[Job %d] Missing or bad job-priority attribute in "
1796 "control file.", job
->id
);
1800 job
->priority
= attr
->values
[0].integer
;
1805 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1806 IPP_TAG_NAME
)) == NULL
)
1808 cupsdLogMessage(CUPSD_LOG_ERROR
,
1809 "[Job %d] Missing or bad job-originating-user-name "
1810 "attribute in control file.", job
->id
);
1814 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1818 * Set the job hold-until time and state...
1821 if (job
->state_value
== IPP_JOB_HELD
)
1823 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1824 IPP_TAG_KEYWORD
)) == NULL
)
1825 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1828 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1831 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1832 job
->state_value
= IPP_JOB_PENDING
;
1835 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1837 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1838 job
->state_value
= IPP_JOB_PENDING
;
1841 if (!job
->num_files
)
1844 * Find all the d##### files...
1847 for (fileid
= 1; fileid
< 10000; fileid
++)
1849 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1852 if (access(jobfile
, 0))
1855 cupsdLogMessage(CUPSD_LOG_DEBUG
,
1856 "[Job %d] Auto-typing document file \"%s\"...", job
->id
,
1859 if (fileid
> job
->num_files
)
1861 if (job
->num_files
== 0)
1863 compressions
= (int *)calloc(fileid
, sizeof(int));
1864 filetypes
= (mime_type_t
**)calloc(fileid
, sizeof(mime_type_t
*));
1868 compressions
= (int *)realloc(job
->compressions
,
1869 sizeof(int) * fileid
);
1870 filetypes
= (mime_type_t
**)realloc(job
->filetypes
,
1871 sizeof(mime_type_t
*) *
1875 if (!compressions
|| !filetypes
)
1877 cupsdLogMessage(CUPSD_LOG_ERROR
,
1878 "[Job %d] Ran out of memory for job file types.",
1881 ippDelete(job
->attrs
);
1890 if (job
->compressions
)
1892 free(job
->compressions
);
1893 job
->compressions
= NULL
;
1898 free(job
->filetypes
);
1899 job
->filetypes
= NULL
;
1906 job
->compressions
= compressions
;
1907 job
->filetypes
= filetypes
;
1908 job
->num_files
= fileid
;
1911 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1912 job
->compressions
+ fileid
- 1);
1914 if (!job
->filetypes
[fileid
- 1])
1915 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1921 * Load authentication information as needed...
1924 if (job
->state_value
< IPP_JOB_STOPPED
)
1926 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1929 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1931 cupsdClearString(job
->auth_env
+ i
);
1932 cupsdClearString(&job
->auth_uid
);
1934 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
1936 int bytes
, /* Size of auth data */
1937 linenum
= 1; /* Current line number */
1938 char line
[65536], /* Line from file */
1939 *value
, /* Value from line */
1940 data
[65536]; /* Decoded data */
1943 if (cupsFileGets(fp
, line
, sizeof(line
)) &&
1944 !strcmp(line
, "CUPSD-AUTH-V2"))
1947 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
1953 bytes
= sizeof(data
);
1954 httpDecode64_2(data
, &bytes
, value
);
1957 * Assign environment variables...
1960 if (!strcmp(line
, "uid"))
1962 cupsdSetStringf(&job
->auth_uid
, "AUTH_UID=%s", value
);
1965 else if (i
>= (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0])))
1968 if (!strcmp(line
, "username"))
1969 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_USERNAME=%s", data
);
1970 else if (!strcmp(line
, "domain"))
1971 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_DOMAIN=%s", data
);
1972 else if (!strcmp(line
, "password"))
1973 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_PASSWORD=%s", data
);
1974 else if (!strcmp(line
, "negotiate"))
1975 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_NEGOTIATE=%s", data
);
1987 job
->access_time
= time(NULL
);
1991 * If we get here then something bad happened...
1996 ippDelete(job
->attrs
);
1999 remove_job_history(job
);
2000 remove_job_files(job
);
2007 * 'cupsdMoveJob()' - Move the specified job to a different destination.
2011 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
2012 cupsd_printer_t
*p
) /* I - Destination printer or class */
2014 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
2015 const char *olddest
; /* Old destination */
2016 cupsd_printer_t
*oldp
; /* Old pointer */
2020 * Don't move completed jobs...
2023 if (job
->state_value
> IPP_JOB_STOPPED
)
2027 * Get the old destination...
2030 olddest
= job
->dest
;
2033 oldp
= job
->printer
;
2035 oldp
= cupsdFindDest(olddest
);
2038 * Change the destination information...
2041 if (job
->state_value
> IPP_JOB_HELD
)
2042 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2043 "Stopping job prior to move.");
2045 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
2046 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2049 cupsdSetString(&job
->dest
, p
->name
);
2050 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
);
2052 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
2053 IPP_TAG_URI
)) != NULL
)
2054 cupsdSetString(&(attr
->values
[0].string
.text
), p
->uri
);
2056 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
2057 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2061 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2066 * 'cupsdReleaseJob()' - Release the specified job.
2070 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
2072 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
2075 if (job
->state_value
== IPP_JOB_HELD
)
2078 * Add trailing banner as needed...
2081 if (job
->pending_timeout
)
2082 cupsdTimeoutJob(job
);
2084 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2085 "Job released by user.");
2091 * 'cupsdRestartJob()' - Restart the specified job.
2095 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
2097 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
2100 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
2101 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2102 "Job restarted by user.");
2107 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2111 cupsdSaveAllJobs(void)
2113 int i
; /* Looping var */
2114 cups_file_t
*fp
; /* job.cache file */
2115 char filename
[1024], /* job.cache filename */
2116 temp
[1024]; /* Temporary string */
2117 cupsd_job_t
*job
; /* Current job */
2118 time_t curtime
; /* Current time */
2119 struct tm
*curdate
; /* Current date */
2122 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
2123 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
)) == NULL
)
2126 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job.cache...");
2129 * Write a small header to the file...
2132 curtime
= time(NULL
);
2133 curdate
= localtime(&curtime
);
2134 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
2136 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
2137 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
2138 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
2141 * Write each job known to the system...
2144 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2146 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2148 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
2149 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
2150 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
2151 cupsFilePrintf(fp
, "HoldUntil %d\n", (int)job
->hold_until
);
2152 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
2153 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
2154 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
2155 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
2156 for (i
= 0; i
< job
->num_files
; i
++)
2157 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
2158 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
2159 cupsFilePuts(fp
, "</Job>\n");
2162 cupsdCloseCreatedConfFile(fp
, filename
);
2167 * 'cupsdSaveJob()' - Save a job to disk.
2171 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
2173 char filename
[1024]; /* Job control filename */
2174 cups_file_t
*fp
; /* Job file */
2177 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2178 job
, job
->id
, job
->attrs
);
2180 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
2182 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
& 0600)) == NULL
)
2185 fchown(cupsFileNumber(fp
), RunUser
, Group
);
2187 job
->attrs
->state
= IPP_IDLE
;
2189 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
2190 job
->attrs
) != IPP_DATA
)
2192 cupsdLogMessage(CUPSD_LOG_ERROR
,
2193 "[Job %d] Unable to write job control file.", job
->id
);
2198 if (!cupsdCloseCreatedConfFile(fp
, filename
))
2204 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2208 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
2209 const char *when
, /* I - When to resume */
2210 int update
)/* I - Update job-hold-until attr? */
2212 time_t curtime
; /* Current time */
2213 struct tm
*curdate
; /* Current date */
2214 int hour
; /* Hold hour */
2215 int minute
; /* Hold minute */
2216 int second
= 0; /* Hold second */
2219 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2220 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2221 job
, job
->id
, when
, update
);
2226 * Update the job-hold-until attribute...
2229 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2231 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2232 IPP_TAG_KEYWORD
)) == NULL
)
2233 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2236 cupsdSetString(&(attr
->values
[0].string
.text
), when
);
2238 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2239 "job-hold-until", NULL
, when
);
2243 if (isdigit(when
[0] & 255))
2244 attr
->value_tag
= IPP_TAG_NAME
;
2246 attr
->value_tag
= IPP_TAG_KEYWORD
;
2249 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2252 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-hold-until-specified");
2256 * Update the hold time...
2259 job
->cancel_time
= 0;
2261 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2264 * Hold indefinitely...
2267 job
->hold_until
= 0;
2269 if (MaxHoldTime
> 0)
2270 job
->cancel_time
= time(NULL
) + MaxHoldTime
;
2272 else if (!strcmp(when
, "day-time"))
2275 * Hold to 6am the next morning unless local time is < 6pm.
2278 curtime
= time(NULL
);
2279 curdate
= localtime(&curtime
);
2281 if (curdate
->tm_hour
< 18)
2282 job
->hold_until
= curtime
;
2284 job
->hold_until
= curtime
+
2285 ((29 - curdate
->tm_hour
) * 60 + 59 -
2286 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2288 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2291 * Hold to 6pm unless local time is > 6pm or < 6am.
2294 curtime
= time(NULL
);
2295 curdate
= localtime(&curtime
);
2297 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2298 job
->hold_until
= curtime
;
2300 job
->hold_until
= curtime
+
2301 ((17 - curdate
->tm_hour
) * 60 + 59 -
2302 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2304 else if (!strcmp(when
, "second-shift"))
2307 * Hold to 4pm unless local time is > 4pm.
2310 curtime
= time(NULL
);
2311 curdate
= localtime(&curtime
);
2313 if (curdate
->tm_hour
>= 16)
2314 job
->hold_until
= curtime
;
2316 job
->hold_until
= curtime
+
2317 ((15 - curdate
->tm_hour
) * 60 + 59 -
2318 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2320 else if (!strcmp(when
, "third-shift"))
2323 * Hold to 12am unless local time is < 8am.
2326 curtime
= time(NULL
);
2327 curdate
= localtime(&curtime
);
2329 if (curdate
->tm_hour
< 8)
2330 job
->hold_until
= curtime
;
2332 job
->hold_until
= curtime
+
2333 ((23 - curdate
->tm_hour
) * 60 + 59 -
2334 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2336 else if (!strcmp(when
, "weekend"))
2339 * Hold to weekend unless we are in the weekend.
2342 curtime
= time(NULL
);
2343 curdate
= localtime(&curtime
);
2345 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2346 job
->hold_until
= curtime
;
2348 job
->hold_until
= curtime
+
2349 (((5 - curdate
->tm_wday
) * 24 +
2350 (17 - curdate
->tm_hour
)) * 60 + 59 -
2351 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2353 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2356 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2359 curtime
= time(NULL
);
2360 curdate
= gmtime(&curtime
);
2362 job
->hold_until
= curtime
+
2363 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2364 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2367 * Hold until next day as needed...
2370 if (job
->hold_until
< curtime
)
2371 job
->hold_until
+= 24 * 60 * 60;
2374 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2375 (int)job
->hold_until
);
2380 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2381 * the list as needed.
2385 cupsdSetJobPriority(
2386 cupsd_job_t
*job
, /* I - Job ID */
2387 int priority
) /* I - New priority (0 to 100) */
2389 ipp_attribute_t
*attr
; /* Job attribute */
2393 * Don't change completed jobs...
2396 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2400 * Set the new priority and re-add the job into the active list...
2403 cupsArrayRemove(ActiveJobs
, job
);
2405 job
->priority
= priority
;
2407 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2408 IPP_TAG_INTEGER
)) != NULL
)
2409 attr
->values
[0].integer
= priority
;
2411 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2414 cupsArrayAdd(ActiveJobs
, job
);
2417 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2422 * 'cupsdSetJobState()' - Set the state of the specified print job.
2427 cupsd_job_t
*job
, /* I - Job to cancel */
2428 ipp_jstate_t newstate
, /* I - New job state */
2429 cupsd_jobaction_t action
, /* I - Action to take */
2430 const char *message
, /* I - Message to log */
2431 ...) /* I - Additional arguments as needed */
2433 int i
; /* Looping var */
2434 ipp_jstate_t oldstate
; /* Old state */
2435 char filename
[1024]; /* Job filename */
2436 ipp_attribute_t
*attr
; /* Job attribute */
2439 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2440 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2441 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2442 newstate
, action
, message
? message
: "(null)");
2446 * Make sure we have the job attributes...
2449 if (!cupsdLoadJob(job
))
2453 * Don't do anything if the state is unchanged and we aren't purging the
2457 oldstate
= job
->state_value
;
2458 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2462 * Stop any processes that are working on the current job...
2465 if (oldstate
== IPP_JOB_PROCESSING
)
2466 stop_job(job
, action
);
2469 * Set the new job state...
2472 job
->state
->values
[0].integer
= newstate
;
2473 job
->state_value
= newstate
;
2477 case IPP_JOB_PENDING
:
2479 * Update job-hold-until as needed...
2482 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2483 IPP_TAG_KEYWORD
)) == NULL
)
2484 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2488 attr
->value_tag
= IPP_TAG_KEYWORD
;
2489 cupsdSetString(&(attr
->values
[0].string
.text
), "no-hold");
2495 case IPP_JOB_ABORTED
:
2496 case IPP_JOB_CANCELED
:
2497 case IPP_JOB_COMPLETED
:
2498 set_time(job
, "time-at-completed");
2499 ippSetString(job
->attrs
, &job
->reasons
, 0, "processing-to-stop-point");
2504 * Log message as needed...
2509 char buffer
[2048]; /* Message buffer */
2510 va_list ap
; /* Pointer to additional arguments */
2512 va_start(ap
, message
);
2513 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2516 if (newstate
> IPP_JOB_STOPPED
)
2517 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2519 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2521 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2522 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2524 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2528 * Handle post-state-change actions...
2533 case IPP_JOB_PROCESSING
:
2535 * Add the job to the "printing" list...
2538 if (!cupsArrayFind(PrintingJobs
, job
))
2539 cupsArrayAdd(PrintingJobs
, job
);
2542 * Set the processing time...
2545 set_time(job
, "time-at-processing");
2547 case IPP_JOB_PENDING
:
2549 case IPP_JOB_STOPPED
:
2551 * Make sure the job is in the active list...
2554 if (!cupsArrayFind(ActiveJobs
, job
))
2555 cupsArrayAdd(ActiveJobs
, job
);
2558 * Save the job state to disk...
2562 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2565 case IPP_JOB_ABORTED
:
2566 case IPP_JOB_CANCELED
:
2567 case IPP_JOB_COMPLETED
:
2568 if (newstate
== IPP_JOB_CANCELED
)
2571 * Remove the job from the active list if there are no processes still
2575 for (i
= 0; job
->filters
[i
] < 0; i
++);
2577 if (!job
->filters
[i
] && job
->backend
<= 0)
2578 cupsArrayRemove(ActiveJobs
, job
);
2583 * Otherwise just remove the job from the active list immediately...
2586 cupsArrayRemove(ActiveJobs
, job
);
2590 * Expire job subscriptions since the job is now "completed"...
2593 cupsdExpireSubscriptions(NULL
, job
);
2597 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2598 * sleep to happen immediately...
2601 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2603 #endif /* __APPLE__ */
2606 * Remove any authentication data...
2609 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2610 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2611 cupsdLogMessage(CUPSD_LOG_ERROR
,
2612 "Unable to remove authentication cache: %s",
2616 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
2618 cupsdClearString(job
->auth_env
+ i
);
2620 cupsdClearString(&job
->auth_uid
);
2623 * Remove the print file for good if we aren't preserving jobs or
2627 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2628 remove_job_files(job
);
2630 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2633 * Save job state info...
2637 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2639 else if (!job
->printer
)
2642 * Delete the job immediately if not actively printing...
2645 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2652 * Finalize the job immediately if we forced things...
2655 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2656 finalize_job(job
, 0);
2659 * Update the server "busy" state...
2662 cupsdSetBusyState();
2667 * 'cupsdStopAllJobs()' - Stop all print jobs.
2672 cupsd_jobaction_t action
, /* I - Action */
2673 int kill_delay
) /* I - Number of seconds before we kill */
2675 cupsd_job_t
*job
; /* Current job */
2678 DEBUG_puts("cupsdStopAllJobs()");
2680 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2682 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2685 job
->kill_time
= time(NULL
) + kill_delay
;
2687 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2693 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2697 cupsdUnloadCompletedJobs(void)
2699 cupsd_job_t
*job
; /* Current job */
2700 time_t expire
; /* Expiration time */
2703 expire
= time(NULL
) - 60;
2705 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2707 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2708 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2709 job
->access_time
< expire
)
2720 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2724 cupsdUpdateJobs(void)
2726 cupsd_job_t
*job
; /* Current job */
2727 time_t curtime
; /* Current time */
2728 ipp_attribute_t
*attr
; /* time-at-completed attribute */
2731 curtime
= time(NULL
);
2732 JobHistoryUpdate
= 0;
2734 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2736 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2738 if (job
->state_value
>= IPP_JOB_CANCELED
&&
2739 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
2740 IPP_TAG_INTEGER
)) != NULL
)
2743 * Update history/file expiration times...
2746 if (JobHistory
< INT_MAX
)
2747 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
2749 job
->history_time
= INT_MAX
;
2751 if (job
->history_time
< curtime
)
2753 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2757 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2758 JobHistoryUpdate
= job
->history_time
;
2760 if (JobFiles
< INT_MAX
)
2761 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
2763 job
->file_time
= INT_MAX
;
2765 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2766 JobHistoryUpdate
= job
->file_time
;
2770 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdUpdateAllJobs: JobHistoryUpdate=%ld",
2771 (long)JobHistoryUpdate
);
2776 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2779 static int /* O - Difference */
2780 compare_active_jobs(void *first
, /* I - First job */
2781 void *second
, /* I - Second job */
2782 void *data
) /* I - App data (not used) */
2784 int diff
; /* Difference */
2789 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2790 ((cupsd_job_t
*)first
)->priority
) != 0)
2793 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2798 * 'compare_jobs()' - Compare the job IDs of two jobs.
2801 static int /* O - Difference */
2802 compare_jobs(void *first
, /* I - First job */
2803 void *second
, /* I - Second job */
2804 void *data
) /* I - App data (not used) */
2808 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2813 * 'dump_job_history()' - Dump any debug messages for a job.
2817 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2819 int i
, /* Looping var */
2820 oldsize
; /* Current MaxLogSize */
2821 struct tm
*date
; /* Date/time value */
2822 cupsd_joblog_t
*message
; /* Current message */
2823 char temp
[2048], /* Log message */
2824 *ptr
, /* Pointer into log message */
2825 start
[256], /* Start time */
2826 end
[256]; /* End time */
2827 cupsd_printer_t
*printer
; /* Printer for job */
2831 * See if we have anything to dump...
2838 * Disable log rotation temporarily...
2841 oldsize
= MaxLogSize
;
2845 * Copy the debug messages to the log...
2848 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2849 date
= localtime(&(message
->time
));
2850 strftime(start
, sizeof(start
), "%X", date
);
2852 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2853 date
= localtime(&(message
->time
));
2854 strftime(end
, sizeof(end
), "%X", date
);
2856 snprintf(temp
, sizeof(temp
),
2857 "[Job %d] The following messages were recorded from %s to %s",
2858 job
->id
, start
, end
);
2859 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2861 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2863 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
2864 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
2866 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
2867 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2870 * Log the printer state values...
2873 if ((printer
= job
->printer
) == NULL
)
2874 printer
= cupsdFindDest(job
->dest
);
2878 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
2880 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
2881 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
2883 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2885 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
2886 job
->id
, printer
->state_message
);
2887 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2889 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
2890 ptr
= temp
+ strlen(temp
);
2891 if (printer
->num_reasons
== 0)
2892 strlcpy(ptr
, "none", sizeof(temp
) - (ptr
- temp
));
2896 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
2902 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (ptr
- temp
));
2906 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2910 * Restore log file rotation...
2913 MaxLogSize
= oldsize
;
2916 * Free all messages...
2919 free_job_history(job
);
2924 * 'free_job_history()' - Free any log history.
2928 free_job_history(cupsd_job_t
*job
) /* I - Job */
2930 char *message
; /* Current message */
2936 for (message
= (char *)cupsArrayFirst(job
->history
);
2938 message
= (char *)cupsArrayNext(job
->history
))
2941 cupsArrayDelete(job
->history
);
2942 job
->history
= NULL
;
2947 * 'finalize_job()' - Cleanup after job filter processes and support data.
2951 finalize_job(cupsd_job_t
*job
, /* I - Job */
2952 int set_job_state
) /* I - 1 = set the job state */
2954 ipp_pstate_t printer_state
; /* New printer state value */
2955 ipp_jstate_t job_state
; /* New job state value */
2956 const char *message
; /* Message for job state */
2957 char buffer
[1024]; /* Buffer for formatted messages */
2960 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
2963 * Clear the "connecting-to-device" reason, which is only valid when a printer
2964 * is processing, along with any remote printing job state...
2967 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device,"
2968 "cups-remote-pending,"
2969 "cups-remote-pending-held,"
2970 "cups-remote-processing,"
2971 "cups-remote-stopped,"
2972 "cups-remote-canceled,"
2973 "cups-remote-aborted,"
2974 "cups-remote-completed");
2977 * Similarly, clear the "offline-report" reason for non-USB devices since we
2978 * rarely have current information for network devices...
2981 if (strncmp(job
->printer
->device_uri
, "usb:", 4) &&
2982 strncmp(job
->printer
->device_uri
, "ippusb:", 7))
2983 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
2986 * Free the security profile...
2989 cupsdDestroyProfile(job
->profile
);
2990 job
->profile
= NULL
;
2993 * Clear the unresponsive job watchdog timers...
2996 job
->cancel_time
= 0;
3000 * Close pipes and status buffer...
3003 cupsdClosePipe(job
->print_pipes
);
3004 cupsdClosePipe(job
->back_pipes
);
3005 cupsdClosePipe(job
->side_pipes
);
3007 cupsdRemoveSelect(job
->status_pipes
[0]);
3008 cupsdClosePipe(job
->status_pipes
);
3009 cupsdStatBufDelete(job
->status_buffer
);
3010 job
->status_buffer
= NULL
;
3013 * Process the exit status...
3016 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
3017 printer_state
= IPP_PRINTER_IDLE
;
3019 printer_state
= job
->printer
->state
;
3021 switch (job_state
= job
->state_value
)
3023 case IPP_JOB_PENDING
:
3024 message
= "Job paused.";
3028 message
= "Job held.";
3032 case IPP_JOB_PROCESSING
:
3033 case IPP_JOB_COMPLETED
:
3034 job_state
= IPP_JOB_COMPLETED
;
3035 message
= "Job completed.";
3037 ippSetString(job
->attrs
, &job
->reasons
, 0,
3038 "job-completed-successfully");
3041 case IPP_JOB_STOPPED
:
3042 message
= "Job stopped.";
3044 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-stopped");
3047 case IPP_JOB_CANCELED
:
3048 message
= "Job canceled.";
3050 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-canceled-by-user");
3053 case IPP_JOB_ABORTED
:
3054 message
= "Job aborted.";
3058 if (job
->status
< 0)
3061 * Backend had errors...
3064 int exit_code
; /* Exit code from backend */
3067 * Convert the status to an exit code. Due to the way the W* macros are
3068 * implemented on MacOS X (bug?), we have to store the exit status in a
3069 * variable first and then convert...
3072 exit_code
= -job
->status
;
3073 if (WIFEXITED(exit_code
))
3074 exit_code
= WEXITSTATUS(exit_code
);
3077 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-backend-crashed");
3078 exit_code
= job
->status
;
3081 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
3083 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
3084 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
3085 "authentication required" :
3086 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
3087 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
3088 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
3089 exit_code
== CUPS_BACKEND_RETRY
? "retry job later" :
3090 exit_code
== CUPS_BACKEND_RETRY_CURRENT
? "retry job immediately" :
3091 exit_code
< 0 ? "crashed" : "unknown");
3094 * Do what needs to be done...
3100 case CUPS_BACKEND_FAILED
:
3102 * Backend failure, use the error-policy to determine how to
3106 if (job
->dtype
& CUPS_PRINTER_CLASS
)
3109 * Queued on a class - mark the job as pending and we'll retry on
3110 * another printer...
3113 if (job_state
== IPP_JOB_COMPLETED
)
3115 job_state
= IPP_JOB_PENDING
;
3116 message
= "Retrying job on another printer.";
3118 ippSetString(job
->attrs
, &job
->reasons
, 0,
3119 "resources-are-not-ready");
3122 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
3125 * The error policy is "retry-current-job" - mark the job as pending
3126 * and we'll retry on the same printer...
3129 if (job_state
== IPP_JOB_COMPLETED
)
3131 job_state
= IPP_JOB_PENDING
;
3132 message
= "Retrying job on same printer.";
3134 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3137 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
3138 !strcmp(job
->printer
->error_policy
, "retry-job"))
3140 if (job_state
== IPP_JOB_COMPLETED
)
3143 * The job was queued on a fax or the error policy is "retry-job" -
3144 * hold the job if the number of retries is less than the
3145 * JobRetryLimit, otherwise abort the job.
3150 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3156 snprintf(buffer
, sizeof(buffer
),
3157 "Job aborted after %d unsuccessful attempts.",
3159 job_state
= IPP_JOB_ABORTED
;
3162 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3167 * Try again in N seconds...
3170 snprintf(buffer
, sizeof(buffer
),
3171 "Job held for %d seconds since it could not be sent.",
3174 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3175 job_state
= IPP_JOB_HELD
;
3178 ippSetString(job
->attrs
, &job
->reasons
, 0,
3179 "resources-are-not-ready");
3183 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
3184 job_state
== IPP_JOB_COMPLETED
)
3186 job_state
= IPP_JOB_ABORTED
;
3187 message
= "Job aborted due to backend errors; please consult "
3188 "the error_log file for details.";
3190 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3192 else if (job
->state_value
== IPP_JOB_PROCESSING
)
3194 job_state
= IPP_JOB_PENDING
;
3195 printer_state
= IPP_PRINTER_STOPPED
;
3196 message
= "Printer stopped due to backend errors; please "
3197 "consult the error_log file for details.";
3199 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3203 case CUPS_BACKEND_CANCEL
:
3208 if (job_state
== IPP_JOB_COMPLETED
)
3210 job_state
= IPP_JOB_CANCELED
;
3211 message
= "Job canceled at printer.";
3213 ippSetString(job
->attrs
, &job
->reasons
, 0, "canceled-at-device");
3217 case CUPS_BACKEND_HOLD
:
3218 if (job_state
== IPP_JOB_COMPLETED
)
3224 cupsdSetJobHoldUntil(job
, "indefinite", 1);
3225 ippSetString(job
->attrs
, &job
->reasons
, 0,
3226 "job-hold-until-specified");
3228 job_state
= IPP_JOB_HELD
;
3229 message
= "Job held indefinitely due to backend errors; please "
3230 "consult the error_log file for details.";
3234 case CUPS_BACKEND_STOP
:
3236 * Stop the printer...
3239 printer_state
= IPP_PRINTER_STOPPED
;
3240 message
= "Printer stopped due to backend errors; please "
3241 "consult the error_log file for details.";
3243 if (job_state
== IPP_JOB_COMPLETED
)
3245 job_state
= IPP_JOB_PENDING
;
3247 ippSetString(job
->attrs
, &job
->reasons
, 0,
3248 "resources-are-not-ready");
3252 case CUPS_BACKEND_AUTH_REQUIRED
:
3254 * Hold the job for authentication...
3257 if (job_state
== IPP_JOB_COMPLETED
)
3259 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
3261 job_state
= IPP_JOB_HELD
;
3262 message
= "Job held for authentication.";
3264 if (strncmp(job
->reasons
->values
[0].string
.text
, "account-", 8))
3265 ippSetString(job
->attrs
, &job
->reasons
, 0,
3266 "cups-held-for-authentication");
3270 case CUPS_BACKEND_RETRY
:
3271 if (job_state
== IPP_JOB_COMPLETED
)
3274 * Hold the job if the number of retries is less than the
3275 * JobRetryLimit, otherwise abort the job.
3280 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3286 snprintf(buffer
, sizeof(buffer
),
3287 "Job aborted after %d unsuccessful attempts.",
3289 job_state
= IPP_JOB_ABORTED
;
3292 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3297 * Try again in N seconds...
3300 snprintf(buffer
, sizeof(buffer
),
3301 "Job held for %d seconds since it could not be sent.",
3304 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3305 job_state
= IPP_JOB_HELD
;
3308 ippSetString(job
->attrs
, &job
->reasons
, 0,
3309 "resources-are-not-ready");
3314 case CUPS_BACKEND_RETRY_CURRENT
:
3316 * Mark the job as pending and retry on the same printer...
3319 if (job_state
== IPP_JOB_COMPLETED
)
3321 job_state
= IPP_JOB_PENDING
;
3322 message
= "Retrying job on same printer.";
3324 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3329 else if (job
->status
> 0)
3332 * Filter had errors; stop job...
3335 if (job_state
== IPP_JOB_COMPLETED
)
3337 job_state
= IPP_JOB_STOPPED
;
3338 message
= "Job stopped due to filter errors; please consult the "
3339 "error_log file for details.";
3341 if (WIFSIGNALED(job
->status
))
3342 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-filter-crashed");
3344 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-completed-with-errors");
3349 * Update the printer and job state.
3352 if (set_job_state
&& job_state
!= job
->state_value
)
3353 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
3355 cupsdSetPrinterState(job
->printer
, printer_state
,
3356 printer_state
== IPP_PRINTER_STOPPED
);
3357 update_job_attrs(job
, 0);
3362 (job
->state_value
== IPP_JOB_ABORTED
||
3363 job
->state_value
== IPP_JOB_STOPPED
))
3364 dump_job_history(job
);
3366 free_job_history(job
);
3369 cupsArrayRemove(PrintingJobs
, job
);
3372 * Apply any PPD updates...
3375 if (job
->num_keywords
)
3377 if (cupsdUpdatePrinterPPD(job
->printer
, job
->num_keywords
, job
->keywords
))
3378 cupsdSetPrinterAttrs(job
->printer
);
3380 cupsFreeOptions(job
->num_keywords
, job
->keywords
);
3382 job
->num_keywords
= 0;
3383 job
->keywords
= NULL
;
3387 * Clear the printer <-> job association...
3390 job
->printer
->job
= NULL
;
3391 job
->printer
= NULL
;
3394 * Try printing another job...
3397 if (printer_state
!= IPP_PRINTER_STOPPED
)
3403 * 'get_options()' - Get a string containing the job options.
3406 static char * /* O - Options string */
3407 get_options(cupsd_job_t
*job
, /* I - Job */
3408 int banner_page
, /* I - Printing a banner page? */
3409 char *copies
, /* I - Copies buffer */
3410 size_t copies_size
, /* I - Size of copies buffer */
3411 char *title
, /* I - Title buffer */
3412 size_t title_size
) /* I - Size of title buffer */
3414 int i
; /* Looping var */
3415 size_t newlength
; /* New option buffer length */
3416 char *optptr
, /* Pointer to options */
3417 *valptr
; /* Pointer in value string */
3418 ipp_attribute_t
*attr
; /* Current attribute */
3419 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3420 int num_pwgppds
; /* Number of PWG->PPD options */
3421 cups_option_t
*pwgppds
, /* PWG->PPD options */
3422 *pwgppd
, /* Current PWG->PPD option */
3423 *preset
; /* Current preset option */
3424 int print_color_mode
,
3425 /* Output mode (if any) */
3426 print_quality
; /* Print quality (if any) */
3427 const char *ppd
; /* PPD option choice */
3428 int exact
; /* Did we get an exact match? */
3429 static char *options
= NULL
;/* Full list of options */
3430 static size_t optlength
= 0; /* Length of option buffer */
3434 * Building the options string is harder than it needs to be, but for the
3435 * moment we need to pass strings for command-line args and not IPP attribute
3438 * First build an options array for any PWG->PPD mapped option/choice pairs.
3441 pc
= job
->printer
->pc
;
3446 !ippFindAttribute(job
->attrs
,
3447 "com.apple.print.DocumentTicket.PMSpoolFormat",
3449 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3450 (ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) ||
3451 ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
)))
3454 * Map print-color-mode and print-quality to a preset...
3457 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3458 IPP_TAG_KEYWORD
)) != NULL
&&
3459 !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3460 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3462 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3464 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality",
3465 IPP_TAG_ENUM
)) != NULL
&&
3466 attr
->values
[0].integer
>= IPP_QUALITY_DRAFT
&&
3467 attr
->values
[0].integer
<= IPP_QUALITY_HIGH
)
3468 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3470 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3472 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3475 * Try to find a preset that works so that we maximize the chances of us
3476 * getting a good print using IPP attributes.
3479 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3480 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3481 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3482 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3485 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3486 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3490 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3493 * Copy the preset options as long as the corresponding names are not
3494 * already defined in the IPP request...
3497 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3498 preset
= pc
->presets
[print_color_mode
][print_quality
];
3502 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3503 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
,
3511 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3512 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3514 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3515 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3518 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3519 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3520 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3522 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3523 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3524 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3526 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3528 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3529 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3532 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3533 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3534 IPP_TAG_ZERO
)) != NULL
&&
3535 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3536 attr
->value_tag
== IPP_TAG_NAME
) &&
3537 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3540 * Map output-bin to OutputBin option...
3543 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3546 if (pc
->sides_option
&&
3547 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3548 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3551 * Map sides to duplex option...
3554 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3555 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
,
3556 num_pwgppds
, &pwgppds
);
3557 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3558 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
,
3559 num_pwgppds
, &pwgppds
);
3560 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3561 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
,
3562 num_pwgppds
, &pwgppds
);
3566 * Map finishings values...
3569 num_pwgppds
= _ppdCacheGetFinishingOptions(pc
, job
->attrs
,
3570 IPP_FINISHINGS_NONE
, num_pwgppds
,
3575 * Figure out how much room we need...
3578 newlength
= ipp_length(job
->attrs
);
3580 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3581 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3584 * Then allocate/reallocate the option buffer as needed...
3587 if (newlength
== 0) /* This can never happen, but Clang */
3588 newlength
= 1; /* thinks it can... */
3590 if (newlength
> optlength
|| !options
)
3593 optptr
= malloc(newlength
);
3595 optptr
= realloc(options
, newlength
);
3599 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3600 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer.",
3601 CUPS_LLCAST newlength
);
3606 optlength
= newlength
;
3610 * Now loop through the attributes and convert them to the textual
3611 * representation used by the filters...
3617 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3618 strlcpy(copies
, "1", copies_size
);
3620 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3622 if (!strcmp(attr
->name
, "copies") &&
3623 attr
->value_tag
== IPP_TAG_INTEGER
)
3626 * Don't use the # copies attribute if we are printing the job sheets...
3630 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3632 else if (!strcmp(attr
->name
, "job-name") &&
3633 (attr
->value_tag
== IPP_TAG_NAME
||
3634 attr
->value_tag
== IPP_TAG_NAMELANG
))
3635 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3636 else if (attr
->group_tag
== IPP_TAG_JOB
)
3639 * Filter out other unwanted attributes...
3642 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3643 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3644 attr
->value_tag
== IPP_TAG_NAMELANG
||
3645 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3646 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid")) ||
3647 attr
->value_tag
== IPP_TAG_URISCHEME
||
3648 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3651 if (!strcmp(attr
->name
, "job-hold-until") ||
3652 !strcmp(attr
->name
, "job-id") ||
3653 !strcmp(attr
->name
, "job-k-octets") ||
3654 !strcmp(attr
->name
, "job-media-sheets") ||
3655 !strcmp(attr
->name
, "job-media-sheets-completed") ||
3656 !strcmp(attr
->name
, "job-state") ||
3657 !strcmp(attr
->name
, "job-state-reasons"))
3660 if (!strncmp(attr
->name
, "job-", 4) &&
3661 strcmp(attr
->name
, "job-account-id") &&
3662 strcmp(attr
->name
, "job-accounting-user-id") &&
3663 strcmp(attr
->name
, "job-authorization-uri") &&
3664 strcmp(attr
->name
, "job-billing") &&
3665 strcmp(attr
->name
, "job-impressions") &&
3666 strcmp(attr
->name
, "job-originating-host-name") &&
3667 strcmp(attr
->name
, "job-password") &&
3668 strcmp(attr
->name
, "job-password-encryption") &&
3669 strcmp(attr
->name
, "job-uuid") &&
3670 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3673 if ((!strcmp(attr
->name
, "job-impressions") ||
3674 !strcmp(attr
->name
, "page-label") ||
3675 !strcmp(attr
->name
, "page-border") ||
3676 !strncmp(attr
->name
, "number-up", 9) ||
3677 !strcmp(attr
->name
, "page-ranges") ||
3678 !strcmp(attr
->name
, "page-set") ||
3679 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3680 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3681 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3682 "PMTotalSidesImaged..n.") ||
3683 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3684 "PMTotalBeginPages..n.")) &&
3689 * Otherwise add them to the list...
3692 if (optptr
> options
)
3693 strlcat(optptr
, " ", optlength
- (optptr
- options
));
3695 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3697 strlcat(optptr
, attr
->name
, optlength
- (optptr
- options
));
3698 strlcat(optptr
, "=", optlength
- (optptr
- options
));
3701 for (i
= 0; i
< attr
->num_values
; i
++)
3704 strlcat(optptr
, ",", optlength
- (optptr
- options
));
3706 optptr
+= strlen(optptr
);
3708 switch (attr
->value_tag
)
3710 case IPP_TAG_INTEGER
:
3712 snprintf(optptr
, optlength
- (optptr
- options
),
3713 "%d", attr
->values
[i
].integer
);
3716 case IPP_TAG_BOOLEAN
:
3717 if (!attr
->values
[i
].boolean
)
3718 strlcat(optptr
, "no", optlength
- (optptr
- options
));
3720 strlcat(optptr
, attr
->name
,
3721 optlength
- (optptr
- options
));
3724 case IPP_TAG_RANGE
:
3725 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3726 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3727 "%d", attr
->values
[i
].range
.lower
);
3729 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3730 "%d-%d", attr
->values
[i
].range
.lower
,
3731 attr
->values
[i
].range
.upper
);
3734 case IPP_TAG_RESOLUTION
:
3735 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3736 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
3737 attr
->values
[i
].resolution
.yres
,
3738 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
3742 case IPP_TAG_STRING
:
3745 case IPP_TAG_KEYWORD
:
3746 case IPP_TAG_CHARSET
:
3747 case IPP_TAG_LANGUAGE
:
3749 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
3751 if (strchr(" \t\n\\\'\"", *valptr
))
3753 *optptr
++ = *valptr
++;
3760 break; /* anti-compiler-warning-code */
3764 optptr
+= strlen(optptr
);
3769 * Finally loop through the PWG->PPD mapped options and add them...
3772 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3775 strlcpy(optptr
, pwgppd
->name
, optlength
- (optptr
- options
));
3776 optptr
+= strlen(optptr
);
3778 strlcpy(optptr
, pwgppd
->value
, optlength
- (optptr
- options
));
3779 optptr
+= strlen(optptr
);
3782 cupsFreeOptions(num_pwgppds
, pwgppds
);
3785 * Return the options string...
3793 * 'ipp_length()' - Compute the size of the buffer needed to hold
3794 * the textual IPP attributes.
3797 static size_t /* O - Size of attribute buffer */
3798 ipp_length(ipp_t
*ipp
) /* I - IPP request */
3800 size_t bytes
; /* Number of bytes */
3801 int i
; /* Looping var */
3802 ipp_attribute_t
*attr
; /* Current attribute */
3806 * Loop through all attributes...
3811 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3814 * Skip attributes that won't be sent to filters...
3817 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3818 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3819 attr
->value_tag
== IPP_TAG_NAMELANG
||
3820 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3821 attr
->value_tag
== IPP_TAG_URI
||
3822 attr
->value_tag
== IPP_TAG_URISCHEME
)
3826 * Add space for a leading space and commas between each value.
3827 * For the first attribute, the leading space isn't used, so the
3828 * extra byte can be used as the nul terminator...
3831 bytes
++; /* " " separator */
3832 bytes
+= attr
->num_values
; /* "," separators */
3835 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3836 * other attributes appear as "foo=value1,value2,...,valueN".
3839 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3840 bytes
+= strlen(attr
->name
);
3842 bytes
+= attr
->num_values
* strlen(attr
->name
);
3845 * Now add the size required for each value in the attribute...
3848 switch (attr
->value_tag
)
3850 case IPP_TAG_INTEGER
:
3853 * Minimum value of a signed integer is -2147483647, or 11 digits.
3856 bytes
+= attr
->num_values
* 11;
3859 case IPP_TAG_BOOLEAN
:
3861 * Add two bytes for each false ("no") value...
3864 for (i
= 0; i
< attr
->num_values
; i
++)
3865 if (!attr
->values
[i
].boolean
)
3869 case IPP_TAG_RANGE
:
3871 * A range is two signed integers separated by a hyphen, or
3872 * 23 characters max.
3875 bytes
+= attr
->num_values
* 23;
3878 case IPP_TAG_RESOLUTION
:
3880 * A resolution is two signed integers separated by an "x" and
3881 * suffixed by the units, or 26 characters max.
3884 bytes
+= attr
->num_values
* 26;
3887 case IPP_TAG_STRING
:
3890 case IPP_TAG_KEYWORD
:
3891 case IPP_TAG_CHARSET
:
3892 case IPP_TAG_LANGUAGE
:
3895 * Strings can contain characters that need quoting. We need
3896 * at least 2 * len + 2 characters to cover the quotes and
3897 * any backslashes in the string.
3900 for (i
= 0; i
< attr
->num_values
; i
++)
3901 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
3905 break; /* anti-compiler-warning-code */
3914 * 'load_job_cache()' - Load jobs from the job.cache file.
3918 load_job_cache(const char *filename
) /* I - job.cache filename */
3920 cups_file_t
*fp
; /* job.cache file */
3921 char line
[1024], /* Line buffer */
3922 *value
; /* Value on line */
3923 int linenum
; /* Line number in file */
3924 cupsd_job_t
*job
; /* Current job */
3925 int jobid
; /* Job ID */
3926 char jobfile
[1024]; /* Job filename */
3930 * Open the job.cache file...
3933 if ((fp
= cupsdOpenConfFile(filename
)) == NULL
)
3935 load_request_root();
3940 * Read entries from the job cache file and create jobs as needed.
3943 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
3949 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
3951 if (!_cups_strcasecmp(line
, "NextJobId"))
3954 NextJobId
= atoi(value
);
3956 else if (!_cups_strcasecmp(line
, "<Job"))
3960 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d.",
3967 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d.", linenum
);
3971 jobid
= atoi(value
);
3975 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d.", jobid
,
3980 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
3981 if (access(jobfile
, 0))
3983 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d.N", RequestRoot
, jobid
);
3984 if (access(jobfile
, 0))
3986 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away.",
3992 job
= calloc(1, sizeof(cupsd_job_t
));
3995 cupsdLogMessage(CUPSD_LOG_EMERG
,
3996 "[Job %d] Unable to allocate memory for job.", jobid
);
4001 job
->back_pipes
[0] = -1;
4002 job
->back_pipes
[1] = -1;
4003 job
->print_pipes
[0] = -1;
4004 job
->print_pipes
[1] = -1;
4005 job
->side_pipes
[0] = -1;
4006 job
->side_pipes
[1] = -1;
4007 job
->status_pipes
[0] = -1;
4008 job
->status_pipes
[1] = -1;
4010 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading from cache...",
4015 cupsdLogMessage(CUPSD_LOG_ERROR
,
4016 "Missing <Job #> directive on line %d.", linenum
);
4019 else if (!_cups_strcasecmp(line
, "</Job>"))
4021 cupsArrayAdd(Jobs
, job
);
4023 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
4024 cupsArrayAdd(ActiveJobs
, job
);
4030 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d.", linenum
);
4033 else if (!_cups_strcasecmp(line
, "State"))
4035 job
->state_value
= (ipp_jstate_t
)atoi(value
);
4037 if (job
->state_value
< IPP_JOB_PENDING
)
4038 job
->state_value
= IPP_JOB_PENDING
;
4039 else if (job
->state_value
> IPP_JOB_COMPLETED
)
4040 job
->state_value
= IPP_JOB_COMPLETED
;
4042 else if (!_cups_strcasecmp(line
, "HoldUntil"))
4044 job
->hold_until
= atoi(value
);
4046 else if (!_cups_strcasecmp(line
, "Priority"))
4048 job
->priority
= atoi(value
);
4050 else if (!_cups_strcasecmp(line
, "Username"))
4052 cupsdSetString(&job
->username
, value
);
4054 else if (!_cups_strcasecmp(line
, "Destination"))
4056 cupsdSetString(&job
->dest
, value
);
4058 else if (!_cups_strcasecmp(line
, "DestType"))
4060 job
->dtype
= (cups_ptype_t
)atoi(value
);
4062 else if (!_cups_strcasecmp(line
, "NumFiles"))
4064 job
->num_files
= atoi(value
);
4066 if (job
->num_files
< 0)
4068 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d.",
4069 job
->num_files
, linenum
);
4074 if (job
->num_files
> 0)
4076 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
4078 if (access(jobfile
, 0))
4080 cupsdLogMessage(CUPSD_LOG_INFO
, "[Job %d] Data files have gone away.",
4086 job
->filetypes
= calloc(job
->num_files
, sizeof(mime_type_t
*));
4087 job
->compressions
= calloc(job
->num_files
, sizeof(int));
4089 if (!job
->filetypes
|| !job
->compressions
)
4091 cupsdLogMessage(CUPSD_LOG_EMERG
,
4092 "[Job %d] Unable to allocate memory for %d files.",
4093 job
->id
, job
->num_files
);
4098 else if (!_cups_strcasecmp(line
, "File"))
4100 int number
, /* File number */
4101 compression
; /* Compression value */
4102 char super
[MIME_MAX_SUPER
], /* MIME super type */
4103 type
[MIME_MAX_TYPE
]; /* MIME type */
4106 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
4109 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d.", linenum
);
4113 if (number
< 1 || number
> job
->num_files
)
4115 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d.",
4122 job
->compressions
[number
] = compression
;
4123 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
4125 if (!job
->filetypes
[number
])
4128 * If the original MIME type is unknown, auto-type it!
4131 cupsdLogMessage(CUPSD_LOG_ERROR
,
4132 "[Job %d] Unknown MIME type %s/%s for file %d.",
4133 job
->id
, super
, type
, number
+ 1);
4135 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
4136 job
->id
, number
+ 1);
4137 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
4138 job
->compressions
+ number
);
4141 * If that didn't work, assume it is raw...
4144 if (!job
->filetypes
[number
])
4145 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
4150 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d.",
4159 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4163 load_next_job_id(const char *filename
) /* I - job.cache filename */
4165 cups_file_t
*fp
; /* job.cache file */
4166 char line
[1024], /* Line buffer */
4167 *value
; /* Value on line */
4168 int linenum
; /* Line number in file */
4169 int next_job_id
; /* NextJobId value from line */
4173 * Read the NextJobId directive from the job.cache file and use
4174 * the value (if any).
4177 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4179 if (errno
!= ENOENT
)
4180 cupsdLogMessage(CUPSD_LOG_ERROR
,
4181 "Unable to open job cache file \"%s\": %s",
4182 filename
, strerror(errno
));
4187 cupsdLogMessage(CUPSD_LOG_INFO
,
4188 "Loading NextJobId from job cache file \"%s\"...", filename
);
4192 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4194 if (!_cups_strcasecmp(line
, "NextJobId"))
4198 next_job_id
= atoi(value
);
4200 if (next_job_id
> NextJobId
)
4201 NextJobId
= next_job_id
;
4212 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4216 load_request_root(void)
4218 cups_dir_t
*dir
; /* Directory */
4219 cups_dentry_t
*dent
; /* Directory entry */
4220 cupsd_job_t
*job
; /* New job */
4224 * Open the requests directory...
4227 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
4229 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
4231 cupsdLogMessage(CUPSD_LOG_ERROR
,
4232 "Unable to open spool directory \"%s\": %s",
4233 RequestRoot
, strerror(errno
));
4238 * Read all the c##### files...
4241 while ((dent
= cupsDirRead(dir
)) != NULL
)
4242 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
4245 * Allocate memory for the job...
4248 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
4250 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs.");
4256 * Assign the job ID...
4259 job
->id
= atoi(dent
->filename
+ 1);
4260 job
->back_pipes
[0] = -1;
4261 job
->back_pipes
[1] = -1;
4262 job
->print_pipes
[0] = -1;
4263 job
->print_pipes
[1] = -1;
4264 job
->side_pipes
[0] = -1;
4265 job
->side_pipes
[1] = -1;
4266 job
->status_pipes
[0] = -1;
4267 job
->status_pipes
[1] = -1;
4269 if (job
->id
>= NextJobId
)
4270 NextJobId
= job
->id
+ 1;
4276 if (cupsdLoadJob(job
))
4279 * Insert the job into the array, sorting by job priority and ID...
4282 cupsArrayAdd(Jobs
, job
);
4284 if (job
->state_value
<= IPP_JOB_STOPPED
)
4285 cupsArrayAdd(ActiveJobs
, job
);
4296 * 'remove_job_files()' - Remove the document files for a job.
4300 remove_job_files(cupsd_job_t
*job
) /* I - Job */
4302 int i
; /* Looping var */
4303 char filename
[1024]; /* Document filename */
4306 if (job
->num_files
<= 0)
4309 for (i
= 1; i
<= job
->num_files
; i
++)
4311 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
4314 cupsdRemoveFile(filename
);
4319 free(job
->filetypes
);
4320 free(job
->compressions
);
4324 job
->filetypes
= NULL
;
4325 job
->compressions
= NULL
;
4327 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4332 * 'remove_job_history()' - Remove the control file for a job.
4336 remove_job_history(cupsd_job_t
*job
) /* I - Job */
4338 char filename
[1024]; /* Control filename */
4342 * Remove the job info file...
4345 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
4348 cupsdRemoveFile(filename
);
4352 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4357 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4361 set_time(cupsd_job_t
*job
, /* I - Job to update */
4362 const char *name
) /* I - Name of attribute */
4364 ipp_attribute_t
*attr
; /* Time attribute */
4365 time_t curtime
; /* Current time */
4368 curtime
= time(NULL
);
4370 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s=%ld", name
, (long)curtime
);
4372 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
4374 attr
->value_tag
= IPP_TAG_INTEGER
;
4375 attr
->values
[0].integer
= curtime
;
4378 if (!strcmp(name
, "time-at-completed"))
4380 if (JobHistory
< INT_MAX
)
4381 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
4383 job
->history_time
= INT_MAX
;
4385 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4386 JobHistoryUpdate
= job
->history_time
;
4388 if (JobFiles
< INT_MAX
)
4389 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
4391 job
->file_time
= INT_MAX
;
4393 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4394 JobHistoryUpdate
= job
->file_time
;
4396 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "set_time: JobHistoryUpdate=%ld",
4397 (long)JobHistoryUpdate
);
4403 * 'start_job()' - Start a print job.
4407 start_job(cupsd_job_t
*job
, /* I - Job ID */
4408 cupsd_printer_t
*printer
) /* I - Printer to print job */
4410 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
4411 job
, job
->id
, printer
, printer
->name
);
4414 * Make sure we have some files around before we try to print...
4417 if (job
->num_files
== 0)
4419 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
4420 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
4421 "Aborting job because it has no files.");
4426 * Update the printer and job state to "processing"...
4429 if (!cupsdLoadJob(job
))
4432 if (!job
->printer_message
)
4433 job
->printer_message
= ippFindAttribute(job
->attrs
,
4434 "job-printer-state-message",
4436 if (job
->printer_message
)
4437 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
4439 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-printing");
4440 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
4441 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
4442 cupsdSetPrinterReasons(printer
, "-cups-remote-pending,"
4443 "cups-remote-pending-held,"
4444 "cups-remote-processing,"
4445 "cups-remote-stopped,"
4446 "cups-remote-canceled,"
4447 "cups-remote-aborted,"
4448 "cups-remote-completed");
4451 job
->current_file
= 0;
4453 job
->history_time
= 0;
4455 job
->printer
= printer
;
4459 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4461 job
->cancel_time
= 0;
4464 * Setup the last exit status and security profiles...
4468 job
->profile
= cupsdCreateProfile(job
->id
);
4471 * Create the status pipes and buffer...
4474 if (cupsdOpenPipe(job
->status_pipes
))
4476 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4477 "Unable to create job status pipes - %s.", strerror(errno
));
4479 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4480 "Job stopped because the scheduler could not create the "
4481 "job status pipes.");
4483 cupsdDestroyProfile(job
->profile
);
4484 job
->profile
= NULL
;
4488 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
4489 job
->status_level
= CUPSD_LOG_INFO
;
4492 * Create the backchannel pipes and make them non-blocking...
4495 if (cupsdOpenPipe(job
->back_pipes
))
4497 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4498 "Unable to create back-channel pipes - %s.", strerror(errno
));
4500 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4501 "Job stopped because the scheduler could not create the "
4502 "back-channel pipes.");
4504 cupsdClosePipe(job
->status_pipes
);
4505 cupsdStatBufDelete(job
->status_buffer
);
4506 job
->status_buffer
= NULL
;
4508 cupsdDestroyProfile(job
->profile
);
4509 job
->profile
= NULL
;
4513 fcntl(job
->back_pipes
[0], F_SETFL
,
4514 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4515 fcntl(job
->back_pipes
[1], F_SETFL
,
4516 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4519 * Create the side-channel pipes and make them non-blocking...
4522 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4524 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4525 "Unable to create side-channel pipes - %s.", strerror(errno
));
4527 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4528 "Job stopped because the scheduler could not create the "
4529 "side-channel pipes.");
4531 cupsdClosePipe(job
->back_pipes
);
4533 cupsdClosePipe(job
->status_pipes
);
4534 cupsdStatBufDelete(job
->status_buffer
);
4535 job
->status_buffer
= NULL
;
4537 cupsdDestroyProfile(job
->profile
);
4538 job
->profile
= NULL
;
4542 fcntl(job
->side_pipes
[0], F_SETFL
,
4543 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4544 fcntl(job
->side_pipes
[1], F_SETFL
,
4545 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4547 fcntl(job
->side_pipes
[0], F_SETFD
,
4548 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4549 fcntl(job
->side_pipes
[1], F_SETFD
,
4550 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4553 * Now start the first file in the job...
4556 cupsdContinueJob(job
);
4561 * 'stop_job()' - Stop a print job.
4565 stop_job(cupsd_job_t
*job
, /* I - Job */
4566 cupsd_jobaction_t action
) /* I - Action */
4568 int i
; /* Looping var */
4571 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4574 FilterLevel
-= job
->cost
;
4577 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
)
4578 job
->kill_time
= time(NULL
) + JobKillDelay
;
4579 else if (action
>= CUPSD_JOB_FORCE
)
4582 for (i
= 0; job
->filters
[i
]; i
++)
4583 if (job
->filters
[i
] > 0)
4585 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
4587 if (action
>= CUPSD_JOB_FORCE
)
4588 job
->filters
[i
] = -job
->filters
[i
];
4591 if (job
->backend
> 0)
4593 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
4595 if (action
>= CUPSD_JOB_FORCE
)
4596 job
->backend
= -job
->backend
;
4599 if (action
>= CUPSD_JOB_FORCE
)
4602 * Clear job status...
4611 * 'unload_job()' - Unload a job from memory.
4615 unload_job(cupsd_job_t
*job
) /* I - Job */
4620 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Unloading...", job
->id
);
4622 ippDelete(job
->attrs
);
4626 job
->reasons
= NULL
;
4628 job
->job_sheets
= NULL
;
4629 job
->printer_message
= NULL
;
4630 job
->printer_reasons
= NULL
;
4635 * 'update_job()' - Read a status update from a job's filters.
4639 update_job(cupsd_job_t
*job
) /* I - Job to check */
4641 int i
; /* Looping var */
4642 int copies
; /* Number of copies printed */
4643 char message
[CUPSD_SB_BUFFER_SIZE
],
4645 *ptr
; /* Pointer update... */
4646 int loglevel
, /* Log level for message */
4647 event
= 0; /* Events? */
4648 static const char * const levels
[] = /* Log levels */
4664 * Get the printer associated with this job; if the printer is stopped for
4665 * any reason then job->printer will be reset to NULL, so make sure we have
4666 * a valid pointer...
4669 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
4670 message
, sizeof(message
))) != NULL
)
4673 * Process page and printer state messages as needed...
4676 if (loglevel
== CUPSD_LOG_PAGE
)
4679 * Page message; send the message to the page_log file and update the
4680 * job sheet count...
4683 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
4687 if (!_cups_strncasecmp(message
, "total ", 6))
4690 * Got a total count of pages from a backend or filter...
4693 copies
= atoi(message
+ 6);
4694 copies
-= job
->sheets
->values
[0].integer
; /* Just track the delta */
4696 else if (!sscanf(message
, "%*d%d", &copies
))
4699 job
->sheets
->values
[0].integer
+= copies
;
4701 if (job
->printer
->page_limit
)
4702 cupsdUpdateQuota(job
->printer
, job
->username
, copies
, 0);
4705 cupsdLogPage(job
, message
);
4708 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4709 "Printed %d page(s).", job
->sheets
->values
[0].integer
);
4711 else if (loglevel
== CUPSD_LOG_JOBSTATE
)
4714 * Support "keyword" to set job-state-reasons to the specified keyword.
4715 * This is sufficient for the current paid printing stuff.
4718 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "JOBSTATE: %s", message
);
4720 ippSetString(job
->attrs
, &job
->reasons
, 0, message
);
4722 else if (loglevel
== CUPSD_LOG_STATE
)
4724 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
4726 if (!strcmp(message
, "paused"))
4728 cupsdStopPrinter(job
->printer
, 1);
4731 else if (cupsdSetPrinterReasons(job
->printer
, message
))
4733 event
|= CUPSD_EVENT_PRINTER_STATE
;
4735 if (MaxJobTime
> 0 && strstr(message
, "connecting-to-device") != NULL
)
4738 * Reset cancel time after connecting to the device...
4741 for (i
= 0; i
< job
->printer
->num_reasons
; i
++)
4742 if (!strcmp(job
->printer
->reasons
[i
], "connecting-to-device"))
4745 if (i
>= job
->printer
->num_reasons
)
4746 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4750 update_job_attrs(job
, 0);
4752 else if (loglevel
== CUPSD_LOG_ATTR
)
4755 * Set attribute(s)...
4758 int num_attrs
; /* Number of attributes */
4759 cups_option_t
*attrs
; /* Attributes */
4760 const char *attr
; /* Attribute */
4762 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
4764 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
4766 if ((attr
= cupsGetOption("auth-info-default", num_attrs
,
4769 job
->printer
->num_options
= cupsAddOption("auth-info", attr
,
4770 job
->printer
->num_options
,
4771 &(job
->printer
->options
));
4772 cupsdSetPrinterAttrs(job
->printer
);
4774 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4777 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
4780 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
4781 cupsdSetPrinterAttrs(job
->printer
);
4783 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4786 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
4789 int progress
= atoi(attr
);
4792 if (progress
>= 0 && progress
<= 100)
4794 job
->progress
= progress
;
4797 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4798 "Printing page %d, %d%%",
4799 job
->sheets
->values
[0].integer
, job
->progress
);
4803 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
4805 cupsdSetString(&job
->printer
->alert
, attr
);
4806 event
|= CUPSD_EVENT_PRINTER_STATE
;
4809 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
4812 cupsdSetString(&job
->printer
->alert_description
, attr
);
4813 event
|= CUPSD_EVENT_PRINTER_STATE
;
4816 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
4818 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
4819 job
->printer
->marker_time
= time(NULL
);
4820 event
|= CUPSD_EVENT_PRINTER_STATE
;
4821 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4824 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
4826 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
4827 job
->printer
->marker_time
= time(NULL
);
4828 event
|= CUPSD_EVENT_PRINTER_STATE
;
4829 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4832 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
4834 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
4835 job
->printer
->marker_time
= time(NULL
);
4836 event
|= CUPSD_EVENT_PRINTER_STATE
;
4837 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4840 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
4842 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
4843 job
->printer
->marker_time
= time(NULL
);
4844 event
|= CUPSD_EVENT_PRINTER_STATE
;
4845 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4848 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
4850 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
4851 job
->printer
->marker_time
= time(NULL
);
4852 event
|= CUPSD_EVENT_PRINTER_STATE
;
4853 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4856 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
4858 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
4859 job
->printer
->marker_time
= time(NULL
);
4860 event
|= CUPSD_EVENT_PRINTER_STATE
;
4861 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4864 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
4866 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
4867 job
->printer
->marker_time
= time(NULL
);
4868 event
|= CUPSD_EVENT_PRINTER_STATE
;
4869 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4872 cupsFreeOptions(num_attrs
, attrs
);
4874 else if (loglevel
== CUPSD_LOG_PPD
)
4877 * Set attribute(s)...
4880 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
4882 job
->num_keywords
= cupsParseOptions(message
, job
->num_keywords
,
4888 * Strip legacy message prefix...
4891 if (!strncmp(message
, "recoverable:", 12))
4894 while (isspace(*ptr
& 255))
4897 else if (!strncmp(message
, "recovered:", 10))
4900 while (isspace(*ptr
& 255))
4907 cupsdLogJob(job
, loglevel
, "%s", ptr
);
4909 if (loglevel
< CUPSD_LOG_DEBUG
&&
4910 strcmp(job
->printer
->state_message
, ptr
))
4912 strlcpy(job
->printer
->state_message
, ptr
,
4913 sizeof(job
->printer
->state_message
));
4915 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
4917 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
4920 * Some messages show in the job-printer-state-message attribute...
4923 if (loglevel
!= CUPSD_LOG_NOTICE
)
4924 job
->status_level
= loglevel
;
4926 update_job_attrs(job
, 1);
4928 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4929 "Set job-printer-state-message to \"%s\", "
4931 job
->printer_message
->values
[0].string
.text
,
4932 levels
[job
->status_level
]);
4937 if (!strchr(job
->status_buffer
->buffer
, '\n'))
4941 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
4942 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4943 "%s", job
->printer
->state_message
);
4944 if (event
& CUPSD_EVENT_PRINTER_STATE
)
4945 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
4946 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
4947 "Class \"%s\" state changed." :
4948 "Printer \"%s\" state changed.",
4949 job
->printer
->name
);
4952 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
4955 * See if all of the filters and the backend have returned their
4959 for (i
= 0; job
->filters
[i
] < 0; i
++);
4961 if (job
->filters
[i
])
4964 * EOF but we haven't collected the exit status of all filters...
4967 cupsdCheckProcess();
4971 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
4974 * EOF but we haven't collected the exit status of the backend...
4977 cupsdCheckProcess();
4982 * Handle the end of job stuff...
4985 finalize_job(job
, 1);
4988 * Check for new jobs...
4997 * 'update_job_attrs()' - Update the job-printer-* attributes.
5001 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
5002 int do_message
)/* I - 1 = copy job-printer-state message */
5004 int i
; /* Looping var */
5005 int num_reasons
; /* Actual number of reasons */
5006 const char * const *reasons
; /* Reasons */
5007 static const char *none
= "none"; /* "none" reason */
5011 * Get/create the job-printer-state-* attributes...
5014 if (!job
->printer_message
)
5016 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
5017 "job-printer-state-message",
5018 IPP_TAG_TEXT
)) == NULL
)
5019 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
5020 "job-printer-state-message",
5024 if (!job
->printer_reasons
)
5025 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
5026 "job-printer-state-reasons",
5030 * Copy or clear the printer-state-message value as needed...
5033 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
5034 job
->status_level
== CUPSD_LOG_INFO
)
5036 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
5039 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5041 else if (job
->printer
->state_message
[0] && do_message
)
5043 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
),
5044 job
->printer
->state_message
);
5047 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5051 * ... and the printer-state-reasons value...
5054 if (job
->printer
->num_reasons
== 0)
5061 num_reasons
= job
->printer
->num_reasons
;
5062 reasons
= (const char * const *)job
->printer
->reasons
;
5065 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
5068 * Replace/create a job-printer-state-reasons attribute...
5071 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
5073 job
->printer_reasons
= ippAddStrings(job
->attrs
,
5074 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
5075 "job-printer-state-reasons",
5076 num_reasons
, NULL
, NULL
);
5081 * Don't bother clearing the reason strings if they are the same...
5084 for (i
= 0; i
< num_reasons
; i
++)
5085 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
5088 if (i
>= num_reasons
)
5092 * Not the same, so free the current strings...
5095 for (i
= 0; i
< num_reasons
; i
++)
5096 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
5100 * Copy the reasons...
5103 for (i
= 0; i
< num_reasons
; i
++)
5104 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
5107 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5112 * End of "$Id: job.c 7902 2008-09-03 14:20:17Z mike $".