scheduler/job.h

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