scheduler/printers.h

   1 /*
   2  * "$Id: printers.h 5178 2006-02-26 00:24:23Z mike $"
   3  *
   4  *   Printer definitions for the Common UNIX Printing System (CUPS) scheduler.
   5  *
   6  *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
   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  * 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  * Printer/class information structure...
  40  */
  41
  42 typedef struct cupsd_printer_s
  43 {
  44   char          *uri,                   /* Printer URI */
  45                 *hostname,              /* Host printer resides on */
  46                 *name,                  /* Printer name */
  47                 *location,              /* Location code */
  48                 *make_model,            /* Make and model */
  49                 *info,                  /* Description */
  50                 *op_policy,             /* Operation policy name */
  51                 *error_policy;          /* Error policy */
  52   cupsd_policy_t *op_policy_ptr;        /* Pointer to operation policy */
  53   int           shared;                 /* Shared? */
  54   int           accepting;              /* Accepting jobs? */
  55   int           in_implicit_class;      /* In an implicit class? */
  56   ipp_pstate_t  state;                  /* Printer state */
  57   char          state_message[1024];    /* Printer state message */
  58   int           num_reasons;            /* Number of printer-state-reasons */
  59   char          *reasons[16];           /* printer-state-reasons strings */
  60   time_t        state_time;             /* Time at this state */
  61   char          *job_sheets[2];         /* Banners/job sheets */
  62   cups_ptype_t  type;                   /* Printer type (color, small, etc.) */
  63   char          *browse_attrs;          /* Attributes sent with browse data */
  64   time_t        browse_expire;          /* Expiration time for printer */
  65   time_t        browse_time;            /* Last time update was sent/received */
  66   char          *device_uri;            /* Device URI */
  67   char          *port_monitor;          /* Port monitor */
  68   int           raw;                    /* Raw queue? */
  69   mime_type_t   *filetype;              /* Pseudo-filetype for printer */
  70   void          *job;                   /* Current job in queue */
  71   ipp_t         *attrs;                 /* Attributes supported by this printer */
  72   int           num_printers,           /* Number of printers in class */
  73                 last_printer;           /* Last printer job was sent to */
  74   struct cupsd_printer_s **printers;    /* Printers in class */
  75   int           quota_period,           /* Period for quotas */
  76                 page_limit,             /* Maximum number of pages */
  77                 k_limit;                /* Maximum number of kilobytes */
  78   cups_array_t  *quotas;                /* Quota records */
  79   int           deny_users,             /* 1 = deny, 0 = allow */
  80                 num_users;              /* Number of allowed/denied users */
  81   const char    **users;                /* Allowed/denied users */
  82   int           num_history;            /* Number of history collections */
  83   ipp_t         **history;              /* History data */
  84   int           sequence_number;        /* Increasing sequence number */
  85   int           num_options;            /* Number of default options */
  86   cups_option_t *options;               /* Default options */
  87 #ifdef __APPLE__
  88   char          *recoverable;           /* com.apple.print.recoverable-message */
  89 #endif /* __APPLE__ */
  90 } cupsd_printer_t;
  91
  92
  93 /*
  94  * Globals...
  95  */
  96
  97 VAR ipp_t               *CommonData     VALUE(NULL);
  98                                         /* Common printer object attrs */
  99 VAR cups_array_t        *Printers       VALUE(NULL),
 100                                         /* Printer list */
 101                         *ImplicitPrinters VALUE(NULL);
 102                                         /* Implicit class printers */
 103 VAR cupsd_printer_t     *DefaultPrinter VALUE(NULL);
 104                                         /* Default printer */
 105 VAR char                *DefaultPolicy  VALUE(NULL);
 106                                         /* Default policy name */
 107 VAR cupsd_policy_t      *DefaultPolicyPtr
 108                                         VALUE(NULL);
 109                                         /* Pointer to default policy */
 110
 111
 112 /*
 113  * Prototypes...
 114  */
 115
 116 extern cupsd_printer_t  *cupsdAddPrinter(const char *name);
 117 extern void             cupsdAddPrinterHistory(cupsd_printer_t *p);
 118 extern void             cupsdAddPrinterUser(cupsd_printer_t *p, const char *username);
 119 extern cupsd_quota_t    *cupsdAddQuota(cupsd_printer_t *p, const char *username);
 120 extern void             cupsdCreateCommonData(void);
 121 extern void             cupsdDeleteAllPrinters(void);
 122 extern void             cupsdDeletePrinter(cupsd_printer_t *p, int update);
 123 extern void             cupsdDeletePrinterFilters(cupsd_printer_t *p);
 124 extern cupsd_printer_t  *cupsdFindDest(const char *name);
 125 extern cupsd_printer_t  *cupsdFindPrinter(const char *name);
 126 extern cupsd_quota_t    *cupsdFindQuota(cupsd_printer_t *p, const char *username);
 127 extern void             cupsdFreePrinterUsers(cupsd_printer_t *p);
 128 extern void             cupsdFreeQuotas(cupsd_printer_t *p);
 129 extern void             cupsdLoadAllPrinters(void);
 130 extern void             cupsdRenamePrinter(cupsd_printer_t *p, const char *name);
 131 extern void             cupsdSaveAllPrinters(void);
 132 extern void             cupsdSetPrinterAttrs(cupsd_printer_t *p);
 133 extern void             cupsdSetPrinterReasons(cupsd_printer_t *p, const char *s);
 134 extern void             cupsdSetPrinterState(cupsd_printer_t *p, ipp_pstate_t s, int update);
 135 #define                 cupsdStartPrinter(p,u) cupsdSetPrinterState((p), IPP_PRINTER_IDLE, (u))
 136 extern void             cupsdStopPrinter(cupsd_printer_t *p, int update);
 137 extern void             cupsdUpdatePrinters(void);
 138 extern cupsd_quota_t    *cupsdUpdateQuota(cupsd_printer_t *p, const char *username,
 139                                           int pages, int k);
 140 extern const char       *cupsdValidateDest(const char *hostname,
 141                                            const char *resource,
 142                                            cups_ptype_t *dtype,
 143                                            cupsd_printer_t **printer);
 144 extern void             cupsdWritePrintcap(void);
 145
 146 extern char             *cupsdSanitizeURI(const char *uri, char *buffer,
 147                                           int buflen);
 148
 149
 150 /*
 151  * End of "$Id: printers.h 5178 2006-02-26 00:24:23Z mike $".
 152  */