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

Diff Legend

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