cups/cups-private.h

   1 /*
   2  * Private definitions for CUPS.
   3  *
   4  * Copyright © 2007-2018 by Apple Inc.
   5  * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
   6  *
   7  * Licensed under Apache License v2.0.  See the file "LICENSE" for more
   8  * information.
   9  */
  10
  11 #ifndef _CUPS_CUPS_PRIVATE_H_
  12 #  define _CUPS_CUPS_PRIVATE_H_
  13
  14 /*
  15  * Include necessary headers...
  16  */
  17
  18 #  include "string-private.h"
  19 #  include "debug-private.h"
  20 #  include "array-private.h"
  21 #  include "ipp-private.h"
  22 #  include "http-private.h"
  23 #  include "language-private.h"
  24 #  include "pwg-private.h"
  25 #  include "thread-private.h"
  26 #  include <cups/cups.h>
  27 #  ifdef __APPLE__
  28 #    include <sys/cdefs.h>
  29 #    include <CoreFoundation/CoreFoundation.h>
  30 #  endif /* __APPLE__ */
  31
  32
  33 /*
  34  * C++ magic...
  35  */
  36
  37 #  ifdef __cplusplus
  38 extern "C" {
  39 #  endif /* __cplusplus */
  40
  41
  42 /*
  43  * Types...
  44  */
  45
  46 typedef struct _cups_buffer_s           /**** Read/write buffer ****/
  47 {
  48   struct _cups_buffer_s *next;          /* Next buffer in list */
  49   size_t                size;           /* Size of buffer */
  50   char                  used,           /* Is this buffer used? */
  51                         d[1];           /* Data buffer */
  52 } _cups_buffer_t;
  53
  54 typedef struct _cups_raster_error_s     /**** Error buffer structure ****/
  55 {
  56   char  *start,                         /* Start of buffer */
  57         *current,                       /* Current position in buffer */
  58         *end;                           /* End of buffer */
  59 } _cups_raster_error_t;
  60
  61 typedef struct _cups_globals_s          /**** CUPS global state data ****/
  62 {
  63   /* Multiple places... */
  64   const char            *cups_datadir,  /* CUPS_DATADIR environment var */
  65                         *cups_serverbin,/* CUPS_SERVERBIN environment var */
  66                         *cups_serverroot,
  67                                         /* CUPS_SERVERROOT environment var */
  68                         *cups_statedir, /* CUPS_STATEDIR environment var */
  69                         *localedir;     /* LOCALDIR environment var */
  70
  71   /* adminutil.c */
  72   time_t                cupsd_update;   /* Last time we got or set cupsd.conf */
  73   char                  cupsd_hostname[HTTP_MAX_HOST];
  74                                         /* Hostname for connection */
  75   int                   cupsd_num_settings;
  76                                         /* Number of server settings */
  77   cups_option_t         *cupsd_settings;/* Server settings */
  78
  79   /* auth.c */
  80 #  ifdef HAVE_GSSAPI
  81   char                  gss_service_name[32];
  82                                         /* Kerberos service name */
  83 #  endif /* HAVE_GSSAPI */
  84
  85   /* backend.c */
  86   char                  resolved_uri[1024];
  87                                         /* Buffer for cupsBackendDeviceURI */
  88
  89   /* debug.c */
  90 #  ifdef DEBUG
  91   int                   thread_id;      /* Friendly thread ID */
  92 #  endif /* DEBUG */
  93
  94   /* file.c */
  95   cups_file_t           *stdio_files[3];/* stdin, stdout, stderr */
  96
  97   /* http.c */
  98   char                  http_date[256]; /* Date+time buffer */
  99
 100   /* http-addr.c */
 101   unsigned              ip_addr;        /* Packed IPv4 address */
 102   char                  *ip_ptrs[2];    /* Pointer to packed address */
 103   struct hostent        hostent;        /* Host entry for IP address */
 104 #  ifdef HAVE_GETADDRINFO
 105   char                  hostname[1024]; /* Hostname */
 106 #  endif /* HAVE_GETADDRINFO */
 107   int                   need_res_init;  /* Need to reinitialize resolver? */
 108
 109   /* ipp.c */
 110   ipp_uchar_t           ipp_date[11];   /* RFC-2579 date/time data */
 111   _cups_buffer_t        *cups_buffers;  /* Buffer list */
 112
 113   /* ipp-support.c */
 114   int                   ipp_port;       /* IPP port number */
 115   char                  ipp_unknown[255];
 116                                         /* Unknown error statuses */
 117
 118   /* language.c */
 119   cups_lang_t           *lang_default;  /* Default language */
 120 #  ifdef __APPLE__
 121   char                  language[32];   /* Cached language */
 122 #  endif /* __APPLE__ */
 123
 124   /* pwg-media.c */
 125   cups_array_t          *leg_size_lut,  /* Lookup table for legacy names */
 126                         *ppd_size_lut,  /* Lookup table for PPD names */
 127                         *pwg_size_lut;  /* Lookup table for PWG names */
 128   pwg_media_t           pwg_media;      /* PWG media data for custom size */
 129   char                  pwg_name[65],   /* PWG media name for custom size */
 130                         ppd_name[41];   /* PPD media name for custom size */
 131
 132   /* raster-error.c */
 133   _cups_raster_error_t  raster_error;   /* Raster error information */
 134
 135   /* request.c */
 136   http_t                *http;          /* Current server connection */
 137   ipp_status_t          last_error;     /* Last IPP error */
 138   char                  *last_status_message;
 139                                         /* Last IPP status-message */
 140
 141   /* snmp.c */
 142   char                  snmp_community[255];
 143                                         /* Default SNMP community name */
 144   int                   snmp_debug;     /* Log SNMP IO to stderr? */
 145
 146   /* tempfile.c */
 147   char                  tempfile[1024]; /* cupsTempFd/File buffer */
 148
 149   /* usersys.c */
 150   http_encryption_t     encryption;     /* Encryption setting */
 151   char                  user[65],       /* User name */
 152                         user_agent[256],/* User-Agent string */
 153                         server[256],    /* Server address */
 154                         servername[256],/* Server hostname */
 155                         password[128];  /* Password for default callback */
 156   cups_password_cb2_t   password_cb;    /* Password callback */
 157   void                  *password_data; /* Password user data */
 158   http_tls_credentials_t tls_credentials;
 159                                         /* Default client credentials */
 160   cups_client_cert_cb_t client_cert_cb; /* Client certificate callback */
 161   void                  *client_cert_data;
 162                                         /* Client certificate user data */
 163   cups_server_cert_cb_t server_cert_cb; /* Server certificate callback */
 164   void                  *server_cert_data;
 165                                         /* Server certificate user data */
 166   int                   server_version, /* Server IPP version */
 167                         trust_first,    /* Trust on first use? */
 168                         any_root,       /* Allow any (e.g., self-signed) root */
 169                         expired_certs,  /* Allow expired certs */
 170                         validate_certs; /* Validate certificates */
 171
 172   /* util.c */
 173   char                  def_printer[256];
 174                                         /* Default printer */
 175 } _cups_globals_t;
 176
 177 typedef struct _cups_media_db_s         /* Media database */
 178 {
 179   char          *color,                 /* Media color, if any */
 180                 *key,                   /* Media key, if any */
 181                 *info,                  /* Media human-readable name, if any */
 182                 *size_name,             /* Media PWG size name, if provided */
 183                 *source,                /* Media source, if any */
 184                 *type;                  /* Media type, if any */
 185   int           width,                  /* Width in hundredths of millimeters */
 186                 length,                 /* Length in hundredths of
 187                                          * millimeters */
 188                 bottom,                 /* Bottom margin in hundredths of
 189                                          * millimeters */
 190                 left,                   /* Left margin in hundredths of
 191                                          * millimeters */
 192                 right,                  /* Right margin in hundredths of
 193                                          * millimeters */
 194                 top;                    /* Top margin in hundredths of
 195                                          * millimeters */
 196 } _cups_media_db_t;
 197
 198 typedef struct _cups_dconstres_s        /* Constraint/resolver */
 199 {
 200   char  *name;                          /* Name of resolver */
 201   ipp_t *collection;                    /* Collection containing attrs */
 202 } _cups_dconstres_t;
 203
 204 struct _cups_dinfo_s                    /* Destination capability and status
 205                                          * information */
 206 {
 207   int                   version;        /* IPP version */
 208   const char            *uri;           /* Printer URI */
 209   char                  *resource;      /* Resource path */
 210   ipp_t                 *attrs;         /* Printer attributes */
 211   int                   num_defaults;   /* Number of default options */
 212   cups_option_t         *defaults;      /* Default options */
 213   cups_array_t          *constraints;   /* Job constraints */
 214   cups_array_t          *resolvers;     /* Job resolvers */
 215   cups_array_t          *localizations; /* Localization information */
 216   cups_array_t          *media_db;      /* Media database */
 217   _cups_media_db_t      min_size,       /* Minimum size */
 218                         max_size;       /* Maximum size */
 219   unsigned              cached_flags;   /* Flags used for cached media */
 220   cups_array_t          *cached_db;     /* Cache of media from last index/default */
 221   time_t                ready_time;     /* When xxx-ready attributes were last queried */
 222   ipp_t                 *ready_attrs;   /* xxx-ready attributes */
 223   cups_array_t          *ready_db;      /* media[-col]-ready media database */
 224 };
 225
 226
 227 /*
 228  * Prototypes...
 229  */
 230
 231 #  ifdef __APPLE__
 232 extern CFStringRef      _cupsAppleCopyDefaultPaperID(void) _CUPS_PRIVATE;
 233 extern CFStringRef      _cupsAppleCopyDefaultPrinter(void) _CUPS_PRIVATE;
 234 extern int              _cupsAppleGetUseLastPrinter(void) _CUPS_PRIVATE;
 235 extern void             _cupsAppleSetDefaultPaperID(CFStringRef name) _CUPS_PRIVATE;
 236 extern void             _cupsAppleSetDefaultPrinter(CFStringRef name) _CUPS_PRIVATE;
 237 extern void             _cupsAppleSetUseLastPrinter(int uselast) _CUPS_PRIVATE;
 238 #  endif /* __APPLE__ */
 239
 240 extern char             *_cupsBufferGet(size_t size) _CUPS_PRIVATE;
 241 extern void             _cupsBufferRelease(char *b) _CUPS_PRIVATE;
 242
 243 extern http_t           *_cupsConnect(void) _CUPS_INTERNAL;
 244 extern char             *_cupsCreateDest(const char *name, const char *info, const char *device_id, const char *device_uri, char *uri, size_t urisize) _CUPS_PRIVATE;
 245 extern ipp_attribute_t  *_cupsEncodeOption(ipp_t *ipp, ipp_tag_t group_tag, _ipp_option_t *map, const char *name, const char *value) _CUPS_PRIVATE;
 246 extern int              _cupsGet1284Values(const char *device_id, cups_option_t **values) _CUPS_PRIVATE;
 247 extern const char       *_cupsGetDestResource(cups_dest_t *dest, unsigned flags, char *resource, size_t resourcesize) _CUPS_PRIVATE;
 248 extern int              _cupsGetDests(http_t *http, ipp_op_t op, const char *name, cups_dest_t **dests, cups_ptype_t type, cups_ptype_t mask) _CUPS_PRIVATE;
 249 extern const char       *_cupsGetPassword(const char *prompt) _CUPS_PRIVATE;
 250 extern void             _cupsGlobalLock(void) _CUPS_PRIVATE;
 251 extern _cups_globals_t  *_cupsGlobals(void) _CUPS_PRIVATE;
 252 extern void             _cupsGlobalUnlock(void) _CUPS_PRIVATE;
 253 #  ifdef HAVE_GSSAPI
 254 extern const char       *_cupsGSSServiceName(void) _CUPS_PRIVATE;
 255 #  endif /* HAVE_GSSAPI */
 256 extern int              _cupsNextDelay(int current, int *previous) _CUPS_PRIVATE;
 257 extern void             _cupsSetDefaults(void) _CUPS_INTERNAL;
 258 extern void             _cupsSetError(ipp_status_t status, const char *message, int localize) _CUPS_PRIVATE;
 259 extern void             _cupsSetHTTPError(http_status_t status) _CUPS_INTERNAL;
 260 #  ifdef HAVE_GSSAPI
 261 extern int              _cupsSetNegotiateAuthString(http_t *http, const char *method, const char *resource) _CUPS_PRIVATE;
 262 #  endif /* HAVE_GSSAPI */
 263 extern char             *_cupsUserDefault(char *name, size_t namesize) _CUPS_INTERNAL;
 264
 265
 266 /*
 267  * C++ magic...
 268  */
 269
 270 #  ifdef __cplusplus
 271 }
 272 #  endif /* __cplusplus */
 273 #endif /* !_CUPS_CUPS_PRIVATE_H_ */