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