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.75 by root, Mon Oct 2 00:22:01 2006 UTC vs.
Revision 1.107 by root, Sun Dec 31 18:10:40 2006 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3;
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Fcntl;
		21	use IO::AIO 2.31 ();
10	use YAML::Syck ();	22	use YAML::Syck ();
11	use Time::HiRes;	23	use Time::HiRes;
12	use Event;	24
13	$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
14		26
15	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	27	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
16	$YAML::Syck::ImplicitUnicode = 1;	28	$YAML::Syck::ImplicitUnicode = 1;
17		29
18	use strict;	30	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
19		31
20	_init_vars;	32	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
21		33
22	our %COMMAND = ();	34	our %COMMAND = ();
		35	our %COMMAND_TIME = ();
		36	our %EXTCMD = ();
		37
23	our @EVENT;	38	our @EVENT;
24	our $LIBDIR = maps_directory "perl";	39	our $LIBDIR = datadir . "/ext";
25		40
26	our $TICK = MAX_TIME * 1e-6;	41	our $TICK = MAX_TIME * 1e-6;
27	our $TICK_WATCHER;	42	our $TICK_WATCHER;
28	our $NEXT_TICK;	43	our $NEXT_TICK;
		44	our $NOW;
29		45
30	our %CFG;	46	our %CFG;
31		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
32	#############################################################################	72	#############################################################################
33		73
34	=head2 GLOBAL VARIABLES	74	=head2 GLOBAL VARIABLES
35		75
36	=over 4	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.
37		86
38	=item $cf::LIBDIR	87	=item $cf::LIBDIR
39		88
40	The perl library directory, where extensions and cf-specific modules can	89	The perl library directory, where extensions and cf-specific modules can
41	be found. It will be added to C<@INC> automatically.	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.
42		95
43	=item $cf::TICK	96	=item $cf::TICK
44		97
45	The interval between server ticks, in seconds.	98	The interval between server ticks, in seconds.
46		99
…		…
54	=cut	107	=cut
55		108
56	BEGIN {	109	BEGIN {
57	*CORE::GLOBAL::warn = sub {	110	*CORE::GLOBAL::warn = sub {
58	my $msg = join "", @_;	111	my $msg = join "", @_;
		112	utf8::encode $msg;
		113
59	$msg .= "\n"	114	$msg .= "\n"
60	unless $msg =~ /\n$/;	115	unless $msg =~ /\n$/;
61		116
62	print STDERR "cfperl: $msg";
63	LOG llevError, "cfperl: $msg";	117	LOG llevError, "cfperl: $msg";
64	};	118	};
65	}	119	}
66		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';
67	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	126	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
68		127
69	# 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
70	# within the Safe compartment.	129	# within the Safe compartment.
71	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	)) {
72	no strict 'refs';	137	no strict 'refs';
73	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	138	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
74	}	139	}
75		140
76	$Event::DIED = sub {	141	$Event::DIED = sub {
…		…
78	};	143	};
79		144
80	my %ext_pkg;	145	my %ext_pkg;
81	my @exts;	146	my @exts;
82	my @hook;	147	my @hook;
83	my %command;
84	my %extcmd;
85		148
86	=head2 UTILITY FUNCTIONS	149	=head2 UTILITY FUNCTIONS
87		150
88	=over 4	151	=over 4
89		152
…		…
111	sub to_json($) {	174	sub to_json($) {
112	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	175	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
113	JSON::Syck::Dump $_[0]	176	JSON::Syck::Dump $_[0]
114	}	177	}
115		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
116	=back	245	=back
117		246
118	=cut	247	=cut
119		248
120	#############################################################################	249	#############################################################################
121		250
122	=head2 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+).
123		260
124	=over 4	261	=over 4
125		262
126	=item $object->attach ($attachment, key => $value...)
127
128	=item $object->detach ($attachment)
129
130	Attach/detach a pre-registered attachment to an object.
131
132	=item $player->attach ($attachment, key => $value...)
133
134	=item $player->detach ($attachment)
135
136	Attach/detach a pre-registered attachment to a player.
137
138	=item $map->attach ($attachment, key => $value...)	263	=item $attachable->attach ($attachment, key => $value...)
139		264
140	=item $map->detach ($attachment)	265	=item $attachable->detach ($attachment)
141		266
142	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.
143		269
144	=item $bool = $object->attached ($name)	270	Example, attach a minesweeper attachment to the given object, making it a
		271	10x10 minesweeper game:
145		272
146	=item $bool = $player->attached ($name)	273	$obj->attach (minesweeper => width => 10, height => 10);
147		274
148	=item $bool = $map->attached ($name)	275	=item $bool = $attachable->attached ($name)
149		276
150	Checks wether the named attachment is currently attached to the object.	277	Checks wether the named attachment is currently attached to the object.
151		278
152	=item cf::attach_global ...	279	=item cf::CLASS->attach ...
153		280
154	Attach handlers for global events.	281	=item cf::CLASS->detach ...
155		282
156	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
157	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:
158		317
159	=over 4	318	=over 4
160		319
161	=item prio => $number	320	=item prio => $number
162		321
…		…
164	by another C<prio> setting). Lower priority handlers get executed	323	by another C<prio> setting). Lower priority handlers get executed
165	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
166	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
167	unless you know what you are doing.	326	unless you know what you are doing.
168		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
169	=item on_I<event> => \&cb	334	=item on_I<event> => \&cb
170		335
171	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
172	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
173	handlers are recognised generally depends on the type of object these	338	handlers are recognised generally depends on the type of object these
…		…
182	package and register them. Only handlers for eevents supported by the	347	package and register them. Only handlers for eevents supported by the
183	object/class are recognised.	348	object/class are recognised.
184		349
185	=back	350	=back
186		351
187	=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:
188		354
189	Attach handlers for a specific object type (e.g. TRANSPORT) and	355	cf::object::attachment sockpuppet =>
190	subtype. If C<$subtype> is zero or undef, matches all objects of the given	356	on_skill_attack => sub {
191	type.	357	my ($self, $victim) = @_;
192		358	...
193	=item cf::attach_to_objects ...
194
195	Attach handlers to all objects. Do not use this except for debugging or
196	very rare events, as handlers are (obviously) called for I<all> objects in
197	the game.
198
199	=item cf::attach_to_players ...
200
201	Attach handlers to all players.
202
203	=item cf::attach_to_maps ...
204
205	Attach handlers to all maps.
206
207	=item cf:register_attachment $name, ...
208
209	Register an attachment by name through which objects can refer to this
210	attachment.
211
212	=item cf:register_player_attachment $name, ...
213
214	Register an attachment by name through which players can refer to this
215	attachment.
216
217	=item cf:register_map_attachment $name, ...
218
219	Register an attachment by name through which maps can refer to this
220	attachment.
221
222	=cut
223
224	# the following variables are defined in .xs and must not be re-created
225	our @CB_GLOBAL = (); # registry for all global events
226	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
227	our @CB_PLAYER = ();
228	our @CB_TYPE = (); # registry for type (cf-object class) based events
229	our @CB_MAP = ();
230
231	my %attachment;
232
233	sub _attach_cb($\%$$$) {
234	my ($registry, $undo, $event, $prio, $cb) = @_;
235
236	use sort 'stable';
237
238	$cb = [$prio, $cb];
239
240	@{$registry->[$event]} = sort
241	{ $a->[0] cmp $b->[0] }
242	@{$registry->[$event] || []}, $cb;
243
244	push @{$undo->{cb}}, [$event, $cb];
245	}
246
247	# attach handles attaching event callbacks
248	# the only thing the caller has to do is pass the correct
249	# registry (== where the callback attaches to).
250	sub _attach(\@$@) {
251	my ($registry, $klass, @arg) = @_;
252
253	my $prio = 0;
254
255	my %undo = (
256	registry => $registry,
257	cb => [],
258	);
259
260	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
261
262	while (@arg) {
263	my $type = shift @arg;
264
265	if ($type eq "prio") {
266	$prio = shift @arg;
267
268	} elsif ($type eq "package") {
269	my $pkg = shift @arg;
270
271	while (my ($name, $id) = each %cb_id) {
272	if (my $cb = $pkg->can ($name)) {
273	_attach_cb $registry, %undo, $id, $prio, $cb;
274	}
275	}	359	}
276
277	} elsif (exists $cb_id{$type}) {
278	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
279
280	} elsif (ref $type) {
281	warn "attaching objects not supported, ignoring.\n";
282
283	} else {
284	shift @arg;
285	warn "attach argument '$type' not supported, ignoring.\n";
286	}
287	}
288
289	\%undo
290	}
291
292	sub _attach_attachment {
293	my ($obj, $name, %arg) = @_;
294
295	return if exists $obj->{_attachment}{$name};
296
297	my $res;
298
299	if (my $attach = $attachment{$name}) {
300	my $registry = $obj->registry;
301
302	for (@$attach) {
303	my ($klass, @attach) = @$_;
304	$res = _attach @$registry, $klass, @attach;
305	}
306
307	$obj->{$name} = \%arg;
308	} else {
309	warn "object uses attachment '$name' that is not available, postponing.\n";
310	}
311
312	$obj->{_attachment}{$name} = undef;
313
314	$res->{attachment} = $name;
315	$res
316	}
317
318	*cf::object::attach =
319	*cf::player::attach =
320	*cf::map::attach = sub {
321	my ($obj, $name, %arg) = @_;
322
323	_attach_attachment $obj, $name, %arg;
324	};
325
326	# all those should be optimised
327	*cf::object::detach =
328	*cf::player::detach =
329	*cf::map::detach = sub {
330	my ($obj, $name) = @_;
331
332	delete $obj->{_attachment}{$name};
333	reattach ($obj);
334	};
335
336	*cf::object::attached =
337	*cf::player::attached =
338	*cf::map::attached = sub {
339	my ($obj, $name) = @_;
340
341	exists $obj->{_attachment}{$name}
342	};
343
344	sub attach_global {
345	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
346	}
347
348	sub attach_to_type {
349	my $type = shift;
350	my $subtype = shift;
351
352	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
353	}
354
355	sub attach_to_objects {
356	_attach @CB_OBJECT, KLASS_OBJECT, @_
357	}
358
359	sub attach_to_players {
360	_attach @CB_PLAYER, KLASS_PLAYER, @_
361	}
362
363	sub attach_to_maps {
364	_attach @CB_MAP, KLASS_MAP, @_
365	}
366
367	sub register_attachment {
368	my $name = shift;
369
370	$attachment{$name} = [[KLASS_OBJECT, @_]];
371	}
372
373	sub register_player_attachment {
374	my $name = shift;
375
376	$attachment{$name} = [[KLASS_PLAYER, @_]];
377	}
378
379	sub register_map_attachment {
380	my $name = shift;
381
382	$attachment{$name} = [[KLASS_MAP, @_]];
383	}
384
385	our $override;
386	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
387
388	sub override {
389	$override = 1;
390	@invoke_results = ();
391	}
392
393	sub do_invoke {
394	my $event = shift;
395	my $callbacks = shift;
396
397	@invoke_results = ();
398
399	local $override;
400
401	for (@$callbacks) {
402	eval { &{$_->[1]} };
403
404	if ($@) {
405	warn "$@";
406	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
407	override;
408	}
409
410	return 1 if $override;
411	}
412
413	0	360	}
414	}
415		361
416	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	362	=item $attachable->valid
417
418	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
419
420	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
421
422	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
423
424	Generate a global/object/player/map-specific event with the given arguments.
425
426	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
427	removed in future versions), and there is no public API to access override
428	results (if you must, access C<@cf::invoke_results> directly).
429
430	=back
431
432	=cut
433
434	#############################################################################
435
436	=head2 METHODS VALID FOR ALL CORE OBJECTS
437
438	=over 4
439
440	=item $object->valid, $player->valid, $map->valid
441		363
442	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
443	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
444	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
445	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
446	exception.	368	exception.
447		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
448	=back	553	=back
449		554
450	=cut	555	=cut
451
452	*cf::object::valid =
453	*cf::player::valid =
454	*cf::map::valid = \&cf::_valid;
455		556
456	#############################################################################	557	#############################################################################
457	# object support	558	# object support
458		559
459	sub instantiate {
460	my ($obj, $data) = @_;
461
462	$data = from_json $data;
463
464	for (@$data) {
465	my ($name, $args) = @$_;
466
467	$obj->attach ($name, %{$args || {} });
468	}
469	}
470
471	# basically do the same as instantiate, without calling instantiate
472	sub reattach {	560	sub reattach {
		561	# basically do the same as instantiate, without calling instantiate
473	my ($obj) = @_;	562	my ($obj) = @_;
		563
474	my $registry = $obj->registry;	564	my $registry = $obj->registry;
475		565
476	@$registry = ();	566	@$registry = ();
477		567
478	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	568	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
479		569
480	for my $name (keys %{ $obj->{_attachment} || {} }) {	570	for my $name (keys %{ $obj->{_attachment} || {} }) {
481	if (my $attach = $attachment{$name}) {	571	if (my $attach = $attachment{$name}) {
482	for (@$attach) {	572	for (@$attach) {
483	my ($klass, @attach) = @$_;	573	my ($klass, @attach) = @$_;
484	_attach @$registry, $klass, @attach;	574	_attach $registry, $klass, @attach;
485	}	575	}
486	} else {	576	} else {
487	warn "object uses attachment '$name' that is not available, postponing.\n";	577	warn "object uses attachment '$name' that is not available, postponing.\n";
488	}	578	}
489	}	579	}
490	}	580	}
491		581
492	sub object_freezer_save {	582	cf::attachable->attach (
493	my ($filename, $rdata, $objs) = @_;
494
495	if (length $$rdata) {
496	warn sprintf "saving %s (%d,%d)\n",
497	$filename, length $$rdata, scalar @$objs;
498
499	if (open my $fh, ">:raw", "$filename~") {
500	chmod SAVE_MODE, $fh;
501	syswrite $fh, $$rdata;
502	close $fh;
503
504	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
505	chmod SAVE_MODE, $fh;
506	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
507	close $fh;
508	rename "$filename.pst~", "$filename.pst";
509	} else {
510	unlink "$filename.pst";
511	}
512
513	rename "$filename~", $filename;
514	} else {
515	warn "FATAL: $filename~: $!\n";
516	}
517	} else {
518	unlink $filename;
519	unlink "$filename.pst";
520	}
521	}
522
523	sub object_thawer_load {
524	my ($filename) = @_;
525
526	local $/;
527
528	my $av;
529
530	#TODO: use sysread etc.
531	if (open my $data, "<:raw:perlio", $filename) {
532	$data = <$data>;
533	if (open my $pst, "<:raw:perlio", "$filename.pst") {
534	$av = eval { (Storable::thaw <$pst>)->{objs} };
535	}
536	return ($data, $av);
537	}
538
539	()
540	}
541
542	attach_to_objects
543	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,
544	on_clone => sub {	596	on_clone => sub {
545	my ($src, $dst) = @_;	597	my ($src, $dst) = @_;
546		598
547	@{$dst->registry} = @{$src->registry};	599	@{$dst->registry} = @{$src->registry};
548		600
549	%$dst = %$src;	601	%$dst = %$src;
550		602
551	%{$dst->{_attachment}} = %{$src->{_attachment}}	603	%{$dst->{_attachment}} = %{$src->{_attachment}}
552	if exists $src->{_attachment};	604	if exists $src->{_attachment};
553	},	605	},
554	;	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	}
555		670
556	#############################################################################	671	#############################################################################
557	# old plug-in events	672	# command handling &c
558		673
559	sub inject_event {	674	=item cf::register_command $name => \&callback($ob,$args);
560	my $extension = shift;
561	my $event_code = shift;
562		675
563	my $cb = $hook[$event_code]{$extension}	676	Register a callback for execution when the client sends the user command
564	or return;	677	$name.
565		678
566	&$cb	679	=cut
567	}
568
569	sub inject_global_event {
570	my $event = shift;
571
572	my $cb = $hook[$event]
573	or return;
574
575	List::Util::max map &$_, values %$cb
576	}
577
578	sub inject_command {
579	my ($name, $obj, $params) = @_;
580
581	for my $cmd (@{ $command{$name} }) {
582	$cmd->[1]->($obj, $params);
583	}
584
585	-1
586	}
587		680
588	sub register_command {	681	sub register_command {
589	my ($name, $time, $cb) = @_;	682	my ($name, $cb) = @_;
590		683
591	my $caller = caller;	684	my $caller = caller;
592	#warn "registering command '$name/$time' to '$caller'";	685	#warn "registering command '$name/$time' to '$caller'";
593		686
594	push @{ $command{$name} }, [$time, $cb, $caller];	687	push @{ $COMMAND{$name} }, [$caller, $cb];
595	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
596	}	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
597		698
598	sub register_extcmd {	699	sub register_extcmd {
599	my ($name, $cb) = @_;	700	my ($name, $cb) = @_;
600		701
601	my $caller = caller;	702	my $caller = caller;
602	#warn "registering extcmd '$name' to '$caller'";	703	#warn "registering extcmd '$name' to '$caller'";
603		704
604	$extcmd{$name} = [$cb, $caller];	705	$EXTCMD{$name} = [$cb, $caller];
605	}	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	);
606		739
607	sub register {	740	sub register {
608	my ($base, $pkg) = @_;	741	my ($base, $pkg) = @_;
609		742
610	#TODO	743	#TODO
…		…
629	. "#line 1 \"$path\"\n{\n"	762	. "#line 1 \"$path\"\n{\n"
630	. (do { local $/; <$fh> })	763	. (do { local $/; <$fh> })
631	. "\n};\n1";	764	. "\n};\n1";
632		765
633	eval $source	766	eval $source
634	or die "$path: $@";	767	or die $@ ? "$path: $@\n"
		768	: "extension disabled.\n";
635		769
636	push @exts, $pkg;	770	push @exts, $pkg;
637	$ext_pkg{$base} = $pkg;	771	$ext_pkg{$base} = $pkg;
638		772
639	# no strict 'refs';	773	# no strict 'refs';
…		…
652	# for my $idx (0 .. $#PLUGIN_EVENT) {	786	# for my $idx (0 .. $#PLUGIN_EVENT) {
653	# delete $hook[$idx]{$pkg};	787	# delete $hook[$idx]{$pkg};
654	# }	788	# }
655		789
656	# remove commands	790	# remove commands
657	for my $name (keys %command) {	791	for my $name (keys %COMMAND) {
658	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	792	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
659		793
660	if (@cb) {	794	if (@cb) {
661	$command{$name} = \@cb;	795	$COMMAND{$name} = \@cb;
662	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
663	} else {	796	} else {
664	delete $command{$name};
665	delete $COMMAND{"$name\000"};	797	delete $COMMAND{$name};
666	}	798	}
667	}	799	}
668		800
669	# remove extcmds	801	# remove extcmds
670	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	802	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
671	delete $extcmd{$name};	803	delete $EXTCMD{$name};
672	}	804	}
673		805
674	if (my $cb = $pkg->can ("unload")) {	806	if (my $cb = $pkg->can ("unload")) {
675	eval {	807	eval {
676	$cb->($pkg);	808	$cb->($pkg);
…		…
680		812
681	Symbol::delete_package $pkg;	813	Symbol::delete_package $pkg;
682	}	814	}
683		815
684	sub load_extensions {	816	sub load_extensions {
685	my $LIBDIR = maps_directory "perl";
686
687	for my $ext (<$LIBDIR/*.ext>) {	817	for my $ext (<$LIBDIR/*.ext>) {
688	next unless -r $ext;	818	next unless -r $ext;
689	eval {	819	eval {
690	load_extension $ext;	820	load_extension $ext;
691	1	821	1
692	} or warn "$ext not loaded: $@";	822	} or warn "$ext not loaded: $@";
693	}	823	}
694	}	824	}
695		825
696	#############################################################################	826	#############################################################################
697	# extcmd framework, basically convert ext <msg>
698	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
699
700	attach_to_players
701	on_extcmd => sub {
702	my ($pl, $buf) = @_;
703
704	my $msg = eval { from_json $buf };
705
706	if (ref $msg) {
707	if (my $cb = $extcmd{$msg->{msgtype}}) {
708	if (my %reply = $cb->[0]->($pl, $msg)) {
709	$pl->ext_reply ($msg->{msgid}, %reply);
710	}
711	}
712	} else {
713	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
714	}
715
716	cf::override;
717	},
718	;
719
720	#############################################################################
721	# load/save/clean perl data associated with a map	827	# load/save/clean perl data associated with a map
722		828
723	*cf::mapsupport::on_clean = sub {	829	*cf::mapsupport::on_clean = sub {
724	my ($map) = @_;	830	my ($map) = @_;
725		831
…		…
727	defined $path or return;	833	defined $path or return;
728		834
729	unlink "$path.pst";	835	unlink "$path.pst";
730	};	836	};
731		837
732	attach_to_maps prio => -10000, package => cf::mapsupport::;	838	cf::map->attach (prio => -10000, package => cf::mapsupport::);
733		839
734	#############################################################################	840	#############################################################################
735	# load/save perl data associated with player->ob objects	841	# load/save perl data associated with player->ob objects
736		842
737	sub all_objects(@) {	843	sub all_objects(@) {
738	@_, map all_objects ($_->inv), @_	844	@_, map all_objects ($_->inv), @_
739	}	845	}
740		846
741	# TODO: compatibility cruft, remove when no longer needed	847	# TODO: compatibility cruft, remove when no longer needed
742	attach_to_players	848	cf::player->attach (
743	on_load => sub {	849	on_load => sub {
744	my ($pl, $path) = @_;	850	my ($pl, $path) = @_;
745		851
746	for my $o (all_objects $pl->ob) {	852	for my $o (all_objects $pl->ob) {
747	if (my $value = $o->get_ob_key_value ("_perl_data")) {	853	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
749		855
750	%$o = %{ Storable::thaw pack "H*", $value };	856	%$o = %{ Storable::thaw pack "H*", $value };
751	}	857	}
752	}	858	}
753	},	859	},
754	;	860	);
755		861
756	#############################################################################	862	#############################################################################
757		863
758	=head2 CORE EXTENSIONS	864	=head2 CORE EXTENSIONS
759		865
760	Functions and methods that extend core crossfire objects.	866	Functions and methods that extend core crossfire objects.
		867
		868	=head3 cf::player
761		869
762	=over 4	870	=over 4
763		871
764	=item cf::player::exists $login	872	=item cf::player::exists $login
765		873
…		…
770	sub cf::player::exists($) {	878	sub cf::player::exists($) {
771	cf::player::find $_[0]	879	cf::player::find $_[0]
772	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;
773	}	881	}
774		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
775	=item $object->reply ($npc, $msg[, $flags])	903	=item $player_object->reply ($npc, $msg[, $flags])
776		904
777	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>
778	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
779	dialogue with the given NPC character.	907	dialogue with the given NPC character.
780		908
781	=cut	909	=cut
782		910
783	# rough implementation of a future "reply" method that works	911	# rough implementation of a future "reply" method that works
784	# with dialog boxes.	912	# with dialog boxes.
		913	#TODO: the first argument must go, split into a $npc->reply_to ( method
785	sub cf::object::player::reply($$$;$) {	914	sub cf::object::player::reply($$$;$) {
786	my ($self, $npc, $msg, $flags) = @_;	915	my ($self, $npc, $msg, $flags) = @_;
787		916
788	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	917	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
789		918
…		…
793	$msg = $npc->name . " says: $msg" if $npc;	922	$msg = $npc->name . " says: $msg" if $npc;
794	$self->message ($msg, $flags);	923	$self->message ($msg, $flags);
795	}	924	}
796	}	925	}
797		926
798	=item $player->ext_reply ($msgid, $msgtype, %msg)	927	=item $player_object->may ("access")
799		928
800	Sends an ext reply to the player.	929	Returns wether the given player is authorized to access resource "access"
		930	(e.g. "command_wizcast").
801		931
802	=cut	932	=cut
803		933
804	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 {
805	my ($self, $id, %msg) = @_;	1020	my ($self, $cb) = @_;
806		1021
807	$msg{msgid} = $id;	1022	my $coro; $coro = async {
		1023	eval {
		1024	$cb->();
		1025	};
		1026	warn $@ if $@;
		1027	};
808		1028
809	$self->send ("ext " . to_json \%msg);	1029	$coro->on_destroy (sub {
		1030	delete $self->{_coro}{$coro+0};
		1031	});
		1032
		1033	$self->{_coro}{$coro+0} = $coro;
		1034
		1035	$coro
810	}	1036	}
		1037
		1038	cf::client->attach (
		1039	on_destroy => sub {
		1040	my ($ns) = @_;
		1041
		1042	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1043	},
		1044	);
811		1045
812	=back	1046	=back
813		1047
814	=cut
815
816	#############################################################################
817		1048
818	=head2 SAFE SCRIPTING	1049	=head2 SAFE SCRIPTING
819		1050
820	Functions that provide a safe environment to compile and execute	1051	Functions that provide a safe environment to compile and execute
821	snippets of perl code without them endangering the safety of the server	1052	snippets of perl code without them endangering the safety of the server
822	itself. Looping constructs, I/O operators and other built-in functionality	1053	itself. Looping constructs, I/O operators and other built-in functionality
823	is not available in the safe scripting environment, and the number of	1054	is not available in the safe scripting environment, and the number of
824	functions and methods that cna be called is greatly reduced.	1055	functions and methods that can be called is greatly reduced.
825		1056
826	=cut	1057	=cut
827		1058
828	our $safe = new Safe "safe";	1059	our $safe = new Safe "safe";
829	our $safe_hole = new Safe::Hole;	1060	our $safe_hole = new Safe::Hole;
…		…
836		1067
837	=pod	1068	=pod
838		1069
839	The following fucntions and emthods are available within a safe environment:	1070	The following fucntions and emthods are available within a safe environment:
840		1071
841	cf::object contr pay_amount pay_player	1072	cf::object contr pay_amount pay_player map
842	cf::object::player player	1073	cf::object::player player
843	cf::player peaceful	1074	cf::player peaceful
		1075	cf::map trigger
844		1076
845	=cut	1077	=cut
846		1078
847	for (	1079	for (
848	["cf::object" => qw(contr pay_amount pay_player)],	1080	["cf::object" => qw(contr pay_amount pay_player map)],
849	["cf::object::player" => qw(player)],	1081	["cf::object::player" => qw(player)],
850	["cf::player" => qw(peaceful)],	1082	["cf::player" => qw(peaceful)],
		1083	["cf::map" => qw(trigger)],
851	) {	1084	) {
852	no strict 'refs';	1085	no strict 'refs';
853	my ($pkg, @funs) = @$_;	1086	my ($pkg, @funs) = @$_;
854	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1087	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
855	for @funs;	1088	for @funs;
…		…
965		1198
966	Immediately write the database to disk I<if it is dirty>.	1199	Immediately write the database to disk I<if it is dirty>.
967		1200
968	=cut	1201	=cut
969		1202
		1203	our $DB;
		1204
970	{	1205	{
971	my $db;
972	my $path = cf::localdir . "/database.pst";	1206	my $path = cf::localdir . "/database.pst";
973		1207
974	sub db_load() {	1208	sub db_load() {
975	warn "loading database $path\n";#d# remove later	1209	warn "loading database $path\n";#d# remove later
976	$db = stat $path ? Storable::retrieve $path : { };	1210	$DB = stat $path ? Storable::retrieve $path : { };
977	}	1211	}
978		1212
979	my $pid;	1213	my $pid;
980		1214
981	sub db_save() {	1215	sub db_save() {
982	warn "saving database $path\n";#d# remove later	1216	warn "saving database $path\n";#d# remove later
983	waitpid $pid, 0 if $pid;	1217	waitpid $pid, 0 if $pid;
984	if (0 == ($pid = fork)) {	1218	if (0 == ($pid = fork)) {
985	$db->{_meta}{version} = 1;	1219	$DB->{_meta}{version} = 1;
986	Storable::nstore $db, "$path~";	1220	Storable::nstore $DB, "$path~";
987	rename "$path~", $path;	1221	rename "$path~", $path;
988	cf::_exit 0 if defined $pid;	1222	cf::_exit 0 if defined $pid;
989	}	1223	}
990	}	1224	}
991		1225
…		…
994	sub db_sync() {	1228	sub db_sync() {
995	db_save if $dirty;	1229	db_save if $dirty;
996	undef $dirty;	1230	undef $dirty;
997	}	1231	}
998		1232
999	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 {
1000	db_sync;	1234	db_sync;
1001	});	1235	});
1002		1236
1003	sub db_dirty() {	1237	sub db_dirty() {
1004	$dirty = 1;	1238	$dirty = 1;
1005	$idle->start;	1239	$idle->start;
1006	}	1240	}
1007		1241
1008	sub db_get($;$) {	1242	sub db_get($;$) {
1009	@_ >= 2	1243	@_ >= 2
1010	? $db->{$_[0]}{$_[1]}	1244	? $DB->{$_[0]}{$_[1]}
1011	: ($db->{$_[0]} ||= { })	1245	: ($DB->{$_[0]} ||= { })
1012	}	1246	}
1013		1247
1014	sub db_put($$;$) {	1248	sub db_put($$;$) {
1015	if (@_ >= 3) {	1249	if (@_ >= 3) {
1016	$db->{$_[0]}{$_[1]} = $_[2];	1250	$DB->{$_[0]}{$_[1]} = $_[2];
1017	} else {	1251	} else {
1018	$db->{$_[0]} = $_[1];	1252	$DB->{$_[0]} = $_[1];
1019	}	1253	}
1020	db_dirty;	1254	db_dirty;
1021	}	1255	}
1022		1256
1023	attach_global	1257	cf::global->attach (
1024	prio => 10000,	1258	prio => 10000,
1025	on_cleanup => sub {	1259	on_cleanup => sub {
1026	db_sync;	1260	db_sync;
1027	},	1261	},
1028	;	1262	);
1029	}	1263	}
1030		1264
1031	#############################################################################	1265	#############################################################################
1032	# the server's main()	1266	# the server's main()
1033		1267
…		…
1047	}	1281	}
1048		1282
1049	#############################################################################	1283	#############################################################################
1050	# initialisation	1284	# initialisation
1051		1285
1052	sub _perl_reload(&) {	1286	sub perl_reload() {
1053	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	}
1054		1292
1055	$msg->("reloading...");	1293	warn "reloading...";
		1294
		1295	local $FREEZE = 1;
		1296	cf::emergency_save;
1056		1297
1057	eval {	1298	eval {
		1299	# if anything goes wrong in here, we should simply crash as we already saved
		1300
1058	# cancel all watchers	1301	# cancel all watchers
1059	$_->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 = ();
1060		1309
1061	# unload all extensions	1310	# unload all extensions
1062	for (@exts) {	1311	for (@exts) {
1063	$msg->("unloading <$_>");	1312	warn "unloading <$_>";
1064	unload_extension $_;	1313	unload_extension $_;
1065	}	1314	}
1066		1315
1067	# unload all modules loaded from $LIBDIR	1316	# unload all modules loaded from $LIBDIR
1068	while (my ($k, $v) = each %INC) {	1317	while (my ($k, $v) = each %INC) {
1069	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1318	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1070		1319
1071	$msg->("removing <$k>");	1320	warn "removing <$k>";
1072	delete $INC{$k};	1321	delete $INC{$k};
1073		1322
1074	$k =~ s/\.pm$//;	1323	$k =~ s/\.pm$//;
1075	$k =~ s/\//::/g;	1324	$k =~ s/\//::/g;
1076		1325
…		…
1081	Symbol::delete_package $k;	1330	Symbol::delete_package $k;
1082	}	1331	}
1083		1332
1084	# sync database to disk	1333	# sync database to disk
1085	cf::db_sync;	1334	cf::db_sync;
		1335	IO::AIO::flush;
1086		1336
1087	# get rid of safe::, as good as possible	1337	# get rid of safe::, as good as possible
1088	Symbol::delete_package "safe::$_"	1338	Symbol::delete_package "safe::$_"
1089	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);
1090		1340
1091	# remove register_script_function callbacks	1341	# remove register_script_function callbacks
1092	# TODO	1342	# TODO
1093		1343
1094	# unload cf.pm "a bit"	1344	# unload cf.pm "a bit"
…		…
1097	# don't, removes xs symbols, too,	1347	# don't, removes xs symbols, too,
1098	# and global variables created in xs	1348	# and global variables created in xs
1099	#Symbol::delete_package __PACKAGE__;	1349	#Symbol::delete_package __PACKAGE__;
1100		1350
1101	# reload cf.pm	1351	# reload cf.pm
1102	$msg->("reloading cf.pm");	1352	warn "reloading cf.pm";
1103	require cf;	1353	require cf;
		1354	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1104		1355
1105	# load config and database again	1356	# load config and database again
1106	cf::cfg_load;	1357	cf::cfg_load;
1107	cf::db_load;	1358	cf::db_load;
1108		1359
1109	# load extensions	1360	# load extensions
1110	$msg->("load extensions");	1361	warn "load extensions";
1111	cf::load_extensions;	1362	cf::load_extensions;
1112		1363
1113	# reattach attachments to objects	1364	# reattach attachments to objects
1114	$msg->("reattach");	1365	warn "reattach";
1115	_global_reattach;	1366	_global_reattach;
1116	};	1367	};
1117	$msg->($@) if $@;
1118		1368
1119	$msg->("reloaded");	1369	if ($@) {
		1370	warn $@;
		1371	warn "error while reloading, exiting.";
		1372	exit 1;
		1373	}
		1374
		1375	warn "reloaded successfully";
1120	};	1376	};
1121		1377
1122	sub perl_reload() {	1378	register "<global>", __PACKAGE__;
1123	_perl_reload {
1124	warn $_[0];
1125	print "$_[0]\n";
1126	};
1127	}
1128		1379
1129	register_command "perl-reload", 0, sub {	1380	register_command "perl-reload" => sub {
1130	my ($who, $arg) = @_;	1381	my ($who, $arg) = @_;
1131		1382
1132	if ($who->flag (FLAG_WIZ)) {	1383	if ($who->flag (FLAG_WIZ)) {
		1384	$who->message ("start of reload.");
1133	_perl_reload {	1385	perl_reload;
1134	warn $_[0];	1386	$who->message ("end of reload.");
1135	$who->message ($_[0]);
1136	};
1137	}	1387	}
1138	};	1388	};
1139		1389
1140	register "<global>", __PACKAGE__;
1141
1142	unshift @INC, $LIBDIR;	1390	unshift @INC, $LIBDIR;
1143		1391
1144	$TICK_WATCHER = Event->timer (	1392	$TICK_WATCHER = Event->timer (
		1393	reentrant => 0,
1145	prio => 1,	1394	prio => 0,
1146	at => $NEXT_TICK || 1,	1395	at => $NEXT_TICK || $TICK,
		1396	data => WF_AUTOCANCEL,
1147	cb => sub {	1397	cb => sub {
		1398	unless ($FREEZE) {
1148	cf::server_tick; # one server iteration	1399	cf::server_tick; # one server iteration
		1400	$RUNTIME += $TICK;
		1401	}
1149		1402
1150	my $NOW = Event::time;
1151	$NEXT_TICK += $TICK;	1403	$NEXT_TICK += $TICK;
1152		1404
1153	# if we are delayed by four ticks, skip them all	1405	# if we are delayed by four ticks or more, skip them all
1154	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1406	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1155		1407
1156	$TICK_WATCHER->at ($NEXT_TICK);	1408	$TICK_WATCHER->at ($NEXT_TICK);
1157	$TICK_WATCHER->start;	1409	$TICK_WATCHER->start;
1158	},	1410	},
1159	);	1411	);
1160		1412
		1413	IO::AIO::max_poll_time $TICK * 0.2;
		1414
		1415	Event->io (fd => IO::AIO::poll_fileno,
		1416	poll => 'r',
		1417	prio => 5,
		1418	data => WF_AUTOCANCEL,
		1419	cb => \&IO::AIO::poll_cb);
		1420
		1421	# we must not ever block the main coroutine
		1422	$Coro::idle = sub {
		1423	#Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1424	warn "FATAL: Coro::idle was called, major BUG\n";
		1425	(Coro::unblock_sub {
		1426	Event::one_event;
		1427	})->();
		1428	};
		1429
1161	1	1430	1
1162		1431

Diff Legend

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