2 * "$Id: job.c 7902 2008-09-03 14:20:17Z mike $"
4 * Job management routines for the Common UNIX Printing System (CUPS).
6 * Copyright 2007-2009 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 job.
24 * cupsdDeleteJob() - Free all memory used by a job.
25 * cupsdFreeAllJobs() - Free all jobs from memory.
26 * cupsdFindJob() - Find the specified job.
27 * cupsdGetPrinterJobCount() - Get the number of pending, processing, or held
28 * jobs in a printer or class.
29 * cupsdGetUserJobCount() - Get the number of pending, processing, or held
31 * cupsdLoadAllJobs() - Load all jobs from disk.
32 * cupsdLoadJob() - Load a single job.
33 * cupsdMoveJob() - Move the specified job to a different
35 * cupsdReleaseJob() - Release the specified job.
36 * cupsdRestartJob() - Restart the specified job.
37 * cupsdSaveAllJobs() - Save a summary of all jobs to disk.
38 * cupsdSaveJob() - Save a job to disk.
39 * cupsdSetJobHoldUntil() - Set the hold time for a job.
40 * cupsdSetJobPriority() - Set the priority of a job, moving it up/down
41 * in the list as needed.
42 * cupsdSetJobState() - Set the state of the specified print job.
43 * cupsdStopAllJobs() - Stop all print jobs.
44 * cupsdUnloadCompletedJobs() - Flush completed job history from memory.
45 * compare_active_jobs() - Compare the job IDs and priorities of two
47 * compare_jobs() - Compare the job IDs of two jobs.
48 * finalize_job() - Cleanup after job filter processes and support
50 * get_options() - Get a string containing the job options.
51 * ipp_length() - Compute the size of the buffer needed to hold
52 * the textual IPP attributes.
53 * load_job_cache() - Load jobs from the job.cache file.
54 * load_next_job_id() - Load the NextJobId value from the job.cache
56 * load_request_root() - Load jobs from the RequestRoot directory.
57 * set_hold_until() - Set the hold time and update job-hold-until
59 * set_time() - Set one of the "time-at-xyz" attributes.
60 * start_job() - Start a print job.
61 * stop_job() - Stop a print job.
62 * unload_job() - Unload a job from memory.
63 * update_job() - Read a status update from a job's filters.
64 * update_job_attrs() - Update the job-printer-* attributes.
68 * Include necessary headers...
73 #include <cups/backend.h>
78 * Design Notes for Job Management
79 * -------------------------------
83 * pending Do nothing/check jobs
84 * pending-held Send SIGTERM to filters and backend
85 * processing Do nothing/start job
86 * stopped Send SIGKILL to filters and backend
87 * canceled Send SIGTERM to filters and backend
91 * Finalize clears the printer <-> job association, deletes the status
92 * buffer, closes all of the pipes, etc. and doesn't get run until all of
93 * the print processes are finished.
95 * UNLOADING OF JOBS (cupsdUnloadCompletedJobs)
97 * We unload the job attributes when they are not needed to reduce overall
98 * memory consumption. We don't unload jobs where job->state_value <
99 * IPP_JOB_STOPPED, job->printer != NULL, or job->access_time is recent.
101 * STARTING OF JOBS (start_job)
103 * When a job is started, a status buffer, several pipes, a security
104 * profile, and a backend process are created for the life of that job.
105 * These are shared for every file in a job. For remote print jobs, the
106 * IPP backend is provided with every file in the job and no filters are
109 * The job->printer member tracks which printer is printing a job, which
110 * can be different than the destination in job->dest for classes. The
111 * printer object also has a job pointer to track which job is being
114 * PRINTING OF JOB FILES (cupsdContinueJob)
116 * Each file in a job is filtered by 0 or more programs. After getting the
117 * list of filters needed and the total cost, the job is either passed or
118 * put back to the processing state until the current FilterLevel comes down
119 * enough to allow printing.
121 * If we can print, we build a string for the print options and run each of
122 * the filters, piping the output from one into the next.
124 * JOB STATUS UPDATES (update_job)
126 * The update_job function gets called whenever there are pending messages
127 * on the status pipe. These generally are updates to the marker-*,
128 * printer-state-message, or printer-state-reasons attributes. On EOF,
129 * finalize_job is called to clean up.
131 * FINALIZING JOBS (finalize_job)
133 * When all filters and the backend are done, we set the job state to
134 * completed (no errors), aborted (filter errors or abort-job policy),
135 * pending-held (auth required or retry-job policy), or pending
136 * (retry-current-job or stop-printer policies) as appropriate.
138 * Then we close the pipes and free the status buffers and profiles.
140 * JOB FILE COMPLETION (process_children in main.c)
142 * For multiple-file jobs, process_children (in main.c) sees that all
143 * filters have exited and calls in to print the next file if there are
144 * more files in the job, otherwise it waits for the backend to exit and
145 * update_job to do the cleanup.
153 static mime_filter_t gziptoany_filter
=
155 NULL
, /* Source type */
156 NULL
, /* Destination type */
158 "gziptoany" /* Filter program to run */
166 static int compare_active_jobs(void *first
, void *second
, void *data
);
167 static int compare_jobs(void *first
, void *second
, void *data
);
168 static void finalize_job(cupsd_job_t
*job
);
169 static char *get_options(cupsd_job_t
*job
, int banner_page
, char *copies
,
170 size_t copies_size
, char *title
,
172 static int ipp_length(ipp_t
*ipp
);
173 static void load_job_cache(const char *filename
);
174 static void load_next_job_id(const char *filename
);
175 static void load_request_root(void);
176 static void set_hold_until(cupsd_job_t
*job
, time_t holdtime
);
177 static void set_time(cupsd_job_t
*job
, const char *name
);
178 static void start_job(cupsd_job_t
*job
, cupsd_printer_t
*printer
);
179 static void stop_job(cupsd_job_t
*job
, cupsd_jobaction_t action
);
180 static void unload_job(cupsd_job_t
*job
);
181 static void update_job(cupsd_job_t
*job
);
182 static void update_job_attrs(cupsd_job_t
*job
, int do_message
);
186 * 'cupsdAddJob()' - Add a new job to the job queue.
189 cupsd_job_t
* /* O - New job record */
190 cupsdAddJob(int priority
, /* I - Job priority */
191 const char *dest
) /* I - Job destination */
193 cupsd_job_t
*job
; /* New job record */
196 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
199 job
->id
= NextJobId
++;
200 job
->priority
= priority
;
201 job
->back_pipes
[0] = -1;
202 job
->back_pipes
[1] = -1;
203 job
->print_pipes
[0] = -1;
204 job
->print_pipes
[1] = -1;
205 job
->side_pipes
[0] = -1;
206 job
->side_pipes
[1] = -1;
207 job
->status_pipes
[0] = -1;
208 job
->status_pipes
[1] = -1;
210 cupsdSetString(&job
->dest
, dest
);
213 * Add the new job to the "all jobs" and "active jobs" lists...
216 cupsArrayAdd(Jobs
, job
);
217 cupsArrayAdd(ActiveJobs
, job
);
224 * 'cupsdCancelJobs()' - Cancel all jobs for the given destination/user.
228 cupsdCancelJobs(const char *dest
, /* I - Destination to cancel */
229 const char *username
, /* I - Username or NULL */
230 int purge
) /* I - Purge jobs? */
232 cupsd_job_t
*job
; /* Current job */
235 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
237 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
239 if ((!job
->dest
|| !job
->username
) && !cupsdLoadJob(job
))
242 if ((!dest
|| !strcmp(job
->dest
, dest
)) &&
243 (!username
|| !strcmp(job
->username
, username
)))
246 * Cancel all jobs matching this destination/user...
250 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_PURGE
,
251 "Job purged by user.");
253 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
,
254 "Job canceled by user.");
263 * 'cupsdCheckJobs()' - Check the pending jobs and start any if the destination
270 cupsd_job_t
*job
; /* Current job in queue */
271 cupsd_printer_t
*printer
, /* Printer destination */
272 *pclass
; /* Printer class destination */
273 ipp_attribute_t
*attr
; /* Job attribute */
274 time_t curtime
; /* Current time */
277 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
278 "cupsdCheckJobs: %d active jobs, sleeping=%d, reload=%d",
279 cupsArrayCount(ActiveJobs
), Sleeping
, NeedReload
);
281 curtime
= time(NULL
);
283 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
);
285 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
288 * Kill jobs if they are unresponsive...
291 if (job
->kill_time
&& job
->kill_time
<= curtime
)
293 stop_job(job
, CUPSD_JOB_FORCE
);
298 * Start held jobs if they are ready...
301 if (job
->state_value
== IPP_JOB_HELD
&&
303 job
->hold_until
< curtime
)
305 if (job
->pending_timeout
)
308 * This job is pending; check that we don't have an active Send-Document
309 * operation in progress on any of the client connections, then timeout
310 * the job so we can start printing...
313 cupsd_client_t
*con
; /* Current client connection */
316 for (con
= (cupsd_client_t
*)cupsArrayFirst(Clients
);
318 con
= (cupsd_client_t
*)cupsArrayNext(Clients
))
320 con
->request
->request
.op
.operation_id
== IPP_SEND_DOCUMENT
)
326 if (cupsdTimeoutJob(job
))
330 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
331 "Job submission timed out.");
335 * Start pending jobs if the destination is available...
338 if (job
->state_value
== IPP_JOB_PENDING
&& !NeedReload
&& !Sleeping
&&
341 printer
= cupsdFindDest(job
->dest
);
345 (printer
->type
& (CUPS_PRINTER_IMPLICIT
| CUPS_PRINTER_CLASS
)))
348 * If the class is remote, just pass it to the remote server...
353 if (pclass
->state
== IPP_PRINTER_STOPPED
)
355 else if (pclass
->type
& CUPS_PRINTER_REMOTE
)
358 printer
= cupsdFindAvailablePrinter(printer
->name
);
361 if (!printer
&& !pclass
)
364 * Whoa, the printer and/or class for this destination went away;
368 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_PURGE
,
369 "Job aborted because the destination printer/class "
372 else if (printer
&& !printer
->holding_new_jobs
)
375 * See if the printer is available or remote and not printing a job;
376 * if so, start the job...
382 * Add/update a job-actual-printer-uri attribute for this job
383 * so that we know which printer actually printed the job...
386 if ((attr
= ippFindAttribute(job
->attrs
, "job-actual-printer-uri",
387 IPP_TAG_URI
)) != NULL
)
388 cupsdSetString(&attr
->values
[0].string
.text
, printer
->uri
);
390 ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_URI
,
391 "job-actual-printer-uri", NULL
, printer
->uri
);
394 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
397 if ((!(printer
->type
& CUPS_PRINTER_DISCOVERED
) && /* Printer is local */
398 printer
->state
== IPP_PRINTER_IDLE
) || /* and idle, OR */
399 ((printer
->type
& CUPS_PRINTER_DISCOVERED
) && /* Printer is remote */
400 !printer
->job
)) /* and not printing */
406 start_job(job
, printer
);
415 * 'cupsdCleanJobs()' - Clean out old jobs.
421 cupsd_job_t
*job
; /* Current job */
427 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
428 job
&& cupsArrayCount(Jobs
) >= MaxJobs
;
429 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
430 if (job
->state_value
>= IPP_JOB_CANCELED
&& !job
->printer
)
431 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
436 * 'cupsdContinueJob()' - Continue printing with the next file in a job.
440 cupsdContinueJob(cupsd_job_t
*job
) /* I - Job */
442 int i
; /* Looping var */
443 int slot
; /* Pipe slot */
444 cups_array_t
*filters
, /* Filters for job */
445 *prefilters
; /* Filters with prefilters */
446 mime_filter_t
*filter
, /* Current filter */
447 *prefilter
, /* Prefilter */
448 port_monitor
; /* Port monitor filter */
449 char scheme
[255]; /* Device URI scheme */
450 ipp_attribute_t
*attr
; /* Current attribute */
451 const char *ptr
, /* Pointer into value */
452 *abort_message
; /* Abort message */
453 struct stat backinfo
; /* Backend file information */
454 int backroot
; /* Run backend as root? */
455 int pid
; /* Process ID of new filter process */
456 int banner_page
; /* 1 if banner page, 0 otherwise */
457 int filterfds
[2][2];/* Pipes used between filters */
458 int envc
; /* Number of environment variables */
459 char **argv
, /* Filter command-line arguments */
460 filename
[1024], /* Job filename */
461 command
[1024], /* Full path to command */
462 jobid
[255], /* Job ID string */
464 /* Job title string */
465 copies
[255], /* # copies string */
466 *options
, /* Options string */
468 /* Environment variables */
469 charset
[255], /* CHARSET env variable */
470 class_name
[255],/* CLASS env variable */
471 classification
[1024],
472 /* CLASSIFICATION env variable */
474 /* CONTENT_TYPE env variable */
476 /* DEVICE_URI env variable */
477 final_content_type
[1024],
478 /* FINAL_CONTENT_TYPE env variable */
479 lang
[255], /* LANG env variable */
482 /* APPLE_LANGUAGE env variable */
483 #endif /* __APPLE__ */
484 ppd
[1024], /* PPD env variable */
486 /* PRINTER_INFO env variable */
487 printer_location
[255],
488 /* PRINTER_LOCATION env variable */
490 /* PRINTER env variable */
492 /* RIP_MAX_CACHE env variable */
495 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
496 "cupsdContinueJob(job=%p(%d)): current_file=%d, num_files=%d",
497 job
, job
->id
, job
->current_file
, job
->num_files
);
500 * Figure out what filters are required to convert from
501 * the source to the destination type...
504 FilterLevel
-= job
->cost
;
508 if (job
->printer
->raw
)
511 * Remote jobs and raw queues go directly to the printer without
515 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Sending job to queue tagged as raw...");
522 * Local jobs get filtered...
525 filters
= mimeFilter(MimeDatabase
, job
->filetypes
[job
->current_file
],
526 job
->printer
->filetype
, &(job
->cost
));
530 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
531 "Unable to convert file %d to printable format!",
534 job
->current_file
++;
536 if (job
->current_file
== job
->num_files
)
537 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
538 "Aborting job because it cannot be printed.");
544 * Remove NULL ("-") filters...
547 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
549 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
550 if (!strcmp(filter
->filter
, "-"))
551 cupsArrayRemove(filters
, filter
);
553 if (cupsArrayCount(filters
) == 0)
555 cupsArrayDelete(filters
);
560 * If this printer has any pre-filters, insert the required pre-filter
561 * in the filters array...
564 if (job
->printer
->prefiltertype
&& filters
)
566 prefilters
= cupsArrayNew(NULL
, NULL
);
568 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
570 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
572 if ((prefilter
= mimeFilterLookup(MimeDatabase
, filter
->src
,
573 job
->printer
->prefiltertype
)))
575 cupsArrayAdd(prefilters
, prefilter
);
576 job
->cost
+= prefilter
->cost
;
579 cupsArrayAdd(prefilters
, filter
);
582 cupsArrayDelete(filters
);
583 filters
= prefilters
;
588 * Set a minimum cost of 100 for all jobs so that FilterLimit
589 * works with raw queues and other low-cost paths.
596 * See if the filter cost is too high...
599 if ((FilterLevel
+ job
->cost
) > FilterLimit
&& FilterLevel
> 0 &&
603 * Don't print this job quite yet...
606 cupsArrayDelete(filters
);
608 cupsdLogJob(job
, CUPSD_LOG_INFO
,
609 "Holding because filter limit has been reached.");
610 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
,
611 "cupsdContinueJob: file=%d, cost=%d, level=%d, limit=%d",
612 job
->current_file
, job
->cost
, FilterLevel
,
617 FilterLevel
+= job
->cost
;
620 * Add decompression/raw filter as needed...
623 if ((!job
->printer
->raw
&& job
->compressions
[job
->current_file
]) ||
624 (!filters
&& !job
->printer
->remote
&&
625 (job
->num_files
> 1 || !strncmp(job
->printer
->device_uri
, "file:", 5))))
628 * Add gziptoany filter to the front of the list...
632 filters
= cupsArrayNew(NULL
, NULL
);
634 if (!cupsArrayInsert(filters
, &gziptoany_filter
))
636 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
637 "Unable to add decompression filter - %s", strerror(errno
));
639 cupsArrayDelete(filters
);
641 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
642 "Stopping job because the scheduler ran out of "
645 FilterLevel
-= job
->cost
;
651 * Add port monitor, if any...
654 if (job
->printer
->port_monitor
)
657 * Add port monitor to the end of the list...
661 filters
= cupsArrayNew(NULL
, NULL
);
663 port_monitor
.src
= NULL
;
664 port_monitor
.dst
= NULL
;
665 port_monitor
.cost
= 0;
667 snprintf(port_monitor
.filter
, sizeof(port_monitor
.filter
),
668 "%s/monitor/%s", ServerBin
, job
->printer
->port_monitor
);
670 if (!cupsArrayAdd(filters
, &port_monitor
))
672 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
673 "Unable to add port monitor - %s", strerror(errno
));
675 cupsArrayDelete(filters
);
677 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
678 "Stopping job because the scheduler ran out of "
681 FilterLevel
-= job
->cost
;
687 * Make sure we don't go over the "MAX_FILTERS" limit...
690 if (cupsArrayCount(filters
) > MAX_FILTERS
)
692 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
693 "Too many filters (%d > %d), unable to print!",
694 cupsArrayCount(filters
), MAX_FILTERS
);
696 cupsArrayDelete(filters
);
697 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
698 "Stopping job because it needs too many filters to "
701 FilterLevel
-= job
->cost
;
706 * Determine if we are printing a banner page or not...
709 if (job
->job_sheets
== NULL
)
711 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "No job-sheets attribute.");
712 if ((job
->job_sheets
=
713 ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_ZERO
)) != NULL
)
714 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
715 "... but someone added one without setting job_sheets!");
717 else if (job
->job_sheets
->num_values
== 1)
718 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s",
719 job
->job_sheets
->values
[0].string
.text
);
721 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s,%s",
722 job
->job_sheets
->values
[0].string
.text
,
723 job
->job_sheets
->values
[1].string
.text
);
725 if (job
->printer
->type
& (CUPS_PRINTER_REMOTE
| CUPS_PRINTER_IMPLICIT
))
727 else if (job
->job_sheets
== NULL
)
729 else if (strcasecmp(job
->job_sheets
->values
[0].string
.text
, "none") != 0 &&
730 job
->current_file
== 0)
732 else if (job
->job_sheets
->num_values
> 1 &&
733 strcasecmp(job
->job_sheets
->values
[1].string
.text
, "none") != 0 &&
734 job
->current_file
== (job
->num_files
- 1))
739 if ((options
= get_options(job
, banner_page
, copies
, sizeof(copies
), title
,
740 sizeof(title
))) == NULL
)
742 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
743 "Stopping job because the scheduler ran out of memory.");
744 cupsArrayDelete(filters
);
746 FilterLevel
-= job
->cost
;
751 * Build the command-line arguments for the filters. Each filter
752 * has 6 or 7 arguments:
760 * argv[6] = filename (optional; normally stdin)
762 * This allows legacy printer drivers that use the old System V
763 * printing interface to be used by CUPS.
765 * For remote jobs, we send all of the files in the argument list.
768 if (job
->printer
->remote
)
769 argv
= calloc(7 + job
->num_files
, sizeof(char *));
771 argv
= calloc(8, sizeof(char *));
775 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Unable to allocate argument array - %s",
777 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
778 "Stopping job because the scheduler ran out of memory.");
779 cupsArrayDelete(filters
);
781 FilterLevel
-= job
->cost
;
785 sprintf(jobid
, "%d", job
->id
);
787 argv
[0] = job
->printer
->name
;
789 argv
[2] = job
->username
;
794 if (job
->printer
->remote
&& job
->num_files
> 1)
796 for (i
= 0; i
< job
->num_files
; i
++)
798 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
800 argv
[6 + i
] = strdup(filename
);
805 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
806 job
->id
, job
->current_file
+ 1);
810 for (i
= 0; argv
[i
]; i
++)
811 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "argv[%d]=\"%s\"", i
, argv
[i
]);
814 * Create environment variable strings for the filters...
817 attr
= ippFindAttribute(job
->attrs
, "attributes-natural-language",
821 strcpy(apple_language
, "APPLE_LANGUAGE=");
822 _cupsAppleLanguage(attr
->values
[0].string
.text
,
823 apple_language
+ 15, sizeof(apple_language
) - 15);
824 #endif /* __APPLE__ */
826 switch (strlen(attr
->values
[0].string
.text
))
830 * This is an unknown or badly formatted language code; use
831 * the POSIX locale...
834 strcpy(lang
, "LANG=C");
839 * Just the language code (ll)...
842 snprintf(lang
, sizeof(lang
), "LANG=%s.UTF-8",
843 attr
->values
[0].string
.text
);
848 * Language and country code (ll-cc)...
851 snprintf(lang
, sizeof(lang
), "LANG=%c%c_%c%c.UTF-8",
852 attr
->values
[0].string
.text
[0],
853 attr
->values
[0].string
.text
[1],
854 toupper(attr
->values
[0].string
.text
[3] & 255),
855 toupper(attr
->values
[0].string
.text
[4] & 255));
859 if ((attr
= ippFindAttribute(job
->attrs
, "document-format",
860 IPP_TAG_MIMETYPE
)) != NULL
&&
861 (ptr
= strstr(attr
->values
[0].string
.text
, "charset=")) != NULL
)
862 snprintf(charset
, sizeof(charset
), "CHARSET=%s", ptr
+ 8);
864 strlcpy(charset
, "CHARSET=utf-8", sizeof(charset
));
866 snprintf(content_type
, sizeof(content_type
), "CONTENT_TYPE=%s/%s",
867 job
->filetypes
[job
->current_file
]->super
,
868 job
->filetypes
[job
->current_file
]->type
);
869 snprintf(device_uri
, sizeof(device_uri
), "DEVICE_URI=%s",
870 job
->printer
->device_uri
);
871 snprintf(ppd
, sizeof(ppd
), "PPD=%s/ppd/%s.ppd", ServerRoot
,
873 snprintf(printer_info
, sizeof(printer_name
), "PRINTER_INFO=%s",
874 job
->printer
->info
? job
->printer
->info
: "");
875 snprintf(printer_location
, sizeof(printer_name
), "PRINTER_LOCATION=%s",
876 job
->printer
->location
? job
->printer
->location
: "");
877 snprintf(printer_name
, sizeof(printer_name
), "PRINTER=%s", job
->printer
->name
);
878 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
880 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
882 envp
[envc
++] = charset
;
883 envp
[envc
++] = lang
;
885 envp
[envc
++] = apple_language
;
886 #endif /* __APPLE__ */
888 envp
[envc
++] = rip_max_cache
;
889 envp
[envc
++] = content_type
;
890 envp
[envc
++] = device_uri
;
891 envp
[envc
++] = printer_info
;
892 envp
[envc
++] = printer_location
;
893 envp
[envc
++] = printer_name
;
894 envp
[envc
++] = banner_page
? "CUPS_FILETYPE=job-sheet" :
895 "CUPS_FILETYPE=document";
897 if (!job
->printer
->remote
&& !job
->printer
->raw
)
899 filter
= (mime_filter_t
*)cupsArrayLast(filters
);
901 if (job
->printer
->port_monitor
)
902 filter
= (mime_filter_t
*)cupsArrayPrev(filters
);
904 if (filter
&& filter
->dst
)
906 snprintf(final_content_type
, sizeof(final_content_type
),
907 "FINAL_CONTENT_TYPE=%s/%s",
908 filter
->dst
->super
, filter
->dst
->type
);
909 envp
[envc
++] = final_content_type
;
913 if (Classification
&& !banner_page
)
915 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
916 IPP_TAG_NAME
)) == NULL
)
917 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
919 else if (attr
->num_values
> 1 &&
920 strcmp(attr
->values
[1].string
.text
, "none") != 0)
921 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
922 attr
->values
[1].string
.text
);
924 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
925 attr
->values
[0].string
.text
);
927 envp
[envc
++] = classification
;
930 if (job
->dtype
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_IMPLICIT
))
932 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
933 envp
[envc
++] = class_name
;
936 if (job
->auth_username
)
937 envp
[envc
++] = job
->auth_username
;
938 if (job
->auth_domain
)
939 envp
[envc
++] = job
->auth_domain
;
940 if (job
->auth_password
)
941 envp
[envc
++] = job
->auth_password
;
945 envp
[envc
++] = job
->ccname
;
946 #endif /* HAVE_GSSAPI */
950 for (i
= 0; i
< envc
; i
++)
951 if (!strncmp(envp
[i
], "AUTH_", 5))
952 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"AUTH_%c****\"", i
,
954 else if (strncmp(envp
[i
], "DEVICE_URI=", 11))
955 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"%s\"", i
, envp
[i
]);
957 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"DEVICE_URI=%s\"", i
,
958 job
->printer
->sanitized_device_uri
);
960 if (job
->printer
->remote
)
961 job
->current_file
= job
->num_files
;
963 job
->current_file
++;
966 * Now create processes for all of the filters...
969 filterfds
[0][0] = -1;
970 filterfds
[0][1] = -1;
971 filterfds
[1][0] = -1;
972 filterfds
[1][1] = -1;
974 memset(job
->filters
, 0, sizeof(job
->filters
));
976 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
978 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
980 if (filter
->filter
[0] != '/')
981 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
984 strlcpy(command
, filter
->filter
, sizeof(command
));
986 if (i
< (cupsArrayCount(filters
) - 1))
988 if (cupsdOpenPipe(filterfds
[slot
]))
990 abort_message
= "Stopping job because the scheduler could not create "
998 if (job
->current_file
== 1)
1000 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1002 if (cupsdOpenPipe(job
->print_pipes
))
1004 abort_message
= "Stopping job because the scheduler could not "
1005 "create the backend pipes.";
1012 job
->print_pipes
[0] = -1;
1013 if (!strcmp(job
->printer
->device_uri
, "file:/dev/null") ||
1014 !strcmp(job
->printer
->device_uri
, "file:///dev/null"))
1015 job
->print_pipes
[1] = -1;
1018 if (!strncmp(job
->printer
->device_uri
, "file:/dev/", 10))
1019 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1021 else if (!strncmp(job
->printer
->device_uri
, "file:///dev/", 12))
1022 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1024 else if (!strncmp(job
->printer
->device_uri
, "file:///", 8))
1025 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1026 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1028 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1029 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1031 if (job
->print_pipes
[1] < 0)
1033 abort_message
= "Stopping job because the scheduler could not "
1034 "open the output file.";
1039 fcntl(job
->print_pipes
[1], F_SETFD
,
1040 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
1045 filterfds
[slot
][0] = job
->print_pipes
[0];
1046 filterfds
[slot
][1] = job
->print_pipes
[1];
1049 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1050 filterfds
[slot
][1], job
->status_pipes
[1],
1051 job
->back_pipes
[0], job
->side_pipes
[0], 0,
1052 job
->profile
, job
, job
->filters
+ i
);
1054 cupsdClosePipe(filterfds
[!slot
]);
1058 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
1059 filter
->filter
, strerror(errno
));
1061 abort_message
= "Stopped job because the scheduler could not execute a "
1067 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started filter %s (PID %d)", command
,
1074 cupsArrayDelete(filters
);
1078 * Finally, pipe the final output into a backend process if needed...
1081 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1083 if (job
->current_file
== 1 || job
->printer
->remote
)
1085 sscanf(job
->printer
->device_uri
, "%254[^:]", scheme
);
1086 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, scheme
);
1089 * See if the backend needs to run as root...
1094 else if (stat(command
, &backinfo
))
1097 backroot
= !(backinfo
.st_mode
& (S_IRWXG
| S_IRWXO
));
1099 argv
[0] = job
->printer
->sanitized_device_uri
;
1101 filterfds
[slot
][0] = -1;
1102 filterfds
[slot
][1] = -1;
1104 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1105 filterfds
[slot
][1], job
->status_pipes
[1],
1106 job
->back_pipes
[1], job
->side_pipes
[1],
1107 backroot
, job
->profile
, job
, &(job
->backend
));
1111 abort_message
= "Stopping job because the sheduler could not execute "
1118 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started backend %s (PID %d)",
1123 if (job
->current_file
== job
->num_files
)
1125 cupsdClosePipe(job
->print_pipes
);
1126 cupsdClosePipe(job
->back_pipes
);
1127 cupsdClosePipe(job
->side_pipes
);
1129 close(job
->status_pipes
[1]);
1130 job
->status_pipes
[1] = -1;
1135 filterfds
[slot
][0] = -1;
1136 filterfds
[slot
][1] = -1;
1138 if (job
->current_file
== job
->num_files
)
1140 cupsdClosePipe(job
->print_pipes
);
1142 close(job
->status_pipes
[1]);
1143 job
->status_pipes
[1] = -1;
1147 cupsdClosePipe(filterfds
[slot
]);
1149 if (job
->printer
->remote
&& job
->num_files
> 1)
1151 for (i
= 0; i
< job
->num_files
; i
++)
1157 cupsdAddSelect(job
->status_buffer
->fd
, (cupsd_selfunc_t
)update_job
, NULL
,
1160 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
1164 * If we get here than we are able to run the printer driver filters, so clear
1165 * the missing and insecure warnings...
1168 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
1169 "cups-insecure-filter-warning");
1175 * If we get here, we need to abort the current job and close out all
1176 * files and pipes...
1181 for (slot
= 0; slot
< 2; slot
++)
1182 cupsdClosePipe(filterfds
[slot
]);
1184 cupsdClosePipe(job
->status_pipes
);
1185 cupsdStatBufDelete(job
->status_buffer
);
1186 job
->status_buffer
= NULL
;
1188 cupsArrayDelete(filters
);
1190 if (job
->printer
->remote
&& job
->num_files
> 1)
1192 for (i
= 0; i
< job
->num_files
; i
++)
1198 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
, "%s",
1204 * 'cupsdDeleteJob()' - Free all memory used by a job.
1208 cupsdDeleteJob(cupsd_job_t
*job
, /* I - Job */
1209 cupsd_jobaction_t action
)/* I - Action */
1214 if (action
== CUPSD_JOB_PURGE
)
1217 * Remove the job info file...
1220 char filename
[1024]; /* Job filename */
1222 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
1227 cupsdClearString(&job
->username
);
1228 cupsdClearString(&job
->dest
);
1229 cupsdClearString(&job
->auth_username
);
1230 cupsdClearString(&job
->auth_domain
);
1231 cupsdClearString(&job
->auth_password
);
1235 * Destroy the credential cache and clear the KRB5CCNAME env var string.
1240 krb5_cc_destroy(KerberosContext
, job
->ccache
);
1244 cupsdClearString(&job
->ccname
);
1245 #endif /* HAVE_GSSAPI */
1247 if (job
->num_files
> 0)
1249 free(job
->compressions
);
1250 free(job
->filetypes
);
1257 cupsArrayRemove(Jobs
, job
);
1258 cupsArrayRemove(ActiveJobs
, job
);
1259 cupsArrayRemove(PrintingJobs
, job
);
1266 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1270 cupsdFreeAllJobs(void)
1272 cupsd_job_t
*job
; /* Current job */
1280 cupsdStopAllJobs(CUPSD_JOB_FORCE
, 0);
1283 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1285 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1286 cupsdDeleteJob(job
, CUPSD_JOB_DEFAULT
);
1288 cupsdReleaseSignals();
1293 * 'cupsdFindJob()' - Find the specified job.
1296 cupsd_job_t
* /* O - Job data */
1297 cupsdFindJob(int id
) /* I - Job ID */
1299 cupsd_job_t key
; /* Search key */
1304 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
1309 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1310 * or held jobs in a printer or class.
1313 int /* O - Job count */
1314 cupsdGetPrinterJobCount(
1315 const char *dest
) /* I - Printer or class name */
1317 int count
; /* Job count */
1318 cupsd_job_t
*job
; /* Current job */
1321 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1323 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1324 if (job
->dest
&& !strcasecmp(job
->dest
, dest
))
1332 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1333 * or held jobs for a user.
1336 int /* O - Job count */
1337 cupsdGetUserJobCount(
1338 const char *username
) /* I - Username */
1340 int count
; /* Job count */
1341 cupsd_job_t
*job
; /* Current job */
1344 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1346 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1347 if (!strcasecmp(job
->username
, username
))
1355 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1359 cupsdLoadAllJobs(void)
1361 char filename
[1024]; /* Full filename of job.cache file */
1362 struct stat fileinfo
, /* Information on job.cache file */
1363 dirinfo
; /* Information on RequestRoot dir */
1368 * Create the job arrays as needed...
1372 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1375 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1378 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1381 * See whether the job.cache file is older than the RequestRoot directory...
1384 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1386 if (stat(filename
, &fileinfo
))
1388 fileinfo
.st_mtime
= 0;
1390 if (errno
!= ENOENT
)
1391 cupsdLogMessage(CUPSD_LOG_ERROR
,
1392 "Unable to get file information for \"%s\" - %s",
1393 filename
, strerror(errno
));
1396 if (stat(RequestRoot
, &dirinfo
))
1398 dirinfo
.st_mtime
= 0;
1400 if (errno
!= ENOENT
)
1401 cupsdLogMessage(CUPSD_LOG_ERROR
,
1402 "Unable to get directory information for \"%s\" - %s",
1403 RequestRoot
, strerror(errno
));
1407 * Load the most recent source for job data...
1410 if (dirinfo
.st_mtime
> fileinfo
.st_mtime
)
1412 load_request_root();
1414 load_next_job_id(filename
);
1417 load_job_cache(filename
);
1420 * Clean out old jobs as needed...
1423 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1429 * 'cupsdLoadJob()' - Load a single job.
1432 int /* O - 1 on success, 0 on failure */
1433 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1435 char jobfile
[1024]; /* Job filename */
1436 cups_file_t
*fp
; /* Job file */
1437 int fileid
; /* Current file ID */
1438 ipp_attribute_t
*attr
; /* Job attribute */
1439 const char *dest
; /* Destination name */
1440 cupsd_printer_t
*destptr
; /* Pointer to destination */
1441 mime_type_t
**filetypes
; /* New filetypes array */
1442 int *compressions
; /* New compressions array */
1447 if (job
->state_value
> IPP_JOB_STOPPED
)
1448 job
->access_time
= time(NULL
);
1453 if ((job
->attrs
= ippNew()) == NULL
)
1455 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes!");
1460 * Load job attributes...
1463 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading attributes...", job
->id
);
1465 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1466 if ((fp
= cupsFileOpen(jobfile
, "r")) == NULL
)
1468 cupsdLogMessage(CUPSD_LOG_ERROR
,
1469 "[Job %d] Unable to open job control file \"%s\" - %s!",
1470 job
->id
, jobfile
, strerror(errno
));
1474 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1476 cupsdLogMessage(CUPSD_LOG_ERROR
,
1477 "[Job %d] Unable to read job control file \"%s\"!", job
->id
,
1486 * Copy attribute data to the job object...
1489 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1491 cupsdLogMessage(CUPSD_LOG_ERROR
,
1492 "[Job %d] Missing or bad time-at-creation attribute in "
1493 "control file!", job
->id
);
1497 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1498 IPP_TAG_ENUM
)) == NULL
)
1500 cupsdLogMessage(CUPSD_LOG_ERROR
,
1501 "[Job %d] Missing or bad job-state attribute in control "
1506 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1510 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1511 IPP_TAG_URI
)) == NULL
)
1513 cupsdLogMessage(CUPSD_LOG_ERROR
,
1514 "[Job %d] No job-printer-uri attribute in control file!",
1519 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1522 cupsdLogMessage(CUPSD_LOG_ERROR
,
1523 "[Job %d] Unable to queue job for destination \"%s\"!",
1524 job
->id
, attr
->values
[0].string
.text
);
1528 cupsdSetString(&job
->dest
, dest
);
1530 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1532 cupsdLogMessage(CUPSD_LOG_ERROR
,
1533 "[Job %d] Unable to queue job for destination \"%s\"!",
1534 job
->id
, job
->dest
);
1538 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed",
1540 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1544 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1545 IPP_TAG_INTEGER
)) == NULL
)
1547 cupsdLogMessage(CUPSD_LOG_ERROR
,
1548 "[Job %d] Missing or bad job-priority attribute in "
1549 "control file!", job
->id
);
1553 job
->priority
= attr
->values
[0].integer
;
1558 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1559 IPP_TAG_NAME
)) == NULL
)
1561 cupsdLogMessage(CUPSD_LOG_ERROR
,
1562 "[Job %d] Missing or bad job-originating-user-name "
1563 "attribute in control file!", job
->id
);
1567 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1571 * Set the job hold-until time and state...
1574 if (job
->state_value
== IPP_JOB_HELD
)
1576 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1577 IPP_TAG_KEYWORD
)) == NULL
)
1578 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1581 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1584 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1585 job
->state_value
= IPP_JOB_PENDING
;
1588 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1590 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1591 job
->state_value
= IPP_JOB_PENDING
;
1594 if (!job
->num_files
)
1597 * Find all the d##### files...
1600 for (fileid
= 1; fileid
< 10000; fileid
++)
1602 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1605 if (access(jobfile
, 0))
1608 cupsdLogMessage(CUPSD_LOG_DEBUG
,
1609 "[Job %d] Auto-typing document file \"%s\"...", job
->id
,
1612 if (fileid
> job
->num_files
)
1614 if (job
->num_files
== 0)
1616 compressions
= (int *)calloc(fileid
, sizeof(int));
1617 filetypes
= (mime_type_t
**)calloc(fileid
, sizeof(mime_type_t
*));
1621 compressions
= (int *)realloc(job
->compressions
,
1622 sizeof(int) * fileid
);
1623 filetypes
= (mime_type_t
**)realloc(job
->filetypes
,
1624 sizeof(mime_type_t
*) *
1628 if (!compressions
|| !filetypes
)
1630 cupsdLogMessage(CUPSD_LOG_ERROR
,
1631 "[Job %d] Ran out of memory for job file types!",
1636 job
->compressions
= compressions
;
1637 job
->filetypes
= filetypes
;
1638 job
->num_files
= fileid
;
1641 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1642 job
->compressions
+ fileid
- 1);
1644 if (!job
->filetypes
[fileid
- 1])
1645 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1651 * Load authentication information as needed...
1654 if (job
->state_value
< IPP_JOB_STOPPED
)
1656 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1658 cupsdClearString(&job
->auth_username
);
1659 cupsdClearString(&job
->auth_domain
);
1660 cupsdClearString(&job
->auth_password
);
1662 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
1664 int i
, /* Looping var */
1665 bytes
; /* Size of auth data */
1666 char line
[255], /* Line from file */
1667 data
[255]; /* Decoded data */
1671 i
< destptr
->num_auth_info_required
&&
1672 cupsFileGets(fp
, line
, sizeof(line
));
1675 bytes
= sizeof(data
);
1676 httpDecode64_2(data
, &bytes
, line
);
1678 if (!strcmp(destptr
->auth_info_required
[i
], "username"))
1679 cupsdSetStringf(&job
->auth_username
, "AUTH_USERNAME=%s", data
);
1680 else if (!strcmp(destptr
->auth_info_required
[i
], "domain"))
1681 cupsdSetStringf(&job
->auth_domain
, "AUTH_DOMAIN=%s", data
);
1682 else if (!strcmp(destptr
->auth_info_required
[i
], "password"))
1683 cupsdSetStringf(&job
->auth_password
, "AUTH_PASSWORD=%s", data
);
1690 job
->access_time
= time(NULL
);
1694 * If we get here then something bad happened...
1699 ippDelete(job
->attrs
);
1708 * 'cupsdMoveJob()' - Move the specified job to a different destination.
1712 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
1713 cupsd_printer_t
*p
) /* I - Destination printer or class */
1715 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
1716 const char *olddest
; /* Old destination */
1717 cupsd_printer_t
*oldp
; /* Old pointer */
1721 * Don't move completed jobs...
1724 if (job
->state_value
> IPP_JOB_STOPPED
)
1728 * Get the old destination...
1731 olddest
= job
->dest
;
1734 oldp
= job
->printer
;
1736 oldp
= cupsdFindDest(olddest
);
1739 * Change the destination information...
1742 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
1743 "Stopping job prior to move.");
1745 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
1746 "Job #%d moved from %s to %s.", job
->id
, olddest
,
1749 cupsdSetString(&job
->dest
, p
->name
);
1750 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
|
1751 CUPS_PRINTER_IMPLICIT
);
1753 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1754 IPP_TAG_URI
)) != NULL
)
1755 cupsdSetString(&(attr
->values
[0].string
.text
), p
->uri
);
1757 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
1758 "Job #%d moved from %s to %s.", job
->id
, olddest
,
1762 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
1767 * 'cupsdReleaseJob()' - Release the specified job.
1771 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
1773 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
1776 if (job
->state_value
== IPP_JOB_HELD
)
1779 * Add trailing banner as needed...
1782 if (job
->pending_timeout
)
1783 cupsdTimeoutJob(job
);
1785 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
1786 "Job released by user.");
1792 * 'cupsdRestartJob()' - Restart the specified job.
1796 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
1798 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
1801 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
1802 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
1803 "Job restarted by user.");
1808 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
1812 cupsdSaveAllJobs(void)
1814 int i
; /* Looping var */
1815 cups_file_t
*fp
; /* Job cache file */
1816 char temp
[1024]; /* Temporary string */
1817 cupsd_job_t
*job
; /* Current job */
1818 time_t curtime
; /* Current time */
1819 struct tm
*curdate
; /* Current date */
1822 snprintf(temp
, sizeof(temp
), "%s/job.cache", CacheDir
);
1823 if ((fp
= cupsFileOpen(temp
, "w")) == NULL
)
1825 cupsdLogMessage(CUPSD_LOG_ERROR
,
1826 "Unable to create job cache file \"%s\" - %s",
1827 temp
, strerror(errno
));
1831 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job cache file \"%s\"...", temp
);
1834 * Restrict access to the file...
1837 fchown(cupsFileNumber(fp
), getuid(), Group
);
1838 fchmod(cupsFileNumber(fp
), ConfigFilePerm
);
1841 * Write a small header to the file...
1844 curtime
= time(NULL
);
1845 curdate
= localtime(&curtime
);
1846 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
1848 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
1849 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
1850 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
1853 * Write each job known to the system...
1856 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1858 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1860 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
1861 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
1862 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
1863 cupsFilePrintf(fp
, "HoldUntil %d\n", (int)job
->hold_until
);
1864 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
1865 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
1866 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
1867 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
1868 for (i
= 0; i
< job
->num_files
; i
++)
1869 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
1870 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
1871 cupsFilePuts(fp
, "</Job>\n");
1879 * 'cupsdSaveJob()' - Save a job to disk.
1883 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
1885 char filename
[1024]; /* Job control filename */
1886 cups_file_t
*fp
; /* Job file */
1889 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
1890 job
, job
->id
, job
->attrs
);
1892 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
1894 if ((fp
= cupsFileOpen(filename
, "w")) == NULL
)
1896 cupsdLogMessage(CUPSD_LOG_ERROR
,
1897 "[Job %d] Unable to create job control file \"%s\" - %s.",
1898 job
->id
, filename
, strerror(errno
));
1902 fchmod(cupsFileNumber(fp
), 0600);
1903 fchown(cupsFileNumber(fp
), RunUser
, Group
);
1905 job
->attrs
->state
= IPP_IDLE
;
1907 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
1908 job
->attrs
) != IPP_DATA
)
1909 cupsdLogMessage(CUPSD_LOG_ERROR
,
1910 "[Job %d] Unable to write job control file!", job
->id
);
1919 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
1923 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
1924 const char *when
, /* I - When to resume */
1925 int update
)/* I - Update job-hold-until attr? */
1927 time_t curtime
; /* Current time */
1928 struct tm
*curdate
; /* Current date */
1929 int hour
; /* Hold hour */
1930 int minute
; /* Hold minute */
1931 int second
= 0; /* Hold second */
1934 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
1935 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
1936 job
, job
->id
, when
, update
);
1941 * Update the job-hold-until attribute...
1944 ipp_attribute_t
*attr
; /* job-hold-until attribute */
1946 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1947 IPP_TAG_KEYWORD
)) == NULL
)
1948 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1951 cupsdSetString(&(attr
->values
[0].string
.text
), when
);
1953 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
1954 "job-hold-until", NULL
, when
);
1958 if (isdigit(when
[0] & 255))
1959 attr
->value_tag
= IPP_TAG_NAME
;
1961 attr
->value_tag
= IPP_TAG_KEYWORD
;
1964 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
1969 * Update the hold time...
1972 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
1975 * Hold indefinitely...
1978 job
->hold_until
= 0;
1980 else if (!strcmp(when
, "day-time"))
1983 * Hold to 6am the next morning unless local time is < 6pm.
1986 curtime
= time(NULL
);
1987 curdate
= localtime(&curtime
);
1989 if (curdate
->tm_hour
< 18)
1990 job
->hold_until
= curtime
;
1992 job
->hold_until
= curtime
+
1993 ((29 - curdate
->tm_hour
) * 60 + 59 -
1994 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
1996 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
1999 * Hold to 6pm unless local time is > 6pm or < 6am.
2002 curtime
= time(NULL
);
2003 curdate
= localtime(&curtime
);
2005 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2006 job
->hold_until
= curtime
;
2008 job
->hold_until
= curtime
+
2009 ((17 - curdate
->tm_hour
) * 60 + 59 -
2010 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2012 else if (!strcmp(when
, "second-shift"))
2015 * Hold to 4pm unless local time is > 4pm.
2018 curtime
= time(NULL
);
2019 curdate
= localtime(&curtime
);
2021 if (curdate
->tm_hour
>= 16)
2022 job
->hold_until
= curtime
;
2024 job
->hold_until
= curtime
+
2025 ((15 - curdate
->tm_hour
) * 60 + 59 -
2026 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2028 else if (!strcmp(when
, "third-shift"))
2031 * Hold to 12am unless local time is < 8am.
2034 curtime
= time(NULL
);
2035 curdate
= localtime(&curtime
);
2037 if (curdate
->tm_hour
< 8)
2038 job
->hold_until
= curtime
;
2040 job
->hold_until
= curtime
+
2041 ((23 - curdate
->tm_hour
) * 60 + 59 -
2042 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2044 else if (!strcmp(when
, "weekend"))
2047 * Hold to weekend unless we are in the weekend.
2050 curtime
= time(NULL
);
2051 curdate
= localtime(&curtime
);
2053 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2054 job
->hold_until
= curtime
;
2056 job
->hold_until
= curtime
+
2057 (((5 - curdate
->tm_wday
) * 24 +
2058 (17 - curdate
->tm_hour
)) * 60 + 59 -
2059 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2061 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2064 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2067 curtime
= time(NULL
);
2068 curdate
= gmtime(&curtime
);
2070 job
->hold_until
= curtime
+
2071 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2072 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2075 * Hold until next day as needed...
2078 if (job
->hold_until
< curtime
)
2079 job
->hold_until
+= 24 * 60 * 60;
2082 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2083 (int)job
->hold_until
);
2088 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2089 * the list as needed.
2093 cupsdSetJobPriority(
2094 cupsd_job_t
*job
, /* I - Job ID */
2095 int priority
) /* I - New priority (0 to 100) */
2097 ipp_attribute_t
*attr
; /* Job attribute */
2101 * Don't change completed jobs...
2104 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2108 * Set the new priority and re-add the job into the active list...
2111 cupsArrayRemove(ActiveJobs
, job
);
2113 job
->priority
= priority
;
2115 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2116 IPP_TAG_INTEGER
)) != NULL
)
2117 attr
->values
[0].integer
= priority
;
2119 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2122 cupsArrayAdd(ActiveJobs
, job
);
2125 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2130 * 'cupsdSetJobState()' - Set the state of the specified print job.
2135 cupsd_job_t
*job
, /* I - Job to cancel */
2136 ipp_jstate_t newstate
, /* I - New job state */
2137 cupsd_jobaction_t action
, /* I - Action to take */
2138 const char *message
, /* I - Message to log */
2139 ...) /* I - Additional arguments as needed */
2141 int i
; /* Looping var */
2142 ipp_jstate_t oldstate
; /* Old state */
2143 char filename
[1024]; /* Job filename */
2144 ipp_attribute_t
*attr
; /* Job attribute */
2147 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2148 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2149 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2150 newstate
, action
, message
? message
: "(null)");
2154 * Make sure we have the job attributes...
2157 if (!cupsdLoadJob(job
))
2161 * Don't do anything if the state is unchanged...
2164 if (newstate
== (oldstate
= job
->state_value
))
2168 * Stop any processes that are working on the current job...
2171 if (oldstate
== IPP_JOB_PROCESSING
)
2172 stop_job(job
, action
!= CUPSD_JOB_DEFAULT
);
2175 * Set the new job state...
2178 job
->state
->values
[0].integer
= newstate
;
2179 job
->state_value
= newstate
;
2183 case IPP_JOB_PENDING
:
2185 * Update job-hold-until as needed...
2188 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2189 IPP_TAG_KEYWORD
)) == NULL
)
2190 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2194 attr
->value_tag
= IPP_TAG_KEYWORD
;
2195 cupsdSetString(&(attr
->values
[0].string
.text
), "no-hold");
2201 case IPP_JOB_ABORTED
:
2202 case IPP_JOB_CANCELED
:
2203 case IPP_JOB_COMPLETED
:
2204 set_time(job
, "time-at-completed");
2209 * Log message as needed...
2214 char buffer
[2048]; /* Message buffer */
2215 va_list ap
; /* Pointer to additional arguments */
2217 va_start(ap
, message
);
2218 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2221 if (newstate
> IPP_JOB_STOPPED
)
2222 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2224 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2226 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2227 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2229 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2233 * Handle post-state-change actions...
2238 case IPP_JOB_PROCESSING
:
2240 * Add the job to the "printing" list...
2243 if (!cupsArrayFind(PrintingJobs
, job
))
2244 cupsArrayAdd(PrintingJobs
, job
);
2247 * Set the processing time...
2250 set_time(job
, "time-at-processing");
2252 case IPP_JOB_PENDING
:
2254 case IPP_JOB_STOPPED
:
2256 * Make sure the job is in the active list...
2259 if (!cupsArrayFind(ActiveJobs
, job
))
2260 cupsArrayAdd(ActiveJobs
, job
);
2263 * Save the job state to disk...
2267 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2270 case IPP_JOB_ABORTED
:
2271 case IPP_JOB_CANCELED
:
2272 case IPP_JOB_COMPLETED
:
2274 * Expire job subscriptions since the job is now "completed"...
2277 cupsdExpireSubscriptions(NULL
, job
);
2280 * Remove the job from the active list...
2283 cupsArrayRemove(ActiveJobs
, job
);
2287 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2288 * sleep to happen immediately...
2291 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2293 #endif /* __APPLE__ */
2296 * Remove any authentication data...
2299 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2300 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2301 cupsdLogMessage(CUPSD_LOG_ERROR
,
2302 "Unable to remove authentication cache: %s",
2305 cupsdClearString(&job
->auth_username
);
2306 cupsdClearString(&job
->auth_domain
);
2307 cupsdClearString(&job
->auth_password
);
2311 * Destroy the credential cache and clear the KRB5CCNAME env var string.
2316 krb5_cc_destroy(KerberosContext
, job
->ccache
);
2320 cupsdClearString(&job
->ccname
);
2321 #endif /* HAVE_GSSAPI */
2324 * Remove the print file for good if we aren't preserving jobs or
2328 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2330 for (i
= 1; i
<= job
->num_files
; i
++)
2332 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
2337 if (job
->num_files
> 0)
2339 free(job
->filetypes
);
2340 free(job
->compressions
);
2343 job
->filetypes
= NULL
;
2344 job
->compressions
= NULL
;
2348 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2351 * Save job state info...
2355 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2357 else if (!job
->printer
)
2358 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2363 * Update the server "busy" state...
2366 cupsdSetBusyState();
2371 * 'cupsdStopAllJobs()' - Stop all print jobs.
2376 cupsd_jobaction_t action
, /* I - Action */
2377 int kill_delay
) /* I - Number of seconds before we kill */
2379 cupsd_job_t
*job
; /* Current job */
2382 DEBUG_puts("cupsdStopAllJobs()");
2384 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2386 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2389 job
->kill_time
= time(NULL
) + kill_delay
;
2391 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2397 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2401 cupsdUnloadCompletedJobs(void)
2403 cupsd_job_t
*job
; /* Current job */
2404 time_t expire
; /* Expiration time */
2407 expire
= time(NULL
) - 60;
2409 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2411 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2412 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2413 job
->access_time
< expire
)
2424 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2427 static int /* O - Difference */
2428 compare_active_jobs(void *first
, /* I - First job */
2429 void *second
, /* I - Second job */
2430 void *data
) /* I - App data (not used) */
2432 int diff
; /* Difference */
2435 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2436 ((cupsd_job_t
*)first
)->priority
) != 0)
2439 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2444 * 'compare_jobs()' - Compare the job IDs of two jobs.
2447 static int /* O - Difference */
2448 compare_jobs(void *first
, /* I - First job */
2449 void *second
, /* I - Second job */
2450 void *data
) /* I - App data (not used) */
2452 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2457 * 'finalize_job()' - Cleanup after job filter processes and support data.
2461 finalize_job(cupsd_job_t
*job
) /* I - Job */
2463 ipp_pstate_t printer_state
; /* New printer state value */
2464 ipp_jstate_t job_state
; /* New job state value */
2465 const char *message
; /* Message for job state */
2466 char buffer
[1024]; /* Buffer for formatted messages */
2469 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
2472 * Clear the "connecting-to-device" reason, which is only valid when a
2473 * printer is processing...
2476 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device");
2479 * Similarly, clear the "offline-report" reason for non-USB devices since we
2480 * rarely have current information for network devices...
2483 if (strncmp(job
->printer
->device_uri
, "usb:", 4))
2484 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
2487 * Free the security profile...
2490 cupsdDestroyProfile(job
->profile
);
2491 job
->profile
= NULL
;
2494 * Close pipes and status buffer...
2497 cupsdRemoveSelect(job
->status_buffer
->fd
);
2499 cupsdClosePipe(job
->print_pipes
);
2500 cupsdClosePipe(job
->back_pipes
);
2501 cupsdClosePipe(job
->side_pipes
);
2502 cupsdClosePipe(job
->status_pipes
);
2504 cupsdStatBufDelete(job
->status_buffer
);
2505 job
->status_buffer
= NULL
;
2508 * Process the exit status...
2511 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
2512 printer_state
= IPP_PRINTER_IDLE
;
2514 printer_state
= job
->printer
->state
;
2516 switch (job_state
= job
->state_value
)
2518 case IPP_JOB_PENDING
:
2519 message
= "Job paused.";
2523 message
= "Job held.";
2527 case IPP_JOB_PROCESSING
:
2528 case IPP_JOB_COMPLETED
:
2529 job_state
= IPP_JOB_COMPLETED
;
2530 message
= "Job completed.";
2533 case IPP_JOB_STOPPED
:
2534 message
= "Job stopped.";
2537 case IPP_JOB_CANCELED
:
2538 message
= "Job canceled.";
2541 case IPP_JOB_ABORTED
:
2542 message
= "Job aborted.";
2546 if (job
->status
< 0)
2549 * Backend had errors...
2552 int exit_code
; /* Exit code from backend */
2556 * Convert the status to an exit code. Due to the way the W* macros are
2557 * implemented on MacOS X (bug?), we have to store the exit status in a
2558 * variable first and then convert...
2561 exit_code
= -job
->status
;
2562 if (WIFEXITED(exit_code
))
2563 exit_code
= WEXITSTATUS(exit_code
);
2565 exit_code
= job
->status
;
2567 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
2569 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
2570 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
2571 "authentication required" :
2572 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
2573 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
2574 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
2575 exit_code
< 0 ? "crashed" : "unknown");
2578 * Do what needs to be done...
2584 case CUPS_BACKEND_FAILED
:
2586 * Backend failure, use the error-policy to determine how to
2590 if (job
->dtype
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_IMPLICIT
))
2593 * Queued on a class - mark the job as pending and we'll retry on
2594 * another printer...
2597 if (job_state
== IPP_JOB_COMPLETED
)
2599 job_state
= IPP_JOB_PENDING
;
2600 message
= "Retrying job on another printer.";
2603 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
2606 * The error policy is "retry-current-job" - mark the job as pending
2607 * and we'll retry on the same printer...
2610 if (job_state
== IPP_JOB_COMPLETED
)
2612 job_state
= IPP_JOB_PENDING
;
2613 message
= "Retrying job on same printer.";
2616 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
2617 !strcmp(job
->printer
->error_policy
, "retry-job"))
2619 if (job_state
== IPP_JOB_COMPLETED
)
2622 * The job was queued on a fax or the error policy is "retry-job" -
2623 * hold the job if the number of retries is less than the
2624 * JobRetryLimit, otherwise abort the job.
2629 if (job
->tries
>= JobRetryLimit
)
2635 snprintf(buffer
, sizeof(buffer
),
2636 "Job aborted after %d unsuccessful attempts.",
2638 job_state
= IPP_JOB_ABORTED
;
2644 * Try again in N seconds...
2647 set_hold_until(job
, time(NULL
) + JobRetryInterval
);
2649 snprintf(buffer
, sizeof(buffer
),
2650 "Job held for %d seconds since it could not be sent.",
2652 job_state
= IPP_JOB_HELD
;
2657 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
2658 job_state
== IPP_JOB_COMPLETED
)
2660 job_state
= IPP_JOB_ABORTED
;
2661 message
= "Job aborted due to backend errors; please consult "
2662 "the error_log file for details.";
2666 printer_state
= IPP_PRINTER_STOPPED
;
2667 message
= "Printer stopped due to backend errors; please "
2668 "consult the error_log file for details.";
2670 if (job_state
== IPP_JOB_COMPLETED
)
2671 job_state
= IPP_JOB_PENDING
;
2675 case CUPS_BACKEND_CANCEL
:
2680 if (job_state
== IPP_JOB_COMPLETED
)
2682 job_state
= IPP_JOB_ABORTED
;
2683 message
= "Job aborted due to backend errors; please consult "
2684 "the error_log file for details.";
2688 case CUPS_BACKEND_HOLD
:
2689 if (job_state
== IPP_JOB_COMPLETED
)
2695 cupsdSetJobHoldUntil(job
, "indefinite", 1);
2697 job_state
= IPP_JOB_HELD
;
2698 message
= "Job held indefinitely due to backend errors; please "
2699 "consult the error_log file for details.";
2703 case CUPS_BACKEND_STOP
:
2705 * Stop the printer...
2708 printer_state
= IPP_PRINTER_STOPPED
;
2709 message
= "Printer stopped due to backend errors; please "
2710 "consult the error_log file for details.";
2712 if (job_state
== IPP_JOB_COMPLETED
)
2713 job_state
= IPP_JOB_PENDING
;
2716 case CUPS_BACKEND_AUTH_REQUIRED
:
2718 * Hold the job for authentication...
2721 if (job_state
== IPP_JOB_COMPLETED
)
2723 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
2725 job_state
= IPP_JOB_HELD
;
2726 message
= "Job held for authentication.";
2731 else if (job
->status
> 0)
2734 * Filter had errors; stop job...
2737 if (job_state
== IPP_JOB_COMPLETED
)
2739 job_state
= IPP_JOB_STOPPED
;
2740 message
= "Job stopped due to filter errors; please consult the "
2741 "error_log file for details.";
2746 * Update the printer and job state.
2749 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
2750 cupsdSetPrinterState(job
->printer
, printer_state
,
2751 printer_state
== IPP_PRINTER_STOPPED
);
2752 update_job_attrs(job
, 0);
2754 cupsArrayRemove(PrintingJobs
, job
);
2757 * Clear the printer <-> job association...
2760 job
->printer
->job
= NULL
;
2761 job
->printer
= NULL
;
2764 * Try printing another job...
2767 if (printer_state
!= IPP_PRINTER_STOPPED
)
2773 * 'get_options()' - Get a string containing the job options.
2776 static char * /* O - Options string */
2777 get_options(cupsd_job_t
*job
, /* I - Job */
2778 int banner_page
, /* I - Printing a banner page? */
2779 char *copies
, /* I - Copies buffer */
2780 size_t copies_size
, /* I - Size of copies buffer */
2781 char *title
, /* I - Title buffer */
2782 size_t title_size
) /* I - Size of title buffer */
2784 int i
; /* Looping var */
2785 char *optptr
, /* Pointer to options */
2786 *valptr
; /* Pointer in value string */
2787 ipp_attribute_t
*attr
; /* Current attribute */
2788 static char *options
= NULL
;/* Full list of options */
2789 static int optlength
= 0; /* Length of option buffer */
2793 * Building the options string is harder than it needs to be, but
2794 * for the moment we need to pass strings for command-line args and
2795 * not IPP attribute pointers... :)
2797 * First allocate/reallocate the option buffer as needed...
2800 i
= ipp_length(job
->attrs
);
2802 if (i
> optlength
|| !options
)
2807 optptr
= realloc(options
, i
);
2811 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
2812 "Unable to allocate %d bytes for option buffer!", i
);
2821 * Now loop through the attributes and convert them to the textual
2822 * representation used by the filters...
2828 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
2829 strlcpy(copies
, "1", copies_size
);
2831 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
2833 if (!strcmp(attr
->name
, "copies") &&
2834 attr
->value_tag
== IPP_TAG_INTEGER
)
2837 * Don't use the # copies attribute if we are printing the job sheets...
2841 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
2843 else if (!strcmp(attr
->name
, "job-name") &&
2844 (attr
->value_tag
== IPP_TAG_NAME
||
2845 attr
->value_tag
== IPP_TAG_NAMELANG
))
2846 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
2847 else if (attr
->group_tag
== IPP_TAG_JOB
)
2850 * Filter out other unwanted attributes...
2853 if (attr
->value_tag
== IPP_TAG_MIMETYPE
||
2854 attr
->value_tag
== IPP_TAG_NAMELANG
||
2855 attr
->value_tag
== IPP_TAG_TEXTLANG
||
2856 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid")) ||
2857 attr
->value_tag
== IPP_TAG_URISCHEME
||
2858 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
2861 if (!strncmp(attr
->name
, "time-", 5))
2864 if (!strncmp(attr
->name
, "job-", 4) &&
2865 strcmp(attr
->name
, "job-billing") &&
2866 strcmp(attr
->name
, "job-impressions") &&
2867 strcmp(attr
->name
, "job-originating-host-name") &&
2868 strcmp(attr
->name
, "job-uuid") &&
2869 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
2872 if ((!strcmp(attr
->name
, "job-impressions") ||
2873 !strcmp(attr
->name
, "page-label") ||
2874 !strcmp(attr
->name
, "page-border") ||
2875 !strncmp(attr
->name
, "number-up", 9) ||
2876 !strcmp(attr
->name
, "page-ranges") ||
2877 !strcmp(attr
->name
, "page-set") ||
2878 !strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
2879 !strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
2880 !strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
2881 "PMTotalSidesImaged..n.") ||
2882 !strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
2883 "PMTotalBeginPages..n.")) &&
2888 * Otherwise add them to the list...
2891 if (optptr
> options
)
2892 strlcat(optptr
, " ", optlength
- (optptr
- options
));
2894 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
2896 strlcat(optptr
, attr
->name
, optlength
- (optptr
- options
));
2897 strlcat(optptr
, "=", optlength
- (optptr
- options
));
2900 for (i
= 0; i
< attr
->num_values
; i
++)
2903 strlcat(optptr
, ",", optlength
- (optptr
- options
));
2905 optptr
+= strlen(optptr
);
2907 switch (attr
->value_tag
)
2909 case IPP_TAG_INTEGER
:
2911 snprintf(optptr
, optlength
- (optptr
- options
),
2912 "%d", attr
->values
[i
].integer
);
2915 case IPP_TAG_BOOLEAN
:
2916 if (!attr
->values
[i
].boolean
)
2917 strlcat(optptr
, "no", optlength
- (optptr
- options
));
2919 case IPP_TAG_NOVALUE
:
2920 strlcat(optptr
, attr
->name
,
2921 optlength
- (optptr
- options
));
2924 case IPP_TAG_RANGE
:
2925 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
2926 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
2927 "%d", attr
->values
[i
].range
.lower
);
2929 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
2930 "%d-%d", attr
->values
[i
].range
.lower
,
2931 attr
->values
[i
].range
.upper
);
2934 case IPP_TAG_RESOLUTION
:
2935 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
2936 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
2937 attr
->values
[i
].resolution
.yres
,
2938 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
2942 case IPP_TAG_STRING
:
2945 case IPP_TAG_KEYWORD
:
2946 case IPP_TAG_CHARSET
:
2947 case IPP_TAG_LANGUAGE
:
2949 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
2951 if (strchr(" \t\n\\\'\"", *valptr
))
2953 *optptr
++ = *valptr
++;
2960 break; /* anti-compiler-warning-code */
2964 optptr
+= strlen(optptr
);
2974 * 'ipp_length()' - Compute the size of the buffer needed to hold
2975 * the textual IPP attributes.
2978 static int /* O - Size of attribute buffer */
2979 ipp_length(ipp_t
*ipp
) /* I - IPP request */
2981 int bytes
; /* Number of bytes */
2982 int i
; /* Looping var */
2983 ipp_attribute_t
*attr
; /* Current attribute */
2987 * Loop through all attributes...
2992 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
2995 * Skip attributes that won't be sent to filters...
2998 if (attr
->value_tag
== IPP_TAG_MIMETYPE
||
2999 attr
->value_tag
== IPP_TAG_NAMELANG
||
3000 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3001 attr
->value_tag
== IPP_TAG_URI
||
3002 attr
->value_tag
== IPP_TAG_URISCHEME
)
3005 if (strncmp(attr
->name
, "time-", 5) == 0)
3009 * Add space for a leading space and commas between each value.
3010 * For the first attribute, the leading space isn't used, so the
3011 * extra byte can be used as the nul terminator...
3014 bytes
++; /* " " separator */
3015 bytes
+= attr
->num_values
; /* "," separators */
3018 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3019 * other attributes appear as "foo=value1,value2,...,valueN".
3022 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3023 bytes
+= strlen(attr
->name
);
3025 bytes
+= attr
->num_values
* strlen(attr
->name
);
3028 * Now add the size required for each value in the attribute...
3031 switch (attr
->value_tag
)
3033 case IPP_TAG_INTEGER
:
3036 * Minimum value of a signed integer is -2147483647, or 11 digits.
3039 bytes
+= attr
->num_values
* 11;
3042 case IPP_TAG_BOOLEAN
:
3044 * Add two bytes for each false ("no") value...
3047 for (i
= 0; i
< attr
->num_values
; i
++)
3048 if (!attr
->values
[i
].boolean
)
3052 case IPP_TAG_RANGE
:
3054 * A range is two signed integers separated by a hyphen, or
3055 * 23 characters max.
3058 bytes
+= attr
->num_values
* 23;
3061 case IPP_TAG_RESOLUTION
:
3063 * A resolution is two signed integers separated by an "x" and
3064 * suffixed by the units, or 26 characters max.
3067 bytes
+= attr
->num_values
* 26;
3070 case IPP_TAG_STRING
:
3073 case IPP_TAG_KEYWORD
:
3074 case IPP_TAG_CHARSET
:
3075 case IPP_TAG_LANGUAGE
:
3078 * Strings can contain characters that need quoting. We need
3079 * at least 2 * len + 2 characters to cover the quotes and
3080 * any backslashes in the string.
3083 for (i
= 0; i
< attr
->num_values
; i
++)
3084 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
3088 break; /* anti-compiler-warning-code */
3097 * 'load_job_cache()' - Load jobs from the job.cache file.
3101 load_job_cache(const char *filename
) /* I - job.cache filename */
3103 cups_file_t
*fp
; /* job.cache file */
3104 char line
[1024], /* Line buffer */
3105 *value
; /* Value on line */
3106 int linenum
; /* Line number in file */
3107 cupsd_job_t
*job
; /* Current job */
3108 int jobid
; /* Job ID */
3109 char jobfile
[1024]; /* Job filename */
3113 * Open the job.cache file...
3116 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
3118 if (errno
!= ENOENT
)
3119 cupsdLogMessage(CUPSD_LOG_ERROR
,
3120 "Unable to open job cache file \"%s\": %s",
3121 filename
, strerror(errno
));
3123 load_request_root();
3129 * Read entries from the job cache file and create jobs as needed.
3132 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
3138 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
3140 if (!strcasecmp(line
, "NextJobId"))
3143 NextJobId
= atoi(value
);
3145 else if (!strcasecmp(line
, "<Job"))
3149 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d!",
3156 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d!", linenum
);
3160 jobid
= atoi(value
);
3164 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d!", jobid
,
3169 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
3170 if (access(jobfile
, 0))
3172 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away!",
3177 job
= calloc(1, sizeof(cupsd_job_t
));
3180 cupsdLogMessage(CUPSD_LOG_EMERG
,
3181 "[Job %d] Unable to allocate memory for job!", jobid
);
3186 job
->back_pipes
[0] = -1;
3187 job
->back_pipes
[1] = -1;
3188 job
->print_pipes
[0] = -1;
3189 job
->print_pipes
[1] = -1;
3190 job
->side_pipes
[0] = -1;
3191 job
->side_pipes
[1] = -1;
3192 job
->status_pipes
[0] = -1;
3193 job
->status_pipes
[1] = -1;
3195 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading from cache...",
3200 cupsdLogMessage(CUPSD_LOG_ERROR
,
3201 "Missing <Job #> directive on line %d!", linenum
);
3204 else if (!strcasecmp(line
, "</Job>"))
3206 cupsArrayAdd(Jobs
, job
);
3208 if (job
->state_value
<= IPP_JOB_STOPPED
)
3210 cupsArrayAdd(ActiveJobs
, job
);
3218 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d!", linenum
);
3221 else if (!strcasecmp(line
, "State"))
3223 job
->state_value
= (ipp_jstate_t
)atoi(value
);
3225 if (job
->state_value
< IPP_JOB_PENDING
)
3226 job
->state_value
= IPP_JOB_PENDING
;
3227 else if (job
->state_value
> IPP_JOB_COMPLETED
)
3228 job
->state_value
= IPP_JOB_COMPLETED
;
3230 else if (!strcasecmp(line
, "HoldUntil"))
3232 job
->hold_until
= atoi(value
);
3234 else if (!strcasecmp(line
, "Priority"))
3236 job
->priority
= atoi(value
);
3238 else if (!strcasecmp(line
, "Username"))
3240 cupsdSetString(&job
->username
, value
);
3242 else if (!strcasecmp(line
, "Destination"))
3244 cupsdSetString(&job
->dest
, value
);
3246 else if (!strcasecmp(line
, "DestType"))
3248 job
->dtype
= (cups_ptype_t
)atoi(value
);
3250 else if (!strcasecmp(line
, "NumFiles"))
3252 job
->num_files
= atoi(value
);
3254 if (job
->num_files
< 0)
3256 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d!",
3257 job
->num_files
, linenum
);
3262 if (job
->num_files
> 0)
3264 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
3266 if (access(jobfile
, 0))
3268 cupsdLogMessage(CUPSD_LOG_INFO
, "[Job %d] Data files have gone away!",
3274 job
->filetypes
= calloc(job
->num_files
, sizeof(mime_type_t
*));
3275 job
->compressions
= calloc(job
->num_files
, sizeof(int));
3277 if (!job
->filetypes
|| !job
->compressions
)
3279 cupsdLogMessage(CUPSD_LOG_EMERG
,
3280 "[Job %d] Unable to allocate memory for %d files!",
3281 job
->id
, job
->num_files
);
3286 else if (!strcasecmp(line
, "File"))
3288 int number
, /* File number */
3289 compression
; /* Compression value */
3290 char super
[MIME_MAX_SUPER
], /* MIME super type */
3291 type
[MIME_MAX_TYPE
]; /* MIME type */
3294 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
3297 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d!", linenum
);
3301 if (number
< 1 || number
> job
->num_files
)
3303 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d!",
3310 job
->compressions
[number
] = compression
;
3311 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
3313 if (!job
->filetypes
[number
])
3316 * If the original MIME type is unknown, auto-type it!
3319 cupsdLogMessage(CUPSD_LOG_ERROR
,
3320 "[Job %d] Unknown MIME type %s/%s for file %d!",
3321 job
->id
, super
, type
, number
+ 1);
3323 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
3324 job
->id
, number
+ 1);
3325 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
3326 job
->compressions
+ number
);
3329 * If that didn't work, assume it is raw...
3332 if (!job
->filetypes
[number
])
3333 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
3338 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d!",
3347 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
3351 load_next_job_id(const char *filename
) /* I - job.cache filename */
3353 cups_file_t
*fp
; /* job.cache file */
3354 char line
[1024], /* Line buffer */
3355 *value
; /* Value on line */
3356 int linenum
; /* Line number in file */
3357 int next_job_id
; /* NextJobId value from line */
3361 * Read the NextJobId directive from the job.cache file and use
3362 * the value (if any).
3365 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
3367 if (errno
!= ENOENT
)
3368 cupsdLogMessage(CUPSD_LOG_ERROR
,
3369 "Unable to open job cache file \"%s\": %s",
3370 filename
, strerror(errno
));
3375 cupsdLogMessage(CUPSD_LOG_INFO
,
3376 "Loading NextJobId from job cache file \"%s\"...", filename
);
3380 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
3382 if (!strcasecmp(line
, "NextJobId"))
3386 next_job_id
= atoi(value
);
3388 if (next_job_id
> NextJobId
)
3389 NextJobId
= next_job_id
;
3400 * 'load_request_root()' - Load jobs from the RequestRoot directory.
3404 load_request_root(void)
3406 cups_dir_t
*dir
; /* Directory */
3407 cups_dentry_t
*dent
; /* Directory entry */
3408 cupsd_job_t
*job
; /* New job */
3412 * Open the requests directory...
3415 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
3417 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
3419 cupsdLogMessage(CUPSD_LOG_ERROR
,
3420 "Unable to open spool directory \"%s\": %s",
3421 RequestRoot
, strerror(errno
));
3426 * Read all the c##### files...
3429 while ((dent
= cupsDirRead(dir
)) != NULL
)
3430 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
3433 * Allocate memory for the job...
3436 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
3438 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs!");
3444 * Assign the job ID...
3447 job
->id
= atoi(dent
->filename
+ 1);
3448 job
->back_pipes
[0] = -1;
3449 job
->back_pipes
[1] = -1;
3450 job
->print_pipes
[0] = -1;
3451 job
->print_pipes
[1] = -1;
3452 job
->side_pipes
[0] = -1;
3453 job
->side_pipes
[1] = -1;
3454 job
->status_pipes
[0] = -1;
3455 job
->status_pipes
[1] = -1;
3457 if (job
->id
>= NextJobId
)
3458 NextJobId
= job
->id
+ 1;
3467 * Insert the job into the array, sorting by job priority and ID...
3470 cupsArrayAdd(Jobs
, job
);
3472 if (job
->state_value
<= IPP_JOB_STOPPED
)
3473 cupsArrayAdd(ActiveJobs
, job
);
3483 * 'set_hold_until()' - Set the hold time and update job-hold-until attribute.
3487 set_hold_until(cupsd_job_t
*job
, /* I - Job to update */
3488 time_t holdtime
) /* I - Hold until time */
3490 ipp_attribute_t
*attr
; /* job-hold-until attribute */
3491 struct tm
*holddate
; /* Hold date */
3492 char holdstr
[64]; /* Hold time */
3496 * Set the hold_until value and hold the job...
3499 cupsdLogMessage(CUPSD_LOG_DEBUG
, "set_hold_until: hold_until = %d",
3502 job
->state
->values
[0].integer
= IPP_JOB_HELD
;
3503 job
->state_value
= IPP_JOB_HELD
;
3504 job
->hold_until
= holdtime
;
3507 * Update the job-hold-until attribute with a string representing GMT
3508 * time (HH:MM:SS)...
3511 holddate
= gmtime(&holdtime
);
3512 snprintf(holdstr
, sizeof(holdstr
), "%d:%d:%d", holddate
->tm_hour
,
3513 holddate
->tm_min
, holddate
->tm_sec
);
3515 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
3516 IPP_TAG_KEYWORD
)) == NULL
)
3517 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
3520 * Either add the attribute or update the value of the existing one
3524 ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "job-hold-until",
3527 cupsdSetString(&attr
->values
[0].string
.text
, holdstr
);
3530 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
3535 * 'set_time()' - Set one of the "time-at-xyz" attributes.
3539 set_time(cupsd_job_t
*job
, /* I - Job to update */
3540 const char *name
) /* I - Name of attribute */
3542 ipp_attribute_t
*attr
; /* Time attribute */
3545 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
3547 attr
->value_tag
= IPP_TAG_INTEGER
;
3548 attr
->values
[0].integer
= time(NULL
);
3554 * 'start_job()' - Start a print job.
3558 start_job(cupsd_job_t
*job
, /* I - Job ID */
3559 cupsd_printer_t
*printer
) /* I - Printer to print job */
3561 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
3562 job
, job
->id
, printer
, printer
->name
);
3565 * Make sure we have some files around before we try to print...
3568 if (job
->num_files
== 0)
3570 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
3571 "Aborting job because it has no files.");
3576 * Update the printer and job state to "processing"...
3579 if (!cupsdLoadJob(job
))
3582 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
3583 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
3586 job
->current_file
= 0;
3588 job
->printer
= printer
;
3592 * Setup the last exit status and security profiles...
3596 job
->profile
= cupsdCreateProfile(job
->id
);
3599 * Create the status pipes and buffer...
3602 if (cupsdOpenPipe(job
->status_pipes
))
3604 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
3605 "Unable to create job status pipes - %s.", strerror(errno
));
3607 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
3608 "Job stopped because the scheduler could not create the "
3609 "job status pipes.");
3611 cupsdDestroyProfile(job
->profile
);
3612 job
->profile
= NULL
;
3616 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
3617 job
->status_level
= CUPSD_LOG_INFO
;
3619 if (job
->printer_message
)
3620 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
3623 * Create the backchannel pipes and make them non-blocking...
3626 if (cupsdOpenPipe(job
->back_pipes
))
3628 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
3629 "Unable to create back-channel pipes - %s.", strerror(errno
));
3631 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
3632 "Job stopped because the scheduler could not create the "
3633 "back-channel pipes.");
3635 cupsdClosePipe(job
->status_pipes
);
3636 cupsdStatBufDelete(job
->status_buffer
);
3637 job
->status_buffer
= NULL
;
3639 cupsdDestroyProfile(job
->profile
);
3640 job
->profile
= NULL
;
3644 fcntl(job
->back_pipes
[0], F_SETFL
,
3645 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
3646 fcntl(job
->back_pipes
[1], F_SETFL
,
3647 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
3650 * Create the side-channel pipes and make them non-blocking...
3653 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
3655 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
3656 "Unable to create side-channel pipes - %s.", strerror(errno
));
3658 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
3659 "Job stopped because the scheduler could not create the "
3660 "side-channel pipes.");
3662 cupsdClosePipe(job
->back_pipes
);
3664 cupsdClosePipe(job
->status_pipes
);
3665 cupsdStatBufDelete(job
->status_buffer
);
3666 job
->status_buffer
= NULL
;
3668 cupsdDestroyProfile(job
->profile
);
3669 job
->profile
= NULL
;
3673 fcntl(job
->side_pipes
[0], F_SETFL
,
3674 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
3675 fcntl(job
->side_pipes
[1], F_SETFL
,
3676 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
3679 * Now start the first file in the job...
3682 cupsdContinueJob(job
);
3687 * 'stop_job()' - Stop a print job.
3691 stop_job(cupsd_job_t
*job
, /* I - Job */
3692 cupsd_jobaction_t action
) /* I - Action */
3694 int i
; /* Looping var */
3697 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
3700 FilterLevel
-= job
->cost
;
3703 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
)
3704 job
->kill_time
= time(NULL
) + JobKillDelay
;
3705 else if (action
== CUPSD_JOB_FORCE
)
3708 for (i
= 0; job
->filters
[i
]; i
++)
3709 if (job
->filters
[i
] > 0)
3710 cupsdEndProcess(job
->filters
[i
], action
== CUPSD_JOB_FORCE
);
3712 if (job
->backend
> 0)
3713 cupsdEndProcess(job
->backend
, action
== CUPSD_JOB_FORCE
);
3718 * 'unload_job()' - Unload a job from memory.
3722 unload_job(cupsd_job_t
*job
) /* I - Job */
3727 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Unloading...", job
->id
);
3729 ippDelete(job
->attrs
);
3734 job
->job_sheets
= NULL
;
3735 job
->printer_message
= NULL
;
3736 job
->printer_reasons
= NULL
;
3741 * 'update_job()' - Read a status update from a job's filters.
3745 update_job(cupsd_job_t
*job
) /* I - Job to check */
3747 int i
; /* Looping var */
3748 int copies
; /* Number of copies printed */
3749 char message
[1024], /* Message text */
3750 *ptr
; /* Pointer update... */
3751 int loglevel
, /* Log level for message */
3752 event
= 0; /* Events? */
3753 static const char * const levels
[] = /* Log levels */
3769 * Get the printer associated with this job; if the printer is stopped for
3770 * any reason then job->printer will be reset to NULL, so make sure we have
3771 * a valid pointer...
3774 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
3775 message
, sizeof(message
))) != NULL
)
3778 * Process page and printer state messages as needed...
3781 if (loglevel
== CUPSD_LOG_PAGE
)
3784 * Page message; send the message to the page_log file and update the
3785 * job sheet count...
3788 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
3792 if (!strncasecmp(message
, "total ", 6))
3795 * Got a total count of pages from a backend or filter...
3798 copies
= atoi(message
+ 6);
3799 copies
-= job
->sheets
->values
[0].integer
; /* Just track the delta */
3801 else if (!sscanf(message
, "%*d%d", &copies
))
3804 job
->sheets
->values
[0].integer
+= copies
;
3806 if (job
->printer
->page_limit
)
3808 cupsd_quota_t
*q
= cupsdUpdateQuota(job
->printer
, job
->username
,
3812 if (AppleQuotas
&& q
->page_count
== -3)
3815 * Quota limit exceeded, cancel job in progress immediately...
3818 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
,
3819 "Canceled job because pages exceed user %s "
3820 "quota limit on printer %s (%s).",
3821 job
->username
, job
->printer
->name
,
3822 job
->printer
->info
);
3827 #endif /* __APPLE__ */
3831 cupsdLogPage(job
, message
);
3834 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
3835 "Printed %d page(s).", job
->sheets
->values
[0].integer
);
3837 else if (loglevel
== CUPSD_LOG_STATE
)
3839 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
3841 if (!strcmp(message
, "paused"))
3843 cupsdStopPrinter(job
->printer
, 1);
3848 cupsdSetPrinterReasons(job
->printer
, message
);
3849 cupsdAddPrinterHistory(job
->printer
);
3850 event
|= CUPSD_EVENT_PRINTER_STATE
;
3853 update_job_attrs(job
, 0);
3855 else if (loglevel
== CUPSD_LOG_ATTR
)
3858 * Set attribute(s)...
3861 int num_attrs
; /* Number of attributes */
3862 cups_option_t
*attrs
; /* Attributes */
3863 const char *attr
; /* Attribute */
3866 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
3868 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
3870 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
3873 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
3874 cupsdSetPrinterAttrs(job
->printer
);
3876 if (job
->printer
->type
& CUPS_PRINTER_DISCOVERED
)
3877 cupsdMarkDirty(CUPSD_DIRTY_REMOTE
);
3879 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
3882 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
3885 int progress
= atoi(attr
);
3888 if (progress
>= 0 && progress
<= 100)
3890 job
->progress
= progress
;
3893 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
3894 "Printing page %d, %d%%",
3895 job
->sheets
->values
[0].integer
, job
->progress
);
3899 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
3901 cupsdSetString(&job
->printer
->alert
, attr
);
3902 event
|= CUPSD_EVENT_PRINTER_STATE
;
3905 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
3908 cupsdSetString(&job
->printer
->alert_description
, attr
);
3909 event
|= CUPSD_EVENT_PRINTER_STATE
;
3912 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
3914 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
3915 job
->printer
->marker_time
= time(NULL
);
3916 event
|= CUPSD_EVENT_PRINTER_STATE
;
3917 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
3920 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
3922 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
3923 job
->printer
->marker_time
= time(NULL
);
3924 event
|= CUPSD_EVENT_PRINTER_STATE
;
3925 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
3928 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
3930 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
3931 job
->printer
->marker_time
= time(NULL
);
3932 event
|= CUPSD_EVENT_PRINTER_STATE
;
3933 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
3936 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
3938 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
3939 job
->printer
->marker_time
= time(NULL
);
3940 event
|= CUPSD_EVENT_PRINTER_STATE
;
3941 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
3944 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
3946 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
3947 job
->printer
->marker_time
= time(NULL
);
3948 event
|= CUPSD_EVENT_PRINTER_STATE
;
3949 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
3952 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
3954 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
3955 job
->printer
->marker_time
= time(NULL
);
3956 event
|= CUPSD_EVENT_PRINTER_STATE
;
3957 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
3960 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
3962 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
3963 job
->printer
->marker_time
= time(NULL
);
3964 event
|= CUPSD_EVENT_PRINTER_STATE
;
3965 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
3968 cupsFreeOptions(num_attrs
, attrs
);
3970 else if (loglevel
== CUPSD_LOG_PPD
)
3973 * Set attribute(s)...
3976 int num_keywords
; /* Number of keywords */
3977 cups_option_t
*keywords
; /* Keywords */
3980 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
3982 num_keywords
= cupsParseOptions(message
, 0, &keywords
);
3984 if (cupsdUpdatePrinterPPD(job
->printer
, num_keywords
, keywords
))
3985 cupsdSetPrinterAttrs(job
->printer
);
3987 cupsFreeOptions(num_keywords
, keywords
);
3990 else if (!strncmp(message
, "recoverable:", 12))
3993 while (isspace(*ptr
& 255))
3998 cupsdSetPrinterReasons(job
->printer
,
3999 "+com.apple.print.recoverable-warning");
4000 cupsdSetString(&(job
->printer
->recoverable
), ptr
);
4001 cupsdAddPrinterHistory(job
->printer
);
4002 event
|= CUPSD_EVENT_PRINTER_STATE
;
4005 else if (!strncmp(message
, "recovered:", 10))
4007 cupsdSetPrinterReasons(job
->printer
,
4008 "-com.apple.print.recoverable-warning");
4011 while (isspace(*ptr
& 255))
4014 cupsdSetString(&(job
->printer
->recoverable
), ptr
);
4015 cupsdAddPrinterHistory(job
->printer
);
4016 event
|= CUPSD_EVENT_PRINTER_STATE
;
4018 #endif /* __APPLE__ */
4021 cupsdLogJob(job
, loglevel
, "%s", message
);
4023 if (loglevel
< CUPSD_LOG_DEBUG
)
4025 strlcpy(job
->printer
->state_message
, message
,
4026 sizeof(job
->printer
->state_message
));
4027 cupsdAddPrinterHistory(job
->printer
);
4029 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
4031 if (loglevel
< job
->status_level
)
4034 * Some messages show in the job-printer-state-message attribute...
4037 if (loglevel
!= CUPSD_LOG_NOTICE
)
4038 job
->status_level
= loglevel
;
4040 update_job_attrs(job
, 1);
4042 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4043 "Set job-printer-state-message to \"%s\", "
4045 job
->printer_message
->values
[0].string
.text
,
4046 levels
[job
->status_level
]);
4051 if (!strchr(job
->status_buffer
->buffer
, '\n'))
4055 if (event
& CUPSD_EVENT_PRINTER_STATE
)
4056 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
4057 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
4058 "Class \"%s\" state changed." :
4059 "Printer \"%s\" state changed.",
4060 job
->printer
->name
);
4062 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
4063 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4064 "%s", job
->printer
->state_message
);
4066 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
4069 * See if all of the filters and the backend have returned their
4073 for (i
= 0; job
->filters
[i
] < 0; i
++);
4075 if (job
->filters
[i
])
4078 * EOF but we haven't collected the exit status of all filters...
4081 cupsdCheckProcess();
4085 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
4088 * EOF but we haven't collected the exit status of the backend...
4091 cupsdCheckProcess();
4096 * Handle the end of job stuff...
4102 * Check for new jobs...
4111 * 'update_job_attrs()' - Update the job-printer-* attributes.
4115 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
4116 int do_message
)/* I - 1 = copy job-printer-state message */
4118 int i
; /* Looping var */
4119 int num_reasons
; /* Actual number of reasons */
4120 const char * const *reasons
; /* Reasons */
4121 static const char *none
= "none"; /* "none" reason */
4125 * Get/create the job-printer-state-* attributes...
4128 if (!job
->printer_message
)
4130 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
4131 "job-printer-state-message",
4132 IPP_TAG_TEXT
)) == NULL
)
4133 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
4134 "job-printer-state-message",
4138 if (!job
->printer_reasons
)
4139 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
4140 "job-printer-state-reasons",
4144 * Copy or clear the printer-state-message value as needed...
4147 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
4148 job
->status_level
== CUPSD_LOG_INFO
)
4149 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
4150 else if (job
->printer
->state_message
[0] && do_message
)
4151 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
),
4152 job
->printer
->state_message
);
4155 * ... and the printer-state-reasons value...
4158 if (job
->printer
->num_reasons
== 0)
4165 num_reasons
= job
->printer
->num_reasons
;
4166 reasons
= (const char * const *)job
->printer
->reasons
;
4169 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
4172 * Replace/create a job-printer-state-reasons attribute...
4175 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
4177 job
->printer_reasons
= ippAddStrings(job
->attrs
,
4178 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
4179 "job-printer-state-reasons",
4180 num_reasons
, NULL
, NULL
);
4185 * Don't bother clearing the reason strings if they are the same...
4188 for (i
= 0; i
< num_reasons
; i
++)
4189 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
4192 if (i
>= num_reasons
)
4196 * Not the same, so free the current strings...
4199 for (i
= 0; i
< num_reasons
; i
++)
4200 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
4204 * Copy the reasons...
4207 for (i
= 0; i
< num_reasons
; i
++)
4208 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
4213 * End of "$Id: job.c 7902 2008-09-03 14:20:17Z mike $".