empserver/src/lib/player/player.c

/*
 *  Empire - A multi-player, client/server Internet based war game.
 *  Copyright (C) 1986-2017, Dave Pare, Jeff Bailey, Thomas Ruschak,
 *                Ken Stevens, Steve McClure, Markus Armbruster
 *
 *  Empire is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  ---
 *
 *  See files README, COPYING and CREDITS in the root of the source
 *  tree for related information and legal notices.  It is expected
 *  that future projects/authors will amend these files as needed.
 *
 *  ---
 *
 *  player.c: Main command loop for a player
 *
 *  Known contributors to this file:
 *     Steve McClure, 2000
 *     Markus Armbruster, 2004-2017
 *     Ron Koenderink, 2004-2009
 */

#include <config.h>

#include "chance.h"
#include "empio.h"
#include "empthread.h"
#include "misc.h"
#include "nat.h"
#include "optlist.h"
#include "player.h"
#include "prototypes.h"
#include "version.h"

static int command(void);
static int status(void);

struct player *player;

void
player_main(struct player *p)
{
    struct natstr *natp;
    char buf[128];

    player = p;
    time(&player->curup);
    update_timeused_login(player->curup);
    show_motd();
    if (running_test_suite)
	pr("\n"
	   "***          Server configured for testing          ***\n"
	   "*** If you see this in a game, it is misconfigured! ***\n");
    else if (strstr(version, "UNKNOWN-"))
	pr("\n"
	   "***              Server version is unknown               ***\n"
	   "*** If you see this in a game, it was built incorrectly! ***\n");

    if (init_nats() < 0) {
	pr("Server confused, try again later\n");
	return;
    }
    natp = getnatp(player->cnum);
    if (!may_play_now(natp, player->curup))
	return;
    if (natp->nat_stat != STAT_VIS
	&& natp->nat_last_login
	&& (strcmp(natp->nat_hostaddr, player->hostaddr)
	    || strcmp(natp->nat_userid, player->userid))) {
	pr("Last connection from: %s", ctime(&natp->nat_last_login));
	pr("                  to: %s",
	   natp->nat_last_login <= natp->nat_last_logout
	   ? ctime(&natp->nat_last_logout) : "?");
	pr("                  by: %s@%s\n",
	   natp->nat_userid, natp->nat_hostaddr);
    }
    strcpy(natp->nat_userid, player->userid);
    strcpy(natp->nat_hostaddr, player->hostaddr);
    natp->nat_last_login = player->curup;
    putnat(natp);
    if (natp->nat_flags & NF_INFORM && natp->nat_tgms > 0) {
	if (natp->nat_tgms == 1)
	    pr("You have a new telegram waiting ...\n");
	else
	    pr("You have %s new telegrams waiting ...\n",
	       numstr(buf, natp->nat_tgms));
	natp->nat_tgms = 0;
    }

    while (status() && command()) {
	if (player->got_ctld)
	    io_set_eof(player->iop);
	player->aborted = 0;
	empth_yield();
    }
    /* #*# I put the following line in to prevent server crash -KHS */
    natp = getnatp(player->cnum);
    time(&natp->nat_last_logout);
    putnat(natp);
    update_timeused(natp->nat_last_logout);
    enforce_minimum_session_time();
    pr("Bye-bye\n");
}

static int
command(void)
{
    struct natstr *natp = getnatp(player->cnum);
    char *redir;		/* UTF-8 */
    time_t now;

    prprompt(natp->nat_timeused / 60, natp->nat_btu);
    if (getcommand(player->combuf) < 0)
	return player->aborted;

    now = time(NULL);
    update_timeused(now);
    if (!player->god && !may_play_now(natp, now))
	return 0;

    if (parse(player->combuf, player->argbuf, player->argp,
	      player->comtail, &player->condarg, &redir) < 0) {
	pr("See \"info Syntax\"?\n");
    } else {
	if (dispatch(player->combuf, redir) < 0)
	    pr("Try \"list of commands\" or \"info\"\n");
    }
    return 1;
}

static int
status(void)
{
    struct natstr *natp;
    int old_nstat;
    char buf[128];

    natp = getnatp(player->cnum);
    if (player->dolcost > 100.0)
	pr("That just cost you $%.2f\n", player->dolcost);
    else if (player->dolcost < -100.0)
	pr("You just made $%.2f\n", -player->dolcost);
    if (player->dolcost != 0.0) {
	/*
	 * Hackish work around for a race condition in the nightly
	 * build's regression tests: sometimes the update starts right
	 * after the force command yields, sometimes a bit later.  If
	 * it is late, we use one random number here, for the bye,
	 * and throwing off the random sequence.
	 */
	natp->nat_money -= roundavg(player->dolcost);
	player->dolcost = 0.0;
    }

    old_nstat = player->nstat;
    player_set_nstat(player, natp);
    if ((old_nstat & MONEY) && !(player->nstat & MONEY))
	pr("You are now broke; industries are on strike.\n");
    if (!(old_nstat & MONEY) && (player->nstat & MONEY))
	pr("You are no longer broke!\n");

    time(&player->curup);
    update_timeused(player->curup);
    if (io_error(player->iop) || io_eof(player->iop)
	|| !may_play_now(natp, player->curup))
	return 0;

    if (player->btused) {
	natp->nat_btu -= player->btused;
	player->btused = 0;
    }
    if (natp->nat_tgms > 0) {
	if (!(natp->nat_flags & NF_INFORM)) {
	    if (natp->nat_tgms == 1)
		pr("You have a new telegram waiting ...\n");
	    else
		pr("You have %s new telegrams waiting ...\n",
		   numstr(buf, natp->nat_tgms));
	    natp->nat_tgms = 0;
	}
    }
    if (natp->nat_ann > 0) {
	if (natp->nat_ann == 1)
	    pr("You have a new announcement waiting ...\n");
	else
	    pr("You have %s new announcements waiting ...\n",
	       numstr(buf, natp->nat_ann));
	natp->nat_ann = 0;
    }
    if (natp->nat_stat == STAT_ACTIVE && (player->nstat & CAP) == 0)
	pr("You lost your capital... better designate one (see info capital)\n");
    putnat(natp);
    return 1;
}

/*
 * Make all objects stale if @arg is one of the player's command arguments.
 * See ef_make_stale() for what "making stale" means.
 * Useful for functions that prompt for missing arguments.
 * These can yield the processor, so we'd like to call ef_make_stale()
 * there.  Except that leads to false positives when the caller passes
 * an argument that is never null, and relies on the fact that the
 * function doesn't yield then.  We can't know that in general.  But
 * we do know in the common special case of command arguments.
 */
void
make_stale_if_command_arg(char *arg)
{
    if (player->argbuf <= arg
	&& arg <= player->argbuf + sizeof(player->argbuf))
	ef_make_stale();
}

/*
 * XXX This whole mess should be redone; execute block should
 * start with "exec start", and should end with "exec end".
 * We'll wait until 1.2 I guess.
 */
int
execute(void)
{
    char buf[1024];		/* UTF-8 */
    int failed;
    char *p;			/* UTF-8 */
    char *redir;		/* UTF-8 */

    failed = 0;

    p = player->comtail[1];
    if (!p)
	p = ugetstring("File? ", buf);
    if (p == NULL || *p == '\0')
	return RET_SYN;
    prexec(p);

    while (!failed && status() && !player->got_ctld) {
	player->nstat &= ~EXEC;
	if (getcommand(player->combuf) < 0)
	    break;
	if (parse(player->combuf, player->argbuf, player->argp,
		  player->comtail, &player->condarg, &redir) < 0) {
	    failed = 1;
	    continue;
	}
	pr("\nExecute : ");
	uprnf(player->combuf);
	pr("\n");
	if (redir) {
	    pr("Execute : redirection not supported\n");
	    failed = 1;
	} else if (dispatch(player->combuf, NULL) < 0)
	    failed = 1;
	/* player->aborted not reset; makes next getcommand() fail */
	empth_yield();
    }
    if (failed) {
	while (recvclient(buf, sizeof(buf)) >= 0) ;
    }

    pr("Execute : %s\n", failed ? "aborted" : "terminated");
    player->got_ctld = 0;
    return RET_OK;
}

int
show_motd(void)
{
    show_first_tel(motdfil);
    return RET_OK;
}

int
quit(void)
{
    io_set_eof(player->iop);
    return RET_OK;
}

char *
praddr(struct player *p)
{
    return prbuf("%s@%s", p->userid, p->hostaddr);
}