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.99 by root, Sat Dec 23 05:25:35 2006 UTC vs.
Revision 1.493 by root, Mon Oct 26 02:34:37 2009 UTC

		1	#
		2	# This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	#
		4	# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	#
		6	# Deliantra is free software: you can redistribute it and/or modify it under
		7	# the terms of the Affero GNU General Public License as published by the
		8	# Free Software Foundation, either version 3 of the License, or (at your
		9	# option) any later version.
		10	#
		11	# This program is distributed in the hope that it will be useful,
		12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	# GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the Affero GNU General Public License
		17	# and the GNU General Public License along with this program. If not, see
		18	# <http://www.gnu.org/licenses/>.
		19	#
		20	# The authors can be reached via e-mail to <support@deliantra.net>
		21	#
		22
1	package cf;	23	package cf;
2		24
		25	use 5.10.0;
3	use utf8;	26	use utf8;
4	use strict;	27	use strict qw(vars subs);
5		28
6	use Symbol;	29	use Symbol;
7	use List::Util;	30	use List::Util;
8	use Storable;	31	use Socket;
		32	use EV;
9	use Opcode;	33	use Opcode;
10	use Safe;	34	use Safe;
11	use Safe::Hole;	35	use Safe::Hole;
		36	use Storable ();
		37	use Carp ();
12		38
		39	use Guard ();
13	use Coro;	40	use Coro ();
		41	use Coro::State;
		42	use Coro::Handle;
		43	use Coro::EV;
14	use Coro::Event;	44	use Coro::AnyEvent;
15	use Coro::Timer;	45	use Coro::Timer;
16	use Coro::Signal;	46	use Coro::Signal;
17	use Coro::Semaphore;	47	use Coro::Semaphore;
		48	use Coro::SemaphoreSet;
		49	use Coro::AnyEvent;
		50	use Coro::AIO;
		51	use Coro::BDB 1.6;
		52	use Coro::Storable;
		53	use Coro::Util ();
18		54
19	use IO::AIO 2.3;	55	use JSON::XS 2.01 ();
		56	use BDB ();
		57	use Data::Dumper;
		58	use Digest::MD5;
		59	use Fcntl;
20	use YAML::Syck ();	60	use YAML::XS ();
		61	use IO::AIO ();
21	use Time::HiRes;	62	use Time::HiRes;
		63	use Compress::LZF;
		64	use Digest::MD5 ();
22		65
23	use Event; $Event::Eval = 1; # no idea why this is required, but it is	66	AnyEvent::detect;
24		67
25	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	68	# configure various modules to our taste
26	$YAML::Syck::ImplicitUnicode = 1;	69	#
		70	$Storable::canonical = 1; # reduce rsync transfers
		71	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
27		72
28	$Coro::main->prio (Coro::PRIO_MIN);	73	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		74
		75	# make sure c-lzf reinitialises itself
		76	Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
		77	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		78
		79	# strictly for debugging
		80	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
29		81
30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	82	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31		83
32	our %COMMAND = ();	84	our %COMMAND = ();
33	our %COMMAND_TIME = ();	85	our %COMMAND_TIME = ();
		86
		87	our @EXTS = (); # list of extension package names
34	our %EXTCMD = ();	88	our %EXTCMD = ();
		89	our %EXTICMD = ();
		90	our %EXT_CORO = (); # coroutines bound to extensions
		91	our %EXT_MAP = (); # pluggable maps
35		92
36	_init_vars;	93	our $RELOAD; # number of reloads so far, non-zero while in reload
37
38	our @EVENT;	94	our @EVENT;
39	our $LIBDIR = datadir . "/ext";	95	our @REFLECT; # set by XS
		96	our %REFLECT; # set by us
40		97
41	our $TICK = MAX_TIME * 1e-6;	98	our $CONFDIR = confdir;
42	our $TICK_WATCHER;	99	our $DATADIR = datadir;
		100	our $LIBDIR = "$DATADIR/ext";
		101	our $PODDIR = "$DATADIR/pod";
		102	our $MAPDIR = "$DATADIR/" . mapdir;
		103	our $LOCALDIR = localdir;
		104	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		105	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		106	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		107	our $RANDOMDIR = "$LOCALDIR/random";
		108	our $BDBDIR = "$LOCALDIR/db";
		109	our $PIDFILE = "$LOCALDIR/pid";
		110	our $RUNTIMEFILE = "$LOCALDIR/runtime";
		111
		112	our %RESOURCE;
		113
		114	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
		115	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
43	our $NEXT_TICK;	116	our $NEXT_TICK;
		117	our $USE_FSYNC = 1; # use fsync to write maps - default on
		118
		119	our $BDB_DEADLOCK_WATCHER;
		120	our $BDB_CHECKPOINT_WATCHER;
		121	our $BDB_TRICKLE_WATCHER;
		122	our $DB_ENV;
		123
		124	our @EXTRA_MODULES = qw(pod match mapscript);
44		125
45	our %CFG;	126	our %CFG;
46		127
47	our $UPTIME; $UPTIME ||= time;	128	our $UPTIME; $UPTIME ||= time;
		129	our $RUNTIME;
		130	our $NOW;
		131
		132	our (%PLAYER, %PLAYER_LOADING); # all users
		133	our (%MAP, %MAP_LOADING ); # all maps
		134	our $LINK_MAP; # the special {link} map, which is always available
		135
		136	# used to convert map paths into valid unix filenames by replacing / by ∕
		137	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		138
		139	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		140	our $LOADAVG; # same thing, but with alpha-smoothing
		141	our $JITTER; # average jitter
		142	our $TICK_START; # for load detecting purposes
		143
		144	our @POST_INIT;
		145
		146	our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
		147	our $REALLY_UNLOOP; # never set to true, please :)
		148
		149	binmode STDOUT;
		150	binmode STDERR;
		151
		152	# read virtual server time, if available
		153	unless ($RUNTIME || !-e $RUNTIMEFILE) {
		154	open my $fh, "<", $RUNTIMEFILE
		155	or die "unable to read $RUNTIMEFILE file: $!";
		156	$RUNTIME = <$fh> + 0.;
		157	}
		158
		159	eval "sub TICK() { $TICK } 1" or die;
		160
		161	mkdir $_
		162	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
		163
		164	our $EMERGENCY_POSITION;
		165
		166	sub cf::map::normalise;
48		167
49	#############################################################################	168	#############################################################################
50		169
		170	%REFLECT = ();
		171	for (@REFLECT) {
		172	my $reflect = JSON::XS::decode_json $_;
		173	$REFLECT{$reflect->{class}} = $reflect;
		174	}
		175
		176	# this is decidedly evil
		177	$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
		178
		179	#############################################################################
		180
51	=head2 GLOBAL VARIABLES	181	=head2 GLOBAL VARIABLES
52		182
53	=over 4	183	=over 4
54		184
55	=item $cf::UPTIME	185	=item $cf::UPTIME
56		186
57	The timestamp of the server start (so not actually an uptime).	187	The timestamp of the server start (so not actually an uptime).
58		188
59	=item $cf::LIBDIR	189	=item $cf::RUNTIME
60		190
61	The perl library directory, where extensions and cf-specific modules can	191	The time this server has run, starts at 0 and is increased by $cf::TICK on
62	be found. It will be added to C<@INC> automatically.	192	every server tick.
		193
		194	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		195	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		196	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
		197
		198	Various directories - "/etc", read-only install directory, perl-library
		199	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		200	unique-items directory, player file directory, random maps directory and
		201	database environment.
		202
		203	=item $cf::NOW
		204
		205	The time of the last (current) server tick.
63		206
64	=item $cf::TICK	207	=item $cf::TICK
65		208
66	The interval between server ticks, in seconds.	209	The interval between server ticks, in seconds.
67		210
		211	=item $cf::LOADAVG
		212
		213	The current CPU load on the server (alpha-smoothed), as a value between 0
		214	(none) and 1 (overloaded), indicating how much time is spent on processing
		215	objects per tick. Healthy values are < 0.5.
		216
		217	=item $cf::LOAD
		218
		219	The raw value load value from the last tick.
		220
68	=item %cf::CFG	221	=item %cf::CFG
69		222
70	Configuration for the server, loaded from C</etc/crossfire/config>, or	223	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
71	from wherever your confdir points to.	224	from wherever your confdir points to.
72		225
		226	=item cf::wait_for_tick, cf::wait_for_tick_begin
		227
		228	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		229	returns directly I<after> the tick processing (and consequently, can only wake one process
		230	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		231
		232	=item @cf::INVOKE_RESULTS
		233
		234	This array contains the results of the last C<invoke ()> call. When
		235	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		236	that call.
		237
		238	=item %cf::REFLECT
		239
		240	Contains, for each (C++) class name, a hash reference with information
		241	about object members (methods, scalars, arrays and flags) and other
		242	metadata, which is useful for introspection.
		243
73	=back	244	=back
74		245
75	=cut	246	=cut
76		247
77	BEGIN {	248	$Coro::State::WARNHOOK = sub {
78	*CORE::GLOBAL::warn = sub {
79	my $msg = join "", @_;	249	my $msg = join "", @_;
		250
80	$msg .= "\n"	251	$msg .= "\n"
81	unless $msg =~ /\n$/;	252	unless $msg =~ /\n$/;
82		253
83	print STDERR "cfperl: $msg";	254	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		255
84	LOG llevError, "cfperl: $msg";	256	LOG llevError, $msg;
85	};	257	};
86	}	258
		259	$Coro::State::DIEHOOK = sub {
		260	return unless $^S eq 0; # "eq", not "=="
		261
		262	warn Carp::longmess $_[0];
		263
		264	if ($Coro::current == $Coro::main) {#d#
		265	warn "DIEHOOK called in main context, Coro bug?\n";#d#
		266	return;#d#
		267	}#d#
		268
		269	# kill coroutine otherwise
		270	Coro::terminate
		271	};
87		272
88	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	273	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
89	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	274	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
90	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	275	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
91	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	276	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
92	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	277	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		278	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
93	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	279	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
94		280
95	# we bless all objects into (empty) derived classes to force a method lookup	281	# we bless all objects into (empty) derived classes to force a method lookup
96	# within the Safe compartment.	282	# within the Safe compartment.
97	for my $pkg (qw(	283	for my $pkg (qw(
98	cf::global	284	cf::global cf::attachable
99	cf::object cf::object::player	285	cf::object cf::object::player
100	cf::client cf::player	286	cf::client cf::player
101	cf::arch cf::living	287	cf::arch cf::living
		288	cf::map cf::mapspace
102	cf::map cf::party cf::region	289	cf::party cf::region
103	)) {	290	)) {
104	no strict 'refs';
105	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	291	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
106	}	292	}
107		293
108	$Event::DIED = sub {	294	$EV::DIED = sub {
109	warn "error in event callback: @_";	295	Carp::cluck "error in event callback: @_";
110	};	296	};
111		297
112	my %ext_pkg;	298	#############################################################################
113	my @exts;
114	my @hook;
115		299
116	=head2 UTILITY FUNCTIONS	300	=head2 UTILITY FUNCTIONS
117		301
118	=over 4	302	=over 4
119		303
120	=cut	304	=item dumpval $ref
121		305
122	use JSON::Syck (); # TODO# replace by JSON::PC once working	306	=cut
123		307
		308	sub dumpval {
		309	eval {
		310	local $SIG{__DIE__};
		311	my $d;
		312	if (1) {
		313	$d = new Data::Dumper([$_[0]], ["*var"]);
		314	$d->Terse(1);
		315	$d->Indent(2);
		316	$d->Quotekeys(0);
		317	$d->Useqq(1);
		318	#$d->Bless(...);
		319	$d->Seen($_[1]) if @_ > 1;
		320	$d = $d->Dump();
		321	}
		322	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		323	$d
		324	} || "[unable to dump $_[0]: '$@']";
		325	}
		326
124	=item $ref = cf::from_json $json	327	=item $ref = cf::decode_json $json
125		328
126	Converts a JSON string into the corresponding perl data structure.	329	Converts a JSON string into the corresponding perl data structure.
127		330
128	=cut
129
130	sub from_json($) {
131	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
132	JSON::Syck::Load $_[0]
133	}
134
135	=item $json = cf::to_json $ref	331	=item $json = cf::encode_json $ref
136		332
137	Converts a perl data structure into its JSON representation.	333	Converts a perl data structure into its JSON representation.
138		334
139	=cut	335	=cut
140		336
141	sub to_json($) {	337	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
142	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	338
143	JSON::Syck::Dump $_[0]	339	sub encode_json($) { $json_coder->encode ($_[0]) }
		340	sub decode_json($) { $json_coder->decode ($_[0]) }
		341
		342	=item cf::post_init { BLOCK }
		343
		344	Execute the given codeblock, I<after> all extensions have been (re-)loaded,
		345	but I<before> the server starts ticking again.
		346
		347	The cdoeblock will have a single boolean argument to indicate whether this
		348	is a reload or not.
		349
		350	=cut
		351
		352	sub post_init(&) {
		353	push @POST_INIT, shift;
		354	}
		355
		356	=item cf::lock_wait $string
		357
		358	Wait until the given lock is available. See cf::lock_acquire.
		359
		360	=item my $lock = cf::lock_acquire $string
		361
		362	Wait until the given lock is available and then acquires it and returns
		363	a L<Guard> object. If the guard object gets destroyed (goes out of scope,
		364	for example when the coroutine gets canceled), the lock is automatically
		365	returned.
		366
		367	Locks are *not* recursive, locking from the same coro twice results in a
		368	deadlocked coro.
		369
		370	Lock names should begin with a unique identifier (for example, cf::map::find
		371	uses map_find and cf::map::load uses map_load).
		372
		373	=item $locked = cf::lock_active $string
		374
		375	Return true if the lock is currently active, i.e. somebody has locked it.
		376
		377	=cut
		378
		379	our $LOCKS = new Coro::SemaphoreSet;
		380
		381	sub lock_wait($) {
		382	$LOCKS->wait ($_[0]);
		383	}
		384
		385	sub lock_acquire($) {
		386	$LOCKS->guard ($_[0])
		387	}
		388
		389	sub lock_active($) {
		390	$LOCKS->count ($_[0]) < 1
		391	}
		392
		393	sub freeze_mainloop {
		394	tick_inhibit_inc;
		395
		396	&Guard::guard (\&tick_inhibit_dec);
		397	}
		398
		399	=item cf::periodic $interval, $cb
		400
		401	Like EV::periodic, but randomly selects a starting point so that the actions
		402	get spread over timer.
		403
		404	=cut
		405
		406	sub periodic($$) {
		407	my ($interval, $cb) = @_;
		408
		409	my $start = rand List::Util::min 180, $interval;
		410
		411	EV::periodic $start, $interval, 0, $cb
		412	}
		413
		414	=item cf::get_slot $time[, $priority[, $name]]
		415
		416	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		417	This call blocks and returns only when you have at least C<$time> seconds
		418	of cpu time till the next tick. The slot is only valid till the next cede.
		419
		420	The optional C<$name> can be used to identify the job to run. It might be
		421	used for statistical purposes and should identify the same time-class.
		422
		423	Useful for short background jobs.
		424
		425	=cut
		426
		427	our @SLOT_QUEUE;
		428	our $SLOT_QUEUE;
		429
		430	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		431	$SLOT_QUEUE = Coro::async {
		432	$Coro::current->desc ("timeslot manager");
		433
		434	my $signal = new Coro::Signal;
		435
		436	while () {
		437	next_job:
		438	my $avail = cf::till_tick;
		439	if ($avail > 0.01) {
		440	for (0 .. $#SLOT_QUEUE) {
		441	if ($SLOT_QUEUE[$_][0] < $avail) {
		442	my $job = splice @SLOT_QUEUE, $_, 1, ();
		443	$job->[2]->send;
		444	Coro::cede;
		445	goto next_job;
		446	}
		447	}
		448	}
		449
		450	if (@SLOT_QUEUE) {
		451	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		452	push @cf::WAIT_FOR_TICK, $signal;
		453	$signal->wait;
		454	} else {
		455	Coro::schedule;
		456	}
		457	}
		458	};
		459
		460	sub get_slot($;$$) {
		461	return if tick_inhibit || $Coro::current == $Coro::main;
		462
		463	my ($time, $pri, $name) = @_;
		464
		465	$time = $TICK * .6 if $time > $TICK * .6;
		466	my $sig = new Coro::Signal;
		467
		468	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		469	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		470	$SLOT_QUEUE->ready;
		471	$sig->wait;
		472	}
		473
		474	=item cf::async { BLOCK }
		475
		476	Currently the same as Coro::async_pool, meaning you cannot use
		477	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		478	thing you are allowed to do is call C<prio> on it.
		479
		480	=cut
		481
		482	BEGIN { *async = \&Coro::async_pool }
		483
		484	=item cf::sync_job { BLOCK }
		485
		486	The design of Deliantra requires that the main coroutine ($Coro::main)
		487	is always able to handle events or runnable, as Deliantra is only
		488	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		489	acceptable.
		490
		491	If it must be done, put the blocking parts into C<sync_job>. This will run
		492	the given BLOCK in another coroutine while waiting for the result. The
		493	server will be frozen during this time, so the block should either finish
		494	fast or be very important.
		495
		496	=cut
		497
		498	sub sync_job(&) {
		499	my ($job) = @_;
		500
		501	if ($Coro::current == $Coro::main) {
		502	my $time = EV::time;
		503
		504	# this is the main coro, too bad, we have to block
		505	# till the operation succeeds, freezing the server :/
		506
		507	LOG llevError, Carp::longmess "sync job";#d#
		508
		509	my $freeze_guard = freeze_mainloop;
		510
		511	my $busy = 1;
		512	my @res;
		513
		514	(async {
		515	$Coro::current->desc ("sync job coro");
		516	@res = eval { $job->() };
		517	warn $@ if $@;
		518	undef $busy;
		519	})->prio (Coro::PRIO_MAX);
		520
		521	while ($busy) {
		522	if (Coro::nready) {
		523	Coro::cede_notself;
		524	} else {
		525	EV::loop EV::LOOP_ONESHOT;
		526	}
		527	}
		528
		529	my $time = EV::time - $time;
		530
		531	$TICK_START += $time; # do not account sync jobs to server load
		532
		533	wantarray ? @res : $res[0]
		534	} else {
		535	# we are in another coroutine, how wonderful, everything just works
		536
		537	$job->()
		538	}
		539	}
		540
		541	=item $coro = cf::async_ext { BLOCK }
		542
		543	Like async, but this coro is automatically being canceled when the
		544	extension calling this is being unloaded.
		545
		546	=cut
		547
		548	sub async_ext(&) {
		549	my $cb = shift;
		550
		551	my $coro = &Coro::async ($cb);
		552
		553	$coro->on_destroy (sub {
		554	delete $EXT_CORO{$coro+0};
		555	});
		556	$EXT_CORO{$coro+0} = $coro;
		557
		558	$coro
		559	}
		560
		561	=item fork_call { }, $args
		562
		563	Executes the given code block with the given arguments in a seperate
		564	process, returning the results. Everything must be serialisable with
		565	Coro::Storable. May, of course, block. Note that the executed sub may
		566	never block itself or use any form of event handling.
		567
		568	=cut
		569
		570	sub fork_call(&@) {
		571	my ($cb, @args) = @_;
		572
		573	# we seemingly have to make a local copy of the whole thing,
		574	# otherwise perl prematurely frees the stuff :/
		575	# TODO: investigate and fix (likely this will be rather laborious)
		576
		577	my @res = Coro::Util::fork_eval {
		578	reset_signals;
		579	&$cb
		580	}, @args;
		581
		582	wantarray ? @res : $res[-1]
		583	}
		584
		585	=item $coin = coin_from_name $name
		586
		587	=cut
		588
		589	our %coin_alias = (
		590	"silver" => "silvercoin",
		591	"silvercoin" => "silvercoin",
		592	"silvercoins" => "silvercoin",
		593	"gold" => "goldcoin",
		594	"goldcoin" => "goldcoin",
		595	"goldcoins" => "goldcoin",
		596	"platinum" => "platinacoin",
		597	"platinumcoin" => "platinacoin",
		598	"platinumcoins" => "platinacoin",
		599	"platina" => "platinacoin",
		600	"platinacoin" => "platinacoin",
		601	"platinacoins" => "platinacoin",
		602	"royalty" => "royalty",
		603	"royalties" => "royalty",
		604	);
		605
		606	sub coin_from_name($) {
		607	$coin_alias{$_[0]}
		608	? cf::arch::find $coin_alias{$_[0]}
		609	: undef
		610	}
		611
		612	=item $value = cf::db_get $family => $key
		613
		614	Returns a single value from the environment database.
		615
		616	=item cf::db_put $family => $key => $value
		617
		618	Stores the given C<$value> in the family. It can currently store binary
		619	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		620
		621	=item $db = cf::db_table "name"
		622
		623	Create and/or open a new database table. The string must not be "db" and must be unique
		624	within each server.
		625
		626	=cut
		627
		628	sub db_table($) {
		629	my ($name) = @_;
		630	my $db = BDB::db_create $DB_ENV;
		631
		632	eval {
		633	$db->set_flags (BDB::CHKSUM);
		634
		635	utf8::encode $name;
		636	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		637	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		638	cf::cleanup "db_open(db): $!" if $!;
		639	};
		640	cf::cleanup "db_open(db): $@" if $@;
		641
		642	$db
		643	}
		644
		645	our $DB;
		646
		647	sub db_init {
		648	cf::sync_job {
		649	$DB ||= db_table "db";
		650	};
		651	}
		652
		653	sub db_get($$) {
		654	my $key = "$_[0]/$_[1]";
		655
		656	cf::sync_job {
		657	BDB::db_get $DB, undef, $key, my $data;
		658
		659	$! ? ()
		660	: $data
		661	}
		662	}
		663
		664	sub db_put($$$) {
		665	BDB::dbreq_pri 4;
		666	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		667	}
		668
		669	=item cf::cache $id => [$paths...], $processversion => $process
		670
		671	Generic caching function that returns the value of the resource $id,
		672	caching and regenerating as required.
		673
		674	This function can block.
		675
		676	=cut
		677
		678	sub cache {
		679	my ($id, $src, $processversion, $process) = @_;
		680
		681	my $meta =
		682	join "\x00",
		683	$processversion,
		684	map {
		685	aio_stat $_
		686	and Carp::croak "$_: $!";
		687
		688	($_, (stat _)[7,9])
		689	} @$src;
		690
		691	my $dbmeta = db_get cache => "$id/meta";
		692	if ($dbmeta ne $meta) {
		693	# changed, we may need to process
		694
		695	my @data;
		696	my $md5;
		697
		698	for (0 .. $#$src) {
		699	0 <= aio_load $src->[$_], $data[$_]
		700	or Carp::croak "$src->[$_]: $!";
		701	}
		702
		703	# if processing is expensive, check
		704	# checksum first
		705	if (1) {
		706	$md5 =
		707	join "\x00",
		708	$processversion,
		709	map {
		710	cf::cede_to_tick;
		711	($src->[$_], Digest::MD5::md5_hex $data[$_])
		712	} 0.. $#$src;
		713
		714
		715	my $dbmd5 = db_get cache => "$id/md5";
		716	if ($dbmd5 eq $md5) {
		717	db_put cache => "$id/meta", $meta;
		718
		719	return db_get cache => "$id/data";
		720	}
		721	}
		722
		723	my $t1 = Time::HiRes::time;
		724	my $data = $process->(\@data);
		725	my $t2 = Time::HiRes::time;
		726
		727	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		728
		729	db_put cache => "$id/data", $data;
		730	db_put cache => "$id/md5" , $md5;
		731	db_put cache => "$id/meta", $meta;
		732
		733	return $data;
		734	}
		735
		736	db_get cache => "$id/data"
		737	}
		738
		739	=item cf::datalog type => key => value, ...
		740
		741	Log a datalog packet of the given type with the given key-value pairs.
		742
		743	=cut
		744
		745	sub datalog($@) {
		746	my ($type, %kv) = @_;
		747	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
144	}	748	}
145		749
146	=back	750	=back
147		751
148	=cut	752	=cut
149		753
150	#############################################################################	754	#############################################################################
151		755
152	=head2 ATTACHABLE OBJECTS	756	=head2 ATTACHABLE OBJECTS
153		757
154	Many objects in crossfire are so-called attachable objects. That means you can	758	Many objects in deliantra are so-called attachable objects. That means you can
155	attach callbacks/event handlers (a collection of which is called an "attachment")	759	attach callbacks/event handlers (a collection of which is called an "attachment")
156	to it. All such attachable objects support the following methods.	760	to it. All such attachable objects support the following methods.
157		761
158	In the following description, CLASS can be any of C<global>, C<object>	762	In the following description, CLASS can be any of C<global>, C<object>
159	C<player>, C<client> or C<map> (i.e. the attachable objects in	763	C<player>, C<client> or C<map> (i.e. the attachable objects in
160	crossfire+).	764	Deliantra).
161		765
162	=over 4	766	=over 4
163		767
164	=item $attachable->attach ($attachment, key => $value...)	768	=item $attachable->attach ($attachment, key => $value...)
165		769
…		…
209	=item cf::CLASS::attachment $name, ...	813	=item cf::CLASS::attachment $name, ...
210		814
211	Register an attachment by C<$name> through which attachable objects of the	815	Register an attachment by C<$name> through which attachable objects of the
212	given CLASS can refer to this attachment.	816	given CLASS can refer to this attachment.
213		817
214	Some classes such as crossfire maps and objects can specify attachments	818	Some classes such as deliantra maps and objects can specify attachments
215	that are attached at load/instantiate time, thus the need for a name.	819	that are attached at load/instantiate time, thus the need for a name.
216		820
217	These calls expect any number of the following handler/hook descriptions:	821	These calls expect any number of the following handler/hook descriptions:
218		822
219	=over 4	823	=over 4
…		…
269	exception.	873	exception.
270		874
271	=cut	875	=cut
272		876
273	# the following variables are defined in .xs and must not be re-created	877	# the following variables are defined in .xs and must not be re-created
274	our @CB_GLOBAL = (); # registry for all global events	878	our @CB_GLOBAL = (); # registry for all global events
		879	our @CB_ATTACHABLE = (); # registry for all attachables
275	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	880	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
276	our @CB_PLAYER = ();	881	our @CB_PLAYER = ();
277	our @CB_CLIENT = ();	882	our @CB_CLIENT = ();
278	our @CB_TYPE = (); # registry for type (cf-object class) based events	883	our @CB_TYPE = (); # registry for type (cf-object class) based events
279	our @CB_MAP = ();	884	our @CB_MAP = ();
280		885
281	my %attachment;	886	my %attachment;
		887
		888	sub cf::attachable::thawer_merge {
		889	# simply override everything except _meta
		890	local $_[0]{_meta};
		891	%{$_[0]} = %{$_[1]};
		892	}
282		893
283	sub _attach_cb($$$$) {	894	sub _attach_cb($$$$) {
284	my ($registry, $event, $prio, $cb) = @_;	895	my ($registry, $event, $prio, $cb) = @_;
285		896
286	use sort 'stable';	897	use sort 'stable';
…		…
289		900
290	@{$registry->[$event]} = sort	901	@{$registry->[$event]} = sort
291	{ $a->[0] cmp $b->[0] }	902	{ $a->[0] cmp $b->[0] }
292	@{$registry->[$event] || []}, $cb;	903	@{$registry->[$event] || []}, $cb;
293	}	904	}
		905
		906	# hack
		907	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
294		908
295	# attach handles attaching event callbacks	909	# attach handles attaching event callbacks
296	# the only thing the caller has to do is pass the correct	910	# the only thing the caller has to do is pass the correct
297	# registry (== where the callback attaches to).	911	# registry (== where the callback attaches to).
298	sub _attach {	912	sub _attach {
…		…
300		914
301	my $object_type;	915	my $object_type;
302	my $prio = 0;	916	my $prio = 0;
303	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	917	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
304		918
		919	#TODO: get rid of this hack
		920	if ($attachable_klass{$klass}) {
		921	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		922	}
		923
305	while (@arg) {	924	while (@arg) {
306	my $type = shift @arg;	925	my $type = shift @arg;
307		926
308	if ($type eq "prio") {	927	if ($type eq "prio") {
309	$prio = shift @arg;	928	$prio = shift @arg;
…		…
313	$registry = $CB_TYPE[$object_type] ||= [];	932	$registry = $CB_TYPE[$object_type] ||= [];
314		933
315	} elsif ($type eq "subtype") {	934	} elsif ($type eq "subtype") {
316	defined $object_type or Carp::croak "subtype specified without type";	935	defined $object_type or Carp::croak "subtype specified without type";
317	my $object_subtype = shift @arg;	936	my $object_subtype = shift @arg;
318	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	937	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
319		938
320	} elsif ($type eq "package") {	939	} elsif ($type eq "package") {
321	my $pkg = shift @arg;	940	my $pkg = shift @arg;
322		941
323	while (my ($name, $id) = each %cb_id) {	942	while (my ($name, $id) = each %cb_id) {
…		…
352	_attach $registry, $klass, @attach;	971	_attach $registry, $klass, @attach;
353	}	972	}
354		973
355	$obj->{$name} = \%arg;	974	$obj->{$name} = \%arg;
356	} else {	975	} else {
357	warn "object uses attachment '$name' that is not available, postponing.\n";	976	warn "object uses attachment '$name' which is not available, postponing.\n";
358	}	977	}
359		978
360	$obj->{_attachment}{$name} = undef;	979	$obj->{_attachment}{$name} = undef;
361	}	980	}
362		981
…		…
364	if (ref $_[0]) {	983	if (ref $_[0]) {
365	_object_attach @_;	984	_object_attach @_;
366	} else {	985	} else {
367	_attach shift->_attach_registry, @_;	986	_attach shift->_attach_registry, @_;
368	}	987	}
		988	_recalc_want;
369	};	989	};
370		990
371	# all those should be optimised	991	# all those should be optimised
372	sub cf::attachable::detach {	992	sub cf::attachable::detach {
373	my ($obj, $name) = @_;	993	my ($obj, $name) = @_;
…		…
376	delete $obj->{_attachment}{$name};	996	delete $obj->{_attachment}{$name};
377	reattach ($obj);	997	reattach ($obj);
378	} else {	998	} else {
379	Carp::croak "cannot, currently, detach class attachments";	999	Carp::croak "cannot, currently, detach class attachments";
380	}	1000	}
		1001	_recalc_want;
381	};	1002	};
382		1003
383	sub cf::attachable::attached {	1004	sub cf::attachable::attached {
384	my ($obj, $name) = @_;	1005	my ($obj, $name) = @_;
385		1006
386	exists $obj->{_attachment}{$name}	1007	exists $obj->{_attachment}{$name}
387	}	1008	}
388		1009
389	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {	1010	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
390	eval "#line " . __LINE__ . " 'cf.pm'	1011	eval "#line " . __LINE__ . " 'cf.pm'
391	sub cf::\L$klass\E::_attach_registry {	1012	sub cf::\L$klass\E::_attach_registry {
392	(\\\@CB_$klass, KLASS_$klass)	1013	(\\\@CB_$klass, KLASS_$klass)
393	}	1014	}
394		1015
…		…
400	";	1021	";
401	die if $@;	1022	die if $@;
402	}	1023	}
403		1024
404	our $override;	1025	our $override;
405	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	1026	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
406		1027
407	sub override {	1028	sub override {
408	$override = 1;	1029	$override = 1;
409	@invoke_results = ();	1030	@INVOKE_RESULTS = (@_);
410	}	1031	}
411		1032
412	sub do_invoke {	1033	sub do_invoke {
413	my $event = shift;	1034	my $event = shift;
414	my $callbacks = shift;	1035	my $callbacks = shift;
415		1036
416	@invoke_results = ();	1037	@INVOKE_RESULTS = ();
417		1038
418	local $override;	1039	local $override;
419		1040
420	for (@$callbacks) {	1041	for (@$callbacks) {
421	eval { &{$_->[1]} };	1042	eval { &{$_->[1]} };
…		…
430	}	1051	}
431		1052
432	0	1053	0
433	}	1054	}
434		1055
435	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1056	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
436		1057
437	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1058	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
438		1059
439	Generate an object-specific event with the given arguments.	1060	Generate an object-specific event with the given arguments.
440		1061
441	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	1062	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
442	removed in future versions), and there is no public API to access override	1063	removed in future versions), and there is no public API to access override
443	results (if you must, access C<@cf::invoke_results> directly).	1064	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
444		1065
445	=back	1066	=back
446		1067
447	=cut	1068	=cut
448		1069
449	#############################################################################	1070	#############################################################################
450	# object support	1071	# object support
451		1072
452	sub instantiate {	1073	sub _object_equal($$);
		1074	sub _object_equal($$) {
		1075	my ($a, $b) = @_;
		1076
		1077	return 0 unless (ref $a) eq (ref $b);
		1078
		1079	if ("HASH" eq ref $a) {
		1080	my @ka = keys %$a;
		1081	my @kb = keys %$b;
		1082
		1083	return 0 if @ka != @kb;
		1084
		1085	for (0 .. $#ka) {
		1086	return 0 unless $ka[$_] eq $kb[$_];
		1087	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		1088	}
		1089
		1090	} elsif ("ARRAY" eq ref $a) {
		1091
		1092	return 0 if @$a != @$b;
		1093
		1094	for (0 .. $#$a) {
		1095	return 0 unless _object_equal $a->[$_], $b->[$_];
		1096	}
		1097
		1098	} elsif ($a ne $b) {
		1099	return 0;
		1100	}
		1101
		1102	1
		1103	}
		1104
		1105	our $SLOW_MERGES;#d#
		1106	sub _can_merge {
453	my ($obj, $data) = @_;	1107	my ($ob1, $ob2) = @_;
454		1108
455	$data = from_json $data;	1109	++$SLOW_MERGES;#d#
456		1110
457	for (@$data) {	1111	# we do the slow way here
458	my ($name, $args) = @$_;	1112	return _object_equal $ob1, $ob2
459
460	$obj->attach ($name, %{$args || {} });
461	}
462	}	1113	}
463		1114
464	# basically do the same as instantiate, without calling instantiate
465	sub reattach {	1115	sub reattach {
		1116	# basically do the same as instantiate, without calling instantiate
466	my ($obj) = @_;	1117	my ($obj) = @_;
		1118
		1119	# no longer needed after getting rid of delete_package?
		1120	#bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		1121
467	my $registry = $obj->registry;	1122	my $registry = $obj->registry;
468		1123
469	@$registry = ();	1124	@$registry = ();
470		1125
471	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	1126	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
…		…
480	warn "object uses attachment '$name' that is not available, postponing.\n";	1135	warn "object uses attachment '$name' that is not available, postponing.\n";
481	}	1136	}
482	}	1137	}
483	}	1138	}
484		1139
485	sub object_freezer_save {	1140	cf::attachable->attach (
486	my ($filename, $rdata, $objs) = @_;
487
488	if (length $$rdata) {
489	warn sprintf "saving %s (%d,%d)\n",
490	$filename, length $$rdata, scalar @$objs;
491
492	if (open my $fh, ">:raw", "$filename~") {
493	chmod SAVE_MODE, $fh;
494	syswrite $fh, $$rdata;
495	close $fh;
496
497	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
498	chmod SAVE_MODE, $fh;
499	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
500	close $fh;
501	rename "$filename.pst~", "$filename.pst";
502	} else {
503	unlink "$filename.pst";
504	}
505
506	rename "$filename~", $filename;
507	} else {
508	warn "FATAL: $filename~: $!\n";
509	}
510	} else {
511	unlink $filename;
512	unlink "$filename.pst";
513	}
514	}
515
516	sub object_freezer_as_string {
517	my ($rdata, $objs) = @_;
518
519	use Data::Dumper;
520
521	$$rdata . Dumper $objs
522	}
523
524	sub object_thawer_load {
525	my ($filename) = @_;
526
527	local $/;
528
529	my $av;
530
531	#TODO: use sysread etc.
532	if (open my $data, "<:raw:perlio", $filename) {
533	$data = <$data>;
534	if (open my $pst, "<:raw:perlio", "$filename.pst") {
535	$av = eval { (Storable::thaw <$pst>)->{objs} };
536	}
537	return ($data, $av);
538	}
539
540	()
541	}
542
543	cf::object->attach (
544	prio => -1000000,	1141	prio => -1000000,
		1142	on_instantiate => sub {
		1143	my ($obj, $data) = @_;
		1144
		1145	$data = decode_json $data;
		1146
		1147	for (@$data) {
		1148	my ($name, $args) = @$_;
		1149
		1150	$obj->attach ($name, %{$args || {} });
		1151	}
		1152	},
		1153	on_reattach => \&reattach,
545	on_clone => sub {	1154	on_clone => sub {
546	my ($src, $dst) = @_;	1155	my ($src, $dst) = @_;
547		1156
548	@{$dst->registry} = @{$src->registry};	1157	@{$dst->registry} = @{$src->registry};
549		1158
…		…
552	%{$dst->{_attachment}} = %{$src->{_attachment}}	1161	%{$dst->{_attachment}} = %{$src->{_attachment}}
553	if exists $src->{_attachment};	1162	if exists $src->{_attachment};
554	},	1163	},
555	);	1164	);
556		1165
		1166	sub object_freezer_save {
		1167	my ($filename, $rdata, $objs) = @_;
		1168
		1169	sync_job {
		1170	if (length $$rdata) {
		1171	utf8::decode (my $decname = $filename);
		1172	warn sprintf "saving %s (%d,%d)\n",
		1173	$decname, length $$rdata, scalar @$objs;
		1174
		1175	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		1176	aio_chmod $fh, SAVE_MODE;
		1177	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		1178	if ($cf::USE_FSYNC) {
		1179	aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
		1180	aio_fsync $fh;
		1181	}
		1182	aio_close $fh;
		1183
		1184	if (@$objs) {
		1185	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		1186	aio_chmod $fh, SAVE_MODE;
		1187	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
		1188	aio_write $fh, 0, (length $data), $data, 0;
		1189	if ($cf::USE_FSYNC) {
		1190	aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
		1191	aio_fsync $fh;
		1192	}
		1193	aio_close $fh;
		1194	aio_rename "$filename.pst~", "$filename.pst";
		1195	}
		1196	} else {
		1197	aio_unlink "$filename.pst";
		1198	}
		1199
		1200	aio_rename "$filename~", $filename;
		1201
		1202	$filename =~ s%/[^/]+$%%;
		1203	aio_pathsync $filename if $cf::USE_FSYNC;
		1204	} else {
		1205	warn "unable to save objects: $filename~: $!\n";
		1206	}
		1207	} else {
		1208	aio_unlink $filename;
		1209	aio_unlink "$filename.pst";
		1210	}
		1211	};
		1212	}
		1213
		1214	sub object_freezer_as_string {
		1215	my ($rdata, $objs) = @_;
		1216
		1217	use Data::Dumper;
		1218
		1219	$$rdata . Dumper $objs
		1220	}
		1221
		1222	sub object_thawer_load {
		1223	my ($filename) = @_;
		1224
		1225	my ($data, $av);
		1226
		1227	(aio_load $filename, $data) >= 0
		1228	or return;
		1229
		1230	unless (aio_stat "$filename.pst") {
		1231	(aio_load "$filename.pst", $av) >= 0
		1232	or return;
		1233
		1234	my $st = eval { Coro::Storable::thaw $av };
		1235	$av = $st->{objs};
		1236	}
		1237
		1238	utf8::decode (my $decname = $filename);
		1239	warn sprintf "loading %s (%d,%d)\n",
		1240	$decname, length $data, scalar @{$av || []};
		1241
		1242	($data, $av)
		1243	}
		1244
		1245	=head2 COMMAND CALLBACKS
		1246
		1247	=over 4
		1248
		1249	=cut
		1250
557	#############################################################################	1251	#############################################################################
558	# command handling &c	1252	# command handling &c
559		1253
560	=item cf::register_command $name => \&callback($ob,$args);	1254	=item cf::register_command $name => \&callback($ob,$args);
561		1255
…		…
573	push @{ $COMMAND{$name} }, [$caller, $cb];	1267	push @{ $COMMAND{$name} }, [$caller, $cb];
574	}	1268	}
575		1269
576	=item cf::register_extcmd $name => \&callback($pl,$packet);	1270	=item cf::register_extcmd $name => \&callback($pl,$packet);
577		1271
578	Register a callbackf ro execution when the client sends an extcmd packet.	1272	Register a callback for execution when the client sends an (synchronous)
		1273	extcmd packet. Ext commands will be processed in the order they are
		1274	received by the server, like other user commands. The first argument is
		1275	the logged-in player. Ext commands can only be processed after a player
		1276	has logged in successfully.
579		1277
580	If the callback returns something, it is sent back as if reply was being	1278	If the callback returns something, it is sent back as if reply was being
581	called.	1279	called.
582		1280
		1281	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1282
		1283	Register a callback for execution when the client sends an (asynchronous)
		1284	exticmd packet. Exti commands are processed by the server as soon as they
		1285	are received, i.e. out of order w.r.t. other commands. The first argument
		1286	is a client socket. Exti commands can be received anytime, even before
		1287	log-in.
		1288
		1289	If the callback returns something, it is sent back as if reply was being
		1290	called.
		1291
583	=cut	1292	=cut
584		1293
585	sub register_extcmd {	1294	sub register_extcmd {
586	my ($name, $cb) = @_;	1295	my ($name, $cb) = @_;
587		1296
588	my $caller = caller;
589	#warn "registering extcmd '$name' to '$caller'";
590
591	$EXTCMD{$name} = [$cb, $caller];	1297	$EXTCMD{$name} = $cb;
592	}	1298	}
		1299
		1300	sub register_exticmd {
		1301	my ($name, $cb) = @_;
		1302
		1303	$EXTICMD{$name} = $cb;
		1304	}
		1305
		1306	use File::Glob ();
593		1307
594	cf::player->attach (	1308	cf::player->attach (
595	on_command => sub {	1309	on_command => sub {
596	my ($pl, $name, $params) = @_;	1310	my ($pl, $name, $params) = @_;
597		1311
…		…
605	cf::override;	1319	cf::override;
606	},	1320	},
607	on_extcmd => sub {	1321	on_extcmd => sub {
608	my ($pl, $buf) = @_;	1322	my ($pl, $buf) = @_;
609		1323
610	my $msg = eval { from_json $buf };	1324	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
611		1325
612	if (ref $msg) {	1326	if (ref $msg) {
		1327	my ($type, $reply, @payload) =
		1328	"ARRAY" eq ref $msg
		1329	? @$msg
		1330	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1331
		1332	my @reply;
		1333
613	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1334	if (my $cb = $EXTCMD{$type}) {
614	if (my %reply = $cb->[0]->($pl, $msg)) {	1335	@reply = $cb->($pl, @payload);
615	$pl->ext_reply ($msg->{msgid}, %reply);
616	}
617	}	1336	}
		1337
		1338	$pl->ext_reply ($reply, @reply)
		1339	if $reply;
		1340
618	} else {	1341	} else {
619	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1342	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
620	}	1343	}
621		1344
622	cf::override;	1345	cf::override;
623	},	1346	},
624	);	1347	);
625		1348
		1349	# "readahead" all extensions
		1350	sub cache_extensions {
		1351	my $grp = IO::AIO::aio_group;
		1352
		1353	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
		1354	for (grep /\.ext$/, @{$_[0]}) {
		1355	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
		1356	}
		1357	};
		1358
		1359	$grp
		1360	}
		1361
		1362	sub load_extensions {
		1363	cf::sync_job {
		1364	my %todo;
		1365
		1366	for my $path (<$LIBDIR/*.ext>) {
		1367	next unless -r $path;
		1368
		1369	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1370	my $base = $1;
		1371	my $pkg = $1;
		1372	$pkg =~ s/[^[:word:]]/_/g;
		1373	$pkg = "ext::$pkg";
		1374
		1375	open my $fh, "<:utf8", $path
		1376	or die "$path: $!";
		1377
		1378	my $source = do { local $/; <$fh> };
		1379
		1380	my %ext = (
		1381	path => $path,
		1382	base => $base,
		1383	pkg => $pkg,
		1384	);
		1385
		1386	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1387	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1388
		1389	$ext{source} =
		1390	"package $pkg; use 5.10.0; use strict 'vars', 'subs'; use utf8;\n"
		1391	. "#line 1 \"$path\"\n{\n"
		1392	. $source
		1393	. "\n};\n1";
		1394
		1395	$todo{$base} = \%ext;
		1396	}
		1397
		1398	my %done;
		1399	while (%todo) {
		1400	my $progress;
		1401
		1402	while (my ($k, $v) = each %todo) {
		1403	for (split /,\s*/, $v->{meta}{depends}) {
		1404	goto skip
		1405	unless exists $done{$_};
		1406	}
		1407
		1408	warn "... loading '$k' into '$v->{pkg}'\n";
		1409
		1410	unless (eval $v->{source}) {
		1411	my $msg = $@ ? "$v->{path}: $@\n"
		1412	: "$v->{base}: extension inactive.\n";
		1413
		1414	if (exists $v->{meta}{mandatory}) {
		1415	warn $msg;
		1416	cf::cleanup "mandatory extension failed to load, exiting.";
		1417	}
		1418
		1419	warn $msg;
		1420	}
		1421
		1422	$done{$k} = delete $todo{$k};
		1423	push @EXTS, $v->{pkg};
		1424	$progress = 1;
		1425	}
		1426
		1427	skip:
		1428	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1429	unless $progress;
		1430	}
		1431	};
		1432	}
		1433
		1434	#############################################################################
		1435
		1436	=back
		1437
		1438	=head2 CORE EXTENSIONS
		1439
		1440	Functions and methods that extend core deliantra objects.
		1441
		1442	=cut
		1443
		1444	package cf::player;
		1445
		1446	use Coro::AIO;
		1447
		1448	=head3 cf::player
		1449
		1450	=over 4
		1451
		1452	=item cf::player::num_playing
		1453
		1454	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1455
		1456	=cut
		1457
		1458	sub num_playing {
		1459	scalar grep
		1460	$_->ob->map
		1461	&& !$_->hidden
		1462	&& !$_->ob->flag (cf::FLAG_WIZ),
		1463	cf::player::list
		1464	}
		1465
		1466	=item cf::player::find $login
		1467
		1468	Returns the given player object, loading it if necessary (might block).
		1469
		1470	=cut
		1471
		1472	sub playerdir($) {
		1473	"$PLAYERDIR/"
		1474	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1475	}
		1476
		1477	sub path($) {
		1478	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1479
		1480	(playerdir $login) . "/playerdata"
		1481	}
		1482
		1483	sub find_active($) {
		1484	$cf::PLAYER{$_[0]}
		1485	and $cf::PLAYER{$_[0]}->active
		1486	and $cf::PLAYER{$_[0]}
		1487	}
		1488
		1489	sub exists($) {
		1490	my ($login) = @_;
		1491
		1492	$cf::PLAYER{$login}
		1493	or !aio_stat path $login
		1494	}
		1495
		1496	sub find($) {
		1497	return $cf::PLAYER{$_[0]} || do {
		1498	my $login = $_[0];
		1499
		1500	my $guard = cf::lock_acquire "user_find:$login";
		1501
		1502	$cf::PLAYER{$_[0]} || do {
		1503	# rename old playerfiles to new ones
		1504	#TODO: remove when no longer required
		1505	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1506	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1507	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1508	aio_unlink +(playerdir $login) . "/$login.pl";
		1509
		1510	my $f = new_from_file cf::object::thawer path $login
		1511	or return;
		1512
		1513	my $pl = cf::player::load_pl $f
		1514	or return;
		1515
		1516	local $cf::PLAYER_LOADING{$login} = $pl;
		1517	$f->resolve_delayed_derefs;
		1518	$cf::PLAYER{$login} = $pl
		1519	}
		1520	}
		1521	}
		1522
		1523	sub save($) {
		1524	my ($pl) = @_;
		1525
		1526	return if $pl->{deny_save};
		1527
		1528	my $path = path $pl;
		1529	my $guard = cf::lock_acquire "user_save:$path";
		1530
		1531	return if $pl->{deny_save};
		1532
		1533	aio_mkdir playerdir $pl, 0770;
		1534	$pl->{last_save} = $cf::RUNTIME;
		1535
		1536	cf::get_slot 0.01;
		1537
		1538	$pl->save_pl ($path);
		1539	cf::cede_to_tick;
		1540	}
		1541
		1542	sub new($) {
		1543	my ($login) = @_;
		1544
		1545	my $self = create;
		1546
		1547	$self->ob->name ($login);
		1548	$self->{deny_save} = 1;
		1549
		1550	$cf::PLAYER{$login} = $self;
		1551
		1552	$self
		1553	}
		1554
		1555	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1556
		1557	=cut
		1558
		1559	sub send_msg {
		1560	my $ns = shift->ns
		1561	or return;
		1562	$ns->send_msg (@_);
		1563	}
		1564
		1565	=item $pl->quit_character
		1566
		1567	Nukes the player without looking back. If logged in, the connection will
		1568	be destroyed. May block for a long time.
		1569
		1570	=cut
		1571
		1572	sub quit_character {
		1573	my ($pl) = @_;
		1574
		1575	my $name = $pl->ob->name;
		1576
		1577	$pl->{deny_save} = 1;
		1578	$pl->password ("*"); # this should lock out the player until we have nuked the dir
		1579
		1580	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1581	$pl->deactivate;
		1582	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1583	$pl->ob->check_score;
		1584	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1585	$pl->ns->destroy if $pl->ns;
		1586
		1587	my $path = playerdir $pl;
		1588	my $temp = "$path~$cf::RUNTIME~deleting~";
		1589	aio_rename $path, $temp;
		1590	delete $cf::PLAYER{$pl->ob->name};
		1591	$pl->destroy;
		1592
		1593	my $prefix = qr<^~\Q$name\E/>;
		1594
		1595	# nuke player maps
		1596	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1597
		1598	IO::AIO::aio_rmtree $temp;
		1599	}
		1600
		1601	=item $pl->kick
		1602
		1603	Kicks a player out of the game. This destroys the connection.
		1604
		1605	=cut
		1606
		1607	sub kick {
		1608	my ($pl, $kicker) = @_;
		1609
		1610	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1611	$pl->killer ("kicked");
		1612	$pl->ns->destroy;
		1613	}
		1614
		1615	=item cf::player::list_logins
		1616
		1617	Returns am arrayref of all valid playernames in the system, can take a
		1618	while and may block, so not sync_job-capable, ever.
		1619
		1620	=cut
		1621
		1622	sub list_logins {
		1623	my $dirs = aio_readdir $PLAYERDIR
		1624	or return [];
		1625
		1626	my @logins;
		1627
		1628	for my $login (@$dirs) {
		1629	my $path = path $login;
		1630
		1631	# a .pst is a dead give-away for a valid player
		1632	# if no pst file found, open and chekc for blocked users
		1633	if (aio_stat "$path.pst") {
		1634	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
		1635	aio_read $fh, 0, 512, my $buf, 0 or next;
		1636	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1637	}
		1638
		1639	utf8::decode $login;
		1640	push @logins, $login;
		1641	}
		1642
		1643	\@logins
		1644	}
		1645
		1646	=item $player->maps
		1647
		1648	Returns an arrayref of map paths that are private for this
		1649	player. May block.
		1650
		1651	=cut
		1652
		1653	sub maps($) {
		1654	my ($pl) = @_;
		1655
		1656	$pl = ref $pl ? $pl->ob->name : $pl;
		1657
		1658	my $files = aio_readdir playerdir $pl
		1659	or return;
		1660
		1661	my @paths;
		1662
		1663	for (@$files) {
		1664	utf8::decode $_;
		1665	next if /\.(?:pl|pst)$/;
		1666	next unless /^$PATH_SEP/o;
		1667
		1668	push @paths, cf::map::normalise "~$pl/$_";
		1669	}
		1670
		1671	\@paths
		1672	}
		1673
		1674	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1675
		1676	Expand deliantra pod fragments into protocol xml.
		1677
		1678	=item $player->ext_reply ($msgid, @msg)
		1679
		1680	Sends an ext reply to the player.
		1681
		1682	=cut
		1683
		1684	sub ext_reply($$@) {
		1685	my ($self, $id, @msg) = @_;
		1686
		1687	$self->ns->ext_reply ($id, @msg)
		1688	}
		1689
		1690	=item $player->ext_msg ($type, @msg)
		1691
		1692	Sends an ext event to the client.
		1693
		1694	=cut
		1695
		1696	sub ext_msg($$@) {
		1697	my ($self, $type, @msg) = @_;
		1698
		1699	$self->ns->ext_msg ($type, @msg);
		1700	}
		1701
		1702	=head3 cf::region
		1703
		1704	=over 4
		1705
		1706	=cut
		1707
		1708	package cf::region;
		1709
		1710	=item cf::region::find_by_path $path
		1711
		1712	Tries to decuce the likely region for a map knowing only its path.
		1713
		1714	=cut
		1715
		1716	sub find_by_path($) {
		1717	my ($path) = @_;
		1718
		1719	my ($match, $specificity);
		1720
		1721	for my $region (list) {
		1722	if ($region->{match} && $path =~ $region->{match}) {
		1723	($match, $specificity) = ($region, $region->specificity)
		1724	if $region->specificity > $specificity;
		1725	}
		1726	}
		1727
		1728	$match
		1729	}
		1730
		1731	=back
		1732
		1733	=head3 cf::map
		1734
		1735	=over 4
		1736
		1737	=cut
		1738
		1739	package cf::map;
		1740
		1741	use Fcntl;
		1742	use Coro::AIO;
		1743
		1744	use overload
		1745	'""' => \&as_string,
		1746	fallback => 1;
		1747
		1748	our $MAX_RESET = 3600;
		1749	our $DEFAULT_RESET = 3000;
		1750
		1751	sub generate_random_map {
		1752	my ($self, $rmp) = @_;
		1753
		1754	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		1755
		1756	# mit "rum" bekleckern, nicht
		1757	$self->_create_random_map (
		1758	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1759	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1760	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1761	$rmp->{exit_on_final_map},
		1762	$rmp->{xsize}, $rmp->{ysize},
		1763	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1764	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1765	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1766	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1767	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1768	(cf::region::find $rmp->{region}), $rmp->{custom}
		1769	)
		1770	}
		1771
		1772	=item cf::map->register ($regex, $prio)
		1773
		1774	Register a handler for the map path matching the given regex at the
		1775	givne priority (higher is better, built-in handlers have priority 0, the
		1776	default).
		1777
		1778	=cut
		1779
626	sub register {	1780	sub register {
		1781	my (undef, $regex, $prio) = @_;
		1782	my $pkg = caller;
		1783
		1784	no strict;
		1785	push @{"$pkg\::ISA"}, __PACKAGE__;
		1786
		1787	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1788	}
		1789
		1790	# also paths starting with '/'
		1791	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1792
		1793	sub thawer_merge {
627	my ($base, $pkg) = @_;	1794	my ($self, $merge) = @_;
628		1795
629	#TODO	1796	# we have to keep some variables in memory intact
630	}	1797	local $self->{path};
		1798	local $self->{load_path};
631		1799
632	sub load_extension {	1800	$self->SUPER::thawer_merge ($merge);
		1801	}
		1802
		1803	sub normalise {
633	my ($path) = @_;	1804	my ($path, $base) = @_;
634		1805
635	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1806	$path = "$path"; # make sure its a string
636	my $base = $1;
637	my $pkg = $1;
638	$pkg =~ s/[^[:word:]]/_/g;
639	$pkg = "ext::$pkg";
640		1807
641	warn "loading '$path' into '$pkg'\n";	1808	$path =~ s/\.map$//;
642		1809
643	open my $fh, "<:utf8", $path	1810	# map plan:
644	or die "$path: $!";	1811	#
		1812	# /! non-realised random map exit (special hack!)
		1813	# {... are special paths that are not being touched
		1814	# ?xxx/... are special absolute paths
		1815	# ?random/... random maps
		1816	# /... normal maps
		1817	# ~user/... per-player map of a specific user
645		1818
646	my $source =	1819	$path =~ s/$PATH_SEP/\//go;
647	"package $pkg; use strict; use utf8;\n"
648	. "#line 1 \"$path\"\n{\n"
649	. (do { local $/; <$fh> })
650	. "\n};\n1";
651		1820
652	eval $source	1821	# treat it as relative path if it starts with
653	or die $@ ? "$path: $@\n"	1822	# something that looks reasonable
654	: "extension disabled.\n";	1823	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1824	$base or Carp::carp "normalise called with relative path and no base: '$path'";
655		1825
656	push @exts, $pkg;	1826	$base =~ s{[^/]+/?$}{};
657	$ext_pkg{$base} = $pkg;	1827	$path = "$base/$path";
658
659	# no strict 'refs';
660	# @{"$pkg\::ISA"} = ext::;
661
662	register $base, $pkg;
663	}
664
665	sub unload_extension {
666	my ($pkg) = @_;
667
668	warn "removing extension $pkg\n";
669
670	# remove hooks
671	#TODO
672	# for my $idx (0 .. $#PLUGIN_EVENT) {
673	# delete $hook[$idx]{$pkg};
674	# }	1828	}
675		1829
676	# remove commands	1830	for ($path) {
677	for my $name (keys %COMMAND) {	1831	redo if s{//}{/};
678	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };	1832	redo if s{/\.?/}{/};
		1833	redo if s{/[^/]+/\.\./}{/};
		1834	}
679		1835
680	if (@cb) {	1836	$path
681	$COMMAND{$name} = \@cb;	1837	}
		1838
		1839	sub new_from_path {
		1840	my (undef, $path, $base) = @_;
		1841
		1842	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1843
		1844	$path = normalise $path, $base;
		1845
		1846	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1847	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1848	my $self = bless cf::map::new, $pkg;
		1849	$self->{path} = $path; $self->path ($path);
		1850	$self->init; # pass $1 etc.
		1851	return $self;
		1852	}
		1853	}
		1854
		1855	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1856	()
		1857	}
		1858
		1859	sub init {
		1860	my ($self) = @_;
		1861
		1862	$self
		1863	}
		1864
		1865	sub as_string {
		1866	my ($self) = @_;
		1867
		1868	"$self->{path}"
		1869	}
		1870
		1871	# the displayed name, this is a one way mapping
		1872	sub visible_name {
		1873	&as_string
		1874	}
		1875
		1876	# the original (read-only) location
		1877	sub load_path {
		1878	my ($self) = @_;
		1879
		1880	"$MAPDIR/$self->{path}.map"
		1881	}
		1882
		1883	# the temporary/swap location
		1884	sub save_path {
		1885	my ($self) = @_;
		1886
		1887	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1888	"$TMPDIR/$path.map"
		1889	}
		1890
		1891	# the unique path, undef == no special unique path
		1892	sub uniq_path {
		1893	my ($self) = @_;
		1894
		1895	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
		1896	"$UNIQUEDIR/$path"
		1897	}
		1898
		1899	sub decay_objects {
		1900	my ($self) = @_;
		1901
		1902	return if $self->{deny_reset};
		1903
		1904	$self->do_decay_objects;
		1905	}
		1906
		1907	sub unlink_save {
		1908	my ($self) = @_;
		1909
		1910	utf8::encode (my $save = $self->save_path);
		1911	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1912	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1913	}
		1914
		1915	sub load_header_from($) {
		1916	my ($self, $path) = @_;
		1917
		1918	utf8::encode $path;
		1919	my $f = new_from_file cf::object::thawer $path
		1920	or return;
		1921
		1922	$self->_load_header ($f)
		1923	or return;
		1924
		1925	local $MAP_LOADING{$self->{path}} = $self;
		1926	$f->resolve_delayed_derefs;
		1927
		1928	$self->{load_path} = $path;
		1929
		1930	1
		1931	}
		1932
		1933	sub load_header_orig {
		1934	my ($self) = @_;
		1935
		1936	$self->load_header_from ($self->load_path)
		1937	}
		1938
		1939	sub load_header_temp {
		1940	my ($self) = @_;
		1941
		1942	$self->load_header_from ($self->save_path)
		1943	}
		1944
		1945	sub prepare_temp {
		1946	my ($self) = @_;
		1947
		1948	$self->last_access ((delete $self->{last_access})
		1949	|| $cf::RUNTIME); #d#
		1950	# safety
		1951	$self->{instantiate_time} = $cf::RUNTIME
		1952	if $self->{instantiate_time} > $cf::RUNTIME;
		1953	}
		1954
		1955	sub prepare_orig {
		1956	my ($self) = @_;
		1957
		1958	$self->{load_original} = 1;
		1959	$self->{instantiate_time} = $cf::RUNTIME;
		1960	$self->last_access ($cf::RUNTIME);
		1961	$self->instantiate;
		1962	}
		1963
		1964	sub load_header {
		1965	my ($self) = @_;
		1966
		1967	if ($self->load_header_temp) {
		1968	$self->prepare_temp;
682	} else {	1969	} else {
683	delete $COMMAND{$name};	1970	$self->load_header_orig
684	}	1971	or return;
		1972	$self->prepare_orig;
		1973	}
		1974
		1975	$self->{deny_reset} = 1
		1976	if $self->no_reset;
		1977
		1978	$self->default_region (cf::region::find_by_path $self->{path})
		1979	unless $self->default_region;
		1980
685	}	1981	1
		1982	}
686		1983
687	# remove extcmds	1984	sub find;
688	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	1985	sub find {
689	delete $EXTCMD{$name};	1986	my ($path, $origin) = @_;
		1987
		1988	$path = normalise $path, $origin && $origin->path;
		1989
		1990	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
		1991	my $guard2 = cf::lock_acquire "map_find:$path";
		1992
		1993	$cf::MAP{$path} || do {
		1994	my $map = new_from_path cf::map $path
		1995	or return;
		1996
		1997	$map->{last_save} = $cf::RUNTIME;
		1998
		1999	$map->load_header
		2000	or return;
		2001
		2002	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		2003	# doing this can freeze the server in a sync job, obviously
		2004	#$cf::WAIT_FOR_TICK->wait;
		2005	undef $guard2;
		2006	undef $guard1;
		2007	$map->reset;
		2008	return find $path;
		2009	}
		2010
		2011	$cf::MAP{$path} = $map
		2012	}
		2013	}
		2014
		2015	sub pre_load { }
		2016	sub post_load { }
		2017
		2018	sub load {
		2019	my ($self) = @_;
		2020
		2021	local $self->{deny_reset} = 1; # loading can take a long time
		2022
		2023	my $path = $self->{path};
		2024
690	}	2025	{
		2026	my $guard = cf::lock_acquire "map_data:$path";
691		2027
692	if (my $cb = $pkg->can ("unload")) {	2028	return unless $self->valid;
693	eval {	2029	return unless $self->in_memory == cf::MAP_SWAPPED;
694	$cb->($pkg);	2030
		2031	$self->in_memory (cf::MAP_LOADING);
		2032
		2033	$self->alloc;
		2034
		2035	$self->pre_load;
		2036	cf::cede_to_tick;
		2037
		2038	my $f = new_from_file cf::object::thawer $self->{load_path};
		2039	$f->skip_block;
		2040	$self->_load_objects ($f)
		2041	or return;
		2042
		2043	$self->post_load_original
		2044	if delete $self->{load_original};
		2045
		2046	if (my $uniq = $self->uniq_path) {
		2047	utf8::encode $uniq;
		2048	unless (aio_stat $uniq) {
		2049	if (my $f = new_from_file cf::object::thawer $uniq) {
		2050	$self->clear_unique_items;
		2051	$self->_load_objects ($f);
		2052	$f->resolve_delayed_derefs;
		2053	}
695	1	2054	}
696	} or warn "$pkg unloaded, but with errors: $@";	2055	}
697	}
698		2056
699	Symbol::delete_package $pkg;	2057	$f->resolve_delayed_derefs;
700	}
701		2058
702	sub load_extensions {	2059	cf::cede_to_tick;
703	for my $ext (<$LIBDIR/*.ext>) {	2060	# now do the right thing for maps
704	next unless -r $ext;	2061	$self->link_multipart_objects;
705	eval {	2062	$self->difficulty ($self->estimate_difficulty)
706	load_extension $ext;	2063	unless $self->difficulty;
707	1	2064	cf::cede_to_tick;
708	} or warn "$ext not loaded: $@";
709	}
710	}
711		2065
712	#############################################################################	2066	unless ($self->{deny_activate}) {
713	# load/save/clean perl data associated with a map	2067	$self->decay_objects;
		2068	$self->fix_auto_apply;
		2069	$self->update_buttons;
		2070	cf::cede_to_tick;
		2071	$self->activate;
		2072	}
714		2073
715	*cf::mapsupport::on_clean = sub {	2074	$self->{last_save} = $cf::RUNTIME;
		2075	$self->last_access ($cf::RUNTIME);
		2076
		2077	$self->in_memory (cf::MAP_ACTIVE);
		2078	}
		2079
		2080	$self->post_load;
		2081	}
		2082
		2083	sub customise_for {
		2084	my ($self, $ob) = @_;
		2085
		2086	return find "~" . $ob->name . "/" . $self->{path}
		2087	if $self->per_player;
		2088
		2089	# return find "?party/" . $ob->name . "/" . $self->{path}
		2090	# if $self->per_party;
		2091
		2092	$self
		2093	}
		2094
		2095	# find and load all maps in the 3x3 area around a map
		2096	sub load_neighbours {
716	my ($map) = @_;	2097	my ($map) = @_;
717		2098
718	my $path = $map->tmpname;	2099	my @neigh; # diagonal neighbours
719	defined $path or return;
720		2100
721	unlink "$path.pst";	2101	for (0 .. 3) {
722	};	2102	my $neigh = $map->tile_path ($_)
		2103	or next;
		2104	$neigh = find $neigh, $map
		2105	or next;
		2106	$neigh->load;
723		2107
724	cf::map->attach (prio => -10000, package => cf::mapsupport::);	2108	push @neigh,
		2109	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		2110	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		2111	}
725		2112
726	#############################################################################	2113	for (grep defined $_->[0], @neigh) {
727	# load/save perl data associated with player->ob objects	2114	my ($path, $origin) = @$_;
728		2115	my $neigh = find $path, $origin
729	sub all_objects(@) {	2116	or next;
730	@_, map all_objects ($_->inv), @_	2117	$neigh->load;
		2118	}
731	}	2119	}
732		2120
733	# TODO: compatibility cruft, remove when no longer needed	2121	sub find_sync {
734	cf::player->attach (	2122	my ($path, $origin) = @_;
735	on_load => sub {
736	my ($pl, $path) = @_;
737		2123
738	for my $o (all_objects $pl->ob) {	2124	cf::sync_job { find $path, $origin }
739	if (my $value = $o->get_ob_key_value ("_perl_data")) {	2125	}
740	$o->set_ob_key_value ("_perl_data");
741		2126
742	%$o = %{ Storable::thaw pack "H*", $value };	2127	sub do_load_sync {
		2128	my ($map) = @_;
		2129
		2130	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2131	if $Coro::current == $Coro::main;
		2132
		2133	cf::sync_job { $map->load };
		2134	}
		2135
		2136	our %MAP_PREFETCH;
		2137	our $MAP_PREFETCHER = undef;
		2138
		2139	sub find_async {
		2140	my ($path, $origin, $load) = @_;
		2141
		2142	$path = normalise $path, $origin && $origin->{path};
		2143
		2144	if (my $map = $cf::MAP{$path}) {
		2145	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
		2146	}
		2147
		2148	$MAP_PREFETCH{$path} |= $load;
		2149
		2150	$MAP_PREFETCHER ||= cf::async {
		2151	$Coro::current->{desc} = "map prefetcher";
		2152
		2153	while (%MAP_PREFETCH) {
		2154	while (my ($k, $v) = each %MAP_PREFETCH) {
		2155	if (my $map = find $k) {
		2156	$map->load if $v;
		2157	}
		2158
		2159	delete $MAP_PREFETCH{$k};
743	}	2160	}
744	}	2161	}
		2162	undef $MAP_PREFETCHER;
		2163	};
		2164	$MAP_PREFETCHER->prio (6);
		2165
		2166	()
		2167	}
		2168
		2169	sub save {
		2170	my ($self) = @_;
		2171
		2172	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2173
		2174	$self->{last_save} = $cf::RUNTIME;
		2175
		2176	return unless $self->dirty;
		2177
		2178	my $save = $self->save_path; utf8::encode $save;
		2179	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2180
		2181	$self->{load_path} = $save;
		2182
		2183	return if $self->{deny_save};
		2184
		2185	local $self->{last_access} = $self->last_access;#d#
		2186
		2187	cf::async {
		2188	$Coro::current->{desc} = "map player save";
		2189	$_->contr->save for $self->players;
		2190	};
		2191
		2192	cf::get_slot 0.02;
		2193
		2194	if ($uniq) {
		2195	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		2196	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		2197	} else {
		2198	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
745	},	2199	}
746	);	2200	}
747		2201
748	#############################################################################	2202	sub swap_out {
		2203	my ($self) = @_;
749		2204
750	=head2 CORE EXTENSIONS	2205	# save first because save cedes
		2206	$self->save;
751		2207
752	Functions and methods that extend core crossfire objects.	2208	my $lock = cf::lock_acquire "map_data:$self->{path}";
753		2209
754	=head3 cf::player	2210	return if $self->players;
		2211	return if $self->in_memory != cf::MAP_ACTIVE;
		2212	return if $self->{deny_save};
		2213
		2214	$self->in_memory (cf::MAP_SWAPPED);
		2215
		2216	$self->deactivate;
		2217	$_->clear_links_to ($self) for values %cf::MAP;
		2218	$self->clear;
		2219	}
		2220
		2221	sub reset_at {
		2222	my ($self) = @_;
		2223
		2224	# TODO: safety, remove and allow resettable per-player maps
		2225	return 1e99 if $self->{deny_reset};
		2226
		2227	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		2228	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		2229
		2230	$time + $to
		2231	}
		2232
		2233	sub should_reset {
		2234	my ($self) = @_;
		2235
		2236	$self->reset_at <= $cf::RUNTIME
		2237	}
		2238
		2239	sub reset {
		2240	my ($self) = @_;
		2241
		2242	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2243
		2244	return if $self->players;
		2245
		2246	warn "resetting map ", $self->path, "\n";
		2247
		2248	$self->in_memory (cf::MAP_SWAPPED);
		2249
		2250	# need to save uniques path
		2251	unless ($self->{deny_save}) {
		2252	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2253
		2254	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2255	if $uniq;
		2256	}
		2257
		2258	delete $cf::MAP{$self->path};
		2259
		2260	$self->deactivate;
		2261	$_->clear_links_to ($self) for values %cf::MAP;
		2262	$self->clear;
		2263
		2264	$self->unlink_save;
		2265	$self->destroy;
		2266	}
		2267
		2268	my $nuke_counter = "aaaa";
		2269
		2270	sub nuke {
		2271	my ($self) = @_;
		2272
		2273	{
		2274	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2275
		2276	delete $cf::MAP{$self->path};
		2277
		2278	$self->unlink_save;
		2279
		2280	bless $self, "cf::map";
		2281	delete $self->{deny_reset};
		2282	$self->{deny_save} = 1;
		2283	$self->reset_timeout (1);
		2284	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2285
		2286	$cf::MAP{$self->path} = $self;
		2287	}
		2288
		2289	$self->reset; # polite request, might not happen
		2290	}
		2291
		2292	=item $maps = cf::map::tmp_maps
		2293
		2294	Returns an arrayref with all map paths of currently instantiated and saved
		2295	maps. May block.
		2296
		2297	=cut
		2298
		2299	sub tmp_maps() {
		2300	[
		2301	map {
		2302	utf8::decode $_;
		2303	/\.map$/
		2304	? normalise $_
		2305	: ()
		2306	} @{ aio_readdir $TMPDIR or [] }
		2307	]
		2308	}
		2309
		2310	=item $maps = cf::map::random_maps
		2311
		2312	Returns an arrayref with all map paths of currently instantiated and saved
		2313	random maps. May block.
		2314
		2315	=cut
		2316
		2317	sub random_maps() {
		2318	[
		2319	map {
		2320	utf8::decode $_;
		2321	/\.map$/
		2322	? normalise "?random/$_"
		2323	: ()
		2324	} @{ aio_readdir $RANDOMDIR or [] }
		2325	]
		2326	}
		2327
		2328	=item cf::map::unique_maps
		2329
		2330	Returns an arrayref of paths of all shared maps that have
		2331	instantiated unique items. May block.
		2332
		2333	=cut
		2334
		2335	sub unique_maps() {
		2336	[
		2337	map {
		2338	utf8::decode $_;
		2339	s/\.map$//; # TODO future compatibility hack
		2340	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
		2341	? ()
		2342	: normalise $_
		2343	} @{ aio_readdir $UNIQUEDIR or [] }
		2344	]
		2345	}
		2346
		2347	=item cf::map::static_maps
		2348
		2349	Returns an arrayref if paths of all static maps (all preinstalled F<.map>
		2350	file in the shared directory excluding F</styles> and F</editor>). May
		2351	block.
		2352
		2353	=cut
		2354
		2355	sub static_maps() {
		2356	my @dirs = "";
		2357	my @maps;
		2358
		2359	while (@dirs) {
		2360	my $dir = shift @dirs;
		2361
		2362	next if $dir eq "/styles" || $dir eq "/editor";
		2363
		2364	my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
		2365	or return;
		2366
		2367	for (@$files) {
		2368	s/\.map$// or next;
		2369	utf8::decode $_;
		2370	push @maps, "$dir/$_";
		2371	}
		2372
		2373	push @dirs, map "$dir/$_", @$dirs;
		2374	}
		2375
		2376	\@maps
		2377	}
		2378
		2379	=back
		2380
		2381	=head3 cf::object
		2382
		2383	=cut
		2384
		2385	package cf::object;
755		2386
756	=over 4	2387	=over 4
757		2388
758	=item cf::player::exists $login	2389	=item $ob->inv_recursive
759		2390
760	Returns true when the given account exists.	2391	Returns the inventory of the object I<and> their inventories, recursively,
		2392	but I<not> the object itself.
761		2393
762	=cut	2394	=cut
763		2395
764	sub cf::player::exists($) {	2396	sub inv_recursive_;
765	cf::player::find $_[0]	2397	sub inv_recursive_ {
766	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2398	map { $_, inv_recursive_ $_->inv } @_
767	}	2399	}
768		2400
769	=item $player->ext_reply ($msgid, $msgtype, %msg)	2401	sub inv_recursive {
770		2402	inv_recursive_ inv $_[0]
771	Sends an ext reply to the player.
772
773	=cut
774
775	sub cf::player::ext_reply($$$%) {
776	my ($self, $id, %msg) = @_;
777
778	$msg{msgid} = $id;
779
780	$self->send ("ext " . to_json \%msg);
781	}	2403	}
		2404
		2405	=item $ref = $ob->ref
		2406
		2407	Creates and returns a persistent reference to an object that can be stored as a string.
		2408
		2409	=item $ob = cf::object::deref ($refstring)
		2410
		2411	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2412	even if the object actually exists. May block.
		2413
		2414	=cut
		2415
		2416	sub deref {
		2417	my ($ref) = @_;
		2418
		2419	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2420	my ($uuid, $name) = ($1, $2);
		2421	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2422	or return;
		2423	$pl->ob->uuid eq $uuid
		2424	or return;
		2425
		2426	$pl->ob
		2427	} else {
		2428	warn "$ref: cannot resolve object reference\n";
		2429	undef
		2430	}
		2431	}
		2432
		2433	package cf;
782		2434
783	=back	2435	=back
784		2436
785	=head3 cf::object::player	2437	=head3 cf::object::player
786		2438
…		…
791	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2443	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
792	can be C<undef>. Does the right thing when the player is currently in a	2444	can be C<undef>. Does the right thing when the player is currently in a
793	dialogue with the given NPC character.	2445	dialogue with the given NPC character.
794		2446
795	=cut	2447	=cut
		2448
		2449	our $SAY_CHANNEL = {
		2450	id => "say",
		2451	title => "Map",
		2452	reply => "say ",
		2453	tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
		2454	};
		2455
		2456	our $CHAT_CHANNEL = {
		2457	id => "chat",
		2458	title => "Chat",
		2459	reply => "chat ",
		2460	tooltip => "Player chat and shouts, global to the server.",
		2461	};
796		2462
797	# rough implementation of a future "reply" method that works	2463	# rough implementation of a future "reply" method that works
798	# with dialog boxes.	2464	# with dialog boxes.
799	#TODO: the first argument must go, split into a $npc->reply_to ( method	2465	#TODO: the first argument must go, split into a $npc->reply_to ( method
800	sub cf::object::player::reply($$$;$) {	2466	sub cf::object::player::reply($$$;$) {
…		…
802		2468
803	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2469	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
804		2470
805	if ($self->{record_replies}) {	2471	if ($self->{record_replies}) {
806	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2472	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2473
807	} else {	2474	} else {
		2475	my $pl = $self->contr;
		2476
		2477	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2478	my $dialog = $pl->{npc_dialog};
		2479	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2480
		2481	} else {
808	$msg = $npc->name . " says: $msg" if $npc;	2482	$msg = $npc->name . " says: $msg" if $npc;
809	$self->message ($msg, $flags);	2483	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2484	}
810	}	2485	}
		2486	}
		2487
		2488	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2489
		2490	=cut
		2491
		2492	sub cf::object::send_msg {
		2493	my $pl = shift->contr
		2494	or return;
		2495	$pl->send_msg (@_);
811	}	2496	}
812		2497
813	=item $player_object->may ("access")	2498	=item $player_object->may ("access")
814		2499
815	Returns wether the given player is authorized to access resource "access"	2500	Returns wether the given player is authorized to access resource "access"
…		…
824	(ref $cf::CFG{"may_$access"}	2509	(ref $cf::CFG{"may_$access"}
825	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2510	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826	: $cf::CFG{"may_$access"})	2511	: $cf::CFG{"may_$access"})
827	}	2512	}
828		2513
		2514	=item $player_object->enter_link
		2515
		2516	Freezes the player and moves him/her to a special map (C<{link}>).
		2517
		2518	The player should be reasonably safe there for short amounts of time (e.g.
		2519	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2520	though, as the palyer cannot control the character while it is on the link
		2521	map.
		2522
		2523	Will never block.
		2524
		2525	=item $player_object->leave_link ($map, $x, $y)
		2526
		2527	Moves the player out of the special C<{link}> map onto the specified
		2528	map. If the map is not valid (or omitted), the player will be moved back
		2529	to the location he/she was before the call to C<enter_link>, or, if that
		2530	fails, to the emergency map position.
		2531
		2532	Might block.
		2533
		2534	=cut
		2535
		2536	sub link_map {
		2537	unless ($LINK_MAP) {
		2538	$LINK_MAP = cf::map::find "{link}"
		2539	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2540	$LINK_MAP->load;
		2541	}
		2542
		2543	$LINK_MAP
		2544	}
		2545
		2546	sub cf::object::player::enter_link {
		2547	my ($self) = @_;
		2548
		2549	$self->deactivate_recursive;
		2550
		2551	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2552
		2553	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2554	if $self->map && $self->map->{path} ne "{link}";
		2555
		2556	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		2557	}
		2558
		2559	sub cf::object::player::leave_link {
		2560	my ($self, $map, $x, $y) = @_;
		2561
		2562	return unless $self->contr->active;
		2563
		2564	my $link_pos = delete $self->{_link_pos};
		2565
		2566	unless ($map) {
		2567	# restore original map position
		2568	($map, $x, $y) = @{ $link_pos || [] };
		2569	$map = cf::map::find $map;
		2570
		2571	unless ($map) {
		2572	($map, $x, $y) = @$EMERGENCY_POSITION;
		2573	$map = cf::map::find $map
		2574	or die "FATAL: cannot load emergency map\n";
		2575	}
		2576	}
		2577
		2578	($x, $y) = (-1, -1)
		2579	unless (defined $x) && (defined $y);
		2580
		2581	# use -1 or undef as default coordinates, not 0, 0
		2582	($x, $y) = ($map->enter_x, $map->enter_y)
		2583	if $x <= 0 && $y <= 0;
		2584
		2585	$map->load;
		2586	$map->load_neighbours;
		2587
		2588	return unless $self->contr->active;
		2589
		2590	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2591	$self->enter_map ($map, $x, $y);
		2592
		2593	# only activate afterwards, to support waiting in hooks
		2594	$self->activate_recursive;
		2595	}
		2596
		2597	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
		2598
		2599	Moves the player to the given map-path and coordinates by first freezing
		2600	her, loading and preparing them map, calling the provided $check callback
		2601	that has to return the map if sucecssful, and then unfreezes the player on
		2602	the new (success) or old (failed) map position. In either case, $done will
		2603	be called at the end of this process.
		2604
		2605	Note that $check will be called with a potentially non-loaded map, so if
		2606	it needs a loaded map it has to call C<< ->load >>.
		2607
		2608	=cut
		2609
		2610	our $GOTOGEN;
		2611
		2612	sub cf::object::player::goto {
		2613	my ($self, $path, $x, $y, $check, $done) = @_;
		2614
		2615	# do generation counting so two concurrent goto's will be executed in-order
		2616	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2617
		2618	$self->enter_link;
		2619
		2620	(async {
		2621	$Coro::current->{desc} = "player::goto $path $x $y";
		2622
		2623	# *tag paths override both path and x|y
		2624	if ($path =~ /^\*(.*)$/) {
		2625	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2626	my $ob = $obs[rand @obs];
		2627
		2628	# see if we actually can go there
		2629	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2630	$ob = $obs[rand @obs];
		2631	} else {
		2632	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2633	}
		2634	# else put us there anyways for now #d#
		2635
		2636	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2637	} else {
		2638	($path, $x, $y) = (undef, undef, undef);
		2639	}
		2640	}
		2641
		2642	my $map = eval {
		2643	my $map = defined $path ? cf::map::find $path : undef;
		2644
		2645	if ($map) {
		2646	$map = $map->customise_for ($self);
		2647	$map = $check->($map) if $check && $map;
		2648	} else {
		2649	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2650	}
		2651
		2652	$map
		2653	};
		2654
		2655	if ($@) {
		2656	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2657	LOG llevError | logBacktrace, Carp::longmess $@;
		2658	}
		2659
		2660	if ($gen == $self->{_goto_generation}) {
		2661	delete $self->{_goto_generation};
		2662	$self->leave_link ($map, $x, $y);
		2663	}
		2664
		2665	$done->() if $done;
		2666	})->prio (1);
		2667	}
		2668
		2669	=item $player_object->enter_exit ($exit_object)
		2670
		2671	=cut
		2672
		2673	sub parse_random_map_params {
		2674	my ($spec) = @_;
		2675
		2676	my $rmp = { # defaults
		2677	xsize => (cf::rndm 15, 40),
		2678	ysize => (cf::rndm 15, 40),
		2679	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2680	#layout => string,
		2681	};
		2682
		2683	for (split /\n/, $spec) {
		2684	my ($k, $v) = split /\s+/, $_, 2;
		2685
		2686	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2687	}
		2688
		2689	$rmp
		2690	}
		2691
		2692	sub prepare_random_map {
		2693	my ($exit) = @_;
		2694
		2695	# all this does is basically replace the /! path by
		2696	# a new random map path (?random/...) with a seed
		2697	# that depends on the exit object
		2698
		2699	my $rmp = parse_random_map_params $exit->msg;
		2700
		2701	if ($exit->map) {
		2702	$rmp->{region} = $exit->region->name;
		2703	$rmp->{origin_map} = $exit->map->path;
		2704	$rmp->{origin_x} = $exit->x;
		2705	$rmp->{origin_y} = $exit->y;
		2706
		2707	$exit->map->touch;
		2708	}
		2709
		2710	$rmp->{random_seed} ||= $exit->random_seed;
		2711
		2712	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
		2713	my $md5 = Digest::MD5::md5_hex $data;
		2714	my $meta = "$RANDOMDIR/$md5.meta";
		2715
		2716	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2717	aio_write $fh, 0, (length $data), $data, 0;
		2718	undef $fh;
		2719	aio_rename "$meta~", $meta;
		2720
		2721	my $slaying = "?random/$md5";
		2722
		2723	if ($exit->valid) {
		2724	$exit->slaying ("?random/$md5");
		2725	$exit->msg (undef);
		2726	}
		2727	}
		2728	}
		2729
		2730	sub cf::object::player::enter_exit {
		2731	my ($self, $exit) = @_;
		2732
		2733	return unless $self->type == cf::PLAYER;
		2734
		2735	$self->enter_link;
		2736
		2737	(async {
		2738	$Coro::current->{desc} = "enter_exit";
		2739
		2740	unless (eval {
		2741	$self->deactivate_recursive; # just to be sure
		2742
		2743	# random map handling
		2744	{
		2745	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2746
		2747	prepare_random_map $exit
		2748	if $exit->slaying eq "/!";
		2749	}
		2750
		2751	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2752	my $x = $exit->stats->hp;
		2753	my $y = $exit->stats->sp;
		2754
		2755	$self->goto ($map, $x, $y);
		2756
		2757	# if exit is damned, update players death & WoR home-position
		2758	$self->contr->savebed ($map, $x, $y)
		2759	if $exit->flag (cf::FLAG_DAMNED);
		2760
		2761	1
		2762	}) {
		2763	$self->message ("Something went wrong deep within the deliantra server. "
		2764	. "I'll try to bring you back to the map you were before. "
		2765	. "Please report this to the dungeon master!",
		2766	cf::NDI_UNIQUE | cf::NDI_RED);
		2767
		2768	warn "ERROR in enter_exit: $@";
		2769	$self->leave_link;
		2770	}
		2771	})->prio (1);
		2772	}
		2773
829	=head3 cf::client	2774	=head3 cf::client
830		2775
831	=over 4	2776	=over 4
832		2777
833	=item $client->send_drawinfo ($text, $flags)	2778	=item $client->send_drawinfo ($text, $flags)
…		…
839		2784
840	sub cf::client::send_drawinfo {	2785	sub cf::client::send_drawinfo {
841	my ($self, $text, $flags) = @_;	2786	my ($self, $text, $flags) = @_;
842		2787
843	utf8::encode $text;	2788	utf8::encode $text;
844	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2789	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
845	}	2790	}
846		2791
		2792	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2793
		2794	Send a drawinfo or msg packet to the client, formatting the msg for the
		2795	client if neccessary. C<$type> should be a string identifying the type of
		2796	the message, with C<log> being the default. If C<$color> is negative, suppress
		2797	the message unless the client supports the msg packet.
		2798
		2799	=cut
		2800
		2801	# non-persistent channels (usually the info channel)
		2802	our %CHANNEL = (
		2803	"c/motd" => {
		2804	id => "infobox",
		2805	title => "MOTD",
		2806	reply => undef,
		2807	tooltip => "The message of the day",
		2808	},
		2809	"c/identify" => {
		2810	id => "infobox",
		2811	title => "Identify",
		2812	reply => undef,
		2813	tooltip => "Items recently identified",
		2814	},
		2815	"c/examine" => {
		2816	id => "infobox",
		2817	title => "Examine",
		2818	reply => undef,
		2819	tooltip => "Signs and other items you examined",
		2820	},
		2821	"c/shopinfo" => {
		2822	id => "infobox",
		2823	title => "Shop Info",
		2824	reply => undef,
		2825	tooltip => "What your bargaining skill tells you about the shop",
		2826	},
		2827	"c/book" => {
		2828	id => "infobox",
		2829	title => "Book",
		2830	reply => undef,
		2831	tooltip => "The contents of a note or book",
		2832	},
		2833	"c/lookat" => {
		2834	id => "infobox",
		2835	title => "Look",
		2836	reply => undef,
		2837	tooltip => "What you saw there",
		2838	},
		2839	"c/who" => {
		2840	id => "infobox",
		2841	title => "Players",
		2842	reply => undef,
		2843	tooltip => "Shows players who are currently online",
		2844	},
		2845	"c/body" => {
		2846	id => "infobox",
		2847	title => "Body Parts",
		2848	reply => undef,
		2849	tooltip => "Shows which body parts you posess and are available",
		2850	},
		2851	"c/statistics" => {
		2852	id => "infobox",
		2853	title => "Statistics",
		2854	reply => undef,
		2855	tooltip => "Shows your primary statistics",
		2856	},
		2857	"c/skills" => {
		2858	id => "infobox",
		2859	title => "Skills",
		2860	reply => undef,
		2861	tooltip => "Shows your experience per skill and item power",
		2862	},
		2863	"c/shopitems" => {
		2864	id => "infobox",
		2865	title => "Shop Items",
		2866	reply => undef,
		2867	tooltip => "Shows the items currently for sale in this shop",
		2868	},
		2869	"c/resistances" => {
		2870	id => "infobox",
		2871	title => "Resistances",
		2872	reply => undef,
		2873	tooltip => "Shows your resistances",
		2874	},
		2875	"c/pets" => {
		2876	id => "infobox",
		2877	title => "Pets",
		2878	reply => undef,
		2879	tooltip => "Shows information abotu your pets/a specific pet",
		2880	},
		2881	"c/perceiveself" => {
		2882	id => "infobox",
		2883	title => "Perceive Self",
		2884	reply => undef,
		2885	tooltip => "You gained detailed knowledge about yourself",
		2886	},
		2887	"c/uptime" => {
		2888	id => "infobox",
		2889	title => "Uptime",
		2890	reply => undef,
		2891	tooltip => "How long the server has been running since last restart",
		2892	},
		2893	"c/mapinfo" => {
		2894	id => "infobox",
		2895	title => "Map Info",
		2896	reply => undef,
		2897	tooltip => "Information related to the maps",
		2898	},
		2899	"c/party" => {
		2900	id => "party",
		2901	title => "Party",
		2902	reply => "gsay ",
		2903	tooltip => "Messages and chat related to your party",
		2904	},
		2905	"c/death" => {
		2906	id => "death",
		2907	title => "Death",
		2908	reply => undef,
		2909	tooltip => "Reason for and more info about your most recent death",
		2910	},
		2911	"c/say" => $SAY_CHANNEL,
		2912	"c/chat" => $CHAT_CHANNEL,
		2913	);
		2914
		2915	sub cf::client::send_msg {
		2916	my ($self, $channel, $msg, $color, @extra) = @_;
		2917
		2918	$msg = $self->pl->expand_cfpod ($msg)
		2919	unless $color & cf::NDI_VERBATIM;
		2920
		2921	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2922
		2923	# check predefined channels, for the benefit of C
		2924	if ($CHANNEL{$channel}) {
		2925	$channel = $CHANNEL{$channel};
		2926
		2927	$self->ext_msg (channel_info => $channel);
		2928	$channel = $channel->{id};
		2929
		2930	} elsif (ref $channel) {
		2931	# send meta info to client, if not yet sent
		2932	unless (exists $self->{channel}{$channel->{id}}) {
		2933	$self->{channel}{$channel->{id}} = $channel;
		2934	$self->ext_msg (channel_info => $channel);
		2935	}
		2936
		2937	$channel = $channel->{id};
		2938	}
		2939
		2940	return unless @extra || length $msg;
		2941
		2942	# default colour, mask it out
		2943	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2944	if $color & cf::NDI_DEF;
		2945
		2946	my $pkt = "msg "
		2947	. $self->{json_coder}->encode (
		2948	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		2949	);
		2950
		2951	# try lzf for large packets
		2952	$pkt = "lzf " . Compress::LZF::compress $pkt
		2953	if 1024 <= length $pkt and $self->{can_lzf};
		2954
		2955	# split very large packets
		2956	if (8192 < length $pkt and $self->{can_lzf}) {
		2957	$self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
		2958	$pkt = "frag";
		2959	}
		2960
		2961	$self->send_packet ($pkt);
		2962	}
		2963
		2964	=item $client->ext_msg ($type, @msg)
		2965
		2966	Sends an ext event to the client.
		2967
		2968	=cut
		2969
		2970	sub cf::client::ext_msg($$@) {
		2971	my ($self, $type, @msg) = @_;
		2972
		2973	if ($self->extcmd == 2) {
		2974	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2975	} elsif ($self->extcmd == 1) { # TODO: remove
		2976	push @msg, msgtype => "event_$type";
		2977	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2978	}
		2979	}
		2980
		2981	=item $client->ext_reply ($msgid, @msg)
		2982
		2983	Sends an ext reply to the client.
		2984
		2985	=cut
		2986
		2987	sub cf::client::ext_reply($$@) {
		2988	my ($self, $id, @msg) = @_;
		2989
		2990	if ($self->extcmd == 2) {
		2991	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2992	} elsif ($self->extcmd == 1) {
		2993	#TODO: version 1, remove
		2994	unshift @msg, msgtype => "reply", msgid => $id;
		2995	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2996	}
		2997	}
847		2998
848	=item $success = $client->query ($flags, "text", \&cb)	2999	=item $success = $client->query ($flags, "text", \&cb)
849		3000
850	Queues a query to the client, calling the given callback with	3001	Queues a query to the client, calling the given callback with
851	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	3002	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
852	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	3003	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
853		3004
854	Queries can fail, so check the return code. Or don't, as queries will become	3005	Queries can fail, so check the return code. Or don't, as queries will
855	reliable at some point in the future.	3006	become reliable at some point in the future.
856		3007
857	=cut	3008	=cut
858		3009
859	sub cf::client::query {	3010	sub cf::client::query {
860	my ($self, $flags, $text, $cb) = @_;	3011	my ($self, $flags, $text, $cb) = @_;
…		…
868	utf8::encode $text;	3019	utf8::encode $text;
869	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3020	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
870		3021
871	$self->send_packet ($self->{query_queue}[0][0])	3022	$self->send_packet ($self->{query_queue}[0][0])
872	if @{ $self->{query_queue} } == 1;	3023	if @{ $self->{query_queue} } == 1;
		3024
		3025	1
873	}	3026	}
874		3027
875	cf::client->attach (	3028	cf::client->attach (
		3029	on_connect => sub {
		3030	my ($ns) = @_;
		3031
		3032	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3033	},
876	on_reply => sub {	3034	on_reply => sub {
877	my ($ns, $msg) = @_;	3035	my ($ns, $msg) = @_;
878		3036
879	# this weird shuffling is so that direct followup queries	3037	# this weird shuffling is so that direct followup queries
880	# get handled first	3038	# get handled first
881	my $queue = delete $ns->{query_queue};	3039	my $queue = delete $ns->{query_queue}
		3040	or return; # be conservative, not sure how that can happen, but we saw a crash here
882		3041
883	(shift @$queue)->[1]->($msg);	3042	(shift @$queue)->[1]->($msg);
		3043	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
884		3044
885	push @{ $ns->{query_queue} }, @$queue;	3045	push @{ $ns->{query_queue} }, @$queue;
886		3046
887	if (@{ $ns->{query_queue} } == @$queue) {	3047	if (@{ $ns->{query_queue} } == @$queue) {
888	if (@$queue) {	3048	if (@$queue) {
…		…
890	} else {	3050	} else {
891	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3051	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
892	}	3052	}
893	}	3053	}
894	},	3054	},
		3055	on_exticmd => sub {
		3056	my ($ns, $buf) = @_;
		3057
		3058	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3059
		3060	if (ref $msg) {
		3061	my ($type, $reply, @payload) =
		3062	"ARRAY" eq ref $msg
		3063	? @$msg
		3064	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3065
		3066	my @reply;
		3067
		3068	if (my $cb = $EXTICMD{$type}) {
		3069	@reply = $cb->($ns, @payload);
		3070	}
		3071
		3072	$ns->ext_reply ($reply, @reply)
		3073	if $reply;
		3074
		3075	} else {
		3076	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3077	}
		3078
		3079	cf::override;
		3080	},
895	);	3081	);
896		3082
897	=item $client->coro (\&cb)	3083	=item $client->async (\&cb)
898		3084
899	Create a new coroutine, running the specified callback. The coroutine will	3085	Create a new coroutine, running the specified callback. The coroutine will
900	be automatically cancelled when the client gets destroyed (e.g. on logout,	3086	be automatically cancelled when the client gets destroyed (e.g. on logout,
901	or loss of connection).	3087	or loss of connection).
902		3088
903	=cut	3089	=cut
904		3090
905	sub cf::client::coro {	3091	sub cf::client::async {
906	my ($self, $cb) = @_;	3092	my ($self, $cb) = @_;
907		3093
908	my $coro; $coro = async {	3094	my $coro = &Coro::async ($cb);
909	eval {	3095
910	$cb->();	3096	$coro->on_destroy (sub {
911	};
912	warn $@ if $@;
913	delete $self->{_coro}{$coro+0};	3097	delete $self->{_coro}{$coro+0};
914	};	3098	});
915		3099
916	$self->{_coro}{$coro+0} = $coro;	3100	$self->{_coro}{$coro+0} = $coro;
		3101
		3102	$coro
917	}	3103	}
918		3104
919	cf::client->attach (	3105	cf::client->attach (
920	on_destroy => sub {	3106	on_destroy => sub {
921	my ($ns) = @_;	3107	my ($ns) = @_;
…		…
940	our $safe = new Safe "safe";	3126	our $safe = new Safe "safe";
941	our $safe_hole = new Safe::Hole;	3127	our $safe_hole = new Safe::Hole;
942		3128
943	$SIG{FPE} = 'IGNORE';	3129	$SIG{FPE} = 'IGNORE';
944		3130
945	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3131	$safe->permit_only (Opcode::opset qw(
		3132	:base_core :base_mem :base_orig :base_math
		3133	grepstart grepwhile mapstart mapwhile
		3134	sort time
		3135	));
946		3136
947	# here we export the classes and methods available to script code	3137	# here we export the classes and methods available to script code
948		3138
949	=pod	3139	=pod
950		3140
951	The following fucntions and emthods are available within a safe environment:	3141	The following functions and methods are available within a safe environment:
952		3142
953	cf::object contr pay_amount pay_player map	3143	cf::object
		3144	contr pay_amount pay_player map x y force_find force_add destroy
		3145	insert remove name archname title slaying race decrease split
		3146	value
		3147
954	cf::object::player player	3148	cf::object::player
955	cf::player peaceful	3149	player
956	cf::map trigger	3150
		3151	cf::player
		3152	peaceful
		3153
		3154	cf::map
		3155	trigger
957		3156
958	=cut	3157	=cut
959		3158
960	for (	3159	for (
961	["cf::object" => qw(contr pay_amount pay_player map)],	3160	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3161	insert remove inv nrof name archname title slaying race
		3162	decrease split destroy change_exp value msg lore send_msg)],
962	["cf::object::player" => qw(player)],	3163	["cf::object::player" => qw(player)],
963	["cf::player" => qw(peaceful)],	3164	["cf::player" => qw(peaceful send_msg)],
964	["cf::map" => qw(trigger)],	3165	["cf::map" => qw(trigger)],
965	) {	3166	) {
966	no strict 'refs';	3167	no strict 'refs';
967	my ($pkg, @funs) = @$_;	3168	my ($pkg, @funs) = @$_;
968	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3169	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
985	my ($code, %vars) = @_;	3186	my ($code, %vars) = @_;
986		3187
987	my $qcode = $code;	3188	my $qcode = $code;
988	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3189	$qcode =~ s/"/‟/g; # not allowed in #line filenames
989	$qcode =~ s/\n/\\n/g;	3190	$qcode =~ s/\n/\\n/g;
		3191
		3192	%vars = (_dummy => 0) unless %vars;
990		3193
991	local $_;	3194	local $_;
992	local @safe::cf::_safe_eval_args = values %vars;	3195	local @safe::cf::_safe_eval_args = values %vars;
993		3196
994	my $eval =	3197	my $eval =
…		…
1037	=back	3240	=back
1038		3241
1039	=cut	3242	=cut
1040		3243
1041	#############################################################################	3244	#############################################################################
		3245	# the server's init and main functions
1042		3246
1043	=head2 EXTENSION DATABASE SUPPORT	3247	sub load_facedata($) {
		3248	my ($path) = @_;
1044		3249
1045	Crossfire maintains a very simple database for extension use. It can	3250	# HACK to clear player env face cache, we need some signal framework
1046	currently store anything that can be serialised using Storable, which	3251	# for this (global event?)
1047	excludes objects.	3252	%ext::player_env::MUSIC_FACE_CACHE = ();
1048		3253
1049	The parameter C<$family> should best start with the name of the extension	3254	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1050	using it, it should be unique.
1051		3255
1052	=over 4	3256	warn "loading facedata from $path\n";
1053		3257
1054	=item $hashref = cf::db_get $family	3258	my $facedata;
		3259	0 < aio_load $path, $facedata
		3260	or die "$path: $!";
1055		3261
1056	Return a hashref for use by the extension C<$family>, which can be	3262	$facedata = Coro::Storable::thaw $facedata;
1057	modified. After modifications, you have to call C<cf::db_dirty> or
1058	C<cf::db_sync>.
1059		3263
1060	=item $value = cf::db_get $family => $key	3264	$facedata->{version} == 2
		3265	or cf::cleanup "$path: version mismatch, cannot proceed.";
1061		3266
1062	Returns a single value from the database	3267	# patch in the exptable
		3268	$facedata->{resource}{"res/exp_table"} = {
		3269	type => FT_RSRC,
		3270	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		3271	};
		3272	cf::cede_to_tick;
1063		3273
1064	=item cf::db_put $family => $hashref	3274	{
		3275	my $faces = $facedata->{faceinfo};
1065		3276
1066	Stores the given family hashref into the database. Updates are delayed, if	3277	while (my ($face, $info) = each %$faces) {
1067	you want the data to be synced to disk immediately, use C<cf::db_sync>.	3278	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1068		3279
1069	=item cf::db_put $family => $key => $value	3280	cf::face::set_visibility $idx, $info->{visibility};
		3281	cf::face::set_magicmap $idx, $info->{magicmap};
		3282	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		3283	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1070		3284
1071	Stores the given C<$value> in the family hash. Updates are delayed, if you	3285	cf::cede_to_tick;
1072	want the data to be synced to disk immediately, use C<cf::db_sync>.	3286	}
1073		3287
1074	=item cf::db_dirty	3288	while (my ($face, $info) = each %$faces) {
		3289	next unless $info->{smooth};
1075		3290
1076	Marks the database as dirty, to be updated at a later time.	3291	my $idx = cf::face::find $face
		3292	or next;
1077		3293
1078	=item cf::db_sync	3294	if (my $smooth = cf::face::find $info->{smooth}) {
		3295	cf::face::set_smooth $idx, $smooth;
		3296	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3297	} else {
		3298	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3299	}
1079		3300
1080	Immediately write the database to disk I<if it is dirty>.	3301	cf::cede_to_tick;
		3302	}
		3303	}
1081		3304
1082	=cut	3305	{
		3306	my $anims = $facedata->{animinfo};
1083		3307
1084	our $DB;	3308	while (my ($anim, $info) = each %$anims) {
		3309	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3310	cf::cede_to_tick;
		3311	}
		3312
		3313	cf::anim::invalidate_all; # d'oh
		3314	}
		3315
		3316	{
		3317	# TODO: for gcfclient pleasure, we should give resources
		3318	# that gcfclient doesn't grok a >10000 face index.
		3319	my $res = $facedata->{resource};
		3320
		3321	while (my ($name, $info) = each %$res) {
		3322	if (defined $info->{type}) {
		3323	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3324	my $data;
		3325
		3326	if ($info->{type} & 1) {
		3327	# prepend meta info
		3328
		3329	my $meta = $enc->encode ({
		3330	name => $name,
		3331	%{ $info->{meta} || {} },
		3332	});
		3333
		3334	$data = pack "(w/a*)*", $meta, $info->{data};
		3335	} else {
		3336	$data = $info->{data};
		3337	}
		3338
		3339	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3340	cf::face::set_type $idx, $info->{type};
		3341	} else {
		3342	$RESOURCE{$name} = $info;
		3343	}
		3344
		3345	cf::cede_to_tick;
		3346	}
		3347	}
		3348
		3349	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3350
		3351	1
		3352	}
		3353
		3354	cf::global->attach (on_resource_update => sub {
		3355	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3356	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3357
		3358	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3359	my $sound = $soundconf->{compat}[$_]
		3360	or next;
		3361
		3362	my $face = cf::face::find "sound/$sound->[1]";
		3363	cf::sound::set $sound->[0] => $face;
		3364	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3365	}
		3366
		3367	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3368	my $face = cf::face::find "sound/$v";
		3369	cf::sound::set $k => $face;
		3370	}
		3371	}
		3372	});
		3373
		3374	register_exticmd fx_want => sub {
		3375	my ($ns, $want) = @_;
		3376
		3377	while (my ($k, $v) = each %$want) {
		3378	$ns->fx_want ($k, $v);
		3379	}
		3380	};
		3381
		3382	sub load_resource_file($) {
		3383	my $guard = lock_acquire "load_resource_file";
		3384
		3385	my $status = load_resource_file_ $_[0];
		3386	get_slot 0.1, 100;
		3387	cf::arch::commit_load;
		3388
		3389	$status
		3390	}
		3391
		3392	sub reload_regions {
		3393	# HACK to clear player env face cache, we need some signal framework
		3394	# for this (global event?)
		3395	%ext::player_env::MUSIC_FACE_CACHE = ();
		3396
		3397	load_resource_file "$MAPDIR/regions"
		3398	or die "unable to load regions file\n";
		3399
		3400	for (cf::region::list) {
		3401	$_->{match} = qr/$_->{match}/
		3402	if exists $_->{match};
		3403	}
		3404	}
		3405
		3406	sub reload_facedata {
		3407	load_facedata "$DATADIR/facedata"
		3408	or die "unable to load facedata\n";
		3409	}
		3410
		3411	sub reload_archetypes {
		3412	load_resource_file "$DATADIR/archetypes"
		3413	or die "unable to load archetypes\n";
		3414	}
		3415
		3416	sub reload_treasures {
		3417	load_resource_file "$DATADIR/treasures"
		3418	or die "unable to load treasurelists\n";
		3419	}
		3420
		3421	sub reload_resources {
		3422	warn "reloading resource files...\n";
		3423
		3424	reload_facedata;
		3425	reload_archetypes;
		3426	reload_regions;
		3427	reload_treasures;
		3428
		3429	warn "finished reloading resource files\n";
		3430	}
		3431
		3432	sub reload_config {
		3433	warn "reloading config file...\n";
		3434
		3435	open my $fh, "<:utf8", "$CONFDIR/config"
		3436	or return;
		3437
		3438	local $/;
		3439	*CFG = YAML::XS::Load scalar <$fh>;
		3440
		3441	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3442
		3443	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3444	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3445
		3446	if (exists $CFG{mlockall}) {
		3447	eval {
		3448	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3449	and die "WARNING: m(un)lockall failed: $!\n";
		3450	};
		3451	warn $@ if $@;
		3452	}
		3453
		3454	warn "finished reloading resource files\n";
		3455	}
		3456
		3457	sub pidfile() {
		3458	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3459	or die "$PIDFILE: $!";
		3460	flock $fh, &Fcntl::LOCK_EX
		3461	or die "$PIDFILE: flock: $!";
		3462	$fh
		3463	}
		3464
		3465	# make sure only one server instance is running at any one time
		3466	sub atomic {
		3467	my $fh = pidfile;
		3468
		3469	my $pid = <$fh>;
		3470	kill 9, $pid if $pid > 0;
		3471
		3472	seek $fh, 0, 0;
		3473	print $fh $$;
		3474	}
		3475
		3476	sub main_loop {
		3477	warn "EV::loop starting\n";
		3478	if (1) {
		3479	EV::loop;
		3480	}
		3481	warn "EV::loop returned\n";
		3482	goto &main_loop unless $REALLY_UNLOOP;
		3483	}
		3484
		3485	sub main {
		3486	cf::init_globals; # initialise logging
		3487
		3488	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3489	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3490	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3491	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3492
		3493	cf::init_experience;
		3494	cf::init_anim;
		3495	cf::init_attackmess;
		3496	cf::init_dynamic;
		3497
		3498	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3499
		3500	# we must not ever block the main coroutine
		3501	local $Coro::idle = sub {
		3502	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3503	(async {
		3504	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3505	EV::loop EV::LOOP_ONESHOT;
		3506	})->prio (Coro::PRIO_MAX);
		3507	};
		3508
		3509	evthread_start IO::AIO::poll_fileno;
		3510
		3511	cf::sync_job {
		3512	reload_resources;
		3513	reload_config;
		3514	db_init;
		3515
		3516	cf::load_settings;
		3517	cf::load_materials;
		3518	cf::init_uuid;
		3519	cf::init_signals;
		3520	cf::init_commands;
		3521	cf::init_skills;
		3522
		3523	cf::init_beforeplay;
		3524
		3525	atomic;
		3526
		3527	load_extensions;
		3528
		3529	utime time, time, $RUNTIMEFILE;
		3530
		3531	# no (long-running) fork's whatsoever before this point(!)
		3532	use POSIX ();
		3533	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3534
		3535	(pop @POST_INIT)->(0) while @POST_INIT;
		3536	};
		3537
		3538	main_loop;
		3539	}
		3540
		3541	#############################################################################
		3542	# initialisation and cleanup
		3543
		3544	# install some emergency cleanup handlers
		3545	BEGIN {
		3546	our %SIGWATCHER = ();
		3547	for my $signal (qw(INT HUP TERM)) {
		3548	$SIGWATCHER{$signal} = EV::signal $signal, sub {
		3549	cf::cleanup "SIG$signal";
		3550	};
		3551	}
		3552	}
		3553
		3554	sub write_runtime_sync {
		3555	# first touch the runtime file to show we are still running:
		3556	# the fsync below can take a very very long time.
		3557
		3558	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3559
		3560	my $guard = cf::lock_acquire "write_runtime";
		3561
		3562	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
		3563	or return;
		3564
		3565	my $value = $cf::RUNTIME + 90 + 10;
		3566	# 10 is the runtime save interval, for a monotonic clock
		3567	# 60 allows for the watchdog to kill the server.
		3568
		3569	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3570	and return;
		3571
		3572	# always fsync - this file is important
		3573	aio_fsync $fh
		3574	and return;
		3575
		3576	# touch it again to show we are up-to-date
		3577	aio_utime $fh, undef, undef;
		3578
		3579	close $fh
		3580	or return;
		3581
		3582	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3583	and return;
		3584
		3585	warn "runtime file written.\n";
		3586
		3587	1
		3588	}
		3589
		3590	our $uuid_lock;
		3591	our $uuid_skip;
		3592
		3593	sub write_uuid_sync($) {
		3594	$uuid_skip ||= $_[0];
		3595
		3596	return if $uuid_lock;
		3597	local $uuid_lock = 1;
		3598
		3599	my $uuid = "$LOCALDIR/uuid";
		3600
		3601	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3602	or return;
		3603
		3604	my $value = uuid_seq uuid_cur;
		3605
		3606	unless ($value) {
		3607	warn "cowardly refusing to write zero uuid value!\n";
		3608	return;
		3609	}
		3610
		3611	my $value = uuid_str $value + $uuid_skip;
		3612	$uuid_skip = 0;
		3613
		3614	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3615	and return;
		3616
		3617	# always fsync - this file is important
		3618	aio_fsync $fh
		3619	and return;
		3620
		3621	close $fh
		3622	or return;
		3623
		3624	aio_rename "$uuid~", $uuid
		3625	and return;
		3626
		3627	warn "uuid file written ($value).\n";
		3628
		3629	1
		3630
		3631	}
		3632
		3633	sub write_uuid($$) {
		3634	my ($skip, $sync) = @_;
		3635
		3636	$sync ? write_uuid_sync $skip
		3637	: async { write_uuid_sync $skip };
		3638	}
		3639
		3640	sub emergency_save() {
		3641	my $freeze_guard = cf::freeze_mainloop;
		3642
		3643	warn "emergency_perl_save: enter\n";
		3644
		3645	cf::sync_job {
		3646	# this is a trade-off: we want to be very quick here, so
		3647	# save all maps without fsync, and later call a global sync
		3648	# (which in turn might be very very slow)
		3649	local $USE_FSYNC = 0;
		3650
		3651	# use a peculiar iteration method to avoid tripping on perl
		3652	# refcount bugs in for. also avoids problems with players
		3653	# and maps saved/destroyed asynchronously.
		3654	warn "emergency_perl_save: begin player save\n";
		3655	for my $login (keys %cf::PLAYER) {
		3656	my $pl = $cf::PLAYER{$login} or next;
		3657	$pl->valid or next;
		3658	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
		3659	$pl->save;
		3660	}
		3661	warn "emergency_perl_save: end player save\n";
		3662
		3663	warn "emergency_perl_save: begin map save\n";
		3664	for my $path (keys %cf::MAP) {
		3665	my $map = $cf::MAP{$path} or next;
		3666	$map->valid or next;
		3667	$map->save;
		3668	}
		3669	warn "emergency_perl_save: end map save\n";
		3670
		3671	warn "emergency_perl_save: begin database checkpoint\n";
		3672	BDB::db_env_txn_checkpoint $DB_ENV;
		3673	warn "emergency_perl_save: end database checkpoint\n";
		3674
		3675	warn "emergency_perl_save: begin write uuid\n";
		3676	write_uuid_sync 1;
		3677	warn "emergency_perl_save: end write uuid\n";
		3678	};
		3679
		3680	warn "emergency_perl_save: starting sync()\n";
		3681	IO::AIO::aio_sync sub {
		3682	warn "emergency_perl_save: finished sync()\n";
		3683	};
		3684
		3685	warn "emergency_perl_save: leave\n";
		3686	}
		3687
		3688	sub post_cleanup {
		3689	my ($make_core) = @_;
		3690
		3691	warn Carp::longmess "post_cleanup backtrace"
		3692	if $make_core;
		3693
		3694	my $fh = pidfile;
		3695	unlink $PIDFILE if <$fh> == $$;
		3696	}
		3697
		3698	# a safer delete_package, copied from Symbol
		3699	sub clear_package($) {
		3700	my $pkg = shift;
		3701
		3702	# expand to full symbol table name if needed
		3703	unless ($pkg =~ /^main::.*::$/) {
		3704	$pkg = "main$pkg" if $pkg =~ /^::/;
		3705	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3706	$pkg .= '::' unless $pkg =~ /::$/;
		3707	}
		3708
		3709	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3710	my $stem_symtab = *{$stem}{HASH};
		3711
		3712	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3713	or return;
		3714
		3715	# clear all symbols
		3716	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3717	for my $name (keys %$leaf_symtab) {
		3718	_gv_clear *{"$pkg$name"};
		3719	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3720	}
		3721	warn "cleared package $pkg\n";#d#
		3722	}
		3723
		3724	sub do_reload_perl() {
		3725	# can/must only be called in main
		3726	if ($Coro::current != $Coro::main) {
		3727	warn "can only reload from main coroutine";
		3728	return;
		3729	}
		3730
		3731	return if $RELOAD++;
		3732
		3733	my $t1 = EV::time;
		3734
		3735	while ($RELOAD) {
		3736	warn "reloading...";
		3737
		3738	warn "entering sync_job";
		3739
		3740	cf::sync_job {
		3741	cf::write_runtime_sync; # external watchdog should not bark
		3742	cf::emergency_save;
		3743	cf::write_runtime_sync; # external watchdog should not bark
		3744
		3745	warn "syncing database to disk";
		3746	BDB::db_env_txn_checkpoint $DB_ENV;
		3747
		3748	# if anything goes wrong in here, we should simply crash as we already saved
		3749
		3750	warn "flushing outstanding aio requests";
		3751	while (IO::AIO::nreqs || BDB::nreqs) {
		3752	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
		3753	}
		3754
		3755	warn "cancelling all extension coros";
		3756	$_->cancel for values %EXT_CORO;
		3757	%EXT_CORO = ();
		3758
		3759	warn "removing commands";
		3760	%COMMAND = ();
		3761
		3762	warn "removing ext/exti commands";
		3763	%EXTCMD = ();
		3764	%EXTICMD = ();
		3765
		3766	warn "unloading/nuking all extensions";
		3767	for my $pkg (@EXTS) {
		3768	warn "... unloading $pkg";
		3769
		3770	if (my $cb = $pkg->can ("unload")) {
		3771	eval {
		3772	$cb->($pkg);
		3773	1
		3774	} or warn "$pkg unloaded, but with errors: $@";
		3775	}
		3776
		3777	warn "... clearing $pkg";
		3778	clear_package $pkg;
		3779	}
		3780
		3781	warn "unloading all perl modules loaded from $LIBDIR";
		3782	while (my ($k, $v) = each %INC) {
		3783	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3784
		3785	warn "... unloading $k";
		3786	delete $INC{$k};
		3787
		3788	$k =~ s/\.pm$//;
		3789	$k =~ s/\//::/g;
		3790
		3791	if (my $cb = $k->can ("unload_module")) {
		3792	$cb->();
		3793	}
		3794
		3795	clear_package $k;
		3796	}
		3797
		3798	warn "getting rid of safe::, as good as possible";
		3799	clear_package "safe::$_"
		3800	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		3801
		3802	warn "unloading cf.pm \"a bit\"";
		3803	delete $INC{"cf.pm"};
		3804	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
		3805
		3806	# don't, removes xs symbols, too,
		3807	# and global variables created in xs
		3808	#clear_package __PACKAGE__;
		3809
		3810	warn "unload completed, starting to reload now";
		3811
		3812	warn "reloading cf.pm";
		3813	require cf;
		3814	cf::_connect_to_perl_1;
		3815
		3816	warn "loading config and database again";
		3817	cf::reload_config;
		3818
		3819	warn "loading extensions";
		3820	cf::load_extensions;
		3821
		3822	if ($REATTACH_ON_RELOAD) {
		3823	warn "reattaching attachments to objects/players";
		3824	_global_reattach; # objects, sockets
		3825	warn "reattaching attachments to maps";
		3826	reattach $_ for values %MAP;
		3827	warn "reattaching attachments to players";
		3828	reattach $_ for values %PLAYER;
		3829	}
		3830
		3831	warn "running post_init jobs";
		3832	(pop @POST_INIT)->(1) while @POST_INIT;
		3833
		3834	warn "leaving sync_job";
		3835
		3836	1
		3837	} or do {
		3838	warn $@;
		3839	cf::cleanup "error while reloading, exiting.";
		3840	};
		3841
		3842	warn "reloaded";
		3843	--$RELOAD;
		3844	}
		3845
		3846	$t1 = EV::time - $t1;
		3847	warn "reload completed in ${t1}s\n";
		3848	};
		3849
		3850	our $RELOAD_WATCHER; # used only during reload
		3851
		3852	sub reload_perl() {
		3853	# doing reload synchronously and two reloads happen back-to-back,
		3854	# coro crashes during coro_state_free->destroy here.
		3855
		3856	$RELOAD_WATCHER ||= cf::async {
		3857	Coro::AIO::aio_wait cache_extensions;
		3858
		3859	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3860	do_reload_perl;
		3861	undef $RELOAD_WATCHER;
		3862	};
		3863	};
		3864	}
		3865
		3866	register_command "reload" => sub {
		3867	my ($who, $arg) = @_;
		3868
		3869	if ($who->flag (FLAG_WIZ)) {
		3870	$who->message ("reloading server.");
		3871	async {
		3872	$Coro::current->{desc} = "perl_reload";
		3873	reload_perl;
		3874	};
		3875	}
		3876	};
		3877
		3878	unshift @INC, $LIBDIR;
		3879
		3880	my $bug_warning = 0;
		3881
		3882	our @WAIT_FOR_TICK;
		3883	our @WAIT_FOR_TICK_BEGIN;
		3884
		3885	sub wait_for_tick {
		3886	return if tick_inhibit || $Coro::current == $Coro::main;
		3887
		3888	my $signal = new Coro::Signal;
		3889	push @WAIT_FOR_TICK, $signal;
		3890	$signal->wait;
		3891	}
		3892
		3893	sub wait_for_tick_begin {
		3894	return if tick_inhibit || $Coro::current == $Coro::main;
		3895
		3896	my $signal = new Coro::Signal;
		3897	push @WAIT_FOR_TICK_BEGIN, $signal;
		3898	$signal->wait;
		3899	}
		3900
		3901	sub tick {
		3902	if ($Coro::current != $Coro::main) {
		3903	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3904	unless ++$bug_warning > 10;
		3905	return;
		3906	}
		3907
		3908	cf::server_tick; # one server iteration
		3909
		3910	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3911	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		3912	Coro::async_pool {
		3913	$Coro::current->{desc} = "runtime saver";
		3914	write_runtime_sync
		3915	or warn "ERROR: unable to write runtime file: $!";
		3916	};
		3917	}
		3918
		3919	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3920	$sig->send;
		3921	}
		3922	while (my $sig = shift @WAIT_FOR_TICK) {
		3923	$sig->send;
		3924	}
		3925
		3926	$LOAD = ($NOW - $TICK_START) / $TICK;
		3927	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3928
		3929	if (0) {
		3930	if ($NEXT_TICK) {
		3931	my $jitter = $TICK_START - $NEXT_TICK;
		3932	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3933	warn "jitter $JITTER\n";#d#
		3934	}
		3935	}
		3936	}
1085		3937
1086	{	3938	{
1087	my $path = cf::localdir . "/database.pst";	3939	# configure BDB
1088		3940
1089	sub db_load() {	3941	BDB::min_parallel 8;
1090	warn "loading database $path\n";#d# remove later	3942	BDB::max_poll_reqs $TICK * 0.1;
1091	$DB = stat $path ? Storable::retrieve $path : { };	3943	$AnyEvent::BDB::WATCHER->priority (1);
1092	}
1093		3944
1094	my $pid;	3945	unless ($DB_ENV) {
		3946	$DB_ENV = BDB::db_env_create;
		3947	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3948	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3949	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3950	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3951	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
1095		3952
1096	sub db_save() {	3953	cf::sync_job {
1097	warn "saving database $path\n";#d# remove later
1098	waitpid $pid, 0 if $pid;
1099	if (0 == ($pid = fork)) {
1100	$DB->{_meta}{version} = 1;
1101	Storable::nstore $DB, "$path~";
1102	rename "$path~", $path;
1103	cf::_exit 0 if defined $pid;
1104	}
1105	}
1106
1107	my $dirty;
1108
1109	sub db_sync() {
1110	db_save if $dirty;
1111	undef $dirty;
1112	}
1113
1114	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1115	db_sync;
1116	});
1117
1118	sub db_dirty() {
1119	$dirty = 1;
1120	$idle->start;
1121	}
1122
1123	sub db_get($;$) {
1124	@_ >= 2
1125	? $DB->{$_[0]}{$_[1]}
1126	: ($DB->{$_[0]} ||= { })
1127	}
1128
1129	sub db_put($$;$) {
1130	if (@_ >= 3) {
1131	$DB->{$_[0]}{$_[1]} = $_[2];
1132	} else {	3954	eval {
1133	$DB->{$_[0]} = $_[1];	3955	BDB::db_env_open
1134	}	3956	$DB_ENV,
1135	db_dirty;	3957	$BDBDIR,
1136	}	3958	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3959	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3960	0666;
1137		3961
1138	cf::global->attach (	3962	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
1139	prio => 10000,
1140	on_cleanup => sub {
1141	db_sync;
1142	},
1143	);
1144	}
1145
1146	#############################################################################
1147	# the server's main()
1148
1149	sub cfg_load {
1150	open my $fh, "<:utf8", cf::confdir . "/config"
1151	or return;
1152
1153	local $/;
1154	*CFG = YAML::Syck::Load <$fh>;
1155	}
1156
1157	sub main {
1158	cfg_load;
1159	db_load;
1160	load_extensions;
1161	Event::loop;
1162	}
1163
1164	#############################################################################
1165	# initialisation
1166
1167	sub _perl_reload(&) {
1168	my ($msg) = @_;
1169
1170	$msg->("reloading...");
1171
1172	eval {
1173	# cancel all watchers
1174	for (Event::all_watchers) {
1175	$_->cancel if $_->data & WF_AUTOCANCEL;
1176	}
1177
1178	# unload all extensions
1179	for (@exts) {
1180	$msg->("unloading <$_>");
1181	unload_extension $_;
1182	}
1183
1184	# unload all modules loaded from $LIBDIR
1185	while (my ($k, $v) = each %INC) {
1186	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1187
1188	$msg->("removing <$k>");
1189	delete $INC{$k};
1190
1191	$k =~ s/\.pm$//;
1192	$k =~ s/\//::/g;
1193
1194	if (my $cb = $k->can ("unload_module")) {
1195	$cb->();
1196	}	3963	};
1197		3964
1198	Symbol::delete_package $k;	3965	cf::cleanup "db_env_open(db): $@" if $@;
1199	}	3966	};
		3967	}
1200		3968
1201	# sync database to disk	3969	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
1202	cf::db_sync;	3970	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
1203
1204	# get rid of safe::, as good as possible
1205	Symbol::delete_package "safe::$_"
1206	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1207
1208	# remove register_script_function callbacks
1209	# TODO
1210
1211	# unload cf.pm "a bit"
1212	delete $INC{"cf.pm"};
1213
1214	# don't, removes xs symbols, too,
1215	# and global variables created in xs
1216	#Symbol::delete_package __PACKAGE__;
1217
1218	# reload cf.pm
1219	$msg->("reloading cf.pm");
1220	require cf;
1221
1222	# load config and database again
1223	cf::cfg_load;
1224	cf::db_load;
1225
1226	# load extensions
1227	$msg->("load extensions");
1228	cf::load_extensions;
1229
1230	# reattach attachments to objects
1231	$msg->("reattach");
1232	_global_reattach;
1233	};	3971	};
1234	$msg->($@) if $@;	3972	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
1235		3973	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
1236	$msg->("reloaded");
1237	};
1238
1239	sub perl_reload() {
1240	_perl_reload {
1241	warn $_[0];
1242	print "$_[0]\n";
1243	};	3974	};
		3975	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3976	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3977	};
1244	}	3978	}
1245		3979
1246	register "<global>", __PACKAGE__;	3980	{
		3981	# configure IO::AIO
1247		3982
1248	register_command "perl-reload" => sub {	3983	IO::AIO::min_parallel 8;
		3984	IO::AIO::max_poll_time $TICK * 0.1;
		3985	undef $AnyEvent::AIO::WATCHER;
		3986	}
		3987
		3988	my $_log_backtrace;
		3989
		3990	sub _log_backtrace {
1249	my ($who, $arg) = @_;	3991	my ($msg, @addr) = @_;
1250		3992
1251	if ($who->flag (FLAG_WIZ)) {	3993	$msg =~ s/\n//;
1252	_perl_reload {	3994
1253	warn $_[0];	3995	# limit the # of concurrent backtraces
1254	$who->message ($_[0]);	3996	if ($_log_backtrace < 2) {
		3997	++$_log_backtrace;
		3998	my $perl_bt = Carp::longmess $msg;
		3999	async {
		4000	$Coro::current->{desc} = "abt $msg";
		4001
		4002	my @bt = fork_call {
		4003	@addr = map { sprintf "%x", $_ } @addr;
		4004	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4005	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4006	or die "addr2line: $!";
		4007
		4008	my @funcs;
		4009	my @res = <$fh>;
		4010	chomp for @res;
		4011	while (@res) {
		4012	my ($func, $line) = splice @res, 0, 2, ();
		4013	push @funcs, "[$func] $line";
		4014	}
		4015
		4016	@funcs
		4017	};
		4018
		4019	LOG llevInfo, "[ABT] $perl_bt\n";
		4020	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4021	LOG llevInfo, "[ABT] $_\n" for @bt;
		4022	--$_log_backtrace;
1255	};	4023	};
1256	}	4024	} else {
1257	};	4025	LOG llevInfo, "[ABT] $msg\n";
1258		4026	LOG llevInfo, "[ABT] [suppressed]\n";
1259	unshift @INC, $LIBDIR;
1260
1261	$TICK_WATCHER = Event->timer (
1262	prio => 0,
1263	at => $NEXT_TICK || 1,
1264	data => WF_AUTOCANCEL,
1265	cb => sub {
1266	cf::server_tick; # one server iteration
1267
1268	my $NOW = Event::time;
1269	$NEXT_TICK += $TICK;
1270
1271	# if we are delayed by four ticks or more, skip them all
1272	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1273
1274	$TICK_WATCHER->at ($NEXT_TICK);
1275	$TICK_WATCHER->start;
1276	},	4027	}
1277	);	4028	}
1278		4029
1279	IO::AIO::max_poll_time $TICK * 0.2;	4030	# load additional modules
		4031	require "cf/$_.pm" for @EXTRA_MODULES;
		4032	cf::_connect_to_perl_2;
1280		4033
1281	Event->io (fd => IO::AIO::poll_fileno,	4034	END { cf::emergency_save }
1282	poll => 'r',
1283	prio => 5,
1284	data => WF_AUTOCANCEL,
1285	cb => \&IO::AIO::poll_cb);
1286		4035
1287	1	4036	1
1288		4037

Diff Legend

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