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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.85 by root, Mon Dec 11 22:56:57 2006 UTC vs.
Revision 1.101 by root, Mon Dec 25 14:43:23 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);
		29
		30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
20		31
21	our %COMMAND = ();	32	our %COMMAND = ();
22	our %COMMAND_TIME = ();	33	our %COMMAND_TIME = ();
23	our %EXTCMD = ();	34	our %EXTCMD = ();
24		35
25	_init_vars;
26
27	our @EVENT;	36	our @EVENT;
28	our $LIBDIR = maps_directory "perl";	37	our $LIBDIR = datadir . "/ext";
29		38
30	our $TICK = MAX_TIME * 1e-6;	39	our $TICK = MAX_TIME * 1e-6;
31	our $TICK_WATCHER;	40	our $TICK_WATCHER;
32	our $NEXT_TICK;	41	our $NEXT_TICK;
33		42
72	print STDERR "cfperl: $msg";	81	print STDERR "cfperl: $msg";
73	LOG llevError, "cfperl: $msg";	82	LOG llevError, "cfperl: $msg";
74	};	83	};
75	}	84	}
76		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';
77	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	91	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
78		92
79	# 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
80	# within the Safe compartment.	94	# within the Safe compartment.
81	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	)) {
82	no strict 'refs';	102	no strict 'refs';
83	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	103	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84	}	104	}
85		105
86	$Event::DIED = sub {	106	$Event::DIED = sub {
…		…
125		145
126	=cut	146	=cut
127		147
128	#############################################################################	148	#############################################################################
129		149
130	=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+).
131		159
132	=over 4	160	=over 4
133		161
134	=item $object->attach ($attachment, key => $value...)
135
136	=item $object->detach ($attachment)
137
138	Attach/detach a pre-registered attachment to an object.
139
140	=item $player->attach ($attachment, key => $value...)
141
142	=item $player->detach ($attachment)
143
144	Attach/detach a pre-registered attachment to a player.
145
146	=item $map->attach ($attachment, key => $value...)	162	=item $attachable->attach ($attachment, key => $value...)
147		163
148	=item $map->detach ($attachment)	164	=item $attachable->detach ($attachment)
149		165
150	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.
151		168
152	=item $bool = $object->attached ($name)	169	Example, attach a minesweeper attachment to the given object, making it a
		170	10x10 minesweeper game:
153		171
154	=item $bool = $player->attached ($name)	172	$obj->attach (minesweeper => width => 10, height => 10);
155		173
156	=item $bool = $map->attached ($name)	174	=item $bool = $attachable->attached ($name)
157		175
158	Checks wether the named attachment is currently attached to the object.	176	Checks wether the named attachment is currently attached to the object.
159		177
160	=item cf::attach_global ...	178	=item cf::CLASS->attach ...
161		179
162	Attach handlers for global events.	180	=item cf::CLASS->detach ...
163		181
164	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
165	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:
166		216
167	=over 4	217	=over 4
168		218
169	=item prio => $number	219	=item prio => $number
170		220
…		…
172	by another C<prio> setting). Lower priority handlers get executed	222	by another C<prio> setting). Lower priority handlers get executed
173	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
174	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
175	unless you know what you are doing.	225	unless you know what you are doing.
176		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
177	=item on_I<event> => \&cb	233	=item on_I<event> => \&cb
178		234
179	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
180	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
181	handlers are recognised generally depends on the type of object these	237	handlers are recognised generally depends on the type of object these
…		…
190	package and register them. Only handlers for eevents supported by the	246	package and register them. Only handlers for eevents supported by the
191	object/class are recognised.	247	object/class are recognised.
192		248
193	=back	249	=back
194		250
195	=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:
196		253
197	Attach handlers for a specific object type (e.g. TRANSPORT) and	254	cf::object::attachment sockpuppet =>
198	subtype. If C<$subtype> is zero or undef, matches all objects of the given	255	on_skill_attack => sub {
199	type.	256	my ($self, $victim) = @_;
200		257	...
201	=item cf::attach_to_objects ...
202
203	Attach handlers to all objects. Do not use this except for debugging or
204	very rare events, as handlers are (obviously) called for I<all> objects in
205	the game.
206
207	=item cf::attach_to_players ...
208
209	Attach handlers to all players.
210
211	=item cf::attach_to_maps ...
212
213	Attach handlers to all maps.
214
215	=item cf:register_attachment $name, ...
216
217	Register an attachment by name through which objects can refer to this
218	attachment.
219
220	=item cf:register_player_attachment $name, ...
221
222	Register an attachment by name through which players can refer to this
223	attachment.
224
225	=item cf:register_map_attachment $name, ...
226
227	Register an attachment by name through which maps can refer to this
228	attachment.
229
230	=cut
231
232	# the following variables are defined in .xs and must not be re-created
233	our @CB_GLOBAL = (); # registry for all global events
234	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
235	our @CB_PLAYER = ();
236	our @CB_TYPE = (); # registry for type (cf-object class) based events
237	our @CB_MAP = ();
238
239	my %attachment;
240
241	sub _attach_cb($\%$$$) {
242	my ($registry, $undo, $event, $prio, $cb) = @_;
243
244	use sort 'stable';
245
246	$cb = [$prio, $cb];
247
248	@{$registry->[$event]} = sort
249	{ $a->[0] cmp $b->[0] }
250	@{$registry->[$event] \|\| []}, $cb;
251
252	push @{$undo->{cb}}, [$event, $cb];
253	}
254
255	# attach handles attaching event callbacks
256	# the only thing the caller has to do is pass the correct
257	# registry (== where the callback attaches to).
258	sub _attach(\@$@) {
259	my ($registry, $klass, @arg) = @_;
260
261	my $prio = 0;
262
263	my %undo = (
264	registry => $registry,
265	cb => [],
266	);
267
268	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
269
270	while (@arg) {
271	my $type = shift @arg;
272
273	if ($type eq "prio") {
274	$prio = shift @arg;
275
276	} elsif ($type eq "package") {
277	my $pkg = shift @arg;
278
279	while (my ($name, $id) = each %cb_id) {
280	if (my $cb = $pkg->can ($name)) {
281	_attach_cb $registry, %undo, $id, $prio, $cb;
282	}
283	}	258	}
284
285	} elsif (exists $cb_id{$type}) {
286	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
287
288	} elsif (ref $type) {
289	warn "attaching objects not supported, ignoring.\n";
290
291	} else {
292	shift @arg;
293	warn "attach argument '$type' not supported, ignoring.\n";
294	}
295	}
296
297	\%undo
298	}
299
300	sub _attach_attachment {
301	my ($obj, $name, %arg) = @_;
302
303	return if exists $obj->{_attachment}{$name};
304
305	my $res;
306
307	if (my $attach = $attachment{$name}) {
308	my $registry = $obj->registry;
309
310	for (@$attach) {
311	my ($klass, @attach) = @$_;
312	$res = _attach @$registry, $klass, @attach;
313	}
314
315	$obj->{$name} = \%arg;
316	} else {
317	warn "object uses attachment '$name' that is not available, postponing.\n";
318	}
319
320	$obj->{_attachment}{$name} = undef;
321
322	$res->{attachment} = $name;
323	$res
324	}
325
326	*cf::object::attach =
327	*cf::player::attach =
328	*cf::map::attach = sub {
329	my ($obj, $name, %arg) = @_;
330
331	_attach_attachment $obj, $name, %arg;
332	};
333
334	# all those should be optimised
335	*cf::object::detach =
336	*cf::player::detach =
337	*cf::map::detach = sub {
338	my ($obj, $name) = @_;
339
340	delete $obj->{_attachment}{$name};
341	reattach ($obj);
342	};
343
344	*cf::object::attached =
345	*cf::player::attached =
346	*cf::map::attached = sub {
347	my ($obj, $name) = @_;
348
349	exists $obj->{_attachment}{$name}
350	};
351
352	sub attach_global {
353	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
354	}
355
356	sub attach_to_type {
357	my $type = shift;
358	my $subtype = shift;
359
360	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
361	}
362
363	sub attach_to_objects {
364	_attach @CB_OBJECT, KLASS_OBJECT, @_
365	}
366
367	sub attach_to_players {
368	_attach @CB_PLAYER, KLASS_PLAYER, @_
369	}
370
371	sub attach_to_maps {
372	_attach @CB_MAP, KLASS_MAP, @_
373	}
374
375	sub register_attachment {
376	my $name = shift;
377
378	$attachment{$name} = [[KLASS_OBJECT, @_]];
379	}
380
381	sub register_player_attachment {
382	my $name = shift;
383
384	$attachment{$name} = [[KLASS_PLAYER, @_]];
385	}
386
387	sub register_map_attachment {
388	my $name = shift;
389
390	$attachment{$name} = [[KLASS_MAP, @_]];
391	}
392
393	our $override;
394	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
395
396	sub override {
397	$override = 1;
398	@invoke_results = ();
399	}
400
401	sub do_invoke {
402	my $event = shift;
403	my $callbacks = shift;
404
405	@invoke_results = ();
406
407	local $override;
408
409	for (@$callbacks) {
410	eval { &{$_->[1]} };
411
412	if ($@) {
413	warn "$@";
414	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
415	override;
416	}
417
418	return 1 if $override;
419	}
420
421	0	259	}
422	}
423		260
424	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	261	=item $attachable->valid
425
426	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
427
428	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
429
430	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
431
432	Generate a global/object/player/map-specific event with the given arguments.
433
434	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
435	removed in future versions), and there is no public API to access override
436	results (if you must, access C<@cf::invoke_results> directly).
437
438	=back
439
440	=cut
441
442	#############################################################################
443
444	=head2 METHODS VALID FOR ALL CORE OBJECTS
445
446	=over 4
447
448	=item $object->valid, $player->valid, $map->valid
449		262
450	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
451	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
452	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
453	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
454	exception.	267	exception.
455		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
456	=back	452	=back
457		453
458	=cut	454	=cut
459
460	*cf::object::valid =
461	*cf::player::valid =
462	*cf::map::valid = \&cf::_valid;
463		455
464	#############################################################################	456	#############################################################################
465	# object support	457	# object support
466		458
467	sub instantiate {	459	cf::attachable->attach (
		460	prio => -1000000,
		461	on_instantiate => sub {
468	my ($obj, $data) = @_;	462	my ($obj, $data) = @_;
469		463
470	$data = from_json $data;	464	$data = from_json $data;
471		465
472	for (@$data) {	466	for (@$data) {
473	my ($name, $args) = @$_;	467	my ($name, $args) = @$_;
474		468
475	$obj->attach ($name, %{$args \|\| {} });	469	$obj->attach ($name, %{$args \|\| {} });
		470	}
476	}	471	},
477	}	472	on_reattach => sub {
478
479	# basically do the same as instantiate, without calling instantiate	473	# basically do the same as instantiate, without calling instantiate
480	sub reattach {
481	my ($obj) = @_;	474	my ($obj) = @_;
482	my $registry = $obj->registry;	475	my $registry = $obj->registry;
483		476
484	@$registry = ();	477	@$registry = ();
485		478
486	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };	479	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
487		480
488	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	481	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
489	if (my $attach = $attachment{$name}) {	482	if (my $attach = $attachment{$name}) {
490	for (@$attach) {	483	for (@$attach) {
491	my ($klass, @attach) = @$_;	484	my ($klass, @attach) = @$_;
492	_attach @$registry, $klass, @attach;	485	_attach $registry, $klass, @attach;
		486	}
		487	} else {
		488	warn "object uses attachment '$name' that is not available, postponing.\n";
493	}	489	}
494	} else {
495	warn "object uses attachment '$name' that is not available, postponing.\n";
496	}	490	}
497	}	491	},
498	}	492	on_clone => sub {
		493	my ($src, $dst) = @_;
		494
		495	@{$dst->registry} = @{$src->registry};
		496
		497	%$dst = %$src;
		498
		499	%{$dst->{_attachment}} = %{$src->{_attachment}}
		500	if exists $src->{_attachment};
		501	},
		502	);
499		503
500	sub object_freezer_save {	504	sub object_freezer_save {
501	my ($filename, $rdata, $objs) = @_;	505	my ($filename, $rdata, $objs) = @_;
502		506
503	if (length $$rdata) {	507	if (length $$rdata) {
…		…
553	}	557	}
554		558
555	()	559	()
556	}	560	}
557		561
558	attach_to_objects
559	prio => -1000000,
560	on_clone => sub {
561	my ($src, $dst) = @_;
562
563	@{$dst->registry} = @{$src->registry};
564
565	%$dst = %$src;
566
567	%{$dst->{_attachment}} = %{$src->{_attachment}}
568	if exists $src->{_attachment};
569	},
570	;
571
572	#############################################################################	562	#############################################################################
573	# command handling &c	563	# command handling &c
574		564
575	=item cf::register_command $name => \&callback($ob,$args);	565	=item cf::register_command $name => \&callback($ob,$args);
576		566
…		…
604	#warn "registering extcmd '$name' to '$caller'";	594	#warn "registering extcmd '$name' to '$caller'";
605		595
606	$EXTCMD{$name} = [$cb, $caller];	596	$EXTCMD{$name} = [$cb, $caller];
607	}	597	}
608		598
609	attach_to_players	599	cf::player->attach (
610	on_command => sub {	600	on_command => sub {
611	my ($pl, $name, $params) = @_;	601	my ($pl, $name, $params) = @_;
612		602
613	my $cb = $COMMAND{$name}	603	my $cb = $COMMAND{$name}
614	or return;	604	or return;
…		…
634	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	624	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
635	}	625	}
636		626
637	cf::override;	627	cf::override;
638	},	628	},
639	;	629	);
640		630
641	sub register {	631	sub register {
642	my ($base, $pkg) = @_;	632	my ($base, $pkg) = @_;
643		633
644	#TODO	634	#TODO
…		…
713		703
714	Symbol::delete_package $pkg;	704	Symbol::delete_package $pkg;
715	}	705	}
716		706
717	sub load_extensions {	707	sub load_extensions {
718	my $LIBDIR = maps_directory "perl";
719
720	for my $ext (<$LIBDIR/*.ext>) {	708	for my $ext (<$LIBDIR/*.ext>) {
721	next unless -r $ext;	709	next unless -r $ext;
722	eval {	710	eval {
723	load_extension $ext;	711	load_extension $ext;
724	1	712	1
…		…
736	defined $path or return;	724	defined $path or return;
737		725
738	unlink "$path.pst";	726	unlink "$path.pst";
739	};	727	};
740		728
741	attach_to_maps prio => -10000, package => cf::mapsupport::;	729	cf::map->attach (prio => -10000, package => cf::mapsupport::);
742		730
743	#############################################################################	731	#############################################################################
744	# load/save perl data associated with player->ob objects	732	# load/save perl data associated with player->ob objects
745		733
746	sub all_objects(@) {	734	sub all_objects(@) {
747	@_, map all_objects ($_->inv), @_	735	@_, map all_objects ($_->inv), @_
748	}	736	}
749		737
750	# TODO: compatibility cruft, remove when no longer needed	738	# TODO: compatibility cruft, remove when no longer needed
751	attach_to_players	739	cf::player->attach (
752	on_load => sub {	740	on_load => sub {
753	my ($pl, $path) = @_;	741	my ($pl, $path) = @_;
754		742
755	for my $o (all_objects $pl->ob) {	743	for my $o (all_objects $pl->ob) {
756	if (my $value = $o->get_ob_key_value ("_perl_data")) {	744	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
758		746
759	%$o = %{ Storable::thaw pack "H*", $value };	747	%$o = %{ Storable::thaw pack "H*", $value };
760	}	748	}
761	}	749	}
762	},	750	},
763	;	751	);
764		752
765	#############################################################################	753	#############################################################################
766		754
767	=head2 CORE EXTENSIONS	755	=head2 CORE EXTENSIONS
768		756
769	Functions and methods that extend core crossfire objects.	757	Functions and methods that extend core crossfire objects.
		758
		759	=head3 cf::player
770		760
771	=over 4	761	=over 4
772		762
773	=item cf::player::exists $login	763	=item cf::player::exists $login
774		764
…		…
779	sub cf::player::exists($) {	769	sub cf::player::exists($) {
780	cf::player::find $_[0]	770	cf::player::find $_[0]
781	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	771	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
782	}	772	}
783		773
		774	=item $player->ext_reply ($msgid, $msgtype, %msg)
		775
		776	Sends an ext reply to the player.
		777
		778	=cut
		779
		780	sub cf::player::ext_reply($$$%) {
		781	my ($self, $id, %msg) = @_;
		782
		783	$msg{msgid} = $id;
		784
		785	$self->send ("ext " . to_json \%msg);
		786	}
		787
		788	=back
		789
		790	=head3 cf::object::player
		791
		792	=over 4
		793
784	=item $player_object->reply ($npc, $msg[, $flags])	794	=item $player_object->reply ($npc, $msg[, $flags])
785		795
786	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	796	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
787	can be C<undef>. Does the right thing when the player is currently in a	797	can be C<undef>. Does the right thing when the player is currently in a
788	dialogue with the given NPC character.	798	dialogue with the given NPC character.
789		799
790	=cut	800	=cut
791		801
792	# rough implementation of a future "reply" method that works	802	# rough implementation of a future "reply" method that works
793	# with dialog boxes.	803	# with dialog boxes.
		804	#TODO: the first argument must go, split into a $npc->reply_to ( method
794	sub cf::object::player::reply($$$;$) {	805	sub cf::object::player::reply($$$;$) {
795	my ($self, $npc, $msg, $flags) = @_;	806	my ($self, $npc, $msg, $flags) = @_;
796		807
797	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	808	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
798		809
…		…
802	$msg = $npc->name . " says: $msg" if $npc;	813	$msg = $npc->name . " says: $msg" if $npc;
803	$self->message ($msg, $flags);	814	$self->message ($msg, $flags);
804	}	815	}
805	}	816	}
806		817
807	=item $player->ext_reply ($msgid, $msgtype, %msg)
808
809	Sends an ext reply to the player.
810
811	=cut
812
813	sub cf::player::ext_reply($$$%) {
814	my ($self, $id, %msg) = @_;
815
816	$msg{msgid} = $id;
817
818	$self->send ("ext " . to_json \%msg);
819	}
820
821	=item $player_object->may ("access")	818	=item $player_object->may ("access")
822		819
823	Returns wether the given player is authorized to access resource "access"	820	Returns wether the given player is authorized to access resource "access"
824	(e.g. "command_wizcast").	821	(e.g. "command_wizcast").
825		822
…		…
832	(ref $cf::CFG{"may_$access"}	829	(ref $cf::CFG{"may_$access"}
833	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	830	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
834	: $cf::CFG{"may_$access"})	831	: $cf::CFG{"may_$access"})
835	}	832	}
836		833
837	=cut	834	=head3 cf::client
838		835
839	#############################################################################	836	=over 4
		837
		838	=item $client->send_drawinfo ($text, $flags)
		839
		840	Sends a drawinfo packet to the client. Circumvents output buffering so
		841	should not be used under normal circumstances.
		842
		843	=cut
		844
		845	sub cf::client::send_drawinfo {
		846	my ($self, $text, $flags) = @_;
		847
		848	utf8::encode $text;
		849	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		850	}
		851
		852
		853	=item $success = $client->query ($flags, "text", \&cb)
		854
		855	Queues a query to the client, calling the given callback with
		856	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		857	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		858
		859	Queries can fail, so check the return code. Or don't, as queries will become
		860	reliable at some point in the future.
		861
		862	=cut
		863
		864	sub cf::client::query {
		865	my ($self, $flags, $text, $cb) = @_;
		866
		867	return unless $self->state == ST_PLAYING
		868	\|\| $self->state == ST_SETUP
		869	\|\| $self->state == ST_CUSTOM;
		870
		871	$self->state (ST_CUSTOM);
		872
		873	utf8::encode $text;
		874	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		875
		876	$self->send_packet ($self->{query_queue}[0][0])
		877	if @{ $self->{query_queue} } == 1;
		878	}
		879
		880	cf::client->attach (
		881	on_reply => sub {
		882	my ($ns, $msg) = @_;
		883
		884	# this weird shuffling is so that direct followup queries
		885	# get handled first
		886	my $queue = delete $ns->{query_queue};
		887
		888	(shift @$queue)->[1]->($msg);
		889
		890	push @{ $ns->{query_queue} }, @$queue;
		891
		892	if (@{ $ns->{query_queue} } == @$queue) {
		893	if (@$queue) {
		894	$ns->send_packet ($ns->{query_queue}[0][0]);
		895	} else {
		896	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		897	}
		898	}
		899	},
		900	);
		901
		902	=item $client->coro (\&cb)
		903
		904	Create a new coroutine, running the specified callback. The coroutine will
		905	be automatically cancelled when the client gets destroyed (e.g. on logout,
		906	or loss of connection).
		907
		908	=cut
		909
		910	sub cf::client::coro {
		911	my ($self, $cb) = @_;
		912
		913	my $coro; $coro = async {
		914	eval {
		915	$cb->();
		916	};
		917	warn $@ if $@;
		918	delete $self->{_coro}{$coro+0};
		919	};
		920
		921	$self->{_coro}{$coro+0} = $coro;
		922	}
		923
		924	cf::client->attach (
		925	on_destroy => sub {
		926	my ($ns) = @_;
		927
		928	$_->cancel for values %{ (delete $ns->{_coro}) \|\| {} };
		929	},
		930	);
		931
		932	=back
		933
840		934
841	=head2 SAFE SCRIPTING	935	=head2 SAFE SCRIPTING
842		936
843	Functions that provide a safe environment to compile and execute	937	Functions that provide a safe environment to compile and execute
844	snippets of perl code without them endangering the safety of the server	938	snippets of perl code without them endangering the safety of the server
…		…
859		953
860	=pod	954	=pod
861		955
862	The following fucntions and emthods are available within a safe environment:	956	The following fucntions and emthods are available within a safe environment:
863		957
864	cf::object contr pay_amount pay_player	958	cf::object contr pay_amount pay_player map
865	cf::object::player player	959	cf::object::player player
866	cf::player peaceful	960	cf::player peaceful
		961	cf::map trigger
867		962
868	=cut	963	=cut
869		964
870	for (	965	for (
871	["cf::object" => qw(contr pay_amount pay_player)],	966	["cf::object" => qw(contr pay_amount pay_player map)],
872	["cf::object::player" => qw(player)],	967	["cf::object::player" => qw(player)],
873	["cf::player" => qw(peaceful)],	968	["cf::player" => qw(peaceful)],
		969	["cf::map" => qw(trigger)],
874	) {	970	) {
875	no strict 'refs';	971	no strict 'refs';
876	my ($pkg, @funs) = @$_;	972	my ($pkg, @funs) = @$_;
877	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	973	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
878	for @funs;	974	for @funs;
…		…
1018	sub db_sync() {	1114	sub db_sync() {
1019	db_save if $dirty;	1115	db_save if $dirty;
1020	undef $dirty;	1116	undef $dirty;
1021	}	1117	}
1022		1118
1023	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1119	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1024	db_sync;	1120	db_sync;
1025	});	1121	});
1026		1122
1027	sub db_dirty() {	1123	sub db_dirty() {
1028	$dirty = 1;	1124	$dirty = 1;
…		…
1042	$DB->{$_[0]} = $_[1];	1138	$DB->{$_[0]} = $_[1];
1043	}	1139	}
1044	db_dirty;	1140	db_dirty;
1045	}	1141	}
1046		1142
1047	attach_global	1143	cf::global->attach (
1048	prio => 10000,	1144	prio => 10000,
1049	on_cleanup => sub {	1145	on_cleanup => sub {
1050	db_sync;	1146	db_sync;
1051	},	1147	},
1052	;	1148	);
1053	}	1149	}
1054		1150
1055	#############################################################################	1151	#############################################################################
1056	# the server's main()	1152	# the server's main()
1057		1153
…		…
1078		1174
1079	$msg->("reloading...");	1175	$msg->("reloading...");
1080		1176
1081	eval {	1177	eval {
1082	# cancel all watchers	1178	# cancel all watchers
1083	$_->cancel for Event::all_watchers;	1179	for (Event::all_watchers) {
		1180	$_->cancel if $_->data & WF_AUTOCANCEL;
		1181	}
1084		1182
1085	# unload all extensions	1183	# unload all extensions
1086	for (@exts) {	1184	for (@exts) {
1087	$msg->("unloading <$_>");	1185	$msg->("unloading <$_>");
1088	unload_extension $_;	1186	unload_extension $_;
…		…
1123	#Symbol::delete_package __PACKAGE__;	1221	#Symbol::delete_package __PACKAGE__;
1124		1222
1125	# reload cf.pm	1223	# reload cf.pm
1126	$msg->("reloading cf.pm");	1224	$msg->("reloading cf.pm");
1127	require cf;	1225	require cf;
		1226	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1128		1227
1129	# load config and database again	1228	# load config and database again
1130	cf::cfg_load;	1229	cf::cfg_load;
1131	cf::db_load;	1230	cf::db_load;
1132		1231
…		…
1164	};	1263	};
1165		1264
1166	unshift @INC, $LIBDIR;	1265	unshift @INC, $LIBDIR;
1167		1266
1168	$TICK_WATCHER = Event->timer (	1267	$TICK_WATCHER = Event->timer (
1169	prio => 1,	1268	prio => 0,
1170	async => 1,
1171	at => $NEXT_TICK \|\| 1,	1269	at => $NEXT_TICK \|\| 1,
		1270	data => WF_AUTOCANCEL,
1172	cb => sub {	1271	cb => sub {
1173	cf::server_tick; # one server iteration	1272	cf::server_tick; # one server iteration
1174		1273
1175	my $NOW = Event::time;	1274	my $NOW = Event::time;
1176	$NEXT_TICK += $TICK;	1275	$NEXT_TICK += $TICK;
…		…
1186	IO::AIO::max_poll_time $TICK * 0.2;	1285	IO::AIO::max_poll_time $TICK * 0.2;
1187		1286
1188	Event->io (fd => IO::AIO::poll_fileno,	1287	Event->io (fd => IO::AIO::poll_fileno,
1189	poll => 'r',	1288	poll => 'r',
1190	prio => 5,	1289	prio => 5,
		1290	data => WF_AUTOCANCEL,
1191	cb => \&IO::AIO::poll_cb);	1291	cb => \&IO::AIO::poll_cb);
1192		1292
1193	1	1293	1
1194		1294

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.85 by root, Mon Dec 11 22:56:57 2006 UTC vs. Revision 1.101 by root, Mon Dec 25 14:43:23 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.85 by root, Mon Dec 11 22:56:57 2006 UTC vs.
Revision 1.101 by root, Mon Dec 25 14:43:23 2006 UTC