[print notify fixes from APP_HEAD]
[garming/samba-autobuild/.git] / source3 / include / printing.h
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 2 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, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 */
23
24 #include "includes.h"
25
26 /*
27    This file defines the low-level printing system interfaces used by the
28    SAMBA printing subsystem.
29 */
30
31 /* Information for print jobs */
32 struct printjob {
33         pid_t pid; /* which process launched the job */
34         int sysjob; /* the system (lp) job number */
35         int fd; /* file descriptor of open file if open */
36         time_t starttime; /* when the job started spooling */
37         int status; /* the status of this job */
38         size_t size; /* the size of the job so far */
39         int page_count; /* then number of pages so far */
40         BOOL spooled; /* has it been sent to the spooler yet? */
41         BOOL smbjob; /* set if the job is a SMB job */
42         fstring filename; /* the filename used to spool the file */
43         fstring jobname; /* the job name given to us by the client */
44         fstring user; /* the user who started the job */
45         fstring queuename; /* service number of printer for this job */
46         NT_DEVICEMODE *nt_devmode;
47 };
48
49 /* Information for print interfaces */
50 struct printif
51 {
52   int (*queue_get)(int snum, print_queue_struct **q,
53                    print_status_struct *status);
54   int (*queue_pause)(int snum);
55   int (*queue_resume)(int snum);
56   int (*job_delete)(int snum, struct printjob *pjob);
57   int (*job_pause)(int snum, struct printjob *pjob);
58   int (*job_resume)(int snum, struct printjob *pjob);
59   int (*job_submit)(int snum, struct printjob *pjob);
60 };
61
62 extern struct printif   generic_printif;
63
64 #ifdef HAVE_CUPS
65 extern struct printif   cups_printif;
66 #endif /* HAVE_CUPS */
67
68 /* PRINT_MAX_JOBID is now defined in local.h */
69 #define UNIX_JOB_START PRINT_MAX_JOBID
70 #define NEXT_JOBID(j) ((j+1) % PRINT_MAX_JOBID > 0 ? (j+1) % PRINT_MAX_JOBID : 1)
71
72 #define MAX_CACHE_VALID_TIME 3600
73
74 #define PRINT_SPOOL_PREFIX "smbprn."
75 #define PRINT_DATABASE_VERSION 5
76
77 /* There can be this many printing tdb's open, plus any locked ones. */
78 #define MAX_PRINT_DBS_OPEN 1
79
80 struct tdb_print_db {
81         struct tdb_print_db *next, *prev;
82         TDB_CONTEXT *tdb;
83         int ref_count;
84         fstring printer_name;
85 };
86
87 /* 
88  * Used for print notify
89  */
90
91 #define NOTIFY_PID_LIST_KEY "NOTIFY_PID_LIST"
92
93 #endif /* PRINTING_H_ */