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.66 by root, Tue Sep 12 22:43:31 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	_init_vars;	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 $LIBDIR = maps_directory "perl";	39	our $LIBDIR = datadir . "/ext";
21		40
22	our $TICK = MAX_TIME * 1e-6;	41	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	42	our $TICK_WATCHER;
24	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
25		108
26	BEGIN {	109	BEGIN {
27	*CORE::GLOBAL::warn = sub {	110	*CORE::GLOBAL::warn = sub {
28	my $msg = join "", @_;	111	my $msg = join "", @_;
		112	utf8::encode $msg;
		113
29	$msg .= "\n"	114	$msg .= "\n"
30	unless $msg =~ /\n$/;	115	unless $msg =~ /\n$/;
31		116
32	print STDERR "cfperl: $msg";
33	LOG llevError, "cfperl: $msg";	117	LOG llevError, "cfperl: $msg";
34	};	118	};
35	}	119	}
36		120
		121	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		122	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		123	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		124	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		125	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
37	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	126	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
38		127
39	# 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
40	# within the Safe compartment.	129	# within the Safe compartment.
41	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	130	for my $pkg (qw(
		131	cf::global cf::attachable
		132	cf::object cf::object::player
		133	cf::client cf::player
		134	cf::arch cf::living
		135	cf::map cf::party cf::region
		136	)) {
42	no strict 'refs';	137	no strict 'refs';
43	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	138	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
44	}	139	}
45		140
46	$Event::DIED = sub {	141	$Event::DIED = sub {
…		…
48	};	143	};
49		144
50	my %ext_pkg;	145	my %ext_pkg;
51	my @exts;	146	my @exts;
52	my @hook;	147	my @hook;
53	my %command;
54	my %extcmd;
55		148
56	#############################################################################	149	=head2 UTILITY FUNCTIONS
57	# utility functions	150
		151	=over 4
		152
		153	=cut
58		154
59	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
60		162
61	sub from_json($) {	163	sub from_json($) {
62	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	164	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
63	JSON::Syck::Load $_[0]	165	JSON::Syck::Load $_[0]
64	}	166	}
65		167
		168	=item $json = cf::to_json $ref
		169
		170	Converts a perl data structure into its JSON representation.
		171
		172	=cut
		173
66	sub to_json($) {	174	sub to_json($) {
67	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	175	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
68	JSON::Syck::Dump $_[0]	176	JSON::Syck::Dump $_[0]
69	}	177	}
70		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
71	#############################################################################	249	#############################################################################
72	# "new" plug-in system
73		250
74	=head3 EVENTS AND OBJECT ATTACHMENTS	251	=head2 ATTACHABLE OBJECTS
		252
		253	Many objects in crossfire are so-called attachable objects. That means you can
		254	attach callbacks/event handlers (a collection of which is called an "attachment")
		255	to it. All such attachable objects support the following methods.
		256
		257	In the following description, CLASS can be any of C<global>, C<object>
		258	C<player>, C<client> or C<map> (i.e. the attachable objects in
		259	crossfire+).
75		260
76	=over 4	261	=over 4
77		262
78	=item $object->attach ($attachment, key => $value...)
79
80	=item $object->detach ($attachment)
81
82	Attach/detach a pre-registered attachment to an object.
83
84	=item $player->attach ($attachment, key => $value...)
85
86	=item $player->detach ($attachment)
87
88	Attach/detach a pre-registered attachment to a player.
89
90	=item $map->attach ($attachment, key => $value...)	263	=item $attachable->attach ($attachment, key => $value...)
91		264
92	=item $map->detach ($attachment)	265	=item $attachable->detach ($attachment)
93		266
94	Attach/detach a pre-registered attachment to a map.	267	Attach/detach a pre-registered attachment to a specific object and give it
		268	the specified key/value pairs as arguments.
95		269
96	=item $bool = $object->attached ($name)	270	Example, attach a minesweeper attachment to the given object, making it a
		271	10x10 minesweeper game:
97		272
98	=item $bool = $player->attached ($name)	273	$obj->attach (minesweeper => width => 10, height => 10);
99		274
100	=item $bool = $map->attached ($name)	275	=item $bool = $attachable->attached ($name)
101		276
102	Checks wether the named attachment is currently attached to the object.	277	Checks wether the named attachment is currently attached to the object.
103		278
104	=item cf::attach_global ...	279	=item cf::CLASS->attach ...
105		280
106	Attach handlers for global events.	281	=item cf::CLASS->detach ...
107		282
108	This and all following C<attach_*>-functions expect any number of the	283	Define an anonymous attachment and attach it to all objects of the given
109	following handler/hook descriptions:	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:
110		317
111	=over 4	318	=over 4
112		319
113	=item prio => $number	320	=item prio => $number
114		321
…		…
116	by another C<prio> setting). Lower priority handlers get executed	323	by another C<prio> setting). Lower priority handlers get executed
117	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
118	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
119	unless you know what you are doing.	326	unless you know what you are doing.
120		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
121	=item on_I<event> => \&cb	334	=item on_I<event> => \&cb
122		335
123	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
124	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
125	handlers are recognised generally depends on the type of object these	338	handlers are recognised generally depends on the type of object these
…		…
134	package and register them. Only handlers for eevents supported by the	347	package and register them. Only handlers for eevents supported by the
135	object/class are recognised.	348	object/class are recognised.
136		349
137	=back	350	=back
138		351
139	=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:
140		354
141	Attach handlers for a specific object type (e.g. TRANSPORT) and	355	cf::object::attachment sockpuppet =>
142	subtype. If C<$subtype> is zero or undef, matches all objects of the given	356	on_skill_attack => sub {
143	type.	357	my ($self, $victim) = @_;
144		358	...
145	=item cf::attach_to_objects ...
146
147	Attach handlers to all objects. Do not use this except for debugging or
148	very rare events, as handlers are (obviously) called for I<all> objects in
149	the game.
150
151	=item cf::attach_to_players ...
152
153	Attach handlers to all players.
154
155	=item cf::attach_to_maps ...
156
157	Attach handlers to all maps.
158
159	=item cf:register_attachment $name, ...
160
161	Register an attachment by name through which objects can refer to this
162	attachment.
163
164	=item cf:register_player_attachment $name, ...
165
166	Register an attachment by name through which players can refer to this
167	attachment.
168
169	=item cf:register_map_attachment $name, ...
170
171	Register an attachment by name through which maps can refer to this
172	attachment.
173
174	=cut
175
176	# the following variables are defined in .xs and must not be re-created
177	our @CB_GLOBAL = (); # registry for all global events
178	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
179	our @CB_PLAYER = ();
180	our @CB_TYPE = (); # registry for type (cf-object class) based events
181	our @CB_MAP = ();
182
183	my %attachment;
184
185	sub _attach_cb($\%$$$) {
186	my ($registry, $undo, $event, $prio, $cb) = @_;
187
188	use sort 'stable';
189
190	$cb = [$prio, $cb];
191
192	@{$registry->[$event]} = sort
193	{ $a->[0] cmp $b->[0] }
194	@{$registry->[$event] || []}, $cb;
195
196	push @{$undo->{cb}}, [$event, $cb];
197	}
198
199	# attach handles attaching event callbacks
200	# the only thing the caller has to do is pass the correct
201	# registry (== where the callback attaches to).
202	sub _attach(\@$@) {
203	my ($registry, $klass, @arg) = @_;
204
205	my $prio = 0;
206
207	my %undo = (
208	registry => $registry,
209	cb => [],
210	);
211
212	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
213
214	while (@arg) {
215	my $type = shift @arg;
216
217	if ($type eq "prio") {
218	$prio = shift @arg;
219
220	} elsif ($type eq "package") {
221	my $pkg = shift @arg;
222
223	while (my ($name, $id) = each %cb_id) {
224	if (my $cb = $pkg->can ($name)) {
225	_attach_cb $registry, %undo, $id, $prio, $cb;
226	}
227	}	359	}
228
229	} elsif (exists $cb_id{$type}) {
230	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
231
232	} elsif (ref $type) {
233	warn "attaching objects not supported, ignoring.\n";
234
235	} else {
236	shift @arg;
237	warn "attach argument '$type' not supported, ignoring.\n";
238	}
239	}
240
241	\%undo
242	}
243
244	sub _attach_attachment {
245	my ($obj, $name, %arg) = @_;
246
247	return if exists $obj->{_attachment}{$name};
248
249	my $res;
250
251	if (my $attach = $attachment{$name}) {
252	my $registry = $obj->registry;
253
254	for (@$attach) {
255	my ($klass, @attach) = @$_;
256	$res = _attach @$registry, $klass, @attach;
257	}
258
259	$obj->{$name} = \%arg;
260	} else {
261	warn "object uses attachment '$name' that is not available, postponing.\n";
262	}
263
264	$obj->{_attachment}{$name} = undef;
265
266	$res->{attachment} = $name;
267	$res
268	}
269
270	*cf::object::attach =
271	*cf::player::attach =
272	*cf::map::attach = sub {
273	my ($obj, $name, %arg) = @_;
274
275	_attach_attachment $obj, $name, %arg;
276	};
277
278	# all those should be optimised
279	*cf::object::detach =
280	*cf::player::detach =
281	*cf::map::detach = sub {
282	my ($obj, $name) = @_;
283
284	delete $obj->{_attachment}{$name};
285	reattach ($obj);
286	};
287
288	*cf::object::attached =
289	*cf::player::attached =
290	*cf::map::attached = sub {
291	my ($obj, $name) = @_;
292
293	exists $obj->{_attachment}{$name}
294	};
295
296	sub attach_global {
297	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
298	}
299
300	sub attach_to_type {
301	my $type = shift;
302	my $subtype = shift;
303
304	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
305	}
306
307	sub attach_to_objects {
308	_attach @CB_OBJECT, KLASS_OBJECT, @_
309	}
310
311	sub attach_to_players {
312	_attach @CB_PLAYER, KLASS_PLAYER, @_
313	}
314
315	sub attach_to_maps {
316	_attach @CB_MAP, KLASS_MAP, @_
317	}
318
319	sub register_attachment {
320	my $name = shift;
321
322	$attachment{$name} = [[KLASS_OBJECT, @_]];
323	}
324
325	sub register_player_attachment {
326	my $name = shift;
327
328	$attachment{$name} = [[KLASS_PLAYER, @_]];
329	}
330
331	sub register_map_attachment {
332	my $name = shift;
333
334	$attachment{$name} = [[KLASS_MAP, @_]];
335	}
336
337	our $override;
338	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
339
340	sub override {
341	$override = 1;
342	@invoke_results = ();
343	}
344
345	sub do_invoke {
346	my $event = shift;
347	my $callbacks = shift;
348
349	@invoke_results = ();
350
351	local $override;
352
353	for (@$callbacks) {
354	eval { &{$_->[1]} };
355
356	if ($@) {
357	warn "$@";
358	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
359	override;
360	}
361
362	return 1 if $override;
363	}
364
365	0	360	}
366	}
367		361
368	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	362	=item $attachable->valid
369
370	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
371
372	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
373
374	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
375
376	Generate a global/object/player/map-specific event with the given arguments.
377
378	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
379	removed in future versions), and there is no public API to access override
380	results (if you must, access C<@cf::invoke_results> directly).
381
382	=back
383
384	=head2 methods valid for all pointers
385
386	=over 4
387
388	=item $object->valid
389
390	=item $player->valid
391
392	=item $map->valid
393		363
394	Just because you have a perl object does not mean that the corresponding	364	Just because you have a perl object does not mean that the corresponding
395	C-level object still exists. If you try to access an object that has no	365	C-level object still exists. If you try to access an object that has no
396	valid C counterpart anymore you get an exception at runtime. This method	366	valid C counterpart anymore you get an exception at runtime. This method
397	can be used to test for existence of the C object part without causing an	367	can be used to test for existence of the C object part without causing an
398	exception.	368	exception.
399		369
		370	=cut
		371
		372	# the following variables are defined in .xs and must not be re-created
		373	our @CB_GLOBAL = (); # registry for all global events
		374	our @CB_ATTACHABLE = (); # registry for all attachables
		375	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		376	our @CB_PLAYER = ();
		377	our @CB_CLIENT = ();
		378	our @CB_TYPE = (); # registry for type (cf-object class) based events
		379	our @CB_MAP = ();
		380
		381	my %attachment;
		382
		383	sub _attach_cb($$$$) {
		384	my ($registry, $event, $prio, $cb) = @_;
		385
		386	use sort 'stable';
		387
		388	$cb = [$prio, $cb];
		389
		390	@{$registry->[$event]} = sort
		391	{ $a->[0] cmp $b->[0] }
		392	@{$registry->[$event] || []}, $cb;
		393	}
		394
		395	# hack
		396	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		397
		398	# attach handles attaching event callbacks
		399	# the only thing the caller has to do is pass the correct
		400	# registry (== where the callback attaches to).
		401	sub _attach {
		402	my ($registry, $klass, @arg) = @_;
		403
		404	my $object_type;
		405	my $prio = 0;
		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	}
		412
		413	while (@arg) {
		414	my $type = shift @arg;
		415
		416	if ($type eq "prio") {
		417	$prio = shift @arg;
		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
		428	} elsif ($type eq "package") {
		429	my $pkg = shift @arg;
		430
		431	while (my ($name, $id) = each %cb_id) {
		432	if (my $cb = $pkg->can ($name)) {
		433	_attach_cb $registry, $id, $prio, $cb;
		434	}
		435	}
		436
		437	} elsif (exists $cb_id{$type}) {
		438	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		439
		440	} elsif (ref $type) {
		441	warn "attaching objects not supported, ignoring.\n";
		442
		443	} else {
		444	shift @arg;
		445	warn "attach argument '$type' not supported, ignoring.\n";
		446	}
		447	}
		448	}
		449
		450	sub _object_attach {
		451	my ($obj, $name, %arg) = @_;
		452
		453	return if exists $obj->{_attachment}{$name};
		454
		455	if (my $attach = $attachment{$name}) {
		456	my $registry = $obj->registry;
		457
		458	for (@$attach) {
		459	my ($klass, @attach) = @$_;
		460	_attach $registry, $klass, @attach;
		461	}
		462
		463	$obj->{$name} = \%arg;
		464	} else {
		465	warn "object uses attachment '$name' that is not available, postponing.\n";
		466	}
		467
		468	$obj->{_attachment}{$name} = undef;
		469	}
		470
		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 {
		481	my ($obj, $name) = @_;
		482
		483	if (ref $obj) {
		484	delete $obj->{_attachment}{$name};
		485	reattach ($obj);
		486	} else {
		487	Carp::croak "cannot, currently, detach class attachments";
		488	}
		489	};
		490
		491	sub cf::attachable::attached {
		492	my ($obj, $name) = @_;
		493
		494	exists $obj->{_attachment}{$name}
		495	}
		496
		497	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		498	eval "#line " . __LINE__ . " 'cf.pm'
		499	sub cf::\L$klass\E::_attach_registry {
		500	(\\\@CB_$klass, KLASS_$klass)
		501	}
		502
		503	sub cf::\L$klass\E::attachment {
		504	my \$name = shift;
		505
		506	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		507	}
		508	";
		509	die if $@;
		510	}
		511
		512	our $override;
		513	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		514
		515	sub override {
		516	$override = 1;
		517	@invoke_results = ();
		518	}
		519
		520	sub do_invoke {
		521	my $event = shift;
		522	my $callbacks = shift;
		523
		524	@invoke_results = ();
		525
		526	local $override;
		527
		528	for (@$callbacks) {
		529	eval { &{$_->[1]} };
		530
		531	if ($@) {
		532	warn "$@";
		533	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		534	override;
		535	}
		536
		537	return 1 if $override;
		538	}
		539
		540	0
		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
400	=back	553	=back
401		554
402	=cut	555	=cut
403
404	*cf::object::valid =
405	*cf::player::valid =
406	*cf::map::valid = \&cf::_valid;
407		556
408	#############################################################################	557	#############################################################################
409	# object support	558	# object support
410		559
411	sub instantiate {
412	my ($obj, $data) = @_;
413
414	$data = from_json $data;
415
416	for (@$data) {
417	my ($name, $args) = @$_;
418
419	$obj->attach ($name, %{$args || {} });
420	}
421	}
422
423	# basically do the same as instantiate, without calling instantiate
424	sub reattach {	560	sub reattach {
		561	# basically do the same as instantiate, without calling instantiate
425	my ($obj) = @_;	562	my ($obj) = @_;
		563
426	my $registry = $obj->registry;	564	my $registry = $obj->registry;
427		565
428	@$registry = ();	566	@$registry = ();
429		567
430	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	568	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
431		569
432	for my $name (keys %{ $obj->{_attachment} || {} }) {	570	for my $name (keys %{ $obj->{_attachment} || {} }) {
433	if (my $attach = $attachment{$name}) {	571	if (my $attach = $attachment{$name}) {
434	for (@$attach) {	572	for (@$attach) {
435	my ($klass, @attach) = @$_;	573	my ($klass, @attach) = @$_;
436	_attach @$registry, $klass, @attach;	574	_attach $registry, $klass, @attach;
437	}	575	}
438	} else {	576	} else {
439	warn "object uses attachment '$name' that is not available, postponing.\n";	577	warn "object uses attachment '$name' that is not available, postponing.\n";
440	}	578	}
441	}	579	}
442	}	580	}
443		581
444	sub object_freezer_save {	582	cf::attachable->attach (
445	my ($filename, $rdata, $objs) = @_;
446
447	if (length $$rdata) {
448	warn sprintf "saving %s (%d,%d)\n",
449	$filename, length $$rdata, scalar @$objs;
450
451	if (open my $fh, ">:raw", "$filename~") {
452	chmod SAVE_MODE, $fh;
453	syswrite $fh, $$rdata;
454	close $fh;
455
456	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
457	chmod SAVE_MODE, $fh;
458	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
459	close $fh;
460	rename "$filename.pst~", "$filename.pst";
461	} else {
462	unlink "$filename.pst";
463	}
464
465	rename "$filename~", $filename;
466	} else {
467	warn "FATAL: $filename~: $!\n";
468	}
469	} else {
470	unlink $filename;
471	unlink "$filename.pst";
472	}
473	}
474
475	sub object_thawer_load {
476	my ($filename) = @_;
477
478	local $/;
479
480	my $av;
481
482	#TODO: use sysread etc.
483	if (open my $data, "<:raw:perlio", $filename) {
484	$data = <$data>;
485	if (open my $pst, "<:raw:perlio", "$filename.pst") {
486	$av = eval { (Storable::thaw <$pst>)->{objs} };
487	}
488	return ($data, $av);
489	}
490
491	()
492	}
493
494	attach_to_objects
495	prio => -1000000,	583	prio => -1000000,
		584	on_instantiate => sub {
		585	my ($obj, $data) = @_;
		586
		587	$data = from_json $data;
		588
		589	for (@$data) {
		590	my ($name, $args) = @$_;
		591
		592	$obj->attach ($name, %{$args || {} });
		593	}
		594	},
		595	on_reattach => \&reattach,
496	on_clone => sub {	596	on_clone => sub {
497	my ($src, $dst) = @_;	597	my ($src, $dst) = @_;
498		598
499	@{$dst->registry} = @{$src->registry};	599	@{$dst->registry} = @{$src->registry};
500		600
501	%$dst = %$src;	601	%$dst = %$src;
502		602
503	%{$dst->{_attachment}} = %{$src->{_attachment}}	603	%{$dst->{_attachment}} = %{$src->{_attachment}}
504	if exists $src->{_attachment};	604	if exists $src->{_attachment};
505	},	605	},
506	;	606	);
		607
		608	sub object_freezer_save {
		609	my ($filename, $rdata, $objs) = @_;
		610
		611	sync_job {
		612	if (length $$rdata) {
		613	warn sprintf "saving %s (%d,%d)\n",
		614	$filename, length $$rdata, scalar @$objs;
		615
		616	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		617	chmod SAVE_MODE, $fh;
		618	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		619	aio_fsync $fh;
		620	close $fh;
		621
		622	if (@$objs) {
		623	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		624	chmod SAVE_MODE, $fh;
		625	my $data = Storable::nfreeze { version => 1, objs => $objs };
		626	aio_write $fh, 0, (length $data), $data, 0;
		627	aio_fsync $fh;
		628	close $fh;
		629	aio_rename "$filename.pst~", "$filename.pst";
		630	}
		631	} else {
		632	aio_unlink "$filename.pst";
		633	}
		634
		635	aio_rename "$filename~", $filename;
		636	} else {
		637	warn "FATAL: $filename~: $!\n";
		638	}
		639	} else {
		640	aio_unlink $filename;
		641	aio_unlink "$filename.pst";
		642	}
		643	}
		644	}
		645
		646	sub object_freezer_as_string {
		647	my ($rdata, $objs) = @_;
		648
		649	use Data::Dumper;
		650
		651	$$rdata . Dumper $objs
		652	}
		653
		654	sub object_thawer_load {
		655	my ($filename) = @_;
		656
		657	my ($data, $av);
		658
		659	(aio_load $filename, $data) >= 0
		660	or return;
		661
		662	unless (aio_stat "$filename.pst") {
		663	(aio_load "$filename.pst", $av) >= 0
		664	or return;
		665	$av = eval { (Storable::thaw <$av>)->{objs} };
		666	}
		667
		668	return ($data, $av);
		669	}
507		670
508	#############################################################################	671	#############################################################################
509	# old plug-in events	672	# command handling &c
510		673
511	sub inject_event {	674	=item cf::register_command $name => \&callback($ob,$args);
512	my $extension = shift;
513	my $event_code = shift;
514		675
515	my $cb = $hook[$event_code]{$extension}	676	Register a callback for execution when the client sends the user command
516	or return;	677	$name.
517		678
518	&$cb	679	=cut
519	}
520
521	sub inject_global_event {
522	my $event = shift;
523
524	my $cb = $hook[$event]
525	or return;
526
527	List::Util::max map &$_, values %$cb
528	}
529
530	sub inject_command {
531	my ($name, $obj, $params) = @_;
532
533	for my $cmd (@{ $command{$name} }) {
534	$cmd->[1]->($obj, $params);
535	}
536
537	-1
538	}
539		680
540	sub register_command {	681	sub register_command {
541	my ($name, $time, $cb) = @_;	682	my ($name, $cb) = @_;
542		683
543	my $caller = caller;	684	my $caller = caller;
544	#warn "registering command '$name/$time' to '$caller'";	685	#warn "registering command '$name/$time' to '$caller'";
545		686
546	push @{ $command{$name} }, [$time, $cb, $caller];	687	push @{ $COMMAND{$name} }, [$caller, $cb];
547	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
548	}	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
549		698
550	sub register_extcmd {	699	sub register_extcmd {
551	my ($name, $cb) = @_;	700	my ($name, $cb) = @_;
552		701
553	my $caller = caller;	702	my $caller = caller;
554	#warn "registering extcmd '$name' to '$caller'";	703	#warn "registering extcmd '$name' to '$caller'";
555		704
556	$extcmd{$name} = [$cb, $caller];	705	$EXTCMD{$name} = [$cb, $caller];
557	}	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	);
558		739
559	sub register {	740	sub register {
560	my ($base, $pkg) = @_;	741	my ($base, $pkg) = @_;
561		742
562	#TODO	743	#TODO
…		…
581	. "#line 1 \"$path\"\n{\n"	762	. "#line 1 \"$path\"\n{\n"
582	. (do { local $/; <$fh> })	763	. (do { local $/; <$fh> })
583	. "\n};\n1";	764	. "\n};\n1";
584		765
585	eval $source	766	eval $source
586	or die "$path: $@";	767	or die $@ ? "$path: $@\n"
		768	: "extension disabled.\n";
587		769
588	push @exts, $pkg;	770	push @exts, $pkg;
589	$ext_pkg{$base} = $pkg;	771	$ext_pkg{$base} = $pkg;
590		772
591	# no strict 'refs';	773	# no strict 'refs';
…		…
604	# for my $idx (0 .. $#PLUGIN_EVENT) {	786	# for my $idx (0 .. $#PLUGIN_EVENT) {
605	# delete $hook[$idx]{$pkg};	787	# delete $hook[$idx]{$pkg};
606	# }	788	# }
607		789
608	# remove commands	790	# remove commands
609	for my $name (keys %command) {	791	for my $name (keys %COMMAND) {
610	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	792	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
611		793
612	if (@cb) {	794	if (@cb) {
613	$command{$name} = \@cb;	795	$COMMAND{$name} = \@cb;
614	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
615	} else {	796	} else {
616	delete $command{$name};
617	delete $COMMAND{"$name\000"};	797	delete $COMMAND{$name};
618	}	798	}
619	}	799	}
620		800
621	# remove extcmds	801	# remove extcmds
622	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	802	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
623	delete $extcmd{$name};	803	delete $EXTCMD{$name};
624	}	804	}
625		805
626	if (my $cb = $pkg->can ("unload")) {	806	if (my $cb = $pkg->can ("unload")) {
627	eval {	807	eval {
628	$cb->($pkg);	808	$cb->($pkg);
…		…
632		812
633	Symbol::delete_package $pkg;	813	Symbol::delete_package $pkg;
634	}	814	}
635		815
636	sub load_extensions {	816	sub load_extensions {
637	my $LIBDIR = maps_directory "perl";
638
639	for my $ext (<$LIBDIR/*.ext>) {	817	for my $ext (<$LIBDIR/*.ext>) {
640	next unless -r $ext;	818	next unless -r $ext;
641	eval {	819	eval {
642	load_extension $ext;	820	load_extension $ext;
643	1	821	1
644	} or warn "$ext not loaded: $@";	822	} or warn "$ext not loaded: $@";
645	}	823	}
646	}	824	}
647		825
648	#############################################################################	826	#############################################################################
649	# extcmd framework, basically convert ext <msg>
650	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
651
652	attach_to_players
653	on_extcmd => sub {
654	my ($pl, $buf) = @_;
655
656	my $msg = eval { from_json $buf };
657
658	if (ref $msg) {
659	if (my $cb = $extcmd{$msg->{msgtype}}) {
660	if (my %reply = $cb->[0]->($pl, $msg)) {
661	$pl->ext_reply ($msg->{msgid}, %reply);
662	}
663	}
664	} else {
665	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
666	}
667
668	cf::override;
669	},
670	;
671
672	#############################################################################
673	# load/save/clean perl data associated with a map	827	# load/save/clean perl data associated with a map
674		828
675	*cf::mapsupport::on_clean = sub {	829	*cf::mapsupport::on_clean = sub {
676	my ($map) = @_;	830	my ($map) = @_;
677		831
…		…
679	defined $path or return;	833	defined $path or return;
680		834
681	unlink "$path.pst";	835	unlink "$path.pst";
682	};	836	};
683		837
684	attach_to_maps prio => -10000, package => cf::mapsupport::;	838	cf::map->attach (prio => -10000, package => cf::mapsupport::);
685		839
686	#############################################################################	840	#############################################################################
687	# load/save perl data associated with player->ob objects	841	# load/save perl data associated with player->ob objects
688		842
689	sub all_objects(@) {	843	sub all_objects(@) {
690	@_, map all_objects ($_->inv), @_	844	@_, map all_objects ($_->inv), @_
691	}	845	}
692		846
693	# TODO: compatibility cruft, remove when no longer needed	847	# TODO: compatibility cruft, remove when no longer needed
694	attach_to_players	848	cf::player->attach (
695	on_load => sub {	849	on_load => sub {
696	my ($pl, $path) = @_;	850	my ($pl, $path) = @_;
697		851
698	for my $o (all_objects $pl->ob) {	852	for my $o (all_objects $pl->ob) {
699	if (my $value = $o->get_ob_key_value ("_perl_data")) {	853	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
701		855
702	%$o = %{ Storable::thaw pack "H*", $value };	856	%$o = %{ Storable::thaw pack "H*", $value };
703	}	857	}
704	}	858	}
705	},	859	},
706	;	860	);
707		861
708	#############################################################################	862	#############################################################################
709	# 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
710		871
711	=item cf::player::exists $login	872	=item cf::player::exists $login
712		873
713	Returns true when the given account exists.	874	Returns true when the given account exists.
714		875
…		…
717	sub cf::player::exists($) {	878	sub cf::player::exists($) {
718	cf::player::find $_[0]	879	cf::player::find $_[0]
719	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;
720	}	881	}
721		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
722	=item $player->reply ($npc, $msg[, $flags])	903	=item $player_object->reply ($npc, $msg[, $flags])
723		904
724	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>
725	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
726	dialogue with the given NPC character.	907	dialogue with the given NPC character.
727		908
728	=cut	909	=cut
729		910
730	# rough implementation of a future "reply" method that works	911	# rough implementation of a future "reply" method that works
731	# with dialog boxes.	912	# with dialog boxes.
		913	#TODO: the first argument must go, split into a $npc->reply_to ( method
732	sub cf::object::player::reply($$$;$) {	914	sub cf::object::player::reply($$$;$) {
733	my ($self, $npc, $msg, $flags) = @_;	915	my ($self, $npc, $msg, $flags) = @_;
734		916
735	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	917	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
736		918
…		…
740	$msg = $npc->name . " says: $msg" if $npc;	922	$msg = $npc->name . " says: $msg" if $npc;
741	$self->message ($msg, $flags);	923	$self->message ($msg, $flags);
742	}	924	}
743	}	925	}
744		926
745	=item $player->ext_reply ($msgid, $msgtype, %msg)	927	=item $player_object->may ("access")
746		928
747	Sends an ext reply to the player.	929	Returns wether the given player is authorized to access resource "access"
		930	(e.g. "command_wizcast").
748		931
749	=cut	932	=cut
750		933
751	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 {
752	my ($self, $id, %msg) = @_;	1020	my ($self, $cb) = @_;
753		1021
754	$msg{msgid} = $id;	1022	my $coro; $coro = async {
		1023	eval {
		1024	$cb->();
		1025	};
		1026	warn $@ if $@;
		1027	};
755		1028
756	$self->send ("ext " . to_json \%msg);	1029	$coro->on_destroy (sub {
757	}	1030	delete $self->{_coro}{$coro+0};
		1031	});
758		1032
759	#############################################################################	1033	$self->{_coro}{$coro+0} = $coro;
760	# 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
761		1058
762	our $safe = new Safe "safe";	1059	our $safe = new Safe "safe";
763	our $safe_hole = new Safe::Hole;	1060	our $safe_hole = new Safe::Hole;
764		1061
765	$SIG{FPE} = 'IGNORE';	1062	$SIG{FPE} = 'IGNORE';
766		1063
767	$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));
768		1065
769	# here we export the classes and methods available to script code	1066	# here we export the classes and methods available to script code
770		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
771	for (	1079	for (
772	["cf::object" => qw(contr pay_amount pay_player)],	1080	["cf::object" => qw(contr pay_amount pay_player map)],
773	["cf::object::player" => qw(player)],	1081	["cf::object::player" => qw(player)],
774	["cf::player" => qw(peaceful)],	1082	["cf::player" => qw(peaceful)],
		1083	["cf::map" => qw(trigger)],
775	) {	1084	) {
776	no strict 'refs';	1085	no strict 'refs';
777	my ($pkg, @funs) = @$_;	1086	my ($pkg, @funs) = @$_;
778	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1087	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
779	for @funs;	1088	for @funs;
780	}	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
781		1102
782	sub safe_eval($;@) {	1103	sub safe_eval($;@) {
783	my ($code, %vars) = @_;	1104	my ($code, %vars) = @_;
784		1105
785	my $qcode = $code;	1106	my $qcode = $code;
…		…
808	}	1129	}
809		1130
810	wantarray ? @res : $res[0]	1131	wantarray ? @res : $res[0]
811	}	1132	}
812		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
813	sub register_script_function {	1149	sub register_script_function {
814	my ($fun, $cb) = @_;	1150	my ($fun, $cb) = @_;
815		1151
816	no strict 'refs';	1152	no strict 'refs';
817	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1153	*{"safe::$fun"} = $safe_hole->wrap ($cb);
818	}	1154	}
		1155
		1156	=back
		1157
		1158	=cut
819		1159
820	#############################################################################	1160	#############################################################################
821		1161
822	=head2 EXTENSION DATABASE SUPPORT	1162	=head2 EXTENSION DATABASE SUPPORT
823		1163
…		…
858		1198
859	Immediately write the database to disk I<if it is dirty>.	1199	Immediately write the database to disk I<if it is dirty>.
860		1200
861	=cut	1201	=cut
862		1202
		1203	our $DB;
		1204
863	{	1205	{
864	my $db;
865	my $path = cf::localdir . "/database.pst";	1206	my $path = cf::localdir . "/database.pst";
866		1207
867	sub db_load() {	1208	sub db_load() {
868	warn "loading database $path\n";#d# remove later	1209	warn "loading database $path\n";#d# remove later
869	$db = stat $path ? Storable::retrieve $path : { };	1210	$DB = stat $path ? Storable::retrieve $path : { };
870	}	1211	}
871		1212
872	my $pid;	1213	my $pid;
873		1214
874	sub db_save() {	1215	sub db_save() {
875	warn "saving database $path\n";#d# remove later	1216	warn "saving database $path\n";#d# remove later
876	waitpid $pid, 0 if $pid;	1217	waitpid $pid, 0 if $pid;
877	unless ($pid = fork) {	1218	if (0 == ($pid = fork)) {
878	$db->{_meta}{version} = 1;	1219	$DB->{_meta}{version} = 1;
879	Storable::nstore $db, "$path~";	1220	Storable::nstore $DB, "$path~";
880	rename "$path~", $path;	1221	rename "$path~", $path;
881	cf::_exit 0 if defined $pid;	1222	cf::_exit 0 if defined $pid;
882	}	1223	}
883	}	1224	}
884		1225
…		…
887	sub db_sync() {	1228	sub db_sync() {
888	db_save if $dirty;	1229	db_save if $dirty;
889	undef $dirty;	1230	undef $dirty;
890	}	1231	}
891		1232
892	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1233	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
893	db_sync;	1234	db_sync;
894	});	1235	});
895		1236
896	sub db_dirty() {	1237	sub db_dirty() {
897	$dirty = 1;	1238	$dirty = 1;
898	$idle->start;	1239	$idle->start;
899	}	1240	}
900		1241
901	sub db_get($;$) {	1242	sub db_get($;$) {
902	@_ >= 2	1243	@_ >= 2
903	? $db->{$_[0]}{$_[1]}	1244	? $DB->{$_[0]}{$_[1]}
904	: ($db->{$_[0]} ||= { })	1245	: ($DB->{$_[0]} ||= { })
905	}	1246	}
906		1247
907	sub db_put($$;$) {	1248	sub db_put($$;$) {
908	if (@_ >= 3) {	1249	if (@_ >= 3) {
909	$db->{$_[0]}{$_[1]} = $_[2];	1250	$DB->{$_[0]}{$_[1]} = $_[2];
910	} else {	1251	} else {
911	$db->{$_[0]} = $_[1];	1252	$DB->{$_[0]} = $_[1];
912	}	1253	}
913	db_dirty;	1254	db_dirty;
914	}	1255	}
		1256
		1257	cf::global->attach (
		1258	prio => 10000,
		1259	on_cleanup => sub {
		1260	db_sync;
		1261	},
		1262	);
915	}	1263	}
916		1264
917	#############################################################################	1265	#############################################################################
918	# the server's main()	1266	# the server's main()
919		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
920	sub main {	1276	sub main {
		1277	cfg_load;
921	db_load;	1278	db_load;
922	load_extensions;	1279	load_extensions;
923	Event::loop;	1280	Event::loop;
924	}	1281	}
925		1282
926	#############################################################################	1283	#############################################################################
927	# initialisation	1284	# initialisation
928		1285
929	sub _perl_reload(&) {	1286	sub _perl_reload() {
930	my ($msg) = @_;	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	}
931		1292
932	$msg->("reloading...");	1293	warn "reloading...";
		1294
		1295	local $FREEZE = 1;
		1296	cf::emergency_save;
933		1297
934	eval {	1298	eval {
		1299	# if anything goes wrong in here, we should simply crash as we already saved
		1300
935	# cancel all watchers	1301	# cancel all watchers
936	$_->cancel for Event::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 = ();
937		1309
938	# unload all extensions	1310	# unload all extensions
939	for (@exts) {	1311	for (@exts) {
940	$msg->("unloading <$_>");	1312	warn "unloading <$_>";
941	unload_extension $_;	1313	unload_extension $_;
942	}	1314	}
943		1315
944	# unload all modules loaded from $LIBDIR	1316	# unload all modules loaded from $LIBDIR
945	while (my ($k, $v) = each %INC) {	1317	while (my ($k, $v) = each %INC) {
946	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1318	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
947		1319
948	$msg->("removing <$k>");	1320	warn "removing <$k>";
949	delete $INC{$k};	1321	delete $INC{$k};
950		1322
951	$k =~ s/\.pm$//;	1323	$k =~ s/\.pm$//;
952	$k =~ s/\//::/g;	1324	$k =~ s/\//::/g;
953		1325
…		…
958	Symbol::delete_package $k;	1330	Symbol::delete_package $k;
959	}	1331	}
960		1332
961	# sync database to disk	1333	# sync database to disk
962	cf::db_sync;	1334	cf::db_sync;
		1335	IO::AIO::flush;
963		1336
964	# get rid of safe::, as good as possible	1337	# get rid of safe::, as good as possible
965	Symbol::delete_package "safe::$_"	1338	Symbol::delete_package "safe::$_"
966	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	1339	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
967		1340
968	# remove register_script_function callbacks	1341	# remove register_script_function callbacks
969	# TODO	1342	# TODO
970		1343
971	# unload cf.pm "a bit"	1344	# unload cf.pm "a bit"
…		…
974	# don't, removes xs symbols, too,	1347	# don't, removes xs symbols, too,
975	# and global variables created in xs	1348	# and global variables created in xs
976	#Symbol::delete_package __PACKAGE__;	1349	#Symbol::delete_package __PACKAGE__;
977		1350
978	# reload cf.pm	1351	# reload cf.pm
979	$msg->("reloading cf.pm");	1352	warn "reloading cf.pm";
980	require cf;	1353	require cf;
		1354	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
981		1355
982	# load database again	1356	# load config and database again
		1357	cf::cfg_load;
983	cf::db_load;	1358	cf::db_load;
984		1359
985	# load extensions	1360	# load extensions
986	$msg->("load extensions");	1361	warn "load extensions";
987	cf::load_extensions;	1362	cf::load_extensions;
988		1363
989	# reattach attachments to objects	1364	# reattach attachments to objects
990	$msg->("reattach");	1365	warn "reattach";
991	_global_reattach;	1366	_global_reattach;
992	};	1367	};
993	$msg->($@) if $@;
994		1368
995	$msg->("reloaded");	1369	if ($@) {
		1370	warn $@;
		1371	warn "error while reloading, exiting.";
		1372	exit 1;
		1373	}
		1374
		1375	warn "reloaded successfully";
996	};	1376	};
997		1377
998	sub perl_reload() {	1378	sub perl_reload() {
999	_perl_reload {	1379	_perl_reload;
1000	warn $_[0];
1001	print "$_[0]\n";
1002	};
1003	}	1380	}
1004		1381
		1382	register "<global>", __PACKAGE__;
		1383
1005	register_command "perl-reload", 0, sub {	1384	register_command "perl-reload" => sub {
1006	my ($who, $arg) = @_;	1385	my ($who, $arg) = @_;
1007		1386
1008	if ($who->flag (FLAG_WIZ)) {	1387	if ($who->flag (FLAG_WIZ)) {
		1388	$who->message ("reloading...");
1009	_perl_reload {	1389	_perl_reload;
1010	warn $_[0];
1011	$who->message ($_[0]);
1012	};
1013	}	1390	}
1014	};	1391	};
1015		1392
1016	register "<global>", __PACKAGE__;
1017
1018	unshift @INC, $LIBDIR;	1393	unshift @INC, $LIBDIR;
1019		1394
1020	$TICK_WATCHER = Event->timer (	1395	$TICK_WATCHER = Event->timer (
		1396	reentrant => 0,
1021	prio => 1,	1397	prio => 0,
1022	at => $NEXT_TICK || 1,	1398	at => $NEXT_TICK || $TICK,
		1399	data => WF_AUTOCANCEL,
1023	cb => sub {	1400	cb => sub {
		1401	unless ($FREEZE) {
1024	cf::server_tick; # one server iteration	1402	cf::server_tick; # one server iteration
		1403	$RUNTIME += $TICK;
		1404	}
1025		1405
1026	my $NOW = Event::time;
1027	$NEXT_TICK += $TICK;	1406	$NEXT_TICK += $TICK;
1028		1407
1029	# if we are delayed by four ticks, skip them all	1408	# if we are delayed by four ticks or more, skip them all
1030	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1409	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1031		1410
1032	$TICK_WATCHER->at ($NEXT_TICK);	1411	$TICK_WATCHER->at ($NEXT_TICK);
1033	$TICK_WATCHER->start;	1412	$TICK_WATCHER->start;
1034	},	1413	},
1035	);	1414	);
1036		1415
		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	};
		1432
1037	1	1433	1
1038		1434

Diff Legend

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