2
* "$Id: printers.h 10996 2013-05-29 11:51:34Z msweet $"
4
* Printer definitions for the CUPS scheduler.
6
* Copyright 2007-2012 by Apple Inc.
7
* Copyright 1997-2007 by Easy Software Products, all rights reserved.
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/".
18
#elif defined(HAVE_AVAHI)
19
# include <avahi-client/client.h>
20
# include <avahi-client/publish.h>
21
# include <avahi-common/error.h>
22
# include <avahi-common/thread-watch.h>
23
#endif /* HAVE_DNSSD */
24
#include <cups/pwg-private.h>
33
char username[33]; /* User data */
34
time_t next_update; /* Next update time */
35
int page_count, /* Count of pages */
36
k_count; /* Count of kilobytes */
41
* DNS-SD types to make the code cleaner/clearer...
45
typedef DNSServiceRef cupsd_srv_t; /* Service reference */
46
typedef TXTRecordRef cupsd_txt_t; /* TXT record */
48
#elif defined(HAVE_AVAHI)
49
typedef AvahiEntryGroup *cupsd_srv_t; /* Service reference */
50
typedef AvahiStringList *cupsd_txt_t; /* TXT record */
51
#endif /* HAVE_DNSSD */
55
* Printer/class information structure...
58
typedef struct cupsd_job_s cupsd_job_t;
60
struct cupsd_printer_s
62
char *uri, /* Printer URI */
63
*uuid, /* Printer UUID */
64
*hostname, /* Host printer resides on */
65
*name, /* Printer name */
66
*location, /* Location code */
67
*make_model, /* Make and model */
68
*info, /* Description */
69
*op_policy, /* Operation policy name */
70
*error_policy; /* Error policy */
71
cupsd_policy_t *op_policy_ptr; /* Pointer to operation policy */
72
int shared; /* Shared? */
73
int color_managed; /* Color Managed? */
74
int accepting; /* Accepting jobs? */
75
int holding_new_jobs; /* Holding new jobs for printing? */
76
int in_implicit_class; /* In an implicit class? */
77
ipp_pstate_t state; /* Printer state */
78
char state_message[1024]; /* Printer state message */
79
int num_reasons; /* Number of printer-state-reasons */
80
char *reasons[64]; /* printer-state-reasons strings */
81
time_t state_time; /* Time at this state */
82
char *job_sheets[2]; /* Banners/job sheets */
83
cups_ptype_t type; /* Printer type (color, small, etc.) */
84
char *device_uri; /* Device URI */
85
char *ppd_timestamp; /* Driver Modification Date */
86
char *sanitized_device_uri; /* Sanitized device URI */
87
char *port_monitor; /* Port monitor */
88
int raw; /* Raw queue? */
89
int remote; /* Remote queue? */
90
mime_type_t *filetype, /* Pseudo-filetype for printer */
91
*prefiltertype; /* Pseudo-filetype for pre-filters */
92
cups_array_t *filetypes, /* Supported file types */
93
*dest_types; /* Destination types for queue */
94
cupsd_job_t *job; /* Current job in queue */
95
ipp_t *attrs, /* Attributes supported by this printer */
96
*ppd_attrs; /* Attributes based on the PPD */
97
int num_printers, /* Number of printers in class */
98
last_printer; /* Last printer job was sent to */
99
struct cupsd_printer_s **printers; /* Printers in class */
100
int quota_period, /* Period for quotas */
101
page_limit, /* Maximum number of pages */
102
k_limit; /* Maximum number of kilobytes */
103
cups_array_t *quotas; /* Quota records */
104
int deny_users; /* 1 = deny, 0 = allow */
105
cups_array_t *users; /* Allowed/denied users */
106
int sequence_number; /* Increasing sequence number */
107
int num_options; /* Number of default options */
108
cups_option_t *options; /* Default options */
109
int num_auth_info_required; /* Number of required auth fields */
110
const char *auth_info_required[4]; /* Required authentication fields */
111
char *alert, /* PSX printer-alert value */
112
*alert_description; /* PSX printer-alert-description value */
113
time_t marker_time; /* Last time marker attributes were updated */
114
_ppd_cache_t *pc; /* PPD cache and mapping data */
116
#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
117
char *reg_name, /* Name used for service registration */
118
*pdl; /* pdl value for TXT record */
119
cupsd_srv_t ipp_srv; /* IPP service(s) */
122
cupsd_srv_t ipps_srv; /* IPPS service(s) */
123
# endif /* HAVE_SSL */
124
cupsd_srv_t printer_srv; /* LPD service */
125
# endif /* HAVE_DNSSD */
126
#endif /* HAVE_DNSSD || HAVE_AVAHI */
134
VAR ipp_t *CommonData VALUE(NULL);
135
/* Common printer object attrs */
136
VAR cups_array_t *CommonDefaults VALUE(NULL);
137
/* Common -default option names */
138
VAR cups_array_t *Printers VALUE(NULL);
140
VAR cupsd_printer_t *DefaultPrinter VALUE(NULL);
141
/* Default printer */
142
VAR char *DefaultPolicy VALUE(NULL);
143
/* Default policy name */
144
VAR cupsd_policy_t *DefaultPolicyPtr
146
/* Pointer to default policy */
153
extern cupsd_printer_t *cupsdAddPrinter(const char *name);
154
extern void cupsdCreateCommonData(void);
155
extern void cupsdDeleteAllPrinters(void);
156
extern int cupsdDeletePrinter(cupsd_printer_t *p, int update);
157
extern cupsd_printer_t *cupsdFindDest(const char *name);
158
extern cupsd_printer_t *cupsdFindPrinter(const char *name);
159
extern cupsd_quota_t *cupsdFindQuota(cupsd_printer_t *p,
160
const char *username);
161
extern void cupsdFreeQuotas(cupsd_printer_t *p);
162
extern void cupsdLoadAllPrinters(void);
163
extern void cupsdRenamePrinter(cupsd_printer_t *p,
165
extern void cupsdSaveAllPrinters(void);
166
extern int cupsdSetAuthInfoRequired(cupsd_printer_t *p,
168
ipp_attribute_t *attr);
169
extern void cupsdSetDeviceURI(cupsd_printer_t *p, const char *uri);
170
extern void cupsdSetPrinterAttr(cupsd_printer_t *p,
171
const char *name, char *value);
172
extern void cupsdSetPrinterAttrs(cupsd_printer_t *p);
173
extern int cupsdSetPrinterReasons(cupsd_printer_t *p,
175
extern void cupsdSetPrinterState(cupsd_printer_t *p, ipp_pstate_t s,
177
#define cupsdStartPrinter(p,u) cupsdSetPrinterState((p), \
178
IPP_PRINTER_IDLE, (u))
179
extern void cupsdStopPrinter(cupsd_printer_t *p, int update);
180
extern int cupsdUpdatePrinterPPD(cupsd_printer_t *p,
182
cups_option_t *keywords);
183
extern void cupsdUpdatePrinters(void);
184
extern cupsd_quota_t *cupsdUpdateQuota(cupsd_printer_t *p,
185
const char *username, int pages,
187
extern const char *cupsdValidateDest(const char *uri,
189
cupsd_printer_t **printer);
190
extern void cupsdWritePrintcap(void);
194
* End of "$Id: printers.h 10996 2013-05-29 11:51:34Z msweet $".