[thirdparty/cups.git] / scheduler / conf.h

/*
 * "$Id: conf.h 5216 2006-03-02 17:47:53Z mike $"
 *
 *   Configuration file definitions for the Common UNIX Printing System (CUPS)
 *   scheduler.
 *
 *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Easy Software Products and are protected by Federal
 *   copyright law.  Distribution and use rights are outlined in the file
 *   "LICENSE.txt" which should have been included with this file.  If this
 *   file is missing or damaged please contact Easy Software Products
 *   at:
 *
 *       Attn: CUPS Licensing Information
 *       Easy Software Products
 *       44141 Airport View Drive, Suite 204
 *       Hollywood, Maryland 20636 USA
 *
 *       Voice: (301) 373-9600
 *       EMail: cups-info@cups.org
 *         WWW: http://www.cups.org
 */


/*
 * Log levels...
 */

typedef enum
{
  CUPSD_LOG_ATTR = -3,		/* Used internally for attributes */
  CUPSD_LOG_STATE,		/* Used internally for state-reasons */
  CUPSD_LOG_PAGE,		/* Used internally for page logging */
  CUPSD_LOG_NONE,
  CUPSD_LOG_EMERG,		/* Emergency issues */
  CUPSD_LOG_ALERT,		/* Something bad happened that needs attention */
  CUPSD_LOG_CRIT,		/* Critical error but server continues */
  CUPSD_LOG_ERROR,		/* Error condition */
  CUPSD_LOG_WARN,		/* Warning */
  CUPSD_LOG_NOTICE,		/* Normal condition that needs logging */
  CUPSD_LOG_INFO,		/* General information */
  CUPSD_LOG_DEBUG,		/* General debugging */
  CUPSD_LOG_DEBUG2		/* Detailed debugging */
} cupsd_loglevel_t;


/*
 * Printcap formats...
 */

#define PRINTCAP_BSD	0	/* Berkeley LPD format */
#define PRINTCAP_SOLARIS 1	/* Solaris lpsched format */


/*
 * Globals...
 */

VAR char		*ConfigurationFile	VALUE(NULL),
					/* Configuration file to use */
			*ServerName		VALUE(NULL),
					/* FQDN for server */
			*ServerAdmin		VALUE(NULL),
					/* Administrator's email */
			*ServerRoot		VALUE(NULL),
					/* Root directory for scheduler */
			*ServerBin		VALUE(NULL),
					/* Root directory for binaries */
			*StateDir		VALUE(NULL),
					/* Root directory for state data */
			*RequestRoot		VALUE(NULL),
					/* Directory for request files */
			*DocumentRoot		VALUE(NULL);
					/* Root directory for documents */
VAR int			NumSystemGroups		VALUE(0);
					/* Number of system group names */
VAR char		*SystemGroups[MAX_SYSTEM_GROUPS];
					/* System group names */
VAR gid_t		SystemGroupIDs[MAX_SYSTEM_GROUPS];
					/* System group IDs */
VAR char		*AccessLog		VALUE(NULL),
					/* Access log filename */
			*ErrorLog		VALUE(NULL),
					/* Error log filename */
			*PageLog		VALUE(NULL),
					/* Page log filename */
			*CacheDir		VALUE(NULL),
					/* Cache file directory */
			*DataDir		VALUE(NULL),
					/* Data file directory */
			*DefaultLanguage	VALUE(NULL),
					/* Default language encoding */
			*DefaultCharset		VALUE(NULL),
					/* Default charset */
			*DefaultLocale		VALUE(NULL),
					/* Default locale */
			*RIPCache		VALUE(NULL),
					/* Amount of memory for RIPs */
			*TempDir		VALUE(NULL),
					/* Temporary directory */
			*Printcap		VALUE(NULL),
					/* Printcap file */
			*PrintcapGUI		VALUE(NULL),
					/* GUI program to use for IRIX */
			*FontPath		VALUE(NULL),
					/* Font search path */
			*RemoteRoot		VALUE(NULL),
					/* Remote root user */
			*Classification		VALUE(NULL);
					/* Classification of system */
VAR uid_t		User			VALUE(1);
					/* User ID for server */
VAR gid_t		Group			VALUE(0);
					/* Group ID for server */
VAR int			ClassifyOverride	VALUE(0),
					/* Allow overrides? */
			ConfigFilePerm		VALUE(0640),
					/* Permissions for config files */
			LogFilePerm		VALUE(0644),
					/* Permissions for log files */
			LogLevel		VALUE(CUPSD_LOG_ERROR),
					/* Log level */
			MaxClients		VALUE(0),
					/* Maximum number of clients */
			MaxClientsPerHost	VALUE(0),
					/* Maximum number of clients per host */
			MaxCopies		VALUE(100),
					/* Maximum number of copies per job */
			MaxLogSize		VALUE(1024 * 1024),
					/* Maximum size of log files */
			MaxPrinterHistory	VALUE(10),
					/* Maximum printer state history */
			MaxRequestSize		VALUE(0),
					/* Maximum size of IPP requests */
			HostNameLookups		VALUE(FALSE),
					/* Do we do reverse lookups? */
			Timeout			VALUE(DEFAULT_TIMEOUT),
					/* Timeout during requests */
			KeepAlive		VALUE(TRUE),
					/* Support the Keep-Alive option? */
			KeepAliveTimeout	VALUE(DEFAULT_KEEPALIVE),
					/* Timeout between requests */
			ImplicitClasses		VALUE(TRUE),
					/* Are classes implicitly created? */
			ImplicitAnyClasses	VALUE(FALSE),
					/* Create AnyPrinter classes? */
			HideImplicitMembers	VALUE(TRUE),
					/* Hide implicit class members? */
			FileDevice		VALUE(FALSE),
					/* Allow file: devices? */
			FilterLimit		VALUE(0),
					/* Max filter cost at any time */
			FilterLevel		VALUE(0),
					/* Current filter level */
			FilterNice		VALUE(0),
					/* Nice value for filters */
			ReloadTimeout		VALUE(0),
					/* Timeout before reload from SIGHUP */
			RootCertDuration	VALUE(300),
					/* Root certificate update interval */
			RunUser,	/* User to run as, used for files */
			PrintcapFormat		VALUE(PRINTCAP_BSD),
					/* Format of printcap file? */
			DefaultShared		VALUE(TRUE);
					/* Share printers by default? */
VAR cups_file_t		*AccessFile		VALUE(NULL),
					/* Access log file */
			*ErrorFile		VALUE(NULL),
					/* Error log file */
			*PageFile		VALUE(NULL);
					/* Page log file */
VAR mime_t		*MimeDatabase		VALUE(NULL);
					/* MIME type database */
VAR int			NumMimeTypes		VALUE(0);
					/* Number of MIME types */
VAR const char		**MimeTypes		VALUE(NULL);
					/* Array of MIME types */

#ifdef HAVE_SSL
VAR char		*ServerCertificate	VALUE(NULL);
					/* Server certificate file */
#  if defined(HAVE_LIBSSL) || defined(HAVE_GNUTLS)
VAR char		*ServerKey		VALUE(NULL);
					/* Server key file */
#  endif /* HAVE_LIBSSL || HAVE_GNUTLS */
#endif /* HAVE_SSL */

#ifdef HAVE_LAUNCHD
VAR int			LaunchdTimeout		VALUE(DEFAULT_TIMEOUT);
					/* Time after which an idle cupsd will exit */
VAR char		*LaunchdConf		VALUE(NULL);
					/* launchd(8) configuration file */
#endif /* HAVE_LAUNCHD */

/*
 * Prototypes...
 */

extern char	*cupsdGetDateTime(time_t t);
extern int	cupsdReadConfiguration(void);
extern int	cupsdLogRequest(cupsd_client_t *con, http_status_t code);
extern int	cupsdLogMessage(int level, const char *message, ...)
#ifdef __GNUC__
__attribute__ ((__format__ (__printf__, 2, 3)))
#endif /* __GNUC__ */
;
extern int	cupsdLogPage(cupsd_job_t *job, const char *page);


/*
 * End of "$Id: conf.h 5216 2006-03-02 17:47:53Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
4744bd90	2	* "$Id: conf.h 5216 2006-03-02 17:47:53Z mike $"
ef416fc2	3	*
	4	* Configuration file definitions for the Common UNIX Printing System (CUPS)
	5	* scheduler.
	6	*
bd7854cb	7	* Copyright 1997-2006 by Easy Software Products, all rights reserved.
ef416fc2	8	*
	9	* These coded instructions, statements, and computer programs are the
	10	* property of Easy Software Products and are protected by Federal
	11	* copyright law. Distribution and use rights are outlined in the file
	12	* "LICENSE.txt" which should have been included with this file. If this
	13	* file is missing or damaged please contact Easy Software Products
	14	* at:
	15	*
	16	* Attn: CUPS Licensing Information
	17	* Easy Software Products
	18	* 44141 Airport View Drive, Suite 204
	19	* Hollywood, Maryland 20636 USA
	20	*
	21	* Voice: (301) 373-9600
	22	* EMail: cups-info@cups.org
	23	* WWW: http://www.cups.org
	24	*/
	25
	26
	27	/*
	28	* Log levels...
	29	*/
	30
	31	typedef enum
	32	{
	33	CUPSD_LOG_ATTR = -3, /* Used internally for attributes */
	34	CUPSD_LOG_STATE, /* Used internally for state-reasons */
	35	CUPSD_LOG_PAGE, /* Used internally for page logging */
	36	CUPSD_LOG_NONE,
	37	CUPSD_LOG_EMERG, /* Emergency issues */
	38	CUPSD_LOG_ALERT, /* Something bad happened that needs attention */
	39	CUPSD_LOG_CRIT, /* Critical error but server continues */
	40	CUPSD_LOG_ERROR, /* Error condition */
	41	CUPSD_LOG_WARN, /* Warning */
	42	CUPSD_LOG_NOTICE, /* Normal condition that needs logging */
	43	CUPSD_LOG_INFO, /* General information */
	44	CUPSD_LOG_DEBUG, /* General debugging */
	45	CUPSD_LOG_DEBUG2 /* Detailed debugging */
	46	} cupsd_loglevel_t;
	47
	48
	49	/*
	50	* Printcap formats...
	51	*/
	52
	53	#define PRINTCAP_BSD 0 /* Berkeley LPD format */
	54	#define PRINTCAP_SOLARIS 1 /* Solaris lpsched format */
	55
	56
	57	/*
	58	* Globals...
	59	*/
	60
	61	VAR char *ConfigurationFile VALUE(NULL),
	62	/* Configuration file to use */
	63	*ServerName VALUE(NULL),
	64	/* FQDN for server */
	65	*ServerAdmin VALUE(NULL),
	66	/* Administrator's email */
	67	*ServerRoot VALUE(NULL),
	68	/* Root directory for scheduler */
	69	*ServerBin VALUE(NULL),
	70	/* Root directory for binaries */
	71	*StateDir VALUE(NULL),
72	/* Root directory for state data */
73	*RequestRoot VALUE(NULL),
74	/* Directory for request files */
75	*DocumentRoot VALUE(NULL);
76	/* Root directory for documents */
77	VAR int NumSystemGroups VALUE(0);
78	/* Number of system group names */
79	VAR char *SystemGroups[MAX_SYSTEM_GROUPS];
80	/* System group names */
bd7854cb	81	VAR gid_t SystemGroupIDs[MAX_SYSTEM_GROUPS];
ef416fc2	82	/* System group IDs */
	83	VAR char *AccessLog VALUE(NULL),
	84	/* Access log filename */
	85	*ErrorLog VALUE(NULL),
	86	/* Error log filename */
	87	*PageLog VALUE(NULL),
	88	/* Page log filename */
	89	*CacheDir VALUE(NULL),
	90	/* Cache file directory */
	91	*DataDir VALUE(NULL),
	92	/* Data file directory */
	93	*DefaultLanguage VALUE(NULL),
	94	/* Default language encoding */
	95	*DefaultCharset VALUE(NULL),
	96	/* Default charset */
	97	*DefaultLocale VALUE(NULL),
	98	/* Default locale */
	99	*RIPCache VALUE(NULL),
	100	/* Amount of memory for RIPs */
	101	*TempDir VALUE(NULL),
	102	/* Temporary directory */
	103	*Printcap VALUE(NULL),
	104	/* Printcap file */
	105	*PrintcapGUI VALUE(NULL),
	106	/* GUI program to use for IRIX */
	107	*FontPath VALUE(NULL),
	108	/* Font search path */
	109	*RemoteRoot VALUE(NULL),
	110	/* Remote root user */
	111	*Classification VALUE(NULL);
	112	/* Classification of system */
	113	VAR uid_t User VALUE(1);
	114	/* User ID for server */
	115	VAR gid_t Group VALUE(0);
	116	/* Group ID for server */
	117	VAR int ClassifyOverride VALUE(0),
	118	/* Allow overrides? */
	119	ConfigFilePerm VALUE(0640),
	120	/* Permissions for config files */
	121	LogFilePerm VALUE(0644),
	122	/* Permissions for log files */
	123	LogLevel VALUE(CUPSD_LOG_ERROR),
	124	/* Log level */
	125	MaxClients VALUE(0),
	126	/* Maximum number of clients */
	127	MaxClientsPerHost VALUE(0),
	128	/* Maximum number of clients per host */
	129	MaxCopies VALUE(100),
	130	/* Maximum number of copies per job */
	131	MaxLogSize VALUE(1024 * 1024),
	132	/* Maximum size of log files */
	133	MaxPrinterHistory VALUE(10),
	134	/* Maximum printer state history */
	135	MaxRequestSize VALUE(0),
	136	/* Maximum size of IPP requests */
	137	HostNameLookups VALUE(FALSE),
	138	/* Do we do reverse lookups? */
	139	Timeout VALUE(DEFAULT_TIMEOUT),
	140	/* Timeout during requests */
	141	KeepAlive VALUE(TRUE),
	142	/* Support the Keep-Alive option? */
	143	KeepAliveTimeout VALUE(DEFAULT_KEEPALIVE),
	144	/* Timeout between requests */
	145	ImplicitClasses VALUE(TRUE),
146	/* Are classes implicitly created? */
147	ImplicitAnyClasses VALUE(FALSE),
148	/* Create AnyPrinter classes? */
149	HideImplicitMembers VALUE(TRUE),
150	/* Hide implicit class members? */
151	FileDevice VALUE(FALSE),
152	/* Allow file: devices? */
153	FilterLimit VALUE(0),
154	/* Max filter cost at any time */
155	FilterLevel VALUE(0),
156	/* Current filter level */
157	FilterNice VALUE(0),
158	/* Nice value for filters */
159	ReloadTimeout VALUE(0),
160	/* Timeout before reload from SIGHUP */
161	RootCertDuration VALUE(300),
162	/* Root certificate update interval */
ef416fc2	163	RunUser, /* User to run as, used for files */
fa73b229	164	PrintcapFormat VALUE(PRINTCAP_BSD),
ef416fc2	165	/* Format of printcap file? */
fa73b229	166	DefaultShared VALUE(TRUE);
fa73b229	167	/* Share printers by default? */
ef416fc2	168	VAR cups_file_t *AccessFile VALUE(NULL),
	169	/* Access log file */
	170	*ErrorFile VALUE(NULL),
	171	/* Error log file */
	172	*PageFile VALUE(NULL);
	173	/* Page log file */
	174	VAR mime_t *MimeDatabase VALUE(NULL);
	175	/* MIME type database */
	176	VAR int NumMimeTypes VALUE(0);
	177	/* Number of MIME types */
	178	VAR const char **MimeTypes VALUE(NULL);
	179	/* Array of MIME types */
	180
	181	#ifdef HAVE_SSL
	182	VAR char *ServerCertificate VALUE(NULL);
	183	/* Server certificate file */
	184	# if defined(HAVE_LIBSSL) \|\| defined(HAVE_GNUTLS)
	185	VAR char *ServerKey VALUE(NULL);
	186	/* Server key file */
ef416fc2	187	# endif /* HAVE_LIBSSL \|\| HAVE_GNUTLS */
	188	#endif /* HAVE_SSL */
	189
a4d04587	190	#ifdef HAVE_LAUNCHD
	191	VAR int LaunchdTimeout VALUE(DEFAULT_TIMEOUT);
	192	/* Time after which an idle cupsd will exit */
	193	VAR char *LaunchdConf VALUE(NULL);
	194	/* launchd(8) configuration file */
	195	#endif /* HAVE_LAUNCHD */
ef416fc2	196
	197	/*
	198	* Prototypes...
	199	*/
	200
	201	extern char *cupsdGetDateTime(time_t t);
	202	extern int cupsdReadConfiguration(void);
	203	extern int cupsdLogRequest(cupsd_client_t *con, http_status_t code);
	204	extern int cupsdLogMessage(int level, const char *message, ...)
	205	#ifdef __GNUC__
	206	__attribute__ ((__format__ (__printf__, 2, 3)))
	207	#endif /* __GNUC__ */
	208	;
	209	extern int cupsdLogPage(cupsd_job_t job, const char page);
	210
	211
	212	/*
4744bd90	213	* End of "$Id: conf.h 5216 2006-03-02 17:47:53Z mike $".
ef416fc2	214	*/