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 strcpy(apple_language
, "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 strcpy(lang
, "LANG=C");
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 strcpy(printer_state_reasons
, "PRINTER_STATE_REASONS=");
978 for (psrptr
= printer_state_reasons
+ 22, i
= 0;
979 i
< job
->printer
->num_reasons
;
984 strcpy(psrptr
, job
->printer
->reasons
[i
]);
985 psrptr
+= strlen(psrptr
);
989 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
991 if (job
->printer
->num_auth_info_required
== 1)
992 snprintf(auth_info_required
, sizeof(auth_info_required
),
993 "AUTH_INFO_REQUIRED=%s",
994 job
->printer
->auth_info_required
[0]);
995 else if (job
->printer
->num_auth_info_required
== 2)
996 snprintf(auth_info_required
, sizeof(auth_info_required
),
997 "AUTH_INFO_REQUIRED=%s,%s",
998 job
->printer
->auth_info_required
[0],
999 job
->printer
->auth_info_required
[1]);
1000 else if (job
->printer
->num_auth_info_required
== 3)
1001 snprintf(auth_info_required
, sizeof(auth_info_required
),
1002 "AUTH_INFO_REQUIRED=%s,%s,%s",
1003 job
->printer
->auth_info_required
[0],
1004 job
->printer
->auth_info_required
[1],
1005 job
->printer
->auth_info_required
[2]);
1006 else if (job
->printer
->num_auth_info_required
== 4)
1007 snprintf(auth_info_required
, sizeof(auth_info_required
),
1008 "AUTH_INFO_REQUIRED=%s,%s,%s,%s",
1009 job
->printer
->auth_info_required
[0],
1010 job
->printer
->auth_info_required
[1],
1011 job
->printer
->auth_info_required
[2],
1012 job
->printer
->auth_info_required
[3]);
1014 strlcpy(auth_info_required
, "AUTH_INFO_REQUIRED=none",
1015 sizeof(auth_info_required
));
1017 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
1019 envp
[envc
++] = charset
;
1020 envp
[envc
++] = lang
;
1022 envp
[envc
++] = apple_language
;
1023 #endif /* __APPLE__ */
1024 envp
[envc
++] = ppd
;
1025 envp
[envc
++] = rip_max_cache
;
1026 envp
[envc
++] = content_type
;
1027 envp
[envc
++] = device_uri
;
1028 envp
[envc
++] = printer_info
;
1029 envp
[envc
++] = printer_location
;
1030 envp
[envc
++] = printer_name
;
1031 envp
[envc
++] = printer_state_reasons
? printer_state_reasons
:
1032 "PRINTER_STATE_REASONS=none";
1033 envp
[envc
++] = banner_page
? "CUPS_FILETYPE=job-sheet" :
1034 "CUPS_FILETYPE=document";
1036 if (!job
->printer
->remote
&& !job
->printer
->raw
)
1038 filter
= (mime_filter_t
*)cupsArrayLast(filters
);
1040 if (job
->printer
->port_monitor
)
1041 filter
= (mime_filter_t
*)cupsArrayPrev(filters
);
1043 if (filter
&& filter
->dst
)
1045 if ((ptr
= strchr(filter
->dst
->type
, '/')) != NULL
)
1046 snprintf(final_content_type
, sizeof(final_content_type
),
1047 "FINAL_CONTENT_TYPE=%s", ptr
+ 1);
1049 snprintf(final_content_type
, sizeof(final_content_type
),
1050 "FINAL_CONTENT_TYPE=%s/%s", filter
->dst
->super
,
1052 envp
[envc
++] = final_content_type
;
1056 if (Classification
&& !banner_page
)
1058 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
1059 IPP_TAG_NAME
)) == NULL
)
1060 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1062 else if (attr
->num_values
> 1 &&
1063 strcmp(attr
->values
[1].string
.text
, "none") != 0)
1064 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1065 attr
->values
[1].string
.text
);
1067 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1068 attr
->values
[0].string
.text
);
1070 envp
[envc
++] = classification
;
1073 if (job
->dtype
& CUPS_PRINTER_CLASS
)
1075 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
1076 envp
[envc
++] = class_name
;
1079 envp
[envc
++] = auth_info_required
;
1082 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1084 if (job
->auth_env
[i
])
1085 envp
[envc
++] = job
->auth_env
[i
];
1090 envp
[envc
++] = job
->auth_uid
;
1094 for (i
= 0; i
< envc
; i
++)
1095 if (!strncmp(envp
[i
], "AUTH_", 5))
1096 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"AUTH_%c****\"", i
,
1098 else if (strncmp(envp
[i
], "DEVICE_URI=", 11))
1099 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"%s\"", i
, envp
[i
]);
1101 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"DEVICE_URI=%s\"", i
,
1102 job
->printer
->sanitized_device_uri
);
1104 if (job
->printer
->remote
)
1105 job
->current_file
= job
->num_files
;
1107 job
->current_file
++;
1110 * Now create processes for all of the filters...
1113 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
1114 "cups-insecure-filter-warning");
1116 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
1118 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
1120 if (filter
->filter
[0] != '/')
1121 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
1124 strlcpy(command
, filter
->filter
, sizeof(command
));
1126 if (i
< (cupsArrayCount(filters
) - 1))
1128 if (cupsdOpenPipe(filterfds
[slot
]))
1130 abort_message
= "Stopping job because the scheduler could not create "
1131 "the filter pipes.";
1138 if (job
->current_file
== 1 ||
1139 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1141 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1143 if (cupsdOpenPipe(job
->print_pipes
))
1145 abort_message
= "Stopping job because the scheduler could not "
1146 "create the backend pipes.";
1153 job
->print_pipes
[0] = -1;
1154 if (!strcmp(job
->printer
->device_uri
, "file:/dev/null") ||
1155 !strcmp(job
->printer
->device_uri
, "file:///dev/null"))
1156 job
->print_pipes
[1] = -1;
1159 if (!strncmp(job
->printer
->device_uri
, "file:/dev/", 10))
1160 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1162 else if (!strncmp(job
->printer
->device_uri
, "file:///dev/", 12))
1163 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1165 else if (!strncmp(job
->printer
->device_uri
, "file:///", 8))
1166 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1167 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1169 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1170 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1172 if (job
->print_pipes
[1] < 0)
1174 abort_message
= "Stopping job because the scheduler could not "
1175 "open the output file.";
1180 fcntl(job
->print_pipes
[1], F_SETFD
,
1181 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
1186 filterfds
[slot
][0] = job
->print_pipes
[0];
1187 filterfds
[slot
][1] = job
->print_pipes
[1];
1190 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1191 filterfds
[slot
][1], job
->status_pipes
[1],
1192 job
->back_pipes
[0], job
->side_pipes
[0], 0,
1193 job
->profile
, job
, job
->filters
+ i
);
1195 cupsdClosePipe(filterfds
[!slot
]);
1199 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
1200 filter
->filter
, strerror(errno
));
1202 abort_message
= "Stopping job because the scheduler could not execute a "
1208 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started filter %s (PID %d)", command
,
1215 cupsArrayDelete(filters
);
1219 * Finally, pipe the final output into a backend process if needed...
1222 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1224 if (job
->current_file
== 1 || job
->printer
->remote
||
1225 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1227 sscanf(job
->printer
->device_uri
, "%254[^:]", scheme
);
1228 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, scheme
);
1231 * See if the backend needs to run as root...
1236 else if (stat(command
, &backinfo
))
1239 backroot
= !(backinfo
.st_mode
& (S_IRWXG
| S_IRWXO
));
1241 argv
[0] = job
->printer
->sanitized_device_uri
;
1243 filterfds
[slot
][0] = -1;
1244 filterfds
[slot
][1] = -1;
1246 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1247 filterfds
[slot
][1], job
->status_pipes
[1],
1248 job
->back_pipes
[1], job
->side_pipes
[1],
1249 backroot
, job
->profile
, job
, &(job
->backend
));
1253 abort_message
= "Stopping job because the sheduler could not execute "
1260 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started backend %s (PID %d)",
1265 if (job
->current_file
== job
->num_files
||
1266 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1267 cupsdClosePipe(job
->print_pipes
);
1269 if (job
->current_file
== job
->num_files
)
1271 cupsdClosePipe(job
->back_pipes
);
1272 cupsdClosePipe(job
->side_pipes
);
1274 close(job
->status_pipes
[1]);
1275 job
->status_pipes
[1] = -1;
1280 filterfds
[slot
][0] = -1;
1281 filterfds
[slot
][1] = -1;
1283 if (job
->current_file
== job
->num_files
||
1284 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1285 cupsdClosePipe(job
->print_pipes
);
1287 if (job
->current_file
== job
->num_files
)
1289 close(job
->status_pipes
[1]);
1290 job
->status_pipes
[1] = -1;
1294 cupsdClosePipe(filterfds
[slot
]);
1296 if (job
->printer
->remote
&& job
->num_files
> 1)
1298 for (i
= 0; i
< job
->num_files
; i
++)
1303 if (printer_state_reasons
)
1304 free(printer_state_reasons
);
1306 cupsdAddSelect(job
->status_buffer
->fd
, (cupsd_selfunc_t
)update_job
, NULL
,
1309 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
1316 * If we get here, we need to abort the current job and close out all
1317 * files and pipes...
1322 FilterLevel
-= job
->cost
;
1325 for (slot
= 0; slot
< 2; slot
++)
1326 cupsdClosePipe(filterfds
[slot
]);
1328 cupsArrayDelete(filters
);
1332 if (job
->printer
->remote
&& job
->num_files
> 1)
1334 for (i
= 0; i
< job
->num_files
; i
++)
1341 if (printer_state_reasons
)
1342 free(printer_state_reasons
);
1344 cupsdClosePipe(job
->print_pipes
);
1345 cupsdClosePipe(job
->back_pipes
);
1346 cupsdClosePipe(job
->side_pipes
);
1348 cupsdRemoveSelect(job
->status_pipes
[0]);
1349 cupsdClosePipe(job
->status_pipes
);
1350 cupsdStatBufDelete(job
->status_buffer
);
1351 job
->status_buffer
= NULL
;
1354 * Update the printer and job state.
1357 cupsdSetJobState(job
, abort_state
, CUPSD_JOB_DEFAULT
, "%s", abort_message
);
1358 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_IDLE
, 0);
1359 update_job_attrs(job
, 0);
1362 free_job_history(job
);
1364 cupsArrayRemove(PrintingJobs
, job
);
1367 * Clear the printer <-> job association...
1370 job
->printer
->job
= NULL
;
1371 job
->printer
= NULL
;
1376 * 'cupsdDeleteJob()' - Free all memory used by a job.
1380 cupsdDeleteJob(cupsd_job_t
*job
, /* I - Job */
1381 cupsd_jobaction_t action
)/* I - Action */
1383 int i
; /* Looping var */
1387 finalize_job(job
, 1);
1389 if (action
== CUPSD_JOB_PURGE
)
1390 remove_job_history(job
);
1392 cupsdClearString(&job
->username
);
1393 cupsdClearString(&job
->dest
);
1395 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1397 cupsdClearString(job
->auth_env
+ i
);
1398 cupsdClearString(&job
->auth_uid
);
1400 if (action
== CUPSD_JOB_PURGE
)
1401 remove_job_files(job
);
1402 else if (job
->num_files
> 0)
1404 free(job
->compressions
);
1405 free(job
->filetypes
);
1411 free_job_history(job
);
1415 cupsArrayRemove(Jobs
, job
);
1416 cupsArrayRemove(ActiveJobs
, job
);
1417 cupsArrayRemove(PrintingJobs
, job
);
1424 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1428 cupsdFreeAllJobs(void)
1430 cupsd_job_t
*job
; /* Current job */
1438 cupsdStopAllJobs(CUPSD_JOB_FORCE
, 0);
1441 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1443 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1444 cupsdDeleteJob(job
, CUPSD_JOB_DEFAULT
);
1446 cupsdReleaseSignals();
1451 * 'cupsdFindJob()' - Find the specified job.
1454 cupsd_job_t
* /* O - Job data */
1455 cupsdFindJob(int id
) /* I - Job ID */
1457 cupsd_job_t key
; /* Search key */
1462 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
1467 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1468 * or held jobs in a printer or class.
1471 int /* O - Job count */
1472 cupsdGetPrinterJobCount(
1473 const char *dest
) /* I - Printer or class name */
1475 int count
; /* Job count */
1476 cupsd_job_t
*job
; /* Current job */
1479 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1481 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1482 if (job
->dest
&& !_cups_strcasecmp(job
->dest
, dest
))
1490 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1491 * or held jobs for a user.
1494 int /* O - Job count */
1495 cupsdGetUserJobCount(
1496 const char *username
) /* I - Username */
1498 int count
; /* Job count */
1499 cupsd_job_t
*job
; /* Current job */
1502 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1504 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1505 if (!_cups_strcasecmp(job
->username
, username
))
1513 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1517 cupsdLoadAllJobs(void)
1519 char filename
[1024]; /* Full filename of job.cache file */
1520 struct stat fileinfo
, /* Information on job.cache file */
1521 dirinfo
; /* Information on RequestRoot dir */
1526 * Create the job arrays as needed...
1530 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1533 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1536 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1539 * See whether the job.cache file is older than the RequestRoot directory...
1542 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1544 if (stat(filename
, &fileinfo
))
1546 fileinfo
.st_mtime
= 0;
1548 if (errno
!= ENOENT
)
1549 cupsdLogMessage(CUPSD_LOG_ERROR
,
1550 "Unable to get file information for \"%s\" - %s",
1551 filename
, strerror(errno
));
1554 if (stat(RequestRoot
, &dirinfo
))
1556 dirinfo
.st_mtime
= 0;
1558 if (errno
!= ENOENT
)
1559 cupsdLogMessage(CUPSD_LOG_ERROR
,
1560 "Unable to get directory information for \"%s\" - %s",
1561 RequestRoot
, strerror(errno
));
1565 * Load the most recent source for job data...
1568 if (dirinfo
.st_mtime
> fileinfo
.st_mtime
)
1570 load_request_root();
1572 load_next_job_id(filename
);
1575 load_job_cache(filename
);
1578 * Clean out old jobs as needed...
1581 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1587 * 'cupsdLoadJob()' - Load a single job.
1590 int /* O - 1 on success, 0 on failure */
1591 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1593 int i
; /* Looping var */
1594 char jobfile
[1024]; /* Job filename */
1595 cups_file_t
*fp
; /* Job file */
1596 int fileid
; /* Current file ID */
1597 ipp_attribute_t
*attr
; /* Job attribute */
1598 const char *dest
; /* Destination name */
1599 cupsd_printer_t
*destptr
; /* Pointer to destination */
1600 mime_type_t
**filetypes
; /* New filetypes array */
1601 int *compressions
; /* New compressions array */
1606 if (job
->state_value
> IPP_JOB_STOPPED
)
1607 job
->access_time
= time(NULL
);
1612 if ((job
->attrs
= ippNew()) == NULL
)
1614 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes.");
1619 * Load job attributes...
1622 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading attributes...", job
->id
);
1624 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1625 if ((fp
= cupsdOpenConfFile(jobfile
)) == NULL
)
1628 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1630 cupsdLogMessage(CUPSD_LOG_ERROR
,
1631 "[Job %d] Unable to read job control file \"%s\".", job
->id
,
1640 * Copy attribute data to the job object...
1643 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1645 cupsdLogMessage(CUPSD_LOG_ERROR
,
1646 "[Job %d] Missing or bad time-at-creation attribute in "
1647 "control file.", job
->id
);
1651 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1652 IPP_TAG_ENUM
)) == NULL
)
1654 cupsdLogMessage(CUPSD_LOG_ERROR
,
1655 "[Job %d] Missing or bad job-state attribute in control "
1660 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1662 job
->history_time
= 0;
1664 if (job
->state_value
>= IPP_JOB_CANCELED
&&
1665 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
1666 IPP_TAG_INTEGER
)) != NULL
)
1668 if (JobHistory
< INT_MAX
)
1669 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
1671 job
->history_time
= INT_MAX
;
1673 if (job
->history_time
< time(NULL
))
1674 goto error
; /* Expired, remove from history */
1676 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1677 JobHistoryUpdate
= job
->history_time
;
1679 if (JobFiles
< INT_MAX
)
1680 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
1682 job
->file_time
= INT_MAX
;
1684 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1685 JobHistoryUpdate
= job
->file_time
;
1687 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdLoadJob: JobHistoryUpdate=%ld",
1688 (long)JobHistoryUpdate
);
1693 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1694 IPP_TAG_URI
)) == NULL
)
1696 cupsdLogMessage(CUPSD_LOG_ERROR
,
1697 "[Job %d] No job-printer-uri attribute in control file.",
1702 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1705 cupsdLogMessage(CUPSD_LOG_ERROR
,
1706 "[Job %d] Unable to queue job for destination \"%s\".",
1707 job
->id
, attr
->values
[0].string
.text
);
1711 cupsdSetString(&job
->dest
, dest
);
1713 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1715 cupsdLogMessage(CUPSD_LOG_ERROR
,
1716 "[Job %d] Unable to queue job for destination \"%s\".",
1717 job
->id
, job
->dest
);
1721 if ((job
->reasons
= ippFindAttribute(job
->attrs
, "job-state-reasons",
1722 IPP_TAG_KEYWORD
)) == NULL
)
1724 const char *reason
; /* job-state-reason keyword */
1726 cupsdLogMessage(CUPSD_LOG_DEBUG
,
1727 "[Job %d] Adding missing job-state-reasons attribute to "
1728 " control file.", job
->id
);
1730 switch (job
->state_value
)
1733 case IPP_JOB_PENDING
:
1734 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1735 reason
= "printer-stopped";
1741 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1742 IPP_TAG_ZERO
)) != NULL
&&
1743 (attr
->value_tag
== IPP_TAG_NAME
||
1744 attr
->value_tag
== IPP_TAG_NAMELANG
||
1745 attr
->value_tag
== IPP_TAG_KEYWORD
) &&
1746 strcmp(attr
->values
[0].string
.text
, "no-hold"))
1747 reason
= "job-hold-until-specified";
1749 reason
= "job-incoming";
1752 case IPP_JOB_PROCESSING
:
1753 reason
= "job-printing";
1756 case IPP_JOB_STOPPED
:
1757 reason
= "job-stopped";
1760 case IPP_JOB_CANCELED
:
1761 reason
= "job-canceled-by-user";
1764 case IPP_JOB_ABORTED
:
1765 reason
= "aborted-by-system";
1768 case IPP_JOB_COMPLETED
:
1769 reason
= "job-completed-successfully";
1773 job
->reasons
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
1774 "job-state-reasons", NULL
, reason
);
1776 else if (job
->state_value
== IPP_JOB_PENDING
)
1778 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1779 ippSetString(job
->attrs
, &job
->reasons
, 0, "printer-stopped");
1781 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
1784 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed",
1786 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1790 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1791 IPP_TAG_INTEGER
)) == NULL
)
1793 cupsdLogMessage(CUPSD_LOG_ERROR
,
1794 "[Job %d] Missing or bad job-priority attribute in "
1795 "control file.", job
->id
);
1799 job
->priority
= attr
->values
[0].integer
;
1804 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1805 IPP_TAG_NAME
)) == NULL
)
1807 cupsdLogMessage(CUPSD_LOG_ERROR
,
1808 "[Job %d] Missing or bad job-originating-user-name "
1809 "attribute in control file.", job
->id
);
1813 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1817 * Set the job hold-until time and state...
1820 if (job
->state_value
== IPP_JOB_HELD
)
1822 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1823 IPP_TAG_KEYWORD
)) == NULL
)
1824 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1827 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1830 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1831 job
->state_value
= IPP_JOB_PENDING
;
1834 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1836 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1837 job
->state_value
= IPP_JOB_PENDING
;
1840 if (!job
->num_files
)
1843 * Find all the d##### files...
1846 for (fileid
= 1; fileid
< 10000; fileid
++)
1848 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1851 if (access(jobfile
, 0))
1854 cupsdLogMessage(CUPSD_LOG_DEBUG
,
1855 "[Job %d] Auto-typing document file \"%s\"...", job
->id
,
1858 if (fileid
> job
->num_files
)
1860 if (job
->num_files
== 0)
1862 compressions
= (int *)calloc(fileid
, sizeof(int));
1863 filetypes
= (mime_type_t
**)calloc(fileid
, sizeof(mime_type_t
*));
1867 compressions
= (int *)realloc(job
->compressions
,
1868 sizeof(int) * fileid
);
1869 filetypes
= (mime_type_t
**)realloc(job
->filetypes
,
1870 sizeof(mime_type_t
*) *
1874 if (!compressions
|| !filetypes
)
1876 cupsdLogMessage(CUPSD_LOG_ERROR
,
1877 "[Job %d] Ran out of memory for job file types.",
1880 ippDelete(job
->attrs
);
1889 if (job
->compressions
)
1891 free(job
->compressions
);
1892 job
->compressions
= NULL
;
1897 free(job
->filetypes
);
1898 job
->filetypes
= NULL
;
1905 job
->compressions
= compressions
;
1906 job
->filetypes
= filetypes
;
1907 job
->num_files
= fileid
;
1910 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1911 job
->compressions
+ fileid
- 1);
1913 if (!job
->filetypes
[fileid
- 1])
1914 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1920 * Load authentication information as needed...
1923 if (job
->state_value
< IPP_JOB_STOPPED
)
1925 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1928 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1930 cupsdClearString(job
->auth_env
+ i
);
1931 cupsdClearString(&job
->auth_uid
);
1933 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
1935 int bytes
, /* Size of auth data */
1936 linenum
= 1; /* Current line number */
1937 char line
[65536], /* Line from file */
1938 *value
, /* Value from line */
1939 data
[65536]; /* Decoded data */
1942 if (cupsFileGets(fp
, line
, sizeof(line
)) &&
1943 !strcmp(line
, "CUPSD-AUTH-V2"))
1946 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
1952 bytes
= sizeof(data
);
1953 httpDecode64_2(data
, &bytes
, value
);
1956 * Assign environment variables...
1959 if (!strcmp(line
, "uid"))
1961 cupsdSetStringf(&job
->auth_uid
, "AUTH_UID=%s", value
);
1964 else if (i
>= (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0])))
1967 if (!strcmp(line
, "username"))
1968 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_USERNAME=%s", data
);
1969 else if (!strcmp(line
, "domain"))
1970 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_DOMAIN=%s", data
);
1971 else if (!strcmp(line
, "password"))
1972 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_PASSWORD=%s", data
);
1973 else if (!strcmp(line
, "negotiate"))
1974 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_NEGOTIATE=%s", data
);
1986 job
->access_time
= time(NULL
);
1990 * If we get here then something bad happened...
1995 ippDelete(job
->attrs
);
1998 remove_job_history(job
);
1999 remove_job_files(job
);
2006 * 'cupsdMoveJob()' - Move the specified job to a different destination.
2010 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
2011 cupsd_printer_t
*p
) /* I - Destination printer or class */
2013 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
2014 const char *olddest
; /* Old destination */
2015 cupsd_printer_t
*oldp
; /* Old pointer */
2019 * Don't move completed jobs...
2022 if (job
->state_value
> IPP_JOB_STOPPED
)
2026 * Get the old destination...
2029 olddest
= job
->dest
;
2032 oldp
= job
->printer
;
2034 oldp
= cupsdFindDest(olddest
);
2037 * Change the destination information...
2040 if (job
->state_value
> IPP_JOB_HELD
)
2041 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2042 "Stopping job prior to move.");
2044 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
2045 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2048 cupsdSetString(&job
->dest
, p
->name
);
2049 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
);
2051 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
2052 IPP_TAG_URI
)) != NULL
)
2053 cupsdSetString(&(attr
->values
[0].string
.text
), p
->uri
);
2055 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
2056 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2060 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2065 * 'cupsdReleaseJob()' - Release the specified job.
2069 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
2071 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
2074 if (job
->state_value
== IPP_JOB_HELD
)
2077 * Add trailing banner as needed...
2080 if (job
->pending_timeout
)
2081 cupsdTimeoutJob(job
);
2083 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2084 "Job released by user.");
2090 * 'cupsdRestartJob()' - Restart the specified job.
2094 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
2096 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
2099 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
2100 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2101 "Job restarted by user.");
2106 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2110 cupsdSaveAllJobs(void)
2112 int i
; /* Looping var */
2113 cups_file_t
*fp
; /* job.cache file */
2114 char filename
[1024], /* job.cache filename */
2115 temp
[1024]; /* Temporary string */
2116 cupsd_job_t
*job
; /* Current job */
2117 time_t curtime
; /* Current time */
2118 struct tm
*curdate
; /* Current date */
2121 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
2122 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
)) == NULL
)
2125 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job.cache...");
2128 * Write a small header to the file...
2131 curtime
= time(NULL
);
2132 curdate
= localtime(&curtime
);
2133 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
2135 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
2136 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
2137 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
2140 * Write each job known to the system...
2143 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2145 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2147 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
2148 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
2149 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
2150 cupsFilePrintf(fp
, "HoldUntil %d\n", (int)job
->hold_until
);
2151 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
2152 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
2153 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
2154 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
2155 for (i
= 0; i
< job
->num_files
; i
++)
2156 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
2157 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
2158 cupsFilePuts(fp
, "</Job>\n");
2161 cupsdCloseCreatedConfFile(fp
, filename
);
2166 * 'cupsdSaveJob()' - Save a job to disk.
2170 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
2172 char filename
[1024]; /* Job control filename */
2173 cups_file_t
*fp
; /* Job file */
2176 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2177 job
, job
->id
, job
->attrs
);
2179 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
2181 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
& 0600)) == NULL
)
2184 fchown(cupsFileNumber(fp
), RunUser
, Group
);
2186 job
->attrs
->state
= IPP_IDLE
;
2188 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
2189 job
->attrs
) != IPP_DATA
)
2191 cupsdLogMessage(CUPSD_LOG_ERROR
,
2192 "[Job %d] Unable to write job control file.", job
->id
);
2197 if (!cupsdCloseCreatedConfFile(fp
, filename
))
2203 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2207 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
2208 const char *when
, /* I - When to resume */
2209 int update
)/* I - Update job-hold-until attr? */
2211 time_t curtime
; /* Current time */
2212 struct tm
*curdate
; /* Current date */
2213 int hour
; /* Hold hour */
2214 int minute
; /* Hold minute */
2215 int second
= 0; /* Hold second */
2218 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2219 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2220 job
, job
->id
, when
, update
);
2225 * Update the job-hold-until attribute...
2228 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2230 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2231 IPP_TAG_KEYWORD
)) == NULL
)
2232 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2235 cupsdSetString(&(attr
->values
[0].string
.text
), when
);
2237 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2238 "job-hold-until", NULL
, when
);
2242 if (isdigit(when
[0] & 255))
2243 attr
->value_tag
= IPP_TAG_NAME
;
2245 attr
->value_tag
= IPP_TAG_KEYWORD
;
2248 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2251 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-hold-until-specified");
2255 * Update the hold time...
2258 job
->cancel_time
= 0;
2260 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2263 * Hold indefinitely...
2266 job
->hold_until
= 0;
2268 if (MaxHoldTime
> 0)
2269 job
->cancel_time
= time(NULL
) + MaxHoldTime
;
2271 else if (!strcmp(when
, "day-time"))
2274 * Hold to 6am the next morning unless local time is < 6pm.
2277 curtime
= time(NULL
);
2278 curdate
= localtime(&curtime
);
2280 if (curdate
->tm_hour
< 18)
2281 job
->hold_until
= curtime
;
2283 job
->hold_until
= curtime
+
2284 ((29 - curdate
->tm_hour
) * 60 + 59 -
2285 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2287 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2290 * Hold to 6pm unless local time is > 6pm or < 6am.
2293 curtime
= time(NULL
);
2294 curdate
= localtime(&curtime
);
2296 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2297 job
->hold_until
= curtime
;
2299 job
->hold_until
= curtime
+
2300 ((17 - curdate
->tm_hour
) * 60 + 59 -
2301 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2303 else if (!strcmp(when
, "second-shift"))
2306 * Hold to 4pm unless local time is > 4pm.
2309 curtime
= time(NULL
);
2310 curdate
= localtime(&curtime
);
2312 if (curdate
->tm_hour
>= 16)
2313 job
->hold_until
= curtime
;
2315 job
->hold_until
= curtime
+
2316 ((15 - curdate
->tm_hour
) * 60 + 59 -
2317 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2319 else if (!strcmp(when
, "third-shift"))
2322 * Hold to 12am unless local time is < 8am.
2325 curtime
= time(NULL
);
2326 curdate
= localtime(&curtime
);
2328 if (curdate
->tm_hour
< 8)
2329 job
->hold_until
= curtime
;
2331 job
->hold_until
= curtime
+
2332 ((23 - curdate
->tm_hour
) * 60 + 59 -
2333 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2335 else if (!strcmp(when
, "weekend"))
2338 * Hold to weekend unless we are in the weekend.
2341 curtime
= time(NULL
);
2342 curdate
= localtime(&curtime
);
2344 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2345 job
->hold_until
= curtime
;
2347 job
->hold_until
= curtime
+
2348 (((5 - curdate
->tm_wday
) * 24 +
2349 (17 - curdate
->tm_hour
)) * 60 + 59 -
2350 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2352 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2355 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2358 curtime
= time(NULL
);
2359 curdate
= gmtime(&curtime
);
2361 job
->hold_until
= curtime
+
2362 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2363 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2366 * Hold until next day as needed...
2369 if (job
->hold_until
< curtime
)
2370 job
->hold_until
+= 24 * 60 * 60;
2373 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2374 (int)job
->hold_until
);
2379 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2380 * the list as needed.
2384 cupsdSetJobPriority(
2385 cupsd_job_t
*job
, /* I - Job ID */
2386 int priority
) /* I - New priority (0 to 100) */
2388 ipp_attribute_t
*attr
; /* Job attribute */
2392 * Don't change completed jobs...
2395 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2399 * Set the new priority and re-add the job into the active list...
2402 cupsArrayRemove(ActiveJobs
, job
);
2404 job
->priority
= priority
;
2406 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2407 IPP_TAG_INTEGER
)) != NULL
)
2408 attr
->values
[0].integer
= priority
;
2410 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2413 cupsArrayAdd(ActiveJobs
, job
);
2416 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2421 * 'cupsdSetJobState()' - Set the state of the specified print job.
2426 cupsd_job_t
*job
, /* I - Job to cancel */
2427 ipp_jstate_t newstate
, /* I - New job state */
2428 cupsd_jobaction_t action
, /* I - Action to take */
2429 const char *message
, /* I - Message to log */
2430 ...) /* I - Additional arguments as needed */
2432 int i
; /* Looping var */
2433 ipp_jstate_t oldstate
; /* Old state */
2434 char filename
[1024]; /* Job filename */
2435 ipp_attribute_t
*attr
; /* Job attribute */
2438 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2439 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2440 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2441 newstate
, action
, message
? message
: "(null)");
2445 * Make sure we have the job attributes...
2448 if (!cupsdLoadJob(job
))
2452 * Don't do anything if the state is unchanged and we aren't purging the
2456 oldstate
= job
->state_value
;
2457 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2461 * Stop any processes that are working on the current job...
2464 if (oldstate
== IPP_JOB_PROCESSING
)
2465 stop_job(job
, action
);
2468 * Set the new job state...
2471 job
->state
->values
[0].integer
= newstate
;
2472 job
->state_value
= newstate
;
2476 case IPP_JOB_PENDING
:
2478 * Update job-hold-until as needed...
2481 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2482 IPP_TAG_KEYWORD
)) == NULL
)
2483 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2487 attr
->value_tag
= IPP_TAG_KEYWORD
;
2488 cupsdSetString(&(attr
->values
[0].string
.text
), "no-hold");
2494 case IPP_JOB_ABORTED
:
2495 case IPP_JOB_CANCELED
:
2496 case IPP_JOB_COMPLETED
:
2497 set_time(job
, "time-at-completed");
2498 ippSetString(job
->attrs
, &job
->reasons
, 0, "processing-to-stop-point");
2503 * Log message as needed...
2508 char buffer
[2048]; /* Message buffer */
2509 va_list ap
; /* Pointer to additional arguments */
2511 va_start(ap
, message
);
2512 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2515 if (newstate
> IPP_JOB_STOPPED
)
2516 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2518 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2520 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2521 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2523 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2527 * Handle post-state-change actions...
2532 case IPP_JOB_PROCESSING
:
2534 * Add the job to the "printing" list...
2537 if (!cupsArrayFind(PrintingJobs
, job
))
2538 cupsArrayAdd(PrintingJobs
, job
);
2541 * Set the processing time...
2544 set_time(job
, "time-at-processing");
2546 case IPP_JOB_PENDING
:
2548 case IPP_JOB_STOPPED
:
2550 * Make sure the job is in the active list...
2553 if (!cupsArrayFind(ActiveJobs
, job
))
2554 cupsArrayAdd(ActiveJobs
, job
);
2557 * Save the job state to disk...
2561 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2564 case IPP_JOB_ABORTED
:
2565 case IPP_JOB_CANCELED
:
2566 case IPP_JOB_COMPLETED
:
2567 if (newstate
== IPP_JOB_CANCELED
)
2570 * Remove the job from the active list if there are no processes still
2574 for (i
= 0; job
->filters
[i
] < 0; i
++);
2576 if (!job
->filters
[i
] && job
->backend
<= 0)
2577 cupsArrayRemove(ActiveJobs
, job
);
2582 * Otherwise just remove the job from the active list immediately...
2585 cupsArrayRemove(ActiveJobs
, job
);
2589 * Expire job subscriptions since the job is now "completed"...
2592 cupsdExpireSubscriptions(NULL
, job
);
2596 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2597 * sleep to happen immediately...
2600 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2602 #endif /* __APPLE__ */
2605 * Remove any authentication data...
2608 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2609 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2610 cupsdLogMessage(CUPSD_LOG_ERROR
,
2611 "Unable to remove authentication cache: %s",
2615 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
2617 cupsdClearString(job
->auth_env
+ i
);
2619 cupsdClearString(&job
->auth_uid
);
2622 * Remove the print file for good if we aren't preserving jobs or
2626 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2627 remove_job_files(job
);
2629 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2632 * Save job state info...
2636 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2638 else if (!job
->printer
)
2641 * Delete the job immediately if not actively printing...
2644 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2651 * Finalize the job immediately if we forced things...
2654 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2655 finalize_job(job
, 0);
2658 * Update the server "busy" state...
2661 cupsdSetBusyState();
2666 * 'cupsdStopAllJobs()' - Stop all print jobs.
2671 cupsd_jobaction_t action
, /* I - Action */
2672 int kill_delay
) /* I - Number of seconds before we kill */
2674 cupsd_job_t
*job
; /* Current job */
2677 DEBUG_puts("cupsdStopAllJobs()");
2679 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2681 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2684 job
->kill_time
= time(NULL
) + kill_delay
;
2686 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2692 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2696 cupsdUnloadCompletedJobs(void)
2698 cupsd_job_t
*job
; /* Current job */
2699 time_t expire
; /* Expiration time */
2702 expire
= time(NULL
) - 60;
2704 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2706 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2707 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2708 job
->access_time
< expire
)
2719 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2723 cupsdUpdateJobs(void)
2725 cupsd_job_t
*job
; /* Current job */
2726 time_t curtime
; /* Current time */
2727 ipp_attribute_t
*attr
; /* time-at-completed attribute */
2730 curtime
= time(NULL
);
2731 JobHistoryUpdate
= 0;
2733 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2735 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2737 if (job
->state_value
>= IPP_JOB_CANCELED
&&
2738 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
2739 IPP_TAG_INTEGER
)) != NULL
)
2742 * Update history/file expiration times...
2745 if (JobHistory
< INT_MAX
)
2746 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
2748 job
->history_time
= INT_MAX
;
2750 if (job
->history_time
< curtime
)
2752 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2756 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2757 JobHistoryUpdate
= job
->history_time
;
2759 if (JobFiles
< INT_MAX
)
2760 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
2762 job
->file_time
= INT_MAX
;
2764 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2765 JobHistoryUpdate
= job
->file_time
;
2769 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdUpdateAllJobs: JobHistoryUpdate=%ld",
2770 (long)JobHistoryUpdate
);
2775 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2778 static int /* O - Difference */
2779 compare_active_jobs(void *first
, /* I - First job */
2780 void *second
, /* I - Second job */
2781 void *data
) /* I - App data (not used) */
2783 int diff
; /* Difference */
2788 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2789 ((cupsd_job_t
*)first
)->priority
) != 0)
2792 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2797 * 'compare_jobs()' - Compare the job IDs of two jobs.
2800 static int /* O - Difference */
2801 compare_jobs(void *first
, /* I - First job */
2802 void *second
, /* I - Second job */
2803 void *data
) /* I - App data (not used) */
2807 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2812 * 'dump_job_history()' - Dump any debug messages for a job.
2816 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2818 int i
, /* Looping var */
2819 oldsize
; /* Current MaxLogSize */
2820 struct tm
*date
; /* Date/time value */
2821 cupsd_joblog_t
*message
; /* Current message */
2822 char temp
[2048], /* Log message */
2823 *ptr
, /* Pointer into log message */
2824 start
[256], /* Start time */
2825 end
[256]; /* End time */
2826 cupsd_printer_t
*printer
; /* Printer for job */
2830 * See if we have anything to dump...
2837 * Disable log rotation temporarily...
2840 oldsize
= MaxLogSize
;
2844 * Copy the debug messages to the log...
2847 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2848 date
= localtime(&(message
->time
));
2849 strftime(start
, sizeof(start
), "%X", date
);
2851 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2852 date
= localtime(&(message
->time
));
2853 strftime(end
, sizeof(end
), "%X", date
);
2855 snprintf(temp
, sizeof(temp
),
2856 "[Job %d] The following messages were recorded from %s to %s",
2857 job
->id
, start
, end
);
2858 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2860 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2862 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
2863 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
2865 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
2866 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2869 * Log the printer state values...
2872 if ((printer
= job
->printer
) == NULL
)
2873 printer
= cupsdFindDest(job
->dest
);
2877 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
2879 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
2880 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
2882 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2884 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
2885 job
->id
, printer
->state_message
);
2886 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2888 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
2889 ptr
= temp
+ strlen(temp
);
2890 if (printer
->num_reasons
== 0)
2891 strlcpy(ptr
, "none", sizeof(temp
) - (ptr
- temp
));
2895 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
2901 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (ptr
- temp
));
2905 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2909 * Restore log file rotation...
2912 MaxLogSize
= oldsize
;
2915 * Free all messages...
2918 free_job_history(job
);
2923 * 'free_job_history()' - Free any log history.
2927 free_job_history(cupsd_job_t
*job
) /* I - Job */
2929 char *message
; /* Current message */
2935 for (message
= (char *)cupsArrayFirst(job
->history
);
2937 message
= (char *)cupsArrayNext(job
->history
))
2940 cupsArrayDelete(job
->history
);
2941 job
->history
= NULL
;
2946 * 'finalize_job()' - Cleanup after job filter processes and support data.
2950 finalize_job(cupsd_job_t
*job
, /* I - Job */
2951 int set_job_state
) /* I - 1 = set the job state */
2953 ipp_pstate_t printer_state
; /* New printer state value */
2954 ipp_jstate_t job_state
; /* New job state value */
2955 const char *message
; /* Message for job state */
2956 char buffer
[1024]; /* Buffer for formatted messages */
2959 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
2962 * Clear the "connecting-to-device" reason, which is only valid when a printer
2963 * is processing, along with any remote printing job state...
2966 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device,"
2967 "cups-remote-pending,"
2968 "cups-remote-pending-held,"
2969 "cups-remote-processing,"
2970 "cups-remote-stopped,"
2971 "cups-remote-canceled,"
2972 "cups-remote-aborted,"
2973 "cups-remote-completed");
2976 * Similarly, clear the "offline-report" reason for non-USB devices since we
2977 * rarely have current information for network devices...
2980 if (strncmp(job
->printer
->device_uri
, "usb:", 4))
2981 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
2984 * Free the security profile...
2987 cupsdDestroyProfile(job
->profile
);
2988 job
->profile
= NULL
;
2991 * Clear the unresponsive job watchdog timer...
2997 * Close pipes and status buffer...
3000 cupsdClosePipe(job
->print_pipes
);
3001 cupsdClosePipe(job
->back_pipes
);
3002 cupsdClosePipe(job
->side_pipes
);
3004 cupsdRemoveSelect(job
->status_pipes
[0]);
3005 cupsdClosePipe(job
->status_pipes
);
3006 cupsdStatBufDelete(job
->status_buffer
);
3007 job
->status_buffer
= NULL
;
3010 * Process the exit status...
3013 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
3014 printer_state
= IPP_PRINTER_IDLE
;
3016 printer_state
= job
->printer
->state
;
3018 switch (job_state
= job
->state_value
)
3020 case IPP_JOB_PENDING
:
3021 message
= "Job paused.";
3025 message
= "Job held.";
3029 case IPP_JOB_PROCESSING
:
3030 case IPP_JOB_COMPLETED
:
3031 job_state
= IPP_JOB_COMPLETED
;
3032 message
= "Job completed.";
3034 ippSetString(job
->attrs
, &job
->reasons
, 0,
3035 "job-completed-successfully");
3038 case IPP_JOB_STOPPED
:
3039 message
= "Job stopped.";
3041 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-stopped");
3044 case IPP_JOB_CANCELED
:
3045 message
= "Job canceled.";
3047 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-canceled-by-user");
3050 case IPP_JOB_ABORTED
:
3051 message
= "Job aborted.";
3055 if (job
->status
< 0)
3058 * Backend had errors...
3061 int exit_code
; /* Exit code from backend */
3064 * Convert the status to an exit code. Due to the way the W* macros are
3065 * implemented on MacOS X (bug?), we have to store the exit status in a
3066 * variable first and then convert...
3069 exit_code
= -job
->status
;
3070 if (WIFEXITED(exit_code
))
3071 exit_code
= WEXITSTATUS(exit_code
);
3074 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-backend-crashed");
3075 exit_code
= job
->status
;
3078 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
3080 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
3081 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
3082 "authentication required" :
3083 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
3084 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
3085 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
3086 exit_code
< 0 ? "crashed" : "unknown");
3089 * Do what needs to be done...
3095 case CUPS_BACKEND_FAILED
:
3097 * Backend failure, use the error-policy to determine how to
3101 if (job
->dtype
& CUPS_PRINTER_CLASS
)
3104 * Queued on a class - mark the job as pending and we'll retry on
3105 * another printer...
3108 if (job_state
== IPP_JOB_COMPLETED
)
3110 job_state
= IPP_JOB_PENDING
;
3111 message
= "Retrying job on another printer.";
3113 ippSetString(job
->attrs
, &job
->reasons
, 0,
3114 "resources-are-not-ready");
3117 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
3120 * The error policy is "retry-current-job" - mark the job as pending
3121 * and we'll retry on the same printer...
3124 if (job_state
== IPP_JOB_COMPLETED
)
3126 job_state
= IPP_JOB_PENDING
;
3127 message
= "Retrying job on same printer.";
3129 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3132 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
3133 !strcmp(job
->printer
->error_policy
, "retry-job"))
3135 if (job_state
== IPP_JOB_COMPLETED
)
3138 * The job was queued on a fax or the error policy is "retry-job" -
3139 * hold the job if the number of retries is less than the
3140 * JobRetryLimit, otherwise abort the job.
3145 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3151 snprintf(buffer
, sizeof(buffer
),
3152 "Job aborted after %d unsuccessful attempts.",
3154 job_state
= IPP_JOB_ABORTED
;
3157 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3162 * Try again in N seconds...
3165 snprintf(buffer
, sizeof(buffer
),
3166 "Job held for %d seconds since it could not be sent.",
3169 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3170 job_state
= IPP_JOB_HELD
;
3173 ippSetString(job
->attrs
, &job
->reasons
, 0,
3174 "resources-are-not-ready");
3178 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
3179 job_state
== IPP_JOB_COMPLETED
)
3181 job_state
= IPP_JOB_ABORTED
;
3182 message
= "Job aborted due to backend errors; please consult "
3183 "the error_log file for details.";
3185 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3187 else if (job
->state_value
== IPP_JOB_PROCESSING
)
3189 job_state
= IPP_JOB_PENDING
;
3190 printer_state
= IPP_PRINTER_STOPPED
;
3191 message
= "Printer stopped due to backend errors; please "
3192 "consult the error_log file for details.";
3194 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3198 case CUPS_BACKEND_CANCEL
:
3203 if (job_state
== IPP_JOB_COMPLETED
)
3205 job_state
= IPP_JOB_CANCELED
;
3206 message
= "Job canceled at printer.";
3208 ippSetString(job
->attrs
, &job
->reasons
, 0, "canceled-at-device");
3212 case CUPS_BACKEND_HOLD
:
3213 if (job_state
== IPP_JOB_COMPLETED
)
3219 cupsdSetJobHoldUntil(job
, "indefinite", 1);
3220 ippSetString(job
->attrs
, &job
->reasons
, 0,
3221 "job-hold-until-specified");
3223 job_state
= IPP_JOB_HELD
;
3224 message
= "Job held indefinitely due to backend errors; please "
3225 "consult the error_log file for details.";
3229 case CUPS_BACKEND_STOP
:
3231 * Stop the printer...
3234 printer_state
= IPP_PRINTER_STOPPED
;
3235 message
= "Printer stopped due to backend errors; please "
3236 "consult the error_log file for details.";
3238 if (job_state
== IPP_JOB_COMPLETED
)
3240 job_state
= IPP_JOB_PENDING
;
3242 ippSetString(job
->attrs
, &job
->reasons
, 0,
3243 "resources-are-not-ready");
3247 case CUPS_BACKEND_AUTH_REQUIRED
:
3249 * Hold the job for authentication...
3252 if (job_state
== IPP_JOB_COMPLETED
)
3254 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
3256 job_state
= IPP_JOB_HELD
;
3257 message
= "Job held for authentication.";
3259 ippSetString(job
->attrs
, &job
->reasons
, 0,
3260 "cups-held-for-authentication");
3264 case CUPS_BACKEND_RETRY
:
3265 if (job_state
== IPP_JOB_COMPLETED
)
3268 * Hold the job if the number of retries is less than the
3269 * JobRetryLimit, otherwise abort the job.
3274 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3280 snprintf(buffer
, sizeof(buffer
),
3281 "Job aborted after %d unsuccessful attempts.",
3283 job_state
= IPP_JOB_ABORTED
;
3286 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3291 * Try again in N seconds...
3294 snprintf(buffer
, sizeof(buffer
),
3295 "Job held for %d seconds since it could not be sent.",
3298 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3299 job_state
= IPP_JOB_HELD
;
3302 ippSetString(job
->attrs
, &job
->reasons
, 0,
3303 "resources-are-not-ready");
3308 case CUPS_BACKEND_RETRY_CURRENT
:
3310 * Mark the job as pending and retry on the same printer...
3313 if (job_state
== IPP_JOB_COMPLETED
)
3315 job_state
= IPP_JOB_PENDING
;
3316 message
= "Retrying job on same printer.";
3318 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3323 else if (job
->status
> 0)
3326 * Filter had errors; stop job...
3329 if (job_state
== IPP_JOB_COMPLETED
)
3331 job_state
= IPP_JOB_STOPPED
;
3332 message
= "Job stopped due to filter errors; please consult the "
3333 "error_log file for details.";
3335 if (WIFSIGNALED(job
->status
))
3336 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-filter-crashed");
3338 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-completed-with-errors");
3343 * Update the printer and job state.
3346 if (set_job_state
&& job_state
!= job
->state_value
)
3347 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
3349 cupsdSetPrinterState(job
->printer
, printer_state
,
3350 printer_state
== IPP_PRINTER_STOPPED
);
3351 update_job_attrs(job
, 0);
3356 (job
->state_value
== IPP_JOB_ABORTED
||
3357 job
->state_value
== IPP_JOB_STOPPED
))
3358 dump_job_history(job
);
3360 free_job_history(job
);
3363 cupsArrayRemove(PrintingJobs
, job
);
3366 * Apply any PPD updates...
3369 if (job
->num_keywords
)
3371 if (cupsdUpdatePrinterPPD(job
->printer
, job
->num_keywords
, job
->keywords
))
3372 cupsdSetPrinterAttrs(job
->printer
);
3374 cupsFreeOptions(job
->num_keywords
, job
->keywords
);
3376 job
->num_keywords
= 0;
3377 job
->keywords
= NULL
;
3381 * Clear the printer <-> job association...
3384 job
->printer
->job
= NULL
;
3385 job
->printer
= NULL
;
3388 * Try printing another job...
3391 if (printer_state
!= IPP_PRINTER_STOPPED
)
3397 * 'get_options()' - Get a string containing the job options.
3400 static char * /* O - Options string */
3401 get_options(cupsd_job_t
*job
, /* I - Job */
3402 int banner_page
, /* I - Printing a banner page? */
3403 char *copies
, /* I - Copies buffer */
3404 size_t copies_size
, /* I - Size of copies buffer */
3405 char *title
, /* I - Title buffer */
3406 size_t title_size
) /* I - Size of title buffer */
3408 int i
; /* Looping var */
3409 size_t newlength
; /* New option buffer length */
3410 char *optptr
, /* Pointer to options */
3411 *valptr
; /* Pointer in value string */
3412 ipp_attribute_t
*attr
; /* Current attribute */
3413 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3414 int num_pwgppds
; /* Number of PWG->PPD options */
3415 cups_option_t
*pwgppds
, /* PWG->PPD options */
3416 *pwgppd
, /* Current PWG->PPD option */
3417 *preset
; /* Current preset option */
3418 int print_color_mode
,
3419 /* Output mode (if any) */
3420 print_quality
; /* Print quality (if any) */
3421 const char *ppd
; /* PPD option choice */
3422 int exact
; /* Did we get an exact match? */
3423 static char *options
= NULL
;/* Full list of options */
3424 static size_t optlength
= 0; /* Length of option buffer */
3428 * Building the options string is harder than it needs to be, but for the
3429 * moment we need to pass strings for command-line args and not IPP attribute
3432 * First build an options array for any PWG->PPD mapped option/choice pairs.
3435 pc
= job
->printer
->pc
;
3440 !ippFindAttribute(job
->attrs
,
3441 "com.apple.print.DocumentTicket.PMSpoolFormat",
3443 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3444 (ippFindAttribute(job
->attrs
, "output-mode", IPP_TAG_ZERO
) ||
3445 ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) ||
3446 ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
)))
3449 * Map output-mode and print-quality to a preset...
3452 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3453 IPP_TAG_KEYWORD
)) == NULL
)
3454 attr
= ippFindAttribute(job
->attrs
, "output-mode", IPP_TAG_KEYWORD
);
3456 if (attr
&& !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3457 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3459 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3461 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality",
3462 IPP_TAG_ENUM
)) != NULL
&&
3463 attr
->values
[0].integer
>= IPP_QUALITY_DRAFT
&&
3464 attr
->values
[0].integer
<= IPP_QUALITY_HIGH
)
3465 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3467 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3469 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3472 * Try to find a preset that works so that we maximize the chances of us
3473 * getting a good print using IPP attributes.
3476 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3477 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3478 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3479 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3482 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3483 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3487 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3490 * Copy the preset options as long as the corresponding names are not
3491 * already defined in the IPP request...
3494 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3495 preset
= pc
->presets
[print_color_mode
][print_quality
];
3499 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3500 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
,
3508 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3509 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3511 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3512 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3515 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3516 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3517 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3519 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3520 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3521 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3523 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3525 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3526 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3529 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3530 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3531 IPP_TAG_ZERO
)) != NULL
&&
3532 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3533 attr
->value_tag
== IPP_TAG_NAME
) &&
3534 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3537 * Map output-bin to OutputBin option...
3540 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3543 if (pc
->sides_option
&&
3544 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3545 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3548 * Map sides to duplex option...
3551 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3552 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
,
3553 num_pwgppds
, &pwgppds
);
3554 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3555 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
,
3556 num_pwgppds
, &pwgppds
);
3557 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3558 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
,
3559 num_pwgppds
, &pwgppds
);
3563 * Map finishings values...
3566 num_pwgppds
= _ppdCacheGetFinishingOptions(pc
, job
->attrs
,
3567 IPP_FINISHINGS_NONE
, num_pwgppds
,
3572 * Figure out how much room we need...
3575 newlength
= ipp_length(job
->attrs
);
3577 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3578 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3581 * Then allocate/reallocate the option buffer as needed...
3584 if (newlength
== 0) /* This can never happen, but Clang */
3585 newlength
= 1; /* thinks it can... */
3587 if (newlength
> optlength
|| !options
)
3590 optptr
= malloc(newlength
);
3592 optptr
= realloc(options
, newlength
);
3596 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3597 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer.",
3598 CUPS_LLCAST newlength
);
3603 optlength
= newlength
;
3607 * Now loop through the attributes and convert them to the textual
3608 * representation used by the filters...
3614 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3615 strlcpy(copies
, "1", copies_size
);
3617 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3619 if (!strcmp(attr
->name
, "copies") &&
3620 attr
->value_tag
== IPP_TAG_INTEGER
)
3623 * Don't use the # copies attribute if we are printing the job sheets...
3627 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3629 else if (!strcmp(attr
->name
, "job-name") &&
3630 (attr
->value_tag
== IPP_TAG_NAME
||
3631 attr
->value_tag
== IPP_TAG_NAMELANG
))
3632 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3633 else if (attr
->group_tag
== IPP_TAG_JOB
)
3636 * Filter out other unwanted attributes...
3639 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3640 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3641 attr
->value_tag
== IPP_TAG_NAMELANG
||
3642 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3643 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid")) ||
3644 attr
->value_tag
== IPP_TAG_URISCHEME
||
3645 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3648 if (!strcmp(attr
->name
, "job-hold-until"))
3651 if (!strncmp(attr
->name
, "job-", 4) &&
3652 strcmp(attr
->name
, "job-billing") &&
3653 strcmp(attr
->name
, "job-impressions") &&
3654 strcmp(attr
->name
, "job-originating-host-name") &&
3655 strcmp(attr
->name
, "job-uuid") &&
3656 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3659 if ((!strcmp(attr
->name
, "job-impressions") ||
3660 !strcmp(attr
->name
, "page-label") ||
3661 !strcmp(attr
->name
, "page-border") ||
3662 !strncmp(attr
->name
, "number-up", 9) ||
3663 !strcmp(attr
->name
, "page-ranges") ||
3664 !strcmp(attr
->name
, "page-set") ||
3665 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3666 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3667 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3668 "PMTotalSidesImaged..n.") ||
3669 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3670 "PMTotalBeginPages..n.")) &&
3675 * Otherwise add them to the list...
3678 if (optptr
> options
)
3679 strlcat(optptr
, " ", optlength
- (optptr
- options
));
3681 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3683 strlcat(optptr
, attr
->name
, optlength
- (optptr
- options
));
3684 strlcat(optptr
, "=", optlength
- (optptr
- options
));
3687 for (i
= 0; i
< attr
->num_values
; i
++)
3690 strlcat(optptr
, ",", optlength
- (optptr
- options
));
3692 optptr
+= strlen(optptr
);
3694 switch (attr
->value_tag
)
3696 case IPP_TAG_INTEGER
:
3698 snprintf(optptr
, optlength
- (optptr
- options
),
3699 "%d", attr
->values
[i
].integer
);
3702 case IPP_TAG_BOOLEAN
:
3703 if (!attr
->values
[i
].boolean
)
3704 strlcat(optptr
, "no", optlength
- (optptr
- options
));
3706 strlcat(optptr
, attr
->name
,
3707 optlength
- (optptr
- options
));
3710 case IPP_TAG_RANGE
:
3711 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3712 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3713 "%d", attr
->values
[i
].range
.lower
);
3715 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3716 "%d-%d", attr
->values
[i
].range
.lower
,
3717 attr
->values
[i
].range
.upper
);
3720 case IPP_TAG_RESOLUTION
:
3721 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3722 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
3723 attr
->values
[i
].resolution
.yres
,
3724 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
3728 case IPP_TAG_STRING
:
3731 case IPP_TAG_KEYWORD
:
3732 case IPP_TAG_CHARSET
:
3733 case IPP_TAG_LANGUAGE
:
3735 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
3737 if (strchr(" \t\n\\\'\"", *valptr
))
3739 *optptr
++ = *valptr
++;
3746 break; /* anti-compiler-warning-code */
3750 optptr
+= strlen(optptr
);
3755 * Finally loop through the PWG->PPD mapped options and add them...
3758 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3761 strcpy(optptr
, pwgppd
->name
);
3762 optptr
+= strlen(optptr
);
3764 strcpy(optptr
, pwgppd
->value
);
3765 optptr
+= strlen(optptr
);
3768 cupsFreeOptions(num_pwgppds
, pwgppds
);
3771 * Return the options string...
3779 * 'ipp_length()' - Compute the size of the buffer needed to hold
3780 * the textual IPP attributes.
3783 static size_t /* O - Size of attribute buffer */
3784 ipp_length(ipp_t
*ipp
) /* I - IPP request */
3786 size_t bytes
; /* Number of bytes */
3787 int i
; /* Looping var */
3788 ipp_attribute_t
*attr
; /* Current attribute */
3792 * Loop through all attributes...
3797 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3800 * Skip attributes that won't be sent to filters...
3803 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3804 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3805 attr
->value_tag
== IPP_TAG_NAMELANG
||
3806 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3807 attr
->value_tag
== IPP_TAG_URI
||
3808 attr
->value_tag
== IPP_TAG_URISCHEME
)
3812 * Add space for a leading space and commas between each value.
3813 * For the first attribute, the leading space isn't used, so the
3814 * extra byte can be used as the nul terminator...
3817 bytes
++; /* " " separator */
3818 bytes
+= attr
->num_values
; /* "," separators */
3821 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3822 * other attributes appear as "foo=value1,value2,...,valueN".
3825 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3826 bytes
+= strlen(attr
->name
);
3828 bytes
+= attr
->num_values
* strlen(attr
->name
);
3831 * Now add the size required for each value in the attribute...
3834 switch (attr
->value_tag
)
3836 case IPP_TAG_INTEGER
:
3839 * Minimum value of a signed integer is -2147483647, or 11 digits.
3842 bytes
+= attr
->num_values
* 11;
3845 case IPP_TAG_BOOLEAN
:
3847 * Add two bytes for each false ("no") value...
3850 for (i
= 0; i
< attr
->num_values
; i
++)
3851 if (!attr
->values
[i
].boolean
)
3855 case IPP_TAG_RANGE
:
3857 * A range is two signed integers separated by a hyphen, or
3858 * 23 characters max.
3861 bytes
+= attr
->num_values
* 23;
3864 case IPP_TAG_RESOLUTION
:
3866 * A resolution is two signed integers separated by an "x" and
3867 * suffixed by the units, or 26 characters max.
3870 bytes
+= attr
->num_values
* 26;
3873 case IPP_TAG_STRING
:
3876 case IPP_TAG_KEYWORD
:
3877 case IPP_TAG_CHARSET
:
3878 case IPP_TAG_LANGUAGE
:
3881 * Strings can contain characters that need quoting. We need
3882 * at least 2 * len + 2 characters to cover the quotes and
3883 * any backslashes in the string.
3886 for (i
= 0; i
< attr
->num_values
; i
++)
3887 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
3891 break; /* anti-compiler-warning-code */
3900 * 'load_job_cache()' - Load jobs from the job.cache file.
3904 load_job_cache(const char *filename
) /* I - job.cache filename */
3906 cups_file_t
*fp
; /* job.cache file */
3907 char line
[1024], /* Line buffer */
3908 *value
; /* Value on line */
3909 int linenum
; /* Line number in file */
3910 cupsd_job_t
*job
; /* Current job */
3911 int jobid
; /* Job ID */
3912 char jobfile
[1024]; /* Job filename */
3916 * Open the job.cache file...
3919 if ((fp
= cupsdOpenConfFile(filename
)) == NULL
)
3921 load_request_root();
3926 * Read entries from the job cache file and create jobs as needed.
3929 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
3935 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
3937 if (!_cups_strcasecmp(line
, "NextJobId"))
3940 NextJobId
= atoi(value
);
3942 else if (!_cups_strcasecmp(line
, "<Job"))
3946 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d.",
3953 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d.", linenum
);
3957 jobid
= atoi(value
);
3961 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d.", jobid
,
3966 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
3967 if (access(jobfile
, 0))
3969 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d.N", RequestRoot
, jobid
);
3970 if (access(jobfile
, 0))
3972 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away.",
3978 job
= calloc(1, sizeof(cupsd_job_t
));
3981 cupsdLogMessage(CUPSD_LOG_EMERG
,
3982 "[Job %d] Unable to allocate memory for job.", jobid
);
3987 job
->back_pipes
[0] = -1;
3988 job
->back_pipes
[1] = -1;
3989 job
->print_pipes
[0] = -1;
3990 job
->print_pipes
[1] = -1;
3991 job
->side_pipes
[0] = -1;
3992 job
->side_pipes
[1] = -1;
3993 job
->status_pipes
[0] = -1;
3994 job
->status_pipes
[1] = -1;
3996 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading from cache...",
4001 cupsdLogMessage(CUPSD_LOG_ERROR
,
4002 "Missing <Job #> directive on line %d.", linenum
);
4005 else if (!_cups_strcasecmp(line
, "</Job>"))
4007 cupsArrayAdd(Jobs
, job
);
4009 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
4010 cupsArrayAdd(ActiveJobs
, job
);
4016 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d.", linenum
);
4019 else if (!_cups_strcasecmp(line
, "State"))
4021 job
->state_value
= (ipp_jstate_t
)atoi(value
);
4023 if (job
->state_value
< IPP_JOB_PENDING
)
4024 job
->state_value
= IPP_JOB_PENDING
;
4025 else if (job
->state_value
> IPP_JOB_COMPLETED
)
4026 job
->state_value
= IPP_JOB_COMPLETED
;
4028 else if (!_cups_strcasecmp(line
, "HoldUntil"))
4030 job
->hold_until
= atoi(value
);
4032 else if (!_cups_strcasecmp(line
, "Priority"))
4034 job
->priority
= atoi(value
);
4036 else if (!_cups_strcasecmp(line
, "Username"))
4038 cupsdSetString(&job
->username
, value
);
4040 else if (!_cups_strcasecmp(line
, "Destination"))
4042 cupsdSetString(&job
->dest
, value
);
4044 else if (!_cups_strcasecmp(line
, "DestType"))
4046 job
->dtype
= (cups_ptype_t
)atoi(value
);
4048 else if (!_cups_strcasecmp(line
, "NumFiles"))
4050 job
->num_files
= atoi(value
);
4052 if (job
->num_files
< 0)
4054 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d.",
4055 job
->num_files
, linenum
);
4060 if (job
->num_files
> 0)
4062 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
4064 if (access(jobfile
, 0))
4066 cupsdLogMessage(CUPSD_LOG_INFO
, "[Job %d] Data files have gone away.",
4072 job
->filetypes
= calloc(job
->num_files
, sizeof(mime_type_t
*));
4073 job
->compressions
= calloc(job
->num_files
, sizeof(int));
4075 if (!job
->filetypes
|| !job
->compressions
)
4077 cupsdLogMessage(CUPSD_LOG_EMERG
,
4078 "[Job %d] Unable to allocate memory for %d files.",
4079 job
->id
, job
->num_files
);
4084 else if (!_cups_strcasecmp(line
, "File"))
4086 int number
, /* File number */
4087 compression
; /* Compression value */
4088 char super
[MIME_MAX_SUPER
], /* MIME super type */
4089 type
[MIME_MAX_TYPE
]; /* MIME type */
4092 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
4095 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d.", linenum
);
4099 if (number
< 1 || number
> job
->num_files
)
4101 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d.",
4108 job
->compressions
[number
] = compression
;
4109 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
4111 if (!job
->filetypes
[number
])
4114 * If the original MIME type is unknown, auto-type it!
4117 cupsdLogMessage(CUPSD_LOG_ERROR
,
4118 "[Job %d] Unknown MIME type %s/%s for file %d.",
4119 job
->id
, super
, type
, number
+ 1);
4121 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
4122 job
->id
, number
+ 1);
4123 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
4124 job
->compressions
+ number
);
4127 * If that didn't work, assume it is raw...
4130 if (!job
->filetypes
[number
])
4131 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
4136 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d.",
4145 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4149 load_next_job_id(const char *filename
) /* I - job.cache filename */
4151 cups_file_t
*fp
; /* job.cache file */
4152 char line
[1024], /* Line buffer */
4153 *value
; /* Value on line */
4154 int linenum
; /* Line number in file */
4155 int next_job_id
; /* NextJobId value from line */
4159 * Read the NextJobId directive from the job.cache file and use
4160 * the value (if any).
4163 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4165 if (errno
!= ENOENT
)
4166 cupsdLogMessage(CUPSD_LOG_ERROR
,
4167 "Unable to open job cache file \"%s\": %s",
4168 filename
, strerror(errno
));
4173 cupsdLogMessage(CUPSD_LOG_INFO
,
4174 "Loading NextJobId from job cache file \"%s\"...", filename
);
4178 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4180 if (!_cups_strcasecmp(line
, "NextJobId"))
4184 next_job_id
= atoi(value
);
4186 if (next_job_id
> NextJobId
)
4187 NextJobId
= next_job_id
;
4198 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4202 load_request_root(void)
4204 cups_dir_t
*dir
; /* Directory */
4205 cups_dentry_t
*dent
; /* Directory entry */
4206 cupsd_job_t
*job
; /* New job */
4210 * Open the requests directory...
4213 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
4215 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
4217 cupsdLogMessage(CUPSD_LOG_ERROR
,
4218 "Unable to open spool directory \"%s\": %s",
4219 RequestRoot
, strerror(errno
));
4224 * Read all the c##### files...
4227 while ((dent
= cupsDirRead(dir
)) != NULL
)
4228 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
4231 * Allocate memory for the job...
4234 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
4236 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs.");
4242 * Assign the job ID...
4245 job
->id
= atoi(dent
->filename
+ 1);
4246 job
->back_pipes
[0] = -1;
4247 job
->back_pipes
[1] = -1;
4248 job
->print_pipes
[0] = -1;
4249 job
->print_pipes
[1] = -1;
4250 job
->side_pipes
[0] = -1;
4251 job
->side_pipes
[1] = -1;
4252 job
->status_pipes
[0] = -1;
4253 job
->status_pipes
[1] = -1;
4255 if (job
->id
>= NextJobId
)
4256 NextJobId
= job
->id
+ 1;
4262 if (cupsdLoadJob(job
))
4265 * Insert the job into the array, sorting by job priority and ID...
4268 cupsArrayAdd(Jobs
, job
);
4270 if (job
->state_value
<= IPP_JOB_STOPPED
)
4271 cupsArrayAdd(ActiveJobs
, job
);
4282 * 'remove_job_files()' - Remove the document files for a job.
4286 remove_job_files(cupsd_job_t
*job
) /* I - Job */
4288 int i
; /* Looping var */
4289 char filename
[1024]; /* Document filename */
4292 if (job
->num_files
<= 0)
4295 for (i
= 1; i
<= job
->num_files
; i
++)
4297 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
4300 cupsdRemoveFile(filename
);
4305 free(job
->filetypes
);
4306 free(job
->compressions
);
4310 job
->filetypes
= NULL
;
4311 job
->compressions
= NULL
;
4313 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4318 * 'remove_job_history()' - Remove the control file for a job.
4322 remove_job_history(cupsd_job_t
*job
) /* I - Job */
4324 char filename
[1024]; /* Control filename */
4328 * Remove the job info file...
4331 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
4334 cupsdRemoveFile(filename
);
4338 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4343 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4347 set_time(cupsd_job_t
*job
, /* I - Job to update */
4348 const char *name
) /* I - Name of attribute */
4350 ipp_attribute_t
*attr
; /* Time attribute */
4351 time_t curtime
; /* Current time */
4354 curtime
= time(NULL
);
4356 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s=%ld", name
, (long)curtime
);
4358 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
4360 attr
->value_tag
= IPP_TAG_INTEGER
;
4361 attr
->values
[0].integer
= curtime
;
4364 if (!strcmp(name
, "time-at-completed"))
4366 if (JobHistory
< INT_MAX
)
4367 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
4369 job
->history_time
= INT_MAX
;
4371 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4372 JobHistoryUpdate
= job
->history_time
;
4374 if (JobFiles
< INT_MAX
)
4375 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
4377 job
->file_time
= INT_MAX
;
4379 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4380 JobHistoryUpdate
= job
->file_time
;
4382 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "set_time: JobHistoryUpdate=%ld",
4383 (long)JobHistoryUpdate
);
4389 * 'start_job()' - Start a print job.
4393 start_job(cupsd_job_t
*job
, /* I - Job ID */
4394 cupsd_printer_t
*printer
) /* I - Printer to print job */
4396 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
4397 job
, job
->id
, printer
, printer
->name
);
4400 * Make sure we have some files around before we try to print...
4403 if (job
->num_files
== 0)
4405 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
4406 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
4407 "Aborting job because it has no files.");
4412 * Update the printer and job state to "processing"...
4415 if (!cupsdLoadJob(job
))
4418 if (!job
->printer_message
)
4419 job
->printer_message
= ippFindAttribute(job
->attrs
,
4420 "job-printer-state-message",
4422 if (job
->printer_message
)
4423 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
4425 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-printing");
4426 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
4427 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
4428 cupsdSetPrinterReasons(printer
, "-cups-remote-pending,"
4429 "cups-remote-pending-held,"
4430 "cups-remote-processing,"
4431 "cups-remote-stopped,"
4432 "cups-remote-canceled,"
4433 "cups-remote-aborted,"
4434 "cups-remote-completed");
4437 job
->current_file
= 0;
4439 job
->history_time
= 0;
4441 job
->printer
= printer
;
4445 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4447 job
->cancel_time
= 0;
4450 * Setup the last exit status and security profiles...
4454 job
->profile
= cupsdCreateProfile(job
->id
);
4457 * Create the status pipes and buffer...
4460 if (cupsdOpenPipe(job
->status_pipes
))
4462 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4463 "Unable to create job status pipes - %s.", strerror(errno
));
4465 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4466 "Job stopped because the scheduler could not create the "
4467 "job status pipes.");
4469 cupsdDestroyProfile(job
->profile
);
4470 job
->profile
= NULL
;
4474 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
4475 job
->status_level
= CUPSD_LOG_INFO
;
4478 * Create the backchannel pipes and make them non-blocking...
4481 if (cupsdOpenPipe(job
->back_pipes
))
4483 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4484 "Unable to create back-channel pipes - %s.", strerror(errno
));
4486 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4487 "Job stopped because the scheduler could not create the "
4488 "back-channel pipes.");
4490 cupsdClosePipe(job
->status_pipes
);
4491 cupsdStatBufDelete(job
->status_buffer
);
4492 job
->status_buffer
= NULL
;
4494 cupsdDestroyProfile(job
->profile
);
4495 job
->profile
= NULL
;
4499 fcntl(job
->back_pipes
[0], F_SETFL
,
4500 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4501 fcntl(job
->back_pipes
[1], F_SETFL
,
4502 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4505 * Create the side-channel pipes and make them non-blocking...
4508 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4510 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4511 "Unable to create side-channel pipes - %s.", strerror(errno
));
4513 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4514 "Job stopped because the scheduler could not create the "
4515 "side-channel pipes.");
4517 cupsdClosePipe(job
->back_pipes
);
4519 cupsdClosePipe(job
->status_pipes
);
4520 cupsdStatBufDelete(job
->status_buffer
);
4521 job
->status_buffer
= NULL
;
4523 cupsdDestroyProfile(job
->profile
);
4524 job
->profile
= NULL
;
4528 fcntl(job
->side_pipes
[0], F_SETFL
,
4529 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4530 fcntl(job
->side_pipes
[1], F_SETFL
,
4531 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4533 fcntl(job
->side_pipes
[0], F_SETFD
,
4534 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4535 fcntl(job
->side_pipes
[1], F_SETFD
,
4536 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4539 * Now start the first file in the job...
4542 cupsdContinueJob(job
);
4547 * 'stop_job()' - Stop a print job.
4551 stop_job(cupsd_job_t
*job
, /* I - Job */
4552 cupsd_jobaction_t action
) /* I - Action */
4554 int i
; /* Looping var */
4557 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4560 FilterLevel
-= job
->cost
;
4563 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
)
4564 job
->kill_time
= time(NULL
) + JobKillDelay
;
4565 else if (action
>= CUPSD_JOB_FORCE
)
4568 for (i
= 0; job
->filters
[i
]; i
++)
4569 if (job
->filters
[i
] > 0)
4571 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
4573 if (action
>= CUPSD_JOB_FORCE
)
4574 job
->filters
[i
] = -job
->filters
[i
];
4577 if (job
->backend
> 0)
4579 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
4581 if (action
>= CUPSD_JOB_FORCE
)
4582 job
->backend
= -job
->backend
;
4585 if (action
>= CUPSD_JOB_FORCE
)
4588 * Clear job status...
4597 * 'unload_job()' - Unload a job from memory.
4601 unload_job(cupsd_job_t
*job
) /* I - Job */
4606 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Unloading...", job
->id
);
4608 ippDelete(job
->attrs
);
4612 job
->reasons
= NULL
;
4614 job
->job_sheets
= NULL
;
4615 job
->printer_message
= NULL
;
4616 job
->printer_reasons
= NULL
;
4621 * 'update_job()' - Read a status update from a job's filters.
4625 update_job(cupsd_job_t
*job
) /* I - Job to check */
4627 int i
; /* Looping var */
4628 int copies
; /* Number of copies printed */
4629 char message
[CUPSD_SB_BUFFER_SIZE
],
4631 *ptr
; /* Pointer update... */
4632 int loglevel
, /* Log level for message */
4633 event
= 0; /* Events? */
4634 static const char * const levels
[] = /* Log levels */
4650 * Get the printer associated with this job; if the printer is stopped for
4651 * any reason then job->printer will be reset to NULL, so make sure we have
4652 * a valid pointer...
4655 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
4656 message
, sizeof(message
))) != NULL
)
4659 * Process page and printer state messages as needed...
4662 if (loglevel
== CUPSD_LOG_PAGE
)
4665 * Page message; send the message to the page_log file and update the
4666 * job sheet count...
4669 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
4673 if (!_cups_strncasecmp(message
, "total ", 6))
4676 * Got a total count of pages from a backend or filter...
4679 copies
= atoi(message
+ 6);
4680 copies
-= job
->sheets
->values
[0].integer
; /* Just track the delta */
4682 else if (!sscanf(message
, "%*d%d", &copies
))
4685 job
->sheets
->values
[0].integer
+= copies
;
4687 if (job
->printer
->page_limit
)
4688 cupsdUpdateQuota(job
->printer
, job
->username
, copies
, 0);
4691 cupsdLogPage(job
, message
);
4694 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4695 "Printed %d page(s).", job
->sheets
->values
[0].integer
);
4697 else if (loglevel
== CUPSD_LOG_STATE
)
4699 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
4701 if (!strcmp(message
, "paused"))
4703 cupsdStopPrinter(job
->printer
, 1);
4706 else if (cupsdSetPrinterReasons(job
->printer
, message
))
4708 event
|= CUPSD_EVENT_PRINTER_STATE
;
4710 if (MaxJobTime
> 0 && strstr(message
, "connecting-to-device") != NULL
)
4713 * Reset cancel time after connecting to the device...
4716 for (i
= 0; i
< job
->printer
->num_reasons
; i
++)
4717 if (!strcmp(job
->printer
->reasons
[i
], "connecting-to-device"))
4720 if (i
>= job
->printer
->num_reasons
)
4721 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4725 update_job_attrs(job
, 0);
4727 else if (loglevel
== CUPSD_LOG_ATTR
)
4730 * Set attribute(s)...
4733 int num_attrs
; /* Number of attributes */
4734 cups_option_t
*attrs
; /* Attributes */
4735 const char *attr
; /* Attribute */
4738 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
4740 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
4742 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
4745 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
4746 cupsdSetPrinterAttrs(job
->printer
);
4748 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4751 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
4754 int progress
= atoi(attr
);
4757 if (progress
>= 0 && progress
<= 100)
4759 job
->progress
= progress
;
4762 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4763 "Printing page %d, %d%%",
4764 job
->sheets
->values
[0].integer
, job
->progress
);
4768 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
4770 cupsdSetString(&job
->printer
->alert
, attr
);
4771 event
|= CUPSD_EVENT_PRINTER_STATE
;
4774 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
4777 cupsdSetString(&job
->printer
->alert_description
, attr
);
4778 event
|= CUPSD_EVENT_PRINTER_STATE
;
4781 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
4783 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
4784 job
->printer
->marker_time
= time(NULL
);
4785 event
|= CUPSD_EVENT_PRINTER_STATE
;
4786 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4789 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
4791 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
4792 job
->printer
->marker_time
= time(NULL
);
4793 event
|= CUPSD_EVENT_PRINTER_STATE
;
4794 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4797 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
4799 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
4800 job
->printer
->marker_time
= time(NULL
);
4801 event
|= CUPSD_EVENT_PRINTER_STATE
;
4802 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4805 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
4807 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
4808 job
->printer
->marker_time
= time(NULL
);
4809 event
|= CUPSD_EVENT_PRINTER_STATE
;
4810 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4813 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
4815 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
4816 job
->printer
->marker_time
= time(NULL
);
4817 event
|= CUPSD_EVENT_PRINTER_STATE
;
4818 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4821 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
4823 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
4824 job
->printer
->marker_time
= time(NULL
);
4825 event
|= CUPSD_EVENT_PRINTER_STATE
;
4826 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4829 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
4831 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
4832 job
->printer
->marker_time
= time(NULL
);
4833 event
|= CUPSD_EVENT_PRINTER_STATE
;
4834 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4837 cupsFreeOptions(num_attrs
, attrs
);
4839 else if (loglevel
== CUPSD_LOG_PPD
)
4842 * Set attribute(s)...
4845 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
4847 job
->num_keywords
= cupsParseOptions(message
, job
->num_keywords
,
4853 * Strip legacy message prefix...
4856 if (!strncmp(message
, "recoverable:", 12))
4859 while (isspace(*ptr
& 255))
4862 else if (!strncmp(message
, "recovered:", 10))
4865 while (isspace(*ptr
& 255))
4872 cupsdLogJob(job
, loglevel
, "%s", ptr
);
4874 if (loglevel
< CUPSD_LOG_DEBUG
&&
4875 strcmp(job
->printer
->state_message
, ptr
))
4877 strlcpy(job
->printer
->state_message
, ptr
,
4878 sizeof(job
->printer
->state_message
));
4880 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
4882 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
4885 * Some messages show in the job-printer-state-message attribute...
4888 if (loglevel
!= CUPSD_LOG_NOTICE
)
4889 job
->status_level
= loglevel
;
4891 update_job_attrs(job
, 1);
4893 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4894 "Set job-printer-state-message to \"%s\", "
4896 job
->printer_message
->values
[0].string
.text
,
4897 levels
[job
->status_level
]);
4902 if (!strchr(job
->status_buffer
->buffer
, '\n'))
4906 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
4907 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4908 "%s", job
->printer
->state_message
);
4909 if (event
& CUPSD_EVENT_PRINTER_STATE
)
4910 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
4911 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
4912 "Class \"%s\" state changed." :
4913 "Printer \"%s\" state changed.",
4914 job
->printer
->name
);
4917 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
4920 * See if all of the filters and the backend have returned their
4924 for (i
= 0; job
->filters
[i
] < 0; i
++);
4926 if (job
->filters
[i
])
4929 * EOF but we haven't collected the exit status of all filters...
4932 cupsdCheckProcess();
4936 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
4939 * EOF but we haven't collected the exit status of the backend...
4942 cupsdCheckProcess();
4947 * Handle the end of job stuff...
4950 finalize_job(job
, 1);
4953 * Check for new jobs...
4962 * 'update_job_attrs()' - Update the job-printer-* attributes.
4966 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
4967 int do_message
)/* I - 1 = copy job-printer-state message */
4969 int i
; /* Looping var */
4970 int num_reasons
; /* Actual number of reasons */
4971 const char * const *reasons
; /* Reasons */
4972 static const char *none
= "none"; /* "none" reason */
4976 * Get/create the job-printer-state-* attributes...
4979 if (!job
->printer_message
)
4981 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
4982 "job-printer-state-message",
4983 IPP_TAG_TEXT
)) == NULL
)
4984 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
4985 "job-printer-state-message",
4989 if (!job
->printer_reasons
)
4990 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
4991 "job-printer-state-reasons",
4995 * Copy or clear the printer-state-message value as needed...
4998 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
4999 job
->status_level
== CUPSD_LOG_INFO
)
5001 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
5004 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5006 else if (job
->printer
->state_message
[0] && do_message
)
5008 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
),
5009 job
->printer
->state_message
);
5012 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5016 * ... and the printer-state-reasons value...
5019 if (job
->printer
->num_reasons
== 0)
5026 num_reasons
= job
->printer
->num_reasons
;
5027 reasons
= (const char * const *)job
->printer
->reasons
;
5030 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
5033 * Replace/create a job-printer-state-reasons attribute...
5036 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
5038 job
->printer_reasons
= ippAddStrings(job
->attrs
,
5039 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
5040 "job-printer-state-reasons",
5041 num_reasons
, NULL
, NULL
);
5046 * Don't bother clearing the reason strings if they are the same...
5049 for (i
= 0; i
< num_reasons
; i
++)
5050 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
5053 if (i
>= num_reasons
)
5057 * Not the same, so free the current strings...
5060 for (i
= 0; i
< num_reasons
; i
++)
5061 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
5065 * Copy the reasons...
5068 for (i
= 0; i
< num_reasons
; i
++)
5069 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
5072 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5077 * End of "$Id: job.c 7902 2008-09-03 14:20:17Z mike $".