scheduler/printers.h

   1 /*
   2  * "$Id: printers.h 7564 2008-05-15 00:57:43Z mike $"
   3  *
   4  *   Printer definitions for the CUPS scheduler.
   5  *
   6  *   Copyright 2007-2011 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 #include <cups/pwg-private.h>
  20
  21
  22 /*
  23  * Quota data...
  24  */
  25
  26 typedef struct
  27 {
  28   char          username[33];           /* User data */
  29   time_t        next_update;            /* Next update time */
  30   int           page_count,             /* Count of pages */
  31                 k_count;                /* Count of kilobytes */
  32 } cupsd_quota_t;
  33
  34
  35 /*
  36  * Printer/class information structure...
  37  */
  38
  39 typedef struct cupsd_job_s cupsd_job_t;
  40
  41 struct cupsd_printer_s
  42 {
  43   char          *uri,                   /* Printer URI */
  44                 *hostname,              /* Host printer resides on */
  45                 *name,                  /* Printer name */
  46                 *location,              /* Location code */
  47                 *make_model,            /* Make and model */
  48                 *info,                  /* Description */
  49                 *op_policy,             /* Operation policy name */
  50                 *error_policy;          /* Error policy */
  51   cupsd_policy_t *op_policy_ptr;        /* Pointer to operation policy */
  52   int           shared;                 /* Shared? */
  53   int           accepting;              /* Accepting jobs? */
  54   int           holding_new_jobs;       /* Holding new jobs for printing? */
  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[64];           /* 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          *sanitized_device_uri;  /* Sanitized device URI */
  68   char          *port_monitor;          /* Port monitor */
  69   int           raw;                    /* Raw queue? */
  70   int           remote;                 /* Remote queue? */
  71   mime_type_t   *filetype,              /* Pseudo-filetype for printer */
  72                 *prefiltertype;         /* Pseudo-filetype for pre-filters */
  73   cups_array_t  *filetypes,             /* Supported file types */
  74                 *dest_types;            /* Destination types for queue */
  75   cupsd_job_t   *job;                   /* Current job in queue */
  76   ipp_t         *attrs,                 /* Attributes supported by this printer */
  77                 *ppd_attrs;             /* Attributes based on the PPD */
  78   int           num_printers,           /* Number of printers in class */
  79                 last_printer;           /* Last printer job was sent to */
  80   struct cupsd_printer_s **printers;    /* Printers in class */
  81   int           quota_period,           /* Period for quotas */
  82                 page_limit,             /* Maximum number of pages */
  83                 k_limit;                /* Maximum number of kilobytes */
  84   cups_array_t  *quotas;                /* Quota records */
  85   int           deny_users;             /* 1 = deny, 0 = allow */
  86   cups_array_t  *users;                 /* Allowed/denied users */
  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   _ppd_cache_t  *pc;                    /* PPD cache and mapping data */
  96
  97 #ifdef HAVE_DNSSD
  98   char          *reg_name,              /* Name used for service registration */
  99                 *pdl,                   /* pdl value for TXT record */
 100                 *ipp_txt,               /* IPP TXT record contents */
 101                 *printer_txt;           /* LPD TXT record contents */
 102   int           ipp_len,                /* IPP TXT record length */
 103                 printer_len;            /* LPD TXT record length */
 104   DNSServiceRef ipp_ref,                /* Reference for _ipp._tcp,_cups */
 105                 printer_ref;            /* Reference for _printer._tcp */
 106 #endif /* HAVE_DNSSD */
 107 };
 108
 109
 110 /*
 111  * Globals...
 112  */
 113
 114 VAR ipp_t               *CommonData     VALUE(NULL);
 115                                         /* Common printer object attrs */
 116 VAR cups_array_t        *CommonDefaults VALUE(NULL);
 117                                         /* Common -default option names */
 118 VAR cups_array_t        *Printers       VALUE(NULL),
 119                                         /* Printer list */
 120                         *ImplicitPrinters VALUE(NULL);
 121                                         /* Implicit class printers */
 122 VAR cupsd_printer_t     *DefaultPrinter VALUE(NULL);
 123                                         /* Default printer */
 124 VAR char                *DefaultPolicy  VALUE(NULL);
 125                                         /* Default policy name */
 126 VAR cupsd_policy_t      *DefaultPolicyPtr
 127                                         VALUE(NULL);
 128                                         /* Pointer to default policy */
 129
 130
 131 /*
 132  * Prototypes...
 133  */
 134
 135 extern cupsd_printer_t  *cupsdAddPrinter(const char *name);
 136 extern void             cupsdCreateCommonData(void);
 137 extern void             cupsdDeleteAllPrinters(void);
 138 extern int              cupsdDeletePrinter(cupsd_printer_t *p, int update);
 139 extern cupsd_printer_t  *cupsdFindDest(const char *name);
 140 extern cupsd_printer_t  *cupsdFindPrinter(const char *name);
 141 extern cupsd_quota_t    *cupsdFindQuota(cupsd_printer_t *p,
 142                                         const char *username);
 143 extern void             cupsdFreeQuotas(cupsd_printer_t *p);
 144 extern void             cupsdLoadAllPrinters(void);
 145 extern void             cupsdRenamePrinter(cupsd_printer_t *p,
 146                                            const char *name);
 147 extern void             cupsdSaveAllPrinters(void);
 148 extern int              cupsdSetAuthInfoRequired(cupsd_printer_t *p,
 149                                                  const char *values,
 150                                                  ipp_attribute_t *attr);
 151 extern void             cupsdSetDeviceURI(cupsd_printer_t *p, const char *uri);
 152 extern void             cupsdSetPrinterAttr(cupsd_printer_t *p,
 153                                             const char *name, char *value);
 154 extern void             cupsdSetPrinterAttrs(cupsd_printer_t *p);
 155 extern int              cupsdSetPrinterReasons(cupsd_printer_t *p,
 156                                                const char *s);
 157 extern void             cupsdSetPrinterState(cupsd_printer_t *p, ipp_pstate_t s,
 158                                              int update);
 159 #define                 cupsdStartPrinter(p,u) cupsdSetPrinterState((p), IPP_PRINTER_IDLE, (u))
 160 extern void             cupsdStopPrinter(cupsd_printer_t *p, int update);
 161 extern int              cupsdUpdatePrinterPPD(cupsd_printer_t *p,
 162                                               int num_keywords,
 163                                               cups_option_t *keywords);
 164 extern void             cupsdUpdatePrinters(void);
 165 extern cupsd_quota_t    *cupsdUpdateQuota(cupsd_printer_t *p,
 166                                           const char *username, int pages,
 167                                           int k);
 168 extern const char       *cupsdValidateDest(const char *uri,
 169                                            cups_ptype_t *dtype,
 170                                            cupsd_printer_t **printer);
 171 extern void             cupsdWritePrintcap(void);
 172
 173
 174 /*
 175  * End of "$Id: printers.h 7564 2008-05-15 00:57:43Z mike $".
 176  */