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

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