[ViewVC] Diff of: cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.47 by root, Sun Aug 27 13:02:04 2006 UTC vs.
Revision 1.106 by root, Sun Dec 31 17:29:22 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	=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
110	=item $object->attach ($attachment, ...)	251	=head2 ATTACHABLE OBJECTS
111		252
112	Attach a pre-registered attachment to an object.	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.
113		256
114	=item $player->attach ($attachment, ...)	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+).
115		260
116	Attach a pre-registered attachment to a player.	261	=over 4
117		262
118	=item $map->attach ($attachment, ...) # not yet persistent	263	=item $attachable->attach ($attachment, key => $value...)
119		264
120	Attach a pre-registered attachment to a map.	265	=item $attachable->detach ($attachment)
121		266
122	=item cf::attach_global ...	267	Attach/detach a pre-registered attachment to a specific object and give it
		268	the specified key/value pairs as arguments.
123		269
124	Attach handlers for global events.	270	Example, attach a minesweeper attachment to the given object, making it a
		271	10x10 minesweeper game:
125		272
126	This and all following C<attach_*>-functions expect any number of the	273	$obj->attach (minesweeper => width => 10, height => 10);
127	following handler/hook descriptions:	274
		275	=item $bool = $attachable->attached ($name)
		276
		277	Checks wether the named attachment is currently attached to the object.
		278
		279	=item cf::CLASS->attach ...
		280
		281	=item cf::CLASS->detach ...
		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		369
179	=cut	370	=cut
180		371
181	# 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
182	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
183	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)
184	our @CB_PLAYER = ();	376	our @CB_PLAYER = ();
		377	our @CB_CLIENT = ();
185	our @CB_TYPE = (); # registry for type (cf-object class) based events	378	our @CB_TYPE = (); # registry for type (cf-object class) based events
186	our @CB_MAP = ();	379	our @CB_MAP = ();
187		380
188	my %attachment;	381	my %attachment;
189		382
190	sub _attach_cb($\%$$$) {	383	sub _attach_cb($$$$) {
191	my ($registry, $undo, $event, $prio, $cb) = @_;	384	my ($registry, $event, $prio, $cb) = @_;
192		385
193	use sort 'stable';	386	use sort 'stable';
194		387
195	$cb = [$prio, $cb];	388	$cb = [$prio, $cb];
196		389
197	@{$registry->[$event]} = sort	390	@{$registry->[$event]} = sort
198	{ $a->[0] cmp $b->[0] }	391	{ $a->[0] cmp $b->[0] }
199	@{$registry->[$event] \|\| []}, $cb;	392	@{$registry->[$event] \|\| []}, $cb;
200
201	push @{$undo->{cb}}, [$event, $cb];
202	}	393	}
		394
		395	# hack
		396	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
203		397
204	# attach handles attaching event callbacks	398	# attach handles attaching event callbacks
205	# 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
206	# registry (== where the callback attaches to).	400	# registry (== where the callback attaches to).
207	sub _attach(\@$@) {	401	sub _attach {
208	my ($registry, $klass, @arg) = @_;	402	my ($registry, $klass, @arg) = @_;
209		403
		404	my $object_type;
210	my $prio = 0;	405	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;	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	}
218		412
219	while (@arg) {	413	while (@arg) {
220	my $type = shift @arg;	414	my $type = shift @arg;
221		415
222	if ($type eq "prio") {	416	if ($type eq "prio") {
223	$prio = shift @arg;	417	$prio = shift @arg;
224		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
225	} elsif ($type eq "package") {	428	} elsif ($type eq "package") {
226	my $pkg = shift @arg;	429	my $pkg = shift @arg;
227		430
228	while (my ($name, $id) = each %cb_id) {	431	while (my ($name, $id) = each %cb_id) {
229	if (my $cb = $pkg->can ($name)) {	432	if (my $cb = $pkg->can ($name)) {
230	_attach_cb $registry, %undo, $id, $prio, $cb;	433	_attach_cb $registry, $id, $prio, $cb;
231	}	434	}
232	}	435	}
233		436
234	} elsif (exists $cb_id{$type}) {	437	} elsif (exists $cb_id{$type}) {
235	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	438	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
236		439
237	} elsif (ref $type) {	440	} elsif (ref $type) {
238	warn "attaching objects not supported, ignoring.\n";	441	warn "attaching objects not supported, ignoring.\n";
239		442
240	} else {	443	} else {
241	shift @arg;	444	shift @arg;
242	warn "attach argument '$type' not supported, ignoring.\n";	445	warn "attach argument '$type' not supported, ignoring.\n";
243	}	446	}
244	}	447	}
245
246	\%undo
247	}	448	}
248		449
249	sub _attach_attachment {	450	sub _object_attach {
250	my ($obj, $name, @args) = @_;	451	my ($obj, $name, %arg) = @_;
251		452
252	my $res;	453	return if exists $obj->{_attachment}{$name};
253		454
254	if (my $attach = $attachment{$name}) {	455	if (my $attach = $attachment{$name}) {
255	my $registry = $obj->registry;	456	my $registry = $obj->registry;
256		457
257	for (@$attach) {	458	for (@$attach) {
258	my ($klass, @attach) = @$_;	459	my ($klass, @attach) = @$_;
259	$res = _attach @$registry, $klass, @attach;	460	_attach $registry, $klass, @attach;
260	}
261
262	if (my $cb = delete $registry->[EVENT_OBJECT_INSTANTIATE]) {
263	for (@$cb) {
264	eval { $_->[1]->($obj, @args); };
265	if ($@) {
266	warn "$@";
267	warn "... while processing '$name' instantiate with args <@args>.\n";
268	}
269	}	461	}
270	}	462
		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	push @{$obj->{_attachment}}, $name;	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, @args) = @_;	481	my ($obj, $name) = @_;
283		482
284	_attach_attachment $obj, $name, @args;	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, @args) = @_;	492	my ($obj, $name) = @_;
289		493
290	_attach_attachment KLASS_PLAYER, $obj, $name, @args;	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, @args) = @_;	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 KLASS_MAP, $obj, $name, @args;	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, @_]];	506	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		507	}
		508	";
		509	die if $@;
326	}	510	}
327		511
328	our $override;	512	our $override;
329	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?
330		514
…		…
344	for (@$callbacks) {	528	for (@$callbacks) {
345	eval { &{$_->[1]} };	529	eval { &{$_->[1]} };
346		530
347	if ($@) {	531	if ($@) {
348	warn "$@";	532	warn "$@";
349	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	533	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
350	override;	534	override;
351	}	535	}
352		536
353	return 1 if $override;	537	return 1 if $override;
354	}	538	}
355		539
356	0	540	0
357	}	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
358		556
359	#############################################################################	557	#############################################################################
360	# object support	558	# object support
361		559
362	sub instantiate {
363	my ($obj, $data) = @_;
364
365	$data = from_json $data;
366
367	for (@$data) {
368	my ($name, $args) = @$_;
369	attach $obj, $name, @{$args \|\| [] };
370	}
371	}
372
373	# basically do the same as instantiate, without calling instantiate
374	sub reattach {	560	sub reattach {
		561	# basically do the same as instantiate, without calling instantiate
375	my ($obj) = @_;	562	my ($obj) = @_;
		563
376	my $registry = $obj->registry;	564	my $registry = $obj->registry;
377		565
378	@$registry = ();	566	@$registry = ();
379		567
		568	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
		569
380	for my $name (@{ $obj->{_attachment} }) {	570	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
381	if (my $attach = $attachment{$name}) {	571	if (my $attach = $attachment{$name}) {
382	for (@$attach) {	572	for (@$attach) {
383	my ($klass, @attach) = @$_;	573	my ($klass, @attach) = @$_;
384	_attach @$registry, $klass, @attach;	574	_attach $registry, $klass, @attach;
385	}	575	}
386	} else {	576	} else {
387	warn "object uses attachment '$name' that is not available, postponing.\n";	577	warn "object uses attachment '$name' that is not available, postponing.\n";
388	}	578	}
389	}	579	}
390	}	580	}
391		581
		582	cf::attachable->attach (
		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,
		596	on_clone => sub {
		597	my ($src, $dst) = @_;
		598
		599	@{$dst->registry} = @{$src->registry};
		600
		601	%$dst = %$src;
		602
		603	%{$dst->{_attachment}} = %{$src->{_attachment}}
		604	if exists $src->{_attachment};
		605	},
		606	);
		607
392	sub object_freezer_save {	608	sub object_freezer_save {
393	my ($filename, $objs) = @_;	609	my ($filename, $rdata, $objs) = @_;
394		610
395	$filename .= ".pst";	611	sync_job {
		612	if (length $$rdata) {
		613	warn sprintf "saving %s (%d,%d)\n",
		614	$filename, length $$rdata, scalar @$objs;
396		615
397	if (@$objs) {	616	if (my $fh = aio_open "$filename~", O_WRONLY \| O_CREAT, 0600) {
398	open my $fh, ">:raw", "$filename~";	617	chmod SAVE_MODE, $fh;
399	chmod $fh, SAVE_MODE;	618	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
400	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	619	aio_fsync $fh;
401	close $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
402	rename "$filename~", $filename;	635	aio_rename "$filename~", $filename;
		636	} else {
		637	warn "FATAL: $filename~: $!\n";
		638	}
403	} else {	639	} else {
404	unlink $filename;	640	aio_unlink $filename;
		641	aio_unlink "$filename.pst";
		642	}
405	}	643	}
		644	}
		645
		646	sub object_freezer_as_string {
		647	my ($rdata, $objs) = @_;
		648
		649	use Data::Dumper;
		650
		651	$$rdata . Dumper $objs
406	}	652	}
407		653
408	sub object_thawer_load {	654	sub object_thawer_load {
409	my ($filename) = @_;	655	my ($filename) = @_;
410		656
411	open my $fh, "<:raw:perlio", "$filename.pst"	657	my ($data, $av);
		658
		659	(aio_load $filename, $data) >= 0
412	or return;	660	or return;
413		661
		662	unless (aio_stat "$filename.pst") {
		663	(aio_load "$filename.pst", $av) >= 0
		664	or return;
414	eval { local $/; (Storable::thaw <$fh>)->{objs} }	665	$av = eval { (Storable::thaw <$av>)->{objs} };
415	}
416
417	attach_to_objects
418	prio => -1000000,
419	on_clone => sub {
420	my ($src, $dst) = @_;
421
422	@{$dst->registry} = @{$src->registry};
423
424	%$dst = %$src;
425
426	$dst->{_attachment} = [@{ $src->{_attachment} }]
427	if exists $src->{_attachment};
428	},	666	}
429	;	667
		668	return ($data, $av);
		669	}
430		670
431	#############################################################################	671	#############################################################################
432	# old plug-in events	672	# command handling &c
433		673
434	sub inject_event {	674	=item cf::register_command $name => \&callback($ob,$args);
435	my $extension = shift;
436	my $event_code = shift;
437		675
438	my $cb = $hook[$event_code]{$extension}	676	Register a callback for execution when the client sends the user command
439	or return;	677	$name.
440		678
441	&$cb	679	=cut
442	}
443
444	sub inject_global_event {
445	my $event = shift;
446
447	my $cb = $hook[$event]
448	or return;
449
450	List::Util::max map &$_, values %$cb
451	}
452
453	sub inject_command {
454	my ($name, $obj, $params) = @_;
455
456	for my $cmd (@{ $command{$name} }) {
457	$cmd->[1]->($obj, $params);
458	}
459
460	-1
461	}
462		680
463	sub register_command {	681	sub register_command {
464	my ($name, $time, $cb) = @_;	682	my ($name, $cb) = @_;
465		683
466	my $caller = caller;	684	my $caller = caller;
467	#warn "registering command '$name/$time' to '$caller'";	685	#warn "registering command '$name/$time' to '$caller'";
468		686
469	push @{ $command{$name} }, [$time, $cb, $caller];	687	push @{ $COMMAND{$name} }, [$caller, $cb];
470	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
471	}	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
472		698
473	sub register_extcmd {	699	sub register_extcmd {
474	my ($name, $cb) = @_;	700	my ($name, $cb) = @_;
475		701
476	my $caller = caller;	702	my $caller = caller;
477	#warn "registering extcmd '$name' to '$caller'";	703	#warn "registering extcmd '$name' to '$caller'";
478		704
479	$extcmd{$name} = [$cb, $caller];	705	$EXTCMD{$name} = [$cb, $caller];
480	}	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	);
481		739
482	sub register {	740	sub register {
483	my ($base, $pkg) = @_;	741	my ($base, $pkg) = @_;
484		742
485	#TODO	743	#TODO
…		…
504	. "#line 1 \"$path\"\n{\n"	762	. "#line 1 \"$path\"\n{\n"
505	. (do { local $/; <$fh> })	763	. (do { local $/; <$fh> })
506	. "\n};\n1";	764	. "\n};\n1";
507		765
508	eval $source	766	eval $source
509	or die "$path: $@";	767	or die $@ ? "$path: $@\n"
		768	: "extension disabled.\n";
510		769
511	push @exts, $pkg;	770	push @exts, $pkg;
512	$ext_pkg{$base} = $pkg;	771	$ext_pkg{$base} = $pkg;
513		772
514	# no strict 'refs';	773	# no strict 'refs';
…		…
527	# for my $idx (0 .. $#PLUGIN_EVENT) {	786	# for my $idx (0 .. $#PLUGIN_EVENT) {
528	# delete $hook[$idx]{$pkg};	787	# delete $hook[$idx]{$pkg};
529	# }	788	# }
530		789
531	# remove commands	790	# remove commands
532	for my $name (keys %command) {	791	for my $name (keys %COMMAND) {
533	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	792	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
534		793
535	if (@cb) {	794	if (@cb) {
536	$command{$name} = \@cb;	795	$COMMAND{$name} = \@cb;
537	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
538	} else {	796	} else {
539	delete $command{$name};
540	delete $COMMAND{"$name\000"};	797	delete $COMMAND{$name};
541	}	798	}
542	}	799	}
543		800
544	# remove extcmds	801	# remove extcmds
545	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	802	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
546	delete $extcmd{$name};	803	delete $EXTCMD{$name};
547	}	804	}
548		805
549	if (my $cb = $pkg->can ("unload")) {	806	if (my $cb = $pkg->can ("unload")) {
550	eval {	807	eval {
551	$cb->($pkg);	808	$cb->($pkg);
…		…
555		812
556	Symbol::delete_package $pkg;	813	Symbol::delete_package $pkg;
557	}	814	}
558		815
559	sub load_extensions {	816	sub load_extensions {
560	my $LIBDIR = maps_directory "perl";
561
562	for my $ext (<$LIBDIR/*.ext>) {	817	for my $ext (<$LIBDIR/*.ext>) {
563	next unless -r $ext;	818	next unless -r $ext;
564	eval {	819	eval {
565	load_extension $ext;	820	load_extension $ext;
566	1	821	1
567	} or warn "$ext not loaded: $@";	822	} or warn "$ext not loaded: $@";
568	}	823	}
569	}	824	}
570		825
571	sub _perl_reload(&) {
572	my ($msg) = @_;
573
574	$msg->("reloading...");
575
576	eval {
577	# 1. cancel all watchers
578	$_->cancel for Event::all_watchers;
579
580	# 2. unload all extensions
581	for (@exts) {
582	$msg->("unloading <$_>");
583	unload_extension $_;
584	}
585
586	# 3. unload all modules loaded from $LIBDIR
587	while (my ($k, $v) = each %INC) {
588	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
589
590	$msg->("removing <$k>");
591	delete $INC{$k};
592
593	$k =~ s/\.pm$//;
594	$k =~ s/\//::/g;
595
596	if (my $cb = $k->can ("unload_module")) {
597	$cb->();
598	}
599
600	Symbol::delete_package $k;
601	}
602
603	# 4. get rid of safe::, as good as possible
604	Symbol::delete_package "safe::$_"
605	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
606
607	# 5. remove register_script_function callbacks
608	# TODO
609
610	# 6. unload cf.pm "a bit"
611	delete $INC{"cf.pm"};
612
613	# don't, removes xs symbols, too,
614	# and global variables created in xs
615	#Symbol::delete_package __PACKAGE__;
616
617	# 7. reload cf.pm
618	$msg->("reloading cf.pm");
619	require cf;
620	};
621	$msg->($@) if $@;
622
623	$msg->("reloaded");
624	};
625
626	sub perl_reload() {
627	_perl_reload {
628	warn $_[0];
629	print "$_[0]\n";
630	};
631	}
632
633	register_command "perl-reload", 0, sub {
634	my ($who, $arg) = @_;
635
636	if ($who->flag (FLAG_WIZ)) {
637	_perl_reload {
638	warn $_[0];
639	$who->message ($_[0]);
640	};
641	}
642	};
643
644	#############################################################################
645	# extcmd framework, basically convert ext <msg>
646	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
647
648	attach_to_players
649	on_extcmd => sub {
650	my ($pl, $buf) = @_;
651
652	my $msg = eval { from_json $buf };
653
654	if (ref $msg) {
655	if (my $cb = $extcmd{$msg->{msgtype}}) {
656	if (my %reply = $cb->[0]->($pl, $msg)) {
657	$pl->ext_reply ($msg->{msgid}, %reply);
658	}
659	}
660	} else {
661	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
662	}
663
664	cf::override;
665	},
666	;
667
668	#############################################################################	826	#############################################################################
669	# load/save/clean perl data associated with a map	827	# load/save/clean perl data associated with a map
670		828
671	*cf::mapsupport::on_clean = sub {	829	*cf::mapsupport::on_clean = sub {
672	my ($map) = @_;	830	my ($map) = @_;
673		831
674	my $path = $map->tmpname;	832	my $path = $map->tmpname;
675	defined $path or return;	833	defined $path or return;
676		834
677	unlink "$path.cfperl";
678	unlink "$path.pst";	835	unlink "$path.pst";
679	};	836	};
680		837
681	*cf::mapsupport::on_swapin =
682	*cf::mapsupport::on_load = sub {
683	my ($map) = @_;
684
685	my $path = $map->tmpname;
686	$path = $map->path unless defined $path;
687
688	open my $fh, "<:raw", "$path.cfperl"
689	or return; # no perl data
690
691	my $data = Storable::thaw do { local $/; <$fh> };
692
693	$data->{version} <= 1
694	or return; # too new
695
696	$map->_set_obs ($data->{obs});
697	};
698
699	attach_to_maps prio => -10000, package => cf::mapsupport::;	838	cf::map->attach (prio => -10000, package => cf::mapsupport::);
700		839
701	#############################################################################	840	#############################################################################
702	# load/save perl data associated with player->ob objects	841	# load/save perl data associated with player->ob objects
703		842
704	sub all_objects(@) {	843	sub all_objects(@) {
705	@_, map all_objects ($_->inv), @_	844	@_, map all_objects ($_->inv), @_
706	}	845	}
707		846
708	attach_to_players	847	# TODO: compatibility cruft, remove when no longer needed
		848	cf::player->attach (
709	on_load => sub {	849	on_load => sub {
710	my ($pl, $path) = @_;	850	my ($pl, $path) = @_;
711		851
712	for my $o (all_objects $pl->ob) {	852	for my $o (all_objects $pl->ob) {
713	if (my $value = $o->get_ob_key_value ("_perl_data")) {	853	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
715		855
716	%$o = %{ Storable::thaw pack "H*", $value };	856	%$o = %{ Storable::thaw pack "H*", $value };
717	}	857	}
718	}	858	}
719	},	859	},
720	;	860	);
721		861
722	#############################################################################	862	#############################################################################
723	# 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
724		871
725	=item cf::player::exists $login	872	=item cf::player::exists $login
726		873
727	Returns true when the given account exists.	874	Returns true when the given account exists.
728		875
…		…
731	sub cf::player::exists($) {	878	sub cf::player::exists($) {
732	cf::player::find $_[0]	879	cf::player::find $_[0]
733	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;
734	}	881	}
735		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
736	=item $player->reply ($npc, $msg[, $flags])	903	=item $player_object->reply ($npc, $msg[, $flags])
737		904
738	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>
739	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
740	dialogue with the given NPC character.	907	dialogue with the given NPC character.
741		908
742	=cut	909	=cut
743		910
744	# rough implementation of a future "reply" method that works	911	# rough implementation of a future "reply" method that works
745	# with dialog boxes.	912	# with dialog boxes.
		913	#TODO: the first argument must go, split into a $npc->reply_to ( method
746	sub cf::object::player::reply($$$;$) {	914	sub cf::object::player::reply($$$;$) {
747	my ($self, $npc, $msg, $flags) = @_;	915	my ($self, $npc, $msg, $flags) = @_;
748		916
749	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	917	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
750		918
…		…
754	$msg = $npc->name . " says: $msg" if $npc;	922	$msg = $npc->name . " says: $msg" if $npc;
755	$self->message ($msg, $flags);	923	$self->message ($msg, $flags);
756	}	924	}
757	}	925	}
758		926
759	=item $player->ext_reply ($msgid, $msgtype, %msg)	927	=item $player_object->may ("access")
760		928
761	Sends an ext reply to the player.	929	Returns wether the given player is authorized to access resource "access"
		930	(e.g. "command_wizcast").
762		931
763	=cut	932	=cut
764		933
765	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 {
766	my ($self, $id, %msg) = @_;	1020	my ($self, $cb) = @_;
767		1021
768	$msg{msgid} = $id;	1022	my $coro; $coro = async {
		1023	eval {
		1024	$cb->();
		1025	};
		1026	warn $@ if $@;
		1027	};
769		1028
770	$self->send ("ext " . to_json \%msg);	1029	$coro->on_destroy (sub {
771	}	1030	delete $self->{_coro}{$coro+0};
		1031	});
772		1032
773	#############################################################################	1033	$self->{_coro}{$coro+0} = $coro;
774	# 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
775		1058
776	our $safe = new Safe "safe";	1059	our $safe = new Safe "safe";
777	our $safe_hole = new Safe::Hole;	1060	our $safe_hole = new Safe::Hole;
778		1061
779	$SIG{FPE} = 'IGNORE';	1062	$SIG{FPE} = 'IGNORE';
780		1063
781	$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));
782		1065
783	# here we export the classes and methods available to script code	1066	# here we export the classes and methods available to script code
784		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
785	for (	1079	for (
786	["cf::object" => qw(contr pay_amount pay_player)],	1080	["cf::object" => qw(contr pay_amount pay_player map)],
787	["cf::object::player" => qw(player)],	1081	["cf::object::player" => qw(player)],
788	["cf::player" => qw(peaceful)],	1082	["cf::player" => qw(peaceful)],
		1083	["cf::map" => qw(trigger)],
789	) {	1084	) {
790	no strict 'refs';	1085	no strict 'refs';
791	my ($pkg, @funs) = @$_;	1086	my ($pkg, @funs) = @$_;
792	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1087	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
793	for @funs;	1088	for @funs;
794	}	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
795		1102
796	sub safe_eval($;@) {	1103	sub safe_eval($;@) {
797	my ($code, %vars) = @_;	1104	my ($code, %vars) = @_;
798		1105
799	my $qcode = $code;	1106	my $qcode = $code;
…		…
822	}	1129	}
823		1130
824	wantarray ? @res : $res[0]	1131	wantarray ? @res : $res[0]
825	}	1132	}
826		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
827	sub register_script_function {	1149	sub register_script_function {
828	my ($fun, $cb) = @_;	1150	my ($fun, $cb) = @_;
829		1151
830	no strict 'refs';	1152	no strict 'refs';
831	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1153	*{"safe::$fun"} = $safe_hole->wrap ($cb);
832	}	1154	}
833		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
834	#############################################################################	1265	#############################################################################
835	# the server's main()	1266	# the server's main()
836		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
837	sub main {	1276	sub main {
		1277	cfg_load;
		1278	db_load;
		1279	load_extensions;
838	Event::loop;	1280	Event::loop;
839	}	1281	}
840		1282
841	#############################################################################	1283	#############################################################################
842	# initialisation	1284	# initialisation
843		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
		1378	sub perl_reload() {
		1379	_perl_reload;
		1380	}
		1381
844	register "<global>", __PACKAGE__;	1382	register "<global>", __PACKAGE__;
845		1383
		1384	register_command "perl-reload" => sub {
		1385	my ($who, $arg) = @_;
		1386
		1387	if ($who->flag (FLAG_WIZ)) {
		1388	$who->message ("reloading...");
		1389	_perl_reload;
		1390	}
		1391	};
		1392
846	unshift @INC, $LIBDIR;	1393	unshift @INC, $LIBDIR;
847		1394
848	load_extensions;
849
850	$TICK_WATCHER = Event->timer (	1395	$TICK_WATCHER = Event->timer (
		1396	reentrant => 0,
851	prio => 1,	1397	prio => 0,
852	at => $NEXT_TICK \|\| 1,	1398	at => $NEXT_TICK \|\| $TICK,
		1399	data => WF_AUTOCANCEL,
853	cb => sub {	1400	cb => sub {
		1401	unless ($FREEZE) {
854	cf::server_tick; # one server iteration	1402	cf::server_tick; # one server iteration
		1403	$RUNTIME += $TICK;
		1404	}
855		1405
856	my $NOW = Event::time;
857	$NEXT_TICK += $TICK;	1406	$NEXT_TICK += $TICK;
858		1407
859	# if we are delayed by four ticks, skip them all	1408	# if we are delayed by four ticks or more, skip them all
860	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1409	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
861		1410
862	$TICK_WATCHER->at ($NEXT_TICK);	1411	$TICK_WATCHER->at ($NEXT_TICK);
863	$TICK_WATCHER->start;	1412	$TICK_WATCHER->start;
864	},	1413	},
865	);	1414	);
866		1415
867	_reload_2;	1416	IO::AIO::max_poll_time $TICK * 0.2;
		1417
		1418	Event->io (fd => IO::AIO::poll_fileno,
		1419	poll => 'r',
		1420	prio => 5,
		1421	data => WF_AUTOCANCEL,
		1422	cb => \&IO::AIO::poll_cb);
		1423
		1424	# we must not ever block the main coroutine
		1425	$Coro::idle = sub {
		1426	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1427	warn "FATAL: Coro::idle was called, major BUG\n";
		1428	(Coro::unblock_sub {
		1429	Event::one_event;
		1430	})->();
		1431	};
868		1432
869	1	1433	1
870		1434

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.47 by root, Sun Aug 27 13:02:04 2006 UTC vs. Revision 1.106 by root, Sun Dec 31 17:29:22 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.47 by root, Sun Aug 27 13:02:04 2006 UTC vs.
Revision 1.106 by root, Sun Dec 31 17:29:22 2006 UTC