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