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