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

/*
 * "$Id: printers.h 7564 2008-05-15 00:57:43Z mike $"
 *
 *   Printer definitions for the Common UNIX Printing System (CUPS) scheduler.
 *
 *   Copyright 2007-2008 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/".
 */

#ifdef HAVE_DNSSD
#  include <dns_sd.h>
#endif /* HAVE_DNSSD */

/*
 * Quota data...
 */

typedef struct
{
  char		username[33];		/* User data */
  time_t	next_update;		/* Next update time */
  int		page_count,		/* Count of pages */
		k_count;		/* Count of kilobytes */
} cupsd_quota_t;


/*
 * Printer/class information structure...
 */

typedef struct cupsd_job_s cupsd_job_t;

typedef struct cupsd_printer_s
{
  char		*uri,			/* Printer URI */
		*hostname,		/* Host printer resides on */
		*name,			/* Printer name */
		*location,		/* Location code */
		*make_model,		/* Make and model */
		*info,			/* Description */
		*op_policy,		/* Operation policy name */
		*error_policy;		/* Error policy */
  cupsd_policy_t *op_policy_ptr;	/* Pointer to operation policy */
  int		shared;			/* Shared? */
  int		accepting;		/* Accepting jobs? */
  int		holding_new_jobs;	/* Holding new jobs for printing? */
  int		in_implicit_class;	/* In an implicit class? */
  ipp_pstate_t	state;			/* Printer state */
  char		state_message[1024];	/* Printer state message */
  int		num_reasons;		/* Number of printer-state-reasons */
  char		*reasons[64];		/* printer-state-reasons strings */
  time_t	state_time;		/* Time at this state */
  char		*job_sheets[2];		/* Banners/job sheets */
  cups_ptype_t	type;			/* Printer type (color, small, etc.) */
  char		*browse_attrs;		/* Attributes sent with browse data */
  time_t	browse_expire;		/* Expiration time for printer */
  time_t	browse_time;		/* Last time update was sent/received */
  char		*device_uri;		/* Device URI */
  char		*sanitized_device_uri;	/* Sanitized device URI */
  char		*port_monitor;		/* Port monitor */
  int		raw;			/* Raw queue? */
  int		remote;			/* Remote queue? */
  mime_type_t	*filetype,		/* Pseudo-filetype for printer */
		*prefiltertype;		/* Pseudo-filetype for pre-filters */
  cups_array_t	*filetypes;		/* Supported file types */
  cupsd_job_t	*job;			/* Current job in queue */
  ipp_t		*attrs,			/* Attributes supported by this printer */
		*ppd_attrs;		/* Attributes based on the PPD */
  int		num_printers,		/* Number of printers in class */
		last_printer;		/* Last printer job was sent to */
  struct cupsd_printer_s **printers;	/* Printers in class */
  int		quota_period,		/* Period for quotas */
		page_limit,		/* Maximum number of pages */
		k_limit;		/* Maximum number of kilobytes */
  cups_array_t	*quotas;		/* Quota records */
  int		deny_users,		/* 1 = deny, 0 = allow */
		num_users;		/* Number of allowed/denied users */
  const char	**users;		/* Allowed/denied users */
  int		num_history;		/* Number of history collections */
  ipp_t		**history;		/* History data */
  int		sequence_number;	/* Increasing sequence number */
  int		num_options;		/* Number of default options */
  cups_option_t	*options;		/* Default options */
  int		num_auth_info_required;	/* Number of required auth fields */
  const char	*auth_info_required[4];	/* Required authentication fields */
  char		*alert,			/* PSX printer-alert value */
		*alert_description;	/* PSX printer-alert-description value */
  time_t	marker_time;		/* Last time marker attributes were updated */
  cups_array_t	*filters,		/* Filters for queue */
		*pre_filters;		/* Pre-filters for queue */

#ifdef HAVE_DNSSD
  char		*reg_name,		/* Name used for service registration */
		*product,		/* PPD Product string */
		*pdl,			/* pdl value for TXT record */
		*ipp_txt,		/* IPP TXT record contents */
		*printer_txt;		/* LPD TXT record contents */
  int		ipp_len,		/* IPP TXT record length */
		printer_len;		/* LPD TXT record length */
  DNSServiceRef	ipp_ref,		/* Reference for _ipp._tcp,_cups */
		printer_ref;		/* Reference for _printer._tcp */
#endif /* HAVE_DNSSD */
} cupsd_printer_t;


/*
 * Globals...
 */

VAR ipp_t		*CommonData	VALUE(NULL);
					/* Common printer object attrs */
VAR cups_array_t	*CommonDefaults	VALUE(NULL);
					/* Common -default option names */
VAR cups_array_t	*Printers	VALUE(NULL),
					/* Printer list */
			*ImplicitPrinters VALUE(NULL);
					/* Implicit class printers */
VAR cupsd_printer_t	*DefaultPrinter	VALUE(NULL);
					/* Default printer */
VAR char		*DefaultPolicy	VALUE(NULL);
					/* Default policy name */
VAR cupsd_policy_t	*DefaultPolicyPtr
					VALUE(NULL);
					/* Pointer to default policy */


/*
 * Prototypes...
 */

extern cupsd_printer_t	*cupsdAddPrinter(const char *name);
extern void		cupsdAddPrinterHistory(cupsd_printer_t *p);
extern void		cupsdAddPrinterUser(cupsd_printer_t *p,
			                    const char *username);
extern void		cupsdCreateCommonData(void);
extern void		cupsdDeleteAllPrinters(void);
extern int		cupsdDeletePrinter(cupsd_printer_t *p, int update);
extern cupsd_printer_t	*cupsdFindDest(const char *name);
extern cupsd_printer_t	*cupsdFindPrinter(const char *name);
extern cupsd_quota_t	*cupsdFindQuota(cupsd_printer_t *p,
			                const char *username);
extern void		cupsdFreePrinterUsers(cupsd_printer_t *p);
extern void		cupsdFreeQuotas(cupsd_printer_t *p);
extern void		cupsdLoadAllPrinters(void);
extern void		cupsdRenamePrinter(cupsd_printer_t *p,
			                   const char *name);
extern void		cupsdSaveAllPrinters(void);
extern int		cupsdSetAuthInfoRequired(cupsd_printer_t *p,
			                         const char *values,
						 ipp_attribute_t *attr);
extern void		cupsdSetDeviceURI(cupsd_printer_t *p, const char *uri);
extern void		cupsdSetPrinterAttr(cupsd_printer_t *p,
			                    const char *name, char *value);
extern void		cupsdSetPrinterAttrs(cupsd_printer_t *p);
extern int		cupsdSetPrinterReasons(cupsd_printer_t *p,
			                       const char *s);
extern void		cupsdSetPrinterState(cupsd_printer_t *p, ipp_pstate_t s,
			                     int update);
#define			cupsdStartPrinter(p,u) cupsdSetPrinterState((p), IPP_PRINTER_IDLE, (u))
extern void		cupsdStopPrinter(cupsd_printer_t *p, int update);
extern int		cupsdUpdatePrinterPPD(cupsd_printer_t *p,
			                      int num_keywords,
					      cups_option_t *keywords);
extern void		cupsdUpdatePrinters(void);
extern cupsd_quota_t	*cupsdUpdateQuota(cupsd_printer_t *p,
			                  const char *username, int pages,
					  int k);
extern const char	*cupsdValidateDest(const char *uri,
			        	   cups_ptype_t *dtype,
					   cupsd_printer_t **printer);
extern void		cupsdWritePrintcap(void);


/*
 * End of "$Id: printers.h 7564 2008-05-15 00:57:43Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
75bd9771	2	* "$Id: printers.h 7564 2008-05-15 00:57:43Z mike $"
ef416fc2	3	*
	4	* Printer definitions for the Common UNIX Printing System (CUPS) scheduler.
	5	*
61cf44e2	6	* Copyright 2007-2008 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	*/
ef416fc2	15
f7deaa1a	16	#ifdef HAVE_DNSSD
	17	# include <dns_sd.h>
	18	#endif /* HAVE_DNSSD */
	19
ef416fc2	20	/*
	21	* Quota data...
	22	*/
	23
	24	typedef struct
	25	{
	26	char username[33]; /* User data */
	27	time_t next_update; /* Next update time */
	28	int page_count, /* Count of pages */
	29	k_count; /* Count of kilobytes */
	30	} cupsd_quota_t;
	31
	32
	33	/*
	34	* Printer/class information structure...
	35	*/
	36
f11a948a MS	37	typedef struct cupsd_job_s cupsd_job_t;
f11a948a MS	38
ef416fc2	39	typedef struct cupsd_printer_s
	40	{
	41	char uri, / Printer URI */
	42	hostname, / Host printer resides on */
	43	name, / Printer name */
	44	location, / Location code */
	45	make_model, / Make and model */
	46	info, / Description */
	47	op_policy, / Operation policy name */
	48	error_policy; / Error policy */
	49	cupsd_policy_t op_policy_ptr; / Pointer to operation policy */
	50	int shared; /* Shared? */
	51	int accepting; /* Accepting jobs? */
61cf44e2	52	int holding_new_jobs; /* Holding new jobs for printing? */
ef416fc2	53	int in_implicit_class; /* In an implicit class? */
	54	ipp_pstate_t state; /* Printer state */
	55	char state_message[1024]; /* Printer state message */
	56	int num_reasons; /* Number of printer-state-reasons */
d1c13e16	57	char reasons[64]; / printer-state-reasons strings */
ef416fc2	58	time_t state_time; /* Time at this state */
ef416fc2	59	char job_sheets[2]; / Banners/job sheets */
09a101d6	60	cups_ptype_t type; /* Printer type (color, small, etc.) */
b423cd4c	61	char browse_attrs; / Attributes sent with browse data */
b423cd4c	62	time_t browse_expire; /* Expiration time for printer */
ef416fc2	63	time_t browse_time; /* Last time update was sent/received */
ef416fc2	64	char device_uri; / Device URI */
0af14961	65	char sanitized_device_uri; / Sanitized device URI */
ef416fc2	66	char port_monitor; / Port monitor */
ef416fc2	67	int raw; /* Raw queue? */
d09495fa	68	int remote; /* Remote queue? */
f7deaa1a	69	mime_type_t filetype, / Pseudo-filetype for printer */
f7deaa1a	70	prefiltertype; / Pseudo-filetype for pre-filters */
80ca4592	71	cups_array_t filetypes; / Supported file types */
f11a948a	72	cupsd_job_t job; / Current job in queue */
61cf44e2 MS	73	ipp_t attrs, / Attributes supported by this printer */
61cf44e2 MS	74	ppd_attrs; / Attributes based on the PPD */
ef416fc2	75	int num_printers, /* Number of printers in class */
	76	last_printer; /* Last printer job was sent to */
	77	struct cupsd_printer_s *printers; / Printers in class */
	78	int quota_period, /* Period for quotas */
	79	page_limit, /* Maximum number of pages */
fa73b229	80	k_limit; /* Maximum number of kilobytes */
fa73b229	81	cups_array_t quotas; / Quota records */
ef416fc2	82	int deny_users, /* 1 = deny, 0 = allow */
	83	num_users; /* Number of allowed/denied users */
	84	const char *users; / Allowed/denied users */
	85	int num_history; /* Number of history collections */
	86	ipp_t *history; / History data */
	87	int sequence_number; /* Increasing sequence number */
b423cd4c	88	int num_options; /* Number of default options */
b423cd4c	89	cups_option_t options; / Default options */
f7deaa1a	90	int num_auth_info_required; /* Number of required auth fields */
f7deaa1a	91	const char auth_info_required[4]; / Required authentication fields */
323c5de1	92	char alert, / PSX printer-alert value */
323c5de1	93	alert_description; / PSX printer-alert-description value */
5a738aea	94	time_t marker_time; /* Last time marker attributes were updated */
58dc1933 MS	95	cups_array_t filters, / Filters for queue */
58dc1933 MS	96	pre_filters; / Pre-filters for queue */
f7deaa1a	97
	98	#ifdef HAVE_DNSSD
	99	char reg_name, / Name used for service registration */
	100	product, / PPD Product string */
	101	pdl, / pdl value for TXT record */
7a14d768 MS	102	ipp_txt, / IPP TXT record contents */
	103	printer_txt; / LPD TXT record contents */
	104	int ipp_len, /* IPP TXT record length */
	105	printer_len; /* LPD TXT record length */
	106	DNSServiceRef ipp_ref, /* Reference for _ipp._tcp,_cups */
	107	printer_ref; /* Reference for _printer._tcp */
f7deaa1a	108	#endif /* HAVE_DNSSD */
ef416fc2	109	} cupsd_printer_t;
	110
	111
	112	/*
	113	* Globals...
	114	*/
	115
	116	VAR ipp_t *CommonData VALUE(NULL);
	117	/* Common printer object attrs */
f7deaa1a	118	VAR cups_array_t *CommonDefaults VALUE(NULL);
f7deaa1a	119	/* Common -default option names */
ef416fc2	120	VAR cups_array_t *Printers VALUE(NULL),
	121	/* Printer list */
	122	*ImplicitPrinters VALUE(NULL);
	123	/* Implicit class printers */
	124	VAR cupsd_printer_t *DefaultPrinter VALUE(NULL);
	125	/* Default printer */
	126	VAR char *DefaultPolicy VALUE(NULL);
	127	/* Default policy name */
	128	VAR cupsd_policy_t *DefaultPolicyPtr
	129	VALUE(NULL);
	130	/* Pointer to default policy */
	131
	132
	133	/*
	134	* Prototypes...
	135	*/
	136
	137	extern cupsd_printer_t cupsdAddPrinter(const char name);
ef416fc2	138	extern void cupsdAddPrinterHistory(cupsd_printer_t *p);
f7deaa1a	139	extern void cupsdAddPrinterUser(cupsd_printer_t *p,
f7deaa1a	140	const char *username);
ef416fc2	141	extern void cupsdCreateCommonData(void);
ef416fc2	142	extern void cupsdDeleteAllPrinters(void);
f8b3a85b	143	extern int cupsdDeletePrinter(cupsd_printer_t *p, int update);
ef416fc2	144	extern cupsd_printer_t cupsdFindDest(const char name);
ef416fc2	145	extern cupsd_printer_t cupsdFindPrinter(const char name);
3d8365b8	146	extern cupsd_quota_t cupsdFindQuota(cupsd_printer_t p,
3d8365b8	147	const char *username);
ef416fc2	148	extern void cupsdFreePrinterUsers(cupsd_printer_t *p);
	149	extern void cupsdFreeQuotas(cupsd_printer_t *p);
	150	extern void cupsdLoadAllPrinters(void);
f7deaa1a	151	extern void cupsdRenamePrinter(cupsd_printer_t *p,
f7deaa1a	152	const char *name);
ef416fc2	153	extern void cupsdSaveAllPrinters(void);
f7deaa1a	154	extern int cupsdSetAuthInfoRequired(cupsd_printer_t *p,
	155	const char *values,
	156	ipp_attribute_t *attr);
0af14961	157	extern void cupsdSetDeviceURI(cupsd_printer_t p, const char uri);
5a738aea MS	158	extern void cupsdSetPrinterAttr(cupsd_printer_t *p,
5a738aea MS	159	const char name, char value);
ef416fc2	160	extern void cupsdSetPrinterAttrs(cupsd_printer_t *p);
e07d4801	161	extern int cupsdSetPrinterReasons(cupsd_printer_t *p,
f7deaa1a	162	const char *s);
	163	extern void cupsdSetPrinterState(cupsd_printer_t *p, ipp_pstate_t s,
	164	int update);
ef416fc2	165	#define cupsdStartPrinter(p,u) cupsdSetPrinterState((p), IPP_PRINTER_IDLE, (u))
ef416fc2	166	extern void cupsdStopPrinter(cupsd_printer_t *p, int update);
c9fc04c6 MS	167	extern int cupsdUpdatePrinterPPD(cupsd_printer_t *p,
	168	int num_keywords,
	169	cups_option_t *keywords);
ef416fc2	170	extern void cupsdUpdatePrinters(void);
f7deaa1a	171	extern cupsd_quota_t cupsdUpdateQuota(cupsd_printer_t p,
	172	const char *username, int pages,
	173	int k);
	174	extern const char cupsdValidateDest(const char uri,
ef416fc2	175	cups_ptype_t *dtype,
	176	cupsd_printer_t **printer);
	177	extern void cupsdWritePrintcap(void);
	178
ef416fc2	179
ef416fc2	180	/*
75bd9771	181	* End of "$Id: printers.h 7564 2008-05-15 00:57:43Z mike $".
ef416fc2	182	*/