2 * Job management routines for the CUPS scheduler.
4 * Copyright 2007-2019 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
7 * These coded instructions, statements, and computer programs are the
8 * property of Apple Inc. and are protected by Federal copyright
9 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 * which should have been included with this file. If this file is
11 * missing or damaged, see the license at "http://www.cups.org/".
15 * Include necessary headers...
20 #include <cups/backend.h>
23 # include <IOKit/pwr_mgt/IOPMLib.h>
24 # ifdef HAVE_IOKIT_PWR_MGT_IOPMLIBPRIVATE_H
25 # include <IOKit/pwr_mgt/IOPMLibPrivate.h>
26 # endif /* HAVE_IOKIT_PWR_MGT_IOPMLIBPRIVATE_H */
27 #endif /* __APPLE__ */
31 * Design Notes for Job Management
32 * -------------------------------
36 * pending Do nothing/check jobs
37 * pending-held Send SIGTERM to filters and backend
38 * processing Do nothing/start job
39 * stopped Send SIGKILL to filters and backend
40 * canceled Send SIGTERM to filters and backend
44 * Finalize clears the printer <-> job association, deletes the status
45 * buffer, closes all of the pipes, etc. and doesn't get run until all of
46 * the print processes are finished.
48 * UNLOADING OF JOBS (cupsdUnloadCompletedJobs)
50 * We unload the job attributes when they are not needed to reduce overall
51 * memory consumption. We don't unload jobs where job->state_value <
52 * IPP_JOB_STOPPED, job->printer != NULL, or job->access_time is recent.
54 * STARTING OF JOBS (start_job)
56 * When a job is started, a status buffer, several pipes, a security
57 * profile, and a backend process are created for the life of that job.
58 * These are shared for every file in a job. For remote print jobs, the
59 * IPP backend is provided with every file in the job and no filters are
62 * The job->printer member tracks which printer is printing a job, which
63 * can be different than the destination in job->dest for classes. The
64 * printer object also has a job pointer to track which job is being
67 * PRINTING OF JOB FILES (cupsdContinueJob)
69 * Each file in a job is filtered by 0 or more programs. After getting the
70 * list of filters needed and the total cost, the job is either passed or
71 * put back to the processing state until the current FilterLevel comes down
72 * enough to allow printing.
74 * If we can print, we build a string for the print options and run each of
75 * the filters, piping the output from one into the next.
77 * JOB STATUS UPDATES (update_job)
79 * The update_job function gets called whenever there are pending messages
80 * on the status pipe. These generally are updates to the marker-*,
81 * printer-state-message, or printer-state-reasons attributes. On EOF,
82 * finalize_job is called to clean up.
84 * FINALIZING JOBS (finalize_job)
86 * When all filters and the backend are done, we set the job state to
87 * completed (no errors), aborted (filter errors or abort-job policy),
88 * pending-held (auth required or retry-job policy), or pending
89 * (retry-current-job or stop-printer policies) as appropriate.
91 * Then we close the pipes and free the status buffers and profiles.
93 * JOB FILE COMPLETION (process_children in main.c)
95 * For multiple-file jobs, process_children (in main.c) sees that all
96 * filters have exited and calls in to print the next file if there are
97 * more files in the job, otherwise it waits for the backend to exit and
98 * update_job to do the cleanup.
106 static mime_filter_t gziptoany_filter
=
108 NULL
, /* Source type */
109 NULL
, /* Destination type */
111 "gziptoany" /* Filter program to run */
119 static int compare_active_jobs(void *first
, void *second
, void *data
);
120 static int compare_completed_jobs(void *first
, void *second
, void *data
);
121 static int compare_jobs(void *first
, void *second
, void *data
);
122 static void dump_job_history(cupsd_job_t
*job
);
123 static void finalize_job(cupsd_job_t
*job
, int set_job_state
);
124 static void free_job_history(cupsd_job_t
*job
);
125 static char *get_options(cupsd_job_t
*job
, int banner_page
, char *copies
,
126 size_t copies_size
, char *title
,
128 static size_t ipp_length(ipp_t
*ipp
);
129 static void load_job_cache(const char *filename
);
130 static void load_next_job_id(const char *filename
);
131 static void load_request_root(void);
132 static void remove_job_files(cupsd_job_t
*job
);
133 static void remove_job_history(cupsd_job_t
*job
);
134 static void set_time(cupsd_job_t
*job
, const char *name
);
135 static void start_job(cupsd_job_t
*job
, cupsd_printer_t
*printer
);
136 static void stop_job(cupsd_job_t
*job
, cupsd_jobaction_t action
);
137 static void unload_job(cupsd_job_t
*job
);
138 static void update_job(cupsd_job_t
*job
);
139 static void update_job_attrs(cupsd_job_t
*job
, int do_message
);
143 * 'cupsdAddJob()' - Add a new job to the job queue.
146 cupsd_job_t
* /* O - New job record */
147 cupsdAddJob(int priority
, /* I - Job priority */
148 const char *dest
) /* I - Job destination */
150 cupsd_job_t
*job
; /* New job record */
153 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
156 job
->id
= NextJobId
++;
157 job
->priority
= priority
;
158 job
->back_pipes
[0] = -1;
159 job
->back_pipes
[1] = -1;
160 job
->print_pipes
[0] = -1;
161 job
->print_pipes
[1] = -1;
162 job
->side_pipes
[0] = -1;
163 job
->side_pipes
[1] = -1;
164 job
->status_pipes
[0] = -1;
165 job
->status_pipes
[1] = -1;
167 cupsdSetString(&job
->dest
, dest
);
170 * Add the new job to the "all jobs" and "active jobs" lists...
173 cupsArrayAdd(Jobs
, job
);
174 cupsArrayAdd(ActiveJobs
, job
);
181 * 'cupsdCancelJobs()' - Cancel all jobs for the given destination/user.
185 cupsdCancelJobs(const char *dest
, /* I - Destination to cancel */
186 const char *username
, /* I - Username or NULL */
187 int purge
) /* I - Purge jobs? */
189 cupsd_job_t
*job
; /* Current job */
192 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
194 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
196 if ((!job
->dest
|| !job
->username
) && !cupsdLoadJob(job
))
199 if ((!dest
|| !strcmp(job
->dest
, dest
)) &&
200 (!username
|| !strcmp(job
->username
, username
)))
203 * Cancel all jobs matching this destination/user...
207 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_PURGE
,
208 "Job purged by user.");
209 else if (job
->state_value
< IPP_JOB_CANCELED
)
210 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
,
211 "Job canceled by user.");
218 * 'cupsdCheckJobs()' - Check the pending jobs and start any if the destination
225 cupsd_job_t
*job
; /* Current job in queue */
226 cupsd_printer_t
*printer
, /* Printer destination */
227 *pclass
; /* Printer class destination */
228 ipp_attribute_t
*attr
; /* Job attribute */
229 time_t curtime
; /* Current time */
230 const char *reasons
; /* job-state-reasons value */
233 curtime
= time(NULL
);
235 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCheckJobs: %d active jobs, sleeping=%d, ac-power=%d, reload=%d, curtime=%ld", cupsArrayCount(ActiveJobs
), Sleeping
, ACPower
, NeedReload
, (long)curtime
);
237 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
);
239 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
241 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
242 "cupsdCheckJobs: Job %d - dest=\"%s\", printer=%p, "
243 "state=%d, cancel_time=%ld, hold_until=%ld, kill_time=%ld, "
244 "pending_cost=%d, pending_timeout=%ld", job
->id
, job
->dest
,
245 job
->printer
, job
->state_value
, (long)job
->cancel_time
,
246 (long)job
->hold_until
, (long)job
->kill_time
,
247 job
->pending_cost
, (long)job
->pending_timeout
);
250 * Kill jobs if they are unresponsive...
253 if (job
->kill_time
&& job
->kill_time
<= curtime
)
256 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Stopping unresponsive job.");
258 stop_job(job
, CUPSD_JOB_FORCE
);
263 * Cancel stuck jobs...
266 if (job
->cancel_time
&& job
->cancel_time
<= curtime
)
268 int cancel_after
; /* job-cancel-after value */
270 attr
= ippFindAttribute(job
->attrs
, "job-cancel-after", IPP_TAG_INTEGER
);
271 cancel_after
= attr
? ippGetInteger(attr
, 0) : MaxJobTime
;
274 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_FORCE
, "Marking stuck job as completed after %d seconds.", cancel_after
);
276 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
, "Canceling stuck job after %d seconds.", cancel_after
);
281 * Start held jobs if they are ready...
284 if (job
->state_value
== IPP_JOB_HELD
&&
286 job
->hold_until
< curtime
)
288 if (job
->pending_timeout
)
291 * This job is pending; check that we don't have an active Send-Document
292 * operation in progress on any of the client connections, then timeout
293 * the job so we can start printing...
296 cupsd_client_t
*con
; /* Current client connection */
298 for (con
= (cupsd_client_t
*)cupsArrayFirst(Clients
);
300 con
= (cupsd_client_t
*)cupsArrayNext(Clients
))
302 con
->request
->request
.op
.operation_id
== IPP_SEND_DOCUMENT
)
308 if (cupsdTimeoutJob(job
))
312 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
313 "Job submission timed out.");
317 * Continue jobs that are waiting on the FilterLimit...
320 if (job
->pending_cost
> 0 &&
321 ((FilterLevel
+ job
->pending_cost
) < FilterLimit
|| FilterLevel
== 0))
322 cupsdContinueJob(job
);
325 * Skip jobs that where held-on-create
328 reasons
= ippGetString(job
->reasons
, 0, NULL
);
329 if (reasons
&& !strcmp(reasons
, "job-held-on-create"))
332 * Check whether the printer is still holding new jobs...
335 printer
= cupsdFindDest(job
->dest
);
337 if (printer
->holding_new_jobs
)
340 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
344 * Start pending jobs if the destination is available...
347 if (job
->state_value
== IPP_JOB_PENDING
&& !NeedReload
&&
348 (!Sleeping
|| ACPower
) && !DoingShutdown
&& !job
->printer
)
350 printer
= cupsdFindDest(job
->dest
);
353 while (printer
&& (printer
->type
& CUPS_PRINTER_CLASS
))
356 * If the class is remote, just pass it to the remote server...
361 if (pclass
->state
== IPP_PRINTER_STOPPED
)
363 else if (pclass
->type
& CUPS_PRINTER_REMOTE
)
366 printer
= cupsdFindAvailablePrinter(printer
->name
);
369 if (!printer
&& !pclass
)
372 * Whoa, the printer and/or class for this destination went away;
376 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_PURGE
,
377 "Job aborted because the destination printer/class "
383 * See if the printer is available or remote and not printing a job;
384 * if so, start the job...
390 * Add/update a job-printer-uri-actual attribute for this job
391 * so that we know which printer actually printed the job...
394 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri-actual", IPP_TAG_URI
)) != NULL
)
395 ippSetString(job
->attrs
, &attr
, 0, printer
->uri
);
397 ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_URI
, "job-printer-uri-actual", NULL
, printer
->uri
);
400 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
403 if (!printer
->job
&& printer
->state
== IPP_PRINTER_IDLE
)
409 cupsArraySave(ActiveJobs
);
410 start_job(job
, printer
);
411 cupsArrayRestore(ActiveJobs
);
420 * 'cupsdCleanJobs()' - Clean out old jobs.
426 cupsd_job_t
*job
; /* Current job */
427 time_t curtime
; /* Current time */
430 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
431 "cupsdCleanJobs: MaxJobs=%d, JobHistory=%d, JobFiles=%d",
432 MaxJobs
, JobHistory
, JobFiles
);
434 if (MaxJobs
<= 0 && JobHistory
== INT_MAX
&& JobFiles
== INT_MAX
)
437 curtime
= time(NULL
);
438 JobHistoryUpdate
= 0;
440 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
442 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
444 if (job
->state_value
>= IPP_JOB_CANCELED
&& !job
->printer
)
447 * Expire old jobs (or job files)...
450 if ((MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
) ||
451 (job
->history_time
&& job
->history_time
<= curtime
))
453 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Removing from history.");
454 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
456 else if (job
->file_time
&& job
->file_time
<= curtime
)
458 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Removing document files.");
459 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "curtime=%ld, job->file_time=%ld", (long)curtime
, (long)job
->file_time
);
460 remove_job_files(job
);
462 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
464 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
465 JobHistoryUpdate
= job
->history_time
;
469 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
470 JobHistoryUpdate
= job
->history_time
;
472 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
473 JobHistoryUpdate
= job
->file_time
;
478 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCleanJobs: JobHistoryUpdate=%ld",
479 (long)JobHistoryUpdate
);
484 * 'cupsdContinueJob()' - Continue printing with the next file in a job.
488 cupsdContinueJob(cupsd_job_t
*job
) /* I - Job */
490 int i
; /* Looping var */
491 int slot
; /* Pipe slot */
492 cups_array_t
*filters
= NULL
,/* Filters for job */
493 *prefilters
; /* Filters with prefilters */
494 mime_filter_t
*filter
, /* Current filter */
495 *prefilter
, /* Prefilter */
496 port_monitor
; /* Port monitor filter */
497 char scheme
[255]; /* Device URI scheme */
498 ipp_attribute_t
*attr
; /* Current attribute */
499 const char *ptr
, /* Pointer into value */
500 *abort_message
; /* Abort message */
501 ipp_jstate_t abort_state
= IPP_JOB_STOPPED
;
502 /* New job state on abort */
503 struct stat backinfo
; /* Backend file information */
504 int backroot
; /* Run backend as root? */
505 int pid
; /* Process ID of new filter process */
506 int banner_page
; /* 1 if banner page, 0 otherwise */
507 int filterfds
[2][2] = { { -1, -1 }, { -1, -1 } };
508 /* Pipes used between filters */
509 int envc
; /* Number of environment variables */
510 struct stat fileinfo
; /* Job file information */
511 int argc
= 0; /* Number of arguments */
512 char **argv
= NULL
, /* Filter command-line arguments */
513 filename
[1024], /* Job filename */
514 command
[1024], /* Full path to command */
515 jobid
[255], /* Job ID string */
517 /* Job title string */
518 copies
[255], /* # copies string */
519 *options
, /* Options string */
521 /* Environment variables */
522 charset
[255], /* CHARSET env variable */
523 class_name
[255],/* CLASS env variable */
524 classification
[1024],
525 /* CLASSIFICATION env variable */
527 /* CONTENT_TYPE env variable */
529 /* DEVICE_URI env variable */
530 final_content_type
[1024] = "",
531 /* FINAL_CONTENT_TYPE env variable */
532 lang
[255], /* LANG env variable */
535 /* APPLE_LANGUAGE env variable */
536 #endif /* __APPLE__ */
537 auth_info_required
[255],
538 /* AUTH_INFO_REQUIRED env variable */
539 ppd
[1024], /* PPD env variable */
541 /* PRINTER_INFO env variable */
542 printer_location
[255],
543 /* PRINTER_LOCATION env variable */
545 /* PRINTER env variable */
546 *printer_state_reasons
= NULL
,
547 /* PRINTER_STATE_REASONS env var */
549 /* RIP_MAX_CACHE env variable */
552 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
553 "cupsdContinueJob(job=%p(%d)): current_file=%d, num_files=%d",
554 job
, job
->id
, job
->current_file
, job
->num_files
);
557 * Figure out what filters are required to convert from
558 * the source to the destination type...
561 FilterLevel
-= job
->cost
;
564 job
->pending_cost
= 0;
566 memset(job
->filters
, 0, sizeof(job
->filters
));
568 if (job
->printer
->raw
)
571 * Remote jobs and raw queues go directly to the printer without
575 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Sending job to queue tagged as raw...");
580 * Local jobs get filtered...
583 mime_type_t
*dst
= job
->printer
->filetype
;
584 /* Destination file type */
586 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
587 job
->id
, job
->current_file
+ 1);
588 if (stat(filename
, &fileinfo
))
589 fileinfo
.st_size
= 0;
591 if (job
->retry_as_raster
)
594 * Need to figure out whether the printer supports image/pwg-raster or
595 * image/urf, and use the corresponding type...
598 char type
[MIME_MAX_TYPE
]; /* MIME media type for printer */
600 snprintf(type
, sizeof(type
), "%s/image/urf", job
->printer
->name
);
601 if ((dst
= mimeType(MimeDatabase
, "printer", type
)) == NULL
)
603 snprintf(type
, sizeof(type
), "%s/image/pwg-raster", job
->printer
->name
);
604 dst
= mimeType(MimeDatabase
, "printer", type
);
608 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Retrying job as \"%s\".", strchr(dst
->type
, '/') + 1);
610 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to retry job using a supported raster format.");
613 filters
= mimeFilter2(MimeDatabase
, job
->filetypes
[job
->current_file
], (size_t)fileinfo
.st_size
, dst
, &(job
->cost
));
617 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
618 "Unable to convert file %d to printable format.",
621 abort_message
= "Aborting job because it cannot be printed.";
622 abort_state
= IPP_JOB_ABORTED
;
624 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
629 * Figure out the final content type...
632 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%d filters for job:",
633 cupsArrayCount(filters
));
634 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
636 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
637 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s (%s/%s to %s/%s, cost %d)",
639 filter
->src
? filter
->src
->super
: "???",
640 filter
->src
? filter
->src
->type
: "???",
641 filter
->dst
? filter
->dst
->super
: "???",
642 filter
->dst
? filter
->dst
->type
: "???",
645 if (!job
->printer
->remote
)
647 for (filter
= (mime_filter_t
*)cupsArrayLast(filters
);
648 filter
&& filter
->dst
;
649 filter
= (mime_filter_t
*)cupsArrayPrev(filters
))
650 if (strcmp(filter
->dst
->super
, "printer") ||
651 strcmp(filter
->dst
->type
, job
->printer
->name
))
654 if (filter
&& filter
->dst
)
656 if ((ptr
= strchr(filter
->dst
->type
, '/')) != NULL
)
657 snprintf(final_content_type
, sizeof(final_content_type
),
658 "FINAL_CONTENT_TYPE=%s", ptr
+ 1);
660 snprintf(final_content_type
, sizeof(final_content_type
),
661 "FINAL_CONTENT_TYPE=%s/%s", filter
->dst
->super
,
665 snprintf(final_content_type
, sizeof(final_content_type
),
666 "FINAL_CONTENT_TYPE=printer/%s", job
->printer
->name
);
670 * Remove NULL ("-") filters...
673 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
675 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
676 if (!strcmp(filter
->filter
, "-"))
677 cupsArrayRemove(filters
, filter
);
679 if (cupsArrayCount(filters
) == 0)
681 cupsArrayDelete(filters
);
686 * If this printer has any pre-filters, insert the required pre-filter
687 * in the filters array...
690 if (job
->printer
->prefiltertype
&& filters
)
692 prefilters
= cupsArrayNew(NULL
, NULL
);
694 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
696 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
698 if ((prefilter
= mimeFilterLookup(MimeDatabase
, filter
->src
,
699 job
->printer
->prefiltertype
)))
701 cupsArrayAdd(prefilters
, prefilter
);
702 job
->cost
+= prefilter
->cost
;
705 cupsArrayAdd(prefilters
, filter
);
708 cupsArrayDelete(filters
);
709 filters
= prefilters
;
714 * Set a minimum cost of 100 for all jobs so that FilterLimit
715 * works with raw queues and other low-cost paths.
722 * See if the filter cost is too high...
725 if ((FilterLevel
+ job
->cost
) > FilterLimit
&& FilterLevel
> 0 &&
729 * Don't print this job quite yet...
732 cupsArrayDelete(filters
);
734 cupsdLogJob(job
, CUPSD_LOG_INFO
,
735 "Holding because filter limit has been reached.");
736 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
,
737 "cupsdContinueJob: file=%d, cost=%d, level=%d, limit=%d",
738 job
->current_file
, job
->cost
, FilterLevel
,
741 job
->pending_cost
= job
->cost
;
746 FilterLevel
+= job
->cost
;
749 * Add decompression/raw filter as needed...
752 if ((job
->compressions
[job
->current_file
] && (!job
->printer
->remote
|| job
->num_files
== 1)) ||
753 (!job
->printer
->remote
&& job
->printer
->raw
&& job
->num_files
> 1))
756 * Add gziptoany filter to the front of the list...
760 filters
= cupsArrayNew(NULL
, NULL
);
762 if (!cupsArrayInsert(filters
, &gziptoany_filter
))
764 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
765 "Unable to add decompression filter - %s", strerror(errno
));
767 cupsArrayDelete(filters
);
769 abort_message
= "Stopping job because the scheduler ran out of memory.";
776 * Add port monitor, if any...
779 if (job
->printer
->port_monitor
)
782 * Add port monitor to the end of the list...
786 filters
= cupsArrayNew(NULL
, NULL
);
788 port_monitor
.src
= NULL
;
789 port_monitor
.dst
= NULL
;
790 port_monitor
.cost
= 0;
792 snprintf(port_monitor
.filter
, sizeof(port_monitor
.filter
),
793 "%s/monitor/%s", ServerBin
, job
->printer
->port_monitor
);
795 if (!cupsArrayAdd(filters
, &port_monitor
))
797 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
798 "Unable to add port monitor - %s", strerror(errno
));
800 abort_message
= "Stopping job because the scheduler ran out of memory.";
807 * Make sure we don't go over the "MAX_FILTERS" limit...
810 if (cupsArrayCount(filters
) > MAX_FILTERS
)
812 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
813 "Too many filters (%d > %d), unable to print.",
814 cupsArrayCount(filters
), MAX_FILTERS
);
816 abort_message
= "Aborting job because it needs too many filters to print.";
817 abort_state
= IPP_JOB_ABORTED
;
819 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
825 * Determine if we are printing a banner page or not...
828 if (job
->job_sheets
== NULL
)
830 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "No job-sheets attribute.");
831 if ((job
->job_sheets
=
832 ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_ZERO
)) != NULL
)
833 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
834 "... but someone added one without setting job_sheets.");
836 else if (job
->job_sheets
->num_values
== 1)
837 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s",
838 job
->job_sheets
->values
[0].string
.text
);
840 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s,%s",
841 job
->job_sheets
->values
[0].string
.text
,
842 job
->job_sheets
->values
[1].string
.text
);
844 if (job
->printer
->type
& CUPS_PRINTER_REMOTE
)
846 else if (job
->job_sheets
== NULL
)
848 else if (_cups_strcasecmp(job
->job_sheets
->values
[0].string
.text
, "none") != 0 &&
849 job
->current_file
== 0)
851 else if (job
->job_sheets
->num_values
> 1 &&
852 _cups_strcasecmp(job
->job_sheets
->values
[1].string
.text
, "none") != 0 &&
853 job
->current_file
== (job
->num_files
- 1))
858 if ((options
= get_options(job
, banner_page
, copies
, sizeof(copies
), title
,
859 sizeof(title
))) == NULL
)
861 abort_message
= "Stopping job because the scheduler ran out of memory.";
867 * Build the command-line arguments for the filters. Each filter
868 * has 6 or 7 arguments:
876 * argv[6] = filename (optional; normally stdin)
878 * This allows legacy printer drivers that use the old System V
879 * printing interface to be used by CUPS.
881 * For remote jobs, we send all of the files in the argument list.
884 if (job
->printer
->remote
)
885 argc
= 6 + job
->num_files
;
889 if ((argv
= calloc((size_t)argc
+ 1, sizeof(char *))) == NULL
)
891 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Unable to allocate argument array - %s",
894 abort_message
= "Stopping job because the scheduler ran out of memory.";
899 sprintf(jobid
, "%d", job
->id
);
901 argv
[0] = job
->printer
->name
;
903 argv
[2] = job
->username
;
908 if (job
->printer
->remote
&& job
->num_files
> 1)
910 for (i
= 0; i
< job
->num_files
; i
++)
912 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
914 argv
[6 + i
] = strdup(filename
);
919 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
920 job
->id
, job
->current_file
+ 1);
921 argv
[6] = strdup(filename
);
924 for (i
= 0; argv
[i
]; i
++)
925 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "argv[%d]=\"%s\"", i
, argv
[i
]);
928 * Create environment variable strings for the filters...
931 attr
= ippFindAttribute(job
->attrs
, "attributes-natural-language",
935 strlcpy(apple_language
, "APPLE_LANGUAGE=", sizeof(apple_language
));
936 _cupsAppleLanguage(attr
->values
[0].string
.text
,
937 apple_language
+ 15, sizeof(apple_language
) - 15);
938 #endif /* __APPLE__ */
940 switch (strlen(attr
->values
[0].string
.text
))
944 * This is an unknown or badly formatted language code; use
945 * the POSIX locale...
948 strlcpy(lang
, "LANG=C", sizeof(lang
));
953 * Just the language code (ll)...
956 snprintf(lang
, sizeof(lang
), "LANG=%s.UTF-8",
957 attr
->values
[0].string
.text
);
962 * Language and country code (ll-cc)...
965 snprintf(lang
, sizeof(lang
), "LANG=%c%c_%c%c.UTF-8",
966 attr
->values
[0].string
.text
[0],
967 attr
->values
[0].string
.text
[1],
968 toupper(attr
->values
[0].string
.text
[3] & 255),
969 toupper(attr
->values
[0].string
.text
[4] & 255));
973 if ((attr
= ippFindAttribute(job
->attrs
, "document-format",
974 IPP_TAG_MIMETYPE
)) != NULL
&&
975 (ptr
= strstr(attr
->values
[0].string
.text
, "charset=")) != NULL
)
976 snprintf(charset
, sizeof(charset
), "CHARSET=%s", ptr
+ 8);
978 strlcpy(charset
, "CHARSET=utf-8", sizeof(charset
));
980 snprintf(content_type
, sizeof(content_type
), "CONTENT_TYPE=%s/%s",
981 job
->filetypes
[job
->current_file
]->super
,
982 job
->filetypes
[job
->current_file
]->type
);
983 snprintf(device_uri
, sizeof(device_uri
), "DEVICE_URI=%s",
984 job
->printer
->device_uri
);
985 snprintf(ppd
, sizeof(ppd
), "PPD=%s/ppd/%s.ppd", ServerRoot
,
987 snprintf(printer_info
, sizeof(printer_name
), "PRINTER_INFO=%s",
988 job
->printer
->info
? job
->printer
->info
: "");
989 snprintf(printer_location
, sizeof(printer_name
), "PRINTER_LOCATION=%s",
990 job
->printer
->location
? job
->printer
->location
: "");
991 snprintf(printer_name
, sizeof(printer_name
), "PRINTER=%s", job
->printer
->name
);
992 if (job
->printer
->num_reasons
> 0)
994 char *psrptr
; /* Pointer into PRINTER_STATE_REASONS */
995 size_t psrlen
; /* Size of PRINTER_STATE_REASONS */
997 for (psrlen
= 22, i
= 0; i
< job
->printer
->num_reasons
; i
++)
998 psrlen
+= strlen(job
->printer
->reasons
[i
]) + 1;
1000 if ((printer_state_reasons
= malloc(psrlen
)) != NULL
)
1003 * All of these strcpy's are safe because we allocated the psr string...
1006 strlcpy(printer_state_reasons
, "PRINTER_STATE_REASONS=", psrlen
);
1007 for (psrptr
= printer_state_reasons
+ 22, i
= 0;
1008 i
< job
->printer
->num_reasons
;
1013 strlcpy(psrptr
, job
->printer
->reasons
[i
], psrlen
- (size_t)(psrptr
- printer_state_reasons
));
1014 psrptr
+= strlen(psrptr
);
1018 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
1020 if (job
->printer
->num_auth_info_required
== 1)
1021 snprintf(auth_info_required
, sizeof(auth_info_required
),
1022 "AUTH_INFO_REQUIRED=%s",
1023 job
->printer
->auth_info_required
[0]);
1024 else if (job
->printer
->num_auth_info_required
== 2)
1025 snprintf(auth_info_required
, sizeof(auth_info_required
),
1026 "AUTH_INFO_REQUIRED=%s,%s",
1027 job
->printer
->auth_info_required
[0],
1028 job
->printer
->auth_info_required
[1]);
1029 else if (job
->printer
->num_auth_info_required
== 3)
1030 snprintf(auth_info_required
, sizeof(auth_info_required
),
1031 "AUTH_INFO_REQUIRED=%s,%s,%s",
1032 job
->printer
->auth_info_required
[0],
1033 job
->printer
->auth_info_required
[1],
1034 job
->printer
->auth_info_required
[2]);
1035 else if (job
->printer
->num_auth_info_required
== 4)
1036 snprintf(auth_info_required
, sizeof(auth_info_required
),
1037 "AUTH_INFO_REQUIRED=%s,%s,%s,%s",
1038 job
->printer
->auth_info_required
[0],
1039 job
->printer
->auth_info_required
[1],
1040 job
->printer
->auth_info_required
[2],
1041 job
->printer
->auth_info_required
[3]);
1043 strlcpy(auth_info_required
, "AUTH_INFO_REQUIRED=none",
1044 sizeof(auth_info_required
));
1046 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
1048 envp
[envc
++] = charset
;
1049 envp
[envc
++] = lang
;
1051 envp
[envc
++] = apple_language
;
1052 #endif /* __APPLE__ */
1053 envp
[envc
++] = ppd
;
1054 envp
[envc
++] = rip_max_cache
;
1055 envp
[envc
++] = content_type
;
1056 envp
[envc
++] = device_uri
;
1057 envp
[envc
++] = printer_info
;
1058 envp
[envc
++] = printer_location
;
1059 envp
[envc
++] = printer_name
;
1060 envp
[envc
++] = printer_state_reasons
? printer_state_reasons
:
1061 "PRINTER_STATE_REASONS=none";
1062 envp
[envc
++] = banner_page
? "CUPS_FILETYPE=job-sheet" :
1063 "CUPS_FILETYPE=document";
1065 if (final_content_type
[0])
1066 envp
[envc
++] = final_content_type
;
1068 if (Classification
&& !banner_page
)
1070 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
1071 IPP_TAG_NAME
)) == NULL
)
1072 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1074 else if (attr
->num_values
> 1 &&
1075 strcmp(attr
->values
[1].string
.text
, "none") != 0)
1076 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1077 attr
->values
[1].string
.text
);
1079 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1080 attr
->values
[0].string
.text
);
1082 envp
[envc
++] = classification
;
1085 if (job
->dtype
& CUPS_PRINTER_CLASS
)
1087 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
1088 envp
[envc
++] = class_name
;
1091 envp
[envc
++] = auth_info_required
;
1094 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1096 if (job
->auth_env
[i
])
1097 envp
[envc
++] = job
->auth_env
[i
];
1102 envp
[envc
++] = job
->auth_uid
;
1106 for (i
= 0; i
< envc
; i
++)
1107 if (!strncmp(envp
[i
], "AUTH_", 5))
1108 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"AUTH_%c****\"", i
,
1110 else if (strncmp(envp
[i
], "DEVICE_URI=", 11))
1111 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"%s\"", i
, envp
[i
]);
1113 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"DEVICE_URI=%s\"", i
,
1114 job
->printer
->sanitized_device_uri
);
1116 if (job
->printer
->remote
)
1117 job
->current_file
= job
->num_files
;
1119 job
->current_file
++;
1122 * Now create processes for all of the filters...
1125 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
1127 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
1129 if (filter
->filter
[0] != '/')
1130 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
1133 strlcpy(command
, filter
->filter
, sizeof(command
));
1135 if (i
< (cupsArrayCount(filters
) - 1))
1137 if (cupsdOpenPipe(filterfds
[slot
]))
1139 abort_message
= "Stopping job because the scheduler could not create "
1140 "the filter pipes.";
1147 if (job
->current_file
== 1 ||
1148 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1150 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1152 if (cupsdOpenPipe(job
->print_pipes
))
1154 abort_message
= "Stopping job because the scheduler could not "
1155 "create the backend pipes.";
1162 job
->print_pipes
[0] = -1;
1163 if (!strcmp(job
->printer
->device_uri
, "file:/dev/null") ||
1164 !strcmp(job
->printer
->device_uri
, "file:///dev/null"))
1165 job
->print_pipes
[1] = -1;
1168 if (!strncmp(job
->printer
->device_uri
, "file:/dev/", 10))
1169 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1171 else if (!strncmp(job
->printer
->device_uri
, "file:///dev/", 12))
1172 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1174 else if (!strncmp(job
->printer
->device_uri
, "file:///", 8))
1175 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1176 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1178 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1179 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1181 if (job
->print_pipes
[1] < 0)
1183 abort_message
= "Stopping job because the scheduler could not "
1184 "open the output file.";
1189 fcntl(job
->print_pipes
[1], F_SETFD
,
1190 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
1195 filterfds
[slot
][0] = job
->print_pipes
[0];
1196 filterfds
[slot
][1] = job
->print_pipes
[1];
1199 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1200 filterfds
[slot
][1], job
->status_pipes
[1],
1201 job
->back_pipes
[0], job
->side_pipes
[0], 0,
1202 job
->profile
, job
, job
->filters
+ i
);
1204 cupsdClosePipe(filterfds
[!slot
]);
1208 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
1209 filter
->filter
, strerror(errno
));
1211 abort_message
= "Stopping job because the scheduler could not execute a "
1217 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started filter %s (PID %d)", command
,
1229 cupsArrayDelete(filters
);
1233 * Finally, pipe the final output into a backend process if needed...
1236 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1238 if (job
->current_file
== 1 || job
->printer
->remote
||
1239 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1241 sscanf(job
->printer
->device_uri
, "%254[^:]", scheme
);
1242 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, scheme
);
1245 * See if the backend needs to run as root...
1250 else if (stat(command
, &backinfo
))
1253 backroot
= !(backinfo
.st_mode
& (S_IWGRP
| S_IRWXO
));
1255 argv
[0] = job
->printer
->sanitized_device_uri
;
1257 filterfds
[slot
][0] = -1;
1258 filterfds
[slot
][1] = -1;
1260 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1261 filterfds
[slot
][1], job
->status_pipes
[1],
1262 job
->back_pipes
[1], job
->side_pipes
[1],
1263 backroot
, job
->bprofile
, job
, &(job
->backend
));
1267 abort_message
= "Stopping job because the sheduler could not execute "
1274 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started backend %s (PID %d)",
1279 if (job
->current_file
== job
->num_files
||
1280 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1281 cupsdClosePipe(job
->print_pipes
);
1283 if (job
->current_file
== job
->num_files
)
1285 cupsdClosePipe(job
->back_pipes
);
1286 cupsdClosePipe(job
->side_pipes
);
1288 close(job
->status_pipes
[1]);
1289 job
->status_pipes
[1] = -1;
1294 filterfds
[slot
][0] = -1;
1295 filterfds
[slot
][1] = -1;
1297 if (job
->current_file
== job
->num_files
||
1298 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1299 cupsdClosePipe(job
->print_pipes
);
1301 if (job
->current_file
== job
->num_files
)
1303 close(job
->status_pipes
[1]);
1304 job
->status_pipes
[1] = -1;
1308 cupsdClosePipe(filterfds
[slot
]);
1310 for (i
= 6; i
< argc
; i
++)
1316 if (printer_state_reasons
)
1317 free(printer_state_reasons
);
1319 cupsdAddSelect(job
->status_buffer
->fd
, (cupsd_selfunc_t
)update_job
, NULL
,
1322 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
1329 * If we get here, we need to abort the current job and close out all
1330 * files and pipes...
1335 FilterLevel
-= job
->cost
;
1338 for (slot
= 0; slot
< 2; slot
++)
1339 cupsdClosePipe(filterfds
[slot
]);
1341 cupsArrayDelete(filters
);
1345 for (i
= 6; i
< argc
; i
++)
1350 if (printer_state_reasons
)
1351 free(printer_state_reasons
);
1353 cupsdClosePipe(job
->print_pipes
);
1354 cupsdClosePipe(job
->back_pipes
);
1355 cupsdClosePipe(job
->side_pipes
);
1357 cupsdRemoveSelect(job
->status_pipes
[0]);
1358 cupsdClosePipe(job
->status_pipes
);
1359 cupsdStatBufDelete(job
->status_buffer
);
1360 job
->status_buffer
= NULL
;
1363 * Update the printer and job state.
1366 cupsdSetJobState(job
, abort_state
, CUPSD_JOB_DEFAULT
, "%s", abort_message
);
1367 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_IDLE
, 0);
1368 update_job_attrs(job
, 0);
1371 free_job_history(job
);
1373 cupsArrayRemove(PrintingJobs
, job
);
1376 * Clear the printer <-> job association...
1379 job
->printer
->job
= NULL
;
1380 job
->printer
= NULL
;
1385 * 'cupsdDeleteJob()' - Free all memory used by a job.
1389 cupsdDeleteJob(cupsd_job_t
*job
, /* I - Job */
1390 cupsd_jobaction_t action
)/* I - Action */
1392 int i
; /* Looping var */
1396 finalize_job(job
, 1);
1398 if (action
== CUPSD_JOB_PURGE
)
1399 remove_job_history(job
);
1401 cupsdClearString(&job
->username
);
1402 cupsdClearString(&job
->dest
);
1404 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1406 cupsdClearString(job
->auth_env
+ i
);
1407 cupsdClearString(&job
->auth_uid
);
1409 if (action
== CUPSD_JOB_PURGE
)
1410 remove_job_files(job
);
1411 else if (job
->num_files
> 0)
1413 free(job
->compressions
);
1414 free(job
->filetypes
);
1420 free_job_history(job
);
1424 cupsArrayRemove(Jobs
, job
);
1425 cupsArrayRemove(ActiveJobs
, job
);
1426 cupsArrayRemove(PrintingJobs
, job
);
1433 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1437 cupsdFreeAllJobs(void)
1439 cupsd_job_t
*job
; /* Current job */
1447 cupsdStopAllJobs(CUPSD_JOB_FORCE
, 0);
1450 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1452 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1453 cupsdDeleteJob(job
, CUPSD_JOB_DEFAULT
);
1455 cupsdReleaseSignals();
1460 * 'cupsdFindJob()' - Find the specified job.
1463 cupsd_job_t
* /* O - Job data */
1464 cupsdFindJob(int id
) /* I - Job ID */
1466 cupsd_job_t key
; /* Search key */
1471 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
1476 * 'cupsdGetCompletedJobs()'- Generate a completed jobs list.
1479 cups_array_t
* /* O - Array of jobs */
1480 cupsdGetCompletedJobs(
1481 cupsd_printer_t
*p
) /* I - Printer */
1483 cups_array_t
*list
; /* Array of jobs */
1484 cupsd_job_t
*job
; /* Current job */
1487 list
= cupsArrayNew(compare_completed_jobs
, NULL
);
1489 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1491 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1492 if ((!p
|| !_cups_strcasecmp(p
->name
, job
->dest
)) && job
->state_value
>= IPP_JOB_STOPPED
&& job
->completed_time
)
1493 cupsArrayAdd(list
, job
);
1500 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1501 * or held jobs in a printer or class.
1504 int /* O - Job count */
1505 cupsdGetPrinterJobCount(
1506 const char *dest
) /* I - Printer or class name */
1508 int count
; /* Job count */
1509 cupsd_job_t
*job
; /* Current job */
1512 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1514 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1515 if (job
->dest
&& !_cups_strcasecmp(job
->dest
, dest
))
1523 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1524 * or held jobs for a user.
1527 int /* O - Job count */
1528 cupsdGetUserJobCount(
1529 const char *username
) /* I - Username */
1531 int count
; /* Job count */
1532 cupsd_job_t
*job
; /* Current job */
1535 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1537 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1538 if (!_cups_strcasecmp(job
->username
, username
))
1546 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1550 cupsdLoadAllJobs(void)
1552 char filename
[1024]; /* Full filename of job.cache file */
1553 struct stat fileinfo
; /* Information on job.cache file */
1554 cups_dir_t
*dir
; /* RequestRoot dir */
1555 cups_dentry_t
*dent
; /* Entry in RequestRoot */
1556 int load_cache
= 1; /* Load the job.cache file? */
1560 * Create the job arrays as needed...
1564 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1567 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1570 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1573 * See whether the job.cache file is older than the RequestRoot directory...
1576 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1578 if (stat(filename
, &fileinfo
))
1581 * No job.cache file...
1586 if (errno
!= ENOENT
)
1587 cupsdLogMessage(CUPSD_LOG_ERROR
,
1588 "Unable to get file information for \"%s\" - %s",
1589 filename
, strerror(errno
));
1591 else if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
1594 * No spool directory...
1601 while ((dent
= cupsDirRead(dir
)) != NULL
)
1603 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c' && dent
->fileinfo
.st_mtime
> fileinfo
.st_mtime
)
1606 * Job history file is newer than job.cache file...
1618 * Load the most recent source for job data...
1624 * Load the job.cache file...
1627 load_job_cache(filename
);
1632 * Load the job history files...
1635 load_request_root();
1637 load_next_job_id(filename
);
1641 * Clean out old jobs as needed...
1644 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1650 * 'cupsdLoadJob()' - Load a single job.
1653 int /* O - 1 on success, 0 on failure */
1654 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1656 int i
; /* Looping var */
1657 char jobfile
[1024]; /* Job filename */
1658 cups_file_t
*fp
; /* Job file */
1659 int fileid
; /* Current file ID */
1660 ipp_attribute_t
*attr
; /* Job attribute */
1661 const char *dest
; /* Destination name */
1662 cupsd_printer_t
*destptr
; /* Pointer to destination */
1663 mime_type_t
**filetypes
; /* New filetypes array */
1664 int *compressions
; /* New compressions array */
1669 if (job
->state_value
> IPP_JOB_STOPPED
)
1670 job
->access_time
= time(NULL
);
1675 if ((job
->attrs
= ippNew()) == NULL
)
1677 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes.");
1682 * Load job attributes...
1685 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading attributes...");
1687 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1688 if ((fp
= cupsdOpenConfFile(jobfile
)) == NULL
)
1691 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1693 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1694 "Unable to read job control file \"%s\".", jobfile
);
1702 * Copy attribute data to the job object...
1705 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1707 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1708 "Missing or bad time-at-creation attribute in control file.");
1712 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1713 IPP_TAG_ENUM
)) == NULL
)
1715 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1716 "Missing or bad job-state attribute in control file.");
1720 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1722 job
->history_time
= 0;
1724 if ((attr
= ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
)) != NULL
)
1725 job
->creation_time
= attr
->values
[0].integer
;
1727 if (job
->state_value
>= IPP_JOB_CANCELED
&& (attr
= ippFindAttribute(job
->attrs
, "time-at-completed", IPP_TAG_INTEGER
)) != NULL
)
1729 job
->completed_time
= attr
->values
[0].integer
;
1731 if (JobHistory
< INT_MAX
)
1732 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
1734 job
->history_time
= INT_MAX
;
1736 if (job
->history_time
< time(NULL
))
1737 goto error
; /* Expired, remove from history */
1739 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1740 JobHistoryUpdate
= job
->history_time
;
1742 if (JobFiles
< INT_MAX
)
1743 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
1745 job
->file_time
= INT_MAX
;
1747 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "cupsdLoadJob: job->file_time=%ld, time-at-completed=%ld, JobFiles=%d", (long)job
->file_time
, (long)attr
->values
[0].integer
, JobFiles
);
1749 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1750 JobHistoryUpdate
= job
->file_time
;
1752 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdLoadJob: JobHistoryUpdate=%ld",
1753 (long)JobHistoryUpdate
);
1758 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1759 IPP_TAG_URI
)) == NULL
)
1761 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1762 "No job-printer-uri attribute in control file.");
1766 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1769 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1770 "Unable to queue job for destination \"%s\".",
1771 attr
->values
[0].string
.text
);
1775 cupsdSetString(&job
->dest
, dest
);
1777 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1779 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1780 "Unable to queue job for destination \"%s\".",
1785 if ((job
->reasons
= ippFindAttribute(job
->attrs
, "job-state-reasons",
1786 IPP_TAG_KEYWORD
)) == NULL
)
1788 const char *reason
; /* job-state-reason keyword */
1790 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1791 "Adding missing job-state-reasons attribute to control file.");
1793 switch (job
->state_value
)
1796 case IPP_JOB_PENDING
:
1797 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1798 reason
= "printer-stopped";
1804 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1805 IPP_TAG_ZERO
)) != NULL
&&
1806 (attr
->value_tag
== IPP_TAG_NAME
||
1807 attr
->value_tag
== IPP_TAG_NAMELANG
||
1808 attr
->value_tag
== IPP_TAG_KEYWORD
) &&
1809 strcmp(attr
->values
[0].string
.text
, "no-hold"))
1810 reason
= "job-hold-until-specified";
1812 reason
= "job-incoming";
1815 case IPP_JOB_PROCESSING
:
1816 reason
= "job-printing";
1819 case IPP_JOB_STOPPED
:
1820 reason
= "job-stopped";
1823 case IPP_JOB_CANCELED
:
1824 reason
= "job-canceled-by-user";
1827 case IPP_JOB_ABORTED
:
1828 reason
= "aborted-by-system";
1831 case IPP_JOB_COMPLETED
:
1832 reason
= "job-completed-successfully";
1836 job
->reasons
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
1837 "job-state-reasons", NULL
, reason
);
1839 else if (job
->state_value
== IPP_JOB_PENDING
)
1841 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1842 ippSetString(job
->attrs
, &job
->reasons
, 0, "printer-stopped");
1844 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
1847 job
->impressions
= ippFindAttribute(job
->attrs
, "job-impressions-completed", IPP_TAG_INTEGER
);
1848 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed", IPP_TAG_INTEGER
);
1849 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1851 if (!job
->impressions
)
1852 job
->impressions
= ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-impressions-completed", 0);
1854 job
->sheets
= ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-media-sheets-completed", 0);
1858 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1859 IPP_TAG_INTEGER
)) == NULL
)
1861 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1862 "Missing or bad job-priority attribute in control file.");
1866 job
->priority
= attr
->values
[0].integer
;
1871 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1872 IPP_TAG_NAME
)) == NULL
)
1874 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1875 "Missing or bad job-originating-user-name "
1876 "attribute in control file.");
1880 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1885 if ((attr
= ippFindAttribute(job
->attrs
, "job-name", IPP_TAG_NAME
)) != NULL
)
1886 cupsdSetString(&job
->name
, attr
->values
[0].string
.text
);
1890 * Set the job hold-until time and state...
1893 if (job
->state_value
== IPP_JOB_HELD
)
1895 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1896 IPP_TAG_KEYWORD
)) == NULL
)
1897 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1900 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1903 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1904 job
->state_value
= IPP_JOB_PENDING
;
1907 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1909 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1910 job
->state_value
= IPP_JOB_PENDING
;
1913 if ((attr
= ippFindAttribute(job
->attrs
, "job-k-octets", IPP_TAG_INTEGER
)) != NULL
)
1914 job
->koctets
= attr
->values
[0].integer
;
1916 if (!job
->num_files
)
1919 * Find all the d##### files...
1922 for (fileid
= 1; fileid
< 10000; fileid
++)
1924 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1927 if (access(jobfile
, 0))
1930 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1931 "Auto-typing document file \"%s\"...", jobfile
);
1933 if (fileid
> job
->num_files
)
1935 if (job
->num_files
== 0)
1937 compressions
= (int *)calloc((size_t)fileid
, sizeof(int));
1938 filetypes
= (mime_type_t
**)calloc((size_t)fileid
, sizeof(mime_type_t
*));
1942 compressions
= (int *)realloc(job
->compressions
, sizeof(int) * (size_t)fileid
);
1943 filetypes
= (mime_type_t
**)realloc(job
->filetypes
, sizeof(mime_type_t
*) * (size_t)fileid
);
1947 job
->compressions
= compressions
;
1950 job
->filetypes
= filetypes
;
1952 if (!compressions
|| !filetypes
)
1954 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1955 "Ran out of memory for job file types.");
1957 ippDelete(job
->attrs
);
1960 if (job
->compressions
)
1962 free(job
->compressions
);
1963 job
->compressions
= NULL
;
1968 free(job
->filetypes
);
1969 job
->filetypes
= NULL
;
1976 job
->num_files
= fileid
;
1979 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1980 job
->compressions
+ fileid
- 1);
1982 if (!job
->filetypes
[fileid
- 1])
1983 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1989 * Load authentication information as needed...
1992 if (job
->state_value
< IPP_JOB_STOPPED
)
1994 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1997 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1999 cupsdClearString(job
->auth_env
+ i
);
2000 cupsdClearString(&job
->auth_uid
);
2002 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
2004 int bytes
, /* Size of auth data */
2005 linenum
= 1; /* Current line number */
2006 char line
[65536], /* Line from file */
2007 *value
, /* Value from line */
2008 data
[65536]; /* Decoded data */
2011 if (cupsFileGets(fp
, line
, sizeof(line
)) &&
2012 !strcmp(line
, "CUPSD-AUTH-V3"))
2015 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
2021 if (strcmp(line
, "negotiate") && strcmp(line
, "uid"))
2023 bytes
= sizeof(data
);
2024 httpDecode64_2(data
, &bytes
, value
);
2028 * Assign environment variables...
2031 if (!strcmp(line
, "uid"))
2033 cupsdSetStringf(&job
->auth_uid
, "AUTH_UID=%s", value
);
2036 else if (i
>= (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0])))
2039 if (!strcmp(line
, "username"))
2040 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_USERNAME=%s", data
);
2041 else if (!strcmp(line
, "domain"))
2042 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_DOMAIN=%s", data
);
2043 else if (!strcmp(line
, "password"))
2044 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_PASSWORD=%s", data
);
2045 else if (!strcmp(line
, "negotiate"))
2046 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_NEGOTIATE=%s", value
);
2058 job
->access_time
= time(NULL
);
2062 * If we get here then something bad happened...
2067 ippDelete(job
->attrs
);
2070 remove_job_history(job
);
2071 remove_job_files(job
);
2078 * 'cupsdMoveJob()' - Move the specified job to a different destination.
2082 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
2083 cupsd_printer_t
*p
) /* I - Destination printer or class */
2085 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
2086 const char *olddest
; /* Old destination */
2087 cupsd_printer_t
*oldp
; /* Old pointer */
2091 * Don't move completed jobs...
2094 if (job
->state_value
> IPP_JOB_STOPPED
)
2098 * Get the old destination...
2101 olddest
= job
->dest
;
2104 oldp
= job
->printer
;
2106 oldp
= cupsdFindDest(olddest
);
2109 * Change the destination information...
2112 if (job
->state_value
> IPP_JOB_HELD
)
2113 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2114 "Stopping job prior to move.");
2116 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
2117 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2120 cupsdSetString(&job
->dest
, p
->name
);
2121 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
);
2123 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
2124 IPP_TAG_URI
)) != NULL
)
2125 ippSetString(job
->attrs
, &attr
, 0, p
->uri
);
2127 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
2128 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2132 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2137 * 'cupsdReleaseJob()' - Release the specified job.
2141 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
2143 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
2146 if (job
->state_value
== IPP_JOB_HELD
)
2149 * Add trailing banner as needed...
2152 if (job
->pending_timeout
)
2153 cupsdTimeoutJob(job
);
2155 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2156 "Job released by user.");
2162 * 'cupsdRestartJob()' - Restart the specified job.
2166 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
2168 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
2171 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
2172 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2173 "Job restarted by user.");
2178 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2182 cupsdSaveAllJobs(void)
2184 int i
; /* Looping var */
2185 cups_file_t
*fp
; /* job.cache file */
2186 char filename
[1024], /* job.cache filename */
2187 temp
[1024]; /* Temporary string */
2188 cupsd_job_t
*job
; /* Current job */
2189 time_t curtime
; /* Current time */
2190 struct tm
*curdate
; /* Current date */
2193 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
2194 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
)) == NULL
)
2197 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job.cache...");
2200 * Write a small header to the file...
2203 curtime
= time(NULL
);
2204 curdate
= localtime(&curtime
);
2205 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
2207 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
2208 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
2209 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
2212 * Write each job known to the system...
2215 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2217 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2219 if (job
->printer
&& job
->printer
->temporary
)
2222 * Don't save jobs on temporary printers...
2228 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
2229 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
2230 cupsFilePrintf(fp
, "Created %ld\n", (long)job
->creation_time
);
2231 if (job
->completed_time
)
2232 cupsFilePrintf(fp
, "Completed %ld\n", (long)job
->completed_time
);
2233 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
2234 if (job
->hold_until
)
2235 cupsFilePrintf(fp
, "HoldUntil %ld\n", (long)job
->hold_until
);
2236 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
2238 cupsFilePutConf(fp
, "Name", job
->name
);
2239 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
2240 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
2241 cupsFilePrintf(fp
, "KOctets %d\n", job
->koctets
);
2242 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
2243 for (i
= 0; i
< job
->num_files
; i
++)
2244 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
2245 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
2246 cupsFilePuts(fp
, "</Job>\n");
2249 cupsdCloseCreatedConfFile(fp
, filename
);
2254 * 'cupsdSaveJob()' - Save a job to disk.
2258 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
2260 char filename
[1024]; /* Job control filename */
2261 cups_file_t
*fp
; /* Job file */
2264 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2265 job
, job
->id
, job
->attrs
);
2267 if (job
->printer
&& job
->printer
->temporary
)
2270 * Don't save jobs on temporary printers...
2277 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
2279 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
& 0600)) == NULL
)
2282 fchown(cupsFileNumber(fp
), RunUser
, Group
);
2284 job
->attrs
->state
= IPP_IDLE
;
2286 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
2287 job
->attrs
) != IPP_DATA
)
2289 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to write job control file.");
2294 if (!cupsdCloseCreatedConfFile(fp
, filename
))
2297 * Remove backup file and mark this job as clean...
2300 strlcat(filename
, ".O", sizeof(filename
));
2309 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2313 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
2314 const char *when
, /* I - When to resume */
2315 int update
)/* I - Update job-hold-until attr? */
2317 time_t curtime
; /* Current time */
2318 struct tm
*curdate
; /* Current date */
2319 int hour
; /* Hold hour */
2320 int minute
; /* Hold minute */
2321 int second
= 0; /* Hold second */
2324 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2325 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2326 job
, job
->id
, when
, update
);
2331 * Update the job-hold-until attribute...
2334 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2336 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2337 IPP_TAG_KEYWORD
)) == NULL
)
2338 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2341 ippSetString(job
->attrs
, &attr
, 0, when
);
2343 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2344 "job-hold-until", NULL
, when
);
2348 if (isdigit(when
[0] & 255))
2349 attr
->value_tag
= IPP_TAG_NAME
;
2351 attr
->value_tag
= IPP_TAG_KEYWORD
;
2354 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2359 if (strcmp(when
, "no-hold"))
2360 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-hold-until-specified");
2362 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
2365 * Update the hold time...
2368 job
->cancel_time
= 0;
2370 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2373 * Hold indefinitely...
2376 job
->hold_until
= 0;
2378 if (MaxHoldTime
> 0)
2379 job
->cancel_time
= time(NULL
) + MaxHoldTime
;
2381 else if (!strcmp(when
, "day-time"))
2384 * Hold to 6am the next morning unless local time is < 6pm.
2387 curtime
= time(NULL
);
2388 curdate
= localtime(&curtime
);
2390 if (curdate
->tm_hour
< 18)
2391 job
->hold_until
= curtime
;
2393 job
->hold_until
= curtime
+
2394 ((29 - curdate
->tm_hour
) * 60 + 59 -
2395 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2397 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2400 * Hold to 6pm unless local time is > 6pm or < 6am.
2403 curtime
= time(NULL
);
2404 curdate
= localtime(&curtime
);
2406 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2407 job
->hold_until
= curtime
;
2409 job
->hold_until
= curtime
+
2410 ((17 - curdate
->tm_hour
) * 60 + 59 -
2411 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2413 else if (!strcmp(when
, "second-shift"))
2416 * Hold to 4pm unless local time is > 4pm.
2419 curtime
= time(NULL
);
2420 curdate
= localtime(&curtime
);
2422 if (curdate
->tm_hour
>= 16)
2423 job
->hold_until
= curtime
;
2425 job
->hold_until
= curtime
+
2426 ((15 - curdate
->tm_hour
) * 60 + 59 -
2427 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2429 else if (!strcmp(when
, "third-shift"))
2432 * Hold to 12am unless local time is < 8am.
2435 curtime
= time(NULL
);
2436 curdate
= localtime(&curtime
);
2438 if (curdate
->tm_hour
< 8)
2439 job
->hold_until
= curtime
;
2441 job
->hold_until
= curtime
+
2442 ((23 - curdate
->tm_hour
) * 60 + 59 -
2443 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2445 else if (!strcmp(when
, "weekend"))
2448 * Hold to weekend unless we are in the weekend.
2451 curtime
= time(NULL
);
2452 curdate
= localtime(&curtime
);
2454 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2455 job
->hold_until
= curtime
;
2457 job
->hold_until
= curtime
+
2458 (((5 - curdate
->tm_wday
) * 24 +
2459 (17 - curdate
->tm_hour
)) * 60 + 59 -
2460 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2462 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2465 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2468 curtime
= time(NULL
);
2469 curdate
= gmtime(&curtime
);
2471 job
->hold_until
= curtime
+
2472 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2473 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2476 * Hold until next day as needed...
2479 if (job
->hold_until
< curtime
)
2480 job
->hold_until
+= 24 * 60 * 60;
2483 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2484 (int)job
->hold_until
);
2489 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2490 * the list as needed.
2494 cupsdSetJobPriority(
2495 cupsd_job_t
*job
, /* I - Job ID */
2496 int priority
) /* I - New priority (0 to 100) */
2498 ipp_attribute_t
*attr
; /* Job attribute */
2502 * Don't change completed jobs...
2505 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2509 * Set the new priority and re-add the job into the active list...
2512 cupsArrayRemove(ActiveJobs
, job
);
2514 job
->priority
= priority
;
2516 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2517 IPP_TAG_INTEGER
)) != NULL
)
2518 attr
->values
[0].integer
= priority
;
2520 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2523 cupsArrayAdd(ActiveJobs
, job
);
2526 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2531 * 'cupsdSetJobState()' - Set the state of the specified print job.
2536 cupsd_job_t
*job
, /* I - Job to cancel */
2537 ipp_jstate_t newstate
, /* I - New job state */
2538 cupsd_jobaction_t action
, /* I - Action to take */
2539 const char *message
, /* I - Message to log */
2540 ...) /* I - Additional arguments as needed */
2542 int i
; /* Looping var */
2543 ipp_jstate_t oldstate
; /* Old state */
2544 char filename
[1024]; /* Job filename */
2545 ipp_attribute_t
*attr
; /* Job attribute */
2548 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2549 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2550 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2551 newstate
, action
, message
? message
: "(null)");
2555 * Make sure we have the job attributes...
2558 if (!cupsdLoadJob(job
))
2562 * Don't do anything if the state is unchanged and we aren't purging the
2566 oldstate
= job
->state_value
;
2567 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2571 * Stop any processes that are working on the current job...
2574 if (oldstate
== IPP_JOB_PROCESSING
)
2575 stop_job(job
, action
);
2578 * Set the new job state...
2581 job
->state_value
= newstate
;
2584 job
->state
->values
[0].integer
= newstate
;
2588 case IPP_JOB_PENDING
:
2590 * Update job-hold-until as needed...
2593 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2594 IPP_TAG_KEYWORD
)) == NULL
)
2595 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2599 ippSetValueTag(job
->attrs
, &attr
, IPP_TAG_KEYWORD
);
2600 ippSetString(job
->attrs
, &attr
, 0, "no-hold");
2606 case IPP_JOB_ABORTED
:
2607 case IPP_JOB_CANCELED
:
2608 case IPP_JOB_COMPLETED
:
2609 set_time(job
, "time-at-completed");
2610 ippSetString(job
->attrs
, &job
->reasons
, 0, "processing-to-stop-point");
2615 * Log message as needed...
2620 char buffer
[2048]; /* Message buffer */
2621 va_list ap
; /* Pointer to additional arguments */
2623 va_start(ap
, message
);
2624 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2627 if (newstate
> IPP_JOB_STOPPED
)
2628 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2630 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2632 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2633 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2635 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2639 * Handle post-state-change actions...
2644 case IPP_JOB_PROCESSING
:
2646 * Add the job to the "printing" list...
2649 if (!cupsArrayFind(PrintingJobs
, job
))
2650 cupsArrayAdd(PrintingJobs
, job
);
2653 * Set the processing time...
2656 set_time(job
, "time-at-processing");
2658 case IPP_JOB_PENDING
:
2660 case IPP_JOB_STOPPED
:
2662 * Make sure the job is in the active list...
2665 if (!cupsArrayFind(ActiveJobs
, job
))
2666 cupsArrayAdd(ActiveJobs
, job
);
2669 * Save the job state to disk...
2673 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2676 case IPP_JOB_ABORTED
:
2677 case IPP_JOB_CANCELED
:
2678 case IPP_JOB_COMPLETED
:
2679 if (newstate
== IPP_JOB_CANCELED
)
2682 * Remove the job from the active list if there are no processes still
2686 for (i
= 0; job
->filters
[i
] < 0; i
++);
2688 if (!job
->filters
[i
] && job
->backend
<= 0)
2689 cupsArrayRemove(ActiveJobs
, job
);
2694 * Otherwise just remove the job from the active list immediately...
2697 cupsArrayRemove(ActiveJobs
, job
);
2701 * Expire job subscriptions since the job is now "completed"...
2704 cupsdExpireSubscriptions(NULL
, job
);
2708 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2709 * sleep to happen immediately...
2712 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2714 #endif /* __APPLE__ */
2717 * Remove any authentication data...
2720 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2721 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2722 cupsdLogMessage(CUPSD_LOG_ERROR
,
2723 "Unable to remove authentication cache: %s",
2727 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
2729 cupsdClearString(job
->auth_env
+ i
);
2731 cupsdClearString(&job
->auth_uid
);
2734 * Remove the print file for good if we aren't preserving jobs or
2738 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2739 remove_job_files(job
);
2741 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2744 * Save job state info...
2748 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2750 else if (!job
->printer
)
2753 * Delete the job immediately if not actively printing...
2756 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2763 * Finalize the job immediately if we forced things...
2766 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2767 finalize_job(job
, 0);
2770 * Update the server "busy" state...
2773 cupsdSetBusyState(0);
2778 * 'cupsdStopAllJobs()' - Stop all print jobs.
2783 cupsd_jobaction_t action
, /* I - Action */
2784 int kill_delay
) /* I - Number of seconds before we kill */
2786 cupsd_job_t
*job
; /* Current job */
2789 DEBUG_puts("cupsdStopAllJobs()");
2791 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2793 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2797 cupsdSetJobState(job
, IPP_JOB_COMPLETED
, CUPSD_JOB_FORCE
, NULL
);
2802 job
->kill_time
= time(NULL
) + kill_delay
;
2804 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2811 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2815 cupsdUnloadCompletedJobs(void)
2817 cupsd_job_t
*job
; /* Current job */
2818 time_t expire
; /* Expiration time */
2821 expire
= time(NULL
) - 60;
2823 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2825 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2826 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2827 job
->access_time
< expire
)
2839 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2843 cupsdUpdateJobs(void)
2845 cupsd_job_t
*job
; /* Current job */
2846 time_t curtime
; /* Current time */
2847 ipp_attribute_t
*attr
; /* time-at-completed attribute */
2850 curtime
= time(NULL
);
2851 JobHistoryUpdate
= 0;
2853 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2855 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2857 if (job
->state_value
>= IPP_JOB_CANCELED
&&
2858 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
2859 IPP_TAG_INTEGER
)) != NULL
)
2862 * Update history/file expiration times...
2865 if (JobHistory
< INT_MAX
)
2866 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
2868 job
->history_time
= INT_MAX
;
2870 if (job
->history_time
< curtime
)
2872 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2876 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2877 JobHistoryUpdate
= job
->history_time
;
2879 if (JobFiles
< INT_MAX
)
2880 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
2882 job
->file_time
= INT_MAX
;
2884 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "cupsdUpdateJobs: job->file_time=%ld, time-at-completed=%ld, JobFiles=%d", (long)job
->file_time
, (long)attr
->values
[0].integer
, JobFiles
);
2886 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2887 JobHistoryUpdate
= job
->file_time
;
2891 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdUpdateJobs: JobHistoryUpdate=%ld",
2892 (long)JobHistoryUpdate
);
2897 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2900 static int /* O - Difference */
2901 compare_active_jobs(void *first
, /* I - First job */
2902 void *second
, /* I - Second job */
2903 void *data
) /* I - App data (not used) */
2905 int diff
; /* Difference */
2910 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2911 ((cupsd_job_t
*)first
)->priority
) != 0)
2914 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2919 * 'compare_completed_jobs()' - Compare the job IDs and completion times of two jobs.
2922 static int /* O - Difference */
2923 compare_completed_jobs(void *first
, /* I - First job */
2924 void *second
, /* I - Second job */
2925 void *data
) /* I - App data (not used) */
2927 int diff
; /* Difference */
2932 if ((diff
= ((cupsd_job_t
*)second
)->completed_time
-
2933 ((cupsd_job_t
*)first
)->completed_time
) != 0)
2936 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2941 * 'compare_jobs()' - Compare the job IDs of two jobs.
2944 static int /* O - Difference */
2945 compare_jobs(void *first
, /* I - First job */
2946 void *second
, /* I - Second job */
2947 void *data
) /* I - App data (not used) */
2951 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2956 * 'dump_job_history()' - Dump any debug messages for a job.
2960 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2962 int i
, /* Looping var */
2963 oldsize
; /* Current MaxLogSize */
2964 struct tm
*date
; /* Date/time value */
2965 cupsd_joblog_t
*message
; /* Current message */
2966 char temp
[2048], /* Log message */
2967 *ptr
, /* Pointer into log message */
2968 start
[256], /* Start time */
2969 end
[256]; /* End time */
2970 cupsd_printer_t
*printer
; /* Printer for job */
2974 * See if we have anything to dump...
2981 * Disable log rotation temporarily...
2984 oldsize
= MaxLogSize
;
2988 * Copy the debug messages to the log...
2991 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2992 date
= localtime(&(message
->time
));
2993 strftime(start
, sizeof(start
), "%X", date
);
2995 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2996 date
= localtime(&(message
->time
));
2997 strftime(end
, sizeof(end
), "%X", date
);
2999 snprintf(temp
, sizeof(temp
),
3000 "[Job %d] The following messages were recorded from %s to %s",
3001 job
->id
, start
, end
);
3002 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3004 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
3006 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
3007 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
3009 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
3010 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3013 * Log the printer state values...
3016 if ((printer
= job
->printer
) == NULL
)
3017 printer
= cupsdFindDest(job
->dest
);
3021 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
3023 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
3024 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
3026 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3028 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
3029 job
->id
, printer
->state_message
);
3030 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3032 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
3033 ptr
= temp
+ strlen(temp
);
3034 if (printer
->num_reasons
== 0)
3035 strlcpy(ptr
, "none", sizeof(temp
) - (size_t)(ptr
- temp
));
3039 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
3045 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (size_t)(ptr
- temp
));
3049 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3053 * Restore log file rotation...
3056 MaxLogSize
= oldsize
;
3059 * Free all messages...
3062 free_job_history(job
);
3067 * 'free_job_history()' - Free any log history.
3071 free_job_history(cupsd_job_t
*job
) /* I - Job */
3073 char *message
; /* Current message */
3079 for (message
= (char *)cupsArrayFirst(job
->history
);
3081 message
= (char *)cupsArrayNext(job
->history
))
3084 cupsArrayDelete(job
->history
);
3085 job
->history
= NULL
;
3090 * 'finalize_job()' - Cleanup after job filter processes and support data.
3094 finalize_job(cupsd_job_t
*job
, /* I - Job */
3095 int set_job_state
) /* I - 1 = set the job state */
3097 ipp_pstate_t printer_state
; /* New printer state value */
3098 ipp_jstate_t job_state
; /* New job state value */
3099 const char *message
; /* Message for job state */
3100 char buffer
[1024]; /* Buffer for formatted messages */
3103 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
3106 * Clear the "connecting-to-device" and "cups-waiting-for-job-completed"
3107 * reasons, which are only valid when a printer is processing, along with any
3108 * remote printing job state...
3111 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device,"
3112 "cups-waiting-for-job-completed,"
3113 "cups-remote-pending,"
3114 "cups-remote-pending-held,"
3115 "cups-remote-processing,"
3116 "cups-remote-stopped,"
3117 "cups-remote-canceled,"
3118 "cups-remote-aborted,"
3119 "cups-remote-completed");
3122 * Similarly, clear the "offline-report" reason for non-USB devices since we
3123 * rarely have current information for network devices...
3126 if (strncmp(job
->printer
->device_uri
, "usb:", 4) &&
3127 strncmp(job
->printer
->device_uri
, "ippusb:", 7))
3128 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
3131 * Free the security profile...
3134 cupsdDestroyProfile(job
->profile
);
3135 job
->profile
= NULL
;
3136 cupsdDestroyProfile(job
->bprofile
);
3137 job
->bprofile
= NULL
;
3140 * Clear the unresponsive job watchdog timers...
3143 job
->cancel_time
= 0;
3147 * Close pipes and status buffer...
3150 cupsdClosePipe(job
->print_pipes
);
3151 cupsdClosePipe(job
->back_pipes
);
3152 cupsdClosePipe(job
->side_pipes
);
3154 cupsdRemoveSelect(job
->status_pipes
[0]);
3155 cupsdClosePipe(job
->status_pipes
);
3156 cupsdStatBufDelete(job
->status_buffer
);
3157 job
->status_buffer
= NULL
;
3160 * Log the final impression (page) count...
3163 snprintf(buffer
, sizeof(buffer
), "total %d", ippGetInteger(job
->impressions
, 0));
3164 cupsdLogPage(job
, buffer
);
3167 * Process the exit status...
3170 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
3171 printer_state
= IPP_PRINTER_IDLE
;
3173 printer_state
= job
->printer
->state
;
3175 switch (job_state
= job
->state_value
)
3177 case IPP_JOB_PENDING
:
3178 message
= "Job paused.";
3182 message
= "Job held.";
3186 case IPP_JOB_PROCESSING
:
3187 case IPP_JOB_COMPLETED
:
3188 job_state
= IPP_JOB_COMPLETED
;
3189 message
= "Job completed.";
3192 ippSetString(job
->attrs
, &job
->reasons
, 0,
3193 "job-completed-successfully");
3196 case IPP_JOB_STOPPED
:
3197 message
= "Job stopped.";
3199 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-stopped");
3202 case IPP_JOB_CANCELED
:
3203 message
= "Job canceled.";
3205 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-canceled-by-user");
3208 case IPP_JOB_ABORTED
:
3209 message
= "Job aborted.";
3213 if (job
->status
< 0)
3216 * Backend had errors...
3219 int exit_code
; /* Exit code from backend */
3222 * Convert the status to an exit code. Due to the way the W* macros are
3223 * implemented on macOS (bug?), we have to store the exit status in a
3224 * variable first and then convert...
3227 exit_code
= -job
->status
;
3228 if (WIFEXITED(exit_code
))
3229 exit_code
= WEXITSTATUS(exit_code
);
3232 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-backend-crashed");
3233 exit_code
= job
->status
;
3236 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
3238 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
3239 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
3240 "authentication required" :
3241 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
3242 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
3243 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
3244 exit_code
== CUPS_BACKEND_RETRY
? "retry job later" :
3245 exit_code
== CUPS_BACKEND_RETRY_CURRENT
? "retry job immediately" :
3246 exit_code
< 0 ? "crashed" : "unknown");
3249 * Do what needs to be done...
3255 case CUPS_BACKEND_FAILED
:
3257 * Backend failure, use the error-policy to determine how to
3261 if (job
->dtype
& CUPS_PRINTER_CLASS
)
3264 * Queued on a class - mark the job as pending and we'll retry on
3265 * another printer...
3268 if (job_state
== IPP_JOB_COMPLETED
)
3270 job_state
= IPP_JOB_PENDING
;
3271 message
= "Retrying job on another printer.";
3273 ippSetString(job
->attrs
, &job
->reasons
, 0,
3274 "resources-are-not-ready");
3277 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
3280 * The error policy is "retry-current-job" - mark the job as pending
3281 * and we'll retry on the same printer...
3284 if (job_state
== IPP_JOB_COMPLETED
)
3286 job_state
= IPP_JOB_PENDING
;
3287 message
= "Retrying job on same printer.";
3289 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3292 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
3293 !strcmp(job
->printer
->error_policy
, "retry-job"))
3295 if (job_state
== IPP_JOB_COMPLETED
)
3298 * The job was queued on a fax or the error policy is "retry-job" -
3299 * hold the job if the number of retries is less than the
3300 * JobRetryLimit, otherwise abort the job.
3305 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3311 snprintf(buffer
, sizeof(buffer
),
3312 "Job aborted after %d unsuccessful attempts.",
3314 job_state
= IPP_JOB_ABORTED
;
3317 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3322 * Try again in N seconds...
3325 snprintf(buffer
, sizeof(buffer
),
3326 "Job held for %d seconds since it could not be sent.",
3329 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3330 job_state
= IPP_JOB_HELD
;
3333 ippSetString(job
->attrs
, &job
->reasons
, 0,
3334 "resources-are-not-ready");
3338 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
3339 job_state
== IPP_JOB_COMPLETED
)
3341 job_state
= IPP_JOB_ABORTED
;
3345 snprintf(buffer
, sizeof(buffer
), "Job aborted due to backend errors; please consult the %s file for details.", ErrorLog
);
3349 message
= "Job aborted due to backend errors.";
3351 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3353 else if (job
->state_value
== IPP_JOB_PROCESSING
)
3355 job_state
= IPP_JOB_PENDING
;
3356 printer_state
= IPP_PRINTER_STOPPED
;
3360 snprintf(buffer
, sizeof(buffer
), "Printer stopped due to backend errors; please consult the %s file for details.", ErrorLog
);
3364 message
= "Printer stopped due to backend errors.";
3366 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3370 case CUPS_BACKEND_CANCEL
:
3375 if (job_state
== IPP_JOB_COMPLETED
)
3377 job_state
= IPP_JOB_CANCELED
;
3378 message
= "Job canceled at printer.";
3380 ippSetString(job
->attrs
, &job
->reasons
, 0, "canceled-at-device");
3384 case CUPS_BACKEND_HOLD
:
3385 if (job_state
== IPP_JOB_COMPLETED
)
3391 const char *reason
= ippGetString(job
->reasons
, 0, NULL
);
3393 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-state-reasons=\"%s\"",
3396 if (!reason
|| strncmp(reason
, "account-", 8))
3398 cupsdSetJobHoldUntil(job
, "indefinite", 1);
3400 ippSetString(job
->attrs
, &job
->reasons
, 0,
3401 "job-hold-until-specified");
3405 snprintf(buffer
, sizeof(buffer
), "Job held indefinitely due to backend errors; please consult the %s file for details.", ErrorLog
);
3409 message
= "Job held indefinitely due to backend errors.";
3411 else if (!strcmp(reason
, "account-info-needed"))
3413 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3415 message
= "Job held indefinitely - account information is required.";
3417 else if (!strcmp(reason
, "account-closed"))
3419 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3421 message
= "Job held indefinitely - account has been closed.";
3423 else if (!strcmp(reason
, "account-limit-reached"))
3425 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3427 message
= "Job held indefinitely - account limit has been reached.";
3431 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3433 message
= "Job held indefinitely - account authorization failed.";
3436 job_state
= IPP_JOB_HELD
;
3440 case CUPS_BACKEND_STOP
:
3442 * Stop the printer...
3445 if (job_state
== IPP_JSTATE_CANCELED
|| job_state
== IPP_JSTATE_ABORTED
)
3447 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Ignored STOP from backend since the job is %s.", job_state
== IPP_JSTATE_CANCELED
? "canceled" : "aborted");
3451 printer_state
= IPP_PRINTER_STOPPED
;
3455 snprintf(buffer
, sizeof(buffer
), "Printer stopped due to backend errors; please consult the %s file for details.", ErrorLog
);
3459 message
= "Printer stopped due to backend errors.";
3461 if (job_state
== IPP_JOB_COMPLETED
)
3463 job_state
= IPP_JOB_PENDING
;
3465 ippSetString(job
->attrs
, &job
->reasons
, 0, "resources-are-not-ready");
3469 case CUPS_BACKEND_AUTH_REQUIRED
:
3471 * Hold the job for authentication...
3474 if (job_state
== IPP_JOB_COMPLETED
)
3476 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
3478 job_state
= IPP_JOB_HELD
;
3479 message
= "Job held for authentication.";
3481 if (strncmp(job
->reasons
->values
[0].string
.text
, "account-", 8))
3482 ippSetString(job
->attrs
, &job
->reasons
, 0,
3483 "cups-held-for-authentication");
3487 case CUPS_BACKEND_RETRY
:
3488 if (job_state
== IPP_JOB_COMPLETED
)
3491 * Hold the job if the number of retries is less than the
3492 * JobRetryLimit, otherwise abort the job.
3497 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3503 snprintf(buffer
, sizeof(buffer
),
3504 "Job aborted after %d unsuccessful attempts.",
3506 job_state
= IPP_JOB_ABORTED
;
3509 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3514 * Try again in N seconds...
3517 snprintf(buffer
, sizeof(buffer
),
3518 "Job held for %d seconds since it could not be sent.",
3521 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3522 job_state
= IPP_JOB_HELD
;
3525 ippSetString(job
->attrs
, &job
->reasons
, 0,
3526 "resources-are-not-ready");
3531 case CUPS_BACKEND_RETRY_CURRENT
:
3533 * Mark the job as pending and retry on the same printer...
3536 if (job_state
== IPP_JOB_COMPLETED
)
3538 job_state
= IPP_JOB_PENDING
;
3539 message
= "Retrying job on same printer.";
3541 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3546 else if (job
->status
> 0)
3549 * Filter had errors; stop job...
3552 if (job_state
== IPP_JOB_COMPLETED
)
3554 job_state
= IPP_JOB_STOPPED
;
3558 snprintf(buffer
, sizeof(buffer
), "Job stopped due to filter errors; please consult the %s file for details.", ErrorLog
);
3562 message
= "Job stopped due to filter errors.";
3564 if (WIFSIGNALED(job
->status
))
3565 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-filter-crashed");
3567 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-completed-with-errors");
3572 * Update the printer and job state.
3575 if (set_job_state
&& job_state
!= job
->state_value
)
3576 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
3578 cupsdSetPrinterState(job
->printer
, printer_state
,
3579 printer_state
== IPP_PRINTER_STOPPED
);
3580 update_job_attrs(job
, 0);
3585 (job
->state_value
== IPP_JOB_ABORTED
||
3586 job
->state_value
== IPP_JOB_STOPPED
))
3587 dump_job_history(job
);
3589 free_job_history(job
);
3592 cupsArrayRemove(PrintingJobs
, job
);
3595 * Clear informational messages...
3598 if (job
->status_level
> CUPSD_LOG_ERROR
)
3599 job
->printer
->state_message
[0] = '\0';
3602 * Apply any PPD updates...
3605 if (job
->num_keywords
)
3607 if (cupsdUpdatePrinterPPD(job
->printer
, job
->num_keywords
, job
->keywords
))
3608 cupsdSetPrinterAttrs(job
->printer
);
3610 cupsFreeOptions(job
->num_keywords
, job
->keywords
);
3612 job
->num_keywords
= 0;
3613 job
->keywords
= NULL
;
3617 * Clear the printer <-> job association...
3620 job
->printer
->job
= NULL
;
3621 job
->printer
= NULL
;
3626 * 'get_options()' - Get a string containing the job options.
3629 static char * /* O - Options string */
3630 get_options(cupsd_job_t
*job
, /* I - Job */
3631 int banner_page
, /* I - Printing a banner page? */
3632 char *copies
, /* I - Copies buffer */
3633 size_t copies_size
, /* I - Size of copies buffer */
3634 char *title
, /* I - Title buffer */
3635 size_t title_size
) /* I - Size of title buffer */
3637 int i
; /* Looping var */
3638 size_t newlength
; /* New option buffer length */
3639 char *optptr
, /* Pointer to options */
3640 *valptr
; /* Pointer in value string */
3641 ipp_attribute_t
*attr
; /* Current attribute */
3642 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3643 int num_pwgppds
; /* Number of PWG->PPD options */
3644 cups_option_t
*pwgppds
, /* PWG->PPD options */
3645 *pwgppd
, /* Current PWG->PPD option */
3646 *preset
; /* Current preset option */
3647 int print_color_mode
,
3648 /* Output mode (if any) */
3649 print_quality
; /* Print quality (if any) */
3650 const char *ppd
; /* PPD option choice */
3651 int exact
; /* Did we get an exact match? */
3652 static char *options
= NULL
;/* Full list of options */
3653 static size_t optlength
= 0; /* Length of option buffer */
3657 * Building the options string is harder than it needs to be, but for the
3658 * moment we need to pass strings for command-line args and not IPP attribute
3661 * First build an options array for any PWG->PPD mapped option/choice pairs.
3664 pc
= job
->printer
->pc
;
3669 !ippFindAttribute(job
->attrs
, "com.apple.print.DocumentTicket.PMSpoolFormat", IPP_TAG_ZERO
) &&
3670 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3671 (ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) || ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
) || ippFindAttribute(job
->attrs
, "cupsPrintQuality", IPP_TAG_ZERO
)))
3674 * Map print-color-mode and print-quality to a preset...
3677 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3678 IPP_TAG_KEYWORD
)) != NULL
&&
3679 !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3680 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3682 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3684 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ENUM
)) != NULL
)
3686 ipp_quality_t pq
= (ipp_quality_t
)ippGetInteger(attr
, 0);
3688 if (pq
>= IPP_QUALITY_DRAFT
&& pq
<= IPP_QUALITY_HIGH
)
3689 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3691 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3693 else if ((attr
= ippFindAttribute(job
->attrs
, "cupsPrintQuality", IPP_TAG_NAME
)) != NULL
)
3695 const char *pq
= ippGetString(attr
, 0, NULL
);
3697 if (!_cups_strcasecmp(pq
, "draft"))
3698 print_quality
= _PWG_PRINT_QUALITY_DRAFT
;
3699 else if (!_cups_strcasecmp(pq
, "high"))
3700 print_quality
= _PWG_PRINT_QUALITY_HIGH
;
3702 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3704 if (!ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ENUM
))
3706 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping cupsPrintQuality=%s to print-quality=%d", pq
, print_quality
+ IPP_QUALITY_DRAFT
);
3707 num_pwgppds
= cupsAddIntegerOption("print-quality", print_quality
+ IPP_QUALITY_DRAFT
, num_pwgppds
, &pwgppds
);
3712 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3715 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3718 * Try to find a preset that works so that we maximize the chances of us
3719 * getting a good print using IPP attributes.
3722 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3723 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3724 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3725 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3728 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3729 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3733 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3736 * Copy the preset options as long as the corresponding names are not
3737 * already defined in the IPP request...
3740 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3741 preset
= pc
->presets
[print_color_mode
][print_quality
];
3745 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3747 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Adding preset option %s=%s", preset
->name
, preset
->value
);
3749 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
, &pwgppds
);
3757 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ENUM
)) != NULL
)
3759 int pq
= ippGetInteger(attr
, 0);
3760 static const char * const pqs
[] = { "Draft", "Normal", "High" };
3762 if (pq
>= IPP_QUALITY_DRAFT
&& pq
<= IPP_QUALITY_HIGH
)
3764 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping print-quality=%d to cupsPrintQuality=%s", pq
, pqs
[pq
- IPP_QUALITY_DRAFT
]);
3766 num_pwgppds
= cupsAddOption("cupsPrintQuality", pqs
[pq
- IPP_QUALITY_DRAFT
], num_pwgppds
, &pwgppds
);
3770 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3771 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3773 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3774 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3777 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3778 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3780 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping media to MediaType=%s", ppd
);
3782 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3785 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3786 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3787 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3789 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping media to Pagesize=%s", ppd
);
3791 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3793 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3795 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Adding media=%s", ppd
);
3797 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3801 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3802 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3803 IPP_TAG_ZERO
)) != NULL
&&
3804 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3805 attr
->value_tag
== IPP_TAG_NAME
) &&
3806 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3809 * Map output-bin to OutputBin option...
3812 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping output-bin to OutputBin=%s", ppd
);
3814 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3817 if (pc
->sides_option
&&
3818 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3819 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3822 * Map sides to duplex option...
3825 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3827 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping sizes to Duplex=%s", pc
->sides_1sided
);
3829 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
, num_pwgppds
, &pwgppds
);
3831 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3833 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping sizes to Duplex=%s", pc
->sides_2sided_long
);
3835 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
, num_pwgppds
, &pwgppds
);
3837 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3839 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "Mapping sizes to Duplex=%s", pc
->sides_2sided_short
);
3841 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
, num_pwgppds
, &pwgppds
);
3846 * Map finishings values...
3849 num_pwgppds
= _ppdCacheGetFinishingOptions(pc
, job
->attrs
, IPP_FINISHINGS_NONE
, num_pwgppds
, &pwgppds
);
3851 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3852 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
, "After mapping finishings %s=%s", pwgppd
->name
, pwgppd
->value
);
3856 * Figure out how much room we need...
3859 newlength
= ipp_length(job
->attrs
);
3861 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3862 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3865 * Then allocate/reallocate the option buffer as needed...
3868 if (newlength
== 0) /* This can never happen, but Clang */
3869 newlength
= 1; /* thinks it can... */
3871 if (newlength
> optlength
|| !options
)
3874 optptr
= malloc(newlength
);
3876 optptr
= realloc(options
, newlength
);
3880 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3881 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer.",
3882 CUPS_LLCAST newlength
);
3887 optlength
= newlength
;
3891 * Now loop through the attributes and convert them to the textual
3892 * representation used by the filters...
3898 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3899 strlcpy(copies
, "1", copies_size
);
3901 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3903 if (!strcmp(attr
->name
, "copies") &&
3904 attr
->value_tag
== IPP_TAG_INTEGER
)
3907 * Don't use the # copies attribute if we are printing the job sheets...
3911 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3913 else if (!strcmp(attr
->name
, "job-name") &&
3914 (attr
->value_tag
== IPP_TAG_NAME
||
3915 attr
->value_tag
== IPP_TAG_NAMELANG
))
3916 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3917 else if (attr
->group_tag
== IPP_TAG_JOB
)
3920 * Filter out other unwanted attributes...
3923 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3924 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3925 attr
->value_tag
== IPP_TAG_NAMELANG
||
3926 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3927 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid") &&
3928 strcmp(attr
->name
, "job-authorization-uri")) ||
3929 attr
->value_tag
== IPP_TAG_URISCHEME
||
3930 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3933 if (!strcmp(attr
->name
, "job-hold-until") ||
3934 !strcmp(attr
->name
, "job-id") ||
3935 !strcmp(attr
->name
, "job-k-octets") ||
3936 !strcmp(attr
->name
, "job-media-sheets") ||
3937 !strcmp(attr
->name
, "job-media-sheets-completed") ||
3938 !strcmp(attr
->name
, "job-state") ||
3939 !strcmp(attr
->name
, "job-state-reasons"))
3942 if (!strncmp(attr
->name
, "job-", 4) &&
3943 strcmp(attr
->name
, "job-account-id") &&
3944 strcmp(attr
->name
, "job-accounting-user-id") &&
3945 strcmp(attr
->name
, "job-authorization-uri") &&
3946 strcmp(attr
->name
, "job-billing") &&
3947 strcmp(attr
->name
, "job-impressions") &&
3948 strcmp(attr
->name
, "job-originating-host-name") &&
3949 strcmp(attr
->name
, "job-password") &&
3950 strcmp(attr
->name
, "job-password-encryption") &&
3951 strcmp(attr
->name
, "job-uuid") &&
3952 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3955 if ((!strcmp(attr
->name
, "job-impressions") ||
3956 !strcmp(attr
->name
, "page-label") ||
3957 !strcmp(attr
->name
, "page-border") ||
3958 !strncmp(attr
->name
, "number-up", 9) ||
3959 !strcmp(attr
->name
, "page-ranges") ||
3960 !strcmp(attr
->name
, "page-set") ||
3961 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3962 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3963 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3964 "PMTotalSidesImaged..n.") ||
3965 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3966 "PMTotalBeginPages..n.")) &&
3971 * Otherwise add them to the list...
3974 if (optptr
> options
)
3975 strlcat(optptr
, " ", optlength
- (size_t)(optptr
- options
));
3977 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3979 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
3980 strlcat(optptr
, "=", optlength
- (size_t)(optptr
- options
));
3983 for (i
= 0; i
< attr
->num_values
; i
++)
3986 strlcat(optptr
, ",", optlength
- (size_t)(optptr
- options
));
3988 optptr
+= strlen(optptr
);
3990 switch (attr
->value_tag
)
3992 case IPP_TAG_INTEGER
:
3994 snprintf(optptr
, optlength
- (size_t)(optptr
- options
),
3995 "%d", attr
->values
[i
].integer
);
3998 case IPP_TAG_BOOLEAN
:
3999 if (!attr
->values
[i
].boolean
)
4000 strlcat(optptr
, "no", optlength
- (size_t)(optptr
- options
));
4002 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
4005 case IPP_TAG_RANGE
:
4006 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
4007 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
4008 "%d", attr
->values
[i
].range
.lower
);
4010 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
4011 "%d-%d", attr
->values
[i
].range
.lower
,
4012 attr
->values
[i
].range
.upper
);
4015 case IPP_TAG_RESOLUTION
:
4016 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
4017 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
4018 attr
->values
[i
].resolution
.yres
,
4019 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
4023 case IPP_TAG_STRING
:
4026 case IPP_TAG_KEYWORD
:
4027 case IPP_TAG_CHARSET
:
4028 case IPP_TAG_LANGUAGE
:
4030 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
4032 if (strchr(" \t\n\\\'\"", *valptr
))
4034 *optptr
++ = *valptr
++;
4041 break; /* anti-compiler-warning-code */
4045 optptr
+= strlen(optptr
);
4050 * Finally loop through the PWG->PPD mapped options and add them...
4053 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
4056 strlcpy(optptr
, pwgppd
->name
, optlength
- (size_t)(optptr
- options
));
4057 optptr
+= strlen(optptr
);
4059 strlcpy(optptr
, pwgppd
->value
, optlength
- (size_t)(optptr
- options
));
4060 optptr
+= strlen(optptr
);
4063 cupsFreeOptions(num_pwgppds
, pwgppds
);
4066 * Return the options string...
4074 * 'ipp_length()' - Compute the size of the buffer needed to hold
4075 * the textual IPP attributes.
4078 static size_t /* O - Size of attribute buffer */
4079 ipp_length(ipp_t
*ipp
) /* I - IPP request */
4081 size_t bytes
; /* Number of bytes */
4082 int i
; /* Looping var */
4083 ipp_attribute_t
*attr
; /* Current attribute */
4087 * Loop through all attributes...
4092 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
4095 * Skip attributes that won't be sent to filters...
4098 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
4099 attr
->value_tag
== IPP_TAG_MIMETYPE
||
4100 attr
->value_tag
== IPP_TAG_NAMELANG
||
4101 attr
->value_tag
== IPP_TAG_TEXTLANG
||
4102 attr
->value_tag
== IPP_TAG_URI
||
4103 attr
->value_tag
== IPP_TAG_URISCHEME
)
4107 * Add space for a leading space and commas between each value.
4108 * For the first attribute, the leading space isn't used, so the
4109 * extra byte can be used as the nul terminator...
4112 bytes
++; /* " " separator */
4113 bytes
+= (size_t)attr
->num_values
; /* "," separators */
4116 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
4117 * other attributes appear as "foo=value1,value2,...,valueN".
4120 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
4121 bytes
+= strlen(attr
->name
);
4123 bytes
+= (size_t)attr
->num_values
* strlen(attr
->name
);
4126 * Now add the size required for each value in the attribute...
4129 switch (attr
->value_tag
)
4131 case IPP_TAG_INTEGER
:
4134 * Minimum value of a signed integer is -2147483647, or 11 digits.
4137 bytes
+= (size_t)attr
->num_values
* 11;
4140 case IPP_TAG_BOOLEAN
:
4142 * Add two bytes for each false ("no") value...
4145 for (i
= 0; i
< attr
->num_values
; i
++)
4146 if (!attr
->values
[i
].boolean
)
4150 case IPP_TAG_RANGE
:
4152 * A range is two signed integers separated by a hyphen, or
4153 * 23 characters max.
4156 bytes
+= (size_t)attr
->num_values
* 23;
4159 case IPP_TAG_RESOLUTION
:
4161 * A resolution is two signed integers separated by an "x" and
4162 * suffixed by the units, or 26 characters max.
4165 bytes
+= (size_t)attr
->num_values
* 26;
4168 case IPP_TAG_STRING
:
4171 case IPP_TAG_KEYWORD
:
4172 case IPP_TAG_CHARSET
:
4173 case IPP_TAG_LANGUAGE
:
4176 * Strings can contain characters that need quoting. We need
4177 * at least 2 * len + 2 characters to cover the quotes and
4178 * any backslashes in the string.
4181 for (i
= 0; i
< attr
->num_values
; i
++)
4182 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
4186 break; /* anti-compiler-warning-code */
4195 * 'load_job_cache()' - Load jobs from the job.cache file.
4199 load_job_cache(const char *filename
) /* I - job.cache filename */
4201 cups_file_t
*fp
; /* job.cache file */
4202 char line
[1024], /* Line buffer */
4203 *value
; /* Value on line */
4204 int linenum
; /* Line number in file */
4205 cupsd_job_t
*job
; /* Current job */
4206 int jobid
; /* Job ID */
4207 char jobfile
[1024]; /* Job filename */
4211 * Open the job.cache file...
4214 if ((fp
= cupsdOpenConfFile(filename
)) == NULL
)
4216 load_request_root();
4221 * Read entries from the job cache file and create jobs as needed.
4224 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
4230 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4232 if (!_cups_strcasecmp(line
, "NextJobId"))
4235 NextJobId
= atoi(value
);
4237 else if (!_cups_strcasecmp(line
, "<Job"))
4241 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d of %s.", linenum
, filename
);
4247 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d of %s.", linenum
, filename
);
4251 jobid
= atoi(value
);
4255 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d of %s.", jobid
, linenum
, filename
);
4259 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
4260 if (access(jobfile
, 0))
4262 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d.N", RequestRoot
, jobid
);
4263 if (access(jobfile
, 0))
4265 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away.",
4269 * job.cache file is out-of-date compared to spool directory; load
4274 load_request_root();
4279 job
= calloc(1, sizeof(cupsd_job_t
));
4282 cupsdLogMessage(CUPSD_LOG_EMERG
,
4283 "[Job %d] Unable to allocate memory for job.", jobid
);
4288 job
->back_pipes
[0] = -1;
4289 job
->back_pipes
[1] = -1;
4290 job
->print_pipes
[0] = -1;
4291 job
->print_pipes
[1] = -1;
4292 job
->side_pipes
[0] = -1;
4293 job
->side_pipes
[1] = -1;
4294 job
->status_pipes
[0] = -1;
4295 job
->status_pipes
[1] = -1;
4297 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading from cache...");
4301 cupsdLogMessage(CUPSD_LOG_ERROR
,
4302 "Missing <Job #> directive on line %d of %s.", linenum
, filename
);
4305 else if (!_cups_strcasecmp(line
, "</Job>"))
4307 cupsArrayAdd(Jobs
, job
);
4309 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
4310 cupsArrayAdd(ActiveJobs
, job
);
4311 else if (job
->state_value
> IPP_JOB_STOPPED
)
4313 if (!job
->completed_time
|| !job
->creation_time
|| !job
->name
|| !job
->koctets
)
4324 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d of %s.", linenum
, filename
);
4327 else if (!_cups_strcasecmp(line
, "State"))
4329 job
->state_value
= (ipp_jstate_t
)atoi(value
);
4331 if (job
->state_value
< IPP_JOB_PENDING
)
4332 job
->state_value
= IPP_JOB_PENDING
;
4333 else if (job
->state_value
> IPP_JOB_COMPLETED
)
4334 job
->state_value
= IPP_JOB_COMPLETED
;
4336 else if (!_cups_strcasecmp(line
, "Name"))
4338 cupsdSetString(&(job
->name
), value
);
4340 else if (!_cups_strcasecmp(line
, "Created"))
4342 job
->creation_time
= strtol(value
, NULL
, 10);
4344 else if (!_cups_strcasecmp(line
, "Completed"))
4346 job
->completed_time
= strtol(value
, NULL
, 10);
4348 else if (!_cups_strcasecmp(line
, "HoldUntil"))
4350 job
->hold_until
= strtol(value
, NULL
, 10);
4352 else if (!_cups_strcasecmp(line
, "Priority"))
4354 job
->priority
= atoi(value
);
4356 else if (!_cups_strcasecmp(line
, "Username"))
4358 cupsdSetString(&job
->username
, value
);
4360 else if (!_cups_strcasecmp(line
, "Destination"))
4362 cupsdSetString(&job
->dest
, value
);
4364 else if (!_cups_strcasecmp(line
, "DestType"))
4366 job
->dtype
= (cups_ptype_t
)atoi(value
);
4368 else if (!_cups_strcasecmp(line
, "KOctets"))
4370 job
->koctets
= atoi(value
);
4372 else if (!_cups_strcasecmp(line
, "NumFiles"))
4374 job
->num_files
= atoi(value
);
4376 if (job
->num_files
< 0)
4378 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d of %s.", job
->num_files
, linenum
, filename
);
4383 if (job
->num_files
> 0)
4385 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
4387 if (access(jobfile
, 0))
4389 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Data files have gone away.");
4394 job
->filetypes
= calloc((size_t)job
->num_files
, sizeof(mime_type_t
*));
4395 job
->compressions
= calloc((size_t)job
->num_files
, sizeof(int));
4397 if (!job
->filetypes
|| !job
->compressions
)
4399 cupsdLogJob(job
, CUPSD_LOG_EMERG
,
4400 "Unable to allocate memory for %d files.",
4406 else if (!_cups_strcasecmp(line
, "File"))
4408 int number
, /* File number */
4409 compression
; /* Compression value */
4410 char super
[MIME_MAX_SUPER
], /* MIME super type */
4411 type
[MIME_MAX_TYPE
]; /* MIME type */
4414 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
4417 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d of %s.", linenum
, filename
);
4421 if (number
< 1 || number
> job
->num_files
)
4423 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d of %s.", number
, linenum
, filename
);
4429 job
->compressions
[number
] = compression
;
4430 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
4432 if (!job
->filetypes
[number
])
4435 * If the original MIME type is unknown, auto-type it!
4438 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
4439 "Unknown MIME type %s/%s for file %d.",
4440 super
, type
, number
+ 1);
4442 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
4443 job
->id
, number
+ 1);
4444 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
4445 job
->compressions
+ number
);
4448 * If that didn't work, assume it is raw...
4451 if (!job
->filetypes
[number
])
4452 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
4457 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d of %s.", line
, linenum
, filename
);
4462 cupsdLogMessage(CUPSD_LOG_ERROR
,
4463 "Missing </Job> directive on line %d of %s.", linenum
, filename
);
4464 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
4472 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4476 load_next_job_id(const char *filename
) /* I - job.cache filename */
4478 cups_file_t
*fp
; /* job.cache file */
4479 char line
[1024], /* Line buffer */
4480 *value
; /* Value on line */
4481 int linenum
; /* Line number in file */
4482 int next_job_id
; /* NextJobId value from line */
4486 * Read the NextJobId directive from the job.cache file and use
4487 * the value (if any).
4490 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4492 if (errno
!= ENOENT
)
4493 cupsdLogMessage(CUPSD_LOG_ERROR
,
4494 "Unable to open job cache file \"%s\": %s",
4495 filename
, strerror(errno
));
4500 cupsdLogMessage(CUPSD_LOG_INFO
,
4501 "Loading NextJobId from job cache file \"%s\"...", filename
);
4505 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4507 if (!_cups_strcasecmp(line
, "NextJobId"))
4511 next_job_id
= atoi(value
);
4513 if (next_job_id
> NextJobId
)
4514 NextJobId
= next_job_id
;
4525 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4529 load_request_root(void)
4531 cups_dir_t
*dir
; /* Directory */
4532 cups_dentry_t
*dent
; /* Directory entry */
4533 cupsd_job_t
*job
; /* New job */
4537 * Open the requests directory...
4540 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
4542 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
4544 cupsdLogMessage(CUPSD_LOG_ERROR
,
4545 "Unable to open spool directory \"%s\": %s",
4546 RequestRoot
, strerror(errno
));
4551 * Read all the c##### files...
4554 while ((dent
= cupsDirRead(dir
)) != NULL
)
4555 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
4558 * Allocate memory for the job...
4561 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
4563 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs.");
4569 * Assign the job ID...
4572 job
->id
= atoi(dent
->filename
+ 1);
4573 job
->back_pipes
[0] = -1;
4574 job
->back_pipes
[1] = -1;
4575 job
->print_pipes
[0] = -1;
4576 job
->print_pipes
[1] = -1;
4577 job
->side_pipes
[0] = -1;
4578 job
->side_pipes
[1] = -1;
4579 job
->status_pipes
[0] = -1;
4580 job
->status_pipes
[1] = -1;
4582 if (job
->id
>= NextJobId
)
4583 NextJobId
= job
->id
+ 1;
4589 if (cupsdLoadJob(job
))
4592 * Insert the job into the array, sorting by job priority and ID...
4595 cupsArrayAdd(Jobs
, job
);
4597 if (job
->state_value
<= IPP_JOB_STOPPED
)
4598 cupsArrayAdd(ActiveJobs
, job
);
4611 * 'remove_job_files()' - Remove the document files for a job.
4615 remove_job_files(cupsd_job_t
*job
) /* I - Job */
4617 int i
; /* Looping var */
4618 char filename
[1024]; /* Document filename */
4621 if (job
->num_files
<= 0)
4624 for (i
= 1; i
<= job
->num_files
; i
++)
4626 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
4628 cupsdUnlinkOrRemoveFile(filename
);
4631 free(job
->filetypes
);
4632 free(job
->compressions
);
4636 job
->filetypes
= NULL
;
4637 job
->compressions
= NULL
;
4639 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4644 * 'remove_job_history()' - Remove the control file for a job.
4648 remove_job_history(cupsd_job_t
*job
) /* I - Job */
4650 char filename
[1024]; /* Control filename */
4654 * Remove the job info file...
4657 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
4659 cupsdUnlinkOrRemoveFile(filename
);
4661 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4666 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4670 set_time(cupsd_job_t
*job
, /* I - Job to update */
4671 const char *name
) /* I - Name of attribute */
4673 char date_name
[128]; /* date-time-at-xxx */
4674 ipp_attribute_t
*attr
; /* Time attribute */
4675 time_t curtime
; /* Current time */
4678 curtime
= time(NULL
);
4680 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s=%ld", name
, (long)curtime
);
4682 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
4684 attr
->value_tag
= IPP_TAG_INTEGER
;
4685 attr
->values
[0].integer
= curtime
;
4688 snprintf(date_name
, sizeof(date_name
), "date-%s", name
);
4690 if ((attr
= ippFindAttribute(job
->attrs
, date_name
, IPP_TAG_ZERO
)) != NULL
)
4692 attr
->value_tag
= IPP_TAG_DATE
;
4693 ippSetDate(job
->attrs
, &attr
, 0, ippTimeToDate(curtime
));
4696 if (!strcmp(name
, "time-at-completed"))
4698 job
->completed_time
= curtime
;
4700 if (JobHistory
< INT_MAX
&& attr
)
4701 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
4703 job
->history_time
= INT_MAX
;
4705 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4706 JobHistoryUpdate
= job
->history_time
;
4708 if (JobFiles
< INT_MAX
&& attr
)
4709 job
->file_time
= curtime
+ JobFiles
;
4711 job
->file_time
= INT_MAX
;
4713 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4714 JobHistoryUpdate
= job
->file_time
;
4716 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "set_time: JobHistoryUpdate=%ld",
4717 (long)JobHistoryUpdate
);
4723 * 'start_job()' - Start a print job.
4727 start_job(cupsd_job_t
*job
, /* I - Job ID */
4728 cupsd_printer_t
*printer
) /* I - Printer to print job */
4730 const char *filename
; /* Support filename */
4731 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
4734 /* job-cancel-after attribute */
4737 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
4738 job
, job
->id
, printer
, printer
->name
);
4741 * Make sure we have some files around before we try to print...
4744 if (job
->num_files
== 0)
4746 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
4747 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
4748 "Aborting job because it has no files.");
4753 * Update the printer and job state to "processing"...
4756 if (!cupsdLoadJob(job
))
4759 if (!job
->printer_message
)
4760 job
->printer_message
= ippFindAttribute(job
->attrs
,
4761 "job-printer-state-message",
4763 if (job
->printer_message
)
4764 ippSetString(job
->attrs
, &job
->printer_message
, 0, "");
4766 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-printing");
4767 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
4768 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
4769 cupsdSetPrinterReasons(printer
, "-cups-remote-pending,"
4770 "cups-remote-pending-held,"
4771 "cups-remote-processing,"
4772 "cups-remote-stopped,"
4773 "cups-remote-canceled,"
4774 "cups-remote-aborted,"
4775 "cups-remote-completed");
4778 job
->current_file
= 0;
4780 job
->history_time
= 0;
4782 job
->printer
= printer
;
4786 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
4787 else if (MaxJobTime
> 0)
4788 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4790 job
->cancel_time
= 0;
4793 * Check for support files...
4796 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
4797 "cups-insecure-filter-warning");
4801 for (filename
= (const char *)cupsArrayFirst(printer
->pc
->support_files
);
4803 filename
= (const char *)cupsArrayNext(printer
->pc
->support_files
))
4805 if (_cupsFileCheck(filename
, _CUPS_FILE_CHECK_FILE
, !RunUser
,
4806 cupsdLogFCMessage
, printer
))
4812 * Setup the last exit status and security profiles...
4816 job
->profile
= cupsdCreateProfile(job
->id
, 0);
4817 job
->bprofile
= cupsdCreateProfile(job
->id
, 1);
4819 #ifdef HAVE_SANDBOX_H
4820 if ((!job
->profile
|| !job
->bprofile
) && UseSandboxing
&& Sandboxing
!= CUPSD_SANDBOXING_OFF
)
4823 * Failure to create the sandbox profile means something really bad has
4824 * happened and we need to shutdown immediately.
4829 #endif /* HAVE_SANDBOX_H */
4832 * Create the status pipes and buffer...
4835 if (cupsdOpenPipe(job
->status_pipes
))
4837 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4838 "Unable to create job status pipes - %s.", strerror(errno
));
4840 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4841 "Job stopped because the scheduler could not create the "
4842 "job status pipes.");
4844 cupsdDestroyProfile(job
->profile
);
4845 job
->profile
= NULL
;
4846 cupsdDestroyProfile(job
->bprofile
);
4847 job
->bprofile
= NULL
;
4851 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
4852 job
->status_level
= CUPSD_LOG_INFO
;
4855 * Create the backchannel pipes and make them non-blocking...
4858 if (cupsdOpenPipe(job
->back_pipes
))
4860 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4861 "Unable to create back-channel pipes - %s.", strerror(errno
));
4863 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4864 "Job stopped because the scheduler could not create the "
4865 "back-channel pipes.");
4867 cupsdClosePipe(job
->status_pipes
);
4868 cupsdStatBufDelete(job
->status_buffer
);
4869 job
->status_buffer
= NULL
;
4871 cupsdDestroyProfile(job
->profile
);
4872 job
->profile
= NULL
;
4873 cupsdDestroyProfile(job
->bprofile
);
4874 job
->bprofile
= NULL
;
4878 fcntl(job
->back_pipes
[0], F_SETFL
,
4879 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4880 fcntl(job
->back_pipes
[1], F_SETFL
,
4881 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4884 * Create the side-channel pipes and make them non-blocking...
4887 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4889 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4890 "Unable to create side-channel pipes - %s.", strerror(errno
));
4892 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4893 "Job stopped because the scheduler could not create the "
4894 "side-channel pipes.");
4896 cupsdClosePipe(job
->back_pipes
);
4898 cupsdClosePipe(job
->status_pipes
);
4899 cupsdStatBufDelete(job
->status_buffer
);
4900 job
->status_buffer
= NULL
;
4902 cupsdDestroyProfile(job
->profile
);
4903 job
->profile
= NULL
;
4904 cupsdDestroyProfile(job
->bprofile
);
4905 job
->bprofile
= NULL
;
4909 fcntl(job
->side_pipes
[0], F_SETFL
,
4910 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4911 fcntl(job
->side_pipes
[1], F_SETFL
,
4912 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4914 fcntl(job
->side_pipes
[0], F_SETFD
,
4915 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4916 fcntl(job
->side_pipes
[1], F_SETFD
,
4917 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4920 * Now start the first file in the job...
4923 cupsdContinueJob(job
);
4928 * 'stop_job()' - Stop a print job.
4932 stop_job(cupsd_job_t
*job
, /* I - Job */
4933 cupsd_jobaction_t action
) /* I - Action */
4935 int i
; /* Looping var */
4938 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4941 FilterLevel
-= job
->cost
;
4944 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
&& job
->backend
> 0)
4945 job
->kill_time
= time(NULL
) + JobKillDelay
;
4946 else if (action
>= CUPSD_JOB_FORCE
)
4949 for (i
= 0; job
->filters
[i
]; i
++)
4950 if (job
->filters
[i
] > 0)
4952 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
4954 if (action
>= CUPSD_JOB_FORCE
)
4955 job
->filters
[i
] = -job
->filters
[i
];
4958 if (job
->backend
> 0)
4960 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
4962 if (action
>= CUPSD_JOB_FORCE
)
4963 job
->backend
= -job
->backend
;
4966 if (action
>= CUPSD_JOB_FORCE
)
4969 * Clear job status...
4978 * 'unload_job()' - Unload a job from memory.
4982 unload_job(cupsd_job_t
*job
) /* I - Job */
4987 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Unloading...");
4989 ippDelete(job
->attrs
);
4993 job
->reasons
= NULL
;
4994 job
->impressions
= NULL
;
4996 job
->job_sheets
= NULL
;
4997 job
->printer_message
= NULL
;
4998 job
->printer_reasons
= NULL
;
5003 * 'update_job()' - Read a status update from a job's filters.
5007 update_job(cupsd_job_t
*job
) /* I - Job to check */
5009 int i
; /* Looping var */
5010 char message
[CUPSD_SB_BUFFER_SIZE
],
5012 *ptr
; /* Pointer update... */
5013 int loglevel
, /* Log level for message */
5014 event
= 0; /* Events? */
5015 cupsd_printer_t
*printer
= job
->printer
;
5017 static const char * const levels
[] = /* Log levels */
5033 * Get the printer associated with this job; if the printer is stopped for
5034 * any reason then job->printer will be reset to NULL, so make sure we have
5035 * a valid pointer...
5038 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
5039 message
, sizeof(message
))) != NULL
)
5042 * Process page and printer state messages as needed...
5045 if (loglevel
== CUPSD_LOG_PAGE
)
5047 int impressions
= ippGetInteger(job
->impressions
, 0);
5048 /* Number of impressions printed */
5049 int delta
; /* Number of impressions added */
5052 * Page message; send the message to the page_log file and update the
5053 * job sheet count...
5056 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
5058 if (!_cups_strncasecmp(message
, "total ", 6))
5061 * Got a total count of pages from a backend or filter...
5064 int total
= atoi(message
+ 6); /* Total impressions */
5066 if (total
> impressions
)
5068 delta
= total
- impressions
;
5069 impressions
= total
;
5077 * Add the number of copies to the impression count...
5080 int copies
; /* Number of copies */
5082 if (!sscanf(message
, "%*d%d", &copies
) || copies
<= 0)
5086 impressions
+= copies
;
5089 if (job
->impressions
)
5090 ippSetInteger(job
->attrs
, &job
->impressions
, 0, impressions
);
5094 const char *sides
= ippGetString(ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
), 0, NULL
);
5096 if (sides
&& strcmp(sides
, "one-sided"))
5097 ippSetInteger(job
->attrs
, &job
->sheets
, 0, impressions
/ 2);
5099 ippSetInteger(job
->attrs
, &job
->sheets
, 0, impressions
);
5101 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
, "Printed %d page(s).", ippGetInteger(job
->sheets
, 0));
5105 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5107 if (job
->printer
->page_limit
)
5108 cupsdUpdateQuota(job
->printer
, job
->username
, delta
, 0);
5110 else if (loglevel
== CUPSD_LOG_JOBSTATE
)
5113 * Support "keyword" to set job-state-reasons to the specified keyword.
5114 * This is sufficient for the current paid printing stuff.
5117 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "JOBSTATE: %s", message
);
5119 if (!strcmp(message
, "cups-retry-as-raster"))
5120 job
->retry_as_raster
= 1;
5122 ippSetString(job
->attrs
, &job
->reasons
, 0, message
);
5124 else if (loglevel
== CUPSD_LOG_STATE
)
5126 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
5128 if (!strcmp(message
, "paused"))
5130 cupsdStopPrinter(job
->printer
, 1);
5133 else if (message
[0] && cupsdSetPrinterReasons(job
->printer
, message
))
5135 event
|= CUPSD_EVENT_PRINTER_STATE
;
5140 * Reset cancel time after connecting to the device...
5143 for (i
= 0; i
< job
->printer
->num_reasons
; i
++)
5144 if (!strcmp(job
->printer
->reasons
[i
], "connecting-to-device"))
5147 if (i
>= job
->printer
->num_reasons
)
5149 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
5152 /* job-cancel-after attribute */
5155 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
5156 else if (MaxJobTime
> 0)
5157 job
->cancel_time
= time(NULL
) + MaxJobTime
;
5159 job
->cancel_time
= 0;
5164 update_job_attrs(job
, 0);
5166 else if (loglevel
== CUPSD_LOG_ATTR
)
5169 * Set attribute(s)...
5172 int num_attrs
; /* Number of attributes */
5173 cups_option_t
*attrs
; /* Attributes */
5174 const char *attr
; /* Attribute */
5176 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
5178 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
5180 if ((attr
= cupsGetOption("auth-info-default", num_attrs
,
5183 job
->printer
->num_options
= cupsAddOption("auth-info", attr
,
5184 job
->printer
->num_options
,
5185 &(job
->printer
->options
));
5186 cupsdSetPrinterAttrs(job
->printer
);
5188 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5191 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
5194 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
5195 cupsdSetPrinterAttrs(job
->printer
);
5197 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5200 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
5203 int progress
= atoi(attr
);
5206 if (progress
>= 0 && progress
<= 100)
5208 job
->progress
= progress
;
5211 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5212 "Printing page %d, %d%%",
5213 job
->sheets
->values
[0].integer
, job
->progress
);
5217 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
5219 cupsdSetString(&job
->printer
->alert
, attr
);
5220 event
|= CUPSD_EVENT_PRINTER_STATE
;
5223 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
5226 cupsdSetString(&job
->printer
->alert_description
, attr
);
5227 event
|= CUPSD_EVENT_PRINTER_STATE
;
5230 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
5232 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
5233 job
->printer
->marker_time
= time(NULL
);
5234 event
|= CUPSD_EVENT_PRINTER_STATE
;
5235 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5238 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
5240 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
5241 job
->printer
->marker_time
= time(NULL
);
5242 event
|= CUPSD_EVENT_PRINTER_STATE
;
5243 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5246 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
5248 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
5249 job
->printer
->marker_time
= time(NULL
);
5250 event
|= CUPSD_EVENT_PRINTER_STATE
;
5251 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5254 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
5256 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
5257 job
->printer
->marker_time
= time(NULL
);
5258 event
|= CUPSD_EVENT_PRINTER_STATE
;
5259 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5262 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
5264 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
5265 job
->printer
->marker_time
= time(NULL
);
5266 event
|= CUPSD_EVENT_PRINTER_STATE
;
5267 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5270 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
5272 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
5273 job
->printer
->marker_time
= time(NULL
);
5274 event
|= CUPSD_EVENT_PRINTER_STATE
;
5275 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5278 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
5280 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
5281 job
->printer
->marker_time
= time(NULL
);
5282 event
|= CUPSD_EVENT_PRINTER_STATE
;
5283 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5286 cupsFreeOptions(num_attrs
, attrs
);
5288 else if (loglevel
== CUPSD_LOG_PPD
)
5291 * Set attribute(s)...
5294 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
5296 job
->num_keywords
= cupsParseOptions(message
, job
->num_keywords
,
5302 * Strip legacy message prefix...
5305 if (!strncmp(message
, "recoverable:", 12))
5308 while (isspace(*ptr
& 255))
5311 else if (!strncmp(message
, "recovered:", 10))
5314 while (isspace(*ptr
& 255))
5321 cupsdLogJob(job
, loglevel
== CUPSD_LOG_INFO
? CUPSD_LOG_DEBUG
: loglevel
, "%s", ptr
);
5323 if (loglevel
< CUPSD_LOG_DEBUG
&&
5324 strcmp(job
->printer
->state_message
, ptr
))
5326 strlcpy(job
->printer
->state_message
, ptr
,
5327 sizeof(job
->printer
->state_message
));
5329 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
5331 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
5334 * Some messages show in the job-printer-state-message attribute...
5337 if (loglevel
!= CUPSD_LOG_NOTICE
)
5338 job
->status_level
= loglevel
;
5340 update_job_attrs(job
, 1);
5342 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
5343 "Set job-printer-state-message to \"%s\", "
5345 job
->printer_message
->values
[0].string
.text
,
5346 levels
[job
->status_level
]);
5351 if (!strchr(job
->status_buffer
->buffer
, '\n'))
5355 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
5356 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5357 "%s", job
->printer
->state_message
);
5358 if (event
& CUPSD_EVENT_PRINTER_STATE
)
5359 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
5360 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
5361 "Class \"%s\" state changed." :
5362 "Printer \"%s\" state changed.",
5363 job
->printer
->name
);
5366 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
5369 * See if all of the filters and the backend have returned their
5373 for (i
= 0; job
->filters
[i
] < 0; i
++);
5375 if (job
->filters
[i
])
5378 * EOF but we haven't collected the exit status of all filters...
5381 cupsdCheckProcess();
5385 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
5388 * EOF but we haven't collected the exit status of the backend...
5391 cupsdCheckProcess();
5396 * Handle the end of job stuff...
5399 finalize_job(job
, 1);
5402 * Try printing another job...
5405 if (printer
->state
!= IPP_PRINTER_STOPPED
)
5412 * 'update_job_attrs()' - Update the job-printer-* attributes.
5416 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
5417 int do_message
)/* I - 1 = copy job-printer-state message */
5419 int i
; /* Looping var */
5420 int num_reasons
; /* Actual number of reasons */
5421 const char * const *reasons
; /* Reasons */
5422 static const char *none
= "none"; /* "none" reason */
5426 * Get/create the job-printer-state-* attributes...
5429 if (!job
->printer_message
)
5431 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
5432 "job-printer-state-message",
5433 IPP_TAG_TEXT
)) == NULL
)
5434 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
5435 "job-printer-state-message",
5439 if (!job
->printer_reasons
)
5440 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
5441 "job-printer-state-reasons",
5445 * Copy or clear the printer-state-message value as needed...
5448 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
5449 job
->status_level
== CUPSD_LOG_INFO
)
5451 ippSetString(job
->attrs
, &job
->printer_message
, 0, "");
5454 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5456 else if (job
->printer
->state_message
[0] && do_message
)
5458 ippSetString(job
->attrs
, &job
->printer_message
, 0, job
->printer
->state_message
);
5461 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5465 * ... and the printer-state-reasons value...
5468 if (job
->printer
->num_reasons
== 0)
5475 num_reasons
= job
->printer
->num_reasons
;
5476 reasons
= (const char * const *)job
->printer
->reasons
;
5479 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
5482 * Replace/create a job-printer-state-reasons attribute...
5485 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
5487 job
->printer_reasons
= ippAddStrings(job
->attrs
,
5488 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
5489 "job-printer-state-reasons",
5490 num_reasons
, NULL
, NULL
);
5495 * Don't bother clearing the reason strings if they are the same...
5498 for (i
= 0; i
< num_reasons
; i
++)
5499 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
5502 if (i
>= num_reasons
)
5506 * Not the same, so free the current strings...
5509 for (i
= 0; i
< num_reasons
; i
++)
5510 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
5514 * Copy the reasons...
5517 for (i
= 0; i
< num_reasons
; i
++)
5518 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
5521 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);