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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.86 by root, Thu Dec 14 05:09:32 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);
		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(	95	for my $pkg (qw(
		96	cf::global cf::attachable
82	cf::object cf::object::player	97	cf::object cf::object::player
83	cf::client_socket cf::player	98	cf::client cf::player
84	cf::arch cf::living	99	cf::arch cf::living
85	cf::map cf::party cf::region	100	cf::map cf::party cf::region
86	)) {	101	)) {
87	no strict 'refs';	102	no strict 'refs';
88	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	103	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
…		…
130		145
131	=cut	146	=cut
132		147
133	#############################################################################	148	#############################################################################
134		149
135	=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+).
136		159
137	=over 4	160	=over 4
138		161
139	=item $object->attach ($attachment, key => $value...)
140
141	=item $object->detach ($attachment)
142
143	Attach/detach a pre-registered attachment to an object.
144
145	=item $player->attach ($attachment, key => $value...)
146
147	=item $player->detach ($attachment)
148
149	Attach/detach a pre-registered attachment to a player.
150
151	=item $map->attach ($attachment, key => $value...)	162	=item $attachable->attach ($attachment, key => $value...)
152		163
153	=item $map->detach ($attachment)	164	=item $attachable->detach ($attachment)
154		165
155	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.
156		168
157	=item $bool = $object->attached ($name)	169	Example, attach a minesweeper attachment to the given object, making it a
		170	10x10 minesweeper game:
158		171
159	=item $bool = $player->attached ($name)	172	$obj->attach (minesweeper => width => 10, height => 10);
160		173
161	=item $bool = $map->attached ($name)	174	=item $bool = $attachable->attached ($name)
162		175
163	Checks wether the named attachment is currently attached to the object.	176	Checks wether the named attachment is currently attached to the object.
164		177
165	=item cf::attach_global ...	178	=item cf::CLASS->attach ...
166		179
167	Attach handlers for global events.	180	=item cf::CLASS->detach ...
168		181
169	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
170	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:
171		216
172	=over 4	217	=over 4
173		218
174	=item prio => $number	219	=item prio => $number
175		220
…		…
177	by another C<prio> setting). Lower priority handlers get executed	222	by another C<prio> setting). Lower priority handlers get executed
178	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
179	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
180	unless you know what you are doing.	225	unless you know what you are doing.
181		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
182	=item on_I<event> => \&cb	233	=item on_I<event> => \&cb
183		234
184	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
185	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
186	handlers are recognised generally depends on the type of object these	237	handlers are recognised generally depends on the type of object these
…		…
195	package and register them. Only handlers for eevents supported by the	246	package and register them. Only handlers for eevents supported by the
196	object/class are recognised.	247	object/class are recognised.
197		248
198	=back	249	=back
199		250
200	=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:
201		253
202	Attach handlers for a specific object type (e.g. TRANSPORT) and	254	cf::object::attachment sockpuppet =>
203	subtype. If C<$subtype> is zero or undef, matches all objects of the given	255	on_skill_attack => sub {
204	type.	256	my ($self, $victim) = @_;
205		257	...
206	=item cf::attach_to_objects ...
207
208	Attach handlers to all objects. Do not use this except for debugging or
209	very rare events, as handlers are (obviously) called for I<all> objects in
210	the game.
211
212	=item cf::attach_to_players ...
213
214	Attach handlers to all players.
215
216	=item cf::attach_to_maps ...
217
218	Attach handlers to all maps.
219
220	=item cf:register_attachment $name, ...
221
222	Register an attachment by name through which objects can refer to this
223	attachment.
224
225	=item cf:register_player_attachment $name, ...
226
227	Register an attachment by name through which players can refer to this
228	attachment.
229
230	=item cf:register_map_attachment $name, ...
231
232	Register an attachment by name through which maps can refer to this
233	attachment.
234
235	=cut
236
237	# the following variables are defined in .xs and must not be re-created
238	our @CB_GLOBAL = (); # registry for all global events
239	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
240	our @CB_PLAYER = ();
241	our @CB_TYPE = (); # registry for type (cf-object class) based events
242	our @CB_MAP = ();
243
244	my %attachment;
245
246	sub _attach_cb($\%$$$) {
247	my ($registry, $undo, $event, $prio, $cb) = @_;
248
249	use sort 'stable';
250
251	$cb = [$prio, $cb];
252
253	@{$registry->[$event]} = sort
254	{ $a->[0] cmp $b->[0] }
255	@{$registry->[$event] \|\| []}, $cb;
256
257	push @{$undo->{cb}}, [$event, $cb];
258	}
259
260	# attach handles attaching event callbacks
261	# the only thing the caller has to do is pass the correct
262	# registry (== where the callback attaches to).
263	sub _attach(\@$@) {
264	my ($registry, $klass, @arg) = @_;
265
266	my $prio = 0;
267
268	my %undo = (
269	registry => $registry,
270	cb => [],
271	);
272
273	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
274
275	while (@arg) {
276	my $type = shift @arg;
277
278	if ($type eq "prio") {
279	$prio = shift @arg;
280
281	} elsif ($type eq "package") {
282	my $pkg = shift @arg;
283
284	while (my ($name, $id) = each %cb_id) {
285	if (my $cb = $pkg->can ($name)) {
286	_attach_cb $registry, %undo, $id, $prio, $cb;
287	}
288	}	258	}
289
290	} elsif (exists $cb_id{$type}) {
291	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
292
293	} elsif (ref $type) {
294	warn "attaching objects not supported, ignoring.\n";
295
296	} else {
297	shift @arg;
298	warn "attach argument '$type' not supported, ignoring.\n";
299	}
300	}
301
302	\%undo
303	}
304
305	sub _attach_attachment {
306	my ($obj, $name, %arg) = @_;
307
308	return if exists $obj->{_attachment}{$name};
309
310	my $res;
311
312	if (my $attach = $attachment{$name}) {
313	my $registry = $obj->registry;
314
315	for (@$attach) {
316	my ($klass, @attach) = @$_;
317	$res = _attach @$registry, $klass, @attach;
318	}
319
320	$obj->{$name} = \%arg;
321	} else {
322	warn "object uses attachment '$name' that is not available, postponing.\n";
323	}
324
325	$obj->{_attachment}{$name} = undef;
326
327	$res->{attachment} = $name;
328	$res
329	}
330
331	*cf::object::attach =
332	*cf::player::attach =
333	*cf::map::attach = sub {
334	my ($obj, $name, %arg) = @_;
335
336	_attach_attachment $obj, $name, %arg;
337	};
338
339	# all those should be optimised
340	*cf::object::detach =
341	*cf::player::detach =
342	*cf::map::detach = sub {
343	my ($obj, $name) = @_;
344
345	delete $obj->{_attachment}{$name};
346	reattach ($obj);
347	};
348
349	*cf::object::attached =
350	*cf::player::attached =
351	*cf::map::attached = sub {
352	my ($obj, $name) = @_;
353
354	exists $obj->{_attachment}{$name}
355	};
356
357	sub attach_global {
358	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
359	}
360
361	sub attach_to_type {
362	my $type = shift;
363	my $subtype = shift;
364
365	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
366	}
367
368	sub attach_to_objects {
369	_attach @CB_OBJECT, KLASS_OBJECT, @_
370	}
371
372	sub attach_to_players {
373	_attach @CB_PLAYER, KLASS_PLAYER, @_
374	}
375
376	sub attach_to_maps {
377	_attach @CB_MAP, KLASS_MAP, @_
378	}
379
380	sub register_attachment {
381	my $name = shift;
382
383	$attachment{$name} = [[KLASS_OBJECT, @_]];
384	}
385
386	sub register_player_attachment {
387	my $name = shift;
388
389	$attachment{$name} = [[KLASS_PLAYER, @_]];
390	}
391
392	sub register_map_attachment {
393	my $name = shift;
394
395	$attachment{$name} = [[KLASS_MAP, @_]];
396	}
397
398	our $override;
399	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
400
401	sub override {
402	$override = 1;
403	@invoke_results = ();
404	}
405
406	sub do_invoke {
407	my $event = shift;
408	my $callbacks = shift;
409
410	@invoke_results = ();
411
412	local $override;
413
414	for (@$callbacks) {
415	eval { &{$_->[1]} };
416
417	if ($@) {
418	warn "$@";
419	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
420	override;
421	}
422
423	return 1 if $override;
424	}
425
426	0	259	}
427	}
428		260
429	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	261	=item $attachable->valid
430
431	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
432
433	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
434
435	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
436
437	Generate a global/object/player/map-specific event with the given arguments.
438
439	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
440	removed in future versions), and there is no public API to access override
441	results (if you must, access C<@cf::invoke_results> directly).
442
443	=back
444
445	=cut
446
447	#############################################################################
448
449	=head2 METHODS VALID FOR ALL CORE OBJECTS
450
451	=over 4
452
453	=item $object->valid, $player->valid, $map->valid
454		262
455	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
456	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
457	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
458	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
459	exception.	267	exception.
460		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
461	=back	452	=back
462		453
463	=cut	454	=cut
464
465	*cf::object::valid =
466	*cf::player::valid =
467	*cf::map::valid = \&cf::_valid;
468		455
469	#############################################################################	456	#############################################################################
470	# object support	457	# object support
471		458
472	sub instantiate {
473	my ($obj, $data) = @_;
474
475	$data = from_json $data;
476
477	for (@$data) {
478	my ($name, $args) = @$_;
479
480	$obj->attach ($name, %{$args \|\| {} });
481	}
482	}
483
484	# basically do the same as instantiate, without calling instantiate
485	sub reattach {	459	sub reattach {
		460	# basically do the same as instantiate, without calling instantiate
486	my ($obj) = @_;	461	my ($obj) = @_;
		462
487	my $registry = $obj->registry;	463	my $registry = $obj->registry;
488		464
489	@$registry = ();	465	@$registry = ();
490		466
491	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };	467	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
492		468
493	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	469	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
494	if (my $attach = $attachment{$name}) {	470	if (my $attach = $attachment{$name}) {
495	for (@$attach) {	471	for (@$attach) {
496	my ($klass, @attach) = @$_;	472	my ($klass, @attach) = @$_;
497	_attach @$registry, $klass, @attach;	473	_attach $registry, $klass, @attach;
498	}	474	}
499	} else {	475	} else {
500	warn "object uses attachment '$name' that is not available, postponing.\n";	476	warn "object uses attachment '$name' that is not available, postponing.\n";
501	}	477	}
502	}	478	}
503	}	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	);
504		506
505	sub object_freezer_save {	507	sub object_freezer_save {
506	my ($filename, $rdata, $objs) = @_;	508	my ($filename, $rdata, $objs) = @_;
507		509
508	if (length $$rdata) {	510	if (length $$rdata) {
…		…
558	}	560	}
559		561
560	()	562	()
561	}	563	}
562		564
563	attach_to_objects
564	prio => -1000000,
565	on_clone => sub {
566	my ($src, $dst) = @_;
567
568	@{$dst->registry} = @{$src->registry};
569
570	%$dst = %$src;
571
572	%{$dst->{_attachment}} = %{$src->{_attachment}}
573	if exists $src->{_attachment};
574	},
575	;
576
577	#############################################################################	565	#############################################################################
578	# command handling &c	566	# command handling &c
579		567
580	=item cf::register_command $name => \&callback($ob,$args);	568	=item cf::register_command $name => \&callback($ob,$args);
581		569
…		…
609	#warn "registering extcmd '$name' to '$caller'";	597	#warn "registering extcmd '$name' to '$caller'";
610		598
611	$EXTCMD{$name} = [$cb, $caller];	599	$EXTCMD{$name} = [$cb, $caller];
612	}	600	}
613		601
614	attach_to_players	602	cf::player->attach (
615	on_command => sub {	603	on_command => sub {
616	my ($pl, $name, $params) = @_;	604	my ($pl, $name, $params) = @_;
617		605
618	my $cb = $COMMAND{$name}	606	my $cb = $COMMAND{$name}
619	or return;	607	or return;
…		…
639	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	627	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
640	}	628	}
641		629
642	cf::override;	630	cf::override;
643	},	631	},
644	;	632	);
645		633
646	sub register {	634	sub register {
647	my ($base, $pkg) = @_;	635	my ($base, $pkg) = @_;
648		636
649	#TODO	637	#TODO
…		…
718		706
719	Symbol::delete_package $pkg;	707	Symbol::delete_package $pkg;
720	}	708	}
721		709
722	sub load_extensions {	710	sub load_extensions {
723	my $LIBDIR = maps_directory "perl";
724
725	for my $ext (<$LIBDIR/*.ext>) {	711	for my $ext (<$LIBDIR/*.ext>) {
726	next unless -r $ext;	712	next unless -r $ext;
727	eval {	713	eval {
728	load_extension $ext;	714	load_extension $ext;
729	1	715	1
…		…
741	defined $path or return;	727	defined $path or return;
742		728
743	unlink "$path.pst";	729	unlink "$path.pst";
744	};	730	};
745		731
746	attach_to_maps prio => -10000, package => cf::mapsupport::;	732	cf::map->attach (prio => -10000, package => cf::mapsupport::);
747		733
748	#############################################################################	734	#############################################################################
749	# load/save perl data associated with player->ob objects	735	# load/save perl data associated with player->ob objects
750		736
751	sub all_objects(@) {	737	sub all_objects(@) {
752	@_, map all_objects ($_->inv), @_	738	@_, map all_objects ($_->inv), @_
753	}	739	}
754		740
755	# TODO: compatibility cruft, remove when no longer needed	741	# TODO: compatibility cruft, remove when no longer needed
756	attach_to_players	742	cf::player->attach (
757	on_load => sub {	743	on_load => sub {
758	my ($pl, $path) = @_;	744	my ($pl, $path) = @_;
759		745
760	for my $o (all_objects $pl->ob) {	746	for my $o (all_objects $pl->ob) {
761	if (my $value = $o->get_ob_key_value ("_perl_data")) {	747	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
763		749
764	%$o = %{ Storable::thaw pack "H*", $value };	750	%$o = %{ Storable::thaw pack "H*", $value };
765	}	751	}
766	}	752	}
767	},	753	},
768	;	754	);
769		755
770	#############################################################################	756	#############################################################################
771		757
772	=head2 CORE EXTENSIONS	758	=head2 CORE EXTENSIONS
773		759
774	Functions and methods that extend core crossfire objects.	760	Functions and methods that extend core crossfire objects.
		761
		762	=head3 cf::player
775		763
776	=over 4	764	=over 4
777		765
778	=item cf::player::exists $login	766	=item cf::player::exists $login
779		767
…		…
784	sub cf::player::exists($) {	772	sub cf::player::exists($) {
785	cf::player::find $_[0]	773	cf::player::find $_[0]
786	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;
787	}	775	}
788		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
789	=item $player_object->reply ($npc, $msg[, $flags])	797	=item $player_object->reply ($npc, $msg[, $flags])
790		798
791	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>
792	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
793	dialogue with the given NPC character.	801	dialogue with the given NPC character.
794		802
795	=cut	803	=cut
796		804
797	# rough implementation of a future "reply" method that works	805	# rough implementation of a future "reply" method that works
798	# with dialog boxes.	806	# with dialog boxes.
		807	#TODO: the first argument must go, split into a $npc->reply_to ( method
799	sub cf::object::player::reply($$$;$) {	808	sub cf::object::player::reply($$$;$) {
800	my ($self, $npc, $msg, $flags) = @_;	809	my ($self, $npc, $msg, $flags) = @_;
801		810
802	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	811	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
803		812
…		…
807	$msg = $npc->name . " says: $msg" if $npc;	816	$msg = $npc->name . " says: $msg" if $npc;
808	$self->message ($msg, $flags);	817	$self->message ($msg, $flags);
809	}	818	}
810	}	819	}
811		820
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")	821	=item $player_object->may ("access")
827		822
828	Returns wether the given player is authorized to access resource "access"	823	Returns wether the given player is authorized to access resource "access"
829	(e.g. "command_wizcast").	824	(e.g. "command_wizcast").
830		825
…		…
837	(ref $cf::CFG{"may_$access"}	832	(ref $cf::CFG{"may_$access"}
838	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	833	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839	: $cf::CFG{"may_$access"})	834	: $cf::CFG{"may_$access"})
840	}	835	}
841		836
842	=cut	837	=head3 cf::client
843		838
844	#############################################################################	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
845		937
846	=head2 SAFE SCRIPTING	938	=head2 SAFE SCRIPTING
847		939
848	Functions that provide a safe environment to compile and execute	940	Functions that provide a safe environment to compile and execute
849	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
…		…
864		956
865	=pod	957	=pod
866		958
867	The following fucntions and emthods are available within a safe environment:	959	The following fucntions and emthods are available within a safe environment:
868		960
869	cf::object contr pay_amount pay_player	961	cf::object contr pay_amount pay_player map
870	cf::object::player player	962	cf::object::player player
871	cf::player peaceful	963	cf::player peaceful
		964	cf::map trigger
872		965
873	=cut	966	=cut
874		967
875	for (	968	for (
876	["cf::object" => qw(contr pay_amount pay_player)],	969	["cf::object" => qw(contr pay_amount pay_player map)],
877	["cf::object::player" => qw(player)],	970	["cf::object::player" => qw(player)],
878	["cf::player" => qw(peaceful)],	971	["cf::player" => qw(peaceful)],
		972	["cf::map" => qw(trigger)],
879	) {	973	) {
880	no strict 'refs';	974	no strict 'refs';
881	my ($pkg, @funs) = @$_;	975	my ($pkg, @funs) = @$_;
882	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	976	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883	for @funs;	977	for @funs;
…		…
1023	sub db_sync() {	1117	sub db_sync() {
1024	db_save if $dirty;	1118	db_save if $dirty;
1025	undef $dirty;	1119	undef $dirty;
1026	}	1120	}
1027		1121
1028	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 {
1029	db_sync;	1123	db_sync;
1030	});	1124	});
1031		1125
1032	sub db_dirty() {	1126	sub db_dirty() {
1033	$dirty = 1;	1127	$dirty = 1;
…		…
1047	$DB->{$_[0]} = $_[1];	1141	$DB->{$_[0]} = $_[1];
1048	}	1142	}
1049	db_dirty;	1143	db_dirty;
1050	}	1144	}
1051		1145
1052	attach_global	1146	cf::global->attach (
1053	prio => 10000,	1147	prio => 10000,
1054	on_cleanup => sub {	1148	on_cleanup => sub {
1055	db_sync;	1149	db_sync;
1056	},	1150	},
1057	;	1151	);
1058	}	1152	}
1059		1153
1060	#############################################################################	1154	#############################################################################
1061	# the server's main()	1155	# the server's main()
1062		1156
…		…
1083		1177
1084	$msg->("reloading...");	1178	$msg->("reloading...");
1085		1179
1086	eval {	1180	eval {
1087	# cancel all watchers	1181	# cancel all watchers
1088	$_->cancel for Event::all_watchers;	1182	for (Event::all_watchers) {
		1183	$_->cancel if $_->data & WF_AUTOCANCEL;
		1184	}
1089		1185
1090	# unload all extensions	1186	# unload all extensions
1091	for (@exts) {	1187	for (@exts) {
1092	$msg->("unloading <$_>");	1188	$msg->("unloading <$_>");
1093	unload_extension $_;	1189	unload_extension $_;
…		…
1128	#Symbol::delete_package __PACKAGE__;	1224	#Symbol::delete_package __PACKAGE__;
1129		1225
1130	# reload cf.pm	1226	# reload cf.pm
1131	$msg->("reloading cf.pm");	1227	$msg->("reloading cf.pm");
1132	require cf;	1228	require cf;
		1229	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1133		1230
1134	# load config and database again	1231	# load config and database again
1135	cf::cfg_load;	1232	cf::cfg_load;
1136	cf::db_load;	1233	cf::db_load;
1137		1234
…		…
1169	};	1266	};
1170		1267
1171	unshift @INC, $LIBDIR;	1268	unshift @INC, $LIBDIR;
1172		1269
1173	$TICK_WATCHER = Event->timer (	1270	$TICK_WATCHER = Event->timer (
1174	prio => 1,	1271	prio => 0,
1175	async => 1,
1176	at => $NEXT_TICK \|\| 1,	1272	at => $NEXT_TICK \|\| 1,
		1273	data => WF_AUTOCANCEL,
1177	cb => sub {	1274	cb => sub {
1178	cf::server_tick; # one server iteration	1275	cf::server_tick; # one server iteration
1179		1276
1180	my $NOW = Event::time;	1277	my $NOW = Event::time;
1181	$NEXT_TICK += $TICK;	1278	$NEXT_TICK += $TICK;
…		…
1191	IO::AIO::max_poll_time $TICK * 0.2;	1288	IO::AIO::max_poll_time $TICK * 0.2;
1192		1289
1193	Event->io (fd => IO::AIO::poll_fileno,	1290	Event->io (fd => IO::AIO::poll_fileno,
1194	poll => 'r',	1291	poll => 'r',
1195	prio => 5,	1292	prio => 5,
		1293	data => WF_AUTOCANCEL,
1196	cb => \&IO::AIO::poll_cb);	1294	cb => \&IO::AIO::poll_cb);
1197		1295
1198	1	1296	1
1199		1297

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.86 by root, Thu Dec 14 05:09:32 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.86 by root, Thu Dec 14 05:09:32 2006 UTC vs.
Revision 1.102 by root, Wed Dec 27 15:20:54 2006 UTC