]> git.ipfire.org Git - thirdparty/cups.git/blob - scheduler/job.c
Merge changes from CUPS 1.5svn-r8849.
[thirdparty/cups.git] / scheduler / job.c
1 /*
2 * "$Id: job.c 7902 2008-09-03 14:20:17Z mike $"
3 *
4 * Job management routines for the Common UNIX Printing System (CUPS).
5 *
6 * Copyright 2007-2009 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
8 *
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
14 *
15 * Contents:
16 *
17 * cupsdAddJob() - Add a new job to the job queue.
18 * cupsdCancelJobs() - Cancel all jobs for the given
19 * destination/user.
20 * cupsdCheckJobs() - Check the pending jobs and start any if the
21 * destination is available.
22 * cupsdCleanJobs() - Clean out old jobs.
23 * cupsdContinueJob() - Continue printing with the next file in a job.
24 * cupsdDeleteJob() - Free all memory used by a job.
25 * cupsdFreeAllJobs() - Free all jobs from memory.
26 * cupsdFindJob() - Find the specified job.
27 * cupsdGetPrinterJobCount() - Get the number of pending, processing, or held
28 * jobs in a printer or class.
29 * cupsdGetUserJobCount() - Get the number of pending, processing, or held
30 * jobs for a user.
31 * cupsdLoadAllJobs() - Load all jobs from disk.
32 * cupsdLoadJob() - Load a single job.
33 * cupsdMoveJob() - Move the specified job to a different
34 * destination.
35 * cupsdReleaseJob() - Release the specified job.
36 * cupsdRestartJob() - Restart the specified job.
37 * cupsdSaveAllJobs() - Save a summary of all jobs to disk.
38 * cupsdSaveJob() - Save a job to disk.
39 * cupsdSetJobHoldUntil() - Set the hold time for a job.
40 * cupsdSetJobPriority() - Set the priority of a job, moving it up/down
41 * in the list as needed.
42 * cupsdSetJobState() - Set the state of the specified print job.
43 * cupsdStopAllJobs() - Stop all print jobs.
44 * cupsdUnloadCompletedJobs() - Flush completed job history from memory.
45 * compare_active_jobs() - Compare the job IDs and priorities of two
46 * jobs.
47 * compare_jobs() - Compare the job IDs of two jobs.
48 * 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);
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 int 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
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)
437 return;
438
439 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
440 job && cupsArrayCount(Jobs) >= MaxJobs;
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);
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 return (1);
1661 }
1662
1663 job->compressions = compressions;
1664 job->filetypes = filetypes;
1665 job->num_files = fileid;
1666 }
1667
1668 job->filetypes[fileid - 1] = mimeFileType(MimeDatabase, jobfile, NULL,
1669 job->compressions + fileid - 1);
1670
1671 if (!job->filetypes[fileid - 1])
1672 job->filetypes[fileid - 1] = mimeType(MimeDatabase, "application",
1673 "vnd.cups-raw");
1674 }
1675 }
1676
1677 /*
1678 * Load authentication information as needed...
1679 */
1680
1681 if (job->state_value < IPP_JOB_STOPPED)
1682 {
1683 snprintf(jobfile, sizeof(jobfile), "%s/a%05d", RequestRoot, job->id);
1684
1685 cupsdClearString(&job->auth_username);
1686 cupsdClearString(&job->auth_domain);
1687 cupsdClearString(&job->auth_password);
1688
1689 if ((fp = cupsFileOpen(jobfile, "r")) != NULL)
1690 {
1691 int i, /* Looping var */
1692 bytes; /* Size of auth data */
1693 char line[255], /* Line from file */
1694 data[255]; /* Decoded data */
1695
1696
1697 for (i = 0;
1698 i < destptr->num_auth_info_required &&
1699 cupsFileGets(fp, line, sizeof(line));
1700 i ++)
1701 {
1702 bytes = sizeof(data);
1703 httpDecode64_2(data, &bytes, line);
1704
1705 if (!strcmp(destptr->auth_info_required[i], "username"))
1706 cupsdSetStringf(&job->auth_username, "AUTH_USERNAME=%s", data);
1707 else if (!strcmp(destptr->auth_info_required[i], "domain"))
1708 cupsdSetStringf(&job->auth_domain, "AUTH_DOMAIN=%s", data);
1709 else if (!strcmp(destptr->auth_info_required[i], "password"))
1710 cupsdSetStringf(&job->auth_password, "AUTH_PASSWORD=%s", data);
1711 }
1712
1713 cupsFileClose(fp);
1714 }
1715 }
1716
1717 job->access_time = time(NULL);
1718 return (1);
1719
1720 /*
1721 * If we get here then something bad happened...
1722 */
1723
1724 error:
1725
1726 ippDelete(job->attrs);
1727 job->attrs = NULL;
1728 unlink(jobfile);
1729
1730 return (0);
1731 }
1732
1733
1734 /*
1735 * 'cupsdMoveJob()' - Move the specified job to a different destination.
1736 */
1737
1738 void
1739 cupsdMoveJob(cupsd_job_t *job, /* I - Job */
1740 cupsd_printer_t *p) /* I - Destination printer or class */
1741 {
1742 ipp_attribute_t *attr; /* job-printer-uri attribute */
1743 const char *olddest; /* Old destination */
1744 cupsd_printer_t *oldp; /* Old pointer */
1745
1746
1747 /*
1748 * Don't move completed jobs...
1749 */
1750
1751 if (job->state_value > IPP_JOB_STOPPED)
1752 return;
1753
1754 /*
1755 * Get the old destination...
1756 */
1757
1758 olddest = job->dest;
1759
1760 if (job->printer)
1761 oldp = job->printer;
1762 else
1763 oldp = cupsdFindDest(olddest);
1764
1765 /*
1766 * Change the destination information...
1767 */
1768
1769 cupsdSetJobState(job, IPP_JOB_PENDING, CUPSD_JOB_DEFAULT,
1770 "Stopping job prior to move.");
1771
1772 cupsdAddEvent(CUPSD_EVENT_JOB_CONFIG_CHANGED, oldp, job,
1773 "Job #%d moved from %s to %s.", job->id, olddest,
1774 p->name);
1775
1776 cupsdSetString(&job->dest, p->name);
1777 job->dtype = p->type & (CUPS_PRINTER_CLASS | CUPS_PRINTER_REMOTE |
1778 CUPS_PRINTER_IMPLICIT);
1779
1780 if ((attr = ippFindAttribute(job->attrs, "job-printer-uri",
1781 IPP_TAG_URI)) != NULL)
1782 cupsdSetString(&(attr->values[0].string.text), p->uri);
1783
1784 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED, p, job,
1785 "Job #%d moved from %s to %s.", job->id, olddest,
1786 p->name);
1787
1788 job->dirty = 1;
1789 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
1790 }
1791
1792
1793 /*
1794 * 'cupsdReleaseJob()' - Release the specified job.
1795 */
1796
1797 void
1798 cupsdReleaseJob(cupsd_job_t *job) /* I - Job */
1799 {
1800 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdReleaseJob(job=%p(%d))", job,
1801 job->id);
1802
1803 if (job->state_value == IPP_JOB_HELD)
1804 {
1805 /*
1806 * Add trailing banner as needed...
1807 */
1808
1809 if (job->pending_timeout)
1810 cupsdTimeoutJob(job);
1811
1812 cupsdSetJobState(job, IPP_JOB_PENDING, CUPSD_JOB_DEFAULT,
1813 "Job released by user.");
1814 }
1815 }
1816
1817
1818 /*
1819 * 'cupsdRestartJob()' - Restart the specified job.
1820 */
1821
1822 void
1823 cupsdRestartJob(cupsd_job_t *job) /* I - Job */
1824 {
1825 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdRestartJob(job=%p(%d))", job,
1826 job->id);
1827
1828 if (job->state_value == IPP_JOB_STOPPED || job->num_files)
1829 cupsdSetJobState(job, IPP_JOB_PENDING, CUPSD_JOB_DEFAULT,
1830 "Job restarted by user.");
1831 }
1832
1833
1834 /*
1835 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
1836 */
1837
1838 void
1839 cupsdSaveAllJobs(void)
1840 {
1841 int i; /* Looping var */
1842 cups_file_t *fp; /* Job cache file */
1843 char temp[1024]; /* Temporary string */
1844 cupsd_job_t *job; /* Current job */
1845 time_t curtime; /* Current time */
1846 struct tm *curdate; /* Current date */
1847
1848
1849 snprintf(temp, sizeof(temp), "%s/job.cache", CacheDir);
1850 if ((fp = cupsFileOpen(temp, "w")) == NULL)
1851 {
1852 cupsdLogMessage(CUPSD_LOG_ERROR,
1853 "Unable to create job cache file \"%s\" - %s",
1854 temp, strerror(errno));
1855 return;
1856 }
1857
1858 cupsdLogMessage(CUPSD_LOG_INFO, "Saving job cache file \"%s\"...", temp);
1859
1860 /*
1861 * Restrict access to the file...
1862 */
1863
1864 fchown(cupsFileNumber(fp), getuid(), Group);
1865 fchmod(cupsFileNumber(fp), ConfigFilePerm);
1866
1867 /*
1868 * Write a small header to the file...
1869 */
1870
1871 curtime = time(NULL);
1872 curdate = localtime(&curtime);
1873 strftime(temp, sizeof(temp) - 1, "%Y-%m-%d %H:%M", curdate);
1874
1875 cupsFilePuts(fp, "# Job cache file for " CUPS_SVERSION "\n");
1876 cupsFilePrintf(fp, "# Written by cupsd on %s\n", temp);
1877 cupsFilePrintf(fp, "NextJobId %d\n", NextJobId);
1878
1879 /*
1880 * Write each job known to the system...
1881 */
1882
1883 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
1884 job;
1885 job = (cupsd_job_t *)cupsArrayNext(Jobs))
1886 {
1887 cupsFilePrintf(fp, "<Job %d>\n", job->id);
1888 cupsFilePrintf(fp, "State %d\n", job->state_value);
1889 cupsFilePrintf(fp, "Priority %d\n", job->priority);
1890 cupsFilePrintf(fp, "HoldUntil %d\n", (int)job->hold_until);
1891 cupsFilePrintf(fp, "Username %s\n", job->username);
1892 cupsFilePrintf(fp, "Destination %s\n", job->dest);
1893 cupsFilePrintf(fp, "DestType %d\n", job->dtype);
1894 cupsFilePrintf(fp, "NumFiles %d\n", job->num_files);
1895 for (i = 0; i < job->num_files; i ++)
1896 cupsFilePrintf(fp, "File %d %s/%s %d\n", i + 1, job->filetypes[i]->super,
1897 job->filetypes[i]->type, job->compressions[i]);
1898 cupsFilePuts(fp, "</Job>\n");
1899 }
1900
1901 cupsFileClose(fp);
1902 }
1903
1904
1905 /*
1906 * 'cupsdSaveJob()' - Save a job to disk.
1907 */
1908
1909 void
1910 cupsdSaveJob(cupsd_job_t *job) /* I - Job */
1911 {
1912 char filename[1024]; /* Job control filename */
1913 cups_file_t *fp; /* Job file */
1914
1915
1916 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
1917 job, job->id, job->attrs);
1918
1919 snprintf(filename, sizeof(filename), "%s/c%05d", RequestRoot, job->id);
1920
1921 if ((fp = cupsFileOpen(filename, "w")) == NULL)
1922 {
1923 cupsdLogMessage(CUPSD_LOG_ERROR,
1924 "[Job %d] Unable to create job control file \"%s\" - %s.",
1925 job->id, filename, strerror(errno));
1926 return;
1927 }
1928
1929 fchmod(cupsFileNumber(fp), 0600);
1930 fchown(cupsFileNumber(fp), RunUser, Group);
1931
1932 job->attrs->state = IPP_IDLE;
1933
1934 if (ippWriteIO(fp, (ipp_iocb_t)cupsFileWrite, 1, NULL,
1935 job->attrs) != IPP_DATA)
1936 cupsdLogMessage(CUPSD_LOG_ERROR,
1937 "[Job %d] Unable to write job control file!", job->id);
1938
1939 cupsFileClose(fp);
1940
1941 job->dirty = 0;
1942 }
1943
1944
1945 /*
1946 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job.
1947 */
1948
1949 void
1950 cupsdSetJobHoldUntil(cupsd_job_t *job, /* I - Job */
1951 const char *when, /* I - When to resume */
1952 int update)/* I - Update job-hold-until attr? */
1953 {
1954 time_t curtime; /* Current time */
1955 struct tm *curdate; /* Current date */
1956 int hour; /* Hold hour */
1957 int minute; /* Hold minute */
1958 int second = 0; /* Hold second */
1959
1960
1961 cupsdLogMessage(CUPSD_LOG_DEBUG2,
1962 "cupsdSetJobHoldUntil(job=%p(%d), when=\"%s\", update=%d)",
1963 job, job->id, when, update);
1964
1965 if (update)
1966 {
1967 /*
1968 * Update the job-hold-until attribute...
1969 */
1970
1971 ipp_attribute_t *attr; /* job-hold-until attribute */
1972
1973 if ((attr = ippFindAttribute(job->attrs, "job-hold-until",
1974 IPP_TAG_KEYWORD)) == NULL)
1975 attr = ippFindAttribute(job->attrs, "job-hold-until", IPP_TAG_NAME);
1976
1977 if (attr)
1978 cupsdSetString(&(attr->values[0].string.text), when);
1979 else
1980 attr = ippAddString(job->attrs, IPP_TAG_JOB, IPP_TAG_KEYWORD,
1981 "job-hold-until", NULL, when);
1982
1983 if (attr)
1984 {
1985 if (isdigit(when[0] & 255))
1986 attr->value_tag = IPP_TAG_NAME;
1987 else
1988 attr->value_tag = IPP_TAG_KEYWORD;
1989
1990 job->dirty = 1;
1991 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
1992 }
1993 }
1994
1995 /*
1996 * Update the hold time...
1997 */
1998
1999 if (!strcmp(when, "indefinite") || !strcmp(when, "auth-info-required"))
2000 {
2001 /*
2002 * Hold indefinitely...
2003 */
2004
2005 job->hold_until = 0;
2006 }
2007 else if (!strcmp(when, "day-time"))
2008 {
2009 /*
2010 * Hold to 6am the next morning unless local time is < 6pm.
2011 */
2012
2013 curtime = time(NULL);
2014 curdate = localtime(&curtime);
2015
2016 if (curdate->tm_hour < 18)
2017 job->hold_until = curtime;
2018 else
2019 job->hold_until = curtime +
2020 ((29 - curdate->tm_hour) * 60 + 59 -
2021 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2022 }
2023 else if (!strcmp(when, "evening") || !strcmp(when, "night"))
2024 {
2025 /*
2026 * Hold to 6pm unless local time is > 6pm or < 6am.
2027 */
2028
2029 curtime = time(NULL);
2030 curdate = localtime(&curtime);
2031
2032 if (curdate->tm_hour < 6 || curdate->tm_hour >= 18)
2033 job->hold_until = curtime;
2034 else
2035 job->hold_until = curtime +
2036 ((17 - curdate->tm_hour) * 60 + 59 -
2037 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2038 }
2039 else if (!strcmp(when, "second-shift"))
2040 {
2041 /*
2042 * Hold to 4pm unless local time is > 4pm.
2043 */
2044
2045 curtime = time(NULL);
2046 curdate = localtime(&curtime);
2047
2048 if (curdate->tm_hour >= 16)
2049 job->hold_until = curtime;
2050 else
2051 job->hold_until = curtime +
2052 ((15 - curdate->tm_hour) * 60 + 59 -
2053 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2054 }
2055 else if (!strcmp(when, "third-shift"))
2056 {
2057 /*
2058 * Hold to 12am unless local time is < 8am.
2059 */
2060
2061 curtime = time(NULL);
2062 curdate = localtime(&curtime);
2063
2064 if (curdate->tm_hour < 8)
2065 job->hold_until = curtime;
2066 else
2067 job->hold_until = curtime +
2068 ((23 - curdate->tm_hour) * 60 + 59 -
2069 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2070 }
2071 else if (!strcmp(when, "weekend"))
2072 {
2073 /*
2074 * Hold to weekend unless we are in the weekend.
2075 */
2076
2077 curtime = time(NULL);
2078 curdate = localtime(&curtime);
2079
2080 if (curdate->tm_wday == 0 || curdate->tm_wday == 6)
2081 job->hold_until = curtime;
2082 else
2083 job->hold_until = curtime +
2084 (((5 - curdate->tm_wday) * 24 +
2085 (17 - curdate->tm_hour)) * 60 + 59 -
2086 curdate->tm_min) * 60 + 60 - curdate->tm_sec;
2087 }
2088 else if (sscanf(when, "%d:%d:%d", &hour, &minute, &second) >= 2)
2089 {
2090 /*
2091 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
2092 */
2093
2094 curtime = time(NULL);
2095 curdate = gmtime(&curtime);
2096
2097 job->hold_until = curtime +
2098 ((hour - curdate->tm_hour) * 60 + minute -
2099 curdate->tm_min) * 60 + second - curdate->tm_sec;
2100
2101 /*
2102 * Hold until next day as needed...
2103 */
2104
2105 if (job->hold_until < curtime)
2106 job->hold_until += 24 * 60 * 60;
2107 }
2108
2109 cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdSetJobHoldUntil: hold_until=%d",
2110 (int)job->hold_until);
2111 }
2112
2113
2114 /*
2115 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
2116 * the list as needed.
2117 */
2118
2119 void
2120 cupsdSetJobPriority(
2121 cupsd_job_t *job, /* I - Job ID */
2122 int priority) /* I - New priority (0 to 100) */
2123 {
2124 ipp_attribute_t *attr; /* Job attribute */
2125
2126
2127 /*
2128 * Don't change completed jobs...
2129 */
2130
2131 if (job->state_value >= IPP_JOB_PROCESSING)
2132 return;
2133
2134 /*
2135 * Set the new priority and re-add the job into the active list...
2136 */
2137
2138 cupsArrayRemove(ActiveJobs, job);
2139
2140 job->priority = priority;
2141
2142 if ((attr = ippFindAttribute(job->attrs, "job-priority",
2143 IPP_TAG_INTEGER)) != NULL)
2144 attr->values[0].integer = priority;
2145 else
2146 ippAddInteger(job->attrs, IPP_TAG_JOB, IPP_TAG_INTEGER, "job-priority",
2147 priority);
2148
2149 cupsArrayAdd(ActiveJobs, job);
2150
2151 job->dirty = 1;
2152 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2153 }
2154
2155
2156 /*
2157 * 'cupsdSetJobState()' - Set the state of the specified print job.
2158 */
2159
2160 void
2161 cupsdSetJobState(
2162 cupsd_job_t *job, /* I - Job to cancel */
2163 ipp_jstate_t newstate, /* I - New job state */
2164 cupsd_jobaction_t action, /* I - Action to take */
2165 const char *message, /* I - Message to log */
2166 ...) /* I - Additional arguments as needed */
2167 {
2168 int i; /* Looping var */
2169 ipp_jstate_t oldstate; /* Old state */
2170 char filename[1024]; /* Job filename */
2171 ipp_attribute_t *attr; /* Job attribute */
2172
2173
2174 cupsdLogMessage(CUPSD_LOG_DEBUG2,
2175 "cupsdSetJobState(job=%p(%d), state=%d, newstate=%d, "
2176 "action=%d, message=\"%s\")", job, job->id, job->state_value,
2177 newstate, action, message ? message : "(null)");
2178
2179
2180 /*
2181 * Make sure we have the job attributes...
2182 */
2183
2184 if (!cupsdLoadJob(job))
2185 return;
2186
2187 /*
2188 * Don't do anything if the state is unchanged...
2189 */
2190
2191 if (newstate == (oldstate = job->state_value))
2192 return;
2193
2194 /*
2195 * Stop any processes that are working on the current job...
2196 */
2197
2198 if (oldstate == IPP_JOB_PROCESSING)
2199 stop_job(job, action != CUPSD_JOB_DEFAULT);
2200
2201 /*
2202 * Set the new job state...
2203 */
2204
2205 job->state->values[0].integer = newstate;
2206 job->state_value = newstate;
2207
2208 switch (newstate)
2209 {
2210 case IPP_JOB_PENDING :
2211 /*
2212 * Update job-hold-until as needed...
2213 */
2214
2215 if ((attr = ippFindAttribute(job->attrs, "job-hold-until",
2216 IPP_TAG_KEYWORD)) == NULL)
2217 attr = ippFindAttribute(job->attrs, "job-hold-until", IPP_TAG_NAME);
2218
2219 if (attr)
2220 {
2221 attr->value_tag = IPP_TAG_KEYWORD;
2222 cupsdSetString(&(attr->values[0].string.text), "no-hold");
2223 }
2224
2225 default :
2226 break;
2227
2228 case IPP_JOB_ABORTED :
2229 case IPP_JOB_CANCELED :
2230 case IPP_JOB_COMPLETED :
2231 set_time(job, "time-at-completed");
2232 break;
2233 }
2234
2235 /*
2236 * Log message as needed...
2237 */
2238
2239 if (message)
2240 {
2241 char buffer[2048]; /* Message buffer */
2242 va_list ap; /* Pointer to additional arguments */
2243
2244 va_start(ap, message);
2245 vsnprintf(buffer, sizeof(buffer), message, ap);
2246 va_end(ap);
2247
2248 if (newstate > IPP_JOB_STOPPED)
2249 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED, job->printer, job, "%s", buffer);
2250 else
2251 cupsdAddEvent(CUPSD_EVENT_JOB_STATE, job->printer, job, "%s", buffer);
2252
2253 if (newstate == IPP_JOB_STOPPED || newstate == IPP_JOB_ABORTED)
2254 cupsdLogJob(job, CUPSD_LOG_ERROR, "%s", buffer);
2255 else
2256 cupsdLogJob(job, CUPSD_LOG_INFO, "%s", buffer);
2257 }
2258
2259 /*
2260 * Handle post-state-change actions...
2261 */
2262
2263 switch (newstate)
2264 {
2265 case IPP_JOB_PROCESSING :
2266 /*
2267 * Add the job to the "printing" list...
2268 */
2269
2270 if (!cupsArrayFind(PrintingJobs, job))
2271 cupsArrayAdd(PrintingJobs, job);
2272
2273 /*
2274 * Set the processing time...
2275 */
2276
2277 set_time(job, "time-at-processing");
2278
2279 case IPP_JOB_PENDING :
2280 case IPP_JOB_HELD :
2281 case IPP_JOB_STOPPED :
2282 /*
2283 * Make sure the job is in the active list...
2284 */
2285
2286 if (!cupsArrayFind(ActiveJobs, job))
2287 cupsArrayAdd(ActiveJobs, job);
2288
2289 /*
2290 * Save the job state to disk...
2291 */
2292
2293 job->dirty = 1;
2294 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2295 break;
2296
2297 case IPP_JOB_ABORTED :
2298 case IPP_JOB_CANCELED :
2299 case IPP_JOB_COMPLETED :
2300 if (newstate == IPP_JOB_CANCELED)
2301 {
2302 /*
2303 * Remove the job from the active list if there are no processes still
2304 * running for it...
2305 */
2306
2307 for (i = 0; job->filters[i] < 0; i++);
2308
2309 if (!job->filters[i] && job->backend <= 0)
2310 cupsArrayRemove(ActiveJobs, job);
2311 }
2312 else
2313 {
2314 /*
2315 * Otherwise just remove the job from the active list immediately...
2316 */
2317
2318 cupsArrayRemove(ActiveJobs, job);
2319 }
2320
2321 /*
2322 * Expire job subscriptions since the job is now "completed"...
2323 */
2324
2325 cupsdExpireSubscriptions(NULL, job);
2326
2327 #ifdef __APPLE__
2328 /*
2329 * If we are going to sleep and the PrintingJobs count is now 0, allow the
2330 * sleep to happen immediately...
2331 */
2332
2333 if (Sleeping && cupsArrayCount(PrintingJobs) == 0)
2334 cupsdAllowSleep();
2335 #endif /* __APPLE__ */
2336
2337 /*
2338 * Remove any authentication data...
2339 */
2340
2341 snprintf(filename, sizeof(filename), "%s/a%05d", RequestRoot, job->id);
2342 if (cupsdRemoveFile(filename) && errno != ENOENT)
2343 cupsdLogMessage(CUPSD_LOG_ERROR,
2344 "Unable to remove authentication cache: %s",
2345 strerror(errno));
2346
2347 cupsdClearString(&job->auth_username);
2348 cupsdClearString(&job->auth_domain);
2349 cupsdClearString(&job->auth_password);
2350
2351 #ifdef HAVE_GSSAPI
2352 /*
2353 * Destroy the credential cache and clear the KRB5CCNAME env var string.
2354 */
2355
2356 if (job->ccache)
2357 {
2358 krb5_cc_destroy(KerberosContext, job->ccache);
2359 job->ccache = NULL;
2360 }
2361
2362 cupsdClearString(&job->ccname);
2363 #endif /* HAVE_GSSAPI */
2364
2365 /*
2366 * Remove the print file for good if we aren't preserving jobs or
2367 * files...
2368 */
2369
2370 if (!JobHistory || !JobFiles || action == CUPSD_JOB_PURGE)
2371 {
2372 for (i = 1; i <= job->num_files; i ++)
2373 {
2374 snprintf(filename, sizeof(filename), "%s/d%05d-%03d", RequestRoot,
2375 job->id, i);
2376 unlink(filename);
2377 }
2378
2379 if (job->num_files > 0)
2380 {
2381 free(job->filetypes);
2382 free(job->compressions);
2383
2384 job->num_files = 0;
2385 job->filetypes = NULL;
2386 job->compressions = NULL;
2387 }
2388 }
2389
2390 if (JobHistory && action != CUPSD_JOB_PURGE)
2391 {
2392 /*
2393 * Save job state info...
2394 */
2395
2396 job->dirty = 1;
2397 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
2398 }
2399 else if (!job->printer)
2400 cupsdDeleteJob(job, CUPSD_JOB_PURGE);
2401 break;
2402 }
2403
2404 /*
2405 * Finalize the job immediately if we forced things...
2406 */
2407
2408 if (action == CUPSD_JOB_FORCE)
2409 finalize_job(job);
2410
2411 /*
2412 * Update the server "busy" state...
2413 */
2414
2415 cupsdSetBusyState();
2416 }
2417
2418
2419 /*
2420 * 'cupsdStopAllJobs()' - Stop all print jobs.
2421 */
2422
2423 void
2424 cupsdStopAllJobs(
2425 cupsd_jobaction_t action, /* I - Action */
2426 int kill_delay) /* I - Number of seconds before we kill */
2427 {
2428 cupsd_job_t *job; /* Current job */
2429
2430
2431 DEBUG_puts("cupsdStopAllJobs()");
2432
2433 for (job = (cupsd_job_t *)cupsArrayFirst(PrintingJobs);
2434 job;
2435 job = (cupsd_job_t *)cupsArrayNext(PrintingJobs))
2436 {
2437 if (kill_delay)
2438 job->kill_time = time(NULL) + kill_delay;
2439
2440 cupsdSetJobState(job, IPP_JOB_PENDING, action, NULL);
2441 }
2442 }
2443
2444
2445 /*
2446 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
2447 */
2448
2449 void
2450 cupsdUnloadCompletedJobs(void)
2451 {
2452 cupsd_job_t *job; /* Current job */
2453 time_t expire; /* Expiration time */
2454
2455
2456 expire = time(NULL) - 60;
2457
2458 for (job = (cupsd_job_t *)cupsArrayFirst(Jobs);
2459 job;
2460 job = (cupsd_job_t *)cupsArrayNext(Jobs))
2461 if (job->attrs && job->state_value >= IPP_JOB_STOPPED && !job->printer &&
2462 job->access_time < expire)
2463 {
2464 if (job->dirty)
2465 cupsdSaveJob(job);
2466
2467 unload_job(job);
2468 }
2469 }
2470
2471
2472 /*
2473 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
2474 */
2475
2476 static int /* O - Difference */
2477 compare_active_jobs(void *first, /* I - First job */
2478 void *second, /* I - Second job */
2479 void *data) /* I - App data (not used) */
2480 {
2481 int diff; /* Difference */
2482
2483
2484 if ((diff = ((cupsd_job_t *)second)->priority -
2485 ((cupsd_job_t *)first)->priority) != 0)
2486 return (diff);
2487 else
2488 return (((cupsd_job_t *)first)->id - ((cupsd_job_t *)second)->id);
2489 }
2490
2491
2492 /*
2493 * 'compare_jobs()' - Compare the job IDs of two jobs.
2494 */
2495
2496 static int /* O - Difference */
2497 compare_jobs(void *first, /* I - First job */
2498 void *second, /* I - Second job */
2499 void *data) /* I - App data (not used) */
2500 {
2501 return (((cupsd_job_t *)first)->id - ((cupsd_job_t *)second)->id);
2502 }
2503
2504
2505 /*
2506 * 'dump_job_history()' - Dump any debug messages for a job.
2507 */
2508
2509 static void
2510 dump_job_history(cupsd_job_t *job) /* I - Job */
2511 {
2512 int i, /* Looping var */
2513 oldsize; /* Current MaxLogSize */
2514 struct tm *date; /* Date/time value */
2515 cupsd_joblog_t *message; /* Current message */
2516 char temp[2048], /* Log message */
2517 *ptr, /* Pointer into log message */
2518 start[256], /* Start time */
2519 end[256]; /* End time */
2520 cupsd_printer_t *printer; /* Printer for job */
2521
2522
2523 /*
2524 * See if we have anything to dump...
2525 */
2526
2527 if (!job->history)
2528 return;
2529
2530 /*
2531 * Disable log rotation temporarily...
2532 */
2533
2534 oldsize = MaxLogSize;
2535 MaxLogSize = 0;
2536
2537 /*
2538 * Copy the debug messages to the log...
2539 */
2540
2541 message = (cupsd_joblog_t *)cupsArrayFirst(job->history);
2542 date = localtime(&(message->time));
2543 strftime(start, sizeof(start), "%X", date);
2544
2545 message = (cupsd_joblog_t *)cupsArrayLast(job->history);
2546 date = localtime(&(message->time));
2547 strftime(end, sizeof(end), "%X", date);
2548
2549 snprintf(temp, sizeof(temp),
2550 "[Job %d] The following messages were recorded from %s to %s",
2551 job->id, start, end);
2552 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2553
2554 for (message = (cupsd_joblog_t *)cupsArrayFirst(job->history);
2555 message;
2556 message = (cupsd_joblog_t *)cupsArrayNext(job->history))
2557 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, message->message);
2558
2559 snprintf(temp, sizeof(temp), "[Job %d] End of messages", job->id);
2560 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2561
2562 /*
2563 * Log the printer state values...
2564 */
2565
2566 if ((printer = job->printer) == NULL)
2567 printer = cupsdFindDest(job->dest);
2568
2569 if (printer)
2570 {
2571 snprintf(temp, sizeof(temp), "[Job %d] printer-state=%d(%s)", job->id,
2572 printer->state,
2573 printer->state == IPP_PRINTER_IDLE ? "idle" :
2574 printer->state == IPP_PRINTER_PROCESSING ? "processing" :
2575 "stopped");
2576 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2577
2578 snprintf(temp, sizeof(temp), "[Job %d] printer-state-message=\"%s\"",
2579 job->id, printer->state_message);
2580 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2581
2582 snprintf(temp, sizeof(temp), "[Job %d] printer-state-reasons=", job->id);
2583 ptr = temp + strlen(temp);
2584 if (printer->num_reasons == 0)
2585 strlcpy(ptr, "none", sizeof(temp) - (ptr - temp));
2586 else
2587 {
2588 for (i = 0;
2589 i < printer->num_reasons && ptr < (temp + sizeof(temp) - 2);
2590 i ++)
2591 {
2592 if (i)
2593 *ptr++ = ',';
2594
2595 strlcpy(ptr, printer->reasons[i], sizeof(temp) - (ptr - temp));
2596 ptr += strlen(ptr);
2597 }
2598 }
2599 cupsdWriteErrorLog(CUPSD_LOG_DEBUG, temp);
2600 }
2601
2602 /*
2603 * Restore log file rotation...
2604 */
2605
2606 MaxLogSize = oldsize;
2607
2608 /*
2609 * Free all messages...
2610 */
2611
2612 free_job_history(job);
2613 }
2614
2615
2616 /*
2617 * 'free_job_history()' - Free any log history.
2618 */
2619
2620 static void
2621 free_job_history(cupsd_job_t *job) /* I - Job */
2622 {
2623 char *message; /* Current message */
2624
2625
2626 if (!job->history)
2627 return;
2628
2629 for (message = (char *)cupsArrayFirst(job->history);
2630 message;
2631 message = (char *)cupsArrayNext(job->history))
2632 free(message);
2633
2634 cupsArrayDelete(job->history);
2635 job->history = NULL;
2636 }
2637
2638
2639 /*
2640 * 'finalize_job()' - Cleanup after job filter processes and support data.
2641 */
2642
2643 static void
2644 finalize_job(cupsd_job_t *job) /* I - Job */
2645 {
2646 ipp_pstate_t printer_state; /* New printer state value */
2647 ipp_jstate_t job_state; /* New job state value */
2648 const char *message; /* Message for job state */
2649 char buffer[1024]; /* Buffer for formatted messages */
2650
2651
2652 cupsdLogMessage(CUPSD_LOG_DEBUG2, "finalize_job(job=%p(%d))", job, job->id);
2653
2654 /*
2655 * Clear the "connecting-to-device" reason, which is only valid when a printer
2656 * is processing...
2657 */
2658
2659 cupsdSetPrinterReasons(job->printer, "-connecting-to-device");
2660
2661 /*
2662 * Similarly, clear the "offline-report" reason for non-USB devices since we
2663 * rarely have current information for network devices...
2664 */
2665
2666 if (strncmp(job->printer->device_uri, "usb:", 4))
2667 cupsdSetPrinterReasons(job->printer, "-offline-report");
2668
2669 /*
2670 * Free the security profile...
2671 */
2672
2673 cupsdDestroyProfile(job->profile);
2674 job->profile = NULL;
2675
2676 /*
2677 * Close pipes and status buffer...
2678 */
2679
2680 cupsdClosePipe(job->print_pipes);
2681 cupsdClosePipe(job->back_pipes);
2682 cupsdClosePipe(job->side_pipes);
2683
2684 cupsdRemoveSelect(job->status_pipes[0]);
2685 cupsdClosePipe(job->status_pipes);
2686 cupsdStatBufDelete(job->status_buffer);
2687 job->status_buffer = NULL;
2688
2689 /*
2690 * Process the exit status...
2691 */
2692
2693 if (job->printer->state == IPP_PRINTER_PROCESSING)
2694 printer_state = IPP_PRINTER_IDLE;
2695 else
2696 printer_state = job->printer->state;
2697
2698 switch (job_state = job->state_value)
2699 {
2700 case IPP_JOB_PENDING :
2701 message = "Job paused.";
2702 break;
2703
2704 case IPP_JOB_HELD :
2705 message = "Job held.";
2706 break;
2707
2708 default :
2709 case IPP_JOB_PROCESSING :
2710 case IPP_JOB_COMPLETED :
2711 job_state = IPP_JOB_COMPLETED;
2712 message = "Job completed.";
2713 break;
2714
2715 case IPP_JOB_STOPPED :
2716 message = "Job stopped.";
2717 break;
2718
2719 case IPP_JOB_CANCELED :
2720 message = "Job canceled.";
2721 break;
2722
2723 case IPP_JOB_ABORTED :
2724 message = "Job aborted.";
2725 break;
2726 }
2727
2728 if (job->status < 0)
2729 {
2730 /*
2731 * Backend had errors...
2732 */
2733
2734 int exit_code; /* Exit code from backend */
2735
2736
2737 /*
2738 * Convert the status to an exit code. Due to the way the W* macros are
2739 * implemented on MacOS X (bug?), we have to store the exit status in a
2740 * variable first and then convert...
2741 */
2742
2743 exit_code = -job->status;
2744 if (WIFEXITED(exit_code))
2745 exit_code = WEXITSTATUS(exit_code);
2746 else
2747 exit_code = job->status;
2748
2749 cupsdLogJob(job, CUPSD_LOG_INFO, "Backend returned status %d (%s)",
2750 exit_code,
2751 exit_code == CUPS_BACKEND_FAILED ? "failed" :
2752 exit_code == CUPS_BACKEND_AUTH_REQUIRED ?
2753 "authentication required" :
2754 exit_code == CUPS_BACKEND_HOLD ? "hold job" :
2755 exit_code == CUPS_BACKEND_STOP ? "stop printer" :
2756 exit_code == CUPS_BACKEND_CANCEL ? "cancel job" :
2757 exit_code < 0 ? "crashed" : "unknown");
2758
2759 /*
2760 * Do what needs to be done...
2761 */
2762
2763 switch (exit_code)
2764 {
2765 default :
2766 case CUPS_BACKEND_FAILED :
2767 /*
2768 * Backend failure, use the error-policy to determine how to
2769 * act...
2770 */
2771
2772 if (job->dtype & (CUPS_PRINTER_CLASS | CUPS_PRINTER_IMPLICIT))
2773 {
2774 /*
2775 * Queued on a class - mark the job as pending and we'll retry on
2776 * another printer...
2777 */
2778
2779 if (job_state == IPP_JOB_COMPLETED)
2780 {
2781 job_state = IPP_JOB_PENDING;
2782 message = "Retrying job on another printer.";
2783 }
2784 }
2785 else if (!strcmp(job->printer->error_policy, "retry-current-job"))
2786 {
2787 /*
2788 * The error policy is "retry-current-job" - mark the job as pending
2789 * and we'll retry on the same printer...
2790 */
2791
2792 if (job_state == IPP_JOB_COMPLETED)
2793 {
2794 job_state = IPP_JOB_PENDING;
2795 message = "Retrying job on same printer.";
2796 }
2797 }
2798 else if ((job->printer->type & CUPS_PRINTER_FAX) ||
2799 !strcmp(job->printer->error_policy, "retry-job"))
2800 {
2801 if (job_state == IPP_JOB_COMPLETED)
2802 {
2803 /*
2804 * The job was queued on a fax or the error policy is "retry-job" -
2805 * hold the job if the number of retries is less than the
2806 * JobRetryLimit, otherwise abort the job.
2807 */
2808
2809 job->tries ++;
2810
2811 if (job->tries >= JobRetryLimit)
2812 {
2813 /*
2814 * Too many tries...
2815 */
2816
2817 snprintf(buffer, sizeof(buffer),
2818 "Job aborted after %d unsuccessful attempts.",
2819 JobRetryLimit);
2820 job_state = IPP_JOB_ABORTED;
2821 message = buffer;
2822 }
2823 else
2824 {
2825 /*
2826 * Try again in N seconds...
2827 */
2828
2829 set_hold_until(job, time(NULL) + JobRetryInterval);
2830
2831 snprintf(buffer, sizeof(buffer),
2832 "Job held for %d seconds since it could not be sent.",
2833 JobRetryInterval);
2834 job_state = IPP_JOB_HELD;
2835 message = buffer;
2836 }
2837 }
2838 }
2839 else if (!strcmp(job->printer->error_policy, "abort-job") &&
2840 job_state == IPP_JOB_COMPLETED)
2841 {
2842 job_state = IPP_JOB_ABORTED;
2843 message = "Job aborted due to backend errors; please consult "
2844 "the error_log file for details.";
2845 }
2846 else if (job->state_value == IPP_JOB_PROCESSING)
2847 {
2848 job_state = IPP_JOB_PENDING;
2849 printer_state = IPP_PRINTER_STOPPED;
2850 message = "Printer stopped due to backend errors; please "
2851 "consult the error_log file for details.";
2852 }
2853 break;
2854
2855 case CUPS_BACKEND_CANCEL :
2856 /*
2857 * Abort the job...
2858 */
2859
2860 if (job_state == IPP_JOB_COMPLETED)
2861 {
2862 job_state = IPP_JOB_ABORTED;
2863 message = "Job aborted due to backend errors; please consult "
2864 "the error_log file for details.";
2865 }
2866 break;
2867
2868 case CUPS_BACKEND_HOLD :
2869 if (job_state == IPP_JOB_COMPLETED)
2870 {
2871 /*
2872 * Hold the job...
2873 */
2874
2875 cupsdSetJobHoldUntil(job, "indefinite", 1);
2876
2877 job_state = IPP_JOB_HELD;
2878 message = "Job held indefinitely due to backend errors; please "
2879 "consult the error_log file for details.";
2880 }
2881 break;
2882
2883 case CUPS_BACKEND_STOP :
2884 /*
2885 * Stop the printer...
2886 */
2887
2888 printer_state = IPP_PRINTER_STOPPED;
2889 message = "Printer stopped due to backend errors; please "
2890 "consult the error_log file for details.";
2891
2892 if (job_state == IPP_JOB_COMPLETED)
2893 job_state = IPP_JOB_PENDING;
2894 break;
2895
2896 case CUPS_BACKEND_AUTH_REQUIRED :
2897 /*
2898 * Hold the job for authentication...
2899 */
2900
2901 if (job_state == IPP_JOB_COMPLETED)
2902 {
2903 cupsdSetJobHoldUntil(job, "auth-info-required", 1);
2904
2905 job_state = IPP_JOB_HELD;
2906 message = "Job held for authentication.";
2907 }
2908 break;
2909 }
2910 }
2911 else if (job->status > 0)
2912 {
2913 /*
2914 * Filter had errors; stop job...
2915 */
2916
2917 if (job_state == IPP_JOB_COMPLETED)
2918 {
2919 job_state = IPP_JOB_STOPPED;
2920 message = "Job stopped due to filter errors; please consult the "
2921 "error_log file for details.";
2922 }
2923 }
2924
2925 /*
2926 * Update the printer and job state.
2927 */
2928
2929 cupsdSetJobState(job, job_state, CUPSD_JOB_DEFAULT, "%s", message);
2930 cupsdSetPrinterState(job->printer, printer_state,
2931 printer_state == IPP_PRINTER_STOPPED);
2932 update_job_attrs(job, 0);
2933
2934 if (job->history)
2935 {
2936 if (job->status)
2937 dump_job_history(job);
2938 else
2939 free_job_history(job);
2940 }
2941
2942 cupsArrayRemove(PrintingJobs, job);
2943
2944 /*
2945 * Clear the printer <-> job association...
2946 */
2947
2948 job->printer->job = NULL;
2949 job->printer = NULL;
2950
2951 /*
2952 * Try printing another job...
2953 */
2954
2955 if (printer_state != IPP_PRINTER_STOPPED)
2956 cupsdCheckJobs();
2957 }
2958
2959
2960 /*
2961 * 'get_options()' - Get a string containing the job options.
2962 */
2963
2964 static char * /* O - Options string */
2965 get_options(cupsd_job_t *job, /* I - Job */
2966 int banner_page, /* I - Printing a banner page? */
2967 char *copies, /* I - Copies buffer */
2968 size_t copies_size, /* I - Size of copies buffer */
2969 char *title, /* I - Title buffer */
2970 size_t title_size) /* I - Size of title buffer */
2971 {
2972 int i; /* Looping var */
2973 char *optptr, /* Pointer to options */
2974 *valptr; /* Pointer in value string */
2975 ipp_attribute_t *attr; /* Current attribute */
2976 static char *options = NULL;/* Full list of options */
2977 static int optlength = 0; /* Length of option buffer */
2978
2979
2980 /*
2981 * Building the options string is harder than it needs to be, but
2982 * for the moment we need to pass strings for command-line args and
2983 * not IPP attribute pointers... :)
2984 *
2985 * First allocate/reallocate the option buffer as needed...
2986 */
2987
2988 i = ipp_length(job->attrs);
2989
2990 if (i > optlength || !options)
2991 {
2992 if (!options)
2993 optptr = malloc(i);
2994 else
2995 optptr = realloc(options, i);
2996
2997 if (!optptr)
2998 {
2999 cupsdLogJob(job, CUPSD_LOG_CRIT,
3000 "Unable to allocate %d bytes for option buffer!", i);
3001 return (NULL);
3002 }
3003
3004 options = optptr;
3005 optlength = i;
3006 }
3007
3008 /*
3009 * Now loop through the attributes and convert them to the textual
3010 * representation used by the filters...
3011 */
3012
3013 optptr = options;
3014 *optptr = '\0';
3015
3016 snprintf(title, title_size, "%s-%d", job->printer->name, job->id);
3017 strlcpy(copies, "1", copies_size);
3018
3019 for (attr = job->attrs->attrs; attr != NULL; attr = attr->next)
3020 {
3021 if (!strcmp(attr->name, "copies") &&
3022 attr->value_tag == IPP_TAG_INTEGER)
3023 {
3024 /*
3025 * Don't use the # copies attribute if we are printing the job sheets...
3026 */
3027
3028 if (!banner_page)
3029 snprintf(copies, copies_size, "%d", attr->values[0].integer);
3030 }
3031 else if (!strcmp(attr->name, "job-name") &&
3032 (attr->value_tag == IPP_TAG_NAME ||
3033 attr->value_tag == IPP_TAG_NAMELANG))
3034 strlcpy(title, attr->values[0].string.text, title_size);
3035 else if (attr->group_tag == IPP_TAG_JOB)
3036 {
3037 /*
3038 * Filter out other unwanted attributes...
3039 */
3040
3041 if (attr->value_tag == IPP_TAG_MIMETYPE ||
3042 attr->value_tag == IPP_TAG_NAMELANG ||
3043 attr->value_tag == IPP_TAG_TEXTLANG ||
3044 (attr->value_tag == IPP_TAG_URI && strcmp(attr->name, "job-uuid")) ||
3045 attr->value_tag == IPP_TAG_URISCHEME ||
3046 attr->value_tag == IPP_TAG_BEGIN_COLLECTION) /* Not yet supported */
3047 continue;
3048
3049 if (!strncmp(attr->name, "time-", 5) ||
3050 !strcmp(attr->name, "job-hold-until"))
3051 continue;
3052
3053 if (!strncmp(attr->name, "job-", 4) &&
3054 strcmp(attr->name, "job-billing") &&
3055 strcmp(attr->name, "job-impressions") &&
3056 strcmp(attr->name, "job-originating-host-name") &&
3057 strcmp(attr->name, "job-uuid") &&
3058 !(job->printer->type & CUPS_PRINTER_REMOTE))
3059 continue;
3060
3061 if ((!strcmp(attr->name, "job-impressions") ||
3062 !strcmp(attr->name, "page-label") ||
3063 !strcmp(attr->name, "page-border") ||
3064 !strncmp(attr->name, "number-up", 9) ||
3065 !strcmp(attr->name, "page-ranges") ||
3066 !strcmp(attr->name, "page-set") ||
3067 !strcasecmp(attr->name, "AP_FIRSTPAGE_InputSlot") ||
3068 !strcasecmp(attr->name, "AP_FIRSTPAGE_ManualFeed") ||
3069 !strcasecmp(attr->name, "com.apple.print.PrintSettings."
3070 "PMTotalSidesImaged..n.") ||
3071 !strcasecmp(attr->name, "com.apple.print.PrintSettings."
3072 "PMTotalBeginPages..n.")) &&
3073 banner_page)
3074 continue;
3075
3076 /*
3077 * Otherwise add them to the list...
3078 */
3079
3080 if (optptr > options)
3081 strlcat(optptr, " ", optlength - (optptr - options));
3082
3083 if (attr->value_tag != IPP_TAG_BOOLEAN)
3084 {
3085 strlcat(optptr, attr->name, optlength - (optptr - options));
3086 strlcat(optptr, "=", optlength - (optptr - options));
3087 }
3088
3089 for (i = 0; i < attr->num_values; i ++)
3090 {
3091 if (i)
3092 strlcat(optptr, ",", optlength - (optptr - options));
3093
3094 optptr += strlen(optptr);
3095
3096 switch (attr->value_tag)
3097 {
3098 case IPP_TAG_INTEGER :
3099 case IPP_TAG_ENUM :
3100 snprintf(optptr, optlength - (optptr - options),
3101 "%d", attr->values[i].integer);
3102 break;
3103
3104 case IPP_TAG_BOOLEAN :
3105 if (!attr->values[i].boolean)
3106 strlcat(optptr, "no", optlength - (optptr - options));
3107
3108 case IPP_TAG_NOVALUE :
3109 strlcat(optptr, attr->name,
3110 optlength - (optptr - options));
3111 break;
3112
3113 case IPP_TAG_RANGE :
3114 if (attr->values[i].range.lower == attr->values[i].range.upper)
3115 snprintf(optptr, optlength - (optptr - options) - 1,
3116 "%d", attr->values[i].range.lower);
3117 else
3118 snprintf(optptr, optlength - (optptr - options) - 1,
3119 "%d-%d", attr->values[i].range.lower,
3120 attr->values[i].range.upper);
3121 break;
3122
3123 case IPP_TAG_RESOLUTION :
3124 snprintf(optptr, optlength - (optptr - options) - 1,
3125 "%dx%d%s", attr->values[i].resolution.xres,
3126 attr->values[i].resolution.yres,
3127 attr->values[i].resolution.units == IPP_RES_PER_INCH ?
3128 "dpi" : "dpc");
3129 break;
3130
3131 case IPP_TAG_STRING :
3132 case IPP_TAG_TEXT :
3133 case IPP_TAG_NAME :
3134 case IPP_TAG_KEYWORD :
3135 case IPP_TAG_CHARSET :
3136 case IPP_TAG_LANGUAGE :
3137 case IPP_TAG_URI :
3138 for (valptr = attr->values[i].string.text; *valptr;)
3139 {
3140 if (strchr(" \t\n\\\'\"", *valptr))
3141 *optptr++ = '\\';
3142 *optptr++ = *valptr++;
3143 }
3144
3145 *optptr = '\0';
3146 break;
3147
3148 default :
3149 break; /* anti-compiler-warning-code */
3150 }
3151 }
3152
3153 optptr += strlen(optptr);
3154 }
3155 }
3156
3157
3158 return (options);
3159 }
3160
3161
3162 /*
3163 * 'ipp_length()' - Compute the size of the buffer needed to hold
3164 * the textual IPP attributes.
3165 */
3166
3167 static int /* O - Size of attribute buffer */
3168 ipp_length(ipp_t *ipp) /* I - IPP request */
3169 {
3170 int bytes; /* Number of bytes */
3171 int i; /* Looping var */
3172 ipp_attribute_t *attr; /* Current attribute */
3173
3174
3175 /*
3176 * Loop through all attributes...
3177 */
3178
3179 bytes = 0;
3180
3181 for (attr = ipp->attrs; attr != NULL; attr = attr->next)
3182 {
3183 /*
3184 * Skip attributes that won't be sent to filters...
3185 */
3186
3187 if (attr->value_tag == IPP_TAG_MIMETYPE ||
3188 attr->value_tag == IPP_TAG_NAMELANG ||
3189 attr->value_tag == IPP_TAG_TEXTLANG ||
3190 attr->value_tag == IPP_TAG_URI ||
3191 attr->value_tag == IPP_TAG_URISCHEME)
3192 continue;
3193
3194 if (strncmp(attr->name, "time-", 5) == 0)
3195 continue;
3196
3197 /*
3198 * Add space for a leading space and commas between each value.
3199 * For the first attribute, the leading space isn't used, so the
3200 * extra byte can be used as the nul terminator...
3201 */
3202
3203 bytes ++; /* " " separator */
3204 bytes += attr->num_values; /* "," separators */
3205
3206 /*
3207 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
3208 * other attributes appear as "foo=value1,value2,...,valueN".
3209 */
3210
3211 if (attr->value_tag != IPP_TAG_BOOLEAN)
3212 bytes += strlen(attr->name);
3213 else
3214 bytes += attr->num_values * strlen(attr->name);
3215
3216 /*
3217 * Now add the size required for each value in the attribute...
3218 */
3219
3220 switch (attr->value_tag)
3221 {
3222 case IPP_TAG_INTEGER :
3223 case IPP_TAG_ENUM :
3224 /*
3225 * Minimum value of a signed integer is -2147483647, or 11 digits.
3226 */
3227
3228 bytes += attr->num_values * 11;
3229 break;
3230
3231 case IPP_TAG_BOOLEAN :
3232 /*
3233 * Add two bytes for each false ("no") value...
3234 */
3235
3236 for (i = 0; i < attr->num_values; i ++)
3237 if (!attr->values[i].boolean)
3238 bytes += 2;
3239 break;
3240
3241 case IPP_TAG_RANGE :
3242 /*
3243 * A range is two signed integers separated by a hyphen, or
3244 * 23 characters max.
3245 */
3246
3247 bytes += attr->num_values * 23;
3248 break;
3249
3250 case IPP_TAG_RESOLUTION :
3251 /*
3252 * A resolution is two signed integers separated by an "x" and
3253 * suffixed by the units, or 26 characters max.
3254 */
3255
3256 bytes += attr->num_values * 26;
3257 break;
3258
3259 case IPP_TAG_STRING :
3260 case IPP_TAG_TEXT :
3261 case IPP_TAG_NAME :
3262 case IPP_TAG_KEYWORD :
3263 case IPP_TAG_CHARSET :
3264 case IPP_TAG_LANGUAGE :
3265 case IPP_TAG_URI :
3266 /*
3267 * Strings can contain characters that need quoting. We need
3268 * at least 2 * len + 2 characters to cover the quotes and
3269 * any backslashes in the string.
3270 */
3271
3272 for (i = 0; i < attr->num_values; i ++)
3273 bytes += 2 * strlen(attr->values[i].string.text) + 2;
3274 break;
3275
3276 default :
3277 break; /* anti-compiler-warning-code */
3278 }
3279 }
3280
3281 return (bytes);
3282 }
3283
3284
3285 /*
3286 * 'load_job_cache()' - Load jobs from the job.cache file.
3287 */
3288
3289 static void
3290 load_job_cache(const char *filename) /* I - job.cache filename */
3291 {
3292 cups_file_t *fp; /* job.cache file */
3293 char line[1024], /* Line buffer */
3294 *value; /* Value on line */
3295 int linenum; /* Line number in file */
3296 cupsd_job_t *job; /* Current job */
3297 int jobid; /* Job ID */
3298 char jobfile[1024]; /* Job filename */
3299
3300
3301 /*
3302 * Open the job.cache file...
3303 */
3304
3305 if ((fp = cupsFileOpen(filename, "r")) == NULL)
3306 {
3307 if (errno != ENOENT)
3308 cupsdLogMessage(CUPSD_LOG_ERROR,
3309 "Unable to open job cache file \"%s\": %s",
3310 filename, strerror(errno));
3311
3312 load_request_root();
3313
3314 return;
3315 }
3316
3317 /*
3318 * Read entries from the job cache file and create jobs as needed.
3319 */
3320
3321 cupsdLogMessage(CUPSD_LOG_INFO, "Loading job cache file \"%s\"...",
3322 filename);
3323
3324 linenum = 0;
3325 job = NULL;
3326
3327 while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
3328 {
3329 if (!strcasecmp(line, "NextJobId"))
3330 {
3331 if (value)
3332 NextJobId = atoi(value);
3333 }
3334 else if (!strcasecmp(line, "<Job"))
3335 {
3336 if (job)
3337 {
3338 cupsdLogMessage(CUPSD_LOG_ERROR, "Missing </Job> directive on line %d!",
3339 linenum);
3340 continue;
3341 }
3342
3343 if (!value)
3344 {
3345 cupsdLogMessage(CUPSD_LOG_ERROR, "Missing job ID on line %d!", linenum);
3346 continue;
3347 }
3348
3349 jobid = atoi(value);
3350
3351 if (jobid < 1)
3352 {
3353 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad job ID %d on line %d!", jobid,
3354 linenum);
3355 continue;
3356 }
3357
3358 snprintf(jobfile, sizeof(jobfile), "%s/c%05d", RequestRoot, jobid);
3359 if (access(jobfile, 0))
3360 {
3361 cupsdLogMessage(CUPSD_LOG_ERROR, "[Job %d] Files have gone away!",
3362 jobid);
3363 continue;
3364 }
3365
3366 job = calloc(1, sizeof(cupsd_job_t));
3367 if (!job)
3368 {
3369 cupsdLogMessage(CUPSD_LOG_EMERG,
3370 "[Job %d] Unable to allocate memory for job!", jobid);
3371 break;
3372 }
3373
3374 job->id = jobid;
3375 job->back_pipes[0] = -1;
3376 job->back_pipes[1] = -1;
3377 job->print_pipes[0] = -1;
3378 job->print_pipes[1] = -1;
3379 job->side_pipes[0] = -1;
3380 job->side_pipes[1] = -1;
3381 job->status_pipes[0] = -1;
3382 job->status_pipes[1] = -1;
3383
3384 cupsdLogMessage(CUPSD_LOG_DEBUG, "[Job %d] Loading from cache...",
3385 job->id);
3386 }
3387 else if (!job)
3388 {
3389 cupsdLogMessage(CUPSD_LOG_ERROR,
3390 "Missing <Job #> directive on line %d!", linenum);
3391 continue;
3392 }
3393 else if (!strcasecmp(line, "</Job>"))
3394 {
3395 cupsArrayAdd(Jobs, job);
3396
3397 if (job->state_value <= IPP_JOB_STOPPED && cupsdLoadJob(job))
3398 cupsArrayAdd(ActiveJobs, job);
3399
3400 job = NULL;
3401 }
3402 else if (!value)
3403 {
3404 cupsdLogMessage(CUPSD_LOG_ERROR, "Missing value on line %d!", linenum);
3405 continue;
3406 }
3407 else if (!strcasecmp(line, "State"))
3408 {
3409 job->state_value = (ipp_jstate_t)atoi(value);
3410
3411 if (job->state_value < IPP_JOB_PENDING)
3412 job->state_value = IPP_JOB_PENDING;
3413 else if (job->state_value > IPP_JOB_COMPLETED)
3414 job->state_value = IPP_JOB_COMPLETED;
3415 }
3416 else if (!strcasecmp(line, "HoldUntil"))
3417 {
3418 job->hold_until = atoi(value);
3419 }
3420 else if (!strcasecmp(line, "Priority"))
3421 {
3422 job->priority = atoi(value);
3423 }
3424 else if (!strcasecmp(line, "Username"))
3425 {
3426 cupsdSetString(&job->username, value);
3427 }
3428 else if (!strcasecmp(line, "Destination"))
3429 {
3430 cupsdSetString(&job->dest, value);
3431 }
3432 else if (!strcasecmp(line, "DestType"))
3433 {
3434 job->dtype = (cups_ptype_t)atoi(value);
3435 }
3436 else if (!strcasecmp(line, "NumFiles"))
3437 {
3438 job->num_files = atoi(value);
3439
3440 if (job->num_files < 0)
3441 {
3442 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad NumFiles value %d on line %d!",
3443 job->num_files, linenum);
3444 job->num_files = 0;
3445 continue;
3446 }
3447
3448 if (job->num_files > 0)
3449 {
3450 snprintf(jobfile, sizeof(jobfile), "%s/d%05d-001", RequestRoot,
3451 job->id);
3452 if (access(jobfile, 0))
3453 {
3454 cupsdLogMessage(CUPSD_LOG_INFO, "[Job %d] Data files have gone away!",
3455 job->id);
3456 job->num_files = 0;
3457 continue;
3458 }
3459
3460 job->filetypes = calloc(job->num_files, sizeof(mime_type_t *));
3461 job->compressions = calloc(job->num_files, sizeof(int));
3462
3463 if (!job->filetypes || !job->compressions)
3464 {
3465 cupsdLogMessage(CUPSD_LOG_EMERG,
3466 "[Job %d] Unable to allocate memory for %d files!",
3467 job->id, job->num_files);
3468 break;
3469 }
3470 }
3471 }
3472 else if (!strcasecmp(line, "File"))
3473 {
3474 int number, /* File number */
3475 compression; /* Compression value */
3476 char super[MIME_MAX_SUPER], /* MIME super type */
3477 type[MIME_MAX_TYPE]; /* MIME type */
3478
3479
3480 if (sscanf(value, "%d%*[ \t]%15[^/]/%255s%d", &number, super, type,
3481 &compression) != 4)
3482 {
3483 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad File on line %d!", linenum);
3484 continue;
3485 }
3486
3487 if (number < 1 || number > job->num_files)
3488 {
3489 cupsdLogMessage(CUPSD_LOG_ERROR, "Bad File number %d on line %d!",
3490 number, linenum);
3491 continue;
3492 }
3493
3494 number --;
3495
3496 job->compressions[number] = compression;
3497 job->filetypes[number] = mimeType(MimeDatabase, super, type);
3498
3499 if (!job->filetypes[number])
3500 {
3501 /*
3502 * If the original MIME type is unknown, auto-type it!
3503 */
3504
3505 cupsdLogMessage(CUPSD_LOG_ERROR,
3506 "[Job %d] Unknown MIME type %s/%s for file %d!",
3507 job->id, super, type, number + 1);
3508
3509 snprintf(jobfile, sizeof(jobfile), "%s/d%05d-%03d", RequestRoot,
3510 job->id, number + 1);
3511 job->filetypes[number] = mimeFileType(MimeDatabase, jobfile, NULL,
3512 job->compressions + number);
3513
3514 /*
3515 * If that didn't work, assume it is raw...
3516 */
3517
3518 if (!job->filetypes[number])
3519 job->filetypes[number] = mimeType(MimeDatabase, "application",
3520 "vnd.cups-raw");
3521 }
3522 }
3523 else
3524 cupsdLogMessage(CUPSD_LOG_ERROR, "Unknown %s directive on line %d!",
3525 line, linenum);
3526 }
3527
3528 cupsFileClose(fp);
3529 }
3530
3531
3532 /*
3533 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
3534 */
3535
3536 static void
3537 load_next_job_id(const char *filename) /* I - job.cache filename */
3538 {
3539 cups_file_t *fp; /* job.cache file */
3540 char line[1024], /* Line buffer */
3541 *value; /* Value on line */
3542 int linenum; /* Line number in file */
3543 int next_job_id; /* NextJobId value from line */
3544
3545
3546 /*
3547 * Read the NextJobId directive from the job.cache file and use
3548 * the value (if any).
3549 */
3550
3551 if ((fp = cupsFileOpen(filename, "r")) == NULL)
3552 {
3553 if (errno != ENOENT)
3554 cupsdLogMessage(CUPSD_LOG_ERROR,
3555 "Unable to open job cache file \"%s\": %s",
3556 filename, strerror(errno));
3557
3558 return;
3559 }
3560
3561 cupsdLogMessage(CUPSD_LOG_INFO,
3562 "Loading NextJobId from job cache file \"%s\"...", filename);
3563
3564 linenum = 0;
3565
3566 while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
3567 {
3568 if (!strcasecmp(line, "NextJobId"))
3569 {
3570 if (value)
3571 {
3572 next_job_id = atoi(value);
3573
3574 if (next_job_id > NextJobId)
3575 NextJobId = next_job_id;
3576 }
3577 break;
3578 }
3579 }
3580
3581 cupsFileClose(fp);
3582 }
3583
3584
3585 /*
3586 * 'load_request_root()' - Load jobs from the RequestRoot directory.
3587 */
3588
3589 static void
3590 load_request_root(void)
3591 {
3592 cups_dir_t *dir; /* Directory */
3593 cups_dentry_t *dent; /* Directory entry */
3594 cupsd_job_t *job; /* New job */
3595
3596
3597 /*
3598 * Open the requests directory...
3599 */
3600
3601 cupsdLogMessage(CUPSD_LOG_DEBUG, "Scanning %s for jobs...", RequestRoot);
3602
3603 if ((dir = cupsDirOpen(RequestRoot)) == NULL)
3604 {
3605 cupsdLogMessage(CUPSD_LOG_ERROR,
3606 "Unable to open spool directory \"%s\": %s",
3607 RequestRoot, strerror(errno));
3608 return;
3609 }
3610
3611 /*
3612 * Read all the c##### files...
3613 */
3614
3615 while ((dent = cupsDirRead(dir)) != NULL)
3616 if (strlen(dent->filename) >= 6 && dent->filename[0] == 'c')
3617 {
3618 /*
3619 * Allocate memory for the job...
3620 */
3621
3622 if ((job = calloc(sizeof(cupsd_job_t), 1)) == NULL)
3623 {
3624 cupsdLogMessage(CUPSD_LOG_ERROR, "Ran out of memory for jobs!");
3625 cupsDirClose(dir);
3626 return;
3627 }
3628
3629 /*
3630 * Assign the job ID...
3631 */
3632
3633 job->id = atoi(dent->filename + 1);
3634 job->back_pipes[0] = -1;
3635 job->back_pipes[1] = -1;
3636 job->print_pipes[0] = -1;
3637 job->print_pipes[1] = -1;
3638 job->side_pipes[0] = -1;
3639 job->side_pipes[1] = -1;
3640 job->status_pipes[0] = -1;
3641 job->status_pipes[1] = -1;
3642
3643 if (job->id >= NextJobId)
3644 NextJobId = job->id + 1;
3645
3646 /*
3647 * Load the job...
3648 */
3649
3650 if (cupsdLoadJob(job))
3651 {
3652 /*
3653 * Insert the job into the array, sorting by job priority and ID...
3654 */
3655
3656 cupsArrayAdd(Jobs, job);
3657
3658 if (job->state_value <= IPP_JOB_STOPPED)
3659 cupsArrayAdd(ActiveJobs, job);
3660 else
3661 unload_job(job);
3662 }
3663 }
3664
3665 cupsDirClose(dir);
3666 }
3667
3668
3669 /*
3670 * 'set_hold_until()' - Set the hold time and update job-hold-until attribute.
3671 */
3672
3673 static void
3674 set_hold_until(cupsd_job_t *job, /* I - Job to update */
3675 time_t holdtime) /* I - Hold until time */
3676 {
3677 ipp_attribute_t *attr; /* job-hold-until attribute */
3678 struct tm *holddate; /* Hold date */
3679 char holdstr[64]; /* Hold time */
3680
3681
3682 /*
3683 * Set the hold_until value and hold the job...
3684 */
3685
3686 cupsdLogMessage(CUPSD_LOG_DEBUG, "set_hold_until: hold_until = %d",
3687 (int)holdtime);
3688
3689 job->state->values[0].integer = IPP_JOB_HELD;
3690 job->state_value = IPP_JOB_HELD;
3691 job->hold_until = holdtime;
3692
3693 /*
3694 * Update the job-hold-until attribute with a string representing GMT
3695 * time (HH:MM:SS)...
3696 */
3697
3698 holddate = gmtime(&holdtime);
3699 snprintf(holdstr, sizeof(holdstr), "%d:%d:%d", holddate->tm_hour,
3700 holddate->tm_min, holddate->tm_sec);
3701
3702 if ((attr = ippFindAttribute(job->attrs, "job-hold-until",
3703 IPP_TAG_KEYWORD)) == NULL)
3704 attr = ippFindAttribute(job->attrs, "job-hold-until", IPP_TAG_NAME);
3705
3706 /*
3707 * Either add the attribute or update the value of the existing one
3708 */
3709
3710 if (attr == NULL)
3711 ippAddString(job->attrs, IPP_TAG_JOB, IPP_TAG_KEYWORD, "job-hold-until",
3712 NULL, holdstr);
3713 else
3714 cupsdSetString(&attr->values[0].string.text, holdstr);
3715
3716 job->dirty = 1;
3717 cupsdMarkDirty(CUPSD_DIRTY_JOBS);
3718 }
3719
3720
3721 /*
3722 * 'set_time()' - Set one of the "time-at-xyz" attributes.
3723 */
3724
3725 static void
3726 set_time(cupsd_job_t *job, /* I - Job to update */
3727 const char *name) /* I - Name of attribute */
3728 {
3729 ipp_attribute_t *attr; /* Time attribute */
3730
3731
3732 if ((attr = ippFindAttribute(job->attrs, name, IPP_TAG_ZERO)) != NULL)
3733 {
3734 attr->value_tag = IPP_TAG_INTEGER;
3735 attr->values[0].integer = time(NULL);
3736 }
3737 }
3738
3739
3740 /*
3741 * 'start_job()' - Start a print job.
3742 */
3743
3744 static void
3745 start_job(cupsd_job_t *job, /* I - Job ID */
3746 cupsd_printer_t *printer) /* I - Printer to print job */
3747 {
3748 cupsdLogMessage(CUPSD_LOG_DEBUG2, "start_job(job=%p(%d), printer=%p(%s))",
3749 job, job->id, printer, printer->name);
3750
3751 /*
3752 * Make sure we have some files around before we try to print...
3753 */
3754
3755 if (job->num_files == 0)
3756 {
3757 cupsdSetJobState(job, IPP_JOB_ABORTED, CUPSD_JOB_DEFAULT,
3758 "Aborting job because it has no files.");
3759 return;
3760 }
3761
3762 /*
3763 * Update the printer and job state to "processing"...
3764 */
3765
3766 if (!cupsdLoadJob(job))
3767 return;
3768
3769 cupsdSetJobState(job, IPP_JOB_PROCESSING, CUPSD_JOB_DEFAULT, NULL);
3770 cupsdSetPrinterState(printer, IPP_PRINTER_PROCESSING, 0);
3771
3772 job->cost = 0;
3773 job->current_file = 0;
3774 job->progress = 0;
3775 job->printer = printer;
3776 printer->job = job;
3777
3778 /*
3779 * Setup the last exit status and security profiles...
3780 */
3781
3782 job->status = 0;
3783 job->profile = cupsdCreateProfile(job->id);
3784
3785 /*
3786 * Create the status pipes and buffer...
3787 */
3788
3789 if (cupsdOpenPipe(job->status_pipes))
3790 {
3791 cupsdLogJob(job, CUPSD_LOG_DEBUG,
3792 "Unable to create job status pipes - %s.", strerror(errno));
3793
3794 cupsdSetJobState(job, IPP_JOB_STOPPED, CUPSD_JOB_DEFAULT,
3795 "Job stopped because the scheduler could not create the "
3796 "job status pipes.");
3797
3798 cupsdDestroyProfile(job->profile);
3799 job->profile = NULL;
3800 return;
3801 }
3802
3803 job->status_buffer = cupsdStatBufNew(job->status_pipes[0], NULL);
3804 job->status_level = CUPSD_LOG_INFO;
3805
3806 if (job->printer_message)
3807 cupsdSetString(&(job->printer_message->values[0].string.text), "");
3808
3809 /*
3810 * Create the backchannel pipes and make them non-blocking...
3811 */
3812
3813 if (cupsdOpenPipe(job->back_pipes))
3814 {
3815 cupsdLogJob(job, CUPSD_LOG_DEBUG,
3816 "Unable to create back-channel pipes - %s.", strerror(errno));
3817
3818 cupsdSetJobState(job, IPP_JOB_STOPPED, CUPSD_JOB_DEFAULT,
3819 "Job stopped because the scheduler could not create the "
3820 "back-channel pipes.");
3821
3822 cupsdClosePipe(job->status_pipes);
3823 cupsdStatBufDelete(job->status_buffer);
3824 job->status_buffer = NULL;
3825
3826 cupsdDestroyProfile(job->profile);
3827 job->profile = NULL;
3828 return;
3829 }
3830
3831 fcntl(job->back_pipes[0], F_SETFL,
3832 fcntl(job->back_pipes[0], F_GETFL) | O_NONBLOCK);
3833 fcntl(job->back_pipes[1], F_SETFL,
3834 fcntl(job->back_pipes[1], F_GETFL) | O_NONBLOCK);
3835
3836 /*
3837 * Create the side-channel pipes and make them non-blocking...
3838 */
3839
3840 if (socketpair(AF_LOCAL, SOCK_STREAM, 0, job->side_pipes))
3841 {
3842 cupsdLogJob(job, CUPSD_LOG_DEBUG,
3843 "Unable to create side-channel pipes - %s.", strerror(errno));
3844
3845 cupsdSetJobState(job, IPP_JOB_STOPPED, CUPSD_JOB_DEFAULT,
3846 "Job stopped because the scheduler could not create the "
3847 "side-channel pipes.");
3848
3849 cupsdClosePipe(job->back_pipes);
3850
3851 cupsdClosePipe(job->status_pipes);
3852 cupsdStatBufDelete(job->status_buffer);
3853 job->status_buffer = NULL;
3854
3855 cupsdDestroyProfile(job->profile);
3856 job->profile = NULL;
3857 return;
3858 }
3859
3860 fcntl(job->side_pipes[0], F_SETFL,
3861 fcntl(job->side_pipes[0], F_GETFL) | O_NONBLOCK);
3862 fcntl(job->side_pipes[1], F_SETFL,
3863 fcntl(job->side_pipes[1], F_GETFL) | O_NONBLOCK);
3864
3865 fcntl(job->side_pipes[0], F_SETFD,
3866 fcntl(job->side_pipes[0], F_GETFD) | FD_CLOEXEC);
3867 fcntl(job->side_pipes[1], F_SETFD,
3868 fcntl(job->side_pipes[1], F_GETFD) | FD_CLOEXEC);
3869
3870 /*
3871 * Now start the first file in the job...
3872 */
3873
3874 cupsdContinueJob(job);
3875 }
3876
3877
3878 /*
3879 * 'stop_job()' - Stop a print job.
3880 */
3881
3882 static void
3883 stop_job(cupsd_job_t *job, /* I - Job */
3884 cupsd_jobaction_t action) /* I - Action */
3885 {
3886 int i; /* Looping var */
3887
3888
3889 cupsdLogMessage(CUPSD_LOG_DEBUG2, "stop_job(job=%p(%d), action=%d)", job,
3890 job->id, action);
3891
3892 FilterLevel -= job->cost;
3893 job->cost = 0;
3894
3895 if (action == CUPSD_JOB_DEFAULT && !job->kill_time)
3896 job->kill_time = time(NULL) + JobKillDelay;
3897 else if (action == CUPSD_JOB_FORCE)
3898 job->kill_time = 0;
3899
3900 for (i = 0; job->filters[i]; i ++)
3901 if (job->filters[i] > 0)
3902 cupsdEndProcess(job->filters[i], action == CUPSD_JOB_FORCE);
3903
3904 if (job->backend > 0)
3905 cupsdEndProcess(job->backend, action == CUPSD_JOB_FORCE);
3906 }
3907
3908
3909 /*
3910 * 'unload_job()' - Unload a job from memory.
3911 */
3912
3913 static void
3914 unload_job(cupsd_job_t *job) /* I - Job */
3915 {
3916 if (!job->attrs)
3917 return;
3918
3919 cupsdLogMessage(CUPSD_LOG_DEBUG, "[Job %d] Unloading...", job->id);
3920
3921 ippDelete(job->attrs);
3922
3923 job->attrs = NULL;
3924 job->state = NULL;
3925 job->sheets = NULL;
3926 job->job_sheets = NULL;
3927 job->printer_message = NULL;
3928 job->printer_reasons = NULL;
3929 }
3930
3931
3932 /*
3933 * 'update_job()' - Read a status update from a job's filters.
3934 */
3935
3936 void
3937 update_job(cupsd_job_t *job) /* I - Job to check */
3938 {
3939 int i; /* Looping var */
3940 int copies; /* Number of copies printed */
3941 char message[CUPSD_SB_BUFFER_SIZE],
3942 /* Message text */
3943 *ptr; /* Pointer update... */
3944 int loglevel, /* Log level for message */
3945 event = 0; /* Events? */
3946 static const char * const levels[] = /* Log levels */
3947 {
3948 "NONE",
3949 "EMERG",
3950 "ALERT",
3951 "CRIT",
3952 "ERROR",
3953 "WARN",
3954 "NOTICE",
3955 "INFO",
3956 "DEBUG",
3957 "DEBUG2"
3958 };
3959
3960
3961 /*
3962 * Get the printer associated with this job; if the printer is stopped for
3963 * any reason then job->printer will be reset to NULL, so make sure we have
3964 * a valid pointer...
3965 */
3966
3967 while ((ptr = cupsdStatBufUpdate(job->status_buffer, &loglevel,
3968 message, sizeof(message))) != NULL)
3969 {
3970 /*
3971 * Process page and printer state messages as needed...
3972 */
3973
3974 if (loglevel == CUPSD_LOG_PAGE)
3975 {
3976 /*
3977 * Page message; send the message to the page_log file and update the
3978 * job sheet count...
3979 */
3980
3981 cupsdLogJob(job, CUPSD_LOG_DEBUG, "PAGE: %s", message);
3982
3983 if (job->sheets)
3984 {
3985 if (!strncasecmp(message, "total ", 6))
3986 {
3987 /*
3988 * Got a total count of pages from a backend or filter...
3989 */
3990
3991 copies = atoi(message + 6);
3992 copies -= job->sheets->values[0].integer; /* Just track the delta */
3993 }
3994 else if (!sscanf(message, "%*d%d", &copies))
3995 copies = 1;
3996
3997 job->sheets->values[0].integer += copies;
3998
3999 if (job->printer->page_limit)
4000 {
4001 cupsd_quota_t *q = cupsdUpdateQuota(job->printer, job->username,
4002 copies, 0);
4003
4004 #ifdef __APPLE__
4005 if (AppleQuotas && q->page_count == -3)
4006 {
4007 /*
4008 * Quota limit exceeded, cancel job in progress immediately...
4009 */
4010
4011 cupsdSetJobState(job, IPP_JOB_CANCELED, CUPSD_JOB_DEFAULT,
4012 "Canceled job because pages exceed user %s "
4013 "quota limit on printer %s (%s).",
4014 job->username, job->printer->name,
4015 job->printer->info);
4016 return;
4017 }
4018 #else
4019 (void)q;
4020 #endif /* __APPLE__ */
4021 }
4022 }
4023
4024 cupsdLogPage(job, message);
4025
4026 if (job->sheets)
4027 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS, job->printer, job,
4028 "Printed %d page(s).", job->sheets->values[0].integer);
4029 }
4030 else if (loglevel == CUPSD_LOG_STATE)
4031 {
4032 cupsdLogJob(job, CUPSD_LOG_DEBUG, "STATE: %s", message);
4033
4034 if (!strcmp(message, "paused"))
4035 {
4036 cupsdStopPrinter(job->printer, 1);
4037 return;
4038 }
4039 else if (cupsdSetPrinterReasons(job->printer, message))
4040 {
4041 cupsdAddPrinterHistory(job->printer);
4042 event |= CUPSD_EVENT_PRINTER_STATE;
4043 }
4044
4045 update_job_attrs(job, 0);
4046 }
4047 else if (loglevel == CUPSD_LOG_ATTR)
4048 {
4049 /*
4050 * Set attribute(s)...
4051 */
4052
4053 int num_attrs; /* Number of attributes */
4054 cups_option_t *attrs; /* Attributes */
4055 const char *attr; /* Attribute */
4056
4057
4058 cupsdLogJob(job, CUPSD_LOG_DEBUG, "ATTR: %s", message);
4059
4060 num_attrs = cupsParseOptions(message, 0, &attrs);
4061
4062 if ((attr = cupsGetOption("auth-info-required", num_attrs,
4063 attrs)) != NULL)
4064 {
4065 cupsdSetAuthInfoRequired(job->printer, attr, NULL);
4066 cupsdSetPrinterAttrs(job->printer);
4067
4068 if (job->printer->type & CUPS_PRINTER_DISCOVERED)
4069 cupsdMarkDirty(CUPSD_DIRTY_REMOTE);
4070 else
4071 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4072 }
4073
4074 if ((attr = cupsGetOption("job-media-progress", num_attrs,
4075 attrs)) != NULL)
4076 {
4077 int progress = atoi(attr);
4078
4079
4080 if (progress >= 0 && progress <= 100)
4081 {
4082 job->progress = progress;
4083
4084 if (job->sheets)
4085 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS, job->printer, job,
4086 "Printing page %d, %d%%",
4087 job->sheets->values[0].integer, job->progress);
4088 }
4089 }
4090
4091 if ((attr = cupsGetOption("printer-alert", num_attrs, attrs)) != NULL)
4092 {
4093 cupsdSetString(&job->printer->alert, attr);
4094 event |= CUPSD_EVENT_PRINTER_STATE;
4095 }
4096
4097 if ((attr = cupsGetOption("printer-alert-description", num_attrs,
4098 attrs)) != NULL)
4099 {
4100 cupsdSetString(&job->printer->alert_description, attr);
4101 event |= CUPSD_EVENT_PRINTER_STATE;
4102 }
4103
4104 if ((attr = cupsGetOption("marker-colors", num_attrs, attrs)) != NULL)
4105 {
4106 cupsdSetPrinterAttr(job->printer, "marker-colors", (char *)attr);
4107 job->printer->marker_time = time(NULL);
4108 event |= CUPSD_EVENT_PRINTER_STATE;
4109 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4110 }
4111
4112 if ((attr = cupsGetOption("marker-levels", num_attrs, attrs)) != NULL)
4113 {
4114 cupsdSetPrinterAttr(job->printer, "marker-levels", (char *)attr);
4115 job->printer->marker_time = time(NULL);
4116 event |= CUPSD_EVENT_PRINTER_STATE;
4117 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4118 }
4119
4120 if ((attr = cupsGetOption("marker-low-levels", num_attrs, attrs)) != NULL)
4121 {
4122 cupsdSetPrinterAttr(job->printer, "marker-low-levels", (char *)attr);
4123 job->printer->marker_time = time(NULL);
4124 event |= CUPSD_EVENT_PRINTER_STATE;
4125 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4126 }
4127
4128 if ((attr = cupsGetOption("marker-high-levels", num_attrs, attrs)) != NULL)
4129 {
4130 cupsdSetPrinterAttr(job->printer, "marker-high-levels", (char *)attr);
4131 job->printer->marker_time = time(NULL);
4132 event |= CUPSD_EVENT_PRINTER_STATE;
4133 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4134 }
4135
4136 if ((attr = cupsGetOption("marker-message", num_attrs, attrs)) != NULL)
4137 {
4138 cupsdSetPrinterAttr(job->printer, "marker-message", (char *)attr);
4139 job->printer->marker_time = time(NULL);
4140 event |= CUPSD_EVENT_PRINTER_STATE;
4141 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4142 }
4143
4144 if ((attr = cupsGetOption("marker-names", num_attrs, attrs)) != NULL)
4145 {
4146 cupsdSetPrinterAttr(job->printer, "marker-names", (char *)attr);
4147 job->printer->marker_time = time(NULL);
4148 event |= CUPSD_EVENT_PRINTER_STATE;
4149 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4150 }
4151
4152 if ((attr = cupsGetOption("marker-types", num_attrs, attrs)) != NULL)
4153 {
4154 cupsdSetPrinterAttr(job->printer, "marker-types", (char *)attr);
4155 job->printer->marker_time = time(NULL);
4156 event |= CUPSD_EVENT_PRINTER_STATE;
4157 cupsdMarkDirty(CUPSD_DIRTY_PRINTERS);
4158 }
4159
4160 cupsFreeOptions(num_attrs, attrs);
4161 }
4162 else if (loglevel == CUPSD_LOG_PPD)
4163 {
4164 /*
4165 * Set attribute(s)...
4166 */
4167
4168 int num_keywords; /* Number of keywords */
4169 cups_option_t *keywords; /* Keywords */
4170
4171
4172 cupsdLogJob(job, CUPSD_LOG_DEBUG, "PPD: %s", message);
4173
4174 num_keywords = cupsParseOptions(message, 0, &keywords);
4175
4176 if (cupsdUpdatePrinterPPD(job->printer, num_keywords, keywords))
4177 cupsdSetPrinterAttrs(job->printer);
4178
4179 cupsFreeOptions(num_keywords, keywords);
4180 }
4181 else
4182 {
4183 /*
4184 * Strip legacy message prefix...
4185 */
4186
4187 if (!strncmp(message, "recoverable:", 12))
4188 {
4189 ptr = message + 12;
4190 while (isspace(*ptr & 255))
4191 ptr ++;
4192 }
4193 else if (!strncmp(message, "recovered:", 10))
4194 {
4195 ptr = message + 10;
4196 while (isspace(*ptr & 255))
4197 ptr ++;
4198 }
4199 else
4200 ptr = message;
4201
4202 cupsdLogJob(job, loglevel, "%s", ptr);
4203
4204 if (loglevel < CUPSD_LOG_DEBUG)
4205 {
4206 strlcpy(job->printer->state_message, ptr,
4207 sizeof(job->printer->state_message));
4208 cupsdAddPrinterHistory(job->printer);
4209
4210 event |= CUPSD_EVENT_PRINTER_STATE | CUPSD_EVENT_JOB_PROGRESS;
4211
4212 if (loglevel < job->status_level)
4213 {
4214 /*
4215 * Some messages show in the job-printer-state-message attribute...
4216 */
4217
4218 if (loglevel != CUPSD_LOG_NOTICE)
4219 job->status_level = loglevel;
4220
4221 update_job_attrs(job, 1);
4222
4223 cupsdLogJob(job, CUPSD_LOG_DEBUG,
4224 "Set job-printer-state-message to \"%s\", "
4225 "current level=%s",
4226 job->printer_message->values[0].string.text,
4227 levels[job->status_level]);
4228 }
4229 }
4230 }
4231
4232 if (!strchr(job->status_buffer->buffer, '\n'))
4233 break;
4234 }
4235
4236 if (event & CUPSD_EVENT_PRINTER_STATE)
4237 cupsdAddEvent(CUPSD_EVENT_PRINTER_STATE, job->printer, NULL,
4238 (job->printer->type & CUPS_PRINTER_CLASS) ?
4239 "Class \"%s\" state changed." :
4240 "Printer \"%s\" state changed.",
4241 job->printer->name);
4242
4243 if (event & CUPSD_EVENT_JOB_PROGRESS)
4244 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS, job->printer, job,
4245 "%s", job->printer->state_message);
4246
4247 if (ptr == NULL && !job->status_buffer->bufused)
4248 {
4249 /*
4250 * See if all of the filters and the backend have returned their
4251 * exit statuses.
4252 */
4253
4254 for (i = 0; job->filters[i] < 0; i ++);
4255
4256 if (job->filters[i])
4257 {
4258 /*
4259 * EOF but we haven't collected the exit status of all filters...
4260 */
4261
4262 cupsdCheckProcess();
4263 return;
4264 }
4265
4266 if (job->current_file >= job->num_files && job->backend > 0)
4267 {
4268 /*
4269 * EOF but we haven't collected the exit status of the backend...
4270 */
4271
4272 cupsdCheckProcess();
4273 return;
4274 }
4275
4276 /*
4277 * Handle the end of job stuff...
4278 */
4279
4280 finalize_job(job);
4281
4282 /*
4283 * Check for new jobs...
4284 */
4285
4286 cupsdCheckJobs();
4287 }
4288 }
4289
4290
4291 /*
4292 * 'update_job_attrs()' - Update the job-printer-* attributes.
4293 */
4294
4295 void
4296 update_job_attrs(cupsd_job_t *job, /* I - Job to update */
4297 int do_message)/* I - 1 = copy job-printer-state message */
4298 {
4299 int i; /* Looping var */
4300 int num_reasons; /* Actual number of reasons */
4301 const char * const *reasons; /* Reasons */
4302 static const char *none = "none"; /* "none" reason */
4303
4304
4305 /*
4306 * Get/create the job-printer-state-* attributes...
4307 */
4308
4309 if (!job->printer_message)
4310 {
4311 if ((job->printer_message = ippFindAttribute(job->attrs,
4312 "job-printer-state-message",
4313 IPP_TAG_TEXT)) == NULL)
4314 job->printer_message = ippAddString(job->attrs, IPP_TAG_JOB, IPP_TAG_TEXT,
4315 "job-printer-state-message",
4316 NULL, "");
4317 }
4318
4319 if (!job->printer_reasons)
4320 job->printer_reasons = ippFindAttribute(job->attrs,
4321 "job-printer-state-reasons",
4322 IPP_TAG_KEYWORD);
4323
4324 /*
4325 * Copy or clear the printer-state-message value as needed...
4326 */
4327
4328 if (job->state_value != IPP_JOB_PROCESSING &&
4329 job->status_level == CUPSD_LOG_INFO)
4330 cupsdSetString(&(job->printer_message->values[0].string.text), "");
4331 else if (job->printer->state_message[0] && do_message)
4332 cupsdSetString(&(job->printer_message->values[0].string.text),
4333 job->printer->state_message);
4334
4335 /*
4336 * ... and the printer-state-reasons value...
4337 */
4338
4339 if (job->printer->num_reasons == 0)
4340 {
4341 num_reasons = 1;
4342 reasons = &none;
4343 }
4344 else
4345 {
4346 num_reasons = job->printer->num_reasons;
4347 reasons = (const char * const *)job->printer->reasons;
4348 }
4349
4350 if (!job->printer_reasons || job->printer_reasons->num_values != num_reasons)
4351 {
4352 /*
4353 * Replace/create a job-printer-state-reasons attribute...
4354 */
4355
4356 ippDeleteAttribute(job->attrs, job->printer_reasons);
4357
4358 job->printer_reasons = ippAddStrings(job->attrs,
4359 IPP_TAG_JOB, IPP_TAG_KEYWORD,
4360 "job-printer-state-reasons",
4361 num_reasons, NULL, NULL);
4362 }
4363 else
4364 {
4365 /*
4366 * Don't bother clearing the reason strings if they are the same...
4367 */
4368
4369 for (i = 0; i < num_reasons; i ++)
4370 if (strcmp(job->printer_reasons->values[i].string.text, reasons[i]))
4371 break;
4372
4373 if (i >= num_reasons)
4374 return;
4375
4376 /*
4377 * Not the same, so free the current strings...
4378 */
4379
4380 for (i = 0; i < num_reasons; i ++)
4381 _cupsStrFree(job->printer_reasons->values[i].string.text);
4382 }
4383
4384 /*
4385 * Copy the reasons...
4386 */
4387
4388 for (i = 0; i < num_reasons; i ++)
4389 job->printer_reasons->values[i].string.text = _cupsStrAlloc(reasons[i]);
4390 }
4391
4392
4393 /*
4394 * End of "$Id: job.c 7902 2008-09-03 14:20:17Z mike $".
4395 */