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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.71 by root, Sun Oct 1 10:59:30 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
…		…
113		138
114	=cut	139	=cut
115		140
116	#############################################################################	141	#############################################################################
117		142
118	=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+).
119		152
120	=over 4	153	=over 4
121		154
122	=item $object->attach ($attachment, key => $value...)
123
124	=item $object->detach ($attachment)
125
126	Attach/detach a pre-registered attachment to an object.
127
128	=item $player->attach ($attachment, key => $value...)
129
130	=item $player->detach ($attachment)
131
132	Attach/detach a pre-registered attachment to a player.
133
134	=item $map->attach ($attachment, key => $value...)	155	=item $attachable->attach ($attachment, key => $value...)
135		156
136	=item $map->detach ($attachment)	157	=item $attachable->detach ($attachment)
137		158
138	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.
139		161
140	=item $bool = $object->attached ($name)	162	Example, attach a minesweeper attachment to the given object, making it a
		163	10x10 minesweeper game:
141		164
142	=item $bool = $player->attached ($name)	165	$obj->attach (minesweeper => width => 10, height => 10);
143		166
144	=item $bool = $map->attached ($name)	167	=item $bool = $attachable->attached ($name)
145		168
146	Checks wether the named attachment is currently attached to the object.	169	Checks wether the named attachment is currently attached to the object.
147		170
148	=item cf::attach_global ...	171	=item cf::CLASS->attach ...
149		172
150	Attach handlers for global events.	173	=item cf::CLASS->detach ...
151		174
152	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
153	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:
154		209
155	=over 4	210	=over 4
156		211
157	=item prio => $number	212	=item prio => $number
158		213
…		…
160	by another C<prio> setting). Lower priority handlers get executed	215	by another C<prio> setting). Lower priority handlers get executed
161	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
162	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
163	unless you know what you are doing.	218	unless you know what you are doing.
164		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
165	=item on_I<event> => \&cb	226	=item on_I<event> => \&cb
166		227
167	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
168	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
169	handlers are recognised generally depends on the type of object these	230	handlers are recognised generally depends on the type of object these
…		…
178	package and register them. Only handlers for eevents supported by the	239	package and register them. Only handlers for eevents supported by the
179	object/class are recognised.	240	object/class are recognised.
180		241
181	=back	242	=back
182		243
183	=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:
184		246
185	Attach handlers for a specific object type (e.g. TRANSPORT) and	247	cf::object::attachment sockpuppet =>
186	subtype. If C<$subtype> is zero or undef, matches all objects of the given	248	on_skill_attack => sub {
187	type.	249	my ($self, $victim) = @_;
188		250	...
189	=item cf::attach_to_objects ...	251	}
190		252	}
191	Attach handlers to all objects. Do not use this except for debugging or
192	very rare events, as handlers are (obviously) called for I<all> objects in
193	the game.
194
195	=item cf::attach_to_players ...
196
197	Attach handlers to all players.
198
199	=item cf::attach_to_maps ...
200
201	Attach handlers to all maps.
202
203	=item cf:register_attachment $name, ...
204
205	Register an attachment by name through which objects can refer to this
206	attachment.
207
208	=item cf:register_player_attachment $name, ...
209
210	Register an attachment by name through which players can refer to this
211	attachment.
212
213	=item cf:register_map_attachment $name, ...
214
215	Register an attachment by name through which maps can refer to this
216	attachment.
217		253
218	=cut	254	=cut
219		255
220	# 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
221	our @CB_GLOBAL = (); # registry for all global events	257	our @CB_GLOBAL = (); # registry for all global events
222	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)
223	our @CB_PLAYER = ();	259	our @CB_PLAYER = ();
		260	our @CB_CLIENT = ();
224	our @CB_TYPE = (); # registry for type (cf-object class) based events	261	our @CB_TYPE = (); # registry for type (cf-object class) based events
225	our @CB_MAP = ();	262	our @CB_MAP = ();
226		263
227	my %attachment;	264	my %attachment;
228		265
229	sub _attach_cb($\%$$$) {	266	sub _attach_cb($$$$) {
230	my ($registry, $undo, $event, $prio, $cb) = @_;	267	my ($registry, $event, $prio, $cb) = @_;
231		268
232	use sort 'stable';	269	use sort 'stable';
233		270
234	$cb = [$prio, $cb];	271	$cb = [$prio, $cb];
235		272
236	@{$registry->[$event]} = sort	273	@{$registry->[$event]} = sort
237	{ $a->[0] cmp $b->[0] }	274	{ $a->[0] cmp $b->[0] }
238	@{$registry->[$event] \|\| []}, $cb;	275	@{$registry->[$event] \|\| []}, $cb;
239
240	push @{$undo->{cb}}, [$event, $cb];
241	}	276	}
242		277
243	# attach handles attaching event callbacks	278	# attach handles attaching event callbacks
244	# 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
245	# registry (== where the callback attaches to).	280	# registry (== where the callback attaches to).
246	sub _attach(\@$@) {	281	sub _attach {
247	my ($registry, $klass, @arg) = @_;	282	my ($registry, $klass, @arg) = @_;
248		283
		284	my $object_type;
249	my $prio = 0;	285	my $prio = 0;
250
251	my %undo = (
252	registry => $registry,
253	cb => [],
254	);
255
256	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;
257		287
258	while (@arg) {	288	while (@arg) {
259	my $type = shift @arg;	289	my $type = shift @arg;
260		290
261	if ($type eq "prio") {	291	if ($type eq "prio") {
262	$prio = shift @arg;	292	$prio = shift @arg;
263		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
264	} elsif ($type eq "package") {	303	} elsif ($type eq "package") {
265	my $pkg = shift @arg;	304	my $pkg = shift @arg;
266		305
267	while (my ($name, $id) = each %cb_id) {	306	while (my ($name, $id) = each %cb_id) {
268	if (my $cb = $pkg->can ($name)) {	307	if (my $cb = $pkg->can ($name)) {
269	_attach_cb $registry, %undo, $id, $prio, $cb;	308	_attach_cb $registry, $id, $prio, $cb;
270	}	309	}
271	}	310	}
272		311
273	} elsif (exists $cb_id{$type}) {	312	} elsif (exists $cb_id{$type}) {
274	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	313	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
275		314
276	} elsif (ref $type) {	315	} elsif (ref $type) {
277	warn "attaching objects not supported, ignoring.\n";	316	warn "attaching objects not supported, ignoring.\n";
278		317
279	} else {	318	} else {
280	shift @arg;	319	shift @arg;
281	warn "attach argument '$type' not supported, ignoring.\n";	320	warn "attach argument '$type' not supported, ignoring.\n";
282	}	321	}
283	}	322	}
284
285	\%undo
286	}	323	}
287		324
288	sub _attach_attachment {	325	sub _object_attach {
289	my ($obj, $name, %arg) = @_;	326	my ($obj, $name, %arg) = @_;
290		327
291	return if exists $obj->{_attachment}{$name};	328	return if exists $obj->{_attachment}{$name};
292
293	my $res;
294		329
295	if (my $attach = $attachment{$name}) {	330	if (my $attach = $attachment{$name}) {
296	my $registry = $obj->registry;	331	my $registry = $obj->registry;
297		332
298	for (@$attach) {	333	for (@$attach) {
299	my ($klass, @attach) = @$_;	334	my ($klass, @attach) = @$_;
300	$res = _attach @$registry, $klass, @attach;	335	_attach $registry, $klass, @attach;
301	}	336	}
302		337
303	$obj->{$name} = \%arg;	338	$obj->{$name} = \%arg;
304	} else {	339	} else {
305	warn "object uses attachment '$name' that is not available, postponing.\n";	340	warn "object uses attachment '$name' that is not available, postponing.\n";
306	}	341	}
307		342
308	$obj->{_attachment}{$name} = undef;	343	$obj->{_attachment}{$name} = undef;
309
310	$res->{attachment} = $name;
311	$res
312	}	344	}
313		345
314	*cf::object::attach =	346	sub cf::attachable::attach {
315	*cf::player::attach =	347	if (ref $_[0]) {
316	*cf::map::attach = sub {	348	_object_attach @_;
317	my ($obj, $name, %arg) = @_;	349	} else {
318		350	_attach shift->_attach_registry, @_;
319	_attach_attachment $obj, $name, %arg;	351	}
320	};	352	};
321		353
322	# all those should be optimised	354	# all those should be optimised
323	*cf::object::detach =	355	sub cf::attachable::detach {
324	*cf::player::detach =
325	*cf::map::detach = sub {
326	my ($obj, $name) = @_;	356	my ($obj, $name) = @_;
327		357
		358	if (ref $obj) {
328	delete $obj->{_attachment}{$name};	359	delete $obj->{_attachment}{$name};
329	reattach ($obj);	360	reattach ($obj);
		361	} else {
		362	Carp::croak "cannot, currently, detach class attachments";
		363	}
330	};	364	};
331		365
332	*cf::object::attached =	366	sub cf::attachable::attached {
333	*cf::player::attached =
334	*cf::map::attached = sub {
335	my ($obj, $name) = @_;	367	my ($obj, $name) = @_;
336		368
337	exists $obj->{_attachment}{$name}	369	exists $obj->{_attachment}{$name}
338	};
339
340	sub attach_global {
341	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
342	}	370	}
343		371
344	sub attach_to_type {	372	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {
345	my $type = shift;	373	eval "#line " . __LINE__ . " 'cf.pm'
346	my $subtype = shift;	374	sub cf::\L$klass\E::_attach_registry {
		375	(\\\@CB_$klass, KLASS_$klass)
		376	}
347		377
348	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_	378	sub cf::\L$klass\E::attachment {
349	}
350
351	sub attach_to_objects {
352	_attach @CB_OBJECT, KLASS_OBJECT, @_
353	}
354
355	sub attach_to_players {
356	_attach @CB_PLAYER, KLASS_PLAYER, @_
357	}
358
359	sub attach_to_maps {
360	_attach @CB_MAP, KLASS_MAP, @_
361	}
362
363	sub register_attachment {
364	my $name = shift;	379	my \$name = shift;
365		380
366	$attachment{$name} = [[KLASS_OBJECT, @_]];
367	}
368
369	sub register_player_attachment {
370	my $name = shift;
371
372	$attachment{$name} = [[KLASS_PLAYER, @_]];
373	}
374
375	sub register_map_attachment {
376	my $name = shift;
377
378	$attachment{$name} = [[KLASS_MAP, @_]];	381	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		382	}
		383	";
		384	die if $@;
379	}	385	}
380		386
381	our $override;	387	our $override;
382	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?
383		389
…		…
413		419
414	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)	420	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
415		421
416	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)	422	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
417		423
		424	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
		425
418	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)	426	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
419		427
420	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.
421		429
422	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
…		…
427		435
428	=cut	436	=cut
429		437
430	#############################################################################	438	#############################################################################
431		439
432	=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.
433		443
434	=over 4	444	=over 4
435		445
436	=item $object->valid, $player->valid, $map->valid	446	=item $object->valid
437		447
438	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
439	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
440	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
441	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
…		…
443		453
444	=back	454	=back
445		455
446	=cut	456	=cut
447		457
448	*cf::object::valid =
449	*cf::player::valid =
450	*cf::map::valid = \&cf::_valid;
451
452	#############################################################################	458	#############################################################################
453	# object support	459	# object support
454		460
455	sub instantiate {	461	sub instantiate {
456	my ($obj, $data) = @_;	462	my ($obj, $data) = @_;
…		…
475		481
476	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	482	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
477	if (my $attach = $attachment{$name}) {	483	if (my $attach = $attachment{$name}) {
478	for (@$attach) {	484	for (@$attach) {
479	my ($klass, @attach) = @$_;	485	my ($klass, @attach) = @$_;
480	_attach @$registry, $klass, @attach;	486	_attach $registry, $klass, @attach;
481	}	487	}
482	} else {	488	} else {
483	warn "object uses attachment '$name' that is not available, postponing.\n";	489	warn "object uses attachment '$name' that is not available, postponing.\n";
484	}	490	}
485	}	491	}
…		…
514	unlink $filename;	520	unlink $filename;
515	unlink "$filename.pst";	521	unlink "$filename.pst";
516	}	522	}
517	}	523	}
518		524
		525	sub object_freezer_as_string {
		526	my ($rdata, $objs) = @_;
		527
		528	use Data::Dumper;
		529
		530	$$rdata . Dumper $objs
		531	}
		532
519	sub object_thawer_load {	533	sub object_thawer_load {
520	my ($filename) = @_;	534	my ($filename) = @_;
521		535
522	local $/;	536	local $/;
523		537
…		…
533	}	547	}
534		548
535	()	549	()
536	}	550	}
537		551
538	attach_to_objects	552	cf::object->attach (
539	prio => -1000000,	553	prio => -1000000,
540	on_clone => sub {	554	on_clone => sub {
541	my ($src, $dst) = @_;	555	my ($src, $dst) = @_;
542		556
543	@{$dst->registry} = @{$src->registry};	557	@{$dst->registry} = @{$src->registry};
…		…
545	%$dst = %$src;	559	%$dst = %$src;
546		560
547	%{$dst->{_attachment}} = %{$src->{_attachment}}	561	%{$dst->{_attachment}} = %{$src->{_attachment}}
548	if exists $src->{_attachment};	562	if exists $src->{_attachment};
549	},	563	},
550	;	564	);
551		565
552	#############################################################################	566	#############################################################################
553	# old plug-in events	567	# command handling &c
554		568
555	sub inject_event {	569	=item cf::register_command $name => \&callback($ob,$args);
556	my $extension = shift;
557	my $event_code = shift;
558		570
559	my $cb = $hook[$event_code]{$extension}	571	Register a callback for execution when the client sends the user command
560	or return;	572	$name.
561		573
562	&$cb	574	=cut
563	}
564
565	sub inject_global_event {
566	my $event = shift;
567
568	my $cb = $hook[$event]
569	or return;
570
571	List::Util::max map &$_, values %$cb
572	}
573
574	sub inject_command {
575	my ($name, $obj, $params) = @_;
576
577	for my $cmd (@{ $command{$name} }) {
578	$cmd->[1]->($obj, $params);
579	}
580
581	-1
582	}
583		575
584	sub register_command {	576	sub register_command {
585	my ($name, $time, $cb) = @_;	577	my ($name, $cb) = @_;
586		578
587	my $caller = caller;	579	my $caller = caller;
588	#warn "registering command '$name/$time' to '$caller'";	580	#warn "registering command '$name/$time' to '$caller'";
589		581
590	push @{ $command{$name} }, [$time, $cb, $caller];	582	push @{ $COMMAND{$name} }, [$caller, $cb];
591	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
592	}	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
593		593
594	sub register_extcmd {	594	sub register_extcmd {
595	my ($name, $cb) = @_;	595	my ($name, $cb) = @_;
596		596
597	my $caller = caller;	597	my $caller = caller;
598	#warn "registering extcmd '$name' to '$caller'";	598	#warn "registering extcmd '$name' to '$caller'";
599		599
600	$extcmd{$name} = [$cb, $caller];	600	$EXTCMD{$name} = [$cb, $caller];
601	}	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	);
602		634
603	sub register {	635	sub register {
604	my ($base, $pkg) = @_;	636	my ($base, $pkg) = @_;
605		637
606	#TODO	638	#TODO
…		…
625	. "#line 1 \"$path\"\n{\n"	657	. "#line 1 \"$path\"\n{\n"
626	. (do { local $/; <$fh> })	658	. (do { local $/; <$fh> })
627	. "\n};\n1";	659	. "\n};\n1";
628		660
629	eval $source	661	eval $source
630	or die "$path: $@";	662	or die $@ ? "$path: $@\n"
		663	: "extension disabled.\n";
631		664
632	push @exts, $pkg;	665	push @exts, $pkg;
633	$ext_pkg{$base} = $pkg;	666	$ext_pkg{$base} = $pkg;
634		667
635	# no strict 'refs';	668	# no strict 'refs';
…		…
648	# for my $idx (0 .. $#PLUGIN_EVENT) {	681	# for my $idx (0 .. $#PLUGIN_EVENT) {
649	# delete $hook[$idx]{$pkg};	682	# delete $hook[$idx]{$pkg};
650	# }	683	# }
651		684
652	# remove commands	685	# remove commands
653	for my $name (keys %command) {	686	for my $name (keys %COMMAND) {
654	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	687	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
655		688
656	if (@cb) {	689	if (@cb) {
657	$command{$name} = \@cb;	690	$COMMAND{$name} = \@cb;
658	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
659	} else {	691	} else {
660	delete $command{$name};
661	delete $COMMAND{"$name\000"};	692	delete $COMMAND{$name};
662	}	693	}
663	}	694	}
664		695
665	# remove extcmds	696	# remove extcmds
666	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	697	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
667	delete $extcmd{$name};	698	delete $EXTCMD{$name};
668	}	699	}
669		700
670	if (my $cb = $pkg->can ("unload")) {	701	if (my $cb = $pkg->can ("unload")) {
671	eval {	702	eval {
672	$cb->($pkg);	703	$cb->($pkg);
…		…
676		707
677	Symbol::delete_package $pkg;	708	Symbol::delete_package $pkg;
678	}	709	}
679		710
680	sub load_extensions {	711	sub load_extensions {
681	my $LIBDIR = maps_directory "perl";
682
683	for my $ext (<$LIBDIR/*.ext>) {	712	for my $ext (<$LIBDIR/*.ext>) {
684	next unless -r $ext;	713	next unless -r $ext;
685	eval {	714	eval {
686	load_extension $ext;	715	load_extension $ext;
687	1	716	1
688	} or warn "$ext not loaded: $@";	717	} or warn "$ext not loaded: $@";
689	}	718	}
690	}	719	}
691		720
692	#############################################################################	721	#############################################################################
693	# extcmd framework, basically convert ext <msg>
694	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
695
696	attach_to_players
697	on_extcmd => sub {
698	my ($pl, $buf) = @_;
699
700	my $msg = eval { from_json $buf };
701
702	if (ref $msg) {
703	if (my $cb = $extcmd{$msg->{msgtype}}) {
704	if (my %reply = $cb->[0]->($pl, $msg)) {
705	$pl->ext_reply ($msg->{msgid}, %reply);
706	}
707	}
708	} else {
709	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
710	}
711
712	cf::override;
713	},
714	;
715
716	#############################################################################
717	# load/save/clean perl data associated with a map	722	# load/save/clean perl data associated with a map
718		723
719	*cf::mapsupport::on_clean = sub {	724	*cf::mapsupport::on_clean = sub {
720	my ($map) = @_;	725	my ($map) = @_;
721		726
…		…
723	defined $path or return;	728	defined $path or return;
724		729
725	unlink "$path.pst";	730	unlink "$path.pst";
726	};	731	};
727		732
728	attach_to_maps prio => -10000, package => cf::mapsupport::;	733	cf::map->attach (prio => -10000, package => cf::mapsupport::);
729		734
730	#############################################################################	735	#############################################################################
731	# load/save perl data associated with player->ob objects	736	# load/save perl data associated with player->ob objects
732		737
733	sub all_objects(@) {	738	sub all_objects(@) {
734	@_, map all_objects ($_->inv), @_	739	@_, map all_objects ($_->inv), @_
735	}	740	}
736		741
737	# TODO: compatibility cruft, remove when no longer needed	742	# TODO: compatibility cruft, remove when no longer needed
738	attach_to_players	743	cf::player->attach (
739	on_load => sub {	744	on_load => sub {
740	my ($pl, $path) = @_;	745	my ($pl, $path) = @_;
741		746
742	for my $o (all_objects $pl->ob) {	747	for my $o (all_objects $pl->ob) {
743	if (my $value = $o->get_ob_key_value ("_perl_data")) {	748	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
745		750
746	%$o = %{ Storable::thaw pack "H*", $value };	751	%$o = %{ Storable::thaw pack "H*", $value };
747	}	752	}
748	}	753	}
749	},	754	},
750	;	755	);
751		756
752	#############################################################################	757	#############################################################################
753		758
754	=head2 CORE EXTENSIONS	759	=head2 CORE EXTENSIONS
755		760
756	Functions and methods that extend core crossfire objects.	761	Functions and methods that extend core crossfire objects.
		762
		763	=head3 cf::player
757		764
758	=over 4	765	=over 4
759		766
760	=item cf::player::exists $login	767	=item cf::player::exists $login
761		768
…		…
766	sub cf::player::exists($) {	773	sub cf::player::exists($) {
767	cf::player::find $_[0]	774	cf::player::find $_[0]
768	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;
769	}	776	}
770		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
771	=item $player->reply ($npc, $msg[, $flags])	798	=item $player_object->reply ($npc, $msg[, $flags])
772		799
773	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>
774	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
775	dialogue with the given NPC character.	802	dialogue with the given NPC character.
776		803
777	=cut	804	=cut
778		805
779	# rough implementation of a future "reply" method that works	806	# rough implementation of a future "reply" method that works
780	# with dialog boxes.	807	# with dialog boxes.
		808	#TODO: the first argument must go, split into a $npc->reply_to ( method
781	sub cf::object::player::reply($$$;$) {	809	sub cf::object::player::reply($$$;$) {
782	my ($self, $npc, $msg, $flags) = @_;	810	my ($self, $npc, $msg, $flags) = @_;
783		811
784	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	812	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
785		813
…		…
789	$msg = $npc->name . " says: $msg" if $npc;	817	$msg = $npc->name . " says: $msg" if $npc;
790	$self->message ($msg, $flags);	818	$self->message ($msg, $flags);
791	}	819	}
792	}	820	}
793		821
794	=item $player->ext_reply ($msgid, $msgtype, %msg)	822	=item $player_object->may ("access")
795		823
796	Sends an ext reply to the player.	824	Returns wether the given player is authorized to access resource "access"
		825	(e.g. "command_wizcast").
797		826
798	=cut	827	=cut
799		828
800	sub cf::player::ext_reply($$$%) {	829	sub cf::object::player::may {
801	my ($self, $id, %msg) = @_;	830	my ($self, $access) = @_;
802		831
803	$msg{msgid} = $id;	832	$self->flag (cf::FLAG_WIZ) \|\|
804		833	(ref $cf::CFG{"may_$access"}
805	$self->send ("ext " . to_json \%msg);	834	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		835	: $cf::CFG{"may_$access"})
806	}	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	);
807		905
808	=back	906	=back
809		907
810	=cut
811
812	#############################################################################
813		908
814	=head2 SAFE SCRIPTING	909	=head2 SAFE SCRIPTING
815		910
816	Functions that provide a safe environment to compile and execute	911	Functions that provide a safe environment to compile and execute
817	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
818	itself. Looping constructs, I/O operators and other built-in functionality	913	itself. Looping constructs, I/O operators and other built-in functionality
819	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
820	functions and methods that cna be called is greatly reduced.	915	functions and methods that can be called is greatly reduced.
821		916
822	=cut	917	=cut
823		918
824	our $safe = new Safe "safe";	919	our $safe = new Safe "safe";
825	our $safe_hole = new Safe::Hole;	920	our $safe_hole = new Safe::Hole;
…		…
832		927
833	=pod	928	=pod
834		929
835	The following fucntions and emthods are available within a safe environment:	930	The following fucntions and emthods are available within a safe environment:
836		931
837	cf::object contr pay_amount pay_player	932	cf::object contr pay_amount pay_player map
838	cf::object::player player	933	cf::object::player player
839	cf::player peaceful	934	cf::player peaceful
		935	cf::map trigger
840		936
841	=cut	937	=cut
842		938
843	for (	939	for (
844	["cf::object" => qw(contr pay_amount pay_player)],	940	["cf::object" => qw(contr pay_amount pay_player map)],
845	["cf::object::player" => qw(player)],	941	["cf::object::player" => qw(player)],
846	["cf::player" => qw(peaceful)],	942	["cf::player" => qw(peaceful)],
		943	["cf::map" => qw(trigger)],
847	) {	944	) {
848	no strict 'refs';	945	no strict 'refs';
849	my ($pkg, @funs) = @$_;	946	my ($pkg, @funs) = @$_;
850	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	947	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
851	for @funs;	948	for @funs;
…		…
961		1058
962	Immediately write the database to disk I<if it is dirty>.	1059	Immediately write the database to disk I<if it is dirty>.
963		1060
964	=cut	1061	=cut
965		1062
		1063	our $DB;
		1064
966	{	1065	{
967	my $db;
968	my $path = cf::localdir . "/database.pst";	1066	my $path = cf::localdir . "/database.pst";
969		1067
970	sub db_load() {	1068	sub db_load() {
971	warn "loading database $path\n";#d# remove later	1069	warn "loading database $path\n";#d# remove later
972	$db = stat $path ? Storable::retrieve $path : { };	1070	$DB = stat $path ? Storable::retrieve $path : { };
973	}	1071	}
974		1072
975	my $pid;	1073	my $pid;
976		1074
977	sub db_save() {	1075	sub db_save() {
978	warn "saving database $path\n";#d# remove later	1076	warn "saving database $path\n";#d# remove later
979	waitpid $pid, 0 if $pid;	1077	waitpid $pid, 0 if $pid;
980	if (0 == ($pid = fork)) {	1078	if (0 == ($pid = fork)) {
981	$db->{_meta}{version} = 1;	1079	$DB->{_meta}{version} = 1;
982	Storable::nstore $db, "$path~";	1080	Storable::nstore $DB, "$path~";
983	rename "$path~", $path;	1081	rename "$path~", $path;
984	cf::_exit 0 if defined $pid;	1082	cf::_exit 0 if defined $pid;
985	}	1083	}
986	}	1084	}
987		1085
…		…
990	sub db_sync() {	1088	sub db_sync() {
991	db_save if $dirty;	1089	db_save if $dirty;
992	undef $dirty;	1090	undef $dirty;
993	}	1091	}
994		1092
995	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 {
996	db_sync;	1094	db_sync;
997	});	1095	});
998		1096
999	sub db_dirty() {	1097	sub db_dirty() {
1000	$dirty = 1;	1098	$dirty = 1;
1001	$idle->start;	1099	$idle->start;
1002	}	1100	}
1003		1101
1004	sub db_get($;$) {	1102	sub db_get($;$) {
1005	@_ >= 2	1103	@_ >= 2
1006	? $db->{$_[0]}{$_[1]}	1104	? $DB->{$_[0]}{$_[1]}
1007	: ($db->{$_[0]} \|\|= { })	1105	: ($DB->{$_[0]} \|\|= { })
1008	}	1106	}
1009		1107
1010	sub db_put($$;$) {	1108	sub db_put($$;$) {
1011	if (@_ >= 3) {	1109	if (@_ >= 3) {
1012	$db->{$_[0]}{$_[1]} = $_[2];	1110	$DB->{$_[0]}{$_[1]} = $_[2];
1013	} else {	1111	} else {
1014	$db->{$_[0]} = $_[1];	1112	$DB->{$_[0]} = $_[1];
1015	}	1113	}
1016	db_dirty;	1114	db_dirty;
1017	}	1115	}
1018		1116
1019	attach_global	1117	cf::global->attach (
1020	prio => 10000,	1118	prio => 10000,
1021	on_cleanup => sub {	1119	on_cleanup => sub {
1022	db_sync;	1120	db_sync;
1023	},	1121	},
1024	;	1122	);
1025	}	1123	}
1026		1124
1027	#############################################################################	1125	#############################################################################
1028	# the server's main()	1126	# the server's main()
1029		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
1030	sub main {	1136	sub main {
		1137	cfg_load;
1031	db_load;	1138	db_load;
1032	load_extensions;	1139	load_extensions;
1033	Event::loop;	1140	Event::loop;
1034	}	1141	}
1035		1142
…		…
1041		1148
1042	$msg->("reloading...");	1149	$msg->("reloading...");
1043		1150
1044	eval {	1151	eval {
1045	# cancel all watchers	1152	# cancel all watchers
1046	$_->cancel for Event::all_watchers;	1153	for (Event::all_watchers) {
		1154	$_->cancel if $_->data & WF_AUTOCANCEL;
		1155	}
1047		1156
1048	# unload all extensions	1157	# unload all extensions
1049	for (@exts) {	1158	for (@exts) {
1050	$msg->("unloading <$_>");	1159	$msg->("unloading <$_>");
1051	unload_extension $_;	1160	unload_extension $_;
…		…
1087		1196
1088	# reload cf.pm	1197	# reload cf.pm
1089	$msg->("reloading cf.pm");	1198	$msg->("reloading cf.pm");
1090	require cf;	1199	require cf;
1091		1200
1092	# load database again	1201	# load config and database again
		1202	cf::cfg_load;
1093	cf::db_load;	1203	cf::db_load;
1094		1204
1095	# load extensions	1205	# load extensions
1096	$msg->("load extensions");	1206	$msg->("load extensions");
1097	cf::load_extensions;	1207	cf::load_extensions;
…		…
1110	warn $_[0];	1220	warn $_[0];
1111	print "$_[0]\n";	1221	print "$_[0]\n";
1112	};	1222	};
1113	}	1223	}
1114		1224
		1225	register "<global>", __PACKAGE__;
		1226
1115	register_command "perl-reload", 0, sub {	1227	register_command "perl-reload" => sub {
1116	my ($who, $arg) = @_;	1228	my ($who, $arg) = @_;
1117		1229
1118	if ($who->flag (FLAG_WIZ)) {	1230	if ($who->flag (FLAG_WIZ)) {
1119	_perl_reload {	1231	_perl_reload {
1120	warn $_[0];	1232	warn $_[0];
1121	$who->message ($_[0]);	1233	$who->message ($_[0]);
1122	};	1234	};
1123	}	1235	}
1124	};	1236	};
1125		1237
1126	register "<global>", __PACKAGE__;
1127
1128	unshift @INC, $LIBDIR;	1238	unshift @INC, $LIBDIR;
1129		1239
1130	$TICK_WATCHER = Event->timer (	1240	$TICK_WATCHER = Event->timer (
1131	prio => 1,	1241	prio => 0,
1132	at => $NEXT_TICK \|\| 1,	1242	at => $NEXT_TICK \|\| 1,
		1243	data => WF_AUTOCANCEL,
1133	cb => sub {	1244	cb => sub {
1134	cf::server_tick; # one server iteration	1245	cf::server_tick; # one server iteration
1135		1246
1136	my $NOW = Event::time;	1247	my $NOW = Event::time;
1137	$NEXT_TICK += $TICK;	1248	$NEXT_TICK += $TICK;
1138		1249
1139	# if we are delayed by four ticks, skip them all	1250	# if we are delayed by four ticks or more, skip them all
1140	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1251	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1141		1252
1142	$TICK_WATCHER->at ($NEXT_TICK);	1253	$TICK_WATCHER->at ($NEXT_TICK);
1143	$TICK_WATCHER->start;	1254	$TICK_WATCHER->start;
1144	},	1255	},
1145	);	1256	);
1146		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
1147	1	1266	1
1148		1267

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.71 by root, Sun Oct 1 10:59:30 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.71 by root, Sun Oct 1 10:59:30 2006 UTC vs.
Revision 1.95 by root, Fri Dec 22 02:04:20 2006 UTC