1/**************************************************************************** 2 * Copyright (c) 1998-2000,2002 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: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 * 31 * and: Eric S. Raymond <esr@snark.thyrsus.com> * 32 ****************************************************************************/ 33 34/* 35 * write_entry.c -- write a terminfo structure onto the file system 36 */ 37 38#include <curses.priv.h> 39 40#include <sys/stat.h> 41 42#include <tic.h> 43#include <term_entry.h> 44 45#ifndef S_ISDIR 46#define S_ISDIR(mode) ((mode & S_IFMT) == S_IFDIR) 47#endif 48 49#if 0 50#define TRACE_OUT(p) DEBUG(2, p) 51#else 52#define TRACE_OUT(p) /*nothing */ 53#endif 54 55MODULE_ID("$Id: write_entry.c,v 1.58 2002/04/21 20:35:08 tom Exp $") 56 57static int total_written; 58 59static int write_object(FILE *, TERMTYPE *); 60 61static void 62write_file(char *filename, TERMTYPE * tp) 63{ 64 FILE *fp = (_nc_access(filename, W_OK) == 0) ? fopen(filename, "wb") : 0; 65 if (fp == 0) { 66 perror(filename); 67 _nc_syserr_abort("can't open %s/%s", _nc_tic_dir(0), filename); 68 } 69 DEBUG(1, ("Created %s", filename)); 70 71 if (write_object(fp, tp) == ERR) { 72 _nc_syserr_abort("error writing %s/%s", _nc_tic_dir(0), filename); 73 } 74 fclose(fp); 75} 76 77/* 78 * make_directory(char *path) 79 * 80 * Make a directory if it doesn't exist. 81 */ 82static int 83make_directory(const char *path) 84{ 85 int rc; 86 struct stat statbuf; 87 char fullpath[PATH_MAX]; 88 const char *destination = _nc_tic_dir(0); 89 90 if (path == destination || *path == '/') { 91 if (strlen(path) + 1 > sizeof(fullpath)) 92 return (-1); 93 (void) strcpy(fullpath, path); 94 } else { 95 if (strlen(destination) + strlen(path) + 2 > sizeof(fullpath)) 96 return (-1); 97 (void) sprintf(fullpath, "%s/%s", destination, path); 98 } 99 100 if ((rc = stat(path, &statbuf)) < 0) { 101 rc = mkdir(path, 0777); 102 } else { 103 if (_nc_access(path, R_OK | W_OK | X_OK) < 0) { 104 rc = -1; /* permission denied */ 105 } else if (!(S_ISDIR(statbuf.st_mode))) { 106 rc = -1; /* not a directory */ 107 } 108 } 109 return rc; 110} 111 112NCURSES_EXPORT(void) 113_nc_set_writedir(char *dir) 114/* set the write directory for compiled entries */ 115{ 116 const char *destination; 117 char actual[PATH_MAX]; 118 119 if (dir == 0 120 && use_terminfo_vars()) 121 dir = getenv("TERMINFO"); 122 123 if (dir != 0) 124 (void) _nc_tic_dir(dir); 125 126 destination = _nc_tic_dir(0); 127 if (make_directory(destination) < 0) { 128 char *home = _nc_home_terminfo(); 129 130 if (home != 0) { 131 destination = home; 132 if (make_directory(destination) < 0) 133 _nc_err_abort("%s: permission denied (errno %d)", 134 destination, errno); 135 } 136 } 137 138 /* 139 * Note: because of this code, this logic should be exercised 140 * *once only* per run. 141 */ 142 if (chdir(_nc_tic_dir(destination)) < 0 143 || getcwd(actual, sizeof(actual)) == 0) 144 _nc_err_abort("%s: not a directory", destination); 145 _nc_keep_tic_dir(strdup(actual)); 146} 147 148/* 149 * check_writeable(char code) 150 * 151 * Miscellaneous initialisations 152 * 153 * Check for access rights to destination directories 154 * Create any directories which don't exist. 155 * Note: there's no reason to return the result of make_directory(), since 156 * this function is called only in instances where that has to succeed. 157 * 158 */ 159 160static void 161check_writeable(int code) 162{ 163 static const char dirnames[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; 164 static bool verified[sizeof(dirnames)]; 165 166 char dir[2]; 167 char *s = 0; 168 169 if (code == 0 || (s = strchr(dirnames, code)) == 0) 170 _nc_err_abort("Illegal terminfo subdirectory \"%c\"", code); 171 172 if (verified[s - dirnames]) 173 return; 174 175 dir[0] = code; 176 dir[1] = '\0'; 177 if (make_directory(dir) < 0) { 178 _nc_err_abort("%s/%s: permission denied", _nc_tic_dir(0), dir); 179 } 180 181 verified[s - dirnames] = TRUE; 182} 183 184/* 185 * _nc_write_entry() 186 * 187 * Save the compiled version of a description in the filesystem. 188 * 189 * make a copy of the name-list 190 * break it up into first-name and all-but-last-name 191 * creat(first-name) 192 * write object information to first-name 193 * close(first-name) 194 * for each name in all-but-last-name 195 * link to first-name 196 * 197 * Using 'time()' to obtain a reference for file timestamps is unreliable, 198 * e.g., with NFS, because the filesystem may have a different time 199 * reference. We check for pre-existence of links by latching the first 200 * timestamp from a file that we create. 201 * 202 * The _nc_warning() calls will report a correct line number only if 203 * _nc_curr_line is properly set before the write_entry() call. 204 */ 205 206void 207_nc_write_entry(TERMTYPE * const tp) 208{ 209 struct stat statbuf; 210 char name_list[MAX_TERMINFO_LENGTH]; 211 char *first_name, *other_names; 212 char *ptr; 213 char filename[PATH_MAX]; 214 char linkname[PATH_MAX]; 215#if USE_SYMLINKS 216 char symlinkname[PATH_MAX]; 217#if !HAVE_LINK 218#undef HAVE_LINK 219#define HAVE_LINK 1 220#endif 221#endif /* USE_SYMLINKS */ 222 static int call_count; 223 static time_t start_time; /* time at start of writes */ 224 225 if (call_count++ == 0) { 226 start_time = 0; 227 } 228 229 (void) strcpy(name_list, tp->term_names); 230 DEBUG(7, ("Name list = '%s'", name_list)); 231 232 first_name = name_list; 233 234 ptr = &name_list[strlen(name_list) - 1]; 235 other_names = ptr + 1; 236 237 while (ptr > name_list && *ptr != '|') 238 ptr--; 239 240 if (ptr != name_list) { 241 *ptr = '\0'; 242 243 for (ptr = name_list; *ptr != '\0' && *ptr != '|'; ptr++) 244 continue; 245 246 if (*ptr == '\0') 247 other_names = ptr; 248 else { 249 *ptr = '\0'; 250 other_names = ptr + 1; 251 } 252 } 253 254 DEBUG(7, ("First name = '%s'", first_name)); 255 DEBUG(7, ("Other names = '%s'", other_names)); 256 257 _nc_set_type(first_name); 258 259 if (strlen(first_name) > sizeof(filename) - 3) 260 _nc_warning("terminal name too long."); 261 262 sprintf(filename, "%c/%s", first_name[0], first_name); 263 264 /* 265 * Has this primary name been written since the first call to 266 * write_entry()? If so, the newer write will step on the older, 267 * so warn the user. 268 */ 269 if (start_time > 0 && 270 stat(filename, &statbuf) >= 0 271 && statbuf.st_mtime >= start_time) { 272 _nc_warning("name multiply defined."); 273 } 274 275 check_writeable(first_name[0]); 276 write_file(filename, tp); 277 278 if (start_time == 0) { 279 if (stat(filename, &statbuf) < 0 280 || (start_time = statbuf.st_mtime) == 0) { 281 _nc_syserr_abort("error obtaining time from %s/%s", 282 _nc_tic_dir(0), filename); 283 } 284 } 285 while (*other_names != '\0') { 286 ptr = other_names++; 287 while (*other_names != '|' && *other_names != '\0') 288 other_names++; 289 290 if (*other_names != '\0') 291 *(other_names++) = '\0'; 292 293 if (strlen(ptr) > sizeof(linkname) - 3) { 294 _nc_warning("terminal alias %s too long.", ptr); 295 continue; 296 } 297 if (strchr(ptr, '/') != 0) { 298 _nc_warning("cannot link alias %s.", ptr); 299 continue; 300 } 301 302 check_writeable(ptr[0]); 303 sprintf(linkname, "%c/%s", ptr[0], ptr); 304 305 if (strcmp(filename, linkname) == 0) { 306 _nc_warning("self-synonym ignored"); 307 } else if (stat(linkname, &statbuf) >= 0 && 308 statbuf.st_mtime < start_time) { 309 _nc_warning("alias %s multiply defined.", ptr); 310 } else if (_nc_access(linkname, W_OK) == 0) 311#if HAVE_LINK 312 { 313 int code; 314#if USE_SYMLINKS 315 strcpy(symlinkname, "../"); 316 strncat(symlinkname, filename, sizeof(symlinkname) - 4); 317 symlinkname[sizeof(symlinkname) - 1] = '\0'; 318#endif /* USE_SYMLINKS */ 319#if HAVE_REMOVE 320 code = remove(linkname); 321#else 322 code = unlink(linkname); 323#endif 324 if (code != 0 && errno == ENOENT) 325 code = 0; 326#if USE_SYMLINKS 327 if (symlink(symlinkname, linkname) < 0) 328#else 329 if (link(filename, linkname) < 0) 330#endif /* USE_SYMLINKS */ 331 { 332 /* 333 * If there wasn't anything there, and we cannot 334 * link to the target because it is the same as the 335 * target, then the source must be on a filesystem 336 * that uses caseless filenames, such as Win32, etc. 337 */ 338 if (code == 0 && errno == EEXIST) 339 _nc_warning("can't link %s to %s", filename, linkname); 340 else if (code == 0 && (errno == EPERM || errno == ENOENT)) 341 write_file(linkname, tp); 342 else { 343#if MIXEDCASE_FILENAMES 344 _nc_syserr_abort("can't link %s to %s", filename, linkname); 345#else 346 _nc_warning("can't link %s to %s (errno=%d)", filename, 347 linkname, errno); 348#endif 349 } 350 } else { 351 DEBUG(1, ("Linked %s", linkname)); 352 } 353 } 354#else /* just make copies */ 355 write_file(linkname, tp); 356#endif /* HAVE_LINK */ 357 } 358} 359 360#undef LITTLE_ENDIAN /* BSD/OS defines this as a feature macro */ 361#define HI(x) ((x) / 256) 362#define LO(x) ((x) % 256) 363#define LITTLE_ENDIAN(p, x) (p)[0] = LO(x), (p)[1] = HI(x) 364 365#define WRITE_STRING(str) (fwrite(str, sizeof(char), strlen(str) + 1, fp) == strlen(str) + 1) 366 367static int 368compute_offsets(char **Strings, unsigned strmax, short *offsets) 369{ 370 size_t nextfree = 0; 371 unsigned i; 372 373 for (i = 0; i < strmax; i++) { 374 if (Strings[i] == ABSENT_STRING) { 375 offsets[i] = -1; 376 } else if (Strings[i] == CANCELLED_STRING) { 377 offsets[i] = -2; 378 } else { 379 offsets[i] = nextfree; 380 nextfree += strlen(Strings[i]) + 1; 381 TRACE_OUT(("put Strings[%d]=%s(%d)", i, _nc_visbuf(Strings[i]), nextfree)); 382 } 383 } 384 return nextfree; 385} 386 387static void 388convert_shorts(unsigned char *buf, short *Numbers, unsigned count) 389{ 390 unsigned i; 391 for (i = 0; i < count; i++) { 392 if (Numbers[i] == ABSENT_NUMERIC) { /* HI/LO won't work */ 393 buf[2 * i] = buf[2 * i + 1] = 0377; 394 } else if (Numbers[i] == CANCELLED_NUMERIC) { /* HI/LO won't work */ 395 buf[2 * i] = 0376; 396 buf[2 * i + 1] = 0377; 397 } else { 398 LITTLE_ENDIAN(buf + 2 * i, Numbers[i]); 399 TRACE_OUT(("put Numbers[%d]=%d", i, Numbers[i])); 400 } 401 } 402} 403 404#define even_boundary(value) \ 405 ((value) % 2 != 0 && fwrite(&zero, sizeof(char), 1, fp) != 1) 406 407static int 408write_object(FILE * fp, TERMTYPE * tp) 409{ 410 char *namelist; 411 size_t namelen, boolmax, nummax, strmax; 412 char zero = '\0'; 413 size_t i; 414 short nextfree; 415 short offsets[MAX_ENTRY_SIZE / 2]; 416 unsigned char buf[MAX_ENTRY_SIZE]; 417 unsigned last_bool = BOOLWRITE; 418 unsigned last_num = NUMWRITE; 419 unsigned last_str = STRWRITE; 420 421#if NCURSES_XNAMES 422 /* 423 * Normally we limit the list of values to exclude the "obsolete" 424 * capabilities. However, if we are accepting extended names, add 425 * these as well, since they are used for supporting translation 426 * to/from termcap. 427 */ 428 if (_nc_user_definable) { 429 last_bool = BOOLCOUNT; 430 last_num = NUMCOUNT; 431 last_str = STRCOUNT; 432 } 433#endif 434 435 namelist = tp->term_names; 436 namelen = strlen(namelist) + 1; 437 438 boolmax = 0; 439 for (i = 0; i < last_bool; i++) { 440 if (tp->Booleans[i] == TRUE) 441 boolmax = i + 1; 442 } 443 444 nummax = 0; 445 for (i = 0; i < last_num; i++) { 446 if (tp->Numbers[i] != ABSENT_NUMERIC) 447 nummax = i + 1; 448 } 449 450 strmax = 0; 451 for (i = 0; i < last_str; i++) { 452 if (tp->Strings[i] != ABSENT_STRING) 453 strmax = i + 1; 454 } 455 456 nextfree = compute_offsets(tp->Strings, strmax, offsets); 457 458 /* fill in the header */ 459 LITTLE_ENDIAN(buf, MAGIC); 460 LITTLE_ENDIAN(buf + 2, min(namelen, MAX_NAME_SIZE + 1)); 461 LITTLE_ENDIAN(buf + 4, boolmax); 462 LITTLE_ENDIAN(buf + 6, nummax); 463 LITTLE_ENDIAN(buf + 8, strmax); 464 LITTLE_ENDIAN(buf + 10, nextfree); 465 466 /* write out the header */ 467 TRACE_OUT(("Header of %s @%ld", namelist, ftell(fp))); 468 if (fwrite(buf, 12, 1, fp) != 1 469 || fwrite(namelist, sizeof(char), namelen, fp) != namelen) 470 return (ERR); 471 472 for (i = 0; i < boolmax; i++) 473 if (tp->Booleans[i] == TRUE) 474 buf[i] = TRUE; 475 else 476 buf[i] = FALSE; 477 if (fwrite(buf, sizeof(char), boolmax, fp) != boolmax) 478 return (ERR); 479 480 if (even_boundary(namelen + boolmax)) 481 return (ERR); 482 483 TRACE_OUT(("Numerics begin at %04lx", ftell(fp))); 484 485 /* the numerics */ 486 convert_shorts(buf, tp->Numbers, nummax); 487 if (fwrite(buf, 2, nummax, fp) != nummax) 488 return (ERR); 489 490 TRACE_OUT(("String offsets begin at %04lx", ftell(fp))); 491 492 /* the string offsets */ 493 convert_shorts(buf, offsets, strmax); 494 if (fwrite(buf, 2, strmax, fp) != strmax) 495 return (ERR); 496 497 TRACE_OUT(("String table begins at %04lx", ftell(fp))); 498 499 /* the strings */ 500 for (i = 0; i < strmax; i++) 501 if (VALID_STRING(tp->Strings[i])) 502 if (!WRITE_STRING(tp->Strings[i])) 503 return (ERR); 504 505#if NCURSES_XNAMES 506 if (NUM_EXT_NAMES(tp)) { 507 unsigned extcnt = NUM_EXT_NAMES(tp); 508 509 if (even_boundary(nextfree)) 510 return (ERR); 511 512 nextfree = compute_offsets(tp->Strings + STRCOUNT, tp->ext_Strings, offsets); 513 TRACE_OUT(("after extended string capabilities, nextfree=%d", nextfree)); 514 nextfree += compute_offsets(tp->ext_Names, extcnt, offsets + tp->ext_Strings); 515 TRACE_OUT(("after extended capnames, nextfree=%d", nextfree)); 516 strmax = tp->ext_Strings + extcnt; 517 518 /* 519 * Write the extended header 520 */ 521 LITTLE_ENDIAN(buf + 0, tp->ext_Booleans); 522 LITTLE_ENDIAN(buf + 2, tp->ext_Numbers); 523 LITTLE_ENDIAN(buf + 4, tp->ext_Strings); 524 LITTLE_ENDIAN(buf + 6, strmax); 525 LITTLE_ENDIAN(buf + 8, nextfree); 526 TRACE_OUT(("WRITE extended-header @%ld", ftell(fp))); 527 if (fwrite(buf, 10, 1, fp) != 1) 528 return (ERR); 529 530 TRACE_OUT(("WRITE %d booleans @%ld", tp->ext_Booleans, ftell(fp))); 531 if (tp->ext_Booleans 532 && fwrite(tp->Booleans + BOOLCOUNT, sizeof(char), 533 tp->ext_Booleans, fp) != tp->ext_Booleans) 534 return (ERR); 535 536 if (even_boundary(tp->ext_Booleans)) 537 return (ERR); 538 539 TRACE_OUT(("WRITE %d numbers @%ld", tp->ext_Numbers, ftell(fp))); 540 if (tp->ext_Numbers) { 541 convert_shorts(buf, tp->Numbers + NUMCOUNT, tp->ext_Numbers); 542 if (fwrite(buf, 2, tp->ext_Numbers, fp) != tp->ext_Numbers) 543 return (ERR); 544 } 545 546 /* 547 * Convert the offsets for the ext_Strings and ext_Names tables, 548 * in that order. 549 */ 550 convert_shorts(buf, offsets, strmax); 551 TRACE_OUT(("WRITE offsets @%ld", ftell(fp))); 552 if (fwrite(buf, 2, strmax, fp) != strmax) 553 return (ERR); 554 555 /* 556 * Write the string table after the offset tables so we do not 557 * have to do anything about alignment. 558 */ 559 for (i = 0; i < tp->ext_Strings; i++) { 560 if (VALID_STRING(tp->Strings[i + STRCOUNT])) { 561 TRACE_OUT(("WRITE ext_Strings[%d]=%s", i, 562 _nc_visbuf(tp->Strings[i + STRCOUNT]))); 563 if (!WRITE_STRING(tp->Strings[i + STRCOUNT])) 564 return (ERR); 565 } 566 } 567 568 /* 569 * Write the extended names 570 */ 571 for (i = 0; i < extcnt; i++) { 572 TRACE_OUT(("WRITE ext_Names[%d]=%s", i, tp->ext_Names[i])); 573 if (!WRITE_STRING(tp->ext_Names[i])) 574 return (ERR); 575 } 576 577 } 578#endif /* NCURSES_XNAMES */ 579 580 total_written++; 581 return (OK); 582} 583 584/* 585 * Returns the total number of entries written by this process 586 */ 587NCURSES_EXPORT(int) 588_nc_tic_written(void) 589{ 590 return total_written; 591} 592