scheduler/cupsd.h

   1 /*
   2  * "$Id: cupsd.h 6875 2007-08-27 23:25:06Z mike $"
   3  *
   4  *   Main header file for the Common UNIX Printing System (CUPS) scheduler.
   5  *
   6  *   Copyright 2007 by Apple Inc.
   7  *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
   8  *
   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  *   "LICENSE" which should have been included with this file.  If this
  13  *   file is missing or damaged, see the license at "http://www.cups.org/".
  14  */
  15
  16
  17 /*
  18  * Include necessary headers.
  19  */
  20
  21 #include <cups/http-private.h>
  22 #include <cups/string.h>
  23 #include <stdlib.h>
  24 #include <limits.h>
  25 #include <errno.h>
  26 #include <time.h>
  27 #include <signal.h>
  28 #include <fcntl.h>
  29 #include <math.h>
  30 #include <sys/types.h>
  31 #include <sys/time.h>
  32 #include <sys/stat.h>
  33 #include <sys/wait.h>
  34
  35 #ifdef WIN32
  36 #  include <direct.h>
  37 #else
  38 #  include <unistd.h>
  39 #endif /* WIN32 */
  40
  41 #include <cups/array.h>
  42 #include <cups/cups.h>
  43 #include "mime.h"
  44 #include <cups/http.h>
  45 #include <cups/ipp.h>
  46 #include <cups/i18n.h>
  47 #include <cups/debug.h>
  48
  49 #if defined(HAVE_CDSASSL)
  50 #  include <CoreFoundation/CoreFoundation.h>
  51 #endif /* HAVE_CDSASSL */
  52
  53
  54 /*
  55  * Some OS's don't have hstrerror(), most notably Solaris...
  56  */
  57
  58 #ifndef HAVE_HSTRERROR
  59 #  ifdef hstrerror
  60 #    undef hstrerror
  61 #  endif /* hstrerror */
  62 #  define hstrerror cups_hstrerror
  63
  64 extern const char *cups_hstrerror(int);
  65 #endif /* !HAVE_HSTRERROR */
  66
  67
  68 /*
  69  * Common constants.
  70  */
  71
  72 #ifndef FALSE
  73 #  define FALSE         0
  74 #  define TRUE          (!FALSE)
  75 #endif /* !FALSE */
  76
  77
  78 /*
  79  * Implementation limits...
  80  */
  81
  82 #define MAX_ENV                 100     /* Maximum number of environment strings */
  83 #define MAX_USERPASS            33      /* Maximum size of username/password */
  84 #define MAX_FILTERS             20      /* Maximum number of filters */
  85 #define MAX_SYSTEM_GROUPS       32      /* Maximum number of system groups */
  86
  87
  88 /*
  89  * Defaults...
  90  */
  91
  92 #define DEFAULT_HISTORY         1       /* Preserve job history? */
  93 #define DEFAULT_FILES           0       /* Preserve job files? */
  94 #define DEFAULT_TIMEOUT         300     /* Timeout during requests/updates */
  95 #define DEFAULT_KEEPALIVE       60      /* Timeout between requests */
  96 #define DEFAULT_INTERVAL        30      /* Interval between browse updates */
  97 #define DEFAULT_CHARSET         "utf-8" /* Default charset */
  98
  99
 100 /*
 101  * Global variable macros...
 102  */
 103
 104 #ifdef _MAIN_C_
 105 #  define VAR
 106 #  define VALUE(x) =x
 107 #  define VALUE2(x,y) ={x,y}
 108 #else
 109 #  define VAR      extern
 110 #  define VALUE(x)
 111 #  define VALUE2(x,y)
 112 #endif /* _MAIN_C */
 113
 114
 115 /*
 116  * Other stuff for the scheduler...
 117  */
 118
 119 #include "sysman.h"
 120 #include "statbuf.h"
 121 #include "cert.h"
 122 #include "auth.h"
 123 #include "client.h"
 124 #include "policy.h"
 125 #include "printers.h"
 126 #include "classes.h"
 127 #include "job.h"
 128 #include "conf.h"
 129 #include "banners.h"
 130 #include "dirsvc.h"
 131 #include "network.h"
 132 #include "subscriptions.h"
 133
 134
 135 /*
 136  * Reload types...
 137  */
 138
 139 #define RELOAD_NONE     0               /* No reload needed */
 140 #define RELOAD_ALL      1               /* Reload everything */
 141 #define RELOAD_CUPSD    2               /* Reload only cupsd.conf */
 142
 143
 144 /*
 145  * Select callback function type...
 146  */
 147
 148 typedef void (*cupsd_selfunc_t)(void *data);
 149
 150
 151 /*
 152  * Globals...
 153  */
 154
 155 VAR int                 TestConfigFile  VALUE(0);
 156                                         /* Test the cupsd.conf file? */
 157 VAR int                 MaxFDs          VALUE(0);
 158                                         /* Maximum number of files */
 159
 160 VAR time_t              ReloadTime      VALUE(0);
 161                                         /* Time of reload request... */
 162 VAR int                 NeedReload      VALUE(RELOAD_ALL);
 163                                         /* Need to load configuration? */
 164 VAR void                *DefaultProfile VALUE(0);
 165                                         /* Default security profile */
 166
 167 #ifdef HAVE_GSSAPI
 168 VAR krb5_context        KerberosContext VALUE(NULL);
 169                                         /* Kerberos context for credentials */
 170 #endif /* HAVE_GSSAPI */
 171
 172 #ifdef HAVE_LAUNCH_H
 173 VAR int                 Launchd         VALUE(0);
 174                                         /* Running from launchd */
 175 #endif /* HAVE_LAUNCH_H */
 176
 177 #if defined(__APPLE__) && defined(HAVE_DLFCN_H)
 178 typedef int (*PSQUpdateQuotaProcPtr)(const char *printer, const char *info,
 179                                      const char *user, int nPages, int options);
 180 VAR PSQUpdateQuotaProcPtr PSQUpdateQuotaProc
 181                                         VALUE(0);
 182                                         /* Apple PrintService quota function */
 183 #endif /* __APPLE__ && HAVE_DLFCN_H */
 184
 185
 186
 187
 188 /*
 189  * Prototypes...
 190  */
 191
 192 extern void     cupsdClearString(char **s);
 193 extern void     cupsdHoldSignals(void);
 194 extern void     cupsdReleaseSignals(void);
 195 extern void     cupsdSetString(char **s, const char *v);
 196 extern void     cupsdSetStringf(char **s, const char *f, ...)
 197 #ifdef __GNUC__
 198 __attribute__ ((__format__ (__printf__, 2, 3)))
 199 #endif /* __GNUC__ */
 200 ;
 201 extern void     cupsdStartServer(void);
 202 extern void     cupsdStopServer(void);
 203 extern void     cupsdClosePipe(int *fds);
 204 extern int      cupsdOpenPipe(int *fds);
 205
 206 extern void     cupsdInitEnv(void);
 207 extern int      cupsdLoadEnv(char *envp[], int envmax);
 208 extern void     cupsdSetEnv(const char *name, const char *value);
 209 extern void     cupsdSetEnvf(const char *name, const char *value, ...)
 210 #ifdef __GNUC__
 211 __attribute__ ((__format__ (__printf__, 2, 3)))
 212 #endif /* __GNUC__ */
 213 ;
 214
 215 extern void     *cupsdCreateProfile(int job_id);
 216 extern void     cupsdDestroyProfile(void *profile);
 217 extern int      cupsdEndProcess(int pid, int force);
 218 extern const char *cupsdFinishProcess(int pid, char *name, int namelen);
 219 extern int      cupsdStartProcess(const char *command, char *argv[],
 220                                   char *envp[], int infd, int outfd,
 221                                   int errfd, int backfd, int sidefd,
 222                                   int root, void *profile, int *pid);
 223
 224 extern int      cupsdAddSelect(int fd, cupsd_selfunc_t read_cb,
 225                                cupsd_selfunc_t write_cb, void *data);
 226 extern int      cupsdDoSelect(long timeout);
 227 #ifdef CUPSD_IS_SELECTING
 228 extern int      cupsdIsSelecting(int fd);
 229 #endif /* CUPSD_IS_SELECTING */
 230 extern void     cupsdRemoveSelect(int fd);
 231 extern void     cupsdStartSelect(void);
 232 extern void     cupsdStopSelect(void);
 233
 234 extern int      cupsdRemoveFile(const char *filename);
 235
 236 /*
 237  * End of "$Id: cupsd.h 6875 2007-08-27 23:25:06Z mike $".
 238  */