]> git.pond.sub.org Git - empserver/blobdiff - src/lib/commands/xdump.c
Update copyright notice
[empserver] / src / lib / commands / xdump.c
index 15e49f7819512024a7eedfb3bd00fab665ab151e..9e93a2f5f72c49037005dd26a384e3893b34e4d6 100644 (file)
@@ -1,6 +1,6 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2005, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *  Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
  *                           Ken Stevens, Steve McClure
  *
  *  This program is free software; you can redistribute it and/or modify
  *
  *  ---
  *
- *  See the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
- *  related information and legal notices. It is expected that any future
- *  projects/authors will amend these files as needed.
+ *  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.
  *
  *  ---
  *
- *  xdump.c: Experimental extended dump
+ *  xdump.c: Extended dump
  * 
  *  Known contributors to this file:
- *     Markus Armbruster, 2004
+ *     Markus Armbruster, 2004-2007
  */
 
-#include <stddef.h>
-#include "misc.h"
-#include "file.h"
-#include "match.h"
-#include "news.h"
-#include "nsc.h"
-#include "optlist.h"
-#include "commands.h"
-
 /*
  * Dump everything under the sun
  *
  * - Sector designation characteristics: dchr[]
  * - Sector infrastructure characteristics: intrchr[]
  * - Ship characteristics: mchr[]
- * Less important:
  * - News item characteristics: rpt[]
- * - News page headings: page_headings[] (TODO)
+ * - News page headings: page_headings[]
  * - Commands: player_coms[] (TODO)
- * - Options: Options[]
+ * - Update schedule: update_time[] (not really static)
  * - Configuration: configkeys[]
  *
  * Dynamic game data:
- * - Sectors: EF_SECTOR, sect_ca[] (already have dump)
- * - Land units: EF_LAND, land_ca[] (already have ldump)
- * - Lost: EF_LOST, lost_ca[] (already have lost)
- * - Nukes: EF_NUKE, nuke_ca[] (already have ndump)
- * - Planes: EF_PLANE, plane_ca[] (already have pdump)
- * - Ships: EF_SHIP, ship_ca[] (already have sdump)
- * - News: EF_NEWS, news_ca[]
- * - Treaties: EF_TREATY, treaty_ca[]
- * - Power: EF_POWER
- * - Nations: EF_NATION, nat_ca[]
- * - Loans: EF_LOAN, loan_ca[]
+ * - Sectors: EF_SECTOR (superseding dump)
+ * - Land units: EF_LAND (superseding ldump)
+ * - Lost: EF_LOST (superseding lost)
+ * - Nukes: EF_NUKE (superseding ndump)
+ * - Planes: EF_PLANE (superseding pdump)
+ * - Ships: EF_SHIP (superseding sdump)
+ * - News: EF_NEWS
+ * - Treaties: EF_TREATY
+ * - Power: EF_POWER (TODO)
+ * - Nations: EF_NATION
+ * - Loans: EF_LOAN
  * - Map: EF_MAP (TODO)
  * - Bmap: EF_BMAP (TODO)
- * - Market: EF_COMM, commodity_ca[]
+ * - Market: EF_COMM
+ */
+
+/*
+ * See doc/xdump for motivation, syntax, semantics, and rationale.
+ * Make sure to keep it up-to-date!
  */
 
-/* FIXME document dump format */
-/* FIXME don't dump stuff that's useless due to options */
+/* TODO don't dump stuff that's useless due to options */
+
+#include <config.h>
+
+#include <ctype.h>
+#include <stddef.h>
+#include "commands.h"
+#include "empobj.h"
+#include "match.h"
+#include "news.h"
+#include "optlist.h"
+#include "treaty.h"
+#include "version.h"
 
 /*
  * Evaluate a attribute of an object into VAL, return VAL.
  * PTR points to the context object.
  * The attribute is stored there at offset OFF + IDX * S, where S is
  * its size.
+ * LEN is the #array elements if it is an array, else zero.
  */
 static struct valstr *
-xdeval(struct valstr *val, nsc_type type, void *ptr, ptrdiff_t off, int idx)
+xdeval(struct valstr *val,
+       nsc_type type, void *ptr, ptrdiff_t off, int idx, int len)
 {
     val->val_type = type;
     val->val_cat = NSC_OFF;
     val->val_as.sym.off = off;
+    val->val_as.sym.len = len;
     val->val_as.sym.idx = idx;
     nstr_exec_val(val, player->cnum, ptr, NSC_NOTYPE);
     return val;                        /* FIXME nstr_exec_val() should return VAL */
@@ -104,7 +113,6 @@ xdprval(struct valstr *val, char *sep)
     unsigned char *s, *e, *l;
 
     switch (val->val_type) {
-    case NSC_TYPEID:
     case NSC_LONG:
        pr("%s%ld", sep, val->val_as.lng);
        break;
@@ -118,7 +126,10 @@ xdprval(struct valstr *val, char *sep)
            l = s + val->val_as.str.maxsz;
            /* FIXME maxsz == INT_MAX ! */
            for (;;) {
-               for (e=s; e<l && *e != '"' && *e != '\\' && isgraph(*e); ++e) ;
+               for (e = s;
+                    e < l && *e != '"' && *e != '\\' && isgraph(*e);
+                    ++e)
+                   ;
                pr("%.*s", (int)(e-s), s);
                if (e < l && *e)
                    pr("\\%03o", *e++);
@@ -131,7 +142,7 @@ xdprval(struct valstr *val, char *sep)
            pr("%snil", sep);
        break;
     default:
-       CANT_HAPPEN("Bad VAL type");
+       CANT_REACH();
        pr("0");
     }
     return " ";
@@ -157,7 +168,7 @@ xdflds(struct castr ca[], void *ptr)
        n = ca[i].ca_type != NSC_STRINGY ? ca[i].ca_len : 0;
        j = 0;
        do {
-           xdeval(&val, ca[i].ca_type, ptr, ca[i].ca_off, j);
+           xdeval(&val, ca[i].ca_type, ptr, ca[i].ca_off, j, ca[i].ca_len);
            sep = xdprval(&val, sep);
        } while (++j < n);
     }
@@ -180,6 +191,79 @@ xdftr(int n)
     pr("/%d\n", n);
 }
 
+/*
+ * Is object P of type TYPE visible to the player?
+ * TODO: Fold this into interators.
+ */
+static int
+xdvisible(int type, void *p)
+{
+    struct empobj *gp = p;
+    struct trtstr *tp = p;
+    struct lonstr *lp = p;
+    struct natstr *natp;
+    int tlev;
+
+    switch (type) {
+    case EF_SECTOR:
+    case EF_REALM:
+       return gp->own == player->cnum || player->god;
+    case EF_SHIP:
+    case EF_PLANE:
+    case EF_LAND:
+    case EF_NUKE:
+    case EF_LOST:
+       return gp->own != 0 && (gp->own == player->cnum || player->god);
+    case EF_NATION:
+       return ((struct natstr *)p)->nat_stat != STAT_UNUSED;
+    case EF_COUNTRY:
+       return gp->own == player->cnum;
+    case EF_NEWS:
+       return ((struct nwsstr *)p)->nws_vrb != 0
+           && (!opt_HIDDEN || player->god); /* FIXME */
+    case EF_TREATY:
+       return tp->trt_status != TS_FREE
+           && (tp->trt_cna == player->cnum || tp->trt_cnb == player->cnum
+               || player->god);
+    case EF_LOAN:
+       if (lp->l_status == LS_FREE)
+           return 0;
+       if (lp->l_status == LS_SIGNED)
+           return 1;
+       return lp->l_loner == player->cnum || lp->l_lonee == player->cnum
+           || player->god;
+    case EF_TRADE:
+    case EF_COMM:
+       return gp->own != 0;
+    case EF_SHIP_CHR:
+       tlev = ((struct mchrstr *)p)->m_tech;
+       goto tech;
+    case EF_PLANE_CHR:
+       tlev = ((struct plchrstr *)p)->pl_tech;
+       goto tech;
+    case EF_LAND_CHR:
+       tlev = ((struct lchrstr *)p)->l_tech;
+    tech:
+       natp = getnatp(player->cnum);
+       return player->god || tlev <= (int)(1.25 * natp->nat_level[NAT_TLEV]);
+    case EF_NUKE_CHR:
+       tlev = ((struct nchrstr *)p)->n_tech;
+       if (drnuke_const > MIN_DRNUKE_CONST) {
+           natp = getnatp(player->cnum);
+           if (tlev > (int)((int)(1.25 * natp->nat_level[NAT_RLEV])
+                            / drnuke_const))
+               return player->god;
+       }
+       goto tech;
+    case EF_NEWS_CHR:
+       return ((struct rptstr *)p)->r_newspage != 0;
+    case EF_TABLE:
+       return ((struct empfile *)p)->cadef != NULL;
+    default:
+       return 1;
+    }
+}
+
 /*
  * Dump items of type TYPE selected by ARG.
  * Return RET_OK on success, RET_SYN on error.
@@ -187,7 +271,6 @@ xdftr(int n)
 static int
 xditem(int type, char *arg)
 {
-    int check_owner = !player->god && (ef_flags(type) & EFF_OWNER) != 0;
     struct castr *ca;
     struct nstr_item ni;
     int n;
@@ -204,7 +287,7 @@ xditem(int type, char *arg)
 
     n = 0;
     while (nxtitem(&ni, buf)) {
-       if (check_owner && ((struct genitem *)buf)->own != player->cnum)
+       if (!xdvisible(type, buf))
            continue;
        ++n;
        xdflds(ca, buf);
@@ -238,8 +321,8 @@ xdmeta(int type)
        if (ca[i].ca_flags & NSC_EXTRA)
            continue;
        xdflds(mdchr_ca, &ca[i]);
-       n++;
        pr("\n");
+       n++;
     }
 
     xdftr(n);
@@ -247,46 +330,6 @@ xdmeta(int type)
     return RET_OK;
 }
 
-/*
- * Dump Options[], return RET_OK.
- * If META, dump meta-data rather than data.
- */
-static int
-xdopt(int meta)
-{
-    int i;
-    char *sep;
-    struct castr ca;
-
-    xdhdr("options", meta);
-
-    if (meta) {
-       for (i = 0; Options[i].opt_key; ++i) {
-           ca.ca_type = NSC_INT;
-           ca.ca_flags = 0;
-           ca.ca_len = 0;
-           ca.ca_off = 0;
-           ca.ca_name = Options[i].opt_key;
-           ca.ca_table = EF_BAD;
-           xdflds(mdchr_ca, &ca);
-           pr("\n");
-       }
-       xdftr(i);
-       return RET_OK;
-    }
-
-    sep = "";
-    for (i = 0; Options[i].opt_key; ++i) {
-       pr("%s%d", sep, *Options[i].opt_valuep);
-       sep = " ";
-    }
-    pr("\n");
-
-    xdftr(1);
-
-    return RET_OK;
-}
-
 /*
  * Dump configkeys[], return RET_OK.
  * If META, dump meta-data rather than data.
@@ -294,6 +337,9 @@ xdopt(int meta)
 static int
 xdver(int meta)
 {
+    static struct castr vers_ca = {
+       NSC_STRINGY, 0, sizeof(PACKAGE_STRING), 0, "version", EF_BAD
+    };
     struct keymatch *kp;
     char *sep;
     int n;
@@ -304,6 +350,9 @@ xdver(int meta)
 
     if (meta) {
        n = 0;
+       xdflds(mdchr_ca, &vers_ca);
+       pr("\n");
+       n++;
        for (kp = configkeys; kp->km_key; ++kp) {
            if (kp->km_type != NSC_NOTYPE && !(kp->km_flags & KM_INTERNAL)) {
                ca.ca_type = kp->km_type;
@@ -321,10 +370,11 @@ xdver(int meta)
        return RET_OK;
     }
 
-    sep = "";
+    xdeval(&val, vers_ca.ca_type, version, vers_ca.ca_off, 0, vers_ca.ca_len);
+    sep = xdprval(&val, "");
     for (kp = configkeys; kp->km_key; ++kp) {
        if (kp->km_type != NSC_NOTYPE && !(kp->km_flags & KM_INTERNAL)) {
-           xdeval(&val, kp->km_type, kp->km_data, 0, 0);
+           xdeval(&val, kp->km_type, kp->km_data, 0, 0, 0);
            sep = xdprval(&val, sep);
        }
     }
@@ -343,28 +393,27 @@ xdump(void)
     char buf[1024];
     int type;
     int meta = 0;
+    struct natstr *natp;
 
-    if (!opt_GUINEA_PIGS) {
-       pr("You are not a guinea pig!\n");
-       return RET_FAIL;
-    }
-
-    p = getstarg(player->argp[1], "What? ", buf);
+    p = getstarg(player->argp[1], "Table name, or meta? ", buf);
     if (p && strcmp(p, "meta") == 0) {
        meta = 1;
-       p = getstarg(player->argp[2], "What? ", buf);
+       p = getstarg(player->argp[2], "Table name? ", buf);
     }
-    if (!p)
+    if (!p || !*p)
        return RET_SYN;
 
+    natp = getnatp(player->cnum);
     type = isdigit(p[0]) ? atoi(p) : ef_byname(p);
-    if (type >= 0) {
+    if (type >= 0 && type < EF_MAX) {
        if (meta)
            return xdmeta(type);
-       else
+       else if ((EF_IS_GAME_STATE(type) || EF_IS_VIEW(type))
+                && !(natp->nat_stat == STAT_ACTIVE || player->god)) {
+           pr("Access to table %s denied\n", ef_nameof(type));
+           return RET_FAIL;
+       } else
            return xditem(type, player->argp[2]);
-    } else if (!strncmp(p, "opt", strlen(p))) {
-       return xdopt(meta);
     } else if (!strncmp(p, "ver", strlen(p))) {
        return xdver(meta);
     }