4 * Job management routines for the CUPS scheduler.
6 * Copyright 2007-2015 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.");
220 * 'cupsdCheckJobs()' - Check the pending jobs and start any if the destination
227 cupsd_job_t
*job
; /* Current job in queue */
228 cupsd_printer_t
*printer
, /* Printer destination */
229 *pclass
; /* Printer class destination */
230 ipp_attribute_t
*attr
; /* Job attribute */
231 time_t curtime
; /* Current time */
234 curtime
= time(NULL
);
236 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCheckJobs: %d active jobs, sleeping=%d, ac-power=%d, reload=%d, curtime=%ld", cupsArrayCount(ActiveJobs
), Sleeping
, ACPower
, NeedReload
, (long)curtime
);
238 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
);
240 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
242 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
243 "cupsdCheckJobs: Job %d - dest=\"%s\", printer=%p, "
244 "state=%d, cancel_time=%ld, hold_until=%ld, kill_time=%ld, "
245 "pending_cost=%d, pending_timeout=%ld", job
->id
, job
->dest
,
246 job
->printer
, job
->state_value
, (long)job
->cancel_time
,
247 (long)job
->hold_until
, (long)job
->kill_time
,
248 job
->pending_cost
, (long)job
->pending_timeout
);
251 * Kill jobs if they are unresponsive...
254 if (job
->kill_time
&& job
->kill_time
<= curtime
)
257 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Stopping unresponsive job.");
259 stop_job(job
, CUPSD_JOB_FORCE
);
264 * Cancel stuck jobs...
267 if (job
->cancel_time
&& job
->cancel_time
<= curtime
)
269 int cancel_after
; /* job-cancel-after value */
271 attr
= ippFindAttribute(job
->attrs
, "job-cancel-after", IPP_TAG_INTEGER
);
272 cancel_after
= attr
? ippGetInteger(attr
, 0) : MaxJobTime
;
275 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_FORCE
, "Marking stuck job as completed after %d seconds.", cancel_after
);
277 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
, "Canceling stuck job after %d seconds.", cancel_after
);
282 * Start held jobs if they are ready...
285 if (job
->state_value
== IPP_JOB_HELD
&&
287 job
->hold_until
< curtime
)
289 if (job
->pending_timeout
)
292 * This job is pending; check that we don't have an active Send-Document
293 * operation in progress on any of the client connections, then timeout
294 * the job so we can start printing...
297 cupsd_client_t
*con
; /* Current client connection */
299 for (con
= (cupsd_client_t
*)cupsArrayFirst(Clients
);
301 con
= (cupsd_client_t
*)cupsArrayNext(Clients
))
303 con
->request
->request
.op
.operation_id
== IPP_SEND_DOCUMENT
)
309 if (cupsdTimeoutJob(job
))
313 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
314 "Job submission timed out.");
318 * Continue jobs that are waiting on the FilterLimit...
321 if (job
->pending_cost
> 0 &&
322 ((FilterLevel
+ job
->pending_cost
) < FilterLimit
|| FilterLevel
== 0))
323 cupsdContinueJob(job
);
326 * Start pending jobs if the destination is available...
329 if (job
->state_value
== IPP_JOB_PENDING
&& !NeedReload
&&
330 (!Sleeping
|| ACPower
) && !DoingShutdown
&& !job
->printer
)
332 printer
= cupsdFindDest(job
->dest
);
335 while (printer
&& (printer
->type
& CUPS_PRINTER_CLASS
))
338 * If the class is remote, just pass it to the remote server...
343 if (pclass
->state
== IPP_PRINTER_STOPPED
)
345 else if (pclass
->type
& CUPS_PRINTER_REMOTE
)
348 printer
= cupsdFindAvailablePrinter(printer
->name
);
351 if (!printer
&& !pclass
)
354 * Whoa, the printer and/or class for this destination went away;
358 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_PURGE
,
359 "Job aborted because the destination printer/class "
362 else if (printer
&& !printer
->holding_new_jobs
)
365 * See if the printer is available or remote and not printing a job;
366 * if so, start the job...
372 * Add/update a job-actual-printer-uri attribute for this job
373 * so that we know which printer actually printed the job...
376 if ((attr
= ippFindAttribute(job
->attrs
, "job-actual-printer-uri",
377 IPP_TAG_URI
)) != NULL
)
378 ippSetString(job
->attrs
, &attr
, 0, printer
->uri
);
380 ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_URI
,
381 "job-actual-printer-uri", NULL
, printer
->uri
);
384 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
387 if (!printer
->job
&& printer
->state
== IPP_PRINTER_IDLE
)
393 cupsArraySave(ActiveJobs
);
394 start_job(job
, printer
);
395 cupsArrayRestore(ActiveJobs
);
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 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
447 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
448 JobHistoryUpdate
= job
->history_time
;
452 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
453 JobHistoryUpdate
= job
->history_time
;
455 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
456 JobHistoryUpdate
= job
->file_time
;
461 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCleanJobs: JobHistoryUpdate=%ld",
462 (long)JobHistoryUpdate
);
467 * 'cupsdContinueJob()' - Continue printing with the next file in a job.
471 cupsdContinueJob(cupsd_job_t
*job
) /* I - Job */
473 int i
; /* Looping var */
474 int slot
; /* Pipe slot */
475 cups_array_t
*filters
= NULL
,/* Filters for job */
476 *prefilters
; /* Filters with prefilters */
477 mime_filter_t
*filter
, /* Current filter */
478 *prefilter
, /* Prefilter */
479 port_monitor
; /* Port monitor filter */
480 char scheme
[255]; /* Device URI scheme */
481 ipp_attribute_t
*attr
; /* Current attribute */
482 const char *ptr
, /* Pointer into value */
483 *abort_message
; /* Abort message */
484 ipp_jstate_t abort_state
= IPP_JOB_STOPPED
;
485 /* New job state on abort */
486 struct stat backinfo
; /* Backend file information */
487 int backroot
; /* Run backend as root? */
488 int pid
; /* Process ID of new filter process */
489 int banner_page
; /* 1 if banner page, 0 otherwise */
490 int filterfds
[2][2] = { { -1, -1 }, { -1, -1 } };
491 /* Pipes used between filters */
492 int envc
; /* Number of environment variables */
493 struct stat fileinfo
; /* Job file information */
494 int argc
= 0; /* Number of arguments */
495 char **argv
= NULL
, /* Filter command-line arguments */
496 filename
[1024], /* Job filename */
497 command
[1024], /* Full path to command */
498 jobid
[255], /* Job ID string */
500 /* Job title string */
501 copies
[255], /* # copies string */
502 *options
, /* Options string */
504 /* Environment variables */
505 charset
[255], /* CHARSET env variable */
506 class_name
[255],/* CLASS env variable */
507 classification
[1024],
508 /* CLASSIFICATION env variable */
510 /* CONTENT_TYPE env variable */
512 /* DEVICE_URI env variable */
513 final_content_type
[1024] = "",
514 /* FINAL_CONTENT_TYPE env variable */
515 lang
[255], /* LANG env variable */
518 /* APPLE_LANGUAGE env variable */
519 #endif /* __APPLE__ */
520 auth_info_required
[255],
521 /* AUTH_INFO_REQUIRED env variable */
522 ppd
[1024], /* PPD env variable */
524 /* PRINTER_INFO env variable */
525 printer_location
[255],
526 /* PRINTER_LOCATION env variable */
528 /* PRINTER env variable */
529 *printer_state_reasons
= NULL
,
530 /* PRINTER_STATE_REASONS env var */
532 /* RIP_MAX_CACHE env variable */
535 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
536 "cupsdContinueJob(job=%p(%d)): current_file=%d, num_files=%d",
537 job
, job
->id
, job
->current_file
, job
->num_files
);
540 * Figure out what filters are required to convert from
541 * the source to the destination type...
544 FilterLevel
-= job
->cost
;
547 job
->pending_cost
= 0;
549 memset(job
->filters
, 0, sizeof(job
->filters
));
551 if (job
->printer
->raw
)
554 * Remote jobs and raw queues go directly to the printer without
558 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Sending job to queue tagged as raw...");
563 * Local jobs get filtered...
566 mime_type_t
*dst
= job
->printer
->filetype
;
567 /* Destination file type */
569 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
570 job
->id
, job
->current_file
+ 1);
571 if (stat(filename
, &fileinfo
))
572 fileinfo
.st_size
= 0;
574 if (job
->retry_as_raster
)
577 * Need to figure out whether the printer supports image/pwg-raster or
578 * image/urf, and use the corresponding type...
581 char type
[MIME_MAX_TYPE
]; /* MIME media type for printer */
583 snprintf(type
, sizeof(type
), "%s/image/urf", job
->printer
->name
);
584 if ((dst
= mimeType(MimeDatabase
, "printer", type
)) == NULL
)
586 snprintf(type
, sizeof(type
), "%s/image/pwg-raster", job
->printer
->name
);
587 dst
= mimeType(MimeDatabase
, "printer", type
);
591 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Retrying job as \"%s\".", strchr(dst
->type
, '/') + 1);
593 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to retry job using a supported raster format.");
596 filters
= mimeFilter2(MimeDatabase
, job
->filetypes
[job
->current_file
], (size_t)fileinfo
.st_size
, dst
, &(job
->cost
));
600 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
601 "Unable to convert file %d to printable format.",
604 abort_message
= "Aborting job because it cannot be printed.";
605 abort_state
= IPP_JOB_ABORTED
;
607 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
612 * Figure out the final content type...
615 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%d filters for job:",
616 cupsArrayCount(filters
));
617 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
619 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
620 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s (%s/%s to %s/%s, cost %d)",
622 filter
->src
? filter
->src
->super
: "???",
623 filter
->src
? filter
->src
->type
: "???",
624 filter
->dst
? filter
->dst
->super
: "???",
625 filter
->dst
? filter
->dst
->type
: "???",
628 if (!job
->printer
->remote
)
630 for (filter
= (mime_filter_t
*)cupsArrayLast(filters
);
631 filter
&& filter
->dst
;
632 filter
= (mime_filter_t
*)cupsArrayPrev(filters
))
633 if (strcmp(filter
->dst
->super
, "printer") ||
634 strcmp(filter
->dst
->type
, job
->printer
->name
))
637 if (filter
&& filter
->dst
)
639 if ((ptr
= strchr(filter
->dst
->type
, '/')) != NULL
)
640 snprintf(final_content_type
, sizeof(final_content_type
),
641 "FINAL_CONTENT_TYPE=%s", ptr
+ 1);
643 snprintf(final_content_type
, sizeof(final_content_type
),
644 "FINAL_CONTENT_TYPE=%s/%s", filter
->dst
->super
,
648 snprintf(final_content_type
, sizeof(final_content_type
),
649 "FINAL_CONTENT_TYPE=printer/%s", job
->printer
->name
);
653 * Remove NULL ("-") filters...
656 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
658 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
659 if (!strcmp(filter
->filter
, "-"))
660 cupsArrayRemove(filters
, filter
);
662 if (cupsArrayCount(filters
) == 0)
664 cupsArrayDelete(filters
);
669 * If this printer has any pre-filters, insert the required pre-filter
670 * in the filters array...
673 if (job
->printer
->prefiltertype
&& filters
)
675 prefilters
= cupsArrayNew(NULL
, NULL
);
677 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
679 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
681 if ((prefilter
= mimeFilterLookup(MimeDatabase
, filter
->src
,
682 job
->printer
->prefiltertype
)))
684 cupsArrayAdd(prefilters
, prefilter
);
685 job
->cost
+= prefilter
->cost
;
688 cupsArrayAdd(prefilters
, filter
);
691 cupsArrayDelete(filters
);
692 filters
= prefilters
;
697 * Set a minimum cost of 100 for all jobs so that FilterLimit
698 * works with raw queues and other low-cost paths.
705 * See if the filter cost is too high...
708 if ((FilterLevel
+ job
->cost
) > FilterLimit
&& FilterLevel
> 0 &&
712 * Don't print this job quite yet...
715 cupsArrayDelete(filters
);
717 cupsdLogJob(job
, CUPSD_LOG_INFO
,
718 "Holding because filter limit has been reached.");
719 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
,
720 "cupsdContinueJob: file=%d, cost=%d, level=%d, limit=%d",
721 job
->current_file
, job
->cost
, FilterLevel
,
724 job
->pending_cost
= job
->cost
;
729 FilterLevel
+= job
->cost
;
732 * Add decompression/raw filter as needed...
735 if (job
->compressions
[job
->current_file
] &&
736 (!job
->printer
->remote
|| job
->num_files
== 1))
739 * Add gziptoany filter to the front of the list...
743 filters
= cupsArrayNew(NULL
, NULL
);
745 if (!cupsArrayInsert(filters
, &gziptoany_filter
))
747 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
748 "Unable to add decompression filter - %s", strerror(errno
));
750 cupsArrayDelete(filters
);
752 abort_message
= "Stopping job because the scheduler ran out of memory.";
759 * Add port monitor, if any...
762 if (job
->printer
->port_monitor
)
765 * Add port monitor to the end of the list...
769 filters
= cupsArrayNew(NULL
, NULL
);
771 port_monitor
.src
= NULL
;
772 port_monitor
.dst
= NULL
;
773 port_monitor
.cost
= 0;
775 snprintf(port_monitor
.filter
, sizeof(port_monitor
.filter
),
776 "%s/monitor/%s", ServerBin
, job
->printer
->port_monitor
);
778 if (!cupsArrayAdd(filters
, &port_monitor
))
780 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
781 "Unable to add port monitor - %s", strerror(errno
));
783 abort_message
= "Stopping job because the scheduler ran out of memory.";
790 * Make sure we don't go over the "MAX_FILTERS" limit...
793 if (cupsArrayCount(filters
) > MAX_FILTERS
)
795 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
796 "Too many filters (%d > %d), unable to print.",
797 cupsArrayCount(filters
), MAX_FILTERS
);
799 abort_message
= "Aborting job because it needs too many filters to print.";
800 abort_state
= IPP_JOB_ABORTED
;
802 ippSetString(job
->attrs
, &job
->reasons
, 0, "document-unprintable-error");
808 * Determine if we are printing a banner page or not...
811 if (job
->job_sheets
== NULL
)
813 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "No job-sheets attribute.");
814 if ((job
->job_sheets
=
815 ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_ZERO
)) != NULL
)
816 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
817 "... but someone added one without setting job_sheets.");
819 else if (job
->job_sheets
->num_values
== 1)
820 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s",
821 job
->job_sheets
->values
[0].string
.text
);
823 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s,%s",
824 job
->job_sheets
->values
[0].string
.text
,
825 job
->job_sheets
->values
[1].string
.text
);
827 if (job
->printer
->type
& CUPS_PRINTER_REMOTE
)
829 else if (job
->job_sheets
== NULL
)
831 else if (_cups_strcasecmp(job
->job_sheets
->values
[0].string
.text
, "none") != 0 &&
832 job
->current_file
== 0)
834 else if (job
->job_sheets
->num_values
> 1 &&
835 _cups_strcasecmp(job
->job_sheets
->values
[1].string
.text
, "none") != 0 &&
836 job
->current_file
== (job
->num_files
- 1))
841 if ((options
= get_options(job
, banner_page
, copies
, sizeof(copies
), title
,
842 sizeof(title
))) == NULL
)
844 abort_message
= "Stopping job because the scheduler ran out of memory.";
850 * Build the command-line arguments for the filters. Each filter
851 * has 6 or 7 arguments:
859 * argv[6] = filename (optional; normally stdin)
861 * This allows legacy printer drivers that use the old System V
862 * printing interface to be used by CUPS.
864 * For remote jobs, we send all of the files in the argument list.
867 if (job
->printer
->remote
)
868 argc
= 6 + job
->num_files
;
872 if ((argv
= calloc((size_t)argc
+ 1, sizeof(char *))) == NULL
)
874 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Unable to allocate argument array - %s",
877 abort_message
= "Stopping job because the scheduler ran out of memory.";
882 sprintf(jobid
, "%d", job
->id
);
884 argv
[0] = job
->printer
->name
;
886 argv
[2] = job
->username
;
891 if (job
->printer
->remote
&& job
->num_files
> 1)
893 for (i
= 0; i
< job
->num_files
; i
++)
895 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
897 argv
[6 + i
] = strdup(filename
);
902 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
903 job
->id
, job
->current_file
+ 1);
904 argv
[6] = strdup(filename
);
907 for (i
= 0; argv
[i
]; i
++)
908 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "argv[%d]=\"%s\"", i
, argv
[i
]);
911 * Create environment variable strings for the filters...
914 attr
= ippFindAttribute(job
->attrs
, "attributes-natural-language",
918 strlcpy(apple_language
, "APPLE_LANGUAGE=", sizeof(apple_language
));
919 _cupsAppleLanguage(attr
->values
[0].string
.text
,
920 apple_language
+ 15, sizeof(apple_language
) - 15);
921 #endif /* __APPLE__ */
923 switch (strlen(attr
->values
[0].string
.text
))
927 * This is an unknown or badly formatted language code; use
928 * the POSIX locale...
931 strlcpy(lang
, "LANG=C", sizeof(lang
));
936 * Just the language code (ll)...
939 snprintf(lang
, sizeof(lang
), "LANG=%s.UTF-8",
940 attr
->values
[0].string
.text
);
945 * Language and country code (ll-cc)...
948 snprintf(lang
, sizeof(lang
), "LANG=%c%c_%c%c.UTF-8",
949 attr
->values
[0].string
.text
[0],
950 attr
->values
[0].string
.text
[1],
951 toupper(attr
->values
[0].string
.text
[3] & 255),
952 toupper(attr
->values
[0].string
.text
[4] & 255));
956 if ((attr
= ippFindAttribute(job
->attrs
, "document-format",
957 IPP_TAG_MIMETYPE
)) != NULL
&&
958 (ptr
= strstr(attr
->values
[0].string
.text
, "charset=")) != NULL
)
959 snprintf(charset
, sizeof(charset
), "CHARSET=%s", ptr
+ 8);
961 strlcpy(charset
, "CHARSET=utf-8", sizeof(charset
));
963 snprintf(content_type
, sizeof(content_type
), "CONTENT_TYPE=%s/%s",
964 job
->filetypes
[job
->current_file
]->super
,
965 job
->filetypes
[job
->current_file
]->type
);
966 snprintf(device_uri
, sizeof(device_uri
), "DEVICE_URI=%s",
967 job
->printer
->device_uri
);
968 snprintf(ppd
, sizeof(ppd
), "PPD=%s/ppd/%s.ppd", ServerRoot
,
970 snprintf(printer_info
, sizeof(printer_name
), "PRINTER_INFO=%s",
971 job
->printer
->info
? job
->printer
->info
: "");
972 snprintf(printer_location
, sizeof(printer_name
), "PRINTER_LOCATION=%s",
973 job
->printer
->location
? job
->printer
->location
: "");
974 snprintf(printer_name
, sizeof(printer_name
), "PRINTER=%s", job
->printer
->name
);
975 if (job
->printer
->num_reasons
> 0)
977 char *psrptr
; /* Pointer into PRINTER_STATE_REASONS */
978 size_t psrlen
; /* Size of PRINTER_STATE_REASONS */
980 for (psrlen
= 22, i
= 0; i
< job
->printer
->num_reasons
; i
++)
981 psrlen
+= strlen(job
->printer
->reasons
[i
]) + 1;
983 if ((printer_state_reasons
= malloc(psrlen
)) != NULL
)
986 * All of these strcpy's are safe because we allocated the psr string...
989 strlcpy(printer_state_reasons
, "PRINTER_STATE_REASONS=", psrlen
);
990 for (psrptr
= printer_state_reasons
+ 22, i
= 0;
991 i
< job
->printer
->num_reasons
;
996 strlcpy(psrptr
, job
->printer
->reasons
[i
], psrlen
- (size_t)(psrptr
- printer_state_reasons
));
997 psrptr
+= strlen(psrptr
);
1001 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
1003 if (job
->printer
->num_auth_info_required
== 1)
1004 snprintf(auth_info_required
, sizeof(auth_info_required
),
1005 "AUTH_INFO_REQUIRED=%s",
1006 job
->printer
->auth_info_required
[0]);
1007 else if (job
->printer
->num_auth_info_required
== 2)
1008 snprintf(auth_info_required
, sizeof(auth_info_required
),
1009 "AUTH_INFO_REQUIRED=%s,%s",
1010 job
->printer
->auth_info_required
[0],
1011 job
->printer
->auth_info_required
[1]);
1012 else if (job
->printer
->num_auth_info_required
== 3)
1013 snprintf(auth_info_required
, sizeof(auth_info_required
),
1014 "AUTH_INFO_REQUIRED=%s,%s,%s",
1015 job
->printer
->auth_info_required
[0],
1016 job
->printer
->auth_info_required
[1],
1017 job
->printer
->auth_info_required
[2]);
1018 else if (job
->printer
->num_auth_info_required
== 4)
1019 snprintf(auth_info_required
, sizeof(auth_info_required
),
1020 "AUTH_INFO_REQUIRED=%s,%s,%s,%s",
1021 job
->printer
->auth_info_required
[0],
1022 job
->printer
->auth_info_required
[1],
1023 job
->printer
->auth_info_required
[2],
1024 job
->printer
->auth_info_required
[3]);
1026 strlcpy(auth_info_required
, "AUTH_INFO_REQUIRED=none",
1027 sizeof(auth_info_required
));
1029 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
1031 envp
[envc
++] = charset
;
1032 envp
[envc
++] = lang
;
1034 envp
[envc
++] = apple_language
;
1035 #endif /* __APPLE__ */
1036 envp
[envc
++] = ppd
;
1037 envp
[envc
++] = rip_max_cache
;
1038 envp
[envc
++] = content_type
;
1039 envp
[envc
++] = device_uri
;
1040 envp
[envc
++] = printer_info
;
1041 envp
[envc
++] = printer_location
;
1042 envp
[envc
++] = printer_name
;
1043 envp
[envc
++] = printer_state_reasons
? printer_state_reasons
:
1044 "PRINTER_STATE_REASONS=none";
1045 envp
[envc
++] = banner_page
? "CUPS_FILETYPE=job-sheet" :
1046 "CUPS_FILETYPE=document";
1048 if (final_content_type
[0])
1049 envp
[envc
++] = final_content_type
;
1051 if (Classification
&& !banner_page
)
1053 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
1054 IPP_TAG_NAME
)) == NULL
)
1055 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1057 else if (attr
->num_values
> 1 &&
1058 strcmp(attr
->values
[1].string
.text
, "none") != 0)
1059 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1060 attr
->values
[1].string
.text
);
1062 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
1063 attr
->values
[0].string
.text
);
1065 envp
[envc
++] = classification
;
1068 if (job
->dtype
& CUPS_PRINTER_CLASS
)
1070 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
1071 envp
[envc
++] = class_name
;
1074 envp
[envc
++] = auth_info_required
;
1077 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1079 if (job
->auth_env
[i
])
1080 envp
[envc
++] = job
->auth_env
[i
];
1085 envp
[envc
++] = job
->auth_uid
;
1089 for (i
= 0; i
< envc
; i
++)
1090 if (!strncmp(envp
[i
], "AUTH_", 5))
1091 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"AUTH_%c****\"", i
,
1093 else if (strncmp(envp
[i
], "DEVICE_URI=", 11))
1094 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"%s\"", i
, envp
[i
]);
1096 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"DEVICE_URI=%s\"", i
,
1097 job
->printer
->sanitized_device_uri
);
1099 if (job
->printer
->remote
)
1100 job
->current_file
= job
->num_files
;
1102 job
->current_file
++;
1105 * Now create processes for all of the filters...
1108 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
1110 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
1112 if (filter
->filter
[0] != '/')
1113 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
1116 strlcpy(command
, filter
->filter
, sizeof(command
));
1118 if (i
< (cupsArrayCount(filters
) - 1))
1120 if (cupsdOpenPipe(filterfds
[slot
]))
1122 abort_message
= "Stopping job because the scheduler could not create "
1123 "the filter pipes.";
1130 if (job
->current_file
== 1 ||
1131 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1133 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1135 if (cupsdOpenPipe(job
->print_pipes
))
1137 abort_message
= "Stopping job because the scheduler could not "
1138 "create the backend pipes.";
1145 job
->print_pipes
[0] = -1;
1146 if (!strcmp(job
->printer
->device_uri
, "file:/dev/null") ||
1147 !strcmp(job
->printer
->device_uri
, "file:///dev/null"))
1148 job
->print_pipes
[1] = -1;
1151 if (!strncmp(job
->printer
->device_uri
, "file:/dev/", 10))
1152 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1154 else if (!strncmp(job
->printer
->device_uri
, "file:///dev/", 12))
1155 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1157 else if (!strncmp(job
->printer
->device_uri
, "file:///", 8))
1158 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1159 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1161 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1162 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1164 if (job
->print_pipes
[1] < 0)
1166 abort_message
= "Stopping job because the scheduler could not "
1167 "open the output file.";
1172 fcntl(job
->print_pipes
[1], F_SETFD
,
1173 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
1178 filterfds
[slot
][0] = job
->print_pipes
[0];
1179 filterfds
[slot
][1] = job
->print_pipes
[1];
1182 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1183 filterfds
[slot
][1], job
->status_pipes
[1],
1184 job
->back_pipes
[0], job
->side_pipes
[0], 0,
1185 job
->profile
, job
, job
->filters
+ i
);
1187 cupsdClosePipe(filterfds
[!slot
]);
1191 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
1192 filter
->filter
, strerror(errno
));
1194 abort_message
= "Stopping job because the scheduler could not execute a "
1200 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started filter %s (PID %d)", command
,
1212 cupsArrayDelete(filters
);
1216 * Finally, pipe the final output into a backend process if needed...
1219 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1221 if (job
->current_file
== 1 || job
->printer
->remote
||
1222 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1224 sscanf(job
->printer
->device_uri
, "%254[^:]", scheme
);
1225 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, scheme
);
1228 * See if the backend needs to run as root...
1233 else if (stat(command
, &backinfo
))
1236 backroot
= !(backinfo
.st_mode
& (S_IWGRP
| S_IRWXO
));
1238 argv
[0] = job
->printer
->sanitized_device_uri
;
1240 filterfds
[slot
][0] = -1;
1241 filterfds
[slot
][1] = -1;
1243 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1244 filterfds
[slot
][1], job
->status_pipes
[1],
1245 job
->back_pipes
[1], job
->side_pipes
[1],
1246 backroot
, job
->bprofile
, job
, &(job
->backend
));
1250 abort_message
= "Stopping job because the sheduler could not execute "
1257 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started backend %s (PID %d)",
1262 if (job
->current_file
== job
->num_files
||
1263 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1264 cupsdClosePipe(job
->print_pipes
);
1266 if (job
->current_file
== job
->num_files
)
1268 cupsdClosePipe(job
->back_pipes
);
1269 cupsdClosePipe(job
->side_pipes
);
1271 close(job
->status_pipes
[1]);
1272 job
->status_pipes
[1] = -1;
1277 filterfds
[slot
][0] = -1;
1278 filterfds
[slot
][1] = -1;
1280 if (job
->current_file
== job
->num_files
||
1281 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1282 cupsdClosePipe(job
->print_pipes
);
1284 if (job
->current_file
== job
->num_files
)
1286 close(job
->status_pipes
[1]);
1287 job
->status_pipes
[1] = -1;
1291 cupsdClosePipe(filterfds
[slot
]);
1293 for (i
= 6; i
< argc
; i
++)
1299 if (printer_state_reasons
)
1300 free(printer_state_reasons
);
1302 cupsdAddSelect(job
->status_buffer
->fd
, (cupsd_selfunc_t
)update_job
, NULL
,
1305 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
1312 * If we get here, we need to abort the current job and close out all
1313 * files and pipes...
1318 FilterLevel
-= job
->cost
;
1321 for (slot
= 0; slot
< 2; slot
++)
1322 cupsdClosePipe(filterfds
[slot
]);
1324 cupsArrayDelete(filters
);
1328 for (i
= 6; i
< argc
; i
++)
1333 if (printer_state_reasons
)
1334 free(printer_state_reasons
);
1336 cupsdClosePipe(job
->print_pipes
);
1337 cupsdClosePipe(job
->back_pipes
);
1338 cupsdClosePipe(job
->side_pipes
);
1340 cupsdRemoveSelect(job
->status_pipes
[0]);
1341 cupsdClosePipe(job
->status_pipes
);
1342 cupsdStatBufDelete(job
->status_buffer
);
1343 job
->status_buffer
= NULL
;
1346 * Update the printer and job state.
1349 cupsdSetJobState(job
, abort_state
, CUPSD_JOB_DEFAULT
, "%s", abort_message
);
1350 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_IDLE
, 0);
1351 update_job_attrs(job
, 0);
1354 free_job_history(job
);
1356 cupsArrayRemove(PrintingJobs
, job
);
1359 * Clear the printer <-> job association...
1362 job
->printer
->job
= NULL
;
1363 job
->printer
= NULL
;
1368 * 'cupsdDeleteJob()' - Free all memory used by a job.
1372 cupsdDeleteJob(cupsd_job_t
*job
, /* I - Job */
1373 cupsd_jobaction_t action
)/* I - Action */
1375 int i
; /* Looping var */
1379 finalize_job(job
, 1);
1381 if (action
== CUPSD_JOB_PURGE
)
1382 remove_job_history(job
);
1384 cupsdClearString(&job
->username
);
1385 cupsdClearString(&job
->dest
);
1387 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1389 cupsdClearString(job
->auth_env
+ i
);
1390 cupsdClearString(&job
->auth_uid
);
1392 if (action
== CUPSD_JOB_PURGE
)
1393 remove_job_files(job
);
1394 else if (job
->num_files
> 0)
1396 free(job
->compressions
);
1397 free(job
->filetypes
);
1403 free_job_history(job
);
1407 cupsArrayRemove(Jobs
, job
);
1408 cupsArrayRemove(ActiveJobs
, job
);
1409 cupsArrayRemove(PrintingJobs
, job
);
1416 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1420 cupsdFreeAllJobs(void)
1422 cupsd_job_t
*job
; /* Current job */
1430 cupsdStopAllJobs(CUPSD_JOB_FORCE
, 0);
1433 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1435 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1436 cupsdDeleteJob(job
, CUPSD_JOB_DEFAULT
);
1438 cupsdReleaseSignals();
1443 * 'cupsdFindJob()' - Find the specified job.
1446 cupsd_job_t
* /* O - Job data */
1447 cupsdFindJob(int id
) /* I - Job ID */
1449 cupsd_job_t key
; /* Search key */
1454 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
1459 * 'cupsdGetCompletedJobs()'- Generate a completed jobs list.
1462 cups_array_t
* /* O - Array of jobs */
1463 cupsdGetCompletedJobs(
1464 cupsd_printer_t
*p
) /* I - Printer */
1466 cups_array_t
*list
; /* Array of jobs */
1467 cupsd_job_t
*job
; /* Current job */
1470 list
= cupsArrayNew(compare_completed_jobs
, NULL
);
1472 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1474 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1475 if ((!p
|| !_cups_strcasecmp(p
->name
, job
->dest
)) && job
->state_value
>= IPP_JOB_STOPPED
&& job
->completed_time
)
1476 cupsArrayAdd(list
, job
);
1483 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1484 * or held jobs in a printer or class.
1487 int /* O - Job count */
1488 cupsdGetPrinterJobCount(
1489 const char *dest
) /* I - Printer or class name */
1491 int count
; /* Job count */
1492 cupsd_job_t
*job
; /* Current job */
1495 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1497 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1498 if (job
->dest
&& !_cups_strcasecmp(job
->dest
, dest
))
1506 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1507 * or held jobs for a user.
1510 int /* O - Job count */
1511 cupsdGetUserJobCount(
1512 const char *username
) /* I - Username */
1514 int count
; /* Job count */
1515 cupsd_job_t
*job
; /* Current job */
1518 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1520 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1521 if (!_cups_strcasecmp(job
->username
, username
))
1529 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1533 cupsdLoadAllJobs(void)
1535 char filename
[1024]; /* Full filename of job.cache file */
1536 struct stat fileinfo
; /* Information on job.cache file */
1537 cups_dir_t
*dir
; /* RequestRoot dir */
1538 cups_dentry_t
*dent
; /* Entry in RequestRoot */
1539 int load_cache
= 1; /* Load the job.cache file? */
1543 * Create the job arrays as needed...
1547 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1550 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1553 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1556 * See whether the job.cache file is older than the RequestRoot directory...
1559 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1561 if (stat(filename
, &fileinfo
))
1564 * No job.cache file...
1569 if (errno
!= ENOENT
)
1570 cupsdLogMessage(CUPSD_LOG_ERROR
,
1571 "Unable to get file information for \"%s\" - %s",
1572 filename
, strerror(errno
));
1574 else if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
1577 * No spool directory...
1584 while ((dent
= cupsDirRead(dir
)) != NULL
)
1586 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c' && dent
->fileinfo
.st_mtime
> fileinfo
.st_mtime
)
1589 * Job history file is newer than job.cache file...
1601 * Load the most recent source for job data...
1607 * Load the job.cache file...
1610 load_job_cache(filename
);
1615 * Load the job history files...
1618 load_request_root();
1620 load_next_job_id(filename
);
1624 * Clean out old jobs as needed...
1627 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1633 * 'cupsdLoadJob()' - Load a single job.
1636 int /* O - 1 on success, 0 on failure */
1637 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1639 int i
; /* Looping var */
1640 char jobfile
[1024]; /* Job filename */
1641 cups_file_t
*fp
; /* Job file */
1642 int fileid
; /* Current file ID */
1643 ipp_attribute_t
*attr
; /* Job attribute */
1644 const char *dest
; /* Destination name */
1645 cupsd_printer_t
*destptr
; /* Pointer to destination */
1646 mime_type_t
**filetypes
; /* New filetypes array */
1647 int *compressions
; /* New compressions array */
1652 if (job
->state_value
> IPP_JOB_STOPPED
)
1653 job
->access_time
= time(NULL
);
1658 if ((job
->attrs
= ippNew()) == NULL
)
1660 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes.");
1665 * Load job attributes...
1668 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading attributes...");
1670 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1671 if ((fp
= cupsdOpenConfFile(jobfile
)) == NULL
)
1674 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1676 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1677 "Unable to read job control file \"%s\".", jobfile
);
1685 * Copy attribute data to the job object...
1688 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1690 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1691 "Missing or bad time-at-creation attribute in control file.");
1695 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1696 IPP_TAG_ENUM
)) == NULL
)
1698 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1699 "Missing or bad job-state attribute in control file.");
1703 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1705 job
->history_time
= 0;
1707 if ((attr
= ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
)) != NULL
)
1708 job
->creation_time
= attr
->values
[0].integer
;
1710 if (job
->state_value
>= IPP_JOB_CANCELED
&& (attr
= ippFindAttribute(job
->attrs
, "time-at-completed", IPP_TAG_INTEGER
)) != NULL
)
1712 job
->completed_time
= attr
->values
[0].integer
;
1714 if (JobHistory
< INT_MAX
)
1715 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
1717 job
->history_time
= INT_MAX
;
1719 if (job
->history_time
< time(NULL
))
1720 goto error
; /* Expired, remove from history */
1722 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1723 JobHistoryUpdate
= job
->history_time
;
1725 if (JobFiles
< INT_MAX
)
1726 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
1728 job
->file_time
= INT_MAX
;
1730 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
1731 JobHistoryUpdate
= job
->file_time
;
1733 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdLoadJob: JobHistoryUpdate=%ld",
1734 (long)JobHistoryUpdate
);
1739 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1740 IPP_TAG_URI
)) == NULL
)
1742 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1743 "No job-printer-uri attribute in control file.");
1747 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1750 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1751 "Unable to queue job for destination \"%s\".",
1752 attr
->values
[0].string
.text
);
1756 cupsdSetString(&job
->dest
, dest
);
1758 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1760 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1761 "Unable to queue job for destination \"%s\".",
1766 if ((job
->reasons
= ippFindAttribute(job
->attrs
, "job-state-reasons",
1767 IPP_TAG_KEYWORD
)) == NULL
)
1769 const char *reason
; /* job-state-reason keyword */
1771 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1772 "Adding missing job-state-reasons attribute to control file.");
1774 switch (job
->state_value
)
1777 case IPP_JOB_PENDING
:
1778 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1779 reason
= "printer-stopped";
1785 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1786 IPP_TAG_ZERO
)) != NULL
&&
1787 (attr
->value_tag
== IPP_TAG_NAME
||
1788 attr
->value_tag
== IPP_TAG_NAMELANG
||
1789 attr
->value_tag
== IPP_TAG_KEYWORD
) &&
1790 strcmp(attr
->values
[0].string
.text
, "no-hold"))
1791 reason
= "job-hold-until-specified";
1793 reason
= "job-incoming";
1796 case IPP_JOB_PROCESSING
:
1797 reason
= "job-printing";
1800 case IPP_JOB_STOPPED
:
1801 reason
= "job-stopped";
1804 case IPP_JOB_CANCELED
:
1805 reason
= "job-canceled-by-user";
1808 case IPP_JOB_ABORTED
:
1809 reason
= "aborted-by-system";
1812 case IPP_JOB_COMPLETED
:
1813 reason
= "job-completed-successfully";
1817 job
->reasons
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
1818 "job-state-reasons", NULL
, reason
);
1820 else if (job
->state_value
== IPP_JOB_PENDING
)
1822 if (destptr
->state
== IPP_PRINTER_STOPPED
)
1823 ippSetString(job
->attrs
, &job
->reasons
, 0, "printer-stopped");
1825 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
1828 job
->impressions
= ippFindAttribute(job
->attrs
, "job-impressions-completed", IPP_TAG_INTEGER
);
1829 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed", IPP_TAG_INTEGER
);
1830 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1832 if (!job
->impressions
)
1833 job
->impressions
= ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-impressions-completed", 0);
1837 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1838 IPP_TAG_INTEGER
)) == NULL
)
1840 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1841 "Missing or bad job-priority attribute in control file.");
1845 job
->priority
= attr
->values
[0].integer
;
1850 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1851 IPP_TAG_NAME
)) == NULL
)
1853 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1854 "Missing or bad job-originating-user-name "
1855 "attribute in control file.");
1859 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1864 if ((attr
= ippFindAttribute(job
->attrs
, "job-name", IPP_TAG_NAME
)) != NULL
)
1865 cupsdSetString(&job
->name
, attr
->values
[0].string
.text
);
1869 * Set the job hold-until time and state...
1872 if (job
->state_value
== IPP_JOB_HELD
)
1874 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1875 IPP_TAG_KEYWORD
)) == NULL
)
1876 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1879 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1882 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1883 job
->state_value
= IPP_JOB_PENDING
;
1886 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1888 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1889 job
->state_value
= IPP_JOB_PENDING
;
1892 if ((attr
= ippFindAttribute(job
->attrs
, "job-k-octets", IPP_TAG_INTEGER
)) != NULL
)
1893 job
->koctets
= attr
->values
[0].integer
;
1895 if (!job
->num_files
)
1898 * Find all the d##### files...
1901 for (fileid
= 1; fileid
< 10000; fileid
++)
1903 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1906 if (access(jobfile
, 0))
1909 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
1910 "Auto-typing document file \"%s\"...", jobfile
);
1912 if (fileid
> job
->num_files
)
1914 if (job
->num_files
== 0)
1916 compressions
= (int *)calloc((size_t)fileid
, sizeof(int));
1917 filetypes
= (mime_type_t
**)calloc((size_t)fileid
, sizeof(mime_type_t
*));
1921 compressions
= (int *)realloc(job
->compressions
, sizeof(int) * (size_t)fileid
);
1922 filetypes
= (mime_type_t
**)realloc(job
->filetypes
, sizeof(mime_type_t
*) * (size_t)fileid
);
1926 job
->compressions
= compressions
;
1929 job
->filetypes
= filetypes
;
1931 if (!compressions
|| !filetypes
)
1933 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
1934 "Ran out of memory for job file types.");
1936 ippDelete(job
->attrs
);
1939 if (job
->compressions
)
1941 free(job
->compressions
);
1942 job
->compressions
= NULL
;
1947 free(job
->filetypes
);
1948 job
->filetypes
= NULL
;
1955 job
->num_files
= fileid
;
1958 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1959 job
->compressions
+ fileid
- 1);
1961 if (!job
->filetypes
[fileid
- 1])
1962 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1968 * Load authentication information as needed...
1971 if (job
->state_value
< IPP_JOB_STOPPED
)
1973 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1976 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
1978 cupsdClearString(job
->auth_env
+ i
);
1979 cupsdClearString(&job
->auth_uid
);
1981 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
1983 int bytes
, /* Size of auth data */
1984 linenum
= 1; /* Current line number */
1985 char line
[65536], /* Line from file */
1986 *value
, /* Value from line */
1987 data
[65536]; /* Decoded data */
1990 if (cupsFileGets(fp
, line
, sizeof(line
)) &&
1991 !strcmp(line
, "CUPSD-AUTH-V3"))
1994 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
2000 if (strcmp(line
, "negotiate") && strcmp(line
, "uid"))
2002 bytes
= sizeof(data
);
2003 httpDecode64_2(data
, &bytes
, value
);
2007 * Assign environment variables...
2010 if (!strcmp(line
, "uid"))
2012 cupsdSetStringf(&job
->auth_uid
, "AUTH_UID=%s", value
);
2015 else if (i
>= (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0])))
2018 if (!strcmp(line
, "username"))
2019 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_USERNAME=%s", data
);
2020 else if (!strcmp(line
, "domain"))
2021 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_DOMAIN=%s", data
);
2022 else if (!strcmp(line
, "password"))
2023 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_PASSWORD=%s", data
);
2024 else if (!strcmp(line
, "negotiate"))
2025 cupsdSetStringf(job
->auth_env
+ i
, "AUTH_NEGOTIATE=%s", value
);
2037 job
->access_time
= time(NULL
);
2041 * If we get here then something bad happened...
2046 ippDelete(job
->attrs
);
2049 remove_job_history(job
);
2050 remove_job_files(job
);
2057 * 'cupsdMoveJob()' - Move the specified job to a different destination.
2061 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
2062 cupsd_printer_t
*p
) /* I - Destination printer or class */
2064 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
2065 const char *olddest
; /* Old destination */
2066 cupsd_printer_t
*oldp
; /* Old pointer */
2070 * Don't move completed jobs...
2073 if (job
->state_value
> IPP_JOB_STOPPED
)
2077 * Get the old destination...
2080 olddest
= job
->dest
;
2083 oldp
= job
->printer
;
2085 oldp
= cupsdFindDest(olddest
);
2088 * Change the destination information...
2091 if (job
->state_value
> IPP_JOB_HELD
)
2092 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2093 "Stopping job prior to move.");
2095 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
2096 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2099 cupsdSetString(&job
->dest
, p
->name
);
2100 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
);
2102 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
2103 IPP_TAG_URI
)) != NULL
)
2104 ippSetString(job
->attrs
, &attr
, 0, p
->uri
);
2106 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
2107 "Job #%d moved from %s to %s.", job
->id
, olddest
,
2111 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2116 * 'cupsdReleaseJob()' - Release the specified job.
2120 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
2122 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
2125 if (job
->state_value
== IPP_JOB_HELD
)
2128 * Add trailing banner as needed...
2131 if (job
->pending_timeout
)
2132 cupsdTimeoutJob(job
);
2134 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2135 "Job released by user.");
2141 * 'cupsdRestartJob()' - Restart the specified job.
2145 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
2147 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
2150 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
2151 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
2152 "Job restarted by user.");
2157 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2161 cupsdSaveAllJobs(void)
2163 int i
; /* Looping var */
2164 cups_file_t
*fp
; /* job.cache file */
2165 char filename
[1024], /* job.cache filename */
2166 temp
[1024]; /* Temporary string */
2167 cupsd_job_t
*job
; /* Current job */
2168 time_t curtime
; /* Current time */
2169 struct tm
*curdate
; /* Current date */
2172 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
2173 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
)) == NULL
)
2176 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job.cache...");
2179 * Write a small header to the file...
2182 curtime
= time(NULL
);
2183 curdate
= localtime(&curtime
);
2184 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
2186 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
2187 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
2188 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
2191 * Write each job known to the system...
2194 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2196 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2198 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
2199 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
2200 cupsFilePrintf(fp
, "Created %ld\n", (long)job
->creation_time
);
2201 if (job
->completed_time
)
2202 cupsFilePrintf(fp
, "Completed %ld\n", (long)job
->completed_time
);
2203 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
2204 if (job
->hold_until
)
2205 cupsFilePrintf(fp
, "HoldUntil %ld\n", (long)job
->hold_until
);
2206 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
2208 cupsFilePutConf(fp
, "Name", job
->name
);
2209 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
2210 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
2211 cupsFilePrintf(fp
, "KOctets %d\n", job
->koctets
);
2212 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
2213 for (i
= 0; i
< job
->num_files
; i
++)
2214 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
2215 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
2216 cupsFilePuts(fp
, "</Job>\n");
2219 cupsdCloseCreatedConfFile(fp
, filename
);
2224 * 'cupsdSaveJob()' - Save a job to disk.
2228 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
2230 char filename
[1024]; /* Job control filename */
2231 cups_file_t
*fp
; /* Job file */
2234 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2235 job
, job
->id
, job
->attrs
);
2237 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
2239 if ((fp
= cupsdCreateConfFile(filename
, ConfigFilePerm
& 0600)) == NULL
)
2242 fchown(cupsFileNumber(fp
), RunUser
, Group
);
2244 job
->attrs
->state
= IPP_IDLE
;
2246 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
2247 job
->attrs
) != IPP_DATA
)
2249 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to write job control file.");
2254 if (!cupsdCloseCreatedConfFile(fp
, filename
))
2257 * Remove backup file and mark this job as clean...
2260 strlcat(filename
, ".O", sizeof(filename
));
2269 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2273 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
2274 const char *when
, /* I - When to resume */
2275 int update
)/* I - Update job-hold-until attr? */
2277 time_t curtime
; /* Current time */
2278 struct tm
*curdate
; /* Current date */
2279 int hour
; /* Hold hour */
2280 int minute
; /* Hold minute */
2281 int second
= 0; /* Hold second */
2284 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2285 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2286 job
, job
->id
, when
, update
);
2291 * Update the job-hold-until attribute...
2294 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2296 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2297 IPP_TAG_KEYWORD
)) == NULL
)
2298 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2301 ippSetString(job
->attrs
, &attr
, 0, when
);
2303 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2304 "job-hold-until", NULL
, when
);
2308 if (isdigit(when
[0] & 255))
2309 attr
->value_tag
= IPP_TAG_NAME
;
2311 attr
->value_tag
= IPP_TAG_KEYWORD
;
2314 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2319 if (strcmp(when
, "no-hold"))
2320 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-hold-until-specified");
2322 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
2325 * Update the hold time...
2328 job
->cancel_time
= 0;
2330 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2333 * Hold indefinitely...
2336 job
->hold_until
= 0;
2338 if (MaxHoldTime
> 0)
2339 job
->cancel_time
= time(NULL
) + MaxHoldTime
;
2341 else if (!strcmp(when
, "day-time"))
2344 * Hold to 6am the next morning unless local time is < 6pm.
2347 curtime
= time(NULL
);
2348 curdate
= localtime(&curtime
);
2350 if (curdate
->tm_hour
< 18)
2351 job
->hold_until
= curtime
;
2353 job
->hold_until
= curtime
+
2354 ((29 - curdate
->tm_hour
) * 60 + 59 -
2355 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2357 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2360 * Hold to 6pm unless local time is > 6pm or < 6am.
2363 curtime
= time(NULL
);
2364 curdate
= localtime(&curtime
);
2366 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2367 job
->hold_until
= curtime
;
2369 job
->hold_until
= curtime
+
2370 ((17 - curdate
->tm_hour
) * 60 + 59 -
2371 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2373 else if (!strcmp(when
, "second-shift"))
2376 * Hold to 4pm unless local time is > 4pm.
2379 curtime
= time(NULL
);
2380 curdate
= localtime(&curtime
);
2382 if (curdate
->tm_hour
>= 16)
2383 job
->hold_until
= curtime
;
2385 job
->hold_until
= curtime
+
2386 ((15 - curdate
->tm_hour
) * 60 + 59 -
2387 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2389 else if (!strcmp(when
, "third-shift"))
2392 * Hold to 12am unless local time is < 8am.
2395 curtime
= time(NULL
);
2396 curdate
= localtime(&curtime
);
2398 if (curdate
->tm_hour
< 8)
2399 job
->hold_until
= curtime
;
2401 job
->hold_until
= curtime
+
2402 ((23 - curdate
->tm_hour
) * 60 + 59 -
2403 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2405 else if (!strcmp(when
, "weekend"))
2408 * Hold to weekend unless we are in the weekend.
2411 curtime
= time(NULL
);
2412 curdate
= localtime(&curtime
);
2414 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2415 job
->hold_until
= curtime
;
2417 job
->hold_until
= curtime
+
2418 (((5 - curdate
->tm_wday
) * 24 +
2419 (17 - curdate
->tm_hour
)) * 60 + 59 -
2420 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2422 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2425 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2428 curtime
= time(NULL
);
2429 curdate
= gmtime(&curtime
);
2431 job
->hold_until
= curtime
+
2432 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2433 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2436 * Hold until next day as needed...
2439 if (job
->hold_until
< curtime
)
2440 job
->hold_until
+= 24 * 60 * 60;
2443 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2444 (int)job
->hold_until
);
2449 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2450 * the list as needed.
2454 cupsdSetJobPriority(
2455 cupsd_job_t
*job
, /* I - Job ID */
2456 int priority
) /* I - New priority (0 to 100) */
2458 ipp_attribute_t
*attr
; /* Job attribute */
2462 * Don't change completed jobs...
2465 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2469 * Set the new priority and re-add the job into the active list...
2472 cupsArrayRemove(ActiveJobs
, job
);
2474 job
->priority
= priority
;
2476 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2477 IPP_TAG_INTEGER
)) != NULL
)
2478 attr
->values
[0].integer
= priority
;
2480 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2483 cupsArrayAdd(ActiveJobs
, job
);
2486 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2491 * 'cupsdSetJobState()' - Set the state of the specified print job.
2496 cupsd_job_t
*job
, /* I - Job to cancel */
2497 ipp_jstate_t newstate
, /* I - New job state */
2498 cupsd_jobaction_t action
, /* I - Action to take */
2499 const char *message
, /* I - Message to log */
2500 ...) /* I - Additional arguments as needed */
2502 int i
; /* Looping var */
2503 ipp_jstate_t oldstate
; /* Old state */
2504 char filename
[1024]; /* Job filename */
2505 ipp_attribute_t
*attr
; /* Job attribute */
2508 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2509 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2510 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2511 newstate
, action
, message
? message
: "(null)");
2515 * Make sure we have the job attributes...
2518 if (!cupsdLoadJob(job
))
2522 * Don't do anything if the state is unchanged and we aren't purging the
2526 oldstate
= job
->state_value
;
2527 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2531 * Stop any processes that are working on the current job...
2534 if (oldstate
== IPP_JOB_PROCESSING
)
2535 stop_job(job
, action
);
2538 * Set the new job state...
2541 job
->state_value
= newstate
;
2544 job
->state
->values
[0].integer
= newstate
;
2548 case IPP_JOB_PENDING
:
2550 * Update job-hold-until as needed...
2553 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2554 IPP_TAG_KEYWORD
)) == NULL
)
2555 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2559 ippSetValueTag(job
->attrs
, &attr
, IPP_TAG_KEYWORD
);
2560 ippSetString(job
->attrs
, &attr
, 0, "no-hold");
2566 case IPP_JOB_ABORTED
:
2567 case IPP_JOB_CANCELED
:
2568 case IPP_JOB_COMPLETED
:
2569 set_time(job
, "time-at-completed");
2570 ippSetString(job
->attrs
, &job
->reasons
, 0, "processing-to-stop-point");
2575 * Log message as needed...
2580 char buffer
[2048]; /* Message buffer */
2581 va_list ap
; /* Pointer to additional arguments */
2583 va_start(ap
, message
);
2584 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2587 if (newstate
> IPP_JOB_STOPPED
)
2588 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2590 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2592 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2593 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2595 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2599 * Handle post-state-change actions...
2604 case IPP_JOB_PROCESSING
:
2606 * Add the job to the "printing" list...
2609 if (!cupsArrayFind(PrintingJobs
, job
))
2610 cupsArrayAdd(PrintingJobs
, job
);
2613 * Set the processing time...
2616 set_time(job
, "time-at-processing");
2618 case IPP_JOB_PENDING
:
2620 case IPP_JOB_STOPPED
:
2622 * Make sure the job is in the active list...
2625 if (!cupsArrayFind(ActiveJobs
, job
))
2626 cupsArrayAdd(ActiveJobs
, job
);
2629 * Save the job state to disk...
2633 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2636 case IPP_JOB_ABORTED
:
2637 case IPP_JOB_CANCELED
:
2638 case IPP_JOB_COMPLETED
:
2639 if (newstate
== IPP_JOB_CANCELED
)
2642 * Remove the job from the active list if there are no processes still
2646 for (i
= 0; job
->filters
[i
] < 0; i
++);
2648 if (!job
->filters
[i
] && job
->backend
<= 0)
2649 cupsArrayRemove(ActiveJobs
, job
);
2654 * Otherwise just remove the job from the active list immediately...
2657 cupsArrayRemove(ActiveJobs
, job
);
2661 * Expire job subscriptions since the job is now "completed"...
2664 cupsdExpireSubscriptions(NULL
, job
);
2668 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2669 * sleep to happen immediately...
2672 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2674 #endif /* __APPLE__ */
2677 * Remove any authentication data...
2680 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2681 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2682 cupsdLogMessage(CUPSD_LOG_ERROR
,
2683 "Unable to remove authentication cache: %s",
2687 i
< (int)(sizeof(job
->auth_env
) / sizeof(job
->auth_env
[0]));
2689 cupsdClearString(job
->auth_env
+ i
);
2691 cupsdClearString(&job
->auth_uid
);
2694 * Remove the print file for good if we aren't preserving jobs or
2698 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2699 remove_job_files(job
);
2701 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2704 * Save job state info...
2708 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2710 else if (!job
->printer
)
2713 * Delete the job immediately if not actively printing...
2716 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2723 * Finalize the job immediately if we forced things...
2726 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2727 finalize_job(job
, 0);
2730 * Update the server "busy" state...
2733 cupsdSetBusyState();
2738 * 'cupsdStopAllJobs()' - Stop all print jobs.
2743 cupsd_jobaction_t action
, /* I - Action */
2744 int kill_delay
) /* I - Number of seconds before we kill */
2746 cupsd_job_t
*job
; /* Current job */
2749 DEBUG_puts("cupsdStopAllJobs()");
2751 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2753 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2757 cupsdSetJobState(job
, IPP_JOB_COMPLETED
, CUPSD_JOB_FORCE
, NULL
);
2762 job
->kill_time
= time(NULL
) + kill_delay
;
2764 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2771 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2775 cupsdUnloadCompletedJobs(void)
2777 cupsd_job_t
*job
; /* Current job */
2778 time_t expire
; /* Expiration time */
2781 expire
= time(NULL
) - 60;
2783 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2785 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2786 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2787 job
->access_time
< expire
)
2798 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2802 cupsdUpdateJobs(void)
2804 cupsd_job_t
*job
; /* Current job */
2805 time_t curtime
; /* Current time */
2806 ipp_attribute_t
*attr
; /* time-at-completed attribute */
2809 curtime
= time(NULL
);
2810 JobHistoryUpdate
= 0;
2812 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2814 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2816 if (job
->state_value
>= IPP_JOB_CANCELED
&&
2817 (attr
= ippFindAttribute(job
->attrs
, "time-at-completed",
2818 IPP_TAG_INTEGER
)) != NULL
)
2821 * Update history/file expiration times...
2824 if (JobHistory
< INT_MAX
)
2825 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
2827 job
->history_time
= INT_MAX
;
2829 if (job
->history_time
< curtime
)
2831 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2835 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2836 JobHistoryUpdate
= job
->history_time
;
2838 if (JobFiles
< INT_MAX
)
2839 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
2841 job
->file_time
= INT_MAX
;
2843 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
2844 JobHistoryUpdate
= job
->file_time
;
2848 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdUpdateAllJobs: JobHistoryUpdate=%ld",
2849 (long)JobHistoryUpdate
);
2854 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2857 static int /* O - Difference */
2858 compare_active_jobs(void *first
, /* I - First job */
2859 void *second
, /* I - Second job */
2860 void *data
) /* I - App data (not used) */
2862 int diff
; /* Difference */
2867 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2868 ((cupsd_job_t
*)first
)->priority
) != 0)
2871 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2876 * 'compare_completed_jobs()' - Compare the job IDs and completion times of two jobs.
2879 static int /* O - Difference */
2880 compare_completed_jobs(void *first
, /* I - First job */
2881 void *second
, /* I - Second job */
2882 void *data
) /* I - App data (not used) */
2884 int diff
; /* Difference */
2889 if ((diff
= ((cupsd_job_t
*)second
)->completed_time
-
2890 ((cupsd_job_t
*)first
)->completed_time
) != 0)
2893 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2898 * 'compare_jobs()' - Compare the job IDs of two jobs.
2901 static int /* O - Difference */
2902 compare_jobs(void *first
, /* I - First job */
2903 void *second
, /* I - Second job */
2904 void *data
) /* I - App data (not used) */
2908 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2913 * 'dump_job_history()' - Dump any debug messages for a job.
2917 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2919 int i
, /* Looping var */
2920 oldsize
; /* Current MaxLogSize */
2921 struct tm
*date
; /* Date/time value */
2922 cupsd_joblog_t
*message
; /* Current message */
2923 char temp
[2048], /* Log message */
2924 *ptr
, /* Pointer into log message */
2925 start
[256], /* Start time */
2926 end
[256]; /* End time */
2927 cupsd_printer_t
*printer
; /* Printer for job */
2931 * See if we have anything to dump...
2938 * Disable log rotation temporarily...
2941 oldsize
= MaxLogSize
;
2945 * Copy the debug messages to the log...
2948 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2949 date
= localtime(&(message
->time
));
2950 strftime(start
, sizeof(start
), "%X", date
);
2952 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2953 date
= localtime(&(message
->time
));
2954 strftime(end
, sizeof(end
), "%X", date
);
2956 snprintf(temp
, sizeof(temp
),
2957 "[Job %d] The following messages were recorded from %s to %s",
2958 job
->id
, start
, end
);
2959 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2961 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2963 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
2964 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
2966 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
2967 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2970 * Log the printer state values...
2973 if ((printer
= job
->printer
) == NULL
)
2974 printer
= cupsdFindDest(job
->dest
);
2978 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
2980 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
2981 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
2983 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2985 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
2986 job
->id
, printer
->state_message
);
2987 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2989 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
2990 ptr
= temp
+ strlen(temp
);
2991 if (printer
->num_reasons
== 0)
2992 strlcpy(ptr
, "none", sizeof(temp
) - (size_t)(ptr
- temp
));
2996 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
3002 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (size_t)(ptr
- temp
));
3006 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
3010 * Restore log file rotation...
3013 MaxLogSize
= oldsize
;
3016 * Free all messages...
3019 free_job_history(job
);
3024 * 'free_job_history()' - Free any log history.
3028 free_job_history(cupsd_job_t
*job
) /* I - Job */
3030 char *message
; /* Current message */
3036 for (message
= (char *)cupsArrayFirst(job
->history
);
3038 message
= (char *)cupsArrayNext(job
->history
))
3041 cupsArrayDelete(job
->history
);
3042 job
->history
= NULL
;
3047 * 'finalize_job()' - Cleanup after job filter processes and support data.
3051 finalize_job(cupsd_job_t
*job
, /* I - Job */
3052 int set_job_state
) /* I - 1 = set the job state */
3054 ipp_pstate_t printer_state
; /* New printer state value */
3055 ipp_jstate_t job_state
; /* New job state value */
3056 const char *message
; /* Message for job state */
3057 char buffer
[1024]; /* Buffer for formatted messages */
3060 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
3063 * Clear the "connecting-to-device" and "cups-waiting-for-job-completed"
3064 * reasons, which are only valid when a printer is processing, along with any
3065 * remote printing job state...
3068 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device,"
3069 "cups-waiting-for-job-completed,"
3070 "cups-remote-pending,"
3071 "cups-remote-pending-held,"
3072 "cups-remote-processing,"
3073 "cups-remote-stopped,"
3074 "cups-remote-canceled,"
3075 "cups-remote-aborted,"
3076 "cups-remote-completed");
3079 * Similarly, clear the "offline-report" reason for non-USB devices since we
3080 * rarely have current information for network devices...
3083 if (strncmp(job
->printer
->device_uri
, "usb:", 4) &&
3084 strncmp(job
->printer
->device_uri
, "ippusb:", 7))
3085 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
3088 * Free the security profile...
3091 cupsdDestroyProfile(job
->profile
);
3092 job
->profile
= NULL
;
3093 cupsdDestroyProfile(job
->bprofile
);
3094 job
->bprofile
= NULL
;
3097 * Clear the unresponsive job watchdog timers...
3100 job
->cancel_time
= 0;
3104 * Close pipes and status buffer...
3107 cupsdClosePipe(job
->print_pipes
);
3108 cupsdClosePipe(job
->back_pipes
);
3109 cupsdClosePipe(job
->side_pipes
);
3111 cupsdRemoveSelect(job
->status_pipes
[0]);
3112 cupsdClosePipe(job
->status_pipes
);
3113 cupsdStatBufDelete(job
->status_buffer
);
3114 job
->status_buffer
= NULL
;
3117 * Process the exit status...
3120 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
3121 printer_state
= IPP_PRINTER_IDLE
;
3123 printer_state
= job
->printer
->state
;
3125 switch (job_state
= job
->state_value
)
3127 case IPP_JOB_PENDING
:
3128 message
= "Job paused.";
3132 message
= "Job held.";
3136 case IPP_JOB_PROCESSING
:
3137 case IPP_JOB_COMPLETED
:
3138 job_state
= IPP_JOB_COMPLETED
;
3139 message
= "Job completed.";
3142 ippSetString(job
->attrs
, &job
->reasons
, 0,
3143 "job-completed-successfully");
3146 case IPP_JOB_STOPPED
:
3147 message
= "Job stopped.";
3149 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-stopped");
3152 case IPP_JOB_CANCELED
:
3153 message
= "Job canceled.";
3155 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-canceled-by-user");
3158 case IPP_JOB_ABORTED
:
3159 message
= "Job aborted.";
3163 if (job
->status
< 0)
3166 * Backend had errors...
3169 int exit_code
; /* Exit code from backend */
3172 * Convert the status to an exit code. Due to the way the W* macros are
3173 * implemented on MacOS X (bug?), we have to store the exit status in a
3174 * variable first and then convert...
3177 exit_code
= -job
->status
;
3178 if (WIFEXITED(exit_code
))
3179 exit_code
= WEXITSTATUS(exit_code
);
3182 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-backend-crashed");
3183 exit_code
= job
->status
;
3186 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
3188 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
3189 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
3190 "authentication required" :
3191 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
3192 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
3193 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
3194 exit_code
== CUPS_BACKEND_RETRY
? "retry job later" :
3195 exit_code
== CUPS_BACKEND_RETRY_CURRENT
? "retry job immediately" :
3196 exit_code
< 0 ? "crashed" : "unknown");
3199 * Do what needs to be done...
3205 case CUPS_BACKEND_FAILED
:
3207 * Backend failure, use the error-policy to determine how to
3211 if (job
->dtype
& CUPS_PRINTER_CLASS
)
3214 * Queued on a class - mark the job as pending and we'll retry on
3215 * another printer...
3218 if (job_state
== IPP_JOB_COMPLETED
)
3220 job_state
= IPP_JOB_PENDING
;
3221 message
= "Retrying job on another printer.";
3223 ippSetString(job
->attrs
, &job
->reasons
, 0,
3224 "resources-are-not-ready");
3227 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
3230 * The error policy is "retry-current-job" - mark the job as pending
3231 * and we'll retry on the same printer...
3234 if (job_state
== IPP_JOB_COMPLETED
)
3236 job_state
= IPP_JOB_PENDING
;
3237 message
= "Retrying job on same printer.";
3239 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3242 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
3243 !strcmp(job
->printer
->error_policy
, "retry-job"))
3245 if (job_state
== IPP_JOB_COMPLETED
)
3248 * The job was queued on a fax or the error policy is "retry-job" -
3249 * hold the job if the number of retries is less than the
3250 * JobRetryLimit, otherwise abort the job.
3255 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3261 snprintf(buffer
, sizeof(buffer
),
3262 "Job aborted after %d unsuccessful attempts.",
3264 job_state
= IPP_JOB_ABORTED
;
3267 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3272 * Try again in N seconds...
3275 snprintf(buffer
, sizeof(buffer
),
3276 "Job held for %d seconds since it could not be sent.",
3279 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3280 job_state
= IPP_JOB_HELD
;
3283 ippSetString(job
->attrs
, &job
->reasons
, 0,
3284 "resources-are-not-ready");
3288 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
3289 job_state
== IPP_JOB_COMPLETED
)
3291 job_state
= IPP_JOB_ABORTED
;
3292 message
= "Job aborted due to backend errors; please consult "
3293 "the error_log file for details.";
3295 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3297 else if (job
->state_value
== IPP_JOB_PROCESSING
)
3299 job_state
= IPP_JOB_PENDING
;
3300 printer_state
= IPP_PRINTER_STOPPED
;
3301 message
= "Printer stopped due to backend errors; please "
3302 "consult the error_log file for details.";
3304 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3308 case CUPS_BACKEND_CANCEL
:
3313 if (job_state
== IPP_JOB_COMPLETED
)
3315 job_state
= IPP_JOB_CANCELED
;
3316 message
= "Job canceled at printer.";
3318 ippSetString(job
->attrs
, &job
->reasons
, 0, "canceled-at-device");
3322 case CUPS_BACKEND_HOLD
:
3323 if (job_state
== IPP_JOB_COMPLETED
)
3329 const char *reason
= ippGetString(job
->reasons
, 0, NULL
);
3331 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-state-reasons=\"%s\"",
3334 if (!reason
|| strncmp(reason
, "account-", 8))
3336 cupsdSetJobHoldUntil(job
, "indefinite", 1);
3338 ippSetString(job
->attrs
, &job
->reasons
, 0,
3339 "job-hold-until-specified");
3340 message
= "Job held indefinitely due to backend errors; please "
3341 "consult the error_log file for details.";
3343 else if (!strcmp(reason
, "account-info-needed"))
3345 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3347 message
= "Job held indefinitely - account information is "
3350 else if (!strcmp(reason
, "account-closed"))
3352 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3354 message
= "Job held indefinitely - account has been closed.";
3356 else if (!strcmp(reason
, "account-limit-reached"))
3358 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3360 message
= "Job held indefinitely - account limit has been "
3365 cupsdSetJobHoldUntil(job
, "indefinite", 0);
3367 message
= "Job held indefinitely - account authorization failed.";
3370 job_state
= IPP_JOB_HELD
;
3374 case CUPS_BACKEND_STOP
:
3376 * Stop the printer...
3379 printer_state
= IPP_PRINTER_STOPPED
;
3380 message
= "Printer stopped due to backend errors; please "
3381 "consult the error_log file for details.";
3383 if (job_state
== IPP_JOB_COMPLETED
)
3385 job_state
= IPP_JOB_PENDING
;
3387 ippSetString(job
->attrs
, &job
->reasons
, 0,
3388 "resources-are-not-ready");
3392 case CUPS_BACKEND_AUTH_REQUIRED
:
3394 * Hold the job for authentication...
3397 if (job_state
== IPP_JOB_COMPLETED
)
3399 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
3401 job_state
= IPP_JOB_HELD
;
3402 message
= "Job held for authentication.";
3404 if (strncmp(job
->reasons
->values
[0].string
.text
, "account-", 8))
3405 ippSetString(job
->attrs
, &job
->reasons
, 0,
3406 "cups-held-for-authentication");
3410 case CUPS_BACKEND_RETRY
:
3411 if (job_state
== IPP_JOB_COMPLETED
)
3414 * Hold the job if the number of retries is less than the
3415 * JobRetryLimit, otherwise abort the job.
3420 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
3426 snprintf(buffer
, sizeof(buffer
),
3427 "Job aborted after %d unsuccessful attempts.",
3429 job_state
= IPP_JOB_ABORTED
;
3432 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
3437 * Try again in N seconds...
3440 snprintf(buffer
, sizeof(buffer
),
3441 "Job held for %d seconds since it could not be sent.",
3444 job
->hold_until
= time(NULL
) + JobRetryInterval
;
3445 job_state
= IPP_JOB_HELD
;
3448 ippSetString(job
->attrs
, &job
->reasons
, 0,
3449 "resources-are-not-ready");
3454 case CUPS_BACKEND_RETRY_CURRENT
:
3456 * Mark the job as pending and retry on the same printer...
3459 if (job_state
== IPP_JOB_COMPLETED
)
3461 job_state
= IPP_JOB_PENDING
;
3462 message
= "Retrying job on same printer.";
3464 ippSetString(job
->attrs
, &job
->reasons
, 0, "none");
3469 else if (job
->status
> 0)
3472 * Filter had errors; stop job...
3475 if (job_state
== IPP_JOB_COMPLETED
)
3477 job_state
= IPP_JOB_STOPPED
;
3478 message
= "Job stopped due to filter errors; please consult the "
3479 "error_log file for details.";
3481 if (WIFSIGNALED(job
->status
))
3482 ippSetString(job
->attrs
, &job
->reasons
, 0, "cups-filter-crashed");
3484 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-completed-with-errors");
3489 * Update the printer and job state.
3492 if (set_job_state
&& job_state
!= job
->state_value
)
3493 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
3495 cupsdSetPrinterState(job
->printer
, printer_state
,
3496 printer_state
== IPP_PRINTER_STOPPED
);
3497 update_job_attrs(job
, 0);
3502 (job
->state_value
== IPP_JOB_ABORTED
||
3503 job
->state_value
== IPP_JOB_STOPPED
))
3504 dump_job_history(job
);
3506 free_job_history(job
);
3509 cupsArrayRemove(PrintingJobs
, job
);
3512 * Apply any PPD updates...
3515 if (job
->num_keywords
)
3517 if (cupsdUpdatePrinterPPD(job
->printer
, job
->num_keywords
, job
->keywords
))
3518 cupsdSetPrinterAttrs(job
->printer
);
3520 cupsFreeOptions(job
->num_keywords
, job
->keywords
);
3522 job
->num_keywords
= 0;
3523 job
->keywords
= NULL
;
3527 * Clear the printer <-> job association...
3530 job
->printer
->job
= NULL
;
3531 job
->printer
= NULL
;
3536 * 'get_options()' - Get a string containing the job options.
3539 static char * /* O - Options string */
3540 get_options(cupsd_job_t
*job
, /* I - Job */
3541 int banner_page
, /* I - Printing a banner page? */
3542 char *copies
, /* I - Copies buffer */
3543 size_t copies_size
, /* I - Size of copies buffer */
3544 char *title
, /* I - Title buffer */
3545 size_t title_size
) /* I - Size of title buffer */
3547 int i
; /* Looping var */
3548 size_t newlength
; /* New option buffer length */
3549 char *optptr
, /* Pointer to options */
3550 *valptr
; /* Pointer in value string */
3551 ipp_attribute_t
*attr
; /* Current attribute */
3552 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3553 int num_pwgppds
; /* Number of PWG->PPD options */
3554 cups_option_t
*pwgppds
, /* PWG->PPD options */
3555 *pwgppd
, /* Current PWG->PPD option */
3556 *preset
; /* Current preset option */
3557 int print_color_mode
,
3558 /* Output mode (if any) */
3559 print_quality
; /* Print quality (if any) */
3560 const char *ppd
; /* PPD option choice */
3561 int exact
; /* Did we get an exact match? */
3562 static char *options
= NULL
;/* Full list of options */
3563 static size_t optlength
= 0; /* Length of option buffer */
3567 * Building the options string is harder than it needs to be, but for the
3568 * moment we need to pass strings for command-line args and not IPP attribute
3571 * First build an options array for any PWG->PPD mapped option/choice pairs.
3574 pc
= job
->printer
->pc
;
3579 !ippFindAttribute(job
->attrs
,
3580 "com.apple.print.DocumentTicket.PMSpoolFormat",
3582 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3583 (ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) ||
3584 ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
)))
3587 * Map print-color-mode and print-quality to a preset...
3590 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3591 IPP_TAG_KEYWORD
)) != NULL
&&
3592 !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3593 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3595 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3597 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality",
3598 IPP_TAG_ENUM
)) != NULL
&&
3599 attr
->values
[0].integer
>= IPP_QUALITY_DRAFT
&&
3600 attr
->values
[0].integer
<= IPP_QUALITY_HIGH
)
3601 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3603 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3605 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3608 * Try to find a preset that works so that we maximize the chances of us
3609 * getting a good print using IPP attributes.
3612 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3613 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3614 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3615 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3618 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3619 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3623 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3626 * Copy the preset options as long as the corresponding names are not
3627 * already defined in the IPP request...
3630 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3631 preset
= pc
->presets
[print_color_mode
][print_quality
];
3635 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3636 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
,
3644 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3645 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3647 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3648 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3651 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3652 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3653 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3655 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3656 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3657 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3659 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3661 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3662 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3665 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3666 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3667 IPP_TAG_ZERO
)) != NULL
&&
3668 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3669 attr
->value_tag
== IPP_TAG_NAME
) &&
3670 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3673 * Map output-bin to OutputBin option...
3676 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3679 if (pc
->sides_option
&&
3680 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3681 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3684 * Map sides to duplex option...
3687 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3688 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
,
3689 num_pwgppds
, &pwgppds
);
3690 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3691 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
,
3692 num_pwgppds
, &pwgppds
);
3693 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3694 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
,
3695 num_pwgppds
, &pwgppds
);
3699 * Map finishings values...
3702 num_pwgppds
= _ppdCacheGetFinishingOptions(pc
, job
->attrs
,
3703 IPP_FINISHINGS_NONE
, num_pwgppds
,
3708 * Figure out how much room we need...
3711 newlength
= ipp_length(job
->attrs
);
3713 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3714 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3717 * Then allocate/reallocate the option buffer as needed...
3720 if (newlength
== 0) /* This can never happen, but Clang */
3721 newlength
= 1; /* thinks it can... */
3723 if (newlength
> optlength
|| !options
)
3726 optptr
= malloc(newlength
);
3728 optptr
= realloc(options
, newlength
);
3732 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3733 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer.",
3734 CUPS_LLCAST newlength
);
3739 optlength
= newlength
;
3743 * Now loop through the attributes and convert them to the textual
3744 * representation used by the filters...
3750 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3751 strlcpy(copies
, "1", copies_size
);
3753 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3755 if (!strcmp(attr
->name
, "copies") &&
3756 attr
->value_tag
== IPP_TAG_INTEGER
)
3759 * Don't use the # copies attribute if we are printing the job sheets...
3763 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3765 else if (!strcmp(attr
->name
, "job-name") &&
3766 (attr
->value_tag
== IPP_TAG_NAME
||
3767 attr
->value_tag
== IPP_TAG_NAMELANG
))
3768 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3769 else if (attr
->group_tag
== IPP_TAG_JOB
)
3772 * Filter out other unwanted attributes...
3775 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3776 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3777 attr
->value_tag
== IPP_TAG_NAMELANG
||
3778 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3779 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid") &&
3780 strcmp(attr
->name
, "job-authorization-uri")) ||
3781 attr
->value_tag
== IPP_TAG_URISCHEME
||
3782 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3785 if (!strcmp(attr
->name
, "job-hold-until") ||
3786 !strcmp(attr
->name
, "job-id") ||
3787 !strcmp(attr
->name
, "job-k-octets") ||
3788 !strcmp(attr
->name
, "job-media-sheets") ||
3789 !strcmp(attr
->name
, "job-media-sheets-completed") ||
3790 !strcmp(attr
->name
, "job-state") ||
3791 !strcmp(attr
->name
, "job-state-reasons"))
3794 if (!strncmp(attr
->name
, "job-", 4) &&
3795 strcmp(attr
->name
, "job-account-id") &&
3796 strcmp(attr
->name
, "job-accounting-user-id") &&
3797 strcmp(attr
->name
, "job-authorization-uri") &&
3798 strcmp(attr
->name
, "job-billing") &&
3799 strcmp(attr
->name
, "job-impressions") &&
3800 strcmp(attr
->name
, "job-originating-host-name") &&
3801 strcmp(attr
->name
, "job-password") &&
3802 strcmp(attr
->name
, "job-password-encryption") &&
3803 strcmp(attr
->name
, "job-uuid") &&
3804 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3807 if ((!strcmp(attr
->name
, "job-impressions") ||
3808 !strcmp(attr
->name
, "page-label") ||
3809 !strcmp(attr
->name
, "page-border") ||
3810 !strncmp(attr
->name
, "number-up", 9) ||
3811 !strcmp(attr
->name
, "page-ranges") ||
3812 !strcmp(attr
->name
, "page-set") ||
3813 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3814 !_cups_strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3815 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3816 "PMTotalSidesImaged..n.") ||
3817 !_cups_strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3818 "PMTotalBeginPages..n.")) &&
3823 * Otherwise add them to the list...
3826 if (optptr
> options
)
3827 strlcat(optptr
, " ", optlength
- (size_t)(optptr
- options
));
3829 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3831 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
3832 strlcat(optptr
, "=", optlength
- (size_t)(optptr
- options
));
3835 for (i
= 0; i
< attr
->num_values
; i
++)
3838 strlcat(optptr
, ",", optlength
- (size_t)(optptr
- options
));
3840 optptr
+= strlen(optptr
);
3842 switch (attr
->value_tag
)
3844 case IPP_TAG_INTEGER
:
3846 snprintf(optptr
, optlength
- (size_t)(optptr
- options
),
3847 "%d", attr
->values
[i
].integer
);
3850 case IPP_TAG_BOOLEAN
:
3851 if (!attr
->values
[i
].boolean
)
3852 strlcat(optptr
, "no", optlength
- (size_t)(optptr
- options
));
3854 strlcat(optptr
, attr
->name
, optlength
- (size_t)(optptr
- options
));
3857 case IPP_TAG_RANGE
:
3858 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3859 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3860 "%d", attr
->values
[i
].range
.lower
);
3862 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3863 "%d-%d", attr
->values
[i
].range
.lower
,
3864 attr
->values
[i
].range
.upper
);
3867 case IPP_TAG_RESOLUTION
:
3868 snprintf(optptr
, optlength
- (size_t)(optptr
- options
) - 1,
3869 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
3870 attr
->values
[i
].resolution
.yres
,
3871 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
3875 case IPP_TAG_STRING
:
3878 case IPP_TAG_KEYWORD
:
3879 case IPP_TAG_CHARSET
:
3880 case IPP_TAG_LANGUAGE
:
3882 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
3884 if (strchr(" \t\n\\\'\"", *valptr
))
3886 *optptr
++ = *valptr
++;
3893 break; /* anti-compiler-warning-code */
3897 optptr
+= strlen(optptr
);
3902 * Finally loop through the PWG->PPD mapped options and add them...
3905 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3908 strlcpy(optptr
, pwgppd
->name
, optlength
- (size_t)(optptr
- options
));
3909 optptr
+= strlen(optptr
);
3911 strlcpy(optptr
, pwgppd
->value
, optlength
- (size_t)(optptr
- options
));
3912 optptr
+= strlen(optptr
);
3915 cupsFreeOptions(num_pwgppds
, pwgppds
);
3918 * Return the options string...
3926 * 'ipp_length()' - Compute the size of the buffer needed to hold
3927 * the textual IPP attributes.
3930 static size_t /* O - Size of attribute buffer */
3931 ipp_length(ipp_t
*ipp
) /* I - IPP request */
3933 size_t bytes
; /* Number of bytes */
3934 int i
; /* Looping var */
3935 ipp_attribute_t
*attr
; /* Current attribute */
3939 * Loop through all attributes...
3944 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3947 * Skip attributes that won't be sent to filters...
3950 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3951 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3952 attr
->value_tag
== IPP_TAG_NAMELANG
||
3953 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3954 attr
->value_tag
== IPP_TAG_URI
||
3955 attr
->value_tag
== IPP_TAG_URISCHEME
)
3959 * Add space for a leading space and commas between each value.
3960 * For the first attribute, the leading space isn't used, so the
3961 * extra byte can be used as the nul terminator...
3964 bytes
++; /* " " separator */
3965 bytes
+= (size_t)attr
->num_values
; /* "," separators */
3968 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3969 * other attributes appear as "foo=value1,value2,...,valueN".
3972 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3973 bytes
+= strlen(attr
->name
);
3975 bytes
+= (size_t)attr
->num_values
* strlen(attr
->name
);
3978 * Now add the size required for each value in the attribute...
3981 switch (attr
->value_tag
)
3983 case IPP_TAG_INTEGER
:
3986 * Minimum value of a signed integer is -2147483647, or 11 digits.
3989 bytes
+= (size_t)attr
->num_values
* 11;
3992 case IPP_TAG_BOOLEAN
:
3994 * Add two bytes for each false ("no") value...
3997 for (i
= 0; i
< attr
->num_values
; i
++)
3998 if (!attr
->values
[i
].boolean
)
4002 case IPP_TAG_RANGE
:
4004 * A range is two signed integers separated by a hyphen, or
4005 * 23 characters max.
4008 bytes
+= (size_t)attr
->num_values
* 23;
4011 case IPP_TAG_RESOLUTION
:
4013 * A resolution is two signed integers separated by an "x" and
4014 * suffixed by the units, or 26 characters max.
4017 bytes
+= (size_t)attr
->num_values
* 26;
4020 case IPP_TAG_STRING
:
4023 case IPP_TAG_KEYWORD
:
4024 case IPP_TAG_CHARSET
:
4025 case IPP_TAG_LANGUAGE
:
4028 * Strings can contain characters that need quoting. We need
4029 * at least 2 * len + 2 characters to cover the quotes and
4030 * any backslashes in the string.
4033 for (i
= 0; i
< attr
->num_values
; i
++)
4034 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
4038 break; /* anti-compiler-warning-code */
4047 * 'load_job_cache()' - Load jobs from the job.cache file.
4051 load_job_cache(const char *filename
) /* I - job.cache filename */
4053 cups_file_t
*fp
; /* job.cache file */
4054 char line
[1024], /* Line buffer */
4055 *value
; /* Value on line */
4056 int linenum
; /* Line number in file */
4057 cupsd_job_t
*job
; /* Current job */
4058 int jobid
; /* Job ID */
4059 char jobfile
[1024]; /* Job filename */
4063 * Open the job.cache file...
4066 if ((fp
= cupsdOpenConfFile(filename
)) == NULL
)
4068 load_request_root();
4073 * Read entries from the job cache file and create jobs as needed.
4076 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
4082 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4084 if (!_cups_strcasecmp(line
, "NextJobId"))
4087 NextJobId
= atoi(value
);
4089 else if (!_cups_strcasecmp(line
, "<Job"))
4093 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d of %s.", linenum
, filename
);
4099 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d of %s.", linenum
, filename
);
4103 jobid
= atoi(value
);
4107 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d of %s.", jobid
, linenum
, filename
);
4111 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
4112 if (access(jobfile
, 0))
4114 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d.N", RequestRoot
, jobid
);
4115 if (access(jobfile
, 0))
4117 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away.",
4123 job
= calloc(1, sizeof(cupsd_job_t
));
4126 cupsdLogMessage(CUPSD_LOG_EMERG
,
4127 "[Job %d] Unable to allocate memory for job.", jobid
);
4132 job
->back_pipes
[0] = -1;
4133 job
->back_pipes
[1] = -1;
4134 job
->print_pipes
[0] = -1;
4135 job
->print_pipes
[1] = -1;
4136 job
->side_pipes
[0] = -1;
4137 job
->side_pipes
[1] = -1;
4138 job
->status_pipes
[0] = -1;
4139 job
->status_pipes
[1] = -1;
4141 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Loading from cache...");
4145 cupsdLogMessage(CUPSD_LOG_ERROR
,
4146 "Missing <Job #> directive on line %d of %s.", linenum
, filename
);
4149 else if (!_cups_strcasecmp(line
, "</Job>"))
4151 cupsArrayAdd(Jobs
, job
);
4153 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
4154 cupsArrayAdd(ActiveJobs
, job
);
4155 else if (job
->state_value
> IPP_JOB_STOPPED
)
4157 if (!job
->completed_time
|| !job
->creation_time
|| !job
->name
|| !job
->koctets
)
4168 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d of %s.", linenum
, filename
);
4171 else if (!_cups_strcasecmp(line
, "State"))
4173 job
->state_value
= (ipp_jstate_t
)atoi(value
);
4175 if (job
->state_value
< IPP_JOB_PENDING
)
4176 job
->state_value
= IPP_JOB_PENDING
;
4177 else if (job
->state_value
> IPP_JOB_COMPLETED
)
4178 job
->state_value
= IPP_JOB_COMPLETED
;
4180 else if (!_cups_strcasecmp(line
, "Name"))
4182 cupsdSetString(&(job
->name
), value
);
4184 else if (!_cups_strcasecmp(line
, "Created"))
4186 job
->creation_time
= strtol(value
, NULL
, 10);
4188 else if (!_cups_strcasecmp(line
, "Completed"))
4190 job
->completed_time
= strtol(value
, NULL
, 10);
4192 else if (!_cups_strcasecmp(line
, "HoldUntil"))
4194 job
->hold_until
= strtol(value
, NULL
, 10);
4196 else if (!_cups_strcasecmp(line
, "Priority"))
4198 job
->priority
= atoi(value
);
4200 else if (!_cups_strcasecmp(line
, "Username"))
4202 cupsdSetString(&job
->username
, value
);
4204 else if (!_cups_strcasecmp(line
, "Destination"))
4206 cupsdSetString(&job
->dest
, value
);
4208 else if (!_cups_strcasecmp(line
, "DestType"))
4210 job
->dtype
= (cups_ptype_t
)atoi(value
);
4212 else if (!_cups_strcasecmp(line
, "KOctets"))
4214 job
->koctets
= atoi(value
);
4216 else if (!_cups_strcasecmp(line
, "NumFiles"))
4218 job
->num_files
= atoi(value
);
4220 if (job
->num_files
< 0)
4222 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d of %s.", job
->num_files
, linenum
, filename
);
4227 if (job
->num_files
> 0)
4229 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
4231 if (access(jobfile
, 0))
4233 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Data files have gone away.");
4238 job
->filetypes
= calloc((size_t)job
->num_files
, sizeof(mime_type_t
*));
4239 job
->compressions
= calloc((size_t)job
->num_files
, sizeof(int));
4241 if (!job
->filetypes
|| !job
->compressions
)
4243 cupsdLogJob(job
, CUPSD_LOG_EMERG
,
4244 "Unable to allocate memory for %d files.",
4250 else if (!_cups_strcasecmp(line
, "File"))
4252 int number
, /* File number */
4253 compression
; /* Compression value */
4254 char super
[MIME_MAX_SUPER
], /* MIME super type */
4255 type
[MIME_MAX_TYPE
]; /* MIME type */
4258 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
4261 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d of %s.", linenum
, filename
);
4265 if (number
< 1 || number
> job
->num_files
)
4267 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d of %s.", number
, linenum
, filename
);
4273 job
->compressions
[number
] = compression
;
4274 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
4276 if (!job
->filetypes
[number
])
4279 * If the original MIME type is unknown, auto-type it!
4282 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
4283 "Unknown MIME type %s/%s for file %d.",
4284 super
, type
, number
+ 1);
4286 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
4287 job
->id
, number
+ 1);
4288 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
4289 job
->compressions
+ number
);
4292 * If that didn't work, assume it is raw...
4295 if (!job
->filetypes
[number
])
4296 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
4301 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d of %s.", line
, linenum
, filename
);
4306 cupsdLogMessage(CUPSD_LOG_ERROR
,
4307 "Missing </Job> directive on line %d of %s.", linenum
, filename
);
4308 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
4316 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4320 load_next_job_id(const char *filename
) /* I - job.cache filename */
4322 cups_file_t
*fp
; /* job.cache file */
4323 char line
[1024], /* Line buffer */
4324 *value
; /* Value on line */
4325 int linenum
; /* Line number in file */
4326 int next_job_id
; /* NextJobId value from line */
4330 * Read the NextJobId directive from the job.cache file and use
4331 * the value (if any).
4334 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4336 if (errno
!= ENOENT
)
4337 cupsdLogMessage(CUPSD_LOG_ERROR
,
4338 "Unable to open job cache file \"%s\": %s",
4339 filename
, strerror(errno
));
4344 cupsdLogMessage(CUPSD_LOG_INFO
,
4345 "Loading NextJobId from job cache file \"%s\"...", filename
);
4349 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4351 if (!_cups_strcasecmp(line
, "NextJobId"))
4355 next_job_id
= atoi(value
);
4357 if (next_job_id
> NextJobId
)
4358 NextJobId
= next_job_id
;
4369 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4373 load_request_root(void)
4375 cups_dir_t
*dir
; /* Directory */
4376 cups_dentry_t
*dent
; /* Directory entry */
4377 cupsd_job_t
*job
; /* New job */
4381 * Open the requests directory...
4384 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
4386 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
4388 cupsdLogMessage(CUPSD_LOG_ERROR
,
4389 "Unable to open spool directory \"%s\": %s",
4390 RequestRoot
, strerror(errno
));
4395 * Read all the c##### files...
4398 while ((dent
= cupsDirRead(dir
)) != NULL
)
4399 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
4402 * Allocate memory for the job...
4405 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
4407 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs.");
4413 * Assign the job ID...
4416 job
->id
= atoi(dent
->filename
+ 1);
4417 job
->back_pipes
[0] = -1;
4418 job
->back_pipes
[1] = -1;
4419 job
->print_pipes
[0] = -1;
4420 job
->print_pipes
[1] = -1;
4421 job
->side_pipes
[0] = -1;
4422 job
->side_pipes
[1] = -1;
4423 job
->status_pipes
[0] = -1;
4424 job
->status_pipes
[1] = -1;
4426 if (job
->id
>= NextJobId
)
4427 NextJobId
= job
->id
+ 1;
4433 if (cupsdLoadJob(job
))
4436 * Insert the job into the array, sorting by job priority and ID...
4439 cupsArrayAdd(Jobs
, job
);
4441 if (job
->state_value
<= IPP_JOB_STOPPED
)
4442 cupsArrayAdd(ActiveJobs
, job
);
4455 * 'remove_job_files()' - Remove the document files for a job.
4459 remove_job_files(cupsd_job_t
*job
) /* I - Job */
4461 int i
; /* Looping var */
4462 char filename
[1024]; /* Document filename */
4465 if (job
->num_files
<= 0)
4468 for (i
= 1; i
<= job
->num_files
; i
++)
4470 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
4472 cupsdUnlinkOrRemoveFile(filename
);
4475 free(job
->filetypes
);
4476 free(job
->compressions
);
4480 job
->filetypes
= NULL
;
4481 job
->compressions
= NULL
;
4483 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4488 * 'remove_job_history()' - Remove the control file for a job.
4492 remove_job_history(cupsd_job_t
*job
) /* I - Job */
4494 char filename
[1024]; /* Control filename */
4498 * Remove the job info file...
4501 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
4503 cupsdUnlinkOrRemoveFile(filename
);
4505 LastEvent
|= CUPSD_EVENT_PRINTER_STATE_CHANGED
;
4510 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4514 set_time(cupsd_job_t
*job
, /* I - Job to update */
4515 const char *name
) /* I - Name of attribute */
4517 char date_name
[128]; /* date-time-at-xxx */
4518 ipp_attribute_t
*attr
; /* Time attribute */
4519 time_t curtime
; /* Current time */
4522 curtime
= time(NULL
);
4524 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "%s=%ld", name
, (long)curtime
);
4526 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
4528 attr
->value_tag
= IPP_TAG_INTEGER
;
4529 attr
->values
[0].integer
= curtime
;
4532 snprintf(date_name
, sizeof(date_name
), "date-%s", name
);
4534 if ((attr
= ippFindAttribute(job
->attrs
, date_name
, IPP_TAG_ZERO
)) != NULL
)
4536 attr
->value_tag
= IPP_TAG_DATE
;
4537 ippSetDate(job
->attrs
, &attr
, 0, ippTimeToDate(curtime
));
4540 if (!strcmp(name
, "time-at-completed"))
4542 job
->completed_time
= curtime
;
4544 if (JobHistory
< INT_MAX
&& attr
)
4545 job
->history_time
= attr
->values
[0].integer
+ JobHistory
;
4547 job
->history_time
= INT_MAX
;
4549 if (job
->history_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4550 JobHistoryUpdate
= job
->history_time
;
4552 if (JobFiles
< INT_MAX
&& attr
)
4553 job
->file_time
= attr
->values
[0].integer
+ JobFiles
;
4555 job
->file_time
= INT_MAX
;
4557 if (job
->file_time
< JobHistoryUpdate
|| !JobHistoryUpdate
)
4558 JobHistoryUpdate
= job
->file_time
;
4560 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "set_time: JobHistoryUpdate=%ld",
4561 (long)JobHistoryUpdate
);
4567 * 'start_job()' - Start a print job.
4571 start_job(cupsd_job_t
*job
, /* I - Job ID */
4572 cupsd_printer_t
*printer
) /* I - Printer to print job */
4574 const char *filename
; /* Support filename */
4575 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
4578 /* job-cancel-after attribute */
4581 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
4582 job
, job
->id
, printer
, printer
->name
);
4585 * Make sure we have some files around before we try to print...
4588 if (job
->num_files
== 0)
4590 ippSetString(job
->attrs
, &job
->reasons
, 0, "aborted-by-system");
4591 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
4592 "Aborting job because it has no files.");
4597 * Update the printer and job state to "processing"...
4600 if (!cupsdLoadJob(job
))
4603 if (!job
->printer_message
)
4604 job
->printer_message
= ippFindAttribute(job
->attrs
,
4605 "job-printer-state-message",
4607 if (job
->printer_message
)
4608 ippSetString(job
->attrs
, &job
->printer_message
, 0, "");
4610 ippSetString(job
->attrs
, &job
->reasons
, 0, "job-printing");
4611 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
4612 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
4613 cupsdSetPrinterReasons(printer
, "-cups-remote-pending,"
4614 "cups-remote-pending-held,"
4615 "cups-remote-processing,"
4616 "cups-remote-stopped,"
4617 "cups-remote-canceled,"
4618 "cups-remote-aborted,"
4619 "cups-remote-completed");
4622 job
->current_file
= 0;
4624 job
->history_time
= 0;
4626 job
->printer
= printer
;
4630 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
4631 else if (MaxJobTime
> 0)
4632 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4634 job
->cancel_time
= 0;
4637 * Check for support files...
4640 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
4641 "cups-insecure-filter-warning");
4645 for (filename
= (const char *)cupsArrayFirst(printer
->pc
->support_files
);
4647 filename
= (const char *)cupsArrayNext(printer
->pc
->support_files
))
4649 if (_cupsFileCheck(filename
, _CUPS_FILE_CHECK_FILE
, !RunUser
,
4650 cupsdLogFCMessage
, printer
))
4656 * Setup the last exit status and security profiles...
4660 job
->profile
= cupsdCreateProfile(job
->id
, 0);
4661 job
->bprofile
= cupsdCreateProfile(job
->id
, 1);
4664 * Create the status pipes and buffer...
4667 if (cupsdOpenPipe(job
->status_pipes
))
4669 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4670 "Unable to create job status pipes - %s.", strerror(errno
));
4672 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4673 "Job stopped because the scheduler could not create the "
4674 "job status pipes.");
4676 cupsdDestroyProfile(job
->profile
);
4677 job
->profile
= NULL
;
4678 cupsdDestroyProfile(job
->bprofile
);
4679 job
->bprofile
= NULL
;
4683 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
4684 job
->status_level
= CUPSD_LOG_INFO
;
4687 * Create the backchannel pipes and make them non-blocking...
4690 if (cupsdOpenPipe(job
->back_pipes
))
4692 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4693 "Unable to create back-channel pipes - %s.", strerror(errno
));
4695 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4696 "Job stopped because the scheduler could not create the "
4697 "back-channel pipes.");
4699 cupsdClosePipe(job
->status_pipes
);
4700 cupsdStatBufDelete(job
->status_buffer
);
4701 job
->status_buffer
= NULL
;
4703 cupsdDestroyProfile(job
->profile
);
4704 job
->profile
= NULL
;
4705 cupsdDestroyProfile(job
->bprofile
);
4706 job
->bprofile
= NULL
;
4710 fcntl(job
->back_pipes
[0], F_SETFL
,
4711 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4712 fcntl(job
->back_pipes
[1], F_SETFL
,
4713 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4716 * Create the side-channel pipes and make them non-blocking...
4719 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4721 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4722 "Unable to create side-channel pipes - %s.", strerror(errno
));
4724 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4725 "Job stopped because the scheduler could not create the "
4726 "side-channel pipes.");
4728 cupsdClosePipe(job
->back_pipes
);
4730 cupsdClosePipe(job
->status_pipes
);
4731 cupsdStatBufDelete(job
->status_buffer
);
4732 job
->status_buffer
= NULL
;
4734 cupsdDestroyProfile(job
->profile
);
4735 job
->profile
= NULL
;
4736 cupsdDestroyProfile(job
->bprofile
);
4737 job
->bprofile
= NULL
;
4741 fcntl(job
->side_pipes
[0], F_SETFL
,
4742 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4743 fcntl(job
->side_pipes
[1], F_SETFL
,
4744 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4746 fcntl(job
->side_pipes
[0], F_SETFD
,
4747 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4748 fcntl(job
->side_pipes
[1], F_SETFD
,
4749 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4752 * Now start the first file in the job...
4755 cupsdContinueJob(job
);
4760 * 'stop_job()' - Stop a print job.
4764 stop_job(cupsd_job_t
*job
, /* I - Job */
4765 cupsd_jobaction_t action
) /* I - Action */
4767 int i
; /* Looping var */
4770 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4773 FilterLevel
-= job
->cost
;
4776 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
&& job
->backend
> 0)
4777 job
->kill_time
= time(NULL
) + JobKillDelay
;
4778 else if (action
>= CUPSD_JOB_FORCE
)
4781 for (i
= 0; job
->filters
[i
]; i
++)
4782 if (job
->filters
[i
] > 0)
4784 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
4786 if (action
>= CUPSD_JOB_FORCE
)
4787 job
->filters
[i
] = -job
->filters
[i
];
4790 if (job
->backend
> 0)
4792 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
4794 if (action
>= CUPSD_JOB_FORCE
)
4795 job
->backend
= -job
->backend
;
4798 if (action
>= CUPSD_JOB_FORCE
)
4801 * Clear job status...
4810 * 'unload_job()' - Unload a job from memory.
4814 unload_job(cupsd_job_t
*job
) /* I - Job */
4819 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Unloading...");
4821 ippDelete(job
->attrs
);
4825 job
->reasons
= NULL
;
4826 job
->impressions
= NULL
;
4828 job
->job_sheets
= NULL
;
4829 job
->printer_message
= NULL
;
4830 job
->printer_reasons
= NULL
;
4835 * 'update_job()' - Read a status update from a job's filters.
4839 update_job(cupsd_job_t
*job
) /* I - Job to check */
4841 int i
; /* Looping var */
4842 int copies
; /* Number of copies printed */
4843 char message
[CUPSD_SB_BUFFER_SIZE
],
4845 *ptr
; /* Pointer update... */
4846 int loglevel
, /* Log level for message */
4847 event
= 0; /* Events? */
4848 cupsd_printer_t
*printer
= job
->printer
;
4850 static const char * const levels
[] = /* Log levels */
4866 * Get the printer associated with this job; if the printer is stopped for
4867 * any reason then job->printer will be reset to NULL, so make sure we have
4868 * a valid pointer...
4871 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
4872 message
, sizeof(message
))) != NULL
)
4875 * Process page and printer state messages as needed...
4878 if (loglevel
== CUPSD_LOG_PAGE
)
4881 * Page message; send the message to the page_log file and update the
4882 * job sheet count...
4885 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
4887 if (job
->impressions
)
4889 if (!_cups_strncasecmp(message
, "total ", 6))
4892 * Got a total count of pages from a backend or filter...
4895 copies
= atoi(message
+ 6);
4896 copies
-= ippGetInteger(job
->impressions
, 0); /* Just track the delta */
4898 else if (!sscanf(message
, "%*d%d", &copies
))
4901 ippSetInteger(job
->attrs
, &job
->impressions
, 0, ippGetInteger(job
->impressions
, 0) + copies
);
4903 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
4908 if (!_cups_strncasecmp(message
, "total ", 6))
4911 * Got a total count of pages from a backend or filter...
4914 copies
= atoi(message
+ 6);
4915 copies
-= ippGetInteger(job
->sheets
, 0); /* Just track the delta */
4917 else if (!sscanf(message
, "%*d%d", &copies
))
4920 ippSetInteger(job
->attrs
, &job
->sheets
, 0, ippGetInteger(job
->sheets
, 0) + copies
);
4922 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
4924 if (job
->printer
->page_limit
)
4925 cupsdUpdateQuota(job
->printer
, job
->username
, copies
, 0);
4928 cupsdLogPage(job
, message
);
4931 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
, "Printed %d page(s).", ippGetInteger(job
->sheets
, 0));
4933 else if (loglevel
== CUPSD_LOG_JOBSTATE
)
4936 * Support "keyword" to set job-state-reasons to the specified keyword.
4937 * This is sufficient for the current paid printing stuff.
4940 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "JOBSTATE: %s", message
);
4942 if (!strcmp(message
, "cups-retry-as-raster"))
4943 job
->retry_as_raster
= 1;
4945 ippSetString(job
->attrs
, &job
->reasons
, 0, message
);
4947 else if (loglevel
== CUPSD_LOG_STATE
)
4949 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
4951 if (!strcmp(message
, "paused"))
4953 cupsdStopPrinter(job
->printer
, 1);
4956 else if (message
[0] && cupsdSetPrinterReasons(job
->printer
, message
))
4958 event
|= CUPSD_EVENT_PRINTER_STATE
;
4963 * Reset cancel time after connecting to the device...
4966 for (i
= 0; i
< job
->printer
->num_reasons
; i
++)
4967 if (!strcmp(job
->printer
->reasons
[i
], "connecting-to-device"))
4970 if (i
>= job
->printer
->num_reasons
)
4972 ipp_attribute_t
*cancel_after
= ippFindAttribute(job
->attrs
,
4975 /* job-cancel-after attribute */
4978 job
->cancel_time
= time(NULL
) + ippGetInteger(cancel_after
, 0);
4980 job
->cancel_time
= time(NULL
) + MaxJobTime
;
4985 update_job_attrs(job
, 0);
4987 else if (loglevel
== CUPSD_LOG_ATTR
)
4990 * Set attribute(s)...
4993 int num_attrs
; /* Number of attributes */
4994 cups_option_t
*attrs
; /* Attributes */
4995 const char *attr
; /* Attribute */
4997 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
4999 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
5001 if ((attr
= cupsGetOption("auth-info-default", num_attrs
,
5004 job
->printer
->num_options
= cupsAddOption("auth-info", attr
,
5005 job
->printer
->num_options
,
5006 &(job
->printer
->options
));
5007 cupsdSetPrinterAttrs(job
->printer
);
5009 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5012 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
5015 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
5016 cupsdSetPrinterAttrs(job
->printer
);
5018 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5021 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
5024 int progress
= atoi(attr
);
5027 if (progress
>= 0 && progress
<= 100)
5029 job
->progress
= progress
;
5032 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5033 "Printing page %d, %d%%",
5034 job
->sheets
->values
[0].integer
, job
->progress
);
5038 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
5040 cupsdSetString(&job
->printer
->alert
, attr
);
5041 event
|= CUPSD_EVENT_PRINTER_STATE
;
5044 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
5047 cupsdSetString(&job
->printer
->alert_description
, attr
);
5048 event
|= CUPSD_EVENT_PRINTER_STATE
;
5051 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
5053 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
5054 job
->printer
->marker_time
= time(NULL
);
5055 event
|= CUPSD_EVENT_PRINTER_STATE
;
5056 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5059 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
5061 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
5062 job
->printer
->marker_time
= time(NULL
);
5063 event
|= CUPSD_EVENT_PRINTER_STATE
;
5064 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5067 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
5069 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
5070 job
->printer
->marker_time
= time(NULL
);
5071 event
|= CUPSD_EVENT_PRINTER_STATE
;
5072 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5075 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
5077 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
5078 job
->printer
->marker_time
= time(NULL
);
5079 event
|= CUPSD_EVENT_PRINTER_STATE
;
5080 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5083 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
5085 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
5086 job
->printer
->marker_time
= time(NULL
);
5087 event
|= CUPSD_EVENT_PRINTER_STATE
;
5088 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5091 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
5093 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
5094 job
->printer
->marker_time
= time(NULL
);
5095 event
|= CUPSD_EVENT_PRINTER_STATE
;
5096 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5099 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
5101 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
5102 job
->printer
->marker_time
= time(NULL
);
5103 event
|= CUPSD_EVENT_PRINTER_STATE
;
5104 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
5107 cupsFreeOptions(num_attrs
, attrs
);
5109 else if (loglevel
== CUPSD_LOG_PPD
)
5112 * Set attribute(s)...
5115 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
5117 job
->num_keywords
= cupsParseOptions(message
, job
->num_keywords
,
5123 * Strip legacy message prefix...
5126 if (!strncmp(message
, "recoverable:", 12))
5129 while (isspace(*ptr
& 255))
5132 else if (!strncmp(message
, "recovered:", 10))
5135 while (isspace(*ptr
& 255))
5142 cupsdLogJob(job
, loglevel
, "%s", ptr
);
5144 if (loglevel
< CUPSD_LOG_DEBUG
&&
5145 strcmp(job
->printer
->state_message
, ptr
))
5147 strlcpy(job
->printer
->state_message
, ptr
,
5148 sizeof(job
->printer
->state_message
));
5150 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
5152 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
5155 * Some messages show in the job-printer-state-message attribute...
5158 if (loglevel
!= CUPSD_LOG_NOTICE
)
5159 job
->status_level
= loglevel
;
5161 update_job_attrs(job
, 1);
5163 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
5164 "Set job-printer-state-message to \"%s\", "
5166 job
->printer_message
->values
[0].string
.text
,
5167 levels
[job
->status_level
]);
5172 if (!strchr(job
->status_buffer
->buffer
, '\n'))
5176 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
5177 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
5178 "%s", job
->printer
->state_message
);
5179 if (event
& CUPSD_EVENT_PRINTER_STATE
)
5180 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
5181 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
5182 "Class \"%s\" state changed." :
5183 "Printer \"%s\" state changed.",
5184 job
->printer
->name
);
5187 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
5190 * See if all of the filters and the backend have returned their
5194 for (i
= 0; job
->filters
[i
] < 0; i
++);
5196 if (job
->filters
[i
])
5199 * EOF but we haven't collected the exit status of all filters...
5202 cupsdCheckProcess();
5206 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
5209 * EOF but we haven't collected the exit status of the backend...
5212 cupsdCheckProcess();
5217 * Handle the end of job stuff...
5220 finalize_job(job
, 1);
5223 * Try printing another job...
5226 if (printer
->state
!= IPP_PRINTER_STOPPED
)
5233 * 'update_job_attrs()' - Update the job-printer-* attributes.
5237 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
5238 int do_message
)/* I - 1 = copy job-printer-state message */
5240 int i
; /* Looping var */
5241 int num_reasons
; /* Actual number of reasons */
5242 const char * const *reasons
; /* Reasons */
5243 static const char *none
= "none"; /* "none" reason */
5247 * Get/create the job-printer-state-* attributes...
5250 if (!job
->printer_message
)
5252 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
5253 "job-printer-state-message",
5254 IPP_TAG_TEXT
)) == NULL
)
5255 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
5256 "job-printer-state-message",
5260 if (!job
->printer_reasons
)
5261 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
5262 "job-printer-state-reasons",
5266 * Copy or clear the printer-state-message value as needed...
5269 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
5270 job
->status_level
== CUPSD_LOG_INFO
)
5272 ippSetString(job
->attrs
, &job
->printer_message
, 0, "");
5275 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5277 else if (job
->printer
->state_message
[0] && do_message
)
5279 ippSetString(job
->attrs
, &job
->printer_message
, 0, job
->printer
->state_message
);
5282 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
5286 * ... and the printer-state-reasons value...
5289 if (job
->printer
->num_reasons
== 0)
5296 num_reasons
= job
->printer
->num_reasons
;
5297 reasons
= (const char * const *)job
->printer
->reasons
;
5300 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
5303 * Replace/create a job-printer-state-reasons attribute...
5306 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
5308 job
->printer_reasons
= ippAddStrings(job
->attrs
,
5309 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
5310 "job-printer-state-reasons",
5311 num_reasons
, NULL
, NULL
);
5316 * Don't bother clearing the reason strings if they are the same...
5319 for (i
= 0; i
< num_reasons
; i
++)
5320 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
5323 if (i
>= num_reasons
)
5327 * Not the same, so free the current strings...
5330 for (i
= 0; i
< num_reasons
; i
++)
5331 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
5335 * Copy the reasons...
5338 for (i
= 0; i
< num_reasons
; i
++)
5339 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
5342 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);