2 * "$Id: job.c 12463 2015-01-30 16:34:31Z msweet $"
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 dirinfo
; /* Information on RequestRoot dir */
1540 * Create the job arrays as needed...
1544 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1547 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1550 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1553 * See whether the job.cache file is older than the RequestRoot directory...
1556 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1558 if (stat(filename
, &fileinfo
))
1560 fileinfo
.st_mtime
= 0;
1562 if (errno
!= ENOENT
)
1563 cupsdLogMessage(CUPSD_LOG_ERROR
,
1564 "Unable to get file information for \"%s\" - %s",
1565 filename
, strerror(errno
));
1568 if (stat(RequestRoot
, &dirinfo
))
1570 dirinfo
.st_mtime
= 0;
1572 if (errno
!= ENOENT
)
1573 cupsdLogMessage(CUPSD_LOG_ERROR
,
1574 "Unable to get directory information for \"%s\" - %s",
1575 RequestRoot
, strerror(errno
));
1579 * Load the most recent source for job data...
1582 if (dirinfo
.st_mtime
> fileinfo
.st_mtime
)
1584 load_request_root();
1586 load_next_job_id(filename
);
1589 load_job_cache(filename
);
1592 * Clean out old jobs as needed...
1595 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1601 * 'cupsdLoadJob()' - Load a single job.
1604 int /* O - 1 on success, 0 on failure */
1605 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1607 int i
; /* Looping var */
1608 char jobfile
[1024]; /* Job filename */
1609 cups_file_t
*fp
; /* Job file */
1610 int fileid
; /* Current file ID */
1611 ipp_attribute_t
*attr
; /* Job attribute */
1612 const char *dest
; /* Destination name */
1613 cupsd_printer_t
*destptr
; /* Pointer to destination */
1614 mime_type_t
**filetypes
; /* New filetypes array */
1615 int *compressions
; /* New compressions array */
1620 if (job
->state_value
> IPP_JOB_STOPPED
)
1621 job
->access_time
= time(NULL
);
1626 if ((job
->attrs
= ippNew()) == NULL
)
1628 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes.");
1633 * Load job attributes...
1636 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading attributes...");
1638 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1639 if ((fp
= cupsdOpenConfFile(jobfile
)) == NULL
)
1642 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1644 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1645 "Unable to read job control file \"%s\".", jobfile
);
1653 * Copy attribute data to the job object...
1656 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1658 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1659 "Missing or bad time-at-creation attribute in control file.");
1663 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1664 IPP_TAG_ENUM
)) == NULL
)
1666 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1667 "Missing or bad job-state attribute in control file.");
1671 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1673 job
->history_time
= 0;
1675 if ((attr
= ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
)) != NULL
)
1676 job
->creation_time
= attr
->values
[0].integer
;
1678 if (job
->state_value
>= IPP_JOB_CANCELED
&& (attr
= ippFindAttribute(job
->attrs
, "time-at-completed", IPP_TAG_INTEGER
)) != NULL
)
1680 job
->completed_time
= attr
->values
[0].integer
;
1682 if (JobHistory
< INT_MAX
)
1683 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
1685 job
->history_time
= INT_MAX
;
1687 if (job
->history_time
< time(NULL
))
1688 goto error
; /* Expired, remove from history */
1690 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1691 JobHistoryUpdate
= job
->history_time
;
1693 if (JobFiles
< INT_MAX
)
1694 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
1696 job
->file_time
= INT_MAX
;
1698 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1699 JobHistoryUpdate
= job
->file_time
;
1701 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdLoadJob: JobHistoryUpdate=%ld",
1702 (long)JobHistoryUpdate
);
1707 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1708 IPP_TAG_URI
)) == NULL
)
1710 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1711 "No job-printer-uri attribute in control file.");
1715 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1718 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1719 "Unable to queue job for destination \"%s\".",
1720 attr
->values
[0].string
.text
);
1724 cupsdSetString(&job
->dest
, dest
);
1726 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1728 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1729 "Unable to queue job for destination \"%s\".",
1734 if ((job
->reasons
= ippFindAttribute(job
->attrs
, "job-state-reasons",
1735 IPP_TAG_KEYWORD
)) == NULL
)
1737 const char *reason
; /* job-state-reason keyword */
1739 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1740 "Adding missing job-state-reasons attribute to control file.");
1742 switch (job
->state_value
)
1745 case IPP_JOB_PENDING
:
1746 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1747 reason
= "printer-stopped";
1753 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1754 IPP_TAG_ZERO
)) != NULL
&&
1755 (attr
->value_tag
== IPP_TAG_NAME
||
1756 attr
->value_tag
== IPP_TAG_NAMELANG
||
1757 attr
->value_tag
== IPP_TAG_KEYWORD
) &&
1758 strcmp(attr
->values
[0].string
.text
, "no-hold"))
1759 reason
= "job-hold-until-specified";
1761 reason
= "job-incoming";
1764 case IPP_JOB_PROCESSING
:
1765 reason
= "job-printing";
1768 case IPP_JOB_STOPPED
:
1769 reason
= "job-stopped";
1772 case IPP_JOB_CANCELED
:
1773 reason
= "job-canceled-by-user";
1776 case IPP_JOB_ABORTED
:
1777 reason
= "aborted-by-system";
1780 case IPP_JOB_COMPLETED
:
1781 reason
= "job-completed-successfully";
1785 job
->reasons
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
1786 "job-state-reasons", NULL
, reason
);
1788 else if (job
->state_value
== IPP_JOB_PENDING
)
1790 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1791 ippSetString(job
->attrs
, &job
->reasons
, 0, "printer-stopped");
1793 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
1796 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed",
1798 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1802 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1803 IPP_TAG_INTEGER
)) == NULL
)
1805 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1806 "Missing or bad job-priority attribute in control file.");
1810 job
->priority
= attr
->values
[0].integer
;
1815 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1816 IPP_TAG_NAME
)) == NULL
)
1818 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1819 "Missing or bad job-originating-user-name "
1820 "attribute in control file.");
1824 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1829 if ((attr
= ippFindAttribute(job
->attrs
, "job-name", IPP_TAG_NAME
)) != NULL
)
1830 cupsdSetString(&job
->name
, attr
->values
[0].string
.text
);
1834 * Set the job hold-until time and state...
1837 if (job
->state_value
== IPP_JOB_HELD
)
1839 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1840 IPP_TAG_KEYWORD
)) == NULL
)
1841 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1844 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1847 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1848 job
->state_value
= IPP_JOB_PENDING
;
1851 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1853 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1854 job
->state_value
= IPP_JOB_PENDING
;
1857 if ((attr
= ippFindAttribute(job
->attrs
, "job-k-octets", IPP_TAG_INTEGER
)) != NULL
)
1858 job
->koctets
= attr
->values
[0].integer
;
1860 if (!job
->num_files
)
1863 * Find all the d##### files...
1866 for (fileid
= 1; fileid
< 10000; fileid
++)
1868 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1871 if (access(jobfile
, 0))
1874 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1875 "Auto-typing document file \"%s\"...", jobfile
);
1877 if (fileid
> job
->num_files
)
1879 if (job
->num_files
== 0)
1881 compressions
= (int *)calloc((size_t)fileid
, sizeof(int));
1882 filetypes
= (mime_type_t
**)calloc((size_t)fileid
, sizeof(mime_type_t
*));
1886 compressions
= (int *)realloc(job
->compressions
, sizeof(int) * (size_t)fileid
);
1887 filetypes
= (mime_type_t
**)realloc(job
->filetypes
, sizeof(mime_type_t
*) * (size_t)fileid
);
1891 job
->compressions
= compressions
;
1894 job
->filetypes
= filetypes
;
1896 if (!compressions
|| !filetypes
)
1898 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1899 "Ran out of memory for job file types.");
1901 ippDelete(job
->attrs
);
1904 if (job
->compressions
)
1906 free(job
->compressions
);
1907 job
->compressions
= NULL
;
1912 free(job
->filetypes
);
1913 job
->filetypes
= NULL
;
1920 job
->num_files
= fileid
;
1923 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1924 job
->compressions
+ fileid
- 1);
1926 if (!job
->filetypes
[fileid
- 1])
1927 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1933 * Load authentication information as needed...
1936 if (job
->state_value
< IPP_JOB_STOPPED
)
1938 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1941 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1943 cupsdClearString(job
->auth_env
+ i
);
1944 cupsdClearString(&job
->auth_uid
);
1946 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
1948 int bytes
, /* Size of auth data */
1949 linenum
= 1; /* Current line number */
1950 char line
[65536], /* Line from file */
1951 *value
, /* Value from line */
1952 data
[65536]; /* Decoded data */
1955 if (cupsFileGets(fp
, line
, sizeof(line
)) &&
1956 !strcmp(line
, "CUPSD-AUTH-V3"))
1959 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
1965 if (strcmp(line
, "negotiate") && strcmp(line
, "uid"))
1967 bytes
= sizeof(data
);
1968 httpDecode64_2(data
, &bytes
, value
);
1972 * Assign environment variables...
1975 if (!strcmp(line
, "uid"))
1977 cupsdSetStringf(&job
->auth_uid
, "AUTH_UID=%s", value
);
1980 else if (i
>= (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0])))
1983 if (!strcmp(line
, "username"))
1984 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_USERNAME=%s", data
);
1985 else if (!strcmp(line
, "domain"))
1986 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_DOMAIN=%s", data
);
1987 else if (!strcmp(line
, "password"))
1988 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_PASSWORD=%s", data
);
1989 else if (!strcmp(line
, "negotiate"))
1990 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_NEGOTIATE=%s", value
);
2002 job
->access_time
= time(NULL
);
2006 * If we get here then something bad happened...
2011 ippDelete(job
->attrs
);
2014 remove_job_history(job
);
2015 remove_job_files(job
);
2022 * 'cupsdMoveJob()' - Move the specified job to a different destination.
2026 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
2027 cupsd_printer_t
*p
) /* I - Destination printer or class */
2029 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
2030 const char *olddest
; /* Old destination */
2031 cupsd_printer_t
*oldp
; /* Old pointer */
2035 * Don't move completed jobs...
2038 if (job
->state_value
> IPP_JOB_STOPPED
)
2042 * Get the old destination...
2045 olddest
= job
->dest
;
2048 oldp
= job
->printer
;
2050 oldp
= cupsdFindDest(olddest
);
2053 * Change the destination information...
2056 if (job
->state_value
> IPP_JOB_HELD
)
2057 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2058 "Stopping job prior to move.");
2060 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
2061 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2064 cupsdSetString(&job
->dest
, p
->name
);
2065 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
);
2067 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
2068 IPP_TAG_URI
)) != NULL
)
2069 cupsdSetString(&(attr
->values
[0].string
.text
), p
->uri
);
2071 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
2072 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2076 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2081 * 'cupsdReleaseJob()' - Release the specified job.
2085 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
2087 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
2090 if (job
->state_value
== IPP_JOB_HELD
)
2093 * Add trailing banner as needed...
2096 if (job
->pending_timeout
)
2097 cupsdTimeoutJob(job
);
2099 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2100 "Job released by user.");
2106 * 'cupsdRestartJob()' - Restart the specified job.
2110 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
2112 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
2115 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
2116 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2117 "Job restarted by user.");
2122 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2126 cupsdSaveAllJobs(void)
2128 int i
; /* Looping var */
2129 cups_file_t
*fp
; /* job.cache file */
2130 char filename
[1024], /* job.cache filename */
2131 temp
[1024]; /* Temporary string */
2132 cupsd_job_t
*job
; /* Current job */
2133 time_t curtime
; /* Current time */
2134 struct tm
*curdate
; /* Current date */
2137 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
2138 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
)) == NULL
)
2141 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job.cache...");
2144 * Write a small header to the file...
2147 curtime
= time(NULL
);
2148 curdate
= localtime(&curtime
);
2149 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
2151 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
2152 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
2153 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
2156 * Write each job known to the system...
2159 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2161 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2163 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
2164 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
2165 cupsFilePrintf(fp
, "Created %ld\n", (long)job
->creation_time
);
2166 if (job
->completed_time
)
2167 cupsFilePrintf(fp
, "Completed %ld\n", (long)job
->completed_time
);
2168 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
2169 if (job
->hold_until
)
2170 cupsFilePrintf(fp
, "HoldUntil %ld\n", (long)job
->hold_until
);
2171 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
2173 cupsFilePutConf(fp
, "Name", job
->name
);
2174 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
2175 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
2176 cupsFilePrintf(fp
, "KOctets %d\n", job
->koctets
);
2177 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
2178 for (i
= 0; i
< job
->num_files
; i
++)
2179 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
2180 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
2181 cupsFilePuts(fp
, "</Job>\n");
2184 cupsdCloseCreatedConfFile(fp
, filename
);
2189 * 'cupsdSaveJob()' - Save a job to disk.
2193 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
2195 char filename
[1024]; /* Job control filename */
2196 cups_file_t
*fp
; /* Job file */
2199 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2200 job
, job
->id
, job
->attrs
);
2202 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
2204 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
& 0600)) == NULL
)
2207 fchown(cupsFileNumber(fp
), RunUser
, Group
);
2209 job
->attrs
->state
= IPP_IDLE
;
2211 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
2212 job
->attrs
) != IPP_DATA
)
2214 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to write job control file.");
2219 if (!cupsdCloseCreatedConfFile(fp
, filename
))
2222 * Remove backup file and mark this job as clean...
2225 strlcat(filename
, ".O", sizeof(filename
));
2234 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2238 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
2239 const char *when
, /* I - When to resume */
2240 int update
)/* I - Update job-hold-until attr? */
2242 time_t curtime
; /* Current time */
2243 struct tm
*curdate
; /* Current date */
2244 int hour
; /* Hold hour */
2245 int minute
; /* Hold minute */
2246 int second
= 0; /* Hold second */
2249 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2250 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2251 job
, job
->id
, when
, update
);
2256 * Update the job-hold-until attribute...
2259 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2261 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2262 IPP_TAG_KEYWORD
)) == NULL
)
2263 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2266 cupsdSetString(&(attr
->values
[0].string
.text
), when
);
2268 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2269 "job-hold-until", NULL
, when
);
2273 if (isdigit(when
[0] & 255))
2274 attr
->value_tag
= IPP_TAG_NAME
;
2276 attr
->value_tag
= IPP_TAG_KEYWORD
;
2279 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2284 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-hold-until-specified");
2287 * Update the hold time...
2290 job
->cancel_time
= 0;
2292 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2295 * Hold indefinitely...
2298 job
->hold_until
= 0;
2300 if (MaxHoldTime
> 0)
2301 job
->cancel_time
= time(NULL
) + MaxHoldTime
;
2303 else if (!strcmp(when
, "day-time"))
2306 * Hold to 6am the next morning unless local time is < 6pm.
2309 curtime
= time(NULL
);
2310 curdate
= localtime(&curtime
);
2312 if (curdate
->tm_hour
< 18)
2313 job
->hold_until
= curtime
;
2315 job
->hold_until
= curtime
+
2316 ((29 - curdate
->tm_hour
) * 60 + 59 -
2317 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2319 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2322 * Hold to 6pm unless local time is > 6pm or < 6am.
2325 curtime
= time(NULL
);
2326 curdate
= localtime(&curtime
);
2328 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2329 job
->hold_until
= curtime
;
2331 job
->hold_until
= curtime
+
2332 ((17 - curdate
->tm_hour
) * 60 + 59 -
2333 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2335 else if (!strcmp(when
, "second-shift"))
2338 * Hold to 4pm unless local time is > 4pm.
2341 curtime
= time(NULL
);
2342 curdate
= localtime(&curtime
);
2344 if (curdate
->tm_hour
>= 16)
2345 job
->hold_until
= curtime
;
2347 job
->hold_until
= curtime
+
2348 ((15 - curdate
->tm_hour
) * 60 + 59 -
2349 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2351 else if (!strcmp(when
, "third-shift"))
2354 * Hold to 12am unless local time is < 8am.
2357 curtime
= time(NULL
);
2358 curdate
= localtime(&curtime
);
2360 if (curdate
->tm_hour
< 8)
2361 job
->hold_until
= curtime
;
2363 job
->hold_until
= curtime
+
2364 ((23 - curdate
->tm_hour
) * 60 + 59 -
2365 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2367 else if (!strcmp(when
, "weekend"))
2370 * Hold to weekend unless we are in the weekend.
2373 curtime
= time(NULL
);
2374 curdate
= localtime(&curtime
);
2376 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2377 job
->hold_until
= curtime
;
2379 job
->hold_until
= curtime
+
2380 (((5 - curdate
->tm_wday
) * 24 +
2381 (17 - curdate
->tm_hour
)) * 60 + 59 -
2382 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2384 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2387 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2390 curtime
= time(NULL
);
2391 curdate
= gmtime(&curtime
);
2393 job
->hold_until
= curtime
+
2394 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2395 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2398 * Hold until next day as needed...
2401 if (job
->hold_until
< curtime
)
2402 job
->hold_until
+= 24 * 60 * 60;
2405 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2406 (int)job
->hold_until
);
2411 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2412 * the list as needed.
2416 cupsdSetJobPriority(
2417 cupsd_job_t
*job
, /* I - Job ID */
2418 int priority
) /* I - New priority (0 to 100) */
2420 ipp_attribute_t
*attr
; /* Job attribute */
2424 * Don't change completed jobs...
2427 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2431 * Set the new priority and re-add the job into the active list...
2434 cupsArrayRemove(ActiveJobs
, job
);
2436 job
->priority
= priority
;
2438 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2439 IPP_TAG_INTEGER
)) != NULL
)
2440 attr
->values
[0].integer
= priority
;
2442 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2445 cupsArrayAdd(ActiveJobs
, job
);
2448 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2453 * 'cupsdSetJobState()' - Set the state of the specified print job.
2458 cupsd_job_t
*job
, /* I - Job to cancel */
2459 ipp_jstate_t newstate
, /* I - New job state */
2460 cupsd_jobaction_t action
, /* I - Action to take */
2461 const char *message
, /* I - Message to log */
2462 ...) /* I - Additional arguments as needed */
2464 int i
; /* Looping var */
2465 ipp_jstate_t oldstate
; /* Old state */
2466 char filename
[1024]; /* Job filename */
2467 ipp_attribute_t
*attr
; /* Job attribute */
2470 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2471 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2472 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2473 newstate
, action
, message
? message
: "(null)");
2477 * Make sure we have the job attributes...
2480 if (!cupsdLoadJob(job
))
2484 * Don't do anything if the state is unchanged and we aren't purging the
2488 oldstate
= job
->state_value
;
2489 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2493 * Stop any processes that are working on the current job...
2496 if (oldstate
== IPP_JOB_PROCESSING
)
2497 stop_job(job
, action
);
2500 * Set the new job state...
2503 job
->state_value
= newstate
;
2506 job
->state
->values
[0].integer
= newstate
;
2510 case IPP_JOB_PENDING
:
2512 * Update job-hold-until as needed...
2515 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2516 IPP_TAG_KEYWORD
)) == NULL
)
2517 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2521 attr
->value_tag
= IPP_TAG_KEYWORD
;
2522 cupsdSetString(&(attr
->values
[0].string
.text
), "no-hold");
2528 case IPP_JOB_ABORTED
:
2529 case IPP_JOB_CANCELED
:
2530 case IPP_JOB_COMPLETED
:
2531 set_time(job
, "time-at-completed");
2532 ippSetString(job
->attrs
, &job
->reasons
, 0, "processing-to-stop-point");
2537 * Log message as needed...
2542 char buffer
[2048]; /* Message buffer */
2543 va_list ap
; /* Pointer to additional arguments */
2545 va_start(ap
, message
);
2546 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2549 if (newstate
> IPP_JOB_STOPPED
)
2550 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2552 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2554 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2555 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2557 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2561 * Handle post-state-change actions...
2566 case IPP_JOB_PROCESSING
:
2568 * Add the job to the "printing" list...
2571 if (!cupsArrayFind(PrintingJobs
, job
))
2572 cupsArrayAdd(PrintingJobs
, job
);
2575 * Set the processing time...
2578 set_time(job
, "time-at-processing");
2580 case IPP_JOB_PENDING
:
2582 case IPP_JOB_STOPPED
:
2584 * Make sure the job is in the active list...
2587 if (!cupsArrayFind(ActiveJobs
, job
))
2588 cupsArrayAdd(ActiveJobs
, job
);
2591 * Save the job state to disk...
2595 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2598 case IPP_JOB_ABORTED
:
2599 case IPP_JOB_CANCELED
:
2600 case IPP_JOB_COMPLETED
:
2601 if (newstate
== IPP_JOB_CANCELED
)
2604 * Remove the job from the active list if there are no processes still
2608 for (i
= 0; job
->filters
[i
] < 0; i
++);
2610 if (!job
->filters
[i
] && job
->backend
<= 0)
2611 cupsArrayRemove(ActiveJobs
, job
);
2616 * Otherwise just remove the job from the active list immediately...
2619 cupsArrayRemove(ActiveJobs
, job
);
2623 * Expire job subscriptions since the job is now "completed"...
2626 cupsdExpireSubscriptions(NULL
, job
);
2630 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2631 * sleep to happen immediately...
2634 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2636 #endif /* __APPLE__ */
2639 * Remove any authentication data...
2642 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2643 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2644 cupsdLogMessage(CUPSD_LOG_ERROR
,
2645 "Unable to remove authentication cache: %s",
2649 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
2651 cupsdClearString(job
->auth_env
+ i
);
2653 cupsdClearString(&job
->auth_uid
);
2656 * Remove the print file for good if we aren't preserving jobs or
2660 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2661 remove_job_files(job
);
2663 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2666 * Save job state info...
2670 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2672 else if (!job
->printer
)
2675 * Delete the job immediately if not actively printing...
2678 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2685 * Finalize the job immediately if we forced things...
2688 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2689 finalize_job(job
, 0);
2692 * Update the server "busy" state...
2695 cupsdSetBusyState();
2700 * 'cupsdStopAllJobs()' - Stop all print jobs.
2705 cupsd_jobaction_t action
, /* I - Action */
2706 int kill_delay
) /* I - Number of seconds before we kill */
2708 cupsd_job_t
*job
; /* Current job */
2711 DEBUG_puts("cupsdStopAllJobs()");
2713 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2715 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2719 cupsdSetJobState(job
, IPP_JOB_COMPLETED
, CUPSD_JOB_FORCE
, NULL
);
2724 job
->kill_time
= time(NULL
) + kill_delay
;
2726 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2733 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2737 cupsdUnloadCompletedJobs(void)
2739 cupsd_job_t
*job
; /* Current job */
2740 time_t expire
; /* Expiration time */
2743 expire
= time(NULL
) - 60;
2745 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2747 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2748 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2749 job
->access_time
< expire
)
2760 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2764 cupsdUpdateJobs(void)
2766 cupsd_job_t
*job
; /* Current job */
2767 time_t curtime
; /* Current time */
2768 ipp_attribute_t
*attr
; /* time-at-completed attribute */
2771 curtime
= time(NULL
);
2772 JobHistoryUpdate
= 0;
2774 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2776 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2778 if (job
->state_value
>= IPP_JOB_CANCELED
&&
2779 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
2780 IPP_TAG_INTEGER
)) != NULL
)
2783 * Update history/file expiration times...
2786 if (JobHistory
< INT_MAX
)
2787 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
2789 job
->history_time
= INT_MAX
;
2791 if (job
->history_time
< curtime
)
2793 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2797 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2798 JobHistoryUpdate
= job
->history_time
;
2800 if (JobFiles
< INT_MAX
)
2801 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
2803 job
->file_time
= INT_MAX
;
2805 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2806 JobHistoryUpdate
= job
->file_time
;
2810 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdUpdateAllJobs: JobHistoryUpdate=%ld",
2811 (long)JobHistoryUpdate
);
2816 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2819 static int /* O - Difference */
2820 compare_active_jobs(void *first
, /* I - First job */
2821 void *second
, /* I - Second job */
2822 void *data
) /* I - App data (not used) */
2824 int diff
; /* Difference */
2829 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2830 ((cupsd_job_t
*)first
)->priority
) != 0)
2833 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2838 * 'compare_completed_jobs()' - Compare the job IDs and completion times of two jobs.
2841 static int /* O - Difference */
2842 compare_completed_jobs(void *first
, /* I - First job */
2843 void *second
, /* I - Second job */
2844 void *data
) /* I - App data (not used) */
2846 int diff
; /* Difference */
2851 if ((diff
= ((cupsd_job_t
*)second
)->completed_time
-
2852 ((cupsd_job_t
*)first
)->completed_time
) != 0)
2855 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2860 * 'compare_jobs()' - Compare the job IDs of two jobs.
2863 static int /* O - Difference */
2864 compare_jobs(void *first
, /* I - First job */
2865 void *second
, /* I - Second job */
2866 void *data
) /* I - App data (not used) */
2870 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2875 * 'dump_job_history()' - Dump any debug messages for a job.
2879 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2881 int i
, /* Looping var */
2882 oldsize
; /* Current MaxLogSize */
2883 struct tm
*date
; /* Date/time value */
2884 cupsd_joblog_t
*message
; /* Current message */
2885 char temp
[2048], /* Log message */
2886 *ptr
, /* Pointer into log message */
2887 start
[256], /* Start time */
2888 end
[256]; /* End time */
2889 cupsd_printer_t
*printer
; /* Printer for job */
2893 * See if we have anything to dump...
2900 * Disable log rotation temporarily...
2903 oldsize
= MaxLogSize
;
2907 * Copy the debug messages to the log...
2910 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2911 date
= localtime(&(message
->time
));
2912 strftime(start
, sizeof(start
), "%X", date
);
2914 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2915 date
= localtime(&(message
->time
));
2916 strftime(end
, sizeof(end
), "%X", date
);
2918 snprintf(temp
, sizeof(temp
),
2919 "[Job %d] The following messages were recorded from %s to %s",
2920 job
->id
, start
, end
);
2921 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2923 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2925 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
2926 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
2928 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
2929 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2932 * Log the printer state values...
2935 if ((printer
= job
->printer
) == NULL
)
2936 printer
= cupsdFindDest(job
->dest
);
2940 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
2942 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
2943 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
2945 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2947 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
2948 job
->id
, printer
->state_message
);
2949 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2951 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
2952 ptr
= temp
+ strlen(temp
);
2953 if (printer
->num_reasons
== 0)
2954 strlcpy(ptr
, "none", sizeof(temp
) - (size_t)(ptr
- temp
));
2958 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
2964 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (size_t)(ptr
- temp
));
2968 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2972 * Restore log file rotation...
2975 MaxLogSize
= oldsize
;
2978 * Free all messages...
2981 free_job_history(job
);
2986 * 'free_job_history()' - Free any log history.
2990 free_job_history(cupsd_job_t
*job
) /* I - Job */
2992 char *message
; /* Current message */
2998 for (message
= (char *)cupsArrayFirst(job
->history
);
3000 message
= (char *)cupsArrayNext(job
->history
))
3003 cupsArrayDelete(job
->history
);
3004 job
->history
= NULL
;
3009 * 'finalize_job()' - Cleanup after job filter processes and support data.
3013 finalize_job(cupsd_job_t
*job
, /* I - Job */
3014 int set_job_state
) /* I - 1 = set the job state */
3016 ipp_pstate_t printer_state
; /* New printer state value */
3017 ipp_jstate_t job_state
; /* New job state value */
3018 const char *message
; /* Message for job state */
3019 char buffer
[1024]; /* Buffer for formatted messages */
3022 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
3025 * Clear the "connecting-to-device" and "cups-waiting-for-job-completed"
3026 * reasons, which are only valid when a printer is processing, along with any
3027 * remote printing job state...
3030 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device,"
3031 "cups-waiting-for-job-completed,"
3032 "cups-remote-pending,"
3033 "cups-remote-pending-held,"
3034 "cups-remote-processing,"
3035 "cups-remote-stopped,"
3036 "cups-remote-canceled,"
3037 "cups-remote-aborted,"
3038 "cups-remote-completed");
3041 * Similarly, clear the "offline-report" reason for non-USB devices since we
3042 * rarely have current information for network devices...
3045 if (strncmp(job
->printer
->device_uri
, "usb:", 4) &&
3046 strncmp(job
->printer
->device_uri
, "ippusb:", 7))
3047 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
3050 * Free the security profile...
3053 cupsdDestroyProfile(job
->profile
);
3054 job
->profile
= NULL
;
3055 cupsdDestroyProfile(job
->bprofile
);
3056 job
->bprofile
= NULL
;
3059 * Clear the unresponsive job watchdog timers...
3062 job
->cancel_time
= 0;
3066 * Close pipes and status buffer...
3069 cupsdClosePipe(job
->print_pipes
);
3070 cupsdClosePipe(job
->back_pipes
);
3071 cupsdClosePipe(job
->side_pipes
);
3073 cupsdRemoveSelect(job
->status_pipes
[0]);
3074 cupsdClosePipe(job
->status_pipes
);
3075 cupsdStatBufDelete(job
->status_buffer
);
3076 job
->status_buffer
= NULL
;
3079 * Process the exit status...
3082 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
3083 printer_state
= IPP_PRINTER_IDLE
;
3085 printer_state
= job
->printer
->state
;
3087 switch (job_state
= job
->state_value
)
3089 case IPP_JOB_PENDING
:
3090 message
= "Job paused.";
3094 message
= "Job held.";
3098 case IPP_JOB_PROCESSING
:
3099 case IPP_JOB_COMPLETED
:
3100 job_state
= IPP_JOB_COMPLETED
;
3101 message
= "Job completed.";
3104 ippSetString(job
->attrs
, &job
->reasons
, 0,
3105 "job-completed-successfully");
3108 case IPP_JOB_STOPPED
:
3109 message
= "Job stopped.";
3111 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-stopped");
3114 case IPP_JOB_CANCELED
:
3115 message
= "Job canceled.";
3117 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-canceled-by-user");
3120 case IPP_JOB_ABORTED
:
3121 message
= "Job aborted.";
3125 if (job
->status
< 0)
3128 * Backend had errors...
3131 int exit_code
; /* Exit code from backend */
3134 * Convert the status to an exit code. Due to the way the W* macros are
3135 * implemented on MacOS X (bug?), we have to store the exit status in a
3136 * variable first and then convert...
3139 exit_code
= -job
->status
;
3140 if (WIFEXITED(exit_code
))
3141 exit_code
= WEXITSTATUS(exit_code
);
3144 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-backend-crashed");
3145 exit_code
= job
->status
;
3148 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
3150 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
3151 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
3152 "authentication required" :
3153 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
3154 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
3155 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
3156 exit_code
== CUPS_BACKEND_RETRY
? "retry job later" :
3157 exit_code
== CUPS_BACKEND_RETRY_CURRENT
? "retry job immediately" :
3158 exit_code
< 0 ? "crashed" : "unknown");
3161 * Do what needs to be done...
3167 case CUPS_BACKEND_FAILED
:
3169 * Backend failure, use the error-policy to determine how to
3173 if (job
->dtype
& CUPS_PRINTER_CLASS
)
3176 * Queued on a class - mark the job as pending and we'll retry on
3177 * another printer...
3180 if (job_state
== IPP_JOB_COMPLETED
)
3182 job_state
= IPP_JOB_PENDING
;
3183 message
= "Retrying job on another printer.";
3185 ippSetString(job
->attrs
, &job
->reasons
, 0,
3186 "resources-are-not-ready");
3189 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
3192 * The error policy is "retry-current-job" - mark the job as pending
3193 * and we'll retry on the same printer...
3196 if (job_state
== IPP_JOB_COMPLETED
)
3198 job_state
= IPP_JOB_PENDING
;
3199 message
= "Retrying job on same printer.";
3201 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3204 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
3205 !strcmp(job
->printer
->error_policy
, "retry-job"))
3207 if (job_state
== IPP_JOB_COMPLETED
)
3210 * The job was queued on a fax or the error policy is "retry-job" -
3211 * hold the job if the number of retries is less than the
3212 * JobRetryLimit, otherwise abort the job.
3217 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3223 snprintf(buffer
, sizeof(buffer
),
3224 "Job aborted after %d unsuccessful attempts.",
3226 job_state
= IPP_JOB_ABORTED
;
3229 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3234 * Try again in N seconds...
3237 snprintf(buffer
, sizeof(buffer
),
3238 "Job held for %d seconds since it could not be sent.",
3241 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3242 job_state
= IPP_JOB_HELD
;
3245 ippSetString(job
->attrs
, &job
->reasons
, 0,
3246 "resources-are-not-ready");
3250 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
3251 job_state
== IPP_JOB_COMPLETED
)
3253 job_state
= IPP_JOB_ABORTED
;
3254 message
= "Job aborted due to backend errors; please consult "
3255 "the error_log file for details.";
3257 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3259 else if (job
->state_value
== IPP_JOB_PROCESSING
)
3261 job_state
= IPP_JOB_PENDING
;
3262 printer_state
= IPP_PRINTER_STOPPED
;
3263 message
= "Printer stopped due to backend errors; please "
3264 "consult the error_log file for details.";
3266 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3270 case CUPS_BACKEND_CANCEL
:
3275 if (job_state
== IPP_JOB_COMPLETED
)
3277 job_state
= IPP_JOB_CANCELED
;
3278 message
= "Job canceled at printer.";
3280 ippSetString(job
->attrs
, &job
->reasons
, 0, "canceled-at-device");
3284 case CUPS_BACKEND_HOLD
:
3285 if (job_state
== IPP_JOB_COMPLETED
)
3291 const char *reason
= ippGetString(job
->reasons
, 0, NULL
);
3293 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-state-reasons=\"%s\"",
3296 if (!reason
|| strncmp(reason
, "account-", 8))
3298 cupsdSetJobHoldUntil(job
, "indefinite", 1);
3300 ippSetString(job
->attrs
, &job
->reasons
, 0,
3301 "job-hold-until-specified");
3302 message
= "Job held indefinitely due to backend errors; please "
3303 "consult the error_log file for details.";
3305 else if (!strcmp(reason
, "account-info-needed"))
3307 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3309 message
= "Job held indefinitely - account information is "
3312 else if (!strcmp(reason
, "account-closed"))
3314 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3316 message
= "Job held indefinitely - account has been closed.";
3318 else if (!strcmp(reason
, "account-limit-reached"))
3320 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3322 message
= "Job held indefinitely - account limit has been "
3327 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3329 message
= "Job held indefinitely - account authorization failed.";
3332 job_state
= IPP_JOB_HELD
;
3336 case CUPS_BACKEND_STOP
:
3338 * Stop the printer...
3341 printer_state
= IPP_PRINTER_STOPPED
;
3342 message
= "Printer stopped due to backend errors; please "
3343 "consult the error_log file for details.";
3345 if (job_state
== IPP_JOB_COMPLETED
)
3347 job_state
= IPP_JOB_PENDING
;
3349 ippSetString(job
->attrs
, &job
->reasons
, 0,
3350 "resources-are-not-ready");
3354 case CUPS_BACKEND_AUTH_REQUIRED
:
3356 * Hold the job for authentication...
3359 if (job_state
== IPP_JOB_COMPLETED
)
3361 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
3363 job_state
= IPP_JOB_HELD
;
3364 message
= "Job held for authentication.";
3366 if (strncmp(job
->reasons
->values
[0].string
.text
, "account-", 8))
3367 ippSetString(job
->attrs
, &job
->reasons
, 0,
3368 "cups-held-for-authentication");
3372 case CUPS_BACKEND_RETRY
:
3373 if (job_state
== IPP_JOB_COMPLETED
)
3376 * Hold the job if the number of retries is less than the
3377 * JobRetryLimit, otherwise abort the job.
3382 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3388 snprintf(buffer
, sizeof(buffer
),
3389 "Job aborted after %d unsuccessful attempts.",
3391 job_state
= IPP_JOB_ABORTED
;
3394 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3399 * Try again in N seconds...
3402 snprintf(buffer
, sizeof(buffer
),
3403 "Job held for %d seconds since it could not be sent.",
3406 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3407 job_state
= IPP_JOB_HELD
;
3410 ippSetString(job
->attrs
, &job
->reasons
, 0,
3411 "resources-are-not-ready");
3416 case CUPS_BACKEND_RETRY_CURRENT
:
3418 * Mark the job as pending and retry on the same printer...
3421 if (job_state
== IPP_JOB_COMPLETED
)
3423 job_state
= IPP_JOB_PENDING
;
3424 message
= "Retrying job on same printer.";
3426 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3431 else if (job
->status
> 0)
3434 * Filter had errors; stop job...
3437 if (job_state
== IPP_JOB_COMPLETED
)
3439 job_state
= IPP_JOB_STOPPED
;
3440 message
= "Job stopped due to filter errors; please consult the "
3441 "error_log file for details.";
3443 if (WIFSIGNALED(job
->status
))
3444 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-filter-crashed");
3446 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-completed-with-errors");
3451 * Update the printer and job state.
3454 if (set_job_state
&& job_state
!= job
->state_value
)
3455 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
3457 cupsdSetPrinterState(job
->printer
, printer_state
,
3458 printer_state
== IPP_PRINTER_STOPPED
);
3459 update_job_attrs(job
, 0);
3464 (job
->state_value
== IPP_JOB_ABORTED
||
3465 job
->state_value
== IPP_JOB_STOPPED
))
3466 dump_job_history(job
);
3468 free_job_history(job
);
3471 cupsArrayRemove(PrintingJobs
, job
);
3474 * Apply any PPD updates...
3477 if (job
->num_keywords
)
3479 if (cupsdUpdatePrinterPPD(job
->printer
, job
->num_keywords
, job
->keywords
))
3480 cupsdSetPrinterAttrs(job
->printer
);
3482 cupsFreeOptions(job
->num_keywords
, job
->keywords
);
3484 job
->num_keywords
= 0;
3485 job
->keywords
= NULL
;
3489 * Clear the printer <-> job association...
3492 job
->printer
->job
= NULL
;
3493 job
->printer
= NULL
;
3496 * Try printing another job...
3499 if (printer_state
!= IPP_PRINTER_STOPPED
)
3505 * 'get_options()' - Get a string containing the job options.
3508 static char * /* O - Options string */
3509 get_options(cupsd_job_t
*job
, /* I - Job */
3510 int banner_page
, /* I - Printing a banner page? */
3511 char *copies
, /* I - Copies buffer */
3512 size_t copies_size
, /* I - Size of copies buffer */
3513 char *title
, /* I - Title buffer */
3514 size_t title_size
) /* I - Size of title buffer */
3516 int i
; /* Looping var */
3517 size_t newlength
; /* New option buffer length */
3518 char *optptr
, /* Pointer to options */
3519 *valptr
; /* Pointer in value string */
3520 ipp_attribute_t
*attr
; /* Current attribute */
3521 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3522 int num_pwgppds
; /* Number of PWG->PPD options */
3523 cups_option_t
*pwgppds
, /* PWG->PPD options */
3524 *pwgppd
, /* Current PWG->PPD option */
3525 *preset
; /* Current preset option */
3526 int print_color_mode
,
3527 /* Output mode (if any) */
3528 print_quality
; /* Print quality (if any) */
3529 const char *ppd
; /* PPD option choice */
3530 int exact
; /* Did we get an exact match? */
3531 static char *options
= NULL
;/* Full list of options */
3532 static size_t optlength
= 0; /* Length of option buffer */
3536 * Building the options string is harder than it needs to be, but for the
3537 * moment we need to pass strings for command-line args and not IPP attribute
3540 * First build an options array for any PWG->PPD mapped option/choice pairs.
3543 pc
= job
->printer
->pc
;
3548 !ippFindAttribute(job
->attrs
,
3549 "com.apple.print.DocumentTicket.PMSpoolFormat",
3551 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3552 (ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) ||
3553 ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
)))
3556 * Map print-color-mode and print-quality to a preset...
3559 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3560 IPP_TAG_KEYWORD
)) != NULL
&&
3561 !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3562 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3564 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3566 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality",
3567 IPP_TAG_ENUM
)) != NULL
&&
3568 attr
->values
[0].integer
>= IPP_QUALITY_DRAFT
&&
3569 attr
->values
[0].integer
<= IPP_QUALITY_HIGH
)
3570 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3572 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3574 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3577 * Try to find a preset that works so that we maximize the chances of us
3578 * getting a good print using IPP attributes.
3581 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3582 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3583 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3584 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3587 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3588 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3592 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3595 * Copy the preset options as long as the corresponding names are not
3596 * already defined in the IPP request...
3599 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3600 preset
= pc
->presets
[print_color_mode
][print_quality
];
3604 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3605 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
,
3613 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3614 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3616 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3617 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3620 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3621 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3622 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3624 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3625 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3626 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3628 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3630 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3631 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3634 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3635 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3636 IPP_TAG_ZERO
)) != NULL
&&
3637 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3638 attr
->value_tag
== IPP_TAG_NAME
) &&
3639 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3642 * Map output-bin to OutputBin option...
3645 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3648 if (pc
->sides_option
&&
3649 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3650 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3653 * Map sides to duplex option...
3656 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3657 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
,
3658 num_pwgppds
, &pwgppds
);
3659 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3660 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
,
3661 num_pwgppds
, &pwgppds
);
3662 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3663 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
,
3664 num_pwgppds
, &pwgppds
);
3668 * Map finishings values...
3671 num_pwgppds
= _ppdCacheGetFinishingOptions(pc
, job
->attrs
,
3672 IPP_FINISHINGS_NONE
, num_pwgppds
,
3677 * Figure out how much room we need...
3680 newlength
= ipp_length(job
->attrs
);
3682 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3683 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3686 * Then allocate/reallocate the option buffer as needed...
3689 if (newlength
== 0) /* This can never happen, but Clang */
3690 newlength
= 1; /* thinks it can... */
3692 if (newlength
> optlength
|| !options
)
3695 optptr
= malloc(newlength
);
3697 optptr
= realloc(options
, newlength
);
3701 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3702 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer.",
3703 CUPS_LLCAST newlength
);
3708 optlength
= newlength
;
3712 * Now loop through the attributes and convert them to the textual
3713 * representation used by the filters...
3719 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3720 strlcpy(copies
, "1", copies_size
);
3722 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3724 if (!strcmp(attr
->name
, "copies") &&
3725 attr
->value_tag
== IPP_TAG_INTEGER
)
3728 * Don't use the # copies attribute if we are printing the job sheets...
3732 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3734 else if (!strcmp(attr
->name
, "job-name") &&
3735 (attr
->value_tag
== IPP_TAG_NAME
||
3736 attr
->value_tag
== IPP_TAG_NAMELANG
))
3737 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3738 else if (attr
->group_tag
== IPP_TAG_JOB
)
3741 * Filter out other unwanted attributes...
3744 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3745 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3746 attr
->value_tag
== IPP_TAG_NAMELANG
||
3747 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3748 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid") &&
3749 strcmp(attr
->name
, "job-authorization-uri")) ||
3750 attr
->value_tag
== IPP_TAG_URISCHEME
||
3751 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3754 if (!strcmp(attr
->name
, "job-hold-until") ||
3755 !strcmp(attr
->name
, "job-id") ||
3756 !strcmp(attr
->name
, "job-k-octets") ||
3757 !strcmp(attr
->name
, "job-media-sheets") ||
3758 !strcmp(attr
->name
, "job-media-sheets-completed") ||
3759 !strcmp(attr
->name
, "job-state") ||
3760 !strcmp(attr
->name
, "job-state-reasons"))
3763 if (!strncmp(attr
->name
, "job-", 4) &&
3764 strcmp(attr
->name
, "job-account-id") &&
3765 strcmp(attr
->name
, "job-accounting-user-id") &&
3766 strcmp(attr
->name
, "job-authorization-uri") &&
3767 strcmp(attr
->name
, "job-billing") &&
3768 strcmp(attr
->name
, "job-impressions") &&
3769 strcmp(attr
->name
, "job-originating-host-name") &&
3770 strcmp(attr
->name
, "job-password") &&
3771 strcmp(attr
->name
, "job-password-encryption") &&
3772 strcmp(attr
->name
, "job-uuid") &&
3773 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3776 if ((!strcmp(attr
->name
, "job-impressions") ||
3777 !strcmp(attr
->name
, "page-label") ||
3778 !strcmp(attr
->name
, "page-border") ||
3779 !strncmp(attr
->name
, "number-up", 9) ||
3780 !strcmp(attr
->name
, "page-ranges") ||
3781 !strcmp(attr
->name
, "page-set") ||
3782 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3783 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3784 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3785 "PMTotalSidesImaged..n.") ||
3786 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3787 "PMTotalBeginPages..n.")) &&
3792 * Otherwise add them to the list...
3795 if (optptr
> options
)
3796 strlcat(optptr
, " ", optlength
- (size_t)(optptr
- options
));
3798 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3800 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
3801 strlcat(optptr
, "=", optlength
- (size_t)(optptr
- options
));
3804 for (i
= 0; i
< attr
->num_values
; i
++)
3807 strlcat(optptr
, ",", optlength
- (size_t)(optptr
- options
));
3809 optptr
+= strlen(optptr
);
3811 switch (attr
->value_tag
)
3813 case IPP_TAG_INTEGER
:
3815 snprintf(optptr
, optlength
- (size_t)(optptr
- options
),
3816 "%d", attr
->values
[i
].integer
);
3819 case IPP_TAG_BOOLEAN
:
3820 if (!attr
->values
[i
].boolean
)
3821 strlcat(optptr
, "no", optlength
- (size_t)(optptr
- options
));
3823 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
3826 case IPP_TAG_RANGE
:
3827 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3828 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3829 "%d", attr
->values
[i
].range
.lower
);
3831 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3832 "%d-%d", attr
->values
[i
].range
.lower
,
3833 attr
->values
[i
].range
.upper
);
3836 case IPP_TAG_RESOLUTION
:
3837 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3838 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
3839 attr
->values
[i
].resolution
.yres
,
3840 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
3844 case IPP_TAG_STRING
:
3847 case IPP_TAG_KEYWORD
:
3848 case IPP_TAG_CHARSET
:
3849 case IPP_TAG_LANGUAGE
:
3851 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
3853 if (strchr(" \t\n\\\'\"", *valptr
))
3855 *optptr
++ = *valptr
++;
3862 break; /* anti-compiler-warning-code */
3866 optptr
+= strlen(optptr
);
3871 * Finally loop through the PWG->PPD mapped options and add them...
3874 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3877 strlcpy(optptr
, pwgppd
->name
, optlength
- (size_t)(optptr
- options
));
3878 optptr
+= strlen(optptr
);
3880 strlcpy(optptr
, pwgppd
->value
, optlength
- (size_t)(optptr
- options
));
3881 optptr
+= strlen(optptr
);
3884 cupsFreeOptions(num_pwgppds
, pwgppds
);
3887 * Return the options string...
3895 * 'ipp_length()' - Compute the size of the buffer needed to hold
3896 * the textual IPP attributes.
3899 static size_t /* O - Size of attribute buffer */
3900 ipp_length(ipp_t
*ipp
) /* I - IPP request */
3902 size_t bytes
; /* Number of bytes */
3903 int i
; /* Looping var */
3904 ipp_attribute_t
*attr
; /* Current attribute */
3908 * Loop through all attributes...
3913 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3916 * Skip attributes that won't be sent to filters...
3919 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3920 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3921 attr
->value_tag
== IPP_TAG_NAMELANG
||
3922 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3923 attr
->value_tag
== IPP_TAG_URI
||
3924 attr
->value_tag
== IPP_TAG_URISCHEME
)
3928 * Add space for a leading space and commas between each value.
3929 * For the first attribute, the leading space isn't used, so the
3930 * extra byte can be used as the nul terminator...
3933 bytes
++; /* " " separator */
3934 bytes
+= (size_t)attr
->num_values
; /* "," separators */
3937 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3938 * other attributes appear as "foo=value1,value2,...,valueN".
3941 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3942 bytes
+= strlen(attr
->name
);
3944 bytes
+= (size_t)attr
->num_values
* strlen(attr
->name
);
3947 * Now add the size required for each value in the attribute...
3950 switch (attr
->value_tag
)
3952 case IPP_TAG_INTEGER
:
3955 * Minimum value of a signed integer is -2147483647, or 11 digits.
3958 bytes
+= (size_t)attr
->num_values
* 11;
3961 case IPP_TAG_BOOLEAN
:
3963 * Add two bytes for each false ("no") value...
3966 for (i
= 0; i
< attr
->num_values
; i
++)
3967 if (!attr
->values
[i
].boolean
)
3971 case IPP_TAG_RANGE
:
3973 * A range is two signed integers separated by a hyphen, or
3974 * 23 characters max.
3977 bytes
+= (size_t)attr
->num_values
* 23;
3980 case IPP_TAG_RESOLUTION
:
3982 * A resolution is two signed integers separated by an "x" and
3983 * suffixed by the units, or 26 characters max.
3986 bytes
+= (size_t)attr
->num_values
* 26;
3989 case IPP_TAG_STRING
:
3992 case IPP_TAG_KEYWORD
:
3993 case IPP_TAG_CHARSET
:
3994 case IPP_TAG_LANGUAGE
:
3997 * Strings can contain characters that need quoting. We need
3998 * at least 2 * len + 2 characters to cover the quotes and
3999 * any backslashes in the string.
4002 for (i
= 0; i
< attr
->num_values
; i
++)
4003 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
4007 break; /* anti-compiler-warning-code */
4016 * 'load_job_cache()' - Load jobs from the job.cache file.
4020 load_job_cache(const char *filename
) /* I - job.cache filename */
4022 cups_file_t
*fp
; /* job.cache file */
4023 char line
[1024], /* Line buffer */
4024 *value
; /* Value on line */
4025 int linenum
; /* Line number in file */
4026 cupsd_job_t
*job
; /* Current job */
4027 int jobid
; /* Job ID */
4028 char jobfile
[1024]; /* Job filename */
4032 * Open the job.cache file...
4035 if ((fp
= cupsdOpenConfFile(filename
)) == NULL
)
4037 load_request_root();
4042 * Read entries from the job cache file and create jobs as needed.
4045 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
4051 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4053 if (!_cups_strcasecmp(line
, "NextJobId"))
4056 NextJobId
= atoi(value
);
4058 else if (!_cups_strcasecmp(line
, "<Job"))
4062 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d of %s.", linenum
, filename
);
4068 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d of %s.", linenum
, filename
);
4072 jobid
= atoi(value
);
4076 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d of %s.", jobid
, linenum
, filename
);
4080 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
4081 if (access(jobfile
, 0))
4083 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d.N", RequestRoot
, jobid
);
4084 if (access(jobfile
, 0))
4086 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away.",
4092 job
= calloc(1, sizeof(cupsd_job_t
));
4095 cupsdLogMessage(CUPSD_LOG_EMERG
,
4096 "[Job %d] Unable to allocate memory for job.", jobid
);
4101 job
->back_pipes
[0] = -1;
4102 job
->back_pipes
[1] = -1;
4103 job
->print_pipes
[0] = -1;
4104 job
->print_pipes
[1] = -1;
4105 job
->side_pipes
[0] = -1;
4106 job
->side_pipes
[1] = -1;
4107 job
->status_pipes
[0] = -1;
4108 job
->status_pipes
[1] = -1;
4110 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading from cache...");
4114 cupsdLogMessage(CUPSD_LOG_ERROR
,
4115 "Missing <Job #> directive on line %d of %s.", linenum
, filename
);
4118 else if (!_cups_strcasecmp(line
, "</Job>"))
4120 cupsArrayAdd(Jobs
, job
);
4122 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
4123 cupsArrayAdd(ActiveJobs
, job
);
4124 else if (job
->state_value
> IPP_JOB_STOPPED
)
4126 if (!job
->completed_time
|| !job
->creation_time
|| !job
->name
|| !job
->koctets
)
4137 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d of %s.", linenum
, filename
);
4140 else if (!_cups_strcasecmp(line
, "State"))
4142 job
->state_value
= (ipp_jstate_t
)atoi(value
);
4144 if (job
->state_value
< IPP_JOB_PENDING
)
4145 job
->state_value
= IPP_JOB_PENDING
;
4146 else if (job
->state_value
> IPP_JOB_COMPLETED
)
4147 job
->state_value
= IPP_JOB_COMPLETED
;
4149 else if (!_cups_strcasecmp(line
, "Name"))
4151 cupsdSetString(&(job
->name
), value
);
4153 else if (!_cups_strcasecmp(line
, "Created"))
4155 job
->creation_time
= strtol(value
, NULL
, 10);
4157 else if (!_cups_strcasecmp(line
, "Completed"))
4159 job
->completed_time
= strtol(value
, NULL
, 10);
4161 else if (!_cups_strcasecmp(line
, "HoldUntil"))
4163 job
->hold_until
= strtol(value
, NULL
, 10);
4165 else if (!_cups_strcasecmp(line
, "Priority"))
4167 job
->priority
= atoi(value
);
4169 else if (!_cups_strcasecmp(line
, "Username"))
4171 cupsdSetString(&job
->username
, value
);
4173 else if (!_cups_strcasecmp(line
, "Destination"))
4175 cupsdSetString(&job
->dest
, value
);
4177 else if (!_cups_strcasecmp(line
, "DestType"))
4179 job
->dtype
= (cups_ptype_t
)atoi(value
);
4181 else if (!_cups_strcasecmp(line
, "KOctets"))
4183 job
->koctets
= atoi(value
);
4185 else if (!_cups_strcasecmp(line
, "NumFiles"))
4187 job
->num_files
= atoi(value
);
4189 if (job
->num_files
< 0)
4191 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d of %s.", job
->num_files
, linenum
, filename
);
4196 if (job
->num_files
> 0)
4198 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
4200 if (access(jobfile
, 0))
4202 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Data files have gone away.");
4207 job
->filetypes
= calloc((size_t)job
->num_files
, sizeof(mime_type_t
*));
4208 job
->compressions
= calloc((size_t)job
->num_files
, sizeof(int));
4210 if (!job
->filetypes
|| !job
->compressions
)
4212 cupsdLogJob(job
, CUPSD_LOG_EMERG
,
4213 "Unable to allocate memory for %d files.",
4219 else if (!_cups_strcasecmp(line
, "File"))
4221 int number
, /* File number */
4222 compression
; /* Compression value */
4223 char super
[MIME_MAX_SUPER
], /* MIME super type */
4224 type
[MIME_MAX_TYPE
]; /* MIME type */
4227 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
4230 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d of %s.", linenum
, filename
);
4234 if (number
< 1 || number
> job
->num_files
)
4236 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d of %s.", number
, linenum
, filename
);
4242 job
->compressions
[number
] = compression
;
4243 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
4245 if (!job
->filetypes
[number
])
4248 * If the original MIME type is unknown, auto-type it!
4251 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
4252 "Unknown MIME type %s/%s for file %d.",
4253 super
, type
, number
+ 1);
4255 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
4256 job
->id
, number
+ 1);
4257 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
4258 job
->compressions
+ number
);
4261 * If that didn't work, assume it is raw...
4264 if (!job
->filetypes
[number
])
4265 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
4270 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d of %s.", line
, linenum
, filename
);
4275 cupsdLogMessage(CUPSD_LOG_ERROR
,
4276 "Missing </Job> directive on line %d of %s.", linenum
, filename
);
4277 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
4285 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4289 load_next_job_id(const char *filename
) /* I - job.cache filename */
4291 cups_file_t
*fp
; /* job.cache file */
4292 char line
[1024], /* Line buffer */
4293 *value
; /* Value on line */
4294 int linenum
; /* Line number in file */
4295 int next_job_id
; /* NextJobId value from line */
4299 * Read the NextJobId directive from the job.cache file and use
4300 * the value (if any).
4303 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4305 if (errno
!= ENOENT
)
4306 cupsdLogMessage(CUPSD_LOG_ERROR
,
4307 "Unable to open job cache file \"%s\": %s",
4308 filename
, strerror(errno
));
4313 cupsdLogMessage(CUPSD_LOG_INFO
,
4314 "Loading NextJobId from job cache file \"%s\"...", filename
);
4318 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4320 if (!_cups_strcasecmp(line
, "NextJobId"))
4324 next_job_id
= atoi(value
);
4326 if (next_job_id
> NextJobId
)
4327 NextJobId
= next_job_id
;
4338 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4342 load_request_root(void)
4344 cups_dir_t
*dir
; /* Directory */
4345 cups_dentry_t
*dent
; /* Directory entry */
4346 cupsd_job_t
*job
; /* New job */
4350 * Open the requests directory...
4353 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
4355 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
4357 cupsdLogMessage(CUPSD_LOG_ERROR
,
4358 "Unable to open spool directory \"%s\": %s",
4359 RequestRoot
, strerror(errno
));
4364 * Read all the c##### files...
4367 while ((dent
= cupsDirRead(dir
)) != NULL
)
4368 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
4371 * Allocate memory for the job...
4374 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
4376 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs.");
4382 * Assign the job ID...
4385 job
->id
= atoi(dent
->filename
+ 1);
4386 job
->back_pipes
[0] = -1;
4387 job
->back_pipes
[1] = -1;
4388 job
->print_pipes
[0] = -1;
4389 job
->print_pipes
[1] = -1;
4390 job
->side_pipes
[0] = -1;
4391 job
->side_pipes
[1] = -1;
4392 job
->status_pipes
[0] = -1;
4393 job
->status_pipes
[1] = -1;
4395 if (job
->id
>= NextJobId
)
4396 NextJobId
= job
->id
+ 1;
4402 if (cupsdLoadJob(job
))
4405 * Insert the job into the array, sorting by job priority and ID...
4408 cupsArrayAdd(Jobs
, job
);
4410 if (job
->state_value
<= IPP_JOB_STOPPED
)
4411 cupsArrayAdd(ActiveJobs
, job
);
4424 * 'remove_job_files()' - Remove the document files for a job.
4428 remove_job_files(cupsd_job_t
*job
) /* I - Job */
4430 int i
; /* Looping var */
4431 char filename
[1024]; /* Document filename */
4434 if (job
->num_files
<= 0)
4437 for (i
= 1; i
<= job
->num_files
; i
++)
4439 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
4441 cupsdUnlinkOrRemoveFile(filename
);
4444 free(job
->filetypes
);
4445 free(job
->compressions
);
4449 job
->filetypes
= NULL
;
4450 job
->compressions
= NULL
;
4452 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4457 * 'remove_job_history()' - Remove the control file for a job.
4461 remove_job_history(cupsd_job_t
*job
) /* I - Job */
4463 char filename
[1024]; /* Control filename */
4467 * Remove the job info file...
4470 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
4472 cupsdUnlinkOrRemoveFile(filename
);
4474 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4479 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4483 set_time(cupsd_job_t
*job
, /* I - Job to update */
4484 const char *name
) /* I - Name of attribute */
4486 ipp_attribute_t
*attr
; /* Time attribute */
4487 time_t curtime
; /* Current time */
4490 curtime
= time(NULL
);
4492 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s=%ld", name
, (long)curtime
);
4494 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
4496 attr
->value_tag
= IPP_TAG_INTEGER
;
4497 attr
->values
[0].integer
= curtime
;
4500 if (!strcmp(name
, "time-at-completed"))
4502 job
->completed_time
= curtime
;
4504 if (JobHistory
< INT_MAX
&& attr
)
4505 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
4507 job
->history_time
= INT_MAX
;
4509 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4510 JobHistoryUpdate
= job
->history_time
;
4512 if (JobFiles
< INT_MAX
&& attr
)
4513 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
4515 job
->file_time
= INT_MAX
;
4517 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4518 JobHistoryUpdate
= job
->file_time
;
4520 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "set_time: JobHistoryUpdate=%ld",
4521 (long)JobHistoryUpdate
);
4527 * 'start_job()' - Start a print job.
4531 start_job(cupsd_job_t
*job
, /* I - Job ID */
4532 cupsd_printer_t
*printer
) /* I - Printer to print job */
4534 const char *filename
; /* Support filename */
4535 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
4538 /* job-cancel-after attribute */
4541 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
4542 job
, job
->id
, printer
, printer
->name
);
4545 * Make sure we have some files around before we try to print...
4548 if (job
->num_files
== 0)
4550 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
4551 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
4552 "Aborting job because it has no files.");
4557 * Update the printer and job state to "processing"...
4560 if (!cupsdLoadJob(job
))
4563 if (!job
->printer_message
)
4564 job
->printer_message
= ippFindAttribute(job
->attrs
,
4565 "job-printer-state-message",
4567 if (job
->printer_message
)
4568 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
4570 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-printing");
4571 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
4572 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
4573 cupsdSetPrinterReasons(printer
, "-cups-remote-pending,"
4574 "cups-remote-pending-held,"
4575 "cups-remote-processing,"
4576 "cups-remote-stopped,"
4577 "cups-remote-canceled,"
4578 "cups-remote-aborted,"
4579 "cups-remote-completed");
4582 job
->current_file
= 0;
4584 job
->history_time
= 0;
4586 job
->printer
= printer
;
4590 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
4591 else if (MaxJobTime
> 0)
4592 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4594 job
->cancel_time
= 0;
4597 * Check for support files...
4600 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
4601 "cups-insecure-filter-warning");
4605 for (filename
= (const char *)cupsArrayFirst(printer
->pc
->support_files
);
4607 filename
= (const char *)cupsArrayNext(printer
->pc
->support_files
))
4609 if (_cupsFileCheck(filename
, _CUPS_FILE_CHECK_FILE
, !RunUser
,
4610 cupsdLogFCMessage
, printer
))
4616 * Setup the last exit status and security profiles...
4620 job
->profile
= cupsdCreateProfile(job
->id
, 0);
4621 job
->bprofile
= cupsdCreateProfile(job
->id
, 1);
4624 * Create the status pipes and buffer...
4627 if (cupsdOpenPipe(job
->status_pipes
))
4629 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4630 "Unable to create job status pipes - %s.", strerror(errno
));
4632 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4633 "Job stopped because the scheduler could not create the "
4634 "job status pipes.");
4636 cupsdDestroyProfile(job
->profile
);
4637 job
->profile
= NULL
;
4638 cupsdDestroyProfile(job
->bprofile
);
4639 job
->bprofile
= NULL
;
4643 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
4644 job
->status_level
= CUPSD_LOG_INFO
;
4647 * Create the backchannel pipes and make them non-blocking...
4650 if (cupsdOpenPipe(job
->back_pipes
))
4652 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4653 "Unable to create back-channel pipes - %s.", strerror(errno
));
4655 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4656 "Job stopped because the scheduler could not create the "
4657 "back-channel pipes.");
4659 cupsdClosePipe(job
->status_pipes
);
4660 cupsdStatBufDelete(job
->status_buffer
);
4661 job
->status_buffer
= NULL
;
4663 cupsdDestroyProfile(job
->profile
);
4664 job
->profile
= NULL
;
4665 cupsdDestroyProfile(job
->bprofile
);
4666 job
->bprofile
= NULL
;
4670 fcntl(job
->back_pipes
[0], F_SETFL
,
4671 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4672 fcntl(job
->back_pipes
[1], F_SETFL
,
4673 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4676 * Create the side-channel pipes and make them non-blocking...
4679 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4681 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4682 "Unable to create side-channel pipes - %s.", strerror(errno
));
4684 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4685 "Job stopped because the scheduler could not create the "
4686 "side-channel pipes.");
4688 cupsdClosePipe(job
->back_pipes
);
4690 cupsdClosePipe(job
->status_pipes
);
4691 cupsdStatBufDelete(job
->status_buffer
);
4692 job
->status_buffer
= NULL
;
4694 cupsdDestroyProfile(job
->profile
);
4695 job
->profile
= NULL
;
4696 cupsdDestroyProfile(job
->bprofile
);
4697 job
->bprofile
= NULL
;
4701 fcntl(job
->side_pipes
[0], F_SETFL
,
4702 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4703 fcntl(job
->side_pipes
[1], F_SETFL
,
4704 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4706 fcntl(job
->side_pipes
[0], F_SETFD
,
4707 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4708 fcntl(job
->side_pipes
[1], F_SETFD
,
4709 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4712 * Now start the first file in the job...
4715 cupsdContinueJob(job
);
4720 * 'stop_job()' - Stop a print job.
4724 stop_job(cupsd_job_t
*job
, /* I - Job */
4725 cupsd_jobaction_t action
) /* I - Action */
4727 int i
; /* Looping var */
4730 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4733 FilterLevel
-= job
->cost
;
4736 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
&& job
->backend
> 0)
4737 job
->kill_time
= time(NULL
) + JobKillDelay
;
4738 else if (action
>= CUPSD_JOB_FORCE
)
4741 for (i
= 0; job
->filters
[i
]; i
++)
4742 if (job
->filters
[i
] > 0)
4744 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
4746 if (action
>= CUPSD_JOB_FORCE
)
4747 job
->filters
[i
] = -job
->filters
[i
];
4750 if (job
->backend
> 0)
4752 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
4754 if (action
>= CUPSD_JOB_FORCE
)
4755 job
->backend
= -job
->backend
;
4758 if (action
>= CUPSD_JOB_FORCE
)
4761 * Clear job status...
4770 * 'unload_job()' - Unload a job from memory.
4774 unload_job(cupsd_job_t
*job
) /* I - Job */
4779 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Unloading...");
4781 ippDelete(job
->attrs
);
4785 job
->reasons
= NULL
;
4787 job
->job_sheets
= NULL
;
4788 job
->printer_message
= NULL
;
4789 job
->printer_reasons
= NULL
;
4794 * 'update_job()' - Read a status update from a job's filters.
4798 update_job(cupsd_job_t
*job
) /* I - Job to check */
4800 int i
; /* Looping var */
4801 int copies
; /* Number of copies printed */
4802 char message
[CUPSD_SB_BUFFER_SIZE
],
4804 *ptr
; /* Pointer update... */
4805 int loglevel
, /* Log level for message */
4806 event
= 0; /* Events? */
4807 static const char * const levels
[] = /* Log levels */
4823 * Get the printer associated with this job; if the printer is stopped for
4824 * any reason then job->printer will be reset to NULL, so make sure we have
4825 * a valid pointer...
4828 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
4829 message
, sizeof(message
))) != NULL
)
4832 * Process page and printer state messages as needed...
4835 if (loglevel
== CUPSD_LOG_PAGE
)
4838 * Page message; send the message to the page_log file and update the
4839 * job sheet count...
4842 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
4846 if (!_cups_strncasecmp(message
, "total ", 6))
4849 * Got a total count of pages from a backend or filter...
4852 copies
= atoi(message
+ 6);
4853 copies
-= job
->sheets
->values
[0].integer
; /* Just track the delta */
4855 else if (!sscanf(message
, "%*d%d", &copies
))
4858 job
->sheets
->values
[0].integer
+= copies
;
4860 if (job
->printer
->page_limit
)
4861 cupsdUpdateQuota(job
->printer
, job
->username
, copies
, 0);
4864 cupsdLogPage(job
, message
);
4867 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4868 "Printed %d page(s).", job
->sheets
->values
[0].integer
);
4870 else if (loglevel
== CUPSD_LOG_JOBSTATE
)
4873 * Support "keyword" to set job-state-reasons to the specified keyword.
4874 * This is sufficient for the current paid printing stuff.
4877 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "JOBSTATE: %s", message
);
4879 if (!strcmp(message
, "cups-retry-as-raster"))
4880 job
->retry_as_raster
= 1;
4882 ippSetString(job
->attrs
, &job
->reasons
, 0, message
);
4884 else if (loglevel
== CUPSD_LOG_STATE
)
4886 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
4888 if (!strcmp(message
, "paused"))
4890 cupsdStopPrinter(job
->printer
, 1);
4893 else if (message
[0] && cupsdSetPrinterReasons(job
->printer
, message
))
4895 event
|= CUPSD_EVENT_PRINTER_STATE
;
4900 * Reset cancel time after connecting to the device...
4903 for (i
= 0; i
< job
->printer
->num_reasons
; i
++)
4904 if (!strcmp(job
->printer
->reasons
[i
], "connecting-to-device"))
4907 if (i
>= job
->printer
->num_reasons
)
4909 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
4912 /* job-cancel-after attribute */
4915 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
4917 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4922 update_job_attrs(job
, 0);
4924 else if (loglevel
== CUPSD_LOG_ATTR
)
4927 * Set attribute(s)...
4930 int num_attrs
; /* Number of attributes */
4931 cups_option_t
*attrs
; /* Attributes */
4932 const char *attr
; /* Attribute */
4934 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
4936 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
4938 if ((attr
= cupsGetOption("auth-info-default", num_attrs
,
4941 job
->printer
->num_options
= cupsAddOption("auth-info", attr
,
4942 job
->printer
->num_options
,
4943 &(job
->printer
->options
));
4944 cupsdSetPrinterAttrs(job
->printer
);
4946 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4949 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
4952 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
4953 cupsdSetPrinterAttrs(job
->printer
);
4955 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4958 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
4961 int progress
= atoi(attr
);
4964 if (progress
>= 0 && progress
<= 100)
4966 job
->progress
= progress
;
4969 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4970 "Printing page %d, %d%%",
4971 job
->sheets
->values
[0].integer
, job
->progress
);
4975 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
4977 cupsdSetString(&job
->printer
->alert
, attr
);
4978 event
|= CUPSD_EVENT_PRINTER_STATE
;
4981 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
4984 cupsdSetString(&job
->printer
->alert_description
, attr
);
4985 event
|= CUPSD_EVENT_PRINTER_STATE
;
4988 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
4990 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
4991 job
->printer
->marker_time
= time(NULL
);
4992 event
|= CUPSD_EVENT_PRINTER_STATE
;
4993 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4996 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
4998 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
4999 job
->printer
->marker_time
= time(NULL
);
5000 event
|= CUPSD_EVENT_PRINTER_STATE
;
5001 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5004 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
5006 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
5007 job
->printer
->marker_time
= time(NULL
);
5008 event
|= CUPSD_EVENT_PRINTER_STATE
;
5009 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5012 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
5014 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
5015 job
->printer
->marker_time
= time(NULL
);
5016 event
|= CUPSD_EVENT_PRINTER_STATE
;
5017 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5020 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
5022 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
5023 job
->printer
->marker_time
= time(NULL
);
5024 event
|= CUPSD_EVENT_PRINTER_STATE
;
5025 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5028 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
5030 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
5031 job
->printer
->marker_time
= time(NULL
);
5032 event
|= CUPSD_EVENT_PRINTER_STATE
;
5033 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5036 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
5038 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
5039 job
->printer
->marker_time
= time(NULL
);
5040 event
|= CUPSD_EVENT_PRINTER_STATE
;
5041 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5044 cupsFreeOptions(num_attrs
, attrs
);
5046 else if (loglevel
== CUPSD_LOG_PPD
)
5049 * Set attribute(s)...
5052 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
5054 job
->num_keywords
= cupsParseOptions(message
, job
->num_keywords
,
5060 * Strip legacy message prefix...
5063 if (!strncmp(message
, "recoverable:", 12))
5066 while (isspace(*ptr
& 255))
5069 else if (!strncmp(message
, "recovered:", 10))
5072 while (isspace(*ptr
& 255))
5079 cupsdLogJob(job
, loglevel
, "%s", ptr
);
5081 if (loglevel
< CUPSD_LOG_DEBUG
&&
5082 strcmp(job
->printer
->state_message
, ptr
))
5084 strlcpy(job
->printer
->state_message
, ptr
,
5085 sizeof(job
->printer
->state_message
));
5087 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
5089 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
5092 * Some messages show in the job-printer-state-message attribute...
5095 if (loglevel
!= CUPSD_LOG_NOTICE
)
5096 job
->status_level
= loglevel
;
5098 update_job_attrs(job
, 1);
5100 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
5101 "Set job-printer-state-message to \"%s\", "
5103 job
->printer_message
->values
[0].string
.text
,
5104 levels
[job
->status_level
]);
5109 if (!strchr(job
->status_buffer
->buffer
, '\n'))
5113 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
5114 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5115 "%s", job
->printer
->state_message
);
5116 if (event
& CUPSD_EVENT_PRINTER_STATE
)
5117 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
5118 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
5119 "Class \"%s\" state changed." :
5120 "Printer \"%s\" state changed.",
5121 job
->printer
->name
);
5124 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
5127 * See if all of the filters and the backend have returned their
5131 for (i
= 0; job
->filters
[i
] < 0; i
++);
5133 if (job
->filters
[i
])
5136 * EOF but we haven't collected the exit status of all filters...
5139 cupsdCheckProcess();
5143 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
5146 * EOF but we haven't collected the exit status of the backend...
5149 cupsdCheckProcess();
5154 * Handle the end of job stuff...
5157 finalize_job(job
, 1);
5160 * Check for new jobs...
5169 * 'update_job_attrs()' - Update the job-printer-* attributes.
5173 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
5174 int do_message
)/* I - 1 = copy job-printer-state message */
5176 int i
; /* Looping var */
5177 int num_reasons
; /* Actual number of reasons */
5178 const char * const *reasons
; /* Reasons */
5179 static const char *none
= "none"; /* "none" reason */
5183 * Get/create the job-printer-state-* attributes...
5186 if (!job
->printer_message
)
5188 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
5189 "job-printer-state-message",
5190 IPP_TAG_TEXT
)) == NULL
)
5191 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
5192 "job-printer-state-message",
5196 if (!job
->printer_reasons
)
5197 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
5198 "job-printer-state-reasons",
5202 * Copy or clear the printer-state-message value as needed...
5205 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
5206 job
->status_level
== CUPSD_LOG_INFO
)
5208 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
5211 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5213 else if (job
->printer
->state_message
[0] && do_message
)
5215 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
),
5216 job
->printer
->state_message
);
5219 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5223 * ... and the printer-state-reasons value...
5226 if (job
->printer
->num_reasons
== 0)
5233 num_reasons
= job
->printer
->num_reasons
;
5234 reasons
= (const char * const *)job
->printer
->reasons
;
5237 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
5240 * Replace/create a job-printer-state-reasons attribute...
5243 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
5245 job
->printer_reasons
= ippAddStrings(job
->attrs
,
5246 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
5247 "job-printer-state-reasons",
5248 num_reasons
, NULL
, NULL
);
5253 * Don't bother clearing the reason strings if they are the same...
5256 for (i
= 0; i
< num_reasons
; i
++)
5257 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
5260 if (i
>= num_reasons
)
5264 * Not the same, so free the current strings...
5267 for (i
= 0; i
< num_reasons
; i
++)
5268 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
5272 * Copy the reasons...
5275 for (i
= 0; i
< num_reasons
; i
++)
5276 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
5279 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5284 * End of "$Id: job.c 12463 2015-01-30 16:34:31Z msweet $".