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