]> git.ipfire.org Git - thirdparty/cups.git/blame - scheduler/conf.h
Merge changes from CUPS 1.4svn-r7961.
[thirdparty/cups.git] / scheduler / conf.h
CommitLineData
ef416fc2 1/*
b19ccc9e 2 * "$Id: conf.h 7935 2008-09-11 01:54:11Z mike $"
ef416fc2 3 *
4 * Configuration file definitions for the Common UNIX Printing System (CUPS)
5 * scheduler.
6 *
1f0275e3 7 * Copyright 2007-2008 by Apple Inc.
7594b224 8 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2 9 *
10 * These coded instructions, statements, and computer programs are the
bc44d920 11 * property of Apple Inc. and are protected by Federal copyright
12 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
13 * which should have been included with this file. If this file is
14 * file is missing or damaged, see the license at "http://www.cups.org/".
ef416fc2 15 */
16
17
18/*
19 * Log levels...
20 */
21
22typedef enum
23{
c9fc04c6
MS
24 CUPSD_LOG_PPD = -4, /* Used internally for PPD keywords */
25 CUPSD_LOG_ATTR, /* Used internally for attributes */
f7deaa1a 26 CUPSD_LOG_STATE, /* Used internally for state-reasons */
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
ef416fc2 47
49d87452
MS
48/*
49 * FatalErrors flags...
50 */
51
52#define CUPSD_FATAL_NONE 0 /* No errors are fatal */
53#define CUPSD_FATAL_BROWSE 1 /* Browse bind errors are fatal */
54#define CUPSD_FATAL_CONFIG 2 /* Config file syntax errors are fatal */
55#define CUPSD_FATAL_LISTEN 4 /* Listen/Port bind errors are fatal */
56#define CUPSD_FATAL_LOG 8 /* Log file errors are fatal */
57#define CUPSD_FATAL_PERMISSIONS 16 /* File permission errors are fatal */
58#define CUPSD_FATAL_ALL ~0 /* All errors are fatal */
59
60
ef416fc2 61/*
62 * Printcap formats...
63 */
64
f7deaa1a 65#define PRINTCAP_BSD 0 /* Berkeley LPD format */
66#define PRINTCAP_SOLARIS 1 /* Solaris lpsched format */
ef416fc2 67
68
b19ccc9e
MS
69/*
70 * SSL options (bits)...
71 */
72
73#define CUPSD_SSL_NONE 0 /* No special options */
74#define CUPSD_SSL_NOEMPTY 1 /* Do not insert empty fragments */
75
76
ef416fc2 77/*
78 * Globals...
79 */
80
81VAR char *ConfigurationFile VALUE(NULL),
82 /* Configuration file to use */
83 *ServerName VALUE(NULL),
84 /* FQDN for server */
85 *ServerAdmin VALUE(NULL),
86 /* Administrator's email */
87 *ServerRoot VALUE(NULL),
88 /* Root directory for scheduler */
89 *ServerBin VALUE(NULL),
90 /* Root directory for binaries */
91 *StateDir VALUE(NULL),
92 /* Root directory for state data */
93 *RequestRoot VALUE(NULL),
94 /* Directory for request files */
95 *DocumentRoot VALUE(NULL);
96 /* Root directory for documents */
8ca02f3c 97VAR int ServerNameIsIP VALUE(0);
ef416fc2 98VAR int NumSystemGroups VALUE(0);
99 /* Number of system group names */
ac884b6a
MS
100VAR char *SystemGroups[MAX_SYSTEM_GROUPS]
101 VALUE({0});
ef416fc2 102 /* System group names */
ac884b6a
MS
103VAR gid_t SystemGroupIDs[MAX_SYSTEM_GROUPS]
104 VALUE({0});
ef416fc2 105 /* System group IDs */
106VAR char *AccessLog VALUE(NULL),
107 /* Access log filename */
108 *ErrorLog VALUE(NULL),
109 /* Error log filename */
110 *PageLog VALUE(NULL),
111 /* Page log filename */
112 *CacheDir VALUE(NULL),
113 /* Cache file directory */
114 *DataDir VALUE(NULL),
115 /* Data file directory */
116 *DefaultLanguage VALUE(NULL),
117 /* Default language encoding */
118 *DefaultCharset VALUE(NULL),
119 /* Default charset */
120 *DefaultLocale VALUE(NULL),
121 /* Default locale */
c5571a1d
MS
122 *DefaultPaperSize VALUE(NULL),
123 /* Default paper size */
323c5de1 124 *ErrorPolicy VALUE(NULL),
125 /* Default printer-error-policy */
ef416fc2 126 *RIPCache VALUE(NULL),
127 /* Amount of memory for RIPs */
128 *TempDir VALUE(NULL),
129 /* Temporary directory */
130 *Printcap VALUE(NULL),
131 /* Printcap file */
132 *PrintcapGUI VALUE(NULL),
133 /* GUI program to use for IRIX */
134 *FontPath VALUE(NULL),
135 /* Font search path */
136 *RemoteRoot VALUE(NULL),
137 /* Remote root user */
138 *Classification VALUE(NULL);
139 /* Classification of system */
f7deaa1a 140#ifdef HAVE_GSSAPI
141VAR char *GSSServiceName VALUE(NULL);
142 /* GSS service name */
143VAR char *Krb5Keytab VALUE(NULL);
144 /* Kerberos Keytab */
145#endif /* HAVE_GSSAPI */
ef416fc2 146VAR uid_t User VALUE(1);
147 /* User ID for server */
148VAR gid_t Group VALUE(0);
149 /* Group ID for server */
1f0275e3
MS
150VAR int AccessLogLevel VALUE(CUPSD_ACCESSLOG_ACTIONS),
151 /* Access log level */
152 ClassifyOverride VALUE(0),
ef416fc2 153 /* Allow overrides? */
154 ConfigFilePerm VALUE(0640),
155 /* Permissions for config files */
49d87452
MS
156 FatalErrors VALUE(CUPSD_FATAL_CONFIG),
157 /* Which errors are fatal? */
ef416fc2 158 LogFilePerm VALUE(0644),
159 /* Permissions for log files */
1f0275e3
MS
160 LogLevel VALUE(CUPSD_LOG_WARN),
161 /* Error log level */
ef416fc2 162 MaxClients VALUE(0),
163 /* Maximum number of clients */
164 MaxClientsPerHost VALUE(0),
165 /* Maximum number of clients per host */
f7deaa1a 166 MaxCopies VALUE(CUPS_DEFAULT_MAX_COPIES),
ef416fc2 167 /* Maximum number of copies per job */
168 MaxLogSize VALUE(1024 * 1024),
169 /* Maximum size of log files */
170 MaxPrinterHistory VALUE(10),
171 /* Maximum printer state history */
172 MaxRequestSize VALUE(0),
173 /* Maximum size of IPP requests */
174 HostNameLookups VALUE(FALSE),
175 /* Do we do reverse lookups? */
176 Timeout VALUE(DEFAULT_TIMEOUT),
177 /* Timeout during requests */
178 KeepAlive VALUE(TRUE),
179 /* Support the Keep-Alive option? */
180 KeepAliveTimeout VALUE(DEFAULT_KEEPALIVE),
181 /* Timeout between requests */
182 ImplicitClasses VALUE(TRUE),
183 /* Are classes implicitly created? */
184 ImplicitAnyClasses VALUE(FALSE),
185 /* Create AnyPrinter classes? */
186 HideImplicitMembers VALUE(TRUE),
187 /* Hide implicit class members? */
188 FileDevice VALUE(FALSE),
189 /* Allow file: devices? */
190 FilterLimit VALUE(0),
191 /* Max filter cost at any time */
192 FilterLevel VALUE(0),
193 /* Current filter level */
194 FilterNice VALUE(0),
195 /* Nice value for filters */
49d87452 196 ReloadTimeout VALUE(DEFAULT_KEEPALIVE),
ef416fc2 197 /* Timeout before reload from SIGHUP */
198 RootCertDuration VALUE(300),
199 /* Root certificate update interval */
ac884b6a
MS
200 RunUser VALUE(0),
201 /* User to run as, used for files */
fa73b229 202 PrintcapFormat VALUE(PRINTCAP_BSD),
ef416fc2 203 /* Format of printcap file? */
fa73b229 204 DefaultShared VALUE(TRUE);
205 /* Share printers by default? */
ef416fc2 206VAR cups_file_t *AccessFile VALUE(NULL),
207 /* Access log file */
208 *ErrorFile VALUE(NULL),
209 /* Error log file */
210 *PageFile VALUE(NULL);
211 /* Page log file */
01ce6322
MS
212VAR char *PageLogFormat VALUE(NULL);
213 /* Page log format */
ef416fc2 214VAR mime_t *MimeDatabase VALUE(NULL);
215 /* MIME type database */
216VAR int NumMimeTypes VALUE(0);
217 /* Number of MIME types */
218VAR const char **MimeTypes VALUE(NULL);
219 /* Array of MIME types */
220
221#ifdef HAVE_SSL
222VAR char *ServerCertificate VALUE(NULL);
223 /* Server certificate file */
224# if defined(HAVE_LIBSSL) || defined(HAVE_GNUTLS)
225VAR char *ServerKey VALUE(NULL);
226 /* Server key file */
ef416fc2 227# endif /* HAVE_LIBSSL || HAVE_GNUTLS */
b19ccc9e
MS
228VAR int SSLOptions VALUE(CUPSD_SSL_NONE);
229 /* SSL/TLS options */
ef416fc2 230#endif /* HAVE_SSL */
231
a4d04587 232#ifdef HAVE_LAUNCHD
49d87452 233VAR int LaunchdTimeout VALUE(DEFAULT_KEEPALIVE);
a4d04587 234 /* Time after which an idle cupsd will exit */
235VAR char *LaunchdConf VALUE(NULL);
236 /* launchd(8) configuration file */
237#endif /* HAVE_LAUNCHD */
ef416fc2 238
7594b224 239#ifdef __APPLE__
240VAR int AppleQuotas VALUE(TRUE);
241 /* Use Apple PrintService Quotas instead of CUPS quotas */
242#endif /* __APPLE__ */
243
f7deaa1a 244#ifdef HAVE_AUTHORIZATION_H
245VAR char *SystemGroupAuthKey VALUE(NULL);
246 /* System group auth key */
247#endif /* HAVE_AUTHORIZATION_H */
248
249
ef416fc2 250/*
251 * Prototypes...
252 */
253
b94498cf 254extern int cupsdCheckPermissions(const char *filename,
255 const char *suffix, int mode,
256 int user, int group, int is_dir,
257 int create_dir);
ef416fc2 258extern char *cupsdGetDateTime(time_t t);
f7deaa1a 259#ifdef HAVE_GSSAPI
260extern int cupsdLogGSSMessage(int level, int major_status,
261 int minor_status,
262 const char *message, ...);
263#endif /* HAVE_GSSAPI */
75bd9771
MS
264extern int cupsdLogJob(cupsd_job_t *job, int level, const char *message, ...)
265#ifdef __GNUC__
266__attribute__ ((__format__ (__printf__, 3, 4)))
267#endif /* __GNUC__ */
268;
ef416fc2 269extern int cupsdLogMessage(int level, const char *message, ...)
270#ifdef __GNUC__
271__attribute__ ((__format__ (__printf__, 2, 3)))
272#endif /* __GNUC__ */
273;
274extern int cupsdLogPage(cupsd_job_t *job, const char *page);
f7deaa1a 275extern int cupsdLogRequest(cupsd_client_t *con, http_status_t code);
b94498cf 276extern int cupsdReadConfiguration(void);
75bd9771 277extern int cupsdWriteErrorLog(int level, const char *message);
ef416fc2 278
279
280/*
b19ccc9e 281 * End of "$Id: conf.h 7935 2008-09-11 01:54:11Z mike $".
ef416fc2 282 */