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

/*
 * "$Id: subscriptions.h 5025 2006-01-30 03:49:12Z mike $"
 *
 *   Subscription definitions for the Common UNIX Printing System (CUPS) scheduler.
 *
 *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Easy Software Products 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 please contact Easy Software Products
 *   at:
 *
 *       Attn: CUPS Licensing Information
 *       Easy Software Products
 *       44141 Airport View Drive, Suite 204
 *       Hollywood, Maryland 20636 USA
 *
 *       Voice: (301) 373-9600
 *       EMail: cups-info@cups.org
 *         WWW: http://www.cups.org
 */

/*
 * Event mask enumeration...
 */

typedef enum
{
  /* Individual printer events... */
  CUPSD_EVENT_PRINTER_RESTARTED = 0x0001,
					/* Sent after printer restarted */
  CUPSD_EVENT_PRINTER_SHUTDOWN = 0x0002,/* Sent after printer shutdown */
  CUPSD_EVENT_PRINTER_STOPPED = 0x0004,	/* Sent after printer stopped */
  CUPSD_EVENT_PRINTER_FINISHINGS_CHANGED = 0x0008,
					/* Sent after finishings-supported changed */
  CUPSD_EVENT_PRINTER_MEDIA_CHANGED = 0x0010,
					/* Sent after media-supported changed */
  CUPSD_EVENT_PRINTER_ADDED = 0x0020,	/* Sent after printer added */
  CUPSD_EVENT_PRINTER_DELETED = 0x0040,	/* Sent after printer deleted */
  CUPSD_EVENT_PRINTER_MODIFIED = 0x0080,/* Sent after printer modified */

  /* Convenience printer event groupings... */
  CUPSD_EVENT_PRINTER_STATE_CHANGED = 0x0007,
					/* RESTARTED + SHUTDOWN + STOPPED */
  CUPSD_EVENT_PRINTER_CONFIG_CHANGED = 0x0018,
					/* FINISHINGS_CHANGED + MEDIA_CHANGED */
  CUPSD_EVENT_PRINTER_CHANGED = 0x00ff,	/* All of the above */

  /* Individual job events... */
  CUPSD_EVENT_JOB_STATE = 0x0100,	/* Any state change */
  CUPSD_EVENT_JOB_CREATED = 0x0200,	/* Send after job is created */
  CUPSD_EVENT_JOB_COMPLETED = 0x0400,	/* Sent after job is completed */
  CUPSD_EVENT_JOB_STOPPED = 0x0800,	/* Sent after job is stopped */
  CUPSD_EVENT_JOB_CONFIG_CHANGED = 0x1000,
					/* Sent after set-job-attributes */
  CUPSD_EVENT_JOB_PROGRESS = 0x2000,	/* Sent for each page */

  /* Convenience job event grouping... */
  CUPSD_EVENT_JOB_STATE_CHANGED = 0x0f00,
					/* Any state change + CREATED + COMPLETED + STOPPED */

  /* Server events... */
  CUPSD_EVENT_SERVER_RESTARTED = 0x4000,/* Sent after server restarts */
  CUPSD_EVENT_SERVER_STARTED = 0x8000,	/* Sent when server first starts */
  CUPSD_EVENT_SERVER_STOPPED = 0x10000,	/* Sent when server is stopped */
  CUPSD_EVENT_SERVER_AUDIT = 0x20000,	/* Security-related stuff */

  /* Everything and nothing... */
  CUPSD_EVENT_NONE = 0,			/* Nothing */
  CUPSD_EVENT_ALL = 0x1ffff		/* Everything */
} cupsd_eventmask_t;


/*
 * Notiification support structures...
 */

typedef struct cupsd_event_s		/**** Event structure ****/
{
  cupsd_eventmask_t	event;		/* Event */
  time_t		time;		/* Time of event */
  ipp_t			*attrs;		/* Notification message */
  cupsd_printer_t	*dest;		/* Associated printer, if any */
  cupsd_job_t		*job;		/* Associated job, if any */
} cupsd_event_t; 

typedef struct cupsd_subscription_s	/**** Subscription structure ****/
{
  int			id;		/* subscription-id */
  unsigned		mask;		/* Event mask */
  char			*owner;		/* notify-subscriber-user-name */
  char			*recipient;	/* notify-recipient-uri, if applicable */
  unsigned char		user_data[64];	/* notify-user-data */
  int			user_data_len;	/* Length of notify-user-data */
  int			lease;		/* notify-lease-duration */
  int			interval;	/* notify-time-interval */
  cupsd_printer_t	*dest;		/* notify-printer-uri, if any */
  cupsd_job_t		*job;		/* notify-job-id, if any */
  int			pid;		/* Process ID of notifier */
  int			pipe;		/* Pipe to notifier */
  int			status;		/* Exit status of notifier */
  time_t		last;		/* Time of last notification */
  time_t		expire;		/* Lease expiration time */
  int			first_event_id,	/* First event-id in cache */
			next_event_id,	/* Next event-id to use */
			num_events;	/* Number of cached events */
  cupsd_event_t		**events;	/* Cached events */
} cupsd_subscription_t;


/*
 * Globals...
 */

VAR int		MaxSubscriptions VALUE(100),
					/* Overall subscription limit */
		MaxSubscriptionsPerJob VALUE(0),
					/* Per-job subscription limit */
		MaxSubscriptionsPerPrinter VALUE(0),
					/* Per-printer subscription limit */
		MaxSubscriptionsPerUser VALUE(0),
					/* Per-user subscription limit */
		NextSubscriptionId VALUE(1),
					/* Next subscription ID */
		DefaultLeaseDuration VALUE(86400),
					/* Default notify-lease-duration */
		MaxLeaseDuration VALUE(0);
					/* Maximum notify-lease-duration */
VAR cups_array_t *Subscriptions VALUE(NULL);
					/* Active subscriptions */

VAR int		MaxEvents VALUE(100),	/* Maximum number of events */
		NumEvents VALUE(0);	/* Number of active events */
VAR cupsd_event_t **Events VALUE(NULL);	/* Active events */

VAR unsigned	LastEvent VALUE(0);	/* Last events processed */
VAR time_t	LastEventTime VALUE(0);	/* Time that the last events were sent */

VAR int		NotifierPipes[2] VALUE2(-1, -1);
					/* Pipes for notifier error/debug output */
VAR cupsd_statbuf_t *NotifierStatusBuffer VALUE(NULL);
					/* Status buffer for pipes */


/*
 * Prototypes...
 */

extern void	cupsdAddEvent(cupsd_eventmask_t event, cupsd_printer_t *dest,
		              cupsd_job_t *job, const char *text, ...);
extern cupsd_subscription_t *
		cupsdAddSubscription(unsigned mask, cupsd_printer_t *dest,
		                     cupsd_job_t *job, const char *uri,
				     int sub_id);
extern void	cupsdDeleteAllEvents(void);
extern void	cupsdDeleteAllSubscriptions(void);
extern void	cupsdDeleteSubscription(cupsd_subscription_t *sub, int update);
extern const char *
		cupsdEventName(cupsd_eventmask_t event);
extern cupsd_eventmask_t
		cupsdEventValue(const char *name);

extern cupsd_subscription_t *
		cupsdFindSubscription(int id);
extern void	cupsdExpireSubscriptions(cupsd_printer_t *dest,
		                         cupsd_job_t *job);
extern void	cupsdLoadAllSubscriptions(void);
extern void	cupsdSaveAllSubscriptions(void);
extern void	cupsdSendNotification(cupsd_subscription_t *sub,
		                      cupsd_event_t *event);
extern void	cupsdStopAllNotifiers(void);
extern void	cupsdUpdateNotifierStatus(void);


/*
 * End of "$Id: subscriptions.h 5025 2006-01-30 03:49:12Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
e00b005a	2	* "$Id: subscriptions.h 5025 2006-01-30 03:49:12Z mike $"
ef416fc2	3	*
	4	* Subscription definitions for the Common UNIX Printing System (CUPS) scheduler.
	5	*
fa73b229	6	* Copyright 1997-2006 by Easy Software Products, all rights reserved.
ef416fc2	7	*
	8	* These coded instructions, statements, and computer programs are the
	9	* property of Easy Software Products and are protected by Federal
	10	* copyright law. Distribution and use rights are outlined in the file
	11	* "LICENSE.txt" which should have been included with this file. If this
	12	* file is missing or damaged please contact Easy Software Products
	13	* at:
	14	*
	15	* Attn: CUPS Licensing Information
	16	* Easy Software Products
	17	* 44141 Airport View Drive, Suite 204
	18	* Hollywood, Maryland 20636 USA
	19	*
	20	* Voice: (301) 373-9600
	21	* EMail: cups-info@cups.org
	22	* WWW: http://www.cups.org
	23	*/
	24
	25	/*
	26	* Event mask enumeration...
	27	*/
	28
	29	typedef enum
	30	{
	31	/* Individual printer events... */
	32	CUPSD_EVENT_PRINTER_RESTARTED = 0x0001,
	33	/* Sent after printer restarted */
	34	CUPSD_EVENT_PRINTER_SHUTDOWN = 0x0002,/* Sent after printer shutdown */
	35	CUPSD_EVENT_PRINTER_STOPPED = 0x0004, /* Sent after printer stopped */
	36	CUPSD_EVENT_PRINTER_FINISHINGS_CHANGED = 0x0008,
	37	/* Sent after finishings-supported changed */
	38	CUPSD_EVENT_PRINTER_MEDIA_CHANGED = 0x0010,
	39	/* Sent after media-supported changed */
	40	CUPSD_EVENT_PRINTER_ADDED = 0x0020, /* Sent after printer added */
	41	CUPSD_EVENT_PRINTER_DELETED = 0x0040, /* Sent after printer deleted */
	42	CUPSD_EVENT_PRINTER_MODIFIED = 0x0080,/* Sent after printer modified */
	43
	44	/* Convenience printer event groupings... */
	45	CUPSD_EVENT_PRINTER_STATE_CHANGED = 0x0007,
	46	/* RESTARTED + SHUTDOWN + STOPPED */
	47	CUPSD_EVENT_PRINTER_CONFIG_CHANGED = 0x0018,
	48	/* FINISHINGS_CHANGED + MEDIA_CHANGED */
	49	CUPSD_EVENT_PRINTER_CHANGED = 0x00ff, /* All of the above */
	50
	51	/* Individual job events... */
e00b005a	52	CUPSD_EVENT_JOB_STATE = 0x0100, /* Any state change */
	53	CUPSD_EVENT_JOB_CREATED = 0x0200, /* Send after job is created */
	54	CUPSD_EVENT_JOB_COMPLETED = 0x0400, /* Sent after job is completed */
	55	CUPSD_EVENT_JOB_STOPPED = 0x0800, /* Sent after job is stopped */
	56	CUPSD_EVENT_JOB_CONFIG_CHANGED = 0x1000,
ef416fc2	57	/* Sent after set-job-attributes */
e00b005a	58	CUPSD_EVENT_JOB_PROGRESS = 0x2000, /* Sent for each page */
ef416fc2	59
ef416fc2	60	/* Convenience job event grouping... */
e00b005a	61	CUPSD_EVENT_JOB_STATE_CHANGED = 0x0f00,
e00b005a	62	/* Any state change + CREATED + COMPLETED + STOPPED */
ef416fc2	63
ef416fc2	64	/* Server events... */
e00b005a	65	CUPSD_EVENT_SERVER_RESTARTED = 0x4000,/* Sent after server restarts */
	66	CUPSD_EVENT_SERVER_STARTED = 0x8000, /* Sent when server first starts */
	67	CUPSD_EVENT_SERVER_STOPPED = 0x10000, /* Sent when server is stopped */
	68	CUPSD_EVENT_SERVER_AUDIT = 0x20000, /* Security-related stuff */
ef416fc2	69
	70	/* Everything and nothing... */
	71	CUPSD_EVENT_NONE = 0, /* Nothing */
	72	CUPSD_EVENT_ALL = 0x1ffff /* Everything */
	73	} cupsd_eventmask_t;
	74
	75
	76	/*
	77	* Notiification support structures...
	78	*/
	79
	80	typedef struct cupsd_event_s /** Event structure **/
	81	{
	82	cupsd_eventmask_t event; /* Event */
	83	time_t time; /* Time of event */
	84	ipp_t attrs; / Notification message */
	85	cupsd_printer_t dest; / Associated printer, if any */
	86	cupsd_job_t job; / Associated job, if any */
	87	} cupsd_event_t;
	88
	89	typedef struct cupsd_subscription_s /** Subscription structure **/
	90	{
	91	int id; /* subscription-id */
	92	unsigned mask; /* Event mask */
	93	char owner; / notify-subscriber-user-name */
	94	char recipient; / notify-recipient-uri, if applicable */
	95	unsigned char user_data[64]; /* notify-user-data */
	96	int user_data_len; /* Length of notify-user-data */
	97	int lease; /* notify-lease-duration */
	98	int interval; /* notify-time-interval */
	99	cupsd_printer_t dest; / notify-printer-uri, if any */
	100	cupsd_job_t job; / notify-job-id, if any */
	101	int pid; /* Process ID of notifier */
	102	int pipe; /* Pipe to notifier */
	103	int status; /* Exit status of notifier */
	104	time_t last; /* Time of last notification */
	105	time_t expire; /* Lease expiration time */
	106	int first_event_id, /* First event-id in cache */
	107	next_event_id, /* Next event-id to use */
	108	num_events; /* Number of cached events */
	109	cupsd_event_t *events; / Cached events */
	110	} cupsd_subscription_t;
	111
	112
	113	/*
	114	* Globals...
	115	*/
	116
	117	VAR int MaxSubscriptions VALUE(100),
	118	/* Overall subscription limit */
	119	MaxSubscriptionsPerJob VALUE(0),
	120	/* Per-job subscription limit */
	121	MaxSubscriptionsPerPrinter VALUE(0),
	122	/* Per-printer subscription limit */
	123	MaxSubscriptionsPerUser VALUE(0),
	124	/* Per-user subscription limit */
	125	NextSubscriptionId VALUE(1),
	126	/* Next subscription ID */
	127	DefaultLeaseDuration VALUE(86400),
	128	/* Default notify-lease-duration */
	129	MaxLeaseDuration VALUE(0);
	130	/* Maximum notify-lease-duration */
	131	VAR cups_array_t *Subscriptions VALUE(NULL);
	132	/* Active subscriptions */
133
134	VAR int MaxEvents VALUE(100), /* Maximum number of events */
135	NumEvents VALUE(0); /* Number of active events */
136	VAR cupsd_event_t *Events VALUE(NULL); / Active events */
137
fa73b229	138	VAR unsigned LastEvent VALUE(0); /* Last events processed */
	139	VAR time_t LastEventTime VALUE(0); /* Time that the last events were sent */
	140
ef416fc2	141	VAR int NotifierPipes[2] VALUE2(-1, -1);
	142	/* Pipes for notifier error/debug output */
	143	VAR cupsd_statbuf_t *NotifierStatusBuffer VALUE(NULL);
	144	/* Status buffer for pipes */
	145
	146
	147	/*
	148	* Prototypes...
	149	*/
	150
	151	extern void cupsdAddEvent(cupsd_eventmask_t event, cupsd_printer_t *dest,
	152	cupsd_job_t job, const char text, ...);
	153	extern cupsd_subscription_t *
	154	cupsdAddSubscription(unsigned mask, cupsd_printer_t *dest,
	155	cupsd_job_t job, const char uri,
	156	int sub_id);
	157	extern void cupsdDeleteAllEvents(void);
	158	extern void cupsdDeleteAllSubscriptions(void);
	159	extern void cupsdDeleteSubscription(cupsd_subscription_t *sub, int update);
	160	extern const char *
	161	cupsdEventName(cupsd_eventmask_t event);
	162	extern cupsd_eventmask_t
	163	cupsdEventValue(const char *name);
	164
	165	extern cupsd_subscription_t *
	166	cupsdFindSubscription(int id);
	167	extern void cupsdExpireSubscriptions(cupsd_printer_t *dest,
	168	cupsd_job_t *job);
	169	extern void cupsdLoadAllSubscriptions(void);
	170	extern void cupsdSaveAllSubscriptions(void);
	171	extern void cupsdSendNotification(cupsd_subscription_t *sub,
	172	cupsd_event_t *event);
	173	extern void cupsdStopAllNotifiers(void);
	174	extern void cupsdUpdateNotifierStatus(void);
	175
	176
	177	/*
e00b005a	178	* End of "$Id: subscriptions.h 5025 2006-01-30 03:49:12Z mike $".
ef416fc2	179	*/