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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC vs.
Revision 1.98 by root, Fri Dec 22 16:34:00 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
69	print STDERR "cfperl: $msg";	83	print STDERR "cfperl: $msg";
70	LOG llevError, "cfperl: $msg";	84	LOG llevError, "cfperl: $msg";
71	};	85	};
72	}	86	}
73		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';
74	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	93	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
75		94
76	# 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
77	# within the Safe compartment.	96	# within the Safe compartment.
78	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	)) {
79	no strict 'refs';	104	no strict 'refs';
80	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	105	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
81	}	106	}
82		107
83	$Event::DIED = sub {	108	$Event::DIED = sub {
…		…
85	};	110	};
86		111
87	my %ext_pkg;	112	my %ext_pkg;
88	my @exts;	113	my @exts;
89	my @hook;	114	my @hook;
90	my %command;
91	my %extcmd;
92		115
93	=head2 UTILITY FUNCTIONS	116	=head2 UTILITY FUNCTIONS
94		117
95	=over 4	118	=over 4
96		119
…		…
124		147
125	=cut	148	=cut
126		149
127	#############################################################################	150	#############################################################################
128		151
129	=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+).
130		161
131	=over 4	162	=over 4
132		163
133	=item $object->attach ($attachment, key => $value...)
134
135	=item $object->detach ($attachment)
136
137	Attach/detach a pre-registered attachment to an object.
138
139	=item $player->attach ($attachment, key => $value...)
140
141	=item $player->detach ($attachment)
142
143	Attach/detach a pre-registered attachment to a player.
144
145	=item $map->attach ($attachment, key => $value...)	164	=item $attachable->attach ($attachment, key => $value...)
146		165
147	=item $map->detach ($attachment)	166	=item $attachable->detach ($attachment)
148		167
149	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.
150		170
151	=item $bool = $object->attached ($name)	171	Example, attach a minesweeper attachment to the given object, making it a
		172	10x10 minesweeper game:
152		173
153	=item $bool = $player->attached ($name)	174	$obj->attach (minesweeper => width => 10, height => 10);
154		175
155	=item $bool = $map->attached ($name)	176	=item $bool = $attachable->attached ($name)
156		177
157	Checks wether the named attachment is currently attached to the object.	178	Checks wether the named attachment is currently attached to the object.
158		179
159	=item cf::attach_global ...	180	=item cf::CLASS->attach ...
160		181
161	Attach handlers for global events.	182	=item cf::CLASS->detach ...
162		183
163	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
164	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:
165		218
166	=over 4	219	=over 4
167		220
168	=item prio => $number	221	=item prio => $number
169		222
…		…
171	by another C<prio> setting). Lower priority handlers get executed	224	by another C<prio> setting). Lower priority handlers get executed
172	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
173	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
174	unless you know what you are doing.	227	unless you know what you are doing.
175		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
176	=item on_I<event> => \&cb	235	=item on_I<event> => \&cb
177		236
178	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
179	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
180	handlers are recognised generally depends on the type of object these	239	handlers are recognised generally depends on the type of object these
…		…
189	package and register them. Only handlers for eevents supported by the	248	package and register them. Only handlers for eevents supported by the
190	object/class are recognised.	249	object/class are recognised.
191		250
192	=back	251	=back
193		252
194	=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:
195		255
196	Attach handlers for a specific object type (e.g. TRANSPORT) and	256	cf::object::attachment sockpuppet =>
197	subtype. If C<$subtype> is zero or undef, matches all objects of the given	257	on_skill_attack => sub {
198	type.	258	my ($self, $victim) = @_;
199		259	...
200	=item cf::attach_to_objects ...
201
202	Attach handlers to all objects. Do not use this except for debugging or
203	very rare events, as handlers are (obviously) called for I<all> objects in
204	the game.
205
206	=item cf::attach_to_players ...
207
208	Attach handlers to all players.
209
210	=item cf::attach_to_maps ...
211
212	Attach handlers to all maps.
213
214	=item cf:register_attachment $name, ...
215
216	Register an attachment by name through which objects can refer to this
217	attachment.
218
219	=item cf:register_player_attachment $name, ...
220
221	Register an attachment by name through which players can refer to this
222	attachment.
223
224	=item cf:register_map_attachment $name, ...
225
226	Register an attachment by name through which maps can refer to this
227	attachment.
228
229	=cut
230
231	# the following variables are defined in .xs and must not be re-created
232	our @CB_GLOBAL = (); # registry for all global events
233	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
234	our @CB_PLAYER = ();
235	our @CB_TYPE = (); # registry for type (cf-object class) based events
236	our @CB_MAP = ();
237
238	my %attachment;
239
240	sub _attach_cb($\%$$$) {
241	my ($registry, $undo, $event, $prio, $cb) = @_;
242
243	use sort 'stable';
244
245	$cb = [$prio, $cb];
246
247	@{$registry->[$event]} = sort
248	{ $a->[0] cmp $b->[0] }
249	@{$registry->[$event] \|\| []}, $cb;
250
251	push @{$undo->{cb}}, [$event, $cb];
252	}
253
254	# attach handles attaching event callbacks
255	# the only thing the caller has to do is pass the correct
256	# registry (== where the callback attaches to).
257	sub _attach(\@$@) {
258	my ($registry, $klass, @arg) = @_;
259
260	my $prio = 0;
261
262	my %undo = (
263	registry => $registry,
264	cb => [],
265	);
266
267	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
268
269	while (@arg) {
270	my $type = shift @arg;
271
272	if ($type eq "prio") {
273	$prio = shift @arg;
274
275	} elsif ($type eq "package") {
276	my $pkg = shift @arg;
277
278	while (my ($name, $id) = each %cb_id) {
279	if (my $cb = $pkg->can ($name)) {
280	_attach_cb $registry, %undo, $id, $prio, $cb;
281	}
282	}	260	}
283
284	} elsif (exists $cb_id{$type}) {
285	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
286
287	} elsif (ref $type) {
288	warn "attaching objects not supported, ignoring.\n";
289
290	} else {
291	shift @arg;
292	warn "attach argument '$type' not supported, ignoring.\n";
293	}
294	}
295
296	\%undo
297	}
298
299	sub _attach_attachment {
300	my ($obj, $name, %arg) = @_;
301
302	return if exists $obj->{_attachment}{$name};
303
304	my $res;
305
306	if (my $attach = $attachment{$name}) {
307	my $registry = $obj->registry;
308
309	for (@$attach) {
310	my ($klass, @attach) = @$_;
311	$res = _attach @$registry, $klass, @attach;
312	}
313
314	$obj->{$name} = \%arg;
315	} else {
316	warn "object uses attachment '$name' that is not available, postponing.\n";
317	}
318
319	$obj->{_attachment}{$name} = undef;
320
321	$res->{attachment} = $name;
322	$res
323	}
324
325	*cf::object::attach =
326	*cf::player::attach =
327	*cf::map::attach = sub {
328	my ($obj, $name, %arg) = @_;
329
330	_attach_attachment $obj, $name, %arg;
331	};
332
333	# all those should be optimised
334	*cf::object::detach =
335	*cf::player::detach =
336	*cf::map::detach = sub {
337	my ($obj, $name) = @_;
338
339	delete $obj->{_attachment}{$name};
340	reattach ($obj);
341	};
342
343	*cf::object::attached =
344	*cf::player::attached =
345	*cf::map::attached = sub {
346	my ($obj, $name) = @_;
347
348	exists $obj->{_attachment}{$name}
349	};
350
351	sub attach_global {
352	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
353	}
354
355	sub attach_to_type {
356	my $type = shift;
357	my $subtype = shift;
358
359	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
360	}
361
362	sub attach_to_objects {
363	_attach @CB_OBJECT, KLASS_OBJECT, @_
364	}
365
366	sub attach_to_players {
367	_attach @CB_PLAYER, KLASS_PLAYER, @_
368	}
369
370	sub attach_to_maps {
371	_attach @CB_MAP, KLASS_MAP, @_
372	}
373
374	sub register_attachment {
375	my $name = shift;
376
377	$attachment{$name} = [[KLASS_OBJECT, @_]];
378	}
379
380	sub register_player_attachment {
381	my $name = shift;
382
383	$attachment{$name} = [[KLASS_PLAYER, @_]];
384	}
385
386	sub register_map_attachment {
387	my $name = shift;
388
389	$attachment{$name} = [[KLASS_MAP, @_]];
390	}
391
392	our $override;
393	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
394
395	sub override {
396	$override = 1;
397	@invoke_results = ();
398	}
399
400	sub do_invoke {
401	my $event = shift;
402	my $callbacks = shift;
403
404	@invoke_results = ();
405
406	local $override;
407
408	for (@$callbacks) {
409	eval { &{$_->[1]} };
410
411	if ($@) {
412	warn "$@";
413	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
414	override;
415	}
416
417	return 1 if $override;
418	}
419
420	0	261	}
421	}
422		262
423	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	263	=item $attachable->valid
424
425	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
426
427	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
428
429	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
430
431	Generate a global/object/player/map-specific event with the given arguments.
432
433	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
434	removed in future versions), and there is no public API to access override
435	results (if you must, access C<@cf::invoke_results> directly).
436
437	=back
438
439	=cut
440
441	#############################################################################
442
443	=head2 METHODS VALID FOR ALL CORE OBJECTS
444
445	=over 4
446
447	=item $object->valid, $player->valid, $map->valid
448		264
449	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
450	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
451	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
452	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
453	exception.	269	exception.
454		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
455	=back	445	=back
456		446
457	=cut	447	=cut
458
459	*cf::object::valid =
460	*cf::player::valid =
461	*cf::map::valid = \&cf::_valid;
462		448
463	#############################################################################	449	#############################################################################
464	# object support	450	# object support
465		451
466	sub instantiate {	452	sub instantiate {
…		…
486		472
487	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	473	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
488	if (my $attach = $attachment{$name}) {	474	if (my $attach = $attachment{$name}) {
489	for (@$attach) {	475	for (@$attach) {
490	my ($klass, @attach) = @$_;	476	my ($klass, @attach) = @$_;
491	_attach @$registry, $klass, @attach;	477	_attach $registry, $klass, @attach;
492	}	478	}
493	} else {	479	} else {
494	warn "object uses attachment '$name' that is not available, postponing.\n";	480	warn "object uses attachment '$name' that is not available, postponing.\n";
495	}	481	}
496	}	482	}
…		…
552	}	538	}
553		539
554	()	540	()
555	}	541	}
556		542
557	attach_to_objects	543	cf::object->attach (
558	prio => -1000000,	544	prio => -1000000,
559	on_clone => sub {	545	on_clone => sub {
560	my ($src, $dst) = @_;	546	my ($src, $dst) = @_;
561		547
562	@{$dst->registry} = @{$src->registry};	548	@{$dst->registry} = @{$src->registry};
…		…
564	%$dst = %$src;	550	%$dst = %$src;
565		551
566	%{$dst->{_attachment}} = %{$src->{_attachment}}	552	%{$dst->{_attachment}} = %{$src->{_attachment}}
567	if exists $src->{_attachment};	553	if exists $src->{_attachment};
568	},	554	},
569	;	555	);
570		556
571	#############################################################################	557	#############################################################################
572	# old plug-in events	558	# command handling &c
573		559
574	sub inject_event {	560	=item cf::register_command $name => \&callback($ob,$args);
575	my $extension = shift;
576	my $event_code = shift;
577		561
578	my $cb = $hook[$event_code]{$extension}	562	Register a callback for execution when the client sends the user command
579	or return;	563	$name.
580		564
581	&$cb	565	=cut
582	}
583
584	sub inject_global_event {
585	my $event = shift;
586
587	my $cb = $hook[$event]
588	or return;
589
590	List::Util::max map &$_, values %$cb
591	}
592
593	sub inject_command {
594	my ($name, $obj, $params) = @_;
595
596	for my $cmd (@{ $command{$name} }) {
597	$cmd->[1]->($obj, $params);
598	}
599
600	-1
601	}
602		566
603	sub register_command {	567	sub register_command {
604	my ($name, $time, $cb) = @_;	568	my ($name, $cb) = @_;
605		569
606	my $caller = caller;	570	my $caller = caller;
607	#warn "registering command '$name/$time' to '$caller'";	571	#warn "registering command '$name/$time' to '$caller'";
608		572
609	push @{ $command{$name} }, [$time, $cb, $caller];	573	push @{ $COMMAND{$name} }, [$caller, $cb];
610	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
611	}	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
612		584
613	sub register_extcmd {	585	sub register_extcmd {
614	my ($name, $cb) = @_;	586	my ($name, $cb) = @_;
615		587
616	my $caller = caller;	588	my $caller = caller;
617	#warn "registering extcmd '$name' to '$caller'";	589	#warn "registering extcmd '$name' to '$caller'";
618		590
619	$extcmd{$name} = [$cb, $caller];	591	$EXTCMD{$name} = [$cb, $caller];
620	}	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	);
621		625
622	sub register {	626	sub register {
623	my ($base, $pkg) = @_;	627	my ($base, $pkg) = @_;
624		628
625	#TODO	629	#TODO
…		…
668	# for my $idx (0 .. $#PLUGIN_EVENT) {	672	# for my $idx (0 .. $#PLUGIN_EVENT) {
669	# delete $hook[$idx]{$pkg};	673	# delete $hook[$idx]{$pkg};
670	# }	674	# }
671		675
672	# remove commands	676	# remove commands
673	for my $name (keys %command) {	677	for my $name (keys %COMMAND) {
674	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	678	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
675		679
676	if (@cb) {	680	if (@cb) {
677	$command{$name} = \@cb;	681	$COMMAND{$name} = \@cb;
678	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
679	} else {	682	} else {
680	delete $command{$name};
681	delete $COMMAND{"$name\000"};	683	delete $COMMAND{$name};
682	}	684	}
683	}	685	}
684		686
685	# remove extcmds	687	# remove extcmds
686	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	688	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
687	delete $extcmd{$name};	689	delete $EXTCMD{$name};
688	}	690	}
689		691
690	if (my $cb = $pkg->can ("unload")) {	692	if (my $cb = $pkg->can ("unload")) {
691	eval {	693	eval {
692	$cb->($pkg);	694	$cb->($pkg);
…		…
696		698
697	Symbol::delete_package $pkg;	699	Symbol::delete_package $pkg;
698	}	700	}
699		701
700	sub load_extensions {	702	sub load_extensions {
701	my $LIBDIR = maps_directory "perl";
702
703	for my $ext (<$LIBDIR/*.ext>) {	703	for my $ext (<$LIBDIR/*.ext>) {
704	next unless -r $ext;	704	next unless -r $ext;
705	eval {	705	eval {
706	load_extension $ext;	706	load_extension $ext;
707	1	707	1
708	} or warn "$ext not loaded: $@";	708	} or warn "$ext not loaded: $@";
709	}	709	}
710	}	710	}
711		711
712	#############################################################################	712	#############################################################################
713	# extcmd framework, basically convert ext <msg>
714	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
715
716	attach_to_players
717	on_extcmd => sub {
718	my ($pl, $buf) = @_;
719
720	my $msg = eval { from_json $buf };
721
722	if (ref $msg) {
723	if (my $cb = $extcmd{$msg->{msgtype}}) {
724	if (my %reply = $cb->[0]->($pl, $msg)) {
725	$pl->ext_reply ($msg->{msgid}, %reply);
726	}
727	}
728	} else {
729	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
730	}
731
732	cf::override;
733	},
734	;
735
736	#############################################################################
737	# load/save/clean perl data associated with a map	713	# load/save/clean perl data associated with a map
738		714
739	*cf::mapsupport::on_clean = sub {	715	*cf::mapsupport::on_clean = sub {
740	my ($map) = @_;	716	my ($map) = @_;
741		717
…		…
743	defined $path or return;	719	defined $path or return;
744		720
745	unlink "$path.pst";	721	unlink "$path.pst";
746	};	722	};
747		723
748	attach_to_maps prio => -10000, package => cf::mapsupport::;	724	cf::map->attach (prio => -10000, package => cf::mapsupport::);
749		725
750	#############################################################################	726	#############################################################################
751	# load/save perl data associated with player->ob objects	727	# load/save perl data associated with player->ob objects
752		728
753	sub all_objects(@) {	729	sub all_objects(@) {
754	@_, map all_objects ($_->inv), @_	730	@_, map all_objects ($_->inv), @_
755	}	731	}
756		732
757	# TODO: compatibility cruft, remove when no longer needed	733	# TODO: compatibility cruft, remove when no longer needed
758	attach_to_players	734	cf::player->attach (
759	on_load => sub {	735	on_load => sub {
760	my ($pl, $path) = @_;	736	my ($pl, $path) = @_;
761		737
762	for my $o (all_objects $pl->ob) {	738	for my $o (all_objects $pl->ob) {
763	if (my $value = $o->get_ob_key_value ("_perl_data")) {	739	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
765		741
766	%$o = %{ Storable::thaw pack "H*", $value };	742	%$o = %{ Storable::thaw pack "H*", $value };
767	}	743	}
768	}	744	}
769	},	745	},
770	;	746	);
771		747
772	#############################################################################	748	#############################################################################
773		749
774	=head2 CORE EXTENSIONS	750	=head2 CORE EXTENSIONS
775		751
776	Functions and methods that extend core crossfire objects.	752	Functions and methods that extend core crossfire objects.
		753
		754	=head3 cf::player
777		755
778	=over 4	756	=over 4
779		757
780	=item cf::player::exists $login	758	=item cf::player::exists $login
781		759
…		…
786	sub cf::player::exists($) {	764	sub cf::player::exists($) {
787	cf::player::find $_[0]	765	cf::player::find $_[0]
788	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;
789	}	767	}
790		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
791	=item $player_object->reply ($npc, $msg[, $flags])	789	=item $player_object->reply ($npc, $msg[, $flags])
792		790
793	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>
794	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
795	dialogue with the given NPC character.	793	dialogue with the given NPC character.
796		794
797	=cut	795	=cut
798		796
799	# rough implementation of a future "reply" method that works	797	# rough implementation of a future "reply" method that works
800	# with dialog boxes.	798	# with dialog boxes.
		799	#TODO: the first argument must go, split into a $npc->reply_to ( method
801	sub cf::object::player::reply($$$;$) {	800	sub cf::object::player::reply($$$;$) {
802	my ($self, $npc, $msg, $flags) = @_;	801	my ($self, $npc, $msg, $flags) = @_;
803		802
804	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	803	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
805		804
…		…
809	$msg = $npc->name . " says: $msg" if $npc;	808	$msg = $npc->name . " says: $msg" if $npc;
810	$self->message ($msg, $flags);	809	$self->message ($msg, $flags);
811	}	810	}
812	}	811	}
813		812
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")	813	=item $player_object->may ("access")
829		814
830	Returns wether the given player is authorized to access resource "access"	815	Returns wether the given player is authorized to access resource "access"
831	(e.g. "command_wizcast").	816	(e.g. "command_wizcast").
832		817
…		…
839	(ref $cf::CFG{"may_$access"}	824	(ref $cf::CFG{"may_$access"}
840	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	825	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
841	: $cf::CFG{"may_$access"})	826	: $cf::CFG{"may_$access"})
842	}	827	}
843		828
844	=cut	829	=head3 cf::client
845		830
846	#############################################################################	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) if $ns->state == ST_CUSTOM;
		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	delete $self->{_coro}{$coro+0};
		914	};
		915
		916	$self->{_coro}{$coro+0} = $coro;
		917	}
		918
		919	cf::client->attach (
		920	on_destroy => sub {
		921	my ($ns) = @_;
		922
		923	$_->cancel for values %{ (delete $ns->{_coro}) \|\| {} };
		924	},
		925	);
		926
		927	=back
		928
847		929
848	=head2 SAFE SCRIPTING	930	=head2 SAFE SCRIPTING
849		931
850	Functions that provide a safe environment to compile and execute	932	Functions that provide a safe environment to compile and execute
851	snippets of perl code without them endangering the safety of the server	933	snippets of perl code without them endangering the safety of the server
…		…
866		948
867	=pod	949	=pod
868		950
869	The following fucntions and emthods are available within a safe environment:	951	The following fucntions and emthods are available within a safe environment:
870		952
871	cf::object contr pay_amount pay_player	953	cf::object contr pay_amount pay_player map
872	cf::object::player player	954	cf::object::player player
873	cf::player peaceful	955	cf::player peaceful
		956	cf::map trigger
874		957
875	=cut	958	=cut
876		959
877	for (	960	for (
878	["cf::object" => qw(contr pay_amount pay_player)],	961	["cf::object" => qw(contr pay_amount pay_player map)],
879	["cf::object::player" => qw(player)],	962	["cf::object::player" => qw(player)],
880	["cf::player" => qw(peaceful)],	963	["cf::player" => qw(peaceful)],
		964	["cf::map" => qw(trigger)],
881	) {	965	) {
882	no strict 'refs';	966	no strict 'refs';
883	my ($pkg, @funs) = @$_;	967	my ($pkg, @funs) = @$_;
884	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	968	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
885	for @funs;	969	for @funs;
…		…
1025	sub db_sync() {	1109	sub db_sync() {
1026	db_save if $dirty;	1110	db_save if $dirty;
1027	undef $dirty;	1111	undef $dirty;
1028	}	1112	}
1029		1113
1030	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1114	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1031	db_sync;	1115	db_sync;
1032	});	1116	});
1033		1117
1034	sub db_dirty() {	1118	sub db_dirty() {
1035	$dirty = 1;	1119	$dirty = 1;
…		…
1049	$DB->{$_[0]} = $_[1];	1133	$DB->{$_[0]} = $_[1];
1050	}	1134	}
1051	db_dirty;	1135	db_dirty;
1052	}	1136	}
1053		1137
1054	attach_global	1138	cf::global->attach (
1055	prio => 10000,	1139	prio => 10000,
1056	on_cleanup => sub {	1140	on_cleanup => sub {
1057	db_sync;	1141	db_sync;
1058	},	1142	},
1059	;	1143	);
1060	}	1144	}
1061		1145
1062	#############################################################################	1146	#############################################################################
1063	# the server's main()	1147	# the server's main()
1064		1148
…		…
1085		1169
1086	$msg->("reloading...");	1170	$msg->("reloading...");
1087		1171
1088	eval {	1172	eval {
1089	# cancel all watchers	1173	# cancel all watchers
1090	$_->cancel for Event::all_watchers;	1174	for (Event::all_watchers) {
		1175	$_->cancel if $_->data & WF_AUTOCANCEL;
		1176	}
1091		1177
1092	# unload all extensions	1178	# unload all extensions
1093	for (@exts) {	1179	for (@exts) {
1094	$msg->("unloading <$_>");	1180	$msg->("unloading <$_>");
1095	unload_extension $_;	1181	unload_extension $_;
…		…
1155	warn $_[0];	1241	warn $_[0];
1156	print "$_[0]\n";	1242	print "$_[0]\n";
1157	};	1243	};
1158	}	1244	}
1159		1245
		1246	register "<global>", __PACKAGE__;
		1247
1160	register_command "perl-reload", 0, sub {	1248	register_command "perl-reload" => sub {
1161	my ($who, $arg) = @_;	1249	my ($who, $arg) = @_;
1162		1250
1163	if ($who->flag (FLAG_WIZ)) {	1251	if ($who->flag (FLAG_WIZ)) {
1164	_perl_reload {	1252	_perl_reload {
1165	warn $_[0];	1253	warn $_[0];
1166	$who->message ($_[0]);	1254	$who->message ($_[0]);
1167	};	1255	};
1168	}	1256	}
1169	};	1257	};
1170		1258
1171	register "<global>", __PACKAGE__;
1172
1173	unshift @INC, $LIBDIR;	1259	unshift @INC, $LIBDIR;
1174		1260
1175	$TICK_WATCHER = Event->timer (	1261	$TICK_WATCHER = Event->timer (
1176	prio => 1,	1262	prio => 0,
1177	async => 1,
1178	at => $NEXT_TICK \|\| 1,	1263	at => $NEXT_TICK \|\| 1,
		1264	data => WF_AUTOCANCEL,
1179	cb => sub {	1265	cb => sub {
1180	cf::server_tick; # one server iteration	1266	cf::server_tick; # one server iteration
1181		1267
1182	my $NOW = Event::time;	1268	my $NOW = Event::time;
1183	$NEXT_TICK += $TICK;	1269	$NEXT_TICK += $TICK;
…		…
1193	IO::AIO::max_poll_time $TICK * 0.2;	1279	IO::AIO::max_poll_time $TICK * 0.2;
1194		1280
1195	Event->io (fd => IO::AIO::poll_fileno,	1281	Event->io (fd => IO::AIO::poll_fileno,
1196	poll => 'r',	1282	poll => 'r',
1197	prio => 5,	1283	prio => 5,
		1284	data => WF_AUTOCANCEL,
1198	cb => \&IO::AIO::poll_cb);	1285	cb => \&IO::AIO::poll_cb);
1199		1286
1200	1	1287	1
1201		1288

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC vs. Revision 1.98 by root, Fri Dec 22 16:34:00 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC vs.
Revision 1.98 by root, Fri Dec 22 16:34:00 2006 UTC