/* * Printer definitions for the CUPS scheduler. * * Copyright © 2021-2022 by OpenPrinting. * Copyright @ 2007-2017 by Apple Inc. * Copyright @ 1997-2007 by Easy Software Products, all rights reserved. * * Licensed under Apache License v2.0. See the file "LICENSE" for more information. */ #ifdef HAVE_MDNSRESPONDER # include #elif defined(HAVE_AVAHI) # include # include # include # include #endif /* HAVE_MDNSRESPONDER */ #include /* * Quota data... */ typedef struct { char username[33]; /* User data */ time_t next_update; /* Next update time */ int page_count, /* Count of pages */ k_count; /* Count of kilobytes */ } cupsd_quota_t; /* * DNS-SD types to make the code cleaner/clearer... */ #ifdef HAVE_MDNSRESPONDER typedef DNSServiceRef cupsd_srv_t; /* Service reference */ typedef TXTRecordRef cupsd_txt_t; /* TXT record */ #elif defined(HAVE_AVAHI) typedef AvahiEntryGroup *cupsd_srv_t; /* Service reference */ typedef AvahiStringList *cupsd_txt_t; /* TXT record */ #endif /* HAVE_MDNSRESPONDER */ /* * Printer/class information structure... */ typedef struct cupsd_job_s cupsd_job_t; struct cupsd_printer_s { _cups_rwlock_t lock; /* Concurrency lock for background updates */ int printer_id; /* Printer ID */ char *uri, /* Printer URI */ *uuid, /* Printer UUID */ *hostname, /* Host printer resides on */ *name, /* Printer name */ *location, /* Location string */ *geo_location, /* Geographic location URI */ *make_model, /* Make and model */ *info, /* Description */ *organization, /* Organization name */ *organizational_unit, /* Organizational unit (department, etc.) */ *strings, /* Strings file, if any */ *op_policy, /* Operation policy name */ *error_policy; /* Error policy */ cupsd_policy_t *op_policy_ptr; /* Pointer to operation policy */ int shared; /* Shared? */ int temporary; /* Temporary queue? */ int accepting; /* Accepting jobs? */ int holding_new_jobs; /* Holding new jobs for printing? */ int in_implicit_class; /* In an implicit class? */ ipp_pstate_t state; /* Printer state */ char state_message[1024]; /* Printer state message */ int num_reasons; /* Number of printer-state-reasons */ char *reasons[64]; /* printer-state-reasons strings */ time_t config_time, /* Time at this configuration */ state_time; /* Time at this state */ char *job_sheets[2]; /* Banners/job sheets */ cups_ptype_t type; /* Printer type (color, small, etc.) */ char *device_uri; /* Device URI */ char *sanitized_device_uri; /* Sanitized device URI */ char *port_monitor; /* Port monitor */ int raw; /* Raw queue? */ int remote; /* Remote queue? */ mime_type_t *filetype, /* Pseudo-filetype for printer */ *prefiltertype; /* Pseudo-filetype for pre-filters */ cups_array_t *filetypes, /* Supported file types */ *dest_types; /* Destination types for queue */ cupsd_job_t *job; /* Current job in queue */ ipp_t *attrs, /* Attributes supported by this printer */ *ppd_attrs; /* Attributes based on the PPD */ int num_printers, /* Number of printers in class */ last_printer; /* Last printer job was sent to */ struct cupsd_printer_s **printers; /* Printers in class */ int quota_period, /* Period for quotas */ page_limit, /* Maximum number of pages */ k_limit; /* Maximum number of kilobytes */ cups_array_t *quotas; /* Quota records */ int deny_users; /* 1 = deny, 0 = allow */ cups_array_t *users; /* Allowed/denied users */ int sequence_number; /* Increasing sequence number */ int num_options; /* Number of default options */ cups_option_t *options; /* Default options */ int num_auth_info_required; /* Number of required auth fields */ const char *auth_info_required[4]; /* Required authentication fields */ char *alert, /* PSX printer-alert value */ *alert_description; /* PSX printer-alert-description value */ time_t marker_time; /* Last time marker attributes were updated */ _ppd_cache_t *pc; /* PPD cache and mapping data */ #ifdef HAVE_DNSSD char *reg_name, /* Name used for service registration */ *pdl; /* pdl value for TXT record */ cupsd_srv_t ipp_srv; /* IPP service(s) */ # ifdef HAVE_MDNSRESPONDER # ifdef HAVE_TLS cupsd_srv_t ipps_srv; /* IPPS service(s) */ # endif /* HAVE_TLS */ cupsd_srv_t printer_srv; /* LPD service */ # endif /* HAVE_MDNSRESPONDER */ #endif /* HAVE_DNSSD */ }; /* * Globals... */ VAR ipp_t *CommonData VALUE(NULL); /* Common printer object attrs */ VAR cups_array_t *CommonDefaults VALUE(NULL); /* Common -default option names */ VAR int NextPrinterId VALUE(1); /* Next printer-id value */ VAR cups_array_t *Printers VALUE(NULL); /* Printer list */ VAR cupsd_printer_t *DefaultPrinter VALUE(NULL); /* Default printer */ VAR char *DefaultPolicy VALUE(NULL); /* Default policy name */ VAR cupsd_policy_t *DefaultPolicyPtr VALUE(NULL); /* Pointer to default policy */ /* * Prototypes... */ extern cupsd_printer_t *cupsdAddPrinter(const char *name); extern void cupsdCreateCommonData(void); extern void cupsdDeleteAllPrinters(void); extern int cupsdDeletePrinter(cupsd_printer_t *p, int update); extern void cupsdDeleteTemporaryPrinters(int force); extern cupsd_printer_t *cupsdFindDest(const char *name); extern cupsd_printer_t *cupsdFindPrinter(const char *name); extern cupsd_quota_t *cupsdFindQuota(cupsd_printer_t *p, const char *username); extern void cupsdFreeQuotas(cupsd_printer_t *p); extern void cupsdLoadAllPrinters(void); extern void cupsdRenamePrinter(cupsd_printer_t *p, const char *name); extern void cupsdSaveAllPrinters(void); extern int cupsdSetAuthInfoRequired(cupsd_printer_t *p, const char *values, ipp_attribute_t *attr); extern void cupsdSetDeviceURI(cupsd_printer_t *p, const char *uri); extern void cupsdSetPrinterAttr(cupsd_printer_t *p, const char *name, const char *value); extern void cupsdSetPrinterAttrs(cupsd_printer_t *p); extern int cupsdSetPrinterReasons(cupsd_printer_t *p, const char *s); extern void cupsdSetPrinterState(cupsd_printer_t *p, ipp_pstate_t s, int update); #define cupsdStartPrinter(p,u) cupsdSetPrinterState((p), \ IPP_PRINTER_IDLE, (u)) extern void cupsdStopPrinter(cupsd_printer_t *p, int update); extern int cupsdUpdatePrinterPPD(cupsd_printer_t *p, int num_keywords, cups_option_t *keywords); extern void cupsdUpdatePrinters(void); extern cupsd_quota_t *cupsdUpdateQuota(cupsd_printer_t *p, const char *username, int pages, int k); extern const char *cupsdValidateDest(const char *uri, cups_ptype_t *dtype, cupsd_printer_t **printer); extern void cupsdWritePrintcap(void);