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.94 by root, Thu Dec 21 23:02:54 2006 UTC vs.
Revision 1.220 by root, Sat Feb 17 23:54:35 2007 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.5 ();
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use BDB ();
		21	use Data::Dumper;
		22	use Digest::MD5;
		23	use Fcntl;
10	use IO::AIO ();	24	use IO::AIO 2.32 ();
11	use YAML::Syck ();	25	use YAML::Syck ();
12	use Time::HiRes;	26	use Time::HiRes;
13	use Event;	27	use Compress::LZF;
		28
		29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		30
14	$Event::Eval = 1; # no idea why this is required, but it is	31	use Event; $Event::Eval = 1; # no idea why this is required, but it is
		32
		33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15		34
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	36	$YAML::Syck::ImplicitUnicode = 1;
18		37
19	use strict;	38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		39
23	our %COMMAND = ();	40	our %COMMAND = ();
24	our %COMMAND_TIME = ();	41	our %COMMAND_TIME = ();
		42
		43	our @EXTS = (); # list of extension package names
25	our %EXTCMD = ();	44	our %EXTCMD = ();
26		45	our %EXT_CORO = (); # coroutines bound to extensions
27	_init_vars;	46	our %EXT_MAP = (); # pluggable maps
28		47
29	our @EVENT;	48	our @EVENT;
30	our $LIBDIR = datadir . "/ext";	49	our $LIBDIR = datadir . "/ext";
31		50
32	our $TICK = MAX_TIME * 1e-6;	51	our $TICK = MAX_TIME * 1e-6;
33	our $TICK_WATCHER;	52	our $TICK_WATCHER;
		53	our $AIO_POLL_WATCHER;
		54	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
34	our $NEXT_TICK;	55	our $NEXT_TICK;
		56	our $NOW;
		57	our $USE_FSYNC = 1; # use fsync to write maps - default off
		58
		59	our $BDB_POLL_WATCHER;
		60	our $DB_ENV;
35		61
36	our %CFG;	62	our %CFG;
37		63
38	our $UPTIME; $UPTIME ||= time;	64	our $UPTIME; $UPTIME ||= time;
		65	our $RUNTIME;
		66
		67	our %PLAYER; # all users
		68	our %MAP; # all maps
		69	our $LINK_MAP; # the special {link} map, which is always available
		70	our $RANDOM_MAPS = cf::localdir . "/random";
		71	our $BDB_ENV_DIR = cf::localdir . "/db";
		72
		73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		75
		76	# used to convert map paths into valid unix filenames by replacing / by ∕
		77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		78
		79	binmode STDOUT;
		80	binmode STDERR;
		81
		82	# read virtual server time, if available
		83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		84	open my $fh, "<", cf::localdir . "/runtime"
		85	or die "unable to read runtime file: $!";
		86	$RUNTIME = <$fh> + 0.;
		87	}
		88
		89	mkdir cf::localdir;
		90	mkdir cf::localdir . "/" . cf::playerdir;
		91	mkdir cf::localdir . "/" . cf::tmpdir;
		92	mkdir cf::localdir . "/" . cf::uniquedir;
		93	mkdir $RANDOM_MAPS;
		94	mkdir $BDB_ENV_DIR;
		95
		96	our $EMERGENCY_POSITION;
		97
		98	sub cf::map::normalise;
39		99
40	#############################################################################	100	#############################################################################
41		101
42	=head2 GLOBAL VARIABLES	102	=head2 GLOBAL VARIABLES
43		103
44	=over 4	104	=over 4
45		105
46	=item $cf::UPTIME	106	=item $cf::UPTIME
47		107
48	The timestamp of the server start (so not actually an uptime).	108	The timestamp of the server start (so not actually an uptime).
		109
		110	=item $cf::RUNTIME
		111
		112	The time this server has run, starts at 0 and is increased by $cf::TICK on
		113	every server tick.
49		114
50	=item $cf::LIBDIR	115	=item $cf::LIBDIR
51		116
52	The perl library directory, where extensions and cf-specific modules can	117	The perl library directory, where extensions and cf-specific modules can
53	be found. It will be added to C<@INC> automatically.	118	be found. It will be added to C<@INC> automatically.
54		119
		120	=item $cf::NOW
		121
		122	The time of the last (current) server tick.
		123
55	=item $cf::TICK	124	=item $cf::TICK
56		125
57	The interval between server ticks, in seconds.	126	The interval between server ticks, in seconds.
58		127
59	=item %cf::CFG	128	=item %cf::CFG
60		129
61	Configuration for the server, loaded from C</etc/crossfire/config>, or	130	Configuration for the server, loaded from C</etc/crossfire/config>, or
62	from wherever your confdir points to.	131	from wherever your confdir points to.
		132
		133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		134
		135	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		136	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		137	processing has been done. Call C<< ->wait >> on them to maximise the
		138	window of cpu time available, or simply to synchronise to the server tick.
63		139
64	=back	140	=back
65		141
66	=cut	142	=cut
67		143
68	BEGIN {	144	BEGIN {
69	*CORE::GLOBAL::warn = sub {	145	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	146	my $msg = join "", @_;
		147	utf8::encode $msg;
		148
71	$msg .= "\n"	149	$msg .= "\n"
72	unless $msg =~ /\n$/;	150	unless $msg =~ /\n$/;
73		151
74	print STDERR "cfperl: $msg";
75	LOG llevError, "cfperl: $msg";	152	LOG llevError, $msg;
76	};	153	};
77	}	154	}
78		155
79	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
84	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	161	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
85		162
86	# we bless all objects into (empty) derived classes to force a method lookup	163	# we bless all objects into (empty) derived classes to force a method lookup
87	# within the Safe compartment.	164	# within the Safe compartment.
88	for my $pkg (qw(	165	for my $pkg (qw(
89	cf::global	166	cf::global cf::attachable
90	cf::object cf::object::player	167	cf::object cf::object::player
91	cf::client cf::player	168	cf::client cf::player
92	cf::arch cf::living	169	cf::arch cf::living
93	cf::map cf::party cf::region	170	cf::map cf::party cf::region
94	)) {	171	)) {
…		…
98		175
99	$Event::DIED = sub {	176	$Event::DIED = sub {
100	warn "error in event callback: @_";	177	warn "error in event callback: @_";
101	};	178	};
102		179
103	my %ext_pkg;
104	my @exts;
105	my @hook;
106
107	=head2 UTILITY FUNCTIONS	180	=head2 UTILITY FUNCTIONS
108		181
109	=over 4	182	=over 4
110		183
		184	=item dumpval $ref
		185
111	=cut	186	=cut
		187
		188	sub dumpval {
		189	eval {
		190	local $SIG{__DIE__};
		191	my $d;
		192	if (1) {
		193	$d = new Data::Dumper([$_[0]], ["*var"]);
		194	$d->Terse(1);
		195	$d->Indent(2);
		196	$d->Quotekeys(0);
		197	$d->Useqq(1);
		198	#$d->Bless(...);
		199	$d->Seen($_[1]) if @_ > 1;
		200	$d = $d->Dump();
		201	}
		202	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		203	$d
		204	} || "[unable to dump $_[0]: '$@']";
		205	}
112		206
113	use JSON::Syck (); # TODO# replace by JSON::PC once working	207	use JSON::Syck (); # TODO# replace by JSON::PC once working
114		208
115	=item $ref = cf::from_json $json	209	=item $ref = cf::from_json $json
116		210
…		…
130	=cut	224	=cut
131		225
132	sub to_json($) {	226	sub to_json($) {
133	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
134	JSON::Syck::Dump $_[0]	228	JSON::Syck::Dump $_[0]
		229	}
		230
		231	=item cf::lock_wait $string
		232
		233	Wait until the given lock is available. See cf::lock_acquire.
		234
		235	=item my $lock = cf::lock_acquire $string
		236
		237	Wait until the given lock is available and then acquires it and returns
		238	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		239	for example when the coroutine gets canceled), the lock is automatically
		240	returned.
		241
		242	Lock names should begin with a unique identifier (for example, cf::map::find
		243	uses map_find and cf::map::load uses map_load).
		244
		245	=cut
		246
		247	our %LOCK;
		248
		249	sub lock_wait($) {
		250	my ($key) = @_;
		251
		252	# wait for lock, if any
		253	while ($LOCK{$key}) {
		254	push @{ $LOCK{$key} }, $Coro::current;
		255	Coro::schedule;
		256	}
		257	}
		258
		259	sub lock_acquire($) {
		260	my ($key) = @_;
		261
		262	# wait, to be sure we are not locked
		263	lock_wait $key;
		264
		265	$LOCK{$key} = [];
		266
		267	Coro::guard {
		268	# wake up all waiters, to be on the safe side
		269	$_->ready for @{ delete $LOCK{$key} };
		270	}
		271	}
		272
		273	sub freeze_mainloop {
		274	return unless $TICK_WATCHER->is_active;
		275
		276	my $guard = Coro::guard {
		277	$TICK_WATCHER->start;
		278	};
		279	$TICK_WATCHER->stop;
		280	$guard
		281	}
		282
		283	=item cf::async { BLOCK }
		284
		285	Currently the same as Coro::async_pool, meaning you cannot use
		286	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		287	thing you are allowed to do is call C<prio> on it.
		288
		289	=cut
		290
		291	BEGIN { *async = \&Coro::async_pool }
		292
		293	=item cf::sync_job { BLOCK }
		294
		295	The design of crossfire+ requires that the main coro ($Coro::main) is
		296	always able to handle events or runnable, as crossfire+ is only partly
		297	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		298
		299	If it must be done, put the blocking parts into C<sync_job>. This will run
		300	the given BLOCK in another coroutine while waiting for the result. The
		301	server will be frozen during this time, so the block should either finish
		302	fast or be very important.
		303
		304	=cut
		305
		306	sub sync_job(&) {
		307	my ($job) = @_;
		308
		309	if ($Coro::current == $Coro::main) {
		310	# this is the main coro, too bad, we have to block
		311	# till the operation succeeds, freezing the server :/
		312
		313	# TODO: use suspend/resume instead
		314	# (but this is cancel-safe)
		315	my $freeze_guard = freeze_mainloop;
		316
		317	my $busy = 1;
		318	my @res;
		319
		320	(async {
		321	@res = eval { $job->() };
		322	warn $@ if $@;
		323	undef $busy;
		324	})->prio (Coro::PRIO_MAX);
		325
		326	while ($busy) {
		327	Coro::cede or Event::one_event;
		328	}
		329
		330	wantarray ? @res : $res[0]
		331	} else {
		332	# we are in another coroutine, how wonderful, everything just works
		333
		334	$job->()
		335	}
		336	}
		337
		338	=item $coro = cf::async_ext { BLOCK }
		339
		340	Like async, but this coro is automatically being canceled when the
		341	extension calling this is being unloaded.
		342
		343	=cut
		344
		345	sub async_ext(&) {
		346	my $cb = shift;
		347
		348	my $coro = &Coro::async ($cb);
		349
		350	$coro->on_destroy (sub {
		351	delete $EXT_CORO{$coro+0};
		352	});
		353	$EXT_CORO{$coro+0} = $coro;
		354
		355	$coro
		356	}
		357
		358	sub write_runtime {
		359	my $guard = cf::lock_acquire "write_runtime";
		360
		361	my $runtime = cf::localdir . "/runtime";
		362
		363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		364	or return;
		365
		366	my $value = $cf::RUNTIME + 90 + 10;
		367	# 10 is the runtime save interval, for a monotonic clock
		368	# 60 allows for the watchdog to kill the server.
		369
		370	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		371	and return;
		372
		373	# always fsync - this file is important
		374	aio_fsync $fh
		375	and return;
		376
		377	close $fh
		378	or return;
		379
		380	aio_rename "$runtime~", $runtime
		381	and return;
		382
		383	1
135	}	384	}
136		385
137	=back	386	=back
138		387
139	=cut	388	=cut
…		…
249	my ($self, $victim) = @_;	498	my ($self, $victim) = @_;
250	...	499	...
251	}	500	}
252	}	501	}
253		502
		503	=item $attachable->valid
		504
		505	Just because you have a perl object does not mean that the corresponding
		506	C-level object still exists. If you try to access an object that has no
		507	valid C counterpart anymore you get an exception at runtime. This method
		508	can be used to test for existence of the C object part without causing an
		509	exception.
		510
254	=cut	511	=cut
255		512
256	# the following variables are defined in .xs and must not be re-created	513	# the following variables are defined in .xs and must not be re-created
257	our @CB_GLOBAL = (); # registry for all global events	514	our @CB_GLOBAL = (); # registry for all global events
		515	our @CB_ATTACHABLE = (); # registry for all attachables
258	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	516	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
259	our @CB_PLAYER = ();	517	our @CB_PLAYER = ();
260	our @CB_CLIENT = ();	518	our @CB_CLIENT = ();
261	our @CB_TYPE = (); # registry for type (cf-object class) based events	519	our @CB_TYPE = (); # registry for type (cf-object class) based events
262	our @CB_MAP = ();	520	our @CB_MAP = ();
263		521
264	my %attachment;	522	my %attachment;
		523
		524	sub cf::attachable::thawer_merge {
		525	# simply override everything except _meta
		526	local $_[0]{_meta};
		527	%{$_[0]} = %{$_[1]};
		528	}
265		529
266	sub _attach_cb($$$$) {	530	sub _attach_cb($$$$) {
267	my ($registry, $event, $prio, $cb) = @_;	531	my ($registry, $event, $prio, $cb) = @_;
268		532
269	use sort 'stable';	533	use sort 'stable';
…		…
272		536
273	@{$registry->[$event]} = sort	537	@{$registry->[$event]} = sort
274	{ $a->[0] cmp $b->[0] }	538	{ $a->[0] cmp $b->[0] }
275	@{$registry->[$event] || []}, $cb;	539	@{$registry->[$event] || []}, $cb;
276	}	540	}
		541
		542	# hack
		543	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
277		544
278	# attach handles attaching event callbacks	545	# attach handles attaching event callbacks
279	# the only thing the caller has to do is pass the correct	546	# the only thing the caller has to do is pass the correct
280	# registry (== where the callback attaches to).	547	# registry (== where the callback attaches to).
281	sub _attach {	548	sub _attach {
…		…
283		550
284	my $object_type;	551	my $object_type;
285	my $prio = 0;	552	my $prio = 0;
286	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	553	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
287		554
		555	#TODO: get rid of this hack
		556	if ($attachable_klass{$klass}) {
		557	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		558	}
		559
288	while (@arg) {	560	while (@arg) {
289	my $type = shift @arg;	561	my $type = shift @arg;
290		562
291	if ($type eq "prio") {	563	if ($type eq "prio") {
292	$prio = shift @arg;	564	$prio = shift @arg;
…		…
367	my ($obj, $name) = @_;	639	my ($obj, $name) = @_;
368		640
369	exists $obj->{_attachment}{$name}	641	exists $obj->{_attachment}{$name}
370	}	642	}
371		643
372	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {	644	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
373	eval "#line " . __LINE__ . " 'cf.pm'	645	eval "#line " . __LINE__ . " 'cf.pm'
374	sub cf::\L$klass\E::_attach_registry {	646	sub cf::\L$klass\E::_attach_registry {
375	(\\\@CB_$klass, KLASS_$klass)	647	(\\\@CB_$klass, KLASS_$klass)
376	}	648	}
377		649
…		…
413	}	685	}
414		686
415	0	687	0
416	}	688	}
417		689
418	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	690	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
419		691
420	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
421
422	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
423
424	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)	692	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
425		693
426	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428	Generate a global/object/player/map-specific event with the given arguments.	694	Generate an object-specific event with the given arguments.
429		695
430	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be	696	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
431	removed in future versions), and there is no public API to access override	697	removed in future versions), and there is no public API to access override
432	results (if you must, access C<@cf::invoke_results> directly).	698	results (if you must, access C<@cf::invoke_results> directly).
433		699
434	=back	700	=back
435		701
436	=cut	702	=cut
437		703
438	#############################################################################	704	#############################################################################
439
440	=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
441
442	Attachable objects includes objects, players, clients and maps.
443
444	=over 4
445
446	=item $object->valid
447
448	Just because you have a perl object does not mean that the corresponding
449	C-level object still exists. If you try to access an object that has no
450	valid C counterpart anymore you get an exception at runtime. This method
451	can be used to test for existence of the C object part without causing an
452	exception.
453
454	=back
455
456	=cut
457
458	#############################################################################
459	# object support	705	# object support
460		706
461	sub instantiate {
462	my ($obj, $data) = @_;
463
464	$data = from_json $data;
465
466	for (@$data) {
467	my ($name, $args) = @$_;
468
469	$obj->attach ($name, %{$args || {} });
470	}
471	}
472
473	# basically do the same as instantiate, without calling instantiate
474	sub reattach {	707	sub reattach {
		708	# basically do the same as instantiate, without calling instantiate
475	my ($obj) = @_;	709	my ($obj) = @_;
		710
		711	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		712
476	my $registry = $obj->registry;	713	my $registry = $obj->registry;
477		714
478	@$registry = ();	715	@$registry = ();
479		716
480	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	717	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
…		…
489	warn "object uses attachment '$name' that is not available, postponing.\n";	726	warn "object uses attachment '$name' that is not available, postponing.\n";
490	}	727	}
491	}	728	}
492	}	729	}
493		730
494	sub object_freezer_save {	731	cf::attachable->attach (
495	my ($filename, $rdata, $objs) = @_;
496
497	if (length $$rdata) {
498	warn sprintf "saving %s (%d,%d)\n",
499	$filename, length $$rdata, scalar @$objs;
500
501	if (open my $fh, ">:raw", "$filename~") {
502	chmod SAVE_MODE, $fh;
503	syswrite $fh, $$rdata;
504	close $fh;
505
506	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
507	chmod SAVE_MODE, $fh;
508	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
509	close $fh;
510	rename "$filename.pst~", "$filename.pst";
511	} else {
512	unlink "$filename.pst";
513	}
514
515	rename "$filename~", $filename;
516	} else {
517	warn "FATAL: $filename~: $!\n";
518	}
519	} else {
520	unlink $filename;
521	unlink "$filename.pst";
522	}
523	}
524
525	sub object_freezer_as_string {
526	my ($rdata, $objs) = @_;
527
528	use Data::Dumper;
529
530	$$rdata . Dumper $objs
531	}
532
533	sub object_thawer_load {
534	my ($filename) = @_;
535
536	local $/;
537
538	my $av;
539
540	#TODO: use sysread etc.
541	if (open my $data, "<:raw:perlio", $filename) {
542	$data = <$data>;
543	if (open my $pst, "<:raw:perlio", "$filename.pst") {
544	$av = eval { (Storable::thaw <$pst>)->{objs} };
545	}
546	return ($data, $av);
547	}
548
549	()
550	}
551
552	cf::object->attach (
553	prio => -1000000,	732	prio => -1000000,
		733	on_instantiate => sub {
		734	my ($obj, $data) = @_;
		735
		736	$data = from_json $data;
		737
		738	for (@$data) {
		739	my ($name, $args) = @$_;
		740
		741	$obj->attach ($name, %{$args || {} });
		742	}
		743	},
		744	on_reattach => \&reattach,
554	on_clone => sub {	745	on_clone => sub {
555	my ($src, $dst) = @_;	746	my ($src, $dst) = @_;
556		747
557	@{$dst->registry} = @{$src->registry};	748	@{$dst->registry} = @{$src->registry};
558		749
…		…
561	%{$dst->{_attachment}} = %{$src->{_attachment}}	752	%{$dst->{_attachment}} = %{$src->{_attachment}}
562	if exists $src->{_attachment};	753	if exists $src->{_attachment};
563	},	754	},
564	);	755	);
565		756
		757	sub object_freezer_save {
		758	my ($filename, $rdata, $objs) = @_;
		759
		760	sync_job {
		761	if (length $$rdata) {
		762	warn sprintf "saving %s (%d,%d)\n",
		763	$filename, length $$rdata, scalar @$objs;
		764
		765	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		766	chmod SAVE_MODE, $fh;
		767	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		768	aio_fsync $fh if $cf::USE_FSYNC;
		769	close $fh;
		770
		771	if (@$objs) {
		772	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		773	chmod SAVE_MODE, $fh;
		774	my $data = Storable::nfreeze { version => 1, objs => $objs };
		775	aio_write $fh, 0, (length $data), $data, 0;
		776	aio_fsync $fh if $cf::USE_FSYNC;
		777	close $fh;
		778	aio_rename "$filename.pst~", "$filename.pst";
		779	}
		780	} else {
		781	aio_unlink "$filename.pst";
		782	}
		783
		784	aio_rename "$filename~", $filename;
		785	} else {
		786	warn "FATAL: $filename~: $!\n";
		787	}
		788	} else {
		789	aio_unlink $filename;
		790	aio_unlink "$filename.pst";
		791	}
		792	}
		793	}
		794
		795	sub object_freezer_as_string {
		796	my ($rdata, $objs) = @_;
		797
		798	use Data::Dumper;
		799
		800	$$rdata . Dumper $objs
		801	}
		802
		803	sub object_thawer_load {
		804	my ($filename) = @_;
		805
		806	my ($data, $av);
		807
		808	(aio_load $filename, $data) >= 0
		809	or return;
		810
		811	unless (aio_stat "$filename.pst") {
		812	(aio_load "$filename.pst", $av) >= 0
		813	or return;
		814	$av = eval { (Storable::thaw $av)->{objs} };
		815	}
		816
		817	warn sprintf "loading %s (%d)\n",
		818	$filename, length $data, scalar @{$av || []};#d#
		819	return ($data, $av);
		820	}
		821
566	#############################################################################	822	#############################################################################
567	# command handling &c	823	# command handling &c
568		824
569	=item cf::register_command $name => \&callback($ob,$args);	825	=item cf::register_command $name => \&callback($ob,$args);
570		826
…		…
592	=cut	848	=cut
593		849
594	sub register_extcmd {	850	sub register_extcmd {
595	my ($name, $cb) = @_;	851	my ($name, $cb) = @_;
596		852
597	my $caller = caller;
598	#warn "registering extcmd '$name' to '$caller'";
599
600	$EXTCMD{$name} = [$cb, $caller];	853	$EXTCMD{$name} = $cb;
601	}	854	}
602		855
603	cf::player->attach (	856	cf::player->attach (
604	on_command => sub {	857	on_command => sub {
605	my ($pl, $name, $params) = @_;	858	my ($pl, $name, $params) = @_;
…		…
618		871
619	my $msg = eval { from_json $buf };	872	my $msg = eval { from_json $buf };
620		873
621	if (ref $msg) {	874	if (ref $msg) {
622	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	875	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
623	if (my %reply = $cb->[0]->($pl, $msg)) {	876	if (my %reply = $cb->($pl, $msg)) {
624	$pl->ext_reply ($msg->{msgid}, %reply);	877	$pl->ext_reply ($msg->{msgid}, %reply);
625	}	878	}
626	}	879	}
627	} else {	880	} else {
628	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	881	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
630		883
631	cf::override;	884	cf::override;
632	},	885	},
633	);	886	);
634		887
635	sub register {
636	my ($base, $pkg) = @_;
637
638	#TODO
639	}
640
641	sub load_extension {	888	sub load_extension {
642	my ($path) = @_;	889	my ($path) = @_;
643		890
644	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	891	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
645	my $base = $1;	892	my $base = $1;
646	my $pkg = $1;	893	my $pkg = $1;
647	$pkg =~ s/[^[:word:]]/_/g;	894	$pkg =~ s/[^[:word:]]/_/g;
648	$pkg = "ext::$pkg";	895	$pkg = "ext::$pkg";
649		896
650	warn "loading '$path' into '$pkg'\n";	897	warn "... loading '$path' into '$pkg'\n";
651		898
652	open my $fh, "<:utf8", $path	899	open my $fh, "<:utf8", $path
653	or die "$path: $!";	900	or die "$path: $!";
654		901
655	my $source =	902	my $source =
656	"package $pkg; use strict; use utf8;\n"	903	"package $pkg; use strict; use utf8;\n"
657	. "#line 1 \"$path\"\n{\n"	904	. "#line 1 \"$path\"\n{\n"
658	. (do { local $/; <$fh> })	905	. (do { local $/; <$fh> })
659	. "\n};\n1";	906	. "\n};\n1";
660		907
661	eval $source	908	unless (eval $source) {
662	or die $@ ? "$path: $@\n"	909	my $msg = $@ ? "$path: $@\n"
663	: "extension disabled.\n";	910	: "extension disabled.\n";
664		911	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
665	push @exts, $pkg;	912	warn $@;
666	$ext_pkg{$base} = $pkg;	913	warn "mandatory extension failed to load, exiting.\n";
667		914	exit 1;
668	# no strict 'refs';	915	}
669	# @{"$pkg\::ISA"} = ext::;	916	die $@;
670
671	register $base, $pkg;
672	}
673
674	sub unload_extension {
675	my ($pkg) = @_;
676
677	warn "removing extension $pkg\n";
678
679	# remove hooks
680	#TODO
681	# for my $idx (0 .. $#PLUGIN_EVENT) {
682	# delete $hook[$idx]{$pkg};
683	# }	917	}
684		918
685	# remove commands	919	push @EXTS, $pkg;
686	for my $name (keys %COMMAND) {
687	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
688
689	if (@cb) {
690	$COMMAND{$name} = \@cb;
691	} else {
692	delete $COMMAND{$name};
693	}
694	}
695
696	# remove extcmds
697	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
698	delete $EXTCMD{$name};
699	}
700
701	if (my $cb = $pkg->can ("unload")) {
702	eval {
703	$cb->($pkg);
704	1
705	} or warn "$pkg unloaded, but with errors: $@";
706	}
707
708	Symbol::delete_package $pkg;
709	}	920	}
710		921
711	sub load_extensions {	922	sub load_extensions {
712	for my $ext (<$LIBDIR/*.ext>) {	923	for my $ext (<$LIBDIR/*.ext>) {
713	next unless -r $ext;	924	next unless -r $ext;
…		…
717	} or warn "$ext not loaded: $@";	928	} or warn "$ext not loaded: $@";
718	}	929	}
719	}	930	}
720		931
721	#############################################################################	932	#############################################################################
722	# load/save/clean perl data associated with a map
723		933
724	*cf::mapsupport::on_clean = sub {	934	=head2 CORE EXTENSIONS
		935
		936	Functions and methods that extend core crossfire objects.
		937
		938	=cut
		939
		940	package cf::player;
		941
		942	use Coro::AIO;
		943
		944	=head3 cf::player
		945
		946	=over 4
		947
		948	=item cf::player::find $login
		949
		950	Returns the given player object, loading it if necessary (might block).
		951
		952	=cut
		953
		954	sub playerdir($) {
		955	cf::localdir
		956	. "/"
		957	. cf::playerdir
		958	. "/"
		959	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		960	}
		961
		962	sub path($) {
		963	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		964
		965	(playerdir $login) . "/$login.pl"
		966	}
		967
		968	sub find_active($) {
		969	$cf::PLAYER{$_[0]}
		970	and $cf::PLAYER{$_[0]}->active
		971	and $cf::PLAYER{$_[0]}
		972	}
		973
		974	sub exists($) {
		975	my ($login) = @_;
		976
		977	$cf::PLAYER{$login}
		978	or cf::sync_job { !aio_stat path $login }
		979	}
		980
		981	sub find($) {
		982	return $cf::PLAYER{$_[0]} || do {
		983	my $login = $_[0];
		984
		985	my $guard = cf::lock_acquire "user_find:$login";
		986
		987	$cf::PLAYER{$_[0]} || do {
		988	my $pl = load_pl path $login
		989	or return;
		990	$cf::PLAYER{$login} = $pl
		991	}
		992	}
		993	}
		994
		995	sub save($) {
		996	my ($pl) = @_;
		997
		998	return if $pl->{deny_save};
		999
		1000	my $path = path $pl;
		1001	my $guard = cf::lock_acquire "user_save:$path";
		1002
		1003	return if $pl->{deny_save};
		1004
		1005	aio_mkdir playerdir $pl, 0770;
		1006	$pl->{last_save} = $cf::RUNTIME;
		1007
		1008	$pl->save_pl ($path);
		1009	Coro::cede;
		1010	}
		1011
		1012	sub new($) {
		1013	my ($login) = @_;
		1014
		1015	my $self = create;
		1016
		1017	$self->ob->name ($login);
		1018	$self->{deny_save} = 1;
		1019
		1020	$cf::PLAYER{$login} = $self;
		1021
		1022	$self
		1023	}
		1024
		1025	=item $pl->quit_character
		1026
		1027	Nukes the player without looking back. If logged in, the connection will
		1028	be destroyed. May block for a long time.
		1029
		1030	=cut
		1031
		1032	sub quit_character {
		1033	my ($pl) = @_;
		1034
		1035	my $name = $pl->ob->name;
		1036
		1037	$pl->{deny_save} = 1;
		1038	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1039
		1040	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1041	$pl->deactivate;
		1042	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1043	$pl->ns->destroy if $pl->ns;
		1044
		1045	my $path = playerdir $pl;
		1046	my $temp = "$path~$cf::RUNTIME~deleting~";
		1047	aio_rename $path, $temp;
		1048	delete $cf::PLAYER{$pl->ob->name};
		1049	$pl->destroy;
		1050
		1051	my $prefix = qr<^~\Q$name\E/>;
		1052
		1053	# nuke player maps
		1054	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1055
		1056	IO::AIO::aio_rmtree $temp;
		1057	}
		1058
		1059	=item cf::player::list_logins
		1060
		1061	Returns am arrayref of all valid playernames in the system, can take a
		1062	while and may block, so not sync_job-capable, ever.
		1063
		1064	=cut
		1065
		1066	sub list_logins {
		1067	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1068	or return [];
		1069
		1070	my @logins;
		1071
		1072	for my $login (@$dirs) {
		1073	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1074	aio_read $fh, 0, 512, my $buf, 0 or next;
		1075	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1076
		1077	utf8::decode $login;
		1078	push @logins, $login;
		1079	}
		1080
		1081	\@logins
		1082	}
		1083
		1084	=item $player->maps
		1085
		1086	Returns an arrayref of map paths that are private for this
		1087	player. May block.
		1088
		1089	=cut
		1090
		1091	sub maps($) {
		1092	my ($pl) = @_;
		1093
		1094	$pl = ref $pl ? $pl->ob->name : $pl;
		1095
		1096	my $files = aio_readdir playerdir $pl
		1097	or return;
		1098
		1099	my @paths;
		1100
		1101	for (@$files) {
		1102	utf8::decode $_;
		1103	next if /\.(?:pl|pst)$/;
		1104	next unless /^$PATH_SEP/o;
		1105
		1106	push @paths, cf::map::normalise "~$pl/$_";
		1107	}
		1108
		1109	\@paths
		1110	}
		1111
		1112	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1113
		1114	Sends an ext reply to the player.
		1115
		1116	=cut
		1117
		1118	sub ext_reply($$$%) {
		1119	my ($self, $id, %msg) = @_;
		1120
		1121	$msg{msgid} = $id;
		1122
		1123	$self->send ("ext " . cf::to_json \%msg);
		1124	}
		1125
		1126	package cf;
		1127
		1128	=back
		1129
		1130
		1131	=head3 cf::map
		1132
		1133	=over 4
		1134
		1135	=cut
		1136
		1137	package cf::map;
		1138
		1139	use Fcntl;
		1140	use Coro::AIO;
		1141
		1142	use overload
		1143	'""' => \&as_string,
		1144	fallback => 1;
		1145
		1146	our $MAX_RESET = 3600;
		1147	our $DEFAULT_RESET = 3000;
		1148
		1149	sub generate_random_map {
		1150	my ($self, $rmp) = @_;
		1151	# mit "rum" bekleckern, nicht
		1152	$self->_create_random_map (
		1153	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1154	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1155	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1156	$rmp->{exit_on_final_map},
		1157	$rmp->{xsize}, $rmp->{ysize},
		1158	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1159	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1160	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1161	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1162	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1163	(cf::region::find $rmp->{region}), $rmp->{custom}
		1164	)
		1165	}
		1166
		1167	=item cf::map->register ($regex, $prio)
		1168
		1169	Register a handler for the map path matching the given regex at the
		1170	givne priority (higher is better, built-in handlers have priority 0, the
		1171	default).
		1172
		1173	=cut
		1174
		1175	sub register {
		1176	my (undef, $regex, $prio) = @_;
		1177	my $pkg = caller;
		1178
		1179	no strict;
		1180	push @{"$pkg\::ISA"}, __PACKAGE__;
		1181
		1182	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1183	}
		1184
		1185	# also paths starting with '/'
		1186	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1187
		1188	sub thawer_merge {
		1189	my ($self, $merge) = @_;
		1190
		1191	# we have to keep some variables in memory intact
		1192	local $self->{path};
		1193	local $self->{load_path};
		1194	local $self->{deny_save};
		1195	local $self->{deny_reset};
		1196
		1197	$self->SUPER::thawer_merge ($merge);
		1198	}
		1199
		1200	sub normalise {
		1201	my ($path, $base) = @_;
		1202
		1203	$path = "$path"; # make sure its a string
		1204
		1205	$path =~ s/\.map$//;
		1206
		1207	# map plan:
		1208	#
		1209	# /! non-realised random map exit (special hack!)
		1210	# {... are special paths that are not being touched
		1211	# ?xxx/... are special absolute paths
		1212	# ?random/... random maps
		1213	# /... normal maps
		1214	# ~user/... per-player map of a specific user
		1215
		1216	$path =~ s/$PATH_SEP/\//go;
		1217
		1218	# treat it as relative path if it starts with
		1219	# something that looks reasonable
		1220	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1221	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1222
		1223	$base =~ s{[^/]+/?$}{};
		1224	$path = "$base/$path";
		1225	}
		1226
		1227	for ($path) {
		1228	redo if s{//}{/};
		1229	redo if s{/\.?/}{/};
		1230	redo if s{/[^/]+/\.\./}{/};
		1231	}
		1232
		1233	$path
		1234	}
		1235
		1236	sub new_from_path {
		1237	my (undef, $path, $base) = @_;
		1238
		1239	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1240
		1241	$path = normalise $path, $base;
		1242
		1243	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1244	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1245	my $self = bless cf::map::new, $pkg;
		1246	$self->{path} = $path; $self->path ($path);
		1247	$self->init; # pass $1 etc.
		1248	return $self;
		1249	}
		1250	}
		1251
		1252	Carp::carp "unable to resolve path '$path' (base '$base').";
		1253	()
		1254	}
		1255
		1256	sub init {
		1257	my ($self) = @_;
		1258
		1259	$self
		1260	}
		1261
		1262	sub as_string {
		1263	my ($self) = @_;
		1264
		1265	"$self->{path}"
		1266	}
		1267
		1268	# the displayed name, this is a one way mapping
		1269	sub visible_name {
		1270	&as_string
		1271	}
		1272
		1273	# the original (read-only) location
		1274	sub load_path {
		1275	my ($self) = @_;
		1276
		1277	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
		1278	}
		1279
		1280	# the temporary/swap location
		1281	sub save_path {
		1282	my ($self) = @_;
		1283
		1284	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1285	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
		1286	}
		1287
		1288	# the unique path, undef == no special unique path
		1289	sub uniq_path {
		1290	my ($self) = @_;
		1291
		1292	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1293	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1294	}
		1295
		1296	# and all this just because we cannot iterate over
		1297	# all maps in C++...
		1298	sub change_all_map_light {
		1299	my ($change) = @_;
		1300
		1301	$_->change_map_light ($change)
		1302	for grep $_->outdoor, values %cf::MAP;
		1303	}
		1304
		1305	sub unlink_save {
		1306	my ($self) = @_;
		1307
		1308	utf8::encode (my $save = $self->save_path);
		1309	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1310	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1311	}
		1312
		1313	sub load_header_from($) {
		1314	my ($self, $path) = @_;
		1315
		1316	utf8::encode $path;
		1317	#aio_open $path, O_RDONLY, 0
		1318	# or return;
		1319
		1320	$self->_load_header ($path)
		1321	or return;
		1322
		1323	$self->{load_path} = $path;
		1324
		1325	1
		1326	}
		1327
		1328	sub load_header_orig {
		1329	my ($self) = @_;
		1330
		1331	$self->load_header_from ($self->load_path)
		1332	}
		1333
		1334	sub load_header_temp {
		1335	my ($self) = @_;
		1336
		1337	$self->load_header_from ($self->save_path)
		1338	}
		1339
		1340	sub prepare_temp {
		1341	my ($self) = @_;
		1342
		1343	$self->last_access ((delete $self->{last_access})
		1344	|| $cf::RUNTIME); #d#
		1345	# safety
		1346	$self->{instantiate_time} = $cf::RUNTIME
		1347	if $self->{instantiate_time} > $cf::RUNTIME;
		1348	}
		1349
		1350	sub prepare_orig {
		1351	my ($self) = @_;
		1352
		1353	$self->{load_original} = 1;
		1354	$self->{instantiate_time} = $cf::RUNTIME;
		1355	$self->last_access ($cf::RUNTIME);
		1356	$self->instantiate;
		1357	}
		1358
		1359	sub load_header {
		1360	my ($self) = @_;
		1361
		1362	if ($self->load_header_temp) {
		1363	$self->prepare_temp;
		1364	} else {
		1365	$self->load_header_orig
		1366	or return;
		1367	$self->prepare_orig;
		1368	}
		1369
		1370	1
		1371	}
		1372
		1373	sub find;
		1374	sub find {
		1375	my ($path, $origin) = @_;
		1376
		1377	$path = normalise $path, $origin && $origin->path;
		1378
		1379	cf::lock_wait "map_find:$path";
		1380
		1381	$cf::MAP{$path} || do {
		1382	my $guard = cf::lock_acquire "map_find:$path";
		1383	my $map = new_from_path cf::map $path
		1384	or return;
		1385
		1386	$map->{last_save} = $cf::RUNTIME;
		1387
		1388	$map->load_header
		1389	or return;
		1390
		1391	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1392	# doing this can freeze the server in a sync job, obviously
		1393	#$cf::WAIT_FOR_TICK->wait;
		1394	$map->reset;
		1395	undef $guard;
		1396	return find $path;
		1397	}
		1398
		1399	$cf::MAP{$path} = $map
		1400	}
		1401	}
		1402
		1403	sub pre_load { }
		1404	sub post_load { }
		1405
		1406	sub load {
		1407	my ($self) = @_;
		1408
		1409	local $self->{deny_reset} = 1; # loading can take a long time
		1410
		1411	my $path = $self->{path};
		1412	my $guard = cf::lock_acquire "map_load:$path";
		1413
		1414	return if $self->in_memory != cf::MAP_SWAPPED;
		1415
		1416	$self->in_memory (cf::MAP_LOADING);
		1417
		1418	$self->alloc;
		1419
		1420	$self->pre_load;
		1421
		1422	$self->_load_objects ($self->{load_path}, 1)
		1423	or return;
		1424
		1425	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1426	if delete $self->{load_original};
		1427
		1428	if (my $uniq = $self->uniq_path) {
		1429	utf8::encode $uniq;
		1430	if (aio_open $uniq, O_RDONLY, 0) {
		1431	$self->clear_unique_items;
		1432	$self->_load_objects ($uniq, 0);
		1433	}
		1434	}
		1435
		1436	Coro::cede;
		1437
		1438	# now do the right thing for maps
		1439	$self->link_multipart_objects;
		1440
		1441	unless ($self->{deny_activate}) {
		1442	$self->decay_objects;
		1443	$self->fix_auto_apply;
		1444	$self->update_buttons;
		1445	Coro::cede;
		1446	$self->set_darkness_map;
		1447	$self->difficulty ($self->estimate_difficulty)
		1448	unless $self->difficulty;
		1449	Coro::cede;
		1450	$self->activate;
		1451	}
		1452
		1453	$self->post_load;
		1454
		1455	$self->in_memory (cf::MAP_IN_MEMORY);
		1456	}
		1457
		1458	sub customise_for {
		1459	my ($self, $ob) = @_;
		1460
		1461	return find "~" . $ob->name . "/" . $self->{path}
		1462	if $self->per_player;
		1463
		1464	$self
		1465	}
		1466
		1467	# find and load all maps in the 3x3 area around a map
		1468	sub load_diag {
725	my ($map) = @_;	1469	my ($map) = @_;
726		1470
727	my $path = $map->tmpname;	1471	my @diag; # diagonal neighbours
728	defined $path or return;
729		1472
730	unlink "$path.pst";	1473	for (0 .. 3) {
731	};	1474	my $neigh = $map->tile_path ($_)
		1475	or next;
		1476	$neigh = find $neigh, $map
		1477	or next;
		1478	$neigh->load;
732		1479
733	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1480	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1481	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1482	}
734		1483
735	#############################################################################	1484	for (@diag) {
736	# load/save perl data associated with player->ob objects	1485	my $neigh = find @$_
737		1486	or next;
738	sub all_objects(@) {	1487	$neigh->load;
739	@_, map all_objects ($_->inv), @_	1488	}
740	}	1489	}
741		1490
742	# TODO: compatibility cruft, remove when no longer needed	1491	sub find_sync {
743	cf::player->attach (	1492	my ($path, $origin) = @_;
744	on_load => sub {
745	my ($pl, $path) = @_;
746		1493
747	for my $o (all_objects $pl->ob) {	1494	cf::sync_job { find $path, $origin }
748	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1495	}
749	$o->set_ob_key_value ("_perl_data");
750		1496
751	%$o = %{ Storable::thaw pack "H*", $value };	1497	sub do_load_sync {
		1498	my ($map) = @_;
		1499
		1500	cf::sync_job { $map->load };
		1501	}
		1502
		1503	our %MAP_PREFETCH;
		1504	our $MAP_PREFETCHER = undef;
		1505
		1506	sub find_async {
		1507	my ($path, $origin) = @_;
		1508
		1509	$path = normalise $path, $origin && $origin->{path};
		1510
		1511	if (my $map = $cf::MAP{$path}) {
		1512	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1513	}
		1514
		1515	undef $MAP_PREFETCH{$path};
		1516	$MAP_PREFETCHER ||= cf::async {
		1517	while (%MAP_PREFETCH) {
		1518	for my $path (keys %MAP_PREFETCH) {
		1519	my $map = find $path
		1520	or next;
		1521	$map->load;
		1522
		1523	delete $MAP_PREFETCH{$path};
752	}	1524	}
753	}	1525	}
		1526	undef $MAP_PREFETCHER;
		1527	};
		1528	$MAP_PREFETCHER->prio (6);
		1529
		1530	()
		1531	}
		1532
		1533	sub save {
		1534	my ($self) = @_;
		1535
		1536	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1537
		1538	$self->{last_save} = $cf::RUNTIME;
		1539
		1540	return unless $self->dirty;
		1541
		1542	my $save = $self->save_path; utf8::encode $save;
		1543	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1544
		1545	$self->{load_path} = $save;
		1546
		1547	return if $self->{deny_save};
		1548
		1549	local $self->{last_access} = $self->last_access;#d#
		1550
		1551	cf::async {
		1552	$_->contr->save for $self->players;
		1553	};
		1554
		1555	if ($uniq) {
		1556	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1557	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1558	} else {
		1559	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
754	},	1560	}
755	);	1561	}
756		1562
757	#############################################################################	1563	sub swap_out {
		1564	my ($self) = @_;
758		1565
759	=head2 CORE EXTENSIONS	1566	# save first because save cedes
		1567	$self->save;
760		1568
761	Functions and methods that extend core crossfire objects.	1569	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1570
		1571	return if $self->players;
		1572	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1573	return if $self->{deny_save};
		1574
		1575	$self->clear;
		1576	$self->in_memory (cf::MAP_SWAPPED);
		1577	}
		1578
		1579	sub reset_at {
		1580	my ($self) = @_;
		1581
		1582	# TODO: safety, remove and allow resettable per-player maps
		1583	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1584	return 1e99 if $self->{deny_reset};
		1585
		1586	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1587	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1588
		1589	$time + $to
		1590	}
		1591
		1592	sub should_reset {
		1593	my ($self) = @_;
		1594
		1595	$self->reset_at <= $cf::RUNTIME
		1596	}
		1597
		1598	sub reset {
		1599	my ($self) = @_;
		1600
		1601	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1602
		1603	return if $self->players;
		1604	return if $self->isa ("ext::map_per_player");#d#
		1605
		1606	warn "resetting map ", $self->path;#d#
		1607
		1608	$self->in_memory (cf::MAP_SWAPPED);
		1609
		1610	# need to save uniques path
		1611	unless ($self->{deny_save}) {
		1612	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1613
		1614	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1615	if $uniq;
		1616	}
		1617
		1618	delete $cf::MAP{$self->path};
		1619
		1620	$self->clear;
		1621
		1622	$_->clear_links_to ($self) for values %cf::MAP;
		1623
		1624	$self->unlink_save;
		1625	$self->destroy;
		1626	}
		1627
		1628	my $nuke_counter = "aaaa";
		1629
		1630	sub nuke {
		1631	my ($self) = @_;
		1632
		1633	delete $cf::MAP{$self->path};
		1634
		1635	$self->unlink_save;
		1636
		1637	bless $self, "cf::map";
		1638	delete $self->{deny_reset};
		1639	$self->{deny_save} = 1;
		1640	$self->reset_timeout (1);
		1641	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1642
		1643	$cf::MAP{$self->path} = $self;
		1644
		1645	$self->reset; # polite request, might not happen
		1646	}
		1647
		1648	=item cf::map::unique_maps
		1649
		1650	Returns an arrayref of paths of all shared maps that have
		1651	instantiated unique items. May block.
		1652
		1653	=cut
		1654
		1655	sub unique_maps() {
		1656	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1657	or return;
		1658
		1659	my @paths;
		1660
		1661	for (@$files) {
		1662	utf8::decode $_;
		1663	next if /\.pst$/;
		1664	next unless /^$PATH_SEP/o;
		1665
		1666	push @paths, cf::map::normalise $_;
		1667	}
		1668
		1669	\@paths
		1670	}
		1671
		1672	package cf;
		1673
		1674	=back
		1675
		1676	=head3 cf::object
		1677
		1678	=cut
		1679
		1680	package cf::object;
762		1681
763	=over 4	1682	=over 4
764		1683
765	=item cf::player::exists $login	1684	=item $ob->inv_recursive
766		1685
767	Returns true when the given account exists.	1686	Returns the inventory of the object _and_ their inventories, recursively.
768		1687
769	=cut	1688	=cut
770		1689
771	sub cf::player::exists($) {	1690	sub inv_recursive_;
772	cf::player::find $_[0]	1691	sub inv_recursive_ {
773	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1692	map { $_, inv_recursive_ $_->inv } @_
774	}	1693	}
		1694
		1695	sub inv_recursive {
		1696	inv_recursive_ inv $_[0]
		1697	}
		1698
		1699	package cf;
		1700
		1701	=back
		1702
		1703	=head3 cf::object::player
		1704
		1705	=over 4
775		1706
776	=item $player_object->reply ($npc, $msg[, $flags])	1707	=item $player_object->reply ($npc, $msg[, $flags])
777		1708
778	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1709	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
779	can be C<undef>. Does the right thing when the player is currently in a	1710	can be C<undef>. Does the right thing when the player is currently in a
…		…
781		1712
782	=cut	1713	=cut
783		1714
784	# rough implementation of a future "reply" method that works	1715	# rough implementation of a future "reply" method that works
785	# with dialog boxes.	1716	# with dialog boxes.
		1717	#TODO: the first argument must go, split into a $npc->reply_to ( method
786	sub cf::object::player::reply($$$;$) {	1718	sub cf::object::player::reply($$$;$) {
787	my ($self, $npc, $msg, $flags) = @_;	1719	my ($self, $npc, $msg, $flags) = @_;
788		1720
789	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1721	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
790		1722
…		…
794	$msg = $npc->name . " says: $msg" if $npc;	1726	$msg = $npc->name . " says: $msg" if $npc;
795	$self->message ($msg, $flags);	1727	$self->message ($msg, $flags);
796	}	1728	}
797	}	1729	}
798		1730
799	=item $player->ext_reply ($msgid, $msgtype, %msg)
800
801	Sends an ext reply to the player.
802
803	=cut
804
805	sub cf::player::ext_reply($$$%) {
806	my ($self, $id, %msg) = @_;
807
808	$msg{msgid} = $id;
809
810	$self->send ("ext " . to_json \%msg);
811	}
812
813	=item $player_object->may ("access")	1731	=item $player_object->may ("access")
814		1732
815	Returns wether the given player is authorized to access resource "access"	1733	Returns wether the given player is authorized to access resource "access"
816	(e.g. "command_wizcast").	1734	(e.g. "command_wizcast").
817		1735
…		…
824	(ref $cf::CFG{"may_$access"}	1742	(ref $cf::CFG{"may_$access"}
825	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1743	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826	: $cf::CFG{"may_$access"})	1744	: $cf::CFG{"may_$access"})
827	}	1745	}
828		1746
829	=cut	1747	=item $player_object->enter_link
830		1748
831	#############################################################################	1749	Freezes the player and moves him/her to a special map (C<{link}>).
		1750
		1751	The player should be reasonably safe there for short amounts of time. You
		1752	I<MUST> call C<leave_link> as soon as possible, though.
		1753
		1754	Will never block.
		1755
		1756	=item $player_object->leave_link ($map, $x, $y)
		1757
		1758	Moves the player out of the special C<{link}> map onto the specified
		1759	map. If the map is not valid (or omitted), the player will be moved back
		1760	to the location he/she was before the call to C<enter_link>, or, if that
		1761	fails, to the emergency map position.
		1762
		1763	Might block.
		1764
		1765	=cut
		1766
		1767	sub link_map {
		1768	unless ($LINK_MAP) {
		1769	$LINK_MAP = cf::map::find "{link}"
		1770	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1771	$LINK_MAP->load;
		1772	}
		1773
		1774	$LINK_MAP
		1775	}
		1776
		1777	sub cf::object::player::enter_link {
		1778	my ($self) = @_;
		1779
		1780	$self->deactivate_recursive;
		1781
		1782	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1783
		1784	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1785	if $self->map;
		1786
		1787	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		1788	}
		1789
		1790	sub cf::object::player::leave_link {
		1791	my ($self, $map, $x, $y) = @_;
		1792
		1793	my $link_pos = delete $self->{_link_pos};
		1794
		1795	unless ($map) {
		1796	# restore original map position
		1797	($map, $x, $y) = @{ $link_pos || [] };
		1798	$map = cf::map::find $map;
		1799
		1800	unless ($map) {
		1801	($map, $x, $y) = @$EMERGENCY_POSITION;
		1802	$map = cf::map::find $map
		1803	or die "FATAL: cannot load emergency map\n";
		1804	}
		1805	}
		1806
		1807	($x, $y) = (-1, -1)
		1808	unless (defined $x) && (defined $y);
		1809
		1810	# use -1 or undef as default coordinates, not 0, 0
		1811	($x, $y) = ($map->enter_x, $map->enter_y)
		1812	if $x <=0 && $y <= 0;
		1813
		1814	$map->load;
		1815	$map->load_diag;
		1816
		1817	return unless $self->contr->active;
		1818	$self->activate_recursive;
		1819
		1820	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		1821	$self->enter_map ($map, $x, $y);
		1822	}
		1823
		1824	cf::player->attach (
		1825	on_logout => sub {
		1826	my ($pl) = @_;
		1827
		1828	# abort map switching before logout
		1829	if ($pl->ob->{_link_pos}) {
		1830	cf::sync_job {
		1831	$pl->ob->leave_link
		1832	};
		1833	}
		1834	},
		1835	on_login => sub {
		1836	my ($pl) = @_;
		1837
		1838	# try to abort aborted map switching on player login :)
		1839	# should happen only on crashes
		1840	if ($pl->ob->{_link_pos}) {
		1841	$pl->ob->enter_link;
		1842	(async {
		1843	$pl->ob->reply (undef,
		1844	"There was an internal problem at your last logout, "
		1845	. "the server will try to bring you to your intended destination in a second.",
		1846	cf::NDI_RED);
		1847	# we need this sleep as the login has a concurrent enter_exit running
		1848	# and this sleep increases chances of the player not ending up in scorn
		1849	Coro::Timer::sleep 1;
		1850	$pl->ob->leave_link;
		1851	})->prio (2);
		1852	}
		1853	},
		1854	);
		1855
		1856	=item $player_object->goto ($path, $x, $y)
		1857
		1858	=cut
		1859
		1860	sub cf::object::player::goto {
		1861	my ($self, $path, $x, $y) = @_;
		1862
		1863	$self->enter_link;
		1864
		1865	(async {
		1866	my $map = eval {
		1867	my $map = cf::map::find $path;
		1868	$map = $map->customise_for ($self) if $map;
		1869	$map
		1870	} or
		1871	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1872
		1873	$self->leave_link ($map, $x, $y);
		1874	})->prio (1);
		1875	}
		1876
		1877	=item $player_object->enter_exit ($exit_object)
		1878
		1879	=cut
		1880
		1881	sub parse_random_map_params {
		1882	my ($spec) = @_;
		1883
		1884	my $rmp = { # defaults
		1885	xsize => (cf::rndm 15, 40),
		1886	ysize => (cf::rndm 15, 40),
		1887	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1888	#layout => string,
		1889	};
		1890
		1891	for (split /\n/, $spec) {
		1892	my ($k, $v) = split /\s+/, $_, 2;
		1893
		1894	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1895	}
		1896
		1897	$rmp
		1898	}
		1899
		1900	sub prepare_random_map {
		1901	my ($exit) = @_;
		1902
		1903	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1904
		1905	# all this does is basically replace the /! path by
		1906	# a new random map path (?random/...) with a seed
		1907	# that depends on the exit object
		1908
		1909	my $rmp = parse_random_map_params $exit->msg;
		1910
		1911	if ($exit->map) {
		1912	$rmp->{region} = $exit->region->name;
		1913	$rmp->{origin_map} = $exit->map->path;
		1914	$rmp->{origin_x} = $exit->x;
		1915	$rmp->{origin_y} = $exit->y;
		1916	}
		1917
		1918	$rmp->{random_seed} ||= $exit->random_seed;
		1919
		1920	my $data = cf::to_json $rmp;
		1921	my $md5 = Digest::MD5::md5_hex $data;
		1922	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1923
		1924	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1925	aio_write $fh, 0, (length $data), $data, 0;
		1926	undef $fh;
		1927	aio_rename "$meta~", $meta;
		1928
		1929	$exit->slaying ("?random/$md5");
		1930	$exit->msg (undef);
		1931	}
		1932	}
		1933
		1934	sub cf::object::player::enter_exit {
		1935	my ($self, $exit) = @_;
		1936
		1937	return unless $self->type == cf::PLAYER;
		1938
		1939	if ($exit->slaying eq "/!") {
		1940	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1941	cf::sync_job { prepare_random_map $exit };
		1942	}
		1943
		1944	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1945	my $hp = $exit->stats->hp;
		1946	my $sp = $exit->stats->sp;
		1947
		1948	$self->enter_link;
		1949
		1950	(async {
		1951	$self->deactivate_recursive; # just to be sure
		1952	unless (eval {
		1953	$self->goto ($slaying, $hp, $sp);
		1954
		1955	1;
		1956	}) {
		1957	$self->message ("Something went wrong deep within the crossfire server. "
		1958	. "I'll try to bring you back to the map you were before. "
		1959	. "Please report this to the dungeon master!",
		1960	cf::NDI_UNIQUE | cf::NDI_RED);
		1961
		1962	warn "ERROR in enter_exit: $@";
		1963	$self->leave_link;
		1964	}
		1965	})->prio (1);
		1966	}
		1967
		1968	=head3 cf::client
		1969
		1970	=over 4
		1971
		1972	=item $client->send_drawinfo ($text, $flags)
		1973
		1974	Sends a drawinfo packet to the client. Circumvents output buffering so
		1975	should not be used under normal circumstances.
		1976
		1977	=cut
		1978
		1979	sub cf::client::send_drawinfo {
		1980	my ($self, $text, $flags) = @_;
		1981
		1982	utf8::encode $text;
		1983	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1984	}
		1985
		1986
		1987	=item $success = $client->query ($flags, "text", \&cb)
		1988
		1989	Queues a query to the client, calling the given callback with
		1990	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1991	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1992
		1993	Queries can fail, so check the return code. Or don't, as queries will become
		1994	reliable at some point in the future.
		1995
		1996	=cut
		1997
		1998	sub cf::client::query {
		1999	my ($self, $flags, $text, $cb) = @_;
		2000
		2001	return unless $self->state == ST_PLAYING
		2002	|| $self->state == ST_SETUP
		2003	|| $self->state == ST_CUSTOM;
		2004
		2005	$self->state (ST_CUSTOM);
		2006
		2007	utf8::encode $text;
		2008	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2009
		2010	$self->send_packet ($self->{query_queue}[0][0])
		2011	if @{ $self->{query_queue} } == 1;
		2012	}
		2013
		2014	cf::client->attach (
		2015	on_reply => sub {
		2016	my ($ns, $msg) = @_;
		2017
		2018	# this weird shuffling is so that direct followup queries
		2019	# get handled first
		2020	my $queue = delete $ns->{query_queue}
		2021	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2022
		2023	(shift @$queue)->[1]->($msg);
		2024	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2025
		2026	push @{ $ns->{query_queue} }, @$queue;
		2027
		2028	if (@{ $ns->{query_queue} } == @$queue) {
		2029	if (@$queue) {
		2030	$ns->send_packet ($ns->{query_queue}[0][0]);
		2031	} else {
		2032	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2033	}
		2034	}
		2035	},
		2036	);
		2037
		2038	=item $client->async (\&cb)
		2039
		2040	Create a new coroutine, running the specified callback. The coroutine will
		2041	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2042	or loss of connection).
		2043
		2044	=cut
		2045
		2046	sub cf::client::async {
		2047	my ($self, $cb) = @_;
		2048
		2049	my $coro = &Coro::async ($cb);
		2050
		2051	$coro->on_destroy (sub {
		2052	delete $self->{_coro}{$coro+0};
		2053	});
		2054
		2055	$self->{_coro}{$coro+0} = $coro;
		2056
		2057	$coro
		2058	}
		2059
		2060	cf::client->attach (
		2061	on_destroy => sub {
		2062	my ($ns) = @_;
		2063
		2064	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2065	},
		2066	);
		2067
		2068	=back
		2069
832		2070
833	=head2 SAFE SCRIPTING	2071	=head2 SAFE SCRIPTING
834		2072
835	Functions that provide a safe environment to compile and execute	2073	Functions that provide a safe environment to compile and execute
836	snippets of perl code without them endangering the safety of the server	2074	snippets of perl code without them endangering the safety of the server
…		…
952	The parameter C<$family> should best start with the name of the extension	2190	The parameter C<$family> should best start with the name of the extension
953	using it, it should be unique.	2191	using it, it should be unique.
954		2192
955	=over 4	2193	=over 4
956		2194
957	=item $hashref = cf::db_get $family
958
959	Return a hashref for use by the extension C<$family>, which can be
960	modified. After modifications, you have to call C<cf::db_dirty> or
961	C<cf::db_sync>.
962
963	=item $value = cf::db_get $family => $key	2195	=item $value = cf::db_get $family => $key
964		2196
965	Returns a single value from the database	2197	Returns a single value from the database.
966
967	=item cf::db_put $family => $hashref
968
969	Stores the given family hashref into the database. Updates are delayed, if
970	you want the data to be synced to disk immediately, use C<cf::db_sync>.
971		2198
972	=item cf::db_put $family => $key => $value	2199	=item cf::db_put $family => $key => $value
973		2200
974	Stores the given C<$value> in the family hash. Updates are delayed, if you	2201	Stores the given C<$value> in the family.
975	want the data to be synced to disk immediately, use C<cf::db_sync>.
976
977	=item cf::db_dirty
978
979	Marks the database as dirty, to be updated at a later time.
980
981	=item cf::db_sync
982
983	Immediately write the database to disk I<if it is dirty>.
984		2202
985	=cut	2203	=cut
986		2204
987	our $DB;	2205	our $DB;
988		2206
989	{	2207	sub db_init {
		2208	unless ($DB) {
		2209	$DB = BDB::db_create $DB_ENV;
		2210
		2211	cf::sync_job {
		2212	eval {
		2213	$DB->set_flags (BDB::CHKSUM);
		2214
		2215	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		2216	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		2217	cf::cleanup "db_open(db): $!" if $!;
		2218	};
		2219	cf::cleanup "db_open(db): $@" if $@;
		2220	};
		2221
990	my $path = cf::localdir . "/database.pst";	2222	my $path = cf::localdir . "/database.pst";
		2223	if (stat $path) {
		2224	cf::sync_job {
		2225	my $pst = Storable::retrieve $path;
991		2226
992	sub db_load() {	2227	cf::db_put (board => data => $pst->{board});
993	warn "loading database $path\n";#d# remove later	2228	cf::db_put (guildrules => data => $pst->{guildrules});
994	$DB = stat $path ? Storable::retrieve $path : { };	2229	cf::db_put (rent => balance => $pst->{rent}{balance});
995	}	2230	BDB::db_env_txn_checkpoint $DB_ENV;
996		2231
997	my $pid;	2232	unlink $path;
998
999	sub db_save() {
1000	warn "saving database $path\n";#d# remove later
1001	waitpid $pid, 0 if $pid;
1002	if (0 == ($pid = fork)) {
1003	$DB->{_meta}{version} = 1;
1004	Storable::nstore $DB, "$path~";
1005	rename "$path~", $path;
1006	cf::_exit 0 if defined $pid;
1007	}	2233	};
1008	}
1009
1010	my $dirty;
1011
1012	sub db_sync() {
1013	db_save if $dirty;
1014	undef $dirty;
1015	}
1016
1017	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1018	db_sync;
1019	});
1020
1021	sub db_dirty() {
1022	$dirty = 1;
1023	$idle->start;
1024	}
1025
1026	sub db_get($;$) {
1027	@_ >= 2
1028	? $DB->{$_[0]}{$_[1]}
1029	: ($DB->{$_[0]} ||= { })
1030	}
1031
1032	sub db_put($$;$) {
1033	if (@_ >= 3) {
1034	$DB->{$_[0]}{$_[1]} = $_[2];
1035	} else {
1036	$DB->{$_[0]} = $_[1];
1037	}
1038	db_dirty;
1039	}
1040
1041	cf::global->attach (
1042	prio => 10000,
1043	on_cleanup => sub {
1044	db_sync;
1045	},	2234	}
1046	);	2235	}
		2236	}
		2237
		2238	sub db_get($$) {
		2239	my $key = "$_[0]/$_[1]";
		2240
		2241	cf::sync_job {
		2242	BDB::db_get $DB, undef, $key, my $data;
		2243
		2244	$! ? ()
		2245	: Compress::LZF::sthaw $data
		2246	}
		2247	}
		2248
		2249	sub db_put($$$) {
		2250	BDB::dbreq_pri 4;
		2251	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
1047	}	2252	}
1048		2253
1049	#############################################################################	2254	#############################################################################
1050	# the server's main()	2255	# the server's init and main functions
		2256
		2257	sub init_resources {
		2258	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
		2259	or die "unable to load regions file\n";#d#
		2260	}
1051		2261
1052	sub cfg_load {	2262	sub cfg_load {
1053	open my $fh, "<:utf8", cf::confdir . "/config"	2263	open my $fh, "<:utf8", cf::confdir . "/config"
1054	or return;	2264	or return;
1055		2265
1056	local $/;	2266	local $/;
1057	*CFG = YAML::Syck::Load <$fh>;	2267	*CFG = YAML::Syck::Load <$fh>;
		2268
		2269	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2270
		2271	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2272	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2273
		2274	if (exists $CFG{mlockall}) {
		2275	eval {
		2276	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2277	and die "WARNING: m(un)lockall failed: $!\n";
		2278	};
		2279	warn $@ if $@;
		2280	}
		2281	}
		2282
		2283	sub init {
		2284	init_resources;
1058	}	2285	}
1059		2286
1060	sub main {	2287	sub main {
		2288	# we must not ever block the main coroutine
		2289	local $Coro::idle = sub {
		2290	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2291	(async {
		2292	Event::one_event;
		2293	})->prio (Coro::PRIO_MAX);
		2294	};
		2295
1061	cfg_load;	2296	cfg_load;
1062	db_load;	2297	db_init;
1063	load_extensions;	2298	load_extensions;
		2299
		2300	$TICK_WATCHER->start;
1064	Event::loop;	2301	Event::loop;
1065	}	2302	}
1066		2303
1067	#############################################################################	2304	#############################################################################
1068	# initialisation	2305	# initialisation and cleanup
1069		2306
		2307	# install some emergency cleanup handlers
		2308	BEGIN {
		2309	for my $signal (qw(INT HUP TERM)) {
		2310	Event->signal (
		2311	reentrant => 0,
		2312	data => WF_AUTOCANCEL,
		2313	signal => $signal,
		2314	prio => 0,
		2315	cb => sub {
		2316	cf::cleanup "SIG$signal";
		2317	},
		2318	);
		2319	}
		2320	}
		2321
		2322	sub emergency_save() {
		2323	my $freeze_guard = cf::freeze_mainloop;
		2324
		2325	warn "enter emergency perl save\n";
		2326
		2327	cf::sync_job {
		2328	# use a peculiar iteration method to avoid tripping on perl
		2329	# refcount bugs in for. also avoids problems with players
		2330	# and maps saved/destroyed asynchronously.
		2331	warn "begin emergency player save\n";
		2332	for my $login (keys %cf::PLAYER) {
		2333	my $pl = $cf::PLAYER{$login} or next;
		2334	$pl->valid or next;
		2335	$pl->save;
		2336	}
		2337	warn "end emergency player save\n";
		2338
		2339	warn "begin emergency map save\n";
		2340	for my $path (keys %cf::MAP) {
		2341	my $map = $cf::MAP{$path} or next;
		2342	$map->valid or next;
		2343	$map->save;
		2344	}
		2345	warn "end emergency map save\n";
		2346
		2347	warn "begin emergency database checkpoint\n";
		2348	BDB::db_env_txn_checkpoint $DB_ENV;
		2349	warn "end emergency database checkpoint\n";
		2350	};
		2351
		2352	warn "leave emergency perl save\n";
		2353	}
		2354
		2355	sub post_cleanup {
		2356	my ($make_core) = @_;
		2357
		2358	warn Carp::longmess "post_cleanup backtrace"
		2359	if $make_core;
		2360	}
		2361
1070	sub _perl_reload(&) {	2362	sub reload() {
1071	my ($msg) = @_;	2363	# can/must only be called in main
		2364	if ($Coro::current != $Coro::main) {
		2365	warn "can only reload from main coroutine";
		2366	return;
		2367	}
1072		2368
1073	$msg->("reloading...");	2369	warn "reloading...";
1074		2370
1075	eval {	2371	warn "entering sync_job";
1076	# cancel all watchers	2372
		2373	cf::sync_job {
		2374	cf::write_runtime; # external watchdog should not bark
		2375	cf::emergency_save;
		2376	cf::write_runtime; # external watchdog should not bark
		2377
		2378	warn "syncing database to disk";
		2379	BDB::db_env_txn_checkpoint $DB_ENV;
		2380
		2381	# if anything goes wrong in here, we should simply crash as we already saved
		2382
		2383	warn "cancelling all WF_AUTOCANCEL watchers";
1077	for (Event::all_watchers) {	2384	for (Event::all_watchers) {
1078	$_->cancel if $_->data & WF_AUTOCANCEL;	2385	$_->cancel if $_->data & WF_AUTOCANCEL;
1079	}	2386	}
1080		2387
1081	# unload all extensions	2388	warn "flushing outstanding aio requests";
1082	for (@exts) {	2389	for (;;) {
1083	$msg->("unloading <$_>");	2390	BDB::flush;
1084	unload_extension $_;	2391	IO::AIO::flush;
		2392	Coro::cede;
		2393	last unless IO::AIO::nreqs || BDB::nreqs;
		2394	warn "iterate...";
		2395	}
		2396
		2397	warn "cancelling all extension coros";
		2398	$_->cancel for values %EXT_CORO;
		2399	%EXT_CORO = ();
		2400
		2401	warn "removing commands";
		2402	%COMMAND = ();
		2403
		2404	warn "removing ext commands";
		2405	%EXTCMD = ();
		2406
		2407	warn "unloading/nuking all extensions";
		2408	for my $pkg (@EXTS) {
		2409	warn "... unloading $pkg";
		2410
		2411	if (my $cb = $pkg->can ("unload")) {
		2412	eval {
		2413	$cb->($pkg);
		2414	1
		2415	} or warn "$pkg unloaded, but with errors: $@";
1085	}	2416	}
1086		2417
		2418	warn "... nuking $pkg";
		2419	Symbol::delete_package $pkg;
		2420	}
		2421
1087	# unload all modules loaded from $LIBDIR	2422	warn "unloading all perl modules loaded from $LIBDIR";
1088	while (my ($k, $v) = each %INC) {	2423	while (my ($k, $v) = each %INC) {
1089	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2424	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1090		2425
1091	$msg->("removing <$k>");	2426	warn "... unloading $k";
1092	delete $INC{$k};	2427	delete $INC{$k};
1093		2428
1094	$k =~ s/\.pm$//;	2429	$k =~ s/\.pm$//;
1095	$k =~ s/\//::/g;	2430	$k =~ s/\//::/g;
1096		2431
…		…
1099	}	2434	}
1100		2435
1101	Symbol::delete_package $k;	2436	Symbol::delete_package $k;
1102	}	2437	}
1103		2438
1104	# sync database to disk
1105	cf::db_sync;
1106
1107	# get rid of safe::, as good as possible	2439	warn "getting rid of safe::, as good as possible";
1108	Symbol::delete_package "safe::$_"	2440	Symbol::delete_package "safe::$_"
1109	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2441	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1110		2442
1111	# remove register_script_function callbacks
1112	# TODO
1113
1114	# unload cf.pm "a bit"	2443	warn "unloading cf.pm \"a bit\"";
1115	delete $INC{"cf.pm"};	2444	delete $INC{"cf.pm"};
1116		2445
1117	# don't, removes xs symbols, too,	2446	# don't, removes xs symbols, too,
1118	# and global variables created in xs	2447	# and global variables created in xs
1119	#Symbol::delete_package __PACKAGE__;	2448	#Symbol::delete_package __PACKAGE__;
1120		2449
1121	# reload cf.pm	2450	warn "unload completed, starting to reload now";
		2451
1122	$msg->("reloading cf.pm");	2452	warn "reloading cf.pm";
1123	require cf;	2453	require cf;
		2454	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1124		2455
1125	# load config and database again	2456	warn "loading config and database again";
1126	cf::cfg_load;	2457	cf::cfg_load;
1127	cf::db_load;
1128		2458
1129	# load extensions	2459	warn "loading extensions";
1130	$msg->("load extensions");
1131	cf::load_extensions;	2460	cf::load_extensions;
1132		2461
1133	# reattach attachments to objects	2462	warn "reattaching attachments to objects/players";
1134	$msg->("reattach");
1135	_global_reattach;	2463	_global_reattach;
		2464	warn "reattaching attachments to maps";
		2465	reattach $_ for values %MAP;
		2466
		2467	warn "loading reloadable resources";
		2468	init_resources;
		2469
		2470	warn "leaving sync_job";
		2471
		2472	1
		2473	} or do {
		2474	warn $@;
		2475	warn "error while reloading, exiting.";
		2476	exit 1;
1136	};	2477	};
1137	$msg->($@) if $@;
1138		2478
1139	$msg->("reloaded");	2479	warn "reloaded";
1140	};	2480	};
1141		2481
1142	sub perl_reload() {	2482	our $RELOAD_WATCHER; # used only during reload
1143	_perl_reload {
1144	warn $_[0];
1145	print "$_[0]\n";
1146	};
1147	}
1148		2483
1149	register "<global>", __PACKAGE__;
1150
1151	register_command "perl-reload" => sub {	2484	register_command "reload" => sub {
1152	my ($who, $arg) = @_;	2485	my ($who, $arg) = @_;
1153		2486
1154	if ($who->flag (FLAG_WIZ)) {	2487	if ($who->flag (FLAG_WIZ)) {
1155	_perl_reload {	2488	$who->message ("reloading server.");
1156	warn $_[0];	2489
1157	$who->message ($_[0]);	2490	# doing reload synchronously and two reloads happen back-to-back,
		2491	# coro crashes during coro_state_free->destroy here.
		2492
		2493	$RELOAD_WATCHER ||= Event->timer (
		2494	reentrant => 0,
		2495	after => 0,
		2496	data => WF_AUTOCANCEL,
		2497	cb => sub {
		2498	reload;
		2499	undef $RELOAD_WATCHER;
		2500	},
1158	};	2501	);
1159	}	2502	}
1160	};	2503	};
1161		2504
1162	unshift @INC, $LIBDIR;	2505	unshift @INC, $LIBDIR;
1163		2506
		2507	my $bug_warning = 0;
		2508
1164	$TICK_WATCHER = Event->timer (	2509	$TICK_WATCHER = Event->timer (
		2510	reentrant => 0,
		2511	parked => 1,
1165	prio => 0,	2512	prio => 0,
1166	at => $NEXT_TICK || 1,	2513	at => $NEXT_TICK || $TICK,
1167	data => WF_AUTOCANCEL,	2514	data => WF_AUTOCANCEL,
1168	cb => sub {	2515	cb => sub {
		2516	if ($Coro::current != $Coro::main) {
		2517	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2518	unless ++$bug_warning > 10;
		2519	return;
		2520	}
		2521
		2522	$NOW = Event::time;
		2523
1169	cf::server_tick; # one server iteration	2524	cf::server_tick; # one server iteration
1170		2525	$RUNTIME += $TICK;
1171	my $NOW = Event::time;
1172	$NEXT_TICK += $TICK;	2526	$NEXT_TICK += $TICK;
1173		2527
		2528	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2529	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2530	Coro::async_pool {
		2531	write_runtime
		2532	or warn "ERROR: unable to write runtime file: $!";
		2533	};
		2534	}
		2535
		2536	$WAIT_FOR_TICK->broadcast;
		2537	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2538
		2539	# my $AFTER = Event::time;
		2540	# warn $AFTER - $NOW;#d#
		2541
1174	# if we are delayed by four ticks or more, skip them all	2542	# if we are delayed by four ticks or more, skip them all
1175	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2543	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1176		2544
1177	$TICK_WATCHER->at ($NEXT_TICK);	2545	$TICK_WATCHER->at ($NEXT_TICK);
1178	$TICK_WATCHER->start;	2546	$TICK_WATCHER->start;
1179	},	2547	},
1180	);	2548	);
1181		2549
		2550	{
		2551	BDB::max_poll_time $TICK * 0.1;
		2552	$BDB_POLL_WATCHER = Event->io (
		2553	reentrant => 0,
		2554	fd => BDB::poll_fileno,
		2555	poll => 'r',
		2556	prio => 0,
		2557	data => WF_AUTOCANCEL,
		2558	cb => \&BDB::poll_cb,
		2559	);
		2560	BDB::min_parallel 8;
		2561
		2562	BDB::set_sync_prepare {
		2563	my $status;
		2564	my $current = $Coro::current;
		2565	(
		2566	sub {
		2567	$status = $!;
		2568	$current->ready; undef $current;
		2569	},
		2570	sub {
		2571	Coro::schedule while defined $current;
		2572	$! = $status;
		2573	},
		2574	)
		2575	};
		2576
		2577	unless ($DB_ENV) {
		2578	$DB_ENV = BDB::db_env_create;
		2579
		2580	cf::sync_job {
		2581	eval {
		2582	BDB::db_env_open
		2583	$DB_ENV,
		2584	$BDB_ENV_DIR,
		2585	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2586	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2587	0666;
		2588
		2589	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
		2590
		2591	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2592	$DB_ENV->set_lk_detect;
		2593	};
		2594
		2595	cf::cleanup "db_env_open(db): $@" if $@;
		2596	};
		2597	}
		2598	}
		2599
		2600	{
		2601	IO::AIO::min_parallel 8;
		2602
		2603	undef $Coro::AIO::WATCHER;
1182	IO::AIO::max_poll_time $TICK * 0.2;	2604	IO::AIO::max_poll_time $TICK * 0.1;
1183		2605	$AIO_POLL_WATCHER = Event->io (
1184	Event->io (fd => IO::AIO::poll_fileno,	2606	reentrant => 0,
1185	poll => 'r',
1186	prio => 5,
1187	data => WF_AUTOCANCEL,	2607	data => WF_AUTOCANCEL,
		2608	fd => IO::AIO::poll_fileno,
		2609	poll => 'r',
		2610	prio => 6,
1188	cb => \&IO::AIO::poll_cb);	2611	cb => \&IO::AIO::poll_cb,
		2612	);
		2613	}
		2614
		2615	END { cf::emergency_save }
1189		2616
1190	1	2617	1
1191		2618

Diff Legend

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