1 /****************************************************************************
2 * Copyright (c) 2006-2016,2017 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Thomas E. Dickey *
31 ****************************************************************************/
34 * Iterators for terminal databases.
37 #include <curses.priv.h>
43 #include <hashed_db.h>
46 MODULE_ID("$Id: db_iterator.c,v 1.44 2017/02/04 23:27:01 tom Exp $")
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
58 add_to_blob(const char *text, size_t limit)
63 char *last = my_blob + strlen(my_blob);
65 *last++ = NCURSES_PATHSEP;
66 _nc_STRCPY(last, text, limit);
71 check_existence(const char *name, struct stat *sb)
75 if (quick_prefix(name)) {
77 } else if (stat(name, sb) == 0
78 && (S_ISDIR(sb->st_mode)
79 || (S_ISREG(sb->st_mode) && sb->st_size))) {
83 else if (strlen(name) < PATH_MAX - sizeof(DBM_SUFFIX)) {
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) {
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.
100 trim_formatting(char *source)
102 char *target = source;
105 while ((ch = *source++) != '\0') {
106 if (ch == '\\' && *source == '\n')
108 if (ch == '\n' || ch == '\t')
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.
120 update_getenv(const char *name, DBDIRS which)
124 if (which < dbdLAST) {
127 if ((value = getenv(name)) == 0 || (value = strdup(value)) == 0) {
129 } else if (my_vars[which].name == 0 || strcmp(my_vars[which].name, name)) {
130 FreeIfNeeded(my_vars[which].value);
131 my_vars[which].name = name;
132 my_vars[which].value = value;
134 } else if ((my_vars[which].value != 0) ^ (value != 0)) {
135 FreeIfNeeded(my_vars[which].value);
136 my_vars[which].value = value;
138 } else if (value != 0 && strcmp(value, my_vars[which].value)) {
139 FreeIfNeeded(my_vars[which].value);
140 my_vars[which].value = value;
150 cache_getenv(const char *name, DBDIRS which)
154 (void) update_getenv(name, which);
155 if (which < dbdLAST) {
156 result = my_vars[which].value;
162 * The cache expires if at least a second has passed since the initial lookup,
163 * or if one of the environment variables changed.
165 * Only a few applications use multiple lookups of terminal entries, seems that
166 * aside from bulk I/O such as tic and toe, that leaves interactive programs
167 * which should not be modifying the terminal databases in a way that would
168 * invalidate the search-list.
170 * The "1-second" is to allow for user-directed changes outside the program.
176 time_t now = time((time_t *) 0);
182 for (n = (DBDIRS) 0; n < dbdLAST; ++n) {
183 if (my_vars[n].name != 0
184 && update_getenv(my_vars[n].name, n)) {
196 FreeAndNull(my_blob);
197 FreeAndNull(my_list);
201 * Record the "official" location of the terminfo directory, according to
202 * the place where we're writing to, or the normal default, if not.
204 NCURSES_EXPORT(const char *)
205 _nc_tic_dir(const char *path)
207 T(("_nc_tic_dir %s", NonNull(path)));
208 if (!KeepTicDirectory) {
211 HaveTicDirectory = TRUE;
212 } else if (HaveTicDirectory == 0) {
213 if (use_terminfo_vars()) {
215 if ((envp = getenv("TERMINFO")) != 0)
216 return _nc_tic_dir(envp);
220 return TicDirectory ? TicDirectory : TERMINFO;
224 * Special fix to prevent the terminfo directory from being moved after tic
225 * has chdir'd to it. If we let it be changed, then if $TERMINFO has a
226 * relative path, we'll lose track of the actual directory.
229 _nc_keep_tic_dir(const char *path)
232 KeepTicDirectory = TRUE;
241 if (my_blob != 0 && cache_expired()) {
247 * This is a simple iterator which allows the caller to step through the
248 * possible locations for a terminfo directory. ncurses uses this to find
249 * terminfo files to read.
251 NCURSES_EXPORT(const char *)
252 _nc_next_db(DBDIRS * state, int *offset)
257 if ((int) *state < my_size
259 && my_list[*state] != 0) {
260 result = my_list[*state];
266 T(("_nc_next_db %d %s", *state, result));
272 _nc_first_db(DBDIRS * state, int *offset)
274 bool cache_has_expired = FALSE;
278 T((T_CALLED("_nc_first_db")));
280 /* build a blob containing all of the strings we will use for a lookup
283 if (my_blob == 0 || (cache_has_expired = cache_expired())) {
285 const char *values[dbdLAST];
286 struct stat *my_stat;
289 if (cache_has_expired)
292 for (j = 0; j < dbdLAST; ++j)
296 * This is the first item in the list, and is used only when tic is
297 * writing to the database, as a performance improvement.
299 values[dbdTIC] = TicDirectory;
301 #if NCURSES_USE_DATABASE
303 values[dbdCfgList] = TERMINFO_DIRS;
306 values[dbdCfgOnce] = TERMINFO;
310 #if NCURSES_USE_TERMCAP
311 values[dbdCfgList2] = TERMPATH;
314 if (use_terminfo_vars()) {
315 #if NCURSES_USE_DATABASE
316 values[dbdEnvOnce] = cache_getenv("TERMINFO", dbdEnvOnce);
317 values[dbdHome] = _nc_home_terminfo();
318 (void) cache_getenv("HOME", dbdHome);
319 values[dbdEnvList] = cache_getenv("TERMINFO_DIRS", dbdEnvList);
322 #if NCURSES_USE_TERMCAP
323 values[dbdEnvOnce2] = cache_getenv("TERMCAP", dbdEnvOnce2);
324 /* only use $TERMCAP if it is an absolute path */
325 if (values[dbdEnvOnce2] != 0
326 && *values[dbdEnvOnce2] != '/') {
327 values[dbdEnvOnce2] = 0;
329 values[dbdEnvList2] = cache_getenv("TERMPATH", dbdEnvList2);
330 #endif /* NCURSES_USE_TERMCAP */
333 for (j = 0; j < dbdLAST; ++j) {
336 blobsize += 2 + strlen(values[j]);
339 my_blob = malloc(blobsize);
342 for (j = 0; j < dbdLAST; ++j) {
343 add_to_blob(values[j], blobsize);
346 /* Now, build an array which will be pointers to the distinct
347 * strings in the blob.
350 for (j = 0; my_blob[j] != '\0'; ++j) {
351 if (my_blob[j] == NCURSES_PATHSEP)
354 my_list = typeCalloc(char *, blobsize);
355 my_stat = typeCalloc(struct stat, blobsize);
356 if (my_list != 0 && my_stat != 0) {
358 my_list[k++] = my_blob;
359 for (j = 0; my_blob[j] != '\0'; ++j) {
360 if (my_blob[j] == NCURSES_PATHSEP
361 && ((&my_blob[j] - my_list[k - 1]) != 3
362 || !quick_prefix(my_list[k - 1]))) {
364 my_list[k++] = &my_blob[j + 1];
369 * Eliminate duplicates from the list.
371 for (j = 0; my_list[j] != 0; ++j) {
373 if (*my_list[j] == '\0')
374 my_list[j] = strdup(TERMINFO);
376 trim_formatting(my_list[j]);
377 for (k = 0; k < j; ++k) {
378 if (!strcmp(my_list[j], my_list[k])) {
379 T(("duplicate %s", my_list[j]));
381 while ((my_list[j] = my_list[j + 1]) != 0) {
391 * Eliminate non-existent databases, and those that happen to
392 * be symlinked to another location.
394 for (j = 0; my_list[j] != 0; ++j) {
395 bool found = check_existence(my_list[j], &my_stat[j]);
398 for (k = 0; k < j; ++k) {
399 if (my_stat[j].st_dev == my_stat[k].st_dev
400 && my_stat[j].st_ino == my_stat[k].st_ino) {
408 T(("not found %s", my_list[j]));
410 while ((my_list[k] = my_list[k + 1]) != 0) {
417 my_time = time((time_t *) 0);
419 FreeAndNull(my_blob);
429 _nc_db_iterator_leaks(void)
434 FreeAndNull(my_blob);
436 FreeAndNull(my_list);
437 for (which = 0; (int) which < dbdLAST; ++which) {
438 my_vars[which].name = 0;
439 FreeIfNeeded(my_vars[which].value);
440 my_vars[which].value = 0;