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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.68 by root, Tue Sep 12 23:45:16 2006 UTC vs.
Revision 1.93 by root, Thu Dec 21 22:41:35 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;
		35
		36	our %CFG;
		37
		38	our $UPTIME; $UPTIME \|\|= time;
		39
		40	#############################################################################
		41
		42	=head2 GLOBAL VARIABLES
		43
		44	=over 4
		45
		46	=item $cf::UPTIME
		47
		48	The timestamp of the server start (so not actually an uptime).
		49
		50	=item $cf::LIBDIR
		51
		52	The perl library directory, where extensions and cf-specific modules can
		53	be found. It will be added to C<@INC> automatically.
		54
		55	=item $cf::TICK
		56
		57	The interval between server ticks, in seconds.
		58
		59	=item %cf::CFG
		60
		61	Configuration for the server, loaded from C</etc/crossfire/config>, or
		62	from wherever your confdir points to.
		63
		64	=back
		65
		66	=cut
25		67
26	BEGIN {	68	BEGIN {
27	*CORE::GLOBAL::warn = sub {	69	*CORE::GLOBAL::warn = sub {
28	my $msg = join "", @_;	70	my $msg = join "", @_;
29	$msg .= "\n"	71	$msg .= "\n"
…		…
32	print STDERR "cfperl: $msg";	74	print STDERR "cfperl: $msg";
33	LOG llevError, "cfperl: $msg";	75	LOG llevError, "cfperl: $msg";
34	};	76	};
35	}	77	}
36		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';
37	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	84	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
38		85
39	# 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
40	# within the Safe compartment.	87	# within the Safe compartment.
41	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	)) {
42	no strict 'refs';	95	no strict 'refs';
43	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	96	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
44	}	97	}
45		98
46	$Event::DIED = sub {	99	$Event::DIED = sub {
…		…
48	};	101	};
49		102
50	my %ext_pkg;	103	my %ext_pkg;
51	my @exts;	104	my @exts;
52	my @hook;	105	my @hook;
53	my %command;
54	my %extcmd;
55		106
56	#############################################################################	107	=head2 UTILITY FUNCTIONS
57	# utility functions	108
		109	=over 4
		110
		111	=cut
58		112
59	use JSON::Syck (); # TODO# replace by JSON::PC once working	113	use JSON::Syck (); # TODO# replace by JSON::PC once working
		114
		115	=item $ref = cf::from_json $json
		116
		117	Converts a JSON string into the corresponding perl data structure.
		118
		119	=cut
60		120
61	sub from_json($) {	121	sub from_json($) {
62	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	122	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
63	JSON::Syck::Load $_[0]	123	JSON::Syck::Load $_[0]
64	}	124	}
65		125
		126	=item $json = cf::to_json $ref
		127
		128	Converts a perl data structure into its JSON representation.
		129
		130	=cut
		131
66	sub to_json($) {	132	sub to_json($) {
67	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	133	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
68	JSON::Syck::Dump $_[0]	134	JSON::Syck::Dump $_[0]
69	}	135	}
70		136
		137	=back
		138
		139	=cut
		140
71	#############################################################################	141	#############################################################################
72	# "new" plug-in system
73		142
74	=head3 EVENTS AND OBJECT ATTACHMENTS	143	=head2 ATTACHABLE OBJECTS
		144
		145	You can define and attach attachments to each "attachable" object in
		146	crossfire+ (objects, players, clients, maps and the special "global"
		147	class). In the following description, CLASS can be any of C<global>,
		148	C<object> C<player>, C<client> or C<map>.
75		149
76	=over 4	150	=over 4
77		151
78	=item $object->attach ($attachment, key => $value...)	152	=item cf::CLASS::attachment $name, ...
79		153
80	=item $object->detach ($attachment)	154	Register an attachment by name through which attachable objects can refer
		155	to this attachment.
81		156
82	Attach/detach a pre-registered attachment to an object.
83
84	=item $player->attach ($attachment, key => $value...)
85
86	=item $player->detach ($attachment)
87
88	Attach/detach a pre-registered attachment to a player.
89
90	=item $map->attach ($attachment, key => $value...)
91
92	=item $map->detach ($attachment)
93
94	Attach/detach a pre-registered attachment to a map.
95
96	=item $bool = $object->attached ($name)
97
98	=item $bool = $player->attached ($name)
99
100	=item $bool = $map->attached ($name)	157	=item $bool = $attachable->attached ($name)
101		158
102	Checks wether the named attachment is currently attached to the object.	159	Checks wether the named attachment is currently attached to the object.
103		160
104	=item cf::attach_global ...	161	=item $attachable->attach ($attachment, key => $value...)
105		162
106	Attach handlers for global events.	163	=item $attachable->detach ($attachment)
107		164
108	This and all following C<attach_*>-functions expect any number of the	165	Attach/detach a pre-registered attachment either to a specific object
109	following handler/hook descriptions:	166	(C<$attachable>) or all objects of the given class (if C<$attachable> is a
		167	class in a static method call).
		168
		169	You can attach to global events by using the C<cf::global> class.
		170
		171	These method calls expect any number of the following handler/hook
		172	descriptions:
110		173
111	=over 4	174	=over 4
112		175
113	=item prio => $number	176	=item prio => $number
114		177
…		…
116	by another C<prio> setting). Lower priority handlers get executed	179	by another C<prio> setting). Lower priority handlers get executed
117	earlier. The default priority is C<0>, and many built-in handlers are	180	earlier. The default priority is C<0>, and many built-in handlers are
118	registered at priority C<-1000>, so lower priorities should not be used	181	registered at priority C<-1000>, so lower priorities should not be used
119	unless you know what you are doing.	182	unless you know what you are doing.
120		183
		184	=item type => $type
		185
		186	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		187	given type of objects only (the additional parameter C<subtype> can be
		188	used to further limit to the given subtype).
		189
121	=item on_I<event> => \&cb	190	=item on_I<event> => \&cb
122		191
123	Call the given code reference whenever the named event happens (event is	192	Call the given code reference whenever the named event happens (event is
124	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	193	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
125	handlers are recognised generally depends on the type of object these	194	handlers are recognised generally depends on the type of object these
…		…
134	package and register them. Only handlers for eevents supported by the	203	package and register them. Only handlers for eevents supported by the
135	object/class are recognised.	204	object/class are recognised.
136		205
137	=back	206	=back
138		207
139	=item cf::attach_to_type $object_type, $subtype, ...
140
141	Attach handlers for a specific object type (e.g. TRANSPORT) and
142	subtype. If C<$subtype> is zero or undef, matches all objects of the given
143	type.
144
145	=item cf::attach_to_objects ...
146
147	Attach handlers to all objects. Do not use this except for debugging or
148	very rare events, as handlers are (obviously) called for I<all> objects in
149	the game.
150
151	=item cf::attach_to_players ...
152
153	Attach handlers to all players.
154
155	=item cf::attach_to_maps ...
156
157	Attach handlers to all maps.
158
159	=item cf:register_attachment $name, ...
160
161	Register an attachment by name through which objects can refer to this
162	attachment.
163
164	=item cf:register_player_attachment $name, ...
165
166	Register an attachment by name through which players can refer to this
167	attachment.
168
169	=item cf:register_map_attachment $name, ...
170
171	Register an attachment by name through which maps can refer to this
172	attachment.
173
174	=cut	208	=cut
175		209
176	# the following variables are defined in .xs and must not be re-created	210	# the following variables are defined in .xs and must not be re-created
177	our @CB_GLOBAL = (); # registry for all global events	211	our @CB_GLOBAL = (); # registry for all global events
178	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	212	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
179	our @CB_PLAYER = ();	213	our @CB_PLAYER = ();
		214	our @CB_CLIENT = ();
180	our @CB_TYPE = (); # registry for type (cf-object class) based events	215	our @CB_TYPE = (); # registry for type (cf-object class) based events
181	our @CB_MAP = ();	216	our @CB_MAP = ();
182		217
183	my %attachment;	218	my %attachment;
184		219
185	sub _attach_cb($\%$$$) {	220	sub _attach_cb($$$$) {
186	my ($registry, $undo, $event, $prio, $cb) = @_;	221	my ($registry, $event, $prio, $cb) = @_;
187		222
188	use sort 'stable';	223	use sort 'stable';
189		224
190	$cb = [$prio, $cb];	225	$cb = [$prio, $cb];
191		226
192	@{$registry->[$event]} = sort	227	@{$registry->[$event]} = sort
193	{ $a->[0] cmp $b->[0] }	228	{ $a->[0] cmp $b->[0] }
194	@{$registry->[$event] \|\| []}, $cb;	229	@{$registry->[$event] \|\| []}, $cb;
195
196	push @{$undo->{cb}}, [$event, $cb];
197	}	230	}
198		231
199	# attach handles attaching event callbacks	232	# attach handles attaching event callbacks
200	# the only thing the caller has to do is pass the correct	233	# the only thing the caller has to do is pass the correct
201	# registry (== where the callback attaches to).	234	# registry (== where the callback attaches to).
202	sub _attach(\@$@) {	235	sub _attach {
203	my ($registry, $klass, @arg) = @_;	236	my ($registry, $klass, @arg) = @_;
204		237
		238	my $object_type;
205	my $prio = 0;	239	my $prio = 0;
206
207	my %undo = (
208	registry => $registry,
209	cb => [],
210	);
211
212	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	240	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
213		241
214	while (@arg) {	242	while (@arg) {
215	my $type = shift @arg;	243	my $type = shift @arg;
216		244
217	if ($type eq "prio") {	245	if ($type eq "prio") {
218	$prio = shift @arg;	246	$prio = shift @arg;
219		247
		248	} elsif ($type eq "type") {
		249	$object_type = shift @arg;
		250	$registry = $CB_TYPE[$object_type] \|\|= [];
		251
		252	} elsif ($type eq "subtype") {
		253	defined $object_type or Carp::croak "subtype specified without type";
		254	my $object_subtype = shift @arg;
		255	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] \|\|= [];
		256
220	} elsif ($type eq "package") {	257	} elsif ($type eq "package") {
221	my $pkg = shift @arg;	258	my $pkg = shift @arg;
222		259
223	while (my ($name, $id) = each %cb_id) {	260	while (my ($name, $id) = each %cb_id) {
224	if (my $cb = $pkg->can ($name)) {	261	if (my $cb = $pkg->can ($name)) {
225	_attach_cb $registry, %undo, $id, $prio, $cb;	262	_attach_cb $registry, $id, $prio, $cb;
226	}	263	}
227	}	264	}
228		265
229	} elsif (exists $cb_id{$type}) {	266	} elsif (exists $cb_id{$type}) {
230	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	267	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
231		268
232	} elsif (ref $type) {	269	} elsif (ref $type) {
233	warn "attaching objects not supported, ignoring.\n";	270	warn "attaching objects not supported, ignoring.\n";
234		271
235	} else {	272	} else {
236	shift @arg;	273	shift @arg;
237	warn "attach argument '$type' not supported, ignoring.\n";	274	warn "attach argument '$type' not supported, ignoring.\n";
238	}	275	}
239	}	276	}
240
241	\%undo
242	}	277	}
243		278
244	sub _attach_attachment {	279	sub _object_attach {
245	my ($obj, $name, %arg) = @_;	280	my ($obj, $name, %arg) = @_;
246		281
247	return if exists $obj->{_attachment}{$name};	282	return if exists $obj->{_attachment}{$name};
248
249	my $res;
250		283
251	if (my $attach = $attachment{$name}) {	284	if (my $attach = $attachment{$name}) {
252	my $registry = $obj->registry;	285	my $registry = $obj->registry;
253		286
254	for (@$attach) {	287	for (@$attach) {
255	my ($klass, @attach) = @$_;	288	my ($klass, @attach) = @$_;
256	$res = _attach @$registry, $klass, @attach;	289	_attach $registry, $klass, @attach;
257	}	290	}
258		291
259	$obj->{$name} = \%arg;	292	$obj->{$name} = \%arg;
260	} else {	293	} else {
261	warn "object uses attachment '$name' that is not available, postponing.\n";	294	warn "object uses attachment '$name' that is not available, postponing.\n";
262	}	295	}
263		296
264	$obj->{_attachment}{$name} = undef;	297	$obj->{_attachment}{$name} = undef;
265
266	$res->{attachment} = $name;
267	$res
268	}	298	}
269		299
270	*cf::object::attach =	300	sub cf::attachable::attach {
271	*cf::player::attach =	301	if (ref $_[0]) {
272	*cf::map::attach = sub {	302	_object_attach @_;
273	my ($obj, $name, %arg) = @_;	303	} else {
274		304	_attach shift->_attach_registry, @_;
275	_attach_attachment $obj, $name, %arg;	305	}
276	};	306	};
277		307
278	# all those should be optimised	308	# all those should be optimised
279	*cf::object::detach =	309	sub cf::attachable::detach {
280	*cf::player::detach =
281	*cf::map::detach = sub {
282	my ($obj, $name) = @_;	310	my ($obj, $name) = @_;
283		311
		312	if (ref $obj) {
284	delete $obj->{_attachment}{$name};	313	delete $obj->{_attachment}{$name};
285	reattach ($obj);	314	reattach ($obj);
		315	} else {
		316	Carp::croak "cannot, currently, detach class attachments";
		317	}
286	};	318	};
287		319
288	*cf::object::attached =	320	sub cf::attachable::attached {
289	*cf::player::attached =
290	*cf::map::attached = sub {
291	my ($obj, $name) = @_;	321	my ($obj, $name) = @_;
292		322
293	exists $obj->{_attachment}{$name}	323	exists $obj->{_attachment}{$name}
294	};
295
296	sub attach_global {
297	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
298	}	324	}
299		325
300	sub attach_to_type {	326	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {
301	my $type = shift;	327	eval "#line " . __LINE__ . " 'cf.pm'
302	my $subtype = shift;	328	sub cf::\L$klass\E::_attach_registry {
		329	(\\\@CB_$klass, KLASS_$klass)
		330	}
303		331
304	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_	332	sub cf::\L$klass\E::attachment {
305	}
306
307	sub attach_to_objects {
308	_attach @CB_OBJECT, KLASS_OBJECT, @_
309	}
310
311	sub attach_to_players {
312	_attach @CB_PLAYER, KLASS_PLAYER, @_
313	}
314
315	sub attach_to_maps {
316	_attach @CB_MAP, KLASS_MAP, @_
317	}
318
319	sub register_attachment {
320	my $name = shift;	333	my \$name = shift;
321		334
322	$attachment{$name} = [[KLASS_OBJECT, @_]];
323	}
324
325	sub register_player_attachment {
326	my $name = shift;
327
328	$attachment{$name} = [[KLASS_PLAYER, @_]];
329	}
330
331	sub register_map_attachment {
332	my $name = shift;
333
334	$attachment{$name} = [[KLASS_MAP, @_]];	335	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		336	}
		337	";
		338	die if $@;
335	}	339	}
336		340
337	our $override;	341	our $override;
338	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	342	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
339		343
…		…
369		373
370	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)	374	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
371		375
372	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)	376	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
373		377
		378	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
		379
374	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)	380	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
375		381
376	Generate a global/object/player/map-specific event with the given arguments.	382	Generate a global/object/player/map-specific event with the given arguments.
377		383
378	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be	384	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
379	removed in future versions), and there is no public API to access override	385	removed in future versions), and there is no public API to access override
380	results (if you must, access C<@cf::invoke_results> directly).	386	results (if you must, access C<@cf::invoke_results> directly).
381		387
382	=back	388	=back
383		389
384	=head2 methods valid for all pointers	390	=cut
		391
		392	#############################################################################
		393
		394	=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
		395
		396	Attachable objects includes objects, players, clients and maps.
385		397
386	=over 4	398	=over 4
387		399
388	=item $object->valid	400	=item $object->valid
389
390	=item $player->valid
391
392	=item $map->valid
393		401
394	Just because you have a perl object does not mean that the corresponding	402	Just because you have a perl object does not mean that the corresponding
395	C-level object still exists. If you try to access an object that has no	403	C-level object still exists. If you try to access an object that has no
396	valid C counterpart anymore you get an exception at runtime. This method	404	valid C counterpart anymore you get an exception at runtime. This method
397	can be used to test for existence of the C object part without causing an	405	can be used to test for existence of the C object part without causing an
…		…
399		407
400	=back	408	=back
401		409
402	=cut	410	=cut
403		411
404	*cf::object::valid =
405	*cf::player::valid =
406	*cf::map::valid = \&cf::_valid;
407
408	#############################################################################	412	#############################################################################
409	# object support	413	# object support
410		414
411	sub instantiate {	415	sub instantiate {
412	my ($obj, $data) = @_;	416	my ($obj, $data) = @_;
…		…
431		435
432	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	436	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
433	if (my $attach = $attachment{$name}) {	437	if (my $attach = $attachment{$name}) {
434	for (@$attach) {	438	for (@$attach) {
435	my ($klass, @attach) = @$_;	439	my ($klass, @attach) = @$_;
436	_attach @$registry, $klass, @attach;	440	_attach $registry, $klass, @attach;
437	}	441	}
438	} else {	442	} else {
439	warn "object uses attachment '$name' that is not available, postponing.\n";	443	warn "object uses attachment '$name' that is not available, postponing.\n";
440	}	444	}
441	}	445	}
…		…
470	unlink $filename;	474	unlink $filename;
471	unlink "$filename.pst";	475	unlink "$filename.pst";
472	}	476	}
473	}	477	}
474		478
		479	sub object_freezer_as_string {
		480	my ($rdata, $objs) = @_;
		481
		482	use Data::Dumper;
		483
		484	$$rdata . Dumper $objs
		485	}
		486
475	sub object_thawer_load {	487	sub object_thawer_load {
476	my ($filename) = @_;	488	my ($filename) = @_;
477		489
478	local $/;	490	local $/;
479		491
…		…
489	}	501	}
490		502
491	()	503	()
492	}	504	}
493		505
494	attach_to_objects	506	cf::object->attach (
495	prio => -1000000,	507	prio => -1000000,
496	on_clone => sub {	508	on_clone => sub {
497	my ($src, $dst) = @_;	509	my ($src, $dst) = @_;
498		510
499	@{$dst->registry} = @{$src->registry};	511	@{$dst->registry} = @{$src->registry};
…		…
501	%$dst = %$src;	513	%$dst = %$src;
502		514
503	%{$dst->{_attachment}} = %{$src->{_attachment}}	515	%{$dst->{_attachment}} = %{$src->{_attachment}}
504	if exists $src->{_attachment};	516	if exists $src->{_attachment};
505	},	517	},
506	;	518	);
507		519
508	#############################################################################	520	#############################################################################
509	# old plug-in events	521	# command handling &c
510		522
511	sub inject_event {	523	=item cf::register_command $name => \&callback($ob,$args);
512	my $extension = shift;
513	my $event_code = shift;
514		524
515	my $cb = $hook[$event_code]{$extension}	525	Register a callback for execution when the client sends the user command
516	or return;	526	$name.
517		527
518	&$cb	528	=cut
519	}
520
521	sub inject_global_event {
522	my $event = shift;
523
524	my $cb = $hook[$event]
525	or return;
526
527	List::Util::max map &$_, values %$cb
528	}
529
530	sub inject_command {
531	my ($name, $obj, $params) = @_;
532
533	for my $cmd (@{ $command{$name} }) {
534	$cmd->[1]->($obj, $params);
535	}
536
537	-1
538	}
539		529
540	sub register_command {	530	sub register_command {
541	my ($name, $time, $cb) = @_;	531	my ($name, $cb) = @_;
542		532
543	my $caller = caller;	533	my $caller = caller;
544	#warn "registering command '$name/$time' to '$caller'";	534	#warn "registering command '$name/$time' to '$caller'";
545		535
546	push @{ $command{$name} }, [$time, $cb, $caller];	536	push @{ $COMMAND{$name} }, [$caller, $cb];
547	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
548	}	537	}
		538
		539	=item cf::register_extcmd $name => \&callback($pl,$packet);
		540
		541	Register a callbackf ro execution when the client sends an extcmd packet.
		542
		543	If the callback returns something, it is sent back as if reply was being
		544	called.
		545
		546	=cut
549		547
550	sub register_extcmd {	548	sub register_extcmd {
551	my ($name, $cb) = @_;	549	my ($name, $cb) = @_;
552		550
553	my $caller = caller;	551	my $caller = caller;
554	#warn "registering extcmd '$name' to '$caller'";	552	#warn "registering extcmd '$name' to '$caller'";
555		553
556	$extcmd{$name} = [$cb, $caller];	554	$EXTCMD{$name} = [$cb, $caller];
557	}	555	}
		556
		557	cf::player->attach (
		558	on_command => sub {
		559	my ($pl, $name, $params) = @_;
		560
		561	my $cb = $COMMAND{$name}
		562	or return;
		563
		564	for my $cmd (@$cb) {
		565	$cmd->[1]->($pl->ob, $params);
		566	}
		567
		568	cf::override;
		569	},
		570	on_extcmd => sub {
		571	my ($pl, $buf) = @_;
		572
		573	my $msg = eval { from_json $buf };
		574
		575	if (ref $msg) {
		576	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		577	if (my %reply = $cb->[0]->($pl, $msg)) {
		578	$pl->ext_reply ($msg->{msgid}, %reply);
		579	}
		580	}
		581	} else {
		582	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		583	}
		584
		585	cf::override;
		586	},
		587	);
558		588
559	sub register {	589	sub register {
560	my ($base, $pkg) = @_;	590	my ($base, $pkg) = @_;
561		591
562	#TODO	592	#TODO
…		…
581	. "#line 1 \"$path\"\n{\n"	611	. "#line 1 \"$path\"\n{\n"
582	. (do { local $/; <$fh> })	612	. (do { local $/; <$fh> })
583	. "\n};\n1";	613	. "\n};\n1";
584		614
585	eval $source	615	eval $source
586	or die "$path: $@";	616	or die $@ ? "$path: $@\n"
		617	: "extension disabled.\n";
587		618
588	push @exts, $pkg;	619	push @exts, $pkg;
589	$ext_pkg{$base} = $pkg;	620	$ext_pkg{$base} = $pkg;
590		621
591	# no strict 'refs';	622	# no strict 'refs';
…		…
604	# for my $idx (0 .. $#PLUGIN_EVENT) {	635	# for my $idx (0 .. $#PLUGIN_EVENT) {
605	# delete $hook[$idx]{$pkg};	636	# delete $hook[$idx]{$pkg};
606	# }	637	# }
607		638
608	# remove commands	639	# remove commands
609	for my $name (keys %command) {	640	for my $name (keys %COMMAND) {
610	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	641	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
611		642
612	if (@cb) {	643	if (@cb) {
613	$command{$name} = \@cb;	644	$COMMAND{$name} = \@cb;
614	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
615	} else {	645	} else {
616	delete $command{$name};
617	delete $COMMAND{"$name\000"};	646	delete $COMMAND{$name};
618	}	647	}
619	}	648	}
620		649
621	# remove extcmds	650	# remove extcmds
622	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	651	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
623	delete $extcmd{$name};	652	delete $EXTCMD{$name};
624	}	653	}
625		654
626	if (my $cb = $pkg->can ("unload")) {	655	if (my $cb = $pkg->can ("unload")) {
627	eval {	656	eval {
628	$cb->($pkg);	657	$cb->($pkg);
…		…
632		661
633	Symbol::delete_package $pkg;	662	Symbol::delete_package $pkg;
634	}	663	}
635		664
636	sub load_extensions {	665	sub load_extensions {
637	my $LIBDIR = maps_directory "perl";
638
639	for my $ext (<$LIBDIR/*.ext>) {	666	for my $ext (<$LIBDIR/*.ext>) {
640	next unless -r $ext;	667	next unless -r $ext;
641	eval {	668	eval {
642	load_extension $ext;	669	load_extension $ext;
643	1	670	1
644	} or warn "$ext not loaded: $@";	671	} or warn "$ext not loaded: $@";
645	}	672	}
646	}	673	}
647		674
648	#############################################################################	675	#############################################################################
649	# extcmd framework, basically convert ext <msg>
650	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
651
652	attach_to_players
653	on_extcmd => sub {
654	my ($pl, $buf) = @_;
655
656	my $msg = eval { from_json $buf };
657
658	if (ref $msg) {
659	if (my $cb = $extcmd{$msg->{msgtype}}) {
660	if (my %reply = $cb->[0]->($pl, $msg)) {
661	$pl->ext_reply ($msg->{msgid}, %reply);
662	}
663	}
664	} else {
665	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
666	}
667
668	cf::override;
669	},
670	;
671
672	#############################################################################
673	# load/save/clean perl data associated with a map	676	# load/save/clean perl data associated with a map
674		677
675	*cf::mapsupport::on_clean = sub {	678	*cf::mapsupport::on_clean = sub {
676	my ($map) = @_;	679	my ($map) = @_;
677		680
…		…
679	defined $path or return;	682	defined $path or return;
680		683
681	unlink "$path.pst";	684	unlink "$path.pst";
682	};	685	};
683		686
684	attach_to_maps prio => -10000, package => cf::mapsupport::;	687	cf::map->attach (prio => -10000, package => cf::mapsupport::);
685		688
686	#############################################################################	689	#############################################################################
687	# load/save perl data associated with player->ob objects	690	# load/save perl data associated with player->ob objects
688		691
689	sub all_objects(@) {	692	sub all_objects(@) {
690	@_, map all_objects ($_->inv), @_	693	@_, map all_objects ($_->inv), @_
691	}	694	}
692		695
693	# TODO: compatibility cruft, remove when no longer needed	696	# TODO: compatibility cruft, remove when no longer needed
694	attach_to_players	697	cf::player->attach (
695	on_load => sub {	698	on_load => sub {
696	my ($pl, $path) = @_;	699	my ($pl, $path) = @_;
697		700
698	for my $o (all_objects $pl->ob) {	701	for my $o (all_objects $pl->ob) {
699	if (my $value = $o->get_ob_key_value ("_perl_data")) {	702	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
701		704
702	%$o = %{ Storable::thaw pack "H*", $value };	705	%$o = %{ Storable::thaw pack "H*", $value };
703	}	706	}
704	}	707	}
705	},	708	},
706	;	709	);
707		710
708	#############################################################################	711	#############################################################################
709	# core extensions - in perl	712
		713	=head2 CORE EXTENSIONS
		714
		715	Functions and methods that extend core crossfire objects.
		716
		717	=over 4
710		718
711	=item cf::player::exists $login	719	=item cf::player::exists $login
712		720
713	Returns true when the given account exists.	721	Returns true when the given account exists.
714		722
…		…
717	sub cf::player::exists($) {	725	sub cf::player::exists($) {
718	cf::player::find $_[0]	726	cf::player::find $_[0]
719	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	727	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
720	}	728	}
721		729
722	=item $player->reply ($npc, $msg[, $flags])	730	=item $player_object->reply ($npc, $msg[, $flags])
723		731
724	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	732	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
725	can be C<undef>. Does the right thing when the player is currently in a	733	can be C<undef>. Does the right thing when the player is currently in a
726	dialogue with the given NPC character.	734	dialogue with the given NPC character.
727		735
…		…
754	$msg{msgid} = $id;	762	$msg{msgid} = $id;
755		763
756	$self->send ("ext " . to_json \%msg);	764	$self->send ("ext " . to_json \%msg);
757	}	765	}
758		766
		767	=item $player_object->may ("access")
		768
		769	Returns wether the given player is authorized to access resource "access"
		770	(e.g. "command_wizcast").
		771
		772	=cut
		773
		774	sub cf::object::player::may {
		775	my ($self, $access) = @_;
		776
		777	$self->flag (cf::FLAG_WIZ) \|\|
		778	(ref $cf::CFG{"may_$access"}
		779	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		780	: $cf::CFG{"may_$access"})
		781	}
		782
		783	=cut
		784
759	#############################################################################	785	#############################################################################
760	# map scripting support	786
		787	=head2 SAFE SCRIPTING
		788
		789	Functions that provide a safe environment to compile and execute
		790	snippets of perl code without them endangering the safety of the server
		791	itself. Looping constructs, I/O operators and other built-in functionality
		792	is not available in the safe scripting environment, and the number of
		793	functions and methods that can be called is greatly reduced.
		794
		795	=cut
761		796
762	our $safe = new Safe "safe";	797	our $safe = new Safe "safe";
763	our $safe_hole = new Safe::Hole;	798	our $safe_hole = new Safe::Hole;
764		799
765	$SIG{FPE} = 'IGNORE';	800	$SIG{FPE} = 'IGNORE';
766		801
767	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	802	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
768		803
769	# here we export the classes and methods available to script code	804	# here we export the classes and methods available to script code
770		805
		806	=pod
		807
		808	The following fucntions and emthods are available within a safe environment:
		809
		810	cf::object contr pay_amount pay_player map
		811	cf::object::player player
		812	cf::player peaceful
		813	cf::map trigger
		814
		815	=cut
		816
771	for (	817	for (
772	["cf::object" => qw(contr pay_amount pay_player)],	818	["cf::object" => qw(contr pay_amount pay_player map)],
773	["cf::object::player" => qw(player)],	819	["cf::object::player" => qw(player)],
774	["cf::player" => qw(peaceful)],	820	["cf::player" => qw(peaceful)],
		821	["cf::map" => qw(trigger)],
775	) {	822	) {
776	no strict 'refs';	823	no strict 'refs';
777	my ($pkg, @funs) = @$_;	824	my ($pkg, @funs) = @$_;
778	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	825	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
779	for @funs;	826	for @funs;
780	}	827	}
		828
		829	=over 4
		830
		831	=item @retval = safe_eval $code, [var => value, ...]
		832
		833	Compiled and executes the given perl code snippet. additional var/value
		834	pairs result in temporary local (my) scalar variables of the given name
		835	that are available in the code snippet. Example:
		836
		837	my $five = safe_eval '$first + $second', first => 1, second => 4;
		838
		839	=cut
781		840
782	sub safe_eval($;@) {	841	sub safe_eval($;@) {
783	my ($code, %vars) = @_;	842	my ($code, %vars) = @_;
784		843
785	my $qcode = $code;	844	my $qcode = $code;
…		…
808	}	867	}
809		868
810	wantarray ? @res : $res[0]	869	wantarray ? @res : $res[0]
811	}	870	}
812		871
		872	=item cf::register_script_function $function => $cb
		873
		874	Register a function that can be called from within map/npc scripts. The
		875	function should be reasonably secure and should be put into a package name
		876	like the extension.
		877
		878	Example: register a function that gets called whenever a map script calls
		879	C<rent::overview>, as used by the C<rent> extension.
		880
		881	cf::register_script_function "rent::overview" => sub {
		882	...
		883	};
		884
		885	=cut
		886
813	sub register_script_function {	887	sub register_script_function {
814	my ($fun, $cb) = @_;	888	my ($fun, $cb) = @_;
815		889
816	no strict 'refs';	890	no strict 'refs';
817	*{"safe::$fun"} = $safe_hole->wrap ($cb);	891	*{"safe::$fun"} = $safe_hole->wrap ($cb);
818	}	892	}
		893
		894	=back
		895
		896	=cut
819		897
820	#############################################################################	898	#############################################################################
821		899
822	=head2 EXTENSION DATABASE SUPPORT	900	=head2 EXTENSION DATABASE SUPPORT
823		901
…		…
858		936
859	Immediately write the database to disk I<if it is dirty>.	937	Immediately write the database to disk I<if it is dirty>.
860		938
861	=cut	939	=cut
862		940
		941	our $DB;
		942
863	{	943	{
864	my $db;
865	my $path = cf::localdir . "/database.pst";	944	my $path = cf::localdir . "/database.pst";
866		945
867	sub db_load() {	946	sub db_load() {
868	warn "loading database $path\n";#d# remove later	947	warn "loading database $path\n";#d# remove later
869	$db = stat $path ? Storable::retrieve $path : { };	948	$DB = stat $path ? Storable::retrieve $path : { };
870	}	949	}
871		950
872	my $pid;	951	my $pid;
873		952
874	sub db_save() {	953	sub db_save() {
875	warn "saving database $path\n";#d# remove later	954	warn "saving database $path\n";#d# remove later
876	waitpid $pid, 0 if $pid;	955	waitpid $pid, 0 if $pid;
877	if (0 == ($pid = fork)) {	956	if (0 == ($pid = fork)) {
878	$db->{_meta}{version} = 1;	957	$DB->{_meta}{version} = 1;
879	Storable::nstore $db, "$path~";	958	Storable::nstore $DB, "$path~";
880	rename "$path~", $path;	959	rename "$path~", $path;
881	cf::_exit 0 if defined $pid;	960	cf::_exit 0 if defined $pid;
882	}	961	}
883	}	962	}
884		963
…		…
887	sub db_sync() {	966	sub db_sync() {
888	db_save if $dirty;	967	db_save if $dirty;
889	undef $dirty;	968	undef $dirty;
890	}	969	}
891		970
892	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	971	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
893	db_sync;	972	db_sync;
894	});	973	});
895		974
896	sub db_dirty() {	975	sub db_dirty() {
897	$dirty = 1;	976	$dirty = 1;
898	$idle->start;	977	$idle->start;
899	}	978	}
900		979
901	sub db_get($;$) {	980	sub db_get($;$) {
902	@_ >= 2	981	@_ >= 2
903	? $db->{$_[0]}{$_[1]}	982	? $DB->{$_[0]}{$_[1]}
904	: ($db->{$_[0]} \|\|= { })	983	: ($DB->{$_[0]} \|\|= { })
905	}	984	}
906		985
907	sub db_put($$;$) {	986	sub db_put($$;$) {
908	if (@_ >= 3) {	987	if (@_ >= 3) {
909	$db->{$_[0]}{$_[1]} = $_[2];	988	$DB->{$_[0]}{$_[1]} = $_[2];
910	} else {	989	} else {
911	$db->{$_[0]} = $_[1];	990	$DB->{$_[0]} = $_[1];
912	}	991	}
913	db_dirty;	992	db_dirty;
914	}	993	}
915		994
916	attach_global	995	cf::global->attach (
917	prio => 10000,	996	prio => 10000,
918	on_cleanup => sub {	997	on_cleanup => sub {
919	db_sync;	998	db_sync;
920	},	999	},
921	;	1000	);
922	}	1001	}
923		1002
924	#############################################################################	1003	#############################################################################
925	# the server's main()	1004	# the server's main()
926		1005
		1006	sub cfg_load {
		1007	open my $fh, "<:utf8", cf::confdir . "/config"
		1008	or return;
		1009
		1010	local $/;
		1011	*CFG = YAML::Syck::Load <$fh>;
		1012	}
		1013
927	sub main {	1014	sub main {
		1015	cfg_load;
928	db_load;	1016	db_load;
929	load_extensions;	1017	load_extensions;
930	Event::loop;	1018	Event::loop;
931	}	1019	}
932		1020
…		…
938		1026
939	$msg->("reloading...");	1027	$msg->("reloading...");
940		1028
941	eval {	1029	eval {
942	# cancel all watchers	1030	# cancel all watchers
943	$_->cancel for Event::all_watchers;	1031	for (Event::all_watchers) {
		1032	$_->cancel if $_->data & WF_AUTOCANCEL;
		1033	}
944		1034
945	# unload all extensions	1035	# unload all extensions
946	for (@exts) {	1036	for (@exts) {
947	$msg->("unloading <$_>");	1037	$msg->("unloading <$_>");
948	unload_extension $_;	1038	unload_extension $_;
…		…
984		1074
985	# reload cf.pm	1075	# reload cf.pm
986	$msg->("reloading cf.pm");	1076	$msg->("reloading cf.pm");
987	require cf;	1077	require cf;
988		1078
989	# load database again	1079	# load config and database again
		1080	cf::cfg_load;
990	cf::db_load;	1081	cf::db_load;
991		1082
992	# load extensions	1083	# load extensions
993	$msg->("load extensions");	1084	$msg->("load extensions");
994	cf::load_extensions;	1085	cf::load_extensions;
…		…
1007	warn $_[0];	1098	warn $_[0];
1008	print "$_[0]\n";	1099	print "$_[0]\n";
1009	};	1100	};
1010	}	1101	}
1011		1102
		1103	register "<global>", __PACKAGE__;
		1104
1012	register_command "perl-reload", 0, sub {	1105	register_command "perl-reload" => sub {
1013	my ($who, $arg) = @_;	1106	my ($who, $arg) = @_;
1014		1107
1015	if ($who->flag (FLAG_WIZ)) {	1108	if ($who->flag (FLAG_WIZ)) {
1016	_perl_reload {	1109	_perl_reload {
1017	warn $_[0];	1110	warn $_[0];
1018	$who->message ($_[0]);	1111	$who->message ($_[0]);
1019	};	1112	};
1020	}	1113	}
1021	};	1114	};
1022		1115
1023	register "<global>", __PACKAGE__;
1024
1025	unshift @INC, $LIBDIR;	1116	unshift @INC, $LIBDIR;
1026		1117
1027	$TICK_WATCHER = Event->timer (	1118	$TICK_WATCHER = Event->timer (
1028	prio => 1,	1119	prio => 0,
1029	at => $NEXT_TICK \|\| 1,	1120	at => $NEXT_TICK \|\| 1,
		1121	data => WF_AUTOCANCEL,
1030	cb => sub {	1122	cb => sub {
1031	cf::server_tick; # one server iteration	1123	cf::server_tick; # one server iteration
1032		1124
1033	my $NOW = Event::time;	1125	my $NOW = Event::time;
1034	$NEXT_TICK += $TICK;	1126	$NEXT_TICK += $TICK;
1035		1127
1036	# if we are delayed by four ticks, skip them all	1128	# if we are delayed by four ticks or more, skip them all
1037	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1129	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1038		1130
1039	$TICK_WATCHER->at ($NEXT_TICK);	1131	$TICK_WATCHER->at ($NEXT_TICK);
1040	$TICK_WATCHER->start;	1132	$TICK_WATCHER->start;
1041	},	1133	},
1042	);	1134	);
1043		1135
		1136	IO::AIO::max_poll_time $TICK * 0.2;
		1137
		1138	Event->io (fd => IO::AIO::poll_fileno,
		1139	poll => 'r',
		1140	prio => 5,
		1141	data => WF_AUTOCANCEL,
		1142	cb => \&IO::AIO::poll_cb);
		1143
1044	1	1144	1
1045		1145

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.68 by root, Tue Sep 12 23:45:16 2006 UTC vs. Revision 1.93 by root, Thu Dec 21 22:41:35 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.68 by root, Tue Sep 12 23:45:16 2006 UTC vs.
Revision 1.93 by root, Thu Dec 21 22:41:35 2006 UTC