ncurses 6.0 - patch 20171118
[ncurses.git] / ncurses / tinfo / db_iterator.c
1 /****************************************************************************
2  * Copyright (c) 2006-2016,2017 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: Thomas E. Dickey                                                *
31  ****************************************************************************/
32
33 /*
34  * Iterators for terminal databases.
35  */
36
37 #include <curses.priv.h>
38
39 #include <time.h>
40 #include <tic.h>
41
42 #if USE_HASHED_DB
43 #include <hashed_db.h>
44 #endif
45
46 MODULE_ID("$Id: db_iterator.c,v 1.46 2017/07/01 22:54:42 tom Exp $")
47
48 #define HaveTicDirectory _nc_globals.have_tic_directory
49 #define KeepTicDirectory _nc_globals.keep_tic_directory
50 #define TicDirectory     _nc_globals.tic_directory
51 #define my_blob          _nc_globals.dbd_blob
52 #define my_list          _nc_globals.dbd_list
53 #define my_size          _nc_globals.dbd_size
54 #define my_time          _nc_globals.dbd_time
55 #define my_vars          _nc_globals.dbd_vars
56
57 static void
58 add_to_blob(const char *text, size_t limit)
59 {
60     (void) limit;
61
62     if (*text != '\0') {
63         char *last = my_blob + strlen(my_blob);
64         if (last != my_blob)
65             *last++ = NCURSES_PATHSEP;
66         _nc_STRCPY(last, text, limit);
67     }
68 }
69
70 static bool
71 check_existence(const char *name, struct stat *sb)
72 {
73     bool result = FALSE;
74
75     if (quick_prefix(name)) {
76         result = TRUE;
77     } else if (stat(name, sb) == 0
78                && (S_ISDIR(sb->st_mode)
79                    || (S_ISREG(sb->st_mode) && sb->st_size))) {
80         result = TRUE;
81     }
82 #if USE_HASHED_DB
83     else if (strlen(name) < PATH_MAX - sizeof(DBM_SUFFIX)) {
84         char temp[PATH_MAX];
85         _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp)) "%s%s", name, DBM_SUFFIX);
86         if (stat(temp, sb) == 0 && S_ISREG(sb->st_mode) && sb->st_size) {
87             result = TRUE;
88         }
89     }
90 #endif
91     return result;
92 }
93
94 /*
95  * Trim newlines (and backslashes preceding those) and tab characters to
96  * help simplify scripting of the quick-dump feature.  Leave spaces and
97  * other backslashes alone.
98  */
99 static void
100 trim_formatting(char *source)
101 {
102     char *target = source;
103     char ch;
104
105     while ((ch = *source++) != '\0') {
106         if (ch == '\\' && *source == '\n')
107             continue;
108         if (ch == '\n' || ch == '\t')
109             continue;
110         *target++ = ch;
111     }
112     *target = '\0';
113 }
114
115 /*
116  * Store the latest value of an environment variable in my_vars[] so we can
117  * detect if one changes, invalidating the cached search-list.
118  */
119 static bool
120 update_getenv(const char *name, DBDIRS which)
121 {
122     bool result = FALSE;
123
124     if (which < dbdLAST) {
125         char *value;
126         char *cached_value = my_vars[which].value;
127         bool same_value;
128
129         if ((value = getenv(name)) != 0) {
130             value = strdup(value);
131         }
132         same_value = ((value == 0 && cached_value == 0) ||
133                       (value != 0 &&
134                        cached_value != 0 &&
135                        strcmp(value, cached_value) == 0));
136
137         /* Set variable name to enable checks in cache_expired(). */
138         my_vars[which].name = name;
139
140         if (!same_value) {
141             FreeIfNeeded(my_vars[which].value);
142             my_vars[which].value = value;
143             result = TRUE;
144         } else {
145             free(value);
146         }
147     }
148     return result;
149 }
150
151 static char *
152 cache_getenv(const char *name, DBDIRS which)
153 {
154     char *result = 0;
155
156     (void) update_getenv(name, which);
157     if (which < dbdLAST) {
158         result = my_vars[which].value;
159     }
160     return result;
161 }
162
163 /*
164  * The cache expires if at least a second has passed since the initial lookup,
165  * or if one of the environment variables changed.
166  *
167  * Only a few applications use multiple lookups of terminal entries, seems that
168  * aside from bulk I/O such as tic and toe, that leaves interactive programs
169  * which should not be modifying the terminal databases in a way that would
170  * invalidate the search-list.
171  *
172  * The "1-second" is to allow for user-directed changes outside the program.
173  */
174 static bool
175 cache_expired(void)
176 {
177     bool result = FALSE;
178     time_t now = time((time_t *) 0);
179
180     if (now > my_time) {
181         result = TRUE;
182     } else {
183         DBDIRS n;
184         for (n = (DBDIRS) 0; n < dbdLAST; ++n) {
185             if (my_vars[n].name != 0
186                 && update_getenv(my_vars[n].name, n)) {
187                 result = TRUE;
188                 break;
189             }
190         }
191     }
192     return result;
193 }
194
195 static void
196 free_cache(void)
197 {
198     FreeAndNull(my_blob);
199     FreeAndNull(my_list);
200 }
201
202 /*
203  * Record the "official" location of the terminfo directory, according to
204  * the place where we're writing to, or the normal default, if not.
205  */
206 NCURSES_EXPORT(const char *)
207 _nc_tic_dir(const char *path)
208 {
209     T(("_nc_tic_dir %s", NonNull(path)));
210     if (!KeepTicDirectory) {
211         if (path != 0) {
212             TicDirectory = path;
213             HaveTicDirectory = TRUE;
214         } else if (HaveTicDirectory == 0) {
215             if (use_terminfo_vars()) {
216                 const char *envp;
217                 if ((envp = getenv("TERMINFO")) != 0)
218                     return _nc_tic_dir(envp);
219             }
220         }
221     }
222     return TicDirectory ? TicDirectory : TERMINFO;
223 }
224
225 /*
226  * Special fix to prevent the terminfo directory from being moved after tic
227  * has chdir'd to it.  If we let it be changed, then if $TERMINFO has a
228  * relative path, we'll lose track of the actual directory.
229  */
230 NCURSES_EXPORT(void)
231 _nc_keep_tic_dir(const char *path)
232 {
233     _nc_tic_dir(path);
234     KeepTicDirectory = TRUE;
235 }
236
237 /*
238  * Cleanup.
239  */
240 NCURSES_EXPORT(void)
241 _nc_last_db(void)
242 {
243     if (my_blob != 0 && cache_expired()) {
244         free_cache();
245     }
246 }
247
248 /*
249  * This is a simple iterator which allows the caller to step through the
250  * possible locations for a terminfo directory.  ncurses uses this to find
251  * terminfo files to read.
252  */
253 NCURSES_EXPORT(const char *)
254 _nc_next_db(DBDIRS * state, int *offset)
255 {
256     const char *result;
257
258     (void) offset;
259     if ((int) *state < my_size
260         && my_list != 0
261         && my_list[*state] != 0) {
262         result = my_list[*state];
263         (*state)++;
264     } else {
265         result = 0;
266     }
267     if (result != 0) {
268         T(("_nc_next_db %d %s", *state, result));
269     }
270     return result;
271 }
272
273 NCURSES_EXPORT(void)
274 _nc_first_db(DBDIRS * state, int *offset)
275 {
276     bool cache_has_expired = FALSE;
277     *state = dbdTIC;
278     *offset = 0;
279
280     T((T_CALLED("_nc_first_db")));
281
282     /* build a blob containing all of the strings we will use for a lookup
283      * table.
284      */
285     if (my_blob == 0 || (cache_has_expired = cache_expired())) {
286         size_t blobsize = 0;
287         const char *values[dbdLAST];
288         struct stat *my_stat;
289         int j;
290
291         if (cache_has_expired)
292             free_cache();
293
294         for (j = 0; j < dbdLAST; ++j)
295             values[j] = 0;
296
297         /*
298          * This is the first item in the list, and is used only when tic is
299          * writing to the database, as a performance improvement.
300          */
301         values[dbdTIC] = TicDirectory;
302
303 #if NCURSES_USE_DATABASE
304 #ifdef TERMINFO_DIRS
305         values[dbdCfgList] = TERMINFO_DIRS;
306 #endif
307 #ifdef TERMINFO
308         values[dbdCfgOnce] = TERMINFO;
309 #endif
310 #endif
311
312 #if NCURSES_USE_TERMCAP
313         values[dbdCfgList2] = TERMPATH;
314 #endif
315
316         if (use_terminfo_vars()) {
317 #if NCURSES_USE_DATABASE
318             values[dbdEnvOnce] = cache_getenv("TERMINFO", dbdEnvOnce);
319             values[dbdHome] = _nc_home_terminfo();
320             (void) cache_getenv("HOME", dbdHome);
321             values[dbdEnvList] = cache_getenv("TERMINFO_DIRS", dbdEnvList);
322
323 #endif
324 #if NCURSES_USE_TERMCAP
325             values[dbdEnvOnce2] = cache_getenv("TERMCAP", dbdEnvOnce2);
326             /* only use $TERMCAP if it is an absolute path */
327             if (values[dbdEnvOnce2] != 0
328                 && *values[dbdEnvOnce2] != '/') {
329                 values[dbdEnvOnce2] = 0;
330             }
331             values[dbdEnvList2] = cache_getenv("TERMPATH", dbdEnvList2);
332 #endif /* NCURSES_USE_TERMCAP */
333         }
334
335         for (j = 0; j < dbdLAST; ++j) {
336             if (values[j] == 0)
337                 values[j] = "";
338             blobsize += 2 + strlen(values[j]);
339         }
340
341         my_blob = malloc(blobsize);
342         if (my_blob != 0) {
343             *my_blob = '\0';
344             for (j = 0; j < dbdLAST; ++j) {
345                 add_to_blob(values[j], blobsize);
346             }
347
348             /* Now, build an array which will be pointers to the distinct
349              * strings in the blob.
350              */
351             blobsize = 2;
352             for (j = 0; my_blob[j] != '\0'; ++j) {
353                 if (my_blob[j] == NCURSES_PATHSEP)
354                     ++blobsize;
355             }
356             my_list = typeCalloc(char *, blobsize);
357             my_stat = typeCalloc(struct stat, blobsize);
358             if (my_list != 0 && my_stat != 0) {
359                 int k = 0;
360                 my_list[k++] = my_blob;
361                 for (j = 0; my_blob[j] != '\0'; ++j) {
362                     if (my_blob[j] == NCURSES_PATHSEP
363                         && ((&my_blob[j] - my_list[k - 1]) != 3
364                             || !quick_prefix(my_list[k - 1]))) {
365                         my_blob[j] = '\0';
366                         my_list[k++] = &my_blob[j + 1];
367                     }
368                 }
369
370                 /*
371                  * Eliminate duplicates from the list.
372                  */
373                 for (j = 0; my_list[j] != 0; ++j) {
374 #ifdef TERMINFO
375                     if (*my_list[j] == '\0')
376                         my_list[j] = strdup(TERMINFO);
377 #endif
378                     trim_formatting(my_list[j]);
379                     for (k = 0; k < j; ++k) {
380                         if (!strcmp(my_list[j], my_list[k])) {
381                             T(("duplicate %s", my_list[j]));
382                             k = j - 1;
383                             while ((my_list[j] = my_list[j + 1]) != 0) {
384                                 ++j;
385                             }
386                             j = k;
387                             break;
388                         }
389                     }
390                 }
391
392                 /*
393                  * Eliminate non-existent databases, and those that happen to
394                  * be symlinked to another location.
395                  */
396                 for (j = 0; my_list[j] != 0; ++j) {
397                     bool found = check_existence(my_list[j], &my_stat[j]);
398 #if HAVE_LINK
399                     if (found) {
400                         for (k = 0; k < j; ++k) {
401                             if (my_stat[j].st_dev == my_stat[k].st_dev
402                                 && my_stat[j].st_ino == my_stat[k].st_ino) {
403                                 found = FALSE;
404                                 break;
405                             }
406                         }
407                     }
408 #endif
409                     if (!found) {
410                         T(("not found %s", my_list[j]));
411                         k = j;
412                         while ((my_list[k] = my_list[k + 1]) != 0) {
413                             ++k;
414                         }
415                         --j;
416                     }
417                 }
418                 my_size = j;
419                 my_time = time((time_t *) 0);
420             } else {
421                 FreeAndNull(my_blob);
422             }
423             free(my_stat);
424         }
425     }
426     returnVoid;
427 }
428
429 #if NO_LEAKS
430 void
431 _nc_db_iterator_leaks(void)
432 {
433     DBDIRS which;
434
435     if (my_blob != 0)
436         FreeAndNull(my_blob);
437     if (my_list != 0)
438         FreeAndNull(my_list);
439     for (which = 0; (int) which < dbdLAST; ++which) {
440         my_vars[which].name = 0;
441         FreeIfNeeded(my_vars[which].value);
442         my_vars[which].value = 0;
443     }
444 }
445 #endif