cups/cups-private.h

   1 /*
   2  * "$Id: cups-private.h 9596 2011-03-11 18:26:36Z mike $"
   3  *
   4  *   Private definitions for CUPS.
   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  *   which should have been included with this file.  If this file is
  13  *   file is missing or damaged, see the license at "http://www.cups.org/".
  14  *
  15  *   This file is subject to the Apple OS-Developed Software exception.
  16  */
  17
  18 #ifndef _CUPS_CUPS_PRIVATE_H_
  19 #  define _CUPS_CUPS_PRIVATE_H_
  20
  21 /*
  22  * Include necessary headers...
  23  */
  24
  25 #  include <cups/cups.h>
  26 #  include "string-private.h"
  27 #  include "debug-private.h"
  28 #  include "ppd-private.h"
  29 #  include "http-private.h"
  30 #  include "ipp-private.h"
  31 #  include "language-private.h"
  32 #  include "pwg-private.h"
  33 #  include "thread-private.h"
  34 #  ifdef __APPLE__
  35 #    include <sys/cdefs.h>
  36 #    include <CoreFoundation/CoreFoundation.h>
  37 #  endif /* __APPLE__ */
  38
  39
  40 /*
  41  * C++ magic...
  42  */
  43
  44 #  ifdef __cplusplus
  45 extern "C" {
  46 #  endif /* __cplusplus */
  47
  48
  49 /*
  50  * Types...
  51  */
  52
  53 typedef struct _cups_globals_s          /**** CUPS global state data ****/
  54 {
  55   /* Multiple places... */
  56   const char            *cups_datadir,  /* CUPS_DATADIR environment var */
  57                         *cups_serverbin,/* CUPS_SERVERBIN environment var */
  58                         *cups_serverroot,
  59                                         /* CUPS_SERVERROOT environment var */
  60                         *cups_statedir, /* CUPS_STATEDIR environment var */
  61                         *localedir;     /* LOCALDIR environment var */
  62
  63   /* adminutil.c */
  64   time_t                cupsd_update;   /* Last time we got or set cupsd.conf */
  65   char                  cupsd_hostname[HTTP_MAX_HOST];
  66                                         /* Hostname for connection */
  67   int                   cupsd_num_settings;
  68                                         /* Number of server settings */
  69   cups_option_t         *cupsd_settings;/* Server settings */
  70
  71   /* auth.c */
  72 #  ifdef HAVE_GSSAPI
  73   char                  gss_service_name[32];
  74                                         /* Kerberos service name */
  75 #  endif /* HAVE_GSSAPI */
  76
  77   /* backend.c */
  78   char                  resolved_uri[1024];
  79                                         /* Buffer for cupsBackendDeviceURI */
  80
  81   /* file.c */
  82   cups_file_t           *stdio_files[3];/* stdin, stdout, stderr */
  83
  84   /* http.c */
  85   char                  http_date[256]; /* Date+time buffer */
  86
  87   /* http-addr.c */
  88   unsigned              ip_addr;        /* Packed IPv4 address */
  89   char                  *ip_ptrs[2];    /* Pointer to packed address */
  90   struct hostent        hostent;        /* Host entry for IP address */
  91 #  ifdef HAVE_GETADDRINFO
  92   char                  hostname[1024]; /* Hostname */
  93 #  endif /* HAVE_GETADDRINFO */
  94   int                   need_res_init;  /* Need to reinitialize resolver? */
  95
  96   /* ipp.c */
  97   ipp_uchar_t           ipp_date[11];   /* RFC-1903 date/time data */
  98   _ipp_buffer_t         *ipp_buffers;   /* Buffer list */
  99
 100   /* ipp-support.c */
 101   int                   ipp_port;       /* IPP port number */
 102   char                  ipp_unknown[255];
 103                                         /* Unknown error statuses */
 104
 105   /* language.c */
 106   cups_lang_t           *lang_default;  /* Default language */
 107 #  ifdef __APPLE__
 108   char                  language[32];   /* Cached language */
 109 #  endif /* __APPLE__ */
 110
 111   /* ppd.c */
 112   ppd_status_t          ppd_status;     /* Status of last ppdOpen*() */
 113   int                   ppd_line;       /* Current line number */
 114   ppd_conform_t         ppd_conform;    /* Level of conformance required */
 115
 116   /* pwg-media.c */
 117   cups_array_t          *leg_size_lut,  /* Lookup table for legacy names */
 118                         *ppd_size_lut,  /* Lookup table for PPD names */
 119                         *pwg_size_lut;  /* Lookup table for PWG names */
 120   _pwg_media_t          pwg_media;      /* PWG media data for custom size */
 121   char                  pwg_name[65];   /* PWG media name for custom size */
 122
 123   /* request.c */
 124   http_t                *http;          /* Current server connection */
 125   ipp_status_t          last_error;     /* Last IPP error */
 126   char                  *last_status_message;
 127                                         /* Last IPP status-message */
 128
 129   /* snmp.c */
 130   char                  snmp_community[255];
 131                                         /* Default SNMP community name */
 132   int                   snmp_debug;     /* Log SNMP IO to stderr? */
 133
 134   /* tempfile.c */
 135   char                  tempfile[1024]; /* cupsTempFd/File buffer */
 136
 137   /* usersys.c */
 138   http_encryption_t     encryption;     /* Encryption setting */
 139   char                  user[65],       /* User name */
 140                         server[256],    /* Server address */
 141                         servername[256];/* Server hostname */
 142   cups_password_cb2_t   password_cb;    /* Password callback */
 143   void                  *password_data; /* Password user data */
 144   http_tls_credentials_t tls_credentials;
 145                                         /* Default client credentials */
 146   cups_client_cert_cb_t client_cert_cb; /* Client certificate callback */
 147   void                  *client_cert_data;
 148                                         /* Client certificate user data */
 149   cups_server_cert_cb_t server_cert_cb; /* Server certificate callback */
 150   void                  *server_cert_data;
 151                                         /* Server certificate user data */
 152   int                   any_root,       /* Allow any root */
 153                         expired_certs,  /* Allow expired certs */
 154                         expired_root;   /* Allow expired root */
 155
 156   /* util.c */
 157   char                  def_printer[256];
 158                                         /* Default printer */
 159   char                  ppd_filename[HTTP_MAX_URI];
 160                                         /* PPD filename */
 161 } _cups_globals_t;
 162
 163
 164 /*
 165  * Prototypes...
 166  */
 167
 168 #  ifdef __APPLE__
 169 extern CFStringRef      _cupsAppleCopyDefaultPaperID(void);
 170 extern CFStringRef      _cupsAppleCopyDefaultPrinter(void);
 171 extern int              _cupsAppleGetUseLastPrinter(void);
 172 extern void             _cupsAppleSetDefaultPaperID(CFStringRef name);
 173 extern void             _cupsAppleSetDefaultPrinter(CFStringRef name);
 174 extern void             _cupsAppleSetUseLastPrinter(int uselast);
 175 #  endif /* __APPLE__ */
 176
 177 extern http_t           *_cupsConnect(void);
 178 extern int              _cupsGet1284Values(const char *device_id,
 179                                            cups_option_t **values);
 180 extern int              _cupsGetDests(http_t *http, ipp_op_t op,
 181                                       const char *name, cups_dest_t **dests);
 182 extern const char       *_cupsGetPassword(const char *prompt);
 183 extern void             _cupsGlobalLock(void);
 184 extern _cups_globals_t  *_cupsGlobals(void);
 185 extern void             _cupsGlobalUnlock(void);
 186 #  ifdef HAVE_GSSAPI
 187 extern const char       *_cupsGSSServiceName(void);
 188 #  endif /* HAVE_GSSAPI */
 189 extern int              _cupsNextDelay(int current, int *previous);
 190 extern void             _cupsSetDefaults(void);
 191 extern void             _cupsSetError(ipp_status_t status, const char *message,
 192                                       int localize);
 193 extern void             _cupsSetHTTPError(http_status_t status);
 194 #  ifdef HAVE_GSSAPI
 195 extern int              _cupsSetNegotiateAuthString(http_t *http,
 196                                                     const char *method,
 197                                                     const char *resource);
 198 #  endif /* HAVE_GSSAPI */
 199 extern char             *_cupsUserDefault(char *name, size_t namesize);
 200
 201
 202 /*
 203  * C++ magic...
 204  */
 205
 206 #  ifdef __cplusplus
 207 }
 208 #  endif /* __cplusplus */
 209 #endif /* !_CUPS_CUPS_PRIVATE_H_ */
 210
 211 /*
 212  * End of "$Id: cups-private.h 9596 2011-03-11 18:26:36Z mike $".
 213  */