ncurses 5.9 - patch 20110604
[ncurses.git] / ncurses / tinfo / read_termcap.c
1 /****************************************************************************
2  * Copyright (c) 1998-2010,2011 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  *     and: Thomas E. Dickey                        1996-on                 *
33  ****************************************************************************/
34
35 /*
36  * Termcap compatibility support
37  *
38  * If your OS integrator didn't install a terminfo database, you can call
39  * _nc_read_termcap_entry() to support reading and translating capabilities
40  * from the system termcap file.  This is a kludge; it will bulk up and slow
41  * down every program that uses ncurses, and translated termcap entries cannot
42  * use full terminfo capabilities.  Don't use it unless you absolutely have to;
43  * instead, get your system people to run tic(1) from root on the terminfo
44  * master included with ncurses to translate it into a terminfo database.
45  *
46  * If USE_GETCAP is enabled, we use what is effectively a copy of the 4.4BSD
47  * getcap code to fetch entries.  There are disadvantages to this; mainly that
48  * getcap(3) does its own resolution, meaning that entries read in in this way
49  * can't reference the terminfo tree.  The only thing it buys is faster startup
50  * time, getcap(3) is much faster than our tic parser.
51  */
52
53 #include <curses.priv.h>
54
55 #include <ctype.h>
56 #include <sys/types.h>
57 #include <tic.h>
58
59 MODULE_ID("$Id: read_termcap.c,v 1.76 2011/06/05 00:48:00 tom Exp $")
60
61 #if !PURE_TERMINFO
62
63 #define TC_SUCCESS     0
64 #define TC_NOT_FOUND  -1
65 #define TC_SYS_ERR    -2
66 #define TC_REF_LOOP   -3
67 #define TC_UNRESOLVED -4        /* this is not returned by BSD cgetent */
68
69 static NCURSES_CONST char *
70 get_termpath(void)
71 {
72     NCURSES_CONST char *result;
73
74     if (!use_terminfo_vars() || (result = getenv("TERMPATH")) == 0)
75         result = TERMPATH;
76     T(("TERMPATH is %s", result));
77     return result;
78 }
79
80 /*
81  * Note:
82  * getcap(), cgetent(), etc., are BSD functions.  A copy of those was added to
83  * this file in November 1995, derived from the BSD4.4 Lite sources.
84  *
85  * The initial adaptation uses 518 lines from that source.
86  * The current source (in 2009) uses 183 lines of BSD4.4 Lite (441 ignoring
87  * whitespace).
88  */
89 #if USE_GETCAP
90
91 #if HAVE_BSD_CGETENT
92 #define _nc_cgetcap   cgetcap
93 #define _nc_cgetent(buf, oline, db_array, name) cgetent(buf, db_array, name)
94 #define _nc_cgetmatch cgetmatch
95 #define _nc_cgetset   cgetset
96 #else
97 static int _nc_cgetmatch(char *, const char *);
98 static int _nc_getent(char **, unsigned *, int *, int, char **, int, const char
99                       *, int, char *);
100 static int _nc_nfcmp(const char *, char *);
101
102 /*-
103  * Copyright (c) 1992, 1993
104  *      The Regents of the University of California.  All rights reserved.
105  *
106  * This code is derived from software contributed to Berkeley by
107  * Casey Leedom of Lawrence Livermore National Laboratory.
108  *
109  * Redistribution and use in source and binary forms, with or without
110  * modification, are permitted provided that the following conditions
111  * are met:
112  * 1. Redistributions of source code must retain the above copyright
113  *    notice, this list of conditions and the following disclaimer.
114  * 2. Redistributions in binary form must reproduce the above copyright
115  *    notice, this list of conditions and the following disclaimer in the
116  *    documentation and/or other materials provided with the distribution.
117  * 3. Neither the name of the University nor the names of its contributors
118  *    may be used to endorse or promote products derived from this software
119  *    without specific prior written permission.
120  *
121  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
122  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
123  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
124  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
125  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
126  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
127  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
128  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
129  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
130  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
131  * SUCH DAMAGE.
132  */
133
134 /* static char sccsid[] = "@(#)getcap.c 8.3 (Berkeley) 3/25/94"; */
135
136 #define BFRAG           1024
137 #define BSIZE           1024
138 #define MAX_RECURSION   32      /* maximum getent recursion */
139
140 static size_t topreclen;        /* toprec length */
141 static char *toprec;            /* Additional record specified by cgetset() */
142 static int gottoprec;           /* Flag indicating retrieval of toprecord */
143
144 /*
145  * Cgetset() allows the addition of a user specified buffer to be added to the
146  * database array, in effect "pushing" the buffer on top of the virtual
147  * database.  0 is returned on success, -1 on failure.
148  */
149 static int
150 _nc_cgetset(const char *ent)
151 {
152     if (ent == 0) {
153         FreeIfNeeded(toprec);
154         toprec = 0;
155         topreclen = 0;
156         return (0);
157     }
158     topreclen = strlen(ent);
159     if ((toprec = typeMalloc(char, topreclen + 1)) == 0) {
160         errno = ENOMEM;
161         return (-1);
162     }
163     gottoprec = 0;
164     (void) strcpy(toprec, ent);
165     return (0);
166 }
167
168 /*
169  * Cgetcap searches the capability record buf for the capability cap with type
170  * `type'.  A pointer to the value of cap is returned on success, 0 if the
171  * requested capability couldn't be found.
172  *
173  * Specifying a type of ':' means that nothing should follow cap (:cap:).  In
174  * this case a pointer to the terminating ':' or NUL will be returned if cap is
175  * found.
176  *
177  * If (cap, '@') or (cap, terminator, '@') is found before (cap, terminator)
178  * return 0.
179  */
180 static char *
181 _nc_cgetcap(char *buf, const char *cap, int type)
182 {
183     register const char *cp;
184     register char *bp;
185
186     bp = buf;
187     for (;;) {
188         /*
189          * Skip past the current capability field - it's either the
190          * name field if this is the first time through the loop, or
191          * the remainder of a field whose name failed to match cap.
192          */
193         for (;;) {
194             if (*bp == '\0')
195                 return (0);
196             else if (*bp++ == ':')
197                 break;
198         }
199
200         /*
201          * Try to match (cap, type) in buf.
202          */
203         for (cp = cap; *cp == *bp && *bp != '\0'; cp++, bp++)
204             continue;
205         if (*cp != '\0')
206             continue;
207         if (*bp == '@')
208             return (0);
209         if (type == ':') {
210             if (*bp != '\0' && *bp != ':')
211                 continue;
212             return (bp);
213         }
214         if (*bp != type)
215             continue;
216         bp++;
217         return (*bp == '@' ? 0 : bp);
218     }
219     /* NOTREACHED */
220 }
221
222 /*
223  * Cgetent extracts the capability record name from the NULL terminated file
224  * array db_array and returns a pointer to a malloc'd copy of it in buf.  Buf
225  * must be retained through all subsequent calls to cgetcap, cgetnum, cgetflag,
226  * and cgetstr, but may then be freed.
227  *
228  * Returns:
229  *
230  * positive #    on success (i.e., the index in db_array)
231  * TC_NOT_FOUND  if the requested record couldn't be found
232  * TC_SYS_ERR    if a system error was encountered (e.g.,couldn't open a file)
233  * TC_REF_LOOP   if a potential reference loop is detected
234  * TC_UNRESOLVED if we had too many recurrences to resolve
235  */
236 static int
237 _nc_cgetent(char **buf, int *oline, char **db_array, const char *name)
238 {
239     unsigned dummy;
240
241     return (_nc_getent(buf, &dummy, oline, 0, db_array, -1, name, 0, 0));
242 }
243
244 /*
245  * Getent implements the functions of cgetent.  If fd is non-negative,
246  * *db_array has already been opened and fd is the open file descriptor.  We
247  * do this to save time and avoid using up file descriptors for tc=
248  * recursions.
249  *
250  * Getent returns the same success/failure codes as cgetent.  On success, a
251  * pointer to a malloc'd capability record with all tc= capabilities fully
252  * expanded and its length (not including trailing ASCII NUL) are left in
253  * *cap and *len.
254  *
255  * Basic algorithm:
256  *      + Allocate memory incrementally as needed in chunks of size BFRAG
257  *        for capability buffer.
258  *      + Recurse for each tc=name and interpolate result.  Stop when all
259  *        names interpolated, a name can't be found, or depth exceeds
260  *        MAX_RECURSION.
261  */
262 #define DOALLOC(size) typeRealloc(char, size, record)
263 static int
264 _nc_getent(
265               char **cap,       /* termcap-content */
266               unsigned *len,    /* length, needed for recursion */
267               int *beginning,   /* line-number at match */
268               int in_array,     /* index in 'db_array[] */
269               char **db_array,  /* list of files to search */
270               int fd,
271               const char *name,
272               int depth,
273               char *nfield)
274 {
275     register char *r_end, *rp;
276     int myfd = FALSE;
277     char *record = 0;
278     int tc_not_resolved;
279     int current;
280     int lineno;
281
282     /*
283      * Return with ``loop detected'' error if we've recurred more than
284      * MAX_RECURSION times.
285      */
286     if (depth > MAX_RECURSION)
287         return (TC_REF_LOOP);
288
289     /*
290      * Check if we have a top record from cgetset().
291      */
292     if (depth == 0 && toprec != 0 && _nc_cgetmatch(toprec, name) == 0) {
293         if ((record = DOALLOC(topreclen + BFRAG)) == 0) {
294             errno = ENOMEM;
295             return (TC_SYS_ERR);
296         }
297         (void) strcpy(record, toprec);
298         rp = record + topreclen + 1;
299         r_end = rp + BFRAG;
300         current = in_array;
301     } else {
302         int foundit;
303
304         /*
305          * Allocate first chunk of memory.
306          */
307         if ((record = DOALLOC(BFRAG)) == 0) {
308             errno = ENOMEM;
309             return (TC_SYS_ERR);
310         }
311         rp = r_end = record + BFRAG;
312         foundit = FALSE;
313
314         /*
315          * Loop through database array until finding the record.
316          */
317         for (current = in_array; db_array[current] != 0; current++) {
318             int eof = FALSE;
319
320             /*
321              * Open database if not already open.
322              */
323             if (fd >= 0) {
324                 (void) lseek(fd, (off_t) 0, SEEK_SET);
325             } else if ((_nc_access(db_array[current], R_OK) < 0)
326                        || (fd = open(db_array[current], O_RDONLY, 0)) < 0) {
327                 /* No error on unfound file. */
328                 if (errno == ENOENT)
329                     continue;
330                 free(record);
331                 return (TC_SYS_ERR);
332             } else {
333                 myfd = TRUE;
334             }
335             lineno = 0;
336
337             /*
338              * Find the requested capability record ...
339              */
340             {
341                 char buf[2048];
342                 register char *b_end = buf;
343                 register char *bp = buf;
344                 register int c;
345
346                 /*
347                  * Loop invariants:
348                  *      There is always room for one more character in record.
349                  *      R_end always points just past end of record.
350                  *      Rp always points just past last character in record.
351                  *      B_end always points just past last character in buf.
352                  *      Bp always points at next character in buf.
353                  */
354
355                 for (;;) {
356                     int first = lineno + 1;
357
358                     /*
359                      * Read in a line implementing (\, newline)
360                      * line continuation.
361                      */
362                     rp = record;
363                     for (;;) {
364                         if (bp >= b_end) {
365                             int n;
366
367                             n = read(fd, buf, sizeof(buf));
368                             if (n <= 0) {
369                                 if (myfd)
370                                     (void) close(fd);
371                                 if (n < 0) {
372                                     free(record);
373                                     return (TC_SYS_ERR);
374                                 }
375                                 fd = -1;
376                                 eof = TRUE;
377                                 break;
378                             }
379                             b_end = buf + n;
380                             bp = buf;
381                         }
382
383                         c = *bp++;
384                         if (c == '\n') {
385                             lineno++;
386                             if (rp == record || *(rp - 1) != '\\')
387                                 break;
388                         }
389                         *rp++ = c;
390
391                         /*
392                          * Enforce loop invariant: if no room
393                          * left in record buffer, try to get
394                          * some more.
395                          */
396                         if (rp >= r_end) {
397                             unsigned pos;
398                             size_t newsize;
399
400                             pos = rp - record;
401                             newsize = r_end - record + BFRAG;
402                             record = DOALLOC(newsize);
403                             if (record == 0) {
404                                 if (myfd)
405                                     (void) close(fd);
406                                 errno = ENOMEM;
407                                 return (TC_SYS_ERR);
408                             }
409                             r_end = record + newsize;
410                             rp = record + pos;
411                         }
412                     }
413                     /* loop invariant lets us do this */
414                     *rp++ = '\0';
415
416                     /*
417                      * If encountered eof check next file.
418                      */
419                     if (eof)
420                         break;
421
422                     /*
423                      * Toss blank lines and comments.
424                      */
425                     if (*record == '\0' || *record == '#')
426                         continue;
427
428                     /*
429                      * See if this is the record we want ...
430                      */
431                     if (_nc_cgetmatch(record, name) == 0
432                         && (nfield == 0
433                             || !_nc_nfcmp(nfield, record))) {
434                         foundit = TRUE;
435                         *beginning = first;
436                         break;  /* found it! */
437                     }
438                 }
439             }
440             if (foundit)
441                 break;
442         }
443
444         if (!foundit)
445             return (TC_NOT_FOUND);
446     }
447
448     /*
449      * Got the capability record, but now we have to expand all tc=name
450      * references in it ...
451      */
452     {
453         register char *newicap, *s;
454         register int newilen;
455         unsigned ilen;
456         int diff, iret, tclen, oline;
457         char *icap, *scan, *tc, *tcstart, *tcend;
458
459         /*
460          * Loop invariants:
461          *      There is room for one more character in record.
462          *      R_end points just past end of record.
463          *      Rp points just past last character in record.
464          *      Scan points at remainder of record that needs to be
465          *      scanned for tc=name constructs.
466          */
467         scan = record;
468         tc_not_resolved = FALSE;
469         for (;;) {
470             if ((tc = _nc_cgetcap(scan, "tc", '=')) == 0)
471                 break;
472
473             /*
474              * Find end of tc=name and stomp on the trailing `:'
475              * (if present) so we can use it to call ourselves.
476              */
477             s = tc;
478             while (*s != '\0') {
479                 if (*s++ == ':') {
480                     *(s - 1) = '\0';
481                     break;
482                 }
483             }
484             tcstart = tc - 3;
485             tclen = s - tcstart;
486             tcend = s;
487
488             iret = _nc_getent(&icap, &ilen, &oline, current, db_array, fd,
489                               tc, depth + 1, 0);
490             newicap = icap;     /* Put into a register. */
491             newilen = ilen;
492             if (iret != TC_SUCCESS) {
493                 /* an error */
494                 if (iret < TC_NOT_FOUND) {
495                     if (myfd)
496                         (void) close(fd);
497                     free(record);
498                     return (iret);
499                 }
500                 if (iret == TC_UNRESOLVED)
501                     tc_not_resolved = TRUE;
502                 /* couldn't resolve tc */
503                 if (iret == TC_NOT_FOUND) {
504                     *(s - 1) = ':';
505                     scan = s - 1;
506                     tc_not_resolved = TRUE;
507                     continue;
508                 }
509             }
510
511             /* not interested in name field of tc'ed record */
512             s = newicap;
513             while (*s != '\0' && *s++ != ':') ;
514             newilen -= s - newicap;
515             newicap = s;
516
517             /* make sure interpolated record is `:'-terminated */
518             s += newilen;
519             if (*(s - 1) != ':') {
520                 *s = ':';       /* overwrite NUL with : */
521                 newilen++;
522             }
523
524             /*
525              * Make sure there's enough room to insert the
526              * new record.
527              */
528             diff = newilen - tclen;
529             if (diff >= r_end - rp) {
530                 unsigned pos, tcpos, tcposend;
531                 size_t newsize;
532
533                 pos = rp - record;
534                 newsize = r_end - record + diff + BFRAG;
535                 tcpos = tcstart - record;
536                 tcposend = tcend - record;
537                 record = DOALLOC(newsize);
538                 if (record == 0) {
539                     if (myfd)
540                         (void) close(fd);
541                     free(icap);
542                     errno = ENOMEM;
543                     return (TC_SYS_ERR);
544                 }
545                 r_end = record + newsize;
546                 rp = record + pos;
547                 tcstart = record + tcpos;
548                 tcend = record + tcposend;
549             }
550
551             /*
552              * Insert tc'ed record into our record.
553              */
554             s = tcstart + newilen;
555             memmove(s, tcend, (size_t) (rp - tcend));
556             memmove(tcstart, newicap, (size_t) newilen);
557             rp += diff;
558             free(icap);
559
560             /*
561              * Start scan on `:' so next cgetcap works properly
562              * (cgetcap always skips first field).
563              */
564             scan = s - 1;
565         }
566     }
567
568     /*
569      * Close file (if we opened it), give back any extra memory, and
570      * return capability, length and success.
571      */
572     if (myfd)
573         (void) close(fd);
574     *len = rp - record - 1;     /* don't count NUL */
575     if (r_end > rp) {
576         if ((record = DOALLOC((size_t) (rp - record))) == 0) {
577             errno = ENOMEM;
578             return (TC_SYS_ERR);
579         }
580     }
581
582     *cap = record;
583     if (tc_not_resolved)
584         return (TC_UNRESOLVED);
585     return (current);
586 }
587
588 /*
589  * Cgetmatch will return 0 if name is one of the names of the capability
590  * record buf, -1 if not.
591  */
592 static int
593 _nc_cgetmatch(char *buf, const char *name)
594 {
595     register const char *np;
596     register char *bp;
597
598     /*
599      * Start search at beginning of record.
600      */
601     bp = buf;
602     for (;;) {
603         /*
604          * Try to match a record name.
605          */
606         np = name;
607         for (;;) {
608             if (*np == '\0') {
609                 if (*bp == '|' || *bp == ':' || *bp == '\0')
610                     return (0);
611                 else
612                     break;
613             } else if (*bp++ != *np++) {
614                 break;
615             }
616         }
617
618         /*
619          * Match failed, skip to next name in record.
620          */
621         bp--;                   /* a '|' or ':' may have stopped the match */
622         for (;;) {
623             if (*bp == '\0' || *bp == ':')
624                 return (-1);    /* match failed totally */
625             else if (*bp++ == '|')
626                 break;          /* found next name */
627         }
628     }
629 }
630
631 /*
632  * Compare name field of record.
633  */
634 static int
635 _nc_nfcmp(const char *nf, char *rec)
636 {
637     char *cp, tmp;
638     int ret;
639
640     for (cp = rec; *cp != ':'; cp++) ;
641
642     tmp = *(cp + 1);
643     *(cp + 1) = '\0';
644     ret = strcmp(nf, rec);
645     *(cp + 1) = tmp;
646
647     return (ret);
648 }
649 #endif /* HAVE_BSD_CGETENT */
650
651 /*
652  * Since ncurses provides its own 'tgetent()', we cannot use the native one.
653  * So we reproduce the logic to get down to cgetent() -- or our cut-down
654  * version of that -- to circumvent the problem of configuring against the
655  * termcap library.
656  */
657 #define USE_BSD_TGETENT 1
658
659 #if USE_BSD_TGETENT
660 /*
661  * Copyright (c) 1980, 1993
662  *      The Regents of the University of California.  All rights reserved.
663  *
664  * Redistribution and use in source and binary forms, with or without
665  * modification, are permitted provided that the following conditions
666  * are met:
667  * 1. Redistributions of source code must retain the above copyright
668  *    notice, this list of conditions and the following disclaimer.
669  * 2. Redistributions in binary form must reproduce the above copyright
670  *    notice, this list of conditions and the following disclaimer in the
671  *    documentation and/or other materials provided with the distribution.
672  * 3. All advertising materials mentioning features or use of this software
673  *    must display the following acknowledgment:
674  *      This product includes software developed by the University of
675  *      California, Berkeley and its contributors.
676  * 4. Neither the name of the University nor the names of its contributors
677  *    may be used to endorse or promote products derived from this software
678  *    without specific prior written permission.
679  *
680  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
681  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
682  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
683  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
684  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
685  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
686  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
687  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
688  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
689  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
690  * SUCH DAMAGE.
691  */
692
693 /* static char sccsid[] = "@(#)termcap.c        8.1 (Berkeley) 6/4/93" */
694
695 #define PBUFSIZ         512     /* max length of filename path */
696 #define PVECSIZ         32      /* max number of names in path */
697 #define TBUFSIZ (2048*2)
698
699 static char *tbuf;
700
701 /*
702  * On entry, srcp points to a non ':' character which is the beginning of the
703  * token, if any.  We'll try to return a string that doesn't end with a ':'.
704  */
705 static char *
706 get_tc_token(char **srcp, int *endp)
707 {
708     int ch;
709     bool found = FALSE;
710     char *s, *base;
711     char *tok = 0;
712
713     *endp = TRUE;
714     for (s = base = *srcp; *s != '\0';) {
715         ch = *s++;
716         if (ch == '\\') {
717             if (*s == '\0') {
718                 break;
719             } else if (*s++ == '\n') {
720                 while (isspace(UChar(*s)))
721                     s++;
722             } else {
723                 found = TRUE;
724             }
725         } else if (ch == ':') {
726             if (found) {
727                 tok = base;
728                 s[-1] = '\0';
729                 *srcp = s;
730                 *endp = FALSE;
731                 break;
732             }
733             base = s;
734         } else if (isgraph(UChar(ch))) {
735             found = TRUE;
736         }
737     }
738
739     /* malformed entry may end without a ':' */
740     if (tok == 0 && found) {
741         tok = base;
742     }
743
744     return tok;
745 }
746
747 static char *
748 copy_tc_token(char *dst, const char *src, size_t len)
749 {
750     int ch;
751
752     while ((ch = *src++) != '\0') {
753         if (ch == '\\' && *src == '\n') {
754             while (isspace(UChar(*src)))
755                 src++;
756             continue;
757         }
758         if (--len == 0) {
759             dst = 0;
760             break;
761         }
762         *dst++ = ch;
763     }
764     return dst;
765 }
766
767 /*
768  * Get an entry for terminal name in buffer bp from the termcap file.
769  */
770 static int
771 _nc_tgetent(char *bp, char **sourcename, int *lineno, const char *name)
772 {
773     static char *the_source;
774
775     register char *p;
776     register char *cp;
777     char *dummy = NULL;
778     char **fname;
779     char *home;
780     int i;
781     char pathbuf[PBUFSIZ];      /* holds raw path of filenames */
782     char *pathvec[PVECSIZ];     /* to point to names in pathbuf */
783     char **pvec;                /* holds usable tail of path vector */
784     NCURSES_CONST char *termpath;
785     string_desc desc;
786
787     fname = pathvec;
788     pvec = pathvec;
789     tbuf = bp;
790     p = pathbuf;
791     cp = use_terminfo_vars()? getenv("TERMCAP") : NULL;
792
793     /*
794      * TERMCAP can have one of two things in it.  It can be the name of a file
795      * to use instead of /etc/termcap.  In this case it better start with a
796      * "/".  Or it can be an entry to use so we don't have to read the file. 
797      * In this case it has to already have the newlines crunched out.  If
798      * TERMCAP does not hold a file name then a path of names is searched
799      * instead.  The path is found in the TERMPATH variable, or becomes
800      * "$HOME/.termcap /etc/termcap" if no TERMPATH exists.
801      */
802     _nc_str_init(&desc, pathbuf, sizeof(pathbuf));
803     if (cp == NULL) {
804         _nc_safe_strcpy(&desc, get_termpath());
805     } else if (!_nc_is_abs_path(cp)) {  /* TERMCAP holds an entry */
806         if ((termpath = get_termpath()) != 0) {
807             _nc_safe_strcat(&desc, termpath);
808         } else {
809             char temp[PBUFSIZ];
810             temp[0] = 0;
811             if ((home = getenv("HOME")) != 0 && *home != '\0'
812                 && strchr(home, ' ') == 0
813                 && strlen(home) < sizeof(temp) - 10) {  /* setup path */
814                 sprintf(temp, "%s/", home);     /* $HOME first */
815             }
816             /* if no $HOME look in current directory */
817             strcat(temp, ".termcap");
818             _nc_safe_strcat(&desc, temp);
819             _nc_safe_strcat(&desc, " ");
820             _nc_safe_strcat(&desc, get_termpath());
821         }
822     } else {                    /* user-defined name in TERMCAP */
823         _nc_safe_strcat(&desc, cp);     /* still can be tokenized */
824     }
825
826     *fname++ = pathbuf;         /* tokenize path into vector of names */
827     while (*++p) {
828         if (*p == ' ' || *p == NCURSES_PATHSEP) {
829             *p = '\0';
830             while (*++p)
831                 if (*p != ' ' && *p != NCURSES_PATHSEP)
832                     break;
833             if (*p == '\0')
834                 break;
835             *fname++ = p;
836             if (fname >= pathvec + PVECSIZ) {
837                 fname--;
838                 break;
839             }
840         }
841     }
842     *fname = 0;                 /* mark end of vector */
843     if (_nc_is_abs_path(cp)) {
844         if (_nc_cgetset(cp) < 0) {
845             return (TC_SYS_ERR);
846         }
847     }
848
849     i = _nc_cgetent(&dummy, lineno, pathvec, name);
850
851     /* ncurses' termcap-parsing routines cannot handle multiple adjacent
852      * empty fields, and mistakenly use the last valid cap entry instead of
853      * the first (breaks tc= includes)
854      */
855     if (i >= 0) {
856         char *pd, *ps, *tok;
857         int endflag = FALSE;
858         char *list[1023];
859         size_t n, count = 0;
860
861         pd = bp;
862         ps = dummy;
863         while (!endflag && (tok = get_tc_token(&ps, &endflag)) != 0) {
864             bool ignore = FALSE;
865
866             for (n = 1; n < count; n++) {
867                 char *s = list[n];
868                 if (s[0] == tok[0]
869                     && s[1] == tok[1]) {
870                     ignore = TRUE;
871                     break;
872                 }
873             }
874             if (ignore != TRUE) {
875                 list[count++] = tok;
876                 pd = copy_tc_token(pd, tok, TBUFSIZ - (2 + pd - bp));
877                 if (pd == 0) {
878                     i = -1;
879                     break;
880                 }
881                 *pd++ = ':';
882                 *pd = '\0';
883             }
884         }
885     }
886
887     FreeIfNeeded(dummy);
888     FreeIfNeeded(the_source);
889     the_source = 0;
890
891     /* This is not related to the BSD cgetent(), but to fake up a suitable
892      * filename for ncurses' error reporting.  (If we are not using BSD
893      * cgetent, then it is the actual filename).
894      */
895     if (i >= 0) {
896 #if HAVE_BSD_CGETENT
897         char temp[PATH_MAX];
898
899         _nc_str_init(&desc, temp, sizeof(temp));
900         _nc_safe_strcpy(&desc, pathvec[i]);
901         _nc_safe_strcat(&desc, ".db");
902         if (_nc_access(temp, R_OK) == 0) {
903             _nc_safe_strcpy(&desc, pathvec[i]);
904         }
905         if ((the_source = strdup(temp)) != 0)
906             *sourcename = the_source;
907 #else
908         if ((the_source = strdup(pathvec[i])) != 0)
909             *sourcename = the_source;
910 #endif
911     }
912
913     return (i);
914 }
915 #endif /* USE_BSD_TGETENT */
916 #endif /* USE_GETCAP */
917
918 #define MAXPATHS        32
919
920 /*
921  * Add a filename to the list in 'termpaths[]', checking that we really have
922  * a right to open the file.
923  */
924 #if !USE_GETCAP
925 static int
926 add_tc(char *termpaths[], char *path, int count)
927 {
928     char *save = strchr(path, NCURSES_PATHSEP);
929     if (save != 0)
930         *save = '\0';
931     if (count < MAXPATHS
932         && _nc_access(path, R_OK) == 0) {
933         termpaths[count++] = path;
934         T(("Adding termpath %s", path));
935     }
936     termpaths[count] = 0;
937     if (save != 0)
938         *save = NCURSES_PATHSEP;
939     return count;
940 }
941 #define ADD_TC(path, count) filecount = add_tc(termpaths, path, count)
942 #endif /* !USE_GETCAP */
943
944 NCURSES_EXPORT(int)
945 _nc_read_termcap_entry(const char *const tn, TERMTYPE *const tp)
946 {
947     int found = TGETENT_NO;
948     ENTRY *ep;
949 #if USE_GETCAP_CACHE
950     char cwd_buf[PATH_MAX];
951 #endif
952 #if USE_GETCAP
953     char *p, tc[TBUFSIZ];
954     int status;
955     static char *source;
956     static int lineno;
957
958     T(("read termcap entry for %s", tn));
959
960     if (strlen(tn) == 0
961         || strcmp(tn, ".") == 0
962         || strcmp(tn, "..") == 0
963         || _nc_pathlast(tn) != 0) {
964         T(("illegal or missing entry name '%s'", tn));
965         return TGETENT_NO;
966     }
967
968     if (use_terminfo_vars() && (p = getenv("TERMCAP")) != 0
969         && !_nc_is_abs_path(p) && _nc_name_match(p, tn, "|:")) {
970         /* TERMCAP holds a termcap entry */
971         strncpy(tc, p, sizeof(tc) - 1);
972         tc[sizeof(tc) - 1] = '\0';
973         _nc_set_source("TERMCAP");
974     } else {
975         /* we're using getcap(3) */
976         if ((status = _nc_tgetent(tc, &source, &lineno, tn)) < 0)
977             return (status == TC_NOT_FOUND ? TGETENT_NO : TGETENT_ERR);
978
979         _nc_curr_line = lineno;
980         _nc_set_source(source);
981     }
982     _nc_read_entry_source((FILE *) 0, tc, FALSE, FALSE, NULLHOOK);
983 #else
984     /*
985      * Here is what the 4.4BSD termcap(3) page prescribes:
986      *
987      * It will look in the environment for a TERMCAP variable.  If found, and
988      * the value does not begin with a slash, and the terminal type name is the
989      * same as the environment string TERM, the TERMCAP string is used instead
990      * of reading a termcap file.  If it does begin with a slash, the string is
991      * used as a path name of the termcap file to search.  If TERMCAP does not
992      * begin with a slash and name is different from TERM, tgetent() searches
993      * the files $HOME/.termcap and /usr/share/misc/termcap, in that order,
994      * unless the environment variable TERMPATH exists, in which case it
995      * specifies a list of file pathnames (separated by spaces or colons) to be
996      * searched instead.
997      *
998      * It goes on to state:
999      *
1000      * Whenever multiple files are searched and a tc field occurs in the
1001      * requested entry, the entry it names must be found in the same file or
1002      * one of the succeeding files.
1003      *
1004      * However, this restriction is relaxed in ncurses; tc references to
1005      * previous files are permitted.
1006      *
1007      * This routine returns 1 if an entry is found, 0 if not found, and -1 if
1008      * the database is not accessible.
1009      */
1010     FILE *fp;
1011     char *tc, *termpaths[MAXPATHS];
1012     int filecount = 0;
1013     int j, k;
1014     bool use_buffer = FALSE;
1015     bool normal = TRUE;
1016     char tc_buf[1024];
1017     char pathbuf[PATH_MAX];
1018     char *copied = 0;
1019     char *cp;
1020     struct stat test_stat[MAXPATHS];
1021
1022     termpaths[filecount] = 0;
1023     if (use_terminfo_vars() && (tc = getenv("TERMCAP")) != 0) {
1024         if (_nc_is_abs_path(tc)) {      /* interpret as a filename */
1025             ADD_TC(tc, 0);
1026             normal = FALSE;
1027         } else if (_nc_name_match(tc, tn, "|:")) {      /* treat as a capability file */
1028             use_buffer = TRUE;
1029             (void) sprintf(tc_buf, "%.*s\n", (int) sizeof(tc_buf) - 2, tc);
1030             normal = FALSE;
1031         }
1032     }
1033
1034     if (normal) {               /* normal case */
1035         char envhome[PATH_MAX], *h;
1036
1037         copied = strdup(get_termpath());
1038         for (cp = copied; *cp; cp++) {
1039             if (*cp == NCURSES_PATHSEP)
1040                 *cp = '\0';
1041             else if (cp == copied || cp[-1] == '\0') {
1042                 ADD_TC(cp, filecount);
1043             }
1044         }
1045
1046 #define PRIVATE_CAP "%s/.termcap"
1047
1048         if (use_terminfo_vars() && (h = getenv("HOME")) != NULL && *h != '\0'
1049             && (strlen(h) + sizeof(PRIVATE_CAP)) < PATH_MAX) {
1050             /* user's .termcap, if any, should override it */
1051             (void) strcpy(envhome, h);
1052             (void) sprintf(pathbuf, PRIVATE_CAP, envhome);
1053             ADD_TC(pathbuf, filecount);
1054         }
1055     }
1056
1057     /*
1058      * Probably /etc/termcap is a symlink to /usr/share/misc/termcap.
1059      * Avoid reading the same file twice.
1060      */
1061 #if HAVE_LINK
1062     for (j = 0; j < filecount; j++) {
1063         bool omit = FALSE;
1064         if (stat(termpaths[j], &test_stat[j]) != 0
1065             || !S_ISREG(test_stat[j].st_mode)) {
1066             omit = TRUE;
1067         } else {
1068             for (k = 0; k < j; k++) {
1069                 if (test_stat[k].st_dev == test_stat[j].st_dev
1070                     && test_stat[k].st_ino == test_stat[j].st_ino) {
1071                     omit = TRUE;
1072                     break;
1073                 }
1074             }
1075         }
1076         if (omit) {
1077             T(("Path %s is a duplicate", termpaths[j]));
1078             for (k = j + 1; k < filecount; k++) {
1079                 termpaths[k - 1] = termpaths[k];
1080                 test_stat[k - 1] = test_stat[k];
1081             }
1082             --filecount;
1083             --j;
1084         }
1085     }
1086 #endif
1087
1088     /* parse the sources */
1089     if (use_buffer) {
1090         _nc_set_source("TERMCAP");
1091
1092         /*
1093          * We don't suppress warning messages here.  The presumption is
1094          * that since it's just a single entry, they won't be a pain.
1095          */
1096         _nc_read_entry_source((FILE *) 0, tc_buf, FALSE, FALSE, NULLHOOK);
1097     } else {
1098         int i;
1099
1100         for (i = 0; i < filecount; i++) {
1101
1102             T(("Looking for %s in %s", tn, termpaths[i]));
1103             if (_nc_access(termpaths[i], R_OK) == 0
1104                 && (fp = fopen(termpaths[i], "r")) != (FILE *) 0) {
1105                 _nc_set_source(termpaths[i]);
1106
1107                 /*
1108                  * Suppress warning messages.  Otherwise you get 400 lines of
1109                  * crap from archaic termcap files as ncurses complains about
1110                  * all the obsolete capabilities.
1111                  */
1112                 _nc_read_entry_source(fp, (char *) 0, FALSE, TRUE, NULLHOOK);
1113
1114                 (void) fclose(fp);
1115             }
1116         }
1117     }
1118     if (copied != 0)
1119         free(copied);
1120 #endif /* USE_GETCAP */
1121
1122     if (_nc_head == 0)
1123         return (TGETENT_ERR);
1124
1125     /* resolve all use references */
1126     _nc_resolve_uses2(TRUE, FALSE);
1127
1128     /* find a terminal matching tn, if we can */
1129 #if USE_GETCAP_CACHE
1130     if (getcwd(cwd_buf, sizeof(cwd_buf)) != 0) {
1131         _nc_set_writedir((char *) 0);   /* note: this does a chdir */
1132 #endif
1133         for_entry_list(ep) {
1134             if (_nc_name_match(ep->tterm.term_names, tn, "|:")) {
1135                 /*
1136                  * Make a local copy of the terminal capabilities, delinked
1137                  * from the list.
1138                  */
1139                 *tp = ep->tterm;
1140                 _nc_delink_entry(_nc_head, &(ep->tterm));
1141                 free(ep);
1142
1143                 /*
1144                  * OK, now try to write the type to user's terminfo directory. 
1145                  * Next time he loads this, it will come through terminfo.
1146                  *
1147                  * Advantage:  Second and subsequent fetches of this entry will
1148                  * be very fast.
1149                  *
1150                  * Disadvantage:  After the first time a termcap type is loaded
1151                  * by its user, editing it in the /etc/termcap file, or in
1152                  * TERMCAP, or in a local ~/.termcap, will be ineffective
1153                  * unless the terminfo entry is explicitly removed.
1154                  */
1155 #if USE_GETCAP_CACHE
1156                 (void) _nc_write_entry(tp);
1157 #endif
1158                 found = TGETENT_YES;
1159                 break;
1160             }
1161         }
1162 #if USE_GETCAP_CACHE
1163         chdir(cwd_buf);
1164     }
1165 #endif
1166
1167     return (found);
1168 }
1169 #else
1170 extern
1171 NCURSES_EXPORT(void)
1172 _nc_read_termcap(void);
1173 NCURSES_EXPORT(void)
1174 _nc_read_termcap(void)
1175 {
1176 }
1177 #endif /* PURE_TERMINFO */