4 * Job management routines for the CUPS scheduler.
6 * Copyright 2007-2014 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
17 * Include necessary headers...
22 #include <cups/backend.h>
25 # include <IOKit/pwr_mgt/IOPMLib.h>
26 # ifdef HAVE_IOKIT_PWR_MGT_IOPMLIBPRIVATE_H
27 # include <IOKit/pwr_mgt/IOPMLibPrivate.h>
28 # endif /* HAVE_IOKIT_PWR_MGT_IOPMLIBPRIVATE_H */
29 #endif /* __APPLE__ */
33 * Design Notes for Job Management
34 * -------------------------------
38 * pending Do nothing/check jobs
39 * pending-held Send SIGTERM to filters and backend
40 * processing Do nothing/start job
41 * stopped Send SIGKILL to filters and backend
42 * canceled Send SIGTERM to filters and backend
46 * Finalize clears the printer <-> job association, deletes the status
47 * buffer, closes all of the pipes, etc. and doesn't get run until all of
48 * the print processes are finished.
50 * UNLOADING OF JOBS (cupsdUnloadCompletedJobs)
52 * We unload the job attributes when they are not needed to reduce overall
53 * memory consumption. We don't unload jobs where job->state_value <
54 * IPP_JOB_STOPPED, job->printer != NULL, or job->access_time is recent.
56 * STARTING OF JOBS (start_job)
58 * When a job is started, a status buffer, several pipes, a security
59 * profile, and a backend process are created for the life of that job.
60 * These are shared for every file in a job. For remote print jobs, the
61 * IPP backend is provided with every file in the job and no filters are
64 * The job->printer member tracks which printer is printing a job, which
65 * can be different than the destination in job->dest for classes. The
66 * printer object also has a job pointer to track which job is being
69 * PRINTING OF JOB FILES (cupsdContinueJob)
71 * Each file in a job is filtered by 0 or more programs. After getting the
72 * list of filters needed and the total cost, the job is either passed or
73 * put back to the processing state until the current FilterLevel comes down
74 * enough to allow printing.
76 * If we can print, we build a string for the print options and run each of
77 * the filters, piping the output from one into the next.
79 * JOB STATUS UPDATES (update_job)
81 * The update_job function gets called whenever there are pending messages
82 * on the status pipe. These generally are updates to the marker-*,
83 * printer-state-message, or printer-state-reasons attributes. On EOF,
84 * finalize_job is called to clean up.
86 * FINALIZING JOBS (finalize_job)
88 * When all filters and the backend are done, we set the job state to
89 * completed (no errors), aborted (filter errors or abort-job policy),
90 * pending-held (auth required or retry-job policy), or pending
91 * (retry-current-job or stop-printer policies) as appropriate.
93 * Then we close the pipes and free the status buffers and profiles.
95 * JOB FILE COMPLETION (process_children in main.c)
97 * For multiple-file jobs, process_children (in main.c) sees that all
98 * filters have exited and calls in to print the next file if there are
99 * more files in the job, otherwise it waits for the backend to exit and
100 * update_job to do the cleanup.
108 static mime_filter_t gziptoany_filter
=
110 NULL
, /* Source type */
111 NULL
, /* Destination type */
113 "gziptoany" /* Filter program to run */
121 static int compare_active_jobs(void *first
, void *second
, void *data
);
122 static int compare_completed_jobs(void *first
, void *second
, void *data
);
123 static int compare_jobs(void *first
, void *second
, void *data
);
124 static void dump_job_history(cupsd_job_t
*job
);
125 static void finalize_job(cupsd_job_t
*job
, int set_job_state
);
126 static void free_job_history(cupsd_job_t
*job
);
127 static char *get_options(cupsd_job_t
*job
, int banner_page
, char *copies
,
128 size_t copies_size
, char *title
,
130 static size_t ipp_length(ipp_t
*ipp
);
131 static void load_job_cache(const char *filename
);
132 static void load_next_job_id(const char *filename
);
133 static void load_request_root(void);
134 static void remove_job_files(cupsd_job_t
*job
);
135 static void remove_job_history(cupsd_job_t
*job
);
136 static void set_time(cupsd_job_t
*job
, const char *name
);
137 static void start_job(cupsd_job_t
*job
, cupsd_printer_t
*printer
);
138 static void stop_job(cupsd_job_t
*job
, cupsd_jobaction_t action
);
139 static void unload_job(cupsd_job_t
*job
);
140 static void update_job(cupsd_job_t
*job
);
141 static void update_job_attrs(cupsd_job_t
*job
, int do_message
);
145 * 'cupsdAddJob()' - Add a new job to the job queue.
148 cupsd_job_t
* /* O - New job record */
149 cupsdAddJob(int priority
, /* I - Job priority */
150 const char *dest
) /* I - Job destination */
152 cupsd_job_t
*job
; /* New job record */
155 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
158 job
->id
= NextJobId
++;
159 job
->priority
= priority
;
160 job
->back_pipes
[0] = -1;
161 job
->back_pipes
[1] = -1;
162 job
->print_pipes
[0] = -1;
163 job
->print_pipes
[1] = -1;
164 job
->side_pipes
[0] = -1;
165 job
->side_pipes
[1] = -1;
166 job
->status_pipes
[0] = -1;
167 job
->status_pipes
[1] = -1;
169 cupsdSetString(&job
->dest
, dest
);
172 * Add the new job to the "all jobs" and "active jobs" lists...
175 cupsArrayAdd(Jobs
, job
);
176 cupsArrayAdd(ActiveJobs
, job
);
183 * 'cupsdCancelJobs()' - Cancel all jobs for the given destination/user.
187 cupsdCancelJobs(const char *dest
, /* I - Destination to cancel */
188 const char *username
, /* I - Username or NULL */
189 int purge
) /* I - Purge jobs? */
191 cupsd_job_t
*job
; /* Current job */
194 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
196 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
198 if ((!job
->dest
|| !job
->username
) && !cupsdLoadJob(job
))
201 if ((!dest
|| !strcmp(job
->dest
, dest
)) &&
202 (!username
|| !strcmp(job
->username
, username
)))
205 * Cancel all jobs matching this destination/user...
209 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_PURGE
,
210 "Job purged by user.");
211 else if (job
->state_value
< IPP_JOB_CANCELED
)
212 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
,
213 "Job canceled by user.");
222 * 'cupsdCheckJobs()' - Check the pending jobs and start any if the destination
229 cupsd_job_t
*job
; /* Current job in queue */
230 cupsd_printer_t
*printer
, /* Printer destination */
231 *pclass
; /* Printer class destination */
232 ipp_attribute_t
*attr
; /* Job attribute */
233 time_t curtime
; /* Current time */
236 curtime
= time(NULL
);
238 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCheckJobs: %d active jobs, sleeping=%d, ac-power=%d, reload=%d, curtime=%ld", cupsArrayCount(ActiveJobs
), Sleeping
, ACPower
, NeedReload
, (long)curtime
);
240 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
);
242 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
244 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
245 "cupsdCheckJobs: Job %d - dest=\"%s\", printer=%p, "
246 "state=%d, cancel_time=%ld, hold_until=%ld, kill_time=%ld, "
247 "pending_cost=%d, pending_timeout=%ld", job
->id
, job
->dest
,
248 job
->printer
, job
->state_value
, (long)job
->cancel_time
,
249 (long)job
->hold_until
, (long)job
->kill_time
,
250 job
->pending_cost
, (long)job
->pending_timeout
);
253 * Kill jobs if they are unresponsive...
256 if (job
->kill_time
&& job
->kill_time
<= curtime
)
259 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Stopping unresponsive job.");
261 stop_job(job
, CUPSD_JOB_FORCE
);
266 * Cancel stuck jobs...
269 if (job
->cancel_time
&& job
->cancel_time
<= curtime
)
271 int cancel_after
; /* job-cancel-after value */
273 attr
= ippFindAttribute(job
->attrs
, "job-cancel-after", IPP_TAG_INTEGER
);
274 cancel_after
= attr
? ippGetInteger(attr
, 0) : MaxJobTime
;
277 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_FORCE
, "Marking stuck job as completed after %d seconds.", cancel_after
);
279 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
, "Canceling stuck job after %d seconds.", cancel_after
);
284 * Start held jobs if they are ready...
287 if (job
->state_value
== IPP_JOB_HELD
&&
289 job
->hold_until
< curtime
)
291 if (job
->pending_timeout
)
294 * This job is pending; check that we don't have an active Send-Document
295 * operation in progress on any of the client connections, then timeout
296 * the job so we can start printing...
299 cupsd_client_t
*con
; /* Current client connection */
301 for (con
= (cupsd_client_t
*)cupsArrayFirst(Clients
);
303 con
= (cupsd_client_t
*)cupsArrayNext(Clients
))
305 con
->request
->request
.op
.operation_id
== IPP_SEND_DOCUMENT
)
311 if (cupsdTimeoutJob(job
))
315 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
316 "Job submission timed out.");
320 * Continue jobs that are waiting on the FilterLimit...
323 if (job
->pending_cost
> 0 &&
324 ((FilterLevel
+ job
->pending_cost
) < FilterLimit
|| FilterLevel
== 0))
325 cupsdContinueJob(job
);
328 * Start pending jobs if the destination is available...
331 if (job
->state_value
== IPP_JOB_PENDING
&& !NeedReload
&&
332 (!Sleeping
|| ACPower
) && !DoingShutdown
&& !job
->printer
)
334 printer
= cupsdFindDest(job
->dest
);
337 while (printer
&& (printer
->type
& CUPS_PRINTER_CLASS
))
340 * If the class is remote, just pass it to the remote server...
345 if (pclass
->state
== IPP_PRINTER_STOPPED
)
347 else if (pclass
->type
& CUPS_PRINTER_REMOTE
)
350 printer
= cupsdFindAvailablePrinter(printer
->name
);
353 if (!printer
&& !pclass
)
356 * Whoa, the printer and/or class for this destination went away;
360 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_PURGE
,
361 "Job aborted because the destination printer/class "
364 else if (printer
&& !printer
->holding_new_jobs
)
367 * See if the printer is available or remote and not printing a job;
368 * if so, start the job...
374 * Add/update a job-actual-printer-uri attribute for this job
375 * so that we know which printer actually printed the job...
378 if ((attr
= ippFindAttribute(job
->attrs
, "job-actual-printer-uri",
379 IPP_TAG_URI
)) != NULL
)
380 cupsdSetString(&attr
->values
[0].string
.text
, printer
->uri
);
382 ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_URI
,
383 "job-actual-printer-uri", NULL
, printer
->uri
);
386 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
389 if (!printer
->job
&& printer
->state
== IPP_PRINTER_IDLE
)
395 start_job(job
, printer
);
404 * 'cupsdCleanJobs()' - Clean out old jobs.
410 cupsd_job_t
*job
; /* Current job */
411 time_t curtime
; /* Current time */
414 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
415 "cupsdCleanJobs: MaxJobs=%d, JobHistory=%d, JobFiles=%d",
416 MaxJobs
, JobHistory
, JobFiles
);
418 if (MaxJobs
<= 0 && JobHistory
== INT_MAX
&& JobFiles
== INT_MAX
)
421 curtime
= time(NULL
);
422 JobHistoryUpdate
= 0;
424 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
426 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
428 if (job
->state_value
>= IPP_JOB_CANCELED
&& !job
->printer
)
431 * Expire old jobs (or job files)...
434 if ((MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
) ||
435 (job
->history_time
&& job
->history_time
<= curtime
))
437 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Removing from history.");
438 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
440 else if (job
->file_time
&& job
->file_time
<= curtime
)
442 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Removing document files.");
443 remove_job_files(job
);
445 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
446 JobHistoryUpdate
= job
->history_time
;
450 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
451 JobHistoryUpdate
= job
->history_time
;
453 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
454 JobHistoryUpdate
= job
->file_time
;
459 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCleanJobs: JobHistoryUpdate=%ld",
460 (long)JobHistoryUpdate
);
465 * 'cupsdContinueJob()' - Continue printing with the next file in a job.
469 cupsdContinueJob(cupsd_job_t
*job
) /* I - Job */
471 int i
; /* Looping var */
472 int slot
; /* Pipe slot */
473 cups_array_t
*filters
= NULL
,/* Filters for job */
474 *prefilters
; /* Filters with prefilters */
475 mime_filter_t
*filter
, /* Current filter */
476 *prefilter
, /* Prefilter */
477 port_monitor
; /* Port monitor filter */
478 char scheme
[255]; /* Device URI scheme */
479 ipp_attribute_t
*attr
; /* Current attribute */
480 const char *ptr
, /* Pointer into value */
481 *abort_message
; /* Abort message */
482 ipp_jstate_t abort_state
= IPP_JOB_STOPPED
;
483 /* New job state on abort */
484 struct stat backinfo
; /* Backend file information */
485 int backroot
; /* Run backend as root? */
486 int pid
; /* Process ID of new filter process */
487 int banner_page
; /* 1 if banner page, 0 otherwise */
488 int filterfds
[2][2] = { { -1, -1 }, { -1, -1 } };
489 /* Pipes used between filters */
490 int envc
; /* Number of environment variables */
491 struct stat fileinfo
; /* Job file information */
492 int argc
= 0; /* Number of arguments */
493 char **argv
= NULL
, /* Filter command-line arguments */
494 filename
[1024], /* Job filename */
495 command
[1024], /* Full path to command */
496 jobid
[255], /* Job ID string */
498 /* Job title string */
499 copies
[255], /* # copies string */
500 *options
, /* Options string */
502 /* Environment variables */
503 charset
[255], /* CHARSET env variable */
504 class_name
[255],/* CLASS env variable */
505 classification
[1024],
506 /* CLASSIFICATION env variable */
508 /* CONTENT_TYPE env variable */
510 /* DEVICE_URI env variable */
511 final_content_type
[1024] = "",
512 /* FINAL_CONTENT_TYPE env variable */
513 lang
[255], /* LANG env variable */
516 /* APPLE_LANGUAGE env variable */
517 #endif /* __APPLE__ */
518 auth_info_required
[255],
519 /* AUTH_INFO_REQUIRED env variable */
520 ppd
[1024], /* PPD env variable */
522 /* PRINTER_INFO env variable */
523 printer_location
[255],
524 /* PRINTER_LOCATION env variable */
526 /* PRINTER env variable */
527 *printer_state_reasons
= NULL
,
528 /* PRINTER_STATE_REASONS env var */
530 /* RIP_MAX_CACHE env variable */
533 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
534 "cupsdContinueJob(job=%p(%d)): current_file=%d, num_files=%d",
535 job
, job
->id
, job
->current_file
, job
->num_files
);
538 * Figure out what filters are required to convert from
539 * the source to the destination type...
542 FilterLevel
-= job
->cost
;
545 job
->pending_cost
= 0;
547 memset(job
->filters
, 0, sizeof(job
->filters
));
549 if (job
->printer
->raw
)
552 * Remote jobs and raw queues go directly to the printer without
556 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Sending job to queue tagged as raw...");
561 * Local jobs get filtered...
564 mime_type_t
*dst
= job
->printer
->filetype
;
565 /* Destination file type */
567 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
568 job
->id
, job
->current_file
+ 1);
569 if (stat(filename
, &fileinfo
))
570 fileinfo
.st_size
= 0;
572 if (job
->retry_as_raster
)
575 * Need to figure out whether the printer supports image/pwg-raster or
576 * image/urf, and use the corresponding type...
579 char type
[MIME_MAX_TYPE
]; /* MIME media type for printer */
581 snprintf(type
, sizeof(type
), "%s/image/urf", job
->printer
->name
);
582 if ((dst
= mimeType(MimeDatabase
, "printer", type
)) == NULL
)
584 snprintf(type
, sizeof(type
), "%s/image/pwg-raster", job
->printer
->name
);
585 dst
= mimeType(MimeDatabase
, "printer", type
);
589 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Retrying job as \"%s\".", strchr(dst
->type
, '/') + 1);
591 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to retry job using a supported raster format.");
594 filters
= mimeFilter2(MimeDatabase
, job
->filetypes
[job
->current_file
], (size_t)fileinfo
.st_size
, dst
, &(job
->cost
));
598 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
599 "Unable to convert file %d to printable format.",
602 abort_message
= "Aborting job because it cannot be printed.";
603 abort_state
= IPP_JOB_ABORTED
;
605 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
610 * Figure out the final content type...
613 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%d filters for job:",
614 cupsArrayCount(filters
));
615 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
617 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
618 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s (%s/%s to %s/%s, cost %d)",
620 filter
->src
? filter
->src
->super
: "???",
621 filter
->src
? filter
->src
->type
: "???",
622 filter
->dst
? filter
->dst
->super
: "???",
623 filter
->dst
? filter
->dst
->type
: "???",
626 if (!job
->printer
->remote
)
628 for (filter
= (mime_filter_t
*)cupsArrayLast(filters
);
629 filter
&& filter
->dst
;
630 filter
= (mime_filter_t
*)cupsArrayPrev(filters
))
631 if (strcmp(filter
->dst
->super
, "printer") ||
632 strcmp(filter
->dst
->type
, job
->printer
->name
))
635 if (filter
&& filter
->dst
)
637 if ((ptr
= strchr(filter
->dst
->type
, '/')) != NULL
)
638 snprintf(final_content_type
, sizeof(final_content_type
),
639 "FINAL_CONTENT_TYPE=%s", ptr
+ 1);
641 snprintf(final_content_type
, sizeof(final_content_type
),
642 "FINAL_CONTENT_TYPE=%s/%s", filter
->dst
->super
,
646 snprintf(final_content_type
, sizeof(final_content_type
),
647 "FINAL_CONTENT_TYPE=printer/%s", job
->printer
->name
);
651 * Remove NULL ("-") filters...
654 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
656 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
657 if (!strcmp(filter
->filter
, "-"))
658 cupsArrayRemove(filters
, filter
);
660 if (cupsArrayCount(filters
) == 0)
662 cupsArrayDelete(filters
);
667 * If this printer has any pre-filters, insert the required pre-filter
668 * in the filters array...
671 if (job
->printer
->prefiltertype
&& filters
)
673 prefilters
= cupsArrayNew(NULL
, NULL
);
675 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
677 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
679 if ((prefilter
= mimeFilterLookup(MimeDatabase
, filter
->src
,
680 job
->printer
->prefiltertype
)))
682 cupsArrayAdd(prefilters
, prefilter
);
683 job
->cost
+= prefilter
->cost
;
686 cupsArrayAdd(prefilters
, filter
);
689 cupsArrayDelete(filters
);
690 filters
= prefilters
;
695 * Set a minimum cost of 100 for all jobs so that FilterLimit
696 * works with raw queues and other low-cost paths.
703 * See if the filter cost is too high...
706 if ((FilterLevel
+ job
->cost
) > FilterLimit
&& FilterLevel
> 0 &&
710 * Don't print this job quite yet...
713 cupsArrayDelete(filters
);
715 cupsdLogJob(job
, CUPSD_LOG_INFO
,
716 "Holding because filter limit has been reached.");
717 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
,
718 "cupsdContinueJob: file=%d, cost=%d, level=%d, limit=%d",
719 job
->current_file
, job
->cost
, FilterLevel
,
722 job
->pending_cost
= job
->cost
;
727 FilterLevel
+= job
->cost
;
730 * Add decompression/raw filter as needed...
733 if (job
->compressions
[job
->current_file
] &&
734 (!job
->printer
->remote
|| job
->num_files
== 1))
737 * Add gziptoany filter to the front of the list...
741 filters
= cupsArrayNew(NULL
, NULL
);
743 if (!cupsArrayInsert(filters
, &gziptoany_filter
))
745 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
746 "Unable to add decompression filter - %s", strerror(errno
));
748 cupsArrayDelete(filters
);
750 abort_message
= "Stopping job because the scheduler ran out of memory.";
757 * Add port monitor, if any...
760 if (job
->printer
->port_monitor
)
763 * Add port monitor to the end of the list...
767 filters
= cupsArrayNew(NULL
, NULL
);
769 port_monitor
.src
= NULL
;
770 port_monitor
.dst
= NULL
;
771 port_monitor
.cost
= 0;
773 snprintf(port_monitor
.filter
, sizeof(port_monitor
.filter
),
774 "%s/monitor/%s", ServerBin
, job
->printer
->port_monitor
);
776 if (!cupsArrayAdd(filters
, &port_monitor
))
778 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
779 "Unable to add port monitor - %s", strerror(errno
));
781 abort_message
= "Stopping job because the scheduler ran out of memory.";
788 * Make sure we don't go over the "MAX_FILTERS" limit...
791 if (cupsArrayCount(filters
) > MAX_FILTERS
)
793 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
794 "Too many filters (%d > %d), unable to print.",
795 cupsArrayCount(filters
), MAX_FILTERS
);
797 abort_message
= "Aborting job because it needs too many filters to print.";
798 abort_state
= IPP_JOB_ABORTED
;
800 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
806 * Determine if we are printing a banner page or not...
809 if (job
->job_sheets
== NULL
)
811 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "No job-sheets attribute.");
812 if ((job
->job_sheets
=
813 ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_ZERO
)) != NULL
)
814 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
815 "... but someone added one without setting job_sheets.");
817 else if (job
->job_sheets
->num_values
== 1)
818 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s",
819 job
->job_sheets
->values
[0].string
.text
);
821 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s,%s",
822 job
->job_sheets
->values
[0].string
.text
,
823 job
->job_sheets
->values
[1].string
.text
);
825 if (job
->printer
->type
& CUPS_PRINTER_REMOTE
)
827 else if (job
->job_sheets
== NULL
)
829 else if (_cups_strcasecmp(job
->job_sheets
->values
[0].string
.text
, "none") != 0 &&
830 job
->current_file
== 0)
832 else if (job
->job_sheets
->num_values
> 1 &&
833 _cups_strcasecmp(job
->job_sheets
->values
[1].string
.text
, "none") != 0 &&
834 job
->current_file
== (job
->num_files
- 1))
839 if ((options
= get_options(job
, banner_page
, copies
, sizeof(copies
), title
,
840 sizeof(title
))) == NULL
)
842 abort_message
= "Stopping job because the scheduler ran out of memory.";
848 * Build the command-line arguments for the filters. Each filter
849 * has 6 or 7 arguments:
857 * argv[6] = filename (optional; normally stdin)
859 * This allows legacy printer drivers that use the old System V
860 * printing interface to be used by CUPS.
862 * For remote jobs, we send all of the files in the argument list.
865 if (job
->printer
->remote
)
866 argc
= 6 + job
->num_files
;
870 if ((argv
= calloc((size_t)argc
+ 1, sizeof(char *))) == NULL
)
872 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Unable to allocate argument array - %s",
875 abort_message
= "Stopping job because the scheduler ran out of memory.";
880 sprintf(jobid
, "%d", job
->id
);
882 argv
[0] = job
->printer
->name
;
884 argv
[2] = job
->username
;
889 if (job
->printer
->remote
&& job
->num_files
> 1)
891 for (i
= 0; i
< job
->num_files
; i
++)
893 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
895 argv
[6 + i
] = strdup(filename
);
900 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
901 job
->id
, job
->current_file
+ 1);
902 argv
[6] = strdup(filename
);
905 for (i
= 0; argv
[i
]; i
++)
906 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "argv[%d]=\"%s\"", i
, argv
[i
]);
909 * Create environment variable strings for the filters...
912 attr
= ippFindAttribute(job
->attrs
, "attributes-natural-language",
916 strlcpy(apple_language
, "APPLE_LANGUAGE=", sizeof(apple_language
));
917 _cupsAppleLanguage(attr
->values
[0].string
.text
,
918 apple_language
+ 15, sizeof(apple_language
) - 15);
919 #endif /* __APPLE__ */
921 switch (strlen(attr
->values
[0].string
.text
))
925 * This is an unknown or badly formatted language code; use
926 * the POSIX locale...
929 strlcpy(lang
, "LANG=C", sizeof(lang
));
934 * Just the language code (ll)...
937 snprintf(lang
, sizeof(lang
), "LANG=%s.UTF-8",
938 attr
->values
[0].string
.text
);
943 * Language and country code (ll-cc)...
946 snprintf(lang
, sizeof(lang
), "LANG=%c%c_%c%c.UTF-8",
947 attr
->values
[0].string
.text
[0],
948 attr
->values
[0].string
.text
[1],
949 toupper(attr
->values
[0].string
.text
[3] & 255),
950 toupper(attr
->values
[0].string
.text
[4] & 255));
954 if ((attr
= ippFindAttribute(job
->attrs
, "document-format",
955 IPP_TAG_MIMETYPE
)) != NULL
&&
956 (ptr
= strstr(attr
->values
[0].string
.text
, "charset=")) != NULL
)
957 snprintf(charset
, sizeof(charset
), "CHARSET=%s", ptr
+ 8);
959 strlcpy(charset
, "CHARSET=utf-8", sizeof(charset
));
961 snprintf(content_type
, sizeof(content_type
), "CONTENT_TYPE=%s/%s",
962 job
->filetypes
[job
->current_file
]->super
,
963 job
->filetypes
[job
->current_file
]->type
);
964 snprintf(device_uri
, sizeof(device_uri
), "DEVICE_URI=%s",
965 job
->printer
->device_uri
);
966 snprintf(ppd
, sizeof(ppd
), "PPD=%s/ppd/%s.ppd", ServerRoot
,
968 snprintf(printer_info
, sizeof(printer_name
), "PRINTER_INFO=%s",
969 job
->printer
->info
? job
->printer
->info
: "");
970 snprintf(printer_location
, sizeof(printer_name
), "PRINTER_LOCATION=%s",
971 job
->printer
->location
? job
->printer
->location
: "");
972 snprintf(printer_name
, sizeof(printer_name
), "PRINTER=%s", job
->printer
->name
);
973 if (job
->printer
->num_reasons
> 0)
975 char *psrptr
; /* Pointer into PRINTER_STATE_REASONS */
976 size_t psrlen
; /* Size of PRINTER_STATE_REASONS */
978 for (psrlen
= 22, i
= 0; i
< job
->printer
->num_reasons
; i
++)
979 psrlen
+= strlen(job
->printer
->reasons
[i
]) + 1;
981 if ((printer_state_reasons
= malloc(psrlen
)) != NULL
)
984 * All of these strcpy's are safe because we allocated the psr string...
987 strlcpy(printer_state_reasons
, "PRINTER_STATE_REASONS=", psrlen
);
988 for (psrptr
= printer_state_reasons
+ 22, i
= 0;
989 i
< job
->printer
->num_reasons
;
994 strlcpy(psrptr
, job
->printer
->reasons
[i
], psrlen
- (size_t)(psrptr
- printer_state_reasons
));
995 psrptr
+= strlen(psrptr
);
999 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
1001 if (job
->printer
->num_auth_info_required
== 1)
1002 snprintf(auth_info_required
, sizeof(auth_info_required
),
1003 "AUTH_INFO_REQUIRED=%s",
1004 job
->printer
->auth_info_required
[0]);
1005 else if (job
->printer
->num_auth_info_required
== 2)
1006 snprintf(auth_info_required
, sizeof(auth_info_required
),
1007 "AUTH_INFO_REQUIRED=%s,%s",
1008 job
->printer
->auth_info_required
[0],
1009 job
->printer
->auth_info_required
[1]);
1010 else if (job
->printer
->num_auth_info_required
== 3)
1011 snprintf(auth_info_required
, sizeof(auth_info_required
),
1012 "AUTH_INFO_REQUIRED=%s,%s,%s",
1013 job
->printer
->auth_info_required
[0],
1014 job
->printer
->auth_info_required
[1],
1015 job
->printer
->auth_info_required
[2]);
1016 else if (job
->printer
->num_auth_info_required
== 4)
1017 snprintf(auth_info_required
, sizeof(auth_info_required
),
1018 "AUTH_INFO_REQUIRED=%s,%s,%s,%s",
1019 job
->printer
->auth_info_required
[0],
1020 job
->printer
->auth_info_required
[1],
1021 job
->printer
->auth_info_required
[2],
1022 job
->printer
->auth_info_required
[3]);
1024 strlcpy(auth_info_required
, "AUTH_INFO_REQUIRED=none",
1025 sizeof(auth_info_required
));
1027 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
1029 envp
[envc
++] = charset
;
1030 envp
[envc
++] = lang
;
1032 envp
[envc
++] = apple_language
;
1033 #endif /* __APPLE__ */
1034 envp
[envc
++] = ppd
;
1035 envp
[envc
++] = rip_max_cache
;
1036 envp
[envc
++] = content_type
;
1037 envp
[envc
++] = device_uri
;
1038 envp
[envc
++] = printer_info
;
1039 envp
[envc
++] = printer_location
;
1040 envp
[envc
++] = printer_name
;
1041 envp
[envc
++] = printer_state_reasons
? printer_state_reasons
:
1042 "PRINTER_STATE_REASONS=none";
1043 envp
[envc
++] = banner_page
? "CUPS_FILETYPE=job-sheet" :
1044 "CUPS_FILETYPE=document";
1046 if (final_content_type
[0])
1047 envp
[envc
++] = final_content_type
;
1049 if (Classification
&& !banner_page
)
1051 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
1052 IPP_TAG_NAME
)) == NULL
)
1053 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1055 else if (attr
->num_values
> 1 &&
1056 strcmp(attr
->values
[1].string
.text
, "none") != 0)
1057 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1058 attr
->values
[1].string
.text
);
1060 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1061 attr
->values
[0].string
.text
);
1063 envp
[envc
++] = classification
;
1066 if (job
->dtype
& CUPS_PRINTER_CLASS
)
1068 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
1069 envp
[envc
++] = class_name
;
1072 envp
[envc
++] = auth_info_required
;
1075 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1077 if (job
->auth_env
[i
])
1078 envp
[envc
++] = job
->auth_env
[i
];
1083 envp
[envc
++] = job
->auth_uid
;
1087 for (i
= 0; i
< envc
; i
++)
1088 if (!strncmp(envp
[i
], "AUTH_", 5))
1089 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"AUTH_%c****\"", i
,
1091 else if (strncmp(envp
[i
], "DEVICE_URI=", 11))
1092 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"%s\"", i
, envp
[i
]);
1094 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"DEVICE_URI=%s\"", i
,
1095 job
->printer
->sanitized_device_uri
);
1097 if (job
->printer
->remote
)
1098 job
->current_file
= job
->num_files
;
1100 job
->current_file
++;
1103 * Now create processes for all of the filters...
1106 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
1108 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
1110 if (filter
->filter
[0] != '/')
1111 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
1114 strlcpy(command
, filter
->filter
, sizeof(command
));
1116 if (i
< (cupsArrayCount(filters
) - 1))
1118 if (cupsdOpenPipe(filterfds
[slot
]))
1120 abort_message
= "Stopping job because the scheduler could not create "
1121 "the filter pipes.";
1128 if (job
->current_file
== 1 ||
1129 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1131 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1133 if (cupsdOpenPipe(job
->print_pipes
))
1135 abort_message
= "Stopping job because the scheduler could not "
1136 "create the backend pipes.";
1143 job
->print_pipes
[0] = -1;
1144 if (!strcmp(job
->printer
->device_uri
, "file:/dev/null") ||
1145 !strcmp(job
->printer
->device_uri
, "file:///dev/null"))
1146 job
->print_pipes
[1] = -1;
1149 if (!strncmp(job
->printer
->device_uri
, "file:/dev/", 10))
1150 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1152 else if (!strncmp(job
->printer
->device_uri
, "file:///dev/", 12))
1153 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1155 else if (!strncmp(job
->printer
->device_uri
, "file:///", 8))
1156 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1157 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1159 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1160 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1162 if (job
->print_pipes
[1] < 0)
1164 abort_message
= "Stopping job because the scheduler could not "
1165 "open the output file.";
1170 fcntl(job
->print_pipes
[1], F_SETFD
,
1171 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
1176 filterfds
[slot
][0] = job
->print_pipes
[0];
1177 filterfds
[slot
][1] = job
->print_pipes
[1];
1180 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1181 filterfds
[slot
][1], job
->status_pipes
[1],
1182 job
->back_pipes
[0], job
->side_pipes
[0], 0,
1183 job
->profile
, job
, job
->filters
+ i
);
1185 cupsdClosePipe(filterfds
[!slot
]);
1189 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
1190 filter
->filter
, strerror(errno
));
1192 abort_message
= "Stopping job because the scheduler could not execute a "
1198 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started filter %s (PID %d)", command
,
1210 cupsArrayDelete(filters
);
1214 * Finally, pipe the final output into a backend process if needed...
1217 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1219 if (job
->current_file
== 1 || job
->printer
->remote
||
1220 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1222 sscanf(job
->printer
->device_uri
, "%254[^:]", scheme
);
1223 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, scheme
);
1226 * See if the backend needs to run as root...
1231 else if (stat(command
, &backinfo
))
1234 backroot
= !(backinfo
.st_mode
& (S_IWGRP
| S_IRWXO
));
1236 argv
[0] = job
->printer
->sanitized_device_uri
;
1238 filterfds
[slot
][0] = -1;
1239 filterfds
[slot
][1] = -1;
1241 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1242 filterfds
[slot
][1], job
->status_pipes
[1],
1243 job
->back_pipes
[1], job
->side_pipes
[1],
1244 backroot
, job
->bprofile
, job
, &(job
->backend
));
1248 abort_message
= "Stopping job because the sheduler could not execute "
1255 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started backend %s (PID %d)",
1260 if (job
->current_file
== job
->num_files
||
1261 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1262 cupsdClosePipe(job
->print_pipes
);
1264 if (job
->current_file
== job
->num_files
)
1266 cupsdClosePipe(job
->back_pipes
);
1267 cupsdClosePipe(job
->side_pipes
);
1269 close(job
->status_pipes
[1]);
1270 job
->status_pipes
[1] = -1;
1275 filterfds
[slot
][0] = -1;
1276 filterfds
[slot
][1] = -1;
1278 if (job
->current_file
== job
->num_files
||
1279 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1280 cupsdClosePipe(job
->print_pipes
);
1282 if (job
->current_file
== job
->num_files
)
1284 close(job
->status_pipes
[1]);
1285 job
->status_pipes
[1] = -1;
1289 cupsdClosePipe(filterfds
[slot
]);
1291 for (i
= 6; i
< argc
; i
++)
1297 if (printer_state_reasons
)
1298 free(printer_state_reasons
);
1300 cupsdAddSelect(job
->status_buffer
->fd
, (cupsd_selfunc_t
)update_job
, NULL
,
1303 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
1310 * If we get here, we need to abort the current job and close out all
1311 * files and pipes...
1316 FilterLevel
-= job
->cost
;
1319 for (slot
= 0; slot
< 2; slot
++)
1320 cupsdClosePipe(filterfds
[slot
]);
1322 cupsArrayDelete(filters
);
1326 for (i
= 6; i
< argc
; i
++)
1331 if (printer_state_reasons
)
1332 free(printer_state_reasons
);
1334 cupsdClosePipe(job
->print_pipes
);
1335 cupsdClosePipe(job
->back_pipes
);
1336 cupsdClosePipe(job
->side_pipes
);
1338 cupsdRemoveSelect(job
->status_pipes
[0]);
1339 cupsdClosePipe(job
->status_pipes
);
1340 cupsdStatBufDelete(job
->status_buffer
);
1341 job
->status_buffer
= NULL
;
1344 * Update the printer and job state.
1347 cupsdSetJobState(job
, abort_state
, CUPSD_JOB_DEFAULT
, "%s", abort_message
);
1348 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_IDLE
, 0);
1349 update_job_attrs(job
, 0);
1352 free_job_history(job
);
1354 cupsArrayRemove(PrintingJobs
, job
);
1357 * Clear the printer <-> job association...
1360 job
->printer
->job
= NULL
;
1361 job
->printer
= NULL
;
1366 * 'cupsdDeleteJob()' - Free all memory used by a job.
1370 cupsdDeleteJob(cupsd_job_t
*job
, /* I - Job */
1371 cupsd_jobaction_t action
)/* I - Action */
1373 int i
; /* Looping var */
1377 finalize_job(job
, 1);
1379 if (action
== CUPSD_JOB_PURGE
)
1380 remove_job_history(job
);
1382 cupsdClearString(&job
->username
);
1383 cupsdClearString(&job
->dest
);
1385 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1387 cupsdClearString(job
->auth_env
+ i
);
1388 cupsdClearString(&job
->auth_uid
);
1390 if (action
== CUPSD_JOB_PURGE
)
1391 remove_job_files(job
);
1392 else if (job
->num_files
> 0)
1394 free(job
->compressions
);
1395 free(job
->filetypes
);
1401 free_job_history(job
);
1405 cupsArrayRemove(Jobs
, job
);
1406 cupsArrayRemove(ActiveJobs
, job
);
1407 cupsArrayRemove(PrintingJobs
, job
);
1414 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1418 cupsdFreeAllJobs(void)
1420 cupsd_job_t
*job
; /* Current job */
1428 cupsdStopAllJobs(CUPSD_JOB_FORCE
, 0);
1431 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1433 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1434 cupsdDeleteJob(job
, CUPSD_JOB_DEFAULT
);
1436 cupsdReleaseSignals();
1441 * 'cupsdFindJob()' - Find the specified job.
1444 cupsd_job_t
* /* O - Job data */
1445 cupsdFindJob(int id
) /* I - Job ID */
1447 cupsd_job_t key
; /* Search key */
1452 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
1457 * 'cupsdGetCompletedJobs()'- Generate a completed jobs list.
1460 cups_array_t
* /* O - Array of jobs */
1461 cupsdGetCompletedJobs(
1462 cupsd_printer_t
*p
) /* I - Printer */
1464 cups_array_t
*list
; /* Array of jobs */
1465 cupsd_job_t
*job
; /* Current job */
1468 list
= cupsArrayNew(compare_completed_jobs
, NULL
);
1470 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1472 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1473 if ((!p
|| !_cups_strcasecmp(p
->name
, job
->dest
)) && job
->state_value
>= IPP_JOB_STOPPED
&& job
->completed_time
)
1474 cupsArrayAdd(list
, job
);
1481 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1482 * or held jobs in a printer or class.
1485 int /* O - Job count */
1486 cupsdGetPrinterJobCount(
1487 const char *dest
) /* I - Printer or class name */
1489 int count
; /* Job count */
1490 cupsd_job_t
*job
; /* Current job */
1493 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1495 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1496 if (job
->dest
&& !_cups_strcasecmp(job
->dest
, dest
))
1504 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1505 * or held jobs for a user.
1508 int /* O - Job count */
1509 cupsdGetUserJobCount(
1510 const char *username
) /* I - Username */
1512 int count
; /* Job count */
1513 cupsd_job_t
*job
; /* Current job */
1516 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1518 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1519 if (!_cups_strcasecmp(job
->username
, username
))
1527 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1531 cupsdLoadAllJobs(void)
1533 char filename
[1024]; /* Full filename of job.cache file */
1534 struct stat fileinfo
; /* Information on job.cache file */
1535 cups_dir_t
*dir
; /* RequestRoot dir */
1536 cups_dentry_t
*dent
; /* Entry in RequestRoot */
1537 int load_cache
= 1; /* Load the job.cache file? */
1541 * Create the job arrays as needed...
1545 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1548 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1551 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1554 * See whether the job.cache file is older than the RequestRoot directory...
1557 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1559 if (stat(filename
, &fileinfo
))
1562 * No job.cache file...
1567 if (errno
!= ENOENT
)
1568 cupsdLogMessage(CUPSD_LOG_ERROR
,
1569 "Unable to get file information for \"%s\" - %s",
1570 filename
, strerror(errno
));
1572 else if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
1575 * No spool directory...
1582 while ((dent
= cupsDirRead(dir
)) != NULL
)
1584 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c' && dent
->fileinfo
.st_mtime
> fileinfo
.st_mtime
)
1587 * Job history file is newer than job.cache file...
1597 * Load the most recent source for job data...
1603 * Load the job.cache file...
1606 load_job_cache(filename
);
1611 * Load the job history files...
1614 load_request_root();
1616 load_next_job_id(filename
);
1620 * Clean out old jobs as needed...
1623 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1629 * 'cupsdLoadJob()' - Load a single job.
1632 int /* O - 1 on success, 0 on failure */
1633 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1635 int i
; /* Looping var */
1636 char jobfile
[1024]; /* Job filename */
1637 cups_file_t
*fp
; /* Job file */
1638 int fileid
; /* Current file ID */
1639 ipp_attribute_t
*attr
; /* Job attribute */
1640 const char *dest
; /* Destination name */
1641 cupsd_printer_t
*destptr
; /* Pointer to destination */
1642 mime_type_t
**filetypes
; /* New filetypes array */
1643 int *compressions
; /* New compressions array */
1648 if (job
->state_value
> IPP_JOB_STOPPED
)
1649 job
->access_time
= time(NULL
);
1654 if ((job
->attrs
= ippNew()) == NULL
)
1656 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes.");
1661 * Load job attributes...
1664 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading attributes...");
1666 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1667 if ((fp
= cupsdOpenConfFile(jobfile
)) == NULL
)
1670 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1672 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1673 "Unable to read job control file \"%s\".", jobfile
);
1681 * Copy attribute data to the job object...
1684 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1686 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1687 "Missing or bad time-at-creation attribute in control file.");
1691 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1692 IPP_TAG_ENUM
)) == NULL
)
1694 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1695 "Missing or bad job-state attribute in control file.");
1699 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1701 job
->history_time
= 0;
1703 if ((attr
= ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
)) != NULL
)
1704 job
->creation_time
= attr
->values
[0].integer
;
1706 if (job
->state_value
>= IPP_JOB_CANCELED
&& (attr
= ippFindAttribute(job
->attrs
, "time-at-completed", IPP_TAG_INTEGER
)) != NULL
)
1708 job
->completed_time
= attr
->values
[0].integer
;
1710 if (JobHistory
< INT_MAX
)
1711 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
1713 job
->history_time
= INT_MAX
;
1715 if (job
->history_time
< time(NULL
))
1716 goto error
; /* Expired, remove from history */
1718 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1719 JobHistoryUpdate
= job
->history_time
;
1721 if (JobFiles
< INT_MAX
)
1722 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
1724 job
->file_time
= INT_MAX
;
1726 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1727 JobHistoryUpdate
= job
->file_time
;
1729 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdLoadJob: JobHistoryUpdate=%ld",
1730 (long)JobHistoryUpdate
);
1735 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1736 IPP_TAG_URI
)) == NULL
)
1738 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1739 "No job-printer-uri attribute in control file.");
1743 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1746 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1747 "Unable to queue job for destination \"%s\".",
1748 attr
->values
[0].string
.text
);
1752 cupsdSetString(&job
->dest
, dest
);
1754 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1756 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1757 "Unable to queue job for destination \"%s\".",
1762 if ((job
->reasons
= ippFindAttribute(job
->attrs
, "job-state-reasons",
1763 IPP_TAG_KEYWORD
)) == NULL
)
1765 const char *reason
; /* job-state-reason keyword */
1767 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1768 "Adding missing job-state-reasons attribute to control file.");
1770 switch (job
->state_value
)
1773 case IPP_JOB_PENDING
:
1774 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1775 reason
= "printer-stopped";
1781 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1782 IPP_TAG_ZERO
)) != NULL
&&
1783 (attr
->value_tag
== IPP_TAG_NAME
||
1784 attr
->value_tag
== IPP_TAG_NAMELANG
||
1785 attr
->value_tag
== IPP_TAG_KEYWORD
) &&
1786 strcmp(attr
->values
[0].string
.text
, "no-hold"))
1787 reason
= "job-hold-until-specified";
1789 reason
= "job-incoming";
1792 case IPP_JOB_PROCESSING
:
1793 reason
= "job-printing";
1796 case IPP_JOB_STOPPED
:
1797 reason
= "job-stopped";
1800 case IPP_JOB_CANCELED
:
1801 reason
= "job-canceled-by-user";
1804 case IPP_JOB_ABORTED
:
1805 reason
= "aborted-by-system";
1808 case IPP_JOB_COMPLETED
:
1809 reason
= "job-completed-successfully";
1813 job
->reasons
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
1814 "job-state-reasons", NULL
, reason
);
1816 else if (job
->state_value
== IPP_JOB_PENDING
)
1818 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1819 ippSetString(job
->attrs
, &job
->reasons
, 0, "printer-stopped");
1821 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
1824 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed",
1826 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1830 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1831 IPP_TAG_INTEGER
)) == NULL
)
1833 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1834 "Missing or bad job-priority attribute in control file.");
1838 job
->priority
= attr
->values
[0].integer
;
1843 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1844 IPP_TAG_NAME
)) == NULL
)
1846 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1847 "Missing or bad job-originating-user-name "
1848 "attribute in control file.");
1852 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1857 if ((attr
= ippFindAttribute(job
->attrs
, "job-name", IPP_TAG_NAME
)) != NULL
)
1858 cupsdSetString(&job
->name
, attr
->values
[0].string
.text
);
1862 * Set the job hold-until time and state...
1865 if (job
->state_value
== IPP_JOB_HELD
)
1867 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1868 IPP_TAG_KEYWORD
)) == NULL
)
1869 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1872 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1875 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1876 job
->state_value
= IPP_JOB_PENDING
;
1879 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1881 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1882 job
->state_value
= IPP_JOB_PENDING
;
1885 if ((attr
= ippFindAttribute(job
->attrs
, "job-k-octets", IPP_TAG_INTEGER
)) != NULL
)
1886 job
->koctets
= attr
->values
[0].integer
;
1888 if (!job
->num_files
)
1891 * Find all the d##### files...
1894 for (fileid
= 1; fileid
< 10000; fileid
++)
1896 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1899 if (access(jobfile
, 0))
1902 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1903 "Auto-typing document file \"%s\"...", jobfile
);
1905 if (fileid
> job
->num_files
)
1907 if (job
->num_files
== 0)
1909 compressions
= (int *)calloc((size_t)fileid
, sizeof(int));
1910 filetypes
= (mime_type_t
**)calloc((size_t)fileid
, sizeof(mime_type_t
*));
1914 compressions
= (int *)realloc(job
->compressions
, sizeof(int) * (size_t)fileid
);
1915 filetypes
= (mime_type_t
**)realloc(job
->filetypes
, sizeof(mime_type_t
*) * (size_t)fileid
);
1919 job
->compressions
= compressions
;
1922 job
->filetypes
= filetypes
;
1924 if (!compressions
|| !filetypes
)
1926 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1927 "Ran out of memory for job file types.");
1929 ippDelete(job
->attrs
);
1932 if (job
->compressions
)
1934 free(job
->compressions
);
1935 job
->compressions
= NULL
;
1940 free(job
->filetypes
);
1941 job
->filetypes
= NULL
;
1948 job
->num_files
= fileid
;
1951 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1952 job
->compressions
+ fileid
- 1);
1954 if (!job
->filetypes
[fileid
- 1])
1955 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1961 * Load authentication information as needed...
1964 if (job
->state_value
< IPP_JOB_STOPPED
)
1966 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1969 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1971 cupsdClearString(job
->auth_env
+ i
);
1972 cupsdClearString(&job
->auth_uid
);
1974 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
1976 int bytes
, /* Size of auth data */
1977 linenum
= 1; /* Current line number */
1978 char line
[65536], /* Line from file */
1979 *value
, /* Value from line */
1980 data
[65536]; /* Decoded data */
1983 if (cupsFileGets(fp
, line
, sizeof(line
)) &&
1984 !strcmp(line
, "CUPSD-AUTH-V3"))
1987 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
1993 if (strcmp(line
, "negotiate") && strcmp(line
, "uid"))
1995 bytes
= sizeof(data
);
1996 httpDecode64_2(data
, &bytes
, value
);
2000 * Assign environment variables...
2003 if (!strcmp(line
, "uid"))
2005 cupsdSetStringf(&job
->auth_uid
, "AUTH_UID=%s", value
);
2008 else if (i
>= (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0])))
2011 if (!strcmp(line
, "username"))
2012 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_USERNAME=%s", data
);
2013 else if (!strcmp(line
, "domain"))
2014 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_DOMAIN=%s", data
);
2015 else if (!strcmp(line
, "password"))
2016 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_PASSWORD=%s", data
);
2017 else if (!strcmp(line
, "negotiate"))
2018 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_NEGOTIATE=%s", value
);
2030 job
->access_time
= time(NULL
);
2034 * If we get here then something bad happened...
2039 ippDelete(job
->attrs
);
2042 remove_job_history(job
);
2043 remove_job_files(job
);
2050 * 'cupsdMoveJob()' - Move the specified job to a different destination.
2054 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
2055 cupsd_printer_t
*p
) /* I - Destination printer or class */
2057 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
2058 const char *olddest
; /* Old destination */
2059 cupsd_printer_t
*oldp
; /* Old pointer */
2063 * Don't move completed jobs...
2066 if (job
->state_value
> IPP_JOB_STOPPED
)
2070 * Get the old destination...
2073 olddest
= job
->dest
;
2076 oldp
= job
->printer
;
2078 oldp
= cupsdFindDest(olddest
);
2081 * Change the destination information...
2084 if (job
->state_value
> IPP_JOB_HELD
)
2085 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2086 "Stopping job prior to move.");
2088 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
2089 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2092 cupsdSetString(&job
->dest
, p
->name
);
2093 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
);
2095 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
2096 IPP_TAG_URI
)) != NULL
)
2097 cupsdSetString(&(attr
->values
[0].string
.text
), p
->uri
);
2099 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
2100 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2104 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2109 * 'cupsdReleaseJob()' - Release the specified job.
2113 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
2115 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
2118 if (job
->state_value
== IPP_JOB_HELD
)
2121 * Add trailing banner as needed...
2124 if (job
->pending_timeout
)
2125 cupsdTimeoutJob(job
);
2127 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2128 "Job released by user.");
2134 * 'cupsdRestartJob()' - Restart the specified job.
2138 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
2140 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
2143 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
2144 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2145 "Job restarted by user.");
2150 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2154 cupsdSaveAllJobs(void)
2156 int i
; /* Looping var */
2157 cups_file_t
*fp
; /* job.cache file */
2158 char filename
[1024], /* job.cache filename */
2159 temp
[1024]; /* Temporary string */
2160 cupsd_job_t
*job
; /* Current job */
2161 time_t curtime
; /* Current time */
2162 struct tm
*curdate
; /* Current date */
2165 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
2166 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
)) == NULL
)
2169 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job.cache...");
2172 * Write a small header to the file...
2175 curtime
= time(NULL
);
2176 curdate
= localtime(&curtime
);
2177 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
2179 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
2180 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
2181 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
2184 * Write each job known to the system...
2187 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2189 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2191 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
2192 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
2193 cupsFilePrintf(fp
, "Created %ld\n", (long)job
->creation_time
);
2194 if (job
->completed_time
)
2195 cupsFilePrintf(fp
, "Completed %ld\n", (long)job
->completed_time
);
2196 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
2197 if (job
->hold_until
)
2198 cupsFilePrintf(fp
, "HoldUntil %ld\n", (long)job
->hold_until
);
2199 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
2201 cupsFilePutConf(fp
, "Name", job
->name
);
2202 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
2203 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
2204 cupsFilePrintf(fp
, "KOctets %d\n", job
->koctets
);
2205 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
2206 for (i
= 0; i
< job
->num_files
; i
++)
2207 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
2208 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
2209 cupsFilePuts(fp
, "</Job>\n");
2212 cupsdCloseCreatedConfFile(fp
, filename
);
2217 * 'cupsdSaveJob()' - Save a job to disk.
2221 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
2223 char filename
[1024]; /* Job control filename */
2224 cups_file_t
*fp
; /* Job file */
2227 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2228 job
, job
->id
, job
->attrs
);
2230 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
2232 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
& 0600)) == NULL
)
2235 fchown(cupsFileNumber(fp
), RunUser
, Group
);
2237 job
->attrs
->state
= IPP_IDLE
;
2239 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
2240 job
->attrs
) != IPP_DATA
)
2242 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to write job control file.");
2247 if (!cupsdCloseCreatedConfFile(fp
, filename
))
2250 * Remove backup file and mark this job as clean...
2253 strlcat(filename
, ".O", sizeof(filename
));
2262 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2266 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
2267 const char *when
, /* I - When to resume */
2268 int update
)/* I - Update job-hold-until attr? */
2270 time_t curtime
; /* Current time */
2271 struct tm
*curdate
; /* Current date */
2272 int hour
; /* Hold hour */
2273 int minute
; /* Hold minute */
2274 int second
= 0; /* Hold second */
2277 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2278 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2279 job
, job
->id
, when
, update
);
2284 * Update the job-hold-until attribute...
2287 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2289 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2290 IPP_TAG_KEYWORD
)) == NULL
)
2291 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2294 cupsdSetString(&(attr
->values
[0].string
.text
), when
);
2296 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2297 "job-hold-until", NULL
, when
);
2301 if (isdigit(when
[0] & 255))
2302 attr
->value_tag
= IPP_TAG_NAME
;
2304 attr
->value_tag
= IPP_TAG_KEYWORD
;
2307 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2312 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-hold-until-specified");
2315 * Update the hold time...
2318 job
->cancel_time
= 0;
2320 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2323 * Hold indefinitely...
2326 job
->hold_until
= 0;
2328 if (MaxHoldTime
> 0)
2329 job
->cancel_time
= time(NULL
) + MaxHoldTime
;
2331 else if (!strcmp(when
, "day-time"))
2334 * Hold to 6am the next morning unless local time is < 6pm.
2337 curtime
= time(NULL
);
2338 curdate
= localtime(&curtime
);
2340 if (curdate
->tm_hour
< 18)
2341 job
->hold_until
= curtime
;
2343 job
->hold_until
= curtime
+
2344 ((29 - curdate
->tm_hour
) * 60 + 59 -
2345 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2347 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2350 * Hold to 6pm unless local time is > 6pm or < 6am.
2353 curtime
= time(NULL
);
2354 curdate
= localtime(&curtime
);
2356 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2357 job
->hold_until
= curtime
;
2359 job
->hold_until
= curtime
+
2360 ((17 - curdate
->tm_hour
) * 60 + 59 -
2361 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2363 else if (!strcmp(when
, "second-shift"))
2366 * Hold to 4pm unless local time is > 4pm.
2369 curtime
= time(NULL
);
2370 curdate
= localtime(&curtime
);
2372 if (curdate
->tm_hour
>= 16)
2373 job
->hold_until
= curtime
;
2375 job
->hold_until
= curtime
+
2376 ((15 - curdate
->tm_hour
) * 60 + 59 -
2377 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2379 else if (!strcmp(when
, "third-shift"))
2382 * Hold to 12am unless local time is < 8am.
2385 curtime
= time(NULL
);
2386 curdate
= localtime(&curtime
);
2388 if (curdate
->tm_hour
< 8)
2389 job
->hold_until
= curtime
;
2391 job
->hold_until
= curtime
+
2392 ((23 - curdate
->tm_hour
) * 60 + 59 -
2393 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2395 else if (!strcmp(when
, "weekend"))
2398 * Hold to weekend unless we are in the weekend.
2401 curtime
= time(NULL
);
2402 curdate
= localtime(&curtime
);
2404 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2405 job
->hold_until
= curtime
;
2407 job
->hold_until
= curtime
+
2408 (((5 - curdate
->tm_wday
) * 24 +
2409 (17 - curdate
->tm_hour
)) * 60 + 59 -
2410 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2412 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2415 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2418 curtime
= time(NULL
);
2419 curdate
= gmtime(&curtime
);
2421 job
->hold_until
= curtime
+
2422 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2423 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2426 * Hold until next day as needed...
2429 if (job
->hold_until
< curtime
)
2430 job
->hold_until
+= 24 * 60 * 60;
2433 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2434 (int)job
->hold_until
);
2439 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2440 * the list as needed.
2444 cupsdSetJobPriority(
2445 cupsd_job_t
*job
, /* I - Job ID */
2446 int priority
) /* I - New priority (0 to 100) */
2448 ipp_attribute_t
*attr
; /* Job attribute */
2452 * Don't change completed jobs...
2455 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2459 * Set the new priority and re-add the job into the active list...
2462 cupsArrayRemove(ActiveJobs
, job
);
2464 job
->priority
= priority
;
2466 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2467 IPP_TAG_INTEGER
)) != NULL
)
2468 attr
->values
[0].integer
= priority
;
2470 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2473 cupsArrayAdd(ActiveJobs
, job
);
2476 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2481 * 'cupsdSetJobState()' - Set the state of the specified print job.
2486 cupsd_job_t
*job
, /* I - Job to cancel */
2487 ipp_jstate_t newstate
, /* I - New job state */
2488 cupsd_jobaction_t action
, /* I - Action to take */
2489 const char *message
, /* I - Message to log */
2490 ...) /* I - Additional arguments as needed */
2492 int i
; /* Looping var */
2493 ipp_jstate_t oldstate
; /* Old state */
2494 char filename
[1024]; /* Job filename */
2495 ipp_attribute_t
*attr
; /* Job attribute */
2498 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2499 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2500 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2501 newstate
, action
, message
? message
: "(null)");
2505 * Make sure we have the job attributes...
2508 if (!cupsdLoadJob(job
))
2512 * Don't do anything if the state is unchanged and we aren't purging the
2516 oldstate
= job
->state_value
;
2517 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2521 * Stop any processes that are working on the current job...
2524 if (oldstate
== IPP_JOB_PROCESSING
)
2525 stop_job(job
, action
);
2528 * Set the new job state...
2531 job
->state_value
= newstate
;
2534 job
->state
->values
[0].integer
= newstate
;
2538 case IPP_JOB_PENDING
:
2540 * Update job-hold-until as needed...
2543 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2544 IPP_TAG_KEYWORD
)) == NULL
)
2545 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2549 attr
->value_tag
= IPP_TAG_KEYWORD
;
2550 cupsdSetString(&(attr
->values
[0].string
.text
), "no-hold");
2556 case IPP_JOB_ABORTED
:
2557 case IPP_JOB_CANCELED
:
2558 case IPP_JOB_COMPLETED
:
2559 set_time(job
, "time-at-completed");
2560 ippSetString(job
->attrs
, &job
->reasons
, 0, "processing-to-stop-point");
2565 * Log message as needed...
2570 char buffer
[2048]; /* Message buffer */
2571 va_list ap
; /* Pointer to additional arguments */
2573 va_start(ap
, message
);
2574 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2577 if (newstate
> IPP_JOB_STOPPED
)
2578 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2580 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2582 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2583 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2585 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2589 * Handle post-state-change actions...
2594 case IPP_JOB_PROCESSING
:
2596 * Add the job to the "printing" list...
2599 if (!cupsArrayFind(PrintingJobs
, job
))
2600 cupsArrayAdd(PrintingJobs
, job
);
2603 * Set the processing time...
2606 set_time(job
, "time-at-processing");
2608 case IPP_JOB_PENDING
:
2610 case IPP_JOB_STOPPED
:
2612 * Make sure the job is in the active list...
2615 if (!cupsArrayFind(ActiveJobs
, job
))
2616 cupsArrayAdd(ActiveJobs
, job
);
2619 * Save the job state to disk...
2623 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2626 case IPP_JOB_ABORTED
:
2627 case IPP_JOB_CANCELED
:
2628 case IPP_JOB_COMPLETED
:
2629 if (newstate
== IPP_JOB_CANCELED
)
2632 * Remove the job from the active list if there are no processes still
2636 for (i
= 0; job
->filters
[i
] < 0; i
++);
2638 if (!job
->filters
[i
] && job
->backend
<= 0)
2639 cupsArrayRemove(ActiveJobs
, job
);
2644 * Otherwise just remove the job from the active list immediately...
2647 cupsArrayRemove(ActiveJobs
, job
);
2651 * Expire job subscriptions since the job is now "completed"...
2654 cupsdExpireSubscriptions(NULL
, job
);
2658 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2659 * sleep to happen immediately...
2662 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2664 #endif /* __APPLE__ */
2667 * Remove any authentication data...
2670 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2671 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2672 cupsdLogMessage(CUPSD_LOG_ERROR
,
2673 "Unable to remove authentication cache: %s",
2677 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
2679 cupsdClearString(job
->auth_env
+ i
);
2681 cupsdClearString(&job
->auth_uid
);
2684 * Remove the print file for good if we aren't preserving jobs or
2688 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2689 remove_job_files(job
);
2691 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2694 * Save job state info...
2698 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2700 else if (!job
->printer
)
2703 * Delete the job immediately if not actively printing...
2706 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2713 * Finalize the job immediately if we forced things...
2716 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2717 finalize_job(job
, 0);
2720 * Update the server "busy" state...
2723 cupsdSetBusyState();
2728 * 'cupsdStopAllJobs()' - Stop all print jobs.
2733 cupsd_jobaction_t action
, /* I - Action */
2734 int kill_delay
) /* I - Number of seconds before we kill */
2736 cupsd_job_t
*job
; /* Current job */
2739 DEBUG_puts("cupsdStopAllJobs()");
2741 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2743 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2747 cupsdSetJobState(job
, IPP_JOB_COMPLETED
, CUPSD_JOB_FORCE
, NULL
);
2752 job
->kill_time
= time(NULL
) + kill_delay
;
2754 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2761 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2765 cupsdUnloadCompletedJobs(void)
2767 cupsd_job_t
*job
; /* Current job */
2768 time_t expire
; /* Expiration time */
2771 expire
= time(NULL
) - 60;
2773 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2775 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2776 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2777 job
->access_time
< expire
)
2788 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2792 cupsdUpdateJobs(void)
2794 cupsd_job_t
*job
; /* Current job */
2795 time_t curtime
; /* Current time */
2796 ipp_attribute_t
*attr
; /* time-at-completed attribute */
2799 curtime
= time(NULL
);
2800 JobHistoryUpdate
= 0;
2802 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2804 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2806 if (job
->state_value
>= IPP_JOB_CANCELED
&&
2807 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
2808 IPP_TAG_INTEGER
)) != NULL
)
2811 * Update history/file expiration times...
2814 if (JobHistory
< INT_MAX
)
2815 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
2817 job
->history_time
= INT_MAX
;
2819 if (job
->history_time
< curtime
)
2821 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2825 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2826 JobHistoryUpdate
= job
->history_time
;
2828 if (JobFiles
< INT_MAX
)
2829 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
2831 job
->file_time
= INT_MAX
;
2833 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2834 JobHistoryUpdate
= job
->file_time
;
2838 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdUpdateAllJobs: JobHistoryUpdate=%ld",
2839 (long)JobHistoryUpdate
);
2844 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2847 static int /* O - Difference */
2848 compare_active_jobs(void *first
, /* I - First job */
2849 void *second
, /* I - Second job */
2850 void *data
) /* I - App data (not used) */
2852 int diff
; /* Difference */
2857 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2858 ((cupsd_job_t
*)first
)->priority
) != 0)
2861 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2866 * 'compare_completed_jobs()' - Compare the job IDs and completion times of two jobs.
2869 static int /* O - Difference */
2870 compare_completed_jobs(void *first
, /* I - First job */
2871 void *second
, /* I - Second job */
2872 void *data
) /* I - App data (not used) */
2874 int diff
; /* Difference */
2879 if ((diff
= ((cupsd_job_t
*)second
)->completed_time
-
2880 ((cupsd_job_t
*)first
)->completed_time
) != 0)
2883 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2888 * 'compare_jobs()' - Compare the job IDs of two jobs.
2891 static int /* O - Difference */
2892 compare_jobs(void *first
, /* I - First job */
2893 void *second
, /* I - Second job */
2894 void *data
) /* I - App data (not used) */
2898 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2903 * 'dump_job_history()' - Dump any debug messages for a job.
2907 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2909 int i
, /* Looping var */
2910 oldsize
; /* Current MaxLogSize */
2911 struct tm
*date
; /* Date/time value */
2912 cupsd_joblog_t
*message
; /* Current message */
2913 char temp
[2048], /* Log message */
2914 *ptr
, /* Pointer into log message */
2915 start
[256], /* Start time */
2916 end
[256]; /* End time */
2917 cupsd_printer_t
*printer
; /* Printer for job */
2921 * See if we have anything to dump...
2928 * Disable log rotation temporarily...
2931 oldsize
= MaxLogSize
;
2935 * Copy the debug messages to the log...
2938 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2939 date
= localtime(&(message
->time
));
2940 strftime(start
, sizeof(start
), "%X", date
);
2942 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2943 date
= localtime(&(message
->time
));
2944 strftime(end
, sizeof(end
), "%X", date
);
2946 snprintf(temp
, sizeof(temp
),
2947 "[Job %d] The following messages were recorded from %s to %s",
2948 job
->id
, start
, end
);
2949 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2951 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2953 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
2954 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
2956 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
2957 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2960 * Log the printer state values...
2963 if ((printer
= job
->printer
) == NULL
)
2964 printer
= cupsdFindDest(job
->dest
);
2968 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
2970 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
2971 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
2973 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2975 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
2976 job
->id
, printer
->state_message
);
2977 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2979 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
2980 ptr
= temp
+ strlen(temp
);
2981 if (printer
->num_reasons
== 0)
2982 strlcpy(ptr
, "none", sizeof(temp
) - (size_t)(ptr
- temp
));
2986 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
2992 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (size_t)(ptr
- temp
));
2996 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3000 * Restore log file rotation...
3003 MaxLogSize
= oldsize
;
3006 * Free all messages...
3009 free_job_history(job
);
3014 * 'free_job_history()' - Free any log history.
3018 free_job_history(cupsd_job_t
*job
) /* I - Job */
3020 char *message
; /* Current message */
3026 for (message
= (char *)cupsArrayFirst(job
->history
);
3028 message
= (char *)cupsArrayNext(job
->history
))
3031 cupsArrayDelete(job
->history
);
3032 job
->history
= NULL
;
3037 * 'finalize_job()' - Cleanup after job filter processes and support data.
3041 finalize_job(cupsd_job_t
*job
, /* I - Job */
3042 int set_job_state
) /* I - 1 = set the job state */
3044 ipp_pstate_t printer_state
; /* New printer state value */
3045 ipp_jstate_t job_state
; /* New job state value */
3046 const char *message
; /* Message for job state */
3047 char buffer
[1024]; /* Buffer for formatted messages */
3050 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
3053 * Clear the "connecting-to-device" and "cups-waiting-for-job-completed"
3054 * reasons, which are only valid when a printer is processing, along with any
3055 * remote printing job state...
3058 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device,"
3059 "cups-waiting-for-job-completed,"
3060 "cups-remote-pending,"
3061 "cups-remote-pending-held,"
3062 "cups-remote-processing,"
3063 "cups-remote-stopped,"
3064 "cups-remote-canceled,"
3065 "cups-remote-aborted,"
3066 "cups-remote-completed");
3069 * Similarly, clear the "offline-report" reason for non-USB devices since we
3070 * rarely have current information for network devices...
3073 if (strncmp(job
->printer
->device_uri
, "usb:", 4) &&
3074 strncmp(job
->printer
->device_uri
, "ippusb:", 7))
3075 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
3078 * Free the security profile...
3081 cupsdDestroyProfile(job
->profile
);
3082 job
->profile
= NULL
;
3083 cupsdDestroyProfile(job
->bprofile
);
3084 job
->bprofile
= NULL
;
3087 * Clear the unresponsive job watchdog timers...
3090 job
->cancel_time
= 0;
3094 * Close pipes and status buffer...
3097 cupsdClosePipe(job
->print_pipes
);
3098 cupsdClosePipe(job
->back_pipes
);
3099 cupsdClosePipe(job
->side_pipes
);
3101 cupsdRemoveSelect(job
->status_pipes
[0]);
3102 cupsdClosePipe(job
->status_pipes
);
3103 cupsdStatBufDelete(job
->status_buffer
);
3104 job
->status_buffer
= NULL
;
3107 * Process the exit status...
3110 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
3111 printer_state
= IPP_PRINTER_IDLE
;
3113 printer_state
= job
->printer
->state
;
3115 switch (job_state
= job
->state_value
)
3117 case IPP_JOB_PENDING
:
3118 message
= "Job paused.";
3122 message
= "Job held.";
3126 case IPP_JOB_PROCESSING
:
3127 case IPP_JOB_COMPLETED
:
3128 job_state
= IPP_JOB_COMPLETED
;
3129 message
= "Job completed.";
3132 ippSetString(job
->attrs
, &job
->reasons
, 0,
3133 "job-completed-successfully");
3136 case IPP_JOB_STOPPED
:
3137 message
= "Job stopped.";
3139 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-stopped");
3142 case IPP_JOB_CANCELED
:
3143 message
= "Job canceled.";
3145 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-canceled-by-user");
3148 case IPP_JOB_ABORTED
:
3149 message
= "Job aborted.";
3153 if (job
->status
< 0)
3156 * Backend had errors...
3159 int exit_code
; /* Exit code from backend */
3162 * Convert the status to an exit code. Due to the way the W* macros are
3163 * implemented on MacOS X (bug?), we have to store the exit status in a
3164 * variable first and then convert...
3167 exit_code
= -job
->status
;
3168 if (WIFEXITED(exit_code
))
3169 exit_code
= WEXITSTATUS(exit_code
);
3172 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-backend-crashed");
3173 exit_code
= job
->status
;
3176 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
3178 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
3179 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
3180 "authentication required" :
3181 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
3182 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
3183 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
3184 exit_code
== CUPS_BACKEND_RETRY
? "retry job later" :
3185 exit_code
== CUPS_BACKEND_RETRY_CURRENT
? "retry job immediately" :
3186 exit_code
< 0 ? "crashed" : "unknown");
3189 * Do what needs to be done...
3195 case CUPS_BACKEND_FAILED
:
3197 * Backend failure, use the error-policy to determine how to
3201 if (job
->dtype
& CUPS_PRINTER_CLASS
)
3204 * Queued on a class - mark the job as pending and we'll retry on
3205 * another printer...
3208 if (job_state
== IPP_JOB_COMPLETED
)
3210 job_state
= IPP_JOB_PENDING
;
3211 message
= "Retrying job on another printer.";
3213 ippSetString(job
->attrs
, &job
->reasons
, 0,
3214 "resources-are-not-ready");
3217 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
3220 * The error policy is "retry-current-job" - mark the job as pending
3221 * and we'll retry on the same printer...
3224 if (job_state
== IPP_JOB_COMPLETED
)
3226 job_state
= IPP_JOB_PENDING
;
3227 message
= "Retrying job on same printer.";
3229 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3232 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
3233 !strcmp(job
->printer
->error_policy
, "retry-job"))
3235 if (job_state
== IPP_JOB_COMPLETED
)
3238 * The job was queued on a fax or the error policy is "retry-job" -
3239 * hold the job if the number of retries is less than the
3240 * JobRetryLimit, otherwise abort the job.
3245 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3251 snprintf(buffer
, sizeof(buffer
),
3252 "Job aborted after %d unsuccessful attempts.",
3254 job_state
= IPP_JOB_ABORTED
;
3257 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3262 * Try again in N seconds...
3265 snprintf(buffer
, sizeof(buffer
),
3266 "Job held for %d seconds since it could not be sent.",
3269 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3270 job_state
= IPP_JOB_HELD
;
3273 ippSetString(job
->attrs
, &job
->reasons
, 0,
3274 "resources-are-not-ready");
3278 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
3279 job_state
== IPP_JOB_COMPLETED
)
3281 job_state
= IPP_JOB_ABORTED
;
3282 message
= "Job aborted due to backend errors; please consult "
3283 "the error_log file for details.";
3285 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3287 else if (job
->state_value
== IPP_JOB_PROCESSING
)
3289 job_state
= IPP_JOB_PENDING
;
3290 printer_state
= IPP_PRINTER_STOPPED
;
3291 message
= "Printer stopped due to backend errors; please "
3292 "consult the error_log file for details.";
3294 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3298 case CUPS_BACKEND_CANCEL
:
3303 if (job_state
== IPP_JOB_COMPLETED
)
3305 job_state
= IPP_JOB_CANCELED
;
3306 message
= "Job canceled at printer.";
3308 ippSetString(job
->attrs
, &job
->reasons
, 0, "canceled-at-device");
3312 case CUPS_BACKEND_HOLD
:
3313 if (job_state
== IPP_JOB_COMPLETED
)
3319 const char *reason
= ippGetString(job
->reasons
, 0, NULL
);
3321 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-state-reasons=\"%s\"",
3324 if (!reason
|| strncmp(reason
, "account-", 8))
3326 cupsdSetJobHoldUntil(job
, "indefinite", 1);
3328 ippSetString(job
->attrs
, &job
->reasons
, 0,
3329 "job-hold-until-specified");
3330 message
= "Job held indefinitely due to backend errors; please "
3331 "consult the error_log file for details.";
3333 else if (!strcmp(reason
, "account-info-needed"))
3335 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3337 message
= "Job held indefinitely - account information is "
3340 else if (!strcmp(reason
, "account-closed"))
3342 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3344 message
= "Job held indefinitely - account has been closed.";
3346 else if (!strcmp(reason
, "account-limit-reached"))
3348 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3350 message
= "Job held indefinitely - account limit has been "
3355 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3357 message
= "Job held indefinitely - account authorization failed.";
3360 job_state
= IPP_JOB_HELD
;
3364 case CUPS_BACKEND_STOP
:
3366 * Stop the printer...
3369 printer_state
= IPP_PRINTER_STOPPED
;
3370 message
= "Printer stopped due to backend errors; please "
3371 "consult the error_log file for details.";
3373 if (job_state
== IPP_JOB_COMPLETED
)
3375 job_state
= IPP_JOB_PENDING
;
3377 ippSetString(job
->attrs
, &job
->reasons
, 0,
3378 "resources-are-not-ready");
3382 case CUPS_BACKEND_AUTH_REQUIRED
:
3384 * Hold the job for authentication...
3387 if (job_state
== IPP_JOB_COMPLETED
)
3389 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
3391 job_state
= IPP_JOB_HELD
;
3392 message
= "Job held for authentication.";
3394 if (strncmp(job
->reasons
->values
[0].string
.text
, "account-", 8))
3395 ippSetString(job
->attrs
, &job
->reasons
, 0,
3396 "cups-held-for-authentication");
3400 case CUPS_BACKEND_RETRY
:
3401 if (job_state
== IPP_JOB_COMPLETED
)
3404 * Hold the job if the number of retries is less than the
3405 * JobRetryLimit, otherwise abort the job.
3410 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3416 snprintf(buffer
, sizeof(buffer
),
3417 "Job aborted after %d unsuccessful attempts.",
3419 job_state
= IPP_JOB_ABORTED
;
3422 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3427 * Try again in N seconds...
3430 snprintf(buffer
, sizeof(buffer
),
3431 "Job held for %d seconds since it could not be sent.",
3434 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3435 job_state
= IPP_JOB_HELD
;
3438 ippSetString(job
->attrs
, &job
->reasons
, 0,
3439 "resources-are-not-ready");
3444 case CUPS_BACKEND_RETRY_CURRENT
:
3446 * Mark the job as pending and retry on the same printer...
3449 if (job_state
== IPP_JOB_COMPLETED
)
3451 job_state
= IPP_JOB_PENDING
;
3452 message
= "Retrying job on same printer.";
3454 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3459 else if (job
->status
> 0)
3462 * Filter had errors; stop job...
3465 if (job_state
== IPP_JOB_COMPLETED
)
3467 job_state
= IPP_JOB_STOPPED
;
3468 message
= "Job stopped due to filter errors; please consult the "
3469 "error_log file for details.";
3471 if (WIFSIGNALED(job
->status
))
3472 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-filter-crashed");
3474 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-completed-with-errors");
3479 * Update the printer and job state.
3482 if (set_job_state
&& job_state
!= job
->state_value
)
3483 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
3485 cupsdSetPrinterState(job
->printer
, printer_state
,
3486 printer_state
== IPP_PRINTER_STOPPED
);
3487 update_job_attrs(job
, 0);
3492 (job
->state_value
== IPP_JOB_ABORTED
||
3493 job
->state_value
== IPP_JOB_STOPPED
))
3494 dump_job_history(job
);
3496 free_job_history(job
);
3499 cupsArrayRemove(PrintingJobs
, job
);
3502 * Apply any PPD updates...
3505 if (job
->num_keywords
)
3507 if (cupsdUpdatePrinterPPD(job
->printer
, job
->num_keywords
, job
->keywords
))
3508 cupsdSetPrinterAttrs(job
->printer
);
3510 cupsFreeOptions(job
->num_keywords
, job
->keywords
);
3512 job
->num_keywords
= 0;
3513 job
->keywords
= NULL
;
3517 * Clear the printer <-> job association...
3520 job
->printer
->job
= NULL
;
3521 job
->printer
= NULL
;
3524 * Try printing another job...
3527 if (printer_state
!= IPP_PRINTER_STOPPED
)
3533 * 'get_options()' - Get a string containing the job options.
3536 static char * /* O - Options string */
3537 get_options(cupsd_job_t
*job
, /* I - Job */
3538 int banner_page
, /* I - Printing a banner page? */
3539 char *copies
, /* I - Copies buffer */
3540 size_t copies_size
, /* I - Size of copies buffer */
3541 char *title
, /* I - Title buffer */
3542 size_t title_size
) /* I - Size of title buffer */
3544 int i
; /* Looping var */
3545 size_t newlength
; /* New option buffer length */
3546 char *optptr
, /* Pointer to options */
3547 *valptr
; /* Pointer in value string */
3548 ipp_attribute_t
*attr
; /* Current attribute */
3549 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3550 int num_pwgppds
; /* Number of PWG->PPD options */
3551 cups_option_t
*pwgppds
, /* PWG->PPD options */
3552 *pwgppd
, /* Current PWG->PPD option */
3553 *preset
; /* Current preset option */
3554 int print_color_mode
,
3555 /* Output mode (if any) */
3556 print_quality
; /* Print quality (if any) */
3557 const char *ppd
; /* PPD option choice */
3558 int exact
; /* Did we get an exact match? */
3559 static char *options
= NULL
;/* Full list of options */
3560 static size_t optlength
= 0; /* Length of option buffer */
3564 * Building the options string is harder than it needs to be, but for the
3565 * moment we need to pass strings for command-line args and not IPP attribute
3568 * First build an options array for any PWG->PPD mapped option/choice pairs.
3571 pc
= job
->printer
->pc
;
3576 !ippFindAttribute(job
->attrs
,
3577 "com.apple.print.DocumentTicket.PMSpoolFormat",
3579 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3580 (ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) ||
3581 ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
)))
3584 * Map print-color-mode and print-quality to a preset...
3587 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3588 IPP_TAG_KEYWORD
)) != NULL
&&
3589 !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3590 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3592 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3594 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality",
3595 IPP_TAG_ENUM
)) != NULL
&&
3596 attr
->values
[0].integer
>= IPP_QUALITY_DRAFT
&&
3597 attr
->values
[0].integer
<= IPP_QUALITY_HIGH
)
3598 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3600 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3602 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3605 * Try to find a preset that works so that we maximize the chances of us
3606 * getting a good print using IPP attributes.
3609 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3610 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3611 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3612 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3615 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3616 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3620 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3623 * Copy the preset options as long as the corresponding names are not
3624 * already defined in the IPP request...
3627 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3628 preset
= pc
->presets
[print_color_mode
][print_quality
];
3632 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3633 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
,
3641 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3642 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3644 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3645 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3648 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3649 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3650 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3652 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3653 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3654 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3656 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3658 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3659 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3662 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3663 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3664 IPP_TAG_ZERO
)) != NULL
&&
3665 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3666 attr
->value_tag
== IPP_TAG_NAME
) &&
3667 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3670 * Map output-bin to OutputBin option...
3673 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3676 if (pc
->sides_option
&&
3677 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3678 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3681 * Map sides to duplex option...
3684 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3685 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
,
3686 num_pwgppds
, &pwgppds
);
3687 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3688 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
,
3689 num_pwgppds
, &pwgppds
);
3690 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3691 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
,
3692 num_pwgppds
, &pwgppds
);
3696 * Map finishings values...
3699 num_pwgppds
= _ppdCacheGetFinishingOptions(pc
, job
->attrs
,
3700 IPP_FINISHINGS_NONE
, num_pwgppds
,
3705 * Figure out how much room we need...
3708 newlength
= ipp_length(job
->attrs
);
3710 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3711 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3714 * Then allocate/reallocate the option buffer as needed...
3717 if (newlength
== 0) /* This can never happen, but Clang */
3718 newlength
= 1; /* thinks it can... */
3720 if (newlength
> optlength
|| !options
)
3723 optptr
= malloc(newlength
);
3725 optptr
= realloc(options
, newlength
);
3729 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3730 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer.",
3731 CUPS_LLCAST newlength
);
3736 optlength
= newlength
;
3740 * Now loop through the attributes and convert them to the textual
3741 * representation used by the filters...
3747 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3748 strlcpy(copies
, "1", copies_size
);
3750 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3752 if (!strcmp(attr
->name
, "copies") &&
3753 attr
->value_tag
== IPP_TAG_INTEGER
)
3756 * Don't use the # copies attribute if we are printing the job sheets...
3760 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3762 else if (!strcmp(attr
->name
, "job-name") &&
3763 (attr
->value_tag
== IPP_TAG_NAME
||
3764 attr
->value_tag
== IPP_TAG_NAMELANG
))
3765 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3766 else if (attr
->group_tag
== IPP_TAG_JOB
)
3769 * Filter out other unwanted attributes...
3772 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3773 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3774 attr
->value_tag
== IPP_TAG_NAMELANG
||
3775 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3776 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid") &&
3777 strcmp(attr
->name
, "job-authorization-uri")) ||
3778 attr
->value_tag
== IPP_TAG_URISCHEME
||
3779 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3782 if (!strcmp(attr
->name
, "job-hold-until") ||
3783 !strcmp(attr
->name
, "job-id") ||
3784 !strcmp(attr
->name
, "job-k-octets") ||
3785 !strcmp(attr
->name
, "job-media-sheets") ||
3786 !strcmp(attr
->name
, "job-media-sheets-completed") ||
3787 !strcmp(attr
->name
, "job-state") ||
3788 !strcmp(attr
->name
, "job-state-reasons"))
3791 if (!strncmp(attr
->name
, "job-", 4) &&
3792 strcmp(attr
->name
, "job-account-id") &&
3793 strcmp(attr
->name
, "job-accounting-user-id") &&
3794 strcmp(attr
->name
, "job-authorization-uri") &&
3795 strcmp(attr
->name
, "job-billing") &&
3796 strcmp(attr
->name
, "job-impressions") &&
3797 strcmp(attr
->name
, "job-originating-host-name") &&
3798 strcmp(attr
->name
, "job-password") &&
3799 strcmp(attr
->name
, "job-password-encryption") &&
3800 strcmp(attr
->name
, "job-uuid") &&
3801 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3804 if ((!strcmp(attr
->name
, "job-impressions") ||
3805 !strcmp(attr
->name
, "page-label") ||
3806 !strcmp(attr
->name
, "page-border") ||
3807 !strncmp(attr
->name
, "number-up", 9) ||
3808 !strcmp(attr
->name
, "page-ranges") ||
3809 !strcmp(attr
->name
, "page-set") ||
3810 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3811 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3812 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3813 "PMTotalSidesImaged..n.") ||
3814 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3815 "PMTotalBeginPages..n.")) &&
3820 * Otherwise add them to the list...
3823 if (optptr
> options
)
3824 strlcat(optptr
, " ", optlength
- (size_t)(optptr
- options
));
3826 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3828 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
3829 strlcat(optptr
, "=", optlength
- (size_t)(optptr
- options
));
3832 for (i
= 0; i
< attr
->num_values
; i
++)
3835 strlcat(optptr
, ",", optlength
- (size_t)(optptr
- options
));
3837 optptr
+= strlen(optptr
);
3839 switch (attr
->value_tag
)
3841 case IPP_TAG_INTEGER
:
3843 snprintf(optptr
, optlength
- (size_t)(optptr
- options
),
3844 "%d", attr
->values
[i
].integer
);
3847 case IPP_TAG_BOOLEAN
:
3848 if (!attr
->values
[i
].boolean
)
3849 strlcat(optptr
, "no", optlength
- (size_t)(optptr
- options
));
3851 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
3854 case IPP_TAG_RANGE
:
3855 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3856 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3857 "%d", attr
->values
[i
].range
.lower
);
3859 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3860 "%d-%d", attr
->values
[i
].range
.lower
,
3861 attr
->values
[i
].range
.upper
);
3864 case IPP_TAG_RESOLUTION
:
3865 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3866 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
3867 attr
->values
[i
].resolution
.yres
,
3868 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
3872 case IPP_TAG_STRING
:
3875 case IPP_TAG_KEYWORD
:
3876 case IPP_TAG_CHARSET
:
3877 case IPP_TAG_LANGUAGE
:
3879 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
3881 if (strchr(" \t\n\\\'\"", *valptr
))
3883 *optptr
++ = *valptr
++;
3890 break; /* anti-compiler-warning-code */
3894 optptr
+= strlen(optptr
);
3899 * Finally loop through the PWG->PPD mapped options and add them...
3902 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3905 strlcpy(optptr
, pwgppd
->name
, optlength
- (size_t)(optptr
- options
));
3906 optptr
+= strlen(optptr
);
3908 strlcpy(optptr
, pwgppd
->value
, optlength
- (size_t)(optptr
- options
));
3909 optptr
+= strlen(optptr
);
3912 cupsFreeOptions(num_pwgppds
, pwgppds
);
3915 * Return the options string...
3923 * 'ipp_length()' - Compute the size of the buffer needed to hold
3924 * the textual IPP attributes.
3927 static size_t /* O - Size of attribute buffer */
3928 ipp_length(ipp_t
*ipp
) /* I - IPP request */
3930 size_t bytes
; /* Number of bytes */
3931 int i
; /* Looping var */
3932 ipp_attribute_t
*attr
; /* Current attribute */
3936 * Loop through all attributes...
3941 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3944 * Skip attributes that won't be sent to filters...
3947 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3948 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3949 attr
->value_tag
== IPP_TAG_NAMELANG
||
3950 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3951 attr
->value_tag
== IPP_TAG_URI
||
3952 attr
->value_tag
== IPP_TAG_URISCHEME
)
3956 * Add space for a leading space and commas between each value.
3957 * For the first attribute, the leading space isn't used, so the
3958 * extra byte can be used as the nul terminator...
3961 bytes
++; /* " " separator */
3962 bytes
+= (size_t)attr
->num_values
; /* "," separators */
3965 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3966 * other attributes appear as "foo=value1,value2,...,valueN".
3969 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3970 bytes
+= strlen(attr
->name
);
3972 bytes
+= (size_t)attr
->num_values
* strlen(attr
->name
);
3975 * Now add the size required for each value in the attribute...
3978 switch (attr
->value_tag
)
3980 case IPP_TAG_INTEGER
:
3983 * Minimum value of a signed integer is -2147483647, or 11 digits.
3986 bytes
+= (size_t)attr
->num_values
* 11;
3989 case IPP_TAG_BOOLEAN
:
3991 * Add two bytes for each false ("no") value...
3994 for (i
= 0; i
< attr
->num_values
; i
++)
3995 if (!attr
->values
[i
].boolean
)
3999 case IPP_TAG_RANGE
:
4001 * A range is two signed integers separated by a hyphen, or
4002 * 23 characters max.
4005 bytes
+= (size_t)attr
->num_values
* 23;
4008 case IPP_TAG_RESOLUTION
:
4010 * A resolution is two signed integers separated by an "x" and
4011 * suffixed by the units, or 26 characters max.
4014 bytes
+= (size_t)attr
->num_values
* 26;
4017 case IPP_TAG_STRING
:
4020 case IPP_TAG_KEYWORD
:
4021 case IPP_TAG_CHARSET
:
4022 case IPP_TAG_LANGUAGE
:
4025 * Strings can contain characters that need quoting. We need
4026 * at least 2 * len + 2 characters to cover the quotes and
4027 * any backslashes in the string.
4030 for (i
= 0; i
< attr
->num_values
; i
++)
4031 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
4035 break; /* anti-compiler-warning-code */
4044 * 'load_job_cache()' - Load jobs from the job.cache file.
4048 load_job_cache(const char *filename
) /* I - job.cache filename */
4050 cups_file_t
*fp
; /* job.cache file */
4051 char line
[1024], /* Line buffer */
4052 *value
; /* Value on line */
4053 int linenum
; /* Line number in file */
4054 cupsd_job_t
*job
; /* Current job */
4055 int jobid
; /* Job ID */
4056 char jobfile
[1024]; /* Job filename */
4060 * Open the job.cache file...
4063 if ((fp
= cupsdOpenConfFile(filename
)) == NULL
)
4065 load_request_root();
4070 * Read entries from the job cache file and create jobs as needed.
4073 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
4079 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4081 if (!_cups_strcasecmp(line
, "NextJobId"))
4084 NextJobId
= atoi(value
);
4086 else if (!_cups_strcasecmp(line
, "<Job"))
4090 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d.",
4097 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d.", linenum
);
4101 jobid
= atoi(value
);
4105 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d.", jobid
,
4110 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
4111 if (access(jobfile
, 0))
4113 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d.N", RequestRoot
, jobid
);
4114 if (access(jobfile
, 0))
4116 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away.",
4122 job
= calloc(1, sizeof(cupsd_job_t
));
4125 cupsdLogMessage(CUPSD_LOG_EMERG
,
4126 "[Job %d] Unable to allocate memory for job.", jobid
);
4131 job
->back_pipes
[0] = -1;
4132 job
->back_pipes
[1] = -1;
4133 job
->print_pipes
[0] = -1;
4134 job
->print_pipes
[1] = -1;
4135 job
->side_pipes
[0] = -1;
4136 job
->side_pipes
[1] = -1;
4137 job
->status_pipes
[0] = -1;
4138 job
->status_pipes
[1] = -1;
4140 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading from cache...");
4144 cupsdLogMessage(CUPSD_LOG_ERROR
,
4145 "Missing <Job #> directive on line %d.", linenum
);
4148 else if (!_cups_strcasecmp(line
, "</Job>"))
4150 cupsArrayAdd(Jobs
, job
);
4152 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
4153 cupsArrayAdd(ActiveJobs
, job
);
4154 else if (job
->state_value
> IPP_JOB_STOPPED
)
4156 if (!job
->completed_time
|| !job
->creation_time
|| !job
->name
|| !job
->koctets
)
4167 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d.", linenum
);
4170 else if (!_cups_strcasecmp(line
, "State"))
4172 job
->state_value
= (ipp_jstate_t
)atoi(value
);
4174 if (job
->state_value
< IPP_JOB_PENDING
)
4175 job
->state_value
= IPP_JOB_PENDING
;
4176 else if (job
->state_value
> IPP_JOB_COMPLETED
)
4177 job
->state_value
= IPP_JOB_COMPLETED
;
4179 else if (!_cups_strcasecmp(line
, "Name"))
4181 cupsdSetString(&(job
->name
), value
);
4183 else if (!_cups_strcasecmp(line
, "Created"))
4185 job
->creation_time
= strtol(value
, NULL
, 10);
4187 else if (!_cups_strcasecmp(line
, "Completed"))
4189 job
->completed_time
= strtol(value
, NULL
, 10);
4191 else if (!_cups_strcasecmp(line
, "HoldUntil"))
4193 job
->hold_until
= strtol(value
, NULL
, 10);
4195 else if (!_cups_strcasecmp(line
, "Priority"))
4197 job
->priority
= atoi(value
);
4199 else if (!_cups_strcasecmp(line
, "Username"))
4201 cupsdSetString(&job
->username
, value
);
4203 else if (!_cups_strcasecmp(line
, "Destination"))
4205 cupsdSetString(&job
->dest
, value
);
4207 else if (!_cups_strcasecmp(line
, "DestType"))
4209 job
->dtype
= (cups_ptype_t
)atoi(value
);
4211 else if (!_cups_strcasecmp(line
, "KOctets"))
4213 job
->koctets
= atoi(value
);
4215 else if (!_cups_strcasecmp(line
, "NumFiles"))
4217 job
->num_files
= atoi(value
);
4219 if (job
->num_files
< 0)
4221 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d.",
4222 job
->num_files
, linenum
);
4227 if (job
->num_files
> 0)
4229 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
4231 if (access(jobfile
, 0))
4233 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Data files have gone away.");
4238 job
->filetypes
= calloc((size_t)job
->num_files
, sizeof(mime_type_t
*));
4239 job
->compressions
= calloc((size_t)job
->num_files
, sizeof(int));
4241 if (!job
->filetypes
|| !job
->compressions
)
4243 cupsdLogJob(job
, CUPSD_LOG_EMERG
,
4244 "Unable to allocate memory for %d files.",
4250 else if (!_cups_strcasecmp(line
, "File"))
4252 int number
, /* File number */
4253 compression
; /* Compression value */
4254 char super
[MIME_MAX_SUPER
], /* MIME super type */
4255 type
[MIME_MAX_TYPE
]; /* MIME type */
4258 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
4261 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d.", linenum
);
4265 if (number
< 1 || number
> job
->num_files
)
4267 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d.",
4274 job
->compressions
[number
] = compression
;
4275 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
4277 if (!job
->filetypes
[number
])
4280 * If the original MIME type is unknown, auto-type it!
4283 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
4284 "Unknown MIME type %s/%s for file %d.",
4285 super
, type
, number
+ 1);
4287 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
4288 job
->id
, number
+ 1);
4289 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
4290 job
->compressions
+ number
);
4293 * If that didn't work, assume it is raw...
4296 if (!job
->filetypes
[number
])
4297 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
4302 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d.",
4308 cupsdLogMessage(CUPSD_LOG_ERROR
,
4309 "Missing </Job> directive on line %d.", linenum
);
4310 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
4318 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4322 load_next_job_id(const char *filename
) /* I - job.cache filename */
4324 cups_file_t
*fp
; /* job.cache file */
4325 char line
[1024], /* Line buffer */
4326 *value
; /* Value on line */
4327 int linenum
; /* Line number in file */
4328 int next_job_id
; /* NextJobId value from line */
4332 * Read the NextJobId directive from the job.cache file and use
4333 * the value (if any).
4336 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4338 if (errno
!= ENOENT
)
4339 cupsdLogMessage(CUPSD_LOG_ERROR
,
4340 "Unable to open job cache file \"%s\": %s",
4341 filename
, strerror(errno
));
4346 cupsdLogMessage(CUPSD_LOG_INFO
,
4347 "Loading NextJobId from job cache file \"%s\"...", filename
);
4351 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4353 if (!_cups_strcasecmp(line
, "NextJobId"))
4357 next_job_id
= atoi(value
);
4359 if (next_job_id
> NextJobId
)
4360 NextJobId
= next_job_id
;
4371 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4375 load_request_root(void)
4377 cups_dir_t
*dir
; /* Directory */
4378 cups_dentry_t
*dent
; /* Directory entry */
4379 cupsd_job_t
*job
; /* New job */
4383 * Open the requests directory...
4386 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
4388 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
4390 cupsdLogMessage(CUPSD_LOG_ERROR
,
4391 "Unable to open spool directory \"%s\": %s",
4392 RequestRoot
, strerror(errno
));
4397 * Read all the c##### files...
4400 while ((dent
= cupsDirRead(dir
)) != NULL
)
4401 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
4404 * Allocate memory for the job...
4407 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
4409 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs.");
4415 * Assign the job ID...
4418 job
->id
= atoi(dent
->filename
+ 1);
4419 job
->back_pipes
[0] = -1;
4420 job
->back_pipes
[1] = -1;
4421 job
->print_pipes
[0] = -1;
4422 job
->print_pipes
[1] = -1;
4423 job
->side_pipes
[0] = -1;
4424 job
->side_pipes
[1] = -1;
4425 job
->status_pipes
[0] = -1;
4426 job
->status_pipes
[1] = -1;
4428 if (job
->id
>= NextJobId
)
4429 NextJobId
= job
->id
+ 1;
4435 if (cupsdLoadJob(job
))
4438 * Insert the job into the array, sorting by job priority and ID...
4441 cupsArrayAdd(Jobs
, job
);
4443 if (job
->state_value
<= IPP_JOB_STOPPED
)
4444 cupsArrayAdd(ActiveJobs
, job
);
4457 * 'remove_job_files()' - Remove the document files for a job.
4461 remove_job_files(cupsd_job_t
*job
) /* I - Job */
4463 int i
; /* Looping var */
4464 char filename
[1024]; /* Document filename */
4467 if (job
->num_files
<= 0)
4470 for (i
= 1; i
<= job
->num_files
; i
++)
4472 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
4474 cupsdUnlinkOrRemoveFile(filename
);
4477 free(job
->filetypes
);
4478 free(job
->compressions
);
4482 job
->filetypes
= NULL
;
4483 job
->compressions
= NULL
;
4485 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4490 * 'remove_job_history()' - Remove the control file for a job.
4494 remove_job_history(cupsd_job_t
*job
) /* I - Job */
4496 char filename
[1024]; /* Control filename */
4500 * Remove the job info file...
4503 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
4505 cupsdUnlinkOrRemoveFile(filename
);
4507 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4512 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4516 set_time(cupsd_job_t
*job
, /* I - Job to update */
4517 const char *name
) /* I - Name of attribute */
4519 ipp_attribute_t
*attr
; /* Time attribute */
4520 time_t curtime
; /* Current time */
4523 curtime
= time(NULL
);
4525 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s=%ld", name
, (long)curtime
);
4527 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
4529 attr
->value_tag
= IPP_TAG_INTEGER
;
4530 attr
->values
[0].integer
= curtime
;
4533 if (!strcmp(name
, "time-at-completed"))
4535 job
->completed_time
= curtime
;
4537 if (JobHistory
< INT_MAX
&& attr
)
4538 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
4540 job
->history_time
= INT_MAX
;
4542 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4543 JobHistoryUpdate
= job
->history_time
;
4545 if (JobFiles
< INT_MAX
&& attr
)
4546 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
4548 job
->file_time
= INT_MAX
;
4550 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4551 JobHistoryUpdate
= job
->file_time
;
4553 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "set_time: JobHistoryUpdate=%ld",
4554 (long)JobHistoryUpdate
);
4560 * 'start_job()' - Start a print job.
4564 start_job(cupsd_job_t
*job
, /* I - Job ID */
4565 cupsd_printer_t
*printer
) /* I - Printer to print job */
4567 const char *filename
; /* Support filename */
4568 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
4571 /* job-cancel-after attribute */
4574 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
4575 job
, job
->id
, printer
, printer
->name
);
4578 * Make sure we have some files around before we try to print...
4581 if (job
->num_files
== 0)
4583 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
4584 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
4585 "Aborting job because it has no files.");
4590 * Update the printer and job state to "processing"...
4593 if (!cupsdLoadJob(job
))
4596 if (!job
->printer_message
)
4597 job
->printer_message
= ippFindAttribute(job
->attrs
,
4598 "job-printer-state-message",
4600 if (job
->printer_message
)
4601 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
4603 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-printing");
4604 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
4605 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
4606 cupsdSetPrinterReasons(printer
, "-cups-remote-pending,"
4607 "cups-remote-pending-held,"
4608 "cups-remote-processing,"
4609 "cups-remote-stopped,"
4610 "cups-remote-canceled,"
4611 "cups-remote-aborted,"
4612 "cups-remote-completed");
4615 job
->current_file
= 0;
4617 job
->history_time
= 0;
4619 job
->printer
= printer
;
4623 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
4624 else if (MaxJobTime
> 0)
4625 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4627 job
->cancel_time
= 0;
4630 * Check for support files...
4633 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
4634 "cups-insecure-filter-warning");
4638 for (filename
= (const char *)cupsArrayFirst(printer
->pc
->support_files
);
4640 filename
= (const char *)cupsArrayNext(printer
->pc
->support_files
))
4642 if (_cupsFileCheck(filename
, _CUPS_FILE_CHECK_FILE
, !RunUser
,
4643 cupsdLogFCMessage
, printer
))
4649 * Setup the last exit status and security profiles...
4653 job
->profile
= cupsdCreateProfile(job
->id
, 0);
4654 job
->bprofile
= cupsdCreateProfile(job
->id
, 1);
4657 * Create the status pipes and buffer...
4660 if (cupsdOpenPipe(job
->status_pipes
))
4662 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4663 "Unable to create job status pipes - %s.", strerror(errno
));
4665 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4666 "Job stopped because the scheduler could not create the "
4667 "job status pipes.");
4669 cupsdDestroyProfile(job
->profile
);
4670 job
->profile
= NULL
;
4671 cupsdDestroyProfile(job
->bprofile
);
4672 job
->bprofile
= NULL
;
4676 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
4677 job
->status_level
= CUPSD_LOG_INFO
;
4680 * Create the backchannel pipes and make them non-blocking...
4683 if (cupsdOpenPipe(job
->back_pipes
))
4685 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4686 "Unable to create back-channel pipes - %s.", strerror(errno
));
4688 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4689 "Job stopped because the scheduler could not create the "
4690 "back-channel pipes.");
4692 cupsdClosePipe(job
->status_pipes
);
4693 cupsdStatBufDelete(job
->status_buffer
);
4694 job
->status_buffer
= NULL
;
4696 cupsdDestroyProfile(job
->profile
);
4697 job
->profile
= NULL
;
4698 cupsdDestroyProfile(job
->bprofile
);
4699 job
->bprofile
= NULL
;
4703 fcntl(job
->back_pipes
[0], F_SETFL
,
4704 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4705 fcntl(job
->back_pipes
[1], F_SETFL
,
4706 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4709 * Create the side-channel pipes and make them non-blocking...
4712 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4714 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4715 "Unable to create side-channel pipes - %s.", strerror(errno
));
4717 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4718 "Job stopped because the scheduler could not create the "
4719 "side-channel pipes.");
4721 cupsdClosePipe(job
->back_pipes
);
4723 cupsdClosePipe(job
->status_pipes
);
4724 cupsdStatBufDelete(job
->status_buffer
);
4725 job
->status_buffer
= NULL
;
4727 cupsdDestroyProfile(job
->profile
);
4728 job
->profile
= NULL
;
4729 cupsdDestroyProfile(job
->bprofile
);
4730 job
->bprofile
= NULL
;
4734 fcntl(job
->side_pipes
[0], F_SETFL
,
4735 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4736 fcntl(job
->side_pipes
[1], F_SETFL
,
4737 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4739 fcntl(job
->side_pipes
[0], F_SETFD
,
4740 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4741 fcntl(job
->side_pipes
[1], F_SETFD
,
4742 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4745 * Now start the first file in the job...
4748 cupsdContinueJob(job
);
4753 * 'stop_job()' - Stop a print job.
4757 stop_job(cupsd_job_t
*job
, /* I - Job */
4758 cupsd_jobaction_t action
) /* I - Action */
4760 int i
; /* Looping var */
4763 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4766 FilterLevel
-= job
->cost
;
4769 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
&& job
->backend
> 0)
4770 job
->kill_time
= time(NULL
) + JobKillDelay
;
4771 else if (action
>= CUPSD_JOB_FORCE
)
4774 for (i
= 0; job
->filters
[i
]; i
++)
4775 if (job
->filters
[i
] > 0)
4777 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
4779 if (action
>= CUPSD_JOB_FORCE
)
4780 job
->filters
[i
] = -job
->filters
[i
];
4783 if (job
->backend
> 0)
4785 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
4787 if (action
>= CUPSD_JOB_FORCE
)
4788 job
->backend
= -job
->backend
;
4791 if (action
>= CUPSD_JOB_FORCE
)
4794 * Clear job status...
4803 * 'unload_job()' - Unload a job from memory.
4807 unload_job(cupsd_job_t
*job
) /* I - Job */
4812 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Unloading...");
4814 ippDelete(job
->attrs
);
4818 job
->reasons
= NULL
;
4820 job
->job_sheets
= NULL
;
4821 job
->printer_message
= NULL
;
4822 job
->printer_reasons
= NULL
;
4827 * 'update_job()' - Read a status update from a job's filters.
4831 update_job(cupsd_job_t
*job
) /* I - Job to check */
4833 int i
; /* Looping var */
4834 int copies
; /* Number of copies printed */
4835 char message
[CUPSD_SB_BUFFER_SIZE
],
4837 *ptr
; /* Pointer update... */
4838 int loglevel
, /* Log level for message */
4839 event
= 0; /* Events? */
4840 static const char * const levels
[] = /* Log levels */
4856 * Get the printer associated with this job; if the printer is stopped for
4857 * any reason then job->printer will be reset to NULL, so make sure we have
4858 * a valid pointer...
4861 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
4862 message
, sizeof(message
))) != NULL
)
4865 * Process page and printer state messages as needed...
4868 if (loglevel
== CUPSD_LOG_PAGE
)
4871 * Page message; send the message to the page_log file and update the
4872 * job sheet count...
4875 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
4879 if (!_cups_strncasecmp(message
, "total ", 6))
4882 * Got a total count of pages from a backend or filter...
4885 copies
= atoi(message
+ 6);
4886 copies
-= job
->sheets
->values
[0].integer
; /* Just track the delta */
4888 else if (!sscanf(message
, "%*d%d", &copies
))
4891 job
->sheets
->values
[0].integer
+= copies
;
4893 if (job
->printer
->page_limit
)
4894 cupsdUpdateQuota(job
->printer
, job
->username
, copies
, 0);
4897 cupsdLogPage(job
, message
);
4900 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4901 "Printed %d page(s).", job
->sheets
->values
[0].integer
);
4903 else if (loglevel
== CUPSD_LOG_JOBSTATE
)
4906 * Support "keyword" to set job-state-reasons to the specified keyword.
4907 * This is sufficient for the current paid printing stuff.
4910 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "JOBSTATE: %s", message
);
4912 if (!strcmp(message
, "cups-retry-as-raster"))
4913 job
->retry_as_raster
= 1;
4915 ippSetString(job
->attrs
, &job
->reasons
, 0, message
);
4917 else if (loglevel
== CUPSD_LOG_STATE
)
4919 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
4921 if (!strcmp(message
, "paused"))
4923 cupsdStopPrinter(job
->printer
, 1);
4926 else if (message
[0] && cupsdSetPrinterReasons(job
->printer
, message
))
4928 event
|= CUPSD_EVENT_PRINTER_STATE
;
4933 * Reset cancel time after connecting to the device...
4936 for (i
= 0; i
< job
->printer
->num_reasons
; i
++)
4937 if (!strcmp(job
->printer
->reasons
[i
], "connecting-to-device"))
4940 if (i
>= job
->printer
->num_reasons
)
4942 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
4945 /* job-cancel-after attribute */
4948 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
4950 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4955 update_job_attrs(job
, 0);
4957 else if (loglevel
== CUPSD_LOG_ATTR
)
4960 * Set attribute(s)...
4963 int num_attrs
; /* Number of attributes */
4964 cups_option_t
*attrs
; /* Attributes */
4965 const char *attr
; /* Attribute */
4967 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
4969 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
4971 if ((attr
= cupsGetOption("auth-info-default", num_attrs
,
4974 job
->printer
->num_options
= cupsAddOption("auth-info", attr
,
4975 job
->printer
->num_options
,
4976 &(job
->printer
->options
));
4977 cupsdSetPrinterAttrs(job
->printer
);
4979 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4982 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
4985 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
4986 cupsdSetPrinterAttrs(job
->printer
);
4988 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4991 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
4994 int progress
= atoi(attr
);
4997 if (progress
>= 0 && progress
<= 100)
4999 job
->progress
= progress
;
5002 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5003 "Printing page %d, %d%%",
5004 job
->sheets
->values
[0].integer
, job
->progress
);
5008 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
5010 cupsdSetString(&job
->printer
->alert
, attr
);
5011 event
|= CUPSD_EVENT_PRINTER_STATE
;
5014 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
5017 cupsdSetString(&job
->printer
->alert_description
, attr
);
5018 event
|= CUPSD_EVENT_PRINTER_STATE
;
5021 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
5023 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
5024 job
->printer
->marker_time
= time(NULL
);
5025 event
|= CUPSD_EVENT_PRINTER_STATE
;
5026 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5029 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
5031 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
5032 job
->printer
->marker_time
= time(NULL
);
5033 event
|= CUPSD_EVENT_PRINTER_STATE
;
5034 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5037 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
5039 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
5040 job
->printer
->marker_time
= time(NULL
);
5041 event
|= CUPSD_EVENT_PRINTER_STATE
;
5042 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5045 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
5047 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
5048 job
->printer
->marker_time
= time(NULL
);
5049 event
|= CUPSD_EVENT_PRINTER_STATE
;
5050 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5053 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
5055 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
5056 job
->printer
->marker_time
= time(NULL
);
5057 event
|= CUPSD_EVENT_PRINTER_STATE
;
5058 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5061 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
5063 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
5064 job
->printer
->marker_time
= time(NULL
);
5065 event
|= CUPSD_EVENT_PRINTER_STATE
;
5066 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5069 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
5071 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
5072 job
->printer
->marker_time
= time(NULL
);
5073 event
|= CUPSD_EVENT_PRINTER_STATE
;
5074 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5077 cupsFreeOptions(num_attrs
, attrs
);
5079 else if (loglevel
== CUPSD_LOG_PPD
)
5082 * Set attribute(s)...
5085 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
5087 job
->num_keywords
= cupsParseOptions(message
, job
->num_keywords
,
5093 * Strip legacy message prefix...
5096 if (!strncmp(message
, "recoverable:", 12))
5099 while (isspace(*ptr
& 255))
5102 else if (!strncmp(message
, "recovered:", 10))
5105 while (isspace(*ptr
& 255))
5112 cupsdLogJob(job
, loglevel
, "%s", ptr
);
5114 if (loglevel
< CUPSD_LOG_DEBUG
&&
5115 strcmp(job
->printer
->state_message
, ptr
))
5117 strlcpy(job
->printer
->state_message
, ptr
,
5118 sizeof(job
->printer
->state_message
));
5120 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
5122 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
5125 * Some messages show in the job-printer-state-message attribute...
5128 if (loglevel
!= CUPSD_LOG_NOTICE
)
5129 job
->status_level
= loglevel
;
5131 update_job_attrs(job
, 1);
5133 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
5134 "Set job-printer-state-message to \"%s\", "
5136 job
->printer_message
->values
[0].string
.text
,
5137 levels
[job
->status_level
]);
5142 if (!strchr(job
->status_buffer
->buffer
, '\n'))
5146 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
5147 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5148 "%s", job
->printer
->state_message
);
5149 if (event
& CUPSD_EVENT_PRINTER_STATE
)
5150 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
5151 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
5152 "Class \"%s\" state changed." :
5153 "Printer \"%s\" state changed.",
5154 job
->printer
->name
);
5157 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
5160 * See if all of the filters and the backend have returned their
5164 for (i
= 0; job
->filters
[i
] < 0; i
++);
5166 if (job
->filters
[i
])
5169 * EOF but we haven't collected the exit status of all filters...
5172 cupsdCheckProcess();
5176 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
5179 * EOF but we haven't collected the exit status of the backend...
5182 cupsdCheckProcess();
5187 * Handle the end of job stuff...
5190 finalize_job(job
, 1);
5193 * Check for new jobs...
5202 * 'update_job_attrs()' - Update the job-printer-* attributes.
5206 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
5207 int do_message
)/* I - 1 = copy job-printer-state message */
5209 int i
; /* Looping var */
5210 int num_reasons
; /* Actual number of reasons */
5211 const char * const *reasons
; /* Reasons */
5212 static const char *none
= "none"; /* "none" reason */
5216 * Get/create the job-printer-state-* attributes...
5219 if (!job
->printer_message
)
5221 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
5222 "job-printer-state-message",
5223 IPP_TAG_TEXT
)) == NULL
)
5224 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
5225 "job-printer-state-message",
5229 if (!job
->printer_reasons
)
5230 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
5231 "job-printer-state-reasons",
5235 * Copy or clear the printer-state-message value as needed...
5238 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
5239 job
->status_level
== CUPSD_LOG_INFO
)
5241 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
5244 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5246 else if (job
->printer
->state_message
[0] && do_message
)
5248 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
),
5249 job
->printer
->state_message
);
5252 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5256 * ... and the printer-state-reasons value...
5259 if (job
->printer
->num_reasons
== 0)
5266 num_reasons
= job
->printer
->num_reasons
;
5267 reasons
= (const char * const *)job
->printer
->reasons
;
5270 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
5273 * Replace/create a job-printer-state-reasons attribute...
5276 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
5278 job
->printer_reasons
= ippAddStrings(job
->attrs
,
5279 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
5280 "job-printer-state-reasons",
5281 num_reasons
, NULL
, NULL
);
5286 * Don't bother clearing the reason strings if they are the same...
5289 for (i
= 0; i
< num_reasons
; i
++)
5290 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
5293 if (i
>= num_reasons
)
5297 * Not the same, so free the current strings...
5300 for (i
= 0; i
< num_reasons
; i
++)
5301 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
5305 * Copy the reasons...
5308 for (i
= 0; i
< num_reasons
; i
++)
5309 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
5312 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);