scheduler/printers.h

   1 /*
   2  * "$Id: printers.h 7564 2008-05-15 00:57:43Z mike $"
   3  *
   4  *   Printer 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 #ifdef HAVE_DNSSD
  17 #  include <dns_sd.h>
  18 #endif /* HAVE_DNSSD */
  19
  20 /*
  21  * Quota data...
  22  */
  23
  24 typedef struct
  25 {
  26   char          username[33];           /* User data */
  27   time_t        next_update;            /* Next update time */
  28   int           page_count,             /* Count of pages */
  29                 k_count;                /* Count of kilobytes */
  30 } cupsd_quota_t;
  31
  32
  33 /*
  34  * Printer/class information structure...
  35  */
  36
  37 typedef struct cupsd_job_s cupsd_job_t;
  38
  39 typedef struct cupsd_printer_s
  40 {
  41   char          *uri,                   /* Printer URI */
  42                 *hostname,              /* Host printer resides on */
  43                 *name,                  /* Printer name */
  44                 *location,              /* Location code */
  45                 *make_model,            /* Make and model */
  46                 *info,                  /* Description */
  47                 *op_policy,             /* Operation policy name */
  48                 *error_policy;          /* Error policy */
  49   cupsd_policy_t *op_policy_ptr;        /* Pointer to operation policy */
  50   int           shared;                 /* Shared? */
  51   int           accepting;              /* Accepting jobs? */
  52   int           holding_new_jobs;       /* Holding new jobs for printing? */
  53   int           in_implicit_class;      /* In an implicit class? */
  54   ipp_pstate_t  state;                  /* Printer state */
  55   char          state_message[1024];    /* Printer state message */
  56   int           num_reasons;            /* Number of printer-state-reasons */
  57   char          *reasons[64];           /* printer-state-reasons strings */
  58   time_t        state_time;             /* Time at this state */
  59   char          *job_sheets[2];         /* Banners/job sheets */
  60   cups_ptype_t  type;                   /* Printer type (color, small, etc.) */
  61   char          *browse_attrs;          /* Attributes sent with browse data */
  62   time_t        browse_expire;          /* Expiration time for printer */
  63   time_t        browse_time;            /* Last time update was sent/received */
  64   char          *device_uri;            /* Device URI */
  65   char          *sanitized_device_uri;  /* Sanitized device URI */
  66   char          *port_monitor;          /* Port monitor */
  67   int           raw;                    /* Raw queue? */
  68   int           remote;                 /* Remote queue? */
  69   mime_type_t   *filetype,              /* Pseudo-filetype for printer */
  70                 *prefiltertype;         /* Pseudo-filetype for pre-filters */
  71   cups_array_t  *filetypes;             /* Supported file types */
  72   cupsd_job_t   *job;                   /* Current job in queue */
  73   ipp_t         *attrs,                 /* Attributes supported by this printer */
  74                 *ppd_attrs;             /* Attributes based on the PPD */
  75   int           num_printers,           /* Number of printers in class */
  76                 last_printer;           /* Last printer job was sent to */
  77   struct cupsd_printer_s **printers;    /* Printers in class */
  78   int           quota_period,           /* Period for quotas */
  79                 page_limit,             /* Maximum number of pages */
  80                 k_limit;                /* Maximum number of kilobytes */
  81   cups_array_t  *quotas;                /* Quota records */
  82   int           deny_users,             /* 1 = deny, 0 = allow */
  83                 num_users;              /* Number of allowed/denied users */
  84   const char    **users;                /* Allowed/denied users */
  85   int           num_history;            /* Number of history collections */
  86   ipp_t         **history;              /* History data */
  87   int           sequence_number;        /* Increasing sequence number */
  88   int           num_options;            /* Number of default options */
  89   cups_option_t *options;               /* Default options */
  90   int           num_auth_info_required; /* Number of required auth fields */
  91   const char    *auth_info_required[4]; /* Required authentication fields */
  92   char          *alert,                 /* PSX printer-alert value */
  93                 *alert_description;     /* PSX printer-alert-description value */
  94   time_t        marker_time;            /* Last time marker attributes were updated */
  95   cups_array_t  *filters,               /* Filters for queue */
  96                 *pre_filters;           /* Pre-filters for queue */
  97
  98 #ifdef __APPLE__
  99   char          *recoverable;           /* com.apple.print.recoverable-message */
 100 #endif /* __APPLE__ */
 101
 102 #ifdef HAVE_DNSSD
 103   char          *reg_name,              /* Name used for service registration */
 104                 *product,               /* PPD Product string */
 105                 *pdl,                   /* pdl value for TXT record */
 106                 *ipp_txt,               /* IPP TXT record contents */
 107                 *printer_txt;           /* LPD TXT record contents */
 108   int           ipp_len,                /* IPP TXT record length */
 109                 printer_len;            /* LPD TXT record length */
 110   DNSServiceRef ipp_ref,                /* Reference for _ipp._tcp,_cups */
 111                 printer_ref;            /* Reference for _printer._tcp */
 112 #endif /* HAVE_DNSSD */
 113 } cupsd_printer_t;
 114
 115
 116 /*
 117  * Globals...
 118  */
 119
 120 VAR ipp_t               *CommonData     VALUE(NULL);
 121                                         /* Common printer object attrs */
 122 VAR cups_array_t        *CommonDefaults VALUE(NULL);
 123                                         /* Common -default option names */
 124 VAR cups_array_t        *Printers       VALUE(NULL),
 125                                         /* Printer list */
 126                         *ImplicitPrinters VALUE(NULL);
 127                                         /* Implicit class printers */
 128 VAR cupsd_printer_t     *DefaultPrinter VALUE(NULL);
 129                                         /* Default printer */
 130 VAR char                *DefaultPolicy  VALUE(NULL);
 131                                         /* Default policy name */
 132 VAR cupsd_policy_t      *DefaultPolicyPtr
 133                                         VALUE(NULL);
 134                                         /* Pointer to default policy */
 135
 136
 137 /*
 138  * Prototypes...
 139  */
 140
 141 extern cupsd_printer_t  *cupsdAddPrinter(const char *name);
 142 extern void             cupsdAddPrinterHistory(cupsd_printer_t *p);
 143 extern void             cupsdAddPrinterUser(cupsd_printer_t *p,
 144                                             const char *username);
 145 extern void             cupsdCreateCommonData(void);
 146 extern void             cupsdDeleteAllPrinters(void);
 147 extern void             cupsdDeletePrinter(cupsd_printer_t *p, int update);
 148 extern cupsd_printer_t  *cupsdFindDest(const char *name);
 149 extern cupsd_printer_t  *cupsdFindPrinter(const char *name);
 150 extern cupsd_quota_t    *cupsdFindQuota(cupsd_printer_t *p,
 151                                         const char *username);
 152 extern void             cupsdFreePrinterUsers(cupsd_printer_t *p);
 153 extern void             cupsdFreeQuotas(cupsd_printer_t *p);
 154 extern void             cupsdLoadAllPrinters(void);
 155 extern void             cupsdRenamePrinter(cupsd_printer_t *p,
 156                                            const char *name);
 157 extern void             cupsdSaveAllPrinters(void);
 158 extern int              cupsdSetAuthInfoRequired(cupsd_printer_t *p,
 159                                                  const char *values,
 160                                                  ipp_attribute_t *attr);
 161 extern void             cupsdSetDeviceURI(cupsd_printer_t *p, const char *uri);
 162 extern void             cupsdSetPrinterAttr(cupsd_printer_t *p,
 163                                             const char *name, char *value);
 164 extern void             cupsdSetPrinterAttrs(cupsd_printer_t *p);
 165 extern int              cupsdSetPrinterReasons(cupsd_printer_t *p,
 166                                                const char *s);
 167 extern void             cupsdSetPrinterState(cupsd_printer_t *p, ipp_pstate_t s,
 168                                              int update);
 169 #define                 cupsdStartPrinter(p,u) cupsdSetPrinterState((p), IPP_PRINTER_IDLE, (u))
 170 extern void             cupsdStopPrinter(cupsd_printer_t *p, int update);
 171 extern int              cupsdUpdatePrinterPPD(cupsd_printer_t *p,
 172                                               int num_keywords,
 173                                               cups_option_t *keywords);
 174 extern void             cupsdUpdatePrinters(void);
 175 extern cupsd_quota_t    *cupsdUpdateQuota(cupsd_printer_t *p,
 176                                           const char *username, int pages,
 177                                           int k);
 178 extern const char       *cupsdValidateDest(const char *uri,
 179                                            cups_ptype_t *dtype,
 180                                            cupsd_printer_t **printer);
 181 extern void             cupsdWritePrintcap(void);
 182
 183
 184 /*
 185  * End of "$Id: printers.h 7564 2008-05-15 00:57:43Z mike $".
 186  */