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

/*
 * "$Id: job.h 6755 2007-08-01 19:02:47Z mike $"
 *
 *   Print job 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/".
 */

/*
 * Job request structure...
 */

typedef struct cupsd_job_s
{
  int			id,		/* Job ID */
			priority;	/* Job priority */
  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 (class/remote bits) */
  int			num_files;	/* Number of files in job */
  mime_type_t		**filetypes;	/* File types */
  int			*compressions;	/* Compression status of each file */
  time_t		access_time;	/* Last access time */
  ipp_attribute_t	*sheets;	/* job-media-sheets-completed */
  time_t		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			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 */
#ifdef HAVE_GSSAPI
  krb5_ccache		ccache;		/* Kerberos credential cache */
  char			*ccname;	/* KRB5CCNAME environment variable */
#endif /* HAVE_GSSAPI */
} cupsd_job_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 */
VAR int			NextJobId	VALUE(1);
					/* Next job ID to use */
VAR int			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		cupsdCancelJob(cupsd_job_t *job, int purge,
			               ipp_jstate_t newstate);
extern void		cupsdCancelJobs(const char *dest, const char *username,
			                int purge);
extern void		cupsdCheckJobs(void);
extern void		cupsdCleanJobs(void);
extern void		cupsdDeleteJob(cupsd_job_t *job);
extern cupsd_job_t	*cupsdFindJob(int id);
extern void		cupsdFinishJob(cupsd_job_t *job);
extern void		cupsdFreeAllJobs(void);
extern int		cupsdGetPrinterJobCount(const char *dest);
extern int		cupsdGetUserJobCount(const char *username);
extern void		cupsdHoldJob(cupsd_job_t *job);
extern void		cupsdLoadAllJobs(void);
extern void		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);
extern void		cupsdSetJobPriority(cupsd_job_t *job, int priority);
extern void		cupsdStopAllJobs(int force);
extern void		cupsdStopJob(cupsd_job_t *job, int force);
extern int		cupsdTimeoutJob(cupsd_job_t *job);
extern void		cupsdUnloadCompletedJobs(void);


/*
 * End of "$Id: job.h 6755 2007-08-01 19:02:47Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
c24d2134	2	* "$Id: job.h 6755 2007-08-01 19:02:47Z mike $"
ef416fc2	3	*
	4	* Print job definitions for the Common UNIX Printing System (CUPS) scheduler.
	5	*
91c84a35	6	* Copyright 2007-2008 by Apple Inc.
09a101d6	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	*/
	15
	16	/*
	17	* Job request structure...
	18	*/
	19
	20	typedef struct cupsd_job_s
	21	{
	22	int id, /* Job ID */
	23	priority; /* Job priority */
bd7854cb	24	ipp_jstate_t state_value; /* Cached job-state */
09a101d6	25	int pending_timeout;/* Non-zero if the job was created and waiting on files */
ef416fc2	26	char username; / Printing user */
	27	char dest; / Destination printer or class */
	28	cups_ptype_t dtype; /* Destination type (class/remote bits) */
ef416fc2	29	int num_files; /* Number of files in job */
ef416fc2	30	mime_type_t *filetypes; / File types */
ef416fc2	31	int compressions; / Compression status of each file */
bd7854cb	32	time_t access_time; /* Last access time */
	33	ipp_attribute_t sheets; / job-media-sheets-completed */
	34	time_t hold_until; /* Hold expiration date/time */
	35	ipp_attribute_t state; / Job state */
	36	ipp_attribute_t job_sheets; / Job sheets (NULL if none) */
bc44d920	37	ipp_attribute_t *printer_message,
	38	/* job-printer-state-message */
	39	*printer_reasons;
	40	/* job-printer-state-reasons */
bd7854cb	41	int current_file; /* Current file in job */
ef416fc2	42	ipp_t attrs; / Job attributes */
ef416fc2	43	int print_pipes[2], /* Print data pipes */
89d46774	44	back_pipes[2], /* Backchannel pipes */
f7deaa1a	45	side_pipes[2], /* Sidechannel pipes */
89d46774	46	status_pipes[2];/* Status pipes */
89d46774	47	cupsd_statbuf_t status_buffer; / Status buffer for this job */
09a101d6	48	int status_level; /* Highest log level in a status message */
ef416fc2	49	int cost; /* Filtering cost */
	50	int filters[MAX_FILTERS + 1];
	51	/* Filter process IDs, 0 terminated */
	52	int backend; /* Backend process ID */
	53	int status; /* Status code from filters */
	54	cupsd_printer_t printer; / Printer this job is assigned to */
	55	int tries; /* Number of tries for this job */
09a101d6	56	char auth_username, / AUTH_USERNAME environment variable, if any */
	57	auth_domain, / AUTH_DOMAIN environment variable, if any */
	58	auth_password; / AUTH_PASSWORD environment variable, if any */
a4924f6c	59	void profile; / Security profile */
f7deaa1a	60	#ifdef HAVE_GSSAPI
c24d2134	61	krb5_ccache ccache; /* Kerberos credential cache */
f7deaa1a	62	char ccname; / KRB5CCNAME environment variable */
f7deaa1a	63	#endif /* HAVE_GSSAPI */
ef416fc2	64	} cupsd_job_t;
	65
	66
	67	/*
	68	* Globals...
	69	*/
	70
	71	VAR int JobHistory VALUE(1);
	72	/* Preserve job history? */
	73	VAR int JobFiles VALUE(0);
	74	/* Preserve job files? */
	75	VAR int MaxJobs VALUE(0),
	76	/* Max number of jobs */
	77	MaxActiveJobs VALUE(0),
	78	/* Max number of active jobs */
	79	MaxJobsPerUser VALUE(0),
	80	/* Max jobs per user */
	81	MaxJobsPerPrinter VALUE(0);
	82	/* Max jobs per printer */
	83	VAR int JobAutoPurge VALUE(0);
	84	/* Automatically purge jobs */
	85	VAR cups_array_t *Jobs VALUE(NULL),
	86	/* List of current jobs */
	87	*ActiveJobs VALUE(NULL);
	88	/* List of active jobs */
	89	VAR int NextJobId VALUE(1);
	90	/* Next job ID to use */
	91	VAR int JobRetryLimit VALUE(5),
	92	/* Max number of tries */
	93	JobRetryInterval VALUE(300);
	94	/* Seconds between retries */
	95
	96
	97	/*
	98	* Prototypes...
	99	*/
	100
	101	extern cupsd_job_t cupsdAddJob(int priority, const char dest);
07725fee	102	extern void cupsdCancelJob(cupsd_job_t *job, int purge,
07725fee	103	ipp_jstate_t newstate);
ef416fc2	104	extern void cupsdCancelJobs(const char dest, const char username,
	105	int purge);
	106	extern void cupsdCheckJobs(void);
	107	extern void cupsdCleanJobs(void);
	108	extern void cupsdDeleteJob(cupsd_job_t *job);
	109	extern cupsd_job_t *cupsdFindJob(int id);
	110	extern void cupsdFinishJob(cupsd_job_t *job);
	111	extern void cupsdFreeAllJobs(void);
	112	extern int cupsdGetPrinterJobCount(const char *dest);
	113	extern int cupsdGetUserJobCount(const char *username);
	114	extern void cupsdHoldJob(cupsd_job_t *job);
	115	extern void cupsdLoadAllJobs(void);
bd7854cb	116	extern void cupsdLoadJob(cupsd_job_t *job);
e53920b9	117	extern void cupsdMoveJob(cupsd_job_t job, cupsd_printer_t p);
ef416fc2	118	extern void cupsdReleaseJob(cupsd_job_t *job);
ef416fc2	119	extern void cupsdRestartJob(cupsd_job_t *job);
bd7854cb	120	extern void cupsdSaveAllJobs(void);
ef416fc2	121	extern void cupsdSaveJob(cupsd_job_t *job);
	122	extern void cupsdSetJobHoldUntil(cupsd_job_t job, const char when);
	123	extern void cupsdSetJobPriority(cupsd_job_t *job, int priority);
d09495fa	124	extern void cupsdStopAllJobs(int force);
ef416fc2	125	extern void cupsdStopJob(cupsd_job_t *job, int force);
91c84a35	126	extern int cupsdTimeoutJob(cupsd_job_t *job);
bc44d920	127	extern void cupsdUnloadCompletedJobs(void);
ef416fc2	128
	129
	130	/*
c24d2134	131	* End of "$Id: job.h 6755 2007-08-01 19:02:47Z mike $".
ef416fc2	132	*/