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.46 by root, Sun Aug 27 16:15:12 2006 UTC vs.
Revision 1.103 by root, Sat Dec 30 10:16:11 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
		28	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
		29
		30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		31
16	our %COMMAND = ();	32	our %COMMAND = ();
		33	our %COMMAND_TIME = ();
		34	our %EXTCMD = ();
		35
17	our @EVENT;	36	our @EVENT;
18	our %PROP_TYPE;	37	our $LIBDIR = datadir . "/ext";
19	our %PROP_IDX;
20	our $LIBDIR = maps_directory "perl";
21		38
22	our $TICK = MAX_TIME * 1e-6;	39	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	40	our $TICK_WATCHER;
24	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
25		106
26	BEGIN {	107	BEGIN {
27	*CORE::GLOBAL::warn = sub {	108	*CORE::GLOBAL::warn = sub {
28	my $msg = join "", @_;	109	my $msg = join "", @_;
		110	utf8::encode $msg;
		111
29	$msg .= "\n"	112	$msg .= "\n"
30	unless $msg =~ /\n$/;	113	unless $msg =~ /\n$/;
31		114
32	print STDERR "cfperl: $msg";
33	LOG llevError, "cfperl: $msg";	115	LOG llevError, "cfperl: $msg";
34	};	116	};
35	}	117	}
36		118
37	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	119	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
38		120	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
39	# generate property mutators	121	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
40	sub prop_gen {	122	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
41	my ($prefix, $class) = @_;	123	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
42
43	no strict 'refs';
44
45	for my $prop (keys %PROP_TYPE) {
46	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
47	my $sub = lc $1;
48
49	my $type = $PROP_TYPE{$prop};
50	my $idx = $PROP_IDX {$prop};
51
52	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
53	$_[0]->get_property ($type, $idx)
54	};
55
56	*{"$class\::set_$sub"} = sub {
57	$_[0]->set_property ($type, $idx, $_[1]);
58	} unless $ignore_set{$prop};
59	}
60	}
61
62	# auto-generate most of the API
63
64	prop_gen OBJECT_PROP => "cf::object";
65	# CFAPI_OBJECT_ANIMATION?
66	prop_gen PLAYER_PROP => "cf::object::player";
67
68	prop_gen MAP_PROP => "cf::map";
69	prop_gen ARCH_PROP => "cf::arch";
70
71	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	124	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
72		125
73	# 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
74	# within the Safe compartment.	127	# within the Safe compartment.
75	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {	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	)) {
76	no strict 'refs';	135	no strict 'refs';
77	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	136	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
78	}	137	}
79		138
80	$Event::DIED = sub {	139	$Event::DIED = sub {
…		…
82	};	141	};
83		142
84	my %ext_pkg;	143	my %ext_pkg;
85	my @exts;	144	my @exts;
86	my @hook;	145	my @hook;
87	my %command;
88	my %extcmd;
89		146
90	#############################################################################	147	=head2 UTILITY FUNCTIONS
91	# utility functions	148
		149	=over 4
		150
		151	=cut
92		152
93	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
94		160
95	sub from_json($) {	161	sub from_json($) {
96	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	162	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
97	JSON::Syck::Load $_[0]	163	JSON::Syck::Load $_[0]
98	}	164	}
99		165
		166	=item $json = cf::to_json $ref
		167
		168	Converts a perl data structure into its JSON representation.
		169
		170	=cut
		171
100	sub to_json($) {	172	sub to_json($) {
101	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	173	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
102	JSON::Syck::Dump $_[0]	174	JSON::Syck::Dump $_[0]
103	}	175	}
104		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
105	#############################################################################	206	#############################################################################
106	# "new" plug-in system
107		207
108	=item $object->attach ($attachment, ...)	208	=head2 ATTACHABLE OBJECTS
109		209
110	Attach a pre-registered attachment to an object.	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.
111		213
112	=item $player->attach ($attachment, ...)	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+).
113		217
114	Attach a pre-registered attachment to a player.	218	=over 4
115		219
116	=item $map->attach ($attachment, ...) # not yet persistent	220	=item $attachable->attach ($attachment, key => $value...)
117		221
118	Attach a pre-registered attachment to a map.	222	=item $attachable->detach ($attachment)
119		223
120	=item cf::attach_global ...	224	Attach/detach a pre-registered attachment to a specific object and give it
		225	the specified key/value pairs as arguments.
121		226
122	Attach handlers for global events.	227	Example, attach a minesweeper attachment to the given object, making it a
		228	10x10 minesweeper game:
123		229
124	This and all following C<attach_*>-functions expect any number of the	230	$obj->attach (minesweeper => width => 10, height => 10);
125	following handler/hook descriptions:	231
		232	=item $bool = $attachable->attached ($name)
		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:
126		274
127	=over 4	275	=over 4
128		276
129	=item prio => $number	277	=item prio => $number
130		278
…		…
132	by another C<prio> setting). Lower priority handlers get executed	280	by another C<prio> setting). Lower priority handlers get executed
133	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
134	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
135	unless you know what you are doing.	283	unless you know what you are doing.
136		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
137	=item on_I<event> => \&cb	291	=item on_I<event> => \&cb
138		292
139	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
140	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
141	handlers are recognised generally depends on the type of object these	295	handlers are recognised generally depends on the type of object these
…		…
150	package and register them. Only handlers for eevents supported by the	304	package and register them. Only handlers for eevents supported by the
151	object/class are recognised.	305	object/class are recognised.
152		306
153	=back	307	=back
154		308
155	=item cf::attach_to_type $object_type, ...	309	Example, define an attachment called "sockpuppet" that calls the given
		310	event handler when a monster attacks:
156		311
157	Attach handlers for a specific object type (e.g. TRANSPORT).	312	cf::object::attachment sockpuppet =>
		313	on_skill_attack => sub {
		314	my ($self, $victim) = @_;
		315	...
		316	}
		317	}
158		318
159	=item cf::attach_to_objects ...	319	=item $attachable->valid
160		320
161	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
162	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
163	the game.	323	valid C counterpart anymore you get an exception at runtime. This method
164		324	can be used to test for existence of the C object part without causing an
165	=item cf::attach_to_players ...	325	exception.
166
167	Attach handlers to all players.
168
169	=item cf::attach_to_maps ...
170
171	Attach handlers to all maps.
172
173	=item cf:register_attachment $name, ...
174		326
175	=cut	327	=cut
176		328
177	# 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
178	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
179	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)
180	our @CB_PLAYER = ();	333	our @CB_PLAYER = ();
		334	our @CB_CLIENT = ();
181	our @CB_TYPE = (); # registry for type (cf-object class) based events	335	our @CB_TYPE = (); # registry for type (cf-object class) based events
182	our @CB_MAP = ();	336	our @CB_MAP = ();
183		337
184	my %attachment;	338	my %attachment;
185		339
186	sub _attach_cb($\%$$$) {	340	sub _attach_cb($$$$) {
187	my ($registry, $undo, $event, $prio, $cb) = @_;	341	my ($registry, $event, $prio, $cb) = @_;
188		342
189	use sort 'stable';	343	use sort 'stable';
190		344
191	$cb = [$prio, $cb];	345	$cb = [$prio, $cb];
192		346
193	@{$registry->[$event]} = sort	347	@{$registry->[$event]} = sort
194	{ $a->[0] cmp $b->[0] }	348	{ $a->[0] cmp $b->[0] }
195	@{$registry->[$event] || []}, $cb;	349	@{$registry->[$event] || []}, $cb;
196
197	push @{$undo->{cb}}, [$event, $cb];
198	}	350	}
		351
		352	# hack
		353	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
199		354
200	# attach handles attaching event callbacks	355	# attach handles attaching event callbacks
201	# 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
202	# registry (== where the callback attaches to).	357	# registry (== where the callback attaches to).
203	sub _attach(\@$@) {	358	sub _attach {
204	my ($registry, $klass, @arg) = @_;	359	my ($registry, $klass, @arg) = @_;
205		360
		361	my $object_type;
206	my $prio = 0;	362	my $prio = 0;
207
208	my %undo = (
209	registry => $registry,
210	cb => [],
211	);
212
213	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	}
214		369
215	while (@arg) {	370	while (@arg) {
216	my $type = shift @arg;	371	my $type = shift @arg;
217		372
218	if ($type eq "prio") {	373	if ($type eq "prio") {
219	$prio = shift @arg;	374	$prio = shift @arg;
220		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
221	} elsif ($type eq "package") {	385	} elsif ($type eq "package") {
222	my $pkg = shift @arg;	386	my $pkg = shift @arg;
223		387
224	while (my ($name, $id) = each %cb_id) {	388	while (my ($name, $id) = each %cb_id) {
225	if (my $cb = $pkg->can ($name)) {	389	if (my $cb = $pkg->can ($name)) {
226	_attach_cb $registry, %undo, $id, $prio, $cb;	390	_attach_cb $registry, $id, $prio, $cb;
227	}	391	}
228	}	392	}
229		393
230	} elsif (exists $cb_id{$type}) {	394	} elsif (exists $cb_id{$type}) {
231	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	395	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
232		396
233	} elsif (ref $type) {	397	} elsif (ref $type) {
234	warn "attaching objects not supported, ignoring.\n";	398	warn "attaching objects not supported, ignoring.\n";
235		399
236	} else {	400	} else {
237	shift @arg;	401	shift @arg;
238	warn "attach argument '$type' not supported, ignoring.\n";	402	warn "attach argument '$type' not supported, ignoring.\n";
239	}	403	}
240	}	404	}
241
242	\%undo
243	}	405	}
244		406
245	sub _attach_attachment {	407	sub _object_attach {
246	my ($klass, $obj, $name, @args) = q_;	408	my ($obj, $name, %arg) = @_;
247		409
248	my $res;	410	return if exists $obj->{_attachment}{$name};
249		411
250	if (my $attach = $attachment{$name}) {	412	if (my $attach = $attachment{$name}) {
251	my $registry = $obj->registry;	413	my $registry = $obj->registry;
252		414
		415	for (@$attach) {
		416	my ($klass, @attach) = @$_;
253	$res = _attach @$registry, $klass, @$attach;	417	_attach $registry, $klass, @attach;
254
255	if (my $cb = delete $registry->[EVENT_OBJECT_INSTANTIATE]) {
256	for (@$cb) {
257	eval { $_->[1]->($obj, @args); };
258	if ($@) {
259	warn "$@";
260	warn "... while processing '$name' instantiate with args <@args>.\n";
261	}
262	}	418	}
263	}	419
		420	$obj->{$name} = \%arg;
264	} else {	421	} else {
265	warn "object uses attachment '$name' that is not available, postponing.\n";	422	warn "object uses attachment '$name' that is not available, postponing.\n";
266	}	423	}
267		424
268	push @{$obj->{_attachment}}, $name;	425	$obj->{_attachment}{$name} = undef;
269
270	$res->{attachment} = $name;
271	$res
272	}	426	}
273		427
274	sub cf::object::attach {	428	sub cf::attachable::attach {
		429	if (ref $_[0]) {
		430	_object_attach @_;
		431	} else {
		432	_attach shift->_attach_registry, @_;
		433	}
		434	};
		435
		436	# all those should be optimised
		437	sub cf::attachable::detach {
275	my ($obj, $name, @args) = @_;	438	my ($obj, $name) = @_;
276		439
277	_attach_attachment KLASS_OBJECT, $obj, $name, @args;	440	if (ref $obj) {
278	}	441	delete $obj->{_attachment}{$name};
		442	reattach ($obj);
		443	} else {
		444	Carp::croak "cannot, currently, detach class attachments";
		445	}
		446	};
279		447
280	sub cf::player::attach {	448	sub cf::attachable::attached {
281	my ($obj, $name, @args) = @_;	449	my ($obj, $name) = @_;
282		450
283	_attach_attachment KLASS_PLAYER, $obj, $name, @args;	451	exists $obj->{_attachment}{$name}
284	}	452	}
285		453
286	sub cf::map::attach {	454	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
287	my ($obj, $name, @args) = @_;	455	eval "#line " . __LINE__ . " 'cf.pm'
		456	sub cf::\L$klass\E::_attach_registry {
		457	(\\\@CB_$klass, KLASS_$klass)
		458	}
288		459
289	_attach_attachment KLASS_MAP, $obj, $name, @args;	460	sub cf::\L$klass\E::attachment {
290	}
291
292	sub attach_global {
293	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
294	}
295
296	sub attach_to_type {
297	my $type = shift;
298
299	_attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_
300	}
301
302	sub attach_to_objects {
303	_attach @CB_OBJECT, KLASS_OBJECT, @_
304	}
305
306	sub attach_to_players {
307	_attach @CB_PLAYER, KLASS_PLAYER, @_
308	}
309
310	sub attach_to_maps {
311	_attach @CB_MAP, KLASS_MAP, @_
312	}
313
314	sub register_attachment {
315	my $name = shift;	461	my \$name = shift;
316		462
317	$attachment{$name} = [@_];	463	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		464	}
		465	";
		466	die if $@;
318	}	467	}
319		468
320	our $override;	469	our $override;
321	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?
322		471
…		…
336	for (@$callbacks) {	485	for (@$callbacks) {
337	eval { &{$_->[1]} };	486	eval { &{$_->[1]} };
338		487
339	if ($@) {	488	if ($@) {
340	warn "$@";	489	warn "$@";
341	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	490	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342	override;	491	override;
343	}	492	}
344		493
345	return 1 if $override;	494	return 1 if $override;
346	}	495	}
347		496
348	0	497	0
349	}	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
350		513
351	#############################################################################	514	#############################################################################
352	# object support	515	# object support
353		516
354	sub instantiate {
355	my ($obj, $data) = @_;
356
357	$data = from_json $data;
358
359	for (@$data) {
360	my ($name, $args) = @$_;
361	attach $obj, $name, @{$args || [] };
362	}
363	}
364
365	# basically do the same as instantiate, without calling instantiate
366	sub reattach {	517	sub reattach {
367	warn "reattach<@_>\n";#d#	518	# basically do the same as instantiate, without calling instantiate
368	my ($obj) = @_;	519	my ($obj) = @_;
		520
369	my $registry = $obj->registry;	521	my $registry = $obj->registry;
370		522
		523	@$registry = ();
		524
		525	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		526
371	for my $name (@{ $obj->{_attachment} }) {	527	for my $name (keys %{ $obj->{_attachment} || {} }) {
372	if (my $attach = $attachment{$name}) {	528	if (my $attach = $attachment{$name}) {
		529	for (@$attach) {
		530	my ($klass, @attach) = @$_;
373	_attach @$registry, KLASS_OBJECT, @$attach;	531	_attach $registry, $klass, @attach;
		532	}
374	} else {	533	} else {
375	warn "object uses attachment '$name' that is not available, postponing.\n";	534	warn "object uses attachment '$name' that is not available, postponing.\n";
376	}	535	}
377	}	536	}
378
379	warn "reattach<@_, $_>\n";
380	}	537	}
		538
		539	cf::attachable->attach (
		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,
		553	on_clone => sub {
		554	my ($src, $dst) = @_;
		555
		556	@{$dst->registry} = @{$src->registry};
		557
		558	%$dst = %$src;
		559
		560	%{$dst->{_attachment}} = %{$src->{_attachment}}
		561	if exists $src->{_attachment};
		562	},
		563	);
381		564
382	sub object_freezer_save {	565	sub object_freezer_save {
383	my ($filename, $objs) = @_;	566	my ($filename, $rdata, $objs) = @_;
384	warn "freeze $filename\n";#d#
385	use Data::Dumper; print Dumper $objs;
386		567
387	$filename .= ".pst";	568	if (length $$rdata) {
		569	warn sprintf "saving %s (%d,%d)\n",
		570	$filename, length $$rdata, scalar @$objs;
388		571
389	if (@$objs) {
390	open my $fh, ">:raw", "$filename~";	572	if (open my $fh, ">:raw", "$filename~") {
391	chmod $fh, SAVE_MODE;	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;
392	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	579	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
393	close $fh;	580	close $fh;
		581	rename "$filename.pst~", "$filename.pst";
		582	} else {
		583	unlink "$filename.pst";
		584	}
		585
394	rename "$filename~", $filename;	586	rename "$filename~", $filename;
		587	} else {
		588	warn "FATAL: $filename~: $!\n";
		589	}
395	} else {	590	} else {
396	unlink $filename;	591	unlink $filename;
		592	unlink "$filename.pst";
397	}	593	}
		594	}
		595
		596	sub object_freezer_as_string {
		597	my ($rdata, $objs) = @_;
		598
		599	use Data::Dumper;
		600
		601	$$rdata . Dumper $objs
398	}	602	}
399		603
400	sub object_thawer_load {	604	sub object_thawer_load {
401	my ($filename) = @_;	605	my ($filename) = @_;
402		606
403	warn "thaw $filename\n";#d#	607	local $/;
404		608
		609	my $av;
		610
		611	#TODO: use sysread etc.
		612	if (open my $data, "<:raw:perlio", $filename) {
		613	$data = <$data>;
405	open my $fh, "<:raw:perlio", "$filename.pst"	614	if (open my $pst, "<:raw:perlio", "$filename.pst") {
406	or return;	615	$av = eval { (Storable::thaw <$pst>)->{objs} };
407		616	}
408	eval { local $/; (Storable::thaw <$fh>)->{objs} }	617	return ($data, $av);
409	}
410
411	attach_to_objects
412	prio => -1000000,
413	on_clone => sub {
414	my ($src, $dst) = @_;
415
416	@{$dst->registry} = @{$src->registry};
417	warn "registry clone ", join ":", @{$src->registry};#d#
418
419	%$dst = %$src;
420
421	$dst->{_attachment} = [@{ $src->{_attachment} }]
422	if exists $src->{_attachment};
423
424	warn "clone<@_>\n";#d#
425	},	618	}
426	;	619
		620	()
		621	}
427		622
428	#############################################################################	623	#############################################################################
429	# old plug-in events	624	# command handling &c
430		625
431	sub inject_event {	626	=item cf::register_command $name => \&callback($ob,$args);
432	my $extension = shift;
433	my $event_code = shift;
434		627
435	my $cb = $hook[$event_code]{$extension}	628	Register a callback for execution when the client sends the user command
436	or return;	629	$name.
437		630
438	&$cb	631	=cut
439	}
440
441	sub inject_global_event {
442	my $event = shift;
443
444	my $cb = $hook[$event]
445	or return;
446
447	List::Util::max map &$_, values %$cb
448	}
449
450	sub inject_command {
451	my ($name, $obj, $params) = @_;
452
453	for my $cmd (@{ $command{$name} }) {
454	$cmd->[1]->($obj, $params);
455	}
456
457	-1
458	}
459		632
460	sub register_command {	633	sub register_command {
461	my ($name, $time, $cb) = @_;	634	my ($name, $cb) = @_;
462		635
463	my $caller = caller;	636	my $caller = caller;
464	#warn "registering command '$name/$time' to '$caller'";	637	#warn "registering command '$name/$time' to '$caller'";
465		638
466	push @{ $command{$name} }, [$time, $cb, $caller];	639	push @{ $COMMAND{$name} }, [$caller, $cb];
467	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
468	}	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
469		650
470	sub register_extcmd {	651	sub register_extcmd {
471	my ($name, $cb) = @_;	652	my ($name, $cb) = @_;
472		653
473	my $caller = caller;	654	my $caller = caller;
474	#warn "registering extcmd '$name' to '$caller'";	655	#warn "registering extcmd '$name' to '$caller'";
475		656
476	$extcmd{$name} = [$cb, $caller];	657	$EXTCMD{$name} = [$cb, $caller];
477	}	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	);
478		691
479	sub register {	692	sub register {
480	my ($base, $pkg) = @_;	693	my ($base, $pkg) = @_;
481		694
482	#TODO	695	#TODO
…		…
501	. "#line 1 \"$path\"\n{\n"	714	. "#line 1 \"$path\"\n{\n"
502	. (do { local $/; <$fh> })	715	. (do { local $/; <$fh> })
503	. "\n};\n1";	716	. "\n};\n1";
504		717
505	eval $source	718	eval $source
506	or die "$path: $@";	719	or die $@ ? "$path: $@\n"
		720	: "extension disabled.\n";
507		721
508	push @exts, $pkg;	722	push @exts, $pkg;
509	$ext_pkg{$base} = $pkg;	723	$ext_pkg{$base} = $pkg;
510		724
511	# no strict 'refs';	725	# no strict 'refs';
…		…
524	# for my $idx (0 .. $#PLUGIN_EVENT) {	738	# for my $idx (0 .. $#PLUGIN_EVENT) {
525	# delete $hook[$idx]{$pkg};	739	# delete $hook[$idx]{$pkg};
526	# }	740	# }
527		741
528	# remove commands	742	# remove commands
529	for my $name (keys %command) {	743	for my $name (keys %COMMAND) {
530	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	744	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
531		745
532	if (@cb) {	746	if (@cb) {
533	$command{$name} = \@cb;	747	$COMMAND{$name} = \@cb;
534	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
535	} else {	748	} else {
536	delete $command{$name};
537	delete $COMMAND{"$name\000"};	749	delete $COMMAND{$name};
538	}	750	}
539	}	751	}
540		752
541	# remove extcmds	753	# remove extcmds
542	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	754	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
543	delete $extcmd{$name};	755	delete $EXTCMD{$name};
544	}	756	}
545		757
546	if (my $cb = $pkg->can ("unload")) {	758	if (my $cb = $pkg->can ("unload")) {
547	eval {	759	eval {
548	$cb->($pkg);	760	$cb->($pkg);
…		…
552		764
553	Symbol::delete_package $pkg;	765	Symbol::delete_package $pkg;
554	}	766	}
555		767
556	sub load_extensions {	768	sub load_extensions {
557	my $LIBDIR = maps_directory "perl";
558
559	for my $ext (<$LIBDIR/*.ext>) {	769	for my $ext (<$LIBDIR/*.ext>) {
560	next unless -r $ext;	770	next unless -r $ext;
561	eval {	771	eval {
562	load_extension $ext;	772	load_extension $ext;
563	1	773	1
564	} or warn "$ext not loaded: $@";	774	} or warn "$ext not loaded: $@";
565	}	775	}
566	}	776	}
567		777
568	sub _perl_reload(&) {
569	my ($msg) = @_;
570
571	$msg->("reloading...");
572
573	eval {
574	# 1. cancel all watchers
575	$_->cancel for Event::all_watchers;
576
577	# 2. unload all extensions
578	for (@exts) {
579	$msg->("unloading <$_>");
580	unload_extension $_;
581	}
582
583	# 3. unload all modules loaded from $LIBDIR
584	while (my ($k, $v) = each %INC) {
585	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
586
587	$msg->("removing <$k>");
588	delete $INC{$k};
589
590	$k =~ s/\.pm$//;
591	$k =~ s/\//::/g;
592
593	if (my $cb = $k->can ("unload_module")) {
594	$cb->();
595	}
596
597	Symbol::delete_package $k;
598	}
599
600	# 4. get rid of safe::, as good as possible
601	Symbol::delete_package "safe::$_"
602	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
603
604	# 5. remove register_script_function callbacks
605	# TODO
606
607	# 6. unload cf.pm "a bit"
608	delete $INC{"cf.pm"};
609
610	# don't, removes xs symbols, too,
611	# and global variables created in xs
612	#Symbol::delete_package __PACKAGE__;
613
614	# 7. reload cf.pm
615	$msg->("reloading cf.pm");
616	require cf;
617	};
618	$msg->($@) if $@;
619
620	$msg->("reloaded");
621	};
622
623	sub perl_reload() {
624	_perl_reload {
625	warn $_[0];
626	print "$_[0]\n";
627	};
628	}
629
630	register_command "perl-reload", 0, sub {
631	my ($who, $arg) = @_;
632
633	if ($who->flag (FLAG_WIZ)) {
634	_perl_reload {
635	warn $_[0];
636	$who->message ($_[0]);
637	};
638	}
639	};
640
641	#############################################################################
642	# extcmd framework, basically convert ext <msg>
643	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
644
645	attach_to_players
646	on_extcmd => sub {
647	my ($pl, $buf) = @_;
648
649	my $msg = eval { from_json $buf };
650
651	if (ref $msg) {
652	if (my $cb = $extcmd{$msg->{msgtype}}) {
653	if (my %reply = $cb->[0]->($pl, $msg)) {
654	$pl->ext_reply ($msg->{msgid}, %reply);
655	}
656	}
657	} else {
658	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
659	}
660
661	cf::override;
662	},
663	;
664
665	#############################################################################	778	#############################################################################
666	# load/save/clean perl data associated with a map	779	# load/save/clean perl data associated with a map
667		780
668	*cf::mapsupport::on_clean = sub {	781	*cf::mapsupport::on_clean = sub {
669	my ($map) = @_;	782	my ($map) = @_;
670		783
671	my $path = $map->tmpname;	784	my $path = $map->tmpname;
672	defined $path or return;	785	defined $path or return;
673		786
674	unlink "$path.cfperl";
675	unlink "$path.pst";	787	unlink "$path.pst";
676	};	788	};
677		789
678	*cf::mapsupport::on_swapin =
679	*cf::mapsupport::on_load = sub {
680	my ($map) = @_;
681
682	my $path = $map->tmpname;
683	$path = $map->path unless defined $path;
684
685	open my $fh, "<:raw", "$path.cfperl"
686	or return; # no perl data
687
688	my $data = Storable::thaw do { local $/; <$fh> };
689
690	$data->{version} <= 1
691	or return; # too new
692
693	$map->_set_obs ($data->{obs});
694	};
695
696	attach_to_maps prio => -10000, package => cf::mapsupport::;	790	cf::map->attach (prio => -10000, package => cf::mapsupport::);
697		791
698	#############################################################################	792	#############################################################################
699	# load/save perl data associated with player->ob objects	793	# load/save perl data associated with player->ob objects
700		794
701	sub all_objects(@) {	795	sub all_objects(@) {
702	@_, map all_objects ($_->inv), @_	796	@_, map all_objects ($_->inv), @_
703	}	797	}
704		798
705	attach_to_players	799	# TODO: compatibility cruft, remove when no longer needed
		800	cf::player->attach (
706	on_load => sub {	801	on_load => sub {
707	my ($pl, $path) = @_;	802	my ($pl, $path) = @_;
708		803
709	for my $o (all_objects $pl->ob) {	804	for my $o (all_objects $pl->ob) {
710	if (my $value = $o->get_ob_key_value ("_perl_data")) {	805	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
712		807
713	%$o = %{ Storable::thaw pack "H*", $value };	808	%$o = %{ Storable::thaw pack "H*", $value };
714	}	809	}
715	}	810	}
716	},	811	},
717	;	812	);
718		813
719	#############################################################################	814	#############################################################################
720	# 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
721		823
722	=item cf::player::exists $login	824	=item cf::player::exists $login
723		825
724	Returns true when the given account exists.	826	Returns true when the given account exists.
725		827
…		…
728	sub cf::player::exists($) {	830	sub cf::player::exists($) {
729	cf::player::find $_[0]	831	cf::player::find $_[0]
730	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;
731	}	833	}
732		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
733	=item $player->reply ($npc, $msg[, $flags])	855	=item $player_object->reply ($npc, $msg[, $flags])
734		856
735	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>
736	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
737	dialogue with the given NPC character.	859	dialogue with the given NPC character.
738		860
739	=cut	861	=cut
740		862
741	# rough implementation of a future "reply" method that works	863	# rough implementation of a future "reply" method that works
742	# with dialog boxes.	864	# with dialog boxes.
		865	#TODO: the first argument must go, split into a $npc->reply_to ( method
743	sub cf::object::player::reply($$$;$) {	866	sub cf::object::player::reply($$$;$) {
744	my ($self, $npc, $msg, $flags) = @_;	867	my ($self, $npc, $msg, $flags) = @_;
745		868
746	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	869	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
747		870
…		…
751	$msg = $npc->name . " says: $msg" if $npc;	874	$msg = $npc->name . " says: $msg" if $npc;
752	$self->message ($msg, $flags);	875	$self->message ($msg, $flags);
753	}	876	}
754	}	877	}
755		878
756	=item $player->ext_reply ($msgid, $msgtype, %msg)	879	=item $player_object->may ("access")
757		880
758	Sends an ext reply to the player.	881	Returns wether the given player is authorized to access resource "access"
		882	(e.g. "command_wizcast").
759		883
760	=cut	884	=cut
761		885
762	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 {
763	my ($self, $id, %msg) = @_;	972	my ($self, $cb) = @_;
764		973
765	$msg{msgid} = $id;	974	my $coro; $coro = async {
		975	eval {
		976	$cb->();
		977	};
		978	warn $@ if $@;
		979	};
766		980
767	$self->send ("ext " . to_json \%msg);	981	$coro->on_destroy (sub {
768	}	982	delete $self->{_coro}{$coro+0};
		983	});
769		984
770	#############################################################################	985	$self->{_coro}{$coro+0} = $coro;
771	# 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
772		1010
773	our $safe = new Safe "safe";	1011	our $safe = new Safe "safe";
774	our $safe_hole = new Safe::Hole;	1012	our $safe_hole = new Safe::Hole;
775		1013
776	$SIG{FPE} = 'IGNORE';	1014	$SIG{FPE} = 'IGNORE';
777		1015
778	$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));
779		1017
780	# here we export the classes and methods available to script code	1018	# here we export the classes and methods available to script code
781		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
782	for (	1031	for (
783	["cf::object" => qw(contr pay_amount pay_player)],	1032	["cf::object" => qw(contr pay_amount pay_player map)],
784	["cf::object::player" => qw(player)],	1033	["cf::object::player" => qw(player)],
785	["cf::player" => qw(peaceful)],	1034	["cf::player" => qw(peaceful)],
		1035	["cf::map" => qw(trigger)],
786	) {	1036	) {
787	no strict 'refs';	1037	no strict 'refs';
788	my ($pkg, @funs) = @$_;	1038	my ($pkg, @funs) = @$_;
789	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1039	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
790	for @funs;	1040	for @funs;
791	}	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
792		1054
793	sub safe_eval($;@) {	1055	sub safe_eval($;@) {
794	my ($code, %vars) = @_;	1056	my ($code, %vars) = @_;
795		1057
796	my $qcode = $code;	1058	my $qcode = $code;
…		…
819	}	1081	}
820		1082
821	wantarray ? @res : $res[0]	1083	wantarray ? @res : $res[0]
822	}	1084	}
823		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
824	sub register_script_function {	1101	sub register_script_function {
825	my ($fun, $cb) = @_;	1102	my ($fun, $cb) = @_;
826		1103
827	no strict 'refs';	1104	no strict 'refs';
828	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1105	*{"safe::$fun"} = $safe_hole->wrap ($cb);
829	}	1106	}
830		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
831	#############################################################################	1217	#############################################################################
832	# the server's main()	1218	# the server's main()
833		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
834	sub main {	1228	sub main {
		1229	cfg_load;
		1230	db_load;
		1231	load_extensions;
835	Event::loop;	1232	Event::loop;
836	}	1233	}
837		1234
838	#############################################################################	1235	#############################################################################
839	# initialisation	1236	# initialisation
840		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
841	register "<global>", __PACKAGE__;	1322	register "<global>", __PACKAGE__;
842		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
843	unshift @INC, $LIBDIR;	1333	unshift @INC, $LIBDIR;
844		1334
845	load_extensions;
846
847	$TICK_WATCHER = Event->timer (	1335	$TICK_WATCHER = Event->timer (
848	prio => 1,	1336	prio => 0,
849	at => $NEXT_TICK || 1,	1337	at => $NEXT_TICK || $TICK,
		1338	data => WF_AUTOCANCEL,
850	cb => sub {	1339	cb => sub {
		1340	unless ($FREEZE) {
851	cf::server_tick; # one server iteration	1341	cf::server_tick; # one server iteration
		1342	$RUNTIME += $TICK;
		1343	}
852		1344
853	my $NOW = Event::time;
854	$NEXT_TICK += $TICK;	1345	$NEXT_TICK += $TICK;
855		1346
856	# if we are delayed by four ticks, skip them all	1347	# if we are delayed by four ticks or more, skip them all
857	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1348	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
858		1349
859	$TICK_WATCHER->at ($NEXT_TICK);	1350	$TICK_WATCHER->at ($NEXT_TICK);
860	$TICK_WATCHER->start;	1351	$TICK_WATCHER->start;
861	},	1352	},
862	);	1353	);
863		1354
		1355	IO::AIO::max_poll_time $TICK * 0.2;
		1356
		1357	Event->io (fd => IO::AIO::poll_fileno,
		1358	poll => 'r',
		1359	prio => 5,
		1360	data => WF_AUTOCANCEL,
		1361	cb => \&IO::AIO::poll_cb);
		1362
		1363	# we must not ever block the main coroutine
		1364	$Coro::idle = sub {
		1365	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1366	warn "FATAL: Coro::idle was called, major BUG\n";
		1367	(Coro::unblock_sub {
		1368	Event::one_event;
		1369	})->();
		1370	};
		1371
864	1	1372	1
865		1373

Diff Legend

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