[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.104 by root, Sat Dec 30 16:56:16 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
10	use IO::AIO ();	19	use IO::AIO 2.3;
11	use YAML::Syck ();	20	use YAML::Syck ();
12	use Time::HiRes;	21	use Time::HiRes;
13	use Event;	22
14	$Event::Eval = 1; # no idea why this is required, but it is	23	use Event; $Event::Eval = 1; # no idea why this is required, but it is
15		24
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	25	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	26	$YAML::Syck::ImplicitUnicode = 1;
18		27
19	use strict;	28	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
20		29
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		31
23	our %COMMAND = ();	32	our %COMMAND = ();
24	our %COMMAND_TIME = ();	33	our %COMMAND_TIME = ();
25	our %EXTCMD = ();	34	our %EXTCMD = ();
26		35
27	_init_vars;
28
29	our @EVENT;	36	our @EVENT;
30	our $LIBDIR = datadir . "/ext";	37	our $LIBDIR = datadir . "/ext";
31		38
32	our $TICK = MAX_TIME * 1e-6;	39	our $TICK = MAX_TIME * 1e-6;
33	our $TICK_WATCHER;	40	our $TICK_WATCHER;
34	our $NEXT_TICK;	41	our $NEXT_TICK;
		42	our $NOW;
35		43
36	our %CFG;	44	our %CFG;
37		45
38	our $UPTIME; $UPTIME \|\|= time;	46	our $UPTIME; $UPTIME \|\|= time;
		47	our $RUNTIME;
		48
		49	our %MAP; # all maps
		50	our $LINK_MAP; # the special {link} map
		51	our $FREEZE;
		52
		53	binmode STDOUT;
		54	binmode STDERR;
		55
		56	# read virtual server time, if available
		57	unless ($RUNTIME \|\| !-e cf::localdir . "/runtime") {
		58	open my $fh, "<", cf::localdir . "/runtime"
		59	or die "unable to read runtime file: $!";
		60	$RUNTIME = <$fh> + 0.;
		61	}
		62
		63	mkdir cf::localdir;
		64	mkdir cf::localdir . "/" . cf::playerdir;
		65	mkdir cf::localdir . "/" . cf::tmpdir;
		66	mkdir cf::localdir . "/" . cf::uniquedir;
		67
		68	our %EXT_CORO;
39		69
40	#############################################################################	70	#############################################################################
41		71
42	=head2 GLOBAL VARIABLES	72	=head2 GLOBAL VARIABLES
43		73
44	=over 4	74	=over 4
45		75
46	=item $cf::UPTIME	76	=item $cf::UPTIME
47		77
48	The timestamp of the server start (so not actually an uptime).	78	The timestamp of the server start (so not actually an uptime).
		79
		80	=item $cf::RUNTIME
		81
		82	The time this server has run, starts at 0 and is increased by $cf::TICK on
		83	every server tick.
49		84
50	=item $cf::LIBDIR	85	=item $cf::LIBDIR
51		86
52	The perl library directory, where extensions and cf-specific modules can	87	The perl library directory, where extensions and cf-specific modules can
53	be found. It will be added to C<@INC> automatically.	88	be found. It will be added to C<@INC> automatically.
		89
		90	=item $cf::NOW
		91
		92	The time of the last (current) server tick.
54		93
55	=item $cf::TICK	94	=item $cf::TICK
56		95
57	The interval between server ticks, in seconds.	96	The interval between server ticks, in seconds.
58		97
66	=cut	105	=cut
67		106
68	BEGIN {	107	BEGIN {
69	*CORE::GLOBAL::warn = sub {	108	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	109	my $msg = join "", @_;
		110	utf8::encode $msg;
		111
71	$msg .= "\n"	112	$msg .= "\n"
72	unless $msg =~ /\n$/;	113	unless $msg =~ /\n$/;
73		114
74	print STDERR "cfperl: $msg";
75	LOG llevError, "cfperl: $msg";	115	LOG llevError, "cfperl: $msg";
76	};	116	};
77	}	117	}
78		118
		119	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		120	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		121	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		122	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		123	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
79	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	124	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
80		125
81	# we bless all objects into (empty) derived classes to force a method lookup	126	# we bless all objects into (empty) derived classes to force a method lookup
82	# within the Safe compartment.	127	# within the Safe compartment.
83	for my $pkg (qw(	128	for my $pkg (qw(
		129	cf::global cf::attachable
84	cf::object cf::object::player	130	cf::object cf::object::player
85	cf::client cf::player	131	cf::client cf::player
86	cf::arch cf::living	132	cf::arch cf::living
87	cf::map cf::party cf::region	133	cf::map cf::party cf::region
88	)) {	134	)) {
…		…
126	sub to_json($) {	172	sub to_json($) {
127	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	173	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
128	JSON::Syck::Dump $_[0]	174	JSON::Syck::Dump $_[0]
129	}	175	}
130		176
		177	=item $coro = cf::coro { BLOCK }
		178
		179	Creates and returns a new coro. This coro is automcatially being canceled
		180	when the extension calling this is being unloaded.
		181
		182	=cut
		183
		184	sub coro(&) {
		185	my $cb = shift;
		186
		187	my $coro; $coro = async {
		188	eval {
		189	$cb->();
		190	};
		191	warn $@ if $@;
		192	};
		193
		194	$coro->on_destroy (sub {
		195	delete $EXT_CORO{$coro+0};
		196	});
		197	$EXT_CORO{$coro+0} = $coro;
		198
		199	$coro
		200	}
		201
131	=back	202	=back
132		203
133	=cut	204	=cut
134		205
135	#############################################################################	206	#############################################################################
136		207
137	=head2 EVENTS AND OBJECT ATTACHMENTS	208	=head2 ATTACHABLE OBJECTS
		209
		210	Many objects in crossfire are so-called attachable objects. That means you can
		211	attach callbacks/event handlers (a collection of which is called an "attachment")
		212	to it. All such attachable objects support the following methods.
		213
		214	In the following description, CLASS can be any of C<global>, C<object>
		215	C<player>, C<client> or C<map> (i.e. the attachable objects in
		216	crossfire+).
138		217
139	=over 4	218	=over 4
140		219
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...)	220	=item $attachable->attach ($attachment, key => $value...)
154		221
155	=item $map->detach ($attachment)	222	=item $attachable->detach ($attachment)
156		223
157	Attach/detach a pre-registered attachment to a map.	224	Attach/detach a pre-registered attachment to a specific object and give it
		225	the specified key/value pairs as arguments.
158		226
159	=item $bool = $object->attached ($name)	227	Example, attach a minesweeper attachment to the given object, making it a
		228	10x10 minesweeper game:
160		229
161	=item $bool = $player->attached ($name)	230	$obj->attach (minesweeper => width => 10, height => 10);
162		231
163	=item $bool = $map->attached ($name)	232	=item $bool = $attachable->attached ($name)
164		233
165	Checks wether the named attachment is currently attached to the object.	234	Checks wether the named attachment is currently attached to the object.
166		235
167	=item cf::attach_global ...	236	=item cf::CLASS->attach ...
168		237
169	Attach handlers for global events.	238	=item cf::CLASS->detach ...
170		239
171	This and all following C<attach_*>-functions expect any number of the	240	Define an anonymous attachment and attach it to all objects of the given
172	following handler/hook descriptions:	241	CLASS. See the next function for an explanation of its arguments.
		242
		243	You can attach to global events by using the C<cf::global> class.
		244
		245	Example, log all player logins:
		246
		247	cf::player->attach (
		248	on_login => sub {
		249	my ($pl) = @_;
		250	...
		251	},
		252	);
		253
		254	Example, attach to the jeweler skill:
		255
		256	cf::object->attach (
		257	type => cf::SKILL,
		258	subtype => cf::SK_JEWELER,
		259	on_use_skill => sub {
		260	my ($sk, $ob, $part, $dir, $msg) = @_;
		261	...
		262	},
		263	);
		264
		265	=item cf::CLASS::attachment $name, ...
		266
		267	Register an attachment by C<$name> through which attachable objects of the
		268	given CLASS can refer to this attachment.
		269
		270	Some classes such as crossfire maps and objects can specify attachments
		271	that are attached at load/instantiate time, thus the need for a name.
		272
		273	These calls expect any number of the following handler/hook descriptions:
173		274
174	=over 4	275	=over 4
175		276
176	=item prio => $number	277	=item prio => $number
177		278
…		…
179	by another C<prio> setting). Lower priority handlers get executed	280	by another C<prio> setting). Lower priority handlers get executed
180	earlier. The default priority is C<0>, and many built-in handlers are	281	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	282	registered at priority C<-1000>, so lower priorities should not be used
182	unless you know what you are doing.	283	unless you know what you are doing.
183		284
		285	=item type => $type
		286
		287	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		288	given type of objects only (the additional parameter C<subtype> can be
		289	used to further limit to the given subtype).
		290
184	=item on_I<event> => \&cb	291	=item on_I<event> => \&cb
185		292
186	Call the given code reference whenever the named event happens (event is	293	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	294	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	295	handlers are recognised generally depends on the type of object these
…		…
197	package and register them. Only handlers for eevents supported by the	304	package and register them. Only handlers for eevents supported by the
198	object/class are recognised.	305	object/class are recognised.
199		306
200	=back	307	=back
201		308
202	=item cf::attach_to_type $object_type, $subtype, ...	309	Example, define an attachment called "sockpuppet" that calls the given
		310	event handler when a monster attacks:
203		311
204	Attach handlers for a specific object type (e.g. TRANSPORT) and	312	cf::object::attachment sockpuppet =>
205	subtype. If C<$subtype> is zero or undef, matches all objects of the given	313	on_skill_attack => sub {
206	type.	314	my ($self, $victim) = @_;
207		315	...
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	}	316	}
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	317	}
429	}
430		318
431	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	319	=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		320
457	Just because you have a perl object does not mean that the corresponding	321	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	322	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	323	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	324	can be used to test for existence of the C object part without causing an
461	exception.	325	exception.
462		326
		327	=cut
		328
		329	# the following variables are defined in .xs and must not be re-created
		330	our @CB_GLOBAL = (); # registry for all global events
		331	our @CB_ATTACHABLE = (); # registry for all attachables
		332	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		333	our @CB_PLAYER = ();
		334	our @CB_CLIENT = ();
		335	our @CB_TYPE = (); # registry for type (cf-object class) based events
		336	our @CB_MAP = ();
		337
		338	my %attachment;
		339
		340	sub _attach_cb($$$$) {
		341	my ($registry, $event, $prio, $cb) = @_;
		342
		343	use sort 'stable';
		344
		345	$cb = [$prio, $cb];
		346
		347	@{$registry->[$event]} = sort
		348	{ $a->[0] cmp $b->[0] }
		349	@{$registry->[$event] \|\| []}, $cb;
		350	}
		351
		352	# hack
		353	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		354
		355	# attach handles attaching event callbacks
		356	# the only thing the caller has to do is pass the correct
		357	# registry (== where the callback attaches to).
		358	sub _attach {
		359	my ($registry, $klass, @arg) = @_;
		360
		361	my $object_type;
		362	my $prio = 0;
		363	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		364
		365	#TODO: get rid of this hack
		366	if ($attachable_klass{$klass}) {
		367	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		368	}
		369
		370	while (@arg) {
		371	my $type = shift @arg;
		372
		373	if ($type eq "prio") {
		374	$prio = shift @arg;
		375
		376	} elsif ($type eq "type") {
		377	$object_type = shift @arg;
		378	$registry = $CB_TYPE[$object_type] \|\|= [];
		379
		380	} elsif ($type eq "subtype") {
		381	defined $object_type or Carp::croak "subtype specified without type";
		382	my $object_subtype = shift @arg;
		383	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] \|\|= [];
		384
		385	} elsif ($type eq "package") {
		386	my $pkg = shift @arg;
		387
		388	while (my ($name, $id) = each %cb_id) {
		389	if (my $cb = $pkg->can ($name)) {
		390	_attach_cb $registry, $id, $prio, $cb;
		391	}
		392	}
		393
		394	} elsif (exists $cb_id{$type}) {
		395	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		396
		397	} elsif (ref $type) {
		398	warn "attaching objects not supported, ignoring.\n";
		399
		400	} else {
		401	shift @arg;
		402	warn "attach argument '$type' not supported, ignoring.\n";
		403	}
		404	}
		405	}
		406
		407	sub _object_attach {
		408	my ($obj, $name, %arg) = @_;
		409
		410	return if exists $obj->{_attachment}{$name};
		411
		412	if (my $attach = $attachment{$name}) {
		413	my $registry = $obj->registry;
		414
		415	for (@$attach) {
		416	my ($klass, @attach) = @$_;
		417	_attach $registry, $klass, @attach;
		418	}
		419
		420	$obj->{$name} = \%arg;
		421	} else {
		422	warn "object uses attachment '$name' that is not available, postponing.\n";
		423	}
		424
		425	$obj->{_attachment}{$name} = undef;
		426	}
		427
		428	sub cf::attachable::attach {
		429	if (ref $_[0]) {
		430	_object_attach @_;
		431	} else {
		432	_attach shift->_attach_registry, @_;
		433	}
		434	};
		435
		436	# all those should be optimised
		437	sub cf::attachable::detach {
		438	my ($obj, $name) = @_;
		439
		440	if (ref $obj) {
		441	delete $obj->{_attachment}{$name};
		442	reattach ($obj);
		443	} else {
		444	Carp::croak "cannot, currently, detach class attachments";
		445	}
		446	};
		447
		448	sub cf::attachable::attached {
		449	my ($obj, $name) = @_;
		450
		451	exists $obj->{_attachment}{$name}
		452	}
		453
		454	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		455	eval "#line " . __LINE__ . " 'cf.pm'
		456	sub cf::\L$klass\E::_attach_registry {
		457	(\\\@CB_$klass, KLASS_$klass)
		458	}
		459
		460	sub cf::\L$klass\E::attachment {
		461	my \$name = shift;
		462
		463	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		464	}
		465	";
		466	die if $@;
		467	}
		468
		469	our $override;
		470	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		471
		472	sub override {
		473	$override = 1;
		474	@invoke_results = ();
		475	}
		476
		477	sub do_invoke {
		478	my $event = shift;
		479	my $callbacks = shift;
		480
		481	@invoke_results = ();
		482
		483	local $override;
		484
		485	for (@$callbacks) {
		486	eval { &{$_->[1]} };
		487
		488	if ($@) {
		489	warn "$@";
		490	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		491	override;
		492	}
		493
		494	return 1 if $override;
		495	}
		496
		497	0
		498	}
		499
		500	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		501
		502	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		503
		504	Generate an object-specific event with the given arguments.
		505
		506	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		507	removed in future versions), and there is no public API to access override
		508	results (if you must, access C<@cf::invoke_results> directly).
		509
463	=back	510	=back
464		511
465	=cut	512	=cut
466
467	*cf::object::valid =
468	*cf::player::valid =
469	*cf::map::valid = \&cf::_valid;
470		513
471	#############################################################################	514	#############################################################################
472	# object support	515	# object support
473		516
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 {	517	sub reattach {
		518	# basically do the same as instantiate, without calling instantiate
488	my ($obj) = @_;	519	my ($obj) = @_;
		520
489	my $registry = $obj->registry;	521	my $registry = $obj->registry;
490		522
491	@$registry = ();	523	@$registry = ();
492		524
493	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };	525	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
494		526
495	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	527	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
496	if (my $attach = $attachment{$name}) {	528	if (my $attach = $attachment{$name}) {
497	for (@$attach) {	529	for (@$attach) {
498	my ($klass, @attach) = @$_;	530	my ($klass, @attach) = @$_;
499	_attach @$registry, $klass, @attach;	531	_attach $registry, $klass, @attach;
500	}	532	}
501	} else {	533	} else {
502	warn "object uses attachment '$name' that is not available, postponing.\n";	534	warn "object uses attachment '$name' that is not available, postponing.\n";
503	}	535	}
504	}	536	}
505	}	537	}
		538
		539	cf::attachable->attach (
		540	prio => -1000000,
		541	on_instantiate => sub {
		542	my ($obj, $data) = @_;
		543
		544	$data = from_json $data;
		545
		546	for (@$data) {
		547	my ($name, $args) = @$_;
		548
		549	$obj->attach ($name, %{$args \|\| {} });
		550	}
		551	},
		552	on_reattach => \&reattach,
		553	on_clone => sub {
		554	my ($src, $dst) = @_;
		555
		556	@{$dst->registry} = @{$src->registry};
		557
		558	%$dst = %$src;
		559
		560	%{$dst->{_attachment}} = %{$src->{_attachment}}
		561	if exists $src->{_attachment};
		562	},
		563	);
506		564
507	sub object_freezer_save {	565	sub object_freezer_save {
508	my ($filename, $rdata, $objs) = @_;	566	my ($filename, $rdata, $objs) = @_;
509		567
510	if (length $$rdata) {	568	if (length $$rdata) {
…		…
560	}	618	}
561		619
562	()	620	()
563	}	621	}
564		622
565	attach_to_objects
566	prio => -1000000,
567	on_clone => sub {
568	my ($src, $dst) = @_;
569
570	@{$dst->registry} = @{$src->registry};
571
572	%$dst = %$src;
573
574	%{$dst->{_attachment}} = %{$src->{_attachment}}
575	if exists $src->{_attachment};
576	},
577	;
578
579	#############################################################################	623	#############################################################################
580	# command handling &c	624	# command handling &c
581		625
582	=item cf::register_command $name => \&callback($ob,$args);	626	=item cf::register_command $name => \&callback($ob,$args);
583		627
…		…
611	#warn "registering extcmd '$name' to '$caller'";	655	#warn "registering extcmd '$name' to '$caller'";
612		656
613	$EXTCMD{$name} = [$cb, $caller];	657	$EXTCMD{$name} = [$cb, $caller];
614	}	658	}
615		659
616	attach_to_players	660	cf::player->attach (
617	on_command => sub {	661	on_command => sub {
618	my ($pl, $name, $params) = @_;	662	my ($pl, $name, $params) = @_;
619		663
620	my $cb = $COMMAND{$name}	664	my $cb = $COMMAND{$name}
621	or return;	665	or return;
…		…
641	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	685	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
642	}	686	}
643		687
644	cf::override;	688	cf::override;
645	},	689	},
646	;	690	);
647		691
648	sub register {	692	sub register {
649	my ($base, $pkg) = @_;	693	my ($base, $pkg) = @_;
650		694
651	#TODO	695	#TODO
…		…
741	defined $path or return;	785	defined $path or return;
742		786
743	unlink "$path.pst";	787	unlink "$path.pst";
744	};	788	};
745		789
746	attach_to_maps prio => -10000, package => cf::mapsupport::;	790	cf::map->attach (prio => -10000, package => cf::mapsupport::);
747		791
748	#############################################################################	792	#############################################################################
749	# load/save perl data associated with player->ob objects	793	# load/save perl data associated with player->ob objects
750		794
751	sub all_objects(@) {	795	sub all_objects(@) {
752	@_, map all_objects ($_->inv), @_	796	@_, map all_objects ($_->inv), @_
753	}	797	}
754		798
755	# TODO: compatibility cruft, remove when no longer needed	799	# TODO: compatibility cruft, remove when no longer needed
756	attach_to_players	800	cf::player->attach (
757	on_load => sub {	801	on_load => sub {
758	my ($pl, $path) = @_;	802	my ($pl, $path) = @_;
759		803
760	for my $o (all_objects $pl->ob) {	804	for my $o (all_objects $pl->ob) {
761	if (my $value = $o->get_ob_key_value ("_perl_data")) {	805	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
763		807
764	%$o = %{ Storable::thaw pack "H*", $value };	808	%$o = %{ Storable::thaw pack "H*", $value };
765	}	809	}
766	}	810	}
767	},	811	},
768	;	812	);
769		813
770	#############################################################################	814	#############################################################################
771		815
772	=head2 CORE EXTENSIONS	816	=head2 CORE EXTENSIONS
773		817
774	Functions and methods that extend core crossfire objects.	818	Functions and methods that extend core crossfire objects.
		819
		820	=head3 cf::player
775		821
776	=over 4	822	=over 4
777		823
778	=item cf::player::exists $login	824	=item cf::player::exists $login
779		825
…		…
784	sub cf::player::exists($) {	830	sub cf::player::exists($) {
785	cf::player::find $_[0]	831	cf::player::find $_[0]
786	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	832	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
787	}	833	}
788		834
		835	=item $player->ext_reply ($msgid, $msgtype, %msg)
		836
		837	Sends an ext reply to the player.
		838
		839	=cut
		840
		841	sub cf::player::ext_reply($$$%) {
		842	my ($self, $id, %msg) = @_;
		843
		844	$msg{msgid} = $id;
		845
		846	$self->send ("ext " . to_json \%msg);
		847	}
		848
		849	=back
		850
		851	=head3 cf::object::player
		852
		853	=over 4
		854
789	=item $player_object->reply ($npc, $msg[, $flags])	855	=item $player_object->reply ($npc, $msg[, $flags])
790		856
791	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	857	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	858	can be C<undef>. Does the right thing when the player is currently in a
793	dialogue with the given NPC character.	859	dialogue with the given NPC character.
794		860
795	=cut	861	=cut
796		862
797	# rough implementation of a future "reply" method that works	863	# rough implementation of a future "reply" method that works
798	# with dialog boxes.	864	# with dialog boxes.
		865	#TODO: the first argument must go, split into a $npc->reply_to ( method
799	sub cf::object::player::reply($$$;$) {	866	sub cf::object::player::reply($$$;$) {
800	my ($self, $npc, $msg, $flags) = @_;	867	my ($self, $npc, $msg, $flags) = @_;
801		868
802	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	869	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
803		870
…		…
807	$msg = $npc->name . " says: $msg" if $npc;	874	$msg = $npc->name . " says: $msg" if $npc;
808	$self->message ($msg, $flags);	875	$self->message ($msg, $flags);
809	}	876	}
810	}	877	}
811		878
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")	879	=item $player_object->may ("access")
827		880
828	Returns wether the given player is authorized to access resource "access"	881	Returns wether the given player is authorized to access resource "access"
829	(e.g. "command_wizcast").	882	(e.g. "command_wizcast").
830		883
…		…
837	(ref $cf::CFG{"may_$access"}	890	(ref $cf::CFG{"may_$access"}
838	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	891	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839	: $cf::CFG{"may_$access"})	892	: $cf::CFG{"may_$access"})
840	}	893	}
841		894
842	=cut	895	=head3 cf::client
843		896
844	#############################################################################	897	=over 4
		898
		899	=item $client->send_drawinfo ($text, $flags)
		900
		901	Sends a drawinfo packet to the client. Circumvents output buffering so
		902	should not be used under normal circumstances.
		903
		904	=cut
		905
		906	sub cf::client::send_drawinfo {
		907	my ($self, $text, $flags) = @_;
		908
		909	utf8::encode $text;
		910	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		911	}
		912
		913
		914	=item $success = $client->query ($flags, "text", \&cb)
		915
		916	Queues a query to the client, calling the given callback with
		917	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		918	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		919
		920	Queries can fail, so check the return code. Or don't, as queries will become
		921	reliable at some point in the future.
		922
		923	=cut
		924
		925	sub cf::client::query {
		926	my ($self, $flags, $text, $cb) = @_;
		927
		928	return unless $self->state == ST_PLAYING
		929	\|\| $self->state == ST_SETUP
		930	\|\| $self->state == ST_CUSTOM;
		931
		932	$self->state (ST_CUSTOM);
		933
		934	utf8::encode $text;
		935	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		936
		937	$self->send_packet ($self->{query_queue}[0][0])
		938	if @{ $self->{query_queue} } == 1;
		939	}
		940
		941	cf::client->attach (
		942	on_reply => sub {
		943	my ($ns, $msg) = @_;
		944
		945	# this weird shuffling is so that direct followup queries
		946	# get handled first
		947	my $queue = delete $ns->{query_queue};
		948
		949	(shift @$queue)->[1]->($msg);
		950
		951	push @{ $ns->{query_queue} }, @$queue;
		952
		953	if (@{ $ns->{query_queue} } == @$queue) {
		954	if (@$queue) {
		955	$ns->send_packet ($ns->{query_queue}[0][0]);
		956	} else {
		957	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		958	}
		959	}
		960	},
		961	);
		962
		963	=item $client->coro (\&cb)
		964
		965	Create a new coroutine, running the specified callback. The coroutine will
		966	be automatically cancelled when the client gets destroyed (e.g. on logout,
		967	or loss of connection).
		968
		969	=cut
		970
		971	sub cf::client::coro {
		972	my ($self, $cb) = @_;
		973
		974	my $coro; $coro = async {
		975	eval {
		976	$cb->();
		977	};
		978	warn $@ if $@;
		979	};
		980
		981	$coro->on_destroy (sub {
		982	delete $self->{_coro}{$coro+0};
		983	});
		984
		985	$self->{_coro}{$coro+0} = $coro;
		986
		987	$coro
		988	}
		989
		990	cf::client->attach (
		991	on_destroy => sub {
		992	my ($ns) = @_;
		993
		994	$_->cancel for values %{ (delete $ns->{_coro}) \|\| {} };
		995	},
		996	);
		997
		998	=back
		999
845		1000
846	=head2 SAFE SCRIPTING	1001	=head2 SAFE SCRIPTING
847		1002
848	Functions that provide a safe environment to compile and execute	1003	Functions that provide a safe environment to compile and execute
849	snippets of perl code without them endangering the safety of the server	1004	snippets of perl code without them endangering the safety of the server
…		…
864		1019
865	=pod	1020	=pod
866		1021
867	The following fucntions and emthods are available within a safe environment:	1022	The following fucntions and emthods are available within a safe environment:
868		1023
869	cf::object contr pay_amount pay_player	1024	cf::object contr pay_amount pay_player map
870	cf::object::player player	1025	cf::object::player player
871	cf::player peaceful	1026	cf::player peaceful
		1027	cf::map trigger
872		1028
873	=cut	1029	=cut
874		1030
875	for (	1031	for (
876	["cf::object" => qw(contr pay_amount pay_player)],	1032	["cf::object" => qw(contr pay_amount pay_player map)],
877	["cf::object::player" => qw(player)],	1033	["cf::object::player" => qw(player)],
878	["cf::player" => qw(peaceful)],	1034	["cf::player" => qw(peaceful)],
		1035	["cf::map" => qw(trigger)],
879	) {	1036	) {
880	no strict 'refs';	1037	no strict 'refs';
881	my ($pkg, @funs) = @$_;	1038	my ($pkg, @funs) = @$_;
882	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1039	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883	for @funs;	1040	for @funs;
…		…
1047	$DB->{$_[0]} = $_[1];	1204	$DB->{$_[0]} = $_[1];
1048	}	1205	}
1049	db_dirty;	1206	db_dirty;
1050	}	1207	}
1051		1208
1052	attach_global	1209	cf::global->attach (
1053	prio => 10000,	1210	prio => 10000,
1054	on_cleanup => sub {	1211	on_cleanup => sub {
1055	db_sync;	1212	db_sync;
1056	},	1213	},
1057	;	1214	);
1058	}	1215	}
1059		1216
1060	#############################################################################	1217	#############################################################################
1061	# the server's main()	1218	# the server's main()
1062		1219
…		…
1076	}	1233	}
1077		1234
1078	#############################################################################	1235	#############################################################################
1079	# initialisation	1236	# initialisation
1080		1237
1081	sub _perl_reload(&) {	1238	sub _perl_reload() {
1082	my ($msg) = @_;	1239	warn "reloading...";
1083
1084	$msg->("reloading...");
1085		1240
1086	eval {	1241	eval {
		1242	local $FREEZE = 1;
		1243
		1244	cf::emergency_save;
		1245
1087	# cancel all watchers	1246	# cancel all watchers
1088	for (Event::all_watchers) {	1247	for (Event::all_watchers) {
1089	$_->cancel if $_->data & WF_AUTOCANCEL;	1248	$_->cancel if $_->data & WF_AUTOCANCEL;
1090	}	1249	}
1091		1250
		1251	# cancel all extension coros
		1252	$_->cancel for values %EXT_CORO;
		1253	%EXT_CORO = ();
		1254
1092	# unload all extensions	1255	# unload all extensions
1093	for (@exts) {	1256	for (@exts) {
1094	$msg->("unloading <$_>");	1257	warn "unloading <$_>";
1095	unload_extension $_;	1258	unload_extension $_;
1096	}	1259	}
1097		1260
1098	# unload all modules loaded from $LIBDIR	1261	# unload all modules loaded from $LIBDIR
1099	while (my ($k, $v) = each %INC) {	1262	while (my ($k, $v) = each %INC) {
1100	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1263	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101		1264
1102	$msg->("removing <$k>");	1265	warn "removing <$k>";
1103	delete $INC{$k};	1266	delete $INC{$k};
1104		1267
1105	$k =~ s/\.pm$//;	1268	$k =~ s/\.pm$//;
1106	$k =~ s/\//::/g;	1269	$k =~ s/\//::/g;
1107		1270
…		…
1112	Symbol::delete_package $k;	1275	Symbol::delete_package $k;
1113	}	1276	}
1114		1277
1115	# sync database to disk	1278	# sync database to disk
1116	cf::db_sync;	1279	cf::db_sync;
		1280	IO::AIO::flush;
1117		1281
1118	# get rid of safe::, as good as possible	1282	# get rid of safe::, as good as possible
1119	Symbol::delete_package "safe::$_"	1283	Symbol::delete_package "safe::$_"
1120	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	1284	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1121		1285
1122	# remove register_script_function callbacks	1286	# remove register_script_function callbacks
1123	# TODO	1287	# TODO
1124		1288
1125	# unload cf.pm "a bit"	1289	# unload cf.pm "a bit"
…		…
1128	# don't, removes xs symbols, too,	1292	# don't, removes xs symbols, too,
1129	# and global variables created in xs	1293	# and global variables created in xs
1130	#Symbol::delete_package __PACKAGE__;	1294	#Symbol::delete_package __PACKAGE__;
1131		1295
1132	# reload cf.pm	1296	# reload cf.pm
1133	$msg->("reloading cf.pm");	1297	warn "reloading cf.pm";
1134	require cf;	1298	require cf;
		1299	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1135		1300
1136	# load config and database again	1301	# load config and database again
1137	cf::cfg_load;	1302	cf::cfg_load;
1138	cf::db_load;	1303	cf::db_load;
1139		1304
1140	# load extensions	1305	# load extensions
1141	$msg->("load extensions");	1306	warn "load extensions";
1142	cf::load_extensions;	1307	cf::load_extensions;
1143		1308
1144	# reattach attachments to objects	1309	# reattach attachments to objects
1145	$msg->("reattach");	1310	warn "reattach";
1146	_global_reattach;	1311	_global_reattach;
1147	};	1312	};
1148	$msg->($@) if $@;	1313	warn $@ if $@;
1149		1314
1150	$msg->("reloaded");	1315	warn "reloaded";
1151	};	1316	};
1152		1317
1153	sub perl_reload() {	1318	sub perl_reload() {
1154	_perl_reload {	1319	_perl_reload;
1155	warn $_[0];
1156	print "$_[0]\n";
1157	};
1158	}	1320	}
1159		1321
1160	register "<global>", __PACKAGE__;	1322	register "<global>", __PACKAGE__;
1161		1323
1162	register_command "perl-reload" => sub {	1324	register_command "perl-reload" => sub {
1163	my ($who, $arg) = @_;	1325	my ($who, $arg) = @_;
1164		1326
1165	if ($who->flag (FLAG_WIZ)) {	1327	if ($who->flag (FLAG_WIZ)) {
		1328	$who->message ("reloading...");
1166	_perl_reload {	1329	_perl_reload;
1167	warn $_[0];
1168	$who->message ($_[0]);
1169	};
1170	}	1330	}
1171	};	1331	};
1172		1332
1173	unshift @INC, $LIBDIR;	1333	unshift @INC, $LIBDIR;
1174		1334
1175	$TICK_WATCHER = Event->timer (	1335	$TICK_WATCHER = Event->timer (
		1336	reentrant => 0,
1176	prio => 0,	1337	prio => 0,
1177	at => $NEXT_TICK \|\| 1,	1338	at => $NEXT_TICK \|\| $TICK,
1178	data => WF_AUTOCANCEL,	1339	data => WF_AUTOCANCEL,
1179	cb => sub {	1340	cb => sub {
		1341	unless ($FREEZE) {
1180	cf::server_tick; # one server iteration	1342	cf::server_tick; # one server iteration
		1343	$RUNTIME += $TICK;
		1344	}
1181		1345
1182	my $NOW = Event::time;
1183	$NEXT_TICK += $TICK;	1346	$NEXT_TICK += $TICK;
1184		1347
1185	# if we are delayed by four ticks or more, skip them all	1348	# if we are delayed by four ticks or more, skip them all
1186	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1349	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1187		1350
1188	$TICK_WATCHER->at ($NEXT_TICK);	1351	$TICK_WATCHER->at ($NEXT_TICK);
1189	$TICK_WATCHER->start;	1352	$TICK_WATCHER->start;
1190	},	1353	},
1191	);	1354	);
…		…
1196	poll => 'r',	1359	poll => 'r',
1197	prio => 5,	1360	prio => 5,
1198	data => WF_AUTOCANCEL,	1361	data => WF_AUTOCANCEL,
1199	cb => \&IO::AIO::poll_cb);	1362	cb => \&IO::AIO::poll_cb);
1200		1363
		1364	# we must not ever block the main coroutine
		1365	$Coro::idle = sub {
		1366	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1367	warn "FATAL: Coro::idle was called, major BUG\n";
		1368	(Coro::unblock_sub {
		1369	Event::one_event;
		1370	})->();
		1371	};
		1372
1201	1	1373	1
1202		1374

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.104 by root, Sat Dec 30 16:56:16 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.104 by root, Sat Dec 30 16:56:16 2006 UTC