]> git.ipfire.org Git - thirdparty/cups.git/blob - scheduler/job.c
The scheduler now reads the spool directory if one or more job cache entries
[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
218
219 /*
220 * 'cupsdCheckJobs()' - Check the pending jobs and start any if the destination
221 * is available.
222 */
223
224 void
225 cupsdCheckJobs(void)
226 {
227 cupsd_job_t *job; /* Current job in queue */
228 cupsd_printer_t *printer, /* Printer destination */
229 *pclass; /* Printer class destination */
230 ipp_attribute_t *attr; /* Job attribute */
231 time_t curtime; /* Current time */
232
233
234 curtime = time(NULL);
235
236 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdCheckJobs: %d active jobs, sleeping=%d, ac-power=%d, reload=%d, curtime=%ld", cupsArrayCount(ActiveJobs), Sleeping, ACPower, NeedReload, (long)curtime);
237
238 for (job = (cupsd_job_t *)cupsArrayFirst(ActiveJobs);
239 job;
240 job = (cupsd_job_t *)cupsArrayNext(ActiveJobs))
241 {
242 cupsdLogMessage(CUPSD_LOG_DEBUG2,
243 "cupsdCheckJobs: Job %d - dest=\"%s\", printer=%p, "
244 "state=%d, cancel_time=%ld, hold_until=%ld, kill_time=%ld, "
245 "pending_cost=%d, pending_timeout=%ld", job->id, job->dest,
246 job->printer, job->state_value, (long)job->cancel_time,
247 (long)job->hold_until, (long)job->kill_time,
248 job->pending_cost, (long)job->pending_timeout);
249
250 /*
251 * Kill jobs if they are unresponsive...
252 */
253
254 if (job->kill_time && job->kill_time <= curtime)
255 {
256 if (!job->completed)
257 cupsdLogJob(job, CUPSD_LOG_ERROR, "Stopping unresponsive job.");
258
259 stop_job(job, CUPSD_JOB_FORCE);
260 continue;
261 }
262
263 /*
264 * Cancel stuck jobs...
265 */
266
267 if (job->cancel_time && job->cancel_time <= curtime)
268 {
269 int cancel_after; /* job-cancel-after value */
270
271 attr = ippFindAttribute(job->attrs, "job-cancel-after", IPP_TAG_INTEGER);
272 cancel_after = attr ? ippGetInteger(attr, 0) : MaxJobTime;
273
274 if (job->completed)
275 cupsdSetJobState(job, IPP_JOB_CANCELED, CUPSD_JOB_FORCE, "Marking stuck job as completed after %d seconds.", cancel_after);
276 else
277 cupsdSetJobState(job, IPP_JOB_CANCELED, CUPSD_JOB_DEFAULT, "Canceling stuck job after %d seconds.", cancel_after);
278 continue;
279 }
280
281 /*
282 * Start held jobs if they are ready...
283 */
284
285 if (job->state_value == IPP_JOB_HELD &&
286 job->hold_until &&
287 job->hold_until < curtime)
288 {
289 if (job->pending_timeout)
290 {
291 /*
292 * This job is pending; check that we don't have an active Send-Document
293 * operation in progress on any of the client connections, then timeout
294 * the job so we can start printing...
295 */
296
297 cupsd_client_t *con; /* Current client connection */
298
299 for (con = (cupsd_client_t *)cupsArrayFirst(Clients);
300 con;
301 con = (cupsd_client_t *)cupsArrayNext(Clients))
302 if (con->request &&
303 con->request->request.op.operation_id == IPP_SEND_DOCUMENT)
304 break;
305
306 if (con)
307 continue;
308
309 if (cupsdTimeoutJob(job))
310 continue;
311 }
312
313 cupsdSetJobState(job, IPP_JOB_PENDING, CUPSD_JOB_DEFAULT,
314 "Job submission timed out.");
315 }
316
317 /*
318 * Continue jobs that are waiting on the FilterLimit...
319 */
320
321 if (job->pending_cost > 0 &&
322 ((FilterLevel + job->pending_cost) < FilterLimit || FilterLevel == 0))
323 cupsdContinueJob(job);
324
325 /*
326 * Start pending jobs if the destination is available...
327 */
328
329 if (job->state_value == IPP_JOB_PENDING && !NeedReload &&
330 (!Sleeping || ACPower) && !DoingShutdown && !job->printer)
331 {
332 printer = cupsdFindDest(job->dest);
333 pclass = NULL;
334
335 while (printer && (printer->type & CUPS_PRINTER_CLASS))
336 {
337 /*
338 * If the class is remote, just pass it to the remote server...
339 */
340
341 pclass = printer;
342
343 if (pclass->state == IPP_PRINTER_STOPPED)
344 printer = NULL;
345 else if (pclass->type & CUPS_PRINTER_REMOTE)
346 break;
347 else
348 printer = cupsdFindAvailablePrinter(printer->name);
349 }
350
351 if (!printer && !pclass)
352 {
353 /*
354 * Whoa, the printer and/or class for this destination went away;
355 * cancel the job...
356 */
357
358 cupsdSetJobState(job, IPP_JOB_ABORTED, CUPSD_JOB_PURGE,
359 "Job aborted because the destination printer/class "
360 "has gone away.");
361 }
362 else if (printer && !printer->holding_new_jobs)
363 {
364 /*
365 * See if the printer is available or remote and not printing a job;
366 * if so, start the job...
367 */
368
369 if (pclass)
370 {
371 /*
372 * Add/update a job-actual-printer-uri attribute for this job
373 * so that we know which printer actually printed the job...
374 */
375
376 if ((attr = ippFindAttribute(job->attrs, "job-actual-printer-uri",
377 IPP_TAG_URI)) != NULL)
378 ippSetString(job->attrs, &attr, 0, printer->uri);
379 else
380 ippAddString(job->attrs, IPP_TAG_JOB, IPP_TAG_URI,
381 "job-actual-printer-uri", NULL, printer->uri);
382
383 job->dirty = 1;
384 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
385 }
386
387 if (!printer->job && printer->state == IPP_PRINTER_IDLE)
388 {
389 /*
390 * Start the job...
391 */
392
393 cupsArraySave(ActiveJobs);
394 start_job(job, printer);
395 cupsArrayRestore(ActiveJobs);
396 }
397 }
398 }
399 }
400 }
401
402
403 /*
404 * 'cupsdCleanJobs()' - Clean out old jobs.
405 */
406
407 void
408 cupsdCleanJobs(void)
409 {
410 cupsd_job_t *job; /* Current job */
411 time_t curtime; /* Current time */
412
413
414 cupsdLogMessage(CUPSD_LOG_DEBUG2,
415 "cupsdCleanJobs: MaxJobs=%d, JobHistory=%d, JobFiles=%d",
416 MaxJobs, JobHistory, JobFiles);
417
418 if (MaxJobs <= 0 && JobHistory == INT_MAX && JobFiles == INT_MAX)
419 return;
420
421 curtime = time(NULL);
422 JobHistoryUpdate = 0;
423
424 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
425 job;
426 job = (cupsd_job_t *)cupsArrayNext(Jobs))
427 {
428 if (job->state_value >= IPP_JOB_CANCELED && !job->printer)
429 {
430 /*
431 * Expire old jobs (or job files)...
432 */
433
434 if ((MaxJobs > 0 && cupsArrayCount(Jobs) >= MaxJobs) ||
435 (job->history_time && job->history_time <= curtime))
436 {
437 cupsdLogJob(job, CUPSD_LOG_DEBUG, "Removing from history.");
438 cupsdDeleteJob(job, CUPSD_JOB_PURGE);
439 }
440 else if (job->file_time && job->file_time <= curtime)
441 {
442 cupsdLogJob(job, CUPSD_LOG_DEBUG, "Removing document files.");
443 remove_job_files(job);
444
445 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
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 if (job->printer && job->printer->temporary)
2199 {
2200 /*
2201 * Don't save jobs on temporary printers...
2202 */
2203
2204 continue;
2205 }
2206
2207 cupsFilePrintf(fp, "<Job %d>\n", job->id);
2208 cupsFilePrintf(fp, "State %d\n", job->state_value);
2209 cupsFilePrintf(fp, "Created %ld\n", (long)job->creation_time);
2210 if (job->completed_time)
2211 cupsFilePrintf(fp, "Completed %ld\n", (long)job->completed_time);
2212 cupsFilePrintf(fp, "Priority %d\n", job->priority);
2213 if (job->hold_until)
2214 cupsFilePrintf(fp, "HoldUntil %ld\n", (long)job->hold_until);
2215 cupsFilePrintf(fp, "Username %s\n", job->username);
2216 if (job->name)
2217 cupsFilePutConf(fp, "Name", job->name);
2218 cupsFilePrintf(fp, "Destination %s\n", job->dest);
2219 cupsFilePrintf(fp, "DestType %d\n", job->dtype);
2220 cupsFilePrintf(fp, "KOctets %d\n", job->koctets);
2221 cupsFilePrintf(fp, "NumFiles %d\n", job->num_files);
2222 for (i = 0; i < job->num_files; i ++)
2223 cupsFilePrintf(fp, "File %d %s/%s %d\n", i + 1, job->filetypes[i]->super,
2224 job->filetypes[i]->type, job->compressions[i]);
2225 cupsFilePuts(fp, "</Job>\n");
2226 }
2227
2228 cupsdCloseCreatedConfFile(fp, filename);
2229 }
2230
2231
2232 /*
2233 * 'cupsdSaveJob()' - Save a job to disk.
2234 */
2235
2236 void
2237 cupsdSaveJob(cupsd_job_t *job) /* I - Job */
2238 {
2239 char filename[1024]; /* Job control filename */
2240 cups_file_t *fp; /* Job file */
2241
2242
2243 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
2244 job, job->id, job->attrs);
2245
2246 if (job->printer && job->printer->temporary)
2247 {
2248 /*
2249 * Don't save jobs on temporary printers...
2250 */
2251
2252 job->dirty = 0;
2253 return;
2254 }
2255
2256 snprintf(filename, sizeof(filename), "%s/c%05d", RequestRoot, job->id);
2257
2258 if ((fp = cupsdCreateConfFile(filename, ConfigFilePerm & 0600)) == NULL)
2259 return;
2260
2261 fchown(cupsFileNumber(fp), RunUser, Group);
2262
2263 job->attrs->state = IPP_IDLE;
2264
2265 if (ippWriteIO(fp, (ipp_iocb_t)cupsFileWrite, 1, NULL,
2266 job->attrs) != IPP_DATA)
2267 {
2268 cupsdLogJob(job, CUPSD_LOG_ERROR, "Unable to write job control file.");
2269 cupsFileClose(fp);
2270 return;
2271 }
2272
2273 if (!cupsdCloseCreatedConfFile(fp, filename))
2274 {
2275 /*
2276 * Remove backup file and mark this job as clean...
2277 */
2278
2279 strlcat(filename, ".O", sizeof(filename));
2280 unlink(filename);
2281
2282 job->dirty = 0;
2283 }
2284 }
2285
2286
2287 /*
2288 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
2289 */
2290
2291 void
2292 cupsdSetJobHoldUntil(cupsd_job_t *job, /* I - Job */
2293 const char *when, /* I - When to resume */
2294 int update)/* I - Update job-hold-until attr? */
2295 {
2296 time_t curtime; /* Current time */
2297 struct tm *curdate; /* Current date */
2298 int hour; /* Hold hour */
2299 int minute; /* Hold minute */
2300 int second = 0; /* Hold second */
2301
2302
2303 cupsdLogMessage(CUPSD_LOG_DEBUG2,
2304 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
2305 job, job->id, when, update);
2306
2307 if (update)
2308 {
2309 /*
2310 * Update the job-hold-until attribute...
2311 */
2312
2313 ipp_attribute_t *attr; /* job-hold-until attribute */
2314
2315 if ((attr = ippFindAttribute(job->attrs, "job-hold-until",
2316 IPP_TAG_KEYWORD)) == NULL)
2317 attr = ippFindAttribute(job->attrs, "job-hold-until", IPP_TAG_NAME);
2318
2319 if (attr)
2320 ippSetString(job->attrs, &attr, 0, when);
2321 else
2322 attr = ippAddString(job->attrs, IPP_TAG_JOB, IPP_TAG_KEYWORD,
2323 "job-hold-until", NULL, when);
2324
2325 if (attr)
2326 {
2327 if (isdigit(when[0] & 255))
2328 attr->value_tag = IPP_TAG_NAME;
2329 else
2330 attr->value_tag = IPP_TAG_KEYWORD;
2331
2332 job->dirty = 1;
2333 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2334 }
2335
2336 }
2337
2338 if (strcmp(when, "no-hold"))
2339 ippSetString(job->attrs, &job->reasons, 0, "job-hold-until-specified");
2340 else
2341 ippSetString(job->attrs, &job->reasons, 0, "none");
2342
2343 /*
2344 * Update the hold time...
2345 */
2346
2347 job->cancel_time = 0;
2348
2349 if (!strcmp(when, "indefinite") || !strcmp(when, "auth-info-required"))
2350 {
2351 /*
2352 * Hold indefinitely...
2353 */
2354
2355 job->hold_until = 0;
2356
2357 if (MaxHoldTime > 0)
2358 job->cancel_time = time(NULL) + MaxHoldTime;
2359 }
2360 else if (!strcmp(when, "day-time"))
2361 {
2362 /*
2363 * Hold to 6am the next morning unless local time is < 6pm.
2364 */
2365
2366 curtime = time(NULL);
2367 curdate = localtime(&curtime);
2368
2369 if (curdate->tm_hour < 18)
2370 job->hold_until = curtime;
2371 else
2372 job->hold_until = curtime +
2373 ((29 - curdate->tm_hour) * 60 + 59 -
2374 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2375 }
2376 else if (!strcmp(when, "evening") || !strcmp(when, "night"))
2377 {
2378 /*
2379 * Hold to 6pm unless local time is > 6pm or < 6am.
2380 */
2381
2382 curtime = time(NULL);
2383 curdate = localtime(&curtime);
2384
2385 if (curdate->tm_hour < 6 || curdate->tm_hour >= 18)
2386 job->hold_until = curtime;
2387 else
2388 job->hold_until = curtime +
2389 ((17 - curdate->tm_hour) * 60 + 59 -
2390 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2391 }
2392 else if (!strcmp(when, "second-shift"))
2393 {
2394 /*
2395 * Hold to 4pm unless local time is > 4pm.
2396 */
2397
2398 curtime = time(NULL);
2399 curdate = localtime(&curtime);
2400
2401 if (curdate->tm_hour >= 16)
2402 job->hold_until = curtime;
2403 else
2404 job->hold_until = curtime +
2405 ((15 - curdate->tm_hour) * 60 + 59 -
2406 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2407 }
2408 else if (!strcmp(when, "third-shift"))
2409 {
2410 /*
2411 * Hold to 12am unless local time is < 8am.
2412 */
2413
2414 curtime = time(NULL);
2415 curdate = localtime(&curtime);
2416
2417 if (curdate->tm_hour < 8)
2418 job->hold_until = curtime;
2419 else
2420 job->hold_until = curtime +
2421 ((23 - curdate->tm_hour) * 60 + 59 -
2422 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2423 }
2424 else if (!strcmp(when, "weekend"))
2425 {
2426 /*
2427 * Hold to weekend unless we are in the weekend.
2428 */
2429
2430 curtime = time(NULL);
2431 curdate = localtime(&curtime);
2432
2433 if (curdate->tm_wday == 0 || curdate->tm_wday == 6)
2434 job->hold_until = curtime;
2435 else
2436 job->hold_until = curtime +
2437 (((5 - curdate->tm_wday) * 24 +
2438 (17 - curdate->tm_hour)) * 60 + 59 -
2439 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2440 }
2441 else if (sscanf(when, "%d:%d:%d", &hour, &minute, &second) >= 2)
2442 {
2443 /*
2444 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2445 */
2446
2447 curtime = time(NULL);
2448 curdate = gmtime(&curtime);
2449
2450 job->hold_until = curtime +
2451 ((hour - curdate->tm_hour) * 60 + minute -
2452 curdate->tm_min) * 60 + second - curdate->tm_sec;
2453
2454 /*
2455 * Hold until next day as needed...
2456 */
2457
2458 if (job->hold_until < curtime)
2459 job->hold_until += 24 * 60 * 60;
2460 }
2461
2462 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdSetJobHoldUntil: hold_until=%d",
2463 (int)job->hold_until);
2464 }
2465
2466
2467 /*
2468 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2469 * the list as needed.
2470 */
2471
2472 void
2473 cupsdSetJobPriority(
2474 cupsd_job_t *job, /* I - Job ID */
2475 int priority) /* I - New priority (0 to 100) */
2476 {
2477 ipp_attribute_t *attr; /* Job attribute */
2478
2479
2480 /*
2481 * Don't change completed jobs...
2482 */
2483
2484 if (job->state_value >= IPP_JOB_PROCESSING)
2485 return;
2486
2487 /*
2488 * Set the new priority and re-add the job into the active list...
2489 */
2490
2491 cupsArrayRemove(ActiveJobs, job);
2492
2493 job->priority = priority;
2494
2495 if ((attr = ippFindAttribute(job->attrs, "job-priority",
2496 IPP_TAG_INTEGER)) != NULL)
2497 attr->values[0].integer = priority;
2498 else
2499 ippAddInteger(job->attrs, IPP_TAG_JOB, IPP_TAG_INTEGER, "job-priority",
2500 priority);
2501
2502 cupsArrayAdd(ActiveJobs, job);
2503
2504 job->dirty = 1;
2505 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2506 }
2507
2508
2509 /*
2510 * 'cupsdSetJobState()' - Set the state of the specified print job.
2511 */
2512
2513 void
2514 cupsdSetJobState(
2515 cupsd_job_t *job, /* I - Job to cancel */
2516 ipp_jstate_t newstate, /* I - New job state */
2517 cupsd_jobaction_t action, /* I - Action to take */
2518 const char *message, /* I - Message to log */
2519 ...) /* I - Additional arguments as needed */
2520 {
2521 int i; /* Looping var */
2522 ipp_jstate_t oldstate; /* Old state */
2523 char filename[1024]; /* Job filename */
2524 ipp_attribute_t *attr; /* Job attribute */
2525
2526
2527 cupsdLogMessage(CUPSD_LOG_DEBUG2,
2528 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2529 "action=%d, message=\"%s\")", job, job->id, job->state_value,
2530 newstate, action, message ? message : "(null)");
2531
2532
2533 /*
2534 * Make sure we have the job attributes...
2535 */
2536
2537 if (!cupsdLoadJob(job))
2538 return;
2539
2540 /*
2541 * Don't do anything if the state is unchanged and we aren't purging the
2542 * job...
2543 */
2544
2545 oldstate = job->state_value;
2546 if (newstate == oldstate && action != CUPSD_JOB_PURGE)
2547 return;
2548
2549 /*
2550 * Stop any processes that are working on the current job...
2551 */
2552
2553 if (oldstate == IPP_JOB_PROCESSING)
2554 stop_job(job, action);
2555
2556 /*
2557 * Set the new job state...
2558 */
2559
2560 job->state_value = newstate;
2561
2562 if (job->state)
2563 job->state->values[0].integer = newstate;
2564
2565 switch (newstate)
2566 {
2567 case IPP_JOB_PENDING :
2568 /*
2569 * Update job-hold-until as needed...
2570 */
2571
2572 if ((attr = ippFindAttribute(job->attrs, "job-hold-until",
2573 IPP_TAG_KEYWORD)) == NULL)
2574 attr = ippFindAttribute(job->attrs, "job-hold-until", IPP_TAG_NAME);
2575
2576 if (attr)
2577 {
2578 ippSetValueTag(job->attrs, &attr, IPP_TAG_KEYWORD);
2579 ippSetString(job->attrs, &attr, 0, "no-hold");
2580 }
2581
2582 default :
2583 break;
2584
2585 case IPP_JOB_ABORTED :
2586 case IPP_JOB_CANCELED :
2587 case IPP_JOB_COMPLETED :
2588 set_time(job, "time-at-completed");
2589 ippSetString(job->attrs, &job->reasons, 0, "processing-to-stop-point");
2590 break;
2591 }
2592
2593 /*
2594 * Log message as needed...
2595 */
2596
2597 if (message)
2598 {
2599 char buffer[2048]; /* Message buffer */
2600 va_list ap; /* Pointer to additional arguments */
2601
2602 va_start(ap, message);
2603 vsnprintf(buffer, sizeof(buffer), message, ap);
2604 va_end(ap);
2605
2606 if (newstate > IPP_JOB_STOPPED)
2607 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED, job->printer, job, "%s", buffer);
2608 else
2609 cupsdAddEvent(CUPSD_EVENT_JOB_STATE, job->printer, job, "%s", buffer);
2610
2611 if (newstate == IPP_JOB_STOPPED || newstate == IPP_JOB_ABORTED)
2612 cupsdLogJob(job, CUPSD_LOG_ERROR, "%s", buffer);
2613 else
2614 cupsdLogJob(job, CUPSD_LOG_INFO, "%s", buffer);
2615 }
2616
2617 /*
2618 * Handle post-state-change actions...
2619 */
2620
2621 switch (newstate)
2622 {
2623 case IPP_JOB_PROCESSING :
2624 /*
2625 * Add the job to the "printing" list...
2626 */
2627
2628 if (!cupsArrayFind(PrintingJobs, job))
2629 cupsArrayAdd(PrintingJobs, job);
2630
2631 /*
2632 * Set the processing time...
2633 */
2634
2635 set_time(job, "time-at-processing");
2636
2637 case IPP_JOB_PENDING :
2638 case IPP_JOB_HELD :
2639 case IPP_JOB_STOPPED :
2640 /*
2641 * Make sure the job is in the active list...
2642 */
2643
2644 if (!cupsArrayFind(ActiveJobs, job))
2645 cupsArrayAdd(ActiveJobs, job);
2646
2647 /*
2648 * Save the job state to disk...
2649 */
2650
2651 job->dirty = 1;
2652 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2653 break;
2654
2655 case IPP_JOB_ABORTED :
2656 case IPP_JOB_CANCELED :
2657 case IPP_JOB_COMPLETED :
2658 if (newstate == IPP_JOB_CANCELED)
2659 {
2660 /*
2661 * Remove the job from the active list if there are no processes still
2662 * running for it...
2663 */
2664
2665 for (i = 0; job->filters[i] < 0; i++);
2666
2667 if (!job->filters[i] && job->backend <= 0)
2668 cupsArrayRemove(ActiveJobs, job);
2669 }
2670 else
2671 {
2672 /*
2673 * Otherwise just remove the job from the active list immediately...
2674 */
2675
2676 cupsArrayRemove(ActiveJobs, job);
2677 }
2678
2679 /*
2680 * Expire job subscriptions since the job is now "completed"...
2681 */
2682
2683 cupsdExpireSubscriptions(NULL, job);
2684
2685 #ifdef __APPLE__
2686 /*
2687 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2688 * sleep to happen immediately...
2689 */
2690
2691 if (Sleeping && cupsArrayCount(PrintingJobs) == 0)
2692 cupsdAllowSleep();
2693 #endif /* __APPLE__ */
2694
2695 /*
2696 * Remove any authentication data...
2697 */
2698
2699 snprintf(filename, sizeof(filename), "%s/a%05d", RequestRoot, job->id);
2700 if (cupsdRemoveFile(filename) && errno != ENOENT)
2701 cupsdLogMessage(CUPSD_LOG_ERROR,
2702 "Unable to remove authentication cache: %s",
2703 strerror(errno));
2704
2705 for (i = 0;
2706 i < (int)(sizeof(job->auth_env) / sizeof(job->auth_env[0]));
2707 i ++)
2708 cupsdClearString(job->auth_env + i);
2709
2710 cupsdClearString(&job->auth_uid);
2711
2712 /*
2713 * Remove the print file for good if we aren't preserving jobs or
2714 * files...
2715 */
2716
2717 if (!JobHistory || !JobFiles || action == CUPSD_JOB_PURGE)
2718 remove_job_files(job);
2719
2720 if (JobHistory && action != CUPSD_JOB_PURGE)
2721 {
2722 /*
2723 * Save job state info...
2724 */
2725
2726 job->dirty = 1;
2727 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2728 }
2729 else if (!job->printer)
2730 {
2731 /*
2732 * Delete the job immediately if not actively printing...
2733 */
2734
2735 cupsdDeleteJob(job, CUPSD_JOB_PURGE);
2736 job = NULL;
2737 }
2738 break;
2739 }
2740
2741 /*
2742 * Finalize the job immediately if we forced things...
2743 */
2744
2745 if (action >= CUPSD_JOB_FORCE && job && job->printer)
2746 finalize_job(job, 0);
2747
2748 /*
2749 * Update the server "busy" state...
2750 */
2751
2752 cupsdSetBusyState();
2753 }
2754
2755
2756 /*
2757 * 'cupsdStopAllJobs()' - Stop all print jobs.
2758 */
2759
2760 void
2761 cupsdStopAllJobs(
2762 cupsd_jobaction_t action, /* I - Action */
2763 int kill_delay) /* I - Number of seconds before we kill */
2764 {
2765 cupsd_job_t *job; /* Current job */
2766
2767
2768 DEBUG_puts("cupsdStopAllJobs()");
2769
2770 for (job = (cupsd_job_t *)cupsArrayFirst(PrintingJobs);
2771 job;
2772 job = (cupsd_job_t *)cupsArrayNext(PrintingJobs))
2773 {
2774 if (job->completed)
2775 {
2776 cupsdSetJobState(job, IPP_JOB_COMPLETED, CUPSD_JOB_FORCE, NULL);
2777 }
2778 else
2779 {
2780 if (kill_delay)
2781 job->kill_time = time(NULL) + kill_delay;
2782
2783 cupsdSetJobState(job, IPP_JOB_PENDING, action, NULL);
2784 }
2785 }
2786 }
2787
2788
2789 /*
2790 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2791 */
2792
2793 void
2794 cupsdUnloadCompletedJobs(void)
2795 {
2796 cupsd_job_t *job; /* Current job */
2797 time_t expire; /* Expiration time */
2798
2799
2800 expire = time(NULL) - 60;
2801
2802 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
2803 job;
2804 job = (cupsd_job_t *)cupsArrayNext(Jobs))
2805 if (job->attrs && job->state_value >= IPP_JOB_STOPPED && !job->printer &&
2806 job->access_time < expire)
2807 {
2808 if (job->dirty)
2809 cupsdSaveJob(job);
2810
2811 unload_job(job);
2812 }
2813 }
2814
2815
2816 /*
2817 * 'cupsdUpdateJobs()' - Update the history/file files for all jobs.
2818 */
2819
2820 void
2821 cupsdUpdateJobs(void)
2822 {
2823 cupsd_job_t *job; /* Current job */
2824 time_t curtime; /* Current time */
2825 ipp_attribute_t *attr; /* time-at-completed attribute */
2826
2827
2828 curtime = time(NULL);
2829 JobHistoryUpdate = 0;
2830
2831 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
2832 job;
2833 job = (cupsd_job_t *)cupsArrayNext(Jobs))
2834 {
2835 if (job->state_value >= IPP_JOB_CANCELED &&
2836 (attr = ippFindAttribute(job->attrs, "time-at-completed",
2837 IPP_TAG_INTEGER)) != NULL)
2838 {
2839 /*
2840 * Update history/file expiration times...
2841 */
2842
2843 if (JobHistory < INT_MAX)
2844 job->history_time = attr->values[0].integer + JobHistory;
2845 else
2846 job->history_time = INT_MAX;
2847
2848 if (job->history_time < curtime)
2849 {
2850 cupsdDeleteJob(job, CUPSD_JOB_PURGE);
2851 continue;
2852 }
2853
2854 if (job->history_time < JobHistoryUpdate || !JobHistoryUpdate)
2855 JobHistoryUpdate = job->history_time;
2856
2857 if (JobFiles < INT_MAX)
2858 job->file_time = attr->values[0].integer + JobFiles;
2859 else
2860 job->file_time = INT_MAX;
2861
2862 if (job->file_time < JobHistoryUpdate || !JobHistoryUpdate)
2863 JobHistoryUpdate = job->file_time;
2864 }
2865 }
2866
2867 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdUpdateAllJobs: JobHistoryUpdate=%ld",
2868 (long)JobHistoryUpdate);
2869 }
2870
2871
2872 /*
2873 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2874 */
2875
2876 static int /* O - Difference */
2877 compare_active_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)->priority -
2887 ((cupsd_job_t *)first)->priority) != 0)
2888 return (diff);
2889 else
2890 return (((cupsd_job_t *)first)->id - ((cupsd_job_t *)second)->id);
2891 }
2892
2893
2894 /*
2895 * 'compare_completed_jobs()' - Compare the job IDs and completion times of two jobs.
2896 */
2897
2898 static int /* O - Difference */
2899 compare_completed_jobs(void *first, /* I - First job */
2900 void *second, /* I - Second job */
2901 void *data) /* I - App data (not used) */
2902 {
2903 int diff; /* Difference */
2904
2905
2906 (void)data;
2907
2908 if ((diff = ((cupsd_job_t *)second)->completed_time -
2909 ((cupsd_job_t *)first)->completed_time) != 0)
2910 return (diff);
2911 else
2912 return (((cupsd_job_t *)first)->id - ((cupsd_job_t *)second)->id);
2913 }
2914
2915
2916 /*
2917 * 'compare_jobs()' - Compare the job IDs of two jobs.
2918 */
2919
2920 static int /* O - Difference */
2921 compare_jobs(void *first, /* I - First job */
2922 void *second, /* I - Second job */
2923 void *data) /* I - App data (not used) */
2924 {
2925 (void)data;
2926
2927 return (((cupsd_job_t *)first)->id - ((cupsd_job_t *)second)->id);
2928 }
2929
2930
2931 /*
2932 * 'dump_job_history()' - Dump any debug messages for a job.
2933 */
2934
2935 static void
2936 dump_job_history(cupsd_job_t *job) /* I - Job */
2937 {
2938 int i, /* Looping var */
2939 oldsize; /* Current MaxLogSize */
2940 struct tm *date; /* Date/time value */
2941 cupsd_joblog_t *message; /* Current message */
2942 char temp[2048], /* Log message */
2943 *ptr, /* Pointer into log message */
2944 start[256], /* Start time */
2945 end[256]; /* End time */
2946 cupsd_printer_t *printer; /* Printer for job */
2947
2948
2949 /*
2950 * See if we have anything to dump...
2951 */
2952
2953 if (!job->history)
2954 return;
2955
2956 /*
2957 * Disable log rotation temporarily...
2958 */
2959
2960 oldsize = MaxLogSize;
2961 MaxLogSize = 0;
2962
2963 /*
2964 * Copy the debug messages to the log...
2965 */
2966
2967 message = (cupsd_joblog_t *)cupsArrayFirst(job->history);
2968 date = localtime(&(message->time));
2969 strftime(start, sizeof(start), "%X", date);
2970
2971 message = (cupsd_joblog_t *)cupsArrayLast(job->history);
2972 date = localtime(&(message->time));
2973 strftime(end, sizeof(end), "%X", date);
2974
2975 snprintf(temp, sizeof(temp),
2976 "[Job %d] The following messages were recorded from %s to %s",
2977 job->id, start, end);
2978 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2979
2980 for (message = (cupsd_joblog_t *)cupsArrayFirst(job->history);
2981 message;
2982 message = (cupsd_joblog_t *)cupsArrayNext(job->history))
2983 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, message->message);
2984
2985 snprintf(temp, sizeof(temp), "[Job %d] End of messages", job->id);
2986 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2987
2988 /*
2989 * Log the printer state values...
2990 */
2991
2992 if ((printer = job->printer) == NULL)
2993 printer = cupsdFindDest(job->dest);
2994
2995 if (printer)
2996 {
2997 snprintf(temp, sizeof(temp), "[Job %d] printer-state=%d(%s)", job->id,
2998 printer->state,
2999 printer->state == IPP_PRINTER_IDLE ? "idle" :
3000 printer->state == IPP_PRINTER_PROCESSING ? "processing" :
3001 "stopped");
3002 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
3003
3004 snprintf(temp, sizeof(temp), "[Job %d] printer-state-message=\"%s\"",
3005 job->id, printer->state_message);
3006 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
3007
3008 snprintf(temp, sizeof(temp), "[Job %d] printer-state-reasons=", job->id);
3009 ptr = temp + strlen(temp);
3010 if (printer->num_reasons == 0)
3011 strlcpy(ptr, "none", sizeof(temp) - (size_t)(ptr - temp));
3012 else
3013 {
3014 for (i = 0;
3015 i < printer->num_reasons && ptr < (temp + sizeof(temp) - 2);
3016 i ++)
3017 {
3018 if (i)
3019 *ptr++ = ',';
3020
3021 strlcpy(ptr, printer->reasons[i], sizeof(temp) - (size_t)(ptr - temp));
3022 ptr += strlen(ptr);
3023 }
3024 }
3025 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
3026 }
3027
3028 /*
3029 * Restore log file rotation...
3030 */
3031
3032 MaxLogSize = oldsize;
3033
3034 /*
3035 * Free all messages...
3036 */
3037
3038 free_job_history(job);
3039 }
3040
3041
3042 /*
3043 * 'free_job_history()' - Free any log history.
3044 */
3045
3046 static void
3047 free_job_history(cupsd_job_t *job) /* I - Job */
3048 {
3049 char *message; /* Current message */
3050
3051
3052 if (!job->history)
3053 return;
3054
3055 for (message = (char *)cupsArrayFirst(job->history);
3056 message;
3057 message = (char *)cupsArrayNext(job->history))
3058 free(message);
3059
3060 cupsArrayDelete(job->history);
3061 job->history = NULL;
3062 }
3063
3064
3065 /*
3066 * 'finalize_job()' - Cleanup after job filter processes and support data.
3067 */
3068
3069 static void
3070 finalize_job(cupsd_job_t *job, /* I - Job */
3071 int set_job_state) /* I - 1 = set the job state */
3072 {
3073 ipp_pstate_t printer_state; /* New printer state value */
3074 ipp_jstate_t job_state; /* New job state value */
3075 const char *message; /* Message for job state */
3076 char buffer[1024]; /* Buffer for formatted messages */
3077
3078
3079 cupsdLogMessage(CUPSD_LOG_DEBUG2, "finalize_job(job=%p(%d))", job, job->id);
3080
3081 /*
3082 * Clear the "connecting-to-device" and "cups-waiting-for-job-completed"
3083 * reasons, which are only valid when a printer is processing, along with any
3084 * remote printing job state...
3085 */
3086
3087 cupsdSetPrinterReasons(job->printer, "-connecting-to-device,"
3088 "cups-waiting-for-job-completed,"
3089 "cups-remote-pending,"
3090 "cups-remote-pending-held,"
3091 "cups-remote-processing,"
3092 "cups-remote-stopped,"
3093 "cups-remote-canceled,"
3094 "cups-remote-aborted,"
3095 "cups-remote-completed");
3096
3097 /*
3098 * Similarly, clear the "offline-report" reason for non-USB devices since we
3099 * rarely have current information for network devices...
3100 */
3101
3102 if (strncmp(job->printer->device_uri, "usb:", 4) &&
3103 strncmp(job->printer->device_uri, "ippusb:", 7))
3104 cupsdSetPrinterReasons(job->printer, "-offline-report");
3105
3106 /*
3107 * Free the security profile...
3108 */
3109
3110 cupsdDestroyProfile(job->profile);
3111 job->profile = NULL;
3112 cupsdDestroyProfile(job->bprofile);
3113 job->bprofile = NULL;
3114
3115 /*
3116 * Clear the unresponsive job watchdog timers...
3117 */
3118
3119 job->cancel_time = 0;
3120 job->kill_time = 0;
3121
3122 /*
3123 * Close pipes and status buffer...
3124 */
3125
3126 cupsdClosePipe(job->print_pipes);
3127 cupsdClosePipe(job->back_pipes);
3128 cupsdClosePipe(job->side_pipes);
3129
3130 cupsdRemoveSelect(job->status_pipes[0]);
3131 cupsdClosePipe(job->status_pipes);
3132 cupsdStatBufDelete(job->status_buffer);
3133 job->status_buffer = NULL;
3134
3135 /*
3136 * Process the exit status...
3137 */
3138
3139 if (job->printer->state == IPP_PRINTER_PROCESSING)
3140 printer_state = IPP_PRINTER_IDLE;
3141 else
3142 printer_state = job->printer->state;
3143
3144 switch (job_state = job->state_value)
3145 {
3146 case IPP_JOB_PENDING :
3147 message = "Job paused.";
3148 break;
3149
3150 case IPP_JOB_HELD :
3151 message = "Job held.";
3152 break;
3153
3154 default :
3155 case IPP_JOB_PROCESSING :
3156 case IPP_JOB_COMPLETED :
3157 job_state = IPP_JOB_COMPLETED;
3158 message = "Job completed.";
3159
3160 if (!job->status)
3161 ippSetString(job->attrs, &job->reasons, 0,
3162 "job-completed-successfully");
3163 break;
3164
3165 case IPP_JOB_STOPPED :
3166 message = "Job stopped.";
3167
3168 ippSetString(job->attrs, &job->reasons, 0, "job-stopped");
3169 break;
3170
3171 case IPP_JOB_CANCELED :
3172 message = "Job canceled.";
3173
3174 ippSetString(job->attrs, &job->reasons, 0, "job-canceled-by-user");
3175 break;
3176
3177 case IPP_JOB_ABORTED :
3178 message = "Job aborted.";
3179 break;
3180 }
3181
3182 if (job->status < 0)
3183 {
3184 /*
3185 * Backend had errors...
3186 */
3187
3188 int exit_code; /* Exit code from backend */
3189
3190 /*
3191 * Convert the status to an exit code. Due to the way the W* macros are
3192 * implemented on MacOS X (bug?), we have to store the exit status in a
3193 * variable first and then convert...
3194 */
3195
3196 exit_code = -job->status;
3197 if (WIFEXITED(exit_code))
3198 exit_code = WEXITSTATUS(exit_code);
3199 else
3200 {
3201 ippSetString(job->attrs, &job->reasons, 0, "cups-backend-crashed");
3202 exit_code = job->status;
3203 }
3204
3205 cupsdLogJob(job, CUPSD_LOG_INFO, "Backend returned status %d (%s)",
3206 exit_code,
3207 exit_code == CUPS_BACKEND_FAILED ? "failed" :
3208 exit_code == CUPS_BACKEND_AUTH_REQUIRED ?
3209 "authentication required" :
3210 exit_code == CUPS_BACKEND_HOLD ? "hold job" :
3211 exit_code == CUPS_BACKEND_STOP ? "stop printer" :
3212 exit_code == CUPS_BACKEND_CANCEL ? "cancel job" :
3213 exit_code == CUPS_BACKEND_RETRY ? "retry job later" :
3214 exit_code == CUPS_BACKEND_RETRY_CURRENT ? "retry job immediately" :
3215 exit_code < 0 ? "crashed" : "unknown");
3216
3217 /*
3218 * Do what needs to be done...
3219 */
3220
3221 switch (exit_code)
3222 {
3223 default :
3224 case CUPS_BACKEND_FAILED :
3225 /*
3226 * Backend failure, use the error-policy to determine how to
3227 * act...
3228 */
3229
3230 if (job->dtype & CUPS_PRINTER_CLASS)
3231 {
3232 /*
3233 * Queued on a class - mark the job as pending and we'll retry on
3234 * another printer...
3235 */
3236
3237 if (job_state == IPP_JOB_COMPLETED)
3238 {
3239 job_state = IPP_JOB_PENDING;
3240 message = "Retrying job on another printer.";
3241
3242 ippSetString(job->attrs, &job->reasons, 0,
3243 "resources-are-not-ready");
3244 }
3245 }
3246 else if (!strcmp(job->printer->error_policy, "retry-current-job"))
3247 {
3248 /*
3249 * The error policy is "retry-current-job" - mark the job as pending
3250 * and we'll retry on the same printer...
3251 */
3252
3253 if (job_state == IPP_JOB_COMPLETED)
3254 {
3255 job_state = IPP_JOB_PENDING;
3256 message = "Retrying job on same printer.";
3257
3258 ippSetString(job->attrs, &job->reasons, 0, "none");
3259 }
3260 }
3261 else if ((job->printer->type & CUPS_PRINTER_FAX) ||
3262 !strcmp(job->printer->error_policy, "retry-job"))
3263 {
3264 if (job_state == IPP_JOB_COMPLETED)
3265 {
3266 /*
3267 * The job was queued on a fax or the error policy is "retry-job" -
3268 * hold the job if the number of retries is less than the
3269 * JobRetryLimit, otherwise abort the job.
3270 */
3271
3272 job->tries ++;
3273
3274 if (job->tries > JobRetryLimit && JobRetryLimit > 0)
3275 {
3276 /*
3277 * Too many tries...
3278 */
3279
3280 snprintf(buffer, sizeof(buffer),
3281 "Job aborted after %d unsuccessful attempts.",
3282 JobRetryLimit);
3283 job_state = IPP_JOB_ABORTED;
3284 message = buffer;
3285
3286 ippSetString(job->attrs, &job->reasons, 0, "aborted-by-system");
3287 }
3288 else
3289 {
3290 /*
3291 * Try again in N seconds...
3292 */
3293
3294 snprintf(buffer, sizeof(buffer),
3295 "Job held for %d seconds since it could not be sent.",
3296 JobRetryInterval);
3297
3298 job->hold_until = time(NULL) + JobRetryInterval;
3299 job_state = IPP_JOB_HELD;
3300 message = buffer;
3301
3302 ippSetString(job->attrs, &job->reasons, 0,
3303 "resources-are-not-ready");
3304 }
3305 }
3306 }
3307 else if (!strcmp(job->printer->error_policy, "abort-job") &&
3308 job_state == IPP_JOB_COMPLETED)
3309 {
3310 job_state = IPP_JOB_ABORTED;
3311 message = "Job aborted due to backend errors; please consult "
3312 "the error_log file for details.";
3313
3314 ippSetString(job->attrs, &job->reasons, 0, "aborted-by-system");
3315 }
3316 else if (job->state_value == IPP_JOB_PROCESSING)
3317 {
3318 job_state = IPP_JOB_PENDING;
3319 printer_state = IPP_PRINTER_STOPPED;
3320 message = "Printer stopped due to backend errors; please "
3321 "consult the error_log file for details.";
3322
3323 ippSetString(job->attrs, &job->reasons, 0, "none");
3324 }
3325 break;
3326
3327 case CUPS_BACKEND_CANCEL :
3328 /*
3329 * Cancel the job...
3330 */
3331
3332 if (job_state == IPP_JOB_COMPLETED)
3333 {
3334 job_state = IPP_JOB_CANCELED;
3335 message = "Job canceled at printer.";
3336
3337 ippSetString(job->attrs, &job->reasons, 0, "canceled-at-device");
3338 }
3339 break;
3340
3341 case CUPS_BACKEND_HOLD :
3342 if (job_state == IPP_JOB_COMPLETED)
3343 {
3344 /*
3345 * Hold the job...
3346 */
3347
3348 const char *reason = ippGetString(job->reasons, 0, NULL);
3349
3350 cupsdLogJob(job, CUPSD_LOG_DEBUG, "job-state-reasons=\"%s\"",
3351 reason);
3352
3353 if (!reason || strncmp(reason, "account-", 8))
3354 {
3355 cupsdSetJobHoldUntil(job, "indefinite", 1);
3356
3357 ippSetString(job->attrs, &job->reasons, 0,
3358 "job-hold-until-specified");
3359 message = "Job held indefinitely due to backend errors; please "
3360 "consult the error_log file for details.";
3361 }
3362 else if (!strcmp(reason, "account-info-needed"))
3363 {
3364 cupsdSetJobHoldUntil(job, "indefinite", 0);
3365
3366 message = "Job held indefinitely - account information is "
3367 "required.";
3368 }
3369 else if (!strcmp(reason, "account-closed"))
3370 {
3371 cupsdSetJobHoldUntil(job, "indefinite", 0);
3372
3373 message = "Job held indefinitely - account has been closed.";
3374 }
3375 else if (!strcmp(reason, "account-limit-reached"))
3376 {
3377 cupsdSetJobHoldUntil(job, "indefinite", 0);
3378
3379 message = "Job held indefinitely - account limit has been "
3380 "reached.";
3381 }
3382 else
3383 {
3384 cupsdSetJobHoldUntil(job, "indefinite", 0);
3385
3386 message = "Job held indefinitely - account authorization failed.";
3387 }
3388
3389 job_state = IPP_JOB_HELD;
3390 }
3391 break;
3392
3393 case CUPS_BACKEND_STOP :
3394 /*
3395 * Stop the printer...
3396 */
3397
3398 printer_state = IPP_PRINTER_STOPPED;
3399 message = "Printer stopped due to backend errors; please "
3400 "consult the error_log file for details.";
3401
3402 if (job_state == IPP_JOB_COMPLETED)
3403 {
3404 job_state = IPP_JOB_PENDING;
3405
3406 ippSetString(job->attrs, &job->reasons, 0,
3407 "resources-are-not-ready");
3408 }
3409 break;
3410
3411 case CUPS_BACKEND_AUTH_REQUIRED :
3412 /*
3413 * Hold the job for authentication...
3414 */
3415
3416 if (job_state == IPP_JOB_COMPLETED)
3417 {
3418 cupsdSetJobHoldUntil(job, "auth-info-required", 1);
3419
3420 job_state = IPP_JOB_HELD;
3421 message = "Job held for authentication.";
3422
3423 if (strncmp(job->reasons->values[0].string.text, "account-", 8))
3424 ippSetString(job->attrs, &job->reasons, 0,
3425 "cups-held-for-authentication");
3426 }
3427 break;
3428
3429 case CUPS_BACKEND_RETRY :
3430 if (job_state == IPP_JOB_COMPLETED)
3431 {
3432 /*
3433 * Hold the job if the number of retries is less than the
3434 * JobRetryLimit, otherwise abort the job.
3435 */
3436
3437 job->tries ++;
3438
3439 if (job->tries > JobRetryLimit && JobRetryLimit > 0)
3440 {
3441 /*
3442 * Too many tries...
3443 */
3444
3445 snprintf(buffer, sizeof(buffer),
3446 "Job aborted after %d unsuccessful attempts.",
3447 JobRetryLimit);
3448 job_state = IPP_JOB_ABORTED;
3449 message = buffer;
3450
3451 ippSetString(job->attrs, &job->reasons, 0, "aborted-by-system");
3452 }
3453 else
3454 {
3455 /*
3456 * Try again in N seconds...
3457 */
3458
3459 snprintf(buffer, sizeof(buffer),
3460 "Job held for %d seconds since it could not be sent.",
3461 JobRetryInterval);
3462
3463 job->hold_until = time(NULL) + JobRetryInterval;
3464 job_state = IPP_JOB_HELD;
3465 message = buffer;
3466
3467 ippSetString(job->attrs, &job->reasons, 0,
3468 "resources-are-not-ready");
3469 }
3470 }
3471 break;
3472
3473 case CUPS_BACKEND_RETRY_CURRENT :
3474 /*
3475 * Mark the job as pending and retry on the same printer...
3476 */
3477
3478 if (job_state == IPP_JOB_COMPLETED)
3479 {
3480 job_state = IPP_JOB_PENDING;
3481 message = "Retrying job on same printer.";
3482
3483 ippSetString(job->attrs, &job->reasons, 0, "none");
3484 }
3485 break;
3486 }
3487 }
3488 else if (job->status > 0)
3489 {
3490 /*
3491 * Filter had errors; stop job...
3492 */
3493
3494 if (job_state == IPP_JOB_COMPLETED)
3495 {
3496 job_state = IPP_JOB_STOPPED;
3497 message = "Job stopped due to filter errors; please consult the "
3498 "error_log file for details.";
3499
3500 if (WIFSIGNALED(job->status))
3501 ippSetString(job->attrs, &job->reasons, 0, "cups-filter-crashed");
3502 else
3503 ippSetString(job->attrs, &job->reasons, 0, "job-completed-with-errors");
3504 }
3505 }
3506
3507 /*
3508 * Update the printer and job state.
3509 */
3510
3511 if (set_job_state && job_state != job->state_value)
3512 cupsdSetJobState(job, job_state, CUPSD_JOB_DEFAULT, "%s", message);
3513
3514 cupsdSetPrinterState(job->printer, printer_state,
3515 printer_state == IPP_PRINTER_STOPPED);
3516 update_job_attrs(job, 0);
3517
3518 if (job->history)
3519 {
3520 if (job->status &&
3521 (job->state_value == IPP_JOB_ABORTED ||
3522 job->state_value == IPP_JOB_STOPPED))
3523 dump_job_history(job);
3524 else
3525 free_job_history(job);
3526 }
3527
3528 cupsArrayRemove(PrintingJobs, job);
3529
3530 /*
3531 * Apply any PPD updates...
3532 */
3533
3534 if (job->num_keywords)
3535 {
3536 if (cupsdUpdatePrinterPPD(job->printer, job->num_keywords, job->keywords))
3537 cupsdSetPrinterAttrs(job->printer);
3538
3539 cupsFreeOptions(job->num_keywords, job->keywords);
3540
3541 job->num_keywords = 0;
3542 job->keywords = NULL;
3543 }
3544
3545 /*
3546 * Clear the printer <-> job association...
3547 */
3548
3549 job->printer->job = NULL;
3550 job->printer = NULL;
3551 }
3552
3553
3554 /*
3555 * 'get_options()' - Get a string containing the job options.
3556 */
3557
3558 static char * /* O - Options string */
3559 get_options(cupsd_job_t *job, /* I - Job */
3560 int banner_page, /* I - Printing a banner page? */
3561 char *copies, /* I - Copies buffer */
3562 size_t copies_size, /* I - Size of copies buffer */
3563 char *title, /* I - Title buffer */
3564 size_t title_size) /* I - Size of title buffer */
3565 {
3566 int i; /* Looping var */
3567 size_t newlength; /* New option buffer length */
3568 char *optptr, /* Pointer to options */
3569 *valptr; /* Pointer in value string */
3570 ipp_attribute_t *attr; /* Current attribute */
3571 _ppd_cache_t *pc; /* PPD cache and mapping data */
3572 int num_pwgppds; /* Number of PWG->PPD options */
3573 cups_option_t *pwgppds, /* PWG->PPD options */
3574 *pwgppd, /* Current PWG->PPD option */
3575 *preset; /* Current preset option */
3576 int print_color_mode,
3577 /* Output mode (if any) */
3578 print_quality; /* Print quality (if any) */
3579 const char *ppd; /* PPD option choice */
3580 int exact; /* Did we get an exact match? */
3581 static char *options = NULL;/* Full list of options */
3582 static size_t optlength = 0; /* Length of option buffer */
3583
3584
3585 /*
3586 * Building the options string is harder than it needs to be, but for the
3587 * moment we need to pass strings for command-line args and not IPP attribute
3588 * pointers... :)
3589 *
3590 * First build an options array for any PWG->PPD mapped option/choice pairs.
3591 */
3592
3593 pc = job->printer->pc;
3594 num_pwgppds = 0;
3595 pwgppds = NULL;
3596
3597 if (pc &&
3598 !ippFindAttribute(job->attrs,
3599 "com.apple.print.DocumentTicket.PMSpoolFormat",
3600 IPP_TAG_ZERO) &&
3601 !ippFindAttribute(job->attrs, "APPrinterPreset", IPP_TAG_ZERO) &&
3602 (ippFindAttribute(job->attrs, "print-color-mode", IPP_TAG_ZERO) ||
3603 ippFindAttribute(job->attrs, "print-quality", IPP_TAG_ZERO)))
3604 {
3605 /*
3606 * Map print-color-mode and print-quality to a preset...
3607 */
3608
3609 if ((attr = ippFindAttribute(job->attrs, "print-color-mode",
3610 IPP_TAG_KEYWORD)) != NULL &&
3611 !strcmp(attr->values[0].string.text, "monochrome"))
3612 print_color_mode = _PWG_PRINT_COLOR_MODE_MONOCHROME;
3613 else
3614 print_color_mode = _PWG_PRINT_COLOR_MODE_COLOR;
3615
3616 if ((attr = ippFindAttribute(job->attrs, "print-quality",
3617 IPP_TAG_ENUM)) != NULL &&
3618 attr->values[0].integer >= IPP_QUALITY_DRAFT &&
3619 attr->values[0].integer <= IPP_QUALITY_HIGH)
3620 print_quality = attr->values[0].integer - IPP_QUALITY_DRAFT;
3621 else
3622 print_quality = _PWG_PRINT_QUALITY_NORMAL;
3623
3624 if (pc->num_presets[print_color_mode][print_quality] == 0)
3625 {
3626 /*
3627 * Try to find a preset that works so that we maximize the chances of us
3628 * getting a good print using IPP attributes.
3629 */
3630
3631 if (pc->num_presets[print_color_mode][_PWG_PRINT_QUALITY_NORMAL] > 0)
3632 print_quality = _PWG_PRINT_QUALITY_NORMAL;
3633 else if (pc->num_presets[_PWG_PRINT_COLOR_MODE_COLOR][print_quality] > 0)
3634 print_color_mode = _PWG_PRINT_COLOR_MODE_COLOR;
3635 else
3636 {
3637 print_quality = _PWG_PRINT_QUALITY_NORMAL;
3638 print_color_mode = _PWG_PRINT_COLOR_MODE_COLOR;
3639 }
3640 }
3641
3642 if (pc->num_presets[print_color_mode][print_quality] > 0)
3643 {
3644 /*
3645 * Copy the preset options as long as the corresponding names are not
3646 * already defined in the IPP request...
3647 */
3648
3649 for (i = pc->num_presets[print_color_mode][print_quality],
3650 preset = pc->presets[print_color_mode][print_quality];
3651 i > 0;
3652 i --, preset ++)
3653 {
3654 if (!ippFindAttribute(job->attrs, preset->name, IPP_TAG_ZERO))
3655 num_pwgppds = cupsAddOption(preset->name, preset->value, num_pwgppds,
3656 &pwgppds);
3657 }
3658 }
3659 }
3660
3661 if (pc)
3662 {
3663 if (!ippFindAttribute(job->attrs, "InputSlot", IPP_TAG_ZERO) &&
3664 !ippFindAttribute(job->attrs, "HPPaperSource", IPP_TAG_ZERO))
3665 {
3666 if ((ppd = _ppdCacheGetInputSlot(pc, job->attrs, NULL)) != NULL)
3667 num_pwgppds = cupsAddOption(pc->source_option, ppd, num_pwgppds,
3668 &pwgppds);
3669 }
3670 if (!ippFindAttribute(job->attrs, "MediaType", IPP_TAG_ZERO) &&
3671 (ppd = _ppdCacheGetMediaType(pc, job->attrs, NULL)) != NULL)
3672 num_pwgppds = cupsAddOption("MediaType", ppd, num_pwgppds, &pwgppds);
3673
3674 if (!ippFindAttribute(job->attrs, "PageRegion", IPP_TAG_ZERO) &&
3675 !ippFindAttribute(job->attrs, "PageSize", IPP_TAG_ZERO) &&
3676 (ppd = _ppdCacheGetPageSize(pc, job->attrs, NULL, &exact)) != NULL)
3677 {
3678 num_pwgppds = cupsAddOption("PageSize", ppd, num_pwgppds, &pwgppds);
3679
3680 if (!ippFindAttribute(job->attrs, "media", IPP_TAG_ZERO))
3681 num_pwgppds = cupsAddOption("media", ppd, num_pwgppds, &pwgppds);
3682 }
3683
3684 if (!ippFindAttribute(job->attrs, "OutputBin", IPP_TAG_ZERO) &&
3685 (attr = ippFindAttribute(job->attrs, "output-bin",
3686 IPP_TAG_ZERO)) != NULL &&
3687 (attr->value_tag == IPP_TAG_KEYWORD ||
3688 attr->value_tag == IPP_TAG_NAME) &&
3689 (ppd = _ppdCacheGetOutputBin(pc, attr->values[0].string.text)) != NULL)
3690 {
3691 /*
3692 * Map output-bin to OutputBin option...
3693 */
3694
3695 num_pwgppds = cupsAddOption("OutputBin", ppd, num_pwgppds, &pwgppds);
3696 }
3697
3698 if (pc->sides_option &&
3699 !ippFindAttribute(job->attrs, pc->sides_option, IPP_TAG_ZERO) &&
3700 (attr = ippFindAttribute(job->attrs, "sides", IPP_TAG_KEYWORD)) != NULL)
3701 {
3702 /*
3703 * Map sides to duplex option...
3704 */
3705
3706 if (!strcmp(attr->values[0].string.text, "one-sided"))
3707 num_pwgppds = cupsAddOption(pc->sides_option, pc->sides_1sided,
3708 num_pwgppds, &pwgppds);
3709 else if (!strcmp(attr->values[0].string.text, "two-sided-long-edge"))
3710 num_pwgppds = cupsAddOption(pc->sides_option, pc->sides_2sided_long,
3711 num_pwgppds, &pwgppds);
3712 else if (!strcmp(attr->values[0].string.text, "two-sided-short-edge"))
3713 num_pwgppds = cupsAddOption(pc->sides_option, pc->sides_2sided_short,
3714 num_pwgppds, &pwgppds);
3715 }
3716
3717 /*
3718 * Map finishings values...
3719 */
3720
3721 num_pwgppds = _ppdCacheGetFinishingOptions(pc, job->attrs,
3722 IPP_FINISHINGS_NONE, num_pwgppds,
3723 &pwgppds);
3724 }
3725
3726 /*
3727 * Figure out how much room we need...
3728 */
3729
3730 newlength = ipp_length(job->attrs);
3731
3732 for (i = num_pwgppds, pwgppd = pwgppds; i > 0; i --, pwgppd ++)
3733 newlength += 1 + strlen(pwgppd->name) + 1 + strlen(pwgppd->value);
3734
3735 /*
3736 * Then allocate/reallocate the option buffer as needed...
3737 */
3738
3739 if (newlength == 0) /* This can never happen, but Clang */
3740 newlength = 1; /* thinks it can... */
3741
3742 if (newlength > optlength || !options)
3743 {
3744 if (!options)
3745 optptr = malloc(newlength);
3746 else
3747 optptr = realloc(options, newlength);
3748
3749 if (!optptr)
3750 {
3751 cupsdLogJob(job, CUPSD_LOG_CRIT,
3752 "Unable to allocate " CUPS_LLFMT " bytes for option buffer.",
3753 CUPS_LLCAST newlength);
3754 return (NULL);
3755 }
3756
3757 options = optptr;
3758 optlength = newlength;
3759 }
3760
3761 /*
3762 * Now loop through the attributes and convert them to the textual
3763 * representation used by the filters...
3764 */
3765
3766 optptr = options;
3767 *optptr = '\0';
3768
3769 snprintf(title, title_size, "%s-%d", job->printer->name, job->id);
3770 strlcpy(copies, "1", copies_size);
3771
3772 for (attr = job->attrs->attrs; attr != NULL; attr = attr->next)
3773 {
3774 if (!strcmp(attr->name, "copies") &&
3775 attr->value_tag == IPP_TAG_INTEGER)
3776 {
3777 /*
3778 * Don't use the # copies attribute if we are printing the job sheets...
3779 */
3780
3781 if (!banner_page)
3782 snprintf(copies, copies_size, "%d", attr->values[0].integer);
3783 }
3784 else if (!strcmp(attr->name, "job-name") &&
3785 (attr->value_tag == IPP_TAG_NAME ||
3786 attr->value_tag == IPP_TAG_NAMELANG))
3787 strlcpy(title, attr->values[0].string.text, title_size);
3788 else if (attr->group_tag == IPP_TAG_JOB)
3789 {
3790 /*
3791 * Filter out other unwanted attributes...
3792 */
3793
3794 if (attr->value_tag == IPP_TAG_NOVALUE ||
3795 attr->value_tag == IPP_TAG_MIMETYPE ||
3796 attr->value_tag == IPP_TAG_NAMELANG ||
3797 attr->value_tag == IPP_TAG_TEXTLANG ||
3798 (attr->value_tag == IPP_TAG_URI && strcmp(attr->name, "job-uuid") &&
3799 strcmp(attr->name, "job-authorization-uri")) ||
3800 attr->value_tag == IPP_TAG_URISCHEME ||
3801 attr->value_tag == IPP_TAG_BEGIN_COLLECTION) /* Not yet supported */
3802 continue;
3803
3804 if (!strcmp(attr->name, "job-hold-until") ||
3805 !strcmp(attr->name, "job-id") ||
3806 !strcmp(attr->name, "job-k-octets") ||
3807 !strcmp(attr->name, "job-media-sheets") ||
3808 !strcmp(attr->name, "job-media-sheets-completed") ||
3809 !strcmp(attr->name, "job-state") ||
3810 !strcmp(attr->name, "job-state-reasons"))
3811 continue;
3812
3813 if (!strncmp(attr->name, "job-", 4) &&
3814 strcmp(attr->name, "job-account-id") &&
3815 strcmp(attr->name, "job-accounting-user-id") &&
3816 strcmp(attr->name, "job-authorization-uri") &&
3817 strcmp(attr->name, "job-billing") &&
3818 strcmp(attr->name, "job-impressions") &&
3819 strcmp(attr->name, "job-originating-host-name") &&
3820 strcmp(attr->name, "job-password") &&
3821 strcmp(attr->name, "job-password-encryption") &&
3822 strcmp(attr->name, "job-uuid") &&
3823 !(job->printer->type & CUPS_PRINTER_REMOTE))
3824 continue;
3825
3826 if ((!strcmp(attr->name, "job-impressions") ||
3827 !strcmp(attr->name, "page-label") ||
3828 !strcmp(attr->name, "page-border") ||
3829 !strncmp(attr->name, "number-up", 9) ||
3830 !strcmp(attr->name, "page-ranges") ||
3831 !strcmp(attr->name, "page-set") ||
3832 !_cups_strcasecmp(attr->name, "AP_FIRSTPAGE_InputSlot") ||
3833 !_cups_strcasecmp(attr->name, "AP_FIRSTPAGE_ManualFeed") ||
3834 !_cups_strcasecmp(attr->name, "com.apple.print.PrintSettings."
3835 "PMTotalSidesImaged..n.") ||
3836 !_cups_strcasecmp(attr->name, "com.apple.print.PrintSettings."
3837 "PMTotalBeginPages..n.")) &&
3838 banner_page)
3839 continue;
3840
3841 /*
3842 * Otherwise add them to the list...
3843 */
3844
3845 if (optptr > options)
3846 strlcat(optptr, " ", optlength - (size_t)(optptr - options));
3847
3848 if (attr->value_tag != IPP_TAG_BOOLEAN)
3849 {
3850 strlcat(optptr, attr->name, optlength - (size_t)(optptr - options));
3851 strlcat(optptr, "=", optlength - (size_t)(optptr - options));
3852 }
3853
3854 for (i = 0; i < attr->num_values; i ++)
3855 {
3856 if (i)
3857 strlcat(optptr, ",", optlength - (size_t)(optptr - options));
3858
3859 optptr += strlen(optptr);
3860
3861 switch (attr->value_tag)
3862 {
3863 case IPP_TAG_INTEGER :
3864 case IPP_TAG_ENUM :
3865 snprintf(optptr, optlength - (size_t)(optptr - options),
3866 "%d", attr->values[i].integer);
3867 break;
3868
3869 case IPP_TAG_BOOLEAN :
3870 if (!attr->values[i].boolean)
3871 strlcat(optptr, "no", optlength - (size_t)(optptr - options));
3872
3873 strlcat(optptr, attr->name, optlength - (size_t)(optptr - options));
3874 break;
3875
3876 case IPP_TAG_RANGE :
3877 if (attr->values[i].range.lower == attr->values[i].range.upper)
3878 snprintf(optptr, optlength - (size_t)(optptr - options) - 1,
3879 "%d", attr->values[i].range.lower);
3880 else
3881 snprintf(optptr, optlength - (size_t)(optptr - options) - 1,
3882 "%d-%d", attr->values[i].range.lower,
3883 attr->values[i].range.upper);
3884 break;
3885
3886 case IPP_TAG_RESOLUTION :
3887 snprintf(optptr, optlength - (size_t)(optptr - options) - 1,
3888 "%dx%d%s", attr->values[i].resolution.xres,
3889 attr->values[i].resolution.yres,
3890 attr->values[i].resolution.units == IPP_RES_PER_INCH ?
3891 "dpi" : "dpcm");
3892 break;
3893
3894 case IPP_TAG_STRING :
3895 case IPP_TAG_TEXT :
3896 case IPP_TAG_NAME :
3897 case IPP_TAG_KEYWORD :
3898 case IPP_TAG_CHARSET :
3899 case IPP_TAG_LANGUAGE :
3900 case IPP_TAG_URI :
3901 for (valptr = attr->values[i].string.text; *valptr;)
3902 {
3903 if (strchr(" \t\n\\\'\"", *valptr))
3904 *optptr++ = '\\';
3905 *optptr++ = *valptr++;
3906 }
3907
3908 *optptr = '\0';
3909 break;
3910
3911 default :
3912 break; /* anti-compiler-warning-code */
3913 }
3914 }
3915
3916 optptr += strlen(optptr);
3917 }
3918 }
3919
3920 /*
3921 * Finally loop through the PWG->PPD mapped options and add them...
3922 */
3923
3924 for (i = num_pwgppds, pwgppd = pwgppds; i > 0; i --, pwgppd ++)
3925 {
3926 *optptr++ = ' ';
3927 strlcpy(optptr, pwgppd->name, optlength - (size_t)(optptr - options));
3928 optptr += strlen(optptr);
3929 *optptr++ = '=';
3930 strlcpy(optptr, pwgppd->value, optlength - (size_t)(optptr - options));
3931 optptr += strlen(optptr);
3932 }
3933
3934 cupsFreeOptions(num_pwgppds, pwgppds);
3935
3936 /*
3937 * Return the options string...
3938 */
3939
3940 return (options);
3941 }
3942
3943
3944 /*
3945 * 'ipp_length()' - Compute the size of the buffer needed to hold
3946 * the textual IPP attributes.
3947 */
3948
3949 static size_t /* O - Size of attribute buffer */
3950 ipp_length(ipp_t *ipp) /* I - IPP request */
3951 {
3952 size_t bytes; /* Number of bytes */
3953 int i; /* Looping var */
3954 ipp_attribute_t *attr; /* Current attribute */
3955
3956
3957 /*
3958 * Loop through all attributes...
3959 */
3960
3961 bytes = 0;
3962
3963 for (attr = ipp->attrs; attr != NULL; attr = attr->next)
3964 {
3965 /*
3966 * Skip attributes that won't be sent to filters...
3967 */
3968
3969 if (attr->value_tag == IPP_TAG_NOVALUE ||
3970 attr->value_tag == IPP_TAG_MIMETYPE ||
3971 attr->value_tag == IPP_TAG_NAMELANG ||
3972 attr->value_tag == IPP_TAG_TEXTLANG ||
3973 attr->value_tag == IPP_TAG_URI ||
3974 attr->value_tag == IPP_TAG_URISCHEME)
3975 continue;
3976
3977 /*
3978 * Add space for a leading space and commas between each value.
3979 * For the first attribute, the leading space isn't used, so the
3980 * extra byte can be used as the nul terminator...
3981 */
3982
3983 bytes ++; /* " " separator */
3984 bytes += (size_t)attr->num_values; /* "," separators */
3985
3986 /*
3987 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3988 * other attributes appear as "foo=value1,value2,...,valueN".
3989 */
3990
3991 if (attr->value_tag != IPP_TAG_BOOLEAN)
3992 bytes += strlen(attr->name);
3993 else
3994 bytes += (size_t)attr->num_values * strlen(attr->name);
3995
3996 /*
3997 * Now add the size required for each value in the attribute...
3998 */
3999
4000 switch (attr->value_tag)
4001 {
4002 case IPP_TAG_INTEGER :
4003 case IPP_TAG_ENUM :
4004 /*
4005 * Minimum value of a signed integer is -2147483647, or 11 digits.
4006 */
4007
4008 bytes += (size_t)attr->num_values * 11;
4009 break;
4010
4011 case IPP_TAG_BOOLEAN :
4012 /*
4013 * Add two bytes for each false ("no") value...
4014 */
4015
4016 for (i = 0; i < attr->num_values; i ++)
4017 if (!attr->values[i].boolean)
4018 bytes += 2;
4019 break;
4020
4021 case IPP_TAG_RANGE :
4022 /*
4023 * A range is two signed integers separated by a hyphen, or
4024 * 23 characters max.
4025 */
4026
4027 bytes += (size_t)attr->num_values * 23;
4028 break;
4029
4030 case IPP_TAG_RESOLUTION :
4031 /*
4032 * A resolution is two signed integers separated by an "x" and
4033 * suffixed by the units, or 26 characters max.
4034 */
4035
4036 bytes += (size_t)attr->num_values * 26;
4037 break;
4038
4039 case IPP_TAG_STRING :
4040 case IPP_TAG_TEXT :
4041 case IPP_TAG_NAME :
4042 case IPP_TAG_KEYWORD :
4043 case IPP_TAG_CHARSET :
4044 case IPP_TAG_LANGUAGE :
4045 case IPP_TAG_URI :
4046 /*
4047 * Strings can contain characters that need quoting. We need
4048 * at least 2 * len + 2 characters to cover the quotes and
4049 * any backslashes in the string.
4050 */
4051
4052 for (i = 0; i < attr->num_values; i ++)
4053 bytes += 2 * strlen(attr->values[i].string.text) + 2;
4054 break;
4055
4056 default :
4057 break; /* anti-compiler-warning-code */
4058 }
4059 }
4060
4061 return (bytes);
4062 }
4063
4064
4065 /*
4066 * 'load_job_cache()' - Load jobs from the job.cache file.
4067 */
4068
4069 static void
4070 load_job_cache(const char *filename) /* I - job.cache filename */
4071 {
4072 cups_file_t *fp; /* job.cache file */
4073 char line[1024], /* Line buffer */
4074 *value; /* Value on line */
4075 int linenum; /* Line number in file */
4076 cupsd_job_t *job; /* Current job */
4077 int jobid; /* Job ID */
4078 char jobfile[1024]; /* Job filename */
4079
4080
4081 /*
4082 * Open the job.cache file...
4083 */
4084
4085 if ((fp = cupsdOpenConfFile(filename)) == NULL)
4086 {
4087 load_request_root();
4088 return;
4089 }
4090
4091 /*
4092 * Read entries from the job cache file and create jobs as needed.
4093 */
4094
4095 cupsdLogMessage(CUPSD_LOG_INFO, "Loading job cache file \"%s\"...",
4096 filename);
4097
4098 linenum = 0;
4099 job = NULL;
4100
4101 while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
4102 {
4103 if (!_cups_strcasecmp(line, "NextJobId"))
4104 {
4105 if (value)
4106 NextJobId = atoi(value);
4107 }
4108 else if (!_cups_strcasecmp(line, "<Job"))
4109 {
4110 if (job)
4111 {
4112 cupsdLogMessage(CUPSD_LOG_ERROR, "Missing </Job> directive on line %d of %s.", linenum, filename);
4113 continue;
4114 }
4115
4116 if (!value)
4117 {
4118 cupsdLogMessage(CUPSD_LOG_ERROR, "Missing job ID on line %d of %s.", linenum, filename);
4119 continue;
4120 }
4121
4122 jobid = atoi(value);
4123
4124 if (jobid < 1)
4125 {
4126 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad job ID %d on line %d of %s.", jobid, linenum, filename);
4127 continue;
4128 }
4129
4130 snprintf(jobfile, sizeof(jobfile), "%s/c%05d", RequestRoot, jobid);
4131 if (access(jobfile, 0))
4132 {
4133 snprintf(jobfile, sizeof(jobfile), "%s/c%05d.N", RequestRoot, jobid);
4134 if (access(jobfile, 0))
4135 {
4136 cupsdLogMessage(CUPSD_LOG_ERROR, "[Job %d] Files have gone away.",
4137 jobid);
4138
4139 /*
4140 * job.cache file is out-of-date compared to spool directory; load
4141 * that instead...
4142 */
4143
4144 cupsFileClose(fp);
4145 load_request_root();
4146 return;
4147 }
4148 }
4149
4150 job = calloc(1, sizeof(cupsd_job_t));
4151 if (!job)
4152 {
4153 cupsdLogMessage(CUPSD_LOG_EMERG,
4154 "[Job %d] Unable to allocate memory for job.", jobid);
4155 break;
4156 }
4157
4158 job->id = jobid;
4159 job->back_pipes[0] = -1;
4160 job->back_pipes[1] = -1;
4161 job->print_pipes[0] = -1;
4162 job->print_pipes[1] = -1;
4163 job->side_pipes[0] = -1;
4164 job->side_pipes[1] = -1;
4165 job->status_pipes[0] = -1;
4166 job->status_pipes[1] = -1;
4167
4168 cupsdLogJob(job, CUPSD_LOG_DEBUG, "Loading from cache...");
4169 }
4170 else if (!job)
4171 {
4172 cupsdLogMessage(CUPSD_LOG_ERROR,
4173 "Missing <Job #> directive on line %d of %s.", linenum, filename);
4174 continue;
4175 }
4176 else if (!_cups_strcasecmp(line, "</Job>"))
4177 {
4178 cupsArrayAdd(Jobs, job);
4179
4180 if (job->state_value <= IPP_JOB_STOPPED && cupsdLoadJob(job))
4181 cupsArrayAdd(ActiveJobs, job);
4182 else if (job->state_value > IPP_JOB_STOPPED)
4183 {
4184 if (!job->completed_time || !job->creation_time || !job->name || !job->koctets)
4185 {
4186 cupsdLoadJob(job);
4187 unload_job(job);
4188 }
4189 }
4190
4191 job = NULL;
4192 }
4193 else if (!value)
4194 {
4195 cupsdLogMessage(CUPSD_LOG_ERROR, "Missing value on line %d of %s.", linenum, filename);
4196 continue;
4197 }
4198 else if (!_cups_strcasecmp(line, "State"))
4199 {
4200 job->state_value = (ipp_jstate_t)atoi(value);
4201
4202 if (job->state_value < IPP_JOB_PENDING)
4203 job->state_value = IPP_JOB_PENDING;
4204 else if (job->state_value > IPP_JOB_COMPLETED)
4205 job->state_value = IPP_JOB_COMPLETED;
4206 }
4207 else if (!_cups_strcasecmp(line, "Name"))
4208 {
4209 cupsdSetString(&(job->name), value);
4210 }
4211 else if (!_cups_strcasecmp(line, "Created"))
4212 {
4213 job->creation_time = strtol(value, NULL, 10);
4214 }
4215 else if (!_cups_strcasecmp(line, "Completed"))
4216 {
4217 job->completed_time = strtol(value, NULL, 10);
4218 }
4219 else if (!_cups_strcasecmp(line, "HoldUntil"))
4220 {
4221 job->hold_until = strtol(value, NULL, 10);
4222 }
4223 else if (!_cups_strcasecmp(line, "Priority"))
4224 {
4225 job->priority = atoi(value);
4226 }
4227 else if (!_cups_strcasecmp(line, "Username"))
4228 {
4229 cupsdSetString(&job->username, value);
4230 }
4231 else if (!_cups_strcasecmp(line, "Destination"))
4232 {
4233 cupsdSetString(&job->dest, value);
4234 }
4235 else if (!_cups_strcasecmp(line, "DestType"))
4236 {
4237 job->dtype = (cups_ptype_t)atoi(value);
4238 }
4239 else if (!_cups_strcasecmp(line, "KOctets"))
4240 {
4241 job->koctets = atoi(value);
4242 }
4243 else if (!_cups_strcasecmp(line, "NumFiles"))
4244 {
4245 job->num_files = atoi(value);
4246
4247 if (job->num_files < 0)
4248 {
4249 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad NumFiles value %d on line %d of %s.", job->num_files, linenum, filename);
4250 job->num_files = 0;
4251 continue;
4252 }
4253
4254 if (job->num_files > 0)
4255 {
4256 snprintf(jobfile, sizeof(jobfile), "%s/d%05d-001", RequestRoot,
4257 job->id);
4258 if (access(jobfile, 0))
4259 {
4260 cupsdLogJob(job, CUPSD_LOG_INFO, "Data files have gone away.");
4261 job->num_files = 0;
4262 continue;
4263 }
4264
4265 job->filetypes = calloc((size_t)job->num_files, sizeof(mime_type_t *));
4266 job->compressions = calloc((size_t)job->num_files, sizeof(int));
4267
4268 if (!job->filetypes || !job->compressions)
4269 {
4270 cupsdLogJob(job, CUPSD_LOG_EMERG,
4271 "Unable to allocate memory for %d files.",
4272 job->num_files);
4273 break;
4274 }
4275 }
4276 }
4277 else if (!_cups_strcasecmp(line, "File"))
4278 {
4279 int number, /* File number */
4280 compression; /* Compression value */
4281 char super[MIME_MAX_SUPER], /* MIME super type */
4282 type[MIME_MAX_TYPE]; /* MIME type */
4283
4284
4285 if (sscanf(value, "%d%*[ \t]%15[^/]/%255s%d", &number, super, type,
4286 &compression) != 4)
4287 {
4288 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad File on line %d of %s.", linenum, filename);
4289 continue;
4290 }
4291
4292 if (number < 1 || number > job->num_files)
4293 {
4294 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad File number %d on line %d of %s.", number, linenum, filename);
4295 continue;
4296 }
4297
4298 number --;
4299
4300 job->compressions[number] = compression;
4301 job->filetypes[number] = mimeType(MimeDatabase, super, type);
4302
4303 if (!job->filetypes[number])
4304 {
4305 /*
4306 * If the original MIME type is unknown, auto-type it!
4307 */
4308
4309 cupsdLogJob(job, CUPSD_LOG_ERROR,
4310 "Unknown MIME type %s/%s for file %d.",
4311 super, type, number + 1);
4312
4313 snprintf(jobfile, sizeof(jobfile), "%s/d%05d-%03d", RequestRoot,
4314 job->id, number + 1);
4315 job->filetypes[number] = mimeFileType(MimeDatabase, jobfile, NULL,
4316 job->compressions + number);
4317
4318 /*
4319 * If that didn't work, assume it is raw...
4320 */
4321
4322 if (!job->filetypes[number])
4323 job->filetypes[number] = mimeType(MimeDatabase, "application",
4324 "vnd.cups-raw");
4325 }
4326 }
4327 else
4328 cupsdLogMessage(CUPSD_LOG_ERROR, "Unknown %s directive on line %d of %s.", line, linenum, filename);
4329 }
4330
4331 if (job)
4332 {
4333 cupsdLogMessage(CUPSD_LOG_ERROR,
4334 "Missing </Job> directive on line %d of %s.", linenum, filename);
4335 cupsdDeleteJob(job, CUPSD_JOB_PURGE);
4336 }
4337
4338 cupsFileClose(fp);
4339 }
4340
4341
4342 /*
4343 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
4344 */
4345
4346 static void
4347 load_next_job_id(const char *filename) /* I - job.cache filename */
4348 {
4349 cups_file_t *fp; /* job.cache file */
4350 char line[1024], /* Line buffer */
4351 *value; /* Value on line */
4352 int linenum; /* Line number in file */
4353 int next_job_id; /* NextJobId value from line */
4354
4355
4356 /*
4357 * Read the NextJobId directive from the job.cache file and use
4358 * the value (if any).
4359 */
4360
4361 if ((fp = cupsFileOpen(filename, "r")) == NULL)
4362 {
4363 if (errno != ENOENT)
4364 cupsdLogMessage(CUPSD_LOG_ERROR,
4365 "Unable to open job cache file \"%s\": %s",
4366 filename, strerror(errno));
4367
4368 return;
4369 }
4370
4371 cupsdLogMessage(CUPSD_LOG_INFO,
4372 "Loading NextJobId from job cache file \"%s\"...", filename);
4373
4374 linenum = 0;
4375
4376 while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
4377 {
4378 if (!_cups_strcasecmp(line, "NextJobId"))
4379 {
4380 if (value)
4381 {
4382 next_job_id = atoi(value);
4383
4384 if (next_job_id > NextJobId)
4385 NextJobId = next_job_id;
4386 }
4387 break;
4388 }
4389 }
4390
4391 cupsFileClose(fp);
4392 }
4393
4394
4395 /*
4396 * 'load_request_root()' - Load jobs from the RequestRoot directory.
4397 */
4398
4399 static void
4400 load_request_root(void)
4401 {
4402 cups_dir_t *dir; /* Directory */
4403 cups_dentry_t *dent; /* Directory entry */
4404 cupsd_job_t *job; /* New job */
4405
4406
4407 /*
4408 * Open the requests directory...
4409 */
4410
4411 cupsdLogMessage(CUPSD_LOG_DEBUG, "Scanning %s for jobs...", RequestRoot);
4412
4413 if ((dir = cupsDirOpen(RequestRoot)) == NULL)
4414 {
4415 cupsdLogMessage(CUPSD_LOG_ERROR,
4416 "Unable to open spool directory \"%s\": %s",
4417 RequestRoot, strerror(errno));
4418 return;
4419 }
4420
4421 /*
4422 * Read all the c##### files...
4423 */
4424
4425 while ((dent = cupsDirRead(dir)) != NULL)
4426 if (strlen(dent->filename) >= 6 && dent->filename[0] == 'c')
4427 {
4428 /*
4429 * Allocate memory for the job...
4430 */
4431
4432 if ((job = calloc(sizeof(cupsd_job_t), 1)) == NULL)
4433 {
4434 cupsdLogMessage(CUPSD_LOG_ERROR, "Ran out of memory for jobs.");
4435 cupsDirClose(dir);
4436 return;
4437 }
4438
4439 /*
4440 * Assign the job ID...
4441 */
4442
4443 job->id = atoi(dent->filename + 1);
4444 job->back_pipes[0] = -1;
4445 job->back_pipes[1] = -1;
4446 job->print_pipes[0] = -1;
4447 job->print_pipes[1] = -1;
4448 job->side_pipes[0] = -1;
4449 job->side_pipes[1] = -1;
4450 job->status_pipes[0] = -1;
4451 job->status_pipes[1] = -1;
4452
4453 if (job->id >= NextJobId)
4454 NextJobId = job->id + 1;
4455
4456 /*
4457 * Load the job...
4458 */
4459
4460 if (cupsdLoadJob(job))
4461 {
4462 /*
4463 * Insert the job into the array, sorting by job priority and ID...
4464 */
4465
4466 cupsArrayAdd(Jobs, job);
4467
4468 if (job->state_value <= IPP_JOB_STOPPED)
4469 cupsArrayAdd(ActiveJobs, job);
4470 else
4471 unload_job(job);
4472 }
4473 else
4474 free(job);
4475 }
4476
4477 cupsDirClose(dir);
4478 }
4479
4480
4481 /*
4482 * 'remove_job_files()' - Remove the document files for a job.
4483 */
4484
4485 static void
4486 remove_job_files(cupsd_job_t *job) /* I - Job */
4487 {
4488 int i; /* Looping var */
4489 char filename[1024]; /* Document filename */
4490
4491
4492 if (job->num_files <= 0)
4493 return;
4494
4495 for (i = 1; i <= job->num_files; i ++)
4496 {
4497 snprintf(filename, sizeof(filename), "%s/d%05d-%03d", RequestRoot,
4498 job->id, i);
4499 cupsdUnlinkOrRemoveFile(filename);
4500 }
4501
4502 free(job->filetypes);
4503 free(job->compressions);
4504
4505 job->file_time = 0;
4506 job->num_files = 0;
4507 job->filetypes = NULL;
4508 job->compressions = NULL;
4509
4510 LastEvent |= CUPSD_EVENT_PRINTER_STATE_CHANGED;
4511 }
4512
4513
4514 /*
4515 * 'remove_job_history()' - Remove the control file for a job.
4516 */
4517
4518 static void
4519 remove_job_history(cupsd_job_t *job) /* I - Job */
4520 {
4521 char filename[1024]; /* Control filename */
4522
4523
4524 /*
4525 * Remove the job info file...
4526 */
4527
4528 snprintf(filename, sizeof(filename), "%s/c%05d", RequestRoot,
4529 job->id);
4530 cupsdUnlinkOrRemoveFile(filename);
4531
4532 LastEvent |= CUPSD_EVENT_PRINTER_STATE_CHANGED;
4533 }
4534
4535
4536 /*
4537 * 'set_time()' - Set one of the "time-at-xyz" attributes.
4538 */
4539
4540 static void
4541 set_time(cupsd_job_t *job, /* I - Job to update */
4542 const char *name) /* I - Name of attribute */
4543 {
4544 char date_name[128]; /* date-time-at-xxx */
4545 ipp_attribute_t *attr; /* Time attribute */
4546 time_t curtime; /* Current time */
4547
4548
4549 curtime = time(NULL);
4550
4551 cupsdLogJob(job, CUPSD_LOG_DEBUG, "%s=%ld", name, (long)curtime);
4552
4553 if ((attr = ippFindAttribute(job->attrs, name, IPP_TAG_ZERO)) != NULL)
4554 {
4555 attr->value_tag = IPP_TAG_INTEGER;
4556 attr->values[0].integer = curtime;
4557 }
4558
4559 snprintf(date_name, sizeof(date_name), "date-%s", name);
4560
4561 if ((attr = ippFindAttribute(job->attrs, date_name, IPP_TAG_ZERO)) != NULL)
4562 {
4563 attr->value_tag = IPP_TAG_DATE;
4564 ippSetDate(job->attrs, &attr, 0, ippTimeToDate(curtime));
4565 }
4566
4567 if (!strcmp(name, "time-at-completed"))
4568 {
4569 job->completed_time = curtime;
4570
4571 if (JobHistory < INT_MAX && attr)
4572 job->history_time = attr->values[0].integer + JobHistory;
4573 else
4574 job->history_time = INT_MAX;
4575
4576 if (job->history_time < JobHistoryUpdate || !JobHistoryUpdate)
4577 JobHistoryUpdate = job->history_time;
4578
4579 if (JobFiles < INT_MAX && attr)
4580 job->file_time = attr->values[0].integer + JobFiles;
4581 else
4582 job->file_time = INT_MAX;
4583
4584 if (job->file_time < JobHistoryUpdate || !JobHistoryUpdate)
4585 JobHistoryUpdate = job->file_time;
4586
4587 cupsdLogMessage(CUPSD_LOG_DEBUG2, "set_time: JobHistoryUpdate=%ld",
4588 (long)JobHistoryUpdate);
4589 }
4590 }
4591
4592
4593 /*
4594 * 'start_job()' - Start a print job.
4595 */
4596
4597 static void
4598 start_job(cupsd_job_t *job, /* I - Job ID */
4599 cupsd_printer_t *printer) /* I - Printer to print job */
4600 {
4601 const char *filename; /* Support filename */
4602 ipp_attribute_t *cancel_after = ippFindAttribute(job->attrs,
4603 "job-cancel-after",
4604 IPP_TAG_INTEGER);
4605 /* job-cancel-after attribute */
4606
4607
4608 cupsdLogMessage(CUPSD_LOG_DEBUG2, "start_job(job=%p(%d), printer=%p(%s))",
4609 job, job->id, printer, printer->name);
4610
4611 /*
4612 * Make sure we have some files around before we try to print...
4613 */
4614
4615 if (job->num_files == 0)
4616 {
4617 ippSetString(job->attrs, &job->reasons, 0, "aborted-by-system");
4618 cupsdSetJobState(job, IPP_JOB_ABORTED, CUPSD_JOB_DEFAULT,
4619 "Aborting job because it has no files.");
4620 return;
4621 }
4622
4623 /*
4624 * Update the printer and job state to "processing"...
4625 */
4626
4627 if (!cupsdLoadJob(job))
4628 return;
4629
4630 if (!job->printer_message)
4631 job->printer_message = ippFindAttribute(job->attrs,
4632 "job-printer-state-message",
4633 IPP_TAG_TEXT);
4634 if (job->printer_message)
4635 ippSetString(job->attrs, &job->printer_message, 0, "");
4636
4637 ippSetString(job->attrs, &job->reasons, 0, "job-printing");
4638 cupsdSetJobState(job, IPP_JOB_PROCESSING, CUPSD_JOB_DEFAULT, NULL);
4639 cupsdSetPrinterState(printer, IPP_PRINTER_PROCESSING, 0);
4640 cupsdSetPrinterReasons(printer, "-cups-remote-pending,"
4641 "cups-remote-pending-held,"
4642 "cups-remote-processing,"
4643 "cups-remote-stopped,"
4644 "cups-remote-canceled,"
4645 "cups-remote-aborted,"
4646 "cups-remote-completed");
4647
4648 job->cost = 0;
4649 job->current_file = 0;
4650 job->file_time = 0;
4651 job->history_time = 0;
4652 job->progress = 0;
4653 job->printer = printer;
4654 printer->job = job;
4655
4656 if (cancel_after)
4657 job->cancel_time = time(NULL) + ippGetInteger(cancel_after, 0);
4658 else if (MaxJobTime > 0)
4659 job->cancel_time = time(NULL) + MaxJobTime;
4660 else
4661 job->cancel_time = 0;
4662
4663 /*
4664 * Check for support files...
4665 */
4666
4667 cupsdSetPrinterReasons(job->printer, "-cups-missing-filter-warning,"
4668 "cups-insecure-filter-warning");
4669
4670 if (printer->pc)
4671 {
4672 for (filename = (const char *)cupsArrayFirst(printer->pc->support_files);
4673 filename;
4674 filename = (const char *)cupsArrayNext(printer->pc->support_files))
4675 {
4676 if (_cupsFileCheck(filename, _CUPS_FILE_CHECK_FILE, !RunUser,
4677 cupsdLogFCMessage, printer))
4678 break;
4679 }
4680 }
4681
4682 /*
4683 * Setup the last exit status and security profiles...
4684 */
4685
4686 job->status = 0;
4687 job->profile = cupsdCreateProfile(job->id, 0);
4688 job->bprofile = cupsdCreateProfile(job->id, 1);
4689
4690 /*
4691 * Create the status pipes and buffer...
4692 */
4693
4694 if (cupsdOpenPipe(job->status_pipes))
4695 {
4696 cupsdLogJob(job, CUPSD_LOG_DEBUG,
4697 "Unable to create job status 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 "job status pipes.");
4702
4703 cupsdDestroyProfile(job->profile);
4704 job->profile = NULL;
4705 cupsdDestroyProfile(job->bprofile);
4706 job->bprofile = NULL;
4707 return;
4708 }
4709
4710 job->status_buffer = cupsdStatBufNew(job->status_pipes[0], NULL);
4711 job->status_level = CUPSD_LOG_INFO;
4712
4713 /*
4714 * Create the backchannel pipes and make them non-blocking...
4715 */
4716
4717 if (cupsdOpenPipe(job->back_pipes))
4718 {
4719 cupsdLogJob(job, CUPSD_LOG_DEBUG,
4720 "Unable to create back-channel pipes - %s.", strerror(errno));
4721
4722 cupsdSetJobState(job, IPP_JOB_STOPPED, CUPSD_JOB_DEFAULT,
4723 "Job stopped because the scheduler could not create the "
4724 "back-channel pipes.");
4725
4726 cupsdClosePipe(job->status_pipes);
4727 cupsdStatBufDelete(job->status_buffer);
4728 job->status_buffer = NULL;
4729
4730 cupsdDestroyProfile(job->profile);
4731 job->profile = NULL;
4732 cupsdDestroyProfile(job->bprofile);
4733 job->bprofile = NULL;
4734 return;
4735 }
4736
4737 fcntl(job->back_pipes[0], F_SETFL,
4738 fcntl(job->back_pipes[0], F_GETFL) | O_NONBLOCK);
4739 fcntl(job->back_pipes[1], F_SETFL,
4740 fcntl(job->back_pipes[1], F_GETFL) | O_NONBLOCK);
4741
4742 /*
4743 * Create the side-channel pipes and make them non-blocking...
4744 */
4745
4746 if (socketpair(AF_LOCAL, SOCK_STREAM, 0, job->side_pipes))
4747 {
4748 cupsdLogJob(job, CUPSD_LOG_DEBUG,
4749 "Unable to create side-channel pipes - %s.", strerror(errno));
4750
4751 cupsdSetJobState(job, IPP_JOB_STOPPED, CUPSD_JOB_DEFAULT,
4752 "Job stopped because the scheduler could not create the "
4753 "side-channel pipes.");
4754
4755 cupsdClosePipe(job->back_pipes);
4756
4757 cupsdClosePipe(job->status_pipes);
4758 cupsdStatBufDelete(job->status_buffer);
4759 job->status_buffer = NULL;
4760
4761 cupsdDestroyProfile(job->profile);
4762 job->profile = NULL;
4763 cupsdDestroyProfile(job->bprofile);
4764 job->bprofile = NULL;
4765 return;
4766 }
4767
4768 fcntl(job->side_pipes[0], F_SETFL,
4769 fcntl(job->side_pipes[0], F_GETFL) | O_NONBLOCK);
4770 fcntl(job->side_pipes[1], F_SETFL,
4771 fcntl(job->side_pipes[1], F_GETFL) | O_NONBLOCK);
4772
4773 fcntl(job->side_pipes[0], F_SETFD,
4774 fcntl(job->side_pipes[0], F_GETFD) | FD_CLOEXEC);
4775 fcntl(job->side_pipes[1], F_SETFD,
4776 fcntl(job->side_pipes[1], F_GETFD) | FD_CLOEXEC);
4777
4778 /*
4779 * Now start the first file in the job...
4780 */
4781
4782 cupsdContinueJob(job);
4783 }
4784
4785
4786 /*
4787 * 'stop_job()' - Stop a print job.
4788 */
4789
4790 static void
4791 stop_job(cupsd_job_t *job, /* I - Job */
4792 cupsd_jobaction_t action) /* I - Action */
4793 {
4794 int i; /* Looping var */
4795
4796
4797 cupsdLogMessage(CUPSD_LOG_DEBUG2, "stop_job(job=%p(%d), action=%d)", job,
4798 job->id, action);
4799
4800 FilterLevel -= job->cost;
4801 job->cost = 0;
4802
4803 if (action == CUPSD_JOB_DEFAULT && !job->kill_time && job->backend > 0)
4804 job->kill_time = time(NULL) + JobKillDelay;
4805 else if (action >= CUPSD_JOB_FORCE)
4806 job->kill_time = 0;
4807
4808 for (i = 0; job->filters[i]; i ++)
4809 if (job->filters[i] > 0)
4810 {
4811 cupsdEndProcess(job->filters[i], action >= CUPSD_JOB_FORCE);
4812
4813 if (action >= CUPSD_JOB_FORCE)
4814 job->filters[i] = -job->filters[i];
4815 }
4816
4817 if (job->backend > 0)
4818 {
4819 cupsdEndProcess(job->backend, action >= CUPSD_JOB_FORCE);
4820
4821 if (action >= CUPSD_JOB_FORCE)
4822 job->backend = -job->backend;
4823 }
4824
4825 if (action >= CUPSD_JOB_FORCE)
4826 {
4827 /*
4828 * Clear job status...
4829 */
4830
4831 job->status = 0;
4832 }
4833 }
4834
4835
4836 /*
4837 * 'unload_job()' - Unload a job from memory.
4838 */
4839
4840 static void
4841 unload_job(cupsd_job_t *job) /* I - Job */
4842 {
4843 if (!job->attrs)
4844 return;
4845
4846 cupsdLogJob(job, CUPSD_LOG_DEBUG, "Unloading...");
4847
4848 ippDelete(job->attrs);
4849
4850 job->attrs = NULL;
4851 job->state = NULL;
4852 job->reasons = NULL;
4853 job->impressions = NULL;
4854 job->sheets = NULL;
4855 job->job_sheets = NULL;
4856 job->printer_message = NULL;
4857 job->printer_reasons = NULL;
4858 }
4859
4860
4861 /*
4862 * 'update_job()' - Read a status update from a job's filters.
4863 */
4864
4865 void
4866 update_job(cupsd_job_t *job) /* I - Job to check */
4867 {
4868 int i; /* Looping var */
4869 int copies; /* Number of copies printed */
4870 char message[CUPSD_SB_BUFFER_SIZE],
4871 /* Message text */
4872 *ptr; /* Pointer update... */
4873 int loglevel, /* Log level for message */
4874 event = 0; /* Events? */
4875 cupsd_printer_t *printer = job->printer;
4876 /* Printer */
4877 static const char * const levels[] = /* Log levels */
4878 {
4879 "NONE",
4880 "EMERG",
4881 "ALERT",
4882 "CRIT",
4883 "ERROR",
4884 "WARN",
4885 "NOTICE",
4886 "INFO",
4887 "DEBUG",
4888 "DEBUG2"
4889 };
4890
4891
4892 /*
4893 * Get the printer associated with this job; if the printer is stopped for
4894 * any reason then job->printer will be reset to NULL, so make sure we have
4895 * a valid pointer...
4896 */
4897
4898 while ((ptr = cupsdStatBufUpdate(job->status_buffer, &loglevel,
4899 message, sizeof(message))) != NULL)
4900 {
4901 /*
4902 * Process page and printer state messages as needed...
4903 */
4904
4905 if (loglevel == CUPSD_LOG_PAGE)
4906 {
4907 /*
4908 * Page message; send the message to the page_log file and update the
4909 * job sheet count...
4910 */
4911
4912 cupsdLogJob(job, CUPSD_LOG_DEBUG, "PAGE: %s", message);
4913
4914 if (job->impressions)
4915 {
4916 if (!_cups_strncasecmp(message, "total ", 6))
4917 {
4918 /*
4919 * Got a total count of pages from a backend or filter...
4920 */
4921
4922 copies = atoi(message + 6);
4923 copies -= ippGetInteger(job->impressions, 0); /* Just track the delta */
4924 }
4925 else if (!sscanf(message, "%*d%d", &copies))
4926 copies = 1;
4927
4928 ippSetInteger(job->attrs, &job->impressions, 0, ippGetInteger(job->impressions, 0) + copies);
4929 job->dirty = 1;
4930 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
4931 }
4932
4933 if (job->sheets)
4934 {
4935 if (!_cups_strncasecmp(message, "total ", 6))
4936 {
4937 /*
4938 * Got a total count of pages from a backend or filter...
4939 */
4940
4941 copies = atoi(message + 6);
4942 copies -= ippGetInteger(job->sheets, 0); /* Just track the delta */
4943 }
4944 else if (!sscanf(message, "%*d%d", &copies))
4945 copies = 1;
4946
4947 ippSetInteger(job->attrs, &job->sheets, 0, ippGetInteger(job->sheets, 0) + copies);
4948 job->dirty = 1;
4949 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
4950
4951 if (job->printer->page_limit)
4952 cupsdUpdateQuota(job->printer, job->username, copies, 0);
4953 }
4954
4955 cupsdLogPage(job, message);
4956
4957 if (job->sheets)
4958 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS, job->printer, job, "Printed %d page(s).", ippGetInteger(job->sheets, 0));
4959 }
4960 else if (loglevel == CUPSD_LOG_JOBSTATE)
4961 {
4962 /*
4963 * Support "keyword" to set job-state-reasons to the specified keyword.
4964 * This is sufficient for the current paid printing stuff.
4965 */
4966
4967 cupsdLogJob(job, CUPSD_LOG_DEBUG, "JOBSTATE: %s", message);
4968
4969 if (!strcmp(message, "cups-retry-as-raster"))
4970 job->retry_as_raster = 1;
4971 else
4972 ippSetString(job->attrs, &job->reasons, 0, message);
4973 }
4974 else if (loglevel == CUPSD_LOG_STATE)
4975 {
4976 cupsdLogJob(job, CUPSD_LOG_DEBUG, "STATE: %s", message);
4977
4978 if (!strcmp(message, "paused"))
4979 {
4980 cupsdStopPrinter(job->printer, 1);
4981 return;
4982 }
4983 else if (message[0] && cupsdSetPrinterReasons(job->printer, message))
4984 {
4985 event |= CUPSD_EVENT_PRINTER_STATE;
4986
4987 if (MaxJobTime > 0)
4988 {
4989 /*
4990 * Reset cancel time after connecting to the device...
4991 */
4992
4993 for (i = 0; i < job->printer->num_reasons; i ++)
4994 if (!strcmp(job->printer->reasons[i], "connecting-to-device"))
4995 break;
4996
4997 if (i >= job->printer->num_reasons)
4998 {
4999 ipp_attribute_t *cancel_after = ippFindAttribute(job->attrs,
5000 "job-cancel-after",
5001 IPP_TAG_INTEGER);
5002 /* job-cancel-after attribute */
5003
5004 if (cancel_after)
5005 job->cancel_time = time(NULL) + ippGetInteger(cancel_after, 0);
5006 else
5007 job->cancel_time = time(NULL) + MaxJobTime;
5008 }
5009 }
5010 }
5011
5012 update_job_attrs(job, 0);
5013 }
5014 else if (loglevel == CUPSD_LOG_ATTR)
5015 {
5016 /*
5017 * Set attribute(s)...
5018 */
5019
5020 int num_attrs; /* Number of attributes */
5021 cups_option_t *attrs; /* Attributes */
5022 const char *attr; /* Attribute */
5023
5024 cupsdLogJob(job, CUPSD_LOG_DEBUG, "ATTR: %s", message);
5025
5026 num_attrs = cupsParseOptions(message, 0, &attrs);
5027
5028 if ((attr = cupsGetOption("auth-info-default", num_attrs,
5029 attrs)) != NULL)
5030 {
5031 job->printer->num_options = cupsAddOption("auth-info", attr,
5032 job->printer->num_options,
5033 &(job->printer->options));
5034 cupsdSetPrinterAttrs(job->printer);
5035
5036 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
5037 }
5038
5039 if ((attr = cupsGetOption("auth-info-required", num_attrs,
5040 attrs)) != NULL)
5041 {
5042 cupsdSetAuthInfoRequired(job->printer, attr, NULL);
5043 cupsdSetPrinterAttrs(job->printer);
5044
5045 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
5046 }
5047
5048 if ((attr = cupsGetOption("job-media-progress", num_attrs,
5049 attrs)) != NULL)
5050 {
5051 int progress = atoi(attr);
5052
5053
5054 if (progress >= 0 && progress <= 100)
5055 {
5056 job->progress = progress;
5057
5058 if (job->sheets)
5059 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS, job->printer, job,
5060 "Printing page %d, %d%%",
5061 job->sheets->values[0].integer, job->progress);
5062 }
5063 }
5064
5065 if ((attr = cupsGetOption("printer-alert", num_attrs, attrs)) != NULL)
5066 {
5067 cupsdSetString(&job->printer->alert, attr);
5068 event |= CUPSD_EVENT_PRINTER_STATE;
5069 }
5070
5071 if ((attr = cupsGetOption("printer-alert-description", num_attrs,
5072 attrs)) != NULL)
5073 {
5074 cupsdSetString(&job->printer->alert_description, attr);
5075 event |= CUPSD_EVENT_PRINTER_STATE;
5076 }
5077
5078 if ((attr = cupsGetOption("marker-colors", num_attrs, attrs)) != NULL)
5079 {
5080 cupsdSetPrinterAttr(job->printer, "marker-colors", (char *)attr);
5081 job->printer->marker_time = time(NULL);
5082 event |= CUPSD_EVENT_PRINTER_STATE;
5083 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
5084 }
5085
5086 if ((attr = cupsGetOption("marker-levels", num_attrs, attrs)) != NULL)
5087 {
5088 cupsdSetPrinterAttr(job->printer, "marker-levels", (char *)attr);
5089 job->printer->marker_time = time(NULL);
5090 event |= CUPSD_EVENT_PRINTER_STATE;
5091 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
5092 }
5093
5094 if ((attr = cupsGetOption("marker-low-levels", num_attrs, attrs)) != NULL)
5095 {
5096 cupsdSetPrinterAttr(job->printer, "marker-low-levels", (char *)attr);
5097 job->printer->marker_time = time(NULL);
5098 event |= CUPSD_EVENT_PRINTER_STATE;
5099 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
5100 }
5101
5102 if ((attr = cupsGetOption("marker-high-levels", num_attrs, attrs)) != NULL)
5103 {
5104 cupsdSetPrinterAttr(job->printer, "marker-high-levels", (char *)attr);
5105 job->printer->marker_time = time(NULL);
5106 event |= CUPSD_EVENT_PRINTER_STATE;
5107 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
5108 }
5109
5110 if ((attr = cupsGetOption("marker-message", num_attrs, attrs)) != NULL)
5111 {
5112 cupsdSetPrinterAttr(job->printer, "marker-message", (char *)attr);
5113 job->printer->marker_time = time(NULL);
5114 event |= CUPSD_EVENT_PRINTER_STATE;
5115 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
5116 }
5117
5118 if ((attr = cupsGetOption("marker-names", num_attrs, attrs)) != NULL)
5119 {
5120 cupsdSetPrinterAttr(job->printer, "marker-names", (char *)attr);
5121 job->printer->marker_time = time(NULL);
5122 event |= CUPSD_EVENT_PRINTER_STATE;
5123 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
5124 }
5125
5126 if ((attr = cupsGetOption("marker-types", num_attrs, attrs)) != NULL)
5127 {
5128 cupsdSetPrinterAttr(job->printer, "marker-types", (char *)attr);
5129 job->printer->marker_time = time(NULL);
5130 event |= CUPSD_EVENT_PRINTER_STATE;
5131 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
5132 }
5133
5134 cupsFreeOptions(num_attrs, attrs);
5135 }
5136 else if (loglevel == CUPSD_LOG_PPD)
5137 {
5138 /*
5139 * Set attribute(s)...
5140 */
5141
5142 cupsdLogJob(job, CUPSD_LOG_DEBUG, "PPD: %s", message);
5143
5144 job->num_keywords = cupsParseOptions(message, job->num_keywords,
5145 &job->keywords);
5146 }
5147 else
5148 {
5149 /*
5150 * Strip legacy message prefix...
5151 */
5152
5153 if (!strncmp(message, "recoverable:", 12))
5154 {
5155 ptr = message + 12;
5156 while (isspace(*ptr & 255))
5157 ptr ++;
5158 }
5159 else if (!strncmp(message, "recovered:", 10))
5160 {
5161 ptr = message + 10;
5162 while (isspace(*ptr & 255))
5163 ptr ++;
5164 }
5165 else
5166 ptr = message;
5167
5168 if (*ptr)
5169 cupsdLogJob(job, loglevel, "%s", ptr);
5170
5171 if (loglevel < CUPSD_LOG_DEBUG &&
5172 strcmp(job->printer->state_message, ptr))
5173 {
5174 strlcpy(job->printer->state_message, ptr,
5175 sizeof(job->printer->state_message));
5176
5177 event |= CUPSD_EVENT_PRINTER_STATE | CUPSD_EVENT_JOB_PROGRESS;
5178
5179 if (loglevel <= job->status_level && job->status_level > CUPSD_LOG_ERROR)
5180 {
5181 /*
5182 * Some messages show in the job-printer-state-message attribute...
5183 */
5184
5185 if (loglevel != CUPSD_LOG_NOTICE)
5186 job->status_level = loglevel;
5187
5188 update_job_attrs(job, 1);
5189
5190 cupsdLogJob(job, CUPSD_LOG_DEBUG,
5191 "Set job-printer-state-message to \"%s\", "
5192 "current level=%s",
5193 job->printer_message->values[0].string.text,
5194 levels[job->status_level]);
5195 }
5196 }
5197 }
5198
5199 if (!strchr(job->status_buffer->buffer, '\n'))
5200 break;
5201 }
5202
5203 if (event & CUPSD_EVENT_JOB_PROGRESS)
5204 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS, job->printer, job,
5205 "%s", job->printer->state_message);
5206 if (event & CUPSD_EVENT_PRINTER_STATE)
5207 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE, job->printer, NULL,
5208 (job->printer->type & CUPS_PRINTER_CLASS) ?
5209 "Class \"%s\" state changed." :
5210 "Printer \"%s\" state changed.",
5211 job->printer->name);
5212
5213
5214 if (ptr == NULL && !job->status_buffer->bufused)
5215 {
5216 /*
5217 * See if all of the filters and the backend have returned their
5218 * exit statuses.
5219 */
5220
5221 for (i = 0; job->filters[i] < 0; i ++);
5222
5223 if (job->filters[i])
5224 {
5225 /*
5226 * EOF but we haven't collected the exit status of all filters...
5227 */
5228
5229 cupsdCheckProcess();
5230 return;
5231 }
5232
5233 if (job->current_file >= job->num_files && job->backend > 0)
5234 {
5235 /*
5236 * EOF but we haven't collected the exit status of the backend...
5237 */
5238
5239 cupsdCheckProcess();
5240 return;
5241 }
5242
5243 /*
5244 * Handle the end of job stuff...
5245 */
5246
5247 finalize_job(job, 1);
5248
5249 /*
5250 * Try printing another job...
5251 */
5252
5253 if (printer->state != IPP_PRINTER_STOPPED)
5254 cupsdCheckJobs();
5255 }
5256 }
5257
5258
5259 /*
5260 * 'update_job_attrs()' - Update the job-printer-* attributes.
5261 */
5262
5263 void
5264 update_job_attrs(cupsd_job_t *job, /* I - Job to update */
5265 int do_message)/* I - 1 = copy job-printer-state message */
5266 {
5267 int i; /* Looping var */
5268 int num_reasons; /* Actual number of reasons */
5269 const char * const *reasons; /* Reasons */
5270 static const char *none = "none"; /* "none" reason */
5271
5272
5273 /*
5274 * Get/create the job-printer-state-* attributes...
5275 */
5276
5277 if (!job->printer_message)
5278 {
5279 if ((job->printer_message = ippFindAttribute(job->attrs,
5280 "job-printer-state-message",
5281 IPP_TAG_TEXT)) == NULL)
5282 job->printer_message = ippAddString(job->attrs, IPP_TAG_JOB, IPP_TAG_TEXT,
5283 "job-printer-state-message",
5284 NULL, "");
5285 }
5286
5287 if (!job->printer_reasons)
5288 job->printer_reasons = ippFindAttribute(job->attrs,
5289 "job-printer-state-reasons",
5290 IPP_TAG_KEYWORD);
5291
5292 /*
5293 * Copy or clear the printer-state-message value as needed...
5294 */
5295
5296 if (job->state_value != IPP_JOB_PROCESSING &&
5297 job->status_level == CUPSD_LOG_INFO)
5298 {
5299 ippSetString(job->attrs, &job->printer_message, 0, "");
5300
5301 job->dirty = 1;
5302 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
5303 }
5304 else if (job->printer->state_message[0] && do_message)
5305 {
5306 ippSetString(job->attrs, &job->printer_message, 0, job->printer->state_message);
5307
5308 job->dirty = 1;
5309 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
5310 }
5311
5312 /*
5313 * ... and the printer-state-reasons value...
5314 */
5315
5316 if (job->printer->num_reasons == 0)
5317 {
5318 num_reasons = 1;
5319 reasons = &none;
5320 }
5321 else
5322 {
5323 num_reasons = job->printer->num_reasons;
5324 reasons = (const char * const *)job->printer->reasons;
5325 }
5326
5327 if (!job->printer_reasons || job->printer_reasons->num_values != num_reasons)
5328 {
5329 /*
5330 * Replace/create a job-printer-state-reasons attribute...
5331 */
5332
5333 ippDeleteAttribute(job->attrs, job->printer_reasons);
5334
5335 job->printer_reasons = ippAddStrings(job->attrs,
5336 IPP_TAG_JOB, IPP_TAG_KEYWORD,
5337 "job-printer-state-reasons",
5338 num_reasons, NULL, NULL);
5339 }
5340 else
5341 {
5342 /*
5343 * Don't bother clearing the reason strings if they are the same...
5344 */
5345
5346 for (i = 0; i < num_reasons; i ++)
5347 if (strcmp(job->printer_reasons->values[i].string.text, reasons[i]))
5348 break;
5349
5350 if (i >= num_reasons)
5351 return;
5352
5353 /*
5354 * Not the same, so free the current strings...
5355 */
5356
5357 for (i = 0; i < num_reasons; i ++)
5358 _cupsStrFree(job->printer_reasons->values[i].string.text);
5359 }
5360
5361 /*
5362 * Copy the reasons...
5363 */
5364
5365 for (i = 0; i < num_reasons; i ++)
5366 job->printer_reasons->values[i].string.text = _cupsStrAlloc(reasons[i]);
5367
5368 job->dirty = 1;
5369 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
5370 }
5371
5372
5373 /*
5374 * End of "$Id$".
5375 */