4ff8cc48bf48ed002352aa3bf2311f2ff528015e
[ncurses.git] / ncurses / tinfo / read_entry.c
1 /****************************************************************************
2  * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  *     and: Thomas E. Dickey                        1996-on                 *
33  ****************************************************************************/
34
35 /*
36  *      read_entry.c -- Routine for reading in a compiled terminfo file
37  */
38
39 #include <curses.priv.h>
40 #include <hashed_db.h>
41
42 #include <tic.h>
43
44 MODULE_ID("$Id: read_entry.c,v 1.111 2011/09/24 20:15:12 tom Exp $")
45
46 #define TYPE_CALLOC(type,elts) typeCalloc(type, (unsigned)(elts))
47
48 #if USE_DATABASE
49 static void
50 convert_shorts(char *buf, short *Numbers, int count)
51 {
52     int i;
53     for (i = 0; i < count; i++) {
54         if (IS_NEG1(buf + 2 * i))
55             Numbers[i] = ABSENT_NUMERIC;
56         else if (IS_NEG2(buf + 2 * i))
57             Numbers[i] = CANCELLED_NUMERIC;
58         else
59             Numbers[i] = (short) LOW_MSB(buf + 2 * i);
60         TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
61     }
62 }
63
64 static void
65 convert_strings(char *buf, char **Strings, int count, int size, char *table)
66 {
67     int i;
68     char *p;
69
70     for (i = 0; i < count; i++) {
71         if (IS_NEG1(buf + 2 * i)) {
72             Strings[i] = ABSENT_STRING;
73         } else if (IS_NEG2(buf + 2 * i)) {
74             Strings[i] = CANCELLED_STRING;
75         } else if ((int) LOW_MSB(buf + 2 * i) > size) {
76             Strings[i] = ABSENT_STRING;
77         } else {
78             Strings[i] = (LOW_MSB(buf + 2 * i) + table);
79             TR(TRACE_DATABASE, ("Strings[%d] = %s", i, _nc_visbuf(Strings[i])));
80         }
81
82         /* make sure all strings are NUL terminated */
83         if (VALID_STRING(Strings[i])) {
84             for (p = Strings[i]; p <= table + size; p++)
85                 if (*p == '\0')
86                     break;
87             /* if there is no NUL, ignore the string */
88             if (p > table + size)
89                 Strings[i] = ABSENT_STRING;
90         }
91     }
92 }
93
94 static int
95 fake_read(char *src, int *offset, int limit, char *dst, unsigned want)
96 {
97     int have = (limit - *offset);
98
99     if (have > 0) {
100         if ((int) want > have)
101             want = (unsigned) have;
102         memcpy(dst, src + *offset, want);
103         *offset += (int) want;
104     } else {
105         want = 0;
106     }
107     return (int) want;
108 }
109
110 #define Read(buf, count) fake_read(buffer, &offset, limit, buf, count)
111
112 #define read_shorts(buf, count) \
113         (Read(buf, (unsigned) (count)*2) == (int) (count)*2)
114
115 #define even_boundary(value) \
116     if ((value) % 2 != 0) Read(buf, 1)
117
118 /*
119  * Return TGETENT_YES if read, TGETENT_NO if not found or garbled.
120  */
121 NCURSES_EXPORT(int)
122 _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
123 {
124     int offset = 0;
125     int name_size, bool_count, num_count, str_count, str_size;
126     int i;
127     char buf[MAX_ENTRY_SIZE + 1];
128     char *string_table;
129     unsigned want, have;
130
131     TR(TRACE_DATABASE, ("READ termtype header @%d", offset));
132
133     memset(ptr, 0, sizeof(*ptr));
134
135     /* grab the header */
136     if (!read_shorts(buf, 6)
137         || !IS_TIC_MAGIC(buf)) {
138         return (TGETENT_NO);
139     }
140
141     name_size = LOW_MSB(buf + 2);
142     bool_count = LOW_MSB(buf + 4);
143     num_count = LOW_MSB(buf + 6);
144     str_count = LOW_MSB(buf + 8);
145     str_size = LOW_MSB(buf + 10);
146
147     TR(TRACE_DATABASE,
148        ("TERMTYPE name_size=%d, bool=%d/%d, num=%d/%d str=%d/%d(%d)",
149         name_size, bool_count, BOOLCOUNT, num_count, NUMCOUNT,
150         str_count, STRCOUNT, str_size));
151     if (name_size < 0
152         || bool_count < 0
153         || num_count < 0
154         || str_count < 0
155         || str_size < 0) {
156         return (TGETENT_NO);
157     }
158
159     want = (unsigned) (str_size + name_size + 1);
160     if (str_size) {
161         /* try to allocate space for the string table */
162         if (str_count * 2 >= (int) sizeof(buf)
163             || (string_table = typeMalloc(char, want)) == 0) {
164             return (TGETENT_NO);
165         }
166     } else {
167         str_count = 0;
168         if ((string_table = typeMalloc(char, want)) == 0) {
169             return (TGETENT_NO);
170         }
171     }
172
173     /* grab the name (a null-terminated string) */
174     want = min(MAX_NAME_SIZE, (unsigned) name_size);
175     ptr->str_table = string_table;
176     ptr->term_names = string_table;
177     if ((have = (unsigned) Read(ptr->term_names, want)) != want) {
178         memset(ptr->term_names + have, 0, want - have);
179     }
180     ptr->term_names[want] = '\0';
181     string_table += (want + 1);
182
183     if (have > MAX_NAME_SIZE)
184         offset = (int) (have - MAX_NAME_SIZE);
185
186     /* grab the booleans */
187     if ((ptr->Booleans = TYPE_CALLOC(NCURSES_SBOOL,
188                                      max(BOOLCOUNT, bool_count))) == 0
189         || Read(ptr->Booleans, (unsigned) bool_count) < bool_count) {
190         return (TGETENT_NO);
191     }
192
193     /*
194      * If booleans end on an odd byte, skip it.  The machine they
195      * originally wrote terminfo on must have been a 16-bit
196      * word-oriented machine that would trap out if you tried a
197      * word access off a 2-byte boundary.
198      */
199     even_boundary(name_size + bool_count);
200
201     /* grab the numbers */
202     if ((ptr->Numbers = TYPE_CALLOC(short, max(NUMCOUNT, num_count))) == 0
203         || !read_shorts(buf, num_count)) {
204         return (TGETENT_NO);
205     }
206     convert_shorts(buf, ptr->Numbers, num_count);
207
208     if ((ptr->Strings = TYPE_CALLOC(char *, max(STRCOUNT, str_count))) == 0)
209           return (TGETENT_NO);
210
211     if (str_count) {
212         /* grab the string offsets */
213         if (!read_shorts(buf, str_count)) {
214             return (TGETENT_NO);
215         }
216         /* finally, grab the string table itself */
217         if (Read(string_table, (unsigned) str_size) != str_size)
218             return (TGETENT_NO);
219         convert_strings(buf, ptr->Strings, str_count, str_size, string_table);
220     }
221 #if NCURSES_XNAMES
222
223     ptr->num_Booleans = BOOLCOUNT;
224     ptr->num_Numbers = NUMCOUNT;
225     ptr->num_Strings = STRCOUNT;
226
227     /*
228      * Read extended entries, if any, after the normal end of terminfo data.
229      */
230     even_boundary(str_size);
231     TR(TRACE_DATABASE, ("READ extended_header @%d", offset));
232     if (_nc_user_definable && read_shorts(buf, 5)) {
233         int ext_bool_count = LOW_MSB(buf + 0);
234         int ext_num_count = LOW_MSB(buf + 2);
235         int ext_str_count = LOW_MSB(buf + 4);
236         int ext_str_size = LOW_MSB(buf + 6);
237         int ext_str_limit = LOW_MSB(buf + 8);
238         unsigned need = (unsigned) (ext_bool_count + ext_num_count + ext_str_count);
239         int base = 0;
240
241         if (need >= sizeof(buf)
242             || ext_str_size >= (int) sizeof(buf)
243             || ext_str_limit >= (int) sizeof(buf)
244             || ext_bool_count < 0
245             || ext_num_count < 0
246             || ext_str_count < 0
247             || ext_str_size < 0
248             || ext_str_limit < 0)
249             return (TGETENT_NO);
250
251         ptr->num_Booleans = UShort(BOOLCOUNT + ext_bool_count);
252         ptr->num_Numbers = UShort(NUMCOUNT + ext_num_count);
253         ptr->num_Strings = UShort(STRCOUNT + ext_str_count);
254
255         ptr->Booleans = typeRealloc(NCURSES_SBOOL, ptr->num_Booleans, ptr->Booleans);
256         ptr->Numbers = typeRealloc(short, ptr->num_Numbers, ptr->Numbers);
257         ptr->Strings = typeRealloc(char *, ptr->num_Strings, ptr->Strings);
258
259         TR(TRACE_DATABASE, ("extended header is %d/%d/%d(%d:%d)",
260                             ext_bool_count, ext_num_count, ext_str_count,
261                             ext_str_size, ext_str_limit));
262
263         TR(TRACE_DATABASE, ("READ %d extended-booleans @%d",
264                             ext_bool_count, offset));
265         if ((ptr->ext_Booleans = UShort(ext_bool_count)) != 0) {
266             if (Read(ptr->Booleans + BOOLCOUNT, (unsigned)
267                      ext_bool_count) != ext_bool_count)
268                 return (TGETENT_NO);
269         }
270         even_boundary(ext_bool_count);
271
272         TR(TRACE_DATABASE, ("READ %d extended-numbers @%d",
273                             ext_num_count, offset));
274         if ((ptr->ext_Numbers = UShort(ext_num_count)) != 0) {
275             if (!read_shorts(buf, ext_num_count))
276                 return (TGETENT_NO);
277             TR(TRACE_DATABASE, ("Before converting extended-numbers"));
278             convert_shorts(buf, ptr->Numbers + NUMCOUNT, ext_num_count);
279         }
280
281         TR(TRACE_DATABASE, ("READ extended-offsets @%d", offset));
282         if ((ext_str_count || need)
283             && !read_shorts(buf, ext_str_count + (int) need))
284             return (TGETENT_NO);
285
286         TR(TRACE_DATABASE, ("READ %d bytes of extended-strings @%d",
287                             ext_str_limit, offset));
288
289         if (ext_str_limit) {
290             ptr->ext_str_table = typeMalloc(char, (size_t) ext_str_limit);
291             if (ptr->ext_str_table == 0)
292                 return (TGETENT_NO);
293             if (Read(ptr->ext_str_table, (unsigned) ext_str_limit) != ext_str_limit)
294                 return (TGETENT_NO);
295             TR(TRACE_DATABASE, ("first extended-string is %s", _nc_visbuf(ptr->ext_str_table)));
296         }
297
298         if ((ptr->ext_Strings = UShort(ext_str_count)) != 0) {
299             TR(TRACE_DATABASE,
300                ("Before computing extended-string capabilities str_count=%d, ext_str_count=%d",
301                 str_count, ext_str_count));
302             convert_strings(buf, ptr->Strings + str_count, ext_str_count,
303                             ext_str_limit, ptr->ext_str_table);
304             for (i = ext_str_count - 1; i >= 0; i--) {
305                 TR(TRACE_DATABASE, ("MOVE from [%d:%d] %s",
306                                     i, i + str_count,
307                                     _nc_visbuf(ptr->Strings[i + str_count])));
308                 ptr->Strings[i + STRCOUNT] = ptr->Strings[i + str_count];
309                 if (VALID_STRING(ptr->Strings[i + STRCOUNT]))
310                     base += (int) (strlen(ptr->Strings[i + STRCOUNT]) + 1);
311                 TR(TRACE_DATABASE, ("... to    [%d] %s",
312                                     i + STRCOUNT,
313                                     _nc_visbuf(ptr->Strings[i + STRCOUNT])));
314             }
315         }
316
317         if (need) {
318             if (ext_str_count >= (MAX_ENTRY_SIZE * 2))
319                 return (TGETENT_NO);
320             if ((ptr->ext_Names = TYPE_CALLOC(char *, need)) == 0)
321                   return (TGETENT_NO);
322             TR(TRACE_DATABASE,
323                ("ext_NAMES starting @%d in extended_strings, first = %s",
324                 base, _nc_visbuf(ptr->ext_str_table + base)));
325             convert_strings(buf + (2 * ext_str_count),
326                             ptr->ext_Names,
327                             (int) need,
328                             ext_str_limit, ptr->ext_str_table + base);
329         }
330
331         T(("...done reading terminfo bool %d(%d) num %d(%d) str %d(%d)",
332            ptr->num_Booleans, ptr->ext_Booleans,
333            ptr->num_Numbers, ptr->ext_Numbers,
334            ptr->num_Strings, ptr->ext_Strings));
335
336         TR(TRACE_DATABASE, ("extend: num_Booleans:%d", ptr->num_Booleans));
337     } else
338 #endif /* NCURSES_XNAMES */
339     {
340         T(("...done reading terminfo bool %d num %d str %d",
341            bool_count, num_count, str_count));
342 #if NCURSES_XNAMES
343         TR(TRACE_DATABASE, ("normal: num_Booleans:%d", ptr->num_Booleans));
344 #endif
345     }
346
347     for (i = bool_count; i < BOOLCOUNT; i++)
348         ptr->Booleans[i] = FALSE;
349     for (i = num_count; i < NUMCOUNT; i++)
350         ptr->Numbers[i] = ABSENT_NUMERIC;
351     for (i = str_count; i < STRCOUNT; i++)
352         ptr->Strings[i] = ABSENT_STRING;
353
354     return (TGETENT_YES);
355 }
356
357 /*
358  *      int
359  *      _nc_read_file_entry(filename, ptr)
360  *
361  *      Read the compiled terminfo entry in the given file into the
362  *      structure pointed to by ptr, allocating space for the string
363  *      table.
364  */
365 NCURSES_EXPORT(int)
366 _nc_read_file_entry(const char *const filename, TERMTYPE *ptr)
367 /* return 1 if read, 0 if not found or garbled */
368 {
369     FILE *fp = 0;
370     int code;
371     int limit;
372     char buffer[MAX_ENTRY_SIZE + 1];
373
374     if (_nc_access(filename, R_OK) < 0
375         || (fp = fopen(filename, "rb")) == 0) {
376         T(("cannot open terminfo %s (errno=%d)", filename, errno));
377         code = TGETENT_NO;
378     } else {
379         if ((limit = (int) fread(buffer, sizeof(char), sizeof(buffer), fp))
380             > 0) {
381
382             T(("read terminfo %s", filename));
383             if ((code = _nc_read_termtype(ptr, buffer, limit)) == TGETENT_NO) {
384                 _nc_free_termtype(ptr);
385             }
386         } else {
387             code = TGETENT_NO;
388         }
389         fclose(fp);
390     }
391
392     return (code);
393 }
394
395 #if USE_HASHED_DB
396 /*
397  * Return if if we can build the filename of a ".db" file.
398  */
399 static bool
400 make_db_filename(char *filename, unsigned limit, const char *const path)
401 {
402     static const char suffix[] = DBM_SUFFIX;
403
404     unsigned lens = sizeof(suffix) - 1;
405     unsigned size = strlen(path);
406     unsigned test = lens + size;
407     bool result = FALSE;
408
409     if (test < limit) {
410         if (size >= lens
411             && !strcmp(path + size - lens, suffix))
412             (void) strcpy(filename, path);
413         else
414             (void) sprintf(filename, "%s%s", path, suffix);
415         result = TRUE;
416     }
417     return result;
418 }
419 #endif
420
421 /*
422  * Return true if we can build the name of a filesystem entry.
423  */
424 static bool
425 make_dir_filename(char *filename,
426                   unsigned limit,
427                   const char *const path,
428                   const char *name)
429 {
430     unsigned need = (unsigned) (LEAF_LEN + 3 + strlen(path) + strlen(name));
431     bool result = FALSE;
432
433     if (need <= limit) {
434         (void) sprintf(filename, "%s/" LEAF_FMT "/%s", path, *name, name);
435         result = TRUE;
436     }
437     return result;
438 }
439
440 /*
441  * Build a terminfo pathname and try to read the data.  Returns TGETENT_YES on
442  * success, TGETENT_NO on failure.
443  */
444 static int
445 _nc_read_tic_entry(char *filename,
446                    unsigned limit,
447                    const char *const path,
448                    const char *name,
449                    TERMTYPE *const tp)
450 {
451     int code = TGETENT_NO;
452
453 #if USE_HASHED_DB
454     DB *capdbp;
455
456     if (make_db_filename(filename, limit, path)
457         && (capdbp = _nc_db_open(filename, FALSE)) != 0) {
458
459         DBT key, data;
460         int reccnt = 0;
461         char *save = strdup(name);
462
463         memset(&key, 0, sizeof(key));
464         key.data = save;
465         key.size = strlen(save);
466
467         /*
468          * This lookup could return termcap data, which we do not want.  We are
469          * looking for compiled (binary) terminfo data.
470          *
471          * cgetent uses a two-level lookup.  On the first it uses the given
472          * name to return a record containing only the aliases for an entry. 
473          * On the second (using that list of aliases as a key), it returns the
474          * content of the terminal description.  We expect second lookup to
475          * return data beginning with the same set of aliases.
476          *
477          * For compiled terminfo, the list of aliases in the second case will
478          * be null-terminated.  A termcap entry will not be, and will run on
479          * into the description.  So we can easily distinguish between the two
480          * (source/binary) by checking the lengths.
481          */
482         while (_nc_db_get(capdbp, &key, &data) == 0) {
483             int used = data.size - 1;
484             char *have = (char *) data.data;
485
486             if (*have++ == 0) {
487                 if (data.size > key.size
488                     && IS_TIC_MAGIC(have)) {
489                     code = _nc_read_termtype(tp, have, used);
490                     if (code == TGETENT_NO) {
491                         _nc_free_termtype(tp);
492                     }
493                 }
494                 break;
495             }
496
497             /*
498              * Just in case we have a corrupt database, do not waste time with
499              * it.
500              */
501             if (++reccnt >= 3)
502                 break;
503
504             /*
505              * Prepare for the second level.
506              */
507             key.data = have;
508             key.size = used;
509         }
510
511         free(save);
512     } else                      /* may be either filesystem or flat file */
513 #endif
514     if (make_dir_filename(filename, limit, path, name)) {
515         code = _nc_read_file_entry(filename, tp);
516     }
517 #if USE_TERMCAP
518     if (code != TGETENT_YES) {
519         code = _nc_read_termcap_entry(name, tp);
520         sprintf(filename, "%.*s", PATH_MAX - 1, _nc_get_source());
521     }
522 #endif
523     return code;
524 }
525 #endif /* USE_DATABASE */
526
527 /*
528  *      _nc_read_entry(char *name, char *filename, TERMTYPE *tp)
529  *
530  *      Find and read the compiled entry for a given terminal type,
531  *      if it exists.  We take pains here to make sure no combination
532  *      of environment variables and terminal type name can be used to
533  *      overrun the file buffer.
534  */
535
536 NCURSES_EXPORT(int)
537 _nc_read_entry(const char *const name, char *const filename, TERMTYPE *const tp)
538 {
539     int code = TGETENT_NO;
540
541     sprintf(filename, "%.*s", PATH_MAX - 1, name);
542     if (strlen(name) == 0
543         || strcmp(name, ".") == 0
544         || strcmp(name, "..") == 0
545         || _nc_pathlast(name) != 0
546         || strchr(name, NCURSES_PATHSEP) != 0) {
547         T(("illegal or missing entry name '%s'", name));
548     } else {
549 #if USE_DATABASE
550         DBDIRS state = dbdTIC;
551         int offset = 0;
552         const char *path;
553
554         while ((path = _nc_next_db(&state, &offset)) != 0) {
555             code = _nc_read_tic_entry(filename, PATH_MAX, path, name, tp);
556             if (code == TGETENT_YES) {
557                 _nc_last_db();
558                 break;
559             }
560         }
561 #elif USE_TERMCAP
562         if (code != TGETENT_YES) {
563             code = _nc_read_termcap_entry(name, tp);
564             sprintf(filename, "%.*s", PATH_MAX - 1, _nc_get_source());
565         }
566 #endif
567     }
568     return code;
569 }