s3:smbd: change blocking.c to use fsp_fnum_dbg() for fsp->fnum logging.
[Samba/gebeck_regimport.git] / source3 / include / printing.h
blobcfdf3a4a8ca5211306c3f06733726f0ba191e1d3
1 #ifndef PRINTING_H_
2 #define PRINTING_H_
4 /*
5 Unix SMB/CIFS implementation.
6 printing definitions
7 Copyright (C) Andrew Tridgell 1992-2000
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.
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.
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/>.
24 This file defines the low-level printing system interfaces used by the
25 SAMBA printing subsystem.
27 #include "tdb_compat.h"
29 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
31 enum {
32 LPQ_QUEUED = 0,
33 LPQ_PAUSED,
34 LPQ_SPOOLING,
35 LPQ_PRINTING,
36 LPQ_ERROR,
37 LPQ_DELETING,
38 LPQ_OFFLINE,
39 LPQ_PAPEROUT,
40 LPQ_PRINTED,
41 LPQ_DELETED,
42 LPQ_BLOCKED,
43 LPQ_USER_INTERVENTION,
45 /* smbd is dooing the file spooling before passing control to spoolss */
46 PJOB_SMBD_SPOOLING
49 typedef struct _print_queue_struct {
50 int job; /* normally the UNIX jobid -- see note in
51 printing.c:traverse_fn_delete() */
52 int size;
53 int page_count;
54 int status;
55 int priority;
56 time_t time;
57 fstring fs_user;
58 fstring fs_file;
59 } print_queue_struct;
61 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
63 typedef struct {
64 fstring message;
65 int qcount;
66 int status;
67 } print_status_struct;
69 /* Information for print jobs */
70 struct printjob {
71 pid_t pid; /* which process launched the job */
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;
88 /* Information for print interfaces */
89 struct printif
91 /* value of the 'printing' option for this service */
92 enum printing_types type;
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);
104 int (*job_submit)(int snum, struct printjob *pjob);
107 extern struct printif generic_printif;
109 #ifdef HAVE_CUPS
110 extern struct printif cups_printif;
111 #endif /* HAVE_CUPS */
113 #ifdef HAVE_IPRINT
114 extern struct printif iprint_printif;
115 #endif /* HAVE_IPRINT */
117 /* PRINT_MAX_JOBID is now defined in local.h */
118 #define UNIX_JOB_START PRINT_MAX_JOBID
119 #define NEXT_JOBID(j) ((j+1) % PRINT_MAX_JOBID > 0 ? (j+1) % PRINT_MAX_JOBID : 1)
121 #define MAX_CACHE_VALID_TIME 3600
122 #define CUPS_DEFAULT_CONNECTION_TIMEOUT 30
124 #ifndef PRINT_SPOOL_PREFIX
125 #define PRINT_SPOOL_PREFIX "smbprn."
126 #endif
127 #define PRINT_DATABASE_VERSION 7
129 #ifdef AIX
130 #define DEFAULT_PRINTING PRINT_AIX
131 #define PRINTCAP_NAME "/etc/qconfig"
132 #endif
134 #ifdef HPUX
135 #define DEFAULT_PRINTING PRINT_HPUX
136 #endif
138 #ifdef QNX
139 #define DEFAULT_PRINTING PRINT_QNX
140 #endif
142 #ifndef DEFAULT_PRINTING
143 #ifdef HAVE_CUPS
144 #define DEFAULT_PRINTING PRINT_CUPS
145 #define PRINTCAP_NAME "cups"
146 #elif defined(SYSV)
147 #define DEFAULT_PRINTING PRINT_SYSV
148 #define PRINTCAP_NAME "lpstat"
149 #else
150 #define DEFAULT_PRINTING PRINT_BSD
151 #define PRINTCAP_NAME "/etc/printcap"
152 #endif
153 #endif
155 #ifndef PRINTCAP_NAME
156 #define PRINTCAP_NAME "/etc/printcap"
157 #endif
159 /* There can be this many printing tdb's open, plus any locked ones. */
160 #define MAX_PRINT_DBS_OPEN 1
162 struct tdb_print_db {
163 struct tdb_print_db *next, *prev;
164 struct tdb_context *tdb;
165 int ref_count;
166 fstring printer_name;
170 * Used for print notify
173 #define NOTIFY_PID_LIST_KEY "NOTIFY_PID_LIST"
175 /* The following definitions come from printing/printspoolss.c */
177 NTSTATUS print_spool_open(files_struct *fsp,
178 const char *fname,
179 uint64_t current_vuid);
181 int print_spool_write(files_struct *fsp, const char *data, uint32_t size,
182 off_t offset, uint32_t *written);
184 void print_spool_end(files_struct *fsp, enum file_close_type close_type);
186 void print_spool_terminate(struct connection_struct *conn,
187 struct print_file_data *print_file);
188 uint16_t print_spool_rap_jobid(struct print_file_data *print_file);
190 /* The following definitions come from printing/printing.c */
192 uint32 sysjob_to_jobid(int unix_jobid);
193 bool print_notify_register_pid(int snum);
194 bool print_notify_deregister_pid(int snum);
195 bool print_job_exists(const char* sharename, uint32 jobid);
196 char *print_job_fname(const char* sharename, uint32 jobid);
197 struct spoolss_DeviceMode *print_job_devmode(const char* sharename, uint32 jobid);
198 bool print_job_set_name(struct tevent_context *ev,
199 struct messaging_context *msg_ctx,
200 const char *sharename, uint32 jobid, const char *name);
201 bool print_job_get_name(TALLOC_CTX *mem_ctx, const char *sharename, uint32_t jobid, char **name);
202 WERROR print_job_delete(const struct auth_session_info *server_info,
203 struct messaging_context *msg_ctx,
204 int snum, uint32_t jobid);
205 bool print_job_pause(const struct auth_session_info *server_info,
206 struct messaging_context *msg_ctx,
207 int snum, uint32 jobid, WERROR *errcode);
208 bool print_job_resume(const struct auth_session_info *server_info,
209 struct messaging_context *msg_ctx,
210 int snum, uint32 jobid, WERROR *errcode);
211 ssize_t print_job_write(struct tevent_context *ev,
212 struct messaging_context *msg_ctx,
213 int snum, uint32 jobid, const char *buf, size_t size);
214 int print_queue_length(struct messaging_context *msg_ctx, int snum,
215 print_status_struct *pstatus);
216 WERROR print_job_start(const struct auth_session_info *server_info,
217 struct messaging_context *msg_ctx,
218 const char *clientmachine,
219 int snum, const char *docname, const char *filename,
220 struct spoolss_DeviceMode *devmode, uint32_t *_jobid);
221 void print_job_endpage(struct messaging_context *msg_ctx,
222 int snum, uint32 jobid);
223 NTSTATUS print_job_end(struct messaging_context *msg_ctx, int snum,
224 uint32 jobid, enum file_close_type close_type);
225 int print_queue_status(struct messaging_context *msg_ctx, int snum,
226 print_queue_struct **ppqueue,
227 print_status_struct *status);
228 WERROR print_queue_pause(const struct auth_session_info *server_info,
229 struct messaging_context *msg_ctx, int snum);
230 WERROR print_queue_resume(const struct auth_session_info *server_info,
231 struct messaging_context *msg_ctx, int snum);
232 WERROR print_queue_purge(const struct auth_session_info *server_info,
233 struct messaging_context *msg_ctx, int snum);
234 uint16 pjobid_to_rap(const char* sharename, uint32 jobid);
235 bool rap_to_pjobid(uint16 rap_jobid, fstring sharename, uint32 *pjobid);
236 void rap_jobid_delete(const char* sharename, uint32 jobid);
237 bool print_backend_init(struct messaging_context *msg_ctx);
238 void printing_end(void);
240 /* The following definitions come from printing/lpq_parse.c */
242 bool parse_lpq_entry(enum printing_types printing_type,char *line,
243 print_queue_struct *buf,
244 print_status_struct *status,bool first);
245 uint32_t print_parse_jobid(const char *fname);
247 /* The following definitions come from printing/printing_db.c */
249 struct tdb_print_db *get_print_db_byname(const char *printername);
250 void release_print_db( struct tdb_print_db *pdb);
251 void close_all_print_db(void);
252 TDB_DATA get_printer_notify_pid_list(struct tdb_context *tdb, const char *printer_name, bool cleanlist);
254 void print_queue_receive(struct messaging_context *msg,
255 void *private_data,
256 uint32_t msg_type,
257 struct server_id server_id,
258 DATA_BLOB *data);
259 #endif /* PRINTING_H_ */