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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.80 by root, Tue Nov 7 16:30:55 2006 UTC vs.
Revision 1.102 by root, Wed Dec 27 15:20:54 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;
		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 (Coro::PRIO_MIN);
20		29
21	_init_vars;	30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		31
23	our %COMMAND = ();	32	our %COMMAND = ();
		33	our %COMMAND_TIME = ();
		34	our %EXTCMD = ();
		35
24	our @EVENT;	36	our @EVENT;
25	our $LIBDIR = maps_directory "perl";	37	our $LIBDIR = datadir . "/ext";
26		38
27	our $TICK = MAX_TIME * 1e-6;	39	our $TICK = MAX_TIME * 1e-6;
28	our $TICK_WATCHER;	40	our $TICK_WATCHER;
29	our $NEXT_TICK;	41	our $NEXT_TICK;
30		42
31	our %CFG;	43	our %CFG;
32		44
33	our $uptime;	45	our $UPTIME; $UPTIME \|\|= time;
34
35	$uptime \|\|= time;
36		46
37	#############################################################################	47	#############################################################################
38		48
39	=head2 GLOBAL VARIABLES	49	=head2 GLOBAL VARIABLES
40		50
41	=over 4	51	=over 4
		52
		53	=item $cf::UPTIME
		54
		55	The timestamp of the server start (so not actually an uptime).
42		56
43	=item $cf::LIBDIR	57	=item $cf::LIBDIR
44		58
45	The perl library directory, where extensions and cf-specific modules can	59	The perl library directory, where extensions and cf-specific modules can
46	be found. It will be added to C<@INC> automatically.	60	be found. It will be added to C<@INC> automatically.
67	print STDERR "cfperl: $msg";	81	print STDERR "cfperl: $msg";
68	LOG llevError, "cfperl: $msg";	82	LOG llevError, "cfperl: $msg";
69	};	83	};
70	}	84	}
71		85
		86	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		87	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		88	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		89	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		90	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
72	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	91	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
73		92
74	# we bless all objects into (empty) derived classes to force a method lookup	93	# we bless all objects into (empty) derived classes to force a method lookup
75	# within the Safe compartment.	94	# within the Safe compartment.
76	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	95	for my $pkg (qw(
		96	cf::global cf::attachable
		97	cf::object cf::object::player
		98	cf::client cf::player
		99	cf::arch cf::living
		100	cf::map cf::party cf::region
		101	)) {
77	no strict 'refs';	102	no strict 'refs';
78	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	103	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
79	}	104	}
80		105
81	$Event::DIED = sub {	106	$Event::DIED = sub {
…		…
83	};	108	};
84		109
85	my %ext_pkg;	110	my %ext_pkg;
86	my @exts;	111	my @exts;
87	my @hook;	112	my @hook;
88	my %command;
89	my %extcmd;
90		113
91	=head2 UTILITY FUNCTIONS	114	=head2 UTILITY FUNCTIONS
92		115
93	=over 4	116	=over 4
94		117
…		…
122		145
123	=cut	146	=cut
124		147
125	#############################################################################	148	#############################################################################
126		149
127	=head2 EVENTS AND OBJECT ATTACHMENTS	150	=head2 ATTACHABLE OBJECTS
		151
		152	Many objects in crossfire are so-called attachable objects. That means you can
		153	attach callbacks/event handlers (a collection of which is called an "attachment")
		154	to it. All such attachable objects support the following methods.
		155
		156	In the following description, CLASS can be any of C<global>, C<object>
		157	C<player>, C<client> or C<map> (i.e. the attachable objects in
		158	crossfire+).
128		159
129	=over 4	160	=over 4
130		161
131	=item $object->attach ($attachment, key => $value...)
132
133	=item $object->detach ($attachment)
134
135	Attach/detach a pre-registered attachment to an object.
136
137	=item $player->attach ($attachment, key => $value...)
138
139	=item $player->detach ($attachment)
140
141	Attach/detach a pre-registered attachment to a player.
142
143	=item $map->attach ($attachment, key => $value...)	162	=item $attachable->attach ($attachment, key => $value...)
144		163
145	=item $map->detach ($attachment)	164	=item $attachable->detach ($attachment)
146		165
147	Attach/detach a pre-registered attachment to a map.	166	Attach/detach a pre-registered attachment to a specific object and give it
		167	the specified key/value pairs as arguments.
148		168
149	=item $bool = $object->attached ($name)	169	Example, attach a minesweeper attachment to the given object, making it a
		170	10x10 minesweeper game:
150		171
151	=item $bool = $player->attached ($name)	172	$obj->attach (minesweeper => width => 10, height => 10);
152		173
153	=item $bool = $map->attached ($name)	174	=item $bool = $attachable->attached ($name)
154		175
155	Checks wether the named attachment is currently attached to the object.	176	Checks wether the named attachment is currently attached to the object.
156		177
157	=item cf::attach_global ...	178	=item cf::CLASS->attach ...
158		179
159	Attach handlers for global events.	180	=item cf::CLASS->detach ...
160		181
161	This and all following C<attach_*>-functions expect any number of the	182	Define an anonymous attachment and attach it to all objects of the given
162	following handler/hook descriptions:	183	CLASS. See the next function for an explanation of its arguments.
		184
		185	You can attach to global events by using the C<cf::global> class.
		186
		187	Example, log all player logins:
		188
		189	cf::player->attach (
		190	on_login => sub {
		191	my ($pl) = @_;
		192	...
		193	},
		194	);
		195
		196	Example, attach to the jeweler skill:
		197
		198	cf::object->attach (
		199	type => cf::SKILL,
		200	subtype => cf::SK_JEWELER,
		201	on_use_skill => sub {
		202	my ($sk, $ob, $part, $dir, $msg) = @_;
		203	...
		204	},
		205	);
		206
		207	=item cf::CLASS::attachment $name, ...
		208
		209	Register an attachment by C<$name> through which attachable objects of the
		210	given CLASS can refer to this attachment.
		211
		212	Some classes such as crossfire maps and objects can specify attachments
		213	that are attached at load/instantiate time, thus the need for a name.
		214
		215	These calls expect any number of the following handler/hook descriptions:
163		216
164	=over 4	217	=over 4
165		218
166	=item prio => $number	219	=item prio => $number
167		220
…		…
169	by another C<prio> setting). Lower priority handlers get executed	222	by another C<prio> setting). Lower priority handlers get executed
170	earlier. The default priority is C<0>, and many built-in handlers are	223	earlier. The default priority is C<0>, and many built-in handlers are
171	registered at priority C<-1000>, so lower priorities should not be used	224	registered at priority C<-1000>, so lower priorities should not be used
172	unless you know what you are doing.	225	unless you know what you are doing.
173		226
		227	=item type => $type
		228
		229	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		230	given type of objects only (the additional parameter C<subtype> can be
		231	used to further limit to the given subtype).
		232
174	=item on_I<event> => \&cb	233	=item on_I<event> => \&cb
175		234
176	Call the given code reference whenever the named event happens (event is	235	Call the given code reference whenever the named event happens (event is
177	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	236	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
178	handlers are recognised generally depends on the type of object these	237	handlers are recognised generally depends on the type of object these
…		…
187	package and register them. Only handlers for eevents supported by the	246	package and register them. Only handlers for eevents supported by the
188	object/class are recognised.	247	object/class are recognised.
189		248
190	=back	249	=back
191		250
192	=item cf::attach_to_type $object_type, $subtype, ...	251	Example, define an attachment called "sockpuppet" that calls the given
		252	event handler when a monster attacks:
193		253
194	Attach handlers for a specific object type (e.g. TRANSPORT) and	254	cf::object::attachment sockpuppet =>
195	subtype. If C<$subtype> is zero or undef, matches all objects of the given	255	on_skill_attack => sub {
196	type.	256	my ($self, $victim) = @_;
197		257	...
198	=item cf::attach_to_objects ...
199
200	Attach handlers to all objects. Do not use this except for debugging or
201	very rare events, as handlers are (obviously) called for I<all> objects in
202	the game.
203
204	=item cf::attach_to_players ...
205
206	Attach handlers to all players.
207
208	=item cf::attach_to_maps ...
209
210	Attach handlers to all maps.
211
212	=item cf:register_attachment $name, ...
213
214	Register an attachment by name through which objects can refer to this
215	attachment.
216
217	=item cf:register_player_attachment $name, ...
218
219	Register an attachment by name through which players can refer to this
220	attachment.
221
222	=item cf:register_map_attachment $name, ...
223
224	Register an attachment by name through which maps can refer to this
225	attachment.
226
227	=cut
228
229	# the following variables are defined in .xs and must not be re-created
230	our @CB_GLOBAL = (); # registry for all global events
231	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
232	our @CB_PLAYER = ();
233	our @CB_TYPE = (); # registry for type (cf-object class) based events
234	our @CB_MAP = ();
235
236	my %attachment;
237
238	sub _attach_cb($\%$$$) {
239	my ($registry, $undo, $event, $prio, $cb) = @_;
240
241	use sort 'stable';
242
243	$cb = [$prio, $cb];
244
245	@{$registry->[$event]} = sort
246	{ $a->[0] cmp $b->[0] }
247	@{$registry->[$event] \|\| []}, $cb;
248
249	push @{$undo->{cb}}, [$event, $cb];
250	}
251
252	# attach handles attaching event callbacks
253	# the only thing the caller has to do is pass the correct
254	# registry (== where the callback attaches to).
255	sub _attach(\@$@) {
256	my ($registry, $klass, @arg) = @_;
257
258	my $prio = 0;
259
260	my %undo = (
261	registry => $registry,
262	cb => [],
263	);
264
265	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
266
267	while (@arg) {
268	my $type = shift @arg;
269
270	if ($type eq "prio") {
271	$prio = shift @arg;
272
273	} elsif ($type eq "package") {
274	my $pkg = shift @arg;
275
276	while (my ($name, $id) = each %cb_id) {
277	if (my $cb = $pkg->can ($name)) {
278	_attach_cb $registry, %undo, $id, $prio, $cb;
279	}
280	}	258	}
281
282	} elsif (exists $cb_id{$type}) {
283	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
284
285	} elsif (ref $type) {
286	warn "attaching objects not supported, ignoring.\n";
287
288	} else {
289	shift @arg;
290	warn "attach argument '$type' not supported, ignoring.\n";
291	}
292	}
293
294	\%undo
295	}
296
297	sub _attach_attachment {
298	my ($obj, $name, %arg) = @_;
299
300	return if exists $obj->{_attachment}{$name};
301
302	my $res;
303
304	if (my $attach = $attachment{$name}) {
305	my $registry = $obj->registry;
306
307	for (@$attach) {
308	my ($klass, @attach) = @$_;
309	$res = _attach @$registry, $klass, @attach;
310	}
311
312	$obj->{$name} = \%arg;
313	} else {
314	warn "object uses attachment '$name' that is not available, postponing.\n";
315	}
316
317	$obj->{_attachment}{$name} = undef;
318
319	$res->{attachment} = $name;
320	$res
321	}
322
323	*cf::object::attach =
324	*cf::player::attach =
325	*cf::map::attach = sub {
326	my ($obj, $name, %arg) = @_;
327
328	_attach_attachment $obj, $name, %arg;
329	};
330
331	# all those should be optimised
332	*cf::object::detach =
333	*cf::player::detach =
334	*cf::map::detach = sub {
335	my ($obj, $name) = @_;
336
337	delete $obj->{_attachment}{$name};
338	reattach ($obj);
339	};
340
341	*cf::object::attached =
342	*cf::player::attached =
343	*cf::map::attached = sub {
344	my ($obj, $name) = @_;
345
346	exists $obj->{_attachment}{$name}
347	};
348
349	sub attach_global {
350	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
351	}
352
353	sub attach_to_type {
354	my $type = shift;
355	my $subtype = shift;
356
357	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
358	}
359
360	sub attach_to_objects {
361	_attach @CB_OBJECT, KLASS_OBJECT, @_
362	}
363
364	sub attach_to_players {
365	_attach @CB_PLAYER, KLASS_PLAYER, @_
366	}
367
368	sub attach_to_maps {
369	_attach @CB_MAP, KLASS_MAP, @_
370	}
371
372	sub register_attachment {
373	my $name = shift;
374
375	$attachment{$name} = [[KLASS_OBJECT, @_]];
376	}
377
378	sub register_player_attachment {
379	my $name = shift;
380
381	$attachment{$name} = [[KLASS_PLAYER, @_]];
382	}
383
384	sub register_map_attachment {
385	my $name = shift;
386
387	$attachment{$name} = [[KLASS_MAP, @_]];
388	}
389
390	our $override;
391	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
392
393	sub override {
394	$override = 1;
395	@invoke_results = ();
396	}
397
398	sub do_invoke {
399	my $event = shift;
400	my $callbacks = shift;
401
402	@invoke_results = ();
403
404	local $override;
405
406	for (@$callbacks) {
407	eval { &{$_->[1]} };
408
409	if ($@) {
410	warn "$@";
411	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
412	override;
413	}
414
415	return 1 if $override;
416	}
417
418	0	259	}
419	}
420		260
421	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	261	=item $attachable->valid
422
423	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
424
425	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
426
427	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
428
429	Generate a global/object/player/map-specific event with the given arguments.
430
431	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
432	removed in future versions), and there is no public API to access override
433	results (if you must, access C<@cf::invoke_results> directly).
434
435	=back
436
437	=cut
438
439	#############################################################################
440
441	=head2 METHODS VALID FOR ALL CORE OBJECTS
442
443	=over 4
444
445	=item $object->valid, $player->valid, $map->valid
446		262
447	Just because you have a perl object does not mean that the corresponding	263	Just because you have a perl object does not mean that the corresponding
448	C-level object still exists. If you try to access an object that has no	264	C-level object still exists. If you try to access an object that has no
449	valid C counterpart anymore you get an exception at runtime. This method	265	valid C counterpart anymore you get an exception at runtime. This method
450	can be used to test for existence of the C object part without causing an	266	can be used to test for existence of the C object part without causing an
451	exception.	267	exception.
452		268
		269	=cut
		270
		271	# the following variables are defined in .xs and must not be re-created
		272	our @CB_GLOBAL = (); # registry for all global events
		273	our @CB_ATTACHABLE = (); # registry for all attachables
		274	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		275	our @CB_PLAYER = ();
		276	our @CB_CLIENT = ();
		277	our @CB_TYPE = (); # registry for type (cf-object class) based events
		278	our @CB_MAP = ();
		279
		280	my %attachment;
		281
		282	sub _attach_cb($$$$) {
		283	my ($registry, $event, $prio, $cb) = @_;
		284
		285	use sort 'stable';
		286
		287	$cb = [$prio, $cb];
		288
		289	@{$registry->[$event]} = sort
		290	{ $a->[0] cmp $b->[0] }
		291	@{$registry->[$event] \|\| []}, $cb;
		292	}
		293
		294	# hack
		295	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		296
		297	# attach handles attaching event callbacks
		298	# the only thing the caller has to do is pass the correct
		299	# registry (== where the callback attaches to).
		300	sub _attach {
		301	my ($registry, $klass, @arg) = @_;
		302
		303	my $object_type;
		304	my $prio = 0;
		305	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		306
		307	#TODO: get rid of this hack
		308	if ($attachable_klass{$klass}) {
		309	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		310	}
		311
		312	while (@arg) {
		313	my $type = shift @arg;
		314
		315	if ($type eq "prio") {
		316	$prio = shift @arg;
		317
		318	} elsif ($type eq "type") {
		319	$object_type = shift @arg;
		320	$registry = $CB_TYPE[$object_type] \|\|= [];
		321
		322	} elsif ($type eq "subtype") {
		323	defined $object_type or Carp::croak "subtype specified without type";
		324	my $object_subtype = shift @arg;
		325	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] \|\|= [];
		326
		327	} elsif ($type eq "package") {
		328	my $pkg = shift @arg;
		329
		330	while (my ($name, $id) = each %cb_id) {
		331	if (my $cb = $pkg->can ($name)) {
		332	_attach_cb $registry, $id, $prio, $cb;
		333	}
		334	}
		335
		336	} elsif (exists $cb_id{$type}) {
		337	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		338
		339	} elsif (ref $type) {
		340	warn "attaching objects not supported, ignoring.\n";
		341
		342	} else {
		343	shift @arg;
		344	warn "attach argument '$type' not supported, ignoring.\n";
		345	}
		346	}
		347	}
		348
		349	sub _object_attach {
		350	my ($obj, $name, %arg) = @_;
		351
		352	return if exists $obj->{_attachment}{$name};
		353
		354	if (my $attach = $attachment{$name}) {
		355	my $registry = $obj->registry;
		356
		357	for (@$attach) {
		358	my ($klass, @attach) = @$_;
		359	_attach $registry, $klass, @attach;
		360	}
		361
		362	$obj->{$name} = \%arg;
		363	} else {
		364	warn "object uses attachment '$name' that is not available, postponing.\n";
		365	}
		366
		367	$obj->{_attachment}{$name} = undef;
		368	}
		369
		370	sub cf::attachable::attach {
		371	if (ref $_[0]) {
		372	_object_attach @_;
		373	} else {
		374	_attach shift->_attach_registry, @_;
		375	}
		376	};
		377
		378	# all those should be optimised
		379	sub cf::attachable::detach {
		380	my ($obj, $name) = @_;
		381
		382	if (ref $obj) {
		383	delete $obj->{_attachment}{$name};
		384	reattach ($obj);
		385	} else {
		386	Carp::croak "cannot, currently, detach class attachments";
		387	}
		388	};
		389
		390	sub cf::attachable::attached {
		391	my ($obj, $name) = @_;
		392
		393	exists $obj->{_attachment}{$name}
		394	}
		395
		396	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		397	eval "#line " . __LINE__ . " 'cf.pm'
		398	sub cf::\L$klass\E::_attach_registry {
		399	(\\\@CB_$klass, KLASS_$klass)
		400	}
		401
		402	sub cf::\L$klass\E::attachment {
		403	my \$name = shift;
		404
		405	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		406	}
		407	";
		408	die if $@;
		409	}
		410
		411	our $override;
		412	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		413
		414	sub override {
		415	$override = 1;
		416	@invoke_results = ();
		417	}
		418
		419	sub do_invoke {
		420	my $event = shift;
		421	my $callbacks = shift;
		422
		423	@invoke_results = ();
		424
		425	local $override;
		426
		427	for (@$callbacks) {
		428	eval { &{$_->[1]} };
		429
		430	if ($@) {
		431	warn "$@";
		432	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		433	override;
		434	}
		435
		436	return 1 if $override;
		437	}
		438
		439	0
		440	}
		441
		442	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		443
		444	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		445
		446	Generate an object-specific event with the given arguments.
		447
		448	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		449	removed in future versions), and there is no public API to access override
		450	results (if you must, access C<@cf::invoke_results> directly).
		451
453	=back	452	=back
454		453
455	=cut	454	=cut
456
457	*cf::object::valid =
458	*cf::player::valid =
459	*cf::map::valid = \&cf::_valid;
460		455
461	#############################################################################	456	#############################################################################
462	# object support	457	# object support
463		458
464	sub instantiate {
465	my ($obj, $data) = @_;
466
467	$data = from_json $data;
468
469	for (@$data) {
470	my ($name, $args) = @$_;
471
472	$obj->attach ($name, %{$args \|\| {} });
473	}
474	}
475
476	# basically do the same as instantiate, without calling instantiate
477	sub reattach {	459	sub reattach {
		460	# basically do the same as instantiate, without calling instantiate
478	my ($obj) = @_;	461	my ($obj) = @_;
		462
479	my $registry = $obj->registry;	463	my $registry = $obj->registry;
480		464
481	@$registry = ();	465	@$registry = ();
482		466
483	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };	467	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
484		468
485	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	469	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
486	if (my $attach = $attachment{$name}) {	470	if (my $attach = $attachment{$name}) {
487	for (@$attach) {	471	for (@$attach) {
488	my ($klass, @attach) = @$_;	472	my ($klass, @attach) = @$_;
489	_attach @$registry, $klass, @attach;	473	_attach $registry, $klass, @attach;
490	}	474	}
491	} else {	475	} else {
492	warn "object uses attachment '$name' that is not available, postponing.\n";	476	warn "object uses attachment '$name' that is not available, postponing.\n";
493	}	477	}
494	}	478	}
495	}	479	}
		480
		481	cf::attachable->attach (
		482	prio => -1000000,
		483	on_instantiate => sub {
		484	my ($obj, $data) = @_;
		485
		486	$data = from_json $data;
		487
		488	for (@$data) {
		489	my ($name, $args) = @$_;
		490
		491	$obj->attach ($name, %{$args \|\| {} });
		492	}
		493	},
		494	on_reattach => \&reattach,
		495	on_clone => sub {
		496	my ($src, $dst) = @_;
		497
		498	@{$dst->registry} = @{$src->registry};
		499
		500	%$dst = %$src;
		501
		502	%{$dst->{_attachment}} = %{$src->{_attachment}}
		503	if exists $src->{_attachment};
		504	},
		505	);
496		506
497	sub object_freezer_save {	507	sub object_freezer_save {
498	my ($filename, $rdata, $objs) = @_;	508	my ($filename, $rdata, $objs) = @_;
499		509
500	if (length $$rdata) {	510	if (length $$rdata) {
…		…
528	sub object_freezer_as_string {	538	sub object_freezer_as_string {
529	my ($rdata, $objs) = @_;	539	my ($rdata, $objs) = @_;
530		540
531	use Data::Dumper;	541	use Data::Dumper;
532		542
533	"$$rdata\n" . Dumper $objs	543	$$rdata . Dumper $objs
534	}	544	}
535		545
536	sub object_thawer_load {	546	sub object_thawer_load {
537	my ($filename) = @_;	547	my ($filename) = @_;
538		548
…		…
550	}	560	}
551		561
552	()	562	()
553	}	563	}
554		564
555	attach_to_objects
556	prio => -1000000,
557	on_clone => sub {
558	my ($src, $dst) = @_;
559
560	@{$dst->registry} = @{$src->registry};
561
562	%$dst = %$src;
563
564	%{$dst->{_attachment}} = %{$src->{_attachment}}
565	if exists $src->{_attachment};
566	},
567	;
568
569	#############################################################################	565	#############################################################################
570	# old plug-in events	566	# command handling &c
571		567
572	sub inject_event {	568	=item cf::register_command $name => \&callback($ob,$args);
573	my $extension = shift;
574	my $event_code = shift;
575		569
576	my $cb = $hook[$event_code]{$extension}	570	Register a callback for execution when the client sends the user command
577	or return;	571	$name.
578		572
579	&$cb	573	=cut
580	}
581
582	sub inject_global_event {
583	my $event = shift;
584
585	my $cb = $hook[$event]
586	or return;
587
588	List::Util::max map &$_, values %$cb
589	}
590
591	sub inject_command {
592	my ($name, $obj, $params) = @_;
593
594	for my $cmd (@{ $command{$name} }) {
595	$cmd->[1]->($obj, $params);
596	}
597
598	-1
599	}
600		574
601	sub register_command {	575	sub register_command {
602	my ($name, $time, $cb) = @_;	576	my ($name, $cb) = @_;
603		577
604	my $caller = caller;	578	my $caller = caller;
605	#warn "registering command '$name/$time' to '$caller'";	579	#warn "registering command '$name/$time' to '$caller'";
606		580
607	push @{ $command{$name} }, [$time, $cb, $caller];	581	push @{ $COMMAND{$name} }, [$caller, $cb];
608	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
609	}	582	}
		583
		584	=item cf::register_extcmd $name => \&callback($pl,$packet);
		585
		586	Register a callbackf ro execution when the client sends an extcmd packet.
		587
		588	If the callback returns something, it is sent back as if reply was being
		589	called.
		590
		591	=cut
610		592
611	sub register_extcmd {	593	sub register_extcmd {
612	my ($name, $cb) = @_;	594	my ($name, $cb) = @_;
613		595
614	my $caller = caller;	596	my $caller = caller;
615	#warn "registering extcmd '$name' to '$caller'";	597	#warn "registering extcmd '$name' to '$caller'";
616		598
617	$extcmd{$name} = [$cb, $caller];	599	$EXTCMD{$name} = [$cb, $caller];
618	}	600	}
		601
		602	cf::player->attach (
		603	on_command => sub {
		604	my ($pl, $name, $params) = @_;
		605
		606	my $cb = $COMMAND{$name}
		607	or return;
		608
		609	for my $cmd (@$cb) {
		610	$cmd->[1]->($pl->ob, $params);
		611	}
		612
		613	cf::override;
		614	},
		615	on_extcmd => sub {
		616	my ($pl, $buf) = @_;
		617
		618	my $msg = eval { from_json $buf };
		619
		620	if (ref $msg) {
		621	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		622	if (my %reply = $cb->[0]->($pl, $msg)) {
		623	$pl->ext_reply ($msg->{msgid}, %reply);
		624	}
		625	}
		626	} else {
		627	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		628	}
		629
		630	cf::override;
		631	},
		632	);
619		633
620	sub register {	634	sub register {
621	my ($base, $pkg) = @_;	635	my ($base, $pkg) = @_;
622		636
623	#TODO	637	#TODO
…		…
642	. "#line 1 \"$path\"\n{\n"	656	. "#line 1 \"$path\"\n{\n"
643	. (do { local $/; <$fh> })	657	. (do { local $/; <$fh> })
644	. "\n};\n1";	658	. "\n};\n1";
645		659
646	eval $source	660	eval $source
647	or die "$path: $@";	661	or die $@ ? "$path: $@\n"
		662	: "extension disabled.\n";
648		663
649	push @exts, $pkg;	664	push @exts, $pkg;
650	$ext_pkg{$base} = $pkg;	665	$ext_pkg{$base} = $pkg;
651		666
652	# no strict 'refs';	667	# no strict 'refs';
…		…
665	# for my $idx (0 .. $#PLUGIN_EVENT) {	680	# for my $idx (0 .. $#PLUGIN_EVENT) {
666	# delete $hook[$idx]{$pkg};	681	# delete $hook[$idx]{$pkg};
667	# }	682	# }
668		683
669	# remove commands	684	# remove commands
670	for my $name (keys %command) {	685	for my $name (keys %COMMAND) {
671	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	686	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
672		687
673	if (@cb) {	688	if (@cb) {
674	$command{$name} = \@cb;	689	$COMMAND{$name} = \@cb;
675	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
676	} else {	690	} else {
677	delete $command{$name};
678	delete $COMMAND{"$name\000"};	691	delete $COMMAND{$name};
679	}	692	}
680	}	693	}
681		694
682	# remove extcmds	695	# remove extcmds
683	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	696	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
684	delete $extcmd{$name};	697	delete $EXTCMD{$name};
685	}	698	}
686		699
687	if (my $cb = $pkg->can ("unload")) {	700	if (my $cb = $pkg->can ("unload")) {
688	eval {	701	eval {
689	$cb->($pkg);	702	$cb->($pkg);
…		…
693		706
694	Symbol::delete_package $pkg;	707	Symbol::delete_package $pkg;
695	}	708	}
696		709
697	sub load_extensions {	710	sub load_extensions {
698	my $LIBDIR = maps_directory "perl";
699
700	for my $ext (<$LIBDIR/*.ext>) {	711	for my $ext (<$LIBDIR/*.ext>) {
701	next unless -r $ext;	712	next unless -r $ext;
702	eval {	713	eval {
703	load_extension $ext;	714	load_extension $ext;
704	1	715	1
705	} or warn "$ext not loaded: $@";	716	} or warn "$ext not loaded: $@";
706	}	717	}
707	}	718	}
708		719
709	#############################################################################	720	#############################################################################
710	# extcmd framework, basically convert ext <msg>
711	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
712
713	attach_to_players
714	on_extcmd => sub {
715	my ($pl, $buf) = @_;
716
717	my $msg = eval { from_json $buf };
718
719	if (ref $msg) {
720	if (my $cb = $extcmd{$msg->{msgtype}}) {
721	if (my %reply = $cb->[0]->($pl, $msg)) {
722	$pl->ext_reply ($msg->{msgid}, %reply);
723	}
724	}
725	} else {
726	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
727	}
728
729	cf::override;
730	},
731	;
732
733	#############################################################################
734	# load/save/clean perl data associated with a map	721	# load/save/clean perl data associated with a map
735		722
736	*cf::mapsupport::on_clean = sub {	723	*cf::mapsupport::on_clean = sub {
737	my ($map) = @_;	724	my ($map) = @_;
738		725
…		…
740	defined $path or return;	727	defined $path or return;
741		728
742	unlink "$path.pst";	729	unlink "$path.pst";
743	};	730	};
744		731
745	attach_to_maps prio => -10000, package => cf::mapsupport::;	732	cf::map->attach (prio => -10000, package => cf::mapsupport::);
746		733
747	#############################################################################	734	#############################################################################
748	# load/save perl data associated with player->ob objects	735	# load/save perl data associated with player->ob objects
749		736
750	sub all_objects(@) {	737	sub all_objects(@) {
751	@_, map all_objects ($_->inv), @_	738	@_, map all_objects ($_->inv), @_
752	}	739	}
753		740
754	# TODO: compatibility cruft, remove when no longer needed	741	# TODO: compatibility cruft, remove when no longer needed
755	attach_to_players	742	cf::player->attach (
756	on_load => sub {	743	on_load => sub {
757	my ($pl, $path) = @_;	744	my ($pl, $path) = @_;
758		745
759	for my $o (all_objects $pl->ob) {	746	for my $o (all_objects $pl->ob) {
760	if (my $value = $o->get_ob_key_value ("_perl_data")) {	747	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
762		749
763	%$o = %{ Storable::thaw pack "H*", $value };	750	%$o = %{ Storable::thaw pack "H*", $value };
764	}	751	}
765	}	752	}
766	},	753	},
767	;	754	);
768		755
769	#############################################################################	756	#############################################################################
770		757
771	=head2 CORE EXTENSIONS	758	=head2 CORE EXTENSIONS
772		759
773	Functions and methods that extend core crossfire objects.	760	Functions and methods that extend core crossfire objects.
		761
		762	=head3 cf::player
774		763
775	=over 4	764	=over 4
776		765
777	=item cf::player::exists $login	766	=item cf::player::exists $login
778		767
…		…
783	sub cf::player::exists($) {	772	sub cf::player::exists($) {
784	cf::player::find $_[0]	773	cf::player::find $_[0]
785	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	774	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
786	}	775	}
787		776
		777	=item $player->ext_reply ($msgid, $msgtype, %msg)
		778
		779	Sends an ext reply to the player.
		780
		781	=cut
		782
		783	sub cf::player::ext_reply($$$%) {
		784	my ($self, $id, %msg) = @_;
		785
		786	$msg{msgid} = $id;
		787
		788	$self->send ("ext " . to_json \%msg);
		789	}
		790
		791	=back
		792
		793	=head3 cf::object::player
		794
		795	=over 4
		796
788	=item $player_object->reply ($npc, $msg[, $flags])	797	=item $player_object->reply ($npc, $msg[, $flags])
789		798
790	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	799	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
791	can be C<undef>. Does the right thing when the player is currently in a	800	can be C<undef>. Does the right thing when the player is currently in a
792	dialogue with the given NPC character.	801	dialogue with the given NPC character.
793		802
794	=cut	803	=cut
795		804
796	# rough implementation of a future "reply" method that works	805	# rough implementation of a future "reply" method that works
797	# with dialog boxes.	806	# with dialog boxes.
		807	#TODO: the first argument must go, split into a $npc->reply_to ( method
798	sub cf::object::player::reply($$$;$) {	808	sub cf::object::player::reply($$$;$) {
799	my ($self, $npc, $msg, $flags) = @_;	809	my ($self, $npc, $msg, $flags) = @_;
800		810
801	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	811	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
802		812
…		…
806	$msg = $npc->name . " says: $msg" if $npc;	816	$msg = $npc->name . " says: $msg" if $npc;
807	$self->message ($msg, $flags);	817	$self->message ($msg, $flags);
808	}	818	}
809	}	819	}
810		820
811	=item $player->ext_reply ($msgid, $msgtype, %msg)
812
813	Sends an ext reply to the player.
814
815	=cut
816
817	sub cf::player::ext_reply($$$%) {
818	my ($self, $id, %msg) = @_;
819
820	$msg{msgid} = $id;
821
822	$self->send ("ext " . to_json \%msg);
823	}
824
825	=item $player_object->may ("access")	821	=item $player_object->may ("access")
826		822
827	Returns wether the given player is authorized to access resource "access"	823	Returns wether the given player is authorized to access resource "access"
828	(e.g. "command_wizcast").	824	(e.g. "command_wizcast").
829		825
…		…
836	(ref $cf::CFG{"may_$access"}	832	(ref $cf::CFG{"may_$access"}
837	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	833	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
838	: $cf::CFG{"may_$access"})	834	: $cf::CFG{"may_$access"})
839	}	835	}
840		836
841	=cut	837	=head3 cf::client
842		838
843	#############################################################################	839	=over 4
		840
		841	=item $client->send_drawinfo ($text, $flags)
		842
		843	Sends a drawinfo packet to the client. Circumvents output buffering so
		844	should not be used under normal circumstances.
		845
		846	=cut
		847
		848	sub cf::client::send_drawinfo {
		849	my ($self, $text, $flags) = @_;
		850
		851	utf8::encode $text;
		852	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		853	}
		854
		855
		856	=item $success = $client->query ($flags, "text", \&cb)
		857
		858	Queues a query to the client, calling the given callback with
		859	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		860	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		861
		862	Queries can fail, so check the return code. Or don't, as queries will become
		863	reliable at some point in the future.
		864
		865	=cut
		866
		867	sub cf::client::query {
		868	my ($self, $flags, $text, $cb) = @_;
		869
		870	return unless $self->state == ST_PLAYING
		871	\|\| $self->state == ST_SETUP
		872	\|\| $self->state == ST_CUSTOM;
		873
		874	$self->state (ST_CUSTOM);
		875
		876	utf8::encode $text;
		877	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		878
		879	$self->send_packet ($self->{query_queue}[0][0])
		880	if @{ $self->{query_queue} } == 1;
		881	}
		882
		883	cf::client->attach (
		884	on_reply => sub {
		885	my ($ns, $msg) = @_;
		886
		887	# this weird shuffling is so that direct followup queries
		888	# get handled first
		889	my $queue = delete $ns->{query_queue};
		890
		891	(shift @$queue)->[1]->($msg);
		892
		893	push @{ $ns->{query_queue} }, @$queue;
		894
		895	if (@{ $ns->{query_queue} } == @$queue) {
		896	if (@$queue) {
		897	$ns->send_packet ($ns->{query_queue}[0][0]);
		898	} else {
		899	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		900	}
		901	}
		902	},
		903	);
		904
		905	=item $client->coro (\&cb)
		906
		907	Create a new coroutine, running the specified callback. The coroutine will
		908	be automatically cancelled when the client gets destroyed (e.g. on logout,
		909	or loss of connection).
		910
		911	=cut
		912
		913	sub cf::client::coro {
		914	my ($self, $cb) = @_;
		915
		916	my $coro; $coro = async {
		917	eval {
		918	$cb->();
		919	};
		920	warn $@ if $@;
		921	delete $self->{_coro}{$coro+0};
		922	};
		923
		924	$self->{_coro}{$coro+0} = $coro;
		925	}
		926
		927	cf::client->attach (
		928	on_destroy => sub {
		929	my ($ns) = @_;
		930
		931	$_->cancel for values %{ (delete $ns->{_coro}) \|\| {} };
		932	},
		933	);
		934
		935	=back
		936
844		937
845	=head2 SAFE SCRIPTING	938	=head2 SAFE SCRIPTING
846		939
847	Functions that provide a safe environment to compile and execute	940	Functions that provide a safe environment to compile and execute
848	snippets of perl code without them endangering the safety of the server	941	snippets of perl code without them endangering the safety of the server
…		…
863		956
864	=pod	957	=pod
865		958
866	The following fucntions and emthods are available within a safe environment:	959	The following fucntions and emthods are available within a safe environment:
867		960
868	cf::object contr pay_amount pay_player	961	cf::object contr pay_amount pay_player map
869	cf::object::player player	962	cf::object::player player
870	cf::player peaceful	963	cf::player peaceful
		964	cf::map trigger
871		965
872	=cut	966	=cut
873		967
874	for (	968	for (
875	["cf::object" => qw(contr pay_amount pay_player)],	969	["cf::object" => qw(contr pay_amount pay_player map)],
876	["cf::object::player" => qw(player)],	970	["cf::object::player" => qw(player)],
877	["cf::player" => qw(peaceful)],	971	["cf::player" => qw(peaceful)],
		972	["cf::map" => qw(trigger)],
878	) {	973	) {
879	no strict 'refs';	974	no strict 'refs';
880	my ($pkg, @funs) = @$_;	975	my ($pkg, @funs) = @$_;
881	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	976	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
882	for @funs;	977	for @funs;
…		…
1022	sub db_sync() {	1117	sub db_sync() {
1023	db_save if $dirty;	1118	db_save if $dirty;
1024	undef $dirty;	1119	undef $dirty;
1025	}	1120	}
1026		1121
1027	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1122	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1028	db_sync;	1123	db_sync;
1029	});	1124	});
1030		1125
1031	sub db_dirty() {	1126	sub db_dirty() {
1032	$dirty = 1;	1127	$dirty = 1;
…		…
1046	$DB->{$_[0]} = $_[1];	1141	$DB->{$_[0]} = $_[1];
1047	}	1142	}
1048	db_dirty;	1143	db_dirty;
1049	}	1144	}
1050		1145
1051	attach_global	1146	cf::global->attach (
1052	prio => 10000,	1147	prio => 10000,
1053	on_cleanup => sub {	1148	on_cleanup => sub {
1054	db_sync;	1149	db_sync;
1055	},	1150	},
1056	;	1151	);
1057	}	1152	}
1058		1153
1059	#############################################################################	1154	#############################################################################
1060	# the server's main()	1155	# the server's main()
1061		1156
…		…
1082		1177
1083	$msg->("reloading...");	1178	$msg->("reloading...");
1084		1179
1085	eval {	1180	eval {
1086	# cancel all watchers	1181	# cancel all watchers
1087	$_->cancel for Event::all_watchers;	1182	for (Event::all_watchers) {
		1183	$_->cancel if $_->data & WF_AUTOCANCEL;
		1184	}
1088		1185
1089	# unload all extensions	1186	# unload all extensions
1090	for (@exts) {	1187	for (@exts) {
1091	$msg->("unloading <$_>");	1188	$msg->("unloading <$_>");
1092	unload_extension $_;	1189	unload_extension $_;
…		…
1127	#Symbol::delete_package __PACKAGE__;	1224	#Symbol::delete_package __PACKAGE__;
1128		1225
1129	# reload cf.pm	1226	# reload cf.pm
1130	$msg->("reloading cf.pm");	1227	$msg->("reloading cf.pm");
1131	require cf;	1228	require cf;
		1229	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1132		1230
1133	# load config and database again	1231	# load config and database again
1134	cf::cfg_load;	1232	cf::cfg_load;
1135	cf::db_load;	1233	cf::db_load;
1136		1234
…		…
1152	warn $_[0];	1250	warn $_[0];
1153	print "$_[0]\n";	1251	print "$_[0]\n";
1154	};	1252	};
1155	}	1253	}
1156		1254
		1255	register "<global>", __PACKAGE__;
		1256
1157	register_command "perl-reload", 0, sub {	1257	register_command "perl-reload" => sub {
1158	my ($who, $arg) = @_;	1258	my ($who, $arg) = @_;
1159		1259
1160	if ($who->flag (FLAG_WIZ)) {	1260	if ($who->flag (FLAG_WIZ)) {
1161	_perl_reload {	1261	_perl_reload {
1162	warn $_[0];	1262	warn $_[0];
1163	$who->message ($_[0]);	1263	$who->message ($_[0]);
1164	};	1264	};
1165	}	1265	}
1166	};	1266	};
1167		1267
1168	register "<global>", __PACKAGE__;
1169
1170	unshift @INC, $LIBDIR;	1268	unshift @INC, $LIBDIR;
1171		1269
1172	$TICK_WATCHER = Event->timer (	1270	$TICK_WATCHER = Event->timer (
1173	prio => 1,	1271	prio => 0,
1174	async => 1,
1175	at => $NEXT_TICK \|\| 1,	1272	at => $NEXT_TICK \|\| 1,
		1273	data => WF_AUTOCANCEL,
1176	cb => sub {	1274	cb => sub {
1177	cf::server_tick; # one server iteration	1275	cf::server_tick; # one server iteration
1178		1276
1179	my $NOW = Event::time;	1277	my $NOW = Event::time;
1180	$NEXT_TICK += $TICK;	1278	$NEXT_TICK += $TICK;
…		…
1190	IO::AIO::max_poll_time $TICK * 0.2;	1288	IO::AIO::max_poll_time $TICK * 0.2;
1191		1289
1192	Event->io (fd => IO::AIO::poll_fileno,	1290	Event->io (fd => IO::AIO::poll_fileno,
1193	poll => 'r',	1291	poll => 'r',
1194	prio => 5,	1292	prio => 5,
		1293	data => WF_AUTOCANCEL,
1195	cb => \&IO::AIO::poll_cb);	1294	cb => \&IO::AIO::poll_cb);
1196		1295
1197	1	1296	1
1198		1297

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.80 by root, Tue Nov 7 16:30:55 2006 UTC vs. Revision 1.102 by root, Wed Dec 27 15:20:54 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.80 by root, Tue Nov 7 16:30:55 2006 UTC vs.
Revision 1.102 by root, Wed Dec 27 15:20:54 2006 UTC