ncurses 6.0 - patch 20171209
[ncurses.git] / ncurses / tinfo / read_entry.c
index 0c825d537e4c6e8106515b001fccf4e8547a5c3d..3cb0241095dd622e117b6fd5ec6d9a7031fef4d2 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2012,2013 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
 
 #include <tic.h>
 
-MODULE_ID("$Id: read_entry.c,v 1.125 2013/08/17 19:06:59 tom Exp $")
+MODULE_ID("$Id: read_entry.c,v 1.143 2017/04/06 22:19:06 tom Exp $")
 
 #define TYPE_CALLOC(type,elts) typeCalloc(type, (unsigned)(elts))
 
+#define MyNumber(n) (short) LOW_MSB(n)
+
 #if NCURSES_USE_DATABASE
 static void
-convert_shorts(char *buf, short *Numbers, int count)
+convert_numbers(char *buf, NCURSES_INT2 *Numbers, int count)
 {
     int i;
     for (i = 0; i < count; i++) {
@@ -56,7 +58,7 @@ convert_shorts(char *buf, short *Numbers, int count)
        else if (IS_NEG2(buf + 2 * i))
            Numbers[i] = CANCELLED_NUMERIC;
        else
-           Numbers[i] = (short) LOW_MSB(buf + 2 * i);
+           Numbers[i] = MyNumber(buf + 2 * i);
        TR(TRACE_DATABASE, ("get Numbers[%d]=%d", i, Numbers[i]));
     }
 }
@@ -72,10 +74,10 @@ convert_strings(char *buf, char **Strings, int count, int size, char *table)
            Strings[i] = ABSENT_STRING;
        } else if (IS_NEG2(buf + 2 * i)) {
            Strings[i] = CANCELLED_STRING;
-       } else if ((int) LOW_MSB(buf + 2 * i) > size) {
+       } else if (MyNumber(buf + 2 * i) > size) {
            Strings[i] = ABSENT_STRING;
        } else {
-           Strings[i] = (LOW_MSB(buf + 2 * i) + table);
+           Strings[i] = (MyNumber(buf + 2 * i) + table);
            TR(TRACE_DATABASE, ("Strings[%d] = %s", i, _nc_visbuf(Strings[i])));
        }
 
@@ -114,9 +116,10 @@ fake_read(char *src, int *offset, int limit, char *dst, unsigned want)
 
 #define even_boundary(value) \
     if ((value) % 2 != 0) Read(buf, 1)
+#endif
 
 NCURSES_EXPORT(void)
-_nc_init_termtype(TERMTYPE *const tp)
+_nc_init_termtype(TERMTYPE2 *const tp)
 {
     unsigned i;
 
@@ -131,7 +134,7 @@ _nc_init_termtype(TERMTYPE *const tp)
     if (tp->Booleans == 0)
        TYPE_MALLOC(NCURSES_SBOOL, BOOLCOUNT, tp->Booleans);
     if (tp->Numbers == 0)
-       TYPE_MALLOC(short, NUMCOUNT, tp->Numbers);
+       TYPE_MALLOC(NCURSES_INT2, NUMCOUNT, tp->Numbers);
     if (tp->Strings == 0)
        TYPE_MALLOC(char *, STRCOUNT, tp->Strings);
 
@@ -145,11 +148,28 @@ _nc_init_termtype(TERMTYPE *const tp)
        tp->Strings[i] = ABSENT_STRING;
 }
 
+#if NCURSES_USE_DATABASE
+#if NCURSES_XNAMES
+static bool
+valid_shorts(char *buffer, int limit)
+{
+    bool result = FALSE;
+    int n;
+    for (n = 0; n < limit; ++n) {
+       if (MyNumber(buffer + (n * 2)) > 0) {
+           result = TRUE;
+           break;
+       }
+    }
+    return result;
+}
+#endif
+
 /*
  * Return TGETENT_YES if read, TGETENT_NO if not found or garbled.
  */
 NCURSES_EXPORT(int)
-_nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
+_nc_read_termtype(TERMTYPE2 *ptr, char *buffer, int limit)
 {
     int offset = 0;
     int name_size, bool_count, num_count, str_count, str_size;
@@ -158,6 +178,10 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
     char *string_table;
     unsigned want, have;
 
+    TR(TRACE_DATABASE,
+       (T_CALLED("_nc_read_termtype(ptr=%p, buffer=%p, limit=%d)"),
+       (void *) ptr, buffer, limit));
+
     TR(TRACE_DATABASE, ("READ termtype header @%d", offset));
 
     memset(ptr, 0, sizeof(*ptr));
@@ -165,14 +189,15 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
     /* grab the header */
     if (!read_shorts(buf, 6)
        || !IS_TIC_MAGIC(buf)) {
-       return (TGETENT_NO);
+       returnDB(TGETENT_NO);
     }
 
-    name_size = LOW_MSB(buf + 2);
-    bool_count = LOW_MSB(buf + 4);
-    num_count = LOW_MSB(buf + 6);
-    str_count = LOW_MSB(buf + 8);
-    str_size = LOW_MSB(buf + 10);
+    /* *INDENT-EQLS* */
+    name_size  = MyNumber(buf + 2);
+    bool_count = MyNumber(buf + 4);
+    num_count  = MyNumber(buf + 6);
+    str_count  = MyNumber(buf + 8);
+    str_size   = MyNumber(buf + 10);
 
     TR(TRACE_DATABASE,
        ("TERMTYPE name_size=%d, bool=%d/%d, num=%d/%d str=%d/%d(%d)",
@@ -183,21 +208,14 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
        || num_count < 0
        || str_count < 0
        || str_size < 0) {
-       return (TGETENT_NO);
+       returnDB(TGETENT_NO);
     }
 
     want = (unsigned) (str_size + name_size + 1);
-    if (str_size) {
-       /* try to allocate space for the string table */
-       if (str_count * 2 >= MAX_ENTRY_SIZE
-           || (string_table = typeMalloc(char, want)) == 0) {
-           return (TGETENT_NO);
-       }
-    } else {
-       str_count = 0;
-       if ((string_table = typeMalloc(char, want)) == 0) {
-           return (TGETENT_NO);
-       }
+    /* try to allocate space for the string table */
+    if (str_count * 2 >= MAX_ENTRY_SIZE
+       || (string_table = typeMalloc(char, want)) == 0) {
+       returnDB(TGETENT_NO);
     }
 
     /* grab the name (a null-terminated string) */
@@ -217,7 +235,7 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
     if ((ptr->Booleans = TYPE_CALLOC(NCURSES_SBOOL,
                                     max(BOOLCOUNT, bool_count))) == 0
        || Read(ptr->Booleans, (unsigned) bool_count) < bool_count) {
-       return (TGETENT_NO);
+       returnDB(TGETENT_NO);
     }
 
     /*
@@ -229,23 +247,25 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
     even_boundary(name_size + bool_count);
 
     /* grab the numbers */
-    if ((ptr->Numbers = TYPE_CALLOC(short, max(NUMCOUNT, num_count))) == 0
+    if (!(ptr->Numbers = TYPE_CALLOC(NCURSES_INT2, max(NUMCOUNT, num_count)))
        || !read_shorts(buf, num_count)) {
-       return (TGETENT_NO);
+       returnDB(TGETENT_NO);
     }
-    convert_shorts(buf, ptr->Numbers, num_count);
+    convert_numbers(buf, ptr->Numbers, num_count);
 
-    if ((ptr->Strings = TYPE_CALLOC(char *, max(STRCOUNT, str_count))) == 0)
-         return (TGETENT_NO);
+    if ((ptr->Strings = TYPE_CALLOC(char *, max(STRCOUNT, str_count))) == 0) {
+       returnDB(TGETENT_NO);
+    }
 
     if (str_count) {
        /* grab the string offsets */
        if (!read_shorts(buf, str_count)) {
-           return (TGETENT_NO);
+           returnDB(TGETENT_NO);
        }
        /* finally, grab the string table itself */
-       if (Read(string_table, (unsigned) str_size) != str_size)
-           return (TGETENT_NO);
+       if (Read(string_table, (unsigned) str_size) != str_size) {
+           returnDB(TGETENT_NO);
+       }
        convert_strings(buf, ptr->Strings, str_count, str_size, string_table);
     }
 #if NCURSES_XNAMES
@@ -259,12 +279,12 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
      */
     even_boundary(str_size);
     TR(TRACE_DATABASE, ("READ extended_header @%d", offset));
-    if (_nc_user_definable && read_shorts(buf, 5)) {
-       int ext_bool_count = LOW_MSB(buf + 0);
-       int ext_num_count = LOW_MSB(buf + 2);
-       int ext_str_count = LOW_MSB(buf + 4);
-       int ext_str_size = LOW_MSB(buf + 6);
-       int ext_str_limit = LOW_MSB(buf + 8);
+    if (_nc_user_definable && read_shorts(buf, 5) && valid_shorts(buf, 5)) {
+       int ext_bool_count = MyNumber(buf + 0);
+       int ext_num_count = MyNumber(buf + 2);
+       int ext_str_count = MyNumber(buf + 4);
+       int ext_str_size = MyNumber(buf + 6);
+       int ext_str_limit = MyNumber(buf + 8);
        unsigned need = (unsigned) (ext_bool_count + ext_num_count + ext_str_count);
        int base = 0;
 
@@ -275,15 +295,16 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
            || ext_num_count < 0
            || ext_str_count < 0
            || ext_str_size < 0
-           || ext_str_limit < 0)
-           return (TGETENT_NO);
+           || ext_str_limit < 0) {
+           returnDB(TGETENT_NO);
+       }
 
        ptr->num_Booleans = UShort(BOOLCOUNT + ext_bool_count);
        ptr->num_Numbers = UShort(NUMCOUNT + ext_num_count);
        ptr->num_Strings = UShort(STRCOUNT + ext_str_count);
 
        TYPE_REALLOC(NCURSES_SBOOL, ptr->num_Booleans, ptr->Booleans);
-       TYPE_REALLOC(short, ptr->num_Numbers, ptr->Numbers);
+       TYPE_REALLOC(NCURSES_INT2, ptr->num_Numbers, ptr->Numbers);
        TYPE_REALLOC(char *, ptr->num_Strings, ptr->Strings);
 
        TR(TRACE_DATABASE, ("extended header is %d/%d/%d(%d:%d)",
@@ -294,36 +315,42 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
                            ext_bool_count, offset));
        if ((ptr->ext_Booleans = UShort(ext_bool_count)) != 0) {
            if (Read(ptr->Booleans + BOOLCOUNT, (unsigned)
-                    ext_bool_count) != ext_bool_count)
-               return (TGETENT_NO);
+                    ext_bool_count) != ext_bool_count) {
+               returnDB(TGETENT_NO);
+           }
        }
        even_boundary(ext_bool_count);
 
        TR(TRACE_DATABASE, ("READ %d extended-numbers @%d",
                            ext_num_count, offset));
        if ((ptr->ext_Numbers = UShort(ext_num_count)) != 0) {
-           if (!read_shorts(buf, ext_num_count))
-               return (TGETENT_NO);
+           if (!read_shorts(buf, ext_num_count)) {
+               returnDB(TGETENT_NO);
+           }
            TR(TRACE_DATABASE, ("Before converting extended-numbers"));
-           convert_shorts(buf, ptr->Numbers + NUMCOUNT, ext_num_count);
+           convert_numbers(buf, ptr->Numbers + NUMCOUNT, ext_num_count);
        }
 
        TR(TRACE_DATABASE, ("READ extended-offsets @%d", offset));
-       if ((unsigned) (ext_str_count + (int) need) >= (MAX_ENTRY_SIZE / 2))
-           return (TGETENT_NO);
+       if ((unsigned) (ext_str_count + (int) need) >= (MAX_ENTRY_SIZE / 2)) {
+           returnDB(TGETENT_NO);
+       }
        if ((ext_str_count || need)
-           && !read_shorts(buf, ext_str_count + (int) need))
-           return (TGETENT_NO);
+           && !read_shorts(buf, ext_str_count + (int) need)) {
+           returnDB(TGETENT_NO);
+       }
 
        TR(TRACE_DATABASE, ("READ %d bytes of extended-strings @%d",
                            ext_str_limit, offset));
 
        if (ext_str_limit) {
            ptr->ext_str_table = typeMalloc(char, (size_t) ext_str_limit);
-           if (ptr->ext_str_table == 0)
-               return (TGETENT_NO);
-           if (Read(ptr->ext_str_table, (unsigned) ext_str_limit) != ext_str_limit)
-               return (TGETENT_NO);
+           if (ptr->ext_str_table == 0) {
+               returnDB(TGETENT_NO);
+           }
+           if (Read(ptr->ext_str_table, (unsigned) ext_str_limit) != ext_str_limit) {
+               returnDB(TGETENT_NO);
+           }
            TR(TRACE_DATABASE, ("first extended-string is %s", _nc_visbuf(ptr->ext_str_table)));
        }
 
@@ -347,10 +374,12 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
        }
 
        if (need) {
-           if (ext_str_count >= (MAX_ENTRY_SIZE / 2))
-               return (TGETENT_NO);
-           if ((ptr->ext_Names = TYPE_CALLOC(char *, need)) == 0)
-                 return (TGETENT_NO);
+           if (ext_str_count >= (MAX_ENTRY_SIZE / 2)) {
+               returnDB(TGETENT_NO);
+           }
+           if ((ptr->ext_Names = TYPE_CALLOC(char *, need)) == 0) {
+               returnDB(TGETENT_NO);
+           }
            TR(TRACE_DATABASE,
               ("ext_NAMES starting @%d in extended_strings, first = %s",
                base, _nc_visbuf(ptr->ext_str_table + base)));
@@ -384,7 +413,7 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
     for (i = str_count; i < STRCOUNT; i++)
        ptr->Strings[i] = ABSENT_STRING;
 
-    return (TGETENT_YES);
+    returnDB(TGETENT_YES);
 }
 
 /*
@@ -396,25 +425,26 @@ _nc_read_termtype(TERMTYPE *ptr, char *buffer, int limit)
  *     table.
  */
 NCURSES_EXPORT(int)
-_nc_read_file_entry(const char *const filename, TERMTYPE *ptr)
+_nc_read_file_entry(const char *const filename, TERMTYPE2 *ptr)
 /* return 1 if read, 0 if not found or garbled */
 {
     FILE *fp = 0;
     int code;
-    int limit;
-    char buffer[MAX_ENTRY_SIZE + 1];
 
     if (_nc_access(filename, R_OK) < 0
        || (fp = fopen(filename, "rb")) == 0) {
        TR(TRACE_DATABASE, ("cannot open terminfo %s (errno=%d)", filename, errno));
        code = TGETENT_NO;
     } else {
+       int limit;
+       char buffer[MAX_ENTRY_SIZE + 1];
+
        if ((limit = (int) fread(buffer, sizeof(char), sizeof(buffer), fp))
            > 0) {
 
            TR(TRACE_DATABASE, ("read terminfo %s", filename));
            if ((code = _nc_read_termtype(ptr, buffer, limit)) == TGETENT_NO) {
-               _nc_free_termtype(ptr);
+               _nc_free_termtype2(ptr);
            }
        } else {
            code = TGETENT_NO;
@@ -434,9 +464,9 @@ make_db_filename(char *filename, unsigned limit, const char *const path)
 {
     static const char suffix[] = DBM_SUFFIX;
 
-    unsigned lens = sizeof(suffix) - 1;
-    unsigned size = strlen(path);
-    unsigned test = lens + size;
+    size_t lens = sizeof(suffix) - 1;
+    size_t size = strlen(path);
+    size_t test = lens + size;
     bool result = FALSE;
 
     if (test < limit) {
@@ -477,6 +507,106 @@ make_dir_filename(char *filename,
     return result;
 }
 
+static int
+lookup_b64(int *target, const char **source)
+{
+    int result = 3;
+    int j;
+    /*
+     * ncurses' quickdump writes only RFC 4648 "url/filename-safe" encoding,
+     * but accepts RFC-3548
+     */
+    for (j = 0; j < 4; ++j) {
+       int ch = UChar(**source);
+       *source += 1;
+       if (ch >= 'A' && ch <= 'Z') {
+           target[j] = (ch - 'A');
+       } else if (ch >= 'a' && ch <= 'z') {
+           target[j] = 26 + (ch - 'a');
+       } else if (ch >= '0' && ch <= '9') {
+           target[j] = 52 + (ch - '0');
+       } else if (ch == '-' || ch == '+') {
+           target[j] = 62;
+       } else if (ch == '_' || ch == '/') {
+           target[j] = 63;
+       } else if (ch == '=') {
+           target[j] = 64;
+           result--;
+       } else {
+           result = -1;
+           break;
+       }
+    }
+    return result;
+}
+
+static int
+decode_hex(const char **source)
+{
+    int result = 0;
+    int nibble;
+    int ch;
+
+    for (nibble = 0; nibble < 2; ++nibble) {
+       result <<= 4;
+       ch = UChar(**source);
+       *source += 1;
+       if (ch >= '0' && ch <= '9') {
+           ch -= '0';
+       } else if (ch >= 'A' && ch <= 'F') {
+           ch -= 'A';
+           ch += 10;
+       } else if (ch >= 'a' && ch <= 'f') {
+           ch -= 'a';
+           ch += 10;
+       } else {
+           result = -1;
+           break;
+       }
+       result |= ch;
+    }
+    return result;
+}
+
+static int
+decode_quickdump(char *target, const char *source)
+{
+    char *base = target;
+    int result = 0;
+
+    if (!strncmp(source, "b64:", 4)) {
+       source += 4;
+       while (*source != '\0') {
+           int bits[4];
+           int ch = lookup_b64(bits, &source);
+           if (ch < 0 || (ch + target - base) >= MAX_ENTRY_SIZE) {
+               result = 0;
+               break;
+           }
+           result += ch;
+           *target++ = (char) ((bits[0] << 2) | (bits[1] >> 4));
+           if (bits[2] < 64) {
+               *target++ = (char) ((bits[1] << 4) | (bits[2] >> 2));
+               if (bits[3] < 64) {
+                   *target++ = (char) ((bits[2] << 6) | bits[3]);
+               }
+           }
+       }
+    } else if (!strncmp(source, "hex:", 4)) {
+       source += 4;
+       while (*source != '\0') {
+           int ch = decode_hex(&source);
+           if (ch < 0 || (target - base) >= MAX_ENTRY_SIZE) {
+               result = 0;
+               break;
+           }
+           *target++ = (char) ch;
+           ++result;
+       }
+    }
+    return result;
+}
+
 /*
  * Build a terminfo pathname and try to read the data.  Returns TGETENT_YES on
  * success, TGETENT_NO on failure.
@@ -486,15 +616,27 @@ _nc_read_tic_entry(char *filename,
                   unsigned limit,
                   const char *const path,
                   const char *name,
-                  TERMTYPE *const tp)
+                  TERMTYPE2 *const tp)
 {
     int code = TGETENT_NO;
-
 #if USE_HASHED_DB
     DB *capdbp;
+#endif
+    char buffer[MAX_ENTRY_SIZE + 1];
+    int used;
+
+    TR(TRACE_DATABASE,
+       (T_CALLED("_nc_read_tic_entry(file=%p, path=%s, name=%s)"),
+       filename, path, name));
 
-    if (make_db_filename(filename, limit, path)
-       && (capdbp = _nc_db_open(filename, FALSE)) != 0) {
+    if ((used = decode_quickdump(buffer, path)) != 0
+       && (code = _nc_read_termtype(tp, buffer, used)) == TGETENT_YES
+       && _nc_name_match(tp->term_names, name, "|")) {
+       TR(TRACE_DATABASE, ("loaded quick-dump for %s", name));
+    } else
+#if USE_HASHED_DB
+       if (make_db_filename(filename, limit, path)
+           && (capdbp = _nc_db_open(filename, FALSE)) != 0) {
 
        DBT key, data;
        int reccnt = 0;
@@ -520,8 +662,8 @@ _nc_read_tic_entry(char *filename,
         * (source/binary) by checking the lengths.
         */
        while (_nc_db_get(capdbp, &key, &data) == 0) {
-           int used = data.size - 1;
            char *have = (char *) data.data;
+           used = (int) data.size - 1;
 
            if (*have++ == 0) {
                if (data.size > key.size
@@ -561,21 +703,17 @@ _nc_read_tic_entry(char *filename,
                    "%.*s", PATH_MAX - 1, _nc_get_source());
     }
 #endif
-    return code;
+    returnDB(code);
 }
 #endif /* NCURSES_USE_DATABASE */
 
 /*
- *     _nc_read_entry(char *name, char *filename, TERMTYPE *tp)
- *
- *     Find and read the compiled entry for a given terminal type,
- *     if it exists.  We take pains here to make sure no combination
- *     of environment variables and terminal type name can be used to
- *     overrun the file buffer.
+ * Find and read the compiled entry for a given terminal type, if it exists. 
+ * We take pains here to make sure no combination of environment variables and
+ * terminal type name can be used to overrun the file buffer.
  */
-
 NCURSES_EXPORT(int)
-_nc_read_entry(const char *const name, char *const filename, TERMTYPE *const tp)
+_nc_read_entry2(const char *const name, char *const filename, TERMTYPE2 *const tp)
 {
     int code = TGETENT_NO;
 
@@ -595,8 +733,8 @@ _nc_read_entry(const char *const name, char *const filename, TERMTYPE *const tp)
        const char *path;
 
        _nc_first_db(&state, &offset);
+       code = TGETENT_ERR;
        while ((path = _nc_next_db(&state, &offset)) != 0) {
-           TR(TRACE_DATABASE, ("_nc_read_tic_entry path=%s, name=%s", path, name));
            code = _nc_read_tic_entry(filename, PATH_MAX, path, name, tp);
            if (code == TGETENT_YES) {
                _nc_last_db();
@@ -613,3 +751,19 @@ _nc_read_entry(const char *const name, char *const filename, TERMTYPE *const tp)
     }
     return code;
 }
+
+#if NCURSES_EXT_NUMBERS
+/*
+ * This entrypoint is used by tack.
+ */
+NCURSES_EXPORT(int)
+_nc_read_entry(const char *const name, char *const filename, TERMTYPE *const tp)
+{
+    TERMTYPE2 dummy;
+    int rc;
+    rc = _nc_read_entry2(name, filename, &dummy);
+    if (rc == TGETENT_YES)
+       _nc_export_termtype2(tp, &dummy);
+    return rc;
+}
+#endif