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.187 by root, Sat Jan 20 21:06:52 2007 UTC vs.
Revision 1.413 by root, Sun Apr 6 16:13:20 2008 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
		7	# it under the terms of the GNU General Public License as published by
		8	# the Free Software Foundation, either version 3 of the License, or
		9	# (at your 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 GNU General Public License
		17	# along with this program. If not, see <http://www.gnu.org/licenses/>.
		18	#
		19	# The authors can be reached via e-mail to <support@deliantra.net>
		20	#
		21
1	package cf;	22	package cf;
2		23
3	use utf8;	24	use utf8;
4	use strict;	25	use strict;
5		26
6	use Symbol;	27	use Symbol;
7	use List::Util;	28	use List::Util;
8	use Storable;	29	use Socket;
		30	use EV 3.2;
9	use Opcode;	31	use Opcode;
10	use Safe;	32	use Safe;
11	use Safe::Hole;	33	use Safe::Hole;
		34	use Storable ();
12		35
13	use Coro 3.4 ();	36	use Coro 4.32 ();
		37	use Coro::State;
		38	use Coro::Handle;
14	use Coro::Event;	39	use Coro::EV;
15	use Coro::Timer;	40	use Coro::Timer;
16	use Coro::Signal;	41	use Coro::Signal;
17	use Coro::Semaphore;	42	use Coro::Semaphore;
18	use Coro::AIO;	43	use Coro::AIO;
		44	use Coro::BDB;
		45	use Coro::Storable;
		46	use Coro::Util ();
19		47
		48	use JSON::XS 2.01 ();
		49	use BDB ();
20	use Data::Dumper;	50	use Data::Dumper;
21	use Digest::MD5;	51	use Digest::MD5;
22	use Fcntl;	52	use Fcntl;
		53	use YAML ();
23	use IO::AIO 2.32 ();	54	use IO::AIO 2.51 ();
24	use YAML::Syck ();
25	use Time::HiRes;	55	use Time::HiRes;
		56	use Compress::LZF;
		57	use Digest::MD5 ();
26		58
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	59	# configure various modules to our taste
		60	#
		61	$Storable::canonical = 1; # reduce rsync transfers
		62	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		63	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		64
		65	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
28		66
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	67	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;
33
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		68
36	our %COMMAND = ();	69	our %COMMAND = ();
37	our %COMMAND_TIME = ();	70	our %COMMAND_TIME = ();
38		71
39	our @EXTS = (); # list of extension package names	72	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	73	our %EXTCMD = ();
		74	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	75	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	76	our %EXT_MAP = (); # pluggable maps
43		77
		78	our $RELOAD; # number of reloads so far
44	our @EVENT;	79	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		80
47	our $TICK = MAX_TIME * 1e-6;	81	our $CONFDIR = confdir;
48	our $TICK_WATCHER;	82	our $DATADIR = datadir;
		83	our $LIBDIR = "$DATADIR/ext";
		84	our $PODDIR = "$DATADIR/pod";
		85	our $MAPDIR = "$DATADIR/" . mapdir;
		86	our $LOCALDIR = localdir;
		87	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		88	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		89	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		90	our $RANDOMDIR = "$LOCALDIR/random";
		91	our $BDBDIR = "$LOCALDIR/db";
		92	our %RESOURCE;
		93
		94	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
49	our $AIO_POLL_WATCHER;	95	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	96	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	97	our $NEXT_TICK;
52	our $NOW;	98	our $USE_FSYNC = 1; # use fsync to write maps - default off
		99
		100	our $BDB_POLL_WATCHER;
		101	our $BDB_DEADLOCK_WATCHER;
		102	our $BDB_CHECKPOINT_WATCHER;
		103	our $BDB_TRICKLE_WATCHER;
		104	our $DB_ENV;
53		105
54	our %CFG;	106	our %CFG;
55		107
56	our $UPTIME; $UPTIME ||= time;	108	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	109	our $RUNTIME;
		110	our $NOW;
58		111
59	our %PLAYER; # all users	112	our (%PLAYER, %PLAYER_LOADING); # all users
60	our %MAP; # all maps	113	our (%MAP, %MAP_LOADING ); # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	114	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		115
67	# used to convert map paths into valid unix filenames by replacing / by ∕	116	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	117	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		118
		119	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		120	our $LOADAVG; # same thing, but with alpha-smoothing
		121	our $JITTER; # average jitter
		122	our $TICK_START; # for load detecting purposes
		123
70	binmode STDOUT;	124	binmode STDOUT;
71	binmode STDERR;	125	binmode STDERR;
72		126
73	# read virtual server time, if available	127	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	128	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	129	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	130	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	131	$RUNTIME = <$fh> + 0.;
78	}	132	}
79		133
80	mkdir cf::localdir;	134	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	135	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		136
86	our $EMERGENCY_POSITION;	137	our $EMERGENCY_POSITION;
		138
		139	sub cf::map::normalise;
87		140
88	#############################################################################	141	#############################################################################
89		142
90	=head2 GLOBAL VARIABLES	143	=head2 GLOBAL VARIABLES
91		144
…		…
98	=item $cf::RUNTIME	151	=item $cf::RUNTIME
99		152
100	The time this server has run, starts at 0 and is increased by $cf::TICK on	153	The time this server has run, starts at 0 and is increased by $cf::TICK on
101	every server tick.	154	every server tick.
102		155
103	=item $cf::LIBDIR	156	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		157	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		158	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104		159
105	The perl library directory, where extensions and cf-specific modules can	160	Various directories - "/etc", read-only install directory, perl-library
106	be found. It will be added to C<@INC> automatically.	161	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		162	unique-items directory, player file directory, random maps directory and
		163	database environment.
107		164
108	=item $cf::NOW	165	=item $cf::NOW
109		166
110	The time of the last (current) server tick.	167	The time of the last (current) server tick.
111		168
112	=item $cf::TICK	169	=item $cf::TICK
113		170
114	The interval between server ticks, in seconds.	171	The interval between server ticks, in seconds.
115		172
		173	=item $cf::LOADAVG
		174
		175	The current CPU load on the server (alpha-smoothed), as a value between 0
		176	(none) and 1 (overloaded), indicating how much time is spent on processing
		177	objects per tick. Healthy values are < 0.5.
		178
		179	=item $cf::LOAD
		180
		181	The raw value load value from the last tick.
		182
116	=item %cf::CFG	183	=item %cf::CFG
117		184
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	185	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
119	from wherever your confdir points to.	186	from wherever your confdir points to.
120		187
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	188	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		189
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	190	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	191	returns directly I<after> the tick processing (and consequently, can only wake one process
125	processing has been done. Call C<< ->wait >> on them to maximise the	192	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126	window of cpu time available, or simply to synchronise to the server tick.	193
		194	=item @cf::INVOKE_RESULTS
		195
		196	This array contains the results of the last C<invoke ()> call. When
		197	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		198	that call.
127		199
128	=back	200	=back
129		201
130	=cut	202	=cut
131		203
132	BEGIN {	204	BEGIN {
133	*CORE::GLOBAL::warn = sub {	205	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	206	my $msg = join "", @_;
135	utf8::encode $msg;
136		207
137	$msg .= "\n"	208	$msg .= "\n"
138	unless $msg =~ /\n$/;	209	unless $msg =~ /\n$/;
139		210
		211	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		212
140	LOG llevError, $msg;	213	LOG llevError, $msg;
141	};	214	};
142	}	215	}
		216
		217	$Coro::State::DIEHOOK = sub {
		218	return unless $^S eq 0; # "eq", not "=="
		219
		220	if ($Coro::current == $Coro::main) {#d#
		221	warn "DIEHOOK called in main context, Coro bug?\n";#d#
		222	return;#d#
		223	}#d#
		224
		225	# kill coroutine otherwise
		226	warn Carp::longmess $_[0];
		227	Coro::terminate
		228	};
		229
		230	$SIG{__DIE__} = sub { }; #d#?
143		231
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	232	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	233	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	234	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	235	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	236	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		237	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	238	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150		239
151	# we bless all objects into (empty) derived classes to force a method lookup	240	# we bless all objects into (empty) derived classes to force a method lookup
152	# within the Safe compartment.	241	# within the Safe compartment.
153	for my $pkg (qw(	242	for my $pkg (qw(
154	cf::global cf::attachable	243	cf::global cf::attachable
…		…
159	)) {	248	)) {
160	no strict 'refs';	249	no strict 'refs';
161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	250	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
162	}	251	}
163		252
164	$Event::DIED = sub {	253	$EV::DIED = sub {
165	warn "error in event callback: @_";	254	warn "error in event callback: @_";
166	};	255	};
		256
		257	#############################################################################
167		258
168	=head2 UTILITY FUNCTIONS	259	=head2 UTILITY FUNCTIONS
169		260
170	=over 4	261	=over 4
171		262
…		…
190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	281	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191	$d	282	$d
192	} || "[unable to dump $_[0]: '$@']";	283	} || "[unable to dump $_[0]: '$@']";
193	}	284	}
194		285
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	286	=item $ref = cf::decode_json $json
198		287
199	Converts a JSON string into the corresponding perl data structure.	288	Converts a JSON string into the corresponding perl data structure.
200		289
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	290	=item $json = cf::encode_json $ref
209		291
210	Converts a perl data structure into its JSON representation.	292	Converts a perl data structure into its JSON representation.
211		293
212	=cut	294	=cut
213		295
214	sub to_json($) {	296	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	297
216	JSON::Syck::Dump $_[0]	298	sub encode_json($) { $json_coder->encode ($_[0]) }
217	}	299	sub decode_json($) { $json_coder->decode ($_[0]) }
218		300
219	=item cf::lock_wait $string	301	=item cf::lock_wait $string
220		302
221	Wait until the given lock is available. See cf::lock_acquire.	303	Wait until the given lock is available. See cf::lock_acquire.
222		304
…		…
225	Wait until the given lock is available and then acquires it and returns	307	Wait until the given lock is available and then acquires it and returns
226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	308	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
227	for example when the coroutine gets canceled), the lock is automatically	309	for example when the coroutine gets canceled), the lock is automatically
228	returned.	310	returned.
229		311
		312	Locks are *not* recursive, locking from the same coro twice results in a
		313	deadlocked coro.
		314
230	Lock names should begin with a unique identifier (for example, cf::map::find	315	Lock names should begin with a unique identifier (for example, cf::map::find
231	uses map_find and cf::map::load uses map_load).	316	uses map_find and cf::map::load uses map_load).
232		317
		318	=item $locked = cf::lock_active $string
		319
		320	Return true if the lock is currently active, i.e. somebody has locked it.
		321
233	=cut	322	=cut
234		323
235	our %LOCK;	324	our %LOCK;
		325	our %LOCKER;#d#
236		326
237	sub lock_wait($) {	327	sub lock_wait($) {
238	my ($key) = @_;	328	my ($key) = @_;
		329
		330	if ($LOCKER{$key} == $Coro::current) {#d#
		331	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		332	return;#d#
		333	}#d#
239		334
240	# wait for lock, if any	335	# wait for lock, if any
241	while ($LOCK{$key}) {	336	while ($LOCK{$key}) {
242	push @{ $LOCK{$key} }, $Coro::current;	337	push @{ $LOCK{$key} }, $Coro::current;
243	Coro::schedule;	338	Coro::schedule;
…		…
249		344
250	# wait, to be sure we are not locked	345	# wait, to be sure we are not locked
251	lock_wait $key;	346	lock_wait $key;
252		347
253	$LOCK{$key} = [];	348	$LOCK{$key} = [];
		349	$LOCKER{$key} = $Coro::current;#d#
254		350
255	Coro::guard {	351	Coro::guard {
		352	delete $LOCKER{$key};#d#
256	# wake up all waiters, to be on the safe side	353	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	354	$_->ready for @{ delete $LOCK{$key} };
258	}	355	}
259	}	356	}
260		357
		358	sub lock_active($) {
		359	my ($key) = @_;
		360
		361	! ! $LOCK{$key}
		362	}
		363
261	sub freeze_mainloop {	364	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	365	tick_inhibit_inc;
263		366
264	my $guard = Coro::guard {	367	Coro::guard \&tick_inhibit_dec;
265	$TICK_WATCHER->start;	368	}
266	$WRITE_RUNTIME_WATCHER->start;	369
		370	=item cf::periodic $interval, $cb
		371
		372	Like EV::periodic, but randomly selects a starting point so that the actions
		373	get spread over timer.
		374
		375	=cut
		376
		377	sub periodic($$) {
		378	my ($interval, $cb) = @_;
		379
		380	my $start = rand List::Util::min 180, $interval;
		381
		382	EV::periodic $start, $interval, 0, $cb
		383	}
		384
		385	=item cf::get_slot $time[, $priority[, $name]]
		386
		387	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		388	This call blocks and returns only when you have at least C<$time> seconds
		389	of cpu time till the next tick. The slot is only valid till the next cede.
		390
		391	The optional C<$name> can be used to identify the job to run. It might be
		392	used for statistical purposes and should identify the same time-class.
		393
		394	Useful for short background jobs.
		395
		396	=cut
		397
		398	our @SLOT_QUEUE;
		399	our $SLOT_QUEUE;
		400
		401	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		402	$SLOT_QUEUE = Coro::async {
		403	$Coro::current->desc ("timeslot manager");
		404
		405	my $signal = new Coro::Signal;
		406
		407	while () {
		408	next_job:
		409	my $avail = cf::till_tick;
		410	if ($avail > 0.01) {
		411	for (0 .. $#SLOT_QUEUE) {
		412	if ($SLOT_QUEUE[$_][0] < $avail) {
		413	my $job = splice @SLOT_QUEUE, $_, 1, ();
		414	$job->[2]->send;
		415	Coro::cede;
		416	goto next_job;
		417	}
		418	}
		419	}
		420
		421	if (@SLOT_QUEUE) {
		422	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		423	push @cf::WAIT_FOR_TICK, $signal;
		424	$signal->wait;
		425	} else {
		426	Coro::schedule;
		427	}
267	};	428	}
268	$WRITE_RUNTIME_WATCHER->stop;	429	};
269	$TICK_WATCHER->stop;	430
270	$guard	431	sub get_slot($;$$) {
		432	my ($time, $pri, $name) = @_;
		433
		434	$time = $TICK * .6 if $time > $TICK * .6;
		435	my $sig = new Coro::Signal;
		436
		437	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		438	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		439	$SLOT_QUEUE->ready;
		440	$sig->wait;
271	}	441	}
272		442
273	=item cf::async { BLOCK }	443	=item cf::async { BLOCK }
274		444
275	Currently the same as Coro::async_pool, meaning you cannot use	445	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		450
281	BEGIN { *async = \&Coro::async_pool }	451	BEGIN { *async = \&Coro::async_pool }
282		452
283	=item cf::sync_job { BLOCK }	453	=item cf::sync_job { BLOCK }
284		454
285	The design of crossfire+ requires that the main coro ($Coro::main) is	455	The design of Deliantra requires that the main coroutine ($Coro::main)
286	always able to handle events or runnable, as crossfire+ is only partly	456	is always able to handle events or runnable, as Deliantra is only
287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	457	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		458	acceptable.
288		459
289	If it must be done, put the blocking parts into C<sync_job>. This will run	460	If it must be done, put the blocking parts into C<sync_job>. This will run
290	the given BLOCK in another coroutine while waiting for the result. The	461	the given BLOCK in another coroutine while waiting for the result. The
291	server will be frozen during this time, so the block should either finish	462	server will be frozen during this time, so the block should either finish
292	fast or be very important.	463	fast or be very important.
…		…
295		466
296	sub sync_job(&) {	467	sub sync_job(&) {
297	my ($job) = @_;	468	my ($job) = @_;
298		469
299	if ($Coro::current == $Coro::main) {	470	if ($Coro::current == $Coro::main) {
		471	my $time = EV::time;
		472
300	# this is the main coro, too bad, we have to block	473	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	474	# till the operation succeeds, freezing the server :/
302		475
303	# TODO: use suspend/resume instead	476	LOG llevError, Carp::longmess "sync job";#d#
304	# (but this is cancel-safe)	477
305	my $freeze_guard = freeze_mainloop;	478	my $freeze_guard = freeze_mainloop;
306		479
307	my $busy = 1;	480	my $busy = 1;
308	my @res;	481	my @res;
309		482
310	(async {	483	(async {
		484	$Coro::current->desc ("sync job coro");
311	@res = eval { $job->() };	485	@res = eval { $job->() };
312	warn $@ if $@;	486	warn $@ if $@;
313	undef $busy;	487	undef $busy;
314	})->prio (Coro::PRIO_MAX);	488	})->prio (Coro::PRIO_MAX);
315		489
316	while ($busy) {	490	while ($busy) {
317	Coro::cede or Event::one_event;	491	if (Coro::nready) {
		492	Coro::cede_notself;
		493	} else {
		494	EV::loop EV::LOOP_ONESHOT;
318	}	495	}
		496	}
		497
		498	my $time = EV::time - $time;
		499
		500	$TICK_START += $time; # do not account sync jobs to server load
319		501
320	wantarray ? @res : $res[0]	502	wantarray ? @res : $res[0]
321	} else {	503	} else {
322	# we are in another coroutine, how wonderful, everything just works	504	# we are in another coroutine, how wonderful, everything just works
323		505
…		…
343	$EXT_CORO{$coro+0} = $coro;	525	$EXT_CORO{$coro+0} = $coro;
344		526
345	$coro	527	$coro
346	}	528	}
347		529
348	sub write_runtime {	530	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		531
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	532	Executes the given code block with the given arguments in a seperate
352	or return;	533	process, returning the results. Everything must be serialisable with
		534	Coro::Storable. May, of course, block. Note that the executed sub may
		535	never block itself or use any form of event handling.
353		536
354	my $value = $cf::RUNTIME + 90 + 10;	537	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		538
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	539	sub fork_call(&@) {
359	and return;	540	my ($cb, @args) = @_;
360		541
361	aio_fsync $fh	542	# we seemingly have to make a local copy of the whole thing,
362	and return;	543	# otherwise perl prematurely frees the stuff :/
		544	# TODO: investigate and fix (likely this will be rather laborious)
363		545
364	close $fh	546	my @res = Coro::Util::fork_eval {
365	or return;	547	reset_signals;
		548	&$cb
		549	}, @args;
366		550
367	aio_rename "$runtime~", $runtime	551	wantarray ? @res : $res[-1]
368	and return;	552	}
369		553
		554	=item $value = cf::db_get $family => $key
		555
		556	Returns a single value from the environment database.
		557
		558	=item cf::db_put $family => $key => $value
		559
		560	Stores the given C<$value> in the family. It can currently store binary
		561	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		562
		563	=item $db = cf::db_table "name"
		564
		565	Create and/or open a new database table. The string must not be "db" and must be unique
		566	within each server.
		567
		568	=cut
		569
		570	sub db_table($) {
		571	my ($name) = @_;
		572	my $db = BDB::db_create $DB_ENV;
		573
		574	eval {
		575	$db->set_flags (BDB::CHKSUM);
		576
		577	utf8::encode $name;
		578	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		579	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		580	cf::cleanup "db_open(db): $!" if $!;
		581	};
		582	cf::cleanup "db_open(db): $@" if $@;
		583
		584	$db
		585	}
		586
		587	our $DB;
		588
		589	sub db_init {
		590	cf::sync_job {
		591	$DB ||= db_table "db";
		592	};
		593	}
		594
		595	sub db_get($$) {
		596	my $key = "$_[0]/$_[1]";
		597
		598	cf::sync_job {
		599	BDB::db_get $DB, undef, $key, my $data;
		600
		601	$! ? ()
		602	: $data
370	1	603	}
		604	}
		605
		606	sub db_put($$$) {
		607	BDB::dbreq_pri 4;
		608	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		609	}
		610
		611	=item cf::cache $id => [$paths...], $processversion => $process
		612
		613	Generic caching function that returns the value of the resource $id,
		614	caching and regenerating as required.
		615
		616	This function can block.
		617
		618	=cut
		619
		620	sub cache {
		621	my ($id, $src, $processversion, $process) = @_;
		622
		623	my $meta =
		624	join "\x00",
		625	$processversion,
		626	map {
		627	aio_stat $_
		628	and Carp::croak "$_: $!";
		629
		630	($_, (stat _)[7,9])
		631	} @$src;
		632
		633	my $dbmeta = db_get cache => "$id/meta";
		634	if ($dbmeta ne $meta) {
		635	# changed, we may need to process
		636
		637	my @data;
		638	my $md5;
		639
		640	for (0 .. $#$src) {
		641	0 <= aio_load $src->[$_], $data[$_]
		642	or Carp::croak "$src->[$_]: $!";
		643	}
		644
		645	# if processing is expensive, check
		646	# checksum first
		647	if (1) {
		648	$md5 =
		649	join "\x00",
		650	$processversion,
		651	map {
		652	cf::cede_to_tick;
		653	($src->[$_], Digest::MD5::md5_hex $data[$_])
		654	} 0.. $#$src;
		655
		656
		657	my $dbmd5 = db_get cache => "$id/md5";
		658	if ($dbmd5 eq $md5) {
		659	db_put cache => "$id/meta", $meta;
		660
		661	return db_get cache => "$id/data";
		662	}
		663	}
		664
		665	my $t1 = Time::HiRes::time;
		666	my $data = $process->(\@data);
		667	my $t2 = Time::HiRes::time;
		668
		669	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		670
		671	db_put cache => "$id/data", $data;
		672	db_put cache => "$id/md5" , $md5;
		673	db_put cache => "$id/meta", $meta;
		674
		675	return $data;
		676	}
		677
		678	db_get cache => "$id/data"
		679	}
		680
		681	=item cf::datalog type => key => value, ...
		682
		683	Log a datalog packet of the given type with the given key-value pairs.
		684
		685	=cut
		686
		687	sub datalog($@) {
		688	my ($type, %kv) = @_;
		689	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
371	}	690	}
372		691
373	=back	692	=back
374		693
375	=cut	694	=cut
…		…
382	attach callbacks/event handlers (a collection of which is called an "attachment")	701	attach callbacks/event handlers (a collection of which is called an "attachment")
383	to it. All such attachable objects support the following methods.	702	to it. All such attachable objects support the following methods.
384		703
385	In the following description, CLASS can be any of C<global>, C<object>	704	In the following description, CLASS can be any of C<global>, C<object>
386	C<player>, C<client> or C<map> (i.e. the attachable objects in	705	C<player>, C<client> or C<map> (i.e. the attachable objects in
387	crossfire+).	706	Deliantra).
388		707
389	=over 4	708	=over 4
390		709
391	=item $attachable->attach ($attachment, key => $value...)	710	=item $attachable->attach ($attachment, key => $value...)
392		711
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	874	$registry = $CB_TYPE[$object_type] ||= [];
556		875
557	} elsif ($type eq "subtype") {	876	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	877	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	878	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	879	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		880
562	} elsif ($type eq "package") {	881	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	882	my $pkg = shift @arg;
564		883
565	while (my ($name, $id) = each %cb_id) {	884	while (my ($name, $id) = each %cb_id) {
…		…
594	_attach $registry, $klass, @attach;	913	_attach $registry, $klass, @attach;
595	}	914	}
596		915
597	$obj->{$name} = \%arg;	916	$obj->{$name} = \%arg;
598	} else {	917	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	918	warn "object uses attachment '$name' which is not available, postponing.\n";
600	}	919	}
601		920
602	$obj->{_attachment}{$name} = undef;	921	$obj->{_attachment}{$name} = undef;
603	}	922	}
604		923
…		…
606	if (ref $_[0]) {	925	if (ref $_[0]) {
607	_object_attach @_;	926	_object_attach @_;
608	} else {	927	} else {
609	_attach shift->_attach_registry, @_;	928	_attach shift->_attach_registry, @_;
610	}	929	}
		930	_recalc_want;
611	};	931	};
612		932
613	# all those should be optimised	933	# all those should be optimised
614	sub cf::attachable::detach {	934	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	935	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	938	delete $obj->{_attachment}{$name};
619	reattach ($obj);	939	reattach ($obj);
620	} else {	940	} else {
621	Carp::croak "cannot, currently, detach class attachments";	941	Carp::croak "cannot, currently, detach class attachments";
622	}	942	}
		943	_recalc_want;
623	};	944	};
624		945
625	sub cf::attachable::attached {	946	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	947	my ($obj, $name) = @_;
627		948
…		…
642	";	963	";
643	die if $@;	964	die if $@;
644	}	965	}
645		966
646	our $override;	967	our $override;
647	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	968	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
648		969
649	sub override {	970	sub override {
650	$override = 1;	971	$override = 1;
651	@invoke_results = ();	972	@INVOKE_RESULTS = (@_);
652	}	973	}
653		974
654	sub do_invoke {	975	sub do_invoke {
655	my $event = shift;	976	my $event = shift;
656	my $callbacks = shift;	977	my $callbacks = shift;
657		978
658	@invoke_results = ();	979	@INVOKE_RESULTS = ();
659		980
660	local $override;	981	local $override;
661		982
662	for (@$callbacks) {	983	for (@$callbacks) {
663	eval { &{$_->[1]} };	984	eval { &{$_->[1]} };
…		…
672	}	993	}
673		994
674	0	995	0
675	}	996	}
676		997
677	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	998	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
678		999
679	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1000	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
680		1001
681	Generate an object-specific event with the given arguments.	1002	Generate an object-specific event with the given arguments.
682		1003
683	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	1004	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
684	removed in future versions), and there is no public API to access override	1005	removed in future versions), and there is no public API to access override
685	results (if you must, access C<@cf::invoke_results> directly).	1006	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686		1007
687	=back	1008	=back
688		1009
689	=cut	1010	=cut
690		1011
691	#############################################################################	1012	#############################################################################
692	# object support	1013	# object support
		1014
		1015	sub _object_equal($$);
		1016	sub _object_equal($$) {
		1017	my ($a, $b) = @_;
		1018
		1019	return 0 unless (ref $a) eq (ref $b);
		1020
		1021	if ("HASH" eq ref $a) {
		1022	my @ka = keys %$a;
		1023	my @kb = keys %$b;
		1024
		1025	return 0 if @ka != @kb;
		1026
		1027	for (0 .. $#ka) {
		1028	return 0 unless $ka[$_] eq $kb[$_];
		1029	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		1030	}
		1031
		1032	} elsif ("ARRAY" eq ref $a) {
		1033
		1034	return 0 if @$a != @$b;
		1035
		1036	for (0 .. $#$a) {
		1037	return 0 unless _object_equal $a->[$_], $b->[$_];
		1038	}
		1039
		1040	} elsif ($a ne $b) {
		1041	return 0;
		1042	}
		1043
		1044	1
		1045	}
		1046
		1047	our $SLOW_MERGES;#d#
		1048	sub _can_merge {
		1049	my ($ob1, $ob2) = @_;
		1050
		1051	++$SLOW_MERGES;#d#
		1052
		1053	# we do the slow way here
		1054	return _object_equal $ob1, $ob2
		1055	}
693		1056
694	sub reattach {	1057	sub reattach {
695	# basically do the same as instantiate, without calling instantiate	1058	# basically do the same as instantiate, without calling instantiate
696	my ($obj) = @_;	1059	my ($obj) = @_;
697		1060
…		…
718	cf::attachable->attach (	1081	cf::attachable->attach (
719	prio => -1000000,	1082	prio => -1000000,
720	on_instantiate => sub {	1083	on_instantiate => sub {
721	my ($obj, $data) = @_;	1084	my ($obj, $data) = @_;
722		1085
723	$data = from_json $data;	1086	$data = decode_json $data;
724		1087
725	for (@$data) {	1088	for (@$data) {
726	my ($name, $args) = @$_;	1089	my ($name, $args) = @$_;
727		1090
728	$obj->attach ($name, %{$args || {} });	1091	$obj->attach ($name, %{$args || {} });
…		…
744	sub object_freezer_save {	1107	sub object_freezer_save {
745	my ($filename, $rdata, $objs) = @_;	1108	my ($filename, $rdata, $objs) = @_;
746		1109
747	sync_job {	1110	sync_job {
748	if (length $$rdata) {	1111	if (length $$rdata) {
		1112	utf8::decode (my $decname = $filename);
749	warn sprintf "saving %s (%d,%d)\n",	1113	warn sprintf "saving %s (%d,%d)\n",
750	$filename, length $$rdata, scalar @$objs;	1114	$decname, length $$rdata, scalar @$objs;
751		1115
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1116	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	1117	chmod SAVE_MODE, $fh;
754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1118	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
755	aio_fsync $fh;	1119	aio_fsync $fh if $cf::USE_FSYNC;
756	close $fh;	1120	close $fh;
757		1121
758	if (@$objs) {	1122	if (@$objs) {
759	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1123	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
760	chmod SAVE_MODE, $fh;	1124	chmod SAVE_MODE, $fh;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	1125	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
762	aio_write $fh, 0, (length $data), $data, 0;	1126	aio_write $fh, 0, (length $data), $data, 0;
763	aio_fsync $fh;	1127	aio_fsync $fh if $cf::USE_FSYNC;
764	close $fh;	1128	close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	1129	aio_rename "$filename.pst~", "$filename.pst";
766	}	1130	}
767	} else {	1131	} else {
768	aio_unlink "$filename.pst";	1132	aio_unlink "$filename.pst";
…		…
774	}	1138	}
775	} else {	1139	} else {
776	aio_unlink $filename;	1140	aio_unlink $filename;
777	aio_unlink "$filename.pst";	1141	aio_unlink "$filename.pst";
778	}	1142	}
779	}	1143	};
780	}	1144	}
781		1145
782	sub object_freezer_as_string {	1146	sub object_freezer_as_string {
783	my ($rdata, $objs) = @_;	1147	my ($rdata, $objs) = @_;
784		1148
…		…
796	or return;	1160	or return;
797		1161
798	unless (aio_stat "$filename.pst") {	1162	unless (aio_stat "$filename.pst") {
799	(aio_load "$filename.pst", $av) >= 0	1163	(aio_load "$filename.pst", $av) >= 0
800	or return;	1164	or return;
		1165
801	$av = eval { (Storable::thaw $av)->{objs} };	1166	my $st = eval { Coro::Storable::thaw $av };
		1167	$av = $st->{objs};
802	}	1168	}
803		1169
		1170	utf8::decode (my $decname = $filename);
804	warn sprintf "loading %s (%d)\n",	1171	warn sprintf "loading %s (%d,%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1172	$decname, length $data, scalar @{$av || []};
		1173
806	return ($data, $av);	1174	($data, $av)
807	}	1175	}
		1176
		1177	=head2 COMMAND CALLBACKS
		1178
		1179	=over 4
		1180
		1181	=cut
808		1182
809	#############################################################################	1183	#############################################################################
810	# command handling &c	1184	# command handling &c
811		1185
812	=item cf::register_command $name => \&callback($ob,$args);	1186	=item cf::register_command $name => \&callback($ob,$args);
…		…
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1199	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1200	}
827		1201
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1202	=item cf::register_extcmd $name => \&callback($pl,$packet);
829		1203
830	Register a callbackf ro execution when the client sends an extcmd packet.	1204	Register a callback for execution when the client sends an (synchronous)
		1205	extcmd packet. Ext commands will be processed in the order they are
		1206	received by the server, like other user commands. The first argument is
		1207	the logged-in player. Ext commands can only be processed after a player
		1208	has logged in successfully.
831		1209
832	If the callback returns something, it is sent back as if reply was being	1210	If the callback returns something, it is sent back as if reply was being
833	called.	1211	called.
834		1212
		1213	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1214
		1215	Register a callback for execution when the client sends an (asynchronous)
		1216	exticmd packet. Exti commands are processed by the server as soon as they
		1217	are received, i.e. out of order w.r.t. other commands. The first argument
		1218	is a client socket. Exti commands can be received anytime, even before
		1219	log-in.
		1220
		1221	If the callback returns something, it is sent back as if reply was being
		1222	called.
		1223
835	=cut	1224	=cut
836		1225
837	sub register_extcmd {	1226	sub register_extcmd {
838	my ($name, $cb) = @_;	1227	my ($name, $cb) = @_;
839		1228
840	$EXTCMD{$name} = $cb;	1229	$EXTCMD{$name} = $cb;
		1230	}
		1231
		1232	sub register_exticmd {
		1233	my ($name, $cb) = @_;
		1234
		1235	$EXTICMD{$name} = $cb;
841	}	1236	}
842		1237
843	cf::player->attach (	1238	cf::player->attach (
844	on_command => sub {	1239	on_command => sub {
845	my ($pl, $name, $params) = @_;	1240	my ($pl, $name, $params) = @_;
…		…
854	cf::override;	1249	cf::override;
855	},	1250	},
856	on_extcmd => sub {	1251	on_extcmd => sub {
857	my ($pl, $buf) = @_;	1252	my ($pl, $buf) = @_;
858		1253
859	my $msg = eval { from_json $buf };	1254	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860		1255
861	if (ref $msg) {	1256	if (ref $msg) {
		1257	my ($type, $reply, @payload) =
		1258	"ARRAY" eq ref $msg
		1259	? @$msg
		1260	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1261
		1262	my @reply;
		1263
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1264	if (my $cb = $EXTCMD{$type}) {
863	if (my %reply = $cb->($pl, $msg)) {	1265	@reply = $cb->($pl, @payload);
864	$pl->ext_reply ($msg->{msgid}, %reply);
865	}
866	}	1266	}
		1267
		1268	$pl->ext_reply ($reply, @reply)
		1269	if $reply;
		1270
867	} else {	1271	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1272	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869	}	1273	}
870		1274
871	cf::override;	1275	cf::override;
872	},	1276	},
873	);	1277	);
874		1278
875	sub load_extension {
876	my ($path) = @_;
877
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
879	my $base = $1;
880	my $pkg = $1;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}
903	die $@;
904	}
905
906	push @EXTS, $pkg;
907	}
908
909	sub load_extensions {	1279	sub load_extensions {
		1280	cf::sync_job {
		1281	my %todo;
		1282
910	for my $ext (<$LIBDIR/*.ext>) {	1283	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1284	next unless -r $path;
912	eval {	1285
913	load_extension $ext;	1286	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1287	my $base = $1;
		1288	my $pkg = $1;
		1289	$pkg =~ s/[^[:word:]]/_/g;
		1290	$pkg = "ext::$pkg";
		1291
		1292	open my $fh, "<:utf8", $path
		1293	or die "$path: $!";
		1294
		1295	my $source = do { local $/; <$fh> };
		1296
		1297	my %ext = (
		1298	path => $path,
		1299	base => $base,
		1300	pkg => $pkg,
		1301	);
		1302
		1303	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1304	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1305
		1306	$ext{source} =
		1307	"package $pkg; use strict; use utf8;\n"
		1308	. "#line 1 \"$path\"\n{\n"
		1309	. $source
		1310	. "\n};\n1";
		1311
		1312	$todo{$base} = \%ext;
		1313	}
		1314
		1315	my %done;
		1316	while (%todo) {
		1317	my $progress;
		1318
		1319	while (my ($k, $v) = each %todo) {
		1320	for (split /,\s*/, $v->{meta}{depends}) {
		1321	goto skip
		1322	unless exists $done{$_};
		1323	}
		1324
		1325	warn "... loading '$k' into '$v->{pkg}'\n";
		1326
		1327	unless (eval $v->{source}) {
		1328	my $msg = $@ ? "$v->{path}: $@\n"
		1329	: "$v->{base}: extension inactive.\n";
		1330
		1331	if (exists $v->{meta}{mandatory}) {
		1332	warn $msg;
		1333	cf::cleanup "mandatory extension failed to load, exiting.";
		1334	}
		1335
		1336	warn $msg;
		1337	}
		1338
		1339	$done{$k} = delete $todo{$k};
		1340	push @EXTS, $v->{pkg};
		1341	$progress = 1;
914	1	1342	}
915	} or warn "$ext not loaded: $@";	1343
		1344	skip:
		1345	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1346	unless $progress;
		1347	}
916	}	1348	};
917	}	1349	}
918		1350
919	#############################################################################	1351	#############################################################################
920		1352
		1353	=back
		1354
921	=head2 CORE EXTENSIONS	1355	=head2 CORE EXTENSIONS
922		1356
923	Functions and methods that extend core crossfire objects.	1357	Functions and methods that extend core crossfire objects.
924		1358
925	=cut	1359	=cut
…		…
930		1364
931	=head3 cf::player	1365	=head3 cf::player
932		1366
933	=over 4	1367	=over 4
934		1368
		1369	=item cf::player::num_playing
		1370
		1371	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1372
		1373	=cut
		1374
		1375	sub num_playing {
		1376	scalar grep
		1377	$_->ob->map
		1378	&& !$_->hidden
		1379	&& !$_->ob->flag (cf::FLAG_WIZ),
		1380	cf::player::list
		1381	}
		1382
935	=item cf::player::find $login	1383	=item cf::player::find $login
936		1384
937	Returns the given player object, loading it if necessary (might block).	1385	Returns the given player object, loading it if necessary (might block).
938		1386
939	=cut	1387	=cut
940		1388
941	sub playerdir($) {	1389	sub playerdir($) {
942	cf::localdir	1390	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1391	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1392	}
948		1393
949	sub path($) {	1394	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1395	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1396
952	(playerdir $login) . "/$login.pl"	1397	(playerdir $login) . "/playerdata"
953	}	1398	}
954		1399
955	sub find_active($) {	1400	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1401	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1402	and $cf::PLAYER{$_[0]}->active
…		…
970	my $login = $_[0];	1415	my $login = $_[0];
971		1416
972	my $guard = cf::lock_acquire "user_find:$login";	1417	my $guard = cf::lock_acquire "user_find:$login";
973		1418
974	$cf::PLAYER{$_[0]} || do {	1419	$cf::PLAYER{$_[0]} || do {
975	my $pl = load_pl path $login	1420	# rename old playerfiles to new ones
		1421	#TODO: remove when no longer required
		1422	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1423	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1424	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1425	aio_unlink +(playerdir $login) . "/$login.pl";
		1426
		1427	my $f = new_from_file cf::object::thawer path $login
976	or return;	1428	or return;
		1429
		1430	my $pl = cf::player::load_pl $f
		1431	or return;
		1432	local $cf::PLAYER_LOADING{$login} = $pl;
		1433	$f->resolve_delayed_derefs;
977	$cf::PLAYER{$login} = $pl	1434	$cf::PLAYER{$login} = $pl
978	}	1435	}
979	}	1436	}
980	}	1437	}
981		1438
…		…
991		1448
992	aio_mkdir playerdir $pl, 0770;	1449	aio_mkdir playerdir $pl, 0770;
993	$pl->{last_save} = $cf::RUNTIME;	1450	$pl->{last_save} = $cf::RUNTIME;
994		1451
995	$pl->save_pl ($path);	1452	$pl->save_pl ($path);
996	Coro::cede;	1453	cf::cede_to_tick;
997	}	1454	}
998		1455
999	sub new($) {	1456	sub new($) {
1000	my ($login) = @_;	1457	my ($login) = @_;
1001		1458
…		…
1007	$cf::PLAYER{$login} = $self;	1464	$cf::PLAYER{$login} = $self;
1008		1465
1009	$self	1466	$self
1010	}	1467	}
1011		1468
		1469	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1470
		1471	=cut
		1472
		1473	sub send_msg {
		1474	my $ns = shift->ns
		1475	or return;
		1476	$ns->send_msg (@_);
		1477	}
		1478
1012	=item $pl->quit_character	1479	=item $pl->quit_character
1013		1480
1014	Nukes the player without looking back. If logged in, the connection will	1481	Nukes the player without looking back. If logged in, the connection will
1015	be destroyed. May block for a long time.	1482	be destroyed. May block for a long time.
1016		1483
1017	=cut	1484	=cut
1018		1485
1019	sub quit_character {	1486	sub quit_character {
1020	my ($pl) = @_;	1487	my ($pl) = @_;
		1488
		1489	my $name = $pl->ob->name;
1021		1490
1022	$pl->{deny_save} = 1;	1491	$pl->{deny_save} = 1;
1023	$pl->password ("*"); # this should lock out the player until we nuked the dir	1492	$pl->password ("*"); # this should lock out the player until we nuked the dir
1024		1493
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1494	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1030	my $path = playerdir $pl;	1499	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1500	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1501	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1502	delete $cf::PLAYER{$pl->ob->name};
1034	$pl->destroy;	1503	$pl->destroy;
		1504
		1505	my $prefix = qr<^~\Q$name\E/>;
		1506
		1507	# nuke player maps
		1508	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1509
1035	IO::AIO::aio_rmtree $temp;	1510	IO::AIO::aio_rmtree $temp;
		1511	}
		1512
		1513	=item $pl->kick
		1514
		1515	Kicks a player out of the game. This destroys the connection.
		1516
		1517	=cut
		1518
		1519	sub kick {
		1520	my ($pl, $kicker) = @_;
		1521
		1522	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1523	$pl->killer ("kicked");
		1524	$pl->ns->destroy;
1036	}	1525	}
1037		1526
1038	=item cf::player::list_logins	1527	=item cf::player::list_logins
1039		1528
1040	Returns am arrayref of all valid playernames in the system, can take a	1529	Returns am arrayref of all valid playernames in the system, can take a
1041	while and may block, so not sync_job-capable, ever.	1530	while and may block, so not sync_job-capable, ever.
1042		1531
1043	=cut	1532	=cut
1044		1533
1045	sub list_logins {	1534	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1535	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1536	or return [];
1048		1537
1049	my @logins;	1538	my @logins;
1050		1539
1051	for my $login (@$dirs) {	1540	for my $login (@$dirs) {
		1541	my $path = path $login;
		1542
		1543	# a .pst is a dead give-away for a valid player
		1544	unless (-e "$path.pst") {
1052	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1545	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1053	aio_read $fh, 0, 512, my $buf, 0 or next;	1546	aio_read $fh, 0, 512, my $buf, 0 or next;
1054	$buf !~ /^password -------------$/m or next; # official not-valid tag	1547	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1548	}
1055		1549
1056	utf8::decode $login;	1550	utf8::decode $login;
1057	push @logins, $login;	1551	push @logins, $login;
1058	}	1552	}
1059		1553
…		…
1067		1561
1068	=cut	1562	=cut
1069		1563
1070	sub maps($) {	1564	sub maps($) {
1071	my ($pl) = @_;	1565	my ($pl) = @_;
		1566
		1567	$pl = ref $pl ? $pl->ob->name : $pl;
1072		1568
1073	my $files = aio_readdir playerdir $pl	1569	my $files = aio_readdir playerdir $pl
1074	or return;	1570	or return;
1075		1571
1076	my @paths;	1572	my @paths;
…		…
1078	for (@$files) {	1574	for (@$files) {
1079	utf8::decode $_;	1575	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1576	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1577	next unless /^$PATH_SEP/o;
1082		1578
1083	s/\.map$//;	1579	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1580	}
1086		1581
1087	\@paths	1582	\@paths
1088	}	1583	}
1089		1584
		1585	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1586
		1587	Expand crossfire pod fragments into protocol xml.
		1588
		1589	=cut
		1590
		1591	use re 'eval';
		1592
		1593	my $group;
		1594	my $interior; $interior = qr{
		1595	# match a pod interior sequence sans C<< >>
		1596	(?:
		1597	\ (.*?)\ (?{ $group = $^N })
		1598	| < (??{$interior}) >
		1599	)
		1600	}x;
		1601
		1602	sub expand_cfpod {
		1603	my ($self, $pod) = @_;
		1604
		1605	my $xml;
		1606
		1607	while () {
		1608	if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
		1609	$group = $1;
		1610
		1611	$group =~ s/&/&amp;/g;
		1612	$group =~ s/</&lt;/g;
		1613
		1614	$xml .= $group;
		1615	} elsif ($pod =~ m%\G
		1616	([BCGHITU])
		1617	<
		1618	(?:
		1619	([^<>]*) (?{ $group = $^N })
		1620	| < $interior >
		1621	)
		1622	>
		1623	%gcsx
		1624	) {
		1625	my ($code, $data) = ($1, $group);
		1626
		1627	if ($code eq "B") {
		1628	$xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
		1629	} elsif ($code eq "I") {
		1630	$xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
		1631	} elsif ($code eq "U") {
		1632	$xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
		1633	} elsif ($code eq "C") {
		1634	$xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
		1635	} elsif ($code eq "T") {
		1636	$xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
		1637	} elsif ($code eq "G") {
		1638	my ($male, $female) = split /\|/, $data;
		1639	$data = $self->gender ? $female : $male;
		1640	$xml .= expand_cfpod ($self, $data);
		1641	} elsif ($code eq "H") {
		1642	$xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
		1643	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1644	"")
		1645	[$self->{hintmode}];
		1646	} else {
		1647	$xml .= "error processing '$code($data)' directive";
		1648	}
		1649	} else {
		1650	if ($pod =~ /\G(.+)/) {
		1651	warn "parse error while expanding $pod (at $1)";
		1652	}
		1653	last;
		1654	}
		1655	}
		1656
		1657	for ($xml) {
		1658	# create single paragraphs (very hackish)
		1659	s/(?<=\S)\n(?=\w)/ /g;
		1660
		1661	# compress some whitespace
		1662	s/\s+\n/\n/g; # ws line-ends
		1663	s/\n\n+/\n/g; # double lines
		1664	s/^\n+//; # beginning lines
		1665	s/\n+$//; # ending lines
		1666	}
		1667
		1668	$xml
		1669	}
		1670
		1671	no re 'eval';
		1672
		1673	sub hintmode {
		1674	$_[0]{hintmode} = $_[1] if @_ > 1;
		1675	$_[0]{hintmode}
		1676	}
		1677
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1678	=item $player->ext_reply ($msgid, @msg)
1091		1679
1092	Sends an ext reply to the player.	1680	Sends an ext reply to the player.
1093		1681
1094	=cut	1682	=cut
1095		1683
1096	sub ext_reply($$$%) {	1684	sub ext_reply($$@) {
1097	my ($self, $id, %msg) = @_;	1685	my ($self, $id, @msg) = @_;
1098		1686
1099	$msg{msgid} = $id;	1687	$self->ns->ext_reply ($id, @msg)
1100
1101	$self->send ("ext " . cf::to_json \%msg);
1102	}	1688	}
1103		1689
1104	package cf;	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	}
1105		1730
1106	=back	1731	=back
1107
1108		1732
1109	=head3 cf::map	1733	=head3 cf::map
1110		1734
1111	=over 4	1735	=over 4
1112		1736
…		…
1167	my ($self, $merge) = @_;	1791	my ($self, $merge) = @_;
1168		1792
1169	# we have to keep some variables in memory intact	1793	# we have to keep some variables in memory intact
1170	local $self->{path};	1794	local $self->{path};
1171	local $self->{load_path};	1795	local $self->{load_path};
1172	local $self->{deny_save};
1173	local $self->{deny_reset};
1174		1796
1175	$self->SUPER::thawer_merge ($merge);	1797	$self->SUPER::thawer_merge ($merge);
1176	}	1798	}
1177		1799
1178	sub normalise {	1800	sub normalise {
1179	my ($path, $base) = @_;	1801	my ($path, $base) = @_;
		1802
		1803	$path = "$path"; # make sure its a string
		1804
		1805	$path =~ s/\.map$//;
1180		1806
1181	# map plan:	1807	# map plan:
1182	#	1808	#
1183	# /! non-realised random map exit (special hack!)	1809	# /! non-realised random map exit (special hack!)
1184	# {... are special paths that are not being touched	1810	# {... are special paths that are not being touched
…		…
1221	$self->init; # pass $1 etc.	1847	$self->init; # pass $1 etc.
1222	return $self;	1848	return $self;
1223	}	1849	}
1224	}	1850	}
1225		1851
1226	Carp::carp "unable to resolve path '$path'.";	1852	Carp::cluck "unable to resolve path '$path' (base '$base').";
1227	()	1853	()
1228	}	1854	}
1229		1855
1230	sub init {	1856	sub init {
1231	my ($self) = @_;	1857	my ($self) = @_;
…		…
1246		1872
1247	# the original (read-only) location	1873	# the original (read-only) location
1248	sub load_path {	1874	sub load_path {
1249	my ($self) = @_;	1875	my ($self) = @_;
1250		1876
1251	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1877	"$MAPDIR/$self->{path}.map"
1252	}	1878	}
1253		1879
1254	# the temporary/swap location	1880	# the temporary/swap location
1255	sub save_path {	1881	sub save_path {
1256	my ($self) = @_;	1882	my ($self) = @_;
1257		1883
1258	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1884	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1259	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1885	"$TMPDIR/$path.map"
1260	}	1886	}
1261		1887
1262	# the unique path, undef == no special unique path	1888	# the unique path, undef == no special unique path
1263	sub uniq_path {	1889	sub uniq_path {
1264	my ($self) = @_;	1890	my ($self) = @_;
1265		1891
1266	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1892	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1267	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1893	"$UNIQUEDIR/$path"
1268	}	1894	}
1269		1895
1270	# and all this just because we cannot iterate over	1896	# and all this just because we cannot iterate over
1271	# all maps in C++...	1897	# all maps in C++...
1272	sub change_all_map_light {	1898	sub change_all_map_light {
…		…
1274		1900
1275	$_->change_map_light ($change)	1901	$_->change_map_light ($change)
1276	for grep $_->outdoor, values %cf::MAP;	1902	for grep $_->outdoor, values %cf::MAP;
1277	}	1903	}
1278		1904
		1905	sub decay_objects {
		1906	my ($self) = @_;
		1907
		1908	return if $self->{deny_reset};
		1909
		1910	$self->do_decay_objects;
		1911	}
		1912
1279	sub unlink_save {	1913	sub unlink_save {
1280	my ($self) = @_;	1914	my ($self) = @_;
1281		1915
1282	utf8::encode (my $save = $self->save_path);	1916	utf8::encode (my $save = $self->save_path);
1283	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1917	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1286		1920
1287	sub load_header_from($) {	1921	sub load_header_from($) {
1288	my ($self, $path) = @_;	1922	my ($self, $path) = @_;
1289		1923
1290	utf8::encode $path;	1924	utf8::encode $path;
1291	aio_open $path, O_RDONLY, 0	1925	my $f = new_from_file cf::object::thawer $path
1292	or return;	1926	or return;
1293		1927
1294	$self->_load_header ($path)	1928	$self->_load_header ($f)
1295	or return;	1929	or return;
1296		1930
		1931	local $MAP_LOADING{$self->{path}} = $self;
		1932	$f->resolve_delayed_derefs;
		1933
1297	$self->{load_path} = $path;	1934	$self->{load_path} = $path;
1298		1935
1299	1	1936	1
1300	}	1937	}
1301		1938
1302	sub load_orig {	1939	sub load_header_orig {
1303	my ($self) = @_;	1940	my ($self) = @_;
1304		1941
1305	$self->load_header_from ($self->load_path)	1942	$self->load_header_from ($self->load_path)
1306	}	1943	}
1307		1944
1308	sub load_temp {	1945	sub load_header_temp {
1309	my ($self) = @_;	1946	my ($self) = @_;
1310		1947
1311	$self->load_header_from ($self->save_path)	1948	$self->load_header_from ($self->save_path)
		1949	}
		1950
		1951	sub prepare_temp {
		1952	my ($self) = @_;
		1953
		1954	$self->last_access ((delete $self->{last_access})
		1955	|| $cf::RUNTIME); #d#
		1956	# safety
		1957	$self->{instantiate_time} = $cf::RUNTIME
		1958	if $self->{instantiate_time} > $cf::RUNTIME;
		1959	}
		1960
		1961	sub prepare_orig {
		1962	my ($self) = @_;
		1963
		1964	$self->{load_original} = 1;
		1965	$self->{instantiate_time} = $cf::RUNTIME;
		1966	$self->last_access ($cf::RUNTIME);
		1967	$self->instantiate;
1312	}	1968	}
1313		1969
1314	sub load_header {	1970	sub load_header {
1315	my ($self) = @_;	1971	my ($self) = @_;
1316		1972
1317	if ($self->load_temp) {	1973	if ($self->load_header_temp) {
1318	$self->last_access ((delete $self->{last_access})	1974	$self->prepare_temp;
1319	|| $cf::RUNTIME); #d#
1320	# safety
1321	$self->{instantiate_time} = $cf::RUNTIME
1322	if $self->{instantiate_time} > $cf::RUNTIME;
1323	} else {	1975	} else {
1324	$self->load_orig	1976	$self->load_header_orig
1325	or return;	1977	or return;
1326		1978	$self->prepare_orig;
1327	$self->{load_original} = 1;
1328	$self->{instantiate_time} = $cf::RUNTIME;
1329	$self->last_access ($cf::RUNTIME);
1330	$self->instantiate;
1331	}	1979	}
		1980
		1981	$self->{deny_reset} = 1
		1982	if $self->no_reset;
		1983
		1984	$self->default_region (cf::region::find_by_path $self->{path})
		1985	unless $self->default_region;
1332		1986
1333	1	1987	1
1334	}	1988	}
1335		1989
1336	sub find;	1990	sub find;
1337	sub find {	1991	sub find {
1338	my ($path, $origin) = @_;	1992	my ($path, $origin) = @_;
1339		1993
1340	$path = normalise $path, $origin && $origin->path;	1994	$path = normalise $path, $origin && $origin->path;
1341		1995
		1996	cf::lock_wait "map_data:$path";#d#remove
1342	cf::lock_wait "map_find:$path";	1997	cf::lock_wait "map_find:$path";
1343		1998
1344	$cf::MAP{$path} || do {	1999	$cf::MAP{$path} || do {
1345	my $guard = cf::lock_acquire "map_find:$path";	2000	my $guard1 = cf::lock_acquire "map_find:$path";
		2001	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		2002
1346	my $map = new_from_path cf::map $path	2003	my $map = new_from_path cf::map $path
1347	or return;	2004	or return;
1348		2005
1349	$map->{last_save} = $cf::RUNTIME;	2006	$map->{last_save} = $cf::RUNTIME;
1350		2007
1351	$map->load_header	2008	$map->load_header
1352	or return;	2009	or return;
1353		2010
1354	if ($map->should_reset) {	2011	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1355	# doing this can freeze the server in a sync job, obviously	2012	# doing this can freeze the server in a sync job, obviously
1356	#$cf::WAIT_FOR_TICK->wait;	2013	#$cf::WAIT_FOR_TICK->wait;
		2014	undef $guard1;
		2015	undef $guard2;
1357	$map->reset;	2016	$map->reset;
1358	undef $guard;
1359	$map = find $path	2017	return find $path;
1360	or return;
1361	}	2018	}
1362		2019
1363	$cf::MAP{$path} = $map	2020	$cf::MAP{$path} = $map
1364	}	2021	}
1365	}	2022	}
		2023
		2024	sub pre_load { }
		2025	sub post_load { }
1366		2026
1367	sub load {	2027	sub load {
1368	my ($self) = @_;	2028	my ($self) = @_;
1369		2029
		2030	local $self->{deny_reset} = 1; # loading can take a long time
		2031
1370	my $path = $self->{path};	2032	my $path = $self->{path};
		2033
		2034	{
1371	my $guard = cf::lock_acquire "map_load:$path";	2035	my $guard = cf::lock_acquire "map_data:$path";
1372		2036
		2037	return unless $self->valid;
1373	return if $self->in_memory != cf::MAP_SWAPPED;	2038	return unless $self->in_memory == cf::MAP_SWAPPED;
1374		2039
1375	$self->in_memory (cf::MAP_LOADING);	2040	$self->in_memory (cf::MAP_LOADING);
1376		2041
1377	$self->alloc;	2042	$self->alloc;
1378	$self->_load_objects ($self->{load_path}, 1)	2043
		2044	$self->pre_load;
		2045	cf::cede_to_tick;
		2046
		2047	my $f = new_from_file cf::object::thawer $self->{load_path};
		2048	$f->skip_block;
		2049	$self->_load_objects ($f)
1379	or return;	2050	or return;
1380		2051
1381	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2052	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1382	if delete $self->{load_original};	2053	if delete $self->{load_original};
1383		2054
1384	if (my $uniq = $self->uniq_path) {	2055	if (my $uniq = $self->uniq_path) {
1385	utf8::encode $uniq;	2056	utf8::encode $uniq;
1386	if (aio_open $uniq, O_RDONLY, 0) {	2057	unless (aio_stat $uniq) {
		2058	if (my $f = new_from_file cf::object::thawer $uniq) {
1387	$self->clear_unique_items;	2059	$self->clear_unique_items;
1388	$self->_load_objects ($uniq, 0);	2060	$self->_load_objects ($f);
		2061	$f->resolve_delayed_derefs;
		2062	}
1389	}	2063	}
1390	}	2064	}
1391		2065
1392	Coro::cede;	2066	$f->resolve_delayed_derefs;
1393		2067
		2068	cf::cede_to_tick;
1394	# now do the right thing for maps	2069	# now do the right thing for maps
1395	$self->link_multipart_objects;	2070	$self->link_multipart_objects;
1396
1397	unless ($self->{deny_activate}) {
1398	$self->decay_objects;
1399	$self->fix_auto_apply;
1400	$self->update_buttons;
1401	Coro::cede;
1402	$self->set_darkness_map;
1403	$self->difficulty ($self->estimate_difficulty)	2071	$self->difficulty ($self->estimate_difficulty)
1404	unless $self->difficulty;	2072	unless $self->difficulty;
1405	Coro::cede;	2073	cf::cede_to_tick;
		2074
		2075	unless ($self->{deny_activate}) {
		2076	$self->decay_objects;
		2077	$self->fix_auto_apply;
		2078	$self->update_buttons;
		2079	cf::cede_to_tick;
		2080	$self->set_darkness_map;
		2081	cf::cede_to_tick;
1406	$self->activate;	2082	$self->activate;
1407	}	2083	}
1408		2084
		2085	$self->{last_save} = $cf::RUNTIME;
		2086	$self->last_access ($cf::RUNTIME);
		2087
1409	$self->in_memory (cf::MAP_IN_MEMORY);	2088	$self->in_memory (cf::MAP_IN_MEMORY);
		2089	}
		2090
		2091	$self->post_load;
1410	}	2092	}
1411		2093
1412	sub customise_for {	2094	sub customise_for {
1413	my ($self, $ob) = @_;	2095	my ($self, $ob) = @_;
1414		2096
1415	return find "~" . $ob->name . "/" . $self->{path}	2097	return find "~" . $ob->name . "/" . $self->{path}
1416	if $self->per_player;	2098	if $self->per_player;
1417		2099
		2100	# return find "?party/" . $ob->name . "/" . $self->{path}
		2101	# if $self->per_party;
		2102
1418	$self	2103	$self
1419	}	2104	}
1420		2105
1421	# find and load all maps in the 3x3 area around a map	2106	# find and load all maps in the 3x3 area around a map
1422	sub load_diag {	2107	sub load_neighbours {
1423	my ($map) = @_;	2108	my ($map) = @_;
1424		2109
1425	my @diag; # diagonal neighbours	2110	my @neigh; # diagonal neighbours
1426		2111
1427	for (0 .. 3) {	2112	for (0 .. 3) {
1428	my $neigh = $map->tile_path ($_)	2113	my $neigh = $map->tile_path ($_)
1429	or next;	2114	or next;
1430	$neigh = find $neigh, $map	2115	$neigh = find $neigh, $map
1431	or next;	2116	or next;
1432	$neigh->load;	2117	$neigh->load;
1433		2118
		2119	push @neigh,
1434	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2120	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1435	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2121	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1436	}	2122	}
1437		2123
1438	for (@diag) {	2124	for (grep defined $_->[0], @neigh) {
		2125	my ($path, $origin) = @$_;
1439	my $neigh = find @$_	2126	my $neigh = find $path, $origin
1440	or next;	2127	or next;
1441	$neigh->load;	2128	$neigh->load;
1442	}	2129	}
1443	}	2130	}
1444		2131
…		…
1449	}	2136	}
1450		2137
1451	sub do_load_sync {	2138	sub do_load_sync {
1452	my ($map) = @_;	2139	my ($map) = @_;
1453		2140
		2141	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2142	if $Coro::current == $Coro::main;
		2143
1454	cf::sync_job { $map->load };	2144	cf::sync_job { $map->load };
1455	}	2145	}
1456		2146
1457	our %MAP_PREFETCH;	2147	our %MAP_PREFETCH;
1458	our $MAP_PREFETCHER = undef;	2148	our $MAP_PREFETCHER = undef;
1459		2149
1460	sub find_async {	2150	sub find_async {
1461	my ($path, $origin) = @_;	2151	my ($path, $origin, $load) = @_;
1462		2152
1463	$path = normalise $path, $origin && $origin->{path};	2153	$path = normalise $path, $origin && $origin->{path};
1464		2154
1465	if (my $map = $cf::MAP{$path}) {	2155	if (my $map = $cf::MAP{$path}) {
1466	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2156	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1467	}	2157	}
1468		2158
1469	undef $MAP_PREFETCH{$path};	2159	$MAP_PREFETCH{$path} |= $load;
		2160
1470	$MAP_PREFETCHER ||= cf::async {	2161	$MAP_PREFETCHER ||= cf::async {
		2162	$Coro::current->{desc} = "map prefetcher";
		2163
1471	while (%MAP_PREFETCH) {	2164	while (%MAP_PREFETCH) {
1472	for my $path (keys %MAP_PREFETCH) {	2165	while (my ($k, $v) = each %MAP_PREFETCH) {
1473	my $map = find $path	2166	if (my $map = find $k) {
1474	or next;
1475	$map->load;	2167	$map->load if $v;
		2168	}
1476		2169
1477	delete $MAP_PREFETCH{$path};	2170	delete $MAP_PREFETCH{$k};
1478	}	2171	}
1479	}	2172	}
1480	undef $MAP_PREFETCHER;	2173	undef $MAP_PREFETCHER;
1481	};	2174	};
		2175	$MAP_PREFETCHER->prio (6);
1482		2176
1483	()	2177	()
1484	}	2178	}
1485		2179
1486	sub save {	2180	sub save {
1487	my ($self) = @_;	2181	my ($self) = @_;
1488		2182
1489	my $lock = cf::lock_acquire "map_data:" . $self->path;	2183	my $lock = cf::lock_acquire "map_data:$self->{path}";
1490		2184
1491	$self->{last_save} = $cf::RUNTIME;	2185	$self->{last_save} = $cf::RUNTIME;
1492		2186
1493	return unless $self->dirty;	2187	return unless $self->dirty;
1494		2188
…		…
1500	return if $self->{deny_save};	2194	return if $self->{deny_save};
1501		2195
1502	local $self->{last_access} = $self->last_access;#d#	2196	local $self->{last_access} = $self->last_access;#d#
1503		2197
1504	cf::async {	2198	cf::async {
		2199	$Coro::current->{desc} = "map player save";
1505	$_->contr->save for $self->players;	2200	$_->contr->save for $self->players;
1506	};	2201	};
1507		2202
1508	if ($uniq) {	2203	if ($uniq) {
1509	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2204	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
…		…
1517	my ($self) = @_;	2212	my ($self) = @_;
1518		2213
1519	# save first because save cedes	2214	# save first because save cedes
1520	$self->save;	2215	$self->save;
1521		2216
1522	my $lock = cf::lock_acquire "map_data:" . $self->path;	2217	my $lock = cf::lock_acquire "map_data:$self->{path}";
1523		2218
1524	return if $self->players;	2219	return if $self->players;
1525	return if $self->in_memory != cf::MAP_IN_MEMORY;	2220	return if $self->in_memory != cf::MAP_IN_MEMORY;
1526	return if $self->{deny_save};	2221	return if $self->{deny_save};
1527		2222
		2223	$self->in_memory (cf::MAP_SWAPPED);
		2224
		2225	$self->deactivate;
		2226	$_->clear_links_to ($self) for values %cf::MAP;
1528	$self->clear;	2227	$self->clear;
1529	$self->in_memory (cf::MAP_SWAPPED);
1530	}	2228	}
1531		2229
1532	sub reset_at {	2230	sub reset_at {
1533	my ($self) = @_;	2231	my ($self) = @_;
1534		2232
1535	# TODO: safety, remove and allow resettable per-player maps	2233	# TODO: safety, remove and allow resettable per-player maps
1536	return 1e99 if $self->isa ("ext::map_per_player");#d#
1537	return 1e99 if $self->{deny_reset};	2234	return 1e99 if $self->{deny_reset};
1538		2235
1539	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2236	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1540	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2237	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1541		2238
…		…
1552	my ($self) = @_;	2249	my ($self) = @_;
1553		2250
1554	my $lock = cf::lock_acquire "map_data:$self->{path}";	2251	my $lock = cf::lock_acquire "map_data:$self->{path}";
1555		2252
1556	return if $self->players;	2253	return if $self->players;
1557	return if $self->isa ("ext::map_per_player");#d#
1558		2254
1559	warn "resetting map ", $self->path;#d#	2255	warn "resetting map ", $self->path;
		2256
		2257	$self->in_memory (cf::MAP_SWAPPED);
		2258
		2259	# need to save uniques path
		2260	unless ($self->{deny_save}) {
		2261	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2262
		2263	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2264	if $uniq;
		2265	}
1560		2266
1561	delete $cf::MAP{$self->path};	2267	delete $cf::MAP{$self->path};
1562		2268
1563	$self->in_memory (cf::MAP_SWAPPED);	2269	$self->deactivate;
		2270	$_->clear_links_to ($self) for values %cf::MAP;
1564	$self->clear;	2271	$self->clear;
1565
1566	$_->clear_links_to ($self) for values %cf::MAP;
1567		2272
1568	$self->unlink_save;	2273	$self->unlink_save;
1569	$self->destroy;	2274	$self->destroy;
1570	}	2275	}
1571		2276
1572	my $nuke_counter = "aaaa";	2277	my $nuke_counter = "aaaa";
1573		2278
1574	sub nuke {	2279	sub nuke {
1575	my ($self) = @_;	2280	my ($self) = @_;
1576		2281
		2282	{
		2283	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2284
1577	delete $cf::MAP{$self->path};	2285	delete $cf::MAP{$self->path};
1578		2286
1579	$self->unlink_save;	2287	$self->unlink_save;
1580		2288
1581	bless $self, "cf::map";	2289	bless $self, "cf::map";
1582	delete $self->{deny_reset};	2290	delete $self->{deny_reset};
1583	$self->{deny_save} = 1;	2291	$self->{deny_save} = 1;
1584	$self->reset_timeout (1);	2292	$self->reset_timeout (1);
1585	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2293	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1586		2294
1587	$cf::MAP{$self->path} = $self;	2295	$cf::MAP{$self->path} = $self;
		2296	}
1588		2297
1589	$self->reset; # polite request, might not happen	2298	$self->reset; # polite request, might not happen
		2299	}
		2300
		2301	=item $maps = cf::map::tmp_maps
		2302
		2303	Returns an arrayref with all map paths of currently instantiated and saved
		2304	maps. May block.
		2305
		2306	=cut
		2307
		2308	sub tmp_maps() {
		2309	[
		2310	map {
		2311	utf8::decode $_;
		2312	/\.map$/
		2313	? normalise $_
		2314	: ()
		2315	} @{ aio_readdir $TMPDIR or [] }
		2316	]
		2317	}
		2318
		2319	=item $maps = cf::map::random_maps
		2320
		2321	Returns an arrayref with all map paths of currently instantiated and saved
		2322	random maps. May block.
		2323
		2324	=cut
		2325
		2326	sub random_maps() {
		2327	[
		2328	map {
		2329	utf8::decode $_;
		2330	/\.map$/
		2331	? normalise "?random/$_"
		2332	: ()
		2333	} @{ aio_readdir $RANDOMDIR or [] }
		2334	]
1590	}	2335	}
1591		2336
1592	=item cf::map::unique_maps	2337	=item cf::map::unique_maps
1593		2338
1594	Returns an arrayref of paths of all shared maps that have	2339	Returns an arrayref of paths of all shared maps that have
1595	instantiated unique items. May block.	2340	instantiated unique items. May block.
1596		2341
1597	=cut	2342	=cut
1598		2343
1599	sub unique_maps() {	2344	sub unique_maps() {
1600	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2345	[
1601	or return;	2346	map {
1602
1603	my @paths;
1604
1605	for (@$files) {
1606	utf8::decode $_;	2347	utf8::decode $_;
1607	next if /\.pst$/;
1608	next unless /^$PATH_SEP/o;
1609
1610	s/\.map$//;	2348	/\.map$/
1611	push @paths, $_;	2349	? normalise $_
		2350	: ()
		2351	} @{ aio_readdir $UNIQUEDIR or [] }
1612	}	2352	]
1613
1614	\@paths
1615	}	2353	}
1616		2354
1617	package cf;	2355	package cf;
1618		2356
1619	=back	2357	=back
…		…
1637	map { $_, inv_recursive_ $_->inv } @_	2375	map { $_, inv_recursive_ $_->inv } @_
1638	}	2376	}
1639		2377
1640	sub inv_recursive {	2378	sub inv_recursive {
1641	inv_recursive_ inv $_[0]	2379	inv_recursive_ inv $_[0]
		2380	}
		2381
		2382	=item $ref = $ob->ref
		2383
		2384	creates and returns a persistent reference to an objetc that can be stored as a string.
		2385
		2386	=item $ob = cf::object::deref ($refstring)
		2387
		2388	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2389	even if the object actually exists. May block.
		2390
		2391	=cut
		2392
		2393	sub deref {
		2394	my ($ref) = @_;
		2395
		2396	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2397	my ($uuid, $name) = ($1, $2);
		2398	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2399	or return;
		2400	$pl->ob->uuid eq $uuid
		2401	or return;
		2402
		2403	$pl->ob
		2404	} else {
		2405	warn "$ref: cannot resolve object reference\n";
		2406	undef
		2407	}
1642	}	2408	}
1643		2409
1644	package cf;	2410	package cf;
1645		2411
1646	=back	2412	=back
…		…
1665		2431
1666	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2432	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1667		2433
1668	if ($self->{record_replies}) {	2434	if ($self->{record_replies}) {
1669	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2435	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2436
1670	} else {	2437	} else {
		2438	my $pl = $self->contr;
		2439
		2440	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2441	my $dialog = $pl->{npc_dialog};
		2442	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2443
		2444	} else {
1671	$msg = $npc->name . " says: $msg" if $npc;	2445	$msg = $npc->name . " says: $msg" if $npc;
1672	$self->message ($msg, $flags);	2446	$self->message ($msg, $flags);
		2447	}
1673	}	2448	}
		2449	}
		2450
		2451	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2452
		2453	=cut
		2454
		2455	sub cf::object::send_msg {
		2456	my $pl = shift->contr
		2457	or return;
		2458	$pl->send_msg (@_);
1674	}	2459	}
1675		2460
1676	=item $player_object->may ("access")	2461	=item $player_object->may ("access")
1677		2462
1678	Returns wether the given player is authorized to access resource "access"	2463	Returns wether the given player is authorized to access resource "access"
…		…
1710	=cut	2495	=cut
1711		2496
1712	sub link_map {	2497	sub link_map {
1713	unless ($LINK_MAP) {	2498	unless ($LINK_MAP) {
1714	$LINK_MAP = cf::map::find "{link}"	2499	$LINK_MAP = cf::map::find "{link}"
1715	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2500	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1716	$LINK_MAP->load;	2501	$LINK_MAP->load;
1717	}	2502	}
1718		2503
1719	$LINK_MAP	2504	$LINK_MAP
1720	}	2505	}
…		…
1725	$self->deactivate_recursive;	2510	$self->deactivate_recursive;
1726		2511
1727	return if UNIVERSAL::isa $self->map, "ext::map_link";	2512	return if UNIVERSAL::isa $self->map, "ext::map_link";
1728		2513
1729	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2514	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1730	if $self->map;	2515	if $self->map && $self->map->{path} ne "{link}";
1731		2516
1732	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2517	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1733	}	2518	}
1734		2519
1735	sub cf::object::player::leave_link {	2520	sub cf::object::player::leave_link {
1736	my ($self, $map, $x, $y) = @_;	2521	my ($self, $map, $x, $y) = @_;
		2522
		2523	return unless $self->contr->active;
1737		2524
1738	my $link_pos = delete $self->{_link_pos};	2525	my $link_pos = delete $self->{_link_pos};
1739		2526
1740	unless ($map) {	2527	unless ($map) {
1741	# restore original map position	2528	# restore original map position
…		…
1755	# use -1 or undef as default coordinates, not 0, 0	2542	# use -1 or undef as default coordinates, not 0, 0
1756	($x, $y) = ($map->enter_x, $map->enter_y)	2543	($x, $y) = ($map->enter_x, $map->enter_y)
1757	if $x <=0 && $y <= 0;	2544	if $x <=0 && $y <= 0;
1758		2545
1759	$map->load;	2546	$map->load;
1760	$map->load_diag;	2547	$map->load_neighbours;
1761		2548
1762	return unless $self->contr->active;	2549	return unless $self->contr->active;
1763	$self->activate_recursive;	2550	$self->activate_recursive;
		2551
		2552	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1764	$self->enter_map ($map, $x, $y);	2553	$self->enter_map ($map, $x, $y);
1765	}	2554	}
1766		2555
1767	cf::player->attach (	2556	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1768	on_logout => sub {
1769	my ($pl) = @_;
1770		2557
1771	# abort map switching before logout	2558	Moves the player to the given map-path and coordinates by first freezing
1772	if ($pl->ob->{_link_pos}) {	2559	her, loading and preparing them map, calling the provided $check callback
1773	cf::sync_job {	2560	that has to return the map if sucecssful, and then unfreezes the player on
1774	$pl->ob->leave_link	2561	the new (success) or old (failed) map position. In either case, $done will
1775	};	2562	be called at the end of this process.
1776	}
1777	},
1778	on_login => sub {
1779	my ($pl) = @_;
1780		2563
1781	# try to abort aborted map switching on player login :)
1782	# should happen only on crashes
1783	if ($pl->ob->{_link_pos}) {
1784	$pl->ob->enter_link;
1785	(async {
1786	# we need this sleep as the login has a concurrent enter_exit running
1787	# and this sleep increases chances of the player not ending up in scorn
1788	$pl->ob->reply (undef,
1789	"There was an internal problem at your last logout, "
1790	. "the server will try to bring you to your intended destination in a second.",
1791	cf::NDI_RED);
1792	Coro::Timer::sleep 1;
1793	$pl->ob->leave_link;
1794	})->prio (2);
1795	}
1796	},
1797	);
1798
1799	=item $player_object->goto ($path, $x, $y)
1800
1801	=cut	2564	=cut
		2565
		2566	our $GOTOGEN;
1802		2567
1803	sub cf::object::player::goto {	2568	sub cf::object::player::goto {
1804	my ($self, $path, $x, $y) = @_;	2569	my ($self, $path, $x, $y, $check, $done) = @_;
		2570
		2571	# do generation counting so two concurrent goto's will be executed in-order
		2572	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1805		2573
1806	$self->enter_link;	2574	$self->enter_link;
1807		2575
1808	(async {	2576	(async {
1809	my $map = cf::map::find $path;	2577	$Coro::current->{desc} = "player::goto $path $x $y";
		2578
		2579	# *tag paths override both path and x|y
		2580	if ($path =~ /^\*(.*)$/) {
		2581	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2582	my $ob = $obs[rand @obs];
		2583
		2584	# see if we actually can go there
		2585	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2586	$ob = $obs[rand @obs];
		2587	} else {
		2588	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2589	}
		2590	# else put us there anyways for now #d#
		2591
		2592	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2593	} else {
		2594	($path, $x, $y) = (undef, undef, undef);
		2595	}
		2596	}
		2597
		2598	my $map = eval {
		2599	my $map = defined $path ? cf::map::find $path : undef;
		2600
		2601	if ($map) {
1810	$map = $map->customise_for ($self) if $map;	2602	$map = $map->customise_for ($self);
1811		2603	$map = $check->($map) if $check && $map;
1812	# warn "entering ", $map->path, " at ($x, $y)\n"	2604	} else {
1813	# if $map;
1814
1815	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2605	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2606	}
1816		2607
		2608	$map
		2609	};
		2610
		2611	if ($@) {
		2612	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2613	LOG llevError | logBacktrace, Carp::longmess $@;
		2614	}
		2615
		2616	if ($gen == $self->{_goto_generation}) {
		2617	delete $self->{_goto_generation};
1817	$self->leave_link ($map, $x, $y);	2618	$self->leave_link ($map, $x, $y);
		2619	}
		2620
		2621	$done->() if $done;
1818	})->prio (1);	2622	})->prio (1);
1819	}	2623	}
1820		2624
1821	=item $player_object->enter_exit ($exit_object)	2625	=item $player_object->enter_exit ($exit_object)
1822		2626
…		…
1851	# that depends on the exit object	2655	# that depends on the exit object
1852		2656
1853	my $rmp = parse_random_map_params $exit->msg;	2657	my $rmp = parse_random_map_params $exit->msg;
1854		2658
1855	if ($exit->map) {	2659	if ($exit->map) {
1856	$rmp->{region} = $exit->map->region_name;	2660	$rmp->{region} = $exit->region->name;
1857	$rmp->{origin_map} = $exit->map->path;	2661	$rmp->{origin_map} = $exit->map->path;
1858	$rmp->{origin_x} = $exit->x;	2662	$rmp->{origin_x} = $exit->x;
1859	$rmp->{origin_y} = $exit->y;	2663	$rmp->{origin_y} = $exit->y;
1860	}	2664	}
1861		2665
1862	$rmp->{random_seed} ||= $exit->random_seed;	2666	$rmp->{random_seed} ||= $exit->random_seed;
1863		2667
1864	my $data = cf::to_json $rmp;	2668	my $data = cf::encode_json $rmp;
1865	my $md5 = Digest::MD5::md5_hex $data;	2669	my $md5 = Digest::MD5::md5_hex $data;
1866	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2670	my $meta = "$RANDOMDIR/$md5.meta";
1867		2671
1868	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2672	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1869	aio_write $fh, 0, (length $data), $data, 0;	2673	aio_write $fh, 0, (length $data), $data, 0;
1870	undef $fh;	2674	undef $fh;
1871	aio_rename "$meta~", $meta;	2675	aio_rename "$meta~", $meta;
…		…
1878	sub cf::object::player::enter_exit {	2682	sub cf::object::player::enter_exit {
1879	my ($self, $exit) = @_;	2683	my ($self, $exit) = @_;
1880		2684
1881	return unless $self->type == cf::PLAYER;	2685	return unless $self->type == cf::PLAYER;
1882		2686
		2687	if ($exit->slaying eq "/!") {
		2688	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2689	# the problem is that $exit might not survive long enough
		2690	# so it needs to be done right now, right here
		2691	cf::sync_job { prepare_random_map $exit };
		2692	}
		2693
		2694	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2695	my $hp = $exit->stats->hp;
		2696	my $sp = $exit->stats->sp;
		2697
1883	$self->enter_link;	2698	$self->enter_link;
1884		2699
		2700	# if exit is damned, update players death & WoR home-position
		2701	$self->contr->savebed ($slaying, $hp, $sp)
		2702	if $exit->flag (FLAG_DAMNED);
		2703
1885	(async {	2704	(async {
		2705	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2706
1886	$self->deactivate_recursive; # just to be sure	2707	$self->deactivate_recursive; # just to be sure
1887	unless (eval {	2708	unless (eval {
1888	prepare_random_map $exit	2709	$self->goto ($slaying, $hp, $sp);
1889	if $exit->slaying eq "/!";
1890
1891	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1892	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1893		2710
1894	1;	2711	1;
1895	}) {	2712	}) {
1896	$self->message ("Something went wrong deep within the crossfire server. "	2713	$self->message ("Something went wrong deep within the crossfire server. "
1897	. "I'll try to bring you back to the map you were before. "	2714	. "I'll try to bring you back to the map you were before. "
1898	. "Please report this to the dungeon master!",	2715	. "Please report this to the dungeon master!",
1899	cf::NDI_UNIQUE | cf::NDI_RED);	2716	cf::NDI_UNIQUE | cf::NDI_RED);
1900		2717
1901	warn "ERROR in enter_exit: $@";	2718	warn "ERROR in enter_exit: $@";
1902	$self->leave_link;	2719	$self->leave_link;
1903	}	2720	}
1904	})->prio (1);	2721	})->prio (1);
…		…
1917		2734
1918	sub cf::client::send_drawinfo {	2735	sub cf::client::send_drawinfo {
1919	my ($self, $text, $flags) = @_;	2736	my ($self, $text, $flags) = @_;
1920		2737
1921	utf8::encode $text;	2738	utf8::encode $text;
1922	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2739	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1923	}	2740	}
1924		2741
		2742	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2743
		2744	Send a drawinfo or msg packet to the client, formatting the msg for the
		2745	client if neccessary. C<$type> should be a string identifying the type of
		2746	the message, with C<log> being the default. If C<$color> is negative, suppress
		2747	the message unless the client supports the msg packet.
		2748
		2749	=cut
		2750
		2751	# non-persistent channels (usually the info channel)
		2752	our %CHANNEL = (
		2753	"c/identify" => {
		2754	id => "infobox",
		2755	title => "Identify",
		2756	reply => undef,
		2757	tooltip => "Items recently identified",
		2758	},
		2759	"c/examine" => {
		2760	id => "infobox",
		2761	title => "Examine",
		2762	reply => undef,
		2763	tooltip => "Signs and other items you examined",
		2764	},
		2765	"c/book" => {
		2766	id => "infobox",
		2767	title => "Book",
		2768	reply => undef,
		2769	tooltip => "The contents of a note or book",
		2770	},
		2771	"c/lookat" => {
		2772	id => "infobox",
		2773	title => "Look",
		2774	reply => undef,
		2775	tooltip => "What you saw there",
		2776	},
		2777	"c/who" => {
		2778	id => "infobox",
		2779	title => "Players",
		2780	reply => undef,
		2781	tooltip => "Shows players who are currently online",
		2782	},
		2783	"c/body" => {
		2784	id => "infobox",
		2785	title => "Body Parts",
		2786	reply => undef,
		2787	tooltip => "Shows which body parts you posess and are available",
		2788	},
		2789	"c/uptime" => {
		2790	id => "infobox",
		2791	title => "Uptime",
		2792	reply => undef,
		2793	tooltip => "How long the server has been running since last restart",
		2794	},
		2795	"c/mapinfo" => {
		2796	id => "infobox",
		2797	title => "Map Info",
		2798	reply => undef,
		2799	tooltip => "Information related to the maps",
		2800	},
		2801	);
		2802
		2803	sub cf::client::send_msg {
		2804	my ($self, $channel, $msg, $color, @extra) = @_;
		2805
		2806	$msg = $self->pl->expand_cfpod ($msg);
		2807
		2808	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2809
		2810	# check predefined channels, for the benefit of C
		2811	if ($CHANNEL{$channel}) {
		2812	$channel = $CHANNEL{$channel};
		2813
		2814	$self->ext_msg (channel_info => $channel)
		2815	if $self->can_msg;
		2816
		2817	$channel = $channel->{id};
		2818
		2819	} elsif (ref $channel) {
		2820	# send meta info to client, if not yet sent
		2821	unless (exists $self->{channel}{$channel->{id}}) {
		2822	$self->{channel}{$channel->{id}} = $channel;
		2823	$self->ext_msg (channel_info => $channel)
		2824	if $self->can_msg;
		2825	}
		2826
		2827	$channel = $channel->{id};
		2828	}
		2829
		2830	return unless @extra || length $msg;
		2831
		2832	if ($self->can_msg) {
		2833	# default colour, mask it out
		2834	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2835	if $color & cf::NDI_DEF;
		2836
		2837	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2838	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2839	} else {
		2840	if ($color >= 0) {
		2841	# replace some tags by gcfclient-compatible ones
		2842	for ($msg) {
		2843	1 while
		2844	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2845	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2846	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2847	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2848	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2849	}
		2850
		2851	$color &= cf::NDI_COLOR_MASK;
		2852
		2853	utf8::encode $msg;
		2854
		2855	if (0 && $msg =~ /\[/) {
		2856	# COMMAND/INFO
		2857	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2858	} else {
		2859	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2860	$self->send_packet ("drawinfo $color $msg")
		2861	}
		2862	}
		2863	}
		2864	}
		2865
		2866	=item $client->ext_msg ($type, @msg)
		2867
		2868	Sends an ext event to the client.
		2869
		2870	=cut
		2871
		2872	sub cf::client::ext_msg($$@) {
		2873	my ($self, $type, @msg) = @_;
		2874
		2875	if ($self->extcmd == 2) {
		2876	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2877	} elsif ($self->extcmd == 1) { # TODO: remove
		2878	push @msg, msgtype => "event_$type";
		2879	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2880	}
		2881	}
		2882
		2883	=item $client->ext_reply ($msgid, @msg)
		2884
		2885	Sends an ext reply to the client.
		2886
		2887	=cut
		2888
		2889	sub cf::client::ext_reply($$@) {
		2890	my ($self, $id, @msg) = @_;
		2891
		2892	if ($self->extcmd == 2) {
		2893	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2894	} elsif ($self->extcmd == 1) {
		2895	#TODO: version 1, remove
		2896	unshift @msg, msgtype => "reply", msgid => $id;
		2897	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2898	}
		2899	}
1925		2900
1926	=item $success = $client->query ($flags, "text", \&cb)	2901	=item $success = $client->query ($flags, "text", \&cb)
1927		2902
1928	Queues a query to the client, calling the given callback with	2903	Queues a query to the client, calling the given callback with
1929	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2904	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1930	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2905	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1931		2906
1932	Queries can fail, so check the return code. Or don't, as queries will become	2907	Queries can fail, so check the return code. Or don't, as queries will
1933	reliable at some point in the future.	2908	become reliable at some point in the future.
1934		2909
1935	=cut	2910	=cut
1936		2911
1937	sub cf::client::query {	2912	sub cf::client::query {
1938	my ($self, $flags, $text, $cb) = @_;	2913	my ($self, $flags, $text, $cb) = @_;
…		…
1946	utf8::encode $text;	2921	utf8::encode $text;
1947	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2922	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1948		2923
1949	$self->send_packet ($self->{query_queue}[0][0])	2924	$self->send_packet ($self->{query_queue}[0][0])
1950	if @{ $self->{query_queue} } == 1;	2925	if @{ $self->{query_queue} } == 1;
		2926
		2927	1
1951	}	2928	}
1952		2929
1953	cf::client->attach (	2930	cf::client->attach (
		2931	on_connect => sub {
		2932	my ($ns) = @_;
		2933
		2934	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2935	},
1954	on_reply => sub {	2936	on_reply => sub {
1955	my ($ns, $msg) = @_;	2937	my ($ns, $msg) = @_;
1956		2938
1957	# this weird shuffling is so that direct followup queries	2939	# this weird shuffling is so that direct followup queries
1958	# get handled first	2940	# get handled first
1959	my $queue = delete $ns->{query_queue}	2941	my $queue = delete $ns->{query_queue}
1960	or return; # be conservative, not sure how that can happen, but we saw a crash here	2942	or return; # be conservative, not sure how that can happen, but we saw a crash here
1961		2943
1962	(shift @$queue)->[1]->($msg);	2944	(shift @$queue)->[1]->($msg);
		2945	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1963		2946
1964	push @{ $ns->{query_queue} }, @$queue;	2947	push @{ $ns->{query_queue} }, @$queue;
1965		2948
1966	if (@{ $ns->{query_queue} } == @$queue) {	2949	if (@{ $ns->{query_queue} } == @$queue) {
1967	if (@$queue) {	2950	if (@$queue) {
…		…
1969	} else {	2952	} else {
1970	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2953	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1971	}	2954	}
1972	}	2955	}
1973	},	2956	},
		2957	on_exticmd => sub {
		2958	my ($ns, $buf) = @_;
		2959
		2960	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2961
		2962	if (ref $msg) {
		2963	my ($type, $reply, @payload) =
		2964	"ARRAY" eq ref $msg
		2965	? @$msg
		2966	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2967
		2968	my @reply;
		2969
		2970	if (my $cb = $EXTICMD{$type}) {
		2971	@reply = $cb->($ns, @payload);
		2972	}
		2973
		2974	$ns->ext_reply ($reply, @reply)
		2975	if $reply;
		2976
		2977	} else {
		2978	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2979	}
		2980
		2981	cf::override;
		2982	},
1974	);	2983	);
1975		2984
1976	=item $client->async (\&cb)	2985	=item $client->async (\&cb)
1977		2986
1978	Create a new coroutine, running the specified callback. The coroutine will	2987	Create a new coroutine, running the specified callback. The coroutine will
…		…
2019	our $safe = new Safe "safe";	3028	our $safe = new Safe "safe";
2020	our $safe_hole = new Safe::Hole;	3029	our $safe_hole = new Safe::Hole;
2021		3030
2022	$SIG{FPE} = 'IGNORE';	3031	$SIG{FPE} = 'IGNORE';
2023		3032
2024	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3033	$safe->permit_only (Opcode::opset qw(
		3034	:base_core :base_mem :base_orig :base_math
		3035	grepstart grepwhile mapstart mapwhile
		3036	sort time
		3037	));
2025		3038
2026	# here we export the classes and methods available to script code	3039	# here we export the classes and methods available to script code
2027		3040
2028	=pod	3041	=pod
2029		3042
2030	The following fucntions and emthods are available within a safe environment:	3043	The following functions and methods are available within a safe environment:
2031		3044
2032	cf::object contr pay_amount pay_player map	3045	cf::object
		3046	contr pay_amount pay_player map x y force_find force_add destroy
		3047	insert remove name archname title slaying race decrease_ob_nr
		3048
2033	cf::object::player player	3049	cf::object::player
2034	cf::player peaceful	3050	player
2035	cf::map trigger	3051
		3052	cf::player
		3053	peaceful
		3054
		3055	cf::map
		3056	trigger
2036		3057
2037	=cut	3058	=cut
2038		3059
2039	for (	3060	for (
2040	["cf::object" => qw(contr pay_amount pay_player map)],	3061	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3062	insert remove inv name archname title slaying race
		3063	decrease_ob_nr destroy)],
2041	["cf::object::player" => qw(player)],	3064	["cf::object::player" => qw(player)],
2042	["cf::player" => qw(peaceful)],	3065	["cf::player" => qw(peaceful)],
2043	["cf::map" => qw(trigger)],	3066	["cf::map" => qw(trigger)],
2044	) {	3067	) {
2045	no strict 'refs';	3068	no strict 'refs';
…		…
2116	=back	3139	=back
2117		3140
2118	=cut	3141	=cut
2119		3142
2120	#############################################################################	3143	#############################################################################
		3144	# the server's init and main functions
2121		3145
2122	=head2 EXTENSION DATABASE SUPPORT	3146	sub load_facedata($) {
		3147	my ($path) = @_;
2123		3148
2124	Crossfire maintains a very simple database for extension use. It can	3149	# HACK to clear player env face cache, we need some signal framework
2125	currently store anything that can be serialised using Storable, which	3150	# for this (global event?)
2126	excludes objects.	3151	%ext::player_env::MUSIC_FACE_CACHE = ();
2127		3152
2128	The parameter C<$family> should best start with the name of the extension	3153	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2129	using it, it should be unique.
2130		3154
2131	=over 4	3155	warn "loading facedata from $path\n";
2132		3156
2133	=item $hashref = cf::db_get $family	3157	my $facedata;
		3158	0 < aio_load $path, $facedata
		3159	or die "$path: $!";
2134		3160
2135	Return a hashref for use by the extension C<$family>, which can be	3161	$facedata = Coro::Storable::thaw $facedata;
2136	modified. After modifications, you have to call C<cf::db_dirty> or
2137	C<cf::db_sync>.
2138		3162
2139	=item $value = cf::db_get $family => $key	3163	$facedata->{version} == 2
		3164	or cf::cleanup "$path: version mismatch, cannot proceed.";
2140		3165
2141	Returns a single value from the database	3166	# patch in the exptable
2142		3167	$facedata->{resource}{"res/exp_table"} = {
2143	=item cf::db_put $family => $hashref	3168	type => FT_RSRC,
2144		3169	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2145	Stores the given family hashref into the database. Updates are delayed, if
2146	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2147
2148	=item cf::db_put $family => $key => $value
2149
2150	Stores the given C<$value> in the family hash. Updates are delayed, if you
2151	want the data to be synced to disk immediately, use C<cf::db_sync>.
2152
2153	=item cf::db_dirty
2154
2155	Marks the database as dirty, to be updated at a later time.
2156
2157	=item cf::db_sync
2158
2159	Immediately write the database to disk I<if it is dirty>.
2160
2161	=cut
2162
2163	our $DB;
2164
2165	{
2166	my $path = cf::localdir . "/database.pst";
2167
2168	sub db_load() {
2169	$DB = stat $path ? Storable::retrieve $path : { };
2170	}
2171
2172	my $pid;
2173
2174	sub db_save() {
2175	waitpid $pid, 0 if $pid;
2176	if (0 == ($pid = fork)) {
2177	$DB->{_meta}{version} = 1;
2178	Storable::nstore $DB, "$path~";
2179	rename "$path~", $path;
2180	cf::_exit 0 if defined $pid;
2181	}
2182	}
2183
2184	my $dirty;
2185
2186	sub db_sync() {
2187	db_save if $dirty;
2188	undef $dirty;
2189	}
2190
2191	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2192	db_sync;
2193	});	3170	};
		3171	cf::cede_to_tick;
2194		3172
2195	sub db_dirty() {
2196	$dirty = 1;
2197	$idle->start;
2198	}	3173	{
		3174	my $faces = $facedata->{faceinfo};
2199		3175
2200	sub db_get($;$) {	3176	while (my ($face, $info) = each %$faces) {
2201	@_ >= 2	3177	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2202	? $DB->{$_[0]}{$_[1]}
2203	: ($DB->{$_[0]} ||= { })
2204	}
2205		3178
2206	sub db_put($$;$) {	3179	cf::face::set_visibility $idx, $info->{visibility};
2207	if (@_ >= 3) {	3180	cf::face::set_magicmap $idx, $info->{magicmap};
2208	$DB->{$_[0]}{$_[1]} = $_[2];	3181	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2209	} else {	3182	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2210	$DB->{$_[0]} = $_[1];
2211	}
2212	db_dirty;
2213	}
2214		3183
2215	cf::global->attach (	3184	cf::cede_to_tick;
2216	prio => 10000,
2217	on_cleanup => sub {
2218	db_sync;
2219	},	3185	}
2220	);
2221	}
2222		3186
2223	#############################################################################	3187	while (my ($face, $info) = each %$faces) {
2224	# the server's main()	3188	next unless $info->{smooth};
2225		3189
2226	sub cfg_load {	3190	my $idx = cf::face::find $face
		3191	or next;
		3192
		3193	if (my $smooth = cf::face::find $info->{smooth}) {
		3194	cf::face::set_smooth $idx, $smooth;
		3195	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3196	} else {
		3197	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3198	}
		3199
		3200	cf::cede_to_tick;
		3201	}
		3202	}
		3203
		3204	{
		3205	my $anims = $facedata->{animinfo};
		3206
		3207	while (my ($anim, $info) = each %$anims) {
		3208	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3209	cf::cede_to_tick;
		3210	}
		3211
		3212	cf::anim::invalidate_all; # d'oh
		3213	}
		3214
		3215	{
		3216	# TODO: for gcfclient pleasure, we should give resources
		3217	# that gcfclient doesn't grok a >10000 face index.
		3218	my $res = $facedata->{resource};
		3219
		3220	while (my ($name, $info) = each %$res) {
		3221	if (defined $info->{type}) {
		3222	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3223	my $data;
		3224
		3225	if ($info->{type} & 1) {
		3226	# prepend meta info
		3227
		3228	my $meta = $enc->encode ({
		3229	name => $name,
		3230	%{ $info->{meta} || {} },
		3231	});
		3232
		3233	$data = pack "(w/a*)*", $meta, $info->{data};
		3234	} else {
		3235	$data = $info->{data};
		3236	}
		3237
		3238	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3239	cf::face::set_type $idx, $info->{type};
		3240	} else {
		3241	$RESOURCE{$name} = $info;
		3242	}
		3243
		3244	cf::cede_to_tick;
		3245	}
		3246	}
		3247
		3248	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3249
		3250	1
		3251	}
		3252
		3253	cf::global->attach (on_resource_update => sub {
		3254	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3255	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3256
		3257	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3258	my $sound = $soundconf->{compat}[$_]
		3259	or next;
		3260
		3261	my $face = cf::face::find "sound/$sound->[1]";
		3262	cf::sound::set $sound->[0] => $face;
		3263	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3264	}
		3265
		3266	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3267	my $face = cf::face::find "sound/$v";
		3268	cf::sound::set $k => $face;
		3269	}
		3270	}
		3271	});
		3272
		3273	register_exticmd fx_want => sub {
		3274	my ($ns, $want) = @_;
		3275
		3276	while (my ($k, $v) = each %$want) {
		3277	$ns->fx_want ($k, $v);
		3278	}
		3279	};
		3280
		3281	sub reload_regions {
		3282	# HACK to clear player env face cache, we need some signal framework
		3283	# for this (global event?)
		3284	%ext::player_env::MUSIC_FACE_CACHE = ();
		3285
		3286	load_resource_file "$MAPDIR/regions"
		3287	or die "unable to load regions file\n";
		3288
		3289	for (cf::region::list) {
		3290	$_->{match} = qr/$_->{match}/
		3291	if exists $_->{match};
		3292	}
		3293	}
		3294
		3295	sub reload_facedata {
		3296	load_facedata "$DATADIR/facedata"
		3297	or die "unable to load facedata\n";
		3298	}
		3299
		3300	sub reload_archetypes {
		3301	load_resource_file "$DATADIR/archetypes"
		3302	or die "unable to load archetypes\n";
		3303	#d# NEED to laod twice to resolve forward references
		3304	# this really needs to be done in an extra post-pass
		3305	# (which needs to be synchronous, so solve it differently)
		3306	load_resource_file "$DATADIR/archetypes"
		3307	or die "unable to load archetypes\n";
		3308	}
		3309
		3310	sub reload_treasures {
		3311	load_resource_file "$DATADIR/treasures"
		3312	or die "unable to load treasurelists\n";
		3313	}
		3314
		3315	sub reload_resources {
		3316	warn "reloading resource files...\n";
		3317
		3318	reload_regions;
		3319	reload_facedata;
		3320	#reload_archetypes;#d#
		3321	reload_archetypes;
		3322	reload_treasures;
		3323
		3324	warn "finished reloading resource files\n";
		3325	}
		3326
		3327	sub init {
		3328	reload_resources;
		3329	}
		3330
		3331	sub reload_config {
2227	open my $fh, "<:utf8", cf::confdir . "/config"	3332	open my $fh, "<:utf8", "$CONFDIR/config"
2228	or return;	3333	or return;
2229		3334
2230	local $/;	3335	local $/;
2231	*CFG = YAML::Syck::Load <$fh>;	3336	*CFG = YAML::Load <$fh>;
2232		3337
2233	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3338	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2234		3339
2235	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3340	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2236	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3341	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2247	sub main {	3352	sub main {
2248	# we must not ever block the main coroutine	3353	# we must not ever block the main coroutine
2249	local $Coro::idle = sub {	3354	local $Coro::idle = sub {
2250	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3355	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2251	(async {	3356	(async {
2252	Event::one_event;	3357	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3358	EV::loop EV::LOOP_ONESHOT;
2253	})->prio (Coro::PRIO_MAX);	3359	})->prio (Coro::PRIO_MAX);
2254	};	3360	};
2255		3361
2256	cfg_load;	3362	reload_config;
2257	db_load;	3363	db_init;
2258	load_extensions;	3364	load_extensions;
2259		3365
2260	$TICK_WATCHER->start;	3366	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3367	evthread_start IO::AIO::poll_fileno;
2261	Event::loop;	3368	EV::loop;
2262	}	3369	}
2263		3370
2264	#############################################################################	3371	#############################################################################
2265	# initialisation and cleanup	3372	# initialisation and cleanup
2266		3373
2267	# install some emergency cleanup handlers	3374	# install some emergency cleanup handlers
2268	BEGIN {	3375	BEGIN {
		3376	our %SIGWATCHER = ();
2269	for my $signal (qw(INT HUP TERM)) {	3377	for my $signal (qw(INT HUP TERM)) {
2270	Event->signal (	3378	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2271	data => WF_AUTOCANCEL,
2272	signal => $signal,
2273	cb => sub {
2274	cf::cleanup "SIG$signal";	3379	cf::cleanup "SIG$signal";
2275	},
2276	);	3380	};
		3381	}
		3382	}
		3383
		3384	sub write_runtime {
		3385	my $runtime = "$LOCALDIR/runtime";
		3386
		3387	# first touch the runtime file to show we are still running:
		3388	# the fsync below can take a very very long time.
		3389
		3390	IO::AIO::aio_utime $runtime, undef, undef;
		3391
		3392	my $guard = cf::lock_acquire "write_runtime";
		3393
		3394	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3395	or return;
		3396
		3397	my $value = $cf::RUNTIME + 90 + 10;
		3398	# 10 is the runtime save interval, for a monotonic clock
		3399	# 60 allows for the watchdog to kill the server.
		3400
		3401	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3402	and return;
		3403
		3404	# always fsync - this file is important
		3405	aio_fsync $fh
		3406	and return;
		3407
		3408	# touch it again to show we are up-to-date
		3409	aio_utime $fh, undef, undef;
		3410
		3411	close $fh
		3412	or return;
		3413
		3414	aio_rename "$runtime~", $runtime
		3415	and return;
		3416
		3417	warn "runtime file written.\n";
		3418
2277	}	3419	1
2278	}	3420	}
2279		3421
2280	sub emergency_save() {	3422	sub emergency_save() {
2281	my $freeze_guard = cf::freeze_mainloop;	3423	my $freeze_guard = cf::freeze_mainloop;
2282		3424
…		…
2288	# and maps saved/destroyed asynchronously.	3430	# and maps saved/destroyed asynchronously.
2289	warn "begin emergency player save\n";	3431	warn "begin emergency player save\n";
2290	for my $login (keys %cf::PLAYER) {	3432	for my $login (keys %cf::PLAYER) {
2291	my $pl = $cf::PLAYER{$login} or next;	3433	my $pl = $cf::PLAYER{$login} or next;
2292	$pl->valid or next;	3434	$pl->valid or next;
		3435	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2293	$pl->save;	3436	$pl->save;
2294	}	3437	}
2295	warn "end emergency player save\n";	3438	warn "end emergency player save\n";
2296		3439
2297	warn "begin emergency map save\n";	3440	warn "begin emergency map save\n";
…		…
2299	my $map = $cf::MAP{$path} or next;	3442	my $map = $cf::MAP{$path} or next;
2300	$map->valid or next;	3443	$map->valid or next;
2301	$map->save;	3444	$map->save;
2302	}	3445	}
2303	warn "end emergency map save\n";	3446	warn "end emergency map save\n";
		3447
		3448	warn "begin emergency database checkpoint\n";
		3449	BDB::db_env_txn_checkpoint $DB_ENV;
		3450	warn "end emergency database checkpoint\n";
2304	};	3451	};
2305		3452
2306	warn "leave emergency perl save\n";	3453	warn "leave emergency perl save\n";
2307	}	3454	}
2308		3455
		3456	sub post_cleanup {
		3457	my ($make_core) = @_;
		3458
		3459	warn Carp::longmess "post_cleanup backtrace"
		3460	if $make_core;
		3461	}
		3462
2309	sub reload() {	3463	sub do_reload_perl() {
2310	# can/must only be called in main	3464	# can/must only be called in main
2311	if ($Coro::current != $Coro::main) {	3465	if ($Coro::current != $Coro::main) {
2312	warn "can only reload from main coroutine";	3466	warn "can only reload from main coroutine";
2313	return;	3467	return;
2314	}	3468	}
2315		3469
2316	warn "reloading...";	3470	warn "reloading...";
2317		3471
2318	warn "cancelling server ticker";	3472	warn "entering sync_job";
2319	$TICK_WATCHER->cancel;
2320		3473
		3474	cf::sync_job {
		3475	cf::write_runtime; # external watchdog should not bark
2321	cf::emergency_save;	3476	cf::emergency_save;
		3477	cf::write_runtime; # external watchdog should not bark
2322		3478
2323	eval {	3479	warn "syncing database to disk";
		3480	BDB::db_env_txn_checkpoint $DB_ENV;
		3481
2324	# if anything goes wrong in here, we should simply crash as we already saved	3482	# if anything goes wrong in here, we should simply crash as we already saved
2325
2326	warn "syncing database to disk";
2327	cf::db_sync;
2328
2329	warn "cancelling all WF_AUTOCANCEL watchers";
2330	for (Event::all_watchers) {
2331	$_->cancel if $_->data & WF_AUTOCANCEL;
2332	}
2333		3483
2334	warn "flushing outstanding aio requests";	3484	warn "flushing outstanding aio requests";
2335	for (;;) {	3485	for (;;) {
		3486	BDB::flush;
2336	IO::AIO::flush;	3487	IO::AIO::flush;
2337	Coro::cede;	3488	Coro::cede_notself;
2338	last unless IO::AIO::nreqs;	3489	last unless IO::AIO::nreqs || BDB::nreqs;
2339	warn "iterate...";	3490	warn "iterate...";
2340	}	3491	}
		3492
		3493	++$RELOAD;
2341		3494
2342	warn "cancelling all extension coros";	3495	warn "cancelling all extension coros";
2343	$_->cancel for values %EXT_CORO;	3496	$_->cancel for values %EXT_CORO;
2344	%EXT_CORO = ();	3497	%EXT_CORO = ();
2345		3498
2346	warn "removing commands";	3499	warn "removing commands";
2347	%COMMAND = ();	3500	%COMMAND = ();
2348		3501
2349	warn "removing ext commands";	3502	warn "removing ext/exti commands";
2350	%EXTCMD = ();	3503	%EXTCMD = ();
		3504	%EXTICMD = ();
2351		3505
2352	warn "unloading/nuking all extensions";	3506	warn "unloading/nuking all extensions";
2353	for my $pkg (@EXTS) {	3507	for my $pkg (@EXTS) {
2354	warn "... unloading $pkg";	3508	warn "... unloading $pkg";
2355		3509
…		…
2385	Symbol::delete_package "safe::$_"	3539	Symbol::delete_package "safe::$_"
2386	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3540	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2387		3541
2388	warn "unloading cf.pm \"a bit\"";	3542	warn "unloading cf.pm \"a bit\"";
2389	delete $INC{"cf.pm"};	3543	delete $INC{"cf.pm"};
		3544	delete $INC{"cf/pod.pm"};
2390		3545
2391	# don't, removes xs symbols, too,	3546	# don't, removes xs symbols, too,
2392	# and global variables created in xs	3547	# and global variables created in xs
2393	#Symbol::delete_package __PACKAGE__;	3548	#Symbol::delete_package __PACKAGE__;
2394		3549
…		…
2397	warn "reloading cf.pm";	3552	warn "reloading cf.pm";
2398	require cf;	3553	require cf;
2399	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3554	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2400		3555
2401	warn "loading config and database again";	3556	warn "loading config and database again";
2402	cf::cfg_load;	3557	cf::reload_config;
2403	cf::db_load;
2404		3558
2405	warn "loading extensions";	3559	warn "loading extensions";
2406	cf::load_extensions;	3560	cf::load_extensions;
2407		3561
2408	warn "reattaching attachments to objects/players";	3562	warn "reattaching attachments to objects/players";
2409	_global_reattach;	3563	_global_reattach; # objects, sockets
2410	warn "reattaching attachments to maps";	3564	warn "reattaching attachments to maps";
2411	reattach $_ for values %MAP;	3565	reattach $_ for values %MAP;
		3566	warn "reattaching attachments to players";
		3567	reattach $_ for values %PLAYER;
2412		3568
2413	warn "restarting server ticker";	3569	warn "leaving sync_job";
2414		3570
2415	$TICK_WATCHER->start;	3571	1
		3572	} or do {
		3573	warn $@;
		3574	cf::cleanup "error while reloading, exiting.";
2416	};	3575	};
2417
2418	if ($@) {
2419	warn $@;
2420	warn "error while reloading, exiting.";
2421	exit 1;
2422	}
2423		3576
2424	warn "reloaded";	3577	warn "reloaded";
2425	};	3578	};
2426		3579
2427	our $RELOAD_WATCHER; # used only during reload	3580	our $RELOAD_WATCHER; # used only during reload
2428		3581
		3582	sub reload_perl() {
		3583	# doing reload synchronously and two reloads happen back-to-back,
		3584	# coro crashes during coro_state_free->destroy here.
		3585
		3586	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
		3587	do_reload_perl;
		3588	undef $RELOAD_WATCHER;
		3589	};
		3590	}
		3591
2429	register_command "reload" => sub {	3592	register_command "reload" => sub {
2430	my ($who, $arg) = @_;	3593	my ($who, $arg) = @_;
2431		3594
2432	if ($who->flag (FLAG_WIZ)) {	3595	if ($who->flag (FLAG_WIZ)) {
2433	$who->message ("reloading server.");	3596	$who->message ("reloading server.");
2434		3597	async {
2435	# doing reload synchronously and two reloads happen back-to-back,	3598	$Coro::current->{desc} = "perl_reload";
2436	# coro crashes during coro_state_free->destroy here.
2437
2438	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2439	reload;	3599	reload_perl;
2440	undef $RELOAD_WATCHER;
2441	});	3600	};
2442	}	3601	}
2443	};	3602	};
2444		3603
2445	unshift @INC, $LIBDIR;	3604	unshift @INC, $LIBDIR;
2446		3605
2447	my $bug_warning = 0;	3606	my $bug_warning = 0;
2448		3607
2449	$TICK_WATCHER = Event->timer (	3608	our @WAIT_FOR_TICK;
2450	reentrant => 0,	3609	our @WAIT_FOR_TICK_BEGIN;
2451	parked => 1,	3610
2452	prio => 0,	3611	sub wait_for_tick {
2453	at => $NEXT_TICK || $TICK,	3612	return if tick_inhibit;
2454	data => WF_AUTOCANCEL,	3613	return if $Coro::current == $Coro::main;
2455	cb => sub {	3614
		3615	my $signal = new Coro::Signal;
		3616	push @WAIT_FOR_TICK, $signal;
		3617	$signal->wait;
		3618	}
		3619
		3620	sub wait_for_tick_begin {
		3621	return if tick_inhibit;
		3622	return if $Coro::current == $Coro::main;
		3623
		3624	my $signal = new Coro::Signal;
		3625	push @WAIT_FOR_TICK_BEGIN, $signal;
		3626	$signal->wait;
		3627	}
		3628
		3629	sub tick {
2456	if ($Coro::current != $Coro::main) {	3630	if ($Coro::current != $Coro::main) {
2457	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3631	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2458	unless ++$bug_warning > 10;	3632	unless ++$bug_warning > 10;
2459	return;	3633	return;
2460	}	3634	}
2461		3635
2462	$NOW = Event::time;
2463
2464	cf::server_tick; # one server iteration	3636	cf::server_tick; # one server iteration
2465	$RUNTIME += $TICK;
2466	$NEXT_TICK += $TICK;
2467		3637
2468	$WAIT_FOR_TICK->broadcast;	3638	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2469	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3639	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2470		3640	Coro::async_pool {
2471	# if we are delayed by four ticks or more, skip them all	3641	$Coro::current->{desc} = "runtime saver";
2472	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2473
2474	$TICK_WATCHER->at ($NEXT_TICK);
2475	$TICK_WATCHER->start;
2476	},
2477	);
2478
2479	IO::AIO::max_poll_time $TICK * 0.2;
2480
2481	$AIO_POLL_WATCHER = Event->io (
2482	fd => IO::AIO::poll_fileno,
2483	poll => 'r',
2484	prio => 5,
2485	data => WF_AUTOCANCEL,
2486	cb => \&IO::AIO::poll_cb,
2487	);
2488
2489	$WRITE_RUNTIME_WATCHER = Event->timer (
2490	data => WF_AUTOCANCEL,
2491	after => 1,
2492	interval => 10,
2493	prio => 6, # keep it lowest so it acts like a watchdog
2494	cb => Coro::unblock_sub {
2495	write_runtime	3642	write_runtime
2496	or warn "ERROR: unable to write runtime file: $!";	3643	or warn "ERROR: unable to write runtime file: $!";
		3644	};
2497	},	3645	}
2498	);	3646
		3647	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3648	$sig->send;
		3649	}
		3650	while (my $sig = shift @WAIT_FOR_TICK) {
		3651	$sig->send;
		3652	}
		3653
		3654	$LOAD = ($NOW - $TICK_START) / $TICK;
		3655	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3656
		3657	if (0) {
		3658	if ($NEXT_TICK) {
		3659	my $jitter = $TICK_START - $NEXT_TICK;
		3660	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3661	warn "jitter $JITTER\n";#d#
		3662	}
		3663	}
		3664	}
		3665
		3666	{
		3667	# configure BDB
		3668
		3669	BDB::min_parallel 8;
		3670	BDB::max_poll_reqs $TICK * 0.1;
		3671	$Coro::BDB::WATCHER->priority (1);
		3672
		3673	unless ($DB_ENV) {
		3674	$DB_ENV = BDB::db_env_create;
		3675	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3676	| BDB::LOG_AUTOREMOVE, 1);
		3677	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3678	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3679
		3680	cf::sync_job {
		3681	eval {
		3682	BDB::db_env_open
		3683	$DB_ENV,
		3684	$BDBDIR,
		3685	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3686	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3687	0666;
		3688
		3689	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3690	};
		3691
		3692	cf::cleanup "db_env_open(db): $@" if $@;
		3693	};
		3694	}
		3695
		3696	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3697	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3698	};
		3699	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3700	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3701	};
		3702	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3703	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3704	};
		3705	}
		3706
		3707	{
		3708	# configure IO::AIO
		3709
		3710	IO::AIO::min_parallel 8;
		3711	IO::AIO::max_poll_time $TICK * 0.1;
		3712	$Coro::AIO::WATCHER->priority (1);
		3713	}
		3714
		3715	my $_log_backtrace;
		3716
		3717	sub _log_backtrace {
		3718	my ($msg, @addr) = @_;
		3719
		3720	$msg =~ s/\n//;
		3721
		3722	# limit the # of concurrent backtraces
		3723	if ($_log_backtrace < 2) {
		3724	++$_log_backtrace;
		3725	async {
		3726	$Coro::current->{desc} = "abt $msg";
		3727
		3728	my @bt = fork_call {
		3729	@addr = map { sprintf "%x", $_ } @addr;
		3730	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3731	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3732	or die "addr2line: $!";
		3733
		3734	my @funcs;
		3735	my @res = <$fh>;
		3736	chomp for @res;
		3737	while (@res) {
		3738	my ($func, $line) = splice @res, 0, 2, ();
		3739	push @funcs, "[$func] $line";
		3740	}
		3741
		3742	@funcs
		3743	};
		3744
		3745	LOG llevInfo, "[ABT] $msg\n";
		3746	LOG llevInfo, "[ABT] $_\n" for @bt;
		3747	--$_log_backtrace;
		3748	};
		3749	} else {
		3750	LOG llevInfo, "[ABT] $msg\n";
		3751	LOG llevInfo, "[ABT] [suppressed]\n";
		3752	}
		3753	}
		3754
		3755	# load additional modules
		3756	use cf::pod;
2499		3757
2500	END { cf::emergency_save }	3758	END { cf::emergency_save }
2501		3759
2502	1	3760	1
2503		3761

Diff Legend

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