2 * Job management routines for the CUPS scheduler.
4 * Copyright 2007-2016 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 * file is 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-actual-printer-uri attribute for this job
391 * so that we know which printer actually printed the job...
394 if ((attr
= ippFindAttribute(job
->attrs
, "job-actual-printer-uri",
395 IPP_TAG_URI
)) != NULL
)
396 ippSetString(job
->attrs
, &attr
, 0, printer
->uri
);
398 ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_URI
,
399 "job-actual-printer-uri", NULL
, printer
->uri
);
402 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
405 if (!printer
->job
&& printer
->state
== IPP_PRINTER_IDLE
)
411 cupsArraySave(ActiveJobs
);
412 start_job(job
, printer
);
413 cupsArrayRestore(ActiveJobs
);
422 * 'cupsdCleanJobs()' - Clean out old jobs.
428 cupsd_job_t
*job
; /* Current job */
429 time_t curtime
; /* Current time */
432 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
433 "cupsdCleanJobs: MaxJobs=%d, JobHistory=%d, JobFiles=%d",
434 MaxJobs
, JobHistory
, JobFiles
);
436 if (MaxJobs
<= 0 && JobHistory
== INT_MAX
&& JobFiles
== INT_MAX
)
439 curtime
= time(NULL
);
440 JobHistoryUpdate
= 0;
442 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
444 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
446 if (job
->state_value
>= IPP_JOB_CANCELED
&& !job
->printer
)
449 * Expire old jobs (or job files)...
452 if ((MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
) ||
453 (job
->history_time
&& job
->history_time
<= curtime
))
455 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Removing from history.");
456 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
458 else if (job
->file_time
&& job
->file_time
<= curtime
)
460 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Removing document files.");
461 remove_job_files(job
);
463 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
465 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
466 JobHistoryUpdate
= job
->history_time
;
470 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
471 JobHistoryUpdate
= job
->history_time
;
473 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
474 JobHistoryUpdate
= job
->file_time
;
479 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCleanJobs: JobHistoryUpdate=%ld",
480 (long)JobHistoryUpdate
);
485 * 'cupsdContinueJob()' - Continue printing with the next file in a job.
489 cupsdContinueJob(cupsd_job_t
*job
) /* I - Job */
491 int i
; /* Looping var */
492 int slot
; /* Pipe slot */
493 cups_array_t
*filters
= NULL
,/* Filters for job */
494 *prefilters
; /* Filters with prefilters */
495 mime_filter_t
*filter
, /* Current filter */
496 *prefilter
, /* Prefilter */
497 port_monitor
; /* Port monitor filter */
498 char scheme
[255]; /* Device URI scheme */
499 ipp_attribute_t
*attr
; /* Current attribute */
500 const char *ptr
, /* Pointer into value */
501 *abort_message
; /* Abort message */
502 ipp_jstate_t abort_state
= IPP_JOB_STOPPED
;
503 /* New job state on abort */
504 struct stat backinfo
; /* Backend file information */
505 int backroot
; /* Run backend as root? */
506 int pid
; /* Process ID of new filter process */
507 int banner_page
; /* 1 if banner page, 0 otherwise */
508 int filterfds
[2][2] = { { -1, -1 }, { -1, -1 } };
509 /* Pipes used between filters */
510 int envc
; /* Number of environment variables */
511 struct stat fileinfo
; /* Job file information */
512 int argc
= 0; /* Number of arguments */
513 char **argv
= NULL
, /* Filter command-line arguments */
514 filename
[1024], /* Job filename */
515 command
[1024], /* Full path to command */
516 jobid
[255], /* Job ID string */
518 /* Job title string */
519 copies
[255], /* # copies string */
520 *options
, /* Options string */
522 /* Environment variables */
523 charset
[255], /* CHARSET env variable */
524 class_name
[255],/* CLASS env variable */
525 classification
[1024],
526 /* CLASSIFICATION env variable */
528 /* CONTENT_TYPE env variable */
530 /* DEVICE_URI env variable */
531 final_content_type
[1024] = "",
532 /* FINAL_CONTENT_TYPE env variable */
533 lang
[255], /* LANG env variable */
536 /* APPLE_LANGUAGE env variable */
537 #endif /* __APPLE__ */
538 auth_info_required
[255],
539 /* AUTH_INFO_REQUIRED env variable */
540 ppd
[1024], /* PPD env variable */
542 /* PRINTER_INFO env variable */
543 printer_location
[255],
544 /* PRINTER_LOCATION env variable */
546 /* PRINTER env variable */
547 *printer_state_reasons
= NULL
,
548 /* PRINTER_STATE_REASONS env var */
550 /* RIP_MAX_CACHE env variable */
553 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
554 "cupsdContinueJob(job=%p(%d)): current_file=%d, num_files=%d",
555 job
, job
->id
, job
->current_file
, job
->num_files
);
558 * Figure out what filters are required to convert from
559 * the source to the destination type...
562 FilterLevel
-= job
->cost
;
565 job
->pending_cost
= 0;
567 memset(job
->filters
, 0, sizeof(job
->filters
));
569 if (job
->printer
->raw
)
572 * Remote jobs and raw queues go directly to the printer without
576 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Sending job to queue tagged as raw...");
581 * Local jobs get filtered...
584 mime_type_t
*dst
= job
->printer
->filetype
;
585 /* Destination file type */
587 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
588 job
->id
, job
->current_file
+ 1);
589 if (stat(filename
, &fileinfo
))
590 fileinfo
.st_size
= 0;
592 if (job
->retry_as_raster
)
595 * Need to figure out whether the printer supports image/pwg-raster or
596 * image/urf, and use the corresponding type...
599 char type
[MIME_MAX_TYPE
]; /* MIME media type for printer */
601 snprintf(type
, sizeof(type
), "%s/image/urf", job
->printer
->name
);
602 if ((dst
= mimeType(MimeDatabase
, "printer", type
)) == NULL
)
604 snprintf(type
, sizeof(type
), "%s/image/pwg-raster", job
->printer
->name
);
605 dst
= mimeType(MimeDatabase
, "printer", type
);
609 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Retrying job as \"%s\".", strchr(dst
->type
, '/') + 1);
611 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to retry job using a supported raster format.");
614 filters
= mimeFilter2(MimeDatabase
, job
->filetypes
[job
->current_file
], (size_t)fileinfo
.st_size
, dst
, &(job
->cost
));
618 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
619 "Unable to convert file %d to printable format.",
622 abort_message
= "Aborting job because it cannot be printed.";
623 abort_state
= IPP_JOB_ABORTED
;
625 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
630 * Figure out the final content type...
633 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%d filters for job:",
634 cupsArrayCount(filters
));
635 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
637 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
638 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s (%s/%s to %s/%s, cost %d)",
640 filter
->src
? filter
->src
->super
: "???",
641 filter
->src
? filter
->src
->type
: "???",
642 filter
->dst
? filter
->dst
->super
: "???",
643 filter
->dst
? filter
->dst
->type
: "???",
646 if (!job
->printer
->remote
)
648 for (filter
= (mime_filter_t
*)cupsArrayLast(filters
);
649 filter
&& filter
->dst
;
650 filter
= (mime_filter_t
*)cupsArrayPrev(filters
))
651 if (strcmp(filter
->dst
->super
, "printer") ||
652 strcmp(filter
->dst
->type
, job
->printer
->name
))
655 if (filter
&& filter
->dst
)
657 if ((ptr
= strchr(filter
->dst
->type
, '/')) != NULL
)
658 snprintf(final_content_type
, sizeof(final_content_type
),
659 "FINAL_CONTENT_TYPE=%s", ptr
+ 1);
661 snprintf(final_content_type
, sizeof(final_content_type
),
662 "FINAL_CONTENT_TYPE=%s/%s", filter
->dst
->super
,
666 snprintf(final_content_type
, sizeof(final_content_type
),
667 "FINAL_CONTENT_TYPE=printer/%s", job
->printer
->name
);
671 * Remove NULL ("-") filters...
674 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
676 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
677 if (!strcmp(filter
->filter
, "-"))
678 cupsArrayRemove(filters
, filter
);
680 if (cupsArrayCount(filters
) == 0)
682 cupsArrayDelete(filters
);
687 * If this printer has any pre-filters, insert the required pre-filter
688 * in the filters array...
691 if (job
->printer
->prefiltertype
&& filters
)
693 prefilters
= cupsArrayNew(NULL
, NULL
);
695 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
697 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
699 if ((prefilter
= mimeFilterLookup(MimeDatabase
, filter
->src
,
700 job
->printer
->prefiltertype
)))
702 cupsArrayAdd(prefilters
, prefilter
);
703 job
->cost
+= prefilter
->cost
;
706 cupsArrayAdd(prefilters
, filter
);
709 cupsArrayDelete(filters
);
710 filters
= prefilters
;
715 * Set a minimum cost of 100 for all jobs so that FilterLimit
716 * works with raw queues and other low-cost paths.
723 * See if the filter cost is too high...
726 if ((FilterLevel
+ job
->cost
) > FilterLimit
&& FilterLevel
> 0 &&
730 * Don't print this job quite yet...
733 cupsArrayDelete(filters
);
735 cupsdLogJob(job
, CUPSD_LOG_INFO
,
736 "Holding because filter limit has been reached.");
737 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
,
738 "cupsdContinueJob: file=%d, cost=%d, level=%d, limit=%d",
739 job
->current_file
, job
->cost
, FilterLevel
,
742 job
->pending_cost
= job
->cost
;
747 FilterLevel
+= job
->cost
;
750 * Add decompression/raw filter as needed...
753 if (job
->compressions
[job
->current_file
] &&
754 (!job
->printer
->remote
|| job
->num_files
== 1))
757 * Add gziptoany filter to the front of the list...
761 filters
= cupsArrayNew(NULL
, NULL
);
763 if (!cupsArrayInsert(filters
, &gziptoany_filter
))
765 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
766 "Unable to add decompression filter - %s", strerror(errno
));
768 cupsArrayDelete(filters
);
770 abort_message
= "Stopping job because the scheduler ran out of memory.";
777 * Add port monitor, if any...
780 if (job
->printer
->port_monitor
)
783 * Add port monitor to the end of the list...
787 filters
= cupsArrayNew(NULL
, NULL
);
789 port_monitor
.src
= NULL
;
790 port_monitor
.dst
= NULL
;
791 port_monitor
.cost
= 0;
793 snprintf(port_monitor
.filter
, sizeof(port_monitor
.filter
),
794 "%s/monitor/%s", ServerBin
, job
->printer
->port_monitor
);
796 if (!cupsArrayAdd(filters
, &port_monitor
))
798 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
799 "Unable to add port monitor - %s", strerror(errno
));
801 abort_message
= "Stopping job because the scheduler ran out of memory.";
808 * Make sure we don't go over the "MAX_FILTERS" limit...
811 if (cupsArrayCount(filters
) > MAX_FILTERS
)
813 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
814 "Too many filters (%d > %d), unable to print.",
815 cupsArrayCount(filters
), MAX_FILTERS
);
817 abort_message
= "Aborting job because it needs too many filters to print.";
818 abort_state
= IPP_JOB_ABORTED
;
820 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
826 * Determine if we are printing a banner page or not...
829 if (job
->job_sheets
== NULL
)
831 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "No job-sheets attribute.");
832 if ((job
->job_sheets
=
833 ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_ZERO
)) != NULL
)
834 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
835 "... but someone added one without setting job_sheets.");
837 else if (job
->job_sheets
->num_values
== 1)
838 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s",
839 job
->job_sheets
->values
[0].string
.text
);
841 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s,%s",
842 job
->job_sheets
->values
[0].string
.text
,
843 job
->job_sheets
->values
[1].string
.text
);
845 if (job
->printer
->type
& CUPS_PRINTER_REMOTE
)
847 else if (job
->job_sheets
== NULL
)
849 else if (_cups_strcasecmp(job
->job_sheets
->values
[0].string
.text
, "none") != 0 &&
850 job
->current_file
== 0)
852 else if (job
->job_sheets
->num_values
> 1 &&
853 _cups_strcasecmp(job
->job_sheets
->values
[1].string
.text
, "none") != 0 &&
854 job
->current_file
== (job
->num_files
- 1))
859 if ((options
= get_options(job
, banner_page
, copies
, sizeof(copies
), title
,
860 sizeof(title
))) == NULL
)
862 abort_message
= "Stopping job because the scheduler ran out of memory.";
868 * Build the command-line arguments for the filters. Each filter
869 * has 6 or 7 arguments:
877 * argv[6] = filename (optional; normally stdin)
879 * This allows legacy printer drivers that use the old System V
880 * printing interface to be used by CUPS.
882 * For remote jobs, we send all of the files in the argument list.
885 if (job
->printer
->remote
)
886 argc
= 6 + job
->num_files
;
890 if ((argv
= calloc((size_t)argc
+ 1, sizeof(char *))) == NULL
)
892 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Unable to allocate argument array - %s",
895 abort_message
= "Stopping job because the scheduler ran out of memory.";
900 sprintf(jobid
, "%d", job
->id
);
902 argv
[0] = job
->printer
->name
;
904 argv
[2] = job
->username
;
909 if (job
->printer
->remote
&& job
->num_files
> 1)
911 for (i
= 0; i
< job
->num_files
; i
++)
913 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
915 argv
[6 + i
] = strdup(filename
);
920 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
921 job
->id
, job
->current_file
+ 1);
922 argv
[6] = strdup(filename
);
925 for (i
= 0; argv
[i
]; i
++)
926 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "argv[%d]=\"%s\"", i
, argv
[i
]);
929 * Create environment variable strings for the filters...
932 attr
= ippFindAttribute(job
->attrs
, "attributes-natural-language",
936 strlcpy(apple_language
, "APPLE_LANGUAGE=", sizeof(apple_language
));
937 _cupsAppleLanguage(attr
->values
[0].string
.text
,
938 apple_language
+ 15, sizeof(apple_language
) - 15);
939 #endif /* __APPLE__ */
941 switch (strlen(attr
->values
[0].string
.text
))
945 * This is an unknown or badly formatted language code; use
946 * the POSIX locale...
949 strlcpy(lang
, "LANG=C", sizeof(lang
));
954 * Just the language code (ll)...
957 snprintf(lang
, sizeof(lang
), "LANG=%s.UTF-8",
958 attr
->values
[0].string
.text
);
963 * Language and country code (ll-cc)...
966 snprintf(lang
, sizeof(lang
), "LANG=%c%c_%c%c.UTF-8",
967 attr
->values
[0].string
.text
[0],
968 attr
->values
[0].string
.text
[1],
969 toupper(attr
->values
[0].string
.text
[3] & 255),
970 toupper(attr
->values
[0].string
.text
[4] & 255));
974 if ((attr
= ippFindAttribute(job
->attrs
, "document-format",
975 IPP_TAG_MIMETYPE
)) != NULL
&&
976 (ptr
= strstr(attr
->values
[0].string
.text
, "charset=")) != NULL
)
977 snprintf(charset
, sizeof(charset
), "CHARSET=%s", ptr
+ 8);
979 strlcpy(charset
, "CHARSET=utf-8", sizeof(charset
));
981 snprintf(content_type
, sizeof(content_type
), "CONTENT_TYPE=%s/%s",
982 job
->filetypes
[job
->current_file
]->super
,
983 job
->filetypes
[job
->current_file
]->type
);
984 snprintf(device_uri
, sizeof(device_uri
), "DEVICE_URI=%s",
985 job
->printer
->device_uri
);
986 snprintf(ppd
, sizeof(ppd
), "PPD=%s/ppd/%s.ppd", ServerRoot
,
988 snprintf(printer_info
, sizeof(printer_name
), "PRINTER_INFO=%s",
989 job
->printer
->info
? job
->printer
->info
: "");
990 snprintf(printer_location
, sizeof(printer_name
), "PRINTER_LOCATION=%s",
991 job
->printer
->location
? job
->printer
->location
: "");
992 snprintf(printer_name
, sizeof(printer_name
), "PRINTER=%s", job
->printer
->name
);
993 if (job
->printer
->num_reasons
> 0)
995 char *psrptr
; /* Pointer into PRINTER_STATE_REASONS */
996 size_t psrlen
; /* Size of PRINTER_STATE_REASONS */
998 for (psrlen
= 22, i
= 0; i
< job
->printer
->num_reasons
; i
++)
999 psrlen
+= strlen(job
->printer
->reasons
[i
]) + 1;
1001 if ((printer_state_reasons
= malloc(psrlen
)) != NULL
)
1004 * All of these strcpy's are safe because we allocated the psr string...
1007 strlcpy(printer_state_reasons
, "PRINTER_STATE_REASONS=", psrlen
);
1008 for (psrptr
= printer_state_reasons
+ 22, i
= 0;
1009 i
< job
->printer
->num_reasons
;
1014 strlcpy(psrptr
, job
->printer
->reasons
[i
], psrlen
- (size_t)(psrptr
- printer_state_reasons
));
1015 psrptr
+= strlen(psrptr
);
1019 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
1021 if (job
->printer
->num_auth_info_required
== 1)
1022 snprintf(auth_info_required
, sizeof(auth_info_required
),
1023 "AUTH_INFO_REQUIRED=%s",
1024 job
->printer
->auth_info_required
[0]);
1025 else if (job
->printer
->num_auth_info_required
== 2)
1026 snprintf(auth_info_required
, sizeof(auth_info_required
),
1027 "AUTH_INFO_REQUIRED=%s,%s",
1028 job
->printer
->auth_info_required
[0],
1029 job
->printer
->auth_info_required
[1]);
1030 else if (job
->printer
->num_auth_info_required
== 3)
1031 snprintf(auth_info_required
, sizeof(auth_info_required
),
1032 "AUTH_INFO_REQUIRED=%s,%s,%s",
1033 job
->printer
->auth_info_required
[0],
1034 job
->printer
->auth_info_required
[1],
1035 job
->printer
->auth_info_required
[2]);
1036 else if (job
->printer
->num_auth_info_required
== 4)
1037 snprintf(auth_info_required
, sizeof(auth_info_required
),
1038 "AUTH_INFO_REQUIRED=%s,%s,%s,%s",
1039 job
->printer
->auth_info_required
[0],
1040 job
->printer
->auth_info_required
[1],
1041 job
->printer
->auth_info_required
[2],
1042 job
->printer
->auth_info_required
[3]);
1044 strlcpy(auth_info_required
, "AUTH_INFO_REQUIRED=none",
1045 sizeof(auth_info_required
));
1047 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
1049 envp
[envc
++] = charset
;
1050 envp
[envc
++] = lang
;
1052 envp
[envc
++] = apple_language
;
1053 #endif /* __APPLE__ */
1054 envp
[envc
++] = ppd
;
1055 envp
[envc
++] = rip_max_cache
;
1056 envp
[envc
++] = content_type
;
1057 envp
[envc
++] = device_uri
;
1058 envp
[envc
++] = printer_info
;
1059 envp
[envc
++] = printer_location
;
1060 envp
[envc
++] = printer_name
;
1061 envp
[envc
++] = printer_state_reasons
? printer_state_reasons
:
1062 "PRINTER_STATE_REASONS=none";
1063 envp
[envc
++] = banner_page
? "CUPS_FILETYPE=job-sheet" :
1064 "CUPS_FILETYPE=document";
1066 if (final_content_type
[0])
1067 envp
[envc
++] = final_content_type
;
1069 if (Classification
&& !banner_page
)
1071 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
1072 IPP_TAG_NAME
)) == NULL
)
1073 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1075 else if (attr
->num_values
> 1 &&
1076 strcmp(attr
->values
[1].string
.text
, "none") != 0)
1077 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1078 attr
->values
[1].string
.text
);
1080 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1081 attr
->values
[0].string
.text
);
1083 envp
[envc
++] = classification
;
1086 if (job
->dtype
& CUPS_PRINTER_CLASS
)
1088 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
1089 envp
[envc
++] = class_name
;
1092 envp
[envc
++] = auth_info_required
;
1095 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1097 if (job
->auth_env
[i
])
1098 envp
[envc
++] = job
->auth_env
[i
];
1103 envp
[envc
++] = job
->auth_uid
;
1107 for (i
= 0; i
< envc
; i
++)
1108 if (!strncmp(envp
[i
], "AUTH_", 5))
1109 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"AUTH_%c****\"", i
,
1111 else if (strncmp(envp
[i
], "DEVICE_URI=", 11))
1112 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"%s\"", i
, envp
[i
]);
1114 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"DEVICE_URI=%s\"", i
,
1115 job
->printer
->sanitized_device_uri
);
1117 if (job
->printer
->remote
)
1118 job
->current_file
= job
->num_files
;
1120 job
->current_file
++;
1123 * Now create processes for all of the filters...
1126 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
1128 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
1130 if (filter
->filter
[0] != '/')
1131 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
1134 strlcpy(command
, filter
->filter
, sizeof(command
));
1136 if (i
< (cupsArrayCount(filters
) - 1))
1138 if (cupsdOpenPipe(filterfds
[slot
]))
1140 abort_message
= "Stopping job because the scheduler could not create "
1141 "the filter pipes.";
1148 if (job
->current_file
== 1 ||
1149 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1151 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1153 if (cupsdOpenPipe(job
->print_pipes
))
1155 abort_message
= "Stopping job because the scheduler could not "
1156 "create the backend pipes.";
1163 job
->print_pipes
[0] = -1;
1164 if (!strcmp(job
->printer
->device_uri
, "file:/dev/null") ||
1165 !strcmp(job
->printer
->device_uri
, "file:///dev/null"))
1166 job
->print_pipes
[1] = -1;
1169 if (!strncmp(job
->printer
->device_uri
, "file:/dev/", 10))
1170 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1172 else if (!strncmp(job
->printer
->device_uri
, "file:///dev/", 12))
1173 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1175 else if (!strncmp(job
->printer
->device_uri
, "file:///", 8))
1176 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1177 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1179 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1180 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1182 if (job
->print_pipes
[1] < 0)
1184 abort_message
= "Stopping job because the scheduler could not "
1185 "open the output file.";
1190 fcntl(job
->print_pipes
[1], F_SETFD
,
1191 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
1196 filterfds
[slot
][0] = job
->print_pipes
[0];
1197 filterfds
[slot
][1] = job
->print_pipes
[1];
1200 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1201 filterfds
[slot
][1], job
->status_pipes
[1],
1202 job
->back_pipes
[0], job
->side_pipes
[0], 0,
1203 job
->profile
, job
, job
->filters
+ i
);
1205 cupsdClosePipe(filterfds
[!slot
]);
1209 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
1210 filter
->filter
, strerror(errno
));
1212 abort_message
= "Stopping job because the scheduler could not execute a "
1218 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started filter %s (PID %d)", command
,
1230 cupsArrayDelete(filters
);
1234 * Finally, pipe the final output into a backend process if needed...
1237 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1239 if (job
->current_file
== 1 || job
->printer
->remote
||
1240 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1242 sscanf(job
->printer
->device_uri
, "%254[^:]", scheme
);
1243 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, scheme
);
1246 * See if the backend needs to run as root...
1251 else if (stat(command
, &backinfo
))
1254 backroot
= !(backinfo
.st_mode
& (S_IWGRP
| S_IRWXO
));
1256 argv
[0] = job
->printer
->sanitized_device_uri
;
1258 filterfds
[slot
][0] = -1;
1259 filterfds
[slot
][1] = -1;
1261 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1262 filterfds
[slot
][1], job
->status_pipes
[1],
1263 job
->back_pipes
[1], job
->side_pipes
[1],
1264 backroot
, job
->bprofile
, job
, &(job
->backend
));
1268 abort_message
= "Stopping job because the sheduler could not execute "
1275 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started backend %s (PID %d)",
1280 if (job
->current_file
== job
->num_files
||
1281 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1282 cupsdClosePipe(job
->print_pipes
);
1284 if (job
->current_file
== job
->num_files
)
1286 cupsdClosePipe(job
->back_pipes
);
1287 cupsdClosePipe(job
->side_pipes
);
1289 close(job
->status_pipes
[1]);
1290 job
->status_pipes
[1] = -1;
1295 filterfds
[slot
][0] = -1;
1296 filterfds
[slot
][1] = -1;
1298 if (job
->current_file
== job
->num_files
||
1299 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1300 cupsdClosePipe(job
->print_pipes
);
1302 if (job
->current_file
== job
->num_files
)
1304 close(job
->status_pipes
[1]);
1305 job
->status_pipes
[1] = -1;
1309 cupsdClosePipe(filterfds
[slot
]);
1311 for (i
= 6; i
< argc
; i
++)
1317 if (printer_state_reasons
)
1318 free(printer_state_reasons
);
1320 cupsdAddSelect(job
->status_buffer
->fd
, (cupsd_selfunc_t
)update_job
, NULL
,
1323 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
1330 * If we get here, we need to abort the current job and close out all
1331 * files and pipes...
1336 FilterLevel
-= job
->cost
;
1339 for (slot
= 0; slot
< 2; slot
++)
1340 cupsdClosePipe(filterfds
[slot
]);
1342 cupsArrayDelete(filters
);
1346 for (i
= 6; i
< argc
; i
++)
1351 if (printer_state_reasons
)
1352 free(printer_state_reasons
);
1354 cupsdClosePipe(job
->print_pipes
);
1355 cupsdClosePipe(job
->back_pipes
);
1356 cupsdClosePipe(job
->side_pipes
);
1358 cupsdRemoveSelect(job
->status_pipes
[0]);
1359 cupsdClosePipe(job
->status_pipes
);
1360 cupsdStatBufDelete(job
->status_buffer
);
1361 job
->status_buffer
= NULL
;
1364 * Update the printer and job state.
1367 cupsdSetJobState(job
, abort_state
, CUPSD_JOB_DEFAULT
, "%s", abort_message
);
1368 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_IDLE
, 0);
1369 update_job_attrs(job
, 0);
1372 free_job_history(job
);
1374 cupsArrayRemove(PrintingJobs
, job
);
1377 * Clear the printer <-> job association...
1380 job
->printer
->job
= NULL
;
1381 job
->printer
= NULL
;
1386 * 'cupsdDeleteJob()' - Free all memory used by a job.
1390 cupsdDeleteJob(cupsd_job_t
*job
, /* I - Job */
1391 cupsd_jobaction_t action
)/* I - Action */
1393 int i
; /* Looping var */
1397 finalize_job(job
, 1);
1399 if (action
== CUPSD_JOB_PURGE
)
1400 remove_job_history(job
);
1402 cupsdClearString(&job
->username
);
1403 cupsdClearString(&job
->dest
);
1405 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1407 cupsdClearString(job
->auth_env
+ i
);
1408 cupsdClearString(&job
->auth_uid
);
1410 if (action
== CUPSD_JOB_PURGE
)
1411 remove_job_files(job
);
1412 else if (job
->num_files
> 0)
1414 free(job
->compressions
);
1415 free(job
->filetypes
);
1421 free_job_history(job
);
1425 cupsArrayRemove(Jobs
, job
);
1426 cupsArrayRemove(ActiveJobs
, job
);
1427 cupsArrayRemove(PrintingJobs
, job
);
1434 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1438 cupsdFreeAllJobs(void)
1440 cupsd_job_t
*job
; /* Current job */
1448 cupsdStopAllJobs(CUPSD_JOB_FORCE
, 0);
1451 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1453 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1454 cupsdDeleteJob(job
, CUPSD_JOB_DEFAULT
);
1456 cupsdReleaseSignals();
1461 * 'cupsdFindJob()' - Find the specified job.
1464 cupsd_job_t
* /* O - Job data */
1465 cupsdFindJob(int id
) /* I - Job ID */
1467 cupsd_job_t key
; /* Search key */
1472 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
1477 * 'cupsdGetCompletedJobs()'- Generate a completed jobs list.
1480 cups_array_t
* /* O - Array of jobs */
1481 cupsdGetCompletedJobs(
1482 cupsd_printer_t
*p
) /* I - Printer */
1484 cups_array_t
*list
; /* Array of jobs */
1485 cupsd_job_t
*job
; /* Current job */
1488 list
= cupsArrayNew(compare_completed_jobs
, NULL
);
1490 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1492 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1493 if ((!p
|| !_cups_strcasecmp(p
->name
, job
->dest
)) && job
->state_value
>= IPP_JOB_STOPPED
&& job
->completed_time
)
1494 cupsArrayAdd(list
, job
);
1501 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1502 * or held jobs in a printer or class.
1505 int /* O - Job count */
1506 cupsdGetPrinterJobCount(
1507 const char *dest
) /* I - Printer or class name */
1509 int count
; /* Job count */
1510 cupsd_job_t
*job
; /* Current job */
1513 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1515 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1516 if (job
->dest
&& !_cups_strcasecmp(job
->dest
, dest
))
1524 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1525 * or held jobs for a user.
1528 int /* O - Job count */
1529 cupsdGetUserJobCount(
1530 const char *username
) /* I - Username */
1532 int count
; /* Job count */
1533 cupsd_job_t
*job
; /* Current job */
1536 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1538 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1539 if (!_cups_strcasecmp(job
->username
, username
))
1547 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1551 cupsdLoadAllJobs(void)
1553 char filename
[1024]; /* Full filename of job.cache file */
1554 struct stat fileinfo
; /* Information on job.cache file */
1555 cups_dir_t
*dir
; /* RequestRoot dir */
1556 cups_dentry_t
*dent
; /* Entry in RequestRoot */
1557 int load_cache
= 1; /* Load the job.cache file? */
1561 * Create the job arrays as needed...
1565 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1568 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1571 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1574 * See whether the job.cache file is older than the RequestRoot directory...
1577 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1579 if (stat(filename
, &fileinfo
))
1582 * No job.cache file...
1587 if (errno
!= ENOENT
)
1588 cupsdLogMessage(CUPSD_LOG_ERROR
,
1589 "Unable to get file information for \"%s\" - %s",
1590 filename
, strerror(errno
));
1592 else if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
1595 * No spool directory...
1602 while ((dent
= cupsDirRead(dir
)) != NULL
)
1604 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c' && dent
->fileinfo
.st_mtime
> fileinfo
.st_mtime
)
1607 * Job history file is newer than job.cache file...
1619 * Load the most recent source for job data...
1625 * Load the job.cache file...
1628 load_job_cache(filename
);
1633 * Load the job history files...
1636 load_request_root();
1638 load_next_job_id(filename
);
1642 * Clean out old jobs as needed...
1645 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1651 * 'cupsdLoadJob()' - Load a single job.
1654 int /* O - 1 on success, 0 on failure */
1655 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1657 int i
; /* Looping var */
1658 char jobfile
[1024]; /* Job filename */
1659 cups_file_t
*fp
; /* Job file */
1660 int fileid
; /* Current file ID */
1661 ipp_attribute_t
*attr
; /* Job attribute */
1662 const char *dest
; /* Destination name */
1663 cupsd_printer_t
*destptr
; /* Pointer to destination */
1664 mime_type_t
**filetypes
; /* New filetypes array */
1665 int *compressions
; /* New compressions array */
1670 if (job
->state_value
> IPP_JOB_STOPPED
)
1671 job
->access_time
= time(NULL
);
1676 if ((job
->attrs
= ippNew()) == NULL
)
1678 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes.");
1683 * Load job attributes...
1686 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading attributes...");
1688 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1689 if ((fp
= cupsdOpenConfFile(jobfile
)) == NULL
)
1692 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1694 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1695 "Unable to read job control file \"%s\".", jobfile
);
1703 * Copy attribute data to the job object...
1706 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1708 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1709 "Missing or bad time-at-creation attribute in control file.");
1713 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1714 IPP_TAG_ENUM
)) == NULL
)
1716 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1717 "Missing or bad job-state attribute in control file.");
1721 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1723 job
->history_time
= 0;
1725 if ((attr
= ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
)) != NULL
)
1726 job
->creation_time
= attr
->values
[0].integer
;
1728 if (job
->state_value
>= IPP_JOB_CANCELED
&& (attr
= ippFindAttribute(job
->attrs
, "time-at-completed", IPP_TAG_INTEGER
)) != NULL
)
1730 job
->completed_time
= attr
->values
[0].integer
;
1732 if (JobHistory
< INT_MAX
)
1733 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
1735 job
->history_time
= INT_MAX
;
1737 if (job
->history_time
< time(NULL
))
1738 goto error
; /* Expired, remove from history */
1740 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1741 JobHistoryUpdate
= job
->history_time
;
1743 if (JobFiles
< INT_MAX
)
1744 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
1746 job
->file_time
= INT_MAX
;
1748 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1749 JobHistoryUpdate
= job
->file_time
;
1751 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdLoadJob: JobHistoryUpdate=%ld",
1752 (long)JobHistoryUpdate
);
1757 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1758 IPP_TAG_URI
)) == NULL
)
1760 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1761 "No job-printer-uri attribute in control file.");
1765 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1768 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1769 "Unable to queue job for destination \"%s\".",
1770 attr
->values
[0].string
.text
);
1774 cupsdSetString(&job
->dest
, dest
);
1776 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1778 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1779 "Unable to queue job for destination \"%s\".",
1784 if ((job
->reasons
= ippFindAttribute(job
->attrs
, "job-state-reasons",
1785 IPP_TAG_KEYWORD
)) == NULL
)
1787 const char *reason
; /* job-state-reason keyword */
1789 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1790 "Adding missing job-state-reasons attribute to control file.");
1792 switch (job
->state_value
)
1795 case IPP_JOB_PENDING
:
1796 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1797 reason
= "printer-stopped";
1803 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1804 IPP_TAG_ZERO
)) != NULL
&&
1805 (attr
->value_tag
== IPP_TAG_NAME
||
1806 attr
->value_tag
== IPP_TAG_NAMELANG
||
1807 attr
->value_tag
== IPP_TAG_KEYWORD
) &&
1808 strcmp(attr
->values
[0].string
.text
, "no-hold"))
1809 reason
= "job-hold-until-specified";
1811 reason
= "job-incoming";
1814 case IPP_JOB_PROCESSING
:
1815 reason
= "job-printing";
1818 case IPP_JOB_STOPPED
:
1819 reason
= "job-stopped";
1822 case IPP_JOB_CANCELED
:
1823 reason
= "job-canceled-by-user";
1826 case IPP_JOB_ABORTED
:
1827 reason
= "aborted-by-system";
1830 case IPP_JOB_COMPLETED
:
1831 reason
= "job-completed-successfully";
1835 job
->reasons
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
1836 "job-state-reasons", NULL
, reason
);
1838 else if (job
->state_value
== IPP_JOB_PENDING
)
1840 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1841 ippSetString(job
->attrs
, &job
->reasons
, 0, "printer-stopped");
1843 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
1846 job
->impressions
= ippFindAttribute(job
->attrs
, "job-impressions-completed", IPP_TAG_INTEGER
);
1847 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed", IPP_TAG_INTEGER
);
1848 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1850 if (!job
->impressions
)
1851 job
->impressions
= ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-impressions-completed", 0);
1855 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1856 IPP_TAG_INTEGER
)) == NULL
)
1858 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1859 "Missing or bad job-priority attribute in control file.");
1863 job
->priority
= attr
->values
[0].integer
;
1868 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1869 IPP_TAG_NAME
)) == NULL
)
1871 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1872 "Missing or bad job-originating-user-name "
1873 "attribute in control file.");
1877 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1882 if ((attr
= ippFindAttribute(job
->attrs
, "job-name", IPP_TAG_NAME
)) != NULL
)
1883 cupsdSetString(&job
->name
, attr
->values
[0].string
.text
);
1887 * Set the job hold-until time and state...
1890 if (job
->state_value
== IPP_JOB_HELD
)
1892 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1893 IPP_TAG_KEYWORD
)) == NULL
)
1894 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1897 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1900 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1901 job
->state_value
= IPP_JOB_PENDING
;
1904 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1906 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1907 job
->state_value
= IPP_JOB_PENDING
;
1910 if ((attr
= ippFindAttribute(job
->attrs
, "job-k-octets", IPP_TAG_INTEGER
)) != NULL
)
1911 job
->koctets
= attr
->values
[0].integer
;
1913 if (!job
->num_files
)
1916 * Find all the d##### files...
1919 for (fileid
= 1; fileid
< 10000; fileid
++)
1921 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1924 if (access(jobfile
, 0))
1927 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1928 "Auto-typing document file \"%s\"...", jobfile
);
1930 if (fileid
> job
->num_files
)
1932 if (job
->num_files
== 0)
1934 compressions
= (int *)calloc((size_t)fileid
, sizeof(int));
1935 filetypes
= (mime_type_t
**)calloc((size_t)fileid
, sizeof(mime_type_t
*));
1939 compressions
= (int *)realloc(job
->compressions
, sizeof(int) * (size_t)fileid
);
1940 filetypes
= (mime_type_t
**)realloc(job
->filetypes
, sizeof(mime_type_t
*) * (size_t)fileid
);
1944 job
->compressions
= compressions
;
1947 job
->filetypes
= filetypes
;
1949 if (!compressions
|| !filetypes
)
1951 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1952 "Ran out of memory for job file types.");
1954 ippDelete(job
->attrs
);
1957 if (job
->compressions
)
1959 free(job
->compressions
);
1960 job
->compressions
= NULL
;
1965 free(job
->filetypes
);
1966 job
->filetypes
= NULL
;
1973 job
->num_files
= fileid
;
1976 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1977 job
->compressions
+ fileid
- 1);
1979 if (!job
->filetypes
[fileid
- 1])
1980 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1986 * Load authentication information as needed...
1989 if (job
->state_value
< IPP_JOB_STOPPED
)
1991 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1994 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1996 cupsdClearString(job
->auth_env
+ i
);
1997 cupsdClearString(&job
->auth_uid
);
1999 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
2001 int bytes
, /* Size of auth data */
2002 linenum
= 1; /* Current line number */
2003 char line
[65536], /* Line from file */
2004 *value
, /* Value from line */
2005 data
[65536]; /* Decoded data */
2008 if (cupsFileGets(fp
, line
, sizeof(line
)) &&
2009 !strcmp(line
, "CUPSD-AUTH-V3"))
2012 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
2018 if (strcmp(line
, "negotiate") && strcmp(line
, "uid"))
2020 bytes
= sizeof(data
);
2021 httpDecode64_2(data
, &bytes
, value
);
2025 * Assign environment variables...
2028 if (!strcmp(line
, "uid"))
2030 cupsdSetStringf(&job
->auth_uid
, "AUTH_UID=%s", value
);
2033 else if (i
>= (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0])))
2036 if (!strcmp(line
, "username"))
2037 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_USERNAME=%s", data
);
2038 else if (!strcmp(line
, "domain"))
2039 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_DOMAIN=%s", data
);
2040 else if (!strcmp(line
, "password"))
2041 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_PASSWORD=%s", data
);
2042 else if (!strcmp(line
, "negotiate"))
2043 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_NEGOTIATE=%s", value
);
2055 job
->access_time
= time(NULL
);
2059 * If we get here then something bad happened...
2064 ippDelete(job
->attrs
);
2067 remove_job_history(job
);
2068 remove_job_files(job
);
2075 * 'cupsdMoveJob()' - Move the specified job to a different destination.
2079 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
2080 cupsd_printer_t
*p
) /* I - Destination printer or class */
2082 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
2083 const char *olddest
; /* Old destination */
2084 cupsd_printer_t
*oldp
; /* Old pointer */
2088 * Don't move completed jobs...
2091 if (job
->state_value
> IPP_JOB_STOPPED
)
2095 * Get the old destination...
2098 olddest
= job
->dest
;
2101 oldp
= job
->printer
;
2103 oldp
= cupsdFindDest(olddest
);
2106 * Change the destination information...
2109 if (job
->state_value
> IPP_JOB_HELD
)
2110 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2111 "Stopping job prior to move.");
2113 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
2114 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2117 cupsdSetString(&job
->dest
, p
->name
);
2118 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
);
2120 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
2121 IPP_TAG_URI
)) != NULL
)
2122 ippSetString(job
->attrs
, &attr
, 0, p
->uri
);
2124 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
2125 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2129 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2134 * 'cupsdReleaseJob()' - Release the specified job.
2138 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
2140 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
2143 if (job
->state_value
== IPP_JOB_HELD
)
2146 * Add trailing banner as needed...
2149 if (job
->pending_timeout
)
2150 cupsdTimeoutJob(job
);
2152 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2153 "Job released by user.");
2159 * 'cupsdRestartJob()' - Restart the specified job.
2163 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
2165 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
2168 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
2169 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2170 "Job restarted by user.");
2175 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2179 cupsdSaveAllJobs(void)
2181 int i
; /* Looping var */
2182 cups_file_t
*fp
; /* job.cache file */
2183 char filename
[1024], /* job.cache filename */
2184 temp
[1024]; /* Temporary string */
2185 cupsd_job_t
*job
; /* Current job */
2186 time_t curtime
; /* Current time */
2187 struct tm
*curdate
; /* Current date */
2190 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
2191 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
)) == NULL
)
2194 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job.cache...");
2197 * Write a small header to the file...
2200 curtime
= time(NULL
);
2201 curdate
= localtime(&curtime
);
2202 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
2204 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
2205 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
2206 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
2209 * Write each job known to the system...
2212 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2214 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2216 if (job
->printer
&& job
->printer
->temporary
)
2219 * Don't save jobs on temporary printers...
2225 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
2226 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
2227 cupsFilePrintf(fp
, "Created %ld\n", (long)job
->creation_time
);
2228 if (job
->completed_time
)
2229 cupsFilePrintf(fp
, "Completed %ld\n", (long)job
->completed_time
);
2230 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
2231 if (job
->hold_until
)
2232 cupsFilePrintf(fp
, "HoldUntil %ld\n", (long)job
->hold_until
);
2233 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
2235 cupsFilePutConf(fp
, "Name", job
->name
);
2236 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
2237 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
2238 cupsFilePrintf(fp
, "KOctets %d\n", job
->koctets
);
2239 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
2240 for (i
= 0; i
< job
->num_files
; i
++)
2241 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
2242 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
2243 cupsFilePuts(fp
, "</Job>\n");
2246 cupsdCloseCreatedConfFile(fp
, filename
);
2251 * 'cupsdSaveJob()' - Save a job to disk.
2255 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
2257 char filename
[1024]; /* Job control filename */
2258 cups_file_t
*fp
; /* Job file */
2261 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2262 job
, job
->id
, job
->attrs
);
2264 if (job
->printer
&& job
->printer
->temporary
)
2267 * Don't save jobs on temporary printers...
2274 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
2276 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
& 0600)) == NULL
)
2279 fchown(cupsFileNumber(fp
), RunUser
, Group
);
2281 job
->attrs
->state
= IPP_IDLE
;
2283 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
2284 job
->attrs
) != IPP_DATA
)
2286 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to write job control file.");
2291 if (!cupsdCloseCreatedConfFile(fp
, filename
))
2294 * Remove backup file and mark this job as clean...
2297 strlcat(filename
, ".O", sizeof(filename
));
2306 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2310 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
2311 const char *when
, /* I - When to resume */
2312 int update
)/* I - Update job-hold-until attr? */
2314 time_t curtime
; /* Current time */
2315 struct tm
*curdate
; /* Current date */
2316 int hour
; /* Hold hour */
2317 int minute
; /* Hold minute */
2318 int second
= 0; /* Hold second */
2321 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2322 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2323 job
, job
->id
, when
, update
);
2328 * Update the job-hold-until attribute...
2331 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2333 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2334 IPP_TAG_KEYWORD
)) == NULL
)
2335 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2338 ippSetString(job
->attrs
, &attr
, 0, when
);
2340 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2341 "job-hold-until", NULL
, when
);
2345 if (isdigit(when
[0] & 255))
2346 attr
->value_tag
= IPP_TAG_NAME
;
2348 attr
->value_tag
= IPP_TAG_KEYWORD
;
2351 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2356 if (strcmp(when
, "no-hold"))
2357 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-hold-until-specified");
2359 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
2362 * Update the hold time...
2365 job
->cancel_time
= 0;
2367 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2370 * Hold indefinitely...
2373 job
->hold_until
= 0;
2375 if (MaxHoldTime
> 0)
2376 job
->cancel_time
= time(NULL
) + MaxHoldTime
;
2378 else if (!strcmp(when
, "day-time"))
2381 * Hold to 6am the next morning unless local time is < 6pm.
2384 curtime
= time(NULL
);
2385 curdate
= localtime(&curtime
);
2387 if (curdate
->tm_hour
< 18)
2388 job
->hold_until
= curtime
;
2390 job
->hold_until
= curtime
+
2391 ((29 - curdate
->tm_hour
) * 60 + 59 -
2392 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2394 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2397 * Hold to 6pm unless local time is > 6pm or < 6am.
2400 curtime
= time(NULL
);
2401 curdate
= localtime(&curtime
);
2403 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2404 job
->hold_until
= curtime
;
2406 job
->hold_until
= curtime
+
2407 ((17 - curdate
->tm_hour
) * 60 + 59 -
2408 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2410 else if (!strcmp(when
, "second-shift"))
2413 * Hold to 4pm unless local time is > 4pm.
2416 curtime
= time(NULL
);
2417 curdate
= localtime(&curtime
);
2419 if (curdate
->tm_hour
>= 16)
2420 job
->hold_until
= curtime
;
2422 job
->hold_until
= curtime
+
2423 ((15 - curdate
->tm_hour
) * 60 + 59 -
2424 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2426 else if (!strcmp(when
, "third-shift"))
2429 * Hold to 12am unless local time is < 8am.
2432 curtime
= time(NULL
);
2433 curdate
= localtime(&curtime
);
2435 if (curdate
->tm_hour
< 8)
2436 job
->hold_until
= curtime
;
2438 job
->hold_until
= curtime
+
2439 ((23 - curdate
->tm_hour
) * 60 + 59 -
2440 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2442 else if (!strcmp(when
, "weekend"))
2445 * Hold to weekend unless we are in the weekend.
2448 curtime
= time(NULL
);
2449 curdate
= localtime(&curtime
);
2451 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2452 job
->hold_until
= curtime
;
2454 job
->hold_until
= curtime
+
2455 (((5 - curdate
->tm_wday
) * 24 +
2456 (17 - curdate
->tm_hour
)) * 60 + 59 -
2457 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2459 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2462 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2465 curtime
= time(NULL
);
2466 curdate
= gmtime(&curtime
);
2468 job
->hold_until
= curtime
+
2469 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2470 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2473 * Hold until next day as needed...
2476 if (job
->hold_until
< curtime
)
2477 job
->hold_until
+= 24 * 60 * 60;
2480 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2481 (int)job
->hold_until
);
2486 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2487 * the list as needed.
2491 cupsdSetJobPriority(
2492 cupsd_job_t
*job
, /* I - Job ID */
2493 int priority
) /* I - New priority (0 to 100) */
2495 ipp_attribute_t
*attr
; /* Job attribute */
2499 * Don't change completed jobs...
2502 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2506 * Set the new priority and re-add the job into the active list...
2509 cupsArrayRemove(ActiveJobs
, job
);
2511 job
->priority
= priority
;
2513 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2514 IPP_TAG_INTEGER
)) != NULL
)
2515 attr
->values
[0].integer
= priority
;
2517 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2520 cupsArrayAdd(ActiveJobs
, job
);
2523 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2528 * 'cupsdSetJobState()' - Set the state of the specified print job.
2533 cupsd_job_t
*job
, /* I - Job to cancel */
2534 ipp_jstate_t newstate
, /* I - New job state */
2535 cupsd_jobaction_t action
, /* I - Action to take */
2536 const char *message
, /* I - Message to log */
2537 ...) /* I - Additional arguments as needed */
2539 int i
; /* Looping var */
2540 ipp_jstate_t oldstate
; /* Old state */
2541 char filename
[1024]; /* Job filename */
2542 ipp_attribute_t
*attr
; /* Job attribute */
2545 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2546 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2547 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2548 newstate
, action
, message
? message
: "(null)");
2552 * Make sure we have the job attributes...
2555 if (!cupsdLoadJob(job
))
2559 * Don't do anything if the state is unchanged and we aren't purging the
2563 oldstate
= job
->state_value
;
2564 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2568 * Stop any processes that are working on the current job...
2571 if (oldstate
== IPP_JOB_PROCESSING
)
2572 stop_job(job
, action
);
2575 * Set the new job state...
2578 job
->state_value
= newstate
;
2581 job
->state
->values
[0].integer
= newstate
;
2585 case IPP_JOB_PENDING
:
2587 * Update job-hold-until as needed...
2590 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2591 IPP_TAG_KEYWORD
)) == NULL
)
2592 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2596 ippSetValueTag(job
->attrs
, &attr
, IPP_TAG_KEYWORD
);
2597 ippSetString(job
->attrs
, &attr
, 0, "no-hold");
2603 case IPP_JOB_ABORTED
:
2604 case IPP_JOB_CANCELED
:
2605 case IPP_JOB_COMPLETED
:
2606 set_time(job
, "time-at-completed");
2607 ippSetString(job
->attrs
, &job
->reasons
, 0, "processing-to-stop-point");
2612 * Log message as needed...
2617 char buffer
[2048]; /* Message buffer */
2618 va_list ap
; /* Pointer to additional arguments */
2620 va_start(ap
, message
);
2621 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2624 if (newstate
> IPP_JOB_STOPPED
)
2625 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2627 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2629 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2630 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2632 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2636 * Handle post-state-change actions...
2641 case IPP_JOB_PROCESSING
:
2643 * Add the job to the "printing" list...
2646 if (!cupsArrayFind(PrintingJobs
, job
))
2647 cupsArrayAdd(PrintingJobs
, job
);
2650 * Set the processing time...
2653 set_time(job
, "time-at-processing");
2655 case IPP_JOB_PENDING
:
2657 case IPP_JOB_STOPPED
:
2659 * Make sure the job is in the active list...
2662 if (!cupsArrayFind(ActiveJobs
, job
))
2663 cupsArrayAdd(ActiveJobs
, job
);
2666 * Save the job state to disk...
2670 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2673 case IPP_JOB_ABORTED
:
2674 case IPP_JOB_CANCELED
:
2675 case IPP_JOB_COMPLETED
:
2676 if (newstate
== IPP_JOB_CANCELED
)
2679 * Remove the job from the active list if there are no processes still
2683 for (i
= 0; job
->filters
[i
] < 0; i
++);
2685 if (!job
->filters
[i
] && job
->backend
<= 0)
2686 cupsArrayRemove(ActiveJobs
, job
);
2691 * Otherwise just remove the job from the active list immediately...
2694 cupsArrayRemove(ActiveJobs
, job
);
2698 * Expire job subscriptions since the job is now "completed"...
2701 cupsdExpireSubscriptions(NULL
, job
);
2705 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2706 * sleep to happen immediately...
2709 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2711 #endif /* __APPLE__ */
2714 * Remove any authentication data...
2717 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2718 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2719 cupsdLogMessage(CUPSD_LOG_ERROR
,
2720 "Unable to remove authentication cache: %s",
2724 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
2726 cupsdClearString(job
->auth_env
+ i
);
2728 cupsdClearString(&job
->auth_uid
);
2731 * Remove the print file for good if we aren't preserving jobs or
2735 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2736 remove_job_files(job
);
2738 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2741 * Save job state info...
2745 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2747 else if (!job
->printer
)
2750 * Delete the job immediately if not actively printing...
2753 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2760 * Finalize the job immediately if we forced things...
2763 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2764 finalize_job(job
, 0);
2767 * Update the server "busy" state...
2770 cupsdSetBusyState();
2775 * 'cupsdStopAllJobs()' - Stop all print jobs.
2780 cupsd_jobaction_t action
, /* I - Action */
2781 int kill_delay
) /* I - Number of seconds before we kill */
2783 cupsd_job_t
*job
; /* Current job */
2786 DEBUG_puts("cupsdStopAllJobs()");
2788 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2790 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2794 cupsdSetJobState(job
, IPP_JOB_COMPLETED
, CUPSD_JOB_FORCE
, NULL
);
2799 job
->kill_time
= time(NULL
) + kill_delay
;
2801 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2808 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2812 cupsdUnloadCompletedJobs(void)
2814 cupsd_job_t
*job
; /* Current job */
2815 time_t expire
; /* Expiration time */
2818 expire
= time(NULL
) - 60;
2820 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2822 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2823 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2824 job
->access_time
< expire
)
2836 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2840 cupsdUpdateJobs(void)
2842 cupsd_job_t
*job
; /* Current job */
2843 time_t curtime
; /* Current time */
2844 ipp_attribute_t
*attr
; /* time-at-completed attribute */
2847 curtime
= time(NULL
);
2848 JobHistoryUpdate
= 0;
2850 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2852 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2854 if (job
->state_value
>= IPP_JOB_CANCELED
&&
2855 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
2856 IPP_TAG_INTEGER
)) != NULL
)
2859 * Update history/file expiration times...
2862 if (JobHistory
< INT_MAX
)
2863 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
2865 job
->history_time
= INT_MAX
;
2867 if (job
->history_time
< curtime
)
2869 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2873 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2874 JobHistoryUpdate
= job
->history_time
;
2876 if (JobFiles
< INT_MAX
)
2877 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
2879 job
->file_time
= INT_MAX
;
2881 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2882 JobHistoryUpdate
= job
->file_time
;
2886 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdUpdateAllJobs: JobHistoryUpdate=%ld",
2887 (long)JobHistoryUpdate
);
2892 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2895 static int /* O - Difference */
2896 compare_active_jobs(void *first
, /* I - First job */
2897 void *second
, /* I - Second job */
2898 void *data
) /* I - App data (not used) */
2900 int diff
; /* Difference */
2905 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2906 ((cupsd_job_t
*)first
)->priority
) != 0)
2909 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2914 * 'compare_completed_jobs()' - Compare the job IDs and completion times of two jobs.
2917 static int /* O - Difference */
2918 compare_completed_jobs(void *first
, /* I - First job */
2919 void *second
, /* I - Second job */
2920 void *data
) /* I - App data (not used) */
2922 int diff
; /* Difference */
2927 if ((diff
= ((cupsd_job_t
*)second
)->completed_time
-
2928 ((cupsd_job_t
*)first
)->completed_time
) != 0)
2931 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2936 * 'compare_jobs()' - Compare the job IDs of two jobs.
2939 static int /* O - Difference */
2940 compare_jobs(void *first
, /* I - First job */
2941 void *second
, /* I - Second job */
2942 void *data
) /* I - App data (not used) */
2946 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2951 * 'dump_job_history()' - Dump any debug messages for a job.
2955 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2957 int i
, /* Looping var */
2958 oldsize
; /* Current MaxLogSize */
2959 struct tm
*date
; /* Date/time value */
2960 cupsd_joblog_t
*message
; /* Current message */
2961 char temp
[2048], /* Log message */
2962 *ptr
, /* Pointer into log message */
2963 start
[256], /* Start time */
2964 end
[256]; /* End time */
2965 cupsd_printer_t
*printer
; /* Printer for job */
2969 * See if we have anything to dump...
2976 * Disable log rotation temporarily...
2979 oldsize
= MaxLogSize
;
2983 * Copy the debug messages to the log...
2986 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2987 date
= localtime(&(message
->time
));
2988 strftime(start
, sizeof(start
), "%X", date
);
2990 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2991 date
= localtime(&(message
->time
));
2992 strftime(end
, sizeof(end
), "%X", date
);
2994 snprintf(temp
, sizeof(temp
),
2995 "[Job %d] The following messages were recorded from %s to %s",
2996 job
->id
, start
, end
);
2997 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2999 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
3001 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
3002 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
3004 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
3005 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3008 * Log the printer state values...
3011 if ((printer
= job
->printer
) == NULL
)
3012 printer
= cupsdFindDest(job
->dest
);
3016 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
3018 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
3019 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
3021 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3023 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
3024 job
->id
, printer
->state_message
);
3025 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3027 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
3028 ptr
= temp
+ strlen(temp
);
3029 if (printer
->num_reasons
== 0)
3030 strlcpy(ptr
, "none", sizeof(temp
) - (size_t)(ptr
- temp
));
3034 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
3040 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (size_t)(ptr
- temp
));
3044 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3048 * Restore log file rotation...
3051 MaxLogSize
= oldsize
;
3054 * Free all messages...
3057 free_job_history(job
);
3062 * 'free_job_history()' - Free any log history.
3066 free_job_history(cupsd_job_t
*job
) /* I - Job */
3068 char *message
; /* Current message */
3074 for (message
= (char *)cupsArrayFirst(job
->history
);
3076 message
= (char *)cupsArrayNext(job
->history
))
3079 cupsArrayDelete(job
->history
);
3080 job
->history
= NULL
;
3085 * 'finalize_job()' - Cleanup after job filter processes and support data.
3089 finalize_job(cupsd_job_t
*job
, /* I - Job */
3090 int set_job_state
) /* I - 1 = set the job state */
3092 ipp_pstate_t printer_state
; /* New printer state value */
3093 ipp_jstate_t job_state
; /* New job state value */
3094 const char *message
; /* Message for job state */
3095 char buffer
[1024]; /* Buffer for formatted messages */
3098 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
3101 * Clear the "connecting-to-device" and "cups-waiting-for-job-completed"
3102 * reasons, which are only valid when a printer is processing, along with any
3103 * remote printing job state...
3106 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device,"
3107 "cups-waiting-for-job-completed,"
3108 "cups-remote-pending,"
3109 "cups-remote-pending-held,"
3110 "cups-remote-processing,"
3111 "cups-remote-stopped,"
3112 "cups-remote-canceled,"
3113 "cups-remote-aborted,"
3114 "cups-remote-completed");
3117 * Similarly, clear the "offline-report" reason for non-USB devices since we
3118 * rarely have current information for network devices...
3121 if (strncmp(job
->printer
->device_uri
, "usb:", 4) &&
3122 strncmp(job
->printer
->device_uri
, "ippusb:", 7))
3123 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
3126 * Free the security profile...
3129 cupsdDestroyProfile(job
->profile
);
3130 job
->profile
= NULL
;
3131 cupsdDestroyProfile(job
->bprofile
);
3132 job
->bprofile
= NULL
;
3135 * Clear the unresponsive job watchdog timers...
3138 job
->cancel_time
= 0;
3142 * Close pipes and status buffer...
3145 cupsdClosePipe(job
->print_pipes
);
3146 cupsdClosePipe(job
->back_pipes
);
3147 cupsdClosePipe(job
->side_pipes
);
3149 cupsdRemoveSelect(job
->status_pipes
[0]);
3150 cupsdClosePipe(job
->status_pipes
);
3151 cupsdStatBufDelete(job
->status_buffer
);
3152 job
->status_buffer
= NULL
;
3155 * Process the exit status...
3158 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
3159 printer_state
= IPP_PRINTER_IDLE
;
3161 printer_state
= job
->printer
->state
;
3163 switch (job_state
= job
->state_value
)
3165 case IPP_JOB_PENDING
:
3166 message
= "Job paused.";
3170 message
= "Job held.";
3174 case IPP_JOB_PROCESSING
:
3175 case IPP_JOB_COMPLETED
:
3176 job_state
= IPP_JOB_COMPLETED
;
3177 message
= "Job completed.";
3180 ippSetString(job
->attrs
, &job
->reasons
, 0,
3181 "job-completed-successfully");
3184 case IPP_JOB_STOPPED
:
3185 message
= "Job stopped.";
3187 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-stopped");
3190 case IPP_JOB_CANCELED
:
3191 message
= "Job canceled.";
3193 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-canceled-by-user");
3196 case IPP_JOB_ABORTED
:
3197 message
= "Job aborted.";
3201 if (job
->status
< 0)
3204 * Backend had errors...
3207 int exit_code
; /* Exit code from backend */
3210 * Convert the status to an exit code. Due to the way the W* macros are
3211 * implemented on MacOS X (bug?), we have to store the exit status in a
3212 * variable first and then convert...
3215 exit_code
= -job
->status
;
3216 if (WIFEXITED(exit_code
))
3217 exit_code
= WEXITSTATUS(exit_code
);
3220 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-backend-crashed");
3221 exit_code
= job
->status
;
3224 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
3226 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
3227 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
3228 "authentication required" :
3229 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
3230 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
3231 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
3232 exit_code
== CUPS_BACKEND_RETRY
? "retry job later" :
3233 exit_code
== CUPS_BACKEND_RETRY_CURRENT
? "retry job immediately" :
3234 exit_code
< 0 ? "crashed" : "unknown");
3237 * Do what needs to be done...
3243 case CUPS_BACKEND_FAILED
:
3245 * Backend failure, use the error-policy to determine how to
3249 if (job
->dtype
& CUPS_PRINTER_CLASS
)
3252 * Queued on a class - mark the job as pending and we'll retry on
3253 * another printer...
3256 if (job_state
== IPP_JOB_COMPLETED
)
3258 job_state
= IPP_JOB_PENDING
;
3259 message
= "Retrying job on another printer.";
3261 ippSetString(job
->attrs
, &job
->reasons
, 0,
3262 "resources-are-not-ready");
3265 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
3268 * The error policy is "retry-current-job" - mark the job as pending
3269 * and we'll retry on the same printer...
3272 if (job_state
== IPP_JOB_COMPLETED
)
3274 job_state
= IPP_JOB_PENDING
;
3275 message
= "Retrying job on same printer.";
3277 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3280 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
3281 !strcmp(job
->printer
->error_policy
, "retry-job"))
3283 if (job_state
== IPP_JOB_COMPLETED
)
3286 * The job was queued on a fax or the error policy is "retry-job" -
3287 * hold the job if the number of retries is less than the
3288 * JobRetryLimit, otherwise abort the job.
3293 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3299 snprintf(buffer
, sizeof(buffer
),
3300 "Job aborted after %d unsuccessful attempts.",
3302 job_state
= IPP_JOB_ABORTED
;
3305 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3310 * Try again in N seconds...
3313 snprintf(buffer
, sizeof(buffer
),
3314 "Job held for %d seconds since it could not be sent.",
3317 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3318 job_state
= IPP_JOB_HELD
;
3321 ippSetString(job
->attrs
, &job
->reasons
, 0,
3322 "resources-are-not-ready");
3326 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
3327 job_state
== IPP_JOB_COMPLETED
)
3329 job_state
= IPP_JOB_ABORTED
;
3330 message
= "Job aborted due to backend errors; please consult "
3331 "the error_log file for details.";
3333 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3335 else if (job
->state_value
== IPP_JOB_PROCESSING
)
3337 job_state
= IPP_JOB_PENDING
;
3338 printer_state
= IPP_PRINTER_STOPPED
;
3339 message
= "Printer stopped due to backend errors; please "
3340 "consult the error_log file for details.";
3342 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3346 case CUPS_BACKEND_CANCEL
:
3351 if (job_state
== IPP_JOB_COMPLETED
)
3353 job_state
= IPP_JOB_CANCELED
;
3354 message
= "Job canceled at printer.";
3356 ippSetString(job
->attrs
, &job
->reasons
, 0, "canceled-at-device");
3360 case CUPS_BACKEND_HOLD
:
3361 if (job_state
== IPP_JOB_COMPLETED
)
3367 const char *reason
= ippGetString(job
->reasons
, 0, NULL
);
3369 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-state-reasons=\"%s\"",
3372 if (!reason
|| strncmp(reason
, "account-", 8))
3374 cupsdSetJobHoldUntil(job
, "indefinite", 1);
3376 ippSetString(job
->attrs
, &job
->reasons
, 0,
3377 "job-hold-until-specified");
3378 message
= "Job held indefinitely due to backend errors; please "
3379 "consult the error_log file for details.";
3381 else if (!strcmp(reason
, "account-info-needed"))
3383 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3385 message
= "Job held indefinitely - account information is "
3388 else if (!strcmp(reason
, "account-closed"))
3390 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3392 message
= "Job held indefinitely - account has been closed.";
3394 else if (!strcmp(reason
, "account-limit-reached"))
3396 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3398 message
= "Job held indefinitely - account limit has been "
3403 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3405 message
= "Job held indefinitely - account authorization failed.";
3408 job_state
= IPP_JOB_HELD
;
3412 case CUPS_BACKEND_STOP
:
3414 * Stop the printer...
3417 printer_state
= IPP_PRINTER_STOPPED
;
3418 message
= "Printer stopped due to backend errors; please "
3419 "consult the error_log file for details.";
3421 if (job_state
== IPP_JOB_COMPLETED
)
3423 job_state
= IPP_JOB_PENDING
;
3425 ippSetString(job
->attrs
, &job
->reasons
, 0,
3426 "resources-are-not-ready");
3430 case CUPS_BACKEND_AUTH_REQUIRED
:
3432 * Hold the job for authentication...
3435 if (job_state
== IPP_JOB_COMPLETED
)
3437 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
3439 job_state
= IPP_JOB_HELD
;
3440 message
= "Job held for authentication.";
3442 if (strncmp(job
->reasons
->values
[0].string
.text
, "account-", 8))
3443 ippSetString(job
->attrs
, &job
->reasons
, 0,
3444 "cups-held-for-authentication");
3448 case CUPS_BACKEND_RETRY
:
3449 if (job_state
== IPP_JOB_COMPLETED
)
3452 * Hold the job if the number of retries is less than the
3453 * JobRetryLimit, otherwise abort the job.
3458 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3464 snprintf(buffer
, sizeof(buffer
),
3465 "Job aborted after %d unsuccessful attempts.",
3467 job_state
= IPP_JOB_ABORTED
;
3470 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3475 * Try again in N seconds...
3478 snprintf(buffer
, sizeof(buffer
),
3479 "Job held for %d seconds since it could not be sent.",
3482 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3483 job_state
= IPP_JOB_HELD
;
3486 ippSetString(job
->attrs
, &job
->reasons
, 0,
3487 "resources-are-not-ready");
3492 case CUPS_BACKEND_RETRY_CURRENT
:
3494 * Mark the job as pending and retry on the same printer...
3497 if (job_state
== IPP_JOB_COMPLETED
)
3499 job_state
= IPP_JOB_PENDING
;
3500 message
= "Retrying job on same printer.";
3502 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3507 else if (job
->status
> 0)
3510 * Filter had errors; stop job...
3513 if (job_state
== IPP_JOB_COMPLETED
)
3515 job_state
= IPP_JOB_STOPPED
;
3516 message
= "Job stopped due to filter errors; please consult the "
3517 "error_log file for details.";
3519 if (WIFSIGNALED(job
->status
))
3520 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-filter-crashed");
3522 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-completed-with-errors");
3527 * Update the printer and job state.
3530 if (set_job_state
&& job_state
!= job
->state_value
)
3531 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
3533 cupsdSetPrinterState(job
->printer
, printer_state
,
3534 printer_state
== IPP_PRINTER_STOPPED
);
3535 update_job_attrs(job
, 0);
3540 (job
->state_value
== IPP_JOB_ABORTED
||
3541 job
->state_value
== IPP_JOB_STOPPED
))
3542 dump_job_history(job
);
3544 free_job_history(job
);
3547 cupsArrayRemove(PrintingJobs
, job
);
3550 * Apply any PPD updates...
3553 if (job
->num_keywords
)
3555 if (cupsdUpdatePrinterPPD(job
->printer
, job
->num_keywords
, job
->keywords
))
3556 cupsdSetPrinterAttrs(job
->printer
);
3558 cupsFreeOptions(job
->num_keywords
, job
->keywords
);
3560 job
->num_keywords
= 0;
3561 job
->keywords
= NULL
;
3565 * Clear the printer <-> job association...
3568 job
->printer
->job
= NULL
;
3569 job
->printer
= NULL
;
3574 * 'get_options()' - Get a string containing the job options.
3577 static char * /* O - Options string */
3578 get_options(cupsd_job_t
*job
, /* I - Job */
3579 int banner_page
, /* I - Printing a banner page? */
3580 char *copies
, /* I - Copies buffer */
3581 size_t copies_size
, /* I - Size of copies buffer */
3582 char *title
, /* I - Title buffer */
3583 size_t title_size
) /* I - Size of title buffer */
3585 int i
; /* Looping var */
3586 size_t newlength
; /* New option buffer length */
3587 char *optptr
, /* Pointer to options */
3588 *valptr
; /* Pointer in value string */
3589 ipp_attribute_t
*attr
; /* Current attribute */
3590 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3591 int num_pwgppds
; /* Number of PWG->PPD options */
3592 cups_option_t
*pwgppds
, /* PWG->PPD options */
3593 *pwgppd
, /* Current PWG->PPD option */
3594 *preset
; /* Current preset option */
3595 int print_color_mode
,
3596 /* Output mode (if any) */
3597 print_quality
; /* Print quality (if any) */
3598 const char *ppd
; /* PPD option choice */
3599 int exact
; /* Did we get an exact match? */
3600 static char *options
= NULL
;/* Full list of options */
3601 static size_t optlength
= 0; /* Length of option buffer */
3605 * Building the options string is harder than it needs to be, but for the
3606 * moment we need to pass strings for command-line args and not IPP attribute
3609 * First build an options array for any PWG->PPD mapped option/choice pairs.
3612 pc
= job
->printer
->pc
;
3617 !ippFindAttribute(job
->attrs
,
3618 "com.apple.print.DocumentTicket.PMSpoolFormat",
3620 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3621 (ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) ||
3622 ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
)))
3625 * Map print-color-mode and print-quality to a preset...
3628 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3629 IPP_TAG_KEYWORD
)) != NULL
&&
3630 !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3631 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3633 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3635 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality",
3636 IPP_TAG_ENUM
)) != NULL
&&
3637 attr
->values
[0].integer
>= IPP_QUALITY_DRAFT
&&
3638 attr
->values
[0].integer
<= IPP_QUALITY_HIGH
)
3639 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3641 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3643 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3646 * Try to find a preset that works so that we maximize the chances of us
3647 * getting a good print using IPP attributes.
3650 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3651 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3652 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3653 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3656 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3657 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3661 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3664 * Copy the preset options as long as the corresponding names are not
3665 * already defined in the IPP request...
3668 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3669 preset
= pc
->presets
[print_color_mode
][print_quality
];
3673 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3674 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
,
3682 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3683 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3685 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3686 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3689 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3690 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3691 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3693 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3694 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3695 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3697 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3699 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3700 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3703 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3704 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3705 IPP_TAG_ZERO
)) != NULL
&&
3706 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3707 attr
->value_tag
== IPP_TAG_NAME
) &&
3708 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3711 * Map output-bin to OutputBin option...
3714 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3717 if (pc
->sides_option
&&
3718 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3719 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3722 * Map sides to duplex option...
3725 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3726 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
,
3727 num_pwgppds
, &pwgppds
);
3728 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3729 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
,
3730 num_pwgppds
, &pwgppds
);
3731 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3732 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
,
3733 num_pwgppds
, &pwgppds
);
3737 * Map finishings values...
3740 num_pwgppds
= _ppdCacheGetFinishingOptions(pc
, job
->attrs
,
3741 IPP_FINISHINGS_NONE
, num_pwgppds
,
3746 * Figure out how much room we need...
3749 newlength
= ipp_length(job
->attrs
);
3751 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3752 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3755 * Then allocate/reallocate the option buffer as needed...
3758 if (newlength
== 0) /* This can never happen, but Clang */
3759 newlength
= 1; /* thinks it can... */
3761 if (newlength
> optlength
|| !options
)
3764 optptr
= malloc(newlength
);
3766 optptr
= realloc(options
, newlength
);
3770 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3771 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer.",
3772 CUPS_LLCAST newlength
);
3777 optlength
= newlength
;
3781 * Now loop through the attributes and convert them to the textual
3782 * representation used by the filters...
3788 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3789 strlcpy(copies
, "1", copies_size
);
3791 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3793 if (!strcmp(attr
->name
, "copies") &&
3794 attr
->value_tag
== IPP_TAG_INTEGER
)
3797 * Don't use the # copies attribute if we are printing the job sheets...
3801 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3803 else if (!strcmp(attr
->name
, "job-name") &&
3804 (attr
->value_tag
== IPP_TAG_NAME
||
3805 attr
->value_tag
== IPP_TAG_NAMELANG
))
3806 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3807 else if (attr
->group_tag
== IPP_TAG_JOB
)
3810 * Filter out other unwanted attributes...
3813 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3814 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3815 attr
->value_tag
== IPP_TAG_NAMELANG
||
3816 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3817 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid") &&
3818 strcmp(attr
->name
, "job-authorization-uri")) ||
3819 attr
->value_tag
== IPP_TAG_URISCHEME
||
3820 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3823 if (!strcmp(attr
->name
, "job-hold-until") ||
3824 !strcmp(attr
->name
, "job-id") ||
3825 !strcmp(attr
->name
, "job-k-octets") ||
3826 !strcmp(attr
->name
, "job-media-sheets") ||
3827 !strcmp(attr
->name
, "job-media-sheets-completed") ||
3828 !strcmp(attr
->name
, "job-state") ||
3829 !strcmp(attr
->name
, "job-state-reasons"))
3832 if (!strncmp(attr
->name
, "job-", 4) &&
3833 strcmp(attr
->name
, "job-account-id") &&
3834 strcmp(attr
->name
, "job-accounting-user-id") &&
3835 strcmp(attr
->name
, "job-authorization-uri") &&
3836 strcmp(attr
->name
, "job-billing") &&
3837 strcmp(attr
->name
, "job-impressions") &&
3838 strcmp(attr
->name
, "job-originating-host-name") &&
3839 strcmp(attr
->name
, "job-password") &&
3840 strcmp(attr
->name
, "job-password-encryption") &&
3841 strcmp(attr
->name
, "job-uuid") &&
3842 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3845 if ((!strcmp(attr
->name
, "job-impressions") ||
3846 !strcmp(attr
->name
, "page-label") ||
3847 !strcmp(attr
->name
, "page-border") ||
3848 !strncmp(attr
->name
, "number-up", 9) ||
3849 !strcmp(attr
->name
, "page-ranges") ||
3850 !strcmp(attr
->name
, "page-set") ||
3851 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3852 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3853 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3854 "PMTotalSidesImaged..n.") ||
3855 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3856 "PMTotalBeginPages..n.")) &&
3861 * Otherwise add them to the list...
3864 if (optptr
> options
)
3865 strlcat(optptr
, " ", optlength
- (size_t)(optptr
- options
));
3867 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3869 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
3870 strlcat(optptr
, "=", optlength
- (size_t)(optptr
- options
));
3873 for (i
= 0; i
< attr
->num_values
; i
++)
3876 strlcat(optptr
, ",", optlength
- (size_t)(optptr
- options
));
3878 optptr
+= strlen(optptr
);
3880 switch (attr
->value_tag
)
3882 case IPP_TAG_INTEGER
:
3884 snprintf(optptr
, optlength
- (size_t)(optptr
- options
),
3885 "%d", attr
->values
[i
].integer
);
3888 case IPP_TAG_BOOLEAN
:
3889 if (!attr
->values
[i
].boolean
)
3890 strlcat(optptr
, "no", optlength
- (size_t)(optptr
- options
));
3892 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
3895 case IPP_TAG_RANGE
:
3896 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3897 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3898 "%d", attr
->values
[i
].range
.lower
);
3900 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3901 "%d-%d", attr
->values
[i
].range
.lower
,
3902 attr
->values
[i
].range
.upper
);
3905 case IPP_TAG_RESOLUTION
:
3906 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3907 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
3908 attr
->values
[i
].resolution
.yres
,
3909 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
3913 case IPP_TAG_STRING
:
3916 case IPP_TAG_KEYWORD
:
3917 case IPP_TAG_CHARSET
:
3918 case IPP_TAG_LANGUAGE
:
3920 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
3922 if (strchr(" \t\n\\\'\"", *valptr
))
3924 *optptr
++ = *valptr
++;
3931 break; /* anti-compiler-warning-code */
3935 optptr
+= strlen(optptr
);
3940 * Finally loop through the PWG->PPD mapped options and add them...
3943 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3946 strlcpy(optptr
, pwgppd
->name
, optlength
- (size_t)(optptr
- options
));
3947 optptr
+= strlen(optptr
);
3949 strlcpy(optptr
, pwgppd
->value
, optlength
- (size_t)(optptr
- options
));
3950 optptr
+= strlen(optptr
);
3953 cupsFreeOptions(num_pwgppds
, pwgppds
);
3956 * Return the options string...
3964 * 'ipp_length()' - Compute the size of the buffer needed to hold
3965 * the textual IPP attributes.
3968 static size_t /* O - Size of attribute buffer */
3969 ipp_length(ipp_t
*ipp
) /* I - IPP request */
3971 size_t bytes
; /* Number of bytes */
3972 int i
; /* Looping var */
3973 ipp_attribute_t
*attr
; /* Current attribute */
3977 * Loop through all attributes...
3982 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3985 * Skip attributes that won't be sent to filters...
3988 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3989 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3990 attr
->value_tag
== IPP_TAG_NAMELANG
||
3991 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3992 attr
->value_tag
== IPP_TAG_URI
||
3993 attr
->value_tag
== IPP_TAG_URISCHEME
)
3997 * Add space for a leading space and commas between each value.
3998 * For the first attribute, the leading space isn't used, so the
3999 * extra byte can be used as the nul terminator...
4002 bytes
++; /* " " separator */
4003 bytes
+= (size_t)attr
->num_values
; /* "," separators */
4006 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
4007 * other attributes appear as "foo=value1,value2,...,valueN".
4010 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
4011 bytes
+= strlen(attr
->name
);
4013 bytes
+= (size_t)attr
->num_values
* strlen(attr
->name
);
4016 * Now add the size required for each value in the attribute...
4019 switch (attr
->value_tag
)
4021 case IPP_TAG_INTEGER
:
4024 * Minimum value of a signed integer is -2147483647, or 11 digits.
4027 bytes
+= (size_t)attr
->num_values
* 11;
4030 case IPP_TAG_BOOLEAN
:
4032 * Add two bytes for each false ("no") value...
4035 for (i
= 0; i
< attr
->num_values
; i
++)
4036 if (!attr
->values
[i
].boolean
)
4040 case IPP_TAG_RANGE
:
4042 * A range is two signed integers separated by a hyphen, or
4043 * 23 characters max.
4046 bytes
+= (size_t)attr
->num_values
* 23;
4049 case IPP_TAG_RESOLUTION
:
4051 * A resolution is two signed integers separated by an "x" and
4052 * suffixed by the units, or 26 characters max.
4055 bytes
+= (size_t)attr
->num_values
* 26;
4058 case IPP_TAG_STRING
:
4061 case IPP_TAG_KEYWORD
:
4062 case IPP_TAG_CHARSET
:
4063 case IPP_TAG_LANGUAGE
:
4066 * Strings can contain characters that need quoting. We need
4067 * at least 2 * len + 2 characters to cover the quotes and
4068 * any backslashes in the string.
4071 for (i
= 0; i
< attr
->num_values
; i
++)
4072 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
4076 break; /* anti-compiler-warning-code */
4085 * 'load_job_cache()' - Load jobs from the job.cache file.
4089 load_job_cache(const char *filename
) /* I - job.cache filename */
4091 cups_file_t
*fp
; /* job.cache file */
4092 char line
[1024], /* Line buffer */
4093 *value
; /* Value on line */
4094 int linenum
; /* Line number in file */
4095 cupsd_job_t
*job
; /* Current job */
4096 int jobid
; /* Job ID */
4097 char jobfile
[1024]; /* Job filename */
4101 * Open the job.cache file...
4104 if ((fp
= cupsdOpenConfFile(filename
)) == NULL
)
4106 load_request_root();
4111 * Read entries from the job cache file and create jobs as needed.
4114 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
4120 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4122 if (!_cups_strcasecmp(line
, "NextJobId"))
4125 NextJobId
= atoi(value
);
4127 else if (!_cups_strcasecmp(line
, "<Job"))
4131 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d of %s.", linenum
, filename
);
4137 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d of %s.", linenum
, filename
);
4141 jobid
= atoi(value
);
4145 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d of %s.", jobid
, linenum
, filename
);
4149 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
4150 if (access(jobfile
, 0))
4152 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d.N", RequestRoot
, jobid
);
4153 if (access(jobfile
, 0))
4155 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away.",
4159 * job.cache file is out-of-date compared to spool directory; load
4164 load_request_root();
4169 job
= calloc(1, sizeof(cupsd_job_t
));
4172 cupsdLogMessage(CUPSD_LOG_EMERG
,
4173 "[Job %d] Unable to allocate memory for job.", jobid
);
4178 job
->back_pipes
[0] = -1;
4179 job
->back_pipes
[1] = -1;
4180 job
->print_pipes
[0] = -1;
4181 job
->print_pipes
[1] = -1;
4182 job
->side_pipes
[0] = -1;
4183 job
->side_pipes
[1] = -1;
4184 job
->status_pipes
[0] = -1;
4185 job
->status_pipes
[1] = -1;
4187 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading from cache...");
4191 cupsdLogMessage(CUPSD_LOG_ERROR
,
4192 "Missing <Job #> directive on line %d of %s.", linenum
, filename
);
4195 else if (!_cups_strcasecmp(line
, "</Job>"))
4197 cupsArrayAdd(Jobs
, job
);
4199 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
4200 cupsArrayAdd(ActiveJobs
, job
);
4201 else if (job
->state_value
> IPP_JOB_STOPPED
)
4203 if (!job
->completed_time
|| !job
->creation_time
|| !job
->name
|| !job
->koctets
)
4214 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d of %s.", linenum
, filename
);
4217 else if (!_cups_strcasecmp(line
, "State"))
4219 job
->state_value
= (ipp_jstate_t
)atoi(value
);
4221 if (job
->state_value
< IPP_JOB_PENDING
)
4222 job
->state_value
= IPP_JOB_PENDING
;
4223 else if (job
->state_value
> IPP_JOB_COMPLETED
)
4224 job
->state_value
= IPP_JOB_COMPLETED
;
4226 else if (!_cups_strcasecmp(line
, "Name"))
4228 cupsdSetString(&(job
->name
), value
);
4230 else if (!_cups_strcasecmp(line
, "Created"))
4232 job
->creation_time
= strtol(value
, NULL
, 10);
4234 else if (!_cups_strcasecmp(line
, "Completed"))
4236 job
->completed_time
= strtol(value
, NULL
, 10);
4238 else if (!_cups_strcasecmp(line
, "HoldUntil"))
4240 job
->hold_until
= strtol(value
, NULL
, 10);
4242 else if (!_cups_strcasecmp(line
, "Priority"))
4244 job
->priority
= atoi(value
);
4246 else if (!_cups_strcasecmp(line
, "Username"))
4248 cupsdSetString(&job
->username
, value
);
4250 else if (!_cups_strcasecmp(line
, "Destination"))
4252 cupsdSetString(&job
->dest
, value
);
4254 else if (!_cups_strcasecmp(line
, "DestType"))
4256 job
->dtype
= (cups_ptype_t
)atoi(value
);
4258 else if (!_cups_strcasecmp(line
, "KOctets"))
4260 job
->koctets
= atoi(value
);
4262 else if (!_cups_strcasecmp(line
, "NumFiles"))
4264 job
->num_files
= atoi(value
);
4266 if (job
->num_files
< 0)
4268 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d of %s.", job
->num_files
, linenum
, filename
);
4273 if (job
->num_files
> 0)
4275 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
4277 if (access(jobfile
, 0))
4279 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Data files have gone away.");
4284 job
->filetypes
= calloc((size_t)job
->num_files
, sizeof(mime_type_t
*));
4285 job
->compressions
= calloc((size_t)job
->num_files
, sizeof(int));
4287 if (!job
->filetypes
|| !job
->compressions
)
4289 cupsdLogJob(job
, CUPSD_LOG_EMERG
,
4290 "Unable to allocate memory for %d files.",
4296 else if (!_cups_strcasecmp(line
, "File"))
4298 int number
, /* File number */
4299 compression
; /* Compression value */
4300 char super
[MIME_MAX_SUPER
], /* MIME super type */
4301 type
[MIME_MAX_TYPE
]; /* MIME type */
4304 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
4307 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d of %s.", linenum
, filename
);
4311 if (number
< 1 || number
> job
->num_files
)
4313 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d of %s.", number
, linenum
, filename
);
4319 job
->compressions
[number
] = compression
;
4320 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
4322 if (!job
->filetypes
[number
])
4325 * If the original MIME type is unknown, auto-type it!
4328 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
4329 "Unknown MIME type %s/%s for file %d.",
4330 super
, type
, number
+ 1);
4332 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
4333 job
->id
, number
+ 1);
4334 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
4335 job
->compressions
+ number
);
4338 * If that didn't work, assume it is raw...
4341 if (!job
->filetypes
[number
])
4342 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
4347 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d of %s.", line
, linenum
, filename
);
4352 cupsdLogMessage(CUPSD_LOG_ERROR
,
4353 "Missing </Job> directive on line %d of %s.", linenum
, filename
);
4354 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
4362 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4366 load_next_job_id(const char *filename
) /* I - job.cache filename */
4368 cups_file_t
*fp
; /* job.cache file */
4369 char line
[1024], /* Line buffer */
4370 *value
; /* Value on line */
4371 int linenum
; /* Line number in file */
4372 int next_job_id
; /* NextJobId value from line */
4376 * Read the NextJobId directive from the job.cache file and use
4377 * the value (if any).
4380 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4382 if (errno
!= ENOENT
)
4383 cupsdLogMessage(CUPSD_LOG_ERROR
,
4384 "Unable to open job cache file \"%s\": %s",
4385 filename
, strerror(errno
));
4390 cupsdLogMessage(CUPSD_LOG_INFO
,
4391 "Loading NextJobId from job cache file \"%s\"...", filename
);
4395 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4397 if (!_cups_strcasecmp(line
, "NextJobId"))
4401 next_job_id
= atoi(value
);
4403 if (next_job_id
> NextJobId
)
4404 NextJobId
= next_job_id
;
4415 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4419 load_request_root(void)
4421 cups_dir_t
*dir
; /* Directory */
4422 cups_dentry_t
*dent
; /* Directory entry */
4423 cupsd_job_t
*job
; /* New job */
4427 * Open the requests directory...
4430 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
4432 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
4434 cupsdLogMessage(CUPSD_LOG_ERROR
,
4435 "Unable to open spool directory \"%s\": %s",
4436 RequestRoot
, strerror(errno
));
4441 * Read all the c##### files...
4444 while ((dent
= cupsDirRead(dir
)) != NULL
)
4445 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
4448 * Allocate memory for the job...
4451 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
4453 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs.");
4459 * Assign the job ID...
4462 job
->id
= atoi(dent
->filename
+ 1);
4463 job
->back_pipes
[0] = -1;
4464 job
->back_pipes
[1] = -1;
4465 job
->print_pipes
[0] = -1;
4466 job
->print_pipes
[1] = -1;
4467 job
->side_pipes
[0] = -1;
4468 job
->side_pipes
[1] = -1;
4469 job
->status_pipes
[0] = -1;
4470 job
->status_pipes
[1] = -1;
4472 if (job
->id
>= NextJobId
)
4473 NextJobId
= job
->id
+ 1;
4479 if (cupsdLoadJob(job
))
4482 * Insert the job into the array, sorting by job priority and ID...
4485 cupsArrayAdd(Jobs
, job
);
4487 if (job
->state_value
<= IPP_JOB_STOPPED
)
4488 cupsArrayAdd(ActiveJobs
, job
);
4501 * 'remove_job_files()' - Remove the document files for a job.
4505 remove_job_files(cupsd_job_t
*job
) /* I - Job */
4507 int i
; /* Looping var */
4508 char filename
[1024]; /* Document filename */
4511 if (job
->num_files
<= 0)
4514 for (i
= 1; i
<= job
->num_files
; i
++)
4516 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
4518 cupsdUnlinkOrRemoveFile(filename
);
4521 free(job
->filetypes
);
4522 free(job
->compressions
);
4526 job
->filetypes
= NULL
;
4527 job
->compressions
= NULL
;
4529 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4534 * 'remove_job_history()' - Remove the control file for a job.
4538 remove_job_history(cupsd_job_t
*job
) /* I - Job */
4540 char filename
[1024]; /* Control filename */
4544 * Remove the job info file...
4547 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
4549 cupsdUnlinkOrRemoveFile(filename
);
4551 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4556 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4560 set_time(cupsd_job_t
*job
, /* I - Job to update */
4561 const char *name
) /* I - Name of attribute */
4563 char date_name
[128]; /* date-time-at-xxx */
4564 ipp_attribute_t
*attr
; /* Time attribute */
4565 time_t curtime
; /* Current time */
4568 curtime
= time(NULL
);
4570 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s=%ld", name
, (long)curtime
);
4572 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
4574 attr
->value_tag
= IPP_TAG_INTEGER
;
4575 attr
->values
[0].integer
= curtime
;
4578 snprintf(date_name
, sizeof(date_name
), "date-%s", name
);
4580 if ((attr
= ippFindAttribute(job
->attrs
, date_name
, IPP_TAG_ZERO
)) != NULL
)
4582 attr
->value_tag
= IPP_TAG_DATE
;
4583 ippSetDate(job
->attrs
, &attr
, 0, ippTimeToDate(curtime
));
4586 if (!strcmp(name
, "time-at-completed"))
4588 job
->completed_time
= curtime
;
4590 if (JobHistory
< INT_MAX
&& attr
)
4591 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
4593 job
->history_time
= INT_MAX
;
4595 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4596 JobHistoryUpdate
= job
->history_time
;
4598 if (JobFiles
< INT_MAX
&& attr
)
4599 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
4601 job
->file_time
= INT_MAX
;
4603 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4604 JobHistoryUpdate
= job
->file_time
;
4606 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "set_time: JobHistoryUpdate=%ld",
4607 (long)JobHistoryUpdate
);
4613 * 'start_job()' - Start a print job.
4617 start_job(cupsd_job_t
*job
, /* I - Job ID */
4618 cupsd_printer_t
*printer
) /* I - Printer to print job */
4620 const char *filename
; /* Support filename */
4621 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
4624 /* job-cancel-after attribute */
4627 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
4628 job
, job
->id
, printer
, printer
->name
);
4631 * Make sure we have some files around before we try to print...
4634 if (job
->num_files
== 0)
4636 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
4637 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
4638 "Aborting job because it has no files.");
4643 * Update the printer and job state to "processing"...
4646 if (!cupsdLoadJob(job
))
4649 if (!job
->printer_message
)
4650 job
->printer_message
= ippFindAttribute(job
->attrs
,
4651 "job-printer-state-message",
4653 if (job
->printer_message
)
4654 ippSetString(job
->attrs
, &job
->printer_message
, 0, "");
4656 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-printing");
4657 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
4658 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
4659 cupsdSetPrinterReasons(printer
, "-cups-remote-pending,"
4660 "cups-remote-pending-held,"
4661 "cups-remote-processing,"
4662 "cups-remote-stopped,"
4663 "cups-remote-canceled,"
4664 "cups-remote-aborted,"
4665 "cups-remote-completed");
4668 job
->current_file
= 0;
4670 job
->history_time
= 0;
4672 job
->printer
= printer
;
4676 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
4677 else if (MaxJobTime
> 0)
4678 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4680 job
->cancel_time
= 0;
4683 * Check for support files...
4686 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
4687 "cups-insecure-filter-warning");
4691 for (filename
= (const char *)cupsArrayFirst(printer
->pc
->support_files
);
4693 filename
= (const char *)cupsArrayNext(printer
->pc
->support_files
))
4695 if (_cupsFileCheck(filename
, _CUPS_FILE_CHECK_FILE
, !RunUser
,
4696 cupsdLogFCMessage
, printer
))
4702 * Setup the last exit status and security profiles...
4706 job
->profile
= cupsdCreateProfile(job
->id
, 0);
4707 job
->bprofile
= cupsdCreateProfile(job
->id
, 1);
4710 * Create the status pipes and buffer...
4713 if (cupsdOpenPipe(job
->status_pipes
))
4715 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4716 "Unable to create job status pipes - %s.", strerror(errno
));
4718 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4719 "Job stopped because the scheduler could not create the "
4720 "job status pipes.");
4722 cupsdDestroyProfile(job
->profile
);
4723 job
->profile
= NULL
;
4724 cupsdDestroyProfile(job
->bprofile
);
4725 job
->bprofile
= NULL
;
4729 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
4730 job
->status_level
= CUPSD_LOG_INFO
;
4733 * Create the backchannel pipes and make them non-blocking...
4736 if (cupsdOpenPipe(job
->back_pipes
))
4738 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4739 "Unable to create back-channel pipes - %s.", strerror(errno
));
4741 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4742 "Job stopped because the scheduler could not create the "
4743 "back-channel pipes.");
4745 cupsdClosePipe(job
->status_pipes
);
4746 cupsdStatBufDelete(job
->status_buffer
);
4747 job
->status_buffer
= NULL
;
4749 cupsdDestroyProfile(job
->profile
);
4750 job
->profile
= NULL
;
4751 cupsdDestroyProfile(job
->bprofile
);
4752 job
->bprofile
= NULL
;
4756 fcntl(job
->back_pipes
[0], F_SETFL
,
4757 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4758 fcntl(job
->back_pipes
[1], F_SETFL
,
4759 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4762 * Create the side-channel pipes and make them non-blocking...
4765 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4767 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4768 "Unable to create side-channel pipes - %s.", strerror(errno
));
4770 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4771 "Job stopped because the scheduler could not create the "
4772 "side-channel pipes.");
4774 cupsdClosePipe(job
->back_pipes
);
4776 cupsdClosePipe(job
->status_pipes
);
4777 cupsdStatBufDelete(job
->status_buffer
);
4778 job
->status_buffer
= NULL
;
4780 cupsdDestroyProfile(job
->profile
);
4781 job
->profile
= NULL
;
4782 cupsdDestroyProfile(job
->bprofile
);
4783 job
->bprofile
= NULL
;
4787 fcntl(job
->side_pipes
[0], F_SETFL
,
4788 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4789 fcntl(job
->side_pipes
[1], F_SETFL
,
4790 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4792 fcntl(job
->side_pipes
[0], F_SETFD
,
4793 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4794 fcntl(job
->side_pipes
[1], F_SETFD
,
4795 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4798 * Now start the first file in the job...
4801 cupsdContinueJob(job
);
4806 * 'stop_job()' - Stop a print job.
4810 stop_job(cupsd_job_t
*job
, /* I - Job */
4811 cupsd_jobaction_t action
) /* I - Action */
4813 int i
; /* Looping var */
4816 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4819 FilterLevel
-= job
->cost
;
4822 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
&& job
->backend
> 0)
4823 job
->kill_time
= time(NULL
) + JobKillDelay
;
4824 else if (action
>= CUPSD_JOB_FORCE
)
4827 for (i
= 0; job
->filters
[i
]; i
++)
4828 if (job
->filters
[i
] > 0)
4830 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
4832 if (action
>= CUPSD_JOB_FORCE
)
4833 job
->filters
[i
] = -job
->filters
[i
];
4836 if (job
->backend
> 0)
4838 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
4840 if (action
>= CUPSD_JOB_FORCE
)
4841 job
->backend
= -job
->backend
;
4844 if (action
>= CUPSD_JOB_FORCE
)
4847 * Clear job status...
4856 * 'unload_job()' - Unload a job from memory.
4860 unload_job(cupsd_job_t
*job
) /* I - Job */
4865 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Unloading...");
4867 ippDelete(job
->attrs
);
4871 job
->reasons
= NULL
;
4872 job
->impressions
= NULL
;
4874 job
->job_sheets
= NULL
;
4875 job
->printer_message
= NULL
;
4876 job
->printer_reasons
= NULL
;
4881 * 'update_job()' - Read a status update from a job's filters.
4885 update_job(cupsd_job_t
*job
) /* I - Job to check */
4887 int i
; /* Looping var */
4888 int copies
; /* Number of copies printed */
4889 char message
[CUPSD_SB_BUFFER_SIZE
],
4891 *ptr
; /* Pointer update... */
4892 int loglevel
, /* Log level for message */
4893 event
= 0; /* Events? */
4894 cupsd_printer_t
*printer
= job
->printer
;
4896 static const char * const levels
[] = /* Log levels */
4912 * Get the printer associated with this job; if the printer is stopped for
4913 * any reason then job->printer will be reset to NULL, so make sure we have
4914 * a valid pointer...
4917 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
4918 message
, sizeof(message
))) != NULL
)
4921 * Process page and printer state messages as needed...
4924 if (loglevel
== CUPSD_LOG_PAGE
)
4927 * Page message; send the message to the page_log file and update the
4928 * job sheet count...
4931 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
4933 if (job
->impressions
)
4935 if (!_cups_strncasecmp(message
, "total ", 6))
4938 * Got a total count of pages from a backend or filter...
4941 copies
= atoi(message
+ 6);
4942 copies
-= ippGetInteger(job
->impressions
, 0); /* Just track the delta */
4944 else if (!sscanf(message
, "%*d%d", &copies
))
4947 ippSetInteger(job
->attrs
, &job
->impressions
, 0, ippGetInteger(job
->impressions
, 0) + copies
);
4949 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
4954 if (!_cups_strncasecmp(message
, "total ", 6))
4957 * Got a total count of pages from a backend or filter...
4960 copies
= atoi(message
+ 6);
4961 copies
-= ippGetInteger(job
->sheets
, 0); /* Just track the delta */
4963 else if (!sscanf(message
, "%*d%d", &copies
))
4966 ippSetInteger(job
->attrs
, &job
->sheets
, 0, ippGetInteger(job
->sheets
, 0) + copies
);
4968 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
4970 if (job
->printer
->page_limit
)
4971 cupsdUpdateQuota(job
->printer
, job
->username
, copies
, 0);
4974 cupsdLogPage(job
, message
);
4977 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
, "Printed %d page(s).", ippGetInteger(job
->sheets
, 0));
4979 else if (loglevel
== CUPSD_LOG_JOBSTATE
)
4982 * Support "keyword" to set job-state-reasons to the specified keyword.
4983 * This is sufficient for the current paid printing stuff.
4986 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "JOBSTATE: %s", message
);
4988 if (!strcmp(message
, "cups-retry-as-raster"))
4989 job
->retry_as_raster
= 1;
4991 ippSetString(job
->attrs
, &job
->reasons
, 0, message
);
4993 else if (loglevel
== CUPSD_LOG_STATE
)
4995 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
4997 if (!strcmp(message
, "paused"))
4999 cupsdStopPrinter(job
->printer
, 1);
5002 else if (message
[0] && cupsdSetPrinterReasons(job
->printer
, message
))
5004 event
|= CUPSD_EVENT_PRINTER_STATE
;
5009 * Reset cancel time after connecting to the device...
5012 for (i
= 0; i
< job
->printer
->num_reasons
; i
++)
5013 if (!strcmp(job
->printer
->reasons
[i
], "connecting-to-device"))
5016 if (i
>= job
->printer
->num_reasons
)
5018 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
5021 /* job-cancel-after attribute */
5024 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
5026 job
->cancel_time
= time(NULL
) + MaxJobTime
;
5031 update_job_attrs(job
, 0);
5033 else if (loglevel
== CUPSD_LOG_ATTR
)
5036 * Set attribute(s)...
5039 int num_attrs
; /* Number of attributes */
5040 cups_option_t
*attrs
; /* Attributes */
5041 const char *attr
; /* Attribute */
5043 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
5045 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
5047 if ((attr
= cupsGetOption("auth-info-default", num_attrs
,
5050 job
->printer
->num_options
= cupsAddOption("auth-info", attr
,
5051 job
->printer
->num_options
,
5052 &(job
->printer
->options
));
5053 cupsdSetPrinterAttrs(job
->printer
);
5055 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5058 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
5061 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
5062 cupsdSetPrinterAttrs(job
->printer
);
5064 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5067 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
5070 int progress
= atoi(attr
);
5073 if (progress
>= 0 && progress
<= 100)
5075 job
->progress
= progress
;
5078 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5079 "Printing page %d, %d%%",
5080 job
->sheets
->values
[0].integer
, job
->progress
);
5084 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
5086 cupsdSetString(&job
->printer
->alert
, attr
);
5087 event
|= CUPSD_EVENT_PRINTER_STATE
;
5090 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
5093 cupsdSetString(&job
->printer
->alert_description
, attr
);
5094 event
|= CUPSD_EVENT_PRINTER_STATE
;
5097 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
5099 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
5100 job
->printer
->marker_time
= time(NULL
);
5101 event
|= CUPSD_EVENT_PRINTER_STATE
;
5102 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5105 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
5107 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
5108 job
->printer
->marker_time
= time(NULL
);
5109 event
|= CUPSD_EVENT_PRINTER_STATE
;
5110 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5113 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
5115 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
5116 job
->printer
->marker_time
= time(NULL
);
5117 event
|= CUPSD_EVENT_PRINTER_STATE
;
5118 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5121 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
5123 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
5124 job
->printer
->marker_time
= time(NULL
);
5125 event
|= CUPSD_EVENT_PRINTER_STATE
;
5126 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5129 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
5131 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
5132 job
->printer
->marker_time
= time(NULL
);
5133 event
|= CUPSD_EVENT_PRINTER_STATE
;
5134 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5137 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
5139 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
5140 job
->printer
->marker_time
= time(NULL
);
5141 event
|= CUPSD_EVENT_PRINTER_STATE
;
5142 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5145 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
5147 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
5148 job
->printer
->marker_time
= time(NULL
);
5149 event
|= CUPSD_EVENT_PRINTER_STATE
;
5150 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5153 cupsFreeOptions(num_attrs
, attrs
);
5155 else if (loglevel
== CUPSD_LOG_PPD
)
5158 * Set attribute(s)...
5161 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
5163 job
->num_keywords
= cupsParseOptions(message
, job
->num_keywords
,
5169 * Strip legacy message prefix...
5172 if (!strncmp(message
, "recoverable:", 12))
5175 while (isspace(*ptr
& 255))
5178 else if (!strncmp(message
, "recovered:", 10))
5181 while (isspace(*ptr
& 255))
5188 cupsdLogJob(job
, loglevel
, "%s", ptr
);
5190 if (loglevel
< CUPSD_LOG_DEBUG
&&
5191 strcmp(job
->printer
->state_message
, ptr
))
5193 strlcpy(job
->printer
->state_message
, ptr
,
5194 sizeof(job
->printer
->state_message
));
5196 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
5198 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
5201 * Some messages show in the job-printer-state-message attribute...
5204 if (loglevel
!= CUPSD_LOG_NOTICE
)
5205 job
->status_level
= loglevel
;
5207 update_job_attrs(job
, 1);
5209 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
5210 "Set job-printer-state-message to \"%s\", "
5212 job
->printer_message
->values
[0].string
.text
,
5213 levels
[job
->status_level
]);
5218 if (!strchr(job
->status_buffer
->buffer
, '\n'))
5222 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
5223 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5224 "%s", job
->printer
->state_message
);
5225 if (event
& CUPSD_EVENT_PRINTER_STATE
)
5226 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
5227 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
5228 "Class \"%s\" state changed." :
5229 "Printer \"%s\" state changed.",
5230 job
->printer
->name
);
5233 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
5236 * See if all of the filters and the backend have returned their
5240 for (i
= 0; job
->filters
[i
] < 0; i
++);
5242 if (job
->filters
[i
])
5245 * EOF but we haven't collected the exit status of all filters...
5248 cupsdCheckProcess();
5252 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
5255 * EOF but we haven't collected the exit status of the backend...
5258 cupsdCheckProcess();
5263 * Handle the end of job stuff...
5266 finalize_job(job
, 1);
5269 * Try printing another job...
5272 if (printer
->state
!= IPP_PRINTER_STOPPED
)
5279 * 'update_job_attrs()' - Update the job-printer-* attributes.
5283 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
5284 int do_message
)/* I - 1 = copy job-printer-state message */
5286 int i
; /* Looping var */
5287 int num_reasons
; /* Actual number of reasons */
5288 const char * const *reasons
; /* Reasons */
5289 static const char *none
= "none"; /* "none" reason */
5293 * Get/create the job-printer-state-* attributes...
5296 if (!job
->printer_message
)
5298 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
5299 "job-printer-state-message",
5300 IPP_TAG_TEXT
)) == NULL
)
5301 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
5302 "job-printer-state-message",
5306 if (!job
->printer_reasons
)
5307 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
5308 "job-printer-state-reasons",
5312 * Copy or clear the printer-state-message value as needed...
5315 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
5316 job
->status_level
== CUPSD_LOG_INFO
)
5318 ippSetString(job
->attrs
, &job
->printer_message
, 0, "");
5321 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5323 else if (job
->printer
->state_message
[0] && do_message
)
5325 ippSetString(job
->attrs
, &job
->printer_message
, 0, job
->printer
->state_message
);
5328 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5332 * ... and the printer-state-reasons value...
5335 if (job
->printer
->num_reasons
== 0)
5342 num_reasons
= job
->printer
->num_reasons
;
5343 reasons
= (const char * const *)job
->printer
->reasons
;
5346 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
5349 * Replace/create a job-printer-state-reasons attribute...
5352 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
5354 job
->printer_reasons
= ippAddStrings(job
->attrs
,
5355 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
5356 "job-printer-state-reasons",
5357 num_reasons
, NULL
, NULL
);
5362 * Don't bother clearing the reason strings if they are the same...
5365 for (i
= 0; i
< num_reasons
; i
++)
5366 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
5369 if (i
>= num_reasons
)
5373 * Not the same, so free the current strings...
5376 for (i
= 0; i
< num_reasons
; i
++)
5377 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
5381 * Copy the reasons...
5384 for (i
= 0; i
< num_reasons
; i
++)
5385 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
5388 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);