2 * "$Id: printers.h 6649 2007-07-11 21:46:42Z mike $"
4 * Printer definitions for the Common UNIX Printing System (CUPS) scheduler.
6 * Copyright 2007 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 #endif /* HAVE_DNSSD */
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 */
34 * Printer/class information structure...
37 typedef struct cupsd_printer_s
39 char *uri
, /* Printer URI */
40 *hostname
, /* Host printer resides on */
41 *name
, /* Printer name */
42 *location
, /* Location code */
43 *make_model
, /* Make and model */
44 *info
, /* Description */
45 *op_policy
, /* Operation policy name */
46 *error_policy
; /* Error policy */
47 cupsd_policy_t
*op_policy_ptr
; /* Pointer to operation policy */
48 int shared
; /* Shared? */
49 int accepting
; /* Accepting jobs? */
50 int in_implicit_class
; /* In an implicit class? */
51 ipp_pstate_t state
; /* Printer state */
52 char state_message
[1024]; /* Printer state message */
53 int num_reasons
; /* Number of printer-state-reasons */
54 char *reasons
[16]; /* printer-state-reasons strings */
55 time_t state_time
; /* Time at this state */
56 char *job_sheets
[2]; /* Banners/job sheets */
57 cups_ptype_t type
; /* Printer type (color, small, etc.) */
58 char *browse_attrs
; /* Attributes sent with browse data */
59 time_t browse_expire
; /* Expiration time for printer */
60 time_t browse_time
; /* Last time update was sent/received */
61 char *device_uri
; /* Device URI */
62 char *port_monitor
; /* Port monitor */
63 int raw
; /* Raw queue? */
64 int remote
; /* Remote queue? */
65 mime_type_t
*filetype
, /* Pseudo-filetype for printer */
66 *prefiltertype
; /* Pseudo-filetype for pre-filters */
67 cups_array_t
*filetypes
; /* Supported file types */
68 void *job
; /* Current job in queue */
69 ipp_t
*attrs
; /* Attributes supported by this printer */
70 int num_printers
, /* Number of printers in class */
71 last_printer
; /* Last printer job was sent to */
72 struct cupsd_printer_s
**printers
; /* Printers in class */
73 int quota_period
, /* Period for quotas */
74 page_limit
, /* Maximum number of pages */
75 k_limit
; /* Maximum number of kilobytes */
76 cups_array_t
*quotas
; /* Quota records */
77 int deny_users
, /* 1 = deny, 0 = allow */
78 num_users
; /* Number of allowed/denied users */
79 const char **users
; /* Allowed/denied users */
80 int num_history
; /* Number of history collections */
81 ipp_t
**history
; /* History data */
82 int sequence_number
; /* Increasing sequence number */
83 int num_options
; /* Number of default options */
84 cups_option_t
*options
; /* Default options */
85 int num_auth_info_required
; /* Number of required auth fields */
86 const char *auth_info_required
[4]; /* Required authentication fields */
87 char *alert
, /* PSX printer-alert value */
88 *alert_description
; /* PSX printer-alert-description value */
91 char *recoverable
; /* com.apple.print.recoverable-message */
92 #endif /* __APPLE__ */
95 char *reg_name
, /* Name used for service registration */
96 *product
, /* PPD Product string */
97 *pdl
, /* pdl value for TXT record */
98 *txt_record
; /* TXT record contents */
99 int txt_len
; /* TXT record length */
100 DNSServiceRef dnssd_ipp_ref
; /* DNSServiceRegister ref for _ipp */
101 int dnssd_ipp_fd
; /* File descriptor for DNSServiceRegister reference */
102 #endif /* HAVE_DNSSD */
110 VAR ipp_t
*CommonData
VALUE(NULL
);
111 /* Common printer object attrs */
112 VAR cups_array_t
*CommonDefaults
VALUE(NULL
);
113 /* Common -default option names */
114 VAR cups_array_t
*Printers
VALUE(NULL
),
116 *ImplicitPrinters
VALUE(NULL
);
117 /* Implicit class printers */
118 VAR cupsd_printer_t
*DefaultPrinter
VALUE(NULL
);
119 /* Default printer */
120 VAR
char *DefaultPolicy
VALUE(NULL
);
121 /* Default policy name */
122 VAR cupsd_policy_t
*DefaultPolicyPtr
124 /* Pointer to default policy */
131 extern cupsd_printer_t
*cupsdAddPrinter(const char *name
);
132 extern void cupsdAddPrinterHistory(cupsd_printer_t
*p
);
133 extern void cupsdAddPrinterUser(cupsd_printer_t
*p
,
134 const char *username
);
135 extern void cupsdCreateCommonData(void);
136 extern void cupsdDeleteAllPrinters(void);
137 extern void cupsdDeletePrinter(cupsd_printer_t
*p
, int update
);
138 extern cupsd_printer_t
*cupsdFindDest(const char *name
);
139 extern cupsd_printer_t
*cupsdFindPrinter(const char *name
);
140 extern cupsd_quota_t
*cupsdFindQuota(cupsd_printer_t
*p
,
141 const char *username
);
142 extern void cupsdFreePrinterUsers(cupsd_printer_t
*p
);
143 extern void cupsdFreeQuotas(cupsd_printer_t
*p
);
144 extern void cupsdLoadAllPrinters(void);
145 extern void cupsdRenamePrinter(cupsd_printer_t
*p
,
147 extern char *cupsdSanitizeURI(const char *uri
, char *buffer
,
149 extern void cupsdSaveAllPrinters(void);
150 extern int cupsdSetAuthInfoRequired(cupsd_printer_t
*p
,
152 ipp_attribute_t
*attr
);
153 extern void cupsdSetPrinterAttrs(cupsd_printer_t
*p
);
154 extern void cupsdSetPrinterReasons(cupsd_printer_t
*p
,
156 extern void cupsdSetPrinterState(cupsd_printer_t
*p
, ipp_pstate_t s
,
158 #define cupsdStartPrinter(p,u) cupsdSetPrinterState((p), IPP_PRINTER_IDLE, (u))
159 extern void cupsdStopPrinter(cupsd_printer_t
*p
, int update
);
160 extern void cupsdUpdatePrinters(void);
161 extern cupsd_quota_t
*cupsdUpdateQuota(cupsd_printer_t
*p
,
162 const char *username
, int pages
,
164 extern const char *cupsdValidateDest(const char *uri
,
166 cupsd_printer_t
**printer
);
167 extern void cupsdWritePrintcap(void);
171 * End of "$Id: printers.h 6649 2007-07-11 21:46:42Z mike $".