git.pond.sub.org Git - empserver/blob - src/lib/commands/xdump.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2011, 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  *  xdump.c: Extended dump
  28  *
  29  *  Known contributors to this file:
  30  *     Markus Armbruster, 2004-2011
  31  */
  32
  33 #include <config.h>
  34
  35 #include <ctype.h>
  36 #include "commands.h"
  37 #include "empobj.h"
  38 #include "news.h"
  39 #include "optlist.h"
  40 #include "version.h"
  41 #include "xdump.h"
  42
  43 /*
  44  * Is object P of type TYPE visible to the player?
  45  * TODO: Fold this into interators.
  46  */
  47 static int
  48 xdvisible(int type, void *p)
  49 {
  50     struct empobj *gp = p;
  51     struct trtstr *tp = p;
  52     struct lonstr *lp = p;
  53     struct natstr *natp;
  54     int tlev;
  55
  56     switch (type) {
  57     case EF_SECTOR:
  58     case EF_REALM:
  59         return gp->own == player->cnum || player->god;
  60     case EF_SHIP:
  61     case EF_PLANE:
  62     case EF_LAND:
  63     case EF_NUKE:
  64     case EF_LOST:
  65         return gp->own != 0 && (gp->own == player->cnum || player->god);
  66     case EF_NATION:
  67         return ((struct natstr *)p)->nat_stat != STAT_UNUSED;
  68     case EF_COUNTRY:
  69         return gp->own == player->cnum;
  70     case EF_NEWS:
  71         return ((struct nwsstr *)p)->nws_vrb != 0
  72             && (!opt_HIDDEN || player->god); /* FIXME */
  73     case EF_TREATY:
  74         return tp->trt_status != TS_FREE
  75             && (tp->trt_cna == player->cnum || tp->trt_cnb == player->cnum
  76                 || player->god);
  77     case EF_LOAN:
  78         if (lp->l_status == LS_FREE)
  79             return 0;
  80         if (lp->l_status == LS_SIGNED)
  81             return 1;
  82         return lp->l_loner == player->cnum || lp->l_lonee == player->cnum
  83             || player->god;
  84     case EF_TRADE:
  85     case EF_COMM:
  86         return gp->own != 0;
  87     case EF_SHIP_CHR:
  88         tlev = ((struct mchrstr *)p)->m_tech;
  89         goto tech;
  90     case EF_PLANE_CHR:
  91         tlev = ((struct plchrstr *)p)->pl_tech;
  92         goto tech;
  93     case EF_LAND_CHR:
  94         tlev = ((struct lchrstr *)p)->l_tech;
  95     tech:
  96         natp = getnatp(player->cnum);
  97         return player->god || tlev <= (int)(1.25 * natp->nat_level[NAT_TLEV]);
  98     case EF_NUKE_CHR:
  99         tlev = ((struct nchrstr *)p)->n_tech;
 100         if (drnuke_const > MIN_DRNUKE_CONST) {
 101             natp = getnatp(player->cnum);
 102             if (tlev > (int)((int)(1.25 * natp->nat_level[NAT_RLEV])
 103                              / drnuke_const))
 104                 return player->god;
 105         }
 106         goto tech;
 107     case EF_NEWS_CHR:
 108         return ((struct rptstr *)p)->r_newspage != 0;
 109     case EF_TABLE:
 110         return ((struct empfile *)p)->cadef != NULL;
 111     default:
 112         return 1;
 113     }
 114 }
 115
 116 /*
 117  * Dump meta-data for items of type TYPE to XD.
 118  * Return RET_SYN when TYPE doesn't have meta-data, else RET_OK.
 119  */
 120 static int
 121 xdmeta(struct xdstr *xd, int type)
 122 {
 123     struct castr *ca = ef_cadef(type);
 124     int i;
 125     int n = 0;
 126
 127     if (!ca)
 128         return RET_SYN;
 129
 130     xdhdr(xd, ef_nameof(type), 1);
 131     xdcolhdr(xd, ca);
 132
 133     for (i = 0; ca[i].ca_name; i++) {
 134         if (ca[i].ca_flags & NSC_DEITY && !xd->divine)
 135             continue;
 136         if (ca[i].ca_flags & NSC_EXTRA)
 137             continue;
 138         xdflds(xd, mdchr_ca, &ca[i]);
 139         xd->pr("\n");
 140         n++;
 141     }
 142
 143     xdftr(xd, n);
 144
 145     return RET_OK;
 146 }
 147
 148 /*
 149  * Dump items of type TYPE selected by ARG to XD.
 150  * Return RET_OK on success, RET_SYN on error.
 151  */
 152 static int
 153 xditem(struct xdstr *xd, int type, char *arg)
 154 {
 155     struct castr *ca;
 156     struct nstr_item ni;
 157     int n;
 158     char buf[2048];             /* FIXME buffer size? */
 159
 160     ca = ef_cadef(type);
 161     if (!ca)
 162         return RET_SYN;
 163
 164     if (!snxtitem(&ni, type, arg, NULL))
 165         return RET_SYN;
 166
 167     xdhdr(xd, ef_nameof(type), 0);
 168
 169     n = 0;
 170     while (nxtitem(&ni, buf)) {
 171         if (!xdvisible(type, buf))
 172             continue;
 173         ++n;
 174         xdflds(xd, ca, buf);
 175         xd->pr("\n");
 176     }
 177
 178     xdftr(xd, n);
 179
 180     return RET_OK;
 181 }
 182
 183 /* Extended dump command */
 184 int
 185 xdump(void)
 186 {
 187     char *p;
 188     char buf[1024];
 189     struct xdstr xd;
 190     struct natstr *natp;
 191     int type;
 192     int meta = 0;
 193
 194     p = getstarg(player->argp[1], "Table name, or meta? ", buf);
 195     if (p && strcmp(p, "meta") == 0) {
 196         meta = 1;
 197         p = getstarg(player->argp[2], "Table name? ", buf);
 198     }
 199     if (!p || !*p)
 200         return RET_SYN;
 201
 202     xdinit(&xd, player->cnum, 0, pr);
 203     natp = getnatp(player->cnum);
 204     type = isdigit(p[0]) ? atoi(p) : ef_byname(p);
 205     if (type < 0 || type >= EF_MAX)
 206         return RET_SYN;
 207     if (meta)
 208         return xdmeta(&xd, type);
 209     if ((EF_IS_GAME_STATE(type) || EF_IS_VIEW(type))
 210         && !(natp->nat_stat == STAT_ACTIVE || player->god)) {
 211         pr("Access to table %s denied\n", ef_nameof(type));
 212         return RET_FAIL;
 213     }
 214     return xditem(&xd, type, player->argp[2]);
 215 }