1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 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.75 2009/12/05 21:25:01 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 static const char suffix[] = DBM_SUFFIX;
141 unsigned have = strlen(dst);
142 unsigned need = strlen(suffix);
143 if (have > need && strcmp(dst + have - need, suffix)) {
144 if (have + need <= limit)
156 * Make a database-root if it doesn't exist.
159 make_db_root(const char *path)
162 char fullpath[PATH_MAX];
164 if ((rc = make_db_path(fullpath, path, sizeof(fullpath))) == 0) {
168 if ((capdbp = _nc_db_open(fullpath, TRUE)) == NULL)
170 else if (_nc_db_close(capdbp) < 0)
175 if ((rc = stat(path, &statbuf)) < 0) {
177 #if !defined(__MINGW32__)
181 } else if (_nc_access(path, R_OK | W_OK | X_OK) < 0) {
182 rc = -1; /* permission denied */
183 } else if (!(S_ISDIR(statbuf.st_mode))) {
184 rc = -1; /* not a directory */
192 * Set the write directory for compiled entries.
195 _nc_set_writedir(char *dir)
197 const char *destination;
198 char actual[PATH_MAX];
201 && use_terminfo_vars())
202 dir = getenv("TERMINFO");
205 (void) _nc_tic_dir(dir);
207 destination = _nc_tic_dir(0);
208 if (make_db_root(destination) < 0) {
209 char *home = _nc_home_terminfo();
213 if (make_db_root(destination) < 0)
214 _nc_err_abort("%s: permission denied (errno %d)",
220 * Note: because of this code, this logic should be exercised
221 * *once only* per run.
224 make_db_path(actual, destination, sizeof(actual));
226 if (chdir(_nc_tic_dir(destination)) < 0
227 || getcwd(actual, sizeof(actual)) == 0)
228 _nc_err_abort("%s: not a directory", destination);
230 _nc_keep_tic_dir(strdup(actual));
234 * Save the compiled version of a description in the filesystem.
236 * make a copy of the name-list
237 * break it up into first-name and all-but-last-name
239 * write object information to first-name
241 * for each name in all-but-last-name
244 * Using 'time()' to obtain a reference for file timestamps is unreliable,
245 * e.g., with NFS, because the filesystem may have a different time
246 * reference. We check for pre-existence of links by latching the first
247 * timestamp from a file that we create.
249 * The _nc_warning() calls will report a correct line number only if
250 * _nc_curr_line is properly set before the write_entry() call.
254 _nc_write_entry(TERMTYPE *const tp)
258 char buffer[MAX_ENTRY_SIZE + 1];
259 unsigned limit = sizeof(buffer);
262 #else /* !USE_HASHED_DB */
265 char filename[PATH_MAX];
266 char linkname[PATH_MAX];
268 char symlinkname[PATH_MAX];
273 #endif /* USE_SYMLINKS */
275 static int call_count;
276 static time_t start_time; /* time at start of writes */
278 #endif /* USE_HASHED_DB */
280 char name_list[MAX_TERMINFO_LENGTH];
281 char *first_name, *other_names;
284 assert(strlen(tp->term_names) != 0);
285 assert(strlen(tp->term_names) < sizeof(name_list));
287 (void) strcpy(name_list, tp->term_names);
288 DEBUG(7, ("Name list = '%s'", name_list));
290 first_name = name_list;
292 ptr = &name_list[strlen(name_list) - 1];
293 other_names = ptr + 1;
295 while (ptr > name_list && *ptr != '|')
298 if (ptr != name_list) {
301 for (ptr = name_list; *ptr != '\0' && *ptr != '|'; ptr++)
308 other_names = ptr + 1;
312 DEBUG(7, ("First name = '%s'", first_name));
313 DEBUG(7, ("Other names = '%s'", other_names));
315 _nc_set_type(first_name);
318 if (write_object(tp, buffer + 1, &offset, limit - 1) != ERR) {
319 DB *capdb = _nc_db_open(_nc_tic_dir(0), TRUE);
325 memset(&key, 0, sizeof(key));
326 key.data = tp->term_names;
327 key.size = strlen(tp->term_names);
329 memset(&data, 0, sizeof(data));
331 data.size = offset + 1;
333 _nc_db_put(capdb, &key, &data);
337 key.data = name_list;
338 key.size = strlen(name_list);
340 strcpy(buffer + 1, tp->term_names);
341 data.size = strlen(tp->term_names) + 1;
343 _nc_db_put(capdb, &key, &data);
345 while (*other_names != '\0') {
347 assert(ptr < buffer + sizeof(buffer) - 1);
348 while (*other_names != '|' && *other_names != '\0')
351 if (*other_names != '\0')
352 *(other_names++) = '\0';
355 key.size = strlen(ptr);
357 _nc_db_put(capdb, &key, &data);
362 #else /* !USE_HASHED_DB */
363 if (call_count++ == 0) {
367 if (strlen(first_name) >= sizeof(filename) - (2 + LEAF_LEN))
368 _nc_warning("terminal name too long.");
370 sprintf(filename, LEAF_FMT "/%s", first_name[0], first_name);
373 * Has this primary name been written since the first call to
374 * write_entry()? If so, the newer write will step on the older,
377 if (start_time > 0 &&
378 stat(filename, &statbuf) >= 0
379 && statbuf.st_mtime >= start_time) {
380 _nc_warning("name multiply defined.");
383 check_writeable(first_name[0]);
384 write_file(filename, tp);
386 if (start_time == 0) {
387 if (stat(filename, &statbuf) < 0
388 || (start_time = statbuf.st_mtime) == 0) {
389 _nc_syserr_abort("error obtaining time from %s/%s",
390 _nc_tic_dir(0), filename);
393 while (*other_names != '\0') {
395 while (*other_names != '|' && *other_names != '\0')
398 if (*other_names != '\0')
399 *(other_names++) = '\0';
401 if (strlen(ptr) > sizeof(linkname) - (2 + LEAF_LEN)) {
402 _nc_warning("terminal alias %s too long.", ptr);
405 if (strchr(ptr, '/') != 0) {
406 _nc_warning("cannot link alias %s.", ptr);
410 check_writeable(ptr[0]);
411 sprintf(linkname, LEAF_FMT "/%s", ptr[0], ptr);
413 if (strcmp(filename, linkname) == 0) {
414 _nc_warning("self-synonym ignored");
415 } else if (stat(linkname, &statbuf) >= 0 &&
416 statbuf.st_mtime < start_time) {
417 _nc_warning("alias %s multiply defined.", ptr);
418 } else if (_nc_access(linkname, W_OK) == 0)
423 if (first_name[0] == linkname[0])
424 strncpy(symlinkname, first_name, sizeof(symlinkname) - 1);
426 strcpy(symlinkname, "../");
427 strncat(symlinkname, filename, sizeof(symlinkname) - 4);
429 symlinkname[sizeof(symlinkname) - 1] = '\0';
430 #endif /* USE_SYMLINKS */
432 code = remove(linkname);
434 code = unlink(linkname);
436 if (code != 0 && errno == ENOENT)
439 if (symlink(symlinkname, linkname) < 0)
441 if (link(filename, linkname) < 0)
442 #endif /* USE_SYMLINKS */
445 * If there wasn't anything there, and we cannot
446 * link to the target because it is the same as the
447 * target, then the source must be on a filesystem
448 * that uses caseless filenames, such as Win32, etc.
450 if (code == 0 && errno == EEXIST)
451 _nc_warning("can't link %s to %s", filename, linkname);
452 else if (code == 0 && (errno == EPERM || errno == ENOENT))
453 write_file(linkname, tp);
455 #if MIXEDCASE_FILENAMES
456 _nc_syserr_abort("can't link %s to %s", filename, linkname);
458 _nc_warning("can't link %s to %s (errno=%d)", filename,
463 DEBUG(1, ("Linked %s", linkname));
466 #else /* just make copies */
467 write_file(linkname, tp);
468 #endif /* HAVE_LINK */
470 #endif /* USE_HASHED_DB */
474 fake_write(char *dst,
481 unsigned have = (limit - *offset);
487 memcpy(dst + *offset, src, want);
492 return (want / size);
495 #define Write(buf, size, count) fake_write(buffer, offset, limit, (char *) buf, count, size)
497 #undef LITTLE_ENDIAN /* BSD/OS defines this as a feature macro */
498 #define HI(x) ((x) / 256)
499 #define LO(x) ((x) % 256)
500 #define LITTLE_ENDIAN(p, x) (p)[0] = (unsigned char)LO(x), \
501 (p)[1] = (unsigned char)HI(x)
503 #define WRITE_STRING(str) (Write(str, sizeof(char), strlen(str) + 1) == strlen(str) + 1)
506 compute_offsets(char **Strings, unsigned strmax, short *offsets)
511 for (i = 0; i < strmax; i++) {
512 if (Strings[i] == ABSENT_STRING) {
514 } else if (Strings[i] == CANCELLED_STRING) {
517 offsets[i] = (short) nextfree;
518 nextfree += (int) strlen(Strings[i]) + 1;
519 TRACE_OUT(("put Strings[%d]=%s(%d)", (int) i,
520 _nc_visbuf(Strings[i]), (int) nextfree));
527 convert_shorts(unsigned char *buf, short *Numbers, unsigned count)
530 for (i = 0; i < count; i++) {
531 if (Numbers[i] == ABSENT_NUMERIC) { /* HI/LO won't work */
532 buf[2 * i] = buf[2 * i + 1] = 0377;
533 } else if (Numbers[i] == CANCELLED_NUMERIC) { /* HI/LO won't work */
535 buf[2 * i + 1] = 0377;
537 LITTLE_ENDIAN(buf + 2 * i, Numbers[i]);
538 TRACE_OUT(("put Numbers[%d]=%d", i, Numbers[i]));
543 #define even_boundary(value) \
544 ((value) % 2 != 0 && Write(&zero, sizeof(char), 1) != 1)
548 extended_Booleans(TERMTYPE *tp)
553 for (i = 0; i < tp->ext_Booleans; ++i) {
554 if (tp->Booleans[BOOLCOUNT + i] == TRUE)
561 extended_Numbers(TERMTYPE *tp)
566 for (i = 0; i < tp->ext_Numbers; ++i) {
567 if (tp->Numbers[NUMCOUNT + i] != ABSENT_NUMERIC)
574 extended_Strings(TERMTYPE *tp)
576 unsigned short result = 0;
579 for (i = 0; i < tp->ext_Strings; ++i) {
580 if (tp->Strings[STRCOUNT + i] != ABSENT_STRING)
587 * _nc_align_termtype() will extend entries that are referenced in a use=
588 * clause - discard the unneeded data.
591 extended_object(TERMTYPE *tp)
595 if (_nc_user_definable) {
596 result = ((extended_Booleans(tp)
597 + extended_Numbers(tp)
598 + extended_Strings(tp)) != 0);
605 write_object(TERMTYPE *tp, char *buffer, unsigned *offset, unsigned limit)
608 size_t namelen, boolmax, nummax, strmax;
612 short offsets[MAX_ENTRY_SIZE / 2];
613 unsigned char buf[MAX_ENTRY_SIZE];
614 unsigned last_bool = BOOLWRITE;
615 unsigned last_num = NUMWRITE;
616 unsigned last_str = STRWRITE;
620 * Normally we limit the list of values to exclude the "obsolete"
621 * capabilities. However, if we are accepting extended names, add
622 * these as well, since they are used for supporting translation
625 if (_nc_user_definable) {
626 last_bool = BOOLCOUNT;
632 namelist = tp->term_names;
633 namelen = strlen(namelist) + 1;
636 for (i = 0; i < last_bool; i++) {
637 if (tp->Booleans[i] == TRUE)
642 for (i = 0; i < last_num; i++) {
643 if (tp->Numbers[i] != ABSENT_NUMERIC)
648 for (i = 0; i < last_str; i++) {
649 if (tp->Strings[i] != ABSENT_STRING)
653 nextfree = compute_offsets(tp->Strings, strmax, offsets);
655 /* fill in the header */
656 LITTLE_ENDIAN(buf, MAGIC);
657 LITTLE_ENDIAN(buf + 2, min(namelen, MAX_NAME_SIZE + 1));
658 LITTLE_ENDIAN(buf + 4, boolmax);
659 LITTLE_ENDIAN(buf + 6, nummax);
660 LITTLE_ENDIAN(buf + 8, strmax);
661 LITTLE_ENDIAN(buf + 10, nextfree);
663 /* write out the header */
664 TRACE_OUT(("Header of %s @%d", namelist, *offset));
665 if (Write(buf, 12, 1) != 1
666 || Write(namelist, sizeof(char), namelen) != namelen)
669 for (i = 0; i < boolmax; i++)
670 if (tp->Booleans[i] == TRUE)
674 if (Write(buf, sizeof(char), boolmax) != boolmax)
677 if (even_boundary(namelen + boolmax))
680 TRACE_OUT(("Numerics begin at %04x", *offset));
683 convert_shorts(buf, tp->Numbers, nummax);
684 if (Write(buf, 2, nummax) != nummax)
687 TRACE_OUT(("String offsets begin at %04x", *offset));
689 /* the string offsets */
690 convert_shorts(buf, offsets, strmax);
691 if (Write(buf, 2, strmax) != strmax)
694 TRACE_OUT(("String table begins at %04x", *offset));
697 for (i = 0; i < strmax; i++)
698 if (VALID_STRING(tp->Strings[i]))
699 if (!WRITE_STRING(tp->Strings[i]))
703 if (extended_object(tp)) {
704 unsigned extcnt = (unsigned) NUM_EXT_NAMES(tp);
706 if (even_boundary(nextfree))
709 nextfree = compute_offsets(tp->Strings + STRCOUNT,
712 TRACE_OUT(("after extended string capabilities, nextfree=%d", nextfree));
714 if (tp->ext_Strings >= SIZEOF(offsets))
717 nextfree += compute_offsets(tp->ext_Names,
719 offsets + tp->ext_Strings);
720 TRACE_OUT(("after extended capnames, nextfree=%d", nextfree));
721 strmax = tp->ext_Strings + extcnt;
724 * Write the extended header
726 LITTLE_ENDIAN(buf + 0, tp->ext_Booleans);
727 LITTLE_ENDIAN(buf + 2, tp->ext_Numbers);
728 LITTLE_ENDIAN(buf + 4, tp->ext_Strings);
729 LITTLE_ENDIAN(buf + 6, strmax);
730 LITTLE_ENDIAN(buf + 8, nextfree);
731 TRACE_OUT(("WRITE extended-header @%d", *offset));
732 if (Write(buf, 10, 1) != 1)
735 TRACE_OUT(("WRITE %d booleans @%d", tp->ext_Booleans, *offset));
737 && Write(tp->Booleans + BOOLCOUNT, sizeof(char),
738 tp->ext_Booleans) != tp->ext_Booleans)
741 if (even_boundary(tp->ext_Booleans))
744 TRACE_OUT(("WRITE %d numbers @%d", tp->ext_Numbers, *offset));
745 if (tp->ext_Numbers) {
746 convert_shorts(buf, tp->Numbers + NUMCOUNT, tp->ext_Numbers);
747 if (Write(buf, 2, tp->ext_Numbers) != tp->ext_Numbers)
752 * Convert the offsets for the ext_Strings and ext_Names tables,
755 convert_shorts(buf, offsets, strmax);
756 TRACE_OUT(("WRITE offsets @%d", *offset));
757 if (Write(buf, 2, strmax) != strmax)
761 * Write the string table after the offset tables so we do not
762 * have to do anything about alignment.
764 for (i = 0; i < tp->ext_Strings; i++) {
765 if (VALID_STRING(tp->Strings[i + STRCOUNT])) {
766 TRACE_OUT(("WRITE ext_Strings[%d]=%s", (int) i,
767 _nc_visbuf(tp->Strings[i + STRCOUNT])));
768 if (!WRITE_STRING(tp->Strings[i + STRCOUNT]))
774 * Write the extended names
776 for (i = 0; i < extcnt; i++) {
777 TRACE_OUT(("WRITE ext_Names[%d]=%s", (int) i, tp->ext_Names[i]));
778 if (!WRITE_STRING(tp->ext_Names[i]))
783 #endif /* NCURSES_XNAMES */
790 * Returns the total number of entries written by this process
793 _nc_tic_written(void)
795 return total_written;