]> git.pond.sub.org Git - empserver/blob - src/lib/player/dispatch.c
tests: New test-suite-only command __cmd
[empserver] / src / lib / player / dispatch.c
1 /*
2  *  Empire - A multi-player, client/server Internet based war game.
3  *  Copyright (C) 1986-2014, Dave Pare, Jeff Bailey, Thomas Ruschak,
4  *                Ken Stevens, Steve McClure, Markus Armbruster
5  *
6  *  Empire is free software: you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation, either version 3 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  *
19  *  ---
20  *
21  *  See files README, COPYING and CREDITS in the root of the source
22  *  tree for related information and legal notices.  It is expected
23  *  that future projects/authors will amend these files as needed.
24  *
25  *  ---
26  *
27  *  dispatch.c: Actually execute the command given
28  *
29  *  Known contributors to this file:
30  *     Dave Pare, 1994
31  *     Steve McClure, 1998
32  *     Markus Armbruster, 2007-2014
33  */
34
35 #include <config.h>
36
37 #include "chance.h"
38 #include "com.h"
39 #include "empio.h"
40 #include "file.h"
41 #include "journal.h"
42 #include "match.h"
43 #include "misc.h"
44 #include "nat.h"
45 #include "optlist.h"
46 #include "player.h"
47 #include "prototypes.h"
48 #include "server.h"
49 #include "testing.h"
50
51 /*
52  * Last command's PRNG seed.
53  * Only used when running_test_suite.
54  */
55 int test_suite_prng_seed;
56
57 /*
58  * Execute command named by player->argp[0].
59  * BUF is the raw UTF-8 command line.  It should have been passed to
60  * parse() to set up player->argp.
61  * If REDIR is not null, it's the command's redirection, in UTF-8.
62  * Return -1 if the command is not unique or doesn't exist, else 0.
63  */
64 int
65 dispatch(char *buf, char *redir)
66 {
67     struct natstr *np;
68     struct cmndstr *command;
69     int cmd;
70
71     cmd = comtch(player->argp[0], player_coms, player->nstat);
72     if (cmd < 0) {
73         if (cmd == M_NOTUNIQUE)
74             pr("Command \"%s\" is ambiguous -- ", player->argp[0]);
75         else if (cmd == M_IGNORE)
76             return 0;
77         else
78             pr("\"%s\" is not a legal command\n", player->argp[0]);
79         return -1;
80     }
81     command = &player_coms[cmd];
82
83     np = getnatp(player->cnum);
84     if (np->nat_btu < command->c_cost && command->c_cost > 0) {
85         if (player->god || opt_BLITZ)
86             np->nat_btu = max_btus;
87         else {
88             pr("You don't have the BTU's, bozo\n");
89             return 0;
90         }
91     }
92     if (!command->c_addr) {
93         pr("Command not implemented\n");
94         return 0;
95     }
96     player->may_sleep = command->c_flags & C_MOD
97         ? PLAYER_SLEEP_ON_INPUT : PLAYER_SLEEP_FREELY;
98     player->command = command;
99     empth_rwlock_rdlock(update_lock);
100
101     /*
102      * When running the test suite, reseed PRNG for each command with
103      * a counter, to keep results stable even when the number of PRNs
104      * consumed changes.
105      * Tests can adjust the counter with "__cmd added ...", to
106      * keep the results stable when commands are inserted or deleted.
107      */
108     test_suite_prng_seed += !(command->c_permit & TESTING);
109     if (running_test_suite)
110         seed_prng(test_suite_prng_seed);
111
112     if (redir) {
113         prredir(redir);
114         uprnf(buf);
115         pr("\n");
116     }
117     journal_command(command->c_form);
118     switch (command->c_addr()) {
119     case RET_OK:
120         player->btused += command->c_cost;
121         break;
122     case RET_FAIL:
123         pr("command failed\n");
124         player->btused += command->c_cost;
125         break;
126     case RET_SYN:
127         pr("Usage: %s\n", command->c_form);
128         break;
129     default:
130         CANT_REACH();
131         break;
132     }
133
134     empth_rwlock_unlock(update_lock);
135     player->command = NULL;
136     if (player->may_sleep != PLAYER_SLEEP_NEVER || !io_eof(player->iop))
137         player->may_sleep = PLAYER_SLEEP_FREELY;
138     /* else we're being kicked out */
139     return 0;
140 }