[thirdparty/cups.git] / cups / cups-private.h

/*
 * "$Id$"
 *
 *   Private definitions for CUPS.
 *
 *   Copyright 2007-2013 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"
 *   which should have been included with this file.  If this file is
 *   file is missing or damaged, see the license at "http://www.cups.org/".
 *
 *   This file is subject to the Apple OS-Developed Software exception.
 */

#ifndef _CUPS_CUPS_PRIVATE_H_
#  define _CUPS_CUPS_PRIVATE_H_

/*
 * Include necessary headers...
 */

#  include "string-private.h"
#  include "debug-private.h"
#  include "array-private.h"
#  include "ipp-private.h"
#  include "http-private.h"
#  include "language-private.h"
#  include "pwg-private.h"
#  include "ppd-private.h"
#  include "thread-private.h"
#  include <cups/cups.h>
#  ifdef __APPLE__
#    include <sys/cdefs.h>
#    include <CoreFoundation/CoreFoundation.h>
#  endif /* __APPLE__ */


/*
 * C++ magic...
 */

#  ifdef __cplusplus
extern "C" {
#  endif /* __cplusplus */


/*
 * Types...
 */

typedef struct _cups_buffer_s		/**** Read/write buffer ****/
{
  struct _cups_buffer_s	*next;		/* Next buffer in list */
  size_t		size;		/* Size of buffer */
  char			used,		/* Is this buffer used? */
			d[1];		/* Data buffer */
} _cups_buffer_t;

typedef struct _cups_globals_s		/**** CUPS global state data ****/
{
  /* Multiple places... */
  const char		*cups_datadir,	/* CUPS_DATADIR environment var */
			*cups_serverbin,/* CUPS_SERVERBIN environment var */
			*cups_serverroot,
					/* CUPS_SERVERROOT environment var */
			*cups_statedir,	/* CUPS_STATEDIR environment var */
			*localedir;	/* LOCALDIR environment var */

  /* adminutil.c */
  time_t		cupsd_update;	/* Last time we got or set cupsd.conf */
  char			cupsd_hostname[HTTP_MAX_HOST];
					/* Hostname for connection */
  int			cupsd_num_settings;
					/* Number of server settings */
  cups_option_t		*cupsd_settings;/* Server settings */

  /* auth.c */
#  ifdef HAVE_GSSAPI
  char			gss_service_name[32];
  					/* Kerberos service name */
#  endif /* HAVE_GSSAPI */

  /* backend.c */
  char			resolved_uri[1024];
					/* Buffer for cupsBackendDeviceURI */

  /* debug.c */
#  ifdef DEBUG
  int			thread_id;	/* Friendly thread ID */
#  endif /* DEBUG */

  /* file.c */
  cups_file_t		*stdio_files[3];/* stdin, stdout, stderr */

  /* http.c */
  char			http_date[256];	/* Date+time buffer */

  /* http-addr.c */
  unsigned		ip_addr;	/* Packed IPv4 address */
  char			*ip_ptrs[2];	/* Pointer to packed address */
  struct hostent	hostent;	/* Host entry for IP address */
#  ifdef HAVE_GETADDRINFO
  char			hostname[1024];	/* Hostname */
#  endif /* HAVE_GETADDRINFO */
  int			need_res_init;	/* Need to reinitialize resolver? */

  /* ipp.c */
  ipp_uchar_t		ipp_date[11];	/* RFC-1903 date/time data */
  _cups_buffer_t	*cups_buffers;	/* Buffer list */

  /* ipp-support.c */
  int			ipp_port;	/* IPP port number */
  char			ipp_unknown[255];
					/* Unknown error statuses */

  /* language.c */
  cups_lang_t		*lang_default;	/* Default language */
#  ifdef __APPLE__
  char			language[32];	/* Cached language */
#  endif /* __APPLE__ */

  /* ppd.c */
  ppd_status_t		ppd_status;	/* Status of last ppdOpen*() */
  int			ppd_line;	/* Current line number */
  ppd_conform_t		ppd_conform;	/* Level of conformance required */

  /* pwg-media.c */
  cups_array_t		*leg_size_lut,	/* Lookup table for legacy names */
			*ppd_size_lut,	/* Lookup table for PPD names */
			*pwg_size_lut;	/* Lookup table for PWG names */
  pwg_media_t		pwg_media;	/* PWG media data for custom size */
  char			pwg_name[65];	/* PWG media name for custom size */

  /* request.c */
  http_t		*http;		/* Current server connection */
  ipp_status_t		last_error;	/* Last IPP error */
  char			*last_status_message;
					/* Last IPP status-message */

  /* snmp.c */
  char			snmp_community[255];
					/* Default SNMP community name */
  int			snmp_debug;	/* Log SNMP IO to stderr? */

  /* tempfile.c */
  char			tempfile[1024];	/* cupsTempFd/File buffer */

  /* usersys.c */
  http_encryption_t	encryption;	/* Encryption setting */
  char			user[65],	/* User name */
			user_agent[256],/* User-Agent string */
			server[256],	/* Server address */
			servername[256],/* Server hostname */
			password[128];	/* Password for default callback */
  cups_password_cb2_t	password_cb;	/* Password callback */
  void			*password_data;	/* Password user data */
  http_tls_credentials_t tls_credentials;
					/* Default client credentials */
  cups_client_cert_cb_t	client_cert_cb;	/* Client certificate callback */
  void			*client_cert_data;
					/* Client certificate user data */
  cups_server_cert_cb_t	server_cert_cb;	/* Server certificate callback */
  void			*server_cert_data;
					/* Server certificate user data */
  int			server_version,	/* Server IPP version */
			any_root,	/* Allow any root */
			expired_certs,	/* Allow expired certs */
			expired_root;	/* Allow expired root */

  /* util.c */
  char			def_printer[256];
					/* Default printer */
  char			ppd_filename[HTTP_MAX_URI];
					/* PPD filename */
} _cups_globals_t;

typedef struct _cups_media_db_s		/* Media database */
{
  char		*color,			/* Media color, if any */
		*key,			/* Media key, if any */
		*info,			/* Media human-readable name, if any */
		*size_name,		/* Media PWG size name, if provided */
		*source,		/* Media source, if any */
		*type;			/* Media type, if any */
  int		width,			/* Width in hundredths of millimeters */
		length,			/* Length in hundredths of
					 * millimeters */
		bottom,			/* Bottom margin in hundredths of
					 * millimeters */
		left,			/* Left margin in hundredths of
					 * millimeters */
		right,			/* Right margin in hundredths of
					 * millimeters */
		top;			/* Top margin in hundredths of
					 * millimeters */
} _cups_media_db_t;

typedef struct _cups_dconstres_s	/* Constraint/resolver */
{
  char	*name;				/* Name of resolver */
  ipp_t	*collection;			/* Collection containing attrs */
} _cups_dconstres_t;

struct _cups_dinfo_s			/* Destination capability and status
					 * information */
{
  int			version;	/* IPP version */
  const char		*uri;		/* Printer URI */
  char			*resource;	/* Resource path */
  ipp_t			*attrs;		/* Printer attributes */
  int			num_defaults;	/* Number of default options */
  cups_option_t		*defaults;	/* Default options */
  cups_array_t		*constraints;	/* Job constraints */
  cups_array_t		*resolvers;	/* Job resolvers */
  cups_array_t		*localizations;	/* Localization information */
  cups_array_t		*media_db;	/* Media database */
  _cups_media_db_t	min_size,	/* Minimum size */
			max_size;	/* Maximum size */
  unsigned		cached_flags;	/* Flags used for cached media */
  cups_array_t		*cached_db;	/* Cache of media from last index/default */
  time_t		ready_time;	/* When xxx-ready attributes were last queried */
  ipp_t			*ready_attrs;	/* xxx-ready attributes */
  cups_array_t		*ready_db;	/* media[-col]-ready media database */
};


/*
 * Prototypes...
 */

#  ifdef __APPLE__
extern CFStringRef	_cupsAppleCopyDefaultPaperID(void);
extern CFStringRef	_cupsAppleCopyDefaultPrinter(void);
extern int		_cupsAppleGetUseLastPrinter(void);
extern void		_cupsAppleSetDefaultPaperID(CFStringRef name);
extern void		_cupsAppleSetDefaultPrinter(CFStringRef name);
extern void		_cupsAppleSetUseLastPrinter(int uselast);
#  endif /* __APPLE__ */

extern char		*_cupsBufferGet(size_t size);
extern void		_cupsBufferRelease(char *b);

extern http_t		*_cupsConnect(void);
extern int		_cupsGet1284Values(const char *device_id,
			                   cups_option_t **values);
extern const char	*_cupsGetDestResource(cups_dest_t *dest, char *resource,
			                      size_t resourcesize);
extern int		_cupsGetDests(http_t *http, ipp_op_t op,
			              const char *name, cups_dest_t **dests,
			              cups_ptype_t type, cups_ptype_t mask);
extern const char	*_cupsGetPassword(const char *prompt);
extern void		_cupsGlobalLock(void);
extern _cups_globals_t	*_cupsGlobals(void);
extern void		_cupsGlobalUnlock(void);
#  ifdef HAVE_GSSAPI
extern const char	*_cupsGSSServiceName(void);
#  endif /* HAVE_GSSAPI */
extern int		_cupsNextDelay(int current, int *previous);
extern void		_cupsSetDefaults(void);
extern void		_cupsSetError(ipp_status_t status, const char *message,
			              int localize);
extern void		_cupsSetHTTPError(http_status_t status);
#  ifdef HAVE_GSSAPI
extern int		_cupsSetNegotiateAuthString(http_t *http,
			                            const char *method,
						    const char *resource);
#  endif /* HAVE_GSSAPI */
extern char		*_cupsUserDefault(char *name, size_t namesize);


/*
 * C++ magic...
 */

#  ifdef __cplusplus
}
#  endif /* __cplusplus */
#endif /* !_CUPS_CUPS_PRIVATE_H_ */

/*
 * End of "$Id$".
 */
Commit	Line	Data
ef416fc2	1	/*
f2d18633	2	* "$Id$"
ef416fc2	3	*
71e16022	4	* Private definitions for CUPS.
ef416fc2	5	*
0cb67df3	6	* Copyright 2007-2013 by Apple Inc.
f7deaa1a	7	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2	8	*
ef416fc2	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	* This file is subject to the Apple OS-Developed Software exception.
	16	*/
	17
71e16022 MS	18	#ifndef _CUPS_CUPS_PRIVATE_H_
71e16022 MS	19	# define _CUPS_CUPS_PRIVATE_H_
ef416fc2	20
	21	/*
	22	* Include necessary headers...
	23	*/
	24
71e16022 MS	25	# include "string-private.h"
71e16022 MS	26	# include "debug-private.h"
5a9febac	27	# include "array-private.h"
71e16022	28	# include "ipp-private.h"
82cc1f9a	29	# include "http-private.h"
71e16022	30	# include "language-private.h"
54afec33	31	# include "pwg-private.h"
82cc1f9a	32	# include "ppd-private.h"
6d2f911b	33	# include "thread-private.h"
82cc1f9a	34	# include <cups/cups.h>
c8fef167 MS	35	# ifdef __APPLE__
	36	# include <sys/cdefs.h>
	37	# include <CoreFoundation/CoreFoundation.h>
	38	# endif /* __APPLE__ */
ef416fc2	39
	40
	41	/*
	42	* C++ magic...
	43	*/
	44
	45	# ifdef __cplusplus
	46	extern "C" {
	47	# endif /* __cplusplus */
	48
	49
	50	/*
71e16022	51	* Types...
ef416fc2	52	*/
ef416fc2	53
dcb445bc MS	54	typedef struct _cups_buffer_s /** Read/write buffer **/
	55	{
	56	struct _cups_buffer_s next; / Next buffer in list */
	57	size_t size; /* Size of buffer */
	58	char used, /* Is this buffer used? */
	59	d[1]; /* Data buffer */
	60	} _cups_buffer_t;
	61
ef416fc2	62	typedef struct _cups_globals_s /** CUPS global state data **/
	63	{
	64	/* Multiple places... */
	65	const char cups_datadir, / CUPS_DATADIR environment var */
	66	cups_serverbin,/ CUPS_SERVERBIN environment var */
	67	*cups_serverroot,
	68	/* CUPS_SERVERROOT environment var */
	69	cups_statedir, / CUPS_STATEDIR environment var */
	70	localedir; / LOCALDIR environment var */
	71
757d2cad	72	/* adminutil.c */
	73	time_t cupsd_update; /* Last time we got or set cupsd.conf */
	74	char cupsd_hostname[HTTP_MAX_HOST];
	75	/* Hostname for connection */
	76	int cupsd_num_settings;
	77	/* Number of server settings */
	78	cups_option_t cupsd_settings;/ Server settings */
	79
07ed0e9a MS	80	/* auth.c */
	81	# ifdef HAVE_GSSAPI
	82	char gss_service_name[32];
	83	/* Kerberos service name */
	84	# endif /* HAVE_GSSAPI */
	85
5eb9da71 MS	86	/* backend.c */
	87	char resolved_uri[1024];
	88	/* Buffer for cupsBackendDeviceURI */
	89
a469f8a5 MS	90	/* debug.c */
	91	# ifdef DEBUG
	92	int thread_id; /* Friendly thread ID */
	93	# endif /* DEBUG */
	94
80ca4592	95	/* file.c */
	96	cups_file_t stdio_files[3];/ stdin, stdout, stderr */
	97
ef416fc2	98	/* http.c */
	99	char http_date[256]; /* Date+time buffer */
	100
	101	/* http-addr.c */
	102	unsigned ip_addr; /* Packed IPv4 address */
	103	char ip_ptrs[2]; / Pointer to packed address */
	104	struct hostent hostent; /* Host entry for IP address */
	105	# ifdef HAVE_GETADDRINFO
	106	char hostname[1024]; /* Hostname */
	107	# endif /* HAVE_GETADDRINFO */
49d87452	108	int need_res_init; /* Need to reinitialize resolver? */
ef416fc2	109
	110	/* ipp.c */
	111	ipp_uchar_t ipp_date[11]; /* RFC-1903 date/time data */
dcb445bc	112	_cups_buffer_t cups_buffers; / Buffer list */
ef416fc2	113
	114	/* ipp-support.c */
	115	int ipp_port; /* IPP port number */
	116	char ipp_unknown[255];
	117	/* Unknown error statuses */
	118
ef416fc2	119	/* language.c */
fa73b229	120	cups_lang_t lang_default; / Default language */
ef416fc2	121	# ifdef __APPLE__
ef416fc2	122	char language[32]; /* Cached language */
ef416fc2	123	# endif /* __APPLE__ */
	124
	125	/* ppd.c */
	126	ppd_status_t ppd_status; /* Status of last ppdOpen() /
	127	int ppd_line; /* Current line number */
	128	ppd_conform_t ppd_conform; /* Level of conformance required */
	129
54afec33 MS	130	/* pwg-media.c */
	131	cups_array_t leg_size_lut, / Lookup table for legacy names */
	132	ppd_size_lut, / Lookup table for PPD names */
	133	pwg_size_lut; / Lookup table for PWG names */
6961465f	134	pwg_media_t pwg_media; /* PWG media data for custom size */
54afec33	135	char pwg_name[65]; /* PWG media name for custom size */
c168a833	136
5180a04c MS	137	/* request.c */
	138	http_t http; / Current server connection */
	139	ipp_status_t last_error; /* Last IPP error */
	140	char *last_status_message;
	141	/* Last IPP status-message */
	142
91c84a35	143	/* snmp.c */
ac884b6a MS	144	char snmp_community[255];
ac884b6a MS	145	/* Default SNMP community name */
91c84a35 MS	146	int snmp_debug; /* Log SNMP IO to stderr? */
91c84a35 MS	147
ef416fc2	148	/* tempfile.c */
	149	char tempfile[1024]; /* cupsTempFd/File buffer */
	150
ef416fc2	151	/* usersys.c */
	152	http_encryption_t encryption; /* Encryption setting */
	153	char user[65], /* User name */
db8b865d	154	user_agent[256],/* User-Agent string */
ef416fc2	155	server[256], /* Server address */
dcb445bc MS	156	servername[256],/* Server hostname */
dcb445bc MS	157	password[128]; /* Password for default callback */
f11a948a MS	158	cups_password_cb2_t password_cb; /* Password callback */
f11a948a MS	159	void password_data; / Password user data */
7cf5915e MS	160	http_tls_credentials_t tls_credentials;
	161	/* Default client credentials */
	162	cups_client_cert_cb_t client_cert_cb; /* Client certificate callback */
	163	void *client_cert_data;
	164	/* Client certificate user data */
	165	cups_server_cert_cb_t server_cert_cb; /* Server certificate callback */
	166	void *server_cert_data;
	167	/* Server certificate user data */
0cb67df3 MS	168	int server_version, /* Server IPP version */
0cb67df3 MS	169	any_root, /* Allow any root */
7cf5915e MS	170	expired_certs, /* Allow expired certs */
7cf5915e MS	171	expired_root; /* Allow expired root */
ef416fc2	172
ef416fc2	173	/* util.c */
ef416fc2	174	char def_printer[256];
	175	/* Default printer */
	176	char ppd_filename[HTTP_MAX_URI];
	177	/* PPD filename */
	178	} _cups_globals_t;
	179
dcb445bc MS	180	typedef struct _cups_media_db_s /* Media database */
	181	{
	182	char color, / Media color, if any */
	183	key, / Media key, if any */
	184	info, / Media human-readable name, if any */
	185	size_name, / Media PWG size name, if provided */
	186	source, / Media source, if any */
	187	type; / Media type, if any */
	188	int width, /* Width in hundredths of millimeters */
	189	length, /* Length in hundredths of
	190	* millimeters */
	191	bottom, /* Bottom margin in hundredths of
	192	* millimeters */
	193	left, /* Left margin in hundredths of
	194	* millimeters */
	195	right, /* Right margin in hundredths of
	196	* millimeters */
	197	top; /* Top margin in hundredths of
	198	* millimeters */
	199	} _cups_media_db_t;
	200
a29fd7dd MS	201	typedef struct _cups_dconstres_s /* Constraint/resolver */
	202	{
	203	char name; / Name of resolver */
	204	ipp_t collection; / Collection containing attrs */
	205	} _cups_dconstres_t;
	206
dcb445bc MS	207	struct _cups_dinfo_s /* Destination capability and status
	208	* information */
	209	{
6961465f	210	int version; /* IPP version */
dcb445bc MS	211	const char uri; / Printer URI */
	212	char resource; / Resource path */
	213	ipp_t attrs; / Printer attributes */
a29fd7dd MS	214	int num_defaults; /* Number of default options */
a29fd7dd MS	215	cups_option_t defaults; / Default options */
dcb445bc	216	cups_array_t constraints; / Job constraints */
a29fd7dd	217	cups_array_t resolvers; / Job resolvers */
dcb445bc MS	218	cups_array_t localizations; / Localization information */
	219	cups_array_t media_db; / Media database */
	220	_cups_media_db_t min_size, /* Minimum size */
	221	max_size; /* Maximum size */
6961465f MS	222	unsigned cached_flags; /* Flags used for cached media */
	223	cups_array_t cached_db; / Cache of media from last index/default */
	224	time_t ready_time; /* When xxx-ready attributes were last queried */
	225	ipp_t ready_attrs; / xxx-ready attributes */
	226	cups_array_t ready_db; / media[-col]-ready media database */
dcb445bc MS	227	};
dcb445bc MS	228
ef416fc2	229
	230	/*
	231	* Prototypes...
	232	*/
	233
c8fef167 MS	234	# ifdef __APPLE__
c8fef167 MS	235	extern CFStringRef _cupsAppleCopyDefaultPaperID(void);
f14324a7	236	extern CFStringRef _cupsAppleCopyDefaultPrinter(void);
c8fef167 MS	237	extern int _cupsAppleGetUseLastPrinter(void);
c8fef167 MS	238	extern void _cupsAppleSetDefaultPaperID(CFStringRef name);
f14324a7	239	extern void _cupsAppleSetDefaultPrinter(CFStringRef name);
c8fef167 MS	240	extern void _cupsAppleSetUseLastPrinter(int uselast);
	241	# endif /* __APPLE__ */
	242
dcb445bc MS	243	extern char *_cupsBufferGet(size_t size);
	244	extern void _cupsBufferRelease(char *b);
	245
3d052e43	246	extern http_t *_cupsConnect(void);
f8b3a85b MS	247	extern int _cupsGet1284Values(const char *device_id,
f8b3a85b MS	248	cups_option_t **values);
dcb445bc MS	249	extern const char _cupsGetDestResource(cups_dest_t dest, char *resource,
dcb445bc MS	250	size_t resourcesize);
c8fef167	251	extern int _cupsGetDests(http_t *http, ipp_op_t op,
dcb445bc MS	252	const char name, cups_dest_t *dests,
dcb445bc MS	253	cups_ptype_t type, cups_ptype_t mask);
ef416fc2	254	extern const char _cupsGetPassword(const char prompt);
6d2f911b	255	extern void _cupsGlobalLock(void);
ef416fc2	256	extern _cups_globals_t *_cupsGlobals(void);
6d2f911b	257	extern void _cupsGlobalUnlock(void);
eac3a0a0 MS	258	# ifdef HAVE_GSSAPI
	259	extern const char *_cupsGSSServiceName(void);
	260	# endif /* HAVE_GSSAPI */
f14324a7	261	extern int _cupsNextDelay(int current, int *previous);
e07d4801	262	extern void _cupsSetDefaults(void);
749b1e90 MS	263	extern void _cupsSetError(ipp_status_t status, const char *message,
749b1e90 MS	264	int localize);
355e94dc	265	extern void _cupsSetHTTPError(http_status_t status);
f14324a7	266	# ifdef HAVE_GSSAPI
eac3a0a0 MS	267	extern int _cupsSetNegotiateAuthString(http_t *http,
	268	const char *method,
	269	const char *resource);
f14324a7	270	# endif /* HAVE_GSSAPI */
38e73f87	271	extern char _cupsUserDefault(char name, size_t namesize);
ef416fc2	272
	273
	274	/*
	275	* C++ magic...
	276	*/
	277
	278	# ifdef __cplusplus
	279	}
	280	# endif /* __cplusplus */
71e16022	281	#endif /* !_CUPS_CUPS_PRIVATE_H_ */
ef416fc2	282
ef416fc2	283	/*
f2d18633	284	* End of "$Id$".
ef416fc2	285	*/