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