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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.87 by root, Thu Dec 14 22:45:40 2006 UTC vs.
Revision 1.102 by root, Wed Dec 27 15:20:54 2006 UTC

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.87 by root, Thu Dec 14 22:45:40 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.87 by root, Thu Dec 14 22:45:40 2006 UTC vs.
Revision 1.102 by root, Wed Dec 27 15:20:54 2006 UTC