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

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.83 by root, Mon Dec 11 01:30:41 2006 UTC vs. Revision 1.96 by root, Fri Dec 22 06:02:29 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.83 by root, Mon Dec 11 01:30:41 2006 UTC vs.
Revision 1.96 by root, Fri Dec 22 06:02:29 2006 UTC