]> git.pond.sub.org Git - empserver/blob - src/lib/subs/unitsub.c
navigate: Fix buffer overrun for impossibly long paths taken
[empserver] / src / lib / subs / unitsub.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  *  unitsub.c: Common subroutines for multiple type of units
28  *
29  *  Known contributors to this file:
30  *     Ron Koenderink, 2007
31  *     Markus Armbruster, 2009-2014
32  */
33
34 #include <config.h>
35
36 #include "file.h"
37 #include "path.h"
38 #include "player.h"
39 #include "optlist.h"
40 #include "prototypes.h"
41 #include "unit.h"
42
43 char *
44 unit_nameof(struct empobj *gp)
45 {
46     switch (gp->ef_type) {
47     case EF_SHIP:
48         return prship((struct shpstr *)gp);
49     case EF_PLANE:
50         return prplane((struct plnstr *)gp);
51     case EF_LAND:
52         return prland((struct lndstr *)gp);
53     case EF_NUKE:
54         return prnuke((struct nukstr *)gp);
55     }
56     CANT_REACH();
57     return "The Beast #666";
58 }
59
60 void
61 unit_list(struct emp_qelem *unit_list)
62 {
63     struct emp_qelem *qp;
64     struct emp_qelem *next;
65     struct ulist *ulp;
66     int type, npln, nch, nxl;
67     struct empobj *unit;
68     struct lndstr *lnd;
69     struct shpstr *shp;
70
71     if (CANT_HAPPEN(QEMPTY(unit_list)))
72         return;
73     qp = unit_list->q_back;
74     ulp = (struct ulist *)qp;
75     type = ulp->unit.gen.ef_type;
76     if (CANT_HAPPEN(type != EF_LAND && type != EF_SHIP))
77         return;
78
79     if (type == EF_LAND)
80         pr("lnd#     land type       x,y    a  eff mil  sh gun xl ln  mu tech retr\n");
81     else
82         pr("shp#     ship type       x,y   fl  eff mil  sh gun pn he xl ln mob tech\n");
83
84     for (; qp != unit_list; qp = next) {
85         next = qp->q_back;
86         ulp = (struct ulist *)qp;
87         lnd = &ulp->unit.land;
88         shp = &ulp->unit.ship;
89         unit = &ulp->unit.gen;
90         if (CANT_HAPPEN(type != unit->ef_type))
91             continue;
92         pr("%4d ", unit->uid);
93         pr("%-16.16s ", empobj_chr_name(unit));
94         prxy("%4d,%-4d ", unit->x, unit->y);
95         pr("%1.1s", &unit->group);
96         pr("%4d%%", unit->effic);
97         if (type == EF_LAND) {
98             pr("%4d", lnd->lnd_item[I_MILIT]);
99             pr("%4d", lnd->lnd_item[I_SHELL]);
100             pr("%4d", lnd->lnd_item[I_GUN]);
101             pr("%3d%3d", lnd_nxlight(lnd), lnd_nland(lnd));
102         } else {
103             pr("%4d", shp->shp_item[I_MILIT]);
104             pr("%4d", shp->shp_item[I_SHELL]);
105             pr("%4d", shp->shp_item[I_GUN]);
106             npln = shp_nplane(shp, &nch, &nxl, NULL);
107             pr("%3d%3d%3d", npln - nch - nxl, nch, nxl);
108             pr("%3d", shp_nland(shp));
109         }
110         pr("%4d", unit->mobil);
111         pr("%4d", unit->tech);
112         if (type == EF_LAND) {
113             pr("%4d%%", lnd->lnd_retreat);
114         }
115         pr("\n");
116     }
117 }
118
119 char *
120 unit_path(int together, struct empobj *unit, char *buf, size_t bufsz)
121 {
122     coord destx;
123     coord desty;
124     struct sctstr sect;
125     size_t len;
126     double c;
127     int mtype;
128
129     if (CANT_HAPPEN(unit->ef_type != EF_LAND && unit->ef_type != EF_SHIP))
130         return NULL;
131
132     if (!sarg_xy(buf, &destx, &desty))
133         return buf;
134     if (!together) {
135         pr("Cannot go to a destination sector if not all starting in the same sector\n");
136         return NULL;
137     }
138     if (unit->ef_type == EF_SHIP) {
139         c = path_find(unit->x, unit->y, destx, desty,
140                       player->cnum, MOB_SAIL);
141         if (c < 0 || unit->mobil <= 0) {
142             pr("Can't get to '%s' right now.\n",
143                xyas(destx, desty, player->cnum));
144             return NULL;
145         }
146     } else {
147         getsect(unit->x, unit->y, &sect);
148         mtype = lnd_mobtype((struct lndstr *)unit);
149         /*
150          * Note: passing sect.sct_own for actor is funny, but works:
151          * its only effect is to confine the search to that nation's
152          * land.  It doesn't affect mobility costs.  The real actor is
153          * different for marching in allied land, and passing it would
154          * break path finding there.
155          */
156         c = path_find(unit->x, unit->y, destx, desty, sect.sct_own, mtype);
157         if (c < 0) {
158             pr("No owned %s from %s to %s!\n",
159                mtype == MOB_RAIL ? "railway" : "path",
160                xyas(unit->x, unit->y, player->cnum),
161                xyas(destx, desty, player->cnum));
162             return NULL;
163         }
164     }
165     len = path_find_route(buf, bufsz, unit->x, unit->y, destx, desty);
166     if (len == 0 || unit->ef_type == EF_LAND) {
167         if (len + 1 < bufsz)
168             strcpy(buf + len, "h");
169         len++;
170     }
171     if (len >= bufsz) {
172         pr("Can't handle path to %s, it's too long, sorry\n",
173            xyas(destx, desty, player->cnum));
174         return NULL;
175     }
176     pr("Using path '%s'\n", buf);
177     return buf;
178 }
179
180 void
181 unit_view(struct emp_qelem *list)
182 {
183     struct sctstr sect;
184     struct emp_qelem *qp;
185     struct emp_qelem *next;
186     struct ulist *ulp;
187
188     for (qp = list->q_back; qp != list; qp = next) {
189         next = qp->q_back;
190         ulp = (struct ulist *)qp;
191         if (CANT_HAPPEN(!(ef_flags(ulp->unit.gen.ef_type) & EFF_XY)))
192             continue;
193         getsect(ulp->unit.gen.x, ulp->unit.gen.y, &sect);
194         if (ulp->unit.gen.ef_type == EF_SHIP) {
195             if (((struct mchrstr *)ulp->chrp)->m_flags & M_FOOD)
196                 pr("[fert:%d] ", sect.sct_fertil);
197             if (((struct mchrstr *)ulp->chrp)->m_flags & M_OIL)
198                 pr("[oil:%d] ", sect.sct_oil);
199         }
200         pr("%s @ %s %d%% %s\n", unit_nameof(&ulp->unit.gen),
201            xyas(ulp->unit.gen.x, ulp->unit.gen.y, player->cnum),
202            sect.sct_effic, dchr[sect.sct_type].d_name);
203     }
204 }
205
206 /*
207  * Teleport UNIT to X,Y.
208  * If UNIT's mission op-area is centered on it, keep it centered.
209  */
210 void
211 unit_teleport(struct empobj *unit, coord x, coord y)
212 {
213     if (unit->opx == unit->x && unit->opy == unit->y) {
214         unit->opx = x;
215         unit->opy = y;
216     }
217     unit->x = x;
218     unit->y = y;
219 }
220
221 /*
222  * Update cargo of CARRIER for movement or destruction.
223  * If the carrier is destroyed, destroy its cargo (planes, land units,
224  * nukes).
225  * Else update their location to the carrier's.  Any op sectors equal
226  * to location get updated, too.
227  * Return number of units updated.
228  */
229 int
230 unit_update_cargo(struct empobj *carrier)
231 {
232     int cargo_type;
233     struct nstr_item ni;
234     union empobj_storage obj;
235     int n = 0;
236
237     for (cargo_type = EF_PLANE; cargo_type <= EF_NUKE; cargo_type++) {
238         snxtitem_cargo(&ni, cargo_type, carrier->ef_type, carrier->uid);
239         while (nxtitem(&ni, &obj)) {
240             if (carrier->own)
241                 unit_teleport(&obj.gen, carrier->x, carrier->y);
242             else {
243                 mpr(obj.gen.own, "%s lost!\n", unit_nameof(&obj.gen));
244                 obj.gen.effic = 0;
245             }
246             put_empobj(cargo_type, obj.gen.uid, &obj);
247             n++;
248         }
249     }
250     return n;
251 }
252
253 /*
254  * Drop cargo of UNIT.
255  * Give it to NEWOWN, unless it's zero.
256  */
257 void
258 unit_drop_cargo(struct empobj *unit, natid newown)
259 {
260     int type;
261     struct nstr_item ni;
262     union empobj_storage cargo;
263
264     for (type = EF_PLANE; type <= EF_NUKE; type++) {
265         snxtitem_cargo(&ni, type, unit->ef_type, unit->uid);
266         while (nxtitem(&ni, &cargo)) {
267             switch (type) {
268             case EF_PLANE:
269                 cargo.plane.pln_ship = cargo.plane.pln_land = -1;
270                 break;
271             case EF_LAND:
272                 cargo.land.lnd_ship = cargo.land.lnd_land = -1;
273                 break;
274             case EF_NUKE:
275                 cargo.nuke.nuk_plane = -1;
276                 break;
277             }
278             mpr(cargo.gen.own, "%s transferred off %s %d to %s\n",
279                 unit_nameof(&cargo.gen),
280                 ef_nameof(unit->ef_type), unit->uid,
281                 xyas(cargo.gen.x, cargo.gen.y, cargo.gen.own));
282             if (newown)
283                 unit_give_away(&cargo.gen, newown, cargo.gen.own);
284             put_empobj(type, cargo.gen.uid, &cargo.gen);
285         }
286     }
287 }
288
289 /*
290  * Give UNIT and its cargo to RECIPIENT.
291  * No action if RECIPIENT already owns UNIT.
292  * If GIVER is non-zero, inform RECIPIENT and GIVER of the transaction.
293  * Clears mission and group on the units given away.
294  */
295 void
296 unit_give_away(struct empobj *unit, natid recipient, natid giver)
297 {
298     int type;
299     struct nstr_item ni;
300     union empobj_storage cargo;
301
302     if (unit->own == recipient)
303         return;
304
305     if (giver) {
306         mpr(unit->own, "%s given to %s\n",
307             unit_nameof(unit), cname(recipient));
308         mpr(recipient, "%s given to you by %s\n",
309             unit_nameof(unit), cname(giver));
310     }
311
312     unit->own = recipient;
313     unit_wipe_orders(unit);
314     put_empobj(unit->ef_type, unit->uid, unit);
315
316     for (type = EF_PLANE; type <= EF_NUKE; type++) {
317         snxtitem_cargo(&ni, type, unit->ef_type, unit->uid);
318         while (nxtitem(&ni, &cargo))
319             unit_give_away(&cargo.gen, recipient, giver);
320     }
321 }
322
323 /*
324  * Wipe orders and such from UNIT.
325  */
326 void
327 unit_wipe_orders(struct empobj *unit)
328 {
329     struct shpstr *sp;
330     struct plnstr *pp;
331     struct lndstr *lp;
332     int i;
333
334     unit->group = 0;
335     unit->opx = unit->opy = 0;
336     unit->mission = 0;
337     unit->radius = 0;
338
339     switch (unit->ef_type) {
340     case EF_SHIP:
341         sp = (struct shpstr *)unit;
342         sp->shp_destx[0] = sp->shp_desty[0] = 0;
343         sp->shp_destx[1] = sp->shp_desty[1] = 0;
344         for (i = 0; i < TMAX; ++i) {
345             sp->shp_tstart[i] = I_NONE;
346             sp->shp_tend[i] = I_NONE;
347             sp->shp_lstart[i] = 0;
348             sp->shp_lend[i] = 0;
349         }
350         sp->shp_autonav = 0;
351         sp->shp_mobquota = 0;
352         sp->shp_path[0] = 0;
353         sp->shp_follow = sp->shp_uid;
354         sp->shp_rflags = 0;
355         sp->shp_rpath[0] = 0;
356         break;
357     case EF_PLANE:
358         pp = (struct plnstr *)unit;
359         pp->pln_range = pln_range_max(pp);
360         break;
361     case EF_LAND:
362         lp = (struct lndstr *)unit;
363         lp->lnd_retreat = morale_base;
364         lp->lnd_rflags = 0;
365         lp->lnd_rpath[0] = 0;
366         break;
367     case EF_NUKE:
368         break;
369     default:
370         CANT_REACH();
371     }
372 }