2 * "$Id: job.c 5543 2006-05-18 20:51:33Z mike $"
4 * Job management routines for the Common UNIX Printing System (CUPS).
6 * Copyright 1997-2006 by Easy Software Products, all rights reserved.
8 * These coded instructions, statements, and computer programs are the
9 * property of Easy Software Products and are protected by Federal
10 * copyright law. Distribution and use rights are outlined in the file
11 * "LICENSE.txt" which should have been included with this file. If this
12 * file is missing or damaged please contact Easy Software Products
15 * Attn: CUPS Licensing Information
16 * Easy Software Products
17 * 44141 Airport View Drive, Suite 204
18 * Hollywood, Maryland 20636 USA
20 * Voice: (301) 373-9600
21 * EMail: cups-info@cups.org
22 * WWW: http://www.cups.org
26 * cupsdAddJob() - Add a new job to the job queue...
27 * cupsdCancelJob() - Cancel the specified print job.
28 * cupsdCancelJobs() - Cancel all jobs for the given
30 * cupsdCheckJobs() - Check the pending jobs and start any if
31 * the destination is available.
32 * cupsdCleanJobs() - Clean out old jobs.
33 * cupsdFinishJob() - Finish a job.
34 * cupsdFreeAllJobs() - Free all jobs from memory.
35 * cupsdFindJob() - Find the specified job.
36 * cupsdGetPrinterJobCount() - Get the number of pending, processing,
37 * cupsdGetUserJobCount() - Get the number of pending, processing,
38 * cupsdHoldJob() - Hold the specified job.
39 * cupsdLoadAllJobs() - Load all jobs from disk.
40 * cupsdLoadJob() - Load a single job...
41 * cupsdMoveJob() - Move the specified job to a different
43 * cupsdReleaseJob() - Release the specified job.
44 * cupsdRestartJob() - Restart the specified job.
45 * cupsdSaveAllJobs() - Save a summary of all jobs to disk.
46 * cupsdSaveJob() - Save a job to disk.
47 * cupsdSetJobHoldUntil() - Set the hold time for a job...
48 * cupsdSetJobPriority() - Set the priority of a job, moving it
49 * up/down in the list as needed.
50 * cupsdStopAllJobs() - Stop all print jobs.
51 * cupsdStopJob() - Stop a print job.
52 * cupsdUnloadCompletedJobs() - Flush completed job history from memory.
53 * cupsdUpdateJob() - Read a status update from a jobs filters.
54 * compare_active_jobs() - Compare the job IDs and priorities of two
56 * compare_jobs() - Compare the job IDs of two jobs.
57 * free_job() - Free all memory used by a job.
58 * ipp_length() - Compute the size of the buffer needed to
59 * hold the textual IPP attributes.
60 * load_job_cache() - Load jobs from the job.cache file.
61 * load_next_job_id() - Load the NextJobId value from the
63 * load_request_root() - Load jobs from the RequestRoot directory.
64 * set_time() - Set one of the "time-at-xyz" attributes...
65 * set_hold_until() - Set the hold time and update job-hold-until
67 * start_job() - Start a print job.
68 * unload_job() - Unload a job from memory.
72 * Include necessary headers...
77 #include <cups/backend.h>
85 static mime_filter_t gziptoany_filter
=
87 NULL
, /* Source type */
88 NULL
, /* Destination type */
90 "gziptoany" /* Filter program to run */
98 static int compare_active_jobs(void *first
, void *second
, void *data
);
99 static int compare_jobs(void *first
, void *second
, void *data
);
100 static void free_job(cupsd_job_t
*job
);
101 static int ipp_length(ipp_t
*ipp
);
102 static void load_job_cache(const char *filename
);
103 static void load_next_job_id(const char *filename
);
104 static void load_request_root(void);
105 static void set_time(cupsd_job_t
*job
, const char *name
);
106 static void set_hold_until(cupsd_job_t
*job
, time_t holdtime
);
107 static void start_job(cupsd_job_t
*job
, cupsd_printer_t
*printer
);
108 static void unload_job(cupsd_job_t
*job
);
112 * 'cupsdAddJob()' - Add a new job to the job queue...
115 cupsd_job_t
* /* O - New job record */
116 cupsdAddJob(int priority
, /* I - Job priority */
117 const char *dest
) /* I - Job destination */
119 cupsd_job_t
*job
; /* New job record */
122 job
= calloc(sizeof(cupsd_job_t
), 1);
124 job
->id
= NextJobId
++;
125 job
->priority
= priority
;
126 job
->back_pipes
[0] = -1;
127 job
->back_pipes
[1] = -1;
128 job
->print_pipes
[0] = -1;
129 job
->print_pipes
[1] = -1;
130 job
->status_pipes
[0] = -1;
131 job
->status_pipes
[1] = -1;
133 cupsdSetString(&job
->dest
, dest
);
136 * Add the new job to the "all jobs" and "active jobs" lists...
139 cupsArrayAdd(Jobs
, job
);
140 cupsArrayAdd(ActiveJobs
, job
);
147 * 'cupsdCancelJob()' - Cancel the specified print job.
151 cupsdCancelJob(cupsd_job_t
*job
, /* I - Job to cancel */
152 int purge
) /* I - Purge jobs? */
154 int i
; /* Looping var */
155 char filename
[1024]; /* Job filename */
158 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdCancelJob: id = %d", job
->id
);
161 * Stop any processes that are working on the current job...
164 if (job
->state_value
== IPP_JOB_PROCESSING
)
165 cupsdStopJob(job
, 0);
170 job
->state
->values
[0].integer
= IPP_JOB_CANCELLED
;
172 job
->state_value
= IPP_JOB_CANCELLED
;
174 set_time(job
, "time-at-completed");
176 cupsdExpireSubscriptions(NULL
, job
);
179 * Remove the job from the active list...
182 cupsArrayRemove(ActiveJobs
, job
);
185 * Remove any authentication data...
188 snprintf(filename
, sizeof(filename
), "%s/a%05d", RequestRoot
, job
->id
);
192 * Remove the print file for good if we aren't preserving jobs or
196 job
->current_file
= 0;
198 if (!JobHistory
|| !JobFiles
|| purge
|| (job
->dtype
& CUPS_PRINTER_REMOTE
))
200 for (i
= 1; i
<= job
->num_files
; i
++)
202 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
207 if (job
->num_files
> 0)
209 free(job
->filetypes
);
210 free(job
->compressions
);
213 job
->filetypes
= NULL
;
214 job
->compressions
= NULL
;
218 if (JobHistory
&& !purge
&& !(job
->dtype
& CUPS_PRINTER_REMOTE
))
221 * Save job state info...
229 * Remove the job info file...
232 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
,
237 * Remove the job from the "all jobs" list...
240 cupsArrayRemove(Jobs
, job
);
243 * Free all memory used...
252 * 'cupsdCancelJobs()' - Cancel all jobs for the given destination/user...
256 cupsdCancelJobs(const char *dest
, /* I - Destination to cancel */
257 const char *username
, /* I - Username or NULL */
258 int purge
) /* I - Purge jobs? */
260 cupsd_job_t
*job
; /* Current job */
263 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
265 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
266 if ((dest
== NULL
|| !strcmp(job
->dest
, dest
)) &&
267 (username
== NULL
|| !strcmp(job
->username
, username
)))
270 * Cancel all jobs matching this destination/user...
273 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
274 purge
? "Job purged." : "Job canceled.");
276 cupsdCancelJob(job
, purge
);
284 * 'cupsdCheckJobs()' - Check the pending jobs and start any if the destination
291 cupsd_job_t
*job
; /* Current job in queue */
292 cupsd_printer_t
*printer
, /* Printer destination */
293 *pclass
; /* Printer class destination */
296 DEBUG_puts("cupsdCheckJobs()");
298 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
299 "cupsdCheckJobs: %d active jobs, sleeping=%d, reload=%d",
300 cupsArrayCount(ActiveJobs
), Sleeping
, NeedReload
);
302 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
);
304 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
307 * Start held jobs if they are ready...
310 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
311 "cupsdCheckJobs: Job %d: state_value=%d, loaded=%s",
312 job
->id
, job
->state_value
, job
->attrs
? "yes" : "no");
314 if (job
->state_value
== IPP_JOB_HELD
&&
316 job
->hold_until
< time(NULL
))
318 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
319 job
->state_value
= IPP_JOB_PENDING
;
323 * Start pending jobs if the destination is available...
326 if (job
->state_value
== IPP_JOB_PENDING
&& !NeedReload
&& !Sleeping
)
328 printer
= cupsdFindDest(job
->dest
);
332 (printer
->type
& (CUPS_PRINTER_IMPLICIT
| CUPS_PRINTER_CLASS
)))
335 * If the class is remote, just pass it to the remote server...
340 if (!(pclass
->type
& CUPS_PRINTER_REMOTE
))
342 if (pclass
->state
!= IPP_PRINTER_STOPPED
)
343 printer
= cupsdFindAvailablePrinter(job
->dest
);
349 if (!printer
&& !pclass
)
352 * Whoa, the printer and/or class for this destination went away;
356 cupsdLogMessage(CUPSD_LOG_WARN
,
357 "Printer/class %s has gone away; cancelling job %d!",
360 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
361 "Job canceled because the destination printer/class has "
364 cupsdCancelJob(job
, 1);
369 * See if the printer is available or remote and not printing a job;
370 * if so, start the job...
376 * Add/update a job-actual-printer-uri attribute for this job
377 * so that we know which printer actually printed the job...
380 ipp_attribute_t
*attr
; /* job-actual-printer-uri attribute */
383 if ((attr
= ippFindAttribute(job
->attrs
, "job-actual-printer-uri",
384 IPP_TAG_URI
)) != NULL
)
385 cupsdSetString(&attr
->values
[0].string
.text
, printer
->uri
);
387 ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_URI
,
388 "job-actual-printer-uri", NULL
, printer
->uri
);
391 if ((!(printer
->type
& CUPS_PRINTER_REMOTE
) && /* Printer is local */
392 printer
->state
== IPP_PRINTER_IDLE
) || /* and idle */
393 ((printer
->type
& CUPS_PRINTER_REMOTE
) && /* Printer is remote */
394 !printer
->job
)) /* and not printing */
395 start_job(job
, printer
);
403 * 'cupsdCleanJobs()' - Clean out old jobs.
409 cupsd_job_t
*job
; /* Current job */
415 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
416 job
&& cupsArrayCount(Jobs
) >= MaxJobs
;
417 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
418 if (job
->state_value
>= IPP_JOB_CANCELLED
)
419 cupsdCancelJob(job
, 1);
424 * 'cupsdFinishJob()' - Finish a job.
428 cupsdFinishJob(cupsd_job_t
*job
) /* I - Job */
430 int job_history
; /* Did cupsdCancelJob() keep the job? */
431 cupsd_printer_t
*printer
; /* Current printer */
434 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] File %d is complete.",
435 job
->id
, job
->current_file
- 1);
437 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdFinishJob: job->status is %d",
440 if (job
->status_buffer
&& job
->current_file
>= job
->num_files
)
443 * Close the pipe and clear the input bit.
446 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
447 "cupsdFinishJob: Removing fd %d from InputSet...",
448 job
->status_buffer
->fd
);
450 FD_CLR(job
->status_buffer
->fd
, InputSet
);
452 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
453 "cupsdFinishJob: Closing status pipes [ %d %d ]...",
454 job
->status_pipes
[0], job
->status_pipes
[1]);
456 cupsdClosePipe(job
->status_pipes
);
457 cupsdStatBufDelete(job
->status_buffer
);
459 job
->status_buffer
= NULL
;
462 printer
= job
->printer
;
467 * Backend had errors; stop it...
470 int exit_code
; /* Exit code from backend */
474 * Convert the status to an exit code. Due to the way the W* macros are
475 * implemented on MacOS X (bug?), we have to store the exit status in a
476 * variable first and then convert...
479 exit_code
= -job
->status
;
480 if (WIFEXITED(exit_code
))
481 exit_code
= WEXITSTATUS(exit_code
);
483 exit_code
= job
->status
;
485 cupsdLogMessage(CUPSD_LOG_INFO
, "[Job %d] Backend returned status %d (%s)",
487 exit_code
== CUPS_BACKEND_FAILED
? "failed" :
488 exit_code
== CUPS_BACKEND_AUTH_REQUIRED
?
489 "authentication required" :
490 exit_code
== CUPS_BACKEND_HOLD
? "hold job" :
491 exit_code
== CUPS_BACKEND_STOP
? "stop printer" :
492 exit_code
== CUPS_BACKEND_CANCEL
? "cancel job" :
493 exit_code
< 0 ? "crashed" : "unknown");
496 * Do what needs to be done...
502 case CUPS_BACKEND_FAILED
:
504 * Backend failure, use the error-policy to determine how to
508 cupsdStopJob(job
, 0);
509 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
510 job
->state_value
= IPP_JOB_PENDING
;
514 * If the job was queued to a class, try requeuing it... For
515 * faxes and retry-job queues, hold the current job for 5 minutes.
518 if (job
->dtype
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_IMPLICIT
))
520 else if ((printer
->type
& CUPS_PRINTER_FAX
) ||
521 !strcmp(printer
->error_policy
, "retry-job"))
524 * See how many times we've tried to send the job; if more than
525 * the limit, cancel the job.
530 if (job
->tries
>= JobRetryLimit
)
536 cupsdLogMessage(CUPSD_LOG_ERROR
,
537 "Canceling job %d since it could not be sent "
539 job
->id
, JobRetryLimit
);
541 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, printer
, job
,
542 "Job canceled since it could not be sent after %d "
546 cupsdCancelJob(job
, 0);
551 * Try again in N seconds...
554 set_hold_until(job
, time(NULL
) + JobRetryInterval
);
557 else if (!strcmp(printer
->error_policy
, "abort-job"))
558 cupsdCancelJob(job
, 0);
561 case CUPS_BACKEND_CANCEL
:
566 cupsdCancelJob(job
, 0);
569 case CUPS_BACKEND_HOLD
:
574 cupsdStopJob(job
, 0);
575 cupsdSetJobHoldUntil(job
, "indefinite");
579 case CUPS_BACKEND_STOP
:
581 * Stop the printer...
584 cupsdStopJob(job
, 0);
586 cupsdSetPrinterState(printer
, IPP_PRINTER_STOPPED
, 1);
589 case CUPS_BACKEND_AUTH_REQUIRED
:
590 cupsdStopJob(job
, 0);
591 cupsdSetJobHoldUntil(job
, "authenticated");
594 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, printer
, job
,
595 "Authentication is required for job %d.", job
->id
);
600 * Try printing another job...
605 else if (job
->status
> 0)
608 * Filter had errors; stop job...
611 cupsdStopJob(job
, 1);
613 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, printer
, job
,
614 "Job stopped due to filter errors; please consult the "
615 "error_log file for details.");
621 * Job printed successfully; cancel it...
624 if (job
->current_file
< job
->num_files
)
627 * Start the next file in the job...
630 FilterLevel
-= job
->cost
;
631 start_job(job
, printer
);
636 * Close out this job...
639 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, printer
, job
,
640 "Job completed successfully.");
642 job_history
= JobHistory
&& !(job
->dtype
& CUPS_PRINTER_REMOTE
);
644 cupsdCancelJob(job
, 0);
648 job
->state
->values
[0].integer
= IPP_JOB_COMPLETED
;
649 job
->state_value
= IPP_JOB_COMPLETED
;
654 * Clear the printer's state_message and state_reasons and move on...
657 printer
->state_message
[0] = '\0';
659 cupsdSetPrinterReasons(printer
, "");
668 * 'cupsdFreeAllJobs()' - Free all jobs from memory.
672 cupsdFreeAllJobs(void)
674 cupsd_job_t
*job
; /* Current job */
685 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
687 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
689 cupsArrayRemove(Jobs
, job
);
690 cupsArrayRemove(ActiveJobs
, job
);
695 cupsdReleaseSignals();
700 * 'cupsdFindJob()' - Find the specified job.
703 cupsd_job_t
* /* O - Job data */
704 cupsdFindJob(int id
) /* I - Job ID */
706 cupsd_job_t key
; /* Search key */
711 return ((cupsd_job_t
*)cupsArrayFind(Jobs
, &key
));
716 * 'cupsdGetPrinterJobCount()' - Get the number of pending, processing,
717 * or held jobs in a printer or class.
720 int /* O - Job count */
721 cupsdGetPrinterJobCount(
722 const char *dest
) /* I - Printer or class name */
724 int count
; /* Job count */
725 cupsd_job_t
*job
; /* Current job */
728 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
730 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
731 if (job
->dest
&& !strcasecmp(job
->dest
, dest
))
739 * 'cupsdGetUserJobCount()' - Get the number of pending, processing,
740 * or held jobs for a user.
743 int /* O - Job count */
744 cupsdGetUserJobCount(
745 const char *username
) /* I - Username */
747 int count
; /* Job count */
748 cupsd_job_t
*job
; /* Current job */
751 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
), count
= 0;
753 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
754 if (!strcasecmp(job
->username
, username
))
762 * 'cupsdHoldJob()' - Hold the specified job.
766 cupsdHoldJob(cupsd_job_t
*job
) /* I - Job data */
768 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdHoldJob: id = %d", job
->id
);
770 if (job
->state_value
== IPP_JOB_PROCESSING
)
771 cupsdStopJob(job
, 0);
775 DEBUG_puts("cupsdHoldJob: setting state to held...");
777 job
->state
->values
[0].integer
= IPP_JOB_HELD
;
778 job
->state_value
= IPP_JOB_HELD
;
787 * 'cupsdLoadAllJobs()' - Load all jobs from disk.
791 cupsdLoadAllJobs(void)
793 char filename
[1024]; /* Full filename of job.cache file */
794 struct stat fileinfo
, /* Information on job.cache file */
795 dirinfo
; /* Information on RequestRoot dir */
800 * Create the job arrays as needed...
804 Jobs
= cupsArrayNew(compare_jobs
, NULL
);
807 ActiveJobs
= cupsArrayNew(compare_active_jobs
, NULL
);
810 * See whether the job.cache file is older than the RequestRoot directory...
813 snprintf(filename
, sizeof(filename
), "%s/job.cache", CacheDir
);
815 if (stat(filename
, &fileinfo
))
817 fileinfo
.st_mtime
= 0;
820 cupsdLogMessage(CUPSD_LOG_ERROR
,
821 "Unable to get file information for \"%s\" - %s",
822 filename
, strerror(errno
));
825 if (stat(RequestRoot
, &dirinfo
))
827 dirinfo
.st_mtime
= 0;
830 cupsdLogMessage(CUPSD_LOG_ERROR
,
831 "Unable to get directory information for \"%s\" - %s",
832 RequestRoot
, strerror(errno
));
836 * Load the most recent source for job data...
839 if (dirinfo
.st_mtime
> fileinfo
.st_mtime
)
843 load_next_job_id(filename
);
846 load_job_cache(filename
);
849 * Clean out old jobs as needed...
852 if (MaxJobs
> 0 && cupsArrayCount(Jobs
) >= MaxJobs
)
858 * 'cupsdLoadJob()' - Load a single job...
862 cupsdLoadJob(cupsd_job_t
*job
) /* I - Job */
864 char jobfile
[1024]; /* Job filename */
865 cups_file_t
*fp
; /* Job file */
866 int fileid
; /* Current file ID */
867 ipp_attribute_t
*attr
; /* Job attribute */
868 const char *dest
; /* Destination */
869 mime_type_t
**filetypes
; /* New filetypes array */
870 int *compressions
; /* New compressions array */
875 if (job
->state_value
> IPP_JOB_STOPPED
)
876 job
->access_time
= time(NULL
);
881 if ((job
->attrs
= ippNew()) == NULL
)
883 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for job attributes!");
888 * Load job attributes...
891 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Loading attributes for job %d...",
894 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, job
->id
);
895 if ((fp
= cupsFileOpen(jobfile
, "r")) == NULL
)
897 cupsdLogMessage(CUPSD_LOG_ERROR
,
898 "Unable to open job control file \"%s\" - %s!",
899 jobfile
, strerror(errno
));
900 ippDelete(job
->attrs
);
905 if (ippReadIO(fp
, (ipp_iocb_t
)cupsFileRead
, 1, NULL
, job
->attrs
) != IPP_DATA
)
907 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to read job control file \"%s\"!",
910 ippDelete(job
->attrs
);
919 * Copy attribute data to the job object...
922 if ((job
->state
= ippFindAttribute(job
->attrs
, "job-state",
923 IPP_TAG_ENUM
)) == NULL
)
925 cupsdLogMessage(CUPSD_LOG_ERROR
,
926 "Missing or bad job-state attribute in control "
929 ippDelete(job
->attrs
);
935 job
->state_value
= (ipp_jstate_t
)job
->state
->values
[0].integer
;
939 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
940 IPP_TAG_URI
)) == NULL
)
942 cupsdLogMessage(CUPSD_LOG_ERROR
,
943 "No job-printer-uri attribute in control file \"%s\"!",
945 ippDelete(job
->attrs
);
951 if ((dest
= cupsdValidateDest(attr
->values
[0].string
.text
, &(job
->dtype
),
954 cupsdLogMessage(CUPSD_LOG_ERROR
,
955 "Unable to queue job for destination \"%s\"!",
956 attr
->values
[0].string
.text
);
957 ippDelete(job
->attrs
);
963 cupsdSetString(&job
->dest
, dest
);
966 job
->sheets
= ippFindAttribute(job
->attrs
, "job-media-sheets-completed",
968 job
->job_sheets
= ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_NAME
);
972 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
973 IPP_TAG_INTEGER
)) == NULL
)
975 cupsdLogMessage(CUPSD_LOG_ERROR
,
976 "Missing or bad job-priority attribute in control "
977 "file \"%s\"!", jobfile
);
978 ippDelete(job
->attrs
);
984 job
->priority
= attr
->values
[0].integer
;
989 if ((attr
= ippFindAttribute(job
->attrs
, "job-originating-user-name",
990 IPP_TAG_NAME
)) == NULL
)
992 cupsdLogMessage(CUPSD_LOG_ERROR
,
993 "Missing or bad job-originating-user-name attribute "
994 "in control file \"%s\"!", jobfile
);
995 ippDelete(job
->attrs
);
1001 cupsdSetString(&job
->username
, attr
->values
[0].string
.text
);
1005 * Set the job hold-until time and state...
1008 if (job
->state_value
== IPP_JOB_HELD
)
1010 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
1011 IPP_TAG_KEYWORD
)) == NULL
)
1012 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
1015 cupsdSetJobHoldUntil(job
, attr
->values
[0].string
.text
);
1018 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1019 job
->state_value
= IPP_JOB_PENDING
;
1022 else if (job
->state_value
== IPP_JOB_PROCESSING
)
1024 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1025 job
->state_value
= IPP_JOB_PENDING
;
1028 if (!job
->num_files
)
1031 * Find all the d##### files...
1034 for (fileid
= 1; fileid
< 10000; fileid
++)
1036 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
1039 if (access(jobfile
, 0))
1042 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Auto-typing document file \"%s\"...",
1045 if (fileid
> job
->num_files
)
1047 if (job
->num_files
== 0)
1049 compressions
= (int *)calloc(fileid
, sizeof(int));
1050 filetypes
= (mime_type_t
**)calloc(fileid
, sizeof(mime_type_t
*));
1054 compressions
= (int *)realloc(job
->compressions
,
1055 sizeof(int) * fileid
);
1056 filetypes
= (mime_type_t
**)realloc(job
->filetypes
,
1057 sizeof(mime_type_t
*) *
1061 if (!compressions
|| !filetypes
)
1063 cupsdLogMessage(CUPSD_LOG_ERROR
,
1064 "Ran out of memory for job file types!");
1068 job
->compressions
= compressions
;
1069 job
->filetypes
= filetypes
;
1070 job
->num_files
= fileid
;
1073 job
->filetypes
[fileid
- 1] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
1074 job
->compressions
+ fileid
- 1);
1076 if (!job
->filetypes
[fileid
- 1])
1077 job
->filetypes
[fileid
- 1] = mimeType(MimeDatabase
, "application",
1082 job
->access_time
= time(NULL
);
1087 * 'cupsdMoveJob()' - Move the specified job to a different destination.
1091 cupsdMoveJob(cupsd_job_t
*job
, /* I - Job */
1092 cupsd_printer_t
*p
) /* I - Destination printer or class */
1094 ipp_attribute_t
*attr
; /* job-printer-uri attribute */
1095 const char *olddest
; /* Old destination */
1096 cupsd_printer_t
*oldp
; /* Old pointer */
1100 * Don't move completed jobs...
1103 if (job
->state_value
> IPP_JOB_STOPPED
)
1107 * Get the old destination...
1110 olddest
= job
->dest
;
1113 oldp
= job
->printer
;
1115 oldp
= cupsdFindDest(olddest
);
1118 * Change the destination information...
1123 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, oldp
, job
,
1124 "Job #%d moved from %s to %s.", job
->id
, olddest
,
1127 cupsdSetString(&job
->dest
, p
->name
);
1128 job
->dtype
= p
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_REMOTE
|
1129 CUPS_PRINTER_IMPLICIT
);
1131 if ((attr
= ippFindAttribute(job
->attrs
, "job-printer-uri",
1132 IPP_TAG_URI
)) != NULL
)
1133 cupsdSetString(&(attr
->values
[0].string
.text
), p
->uri
);
1135 cupsdAddEvent(CUPSD_EVENT_JOB_STOPPED
, p
, job
,
1136 "Job #%d moved from %s to %s.", job
->id
, olddest
,
1144 * 'cupsdReleaseJob()' - Release the specified job.
1148 cupsdReleaseJob(cupsd_job_t
*job
) /* I - Job */
1150 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdReleaseJob: id = %d", job
->id
);
1152 if (job
->state_value
== IPP_JOB_HELD
)
1154 DEBUG_puts("cupsdReleaseJob: setting state to pending...");
1156 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1157 job
->state_value
= IPP_JOB_PENDING
;
1165 * 'cupsdRestartJob()' - Restart the specified job.
1169 cupsdRestartJob(cupsd_job_t
*job
) /* I - Job */
1171 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdRestartJob: id = %d", job
->id
);
1173 if (job
->state_value
== IPP_JOB_STOPPED
|| job
->num_files
)
1178 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1179 job
->state_value
= IPP_JOB_PENDING
;
1187 * 'cupsdSaveAllJobs()' - Save a summary of all jobs to disk.
1191 cupsdSaveAllJobs(void)
1193 int i
; /* Looping var */
1194 cups_file_t
*fp
; /* Job cache file */
1195 char temp
[1024]; /* Temporary string */
1196 cupsd_job_t
*job
; /* Current job */
1197 time_t curtime
; /* Current time */
1198 struct tm
*curdate
; /* Current date */
1201 snprintf(temp
, sizeof(temp
), "%s/job.cache", CacheDir
);
1202 if ((fp
= cupsFileOpen(temp
, "w")) == NULL
)
1204 cupsdLogMessage(CUPSD_LOG_ERROR
,
1205 "Unable to create job cache file \"%s\" - %s",
1206 temp
, strerror(errno
));
1210 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving job cache file \"%s\"...", temp
);
1213 * Restrict access to the file...
1216 fchown(cupsFileNumber(fp
), getuid(), Group
);
1217 fchmod(cupsFileNumber(fp
), ConfigFilePerm
);
1220 * Write a small header to the file...
1223 curtime
= time(NULL
);
1224 curdate
= localtime(&curtime
);
1225 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
1227 cupsFilePuts(fp
, "# Job cache file for " CUPS_SVERSION
"\n");
1228 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
1229 cupsFilePrintf(fp
, "NextJobId %d\n", NextJobId
);
1232 * Write each job known to the system...
1235 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1237 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1239 cupsFilePrintf(fp
, "<Job %d>\n", job
->id
);
1240 cupsFilePrintf(fp
, "State %d\n", job
->state_value
);
1241 cupsFilePrintf(fp
, "Priority %d\n", job
->priority
);
1242 cupsFilePrintf(fp
, "Username %s\n", job
->username
);
1243 cupsFilePrintf(fp
, "Destination %s\n", job
->dest
);
1244 cupsFilePrintf(fp
, "DestType %d\n", job
->dtype
);
1245 cupsFilePrintf(fp
, "NumFiles %d\n", job
->num_files
);
1246 for (i
= 0; i
< job
->num_files
; i
++)
1247 cupsFilePrintf(fp
, "File %d %s/%s %d\n", i
+ 1, job
->filetypes
[i
]->super
,
1248 job
->filetypes
[i
]->type
, job
->compressions
[i
]);
1249 cupsFilePuts(fp
, "</Job>\n");
1257 * 'cupsdSaveJob()' - Save a job to disk.
1261 cupsdSaveJob(cupsd_job_t
*job
) /* I - Job */
1263 char filename
[1024]; /* Job control filename */
1264 cups_file_t
*fp
; /* Job file */
1267 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSaveJob(job=%p(%d)): job->attrs=%p",
1268 job
, job
->id
, job
->attrs
);
1270 snprintf(filename
, sizeof(filename
), "%s/c%05d", RequestRoot
, job
->id
);
1272 if ((fp
= cupsFileOpen(filename
, "w")) == NULL
)
1274 cupsdLogMessage(CUPSD_LOG_ERROR
,
1275 "Unable to create job control file \"%s\" - %s.",
1276 filename
, strerror(errno
));
1280 fchmod(cupsFileNumber(fp
), 0600);
1281 fchown(cupsFileNumber(fp
), RunUser
, Group
);
1283 job
->attrs
->state
= IPP_IDLE
;
1285 if (ippWriteIO(fp
, (ipp_iocb_t
)cupsFileWrite
, 1, NULL
,
1286 job
->attrs
) != IPP_DATA
)
1287 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to write job control file \"%s\"!",
1295 * 'cupsdSetJobHoldUntil()' - Set the hold time for a job...
1299 cupsdSetJobHoldUntil(cupsd_job_t
*job
, /* I - Job */
1300 const char *when
) /* I - When to resume */
1302 time_t curtime
; /* Current time */
1303 struct tm
*curdate
; /* Current date */
1304 int hour
; /* Hold hour */
1305 int minute
; /* Hold minute */
1306 int second
; /* Hold second */
1309 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil(%d, \"%s\")",
1314 if (!strcmp(when
, "indefinite") || !strcmp(when
, "authenticated"))
1317 * Hold indefinitely...
1320 job
->hold_until
= 0;
1322 else if (!strcmp(when
, "day-time"))
1325 * Hold to 6am the next morning unless local time is < 6pm.
1328 curtime
= time(NULL
);
1329 curdate
= localtime(&curtime
);
1331 if (curdate
->tm_hour
< 18)
1332 job
->hold_until
= curtime
;
1334 job
->hold_until
= curtime
+
1335 ((29 - curdate
->tm_hour
) * 60 + 59 -
1336 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
1338 else if (!strcmp(when
, "evening") || !strcmp(when
, "night"))
1341 * Hold to 6pm unless local time is > 6pm or < 6am.
1344 curtime
= time(NULL
);
1345 curdate
= localtime(&curtime
);
1347 if (curdate
->tm_hour
< 6 || curdate
->tm_hour
>= 18)
1348 job
->hold_until
= curtime
;
1350 job
->hold_until
= curtime
+
1351 ((17 - curdate
->tm_hour
) * 60 + 59 -
1352 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
1354 else if (!strcmp(when
, "second-shift"))
1357 * Hold to 4pm unless local time is > 4pm.
1360 curtime
= time(NULL
);
1361 curdate
= localtime(&curtime
);
1363 if (curdate
->tm_hour
>= 16)
1364 job
->hold_until
= curtime
;
1366 job
->hold_until
= curtime
+
1367 ((15 - curdate
->tm_hour
) * 60 + 59 -
1368 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
1370 else if (!strcmp(when
, "third-shift"))
1373 * Hold to 12am unless local time is < 8am.
1376 curtime
= time(NULL
);
1377 curdate
= localtime(&curtime
);
1379 if (curdate
->tm_hour
< 8)
1380 job
->hold_until
= curtime
;
1382 job
->hold_until
= curtime
+
1383 ((23 - curdate
->tm_hour
) * 60 + 59 -
1384 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
1386 else if (!strcmp(when
, "weekend"))
1389 * Hold to weekend unless we are in the weekend.
1392 curtime
= time(NULL
);
1393 curdate
= localtime(&curtime
);
1395 if (curdate
->tm_wday
|| curdate
->tm_wday
== 6)
1396 job
->hold_until
= curtime
;
1398 job
->hold_until
= curtime
+
1399 (((5 - curdate
->tm_wday
) * 24 +
1400 (17 - curdate
->tm_hour
)) * 60 + 59 -
1401 curdate
->tm_min
) * 60 + 60 - curdate
->tm_sec
;
1403 else if (sscanf(when
, "%d:%d:%d", &hour
, &minute
, &second
) >= 2)
1406 * Hold to specified GMT time (HH:MM or HH:MM:SS)...
1409 curtime
= time(NULL
);
1410 curdate
= gmtime(&curtime
);
1412 job
->hold_until
= curtime
+
1413 ((hour
- curdate
->tm_hour
) * 60 + minute
-
1414 curdate
->tm_min
) * 60 + second
- curdate
->tm_sec
;
1417 * Hold until next day as needed...
1420 if (job
->hold_until
< curtime
)
1421 job
->hold_until
+= 24 * 60 * 60 * 60;
1424 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdSetJobHoldUntil: hold_until = %d",
1425 (int)job
->hold_until
);
1430 * 'cupsdSetJobPriority()' - Set the priority of a job, moving it up/down in
1431 * the list as needed.
1435 cupsdSetJobPriority(
1436 cupsd_job_t
*job
, /* I - Job ID */
1437 int priority
) /* I - New priority (0 to 100) */
1439 ipp_attribute_t
*attr
; /* Job attribute */
1443 * Don't change completed jobs...
1446 if (job
->state_value
>= IPP_JOB_PROCESSING
)
1450 * Set the new priority and re-add the job into the active list...
1453 cupsArrayRemove(ActiveJobs
, job
);
1455 job
->priority
= priority
;
1457 if ((attr
= ippFindAttribute(job
->attrs
, "job-priority",
1458 IPP_TAG_INTEGER
)) != NULL
)
1459 attr
->values
[0].integer
= priority
;
1461 ippAddInteger(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "job-priority",
1464 cupsArrayAdd(ActiveJobs
, job
);
1471 * 'cupsdStopAllJobs()' - Stop all print jobs.
1475 cupsdStopAllJobs(void)
1477 cupsd_job_t
*job
; /* Current job */
1480 DEBUG_puts("cupsdStopAllJobs()");
1482 for (job
= (cupsd_job_t
*)cupsArrayFirst(ActiveJobs
);
1484 job
= (cupsd_job_t
*)cupsArrayNext(ActiveJobs
))
1485 if (job
->state_value
== IPP_JOB_PROCESSING
)
1487 cupsdStopJob(job
, 1);
1488 job
->state
->values
[0].integer
= IPP_JOB_PENDING
;
1489 job
->state_value
= IPP_JOB_PENDING
;
1495 * 'cupsdStopJob()' - Stop a print job.
1499 cupsdStopJob(cupsd_job_t
*job
, /* I - Job */
1500 int force
) /* I - 1 = Force all filters to stop */
1502 int i
; /* Looping var */
1505 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdStopJob: id = %d, force = %d",
1508 if (job
->state_value
!= IPP_JOB_PROCESSING
)
1511 FilterLevel
-= job
->cost
;
1513 if (job
->status
< 0 &&
1514 !(job
->dtype
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_IMPLICIT
)) &&
1515 !(job
->printer
->type
& CUPS_PRINTER_FAX
) &&
1516 !strcmp(job
->printer
->error_policy
, "stop-printer"))
1517 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_STOPPED
, 1);
1518 else if (job
->printer
->state
!= IPP_PRINTER_STOPPED
)
1519 cupsdSetPrinterState(job
->printer
, IPP_PRINTER_IDLE
, 0);
1521 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "cupsdStopJob: printer state is %d",
1522 job
->printer
->state
);
1524 job
->state
->values
[0].integer
= IPP_JOB_STOPPED
;
1525 job
->state_value
= IPP_JOB_STOPPED
;
1526 job
->printer
->job
= NULL
;
1527 job
->printer
= NULL
;
1529 job
->current_file
--;
1531 for (i
= 0; job
->filters
[i
]; i
++)
1532 if (job
->filters
[i
] > 0)
1534 cupsdEndProcess(job
->filters
[i
], force
);
1535 job
->filters
[i
] = 0;
1538 if (job
->backend
> 0)
1540 cupsdEndProcess(job
->backend
, force
);
1544 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
1545 "cupsdStopJob: Closing print pipes [ %d %d ]...",
1546 job
->print_pipes
[0], job
->print_pipes
[1]);
1548 cupsdClosePipe(job
->print_pipes
);
1550 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
1551 "cupsdStopJob: Closing back pipes [ %d %d ]...",
1552 job
->back_pipes
[0], job
->back_pipes
[1]);
1554 cupsdClosePipe(job
->back_pipes
);
1556 if (job
->status_buffer
)
1559 * Close the pipe and clear the input bit.
1562 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
1563 "cupsdStopJob: Removing fd %d from InputSet...",
1564 job
->status_buffer
->fd
);
1566 FD_CLR(job
->status_buffer
->fd
, InputSet
);
1568 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
1569 "cupsdStopJob: Closing status pipes [ %d %d ]...",
1570 job
->status_pipes
[0], job
->status_pipes
[1]);
1572 cupsdClosePipe(job
->status_pipes
);
1573 cupsdStatBufDelete(job
->status_buffer
);
1575 job
->status_buffer
= NULL
;
1581 * 'cupsdUnloadCompletedJobs()' - Flush completed job history from memory.
1585 cupsdUnloadCompletedJobs(void)
1587 cupsd_job_t
*job
; /* Current job */
1588 time_t expire
; /* Expiration time */
1591 expire
= time(NULL
) - 60;
1593 for (job
= (cupsd_job_t
*)cupsArrayFirst(Jobs
);
1595 job
= (cupsd_job_t
*)cupsArrayNext(Jobs
))
1596 if (job
->attrs
&& job
->state_value
>= IPP_JOB_STOPPED
&&
1597 job
->access_time
< expire
)
1603 * 'cupsdUpdateJob()' - Read a status update from a job's filters.
1607 cupsdUpdateJob(cupsd_job_t
*job
) /* I - Job to check */
1609 int i
; /* Looping var */
1610 int copies
; /* Number of copies printed */
1611 char message
[1024], /* Message text */
1612 *ptr
; /* Pointer update... */
1613 int loglevel
; /* Log level for message */
1616 while ((ptr
= cupsdStatBufUpdate(job
->status_buffer
, &loglevel
,
1617 message
, sizeof(message
))) != NULL
)
1620 * Process page and printer state messages as needed...
1623 if (loglevel
== CUPSD_LOG_PAGE
)
1626 * Page message; send the message to the page_log file and update the
1627 * job sheet count...
1630 if (job
->sheets
!= NULL
)
1632 if (!strncasecmp(message
, "total ", 6))
1635 * Got a total count of pages from a backend or filter...
1638 copies
= atoi(message
+ 6);
1639 copies
-= job
->sheets
->values
[0].integer
; /* Just track the delta */
1641 else if (!sscanf(message
, "%*d%d", &copies
))
1644 job
->sheets
->values
[0].integer
+= copies
;
1646 if (job
->printer
->page_limit
)
1647 cupsdUpdateQuota(job
->printer
, job
->username
, copies
, 0);
1650 cupsdLogPage(job
, message
);
1652 cupsdAddEvent(CUPSD_EVENT_JOB_PROGRESS
, job
->printer
, job
,
1653 "Printed %d page(s).", job
->sheets
->values
[0].integer
);
1655 else if (loglevel
== CUPSD_LOG_STATE
)
1657 cupsdSetPrinterReasons(job
->printer
, message
);
1658 cupsdAddPrinterHistory(job
->printer
);
1660 else if (loglevel
== CUPSD_LOG_ATTR
)
1663 * Set attribute(s)...
1669 else if (!strncmp(message
, "recoverable:", 12))
1671 cupsdSetPrinterReasons(job
->printer
,
1672 "+com.apple.print.recoverable-warning");
1675 while (isspace(*ptr
& 255))
1678 cupsdSetString(&job
->printer
->recoverable
, ptr
);
1679 cupsdAddPrinterHistory(job
->printer
);
1681 else if (!strncmp(message
, "recovered:", 10))
1683 cupsdSetPrinterReasons(job
->printer
,
1684 "-com.apple.print.recoverable-warning");
1687 while (isspace(*ptr
& 255))
1690 cupsdSetString(&job
->printer
->recoverable
, ptr
);
1691 cupsdAddPrinterHistory(job
->printer
);
1693 #endif /* __APPLE__ */
1694 else if (loglevel
<= CUPSD_LOG_INFO
)
1697 * Some message to show in the printer-state-message attribute...
1700 strlcpy(job
->printer
->state_message
, message
,
1701 sizeof(job
->printer
->state_message
));
1702 cupsdAddPrinterHistory(job
->printer
);
1705 if (!strchr(job
->status_buffer
->buffer
, '\n'))
1712 * See if all of the filters and the backend have returned their
1716 for (i
= 0; job
->filters
[i
] < 0; i
++);
1718 if (job
->filters
[i
])
1721 if (job
->current_file
>= job
->num_files
&& job
->backend
> 0)
1725 * Handle the end of job stuff...
1728 cupsdFinishJob(job
);
1734 * 'compare_active_jobs()' - Compare the job IDs and priorities of two jobs.
1737 static int /* O - Difference */
1738 compare_active_jobs(void *first
, /* I - First job */
1739 void *second
, /* I - Second job */
1740 void *data
) /* I - App data (not used) */
1742 int diff
; /* Difference */
1745 if ((diff
= ((cupsd_job_t
*)first
)->priority
-
1746 ((cupsd_job_t
*)second
)->priority
) != 0)
1749 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
1754 * 'compare_jobs()' - Compare the job IDs of two jobs.
1757 static int /* O - Difference */
1758 compare_jobs(void *first
, /* I - First job */
1759 void *second
, /* I - Second job */
1760 void *data
) /* I - App data (not used) */
1762 return (((cupsd_job_t
*)first
)->id
- ((cupsd_job_t
*)second
)->id
);
1767 * 'free_job()' - Free all memory used by a job.
1771 free_job(cupsd_job_t
*job
) /* I - Job */
1773 cupsdClearString(&job
->username
);
1774 cupsdClearString(&job
->dest
);
1776 if (job
->num_files
> 0)
1778 free(job
->compressions
);
1779 free(job
->filetypes
);
1782 ippDelete(job
->attrs
);
1789 * 'ipp_length()' - Compute the size of the buffer needed to hold
1790 * the textual IPP attributes.
1793 static int /* O - Size of attribute buffer */
1794 ipp_length(ipp_t
*ipp
) /* I - IPP request */
1796 int bytes
; /* Number of bytes */
1797 int i
; /* Looping var */
1798 ipp_attribute_t
*attr
; /* Current attribute */
1802 * Loop through all attributes...
1807 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
1810 * Skip attributes that won't be sent to filters...
1813 if (attr
->value_tag
== IPP_TAG_MIMETYPE
||
1814 attr
->value_tag
== IPP_TAG_NAMELANG
||
1815 attr
->value_tag
== IPP_TAG_TEXTLANG
||
1816 attr
->value_tag
== IPP_TAG_URI
||
1817 attr
->value_tag
== IPP_TAG_URISCHEME
)
1820 if (strncmp(attr
->name
, "time-", 5) == 0)
1824 * Add space for a leading space and commas between each value.
1825 * For the first attribute, the leading space isn't used, so the
1826 * extra byte can be used as the nul terminator...
1829 bytes
++; /* " " separator */
1830 bytes
+= attr
->num_values
; /* "," separators */
1833 * Boolean attributes appear as "foo,nofoo,foo,nofoo", while
1834 * other attributes appear as "foo=value1,value2,...,valueN".
1837 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
1838 bytes
+= strlen(attr
->name
);
1840 bytes
+= attr
->num_values
* strlen(attr
->name
);
1843 * Now add the size required for each value in the attribute...
1846 switch (attr
->value_tag
)
1848 case IPP_TAG_INTEGER
:
1851 * Minimum value of a signed integer is -2147483647, or 11 digits.
1854 bytes
+= attr
->num_values
* 11;
1857 case IPP_TAG_BOOLEAN
:
1859 * Add two bytes for each false ("no") value...
1862 for (i
= 0; i
< attr
->num_values
; i
++)
1863 if (!attr
->values
[i
].boolean
)
1867 case IPP_TAG_RANGE
:
1869 * A range is two signed integers separated by a hyphen, or
1870 * 23 characters max.
1873 bytes
+= attr
->num_values
* 23;
1876 case IPP_TAG_RESOLUTION
:
1878 * A resolution is two signed integers separated by an "x" and
1879 * suffixed by the units, or 26 characters max.
1882 bytes
+= attr
->num_values
* 26;
1885 case IPP_TAG_STRING
:
1888 case IPP_TAG_KEYWORD
:
1889 case IPP_TAG_CHARSET
:
1890 case IPP_TAG_LANGUAGE
:
1893 * Strings can contain characters that need quoting. We need
1894 * at least 2 * len + 2 characters to cover the quotes and
1895 * any backslashes in the string.
1898 for (i
= 0; i
< attr
->num_values
; i
++)
1899 bytes
+= 2 * strlen(attr
->values
[i
].string
.text
) + 2;
1903 break; /* anti-compiler-warning-code */
1912 * 'load_job_cache()' - Load jobs from the job.cache file.
1916 load_job_cache(const char *filename
) /* I - job.cache filename */
1918 cups_file_t
*fp
; /* job.cache file */
1919 char line
[1024], /* Line buffer */
1920 *value
; /* Value on line */
1921 int linenum
; /* Line number in file */
1922 cupsd_job_t
*job
; /* Current job */
1923 int jobid
; /* Job ID */
1924 char jobfile
[1024]; /* Job filename */
1928 * Open the job.cache file...
1931 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
1933 if (errno
!= ENOENT
)
1934 cupsdLogMessage(CUPSD_LOG_ERROR
,
1935 "Unable to open job cache file \"%s\": %s",
1936 filename
, strerror(errno
));
1938 load_request_root();
1944 * Read entries from the job cache file and create jobs as needed.
1947 cupsdLogMessage(CUPSD_LOG_INFO
, "Loading job cache file \"%s\"...",
1953 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
1955 if (!strcasecmp(line
, "NextJobId"))
1958 NextJobId
= atoi(value
);
1960 else if (!strcasecmp(line
, "<Job"))
1964 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing </Job> directive on line %d!",
1971 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing job ID on line %d!", linenum
);
1975 jobid
= atoi(value
);
1979 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad job ID %d on line %d!", jobid
,
1984 snprintf(jobfile
, sizeof(jobfile
), "%s/c%05d", RequestRoot
, jobid
);
1985 if (access(jobfile
, 0))
1987 cupsdLogMessage(CUPSD_LOG_ERROR
, "Job %d files have gone away!", jobid
);
1991 job
= calloc(1, sizeof(cupsd_job_t
));
1994 cupsdLogMessage(CUPSD_LOG_EMERG
,
1995 "Unable to allocate memory for job %d!", jobid
);
2000 job
->back_pipes
[0] = -1;
2001 job
->back_pipes
[1] = -1;
2002 job
->print_pipes
[0] = -1;
2003 job
->print_pipes
[1] = -1;
2004 job
->status_pipes
[0] = -1;
2005 job
->status_pipes
[1] = -1;
2007 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Loading job %d from cache...", job
->id
);
2011 cupsdLogMessage(CUPSD_LOG_ERROR
,
2012 "Missing <Job #> directive on line %d!", linenum
);
2015 else if (!strcasecmp(line
, "</Job>"))
2017 cupsArrayAdd(Jobs
, job
);
2019 if (job
->state_value
<= IPP_JOB_STOPPED
)
2021 cupsArrayAdd(ActiveJobs
, job
);
2029 cupsdLogMessage(CUPSD_LOG_ERROR
, "Missing value on line %d!", linenum
);
2032 else if (!strcasecmp(line
, "State"))
2034 job
->state_value
= atoi(value
);
2036 if (job
->state_value
< IPP_JOB_PENDING
)
2037 job
->state_value
= IPP_JOB_PENDING
;
2038 else if (job
->state_value
> IPP_JOB_COMPLETED
)
2039 job
->state_value
= IPP_JOB_COMPLETED
;
2041 else if (!strcasecmp(line
, "Priority"))
2043 job
->priority
= atoi(value
);
2045 else if (!strcasecmp(line
, "Username"))
2047 cupsdSetString(&job
->username
, value
);
2049 else if (!strcasecmp(line
, "Destination"))
2051 cupsdSetString(&job
->dest
, value
);
2053 else if (!strcasecmp(line
, "DestType"))
2055 job
->dtype
= (cups_ptype_t
)atoi(value
);
2057 else if (!strcasecmp(line
, "NumFiles"))
2059 job
->num_files
= atoi(value
);
2061 if (job
->num_files
< 0)
2063 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad NumFiles value %d on line %d!",
2064 job
->num_files
, linenum
);
2069 if (job
->num_files
> 0)
2071 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-001", RequestRoot
,
2073 if (access(jobfile
, 0))
2075 cupsdLogMessage(CUPSD_LOG_INFO
,
2076 "Data files for job %d have gone away!", job
->id
);
2081 job
->filetypes
= calloc(job
->num_files
, sizeof(mime_type_t
*));
2082 job
->compressions
= calloc(job
->num_files
, sizeof(int));
2084 if (!job
->filetypes
|| !job
->compressions
)
2086 cupsdLogMessage(CUPSD_LOG_EMERG
,
2087 "Unable to allocate memory for %d files!",
2093 else if (!strcasecmp(line
, "File"))
2095 int number
, /* File number */
2096 compression
; /* Compression value */
2097 char super
[MIME_MAX_SUPER
], /* MIME super type */
2098 type
[MIME_MAX_TYPE
]; /* MIME type */
2101 if (sscanf(value
, "%d%*[ \t]%15[^/]/%255s%d", &number
, super
, type
,
2104 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File on line %d!", linenum
);
2108 if (number
< 1 || number
> job
->num_files
)
2110 cupsdLogMessage(CUPSD_LOG_ERROR
, "Bad File number %d on line %d!",
2117 job
->compressions
[number
] = compression
;
2118 job
->filetypes
[number
] = mimeType(MimeDatabase
, super
, type
);
2120 if (!job
->filetypes
[number
])
2123 * If the original MIME type is unknown, auto-type it!
2126 cupsdLogMessage(CUPSD_LOG_ERROR
,
2127 "Unknown MIME type %s/%s for file %d of job %d!",
2128 super
, type
, number
+ 1, job
->id
);
2130 snprintf(jobfile
, sizeof(jobfile
), "%s/d%05d-%03d", RequestRoot
,
2131 job
->id
, number
+ 1);
2132 job
->filetypes
[number
] = mimeFileType(MimeDatabase
, jobfile
, NULL
,
2133 job
->compressions
+ number
);
2136 * If that didn't work, assume it is raw...
2139 if (!job
->filetypes
[number
])
2140 job
->filetypes
[number
] = mimeType(MimeDatabase
, "application",
2145 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unknown %s directive on line %d!",
2154 * 'load_next_job_id()' - Load the NextJobId value from the job.cache file.
2158 load_next_job_id(const char *filename
) /* I - job.cache filename */
2160 cups_file_t
*fp
; /* job.cache file */
2161 char line
[1024], /* Line buffer */
2162 *value
; /* Value on line */
2163 int linenum
; /* Line number in file */
2164 int next_job_id
; /* NextJobId value from line */
2168 * Read the NextJobId directive from the job.cache file and use
2169 * the value (if any).
2172 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
2174 if (errno
!= ENOENT
)
2175 cupsdLogMessage(CUPSD_LOG_ERROR
,
2176 "Unable to open job cache file \"%s\": %s",
2177 filename
, strerror(errno
));
2182 cupsdLogMessage(CUPSD_LOG_INFO
,
2183 "Loading NextJobId from job cache file \"%s\"...", filename
);
2187 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
2189 if (!strcasecmp(line
, "NextJobId"))
2193 next_job_id
= atoi(value
);
2195 if (next_job_id
> NextJobId
)
2196 NextJobId
= next_job_id
;
2207 * 'load_request_root()' - Load jobs from the RequestRoot directory.
2211 load_request_root(void)
2213 cups_dir_t
*dir
; /* Directory */
2214 cups_dentry_t
*dent
; /* Directory entry */
2215 cupsd_job_t
*job
; /* New job */
2219 * Open the requests directory...
2222 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Scanning %s for jobs...", RequestRoot
);
2224 if ((dir
= cupsDirOpen(RequestRoot
)) == NULL
)
2226 cupsdLogMessage(CUPSD_LOG_ERROR
,
2227 "Unable to open spool directory \"%s\": %s",
2228 RequestRoot
, strerror(errno
));
2233 * Read all the c##### files...
2236 while ((dent
= cupsDirRead(dir
)) != NULL
)
2237 if (strlen(dent
->filename
) >= 6 && dent
->filename
[0] == 'c')
2240 * Allocate memory for the job...
2243 if ((job
= calloc(sizeof(cupsd_job_t
), 1)) == NULL
)
2245 cupsdLogMessage(CUPSD_LOG_ERROR
, "Ran out of memory for jobs!");
2251 * Assign the job ID...
2254 job
->id
= atoi(dent
->filename
+ 1);
2255 job
->back_pipes
[0] = -1;
2256 job
->back_pipes
[1] = -1;
2257 job
->print_pipes
[0] = -1;
2258 job
->print_pipes
[1] = -1;
2259 job
->status_pipes
[0] = -1;
2260 job
->status_pipes
[1] = -1;
2262 if (job
->id
>= NextJobId
)
2263 NextJobId
= job
->id
+ 1;
2272 * Insert the job into the array, sorting by job priority and ID...
2275 cupsArrayAdd(Jobs
, job
);
2277 if (job
->state_value
<= IPP_JOB_STOPPED
)
2278 cupsArrayAdd(ActiveJobs
,job
);
2288 * 'set_time()' - Set one of the "time-at-xyz" attributes...
2292 set_time(cupsd_job_t
*job
, /* I - Job to update */
2293 const char *name
) /* I - Name of attribute */
2295 ipp_attribute_t
*attr
; /* Time attribute */
2298 if ((attr
= ippFindAttribute(job
->attrs
, name
, IPP_TAG_ZERO
)) != NULL
)
2300 attr
->value_tag
= IPP_TAG_INTEGER
;
2301 attr
->values
[0].integer
= time(NULL
);
2307 * 'set_hold_until()' - Set the hold time and update job-hold-until attribute...
2311 set_hold_until(cupsd_job_t
*job
, /* I - Job to update */
2312 time_t holdtime
) /* I - Hold until time */
2314 ipp_attribute_t
*attr
; /* job-hold-until attribute */
2315 struct tm
*holddate
; /* Hold date */
2316 char holdstr
[64]; /* Hold time */
2320 * Set the hold_until value and hold the job...
2323 cupsdLogMessage(CUPSD_LOG_DEBUG
, "set_hold_until: hold_until = %d",
2326 job
->state
->values
[0].integer
= IPP_JOB_HELD
;
2327 job
->state_value
= IPP_JOB_HELD
;
2328 job
->hold_until
= holdtime
;
2331 * Update the job-hold-until attribute with a string representing GMT
2332 * time (HH:MM:SS)...
2335 holddate
= gmtime(&holdtime
);
2336 snprintf(holdstr
, sizeof(holdstr
), "%d:%d:%d", holddate
->tm_hour
,
2337 holddate
->tm_min
, holddate
->tm_sec
);
2339 if ((attr
= ippFindAttribute(job
->attrs
, "job-hold-until",
2340 IPP_TAG_KEYWORD
)) == NULL
)
2341 attr
= ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
);
2344 * Either add the attribute or update the value of the existing one
2348 attr
= ippAddString(job
->attrs
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2349 "job-hold-until", NULL
, holdstr
);
2351 cupsdSetString(&attr
->values
[0].string
.text
, holdstr
);
2358 * 'start_job()' - Start a print job.
2362 start_job(cupsd_job_t
*job
, /* I - Job ID */
2363 cupsd_printer_t
*printer
) /* I - Printer to print job */
2365 int i
; /* Looping var */
2366 int slot
; /* Pipe slot */
2367 cups_array_t
*filters
; /* Filters for job */
2368 mime_filter_t
*filter
, /* Current filter */
2369 port_monitor
; /* Port monitor filter */
2370 char method
[255], /* Method for output */
2371 *optptr
, /* Pointer to options */
2372 *valptr
; /* Pointer in value string */
2373 ipp_attribute_t
*attr
; /* Current attribute */
2374 struct stat backinfo
; /* Backend file information */
2375 int backroot
; /* Run backend as root? */
2376 int pid
; /* Process ID of new filter process */
2377 int banner_page
; /* 1 if banner page, 0 otherwise */
2378 int filterfds
[2][2];/* Pipes used between filters */
2379 int envc
; /* Number of environment variables */
2380 char **argv
, /* Filter command-line arguments */
2381 sani_uri
[1024], /* Sanitized DEVICE_URI env var */
2382 filename
[1024], /* Job filename */
2383 command
[1024], /* Full path to command */
2384 jobid
[255], /* Job ID string */
2385 title
[IPP_MAX_NAME
],
2386 /* Job title string */
2387 copies
[255], /* # copies string */
2388 *envp
[MAX_ENV
+ 11],
2389 /* Environment variables */
2390 charset
[255], /* CHARSET env variable */
2391 class_name
[255],/* CLASS env variable */
2392 classification
[1024],
2393 /* CLASSIFICATION env variable */
2395 /* CONTENT_TYPE env variable */
2397 /* DEVICE_URI env variable */
2398 final_content_type
[1024],
2399 /* FINAL_CONTENT_TYPE env variable */
2400 lang
[255], /* LANG env variable */
2401 ppd
[1024], /* PPD env variable */
2403 /* PRINTER env variable */
2405 /* RIP_MAX_CACHE env variable */
2406 int remote_job
; /* Remote print job? */
2407 static char *options
= NULL
;/* Full list of options */
2408 static int optlength
= 0; /* Length of option buffer */
2411 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job: id = %d, file = %d/%d",
2412 job
->id
, job
->current_file
, job
->num_files
);
2414 if (job
->num_files
== 0)
2416 cupsdLogMessage(CUPSD_LOG_ERROR
, "Job ID %d has no files! Cancelling it!",
2419 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
2420 "Job canceled because it has no files.");
2422 cupsdCancelJob(job
, 0);
2426 if (printer
->raw
&& !strncmp(printer
->device_uri
, "file:", 5))
2428 cupsdLogMessage(CUPSD_LOG_ERROR
,
2429 "Job ID %d cannot be printed to raw queue pointing to "
2433 strlcpy(printer
->state_message
, "Raw printers cannot use file: devices!",
2434 sizeof(printer
->state_message
));
2435 cupsdStopPrinter(printer
, 1);
2436 cupsdAddPrinterHistory(printer
);
2441 * Figure out what filters are required to convert from
2442 * the source to the destination type...
2451 * Remote jobs and raw queues go directly to the printer without
2455 cupsdLogMessage(CUPSD_LOG_DEBUG
,
2456 "[Job %d] Sending job to queue tagged as raw...", job
->id
);
2463 * Local jobs get filtered...
2466 filters
= mimeFilter(MimeDatabase
, job
->filetypes
[job
->current_file
],
2467 printer
->filetype
, &(job
->cost
));
2471 cupsdLogMessage(CUPSD_LOG_ERROR
,
2472 "Unable to convert file %d to printable format for "
2474 job
->current_file
, job
->id
);
2475 cupsdLogMessage(CUPSD_LOG_INFO
,
2476 "Hint: Do you have ESP Ghostscript installed?");
2478 if (LogLevel
< CUPSD_LOG_DEBUG
)
2479 cupsdLogMessage(CUPSD_LOG_INFO
,
2480 "Hint: Try setting the LogLevel to \"debug\".");
2482 job
->current_file
++;
2484 if (job
->current_file
== job
->num_files
)
2486 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
2487 "Job canceled because it has no files that can be "
2490 cupsdCancelJob(job
, 0);
2497 * Remove NULL ("-") filters...
2500 for (filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
2502 filter
= (mime_filter_t
*)cupsArrayNext(filters
))
2503 if (!strcmp(filter
->filter
, "-"))
2504 cupsArrayRemove(filters
, filter
);
2506 if (cupsArrayCount(filters
) == 0)
2508 cupsArrayDelete(filters
);
2514 * Set a minimum cost of 100 for all jobs so that FilterLimit
2515 * works with raw queues and other low-cost paths.
2518 if (job
->cost
< 100)
2522 * See if the filter cost is too high...
2525 if ((FilterLevel
+ job
->cost
) > FilterLimit
&& FilterLevel
> 0 &&
2529 * Don't print this job quite yet...
2532 cupsArrayDelete(filters
);
2534 cupsdLogMessage(CUPSD_LOG_INFO
,
2535 "Holding job %d because filter limit has been reached.",
2537 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
2538 "start_job: id=%d, file=%d, cost=%d, level=%d, "
2540 job
->id
, job
->current_file
, job
->cost
, FilterLevel
,
2545 FilterLevel
+= job
->cost
;
2548 * Determine if we are printing to a remote printer...
2551 remote_job
= printer
->raw
&& job
->num_files
> 1 &&
2552 !strncmp(printer
->device_uri
, "ipp://", 6);
2555 * Add decompression filters, if any...
2558 if (!remote_job
&& job
->compressions
[job
->current_file
])
2561 * Add gziptoany filter to the front of the list...
2564 if (!cupsArrayInsert(filters
, &gziptoany_filter
))
2566 cupsdLogMessage(CUPSD_LOG_ERROR
,
2567 "Unable to add decompression filter - %s",
2570 cupsArrayDelete(filters
);
2572 job
->current_file
++;
2574 if (job
->current_file
== job
->num_files
)
2576 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
2577 "Job canceled because the print file could not be "
2580 cupsdCancelJob(job
, 0);
2588 * Add port monitor, if any...
2591 if (printer
->port_monitor
)
2594 * Add port monitor to the end of the list...
2597 if (!cupsArrayAdd(filters
, &port_monitor
))
2599 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to add port monitor - %s",
2602 cupsArrayDelete(filters
);
2604 job
->current_file
++;
2606 if (job
->current_file
== job
->num_files
)
2608 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
2609 "Job canceled because the port monitor could not be "
2612 cupsdCancelJob(job
, 0);
2618 snprintf(port_monitor
.filter
, sizeof(port_monitor
.filter
),
2619 "%s/monitor/%s", ServerBin
, printer
->port_monitor
);
2623 * Update the printer and job state to "processing"...
2626 job
->state
->values
[0].integer
= IPP_JOB_PROCESSING
;
2627 job
->state_value
= IPP_JOB_PROCESSING
;
2629 job
->printer
= printer
;
2631 cupsdSetPrinterState(printer
, IPP_PRINTER_PROCESSING
, 0);
2633 if (job
->current_file
== 0)
2636 * Set the processing time...
2639 set_time(job
, "time-at-processing");
2642 * Create the backchannel pipes and make them non-blocking...
2645 cupsdOpenPipe(job
->back_pipes
);
2647 fcntl(job
->back_pipes
[0], F_SETFL
,
2648 fcntl(job
->back_pipes
[0], F_GETFL
) | O_NONBLOCK
);
2650 fcntl(job
->back_pipes
[1], F_SETFL
,
2651 fcntl(job
->back_pipes
[1], F_GETFL
) | O_NONBLOCK
);
2655 * Determine if we are printing a banner page or not...
2658 if (job
->job_sheets
== NULL
)
2660 cupsdLogMessage(CUPSD_LOG_DEBUG
, "No job-sheets attribute.");
2661 if ((job
->job_sheets
=
2662 ippFindAttribute(job
->attrs
, "job-sheets", IPP_TAG_ZERO
)) != NULL
)
2663 cupsdLogMessage(CUPSD_LOG_DEBUG
,
2664 "... but someone added one without setting job_sheets!");
2666 else if (job
->job_sheets
->num_values
== 1)
2667 cupsdLogMessage(CUPSD_LOG_DEBUG
, "job-sheets=%s",
2668 job
->job_sheets
->values
[0].string
.text
);
2670 cupsdLogMessage(CUPSD_LOG_DEBUG
, "job-sheets=%s,%s",
2671 job
->job_sheets
->values
[0].string
.text
,
2672 job
->job_sheets
->values
[1].string
.text
);
2674 if (printer
->type
& (CUPS_PRINTER_REMOTE
| CUPS_PRINTER_IMPLICIT
))
2676 else if (job
->job_sheets
== NULL
)
2678 else if (strcasecmp(job
->job_sheets
->values
[0].string
.text
, "none") != 0 &&
2679 job
->current_file
== 0)
2681 else if (job
->job_sheets
->num_values
> 1 &&
2682 strcasecmp(job
->job_sheets
->values
[1].string
.text
, "none") != 0 &&
2683 job
->current_file
== (job
->num_files
- 1))
2688 cupsdLogMessage(CUPSD_LOG_DEBUG
, "banner_page = %d", banner_page
);
2691 * Building the options string is harder than it needs to be, but
2692 * for the moment we need to pass strings for command-line args and
2693 * not IPP attribute pointers... :)
2695 * First allocate/reallocate the option buffer as needed...
2698 i
= ipp_length(job
->attrs
);
2705 optptr
= realloc(options
, i
);
2709 cupsdLogMessage(CUPSD_LOG_CRIT
,
2710 "Unable to allocate %d bytes for option buffer for "
2711 "job %d!", i
, job
->id
);
2713 cupsArrayDelete(filters
);
2715 FilterLevel
-= job
->cost
;
2717 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
2718 "Job canceled because the server ran out of memory.");
2720 cupsdCancelJob(job
, 0);
2729 * Now loop through the attributes and convert them to the textual
2730 * representation used by the filters...
2736 snprintf(title
, sizeof(title
), "%s-%d", printer
->name
, job
->id
);
2737 strcpy(copies
, "1");
2739 for (attr
= job
->attrs
->attrs
; attr
!= NULL
; attr
= attr
->next
)
2741 if (!strcmp(attr
->name
, "copies") &&
2742 attr
->value_tag
== IPP_TAG_INTEGER
)
2745 * Don't use the # copies attribute if we are printing the job sheets...
2749 sprintf(copies
, "%d", attr
->values
[0].integer
);
2751 else if (!strcmp(attr
->name
, "job-name") &&
2752 (attr
->value_tag
== IPP_TAG_NAME
||
2753 attr
->value_tag
== IPP_TAG_NAMELANG
))
2754 strlcpy(title
, attr
->values
[0].string
.text
, sizeof(title
));
2755 else if (attr
->group_tag
== IPP_TAG_JOB
)
2758 * Filter out other unwanted attributes...
2761 if (attr
->value_tag
== IPP_TAG_MIMETYPE
||
2762 attr
->value_tag
== IPP_TAG_NAMELANG
||
2763 attr
->value_tag
== IPP_TAG_TEXTLANG
||
2764 (attr
->value_tag
== IPP_TAG_URI
&& strcmp(attr
->name
, "job-uuid")) ||
2765 attr
->value_tag
== IPP_TAG_URISCHEME
||
2766 attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
) /* Not yet supported */
2769 if (!strncmp(attr
->name
, "time-", 5))
2772 if (!strncmp(attr
->name
, "job-", 4) && strcmp(attr
->name
, "job-uuid") &&
2773 !(printer
->type
& CUPS_PRINTER_REMOTE
))
2776 if (!strncmp(attr
->name
, "job-", 4) &&
2777 strcmp(attr
->name
, "job-uuid") &&
2778 strcmp(attr
->name
, "job-billing") &&
2779 strcmp(attr
->name
, "job-sheets") &&
2780 strcmp(attr
->name
, "job-hold-until") &&
2781 strcmp(attr
->name
, "job-priority"))
2784 if ((!strcmp(attr
->name
, "page-label") ||
2785 !strcmp(attr
->name
, "page-border") ||
2786 !strncmp(attr
->name
, "number-up", 9) ||
2787 !strcmp(attr
->name
, "page-set") ||
2788 !strcasecmp(attr
->name
, "AP_FIRSTPAGE_InputSlot") ||
2789 !strcasecmp(attr
->name
, "AP_FIRSTPAGE_ManualFeed")) &&
2794 * Otherwise add them to the list...
2797 if (optptr
> options
)
2798 strlcat(optptr
, " ", optlength
- (optptr
- options
));
2800 if (attr
->value_tag
!= IPP_TAG_BOOLEAN
)
2802 strlcat(optptr
, attr
->name
, optlength
- (optptr
- options
));
2803 strlcat(optptr
, "=", optlength
- (optptr
- options
));
2806 for (i
= 0; i
< attr
->num_values
; i
++)
2809 strlcat(optptr
, ",", optlength
- (optptr
- options
));
2811 optptr
+= strlen(optptr
);
2813 switch (attr
->value_tag
)
2815 case IPP_TAG_INTEGER
:
2817 snprintf(optptr
, optlength
- (optptr
- options
),
2818 "%d", attr
->values
[i
].integer
);
2821 case IPP_TAG_BOOLEAN
:
2822 if (!attr
->values
[i
].boolean
)
2823 strlcat(optptr
, "no", optlength
- (optptr
- options
));
2825 case IPP_TAG_NOVALUE
:
2826 strlcat(optptr
, attr
->name
,
2827 optlength
- (optptr
- options
));
2830 case IPP_TAG_RANGE
:
2831 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
2832 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
2833 "%d", attr
->values
[i
].range
.lower
);
2835 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
2836 "%d-%d", attr
->values
[i
].range
.lower
,
2837 attr
->values
[i
].range
.upper
);
2840 case IPP_TAG_RESOLUTION
:
2841 snprintf(optptr
, optlength
- (optptr
- options
) - 1,
2842 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
2843 attr
->values
[i
].resolution
.yres
,
2844 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
2848 case IPP_TAG_STRING
:
2851 case IPP_TAG_KEYWORD
:
2852 case IPP_TAG_CHARSET
:
2853 case IPP_TAG_LANGUAGE
:
2855 for (valptr
= attr
->values
[i
].string
.text
; *valptr
;)
2857 if (strchr(" \t\n\\\'\"", *valptr
))
2859 *optptr
++ = *valptr
++;
2866 break; /* anti-compiler-warning-code */
2870 optptr
+= strlen(optptr
);
2875 * Build the command-line arguments for the filters. Each filter
2876 * has 6 or 7 arguments:
2880 * argv[2] = username
2882 * argv[4] = # copies
2884 * argv[6] = filename (optional; normally stdin)
2886 * This allows legacy printer drivers that use the old System V
2887 * printing interface to be used by CUPS.
2889 * For remote jobs, we send all of the files in the argument list.
2893 argv
= calloc(7 + job
->num_files
, sizeof(char *));
2895 argv
= calloc(8, sizeof(char *));
2897 sprintf(jobid
, "%d", job
->id
);
2899 argv
[0] = printer
->name
;
2901 argv
[2] = job
->username
;
2908 for (i
= 0; i
< job
->num_files
; i
++)
2910 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
2912 argv
[6 + i
] = strdup(filename
);
2917 snprintf(filename
, sizeof(filename
), "%s/d%05d-%03d", RequestRoot
,
2918 job
->id
, job
->current_file
+ 1);
2922 for (i
= 0; argv
[i
]; i
++)
2923 cupsdLogMessage(CUPSD_LOG_DEBUG
,
2924 "[Job %d] argv[%d]=\"%s\"", job
->id
, i
, argv
[i
]);
2927 * Create environment variable strings for the filters...
2930 attr
= ippFindAttribute(job
->attrs
, "attributes-natural-language",
2933 switch (strlen(attr
->values
[0].string
.text
))
2937 * This is an unknown or badly formatted language code; use
2938 * the POSIX locale...
2941 strcpy(lang
, "LANG=C");
2946 * Just the language code (ll)...
2949 snprintf(lang
, sizeof(lang
), "LANG=%s",
2950 attr
->values
[0].string
.text
);
2955 * Language and country code (ll-cc)...
2958 snprintf(lang
, sizeof(lang
), "LANG=%c%c_%c%c",
2959 attr
->values
[0].string
.text
[0],
2960 attr
->values
[0].string
.text
[1],
2961 toupper(attr
->values
[0].string
.text
[3] & 255),
2962 toupper(attr
->values
[0].string
.text
[4] & 255));
2966 attr
= ippFindAttribute(job
->attrs
, "document-format",
2969 (optptr
= strstr(attr
->values
[0].string
.text
, "charset=")) != NULL
)
2970 snprintf(charset
, sizeof(charset
), "CHARSET=%s", optptr
+ 8);
2973 attr
= ippFindAttribute(job
->attrs
, "attributes-charset",
2975 snprintf(charset
, sizeof(charset
), "CHARSET=%s",
2976 attr
->values
[0].string
.text
);
2979 snprintf(content_type
, sizeof(content_type
), "CONTENT_TYPE=%s/%s",
2980 job
->filetypes
[job
->current_file
]->super
,
2981 job
->filetypes
[job
->current_file
]->type
);
2982 snprintf(device_uri
, sizeof(device_uri
), "DEVICE_URI=%s",
2983 printer
->device_uri
);
2984 cupsdSanitizeURI(printer
->device_uri
, sani_uri
, sizeof(sani_uri
));
2985 snprintf(ppd
, sizeof(ppd
), "PPD=%s/ppd/%s.ppd", ServerRoot
, printer
->name
);
2986 snprintf(printer_name
, sizeof(printer_name
), "PRINTER=%s", printer
->name
);
2987 snprintf(rip_max_cache
, sizeof(rip_max_cache
), "RIP_MAX_CACHE=%s", RIPCache
);
2989 envc
= cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
2991 envp
[envc
++] = charset
;
2992 envp
[envc
++] = lang
;
2993 envp
[envc
++] = ppd
;
2994 envp
[envc
++] = rip_max_cache
;
2995 envp
[envc
++] = content_type
;
2996 envp
[envc
++] = device_uri
;
2997 envp
[envc
++] = printer_name
;
2999 if ((filter
= (mime_filter_t
*)cupsArrayLast(filters
)) != NULL
)
3001 snprintf(final_content_type
, sizeof(final_content_type
),
3002 "FINAL_CONTENT_TYPE=%s/%s",
3003 filter
->dst
->super
, filter
->dst
->type
);
3004 envp
[envc
++] = final_content_type
;
3007 if (Classification
&& !banner_page
)
3009 if ((attr
= ippFindAttribute(job
->attrs
, "job-sheets",
3010 IPP_TAG_NAME
)) == NULL
)
3011 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
3013 else if (attr
->num_values
> 1 &&
3014 strcmp(attr
->values
[1].string
.text
, "none") != 0)
3015 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
3016 attr
->values
[1].string
.text
);
3018 snprintf(classification
, sizeof(classification
), "CLASSIFICATION=%s",
3019 attr
->values
[0].string
.text
);
3021 envp
[envc
++] = classification
;
3024 if (job
->dtype
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_IMPLICIT
))
3026 snprintf(class_name
, sizeof(class_name
), "CLASS=%s", job
->dest
);
3027 envp
[envc
++] = class_name
;
3032 for (i
= 0; i
< envc
; i
++)
3033 if (strncmp(envp
[i
], "DEVICE_URI=", 11))
3034 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] envp[%d]=\"%s\"",
3035 job
->id
, i
, envp
[i
]);
3037 cupsdLogMessage(CUPSD_LOG_DEBUG
, "[Job %d] envp[%d]=\"DEVICE_URI=%s\"",
3038 job
->id
, i
, sani_uri
);
3041 job
->current_file
= job
->num_files
;
3043 job
->current_file
++;
3046 * Now create processes for all of the filters...
3049 filterfds
[0][0] = -1;
3050 filterfds
[0][1] = -1;
3051 filterfds
[1][0] = -1;
3052 filterfds
[1][1] = -1;
3054 if (!job
->status_buffer
)
3056 if (cupsdOpenPipe(job
->status_pipes
))
3058 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to create job status pipes - %s.",
3060 snprintf(printer
->state_message
, sizeof(printer
->state_message
),
3061 "Unable to create status pipes - %s.", strerror(errno
));
3063 cupsdAddPrinterHistory(printer
);
3065 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
3066 "Job canceled because the server could not create the job "
3072 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job: status_pipes = [ %d %d ]",
3073 job
->status_pipes
[0], job
->status_pipes
[1]);
3075 job
->status_buffer
= cupsdStatBufNew(job
->status_pipes
[0], "[Job %d]",
3080 memset(job
->filters
, 0, sizeof(job
->filters
));
3082 filterfds
[1][0] = open("/dev/null", O_RDONLY
);
3084 if (filterfds
[1][0] < 0)
3086 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to open \"/dev/null\" - %s.",
3088 snprintf(printer
->state_message
, sizeof(printer
->state_message
),
3089 "Unable to open \"/dev/null\" - %s.", strerror(errno
));
3091 cupsdAddPrinterHistory(printer
);
3093 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
3094 "Job canceled because the server could not open /dev/null.");
3099 fcntl(filterfds
[1][0], F_SETFD
, fcntl(filterfds
[1][0], F_GETFD
) | FD_CLOEXEC
);
3101 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job: filterfds[%d] = [ %d %d ]",
3102 1, filterfds
[1][0], filterfds
[1][1]);
3104 for (i
= 0, slot
= 0, filter
= (mime_filter_t
*)cupsArrayFirst(filters
);
3106 i
++, filter
= (mime_filter_t
*)cupsArrayNext(filters
))
3108 if (filter
->filter
[0] != '/')
3109 snprintf(command
, sizeof(command
), "%s/filter/%s", ServerBin
,
3112 strlcpy(command
, filter
->filter
, sizeof(command
));
3114 if (i
< (cupsArrayCount(filters
) - 1))
3116 if (cupsdOpenPipe(filterfds
[slot
]))
3118 cupsdLogMessage(CUPSD_LOG_ERROR
,
3119 "Unable to create job filter pipes - %s.",
3121 snprintf(printer
->state_message
, sizeof(printer
->state_message
),
3122 "Unable to create filter pipes - %s.", strerror(errno
));
3123 cupsdAddPrinterHistory(printer
);
3125 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
3126 "Job canceled because the server could not create the "
3134 if (job
->current_file
== 1)
3136 if (strncmp(printer
->device_uri
, "file:", 5) != 0)
3138 if (cupsdOpenPipe(job
->print_pipes
))
3140 cupsdLogMessage(CUPSD_LOG_ERROR
,
3141 "Unable to create job backend pipes - %s.",
3143 snprintf(printer
->state_message
, sizeof(printer
->state_message
),
3144 "Unable to create backend pipes - %s.", strerror(errno
));
3145 cupsdAddPrinterHistory(printer
);
3147 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
3148 "Job canceled because the server could not create "
3149 "the backend pipes.");
3156 job
->print_pipes
[0] = -1;
3157 if (!strncmp(printer
->device_uri
, "file:/dev/", 10) &&
3158 strcmp(printer
->device_uri
, "file:/dev/null"))
3159 job
->print_pipes
[1] = open(printer
->device_uri
+ 5,
3161 else if (!strncmp(printer
->device_uri
, "file:///dev/", 12) &&
3162 strcmp(printer
->device_uri
, "file:///dev/null"))
3163 job
->print_pipes
[1] = open(printer
->device_uri
+ 7,
3166 job
->print_pipes
[1] = open(printer
->device_uri
+ 5,
3167 O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
3169 if (job
->print_pipes
[1] < 0)
3171 cupsdLogMessage(CUPSD_LOG_ERROR
,
3172 "Unable to open output file \"%s\" - %s.",
3173 printer
->device_uri
, strerror(errno
));
3174 snprintf(printer
->state_message
, sizeof(printer
->state_message
),
3175 "Unable to open output file \"%s\" - %s.",
3176 printer
->device_uri
, strerror(errno
));
3178 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
3179 "Job canceled because the server could not open the "
3185 fcntl(job
->print_pipes
[1], F_SETFD
,
3186 fcntl(job
->print_pipes
[1], F_GETFD
) | FD_CLOEXEC
);
3189 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3190 "start_job: print_pipes = [ %d %d ]",
3191 job
->print_pipes
[0], job
->print_pipes
[1]);
3194 filterfds
[slot
][0] = job
->print_pipes
[0];
3195 filterfds
[slot
][1] = job
->print_pipes
[1];
3198 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job: filter=\"%s\"",
3200 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3201 "start_job: filterfds[%d]=[ %d %d ]",
3202 slot
, filterfds
[slot
][0], filterfds
[slot
][1]);
3204 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
3205 filterfds
[slot
][1], job
->status_pipes
[1],
3206 job
->back_pipes
[0], 0, job
->filters
+ i
);
3208 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3209 "start_job: Closing filter pipes for slot %d "
3211 !slot
, filterfds
[!slot
][0], filterfds
[!slot
][1]);
3213 cupsdClosePipe(filterfds
[!slot
]);
3217 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to start filter \"%s\" - %s.",
3218 filter
->filter
, strerror(errno
));
3219 snprintf(printer
->state_message
, sizeof(printer
->state_message
),
3220 "Unable to start filter \"%s\" - %s.",
3221 filter
->filter
, strerror(errno
));
3223 cupsdAddPrinterHistory(printer
);
3225 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
3226 "Job canceled because the server could not execute a "
3232 cupsdLogMessage(CUPSD_LOG_INFO
, "Started filter %s (PID %d) for job %d.",
3233 command
, pid
, job
->id
);
3239 cupsArrayDelete(filters
);
3242 * Finally, pipe the final output into a backend process if needed...
3245 if (strncmp(printer
->device_uri
, "file:", 5) != 0)
3247 if (job
->current_file
== 1)
3249 sscanf(printer
->device_uri
, "%254[^:]", method
);
3250 snprintf(command
, sizeof(command
), "%s/backend/%s", ServerBin
, method
);
3253 * See if the backend needs to run as root...
3258 else if (stat(command
, &backinfo
))
3261 backroot
= !(backinfo
.st_mode
& (S_IRWXG
| S_IRWXO
));
3265 filterfds
[slot
][0] = -1;
3266 filterfds
[slot
][1] = open("/dev/null", O_WRONLY
);
3268 if (filterfds
[slot
][1] < 0)
3270 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to open \"/dev/null\" - %s.",
3272 snprintf(printer
->state_message
, sizeof(printer
->state_message
),
3273 "Unable to open \"/dev/null\" - %s.", strerror(errno
));
3275 cupsdAddPrinterHistory(printer
);
3277 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
3278 "Job canceled because the server could not open a file.");
3283 fcntl(filterfds
[slot
][1], F_SETFD
,
3284 fcntl(filterfds
[slot
][1], F_GETFD
) | FD_CLOEXEC
);
3286 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "start_job: backend=\"%s\"",
3288 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3289 "start_job: filterfds[%d] = [ %d %d ]",
3290 slot
, filterfds
[slot
][0], filterfds
[slot
][1]);
3292 pid
= cupsdStartProcess(command
, argv
, envp
, filterfds
[!slot
][0],
3293 filterfds
[slot
][1], job
->status_pipes
[1],
3294 job
->back_pipes
[1], backroot
,
3299 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to start backend \"%s\" - %s.",
3300 method
, strerror(errno
));
3301 snprintf(printer
->state_message
, sizeof(printer
->state_message
),
3302 "Unable to start backend \"%s\" - %s.", method
,
3305 cupsdAddEvent(CUPSD_EVENT_JOB_COMPLETED
, job
->printer
, job
,
3306 "Job canceled because the server could not execute "
3313 cupsdLogMessage(CUPSD_LOG_INFO
,
3314 "Started backend %s (PID %d) for job %d.",
3315 command
, pid
, job
->id
);
3319 if (job
->current_file
== job
->num_files
)
3321 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3322 "start_job: Closing print pipes [ %d %d ]...",
3323 job
->print_pipes
[0], job
->print_pipes
[1]);
3325 cupsdClosePipe(job
->print_pipes
);
3327 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3328 "start_job: Closing back pipes [ %d %d ]...",
3329 job
->back_pipes
[0], job
->back_pipes
[1]);
3331 cupsdClosePipe(job
->back_pipes
);
3333 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3334 "start_job: Closing status output pipe %d...",
3335 job
->status_pipes
[1]);
3337 close(job
->status_pipes
[1]);
3338 job
->status_pipes
[1] = -1;
3343 filterfds
[slot
][0] = -1;
3344 filterfds
[slot
][1] = -1;
3346 if (job
->current_file
== job
->num_files
)
3348 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3349 "start_job: Closing print pipes [ %d %d ]...",
3350 job
->print_pipes
[0], job
->print_pipes
[1]);
3352 cupsdClosePipe(job
->print_pipes
);
3354 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3355 "start_job: Closing status output pipe %d...",
3356 job
->status_pipes
[1]);
3358 close(job
->status_pipes
[1]);
3359 job
->status_pipes
[1] = -1;
3363 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3364 "start_job: Closing filter pipes for slot %d "
3366 slot
, filterfds
[slot
][0], filterfds
[slot
][1]);
3367 cupsdClosePipe(filterfds
[slot
]);
3371 for (i
= 0; i
< job
->num_files
; i
++)
3377 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3378 "start_job: Adding fd %d to InputSet...",
3379 job
->status_buffer
->fd
);
3381 FD_SET(job
->status_buffer
->fd
, InputSet
);
3383 cupsdAddEvent(CUPSD_EVENT_JOB_STATE
, job
->printer
, job
, "Job #%d started.",
3390 * If we get here, we need to abort the current job and close out all
3391 * files and pipes...
3396 for (slot
= 0; slot
< 2; slot
++)
3398 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3399 "start_job: Closing filter pipes for slot %d "
3401 slot
, filterfds
[slot
][0], filterfds
[slot
][1]);
3402 cupsdClosePipe(filterfds
[slot
]);
3405 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
3406 "start_job: Closing status pipes [ %d %d ]...",
3407 job
->status_pipes
[0], job
->status_pipes
[1]);
3408 cupsdClosePipe(job
->status_pipes
);
3409 cupsdStatBufDelete(job
->status_buffer
);
3411 cupsArrayDelete(filters
);
3415 for (i
= 0; i
< job
->num_files
; i
++)
3421 cupsdStopJob(job
, 0);
3426 * 'unload_job()' - Unload a job from memory.
3430 unload_job(cupsd_job_t
*job
) /* I - Job */
3435 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Unloading job %d...", job
->id
);
3437 ippDelete(job
->attrs
);
3442 job
->job_sheets
= NULL
;
3447 * End of "$Id: job.c 5543 2006-05-18 20:51:33Z mike $".