nethack/sys/unix/unixunix.c

/* NetHack 3.7	unixunix.c	$NHDT-Date: 1711213894 2024/03/23 17:11:34 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.43 $ */
/* Copyright (c) Stichting Mathematisch Centrum, Amsterdam, 1985. */
/*-Copyright (c) Kenneth Lorber, Kensington, Maryland, 2015. */
/* NetHack may be freely redistributed.  See license for details. */

/* This file collects some Unix dependencies */

#include "hack.h" /* mainly for strchr() which depends on BSD */

#include <errno.h>
#include <sys/stat.h>
#if defined(NO_FILE_LINKS) || defined(SUNOS4) || defined(POSIX_TYPES)
#include <fcntl.h>
#endif
#include <signal.h>

static int veryold(int);
static int eraseoldlocks(void);

#ifdef _M_UNIX
extern void sco_mapon(void);
extern void sco_mapoff(void);
#endif
#ifdef __linux__
extern void linux_mapon(void);
extern void linux_mapoff(void);
#endif

#ifndef NHSTDC
extern int errno;
#endif

static struct stat buf;

/* see whether we should throw away this xlock file;
   if yes, close it, otherwise leave it open */
static int
veryold(int fd)
{
    time_t date;

    if (fstat(fd, &buf))
        return 0; /* cannot get status */
#ifndef INSURANCE
    if (buf.st_size != sizeof (int))
        return 0; /* not an xlock file */
#endif
#if defined(BSD) && !defined(POSIX_TYPES)
    (void) time((long *) (&date));
#else
    (void) time(&date);
#endif
    if (date - buf.st_mtime < 3L * 24L * 60L * 60L) { /* recent */
        int lockedpid; /* should be the same size as hackpid */

        if (read(fd, (genericptr_t) &lockedpid, sizeof lockedpid)
            != sizeof lockedpid)
            /* strange ... */
            return 0;

/* From: Rick Adams <seismo!rick> */
/* This will work on 4.1cbsd, 4.2bsd and system 3? & 5. */
/* It will do nothing on V7 or 4.1bsd. */
#ifndef NETWORK
        /* It will do a VERY BAD THING if the playground is shared
           by more than one machine! -pem */
        if (!(kill(lockedpid, 0) == -1 && errno == ESRCH))
#endif
            return 0;
    }
    /* this used to close the file upon success, leave it open upon failure;
       that was supposed to simplify the caller's usage but ended up making
       that be more complicated; always leave the file open so that caller
       can close it unconditionally */
    /*(void) close(fd);*/
    return 1;
}

static int
eraseoldlocks(void)
{
    int i;

#if defined(HANGUPHANDLING)
    gp.program_state.preserve_locks = 0; /* not required but shows intent */
    /* cannot use maxledgerno() here, because we need to find a lock name
     * before starting everything (including the dungeon initialization
     * that sets astral_level, needed for maxledgerno()) up
     */
#endif
    for (i = 1; i <= MAXDUNGEON * MAXLEVEL + 1; i++) {
        /* try to remove all */
        set_levelfile_name(gl.lock, i);
        (void) unlink(fqname(gl.lock, LEVELPREFIX, 0));
    }
    set_levelfile_name(gl.lock, 0);
    if (unlink(fqname(gl.lock, LEVELPREFIX, 0)))
        return 0; /* cannot remove it */
    return 1;     /* success! */
}

void
getlock(void)
{
#ifndef SELF_RECOVER
    static const char destroy_old_game_prompt[] =
    "There is already a game in progress under your name.  Destroy old game?";
#endif
    int i = 0, fd, c, too_old;
    const char *fq_lock;

#ifdef TTY_GRAPHICS
    /* idea from rpick%ucqais@uccba.uc.edu
     * prevent automated rerolling of characters
     * test input (fd0) so that tee'ing output to get a screen dump still
     * works
     * also incidentally prevents development of any hack-o-matic programs
     */
    /* added check for window-system type -dlc */
    if (!strcmp(windowprocs.name, "tty"))
        if (!isatty(0))
            error("You must play from a terminal.");
#endif

    /* we ignore QUIT and INT at this point */
    if (!lock_file(HLOCK, LOCKPREFIX, 10)) {
        wait_synch();
        error("%s", "");
    }

    /* default value of gl.lock[] is "1lock" where '1' gets changed to
       'a','b',&c below; override the default and use <uid><charname>
       if we aren't restricting the number of simultaneous games */
    if (!gl.locknum)
        Sprintf(gl.lock, "%u%s", (unsigned) getuid(), gp.plname);

    regularize(gl.lock);
    set_levelfile_name(gl.lock, 0);

    if (gl.locknum) {
        if (gl.locknum > 25)
            gl.locknum = 25;

        do {
            gl.lock[0] = 'a' + i++;
            fq_lock = fqname(gl.lock, LEVELPREFIX, 0);

            if ((fd = open(fq_lock, 0)) == -1) {
                if (errno == ENOENT)
                    goto gotlock; /* no such file */
                perror(fq_lock);
                unlock_file(HLOCK);
                error("Cannot open %s", fq_lock);
            }

            /* veryold() no longer conditionally closes fd */
            too_old = veryold(fd);
            (void) close(fd);
            if (too_old && eraseoldlocks())
                goto gotlock;
        } while (i < gl.locknum);

        unlock_file(HLOCK);
        error("Too many hacks running now.");
    } else {
        fq_lock = fqname(gl.lock, LEVELPREFIX, 0);
        if ((fd = open(fq_lock, 0)) == -1) {
            if (errno == ENOENT)
                goto gotlock; /* no such file */
            perror(fq_lock);
            unlock_file(HLOCK);
            error("Cannot open %s", fq_lock);
        }

        /* veryold() no longer conditionally closes fd */
        too_old = veryold(fd);
        (void) close(fd);
        if (too_old && eraseoldlocks())
            goto gotlock;

        /* drop the "perm" lock while the user decides */
        unlock_file(HLOCK);
        if (iflags.window_inited) {
#ifdef SELF_RECOVER
            c = yn_function(
             "Old game in progress. Destroy [y], Recover [r], or Cancel [n]?",
                            "ynr", 'n', FALSE);
#else
            /* this is a candidate for paranoid_confirmation */
            c = y_n(destroy_old_game_prompt);
#endif
        } else {
#ifdef SELF_RECOVER
            (void) raw_printf(
        "\nThere is already a game in progress under your name.  Do what?\n");
            (void) raw_printf("\n  y - Destroy old game");
            (void) raw_printf("\n  r - Try to recover it");
            (void) raw_printf("\n  n - Cancel");
            (void) raw_printf("\n\n  => ");
            (void) fflush(stdout);
            do {
                c = getchar();
            } while (!strchr("rRyYnN", c) && c != -1);
#else
            (void) raw_printf("\n%s [yn] ", destroy_old_game_prompt);
            (void) fflush(stdout);
            if ((c = getchar()) != EOF) {
                int tmp;

                (void) putchar(c);
                (void) fflush(stdout);
                while ((tmp = getchar()) != '\n' && tmp != EOF)
                    ; /* eat rest of line and newline */
            }
#endif
        }
#ifdef SELF_RECOVER
        if (c == 'r' || c == 'R') {
            if (recover_savefile() && gp.program_state.in_self_recover) {
                set_levelfile_name(gl.lock, 0);
                fq_lock = fqname(gl.lock, LEVELPREFIX, 0);
                goto gotlock;
            } else {
                unlock_file(HLOCK);
                error("Couldn't recover old game.");
            }
        } else
#endif
        if (c == 'y' || c == 'Y') {
            if (eraseoldlocks()) {
                goto gotlock;
            } else {
                unlock_file(HLOCK);
                error("Couldn't destroy old game.");
            }
        } else {
            unlock_file(HLOCK);
            error("%s", "");
        }
    }

 gotlock:
    fd = creat(fq_lock, FCMASK);
    unlock_file(HLOCK);
    if (fd == -1) {
        error("cannot creat lock file (%s).", fq_lock);
        /*NOTREACHED*/
    } else {
        if (write(fd, (genericptr_t) &gh.hackpid, sizeof gh.hackpid)
            != sizeof gh.hackpid) {
            error("cannot write lock (%s)", fq_lock);
            /*NOTREACHED*/
        }
        if (close(fd) == -1) {
            error("cannot close lock (%s)", fq_lock);
            /*NOTREACHED*/
        }
    }
}

/* caller couldn't find a regular save file but did find a panic one */
void
ask_about_panic_save(void)
{
#ifdef CHECK_PANIC_SAVE
    static const char Instead_prompt[] = "Start a new game instead?";
    int c = '\0';

    pline("There is no regular save file but there is a panic one.");
    pline("It might be recoverable with demi-divine intervention.");
    if (iflags.window_inited) {
        c = yn_function(Instead_prompt, "yn\033q", 'n', FALSE);
    } else {
        raw_printf("%s [yn] (n) ", Instead_prompt);
        (void) fflush(stdout);
        do {
            c = getchar();
            if (c == EOF || c == '\033' || c == '\0')
                break;
            c = lowc(c);
        } while (!strchr("ynq\n", c));
    }
    if (c != 'y') {
        /* caller successfully called getlock() and made <levelfile>.0 */
        delete_levelfile(0);
        unlock_file(HLOCK); /* just in case, release 'perm' */
        if (iflags.window_inited)
            exit_nhwindows((char *) 0);
        nh_terminate(EXIT_SUCCESS);
    }
#endif
    return; /* proceed with new game */
}

/* normalize file name - we don't like .'s, /'s, spaces */
void
regularize(char *s)
{
    char *lp;

    while ((lp = strchr(s, '.')) != 0 || (lp = strchr(s, '/')) != 0
           || (lp = strchr(s, ' ')) != 0)
        *lp = '_';
#if defined(SYSV) && !defined(AIX_31) && !defined(SVR4) && !defined(LINUX) \
    && !defined(__APPLE__)
/* avoid problems with 14 character file name limit */
#ifdef COMPRESS
    /* leave room for .e from error and .Z from compress appended to
     * save files */
    {
#ifdef COMPRESS_EXTENSION
        int i = 12 - strlen(COMPRESS_EXTENSION);
#else
        int i = 10; /* should never happen... */
#endif
        if (strlen(s) > i)
            s[i] = '\0';
    }
#else
    if (strlen(s) > 11)
        /* leave room for .nn appended to level files */
        s[11] = '\0';
#endif
#endif
}

#if defined(TIMED_DELAY) && !defined(msleep) && defined(SYSV)
#include <poll.h>

void
msleep(unsigned msec) /* milliseconds */
{
    struct pollfd unused;
    int msecs = msec; /* poll API is signed */

    if (msecs < 0)
        msecs = 0; /* avoid infinite sleep */
    (void) poll(&unused, (unsigned long) 0, msecs);
}
#endif /* TIMED_DELAY for SYSV */

#ifdef SHELL
int
dosh(void)
{
    char *str;

#ifdef SYSCF
    if (!sysopt.shellers || !sysopt.shellers[0]
        || !check_user_string(sysopt.shellers)) {
        /* FIXME: should no longer assume a particular command keystroke */
        Norep("Unavailable command '!'.");
        return 0;
    }
#endif
    if (child(0)) {
        if ((str = getenv("SHELL")) != (char *) 0)
            (void) execl(str, str, (char *) 0);
        else
            (void) execl("/bin/sh", "sh", (char *) 0);
        raw_print("sh: cannot execute.");
        exit(EXIT_FAILURE);
    }
    return 0;
}
#endif /* SHELL */

#if defined(SHELL) || defined(DEF_PAGER) || defined(DEF_MAILREADER)
int
child(int wt)
{
    int f;

    suspend_nhwindows((char *) 0); /* also calls end_screen() */
#ifdef _M_UNIX
    sco_mapon();
#endif
#ifdef __linux__
    linux_mapon();
#endif
    if ((f = fork()) == 0) { /* child */
        (void) setgid(getgid());
        (void) setuid(getuid());
#ifdef CHDIR
        (void) chdir(getenv("HOME"));
#endif
        return 1;
    }
    if (f == -1) { /* cannot fork */
        pline("Fork failed.  Try again.");
        return 0;
    }
    /* fork succeeded; wait for child to exit */
#ifndef NO_SIGNAL
    (void) signal(SIGINT, SIG_IGN);
    (void) signal(SIGQUIT, SIG_IGN);
#endif
    (void) wait((int *) 0);
#ifdef _M_UNIX
    sco_mapoff();
#endif
#ifdef __linux__
    linux_mapoff();
#endif
#ifndef NO_SIGNAL
    (void) signal(SIGINT, (SIG_RET_TYPE) done1);
    if (wizard)
        (void) signal(SIGQUIT, SIG_DFL);
#endif
    if (wt) {
        raw_print("");
        wait_synch();
    }
    resume_nhwindows();
    return 0;
}
#endif /* SHELL || DEF_PAGER || DEF_MAILREADER */

#ifdef GETRES_SUPPORT

extern int nh_getresuid(uid_t *, uid_t *, uid_t *);
extern uid_t nh_getuid(void);
extern uid_t nh_geteuid(void);
extern int nh_getresgid(gid_t *, gid_t *, gid_t *);
extern gid_t nh_getgid(void);
extern gid_t nh_getegid(void);

/* the following several functions assume __STDC__ where parentheses
   around the name of a function-like macro prevent macro expansion */

int (getresuid)(uid_t *ruid, *euid, *suid)
{
    return nh_getresuid(ruid, euid, suid);
}

uid_t (getuid)(void)
{
    return nh_getuid();
}

uid_t (geteuid)(void)
{
    return nh_geteuid();
}

int (getresgid)(gid_t *rgid, *egid, *sgid)
{
    return nh_getresgid(rgid, egid, sgid);
}

gid_t (getgid)(void)
{
    return nh_getgid();
}

gid_t (getegid)(void)
{
    return nh_getegid();
}

#endif /* GETRES_SUPPORT */

/* XXX should be ifdef PANICTRACE_GDB, but there's no such symbol yet */
#ifdef PANICTRACE
boolean
file_exists(const char *path)
{
    struct stat sb;

    /* Just see if it's there - trying to figure out if we can actually
     * execute it in all cases is too hard - we really just want to
     * catch typos in SYSCF.
     */
    if (stat(path, &sb)) {
        return FALSE;
    }
    return TRUE;
}
#endif

/*unixunix.c*/