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