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

/*
 * "$Id: job.h 7883 2008-08-28 20:38:13Z mike $"
 *
 *   Print job definitions for the Common UNIX Printing System (CUPS) scheduler.
 *
 *   Copyright 2007-2009 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/".
 */

/*
 * Constants...
 */

typedef enum cupsd_jobaction_e		/**** Actions for state changes ****/
{
  CUPSD_JOB_DEFAULT,			/* Use default action */
  CUPSD_JOB_FORCE,			/* Force the change */
  CUPSD_JOB_PURGE			/* Force the change and purge */
} cupsd_jobaction_t;


/*
 * Job request structure...
 */

struct cupsd_job_s			/**** Job request ****/
{
  int			id,		/* Job ID */
			priority,	/* Job priority */
			dirty;		/* Do we need to write the "c" file? */
  ipp_jstate_t		state_value;	/* Cached job-state */
  int			pending_timeout;/* Non-zero if the job was created and
					 * waiting on files */
  char			*username;	/* Printing user */
  char			*dest;		/* Destination printer or class */
  cups_ptype_t		dtype;		/* Destination type */
  int			num_files;	/* Number of files in job */
  mime_type_t		**filetypes;	/* File types */
  int			*compressions;	/* Compression status of each file */
  ipp_attribute_t	*sheets;	/* job-media-sheets-completed */
  time_t		access_time,	/* Last access time */
			kill_time,	/* When to send SIGKILL */
			hold_until;	/* Hold expiration date/time */
  ipp_attribute_t	*state;		/* Job state */
  ipp_attribute_t	*job_sheets;	/* Job sheets (NULL if none) */
  ipp_attribute_t	*printer_message,
					/* job-printer-state-message */
			*printer_reasons;
					/* job-printer-state-reasons */
  int			current_file;	/* Current file in job */
  ipp_t			*attrs;		/* Job attributes */
  int			print_pipes[2],	/* Print data pipes */
			back_pipes[2],	/* Backchannel pipes */
			side_pipes[2],	/* Sidechannel pipes */
			status_pipes[2];/* Status pipes */
  cupsd_statbuf_t	*status_buffer;	/* Status buffer for this job */
  int			status_level;	/* Highest log level in a status
					 * message */
  int			cost;		/* Filtering cost */
  int			pending_cost;	/* Waiting for FilterLimit */
  int			filters[MAX_FILTERS + 1];
					/* Filter process IDs, 0 terminated */
  int			backend;	/* Backend process ID */
  int			status;		/* Status code from filters */
  cupsd_printer_t	*printer;	/* Printer this job is assigned to */
  int			tries;		/* Number of tries for this job */
  char			*auth_username,	/* AUTH_USERNAME environment variable,
                                         * if any */
			*auth_domain,	/* AUTH_DOMAIN environment variable,
					 * if any */
			*auth_password;	/* AUTH_PASSWORD environment variable,
					 * if any */
  void			*profile;	/* Security profile */
  cups_array_t		*history;	/* Debug log history */
  int			progress;	/* Printing progress */
#ifdef HAVE_GSSAPI
  krb5_ccache		ccache;		/* Kerberos credential cache */
  char			*ccname;	/* KRB5CCNAME environment variable */
#endif /* HAVE_GSSAPI */
};

typedef struct cupsd_joblog_s		/**** Job log message ****/
{
  time_t		time;		/* Time of message */
  char			message[1];	/* Message string */
} cupsd_joblog_t;


/*
 * Globals...
 */

VAR int			JobHistory	VALUE(1);
					/* Preserve job history? */
VAR int			JobFiles	VALUE(0);
					/* Preserve job files? */
VAR int			MaxJobs		VALUE(0),
					/* Max number of jobs */
			MaxActiveJobs	VALUE(0),
					/* Max number of active jobs */
			MaxJobsPerUser	VALUE(0),
					/* Max jobs per user */
			MaxJobsPerPrinter VALUE(0);
					/* Max jobs per printer */
VAR int			JobAutoPurge	VALUE(0);
					/* Automatically purge jobs */
VAR cups_array_t	*Jobs		VALUE(NULL),
					/* List of current jobs */
			*ActiveJobs	VALUE(NULL),
					/* List of active jobs */
			*PrintingJobs	VALUE(NULL);
					/* List of jobs that are printing */
VAR int			NextJobId	VALUE(1);
					/* Next job ID to use */
VAR int			JobKillDelay	VALUE(DEFAULT_TIMEOUT),
					/* Delay before killing jobs */
			JobRetryLimit	VALUE(5),
					/* Max number of tries */
			JobRetryInterval VALUE(300);
					/* Seconds between retries */


/*
 * Prototypes...
 */

extern cupsd_job_t	*cupsdAddJob(int priority, const char *dest);
extern void		cupsdCancelJobs(const char *dest, const char *username,
			                int purge);
extern void		cupsdCheckJobs(void);
extern void		cupsdCleanJobs(void);
extern void		cupsdContinueJob(cupsd_job_t *job);
extern void		cupsdDeleteJob(cupsd_job_t *job,
			               cupsd_jobaction_t action);
extern cupsd_job_t	*cupsdFindJob(int id);
extern void		cupsdFreeAllJobs(void);
extern int		cupsdGetPrinterJobCount(const char *dest);
extern int		cupsdGetUserJobCount(const char *username);
extern void		cupsdLoadAllJobs(void);
extern int		cupsdLoadJob(cupsd_job_t *job);
extern void		cupsdMoveJob(cupsd_job_t *job, cupsd_printer_t *p);
extern void		cupsdReleaseJob(cupsd_job_t *job);
extern void		cupsdRestartJob(cupsd_job_t *job);
extern void		cupsdSaveAllJobs(void);
extern void		cupsdSaveJob(cupsd_job_t *job);
extern void		cupsdSetJobHoldUntil(cupsd_job_t *job,
			                     const char *when, int update);
extern void		cupsdSetJobPriority(cupsd_job_t *job, int priority);
extern void		cupsdSetJobState(cupsd_job_t *job,
			                 ipp_jstate_t newstate,
					 cupsd_jobaction_t action,
					 const char *message, ...)
#ifdef __GNUC__
__attribute__ ((__format__ (__printf__, 4, 5)))
#endif /* __GNUC__ */
;
extern void		cupsdStopAllJobs(cupsd_jobaction_t action,
			                 int kill_delay);
extern int		cupsdTimeoutJob(cupsd_job_t *job);
extern void		cupsdUnloadCompletedJobs(void);


/*
 * End of "$Id: job.h 7883 2008-08-28 20:38:13Z mike $".
 */
Commit	Line	Data
	1	/*
	2	* "$Id: job.h 7883 2008-08-28 20:38:13Z mike $"
	3	*
	4	* Print job definitions for the Common UNIX Printing System (CUPS) scheduler.
	5	*
	6	* Copyright 2007-2009 by Apple Inc.
	7	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
	8	*
	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/".
	14	*/
	15
	16	/*
	17	* Constants...
	18	*/
	19
	20	typedef enum cupsd_jobaction_e /** Actions for state changes **/
	21	{
	22	CUPSD_JOB_DEFAULT, /* Use default action */
	23	CUPSD_JOB_FORCE, /* Force the change */
	24	CUPSD_JOB_PURGE /* Force the change and purge */
	25	} cupsd_jobaction_t;
	26
	27
	28	/*
	29	* Job request structure...
	30	*/
	31
	32	struct cupsd_job_s /** Job request **/
	33	{
	34	int id, /* Job ID */
	35	priority, /* Job priority */
	36	dirty; /* Do we need to write the "c" file? */
	37	ipp_jstate_t state_value; /* Cached job-state */
	38	int pending_timeout;/* Non-zero if the job was created and
	39	* waiting on files */
	40	char username; / Printing user */
	41	char dest; / Destination printer or class */
	42	cups_ptype_t dtype; /* Destination type */
	43	int num_files; /* Number of files in job */
	44	mime_type_t *filetypes; / File types */
	45	int compressions; / Compression status of each file */
	46	ipp_attribute_t sheets; / job-media-sheets-completed */
	47	time_t access_time, /* Last access time */
	48	kill_time, /* When to send SIGKILL */
	49	hold_until; /* Hold expiration date/time */
	50	ipp_attribute_t state; / Job state */
	51	ipp_attribute_t job_sheets; / Job sheets (NULL if none) */
	52	ipp_attribute_t *printer_message,
	53	/* job-printer-state-message */
	54	*printer_reasons;
	55	/* job-printer-state-reasons */
	56	int current_file; /* Current file in job */
	57	ipp_t attrs; / Job attributes */
	58	int print_pipes[2], /* Print data pipes */
	59	back_pipes[2], /* Backchannel pipes */
	60	side_pipes[2], /* Sidechannel pipes */
	61	status_pipes[2];/* Status pipes */
	62	cupsd_statbuf_t status_buffer; / Status buffer for this job */
	63	int status_level; /* Highest log level in a status
	64	* message */
	65	int cost; /* Filtering cost */
	66	int pending_cost; /* Waiting for FilterLimit */
	67	int filters[MAX_FILTERS + 1];
	68	/* Filter process IDs, 0 terminated */
	69	int backend; /* Backend process ID */
	70	int status; /* Status code from filters */
	71	cupsd_printer_t printer; / Printer this job is assigned to */
	72	int tries; /* Number of tries for this job */
	73	char auth_username, / AUTH_USERNAME environment variable,
	74	* if any */
	75	auth_domain, / AUTH_DOMAIN environment variable,
	76	* if any */
	77	auth_password; / AUTH_PASSWORD environment variable,
	78	* if any */
	79	void profile; / Security profile */
	80	cups_array_t history; / Debug log history */
	81	int progress; /* Printing progress */
	82	#ifdef HAVE_GSSAPI
	83	krb5_ccache ccache; /* Kerberos credential cache */
	84	char ccname; / KRB5CCNAME environment variable */
	85	#endif /* HAVE_GSSAPI */
	86	};
	87
	88	typedef struct cupsd_joblog_s /** Job log message **/
	89	{
	90	time_t time; /* Time of message */
	91	char message[1]; /* Message string */
	92	} cupsd_joblog_t;
	93
	94
	95	/*
	96	* Globals...
	97	*/
	98
	99	VAR int JobHistory VALUE(1);
	100	/* Preserve job history? */
	101	VAR int JobFiles VALUE(0);
	102	/* Preserve job files? */
	103	VAR int MaxJobs VALUE(0),
	104	/* Max number of jobs */
	105	MaxActiveJobs VALUE(0),
	106	/* Max number of active jobs */
	107	MaxJobsPerUser VALUE(0),
	108	/* Max jobs per user */
	109	MaxJobsPerPrinter VALUE(0);
	110	/* Max jobs per printer */
	111	VAR int JobAutoPurge VALUE(0);
	112	/* Automatically purge jobs */
	113	VAR cups_array_t *Jobs VALUE(NULL),
	114	/* List of current jobs */
	115	*ActiveJobs VALUE(NULL),
	116	/* List of active jobs */
	117	*PrintingJobs VALUE(NULL);
	118	/* List of jobs that are printing */
	119	VAR int NextJobId VALUE(1);
	120	/* Next job ID to use */
	121	VAR int JobKillDelay VALUE(DEFAULT_TIMEOUT),
	122	/* Delay before killing jobs */
	123	JobRetryLimit VALUE(5),
	124	/* Max number of tries */
	125	JobRetryInterval VALUE(300);
	126	/* Seconds between retries */
	127
	128
	129	/*
	130	* Prototypes...
	131	*/
	132
	133	extern cupsd_job_t cupsdAddJob(int priority, const char dest);
	134	extern void cupsdCancelJobs(const char dest, const char username,
	135	int purge);
	136	extern void cupsdCheckJobs(void);
	137	extern void cupsdCleanJobs(void);
	138	extern void cupsdContinueJob(cupsd_job_t *job);
	139	extern void cupsdDeleteJob(cupsd_job_t *job,
	140	cupsd_jobaction_t action);
	141	extern cupsd_job_t *cupsdFindJob(int id);
	142	extern void cupsdFreeAllJobs(void);
	143	extern int cupsdGetPrinterJobCount(const char *dest);
	144	extern int cupsdGetUserJobCount(const char *username);
	145	extern void cupsdLoadAllJobs(void);
	146	extern int cupsdLoadJob(cupsd_job_t *job);
	147	extern void cupsdMoveJob(cupsd_job_t job, cupsd_printer_t p);
	148	extern void cupsdReleaseJob(cupsd_job_t *job);
	149	extern void cupsdRestartJob(cupsd_job_t *job);
	150	extern void cupsdSaveAllJobs(void);
	151	extern void cupsdSaveJob(cupsd_job_t *job);
	152	extern void cupsdSetJobHoldUntil(cupsd_job_t *job,
	153	const char *when, int update);
	154	extern void cupsdSetJobPriority(cupsd_job_t *job, int priority);
	155	extern void cupsdSetJobState(cupsd_job_t *job,
	156	ipp_jstate_t newstate,
	157	cupsd_jobaction_t action,
	158	const char *message, ...)
	159	#ifdef __GNUC__
	160	__attribute__ ((__format__ (__printf__, 4, 5)))
	161	#endif /* __GNUC__ */
	162	;
	163	extern void cupsdStopAllJobs(cupsd_jobaction_t action,
	164	int kill_delay);
	165	extern int cupsdTimeoutJob(cupsd_job_t *job);
	166	extern void cupsdUnloadCompletedJobs(void);
	167
	168
	169	/*
	170	* End of "$Id: job.h 7883 2008-08-28 20:38:13Z mike $".
	171	*/