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

Diff Legend

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