/* * Private definitions for CUPS. * * Copyright 2007-2017 by Apple Inc. * Copyright 1997-2007 by Easy Software Products, all rights reserved. * * These coded instructions, statements, and computer programs are the * property of Apple Inc. and are protected by Federal copyright * law. Distribution and use rights are outlined in the file "LICENSE.txt" * which should have been included with this file. If this file is * missing or damaged, see the license at "http://www.cups.org/". * * This file is subject to the Apple OS-Developed Software exception. */ #ifndef _CUPS_CUPS_PRIVATE_H_ # define _CUPS_CUPS_PRIVATE_H_ /* * Include necessary headers... */ # include "string-private.h" # include "debug-private.h" # include "array-private.h" # include "ipp-private.h" # include "http-private.h" # include "language-private.h" # include "pwg-private.h" # include "thread-private.h" # include # ifdef __APPLE__ # include # include # endif /* __APPLE__ */ /* * C++ magic... */ # ifdef __cplusplus extern "C" { # endif /* __cplusplus */ /* * Types... */ typedef struct _cups_buffer_s /**** Read/write buffer ****/ { struct _cups_buffer_s *next; /* Next buffer in list */ size_t size; /* Size of buffer */ char used, /* Is this buffer used? */ d[1]; /* Data buffer */ } _cups_buffer_t; typedef struct _cups_globals_s /**** CUPS global state data ****/ { /* Multiple places... */ const char *cups_datadir, /* CUPS_DATADIR environment var */ *cups_serverbin,/* CUPS_SERVERBIN environment var */ *cups_serverroot, /* CUPS_SERVERROOT environment var */ *cups_statedir, /* CUPS_STATEDIR environment var */ *localedir; /* LOCALDIR environment var */ /* adminutil.c */ time_t cupsd_update; /* Last time we got or set cupsd.conf */ char cupsd_hostname[HTTP_MAX_HOST]; /* Hostname for connection */ int cupsd_num_settings; /* Number of server settings */ cups_option_t *cupsd_settings;/* Server settings */ /* auth.c */ # ifdef HAVE_GSSAPI char gss_service_name[32]; /* Kerberos service name */ # endif /* HAVE_GSSAPI */ /* backend.c */ char resolved_uri[1024]; /* Buffer for cupsBackendDeviceURI */ /* debug.c */ # ifdef DEBUG int thread_id; /* Friendly thread ID */ # endif /* DEBUG */ /* file.c */ cups_file_t *stdio_files[3];/* stdin, stdout, stderr */ /* http.c */ char http_date[256]; /* Date+time buffer */ /* http-addr.c */ unsigned ip_addr; /* Packed IPv4 address */ char *ip_ptrs[2]; /* Pointer to packed address */ struct hostent hostent; /* Host entry for IP address */ # ifdef HAVE_GETADDRINFO char hostname[1024]; /* Hostname */ # endif /* HAVE_GETADDRINFO */ int need_res_init; /* Need to reinitialize resolver? */ /* ipp.c */ ipp_uchar_t ipp_date[11]; /* RFC-2579 date/time data */ _cups_buffer_t *cups_buffers; /* Buffer list */ /* ipp-support.c */ int ipp_port; /* IPP port number */ char ipp_unknown[255]; /* Unknown error statuses */ /* language.c */ cups_lang_t *lang_default; /* Default language */ # ifdef __APPLE__ char language[32]; /* Cached language */ # endif /* __APPLE__ */ /* pwg-media.c */ cups_array_t *leg_size_lut, /* Lookup table for legacy names */ *ppd_size_lut, /* Lookup table for PPD names */ *pwg_size_lut; /* Lookup table for PWG names */ pwg_media_t pwg_media; /* PWG media data for custom size */ char pwg_name[65], /* PWG media name for custom size */ ppd_name[41]; /* PPD media name for custom size */ /* request.c */ http_t *http; /* Current server connection */ ipp_status_t last_error; /* Last IPP error */ char *last_status_message; /* Last IPP status-message */ /* snmp.c */ char snmp_community[255]; /* Default SNMP community name */ int snmp_debug; /* Log SNMP IO to stderr? */ /* tempfile.c */ char tempfile[1024]; /* cupsTempFd/File buffer */ /* usersys.c */ http_encryption_t encryption; /* Encryption setting */ char user[65], /* User name */ user_agent[256],/* User-Agent string */ server[256], /* Server address */ servername[256],/* Server hostname */ password[128]; /* Password for default callback */ cups_password_cb2_t password_cb; /* Password callback */ void *password_data; /* Password user data */ http_tls_credentials_t tls_credentials; /* Default client credentials */ cups_client_cert_cb_t client_cert_cb; /* Client certificate callback */ void *client_cert_data; /* Client certificate user data */ cups_server_cert_cb_t server_cert_cb; /* Server certificate callback */ void *server_cert_data; /* Server certificate user data */ int server_version, /* Server IPP version */ trust_first, /* Trust on first use? */ any_root, /* Allow any (e.g., self-signed) root */ expired_certs, /* Allow expired certs */ validate_certs; /* Validate certificates */ /* util.c */ char def_printer[256]; /* Default printer */ } _cups_globals_t; typedef struct _cups_media_db_s /* Media database */ { char *color, /* Media color, if any */ *key, /* Media key, if any */ *info, /* Media human-readable name, if any */ *size_name, /* Media PWG size name, if provided */ *source, /* Media source, if any */ *type; /* Media type, if any */ int width, /* Width in hundredths of millimeters */ length, /* Length in hundredths of * millimeters */ bottom, /* Bottom margin in hundredths of * millimeters */ left, /* Left margin in hundredths of * millimeters */ right, /* Right margin in hundredths of * millimeters */ top; /* Top margin in hundredths of * millimeters */ } _cups_media_db_t; typedef struct _cups_dconstres_s /* Constraint/resolver */ { char *name; /* Name of resolver */ ipp_t *collection; /* Collection containing attrs */ } _cups_dconstres_t; struct _cups_dinfo_s /* Destination capability and status * information */ { int version; /* IPP version */ const char *uri; /* Printer URI */ char *resource; /* Resource path */ ipp_t *attrs; /* Printer attributes */ int num_defaults; /* Number of default options */ cups_option_t *defaults; /* Default options */ cups_array_t *constraints; /* Job constraints */ cups_array_t *resolvers; /* Job resolvers */ cups_array_t *localizations; /* Localization information */ cups_array_t *media_db; /* Media database */ _cups_media_db_t min_size, /* Minimum size */ max_size; /* Maximum size */ unsigned cached_flags; /* Flags used for cached media */ cups_array_t *cached_db; /* Cache of media from last index/default */ time_t ready_time; /* When xxx-ready attributes were last queried */ ipp_t *ready_attrs; /* xxx-ready attributes */ cups_array_t *ready_db; /* media[-col]-ready media database */ }; /* * Prototypes... */ # ifdef __APPLE__ extern CFStringRef _cupsAppleCopyDefaultPaperID(void); extern CFStringRef _cupsAppleCopyDefaultPrinter(void); extern int _cupsAppleGetUseLastPrinter(void); extern void _cupsAppleSetDefaultPaperID(CFStringRef name); extern void _cupsAppleSetDefaultPrinter(CFStringRef name); extern void _cupsAppleSetUseLastPrinter(int uselast); # endif /* __APPLE__ */ extern char *_cupsBufferGet(size_t size); extern void _cupsBufferRelease(char *b); extern http_t *_cupsConnect(void); extern char *_cupsCreateDest(const char *name, const char *info, const char *device_id, const char *device_uri, char *uri, size_t urisize); extern int _cupsGet1284Values(const char *device_id, cups_option_t **values); extern const char *_cupsGetDestResource(cups_dest_t *dest, char *resource, size_t resourcesize); 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); extern const char *_cupsGetPassword(const char *prompt); extern void _cupsGlobalLock(void); extern _cups_globals_t *_cupsGlobals(void); extern void _cupsGlobalUnlock(void); # ifdef HAVE_GSSAPI extern const char *_cupsGSSServiceName(void); # endif /* HAVE_GSSAPI */ extern int _cupsNextDelay(int current, int *previous); extern void _cupsSetDefaults(void); extern void _cupsSetError(ipp_status_t status, const char *message, int localize); extern void _cupsSetHTTPError(http_status_t status); # ifdef HAVE_GSSAPI extern int _cupsSetNegotiateAuthString(http_t *http, const char *method, const char *resource); # endif /* HAVE_GSSAPI */ extern char *_cupsUserDefault(char *name, size_t namesize); /* * C++ magic... */ # ifdef __cplusplus } # endif /* __cplusplus */ #endif /* !_CUPS_CUPS_PRIVATE_H_ */