ncurses/tinfo/read_entry.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2018,2019 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.155 2019/07/20 20:23:11 tom Exp $")
  45
  46 #define TYPE_CALLOC(type,elts) typeCalloc(type, (unsigned)(elts))
  47
  48 #define MyNumber(n) (short) LOW_MSB(n)
  49
  50 #define SIZEOF_32BITS 4
  51
  52 #if NCURSES_USE_DATABASE
  53 #if NCURSES_EXT_NUMBERS
  54 static size_t
  55 convert_16bits(char *buf, NCURSES_INT2 *Numbers, int count)
  56 {
  57     int i;
  58     size_t j;
  59     size_t size = SIZEOF_SHORT;
  60     for (i = 0; i < count; i++) {
  61         unsigned mask = 0xff;
  62         unsigned char ch = 0;
  63         Numbers[i] = 0;
  64         for (j = 0; j < size; ++j) {
  65             ch = UChar(*buf++);
  66             Numbers[i] |= (ch << (8 * j));
  67             mask <<= 8;
  68         }
  69         if (ch & 0x80) {
  70             while (mask != 0) {
  71                 Numbers[i] |= (int) mask;
  72                 mask <<= 8;
  73             }
  74         }
  75         TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
  76     }
  77     return size;
  78 }
  79
  80 static size_t
  81 convert_32bits(char *buf, NCURSES_INT2 *Numbers, int count)
  82 {
  83     int i;
  84     size_t j;
  85     size_t size = SIZEOF_INT2;
  86     unsigned char ch;
  87
  88     assert(sizeof(NCURSES_INT2) == size);
  89     for (i = 0; i < count; i++) {
  90         Numbers[i] = 0;
  91         for (j = 0; j < size; ++j) {
  92             ch = UChar(*buf++);
  93             Numbers[i] |= (ch << (8 * j));
  94         }
  95         /* "unsigned" and NCURSES_INT2 are the same size - no sign-extension */
  96         TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
  97     }
  98     return size;
  99 }
 100 #else
 101 static size_t
 102 convert_32bits(char *buf, NCURSES_INT2 *Numbers, int count)
 103 {
 104     int i, j;
 105     unsigned char ch;
 106     for (i = 0; i < count; i++) {
 107         int value = 0;
 108         for (j = 0; j < SIZEOF_32BITS; ++j) {
 109             ch = UChar(*buf++);
 110             value |= (ch << (8 * j));
 111         }
 112         if (value == -1)
 113             Numbers[i] = ABSENT_NUMERIC;
 114         else if (value == -2)
 115             Numbers[i] = CANCELLED_NUMERIC;
 116         else if (value > MAX_OF_TYPE(NCURSES_INT2))
 117             Numbers[i] = MAX_OF_TYPE(NCURSES_INT2);
 118         else
 119             Numbers[i] = (short) value;
 120         TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
 121     }
 122     return SIZEOF_SHORT;
 123 }
 124
 125 static size_t
 126 convert_16bits(char *buf, NCURSES_INT2 *Numbers, int count)
 127 {
 128     int i;
 129     for (i = 0; i < count; i++) {
 130         if (IS_NEG1(buf + 2 * i))
 131             Numbers[i] = ABSENT_NUMERIC;
 132         else if (IS_NEG2(buf + 2 * i))
 133             Numbers[i] = CANCELLED_NUMERIC;
 134         else
 135             Numbers[i] = MyNumber(buf + 2 * i);
 136         TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
 137     }
 138     return SIZEOF_SHORT;
 139 }
 140 #endif
 141
 142 static void
 143 convert_strings(char *buf, char **Strings, int count, int size, char *table)
 144 {
 145     int i;
 146     char *p;
 147
 148     for (i = 0; i < count; i++) {
 149         if (IS_NEG1(buf + 2 * i)) {
 150             Strings[i] = ABSENT_STRING;
 151         } else if (IS_NEG2(buf + 2 * i)) {
 152             Strings[i] = CANCELLED_STRING;
 153         } else if (MyNumber(buf + 2 * i) > size) {
 154             Strings[i] = ABSENT_STRING;
 155         } else {
 156             Strings[i] = (MyNumber(buf + 2 * i) + table);
 157             TR(TRACE_DATABASE, ("Strings[%d] = %s", i, _nc_visbuf(Strings[i])));
 158         }
 159
 160         /* make sure all strings are NUL terminated */
 161         if (VALID_STRING(Strings[i])) {
 162             for (p = Strings[i]; p <= table + size; p++)
 163                 if (*p == '\0')
 164                     break;
 165             /* if there is no NUL, ignore the string */
 166             if (p > table + size)
 167                 Strings[i] = ABSENT_STRING;
 168         }
 169     }
 170 }
 171
 172 static int
 173 fake_read(char *src, int *offset, int limit, char *dst, unsigned want)
 174 {
 175     int have = (limit - *offset);
 176
 177     if (have > 0) {
 178         if ((int) want > have)
 179             want = (unsigned) have;
 180         memcpy(dst, src + *offset, (size_t) want);
 181         *offset += (int) want;
 182     } else {
 183         want = 0;
 184     }
 185     return (int) want;
 186 }
 187
 188 #define Read(buf, count) fake_read(buffer, &offset, limit, (char *) buf, (unsigned) count)
 189
 190 #define read_shorts(buf, count) \
 191         (Read(buf, (count)*SIZEOF_SHORT) == (int) (count)*SIZEOF_SHORT)
 192
 193 #define read_numbers(buf, count) \
 194         (Read(buf, (count)*(unsigned)size_of_numbers) == (int) (count)*size_of_numbers)
 195
 196 #define even_boundary(value) \
 197     if ((value) % 2 != 0) Read(buf, 1)
 198 #endif
 199
 200 NCURSES_EXPORT(void)
 201 _nc_init_termtype(TERMTYPE2 *const tp)
 202 {
 203     unsigned i;
 204
 205 #if NCURSES_XNAMES
 206     tp->num_Booleans = BOOLCOUNT;
 207     tp->num_Numbers = NUMCOUNT;
 208     tp->num_Strings = STRCOUNT;
 209     tp->ext_Booleans = 0;
 210     tp->ext_Numbers = 0;
 211     tp->ext_Strings = 0;
 212 #endif
 213     if (tp->Booleans == 0)
 214         TYPE_MALLOC(NCURSES_SBOOL, BOOLCOUNT, tp->Booleans);
 215     if (tp->Numbers == 0)
 216         TYPE_MALLOC(NCURSES_INT2, NUMCOUNT, tp->Numbers);
 217     if (tp->Strings == 0)
 218         TYPE_MALLOC(char *, STRCOUNT, tp->Strings);
 219
 220     for_each_boolean(i, tp)
 221         tp->Booleans[i] = FALSE;
 222
 223     for_each_number(i, tp)
 224         tp->Numbers[i] = ABSENT_NUMERIC;
 225
 226     for_each_string(i, tp)
 227         tp->Strings[i] = ABSENT_STRING;
 228 }
 229
 230 #if NCURSES_USE_DATABASE
 231 #if NCURSES_XNAMES
 232 static bool
 233 valid_shorts(char *buffer, int limit)
 234 {
 235     bool result = FALSE;
 236     int n;
 237     for (n = 0; n < limit; ++n) {
 238         if (MyNumber(buffer + (n * 2)) > 0) {
 239             result = TRUE;
 240             break;
 241         }
 242     }
 243     return result;
 244 }
 245 #endif
 246
 247 /*
 248  * Return TGETENT_YES if read, TGETENT_NO if not found or garbled.
 249  */
 250 NCURSES_EXPORT(int)
 251 _nc_read_termtype(TERMTYPE2 *ptr, char *buffer, int limit)
 252 {
 253     int offset = 0;
 254     int name_size, bool_count, num_count, str_count, str_size;
 255     int i;
 256     char buf[MAX_ENTRY_SIZE + 2];
 257     char *string_table;
 258     unsigned want, have;
 259     bool need_ints;
 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 ((need_ints = (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 ((need_ints = (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 = 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     int ch;
 669
 670     for (nibble = 0; nibble < 2; ++nibble) {
 671         result <<= 4;
 672         ch = UChar(**source);
 673         *source += 1;
 674         if (ch >= '0' && ch <= '9') {
 675             ch -= '0';
 676         } else if (ch >= 'A' && ch <= 'F') {
 677             ch -= 'A';
 678             ch += 10;
 679         } else if (ch >= 'a' && ch <= 'f') {
 680             ch -= 'a';
 681             ch += 10;
 682         } else {
 683             result = -1;
 684             break;
 685         }
 686         result |= ch;
 687     }
 688     return result;
 689 }
 690
 691 static int
 692 decode_quickdump(char *target, const char *source)
 693 {
 694     char *base = target;
 695     int result = 0;
 696
 697     if (!strncmp(source, "b64:", (size_t) 4)) {
 698         source += 4;
 699         while (*source != '\0') {
 700             int bits[4];
 701             int ch = lookup_b64(bits, &source);
 702             if (ch < 0 || (ch + target - base) >= MAX_ENTRY_SIZE) {
 703                 result = 0;
 704                 break;
 705             }
 706             result += ch;
 707             *target++ = (char) ((bits[0] << 2) | (bits[1] >> 4));
 708             if (bits[2] < 64) {
 709                 *target++ = (char) ((bits[1] << 4) | (bits[2] >> 2));
 710                 if (bits[3] < 64) {
 711                     *target++ = (char) ((bits[2] << 6) | bits[3]);
 712                 }
 713             }
 714         }
 715     } else if (!strncmp(source, "hex:", (size_t) 4)) {
 716         source += 4;
 717         while (*source != '\0') {
 718             int ch = decode_hex(&source);
 719             if (ch < 0 || (target - base) >= MAX_ENTRY_SIZE) {
 720                 result = 0;
 721                 break;
 722             }
 723             *target++ = (char) ch;
 724             ++result;
 725         }
 726     }
 727     return result;
 728 }
 729
 730 /*
 731  * Build a terminfo pathname and try to read the data.  Returns TGETENT_YES on
 732  * success, TGETENT_NO on failure.
 733  */
 734 static int
 735 _nc_read_tic_entry(char *filename,
 736                    unsigned limit,
 737                    const char *const path,
 738                    const char *name,
 739                    TERMTYPE2 *const tp)
 740 {
 741     int code = TGETENT_NO;
 742 #if USE_HASHED_DB
 743     DB *capdbp;
 744 #endif
 745     char buffer[MAX_ENTRY_SIZE + 1];
 746     int used;
 747
 748     TR(TRACE_DATABASE,
 749        (T_CALLED("_nc_read_tic_entry(file=%p, path=%s, name=%s)"),
 750         filename, path, name));
 751
 752     assert(TGETENT_YES == TRUE);        /* simplify call for _nc_name_match */
 753
 754     if ((used = decode_quickdump(buffer, path)) != 0
 755         && (code = _nc_read_termtype(tp, buffer, used)) == TGETENT_YES
 756         && (code = _nc_name_match(tp->term_names, name, "|")) == TGETENT_YES) {
 757         TR(TRACE_DATABASE, ("loaded quick-dump for %s", name));
 758         /* shorten name shown by infocmp */
 759         _nc_STRCPY(filename, "$TERMINFO", limit);
 760     } else
 761 #if USE_HASHED_DB
 762         if (make_db_filename(filename, limit, path)
 763             && (capdbp = _nc_db_open(filename, FALSE)) != 0) {
 764
 765         DBT key, data;
 766         int reccnt = 0;
 767         char *save = strdup(name);
 768
 769         memset(&key, 0, sizeof(key));
 770         key.data = save;
 771         key.size = strlen(save);
 772
 773         /*
 774          * This lookup could return termcap data, which we do not want.  We are
 775          * looking for compiled (binary) terminfo data.
 776          *
 777          * cgetent uses a two-level lookup.  On the first it uses the given
 778          * name to return a record containing only the aliases for an entry.
 779          * On the second (using that list of aliases as a key), it returns the
 780          * content of the terminal description.  We expect second lookup to
 781          * return data beginning with the same set of aliases.
 782          *
 783          * For compiled terminfo, the list of aliases in the second case will
 784          * be null-terminated.  A termcap entry will not be, and will run on
 785          * into the description.  So we can easily distinguish between the two
 786          * (source/binary) by checking the lengths.
 787          */
 788         while (_nc_db_get(capdbp, &key, &data) == 0) {
 789             char *have = (char *) data.data;
 790             used = (int) data.size - 1;
 791
 792             if (*have++ == 0) {
 793                 if (data.size > key.size
 794                     && IS_TIC_MAGIC(have)) {
 795                     code = _nc_read_termtype(tp, have, used);
 796                     if (code == TGETENT_NO) {
 797                         _nc_free_termtype2(tp);
 798                     }
 799                 }
 800                 break;
 801             }
 802
 803             /*
 804              * Just in case we have a corrupt database, do not waste time with
 805              * it.
 806              */
 807             if (++reccnt >= 3)
 808                 break;
 809
 810             /*
 811              * Prepare for the second level.
 812              */
 813             key.data = have;
 814             key.size = used;
 815         }
 816
 817         free(save);
 818     } else                      /* may be either filesystem or flat file */
 819 #endif
 820     if (make_dir_filename(filename, limit, path, name)) {
 821         code = _nc_read_file_entry(filename, tp);
 822     }
 823 #if NCURSES_USE_TERMCAP
 824     if (code != TGETENT_YES) {
 825         code = _nc_read_termcap_entry(name, tp);
 826         _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
 827                     "%.*s", PATH_MAX - 1, _nc_get_source());
 828     }
 829 #endif
 830     returnDB(code);
 831 }
 832 #endif /* NCURSES_USE_DATABASE */
 833
 834 /*
 835  * Find and read the compiled entry for a given terminal type, if it exists.
 836  * We take pains here to make sure no combination of environment variables and
 837  * terminal type name can be used to overrun the file buffer.
 838  */
 839 NCURSES_EXPORT(int)
 840 _nc_read_entry2(const char *const name, char *const filename, TERMTYPE2 *const tp)
 841 {
 842     int code = TGETENT_NO;
 843
 844     if (name == 0)
 845         return _nc_read_entry2("", filename, tp);
 846
 847     _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
 848                 "%.*s", PATH_MAX - 1, name);
 849
 850     if (strlen(name) == 0
 851         || strcmp(name, ".") == 0
 852         || strcmp(name, "..") == 0
 853         || _nc_pathlast(name) != 0
 854         || strchr(name, NCURSES_PATHSEP) != 0) {
 855         TR(TRACE_DATABASE, ("illegal or missing entry name '%s'", name));
 856     } else {
 857 #if NCURSES_USE_DATABASE
 858         DBDIRS state;
 859         int offset;
 860         const char *path;
 861
 862         _nc_first_db(&state, &offset);
 863         code = TGETENT_ERR;
 864         while ((path = _nc_next_db(&state, &offset)) != 0) {
 865             code = _nc_read_tic_entry(filename, PATH_MAX, path, name, tp);
 866             if (code == TGETENT_YES) {
 867                 _nc_last_db();
 868                 break;
 869             }
 870         }
 871 #elif NCURSES_USE_TERMCAP
 872         if (code != TGETENT_YES) {
 873             code = _nc_read_termcap_entry(name, tp);
 874             _nc_SPRINTF(filename, _nc_SLIMIT(PATH_MAX)
 875                         "%.*s", PATH_MAX - 1, _nc_get_source());
 876         }
 877 #endif
 878     }
 879     return code;
 880 }
 881
 882 #if NCURSES_EXT_NUMBERS
 883 /*
 884  * This entrypoint is used by tack.
 885  */
 886 NCURSES_EXPORT(int)
 887 _nc_read_entry(const char *const name, char *const filename, TERMTYPE *const tp)
 888 {
 889     TERMTYPE2 dummy;
 890     int rc;
 891     rc = _nc_read_entry2(name, filename, &dummy);
 892     if (rc == TGETENT_YES)
 893         _nc_export_termtype2(tp, &dummy);
 894     return rc;
 895 }
 896 #endif