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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.70 by root, Sun Oct 1 10:55:37 2006 UTC vs.
Revision 1.95 by root, Fri Dec 22 02:04:20 2006 UTC

…		…
5	use Storable;	5	use Storable;
6	use Opcode;	6	use Opcode;
7	use Safe;	7	use Safe;
8	use Safe::Hole;	8	use Safe::Hole;
9		9
		10	use IO::AIO ();
		11	use YAML::Syck ();
10	use Time::HiRes;	12	use Time::HiRes;
11	use Event;	13	use Event;
12	$Event::Eval = 1; # no idea why this is required, but it is	14	$Event::Eval = 1; # no idea why this is required, but it is
13		15
		16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		17	$YAML::Syck::ImplicitUnicode = 1;
		18
14	use strict;	19	use strict;
15		20
		21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		22
		23	our %COMMAND = ();
		24	our %COMMAND_TIME = ();
		25	our %EXTCMD = ();
		26
16	_init_vars;	27	_init_vars;
17		28
18	our %COMMAND = ();
19	our @EVENT;	29	our @EVENT;
20	our $LIBDIR = maps_directory "perl";	30	our $LIBDIR = datadir . "/ext";
21		31
22	our $TICK = MAX_TIME * 1e-6;	32	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	33	our $TICK_WATCHER;
24	our $NEXT_TICK;	34	our $NEXT_TICK;
25		35
26	our %CFG;	36	our %CFG;
27		37
		38	our $UPTIME; $UPTIME \|\|= time;
		39
28	#############################################################################	40	#############################################################################
29		41
30	=head2 GLOBAL VARIABLES	42	=head2 GLOBAL VARIABLES
31		43
32	=over 4	44	=over 4
		45
		46	=item $cf::UPTIME
		47
		48	The timestamp of the server start (so not actually an uptime).
33		49
34	=item $cf::LIBDIR	50	=item $cf::LIBDIR
35		51
36	The perl library directory, where extensions and cf-specific modules can	52	The perl library directory, where extensions and cf-specific modules can
37	be found. It will be added to C<@INC> automatically.	53	be found. It will be added to C<@INC> automatically.
…		…
58	print STDERR "cfperl: $msg";	74	print STDERR "cfperl: $msg";
59	LOG llevError, "cfperl: $msg";	75	LOG llevError, "cfperl: $msg";
60	};	76	};
61	}	77	}
62		78
		79	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		80	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		81	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		82	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		83	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
63	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	84	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
64		85
65	# we bless all objects into (empty) derived classes to force a method lookup	86	# we bless all objects into (empty) derived classes to force a method lookup
66	# within the Safe compartment.	87	# within the Safe compartment.
67	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	88	for my $pkg (qw(
		89	cf::global
		90	cf::object cf::object::player
		91	cf::client cf::player
		92	cf::arch cf::living
		93	cf::map cf::party cf::region
		94	)) {
68	no strict 'refs';	95	no strict 'refs';
69	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	96	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
70	}	97	}
71		98
72	$Event::DIED = sub {	99	$Event::DIED = sub {
…		…
74	};	101	};
75		102
76	my %ext_pkg;	103	my %ext_pkg;
77	my @exts;	104	my @exts;
78	my @hook;	105	my @hook;
79	my %command;
80	my %extcmd;
81		106
82	=head2 UTILITY FUNCTIONS	107	=head2 UTILITY FUNCTIONS
83		108
84	=over 4	109	=over 4
85		110
…		…
109	JSON::Syck::Dump $_[0]	134	JSON::Syck::Dump $_[0]
110	}	135	}
111		136
112	=back	137	=back
113		138
		139	=cut
		140
114	#############################################################################	141	#############################################################################
115		142
116	=head2 EVENTS AND OBJECT ATTACHMENTS	143	=head2 ATTACHABLE OBJECTS
		144
		145	Many objects in crossfire are so-called attachable objects. That means you can
		146	attach callbacks/event handlers (a collection of which is called an "attachment")
		147	to it. All such attachable objects support the following methods.
		148
		149	In the following description, CLASS can be any of C<global>, C<object>
		150	C<player>, C<client> or C<map> (i.e. the attachable objects in
		151	crossfire+).
117		152
118	=over 4	153	=over 4
119		154
120	=item $object->attach ($attachment, key => $value...)
121
122	=item $object->detach ($attachment)
123
124	Attach/detach a pre-registered attachment to an object.
125
126	=item $player->attach ($attachment, key => $value...)
127
128	=item $player->detach ($attachment)
129
130	Attach/detach a pre-registered attachment to a player.
131
132	=item $map->attach ($attachment, key => $value...)	155	=item $attachable->attach ($attachment, key => $value...)
133		156
134	=item $map->detach ($attachment)	157	=item $attachable->detach ($attachment)
135		158
136	Attach/detach a pre-registered attachment to a map.	159	Attach/detach a pre-registered attachment to a specific object and give it
		160	the specified key/value pairs as arguments.
137		161
138	=item $bool = $object->attached ($name)	162	Example, attach a minesweeper attachment to the given object, making it a
		163	10x10 minesweeper game:
139		164
140	=item $bool = $player->attached ($name)	165	$obj->attach (minesweeper => width => 10, height => 10);
141		166
142	=item $bool = $map->attached ($name)	167	=item $bool = $attachable->attached ($name)
143		168
144	Checks wether the named attachment is currently attached to the object.	169	Checks wether the named attachment is currently attached to the object.
145		170
146	=item cf::attach_global ...	171	=item cf::CLASS->attach ...
147		172
148	Attach handlers for global events.	173	=item cf::CLASS->detach ...
149		174
150	This and all following C<attach_*>-functions expect any number of the	175	Define an anonymous attachment and attach it to all objects of the given
151	following handler/hook descriptions:	176	CLASS. See the next function for an explanation of its arguments.
		177
		178	You can attach to global events by using the C<cf::global> class.
		179
		180	Example, log all player logins:
		181
		182	cf::player->attach (
		183	on_login => sub {
		184	my ($pl) = @_;
		185	...
		186	},
		187	);
		188
		189	Example, attach to the jeweler skill:
		190
		191	cf::object->attach (
		192	type => cf::SKILL,
		193	subtype => cf::SK_JEWELER,
		194	on_use_skill => sub {
		195	my ($sk, $ob, $part, $dir, $msg) = @_;
		196	...
		197	},
		198	);
		199
		200	=item cf::CLASS::attachment $name, ...
		201
		202	Register an attachment by C<$name> through which attachable objects of the
		203	given CLASS can refer to this attachment.
		204
		205	Some classes such as crossfire maps and objects can specify attachments
		206	that are attached at load/instantiate time, thus the need for a name.
		207
		208	These calls expect any number of the following handler/hook descriptions:
152		209
153	=over 4	210	=over 4
154		211
155	=item prio => $number	212	=item prio => $number
156		213
…		…
158	by another C<prio> setting). Lower priority handlers get executed	215	by another C<prio> setting). Lower priority handlers get executed
159	earlier. The default priority is C<0>, and many built-in handlers are	216	earlier. The default priority is C<0>, and many built-in handlers are
160	registered at priority C<-1000>, so lower priorities should not be used	217	registered at priority C<-1000>, so lower priorities should not be used
161	unless you know what you are doing.	218	unless you know what you are doing.
162		219
		220	=item type => $type
		221
		222	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		223	given type of objects only (the additional parameter C<subtype> can be
		224	used to further limit to the given subtype).
		225
163	=item on_I<event> => \&cb	226	=item on_I<event> => \&cb
164		227
165	Call the given code reference whenever the named event happens (event is	228	Call the given code reference whenever the named event happens (event is
166	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	229	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
167	handlers are recognised generally depends on the type of object these	230	handlers are recognised generally depends on the type of object these
…		…
176	package and register them. Only handlers for eevents supported by the	239	package and register them. Only handlers for eevents supported by the
177	object/class are recognised.	240	object/class are recognised.
178		241
179	=back	242	=back
180		243
181	=item cf::attach_to_type $object_type, $subtype, ...	244	Example, define an attachment called "sockpuppet" that calls the given
		245	event handler when a monster attacks:
182		246
183	Attach handlers for a specific object type (e.g. TRANSPORT) and	247	cf::object::attachment sockpuppet =>
184	subtype. If C<$subtype> is zero or undef, matches all objects of the given	248	on_skill_attack => sub {
185	type.	249	my ($self, $victim) = @_;
186		250	...
187	=item cf::attach_to_objects ...	251	}
188		252	}
189	Attach handlers to all objects. Do not use this except for debugging or
190	very rare events, as handlers are (obviously) called for I<all> objects in
191	the game.
192
193	=item cf::attach_to_players ...
194
195	Attach handlers to all players.
196
197	=item cf::attach_to_maps ...
198
199	Attach handlers to all maps.
200
201	=item cf:register_attachment $name, ...
202
203	Register an attachment by name through which objects can refer to this
204	attachment.
205
206	=item cf:register_player_attachment $name, ...
207
208	Register an attachment by name through which players can refer to this
209	attachment.
210
211	=item cf:register_map_attachment $name, ...
212
213	Register an attachment by name through which maps can refer to this
214	attachment.
215		253
216	=cut	254	=cut
217		255
218	# the following variables are defined in .xs and must not be re-created	256	# the following variables are defined in .xs and must not be re-created
219	our @CB_GLOBAL = (); # registry for all global events	257	our @CB_GLOBAL = (); # registry for all global events
220	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	258	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
221	our @CB_PLAYER = ();	259	our @CB_PLAYER = ();
		260	our @CB_CLIENT = ();
222	our @CB_TYPE = (); # registry for type (cf-object class) based events	261	our @CB_TYPE = (); # registry for type (cf-object class) based events
223	our @CB_MAP = ();	262	our @CB_MAP = ();
224		263
225	my %attachment;	264	my %attachment;
226		265
227	sub _attach_cb($\%$$$) {	266	sub _attach_cb($$$$) {
228	my ($registry, $undo, $event, $prio, $cb) = @_;	267	my ($registry, $event, $prio, $cb) = @_;
229		268
230	use sort 'stable';	269	use sort 'stable';
231		270
232	$cb = [$prio, $cb];	271	$cb = [$prio, $cb];
233		272
234	@{$registry->[$event]} = sort	273	@{$registry->[$event]} = sort
235	{ $a->[0] cmp $b->[0] }	274	{ $a->[0] cmp $b->[0] }
236	@{$registry->[$event] \|\| []}, $cb;	275	@{$registry->[$event] \|\| []}, $cb;
237
238	push @{$undo->{cb}}, [$event, $cb];
239	}	276	}
240		277
241	# attach handles attaching event callbacks	278	# attach handles attaching event callbacks
242	# the only thing the caller has to do is pass the correct	279	# the only thing the caller has to do is pass the correct
243	# registry (== where the callback attaches to).	280	# registry (== where the callback attaches to).
244	sub _attach(\@$@) {	281	sub _attach {
245	my ($registry, $klass, @arg) = @_;	282	my ($registry, $klass, @arg) = @_;
246		283
		284	my $object_type;
247	my $prio = 0;	285	my $prio = 0;
248
249	my %undo = (
250	registry => $registry,
251	cb => [],
252	);
253
254	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	286	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
255		287
256	while (@arg) {	288	while (@arg) {
257	my $type = shift @arg;	289	my $type = shift @arg;
258		290
259	if ($type eq "prio") {	291	if ($type eq "prio") {
260	$prio = shift @arg;	292	$prio = shift @arg;
261		293
		294	} elsif ($type eq "type") {
		295	$object_type = shift @arg;
		296	$registry = $CB_TYPE[$object_type] \|\|= [];
		297
		298	} elsif ($type eq "subtype") {
		299	defined $object_type or Carp::croak "subtype specified without type";
		300	my $object_subtype = shift @arg;
		301	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] \|\|= [];
		302
262	} elsif ($type eq "package") {	303	} elsif ($type eq "package") {
263	my $pkg = shift @arg;	304	my $pkg = shift @arg;
264		305
265	while (my ($name, $id) = each %cb_id) {	306	while (my ($name, $id) = each %cb_id) {
266	if (my $cb = $pkg->can ($name)) {	307	if (my $cb = $pkg->can ($name)) {
267	_attach_cb $registry, %undo, $id, $prio, $cb;	308	_attach_cb $registry, $id, $prio, $cb;
268	}	309	}
269	}	310	}
270		311
271	} elsif (exists $cb_id{$type}) {	312	} elsif (exists $cb_id{$type}) {
272	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	313	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
273		314
274	} elsif (ref $type) {	315	} elsif (ref $type) {
275	warn "attaching objects not supported, ignoring.\n";	316	warn "attaching objects not supported, ignoring.\n";
276		317
277	} else {	318	} else {
278	shift @arg;	319	shift @arg;
279	warn "attach argument '$type' not supported, ignoring.\n";	320	warn "attach argument '$type' not supported, ignoring.\n";
280	}	321	}
281	}	322	}
282
283	\%undo
284	}	323	}
285		324
286	sub _attach_attachment {	325	sub _object_attach {
287	my ($obj, $name, %arg) = @_;	326	my ($obj, $name, %arg) = @_;
288		327
289	return if exists $obj->{_attachment}{$name};	328	return if exists $obj->{_attachment}{$name};
290
291	my $res;
292		329
293	if (my $attach = $attachment{$name}) {	330	if (my $attach = $attachment{$name}) {
294	my $registry = $obj->registry;	331	my $registry = $obj->registry;
295		332
296	for (@$attach) {	333	for (@$attach) {
297	my ($klass, @attach) = @$_;	334	my ($klass, @attach) = @$_;
298	$res = _attach @$registry, $klass, @attach;	335	_attach $registry, $klass, @attach;
299	}	336	}
300		337
301	$obj->{$name} = \%arg;	338	$obj->{$name} = \%arg;
302	} else {	339	} else {
303	warn "object uses attachment '$name' that is not available, postponing.\n";	340	warn "object uses attachment '$name' that is not available, postponing.\n";
304	}	341	}
305		342
306	$obj->{_attachment}{$name} = undef;	343	$obj->{_attachment}{$name} = undef;
307
308	$res->{attachment} = $name;
309	$res
310	}	344	}
311		345
312	*cf::object::attach =	346	sub cf::attachable::attach {
313	*cf::player::attach =	347	if (ref $_[0]) {
314	*cf::map::attach = sub {	348	_object_attach @_;
315	my ($obj, $name, %arg) = @_;	349	} else {
316		350	_attach shift->_attach_registry, @_;
317	_attach_attachment $obj, $name, %arg;	351	}
318	};	352	};
319		353
320	# all those should be optimised	354	# all those should be optimised
321	*cf::object::detach =	355	sub cf::attachable::detach {
322	*cf::player::detach =
323	*cf::map::detach = sub {
324	my ($obj, $name) = @_;	356	my ($obj, $name) = @_;
325		357
		358	if (ref $obj) {
326	delete $obj->{_attachment}{$name};	359	delete $obj->{_attachment}{$name};
327	reattach ($obj);	360	reattach ($obj);
		361	} else {
		362	Carp::croak "cannot, currently, detach class attachments";
		363	}
328	};	364	};
329		365
330	*cf::object::attached =	366	sub cf::attachable::attached {
331	*cf::player::attached =
332	*cf::map::attached = sub {
333	my ($obj, $name) = @_;	367	my ($obj, $name) = @_;
334		368
335	exists $obj->{_attachment}{$name}	369	exists $obj->{_attachment}{$name}
336	};
337
338	sub attach_global {
339	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
340	}	370	}
341		371
342	sub attach_to_type {	372	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {
343	my $type = shift;	373	eval "#line " . __LINE__ . " 'cf.pm'
344	my $subtype = shift;	374	sub cf::\L$klass\E::_attach_registry {
		375	(\\\@CB_$klass, KLASS_$klass)
		376	}
345		377
346	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_	378	sub cf::\L$klass\E::attachment {
347	}
348
349	sub attach_to_objects {
350	_attach @CB_OBJECT, KLASS_OBJECT, @_
351	}
352
353	sub attach_to_players {
354	_attach @CB_PLAYER, KLASS_PLAYER, @_
355	}
356
357	sub attach_to_maps {
358	_attach @CB_MAP, KLASS_MAP, @_
359	}
360
361	sub register_attachment {
362	my $name = shift;	379	my \$name = shift;
363		380
364	$attachment{$name} = [[KLASS_OBJECT, @_]];
365	}
366
367	sub register_player_attachment {
368	my $name = shift;
369
370	$attachment{$name} = [[KLASS_PLAYER, @_]];
371	}
372
373	sub register_map_attachment {
374	my $name = shift;
375
376	$attachment{$name} = [[KLASS_MAP, @_]];	381	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		382	}
		383	";
		384	die if $@;
377	}	385	}
378		386
379	our $override;	387	our $override;
380	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	388	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
381		389
…		…
411		419
412	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)	420	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
413		421
414	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)	422	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
415		423
		424	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
		425
416	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)	426	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
417		427
418	Generate a global/object/player/map-specific event with the given arguments.	428	Generate a global/object/player/map-specific event with the given arguments.
419		429
420	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be	430	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
421	removed in future versions), and there is no public API to access override	431	removed in future versions), and there is no public API to access override
422	results (if you must, access C<@cf::invoke_results> directly).	432	results (if you must, access C<@cf::invoke_results> directly).
423		433
424	=back	434	=back
425		435
		436	=cut
		437
426	#############################################################################	438	#############################################################################
427		439
428	=head2 METHODS VALID FOR ALL CORE OBJECTS	440	=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
		441
		442	Attachable objects includes objects, players, clients and maps.
429		443
430	=over 4	444	=over 4
431		445
432	=item $object->valid, $player->valid, $map->valid	446	=item $object->valid
433		447
434	Just because you have a perl object does not mean that the corresponding	448	Just because you have a perl object does not mean that the corresponding
435	C-level object still exists. If you try to access an object that has no	449	C-level object still exists. If you try to access an object that has no
436	valid C counterpart anymore you get an exception at runtime. This method	450	valid C counterpart anymore you get an exception at runtime. This method
437	can be used to test for existence of the C object part without causing an	451	can be used to test for existence of the C object part without causing an
…		…
439		453
440	=back	454	=back
441		455
442	=cut	456	=cut
443		457
444	*cf::object::valid =
445	*cf::player::valid =
446	*cf::map::valid = \&cf::_valid;
447
448	#############################################################################	458	#############################################################################
449	# object support	459	# object support
450		460
451	sub instantiate {	461	sub instantiate {
452	my ($obj, $data) = @_;	462	my ($obj, $data) = @_;
…		…
471		481
472	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	482	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
473	if (my $attach = $attachment{$name}) {	483	if (my $attach = $attachment{$name}) {
474	for (@$attach) {	484	for (@$attach) {
475	my ($klass, @attach) = @$_;	485	my ($klass, @attach) = @$_;
476	_attach @$registry, $klass, @attach;	486	_attach $registry, $klass, @attach;
477	}	487	}
478	} else {	488	} else {
479	warn "object uses attachment '$name' that is not available, postponing.\n";	489	warn "object uses attachment '$name' that is not available, postponing.\n";
480	}	490	}
481	}	491	}
…		…
510	unlink $filename;	520	unlink $filename;
511	unlink "$filename.pst";	521	unlink "$filename.pst";
512	}	522	}
513	}	523	}
514		524
		525	sub object_freezer_as_string {
		526	my ($rdata, $objs) = @_;
		527
		528	use Data::Dumper;
		529
		530	$$rdata . Dumper $objs
		531	}
		532
515	sub object_thawer_load {	533	sub object_thawer_load {
516	my ($filename) = @_;	534	my ($filename) = @_;
517		535
518	local $/;	536	local $/;
519		537
…		…
529	}	547	}
530		548
531	()	549	()
532	}	550	}
533		551
534	attach_to_objects	552	cf::object->attach (
535	prio => -1000000,	553	prio => -1000000,
536	on_clone => sub {	554	on_clone => sub {
537	my ($src, $dst) = @_;	555	my ($src, $dst) = @_;
538		556
539	@{$dst->registry} = @{$src->registry};	557	@{$dst->registry} = @{$src->registry};
…		…
541	%$dst = %$src;	559	%$dst = %$src;
542		560
543	%{$dst->{_attachment}} = %{$src->{_attachment}}	561	%{$dst->{_attachment}} = %{$src->{_attachment}}
544	if exists $src->{_attachment};	562	if exists $src->{_attachment};
545	},	563	},
546	;	564	);
547		565
548	#############################################################################	566	#############################################################################
549	# old plug-in events	567	# command handling &c
550		568
551	sub inject_event {	569	=item cf::register_command $name => \&callback($ob,$args);
552	my $extension = shift;
553	my $event_code = shift;
554		570
555	my $cb = $hook[$event_code]{$extension}	571	Register a callback for execution when the client sends the user command
556	or return;	572	$name.
557		573
558	&$cb	574	=cut
559	}
560
561	sub inject_global_event {
562	my $event = shift;
563
564	my $cb = $hook[$event]
565	or return;
566
567	List::Util::max map &$_, values %$cb
568	}
569
570	sub inject_command {
571	my ($name, $obj, $params) = @_;
572
573	for my $cmd (@{ $command{$name} }) {
574	$cmd->[1]->($obj, $params);
575	}
576
577	-1
578	}
579		575
580	sub register_command {	576	sub register_command {
581	my ($name, $time, $cb) = @_;	577	my ($name, $cb) = @_;
582		578
583	my $caller = caller;	579	my $caller = caller;
584	#warn "registering command '$name/$time' to '$caller'";	580	#warn "registering command '$name/$time' to '$caller'";
585		581
586	push @{ $command{$name} }, [$time, $cb, $caller];	582	push @{ $COMMAND{$name} }, [$caller, $cb];
587	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
588	}	583	}
		584
		585	=item cf::register_extcmd $name => \&callback($pl,$packet);
		586
		587	Register a callbackf ro execution when the client sends an extcmd packet.
		588
		589	If the callback returns something, it is sent back as if reply was being
		590	called.
		591
		592	=cut
589		593
590	sub register_extcmd {	594	sub register_extcmd {
591	my ($name, $cb) = @_;	595	my ($name, $cb) = @_;
592		596
593	my $caller = caller;	597	my $caller = caller;
594	#warn "registering extcmd '$name' to '$caller'";	598	#warn "registering extcmd '$name' to '$caller'";
595		599
596	$extcmd{$name} = [$cb, $caller];	600	$EXTCMD{$name} = [$cb, $caller];
597	}	601	}
		602
		603	cf::player->attach (
		604	on_command => sub {
		605	my ($pl, $name, $params) = @_;
		606
		607	my $cb = $COMMAND{$name}
		608	or return;
		609
		610	for my $cmd (@$cb) {
		611	$cmd->[1]->($pl->ob, $params);
		612	}
		613
		614	cf::override;
		615	},
		616	on_extcmd => sub {
		617	my ($pl, $buf) = @_;
		618
		619	my $msg = eval { from_json $buf };
		620
		621	if (ref $msg) {
		622	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		623	if (my %reply = $cb->[0]->($pl, $msg)) {
		624	$pl->ext_reply ($msg->{msgid}, %reply);
		625	}
		626	}
		627	} else {
		628	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		629	}
		630
		631	cf::override;
		632	},
		633	);
598		634
599	sub register {	635	sub register {
600	my ($base, $pkg) = @_;	636	my ($base, $pkg) = @_;
601		637
602	#TODO	638	#TODO
…		…
621	. "#line 1 \"$path\"\n{\n"	657	. "#line 1 \"$path\"\n{\n"
622	. (do { local $/; <$fh> })	658	. (do { local $/; <$fh> })
623	. "\n};\n1";	659	. "\n};\n1";
624		660
625	eval $source	661	eval $source
626	or die "$path: $@";	662	or die $@ ? "$path: $@\n"
		663	: "extension disabled.\n";
627		664
628	push @exts, $pkg;	665	push @exts, $pkg;
629	$ext_pkg{$base} = $pkg;	666	$ext_pkg{$base} = $pkg;
630		667
631	# no strict 'refs';	668	# no strict 'refs';
…		…
644	# for my $idx (0 .. $#PLUGIN_EVENT) {	681	# for my $idx (0 .. $#PLUGIN_EVENT) {
645	# delete $hook[$idx]{$pkg};	682	# delete $hook[$idx]{$pkg};
646	# }	683	# }
647		684
648	# remove commands	685	# remove commands
649	for my $name (keys %command) {	686	for my $name (keys %COMMAND) {
650	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	687	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
651		688
652	if (@cb) {	689	if (@cb) {
653	$command{$name} = \@cb;	690	$COMMAND{$name} = \@cb;
654	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
655	} else {	691	} else {
656	delete $command{$name};
657	delete $COMMAND{"$name\000"};	692	delete $COMMAND{$name};
658	}	693	}
659	}	694	}
660		695
661	# remove extcmds	696	# remove extcmds
662	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	697	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
663	delete $extcmd{$name};	698	delete $EXTCMD{$name};
664	}	699	}
665		700
666	if (my $cb = $pkg->can ("unload")) {	701	if (my $cb = $pkg->can ("unload")) {
667	eval {	702	eval {
668	$cb->($pkg);	703	$cb->($pkg);
…		…
672		707
673	Symbol::delete_package $pkg;	708	Symbol::delete_package $pkg;
674	}	709	}
675		710
676	sub load_extensions {	711	sub load_extensions {
677	my $LIBDIR = maps_directory "perl";
678
679	for my $ext (<$LIBDIR/*.ext>) {	712	for my $ext (<$LIBDIR/*.ext>) {
680	next unless -r $ext;	713	next unless -r $ext;
681	eval {	714	eval {
682	load_extension $ext;	715	load_extension $ext;
683	1	716	1
684	} or warn "$ext not loaded: $@";	717	} or warn "$ext not loaded: $@";
685	}	718	}
686	}	719	}
687		720
688	#############################################################################	721	#############################################################################
689	# extcmd framework, basically convert ext <msg>
690	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
691
692	attach_to_players
693	on_extcmd => sub {
694	my ($pl, $buf) = @_;
695
696	my $msg = eval { from_json $buf };
697
698	if (ref $msg) {
699	if (my $cb = $extcmd{$msg->{msgtype}}) {
700	if (my %reply = $cb->[0]->($pl, $msg)) {
701	$pl->ext_reply ($msg->{msgid}, %reply);
702	}
703	}
704	} else {
705	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
706	}
707
708	cf::override;
709	},
710	;
711
712	#############################################################################
713	# load/save/clean perl data associated with a map	722	# load/save/clean perl data associated with a map
714		723
715	*cf::mapsupport::on_clean = sub {	724	*cf::mapsupport::on_clean = sub {
716	my ($map) = @_;	725	my ($map) = @_;
717		726
…		…
719	defined $path or return;	728	defined $path or return;
720		729
721	unlink "$path.pst";	730	unlink "$path.pst";
722	};	731	};
723		732
724	attach_to_maps prio => -10000, package => cf::mapsupport::;	733	cf::map->attach (prio => -10000, package => cf::mapsupport::);
725		734
726	#############################################################################	735	#############################################################################
727	# load/save perl data associated with player->ob objects	736	# load/save perl data associated with player->ob objects
728		737
729	sub all_objects(@) {	738	sub all_objects(@) {
730	@_, map all_objects ($_->inv), @_	739	@_, map all_objects ($_->inv), @_
731	}	740	}
732		741
733	# TODO: compatibility cruft, remove when no longer needed	742	# TODO: compatibility cruft, remove when no longer needed
734	attach_to_players	743	cf::player->attach (
735	on_load => sub {	744	on_load => sub {
736	my ($pl, $path) = @_;	745	my ($pl, $path) = @_;
737		746
738	for my $o (all_objects $pl->ob) {	747	for my $o (all_objects $pl->ob) {
739	if (my $value = $o->get_ob_key_value ("_perl_data")) {	748	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
741		750
742	%$o = %{ Storable::thaw pack "H*", $value };	751	%$o = %{ Storable::thaw pack "H*", $value };
743	}	752	}
744	}	753	}
745	},	754	},
746	;	755	);
747		756
748	#############################################################################	757	#############################################################################
749		758
750	=head2 CORE EXTENSIONS	759	=head2 CORE EXTENSIONS
751		760
752	Functions and methods that extend core crossfire objects.	761	Functions and methods that extend core crossfire objects.
		762
		763	=head3 cf::player
753		764
754	=over 4	765	=over 4
755		766
756	=item cf::player::exists $login	767	=item cf::player::exists $login
757		768
…		…
762	sub cf::player::exists($) {	773	sub cf::player::exists($) {
763	cf::player::find $_[0]	774	cf::player::find $_[0]
764	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	775	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
765	}	776	}
766		777
		778	=item $player->ext_reply ($msgid, $msgtype, %msg)
		779
		780	Sends an ext reply to the player.
		781
		782	=cut
		783
		784	sub cf::player::ext_reply($$$%) {
		785	my ($self, $id, %msg) = @_;
		786
		787	$msg{msgid} = $id;
		788
		789	$self->send ("ext " . to_json \%msg);
		790	}
		791
		792	=back
		793
		794	=head3 cf::object::player
		795
		796	=over 4
		797
767	=item $player->reply ($npc, $msg[, $flags])	798	=item $player_object->reply ($npc, $msg[, $flags])
768		799
769	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	800	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
770	can be C<undef>. Does the right thing when the player is currently in a	801	can be C<undef>. Does the right thing when the player is currently in a
771	dialogue with the given NPC character.	802	dialogue with the given NPC character.
772		803
773	=cut	804	=cut
774		805
775	# rough implementation of a future "reply" method that works	806	# rough implementation of a future "reply" method that works
776	# with dialog boxes.	807	# with dialog boxes.
		808	#TODO: the first argument must go, split into a $npc->reply_to ( method
777	sub cf::object::player::reply($$$;$) {	809	sub cf::object::player::reply($$$;$) {
778	my ($self, $npc, $msg, $flags) = @_;	810	my ($self, $npc, $msg, $flags) = @_;
779		811
780	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	812	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
781		813
…		…
785	$msg = $npc->name . " says: $msg" if $npc;	817	$msg = $npc->name . " says: $msg" if $npc;
786	$self->message ($msg, $flags);	818	$self->message ($msg, $flags);
787	}	819	}
788	}	820	}
789		821
790	=item $player->ext_reply ($msgid, $msgtype, %msg)	822	=item $player_object->may ("access")
791		823
792	Sends an ext reply to the player.	824	Returns wether the given player is authorized to access resource "access"
		825	(e.g. "command_wizcast").
793		826
794	=cut	827	=cut
795		828
796	sub cf::player::ext_reply($$$%) {	829	sub cf::object::player::may {
797	my ($self, $id, %msg) = @_;	830	my ($self, $access) = @_;
798		831
799	$msg{msgid} = $id;	832	$self->flag (cf::FLAG_WIZ) \|\|
800		833	(ref $cf::CFG{"may_$access"}
801	$self->send ("ext " . to_json \%msg);	834	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		835	: $cf::CFG{"may_$access"})
802	}	836	}
		837
		838	=head3 cf::client
		839
		840	=over 4
		841
		842	=item $client->send_drawinfo ($text, $flags)
		843
		844	Sends a drawinfo packet to the client. Circumvents output buffering so
		845	should not be used under normal circumstances.
		846
		847	=cut
		848
		849	sub cf::client::send_drawinfo {
		850	my ($self, $text, $flags) = @_;
		851
		852	utf8::encode $text;
		853	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		854	}
		855
		856
		857	=item $success = $client->query ($flags, "text", \&cb)
		858
		859	Queues a query to the client, calling the given callback with
		860	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		861	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		862
		863	Queries can fail, so check the return code. Or don't, as queries will become
		864	reliable at some point in the future.
		865
		866	=cut
		867
		868	sub cf::client::query {
		869	my ($self, $flags, $text, $cb) = @_;
		870
		871	return unless $self->state == ST_PLAYING
		872	\|\| $self->state == ST_SETUP
		873	\|\| $self->state == ST_CUSTOM;
		874
		875	$self->state (ST_CUSTOM);
		876
		877	utf8::encode $text;
		878	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		879
		880	$self->send_packet ($self->{query_queue}[0][0])
		881	if @{ $self->{query_queue} } == 1;
		882	}
		883
		884	cf::client->attach (
		885	on_reply => sub {
		886	my ($ns, $msg) = @_;
		887
		888	# this weird shuffling is so that direct followup queries
		889	# get handled first
		890	my $queue = delete $ns->{query_queue};
		891
		892	(shift @$queue)->[1]->($msg);
		893
		894	push @{ $ns->{query_queue} }, @$queue;
		895
		896	if (@{ $ns->{query_queue} } == @$queue) {
		897	if (@$queue) {
		898	$ns->send_packet ($ns->{query_queue}[0][0]);
		899	} else {
		900	$ns->state (ST_PLAYING);
		901	}
		902	}
		903	},
		904	);
803		905
804	=back	906	=back
805		907
806	=cut
807
808	#############################################################################
809		908
810	=head2 SAFE SCRIPTING	909	=head2 SAFE SCRIPTING
811		910
812	Functions that provide a safe environment to compile and execute	911	Functions that provide a safe environment to compile and execute
813	snippets of perl code without them endangering the safety of the server	912	snippets of perl code without them endangering the safety of the server
814	itself. Looping constructs, I/O operators and other built-in functionality	913	itself. Looping constructs, I/O operators and other built-in functionality
815	is not available in the safe scripting environment, and the number of	914	is not available in the safe scripting environment, and the number of
816	functions and methods that cna be called is greatly reduced.	915	functions and methods that can be called is greatly reduced.
817		916
818	=cut	917	=cut
819		918
820	our $safe = new Safe "safe";	919	our $safe = new Safe "safe";
821	our $safe_hole = new Safe::Hole;	920	our $safe_hole = new Safe::Hole;
…		…
828		927
829	=pod	928	=pod
830		929
831	The following fucntions and emthods are available within a safe environment:	930	The following fucntions and emthods are available within a safe environment:
832		931
833	cf::object contr pay_amount pay_player	932	cf::object contr pay_amount pay_player map
834	cf::object::player player	933	cf::object::player player
835	cf::player peaceful	934	cf::player peaceful
		935	cf::map trigger
836		936
837	=cut	937	=cut
838		938
839	for (	939	for (
840	["cf::object" => qw(contr pay_amount pay_player)],	940	["cf::object" => qw(contr pay_amount pay_player map)],
841	["cf::object::player" => qw(player)],	941	["cf::object::player" => qw(player)],
842	["cf::player" => qw(peaceful)],	942	["cf::player" => qw(peaceful)],
		943	["cf::map" => qw(trigger)],
843	) {	944	) {
844	no strict 'refs';	945	no strict 'refs';
845	my ($pkg, @funs) = @$_;	946	my ($pkg, @funs) = @$_;
846	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	947	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
847	for @funs;	948	for @funs;
…		…
912	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1013	*{"safe::$fun"} = $safe_hole->wrap ($cb);
913	}	1014	}
914		1015
915	=back	1016	=back
916		1017
		1018	=cut
		1019
917	#############################################################################	1020	#############################################################################
918		1021
919	=head2 EXTENSION DATABASE SUPPORT	1022	=head2 EXTENSION DATABASE SUPPORT
920		1023
921	Crossfire maintains a very simple database for extension use. It can	1024	Crossfire maintains a very simple database for extension use. It can
…		…
955		1058
956	Immediately write the database to disk I<if it is dirty>.	1059	Immediately write the database to disk I<if it is dirty>.
957		1060
958	=cut	1061	=cut
959		1062
		1063	our $DB;
		1064
960	{	1065	{
961	my $db;
962	my $path = cf::localdir . "/database.pst";	1066	my $path = cf::localdir . "/database.pst";
963		1067
964	sub db_load() {	1068	sub db_load() {
965	warn "loading database $path\n";#d# remove later	1069	warn "loading database $path\n";#d# remove later
966	$db = stat $path ? Storable::retrieve $path : { };	1070	$DB = stat $path ? Storable::retrieve $path : { };
967	}	1071	}
968		1072
969	my $pid;	1073	my $pid;
970		1074
971	sub db_save() {	1075	sub db_save() {
972	warn "saving database $path\n";#d# remove later	1076	warn "saving database $path\n";#d# remove later
973	waitpid $pid, 0 if $pid;	1077	waitpid $pid, 0 if $pid;
974	if (0 == ($pid = fork)) {	1078	if (0 == ($pid = fork)) {
975	$db->{_meta}{version} = 1;	1079	$DB->{_meta}{version} = 1;
976	Storable::nstore $db, "$path~";	1080	Storable::nstore $DB, "$path~";
977	rename "$path~", $path;	1081	rename "$path~", $path;
978	cf::_exit 0 if defined $pid;	1082	cf::_exit 0 if defined $pid;
979	}	1083	}
980	}	1084	}
981		1085
…		…
984	sub db_sync() {	1088	sub db_sync() {
985	db_save if $dirty;	1089	db_save if $dirty;
986	undef $dirty;	1090	undef $dirty;
987	}	1091	}
988		1092
989	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1093	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
990	db_sync;	1094	db_sync;
991	});	1095	});
992		1096
993	sub db_dirty() {	1097	sub db_dirty() {
994	$dirty = 1;	1098	$dirty = 1;
995	$idle->start;	1099	$idle->start;
996	}	1100	}
997		1101
998	sub db_get($;$) {	1102	sub db_get($;$) {
999	@_ >= 2	1103	@_ >= 2
1000	? $db->{$_[0]}{$_[1]}	1104	? $DB->{$_[0]}{$_[1]}
1001	: ($db->{$_[0]} \|\|= { })	1105	: ($DB->{$_[0]} \|\|= { })
1002	}	1106	}
1003		1107
1004	sub db_put($$;$) {	1108	sub db_put($$;$) {
1005	if (@_ >= 3) {	1109	if (@_ >= 3) {
1006	$db->{$_[0]}{$_[1]} = $_[2];	1110	$DB->{$_[0]}{$_[1]} = $_[2];
1007	} else {	1111	} else {
1008	$db->{$_[0]} = $_[1];	1112	$DB->{$_[0]} = $_[1];
1009	}	1113	}
1010	db_dirty;	1114	db_dirty;
1011	}	1115	}
1012		1116
1013	attach_global	1117	cf::global->attach (
1014	prio => 10000,	1118	prio => 10000,
1015	on_cleanup => sub {	1119	on_cleanup => sub {
1016	db_sync;	1120	db_sync;
1017	},	1121	},
1018	;	1122	);
1019	}	1123	}
1020		1124
1021	#############################################################################	1125	#############################################################################
1022	# the server's main()	1126	# the server's main()
1023		1127
		1128	sub cfg_load {
		1129	open my $fh, "<:utf8", cf::confdir . "/config"
		1130	or return;
		1131
		1132	local $/;
		1133	*CFG = YAML::Syck::Load <$fh>;
		1134	}
		1135
1024	sub main {	1136	sub main {
		1137	cfg_load;
1025	db_load;	1138	db_load;
1026	load_extensions;	1139	load_extensions;
1027	Event::loop;	1140	Event::loop;
1028	}	1141	}
1029		1142
…		…
1035		1148
1036	$msg->("reloading...");	1149	$msg->("reloading...");
1037		1150
1038	eval {	1151	eval {
1039	# cancel all watchers	1152	# cancel all watchers
1040	$_->cancel for Event::all_watchers;	1153	for (Event::all_watchers) {
		1154	$_->cancel if $_->data & WF_AUTOCANCEL;
		1155	}
1041		1156
1042	# unload all extensions	1157	# unload all extensions
1043	for (@exts) {	1158	for (@exts) {
1044	$msg->("unloading <$_>");	1159	$msg->("unloading <$_>");
1045	unload_extension $_;	1160	unload_extension $_;
…		…
1081		1196
1082	# reload cf.pm	1197	# reload cf.pm
1083	$msg->("reloading cf.pm");	1198	$msg->("reloading cf.pm");
1084	require cf;	1199	require cf;
1085		1200
1086	# load database again	1201	# load config and database again
		1202	cf::cfg_load;
1087	cf::db_load;	1203	cf::db_load;
1088		1204
1089	# load extensions	1205	# load extensions
1090	$msg->("load extensions");	1206	$msg->("load extensions");
1091	cf::load_extensions;	1207	cf::load_extensions;
…		…
1104	warn $_[0];	1220	warn $_[0];
1105	print "$_[0]\n";	1221	print "$_[0]\n";
1106	};	1222	};
1107	}	1223	}
1108		1224
		1225	register "<global>", __PACKAGE__;
		1226
1109	register_command "perl-reload", 0, sub {	1227	register_command "perl-reload" => sub {
1110	my ($who, $arg) = @_;	1228	my ($who, $arg) = @_;
1111		1229
1112	if ($who->flag (FLAG_WIZ)) {	1230	if ($who->flag (FLAG_WIZ)) {
1113	_perl_reload {	1231	_perl_reload {
1114	warn $_[0];	1232	warn $_[0];
1115	$who->message ($_[0]);	1233	$who->message ($_[0]);
1116	};	1234	};
1117	}	1235	}
1118	};	1236	};
1119		1237
1120	register "<global>", __PACKAGE__;
1121
1122	unshift @INC, $LIBDIR;	1238	unshift @INC, $LIBDIR;
1123		1239
1124	$TICK_WATCHER = Event->timer (	1240	$TICK_WATCHER = Event->timer (
1125	prio => 1,	1241	prio => 0,
1126	at => $NEXT_TICK \|\| 1,	1242	at => $NEXT_TICK \|\| 1,
		1243	data => WF_AUTOCANCEL,
1127	cb => sub {	1244	cb => sub {
1128	cf::server_tick; # one server iteration	1245	cf::server_tick; # one server iteration
1129		1246
1130	my $NOW = Event::time;	1247	my $NOW = Event::time;
1131	$NEXT_TICK += $TICK;	1248	$NEXT_TICK += $TICK;
1132		1249
1133	# if we are delayed by four ticks, skip them all	1250	# if we are delayed by four ticks or more, skip them all
1134	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1251	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1135		1252
1136	$TICK_WATCHER->at ($NEXT_TICK);	1253	$TICK_WATCHER->at ($NEXT_TICK);
1137	$TICK_WATCHER->start;	1254	$TICK_WATCHER->start;
1138	},	1255	},
1139	);	1256	);
1140		1257
		1258	IO::AIO::max_poll_time $TICK * 0.2;
		1259
		1260	Event->io (fd => IO::AIO::poll_fileno,
		1261	poll => 'r',
		1262	prio => 5,
		1263	data => WF_AUTOCANCEL,
		1264	cb => \&IO::AIO::poll_cb);
		1265
1141	1	1266	1
1142		1267

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.70 by root, Sun Oct 1 10:55:37 2006 UTC vs. Revision 1.95 by root, Fri Dec 22 02:04:20 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.70 by root, Sun Oct 1 10:55:37 2006 UTC vs.
Revision 1.95 by root, Fri Dec 22 02:04:20 2006 UTC