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