ncurses 6.2 - patch 20210626
[ncurses.git] / ncurses / tinfo / read_entry.c
1 /****************************************************************************
2  * Copyright 2018-2020,2021 Thomas E. Dickey                                *
3  * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
33  *     and: Thomas E. Dickey                        1996-on                 *
34  ****************************************************************************/
35
36 /*
37  *      read_entry.c -- Routine for reading in a compiled terminfo file
38  */
39
40 #include <curses.priv.h>
41 #include <hashed_db.h>
42
43 #include <tic.h>
44
45 MODULE_ID("$Id: read_entry.c,v 1.161 2021/06/26 19:43:17 tom Exp $")
46
47 #define TYPE_CALLOC(type,elts) typeCalloc(type, (unsigned)(elts))
48
49 #define MyNumber(n) (short) LOW_MSB(n)
50
51 #define SIZEOF_32BITS 4
52
53 #if NCURSES_USE_DATABASE
54 #if NCURSES_EXT_NUMBERS
55 static size_t
56 convert_16bits(char *buf, NCURSES_INT2 *Numbers, int count)
57 {
58     int i;
59     size_t j;
60     size_t size = SIZEOF_SHORT;
61     for (i = 0; i < count; i++) {
62         unsigned mask = 0xff;
63         unsigned char ch = 0;
64         Numbers[i] = 0;
65         for (j = 0; j < size; ++j) {
66             ch = UChar(*buf++);
67             Numbers[i] |= (ch << (8 * j));
68             mask <<= 8;
69         }
70         if (ch & 0x80) {
71             while (mask != 0) {
72                 Numbers[i] |= (int) mask;
73                 mask <<= 8;
74             }
75         }
76         TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
77     }
78     return size;
79 }
80
81 static size_t
82 convert_32bits(char *buf, NCURSES_INT2 *Numbers, int count)
83 {
84     int i;
85     size_t j;
86     size_t size = SIZEOF_INT2;
87     unsigned char ch;
88
89     assert(sizeof(NCURSES_INT2) == size);
90     for (i = 0; i < count; i++) {
91         Numbers[i] = 0;
92         for (j = 0; j < size; ++j) {
93             ch = UChar(*buf++);
94             Numbers[i] |= (ch << (8 * j));
95         }
96         /* "unsigned" and NCURSES_INT2 are the same size - no sign-extension */
97         TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
98     }
99     return size;
100 }
101 #else
102 static size_t
103 convert_32bits(char *buf, NCURSES_INT2 *Numbers, int count)
104 {
105     int i, j;
106     unsigned char ch;
107     for (i = 0; i < count; i++) {
108         int value = 0;
109         for (j = 0; j < SIZEOF_32BITS; ++j) {
110             ch = UChar(*buf++);
111             value |= (ch << (8 * j));
112         }
113         if (value == -1)
114             Numbers[i] = ABSENT_NUMERIC;
115         else if (value == -2)
116             Numbers[i] = CANCELLED_NUMERIC;
117         else if (value > MAX_OF_TYPE(NCURSES_INT2))
118             Numbers[i] = MAX_OF_TYPE(NCURSES_INT2);
119         else
120             Numbers[i] = (short) value;
121         TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
122     }
123     return SIZEOF_SHORT;
124 }
125
126 static size_t
127 convert_16bits(char *buf, NCURSES_INT2 *Numbers, int count)
128 {
129     int i;
130     for (i = 0; i < count; i++) {
131         if (IS_NEG1(buf + 2 * i))
132             Numbers[i] = ABSENT_NUMERIC;
133         else if (IS_NEG2(buf + 2 * i))
134             Numbers[i] = CANCELLED_NUMERIC;
135         else
136             Numbers[i] = MyNumber(buf + 2 * i);
137         TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
138     }
139     return SIZEOF_SHORT;
140 }
141 #endif
142
143 static void
144 convert_strings(char *buf, char **Strings, int count, int size, char *table)
145 {
146     int i;
147     char *p;
148
149     for (i = 0; i < count; i++) {
150         if (IS_NEG1(buf + 2 * i)) {
151             Strings[i] = ABSENT_STRING;
152         } else if (IS_NEG2(buf + 2 * i)) {
153             Strings[i] = CANCELLED_STRING;
154         } else if (MyNumber(buf + 2 * i) > size) {
155             Strings[i] = ABSENT_STRING;
156         } else {
157             Strings[i] = (MyNumber(buf + 2 * i) + table);
158             TR(TRACE_DATABASE, ("Strings[%d] = %s", i, _nc_visbuf(Strings[i])));
159         }
160
161         /* make sure all strings are NUL terminated */
162         if (VALID_STRING(Strings[i])) {
163             for (p = Strings[i]; p < table + size; p++)
164                 if (*p == '\0')
165                     break;
166             /* if there is no NUL, ignore the string */
167             if (p >= table + size)
168                 Strings[i] = ABSENT_STRING;
169         }
170     }
171 }
172
173 static int
174 fake_read(char *src, int *offset, int limit, char *dst, unsigned want)
175 {
176     int have = (limit - *offset);
177
178     if (have > 0) {
179         if ((int) want > have)
180             want = (unsigned) have;
181         memcpy(dst, src + *offset, (size_t) want);
182         *offset += (int) want;
183     } else {
184         want = 0;
185     }
186     return (int) want;
187 }
188
189 #define Read(buf, count) fake_read(buffer, &offset, limit, (char *) buf, (unsigned) count)
190
191 #define read_shorts(buf, count) \
192         (Read(buf, (count)*SIZEOF_SHORT) == (int) (count)*SIZEOF_SHORT)
193
194 #define read_numbers(buf, count) \
195         (Read(buf, (count)*(unsigned)size_of_numbers) == (int) (count)*size_of_numbers)
196
197 #define even_boundary(value) \
198     if ((value) % 2 != 0) Read(buf, 1)
199 #endif
200
201 NCURSES_EXPORT(void)
202 _nc_init_termtype(TERMTYPE2 *const tp)
203 {
204     unsigned i;
205
206 #if NCURSES_XNAMES
207     tp->num_Booleans = BOOLCOUNT;
208     tp->num_Numbers = NUMCOUNT;
209     tp->num_Strings = STRCOUNT;
210     tp->ext_Booleans = 0;
211     tp->ext_Numbers = 0;
212     tp->ext_Strings = 0;
213 #endif
214     if (tp->Booleans == 0)
215         TYPE_MALLOC(NCURSES_SBOOL, BOOLCOUNT, tp->Booleans);
216     if (tp->Numbers == 0)
217         TYPE_MALLOC(NCURSES_INT2, NUMCOUNT, tp->Numbers);
218     if (tp->Strings == 0)
219         TYPE_MALLOC(char *, STRCOUNT, tp->Strings);
220
221     for_each_boolean(i, tp)
222         tp->Booleans[i] = FALSE;
223
224     for_each_number(i, tp)
225         tp->Numbers[i] = ABSENT_NUMERIC;
226
227     for_each_string(i, tp)
228         tp->Strings[i] = ABSENT_STRING;
229 }
230
231 #if NCURSES_USE_DATABASE
232 #if NCURSES_XNAMES
233 static bool
234 valid_shorts(char *buffer, int limit)
235 {
236     bool result = FALSE;
237     int n;
238     for (n = 0; n < limit; ++n) {
239         if (MyNumber(buffer + (n * 2)) > 0) {
240             result = TRUE;
241             break;
242         }
243     }
244     return result;
245 }
246 #endif
247
248 /*
249  * Return TGETENT_YES if read, TGETENT_NO if not found or garbled.
250  */
251 NCURSES_EXPORT(int)
252 _nc_read_termtype(TERMTYPE2 *ptr, char *buffer, int limit)
253 {
254     int offset = 0;
255     int name_size, bool_count, num_count, str_count, str_size;
256     int i;
257     char buf[MAX_ENTRY_SIZE + 2];
258     char *string_table;
259     unsigned want, have;
260     size_t (*convert_numbers) (char *, NCURSES_INT2 *, int);
261     int size_of_numbers;
262     int max_entry_size = MAX_ENTRY_SIZE;
263
264     TR(TRACE_DATABASE,
265        (T_CALLED("_nc_read_termtype(ptr=%p, buffer=%p, limit=%d)"),
266         (void *) ptr, buffer, limit));
267
268     TR(TRACE_DATABASE, ("READ termtype header @%d", offset));
269
270     memset(ptr, 0, sizeof(*ptr));
271
272     /* grab the header */
273     if (!read_shorts(buf, 6)
274         || !IS_TIC_MAGIC(buf)) {
275         returnDB(TGETENT_NO);
276     }
277 #if NCURSES_EXT_NUMBERS
278     if (LOW_MSB(buf) == MAGIC2) {
279         convert_numbers = convert_32bits;
280         size_of_numbers = SIZEOF_INT2;
281     } else {
282         max_entry_size = MAX_ENTRY_SIZE1;
283         convert_numbers = convert_16bits;
284         size_of_numbers = SIZEOF_SHORT;
285     }
286 #else
287     if (LOW_MSB(buf) == MAGIC2) {
288         convert_numbers = convert_32bits;
289         size_of_numbers = SIZEOF_32BITS;
290     } else {
291         convert_numbers = convert_16bits;
292         size_of_numbers = SIZEOF_INT2;
293     }
294 #endif
295
296     /* *INDENT-EQLS* */
297     name_size  = MyNumber(buf + 2);
298     bool_count = MyNumber(buf + 4);
299     num_count  = MyNumber(buf + 6);
300     str_count  = MyNumber(buf + 8);
301     str_size   = MyNumber(buf + 10);
302
303     TR(TRACE_DATABASE,
304        ("TERMTYPE name_size=%d, bool=%d/%d, num=%d/%d str=%d/%d(%d)",
305         name_size, bool_count, BOOLCOUNT, num_count, NUMCOUNT,
306         str_count, STRCOUNT, str_size));
307     if (name_size < 0
308         || bool_count < 0
309         || num_count < 0
310         || str_count < 0
311         || str_size < 0) {
312         returnDB(TGETENT_NO);
313     }
314
315     want = (unsigned) (str_size + name_size + 1);
316     /* try to allocate space for the string table */
317     if (str_count * SIZEOF_SHORT >= max_entry_size
318         || (string_table = typeMalloc(char, want)) == 0) {
319         returnDB(TGETENT_NO);
320     }
321
322     /* grab the name (a null-terminated string) */
323     want = min(MAX_NAME_SIZE, (unsigned) name_size);
324     ptr->str_table = string_table;
325     ptr->term_names = string_table;
326     if ((have = (unsigned) Read(ptr->term_names, want)) != want) {
327         memset(ptr->term_names + have, 0, (size_t) (want - have));
328     }
329     ptr->term_names[want] = '\0';
330     string_table += (want + 1);
331
332     if (have > MAX_NAME_SIZE)
333         offset = (int) (have - MAX_NAME_SIZE);
334
335     /* grab the booleans */
336     if ((ptr->Booleans = TYPE_CALLOC(NCURSES_SBOOL,
337                                      max(BOOLCOUNT, bool_count))) == 0
338         || Read(ptr->Booleans, (unsigned) bool_count) < bool_count) {
339         returnDB(TGETENT_NO);
340     }
341
342     /*
343      * If booleans end on an odd byte, skip it.  The machine they
344      * originally wrote terminfo on must have been a 16-bit
345      * word-oriented machine that would trap out if you tried a
346      * word access off a 2-byte boundary.
347      */
348     even_boundary(name_size + bool_count);
349
350     /* grab the numbers */
351     if (!(ptr->Numbers = TYPE_CALLOC(NCURSES_INT2, max(NUMCOUNT, num_count)))
352         || !read_numbers(buf, num_count)) {
353         returnDB(TGETENT_NO);
354     }
355     convert_numbers(buf, ptr->Numbers, num_count);
356
357     if ((ptr->Strings = TYPE_CALLOC(char *, max(STRCOUNT, str_count))) == 0) {
358         returnDB(TGETENT_NO);
359     }
360
361     if (str_count) {
362         /* grab the string offsets */
363         if (!read_shorts(buf, str_count)) {
364             returnDB(TGETENT_NO);
365         }
366         /* finally, grab the string table itself */
367         if (Read(string_table, (unsigned) str_size) != str_size) {
368             returnDB(TGETENT_NO);
369         }
370         convert_strings(buf, ptr->Strings, str_count, str_size, string_table);
371     }
372 #if NCURSES_XNAMES
373
374     ptr->num_Booleans = BOOLCOUNT;
375     ptr->num_Numbers = NUMCOUNT;
376     ptr->num_Strings = STRCOUNT;
377
378     /*
379      * Read extended entries, if any, after the normal end of terminfo data.
380      */
381     even_boundary(str_size);
382     TR(TRACE_DATABASE, ("READ extended_header @%d", offset));
383     if (_nc_user_definable && read_shorts(buf, 5) && valid_shorts(buf, 5)) {
384         int ext_bool_count = MyNumber(buf + 0);
385         int ext_num_count = MyNumber(buf + 2);
386         int ext_str_count = MyNumber(buf + 4);
387         int ext_str_usage = MyNumber(buf + 6);
388         int ext_str_limit = MyNumber(buf + 8);
389         unsigned need = (unsigned) (ext_bool_count + ext_num_count + ext_str_count);
390         int base = 0;
391
392         if ((int) need >= (max_entry_size / 2)
393             || ext_str_usage >= max_entry_size
394             || ext_str_limit >= max_entry_size
395             || ext_bool_count < 0
396             || ext_num_count < 0
397             || ext_str_count < 0
398             || ext_str_usage < 0
399             || ext_str_limit < 0) {
400             returnDB(TGETENT_NO);
401         }
402
403         ptr->num_Booleans = UShort(BOOLCOUNT + ext_bool_count);
404         ptr->num_Numbers = UShort(NUMCOUNT + ext_num_count);
405         ptr->num_Strings = UShort(STRCOUNT + ext_str_count);
406
407         TYPE_REALLOC(NCURSES_SBOOL, ptr->num_Booleans, ptr->Booleans);
408         TYPE_REALLOC(NCURSES_INT2, ptr->num_Numbers, ptr->Numbers);
409         TYPE_REALLOC(char *, ptr->num_Strings, ptr->Strings);
410
411         TR(TRACE_DATABASE, ("extended header: "
412                             "bool %d, "
413                             "number %d, "
414                             "string %d(%d:%d)",
415                             ext_bool_count,
416                             ext_num_count,
417                             ext_str_count,
418                             ext_str_usage,
419                             ext_str_limit));
420
421         TR(TRACE_DATABASE, ("READ %d extended-booleans @%d",
422                             ext_bool_count, offset));
423         if ((ptr->ext_Booleans = UShort(ext_bool_count)) != 0) {
424             if (Read(ptr->Booleans + BOOLCOUNT, (unsigned)
425                      ext_bool_count) != ext_bool_count) {
426                 returnDB(TGETENT_NO);
427             }
428         }
429         even_boundary(ext_bool_count);
430
431         TR(TRACE_DATABASE, ("READ %d extended-numbers @%d",
432                             ext_num_count, offset));
433         if ((ptr->ext_Numbers = UShort(ext_num_count)) != 0) {
434             if (!read_numbers(buf, ext_num_count)) {
435                 returnDB(TGETENT_NO);
436             }
437             TR(TRACE_DATABASE, ("Before converting extended-numbers"));
438             convert_numbers(buf, ptr->Numbers + NUMCOUNT, ext_num_count);
439         }
440
441         TR(TRACE_DATABASE, ("READ extended-offsets @%d", offset));
442         if ((ext_str_count + (int) need) >= (max_entry_size / 2)) {
443             returnDB(TGETENT_NO);
444         }
445         if ((ext_str_count || need)
446             && !read_shorts(buf, ext_str_count + (int) need)) {
447             returnDB(TGETENT_NO);
448         }
449
450         TR(TRACE_DATABASE, ("READ %d bytes of extended-strings @%d",
451                             ext_str_limit, offset));
452
453         if (ext_str_limit) {
454             ptr->ext_str_table = typeMalloc(char, (size_t) ext_str_limit);
455             if (ptr->ext_str_table == 0) {
456                 returnDB(TGETENT_NO);
457             }
458             if (Read(ptr->ext_str_table, (unsigned) ext_str_limit) != ext_str_limit) {
459                 returnDB(TGETENT_NO);
460             }
461             TR(TRACE_DATABASE, ("first extended-string is %s", _nc_visbuf(ptr->ext_str_table)));
462         }
463
464         if ((ptr->ext_Strings = UShort(ext_str_count)) != 0) {
465             int check = (ext_bool_count + ext_num_count + ext_str_count);
466
467             TR(TRACE_DATABASE,
468                ("Before computing extended-string capabilities "
469                 "str_count=%d, ext_str_count=%d",
470                 str_count, ext_str_count));
471             convert_strings(buf, ptr->Strings + str_count, ext_str_count,
472                             ext_str_limit, ptr->ext_str_table);
473             for (i = ext_str_count - 1; i >= 0; i--) {
474                 TR(TRACE_DATABASE, ("MOVE from [%d:%d] %s",
475                                     i, i + str_count,
476                                     _nc_visbuf(ptr->Strings[i + str_count])));
477                 ptr->Strings[i + STRCOUNT] = ptr->Strings[i + str_count];
478                 if (VALID_STRING(ptr->Strings[i + STRCOUNT])) {
479                     base += (int) (strlen(ptr->Strings[i + STRCOUNT]) + 1);
480                     ++check;
481                 }
482                 TR(TRACE_DATABASE, ("... to    [%d] %s",
483                                     i + STRCOUNT,
484                                     _nc_visbuf(ptr->Strings[i + STRCOUNT])));
485             }
486             TR(TRACE_DATABASE, ("Check table-size: %d/%d", check, ext_str_usage));
487 #if 0
488             /*
489              * Phasing in a proper check will be done "later".
490              */
491             if (check != ext_str_usage)
492                 returnDB(TGETENT_NO);
493 #endif
494         }
495
496         if (need) {
497             if (ext_str_count >= (max_entry_size / 2)) {
498                 returnDB(TGETENT_NO);
499             }
500             if ((ptr->ext_Names = TYPE_CALLOC(char *, need)) == 0) {
501                 returnDB(TGETENT_NO);
502             }
503             TR(TRACE_DATABASE,
504                ("ext_NAMES starting @%d in extended_strings, first = %s",
505                 base, _nc_visbuf(ptr->ext_str_table + base)));
506             convert_strings(buf + (2 * ext_str_count),
507                             ptr->ext_Names,
508                             (int) need,
509                             ext_str_limit, ptr->ext_str_table + base);
510         }
511
512         TR(TRACE_DATABASE,
513            ("...done reading terminfo bool %d(%d) num %d(%d) str %d(%d)",
514             ptr->num_Booleans, ptr->ext_Booleans,
515             ptr->num_Numbers, ptr->ext_Numbers,
516             ptr->num_Strings, ptr->ext_Strings));
517
518         TR(TRACE_DATABASE, ("extend: num_Booleans:%d", ptr->num_Booleans));
519     } else
520 #endif /* NCURSES_XNAMES */
521     {
522         TR(TRACE_DATABASE, ("...done reading terminfo bool %d num %d str %d",
523                             bool_count, num_count, str_count));
524 #if NCURSES_XNAMES
525         TR(TRACE_DATABASE, ("normal: num_Booleans:%d", ptr->num_Booleans));
526 #endif
527     }
528
529     for (i = bool_count; i < BOOLCOUNT; i++)
530         ptr->Booleans[i] = FALSE;
531     for (i = num_count; i < NUMCOUNT; i++)
532         ptr->Numbers[i] = ABSENT_NUMERIC;
533     for (i = str_count; i < STRCOUNT; i++)
534         ptr->Strings[i] = ABSENT_STRING;
535
536     returnDB(TGETENT_YES);
537 }
538
539 /*
540  *      int
541  *      _nc_read_file_entry(filename, ptr)
542  *
543  *      Read the compiled terminfo entry in the given file into the
544  *      structure pointed to by ptr, allocating space for the string
545  *      table.
546  */
547 NCURSES_EXPORT(int)
548 _nc_read_file_entry(const char *const filename, TERMTYPE2 *ptr)
549 /* return 1 if read, 0 if not found or garbled */
550 {
551     FILE *fp = 0;
552     int code;
553
554     if (_nc_access(filename, R_OK) < 0
555         || (fp = safe_fopen(filename, BIN_R)) == 0) {
556         TR(TRACE_DATABASE, ("cannot open terminfo %s (errno=%d)", filename, errno));
557         code = TGETENT_NO;
558     } else {
559         int limit;
560         char buffer[MAX_ENTRY_SIZE + 1];
561
562         if ((limit = (int) fread(buffer, sizeof(char), sizeof(buffer), fp))
563             > 0) {
564
565             TR(TRACE_DATABASE, ("read terminfo %s", filename));
566             if ((code = _nc_read_termtype(ptr, buffer, limit)) == TGETENT_NO) {
567                 _nc_free_termtype2(ptr);
568             }
569         } else {
570             code = TGETENT_NO;
571         }
572         fclose(fp);
573     }
574
575     return (code);
576 }
577
578 #if USE_HASHED_DB
579 /*
580  * Return if if we can build the filename of a ".db" file.
581  */
582 static bool
583 make_db_filename(char *filename, unsigned limit, const char *const path)
584 {
585     static const char suffix[] = DBM_SUFFIX;
586
587     size_t lens = sizeof(suffix) - 1;
588     size_t size = strlen(path);
589     size_t test = lens + size;
590     bool result = FALSE;
591
592     if (test < limit) {
593         if (size >= lens
594             && !strcmp(path + size - lens, suffix))
595             _nc_STRCPY(filename, path, limit);
596         else
597             _nc_SPRINTF(filename, _nc_SLIMIT(limit) "%s%s", path, suffix);
598         result = TRUE;
599     }
600     return result;
601 }
602 #endif
603
604 /*
605  * Return true if we can build the name of a filesystem entry.
606  */
607 static bool
608 make_dir_filename(char *filename,
609                   unsigned limit,
610                   const char *const path,
611                   const char *name)
612 {
613     bool result = FALSE;
614
615 #if NCURSES_USE_TERMCAP
616     if (_nc_is_dir_path(path))
617 #endif
618     {
619         unsigned need = (unsigned) (LEAF_LEN + 3 + strlen(path) + strlen(name));
620
621         if (need <= limit) {
622             _nc_SPRINTF(filename, _nc_SLIMIT(limit)
623                         "%s/" LEAF_FMT "/%s", path, *name, name);
624             result = TRUE;
625         }
626     }
627     return result;
628 }
629
630 static int
631 lookup_b64(int *target, const char **source)
632 {
633     int result = 3;
634     int j;
635     /*
636      * ncurses' quickdump writes only RFC 4648 "url/filename-safe" encoding,
637      * but accepts RFC-3548
638      */
639     for (j = 0; j < 4; ++j) {
640         int ch = UChar(**source);
641         *source += 1;
642         if (ch >= 'A' && ch <= 'Z') {
643             target[j] = (ch - 'A');
644         } else if (ch >= 'a' && ch <= 'z') {
645             target[j] = 26 + (ch - 'a');
646         } else if (ch >= '0' && ch <= '9') {
647             target[j] = 52 + (ch - '0');
648         } else if (ch == '-' || ch == '+') {
649             target[j] = 62;
650         } else if (ch == '_' || ch == '/') {
651             target[j] = 63;
652         } else if (ch == '=') {
653             target[j] = 64;
654             result--;
655         } else {
656             result = -1;
657             break;
658         }
659     }
660     return result;
661 }
662
663 static int
664 decode_hex(const char **source)
665 {
666     int result = 0;
667     int nibble;
668
669     for (nibble = 0; nibble < 2; ++nibble) {
670         int ch = UChar(**source);
671         result <<= 4;
672         *source += 1;
673         if (ch >= '0' && ch <= '9') {
674             ch -= '0';
675         } else if (ch >= 'A' && ch <= 'F') {
676             ch -= 'A';
677             ch += 10;
678         } else if (ch >= 'a' && ch <= 'f') {
679             ch -= 'a';
680             ch += 10;
681         } else {
682             result = -1;
683             break;
684         }
685         result |= ch;
686     }
687     return result;
688 }
689
690 static int
691 decode_quickdump(char *target, const char *source)
692 {
693     char *base = target;
694     int result = 0;
695
696     if (!strncmp(source, "b64:", (size_t) 4)) {
697         source += 4;
698         while (*source != '\0') {
699             int bits[4];
700             int ch = lookup_b64(bits, &source);
701             if (ch < 0 || (ch + target - base) >= MAX_ENTRY_SIZE) {
702                 result = 0;
703                 break;
704             }
705             result += ch;
706             *target++ = (char) ((bits[0] << 2) | (bits[1] >> 4));
707             if (bits[2] < 64) {
708                 *target++ = (char) ((bits[1] << 4) | (bits[2] >> 2));
709                 if (bits[3] < 64) {
710                     *target++ = (char) ((bits[2] << 6) | bits[3]);
711                 }
712             }
713         }
714     } else if (!strncmp(source, "hex:", (size_t) 4)) {
715         source += 4;
716         while (*source != '\0') {
717             int ch = decode_hex(&source);
718             if (ch < 0 || (target - base) >= MAX_ENTRY_SIZE) {
719                 result = 0;
720                 break;
721             }
722             *target++ = (char) ch;
723             ++result;
724         }
725     }
726     return result;
727 }
728
729 /*
730  * Build a terminfo pathname and try to read the data.  Returns TGETENT_YES on
731  * success, TGETENT_NO on failure.
732  */
733 static int
734 _nc_read_tic_entry(char *filename,
735                    unsigned limit,
736                    const char *const path,
737                    const char *name,
738                    TERMTYPE2 *const tp)
739 {
740     int code = TGETENT_NO;
741 #if USE_HASHED_DB
742     DB *capdbp;
743 #endif
744     char buffer[MAX_ENTRY_SIZE + 1];
745     int used;
746
747     TR(TRACE_DATABASE,
748        (T_CALLED("_nc_read_tic_entry(file=%p, path=%s, name=%s)"),
749         filename, path, name));
750
751     assert(TGETENT_YES == TRUE);        /* simplify call for _nc_name_match */
752
753     if ((used = decode_quickdump(buffer, path)) != 0
754         && (code = _nc_read_termtype(tp, buffer, used)) == TGETENT_YES
755         && (code = _nc_name_match(tp->term_names, name, "|")) == TGETENT_YES) {
756         TR(TRACE_DATABASE, ("loaded quick-dump for %s", name));
757         /* shorten name shown by infocmp */
758         _nc_STRCPY(filename, "$TERMINFO", limit);
759     } else
760 #if USE_HASHED_DB
761         if (make_db_filename(filename, limit, path)
762             && (capdbp = _nc_db_open(filename, FALSE)) != 0) {
763
764         DBT key, data;
765         int reccnt = 0;
766         char *save = strdup(name);
767
768         memset(&key, 0, sizeof(key));
769         key.data = save;
770         key.size = strlen(save);
771
772         /*
773          * This lookup could return termcap data, which we do not want.  We are
774          * looking for compiled (binary) terminfo data.
775          *
776          * cgetent uses a two-level lookup.  On the first it uses the given
777          * name to return a record containing only the aliases for an entry.
778          * On the second (using that list of aliases as a key), it returns the
779          * content of the terminal description.  We expect second lookup to
780          * return data beginning with the same set of aliases.
781          *
782          * For compiled terminfo, the list of aliases in the second case will
783          * be null-terminated.  A termcap entry will not be, and will run on
784          * into the description.  So we can easily distinguish between the two
785          * (source/binary) by checking the lengths.
786          */
787         while (_nc_db_get(capdbp, &key, &data) == 0) {
788             char *have = (char *) data.data;
789             used = (int) data.size - 1;
790
791             if (*have++ == 0) {
792                 if (data.size > key.size
793                     && IS_TIC_MAGIC(have)) {
794                     code = _nc_read_termtype(tp, have, used);
795                     if (code == TGETENT_NO) {
796                         _nc_free_termtype2(tp);
797                     }
798                 }
799                 break;
800             }
801
802             /*
803              * Just in case we have a corrupt database, do not waste time with
804              * it.
805              */
806             if (++reccnt >= 3)
807                 break;
808
809             /*
810              * Prepare for the second level.
811              */
812             key.data = have;
813             key.size = used;
814         }
815
816         free(save);
817     } else                      /* may be either filesystem or flat file */
818 #endif
819     if (make_dir_filename(filename, limit, path, name)) {
820         code = _nc_read_file_entry(filename, tp);
821     }
822 #if NCURSES_USE_TERMCAP
823     if (code != TGETENT_YES) {
824         code = _nc_read_termcap_entry(name, tp);
825         _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
826                     "%.*s", PATH_MAX - 1, _nc_get_source());
827     }
828 #endif
829     returnDB(code);
830 }
831 #endif /* NCURSES_USE_DATABASE */
832
833 /*
834  * Find and read the compiled entry for a given terminal type, if it exists.
835  * We take pains here to make sure no combination of environment variables and
836  * terminal type name can be used to overrun the file buffer.
837  */
838 NCURSES_EXPORT(int)
839 _nc_read_entry2(const char *const name, char *const filename, TERMTYPE2 *const tp)
840 {
841     int code = TGETENT_NO;
842
843     if (name == 0)
844         return _nc_read_entry2("", filename, tp);
845
846     _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
847                 "%.*s", PATH_MAX - 1, name);
848
849     if (strlen(name) == 0
850         || strcmp(name, ".") == 0
851         || strcmp(name, "..") == 0
852         || _nc_pathlast(name) != 0
853         || strchr(name, NCURSES_PATHSEP) != 0) {
854         TR(TRACE_DATABASE, ("illegal or missing entry name '%s'", name));
855     } else {
856 #if NCURSES_USE_DATABASE
857         DBDIRS state;
858         int offset;
859         const char *path;
860
861         _nc_first_db(&state, &offset);
862         code = TGETENT_ERR;
863         while ((path = _nc_next_db(&state, &offset)) != 0) {
864             code = _nc_read_tic_entry(filename, PATH_MAX, path, name, tp);
865             if (code == TGETENT_YES) {
866                 _nc_last_db();
867                 break;
868             }
869         }
870 #elif NCURSES_USE_TERMCAP
871         if (code != TGETENT_YES) {
872             code = _nc_read_termcap_entry(name, tp);
873             _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
874                         "%.*s", PATH_MAX - 1, _nc_get_source());
875         }
876 #endif
877     }
878     return code;
879 }
880
881 #if NCURSES_EXT_NUMBERS
882 /*
883  * This entrypoint is used by tack 1.07
884  */
885 NCURSES_EXPORT(int)
886 _nc_read_entry(const char *const name, char *const filename, TERMTYPE *const tp)
887 {
888     TERMTYPE2 dummy;
889     int rc;
890     rc = _nc_read_entry2(name, filename, &dummy);
891     if (rc == TGETENT_YES)
892         _nc_export_termtype2(tp, &dummy);
893     return rc;
894 }
895 #endif