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