]> git.ipfire.org Git - thirdparty/cups.git/blob - scheduler/job.c
<rdar://problem/15939788> Improve CUPS sandboxing
[thirdparty/cups.git] / scheduler / job.c
1 /*
2 * "$Id$"
3 *
4 * Job management routines for the CUPS scheduler.
5 *
6 * Copyright 2007-2014 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
8 *
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/".
14 */
15
16 /*
17 * Include necessary headers...
18 */
19
20 #include "cupsd.h"
21 #include <grp.h>
22 #include <cups/backend.h>
23 #include <cups/dir.h>
24 #ifdef __APPLE__
25 # include <IOKit/pwr_mgt/IOPMLib.h>
26 # ifdef HAVE_IOKIT_PWR_MGT_IOPMLIBPRIVATE_H
27 # include <IOKit/pwr_mgt/IOPMLibPrivate.h>
28 # endif /* HAVE_IOKIT_PWR_MGT_IOPMLIBPRIVATE_H */
29 #endif /* __APPLE__ */
30
31
32 /*
33 * Design Notes for Job Management
34 * -------------------------------
35 *
36 * STATE CHANGES
37 *
38 * pending Do nothing/check jobs
39 * pending-held Send SIGTERM to filters and backend
40 * processing Do nothing/start job
41 * stopped Send SIGKILL to filters and backend
42 * canceled Send SIGTERM to filters and backend
43 * aborted Finalize
44 * completed Finalize
45 *
46 * Finalize clears the printer <-> job association, deletes the status
47 * buffer, closes all of the pipes, etc. and doesn't get run until all of
48 * the print processes are finished.
49 *
50 * UNLOADING OF JOBS (cupsdUnloadCompletedJobs)
51 *
52 * We unload the job attributes when they are not needed to reduce overall
53 * memory consumption. We don't unload jobs where job->state_value <
54 * IPP_JOB_STOPPED, job->printer != NULL, or job->access_time is recent.
55 *
56 * STARTING OF JOBS (start_job)
57 *
58 * When a job is started, a status buffer, several pipes, a security
59 * profile, and a backend process are created for the life of that job.
60 * These are shared for every file in a job. For remote print jobs, the
61 * IPP backend is provided with every file in the job and no filters are
62 * run.
63 *
64 * The job->printer member tracks which printer is printing a job, which
65 * can be different than the destination in job->dest for classes. The
66 * printer object also has a job pointer to track which job is being
67 * printed.
68 *
69 * PRINTING OF JOB FILES (cupsdContinueJob)
70 *
71 * Each file in a job is filtered by 0 or more programs. After getting the
72 * list of filters needed and the total cost, the job is either passed or
73 * put back to the processing state until the current FilterLevel comes down
74 * enough to allow printing.
75 *
76 * If we can print, we build a string for the print options and run each of
77 * the filters, piping the output from one into the next.
78 *
79 * JOB STATUS UPDATES (update_job)
80 *
81 * The update_job function gets called whenever there are pending messages
82 * on the status pipe. These generally are updates to the marker-*,
83 * printer-state-message, or printer-state-reasons attributes. On EOF,
84 * finalize_job is called to clean up.
85 *
86 * FINALIZING JOBS (finalize_job)
87 *
88 * When all filters and the backend are done, we set the job state to
89 * completed (no errors), aborted (filter errors or abort-job policy),
90 * pending-held (auth required or retry-job policy), or pending
91 * (retry-current-job or stop-printer policies) as appropriate.
92 *
93 * Then we close the pipes and free the status buffers and profiles.
94 *
95 * JOB FILE COMPLETION (process_children in main.c)
96 *
97 * For multiple-file jobs, process_children (in main.c) sees that all
98 * filters have exited and calls in to print the next file if there are
99 * more files in the job, otherwise it waits for the backend to exit and
100 * update_job to do the cleanup.
101 */
102
103
104 /*
105 * Local globals...
106 */
107
108 static mime_filter_t gziptoany_filter =
109 {
110 NULL, /* Source type */
111 NULL, /* Destination type */
112 0, /* Cost */
113 "gziptoany" /* Filter program to run */
114 };
115
116
117 /*
118 * Local functions...
119 */
120
121 static int compare_active_jobs(void *first, void *second, void *data);
122 static int compare_jobs(void *first, void *second, void *data);
123 static void dump_job_history(cupsd_job_t *job);
124 static void finalize_job(cupsd_job_t *job, int set_job_state);
125 static void free_job_history(cupsd_job_t *job);
126 static char *get_options(cupsd_job_t *job, int banner_page, char *copies,
127 size_t copies_size, char *title,
128 size_t title_size);
129 static size_t ipp_length(ipp_t *ipp);
130 static void load_job_cache(const char *filename);
131 static void load_next_job_id(const char *filename);
132 static void load_request_root(void);
133 static void remove_job_files(cupsd_job_t *job);
134 static void remove_job_history(cupsd_job_t *job);
135 static void set_time(cupsd_job_t *job, const char *name);
136 static void start_job(cupsd_job_t *job, cupsd_printer_t *printer);
137 static void stop_job(cupsd_job_t *job, cupsd_jobaction_t action);
138 static void unload_job(cupsd_job_t *job);
139 static void update_job(cupsd_job_t *job);
140 static void update_job_attrs(cupsd_job_t *job, int do_message);
141
142
143 /*
144 * 'cupsdAddJob()' - Add a new job to the job queue.
145 */
146
147 cupsd_job_t * /* O - New job record */
148 cupsdAddJob(int priority, /* I - Job priority */
149 const char *dest) /* I - Job destination */
150 {
151 cupsd_job_t *job; /* New job record */
152
153
154 if ((job = calloc(sizeof(cupsd_job_t), 1)) == NULL)
155 return (NULL);
156
157 job->id = NextJobId ++;
158 job->priority = priority;
159 job->back_pipes[0] = -1;
160 job->back_pipes[1] = -1;
161 job->print_pipes[0] = -1;
162 job->print_pipes[1] = -1;
163 job->side_pipes[0] = -1;
164 job->side_pipes[1] = -1;
165 job->status_pipes[0] = -1;
166 job->status_pipes[1] = -1;
167
168 cupsdSetString(&job->dest, dest);
169
170 /*
171 * Add the new job to the "all jobs" and "active jobs" lists...
172 */
173
174 cupsArrayAdd(Jobs, job);
175 cupsArrayAdd(ActiveJobs, job);
176
177 return (job);
178 }
179
180
181 /*
182 * 'cupsdCancelJobs()' - Cancel all jobs for the given destination/user.
183 */
184
185 void
186 cupsdCancelJobs(const char *dest, /* I - Destination to cancel */
187 const char *username, /* I - Username or NULL */
188 int purge) /* I - Purge jobs? */
189 {
190 cupsd_job_t *job; /* Current job */
191
192
193 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
194 job;
195 job = (cupsd_job_t *)cupsArrayNext(Jobs))
196 {
197 if ((!job->dest || !job->username) && !cupsdLoadJob(job))
198 continue;
199
200 if ((!dest || !strcmp(job->dest, dest)) &&
201 (!username || !strcmp(job->username, username)))
202 {
203 /*
204 * Cancel all jobs matching this destination/user...
205 */
206
207 if (purge)
208 cupsdSetJobState(job, IPP_JOB_CANCELED, CUPSD_JOB_PURGE,
209 "Job purged by user.");
210 else if (job->state_value < IPP_JOB_CANCELED)
211 cupsdSetJobState(job, IPP_JOB_CANCELED, CUPSD_JOB_DEFAULT,
212 "Job canceled by user.");
213 }
214 }
215
216 cupsdCheckJobs();
217 }
218
219
220 /*
221 * 'cupsdCheckJobs()' - Check the pending jobs and start any if the destination
222 * is available.
223 */
224
225 void
226 cupsdCheckJobs(void)
227 {
228 cupsd_job_t *job; /* Current job in queue */
229 cupsd_printer_t *printer, /* Printer destination */
230 *pclass; /* Printer class destination */
231 ipp_attribute_t *attr; /* Job attribute */
232 time_t curtime; /* Current time */
233
234
235 curtime = time(NULL);
236
237 cupsdLogMessage(CUPSD_LOG_DEBUG2,
238 "cupsdCheckJobs: %d active jobs, sleeping=%d, reload=%d, "
239 "curtime=%ld", cupsArrayCount(ActiveJobs), Sleeping,
240 NeedReload, (long)curtime);
241
242 for (job = (cupsd_job_t *)cupsArrayFirst(ActiveJobs);
243 job;
244 job = (cupsd_job_t *)cupsArrayNext(ActiveJobs))
245 {
246 cupsdLogMessage(CUPSD_LOG_DEBUG2,
247 "cupsdCheckJobs: Job %d - dest=\"%s\", printer=%p, "
248 "state=%d, cancel_time=%ld, hold_until=%ld, kill_time=%ld, "
249 "pending_cost=%d, pending_timeout=%ld", job->id, job->dest,
250 job->printer, job->state_value, (long)job->cancel_time,
251 (long)job->hold_until, (long)job->kill_time,
252 job->pending_cost, (long)job->pending_timeout);
253
254 /*
255 * Kill jobs if they are unresponsive...
256 */
257
258 if (job->kill_time && job->kill_time <= curtime)
259 {
260 if (!job->completed)
261 cupsdLogJob(job, CUPSD_LOG_ERROR, "Stopping unresponsive job.");
262
263 stop_job(job, CUPSD_JOB_FORCE);
264 continue;
265 }
266
267 /*
268 * Cancel stuck jobs...
269 */
270
271 if (job->cancel_time && job->cancel_time <= curtime)
272 {
273 int cancel_after; /* job-cancel-after value */
274
275 attr = ippFindAttribute(job->attrs, "job-cancel-after", IPP_TAG_INTEGER);
276 cancel_after = attr ? ippGetInteger(attr, 0) : MaxJobTime;
277
278 if (job->completed)
279 cupsdSetJobState(job, IPP_JOB_CANCELED, CUPSD_JOB_FORCE, "Marking stuck job as completed after %d seconds.", cancel_after);
280 else
281 cupsdSetJobState(job, IPP_JOB_CANCELED, CUPSD_JOB_DEFAULT, "Canceling stuck job after %d seconds.", cancel_after);
282 continue;
283 }
284
285 /*
286 * Start held jobs if they are ready...
287 */
288
289 if (job->state_value == IPP_JOB_HELD &&
290 job->hold_until &&
291 job->hold_until < curtime)
292 {
293 if (job->pending_timeout)
294 {
295 /*
296 * This job is pending; check that we don't have an active Send-Document
297 * operation in progress on any of the client connections, then timeout
298 * the job so we can start printing...
299 */
300
301 cupsd_client_t *con; /* Current client connection */
302
303 for (con = (cupsd_client_t *)cupsArrayFirst(Clients);
304 con;
305 con = (cupsd_client_t *)cupsArrayNext(Clients))
306 if (con->request &&
307 con->request->request.op.operation_id == IPP_SEND_DOCUMENT)
308 break;
309
310 if (con)
311 continue;
312
313 if (cupsdTimeoutJob(job))
314 continue;
315 }
316
317 cupsdSetJobState(job, IPP_JOB_PENDING, CUPSD_JOB_DEFAULT,
318 "Job submission timed out.");
319 }
320
321 /*
322 * Continue jobs that are waiting on the FilterLimit...
323 */
324
325 if (job->pending_cost > 0 &&
326 ((FilterLevel + job->pending_cost) < FilterLimit || FilterLevel == 0))
327 cupsdContinueJob(job);
328
329 /*
330 * Start pending jobs if the destination is available...
331 */
332
333 if (job->state_value == IPP_JOB_PENDING && !NeedReload &&
334 !Sleeping && !DoingShutdown && !job->printer)
335 {
336 printer = cupsdFindDest(job->dest);
337 pclass = NULL;
338
339 while (printer && (printer->type & CUPS_PRINTER_CLASS))
340 {
341 /*
342 * If the class is remote, just pass it to the remote server...
343 */
344
345 pclass = printer;
346
347 if (pclass->state == IPP_PRINTER_STOPPED)
348 printer = NULL;
349 else if (pclass->type & CUPS_PRINTER_REMOTE)
350 break;
351 else
352 printer = cupsdFindAvailablePrinter(printer->name);
353 }
354
355 if (!printer && !pclass)
356 {
357 /*
358 * Whoa, the printer and/or class for this destination went away;
359 * cancel the job...
360 */
361
362 cupsdSetJobState(job, IPP_JOB_ABORTED, CUPSD_JOB_PURGE,
363 "Job aborted because the destination printer/class "
364 "has gone away.");
365 }
366 else if (printer && !printer->holding_new_jobs)
367 {
368 /*
369 * See if the printer is available or remote and not printing a job;
370 * if so, start the job...
371 */
372
373 if (pclass)
374 {
375 /*
376 * Add/update a job-actual-printer-uri attribute for this job
377 * so that we know which printer actually printed the job...
378 */
379
380 if ((attr = ippFindAttribute(job->attrs, "job-actual-printer-uri",
381 IPP_TAG_URI)) != NULL)
382 cupsdSetString(&attr->values[0].string.text, printer->uri);
383 else
384 ippAddString(job->attrs, IPP_TAG_JOB, IPP_TAG_URI,
385 "job-actual-printer-uri", NULL, printer->uri);
386
387 job->dirty = 1;
388 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
389 }
390
391 if (!printer->job && printer->state == IPP_PRINTER_IDLE)
392 {
393 /*
394 * Start the job...
395 */
396
397 start_job(job, printer);
398 }
399 }
400 }
401 }
402 }
403
404
405 /*
406 * 'cupsdCleanJobs()' - Clean out old jobs.
407 */
408
409 void
410 cupsdCleanJobs(void)
411 {
412 cupsd_job_t *job; /* Current job */
413 time_t curtime; /* Current time */
414
415
416 cupsdLogMessage(CUPSD_LOG_DEBUG2,
417 "cupsdCleanJobs: MaxJobs=%d, JobHistory=%d, JobFiles=%d",
418 MaxJobs, JobHistory, JobFiles);
419
420 if (MaxJobs <= 0 && JobHistory == INT_MAX && JobFiles == INT_MAX)
421 return;
422
423 curtime = time(NULL);
424 JobHistoryUpdate = 0;
425
426 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
427 job;
428 job = (cupsd_job_t *)cupsArrayNext(Jobs))
429 {
430 if (job->state_value >= IPP_JOB_CANCELED && !job->printer)
431 {
432 /*
433 * Expire old jobs (or job files)...
434 */
435
436 if ((MaxJobs > 0 && cupsArrayCount(Jobs) >= MaxJobs) ||
437 (job->history_time && job->history_time <= curtime))
438 {
439 cupsdLogJob(job, CUPSD_LOG_DEBUG, "Removing from history.");
440 cupsdDeleteJob(job, CUPSD_JOB_PURGE);
441 }
442 else if (job->file_time && job->file_time <= curtime)
443 {
444 cupsdLogJob(job, CUPSD_LOG_DEBUG, "Removing document files.");
445 remove_job_files(job);
446
447 if (job->history_time < JobHistoryUpdate || !JobHistoryUpdate)
448 JobHistoryUpdate = job->history_time;
449 }
450 else
451 {
452 if (job->history_time < JobHistoryUpdate || !JobHistoryUpdate)
453 JobHistoryUpdate = job->history_time;
454
455 if (job->file_time < JobHistoryUpdate || !JobHistoryUpdate)
456 JobHistoryUpdate = job->file_time;
457 }
458 }
459 }
460
461 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdCleanJobs: JobHistoryUpdate=%ld",
462 (long)JobHistoryUpdate);
463 }
464
465
466 /*
467 * 'cupsdContinueJob()' - Continue printing with the next file in a job.
468 */
469
470 void
471 cupsdContinueJob(cupsd_job_t *job) /* I - Job */
472 {
473 int i; /* Looping var */
474 int slot; /* Pipe slot */
475 cups_array_t *filters = NULL,/* Filters for job */
476 *prefilters; /* Filters with prefilters */
477 mime_filter_t *filter, /* Current filter */
478 *prefilter, /* Prefilter */
479 port_monitor; /* Port monitor filter */
480 char scheme[255]; /* Device URI scheme */
481 ipp_attribute_t *attr; /* Current attribute */
482 const char *ptr, /* Pointer into value */
483 *abort_message; /* Abort message */
484 ipp_jstate_t abort_state = IPP_JOB_STOPPED;
485 /* New job state on abort */
486 struct stat backinfo; /* Backend file information */
487 int backroot; /* Run backend as root? */
488 int pid; /* Process ID of new filter process */
489 int banner_page; /* 1 if banner page, 0 otherwise */
490 int filterfds[2][2] = { { -1, -1 }, { -1, -1 } };
491 /* Pipes used between filters */
492 int envc; /* Number of environment variables */
493 struct stat fileinfo; /* Job file information */
494 int argc; /* Number of arguments */
495 char **argv = NULL, /* Filter command-line arguments */
496 filename[1024], /* Job filename */
497 command[1024], /* Full path to command */
498 jobid[255], /* Job ID string */
499 title[IPP_MAX_NAME],
500 /* Job title string */
501 copies[255], /* # copies string */
502 *options, /* Options string */
503 *envp[MAX_ENV + 21],
504 /* Environment variables */
505 charset[255], /* CHARSET env variable */
506 class_name[255],/* CLASS env variable */
507 classification[1024],
508 /* CLASSIFICATION env variable */
509 content_type[1024],
510 /* CONTENT_TYPE env variable */
511 device_uri[1024],
512 /* DEVICE_URI env variable */
513 final_content_type[1024] = "",
514 /* FINAL_CONTENT_TYPE env variable */
515 lang[255], /* LANG env variable */
516 #ifdef __APPLE__
517 apple_language[255],
518 /* APPLE_LANGUAGE env variable */
519 #endif /* __APPLE__ */
520 auth_info_required[255],
521 /* AUTH_INFO_REQUIRED env variable */
522 ppd[1024], /* PPD env variable */
523 printer_info[255],
524 /* PRINTER_INFO env variable */
525 printer_location[255],
526 /* PRINTER_LOCATION env variable */
527 printer_name[255],
528 /* PRINTER env variable */
529 *printer_state_reasons = NULL,
530 /* PRINTER_STATE_REASONS env var */
531 rip_max_cache[255];
532 /* RIP_MAX_CACHE env variable */
533
534
535 cupsdLogMessage(CUPSD_LOG_DEBUG2,
536 "cupsdContinueJob(job=%p(%d)): current_file=%d, num_files=%d",
537 job, job->id, job->current_file, job->num_files);
538
539 /*
540 * Figure out what filters are required to convert from
541 * the source to the destination type...
542 */
543
544 FilterLevel -= job->cost;
545
546 job->cost = 0;
547 job->pending_cost = 0;
548
549 memset(job->filters, 0, sizeof(job->filters));
550
551 if (job->printer->raw)
552 {
553 /*
554 * Remote jobs and raw queues go directly to the printer without
555 * filtering...
556 */
557
558 cupsdLogJob(job, CUPSD_LOG_DEBUG, "Sending job to queue tagged as raw...");
559 }
560 else
561 {
562 /*
563 * Local jobs get filtered...
564 */
565
566 snprintf(filename, sizeof(filename), "%s/d%05d-%03d", RequestRoot,
567 job->id, job->current_file + 1);
568 if (stat(filename, &fileinfo))
569 fileinfo.st_size = 0;
570
571 filters = mimeFilter2(MimeDatabase, job->filetypes[job->current_file], (size_t)fileinfo.st_size, job->printer->filetype, &(job->cost));
572
573 if (!filters)
574 {
575 cupsdLogJob(job, CUPSD_LOG_ERROR,
576 "Unable to convert file %d to printable format.",
577 job->current_file);
578
579 abort_message = "Aborting job because it cannot be printed.";
580 abort_state = IPP_JOB_ABORTED;
581
582 ippSetString(job->attrs, &job->reasons, 0, "document-unprintable-error");
583 goto abort_job;
584 }
585
586 /*
587 * Figure out the final content type...
588 */
589
590 cupsdLogJob(job, CUPSD_LOG_DEBUG, "%d filters for job:",
591 cupsArrayCount(filters));
592 for (filter = (mime_filter_t *)cupsArrayFirst(filters);
593 filter;
594 filter = (mime_filter_t *)cupsArrayNext(filters))
595 cupsdLogJob(job, CUPSD_LOG_DEBUG, "%s (%s/%s to %s/%s, cost %d)",
596 filter->filter,
597 filter->src ? filter->src->super : "???",
598 filter->src ? filter->src->type : "???",
599 filter->dst ? filter->dst->super : "???",
600 filter->dst ? filter->dst->type : "???",
601 filter->cost);
602
603 if (!job->printer->remote)
604 {
605 for (filter = (mime_filter_t *)cupsArrayLast(filters);
606 filter && filter->dst;
607 filter = (mime_filter_t *)cupsArrayPrev(filters))
608 if (strcmp(filter->dst->super, "printer") ||
609 strcmp(filter->dst->type, job->printer->name))
610 break;
611
612 if (filter && filter->dst)
613 {
614 if ((ptr = strchr(filter->dst->type, '/')) != NULL)
615 snprintf(final_content_type, sizeof(final_content_type),
616 "FINAL_CONTENT_TYPE=%s", ptr + 1);
617 else
618 snprintf(final_content_type, sizeof(final_content_type),
619 "FINAL_CONTENT_TYPE=%s/%s", filter->dst->super,
620 filter->dst->type);
621 }
622 else
623 snprintf(final_content_type, sizeof(final_content_type),
624 "FINAL_CONTENT_TYPE=printer/%s", job->printer->name);
625 }
626
627 /*
628 * Remove NULL ("-") filters...
629 */
630
631 for (filter = (mime_filter_t *)cupsArrayFirst(filters);
632 filter;
633 filter = (mime_filter_t *)cupsArrayNext(filters))
634 if (!strcmp(filter->filter, "-"))
635 cupsArrayRemove(filters, filter);
636
637 if (cupsArrayCount(filters) == 0)
638 {
639 cupsArrayDelete(filters);
640 filters = NULL;
641 }
642
643 /*
644 * If this printer has any pre-filters, insert the required pre-filter
645 * in the filters array...
646 */
647
648 if (job->printer->prefiltertype && filters)
649 {
650 prefilters = cupsArrayNew(NULL, NULL);
651
652 for (filter = (mime_filter_t *)cupsArrayFirst(filters);
653 filter;
654 filter = (mime_filter_t *)cupsArrayNext(filters))
655 {
656 if ((prefilter = mimeFilterLookup(MimeDatabase, filter->src,
657 job->printer->prefiltertype)))
658 {
659 cupsArrayAdd(prefilters, prefilter);
660 job->cost += prefilter->cost;
661 }
662
663 cupsArrayAdd(prefilters, filter);
664 }
665
666 cupsArrayDelete(filters);
667 filters = prefilters;
668 }
669 }
670
671 /*
672 * Set a minimum cost of 100 for all jobs so that FilterLimit
673 * works with raw queues and other low-cost paths.
674 */
675
676 if (job->cost < 100)
677 job->cost = 100;
678
679 /*
680 * See if the filter cost is too high...
681 */
682
683 if ((FilterLevel + job->cost) > FilterLimit && FilterLevel > 0 &&
684 FilterLimit > 0)
685 {
686 /*
687 * Don't print this job quite yet...
688 */
689
690 cupsArrayDelete(filters);
691
692 cupsdLogJob(job, CUPSD_LOG_INFO,
693 "Holding because filter limit has been reached.");
694 cupsdLogJob(job, CUPSD_LOG_DEBUG2,
695 "cupsdContinueJob: file=%d, cost=%d, level=%d, limit=%d",
696 job->current_file, job->cost, FilterLevel,
697 FilterLimit);
698
699 job->pending_cost = job->cost;
700 job->cost = 0;
701 return;
702 }
703
704 FilterLevel += job->cost;
705
706 /*
707 * Add decompression/raw filter as needed...
708 */
709
710 if (job->compressions[job->current_file] &&
711 (!job->printer->remote || job->num_files == 1))
712 {
713 /*
714 * Add gziptoany filter to the front of the list...
715 */
716
717 if (!filters)
718 filters = cupsArrayNew(NULL, NULL);
719
720 if (!cupsArrayInsert(filters, &gziptoany_filter))
721 {
722 cupsdLogJob(job, CUPSD_LOG_DEBUG,
723 "Unable to add decompression filter - %s", strerror(errno));
724
725 cupsArrayDelete(filters);
726
727 abort_message = "Stopping job because the scheduler ran out of memory.";
728
729 goto abort_job;
730 }
731 }
732
733 /*
734 * Add port monitor, if any...
735 */
736
737 if (job->printer->port_monitor)
738 {
739 /*
740 * Add port monitor to the end of the list...
741 */
742
743 if (!filters)
744 filters = cupsArrayNew(NULL, NULL);
745
746 port_monitor.src = NULL;
747 port_monitor.dst = NULL;
748 port_monitor.cost = 0;
749
750 snprintf(port_monitor.filter, sizeof(port_monitor.filter),
751 "%s/monitor/%s", ServerBin, job->printer->port_monitor);
752
753 if (!cupsArrayAdd(filters, &port_monitor))
754 {
755 cupsdLogJob(job, CUPSD_LOG_DEBUG,
756 "Unable to add port monitor - %s", strerror(errno));
757
758 abort_message = "Stopping job because the scheduler ran out of memory.";
759
760 goto abort_job;
761 }
762 }
763
764 /*
765 * Make sure we don't go over the "MAX_FILTERS" limit...
766 */
767
768 if (cupsArrayCount(filters) > MAX_FILTERS)
769 {
770 cupsdLogJob(job, CUPSD_LOG_DEBUG,
771 "Too many filters (%d > %d), unable to print.",
772 cupsArrayCount(filters), MAX_FILTERS);
773
774 abort_message = "Aborting job because it needs too many filters to print.";
775 abort_state = IPP_JOB_ABORTED;
776
777 ippSetString(job->attrs, &job->reasons, 0, "document-unprintable-error");
778
779 goto abort_job;
780 }
781
782 /*
783 * Determine if we are printing a banner page or not...
784 */
785
786 if (job->job_sheets == NULL)
787 {
788 cupsdLogJob(job, CUPSD_LOG_DEBUG, "No job-sheets attribute.");
789 if ((job->job_sheets =
790 ippFindAttribute(job->attrs, "job-sheets", IPP_TAG_ZERO)) != NULL)
791 cupsdLogJob(job, CUPSD_LOG_DEBUG,
792 "... but someone added one without setting job_sheets.");
793 }
794 else if (job->job_sheets->num_values == 1)
795 cupsdLogJob(job, CUPSD_LOG_DEBUG, "job-sheets=%s",
796 job->job_sheets->values[0].string.text);
797 else
798 cupsdLogJob(job, CUPSD_LOG_DEBUG, "job-sheets=%s,%s",
799 job->job_sheets->values[0].string.text,
800 job->job_sheets->values[1].string.text);
801
802 if (job->printer->type & CUPS_PRINTER_REMOTE)
803 banner_page = 0;
804 else if (job->job_sheets == NULL)
805 banner_page = 0;
806 else if (_cups_strcasecmp(job->job_sheets->values[0].string.text, "none") != 0 &&
807 job->current_file == 0)
808 banner_page = 1;
809 else if (job->job_sheets->num_values > 1 &&
810 _cups_strcasecmp(job->job_sheets->values[1].string.text, "none") != 0 &&
811 job->current_file == (job->num_files - 1))
812 banner_page = 1;
813 else
814 banner_page = 0;
815
816 if ((options = get_options(job, banner_page, copies, sizeof(copies), title,
817 sizeof(title))) == NULL)
818 {
819 abort_message = "Stopping job because the scheduler ran out of memory.";
820
821 goto abort_job;
822 }
823
824 /*
825 * Build the command-line arguments for the filters. Each filter
826 * has 6 or 7 arguments:
827 *
828 * argv[0] = printer
829 * argv[1] = job ID
830 * argv[2] = username
831 * argv[3] = title
832 * argv[4] = # copies
833 * argv[5] = options
834 * argv[6] = filename (optional; normally stdin)
835 *
836 * This allows legacy printer drivers that use the old System V
837 * printing interface to be used by CUPS.
838 *
839 * For remote jobs, we send all of the files in the argument list.
840 */
841
842 if (job->printer->remote)
843 argc = 6 + job->num_files;
844 else
845 argc = 7;
846
847 if ((argv = calloc((size_t)argc + 1, sizeof(char *))) == NULL)
848 {
849 cupsdLogMessage(CUPSD_LOG_DEBUG, "Unable to allocate argument array - %s",
850 strerror(errno));
851
852 abort_message = "Stopping job because the scheduler ran out of memory.";
853
854 goto abort_job;
855 }
856
857 sprintf(jobid, "%d", job->id);
858
859 argv[0] = job->printer->name;
860 argv[1] = jobid;
861 argv[2] = job->username;
862 argv[3] = title;
863 argv[4] = copies;
864 argv[5] = options;
865
866 if (job->printer->remote && job->num_files > 1)
867 {
868 for (i = 0; i < job->num_files; i ++)
869 {
870 snprintf(filename, sizeof(filename), "%s/d%05d-%03d", RequestRoot,
871 job->id, i + 1);
872 argv[6 + i] = strdup(filename);
873 }
874 }
875 else
876 {
877 snprintf(filename, sizeof(filename), "%s/d%05d-%03d", RequestRoot,
878 job->id, job->current_file + 1);
879 argv[6] = strdup(filename);
880 }
881
882 for (i = 0; argv[i]; i ++)
883 cupsdLogJob(job, CUPSD_LOG_DEBUG, "argv[%d]=\"%s\"", i, argv[i]);
884
885 /*
886 * Create environment variable strings for the filters...
887 */
888
889 attr = ippFindAttribute(job->attrs, "attributes-natural-language",
890 IPP_TAG_LANGUAGE);
891
892 #ifdef __APPLE__
893 strlcpy(apple_language, "APPLE_LANGUAGE=", sizeof(apple_language));
894 _cupsAppleLanguage(attr->values[0].string.text,
895 apple_language + 15, sizeof(apple_language) - 15);
896 #endif /* __APPLE__ */
897
898 switch (strlen(attr->values[0].string.text))
899 {
900 default :
901 /*
902 * This is an unknown or badly formatted language code; use
903 * the POSIX locale...
904 */
905
906 strlcpy(lang, "LANG=C", sizeof(lang));
907 break;
908
909 case 2 :
910 /*
911 * Just the language code (ll)...
912 */
913
914 snprintf(lang, sizeof(lang), "LANG=%s.UTF-8",
915 attr->values[0].string.text);
916 break;
917
918 case 5 :
919 /*
920 * Language and country code (ll-cc)...
921 */
922
923 snprintf(lang, sizeof(lang), "LANG=%c%c_%c%c.UTF-8",
924 attr->values[0].string.text[0],
925 attr->values[0].string.text[1],
926 toupper(attr->values[0].string.text[3] & 255),
927 toupper(attr->values[0].string.text[4] & 255));
928 break;
929 }
930
931 if ((attr = ippFindAttribute(job->attrs, "document-format",
932 IPP_TAG_MIMETYPE)) != NULL &&
933 (ptr = strstr(attr->values[0].string.text, "charset=")) != NULL)
934 snprintf(charset, sizeof(charset), "CHARSET=%s", ptr + 8);
935 else
936 strlcpy(charset, "CHARSET=utf-8", sizeof(charset));
937
938 snprintf(content_type, sizeof(content_type), "CONTENT_TYPE=%s/%s",
939 job->filetypes[job->current_file]->super,
940 job->filetypes[job->current_file]->type);
941 snprintf(device_uri, sizeof(device_uri), "DEVICE_URI=%s",
942 job->printer->device_uri);
943 snprintf(ppd, sizeof(ppd), "PPD=%s/ppd/%s.ppd", ServerRoot,
944 job->printer->name);
945 snprintf(printer_info, sizeof(printer_name), "PRINTER_INFO=%s",
946 job->printer->info ? job->printer->info : "");
947 snprintf(printer_location, sizeof(printer_name), "PRINTER_LOCATION=%s",
948 job->printer->location ? job->printer->location : "");
949 snprintf(printer_name, sizeof(printer_name), "PRINTER=%s", job->printer->name);
950 if (job->printer->num_reasons > 0)
951 {
952 char *psrptr; /* Pointer into PRINTER_STATE_REASONS */
953 size_t psrlen; /* Size of PRINTER_STATE_REASONS */
954
955 for (psrlen = 22, i = 0; i < job->printer->num_reasons; i ++)
956 psrlen += strlen(job->printer->reasons[i]) + 1;
957
958 if ((printer_state_reasons = malloc(psrlen)) != NULL)
959 {
960 /*
961 * All of these strcpy's are safe because we allocated the psr string...
962 */
963
964 strlcpy(printer_state_reasons, "PRINTER_STATE_REASONS=", psrlen);
965 for (psrptr = printer_state_reasons + 22, i = 0;
966 i < job->printer->num_reasons;
967 i ++)
968 {
969 if (i)
970 *psrptr++ = ',';
971 strlcpy(psrptr, job->printer->reasons[i], psrlen - (size_t)(psrptr - printer_state_reasons));
972 psrptr += strlen(psrptr);
973 }
974 }
975 }
976 snprintf(rip_max_cache, sizeof(rip_max_cache), "RIP_MAX_CACHE=%s", RIPCache);
977
978 if (job->printer->num_auth_info_required == 1)
979 snprintf(auth_info_required, sizeof(auth_info_required),
980 "AUTH_INFO_REQUIRED=%s",
981 job->printer->auth_info_required[0]);
982 else if (job->printer->num_auth_info_required == 2)
983 snprintf(auth_info_required, sizeof(auth_info_required),
984 "AUTH_INFO_REQUIRED=%s,%s",
985 job->printer->auth_info_required[0],
986 job->printer->auth_info_required[1]);
987 else if (job->printer->num_auth_info_required == 3)
988 snprintf(auth_info_required, sizeof(auth_info_required),
989 "AUTH_INFO_REQUIRED=%s,%s,%s",
990 job->printer->auth_info_required[0],
991 job->printer->auth_info_required[1],
992 job->printer->auth_info_required[2]);
993 else if (job->printer->num_auth_info_required == 4)
994 snprintf(auth_info_required, sizeof(auth_info_required),
995 "AUTH_INFO_REQUIRED=%s,%s,%s,%s",
996 job->printer->auth_info_required[0],
997 job->printer->auth_info_required[1],
998 job->printer->auth_info_required[2],
999 job->printer->auth_info_required[3]);
1000 else
1001 strlcpy(auth_info_required, "AUTH_INFO_REQUIRED=none",
1002 sizeof(auth_info_required));
1003
1004 envc = cupsdLoadEnv(envp, (int)(sizeof(envp) / sizeof(envp[0])));
1005
1006 envp[envc ++] = charset;
1007 envp[envc ++] = lang;
1008 #ifdef __APPLE__
1009 envp[envc ++] = apple_language;
1010 #endif /* __APPLE__ */
1011 envp[envc ++] = ppd;
1012 envp[envc ++] = rip_max_cache;
1013 envp[envc ++] = content_type;
1014 envp[envc ++] = device_uri;
1015 envp[envc ++] = printer_info;
1016 envp[envc ++] = printer_location;
1017 envp[envc ++] = printer_name;
1018 envp[envc ++] = printer_state_reasons ? printer_state_reasons :
1019 "PRINTER_STATE_REASONS=none";
1020 envp[envc ++] = banner_page ? "CUPS_FILETYPE=job-sheet" :
1021 "CUPS_FILETYPE=document";
1022
1023 if (final_content_type[0])
1024 envp[envc ++] = final_content_type;
1025
1026 if (Classification && !banner_page)
1027 {
1028 if ((attr = ippFindAttribute(job->attrs, "job-sheets",
1029 IPP_TAG_NAME)) == NULL)
1030 snprintf(classification, sizeof(classification), "CLASSIFICATION=%s",
1031 Classification);
1032 else if (attr->num_values > 1 &&
1033 strcmp(attr->values[1].string.text, "none") != 0)
1034 snprintf(classification, sizeof(classification), "CLASSIFICATION=%s",
1035 attr->values[1].string.text);
1036 else
1037 snprintf(classification, sizeof(classification), "CLASSIFICATION=%s",
1038 attr->values[0].string.text);
1039
1040 envp[envc ++] = classification;
1041 }
1042
1043 if (job->dtype & CUPS_PRINTER_CLASS)
1044 {
1045 snprintf(class_name, sizeof(class_name), "CLASS=%s", job->dest);
1046 envp[envc ++] = class_name;
1047 }
1048
1049 envp[envc ++] = auth_info_required;
1050
1051 for (i = 0;
1052 i < (int)(sizeof(job->auth_env) / sizeof(job->auth_env[0]));
1053 i ++)
1054 if (job->auth_env[i])
1055 envp[envc ++] = job->auth_env[i];
1056 else
1057 break;
1058
1059 if (job->auth_uid)
1060 envp[envc ++] = job->auth_uid;
1061
1062 envp[envc] = NULL;
1063
1064 for (i = 0; i < envc; i ++)
1065 if (!strncmp(envp[i], "AUTH_", 5))
1066 cupsdLogJob(job, CUPSD_LOG_DEBUG, "envp[%d]=\"AUTH_%c****\"", i,
1067 envp[i][5]);
1068 else if (strncmp(envp[i], "DEVICE_URI=", 11))
1069 cupsdLogJob(job, CUPSD_LOG_DEBUG, "envp[%d]=\"%s\"", i, envp[i]);
1070 else
1071 cupsdLogJob(job, CUPSD_LOG_DEBUG, "envp[%d]=\"DEVICE_URI=%s\"", i,
1072 job->printer->sanitized_device_uri);
1073
1074 if (job->printer->remote)
1075 job->current_file = job->num_files;
1076 else
1077 job->current_file ++;
1078
1079 /*
1080 * Now create processes for all of the filters...
1081 */
1082
1083 for (i = 0, slot = 0, filter = (mime_filter_t *)cupsArrayFirst(filters);
1084 filter;
1085 i ++, filter = (mime_filter_t *)cupsArrayNext(filters))
1086 {
1087 if (filter->filter[0] != '/')
1088 snprintf(command, sizeof(command), "%s/filter/%s", ServerBin,
1089 filter->filter);
1090 else
1091 strlcpy(command, filter->filter, sizeof(command));
1092
1093 if (i < (cupsArrayCount(filters) - 1))
1094 {
1095 if (cupsdOpenPipe(filterfds[slot]))
1096 {
1097 abort_message = "Stopping job because the scheduler could not create "
1098 "the filter pipes.";
1099
1100 goto abort_job;
1101 }
1102 }
1103 else
1104 {
1105 if (job->current_file == 1 ||
1106 (job->printer->pc && job->printer->pc->single_file))
1107 {
1108 if (strncmp(job->printer->device_uri, "file:", 5) != 0)
1109 {
1110 if (cupsdOpenPipe(job->print_pipes))
1111 {
1112 abort_message = "Stopping job because the scheduler could not "
1113 "create the backend pipes.";
1114
1115 goto abort_job;
1116 }
1117 }
1118 else
1119 {
1120 job->print_pipes[0] = -1;
1121 if (!strcmp(job->printer->device_uri, "file:/dev/null") ||
1122 !strcmp(job->printer->device_uri, "file:///dev/null"))
1123 job->print_pipes[1] = -1;
1124 else
1125 {
1126 if (!strncmp(job->printer->device_uri, "file:/dev/", 10))
1127 job->print_pipes[1] = open(job->printer->device_uri + 5,
1128 O_WRONLY | O_EXCL);
1129 else if (!strncmp(job->printer->device_uri, "file:///dev/", 12))
1130 job->print_pipes[1] = open(job->printer->device_uri + 7,
1131 O_WRONLY | O_EXCL);
1132 else if (!strncmp(job->printer->device_uri, "file:///", 8))
1133 job->print_pipes[1] = open(job->printer->device_uri + 7,
1134 O_WRONLY | O_CREAT | O_TRUNC, 0600);
1135 else
1136 job->print_pipes[1] = open(job->printer->device_uri + 5,
1137 O_WRONLY | O_CREAT | O_TRUNC, 0600);
1138
1139 if (job->print_pipes[1] < 0)
1140 {
1141 abort_message = "Stopping job because the scheduler could not "
1142 "open the output file.";
1143
1144 goto abort_job;
1145 }
1146
1147 fcntl(job->print_pipes[1], F_SETFD,
1148 fcntl(job->print_pipes[1], F_GETFD) | FD_CLOEXEC);
1149 }
1150 }
1151 }
1152
1153 filterfds[slot][0] = job->print_pipes[0];
1154 filterfds[slot][1] = job->print_pipes[1];
1155 }
1156
1157 pid = cupsdStartProcess(command, argv, envp, filterfds[!slot][0],
1158 filterfds[slot][1], job->status_pipes[1],
1159 job->back_pipes[0], job->side_pipes[0], 0,
1160 job->profile, job, job->filters + i);
1161
1162 cupsdClosePipe(filterfds[!slot]);
1163
1164 if (pid == 0)
1165 {
1166 cupsdLogJob(job, CUPSD_LOG_ERROR, "Unable to start filter \"%s\" - %s.",
1167 filter->filter, strerror(errno));
1168
1169 abort_message = "Stopping job because the scheduler could not execute a "
1170 "filter.";
1171
1172 goto abort_job;
1173 }
1174
1175 cupsdLogJob(job, CUPSD_LOG_INFO, "Started filter %s (PID %d)", command,
1176 pid);
1177
1178 if (argv[6])
1179 {
1180 free(argv[6]);
1181 argv[6] = NULL;
1182 }
1183
1184 slot = !slot;
1185 }
1186
1187 cupsArrayDelete(filters);
1188 filters = NULL;
1189
1190 /*
1191 * Finally, pipe the final output into a backend process if needed...
1192 */
1193
1194 if (strncmp(job->printer->device_uri, "file:", 5) != 0)
1195 {
1196 if (job->current_file == 1 || job->printer->remote ||
1197 (job->printer->pc && job->printer->pc->single_file))
1198 {
1199 sscanf(job->printer->device_uri, "%254[^:]", scheme);
1200 snprintf(command, sizeof(command), "%s/backend/%s", ServerBin, scheme);
1201
1202 /*
1203 * See if the backend needs to run as root...
1204 */
1205
1206 if (RunUser)
1207 backroot = 0;
1208 else if (stat(command, &backinfo))
1209 backroot = 0;
1210 else
1211 backroot = !(backinfo.st_mode & (S_IRWXG | S_IRWXO));
1212
1213 argv[0] = job->printer->sanitized_device_uri;
1214
1215 filterfds[slot][0] = -1;
1216 filterfds[slot][1] = -1;
1217
1218 pid = cupsdStartProcess(command, argv, envp, filterfds[!slot][0],
1219 filterfds[slot][1], job->status_pipes[1],
1220 job->back_pipes[1], job->side_pipes[1],
1221 backroot, job->bprofile, job, &(job->backend));
1222
1223 if (pid == 0)
1224 {
1225 abort_message = "Stopping job because the sheduler could not execute "
1226 "the backend.";
1227
1228 goto abort_job;
1229 }
1230 else
1231 {
1232 cupsdLogJob(job, CUPSD_LOG_INFO, "Started backend %s (PID %d)",
1233 command, pid);
1234 }
1235 }
1236
1237 if (job->current_file == job->num_files ||
1238 (job->printer->pc && job->printer->pc->single_file))
1239 cupsdClosePipe(job->print_pipes);
1240
1241 if (job->current_file == job->num_files)
1242 {
1243 cupsdClosePipe(job->back_pipes);
1244 cupsdClosePipe(job->side_pipes);
1245
1246 close(job->status_pipes[1]);
1247 job->status_pipes[1] = -1;
1248 }
1249 }
1250 else
1251 {
1252 filterfds[slot][0] = -1;
1253 filterfds[slot][1] = -1;
1254
1255 if (job->current_file == job->num_files ||
1256 (job->printer->pc && job->printer->pc->single_file))
1257 cupsdClosePipe(job->print_pipes);
1258
1259 if (job->current_file == job->num_files)
1260 {
1261 close(job->status_pipes[1]);
1262 job->status_pipes[1] = -1;
1263 }
1264 }
1265
1266 cupsdClosePipe(filterfds[slot]);
1267
1268 for (i = 6; i < argc; i ++)
1269 if (argv[i])
1270 free(argv[i]);
1271
1272 free(argv);
1273
1274 if (printer_state_reasons)
1275 free(printer_state_reasons);
1276
1277 cupsdAddSelect(job->status_buffer->fd, (cupsd_selfunc_t)update_job, NULL,
1278 job);
1279
1280 cupsdAddEvent(CUPSD_EVENT_JOB_STATE, job->printer, job, "Job #%d started.",
1281 job->id);
1282
1283 return;
1284
1285
1286 /*
1287 * If we get here, we need to abort the current job and close out all
1288 * files and pipes...
1289 */
1290
1291 abort_job:
1292
1293 FilterLevel -= job->cost;
1294 job->cost = 0;
1295
1296 for (slot = 0; slot < 2; slot ++)
1297 cupsdClosePipe(filterfds[slot]);
1298
1299 cupsArrayDelete(filters);
1300
1301 if (argv)
1302 {
1303 for (i = 6; i < argc; i ++)
1304 if (argv[i])
1305 free(argv[i]);
1306 }
1307
1308 if (printer_state_reasons)
1309 free(printer_state_reasons);
1310
1311 cupsdClosePipe(job->print_pipes);
1312 cupsdClosePipe(job->back_pipes);
1313 cupsdClosePipe(job->side_pipes);
1314
1315 cupsdRemoveSelect(job->status_pipes[0]);
1316 cupsdClosePipe(job->status_pipes);
1317 cupsdStatBufDelete(job->status_buffer);
1318 job->status_buffer = NULL;
1319
1320 /*
1321 * Update the printer and job state.
1322 */
1323
1324 cupsdSetJobState(job, abort_state, CUPSD_JOB_DEFAULT, "%s", abort_message);
1325 cupsdSetPrinterState(job->printer, IPP_PRINTER_IDLE, 0);
1326 update_job_attrs(job, 0);
1327
1328 if (job->history)
1329 free_job_history(job);
1330
1331 cupsArrayRemove(PrintingJobs, job);
1332
1333 /*
1334 * Clear the printer <-> job association...
1335 */
1336
1337 job->printer->job = NULL;
1338 job->printer = NULL;
1339 }
1340
1341
1342 /*
1343 * 'cupsdDeleteJob()' - Free all memory used by a job.
1344 */
1345
1346 void
1347 cupsdDeleteJob(cupsd_job_t *job, /* I - Job */
1348 cupsd_jobaction_t action)/* I - Action */
1349 {
1350 int i; /* Looping var */
1351
1352
1353 if (job->printer)
1354 finalize_job(job, 1);
1355
1356 if (action == CUPSD_JOB_PURGE)
1357 remove_job_history(job);
1358
1359 cupsdClearString(&job->username);
1360 cupsdClearString(&job->dest);
1361 for (i = 0;
1362 i < (int)(sizeof(job->auth_env) / sizeof(job->auth_env[0]));
1363 i ++)
1364 cupsdClearString(job->auth_env + i);
1365 cupsdClearString(&job->auth_uid);
1366
1367 if (action == CUPSD_JOB_PURGE)
1368 remove_job_files(job);
1369 else if (job->num_files > 0)
1370 {
1371 free(job->compressions);
1372 free(job->filetypes);
1373
1374 job->num_files = 0;
1375 }
1376
1377 if (job->history)
1378 free_job_history(job);
1379
1380 unload_job(job);
1381
1382 cupsArrayRemove(Jobs, job);
1383 cupsArrayRemove(ActiveJobs, job);
1384 cupsArrayRemove(PrintingJobs, job);
1385
1386 free(job);
1387 }
1388
1389
1390 /*
1391 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
1392 */
1393
1394 void
1395 cupsdFreeAllJobs(void)
1396 {
1397 cupsd_job_t *job; /* Current job */
1398
1399
1400 if (!Jobs)
1401 return;
1402
1403 cupsdHoldSignals();
1404
1405 cupsdStopAllJobs(CUPSD_JOB_FORCE, 0);
1406 cupsdSaveAllJobs();
1407
1408 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
1409 job;
1410 job = (cupsd_job_t *)cupsArrayNext(Jobs))
1411 cupsdDeleteJob(job, CUPSD_JOB_DEFAULT);
1412
1413 cupsdReleaseSignals();
1414 }
1415
1416
1417 /*
1418 * 'cupsdFindJob()' - Find the specified job.
1419 */
1420
1421 cupsd_job_t * /* O - Job data */
1422 cupsdFindJob(int id) /* I - Job ID */
1423 {
1424 cupsd_job_t key; /* Search key */
1425
1426
1427 key.id = id;
1428
1429 return ((cupsd_job_t *)cupsArrayFind(Jobs, &key));
1430 }
1431
1432
1433 /*
1434 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
1435 * or held jobs in a printer or class.
1436 */
1437
1438 int /* O - Job count */
1439 cupsdGetPrinterJobCount(
1440 const char *dest) /* I - Printer or class name */
1441 {
1442 int count; /* Job count */
1443 cupsd_job_t *job; /* Current job */
1444
1445
1446 for (job = (cupsd_job_t *)cupsArrayFirst(ActiveJobs), count = 0;
1447 job;
1448 job = (cupsd_job_t *)cupsArrayNext(ActiveJobs))
1449 if (job->dest && !_cups_strcasecmp(job->dest, dest))
1450 count ++;
1451
1452 return (count);
1453 }
1454
1455
1456 /*
1457 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
1458 * or held jobs for a user.
1459 */
1460
1461 int /* O - Job count */
1462 cupsdGetUserJobCount(
1463 const char *username) /* I - Username */
1464 {
1465 int count; /* Job count */
1466 cupsd_job_t *job; /* Current job */
1467
1468
1469 for (job = (cupsd_job_t *)cupsArrayFirst(ActiveJobs), count = 0;
1470 job;
1471 job = (cupsd_job_t *)cupsArrayNext(ActiveJobs))
1472 if (!_cups_strcasecmp(job->username, username))
1473 count ++;
1474
1475 return (count);
1476 }
1477
1478
1479 /*
1480 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
1481 */
1482
1483 void
1484 cupsdLoadAllJobs(void)
1485 {
1486 char filename[1024]; /* Full filename of job.cache file */
1487 struct stat fileinfo, /* Information on job.cache file */
1488 dirinfo; /* Information on RequestRoot dir */
1489
1490
1491
1492 /*
1493 * Create the job arrays as needed...
1494 */
1495
1496 if (!Jobs)
1497 Jobs = cupsArrayNew(compare_jobs, NULL);
1498
1499 if (!ActiveJobs)
1500 ActiveJobs = cupsArrayNew(compare_active_jobs, NULL);
1501
1502 if (!PrintingJobs)
1503 PrintingJobs = cupsArrayNew(compare_jobs, NULL);
1504
1505 /*
1506 * See whether the job.cache file is older than the RequestRoot directory...
1507 */
1508
1509 snprintf(filename, sizeof(filename), "%s/job.cache", CacheDir);
1510
1511 if (stat(filename, &fileinfo))
1512 {
1513 fileinfo.st_mtime = 0;
1514
1515 if (errno != ENOENT)
1516 cupsdLogMessage(CUPSD_LOG_ERROR,
1517 "Unable to get file information for \"%s\" - %s",
1518 filename, strerror(errno));
1519 }
1520
1521 if (stat(RequestRoot, &dirinfo))
1522 {
1523 dirinfo.st_mtime = 0;
1524
1525 if (errno != ENOENT)
1526 cupsdLogMessage(CUPSD_LOG_ERROR,
1527 "Unable to get directory information for \"%s\" - %s",
1528 RequestRoot, strerror(errno));
1529 }
1530
1531 /*
1532 * Load the most recent source for job data...
1533 */
1534
1535 if (dirinfo.st_mtime > fileinfo.st_mtime)
1536 {
1537 load_request_root();
1538
1539 load_next_job_id(filename);
1540 }
1541 else
1542 load_job_cache(filename);
1543
1544 /*
1545 * Clean out old jobs as needed...
1546 */
1547
1548 if (MaxJobs > 0 && cupsArrayCount(Jobs) >= MaxJobs)
1549 cupsdCleanJobs();
1550 }
1551
1552
1553 /*
1554 * 'cupsdLoadJob()' - Load a single job.
1555 */
1556
1557 int /* O - 1 on success, 0 on failure */
1558 cupsdLoadJob(cupsd_job_t *job) /* I - Job */
1559 {
1560 int i; /* Looping var */
1561 char jobfile[1024]; /* Job filename */
1562 cups_file_t *fp; /* Job file */
1563 int fileid; /* Current file ID */
1564 ipp_attribute_t *attr; /* Job attribute */
1565 const char *dest; /* Destination name */
1566 cupsd_printer_t *destptr; /* Pointer to destination */
1567 mime_type_t **filetypes; /* New filetypes array */
1568 int *compressions; /* New compressions array */
1569
1570
1571 if (job->attrs)
1572 {
1573 if (job->state_value > IPP_JOB_STOPPED)
1574 job->access_time = time(NULL);
1575
1576 return (1);
1577 }
1578
1579 if ((job->attrs = ippNew()) == NULL)
1580 {
1581 cupsdLogJob(job, CUPSD_LOG_ERROR, "Ran out of memory for job attributes.");
1582 return (0);
1583 }
1584
1585 /*
1586 * Load job attributes...
1587 */
1588
1589 cupsdLogJob(job, CUPSD_LOG_DEBUG, "Loading attributes...");
1590
1591 snprintf(jobfile, sizeof(jobfile), "%s/c%05d", RequestRoot, job->id);
1592 if ((fp = cupsdOpenConfFile(jobfile)) == NULL)
1593 goto error;
1594
1595 if (ippReadIO(fp, (ipp_iocb_t)cupsFileRead, 1, NULL, job->attrs) != IPP_DATA)
1596 {
1597 cupsdLogJob(job, CUPSD_LOG_ERROR,
1598 "Unable to read job control file \"%s\".", jobfile);
1599 cupsFileClose(fp);
1600 goto error;
1601 }
1602
1603 cupsFileClose(fp);
1604
1605 /*
1606 * Copy attribute data to the job object...
1607 */
1608
1609 if (!ippFindAttribute(job->attrs, "time-at-creation", IPP_TAG_INTEGER))
1610 {
1611 cupsdLogJob(job, CUPSD_LOG_ERROR,
1612 "Missing or bad time-at-creation attribute in control file.");
1613 goto error;
1614 }
1615
1616 if ((job->state = ippFindAttribute(job->attrs, "job-state",
1617 IPP_TAG_ENUM)) == NULL)
1618 {
1619 cupsdLogJob(job, CUPSD_LOG_ERROR,
1620 "Missing or bad job-state attribute in control file.");
1621 goto error;
1622 }
1623
1624 job->state_value = (ipp_jstate_t)job->state->values[0].integer;
1625 job->file_time = 0;
1626 job->history_time = 0;
1627
1628 if (job->state_value >= IPP_JOB_CANCELED &&
1629 (attr = ippFindAttribute(job->attrs, "time-at-completed",
1630 IPP_TAG_INTEGER)) != NULL)
1631 {
1632 if (JobHistory < INT_MAX)
1633 job->history_time = attr->values[0].integer + JobHistory;
1634 else
1635 job->history_time = INT_MAX;
1636
1637 if (job->history_time < time(NULL))
1638 goto error; /* Expired, remove from history */
1639
1640 if (job->history_time < JobHistoryUpdate || !JobHistoryUpdate)
1641 JobHistoryUpdate = job->history_time;
1642
1643 if (JobFiles < INT_MAX)
1644 job->file_time = attr->values[0].integer + JobFiles;
1645 else
1646 job->file_time = INT_MAX;
1647
1648 if (job->file_time < JobHistoryUpdate || !JobHistoryUpdate)
1649 JobHistoryUpdate = job->file_time;
1650
1651 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdLoadJob: JobHistoryUpdate=%ld",
1652 (long)JobHistoryUpdate);
1653 }
1654
1655 if (!job->dest)
1656 {
1657 if ((attr = ippFindAttribute(job->attrs, "job-printer-uri",
1658 IPP_TAG_URI)) == NULL)
1659 {
1660 cupsdLogJob(job, CUPSD_LOG_ERROR,
1661 "No job-printer-uri attribute in control file.");
1662 goto error;
1663 }
1664
1665 if ((dest = cupsdValidateDest(attr->values[0].string.text, &(job->dtype),
1666 &destptr)) == NULL)
1667 {
1668 cupsdLogJob(job, CUPSD_LOG_ERROR,
1669 "Unable to queue job for destination \"%s\".",
1670 attr->values[0].string.text);
1671 goto error;
1672 }
1673
1674 cupsdSetString(&job->dest, dest);
1675 }
1676 else if ((destptr = cupsdFindDest(job->dest)) == NULL)
1677 {
1678 cupsdLogJob(job, CUPSD_LOG_ERROR,
1679 "Unable to queue job for destination \"%s\".",
1680 job->dest);
1681 goto error;
1682 }
1683
1684 if ((job->reasons = ippFindAttribute(job->attrs, "job-state-reasons",
1685 IPP_TAG_KEYWORD)) == NULL)
1686 {
1687 const char *reason; /* job-state-reason keyword */
1688
1689 cupsdLogJob(job, CUPSD_LOG_DEBUG,
1690 "Adding missing job-state-reasons attribute to control file.");
1691
1692 switch (job->state_value)
1693 {
1694 default :
1695 case IPP_JOB_PENDING :
1696 if (destptr->state == IPP_PRINTER_STOPPED)
1697 reason = "printer-stopped";
1698 else
1699 reason = "none";
1700 break;
1701
1702 case IPP_JOB_HELD :
1703 if ((attr = ippFindAttribute(job->attrs, "job-hold-until",
1704 IPP_TAG_ZERO)) != NULL &&
1705 (attr->value_tag == IPP_TAG_NAME ||
1706 attr->value_tag == IPP_TAG_NAMELANG ||
1707 attr->value_tag == IPP_TAG_KEYWORD) &&
1708 strcmp(attr->values[0].string.text, "no-hold"))
1709 reason = "job-hold-until-specified";
1710 else
1711 reason = "job-incoming";
1712 break;
1713
1714 case IPP_JOB_PROCESSING :
1715 reason = "job-printing";
1716 break;
1717
1718 case IPP_JOB_STOPPED :
1719 reason = "job-stopped";
1720 break;
1721
1722 case IPP_JOB_CANCELED :
1723 reason = "job-canceled-by-user";
1724 break;
1725
1726 case IPP_JOB_ABORTED :
1727 reason = "aborted-by-system";
1728 break;
1729
1730 case IPP_JOB_COMPLETED :
1731 reason = "job-completed-successfully";
1732 break;
1733 }
1734
1735 job->reasons = ippAddString(job->attrs, IPP_TAG_JOB, IPP_TAG_KEYWORD,
1736 "job-state-reasons", NULL, reason);
1737 }
1738 else if (job->state_value == IPP_JOB_PENDING)
1739 {
1740 if (destptr->state == IPP_PRINTER_STOPPED)
1741 ippSetString(job->attrs, &job->reasons, 0, "printer-stopped");
1742 else
1743 ippSetString(job->attrs, &job->reasons, 0, "none");
1744 }
1745
1746 job->sheets = ippFindAttribute(job->attrs, "job-media-sheets-completed",
1747 IPP_TAG_INTEGER);
1748 job->job_sheets = ippFindAttribute(job->attrs, "job-sheets", IPP_TAG_NAME);
1749
1750 if (!job->priority)
1751 {
1752 if ((attr = ippFindAttribute(job->attrs, "job-priority",
1753 IPP_TAG_INTEGER)) == NULL)
1754 {
1755 cupsdLogJob(job, CUPSD_LOG_ERROR,
1756 "Missing or bad job-priority attribute in control file.");
1757 goto error;
1758 }
1759
1760 job->priority = attr->values[0].integer;
1761 }
1762
1763 if (!job->username)
1764 {
1765 if ((attr = ippFindAttribute(job->attrs, "job-originating-user-name",
1766 IPP_TAG_NAME)) == NULL)
1767 {
1768 cupsdLogJob(job, CUPSD_LOG_ERROR,
1769 "Missing or bad job-originating-user-name "
1770 "attribute in control file.");
1771 goto error;
1772 }
1773
1774 cupsdSetString(&job->username, attr->values[0].string.text);
1775 }
1776
1777 /*
1778 * Set the job hold-until time and state...
1779 */
1780
1781 if (job->state_value == IPP_JOB_HELD)
1782 {
1783 if ((attr = ippFindAttribute(job->attrs, "job-hold-until",
1784 IPP_TAG_KEYWORD)) == NULL)
1785 attr = ippFindAttribute(job->attrs, "job-hold-until", IPP_TAG_NAME);
1786
1787 if (attr)
1788 cupsdSetJobHoldUntil(job, attr->values[0].string.text, CUPSD_JOB_DEFAULT);
1789 else
1790 {
1791 job->state->values[0].integer = IPP_JOB_PENDING;
1792 job->state_value = IPP_JOB_PENDING;
1793 }
1794 }
1795 else if (job->state_value == IPP_JOB_PROCESSING)
1796 {
1797 job->state->values[0].integer = IPP_JOB_PENDING;
1798 job->state_value = IPP_JOB_PENDING;
1799 }
1800
1801 if (!job->num_files)
1802 {
1803 /*
1804 * Find all the d##### files...
1805 */
1806
1807 for (fileid = 1; fileid < 10000; fileid ++)
1808 {
1809 snprintf(jobfile, sizeof(jobfile), "%s/d%05d-%03d", RequestRoot,
1810 job->id, fileid);
1811
1812 if (access(jobfile, 0))
1813 break;
1814
1815 cupsdLogJob(job, CUPSD_LOG_DEBUG,
1816 "Auto-typing document file \"%s\"...", jobfile);
1817
1818 if (fileid > job->num_files)
1819 {
1820 if (job->num_files == 0)
1821 {
1822 compressions = (int *)calloc((size_t)fileid, sizeof(int));
1823 filetypes = (mime_type_t **)calloc((size_t)fileid, sizeof(mime_type_t *));
1824 }
1825 else
1826 {
1827 compressions = (int *)realloc(job->compressions, sizeof(int) * (size_t)fileid);
1828 filetypes = (mime_type_t **)realloc(job->filetypes, sizeof(mime_type_t *) * (size_t)fileid);
1829 }
1830
1831 if (compressions)
1832 job->compressions = compressions;
1833
1834 if (filetypes)
1835 job->filetypes = filetypes;
1836
1837 if (!compressions || !filetypes)
1838 {
1839 cupsdLogJob(job, CUPSD_LOG_ERROR,
1840 "Ran out of memory for job file types.");
1841
1842 ippDelete(job->attrs);
1843 job->attrs = NULL;
1844
1845 if (job->compressions)
1846 {
1847 free(job->compressions);
1848 job->compressions = NULL;
1849 }
1850
1851 if (job->filetypes)
1852 {
1853 free(job->filetypes);
1854 job->filetypes = NULL;
1855 }
1856
1857 job->num_files = 0;
1858 return (0);
1859 }
1860
1861 job->num_files = fileid;
1862 }
1863
1864 job->filetypes[fileid - 1] = mimeFileType(MimeDatabase, jobfile, NULL,
1865 job->compressions + fileid - 1);
1866
1867 if (!job->filetypes[fileid - 1])
1868 job->filetypes[fileid - 1] = mimeType(MimeDatabase, "application",
1869 "vnd.cups-raw");
1870 }
1871 }
1872
1873 /*
1874 * Load authentication information as needed...
1875 */
1876
1877 if (job->state_value < IPP_JOB_STOPPED)
1878 {
1879 snprintf(jobfile, sizeof(jobfile), "%s/a%05d", RequestRoot, job->id);
1880
1881 for (i = 0;
1882 i < (int)(sizeof(job->auth_env) / sizeof(job->auth_env[0]));
1883 i ++)
1884 cupsdClearString(job->auth_env + i);
1885 cupsdClearString(&job->auth_uid);
1886
1887 if ((fp = cupsFileOpen(jobfile, "r")) != NULL)
1888 {
1889 int bytes, /* Size of auth data */
1890 linenum = 1; /* Current line number */
1891 char line[65536], /* Line from file */
1892 *value, /* Value from line */
1893 data[65536]; /* Decoded data */
1894
1895
1896 if (cupsFileGets(fp, line, sizeof(line)) &&
1897 !strcmp(line, "CUPSD-AUTH-V3"))
1898 {
1899 i = 0;
1900 while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
1901 {
1902 /*
1903 * Decode value...
1904 */
1905
1906 if (strcmp(line, "negotiate") && strcmp(line, "uid"))
1907 {
1908 bytes = sizeof(data);
1909 httpDecode64_2(data, &bytes, value);
1910 }
1911
1912 /*
1913 * Assign environment variables...
1914 */
1915
1916 if (!strcmp(line, "uid"))
1917 {
1918 cupsdSetStringf(&job->auth_uid, "AUTH_UID=%s", value);
1919 continue;
1920 }
1921 else if (i >= (int)(sizeof(job->auth_env) / sizeof(job->auth_env[0])))
1922 break;
1923
1924 if (!strcmp(line, "username"))
1925 cupsdSetStringf(job->auth_env + i, "AUTH_USERNAME=%s", data);
1926 else if (!strcmp(line, "domain"))
1927 cupsdSetStringf(job->auth_env + i, "AUTH_DOMAIN=%s", data);
1928 else if (!strcmp(line, "password"))
1929 cupsdSetStringf(job->auth_env + i, "AUTH_PASSWORD=%s", data);
1930 else if (!strcmp(line, "negotiate"))
1931 cupsdSetStringf(job->auth_env + i, "AUTH_NEGOTIATE=%s", value);
1932 else
1933 continue;
1934
1935 i ++;
1936 }
1937 }
1938
1939 cupsFileClose(fp);
1940 }
1941 }
1942
1943 job->access_time = time(NULL);
1944 return (1);
1945
1946 /*
1947 * If we get here then something bad happened...
1948 */
1949
1950 error:
1951
1952 ippDelete(job->attrs);
1953 job->attrs = NULL;
1954
1955 remove_job_history(job);
1956 remove_job_files(job);
1957
1958 return (0);
1959 }
1960
1961
1962 /*
1963 * 'cupsdMoveJob()' - Move the specified job to a different destination.
1964 */
1965
1966 void
1967 cupsdMoveJob(cupsd_job_t *job, /* I - Job */
1968 cupsd_printer_t *p) /* I - Destination printer or class */
1969 {
1970 ipp_attribute_t *attr; /* job-printer-uri attribute */
1971 const char *olddest; /* Old destination */
1972 cupsd_printer_t *oldp; /* Old pointer */
1973
1974
1975 /*
1976 * Don't move completed jobs...
1977 */
1978
1979 if (job->state_value > IPP_JOB_STOPPED)
1980 return;
1981
1982 /*
1983 * Get the old destination...
1984 */
1985
1986 olddest = job->dest;
1987
1988 if (job->printer)
1989 oldp = job->printer;
1990 else
1991 oldp = cupsdFindDest(olddest);
1992
1993 /*
1994 * Change the destination information...
1995 */
1996
1997 if (job->state_value > IPP_JOB_HELD)
1998 cupsdSetJobState(job, IPP_JOB_PENDING, CUPSD_JOB_DEFAULT,
1999 "Stopping job prior to move.");
2000
2001 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED, oldp, job,
2002 "Job #%d moved from %s to %s.", job->id, olddest,
2003 p->name);
2004
2005 cupsdSetString(&job->dest, p->name);
2006 job->dtype = p->type & (CUPS_PRINTER_CLASS | CUPS_PRINTER_REMOTE);
2007
2008 if ((attr = ippFindAttribute(job->attrs, "job-printer-uri",
2009 IPP_TAG_URI)) != NULL)
2010 cupsdSetString(&(attr->values[0].string.text), p->uri);
2011
2012 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED, p, job,
2013 "Job #%d moved from %s to %s.", job->id, olddest,
2014 p->name);
2015
2016 job->dirty = 1;
2017 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2018 }
2019
2020
2021 /*
2022 * 'cupsdReleaseJob()' - Release the specified job.
2023 */
2024
2025 void
2026 cupsdReleaseJob(cupsd_job_t *job) /* I - Job */
2027 {
2028 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdReleaseJob(job=%p(%d))", job,
2029 job->id);
2030
2031 if (job->state_value == IPP_JOB_HELD)
2032 {
2033 /*
2034 * Add trailing banner as needed...
2035 */
2036
2037 if (job->pending_timeout)
2038 cupsdTimeoutJob(job);
2039
2040 cupsdSetJobState(job, IPP_JOB_PENDING, CUPSD_JOB_DEFAULT,
2041 "Job released by user.");
2042 }
2043 }
2044
2045
2046 /*
2047 * 'cupsdRestartJob()' - Restart the specified job.
2048 */
2049
2050 void
2051 cupsdRestartJob(cupsd_job_t *job) /* I - Job */
2052 {
2053 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdRestartJob(job=%p(%d))", job,
2054 job->id);
2055
2056 if (job->state_value == IPP_JOB_STOPPED || job->num_files)
2057 cupsdSetJobState(job, IPP_JOB_PENDING, CUPSD_JOB_DEFAULT,
2058 "Job restarted by user.");
2059 }
2060
2061
2062 /*
2063 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
2064 */
2065
2066 void
2067 cupsdSaveAllJobs(void)
2068 {
2069 int i; /* Looping var */
2070 cups_file_t *fp; /* job.cache file */
2071 char filename[1024], /* job.cache filename */
2072 temp[1024]; /* Temporary string */
2073 cupsd_job_t *job; /* Current job */
2074 time_t curtime; /* Current time */
2075 struct tm *curdate; /* Current date */
2076
2077
2078 snprintf(filename, sizeof(filename), "%s/job.cache", CacheDir);
2079 if ((fp = cupsdCreateConfFile(filename, ConfigFilePerm)) == NULL)
2080 return;
2081
2082 cupsdLogMessage(CUPSD_LOG_INFO, "Saving job.cache...");
2083
2084 /*
2085 * Write a small header to the file...
2086 */
2087
2088 curtime = time(NULL);
2089 curdate = localtime(&curtime);
2090 strftime(temp, sizeof(temp) - 1, "%Y-%m-%d %H:%M", curdate);
2091
2092 cupsFilePuts(fp, "# Job cache file for " CUPS_SVERSION "\n");
2093 cupsFilePrintf(fp, "# Written by cupsd on %s\n", temp);
2094 cupsFilePrintf(fp, "NextJobId %d\n", NextJobId);
2095
2096 /*
2097 * Write each job known to the system...
2098 */
2099
2100 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
2101 job;
2102 job = (cupsd_job_t *)cupsArrayNext(Jobs))
2103 {
2104 cupsFilePrintf(fp, "<Job %d>\n", job->id);
2105 cupsFilePrintf(fp, "State %d\n", job->state_value);
2106 cupsFilePrintf(fp, "Priority %d\n", job->priority);
2107 cupsFilePrintf(fp, "HoldUntil %d\n", (int)job->hold_until);
2108 cupsFilePrintf(fp, "Username %s\n", job->username);
2109 cupsFilePrintf(fp, "Destination %s\n", job->dest);
2110 cupsFilePrintf(fp, "DestType %d\n", job->dtype);
2111 cupsFilePrintf(fp, "NumFiles %d\n", job->num_files);
2112 for (i = 0; i < job->num_files; i ++)
2113 cupsFilePrintf(fp, "File %d %s/%s %d\n", i + 1, job->filetypes[i]->super,
2114 job->filetypes[i]->type, job->compressions[i]);
2115 cupsFilePuts(fp, "</Job>\n");
2116 }
2117
2118 cupsdCloseCreatedConfFile(fp, filename);
2119 }
2120
2121
2122 /*
2123 * 'cupsdSaveJob()' - Save a job to disk.
2124 */
2125
2126 void
2127 cupsdSaveJob(cupsd_job_t *job) /* I - Job */
2128 {
2129 char filename[1024]; /* Job control filename */
2130 cups_file_t *fp; /* Job file */
2131
2132
2133 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2134 job, job->id, job->attrs);
2135
2136 snprintf(filename, sizeof(filename), "%s/c%05d", RequestRoot, job->id);
2137
2138 if ((fp = cupsdCreateConfFile(filename, ConfigFilePerm & 0600)) == NULL)
2139 return;
2140
2141 fchown(cupsFileNumber(fp), RunUser, Group);
2142
2143 job->attrs->state = IPP_IDLE;
2144
2145 if (ippWriteIO(fp, (ipp_iocb_t)cupsFileWrite, 1, NULL,
2146 job->attrs) != IPP_DATA)
2147 {
2148 cupsdLogJob(job, CUPSD_LOG_ERROR, "Unable to write job control file.");
2149 cupsFileClose(fp);
2150 return;
2151 }
2152
2153 if (!cupsdCloseCreatedConfFile(fp, filename))
2154 {
2155 /*
2156 * Remove backup file and mark this job as clean...
2157 */
2158
2159 strlcat(filename, ".O", sizeof(filename));
2160 unlink(filename);
2161
2162 job->dirty = 0;
2163 }
2164 }
2165
2166
2167 /*
2168 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2169 */
2170
2171 void
2172 cupsdSetJobHoldUntil(cupsd_job_t *job, /* I - Job */
2173 const char *when, /* I - When to resume */
2174 int update)/* I - Update job-hold-until attr? */
2175 {
2176 time_t curtime; /* Current time */
2177 struct tm *curdate; /* Current date */
2178 int hour; /* Hold hour */
2179 int minute; /* Hold minute */
2180 int second = 0; /* Hold second */
2181
2182
2183 cupsdLogMessage(CUPSD_LOG_DEBUG2,
2184 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2185 job, job->id, when, update);
2186
2187 if (update)
2188 {
2189 /*
2190 * Update the job-hold-until attribute...
2191 */
2192
2193 ipp_attribute_t *attr; /* job-hold-until attribute */
2194
2195 if ((attr = ippFindAttribute(job->attrs, "job-hold-until",
2196 IPP_TAG_KEYWORD)) == NULL)
2197 attr = ippFindAttribute(job->attrs, "job-hold-until", IPP_TAG_NAME);
2198
2199 if (attr)
2200 cupsdSetString(&(attr->values[0].string.text), when);
2201 else
2202 attr = ippAddString(job->attrs, IPP_TAG_JOB, IPP_TAG_KEYWORD,
2203 "job-hold-until", NULL, when);
2204
2205 if (attr)
2206 {
2207 if (isdigit(when[0] & 255))
2208 attr->value_tag = IPP_TAG_NAME;
2209 else
2210 attr->value_tag = IPP_TAG_KEYWORD;
2211
2212 job->dirty = 1;
2213 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2214 }
2215
2216 ippSetString(job->attrs, &job->reasons, 0, "job-hold-until-specified");
2217 }
2218
2219 /*
2220 * Update the hold time...
2221 */
2222
2223 job->cancel_time = 0;
2224
2225 if (!strcmp(when, "indefinite") || !strcmp(when, "auth-info-required"))
2226 {
2227 /*
2228 * Hold indefinitely...
2229 */
2230
2231 job->hold_until = 0;
2232
2233 if (MaxHoldTime > 0)
2234 job->cancel_time = time(NULL) + MaxHoldTime;
2235 }
2236 else if (!strcmp(when, "day-time"))
2237 {
2238 /*
2239 * Hold to 6am the next morning unless local time is < 6pm.
2240 */
2241
2242 curtime = time(NULL);
2243 curdate = localtime(&curtime);
2244
2245 if (curdate->tm_hour < 18)
2246 job->hold_until = curtime;
2247 else
2248 job->hold_until = curtime +
2249 ((29 - curdate->tm_hour) * 60 + 59 -
2250 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2251 }
2252 else if (!strcmp(when, "evening") || !strcmp(when, "night"))
2253 {
2254 /*
2255 * Hold to 6pm unless local time is > 6pm or < 6am.
2256 */
2257
2258 curtime = time(NULL);
2259 curdate = localtime(&curtime);
2260
2261 if (curdate->tm_hour < 6 || curdate->tm_hour >= 18)
2262 job->hold_until = curtime;
2263 else
2264 job->hold_until = curtime +
2265 ((17 - curdate->tm_hour) * 60 + 59 -
2266 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2267 }
2268 else if (!strcmp(when, "second-shift"))
2269 {
2270 /*
2271 * Hold to 4pm unless local time is > 4pm.
2272 */
2273
2274 curtime = time(NULL);
2275 curdate = localtime(&curtime);
2276
2277 if (curdate->tm_hour >= 16)
2278 job->hold_until = curtime;
2279 else
2280 job->hold_until = curtime +
2281 ((15 - curdate->tm_hour) * 60 + 59 -
2282 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2283 }
2284 else if (!strcmp(when, "third-shift"))
2285 {
2286 /*
2287 * Hold to 12am unless local time is < 8am.
2288 */
2289
2290 curtime = time(NULL);
2291 curdate = localtime(&curtime);
2292
2293 if (curdate->tm_hour < 8)
2294 job->hold_until = curtime;
2295 else
2296 job->hold_until = curtime +
2297 ((23 - curdate->tm_hour) * 60 + 59 -
2298 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2299 }
2300 else if (!strcmp(when, "weekend"))
2301 {
2302 /*
2303 * Hold to weekend unless we are in the weekend.
2304 */
2305
2306 curtime = time(NULL);
2307 curdate = localtime(&curtime);
2308
2309 if (curdate->tm_wday == 0 || curdate->tm_wday == 6)
2310 job->hold_until = curtime;
2311 else
2312 job->hold_until = curtime +
2313 (((5 - curdate->tm_wday) * 24 +
2314 (17 - curdate->tm_hour)) * 60 + 59 -
2315 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2316 }
2317 else if (sscanf(when, "%d:%d:%d", &hour, &minute, &second) >= 2)
2318 {
2319 /*
2320 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2321 */
2322
2323 curtime = time(NULL);
2324 curdate = gmtime(&curtime);
2325
2326 job->hold_until = curtime +
2327 ((hour - curdate->tm_hour) * 60 + minute -
2328 curdate->tm_min) * 60 + second - curdate->tm_sec;
2329
2330 /*
2331 * Hold until next day as needed...
2332 */
2333
2334 if (job->hold_until < curtime)
2335 job->hold_until += 24 * 60 * 60;
2336 }
2337
2338 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdSetJobHoldUntil: hold_until=%d",
2339 (int)job->hold_until);
2340 }
2341
2342
2343 /*
2344 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2345 * the list as needed.
2346 */
2347
2348 void
2349 cupsdSetJobPriority(
2350 cupsd_job_t *job, /* I - Job ID */
2351 int priority) /* I - New priority (0 to 100) */
2352 {
2353 ipp_attribute_t *attr; /* Job attribute */
2354
2355
2356 /*
2357 * Don't change completed jobs...
2358 */
2359
2360 if (job->state_value >= IPP_JOB_PROCESSING)
2361 return;
2362
2363 /*
2364 * Set the new priority and re-add the job into the active list...
2365 */
2366
2367 cupsArrayRemove(ActiveJobs, job);
2368
2369 job->priority = priority;
2370
2371 if ((attr = ippFindAttribute(job->attrs, "job-priority",
2372 IPP_TAG_INTEGER)) != NULL)
2373 attr->values[0].integer = priority;
2374 else
2375 ippAddInteger(job->attrs, IPP_TAG_JOB, IPP_TAG_INTEGER, "job-priority",
2376 priority);
2377
2378 cupsArrayAdd(ActiveJobs, job);
2379
2380 job->dirty = 1;
2381 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2382 }
2383
2384
2385 /*
2386 * 'cupsdSetJobState()' - Set the state of the specified print job.
2387 */
2388
2389 void
2390 cupsdSetJobState(
2391 cupsd_job_t *job, /* I - Job to cancel */
2392 ipp_jstate_t newstate, /* I - New job state */
2393 cupsd_jobaction_t action, /* I - Action to take */
2394 const char *message, /* I - Message to log */
2395 ...) /* I - Additional arguments as needed */
2396 {
2397 int i; /* Looping var */
2398 ipp_jstate_t oldstate; /* Old state */
2399 char filename[1024]; /* Job filename */
2400 ipp_attribute_t *attr; /* Job attribute */
2401
2402
2403 cupsdLogMessage(CUPSD_LOG_DEBUG2,
2404 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2405 "action=%d, message=\"%s\")", job, job->id, job->state_value,
2406 newstate, action, message ? message : "(null)");
2407
2408
2409 /*
2410 * Make sure we have the job attributes...
2411 */
2412
2413 if (!cupsdLoadJob(job))
2414 return;
2415
2416 /*
2417 * Don't do anything if the state is unchanged and we aren't purging the
2418 * job...
2419 */
2420
2421 oldstate = job->state_value;
2422 if (newstate == oldstate && action != CUPSD_JOB_PURGE)
2423 return;
2424
2425 /*
2426 * Stop any processes that are working on the current job...
2427 */
2428
2429 if (oldstate == IPP_JOB_PROCESSING)
2430 stop_job(job, action);
2431
2432 /*
2433 * Set the new job state...
2434 */
2435
2436 job->state_value = newstate;
2437
2438 if (job->state)
2439 job->state->values[0].integer = newstate;
2440
2441 switch (newstate)
2442 {
2443 case IPP_JOB_PENDING :
2444 /*
2445 * Update job-hold-until as needed...
2446 */
2447
2448 if ((attr = ippFindAttribute(job->attrs, "job-hold-until",
2449 IPP_TAG_KEYWORD)) == NULL)
2450 attr = ippFindAttribute(job->attrs, "job-hold-until", IPP_TAG_NAME);
2451
2452 if (attr)
2453 {
2454 attr->value_tag = IPP_TAG_KEYWORD;
2455 cupsdSetString(&(attr->values[0].string.text), "no-hold");
2456 }
2457
2458 default :
2459 break;
2460
2461 case IPP_JOB_ABORTED :
2462 case IPP_JOB_CANCELED :
2463 case IPP_JOB_COMPLETED :
2464 set_time(job, "time-at-completed");
2465 ippSetString(job->attrs, &job->reasons, 0, "processing-to-stop-point");
2466 break;
2467 }
2468
2469 /*
2470 * Log message as needed...
2471 */
2472
2473 if (message)
2474 {
2475 char buffer[2048]; /* Message buffer */
2476 va_list ap; /* Pointer to additional arguments */
2477
2478 va_start(ap, message);
2479 vsnprintf(buffer, sizeof(buffer), message, ap);
2480 va_end(ap);
2481
2482 if (newstate > IPP_JOB_STOPPED)
2483 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED, job->printer, job, "%s", buffer);
2484 else
2485 cupsdAddEvent(CUPSD_EVENT_JOB_STATE, job->printer, job, "%s", buffer);
2486
2487 if (newstate == IPP_JOB_STOPPED || newstate == IPP_JOB_ABORTED)
2488 cupsdLogJob(job, CUPSD_LOG_ERROR, "%s", buffer);
2489 else
2490 cupsdLogJob(job, CUPSD_LOG_INFO, "%s", buffer);
2491 }
2492
2493 /*
2494 * Handle post-state-change actions...
2495 */
2496
2497 switch (newstate)
2498 {
2499 case IPP_JOB_PROCESSING :
2500 /*
2501 * Add the job to the "printing" list...
2502 */
2503
2504 if (!cupsArrayFind(PrintingJobs, job))
2505 cupsArrayAdd(PrintingJobs, job);
2506
2507 /*
2508 * Set the processing time...
2509 */
2510
2511 set_time(job, "time-at-processing");
2512
2513 case IPP_JOB_PENDING :
2514 case IPP_JOB_HELD :
2515 case IPP_JOB_STOPPED :
2516 /*
2517 * Make sure the job is in the active list...
2518 */
2519
2520 if (!cupsArrayFind(ActiveJobs, job))
2521 cupsArrayAdd(ActiveJobs, job);
2522
2523 /*
2524 * Save the job state to disk...
2525 */
2526
2527 job->dirty = 1;
2528 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2529 break;
2530
2531 case IPP_JOB_ABORTED :
2532 case IPP_JOB_CANCELED :
2533 case IPP_JOB_COMPLETED :
2534 if (newstate == IPP_JOB_CANCELED)
2535 {
2536 /*
2537 * Remove the job from the active list if there are no processes still
2538 * running for it...
2539 */
2540
2541 for (i = 0; job->filters[i] < 0; i++);
2542
2543 if (!job->filters[i] && job->backend <= 0)
2544 cupsArrayRemove(ActiveJobs, job);
2545 }
2546 else
2547 {
2548 /*
2549 * Otherwise just remove the job from the active list immediately...
2550 */
2551
2552 cupsArrayRemove(ActiveJobs, job);
2553 }
2554
2555 /*
2556 * Expire job subscriptions since the job is now "completed"...
2557 */
2558
2559 cupsdExpireSubscriptions(NULL, job);
2560
2561 #ifdef __APPLE__
2562 /*
2563 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2564 * sleep to happen immediately...
2565 */
2566
2567 if (Sleeping && cupsArrayCount(PrintingJobs) == 0)
2568 cupsdAllowSleep();
2569 #endif /* __APPLE__ */
2570
2571 /*
2572 * Remove any authentication data...
2573 */
2574
2575 snprintf(filename, sizeof(filename), "%s/a%05d", RequestRoot, job->id);
2576 if (cupsdRemoveFile(filename) && errno != ENOENT)
2577 cupsdLogMessage(CUPSD_LOG_ERROR,
2578 "Unable to remove authentication cache: %s",
2579 strerror(errno));
2580
2581 for (i = 0;
2582 i < (int)(sizeof(job->auth_env) / sizeof(job->auth_env[0]));
2583 i ++)
2584 cupsdClearString(job->auth_env + i);
2585
2586 cupsdClearString(&job->auth_uid);
2587
2588 /*
2589 * Remove the print file for good if we aren't preserving jobs or
2590 * files...
2591 */
2592
2593 if (!JobHistory || !JobFiles || action == CUPSD_JOB_PURGE)
2594 remove_job_files(job);
2595
2596 if (JobHistory && action != CUPSD_JOB_PURGE)
2597 {
2598 /*
2599 * Save job state info...
2600 */
2601
2602 job->dirty = 1;
2603 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2604 }
2605 else if (!job->printer)
2606 {
2607 /*
2608 * Delete the job immediately if not actively printing...
2609 */
2610
2611 cupsdDeleteJob(job, CUPSD_JOB_PURGE);
2612 job = NULL;
2613 }
2614 break;
2615 }
2616
2617 /*
2618 * Finalize the job immediately if we forced things...
2619 */
2620
2621 if (action >= CUPSD_JOB_FORCE && job && job->printer)
2622 finalize_job(job, 0);
2623
2624 /*
2625 * Update the server "busy" state...
2626 */
2627
2628 cupsdSetBusyState();
2629 }
2630
2631
2632 /*
2633 * 'cupsdStopAllJobs()' - Stop all print jobs.
2634 */
2635
2636 void
2637 cupsdStopAllJobs(
2638 cupsd_jobaction_t action, /* I - Action */
2639 int kill_delay) /* I - Number of seconds before we kill */
2640 {
2641 cupsd_job_t *job; /* Current job */
2642
2643
2644 DEBUG_puts("cupsdStopAllJobs()");
2645
2646 for (job = (cupsd_job_t *)cupsArrayFirst(PrintingJobs);
2647 job;
2648 job = (cupsd_job_t *)cupsArrayNext(PrintingJobs))
2649 {
2650 if (job->completed)
2651 {
2652 cupsdSetJobState(job, IPP_JOB_COMPLETED, CUPSD_JOB_FORCE, NULL);
2653 }
2654 else
2655 {
2656 if (kill_delay)
2657 job->kill_time = time(NULL) + kill_delay;
2658
2659 cupsdSetJobState(job, IPP_JOB_PENDING, action, NULL);
2660 }
2661 }
2662 }
2663
2664
2665 /*
2666 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2667 */
2668
2669 void
2670 cupsdUnloadCompletedJobs(void)
2671 {
2672 cupsd_job_t *job; /* Current job */
2673 time_t expire; /* Expiration time */
2674
2675
2676 expire = time(NULL) - 60;
2677
2678 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
2679 job;
2680 job = (cupsd_job_t *)cupsArrayNext(Jobs))
2681 if (job->attrs && job->state_value >= IPP_JOB_STOPPED && !job->printer &&
2682 job->access_time < expire)
2683 {
2684 if (job->dirty)
2685 cupsdSaveJob(job);
2686
2687 unload_job(job);
2688 }
2689 }
2690
2691
2692 /*
2693 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2694 */
2695
2696 void
2697 cupsdUpdateJobs(void)
2698 {
2699 cupsd_job_t *job; /* Current job */
2700 time_t curtime; /* Current time */
2701 ipp_attribute_t *attr; /* time-at-completed attribute */
2702
2703
2704 curtime = time(NULL);
2705 JobHistoryUpdate = 0;
2706
2707 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
2708 job;
2709 job = (cupsd_job_t *)cupsArrayNext(Jobs))
2710 {
2711 if (job->state_value >= IPP_JOB_CANCELED &&
2712 (attr = ippFindAttribute(job->attrs, "time-at-completed",
2713 IPP_TAG_INTEGER)) != NULL)
2714 {
2715 /*
2716 * Update history/file expiration times...
2717 */
2718
2719 if (JobHistory < INT_MAX)
2720 job->history_time = attr->values[0].integer + JobHistory;
2721 else
2722 job->history_time = INT_MAX;
2723
2724 if (job->history_time < curtime)
2725 {
2726 cupsdDeleteJob(job, CUPSD_JOB_PURGE);
2727 continue;
2728 }
2729
2730 if (job->history_time < JobHistoryUpdate || !JobHistoryUpdate)
2731 JobHistoryUpdate = job->history_time;
2732
2733 if (JobFiles < INT_MAX)
2734 job->file_time = attr->values[0].integer + JobFiles;
2735 else
2736 job->file_time = INT_MAX;
2737
2738 if (job->file_time < JobHistoryUpdate || !JobHistoryUpdate)
2739 JobHistoryUpdate = job->file_time;
2740 }
2741 }
2742
2743 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdUpdateAllJobs: JobHistoryUpdate=%ld",
2744 (long)JobHistoryUpdate);
2745 }
2746
2747
2748 /*
2749 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2750 */
2751
2752 static int /* O - Difference */
2753 compare_active_jobs(void *first, /* I - First job */
2754 void *second, /* I - Second job */
2755 void *data) /* I - App data (not used) */
2756 {
2757 int diff; /* Difference */
2758
2759
2760 (void)data;
2761
2762 if ((diff = ((cupsd_job_t *)second)->priority -
2763 ((cupsd_job_t *)first)->priority) != 0)
2764 return (diff);
2765 else
2766 return (((cupsd_job_t *)first)->id - ((cupsd_job_t *)second)->id);
2767 }
2768
2769
2770 /*
2771 * 'compare_jobs()' - Compare the job IDs of two jobs.
2772 */
2773
2774 static int /* O - Difference */
2775 compare_jobs(void *first, /* I - First job */
2776 void *second, /* I - Second job */
2777 void *data) /* I - App data (not used) */
2778 {
2779 (void)data;
2780
2781 return (((cupsd_job_t *)first)->id - ((cupsd_job_t *)second)->id);
2782 }
2783
2784
2785 /*
2786 * 'dump_job_history()' - Dump any debug messages for a job.
2787 */
2788
2789 static void
2790 dump_job_history(cupsd_job_t *job) /* I - Job */
2791 {
2792 int i, /* Looping var */
2793 oldsize; /* Current MaxLogSize */
2794 struct tm *date; /* Date/time value */
2795 cupsd_joblog_t *message; /* Current message */
2796 char temp[2048], /* Log message */
2797 *ptr, /* Pointer into log message */
2798 start[256], /* Start time */
2799 end[256]; /* End time */
2800 cupsd_printer_t *printer; /* Printer for job */
2801
2802
2803 /*
2804 * See if we have anything to dump...
2805 */
2806
2807 if (!job->history)
2808 return;
2809
2810 /*
2811 * Disable log rotation temporarily...
2812 */
2813
2814 oldsize = MaxLogSize;
2815 MaxLogSize = 0;
2816
2817 /*
2818 * Copy the debug messages to the log...
2819 */
2820
2821 message = (cupsd_joblog_t *)cupsArrayFirst(job->history);
2822 date = localtime(&(message->time));
2823 strftime(start, sizeof(start), "%X", date);
2824
2825 message = (cupsd_joblog_t *)cupsArrayLast(job->history);
2826 date = localtime(&(message->time));
2827 strftime(end, sizeof(end), "%X", date);
2828
2829 snprintf(temp, sizeof(temp),
2830 "[Job %d] The following messages were recorded from %s to %s",
2831 job->id, start, end);
2832 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2833
2834 for (message = (cupsd_joblog_t *)cupsArrayFirst(job->history);
2835 message;
2836 message = (cupsd_joblog_t *)cupsArrayNext(job->history))
2837 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, message->message);
2838
2839 snprintf(temp, sizeof(temp), "[Job %d] End of messages", job->id);
2840 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2841
2842 /*
2843 * Log the printer state values...
2844 */
2845
2846 if ((printer = job->printer) == NULL)
2847 printer = cupsdFindDest(job->dest);
2848
2849 if (printer)
2850 {
2851 snprintf(temp, sizeof(temp), "[Job %d] printer-state=%d(%s)", job->id,
2852 printer->state,
2853 printer->state == IPP_PRINTER_IDLE ? "idle" :
2854 printer->state == IPP_PRINTER_PROCESSING ? "processing" :
2855 "stopped");
2856 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2857
2858 snprintf(temp, sizeof(temp), "[Job %d] printer-state-message=\"%s\"",
2859 job->id, printer->state_message);
2860 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2861
2862 snprintf(temp, sizeof(temp), "[Job %d] printer-state-reasons=", job->id);
2863 ptr = temp + strlen(temp);
2864 if (printer->num_reasons == 0)
2865 strlcpy(ptr, "none", sizeof(temp) - (size_t)(ptr - temp));
2866 else
2867 {
2868 for (i = 0;
2869 i < printer->num_reasons && ptr < (temp + sizeof(temp) - 2);
2870 i ++)
2871 {
2872 if (i)
2873 *ptr++ = ',';
2874
2875 strlcpy(ptr, printer->reasons[i], sizeof(temp) - (size_t)(ptr - temp));
2876 ptr += strlen(ptr);
2877 }
2878 }
2879 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2880 }
2881
2882 /*
2883 * Restore log file rotation...
2884 */
2885
2886 MaxLogSize = oldsize;
2887
2888 /*
2889 * Free all messages...
2890 */
2891
2892 free_job_history(job);
2893 }
2894
2895
2896 /*
2897 * 'free_job_history()' - Free any log history.
2898 */
2899
2900 static void
2901 free_job_history(cupsd_job_t *job) /* I - Job */
2902 {
2903 char *message; /* Current message */
2904
2905
2906 if (!job->history)
2907 return;
2908
2909 for (message = (char *)cupsArrayFirst(job->history);
2910 message;
2911 message = (char *)cupsArrayNext(job->history))
2912 free(message);
2913
2914 cupsArrayDelete(job->history);
2915 job->history = NULL;
2916 }
2917
2918
2919 /*
2920 * 'finalize_job()' - Cleanup after job filter processes and support data.
2921 */
2922
2923 static void
2924 finalize_job(cupsd_job_t *job, /* I - Job */
2925 int set_job_state) /* I - 1 = set the job state */
2926 {
2927 ipp_pstate_t printer_state; /* New printer state value */
2928 ipp_jstate_t job_state; /* New job state value */
2929 const char *message; /* Message for job state */
2930 char buffer[1024]; /* Buffer for formatted messages */
2931
2932
2933 cupsdLogMessage(CUPSD_LOG_DEBUG2, "finalize_job(job=%p(%d))", job, job->id);
2934
2935 /*
2936 * Clear the "connecting-to-device" and "cups-waiting-for-job-completed"
2937 * reasons, which are only valid when a printer is processing, along with any
2938 * remote printing job state...
2939 */
2940
2941 cupsdSetPrinterReasons(job->printer, "-connecting-to-device,"
2942 "cups-waiting-for-job-completed,"
2943 "cups-remote-pending,"
2944 "cups-remote-pending-held,"
2945 "cups-remote-processing,"
2946 "cups-remote-stopped,"
2947 "cups-remote-canceled,"
2948 "cups-remote-aborted,"
2949 "cups-remote-completed");
2950
2951 /*
2952 * Similarly, clear the "offline-report" reason for non-USB devices since we
2953 * rarely have current information for network devices...
2954 */
2955
2956 if (strncmp(job->printer->device_uri, "usb:", 4) &&
2957 strncmp(job->printer->device_uri, "ippusb:", 7))
2958 cupsdSetPrinterReasons(job->printer, "-offline-report");
2959
2960 /*
2961 * Free the security profile...
2962 */
2963
2964 cupsdDestroyProfile(job->profile);
2965 job->profile = NULL;
2966 cupsdDestroyProfile(job->bprofile);
2967 job->bprofile = NULL;
2968
2969 /*
2970 * Clear the unresponsive job watchdog timers...
2971 */
2972
2973 job->cancel_time = 0;
2974 job->kill_time = 0;
2975
2976 /*
2977 * Close pipes and status buffer...
2978 */
2979
2980 cupsdClosePipe(job->print_pipes);
2981 cupsdClosePipe(job->back_pipes);
2982 cupsdClosePipe(job->side_pipes);
2983
2984 cupsdRemoveSelect(job->status_pipes[0]);
2985 cupsdClosePipe(job->status_pipes);
2986 cupsdStatBufDelete(job->status_buffer);
2987 job->status_buffer = NULL;
2988
2989 /*
2990 * Process the exit status...
2991 */
2992
2993 if (job->printer->state == IPP_PRINTER_PROCESSING)
2994 printer_state = IPP_PRINTER_IDLE;
2995 else
2996 printer_state = job->printer->state;
2997
2998 switch (job_state = job->state_value)
2999 {
3000 case IPP_JOB_PENDING :
3001 message = "Job paused.";
3002 break;
3003
3004 case IPP_JOB_HELD :
3005 message = "Job held.";
3006 break;
3007
3008 default :
3009 case IPP_JOB_PROCESSING :
3010 case IPP_JOB_COMPLETED :
3011 job_state = IPP_JOB_COMPLETED;
3012 message = "Job completed.";
3013
3014 if (!job->status)
3015 ippSetString(job->attrs, &job->reasons, 0,
3016 "job-completed-successfully");
3017 break;
3018
3019 case IPP_JOB_STOPPED :
3020 message = "Job stopped.";
3021
3022 ippSetString(job->attrs, &job->reasons, 0, "job-stopped");
3023 break;
3024
3025 case IPP_JOB_CANCELED :
3026 message = "Job canceled.";
3027
3028 ippSetString(job->attrs, &job->reasons, 0, "job-canceled-by-user");
3029 break;
3030
3031 case IPP_JOB_ABORTED :
3032 message = "Job aborted.";
3033 break;
3034 }
3035
3036 if (job->status < 0)
3037 {
3038 /*
3039 * Backend had errors...
3040 */
3041
3042 int exit_code; /* Exit code from backend */
3043
3044 /*
3045 * Convert the status to an exit code. Due to the way the W* macros are
3046 * implemented on MacOS X (bug?), we have to store the exit status in a
3047 * variable first and then convert...
3048 */
3049
3050 exit_code = -job->status;
3051 if (WIFEXITED(exit_code))
3052 exit_code = WEXITSTATUS(exit_code);
3053 else
3054 {
3055 ippSetString(job->attrs, &job->reasons, 0, "cups-backend-crashed");
3056 exit_code = job->status;
3057 }
3058
3059 cupsdLogJob(job, CUPSD_LOG_INFO, "Backend returned status %d (%s)",
3060 exit_code,
3061 exit_code == CUPS_BACKEND_FAILED ? "failed" :
3062 exit_code == CUPS_BACKEND_AUTH_REQUIRED ?
3063 "authentication required" :
3064 exit_code == CUPS_BACKEND_HOLD ? "hold job" :
3065 exit_code == CUPS_BACKEND_STOP ? "stop printer" :
3066 exit_code == CUPS_BACKEND_CANCEL ? "cancel job" :
3067 exit_code == CUPS_BACKEND_RETRY ? "retry job later" :
3068 exit_code == CUPS_BACKEND_RETRY_CURRENT ? "retry job immediately" :
3069 exit_code < 0 ? "crashed" : "unknown");
3070
3071 /*
3072 * Do what needs to be done...
3073 */
3074
3075 switch (exit_code)
3076 {
3077 default :
3078 case CUPS_BACKEND_FAILED :
3079 /*
3080 * Backend failure, use the error-policy to determine how to
3081 * act...
3082 */
3083
3084 if (job->dtype & CUPS_PRINTER_CLASS)
3085 {
3086 /*
3087 * Queued on a class - mark the job as pending and we'll retry on
3088 * another printer...
3089 */
3090
3091 if (job_state == IPP_JOB_COMPLETED)
3092 {
3093 job_state = IPP_JOB_PENDING;
3094 message = "Retrying job on another printer.";
3095
3096 ippSetString(job->attrs, &job->reasons, 0,
3097 "resources-are-not-ready");
3098 }
3099 }
3100 else if (!strcmp(job->printer->error_policy, "retry-current-job"))
3101 {
3102 /*
3103 * The error policy is "retry-current-job" - mark the job as pending
3104 * and we'll retry on the same printer...
3105 */
3106
3107 if (job_state == IPP_JOB_COMPLETED)
3108 {
3109 job_state = IPP_JOB_PENDING;
3110 message = "Retrying job on same printer.";
3111
3112 ippSetString(job->attrs, &job->reasons, 0, "none");
3113 }
3114 }
3115 else if ((job->printer->type & CUPS_PRINTER_FAX) ||
3116 !strcmp(job->printer->error_policy, "retry-job"))
3117 {
3118 if (job_state == IPP_JOB_COMPLETED)
3119 {
3120 /*
3121 * The job was queued on a fax or the error policy is "retry-job" -
3122 * hold the job if the number of retries is less than the
3123 * JobRetryLimit, otherwise abort the job.
3124 */
3125
3126 job->tries ++;
3127
3128 if (job->tries > JobRetryLimit && JobRetryLimit > 0)
3129 {
3130 /*
3131 * Too many tries...
3132 */
3133
3134 snprintf(buffer, sizeof(buffer),
3135 "Job aborted after %d unsuccessful attempts.",
3136 JobRetryLimit);
3137 job_state = IPP_JOB_ABORTED;
3138 message = buffer;
3139
3140 ippSetString(job->attrs, &job->reasons, 0, "aborted-by-system");
3141 }
3142 else
3143 {
3144 /*
3145 * Try again in N seconds...
3146 */
3147
3148 snprintf(buffer, sizeof(buffer),
3149 "Job held for %d seconds since it could not be sent.",
3150 JobRetryInterval);
3151
3152 job->hold_until = time(NULL) + JobRetryInterval;
3153 job_state = IPP_JOB_HELD;
3154 message = buffer;
3155
3156 ippSetString(job->attrs, &job->reasons, 0,
3157 "resources-are-not-ready");
3158 }
3159 }
3160 }
3161 else if (!strcmp(job->printer->error_policy, "abort-job") &&
3162 job_state == IPP_JOB_COMPLETED)
3163 {
3164 job_state = IPP_JOB_ABORTED;
3165 message = "Job aborted due to backend errors; please consult "
3166 "the error_log file for details.";
3167
3168 ippSetString(job->attrs, &job->reasons, 0, "aborted-by-system");
3169 }
3170 else if (job->state_value == IPP_JOB_PROCESSING)
3171 {
3172 job_state = IPP_JOB_PENDING;
3173 printer_state = IPP_PRINTER_STOPPED;
3174 message = "Printer stopped due to backend errors; please "
3175 "consult the error_log file for details.";
3176
3177 ippSetString(job->attrs, &job->reasons, 0, "none");
3178 }
3179 break;
3180
3181 case CUPS_BACKEND_CANCEL :
3182 /*
3183 * Cancel the job...
3184 */
3185
3186 if (job_state == IPP_JOB_COMPLETED)
3187 {
3188 job_state = IPP_JOB_CANCELED;
3189 message = "Job canceled at printer.";
3190
3191 ippSetString(job->attrs, &job->reasons, 0, "canceled-at-device");
3192 }
3193 break;
3194
3195 case CUPS_BACKEND_HOLD :
3196 if (job_state == IPP_JOB_COMPLETED)
3197 {
3198 /*
3199 * Hold the job...
3200 */
3201
3202 const char *reason = ippGetString(job->reasons, 0, NULL);
3203
3204 cupsdLogJob(job, CUPSD_LOG_DEBUG, "job-state-reasons=\"%s\"",
3205 reason);
3206
3207 if (!reason || strncmp(reason, "account-", 8))
3208 {
3209 cupsdSetJobHoldUntil(job, "indefinite", 1);
3210
3211 ippSetString(job->attrs, &job->reasons, 0,
3212 "job-hold-until-specified");
3213 message = "Job held indefinitely due to backend errors; please "
3214 "consult the error_log file for details.";
3215 }
3216 else if (!strcmp(reason, "account-info-needed"))
3217 {
3218 cupsdSetJobHoldUntil(job, "indefinite", 0);
3219
3220 message = "Job held indefinitely - account information is "
3221 "required.";
3222 }
3223 else if (!strcmp(reason, "account-closed"))
3224 {
3225 cupsdSetJobHoldUntil(job, "indefinite", 0);
3226
3227 message = "Job held indefinitely - account has been closed.";
3228 }
3229 else if (!strcmp(reason, "account-limit-reached"))
3230 {
3231 cupsdSetJobHoldUntil(job, "indefinite", 0);
3232
3233 message = "Job held indefinitely - account limit has been "
3234 "reached.";
3235 }
3236 else
3237 {
3238 cupsdSetJobHoldUntil(job, "indefinite", 0);
3239
3240 message = "Job held indefinitely - account authorization failed.";
3241 }
3242
3243 job_state = IPP_JOB_HELD;
3244 }
3245 break;
3246
3247 case CUPS_BACKEND_STOP :
3248 /*
3249 * Stop the printer...
3250 */
3251
3252 printer_state = IPP_PRINTER_STOPPED;
3253 message = "Printer stopped due to backend errors; please "
3254 "consult the error_log file for details.";
3255
3256 if (job_state == IPP_JOB_COMPLETED)
3257 {
3258 job_state = IPP_JOB_PENDING;
3259
3260 ippSetString(job->attrs, &job->reasons, 0,
3261 "resources-are-not-ready");
3262 }
3263 break;
3264
3265 case CUPS_BACKEND_AUTH_REQUIRED :
3266 /*
3267 * Hold the job for authentication...
3268 */
3269
3270 if (job_state == IPP_JOB_COMPLETED)
3271 {
3272 cupsdSetJobHoldUntil(job, "auth-info-required", 1);
3273
3274 job_state = IPP_JOB_HELD;
3275 message = "Job held for authentication.";
3276
3277 if (strncmp(job->reasons->values[0].string.text, "account-", 8))
3278 ippSetString(job->attrs, &job->reasons, 0,
3279 "cups-held-for-authentication");
3280 }
3281 break;
3282
3283 case CUPS_BACKEND_RETRY :
3284 if (job_state == IPP_JOB_COMPLETED)
3285 {
3286 /*
3287 * Hold the job if the number of retries is less than the
3288 * JobRetryLimit, otherwise abort the job.
3289 */
3290
3291 job->tries ++;
3292
3293 if (job->tries > JobRetryLimit && JobRetryLimit > 0)
3294 {
3295 /*
3296 * Too many tries...
3297 */
3298
3299 snprintf(buffer, sizeof(buffer),
3300 "Job aborted after %d unsuccessful attempts.",
3301 JobRetryLimit);
3302 job_state = IPP_JOB_ABORTED;
3303 message = buffer;
3304
3305 ippSetString(job->attrs, &job->reasons, 0, "aborted-by-system");
3306 }
3307 else
3308 {
3309 /*
3310 * Try again in N seconds...
3311 */
3312
3313 snprintf(buffer, sizeof(buffer),
3314 "Job held for %d seconds since it could not be sent.",
3315 JobRetryInterval);
3316
3317 job->hold_until = time(NULL) + JobRetryInterval;
3318 job_state = IPP_JOB_HELD;
3319 message = buffer;
3320
3321 ippSetString(job->attrs, &job->reasons, 0,
3322 "resources-are-not-ready");
3323 }
3324 }
3325 break;
3326
3327 case CUPS_BACKEND_RETRY_CURRENT :
3328 /*
3329 * Mark the job as pending and retry on the same printer...
3330 */
3331
3332 if (job_state == IPP_JOB_COMPLETED)
3333 {
3334 job_state = IPP_JOB_PENDING;
3335 message = "Retrying job on same printer.";
3336
3337 ippSetString(job->attrs, &job->reasons, 0, "none");
3338 }
3339 break;
3340 }
3341 }
3342 else if (job->status > 0)
3343 {
3344 /*
3345 * Filter had errors; stop job...
3346 */
3347
3348 if (job_state == IPP_JOB_COMPLETED)
3349 {
3350 job_state = IPP_JOB_STOPPED;
3351 message = "Job stopped due to filter errors; please consult the "
3352 "error_log file for details.";
3353
3354 if (WIFSIGNALED(job->status))
3355 ippSetString(job->attrs, &job->reasons, 0, "cups-filter-crashed");
3356 else
3357 ippSetString(job->attrs, &job->reasons, 0, "job-completed-with-errors");
3358 }
3359 }
3360
3361 /*
3362 * Update the printer and job state.
3363 */
3364
3365 if (set_job_state && job_state != job->state_value)
3366 cupsdSetJobState(job, job_state, CUPSD_JOB_DEFAULT, "%s", message);
3367
3368 cupsdSetPrinterState(job->printer, printer_state,
3369 printer_state == IPP_PRINTER_STOPPED);
3370 update_job_attrs(job, 0);
3371
3372 if (job->history)
3373 {
3374 if (job->status &&
3375 (job->state_value == IPP_JOB_ABORTED ||
3376 job->state_value == IPP_JOB_STOPPED))
3377 dump_job_history(job);
3378 else
3379 free_job_history(job);
3380 }
3381
3382 cupsArrayRemove(PrintingJobs, job);
3383
3384 /*
3385 * Apply any PPD updates...
3386 */
3387
3388 if (job->num_keywords)
3389 {
3390 if (cupsdUpdatePrinterPPD(job->printer, job->num_keywords, job->keywords))
3391 cupsdSetPrinterAttrs(job->printer);
3392
3393 cupsFreeOptions(job->num_keywords, job->keywords);
3394
3395 job->num_keywords = 0;
3396 job->keywords = NULL;
3397 }
3398
3399 /*
3400 * Clear the printer <-> job association...
3401 */
3402
3403 job->printer->job = NULL;
3404 job->printer = NULL;
3405
3406 /*
3407 * Try printing another job...
3408 */
3409
3410 if (printer_state != IPP_PRINTER_STOPPED)
3411 cupsdCheckJobs();
3412 }
3413
3414
3415 /*
3416 * 'get_options()' - Get a string containing the job options.
3417 */
3418
3419 static char * /* O - Options string */
3420 get_options(cupsd_job_t *job, /* I - Job */
3421 int banner_page, /* I - Printing a banner page? */
3422 char *copies, /* I - Copies buffer */
3423 size_t copies_size, /* I - Size of copies buffer */
3424 char *title, /* I - Title buffer */
3425 size_t title_size) /* I - Size of title buffer */
3426 {
3427 int i; /* Looping var */
3428 size_t newlength; /* New option buffer length */
3429 char *optptr, /* Pointer to options */
3430 *valptr; /* Pointer in value string */
3431 ipp_attribute_t *attr; /* Current attribute */
3432 _ppd_cache_t *pc; /* PPD cache and mapping data */
3433 int num_pwgppds; /* Number of PWG->PPD options */
3434 cups_option_t *pwgppds, /* PWG->PPD options */
3435 *pwgppd, /* Current PWG->PPD option */
3436 *preset; /* Current preset option */
3437 int print_color_mode,
3438 /* Output mode (if any) */
3439 print_quality; /* Print quality (if any) */
3440 const char *ppd; /* PPD option choice */
3441 int exact; /* Did we get an exact match? */
3442 static char *options = NULL;/* Full list of options */
3443 static size_t optlength = 0; /* Length of option buffer */
3444
3445
3446 /*
3447 * Building the options string is harder than it needs to be, but for the
3448 * moment we need to pass strings for command-line args and not IPP attribute
3449 * pointers... :)
3450 *
3451 * First build an options array for any PWG->PPD mapped option/choice pairs.
3452 */
3453
3454 pc = job->printer->pc;
3455 num_pwgppds = 0;
3456 pwgppds = NULL;
3457
3458 if (pc &&
3459 !ippFindAttribute(job->attrs,
3460 "com.apple.print.DocumentTicket.PMSpoolFormat",
3461 IPP_TAG_ZERO) &&
3462 !ippFindAttribute(job->attrs, "APPrinterPreset", IPP_TAG_ZERO) &&
3463 (ippFindAttribute(job->attrs, "print-color-mode", IPP_TAG_ZERO) ||
3464 ippFindAttribute(job->attrs, "print-quality", IPP_TAG_ZERO)))
3465 {
3466 /*
3467 * Map print-color-mode and print-quality to a preset...
3468 */
3469
3470 if ((attr = ippFindAttribute(job->attrs, "print-color-mode",
3471 IPP_TAG_KEYWORD)) != NULL &&
3472 !strcmp(attr->values[0].string.text, "monochrome"))
3473 print_color_mode = _PWG_PRINT_COLOR_MODE_MONOCHROME;
3474 else
3475 print_color_mode = _PWG_PRINT_COLOR_MODE_COLOR;
3476
3477 if ((attr = ippFindAttribute(job->attrs, "print-quality",
3478 IPP_TAG_ENUM)) != NULL &&
3479 attr->values[0].integer >= IPP_QUALITY_DRAFT &&
3480 attr->values[0].integer <= IPP_QUALITY_HIGH)
3481 print_quality = attr->values[0].integer - IPP_QUALITY_DRAFT;
3482 else
3483 print_quality = _PWG_PRINT_QUALITY_NORMAL;
3484
3485 if (pc->num_presets[print_color_mode][print_quality] == 0)
3486 {
3487 /*
3488 * Try to find a preset that works so that we maximize the chances of us
3489 * getting a good print using IPP attributes.
3490 */
3491
3492 if (pc->num_presets[print_color_mode][_PWG_PRINT_QUALITY_NORMAL] > 0)
3493 print_quality = _PWG_PRINT_QUALITY_NORMAL;
3494 else if (pc->num_presets[_PWG_PRINT_COLOR_MODE_COLOR][print_quality] > 0)
3495 print_color_mode = _PWG_PRINT_COLOR_MODE_COLOR;
3496 else
3497 {
3498 print_quality = _PWG_PRINT_QUALITY_NORMAL;
3499 print_color_mode = _PWG_PRINT_COLOR_MODE_COLOR;
3500 }
3501 }
3502
3503 if (pc->num_presets[print_color_mode][print_quality] > 0)
3504 {
3505 /*
3506 * Copy the preset options as long as the corresponding names are not
3507 * already defined in the IPP request...
3508 */
3509
3510 for (i = pc->num_presets[print_color_mode][print_quality],
3511 preset = pc->presets[print_color_mode][print_quality];
3512 i > 0;
3513 i --, preset ++)
3514 {
3515 if (!ippFindAttribute(job->attrs, preset->name, IPP_TAG_ZERO))
3516 num_pwgppds = cupsAddOption(preset->name, preset->value, num_pwgppds,
3517 &pwgppds);
3518 }
3519 }
3520 }
3521
3522 if (pc)
3523 {
3524 if (!ippFindAttribute(job->attrs, "InputSlot", IPP_TAG_ZERO) &&
3525 !ippFindAttribute(job->attrs, "HPPaperSource", IPP_TAG_ZERO))
3526 {
3527 if ((ppd = _ppdCacheGetInputSlot(pc, job->attrs, NULL)) != NULL)
3528 num_pwgppds = cupsAddOption(pc->source_option, ppd, num_pwgppds,
3529 &pwgppds);
3530 }
3531 if (!ippFindAttribute(job->attrs, "MediaType", IPP_TAG_ZERO) &&
3532 (ppd = _ppdCacheGetMediaType(pc, job->attrs, NULL)) != NULL)
3533 num_pwgppds = cupsAddOption("MediaType", ppd, num_pwgppds, &pwgppds);
3534
3535 if (!ippFindAttribute(job->attrs, "PageRegion", IPP_TAG_ZERO) &&
3536 !ippFindAttribute(job->attrs, "PageSize", IPP_TAG_ZERO) &&
3537 (ppd = _ppdCacheGetPageSize(pc, job->attrs, NULL, &exact)) != NULL)
3538 {
3539 num_pwgppds = cupsAddOption("PageSize", ppd, num_pwgppds, &pwgppds);
3540
3541 if (!ippFindAttribute(job->attrs, "media", IPP_TAG_ZERO))
3542 num_pwgppds = cupsAddOption("media", ppd, num_pwgppds, &pwgppds);
3543 }
3544
3545 if (!ippFindAttribute(job->attrs, "OutputBin", IPP_TAG_ZERO) &&
3546 (attr = ippFindAttribute(job->attrs, "output-bin",
3547 IPP_TAG_ZERO)) != NULL &&
3548 (attr->value_tag == IPP_TAG_KEYWORD ||
3549 attr->value_tag == IPP_TAG_NAME) &&
3550 (ppd = _ppdCacheGetOutputBin(pc, attr->values[0].string.text)) != NULL)
3551 {
3552 /*
3553 * Map output-bin to OutputBin option...
3554 */
3555
3556 num_pwgppds = cupsAddOption("OutputBin", ppd, num_pwgppds, &pwgppds);
3557 }
3558
3559 if (pc->sides_option &&
3560 !ippFindAttribute(job->attrs, pc->sides_option, IPP_TAG_ZERO) &&
3561 (attr = ippFindAttribute(job->attrs, "sides", IPP_TAG_KEYWORD)) != NULL)
3562 {
3563 /*
3564 * Map sides to duplex option...
3565 */
3566
3567 if (!strcmp(attr->values[0].string.text, "one-sided"))
3568 num_pwgppds = cupsAddOption(pc->sides_option, pc->sides_1sided,
3569 num_pwgppds, &pwgppds);
3570 else if (!strcmp(attr->values[0].string.text, "two-sided-long-edge"))
3571 num_pwgppds = cupsAddOption(pc->sides_option, pc->sides_2sided_long,
3572 num_pwgppds, &pwgppds);
3573 else if (!strcmp(attr->values[0].string.text, "two-sided-short-edge"))
3574 num_pwgppds = cupsAddOption(pc->sides_option, pc->sides_2sided_short,
3575 num_pwgppds, &pwgppds);
3576 }
3577
3578 /*
3579 * Map finishings values...
3580 */
3581
3582 num_pwgppds = _ppdCacheGetFinishingOptions(pc, job->attrs,
3583 IPP_FINISHINGS_NONE, num_pwgppds,
3584 &pwgppds);
3585 }
3586
3587 /*
3588 * Figure out how much room we need...
3589 */
3590
3591 newlength = ipp_length(job->attrs);
3592
3593 for (i = num_pwgppds, pwgppd = pwgppds; i > 0; i --, pwgppd ++)
3594 newlength += 1 + strlen(pwgppd->name) + 1 + strlen(pwgppd->value);
3595
3596 /*
3597 * Then allocate/reallocate the option buffer as needed...
3598 */
3599
3600 if (newlength == 0) /* This can never happen, but Clang */
3601 newlength = 1; /* thinks it can... */
3602
3603 if (newlength > optlength || !options)
3604 {
3605 if (!options)
3606 optptr = malloc(newlength);
3607 else
3608 optptr = realloc(options, newlength);
3609
3610 if (!optptr)
3611 {
3612 cupsdLogJob(job, CUPSD_LOG_CRIT,
3613 "Unable to allocate " CUPS_LLFMT " bytes for option buffer.",
3614 CUPS_LLCAST newlength);
3615 return (NULL);
3616 }
3617
3618 options = optptr;
3619 optlength = newlength;
3620 }
3621
3622 /*
3623 * Now loop through the attributes and convert them to the textual
3624 * representation used by the filters...
3625 */
3626
3627 optptr = options;
3628 *optptr = '\0';
3629
3630 snprintf(title, title_size, "%s-%d", job->printer->name, job->id);
3631 strlcpy(copies, "1", copies_size);
3632
3633 for (attr = job->attrs->attrs; attr != NULL; attr = attr->next)
3634 {
3635 if (!strcmp(attr->name, "copies") &&
3636 attr->value_tag == IPP_TAG_INTEGER)
3637 {
3638 /*
3639 * Don't use the # copies attribute if we are printing the job sheets...
3640 */
3641
3642 if (!banner_page)
3643 snprintf(copies, copies_size, "%d", attr->values[0].integer);
3644 }
3645 else if (!strcmp(attr->name, "job-name") &&
3646 (attr->value_tag == IPP_TAG_NAME ||
3647 attr->value_tag == IPP_TAG_NAMELANG))
3648 strlcpy(title, attr->values[0].string.text, title_size);
3649 else if (attr->group_tag == IPP_TAG_JOB)
3650 {
3651 /*
3652 * Filter out other unwanted attributes...
3653 */
3654
3655 if (attr->value_tag == IPP_TAG_NOVALUE ||
3656 attr->value_tag == IPP_TAG_MIMETYPE ||
3657 attr->value_tag == IPP_TAG_NAMELANG ||
3658 attr->value_tag == IPP_TAG_TEXTLANG ||
3659 (attr->value_tag == IPP_TAG_URI && strcmp(attr->name, "job-uuid") &&
3660 strcmp(attr->name, "job-authorization-uri")) ||
3661 attr->value_tag == IPP_TAG_URISCHEME ||
3662 attr->value_tag == IPP_TAG_BEGIN_COLLECTION) /* Not yet supported */
3663 continue;
3664
3665 if (!strcmp(attr->name, "job-hold-until") ||
3666 !strcmp(attr->name, "job-id") ||
3667 !strcmp(attr->name, "job-k-octets") ||
3668 !strcmp(attr->name, "job-media-sheets") ||
3669 !strcmp(attr->name, "job-media-sheets-completed") ||
3670 !strcmp(attr->name, "job-state") ||
3671 !strcmp(attr->name, "job-state-reasons"))
3672 continue;
3673
3674 if (!strncmp(attr->name, "job-", 4) &&
3675 strcmp(attr->name, "job-account-id") &&
3676 strcmp(attr->name, "job-accounting-user-id") &&
3677 strcmp(attr->name, "job-authorization-uri") &&
3678 strcmp(attr->name, "job-billing") &&
3679 strcmp(attr->name, "job-impressions") &&
3680 strcmp(attr->name, "job-originating-host-name") &&
3681 strcmp(attr->name, "job-password") &&
3682 strcmp(attr->name, "job-password-encryption") &&
3683 strcmp(attr->name, "job-uuid") &&
3684 !(job->printer->type & CUPS_PRINTER_REMOTE))
3685 continue;
3686
3687 if ((!strcmp(attr->name, "job-impressions") ||
3688 !strcmp(attr->name, "page-label") ||
3689 !strcmp(attr->name, "page-border") ||
3690 !strncmp(attr->name, "number-up", 9) ||
3691 !strcmp(attr->name, "page-ranges") ||
3692 !strcmp(attr->name, "page-set") ||
3693 !_cups_strcasecmp(attr->name, "AP_FIRSTPAGE_InputSlot") ||
3694 !_cups_strcasecmp(attr->name, "AP_FIRSTPAGE_ManualFeed") ||
3695 !_cups_strcasecmp(attr->name, "com.apple.print.PrintSettings."
3696 "PMTotalSidesImaged..n.") ||
3697 !_cups_strcasecmp(attr->name, "com.apple.print.PrintSettings."
3698 "PMTotalBeginPages..n.")) &&
3699 banner_page)
3700 continue;
3701
3702 /*
3703 * Otherwise add them to the list...
3704 */
3705
3706 if (optptr > options)
3707 strlcat(optptr, " ", optlength - (size_t)(optptr - options));
3708
3709 if (attr->value_tag != IPP_TAG_BOOLEAN)
3710 {
3711 strlcat(optptr, attr->name, optlength - (size_t)(optptr - options));
3712 strlcat(optptr, "=", optlength - (size_t)(optptr - options));
3713 }
3714
3715 for (i = 0; i < attr->num_values; i ++)
3716 {
3717 if (i)
3718 strlcat(optptr, ",", optlength - (size_t)(optptr - options));
3719
3720 optptr += strlen(optptr);
3721
3722 switch (attr->value_tag)
3723 {
3724 case IPP_TAG_INTEGER :
3725 case IPP_TAG_ENUM :
3726 snprintf(optptr, optlength - (size_t)(optptr - options),
3727 "%d", attr->values[i].integer);
3728 break;
3729
3730 case IPP_TAG_BOOLEAN :
3731 if (!attr->values[i].boolean)
3732 strlcat(optptr, "no", optlength - (size_t)(optptr - options));
3733
3734 strlcat(optptr, attr->name, optlength - (size_t)(optptr - options));
3735 break;
3736
3737 case IPP_TAG_RANGE :
3738 if (attr->values[i].range.lower == attr->values[i].range.upper)
3739 snprintf(optptr, optlength - (size_t)(optptr - options) - 1,
3740 "%d", attr->values[i].range.lower);
3741 else
3742 snprintf(optptr, optlength - (size_t)(optptr - options) - 1,
3743 "%d-%d", attr->values[i].range.lower,
3744 attr->values[i].range.upper);
3745 break;
3746
3747 case IPP_TAG_RESOLUTION :
3748 snprintf(optptr, optlength - (size_t)(optptr - options) - 1,
3749 "%dx%d%s", attr->values[i].resolution.xres,
3750 attr->values[i].resolution.yres,
3751 attr->values[i].resolution.units == IPP_RES_PER_INCH ?
3752 "dpi" : "dpcm");
3753 break;
3754
3755 case IPP_TAG_STRING :
3756 case IPP_TAG_TEXT :
3757 case IPP_TAG_NAME :
3758 case IPP_TAG_KEYWORD :
3759 case IPP_TAG_CHARSET :
3760 case IPP_TAG_LANGUAGE :
3761 case IPP_TAG_URI :
3762 for (valptr = attr->values[i].string.text; *valptr;)
3763 {
3764 if (strchr(" \t\n\\\'\"", *valptr))
3765 *optptr++ = '\\';
3766 *optptr++ = *valptr++;
3767 }
3768
3769 *optptr = '\0';
3770 break;
3771
3772 default :
3773 break; /* anti-compiler-warning-code */
3774 }
3775 }
3776
3777 optptr += strlen(optptr);
3778 }
3779 }
3780
3781 /*
3782 * Finally loop through the PWG->PPD mapped options and add them...
3783 */
3784
3785 for (i = num_pwgppds, pwgppd = pwgppds; i > 0; i --, pwgppd ++)
3786 {
3787 *optptr++ = ' ';
3788 strlcpy(optptr, pwgppd->name, optlength - (size_t)(optptr - options));
3789 optptr += strlen(optptr);
3790 *optptr++ = '=';
3791 strlcpy(optptr, pwgppd->value, optlength - (size_t)(optptr - options));
3792 optptr += strlen(optptr);
3793 }
3794
3795 cupsFreeOptions(num_pwgppds, pwgppds);
3796
3797 /*
3798 * Return the options string...
3799 */
3800
3801 return (options);
3802 }
3803
3804
3805 /*
3806 * 'ipp_length()' - Compute the size of the buffer needed to hold
3807 * the textual IPP attributes.
3808 */
3809
3810 static size_t /* O - Size of attribute buffer */
3811 ipp_length(ipp_t *ipp) /* I - IPP request */
3812 {
3813 size_t bytes; /* Number of bytes */
3814 int i; /* Looping var */
3815 ipp_attribute_t *attr; /* Current attribute */
3816
3817
3818 /*
3819 * Loop through all attributes...
3820 */
3821
3822 bytes = 0;
3823
3824 for (attr = ipp->attrs; attr != NULL; attr = attr->next)
3825 {
3826 /*
3827 * Skip attributes that won't be sent to filters...
3828 */
3829
3830 if (attr->value_tag == IPP_TAG_NOVALUE ||
3831 attr->value_tag == IPP_TAG_MIMETYPE ||
3832 attr->value_tag == IPP_TAG_NAMELANG ||
3833 attr->value_tag == IPP_TAG_TEXTLANG ||
3834 attr->value_tag == IPP_TAG_URI ||
3835 attr->value_tag == IPP_TAG_URISCHEME)
3836 continue;
3837
3838 /*
3839 * Add space for a leading space and commas between each value.
3840 * For the first attribute, the leading space isn't used, so the
3841 * extra byte can be used as the nul terminator...
3842 */
3843
3844 bytes ++; /* " " separator */
3845 bytes += (size_t)attr->num_values; /* "," separators */
3846
3847 /*
3848 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3849 * other attributes appear as "foo=value1,value2,...,valueN".
3850 */
3851
3852 if (attr->value_tag != IPP_TAG_BOOLEAN)
3853 bytes += strlen(attr->name);
3854 else
3855 bytes += (size_t)attr->num_values * strlen(attr->name);
3856
3857 /*
3858 * Now add the size required for each value in the attribute...
3859 */
3860
3861 switch (attr->value_tag)
3862 {
3863 case IPP_TAG_INTEGER :
3864 case IPP_TAG_ENUM :
3865 /*
3866 * Minimum value of a signed integer is -2147483647, or 11 digits.
3867 */
3868
3869 bytes += (size_t)attr->num_values * 11;
3870 break;
3871
3872 case IPP_TAG_BOOLEAN :
3873 /*
3874 * Add two bytes for each false ("no") value...
3875 */
3876
3877 for (i = 0; i < attr->num_values; i ++)
3878 if (!attr->values[i].boolean)
3879 bytes += 2;
3880 break;
3881
3882 case IPP_TAG_RANGE :
3883 /*
3884 * A range is two signed integers separated by a hyphen, or
3885 * 23 characters max.
3886 */
3887
3888 bytes += (size_t)attr->num_values * 23;
3889 break;
3890
3891 case IPP_TAG_RESOLUTION :
3892 /*
3893 * A resolution is two signed integers separated by an "x" and
3894 * suffixed by the units, or 26 characters max.
3895 */
3896
3897 bytes += (size_t)attr->num_values * 26;
3898 break;
3899
3900 case IPP_TAG_STRING :
3901 case IPP_TAG_TEXT :
3902 case IPP_TAG_NAME :
3903 case IPP_TAG_KEYWORD :
3904 case IPP_TAG_CHARSET :
3905 case IPP_TAG_LANGUAGE :
3906 case IPP_TAG_URI :
3907 /*
3908 * Strings can contain characters that need quoting. We need
3909 * at least 2 * len + 2 characters to cover the quotes and
3910 * any backslashes in the string.
3911 */
3912
3913 for (i = 0; i < attr->num_values; i ++)
3914 bytes += 2 * strlen(attr->values[i].string.text) + 2;
3915 break;
3916
3917 default :
3918 break; /* anti-compiler-warning-code */
3919 }
3920 }
3921
3922 return (bytes);
3923 }
3924
3925
3926 /*
3927 * 'load_job_cache()' - Load jobs from the job.cache file.
3928 */
3929
3930 static void
3931 load_job_cache(const char *filename) /* I - job.cache filename */
3932 {
3933 cups_file_t *fp; /* job.cache file */
3934 char line[1024], /* Line buffer */
3935 *value; /* Value on line */
3936 int linenum; /* Line number in file */
3937 cupsd_job_t *job; /* Current job */
3938 int jobid; /* Job ID */
3939 char jobfile[1024]; /* Job filename */
3940
3941
3942 /*
3943 * Open the job.cache file...
3944 */
3945
3946 if ((fp = cupsdOpenConfFile(filename)) == NULL)
3947 {
3948 load_request_root();
3949 return;
3950 }
3951
3952 /*
3953 * Read entries from the job cache file and create jobs as needed.
3954 */
3955
3956 cupsdLogMessage(CUPSD_LOG_INFO, "Loading job cache file \"%s\"...",
3957 filename);
3958
3959 linenum = 0;
3960 job = NULL;
3961
3962 while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
3963 {
3964 if (!_cups_strcasecmp(line, "NextJobId"))
3965 {
3966 if (value)
3967 NextJobId = atoi(value);
3968 }
3969 else if (!_cups_strcasecmp(line, "<Job"))
3970 {
3971 if (job)
3972 {
3973 cupsdLogMessage(CUPSD_LOG_ERROR, "Missing </Job> directive on line %d.",
3974 linenum);
3975 continue;
3976 }
3977
3978 if (!value)
3979 {
3980 cupsdLogMessage(CUPSD_LOG_ERROR, "Missing job ID on line %d.", linenum);
3981 continue;
3982 }
3983
3984 jobid = atoi(value);
3985
3986 if (jobid < 1)
3987 {
3988 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad job ID %d on line %d.", jobid,
3989 linenum);
3990 continue;
3991 }
3992
3993 snprintf(jobfile, sizeof(jobfile), "%s/c%05d", RequestRoot, jobid);
3994 if (access(jobfile, 0))
3995 {
3996 snprintf(jobfile, sizeof(jobfile), "%s/c%05d.N", RequestRoot, jobid);
3997 if (access(jobfile, 0))
3998 {
3999 cupsdLogMessage(CUPSD_LOG_ERROR, "[Job %d] Files have gone away.",
4000 jobid);
4001 continue;
4002 }
4003 }
4004
4005 job = calloc(1, sizeof(cupsd_job_t));
4006 if (!job)
4007 {
4008 cupsdLogMessage(CUPSD_LOG_EMERG,
4009 "[Job %d] Unable to allocate memory for job.", jobid);
4010 break;
4011 }
4012
4013 job->id = jobid;
4014 job->back_pipes[0] = -1;
4015 job->back_pipes[1] = -1;
4016 job->print_pipes[0] = -1;
4017 job->print_pipes[1] = -1;
4018 job->side_pipes[0] = -1;
4019 job->side_pipes[1] = -1;
4020 job->status_pipes[0] = -1;
4021 job->status_pipes[1] = -1;
4022
4023 cupsdLogJob(job, CUPSD_LOG_DEBUG, "Loading from cache...");
4024 }
4025 else if (!job)
4026 {
4027 cupsdLogMessage(CUPSD_LOG_ERROR,
4028 "Missing <Job #> directive on line %d.", linenum);
4029 continue;
4030 }
4031 else if (!_cups_strcasecmp(line, "</Job>"))
4032 {
4033 cupsArrayAdd(Jobs, job);
4034
4035 if (job->state_value <= IPP_JOB_STOPPED && cupsdLoadJob(job))
4036 cupsArrayAdd(ActiveJobs, job);
4037
4038 job = NULL;
4039 }
4040 else if (!value)
4041 {
4042 cupsdLogMessage(CUPSD_LOG_ERROR, "Missing value on line %d.", linenum);
4043 continue;
4044 }
4045 else if (!_cups_strcasecmp(line, "State"))
4046 {
4047 job->state_value = (ipp_jstate_t)atoi(value);
4048
4049 if (job->state_value < IPP_JOB_PENDING)
4050 job->state_value = IPP_JOB_PENDING;
4051 else if (job->state_value > IPP_JOB_COMPLETED)
4052 job->state_value = IPP_JOB_COMPLETED;
4053 }
4054 else if (!_cups_strcasecmp(line, "HoldUntil"))
4055 {
4056 job->hold_until = atoi(value);
4057 }
4058 else if (!_cups_strcasecmp(line, "Priority"))
4059 {
4060 job->priority = atoi(value);
4061 }
4062 else if (!_cups_strcasecmp(line, "Username"))
4063 {
4064 cupsdSetString(&job->username, value);
4065 }
4066 else if (!_cups_strcasecmp(line, "Destination"))
4067 {
4068 cupsdSetString(&job->dest, value);
4069 }
4070 else if (!_cups_strcasecmp(line, "DestType"))
4071 {
4072 job->dtype = (cups_ptype_t)atoi(value);
4073 }
4074 else if (!_cups_strcasecmp(line, "NumFiles"))
4075 {
4076 job->num_files = atoi(value);
4077
4078 if (job->num_files < 0)
4079 {
4080 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad NumFiles value %d on line %d.",
4081 job->num_files, linenum);
4082 job->num_files = 0;
4083 continue;
4084 }
4085
4086 if (job->num_files > 0)
4087 {
4088 snprintf(jobfile, sizeof(jobfile), "%s/d%05d-001", RequestRoot,
4089 job->id);
4090 if (access(jobfile, 0))
4091 {
4092 cupsdLogJob(job, CUPSD_LOG_INFO, "Data files have gone away.");
4093 job->num_files = 0;
4094 continue;
4095 }
4096
4097 job->filetypes = calloc((size_t)job->num_files, sizeof(mime_type_t *));
4098 job->compressions = calloc((size_t)job->num_files, sizeof(int));
4099
4100 if (!job->filetypes || !job->compressions)
4101 {
4102 cupsdLogJob(job, CUPSD_LOG_EMERG,
4103 "Unable to allocate memory for %d files.",
4104 job->num_files);
4105 break;
4106 }
4107 }
4108 }
4109 else if (!_cups_strcasecmp(line, "File"))
4110 {
4111 int number, /* File number */
4112 compression; /* Compression value */
4113 char super[MIME_MAX_SUPER], /* MIME super type */
4114 type[MIME_MAX_TYPE]; /* MIME type */
4115
4116
4117 if (sscanf(value, "%d%*[ \t]%15[^/]/%255s%d", &number, super, type,
4118 &compression) != 4)
4119 {
4120 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad File on line %d.", linenum);
4121 continue;
4122 }
4123
4124 if (number < 1 || number > job->num_files)
4125 {
4126 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad File number %d on line %d.",
4127 number, linenum);
4128 continue;
4129 }
4130
4131 number --;
4132
4133 job->compressions[number] = compression;
4134 job->filetypes[number] = mimeType(MimeDatabase, super, type);
4135
4136 if (!job->filetypes[number])
4137 {
4138 /*
4139 * If the original MIME type is unknown, auto-type it!
4140 */
4141
4142 cupsdLogJob(job, CUPSD_LOG_ERROR,
4143 "Unknown MIME type %s/%s for file %d.",
4144 super, type, number + 1);
4145
4146 snprintf(jobfile, sizeof(jobfile), "%s/d%05d-%03d", RequestRoot,
4147 job->id, number + 1);
4148 job->filetypes[number] = mimeFileType(MimeDatabase, jobfile, NULL,
4149 job->compressions + number);
4150
4151 /*
4152 * If that didn't work, assume it is raw...
4153 */
4154
4155 if (!job->filetypes[number])
4156 job->filetypes[number] = mimeType(MimeDatabase, "application",
4157 "vnd.cups-raw");
4158 }
4159 }
4160 else
4161 cupsdLogMessage(CUPSD_LOG_ERROR, "Unknown %s directive on line %d.",
4162 line, linenum);
4163 }
4164
4165 if (job)
4166 {
4167 cupsdLogMessage(CUPSD_LOG_ERROR,
4168 "Missing </Job> directive on line %d.", linenum);
4169 cupsdDeleteJob(job, CUPSD_JOB_PURGE);
4170 }
4171
4172 cupsFileClose(fp);
4173 }
4174
4175
4176 /*
4177 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4178 */
4179
4180 static void
4181 load_next_job_id(const char *filename) /* I - job.cache filename */
4182 {
4183 cups_file_t *fp; /* job.cache file */
4184 char line[1024], /* Line buffer */
4185 *value; /* Value on line */
4186 int linenum; /* Line number in file */
4187 int next_job_id; /* NextJobId value from line */
4188
4189
4190 /*
4191 * Read the NextJobId directive from the job.cache file and use
4192 * the value (if any).
4193 */
4194
4195 if ((fp = cupsFileOpen(filename, "r")) == NULL)
4196 {
4197 if (errno != ENOENT)
4198 cupsdLogMessage(CUPSD_LOG_ERROR,
4199 "Unable to open job cache file \"%s\": %s",
4200 filename, strerror(errno));
4201
4202 return;
4203 }
4204
4205 cupsdLogMessage(CUPSD_LOG_INFO,
4206 "Loading NextJobId from job cache file \"%s\"...", filename);
4207
4208 linenum = 0;
4209
4210 while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
4211 {
4212 if (!_cups_strcasecmp(line, "NextJobId"))
4213 {
4214 if (value)
4215 {
4216 next_job_id = atoi(value);
4217
4218 if (next_job_id > NextJobId)
4219 NextJobId = next_job_id;
4220 }
4221 break;
4222 }
4223 }
4224
4225 cupsFileClose(fp);
4226 }
4227
4228
4229 /*
4230 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4231 */
4232
4233 static void
4234 load_request_root(void)
4235 {
4236 cups_dir_t *dir; /* Directory */
4237 cups_dentry_t *dent; /* Directory entry */
4238 cupsd_job_t *job; /* New job */
4239
4240
4241 /*
4242 * Open the requests directory...
4243 */
4244
4245 cupsdLogMessage(CUPSD_LOG_DEBUG, "Scanning %s for jobs...", RequestRoot);
4246
4247 if ((dir = cupsDirOpen(RequestRoot)) == NULL)
4248 {
4249 cupsdLogMessage(CUPSD_LOG_ERROR,
4250 "Unable to open spool directory \"%s\": %s",
4251 RequestRoot, strerror(errno));
4252 return;
4253 }
4254
4255 /*
4256 * Read all the c##### files...
4257 */
4258
4259 while ((dent = cupsDirRead(dir)) != NULL)
4260 if (strlen(dent->filename) >= 6 && dent->filename[0] == 'c')
4261 {
4262 /*
4263 * Allocate memory for the job...
4264 */
4265
4266 if ((job = calloc(sizeof(cupsd_job_t), 1)) == NULL)
4267 {
4268 cupsdLogMessage(CUPSD_LOG_ERROR, "Ran out of memory for jobs.");
4269 cupsDirClose(dir);
4270 return;
4271 }
4272
4273 /*
4274 * Assign the job ID...
4275 */
4276
4277 job->id = atoi(dent->filename + 1);
4278 job->back_pipes[0] = -1;
4279 job->back_pipes[1] = -1;
4280 job->print_pipes[0] = -1;
4281 job->print_pipes[1] = -1;
4282 job->side_pipes[0] = -1;
4283 job->side_pipes[1] = -1;
4284 job->status_pipes[0] = -1;
4285 job->status_pipes[1] = -1;
4286
4287 if (job->id >= NextJobId)
4288 NextJobId = job->id + 1;
4289
4290 /*
4291 * Load the job...
4292 */
4293
4294 if (cupsdLoadJob(job))
4295 {
4296 /*
4297 * Insert the job into the array, sorting by job priority and ID...
4298 */
4299
4300 cupsArrayAdd(Jobs, job);
4301
4302 if (job->state_value <= IPP_JOB_STOPPED)
4303 cupsArrayAdd(ActiveJobs, job);
4304 else
4305 unload_job(job);
4306 }
4307 else
4308 free(job);
4309 }
4310
4311 cupsDirClose(dir);
4312 }
4313
4314
4315 /*
4316 * 'remove_job_files()' - Remove the document files for a job.
4317 */
4318
4319 static void
4320 remove_job_files(cupsd_job_t *job) /* I - Job */
4321 {
4322 int i; /* Looping var */
4323 char filename[1024]; /* Document filename */
4324
4325
4326 if (job->num_files <= 0)
4327 return;
4328
4329 for (i = 1; i <= job->num_files; i ++)
4330 {
4331 snprintf(filename, sizeof(filename), "%s/d%05d-%03d", RequestRoot,
4332 job->id, i);
4333 cupsdUnlinkOrRemoveFile(filename);
4334 }
4335
4336 free(job->filetypes);
4337 free(job->compressions);
4338
4339 job->file_time = 0;
4340 job->num_files = 0;
4341 job->filetypes = NULL;
4342 job->compressions = NULL;
4343
4344 LastEvent |= CUPSD_EVENT_PRINTER_STATE_CHANGED;
4345 }
4346
4347
4348 /*
4349 * 'remove_job_history()' - Remove the control file for a job.
4350 */
4351
4352 static void
4353 remove_job_history(cupsd_job_t *job) /* I - Job */
4354 {
4355 char filename[1024]; /* Control filename */
4356
4357
4358 /*
4359 * Remove the job info file...
4360 */
4361
4362 snprintf(filename, sizeof(filename), "%s/c%05d", RequestRoot,
4363 job->id);
4364 cupsdUnlinkOrRemoveFile(filename);
4365
4366 LastEvent |= CUPSD_EVENT_PRINTER_STATE_CHANGED;
4367 }
4368
4369
4370 /*
4371 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4372 */
4373
4374 static void
4375 set_time(cupsd_job_t *job, /* I - Job to update */
4376 const char *name) /* I - Name of attribute */
4377 {
4378 ipp_attribute_t *attr; /* Time attribute */
4379 time_t curtime; /* Current time */
4380
4381
4382 curtime = time(NULL);
4383
4384 cupsdLogJob(job, CUPSD_LOG_DEBUG, "%s=%ld", name, (long)curtime);
4385
4386 if ((attr = ippFindAttribute(job->attrs, name, IPP_TAG_ZERO)) != NULL)
4387 {
4388 attr->value_tag = IPP_TAG_INTEGER;
4389 attr->values[0].integer = curtime;
4390 }
4391
4392 if (!strcmp(name, "time-at-completed"))
4393 {
4394 if (JobHistory < INT_MAX && attr)
4395 job->history_time = attr->values[0].integer + JobHistory;
4396 else
4397 job->history_time = INT_MAX;
4398
4399 if (job->history_time < JobHistoryUpdate || !JobHistoryUpdate)
4400 JobHistoryUpdate = job->history_time;
4401
4402 if (JobFiles < INT_MAX && attr)
4403 job->file_time = attr->values[0].integer + JobFiles;
4404 else
4405 job->file_time = INT_MAX;
4406
4407 if (job->file_time < JobHistoryUpdate || !JobHistoryUpdate)
4408 JobHistoryUpdate = job->file_time;
4409
4410 cupsdLogMessage(CUPSD_LOG_DEBUG2, "set_time: JobHistoryUpdate=%ld",
4411 (long)JobHistoryUpdate);
4412 }
4413 }
4414
4415
4416 /*
4417 * 'start_job()' - Start a print job.
4418 */
4419
4420 static void
4421 start_job(cupsd_job_t *job, /* I - Job ID */
4422 cupsd_printer_t *printer) /* I - Printer to print job */
4423 {
4424 const char *filename; /* Support filename */
4425 ipp_attribute_t *cancel_after = ippFindAttribute(job->attrs,
4426 "job-cancel-after",
4427 IPP_TAG_INTEGER);
4428 /* job-cancel-after attribute */
4429
4430
4431 cupsdLogMessage(CUPSD_LOG_DEBUG2, "start_job(job=%p(%d), printer=%p(%s))",
4432 job, job->id, printer, printer->name);
4433
4434 /*
4435 * Make sure we have some files around before we try to print...
4436 */
4437
4438 if (job->num_files == 0)
4439 {
4440 ippSetString(job->attrs, &job->reasons, 0, "aborted-by-system");
4441 cupsdSetJobState(job, IPP_JOB_ABORTED, CUPSD_JOB_DEFAULT,
4442 "Aborting job because it has no files.");
4443 return;
4444 }
4445
4446 /*
4447 * Update the printer and job state to "processing"...
4448 */
4449
4450 if (!cupsdLoadJob(job))
4451 return;
4452
4453 if (!job->printer_message)
4454 job->printer_message = ippFindAttribute(job->attrs,
4455 "job-printer-state-message",
4456 IPP_TAG_TEXT);
4457 if (job->printer_message)
4458 cupsdSetString(&(job->printer_message->values[0].string.text), "");
4459
4460 ippSetString(job->attrs, &job->reasons, 0, "job-printing");
4461 cupsdSetJobState(job, IPP_JOB_PROCESSING, CUPSD_JOB_DEFAULT, NULL);
4462 cupsdSetPrinterState(printer, IPP_PRINTER_PROCESSING, 0);
4463 cupsdSetPrinterReasons(printer, "-cups-remote-pending,"
4464 "cups-remote-pending-held,"
4465 "cups-remote-processing,"
4466 "cups-remote-stopped,"
4467 "cups-remote-canceled,"
4468 "cups-remote-aborted,"
4469 "cups-remote-completed");
4470
4471 job->cost = 0;
4472 job->current_file = 0;
4473 job->file_time = 0;
4474 job->history_time = 0;
4475 job->progress = 0;
4476 job->printer = printer;
4477 printer->job = job;
4478
4479 if (cancel_after)
4480 job->cancel_time = time(NULL) + ippGetInteger(cancel_after, 0);
4481 else if (MaxJobTime > 0)
4482 job->cancel_time = time(NULL) + MaxJobTime;
4483 else
4484 job->cancel_time = 0;
4485
4486 /*
4487 * Check for support files...
4488 */
4489
4490 cupsdSetPrinterReasons(job->printer, "-cups-missing-filter-warning,"
4491 "cups-insecure-filter-warning");
4492
4493 if (printer->pc)
4494 {
4495 for (filename = (const char *)cupsArrayFirst(printer->pc->support_files);
4496 filename;
4497 filename = (const char *)cupsArrayNext(printer->pc->support_files))
4498 {
4499 if (_cupsFileCheck(filename, _CUPS_FILE_CHECK_FILE, !RunUser,
4500 cupsdLogFCMessage, printer))
4501 break;
4502 }
4503 }
4504
4505 /*
4506 * Setup the last exit status and security profiles...
4507 */
4508
4509 job->status = 0;
4510 job->profile = cupsdCreateProfile(job->id, 0);
4511 job->bprofile = cupsdCreateProfile(job->id, 1);
4512
4513 /*
4514 * Create the status pipes and buffer...
4515 */
4516
4517 if (cupsdOpenPipe(job->status_pipes))
4518 {
4519 cupsdLogJob(job, CUPSD_LOG_DEBUG,
4520 "Unable to create job status pipes - %s.", strerror(errno));
4521
4522 cupsdSetJobState(job, IPP_JOB_STOPPED, CUPSD_JOB_DEFAULT,
4523 "Job stopped because the scheduler could not create the "
4524 "job status pipes.");
4525
4526 cupsdDestroyProfile(job->profile);
4527 job->profile = NULL;
4528 cupsdDestroyProfile(job->bprofile);
4529 job->bprofile = NULL;
4530 return;
4531 }
4532
4533 job->status_buffer = cupsdStatBufNew(job->status_pipes[0], NULL);
4534 job->status_level = CUPSD_LOG_INFO;
4535
4536 /*
4537 * Create the backchannel pipes and make them non-blocking...
4538 */
4539
4540 if (cupsdOpenPipe(job->back_pipes))
4541 {
4542 cupsdLogJob(job, CUPSD_LOG_DEBUG,
4543 "Unable to create back-channel pipes - %s.", strerror(errno));
4544
4545 cupsdSetJobState(job, IPP_JOB_STOPPED, CUPSD_JOB_DEFAULT,
4546 "Job stopped because the scheduler could not create the "
4547 "back-channel pipes.");
4548
4549 cupsdClosePipe(job->status_pipes);
4550 cupsdStatBufDelete(job->status_buffer);
4551 job->status_buffer = NULL;
4552
4553 cupsdDestroyProfile(job->profile);
4554 job->profile = NULL;
4555 cupsdDestroyProfile(job->bprofile);
4556 job->bprofile = NULL;
4557 return;
4558 }
4559
4560 fcntl(job->back_pipes[0], F_SETFL,
4561 fcntl(job->back_pipes[0], F_GETFL) | O_NONBLOCK);
4562 fcntl(job->back_pipes[1], F_SETFL,
4563 fcntl(job->back_pipes[1], F_GETFL) | O_NONBLOCK);
4564
4565 /*
4566 * Create the side-channel pipes and make them non-blocking...
4567 */
4568
4569 if (socketpair(AF_LOCAL, SOCK_STREAM, 0, job->side_pipes))
4570 {
4571 cupsdLogJob(job, CUPSD_LOG_DEBUG,
4572 "Unable to create side-channel pipes - %s.", strerror(errno));
4573
4574 cupsdSetJobState(job, IPP_JOB_STOPPED, CUPSD_JOB_DEFAULT,
4575 "Job stopped because the scheduler could not create the "
4576 "side-channel pipes.");
4577
4578 cupsdClosePipe(job->back_pipes);
4579
4580 cupsdClosePipe(job->status_pipes);
4581 cupsdStatBufDelete(job->status_buffer);
4582 job->status_buffer = NULL;
4583
4584 cupsdDestroyProfile(job->profile);
4585 job->profile = NULL;
4586 cupsdDestroyProfile(job->bprofile);
4587 job->bprofile = NULL;
4588 return;
4589 }
4590
4591 fcntl(job->side_pipes[0], F_SETFL,
4592 fcntl(job->side_pipes[0], F_GETFL) | O_NONBLOCK);
4593 fcntl(job->side_pipes[1], F_SETFL,
4594 fcntl(job->side_pipes[1], F_GETFL) | O_NONBLOCK);
4595
4596 fcntl(job->side_pipes[0], F_SETFD,
4597 fcntl(job->side_pipes[0], F_GETFD) | FD_CLOEXEC);
4598 fcntl(job->side_pipes[1], F_SETFD,
4599 fcntl(job->side_pipes[1], F_GETFD) | FD_CLOEXEC);
4600
4601 /*
4602 * Now start the first file in the job...
4603 */
4604
4605 cupsdContinueJob(job);
4606 }
4607
4608
4609 /*
4610 * 'stop_job()' - Stop a print job.
4611 */
4612
4613 static void
4614 stop_job(cupsd_job_t *job, /* I - Job */
4615 cupsd_jobaction_t action) /* I - Action */
4616 {
4617 int i; /* Looping var */
4618
4619
4620 cupsdLogMessage(CUPSD_LOG_DEBUG2, "stop_job(job=%p(%d), action=%d)", job,
4621 job->id, action);
4622
4623 FilterLevel -= job->cost;
4624 job->cost = 0;
4625
4626 if (action == CUPSD_JOB_DEFAULT && !job->kill_time)
4627 job->kill_time = time(NULL) + JobKillDelay;
4628 else if (action >= CUPSD_JOB_FORCE)
4629 job->kill_time = 0;
4630
4631 for (i = 0; job->filters[i]; i ++)
4632 if (job->filters[i] > 0)
4633 {
4634 cupsdEndProcess(job->filters[i], action >= CUPSD_JOB_FORCE);
4635
4636 if (action >= CUPSD_JOB_FORCE)
4637 job->filters[i] = -job->filters[i];
4638 }
4639
4640 if (job->backend > 0)
4641 {
4642 cupsdEndProcess(job->backend, action >= CUPSD_JOB_FORCE);
4643
4644 if (action >= CUPSD_JOB_FORCE)
4645 job->backend = -job->backend;
4646 }
4647
4648 if (action >= CUPSD_JOB_FORCE)
4649 {
4650 /*
4651 * Clear job status...
4652 */
4653
4654 job->status = 0;
4655 }
4656 }
4657
4658
4659 /*
4660 * 'unload_job()' - Unload a job from memory.
4661 */
4662
4663 static void
4664 unload_job(cupsd_job_t *job) /* I - Job */
4665 {
4666 if (!job->attrs)
4667 return;
4668
4669 cupsdLogJob(job, CUPSD_LOG_DEBUG, "Unloading...");
4670
4671 ippDelete(job->attrs);
4672
4673 job->attrs = NULL;
4674 job->state = NULL;
4675 job->reasons = NULL;
4676 job->sheets = NULL;
4677 job->job_sheets = NULL;
4678 job->printer_message = NULL;
4679 job->printer_reasons = NULL;
4680 }
4681
4682
4683 /*
4684 * 'update_job()' - Read a status update from a job's filters.
4685 */
4686
4687 void
4688 update_job(cupsd_job_t *job) /* I - Job to check */
4689 {
4690 int i; /* Looping var */
4691 int copies; /* Number of copies printed */
4692 char message[CUPSD_SB_BUFFER_SIZE],
4693 /* Message text */
4694 *ptr; /* Pointer update... */
4695 int loglevel, /* Log level for message */
4696 event = 0; /* Events? */
4697 static const char * const levels[] = /* Log levels */
4698 {
4699 "NONE",
4700 "EMERG",
4701 "ALERT",
4702 "CRIT",
4703 "ERROR",
4704 "WARN",
4705 "NOTICE",
4706 "INFO",
4707 "DEBUG",
4708 "DEBUG2"
4709 };
4710
4711
4712 /*
4713 * Get the printer associated with this job; if the printer is stopped for
4714 * any reason then job->printer will be reset to NULL, so make sure we have
4715 * a valid pointer...
4716 */
4717
4718 while ((ptr = cupsdStatBufUpdate(job->status_buffer, &loglevel,
4719 message, sizeof(message))) != NULL)
4720 {
4721 /*
4722 * Process page and printer state messages as needed...
4723 */
4724
4725 if (loglevel == CUPSD_LOG_PAGE)
4726 {
4727 /*
4728 * Page message; send the message to the page_log file and update the
4729 * job sheet count...
4730 */
4731
4732 cupsdLogJob(job, CUPSD_LOG_DEBUG, "PAGE: %s", message);
4733
4734 if (job->sheets)
4735 {
4736 if (!_cups_strncasecmp(message, "total ", 6))
4737 {
4738 /*
4739 * Got a total count of pages from a backend or filter...
4740 */
4741
4742 copies = atoi(message + 6);
4743 copies -= job->sheets->values[0].integer; /* Just track the delta */
4744 }
4745 else if (!sscanf(message, "%*d%d", &copies))
4746 copies = 1;
4747
4748 job->sheets->values[0].integer += copies;
4749
4750 if (job->printer->page_limit)
4751 cupsdUpdateQuota(job->printer, job->username, copies, 0);
4752 }
4753
4754 cupsdLogPage(job, message);
4755
4756 if (job->sheets)
4757 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS, job->printer, job,
4758 "Printed %d page(s).", job->sheets->values[0].integer);
4759 }
4760 else if (loglevel == CUPSD_LOG_JOBSTATE)
4761 {
4762 /*
4763 * Support "keyword" to set job-state-reasons to the specified keyword.
4764 * This is sufficient for the current paid printing stuff.
4765 */
4766
4767 cupsdLogJob(job, CUPSD_LOG_DEBUG, "JOBSTATE: %s", message);
4768
4769 ippSetString(job->attrs, &job->reasons, 0, message);
4770 }
4771 else if (loglevel == CUPSD_LOG_STATE)
4772 {
4773 cupsdLogJob(job, CUPSD_LOG_DEBUG, "STATE: %s", message);
4774
4775 if (!strcmp(message, "paused"))
4776 {
4777 cupsdStopPrinter(job->printer, 1);
4778 return;
4779 }
4780 else if (message[0] && cupsdSetPrinterReasons(job->printer, message))
4781 {
4782 event |= CUPSD_EVENT_PRINTER_STATE;
4783
4784 if (MaxJobTime > 0)
4785 {
4786 /*
4787 * Reset cancel time after connecting to the device...
4788 */
4789
4790 for (i = 0; i < job->printer->num_reasons; i ++)
4791 if (!strcmp(job->printer->reasons[i], "connecting-to-device"))
4792 break;
4793
4794 if (i >= job->printer->num_reasons)
4795 {
4796 ipp_attribute_t *cancel_after = ippFindAttribute(job->attrs,
4797 "job-cancel-after",
4798 IPP_TAG_INTEGER);
4799 /* job-cancel-after attribute */
4800
4801 if (cancel_after)
4802 job->cancel_time = time(NULL) + ippGetInteger(cancel_after, 0);
4803 else
4804 job->cancel_time = time(NULL) + MaxJobTime;
4805 }
4806 }
4807 }
4808
4809 update_job_attrs(job, 0);
4810 }
4811 else if (loglevel == CUPSD_LOG_ATTR)
4812 {
4813 /*
4814 * Set attribute(s)...
4815 */
4816
4817 int num_attrs; /* Number of attributes */
4818 cups_option_t *attrs; /* Attributes */
4819 const char *attr; /* Attribute */
4820
4821 cupsdLogJob(job, CUPSD_LOG_DEBUG, "ATTR: %s", message);
4822
4823 num_attrs = cupsParseOptions(message, 0, &attrs);
4824
4825 if ((attr = cupsGetOption("auth-info-default", num_attrs,
4826 attrs)) != NULL)
4827 {
4828 job->printer->num_options = cupsAddOption("auth-info", attr,
4829 job->printer->num_options,
4830 &(job->printer->options));
4831 cupsdSetPrinterAttrs(job->printer);
4832
4833 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4834 }
4835
4836 if ((attr = cupsGetOption("auth-info-required", num_attrs,
4837 attrs)) != NULL)
4838 {
4839 cupsdSetAuthInfoRequired(job->printer, attr, NULL);
4840 cupsdSetPrinterAttrs(job->printer);
4841
4842 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4843 }
4844
4845 if ((attr = cupsGetOption("job-media-progress", num_attrs,
4846 attrs)) != NULL)
4847 {
4848 int progress = atoi(attr);
4849
4850
4851 if (progress >= 0 && progress <= 100)
4852 {
4853 job->progress = progress;
4854
4855 if (job->sheets)
4856 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS, job->printer, job,
4857 "Printing page %d, %d%%",
4858 job->sheets->values[0].integer, job->progress);
4859 }
4860 }
4861
4862 if ((attr = cupsGetOption("printer-alert", num_attrs, attrs)) != NULL)
4863 {
4864 cupsdSetString(&job->printer->alert, attr);
4865 event |= CUPSD_EVENT_PRINTER_STATE;
4866 }
4867
4868 if ((attr = cupsGetOption("printer-alert-description", num_attrs,
4869 attrs)) != NULL)
4870 {
4871 cupsdSetString(&job->printer->alert_description, attr);
4872 event |= CUPSD_EVENT_PRINTER_STATE;
4873 }
4874
4875 if ((attr = cupsGetOption("marker-colors", num_attrs, attrs)) != NULL)
4876 {
4877 cupsdSetPrinterAttr(job->printer, "marker-colors", (char *)attr);
4878 job->printer->marker_time = time(NULL);
4879 event |= CUPSD_EVENT_PRINTER_STATE;
4880 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4881 }
4882
4883 if ((attr = cupsGetOption("marker-levels", num_attrs, attrs)) != NULL)
4884 {
4885 cupsdSetPrinterAttr(job->printer, "marker-levels", (char *)attr);
4886 job->printer->marker_time = time(NULL);
4887 event |= CUPSD_EVENT_PRINTER_STATE;
4888 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4889 }
4890
4891 if ((attr = cupsGetOption("marker-low-levels", num_attrs, attrs)) != NULL)
4892 {
4893 cupsdSetPrinterAttr(job->printer, "marker-low-levels", (char *)attr);
4894 job->printer->marker_time = time(NULL);
4895 event |= CUPSD_EVENT_PRINTER_STATE;
4896 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4897 }
4898
4899 if ((attr = cupsGetOption("marker-high-levels", num_attrs, attrs)) != NULL)
4900 {
4901 cupsdSetPrinterAttr(job->printer, "marker-high-levels", (char *)attr);
4902 job->printer->marker_time = time(NULL);
4903 event |= CUPSD_EVENT_PRINTER_STATE;
4904 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4905 }
4906
4907 if ((attr = cupsGetOption("marker-message", num_attrs, attrs)) != NULL)
4908 {
4909 cupsdSetPrinterAttr(job->printer, "marker-message", (char *)attr);
4910 job->printer->marker_time = time(NULL);
4911 event |= CUPSD_EVENT_PRINTER_STATE;
4912 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4913 }
4914
4915 if ((attr = cupsGetOption("marker-names", num_attrs, attrs)) != NULL)
4916 {
4917 cupsdSetPrinterAttr(job->printer, "marker-names", (char *)attr);
4918 job->printer->marker_time = time(NULL);
4919 event |= CUPSD_EVENT_PRINTER_STATE;
4920 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4921 }
4922
4923 if ((attr = cupsGetOption("marker-types", num_attrs, attrs)) != NULL)
4924 {
4925 cupsdSetPrinterAttr(job->printer, "marker-types", (char *)attr);
4926 job->printer->marker_time = time(NULL);
4927 event |= CUPSD_EVENT_PRINTER_STATE;
4928 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4929 }
4930
4931 cupsFreeOptions(num_attrs, attrs);
4932 }
4933 else if (loglevel == CUPSD_LOG_PPD)
4934 {
4935 /*
4936 * Set attribute(s)...
4937 */
4938
4939 cupsdLogJob(job, CUPSD_LOG_DEBUG, "PPD: %s", message);
4940
4941 job->num_keywords = cupsParseOptions(message, job->num_keywords,
4942 &job->keywords);
4943 }
4944 else
4945 {
4946 /*
4947 * Strip legacy message prefix...
4948 */
4949
4950 if (!strncmp(message, "recoverable:", 12))
4951 {
4952 ptr = message + 12;
4953 while (isspace(*ptr & 255))
4954 ptr ++;
4955 }
4956 else if (!strncmp(message, "recovered:", 10))
4957 {
4958 ptr = message + 10;
4959 while (isspace(*ptr & 255))
4960 ptr ++;
4961 }
4962 else
4963 ptr = message;
4964
4965 if (*ptr)
4966 cupsdLogJob(job, loglevel, "%s", ptr);
4967
4968 if (loglevel < CUPSD_LOG_DEBUG &&
4969 strcmp(job->printer->state_message, ptr))
4970 {
4971 strlcpy(job->printer->state_message, ptr,
4972 sizeof(job->printer->state_message));
4973
4974 event |= CUPSD_EVENT_PRINTER_STATE | CUPSD_EVENT_JOB_PROGRESS;
4975
4976 if (loglevel <= job->status_level && job->status_level > CUPSD_LOG_ERROR)
4977 {
4978 /*
4979 * Some messages show in the job-printer-state-message attribute...
4980 */
4981
4982 if (loglevel != CUPSD_LOG_NOTICE)
4983 job->status_level = loglevel;
4984
4985 update_job_attrs(job, 1);
4986
4987 cupsdLogJob(job, CUPSD_LOG_DEBUG,
4988 "Set job-printer-state-message to \"%s\", "
4989 "current level=%s",
4990 job->printer_message->values[0].string.text,
4991 levels[job->status_level]);
4992 }
4993 }
4994 }
4995
4996 if (!strchr(job->status_buffer->buffer, '\n'))
4997 break;
4998 }
4999
5000 if (event & CUPSD_EVENT_JOB_PROGRESS)
5001 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS, job->printer, job,
5002 "%s", job->printer->state_message);
5003 if (event & CUPSD_EVENT_PRINTER_STATE)
5004 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE, job->printer, NULL,
5005 (job->printer->type & CUPS_PRINTER_CLASS) ?
5006 "Class \"%s\" state changed." :
5007 "Printer \"%s\" state changed.",
5008 job->printer->name);
5009
5010
5011 if (ptr == NULL && !job->status_buffer->bufused)
5012 {
5013 /*
5014 * See if all of the filters and the backend have returned their
5015 * exit statuses.
5016 */
5017
5018 for (i = 0; job->filters[i] < 0; i ++);
5019
5020 if (job->filters[i])
5021 {
5022 /*
5023 * EOF but we haven't collected the exit status of all filters...
5024 */
5025
5026 cupsdCheckProcess();
5027 return;
5028 }
5029
5030 if (job->current_file >= job->num_files && job->backend > 0)
5031 {
5032 /*
5033 * EOF but we haven't collected the exit status of the backend...
5034 */
5035
5036 cupsdCheckProcess();
5037 return;
5038 }
5039
5040 /*
5041 * Handle the end of job stuff...
5042 */
5043
5044 finalize_job(job, 1);
5045
5046 /*
5047 * Check for new jobs...
5048 */
5049
5050 cupsdCheckJobs();
5051 }
5052 }
5053
5054
5055 /*
5056 * 'update_job_attrs()' - Update the job-printer-* attributes.
5057 */
5058
5059 void
5060 update_job_attrs(cupsd_job_t *job, /* I - Job to update */
5061 int do_message)/* I - 1 = copy job-printer-state message */
5062 {
5063 int i; /* Looping var */
5064 int num_reasons; /* Actual number of reasons */
5065 const char * const *reasons; /* Reasons */
5066 static const char *none = "none"; /* "none" reason */
5067
5068
5069 /*
5070 * Get/create the job-printer-state-* attributes...
5071 */
5072
5073 if (!job->printer_message)
5074 {
5075 if ((job->printer_message = ippFindAttribute(job->attrs,
5076 "job-printer-state-message",
5077 IPP_TAG_TEXT)) == NULL)
5078 job->printer_message = ippAddString(job->attrs, IPP_TAG_JOB, IPP_TAG_TEXT,
5079 "job-printer-state-message",
5080 NULL, "");
5081 }
5082
5083 if (!job->printer_reasons)
5084 job->printer_reasons = ippFindAttribute(job->attrs,
5085 "job-printer-state-reasons",
5086 IPP_TAG_KEYWORD);
5087
5088 /*
5089 * Copy or clear the printer-state-message value as needed...
5090 */
5091
5092 if (job->state_value != IPP_JOB_PROCESSING &&
5093 job->status_level == CUPSD_LOG_INFO)
5094 {
5095 cupsdSetString(&(job->printer_message->values[0].string.text), "");
5096
5097 job->dirty = 1;
5098 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
5099 }
5100 else if (job->printer->state_message[0] && do_message)
5101 {
5102 cupsdSetString(&(job->printer_message->values[0].string.text),
5103 job->printer->state_message);
5104
5105 job->dirty = 1;
5106 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
5107 }
5108
5109 /*
5110 * ... and the printer-state-reasons value...
5111 */
5112
5113 if (job->printer->num_reasons == 0)
5114 {
5115 num_reasons = 1;
5116 reasons = &none;
5117 }
5118 else
5119 {
5120 num_reasons = job->printer->num_reasons;
5121 reasons = (const char * const *)job->printer->reasons;
5122 }
5123
5124 if (!job->printer_reasons || job->printer_reasons->num_values != num_reasons)
5125 {
5126 /*
5127 * Replace/create a job-printer-state-reasons attribute...
5128 */
5129
5130 ippDeleteAttribute(job->attrs, job->printer_reasons);
5131
5132 job->printer_reasons = ippAddStrings(job->attrs,
5133 IPP_TAG_JOB, IPP_TAG_KEYWORD,
5134 "job-printer-state-reasons",
5135 num_reasons, NULL, NULL);
5136 }
5137 else
5138 {
5139 /*
5140 * Don't bother clearing the reason strings if they are the same...
5141 */
5142
5143 for (i = 0; i < num_reasons; i ++)
5144 if (strcmp(job->printer_reasons->values[i].string.text, reasons[i]))
5145 break;
5146
5147 if (i >= num_reasons)
5148 return;
5149
5150 /*
5151 * Not the same, so free the current strings...
5152 */
5153
5154 for (i = 0; i < num_reasons; i ++)
5155 _cupsStrFree(job->printer_reasons->values[i].string.text);
5156 }
5157
5158 /*
5159 * Copy the reasons...
5160 */
5161
5162 for (i = 0; i < num_reasons; i ++)
5163 job->printer_reasons->values[i].string.text = _cupsStrAlloc(reasons[i]);
5164
5165 job->dirty = 1;
5166 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
5167 }
5168
5169
5170 /*
5171 * End of "$Id$".
5172 */