server/server/freezethaw.C

/*****************************************************************************/
/*  CrossFire, A roguelike realtime multiplayer game                         */
/*****************************************************************************/

/*
 *  This code is placed under the GNU General Public Licence (GPL)
 *
 *  Copyright (C) 2006      by Marc Lehmann <crossfire@schmorp.de>
 *                                                                          
 *  This program is free software; you can redistribute it and/or modify    
 *  it under the terms of the GNU General Public License as published by    
 *  the Free Software Foundation; either version 2 of the License, or       
 *  (at your option) any later version.                                     
 *                                                                          
 *  This program is distributed in the hope that it will be useful,         
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of          
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           
 *  GNU General Public License for more details.                            
 *                                                                          
 *  You should have received a copy of the GNU General Public License       
 *  along with this program; if not, write to the Free Software             
 *  Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA 
 */

#include "global.h" // bug in cfperl.h, doesn't include interface_class stuff
#include "logger.h"
#include "cfperl.h"
#include "kw_hash.h"

object_freezer::object_freezer ()
: dynbuf_text (128 * 1024, 64 * 1024)
{
  av = newAV ();
}

object_freezer::~object_freezer ()
{
  SvREFCNT_dec (av);
}

void
object_freezer::put (attachable *ext)
{
  ext->optimise ();

  if (ext->self)
    {
      int idx = AvFILLp ((AV *)av) + 1;
      av_store (av, idx, newRV_inc ((SV *)ext->self));

      add ((void *)"oid ", 4);
      add ((sint32)idx);
      add ('\n');
    }
}

bool
object_freezer::save (const char *path)
{
  CALL_BEGIN (3);
  CALL_ARG_SV (newSVpv (path, 0));
  CALL_ARG_SV (newRV_noinc (newSVpvn ((char *)linearise (), size ())));
  CALL_ARG_SV (newRV_inc ((SV *)av));
  CALL_CALL ("cf::object_freezer_save", G_VOID | G_DISCARD);
  CALL_END;

  return 1;
}

char *
object_freezer::as_string ()
{
  CALL_BEGIN (2);
  CALL_ARG_SV (newRV_noinc (newSVpvn ((char *)linearise (), size ())));
  CALL_ARG_SV (newRV_inc ((SV *)av));
  CALL_CALL ("cf::object_freezer_as_string", G_SCALAR);

  char *res = count > 0
                ? strdup (SvPVX (POPs))
                : strdup ("[fatal error]");

  CALL_END;

  return res;
}

void
fprintf (object_freezer &freezer, const char *format, ...)
{
  va_list ap;

  va_start (ap, format);

  int len = vsnprintf ((char *)freezer.force (1024), 1024, format, ap);

  if (len >= 0)
    freezer.alloc (len);

  va_end (ap);
}

// XXX: function not returning an int
void
fputs (const char *s, object_freezer &freezer)
{
  freezer.add (s);
}

static const char thawer_eof[] = "\n\n\n\0\0\0";

object_thawer::object_thawer (const char *path)
: name (strdup (path))
{
  static const char eof[] = "\n\n\n\0\0\0";

  av      = 0;
  text    = 0;
  line    = 0;
  linenum = 0;

  kw      = KW_ERROR;
  kw_str  = 0;
  value   = 0;

  if (path)
    {
      CALL_BEGIN (1);
      CALL_ARG_SV (newSVpv (path, 0));
      CALL_CALL ("cf::object_thawer_load", G_ARRAY);

      if (count == 2)
        {
          // second value - perl objects
          {
            SV *sv = POPs;
            if (SvROK (sv))
              av = (AV *)SvREFCNT_inc (SvRV (sv));
          }

          // first value - text part, pad with 3 zeroes
          {
            SV *sv = POPs;
            STRLEN len;
            char *sv_ = SvPVbyte (sv, len);
            text = newSV (len + sizeof (eof));
            SvCUR_set (text, len);
            memcpy (SvPVX (text), sv_, len);
            memcpy (SvEND (text), eof, sizeof (eof)); // just to be sure

            line = SvPVX (text);
          }
        }

      CALL_END;
    }
}

object_thawer::object_thawer (const char *data, AV *perlav)
: name (strdup ("(memory stream"))
{
  av   = perlav;
  text = newSVpv (data, 0);
  sv_catpv (text, thawer_eof);
  line = SvPVbyte_nolen (text);
}

void
object_thawer::get (attachable *obj, int oid)
{
  if (!av || oid < 0) // this is actually an error of sorts
    return;

  SV **svp = av_fetch ((AV *)av, oid, 0);

  if (!svp || !SvROK (*svp))
    {
      LOG (llevError, "trying to thaw duplicate or never-issued oid %d, ignoring.\n", oid);
      return;
    }

  if (!SvROK (*svp))
    {
      LOG (llevError, "deserialised perl object is not an RV\n");
      return;
    }

  HV *hv = (HV *)SvRV (*svp);

  if (SvTYPE (hv) != SVt_PVHV)
    {
      LOG (llevError, "deserialised perl object is not a PVHV\n");
      return;
    }

  if (obj->self)
    {
      // the hard way(?)

      CALL_BEGIN (2);
      CALL_ARG_SV (newRV_inc ((SV *)obj->self));
      CALL_ARG_SV (newRV_inc ((SV *)hv));
      PUTBACK;
      call_method ("thawer_merge", G_DISCARD | G_EVAL);
      SPAGAIN;
      CALL_END;
    }
  else
    {
      // the easy way(?)

      obj->self = hv;
      SvRV_set (*svp, &PL_sv_undef);

      sv_magicext ((SV *)obj->self, 0, PERL_MAGIC_ext, &attachable::vtbl, (char *)obj, 0);
    }

  obj->reattach ();
}

object_thawer::~object_thawer ()
{
  if (text) SvREFCNT_dec (text);
  if (av)   SvREFCNT_dec (av);

  free ((void *)name);
}

//TODO: remove
char *
fgets (char *s, int n, object_thawer &thawer)
{
  char *p = thawer.line;
  char *q = s;

  if (!p)
    return 0;

  while (--n)
    {
      if (!*p)
        break;

      *q++ = *p;

      if (*p++ == '\n')
        {
          ++thawer.linenum;
          break;
        }
    }

  *q = 0;
  thawer.line = p;

  return s == q ? 0 : s;
}

bool
object_thawer::parse_error (const char *type, const char *name, bool skip)
{
  if (!type) type = "file section";
  if (!name) name = "generic";

  switch (kw)
    {
      case KW_EOF:
        LOG (llevError, "%s:%d end of file while reading %s '%s', aborting load.\n",
             this->name, linenum, type, name);
        return false;

      case KW_ERROR:
        LOG (llevError, "%s:%d error while reading %s '%s', at '%s', aborting load.\n",
             this->name, linenum,
             type, name,
             kw_str ? kw_str : "<file load>");
        return false;

      default:
        LOG (llevError, "%s:%d unexpected line (%s %s) while reading %s '%s', %s.\n",
             this->name, linenum,
             kw_str ? kw_str : "<null>",
             value   ? value   : "<null>",
             type, name,
             skip ? "skipping line" : "aborting load");
        return skip;
    }
}

void
object_thawer::next ()
{
  if (!line)
    {
      kw = KW_ERROR;
      return;
    }

  for (;;)
    {
      char *p = line;

      if (*p <= ' ')
        {
          // skip whitespace (only some files need this)
          while (*p == ' ' || *p == '\t')
            p++;

          line = p;
        }

      if (!*p)
        {
          kw = KW_EOF;
          break;
        }

      // parse keyword
      while (*p > ' ')
        p++;

      int klen = p - line;

      value = 0;

      if (*p++ != '\n')
        {
          // parse value
          while (*(unsigned char *)p <= ' ' && *p != '\n')
            ++p;

          value = p;

          while (*p != '\n')
            p++;

          *p++ = 0;
        }

      ++linenum;
      line [klen] = 0;
      keyword_idx *kw_idx = kw_lex::match (line, klen);

      kw_str = line;
      line = p;

      if (kw_idx)
        {
          kw = kw_idx->index;
          break;
        }
      else if (!*kw_str || *kw_str == '#')
        ; // empty/comment line
      else
        {
          kw = KW_ERROR;
          break;
        }
    }
}

void
object_thawer::skip ()
{
  shstr ml;

  switch (kw)
    {
      case KW_msg:     get_ml (KW_endmsg    , ml); break;
      case KW_lore:    get_ml (KW_endlore   , ml); break;
      case KW_maplore: get_ml (KW_endmaplore, ml); break;
      default:                                     break;
    }

  next ();
}
 
void
object_thawer::get (shstr &sh) const
{
  if (value)
    sh = value;
  else
    {
      sh = "<value missing>";
      LOG (llevError, "keyword \"%s\" requires value, substituting with <value missing>\n", kw_str);//TODO: add filename
    }
}

void
object_thawer::get_ml (keyword kend, shstr &sh)
{
  char kw[128];

  int klen = keyword_len [kend];

  kw [0] = '\n';
  memcpy (kw + 1, keyword_str [kend], klen);
  kw [klen + 1] = '\n';
  kw [klen + 2] = 0;

  ++linenum;

  // first test for completely empty msg... "endXXX\n"
  if (!strncmp (line, kw + 1, klen + 1))
    {
      sh = 0;

      line += klen + 1;

      return;
    }
  else
    {
      // multi-line strings are delimited by "\nendXXX\n" or "endXXX\n" (NULL)

      char *end = strstr (line, kw);

      if (!end)
        {
          sh = 0;
          return;
        }

      *end = 0;
      sh = line;

      // count line numbers
      while (line < end)
        linenum += *line++ == '\n';

      line += keyword_len [kend];

      while (*line++ != '\n')
        ;

      ++linenum;
    }
}

sint32
object_thawer::get_sint32 () const
{
  char *p = value;

  if (!p)
    return 0;

  sint32 val = 0;
  bool negate;

  if (*p == '-')
    {
      negate = true;
      ++p;
    }
  else
    negate = false;

  do
    {
      val *= 10;
      val += *p++ - '0';
    }
  while (*p);

  return negate ? -val : val;
}

sint64
object_thawer::get_sint64 () const
{
  return value ? atoll (value) : 0;
}

double
object_thawer::get_double () const
{
  return value ? atof (value) : 0;
}

Revision:	1.18
Committed:	Mon Apr 30 05:54:14 2007 UTC (17 years, 1 month ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.17:	+0 -2 lines
Log Message:	works a tad better
#	Content
1	/*****************************************************************************/
2	/* CrossFire, A roguelike realtime multiplayer game */
3	/*****************************************************************************/
4
5	/*
6	* This code is placed under the GNU General Public Licence (GPL)
7	*
8	* Copyright (C) 2006 by Marc Lehmann <crossfire@schmorp.de>
9	*
10	* This program is free software; you can redistribute it and/or modify
11	* it under the terms of the GNU General Public License as published by
12	* the Free Software Foundation; either version 2 of the License, or
13	* (at your option) any later version.
14	*
15	* This program is distributed in the hope that it will be useful,
16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18	* GNU General Public License for more details.
19	*
20	* You should have received a copy of the GNU General Public License
21	* along with this program; if not, write to the Free Software
22	* Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23	*/
24
25	#include "global.h" // bug in cfperl.h, doesn't include interface_class stuff
26	#include "logger.h"
27	#include "cfperl.h"
28	#include "kw_hash.h"
29
30	object_freezer::object_freezer ()
31	: dynbuf_text (128 * 1024, 64 * 1024)
32	{
33	av = newAV ();
34	}
35
36	object_freezer::~object_freezer ()
37	{
38	SvREFCNT_dec (av);
39	}
40
41	void
42	object_freezer::put (attachable *ext)
43	{
44	ext->optimise ();
45
46	if (ext->self)
47	{
48	int idx = AvFILLp ((AV *)av) + 1;
49	av_store (av, idx, newRV_inc ((SV *)ext->self));
50
51	add ((void *)"oid ", 4);
52	add ((sint32)idx);
53	add ('\n');
54	}
55	}
56
57	bool
58	object_freezer::save (const char *path)
59	{
60	CALL_BEGIN (3);
61	CALL_ARG_SV (newSVpv (path, 0));
62	CALL_ARG_SV (newRV_noinc (newSVpvn ((char *)linearise (), size ())));
63	CALL_ARG_SV (newRV_inc ((SV *)av));
64	CALL_CALL ("cf::object_freezer_save", G_VOID \| G_DISCARD);
65	CALL_END;
66
67	return 1;
68	}
69
70	char *
71	object_freezer::as_string ()
72	{
73	CALL_BEGIN (2);
74	CALL_ARG_SV (newRV_noinc (newSVpvn ((char *)linearise (), size ())));
75	CALL_ARG_SV (newRV_inc ((SV *)av));
76	CALL_CALL ("cf::object_freezer_as_string", G_SCALAR);
77
78	char *res = count > 0
79	? strdup (SvPVX (POPs))
80	: strdup ("[fatal error]");
81
82	CALL_END;
83
84	return res;
85	}
86
87	void
88	fprintf (object_freezer &freezer, const char *format, ...)
89	{
90	va_list ap;
91
92	va_start (ap, format);
93
94	int len = vsnprintf ((char *)freezer.force (1024), 1024, format, ap);
95
96	if (len >= 0)
97	freezer.alloc (len);
98
99	va_end (ap);
100	}
101
102	// XXX: function not returning an int
103	void
104	fputs (const char *s, object_freezer &freezer)
105	{
106	freezer.add (s);
107	}
108
109	static const char thawer_eof[] = "\n\n\n\0\0\0";
110
111	object_thawer::object_thawer (const char *path)
112	: name (strdup (path))
113	{
114	static const char eof[] = "\n\n\n\0\0\0";
115
116	av = 0;
117	text = 0;
118	line = 0;
119	linenum = 0;
120
121	kw = KW_ERROR;
122	kw_str = 0;
123	value = 0;
124
125	if (path)
126	{
127	CALL_BEGIN (1);
128	CALL_ARG_SV (newSVpv (path, 0));
129	CALL_CALL ("cf::object_thawer_load", G_ARRAY);
130
131	if (count == 2)
132	{
133	// second value - perl objects
134	{
135	SV *sv = POPs;
136	if (SvROK (sv))
137	av = (AV *)SvREFCNT_inc (SvRV (sv));
138	}
139
140	// first value - text part, pad with 3 zeroes
141	{
142	SV *sv = POPs;
143	STRLEN len;
144	char *sv_ = SvPVbyte (sv, len);
145	text = newSV (len + sizeof (eof));
146	SvCUR_set (text, len);
147	memcpy (SvPVX (text), sv_, len);
148	memcpy (SvEND (text), eof, sizeof (eof)); // just to be sure
149
150	line = SvPVX (text);
151	}
152	}
153
154	CALL_END;
155	}
156	}
157
158	object_thawer::object_thawer (const char data, AV perlav)
159	: name (strdup ("(memory stream"))
160	{
161	av = perlav;
162	text = newSVpv (data, 0);
163	sv_catpv (text, thawer_eof);
164	line = SvPVbyte_nolen (text);
165	}
166
167	void
168	object_thawer::get (attachable *obj, int oid)
169	{
170	if (!av \|\| oid < 0) // this is actually an error of sorts
171	return;
172
173	SV *svp = av_fetch ((AV )av, oid, 0);
174
175	if (!svp \|\| !SvROK (*svp))
176	{
177	LOG (llevError, "trying to thaw duplicate or never-issued oid %d, ignoring.\n", oid);
178	return;
179	}
180
181	if (!SvROK (*svp))
182	{
183	LOG (llevError, "deserialised perl object is not an RV\n");
184	return;
185	}
186
187	HV hv = (HV )SvRV (*svp);
188
189	if (SvTYPE (hv) != SVt_PVHV)
190	{
191	LOG (llevError, "deserialised perl object is not a PVHV\n");
192	return;
193	}
194
195	if (obj->self)
196	{
197	// the hard way(?)
198
199	CALL_BEGIN (2);
200	CALL_ARG_SV (newRV_inc ((SV *)obj->self));
201	CALL_ARG_SV (newRV_inc ((SV *)hv));
202	PUTBACK;
203	call_method ("thawer_merge", G_DISCARD \| G_EVAL);
204	SPAGAIN;
205	CALL_END;
206	}
207	else
208	{
209	// the easy way(?)
210
211	obj->self = hv;
212	SvRV_set (*svp, &PL_sv_undef);
213
214	sv_magicext ((SV )obj->self, 0, PERL_MAGIC_ext, &attachable::vtbl, (char )obj, 0);
215	}
216
217	obj->reattach ();
218	}
219
220	object_thawer::~object_thawer ()
221	{
222	if (text) SvREFCNT_dec (text);
223	if (av) SvREFCNT_dec (av);
224
225	free ((void *)name);
226	}
227
228	//TODO: remove
229	char *
230	fgets (char *s, int n, object_thawer &thawer)
231	{
232	char *p = thawer.line;
233	char *q = s;
234
235	if (!p)
236	return 0;
237
238	while (--n)
239	{
240	if (!*p)
241	break;
242
243	q++ = p;
244
245	if (*p++ == '\n')
246	{
247	++thawer.linenum;
248	break;
249	}
250	}
251
252	*q = 0;
253	thawer.line = p;
254
255	return s == q ? 0 : s;
256	}
257
258	bool
259	object_thawer::parse_error (const char type, const char name, bool skip)
260	{
261	if (!type) type = "file section";
262	if (!name) name = "generic";
263
264	switch (kw)
265	{
266	case KW_EOF:
267	LOG (llevError, "%s:%d end of file while reading %s '%s', aborting load.\n",
268	this->name, linenum, type, name);
269	return false;
270
271	case KW_ERROR:
272	LOG (llevError, "%s:%d error while reading %s '%s', at '%s', aborting load.\n",
273	this->name, linenum,
274	type, name,
275	kw_str ? kw_str : "<file load>");
276	return false;
277
278	default:
279	LOG (llevError, "%s:%d unexpected line (%s %s) while reading %s '%s', %s.\n",
280	this->name, linenum,
281	kw_str ? kw_str : "<null>",
282	value ? value : "<null>",
283	type, name,
284	skip ? "skipping line" : "aborting load");
285	return skip;
286	}
287	}
288
289	void
290	object_thawer::next ()
291	{
292	if (!line)
293	{
294	kw = KW_ERROR;
295	return;
296	}
297
298	for (;;)
299	{
300	char *p = line;
301
302	if (*p <= ' ')
303	{
304	// skip whitespace (only some files need this)
305	while (p == ' ' \|\| p == '\t')
306	p++;
307
308	line = p;
309	}
310
311	if (!*p)
312	{
313	kw = KW_EOF;
314	break;
315	}
316
317	// parse keyword
318	while (*p > ' ')
319	p++;
320
321	int klen = p - line;
322
323	value = 0;
324
325	if (*p++ != '\n')
326	{
327	// parse value
328	while ((unsigned char )p <= ' ' && *p != '\n')
329	++p;
330
331	value = p;
332
333	while (*p != '\n')
334	p++;
335
336	*p++ = 0;
337	}
338
339	++linenum;
340	line [klen] = 0;
341	keyword_idx *kw_idx = kw_lex::match (line, klen);
342
343	kw_str = line;
344	line = p;
345
346	if (kw_idx)
347	{
348	kw = kw_idx->index;
349	break;
350	}
351	else if (!kw_str \|\| kw_str == '#')
352	; // empty/comment line
353	else
354	{
355	kw = KW_ERROR;
356	break;
357	}
358	}
359	}
360
361	void
362	object_thawer::skip ()
363	{
364	shstr ml;
365
366	switch (kw)
367	{
368	case KW_msg: get_ml (KW_endmsg , ml); break;
369	case KW_lore: get_ml (KW_endlore , ml); break;
370	case KW_maplore: get_ml (KW_endmaplore, ml); break;
371	default: break;
372	}
373
374	next ();
375	}
376
377	void
378	object_thawer::get (shstr &sh) const
379	{
380	if (value)
381	sh = value;
382	else
383	{
384	sh = "<value missing>";
385	LOG (llevError, "keyword \"%s\" requires value, substituting with <value missing>\n", kw_str);//TODO: add filename
386	}
387	}
388
389	void
390	object_thawer::get_ml (keyword kend, shstr &sh)
391	{
392	char kw[128];
393
394	int klen = keyword_len [kend];
395
396	kw [0] = '\n';
397	memcpy (kw + 1, keyword_str [kend], klen);
398	kw [klen + 1] = '\n';
399	kw [klen + 2] = 0;
400
401	++linenum;
402
403	// first test for completely empty msg... "endXXX\n"
404	if (!strncmp (line, kw + 1, klen + 1))
405	{
406	sh = 0;
407
408	line += klen + 1;
409
410	return;
411	}
412	else
413	{
414	// multi-line strings are delimited by "\nendXXX\n" or "endXXX\n" (NULL)
415
416	char *end = strstr (line, kw);
417
418	if (!end)
419	{
420	sh = 0;
421	return;
422	}
423
424	*end = 0;
425	sh = line;
426
427	// count line numbers
428	while (line < end)
429	linenum += *line++ == '\n';
430
431	line += keyword_len [kend];
432
433	while (*line++ != '\n')
434	;
435
436	++linenum;
437	}
438	}
439
440	sint32
441	object_thawer::get_sint32 () const
442	{
443	char *p = value;
444
445	if (!p)
446	return 0;
447
448	sint32 val = 0;
449	bool negate;
450
451	if (*p == '-')
452	{
453	negate = true;
454	++p;
455	}
456	else
457	negate = false;
458
459	do
460	{
461	val *= 10;
462	val += *p++ - '0';
463	}
464	while (*p);
465
466	return negate ? -val : val;
467	}
468
469	sint64
470	object_thawer::get_sint64 () const
471	{
472	return value ? atoll (value) : 0;
473	}
474
475	double
476	object_thawer::get_double () const
477	{
478	return value ? atof (value) : 0;
479	}
480