1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 1998 Brian Somers <brian@Awfulhak.org>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD$
29 */
30
31#define LOCAL_AUTH	0x01
32#define LOCAL_NO_AUTH	0x02
33#define LOCAL_DENY	0x03
34#define LOCAL_CX	0x04	/* OR'd value - require a context */
35#define LOCAL_CX_OPT	0x08	/* OR'd value - optional context */
36
37struct server;
38struct datalink;
39struct bundle;
40struct cmdargs;
41
42struct prompt {
43  struct fdescriptor desc;
44  int fd_in, fd_out;
45  struct datalink *TermMode;	/* The modem we're talking directly to */
46  FILE *Term;			/* sits on top of fd_out */
47  u_char auth;			/* Local Authorized status */
48  struct server *owner;         /* who created me */
49  struct bundle *bundle;	/* who I'm controlling */
50  unsigned nonewline : 1;	/* need a newline before our prompt ? */
51  unsigned needprompt : 1;	/* Show a prompt at the next UpdateSet() */
52  unsigned active : 1;		/* Is the prompt active (^Z) */
53  unsigned readtilde : 1;	/* We've read a ``~'' from fd_in */
54
55  struct {
56    const char *type;		/* Type of connection */
57    char from[40];		/* Source of connection */
58  } src;
59
60  struct prompt *next;		/* Maintained in log.c */
61  u_long logmask;		/* Maintained in log.c */
62
63  struct termios oldtio;	/* Original tty mode */
64  struct termios comtio;	/* Command level tty mode */
65};
66
67#define descriptor2prompt(d) \
68  ((d)->type == PROMPT_DESCRIPTOR ? (struct prompt *)(d) : NULL)
69
70#define PROMPT_STD (-1)
71extern struct prompt *prompt_Create(struct server *, struct bundle *, int);
72extern void prompt_Destroy(struct prompt *, int);
73extern void prompt_Required(struct prompt *);
74#ifdef __GNUC__
75extern void prompt_Printf(struct prompt *, const char *, ...)
76                          __attribute__ ((format (printf, 2, 3)));
77#else
78extern void prompt_Printf(struct prompt *, const char *, ...);
79#endif
80#ifdef __GNUC__
81extern void prompt_vPrintf(struct prompt *, const char *, va_list)
82			   __attribute__ ((format (printf, 2, 0)));
83#else
84extern void prompt_vPrintf(struct prompt *, const char *, va_list);
85#endif
86#define PROMPT_DONT_WANT_INT 1
87#define PROMPT_WANT_INT 0
88extern void prompt_TtyInit(struct prompt *);
89extern void prompt_TtyCommandMode(struct prompt *);
90extern void prompt_TtyTermMode(struct prompt *, struct datalink *);
91extern void prompt_TtyOldMode(struct prompt *);
92extern pid_t prompt_pgrp(struct prompt *);
93extern int PasswdCommand(struct cmdargs const *);
94extern void prompt_Suspend(struct prompt *);
95extern void prompt_Continue(struct prompt *);
96#define prompt_IsTermMode(p, dl) ((p)->TermMode == (dl) ? 1 : 0)
97#define prompt_IsController(p) (!(p) || (p)->owner ? 0 : 1)
98#define prompt_Required(p) ((p)->needprompt = 1)
99