]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | /* |
61515785 | 2 | * "$Id: cupsd.h 10996 2013-05-29 11:51:34Z msweet $" |
ef416fc2 | 3 | * |
71e16022 | 4 | * Main header file for the CUPS scheduler. |
ef416fc2 | 5 | * |
cb7f98ee | 6 | * Copyright 2007-2013 by Apple Inc. |
f899b121 | 7 | * Copyright 1997-2007 by Easy Software Products, all rights reserved. |
ef416fc2 | 8 | * |
9 | * These coded instructions, statements, and computer programs are the | |
bc44d920 | 10 | * property of Apple Inc. and are protected by Federal copyright |
11 | * law. Distribution and use rights are outlined in the file "LICENSE.txt" | |
ef416fc2 | 12 | * "LICENSE" which should have been included with this file. If this |
bc44d920 | 13 | * file is missing or damaged, see the license at "http://www.cups.org/". |
ef416fc2 | 14 | */ |
15 | ||
16 | ||
17 | /* | |
18 | * Include necessary headers. | |
19 | */ | |
20 | ||
71e16022 | 21 | #include <cups/cups-private.h> |
22c9029b | 22 | #include <cups/file-private.h> |
71e16022 | 23 | |
ef416fc2 | 24 | #include <limits.h> |
ef416fc2 | 25 | #include <time.h> |
26 | #include <signal.h> | |
27 | #include <fcntl.h> | |
28 | #include <math.h> | |
29 | #include <sys/types.h> | |
30 | #include <sys/time.h> | |
31 | #include <sys/stat.h> | |
32 | #include <sys/wait.h> | |
33 | ||
34 | #ifdef WIN32 | |
35 | # include <direct.h> | |
36 | #else | |
37 | # include <unistd.h> | |
38 | #endif /* WIN32 */ | |
39 | ||
ef416fc2 | 40 | #include "mime.h" |
ef416fc2 | 41 | |
42 | #if defined(HAVE_CDSASSL) | |
43 | # include <CoreFoundation/CoreFoundation.h> | |
44 | #endif /* HAVE_CDSASSL */ | |
45 | ||
46 | ||
47 | /* | |
48 | * Some OS's don't have hstrerror(), most notably Solaris... | |
49 | */ | |
50 | ||
51 | #ifndef HAVE_HSTRERROR | |
b423cd4c | 52 | # ifdef hstrerror |
53 | # undef hstrerror | |
54 | # endif /* hstrerror */ | |
ef416fc2 | 55 | # define hstrerror cups_hstrerror |
56 | ||
57 | extern const char *cups_hstrerror(int); | |
58 | #endif /* !HAVE_HSTRERROR */ | |
59 | ||
60 | ||
61 | /* | |
62 | * Common constants. | |
63 | */ | |
64 | ||
65 | #ifndef FALSE | |
66 | # define FALSE 0 | |
67 | # define TRUE (!FALSE) | |
68 | #endif /* !FALSE */ | |
69 | ||
70 | ||
71 | /* | |
72 | * Implementation limits... | |
73 | */ | |
74 | ||
e00b005a | 75 | #define MAX_ENV 100 /* Maximum number of environment strings */ |
ef416fc2 | 76 | #define MAX_USERPASS 33 /* Maximum size of username/password */ |
77 | #define MAX_FILTERS 20 /* Maximum number of filters */ | |
78 | #define MAX_SYSTEM_GROUPS 32 /* Maximum number of system groups */ | |
79 | ||
80 | ||
81 | /* | |
82 | * Defaults... | |
83 | */ | |
84 | ||
82cc1f9a MS |
85 | #define DEFAULT_HISTORY INT_MAX /* Preserve job history? */ |
86 | #define DEFAULT_FILES 86400 /* Preserve job files? */ | |
ef416fc2 | 87 | #define DEFAULT_TIMEOUT 300 /* Timeout during requests/updates */ |
49d87452 | 88 | #define DEFAULT_KEEPALIVE 30 /* Timeout between requests */ |
ef416fc2 | 89 | |
90 | ||
91 | /* | |
92 | * Global variable macros... | |
93 | */ | |
94 | ||
95 | #ifdef _MAIN_C_ | |
96 | # define VAR | |
97 | # define VALUE(x) =x | |
98 | # define VALUE2(x,y) ={x,y} | |
99 | #else | |
100 | # define VAR extern | |
101 | # define VALUE(x) | |
102 | # define VALUE2(x,y) | |
103 | #endif /* _MAIN_C */ | |
104 | ||
105 | ||
106 | /* | |
107 | * Other stuff for the scheduler... | |
108 | */ | |
109 | ||
09ec0018 | 110 | #include "sysman.h" |
ef416fc2 | 111 | #include "statbuf.h" |
112 | #include "cert.h" | |
113 | #include "auth.h" | |
114 | #include "client.h" | |
115 | #include "policy.h" | |
116 | #include "printers.h" | |
117 | #include "classes.h" | |
118 | #include "job.h" | |
a29fd7dd | 119 | #include "colorman.h" |
ef416fc2 | 120 | #include "conf.h" |
121 | #include "banners.h" | |
122 | #include "dirsvc.h" | |
123 | #include "network.h" | |
124 | #include "subscriptions.h" | |
125 | ||
126 | ||
127 | /* | |
128 | * Reload types... | |
129 | */ | |
130 | ||
131 | #define RELOAD_NONE 0 /* No reload needed */ | |
132 | #define RELOAD_ALL 1 /* Reload everything */ | |
133 | #define RELOAD_CUPSD 2 /* Reload only cupsd.conf */ | |
134 | ||
135 | ||
f7deaa1a | 136 | /* |
137 | * Select callback function type... | |
138 | */ | |
139 | ||
140 | typedef void (*cupsd_selfunc_t)(void *data); | |
141 | ||
142 | ||
ef416fc2 | 143 | /* |
144 | * Globals... | |
145 | */ | |
146 | ||
1340db2d | 147 | VAR int TestConfigFile VALUE(0), |
2e4ff8af | 148 | /* Test the cupsd.conf file? */ |
1340db2d MS |
149 | UseProfiles VALUE(1); |
150 | /* Use security profiles for child procs? */ | |
ac884b6a MS |
151 | VAR int MaxFDs VALUE(0); |
152 | /* Maximum number of files */ | |
ef416fc2 | 153 | |
154 | VAR time_t ReloadTime VALUE(0); | |
155 | /* Time of reload request... */ | |
7cf5915e | 156 | VAR int NeedReload VALUE(RELOAD_ALL), |
ef416fc2 | 157 | /* Need to load configuration? */ |
7cf5915e MS |
158 | DoingShutdown VALUE(0); |
159 | /* Shutting down the scheduler? */ | |
a4924f6c MS |
160 | VAR void *DefaultProfile VALUE(0); |
161 | /* Default security profile */ | |
c24d2134 | 162 | |
4400e98d | 163 | #ifdef HAVE_LAUNCH_H |
164 | VAR int Launchd VALUE(0); | |
165 | /* Running from launchd */ | |
166 | #endif /* HAVE_LAUNCH_H */ | |
ef416fc2 | 167 | |
168 | ||
169 | /* | |
170 | * Prototypes... | |
171 | */ | |
172 | ||
321d8d57 MS |
173 | /* env.c */ |
174 | extern void cupsdInitEnv(void); | |
175 | extern int cupsdLoadEnv(char *envp[], int envmax); | |
176 | extern void cupsdSetEnv(const char *name, const char *value); | |
177 | extern void cupsdSetEnvf(const char *name, const char *value, ...) | |
85dda01c | 178 | __attribute__ ((__format__ (__printf__, 2, 3))); |
321d8d57 MS |
179 | extern void cupsdUpdateEnv(void); |
180 | ||
181 | /* file.c */ | |
182 | extern void cupsdCleanFiles(const char *path, const char *pattern); | |
183 | extern int cupsdCloseCreatedConfFile(cups_file_t *fp, | |
184 | const char *filename); | |
185 | extern void cupsdClosePipe(int *fds); | |
186 | extern cups_file_t *cupsdCreateConfFile(const char *filename, mode_t mode); | |
187 | extern cups_file_t *cupsdOpenConfFile(const char *filename); | |
188 | extern int cupsdOpenPipe(int *fds); | |
189 | extern int cupsdRemoveFile(const char *filename); | |
cb7f98ee | 190 | extern int cupsdUnlinkOrRemoveFile(const char *filename); |
321d8d57 MS |
191 | |
192 | /* main.c */ | |
193 | extern int cupsdAddString(cups_array_t **a, const char *s); | |
194 | extern void cupsdCheckProcess(void); | |
195 | extern void cupsdClearString(char **s); | |
196 | extern void cupsdFreeStrings(cups_array_t **a); | |
197 | extern void cupsdHoldSignals(void); | |
198 | extern char *cupsdMakeUUID(const char *name, int number, | |
199 | char *buffer, size_t bufsize); | |
200 | extern void cupsdReleaseSignals(void); | |
201 | extern void cupsdSetString(char **s, const char *v); | |
202 | extern void cupsdSetStringf(char **s, const char *f, ...) | |
85dda01c | 203 | __attribute__ ((__format__ (__printf__, 2, 3))); |
321d8d57 MS |
204 | |
205 | /* process.c */ | |
206 | extern void *cupsdCreateProfile(int job_id); | |
207 | extern void cupsdDestroyProfile(void *profile); | |
208 | extern int cupsdEndProcess(int pid, int force); | |
209 | extern const char *cupsdFinishProcess(int pid, char *name, int namelen, | |
210 | int *job_id); | |
211 | extern int cupsdStartProcess(const char *command, char *argv[], | |
212 | char *envp[], int infd, int outfd, | |
213 | int errfd, int backfd, int sidefd, | |
214 | int root, void *profile, | |
215 | cupsd_job_t *job, int *pid); | |
216 | ||
217 | /* select.c */ | |
218 | extern int cupsdAddSelect(int fd, cupsd_selfunc_t read_cb, | |
219 | cupsd_selfunc_t write_cb, void *data); | |
220 | extern int cupsdDoSelect(long timeout); | |
f899b121 | 221 | #ifdef CUPSD_IS_SELECTING |
321d8d57 | 222 | extern int cupsdIsSelecting(int fd); |
f899b121 | 223 | #endif /* CUPSD_IS_SELECTING */ |
321d8d57 MS |
224 | extern void cupsdRemoveSelect(int fd); |
225 | extern void cupsdStartSelect(void); | |
226 | extern void cupsdStopSelect(void); | |
ef416fc2 | 227 | |
321d8d57 MS |
228 | /* server.c */ |
229 | extern void cupsdStartServer(void); | |
230 | extern void cupsdStopServer(void); | |
ef416fc2 | 231 | |
58dc1933 | 232 | |
ef416fc2 | 233 | /* |
61515785 | 234 | * End of "$Id: cupsd.h 10996 2013-05-29 11:51:34Z msweet $". |
ef416fc2 | 235 | */ |