source: trunk/server/source3/include/printing.h

Last change on this file was 751, checked in by Silvan Scherrer, 13 years ago

Samba Server: updated trunk to 3.6.9
File size: 8.8 KB
RevLine 
[745]1#ifndef PRINTING_H_
2#define PRINTING_H_
3
4/*
5 Unix SMB/CIFS implementation.
6 printing definitions
7 Copyright (C) Andrew Tridgell 1992-2000
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
21*/
22
23/*
24 This file defines the low-level printing system interfaces used by the
25 SAMBA printing subsystem.
26*/
27
28/* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
29
30enum {
31 LPQ_QUEUED = 0,
32 LPQ_PAUSED,
33 LPQ_SPOOLING,
34 LPQ_PRINTING,
35 LPQ_ERROR,
36 LPQ_DELETING,
37 LPQ_OFFLINE,
38 LPQ_PAPEROUT,
39 LPQ_PRINTED,
40 LPQ_DELETED,
41 LPQ_BLOCKED,
42 LPQ_USER_INTERVENTION,
43
44 /* smbd is dooing the file spooling before passing control to spoolss */
45 PJOB_SMBD_SPOOLING
46};
47
48typedef struct _print_queue_struct {
[751]49 int sysjob; /* normally the UNIX jobid -- see note in
[745]50 printing.c:traverse_fn_delete() */
51 int size;
52 int page_count;
53 int status;
54 int priority;
55 time_t time;
56 fstring fs_user;
57 fstring fs_file;
58} print_queue_struct;
59
60enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
61
62typedef struct {
63 fstring message;
64 int qcount;
65 int status;
66} print_status_struct;
67
68/* Information for print jobs */
69struct printjob {
70 pid_t pid; /* which process launched the job */
[751]71 uint32_t jobid; /* the spoolss print job identifier */
[745]72 int sysjob; /* the system (lp) job number */
73 int fd; /* file descriptor of open file if open */
74 time_t starttime; /* when the job started spooling */
75 int status; /* the status of this job */
76 size_t size; /* the size of the job so far */
77 int page_count; /* then number of pages so far */
78 bool spooled; /* has it been sent to the spooler yet? */
79 bool smbjob; /* set if the job is a SMB job */
80 fstring filename; /* the filename used to spool the file */
81 fstring jobname; /* the job name given to us by the client */
82 fstring user; /* the user who started the job */
83 fstring clientmachine; /* The client machine which started this job */
84 fstring queuename; /* service number of printer for this job */
85 struct spoolss_DeviceMode *devmode;
86};
87
88/* Information for print interfaces */
89struct printif
90{
91 /* value of the 'printing' option for this service */
92 enum printing_types type;
93
94 int (*queue_get)(const char *printer_name,
95 enum printing_types printing_type,
96 char *lpq_command,
97 print_queue_struct **q,
98 print_status_struct *status);
99 int (*queue_pause)(int snum);
100 int (*queue_resume)(int snum);
101 int (*job_delete)(const char *sharename, const char *lprm_command, struct printjob *pjob);
102 int (*job_pause)(int snum, struct printjob *pjob);
103 int (*job_resume)(int snum, struct printjob *pjob);
[751]104 int (*job_submit)(int snum, struct printjob *pjob,
105 enum printing_types printing_type,
106 char *lpq_command);
[745]107};
108
109extern struct printif generic_printif;
110
111#ifdef HAVE_CUPS
112extern struct printif cups_printif;
113#endif /* HAVE_CUPS */
114
115#ifdef HAVE_IPRINT
116extern struct printif iprint_printif;
117#endif /* HAVE_IPRINT */
118
119/* PRINT_MAX_JOBID is now defined in local.h */
120#define UNIX_JOB_START PRINT_MAX_JOBID
121#define NEXT_JOBID(j) ((j+1) % PRINT_MAX_JOBID > 0 ? (j+1) % PRINT_MAX_JOBID : 1)
122
123#define MAX_CACHE_VALID_TIME 3600
124#define CUPS_DEFAULT_CONNECTION_TIMEOUT 30
125
126#ifndef PRINT_SPOOL_PREFIX
127#define PRINT_SPOOL_PREFIX "smbprn."
128#endif
[751]129#define PRINT_DATABASE_VERSION 8
[745]130
131#ifdef AIX
132#define DEFAULT_PRINTING PRINT_AIX
133#define PRINTCAP_NAME "/etc/qconfig"
134#endif
135
136#ifdef HPUX
137#define DEFAULT_PRINTING PRINT_HPUX
138#endif
139
140#ifdef QNX
141#define DEFAULT_PRINTING PRINT_QNX
142#endif
143
144#ifndef DEFAULT_PRINTING
145#ifdef HAVE_CUPS
146#define DEFAULT_PRINTING PRINT_CUPS
147#define PRINTCAP_NAME "cups"
148#elif defined(SYSV)
149#define DEFAULT_PRINTING PRINT_SYSV
150#define PRINTCAP_NAME "lpstat"
151#else
152#define DEFAULT_PRINTING PRINT_BSD
153#define PRINTCAP_NAME "/etc/printcap"
154#endif
155#endif
156
157#ifndef PRINTCAP_NAME
158#define PRINTCAP_NAME "/etc/printcap"
159#endif
160
161/* There can be this many printing tdb's open, plus any locked ones. */
162#define MAX_PRINT_DBS_OPEN 1
163
164struct TDB_DATA;
165struct tdb_context;
166
167struct tdb_print_db {
168 struct tdb_print_db *next, *prev;
169 struct tdb_context *tdb;
170 int ref_count;
171 fstring printer_name;
172};
173
174/*
175 * Used for print notify
176 */
177
178#define NOTIFY_PID_LIST_KEY "NOTIFY_PID_LIST"
179
180/* The following definitions come from printing/printspoolss.c */
181
182NTSTATUS print_spool_open(files_struct *fsp,
183 const char *fname,
184 uint16_t current_vuid);
185
186int print_spool_write(files_struct *fsp, const char *data, uint32_t size,
187 SMB_OFF_T offset, uint32_t *written);
188
189void print_spool_end(files_struct *fsp, enum file_close_type close_type);
190
191void print_spool_terminate(struct connection_struct *conn,
192 struct print_file_data *print_file);
193
194/* The following definitions come from printing/printing.c */
195
196uint32 sysjob_to_jobid(int unix_jobid);
197bool print_notify_register_pid(int snum);
198bool print_notify_deregister_pid(int snum);
199bool print_job_exists(const char* sharename, uint32 jobid);
[751]200struct spoolss_DeviceMode *print_job_devmode(TALLOC_CTX *mem_ctx,
201 const char *sharename,
202 uint32 jobid);
[745]203bool print_job_set_name(struct tevent_context *ev,
204 struct messaging_context *msg_ctx,
205 const char *sharename, uint32 jobid, const char *name);
206bool print_job_get_name(TALLOC_CTX *mem_ctx, const char *sharename, uint32_t jobid, char **name);
207WERROR print_job_delete(const struct auth_serversupplied_info *server_info,
208 struct messaging_context *msg_ctx,
209 int snum, uint32_t jobid);
[751]210WERROR print_job_pause(const struct auth_serversupplied_info *server_info,
[745]211 struct messaging_context *msg_ctx,
[751]212 int snum, uint32 jobid);
213WERROR print_job_resume(const struct auth_serversupplied_info *server_info,
[745]214 struct messaging_context *msg_ctx,
[751]215 int snum, uint32 jobid);
[745]216ssize_t print_job_write(struct tevent_context *ev,
217 struct messaging_context *msg_ctx,
218 int snum, uint32 jobid, const char *buf, size_t size);
219int print_queue_length(struct messaging_context *msg_ctx, int snum,
220 print_status_struct *pstatus);
221WERROR print_job_start(const struct auth_serversupplied_info *server_info,
222 struct messaging_context *msg_ctx,
223 const char *clientmachine,
224 int snum, const char *docname, const char *filename,
225 struct spoolss_DeviceMode *devmode, uint32_t *_jobid);
226void print_job_endpage(struct messaging_context *msg_ctx,
227 int snum, uint32 jobid);
228NTSTATUS print_job_end(struct messaging_context *msg_ctx, int snum,
229 uint32 jobid, enum file_close_type close_type);
230int print_queue_status(struct messaging_context *msg_ctx, int snum,
231 print_queue_struct **ppqueue,
232 print_status_struct *status);
233WERROR print_queue_pause(const struct auth_serversupplied_info *server_info,
234 struct messaging_context *msg_ctx, int snum);
235WERROR print_queue_resume(const struct auth_serversupplied_info *server_info,
236 struct messaging_context *msg_ctx, int snum);
237WERROR print_queue_purge(const struct auth_serversupplied_info *server_info,
238 struct messaging_context *msg_ctx, int snum);
239uint16 pjobid_to_rap(const char* sharename, uint32 jobid);
240bool rap_to_pjobid(uint16 rap_jobid, fstring sharename, uint32 *pjobid);
241void rap_jobid_delete(const char* sharename, uint32 jobid);
242bool print_backend_init(struct messaging_context *msg_ctx);
243void start_background_queue(struct tevent_context *ev,
244 struct messaging_context *msg);
245void printing_end(void);
246
247/* The following definitions come from printing/lpq_parse.c */
248
249bool parse_lpq_entry(enum printing_types printing_type,char *line,
250 print_queue_struct *buf,
251 print_status_struct *status,bool first);
252
253/* The following definitions come from printing/printing_db.c */
254
255struct tdb_print_db *get_print_db_byname(const char *printername);
256void release_print_db( struct tdb_print_db *pdb);
257void close_all_print_db(void);
258struct TDB_DATA get_printer_notify_pid_list(struct tdb_context *tdb, const char *printer_name, bool cleanlist);
259
260void print_queue_receive(struct messaging_context *msg,
261 void *private_data,
262 uint32_t msg_type,
263 struct server_id server_id,
264 DATA_BLOB *data);
265#endif /* PRINTING_H_ */
Note: See TracBrowser for help on using the repository browser.