]> git.ipfire.org Git - thirdparty/cups.git/blame - scheduler/conf.h
Update svn:keyword properties.
[thirdparty/cups.git] / scheduler / conf.h
CommitLineData
ef416fc2 1/*
f2d18633 2 * "$Id$"
ef416fc2 3 *
10d09e33 4 * Configuration file definitions for the CUPS scheduler.
ef416fc2 5 *
f3c17241 6 * Copyright 2007-2012 by Apple Inc.
7594b224 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
16
17/*
18 * Log levels...
19 */
20
21typedef enum
22{
a469f8a5 23 CUPSD_LOG_PPD = -5, /* Used internally for PPD keywords */
c9fc04c6 24 CUPSD_LOG_ATTR, /* Used internally for attributes */
a469f8a5
MS
25 CUPSD_LOG_STATE, /* Used internally for printer-state-reasons */
26 CUPSD_LOG_JOBSTATE, /* Used internally for job-state-reasons */
f7deaa1a 27 CUPSD_LOG_PAGE, /* Used internally for page logging */
ef416fc2 28 CUPSD_LOG_NONE,
f7deaa1a 29 CUPSD_LOG_EMERG, /* Emergency issues */
30 CUPSD_LOG_ALERT, /* Something bad happened that needs attention */
31 CUPSD_LOG_CRIT, /* Critical error but server continues */
32 CUPSD_LOG_ERROR, /* Error condition */
33 CUPSD_LOG_WARN, /* Warning */
34 CUPSD_LOG_NOTICE, /* Normal condition that needs logging */
35 CUPSD_LOG_INFO, /* General information */
36 CUPSD_LOG_DEBUG, /* General debugging */
37 CUPSD_LOG_DEBUG2 /* Detailed debugging */
ef416fc2 38} cupsd_loglevel_t;
39
1f0275e3
MS
40typedef enum
41{
42 CUPSD_ACCESSLOG_CONFIG, /* Log config requests */
43 CUPSD_ACCESSLOG_ACTIONS, /* Log config, print, and job management requests */
44 CUPSD_ACCESSLOG_ALL /* Log everything */
45} cupsd_accesslog_t;
46
dfd5680b
MS
47typedef enum
48{
49 CUPSD_TIME_STANDARD, /* "Standard" Apache/CLF format */
50 CUPSD_TIME_USECS /* Standard format with microseconds */
51} cupsd_time_t;
52
ef416fc2 53
49d87452
MS
54/*
55 * FatalErrors flags...
56 */
57
58#define CUPSD_FATAL_NONE 0 /* No errors are fatal */
59#define CUPSD_FATAL_BROWSE 1 /* Browse bind errors are fatal */
60#define CUPSD_FATAL_CONFIG 2 /* Config file syntax errors are fatal */
61#define CUPSD_FATAL_LISTEN 4 /* Listen/Port bind errors are fatal */
62#define CUPSD_FATAL_LOG 8 /* Log file errors are fatal */
63#define CUPSD_FATAL_PERMISSIONS 16 /* File permission errors are fatal */
64#define CUPSD_FATAL_ALL ~0 /* All errors are fatal */
65
66
ef416fc2 67/*
68 * Printcap formats...
69 */
70
f7deaa1a 71#define PRINTCAP_BSD 0 /* Berkeley LPD format */
72#define PRINTCAP_SOLARIS 1 /* Solaris lpsched format */
f3c17241 73#define PRINTCAP_PLIST 2 /* OS X plist format */
ef416fc2 74
75
b19ccc9e
MS
76/*
77 * SSL options (bits)...
78 */
79
80#define CUPSD_SSL_NONE 0 /* No special options */
81#define CUPSD_SSL_NOEMPTY 1 /* Do not insert empty fragments */
82
83
e07d4801
MS
84/*
85 * ServerAlias data...
86 */
87
88typedef struct
89{
90 size_t namelen; /* Length of alias name */
91 char name[1]; /* Alias name */
92} cupsd_alias_t;
93
94
ef416fc2 95/*
96 * Globals...
97 */
98
99VAR char *ConfigurationFile VALUE(NULL),
c41769ff
MS
100 /* cupsd.conf file to use */
101 *CupsFilesFile VALUE(NULL),
102 /* cups-files.conf file to use */
ef416fc2 103 *ServerName VALUE(NULL),
104 /* FQDN for server */
105 *ServerAdmin VALUE(NULL),
106 /* Administrator's email */
107 *ServerRoot VALUE(NULL),
108 /* Root directory for scheduler */
109 *ServerBin VALUE(NULL),
110 /* Root directory for binaries */
111 *StateDir VALUE(NULL),
112 /* Root directory for state data */
113 *RequestRoot VALUE(NULL),
114 /* Directory for request files */
115 *DocumentRoot VALUE(NULL);
116 /* Root directory for documents */
e07d4801
MS
117VAR cups_array_t *ServerAlias VALUE(NULL);
118 /* Alias names for server */
f11a948a 119VAR int ServerNameIsIP VALUE(0);
d1c13e16 120 /* Is the ServerName an IP address? */
ef416fc2 121VAR int NumSystemGroups VALUE(0);
122 /* Number of system group names */
ac884b6a
MS
123VAR char *SystemGroups[MAX_SYSTEM_GROUPS]
124 VALUE({0});
ef416fc2 125 /* System group names */
ac884b6a
MS
126VAR gid_t SystemGroupIDs[MAX_SYSTEM_GROUPS]
127 VALUE({0});
ef416fc2 128 /* System group IDs */
129VAR char *AccessLog VALUE(NULL),
130 /* Access log filename */
131 *ErrorLog VALUE(NULL),
132 /* Error log filename */
133 *PageLog VALUE(NULL),
134 /* Page log filename */
135 *CacheDir VALUE(NULL),
136 /* Cache file directory */
137 *DataDir VALUE(NULL),
138 /* Data file directory */
139 *DefaultLanguage VALUE(NULL),
140 /* Default language encoding */
ef416fc2 141 *DefaultLocale VALUE(NULL),
142 /* Default locale */
c5571a1d
MS
143 *DefaultPaperSize VALUE(NULL),
144 /* Default paper size */
323c5de1 145 *ErrorPolicy VALUE(NULL),
146 /* Default printer-error-policy */
ef416fc2 147 *RIPCache VALUE(NULL),
148 /* Amount of memory for RIPs */
149 *TempDir VALUE(NULL),
150 /* Temporary directory */
151 *Printcap VALUE(NULL),
152 /* Printcap file */
ef416fc2 153 *FontPath VALUE(NULL),
154 /* Font search path */
155 *RemoteRoot VALUE(NULL),
156 /* Remote root user */
157 *Classification VALUE(NULL);
158 /* Classification of system */
159VAR uid_t User VALUE(1);
160 /* User ID for server */
161VAR gid_t Group VALUE(0);
162 /* Group ID for server */
dfd5680b 163VAR cupsd_accesslog_t AccessLogLevel VALUE(CUPSD_ACCESSLOG_ACTIONS);
1f0275e3 164 /* Access log level */
dfd5680b 165VAR int ClassifyOverride VALUE(0),
ef416fc2 166 /* Allow overrides? */
167 ConfigFilePerm VALUE(0640),
168 /* Permissions for config files */
178cb736
MS
169 LogDebugHistory VALUE(200),
170 /* Amount of automatic debug history */
49d87452
MS
171 FatalErrors VALUE(CUPSD_FATAL_CONFIG),
172 /* Which errors are fatal? */
a29fd7dd
MS
173 StrictConformance VALUE(FALSE),
174 /* Require strict IPP conformance? */
dfd5680b 175 LogFilePerm VALUE(0644);
ef416fc2 176 /* Permissions for log files */
dfd5680b 177VAR cupsd_loglevel_t LogLevel VALUE(CUPSD_LOG_WARN);
1f0275e3 178 /* Error log level */
dfd5680b
MS
179VAR cupsd_time_t LogTimeFormat VALUE(CUPSD_TIME_STANDARD);
180 /* Log file time format */
181VAR int MaxClients VALUE(100),
ef416fc2 182 /* Maximum number of clients */
183 MaxClientsPerHost VALUE(0),
184 /* Maximum number of clients per host */
f7deaa1a 185 MaxCopies VALUE(CUPS_DEFAULT_MAX_COPIES),
ef416fc2 186 /* Maximum number of copies per job */
187 MaxLogSize VALUE(1024 * 1024),
188 /* Maximum size of log files */
ef416fc2 189 MaxRequestSize VALUE(0),
190 /* Maximum size of IPP requests */
191 HostNameLookups VALUE(FALSE),
192 /* Do we do reverse lookups? */
193 Timeout VALUE(DEFAULT_TIMEOUT),
194 /* Timeout during requests */
195 KeepAlive VALUE(TRUE),
196 /* Support the Keep-Alive option? */
197 KeepAliveTimeout VALUE(DEFAULT_KEEPALIVE),
198 /* Timeout between requests */
ef416fc2 199 FileDevice VALUE(FALSE),
200 /* Allow file: devices? */
201 FilterLimit VALUE(0),
202 /* Max filter cost at any time */
203 FilterLevel VALUE(0),
204 /* Current filter level */
205 FilterNice VALUE(0),
206 /* Nice value for filters */
49d87452 207 ReloadTimeout VALUE(DEFAULT_KEEPALIVE),
ef416fc2 208 /* Timeout before reload from SIGHUP */
209 RootCertDuration VALUE(300),
210 /* Root certificate update interval */
ac884b6a
MS
211 RunUser VALUE(0),
212 /* User to run as, used for files */
fa73b229 213 PrintcapFormat VALUE(PRINTCAP_BSD),
ef416fc2 214 /* Format of printcap file? */
dfd5680b 215 DefaultShared VALUE(TRUE),
fa73b229 216 /* Share printers by default? */
229681c1 217 MultipleOperationTimeout VALUE(DEFAULT_TIMEOUT),
dfd5680b 218 /* multiple-operation-time-out value */
229681c1
MS
219 WebInterface VALUE(CUPS_DEFAULT_WEBIF);
220 /* Enable the web interface? */
ef416fc2 221VAR cups_file_t *AccessFile VALUE(NULL),
222 /* Access log file */
223 *ErrorFile VALUE(NULL),
224 /* Error log file */
225 *PageFile VALUE(NULL);
226 /* Page log file */
01ce6322
MS
227VAR char *PageLogFormat VALUE(NULL);
228 /* Page log format */
ef416fc2 229VAR mime_t *MimeDatabase VALUE(NULL);
230 /* MIME type database */
231VAR int NumMimeTypes VALUE(0);
232 /* Number of MIME types */
233VAR const char **MimeTypes VALUE(NULL);
234 /* Array of MIME types */
235
236#ifdef HAVE_SSL
237VAR char *ServerCertificate VALUE(NULL);
238 /* Server certificate file */
239# if defined(HAVE_LIBSSL) || defined(HAVE_GNUTLS)
240VAR char *ServerKey VALUE(NULL);
241 /* Server key file */
ef416fc2 242# endif /* HAVE_LIBSSL || HAVE_GNUTLS */
b19ccc9e
MS
243VAR int SSLOptions VALUE(CUPSD_SSL_NONE);
244 /* SSL/TLS options */
ef416fc2 245#endif /* HAVE_SSL */
246
a4d04587 247#ifdef HAVE_LAUNCHD
dcb445bc 248VAR int LaunchdTimeout VALUE(10);
a4d04587 249 /* Time after which an idle cupsd will exit */
a4d04587 250#endif /* HAVE_LAUNCHD */
ef416fc2 251
f7deaa1a 252#ifdef HAVE_AUTHORIZATION_H
253VAR char *SystemGroupAuthKey VALUE(NULL);
254 /* System group auth key */
255#endif /* HAVE_AUTHORIZATION_H */
256
dcb445bc
MS
257#ifdef HAVE_GSSAPI
258VAR char *GSSServiceName VALUE(NULL);
259 /* GSS service name */
260int HaveServerCreds VALUE(0);
261 /* Do we have server credentials? */
262gss_cred_id_t ServerCreds; /* Server's GSS credentials */
263#endif /* HAVE_GSSAPI */
264
f7deaa1a 265
ef416fc2 266/*
267 * Prototypes...
268 */
269
e07d4801 270extern void cupsdAddAlias(cups_array_t *aliases, const char *name);
22c9029b 271extern int cupsdCheckLogFile(cups_file_t **lf, const char *logname);
b94498cf 272extern int cupsdCheckPermissions(const char *filename,
273 const char *suffix, int mode,
274 int user, int group, int is_dir,
275 int create_dir);
22c9029b 276extern int cupsdCheckProgram(const char *filename, cupsd_printer_t *p);
dcb445bc 277extern int cupsdDefaultAuthType(void);
e07d4801 278extern void cupsdFreeAliases(cups_array_t *aliases);
dfd5680b 279extern char *cupsdGetDateTime(struct timeval *t, cupsd_time_t format);
22c9029b
MS
280extern void cupsdLogFCMessage(void *context, _cups_fc_result_t result,
281 const char *message);
f7deaa1a 282#ifdef HAVE_GSSAPI
283extern int cupsdLogGSSMessage(int level, int major_status,
284 int minor_status,
285 const char *message, ...);
286#endif /* HAVE_GSSAPI */
85dda01c
MS
287extern int cupsdLogJob(cupsd_job_t *job, int level, const char *message,
288 ...) __attribute__((__format__(__printf__, 3, 4)));
ef416fc2 289extern int cupsdLogMessage(int level, const char *message, ...)
85dda01c 290 __attribute__ ((__format__ (__printf__, 2, 3)));
ef416fc2 291extern int cupsdLogPage(cupsd_job_t *job, const char *page);
f7deaa1a 292extern int cupsdLogRequest(cupsd_client_t *con, http_status_t code);
b94498cf 293extern int cupsdReadConfiguration(void);
75bd9771 294extern int cupsdWriteErrorLog(int level, const char *message);
ef416fc2 295
296
297/*
f2d18633 298 * End of "$Id$".
ef416fc2 299 */