[ViewVC] Diff of: cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.90 by root, Sat Dec 16 04:22:13 2006 UTC vs.
Revision 1.109 by root, Sun Dec 31 22:23:12 2006 UTC

…		…
1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3;
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Digest::MD5;
		21	use Fcntl;
10	use IO::AIO ();	22	use IO::AIO 2.31 ();
11	use YAML::Syck ();	23	use YAML::Syck ();
12	use Time::HiRes;	24	use Time::HiRes;
13	use Event;	25
14	$Event::Eval = 1; # no idea why this is required, but it is	26	use Event; $Event::Eval = 1; # no idea why this is required, but it is
15		27
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	29	$YAML::Syck::ImplicitUnicode = 1;
18		30
19	use strict;	31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
20		32
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		34
23	our %COMMAND = ();	35	our %COMMAND = ();
24	our %COMMAND_TIME = ();	36	our %COMMAND_TIME = ();
25	our %EXTCMD = ();	37	our %EXTCMD = ();
26		38
27	_init_vars;
28
29	our @EVENT;	39	our @EVENT;
30	our $LIBDIR = datadir . "/ext";	40	our $LIBDIR = datadir . "/ext";
31		41
32	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
33	our $TICK_WATCHER;	43	our $TICK_WATCHER;
34	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
35		46
36	our %CFG;	47	our %CFG;
37		48
38	our $UPTIME; $UPTIME \|\|= time;	49	our $UPTIME; $UPTIME \|\|= time;
		50	our $RUNTIME;
		51
		52	our %MAP; # all maps
		53	our $LINK_MAP; # the special {link} map
		54	our $FREEZE;
		55	our $RANDOM_MAPS = cf::localdir . "/random";
		56	our %EXT_CORO;
		57
		58	binmode STDOUT;
		59	binmode STDERR;
		60
		61	# read virtual server time, if available
		62	unless ($RUNTIME \|\| !-e cf::localdir . "/runtime") {
		63	open my $fh, "<", cf::localdir . "/runtime"
		64	or die "unable to read runtime file: $!";
		65	$RUNTIME = <$fh> + 0.;
		66	}
		67
		68	mkdir cf::localdir;
		69	mkdir cf::localdir . "/" . cf::playerdir;
		70	mkdir cf::localdir . "/" . cf::tmpdir;
		71	mkdir cf::localdir . "/" . cf::uniquedir;
		72	mkdir $RANDOM_MAPS;
		73
		74	# a special map that is always available
		75	our $LINK_MAP;
39		76
40	#############################################################################	77	#############################################################################
41		78
42	=head2 GLOBAL VARIABLES	79	=head2 GLOBAL VARIABLES
43		80
44	=over 4	81	=over 4
45		82
46	=item $cf::UPTIME	83	=item $cf::UPTIME
47		84
48	The timestamp of the server start (so not actually an uptime).	85	The timestamp of the server start (so not actually an uptime).
		86
		87	=item $cf::RUNTIME
		88
		89	The time this server has run, starts at 0 and is increased by $cf::TICK on
		90	every server tick.
49		91
50	=item $cf::LIBDIR	92	=item $cf::LIBDIR
51		93
52	The perl library directory, where extensions and cf-specific modules can	94	The perl library directory, where extensions and cf-specific modules can
53	be found. It will be added to C<@INC> automatically.	95	be found. It will be added to C<@INC> automatically.
		96
		97	=item $cf::NOW
		98
		99	The time of the last (current) server tick.
54		100
55	=item $cf::TICK	101	=item $cf::TICK
56		102
57	The interval between server ticks, in seconds.	103	The interval between server ticks, in seconds.
58		104
66	=cut	112	=cut
67		113
68	BEGIN {	114	BEGIN {
69	*CORE::GLOBAL::warn = sub {	115	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	116	my $msg = join "", @_;
		117	utf8::encode $msg;
		118
71	$msg .= "\n"	119	$msg .= "\n"
72	unless $msg =~ /\n$/;	120	unless $msg =~ /\n$/;
73		121
74	print STDERR "cfperl: $msg";
75	LOG llevError, "cfperl: $msg";	122	LOG llevError, "cfperl: $msg";
76	};	123	};
77	}	124	}
78		125
		126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		130	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
79	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	131	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
80		132
81	# we bless all objects into (empty) derived classes to force a method lookup	133	# we bless all objects into (empty) derived classes to force a method lookup
82	# within the Safe compartment.	134	# within the Safe compartment.
83	for my $pkg (qw(	135	for my $pkg (qw(
		136	cf::global cf::attachable
84	cf::object cf::object::player	137	cf::object cf::object::player
85	cf::client cf::player	138	cf::client cf::player
86	cf::arch cf::living	139	cf::arch cf::living
87	cf::map cf::party cf::region	140	cf::map cf::party cf::region
88	)) {	141	)) {
…		…
126	sub to_json($) {	179	sub to_json($) {
127	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
128	JSON::Syck::Dump $_[0]	181	JSON::Syck::Dump $_[0]
129	}	182	}
130		183
		184	=item cf::sync_job { BLOCK }
		185
		186	The design of crossfire+ requires that the main coro ($Coro::main) is
		187	always able to handle events or runnable, as crossfire+ is only partly
		188	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		189
		190	If it must be done, put the blocking parts into C<sync_job>. This will run
		191	the given BLOCK in another coroutine while waiting for the result. The
		192	server will be frozen during this time, so the block should either finish
		193	fast or be very important.
		194
		195	=cut
		196
		197	sub sync_job(&) {
		198	my ($job) = @_;
		199
		200	my $busy = 1;
		201	my @res;
		202
		203	# TODO: use suspend/resume instead
		204	local $FREEZE = 1;
		205
		206	my $coro = Coro::async {
		207	@res = eval { $job->() };
		208	warn $@ if $@;
		209	undef $busy;
		210	};
		211
		212	if ($Coro::current == $Coro::main) {
		213	$coro->prio (Coro::PRIO_MAX);
		214	while ($busy) {
		215	Coro::cede_notself;
		216	Event::one_event unless Coro::nready;
		217	}
		218	} else {
		219	$coro->join;
		220	}
		221
		222	wantarray ? @res : $res[0]
		223	}
		224
		225	=item $coro = cf::coro { BLOCK }
		226
		227	Creates and returns a new coro. This coro is automcatially being canceled
		228	when the extension calling this is being unloaded.
		229
		230	=cut
		231
		232	sub coro(&) {
		233	my $cb = shift;
		234
		235	my $coro; $coro = async {
		236	eval {
		237	$cb->();
		238	};
		239	warn $@ if $@;
		240	};
		241
		242	$coro->on_destroy (sub {
		243	delete $EXT_CORO{$coro+0};
		244	});
		245	$EXT_CORO{$coro+0} = $coro;
		246
		247	$coro
		248	}
		249
		250	sub write_runtime {
		251	my $runtime = cf::localdir . "/runtime";
		252
		253	my $fh = aio_open "$runtime~", O_WRONLY \| O_CREAT, 0644
		254	or return;
		255
		256	my $value = $cf::RUNTIME;
		257	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		258	and return;
		259
		260	aio_fsync $fh
		261	and return;
		262
		263	close $fh
		264	or return;
		265
		266	aio_rename "$runtime~", $runtime
		267	and return;
		268
		269	1
		270	}
		271
131	=back	272	=back
132		273
133	=cut	274	=cut
134		275
135	#############################################################################	276	#############################################################################
136		277
137	=head2 EVENTS AND OBJECT ATTACHMENTS	278	package cf::path;
		279
		280	sub new {
		281	my ($class, $path, $base) = @_;
		282
		283	my $self = bless { }, $class;
		284
		285	if ($path =~ s{^\?random/}{}) {
		286	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		287	$self->{random} = cf::from_json $data;
		288	} else {
		289	if ($path =~ s{^~([^/]+)?}{}) {
		290	$self->{user_rel} = 1;
		291
		292	if (defined $1) {
		293	$self->{user} = $1;
		294	} elsif ($base =~ m{^~([^/]+)/}) {
		295	$self->{user} = $1;
		296	} else {
		297	warn "cannot resolve user-relative path without user <$path,$base>\n";
		298	}
		299	} elsif ($path =~ /^\//) {
		300	# already absolute
		301	} else {
		302	$base =~ s{[^/]+/?$}{};
		303	return $class->new ("$base/$path");
		304	}
		305
		306	for ($path) {
		307	redo if s{/\.?/}{/};
		308	redo if s{/[^/]+/\.\./}{/};
		309	}
		310	}
		311
		312	$self->{path} = $path;
		313
		314	$self
		315	}
		316
		317	# the name / primary key / in-game path
		318	sub as_string {
		319	my ($self) = @_;
		320
		321	$self->{user_rel} ? "~$self->{user}$self->{path}"
		322	: $self->{random} ? "?random/$self->{path}"
		323	: $self->{path}
		324	}
		325
		326	# the displayed name, this is a one way mapping
		327	sub visible_name {
		328	my ($self) = @_;
		329
		330	# if (my $rmp = $self->{random}) {
		331	# # todo: be more intelligent about this
		332	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		333	# } else {
		334	$self->as_string
		335	# }
		336	}
		337
		338	# escape the /'s in the path
		339	sub _escaped_path {
		340	# ∕ is U+2215
		341	(my $path = $_[0]{path}) =~ s/\//∕/g;
		342	$path
		343	}
		344
		345	# the original (read-only) location
		346	sub load_path {
		347	my ($self) = @_;
		348
		349	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		350	}
		351
		352	# the temporary/swap location
		353	sub save_path {
		354	my ($self) = @_;
		355
		356	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		357	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		358	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		359	}
		360
		361	# the unique path, might be eq to save_path
		362	sub uniq_path {
		363	my ($self) = @_;
		364
		365	$self->{user_rel} \|\| $self->{random}
		366	? undef
		367	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		368	}
		369
		370	# return random map parameters, or undef
		371	sub random_map_params {
		372	my ($self) = @_;
		373
		374	$self->{random}
		375	}
		376
		377	# this is somewhat ugly, but style maps do need special treatment
		378	sub is_style_map {
		379	$_[0]{path} =~ m{^/styles/}
		380	}
		381
		382	package cf;
		383
		384	#############################################################################
		385
		386	=head2 ATTACHABLE OBJECTS
		387
		388	Many objects in crossfire are so-called attachable objects. That means you can
		389	attach callbacks/event handlers (a collection of which is called an "attachment")
		390	to it. All such attachable objects support the following methods.
		391
		392	In the following description, CLASS can be any of C<global>, C<object>
		393	C<player>, C<client> or C<map> (i.e. the attachable objects in
		394	crossfire+).
138		395
139	=over 4	396	=over 4
140		397
141	=item $object->attach ($attachment, key => $value...)
142
143	=item $object->detach ($attachment)
144
145	Attach/detach a pre-registered attachment to an object.
146
147	=item $player->attach ($attachment, key => $value...)
148
149	=item $player->detach ($attachment)
150
151	Attach/detach a pre-registered attachment to a player.
152
153	=item $map->attach ($attachment, key => $value...)	398	=item $attachable->attach ($attachment, key => $value...)
154		399
155	=item $map->detach ($attachment)	400	=item $attachable->detach ($attachment)
156		401
157	Attach/detach a pre-registered attachment to a map.	402	Attach/detach a pre-registered attachment to a specific object and give it
		403	the specified key/value pairs as arguments.
158		404
159	=item $bool = $object->attached ($name)	405	Example, attach a minesweeper attachment to the given object, making it a
		406	10x10 minesweeper game:
160		407
161	=item $bool = $player->attached ($name)	408	$obj->attach (minesweeper => width => 10, height => 10);
162		409
163	=item $bool = $map->attached ($name)	410	=item $bool = $attachable->attached ($name)
164		411
165	Checks wether the named attachment is currently attached to the object.	412	Checks wether the named attachment is currently attached to the object.
166		413
167	=item cf::attach_global ...	414	=item cf::CLASS->attach ...
168		415
169	Attach handlers for global events.	416	=item cf::CLASS->detach ...
170		417
171	This and all following C<attach_*>-functions expect any number of the	418	Define an anonymous attachment and attach it to all objects of the given
172	following handler/hook descriptions:	419	CLASS. See the next function for an explanation of its arguments.
		420
		421	You can attach to global events by using the C<cf::global> class.
		422
		423	Example, log all player logins:
		424
		425	cf::player->attach (
		426	on_login => sub {
		427	my ($pl) = @_;
		428	...
		429	},
		430	);
		431
		432	Example, attach to the jeweler skill:
		433
		434	cf::object->attach (
		435	type => cf::SKILL,
		436	subtype => cf::SK_JEWELER,
		437	on_use_skill => sub {
		438	my ($sk, $ob, $part, $dir, $msg) = @_;
		439	...
		440	},
		441	);
		442
		443	=item cf::CLASS::attachment $name, ...
		444
		445	Register an attachment by C<$name> through which attachable objects of the
		446	given CLASS can refer to this attachment.
		447
		448	Some classes such as crossfire maps and objects can specify attachments
		449	that are attached at load/instantiate time, thus the need for a name.
		450
		451	These calls expect any number of the following handler/hook descriptions:
173		452
174	=over 4	453	=over 4
175		454
176	=item prio => $number	455	=item prio => $number
177		456
…		…
179	by another C<prio> setting). Lower priority handlers get executed	458	by another C<prio> setting). Lower priority handlers get executed
180	earlier. The default priority is C<0>, and many built-in handlers are	459	earlier. The default priority is C<0>, and many built-in handlers are
181	registered at priority C<-1000>, so lower priorities should not be used	460	registered at priority C<-1000>, so lower priorities should not be used
182	unless you know what you are doing.	461	unless you know what you are doing.
183		462
		463	=item type => $type
		464
		465	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		466	given type of objects only (the additional parameter C<subtype> can be
		467	used to further limit to the given subtype).
		468
184	=item on_I<event> => \&cb	469	=item on_I<event> => \&cb
185		470
186	Call the given code reference whenever the named event happens (event is	471	Call the given code reference whenever the named event happens (event is
187	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	472	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
188	handlers are recognised generally depends on the type of object these	473	handlers are recognised generally depends on the type of object these
…		…
197	package and register them. Only handlers for eevents supported by the	482	package and register them. Only handlers for eevents supported by the
198	object/class are recognised.	483	object/class are recognised.
199		484
200	=back	485	=back
201		486
202	=item cf::attach_to_type $object_type, $subtype, ...	487	Example, define an attachment called "sockpuppet" that calls the given
		488	event handler when a monster attacks:
203		489
204	Attach handlers for a specific object type (e.g. TRANSPORT) and	490	cf::object::attachment sockpuppet =>
205	subtype. If C<$subtype> is zero or undef, matches all objects of the given	491	on_skill_attack => sub {
206	type.	492	my ($self, $victim) = @_;
207		493	...
208	=item cf::attach_to_objects ...
209
210	Attach handlers to all objects. Do not use this except for debugging or
211	very rare events, as handlers are (obviously) called for I<all> objects in
212	the game.
213
214	=item cf::attach_to_players ...
215
216	Attach handlers to all players.
217
218	=item cf::attach_to_maps ...
219
220	Attach handlers to all maps.
221
222	=item cf:register_attachment $name, ...
223
224	Register an attachment by name through which objects can refer to this
225	attachment.
226
227	=item cf:register_player_attachment $name, ...
228
229	Register an attachment by name through which players can refer to this
230	attachment.
231
232	=item cf:register_map_attachment $name, ...
233
234	Register an attachment by name through which maps can refer to this
235	attachment.
236
237	=cut
238
239	# the following variables are defined in .xs and must not be re-created
240	our @CB_GLOBAL = (); # registry for all global events
241	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
242	our @CB_PLAYER = ();
243	our @CB_TYPE = (); # registry for type (cf-object class) based events
244	our @CB_MAP = ();
245
246	my %attachment;
247
248	sub _attach_cb($\%$$$) {
249	my ($registry, $undo, $event, $prio, $cb) = @_;
250
251	use sort 'stable';
252
253	$cb = [$prio, $cb];
254
255	@{$registry->[$event]} = sort
256	{ $a->[0] cmp $b->[0] }
257	@{$registry->[$event] \|\| []}, $cb;
258
259	push @{$undo->{cb}}, [$event, $cb];
260	}
261
262	# attach handles attaching event callbacks
263	# the only thing the caller has to do is pass the correct
264	# registry (== where the callback attaches to).
265	sub _attach(\@$@) {
266	my ($registry, $klass, @arg) = @_;
267
268	my $prio = 0;
269
270	my %undo = (
271	registry => $registry,
272	cb => [],
273	);
274
275	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
276
277	while (@arg) {
278	my $type = shift @arg;
279
280	if ($type eq "prio") {
281	$prio = shift @arg;
282
283	} elsif ($type eq "package") {
284	my $pkg = shift @arg;
285
286	while (my ($name, $id) = each %cb_id) {
287	if (my $cb = $pkg->can ($name)) {
288	_attach_cb $registry, %undo, $id, $prio, $cb;
289	}
290	}	494	}
291
292	} elsif (exists $cb_id{$type}) {
293	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
294
295	} elsif (ref $type) {
296	warn "attaching objects not supported, ignoring.\n";
297
298	} else {
299	shift @arg;
300	warn "attach argument '$type' not supported, ignoring.\n";
301	}
302	}
303
304	\%undo
305	}
306
307	sub _attach_attachment {
308	my ($obj, $name, %arg) = @_;
309
310	return if exists $obj->{_attachment}{$name};
311
312	my $res;
313
314	if (my $attach = $attachment{$name}) {
315	my $registry = $obj->registry;
316
317	for (@$attach) {
318	my ($klass, @attach) = @$_;
319	$res = _attach @$registry, $klass, @attach;
320	}
321
322	$obj->{$name} = \%arg;
323	} else {
324	warn "object uses attachment '$name' that is not available, postponing.\n";
325	}
326
327	$obj->{_attachment}{$name} = undef;
328
329	$res->{attachment} = $name;
330	$res
331	}
332
333	*cf::object::attach =
334	*cf::player::attach =
335	*cf::map::attach = sub {
336	my ($obj, $name, %arg) = @_;
337
338	_attach_attachment $obj, $name, %arg;
339	};
340
341	# all those should be optimised
342	*cf::object::detach =
343	*cf::player::detach =
344	*cf::map::detach = sub {
345	my ($obj, $name) = @_;
346
347	delete $obj->{_attachment}{$name};
348	reattach ($obj);
349	};
350
351	*cf::object::attached =
352	*cf::player::attached =
353	*cf::map::attached = sub {
354	my ($obj, $name) = @_;
355
356	exists $obj->{_attachment}{$name}
357	};
358
359	sub attach_global {
360	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
361	}
362
363	sub attach_to_type {
364	my $type = shift;
365	my $subtype = shift;
366
367	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
368	}
369
370	sub attach_to_objects {
371	_attach @CB_OBJECT, KLASS_OBJECT, @_
372	}
373
374	sub attach_to_players {
375	_attach @CB_PLAYER, KLASS_PLAYER, @_
376	}
377
378	sub attach_to_maps {
379	_attach @CB_MAP, KLASS_MAP, @_
380	}
381
382	sub register_attachment {
383	my $name = shift;
384
385	$attachment{$name} = [[KLASS_OBJECT, @_]];
386	}
387
388	sub register_player_attachment {
389	my $name = shift;
390
391	$attachment{$name} = [[KLASS_PLAYER, @_]];
392	}
393
394	sub register_map_attachment {
395	my $name = shift;
396
397	$attachment{$name} = [[KLASS_MAP, @_]];
398	}
399
400	our $override;
401	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
402
403	sub override {
404	$override = 1;
405	@invoke_results = ();
406	}
407
408	sub do_invoke {
409	my $event = shift;
410	my $callbacks = shift;
411
412	@invoke_results = ();
413
414	local $override;
415
416	for (@$callbacks) {
417	eval { &{$_->[1]} };
418
419	if ($@) {
420	warn "$@";
421	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
422	override;
423	}
424
425	return 1 if $override;
426	}
427
428	0	495	}
429	}
430		496
431	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	497	=item $attachable->valid
432
433	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
434
435	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
436
437	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
438
439	Generate a global/object/player/map-specific event with the given arguments.
440
441	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
442	removed in future versions), and there is no public API to access override
443	results (if you must, access C<@cf::invoke_results> directly).
444
445	=back
446
447	=cut
448
449	#############################################################################
450
451	=head2 METHODS VALID FOR ALL CORE OBJECTS
452
453	=over 4
454
455	=item $object->valid, $player->valid, $map->valid
456		498
457	Just because you have a perl object does not mean that the corresponding	499	Just because you have a perl object does not mean that the corresponding
458	C-level object still exists. If you try to access an object that has no	500	C-level object still exists. If you try to access an object that has no
459	valid C counterpart anymore you get an exception at runtime. This method	501	valid C counterpart anymore you get an exception at runtime. This method
460	can be used to test for existence of the C object part without causing an	502	can be used to test for existence of the C object part without causing an
461	exception.	503	exception.
462		504
		505	=cut
		506
		507	# the following variables are defined in .xs and must not be re-created
		508	our @CB_GLOBAL = (); # registry for all global events
		509	our @CB_ATTACHABLE = (); # registry for all attachables
		510	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		511	our @CB_PLAYER = ();
		512	our @CB_CLIENT = ();
		513	our @CB_TYPE = (); # registry for type (cf-object class) based events
		514	our @CB_MAP = ();
		515
		516	my %attachment;
		517
		518	sub _attach_cb($$$$) {
		519	my ($registry, $event, $prio, $cb) = @_;
		520
		521	use sort 'stable';
		522
		523	$cb = [$prio, $cb];
		524
		525	@{$registry->[$event]} = sort
		526	{ $a->[0] cmp $b->[0] }
		527	@{$registry->[$event] \|\| []}, $cb;
		528	}
		529
		530	# hack
		531	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		532
		533	# attach handles attaching event callbacks
		534	# the only thing the caller has to do is pass the correct
		535	# registry (== where the callback attaches to).
		536	sub _attach {
		537	my ($registry, $klass, @arg) = @_;
		538
		539	my $object_type;
		540	my $prio = 0;
		541	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		542
		543	#TODO: get rid of this hack
		544	if ($attachable_klass{$klass}) {
		545	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		546	}
		547
		548	while (@arg) {
		549	my $type = shift @arg;
		550
		551	if ($type eq "prio") {
		552	$prio = shift @arg;
		553
		554	} elsif ($type eq "type") {
		555	$object_type = shift @arg;
		556	$registry = $CB_TYPE[$object_type] \|\|= [];
		557
		558	} elsif ($type eq "subtype") {
		559	defined $object_type or Carp::croak "subtype specified without type";
		560	my $object_subtype = shift @arg;
		561	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] \|\|= [];
		562
		563	} elsif ($type eq "package") {
		564	my $pkg = shift @arg;
		565
		566	while (my ($name, $id) = each %cb_id) {
		567	if (my $cb = $pkg->can ($name)) {
		568	_attach_cb $registry, $id, $prio, $cb;
		569	}
		570	}
		571
		572	} elsif (exists $cb_id{$type}) {
		573	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		574
		575	} elsif (ref $type) {
		576	warn "attaching objects not supported, ignoring.\n";
		577
		578	} else {
		579	shift @arg;
		580	warn "attach argument '$type' not supported, ignoring.\n";
		581	}
		582	}
		583	}
		584
		585	sub _object_attach {
		586	my ($obj, $name, %arg) = @_;
		587
		588	return if exists $obj->{_attachment}{$name};
		589
		590	if (my $attach = $attachment{$name}) {
		591	my $registry = $obj->registry;
		592
		593	for (@$attach) {
		594	my ($klass, @attach) = @$_;
		595	_attach $registry, $klass, @attach;
		596	}
		597
		598	$obj->{$name} = \%arg;
		599	} else {
		600	warn "object uses attachment '$name' that is not available, postponing.\n";
		601	}
		602
		603	$obj->{_attachment}{$name} = undef;
		604	}
		605
		606	sub cf::attachable::attach {
		607	if (ref $_[0]) {
		608	_object_attach @_;
		609	} else {
		610	_attach shift->_attach_registry, @_;
		611	}
		612	};
		613
		614	# all those should be optimised
		615	sub cf::attachable::detach {
		616	my ($obj, $name) = @_;
		617
		618	if (ref $obj) {
		619	delete $obj->{_attachment}{$name};
		620	reattach ($obj);
		621	} else {
		622	Carp::croak "cannot, currently, detach class attachments";
		623	}
		624	};
		625
		626	sub cf::attachable::attached {
		627	my ($obj, $name) = @_;
		628
		629	exists $obj->{_attachment}{$name}
		630	}
		631
		632	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		633	eval "#line " . __LINE__ . " 'cf.pm'
		634	sub cf::\L$klass\E::_attach_registry {
		635	(\\\@CB_$klass, KLASS_$klass)
		636	}
		637
		638	sub cf::\L$klass\E::attachment {
		639	my \$name = shift;
		640
		641	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		642	}
		643	";
		644	die if $@;
		645	}
		646
		647	our $override;
		648	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		649
		650	sub override {
		651	$override = 1;
		652	@invoke_results = ();
		653	}
		654
		655	sub do_invoke {
		656	my $event = shift;
		657	my $callbacks = shift;
		658
		659	@invoke_results = ();
		660
		661	local $override;
		662
		663	for (@$callbacks) {
		664	eval { &{$_->[1]} };
		665
		666	if ($@) {
		667	warn "$@";
		668	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		669	override;
		670	}
		671
		672	return 1 if $override;
		673	}
		674
		675	0
		676	}
		677
		678	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		679
		680	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		681
		682	Generate an object-specific event with the given arguments.
		683
		684	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		685	removed in future versions), and there is no public API to access override
		686	results (if you must, access C<@cf::invoke_results> directly).
		687
463	=back	688	=back
464		689
465	=cut	690	=cut
466
467	*cf::object::valid =
468	*cf::player::valid =
469	*cf::map::valid = \&cf::_valid;
470		691
471	#############################################################################	692	#############################################################################
472	# object support	693	# object support
473		694
474	sub instantiate {
475	my ($obj, $data) = @_;
476
477	$data = from_json $data;
478
479	for (@$data) {
480	my ($name, $args) = @$_;
481
482	$obj->attach ($name, %{$args \|\| {} });
483	}
484	}
485
486	# basically do the same as instantiate, without calling instantiate
487	sub reattach {	695	sub reattach {
		696	# basically do the same as instantiate, without calling instantiate
488	my ($obj) = @_;	697	my ($obj) = @_;
		698
489	my $registry = $obj->registry;	699	my $registry = $obj->registry;
490		700
491	@$registry = ();	701	@$registry = ();
492		702
493	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };	703	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
494		704
495	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	705	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
496	if (my $attach = $attachment{$name}) {	706	if (my $attach = $attachment{$name}) {
497	for (@$attach) {	707	for (@$attach) {
498	my ($klass, @attach) = @$_;	708	my ($klass, @attach) = @$_;
499	_attach @$registry, $klass, @attach;	709	_attach $registry, $klass, @attach;
500	}	710	}
501	} else {	711	} else {
502	warn "object uses attachment '$name' that is not available, postponing.\n";	712	warn "object uses attachment '$name' that is not available, postponing.\n";
503	}	713	}
504	}	714	}
505	}	715	}
506		716
507	sub object_freezer_save {	717	cf::attachable->attach (
508	my ($filename, $rdata, $objs) = @_;
509
510	if (length $$rdata) {
511	warn sprintf "saving %s (%d,%d)\n",
512	$filename, length $$rdata, scalar @$objs;
513
514	if (open my $fh, ">:raw", "$filename~") {
515	chmod SAVE_MODE, $fh;
516	syswrite $fh, $$rdata;
517	close $fh;
518
519	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
520	chmod SAVE_MODE, $fh;
521	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
522	close $fh;
523	rename "$filename.pst~", "$filename.pst";
524	} else {
525	unlink "$filename.pst";
526	}
527
528	rename "$filename~", $filename;
529	} else {
530	warn "FATAL: $filename~: $!\n";
531	}
532	} else {
533	unlink $filename;
534	unlink "$filename.pst";
535	}
536	}
537
538	sub object_freezer_as_string {
539	my ($rdata, $objs) = @_;
540
541	use Data::Dumper;
542
543	$$rdata . Dumper $objs
544	}
545
546	sub object_thawer_load {
547	my ($filename) = @_;
548
549	local $/;
550
551	my $av;
552
553	#TODO: use sysread etc.
554	if (open my $data, "<:raw:perlio", $filename) {
555	$data = <$data>;
556	if (open my $pst, "<:raw:perlio", "$filename.pst") {
557	$av = eval { (Storable::thaw <$pst>)->{objs} };
558	}
559	return ($data, $av);
560	}
561
562	()
563	}
564
565	attach_to_objects
566	prio => -1000000,	718	prio => -1000000,
		719	on_instantiate => sub {
		720	my ($obj, $data) = @_;
		721
		722	$data = from_json $data;
		723
		724	for (@$data) {
		725	my ($name, $args) = @$_;
		726
		727	$obj->attach ($name, %{$args \|\| {} });
		728	}
		729	},
		730	on_reattach => \&reattach,
567	on_clone => sub {	731	on_clone => sub {
568	my ($src, $dst) = @_;	732	my ($src, $dst) = @_;
569		733
570	@{$dst->registry} = @{$src->registry};	734	@{$dst->registry} = @{$src->registry};
571		735
572	%$dst = %$src;	736	%$dst = %$src;
573		737
574	%{$dst->{_attachment}} = %{$src->{_attachment}}	738	%{$dst->{_attachment}} = %{$src->{_attachment}}
575	if exists $src->{_attachment};	739	if exists $src->{_attachment};
576	},	740	},
577	;	741	);
		742
		743	sub object_freezer_save {
		744	my ($filename, $rdata, $objs) = @_;
		745
		746	sync_job {
		747	if (length $$rdata) {
		748	warn sprintf "saving %s (%d,%d)\n",
		749	$filename, length $$rdata, scalar @$objs;
		750
		751	if (my $fh = aio_open "$filename~", O_WRONLY \| O_CREAT, 0600) {
		752	chmod SAVE_MODE, $fh;
		753	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		754	aio_fsync $fh;
		755	close $fh;
		756
		757	if (@$objs) {
		758	if (my $fh = aio_open "$filename.pst~", O_WRONLY \| O_CREAT, 0600) {
		759	chmod SAVE_MODE, $fh;
		760	my $data = Storable::nfreeze { version => 1, objs => $objs };
		761	aio_write $fh, 0, (length $data), $data, 0;
		762	aio_fsync $fh;
		763	close $fh;
		764	aio_rename "$filename.pst~", "$filename.pst";
		765	}
		766	} else {
		767	aio_unlink "$filename.pst";
		768	}
		769
		770	aio_rename "$filename~", $filename;
		771	} else {
		772	warn "FATAL: $filename~: $!\n";
		773	}
		774	} else {
		775	aio_unlink $filename;
		776	aio_unlink "$filename.pst";
		777	}
		778	}
		779	}
		780
		781	sub object_freezer_as_string {
		782	my ($rdata, $objs) = @_;
		783
		784	use Data::Dumper;
		785
		786	$$rdata . Dumper $objs
		787	}
		788
		789	sub object_thawer_load {
		790	my ($filename) = @_;
		791
		792	my ($data, $av);
		793
		794	(aio_load $filename, $data) >= 0
		795	or return;
		796
		797	unless (aio_stat "$filename.pst") {
		798	(aio_load "$filename.pst", $av) >= 0
		799	or return;
		800	$av = eval { (Storable::thaw <$av>)->{objs} };
		801	}
		802
		803	return ($data, $av);
		804	}
578		805
579	#############################################################################	806	#############################################################################
580	# command handling &c	807	# command handling &c
581		808
582	=item cf::register_command $name => \&callback($ob,$args);	809	=item cf::register_command $name => \&callback($ob,$args);
…		…
611	#warn "registering extcmd '$name' to '$caller'";	838	#warn "registering extcmd '$name' to '$caller'";
612		839
613	$EXTCMD{$name} = [$cb, $caller];	840	$EXTCMD{$name} = [$cb, $caller];
614	}	841	}
615		842
616	attach_to_players	843	cf::player->attach (
617	on_command => sub {	844	on_command => sub {
618	my ($pl, $name, $params) = @_;	845	my ($pl, $name, $params) = @_;
619		846
620	my $cb = $COMMAND{$name}	847	my $cb = $COMMAND{$name}
621	or return;	848	or return;
…		…
641	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
642	}	869	}
643		870
644	cf::override;	871	cf::override;
645	},	872	},
646	;	873	);
647		874
648	sub register {	875	sub register {
649	my ($base, $pkg) = @_;	876	my ($base, $pkg) = @_;
650		877
651	#TODO	878	#TODO
…		…
741	defined $path or return;	968	defined $path or return;
742		969
743	unlink "$path.pst";	970	unlink "$path.pst";
744	};	971	};
745		972
746	attach_to_maps prio => -10000, package => cf::mapsupport::;	973	cf::map->attach (prio => -10000, package => cf::mapsupport::);
747		974
748	#############################################################################	975	#############################################################################
749	# load/save perl data associated with player->ob objects	976	# load/save perl data associated with player->ob objects
750		977
751	sub all_objects(@) {	978	sub all_objects(@) {
752	@_, map all_objects ($_->inv), @_	979	@_, map all_objects ($_->inv), @_
753	}	980	}
754		981
755	# TODO: compatibility cruft, remove when no longer needed	982	# TODO: compatibility cruft, remove when no longer needed
756	attach_to_players	983	cf::player->attach (
757	on_load => sub {	984	on_load => sub {
758	my ($pl, $path) = @_;	985	my ($pl, $path) = @_;
759		986
760	for my $o (all_objects $pl->ob) {	987	for my $o (all_objects $pl->ob) {
761	if (my $value = $o->get_ob_key_value ("_perl_data")) {	988	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
763		990
764	%$o = %{ Storable::thaw pack "H*", $value };	991	%$o = %{ Storable::thaw pack "H*", $value };
765	}	992	}
766	}	993	}
767	},	994	},
768	;	995	);
769		996
770	#############################################################################	997	#############################################################################
771		998
772	=head2 CORE EXTENSIONS	999	=head2 CORE EXTENSIONS
773		1000
774	Functions and methods that extend core crossfire objects.	1001	Functions and methods that extend core crossfire objects.
		1002
		1003	=head3 cf::player
775		1004
776	=over 4	1005	=over 4
777		1006
778	=item cf::player::exists $login	1007	=item cf::player::exists $login
779		1008
…		…
784	sub cf::player::exists($) {	1013	sub cf::player::exists($) {
785	cf::player::find $_[0]	1014	cf::player::find $_[0]
786	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1015	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
787	}	1016	}
788		1017
		1018	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1019
		1020	Sends an ext reply to the player.
		1021
		1022	=cut
		1023
		1024	sub cf::player::ext_reply($$$%) {
		1025	my ($self, $id, %msg) = @_;
		1026
		1027	$msg{msgid} = $id;
		1028
		1029	$self->send ("ext " . to_json \%msg);
		1030	}
		1031
		1032	=back
		1033
		1034	=head3 cf::object::player
		1035
		1036	=over 4
		1037
789	=item $player_object->reply ($npc, $msg[, $flags])	1038	=item $player_object->reply ($npc, $msg[, $flags])
790		1039
791	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1040	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
792	can be C<undef>. Does the right thing when the player is currently in a	1041	can be C<undef>. Does the right thing when the player is currently in a
793	dialogue with the given NPC character.	1042	dialogue with the given NPC character.
794		1043
795	=cut	1044	=cut
796		1045
797	# rough implementation of a future "reply" method that works	1046	# rough implementation of a future "reply" method that works
798	# with dialog boxes.	1047	# with dialog boxes.
		1048	#TODO: the first argument must go, split into a $npc->reply_to ( method
799	sub cf::object::player::reply($$$;$) {	1049	sub cf::object::player::reply($$$;$) {
800	my ($self, $npc, $msg, $flags) = @_;	1050	my ($self, $npc, $msg, $flags) = @_;
801		1051
802	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	1052	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
803		1053
…		…
807	$msg = $npc->name . " says: $msg" if $npc;	1057	$msg = $npc->name . " says: $msg" if $npc;
808	$self->message ($msg, $flags);	1058	$self->message ($msg, $flags);
809	}	1059	}
810	}	1060	}
811		1061
812	=item $player->ext_reply ($msgid, $msgtype, %msg)
813
814	Sends an ext reply to the player.
815
816	=cut
817
818	sub cf::player::ext_reply($$$%) {
819	my ($self, $id, %msg) = @_;
820
821	$msg{msgid} = $id;
822
823	$self->send ("ext " . to_json \%msg);
824	}
825
826	=item $player_object->may ("access")	1062	=item $player_object->may ("access")
827		1063
828	Returns wether the given player is authorized to access resource "access"	1064	Returns wether the given player is authorized to access resource "access"
829	(e.g. "command_wizcast").	1065	(e.g. "command_wizcast").
830		1066
…		…
837	(ref $cf::CFG{"may_$access"}	1073	(ref $cf::CFG{"may_$access"}
838	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1074	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839	: $cf::CFG{"may_$access"})	1075	: $cf::CFG{"may_$access"})
840	}	1076	}
841		1077
842	=cut	1078	=head3 cf::client
843		1079
844	#############################################################################	1080	=over 4
		1081
		1082	=item $client->send_drawinfo ($text, $flags)
		1083
		1084	Sends a drawinfo packet to the client. Circumvents output buffering so
		1085	should not be used under normal circumstances.
		1086
		1087	=cut
		1088
		1089	sub cf::client::send_drawinfo {
		1090	my ($self, $text, $flags) = @_;
		1091
		1092	utf8::encode $text;
		1093	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1094	}
		1095
		1096
		1097	=item $success = $client->query ($flags, "text", \&cb)
		1098
		1099	Queues a query to the client, calling the given callback with
		1100	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1101	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1102
		1103	Queries can fail, so check the return code. Or don't, as queries will become
		1104	reliable at some point in the future.
		1105
		1106	=cut
		1107
		1108	sub cf::client::query {
		1109	my ($self, $flags, $text, $cb) = @_;
		1110
		1111	return unless $self->state == ST_PLAYING
		1112	\|\| $self->state == ST_SETUP
		1113	\|\| $self->state == ST_CUSTOM;
		1114
		1115	$self->state (ST_CUSTOM);
		1116
		1117	utf8::encode $text;
		1118	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1119
		1120	$self->send_packet ($self->{query_queue}[0][0])
		1121	if @{ $self->{query_queue} } == 1;
		1122	}
		1123
		1124	cf::client->attach (
		1125	on_reply => sub {
		1126	my ($ns, $msg) = @_;
		1127
		1128	# this weird shuffling is so that direct followup queries
		1129	# get handled first
		1130	my $queue = delete $ns->{query_queue};
		1131
		1132	(shift @$queue)->[1]->($msg);
		1133
		1134	push @{ $ns->{query_queue} }, @$queue;
		1135
		1136	if (@{ $ns->{query_queue} } == @$queue) {
		1137	if (@$queue) {
		1138	$ns->send_packet ($ns->{query_queue}[0][0]);
		1139	} else {
		1140	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1141	}
		1142	}
		1143	},
		1144	);
		1145
		1146	=item $client->coro (\&cb)
		1147
		1148	Create a new coroutine, running the specified callback. The coroutine will
		1149	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1150	or loss of connection).
		1151
		1152	=cut
		1153
		1154	sub cf::client::coro {
		1155	my ($self, $cb) = @_;
		1156
		1157	my $coro; $coro = async {
		1158	eval {
		1159	$cb->();
		1160	};
		1161	warn $@ if $@;
		1162	};
		1163
		1164	$coro->on_destroy (sub {
		1165	delete $self->{_coro}{$coro+0};
		1166	});
		1167
		1168	$self->{_coro}{$coro+0} = $coro;
		1169
		1170	$coro
		1171	}
		1172
		1173	cf::client->attach (
		1174	on_destroy => sub {
		1175	my ($ns) = @_;
		1176
		1177	$_->cancel for values %{ (delete $ns->{_coro}) \|\| {} };
		1178	},
		1179	);
		1180
		1181	=back
		1182
845		1183
846	=head2 SAFE SCRIPTING	1184	=head2 SAFE SCRIPTING
847		1185
848	Functions that provide a safe environment to compile and execute	1186	Functions that provide a safe environment to compile and execute
849	snippets of perl code without them endangering the safety of the server	1187	snippets of perl code without them endangering the safety of the server
…		…
864		1202
865	=pod	1203	=pod
866		1204
867	The following fucntions and emthods are available within a safe environment:	1205	The following fucntions and emthods are available within a safe environment:
868		1206
869	cf::object contr pay_amount pay_player	1207	cf::object contr pay_amount pay_player map
870	cf::object::player player	1208	cf::object::player player
871	cf::player peaceful	1209	cf::player peaceful
		1210	cf::map trigger
872		1211
873	=cut	1212	=cut
874		1213
875	for (	1214	for (
876	["cf::object" => qw(contr pay_amount pay_player)],	1215	["cf::object" => qw(contr pay_amount pay_player map)],
877	["cf::object::player" => qw(player)],	1216	["cf::object::player" => qw(player)],
878	["cf::player" => qw(peaceful)],	1217	["cf::player" => qw(peaceful)],
		1218	["cf::map" => qw(trigger)],
879	) {	1219	) {
880	no strict 'refs';	1220	no strict 'refs';
881	my ($pkg, @funs) = @$_;	1221	my ($pkg, @funs) = @$_;
882	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1222	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883	for @funs;	1223	for @funs;
…		…
1047	$DB->{$_[0]} = $_[1];	1387	$DB->{$_[0]} = $_[1];
1048	}	1388	}
1049	db_dirty;	1389	db_dirty;
1050	}	1390	}
1051		1391
1052	attach_global	1392	cf::global->attach (
1053	prio => 10000,	1393	prio => 10000,
1054	on_cleanup => sub {	1394	on_cleanup => sub {
1055	db_sync;	1395	db_sync;
1056	},	1396	},
1057	;	1397	);
1058	}	1398	}
1059		1399
1060	#############################################################################	1400	#############################################################################
1061	# the server's main()	1401	# the server's main()
1062		1402
…		…
1067	local $/;	1407	local $/;
1068	*CFG = YAML::Syck::Load <$fh>;	1408	*CFG = YAML::Syck::Load <$fh>;
1069	}	1409	}
1070		1410
1071	sub main {	1411	sub main {
		1412	# we must not ever block the main coroutine
		1413	local $Coro::idle = sub {
		1414	Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1415	(Coro::unblock_sub {
		1416	Event::one_event;
		1417	})->();
		1418	};
		1419
1072	cfg_load;	1420	cfg_load;
1073	db_load;	1421	db_load;
1074	load_extensions;	1422	load_extensions;
1075	Event::loop;	1423	Event::loop;
1076	}	1424	}
1077		1425
1078	#############################################################################	1426	#############################################################################
1079	# initialisation	1427	# initialisation
1080		1428
1081	sub _perl_reload(&) {	1429	sub perl_reload() {
1082	my ($msg) = @_;	1430	# can/must only be called in main
		1431	if ($Coro::current != $Coro::main) {
		1432	warn "can only reload from main coroutine\n";
		1433	return;
		1434	}
1083		1435
1084	$msg->("reloading...");	1436	warn "reloading...";
		1437
		1438	local $FREEZE = 1;
		1439	cf::emergency_save;
1085		1440
1086	eval {	1441	eval {
		1442	# if anything goes wrong in here, we should simply crash as we already saved
		1443
1087	# cancel all watchers	1444	# cancel all watchers
1088	for (Event::all_watchers) {	1445	for (Event::all_watchers) {
1089	$_->cancel if $_->data & WF_AUTOCANCEL;	1446	$_->cancel if $_->data & WF_AUTOCANCEL;
1090	}	1447	}
1091		1448
		1449	# cancel all extension coros
		1450	$_->cancel for values %EXT_CORO;
		1451	%EXT_CORO = ();
		1452
1092	# unload all extensions	1453	# unload all extensions
1093	for (@exts) {	1454	for (@exts) {
1094	$msg->("unloading <$_>");	1455	warn "unloading <$_>";
1095	unload_extension $_;	1456	unload_extension $_;
1096	}	1457	}
1097		1458
1098	# unload all modules loaded from $LIBDIR	1459	# unload all modules loaded from $LIBDIR
1099	while (my ($k, $v) = each %INC) {	1460	while (my ($k, $v) = each %INC) {
1100	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1461	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101		1462
1102	$msg->("removing <$k>");	1463	warn "removing <$k>";
1103	delete $INC{$k};	1464	delete $INC{$k};
1104		1465
1105	$k =~ s/\.pm$//;	1466	$k =~ s/\.pm$//;
1106	$k =~ s/\//::/g;	1467	$k =~ s/\//::/g;
1107		1468
…		…
1112	Symbol::delete_package $k;	1473	Symbol::delete_package $k;
1113	}	1474	}
1114		1475
1115	# sync database to disk	1476	# sync database to disk
1116	cf::db_sync;	1477	cf::db_sync;
		1478	IO::AIO::flush;
1117		1479
1118	# get rid of safe::, as good as possible	1480	# get rid of safe::, as good as possible
1119	Symbol::delete_package "safe::$_"	1481	Symbol::delete_package "safe::$_"
1120	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	1482	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1121		1483
1122	# remove register_script_function callbacks	1484	# remove register_script_function callbacks
1123	# TODO	1485	# TODO
1124		1486
1125	# unload cf.pm "a bit"	1487	# unload cf.pm "a bit"
…		…
1128	# don't, removes xs symbols, too,	1490	# don't, removes xs symbols, too,
1129	# and global variables created in xs	1491	# and global variables created in xs
1130	#Symbol::delete_package __PACKAGE__;	1492	#Symbol::delete_package __PACKAGE__;
1131		1493
1132	# reload cf.pm	1494	# reload cf.pm
1133	$msg->("reloading cf.pm");	1495	warn "reloading cf.pm";
1134	require cf;	1496	require cf;
		1497	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1135		1498
1136	# load config and database again	1499	# load config and database again
1137	cf::cfg_load;	1500	cf::cfg_load;
1138	cf::db_load;	1501	cf::db_load;
1139		1502
1140	# load extensions	1503	# load extensions
1141	$msg->("load extensions");	1504	warn "load extensions";
1142	cf::load_extensions;	1505	cf::load_extensions;
1143		1506
1144	# reattach attachments to objects	1507	# reattach attachments to objects
1145	$msg->("reattach");	1508	warn "reattach";
1146	_global_reattach;	1509	_global_reattach;
1147	};	1510	};
1148	$msg->($@) if $@;
1149		1511
1150	$msg->("reloaded");	1512	if ($@) {
		1513	warn $@;
		1514	warn "error while reloading, exiting.";
		1515	exit 1;
		1516	}
		1517
		1518	warn "reloaded successfully";
1151	};	1519	};
1152		1520
1153	sub perl_reload() {	1521	#############################################################################
1154	_perl_reload {	1522
1155	warn $_[0];	1523	unless ($LINK_MAP) {
1156	print "$_[0]\n";	1524	$LINK_MAP = cf::map::new;
1157	};	1525
		1526	$LINK_MAP->width (41);
		1527	$LINK_MAP->height (41);
		1528	$LINK_MAP->alloc;
		1529	$LINK_MAP->path ("{link}");
		1530	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		1531	$LINK_MAP->in_memory (MAP_IN_MEMORY);
1158	}	1532	}
1159		1533
1160	register "<global>", __PACKAGE__;	1534	register "<global>", __PACKAGE__;
1161		1535
1162	register_command "perl-reload" => sub {	1536	register_command "perl-reload" => sub {
1163	my ($who, $arg) = @_;	1537	my ($who, $arg) = @_;
1164		1538
1165	if ($who->flag (FLAG_WIZ)) {	1539	if ($who->flag (FLAG_WIZ)) {
		1540	$who->message ("start of reload.");
1166	_perl_reload {	1541	perl_reload;
1167	warn $_[0];	1542	$who->message ("end of reload.");
1168	$who->message ($_[0]);
1169	};
1170	}	1543	}
1171	};	1544	};
1172		1545
1173	unshift @INC, $LIBDIR;	1546	unshift @INC, $LIBDIR;
1174		1547
1175	$TICK_WATCHER = Event->timer (	1548	$TICK_WATCHER = Event->timer (
		1549	reentrant => 0,
1176	prio => 0,	1550	prio => 0,
1177	at => $NEXT_TICK \|\| 1,	1551	at => $NEXT_TICK \|\| $TICK,
1178	data => WF_AUTOCANCEL,	1552	data => WF_AUTOCANCEL,
1179	cb => sub {	1553	cb => sub {
		1554	unless ($FREEZE) {
1180	cf::server_tick; # one server iteration	1555	cf::server_tick; # one server iteration
		1556	$RUNTIME += $TICK;
		1557	}
1181		1558
1182	my $NOW = Event::time;
1183	$NEXT_TICK += $TICK;	1559	$NEXT_TICK += $TICK;
1184		1560
1185	# if we are delayed by four ticks or more, skip them all	1561	# if we are delayed by four ticks or more, skip them all
1186	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1562	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1187		1563
1188	$TICK_WATCHER->at ($NEXT_TICK);	1564	$TICK_WATCHER->at ($NEXT_TICK);
1189	$TICK_WATCHER->start;	1565	$TICK_WATCHER->start;
1190	},	1566	},
1191	);	1567	);
1192		1568
1193	IO::AIO::max_poll_time $TICK * 0.2;	1569	IO::AIO::max_poll_time $TICK * 0.2;
1194		1570
		1571	Event->io (
1195	Event->io (fd => IO::AIO::poll_fileno,	1572	fd => IO::AIO::poll_fileno,
1196	poll => 'r',	1573	poll => 'r',
1197	prio => 5,	1574	prio => 5,
1198	data => WF_AUTOCANCEL,	1575	data => WF_AUTOCANCEL,
1199	cb => \&IO::AIO::poll_cb);	1576	cb => \&IO::AIO::poll_cb,
		1577	);
		1578
		1579	Event->timer (
		1580	data => WF_AUTOCANCEL,
		1581	after => 0,
		1582	interval => 10,
		1583	cb => sub {
		1584	(Coro::unblock_sub {
		1585	write_runtime
		1586	or warn "ERROR: unable to write runtime file: $!";
		1587	})->();
		1588	},
		1589	);
1200		1590
1201	1	1591	1
1202		1592

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.90 by root, Sat Dec 16 04:22:13 2006 UTC vs. Revision 1.109 by root, Sun Dec 31 22:23:12 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.90 by root, Sat Dec 16 04:22:13 2006 UTC vs.
Revision 1.109 by root, Sun Dec 31 22:23:12 2006 UTC