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.48 by root, Sun Aug 27 15:24:22 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)) {	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
		240	=head2 ATTACHABLE OBJECTS
		241
		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.
		245
		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+).
		249
		250	=over 4
		251
110	=item $object->attach ($attachment, key => $value...)	252	=item $attachable->attach ($attachment, key => $value...)
111		253
112	Attach a pre-registered attachment to an object.	254	=item $attachable->detach ($attachment)
113		255
114	=item $player->attach ($attachment, key => $value...)	256	Attach/detach a pre-registered attachment to a specific object and give it
		257	the specified key/value pairs as arguments.
115		258
116	Attach a pre-registered attachment to a player.	259	Example, attach a minesweeper attachment to the given object, making it a
		260	10x10 minesweeper game:
117		261
118	=item $map->attach ($attachment, key => $value...) # not yet persistent	262	$obj->attach (minesweeper => width => 10, height => 10);
119		263
120	Attach a pre-registered attachment to a map.	264	=item $bool = $attachable->attached ($name)
121		265
122	=item cf::attach_global ...	266	Checks wether the named attachment is currently attached to the object.
123		267
124	Attach handlers for global events.	268	=item cf::CLASS->attach ...
125		269
126	This and all following C<attach_*>-functions expect any number of the	270	=item cf::CLASS->detach ...
127	following handler/hook descriptions:	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:
128		306
129	=over 4	307	=over 4
130		308
131	=item prio => $number	309	=item prio => $number
132		310
…		…
134	by another C<prio> setting). Lower priority handlers get executed	312	by another C<prio> setting). Lower priority handlers get executed
135	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
136	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
137	unless you know what you are doing.	315	unless you know what you are doing.
138		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
139	=item on_I<event> => \&cb	323	=item on_I<event> => \&cb
140		324
141	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
142	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
143	handlers are recognised generally depends on the type of object these	327	handlers are recognised generally depends on the type of object these
…		…
152	package and register them. Only handlers for eevents supported by the	336	package and register them. Only handlers for eevents supported by the
153	object/class are recognised.	337	object/class are recognised.
154		338
155	=back	339	=back
156		340
157	=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:
158		343
159	Attach handlers for a specific object type (e.g. TRANSPORT) and	344	cf::object::attachment sockpuppet =>
160	subtype. If C<$subtype> is zero or undef, matches all objects of the given	345	on_skill_attack => sub {
161	type.	346	my ($self, $victim) = @_;
		347	...
		348	}
		349	}
162		350
163	=item cf::attach_to_objects ...	351	=item $attachable->valid
164		352
165	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
166	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
167	the game.	355	valid C counterpart anymore you get an exception at runtime. This method
168		356	can be used to test for existence of the C object part without causing an
169	=item cf::attach_to_players ...	357	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		358
179	=cut	359	=cut
180		360
181	# 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
182	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
183	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)
184	our @CB_PLAYER = ();	365	our @CB_PLAYER = ();
		366	our @CB_CLIENT = ();
185	our @CB_TYPE = (); # registry for type (cf-object class) based events	367	our @CB_TYPE = (); # registry for type (cf-object class) based events
186	our @CB_MAP = ();	368	our @CB_MAP = ();
187		369
188	my %attachment;	370	my %attachment;
189		371
190	sub _attach_cb($\%$$$) {	372	sub _attach_cb($$$$) {
191	my ($registry, $undo, $event, $prio, $cb) = @_;	373	my ($registry, $event, $prio, $cb) = @_;
192		374
193	use sort 'stable';	375	use sort 'stable';
194		376
195	$cb = [$prio, $cb];	377	$cb = [$prio, $cb];
196		378
197	@{$registry->[$event]} = sort	379	@{$registry->[$event]} = sort
198	{ $a->[0] cmp $b->[0] }	380	{ $a->[0] cmp $b->[0] }
199	@{$registry->[$event] || []}, $cb;	381	@{$registry->[$event] || []}, $cb;
200
201	push @{$undo->{cb}}, [$event, $cb];
202	}	382	}
		383
		384	# hack
		385	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
203		386
204	# attach handles attaching event callbacks	387	# attach handles attaching event callbacks
205	# 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
206	# registry (== where the callback attaches to).	389	# registry (== where the callback attaches to).
207	sub _attach(\@$@) {	390	sub _attach {
208	my ($registry, $klass, @arg) = @_;	391	my ($registry, $klass, @arg) = @_;
209		392
		393	my $object_type;
210	my $prio = 0;	394	my $prio = 0;
211
212	my %undo = (
213	registry => $registry,
214	cb => [],
215	);
216
217	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	}
218		401
219	while (@arg) {	402	while (@arg) {
220	my $type = shift @arg;	403	my $type = shift @arg;
221		404
222	if ($type eq "prio") {	405	if ($type eq "prio") {
223	$prio = shift @arg;	406	$prio = shift @arg;
224		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
225	} elsif ($type eq "package") {	417	} elsif ($type eq "package") {
226	my $pkg = shift @arg;	418	my $pkg = shift @arg;
227		419
228	while (my ($name, $id) = each %cb_id) {	420	while (my ($name, $id) = each %cb_id) {
229	if (my $cb = $pkg->can ($name)) {	421	if (my $cb = $pkg->can ($name)) {
230	_attach_cb $registry, %undo, $id, $prio, $cb;	422	_attach_cb $registry, $id, $prio, $cb;
231	}	423	}
232	}	424	}
233		425
234	} elsif (exists $cb_id{$type}) {	426	} elsif (exists $cb_id{$type}) {
235	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	427	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
236		428
237	} elsif (ref $type) {	429	} elsif (ref $type) {
238	warn "attaching objects not supported, ignoring.\n";	430	warn "attaching objects not supported, ignoring.\n";
239		431
240	} else {	432	} else {
241	shift @arg;	433	shift @arg;
242	warn "attach argument '$type' not supported, ignoring.\n";	434	warn "attach argument '$type' not supported, ignoring.\n";
243	}	435	}
244	}	436	}
245
246	\%undo
247	}	437	}
248		438
249	sub _attach_attachment {	439	sub _object_attach {
250	my ($obj, $name, %arg) = @_;	440	my ($obj, $name, %arg) = @_;
251		441
252	my $res;	442	return if exists $obj->{_attachment}{$name};
253		443
254	if (my $attach = $attachment{$name}) {	444	if (my $attach = $attachment{$name}) {
255	my $registry = $obj->registry;	445	my $registry = $obj->registry;
256		446
257	for (@$attach) {	447	for (@$attach) {
258	my ($klass, @attach) = @$_;	448	my ($klass, @attach) = @$_;
259	$res = _attach @$registry, $klass, @attach;	449	_attach $registry, $klass, @attach;
260	}	450	}
261		451
262	$obj->{$name} = \%arg;	452	$obj->{$name} = \%arg;
263	} else {	453	} else {
264	warn "object uses attachment '$name' that is not available, postponing.\n";	454	warn "object uses attachment '$name' that is not available, postponing.\n";
265	}	455	}
266		456
267	push @{$obj->{_attachment}}, $name;	457	$obj->{_attachment}{$name} = undef;
268
269	$res->{attachment} = $name;
270	$res
271	}	458	}
272		459
273	sub cf::object::attach {	460	sub cf::attachable::attach {
		461	if (ref $_[0]) {
		462	_object_attach @_;
		463	} else {
		464	_attach shift->_attach_registry, @_;
		465	}
		466	};
		467
		468	# all those should be optimised
		469	sub cf::attachable::detach {
274	my ($obj, $name, %arg) = @_;	470	my ($obj, $name) = @_;
275		471
276	_attach_attachment $obj, $name, %arg;	472	if (ref $obj) {
277	}	473	delete $obj->{_attachment}{$name};
		474	reattach ($obj);
		475	} else {
		476	Carp::croak "cannot, currently, detach class attachments";
		477	}
		478	};
278		479
279	sub cf::player::attach {	480	sub cf::attachable::attached {
280	my ($obj, $name, %arg) = @_;	481	my ($obj, $name) = @_;
281		482
282	_attach_attachment KLASS_PLAYER, $obj, $name, %arg;	483	exists $obj->{_attachment}{$name}
283	}	484	}
284		485
285	sub cf::map::attach {	486	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
286	my ($obj, $name, %arg) = @_;	487	eval "#line " . __LINE__ . " 'cf.pm'
		488	sub cf::\L$klass\E::_attach_registry {
		489	(\\\@CB_$klass, KLASS_$klass)
		490	}
287		491
288	_attach_attachment KLASS_MAP, $obj, $name, %arg;	492	sub cf::\L$klass\E::attachment {
289	}
290
291	sub attach_global {
292	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
293	}
294
295	sub attach_to_type {
296	my $type = shift;
297	my $subtype = shift;
298
299	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
300	}
301
302	sub attach_to_objects {
303	_attach @CB_OBJECT, KLASS_OBJECT, @_
304	}
305
306	sub attach_to_players {
307	_attach @CB_PLAYER, KLASS_PLAYER, @_
308	}
309
310	sub attach_to_maps {
311	_attach @CB_MAP, KLASS_MAP, @_
312	}
313
314	sub register_attachment {
315	my $name = shift;	493	my \$name = shift;
316		494
317	$attachment{$name} = [[KLASS_OBJECT, @_]];	495	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		496	}
		497	";
		498	die if $@;
318	}	499	}
319		500
320	our $override;	501	our $override;
321	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?
322		503
…		…
336	for (@$callbacks) {	517	for (@$callbacks) {
337	eval { &{$_->[1]} };	518	eval { &{$_->[1]} };
338		519
339	if ($@) {	520	if ($@) {
340	warn "$@";	521	warn "$@";
341	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	522	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342	override;	523	override;
343	}	524	}
344		525
345	return 1 if $override;	526	return 1 if $override;
346	}	527	}
347		528
348	0	529	0
349	}	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
350		545
351	#############################################################################	546	#############################################################################
352	# object support	547	# object support
353		548
354	sub instantiate {
355	my ($obj, $data) = @_;
356
357	$data = from_json $data;
358
359	for (@$data) {
360	my ($name, $args) = @$_;
361	attach $obj, $name, %{$args || {} };
362	}
363	}
364
365	# basically do the same as instantiate, without calling instantiate
366	sub reattach {	549	sub reattach {
		550	# basically do the same as instantiate, without calling instantiate
367	my ($obj) = @_;	551	my ($obj) = @_;
		552
368	my $registry = $obj->registry;	553	my $registry = $obj->registry;
369		554
370	@$registry = ();	555	@$registry = ();
371		556
		557	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		558
372	for my $name (@{ $obj->{_attachment} }) {	559	for my $name (keys %{ $obj->{_attachment} || {} }) {
373	if (my $attach = $attachment{$name}) {	560	if (my $attach = $attachment{$name}) {
374	for (@$attach) {	561	for (@$attach) {
375	my ($klass, @attach) = @$_;	562	my ($klass, @attach) = @$_;
376	_attach @$registry, $klass, @attach;	563	_attach $registry, $klass, @attach;
377	}	564	}
378	} else {	565	} else {
379	warn "object uses attachment '$name' that is not available, postponing.\n";	566	warn "object uses attachment '$name' that is not available, postponing.\n";
380	}	567	}
381	}	568	}
382	}	569	}
383		570
		571	cf::attachable->attach (
		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,
		585	on_clone => sub {
		586	my ($src, $dst) = @_;
		587
		588	@{$dst->registry} = @{$src->registry};
		589
		590	%$dst = %$src;
		591
		592	%{$dst->{_attachment}} = %{$src->{_attachment}}
		593	if exists $src->{_attachment};
		594	},
		595	);
		596
384	sub object_freezer_save {	597	sub object_freezer_save {
385	my ($filename, $objs) = @_;	598	my ($filename, $rdata, $objs) = @_;
386		599
387	$filename .= ".pst";	600	sync_job {
		601	if (length $$rdata) {
		602	warn sprintf "saving %s (%d,%d)\n",
		603	$filename, length $$rdata, scalar @$objs;
388		604
389	if (@$objs) {	605	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
390	open my $fh, ">:raw", "$filename~";	606	chmod SAVE_MODE, $fh;
391	chmod $fh, SAVE_MODE;	607	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
392	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	608	aio_fsync $fh;
393	close $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
394	rename "$filename~", $filename;	624	aio_rename "$filename~", $filename;
		625	} else {
		626	warn "FATAL: $filename~: $!\n";
		627	}
395	} else {	628	} else {
396	unlink $filename;	629	aio_unlink $filename;
		630	aio_unlink "$filename.pst";
		631	}
397	}	632	}
		633	}
		634
		635	sub object_freezer_as_string {
		636	my ($rdata, $objs) = @_;
		637
		638	use Data::Dumper;
		639
		640	$$rdata . Dumper $objs
398	}	641	}
399		642
400	sub object_thawer_load {	643	sub object_thawer_load {
401	my ($filename) = @_;	644	my ($filename) = @_;
402		645
403	open my $fh, "<:raw:perlio", "$filename.pst"	646	my ($data, $av);
		647
		648	(aio_load $filename, $data) >= 0
404	or return;	649	or return;
405		650
		651	unless (aio_stat "$filename.pst") {
		652	(aio_load "$filename.pst", $av) >= 0
		653	or return;
406	eval { local $/; (Storable::thaw <$fh>)->{objs} }	654	$av = eval { (Storable::thaw <$av>)->{objs} };
407	}
408
409	attach_to_objects
410	prio => -1000000,
411	on_clone => sub {
412	my ($src, $dst) = @_;
413
414	@{$dst->registry} = @{$src->registry};
415
416	%$dst = %$src;
417
418	$dst->{_attachment} = [@{ $src->{_attachment} }]
419	if exists $src->{_attachment};
420	},	655	}
421	;	656
		657	return ($data, $av);
		658	}
422		659
423	#############################################################################	660	#############################################################################
424	# old plug-in events	661	# command handling &c
425		662
426	sub inject_event {	663	=item cf::register_command $name => \&callback($ob,$args);
427	my $extension = shift;
428	my $event_code = shift;
429		664
430	my $cb = $hook[$event_code]{$extension}	665	Register a callback for execution when the client sends the user command
431	or return;	666	$name.
432		667
433	&$cb	668	=cut
434	}
435
436	sub inject_global_event {
437	my $event = shift;
438
439	my $cb = $hook[$event]
440	or return;
441
442	List::Util::max map &$_, values %$cb
443	}
444
445	sub inject_command {
446	my ($name, $obj, $params) = @_;
447
448	for my $cmd (@{ $command{$name} }) {
449	$cmd->[1]->($obj, $params);
450	}
451
452	-1
453	}
454		669
455	sub register_command {	670	sub register_command {
456	my ($name, $time, $cb) = @_;	671	my ($name, $cb) = @_;
457		672
458	my $caller = caller;	673	my $caller = caller;
459	#warn "registering command '$name/$time' to '$caller'";	674	#warn "registering command '$name/$time' to '$caller'";
460		675
461	push @{ $command{$name} }, [$time, $cb, $caller];	676	push @{ $COMMAND{$name} }, [$caller, $cb];
462	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
463	}	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
464		687
465	sub register_extcmd {	688	sub register_extcmd {
466	my ($name, $cb) = @_;	689	my ($name, $cb) = @_;
467		690
468	my $caller = caller;	691	my $caller = caller;
469	#warn "registering extcmd '$name' to '$caller'";	692	#warn "registering extcmd '$name' to '$caller'";
470		693
471	$extcmd{$name} = [$cb, $caller];	694	$EXTCMD{$name} = [$cb, $caller];
472	}	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	);
473		728
474	sub register {	729	sub register {
475	my ($base, $pkg) = @_;	730	my ($base, $pkg) = @_;
476		731
477	#TODO	732	#TODO
…		…
496	. "#line 1 \"$path\"\n{\n"	751	. "#line 1 \"$path\"\n{\n"
497	. (do { local $/; <$fh> })	752	. (do { local $/; <$fh> })
498	. "\n};\n1";	753	. "\n};\n1";
499		754
500	eval $source	755	eval $source
501	or die "$path: $@";	756	or die $@ ? "$path: $@\n"
		757	: "extension disabled.\n";
502		758
503	push @exts, $pkg;	759	push @exts, $pkg;
504	$ext_pkg{$base} = $pkg;	760	$ext_pkg{$base} = $pkg;
505		761
506	# no strict 'refs';	762	# no strict 'refs';
…		…
519	# for my $idx (0 .. $#PLUGIN_EVENT) {	775	# for my $idx (0 .. $#PLUGIN_EVENT) {
520	# delete $hook[$idx]{$pkg};	776	# delete $hook[$idx]{$pkg};
521	# }	777	# }
522		778
523	# remove commands	779	# remove commands
524	for my $name (keys %command) {	780	for my $name (keys %COMMAND) {
525	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	781	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
526		782
527	if (@cb) {	783	if (@cb) {
528	$command{$name} = \@cb;	784	$COMMAND{$name} = \@cb;
529	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
530	} else {	785	} else {
531	delete $command{$name};
532	delete $COMMAND{"$name\000"};	786	delete $COMMAND{$name};
533	}	787	}
534	}	788	}
535		789
536	# remove extcmds	790	# remove extcmds
537	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	791	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
538	delete $extcmd{$name};	792	delete $EXTCMD{$name};
539	}	793	}
540		794
541	if (my $cb = $pkg->can ("unload")) {	795	if (my $cb = $pkg->can ("unload")) {
542	eval {	796	eval {
543	$cb->($pkg);	797	$cb->($pkg);
…		…
547		801
548	Symbol::delete_package $pkg;	802	Symbol::delete_package $pkg;
549	}	803	}
550		804
551	sub load_extensions {	805	sub load_extensions {
552	my $LIBDIR = maps_directory "perl";
553
554	for my $ext (<$LIBDIR/*.ext>) {	806	for my $ext (<$LIBDIR/*.ext>) {
555	next unless -r $ext;	807	next unless -r $ext;
556	eval {	808	eval {
557	load_extension $ext;	809	load_extension $ext;
558	1	810	1
559	} or warn "$ext not loaded: $@";	811	} or warn "$ext not loaded: $@";
560	}	812	}
561	}	813	}
562		814
563	sub _perl_reload(&) {
564	my ($msg) = @_;
565
566	$msg->("reloading...");
567
568	eval {
569	# 1. cancel all watchers
570	$_->cancel for Event::all_watchers;
571
572	# 2. unload all extensions
573	for (@exts) {
574	$msg->("unloading <$_>");
575	unload_extension $_;
576	}
577
578	# 3. unload all modules loaded from $LIBDIR
579	while (my ($k, $v) = each %INC) {
580	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
581
582	$msg->("removing <$k>");
583	delete $INC{$k};
584
585	$k =~ s/\.pm$//;
586	$k =~ s/\//::/g;
587
588	if (my $cb = $k->can ("unload_module")) {
589	$cb->();
590	}
591
592	Symbol::delete_package $k;
593	}
594
595	# 4. get rid of safe::, as good as possible
596	Symbol::delete_package "safe::$_"
597	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
598
599	# 5. remove register_script_function callbacks
600	# TODO
601
602	# 6. unload cf.pm "a bit"
603	delete $INC{"cf.pm"};
604
605	# don't, removes xs symbols, too,
606	# and global variables created in xs
607	#Symbol::delete_package __PACKAGE__;
608
609	# 7. reload cf.pm
610	$msg->("reloading cf.pm");
611	require cf;
612	};
613	$msg->($@) if $@;
614
615	$msg->("reloaded");
616	};
617
618	sub perl_reload() {
619	_perl_reload {
620	warn $_[0];
621	print "$_[0]\n";
622	};
623	}
624
625	register_command "perl-reload", 0, sub {
626	my ($who, $arg) = @_;
627
628	if ($who->flag (FLAG_WIZ)) {
629	_perl_reload {
630	warn $_[0];
631	$who->message ($_[0]);
632	};
633	}
634	};
635
636	#############################################################################
637	# extcmd framework, basically convert ext <msg>
638	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
639
640	attach_to_players
641	on_extcmd => sub {
642	my ($pl, $buf) = @_;
643
644	my $msg = eval { from_json $buf };
645
646	if (ref $msg) {
647	if (my $cb = $extcmd{$msg->{msgtype}}) {
648	if (my %reply = $cb->[0]->($pl, $msg)) {
649	$pl->ext_reply ($msg->{msgid}, %reply);
650	}
651	}
652	} else {
653	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
654	}
655
656	cf::override;
657	},
658	;
659
660	#############################################################################	815	#############################################################################
661	# load/save/clean perl data associated with a map	816	# load/save/clean perl data associated with a map
662		817
663	*cf::mapsupport::on_clean = sub {	818	*cf::mapsupport::on_clean = sub {
664	my ($map) = @_;	819	my ($map) = @_;
665		820
666	my $path = $map->tmpname;	821	my $path = $map->tmpname;
667	defined $path or return;	822	defined $path or return;
668		823
669	unlink "$path.cfperl";
670	unlink "$path.pst";	824	unlink "$path.pst";
671	};	825	};
672		826
673	*cf::mapsupport::on_swapin =
674	*cf::mapsupport::on_load = sub {
675	my ($map) = @_;
676
677	my $path = $map->tmpname;
678	$path = $map->path unless defined $path;
679
680	open my $fh, "<:raw", "$path.cfperl"
681	or return; # no perl data
682
683	my $data = Storable::thaw do { local $/; <$fh> };
684
685	$data->{version} <= 1
686	or return; # too new
687
688	$map->_set_obs ($data->{obs});
689	};
690
691	attach_to_maps prio => -10000, package => cf::mapsupport::;	827	cf::map->attach (prio => -10000, package => cf::mapsupport::);
692		828
693	#############################################################################	829	#############################################################################
694	# load/save perl data associated with player->ob objects	830	# load/save perl data associated with player->ob objects
695		831
696	sub all_objects(@) {	832	sub all_objects(@) {
697	@_, map all_objects ($_->inv), @_	833	@_, map all_objects ($_->inv), @_
698	}	834	}
699		835
700	attach_to_players	836	# TODO: compatibility cruft, remove when no longer needed
		837	cf::player->attach (
701	on_load => sub {	838	on_load => sub {
702	my ($pl, $path) = @_;	839	my ($pl, $path) = @_;
703		840
704	for my $o (all_objects $pl->ob) {	841	for my $o (all_objects $pl->ob) {
705	if (my $value = $o->get_ob_key_value ("_perl_data")) {	842	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
707		844
708	%$o = %{ Storable::thaw pack "H*", $value };	845	%$o = %{ Storable::thaw pack "H*", $value };
709	}	846	}
710	}	847	}
711	},	848	},
712	;	849	);
713		850
714	#############################################################################	851	#############################################################################
715	# 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
716		860
717	=item cf::player::exists $login	861	=item cf::player::exists $login
718		862
719	Returns true when the given account exists.	863	Returns true when the given account exists.
720		864
…		…
723	sub cf::player::exists($) {	867	sub cf::player::exists($) {
724	cf::player::find $_[0]	868	cf::player::find $_[0]
725	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;
726	}	870	}
727		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
728	=item $player->reply ($npc, $msg[, $flags])	892	=item $player_object->reply ($npc, $msg[, $flags])
729		893
730	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>
731	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
732	dialogue with the given NPC character.	896	dialogue with the given NPC character.
733		897
734	=cut	898	=cut
735		899
736	# rough implementation of a future "reply" method that works	900	# rough implementation of a future "reply" method that works
737	# with dialog boxes.	901	# with dialog boxes.
		902	#TODO: the first argument must go, split into a $npc->reply_to ( method
738	sub cf::object::player::reply($$$;$) {	903	sub cf::object::player::reply($$$;$) {
739	my ($self, $npc, $msg, $flags) = @_;	904	my ($self, $npc, $msg, $flags) = @_;
740		905
741	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	906	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
742		907
…		…
746	$msg = $npc->name . " says: $msg" if $npc;	911	$msg = $npc->name . " says: $msg" if $npc;
747	$self->message ($msg, $flags);	912	$self->message ($msg, $flags);
748	}	913	}
749	}	914	}
750		915
751	=item $player->ext_reply ($msgid, $msgtype, %msg)	916	=item $player_object->may ("access")
752		917
753	Sends an ext reply to the player.	918	Returns wether the given player is authorized to access resource "access"
		919	(e.g. "command_wizcast").
754		920
755	=cut	921	=cut
756		922
757	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 {
758	my ($self, $id, %msg) = @_;	1009	my ($self, $cb) = @_;
759		1010
760	$msg{msgid} = $id;	1011	my $coro; $coro = async {
		1012	eval {
		1013	$cb->();
		1014	};
		1015	warn $@ if $@;
		1016	};
761		1017
762	$self->send ("ext " . to_json \%msg);	1018	$coro->on_destroy (sub {
763	}	1019	delete $self->{_coro}{$coro+0};
		1020	});
764		1021
765	#############################################################################	1022	$self->{_coro}{$coro+0} = $coro;
766	# 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
767		1047
768	our $safe = new Safe "safe";	1048	our $safe = new Safe "safe";
769	our $safe_hole = new Safe::Hole;	1049	our $safe_hole = new Safe::Hole;
770		1050
771	$SIG{FPE} = 'IGNORE';	1051	$SIG{FPE} = 'IGNORE';
772		1052
773	$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));
774		1054
775	# here we export the classes and methods available to script code	1055	# here we export the classes and methods available to script code
776		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
777	for (	1068	for (
778	["cf::object" => qw(contr pay_amount pay_player)],	1069	["cf::object" => qw(contr pay_amount pay_player map)],
779	["cf::object::player" => qw(player)],	1070	["cf::object::player" => qw(player)],
780	["cf::player" => qw(peaceful)],	1071	["cf::player" => qw(peaceful)],
		1072	["cf::map" => qw(trigger)],
781	) {	1073	) {
782	no strict 'refs';	1074	no strict 'refs';
783	my ($pkg, @funs) = @$_;	1075	my ($pkg, @funs) = @$_;
784	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1076	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
785	for @funs;	1077	for @funs;
786	}	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
787		1091
788	sub safe_eval($;@) {	1092	sub safe_eval($;@) {
789	my ($code, %vars) = @_;	1093	my ($code, %vars) = @_;
790		1094
791	my $qcode = $code;	1095	my $qcode = $code;
…		…
814	}	1118	}
815		1119
816	wantarray ? @res : $res[0]	1120	wantarray ? @res : $res[0]
817	}	1121	}
818		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
819	sub register_script_function {	1138	sub register_script_function {
820	my ($fun, $cb) = @_;	1139	my ($fun, $cb) = @_;
821		1140
822	no strict 'refs';	1141	no strict 'refs';
823	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1142	*{"safe::$fun"} = $safe_hole->wrap ($cb);
824	}	1143	}
825		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
826	#############################################################################	1254	#############################################################################
827	# the server's main()	1255	# the server's main()
828		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
829	sub main {	1265	sub main {
		1266	cfg_load;
		1267	db_load;
		1268	load_extensions;
830	Event::loop;	1269	Event::loop;
831	}	1270	}
832		1271
833	#############################################################################	1272	#############################################################################
834	# initialisation	1273	# initialisation
835		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
836	register "<global>", __PACKAGE__;	1359	register "<global>", __PACKAGE__;
837		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
838	unshift @INC, $LIBDIR;	1370	unshift @INC, $LIBDIR;
839		1371
840	load_extensions;
841
842	$TICK_WATCHER = Event->timer (	1372	$TICK_WATCHER = Event->timer (
		1373	reentrant => 0,
843	prio => 1,	1374	prio => 0,
844	at => $NEXT_TICK || 1,	1375	at => $NEXT_TICK || $TICK,
		1376	data => WF_AUTOCANCEL,
845	cb => sub {	1377	cb => sub {
		1378	unless ($FREEZE) {
846	cf::server_tick; # one server iteration	1379	cf::server_tick; # one server iteration
		1380	$RUNTIME += $TICK;
		1381	}
847		1382
848	my $NOW = Event::time;
849	$NEXT_TICK += $TICK;	1383	$NEXT_TICK += $TICK;
850		1384
851	# if we are delayed by four ticks, skip them all	1385	# if we are delayed by four ticks or more, skip them all
852	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1386	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
853		1387
854	$TICK_WATCHER->at ($NEXT_TICK);	1388	$TICK_WATCHER->at ($NEXT_TICK);
855	$TICK_WATCHER->start;	1389	$TICK_WATCHER->start;
856	},	1390	},
857	);	1391	);
858		1392
859	_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	};
860		1409
861	1	1410	1
862		1411

Diff Legend

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