scheduler/cupsd.h

   1 /*
   2  * "$Id: cupsd.h 7928 2008-09-10 22:14:22Z mike $"
   3  *
   4  *   Main header file for the CUPS scheduler.
   5  *
   6  *   Copyright 2007-2011 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/cups-private.h>
  22
  23 #include <limits.h>
  24 #include <time.h>
  25 #include <signal.h>
  26 #include <fcntl.h>
  27 #include <math.h>
  28 #include <sys/types.h>
  29 #include <sys/time.h>
  30 #include <sys/stat.h>
  31 #include <sys/wait.h>
  32
  33 #ifdef WIN32
  34 #  include <direct.h>
  35 #else
  36 #  include <unistd.h>
  37 #endif /* WIN32 */
  38
  39 #include "mime.h"
  40
  41 #if defined(HAVE_CDSASSL)
  42 #  include <CoreFoundation/CoreFoundation.h>
  43 #endif /* HAVE_CDSASSL */
  44
  45
  46 /*
  47  * Some OS's don't have hstrerror(), most notably Solaris...
  48  */
  49
  50 #ifndef HAVE_HSTRERROR
  51 #  ifdef hstrerror
  52 #    undef hstrerror
  53 #  endif /* hstrerror */
  54 #  define hstrerror cups_hstrerror
  55
  56 extern const char *cups_hstrerror(int);
  57 #endif /* !HAVE_HSTRERROR */
  58
  59
  60 /*
  61  * Common constants.
  62  */
  63
  64 #ifndef FALSE
  65 #  define FALSE         0
  66 #  define TRUE          (!FALSE)
  67 #endif /* !FALSE */
  68
  69
  70 /*
  71  * Implementation limits...
  72  */
  73
  74 #define MAX_ENV                 100     /* Maximum number of environment strings */
  75 #define MAX_USERPASS            33      /* Maximum size of username/password */
  76 #define MAX_FILTERS             20      /* Maximum number of filters */
  77 #define MAX_SYSTEM_GROUPS       32      /* Maximum number of system groups */
  78
  79
  80 /*
  81  * Defaults...
  82  */
  83
  84 #define DEFAULT_HISTORY         1       /* Preserve job history? */
  85 #define DEFAULT_FILES           0       /* Preserve job files? */
  86 #define DEFAULT_TIMEOUT         300     /* Timeout during requests/updates */
  87 #define DEFAULT_KEEPALIVE       30      /* Timeout between requests */
  88 #define DEFAULT_INTERVAL        30      /* Interval between browse updates */
  89 #define DEFAULT_CHARSET         "utf-8" /* Default charset */
  90
  91
  92 /*
  93  * Global variable macros...
  94  */
  95
  96 #ifdef _MAIN_C_
  97 #  define VAR
  98 #  define VALUE(x) =x
  99 #  define VALUE2(x,y) ={x,y}
 100 #else
 101 #  define VAR      extern
 102 #  define VALUE(x)
 103 #  define VALUE2(x,y)
 104 #endif /* _MAIN_C */
 105
 106
 107 /*
 108  * Other stuff for the scheduler...
 109  */
 110
 111 #include "sysman.h"
 112 #include "statbuf.h"
 113 #include "cert.h"
 114 #include "auth.h"
 115 #include "client.h"
 116 #include "policy.h"
 117 #include "printers.h"
 118 #include "classes.h"
 119 #include "job.h"
 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
 136 /*
 137  * Select callback function type...
 138  */
 139
 140 typedef void (*cupsd_selfunc_t)(void *data);
 141
 142
 143 /*
 144  * Globals...
 145  */
 146
 147 VAR int                 TestConfigFile  VALUE(0),
 148                                         /* Test the cupsd.conf file? */
 149                         UseProfiles     VALUE(1);
 150                                         /* Use security profiles for child procs? */
 151 VAR int                 MaxFDs          VALUE(0);
 152                                         /* Maximum number of files */
 153
 154 VAR time_t              ReloadTime      VALUE(0);
 155                                         /* Time of reload request... */
 156 VAR int                 NeedReload      VALUE(RELOAD_ALL),
 157                                         /* Need to load configuration? */
 158                         DoingShutdown   VALUE(0);
 159                                         /* Shutting down the scheduler? */
 160 VAR void                *DefaultProfile VALUE(0);
 161                                         /* Default security profile */
 162
 163 #ifdef HAVE_GSSAPI
 164 VAR int                 KerberosInitialized     VALUE(0);
 165                                         /* Has Kerberos been initialized? */
 166 VAR krb5_context        KerberosContext VALUE(NULL);
 167                                         /* Kerberos context for credentials */
 168 #endif /* HAVE_GSSAPI */
 169
 170 #ifdef HAVE_LAUNCH_H
 171 VAR int                 Launchd         VALUE(0);
 172                                         /* Running from launchd */
 173 #endif /* HAVE_LAUNCH_H */
 174
 175
 176 /*
 177  * Prototypes...
 178  */
 179
 180 extern int      cupsdAddString(cups_array_t **a, const char *s);
 181 extern void     cupsdCheckProcess(void);
 182 extern void     cupsdClearString(char **s);
 183 extern void     cupsdFreeStrings(cups_array_t **a);
 184 extern void     cupsdHoldSignals(void);
 185 extern void     cupsdReleaseSignals(void);
 186 extern void     cupsdSetString(char **s, const char *v);
 187 extern void     cupsdSetStringf(char **s, const char *f, ...)
 188 #ifdef __GNUC__
 189 __attribute__ ((__format__ (__printf__, 2, 3)))
 190 #endif /* __GNUC__ */
 191 ;
 192 extern void     cupsdStartServer(void);
 193 extern void     cupsdStopServer(void);
 194 extern void     cupsdClosePipe(int *fds);
 195 extern int      cupsdOpenPipe(int *fds);
 196
 197 extern void     cupsdInitEnv(void);
 198 extern int      cupsdLoadEnv(char *envp[], int envmax);
 199 extern void     cupsdSetEnv(const char *name, const char *value);
 200 extern void     cupsdSetEnvf(const char *name, const char *value, ...)
 201 #ifdef __GNUC__
 202 __attribute__ ((__format__ (__printf__, 2, 3)))
 203 #endif /* __GNUC__ */
 204 ;
 205 extern void     cupsdUpdateEnv(void);
 206
 207 extern void     *cupsdCreateProfile(int job_id);
 208 extern void     cupsdDestroyProfile(void *profile);
 209 extern int      cupsdEndProcess(int pid, int force);
 210 extern const char *cupsdFinishProcess(int pid, char *name, int namelen,
 211                                       int *job_id);
 212 extern int      cupsdStartProcess(const char *command, char *argv[],
 213                                   char *envp[], int infd, int outfd,
 214                                   int errfd, int backfd, int sidefd,
 215                                   int root, void *profile, cupsd_job_t *job,
 216                                   int *pid);
 217
 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);
 221 #ifdef CUPSD_IS_SELECTING
 222 extern int      cupsdIsSelecting(int fd);
 223 #endif /* CUPSD_IS_SELECTING */
 224 extern void     cupsdRemoveSelect(int fd);
 225 extern void     cupsdStartSelect(void);
 226 extern void     cupsdStopSelect(void);
 227
 228 extern int      cupsdRemoveFile(const char *filename);
 229
 230
 231 /*
 232  * End of "$Id: cupsd.h 7928 2008-09-10 22:14:22Z mike $".
 233  */