scheduler/conf.h

   1 /*
   2  * "$Id: conf.h 7935 2008-09-11 01:54:11Z mike $"
   3  *
   4  *   Configuration file definitions for the Common UNIX Printing System (CUPS)
   5  *   scheduler.
   6  *
   7  *   Copyright 2007-2008 by Apple Inc.
   8  *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
   9  *
  10  *   These coded instructions, statements, and computer programs are the
  11  *   property of Apple Inc. and are protected by Federal copyright
  12  *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  13  *   which should have been included with this file.  If this file is
  14  *   file is missing or damaged, see the license at "http://www.cups.org/".
  15  */
  16
  17
  18 /*
  19  * Log levels...
  20  */
  21
  22 typedef enum
  23 {
  24   CUPSD_LOG_PPD = -4,                   /* Used internally for PPD keywords */
  25   CUPSD_LOG_ATTR,                       /* Used internally for attributes */
  26   CUPSD_LOG_STATE,                      /* Used internally for state-reasons */
  27   CUPSD_LOG_PAGE,                       /* Used internally for page logging */
  28   CUPSD_LOG_NONE,
  29   CUPSD_LOG_EMERG,                      /* Emergency issues */
  30   CUPSD_LOG_ALERT,                      /* Something bad happened that needs attention */
  31   CUPSD_LOG_CRIT,                       /* Critical error but server continues */
  32   CUPSD_LOG_ERROR,                      /* Error condition */
  33   CUPSD_LOG_WARN,                       /* Warning */
  34   CUPSD_LOG_NOTICE,                     /* Normal condition that needs logging */
  35   CUPSD_LOG_INFO,                       /* General information */
  36   CUPSD_LOG_DEBUG,                      /* General debugging */
  37   CUPSD_LOG_DEBUG2                      /* Detailed debugging */
  38 } cupsd_loglevel_t;
  39
  40 typedef enum
  41 {
  42   CUPSD_ACCESSLOG_CONFIG,               /* Log config requests */
  43   CUPSD_ACCESSLOG_ACTIONS,              /* Log config, print, and job management requests */
  44   CUPSD_ACCESSLOG_ALL                   /* Log everything */
  45 } cupsd_accesslog_t;
  46
  47
  48 /*
  49  * FatalErrors flags...
  50  */
  51
  52 #define CUPSD_FATAL_NONE        0       /* No errors are fatal */
  53 #define CUPSD_FATAL_BROWSE      1       /* Browse bind errors are fatal */
  54 #define CUPSD_FATAL_CONFIG      2       /* Config file syntax errors are fatal */
  55 #define CUPSD_FATAL_LISTEN      4       /* Listen/Port bind errors are fatal */
  56 #define CUPSD_FATAL_LOG         8       /* Log file errors are fatal */
  57 #define CUPSD_FATAL_PERMISSIONS 16      /* File permission errors are fatal */
  58 #define CUPSD_FATAL_ALL         ~0      /* All errors are fatal */
  59
  60
  61 /*
  62  * Printcap formats...
  63  */
  64
  65 #define PRINTCAP_BSD            0       /* Berkeley LPD format */
  66 #define PRINTCAP_SOLARIS        1       /* Solaris lpsched format */
  67 #define PRINTCAP_PLIST          2       /* Mac OS X plist format */
  68
  69
  70 /*
  71  * SSL options (bits)...
  72  */
  73
  74 #define CUPSD_SSL_NONE          0       /* No special options */
  75 #define CUPSD_SSL_NOEMPTY       1       /* Do not insert empty fragments */
  76
  77
  78 /*
  79  * Globals...
  80  */
  81
  82 VAR char                *ConfigurationFile      VALUE(NULL),
  83                                         /* Configuration file to use */
  84                         *ServerName             VALUE(NULL),
  85                                         /* FQDN for server */
  86                         *ServerAdmin            VALUE(NULL),
  87                                         /* Administrator's email */
  88                         *ServerRoot             VALUE(NULL),
  89                                         /* Root directory for scheduler */
  90                         *ServerBin              VALUE(NULL),
  91                                         /* Root directory for binaries */
  92                         *StateDir               VALUE(NULL),
  93                                         /* Root directory for state data */
  94                         *RequestRoot            VALUE(NULL),
  95                                         /* Directory for request files */
  96                         *DocumentRoot           VALUE(NULL);
  97                                         /* Root directory for documents */
  98 VAR int                 ServerNameIsIP          VALUE(0);
  99 VAR int                 NumSystemGroups         VALUE(0);
 100                                         /* Number of system group names */
 101 VAR char                *SystemGroups[MAX_SYSTEM_GROUPS]
 102                                                 VALUE({0});
 103                                         /* System group names */
 104 VAR gid_t               SystemGroupIDs[MAX_SYSTEM_GROUPS]
 105                                                 VALUE({0});
 106                                         /* System group IDs */
 107 VAR char                *AccessLog              VALUE(NULL),
 108                                         /* Access log filename */
 109                         *ErrorLog               VALUE(NULL),
 110                                         /* Error log filename */
 111                         *PageLog                VALUE(NULL),
 112                                         /* Page log filename */
 113                         *CacheDir               VALUE(NULL),
 114                                         /* Cache file directory */
 115                         *DataDir                VALUE(NULL),
 116                                         /* Data file directory */
 117                         *DefaultLanguage        VALUE(NULL),
 118                                         /* Default language encoding */
 119                         *DefaultCharset         VALUE(NULL),
 120                                         /* Default charset */
 121                         *DefaultLocale          VALUE(NULL),
 122                                         /* Default locale */
 123                         *DefaultPaperSize       VALUE(NULL),
 124                                         /* Default paper size */
 125                         *ErrorPolicy            VALUE(NULL),
 126                                         /* Default printer-error-policy */
 127                         *RIPCache               VALUE(NULL),
 128                                         /* Amount of memory for RIPs */
 129                         *TempDir                VALUE(NULL),
 130                                         /* Temporary directory */
 131                         *Printcap               VALUE(NULL),
 132                                         /* Printcap file */
 133                         *PrintcapGUI            VALUE(NULL),
 134                                         /* GUI program to use for IRIX */
 135                         *FontPath               VALUE(NULL),
 136                                         /* Font search path */
 137                         *RemoteRoot             VALUE(NULL),
 138                                         /* Remote root user */
 139                         *Classification         VALUE(NULL);
 140                                         /* Classification of system */
 141 #ifdef HAVE_GSSAPI
 142 VAR char                *GSSServiceName         VALUE(NULL);
 143                                         /* GSS service name */
 144 VAR char                *Krb5Keytab             VALUE(NULL);
 145                                         /* Kerberos Keytab */
 146 #endif /* HAVE_GSSAPI */
 147 VAR uid_t               User                    VALUE(1);
 148                                         /* User ID for server */
 149 VAR gid_t               Group                   VALUE(0);
 150                                         /* Group ID for server */
 151 VAR int                 AccessLogLevel          VALUE(CUPSD_ACCESSLOG_ACTIONS),
 152                                         /* Access log level */
 153                         ClassifyOverride        VALUE(0),
 154                                         /* Allow overrides? */
 155                         ConfigFilePerm          VALUE(0640),
 156                                         /* Permissions for config files */
 157                         FatalErrors             VALUE(CUPSD_FATAL_CONFIG),
 158                                         /* Which errors are fatal? */
 159                         LogFilePerm             VALUE(0644),
 160                                         /* Permissions for log files */
 161                         LogLevel                VALUE(CUPSD_LOG_WARN),
 162                                         /* Error log level */
 163                         MaxClients              VALUE(0),
 164                                         /* Maximum number of clients */
 165                         MaxClientsPerHost       VALUE(0),
 166                                         /* Maximum number of clients per host */
 167                         MaxCopies               VALUE(CUPS_DEFAULT_MAX_COPIES),
 168                                         /* Maximum number of copies per job */
 169                         MaxLogSize              VALUE(1024 * 1024),
 170                                         /* Maximum size of log files */
 171                         MaxPrinterHistory       VALUE(10),
 172                                         /* Maximum printer state history */
 173                         MaxRequestSize          VALUE(0),
 174                                         /* Maximum size of IPP requests */
 175                         HostNameLookups         VALUE(FALSE),
 176                                         /* Do we do reverse lookups? */
 177                         Timeout                 VALUE(DEFAULT_TIMEOUT),
 178                                         /* Timeout during requests */
 179                         KeepAlive               VALUE(TRUE),
 180                                         /* Support the Keep-Alive option? */
 181                         KeepAliveTimeout        VALUE(DEFAULT_KEEPALIVE),
 182                                         /* Timeout between requests */
 183                         ImplicitClasses         VALUE(TRUE),
 184                                         /* Are classes implicitly created? */
 185                         ImplicitAnyClasses      VALUE(FALSE),
 186                                         /* Create AnyPrinter classes? */
 187                         HideImplicitMembers     VALUE(TRUE),
 188                                         /* Hide implicit class members? */
 189                         FileDevice              VALUE(FALSE),
 190                                         /* Allow file: devices? */
 191                         FilterLimit             VALUE(0),
 192                                         /* Max filter cost at any time */
 193                         FilterLevel             VALUE(0),
 194                                         /* Current filter level */
 195                         FilterNice              VALUE(0),
 196                                         /* Nice value for filters */
 197                         ReloadTimeout           VALUE(DEFAULT_KEEPALIVE),
 198                                         /* Timeout before reload from SIGHUP */
 199                         RootCertDuration        VALUE(300),
 200                                         /* Root certificate update interval */
 201                         RunUser                 VALUE(0),
 202                                         /* User to run as, used for files */
 203                         PrintcapFormat          VALUE(PRINTCAP_BSD),
 204                                         /* Format of printcap file? */
 205                         DefaultShared           VALUE(TRUE);
 206                                         /* Share printers by default? */
 207 VAR cups_file_t         *AccessFile             VALUE(NULL),
 208                                         /* Access log file */
 209                         *ErrorFile              VALUE(NULL),
 210                                         /* Error log file */
 211                         *PageFile               VALUE(NULL);
 212                                         /* Page log file */
 213 VAR char                *PageLogFormat          VALUE(NULL);
 214                                         /* Page log format */
 215 VAR mime_t              *MimeDatabase           VALUE(NULL);
 216                                         /* MIME type database */
 217 VAR int                 NumMimeTypes            VALUE(0);
 218                                         /* Number of MIME types */
 219 VAR const char          **MimeTypes             VALUE(NULL);
 220                                         /* Array of MIME types */
 221
 222 #ifdef HAVE_SSL
 223 VAR char                *ServerCertificate      VALUE(NULL);
 224                                         /* Server certificate file */
 225 #  if defined(HAVE_LIBSSL) || defined(HAVE_GNUTLS)
 226 VAR char                *ServerKey              VALUE(NULL);
 227                                         /* Server key file */
 228 #  endif /* HAVE_LIBSSL || HAVE_GNUTLS */
 229 VAR int                 SSLOptions              VALUE(CUPSD_SSL_NONE);
 230                                         /* SSL/TLS options */
 231 #endif /* HAVE_SSL */
 232
 233 #ifdef HAVE_LAUNCHD
 234 VAR int                 LaunchdTimeout          VALUE(DEFAULT_KEEPALIVE);
 235                                         /* Time after which an idle cupsd will exit */
 236 VAR char                *LaunchdConf            VALUE(NULL);
 237                                         /* launchd(8) configuration file */
 238 #endif /* HAVE_LAUNCHD */
 239
 240 #ifdef __APPLE__
 241 VAR int                 AppleQuotas             VALUE(TRUE);
 242                                         /* Use Apple PrintService Quotas instead of CUPS quotas */
 243 #endif  /* __APPLE__ */
 244
 245 #ifdef HAVE_AUTHORIZATION_H
 246 VAR char                *SystemGroupAuthKey     VALUE(NULL);
 247                                         /* System group auth key */
 248 #endif /* HAVE_AUTHORIZATION_H */
 249
 250
 251 /*
 252  * Prototypes...
 253  */
 254
 255 extern int      cupsdCheckPermissions(const char *filename,
 256                                       const char *suffix, int mode,
 257                                       int user, int group, int is_dir,
 258                                       int create_dir);
 259 extern char     *cupsdGetDateTime(time_t t);
 260 #ifdef HAVE_GSSAPI
 261 extern int      cupsdLogGSSMessage(int level, int major_status,
 262                                    int minor_status,
 263                                    const char *message, ...);
 264 #endif /* HAVE_GSSAPI */
 265 extern int      cupsdLogJob(cupsd_job_t *job, int level, const char *message, ...)
 266 #ifdef __GNUC__
 267 __attribute__ ((__format__ (__printf__, 3, 4)))
 268 #endif /* __GNUC__ */
 269 ;
 270 extern int      cupsdLogMessage(int level, const char *message, ...)
 271 #ifdef __GNUC__
 272 __attribute__ ((__format__ (__printf__, 2, 3)))
 273 #endif /* __GNUC__ */
 274 ;
 275 extern int      cupsdLogPage(cupsd_job_t *job, const char *page);
 276 extern int      cupsdLogRequest(cupsd_client_t *con, http_status_t code);
 277 extern int      cupsdReadConfiguration(void);
 278 extern int      cupsdWriteErrorLog(int level, const char *message);
 279
 280
 281 /*
 282  * End of "$Id: conf.h 7935 2008-09-11 01:54:11Z mike $".
 283  */