2 * PPD file routines for CUPS.
4 * Copyright © 2007-2019 by Apple Inc.
5 * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
10 * PostScript is a trademark of Adobe Systems, Inc.
14 * Include necessary headers.
17 #include "cups-private.h"
18 #include "ppd-private.h"
19 #include "debug-internal.h"
26 #define PPD_KEYWORD 1 /* Line contained a keyword */
27 #define PPD_OPTION 2 /* Line contained an option name */
28 #define PPD_TEXT 4 /* Line contained human-readable text */
29 #define PPD_STRING 8 /* Line contained a string or code */
31 #define PPD_HASHSIZE 512 /* Size of hash */
35 * Line buffer structure...
38 typedef struct _ppd_line_s
40 char *buffer
; /* Pointer to buffer */
41 size_t bufsize
; /* Size of the buffer */
49 static _cups_threadkey_t ppd_globals_key
= _CUPS_THREADKEY_INITIALIZER
;
50 /* Thread local storage key */
52 static pthread_once_t ppd_globals_key_once
= PTHREAD_ONCE_INIT
;
53 /* One-time initialization object */
54 #endif /* HAVE_PTHREAD_H */
61 static ppd_attr_t
*ppd_add_attr(ppd_file_t
*ppd
, const char *name
,
62 const char *spec
, const char *text
,
64 static ppd_choice_t
*ppd_add_choice(ppd_option_t
*option
, const char *name
);
65 static ppd_size_t
*ppd_add_size(ppd_file_t
*ppd
, const char *name
);
66 static int ppd_compare_attrs(ppd_attr_t
*a
, ppd_attr_t
*b
);
67 static int ppd_compare_choices(ppd_choice_t
*a
, ppd_choice_t
*b
);
68 static int ppd_compare_coptions(ppd_coption_t
*a
,
70 static int ppd_compare_options(ppd_option_t
*a
, ppd_option_t
*b
);
71 static int ppd_decode(char *string
);
72 static void ppd_free_filters(ppd_file_t
*ppd
);
73 static void ppd_free_group(ppd_group_t
*group
);
74 static void ppd_free_option(ppd_option_t
*option
);
75 static ppd_coption_t
*ppd_get_coption(ppd_file_t
*ppd
, const char *name
);
76 static ppd_cparam_t
*ppd_get_cparam(ppd_coption_t
*opt
,
79 static ppd_group_t
*ppd_get_group(ppd_file_t
*ppd
, const char *name
,
80 const char *text
, _ppd_globals_t
*pg
,
81 cups_encoding_t encoding
);
82 static ppd_option_t
*ppd_get_option(ppd_group_t
*group
, const char *name
);
83 static _ppd_globals_t
*ppd_globals_alloc(void);
84 #if defined(HAVE_PTHREAD_H) || defined(_WIN32)
85 static void ppd_globals_free(_ppd_globals_t
*g
);
86 #endif /* HAVE_PTHREAD_H || _WIN32 */
88 static void ppd_globals_init(void);
89 #endif /* HAVE_PTHREAD_H */
90 static int ppd_hash_option(ppd_option_t
*option
);
91 static int ppd_read(cups_file_t
*fp
, _ppd_line_t
*line
,
92 char *keyword
, char *option
, char *text
,
93 char **string
, int ignoreblank
,
95 static int ppd_update_filters(ppd_file_t
*ppd
,
100 * 'ppdClose()' - Free all memory used by the PPD file.
104 ppdClose(ppd_file_t
*ppd
) /* I - PPD file record */
106 int i
; /* Looping var */
107 ppd_group_t
*group
; /* Current group */
108 char **font
; /* Current font */
109 ppd_attr_t
**attr
; /* Current attribute */
110 ppd_coption_t
*coption
; /* Current custom option */
111 ppd_cparam_t
*cparam
; /* Current custom parameter */
115 * Range check arguments...
122 * Free all strings at the top level...
125 free(ppd
->lang_encoding
);
128 free(ppd
->jcl_begin
);
133 * Free any UI groups, subgroups, and options...
136 if (ppd
->num_groups
> 0)
138 for (i
= ppd
->num_groups
, group
= ppd
->groups
; i
> 0; i
--, group
++)
139 ppd_free_group(group
);
144 cupsArrayDelete(ppd
->options
);
145 cupsArrayDelete(ppd
->marked
);
148 * Free any page sizes...
151 if (ppd
->num_sizes
> 0)
155 * Free any constraints...
158 if (ppd
->num_consts
> 0)
162 * Free any filters...
165 ppd_free_filters(ppd
);
171 if (ppd
->num_fonts
> 0)
173 for (i
= ppd
->num_fonts
, font
= ppd
->fonts
; i
> 0; i
--, font
++)
180 * Free any profiles...
183 if (ppd
->num_profiles
> 0)
187 * Free any attributes...
190 if (ppd
->num_attrs
> 0)
192 for (i
= ppd
->num_attrs
, attr
= ppd
->attrs
; i
> 0; i
--, attr
++)
194 free((*attr
)->value
);
201 cupsArrayDelete(ppd
->sorted_attrs
);
204 * Free custom options...
207 for (coption
= (ppd_coption_t
*)cupsArrayFirst(ppd
->coptions
);
209 coption
= (ppd_coption_t
*)cupsArrayNext(ppd
->coptions
))
211 for (cparam
= (ppd_cparam_t
*)cupsArrayFirst(coption
->params
);
213 cparam
= (ppd_cparam_t
*)cupsArrayNext(coption
->params
))
215 switch (cparam
->type
)
217 case PPD_CUSTOM_PASSCODE
:
218 case PPD_CUSTOM_PASSWORD
:
219 case PPD_CUSTOM_STRING
:
220 free(cparam
->current
.custom_string
);
230 cupsArrayDelete(coption
->params
);
235 cupsArrayDelete(ppd
->coptions
);
238 * Free constraints...
241 if (ppd
->cups_uiconstraints
)
243 _ppd_cups_uiconsts_t
*consts
; /* Current constraints */
246 for (consts
= (_ppd_cups_uiconsts_t
*)cupsArrayFirst(ppd
->cups_uiconstraints
);
248 consts
= (_ppd_cups_uiconsts_t
*)cupsArrayNext(ppd
->cups_uiconstraints
))
250 free(consts
->constraints
);
254 cupsArrayDelete(ppd
->cups_uiconstraints
);
258 * Free any PPD cache/mapping data...
262 _ppdCacheDestroy(ppd
->cache
);
265 * Free the whole record...
273 * 'ppdErrorString()' - Returns the text associated with a status.
275 * @since CUPS 1.1.19/macOS 10.3@
278 const char * /* O - Status string */
279 ppdErrorString(ppd_status_t status
) /* I - PPD status */
281 static const char * const messages
[] =/* Status messages */
284 _("Unable to open PPD file"),
285 _("NULL PPD file pointer"),
286 _("Memory allocation error"),
287 _("Missing PPD-Adobe-4.x header"),
288 _("Missing value string"),
291 _("OpenGroup without a CloseGroup first"),
292 _("Bad OpenUI/JCLOpenUI"),
293 _("OpenUI/JCLOpenUI without a CloseUI/JCLCloseUI first"),
294 _("Bad OrderDependency"),
295 _("Bad UIConstraints"),
296 _("Missing asterisk in column 1"),
297 _("Line longer than the maximum allowed (255 characters)"),
298 _("Illegal control character"),
299 _("Illegal main keyword string"),
300 _("Illegal option keyword string"),
301 _("Illegal translation string"),
302 _("Illegal whitespace character"),
303 _("Bad custom parameter"),
304 _("Missing option keyword"),
305 _("Bad value string"),
306 _("Missing CloseGroup"),
307 _("Bad CloseUI/JCLCloseUI"),
308 _("Missing CloseUI/JCLCloseUI")
312 if (status
< PPD_OK
|| status
>= PPD_MAX_STATUS
)
313 return (_cupsLangString(cupsLangDefault(), _("Unknown")));
315 return (_cupsLangString(cupsLangDefault(), messages
[status
]));
320 * '_ppdGetEncoding()' - Get the CUPS encoding value for the given
324 cups_encoding_t
/* O - CUPS encoding value */
325 _ppdGetEncoding(const char *name
) /* I - LanguageEncoding string */
327 if (!_cups_strcasecmp(name
, "ISOLatin1"))
328 return (CUPS_ISO8859_1
);
329 else if (!_cups_strcasecmp(name
, "ISOLatin2"))
330 return (CUPS_ISO8859_2
);
331 else if (!_cups_strcasecmp(name
, "ISOLatin5"))
332 return (CUPS_ISO8859_5
);
333 else if (!_cups_strcasecmp(name
, "JIS83-RKSJ"))
334 return (CUPS_JIS_X0213
);
335 else if (!_cups_strcasecmp(name
, "MacStandard"))
336 return (CUPS_MAC_ROMAN
);
337 else if (!_cups_strcasecmp(name
, "WindowsANSI"))
338 return (CUPS_WINDOWS_1252
);
345 * '_ppdGlobals()' - Return a pointer to thread local storage
348 _ppd_globals_t
* /* O - Pointer to global data */
351 _ppd_globals_t
*pg
; /* Pointer to global data */
354 #ifdef HAVE_PTHREAD_H
356 * Initialize the global data exactly once...
359 pthread_once(&ppd_globals_key_once
, ppd_globals_init
);
360 #endif /* HAVE_PTHREAD_H */
363 * See if we have allocated the data yet...
366 if ((pg
= (_ppd_globals_t
*)_cupsThreadGetData(ppd_globals_key
)) == NULL
)
369 * No, allocate memory as set the pointer for the key...
372 if ((pg
= ppd_globals_alloc()) != NULL
)
373 _cupsThreadSetData(ppd_globals_key
, pg
);
377 * Return the pointer to the data...
385 * 'ppdLastError()' - Return the status from the last ppdOpen*().
387 * @since CUPS 1.1.19/macOS 10.3@
390 ppd_status_t
/* O - Status code */
391 ppdLastError(int *line
) /* O - Line number */
393 _ppd_globals_t
*pg
= _ppdGlobals();
398 *line
= pg
->ppd_line
;
400 return (pg
->ppd_status
);
405 * '_ppdOpen()' - Read a PPD file into memory.
407 * @since CUPS 1.2/macOS 10.5@
410 ppd_file_t
* /* O - PPD file record or @code NULL@ if the PPD file could not be opened. */
412 cups_file_t
*fp
, /* I - File to read from */
413 _ppd_localization_t localization
) /* I - Localization to load */
415 int i
, j
, k
; /* Looping vars */
416 _ppd_line_t line
; /* Line buffer */
417 ppd_file_t
*ppd
; /* PPD file record */
418 ppd_group_t
*group
, /* Current group */
419 *subgroup
; /* Current sub-group */
420 ppd_option_t
*option
; /* Current option */
421 ppd_choice_t
*choice
; /* Current choice */
422 ppd_const_t
*constraint
; /* Current constraint */
423 ppd_size_t
*size
; /* Current page size */
424 int mask
; /* Line data mask */
425 char keyword
[PPD_MAX_NAME
],
426 /* Keyword from file */
428 /* Option from file */
430 /* Human-readable text from file */
431 *string
, /* Code/text from file */
432 *sptr
, /* Pointer into string */
433 *temp
, /* Temporary string pointer */
434 **tempfonts
; /* Temporary fonts pointer */
435 float order
; /* Order dependency number */
436 ppd_section_t section
; /* Order dependency section */
437 ppd_profile_t
*profile
; /* Pointer to color profile */
438 char **filter
; /* Pointer to filter */
439 struct lconv
*loc
; /* Locale data */
440 int ui_keyword
; /* Is this line a UI keyword? */
441 cups_lang_t
*lang
; /* Language data */
442 cups_encoding_t encoding
; /* Encoding of PPD file */
443 _ppd_globals_t
*pg
= _ppdGlobals();
445 char custom_name
[PPD_MAX_NAME
];
446 /* CustomFoo attribute name */
447 ppd_attr_t
*custom_attr
; /* CustomFoo attribute */
448 char ll
[7], /* Base language + '.' */
449 ll_CC
[7]; /* Language w/country + '.' */
450 size_t ll_len
= 0, /* Base language length */
451 ll_CC_len
= 0; /* Language w/country length */
452 static const char * const ui_keywords
[] =
454 #ifdef CUPS_USE_FULL_UI_KEYWORDS_LIST
456 * Adobe defines some 41 keywords as "UI", meaning that they are
457 * user interface elements and that they should be treated as such
458 * even if the PPD creator doesn't use Open/CloseUI around them.
460 * Since this can cause previously invisible options to appear and
461 * confuse users, the default is to only treat the PageSize and
462 * PageRegion keywords this way.
464 /* Boolean keywords */
474 /* PickOne keywords */
487 "JCLFrameBufferSize",
508 #else /* !CUPS_USE_FULL_UI_KEYWORDS_LIST */
511 #endif /* CUPS_USE_FULL_UI_KEYWORDS_LIST */
513 static const char * const color_keywords
[] = /* Keywords associated with color profiles */
520 DEBUG_printf(("_ppdOpen(fp=%p)", fp
));
523 * Default to "OK" status...
526 pg
->ppd_status
= PPD_OK
;
530 * Range check input...
535 pg
->ppd_status
= PPD_NULL_FILE
;
540 * If only loading a single localization set up the strings to match...
543 if (localization
== _PPD_LOCALIZATION_DEFAULT
)
545 if ((lang
= cupsLangDefault()) == NULL
)
548 snprintf(ll_CC
, sizeof(ll_CC
), "%s.", lang
->language
);
551 * <rdar://problem/22130168>
552 * <rdar://problem/27245567>
554 * Need to use a different base language for some locales...
557 if (!strcmp(lang
->language
, "zh_HK"))
558 { /* Traditional Chinese + variants */
559 strlcpy(ll_CC
, "zh_TW.", sizeof(ll_CC
));
560 strlcpy(ll
, "zh_", sizeof(ll
));
562 else if (!strncmp(lang
->language
, "zh", 2))
563 strlcpy(ll
, "zh_", sizeof(ll
)); /* Any Chinese variant */
564 else if (!strncmp(lang
->language
, "jp", 2))
565 { /* Any Japanese variant */
566 strlcpy(ll_CC
, "ja", sizeof(ll_CC
));
567 strlcpy(ll
, "jp", sizeof(ll
));
569 else if (!strncmp(lang
->language
, "nb", 2) || !strncmp(lang
->language
, "no", 2))
570 { /* Any Norwegian variant */
571 strlcpy(ll_CC
, "nb", sizeof(ll_CC
));
572 strlcpy(ll
, "no", sizeof(ll
));
575 snprintf(ll
, sizeof(ll
), "%2.2s.", lang
->language
);
577 ll_CC_len
= strlen(ll_CC
);
580 DEBUG_printf(("2_ppdOpen: Loading localizations matching \"%s\" and \"%s\"",
585 * Grab the first line and make sure it reads '*PPD-Adobe: "major.minor"'...
591 mask
= ppd_read(fp
, &line
, keyword
, name
, text
, &string
, 0, pg
);
593 DEBUG_printf(("2_ppdOpen: mask=%x, keyword=\"%s\"...", mask
, keyword
));
596 strcmp(keyword
, "PPD-Adobe") ||
597 string
== NULL
|| string
[0] != '4')
600 * Either this is not a PPD file, or it is not a 4.x PPD file.
603 if (pg
->ppd_status
== PPD_OK
)
604 pg
->ppd_status
= PPD_MISSING_PPDADOBE4
;
612 DEBUG_printf(("2_ppdOpen: keyword=%s, string=%p", keyword
, string
));
615 * Allocate memory for the PPD file record...
618 if ((ppd
= calloc(1, sizeof(ppd_file_t
))) == NULL
)
620 pg
->ppd_status
= PPD_ALLOC_ERROR
;
631 ppd
->language_level
= 2;
632 ppd
->color_device
= 0;
633 ppd
->colorspace
= PPD_CS_N
;
634 ppd
->landscape
= -90;
635 ppd
->coptions
= cupsArrayNew((cups_array_func_t
)ppd_compare_coptions
, NULL
);
638 * Read lines from the PPD file and add them to the file record...
646 encoding
= CUPS_ISO8859_1
;
649 while ((mask
= ppd_read(fp
, &line
, keyword
, name
, text
, &string
, 1, pg
)) != 0)
651 DEBUG_printf(("2_ppdOpen: mask=%x, keyword=\"%s\", name=\"%s\", "
652 "text=\"%s\", string=%d chars...", mask
, keyword
, name
, text
,
653 string
? (int)strlen(string
) : 0));
655 if (strncmp(keyword
, "Default", 7) && !string
&&
656 pg
->ppd_conform
!= PPD_CONFORM_RELAXED
)
659 * Need a string value!
662 pg
->ppd_status
= PPD_MISSING_VALUE
;
670 * Certain main keywords (as defined by the PPD spec) may be used
671 * without the usual OpenUI/CloseUI stuff. Presumably this is just
672 * so that Adobe wouldn't completely break compatibility with PPD
673 * files prior to v4.0 of the spec, but it is hopelessly
674 * inconsistent... Catch these main keywords and automatically
675 * create the corresponding option, as needed...
681 * Previous line was a UI keyword...
689 * If we are filtering out keyword localizations, see if this line needs to
693 if (localization
!= _PPD_LOCALIZATION_ALL
&&
694 (temp
= strchr(keyword
, '.')) != NULL
&&
695 ((temp
- keyword
) == 2 || (temp
- keyword
) == 5) &&
696 _cups_isalpha(keyword
[0]) &&
697 _cups_isalpha(keyword
[1]) &&
698 (keyword
[2] == '.' ||
699 (keyword
[2] == '_' && _cups_isalpha(keyword
[3]) &&
700 _cups_isalpha(keyword
[4]) && keyword
[5] == '.')))
702 if (localization
== _PPD_LOCALIZATION_NONE
||
703 (localization
== _PPD_LOCALIZATION_DEFAULT
&&
704 strncmp(ll_CC
, keyword
, ll_CC_len
) &&
705 strncmp(ll
, keyword
, ll_len
)))
707 DEBUG_printf(("2_ppdOpen: Ignoring localization: \"%s\"\n", keyword
));
710 else if (localization
== _PPD_LOCALIZATION_ICC_PROFILES
)
713 * Only load localizations for the color profile related keywords...
717 i
< (int)(sizeof(color_keywords
) / sizeof(color_keywords
[0]));
720 if (!_cups_strcasecmp(temp
, color_keywords
[i
]))
724 if (i
>= (int)(sizeof(color_keywords
) / sizeof(color_keywords
[0])))
726 DEBUG_printf(("2_ppdOpen: Ignoring localization: \"%s\"\n", keyword
));
732 if (option
== NULL
&&
733 (mask
& (PPD_KEYWORD
| PPD_OPTION
| PPD_STRING
)) ==
734 (PPD_KEYWORD
| PPD_OPTION
| PPD_STRING
))
736 for (i
= 0; i
< (int)(sizeof(ui_keywords
) / sizeof(ui_keywords
[0])); i
++)
737 if (!strcmp(keyword
, ui_keywords
[i
]))
740 if (i
< (int)(sizeof(ui_keywords
) / sizeof(ui_keywords
[0])))
743 * Create the option in the appropriate group...
748 DEBUG_printf(("2_ppdOpen: FOUND ADOBE UI KEYWORD %s WITHOUT OPENUI!",
753 if ((group
= ppd_get_group(ppd
, "General", _("General"), pg
,
757 DEBUG_printf(("2_ppdOpen: Adding to group %s...", group
->text
));
758 option
= ppd_get_option(group
, keyword
);
762 option
= ppd_get_option(group
, keyword
);
766 pg
->ppd_status
= PPD_ALLOC_ERROR
;
772 * Now fill in the initial information for the option...
775 if (!strncmp(keyword
, "JCL", 3))
776 option
->section
= PPD_ORDER_JCL
;
778 option
->section
= PPD_ORDER_ANY
;
780 option
->order
= 10.0f
;
783 option
->ui
= PPD_UI_BOOLEAN
;
785 option
->ui
= PPD_UI_PICKONE
;
787 for (j
= 0; j
< ppd
->num_attrs
; j
++)
788 if (!strncmp(ppd
->attrs
[j
]->name
, "Default", 7) &&
789 !strcmp(ppd
->attrs
[j
]->name
+ 7, keyword
) &&
790 ppd
->attrs
[j
]->value
)
792 DEBUG_printf(("2_ppdOpen: Setting Default%s to %s via attribute...",
793 option
->keyword
, ppd
->attrs
[j
]->value
));
794 strlcpy(option
->defchoice
, ppd
->attrs
[j
]->value
,
795 sizeof(option
->defchoice
));
799 if (!strcmp(keyword
, "PageSize"))
800 strlcpy(option
->text
, _("Media Size"), sizeof(option
->text
));
801 else if (!strcmp(keyword
, "MediaType"))
802 strlcpy(option
->text
, _("Media Type"), sizeof(option
->text
));
803 else if (!strcmp(keyword
, "InputSlot"))
804 strlcpy(option
->text
, _("Media Source"), sizeof(option
->text
));
805 else if (!strcmp(keyword
, "ColorModel"))
806 strlcpy(option
->text
, _("Output Mode"), sizeof(option
->text
));
807 else if (!strcmp(keyword
, "Resolution"))
808 strlcpy(option
->text
, _("Resolution"), sizeof(option
->text
));
810 strlcpy(option
->text
, keyword
, sizeof(option
->text
));
814 if (!strcmp(keyword
, "LanguageLevel"))
815 ppd
->language_level
= atoi(string
);
816 else if (!strcmp(keyword
, "LanguageEncoding"))
819 * Say all PPD files are UTF-8, since we convert to UTF-8...
822 ppd
->lang_encoding
= strdup("UTF-8");
823 encoding
= _ppdGetEncoding(string
);
825 else if (!strcmp(keyword
, "LanguageVersion"))
826 ppd
->lang_version
= string
;
827 else if (!strcmp(keyword
, "Manufacturer"))
828 ppd
->manufacturer
= string
;
829 else if (!strcmp(keyword
, "ModelName"))
830 ppd
->modelname
= string
;
831 else if (!strcmp(keyword
, "Protocols"))
832 ppd
->protocols
= string
;
833 else if (!strcmp(keyword
, "PCFileName"))
834 ppd
->pcfilename
= string
;
835 else if (!strcmp(keyword
, "NickName"))
837 if (encoding
!= CUPS_UTF8
)
839 cups_utf8_t utf8
[256]; /* UTF-8 version of NickName */
842 cupsCharsetToUTF8(utf8
, string
, sizeof(utf8
), encoding
);
843 ppd
->nickname
= strdup((char *)utf8
);
846 ppd
->nickname
= strdup(string
);
848 else if (!strcmp(keyword
, "Product"))
849 ppd
->product
= string
;
850 else if (!strcmp(keyword
, "ShortNickName"))
851 ppd
->shortnickname
= string
;
852 else if (!strcmp(keyword
, "TTRasterizer"))
853 ppd
->ttrasterizer
= string
;
854 else if (!strcmp(keyword
, "JCLBegin"))
856 ppd
->jcl_begin
= strdup(string
);
857 ppd_decode(ppd
->jcl_begin
); /* Decode quoted string */
859 else if (!strcmp(keyword
, "JCLEnd"))
861 ppd
->jcl_end
= strdup(string
);
862 ppd_decode(ppd
->jcl_end
); /* Decode quoted string */
864 else if (!strcmp(keyword
, "JCLToPSInterpreter"))
866 ppd
->jcl_ps
= strdup(string
);
867 ppd_decode(ppd
->jcl_ps
); /* Decode quoted string */
869 else if (!strcmp(keyword
, "AccurateScreensSupport"))
870 ppd
->accurate_screens
= !strcmp(string
, "True");
871 else if (!strcmp(keyword
, "ColorDevice"))
872 ppd
->color_device
= !strcmp(string
, "True");
873 else if (!strcmp(keyword
, "ContoneOnly"))
874 ppd
->contone_only
= !strcmp(string
, "True");
875 else if (!strcmp(keyword
, "cupsFlipDuplex"))
876 ppd
->flip_duplex
= !strcmp(string
, "True");
877 else if (!strcmp(keyword
, "cupsManualCopies"))
878 ppd
->manual_copies
= !strcmp(string
, "True");
879 else if (!strcmp(keyword
, "cupsModelNumber"))
880 ppd
->model_number
= atoi(string
);
881 else if (!strcmp(keyword
, "cupsColorProfile"))
883 if (ppd
->num_profiles
== 0)
884 profile
= malloc(sizeof(ppd_profile_t
));
886 profile
= realloc(ppd
->profiles
, sizeof(ppd_profile_t
) * (size_t)(ppd
->num_profiles
+ 1));
890 pg
->ppd_status
= PPD_ALLOC_ERROR
;
895 ppd
->profiles
= profile
;
896 profile
+= ppd
->num_profiles
;
897 ppd
->num_profiles
++;
899 memset(profile
, 0, sizeof(ppd_profile_t
));
900 strlcpy(profile
->resolution
, name
, sizeof(profile
->resolution
));
901 strlcpy(profile
->media_type
, text
, sizeof(profile
->media_type
));
903 profile
->density
= (float)_cupsStrScand(string
, &sptr
, loc
);
904 profile
->gamma
= (float)_cupsStrScand(sptr
, &sptr
, loc
);
905 profile
->matrix
[0][0] = (float)_cupsStrScand(sptr
, &sptr
, loc
);
906 profile
->matrix
[0][1] = (float)_cupsStrScand(sptr
, &sptr
, loc
);
907 profile
->matrix
[0][2] = (float)_cupsStrScand(sptr
, &sptr
, loc
);
908 profile
->matrix
[1][0] = (float)_cupsStrScand(sptr
, &sptr
, loc
);
909 profile
->matrix
[1][1] = (float)_cupsStrScand(sptr
, &sptr
, loc
);
910 profile
->matrix
[1][2] = (float)_cupsStrScand(sptr
, &sptr
, loc
);
911 profile
->matrix
[2][0] = (float)_cupsStrScand(sptr
, &sptr
, loc
);
912 profile
->matrix
[2][1] = (float)_cupsStrScand(sptr
, &sptr
, loc
);
913 profile
->matrix
[2][2] = (float)_cupsStrScand(sptr
, &sptr
, loc
);
915 else if (!strcmp(keyword
, "cupsFilter"))
917 if (ppd
->num_filters
== 0)
918 filter
= malloc(sizeof(char *));
920 filter
= realloc(ppd
->filters
, sizeof(char *) * (size_t)(ppd
->num_filters
+ 1));
924 pg
->ppd_status
= PPD_ALLOC_ERROR
;
929 ppd
->filters
= filter
;
930 filter
+= ppd
->num_filters
;
934 * Make a copy of the filter string...
937 *filter
= strdup(string
);
939 else if (!strcmp(keyword
, "Throughput"))
940 ppd
->throughput
= atoi(string
);
941 else if (!strcmp(keyword
, "Font"))
944 * Add this font to the list of available fonts...
947 if (ppd
->num_fonts
== 0)
948 tempfonts
= (char **)malloc(sizeof(char *));
950 tempfonts
= (char **)realloc(ppd
->fonts
, sizeof(char *) * (size_t)(ppd
->num_fonts
+ 1));
952 if (tempfonts
== NULL
)
954 pg
->ppd_status
= PPD_ALLOC_ERROR
;
959 ppd
->fonts
= tempfonts
;
960 ppd
->fonts
[ppd
->num_fonts
] = strdup(name
);
963 else if (!strncmp(keyword
, "ParamCustom", 11))
965 ppd_coption_t
*coption
; /* Custom option */
966 ppd_cparam_t
*cparam
; /* Custom parameter */
967 int corder
; /* Order number */
968 char ctype
[33], /* Data type */
969 cminimum
[65], /* Minimum value */
970 cmaximum
[65]; /* Maximum value */
974 * Get the custom option and parameter...
977 if ((coption
= ppd_get_coption(ppd
, keyword
+ 11)) == NULL
)
979 pg
->ppd_status
= PPD_ALLOC_ERROR
;
984 if ((cparam
= ppd_get_cparam(coption
, name
, text
)) == NULL
)
986 pg
->ppd_status
= PPD_ALLOC_ERROR
;
992 * Get the parameter data...
996 sscanf(string
, "%d%32s%64s%64s", &corder
, ctype
, cminimum
,
999 pg
->ppd_status
= PPD_BAD_CUSTOM_PARAM
;
1004 cparam
->order
= corder
;
1006 if (!strcmp(ctype
, "curve"))
1008 cparam
->type
= PPD_CUSTOM_CURVE
;
1009 cparam
->minimum
.custom_curve
= (float)_cupsStrScand(cminimum
, NULL
, loc
);
1010 cparam
->maximum
.custom_curve
= (float)_cupsStrScand(cmaximum
, NULL
, loc
);
1012 else if (!strcmp(ctype
, "int"))
1014 cparam
->type
= PPD_CUSTOM_INT
;
1015 cparam
->minimum
.custom_int
= atoi(cminimum
);
1016 cparam
->maximum
.custom_int
= atoi(cmaximum
);
1018 else if (!strcmp(ctype
, "invcurve"))
1020 cparam
->type
= PPD_CUSTOM_INVCURVE
;
1021 cparam
->minimum
.custom_invcurve
= (float)_cupsStrScand(cminimum
, NULL
, loc
);
1022 cparam
->maximum
.custom_invcurve
= (float)_cupsStrScand(cmaximum
, NULL
, loc
);
1024 else if (!strcmp(ctype
, "passcode"))
1026 cparam
->type
= PPD_CUSTOM_PASSCODE
;
1027 cparam
->minimum
.custom_passcode
= atoi(cminimum
);
1028 cparam
->maximum
.custom_passcode
= atoi(cmaximum
);
1030 else if (!strcmp(ctype
, "password"))
1032 cparam
->type
= PPD_CUSTOM_PASSWORD
;
1033 cparam
->minimum
.custom_password
= atoi(cminimum
);
1034 cparam
->maximum
.custom_password
= atoi(cmaximum
);
1036 else if (!strcmp(ctype
, "points"))
1038 cparam
->type
= PPD_CUSTOM_POINTS
;
1039 cparam
->minimum
.custom_points
= (float)_cupsStrScand(cminimum
, NULL
, loc
);
1040 cparam
->maximum
.custom_points
= (float)_cupsStrScand(cmaximum
, NULL
, loc
);
1042 else if (!strcmp(ctype
, "real"))
1044 cparam
->type
= PPD_CUSTOM_REAL
;
1045 cparam
->minimum
.custom_real
= (float)_cupsStrScand(cminimum
, NULL
, loc
);
1046 cparam
->maximum
.custom_real
= (float)_cupsStrScand(cmaximum
, NULL
, loc
);
1048 else if (!strcmp(ctype
, "string"))
1050 cparam
->type
= PPD_CUSTOM_STRING
;
1051 cparam
->minimum
.custom_string
= atoi(cminimum
);
1052 cparam
->maximum
.custom_string
= atoi(cmaximum
);
1056 pg
->ppd_status
= PPD_BAD_CUSTOM_PARAM
;
1062 * Now special-case for CustomPageSize...
1065 if (!strcmp(coption
->keyword
, "PageSize"))
1067 if (!strcmp(name
, "Width"))
1069 ppd
->custom_min
[0] = cparam
->minimum
.custom_points
;
1070 ppd
->custom_max
[0] = cparam
->maximum
.custom_points
;
1072 else if (!strcmp(name
, "Height"))
1074 ppd
->custom_min
[1] = cparam
->minimum
.custom_points
;
1075 ppd
->custom_max
[1] = cparam
->maximum
.custom_points
;
1079 else if (!strcmp(keyword
, "HWMargins"))
1081 for (i
= 0, sptr
= string
; i
< 4; i
++)
1082 ppd
->custom_margins
[i
] = (float)_cupsStrScand(sptr
, &sptr
, loc
);
1084 else if (!strncmp(keyword
, "Custom", 6) && !strcmp(name
, "True") && !option
)
1086 ppd_option_t
*custom_option
; /* Custom option */
1088 DEBUG_puts("2_ppdOpen: Processing Custom option...");
1091 * Get the option and custom option...
1094 if (!ppd_get_coption(ppd
, keyword
+ 6))
1096 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1101 if (option
&& !_cups_strcasecmp(option
->keyword
, keyword
+ 6))
1102 custom_option
= option
;
1104 custom_option
= ppdFindOption(ppd
, keyword
+ 6);
1109 * Add the "custom" option...
1112 if ((choice
= ppdFindChoice(custom_option
, "Custom")) == NULL
)
1113 if ((choice
= ppd_add_choice(custom_option
, "Custom")) == NULL
)
1115 DEBUG_puts("1_ppdOpen: Unable to add Custom choice!");
1117 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1122 strlcpy(choice
->text
, text
[0] ? text
: _("Custom"),
1123 sizeof(choice
->text
));
1125 choice
->code
= strdup(string
);
1127 if (custom_option
->section
== PPD_ORDER_JCL
)
1128 ppd_decode(choice
->code
);
1132 * Now process custom page sizes specially...
1135 if (!strcmp(keyword
, "CustomPageSize"))
1138 * Add a "Custom" page size entry...
1141 ppd
->variable_sizes
= 1;
1143 ppd_add_size(ppd
, "Custom");
1145 if (option
&& !_cups_strcasecmp(option
->keyword
, "PageRegion"))
1146 custom_option
= option
;
1148 custom_option
= ppdFindOption(ppd
, "PageRegion");
1152 if ((choice
= ppdFindChoice(custom_option
, "Custom")) == NULL
)
1153 if ((choice
= ppd_add_choice(custom_option
, "Custom")) == NULL
)
1155 DEBUG_puts("1_ppdOpen: Unable to add Custom choice!");
1157 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1162 strlcpy(choice
->text
, text
[0] ? text
: _("Custom"),
1163 sizeof(choice
->text
));
1167 else if (!strcmp(keyword
, "LandscapeOrientation"))
1169 if (!strcmp(string
, "Minus90"))
1170 ppd
->landscape
= -90;
1171 else if (!strcmp(string
, "Plus90"))
1172 ppd
->landscape
= 90;
1174 else if (!strcmp(keyword
, "Emulators") && string
&& ppd
->num_emulations
== 0)
1177 * Issue #5562: Samsung printer drivers incorrectly use Emulators keyword
1178 * to configure themselves
1180 * The Emulators keyword was loaded but never used by anything in CUPS,
1181 * and has no valid purpose in CUPS. The old code was removed due to a
1182 * memory leak (Issue #5475), so the following (new) code supports a single
1183 * name for the Emulators keyword, allowing these drivers to work until we
1184 * remove PPD and driver support entirely in a future version of CUPS.
1187 ppd
->num_emulations
= 1;
1188 ppd
->emulations
= calloc(1, sizeof(ppd_emul_t
));
1190 strlcpy(ppd
->emulations
[0].name
, string
, sizeof(ppd
->emulations
[0].name
));
1192 else if (!strcmp(keyword
, "JobPatchFile"))
1195 * CUPS STR #3421: Check for "*JobPatchFile: int: string"
1198 if (isdigit(*string
& 255))
1200 for (sptr
= string
+ 1; isdigit(*sptr
& 255); sptr
++);
1205 * Found "*JobPatchFile: int: string"...
1208 pg
->ppd_status
= PPD_BAD_VALUE
;
1214 if (!name
[0] && pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1217 * Found "*JobPatchFile: string"...
1220 pg
->ppd_status
= PPD_MISSING_OPTION_KEYWORD
;
1225 if (ppd
->patches
== NULL
)
1226 ppd
->patches
= strdup(string
);
1229 temp
= realloc(ppd
->patches
, strlen(ppd
->patches
) +
1230 strlen(string
) + 1);
1233 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1238 ppd
->patches
= temp
;
1240 memcpy(ppd
->patches
+ strlen(ppd
->patches
), string
, strlen(string
) + 1);
1243 else if (!strcmp(keyword
, "OpenUI"))
1246 * Don't allow nesting of options...
1249 if (option
&& pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1251 pg
->ppd_status
= PPD_NESTED_OPEN_UI
;
1257 * Add an option record to the current sub-group, group, or file...
1260 DEBUG_printf(("2_ppdOpen: name=\"%s\" (%d)", name
, (int)strlen(name
)));
1263 _cups_strcpy(name
, name
+ 1); /* Eliminate leading asterisk */
1265 for (i
= (int)strlen(name
) - 1; i
> 0 && _cups_isspace(name
[i
]); i
--)
1266 name
[i
] = '\0'; /* Eliminate trailing spaces */
1268 DEBUG_printf(("2_ppdOpen: OpenUI of %s in group %s...", name
,
1269 group
? group
->text
: "(null)"));
1271 if (subgroup
!= NULL
)
1272 option
= ppd_get_option(subgroup
, name
);
1273 else if (group
== NULL
)
1275 if ((group
= ppd_get_group(ppd
, "General", _("General"), pg
,
1279 DEBUG_printf(("2_ppdOpen: Adding to group %s...", group
->text
));
1280 option
= ppd_get_option(group
, name
);
1284 option
= ppd_get_option(group
, name
);
1288 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1294 * Now fill in the initial information for the option...
1297 if (string
&& !strcmp(string
, "PickMany"))
1298 option
->ui
= PPD_UI_PICKMANY
;
1299 else if (string
&& !strcmp(string
, "Boolean"))
1300 option
->ui
= PPD_UI_BOOLEAN
;
1301 else if (string
&& !strcmp(string
, "PickOne"))
1302 option
->ui
= PPD_UI_PICKONE
;
1303 else if (pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1305 pg
->ppd_status
= PPD_BAD_OPEN_UI
;
1310 option
->ui
= PPD_UI_PICKONE
;
1312 for (j
= 0; j
< ppd
->num_attrs
; j
++)
1313 if (!strncmp(ppd
->attrs
[j
]->name
, "Default", 7) &&
1314 !strcmp(ppd
->attrs
[j
]->name
+ 7, name
) &&
1315 ppd
->attrs
[j
]->value
)
1317 DEBUG_printf(("2_ppdOpen: Setting Default%s to %s via attribute...",
1318 option
->keyword
, ppd
->attrs
[j
]->value
));
1319 strlcpy(option
->defchoice
, ppd
->attrs
[j
]->value
,
1320 sizeof(option
->defchoice
));
1325 cupsCharsetToUTF8((cups_utf8_t
*)option
->text
, text
,
1326 sizeof(option
->text
), encoding
);
1329 if (!strcmp(name
, "PageSize"))
1330 strlcpy(option
->text
, _("Media Size"), sizeof(option
->text
));
1331 else if (!strcmp(name
, "MediaType"))
1332 strlcpy(option
->text
, _("Media Type"), sizeof(option
->text
));
1333 else if (!strcmp(name
, "InputSlot"))
1334 strlcpy(option
->text
, _("Media Source"), sizeof(option
->text
));
1335 else if (!strcmp(name
, "ColorModel"))
1336 strlcpy(option
->text
, _("Output Mode"), sizeof(option
->text
));
1337 else if (!strcmp(name
, "Resolution"))
1338 strlcpy(option
->text
, _("Resolution"), sizeof(option
->text
));
1340 strlcpy(option
->text
, name
, sizeof(option
->text
));
1343 option
->section
= PPD_ORDER_ANY
;
1349 * Add a custom option choice if we have already seen a CustomFoo
1353 if (!_cups_strcasecmp(name
, "PageRegion"))
1354 strlcpy(custom_name
, "CustomPageSize", sizeof(custom_name
));
1356 snprintf(custom_name
, sizeof(custom_name
), "Custom%s", name
);
1358 if ((custom_attr
= ppdFindAttr(ppd
, custom_name
, "True")) != NULL
)
1360 if ((choice
= ppdFindChoice(option
, "Custom")) == NULL
)
1361 if ((choice
= ppd_add_choice(option
, "Custom")) == NULL
)
1363 DEBUG_puts("1_ppdOpen: Unable to add Custom choice!");
1365 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1370 strlcpy(choice
->text
,
1371 custom_attr
->text
[0] ? custom_attr
->text
: _("Custom"),
1372 sizeof(choice
->text
));
1373 choice
->code
= strdup(custom_attr
->value
);
1376 else if (!strcmp(keyword
, "JCLOpenUI"))
1379 * Don't allow nesting of options...
1382 if (option
&& pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1384 pg
->ppd_status
= PPD_NESTED_OPEN_UI
;
1390 * Find the JCL group, and add if needed...
1393 group
= ppd_get_group(ppd
, "JCL", _("JCL"), pg
, encoding
);
1399 * Add an option record to the current JCLs...
1403 _cups_strcpy(name
, name
+ 1);
1405 option
= ppd_get_option(group
, name
);
1409 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1415 * Now fill in the initial information for the option...
1418 if (string
&& !strcmp(string
, "PickMany"))
1419 option
->ui
= PPD_UI_PICKMANY
;
1420 else if (string
&& !strcmp(string
, "Boolean"))
1421 option
->ui
= PPD_UI_BOOLEAN
;
1422 else if (string
&& !strcmp(string
, "PickOne"))
1423 option
->ui
= PPD_UI_PICKONE
;
1426 pg
->ppd_status
= PPD_BAD_OPEN_UI
;
1431 for (j
= 0; j
< ppd
->num_attrs
; j
++)
1432 if (!strncmp(ppd
->attrs
[j
]->name
, "Default", 7) &&
1433 !strcmp(ppd
->attrs
[j
]->name
+ 7, name
) &&
1434 ppd
->attrs
[j
]->value
)
1436 DEBUG_printf(("2_ppdOpen: Setting Default%s to %s via attribute...",
1437 option
->keyword
, ppd
->attrs
[j
]->value
));
1438 strlcpy(option
->defchoice
, ppd
->attrs
[j
]->value
,
1439 sizeof(option
->defchoice
));
1444 cupsCharsetToUTF8((cups_utf8_t
*)option
->text
, text
,
1445 sizeof(option
->text
), encoding
);
1447 strlcpy(option
->text
, name
, sizeof(option
->text
));
1449 option
->section
= PPD_ORDER_JCL
;
1456 * Add a custom option choice if we have already seen a CustomFoo
1460 snprintf(custom_name
, sizeof(custom_name
), "Custom%s", name
);
1462 if ((custom_attr
= ppdFindAttr(ppd
, custom_name
, "True")) != NULL
)
1464 if ((choice
= ppd_add_choice(option
, "Custom")) == NULL
)
1466 DEBUG_puts("1_ppdOpen: Unable to add Custom choice!");
1468 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1473 strlcpy(choice
->text
,
1474 custom_attr
->text
[0] ? custom_attr
->text
: _("Custom"),
1475 sizeof(choice
->text
));
1476 choice
->code
= strdup(custom_attr
->value
);
1479 else if (!strcmp(keyword
, "CloseUI"))
1481 if ((!option
|| option
->section
== PPD_ORDER_JCL
) && pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1483 pg
->ppd_status
= PPD_BAD_CLOSE_UI
;
1493 else if (!strcmp(keyword
, "JCLCloseUI"))
1495 if ((!option
|| option
->section
!= PPD_ORDER_JCL
) && pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1497 pg
->ppd_status
= PPD_BAD_CLOSE_UI
;
1507 else if (!strcmp(keyword
, "OpenGroup"))
1510 * Open a new group...
1515 pg
->ppd_status
= PPD_NESTED_OPEN_GROUP
;
1522 pg
->ppd_status
= PPD_BAD_OPEN_GROUP
;
1528 * Separate the group name from the text (name/text)...
1531 if ((sptr
= strchr(string
, '/')) != NULL
)
1537 * Fix up the text...
1543 * Find/add the group...
1546 group
= ppd_get_group(ppd
, string
, sptr
, pg
, encoding
);
1554 else if (!strcmp(keyword
, "CloseGroup"))
1561 else if (!strcmp(keyword
, "OrderDependency"))
1563 order
= (float)_cupsStrScand(string
, &sptr
, loc
);
1565 if (!sptr
|| sscanf(sptr
, "%40s%40s", name
, keyword
) != 2)
1567 pg
->ppd_status
= PPD_BAD_ORDER_DEPENDENCY
;
1572 if (keyword
[0] == '*')
1573 _cups_strcpy(keyword
, keyword
+ 1);
1575 if (!strcmp(name
, "ExitServer"))
1576 section
= PPD_ORDER_EXIT
;
1577 else if (!strcmp(name
, "Prolog"))
1578 section
= PPD_ORDER_PROLOG
;
1579 else if (!strcmp(name
, "DocumentSetup"))
1580 section
= PPD_ORDER_DOCUMENT
;
1581 else if (!strcmp(name
, "PageSetup"))
1582 section
= PPD_ORDER_PAGE
;
1583 else if (!strcmp(name
, "JCLSetup"))
1584 section
= PPD_ORDER_JCL
;
1586 section
= PPD_ORDER_ANY
;
1594 * Only valid for Non-UI options...
1597 for (i
= ppd
->num_groups
, gtemp
= ppd
->groups
; i
> 0; i
--, gtemp
++)
1598 if (gtemp
->text
[0] == '\0')
1602 for (i
= 0; i
< gtemp
->num_options
; i
++)
1603 if (!strcmp(keyword
, gtemp
->options
[i
].keyword
))
1605 gtemp
->options
[i
].section
= section
;
1606 gtemp
->options
[i
].order
= order
;
1612 option
->section
= section
;
1613 option
->order
= order
;
1619 else if (!strncmp(keyword
, "Default", 7))
1625 * Drop UI text, if any, from value...
1628 if (strchr(string
, '/') != NULL
)
1629 *strchr(string
, '/') = '\0';
1632 * Assign the default value as appropriate...
1635 if (!strcmp(keyword
, "DefaultColorSpace"))
1638 * Set default colorspace...
1641 if (!strcmp(string
, "CMY"))
1642 ppd
->colorspace
= PPD_CS_CMY
;
1643 else if (!strcmp(string
, "CMYK"))
1644 ppd
->colorspace
= PPD_CS_CMYK
;
1645 else if (!strcmp(string
, "RGB"))
1646 ppd
->colorspace
= PPD_CS_RGB
;
1647 else if (!strcmp(string
, "RGBK"))
1648 ppd
->colorspace
= PPD_CS_RGBK
;
1649 else if (!strcmp(string
, "N"))
1650 ppd
->colorspace
= PPD_CS_N
;
1652 ppd
->colorspace
= PPD_CS_GRAY
;
1654 else if (option
&& !strcmp(keyword
+ 7, option
->keyword
))
1657 * Set the default as part of the current option...
1660 DEBUG_printf(("2_ppdOpen: Setting %s to %s...", keyword
, string
));
1662 strlcpy(option
->defchoice
, string
, sizeof(option
->defchoice
));
1664 DEBUG_printf(("2_ppdOpen: %s is now %s...", keyword
, option
->defchoice
));
1669 * Lookup option and set if it has been defined...
1672 ppd_option_t
*toption
; /* Temporary option */
1675 if ((toption
= ppdFindOption(ppd
, keyword
+ 7)) != NULL
)
1677 DEBUG_printf(("2_ppdOpen: Setting %s to %s...", keyword
, string
));
1678 strlcpy(toption
->defchoice
, string
, sizeof(toption
->defchoice
));
1682 else if (!strcmp(keyword
, "UIConstraints") ||
1683 !strcmp(keyword
, "NonUIConstraints"))
1687 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1691 if (ppd
->num_consts
== 0)
1692 constraint
= calloc(2, sizeof(ppd_const_t
));
1694 constraint
= realloc(ppd
->consts
, (size_t)(ppd
->num_consts
+ 2) * sizeof(ppd_const_t
));
1696 if (constraint
== NULL
)
1698 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1703 ppd
->consts
= constraint
;
1704 constraint
+= ppd
->num_consts
;
1707 switch (sscanf(string
, "%40s%40s%40s%40s", constraint
->option1
,
1708 constraint
->choice1
, constraint
->option2
,
1709 constraint
->choice2
))
1711 case 0 : /* Error */
1712 case 1 : /* Error */
1713 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1716 case 2 : /* Two options... */
1718 * Check for broken constraints like "* Option"...
1721 if (pg
->ppd_conform
== PPD_CONFORM_STRICT
&&
1722 (!strcmp(constraint
->option1
, "*") ||
1723 !strcmp(constraint
->choice1
, "*")))
1725 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1730 * The following strcpy's are safe, as optionN and
1731 * choiceN are all the same size (size defined by PPD spec...)
1734 if (constraint
->option1
[0] == '*')
1735 _cups_strcpy(constraint
->option1
, constraint
->option1
+ 1);
1736 else if (pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1738 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1742 if (constraint
->choice1
[0] == '*')
1743 _cups_strcpy(constraint
->option2
, constraint
->choice1
+ 1);
1744 else if (pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1746 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1750 constraint
->choice1
[0] = '\0';
1751 constraint
->choice2
[0] = '\0';
1754 case 3 : /* Two options, one choice... */
1756 * Check for broken constraints like "* Option"...
1759 if (pg
->ppd_conform
== PPD_CONFORM_STRICT
&&
1760 (!strcmp(constraint
->option1
, "*") ||
1761 !strcmp(constraint
->choice1
, "*") ||
1762 !strcmp(constraint
->option2
, "*")))
1764 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1769 * The following _cups_strcpy's are safe, as optionN and
1770 * choiceN are all the same size (size defined by PPD spec...)
1773 if (constraint
->option1
[0] == '*')
1774 _cups_strcpy(constraint
->option1
, constraint
->option1
+ 1);
1775 else if (pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1777 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1781 if (constraint
->choice1
[0] == '*')
1783 if (pg
->ppd_conform
== PPD_CONFORM_STRICT
&&
1784 constraint
->option2
[0] == '*')
1786 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1790 _cups_strcpy(constraint
->choice2
, constraint
->option2
);
1791 _cups_strcpy(constraint
->option2
, constraint
->choice1
+ 1);
1792 constraint
->choice1
[0] = '\0';
1796 if (constraint
->option2
[0] == '*')
1797 _cups_strcpy(constraint
->option2
, constraint
->option2
+ 1);
1798 else if (pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1800 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1804 constraint
->choice2
[0] = '\0';
1808 case 4 : /* Two options, two choices... */
1810 * Check for broken constraints like "* Option"...
1813 if (pg
->ppd_conform
== PPD_CONFORM_STRICT
&&
1814 (!strcmp(constraint
->option1
, "*") ||
1815 !strcmp(constraint
->choice1
, "*") ||
1816 !strcmp(constraint
->option2
, "*") ||
1817 !strcmp(constraint
->choice2
, "*")))
1819 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1823 if (constraint
->option1
[0] == '*')
1824 _cups_strcpy(constraint
->option1
, constraint
->option1
+ 1);
1825 else if (pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1827 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1831 if (pg
->ppd_conform
== PPD_CONFORM_STRICT
&&
1832 constraint
->choice1
[0] == '*')
1834 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1838 if (constraint
->option2
[0] == '*')
1839 _cups_strcpy(constraint
->option2
, constraint
->option2
+ 1);
1840 else if (pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1842 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1846 if (pg
->ppd_conform
== PPD_CONFORM_STRICT
&&
1847 constraint
->choice2
[0] == '*')
1849 pg
->ppd_status
= PPD_BAD_UI_CONSTRAINTS
;
1856 * Don't add this one as an attribute...
1862 else if (!strcmp(keyword
, "PaperDimension"))
1864 if ((size
= ppdPageSize(ppd
, name
)) == NULL
)
1865 size
= ppd_add_size(ppd
, name
);
1870 * Unable to add or find size!
1873 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1878 size
->width
= (float)_cupsStrScand(string
, &sptr
, loc
);
1879 size
->length
= (float)_cupsStrScand(sptr
, NULL
, loc
);
1884 else if (!strcmp(keyword
, "ImageableArea"))
1886 if ((size
= ppdPageSize(ppd
, name
)) == NULL
)
1887 size
= ppd_add_size(ppd
, name
);
1892 * Unable to add or find size!
1895 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1900 size
->left
= (float)_cupsStrScand(string
, &sptr
, loc
);
1901 size
->bottom
= (float)_cupsStrScand(sptr
, &sptr
, loc
);
1902 size
->right
= (float)_cupsStrScand(sptr
, &sptr
, loc
);
1903 size
->top
= (float)_cupsStrScand(sptr
, NULL
, loc
);
1908 else if (option
!= NULL
&&
1909 (mask
& (PPD_KEYWORD
| PPD_OPTION
| PPD_STRING
)) ==
1910 (PPD_KEYWORD
| PPD_OPTION
| PPD_STRING
) &&
1911 !strcmp(keyword
, option
->keyword
))
1913 DEBUG_printf(("2_ppdOpen: group=%p, subgroup=%p", group
, subgroup
));
1915 if (!strcmp(keyword
, "PageSize"))
1918 * Add a page size...
1921 if (ppdPageSize(ppd
, name
) == NULL
)
1922 ppd_add_size(ppd
, name
);
1926 * Add the option choice...
1929 if ((choice
= ppd_add_choice(option
, name
)) == NULL
)
1931 pg
->ppd_status
= PPD_ALLOC_ERROR
;
1937 cupsCharsetToUTF8((cups_utf8_t
*)choice
->text
, text
,
1938 sizeof(choice
->text
), encoding
);
1939 else if (!strcmp(name
, "True"))
1940 strlcpy(choice
->text
, _("Yes"), sizeof(choice
->text
));
1941 else if (!strcmp(name
, "False"))
1942 strlcpy(choice
->text
, _("No"), sizeof(choice
->text
));
1944 strlcpy(choice
->text
, name
, sizeof(choice
->text
));
1946 if (option
->section
== PPD_ORDER_JCL
)
1947 ppd_decode(string
); /* Decode quoted string */
1949 choice
->code
= string
;
1950 string
= NULL
; /* Don't add as an attribute below */
1954 * Add remaining lines with keywords and string values as attributes...
1958 (mask
& (PPD_KEYWORD
| PPD_STRING
)) == (PPD_KEYWORD
| PPD_STRING
))
1959 ppd_add_attr(ppd
, keyword
, name
, text
, string
);
1965 * Check for a missing CloseUI/JCLCloseUI...
1968 if (option
&& pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1970 pg
->ppd_status
= PPD_MISSING_CLOSE_UI
;
1975 * Check for a missing CloseGroup...
1978 if (group
&& pg
->ppd_conform
== PPD_CONFORM_STRICT
)
1980 pg
->ppd_status
= PPD_MISSING_CLOSE_GROUP
;
1987 * Reset language preferences...
1991 if (!cupsFileEOF(fp
))
1992 DEBUG_printf(("1_ppdOpen: Premature EOF at %lu...\n",
1993 (unsigned long)cupsFileTell(fp
)));
1996 if (pg
->ppd_status
!= PPD_OK
)
1999 * Had an error reading the PPD file, cannot continue!
2008 * Update the filters array as needed...
2011 if (!ppd_update_filters(ppd
, pg
))
2019 * Create the sorted options array and set the option back-pointer for
2020 * each choice and custom option...
2023 ppd
->options
= cupsArrayNew2((cups_array_func_t
)ppd_compare_options
, NULL
,
2024 (cups_ahash_func_t
)ppd_hash_option
,
2027 for (i
= ppd
->num_groups
, group
= ppd
->groups
;
2031 for (j
= group
->num_options
, option
= group
->options
;
2035 ppd_coption_t
*coption
; /* Custom option */
2038 cupsArrayAdd(ppd
->options
, option
);
2040 for (k
= 0; k
< option
->num_choices
; k
++)
2041 option
->choices
[k
].option
= option
;
2043 if ((coption
= ppdFindCustomOption(ppd
, option
->keyword
)) != NULL
)
2044 coption
->option
= option
;
2049 * Create an array to track the marked choices...
2052 ppd
->marked
= cupsArrayNew((cups_array_func_t
)ppd_compare_choices
, NULL
);
2055 * Return the PPD file structure...
2061 * Common exit point for errors to save code size...
2076 * 'ppdOpen()' - Read a PPD file into memory.
2079 ppd_file_t
* /* O - PPD file record */
2080 ppdOpen(FILE *fp
) /* I - File to read from */
2082 ppd_file_t
*ppd
; /* PPD file record */
2083 cups_file_t
*cf
; /* CUPS file */
2087 * Reopen the stdio file as a CUPS file...
2090 if ((cf
= cupsFileOpenFd(fileno(fp
), "r")) == NULL
)
2094 * Load the PPD file using the newer API...
2097 ppd
= _ppdOpen(cf
, _PPD_LOCALIZATION_DEFAULT
);
2100 * Close the CUPS file and return the PPD...
2110 * 'ppdOpen2()' - Read a PPD file into memory.
2112 * @since CUPS 1.2/macOS 10.5@
2115 ppd_file_t
* /* O - PPD file record or @code NULL@ if the PPD file could not be opened. */
2116 ppdOpen2(cups_file_t
*fp
) /* I - File to read from */
2118 return _ppdOpen(fp
, _PPD_LOCALIZATION_DEFAULT
);
2123 * 'ppdOpenFd()' - Read a PPD file into memory.
2126 ppd_file_t
* /* O - PPD file record or @code NULL@ if the PPD file could not be opened. */
2127 ppdOpenFd(int fd
) /* I - File to read from */
2129 cups_file_t
*fp
; /* CUPS file pointer */
2130 ppd_file_t
*ppd
; /* PPD file record */
2131 _ppd_globals_t
*pg
= _ppdGlobals();
2136 * Set the line number to 0...
2142 * Range check input...
2147 pg
->ppd_status
= PPD_NULL_FILE
;
2153 * Try to open the file and parse it...
2156 if ((fp
= cupsFileOpenFd(fd
, "r")) != NULL
)
2164 pg
->ppd_status
= PPD_FILE_OPEN_ERROR
;
2173 * '_ppdOpenFile()' - Read a PPD file into memory.
2176 ppd_file_t
* /* O - PPD file record or @code NULL@ if the PPD file could not be opened. */
2177 _ppdOpenFile(const char *filename
, /* I - File to read from */
2178 _ppd_localization_t localization
) /* I - Localization to load */
2180 cups_file_t
*fp
; /* File pointer */
2181 ppd_file_t
*ppd
; /* PPD file record */
2182 _ppd_globals_t
*pg
= _ppdGlobals();
2187 * Set the line number to 0...
2193 * Range check input...
2196 if (filename
== NULL
)
2198 pg
->ppd_status
= PPD_NULL_FILE
;
2204 * Try to open the file and parse it...
2207 if ((fp
= cupsFileOpen(filename
, "r")) != NULL
)
2209 ppd
= _ppdOpen(fp
, localization
);
2215 pg
->ppd_status
= PPD_FILE_OPEN_ERROR
;
2224 * 'ppdOpenFile()' - Read a PPD file into memory.
2227 ppd_file_t
* /* O - PPD file record or @code NULL@ if the PPD file could not be opened. */
2228 ppdOpenFile(const char *filename
) /* I - File to read from */
2230 return _ppdOpenFile(filename
, _PPD_LOCALIZATION_DEFAULT
);
2235 * 'ppdSetConformance()' - Set the conformance level for PPD files.
2237 * @since CUPS 1.1.20/macOS 10.4@
2241 ppdSetConformance(ppd_conform_t c
) /* I - Conformance level */
2243 _ppd_globals_t
*pg
= _ppdGlobals();
2247 pg
->ppd_conform
= c
;
2252 * 'ppd_add_attr()' - Add an attribute to the PPD data.
2255 static ppd_attr_t
* /* O - New attribute */
2256 ppd_add_attr(ppd_file_t
*ppd
, /* I - PPD file data */
2257 const char *name
, /* I - Attribute name */
2258 const char *spec
, /* I - Specifier string, if any */
2259 const char *text
, /* I - Text string, if any */
2260 const char *value
) /* I - Value of attribute */
2262 ppd_attr_t
**ptr
, /* New array */
2263 *temp
; /* New attribute */
2267 * Range check input...
2270 if (ppd
== NULL
|| name
== NULL
|| spec
== NULL
)
2274 * Create the array as needed...
2277 if (!ppd
->sorted_attrs
)
2278 ppd
->sorted_attrs
= cupsArrayNew((cups_array_func_t
)ppd_compare_attrs
,
2282 * Allocate memory for the new attribute...
2285 if (ppd
->num_attrs
== 0)
2286 ptr
= malloc(sizeof(ppd_attr_t
*));
2288 ptr
= realloc(ppd
->attrs
, (size_t)(ppd
->num_attrs
+ 1) * sizeof(ppd_attr_t
*));
2294 ptr
+= ppd
->num_attrs
;
2296 if ((temp
= calloc(1, sizeof(ppd_attr_t
))) == NULL
)
2307 strlcpy(temp
->name
, name
, sizeof(temp
->name
));
2308 strlcpy(temp
->spec
, spec
, sizeof(temp
->spec
));
2309 strlcpy(temp
->text
, text
, sizeof(temp
->text
));
2310 temp
->value
= (char *)value
;
2313 * Add the attribute to the sorted array...
2316 cupsArrayAdd(ppd
->sorted_attrs
, temp
);
2319 * Return the attribute...
2327 * 'ppd_add_choice()' - Add a choice to an option.
2330 static ppd_choice_t
* /* O - Named choice */
2331 ppd_add_choice(ppd_option_t
*option
, /* I - Option */
2332 const char *name
) /* I - Name of choice */
2334 ppd_choice_t
*choice
; /* Choice */
2337 if (option
->num_choices
== 0)
2338 choice
= malloc(sizeof(ppd_choice_t
));
2340 choice
= realloc(option
->choices
, sizeof(ppd_choice_t
) * (size_t)(option
->num_choices
+ 1));
2345 option
->choices
= choice
;
2346 choice
+= option
->num_choices
;
2347 option
->num_choices
++;
2349 memset(choice
, 0, sizeof(ppd_choice_t
));
2350 strlcpy(choice
->choice
, name
, sizeof(choice
->choice
));
2357 * 'ppd_add_size()' - Add a page size.
2360 static ppd_size_t
* /* O - Named size */
2361 ppd_add_size(ppd_file_t
*ppd
, /* I - PPD file */
2362 const char *name
) /* I - Name of size */
2364 ppd_size_t
*size
; /* Size */
2367 if (ppd
->num_sizes
== 0)
2368 size
= malloc(sizeof(ppd_size_t
));
2370 size
= realloc(ppd
->sizes
, sizeof(ppd_size_t
) * (size_t)(ppd
->num_sizes
+ 1));
2376 size
+= ppd
->num_sizes
;
2379 memset(size
, 0, sizeof(ppd_size_t
));
2380 strlcpy(size
->name
, name
, sizeof(size
->name
));
2387 * 'ppd_compare_attrs()' - Compare two attributes.
2390 static int /* O - Result of comparison */
2391 ppd_compare_attrs(ppd_attr_t
*a
, /* I - First attribute */
2392 ppd_attr_t
*b
) /* I - Second attribute */
2394 return (_cups_strcasecmp(a
->name
, b
->name
));
2399 * 'ppd_compare_choices()' - Compare two choices...
2402 static int /* O - Result of comparison */
2403 ppd_compare_choices(ppd_choice_t
*a
, /* I - First choice */
2404 ppd_choice_t
*b
) /* I - Second choice */
2406 return (strcmp(a
->option
->keyword
, b
->option
->keyword
));
2411 * 'ppd_compare_coptions()' - Compare two custom options.
2414 static int /* O - Result of comparison */
2415 ppd_compare_coptions(ppd_coption_t
*a
, /* I - First option */
2416 ppd_coption_t
*b
) /* I - Second option */
2418 return (_cups_strcasecmp(a
->keyword
, b
->keyword
));
2423 * 'ppd_compare_options()' - Compare two options.
2426 static int /* O - Result of comparison */
2427 ppd_compare_options(ppd_option_t
*a
, /* I - First option */
2428 ppd_option_t
*b
) /* I - Second option */
2430 return (_cups_strcasecmp(a
->keyword
, b
->keyword
));
2435 * 'ppd_decode()' - Decode a string value...
2438 static int /* O - Length of decoded string */
2439 ppd_decode(char *string
) /* I - String to decode */
2441 char *inptr
, /* Input pointer */
2442 *outptr
; /* Output pointer */
2448 while (*inptr
!= '\0')
2449 if (*inptr
== '<' && isxdigit(inptr
[1] & 255))
2452 * Convert hex to 8-bit values...
2456 while (isxdigit(*inptr
& 255))
2458 if (_cups_isalpha(*inptr
))
2459 *outptr
= (char)((tolower(*inptr
) - 'a' + 10) << 4);
2461 *outptr
= (char)((*inptr
- '0') << 4);
2465 if (!isxdigit(*inptr
& 255))
2468 if (_cups_isalpha(*inptr
))
2469 *outptr
|= (char)(tolower(*inptr
) - 'a' + 10);
2471 *outptr
|= (char)(*inptr
- '0');
2477 while (*inptr
!= '>' && *inptr
!= '\0')
2479 while (*inptr
== '>')
2483 *outptr
++ = *inptr
++;
2487 return ((int)(outptr
- string
));
2492 * 'ppd_free_filters()' - Free the filters array.
2496 ppd_free_filters(ppd_file_t
*ppd
) /* I - PPD file */
2498 int i
; /* Looping var */
2499 char **filter
; /* Current filter */
2502 if (ppd
->num_filters
> 0)
2504 for (i
= ppd
->num_filters
, filter
= ppd
->filters
; i
> 0; i
--, filter
++)
2509 ppd
->num_filters
= 0;
2510 ppd
->filters
= NULL
;
2516 * 'ppd_free_group()' - Free a single UI group.
2520 ppd_free_group(ppd_group_t
*group
) /* I - Group to free */
2522 int i
; /* Looping var */
2523 ppd_option_t
*option
; /* Current option */
2524 ppd_group_t
*subgroup
; /* Current sub-group */
2527 if (group
->num_options
> 0)
2529 for (i
= group
->num_options
, option
= group
->options
;
2532 ppd_free_option(option
);
2534 free(group
->options
);
2537 if (group
->num_subgroups
> 0)
2539 for (i
= group
->num_subgroups
, subgroup
= group
->subgroups
;
2542 ppd_free_group(subgroup
);
2544 free(group
->subgroups
);
2550 * 'ppd_free_option()' - Free a single option.
2554 ppd_free_option(ppd_option_t
*option
) /* I - Option to free */
2556 int i
; /* Looping var */
2557 ppd_choice_t
*choice
; /* Current choice */
2560 if (option
->num_choices
> 0)
2562 for (i
= option
->num_choices
, choice
= option
->choices
;
2569 free(option
->choices
);
2575 * 'ppd_get_coption()' - Get a custom option record.
2578 static ppd_coption_t
* /* O - Custom option... */
2579 ppd_get_coption(ppd_file_t
*ppd
, /* I - PPD file */
2580 const char *name
) /* I - Name of option */
2582 ppd_coption_t
*copt
; /* New custom option */
2586 * See if the option already exists...
2589 if ((copt
= ppdFindCustomOption(ppd
, name
)) != NULL
)
2593 * Not found, so create the custom option record...
2596 if ((copt
= calloc(1, sizeof(ppd_coption_t
))) == NULL
)
2599 strlcpy(copt
->keyword
, name
, sizeof(copt
->keyword
));
2601 copt
->params
= cupsArrayNew((cups_array_func_t
)NULL
, NULL
);
2603 cupsArrayAdd(ppd
->coptions
, copt
);
2606 * Return the new record...
2614 * 'ppd_get_cparam()' - Get a custom parameter record.
2617 static ppd_cparam_t
* /* O - Extended option... */
2618 ppd_get_cparam(ppd_coption_t
*opt
, /* I - PPD file */
2619 const char *param
, /* I - Name of parameter */
2620 const char *text
) /* I - Human-readable text */
2622 ppd_cparam_t
*cparam
; /* New custom parameter */
2626 * See if the parameter already exists...
2629 if ((cparam
= ppdFindCustomParam(opt
, param
)) != NULL
)
2633 * Not found, so create the custom parameter record...
2636 if ((cparam
= calloc(1, sizeof(ppd_cparam_t
))) == NULL
)
2639 strlcpy(cparam
->name
, param
, sizeof(cparam
->name
));
2640 strlcpy(cparam
->text
, text
[0] ? text
: param
, sizeof(cparam
->text
));
2643 * Add this record to the array...
2646 cupsArrayAdd(opt
->params
, cparam
);
2649 * Return the new record...
2657 * 'ppd_get_group()' - Find or create the named group as needed.
2660 static ppd_group_t
* /* O - Named group */
2661 ppd_get_group(ppd_file_t
*ppd
, /* I - PPD file */
2662 const char *name
, /* I - Name of group */
2663 const char *text
, /* I - Text for group */
2664 _ppd_globals_t
*pg
, /* I - Global data */
2665 cups_encoding_t encoding
) /* I - Encoding of text */
2667 int i
; /* Looping var */
2668 ppd_group_t
*group
; /* Group */
2671 DEBUG_printf(("7ppd_get_group(ppd=%p, name=\"%s\", text=\"%s\", cg=%p)",
2672 ppd
, name
, text
, pg
));
2674 for (i
= ppd
->num_groups
, group
= ppd
->groups
; i
> 0; i
--, group
++)
2675 if (!strcmp(group
->name
, name
))
2680 DEBUG_printf(("8ppd_get_group: Adding group %s...", name
));
2682 if (pg
->ppd_conform
== PPD_CONFORM_STRICT
&& strlen(text
) >= sizeof(group
->text
))
2684 pg
->ppd_status
= PPD_ILLEGAL_TRANSLATION
;
2689 if (ppd
->num_groups
== 0)
2690 group
= malloc(sizeof(ppd_group_t
));
2692 group
= realloc(ppd
->groups
, (size_t)(ppd
->num_groups
+ 1) * sizeof(ppd_group_t
));
2696 pg
->ppd_status
= PPD_ALLOC_ERROR
;
2701 ppd
->groups
= group
;
2702 group
+= ppd
->num_groups
;
2705 memset(group
, 0, sizeof(ppd_group_t
));
2706 strlcpy(group
->name
, name
, sizeof(group
->name
));
2708 cupsCharsetToUTF8((cups_utf8_t
*)group
->text
, text
,
2709 sizeof(group
->text
), encoding
);
2717 * 'ppd_get_option()' - Find or create the named option as needed.
2720 static ppd_option_t
* /* O - Named option */
2721 ppd_get_option(ppd_group_t
*group
, /* I - Group */
2722 const char *name
) /* I - Name of option */
2724 int i
; /* Looping var */
2725 ppd_option_t
*option
; /* Option */
2728 DEBUG_printf(("7ppd_get_option(group=%p(\"%s\"), name=\"%s\")",
2729 group
, group
->name
, name
));
2731 for (i
= group
->num_options
, option
= group
->options
; i
> 0; i
--, option
++)
2732 if (!strcmp(option
->keyword
, name
))
2737 if (group
->num_options
== 0)
2738 option
= malloc(sizeof(ppd_option_t
));
2740 option
= realloc(group
->options
, (size_t)(group
->num_options
+ 1) * sizeof(ppd_option_t
));
2745 group
->options
= option
;
2746 option
+= group
->num_options
;
2747 group
->num_options
++;
2749 memset(option
, 0, sizeof(ppd_option_t
));
2750 strlcpy(option
->keyword
, name
, sizeof(option
->keyword
));
2758 * 'ppd_globals_alloc()' - Allocate and initialize global data.
2761 static _ppd_globals_t
* /* O - Pointer to global data */
2762 ppd_globals_alloc(void)
2764 return ((_ppd_globals_t
*)calloc(1, sizeof(_ppd_globals_t
)));
2769 * 'ppd_globals_free()' - Free global data.
2772 #if defined(HAVE_PTHREAD_H) || defined(_WIN32)
2774 ppd_globals_free(_ppd_globals_t
*pg
) /* I - Pointer to global data */
2778 #endif /* HAVE_PTHREAD_H || _WIN32 */
2781 #ifdef HAVE_PTHREAD_H
2783 * 'ppd_globals_init()' - Initialize per-thread globals...
2787 ppd_globals_init(void)
2790 * Register the global data for this thread...
2793 pthread_key_create(&ppd_globals_key
, (void (*)(void *))ppd_globals_free
);
2795 #endif /* HAVE_PTHREAD_H */
2799 * 'ppd_hash_option()' - Generate a hash of the option name...
2802 static int /* O - Hash index */
2803 ppd_hash_option(ppd_option_t
*option
) /* I - Option */
2805 int hash
= 0; /* Hash index */
2806 const char *k
; /* Pointer into keyword */
2809 for (hash
= option
->keyword
[0], k
= option
->keyword
+ 1; *k
;)
2810 hash
= 33 * hash
+ *k
++;
2812 return (hash
& 511);
2817 * 'ppd_read()' - Read a line from a PPD file, skipping comment lines as
2821 static int /* O - Bitmask of fields read */
2822 ppd_read(cups_file_t
*fp
, /* I - File to read from */
2823 _ppd_line_t
*line
, /* I - Line buffer */
2824 char *keyword
, /* O - Keyword from line */
2825 char *option
, /* O - Option from line */
2826 char *text
, /* O - Human-readable text from line */
2827 char **string
, /* O - Code/string data */
2828 int ignoreblank
, /* I - Ignore blank lines? */
2829 _ppd_globals_t
*pg
) /* I - Global data */
2831 int ch
, /* Character from file */
2832 col
, /* Column in line */
2833 colon
, /* Colon seen? */
2834 endquote
, /* Waiting for an end quote */
2835 mask
, /* Mask to be returned */
2836 startline
, /* Start line */
2837 textlen
; /* Length of text */
2838 char *keyptr
, /* Keyword pointer */
2839 *optptr
, /* Option pointer */
2840 *textptr
, /* Text pointer */
2841 *strptr
, /* Pointer into string */
2842 *lineptr
; /* Current position in line buffer */
2846 * Now loop until we have a valid line...
2851 startline
= pg
->ppd_line
+ 1;
2855 line
->bufsize
= 1024;
2856 line
->buffer
= malloc(1024);
2868 lineptr
= line
->buffer
;
2872 while ((ch
= cupsFileGetChar(fp
)) != EOF
)
2874 if (lineptr
>= (line
->buffer
+ line
->bufsize
- 1))
2877 * Expand the line buffer...
2880 char *temp
; /* Temporary line pointer */
2883 line
->bufsize
+= 1024;
2884 if (line
->bufsize
> 262144)
2887 * Don't allow lines longer than 256k!
2890 pg
->ppd_line
= startline
;
2891 pg
->ppd_status
= PPD_LINE_TOO_LONG
;
2896 temp
= realloc(line
->buffer
, line
->bufsize
);
2899 pg
->ppd_line
= startline
;
2900 pg
->ppd_status
= PPD_LINE_TOO_LONG
;
2905 lineptr
= temp
+ (lineptr
- line
->buffer
);
2906 line
->buffer
= temp
;
2909 if (ch
== '\r' || ch
== '\n')
2912 * Line feed or carriage return...
2921 * Check for a trailing line feed...
2924 if ((ch
= cupsFilePeekChar(fp
)) == EOF
)
2931 cupsFileGetChar(fp
);
2934 if (lineptr
== line
->buffer
&& ignoreblank
)
2935 continue; /* Skip blank lines */
2939 if (!endquote
) /* Continue for multi-line text */
2944 else if (ch
< ' ' && ch
!= '\t' && pg
->ppd_conform
== PPD_CONFORM_STRICT
)
2947 * Other control characters...
2950 pg
->ppd_line
= startline
;
2951 pg
->ppd_status
= PPD_ILLEGAL_CHARACTER
;
2955 else if (ch
!= 0x1a)
2958 * Any other character...
2961 *lineptr
++ = (char)ch
;
2964 if (col
> (PPD_MAX_LINE
- 1))
2967 * Line is too long...
2970 pg
->ppd_line
= startline
;
2971 pg
->ppd_status
= PPD_LINE_TOO_LONG
;
2976 if (ch
== ':' && strncmp(line
->buffer
, "*%", 2) != 0)
2979 if (ch
== '\"' && colon
)
2980 endquote
= !endquote
;
2987 * Didn't finish this quoted string...
2990 while ((ch
= cupsFileGetChar(fp
)) != EOF
)
2993 else if (ch
== '\r' || ch
== '\n')
3001 * Check for a trailing line feed...
3004 if ((ch
= cupsFilePeekChar(fp
)) == EOF
)
3007 cupsFileGetChar(fp
);
3010 else if (ch
< ' ' && ch
!= '\t' && pg
->ppd_conform
== PPD_CONFORM_STRICT
)
3013 * Other control characters...
3016 pg
->ppd_line
= startline
;
3017 pg
->ppd_status
= PPD_ILLEGAL_CHARACTER
;
3021 else if (ch
!= 0x1a)
3025 if (col
> (PPD_MAX_LINE
- 1))
3028 * Line is too long...
3031 pg
->ppd_line
= startline
;
3032 pg
->ppd_status
= PPD_LINE_TOO_LONG
;
3042 * Didn't finish this line...
3045 while ((ch
= cupsFileGetChar(fp
)) != EOF
)
3046 if (ch
== '\r' || ch
== '\n')
3049 * Line feed or carriage return...
3058 * Check for a trailing line feed...
3061 if ((ch
= cupsFilePeekChar(fp
)) == EOF
)
3064 cupsFileGetChar(fp
);
3069 else if (ch
< ' ' && ch
!= '\t' && pg
->ppd_conform
== PPD_CONFORM_STRICT
)
3072 * Other control characters...
3075 pg
->ppd_line
= startline
;
3076 pg
->ppd_status
= PPD_ILLEGAL_CHARACTER
;
3080 else if (ch
!= 0x1a)
3084 if (col
> (PPD_MAX_LINE
- 1))
3087 * Line is too long...
3090 pg
->ppd_line
= startline
;
3091 pg
->ppd_status
= PPD_LINE_TOO_LONG
;
3098 if (lineptr
> line
->buffer
&& lineptr
[-1] == '\n')
3103 DEBUG_printf(("9ppd_read: LINE=\"%s\"", line
->buffer
));
3106 * The dynamically created PPDs for older style macOS
3107 * drivers include a large blob of data inserted as comments
3108 * at the end of the file. As an optimization we can stop
3109 * reading the PPD when we get to the start of this data.
3112 if (!strcmp(line
->buffer
, "*%APLWORKSET START"))
3115 if (ch
== EOF
&& lineptr
== line
->buffer
)
3123 lineptr
= line
->buffer
+ 1;
3130 if ((!line
->buffer
[0] || /* Blank line */
3131 !strncmp(line
->buffer
, "*%", 2) || /* Comment line */
3132 !strcmp(line
->buffer
, "*End")) && /* End of multi-line string */
3133 ignoreblank
) /* Ignore these? */
3135 startline
= pg
->ppd_line
+ 1;
3139 if (!strcmp(line
->buffer
, "*")) /* (Bad) comment line */
3141 if (pg
->ppd_conform
== PPD_CONFORM_RELAXED
)
3143 startline
= pg
->ppd_line
+ 1;
3148 pg
->ppd_line
= startline
;
3149 pg
->ppd_status
= PPD_ILLEGAL_MAIN_KEYWORD
;
3155 if (line
->buffer
[0] != '*') /* All lines start with an asterisk */
3158 * Allow lines consisting of just whitespace...
3161 for (lineptr
= line
->buffer
; *lineptr
; lineptr
++)
3162 if (*lineptr
&& !_cups_isspace(*lineptr
))
3167 pg
->ppd_status
= PPD_MISSING_ASTERISK
;
3170 else if (ignoreblank
)
3182 while (*lineptr
&& *lineptr
!= ':' && !_cups_isspace(*lineptr
))
3184 if (*lineptr
<= ' ' || *lineptr
> 126 || *lineptr
== '/' ||
3185 (keyptr
- keyword
) >= (PPD_MAX_NAME
- 1))
3187 pg
->ppd_status
= PPD_ILLEGAL_MAIN_KEYWORD
;
3191 *keyptr
++ = *lineptr
++;
3196 if (!strcmp(keyword
, "End"))
3199 mask
|= PPD_KEYWORD
;
3201 if (_cups_isspace(*lineptr
))
3204 * Get an option name...
3207 while (_cups_isspace(*lineptr
))
3212 while (*lineptr
&& !_cups_isspace(*lineptr
) && *lineptr
!= ':' &&
3215 if (*lineptr
<= ' ' || *lineptr
> 126 ||
3216 (optptr
- option
) >= (PPD_MAX_NAME
- 1))
3218 pg
->ppd_status
= PPD_ILLEGAL_OPTION_KEYWORD
;
3222 *optptr
++ = *lineptr
++;
3227 if (_cups_isspace(*lineptr
) && pg
->ppd_conform
== PPD_CONFORM_STRICT
)
3229 pg
->ppd_status
= PPD_ILLEGAL_WHITESPACE
;
3233 while (_cups_isspace(*lineptr
))
3238 if (*lineptr
== '/')
3241 * Get human-readable text...
3248 while (*lineptr
!= '\0' && *lineptr
!= '\n' && *lineptr
!= ':')
3250 if (((unsigned char)*lineptr
< ' ' && *lineptr
!= '\t') ||
3251 (textptr
- text
) >= (PPD_MAX_LINE
- 1))
3253 pg
->ppd_status
= PPD_ILLEGAL_TRANSLATION
;
3257 *textptr
++ = *lineptr
++;
3261 textlen
= ppd_decode(text
);
3263 if (textlen
> PPD_MAX_TEXT
&& pg
->ppd_conform
== PPD_CONFORM_STRICT
)
3265 pg
->ppd_status
= PPD_ILLEGAL_TRANSLATION
;
3273 if (_cups_isspace(*lineptr
) && pg
->ppd_conform
== PPD_CONFORM_STRICT
)
3275 pg
->ppd_status
= PPD_ILLEGAL_WHITESPACE
;
3279 while (_cups_isspace(*lineptr
))
3282 if (*lineptr
== ':')
3285 * Get string after triming leading and trailing whitespace...
3289 while (_cups_isspace(*lineptr
))
3292 strptr
= lineptr
+ strlen(lineptr
) - 1;
3293 while (strptr
>= lineptr
&& _cups_isspace(*strptr
))
3296 if (*strptr
== '\"')
3299 * Quoted string by itself, remove quotes...
3306 *string
= strdup(lineptr
);
3318 * 'ppd_update_filters()' - Update the filters array as needed.
3320 * This function re-populates the filters array with cupsFilter2 entries that
3321 * have been stripped of the destination MIME media types and any maxsize hints.
3323 * (All for backwards-compatibility)
3326 static int /* O - 1 on success, 0 on failure */
3327 ppd_update_filters(ppd_file_t
*ppd
, /* I - PPD file */
3328 _ppd_globals_t
*pg
) /* I - Global data */
3330 ppd_attr_t
*attr
; /* Current cupsFilter2 value */
3331 char srcsuper
[16], /* Source MIME media type */
3333 dstsuper
[16], /* Destination MIME media type */
3335 program
[1024], /* Command to run */
3336 *ptr
, /* Pointer into command to run */
3337 buffer
[1024], /* Re-written cupsFilter value */
3338 **filter
; /* Current filter */
3339 int cost
; /* Cost of filter */
3342 DEBUG_printf(("4ppd_update_filters(ppd=%p, cg=%p)", ppd
, pg
));
3345 * See if we have any cupsFilter2 lines...
3348 if ((attr
= ppdFindAttr(ppd
, "cupsFilter2", NULL
)) == NULL
)
3350 DEBUG_puts("5ppd_update_filters: No cupsFilter2 keywords present.");
3355 * Yes, free the cupsFilter-defined filters and re-build...
3358 ppd_free_filters(ppd
);
3363 * Parse the cupsFilter2 string:
3365 * src/type dst/type cost program
3366 * src/type dst/type cost maxsize(n) program
3369 DEBUG_printf(("5ppd_update_filters: cupsFilter2=\"%s\"", attr
->value
));
3371 if (sscanf(attr
->value
, "%15[^/]/%255s%*[ \t]%15[^/]/%255s%d%*[ \t]%1023[^\n]",
3372 srcsuper
, srctype
, dstsuper
, dsttype
, &cost
, program
) != 6)
3374 DEBUG_puts("5ppd_update_filters: Bad cupsFilter2 line.");
3375 pg
->ppd_status
= PPD_BAD_VALUE
;
3380 DEBUG_printf(("5ppd_update_filters: srcsuper=\"%s\", srctype=\"%s\", "
3381 "dstsuper=\"%s\", dsttype=\"%s\", cost=%d, program=\"%s\"",
3382 srcsuper
, srctype
, dstsuper
, dsttype
, cost
, program
));
3384 if (!strncmp(program
, "maxsize(", 8) &&
3385 (ptr
= strchr(program
+ 8, ')')) != NULL
)
3387 DEBUG_puts("5ppd_update_filters: Found maxsize(nnn).");
3390 while (_cups_isspace(*ptr
))
3393 _cups_strcpy(program
, ptr
);
3394 DEBUG_printf(("5ppd_update_filters: New program=\"%s\"", program
));
3398 * Convert to cupsFilter format:
3400 * src/type cost program
3403 snprintf(buffer
, sizeof(buffer
), "%s/%s %d %s", srcsuper
, srctype
, cost
,
3405 DEBUG_printf(("5ppd_update_filters: Adding \"%s\".", buffer
));
3408 * Add a cupsFilter-compatible string to the filters array.
3411 if (ppd
->num_filters
== 0)
3412 filter
= malloc(sizeof(char *));
3414 filter
= realloc(ppd
->filters
, sizeof(char *) * (size_t)(ppd
->num_filters
+ 1));
3418 DEBUG_puts("5ppd_update_filters: Out of memory.");
3419 pg
->ppd_status
= PPD_ALLOC_ERROR
;
3424 ppd
->filters
= filter
;
3425 filter
+= ppd
->num_filters
;
3426 ppd
->num_filters
++;
3428 *filter
= strdup(buffer
);
3430 while ((attr
= ppdFindNextAttr(ppd
, "cupsFilter2", NULL
)) != NULL
);
3432 DEBUG_puts("5ppd_update_filters: Completed OK.");