ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/info.C
Revision: 1.21
Committed: Sat Dec 16 03:08:26 2006 UTC (17 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.20: +2 -7 lines
Log Message:
- socket i/o is completely asynchronous now
- some command sare handled immediately
- others (most palying related commands) are queued
  for later (as of now synchronous) processing
- specifying a max queue length (in seconds) is possible, but disabled
- also add some syntax sugar for network code

File Contents

# User Rev Content
1 root 1.8
2 elmex 1.1 /*
3     CrossFire, A Multiplayer game for X-windows
4    
5     Copyright (C) 2002 Mark Wedel & Crossfire Development Team
6     Copyright (C) 1992 Frank Tore Johansen
7    
8     This program is free software; you can redistribute it and/or modify
9     it under the terms of the GNU General Public License as published by
10     the Free Software Foundation; either version 2 of the License, or
11     (at your option) any later version.
12    
13     This program is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16     GNU General Public License for more details.
17    
18     You should have received a copy of the GNU General Public License
19     along with this program; if not, write to the Free Software
20     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21    
22 root 1.6 The authors can be reached via e-mail at <crossfire@schmorp.de>
23 elmex 1.1 */
24    
25     /**
26     * \file
27     * Basic client output functions.
28     *
29     * \date 2003-12-02
30     *
31     * This file implements some of the simpler output functions to the
32     * client. Basically, things like sending text strings along
33     */
34    
35     #include <global.h>
36     #include <sproto.h>
37     #include <stdarg.h>
38     #include <spells.h>
39     #include <skills.h>
40    
41     /**
42     * Draws a normal message on the client. It is pretty
43     * much the same thing as the draw_info above, but takes a color
44     * parameter. the esrv_drawinfo functions should probably be
45     * replaced with this, just using black as the color.
46     */
47 root 1.5 static void
48 root 1.20 esrv_print_msg (client * ns, int color, const char *str)
49 elmex 1.1 {
50 root 1.21 ns->send_packet_printf ("drawinfo %d %s", color, str);
51 elmex 1.1 }
52    
53     /**
54     * Draws an extended message on the client.
55     * ns the socket to send message to
56     * color color informations (used mainly if client does not support message type)
57     * type,
58     * subtype type and subtype of text message
59     * intro Intro message to send with main message if client does not support the message type
60     * message The main message
61     */
62 root 1.5 static void
63 root 1.20 esrv_print_ext_msg (client * ns, int color, uint8 type, uint8 subtype, const char *message)
64 elmex 1.1 {
65 root 1.21 ns->send_packet_printf ("drawextinfo %d %hhu %hhu %s", color, type, subtype, message);
66 elmex 1.1 }
67    
68     /**
69     * Frontend for esrv_print_msg
70     * \param colr message color
71     * \param pl player to send to. Can be NULL
72     * \param tmp message to send. Can be NULL
73     *
74     * If pl is NULL or without contr set, writes message to log.
75     *
76     * Else sends message to player via esrv_print_msg
77     */
78    
79 root 1.5 static void
80     print_message (int colr, const object *pl, const char *tmp)
81     {
82 elmex 1.1
83 root 1.11 if (!tmp)
84     tmp = "[NULL]";
85 elmex 1.1
86     if (!pl || (pl->type == PLAYER && pl->contr == NULL))
87     return;
88    
89 root 1.5 if (pl->type == PLAYER)
90 root 1.17 esrv_print_msg (pl->contr->socket, colr, (char *) tmp);
91 elmex 1.1 }
92    
93     /**
94     * Prints out the contents of specified buffer structures,
95     * and clears the string.
96     */
97    
98 root 1.5 void
99     flush_output_element (const object *pl, Output_Buf * outputs)
100 elmex 1.1 {
101 root 1.5 char tbuf[MAX_BUF];
102 elmex 1.1
103 root 1.5 if (outputs->buf == NULL)
104     return;
105     if (outputs->count > 1)
106     {
107     snprintf (tbuf, MAX_BUF, "%d times %s", outputs->count, &outputs->buf);
108     print_message (NDI_BLACK, pl, tbuf);
109     }
110     else
111     print_message (NDI_BLACK, pl, &outputs->buf);
112 elmex 1.1
113 root 1.5 outputs->buf = NULL;
114     outputs->first_update = 0; /* This way, it will be reused */
115 elmex 1.1 }
116    
117     /**
118     * Sends message to player through output buffers.
119     * \param pl player to send message
120     * \param buf message to send
121     *
122     * If player's output_count is 1, sends message directly.
123     *
124     * Else checks output buffers for specified message.
125     *
126     * If found, checks if message should be sent now.
127     *
128     * If message not already in buffers, flushes olders buffer,
129     * and adds message to queue.
130     */
131    
132 root 1.5 static void
133     check_output_buffers (const object *pl, const char *buf)
134 elmex 1.1 {
135 root 1.5 int i, oldest = 0;
136 elmex 1.1
137 root 1.5 if (pl->contr->outputs_count < 2)
138     {
139     print_message (NDI_BLACK, pl, buf);
140     return;
141     }
142     else
143     {
144     for (i = 0; i < NUM_OUTPUT_BUFS; i++)
145     {
146     if (pl->contr->outputs[i].buf && !strcmp (buf, pl->contr->outputs[i].buf))
147     break;
148     else if (pl->contr->outputs[i].first_update < pl->contr->outputs[oldest].first_update)
149     oldest = i;
150 root 1.2 }
151 root 1.5 /* We found a match */
152     if (i < NUM_OUTPUT_BUFS)
153     {
154     pl->contr->outputs[i].count++;
155     if (pl->contr->outputs[i].count >= pl->contr->outputs_count)
156     {
157     flush_output_element (pl, &pl->contr->outputs[i]);
158 root 1.2 }
159     }
160 root 1.5 /* No match - flush the oldest, and put the new one in */
161     else
162     {
163     flush_output_element (pl, &pl->contr->outputs[oldest]);
164    
165     pl->contr->outputs[oldest].first_update = pticks;
166     pl->contr->outputs[oldest].count = 1;
167     pl->contr->outputs[oldest].buf = buf;
168 root 1.2 }
169 elmex 1.1 }
170     }
171 root 1.5
172 elmex 1.1
173    
174     /**
175     * Sends message to player(s).
176     *
177     * flags is various flags - mostly color, plus a few specials.
178     *
179     * pri is priority. It is a little odd - the lower the value, the more
180     * important it is. Thus, 0 gets sent no matter what. Otherwise, the
181     * value must be less than the listening level that the player has set.
182     * Unfortunately, there is no clear guideline on what each level does what.
183     *
184     * pl can be passed as NULL - in fact, this will be done if NDI_ALL is set
185     * in the flags.
186     *
187     * If message is black, and not NDI_UNIQUE, gets sent through output buffers.
188     *
189     */
190    
191 root 1.5 void
192     new_draw_info (int flags, int pri, const object *pl, const char *buf)
193 elmex 1.1 {
194    
195 root 1.5 if (flags & NDI_ALL)
196     {
197     player *tmppl;
198 elmex 1.1
199 root 1.5 for (tmppl = first_player; tmppl != NULL; tmppl = tmppl->next)
200     new_draw_info ((flags & ~NDI_ALL), pri, tmppl->ob, buf);
201 elmex 1.1
202 root 1.5 return;
203 elmex 1.1 }
204 root 1.11
205 root 1.5 if (!pl || (pl->type == PLAYER && pl->contr == NULL))
206     {
207     /* Write to the socket? */
208     print_message (0, NULL, buf);
209     return;
210 elmex 1.1 }
211 root 1.11
212 root 1.5 if (pl->type != PLAYER)
213     return;
214 root 1.11
215 root 1.5 if (pri >= pl->contr->listening)
216     return;
217    
218     if ((flags & NDI_COLOR_MASK) == NDI_BLACK && !(flags & NDI_UNIQUE))
219 root 1.11 /* following prints stuff out, as appropriate */
220     check_output_buffers (pl, buf);
221 root 1.5 else
222 root 1.11 print_message (flags & NDI_COLOR_MASK, pl, buf);
223 elmex 1.1 }
224    
225     /**
226     * Wrapper for new_draw_info printf-like.
227     *
228     * This is a pretty trivial function, but it allows us to use printf style
229     * formatting, so instead of the calling function having to do it, we do
230     * it here. It may also have advantages in the future for reduction of
231     * client/server bandwidth (client could keep track of various strings
232     */
233    
234 root 1.5 void
235     new_draw_info_format (int flags, int pri, const object *pl, const char *format, ...)
236 elmex 1.1 {
237 root 1.5 char buf[HUGE_BUF];
238    
239     va_list ap;
240    
241     va_start (ap, format);
242 elmex 1.1
243 root 1.5 vsnprintf (buf, HUGE_BUF, format, ap);
244 elmex 1.1
245 root 1.5 va_end (ap);
246 elmex 1.1
247 root 1.5 new_draw_info (flags, pri, pl, buf);
248 elmex 1.1 }
249    
250    
251 root 1.5 void
252     draw_ext_info (int flags, int pri, const object *pl, uint8 type, uint8 subtype, const char *message, const char *oldmessage)
253     {
254    
255     if (!pl || (pl->type != PLAYER) || (pl->contr == NULL))
256     return;
257    
258     if (pri >= pl->contr->listening)
259     return;
260 root 1.17
261     if (!CLIENT_SUPPORT_READABLES (pl->contr->socket, type))
262 root 1.5 {
263     char *buf = (char *) malloc (strlen (oldmessage == NULL ? message : oldmessage) + 1);
264    
265     if (buf == NULL)
266     LOG (llevError, "info::draw_ext_info -> Out of memory!");
267     else
268     {
269     strcpy (buf, oldmessage == NULL ? message : oldmessage);
270     strip_media_tag (buf);
271     new_draw_info (flags, pri, pl, buf);
272     free (buf);
273 elmex 1.1 }
274 root 1.5 }
275     else
276 root 1.17 esrv_print_ext_msg (pl->contr->socket, flags & NDI_COLOR_MASK, type, subtype, message);
277 elmex 1.1 }
278    
279 root 1.5 void
280     draw_ext_info_format (int flags, int pri, const object *pl, uint8 type, uint8 subtype, const char *old_format, char *new_format, ...)
281     {
282    
283     char buf[HUGE_BUF];
284    
285     if (!pl || (pl->type != PLAYER) || (pl->contr == NULL))
286     return;
287    
288     if (pri >= pl->contr->listening)
289     return;
290 root 1.17
291     if (!CLIENT_SUPPORT_READABLES (pl->contr->socket, type))
292 root 1.5 {
293     va_list ap;
294    
295     LOG (llevDebug, "Non supported extension text type for client.\n");
296     va_start (ap, new_format);
297     vsnprintf (buf, HUGE_BUF, old_format, ap);
298     va_end (ap);
299     new_draw_info (flags, pri, pl, buf);
300     return;
301     }
302     else
303     {
304     va_list ap;
305    
306     va_start (ap, new_format);
307     vsnprintf (buf, HUGE_BUF, new_format, ap);
308     va_end (ap);
309     strip_media_tag (buf);
310 root 1.17 esrv_print_ext_msg (pl->contr->socket, flags & NDI_COLOR_MASK, type, subtype, buf);
311 elmex 1.1 }
312     }
313 root 1.5
314 elmex 1.1 /**
315     * Writes to everyone on the map *except* op. This is useful for emotions.
316     */
317    
318 root 1.5 void
319 root 1.8 new_info_map_except (int color, maptile * map, object *op, const char *str)
320 root 1.5 {
321     player *pl;
322 elmex 1.1
323 root 1.5 for (pl = first_player; pl != NULL; pl = pl->next)
324     if (pl->ob != NULL && pl->ob->map == map && pl->ob != op)
325     {
326     new_draw_info (color, 0, pl->ob, str);
327     }
328 elmex 1.1 }
329    
330     /**
331     * Writes to everyone on the map except op1 and op2
332     */
333    
334 root 1.5 void
335 root 1.8 new_info_map_except2 (int color, maptile * map, object *op1, object *op2, const char *str)
336 root 1.5 {
337     player *pl;
338    
339     for (pl = first_player; pl != NULL; pl = pl->next)
340     if (pl->ob != NULL && pl->ob->map == map && pl->ob != op1 && pl->ob != op2)
341     {
342     new_draw_info (color, 0, pl->ob, str);
343     }
344 elmex 1.1 }
345    
346     /**
347     * Writes to everyone on the specified map
348     */
349    
350 root 1.5 void
351 root 1.8 new_info_map (int color, maptile * map, const char *str)
352 root 1.5 {
353     player *pl;
354 elmex 1.1
355 root 1.5 for (pl = first_player; pl != NULL; pl = pl->next)
356     if (pl->ob != NULL && pl->ob->map == map)
357     {
358     new_draw_info (color, 0, pl->ob, str);
359     }
360 elmex 1.1 }
361    
362    
363     /**
364     * This does nothing now. However, in theory, we should probably send
365     * something to the client and let the client figure out how it might want
366     * to handle this
367     */
368 root 1.5 void
369     clear_win_info (object *op)
370 elmex 1.1 {
371     }
372    
373     /**
374     * Get player's current range attack in obuf.
375     */
376 root 1.5 void
377     rangetostring (object *pl, char *obuf)
378 elmex 1.1 {
379 root 1.5 switch (pl->contr->shoottype)
380     {
381 root 1.8 case range_none:
382     strcpy (obuf, "Range: nothing");
383     break;
384 root 1.2
385 root 1.8 case range_bow:
386     {
387     object *op;
388 root 1.2
389 root 1.8 for (op = pl->inv; op; op = op->below)
390     if (op->type == BOW && QUERY_FLAG (op, FLAG_APPLIED))
391 root 1.5 break;
392 root 1.10
393 root 1.8 if (op == NULL)
394     break;
395    
396     sprintf (obuf, "Range: %s (%s)", query_base_name (op, 0), op->race ? (const char *) op->race : "nothing");
397     }
398     break;
399 root 1.5
400 root 1.8 case range_magic:
401     if (settings.casting_time == TRUE)
402     {
403     if (pl->casting_time > -1)
404     {
405     if (pl->casting_time == 0)
406 root 1.9 sprintf (obuf, "Range: Holding spell (%s)", &pl->spell->name);
407 root 1.8 else
408 root 1.9 sprintf (obuf, "Range: Casting spell (%s)", &pl->spell->name);
409 root 1.8 }
410     else
411     sprintf (obuf, "Range: spell (%s)", &pl->contr->ranges[range_magic]->name);
412 root 1.5 }
413 root 1.8 else
414     sprintf (obuf, "Range: spell (%s)", &pl->contr->ranges[range_magic]->name);
415     break;
416    
417     case range_misc:
418     sprintf (obuf, "Range: %s", pl->contr->ranges[range_misc] ? query_base_name (pl->contr->ranges[range_misc], 0) : "none");
419     break;
420    
421     /* range_scroll is only used for controlling golems. If the
422     * the player does not have a golem, reset some things.
423     */
424     case range_golem:
425     if (pl->contr->ranges[range_golem] != NULL)
426     sprintf (obuf, "Range: golem (%s)", &pl->contr->ranges[range_golem]->name);
427     else
428     {
429     pl->contr->shoottype = range_none;
430     strcpy (obuf, "Range: nothing");
431     }
432     break;
433 root 1.2
434 root 1.8 case range_skill:
435     sprintf (obuf, "Skill: %s", pl->chosen_skill != NULL ? (const char *) pl->chosen_skill->name : "none");
436     break;
437    
438     case range_builder:
439     sprintf (obuf, "Builder: %s", query_base_name (pl->contr->ranges[range_builder], 0));
440     break;
441 elmex 1.1
442 root 1.8 default:
443     strcpy (obuf, "Range: illegal");
444 elmex 1.1 }
445     }
446    
447     /**
448     * Sets player title.
449     */
450 root 1.5 void
451     set_title (object *pl, char *buf)
452 elmex 1.1 {
453 root 1.5 /* Eneq(@csd.uu.se): Let players define their own titles. */
454     if (pl->contr->own_title[0] == '\0')
455     sprintf (buf, "Player: %s the %s", (const char *) pl->name, (const char *) pl->contr->title);
456     else
457     sprintf (buf, "Player: %s %s", (const char *) pl->name, (const char *) pl->contr->own_title);
458 elmex 1.1 }
459    
460    
461     /**
462     * Helper for magic map creation.
463     *
464     * Takes a player, the map_mark array and an x and y starting position.
465     * pl is the player.
466     * px, py are offsets from the player.
467     *
468     * This function examines all the adjacant spaces next to px, py.
469     * It updates the map_mark arrow with the color and high bits set
470     * for various code values.
471     */
472 root 1.5 static void
473     magic_mapping_mark_recursive (object *pl, char *map_mark, int px, int py)
474 elmex 1.1 {
475 root 1.5 int x, y, dx, dy, mflags;
476     sint16 nx, ny;
477 root 1.7 maptile *mp;
478 root 1.5 New_Face *f;
479    
480     for (dx = -1; dx <= 1; dx++)
481     {
482     for (dy = -1; dy <= 1; dy++)
483     {
484     x = px + dx;
485     y = py + dy;
486    
487     if (FABS (x) >= MAGIC_MAP_HALF || FABS (y) >= MAGIC_MAP_HALF)
488     continue;
489    
490     mp = pl->map;
491     nx = pl->x + x;
492     ny = pl->y + y;
493    
494     mflags = get_map_flags (pl->map, &mp, nx, ny, &nx, &ny);
495     if (mflags & P_OUT_OF_MAP)
496     continue;
497    
498     if (map_mark[MAGIC_MAP_HALF + x + MAGIC_MAP_SIZE * (MAGIC_MAP_HALF + y)] == 0)
499     {
500     f = GET_MAP_FACE (mp, nx, ny, 0);
501     if (f == blank_face)
502     f = GET_MAP_FACE (mp, nx, ny, 1);
503     if (f == blank_face)
504     f = GET_MAP_FACE (mp, nx, ny, 2);
505    
506     /* Should probably have P_NO_MAGIC here also, but then shops don't
507     * work.
508     */
509     if (mflags & P_BLOCKSVIEW)
510     map_mark[MAGIC_MAP_HALF + x + MAGIC_MAP_SIZE * (MAGIC_MAP_HALF + y)] = FACE_WALL | (f ? f->magicmap : 0);
511     else
512     {
513     map_mark[MAGIC_MAP_HALF + x + MAGIC_MAP_SIZE * (MAGIC_MAP_HALF + y)] = FACE_FLOOR | (f ? f->magicmap : 0);
514     magic_mapping_mark_recursive (pl, map_mark, x, y);
515 root 1.2 }
516     }
517     }
518 elmex 1.1 }
519     }
520    
521    
522     /**
523     * Creates magic map for player.
524     *
525     * Note: For improved magic mapping display, the space that blocks
526     * the view is now marked with value 2. Any dependencies of map_mark
527     * being nonzero have been changed to check for 1. Also, since
528     * map_mark is a char value, putting 2 in should cause no problems.
529     *
530     * This function examines the map the player is on, and determines what
531     * is visible. 2 is set for walls or objects that blocks view. 1
532     * is for open spaces. map_mark should already have been initialized
533     * to zero before this is called.
534     * strength is an initial strength*2 rectangular area that we automatically
535     * see in/penetrate through.
536     */
537    
538 root 1.5 void
539     magic_mapping_mark (object *pl, char *map_mark, int strength)
540 elmex 1.1 {
541 root 1.5 int x, y, mflags;
542     sint16 nx, ny;
543 root 1.7 maptile *mp;
544 root 1.5 New_Face *f;
545    
546     for (x = -strength; x < strength; x++)
547     {
548     for (y = -strength; y < strength; y++)
549     {
550     mp = pl->map;
551     nx = pl->x + x;
552     ny = pl->y + y;
553     mflags = get_map_flags (pl->map, &mp, nx, ny, &nx, &ny);
554     if (mflags & P_OUT_OF_MAP)
555     continue;
556     else
557     {
558     f = GET_MAP_FACE (mp, nx, ny, 0);
559     if (f == blank_face)
560     f = GET_MAP_FACE (mp, nx, ny, 1);
561     if (f == blank_face)
562     f = GET_MAP_FACE (mp, nx, ny, 2);
563 root 1.2 }
564    
565 root 1.5 if (mflags & P_BLOCKSVIEW)
566     map_mark[MAGIC_MAP_HALF + x + MAGIC_MAP_SIZE * (MAGIC_MAP_HALF + y)] = FACE_WALL | (f ? f->magicmap : 0);
567     else
568     {
569     map_mark[MAGIC_MAP_HALF + x + MAGIC_MAP_SIZE * (MAGIC_MAP_HALF + y)] = FACE_FLOOR | (f ? f->magicmap : 0);
570     magic_mapping_mark_recursive (pl, map_mark, x, y);
571 root 1.2 }
572     }
573 elmex 1.1 }
574     }
575    
576    
577     /**
578     * Creates and sends magic map to player.
579     *
580     * The following function is a lot messier than it really should be,
581     * but there is no real easy solution.
582     *
583     * Mark Wedel
584     */
585    
586 root 1.5 void
587     draw_magic_map (object *pl)
588 elmex 1.1 {
589 root 1.13 char *map_mark = (char *)calloc (MAGIC_MAP_SIZE * MAGIC_MAP_SIZE, 1);
590 root 1.5 int xmin, xmax, ymin, ymax;
591    
592     if (pl->type != PLAYER)
593     {
594     LOG (llevError, "Non player object called draw_map.\n");
595     return;
596     }
597    
598     /* First, we figure out what spaces are 'reachable' by the player */
599     magic_mapping_mark (pl, map_mark, 3);
600    
601     /* We now go through and figure out what spaces have been
602     * marked, and thus figure out rectangular region we send
603     * to the client (eg, if only a 10x10 area is visible, we only
604     * want to send those 100 spaces.)
605     */
606     xmin = MAGIC_MAP_SIZE;
607     ymin = MAGIC_MAP_SIZE;
608     xmax = 0;
609     ymax = 0;
610 root 1.13
611     for (int x = 0; x < MAGIC_MAP_SIZE; x++)
612     for (int y = 0; y < MAGIC_MAP_SIZE; y++)
613     if (map_mark[x + MAP_WIDTH (pl->map) * y] | FACE_FLOOR)
614 root 1.5 {
615 root 1.13 xmin = x < xmin ? x : xmin;
616     xmax = x > xmax ? x : xmax;
617     ymin = y < ymin ? y : ymin;
618     ymax = y > ymax ? y : ymax;
619 root 1.2 }
620 elmex 1.1
621 root 1.15 packet sl;
622 root 1.13 sl.printf ("magicmap %d %d %d %d ", (xmax - xmin + 1), (ymax - ymin + 1),
623     MAGIC_MAP_HALF - xmin, MAGIC_MAP_HALF - ymin);
624    
625     for (int y = ymin; y <= ymax; y++)
626     for (int x = xmin; x <= xmax; x++)
627     sl << uint8 (map_mark[x + MAGIC_MAP_SIZE * y] & ~FACE_FLOOR);
628    
629 root 1.19 pl->contr->socket->send_packet (sl);
630 root 1.5
631     free (map_mark);
632 elmex 1.1 }
633    
634    
635     /**
636     * Send a kill log record to sockets
637     */
638    
639 root 1.5 void
640     Log_Kill (const char *Who, const char *What, int WhatType, const char *With, int WithType)
641     {
642     size_t len;
643     char buf[MAX_BUF];
644    
645     if (With != NULL)
646 root 1.11 snprintf (buf, MAX_BUF, "%s\t%s\t%d\t%s\t%d\n", Who, What, WhatType, With, WithType);
647 root 1.5 else
648 root 1.11 snprintf (buf, MAX_BUF, "%s\t%s\t%d\n", Who, What, WhatType);
649    
650 root 1.5 len = strlen (buf);
651 elmex 1.1 }