2 * "$Id: job.c 7902 2008-09-03 14:20:17Z mike $"
4 * Job management routines for the CUPS scheduler.
6 * Copyright 2007-2011 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 * cupsdAddJob() - Add a new job to the job queue.
18 * cupsdCancelJobs() - Cancel all jobs for the given
20 * cupsdCheckJobs() - Check the pending jobs and start any if the
21 * destination is available.
22 * cupsdCleanJobs() - Clean out old jobs.
23 * cupsdContinueJob() - Continue printing with the next file in a job.
24 * cupsdDeleteJob() - Free all memory used by a job.
25 * cupsdFreeAllJobs() - Free all jobs from memory.
26 * cupsdFindJob() - Find the specified job.
27 * cupsdGetPrinterJobCount() - Get the number of pending, processing, or held
28 * jobs in a printer or class.
29 * cupsdGetUserJobCount() - Get the number of pending, processing, or held
31 * cupsdLoadAllJobs() - Load all jobs from disk.
32 * cupsdLoadJob() - Load a single job.
33 * cupsdMoveJob() - Move the specified job to a different
35 * cupsdReleaseJob() - Release the specified job.
36 * cupsdRestartJob() - Restart the specified job.
37 * cupsdSaveAllJobs() - Save a summary of all jobs to disk.
38 * cupsdSaveJob() - Save a job to disk.
39 * cupsdSetJobHoldUntil() - Set the hold time for a job.
40 * cupsdSetJobPriority() - Set the priority of a job, moving it up/down
41 * in the list as needed.
42 * cupsdSetJobState() - Set the state of the specified print job.
43 * cupsdStopAllJobs() - Stop all print jobs.
44 * cupsdUnloadCompletedJobs() - Flush completed job history from memory.
45 * compare_active_jobs() - Compare the job IDs and priorities of two
47 * compare_jobs() - Compare the job IDs of two jobs.
48 * dump_job_history() - Dump any debug messages for a job.
49 * free_job_history() - Free any log history.
50 * finalize_job() - Cleanup after job filter processes and support
52 * get_options() - Get a string containing the job options.
53 * ipp_length() - Compute the size of the buffer needed to hold
54 * the textual IPP attributes.
55 * load_job_cache() - Load jobs from the job.cache file.
56 * load_next_job_id() - Load the NextJobId value from the job.cache
58 * load_request_root() - Load jobs from the RequestRoot directory.
59 * set_time() - Set one of the "time-at-xyz" attributes.
60 * start_job() - Start a print job.
61 * stop_job() - Stop a print job.
62 * unload_job() - Unload a job from memory.
63 * update_job() - Read a status update from a job's filters.
64 * update_job_attrs() - Update the job-printer-* attributes.
68 * Include necessary headers...
73 #include <cups/backend.h>
78 * Design Notes for Job Management
79 * -------------------------------
83 * pending Do nothing/check jobs
84 * pending-held Send SIGTERM to filters and backend
85 * processing Do nothing/start job
86 * stopped Send SIGKILL to filters and backend
87 * canceled Send SIGTERM to filters and backend
91 * Finalize clears the printer <-> job association, deletes the status
92 * buffer, closes all of the pipes, etc. and doesn't get run until all of
93 * the print processes are finished.
95 * UNLOADING OF JOBS (cupsdUnloadCompletedJobs)
97 * We unload the job attributes when they are not needed to reduce overall
98 * memory consumption. We don't unload jobs where job->state_value <
99 * IPP_JOB_STOPPED, job->printer != NULL, or job->access_time is recent.
101 * STARTING OF JOBS (start_job)
103 * When a job is started, a status buffer, several pipes, a security
104 * profile, and a backend process are created for the life of that job.
105 * These are shared for every file in a job. For remote print jobs, the
106 * IPP backend is provided with every file in the job and no filters are
109 * The job->printer member tracks which printer is printing a job, which
110 * can be different than the destination in job->dest for classes. The
111 * printer object also has a job pointer to track which job is being
114 * PRINTING OF JOB FILES (cupsdContinueJob)
116 * Each file in a job is filtered by 0 or more programs. After getting the
117 * list of filters needed and the total cost, the job is either passed or
118 * put back to the processing state until the current FilterLevel comes down
119 * enough to allow printing.
121 * If we can print, we build a string for the print options and run each of
122 * the filters, piping the output from one into the next.
124 * JOB STATUS UPDATES (update_job)
126 * The update_job function gets called whenever there are pending messages
127 * on the status pipe. These generally are updates to the marker-*,
128 * printer-state-message, or printer-state-reasons attributes. On EOF,
129 * finalize_job is called to clean up.
131 * FINALIZING JOBS (finalize_job)
133 * When all filters and the backend are done, we set the job state to
134 * completed (no errors), aborted (filter errors or abort-job policy),
135 * pending-held (auth required or retry-job policy), or pending
136 * (retry-current-job or stop-printer policies) as appropriate.
138 * Then we close the pipes and free the status buffers and profiles.
140 * JOB FILE COMPLETION (process_children in main.c)
142 * For multiple-file jobs, process_children (in main.c) sees that all
143 * filters have exited and calls in to print the next file if there are
144 * more files in the job, otherwise it waits for the backend to exit and
145 * update_job to do the cleanup.
153 static mime_filter_t gziptoany_filter
=
155 NULL
, /* Source type */
156 NULL
, /* Destination type */
158 "gziptoany" /* Filter program to run */
166 static int compare_active_jobs(void *first
, void *second
, void *data
);
167 static int compare_jobs(void *first
, void *second
, void *data
);
168 static void dump_job_history(cupsd_job_t
*job
);
169 static void finalize_job(cupsd_job_t
*job
, int set_job_state
);
170 static void free_job_history(cupsd_job_t
*job
);
171 static char *get_options(cupsd_job_t
*job
, int banner_page
, char *copies
,
172 size_t copies_size
, char *title
,
174 static size_t ipp_length(ipp_t
*ipp
);
175 static void load_job_cache(const char *filename
);
176 static void load_next_job_id(const char *filename
);
177 static void load_request_root(void);
178 static void set_time(cupsd_job_t
*job
, const char *name
);
179 static void start_job(cupsd_job_t
*job
, cupsd_printer_t
*printer
);
180 static void stop_job(cupsd_job_t
*job
, cupsd_jobaction_t action
);
181 static void unload_job(cupsd_job_t
*job
);
182 static void update_job(cupsd_job_t
*job
);
183 static void update_job_attrs(cupsd_job_t
*job
, int do_message
);
187 * 'cupsdAddJob()' - Add a new job to the job queue.
190 cupsd_job_t
* /* O - New job record */
191 cupsdAddJob(int priority
, /* I - Job priority */
192 const char *dest
) /* I - Job destination */
194 cupsd_job_t
*job
; /* New job record */
197 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
200 job
->id
= NextJobId
++;
201 job
->priority
= priority
;
202 job
->back_pipes
[0] = -1;
203 job
->back_pipes
[1] = -1;
204 job
->print_pipes
[0] = -1;
205 job
->print_pipes
[1] = -1;
206 job
->side_pipes
[0] = -1;
207 job
->side_pipes
[1] = -1;
208 job
->status_pipes
[0] = -1;
209 job
->status_pipes
[1] = -1;
211 cupsdSetString(&job
->dest
, dest
);
214 * Add the new job to the "all jobs" and "active jobs" lists...
217 cupsArrayAdd(Jobs
, job
);
218 cupsArrayAdd(ActiveJobs
, job
);
225 * 'cupsdCancelJobs()' - Cancel all jobs for the given destination/user.
229 cupsdCancelJobs(const char *dest
, /* I - Destination to cancel */
230 const char *username
, /* I - Username or NULL */
231 int purge
) /* I - Purge jobs? */
233 cupsd_job_t
*job
; /* Current job */
236 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
238 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
240 if ((!job
->dest
|| !job
->username
) && !cupsdLoadJob(job
))
243 if ((!dest
|| !strcmp(job
->dest
, dest
)) &&
244 (!username
|| !strcmp(job
->username
, username
)))
247 * Cancel all jobs matching this destination/user...
251 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_PURGE
,
252 "Job purged by user.");
253 else if (job
->state_value
< IPP_JOB_CANCELED
)
254 cupsdSetJobState(job
, IPP_JOB_CANCELED
, CUPSD_JOB_DEFAULT
,
255 "Job canceled by user.");
264 * 'cupsdCheckJobs()' - Check the pending jobs and start any if the destination
271 cupsd_job_t
*job
; /* Current job in queue */
272 cupsd_printer_t
*printer
, /* Printer destination */
273 *pclass
; /* Printer class destination */
274 ipp_attribute_t
*attr
; /* Job attribute */
275 time_t curtime
; /* Current time */
278 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
279 "cupsdCheckJobs: %d active jobs, sleeping=%d, reload=%d",
280 cupsArrayCount(ActiveJobs
), Sleeping
, NeedReload
);
282 curtime
= time(NULL
);
284 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
);
286 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
289 * Kill jobs if they are unresponsive...
292 if (job
->kill_time
&& job
->kill_time
<= curtime
)
294 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Stopping unresponsive job!",
297 stop_job(job
, CUPSD_JOB_FORCE
);
302 * Start held jobs if they are ready...
305 if (job
->state_value
== IPP_JOB_HELD
&&
307 job
->hold_until
< curtime
)
309 if (job
->pending_timeout
)
312 * This job is pending; check that we don't have an active Send-Document
313 * operation in progress on any of the client connections, then timeout
314 * the job so we can start printing...
317 cupsd_client_t
*con
; /* Current client connection */
320 for (con
= (cupsd_client_t
*)cupsArrayFirst(Clients
);
322 con
= (cupsd_client_t
*)cupsArrayNext(Clients
))
324 con
->request
->request
.op
.operation_id
== IPP_SEND_DOCUMENT
)
330 if (cupsdTimeoutJob(job
))
334 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
335 "Job submission timed out.");
339 * Continue jobs that are waiting on the FilterLimit...
342 if (job
->pending_cost
> 0 &&
343 ((FilterLevel
+ job
->pending_cost
) < FilterLimit
|| FilterLevel
== 0))
344 cupsdContinueJob(job
);
347 * Start pending jobs if the destination is available...
350 if (job
->state_value
== IPP_JOB_PENDING
&& !NeedReload
&& !Sleeping
&&
351 !DoingShutdown
&& !job
->printer
)
353 printer
= cupsdFindDest(job
->dest
);
357 (printer
->type
& (CUPS_PRINTER_IMPLICIT
| CUPS_PRINTER_CLASS
)))
360 * If the class is remote, just pass it to the remote server...
365 if (pclass
->state
== IPP_PRINTER_STOPPED
)
367 else if (pclass
->type
& CUPS_PRINTER_REMOTE
)
370 printer
= cupsdFindAvailablePrinter(printer
->name
);
373 if (!printer
&& !pclass
)
376 * Whoa, the printer and/or class for this destination went away;
380 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_PURGE
,
381 "Job aborted because the destination printer/class "
384 else if (printer
&& !printer
->holding_new_jobs
)
387 * See if the printer is available or remote and not printing a job;
388 * if so, start the job...
394 * Add/update a job-actual-printer-uri attribute for this job
395 * so that we know which printer actually printed the job...
398 if ((attr
= ippFindAttribute(job
->attrs
, "job-actual-printer-uri",
399 IPP_TAG_URI
)) != NULL
)
400 cupsdSetString(&attr
->values
[0].string
.text
, printer
->uri
);
402 ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_URI
,
403 "job-actual-printer-uri", NULL
, printer
->uri
);
406 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
409 if ((!(printer
->type
& CUPS_PRINTER_DISCOVERED
) && /* Printer is local */
410 printer
->state
== IPP_PRINTER_IDLE
) || /* and idle, OR */
411 ((printer
->type
& CUPS_PRINTER_DISCOVERED
) && /* Printer is remote */
412 !printer
->job
)) /* and not printing */
418 start_job(job
, printer
);
427 * 'cupsdCleanJobs()' - Clean out old jobs.
433 cupsd_job_t
*job
; /* Current job */
436 if (MaxJobs
<= 0 && JobHistory
)
439 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
440 job
&& (cupsArrayCount(Jobs
) >= MaxJobs
|| !JobHistory
);
441 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
442 if (job
->state_value
>= IPP_JOB_CANCELED
&& !job
->printer
)
443 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
448 * 'cupsdContinueJob()' - Continue printing with the next file in a job.
452 cupsdContinueJob(cupsd_job_t
*job
) /* I - Job */
454 int i
; /* Looping var */
455 int slot
; /* Pipe slot */
456 cups_array_t
*filters
= NULL
,/* Filters for job */
457 *prefilters
; /* Filters with prefilters */
458 mime_filter_t
*filter
, /* Current filter */
459 *prefilter
, /* Prefilter */
460 port_monitor
; /* Port monitor filter */
461 char scheme
[255]; /* Device URI scheme */
462 ipp_attribute_t
*attr
; /* Current attribute */
463 const char *ptr
, /* Pointer into value */
464 *abort_message
; /* Abort message */
465 ipp_jstate_t abort_state
= IPP_JOB_STOPPED
;
466 /* New job state on abort */
467 struct stat backinfo
; /* Backend file information */
468 int backroot
; /* Run backend as root? */
469 int pid
; /* Process ID of new filter process */
470 int banner_page
; /* 1 if banner page, 0 otherwise */
471 int filterfds
[2][2] = { { -1, -1 }, { -1, -1 } };
472 /* Pipes used between filters */
473 int envc
; /* Number of environment variables */
474 char **argv
= NULL
, /* Filter command-line arguments */
475 filename
[1024], /* Job filename */
476 command
[1024], /* Full path to command */
477 jobid
[255], /* Job ID string */
479 /* Job title string */
480 copies
[255], /* # copies string */
481 *options
, /* Options string */
483 /* Environment variables */
484 charset
[255], /* CHARSET env variable */
485 class_name
[255],/* CLASS env variable */
486 classification
[1024],
487 /* CLASSIFICATION env variable */
489 /* CONTENT_TYPE env variable */
491 /* DEVICE_URI env variable */
492 final_content_type
[1024],
493 /* FINAL_CONTENT_TYPE env variable */
494 lang
[255], /* LANG env variable */
497 /* APPLE_LANGUAGE env variable */
498 #endif /* __APPLE__ */
499 ppd
[1024], /* PPD env variable */
501 /* PRINTER_INFO env variable */
502 printer_location
[255],
503 /* PRINTER_LOCATION env variable */
505 /* PRINTER env variable */
507 /* RIP_MAX_CACHE env variable */
510 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
511 "cupsdContinueJob(job=%p(%d)): current_file=%d, num_files=%d",
512 job
, job
->id
, job
->current_file
, job
->num_files
);
515 * Figure out what filters are required to convert from
516 * the source to the destination type...
519 FilterLevel
-= job
->cost
;
522 job
->pending_cost
= 0;
524 memset(job
->filters
, 0, sizeof(job
->filters
));
527 if (job
->printer
->raw
)
530 * Remote jobs and raw queues go directly to the printer without
534 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "Sending job to queue tagged as raw...");
539 * Local jobs get filtered...
542 filters
= mimeFilter(MimeDatabase
, job
->filetypes
[job
->current_file
],
543 job
->printer
->filetype
, &(job
->cost
));
547 cupsdLogJob(job
, CUPSD_LOG_ERROR
,
548 "Unable to convert file %d to printable format!",
551 abort_message
= "Aborting job because it cannot be printed.";
552 abort_state
= IPP_JOB_ABORTED
;
558 * Remove NULL ("-") filters...
561 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
563 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
564 if (!strcmp(filter
->filter
, "-"))
565 cupsArrayRemove(filters
, filter
);
567 if (cupsArrayCount(filters
) == 0)
569 cupsArrayDelete(filters
);
574 * If this printer has any pre-filters, insert the required pre-filter
575 * in the filters array...
578 if (job
->printer
->prefiltertype
&& filters
)
580 prefilters
= cupsArrayNew(NULL
, NULL
);
582 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
584 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
586 if ((prefilter
= mimeFilterLookup(MimeDatabase
, filter
->src
,
587 job
->printer
->prefiltertype
)))
589 cupsArrayAdd(prefilters
, prefilter
);
590 job
->cost
+= prefilter
->cost
;
593 cupsArrayAdd(prefilters
, filter
);
596 cupsArrayDelete(filters
);
597 filters
= prefilters
;
602 * Set a minimum cost of 100 for all jobs so that FilterLimit
603 * works with raw queues and other low-cost paths.
610 * See if the filter cost is too high...
613 if ((FilterLevel
+ job
->cost
) > FilterLimit
&& FilterLevel
> 0 &&
617 * Don't print this job quite yet...
620 cupsArrayDelete(filters
);
622 cupsdLogJob(job
, CUPSD_LOG_INFO
,
623 "Holding because filter limit has been reached.");
624 cupsdLogJob(job
, CUPSD_LOG_DEBUG2
,
625 "cupsdContinueJob: file=%d, cost=%d, level=%d, limit=%d",
626 job
->current_file
, job
->cost
, FilterLevel
,
629 job
->pending_cost
= job
->cost
;
634 FilterLevel
+= job
->cost
;
637 * Add decompression/raw filter as needed...
640 if ((!job
->printer
->raw
&& job
->compressions
[job
->current_file
]) ||
641 (!filters
&& !job
->printer
->remote
&&
642 (job
->num_files
> 1 || !strncmp(job
->printer
->device_uri
, "file:", 5))))
645 * Add gziptoany filter to the front of the list...
649 filters
= cupsArrayNew(NULL
, NULL
);
651 if (!cupsArrayInsert(filters
, &gziptoany_filter
))
653 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
654 "Unable to add decompression filter - %s", strerror(errno
));
656 cupsArrayDelete(filters
);
658 abort_message
= "Stopping job because the scheduler ran out of memory.";
665 * Add port monitor, if any...
668 if (job
->printer
->port_monitor
)
671 * Add port monitor to the end of the list...
675 filters
= cupsArrayNew(NULL
, NULL
);
677 port_monitor
.src
= NULL
;
678 port_monitor
.dst
= NULL
;
679 port_monitor
.cost
= 0;
681 snprintf(port_monitor
.filter
, sizeof(port_monitor
.filter
),
682 "%s/monitor/%s", ServerBin
, job
->printer
->port_monitor
);
684 if (!cupsArrayAdd(filters
, &port_monitor
))
686 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
687 "Unable to add port monitor - %s", strerror(errno
));
689 abort_message
= "Stopping job because the scheduler ran out of memory.";
696 * Make sure we don't go over the "MAX_FILTERS" limit...
699 if (cupsArrayCount(filters
) > MAX_FILTERS
)
701 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
702 "Too many filters (%d > %d), unable to print!",
703 cupsArrayCount(filters
), MAX_FILTERS
);
705 abort_message
= "Aborting job because it needs too many filters to print.";
706 abort_state
= IPP_JOB_ABORTED
;
712 * Determine if we are printing a banner page or not...
715 if (job
->job_sheets
== NULL
)
717 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "No job-sheets attribute.");
718 if ((job
->job_sheets
=
719 ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_ZERO
)) != NULL
)
720 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
721 "... but someone added one without setting job_sheets!");
723 else if (job
->job_sheets
->num_values
== 1)
724 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s",
725 job
->job_sheets
->values
[0].string
.text
);
727 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "job-sheets=%s,%s",
728 job
->job_sheets
->values
[0].string
.text
,
729 job
->job_sheets
->values
[1].string
.text
);
731 if (job
->printer
->type
& (CUPS_PRINTER_REMOTE
| CUPS_PRINTER_IMPLICIT
))
733 else if (job
->job_sheets
== NULL
)
735 else if (strcasecmp(job
->job_sheets
->values
[0].string
.text
, "none") != 0 &&
736 job
->current_file
== 0)
738 else if (job
->job_sheets
->num_values
> 1 &&
739 strcasecmp(job
->job_sheets
->values
[1].string
.text
, "none") != 0 &&
740 job
->current_file
== (job
->num_files
- 1))
745 if ((options
= get_options(job
, banner_page
, copies
, sizeof(copies
), title
,
746 sizeof(title
))) == NULL
)
748 abort_message
= "Stopping job because the scheduler ran out of memory.";
754 * Build the command-line arguments for the filters. Each filter
755 * has 6 or 7 arguments:
763 * argv[6] = filename (optional; normally stdin)
765 * This allows legacy printer drivers that use the old System V
766 * printing interface to be used by CUPS.
768 * For remote jobs, we send all of the files in the argument list.
771 if (job
->printer
->remote
)
772 argv
= calloc(7 + job
->num_files
, sizeof(char *));
774 argv
= calloc(8, sizeof(char *));
778 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Unable to allocate argument array - %s",
781 abort_message
= "Stopping job because the scheduler ran out of memory.";
786 sprintf(jobid
, "%d", job
->id
);
788 argv
[0] = job
->printer
->name
;
790 argv
[2] = job
->username
;
795 if (job
->printer
->remote
&& job
->num_files
> 1)
797 for (i
= 0; i
< job
->num_files
; i
++)
799 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
801 argv
[6 + i
] = strdup(filename
);
806 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
807 job
->id
, job
->current_file
+ 1);
811 for (i
= 0; argv
[i
]; i
++)
812 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "argv[%d]=\"%s\"", i
, argv
[i
]);
815 * Create environment variable strings for the filters...
818 attr
= ippFindAttribute(job
->attrs
, "attributes-natural-language",
822 strcpy(apple_language
, "APPLE_LANGUAGE=");
823 _cupsAppleLanguage(attr
->values
[0].string
.text
,
824 apple_language
+ 15, sizeof(apple_language
) - 15);
825 #endif /* __APPLE__ */
827 switch (strlen(attr
->values
[0].string
.text
))
831 * This is an unknown or badly formatted language code; use
832 * the POSIX locale...
835 strcpy(lang
, "LANG=C");
840 * Just the language code (ll)...
843 snprintf(lang
, sizeof(lang
), "LANG=%s.UTF-8",
844 attr
->values
[0].string
.text
);
849 * Language and country code (ll-cc)...
852 snprintf(lang
, sizeof(lang
), "LANG=%c%c_%c%c.UTF-8",
853 attr
->values
[0].string
.text
[0],
854 attr
->values
[0].string
.text
[1],
855 toupper(attr
->values
[0].string
.text
[3] & 255),
856 toupper(attr
->values
[0].string
.text
[4] & 255));
860 if ((attr
= ippFindAttribute(job
->attrs
, "document-format",
861 IPP_TAG_MIMETYPE
)) != NULL
&&
862 (ptr
= strstr(attr
->values
[0].string
.text
, "charset=")) != NULL
)
863 snprintf(charset
, sizeof(charset
), "CHARSET=%s", ptr
+ 8);
865 strlcpy(charset
, "CHARSET=utf-8", sizeof(charset
));
867 snprintf(content_type
, sizeof(content_type
), "CONTENT_TYPE=%s/%s",
868 job
->filetypes
[job
->current_file
]->super
,
869 job
->filetypes
[job
->current_file
]->type
);
870 snprintf(device_uri
, sizeof(device_uri
), "DEVICE_URI=%s",
871 job
->printer
->device_uri
);
872 snprintf(ppd
, sizeof(ppd
), "PPD=%s/ppd/%s.ppd", ServerRoot
,
874 snprintf(printer_info
, sizeof(printer_name
), "PRINTER_INFO=%s",
875 job
->printer
->info
? job
->printer
->info
: "");
876 snprintf(printer_location
, sizeof(printer_name
), "PRINTER_LOCATION=%s",
877 job
->printer
->location
? job
->printer
->location
: "");
878 snprintf(printer_name
, sizeof(printer_name
), "PRINTER=%s", job
->printer
->name
);
879 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
881 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
883 envp
[envc
++] = charset
;
884 envp
[envc
++] = lang
;
886 envp
[envc
++] = apple_language
;
887 #endif /* __APPLE__ */
889 envp
[envc
++] = rip_max_cache
;
890 envp
[envc
++] = content_type
;
891 envp
[envc
++] = device_uri
;
892 envp
[envc
++] = printer_info
;
893 envp
[envc
++] = printer_location
;
894 envp
[envc
++] = printer_name
;
895 envp
[envc
++] = banner_page
? "CUPS_FILETYPE=job-sheet" :
896 "CUPS_FILETYPE=document";
898 if (!job
->printer
->remote
&& !job
->printer
->raw
)
900 filter
= (mime_filter_t
*)cupsArrayLast(filters
);
902 if (job
->printer
->port_monitor
)
903 filter
= (mime_filter_t
*)cupsArrayPrev(filters
);
905 if (filter
&& filter
->dst
)
907 if ((ptr
= strchr(filter
->dst
->type
, '/')) != NULL
)
908 snprintf(final_content_type
, sizeof(final_content_type
),
909 "FINAL_CONTENT_TYPE=%s", ptr
+ 1);
911 snprintf(final_content_type
, sizeof(final_content_type
),
912 "FINAL_CONTENT_TYPE=%s/%s", filter
->dst
->super
,
914 envp
[envc
++] = final_content_type
;
918 if (Classification
&& !banner_page
)
920 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
921 IPP_TAG_NAME
)) == NULL
)
922 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
924 else if (attr
->num_values
> 1 &&
925 strcmp(attr
->values
[1].string
.text
, "none") != 0)
926 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
927 attr
->values
[1].string
.text
);
929 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
930 attr
->values
[0].string
.text
);
932 envp
[envc
++] = classification
;
935 if (job
->dtype
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_IMPLICIT
))
937 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
938 envp
[envc
++] = class_name
;
941 if (job
->auth_username
)
942 envp
[envc
++] = job
->auth_username
;
943 if (job
->auth_domain
)
944 envp
[envc
++] = job
->auth_domain
;
945 if (job
->auth_password
)
946 envp
[envc
++] = job
->auth_password
;
950 envp
[envc
++] = job
->ccname
;
951 #endif /* HAVE_GSSAPI */
955 for (i
= 0; i
< envc
; i
++)
956 if (!strncmp(envp
[i
], "AUTH_", 5))
957 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"AUTH_%c****\"", i
,
959 else if (strncmp(envp
[i
], "DEVICE_URI=", 11))
960 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"%s\"", i
, envp
[i
]);
962 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "envp[%d]=\"DEVICE_URI=%s\"", i
,
963 job
->printer
->sanitized_device_uri
);
965 if (job
->printer
->remote
)
966 job
->current_file
= job
->num_files
;
968 job
->current_file
++;
971 * Now create processes for all of the filters...
974 cupsdSetPrinterReasons(job
->printer
, "-cups-missing-filter-warning,"
975 "cups-insecure-filter-warning");
977 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
979 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
981 if (filter
->filter
[0] != '/')
982 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
985 strlcpy(command
, filter
->filter
, sizeof(command
));
987 if (i
< (cupsArrayCount(filters
) - 1))
989 if (cupsdOpenPipe(filterfds
[slot
]))
991 abort_message
= "Stopping job because the scheduler could not create "
999 if (job
->current_file
== 1 ||
1000 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1002 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1004 if (cupsdOpenPipe(job
->print_pipes
))
1006 abort_message
= "Stopping job because the scheduler could not "
1007 "create the backend pipes.";
1014 job
->print_pipes
[0] = -1;
1015 if (!strcmp(job
->printer
->device_uri
, "file:/dev/null") ||
1016 !strcmp(job
->printer
->device_uri
, "file:///dev/null"))
1017 job
->print_pipes
[1] = -1;
1020 if (!strncmp(job
->printer
->device_uri
, "file:/dev/", 10))
1021 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1023 else if (!strncmp(job
->printer
->device_uri
, "file:///dev/", 12))
1024 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1026 else if (!strncmp(job
->printer
->device_uri
, "file:///", 8))
1027 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 7,
1028 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1030 job
->print_pipes
[1] = open(job
->printer
->device_uri
+ 5,
1031 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
1033 if (job
->print_pipes
[1] < 0)
1035 abort_message
= "Stopping job because the scheduler could not "
1036 "open the output file.";
1041 fcntl(job
->print_pipes
[1], F_SETFD
,
1042 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
1047 filterfds
[slot
][0] = job
->print_pipes
[0];
1048 filterfds
[slot
][1] = job
->print_pipes
[1];
1051 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1052 filterfds
[slot
][1], job
->status_pipes
[1],
1053 job
->back_pipes
[0], job
->side_pipes
[0], 0,
1054 job
->profile
, job
, job
->filters
+ i
);
1056 cupsdClosePipe(filterfds
[!slot
]);
1060 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
1061 filter
->filter
, strerror(errno
));
1063 abort_message
= "Stopping job because the scheduler could not execute a "
1069 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started filter %s (PID %d)", command
,
1076 cupsArrayDelete(filters
);
1080 * Finally, pipe the final output into a backend process if needed...
1083 if (strncmp(job
->printer
->device_uri
, "file:", 5) != 0)
1085 if (job
->current_file
== 1 || job
->printer
->remote
||
1086 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1088 sscanf(job
->printer
->device_uri
, "%254[^:]", scheme
);
1089 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, scheme
);
1092 * See if the backend needs to run as root...
1097 else if (stat(command
, &backinfo
))
1100 backroot
= !(backinfo
.st_mode
& (S_IRWXG
| S_IRWXO
));
1102 argv
[0] = job
->printer
->sanitized_device_uri
;
1104 filterfds
[slot
][0] = -1;
1105 filterfds
[slot
][1] = -1;
1107 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
1108 filterfds
[slot
][1], job
->status_pipes
[1],
1109 job
->back_pipes
[1], job
->side_pipes
[1],
1110 backroot
, job
->profile
, job
, &(job
->backend
));
1114 abort_message
= "Stopping job because the sheduler could not execute "
1121 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Started backend %s (PID %d)",
1126 if (job
->current_file
== job
->num_files
||
1127 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1128 cupsdClosePipe(job
->print_pipes
);
1130 if (job
->current_file
== job
->num_files
)
1132 cupsdClosePipe(job
->back_pipes
);
1133 cupsdClosePipe(job
->side_pipes
);
1135 close(job
->status_pipes
[1]);
1136 job
->status_pipes
[1] = -1;
1141 filterfds
[slot
][0] = -1;
1142 filterfds
[slot
][1] = -1;
1144 if (job
->current_file
== job
->num_files
||
1145 (job
->printer
->pc
&& job
->printer
->pc
->single_file
))
1146 cupsdClosePipe(job
->print_pipes
);
1148 if (job
->current_file
== job
->num_files
)
1150 close(job
->status_pipes
[1]);
1151 job
->status_pipes
[1] = -1;
1155 cupsdClosePipe(filterfds
[slot
]);
1157 if (job
->printer
->remote
&& job
->num_files
> 1)
1159 for (i
= 0; i
< job
->num_files
; i
++)
1165 cupsdAddSelect(job
->status_buffer
->fd
, (cupsd_selfunc_t
)update_job
, NULL
,
1168 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
1175 * If we get here, we need to abort the current job and close out all
1176 * files and pipes...
1181 FilterLevel
-= job
->cost
;
1184 for (slot
= 0; slot
< 2; slot
++)
1185 cupsdClosePipe(filterfds
[slot
]);
1187 cupsArrayDelete(filters
);
1191 if (job
->printer
->remote
&& job
->num_files
> 1)
1193 for (i
= 0; i
< job
->num_files
; i
++)
1200 cupsdClosePipe(job
->print_pipes
);
1201 cupsdClosePipe(job
->back_pipes
);
1202 cupsdClosePipe(job
->side_pipes
);
1204 cupsdRemoveSelect(job
->status_pipes
[0]);
1205 cupsdClosePipe(job
->status_pipes
);
1206 cupsdStatBufDelete(job
->status_buffer
);
1207 job
->status_buffer
= NULL
;
1210 * Update the printer and job state.
1213 cupsdSetJobState(job
, abort_state
, CUPSD_JOB_DEFAULT
, "%s", abort_message
);
1214 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_IDLE
, 0);
1215 update_job_attrs(job
, 0);
1218 free_job_history(job
);
1220 cupsArrayRemove(PrintingJobs
, job
);
1223 * Clear the printer <-> job association...
1226 job
->printer
->job
= NULL
;
1227 job
->printer
= NULL
;
1232 * 'cupsdDeleteJob()' - Free all memory used by a job.
1236 cupsdDeleteJob(cupsd_job_t
*job
, /* I - Job */
1237 cupsd_jobaction_t action
)/* I - Action */
1240 finalize_job(job
, 1);
1242 if (action
== CUPSD_JOB_PURGE
)
1245 * Remove the job info file...
1248 char filename
[1024]; /* Job filename */
1250 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
1255 cupsdClearString(&job
->username
);
1256 cupsdClearString(&job
->dest
);
1257 cupsdClearString(&job
->auth_username
);
1258 cupsdClearString(&job
->auth_domain
);
1259 cupsdClearString(&job
->auth_password
);
1263 * Destroy the credential cache and clear the KRB5CCNAME env var string.
1268 krb5_cc_destroy(KerberosContext
, job
->ccache
);
1272 cupsdClearString(&job
->ccname
);
1273 #endif /* HAVE_GSSAPI */
1275 if (job
->num_files
> 0)
1277 free(job
->compressions
);
1278 free(job
->filetypes
);
1284 free_job_history(job
);
1288 cupsArrayRemove(Jobs
, job
);
1289 cupsArrayRemove(ActiveJobs
, job
);
1290 cupsArrayRemove(PrintingJobs
, job
);
1297 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1301 cupsdFreeAllJobs(void)
1303 cupsd_job_t
*job
; /* Current job */
1311 cupsdStopAllJobs(CUPSD_JOB_FORCE
, 0);
1314 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1316 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1317 cupsdDeleteJob(job
, CUPSD_JOB_DEFAULT
);
1319 cupsdReleaseSignals();
1324 * 'cupsdFindJob()' - Find the specified job.
1327 cupsd_job_t
* /* O - Job data */
1328 cupsdFindJob(int id
) /* I - Job ID */
1330 cupsd_job_t key
; /* Search key */
1335 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
1340 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1341 * or held jobs in a printer or class.
1344 int /* O - Job count */
1345 cupsdGetPrinterJobCount(
1346 const char *dest
) /* I - Printer or class name */
1348 int count
; /* Job count */
1349 cupsd_job_t
*job
; /* Current job */
1352 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1354 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1355 if (job
->dest
&& !strcasecmp(job
->dest
, dest
))
1363 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1364 * or held jobs for a user.
1367 int /* O - Job count */
1368 cupsdGetUserJobCount(
1369 const char *username
) /* I - Username */
1371 int count
; /* Job count */
1372 cupsd_job_t
*job
; /* Current job */
1375 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
1377 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1378 if (!strcasecmp(job
->username
, username
))
1386 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1390 cupsdLoadAllJobs(void)
1392 char filename
[1024]; /* Full filename of job.cache file */
1393 struct stat fileinfo
, /* Information on job.cache file */
1394 dirinfo
; /* Information on RequestRoot dir */
1399 * Create the job arrays as needed...
1403 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
1406 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
1409 PrintingJobs
= cupsArrayNew(compare_jobs
, NULL
);
1412 * See whether the job.cache file is older than the RequestRoot directory...
1415 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
1417 if (stat(filename
, &fileinfo
))
1419 fileinfo
.st_mtime
= 0;
1421 if (errno
!= ENOENT
)
1422 cupsdLogMessage(CUPSD_LOG_ERROR
,
1423 "Unable to get file information for \"%s\" - %s",
1424 filename
, strerror(errno
));
1427 if (stat(RequestRoot
, &dirinfo
))
1429 dirinfo
.st_mtime
= 0;
1431 if (errno
!= ENOENT
)
1432 cupsdLogMessage(CUPSD_LOG_ERROR
,
1433 "Unable to get directory information for \"%s\" - %s",
1434 RequestRoot
, strerror(errno
));
1438 * Load the most recent source for job data...
1441 if (dirinfo
.st_mtime
> fileinfo
.st_mtime
)
1443 load_request_root();
1445 load_next_job_id(filename
);
1448 load_job_cache(filename
);
1451 * Clean out old jobs as needed...
1454 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
1460 * 'cupsdLoadJob()' - Load a single job.
1463 int /* O - 1 on success, 0 on failure */
1464 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
1466 char jobfile
[1024]; /* Job filename */
1467 cups_file_t
*fp
; /* Job file */
1468 int fileid
; /* Current file ID */
1469 ipp_attribute_t
*attr
; /* Job attribute */
1470 const char *dest
; /* Destination name */
1471 cupsd_printer_t
*destptr
; /* Pointer to destination */
1472 mime_type_t
**filetypes
; /* New filetypes array */
1473 int *compressions
; /* New compressions array */
1478 if (job
->state_value
> IPP_JOB_STOPPED
)
1479 job
->access_time
= time(NULL
);
1484 if ((job
->attrs
= ippNew()) == NULL
)
1486 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "Ran out of memory for job attributes!");
1491 * Load job attributes...
1494 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading attributes...", job
->id
);
1496 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
1497 if ((fp
= cupsFileOpen(jobfile
, "r")) == NULL
)
1499 cupsdLogMessage(CUPSD_LOG_ERROR
,
1500 "[Job %d] Unable to open job control file \"%s\" - %s!",
1501 job
->id
, jobfile
, strerror(errno
));
1505 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
1507 cupsdLogMessage(CUPSD_LOG_ERROR
,
1508 "[Job %d] Unable to read job control file \"%s\"!", job
->id
,
1517 * Copy attribute data to the job object...
1520 if (!ippFindAttribute(job
->attrs
, "time-at-creation", IPP_TAG_INTEGER
))
1522 cupsdLogMessage(CUPSD_LOG_ERROR
,
1523 "[Job %d] Missing or bad time-at-creation attribute in "
1524 "control file!", job
->id
);
1528 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
1529 IPP_TAG_ENUM
)) == NULL
)
1531 cupsdLogMessage(CUPSD_LOG_ERROR
,
1532 "[Job %d] Missing or bad job-state attribute in control "
1537 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
1541 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1542 IPP_TAG_URI
)) == NULL
)
1544 cupsdLogMessage(CUPSD_LOG_ERROR
,
1545 "[Job %d] No job-printer-uri attribute in control file!",
1550 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
1553 cupsdLogMessage(CUPSD_LOG_ERROR
,
1554 "[Job %d] Unable to queue job for destination \"%s\"!",
1555 job
->id
, attr
->values
[0].string
.text
);
1559 cupsdSetString(&job
->dest
, dest
);
1561 else if ((destptr
= cupsdFindDest(job
->dest
)) == NULL
)
1563 cupsdLogMessage(CUPSD_LOG_ERROR
,
1564 "[Job %d] Unable to queue job for destination \"%s\"!",
1565 job
->id
, job
->dest
);
1569 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed",
1571 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
1575 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1576 IPP_TAG_INTEGER
)) == NULL
)
1578 cupsdLogMessage(CUPSD_LOG_ERROR
,
1579 "[Job %d] Missing or bad job-priority attribute in "
1580 "control file!", job
->id
);
1584 job
->priority
= attr
->values
[0].integer
;
1589 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
1590 IPP_TAG_NAME
)) == NULL
)
1592 cupsdLogMessage(CUPSD_LOG_ERROR
,
1593 "[Job %d] Missing or bad job-originating-user-name "
1594 "attribute in control file!", job
->id
);
1598 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1602 * Set the job hold-until time and state...
1605 if (job
->state_value
== IPP_JOB_HELD
)
1607 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1608 IPP_TAG_KEYWORD
)) == NULL
)
1609 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1612 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
, CUPSD_JOB_DEFAULT
);
1615 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1616 job
->state_value
= IPP_JOB_PENDING
;
1619 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1621 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1622 job
->state_value
= IPP_JOB_PENDING
;
1625 if (!job
->num_files
)
1628 * Find all the d##### files...
1631 for (fileid
= 1; fileid
< 10000; fileid
++)
1633 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1636 if (access(jobfile
, 0))
1639 cupsdLogMessage(CUPSD_LOG_DEBUG
,
1640 "[Job %d] Auto-typing document file \"%s\"...", job
->id
,
1643 if (fileid
> job
->num_files
)
1645 if (job
->num_files
== 0)
1647 compressions
= (int *)calloc(fileid
, sizeof(int));
1648 filetypes
= (mime_type_t
**)calloc(fileid
, sizeof(mime_type_t
*));
1652 compressions
= (int *)realloc(job
->compressions
,
1653 sizeof(int) * fileid
);
1654 filetypes
= (mime_type_t
**)realloc(job
->filetypes
,
1655 sizeof(mime_type_t
*) *
1659 if (!compressions
|| !filetypes
)
1661 cupsdLogMessage(CUPSD_LOG_ERROR
,
1662 "[Job %d] Ran out of memory for job file types!",
1665 ippDelete(job
->attrs
);
1674 if (job
->compressions
)
1676 free(job
->compressions
);
1677 job
->compressions
= NULL
;
1682 free(job
->filetypes
);
1683 job
->filetypes
= NULL
;
1690 job
->compressions
= compressions
;
1691 job
->filetypes
= filetypes
;
1692 job
->num_files
= fileid
;
1695 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1696 job
->compressions
+ fileid
- 1);
1698 if (!job
->filetypes
[fileid
- 1])
1699 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1705 * Load authentication information as needed...
1708 if (job
->state_value
< IPP_JOB_STOPPED
)
1710 snprintf(jobfile
, sizeof(jobfile
), "%s/a%05d", RequestRoot
, job
->id
);
1712 cupsdClearString(&job
->auth_username
);
1713 cupsdClearString(&job
->auth_domain
);
1714 cupsdClearString(&job
->auth_password
);
1716 if ((fp
= cupsFileOpen(jobfile
, "r")) != NULL
)
1718 int i
, /* Looping var */
1719 bytes
; /* Size of auth data */
1720 char line
[255], /* Line from file */
1721 data
[255]; /* Decoded data */
1725 i
< destptr
->num_auth_info_required
&&
1726 cupsFileGets(fp
, line
, sizeof(line
));
1729 bytes
= sizeof(data
);
1730 httpDecode64_2(data
, &bytes
, line
);
1732 if (!strcmp(destptr
->auth_info_required
[i
], "username"))
1733 cupsdSetStringf(&job
->auth_username
, "AUTH_USERNAME=%s", data
);
1734 else if (!strcmp(destptr
->auth_info_required
[i
], "domain"))
1735 cupsdSetStringf(&job
->auth_domain
, "AUTH_DOMAIN=%s", data
);
1736 else if (!strcmp(destptr
->auth_info_required
[i
], "password"))
1737 cupsdSetStringf(&job
->auth_password
, "AUTH_PASSWORD=%s", data
);
1744 job
->access_time
= time(NULL
);
1748 * If we get here then something bad happened...
1753 ippDelete(job
->attrs
);
1756 if (job
->compressions
)
1758 free(job
->compressions
);
1759 job
->compressions
= NULL
;
1764 free(job
->filetypes
);
1765 job
->filetypes
= NULL
;
1777 * 'cupsdMoveJob()' - Move the specified job to a different destination.
1781 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
1782 cupsd_printer_t
*p
) /* I - Destination printer or class */
1784 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
1785 const char *olddest
; /* Old destination */
1786 cupsd_printer_t
*oldp
; /* Old pointer */
1790 * Don't move completed jobs...
1793 if (job
->state_value
> IPP_JOB_STOPPED
)
1797 * Get the old destination...
1800 olddest
= job
->dest
;
1803 oldp
= job
->printer
;
1805 oldp
= cupsdFindDest(olddest
);
1808 * Change the destination information...
1811 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
1812 "Stopping job prior to move.");
1814 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED
, oldp
, job
,
1815 "Job #%d moved from %s to %s.", job
->id
, olddest
,
1818 cupsdSetString(&job
->dest
, p
->name
);
1819 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
|
1820 CUPS_PRINTER_IMPLICIT
);
1822 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1823 IPP_TAG_URI
)) != NULL
)
1824 cupsdSetString(&(attr
->values
[0].string
.text
), p
->uri
);
1826 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
1827 "Job #%d moved from %s to %s.", job
->id
, olddest
,
1831 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
1836 * 'cupsdReleaseJob()' - Release the specified job.
1840 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
1842 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob(job=%p(%d))", job
,
1845 if (job
->state_value
== IPP_JOB_HELD
)
1848 * Add trailing banner as needed...
1851 if (job
->pending_timeout
)
1852 cupsdTimeoutJob(job
);
1854 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
1855 "Job released by user.");
1861 * 'cupsdRestartJob()' - Restart the specified job.
1865 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
1867 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob(job=%p(%d))", job
,
1870 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
1871 cupsdSetJobState(job
, IPP_JOB_PENDING
, CUPSD_JOB_DEFAULT
,
1872 "Job restarted by user.");
1877 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
1881 cupsdSaveAllJobs(void)
1883 int i
; /* Looping var */
1884 cups_file_t
*fp
; /* Job cache file */
1885 char temp
[1024]; /* Temporary string */
1886 cupsd_job_t
*job
; /* Current job */
1887 time_t curtime
; /* Current time */
1888 struct tm
*curdate
; /* Current date */
1891 snprintf(temp
, sizeof(temp
), "%s/job.cache", CacheDir
);
1892 if ((fp
= cupsFileOpen(temp
, "w")) == NULL
)
1894 cupsdLogMessage(CUPSD_LOG_ERROR
,
1895 "Unable to create job cache file \"%s\" - %s",
1896 temp
, strerror(errno
));
1900 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job cache file \"%s\"...", temp
);
1903 * Restrict access to the file...
1906 fchown(cupsFileNumber(fp
), getuid(), Group
);
1907 fchmod(cupsFileNumber(fp
), ConfigFilePerm
);
1910 * Write a small header to the file...
1913 curtime
= time(NULL
);
1914 curdate
= localtime(&curtime
);
1915 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
1917 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
1918 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
1919 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
1922 * Write each job known to the system...
1925 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1927 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1929 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
1930 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
1931 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
1932 cupsFilePrintf(fp
, "HoldUntil %d\n", (int)job
->hold_until
);
1933 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
1934 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
1935 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
1936 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
1937 for (i
= 0; i
< job
->num_files
; i
++)
1938 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
1939 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
1940 cupsFilePuts(fp
, "</Job>\n");
1948 * 'cupsdSaveJob()' - Save a job to disk.
1952 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
1954 char filename
[1024]; /* Job control filename */
1955 cups_file_t
*fp
; /* Job file */
1958 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
1959 job
, job
->id
, job
->attrs
);
1961 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
1963 if ((fp
= cupsFileOpen(filename
, "w")) == NULL
)
1965 cupsdLogMessage(CUPSD_LOG_ERROR
,
1966 "[Job %d] Unable to create job control file \"%s\" - %s.",
1967 job
->id
, filename
, strerror(errno
));
1971 fchmod(cupsFileNumber(fp
), 0600);
1972 fchown(cupsFileNumber(fp
), RunUser
, Group
);
1974 job
->attrs
->state
= IPP_IDLE
;
1976 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
1977 job
->attrs
) != IPP_DATA
)
1978 cupsdLogMessage(CUPSD_LOG_ERROR
,
1979 "[Job %d] Unable to write job control file!", job
->id
);
1988 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
1992 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
1993 const char *when
, /* I - When to resume */
1994 int update
)/* I - Update job-hold-until attr? */
1996 time_t curtime
; /* Current time */
1997 struct tm
*curdate
; /* Current date */
1998 int hour
; /* Hold hour */
1999 int minute
; /* Hold minute */
2000 int second
= 0; /* Hold second */
2003 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2004 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2005 job
, job
->id
, when
, update
);
2010 * Update the job-hold-until attribute...
2013 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2015 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2016 IPP_TAG_KEYWORD
)) == NULL
)
2017 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2020 cupsdSetString(&(attr
->values
[0].string
.text
), when
);
2022 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2023 "job-hold-until", NULL
, when
);
2027 if (isdigit(when
[0] & 255))
2028 attr
->value_tag
= IPP_TAG_NAME
;
2030 attr
->value_tag
= IPP_TAG_KEYWORD
;
2033 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2038 * Update the hold time...
2041 if (!strcmp(when
, "indefinite") || !strcmp(when
, "auth-info-required"))
2044 * Hold indefinitely...
2047 job
->hold_until
= 0;
2049 else if (!strcmp(when
, "day-time"))
2052 * Hold to 6am the next morning unless local time is < 6pm.
2055 curtime
= time(NULL
);
2056 curdate
= localtime(&curtime
);
2058 if (curdate
->tm_hour
< 18)
2059 job
->hold_until
= curtime
;
2061 job
->hold_until
= curtime
+
2062 ((29 - curdate
->tm_hour
) * 60 + 59 -
2063 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2065 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
2068 * Hold to 6pm unless local time is > 6pm or < 6am.
2071 curtime
= time(NULL
);
2072 curdate
= localtime(&curtime
);
2074 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
2075 job
->hold_until
= curtime
;
2077 job
->hold_until
= curtime
+
2078 ((17 - curdate
->tm_hour
) * 60 + 59 -
2079 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2081 else if (!strcmp(when
, "second-shift"))
2084 * Hold to 4pm unless local time is > 4pm.
2087 curtime
= time(NULL
);
2088 curdate
= localtime(&curtime
);
2090 if (curdate
->tm_hour
>= 16)
2091 job
->hold_until
= curtime
;
2093 job
->hold_until
= curtime
+
2094 ((15 - curdate
->tm_hour
) * 60 + 59 -
2095 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2097 else if (!strcmp(when
, "third-shift"))
2100 * Hold to 12am unless local time is < 8am.
2103 curtime
= time(NULL
);
2104 curdate
= localtime(&curtime
);
2106 if (curdate
->tm_hour
< 8)
2107 job
->hold_until
= curtime
;
2109 job
->hold_until
= curtime
+
2110 ((23 - curdate
->tm_hour
) * 60 + 59 -
2111 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2113 else if (!strcmp(when
, "weekend"))
2116 * Hold to weekend unless we are in the weekend.
2119 curtime
= time(NULL
);
2120 curdate
= localtime(&curtime
);
2122 if (curdate
->tm_wday
== 0 || curdate
->tm_wday
== 6)
2123 job
->hold_until
= curtime
;
2125 job
->hold_until
= curtime
+
2126 (((5 - curdate
->tm_wday
) * 24 +
2127 (17 - curdate
->tm_hour
)) * 60 + 59 -
2128 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
2130 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
2133 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2136 curtime
= time(NULL
);
2137 curdate
= gmtime(&curtime
);
2139 job
->hold_until
= curtime
+
2140 ((hour
- curdate
->tm_hour
) * 60 + minute
-
2141 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
2144 * Hold until next day as needed...
2147 if (job
->hold_until
< curtime
)
2148 job
->hold_until
+= 24 * 60 * 60;
2151 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until=%d",
2152 (int)job
->hold_until
);
2157 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2158 * the list as needed.
2162 cupsdSetJobPriority(
2163 cupsd_job_t
*job
, /* I - Job ID */
2164 int priority
) /* I - New priority (0 to 100) */
2166 ipp_attribute_t
*attr
; /* Job attribute */
2170 * Don't change completed jobs...
2173 if (job
->state_value
>= IPP_JOB_PROCESSING
)
2177 * Set the new priority and re-add the job into the active list...
2180 cupsArrayRemove(ActiveJobs
, job
);
2182 job
->priority
= priority
;
2184 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
2185 IPP_TAG_INTEGER
)) != NULL
)
2186 attr
->values
[0].integer
= priority
;
2188 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
2191 cupsArrayAdd(ActiveJobs
, job
);
2194 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2199 * 'cupsdSetJobState()' - Set the state of the specified print job.
2204 cupsd_job_t
*job
, /* I - Job to cancel */
2205 ipp_jstate_t newstate
, /* I - New job state */
2206 cupsd_jobaction_t action
, /* I - Action to take */
2207 const char *message
, /* I - Message to log */
2208 ...) /* I - Additional arguments as needed */
2210 int i
; /* Looping var */
2211 ipp_jstate_t oldstate
; /* Old state */
2212 char filename
[1024]; /* Job filename */
2213 ipp_attribute_t
*attr
; /* Job attribute */
2216 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2217 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2218 "action=%d, message=\"%s\")", job
, job
->id
, job
->state_value
,
2219 newstate
, action
, message
? message
: "(null)");
2223 * Make sure we have the job attributes...
2226 if (!cupsdLoadJob(job
))
2230 * Don't do anything if the state is unchanged and we aren't purging the
2234 oldstate
= job
->state_value
;
2235 if (newstate
== oldstate
&& action
!= CUPSD_JOB_PURGE
)
2239 * Stop any processes that are working on the current job...
2242 if (oldstate
== IPP_JOB_PROCESSING
)
2243 stop_job(job
, action
);
2246 * Set the new job state...
2249 job
->state
->values
[0].integer
= newstate
;
2250 job
->state_value
= newstate
;
2254 case IPP_JOB_PENDING
:
2256 * Update job-hold-until as needed...
2259 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2260 IPP_TAG_KEYWORD
)) == NULL
)
2261 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2265 attr
->value_tag
= IPP_TAG_KEYWORD
;
2266 cupsdSetString(&(attr
->values
[0].string
.text
), "no-hold");
2272 case IPP_JOB_ABORTED
:
2273 case IPP_JOB_CANCELED
:
2274 case IPP_JOB_COMPLETED
:
2275 set_time(job
, "time-at-completed");
2280 * Log message as needed...
2285 char buffer
[2048]; /* Message buffer */
2286 va_list ap
; /* Pointer to additional arguments */
2288 va_start(ap
, message
);
2289 vsnprintf(buffer
, sizeof(buffer
), message
, ap
);
2292 if (newstate
> IPP_JOB_STOPPED
)
2293 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
, "%s", buffer
);
2295 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "%s", buffer
);
2297 if (newstate
== IPP_JOB_STOPPED
|| newstate
== IPP_JOB_ABORTED
)
2298 cupsdLogJob(job
, CUPSD_LOG_ERROR
, "%s", buffer
);
2300 cupsdLogJob(job
, CUPSD_LOG_INFO
, "%s", buffer
);
2304 * Handle post-state-change actions...
2309 case IPP_JOB_PROCESSING
:
2311 * Add the job to the "printing" list...
2314 if (!cupsArrayFind(PrintingJobs
, job
))
2315 cupsArrayAdd(PrintingJobs
, job
);
2318 * Set the processing time...
2321 set_time(job
, "time-at-processing");
2323 case IPP_JOB_PENDING
:
2325 case IPP_JOB_STOPPED
:
2327 * Make sure the job is in the active list...
2330 if (!cupsArrayFind(ActiveJobs
, job
))
2331 cupsArrayAdd(ActiveJobs
, job
);
2334 * Save the job state to disk...
2338 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2341 case IPP_JOB_ABORTED
:
2342 case IPP_JOB_CANCELED
:
2343 case IPP_JOB_COMPLETED
:
2344 if (newstate
== IPP_JOB_CANCELED
)
2347 * Remove the job from the active list if there are no processes still
2351 for (i
= 0; job
->filters
[i
] < 0; i
++);
2353 if (!job
->filters
[i
] && job
->backend
<= 0)
2354 cupsArrayRemove(ActiveJobs
, job
);
2359 * Otherwise just remove the job from the active list immediately...
2362 cupsArrayRemove(ActiveJobs
, job
);
2366 * Expire job subscriptions since the job is now "completed"...
2369 cupsdExpireSubscriptions(NULL
, job
);
2373 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2374 * sleep to happen immediately...
2377 if (Sleeping
&& cupsArrayCount(PrintingJobs
) == 0)
2379 #endif /* __APPLE__ */
2382 * Remove any authentication data...
2385 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
2386 if (cupsdRemoveFile(filename
) && errno
!= ENOENT
)
2387 cupsdLogMessage(CUPSD_LOG_ERROR
,
2388 "Unable to remove authentication cache: %s",
2391 cupsdClearString(&job
->auth_username
);
2392 cupsdClearString(&job
->auth_domain
);
2393 cupsdClearString(&job
->auth_password
);
2397 * Destroy the credential cache and clear the KRB5CCNAME env var string.
2402 krb5_cc_destroy(KerberosContext
, job
->ccache
);
2406 cupsdClearString(&job
->ccname
);
2407 #endif /* HAVE_GSSAPI */
2410 * Remove the print file for good if we aren't preserving jobs or
2414 if (!JobHistory
|| !JobFiles
|| action
== CUPSD_JOB_PURGE
)
2416 for (i
= 1; i
<= job
->num_files
; i
++)
2418 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
2423 if (job
->num_files
> 0)
2425 free(job
->filetypes
);
2426 free(job
->compressions
);
2429 job
->filetypes
= NULL
;
2430 job
->compressions
= NULL
;
2434 if (JobHistory
&& action
!= CUPSD_JOB_PURGE
)
2437 * Save job state info...
2441 cupsdMarkDirty(CUPSD_DIRTY_JOBS
);
2443 else if (!job
->printer
)
2446 * Delete the job immediately if not actively printing...
2449 cupsdDeleteJob(job
, CUPSD_JOB_PURGE
);
2456 * Finalize the job immediately if we forced things...
2459 if (action
>= CUPSD_JOB_FORCE
&& job
&& job
->printer
)
2460 finalize_job(job
, 0);
2463 * Update the server "busy" state...
2466 cupsdSetBusyState();
2471 * 'cupsdStopAllJobs()' - Stop all print jobs.
2476 cupsd_jobaction_t action
, /* I - Action */
2477 int kill_delay
) /* I - Number of seconds before we kill */
2479 cupsd_job_t
*job
; /* Current job */
2482 DEBUG_puts("cupsdStopAllJobs()");
2484 for (job
= (cupsd_job_t
*)cupsArrayFirst(PrintingJobs
);
2486 job
= (cupsd_job_t
*)cupsArrayNext(PrintingJobs
))
2489 job
->kill_time
= time(NULL
) + kill_delay
;
2491 cupsdSetJobState(job
, IPP_JOB_PENDING
, action
, NULL
);
2497 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2501 cupsdUnloadCompletedJobs(void)
2503 cupsd_job_t
*job
; /* Current job */
2504 time_t expire
; /* Expiration time */
2507 expire
= time(NULL
) - 60;
2509 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
2511 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
2512 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&& !job
->printer
&&
2513 job
->access_time
< expire
)
2524 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2527 static int /* O - Difference */
2528 compare_active_jobs(void *first
, /* I - First job */
2529 void *second
, /* I - Second job */
2530 void *data
) /* I - App data (not used) */
2532 int diff
; /* Difference */
2535 if ((diff
= ((cupsd_job_t
*)second
)->priority
-
2536 ((cupsd_job_t
*)first
)->priority
) != 0)
2539 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2544 * 'compare_jobs()' - Compare the job IDs of two jobs.
2547 static int /* O - Difference */
2548 compare_jobs(void *first
, /* I - First job */
2549 void *second
, /* I - Second job */
2550 void *data
) /* I - App data (not used) */
2552 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
2557 * 'dump_job_history()' - Dump any debug messages for a job.
2561 dump_job_history(cupsd_job_t
*job
) /* I - Job */
2563 int i
, /* Looping var */
2564 oldsize
; /* Current MaxLogSize */
2565 struct tm
*date
; /* Date/time value */
2566 cupsd_joblog_t
*message
; /* Current message */
2567 char temp
[2048], /* Log message */
2568 *ptr
, /* Pointer into log message */
2569 start
[256], /* Start time */
2570 end
[256]; /* End time */
2571 cupsd_printer_t
*printer
; /* Printer for job */
2575 * See if we have anything to dump...
2582 * Disable log rotation temporarily...
2585 oldsize
= MaxLogSize
;
2589 * Copy the debug messages to the log...
2592 message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2593 date
= localtime(&(message
->time
));
2594 strftime(start
, sizeof(start
), "%X", date
);
2596 message
= (cupsd_joblog_t
*)cupsArrayLast(job
->history
);
2597 date
= localtime(&(message
->time
));
2598 strftime(end
, sizeof(end
), "%X", date
);
2600 snprintf(temp
, sizeof(temp
),
2601 "[Job %d] The following messages were recorded from %s to %s",
2602 job
->id
, start
, end
);
2603 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2605 for (message
= (cupsd_joblog_t
*)cupsArrayFirst(job
->history
);
2607 message
= (cupsd_joblog_t
*)cupsArrayNext(job
->history
))
2608 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, message
->message
);
2610 snprintf(temp
, sizeof(temp
), "[Job %d] End of messages", job
->id
);
2611 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2614 * Log the printer state values...
2617 if ((printer
= job
->printer
) == NULL
)
2618 printer
= cupsdFindDest(job
->dest
);
2622 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state=%d(%s)", job
->id
,
2624 printer
->state
== IPP_PRINTER_IDLE
? "idle" :
2625 printer
->state
== IPP_PRINTER_PROCESSING
? "processing" :
2627 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2629 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-message=\"%s\"",
2630 job
->id
, printer
->state_message
);
2631 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2633 snprintf(temp
, sizeof(temp
), "[Job %d] printer-state-reasons=", job
->id
);
2634 ptr
= temp
+ strlen(temp
);
2635 if (printer
->num_reasons
== 0)
2636 strlcpy(ptr
, "none", sizeof(temp
) - (ptr
- temp
));
2640 i
< printer
->num_reasons
&& ptr
< (temp
+ sizeof(temp
) - 2);
2646 strlcpy(ptr
, printer
->reasons
[i
], sizeof(temp
) - (ptr
- temp
));
2650 cupsdWriteErrorLog(CUPSD_LOG_DEBUG
, temp
);
2654 * Restore log file rotation...
2657 MaxLogSize
= oldsize
;
2660 * Free all messages...
2663 free_job_history(job
);
2668 * 'free_job_history()' - Free any log history.
2672 free_job_history(cupsd_job_t
*job
) /* I - Job */
2674 char *message
; /* Current message */
2680 for (message
= (char *)cupsArrayFirst(job
->history
);
2682 message
= (char *)cupsArrayNext(job
->history
))
2685 cupsArrayDelete(job
->history
);
2686 job
->history
= NULL
;
2691 * 'finalize_job()' - Cleanup after job filter processes and support data.
2695 finalize_job(cupsd_job_t
*job
, /* I - Job */
2696 int set_job_state
) /* I - 1 = set the job state */
2698 ipp_pstate_t printer_state
; /* New printer state value */
2699 ipp_jstate_t job_state
; /* New job state value */
2700 const char *message
; /* Message for job state */
2701 char buffer
[1024]; /* Buffer for formatted messages */
2704 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "finalize_job(job=%p(%d))", job
, job
->id
);
2707 * Clear the "connecting-to-device" reason, which is only valid when a printer
2711 cupsdSetPrinterReasons(job
->printer
, "-connecting-to-device");
2714 * Similarly, clear the "offline-report" reason for non-USB devices since we
2715 * rarely have current information for network devices...
2718 if (strncmp(job
->printer
->device_uri
, "usb:", 4))
2719 cupsdSetPrinterReasons(job
->printer
, "-offline-report");
2722 * Free the security profile...
2725 cupsdDestroyProfile(job
->profile
);
2726 job
->profile
= NULL
;
2729 * Clear the unresponsive job watchdog timer...
2735 * Close pipes and status buffer...
2738 cupsdClosePipe(job
->print_pipes
);
2739 cupsdClosePipe(job
->back_pipes
);
2740 cupsdClosePipe(job
->side_pipes
);
2742 cupsdRemoveSelect(job
->status_pipes
[0]);
2743 cupsdClosePipe(job
->status_pipes
);
2744 cupsdStatBufDelete(job
->status_buffer
);
2745 job
->status_buffer
= NULL
;
2748 * Process the exit status...
2751 if (job
->printer
->state
== IPP_PRINTER_PROCESSING
)
2752 printer_state
= IPP_PRINTER_IDLE
;
2754 printer_state
= job
->printer
->state
;
2756 switch (job_state
= job
->state_value
)
2758 case IPP_JOB_PENDING
:
2759 message
= "Job paused.";
2763 message
= "Job held.";
2767 case IPP_JOB_PROCESSING
:
2768 case IPP_JOB_COMPLETED
:
2769 job_state
= IPP_JOB_COMPLETED
;
2770 message
= "Job completed.";
2773 case IPP_JOB_STOPPED
:
2774 message
= "Job stopped.";
2777 case IPP_JOB_CANCELED
:
2778 message
= "Job canceled.";
2781 case IPP_JOB_ABORTED
:
2782 message
= "Job aborted.";
2786 if (job
->status
< 0)
2789 * Backend had errors...
2792 int exit_code
; /* Exit code from backend */
2796 * Convert the status to an exit code. Due to the way the W* macros are
2797 * implemented on MacOS X (bug?), we have to store the exit status in a
2798 * variable first and then convert...
2801 exit_code
= -job
->status
;
2802 if (WIFEXITED(exit_code
))
2803 exit_code
= WEXITSTATUS(exit_code
);
2805 exit_code
= job
->status
;
2807 cupsdLogJob(job
, CUPSD_LOG_INFO
, "Backend returned status %d (%s)",
2809 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
2810 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
2811 "authentication required" :
2812 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
2813 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
2814 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
2815 exit_code
< 0 ? "crashed" : "unknown");
2818 * Do what needs to be done...
2824 case CUPS_BACKEND_FAILED
:
2826 * Backend failure, use the error-policy to determine how to
2830 if (job
->dtype
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_IMPLICIT
))
2833 * Queued on a class - mark the job as pending and we'll retry on
2834 * another printer...
2837 if (job_state
== IPP_JOB_COMPLETED
)
2839 job_state
= IPP_JOB_PENDING
;
2840 message
= "Retrying job on another printer.";
2843 else if (!strcmp(job
->printer
->error_policy
, "retry-current-job"))
2846 * The error policy is "retry-current-job" - mark the job as pending
2847 * and we'll retry on the same printer...
2850 if (job_state
== IPP_JOB_COMPLETED
)
2852 job_state
= IPP_JOB_PENDING
;
2853 message
= "Retrying job on same printer.";
2856 else if ((job
->printer
->type
& CUPS_PRINTER_FAX
) ||
2857 !strcmp(job
->printer
->error_policy
, "retry-job"))
2859 if (job_state
== IPP_JOB_COMPLETED
)
2862 * The job was queued on a fax or the error policy is "retry-job" -
2863 * hold the job if the number of retries is less than the
2864 * JobRetryLimit, otherwise abort the job.
2869 if (job
->tries
> JobRetryLimit
&& JobRetryLimit
> 0)
2875 snprintf(buffer
, sizeof(buffer
),
2876 "Job aborted after %d unsuccessful attempts.",
2878 job_state
= IPP_JOB_ABORTED
;
2884 * Try again in N seconds...
2887 snprintf(buffer
, sizeof(buffer
),
2888 "Job held for %d seconds since it could not be sent.",
2891 job
->hold_until
= time(NULL
) + JobRetryInterval
;
2892 job_state
= IPP_JOB_HELD
;
2897 else if (!strcmp(job
->printer
->error_policy
, "abort-job") &&
2898 job_state
== IPP_JOB_COMPLETED
)
2900 job_state
= IPP_JOB_ABORTED
;
2901 message
= "Job aborted due to backend errors; please consult "
2902 "the error_log file for details.";
2904 else if (job
->state_value
== IPP_JOB_PROCESSING
)
2906 job_state
= IPP_JOB_PENDING
;
2907 printer_state
= IPP_PRINTER_STOPPED
;
2908 message
= "Printer stopped due to backend errors; please "
2909 "consult the error_log file for details.";
2913 case CUPS_BACKEND_CANCEL
:
2918 if (job_state
== IPP_JOB_COMPLETED
)
2920 job_state
= IPP_JOB_ABORTED
;
2921 message
= "Job aborted due to backend errors; please consult "
2922 "the error_log file for details.";
2926 case CUPS_BACKEND_HOLD
:
2927 if (job_state
== IPP_JOB_COMPLETED
)
2933 cupsdSetJobHoldUntil(job
, "indefinite", 1);
2935 job_state
= IPP_JOB_HELD
;
2936 message
= "Job held indefinitely due to backend errors; please "
2937 "consult the error_log file for details.";
2941 case CUPS_BACKEND_STOP
:
2943 * Stop the printer...
2946 printer_state
= IPP_PRINTER_STOPPED
;
2947 message
= "Printer stopped due to backend errors; please "
2948 "consult the error_log file for details.";
2950 if (job_state
== IPP_JOB_COMPLETED
)
2951 job_state
= IPP_JOB_PENDING
;
2954 case CUPS_BACKEND_AUTH_REQUIRED
:
2956 * Hold the job for authentication...
2959 if (job_state
== IPP_JOB_COMPLETED
)
2961 cupsdSetJobHoldUntil(job
, "auth-info-required", 1);
2963 job_state
= IPP_JOB_HELD
;
2964 message
= "Job held for authentication.";
2969 else if (job
->status
> 0)
2972 * Filter had errors; stop job...
2975 if (job_state
== IPP_JOB_COMPLETED
)
2977 job_state
= IPP_JOB_STOPPED
;
2978 message
= "Job stopped due to filter errors; please consult the "
2979 "error_log file for details.";
2984 * Update the printer and job state.
2987 if (job_state
!= job
->state_value
)
2988 cupsdSetJobState(job
, job_state
, CUPSD_JOB_DEFAULT
, "%s", message
);
2990 cupsdSetPrinterState(job
->printer
, printer_state
,
2991 printer_state
== IPP_PRINTER_STOPPED
);
2992 update_job_attrs(job
, 0);
2997 dump_job_history(job
);
2999 free_job_history(job
);
3002 cupsArrayRemove(PrintingJobs
, job
);
3005 * Clear the printer <-> job association...
3008 job
->printer
->job
= NULL
;
3009 job
->printer
= NULL
;
3012 * Try printing another job...
3015 if (printer_state
!= IPP_PRINTER_STOPPED
)
3021 * 'get_options()' - Get a string containing the job options.
3024 static char * /* O - Options string */
3025 get_options(cupsd_job_t
*job
, /* I - Job */
3026 int banner_page
, /* I - Printing a banner page? */
3027 char *copies
, /* I - Copies buffer */
3028 size_t copies_size
, /* I - Size of copies buffer */
3029 char *title
, /* I - Title buffer */
3030 size_t title_size
) /* I - Size of title buffer */
3032 int i
; /* Looping var */
3033 size_t newlength
; /* New option buffer length */
3034 char *optptr
, /* Pointer to options */
3035 *valptr
; /* Pointer in value string */
3036 ipp_attribute_t
*attr
; /* Current attribute */
3037 _ppd_cache_t
*pc
; /* PPD cache and mapping data */
3038 int num_pwgppds
; /* Number of PWG->PPD options */
3039 cups_option_t
*pwgppds
, /* PWG->PPD options */
3040 *pwgppd
, /* Current PWG->PPD option */
3041 *preset
; /* Current preset option */
3042 int print_color_mode
,
3043 /* Output mode (if any) */
3044 print_quality
; /* Print quality (if any) */
3045 const char *ppd
; /* PPD option choice */
3046 int exact
; /* Did we get an exact match? */
3047 static char *options
= NULL
;/* Full list of options */
3048 static size_t optlength
= 0; /* Length of option buffer */
3052 * Building the options string is harder than it needs to be, but for the
3053 * moment we need to pass strings for command-line args and not IPP attribute
3056 * First build an options array for any PWG->PPD mapped option/choice pairs.
3059 pc
= job
->printer
->pc
;
3064 !ippFindAttribute(job
->attrs
,
3065 "com.apple.print.DocumentTicket.PMSpoolFormat",
3067 !ippFindAttribute(job
->attrs
, "APPrinterPreset", IPP_TAG_ZERO
) &&
3068 (ippFindAttribute(job
->attrs
, "output-mode", IPP_TAG_ZERO
) ||
3069 ippFindAttribute(job
->attrs
, "print-color-mode", IPP_TAG_ZERO
) ||
3070 ippFindAttribute(job
->attrs
, "print-quality", IPP_TAG_ZERO
)))
3073 * Map output-mode and print-quality to a preset...
3076 if ((attr
= ippFindAttribute(job
->attrs
, "print-color-mode",
3077 IPP_TAG_KEYWORD
)) == NULL
)
3078 attr
= ippFindAttribute(job
->attrs
, "output-mode", IPP_TAG_KEYWORD
);
3080 if (attr
&& !strcmp(attr
->values
[0].string
.text
, "monochrome"))
3081 print_color_mode
= _PWG_PRINT_COLOR_MODE_MONOCHROME
;
3083 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3085 if ((attr
= ippFindAttribute(job
->attrs
, "print-quality",
3086 IPP_TAG_ENUM
)) != NULL
&&
3087 attr
->values
[0].integer
>= IPP_QUALITY_DRAFT
&&
3088 attr
->values
[0].integer
<= IPP_QUALITY_HIGH
)
3089 print_quality
= attr
->values
[0].integer
- IPP_QUALITY_DRAFT
;
3091 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3093 if (pc
->num_presets
[print_color_mode
][print_quality
] == 0)
3096 * Try to find a preset that works so that we maximize the chances of us
3097 * getting a good print using IPP attributes.
3100 if (pc
->num_presets
[print_color_mode
][_PWG_PRINT_QUALITY_NORMAL
] > 0)
3101 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3102 else if (pc
->num_presets
[_PWG_PRINT_COLOR_MODE_COLOR
][print_quality
] > 0)
3103 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3106 print_quality
= _PWG_PRINT_QUALITY_NORMAL
;
3107 print_color_mode
= _PWG_PRINT_COLOR_MODE_COLOR
;
3111 if (pc
->num_presets
[print_color_mode
][print_quality
] > 0)
3114 * Copy the preset options as long as the corresponding names are not
3115 * already defined in the IPP request...
3118 for (i
= pc
->num_presets
[print_color_mode
][print_quality
],
3119 preset
= pc
->presets
[print_color_mode
][print_quality
];
3123 if (!ippFindAttribute(job
->attrs
, preset
->name
, IPP_TAG_ZERO
))
3124 num_pwgppds
= cupsAddOption(preset
->name
, preset
->value
, num_pwgppds
,
3132 if (!ippFindAttribute(job
->attrs
, "InputSlot", IPP_TAG_ZERO
) &&
3133 !ippFindAttribute(job
->attrs
, "HPPaperSource", IPP_TAG_ZERO
))
3135 if ((ppd
= _ppdCacheGetInputSlot(pc
, job
->attrs
, NULL
)) != NULL
)
3136 num_pwgppds
= cupsAddOption(pc
->source_option
, ppd
, num_pwgppds
,
3138 else if (!ippFindAttribute(job
->attrs
, "AP_D_InputSlot", IPP_TAG_ZERO
))
3139 num_pwgppds
= cupsAddOption("AP_D_InputSlot", "", num_pwgppds
,
3142 if (!ippFindAttribute(job
->attrs
, "MediaType", IPP_TAG_ZERO
) &&
3143 (ppd
= _ppdCacheGetMediaType(pc
, job
->attrs
, NULL
)) != NULL
)
3144 num_pwgppds
= cupsAddOption("MediaType", ppd
, num_pwgppds
, &pwgppds
);
3146 if (!ippFindAttribute(job
->attrs
, "PageRegion", IPP_TAG_ZERO
) &&
3147 !ippFindAttribute(job
->attrs
, "PageSize", IPP_TAG_ZERO
) &&
3148 (ppd
= _ppdCacheGetPageSize(pc
, job
->attrs
, NULL
, &exact
)) != NULL
)
3150 num_pwgppds
= cupsAddOption("PageSize", ppd
, num_pwgppds
, &pwgppds
);
3152 if (!ippFindAttribute(job
->attrs
, "media", IPP_TAG_ZERO
))
3153 num_pwgppds
= cupsAddOption("media", ppd
, num_pwgppds
, &pwgppds
);
3156 if (!ippFindAttribute(job
->attrs
, "OutputBin", IPP_TAG_ZERO
) &&
3157 (attr
= ippFindAttribute(job
->attrs
, "output-bin",
3158 IPP_TAG_ZERO
)) != NULL
&&
3159 (attr
->value_tag
== IPP_TAG_KEYWORD
||
3160 attr
->value_tag
== IPP_TAG_NAME
) &&
3161 (ppd
= _ppdCacheGetOutputBin(pc
, attr
->values
[0].string
.text
)) != NULL
)
3164 * Map output-bin to OutputBin option...
3167 num_pwgppds
= cupsAddOption("OutputBin", ppd
, num_pwgppds
, &pwgppds
);
3170 if (pc
->sides_option
&&
3171 !ippFindAttribute(job
->attrs
, pc
->sides_option
, IPP_TAG_ZERO
) &&
3172 (attr
= ippFindAttribute(job
->attrs
, "sides", IPP_TAG_KEYWORD
)) != NULL
)
3175 * Map sides to duplex option...
3178 if (!strcmp(attr
->values
[0].string
.text
, "one-sided"))
3179 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_1sided
,
3180 num_pwgppds
, &pwgppds
);
3181 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-long-edge"))
3182 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_long
,
3183 num_pwgppds
, &pwgppds
);
3184 else if (!strcmp(attr
->values
[0].string
.text
, "two-sided-short-edge"))
3185 num_pwgppds
= cupsAddOption(pc
->sides_option
, pc
->sides_2sided_short
,
3186 num_pwgppds
, &pwgppds
);
3191 * Figure out how much room we need...
3194 newlength
= ipp_length(job
->attrs
);
3196 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3197 newlength
+= 1 + strlen(pwgppd
->name
) + 1 + strlen(pwgppd
->value
);
3200 * Then allocate/reallocate the option buffer as needed...
3203 if (newlength
> optlength
|| !options
)
3206 optptr
= malloc(newlength
);
3208 optptr
= realloc(options
, newlength
);
3212 cupsdLogJob(job
, CUPSD_LOG_CRIT
,
3213 "Unable to allocate " CUPS_LLFMT
" bytes for option buffer!",
3214 CUPS_LLCAST newlength
);
3219 optlength
= newlength
;
3223 * Now loop through the attributes and convert them to the textual
3224 * representation used by the filters...
3230 snprintf(title
, title_size
, "%s-%d", job
->printer
->name
, job
->id
);
3231 strlcpy(copies
, "1", copies_size
);
3233 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3235 if (!strcmp(attr
->name
, "copies") &&
3236 attr
->value_tag
== IPP_TAG_INTEGER
)
3239 * Don't use the # copies attribute if we are printing the job sheets...
3243 snprintf(copies
, copies_size
, "%d", attr
->values
[0].integer
);
3245 else if (!strcmp(attr
->name
, "job-name") &&
3246 (attr
->value_tag
== IPP_TAG_NAME
||
3247 attr
->value_tag
== IPP_TAG_NAMELANG
))
3248 strlcpy(title
, attr
->values
[0].string
.text
, title_size
);
3249 else if (attr
->group_tag
== IPP_TAG_JOB
)
3252 * Filter out other unwanted attributes...
3255 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3256 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3257 attr
->value_tag
== IPP_TAG_NAMELANG
||
3258 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3259 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid")) ||
3260 attr
->value_tag
== IPP_TAG_URISCHEME
||
3261 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
3264 if (!strcmp(attr
->name
, "job-hold-until"))
3267 if (!strncmp(attr
->name
, "job-", 4) &&
3268 strcmp(attr
->name
, "job-billing") &&
3269 strcmp(attr
->name
, "job-impressions") &&
3270 strcmp(attr
->name
, "job-originating-host-name") &&
3271 strcmp(attr
->name
, "job-uuid") &&
3272 !(job
->printer
->type
& CUPS_PRINTER_REMOTE
))
3275 if ((!strcmp(attr
->name
, "job-impressions") ||
3276 !strcmp(attr
->name
, "page-label") ||
3277 !strcmp(attr
->name
, "page-border") ||
3278 !strncmp(attr
->name
, "number-up", 9) ||
3279 !strcmp(attr
->name
, "page-ranges") ||
3280 !strcmp(attr
->name
, "page-set") ||
3281 !strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
3282 !strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed") ||
3283 !strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3284 "PMTotalSidesImaged..n.") ||
3285 !strcasecmp(attr
->name
, "com.apple.print.PrintSettings."
3286 "PMTotalBeginPages..n.")) &&
3291 * Otherwise add them to the list...
3294 if (optptr
> options
)
3295 strlcat(optptr
, " ", optlength
- (optptr
- options
));
3297 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3299 strlcat(optptr
, attr
->name
, optlength
- (optptr
- options
));
3300 strlcat(optptr
, "=", optlength
- (optptr
- options
));
3303 for (i
= 0; i
< attr
->num_values
; i
++)
3306 strlcat(optptr
, ",", optlength
- (optptr
- options
));
3308 optptr
+= strlen(optptr
);
3310 switch (attr
->value_tag
)
3312 case IPP_TAG_INTEGER
:
3314 snprintf(optptr
, optlength
- (optptr
- options
),
3315 "%d", attr
->values
[i
].integer
);
3318 case IPP_TAG_BOOLEAN
:
3319 if (!attr
->values
[i
].boolean
)
3320 strlcat(optptr
, "no", optlength
- (optptr
- options
));
3322 strlcat(optptr
, attr
->name
,
3323 optlength
- (optptr
- options
));
3326 case IPP_TAG_RANGE
:
3327 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3328 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3329 "%d", attr
->values
[i
].range
.lower
);
3331 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3332 "%d-%d", attr
->values
[i
].range
.lower
,
3333 attr
->values
[i
].range
.upper
);
3336 case IPP_TAG_RESOLUTION
:
3337 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
3338 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
3339 attr
->values
[i
].resolution
.yres
,
3340 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
3344 case IPP_TAG_STRING
:
3347 case IPP_TAG_KEYWORD
:
3348 case IPP_TAG_CHARSET
:
3349 case IPP_TAG_LANGUAGE
:
3351 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
3353 if (strchr(" \t\n\\\'\"", *valptr
))
3355 *optptr
++ = *valptr
++;
3362 break; /* anti-compiler-warning-code */
3366 optptr
+= strlen(optptr
);
3371 * Finally loop through the PWG->PPD mapped options and add them...
3374 for (i
= num_pwgppds
, pwgppd
= pwgppds
; i
> 0; i
--, pwgppd
++)
3377 strcpy(optptr
, pwgppd
->name
);
3378 optptr
+= strlen(optptr
);
3380 strcpy(optptr
, pwgppd
->value
);
3381 optptr
+= strlen(optptr
);
3384 cupsFreeOptions(num_pwgppds
, pwgppds
);
3387 * Return the options string...
3395 * 'ipp_length()' - Compute the size of the buffer needed to hold
3396 * the textual IPP attributes.
3399 static size_t /* O - Size of attribute buffer */
3400 ipp_length(ipp_t
*ipp
) /* I - IPP request */
3402 size_t bytes
; /* Number of bytes */
3403 int i
; /* Looping var */
3404 ipp_attribute_t
*attr
; /* Current attribute */
3408 * Loop through all attributes...
3413 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
3416 * Skip attributes that won't be sent to filters...
3419 if (attr
->value_tag
== IPP_TAG_NOVALUE
||
3420 attr
->value_tag
== IPP_TAG_MIMETYPE
||
3421 attr
->value_tag
== IPP_TAG_NAMELANG
||
3422 attr
->value_tag
== IPP_TAG_TEXTLANG
||
3423 attr
->value_tag
== IPP_TAG_URI
||
3424 attr
->value_tag
== IPP_TAG_URISCHEME
)
3428 * Add space for a leading space and commas between each value.
3429 * For the first attribute, the leading space isn't used, so the
3430 * extra byte can be used as the nul terminator...
3433 bytes
++; /* " " separator */
3434 bytes
+= attr
->num_values
; /* "," separators */
3437 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3438 * other attributes appear as "foo=value1,value2,...,valueN".
3441 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
3442 bytes
+= strlen(attr
->name
);
3444 bytes
+= attr
->num_values
* strlen(attr
->name
);
3447 * Now add the size required for each value in the attribute...
3450 switch (attr
->value_tag
)
3452 case IPP_TAG_INTEGER
:
3455 * Minimum value of a signed integer is -2147483647, or 11 digits.
3458 bytes
+= attr
->num_values
* 11;
3461 case IPP_TAG_BOOLEAN
:
3463 * Add two bytes for each false ("no") value...
3466 for (i
= 0; i
< attr
->num_values
; i
++)
3467 if (!attr
->values
[i
].boolean
)
3471 case IPP_TAG_RANGE
:
3473 * A range is two signed integers separated by a hyphen, or
3474 * 23 characters max.
3477 bytes
+= attr
->num_values
* 23;
3480 case IPP_TAG_RESOLUTION
:
3482 * A resolution is two signed integers separated by an "x" and
3483 * suffixed by the units, or 26 characters max.
3486 bytes
+= attr
->num_values
* 26;
3489 case IPP_TAG_STRING
:
3492 case IPP_TAG_KEYWORD
:
3493 case IPP_TAG_CHARSET
:
3494 case IPP_TAG_LANGUAGE
:
3497 * Strings can contain characters that need quoting. We need
3498 * at least 2 * len + 2 characters to cover the quotes and
3499 * any backslashes in the string.
3502 for (i
= 0; i
< attr
->num_values
; i
++)
3503 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
3507 break; /* anti-compiler-warning-code */
3516 * 'load_job_cache()' - Load jobs from the job.cache file.
3520 load_job_cache(const char *filename
) /* I - job.cache filename */
3522 cups_file_t
*fp
; /* job.cache file */
3523 char line
[1024], /* Line buffer */
3524 *value
; /* Value on line */
3525 int linenum
; /* Line number in file */
3526 cupsd_job_t
*job
; /* Current job */
3527 int jobid
; /* Job ID */
3528 char jobfile
[1024]; /* Job filename */
3532 * Open the job.cache file...
3535 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
3537 if (errno
!= ENOENT
)
3538 cupsdLogMessage(CUPSD_LOG_ERROR
,
3539 "Unable to open job cache file \"%s\": %s",
3540 filename
, strerror(errno
));
3542 load_request_root();
3548 * Read entries from the job cache file and create jobs as needed.
3551 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
3557 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
3559 if (!strcasecmp(line
, "NextJobId"))
3562 NextJobId
= atoi(value
);
3564 else if (!strcasecmp(line
, "<Job"))
3568 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d!",
3575 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d!", linenum
);
3579 jobid
= atoi(value
);
3583 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d!", jobid
,
3588 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
3589 if (access(jobfile
, 0))
3591 cupsdLogMessage(CUPSD_LOG_ERROR
, "[Job %d] Files have gone away!",
3596 job
= calloc(1, sizeof(cupsd_job_t
));
3599 cupsdLogMessage(CUPSD_LOG_EMERG
,
3600 "[Job %d] Unable to allocate memory for job!", jobid
);
3605 job
->back_pipes
[0] = -1;
3606 job
->back_pipes
[1] = -1;
3607 job
->print_pipes
[0] = -1;
3608 job
->print_pipes
[1] = -1;
3609 job
->side_pipes
[0] = -1;
3610 job
->side_pipes
[1] = -1;
3611 job
->status_pipes
[0] = -1;
3612 job
->status_pipes
[1] = -1;
3614 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Loading from cache...",
3619 cupsdLogMessage(CUPSD_LOG_ERROR
,
3620 "Missing <Job #> directive on line %d!", linenum
);
3623 else if (!strcasecmp(line
, "</Job>"))
3625 cupsArrayAdd(Jobs
, job
);
3627 if (job
->state_value
<= IPP_JOB_STOPPED
&& cupsdLoadJob(job
))
3628 cupsArrayAdd(ActiveJobs
, job
);
3634 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d!", linenum
);
3637 else if (!strcasecmp(line
, "State"))
3639 job
->state_value
= (ipp_jstate_t
)atoi(value
);
3641 if (job
->state_value
< IPP_JOB_PENDING
)
3642 job
->state_value
= IPP_JOB_PENDING
;
3643 else if (job
->state_value
> IPP_JOB_COMPLETED
)
3644 job
->state_value
= IPP_JOB_COMPLETED
;
3646 else if (!strcasecmp(line
, "HoldUntil"))
3648 job
->hold_until
= atoi(value
);
3650 else if (!strcasecmp(line
, "Priority"))
3652 job
->priority
= atoi(value
);
3654 else if (!strcasecmp(line
, "Username"))
3656 cupsdSetString(&job
->username
, value
);
3658 else if (!strcasecmp(line
, "Destination"))
3660 cupsdSetString(&job
->dest
, value
);
3662 else if (!strcasecmp(line
, "DestType"))
3664 job
->dtype
= (cups_ptype_t
)atoi(value
);
3666 else if (!strcasecmp(line
, "NumFiles"))
3668 job
->num_files
= atoi(value
);
3670 if (job
->num_files
< 0)
3672 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d!",
3673 job
->num_files
, linenum
);
3678 if (job
->num_files
> 0)
3680 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
3682 if (access(jobfile
, 0))
3684 cupsdLogMessage(CUPSD_LOG_INFO
, "[Job %d] Data files have gone away!",
3690 job
->filetypes
= calloc(job
->num_files
, sizeof(mime_type_t
*));
3691 job
->compressions
= calloc(job
->num_files
, sizeof(int));
3693 if (!job
->filetypes
|| !job
->compressions
)
3695 cupsdLogMessage(CUPSD_LOG_EMERG
,
3696 "[Job %d] Unable to allocate memory for %d files!",
3697 job
->id
, job
->num_files
);
3702 else if (!strcasecmp(line
, "File"))
3704 int number
, /* File number */
3705 compression
; /* Compression value */
3706 char super
[MIME_MAX_SUPER
], /* MIME super type */
3707 type
[MIME_MAX_TYPE
]; /* MIME type */
3710 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
3713 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d!", linenum
);
3717 if (number
< 1 || number
> job
->num_files
)
3719 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d!",
3726 job
->compressions
[number
] = compression
;
3727 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
3729 if (!job
->filetypes
[number
])
3732 * If the original MIME type is unknown, auto-type it!
3735 cupsdLogMessage(CUPSD_LOG_ERROR
,
3736 "[Job %d] Unknown MIME type %s/%s for file %d!",
3737 job
->id
, super
, type
, number
+ 1);
3739 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
3740 job
->id
, number
+ 1);
3741 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
3742 job
->compressions
+ number
);
3745 * If that didn't work, assume it is raw...
3748 if (!job
->filetypes
[number
])
3749 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
3754 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d!",
3763 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
3767 load_next_job_id(const char *filename
) /* I - job.cache filename */
3769 cups_file_t
*fp
; /* job.cache file */
3770 char line
[1024], /* Line buffer */
3771 *value
; /* Value on line */
3772 int linenum
; /* Line number in file */
3773 int next_job_id
; /* NextJobId value from line */
3777 * Read the NextJobId directive from the job.cache file and use
3778 * the value (if any).
3781 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
3783 if (errno
!= ENOENT
)
3784 cupsdLogMessage(CUPSD_LOG_ERROR
,
3785 "Unable to open job cache file \"%s\": %s",
3786 filename
, strerror(errno
));
3791 cupsdLogMessage(CUPSD_LOG_INFO
,
3792 "Loading NextJobId from job cache file \"%s\"...", filename
);
3796 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
3798 if (!strcasecmp(line
, "NextJobId"))
3802 next_job_id
= atoi(value
);
3804 if (next_job_id
> NextJobId
)
3805 NextJobId
= next_job_id
;
3816 * 'load_request_root()' - Load jobs from the RequestRoot directory.
3820 load_request_root(void)
3822 cups_dir_t
*dir
; /* Directory */
3823 cups_dentry_t
*dent
; /* Directory entry */
3824 cupsd_job_t
*job
; /* New job */
3828 * Open the requests directory...
3831 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
3833 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
3835 cupsdLogMessage(CUPSD_LOG_ERROR
,
3836 "Unable to open spool directory \"%s\": %s",
3837 RequestRoot
, strerror(errno
));
3842 * Read all the c##### files...
3845 while ((dent
= cupsDirRead(dir
)) != NULL
)
3846 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
3849 * Allocate memory for the job...
3852 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
3854 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs!");
3860 * Assign the job ID...
3863 job
->id
= atoi(dent
->filename
+ 1);
3864 job
->back_pipes
[0] = -1;
3865 job
->back_pipes
[1] = -1;
3866 job
->print_pipes
[0] = -1;
3867 job
->print_pipes
[1] = -1;
3868 job
->side_pipes
[0] = -1;
3869 job
->side_pipes
[1] = -1;
3870 job
->status_pipes
[0] = -1;
3871 job
->status_pipes
[1] = -1;
3873 if (job
->id
>= NextJobId
)
3874 NextJobId
= job
->id
+ 1;
3880 if (cupsdLoadJob(job
))
3883 * Insert the job into the array, sorting by job priority and ID...
3886 cupsArrayAdd(Jobs
, job
);
3888 if (job
->state_value
<= IPP_JOB_STOPPED
)
3889 cupsArrayAdd(ActiveJobs
, job
);
3900 * 'set_time()' - Set one of the "time-at-xyz" attributes.
3904 set_time(cupsd_job_t
*job
, /* I - Job to update */
3905 const char *name
) /* I - Name of attribute */
3907 ipp_attribute_t
*attr
; /* Time attribute */
3910 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
3912 attr
->value_tag
= IPP_TAG_INTEGER
;
3913 attr
->values
[0].integer
= time(NULL
);
3919 * 'start_job()' - Start a print job.
3923 start_job(cupsd_job_t
*job
, /* I - Job ID */
3924 cupsd_printer_t
*printer
) /* I - Printer to print job */
3926 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job(job=%p(%d), printer=%p(%s))",
3927 job
, job
->id
, printer
, printer
->name
);
3930 * Make sure we have some files around before we try to print...
3933 if (job
->num_files
== 0)
3935 cupsdSetJobState(job
, IPP_JOB_ABORTED
, CUPSD_JOB_DEFAULT
,
3936 "Aborting job because it has no files.");
3941 * Update the printer and job state to "processing"...
3944 if (!cupsdLoadJob(job
))
3947 cupsdSetJobState(job
, IPP_JOB_PROCESSING
, CUPSD_JOB_DEFAULT
, NULL
);
3948 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
3951 job
->current_file
= 0;
3953 job
->printer
= printer
;
3957 * Setup the last exit status and security profiles...
3961 job
->profile
= cupsdCreateProfile(job
->id
);
3964 * Create the status pipes and buffer...
3967 if (cupsdOpenPipe(job
->status_pipes
))
3969 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
3970 "Unable to create job status pipes - %s.", strerror(errno
));
3972 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
3973 "Job stopped because the scheduler could not create the "
3974 "job status pipes.");
3976 cupsdDestroyProfile(job
->profile
);
3977 job
->profile
= NULL
;
3981 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], NULL
);
3982 job
->status_level
= CUPSD_LOG_INFO
;
3984 if (job
->printer_message
)
3985 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
3988 * Create the backchannel pipes and make them non-blocking...
3991 if (cupsdOpenPipe(job
->back_pipes
))
3993 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
3994 "Unable to create back-channel pipes - %s.", strerror(errno
));
3996 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
3997 "Job stopped because the scheduler could not create the "
3998 "back-channel pipes.");
4000 cupsdClosePipe(job
->status_pipes
);
4001 cupsdStatBufDelete(job
->status_buffer
);
4002 job
->status_buffer
= NULL
;
4004 cupsdDestroyProfile(job
->profile
);
4005 job
->profile
= NULL
;
4009 fcntl(job
->back_pipes
[0], F_SETFL
,
4010 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4011 fcntl(job
->back_pipes
[1], F_SETFL
,
4012 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4015 * Create the side-channel pipes and make them non-blocking...
4018 if (socketpair(AF_LOCAL
, SOCK_STREAM
, 0, job
->side_pipes
))
4020 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4021 "Unable to create side-channel pipes - %s.", strerror(errno
));
4023 cupsdSetJobState(job
, IPP_JOB_STOPPED
, CUPSD_JOB_DEFAULT
,
4024 "Job stopped because the scheduler could not create the "
4025 "side-channel pipes.");
4027 cupsdClosePipe(job
->back_pipes
);
4029 cupsdClosePipe(job
->status_pipes
);
4030 cupsdStatBufDelete(job
->status_buffer
);
4031 job
->status_buffer
= NULL
;
4033 cupsdDestroyProfile(job
->profile
);
4034 job
->profile
= NULL
;
4038 fcntl(job
->side_pipes
[0], F_SETFL
,
4039 fcntl(job
->side_pipes
[0], F_GETFL
) | O_NONBLOCK
);
4040 fcntl(job
->side_pipes
[1], F_SETFL
,
4041 fcntl(job
->side_pipes
[1], F_GETFL
) | O_NONBLOCK
);
4043 fcntl(job
->side_pipes
[0], F_SETFD
,
4044 fcntl(job
->side_pipes
[0], F_GETFD
) | FD_CLOEXEC
);
4045 fcntl(job
->side_pipes
[1], F_SETFD
,
4046 fcntl(job
->side_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
4049 * Now start the first file in the job...
4052 cupsdContinueJob(job
);
4057 * 'stop_job()' - Stop a print job.
4061 stop_job(cupsd_job_t
*job
, /* I - Job */
4062 cupsd_jobaction_t action
) /* I - Action */
4064 int i
; /* Looping var */
4067 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "stop_job(job=%p(%d), action=%d)", job
,
4070 FilterLevel
-= job
->cost
;
4073 if (action
== CUPSD_JOB_DEFAULT
&& !job
->kill_time
)
4074 job
->kill_time
= time(NULL
) + JobKillDelay
;
4075 else if (action
>= CUPSD_JOB_FORCE
)
4078 for (i
= 0; job
->filters
[i
]; i
++)
4079 if (job
->filters
[i
] > 0)
4081 cupsdEndProcess(job
->filters
[i
], action
>= CUPSD_JOB_FORCE
);
4083 if (action
>= CUPSD_JOB_FORCE
)
4084 job
->filters
[i
] = -job
->filters
[i
];
4087 if (job
->backend
> 0)
4089 cupsdEndProcess(job
->backend
, action
>= CUPSD_JOB_FORCE
);
4091 if (action
>= CUPSD_JOB_FORCE
)
4092 job
->backend
= -job
->backend
;
4095 if (action
>= CUPSD_JOB_FORCE
)
4098 * Clear job status...
4107 * 'unload_job()' - Unload a job from memory.
4111 unload_job(cupsd_job_t
*job
) /* I - Job */
4116 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] Unloading...", job
->id
);
4118 ippDelete(job
->attrs
);
4123 job
->job_sheets
= NULL
;
4124 job
->printer_message
= NULL
;
4125 job
->printer_reasons
= NULL
;
4130 * 'update_job()' - Read a status update from a job's filters.
4134 update_job(cupsd_job_t
*job
) /* I - Job to check */
4136 int i
; /* Looping var */
4137 int copies
; /* Number of copies printed */
4138 char message
[CUPSD_SB_BUFFER_SIZE
],
4140 *ptr
; /* Pointer update... */
4141 int loglevel
, /* Log level for message */
4142 event
= 0; /* Events? */
4143 static const char * const levels
[] = /* Log levels */
4159 * Get the printer associated with this job; if the printer is stopped for
4160 * any reason then job->printer will be reset to NULL, so make sure we have
4161 * a valid pointer...
4164 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
4165 message
, sizeof(message
))) != NULL
)
4168 * Process page and printer state messages as needed...
4171 if (loglevel
== CUPSD_LOG_PAGE
)
4174 * Page message; send the message to the page_log file and update the
4175 * job sheet count...
4178 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PAGE: %s", message
);
4182 if (!strncasecmp(message
, "total ", 6))
4185 * Got a total count of pages from a backend or filter...
4188 copies
= atoi(message
+ 6);
4189 copies
-= job
->sheets
->values
[0].integer
; /* Just track the delta */
4191 else if (!sscanf(message
, "%*d%d", &copies
))
4194 job
->sheets
->values
[0].integer
+= copies
;
4196 if (job
->printer
->page_limit
)
4197 cupsdUpdateQuota(job
->printer
, job
->username
, copies
, 0);
4200 cupsdLogPage(job
, message
);
4203 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4204 "Printed %d page(s).", job
->sheets
->values
[0].integer
);
4206 else if (loglevel
== CUPSD_LOG_STATE
)
4208 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "STATE: %s", message
);
4210 if (!strcmp(message
, "paused"))
4212 cupsdStopPrinter(job
->printer
, 1);
4215 else if (cupsdSetPrinterReasons(job
->printer
, message
))
4216 event
|= CUPSD_EVENT_PRINTER_STATE
;
4218 update_job_attrs(job
, 0);
4220 else if (loglevel
== CUPSD_LOG_ATTR
)
4223 * Set attribute(s)...
4226 int num_attrs
; /* Number of attributes */
4227 cups_option_t
*attrs
; /* Attributes */
4228 const char *attr
; /* Attribute */
4231 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "ATTR: %s", message
);
4233 num_attrs
= cupsParseOptions(message
, 0, &attrs
);
4235 if ((attr
= cupsGetOption("auth-info-required", num_attrs
,
4238 cupsdSetAuthInfoRequired(job
->printer
, attr
, NULL
);
4239 cupsdSetPrinterAttrs(job
->printer
);
4241 if (job
->printer
->type
& CUPS_PRINTER_DISCOVERED
)
4242 cupsdMarkDirty(CUPSD_DIRTY_REMOTE
);
4244 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4247 if ((attr
= cupsGetOption("job-media-progress", num_attrs
,
4250 int progress
= atoi(attr
);
4253 if (progress
>= 0 && progress
<= 100)
4255 job
->progress
= progress
;
4258 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4259 "Printing page %d, %d%%",
4260 job
->sheets
->values
[0].integer
, job
->progress
);
4264 if ((attr
= cupsGetOption("printer-alert", num_attrs
, attrs
)) != NULL
)
4266 cupsdSetString(&job
->printer
->alert
, attr
);
4267 event
|= CUPSD_EVENT_PRINTER_STATE
;
4270 if ((attr
= cupsGetOption("printer-alert-description", num_attrs
,
4273 cupsdSetString(&job
->printer
->alert_description
, attr
);
4274 event
|= CUPSD_EVENT_PRINTER_STATE
;
4277 if ((attr
= cupsGetOption("marker-colors", num_attrs
, attrs
)) != NULL
)
4279 cupsdSetPrinterAttr(job
->printer
, "marker-colors", (char *)attr
);
4280 job
->printer
->marker_time
= time(NULL
);
4281 event
|= CUPSD_EVENT_PRINTER_STATE
;
4282 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4285 if ((attr
= cupsGetOption("marker-levels", num_attrs
, attrs
)) != NULL
)
4287 cupsdSetPrinterAttr(job
->printer
, "marker-levels", (char *)attr
);
4288 job
->printer
->marker_time
= time(NULL
);
4289 event
|= CUPSD_EVENT_PRINTER_STATE
;
4290 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4293 if ((attr
= cupsGetOption("marker-low-levels", num_attrs
, attrs
)) != NULL
)
4295 cupsdSetPrinterAttr(job
->printer
, "marker-low-levels", (char *)attr
);
4296 job
->printer
->marker_time
= time(NULL
);
4297 event
|= CUPSD_EVENT_PRINTER_STATE
;
4298 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4301 if ((attr
= cupsGetOption("marker-high-levels", num_attrs
, attrs
)) != NULL
)
4303 cupsdSetPrinterAttr(job
->printer
, "marker-high-levels", (char *)attr
);
4304 job
->printer
->marker_time
= time(NULL
);
4305 event
|= CUPSD_EVENT_PRINTER_STATE
;
4306 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4309 if ((attr
= cupsGetOption("marker-message", num_attrs
, attrs
)) != NULL
)
4311 cupsdSetPrinterAttr(job
->printer
, "marker-message", (char *)attr
);
4312 job
->printer
->marker_time
= time(NULL
);
4313 event
|= CUPSD_EVENT_PRINTER_STATE
;
4314 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4317 if ((attr
= cupsGetOption("marker-names", num_attrs
, attrs
)) != NULL
)
4319 cupsdSetPrinterAttr(job
->printer
, "marker-names", (char *)attr
);
4320 job
->printer
->marker_time
= time(NULL
);
4321 event
|= CUPSD_EVENT_PRINTER_STATE
;
4322 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4325 if ((attr
= cupsGetOption("marker-types", num_attrs
, attrs
)) != NULL
)
4327 cupsdSetPrinterAttr(job
->printer
, "marker-types", (char *)attr
);
4328 job
->printer
->marker_time
= time(NULL
);
4329 event
|= CUPSD_EVENT_PRINTER_STATE
;
4330 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS
);
4333 cupsFreeOptions(num_attrs
, attrs
);
4335 else if (loglevel
== CUPSD_LOG_PPD
)
4338 * Set attribute(s)...
4341 int num_keywords
; /* Number of keywords */
4342 cups_option_t
*keywords
; /* Keywords */
4345 cupsdLogJob(job
, CUPSD_LOG_DEBUG
, "PPD: %s", message
);
4347 num_keywords
= cupsParseOptions(message
, 0, &keywords
);
4349 if (cupsdUpdatePrinterPPD(job
->printer
, num_keywords
, keywords
))
4350 cupsdSetPrinterAttrs(job
->printer
);
4352 cupsFreeOptions(num_keywords
, keywords
);
4357 * Strip legacy message prefix...
4360 if (!strncmp(message
, "recoverable:", 12))
4363 while (isspace(*ptr
& 255))
4366 else if (!strncmp(message
, "recovered:", 10))
4369 while (isspace(*ptr
& 255))
4375 cupsdLogJob(job
, loglevel
, "%s", ptr
);
4377 if (loglevel
< CUPSD_LOG_DEBUG
&&
4378 strcmp(job
->printer
->state_message
, ptr
))
4380 strlcpy(job
->printer
->state_message
, ptr
,
4381 sizeof(job
->printer
->state_message
));
4383 event
|= CUPSD_EVENT_PRINTER_STATE
| CUPSD_EVENT_JOB_PROGRESS
;
4385 if (loglevel
<= job
->status_level
&& job
->status_level
> CUPSD_LOG_ERROR
)
4388 * Some messages show in the job-printer-state-message attribute...
4391 if (loglevel
!= CUPSD_LOG_NOTICE
)
4392 job
->status_level
= loglevel
;
4394 update_job_attrs(job
, 1);
4396 cupsdLogJob(job
, CUPSD_LOG_DEBUG
,
4397 "Set job-printer-state-message to \"%s\", "
4399 job
->printer_message
->values
[0].string
.text
,
4400 levels
[job
->status_level
]);
4405 if (!strchr(job
->status_buffer
->buffer
, '\n'))
4409 if (event
& CUPSD_EVENT_JOB_PROGRESS
)
4410 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
4411 "%s", job
->printer
->state_message
);
4412 if (event
& CUPSD_EVENT_PRINTER_STATE
)
4413 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE
, job
->printer
, NULL
,
4414 (job
->printer
->type
& CUPS_PRINTER_CLASS
) ?
4415 "Class \"%s\" state changed." :
4416 "Printer \"%s\" state changed.",
4417 job
->printer
->name
);
4420 if (ptr
== NULL
&& !job
->status_buffer
->bufused
)
4423 * See if all of the filters and the backend have returned their
4427 for (i
= 0; job
->filters
[i
] < 0; i
++);
4429 if (job
->filters
[i
])
4432 * EOF but we haven't collected the exit status of all filters...
4435 cupsdCheckProcess();
4439 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
4442 * EOF but we haven't collected the exit status of the backend...
4445 cupsdCheckProcess();
4450 * Handle the end of job stuff...
4453 finalize_job(job
, 1);
4456 * Check for new jobs...
4465 * 'update_job_attrs()' - Update the job-printer-* attributes.
4469 update_job_attrs(cupsd_job_t
*job
, /* I - Job to update */
4470 int do_message
)/* I - 1 = copy job-printer-state message */
4472 int i
; /* Looping var */
4473 int num_reasons
; /* Actual number of reasons */
4474 const char * const *reasons
; /* Reasons */
4475 static const char *none
= "none"; /* "none" reason */
4479 * Get/create the job-printer-state-* attributes...
4482 if (!job
->printer_message
)
4484 if ((job
->printer_message
= ippFindAttribute(job
->attrs
,
4485 "job-printer-state-message",
4486 IPP_TAG_TEXT
)) == NULL
)
4487 job
->printer_message
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
4488 "job-printer-state-message",
4492 if (!job
->printer_reasons
)
4493 job
->printer_reasons
= ippFindAttribute(job
->attrs
,
4494 "job-printer-state-reasons",
4498 * Copy or clear the printer-state-message value as needed...
4501 if (job
->state_value
!= IPP_JOB_PROCESSING
&&
4502 job
->status_level
== CUPSD_LOG_INFO
)
4503 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
), "");
4504 else if (job
->printer
->state_message
[0] && do_message
)
4505 cupsdSetString(&(job
->printer_message
->values
[0].string
.text
),
4506 job
->printer
->state_message
);
4509 * ... and the printer-state-reasons value...
4512 if (job
->printer
->num_reasons
== 0)
4519 num_reasons
= job
->printer
->num_reasons
;
4520 reasons
= (const char * const *)job
->printer
->reasons
;
4523 if (!job
->printer_reasons
|| job
->printer_reasons
->num_values
!= num_reasons
)
4526 * Replace/create a job-printer-state-reasons attribute...
4529 ippDeleteAttribute(job
->attrs
, job
->printer_reasons
);
4531 job
->printer_reasons
= ippAddStrings(job
->attrs
,
4532 IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
4533 "job-printer-state-reasons",
4534 num_reasons
, NULL
, NULL
);
4539 * Don't bother clearing the reason strings if they are the same...
4542 for (i
= 0; i
< num_reasons
; i
++)
4543 if (strcmp(job
->printer_reasons
->values
[i
].string
.text
, reasons
[i
]))
4546 if (i
>= num_reasons
)
4550 * Not the same, so free the current strings...
4553 for (i
= 0; i
< num_reasons
; i
++)
4554 _cupsStrFree(job
->printer_reasons
->values
[i
].string
.text
);
4558 * Copy the reasons...
4561 for (i
= 0; i
< num_reasons
; i
++)
4562 job
->printer_reasons
->values
[i
].string
.text
= _cupsStrAlloc(reasons
[i
]);
4567 * End of "$Id: job.c 7902 2008-09-03 14:20:17Z mike $".