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

/*
 * "$Id: cupsd.h 6376 2007-03-21 06:39:10Z mike $"
 *
 *   Main header file for the Common UNIX Printing System (CUPS) scheduler.
 *
 *   Copyright 1997-2007 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" 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
 */


/*
 * Include necessary headers.
 */

#include <cups/http-private.h>
#include <cups/string.h>
#include <stdlib.h>
#include <limits.h>
#include <errno.h>
#include <time.h>
#include <signal.h>
#include <fcntl.h>
#include <math.h>
#include <sys/types.h>
#include <sys/time.h>
#include <sys/stat.h>
#include <sys/wait.h>

#ifdef WIN32
#  include <direct.h>
#else
#  include <unistd.h>
#endif /* WIN32 */

#include <cups/array.h>
#include <cups/cups.h>
#include "mime.h"
#include <cups/http.h>
#include <cups/ipp.h>
#include <cups/i18n.h>
#include <cups/debug.h>

#if defined(HAVE_CDSASSL)
#  include <CoreFoundation/CoreFoundation.h>
#endif /* HAVE_CDSASSL */


/*
 * Some OS's don't have hstrerror(), most notably Solaris...
 */

#ifndef HAVE_HSTRERROR
#  ifdef hstrerror
#    undef hstrerror
#  endif /* hstrerror */
#  define hstrerror cups_hstrerror

extern const char *cups_hstrerror(int);
#endif /* !HAVE_HSTRERROR */


/*
 * Common constants.
 */

#ifndef FALSE
#  define FALSE		0
#  define TRUE		(!FALSE)
#endif /* !FALSE */


/*
 * Implementation limits...
 */

#define MAX_ENV			100	/* Maximum number of environment strings */
#define MAX_USERPASS		33	/* Maximum size of username/password */
#define MAX_FILTERS		20	/* Maximum number of filters */
#define MAX_SYSTEM_GROUPS	32	/* Maximum number of system groups */


/*
 * Defaults...
 */

#define DEFAULT_HISTORY		1	/* Preserve job history? */
#define DEFAULT_FILES		0	/* Preserve job files? */
#define DEFAULT_TIMEOUT		300	/* Timeout during requests/updates */
#define DEFAULT_KEEPALIVE	60	/* Timeout between requests */
#define DEFAULT_INTERVAL	30	/* Interval between browse updates */
#define DEFAULT_CHARSET		"utf-8"	/* Default charset */


/*
 * Global variable macros...
 */

#ifdef _MAIN_C_
#  define VAR
#  define VALUE(x) =x
#  define VALUE2(x,y) ={x,y}
#else
#  define VAR      extern
#  define VALUE(x)
#  define VALUE2(x,y)
#endif /* _MAIN_C */


/*
 * Other stuff for the scheduler...
 */

#include "sysman.h"
#include "statbuf.h"
#include "cert.h"
#include "auth.h"
#include "client.h"
#include "policy.h"
#include "printers.h"
#include "classes.h"
#include "job.h"
#include "conf.h"
#include "banners.h"
#include "dirsvc.h"
#include "network.h"
#include "subscriptions.h"


/*
 * Reload types...
 */

#define RELOAD_NONE	0		/* No reload needed */
#define RELOAD_ALL	1		/* Reload everything */
#define RELOAD_CUPSD	2		/* Reload only cupsd.conf */


/*
 * Select callback function type...
 */

typedef void (*cupsd_selfunc_t)(void *data);


/*
 * Globals...
 */

VAR int			MaxFDs;		/* Maximum number of files */

VAR time_t		ReloadTime	VALUE(0);
					/* Time of reload request... */
VAR int			NeedReload	VALUE(RELOAD_ALL);
					/* Need to load configuration? */
#ifdef HAVE_LAUNCH_H
VAR int			Launchd		VALUE(0);
					/* Running from launchd */
#endif /* HAVE_LAUNCH_H */

#if defined(__APPLE__) && defined(HAVE_DLFCN_H)
typedef int (*PSQUpdateQuotaProcPtr)(const char *printer, const char *info, 
                                     const char *user, int nPages, int options);
VAR PSQUpdateQuotaProcPtr PSQUpdateQuotaProc
					VALUE(0);
					/* Apple PrintService quota function */
#endif /* __APPLE__ && HAVE_DLFCN_H */


/*
 * Prototypes...
 */

extern void	cupsdClearString(char **s);
extern void	cupsdHoldSignals(void);
extern void	cupsdReleaseSignals(void);
extern void	cupsdSetString(char **s, const char *v);
extern void	cupsdSetStringf(char **s, const char *f, ...)
#ifdef __GNUC__
__attribute__ ((__format__ (__printf__, 2, 3)))
#endif /* __GNUC__ */
;
extern void	cupsdStartServer(void);
extern void	cupsdStopServer(void);
extern void	cupsdClosePipe(int *fds);
extern int	cupsdOpenPipe(int *fds);

extern void	cupsdInitEnv(void);
extern int	cupsdLoadEnv(char *envp[], int envmax);
extern void	cupsdSetEnv(const char *name, const char *value);
extern void	cupsdSetEnvf(const char *name, const char *value, ...)
#ifdef __GNUC__
__attribute__ ((__format__ (__printf__, 2, 3)))
#endif /* __GNUC__ */
;

extern int	cupsdEndProcess(int pid, int force);
extern const char *cupsdFinishProcess(int pid, char *name, int namelen);
extern int	cupsdStartProcess(const char *command, char *argv[],
				  char *envp[], int infd, int outfd,
				  int errfd, int backfd, int sidefd,
				  int root, int *pid);

extern int	cupsdAddSelect(int fd, cupsd_selfunc_t read_cb,
		               cupsd_selfunc_t write_cb, void *data);
extern int	cupsdDoSelect(long timeout);
#ifdef CUPSD_IS_SELECTING
extern int	cupsdIsSelecting(int fd);
#endif /* CUPSD_IS_SELECTING */
extern void	cupsdRemoveSelect(int fd);
extern void	cupsdStartSelect(void);
extern void	cupsdStopSelect(void);


/*
 * End of "$Id: cupsd.h 6376 2007-03-21 06:39:10Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
f899b121	2	* "$Id: cupsd.h 6376 2007-03-21 06:39:10Z mike $"
ef416fc2	3	*
	4	* Main header file for the Common UNIX Printing System (CUPS) scheduler.
	5	*
f899b121	6	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2	7	*
	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" which should have been included with this file. If this
	12	* file is missing or damaged please contact Easy Software Products
	13	* at:
	14	*
	15	* Attn: CUPS Licensing Information
	16	* Easy Software Products
	17	* 44141 Airport View Drive, Suite 204
	18	* Hollywood, Maryland 20636 USA
	19	*
	20	* Voice: (301) 373-9600
	21	* EMail: cups-info@cups.org
	22	* WWW: http://www.cups.org
	23	*/
	24
	25
	26	/*
	27	* Include necessary headers.
	28	*/
	29
	30	#include <cups/http-private.h>
	31	#include <cups/string.h>
	32	#include <stdlib.h>
	33	#include <limits.h>
	34	#include <errno.h>
	35	#include <time.h>
	36	#include <signal.h>
	37	#include <fcntl.h>
	38	#include <math.h>
	39	#include <sys/types.h>
	40	#include <sys/time.h>
	41	#include <sys/stat.h>
	42	#include <sys/wait.h>
	43
	44	#ifdef WIN32
	45	# include <direct.h>
	46	#else
	47	# include <unistd.h>
	48	#endif /* WIN32 */
	49
	50	#include <cups/array.h>
	51	#include <cups/cups.h>
	52	#include "mime.h"
	53	#include <cups/http.h>
	54	#include <cups/ipp.h>
	55	#include <cups/i18n.h>
	56	#include <cups/debug.h>
	57
	58	#if defined(HAVE_CDSASSL)
	59	# include <CoreFoundation/CoreFoundation.h>
	60	#endif /* HAVE_CDSASSL */
	61
	62
	63	/*
	64	* Some OS's don't have hstrerror(), most notably Solaris...
	65	*/
	66
	67	#ifndef HAVE_HSTRERROR
b423cd4c	68	# ifdef hstrerror
	69	# undef hstrerror
	70	# endif /* hstrerror */
ef416fc2	71	# define hstrerror cups_hstrerror
	72
	73	extern const char *cups_hstrerror(int);
	74	#endif /* !HAVE_HSTRERROR */
	75
	76
	77	/*
	78	* Common constants.
	79	*/
	80
	81	#ifndef FALSE
	82	# define FALSE 0
	83	# define TRUE (!FALSE)
	84	#endif /* !FALSE */
	85
	86
	87	/*
	88	* Implementation limits...
	89	*/
	90
e00b005a	91	#define MAX_ENV 100 /* Maximum number of environment strings */
ef416fc2	92	#define MAX_USERPASS 33 /* Maximum size of username/password */
	93	#define MAX_FILTERS 20 /* Maximum number of filters */
	94	#define MAX_SYSTEM_GROUPS 32 /* Maximum number of system groups */
	95
	96
	97	/*
	98	* Defaults...
	99	*/
	100
	101	#define DEFAULT_HISTORY 1 /* Preserve job history? */
	102	#define DEFAULT_FILES 0 /* Preserve job files? */
	103	#define DEFAULT_TIMEOUT 300 /* Timeout during requests/updates */
	104	#define DEFAULT_KEEPALIVE 60 /* Timeout between requests */
	105	#define DEFAULT_INTERVAL 30 /* Interval between browse updates */
	106	#define DEFAULT_CHARSET "utf-8" /* Default charset */
	107
	108
	109	/*
	110	* Global variable macros...
	111	*/
	112
	113	#ifdef _MAIN_C_
	114	# define VAR
	115	# define VALUE(x) =x
	116	# define VALUE2(x,y) ={x,y}
	117	#else
	118	# define VAR extern
	119	# define VALUE(x)
	120	# define VALUE2(x,y)
	121	#endif /* _MAIN_C */
	122
	123
	124	/*
	125	* Other stuff for the scheduler...
	126	*/
	127
09ec0018	128	#include "sysman.h"
ef416fc2	129	#include "statbuf.h"
	130	#include "cert.h"
	131	#include "auth.h"
	132	#include "client.h"
	133	#include "policy.h"
	134	#include "printers.h"
	135	#include "classes.h"
	136	#include "job.h"
	137	#include "conf.h"
	138	#include "banners.h"
	139	#include "dirsvc.h"
	140	#include "network.h"
	141	#include "subscriptions.h"
	142
	143
	144	/*
	145	* Reload types...
	146	*/
	147
	148	#define RELOAD_NONE 0 /* No reload needed */
	149	#define RELOAD_ALL 1 /* Reload everything */
	150	#define RELOAD_CUPSD 2 /* Reload only cupsd.conf */
	151
	152
f7deaa1a	153	/*
	154	* Select callback function type...
	155	*/
	156
	157	typedef void (cupsd_selfunc_t)(void data);
	158
	159
ef416fc2	160	/*
	161	* Globals...
	162	*/
	163
f7deaa1a	164	VAR int MaxFDs; /* Maximum number of files */
ef416fc2	165
	166	VAR time_t ReloadTime VALUE(0);
	167	/* Time of reload request... */
	168	VAR int NeedReload VALUE(RELOAD_ALL);
	169	/* Need to load configuration? */
4400e98d	170	#ifdef HAVE_LAUNCH_H
	171	VAR int Launchd VALUE(0);
	172	/* Running from launchd */
	173	#endif /* HAVE_LAUNCH_H */
ef416fc2	174
7594b224	175	#if defined(__APPLE__) && defined(HAVE_DLFCN_H)
	176	typedef int (PSQUpdateQuotaProcPtr)(const char printer, const char *info,
	177	const char *user, int nPages, int options);
	178	VAR PSQUpdateQuotaProcPtr PSQUpdateQuotaProc
	179	VALUE(0);
	180	/* Apple PrintService quota function */
	181	#endif /* __APPLE__ && HAVE_DLFCN_H */
	182
	183
	184
ef416fc2	185
	186	/*
	187	* Prototypes...
	188	*/
	189
ef416fc2	190	extern void cupsdClearString(char **s);
ef416fc2	191	extern void cupsdHoldSignals(void);
ef416fc2	192	extern void cupsdReleaseSignals(void);
	193	extern void cupsdSetString(char *s, const char v);
	194	extern void cupsdSetStringf(char *s, const char f, ...)
	195	#ifdef __GNUC__
	196	__attribute__ ((__format__ (__printf__, 2, 3)))
	197	#endif /* __GNUC__ */
	198	;
	199	extern void cupsdStartServer(void);
	200	extern void cupsdStopServer(void);
	201	extern void cupsdClosePipe(int *fds);
	202	extern int cupsdOpenPipe(int *fds);
	203
ef416fc2	204	extern void cupsdInitEnv(void);
	205	extern int cupsdLoadEnv(char *envp[], int envmax);
	206	extern void cupsdSetEnv(const char name, const char value);
	207	extern void cupsdSetEnvf(const char name, const char value, ...)
	208	#ifdef __GNUC__
	209	__attribute__ ((__format__ (__printf__, 2, 3)))
	210	#endif /* __GNUC__ */
	211	;
	212
	213	extern int cupsdEndProcess(int pid, int force);
e00b005a	214	extern const char cupsdFinishProcess(int pid, char name, int namelen);
ef416fc2	215	extern int cupsdStartProcess(const char command, char argv[],
ef416fc2	216	char *envp[], int infd, int outfd,
f7deaa1a	217	int errfd, int backfd, int sidefd,
	218	int root, int *pid);
	219
	220	extern int cupsdAddSelect(int fd, cupsd_selfunc_t read_cb,
	221	cupsd_selfunc_t write_cb, void *data);
	222	extern int cupsdDoSelect(long timeout);
f899b121	223	#ifdef CUPSD_IS_SELECTING
f7deaa1a	224	extern int cupsdIsSelecting(int fd);
f899b121	225	#endif /* CUPSD_IS_SELECTING */
f7deaa1a	226	extern void cupsdRemoveSelect(int fd);
	227	extern void cupsdStartSelect(void);
	228	extern void cupsdStopSelect(void);
ef416fc2	229
	230
	231	/*
f899b121	232	* End of "$Id: cupsd.h 6376 2007-03-21 06:39:10Z mike $".
ef416fc2	233	*/