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

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.80 by root, Tue Nov 7 16:30:55 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.80 by root, Tue Nov 7 16:30:55 2006 UTC vs.
Revision 1.96 by root, Fri Dec 22 06:02:29 2006 UTC