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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.92 by root, Thu Dec 21 06:42:28 2006 UTC vs.
Revision 1.100 by root, Mon Dec 25 11:25:49 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	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		31
23	our %COMMAND = ();	32	our %COMMAND = ();
24	our %COMMAND_TIME = ();	33	our %COMMAND_TIME = ();
25	our %EXTCMD = ();	34	our %EXTCMD = ();
26
27	_init_vars;
28		35
29	our @EVENT;	36	our @EVENT;
30	our $LIBDIR = datadir . "/ext";	37	our $LIBDIR = datadir . "/ext";
31		38
32	our $TICK = MAX_TIME * 1e-6;	39	our $TICK = MAX_TIME * 1e-6;
74	print STDERR "cfperl: $msg";	81	print STDERR "cfperl: $msg";
75	LOG llevError, "cfperl: $msg";	82	LOG llevError, "cfperl: $msg";
76	};	83	};
77	}	84	}
78		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';
79	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	91	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
80		92
81	# 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
82	# within the Safe compartment.	94	# within the Safe compartment.
83	for my $pkg (qw(	95	for my $pkg (qw(
		96	cf::global cf::attachable
84	cf::object cf::object::player	97	cf::object cf::object::player
85	cf::client cf::player	98	cf::client cf::player
86	cf::arch cf::living	99	cf::arch cf::living
87	cf::map cf::party cf::region	100	cf::map cf::party cf::region
88	)) {	101	)) {
…		…
132		145
133	=cut	146	=cut
134		147
135	#############################################################################	148	#############################################################################
136		149
137	=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+).
138		159
139	=over 4	160	=over 4
140		161
141	=item $object->attach ($attachment, key => $value...)
142
143	=item $object->detach ($attachment)
144
145	Attach/detach a pre-registered attachment to an object.
146
147	=item $player->attach ($attachment, key => $value...)
148
149	=item $player->detach ($attachment)
150
151	Attach/detach a pre-registered attachment to a player.
152
153	=item $map->attach ($attachment, key => $value...)
154
155	=item $map->detach ($attachment)
156
157	Attach/detach a pre-registered attachment to a client.
158
159	=item $client->attach ($attachment, key => $value...)	162	=item $attachable->attach ($attachment, key => $value...)
160		163
161	=item $client->detach ($attachment)	164	=item $attachable->detach ($attachment)
162		165
163	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.
164		168
165	=item $bool = $object->attached ($name)	169	Example, attach a minesweeper attachment to the given object, making it a
		170	10x10 minesweeper game:
166		171
167	=item $bool = $player->attached ($name)	172	$obj->attach (minesweeper => width => 10, height => 10);
168		173
169	=item $bool = $client->attached ($name)	174	=item $bool = $attachable->attached ($name)
170
171	=item $bool = $map->attached ($name)
172		175
173	Checks wether the named attachment is currently attached to the object.	176	Checks wether the named attachment is currently attached to the object.
174		177
175	=item cf::attach_global ...	178	=item cf::CLASS->attach ...
176		179
177	Attach handlers for global events.	180	=item cf::CLASS->detach ...
178		181
179	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
180	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:
181		216
182	=over 4	217	=over 4
183		218
184	=item prio => $number	219	=item prio => $number
185		220
…		…
187	by another C<prio> setting). Lower priority handlers get executed	222	by another C<prio> setting). Lower priority handlers get executed
188	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
189	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
190	unless you know what you are doing.	225	unless you know what you are doing.
191		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
192	=item on_I<event> => \&cb	233	=item on_I<event> => \&cb
193		234
194	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
195	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
196	handlers are recognised generally depends on the type of object these	237	handlers are recognised generally depends on the type of object these
…		…
205	package and register them. Only handlers for eevents supported by the	246	package and register them. Only handlers for eevents supported by the
206	object/class are recognised.	247	object/class are recognised.
207		248
208	=back	249	=back
209		250
210	=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:
211		253
212	Attach handlers for a specific object type (e.g. TRANSPORT) and	254	cf::object::attachment sockpuppet =>
213	subtype. If C<$subtype> is zero or undef, matches all objects of the given	255	on_skill_attack => sub {
214	type.	256	my ($self, $victim) = @_;
215		257	...
216	=item cf::attach_to_objects ...
217
218	Attach handlers to all objects. Do not use this except for debugging or
219	very rare events, as handlers are (obviously) called for I<all> objects in
220	the game.
221
222	=item cf::attach_to_players ...
223
224	Attach handlers to all players.
225
226	=item cf::attach_to_clients ...
227
228	Attach handlers to all players.
229
230	=item cf::attach_to_maps ...
231
232	Attach handlers to all maps.
233
234	=item cf:register_attachment $name, ...
235
236	Register an attachment by name through which objects can refer to this
237	attachment.
238
239	=item cf:register_player_attachment $name, ...
240
241	Register an attachment by name through which players can refer to this
242	attachment.
243
244	=item cf:register_map_attachment $name, ...
245
246	Register an attachment by name through which maps can refer to this
247	attachment.
248
249	=cut
250
251	# the following variables are defined in .xs and must not be re-created
252	our @CB_GLOBAL = (); # registry for all global events
253	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
254	our @CB_PLAYER = ();
255	our @CB_CLIENT = ();
256	our @CB_TYPE = (); # registry for type (cf-object class) based events
257	our @CB_MAP = ();
258
259	my %attachment;
260
261	sub _attach_cb($\%$$$) {
262	my ($registry, $undo, $event, $prio, $cb) = @_;
263
264	use sort 'stable';
265
266	$cb = [$prio, $cb];
267
268	@{$registry->[$event]} = sort
269	{ $a->[0] cmp $b->[0] }
270	@{$registry->[$event] \|\| []}, $cb;
271
272	push @{$undo->{cb}}, [$event, $cb];
273	}
274
275	# attach handles attaching event callbacks
276	# the only thing the caller has to do is pass the correct
277	# registry (== where the callback attaches to).
278	sub _attach(\@$@) {
279	my ($registry, $klass, @arg) = @_;
280
281	my $prio = 0;
282
283	my %undo = (
284	registry => $registry,
285	cb => [],
286	);
287
288	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
289
290	while (@arg) {
291	my $type = shift @arg;
292
293	if ($type eq "prio") {
294	$prio = shift @arg;
295
296	} elsif ($type eq "package") {
297	my $pkg = shift @arg;
298
299	while (my ($name, $id) = each %cb_id) {
300	if (my $cb = $pkg->can ($name)) {
301	_attach_cb $registry, %undo, $id, $prio, $cb;
302	}
303	}	258	}
304
305	} elsif (exists $cb_id{$type}) {
306	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
307
308	} elsif (ref $type) {
309	warn "attaching objects not supported, ignoring.\n";
310
311	} else {
312	shift @arg;
313	warn "attach argument '$type' not supported, ignoring.\n";
314	}
315	}
316
317	\%undo
318	}
319
320	sub _attach_attachment {
321	my ($obj, $name, %arg) = @_;
322
323	return if exists $obj->{_attachment}{$name};
324
325	my $res;
326
327	if (my $attach = $attachment{$name}) {
328	my $registry = $obj->registry;
329
330	for (@$attach) {
331	my ($klass, @attach) = @$_;
332	$res = _attach @$registry, $klass, @attach;
333	}
334
335	$obj->{$name} = \%arg;
336	} else {
337	warn "object uses attachment '$name' that is not available, postponing.\n";
338	}
339
340	$obj->{_attachment}{$name} = undef;
341
342	$res->{attachment} = $name;
343	$res
344	}
345
346	*cf::object::attach =
347	*cf::player::attach =
348	*cf::client::attach =
349	*cf::map::attach = sub {
350	my ($obj, $name, %arg) = @_;
351
352	_attach_attachment $obj, $name, %arg;
353	};
354
355	# all those should be optimised
356	*cf::object::detach =
357	*cf::player::detach =
358	*cf::client::detach =
359	*cf::map::detach = sub {
360	my ($obj, $name) = @_;
361
362	delete $obj->{_attachment}{$name};
363	reattach ($obj);
364	};
365
366	*cf::object::attached =
367	*cf::player::attached =
368	*cf::client::attached =
369	*cf::map::attached = sub {
370	my ($obj, $name) = @_;
371
372	exists $obj->{_attachment}{$name}
373	};
374
375	sub attach_global {
376	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
377	}
378
379	sub attach_to_type {
380	my $type = shift;
381	my $subtype = shift;
382
383	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
384	}
385
386	sub attach_to_objects {
387	_attach @CB_OBJECT, KLASS_OBJECT, @_
388	}
389
390	sub attach_to_players {
391	_attach @CB_PLAYER, KLASS_PLAYER, @_
392	}
393
394	sub attach_to_clients {
395	_attach @CB_CLIENT, KLASS_CLIENT, @_
396	}
397
398	sub attach_to_maps {
399	_attach @CB_MAP, KLASS_MAP, @_
400	}
401
402	sub register_attachment {
403	my $name = shift;
404
405	$attachment{$name} = [[KLASS_OBJECT, @_]];
406	}
407
408	sub register_player_attachment {
409	my $name = shift;
410
411	$attachment{$name} = [[KLASS_PLAYER, @_]];
412	}
413
414	sub register_client_attachment {
415	my $name = shift;
416
417	$attachment{$name} = [[KLASS_CLIENT, @_]];
418	}
419
420	sub register_map_attachment {
421	my $name = shift;
422
423	$attachment{$name} = [[KLASS_MAP, @_]];
424	}
425
426	our $override;
427	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
428
429	sub override {
430	$override = 1;
431	@invoke_results = ();
432	}
433
434	sub do_invoke {
435	my $event = shift;
436	my $callbacks = shift;
437
438	@invoke_results = ();
439
440	local $override;
441
442	for (@$callbacks) {
443	eval { &{$_->[1]} };
444
445	if ($@) {
446	warn "$@";
447	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
448	override;
449	}
450
451	return 1 if $override;
452	}
453
454	0	259	}
455	}
456		260
457	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	261	=item $attachable->valid
458
459	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
460
461	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
462
463	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
464
465	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
466
467	Generate a global/object/player/map-specific event with the given arguments.
468
469	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
470	removed in future versions), and there is no public API to access override
471	results (if you must, access C<@cf::invoke_results> directly).
472
473	=back
474
475	=cut
476
477	#############################################################################
478
479	=head2 METHODS VALID FOR ALL CORE OBJECTS
480
481	=over 4
482
483	=item $object->valid, $player->valid, $client->valid, $map->valid
484		262
485	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
486	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
487	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
488	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
489	exception.	267	exception.
490		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
491	=back	452	=back
492		453
493	=cut	454	=cut
494
495	*cf::object::valid =
496	*cf::player::valid =
497	*cf::client::valid =
498	*cf::map::valid = \&cf::_valid;
499		455
500	#############################################################################	456	#############################################################################
501	# object support	457	# object support
502		458
503	sub instantiate {	459	cf::attachable->attach (
		460	prio => -1000000,
		461	on_instantiate => sub {
504	my ($obj, $data) = @_;	462	my ($obj, $data) = @_;
505		463
506	$data = from_json $data;	464	$data = from_json $data;
507		465
508	for (@$data) {	466	for (@$data) {
509	my ($name, $args) = @$_;	467	my ($name, $args) = @$_;
510		468
511	$obj->attach ($name, %{$args \|\| {} });	469	$obj->attach ($name, %{$args \|\| {} });
		470	}
512	}	471	},
513	}	472	on_reattach => sub {
514
515	# basically do the same as instantiate, without calling instantiate	473	# basically do the same as instantiate, without calling instantiate
516	sub reattach {
517	my ($obj) = @_;	474	my ($obj) = @_;
518	my $registry = $obj->registry;	475	my $registry = $obj->registry;
519		476
520	@$registry = ();	477	@$registry = ();
521		478
522	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };	479	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
523		480
524	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	481	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
525	if (my $attach = $attachment{$name}) {	482	if (my $attach = $attachment{$name}) {
526	for (@$attach) {	483	for (@$attach) {
527	my ($klass, @attach) = @$_;	484	my ($klass, @attach) = @$_;
528	_attach @$registry, $klass, @attach;	485	_attach $registry, $klass, @attach;
		486	}
		487	} else {
		488	warn "object uses attachment '$name' that is not available, postponing.\n";
529	}	489	}
530	} else {
531	warn "object uses attachment '$name' that is not available, postponing.\n";
532	}	490	}
533	}	491	},
534	}	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	);
535		503
536	sub object_freezer_save {	504	sub object_freezer_save {
537	my ($filename, $rdata, $objs) = @_;	505	my ($filename, $rdata, $objs) = @_;
538		506
539	if (length $$rdata) {	507	if (length $$rdata) {
…		…
589	}	557	}
590		558
591	()	559	()
592	}	560	}
593		561
594	attach_to_objects
595	prio => -1000000,
596	on_clone => sub {
597	my ($src, $dst) = @_;
598
599	@{$dst->registry} = @{$src->registry};
600
601	%$dst = %$src;
602
603	%{$dst->{_attachment}} = %{$src->{_attachment}}
604	if exists $src->{_attachment};
605	},
606	;
607
608	#############################################################################	562	#############################################################################
609	# command handling &c	563	# command handling &c
610		564
611	=item cf::register_command $name => \&callback($ob,$args);	565	=item cf::register_command $name => \&callback($ob,$args);
612		566
…		…
640	#warn "registering extcmd '$name' to '$caller'";	594	#warn "registering extcmd '$name' to '$caller'";
641		595
642	$EXTCMD{$name} = [$cb, $caller];	596	$EXTCMD{$name} = [$cb, $caller];
643	}	597	}
644		598
645	attach_to_players	599	cf::player->attach (
646	on_command => sub {	600	on_command => sub {
647	my ($pl, $name, $params) = @_;	601	my ($pl, $name, $params) = @_;
648		602
649	my $cb = $COMMAND{$name}	603	my $cb = $COMMAND{$name}
650	or return;	604	or return;
…		…
670	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	624	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
671	}	625	}
672		626
673	cf::override;	627	cf::override;
674	},	628	},
675	;	629	);
676		630
677	sub register {	631	sub register {
678	my ($base, $pkg) = @_;	632	my ($base, $pkg) = @_;
679		633
680	#TODO	634	#TODO
…		…
770	defined $path or return;	724	defined $path or return;
771		725
772	unlink "$path.pst";	726	unlink "$path.pst";
773	};	727	};
774		728
775	attach_to_maps prio => -10000, package => cf::mapsupport::;	729	cf::map->attach (prio => -10000, package => cf::mapsupport::);
776		730
777	#############################################################################	731	#############################################################################
778	# load/save perl data associated with player->ob objects	732	# load/save perl data associated with player->ob objects
779		733
780	sub all_objects(@) {	734	sub all_objects(@) {
781	@_, map all_objects ($_->inv), @_	735	@_, map all_objects ($_->inv), @_
782	}	736	}
783		737
784	# TODO: compatibility cruft, remove when no longer needed	738	# TODO: compatibility cruft, remove when no longer needed
785	attach_to_players	739	cf::player->attach (
786	on_load => sub {	740	on_load => sub {
787	my ($pl, $path) = @_;	741	my ($pl, $path) = @_;
788		742
789	for my $o (all_objects $pl->ob) {	743	for my $o (all_objects $pl->ob) {
790	if (my $value = $o->get_ob_key_value ("_perl_data")) {	744	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
792		746
793	%$o = %{ Storable::thaw pack "H*", $value };	747	%$o = %{ Storable::thaw pack "H*", $value };
794	}	748	}
795	}	749	}
796	},	750	},
797	;	751	);
798		752
799	#############################################################################	753	#############################################################################
800		754
801	=head2 CORE EXTENSIONS	755	=head2 CORE EXTENSIONS
802		756
803	Functions and methods that extend core crossfire objects.	757	Functions and methods that extend core crossfire objects.
		758
		759	=head3 cf::player
804		760
805	=over 4	761	=over 4
806		762
807	=item cf::player::exists $login	763	=item cf::player::exists $login
808		764
…		…
813	sub cf::player::exists($) {	769	sub cf::player::exists($) {
814	cf::player::find $_[0]	770	cf::player::find $_[0]
815	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;
816	}	772	}
817		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
818	=item $player_object->reply ($npc, $msg[, $flags])	794	=item $player_object->reply ($npc, $msg[, $flags])
819		795
820	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>
821	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
822	dialogue with the given NPC character.	798	dialogue with the given NPC character.
823		799
824	=cut	800	=cut
825		801
826	# rough implementation of a future "reply" method that works	802	# rough implementation of a future "reply" method that works
827	# with dialog boxes.	803	# with dialog boxes.
		804	#TODO: the first argument must go, split into a $npc->reply_to ( method
828	sub cf::object::player::reply($$$;$) {	805	sub cf::object::player::reply($$$;$) {
829	my ($self, $npc, $msg, $flags) = @_;	806	my ($self, $npc, $msg, $flags) = @_;
830		807
831	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	808	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
832		809
…		…
836	$msg = $npc->name . " says: $msg" if $npc;	813	$msg = $npc->name . " says: $msg" if $npc;
837	$self->message ($msg, $flags);	814	$self->message ($msg, $flags);
838	}	815	}
839	}	816	}
840		817
841	=item $player->ext_reply ($msgid, $msgtype, %msg)
842
843	Sends an ext reply to the player.
844
845	=cut
846
847	sub cf::player::ext_reply($$$%) {
848	my ($self, $id, %msg) = @_;
849
850	$msg{msgid} = $id;
851
852	$self->send ("ext " . to_json \%msg);
853	}
854
855	=item $player_object->may ("access")	818	=item $player_object->may ("access")
856		819
857	Returns wether the given player is authorized to access resource "access"	820	Returns wether the given player is authorized to access resource "access"
858	(e.g. "command_wizcast").	821	(e.g. "command_wizcast").
859		822
…		…
866	(ref $cf::CFG{"may_$access"}	829	(ref $cf::CFG{"may_$access"}
867	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	830	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
868	: $cf::CFG{"may_$access"})	831	: $cf::CFG{"may_$access"})
869	}	832	}
870		833
871	=cut	834	=head3 cf::client
872		835
873	#############################################################################	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
874		934
875	=head2 SAFE SCRIPTING	935	=head2 SAFE SCRIPTING
876		936
877	Functions that provide a safe environment to compile and execute	937	Functions that provide a safe environment to compile and execute
878	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
…		…
1078	$DB->{$_[0]} = $_[1];	1138	$DB->{$_[0]} = $_[1];
1079	}	1139	}
1080	db_dirty;	1140	db_dirty;
1081	}	1141	}
1082		1142
1083	attach_global	1143	cf::global->attach (
1084	prio => 10000,	1144	prio => 10000,
1085	on_cleanup => sub {	1145	on_cleanup => sub {
1086	db_sync;	1146	db_sync;
1087	},	1147	},
1088	;	1148	);
1089	}	1149	}
1090		1150
1091	#############################################################################	1151	#############################################################################
1092	# the server's main()	1152	# the server's main()
1093		1153
…		…
1161	#Symbol::delete_package __PACKAGE__;	1221	#Symbol::delete_package __PACKAGE__;
1162		1222
1163	# reload cf.pm	1223	# reload cf.pm
1164	$msg->("reloading cf.pm");	1224	$msg->("reloading cf.pm");
1165	require cf;	1225	require cf;
		1226	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		1227
1166		1228
1167	# load config and database again	1229	# load config and database again
1168	cf::cfg_load;	1230	cf::cfg_load;
1169	cf::db_load;	1231	cf::db_load;
1170		1232

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.92 by root, Thu Dec 21 06:42:28 2006 UTC vs. Revision 1.100 by root, Mon Dec 25 11:25:49 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.92 by root, Thu Dec 21 06:42:28 2006 UTC vs.
Revision 1.100 by root, Mon Dec 25 11:25:49 2006 UTC