1 /****************************************************************************
2 * Copyright (c) 1998-2006,2007 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: 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 ****************************************************************************/
36 * write_entry.c -- write a terminfo structure onto the file system
39 #include <curses.priv.h>
40 #include <hashed_db.h>
45 #include <term_entry.h>
48 #define S_ISDIR(mode) ((mode & S_IFMT) == S_IFDIR)
52 #define TRACE_OUT(p) DEBUG(2, p)
54 #define TRACE_OUT(p) /*nothing */
57 MODULE_ID("$Id: write_entry.c,v 1.70 2007/11/17 23:38:28 tom Exp $")
59 static int total_written;
61 static int make_db_root(const char *);
62 static int write_object(TERMTYPE *, char *, unsigned *, unsigned);
66 write_file(char *filename, TERMTYPE *tp)
68 char buffer[MAX_ENTRY_SIZE];
69 unsigned limit = sizeof(buffer);
72 FILE *fp = (_nc_access(filename, W_OK) == 0) ? fopen(filename, "wb") : 0;
75 _nc_syserr_abort("can't open %s/%s", _nc_tic_dir(0), filename);
77 DEBUG(1, ("Created %s", filename));
79 if (write_object(tp, buffer, &offset, limit) == ERR
80 || fwrite(buffer, sizeof(char), offset, fp) != offset) {
81 _nc_syserr_abort("error writing %s/%s", _nc_tic_dir(0), filename);
88 * Check for access rights to destination directories
89 * Create any directories which don't exist.
91 * Note: there's no reason to return the result of make_db_root(), since
92 * this function is called only in instances where that has to succeed.
95 check_writeable(int code)
97 static const char dirnames[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
98 static bool verified[sizeof(dirnames)];
100 char dir[sizeof(LEAF_FMT)];
103 if (code == 0 || (s = strchr(dirnames, code)) == 0)
104 _nc_err_abort("Illegal terminfo subdirectory \"" LEAF_FMT "\"", code);
106 if (verified[s - dirnames])
109 sprintf(dir, LEAF_FMT, code);
110 if (make_db_root(dir) < 0) {
111 _nc_err_abort("%s/%s: permission denied", _nc_tic_dir(0), dir);
114 verified[s - dirnames] = TRUE;
116 #endif /* !USE_HASHED_DB */
119 make_db_path(char *dst, const char *src, unsigned limit)
122 const char *top = _nc_tic_dir(0);
124 if (src == top || _nc_is_abs_path(src)) {
125 if (strlen(src) + 1 <= limit) {
126 (void) strcpy(dst, src);
130 if (strlen(top) + strlen(src) + 2 <= limit) {
131 (void) sprintf(dst, "%s/%s", top, src);
137 if (_nc_is_dir_path(dst)) {
140 unsigned have = strlen(dst);
141 if (have > 3 && strcmp(dst + have - 3, DBM_SUFFIX)) {
142 if (have + 3 <= limit)
143 strcat(dst, DBM_SUFFIX);
154 * Make a database-root if it doesn't exist.
157 make_db_root(const char *path)
160 char fullpath[PATH_MAX];
162 if ((rc = make_db_path(fullpath, path, sizeof(fullpath))) == 0) {
166 if ((capdbp = _nc_db_open(fullpath, TRUE)) == NULL)
168 else if (_nc_db_close(capdbp) < 0)
173 if ((rc = stat(path, &statbuf)) < 0) {
174 rc = mkdir(path, 0777);
175 } else if (_nc_access(path, R_OK | W_OK | X_OK) < 0) {
176 rc = -1; /* permission denied */
177 } else if (!(S_ISDIR(statbuf.st_mode))) {
178 rc = -1; /* not a directory */
186 * Set the write directory for compiled entries.
189 _nc_set_writedir(char *dir)
191 const char *destination;
192 char actual[PATH_MAX];
195 && use_terminfo_vars())
196 dir = getenv("TERMINFO");
199 (void) _nc_tic_dir(dir);
201 destination = _nc_tic_dir(0);
202 if (make_db_root(destination) < 0) {
203 char *home = _nc_home_terminfo();
207 if (make_db_root(destination) < 0)
208 _nc_err_abort("%s: permission denied (errno %d)",
214 * Note: because of this code, this logic should be exercised
215 * *once only* per run.
218 make_db_path(actual, destination, sizeof(actual));
220 if (chdir(_nc_tic_dir(destination)) < 0
221 || getcwd(actual, sizeof(actual)) == 0)
222 _nc_err_abort("%s: not a directory", destination);
224 _nc_keep_tic_dir(strdup(actual));
228 * Save the compiled version of a description in the filesystem.
230 * make a copy of the name-list
231 * break it up into first-name and all-but-last-name
233 * write object information to first-name
235 * for each name in all-but-last-name
238 * Using 'time()' to obtain a reference for file timestamps is unreliable,
239 * e.g., with NFS, because the filesystem may have a different time
240 * reference. We check for pre-existence of links by latching the first
241 * timestamp from a file that we create.
243 * The _nc_warning() calls will report a correct line number only if
244 * _nc_curr_line is properly set before the write_entry() call.
248 _nc_write_entry(TERMTYPE *const tp)
252 char buffer[MAX_ENTRY_SIZE + 1];
253 unsigned limit = sizeof(buffer);
256 #else /* !USE_HASHED_DB */
259 char filename[PATH_MAX];
260 char linkname[PATH_MAX];
262 char symlinkname[PATH_MAX];
267 #endif /* USE_SYMLINKS */
269 static int call_count;
270 static time_t start_time; /* time at start of writes */
272 #endif /* USE_HASHED_DB */
274 char name_list[MAX_TERMINFO_LENGTH];
275 char *first_name, *other_names;
278 (void) strcpy(name_list, tp->term_names);
279 DEBUG(7, ("Name list = '%s'", name_list));
281 first_name = name_list;
283 ptr = &name_list[strlen(name_list) - 1];
284 other_names = ptr + 1;
286 while (ptr > name_list && *ptr != '|')
289 if (ptr != name_list) {
292 for (ptr = name_list; *ptr != '\0' && *ptr != '|'; ptr++)
299 other_names = ptr + 1;
303 DEBUG(7, ("First name = '%s'", first_name));
304 DEBUG(7, ("Other names = '%s'", other_names));
306 _nc_set_type(first_name);
309 if (write_object(tp, buffer + 1, &offset, limit - 1) != ERR) {
310 DB *capdb = _nc_db_open(_nc_tic_dir(0), TRUE);
316 memset(&key, 0, sizeof(key));
317 key.data = tp->term_names;
318 key.size = strlen(tp->term_names);
320 memset(&data, 0, sizeof(data));
322 data.size = offset + 1;
324 _nc_db_put(capdb, &key, &data);
328 key.data = name_list;
329 key.size = strlen(name_list);
331 strcpy(buffer + 1, tp->term_names);
332 data.size = strlen(tp->term_names) + 1;
334 _nc_db_put(capdb, &key, &data);
336 while (*other_names != '\0') {
338 while (*other_names != '|' && *other_names != '\0')
341 if (*other_names != '\0')
342 *(other_names++) = '\0';
345 key.size = strlen(ptr);
347 _nc_db_put(capdb, &key, &data);
352 #else /* !USE_HASHED_DB */
353 if (call_count++ == 0) {
357 if (strlen(first_name) > sizeof(filename) - 3)
358 _nc_warning("terminal name too long.");
360 sprintf(filename, LEAF_FMT "/%s", first_name[0], first_name);
363 * Has this primary name been written since the first call to
364 * write_entry()? If so, the newer write will step on the older,
367 if (start_time > 0 &&
368 stat(filename, &statbuf) >= 0
369 && statbuf.st_mtime >= start_time) {
370 _nc_warning("name multiply defined.");
373 check_writeable(first_name[0]);
374 write_file(filename, tp);
376 if (start_time == 0) {
377 if (stat(filename, &statbuf) < 0
378 || (start_time = statbuf.st_mtime) == 0) {
379 _nc_syserr_abort("error obtaining time from %s/%s",
380 _nc_tic_dir(0), filename);
383 while (*other_names != '\0') {
385 while (*other_names != '|' && *other_names != '\0')
388 if (*other_names != '\0')
389 *(other_names++) = '\0';
391 if (strlen(ptr) > sizeof(linkname) - 3) {
392 _nc_warning("terminal alias %s too long.", ptr);
395 if (strchr(ptr, '/') != 0) {
396 _nc_warning("cannot link alias %s.", ptr);
400 check_writeable(ptr[0]);
401 sprintf(linkname, LEAF_FMT "/%s", ptr[0], ptr);
403 if (strcmp(filename, linkname) == 0) {
404 _nc_warning("self-synonym ignored");
405 } else if (stat(linkname, &statbuf) >= 0 &&
406 statbuf.st_mtime < start_time) {
407 _nc_warning("alias %s multiply defined.", ptr);
408 } else if (_nc_access(linkname, W_OK) == 0)
413 strcpy(symlinkname, "../");
414 strncat(symlinkname, filename, sizeof(symlinkname) - 4);
415 symlinkname[sizeof(symlinkname) - 1] = '\0';
416 #endif /* USE_SYMLINKS */
418 code = remove(linkname);
420 code = unlink(linkname);
422 if (code != 0 && errno == ENOENT)
425 if (symlink(symlinkname, linkname) < 0)
427 if (link(filename, linkname) < 0)
428 #endif /* USE_SYMLINKS */
431 * If there wasn't anything there, and we cannot
432 * link to the target because it is the same as the
433 * target, then the source must be on a filesystem
434 * that uses caseless filenames, such as Win32, etc.
436 if (code == 0 && errno == EEXIST)
437 _nc_warning("can't link %s to %s", filename, linkname);
438 else if (code == 0 && (errno == EPERM || errno == ENOENT))
439 write_file(linkname, tp);
441 #if MIXEDCASE_FILENAMES
442 _nc_syserr_abort("can't link %s to %s", filename, linkname);
444 _nc_warning("can't link %s to %s (errno=%d)", filename,
449 DEBUG(1, ("Linked %s", linkname));
452 #else /* just make copies */
453 write_file(linkname, tp);
454 #endif /* HAVE_LINK */
456 #endif /* USE_HASHED_DB */
460 fake_write(char *dst,
467 int have = (limit - *offset);
471 if ((int) want > have)
473 memcpy(dst + *offset, src, want);
478 return (int) (want / size);
481 #define Write(buf, size, count) fake_write(buffer, offset, limit, (char *) buf, count, size)
483 #undef LITTLE_ENDIAN /* BSD/OS defines this as a feature macro */
484 #define HI(x) ((x) / 256)
485 #define LO(x) ((x) % 256)
486 #define LITTLE_ENDIAN(p, x) (p)[0] = LO(x), (p)[1] = HI(x)
488 #define WRITE_STRING(str) (Write(str, sizeof(char), strlen(str) + 1) == strlen(str) + 1)
491 compute_offsets(char **Strings, unsigned strmax, short *offsets)
496 for (i = 0; i < strmax; i++) {
497 if (Strings[i] == ABSENT_STRING) {
499 } else if (Strings[i] == CANCELLED_STRING) {
502 offsets[i] = nextfree;
503 nextfree += strlen(Strings[i]) + 1;
504 TRACE_OUT(("put Strings[%d]=%s(%d)", (int) i,
505 _nc_visbuf(Strings[i]), nextfree));
512 convert_shorts(unsigned char *buf, short *Numbers, unsigned count)
515 for (i = 0; i < count; i++) {
516 if (Numbers[i] == ABSENT_NUMERIC) { /* HI/LO won't work */
517 buf[2 * i] = buf[2 * i + 1] = 0377;
518 } else if (Numbers[i] == CANCELLED_NUMERIC) { /* HI/LO won't work */
520 buf[2 * i + 1] = 0377;
522 LITTLE_ENDIAN(buf + 2 * i, Numbers[i]);
523 TRACE_OUT(("put Numbers[%d]=%d", i, Numbers[i]));
528 #define even_boundary(value) \
529 ((value) % 2 != 0 && Write(&zero, sizeof(char), 1) != 1)
533 extended_Booleans(TERMTYPE *tp)
535 unsigned short result = 0;
538 for (i = 0; i < tp->ext_Booleans; ++i) {
539 if (tp->Booleans[BOOLCOUNT + i] == TRUE)
546 extended_Numbers(TERMTYPE *tp)
548 unsigned short result = 0;
551 for (i = 0; i < tp->ext_Numbers; ++i) {
552 if (tp->Numbers[NUMCOUNT + i] != ABSENT_NUMERIC)
559 extended_Strings(TERMTYPE *tp)
561 unsigned short result = 0;
564 for (i = 0; i < tp->ext_Strings; ++i) {
565 if (tp->Strings[STRCOUNT + i] != ABSENT_STRING)
572 * _nc_align_termtype() will extend entries that are referenced in a use=
573 * clause - discard the unneeded data.
576 extended_object(TERMTYPE *tp)
580 if (_nc_user_definable) {
581 result = ((extended_Booleans(tp)
582 + extended_Numbers(tp)
583 + extended_Strings(tp)) != 0);
590 write_object(TERMTYPE *tp, char *buffer, unsigned *offset, unsigned limit)
593 size_t namelen, boolmax, nummax, strmax;
597 short offsets[MAX_ENTRY_SIZE / 2];
598 unsigned char buf[MAX_ENTRY_SIZE];
599 unsigned last_bool = BOOLWRITE;
600 unsigned last_num = NUMWRITE;
601 unsigned last_str = STRWRITE;
605 * Normally we limit the list of values to exclude the "obsolete"
606 * capabilities. However, if we are accepting extended names, add
607 * these as well, since they are used for supporting translation
610 if (_nc_user_definable) {
611 last_bool = BOOLCOUNT;
617 namelist = tp->term_names;
618 namelen = strlen(namelist) + 1;
621 for (i = 0; i < last_bool; i++) {
622 if (tp->Booleans[i] == TRUE)
627 for (i = 0; i < last_num; i++) {
628 if (tp->Numbers[i] != ABSENT_NUMERIC)
633 for (i = 0; i < last_str; i++) {
634 if (tp->Strings[i] != ABSENT_STRING)
638 nextfree = compute_offsets(tp->Strings, strmax, offsets);
640 /* fill in the header */
641 LITTLE_ENDIAN(buf, MAGIC);
642 LITTLE_ENDIAN(buf + 2, min(namelen, MAX_NAME_SIZE + 1));
643 LITTLE_ENDIAN(buf + 4, boolmax);
644 LITTLE_ENDIAN(buf + 6, nummax);
645 LITTLE_ENDIAN(buf + 8, strmax);
646 LITTLE_ENDIAN(buf + 10, nextfree);
648 /* write out the header */
649 TRACE_OUT(("Header of %s @%d", namelist, *offset));
650 if (Write(buf, 12, 1) != 1
651 || Write(namelist, sizeof(char), namelen) != namelen)
654 for (i = 0; i < boolmax; i++)
655 if (tp->Booleans[i] == TRUE)
659 if (Write(buf, sizeof(char), boolmax) != boolmax)
662 if (even_boundary(namelen + boolmax))
665 TRACE_OUT(("Numerics begin at %04x", *offset));
668 convert_shorts(buf, tp->Numbers, nummax);
669 if (Write(buf, 2, nummax) != nummax)
672 TRACE_OUT(("String offsets begin at %04x", *offset));
674 /* the string offsets */
675 convert_shorts(buf, offsets, strmax);
676 if (Write(buf, 2, strmax) != strmax)
679 TRACE_OUT(("String table begins at %04x", *offset));
682 for (i = 0; i < strmax; i++)
683 if (VALID_STRING(tp->Strings[i]))
684 if (!WRITE_STRING(tp->Strings[i]))
688 if (extended_object(tp)) {
689 unsigned extcnt = NUM_EXT_NAMES(tp);
691 if (even_boundary(nextfree))
694 nextfree = compute_offsets(tp->Strings + STRCOUNT, tp->ext_Strings, offsets);
695 TRACE_OUT(("after extended string capabilities, nextfree=%d", nextfree));
696 nextfree += compute_offsets(tp->ext_Names, extcnt, offsets + tp->ext_Strings);
697 TRACE_OUT(("after extended capnames, nextfree=%d", nextfree));
698 strmax = tp->ext_Strings + extcnt;
701 * Write the extended header
703 LITTLE_ENDIAN(buf + 0, tp->ext_Booleans);
704 LITTLE_ENDIAN(buf + 2, tp->ext_Numbers);
705 LITTLE_ENDIAN(buf + 4, tp->ext_Strings);
706 LITTLE_ENDIAN(buf + 6, strmax);
707 LITTLE_ENDIAN(buf + 8, nextfree);
708 TRACE_OUT(("WRITE extended-header @%d", *offset));
709 if (Write(buf, 10, 1) != 1)
712 TRACE_OUT(("WRITE %d booleans @%d", tp->ext_Booleans, *offset));
714 && Write(tp->Booleans + BOOLCOUNT, sizeof(char),
715 tp->ext_Booleans) != tp->ext_Booleans)
718 if (even_boundary(tp->ext_Booleans))
721 TRACE_OUT(("WRITE %d numbers @%d", tp->ext_Numbers, *offset));
722 if (tp->ext_Numbers) {
723 convert_shorts(buf, tp->Numbers + NUMCOUNT, tp->ext_Numbers);
724 if (Write(buf, 2, tp->ext_Numbers) != tp->ext_Numbers)
729 * Convert the offsets for the ext_Strings and ext_Names tables,
732 convert_shorts(buf, offsets, strmax);
733 TRACE_OUT(("WRITE offsets @%d", *offset));
734 if (Write(buf, 2, strmax) != strmax)
738 * Write the string table after the offset tables so we do not
739 * have to do anything about alignment.
741 for (i = 0; i < tp->ext_Strings; i++) {
742 if (VALID_STRING(tp->Strings[i + STRCOUNT])) {
743 TRACE_OUT(("WRITE ext_Strings[%d]=%s", (int) i,
744 _nc_visbuf(tp->Strings[i + STRCOUNT])));
745 if (!WRITE_STRING(tp->Strings[i + STRCOUNT]))
751 * Write the extended names
753 for (i = 0; i < extcnt; i++) {
754 TRACE_OUT(("WRITE ext_Names[%d]=%s", (int) i, tp->ext_Names[i]));
755 if (!WRITE_STRING(tp->ext_Names[i]))
760 #endif /* NCURSES_XNAMES */
767 * Returns the total number of entries written by this process
770 _nc_tic_written(void)
772 return total_written;