d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
16f8f89c5c
freebsd-skq/usr.sbin/ppp/prompt.h

99 lines
3.9 KiB
C
Raw Normal View History

Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
/*-
various: general adoption of SPDX licensing ID tags. Mainly focus on files that use BSD 2-Clause license, however the tool I was using misidentified many licenses so this was mostly a manual - error prone - task. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts. No functional change intended.
2017-11-27 15:37:16 +00:00
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
* Copyright (c) 1998 Brian Somers <brian@Awfulhak.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
$Id$ -> $FreeBSD$
1999-08-28 01:35:59 +00:00
* $FreeBSD$
Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
*/
Deglobalise `struct prompt': o Our diagnostic socket has its password set in the `set socket' line only (not in ppp.secret). o Passwords are per server socket (*VarAuthKey are gone) o Authority is per prompt (VarLocalAuth is gone). o Local logging is per prompt. o Add a `show who' command to see who's connected. No identd routine - just a `where the connection came from' display. o SIGUSR1 is disabled for now - we have no way of choosing a password for the socket created :-( Prompts are attached as a list of `struct descriptor's in struct bundle, and serviced under the bundles descriptor service routines. Ultimately, everything should be done like this. Cosmetic: o alphabeticalise SRCS in Makefile. o Add a few comments in command.h TODO: Start checking that we don't overflow the descriptor sets in select() now that we can have any number of descriptors.
1998-04-03 19:26:02 +00:00
#define LOCAL_AUTH 0x01
#define LOCAL_NO_AUTH 0x02
#define LOCAL_DENY 0x03
#define LOCAL_CX 0x04 /* OR'd value - require a context */
#define LOCAL_CX_OPT 0x08 /* OR'd value - optional context */
struct server;
o Move alias function pointers into loadalias.c o Move Var*Version into command.c o Remove struct pppVars (and there was much rejoicing) ! o Forward-decl some structs in .h files to avoid include ordering requirements and remove a few more redundant #includes.
1998-04-07 00:54:26 +00:00
struct datalink;
Deglobalise `struct prompt': o Our diagnostic socket has its password set in the `set socket' line only (not in ppp.secret). o Passwords are per server socket (*VarAuthKey are gone) o Authority is per prompt (VarLocalAuth is gone). o Local logging is per prompt. o Add a `show who' command to see who's connected. No identd routine - just a `where the connection came from' display. o SIGUSR1 is disabled for now - we have no way of choosing a password for the socket created :-( Prompts are attached as a list of `struct descriptor's in struct bundle, and serviced under the bundles descriptor service routines. Ultimately, everything should be done like this. Cosmetic: o alphabeticalise SRCS in Makefile. o Add a few comments in command.h TODO: Start checking that we don't overflow the descriptor sets in select() now that we can have any number of descriptors.
1998-04-03 19:26:02 +00:00
struct bundle;
o Move alias function pointers into loadalias.c o Move Var*Version into command.c o Remove struct pppVars (and there was much rejoicing) ! o Forward-decl some structs in .h files to avoid include ordering requirements and remove a few more redundant #includes.
1998-04-07 00:54:26 +00:00
struct cmdargs;
Deglobalise `struct prompt': o Our diagnostic socket has its password set in the `set socket' line only (not in ppp.secret). o Passwords are per server socket (*VarAuthKey are gone) o Authority is per prompt (VarLocalAuth is gone). o Local logging is per prompt. o Add a `show who' command to see who's connected. No identd routine - just a `where the connection came from' display. o SIGUSR1 is disabled for now - we have no way of choosing a password for the socket created :-( Prompts are attached as a list of `struct descriptor's in struct bundle, and serviced under the bundles descriptor service routines. Ultimately, everything should be done like this. Cosmetic: o alphabeticalise SRCS in Makefile. o Add a few comments in command.h TODO: Start checking that we don't overflow the descriptor sets in select() now that we can have any number of descriptors.
1998-04-03 19:26:02 +00:00
Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
struct prompt {
To avoid namespace polution in NetBSD: ``struct descriptor'' -> ``struct fdescriptor''
2000-03-14 01:46:09 +00:00
struct fdescriptor desc;
Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
int fd_in, fd_out;
Keep a handle on our current ``term'' in struct prompt so that the `term' command works on the correct link.
1998-02-17 19:28:13 +00:00
struct datalink *TermMode; /* The modem we're talking directly to */
Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
FILE *Term; /* sits on top of fd_out */
Deglobalise `struct prompt': o Our diagnostic socket has its password set in the `set socket' line only (not in ppp.secret). o Passwords are per server socket (*VarAuthKey are gone) o Authority is per prompt (VarLocalAuth is gone). o Local logging is per prompt. o Add a `show who' command to see who's connected. No identd routine - just a `where the connection came from' display. o SIGUSR1 is disabled for now - we have no way of choosing a password for the socket created :-( Prompts are attached as a list of `struct descriptor's in struct bundle, and serviced under the bundles descriptor service routines. Ultimately, everything should be done like this. Cosmetic: o alphabeticalise SRCS in Makefile. o Add a few comments in command.h TODO: Start checking that we don't overflow the descriptor sets in select() now that we can have any number of descriptors.
1998-04-03 19:26:02 +00:00
u_char auth; /* Local Authorized status */
struct server *owner; /* who created me */
struct bundle *bundle; /* who I'm controlling */
unsigned nonewline : 1; /* need a newline before our prompt ? */
unsigned needprompt : 1; /* Show a prompt at the next UpdateSet() */
Make ^Z, bg & fg work. We don't muck around with SIGTTIN or SIGTTOU, we just disable use of the prompt for the controlling terminal (and put a ^Z next to it in a ``show who'' listing). Unfortunately, we need to enable a timer to ``poll'' for the terminal having us as the controlling pgrp when a user does a ``bg''. If anyone knows how to do this better - please speak up (is there any indication to the process group leader when it's ctrling terminal gets tcsetpgrp()'d back ?)....
1998-04-05 18:25:34 +00:00
unsigned active : 1; /* Is the prompt active (^Z) */
o De-staticise things that don't need to be static. o Bring the static ``ttystate'' into struct prompt so that the tilde context is per prompt and not global. o Comment the remaining static variables so that it's clear why they're static. o Add some XXX comments suggesting that our interface list and our hostname should be re-generated after a signal (say SIGUSR1) so that a machine with PCCARDs has a chance.
1998-06-15 19:06:58 +00:00
unsigned readtilde : 1; /* We've read a ``~'' from fd_in */
Deglobalise `struct prompt': o Our diagnostic socket has its password set in the `set socket' line only (not in ppp.secret). o Passwords are per server socket (*VarAuthKey are gone) o Authority is per prompt (VarLocalAuth is gone). o Local logging is per prompt. o Add a `show who' command to see who's connected. No identd routine - just a `where the connection came from' display. o SIGUSR1 is disabled for now - we have no way of choosing a password for the socket created :-( Prompts are attached as a list of `struct descriptor's in struct bundle, and serviced under the bundles descriptor service routines. Ultimately, everything should be done like this. Cosmetic: o alphabeticalise SRCS in Makefile. o Add a few comments in command.h TODO: Start checking that we don't overflow the descriptor sets in select() now that we can have any number of descriptors.
1998-04-03 19:26:02 +00:00
o Remove the `mode' global - it's now per physical device. o Shuffle things that live at the datalink level into ``show link'' rather than ``show modem''. o Make both ``show'' commands prettier and more consistent, and display carrier status, link type and our name in ``show modem''. o Show redial and reconnect information in ``show link'' and remove ``show redial'' and ``show reconnect''. o Down the correct link in bundle_LinkLost(). o Remove stale -direct and -background links at the end of our main loop, not when we know they're going. This prevents unexpected pointer-invalidations... o If we ``set server'' with the same values twice, notice and don't moan about failure. o Record dial script despite our link mode. The mode may be changed later (next mod) :-) We never run scripts in -direct and -dedicated modes. o Make ``set server none'' functional again. o Correct datalink state array so that we don't report an ``unknown'' state. o Pass struct ipcp to IpcpCleanInterface, not struct fsm. o Create TUN_PREFIX define rather than hard-coding in main.c o prompt_TtyInit now handles a NULL prompt for -direct mode rather than having to create one then destroy it uncleanly. o Mention our mode in the "PPP Started" LogPHASE message. o Bring all auto links up when we have something to send. o Remove some redundant Physical_*() functions. o Show which connection is running a command when logging commands. o Initialise throughput uptime correctly.
1998-04-10 13:19:23 +00:00
struct {
const char *type; /* Type of connection */
char from[40]; /* Source of connection */
} src;
Deglobalise `struct prompt': o Our diagnostic socket has its password set in the `set socket' line only (not in ppp.secret). o Passwords are per server socket (*VarAuthKey are gone) o Authority is per prompt (VarLocalAuth is gone). o Local logging is per prompt. o Add a `show who' command to see who's connected. No identd routine - just a `where the connection came from' display. o SIGUSR1 is disabled for now - we have no way of choosing a password for the socket created :-( Prompts are attached as a list of `struct descriptor's in struct bundle, and serviced under the bundles descriptor service routines. Ultimately, everything should be done like this. Cosmetic: o alphabeticalise SRCS in Makefile. o Add a few comments in command.h TODO: Start checking that we don't overflow the descriptor sets in select() now that we can have any number of descriptors.
1998-04-03 19:26:02 +00:00
o Move our prompt descriptor list outside of the bundle. It's now dealt with by the `server' object. This simplifies things as we only have one list of prompt descriptors and the log_ routines check prompt::logactive to determine whether it should be used for output. o Include the MP socket UpdateSet() result in bundle::UpdateSet(). o Don't select on the tun device unless we're in NETWORK phase or AUTO mode. o Stop the idle timer when we go to DEAD phase. We may have transferred a link and not had a chance to kill it. o Don't fail when trying to unlink our transferred datalink from our descriptor lists just before the transfer. o Add our link descriptor to the write set if we got a short write the last time (physical::out is set). o Log the connection source address when a connection is closed. o Remove descriptor::next field. Descriptor lists are not required any more.
1998-05-23 22:24:50 +00:00
struct prompt *next; /* Maintained in log.c */
Deglobalise `struct prompt': o Our diagnostic socket has its password set in the `set socket' line only (not in ppp.secret). o Passwords are per server socket (*VarAuthKey are gone) o Authority is per prompt (VarLocalAuth is gone). o Local logging is per prompt. o Add a `show who' command to see who's connected. No identd routine - just a `where the connection came from' display. o SIGUSR1 is disabled for now - we have no way of choosing a password for the socket created :-( Prompts are attached as a list of `struct descriptor's in struct bundle, and serviced under the bundles descriptor service routines. Ultimately, everything should be done like this. Cosmetic: o alphabeticalise SRCS in Makefile. o Add a few comments in command.h TODO: Start checking that we don't overflow the descriptor sets in select() now that we can have any number of descriptors.
1998-04-03 19:26:02 +00:00
u_long logmask; /* Maintained in log.c */
Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
struct termios oldtio; /* Original tty mode */
struct termios comtio; /* Command level tty mode */
};
#define descriptor2prompt(d) \
((d)->type == PROMPT_DESCRIPTOR ? (struct prompt *)(d) : NULL)
Deglobalise `struct prompt': o Our diagnostic socket has its password set in the `set socket' line only (not in ppp.secret). o Passwords are per server socket (*VarAuthKey are gone) o Authority is per prompt (VarLocalAuth is gone). o Local logging is per prompt. o Add a `show who' command to see who's connected. No identd routine - just a `where the connection came from' display. o SIGUSR1 is disabled for now - we have no way of choosing a password for the socket created :-( Prompts are attached as a list of `struct descriptor's in struct bundle, and serviced under the bundles descriptor service routines. Ultimately, everything should be done like this. Cosmetic: o alphabeticalise SRCS in Makefile. o Add a few comments in command.h TODO: Start checking that we don't overflow the descriptor sets in select() now that we can have any number of descriptors.
1998-04-03 19:26:02 +00:00
#define PROMPT_STD (-1)
extern struct prompt *prompt_Create(struct server *, struct bundle *, int);
extern void prompt_Destroy(struct prompt *, int);
extern void prompt_Required(struct prompt *);
o Use __attribute__ (#ifdef __GNUC__) to type-check LogPrintf() and prompt_Printf(), and fix the bits identified as being wrong as a result.
1998-04-19 23:09:03 +00:00
#ifdef __GNUC__
extern void prompt_Printf(struct prompt *, const char *, ...)
__attribute__ ((format (printf, 2, 3)));
#else
Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
extern void prompt_Printf(struct prompt *, const char *, ...);
o Use __attribute__ (#ifdef __GNUC__) to type-check LogPrintf() and prompt_Printf(), and fix the bits identified as being wrong as a result.
1998-04-19 23:09:03 +00:00
#endif
Silence some of the -Wnon-const-format warnings and add __printflike() to a function prototype which needs it. Approved by: brian MFC After: 2 weeks
2001-07-02 12:27:49 +00:00
#ifdef __GNUC__
Include the correct file (stdarg.h) and use va_list rather than _BSD_VA_LIST_ Suggested by: mike
2002-08-27 20:11:58 +00:00
extern void prompt_vPrintf(struct prompt *, const char *, va_list)
Silence some of the -Wnon-const-format warnings and add __printflike() to a function prototype which needs it. Approved by: brian MFC After: 2 weeks
2001-07-02 12:27:49 +00:00
__attribute__ ((format (printf, 2, 0)));
#else
Include the correct file (stdarg.h) and use va_list rather than _BSD_VA_LIST_ Suggested by: mike
2002-08-27 20:11:58 +00:00
extern void prompt_vPrintf(struct prompt *, const char *, va_list);
Silence some of the -Wnon-const-format warnings and add __printflike() to a function prototype which needs it. Approved by: brian MFC After: 2 weeks
2001-07-02 12:27:49 +00:00
#endif
Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
#define PROMPT_DONT_WANT_INT 1
#define PROMPT_WANT_INT 0
o Remove the `mode' global - it's now per physical device. o Shuffle things that live at the datalink level into ``show link'' rather than ``show modem''. o Make both ``show'' commands prettier and more consistent, and display carrier status, link type and our name in ``show modem''. o Show redial and reconnect information in ``show link'' and remove ``show redial'' and ``show reconnect''. o Down the correct link in bundle_LinkLost(). o Remove stale -direct and -background links at the end of our main loop, not when we know they're going. This prevents unexpected pointer-invalidations... o If we ``set server'' with the same values twice, notice and don't moan about failure. o Record dial script despite our link mode. The mode may be changed later (next mod) :-) We never run scripts in -direct and -dedicated modes. o Make ``set server none'' functional again. o Correct datalink state array so that we don't report an ``unknown'' state. o Pass struct ipcp to IpcpCleanInterface, not struct fsm. o Create TUN_PREFIX define rather than hard-coding in main.c o prompt_TtyInit now handles a NULL prompt for -direct mode rather than having to create one then destroy it uncleanly. o Mention our mode in the "PPP Started" LogPHASE message. o Bring all auto links up when we have something to send. o Remove some redundant Physical_*() functions. o Show which connection is running a command when logging commands. o Initialise throughput uptime correctly.
1998-04-10 13:19:23 +00:00
extern void prompt_TtyInit(struct prompt *);
Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
extern void prompt_TtyCommandMode(struct prompt *);
Keep a handle on our current ``term'' in struct prompt so that the `term' command works on the correct link.
1998-02-17 19:28:13 +00:00
extern void prompt_TtyTermMode(struct prompt *, struct datalink *);
Move the terminal/diagnostic socket stuff out of main.c and into the new `prompt.c'. struct prompt is (of course) a `sort' of descriptor.
1998-02-10 03:23:50 +00:00
extern void prompt_TtyOldMode(struct prompt *);
extern pid_t prompt_pgrp(struct prompt *);
Deglobalise `struct prompt': o Our diagnostic socket has its password set in the `set socket' line only (not in ppp.secret). o Passwords are per server socket (*VarAuthKey are gone) o Authority is per prompt (VarLocalAuth is gone). o Local logging is per prompt. o Add a `show who' command to see who's connected. No identd routine - just a `where the connection came from' display. o SIGUSR1 is disabled for now - we have no way of choosing a password for the socket created :-( Prompts are attached as a list of `struct descriptor's in struct bundle, and serviced under the bundles descriptor service routines. Ultimately, everything should be done like this. Cosmetic: o alphabeticalise SRCS in Makefile. o Add a few comments in command.h TODO: Start checking that we don't overflow the descriptor sets in select() now that we can have any number of descriptors.
1998-04-03 19:26:02 +00:00
extern int PasswdCommand(struct cmdargs const *);
Make ^Z, bg & fg work. We don't muck around with SIGTTIN or SIGTTOU, we just disable use of the prompt for the controlling terminal (and put a ^Z next to it in a ``show who'' listing). Unfortunately, we need to enable a timer to ``poll'' for the terminal having us as the controlling pgrp when a user does a ``bg''. If anyone knows how to do this better - please speak up (is there any indication to the process group leader when it's ctrling terminal gets tcsetpgrp()'d back ?)....
1998-04-05 18:25:34 +00:00
extern void prompt_Suspend(struct prompt *);
extern void prompt_Continue(struct prompt *);
Deglobalise `struct prompt': o Our diagnostic socket has its password set in the `set socket' line only (not in ppp.secret). o Passwords are per server socket (*VarAuthKey are gone) o Authority is per prompt (VarLocalAuth is gone). o Local logging is per prompt. o Add a `show who' command to see who's connected. No identd routine - just a `where the connection came from' display. o SIGUSR1 is disabled for now - we have no way of choosing a password for the socket created :-( Prompts are attached as a list of `struct descriptor's in struct bundle, and serviced under the bundles descriptor service routines. Ultimately, everything should be done like this. Cosmetic: o alphabeticalise SRCS in Makefile. o Add a few comments in command.h TODO: Start checking that we don't overflow the descriptor sets in select() now that we can have any number of descriptors.
1998-04-03 19:26:02 +00:00
#define prompt_IsTermMode(p, dl) ((p)->TermMode == (dl) ? 1 : 0)
#define prompt_IsController(p) (!(p) || (p)->owner ? 0 : 1)
#define prompt_Required(p) ((p)->needprompt = 1)
Reference in New Issue Copy Permalink