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

/*
 * Main header file for the CUPS scheduler.
 *
 * Copyright 2007-2014 by Apple Inc.
 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
 *
 * These coded instructions, statements, and computer programs are the
 * property of Apple Inc. and are protected by Federal copyright
 * law.  Distribution and use rights are outlined in the file "LICENSE.txt"
 * "LICENSE" which should have been included with this file.  If this
 * file is missing or damaged, see the license at "http://www.cups.org/".
 */


/*
 * Include necessary headers.
 */

#include <cups/cups-private.h>
#include <cups/file-private.h>
#include <cups/ppd-private.h>

#include <limits.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 "mime.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		INT_MAX	/* Preserve job history? */
#define DEFAULT_FILES		86400	/* Preserve job files? */
#define DEFAULT_TIMEOUT		300	/* Timeout during requests/updates */
#define DEFAULT_KEEPALIVE	30	/* Timeout between requests */


/*
 * 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 "colorman.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			TestConfigFile	VALUE(0);
					/* Test the cupsd.conf file? */
VAR int			MaxFDs		VALUE(0);
					/* Maximum number of files */

VAR time_t		ReloadTime	VALUE(0);
					/* Time of reload request... */
VAR int			NeedReload	VALUE(RELOAD_ALL),
					/* Need to load configuration? */
			DoingShutdown	VALUE(0);
					/* Shutting down the scheduler? */
VAR void		*DefaultProfile	VALUE(0);
					/* Default security profile */

#if defined(HAVE_LAUNCHD) || defined(HAVE_SYSTEMD)
VAR int			OnDemand	VALUE(0);
					/* Launched on demand */
#endif /* HAVE_LAUNCHD || HAVE_SYSTEMD */


/*
 * Prototypes...
 */

/* env.c */
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, ...)
			__attribute__ ((__format__ (__printf__, 2, 3)));
extern void		cupsdUpdateEnv(void);

/* file.c */
extern void		cupsdCleanFiles(const char *path, const char *pattern);
extern int		cupsdCloseCreatedConfFile(cups_file_t *fp,
			                          const char *filename);
extern void		cupsdClosePipe(int *fds);
extern cups_file_t	*cupsdCreateConfFile(const char *filename, mode_t mode);
extern cups_file_t	*cupsdOpenConfFile(const char *filename);
extern int		cupsdOpenPipe(int *fds);
extern int		cupsdRemoveFile(const char *filename);
extern int		cupsdUnlinkOrRemoveFile(const char *filename);

/* main.c */
extern int		cupsdAddString(cups_array_t **a, const char *s);
extern void		cupsdCheckProcess(void);
extern void		cupsdClearString(char **s);
extern void		cupsdFreeStrings(cups_array_t **a);
extern void		cupsdHoldSignals(void);
extern char		*cupsdMakeUUID(const char *name, int number,
				       char *buffer, size_t bufsize);
extern void		cupsdReleaseSignals(void);
extern void		cupsdSetString(char **s, const char *v);
extern void		cupsdSetStringf(char **s, const char *f, ...)
			__attribute__ ((__format__ (__printf__, 2, 3)));

/* process.c */
extern void		*cupsdCreateProfile(int job_id, int allow_networking);
extern void		cupsdDestroyProfile(void *profile);
extern int		cupsdEndProcess(int pid, int force);
extern const char	*cupsdFinishProcess(int pid, char *name, size_t namelen, int *job_id);
extern int		cupsdStartProcess(const char *command, char *argv[],
					  char *envp[], int infd, int outfd,
					  int errfd, int backfd, int sidefd,
					  int root, void *profile,
					  cupsd_job_t *job, int *pid);

/* select.c */
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);

/* server.c */
extern void		cupsdStartServer(void);
extern void		cupsdStopServer(void);
Commit	Line	Data
	1	/*
	2	* Main header file for the CUPS scheduler.
	3	*
	4	* Copyright 2007-2014 by Apple Inc.
	5	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
	6	*
	7	* These coded instructions, statements, and computer programs are the
	8	* property of Apple Inc. and are protected by Federal copyright
	9	* law. Distribution and use rights are outlined in the file "LICENSE.txt"
	10	* "LICENSE" which should have been included with this file. If this
	11	* file is missing or damaged, see the license at "http://www.cups.org/".
	12	*/
	13
	14
	15	/*
	16	* Include necessary headers.
	17	*/
	18
	19	#include <cups/cups-private.h>
	20	#include <cups/file-private.h>
	21	#include <cups/ppd-private.h>
	22
	23	#include <limits.h>
	24	#include <time.h>
	25	#include <signal.h>
	26	#include <fcntl.h>
	27	#include <math.h>
	28	#include <sys/types.h>
	29	#include <sys/time.h>
	30	#include <sys/stat.h>
	31	#include <sys/wait.h>
	32
	33	#ifdef WIN32
	34	# include <direct.h>
	35	#else
	36	# include <unistd.h>
	37	#endif /* WIN32 */
	38
	39	#include "mime.h"
	40
	41	#if defined(HAVE_CDSASSL)
	42	# include <CoreFoundation/CoreFoundation.h>
	43	#endif /* HAVE_CDSASSL */
	44
	45
	46	/*
	47	* Some OS's don't have hstrerror(), most notably Solaris...
	48	*/
	49
	50	#ifndef HAVE_HSTRERROR
	51	# ifdef hstrerror
	52	# undef hstrerror
	53	# endif /* hstrerror */
	54	# define hstrerror cups_hstrerror
	55
	56	extern const char *cups_hstrerror(int);
	57	#endif /* !HAVE_HSTRERROR */
	58
	59
	60	/*
	61	* Common constants.
	62	*/
	63
	64	#ifndef FALSE
	65	# define FALSE 0
	66	# define TRUE (!FALSE)
	67	#endif /* !FALSE */
	68
	69
	70	/*
	71	* Implementation limits...
	72	*/
	73
	74	#define MAX_ENV 100 /* Maximum number of environment strings */
	75	#define MAX_USERPASS 33 /* Maximum size of username/password */
	76	#define MAX_FILTERS 20 /* Maximum number of filters */
	77	#define MAX_SYSTEM_GROUPS 32 /* Maximum number of system groups */
	78
	79
	80	/*
	81	* Defaults...
	82	*/
	83
	84	#define DEFAULT_HISTORY INT_MAX /* Preserve job history? */
	85	#define DEFAULT_FILES 86400 /* Preserve job files? */
	86	#define DEFAULT_TIMEOUT 300 /* Timeout during requests/updates */
	87	#define DEFAULT_KEEPALIVE 30 /* Timeout between requests */
	88
	89
	90	/*
	91	* Global variable macros...
	92	*/
	93
	94	#ifdef _MAIN_C_
	95	# define VAR
	96	# define VALUE(x) =x
	97	# define VALUE2(x,y) ={x,y}
	98	#else
	99	# define VAR extern
	100	# define VALUE(x)
	101	# define VALUE2(x,y)
	102	#endif /* _MAIN_C */
	103
	104
	105	/*
	106	* Other stuff for the scheduler...
	107	*/
	108
	109	#include "sysman.h"
	110	#include "statbuf.h"
	111	#include "cert.h"
	112	#include "auth.h"
	113	#include "client.h"
	114	#include "policy.h"
	115	#include "printers.h"
	116	#include "classes.h"
	117	#include "job.h"
	118	#include "colorman.h"
	119	#include "conf.h"
	120	#include "banners.h"
	121	#include "dirsvc.h"
	122	#include "network.h"
	123	#include "subscriptions.h"
	124
	125
	126	/*
	127	* Reload types...
	128	*/
	129
	130	#define RELOAD_NONE 0 /* No reload needed */
	131	#define RELOAD_ALL 1 /* Reload everything */
	132	#define RELOAD_CUPSD 2 /* Reload only cupsd.conf */
	133
	134
	135	/*
	136	* Select callback function type...
	137	*/
	138
	139	typedef void (cupsd_selfunc_t)(void data);
	140
	141
	142	/*
	143	* Globals...
	144	*/
	145
	146	VAR int TestConfigFile VALUE(0);
	147	/* Test the cupsd.conf file? */
	148	VAR int MaxFDs VALUE(0);
	149	/* Maximum number of files */
	150
	151	VAR time_t ReloadTime VALUE(0);
	152	/* Time of reload request... */
	153	VAR int NeedReload VALUE(RELOAD_ALL),
	154	/* Need to load configuration? */
	155	DoingShutdown VALUE(0);
	156	/* Shutting down the scheduler? */
	157	VAR void *DefaultProfile VALUE(0);
	158	/* Default security profile */
	159
	160	#if defined(HAVE_LAUNCHD) \|\| defined(HAVE_SYSTEMD)
	161	VAR int OnDemand VALUE(0);
	162	/* Launched on demand */
	163	#endif /* HAVE_LAUNCHD \|\| HAVE_SYSTEMD */
	164
	165
	166	/*
	167	* Prototypes...
	168	*/
	169
	170	/* env.c */
	171	extern void cupsdInitEnv(void);
	172	extern int cupsdLoadEnv(char *envp[], int envmax);
	173	extern void cupsdSetEnv(const char name, const char value);
	174	extern void cupsdSetEnvf(const char name, const char value, ...)
	175	__attribute__ ((__format__ (__printf__, 2, 3)));
	176	extern void cupsdUpdateEnv(void);
	177
	178	/* file.c */
	179	extern void cupsdCleanFiles(const char path, const char pattern);
	180	extern int cupsdCloseCreatedConfFile(cups_file_t *fp,
	181	const char *filename);
	182	extern void cupsdClosePipe(int *fds);
	183	extern cups_file_t cupsdCreateConfFile(const char filename, mode_t mode);
	184	extern cups_file_t cupsdOpenConfFile(const char filename);
	185	extern int cupsdOpenPipe(int *fds);
	186	extern int cupsdRemoveFile(const char *filename);
	187	extern int cupsdUnlinkOrRemoveFile(const char *filename);
	188
	189	/* main.c */
	190	extern int cupsdAddString(cups_array_t *a, const char s);
	191	extern void cupsdCheckProcess(void);
	192	extern void cupsdClearString(char **s);
	193	extern void cupsdFreeStrings(cups_array_t **a);
	194	extern void cupsdHoldSignals(void);
	195	extern char cupsdMakeUUID(const char name, int number,
	196	char *buffer, size_t bufsize);
	197	extern void cupsdReleaseSignals(void);
	198	extern void cupsdSetString(char *s, const char v);
	199	extern void cupsdSetStringf(char *s, const char f, ...)
	200	__attribute__ ((__format__ (__printf__, 2, 3)));
	201
	202	/* process.c */
	203	extern void *cupsdCreateProfile(int job_id, int allow_networking);
	204	extern void cupsdDestroyProfile(void *profile);
	205	extern int cupsdEndProcess(int pid, int force);
	206	extern const char cupsdFinishProcess(int pid, char name, size_t namelen, int *job_id);
	207	extern int cupsdStartProcess(const char command, char argv[],
	208	char *envp[], int infd, int outfd,
	209	int errfd, int backfd, int sidefd,
	210	int root, void *profile,
	211	cupsd_job_t job, int pid);
	212
	213	/* select.c */
	214	extern int cupsdAddSelect(int fd, cupsd_selfunc_t read_cb,
	215	cupsd_selfunc_t write_cb, void *data);
	216	extern int cupsdDoSelect(long timeout);
	217	#ifdef CUPSD_IS_SELECTING
	218	extern int cupsdIsSelecting(int fd);
	219	#endif /* CUPSD_IS_SELECTING */
	220	extern void cupsdRemoveSelect(int fd);
	221	extern void cupsdStartSelect(void);
	222	extern void cupsdStopSelect(void);
	223
	224	/* server.c */
	225	extern void cupsdStartServer(void);
	226	extern void cupsdStopServer(void);