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