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

/*
 * "$Id: printers.h 11380 2013-11-05 01:14:53Z msweet $"
 *
 * Printer definitions for the CUPS scheduler.
 *
 * 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/".
 */

#ifdef HAVE_DNSSD
#  include <dns_sd.h>
#elif defined(HAVE_AVAHI)
#  include <avahi-client/client.h>
#  include <avahi-client/publish.h>
#  include <avahi-common/error.h>
#  include <avahi-common/thread-watch.h>
#endif /* HAVE_DNSSD */
#include <cups/pwg-private.h>


/*
 * 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;


/*
 * DNS-SD types to make the code cleaner/clearer...
 */

#ifdef HAVE_DNSSD
typedef DNSServiceRef cupsd_srv_t;	/* Service reference */
typedef TXTRecordRef cupsd_txt_t;	/* TXT record */

#elif defined(HAVE_AVAHI)
typedef AvahiEntryGroup *cupsd_srv_t;	/* Service reference */
typedef AvahiStringList *cupsd_txt_t;	/* TXT record */
#endif /* HAVE_DNSSD */


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

typedef struct cupsd_job_s cupsd_job_t;

struct cupsd_printer_s
{
  char		*uri,			/* Printer URI */
		*uuid,			/* Printer UUID */
		*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		*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 */
		*dest_types;		/* Destination types for queue */
  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 */
  cups_array_t	*users;			/* Allowed/denied users */
  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 */
  _ppd_cache_t	*pc;			/* PPD cache and mapping data */

#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
  char		*reg_name,		/* Name used for service registration */
		*pdl;			/* pdl value for TXT record */
  cupsd_srv_t	ipp_srv;		/* IPP service(s) */
#  ifdef HAVE_DNSSD
#    ifdef HAVE_SSL
  cupsd_srv_t	ipps_srv;		/* IPPS service(s) */
#    endif /* HAVE_SSL */
  cupsd_srv_t	printer_srv;		/* LPD service */
#  endif /* HAVE_DNSSD */
#endif /* HAVE_DNSSD || HAVE_AVAHI */
};


/*
 * 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 */
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		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		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,
			                    const 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 11380 2013-11-05 01:14:53Z msweet $".
 */
Commit	Line	Data
ef416fc2	1	/*
61515785	2	* "$Id: printers.h 11380 2013-11-05 01:14:53Z msweet $"
ef416fc2	3	*
c7233aab	4	* Printer definitions for the CUPS scheduler.
ef416fc2	5	*
c7233aab MS	6	* Copyright 2007-2013 by Apple Inc.
c7233aab MS	7	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2	8	*
c7233aab MS	9	* These coded instructions, statements, and computer programs are the
	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
f7deaa1a	17	# include <dns_sd.h>
f3c17241 MS	18	#elif defined(HAVE_AVAHI)
	19	# include <avahi-client/client.h>
	20	# include <avahi-client/publish.h>
	21	# include <avahi-common/error.h>
	22	# include <avahi-common/thread-watch.h>
f7deaa1a	23	#endif /* HAVE_DNSSD */
54afec33 MS	24	#include <cups/pwg-private.h>
54afec33 MS	25
f7deaa1a	26
ef416fc2	27	/*
	28	* Quota data...
	29	*/
	30
	31	typedef struct
	32	{
	33	char username[33]; /* User data */
	34	time_t next_update; /* Next update time */
	35	int page_count, /* Count of pages */
	36	k_count; /* Count of kilobytes */
	37	} cupsd_quota_t;
	38
	39
f3c17241 MS	40	/*
	41	* DNS-SD types to make the code cleaner/clearer...
	42	*/
	43
	44	#ifdef HAVE_DNSSD
	45	typedef DNSServiceRef cupsd_srv_t; /* Service reference */
	46	typedef TXTRecordRef cupsd_txt_t; /* TXT record */
	47
	48	#elif defined(HAVE_AVAHI)
	49	typedef AvahiEntryGroup cupsd_srv_t; / Service reference */
	50	typedef AvahiStringList cupsd_txt_t; / TXT record */
	51	#endif /* HAVE_DNSSD */
	52
	53
ef416fc2	54	/*
	55	* Printer/class information structure...
	56	*/
	57
f11a948a MS	58	typedef struct cupsd_job_s cupsd_job_t;
f11a948a MS	59
10d09e33	60	struct cupsd_printer_s
ef416fc2	61	{
ef416fc2	62	char uri, / Printer URI */
82f97232	63	uuid, / Printer UUID */
ef416fc2	64	hostname, / Host printer resides on */
	65	name, / Printer name */
	66	location, / Location code */
	67	make_model, / Make and model */
	68	info, / Description */
	69	op_policy, / Operation policy name */
	70	error_policy; / Error policy */
	71	cupsd_policy_t op_policy_ptr; / Pointer to operation policy */
	72	int shared; /* Shared? */
	73	int accepting; /* Accepting jobs? */
61cf44e2	74	int holding_new_jobs; /* Holding new jobs for printing? */
ef416fc2	75	int in_implicit_class; /* In an implicit class? */
	76	ipp_pstate_t state; /* Printer state */
	77	char state_message[1024]; /* Printer state message */
	78	int num_reasons; /* Number of printer-state-reasons */
d1c13e16	79	char reasons[64]; / printer-state-reasons strings */
ef416fc2	80	time_t state_time; /* Time at this state */
ef416fc2	81	char job_sheets[2]; / Banners/job sheets */
09a101d6	82	cups_ptype_t type; /* Printer type (color, small, etc.) */
ef416fc2	83	char device_uri; / Device URI */
0af14961	84	char sanitized_device_uri; / Sanitized device URI */
ef416fc2	85	char port_monitor; / Port monitor */
ef416fc2	86	int raw; /* Raw queue? */
d09495fa	87	int remote; /* Remote queue? */
f7deaa1a	88	mime_type_t filetype, / Pseudo-filetype for printer */
f7deaa1a	89	prefiltertype; / Pseudo-filetype for pre-filters */
f14324a7 MS	90	cups_array_t filetypes, / Supported file types */
f14324a7 MS	91	dest_types; / Destination types for queue */
f11a948a	92	cupsd_job_t job; / Current job in queue */
61cf44e2 MS	93	ipp_t attrs, / Attributes supported by this printer */
61cf44e2 MS	94	ppd_attrs; / Attributes based on the PPD */
ef416fc2	95	int num_printers, /* Number of printers in class */
	96	last_printer; /* Last printer job was sent to */
	97	struct cupsd_printer_s *printers; / Printers in class */
	98	int quota_period, /* Period for quotas */
	99	page_limit, /* Maximum number of pages */
fa73b229	100	k_limit; /* Maximum number of kilobytes */
fa73b229	101	cups_array_t quotas; / Quota records */
10d09e33 MS	102	int deny_users; /* 1 = deny, 0 = allow */
10d09e33 MS	103	cups_array_t users; / Allowed/denied users */
ef416fc2	104	int sequence_number; /* Increasing sequence number */
b423cd4c	105	int num_options; /* Number of default options */
b423cd4c	106	cups_option_t options; / Default options */
f7deaa1a	107	int num_auth_info_required; /* Number of required auth fields */
f7deaa1a	108	const char auth_info_required[4]; / Required authentication fields */
323c5de1	109	char alert, / PSX printer-alert value */
323c5de1	110	alert_description; / PSX printer-alert-description value */
5a738aea	111	time_t marker_time; /* Last time marker attributes were updated */
f14324a7	112	_ppd_cache_t pc; / PPD cache and mapping data */
f7deaa1a	113
f3c17241	114	#if defined(HAVE_DNSSD) \|\| defined(HAVE_AVAHI)
f7deaa1a	115	char reg_name, / Name used for service registration */
f3c17241 MS	116	pdl; / pdl value for TXT record */
	117	cupsd_srv_t ipp_srv; /* IPP service(s) */
	118	# ifdef HAVE_DNSSD
	119	# ifdef HAVE_SSL
	120	cupsd_srv_t ipps_srv; /* IPPS service(s) */
	121	# endif /* HAVE_SSL */
	122	cupsd_srv_t printer_srv; /* LPD service */
	123	# endif /* HAVE_DNSSD */
	124	#endif /* HAVE_DNSSD \|\| HAVE_AVAHI */
10d09e33	125	};
ef416fc2	126
	127
	128	/*
	129	* Globals...
	130	*/
	131
	132	VAR ipp_t *CommonData VALUE(NULL);
	133	/* Common printer object attrs */
f7deaa1a	134	VAR cups_array_t *CommonDefaults VALUE(NULL);
f7deaa1a	135	/* Common -default option names */
a2326b5b	136	VAR cups_array_t *Printers VALUE(NULL);
ef416fc2	137	/* Printer list */
ef416fc2	138	VAR cupsd_printer_t *DefaultPrinter VALUE(NULL);
	139	/* Default printer */
	140	VAR char *DefaultPolicy VALUE(NULL);
	141	/* Default policy name */
	142	VAR cupsd_policy_t *DefaultPolicyPtr
	143	VALUE(NULL);
	144	/* Pointer to default policy */
	145
	146
	147	/*
	148	* Prototypes...
	149	*/
	150
	151	extern cupsd_printer_t cupsdAddPrinter(const char name);
ef416fc2	152	extern void cupsdCreateCommonData(void);
ef416fc2	153	extern void cupsdDeleteAllPrinters(void);
f8b3a85b	154	extern int cupsdDeletePrinter(cupsd_printer_t *p, int update);
ef416fc2	155	extern cupsd_printer_t cupsdFindDest(const char name);
ef416fc2	156	extern cupsd_printer_t cupsdFindPrinter(const char name);
3d8365b8	157	extern cupsd_quota_t cupsdFindQuota(cupsd_printer_t p,
3d8365b8	158	const char *username);
ef416fc2	159	extern void cupsdFreeQuotas(cupsd_printer_t *p);
ef416fc2	160	extern void cupsdLoadAllPrinters(void);
f7deaa1a	161	extern void cupsdRenamePrinter(cupsd_printer_t *p,
f7deaa1a	162	const char *name);
ef416fc2	163	extern void cupsdSaveAllPrinters(void);
f7deaa1a	164	extern int cupsdSetAuthInfoRequired(cupsd_printer_t *p,
	165	const char *values,
	166	ipp_attribute_t *attr);
0af14961	167	extern void cupsdSetDeviceURI(cupsd_printer_t p, const char uri);
5a738aea	168	extern void cupsdSetPrinterAttr(cupsd_printer_t *p,
c7233aab MS	169	const char *name,
c7233aab MS	170	const char *value);
ef416fc2	171	extern void cupsdSetPrinterAttrs(cupsd_printer_t *p);
e07d4801	172	extern int cupsdSetPrinterReasons(cupsd_printer_t *p,
f7deaa1a	173	const char *s);
	174	extern void cupsdSetPrinterState(cupsd_printer_t *p, ipp_pstate_t s,
	175	int update);
a29fd7dd MS	176	#define cupsdStartPrinter(p,u) cupsdSetPrinterState((p), \
a29fd7dd MS	177	IPP_PRINTER_IDLE, (u))
ef416fc2	178	extern void cupsdStopPrinter(cupsd_printer_t *p, int update);
c9fc04c6 MS	179	extern int cupsdUpdatePrinterPPD(cupsd_printer_t *p,
	180	int num_keywords,
	181	cups_option_t *keywords);
ef416fc2	182	extern void cupsdUpdatePrinters(void);
f7deaa1a	183	extern cupsd_quota_t cupsdUpdateQuota(cupsd_printer_t p,
	184	const char *username, int pages,
	185	int k);
	186	extern const char cupsdValidateDest(const char uri,
ef416fc2	187	cups_ptype_t *dtype,
	188	cupsd_printer_t **printer);
	189	extern void cupsdWritePrintcap(void);
	190
ef416fc2	191
ef416fc2	192	/*
61515785	193	* End of "$Id: printers.h 11380 2013-11-05 01:14:53Z msweet $".
ef416fc2	194	*/