]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | /* |
b19ccc9e | 2 | * "$Id: job.h 7883 2008-08-28 20:38:13Z mike $" |
ef416fc2 | 3 | * |
10d09e33 | 4 | * Print job definitions for the CUPS scheduler. |
ef416fc2 | 5 | * |
88f9aafc | 6 | * Copyright 2007-2011 by Apple Inc. |
09a101d6 | 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 | ||
b9faaae1 MS |
16 | /* |
17 | * Constants... | |
18 | */ | |
19 | ||
20 | typedef enum cupsd_jobaction_e /**** Actions for state changes ****/ | |
21 | { | |
22 | CUPSD_JOB_DEFAULT, /* Use default action */ | |
23 | CUPSD_JOB_FORCE, /* Force the change */ | |
24 | CUPSD_JOB_PURGE /* Force the change and purge */ | |
25 | } cupsd_jobaction_t; | |
26 | ||
27 | ||
ef416fc2 | 28 | /* |
29 | * Job request structure... | |
30 | */ | |
31 | ||
178cb736 | 32 | struct cupsd_job_s /**** Job request ****/ |
ef416fc2 | 33 | { |
34 | int id, /* Job ID */ | |
3dfe78b3 MS |
35 | priority, /* Job priority */ |
36 | dirty; /* Do we need to write the "c" file? */ | |
bd7854cb | 37 | ipp_jstate_t state_value; /* Cached job-state */ |
b9faaae1 MS |
38 | int pending_timeout;/* Non-zero if the job was created and |
39 | * waiting on files */ | |
ef416fc2 | 40 | char *username; /* Printing user */ |
41 | char *dest; /* Destination printer or class */ | |
b9faaae1 | 42 | cups_ptype_t dtype; /* Destination type */ |
10d09e33 | 43 | cupsd_printer_t *printer; /* Printer this job is assigned to */ |
ef416fc2 | 44 | int num_files; /* Number of files in job */ |
ef416fc2 | 45 | mime_type_t **filetypes; /* File types */ |
46 | int *compressions; /* Compression status of each file */ | |
bd7854cb | 47 | ipp_attribute_t *sheets; /* job-media-sheets-completed */ |
238c3832 | 48 | time_t access_time, /* Last access time */ |
dcb445bc | 49 | cancel_time, /* When to cancel/send SIGTERM */ |
82cc1f9a MS |
50 | file_time, /* Job file retain time */ |
51 | history_time, /* Job history retain time */ | |
52 | hold_until, /* Hold expiration date/time */ | |
53 | kill_time; /* When to send SIGKILL */ | |
bd7854cb | 54 | ipp_attribute_t *state; /* Job state */ |
12f89d24 | 55 | ipp_attribute_t *reasons; /* Job state reasons */ |
bd7854cb | 56 | ipp_attribute_t *job_sheets; /* Job sheets (NULL if none) */ |
bc44d920 | 57 | ipp_attribute_t *printer_message, |
58 | /* job-printer-state-message */ | |
59 | *printer_reasons; | |
60 | /* job-printer-state-reasons */ | |
bd7854cb | 61 | int current_file; /* Current file in job */ |
ef416fc2 | 62 | ipp_t *attrs; /* Job attributes */ |
ef416fc2 | 63 | int print_pipes[2], /* Print data pipes */ |
89d46774 | 64 | back_pipes[2], /* Backchannel pipes */ |
f7deaa1a | 65 | side_pipes[2], /* Sidechannel pipes */ |
89d46774 | 66 | status_pipes[2];/* Status pipes */ |
67 | cupsd_statbuf_t *status_buffer; /* Status buffer for this job */ | |
b9faaae1 MS |
68 | int status_level; /* Highest log level in a status |
69 | * message */ | |
ef416fc2 | 70 | int cost; /* Filtering cost */ |
e07d4801 | 71 | int pending_cost; /* Waiting for FilterLimit */ |
ef416fc2 | 72 | int filters[MAX_FILTERS + 1]; |
73 | /* Filter process IDs, 0 terminated */ | |
74 | int backend; /* Backend process ID */ | |
75 | int status; /* Status code from filters */ | |
ef416fc2 | 76 | int tries; /* Number of tries for this job */ |
88f9aafc | 77 | char *auth_env[3], /* AUTH_xxx environment variables, |
b9faaae1 | 78 | * if any */ |
88f9aafc | 79 | *auth_uid; /* AUTH_UID environment variable */ |
a4924f6c | 80 | void *profile; /* Security profile */ |
178cb736 | 81 | cups_array_t *history; /* Debug log history */ |
9a4f8274 | 82 | int progress; /* Printing progress */ |
f11a948a | 83 | }; |
ef416fc2 | 84 | |
178cb736 MS |
85 | typedef struct cupsd_joblog_s /**** Job log message ****/ |
86 | { | |
87 | time_t time; /* Time of message */ | |
88 | char message[1]; /* Message string */ | |
89 | } cupsd_joblog_t; | |
90 | ||
ef416fc2 | 91 | |
92 | /* | |
93 | * Globals... | |
94 | */ | |
95 | ||
82cc1f9a | 96 | VAR int JobHistory VALUE(INT_MAX); |
ef416fc2 | 97 | /* Preserve job history? */ |
82cc1f9a | 98 | VAR int JobFiles VALUE(86400); |
ef416fc2 | 99 | /* Preserve job files? */ |
82cc1f9a MS |
100 | VAR time_t JobHistoryUpdate VALUE(0); |
101 | /* Time for next job history update */ | |
ef416fc2 | 102 | VAR int MaxJobs VALUE(0), |
103 | /* Max number of jobs */ | |
104 | MaxActiveJobs VALUE(0), | |
105 | /* Max number of active jobs */ | |
3e7fe0ca MS |
106 | MaxHoldTime VALUE(0), |
107 | /* Max time for indefinite hold */ | |
ef416fc2 | 108 | MaxJobsPerUser VALUE(0), |
109 | /* Max jobs per user */ | |
dcb445bc | 110 | MaxJobsPerPrinter VALUE(0), |
ef416fc2 | 111 | /* Max jobs per printer */ |
dcb445bc MS |
112 | MaxJobTime VALUE(3 * 60 * 60); |
113 | /* Max time for a job */ | |
ef416fc2 | 114 | VAR int JobAutoPurge VALUE(0); |
115 | /* Automatically purge jobs */ | |
116 | VAR cups_array_t *Jobs VALUE(NULL), | |
117 | /* List of current jobs */ | |
3dfe78b3 | 118 | *ActiveJobs VALUE(NULL), |
ef416fc2 | 119 | /* List of active jobs */ |
3dfe78b3 MS |
120 | *PrintingJobs VALUE(NULL); |
121 | /* List of jobs that are printing */ | |
ef416fc2 | 122 | VAR int NextJobId VALUE(1); |
123 | /* Next job ID to use */ | |
238c3832 MS |
124 | VAR int JobKillDelay VALUE(DEFAULT_TIMEOUT), |
125 | /* Delay before killing jobs */ | |
126 | JobRetryLimit VALUE(5), | |
ef416fc2 | 127 | /* Max number of tries */ |
128 | JobRetryInterval VALUE(300); | |
129 | /* Seconds between retries */ | |
130 | ||
131 | ||
132 | /* | |
133 | * Prototypes... | |
134 | */ | |
135 | ||
136 | extern cupsd_job_t *cupsdAddJob(int priority, const char *dest); | |
ef416fc2 | 137 | extern void cupsdCancelJobs(const char *dest, const char *username, |
138 | int purge); | |
139 | extern void cupsdCheckJobs(void); | |
140 | extern void cupsdCleanJobs(void); | |
b9faaae1 MS |
141 | extern void cupsdContinueJob(cupsd_job_t *job); |
142 | extern void cupsdDeleteJob(cupsd_job_t *job, | |
143 | cupsd_jobaction_t action); | |
ef416fc2 | 144 | extern cupsd_job_t *cupsdFindJob(int id); |
ef416fc2 | 145 | extern void cupsdFreeAllJobs(void); |
146 | extern int cupsdGetPrinterJobCount(const char *dest); | |
147 | extern int cupsdGetUserJobCount(const char *username); | |
ef416fc2 | 148 | extern void cupsdLoadAllJobs(void); |
dfd5680b | 149 | extern int cupsdLoadJob(cupsd_job_t *job); |
e53920b9 | 150 | extern void cupsdMoveJob(cupsd_job_t *job, cupsd_printer_t *p); |
ef416fc2 | 151 | extern void cupsdReleaseJob(cupsd_job_t *job); |
152 | extern void cupsdRestartJob(cupsd_job_t *job); | |
bd7854cb | 153 | extern void cupsdSaveAllJobs(void); |
ef416fc2 | 154 | extern void cupsdSaveJob(cupsd_job_t *job); |
b9faaae1 MS |
155 | extern void cupsdSetJobHoldUntil(cupsd_job_t *job, |
156 | const char *when, int update); | |
ef416fc2 | 157 | extern void cupsdSetJobPriority(cupsd_job_t *job, int priority); |
b9faaae1 MS |
158 | extern void cupsdSetJobState(cupsd_job_t *job, |
159 | ipp_jstate_t newstate, | |
160 | cupsd_jobaction_t action, | |
161 | const char *message, ...) | |
85dda01c MS |
162 | __attribute__((__format__(__printf__, |
163 | 4, 5))); | |
238c3832 MS |
164 | extern void cupsdStopAllJobs(cupsd_jobaction_t action, |
165 | int kill_delay); | |
91c84a35 | 166 | extern int cupsdTimeoutJob(cupsd_job_t *job); |
bc44d920 | 167 | extern void cupsdUnloadCompletedJobs(void); |
82cc1f9a | 168 | extern void cupsdUpdateJobs(void); |
ef416fc2 | 169 | |
170 | ||
171 | /* | |
b19ccc9e | 172 | * End of "$Id: job.h 7883 2008-08-28 20:38:13Z mike $". |
ef416fc2 | 173 | */ |