ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.53 by root, Tue Aug 29 13:11:58 2006 UTC vs.
Revision 1.104 by root, Sat Dec 30 16:56:16 2006 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3;
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18
		19	use IO::AIO 2.3;
		20	use YAML::Syck ();
10	use Time::HiRes;	21	use Time::HiRes;
11	use Event;	22
12	$Event::Eval = 1; # no idea why this is required, but it is	23	use Event; $Event::Eval = 1; # no idea why this is required, but it is
13		24
14	use strict;	25	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		26	$YAML::Syck::ImplicitUnicode = 1;
15		27
16	_reload_1;	28	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
17		29
		30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		31
18	our %COMMAND = ();	32	our %COMMAND = ();
		33	our %COMMAND_TIME = ();
		34	our %EXTCMD = ();
		35
19	our @EVENT;	36	our @EVENT;
20	our %PROP_TYPE;	37	our $LIBDIR = datadir . "/ext";
21	our %PROP_IDX;
22	our $LIBDIR = maps_directory "perl";
23		38
24	our $TICK = MAX_TIME * 1e-6;	39	our $TICK = MAX_TIME * 1e-6;
25	our $TICK_WATCHER;	40	our $TICK_WATCHER;
26	our $NEXT_TICK;	41	our $NEXT_TICK;
		42	our $NOW;
		43
		44	our %CFG;
		45
		46	our $UPTIME; $UPTIME ||= time;
		47	our $RUNTIME;
		48
		49	our %MAP; # all maps
		50	our $LINK_MAP; # the special {link} map
		51	our $FREEZE;
		52
		53	binmode STDOUT;
		54	binmode STDERR;
		55
		56	# read virtual server time, if available
		57	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		58	open my $fh, "<", cf::localdir . "/runtime"
		59	or die "unable to read runtime file: $!";
		60	$RUNTIME = <$fh> + 0.;
		61	}
		62
		63	mkdir cf::localdir;
		64	mkdir cf::localdir . "/" . cf::playerdir;
		65	mkdir cf::localdir . "/" . cf::tmpdir;
		66	mkdir cf::localdir . "/" . cf::uniquedir;
		67
		68	our %EXT_CORO;
		69
		70	#############################################################################
		71
		72	=head2 GLOBAL VARIABLES
		73
		74	=over 4
		75
		76	=item $cf::UPTIME
		77
		78	The timestamp of the server start (so not actually an uptime).
		79
		80	=item $cf::RUNTIME
		81
		82	The time this server has run, starts at 0 and is increased by $cf::TICK on
		83	every server tick.
		84
		85	=item $cf::LIBDIR
		86
		87	The perl library directory, where extensions and cf-specific modules can
		88	be found. It will be added to C<@INC> automatically.
		89
		90	=item $cf::NOW
		91
		92	The time of the last (current) server tick.
		93
		94	=item $cf::TICK
		95
		96	The interval between server ticks, in seconds.
		97
		98	=item %cf::CFG
		99
		100	Configuration for the server, loaded from C</etc/crossfire/config>, or
		101	from wherever your confdir points to.
		102
		103	=back
		104
		105	=cut
27		106
28	BEGIN {	107	BEGIN {
29	*CORE::GLOBAL::warn = sub {	108	*CORE::GLOBAL::warn = sub {
30	my $msg = join "", @_;	109	my $msg = join "", @_;
		110	utf8::encode $msg;
		111
31	$msg .= "\n"	112	$msg .= "\n"
32	unless $msg =~ /\n$/;	113	unless $msg =~ /\n$/;
33		114
34	print STDERR "cfperl: $msg";
35	LOG llevError, "cfperl: $msg";	115	LOG llevError, "cfperl: $msg";
36	};	116	};
37	}	117	}
38		118
39	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	119	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
40		120	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
41	# generate property mutators	121	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
42	sub prop_gen {	122	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
43	my ($prefix, $class) = @_;	123	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
44
45	no strict 'refs';
46
47	for my $prop (keys %PROP_TYPE) {
48	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
49	my $sub = lc $1;
50
51	my $type = $PROP_TYPE{$prop};
52	my $idx = $PROP_IDX {$prop};
53
54	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
55	$_[0]->get_property ($type, $idx)
56	};
57
58	*{"$class\::set_$sub"} = sub {
59	$_[0]->set_property ($type, $idx, $_[1]);
60	} unless $ignore_set{$prop};
61	}
62	}
63
64	# auto-generate most of the API
65
66	prop_gen OBJECT_PROP => "cf::object";
67	# CFAPI_OBJECT_ANIMATION?
68	prop_gen PLAYER_PROP => "cf::object::player";
69
70	prop_gen MAP_PROP => "cf::map";
71	prop_gen ARCH_PROP => "cf::arch";
72
73	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	124	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74		125
75	# we bless all objects into (empty) derived classes to force a method lookup	126	# we bless all objects into (empty) derived classes to force a method lookup
76	# within the Safe compartment.	127	# within the Safe compartment.
77	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	128	for my $pkg (qw(
		129	cf::global cf::attachable
		130	cf::object cf::object::player
		131	cf::client cf::player
		132	cf::arch cf::living
		133	cf::map cf::party cf::region
		134	)) {
78	no strict 'refs';	135	no strict 'refs';
79	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	136	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80	}	137	}
81		138
82	$Event::DIED = sub {	139	$Event::DIED = sub {
…		…
84	};	141	};
85		142
86	my %ext_pkg;	143	my %ext_pkg;
87	my @exts;	144	my @exts;
88	my @hook;	145	my @hook;
89	my %command;
90	my %extcmd;
91		146
92	#############################################################################	147	=head2 UTILITY FUNCTIONS
93	# utility functions	148
		149	=over 4
		150
		151	=cut
94		152
95	use JSON::Syck (); # TODO# replace by JSON::PC once working	153	use JSON::Syck (); # TODO# replace by JSON::PC once working
		154
		155	=item $ref = cf::from_json $json
		156
		157	Converts a JSON string into the corresponding perl data structure.
		158
		159	=cut
96		160
97	sub from_json($) {	161	sub from_json($) {
98	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	162	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99	JSON::Syck::Load $_[0]	163	JSON::Syck::Load $_[0]
100	}	164	}
101		165
		166	=item $json = cf::to_json $ref
		167
		168	Converts a perl data structure into its JSON representation.
		169
		170	=cut
		171
102	sub to_json($) {	172	sub to_json($) {
103	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	173	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104	JSON::Syck::Dump $_[0]	174	JSON::Syck::Dump $_[0]
105	}	175	}
106		176
		177	=item $coro = cf::coro { BLOCK }
		178
		179	Creates and returns a new coro. This coro is automcatially being canceled
		180	when the extension calling this is being unloaded.
		181
		182	=cut
		183
		184	sub coro(&) {
		185	my $cb = shift;
		186
		187	my $coro; $coro = async {
		188	eval {
		189	$cb->();
		190	};
		191	warn $@ if $@;
		192	};
		193
		194	$coro->on_destroy (sub {
		195	delete $EXT_CORO{$coro+0};
		196	});
		197	$EXT_CORO{$coro+0} = $coro;
		198
		199	$coro
		200	}
		201
		202	=back
		203
		204	=cut
		205
107	#############################################################################	206	#############################################################################
108	# "new" plug-in system
109		207
110	=item $object->attach ($attachment, key => $value...)	208	=head2 ATTACHABLE OBJECTS
111		209
112	=item $object->detach ($attachment)	210	Many objects in crossfire are so-called attachable objects. That means you can
		211	attach callbacks/event handlers (a collection of which is called an "attachment")
		212	to it. All such attachable objects support the following methods.
113		213
114	Attach/detach a pre-registered attachment to an object.	214	In the following description, CLASS can be any of C<global>, C<object>
		215	C<player>, C<client> or C<map> (i.e. the attachable objects in
		216	crossfire+).
115		217
116	=item $player->attach ($attachment, key => $value...)	218	=over 4
117		219
118	=item $player->detach ($attachment)
119
120	Attach/detach a pre-registered attachment to a player.
121
122	=item $map->attach ($attachment, key => $value...)	220	=item $attachable->attach ($attachment, key => $value...)
123		221
124	=item $map->detach ($attachment)	222	=item $attachable->detach ($attachment)
125		223
126	Attach/detach a pre-registered attachment to a map.	224	Attach/detach a pre-registered attachment to a specific object and give it
		225	the specified key/value pairs as arguments.
127		226
128	=item cf::attach_global ...	227	Example, attach a minesweeper attachment to the given object, making it a
		228	10x10 minesweeper game:
129		229
130	Attach handlers for global events.	230	$obj->attach (minesweeper => width => 10, height => 10);
131		231
132	This and all following C<attach_*>-functions expect any number of the	232	=item $bool = $attachable->attached ($name)
133	following handler/hook descriptions:	233
		234	Checks wether the named attachment is currently attached to the object.
		235
		236	=item cf::CLASS->attach ...
		237
		238	=item cf::CLASS->detach ...
		239
		240	Define an anonymous attachment and attach it to all objects of the given
		241	CLASS. See the next function for an explanation of its arguments.
		242
		243	You can attach to global events by using the C<cf::global> class.
		244
		245	Example, log all player logins:
		246
		247	cf::player->attach (
		248	on_login => sub {
		249	my ($pl) = @_;
		250	...
		251	},
		252	);
		253
		254	Example, attach to the jeweler skill:
		255
		256	cf::object->attach (
		257	type => cf::SKILL,
		258	subtype => cf::SK_JEWELER,
		259	on_use_skill => sub {
		260	my ($sk, $ob, $part, $dir, $msg) = @_;
		261	...
		262	},
		263	);
		264
		265	=item cf::CLASS::attachment $name, ...
		266
		267	Register an attachment by C<$name> through which attachable objects of the
		268	given CLASS can refer to this attachment.
		269
		270	Some classes such as crossfire maps and objects can specify attachments
		271	that are attached at load/instantiate time, thus the need for a name.
		272
		273	These calls expect any number of the following handler/hook descriptions:
134		274
135	=over 4	275	=over 4
136		276
137	=item prio => $number	277	=item prio => $number
138		278
…		…
140	by another C<prio> setting). Lower priority handlers get executed	280	by another C<prio> setting). Lower priority handlers get executed
141	earlier. The default priority is C<0>, and many built-in handlers are	281	earlier. The default priority is C<0>, and many built-in handlers are
142	registered at priority C<-1000>, so lower priorities should not be used	282	registered at priority C<-1000>, so lower priorities should not be used
143	unless you know what you are doing.	283	unless you know what you are doing.
144		284
		285	=item type => $type
		286
		287	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		288	given type of objects only (the additional parameter C<subtype> can be
		289	used to further limit to the given subtype).
		290
145	=item on_I<event> => \&cb	291	=item on_I<event> => \&cb
146		292
147	Call the given code reference whenever the named event happens (event is	293	Call the given code reference whenever the named event happens (event is
148	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	294	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
149	handlers are recognised generally depends on the type of object these	295	handlers are recognised generally depends on the type of object these
…		…
158	package and register them. Only handlers for eevents supported by the	304	package and register them. Only handlers for eevents supported by the
159	object/class are recognised.	305	object/class are recognised.
160		306
161	=back	307	=back
162		308
163	=item cf::attach_to_type $object_type, $subtype, ...	309	Example, define an attachment called "sockpuppet" that calls the given
		310	event handler when a monster attacks:
164		311
165	Attach handlers for a specific object type (e.g. TRANSPORT) and	312	cf::object::attachment sockpuppet =>
166	subtype. If C<$subtype> is zero or undef, matches all objects of the given	313	on_skill_attack => sub {
167	type.	314	my ($self, $victim) = @_;
		315	...
		316	}
		317	}
168		318
169	=item cf::attach_to_objects ...	319	=item $attachable->valid
170		320
171	Attach handlers to all objects. Do not use this except for debugging or	321	Just because you have a perl object does not mean that the corresponding
172	very rare events, as handlers are (obviously) called for I<all> objects in	322	C-level object still exists. If you try to access an object that has no
173	the game.	323	valid C counterpart anymore you get an exception at runtime. This method
174		324	can be used to test for existence of the C object part without causing an
175	=item cf::attach_to_players ...	325	exception.
176
177	Attach handlers to all players.
178
179	=item cf::attach_to_maps ...
180
181	Attach handlers to all maps.
182
183	=item cf:register_attachment $name, ...
184
185	Register an attachment by name through which objects can refer to this
186	attachment.
187
188	=item cf:register_map_attachment $name, ...
189
190	Register an attachment by name through which maps can refer to this
191	attachment.
192		326
193	=cut	327	=cut
194		328
195	# the following variables are defined in .xs and must not be re-created	329	# the following variables are defined in .xs and must not be re-created
196	our @CB_GLOBAL = (); # registry for all global events	330	our @CB_GLOBAL = (); # registry for all global events
		331	our @CB_ATTACHABLE = (); # registry for all attachables
197	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	332	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
198	our @CB_PLAYER = ();	333	our @CB_PLAYER = ();
		334	our @CB_CLIENT = ();
199	our @CB_TYPE = (); # registry for type (cf-object class) based events	335	our @CB_TYPE = (); # registry for type (cf-object class) based events
200	our @CB_MAP = ();	336	our @CB_MAP = ();
201		337
202	my %attachment;	338	my %attachment;
203		339
204	sub _attach_cb($\%$$$) {	340	sub _attach_cb($$$$) {
205	my ($registry, $undo, $event, $prio, $cb) = @_;	341	my ($registry, $event, $prio, $cb) = @_;
206		342
207	use sort 'stable';	343	use sort 'stable';
208		344
209	$cb = [$prio, $cb];	345	$cb = [$prio, $cb];
210		346
211	@{$registry->[$event]} = sort	347	@{$registry->[$event]} = sort
212	{ $a->[0] cmp $b->[0] }	348	{ $a->[0] cmp $b->[0] }
213	@{$registry->[$event] || []}, $cb;	349	@{$registry->[$event] || []}, $cb;
214
215	push @{$undo->{cb}}, [$event, $cb];
216	}	350	}
		351
		352	# hack
		353	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
217		354
218	# attach handles attaching event callbacks	355	# attach handles attaching event callbacks
219	# the only thing the caller has to do is pass the correct	356	# the only thing the caller has to do is pass the correct
220	# registry (== where the callback attaches to).	357	# registry (== where the callback attaches to).
221	sub _attach(\@$@) {	358	sub _attach {
222	my ($registry, $klass, @arg) = @_;	359	my ($registry, $klass, @arg) = @_;
223		360
		361	my $object_type;
224	my $prio = 0;	362	my $prio = 0;
225
226	my %undo = (
227	registry => $registry,
228	cb => [],
229	);
230
231	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	363	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		364
		365	#TODO: get rid of this hack
		366	if ($attachable_klass{$klass}) {
		367	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		368	}
232		369
233	while (@arg) {	370	while (@arg) {
234	my $type = shift @arg;	371	my $type = shift @arg;
235		372
236	if ($type eq "prio") {	373	if ($type eq "prio") {
237	$prio = shift @arg;	374	$prio = shift @arg;
238		375
		376	} elsif ($type eq "type") {
		377	$object_type = shift @arg;
		378	$registry = $CB_TYPE[$object_type] ||= [];
		379
		380	} elsif ($type eq "subtype") {
		381	defined $object_type or Carp::croak "subtype specified without type";
		382	my $object_subtype = shift @arg;
		383	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		384
239	} elsif ($type eq "package") {	385	} elsif ($type eq "package") {
240	my $pkg = shift @arg;	386	my $pkg = shift @arg;
241		387
242	while (my ($name, $id) = each %cb_id) {	388	while (my ($name, $id) = each %cb_id) {
243	if (my $cb = $pkg->can ($name)) {	389	if (my $cb = $pkg->can ($name)) {
244	_attach_cb $registry, %undo, $id, $prio, $cb;	390	_attach_cb $registry, $id, $prio, $cb;
245	}	391	}
246	}	392	}
247		393
248	} elsif (exists $cb_id{$type}) {	394	} elsif (exists $cb_id{$type}) {
249	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	395	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
250		396
251	} elsif (ref $type) {	397	} elsif (ref $type) {
252	warn "attaching objects not supported, ignoring.\n";	398	warn "attaching objects not supported, ignoring.\n";
253		399
254	} else {	400	} else {
255	shift @arg;	401	shift @arg;
256	warn "attach argument '$type' not supported, ignoring.\n";	402	warn "attach argument '$type' not supported, ignoring.\n";
257	}	403	}
258	}	404	}
259
260	\%undo
261	}	405	}
262		406
263	sub _attach_attachment {	407	sub _object_attach {
264	my ($obj, $name, %arg) = @_;	408	my ($obj, $name, %arg) = @_;
265		409
266	my $res;	410	return if exists $obj->{_attachment}{$name};
267		411
268	if (my $attach = $attachment{$name}) {	412	if (my $attach = $attachment{$name}) {
269	my $registry = $obj->registry;	413	my $registry = $obj->registry;
270		414
271	for (@$attach) {	415	for (@$attach) {
272	my ($klass, @attach) = @$_;	416	my ($klass, @attach) = @$_;
273	$res = _attach @$registry, $klass, @attach;	417	_attach $registry, $klass, @attach;
274	}	418	}
275		419
276	$obj->{$name} = \%arg;	420	$obj->{$name} = \%arg;
277	} else {	421	} else {
278	warn "object uses attachment '$name' that is not available, postponing.\n";	422	warn "object uses attachment '$name' that is not available, postponing.\n";
279	}	423	}
280		424
281	$obj->{_attachment}{$name} = undef;	425	$obj->{_attachment}{$name} = undef;
282
283	$res->{attachment} = $name;
284	$res
285	}	426	}
286		427
287	sub cf::object::attach {	428	sub cf::attachable::attach {
288	my ($obj, $name, %arg) = @_;	429	if (ref $_[0]) {
		430	_object_attach @_;
		431	} else {
		432	_attach shift->_attach_registry, @_;
		433	}
		434	};
289		435
290	_attach_attachment $obj, $name, %arg;	436	# all those should be optimised
291	}
292
293	sub cf::player::attach {
294	my ($obj, $name, %arg) = @_;
295
296	_attach_attachment $obj, $name, %arg;
297	}
298
299	sub cf::map::attach {
300	my ($obj, $name, %arg) = @_;
301
302	_attach_attachment $obj, $name, %arg;
303	}
304
305	sub cf::object::detach {	437	sub cf::attachable::detach {
306	my ($obj, $name) = @_;	438	my ($obj, $name) = @_;
307	die;#d#	439
308	}	440	if (ref $obj) {
309	sub cf::player::detach {	441	delete $obj->{_attachment}{$name};
		442	reattach ($obj);
		443	} else {
		444	Carp::croak "cannot, currently, detach class attachments";
		445	}
		446	};
		447
		448	sub cf::attachable::attached {
310	my ($obj, $name) = @_;	449	my ($obj, $name) = @_;
311	die;#d#
312	}
313	sub cf::map::detach {
314	my ($obj, $name) = @_;
315	die;#d#
316	}
317		450
318	sub attach_global {	451	exists $obj->{_attachment}{$name}
319	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
320	}	452	}
321		453
322	sub attach_to_type {	454	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
323	my $type = shift;	455	eval "#line " . __LINE__ . " 'cf.pm'
324	my $subtype = shift;	456	sub cf::\L$klass\E::_attach_registry {
		457	(\\\@CB_$klass, KLASS_$klass)
		458	}
325		459
326	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_	460	sub cf::\L$klass\E::attachment {
327	}
328
329	sub attach_to_objects {
330	_attach @CB_OBJECT, KLASS_OBJECT, @_
331	}
332
333	sub attach_to_players {
334	_attach @CB_PLAYER, KLASS_PLAYER, @_
335	}
336
337	sub attach_to_maps {
338	_attach @CB_MAP, KLASS_MAP, @_
339	}
340
341	sub register_attachment {
342	my $name = shift;	461	my \$name = shift;
343		462
344	$attachment{$name} = [[KLASS_OBJECT, @_]];
345	}
346
347	sub register_map_attachment {
348	my $name = shift;
349
350	$attachment{$name} = [[KLASS_MAP, @_]];	463	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		464	}
		465	";
		466	die if $@;
351	}	467	}
352		468
353	our $override;	469	our $override;
354	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	470	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
355		471
…		…
369	for (@$callbacks) {	485	for (@$callbacks) {
370	eval { &{$_->[1]} };	486	eval { &{$_->[1]} };
371		487
372	if ($@) {	488	if ($@) {
373	warn "$@";	489	warn "$@";
374	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	490	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
375	override;	491	override;
376	}	492	}
377		493
378	return 1 if $override;	494	return 1 if $override;
379	}	495	}
380		496
381	0	497	0
382	}	498	}
		499
		500	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		501
		502	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		503
		504	Generate an object-specific event with the given arguments.
		505
		506	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		507	removed in future versions), and there is no public API to access override
		508	results (if you must, access C<@cf::invoke_results> directly).
		509
		510	=back
		511
		512	=cut
383		513
384	#############################################################################	514	#############################################################################
385	# object support	515	# object support
386		516
387	sub instantiate {
388	my ($obj, $data) = @_;
389
390	$data = from_json $data;
391
392	for (@$data) {
393	my ($name, $args) = @$_;
394
395	$obj->attach ($name, %{$args || {} });
396	}
397	}
398
399	# basically do the same as instantiate, without calling instantiate
400	sub reattach {	517	sub reattach {
		518	# basically do the same as instantiate, without calling instantiate
401	my ($obj) = @_;	519	my ($obj) = @_;
		520
402	my $registry = $obj->registry;	521	my $registry = $obj->registry;
403		522
404	@$registry = ();	523	@$registry = ();
405		524
406	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	525	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
407		526
408	for my $name (keys %{ $obj->{_attachment} || {} }) {	527	for my $name (keys %{ $obj->{_attachment} || {} }) {
409	if (my $attach = $attachment{$name}) {	528	if (my $attach = $attachment{$name}) {
410	for (@$attach) {	529	for (@$attach) {
411	my ($klass, @attach) = @$_;	530	my ($klass, @attach) = @$_;
412	_attach @$registry, $klass, @attach;	531	_attach $registry, $klass, @attach;
413	}	532	}
414	} else {	533	} else {
415	warn "object uses attachment '$name' that is not available, postponing.\n";	534	warn "object uses attachment '$name' that is not available, postponing.\n";
416	}	535	}
417	}	536	}
418	}	537	}
419		538
420	sub object_freezer_save {	539	cf::attachable->attach (
421	my ($filename, $objs) = @_;
422
423	if (@$objs) {
424	open my $fh, ">:raw", "$filename.pst~";
425	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
426	close $fh;
427	chmod SAVE_MODE, "$filename.pst~";
428	rename "$filename.pst~", "$filename.pst";
429	} else {
430	unlink "$filename.pst";
431	}
432
433	chmod SAVE_MODE, "$filename~";
434	rename "$filename~", $filename;
435	}
436
437	sub object_thawer_load {
438	my ($filename) = @_;
439
440	open my $fh, "<:raw:perlio", "$filename.pst"
441	or return;
442
443	eval { local $/; (Storable::thaw <$fh>)->{objs} }
444	}
445
446	attach_to_objects
447	prio => -1000000,	540	prio => -1000000,
		541	on_instantiate => sub {
		542	my ($obj, $data) = @_;
		543
		544	$data = from_json $data;
		545
		546	for (@$data) {
		547	my ($name, $args) = @$_;
		548
		549	$obj->attach ($name, %{$args || {} });
		550	}
		551	},
		552	on_reattach => \&reattach,
448	on_clone => sub {	553	on_clone => sub {
449	my ($src, $dst) = @_;	554	my ($src, $dst) = @_;
450		555
451	@{$dst->registry} = @{$src->registry};	556	@{$dst->registry} = @{$src->registry};
452		557
453	%$dst = %$src;	558	%$dst = %$src;
454		559
455	%{$dst->{_attachment}} = %{$src->{_attachment}}	560	%{$dst->{_attachment}} = %{$src->{_attachment}}
456	if exists $src->{_attachment};	561	if exists $src->{_attachment};
457	},	562	},
458	;	563	);
		564
		565	sub object_freezer_save {
		566	my ($filename, $rdata, $objs) = @_;
		567
		568	if (length $$rdata) {
		569	warn sprintf "saving %s (%d,%d)\n",
		570	$filename, length $$rdata, scalar @$objs;
		571
		572	if (open my $fh, ">:raw", "$filename~") {
		573	chmod SAVE_MODE, $fh;
		574	syswrite $fh, $$rdata;
		575	close $fh;
		576
		577	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		578	chmod SAVE_MODE, $fh;
		579	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
		580	close $fh;
		581	rename "$filename.pst~", "$filename.pst";
		582	} else {
		583	unlink "$filename.pst";
		584	}
		585
		586	rename "$filename~", $filename;
		587	} else {
		588	warn "FATAL: $filename~: $!\n";
		589	}
		590	} else {
		591	unlink $filename;
		592	unlink "$filename.pst";
		593	}
		594	}
		595
		596	sub object_freezer_as_string {
		597	my ($rdata, $objs) = @_;
		598
		599	use Data::Dumper;
		600
		601	$$rdata . Dumper $objs
		602	}
		603
		604	sub object_thawer_load {
		605	my ($filename) = @_;
		606
		607	local $/;
		608
		609	my $av;
		610
		611	#TODO: use sysread etc.
		612	if (open my $data, "<:raw:perlio", $filename) {
		613	$data = <$data>;
		614	if (open my $pst, "<:raw:perlio", "$filename.pst") {
		615	$av = eval { (Storable::thaw <$pst>)->{objs} };
		616	}
		617	return ($data, $av);
		618	}
		619
		620	()
		621	}
459		622
460	#############################################################################	623	#############################################################################
461	# old plug-in events	624	# command handling &c
462		625
463	sub inject_event {	626	=item cf::register_command $name => \&callback($ob,$args);
464	my $extension = shift;
465	my $event_code = shift;
466		627
467	my $cb = $hook[$event_code]{$extension}	628	Register a callback for execution when the client sends the user command
468	or return;	629	$name.
469		630
470	&$cb	631	=cut
471	}
472
473	sub inject_global_event {
474	my $event = shift;
475
476	my $cb = $hook[$event]
477	or return;
478
479	List::Util::max map &$_, values %$cb
480	}
481
482	sub inject_command {
483	my ($name, $obj, $params) = @_;
484
485	for my $cmd (@{ $command{$name} }) {
486	$cmd->[1]->($obj, $params);
487	}
488
489	-1
490	}
491		632
492	sub register_command {	633	sub register_command {
493	my ($name, $time, $cb) = @_;	634	my ($name, $cb) = @_;
494		635
495	my $caller = caller;	636	my $caller = caller;
496	#warn "registering command '$name/$time' to '$caller'";	637	#warn "registering command '$name/$time' to '$caller'";
497		638
498	push @{ $command{$name} }, [$time, $cb, $caller];	639	push @{ $COMMAND{$name} }, [$caller, $cb];
499	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
500	}	640	}
		641
		642	=item cf::register_extcmd $name => \&callback($pl,$packet);
		643
		644	Register a callbackf ro execution when the client sends an extcmd packet.
		645
		646	If the callback returns something, it is sent back as if reply was being
		647	called.
		648
		649	=cut
501		650
502	sub register_extcmd {	651	sub register_extcmd {
503	my ($name, $cb) = @_;	652	my ($name, $cb) = @_;
504		653
505	my $caller = caller;	654	my $caller = caller;
506	#warn "registering extcmd '$name' to '$caller'";	655	#warn "registering extcmd '$name' to '$caller'";
507		656
508	$extcmd{$name} = [$cb, $caller];	657	$EXTCMD{$name} = [$cb, $caller];
509	}	658	}
		659
		660	cf::player->attach (
		661	on_command => sub {
		662	my ($pl, $name, $params) = @_;
		663
		664	my $cb = $COMMAND{$name}
		665	or return;
		666
		667	for my $cmd (@$cb) {
		668	$cmd->[1]->($pl->ob, $params);
		669	}
		670
		671	cf::override;
		672	},
		673	on_extcmd => sub {
		674	my ($pl, $buf) = @_;
		675
		676	my $msg = eval { from_json $buf };
		677
		678	if (ref $msg) {
		679	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		680	if (my %reply = $cb->[0]->($pl, $msg)) {
		681	$pl->ext_reply ($msg->{msgid}, %reply);
		682	}
		683	}
		684	} else {
		685	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		686	}
		687
		688	cf::override;
		689	},
		690	);
510		691
511	sub register {	692	sub register {
512	my ($base, $pkg) = @_;	693	my ($base, $pkg) = @_;
513		694
514	#TODO	695	#TODO
…		…
533	. "#line 1 \"$path\"\n{\n"	714	. "#line 1 \"$path\"\n{\n"
534	. (do { local $/; <$fh> })	715	. (do { local $/; <$fh> })
535	. "\n};\n1";	716	. "\n};\n1";
536		717
537	eval $source	718	eval $source
538	or die "$path: $@";	719	or die $@ ? "$path: $@\n"
		720	: "extension disabled.\n";
539		721
540	push @exts, $pkg;	722	push @exts, $pkg;
541	$ext_pkg{$base} = $pkg;	723	$ext_pkg{$base} = $pkg;
542		724
543	# no strict 'refs';	725	# no strict 'refs';
…		…
556	# for my $idx (0 .. $#PLUGIN_EVENT) {	738	# for my $idx (0 .. $#PLUGIN_EVENT) {
557	# delete $hook[$idx]{$pkg};	739	# delete $hook[$idx]{$pkg};
558	# }	740	# }
559		741
560	# remove commands	742	# remove commands
561	for my $name (keys %command) {	743	for my $name (keys %COMMAND) {
562	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	744	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
563		745
564	if (@cb) {	746	if (@cb) {
565	$command{$name} = \@cb;	747	$COMMAND{$name} = \@cb;
566	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
567	} else {	748	} else {
568	delete $command{$name};
569	delete $COMMAND{"$name\000"};	749	delete $COMMAND{$name};
570	}	750	}
571	}	751	}
572		752
573	# remove extcmds	753	# remove extcmds
574	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	754	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
575	delete $extcmd{$name};	755	delete $EXTCMD{$name};
576	}	756	}
577		757
578	if (my $cb = $pkg->can ("unload")) {	758	if (my $cb = $pkg->can ("unload")) {
579	eval {	759	eval {
580	$cb->($pkg);	760	$cb->($pkg);
…		…
584		764
585	Symbol::delete_package $pkg;	765	Symbol::delete_package $pkg;
586	}	766	}
587		767
588	sub load_extensions {	768	sub load_extensions {
589	my $LIBDIR = maps_directory "perl";
590
591	for my $ext (<$LIBDIR/*.ext>) {	769	for my $ext (<$LIBDIR/*.ext>) {
592	next unless -r $ext;	770	next unless -r $ext;
593	eval {	771	eval {
594	load_extension $ext;	772	load_extension $ext;
595	1	773	1
596	} or warn "$ext not loaded: $@";	774	} or warn "$ext not loaded: $@";
597	}	775	}
598	}	776	}
599		777
600	sub _perl_reload(&) {
601	my ($msg) = @_;
602
603	$msg->("reloading...");
604
605	eval {
606	# 1. cancel all watchers
607	$_->cancel for Event::all_watchers;
608
609	# 2. unload all extensions
610	for (@exts) {
611	$msg->("unloading <$_>");
612	unload_extension $_;
613	}
614
615	# 3. unload all modules loaded from $LIBDIR
616	while (my ($k, $v) = each %INC) {
617	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
618
619	$msg->("removing <$k>");
620	delete $INC{$k};
621
622	$k =~ s/\.pm$//;
623	$k =~ s/\//::/g;
624
625	if (my $cb = $k->can ("unload_module")) {
626	$cb->();
627	}
628
629	Symbol::delete_package $k;
630	}
631
632	# 4. get rid of safe::, as good as possible
633	Symbol::delete_package "safe::$_"
634	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
635
636	# 5. remove register_script_function callbacks
637	# TODO
638
639	# 6. unload cf.pm "a bit"
640	delete $INC{"cf.pm"};
641
642	# don't, removes xs symbols, too,
643	# and global variables created in xs
644	#Symbol::delete_package __PACKAGE__;
645
646	# 7. reload cf.pm
647	$msg->("reloading cf.pm");
648	require cf;
649	};
650	$msg->($@) if $@;
651
652	$msg->("reloaded");
653	};
654
655	sub perl_reload() {
656	_perl_reload {
657	warn $_[0];
658	print "$_[0]\n";
659	};
660	}
661
662	register_command "perl-reload", 0, sub {
663	my ($who, $arg) = @_;
664
665	if ($who->flag (FLAG_WIZ)) {
666	_perl_reload {
667	warn $_[0];
668	$who->message ($_[0]);
669	};
670	}
671	};
672
673	#############################################################################
674	# extcmd framework, basically convert ext <msg>
675	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
676
677	attach_to_players
678	on_extcmd => sub {
679	my ($pl, $buf) = @_;
680
681	my $msg = eval { from_json $buf };
682
683	if (ref $msg) {
684	if (my $cb = $extcmd{$msg->{msgtype}}) {
685	if (my %reply = $cb->[0]->($pl, $msg)) {
686	$pl->ext_reply ($msg->{msgid}, %reply);
687	}
688	}
689	} else {
690	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
691	}
692
693	cf::override;
694	},
695	;
696
697	#############################################################################	778	#############################################################################
698	# load/save/clean perl data associated with a map	779	# load/save/clean perl data associated with a map
699		780
700	*cf::mapsupport::on_clean = sub {	781	*cf::mapsupport::on_clean = sub {
701	my ($map) = @_;	782	my ($map) = @_;
…		…
704	defined $path or return;	785	defined $path or return;
705		786
706	unlink "$path.pst";	787	unlink "$path.pst";
707	};	788	};
708		789
709	# old style persistent data, TODO: remove #d#
710	*cf::mapsupport::on_swapin =
711	*cf::mapsupport::on_load = sub {
712	my ($map) = @_;
713
714	my $path = $map->tmpname;
715	$path = $map->path unless defined $path;
716
717	open my $fh, "<:raw", "$path.cfperl"
718	or return; # no perl data
719
720	my $data = Storable::thaw do { local $/; <$fh> };
721
722	$data->{version} <= 1
723	or return; # too new
724
725	$map->_set_obs ($data->{obs});
726	$map->invoke (EVENT_MAP_UPGRADE);
727	};
728
729	attach_to_maps prio => -10000, package => cf::mapsupport::;	790	cf::map->attach (prio => -10000, package => cf::mapsupport::);
730		791
731	#############################################################################	792	#############################################################################
732	# load/save perl data associated with player->ob objects	793	# load/save perl data associated with player->ob objects
733		794
734	sub all_objects(@) {	795	sub all_objects(@) {
735	@_, map all_objects ($_->inv), @_	796	@_, map all_objects ($_->inv), @_
736	}	797	}
737		798
738	attach_to_players	799	# TODO: compatibility cruft, remove when no longer needed
		800	cf::player->attach (
739	on_load => sub {	801	on_load => sub {
740	my ($pl, $path) = @_;	802	my ($pl, $path) = @_;
741		803
742	for my $o (all_objects $pl->ob) {	804	for my $o (all_objects $pl->ob) {
743	if (my $value = $o->get_ob_key_value ("_perl_data")) {	805	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
745		807
746	%$o = %{ Storable::thaw pack "H*", $value };	808	%$o = %{ Storable::thaw pack "H*", $value };
747	}	809	}
748	}	810	}
749	},	811	},
750	;	812	);
751		813
752	#############################################################################	814	#############################################################################
753	# core extensions - in perl	815
		816	=head2 CORE EXTENSIONS
		817
		818	Functions and methods that extend core crossfire objects.
		819
		820	=head3 cf::player
		821
		822	=over 4
754		823
755	=item cf::player::exists $login	824	=item cf::player::exists $login
756		825
757	Returns true when the given account exists.	826	Returns true when the given account exists.
758		827
…		…
761	sub cf::player::exists($) {	830	sub cf::player::exists($) {
762	cf::player::find $_[0]	831	cf::player::find $_[0]
763	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	832	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
764	}	833	}
765		834
		835	=item $player->ext_reply ($msgid, $msgtype, %msg)
		836
		837	Sends an ext reply to the player.
		838
		839	=cut
		840
		841	sub cf::player::ext_reply($$$%) {
		842	my ($self, $id, %msg) = @_;
		843
		844	$msg{msgid} = $id;
		845
		846	$self->send ("ext " . to_json \%msg);
		847	}
		848
		849	=back
		850
		851	=head3 cf::object::player
		852
		853	=over 4
		854
766	=item $player->reply ($npc, $msg[, $flags])	855	=item $player_object->reply ($npc, $msg[, $flags])
767		856
768	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	857	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
769	can be C<undef>. Does the right thing when the player is currently in a	858	can be C<undef>. Does the right thing when the player is currently in a
770	dialogue with the given NPC character.	859	dialogue with the given NPC character.
771		860
772	=cut	861	=cut
773		862
774	# rough implementation of a future "reply" method that works	863	# rough implementation of a future "reply" method that works
775	# with dialog boxes.	864	# with dialog boxes.
		865	#TODO: the first argument must go, split into a $npc->reply_to ( method
776	sub cf::object::player::reply($$$;$) {	866	sub cf::object::player::reply($$$;$) {
777	my ($self, $npc, $msg, $flags) = @_;	867	my ($self, $npc, $msg, $flags) = @_;
778		868
779	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	869	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
780		870
…		…
784	$msg = $npc->name . " says: $msg" if $npc;	874	$msg = $npc->name . " says: $msg" if $npc;
785	$self->message ($msg, $flags);	875	$self->message ($msg, $flags);
786	}	876	}
787	}	877	}
788		878
789	=item $player->ext_reply ($msgid, $msgtype, %msg)	879	=item $player_object->may ("access")
790		880
791	Sends an ext reply to the player.	881	Returns wether the given player is authorized to access resource "access"
		882	(e.g. "command_wizcast").
792		883
793	=cut	884	=cut
794		885
795	sub cf::player::ext_reply($$$%) {	886	sub cf::object::player::may {
		887	my ($self, $access) = @_;
		888
		889	$self->flag (cf::FLAG_WIZ) ||
		890	(ref $cf::CFG{"may_$access"}
		891	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		892	: $cf::CFG{"may_$access"})
		893	}
		894
		895	=head3 cf::client
		896
		897	=over 4
		898
		899	=item $client->send_drawinfo ($text, $flags)
		900
		901	Sends a drawinfo packet to the client. Circumvents output buffering so
		902	should not be used under normal circumstances.
		903
		904	=cut
		905
		906	sub cf::client::send_drawinfo {
		907	my ($self, $text, $flags) = @_;
		908
		909	utf8::encode $text;
		910	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		911	}
		912
		913
		914	=item $success = $client->query ($flags, "text", \&cb)
		915
		916	Queues a query to the client, calling the given callback with
		917	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		918	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		919
		920	Queries can fail, so check the return code. Or don't, as queries will become
		921	reliable at some point in the future.
		922
		923	=cut
		924
		925	sub cf::client::query {
		926	my ($self, $flags, $text, $cb) = @_;
		927
		928	return unless $self->state == ST_PLAYING
		929	|| $self->state == ST_SETUP
		930	|| $self->state == ST_CUSTOM;
		931
		932	$self->state (ST_CUSTOM);
		933
		934	utf8::encode $text;
		935	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		936
		937	$self->send_packet ($self->{query_queue}[0][0])
		938	if @{ $self->{query_queue} } == 1;
		939	}
		940
		941	cf::client->attach (
		942	on_reply => sub {
		943	my ($ns, $msg) = @_;
		944
		945	# this weird shuffling is so that direct followup queries
		946	# get handled first
		947	my $queue = delete $ns->{query_queue};
		948
		949	(shift @$queue)->[1]->($msg);
		950
		951	push @{ $ns->{query_queue} }, @$queue;
		952
		953	if (@{ $ns->{query_queue} } == @$queue) {
		954	if (@$queue) {
		955	$ns->send_packet ($ns->{query_queue}[0][0]);
		956	} else {
		957	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		958	}
		959	}
		960	},
		961	);
		962
		963	=item $client->coro (\&cb)
		964
		965	Create a new coroutine, running the specified callback. The coroutine will
		966	be automatically cancelled when the client gets destroyed (e.g. on logout,
		967	or loss of connection).
		968
		969	=cut
		970
		971	sub cf::client::coro {
796	my ($self, $id, %msg) = @_;	972	my ($self, $cb) = @_;
797		973
798	$msg{msgid} = $id;	974	my $coro; $coro = async {
		975	eval {
		976	$cb->();
		977	};
		978	warn $@ if $@;
		979	};
799		980
800	$self->send ("ext " . to_json \%msg);	981	$coro->on_destroy (sub {
801	}	982	delete $self->{_coro}{$coro+0};
		983	});
802		984
803	#############################################################################	985	$self->{_coro}{$coro+0} = $coro;
804	# map scripting support	986
		987	$coro
		988	}
		989
		990	cf::client->attach (
		991	on_destroy => sub {
		992	my ($ns) = @_;
		993
		994	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		995	},
		996	);
		997
		998	=back
		999
		1000
		1001	=head2 SAFE SCRIPTING
		1002
		1003	Functions that provide a safe environment to compile and execute
		1004	snippets of perl code without them endangering the safety of the server
		1005	itself. Looping constructs, I/O operators and other built-in functionality
		1006	is not available in the safe scripting environment, and the number of
		1007	functions and methods that can be called is greatly reduced.
		1008
		1009	=cut
805		1010
806	our $safe = new Safe "safe";	1011	our $safe = new Safe "safe";
807	our $safe_hole = new Safe::Hole;	1012	our $safe_hole = new Safe::Hole;
808		1013
809	$SIG{FPE} = 'IGNORE';	1014	$SIG{FPE} = 'IGNORE';
810		1015
811	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	1016	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
812		1017
813	# here we export the classes and methods available to script code	1018	# here we export the classes and methods available to script code
814		1019
		1020	=pod
		1021
		1022	The following fucntions and emthods are available within a safe environment:
		1023
		1024	cf::object contr pay_amount pay_player map
		1025	cf::object::player player
		1026	cf::player peaceful
		1027	cf::map trigger
		1028
		1029	=cut
		1030
815	for (	1031	for (
816	["cf::object" => qw(contr pay_amount pay_player)],	1032	["cf::object" => qw(contr pay_amount pay_player map)],
817	["cf::object::player" => qw(player)],	1033	["cf::object::player" => qw(player)],
818	["cf::player" => qw(peaceful)],	1034	["cf::player" => qw(peaceful)],
		1035	["cf::map" => qw(trigger)],
819	) {	1036	) {
820	no strict 'refs';	1037	no strict 'refs';
821	my ($pkg, @funs) = @$_;	1038	my ($pkg, @funs) = @$_;
822	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1039	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
823	for @funs;	1040	for @funs;
824	}	1041	}
		1042
		1043	=over 4
		1044
		1045	=item @retval = safe_eval $code, [var => value, ...]
		1046
		1047	Compiled and executes the given perl code snippet. additional var/value
		1048	pairs result in temporary local (my) scalar variables of the given name
		1049	that are available in the code snippet. Example:
		1050
		1051	my $five = safe_eval '$first + $second', first => 1, second => 4;
		1052
		1053	=cut
825		1054
826	sub safe_eval($;@) {	1055	sub safe_eval($;@) {
827	my ($code, %vars) = @_;	1056	my ($code, %vars) = @_;
828		1057
829	my $qcode = $code;	1058	my $qcode = $code;
…		…
852	}	1081	}
853		1082
854	wantarray ? @res : $res[0]	1083	wantarray ? @res : $res[0]
855	}	1084	}
856		1085
		1086	=item cf::register_script_function $function => $cb
		1087
		1088	Register a function that can be called from within map/npc scripts. The
		1089	function should be reasonably secure and should be put into a package name
		1090	like the extension.
		1091
		1092	Example: register a function that gets called whenever a map script calls
		1093	C<rent::overview>, as used by the C<rent> extension.
		1094
		1095	cf::register_script_function "rent::overview" => sub {
		1096	...
		1097	};
		1098
		1099	=cut
		1100
857	sub register_script_function {	1101	sub register_script_function {
858	my ($fun, $cb) = @_;	1102	my ($fun, $cb) = @_;
859		1103
860	no strict 'refs';	1104	no strict 'refs';
861	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1105	*{"safe::$fun"} = $safe_hole->wrap ($cb);
862	}	1106	}
863		1107
		1108	=back
		1109
		1110	=cut
		1111
		1112	#############################################################################
		1113
		1114	=head2 EXTENSION DATABASE SUPPORT
		1115
		1116	Crossfire maintains a very simple database for extension use. It can
		1117	currently store anything that can be serialised using Storable, which
		1118	excludes objects.
		1119
		1120	The parameter C<$family> should best start with the name of the extension
		1121	using it, it should be unique.
		1122
		1123	=over 4
		1124
		1125	=item $hashref = cf::db_get $family
		1126
		1127	Return a hashref for use by the extension C<$family>, which can be
		1128	modified. After modifications, you have to call C<cf::db_dirty> or
		1129	C<cf::db_sync>.
		1130
		1131	=item $value = cf::db_get $family => $key
		1132
		1133	Returns a single value from the database
		1134
		1135	=item cf::db_put $family => $hashref
		1136
		1137	Stores the given family hashref into the database. Updates are delayed, if
		1138	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		1139
		1140	=item cf::db_put $family => $key => $value
		1141
		1142	Stores the given C<$value> in the family hash. Updates are delayed, if you
		1143	want the data to be synced to disk immediately, use C<cf::db_sync>.
		1144
		1145	=item cf::db_dirty
		1146
		1147	Marks the database as dirty, to be updated at a later time.
		1148
		1149	=item cf::db_sync
		1150
		1151	Immediately write the database to disk I<if it is dirty>.
		1152
		1153	=cut
		1154
		1155	our $DB;
		1156
		1157	{
		1158	my $path = cf::localdir . "/database.pst";
		1159
		1160	sub db_load() {
		1161	warn "loading database $path\n";#d# remove later
		1162	$DB = stat $path ? Storable::retrieve $path : { };
		1163	}
		1164
		1165	my $pid;
		1166
		1167	sub db_save() {
		1168	warn "saving database $path\n";#d# remove later
		1169	waitpid $pid, 0 if $pid;
		1170	if (0 == ($pid = fork)) {
		1171	$DB->{_meta}{version} = 1;
		1172	Storable::nstore $DB, "$path~";
		1173	rename "$path~", $path;
		1174	cf::_exit 0 if defined $pid;
		1175	}
		1176	}
		1177
		1178	my $dirty;
		1179
		1180	sub db_sync() {
		1181	db_save if $dirty;
		1182	undef $dirty;
		1183	}
		1184
		1185	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
		1186	db_sync;
		1187	});
		1188
		1189	sub db_dirty() {
		1190	$dirty = 1;
		1191	$idle->start;
		1192	}
		1193
		1194	sub db_get($;$) {
		1195	@_ >= 2
		1196	? $DB->{$_[0]}{$_[1]}
		1197	: ($DB->{$_[0]} ||= { })
		1198	}
		1199
		1200	sub db_put($$;$) {
		1201	if (@_ >= 3) {
		1202	$DB->{$_[0]}{$_[1]} = $_[2];
		1203	} else {
		1204	$DB->{$_[0]} = $_[1];
		1205	}
		1206	db_dirty;
		1207	}
		1208
		1209	cf::global->attach (
		1210	prio => 10000,
		1211	on_cleanup => sub {
		1212	db_sync;
		1213	},
		1214	);
		1215	}
		1216
864	#############################################################################	1217	#############################################################################
865	# the server's main()	1218	# the server's main()
866		1219
		1220	sub cfg_load {
		1221	open my $fh, "<:utf8", cf::confdir . "/config"
		1222	or return;
		1223
		1224	local $/;
		1225	*CFG = YAML::Syck::Load <$fh>;
		1226	}
		1227
867	sub main {	1228	sub main {
		1229	cfg_load;
		1230	db_load;
		1231	load_extensions;
868	Event::loop;	1232	Event::loop;
869	}	1233	}
870		1234
871	#############################################################################	1235	#############################################################################
872	# initialisation	1236	# initialisation
873		1237
		1238	sub _perl_reload() {
		1239	warn "reloading...";
		1240
		1241	eval {
		1242	local $FREEZE = 1;
		1243
		1244	cf::emergency_save;
		1245
		1246	# cancel all watchers
		1247	for (Event::all_watchers) {
		1248	$_->cancel if $_->data & WF_AUTOCANCEL;
		1249	}
		1250
		1251	# cancel all extension coros
		1252	$_->cancel for values %EXT_CORO;
		1253	%EXT_CORO = ();
		1254
		1255	# unload all extensions
		1256	for (@exts) {
		1257	warn "unloading <$_>";
		1258	unload_extension $_;
		1259	}
		1260
		1261	# unload all modules loaded from $LIBDIR
		1262	while (my ($k, $v) = each %INC) {
		1263	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1264
		1265	warn "removing <$k>";
		1266	delete $INC{$k};
		1267
		1268	$k =~ s/\.pm$//;
		1269	$k =~ s/\//::/g;
		1270
		1271	if (my $cb = $k->can ("unload_module")) {
		1272	$cb->();
		1273	}
		1274
		1275	Symbol::delete_package $k;
		1276	}
		1277
		1278	# sync database to disk
		1279	cf::db_sync;
		1280	IO::AIO::flush;
		1281
		1282	# get rid of safe::, as good as possible
		1283	Symbol::delete_package "safe::$_"
		1284	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		1285
		1286	# remove register_script_function callbacks
		1287	# TODO
		1288
		1289	# unload cf.pm "a bit"
		1290	delete $INC{"cf.pm"};
		1291
		1292	# don't, removes xs symbols, too,
		1293	# and global variables created in xs
		1294	#Symbol::delete_package __PACKAGE__;
		1295
		1296	# reload cf.pm
		1297	warn "reloading cf.pm";
		1298	require cf;
		1299	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		1300
		1301	# load config and database again
		1302	cf::cfg_load;
		1303	cf::db_load;
		1304
		1305	# load extensions
		1306	warn "load extensions";
		1307	cf::load_extensions;
		1308
		1309	# reattach attachments to objects
		1310	warn "reattach";
		1311	_global_reattach;
		1312	};
		1313	warn $@ if $@;
		1314
		1315	warn "reloaded";
		1316	};
		1317
		1318	sub perl_reload() {
		1319	_perl_reload;
		1320	}
		1321
874	register "<global>", __PACKAGE__;	1322	register "<global>", __PACKAGE__;
875		1323
		1324	register_command "perl-reload" => sub {
		1325	my ($who, $arg) = @_;
		1326
		1327	if ($who->flag (FLAG_WIZ)) {
		1328	$who->message ("reloading...");
		1329	_perl_reload;
		1330	}
		1331	};
		1332
876	unshift @INC, $LIBDIR;	1333	unshift @INC, $LIBDIR;
877		1334
878	load_extensions;
879
880	$TICK_WATCHER = Event->timer (	1335	$TICK_WATCHER = Event->timer (
		1336	reentrant => 0,
881	prio => 1,	1337	prio => 0,
882	at => $NEXT_TICK || 1,	1338	at => $NEXT_TICK || $TICK,
		1339	data => WF_AUTOCANCEL,
883	cb => sub {	1340	cb => sub {
		1341	unless ($FREEZE) {
884	cf::server_tick; # one server iteration	1342	cf::server_tick; # one server iteration
		1343	$RUNTIME += $TICK;
		1344	}
885		1345
886	my $NOW = Event::time;
887	$NEXT_TICK += $TICK;	1346	$NEXT_TICK += $TICK;
888		1347
889	# if we are delayed by four ticks, skip them all	1348	# if we are delayed by four ticks or more, skip them all
890	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1349	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
891		1350
892	$TICK_WATCHER->at ($NEXT_TICK);	1351	$TICK_WATCHER->at ($NEXT_TICK);
893	$TICK_WATCHER->start;	1352	$TICK_WATCHER->start;
894	},	1353	},
895	);	1354	);
896		1355
897	_reload_2;	1356	IO::AIO::max_poll_time $TICK * 0.2;
		1357
		1358	Event->io (fd => IO::AIO::poll_fileno,
		1359	poll => 'r',
		1360	prio => 5,
		1361	data => WF_AUTOCANCEL,
		1362	cb => \&IO::AIO::poll_cb);
		1363
		1364	# we must not ever block the main coroutine
		1365	$Coro::idle = sub {
		1366	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1367	warn "FATAL: Coro::idle was called, major BUG\n";
		1368	(Coro::unblock_sub {
		1369	Event::one_event;
		1370	})->();
		1371	};
898		1372
899	1	1373	1
900		1374

Diff Legend

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