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.199 by root, Mon Jan 29 14:46:01 2007 UTC vs.
Revision 1.414 by root, Thu Apr 10 09:10:45 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.5 ();	36	use Coro 4.50 ();
		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;
87		138
88	sub cf::map::normalise;	139	sub cf::map::normalise;
89		140
…		…
100	=item $cf::RUNTIME	151	=item $cf::RUNTIME
101		152
102	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
103	every server tick.	154	every server tick.
104		155
105	=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
106		159
107	The perl library directory, where extensions and cf-specific modules can	160	Various directories - "/etc", read-only install directory, perl-library
108	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.
109		164
110	=item $cf::NOW	165	=item $cf::NOW
111		166
112	The time of the last (current) server tick.	167	The time of the last (current) server tick.
113		168
114	=item $cf::TICK	169	=item $cf::TICK
115		170
116	The interval between server ticks, in seconds.	171	The interval between server ticks, in seconds.
117		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
118	=item %cf::CFG	183	=item %cf::CFG
119		184
120	Configuration for the server, loaded from C</etc/crossfire/config>, or	185	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
121	from wherever your confdir points to.	186	from wherever your confdir points to.
122		187
123	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	188	=item cf::wait_for_tick, cf::wait_for_tick_begin
124		189
125	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
126	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
127	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.
128	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.
129		199
130	=back	200	=back
131		201
132	=cut	202	=cut
133		203
134	BEGIN {	204	BEGIN {
135	*CORE::GLOBAL::warn = sub {	205	*CORE::GLOBAL::warn = sub {
136	my $msg = join "", @_;	206	my $msg = join "", @_;
137	utf8::encode $msg;
138		207
139	$msg .= "\n"	208	$msg .= "\n"
140	unless $msg =~ /\n$/;	209	unless $msg =~ /\n$/;
141		210
		211	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		212
142	LOG llevError, $msg;	213	LOG llevError, $msg;
143	};	214	};
144	}	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#?
145		231
146	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	232	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
147	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	233	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
148	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	234	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
149	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	235	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
150	@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';
151	@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)
152		239
153	# 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
154	# within the Safe compartment.	241	# within the Safe compartment.
155	for my $pkg (qw(	242	for my $pkg (qw(
156	cf::global cf::attachable	243	cf::global cf::attachable
…		…
161	)) {	248	)) {
162	no strict 'refs';	249	no strict 'refs';
163	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	250	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
164	}	251	}
165		252
166	$Event::DIED = sub {	253	$EV::DIED = sub {
167	warn "error in event callback: @_";	254	warn "error in event callback: @_";
168	};	255	};
		256
		257	#############################################################################
169		258
170	=head2 UTILITY FUNCTIONS	259	=head2 UTILITY FUNCTIONS
171		260
172	=over 4	261	=over 4
173		262
…		…
192	$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;
193	$d	282	$d
194	} || "[unable to dump $_[0]: '$@']";	283	} || "[unable to dump $_[0]: '$@']";
195	}	284	}
196		285
197	use JSON::Syck (); # TODO# replace by JSON::PC once working
198
199	=item $ref = cf::from_json $json	286	=item $ref = cf::decode_json $json
200		287
201	Converts a JSON string into the corresponding perl data structure.	288	Converts a JSON string into the corresponding perl data structure.
202		289
203	=cut
204
205	sub from_json($) {
206	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
207	JSON::Syck::Load $_[0]
208	}
209
210	=item $json = cf::to_json $ref	290	=item $json = cf::encode_json $ref
211		291
212	Converts a perl data structure into its JSON representation.	292	Converts a perl data structure into its JSON representation.
213		293
214	=cut	294	=cut
215		295
216	sub to_json($) {	296	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
217	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	297
218	JSON::Syck::Dump $_[0]	298	sub encode_json($) { $json_coder->encode ($_[0]) }
219	}	299	sub decode_json($) { $json_coder->decode ($_[0]) }
220		300
221	=item cf::lock_wait $string	301	=item cf::lock_wait $string
222		302
223	Wait until the given lock is available. See cf::lock_acquire.	303	Wait until the given lock is available. See cf::lock_acquire.
224		304
…		…
227	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
228	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,
229	for example when the coroutine gets canceled), the lock is automatically	309	for example when the coroutine gets canceled), the lock is automatically
230	returned.	310	returned.
231		311
		312	Locks are *not* recursive, locking from the same coro twice results in a
		313	deadlocked coro.
		314
232	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
233	uses map_find and cf::map::load uses map_load).	316	uses map_find and cf::map::load uses map_load).
234		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
235	=cut	322	=cut
236		323
237	our %LOCK;	324	our %LOCK;
		325	our %LOCKER;#d#
238		326
239	sub lock_wait($) {	327	sub lock_wait($) {
240	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#
241		334
242	# wait for lock, if any	335	# wait for lock, if any
243	while ($LOCK{$key}) {	336	while ($LOCK{$key}) {
244	push @{ $LOCK{$key} }, $Coro::current;	337	push @{ $LOCK{$key} }, $Coro::current;
245	Coro::schedule;	338	Coro::schedule;
…		…
251		344
252	# wait, to be sure we are not locked	345	# wait, to be sure we are not locked
253	lock_wait $key;	346	lock_wait $key;
254		347
255	$LOCK{$key} = [];	348	$LOCK{$key} = [];
		349	$LOCKER{$key} = $Coro::current;#d#
256		350
257	Coro::guard {	351	Coro::guard {
		352	delete $LOCKER{$key};#d#
258	# wake up all waiters, to be on the safe side	353	# wake up all waiters, to be on the safe side
259	$_->ready for @{ delete $LOCK{$key} };	354	$_->ready for @{ delete $LOCK{$key} };
260	}	355	}
261	}	356	}
262		357
		358	sub lock_active($) {
		359	my ($key) = @_;
		360
		361	! ! $LOCK{$key}
		362	}
		363
263	sub freeze_mainloop {	364	sub freeze_mainloop {
264	return unless $TICK_WATCHER->is_active;	365	tick_inhibit_inc;
265		366
266	my $guard = Coro::guard {	367	Coro::guard \&tick_inhibit_dec;
267	$TICK_WATCHER->start;	368	}
268	$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	}
269	};	428	}
270	$WRITE_RUNTIME_WATCHER->stop;	429	};
271	$TICK_WATCHER->stop;	430
272	$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;
273	}	441	}
274		442
275	=item cf::async { BLOCK }	443	=item cf::async { BLOCK }
276		444
277	Currently the same as Coro::async_pool, meaning you cannot use	445	Currently the same as Coro::async_pool, meaning you cannot use
…		…
282		450
283	BEGIN { *async = \&Coro::async_pool }	451	BEGIN { *async = \&Coro::async_pool }
284		452
285	=item cf::sync_job { BLOCK }	453	=item cf::sync_job { BLOCK }
286		454
287	The design of crossfire+ requires that the main coro ($Coro::main) is	455	The design of Deliantra requires that the main coroutine ($Coro::main)
288	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
289	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.
290		459
291	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
292	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
293	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
294	fast or be very important.	463	fast or be very important.
…		…
297		466
298	sub sync_job(&) {	467	sub sync_job(&) {
299	my ($job) = @_;	468	my ($job) = @_;
300		469
301	if ($Coro::current == $Coro::main) {	470	if ($Coro::current == $Coro::main) {
		471	my $time = EV::time;
		472
302	# this is the main coro, too bad, we have to block	473	# this is the main coro, too bad, we have to block
303	# till the operation succeeds, freezing the server :/	474	# till the operation succeeds, freezing the server :/
304		475
305	# TODO: use suspend/resume instead	476	LOG llevError, Carp::longmess "sync job";#d#
306	# (but this is cancel-safe)	477
307	my $freeze_guard = freeze_mainloop;	478	my $freeze_guard = freeze_mainloop;
308		479
309	my $busy = 1;	480	my $busy = 1;
310	my @res;	481	my @res;
311		482
312	(async {	483	(async {
		484	$Coro::current->desc ("sync job coro");
313	@res = eval { $job->() };	485	@res = eval { $job->() };
314	warn $@ if $@;	486	warn $@ if $@;
315	undef $busy;	487	undef $busy;
316	})->prio (Coro::PRIO_MAX);	488	})->prio (Coro::PRIO_MAX);
317		489
318	while ($busy) {	490	while ($busy) {
319	Coro::cede or Event::one_event;	491	if (Coro::nready) {
		492	Coro::cede_notself;
		493	} else {
		494	EV::loop EV::LOOP_ONESHOT;
320	}	495	}
		496	}
		497
		498	my $time = EV::time - $time;
		499
		500	$TICK_START += $time; # do not account sync jobs to server load
321		501
322	wantarray ? @res : $res[0]	502	wantarray ? @res : $res[0]
323	} else {	503	} else {
324	# we are in another coroutine, how wonderful, everything just works	504	# we are in another coroutine, how wonderful, everything just works
325		505
…		…
345	$EXT_CORO{$coro+0} = $coro;	525	$EXT_CORO{$coro+0} = $coro;
346		526
347	$coro	527	$coro
348	}	528	}
349		529
350	sub write_runtime {	530	=item fork_call { }, $args
351	my $runtime = cf::localdir . "/runtime";
352		531
353	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	532	Executes the given code block with the given arguments in a seperate
354	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.
355		536
356	my $value = $cf::RUNTIME + 90 + 10;	537	=cut
357	# 10 is the runtime save interval, for a monotonic clock
358	# 60 allows for the watchdog to kill the server.
359		538
360	(aio_write $fh, 0, (length $value), $value, 0) <= 0	539	sub fork_call(&@) {
361	and return;	540	my ($cb, @args) = @_;
362		541
363	aio_fsync $fh	542	# we seemingly have to make a local copy of the whole thing,
364	and return;	543	# otherwise perl prematurely frees the stuff :/
		544	# TODO: investigate and fix (likely this will be rather laborious)
365		545
366	close $fh	546	my @res = Coro::Util::fork_eval {
367	or return;	547	reset_signals;
		548	&$cb
		549	}, @args;
368		550
369	aio_rename "$runtime~", $runtime	551	wantarray ? @res : $res[-1]
370	and return;	552	}
371		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
372	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 });
373	}	690	}
374		691
375	=back	692	=back
376		693
377	=cut	694	=cut
…		…
384	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")
385	to it. All such attachable objects support the following methods.	702	to it. All such attachable objects support the following methods.
386		703
387	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>
388	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
389	crossfire+).	706	Deliantra).
390		707
391	=over 4	708	=over 4
392		709
393	=item $attachable->attach ($attachment, key => $value...)	710	=item $attachable->attach ($attachment, key => $value...)
394		711
…		…
557	$registry = $CB_TYPE[$object_type] ||= [];	874	$registry = $CB_TYPE[$object_type] ||= [];
558		875
559	} elsif ($type eq "subtype") {	876	} elsif ($type eq "subtype") {
560	defined $object_type or Carp::croak "subtype specified without type";	877	defined $object_type or Carp::croak "subtype specified without type";
561	my $object_subtype = shift @arg;	878	my $object_subtype = shift @arg;
562	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	879	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
563		880
564	} elsif ($type eq "package") {	881	} elsif ($type eq "package") {
565	my $pkg = shift @arg;	882	my $pkg = shift @arg;
566		883
567	while (my ($name, $id) = each %cb_id) {	884	while (my ($name, $id) = each %cb_id) {
…		…
596	_attach $registry, $klass, @attach;	913	_attach $registry, $klass, @attach;
597	}	914	}
598		915
599	$obj->{$name} = \%arg;	916	$obj->{$name} = \%arg;
600	} else {	917	} else {
601	warn "object uses attachment '$name' that is not available, postponing.\n";	918	warn "object uses attachment '$name' which is not available, postponing.\n";
602	}	919	}
603		920
604	$obj->{_attachment}{$name} = undef;	921	$obj->{_attachment}{$name} = undef;
605	}	922	}
606		923
…		…
608	if (ref $_[0]) {	925	if (ref $_[0]) {
609	_object_attach @_;	926	_object_attach @_;
610	} else {	927	} else {
611	_attach shift->_attach_registry, @_;	928	_attach shift->_attach_registry, @_;
612	}	929	}
		930	_recalc_want;
613	};	931	};
614		932
615	# all those should be optimised	933	# all those should be optimised
616	sub cf::attachable::detach {	934	sub cf::attachable::detach {
617	my ($obj, $name) = @_;	935	my ($obj, $name) = @_;
…		…
620	delete $obj->{_attachment}{$name};	938	delete $obj->{_attachment}{$name};
621	reattach ($obj);	939	reattach ($obj);
622	} else {	940	} else {
623	Carp::croak "cannot, currently, detach class attachments";	941	Carp::croak "cannot, currently, detach class attachments";
624	}	942	}
		943	_recalc_want;
625	};	944	};
626		945
627	sub cf::attachable::attached {	946	sub cf::attachable::attached {
628	my ($obj, $name) = @_;	947	my ($obj, $name) = @_;
629		948
…		…
644	";	963	";
645	die if $@;	964	die if $@;
646	}	965	}
647		966
648	our $override;	967	our $override;
649	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?
650		969
651	sub override {	970	sub override {
652	$override = 1;	971	$override = 1;
653	@invoke_results = ();	972	@INVOKE_RESULTS = (@_);
654	}	973	}
655		974
656	sub do_invoke {	975	sub do_invoke {
657	my $event = shift;	976	my $event = shift;
658	my $callbacks = shift;	977	my $callbacks = shift;
659		978
660	@invoke_results = ();	979	@INVOKE_RESULTS = ();
661		980
662	local $override;	981	local $override;
663		982
664	for (@$callbacks) {	983	for (@$callbacks) {
665	eval { &{$_->[1]} };	984	eval { &{$_->[1]} };
…		…
674	}	993	}
675		994
676	0	995	0
677	}	996	}
678		997
679	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	998	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
680		999
681	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1000	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
682		1001
683	Generate an object-specific event with the given arguments.	1002	Generate an object-specific event with the given arguments.
684		1003
685	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
686	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
687	results (if you must, access C<@cf::invoke_results> directly).	1006	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
688		1007
689	=back	1008	=back
690		1009
691	=cut	1010	=cut
692		1011
693	#############################################################################	1012	#############################################################################
694	# 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	}
695		1056
696	sub reattach {	1057	sub reattach {
697	# basically do the same as instantiate, without calling instantiate	1058	# basically do the same as instantiate, without calling instantiate
698	my ($obj) = @_;	1059	my ($obj) = @_;
699		1060
…		…
720	cf::attachable->attach (	1081	cf::attachable->attach (
721	prio => -1000000,	1082	prio => -1000000,
722	on_instantiate => sub {	1083	on_instantiate => sub {
723	my ($obj, $data) = @_;	1084	my ($obj, $data) = @_;
724		1085
725	$data = from_json $data;	1086	$data = decode_json $data;
726		1087
727	for (@$data) {	1088	for (@$data) {
728	my ($name, $args) = @$_;	1089	my ($name, $args) = @$_;
729		1090
730	$obj->attach ($name, %{$args || {} });	1091	$obj->attach ($name, %{$args || {} });
…		…
746	sub object_freezer_save {	1107	sub object_freezer_save {
747	my ($filename, $rdata, $objs) = @_;	1108	my ($filename, $rdata, $objs) = @_;
748		1109
749	sync_job {	1110	sync_job {
750	if (length $$rdata) {	1111	if (length $$rdata) {
		1112	utf8::decode (my $decname = $filename);
751	warn sprintf "saving %s (%d,%d)\n",	1113	warn sprintf "saving %s (%d,%d)\n",
752	$filename, length $$rdata, scalar @$objs;	1114	$decname, length $$rdata, scalar @$objs;
753		1115
754	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1116	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
755	chmod SAVE_MODE, $fh;	1117	chmod SAVE_MODE, $fh;
756	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1118	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
757	aio_fsync $fh;	1119	aio_fsync $fh if $cf::USE_FSYNC;
758	close $fh;	1120	close $fh;
759		1121
760	if (@$objs) {	1122	if (@$objs) {
761	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) {
762	chmod SAVE_MODE, $fh;	1124	chmod SAVE_MODE, $fh;
763	my $data = Storable::nfreeze { version => 1, objs => $objs };	1125	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
764	aio_write $fh, 0, (length $data), $data, 0;	1126	aio_write $fh, 0, (length $data), $data, 0;
765	aio_fsync $fh;	1127	aio_fsync $fh if $cf::USE_FSYNC;
766	close $fh;	1128	close $fh;
767	aio_rename "$filename.pst~", "$filename.pst";	1129	aio_rename "$filename.pst~", "$filename.pst";
768	}	1130	}
769	} else {	1131	} else {
770	aio_unlink "$filename.pst";	1132	aio_unlink "$filename.pst";
…		…
776	}	1138	}
777	} else {	1139	} else {
778	aio_unlink $filename;	1140	aio_unlink $filename;
779	aio_unlink "$filename.pst";	1141	aio_unlink "$filename.pst";
780	}	1142	}
781	}	1143	};
782	}	1144	}
783		1145
784	sub object_freezer_as_string {	1146	sub object_freezer_as_string {
785	my ($rdata, $objs) = @_;	1147	my ($rdata, $objs) = @_;
786		1148
…		…
798	or return;	1160	or return;
799		1161
800	unless (aio_stat "$filename.pst") {	1162	unless (aio_stat "$filename.pst") {
801	(aio_load "$filename.pst", $av) >= 0	1163	(aio_load "$filename.pst", $av) >= 0
802	or return;	1164	or return;
		1165
803	$av = eval { (Storable::thaw $av)->{objs} };	1166	my $st = eval { Coro::Storable::thaw $av };
		1167	$av = $st->{objs};
804	}	1168	}
805		1169
		1170	utf8::decode (my $decname = $filename);
806	warn sprintf "loading %s (%d)\n",	1171	warn sprintf "loading %s (%d,%d)\n",
807	$filename, length $data, scalar @{$av || []};#d#	1172	$decname, length $data, scalar @{$av || []};
		1173
808	return ($data, $av);	1174	($data, $av)
809	}	1175	}
		1176
		1177	=head2 COMMAND CALLBACKS
		1178
		1179	=over 4
		1180
		1181	=cut
810		1182
811	#############################################################################	1183	#############################################################################
812	# command handling &c	1184	# command handling &c
813		1185
814	=item cf::register_command $name => \&callback($ob,$args);	1186	=item cf::register_command $name => \&callback($ob,$args);
…		…
827	push @{ $COMMAND{$name} }, [$caller, $cb];	1199	push @{ $COMMAND{$name} }, [$caller, $cb];
828	}	1200	}
829		1201
830	=item cf::register_extcmd $name => \&callback($pl,$packet);	1202	=item cf::register_extcmd $name => \&callback($pl,$packet);
831		1203
832	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.
833		1209
834	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
835	called.	1211	called.
836		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
837	=cut	1224	=cut
838		1225
839	sub register_extcmd {	1226	sub register_extcmd {
840	my ($name, $cb) = @_;	1227	my ($name, $cb) = @_;
841		1228
842	$EXTCMD{$name} = $cb;	1229	$EXTCMD{$name} = $cb;
		1230	}
		1231
		1232	sub register_exticmd {
		1233	my ($name, $cb) = @_;
		1234
		1235	$EXTICMD{$name} = $cb;
843	}	1236	}
844		1237
845	cf::player->attach (	1238	cf::player->attach (
846	on_command => sub {	1239	on_command => sub {
847	my ($pl, $name, $params) = @_;	1240	my ($pl, $name, $params) = @_;
…		…
856	cf::override;	1249	cf::override;
857	},	1250	},
858	on_extcmd => sub {	1251	on_extcmd => sub {
859	my ($pl, $buf) = @_;	1252	my ($pl, $buf) = @_;
860		1253
861	my $msg = eval { from_json $buf };	1254	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
862		1255
863	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
864	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1264	if (my $cb = $EXTCMD{$type}) {
865	if (my %reply = $cb->($pl, $msg)) {	1265	@reply = $cb->($pl, @payload);
866	$pl->ext_reply ($msg->{msgid}, %reply);
867	}
868	}	1266	}
		1267
		1268	$pl->ext_reply ($reply, @reply)
		1269	if $reply;
		1270
869	} else {	1271	} else {
870	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1272	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
871	}	1273	}
872		1274
873	cf::override;	1275	cf::override;
874	},	1276	},
875	);	1277	);
876		1278
877	sub load_extension {
878	my ($path) = @_;
879
880	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
881	my $base = $1;
882	my $pkg = $1;
883	$pkg =~ s/[^[:word:]]/_/g;
884	$pkg = "ext::$pkg";
885
886	warn "... loading '$path' into '$pkg'\n";
887
888	open my $fh, "<:utf8", $path
889	or die "$path: $!";
890
891	my $source =
892	"package $pkg; use strict; use utf8;\n"
893	. "#line 1 \"$path\"\n{\n"
894	. (do { local $/; <$fh> })
895	. "\n};\n1";
896
897	unless (eval $source) {
898	my $msg = $@ ? "$path: $@\n"
899	: "extension disabled.\n";
900	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
901	warn $@;
902	warn "mandatory extension failed to load, exiting.\n";
903	exit 1;
904	}
905	die $@;
906	}
907
908	push @EXTS, $pkg;
909	}
910
911	sub load_extensions {	1279	sub load_extensions {
		1280	cf::sync_job {
		1281	my %todo;
		1282
912	for my $ext (<$LIBDIR/*.ext>) {	1283	for my $path (<$LIBDIR/*.ext>) {
913	next unless -r $ext;	1284	next unless -r $path;
914	eval {	1285
915	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;
916	1	1342	}
917	} or warn "$ext not loaded: $@";	1343
		1344	skip:
		1345	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1346	unless $progress;
		1347	}
918	}	1348	};
919	}	1349	}
920		1350
921	#############################################################################	1351	#############################################################################
922		1352
		1353	=back
		1354
923	=head2 CORE EXTENSIONS	1355	=head2 CORE EXTENSIONS
924		1356
925	Functions and methods that extend core crossfire objects.	1357	Functions and methods that extend core crossfire objects.
926		1358
927	=cut	1359	=cut
…		…
932		1364
933	=head3 cf::player	1365	=head3 cf::player
934		1366
935	=over 4	1367	=over 4
936		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
937	=item cf::player::find $login	1383	=item cf::player::find $login
938		1384
939	Returns the given player object, loading it if necessary (might block).	1385	Returns the given player object, loading it if necessary (might block).
940		1386
941	=cut	1387	=cut
942		1388
943	sub playerdir($) {	1389	sub playerdir($) {
944	cf::localdir	1390	"$PLAYERDIR/"
945	. "/"
946	. cf::playerdir
947	. "/"
948	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1391	. (ref $_[0] ? $_[0]->ob->name : $_[0])
949	}	1392	}
950		1393
951	sub path($) {	1394	sub path($) {
952	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1395	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
953		1396
954	(playerdir $login) . "/$login.pl"	1397	(playerdir $login) . "/playerdata"
955	}	1398	}
956		1399
957	sub find_active($) {	1400	sub find_active($) {
958	$cf::PLAYER{$_[0]}	1401	$cf::PLAYER{$_[0]}
959	and $cf::PLAYER{$_[0]}->active	1402	and $cf::PLAYER{$_[0]}->active
…		…
972	my $login = $_[0];	1415	my $login = $_[0];
973		1416
974	my $guard = cf::lock_acquire "user_find:$login";	1417	my $guard = cf::lock_acquire "user_find:$login";
975		1418
976	$cf::PLAYER{$_[0]} || do {	1419	$cf::PLAYER{$_[0]} || do {
977	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
978	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;
979	$cf::PLAYER{$login} = $pl	1434	$cf::PLAYER{$login} = $pl
980	}	1435	}
981	}	1436	}
982	}	1437	}
983		1438
…		…
993		1448
994	aio_mkdir playerdir $pl, 0770;	1449	aio_mkdir playerdir $pl, 0770;
995	$pl->{last_save} = $cf::RUNTIME;	1450	$pl->{last_save} = $cf::RUNTIME;
996		1451
997	$pl->save_pl ($path);	1452	$pl->save_pl ($path);
998	Coro::cede;	1453	cf::cede_to_tick;
999	}	1454	}
1000		1455
1001	sub new($) {	1456	sub new($) {
1002	my ($login) = @_;	1457	my ($login) = @_;
1003		1458
…		…
1009	$cf::PLAYER{$login} = $self;	1464	$cf::PLAYER{$login} = $self;
1010		1465
1011	$self	1466	$self
1012	}	1467	}
1013		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
1014	=item $pl->quit_character	1479	=item $pl->quit_character
1015		1480
1016	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
1017	be destroyed. May block for a long time.	1482	be destroyed. May block for a long time.
1018		1483
1019	=cut	1484	=cut
1020		1485
1021	sub quit_character {	1486	sub quit_character {
1022	my ($pl) = @_;	1487	my ($pl) = @_;
		1488
		1489	my $name = $pl->ob->name;
1023		1490
1024	$pl->{deny_save} = 1;	1491	$pl->{deny_save} = 1;
1025	$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
1026		1493
1027	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1494	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1032	my $path = playerdir $pl;	1499	my $path = playerdir $pl;
1033	my $temp = "$path~$cf::RUNTIME~deleting~";	1500	my $temp = "$path~$cf::RUNTIME~deleting~";
1034	aio_rename $path, $temp;	1501	aio_rename $path, $temp;
1035	delete $cf::PLAYER{$pl->ob->name};	1502	delete $cf::PLAYER{$pl->ob->name};
1036	$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
1037	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;
1038	}	1525	}
1039		1526
1040	=item cf::player::list_logins	1527	=item cf::player::list_logins
1041		1528
1042	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
1043	while and may block, so not sync_job-capable, ever.	1530	while and may block, so not sync_job-capable, ever.
1044		1531
1045	=cut	1532	=cut
1046		1533
1047	sub list_logins {	1534	sub list_logins {
1048	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1535	my $dirs = aio_readdir $PLAYERDIR
1049	or return [];	1536	or return [];
1050		1537
1051	my @logins;	1538	my @logins;
1052		1539
1053	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") {
1054	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1545	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1055	aio_read $fh, 0, 512, my $buf, 0 or next;	1546	aio_read $fh, 0, 512, my $buf, 0 or next;
1056	$buf !~ /^password -------------$/m or next; # official not-valid tag	1547	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1548	}
1057		1549
1058	utf8::decode $login;	1550	utf8::decode $login;
1059	push @logins, $login;	1551	push @logins, $login;
1060	}	1552	}
1061		1553
…		…
1069		1561
1070	=cut	1562	=cut
1071		1563
1072	sub maps($) {	1564	sub maps($) {
1073	my ($pl) = @_;	1565	my ($pl) = @_;
		1566
		1567	$pl = ref $pl ? $pl->ob->name : $pl;
1074		1568
1075	my $files = aio_readdir playerdir $pl	1569	my $files = aio_readdir playerdir $pl
1076	or return;	1570	or return;
1077		1571
1078	my @paths;	1572	my @paths;
…		…
1080	for (@$files) {	1574	for (@$files) {
1081	utf8::decode $_;	1575	utf8::decode $_;
1082	next if /\.(?:pl|pst)$/;	1576	next if /\.(?:pl|pst)$/;
1083	next unless /^$PATH_SEP/o;	1577	next unless /^$PATH_SEP/o;
1084		1578
1085	push @paths, cf::map::normalise "~" . $pl->ob->name . "/" . $_;	1579	push @paths, cf::map::normalise "~$pl/$_";
1086	}	1580	}
1087		1581
1088	\@paths	1582	\@paths
1089	}	1583	}
1090		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
1091	=item $player->ext_reply ($msgid, $msgtype, %msg)	1678	=item $player->ext_reply ($msgid, @msg)
1092		1679
1093	Sends an ext reply to the player.	1680	Sends an ext reply to the player.
1094		1681
1095	=cut	1682	=cut
1096		1683
1097	sub ext_reply($$$%) {	1684	sub ext_reply($$@) {
1098	my ($self, $id, %msg) = @_;	1685	my ($self, $id, @msg) = @_;
1099		1686
1100	$msg{msgid} = $id;	1687	$self->ns->ext_reply ($id, @msg)
1101
1102	$self->send ("ext " . cf::to_json \%msg);
1103	}	1688	}
1104		1689
1105	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	}
1106		1730
1107	=back	1731	=back
1108
1109		1732
1110	=head3 cf::map	1733	=head3 cf::map
1111		1734
1112	=over 4	1735	=over 4
1113		1736
…		…
1168	my ($self, $merge) = @_;	1791	my ($self, $merge) = @_;
1169		1792
1170	# we have to keep some variables in memory intact	1793	# we have to keep some variables in memory intact
1171	local $self->{path};	1794	local $self->{path};
1172	local $self->{load_path};	1795	local $self->{load_path};
1173	local $self->{deny_save};
1174	local $self->{deny_reset};
1175		1796
1176	$self->SUPER::thawer_merge ($merge);	1797	$self->SUPER::thawer_merge ($merge);
1177	}	1798	}
1178		1799
1179	sub normalise {	1800	sub normalise {
…		…
1226	$self->init; # pass $1 etc.	1847	$self->init; # pass $1 etc.
1227	return $self;	1848	return $self;
1228	}	1849	}
1229	}	1850	}
1230		1851
1231	Carp::carp "unable to resolve path '$path' (base '$base').";	1852	Carp::cluck "unable to resolve path '$path' (base '$base').";
1232	()	1853	()
1233	}	1854	}
1234		1855
1235	sub init {	1856	sub init {
1236	my ($self) = @_;	1857	my ($self) = @_;
…		…
1251		1872
1252	# the original (read-only) location	1873	# the original (read-only) location
1253	sub load_path {	1874	sub load_path {
1254	my ($self) = @_;	1875	my ($self) = @_;
1255		1876
1256	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1877	"$MAPDIR/$self->{path}.map"
1257	}	1878	}
1258		1879
1259	# the temporary/swap location	1880	# the temporary/swap location
1260	sub save_path {	1881	sub save_path {
1261	my ($self) = @_;	1882	my ($self) = @_;
1262		1883
1263	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1884	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1264	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1885	"$TMPDIR/$path.map"
1265	}	1886	}
1266		1887
1267	# the unique path, undef == no special unique path	1888	# the unique path, undef == no special unique path
1268	sub uniq_path {	1889	sub uniq_path {
1269	my ($self) = @_;	1890	my ($self) = @_;
1270		1891
1271	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1892	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1272	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1893	"$UNIQUEDIR/$path"
1273	}	1894	}
1274		1895
1275	# and all this just because we cannot iterate over	1896	# and all this just because we cannot iterate over
1276	# all maps in C++...	1897	# all maps in C++...
1277	sub change_all_map_light {	1898	sub change_all_map_light {
…		…
1279		1900
1280	$_->change_map_light ($change)	1901	$_->change_map_light ($change)
1281	for grep $_->outdoor, values %cf::MAP;	1902	for grep $_->outdoor, values %cf::MAP;
1282	}	1903	}
1283		1904
		1905	sub decay_objects {
		1906	my ($self) = @_;
		1907
		1908	return if $self->{deny_reset};
		1909
		1910	$self->do_decay_objects;
		1911	}
		1912
1284	sub unlink_save {	1913	sub unlink_save {
1285	my ($self) = @_;	1914	my ($self) = @_;
1286		1915
1287	utf8::encode (my $save = $self->save_path);	1916	utf8::encode (my $save = $self->save_path);
1288	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1917	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1291		1920
1292	sub load_header_from($) {	1921	sub load_header_from($) {
1293	my ($self, $path) = @_;	1922	my ($self, $path) = @_;
1294		1923
1295	utf8::encode $path;	1924	utf8::encode $path;
1296	aio_open $path, O_RDONLY, 0	1925	my $f = new_from_file cf::object::thawer $path
1297	or return;	1926	or return;
1298		1927
1299	$self->_load_header ($path)	1928	$self->_load_header ($f)
1300	or return;	1929	or return;
		1930
		1931	local $MAP_LOADING{$self->{path}} = $self;
		1932	$f->resolve_delayed_derefs;
1301		1933
1302	$self->{load_path} = $path;	1934	$self->{load_path} = $path;
1303		1935
1304	1	1936	1
1305	}	1937	}
…		…
1344	$self->load_header_orig	1976	$self->load_header_orig
1345	or return;	1977	or return;
1346	$self->prepare_orig;	1978	$self->prepare_orig;
1347	}	1979	}
1348		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;
		1986
1349	1	1987	1
1350	}	1988	}
1351		1989
1352	sub find;	1990	sub find;
1353	sub find {	1991	sub find {
1354	my ($path, $origin) = @_;	1992	my ($path, $origin) = @_;
1355		1993
1356	$path = normalise $path, $origin && $origin->path;	1994	$path = normalise $path, $origin && $origin->path;
1357		1995
		1996	cf::lock_wait "map_data:$path";#d#remove
1358	cf::lock_wait "map_find:$path";	1997	cf::lock_wait "map_find:$path";
1359		1998
1360	$cf::MAP{$path} || do {	1999	$cf::MAP{$path} || do {
1361	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
1362	my $map = new_from_path cf::map $path	2003	my $map = new_from_path cf::map $path
1363	or return;	2004	or return;
1364		2005
1365	$map->{last_save} = $cf::RUNTIME;	2006	$map->{last_save} = $cf::RUNTIME;
1366		2007
1367	$map->load_header	2008	$map->load_header
1368	or return;	2009	or return;
1369		2010
1370	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	2011	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1371	# doing this can freeze the server in a sync job, obviously	2012	# doing this can freeze the server in a sync job, obviously
1372	#$cf::WAIT_FOR_TICK->wait;	2013	#$cf::WAIT_FOR_TICK->wait;
		2014	undef $guard1;
		2015	undef $guard2;
1373	$map->reset;	2016	$map->reset;
1374	undef $guard;
1375	return find $path;	2017	return find $path;
1376	}	2018	}
1377		2019
1378	$cf::MAP{$path} = $map	2020	$cf::MAP{$path} = $map
1379	}	2021	}
…		…
1386	my ($self) = @_;	2028	my ($self) = @_;
1387		2029
1388	local $self->{deny_reset} = 1; # loading can take a long time	2030	local $self->{deny_reset} = 1; # loading can take a long time
1389		2031
1390	my $path = $self->{path};	2032	my $path = $self->{path};
		2033
		2034	{
1391	my $guard = cf::lock_acquire "map_load:$path";	2035	my $guard = cf::lock_acquire "map_data:$path";
1392		2036
		2037	return unless $self->valid;
1393	return if $self->in_memory != cf::MAP_SWAPPED;	2038	return unless $self->in_memory == cf::MAP_SWAPPED;
1394		2039
1395	$self->in_memory (cf::MAP_LOADING);	2040	$self->in_memory (cf::MAP_LOADING);
1396		2041
1397	$self->alloc;	2042	$self->alloc;
1398		2043
1399	$self->pre_load;	2044	$self->pre_load;
		2045	cf::cede_to_tick;
1400		2046
1401	$self->_load_objects ($self->{load_path}, 1)	2047	my $f = new_from_file cf::object::thawer $self->{load_path};
		2048	$f->skip_block;
		2049	$self->_load_objects ($f)
1402	or return;	2050	or return;
1403		2051
1404	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2052	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1405	if delete $self->{load_original};	2053	if delete $self->{load_original};
1406		2054
1407	if (my $uniq = $self->uniq_path) {	2055	if (my $uniq = $self->uniq_path) {
1408	utf8::encode $uniq;	2056	utf8::encode $uniq;
1409	if (aio_open $uniq, O_RDONLY, 0) {	2057	unless (aio_stat $uniq) {
		2058	if (my $f = new_from_file cf::object::thawer $uniq) {
1410	$self->clear_unique_items;	2059	$self->clear_unique_items;
1411	$self->_load_objects ($uniq, 0);	2060	$self->_load_objects ($f);
		2061	$f->resolve_delayed_derefs;
		2062	}
1412	}	2063	}
1413	}	2064	}
1414		2065
1415	Coro::cede;	2066	$f->resolve_delayed_derefs;
1416		2067
		2068	cf::cede_to_tick;
1417	# now do the right thing for maps	2069	# now do the right thing for maps
1418	$self->link_multipart_objects;	2070	$self->link_multipart_objects;
1419
1420	unless ($self->{deny_activate}) {
1421	$self->decay_objects;
1422	$self->fix_auto_apply;
1423	$self->update_buttons;
1424	Coro::cede;
1425	$self->set_darkness_map;
1426	$self->difficulty ($self->estimate_difficulty)	2071	$self->difficulty ($self->estimate_difficulty)
1427	unless $self->difficulty;	2072	unless $self->difficulty;
1428	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;
1429	$self->activate;	2082	$self->activate;
		2083	}
		2084
		2085	$self->{last_save} = $cf::RUNTIME;
		2086	$self->last_access ($cf::RUNTIME);
		2087
		2088	$self->in_memory (cf::MAP_IN_MEMORY);
1430	}	2089	}
1431		2090
1432	$self->post_load;	2091	$self->post_load;
1433
1434	$self->in_memory (cf::MAP_IN_MEMORY);
1435	}	2092	}
1436		2093
1437	sub customise_for {	2094	sub customise_for {
1438	my ($self, $ob) = @_;	2095	my ($self, $ob) = @_;
1439		2096
1440	return find "~" . $ob->name . "/" . $self->{path}	2097	return find "~" . $ob->name . "/" . $self->{path}
1441	if $self->per_player;	2098	if $self->per_player;
1442		2099
		2100	# return find "?party/" . $ob->name . "/" . $self->{path}
		2101	# if $self->per_party;
		2102
1443	$self	2103	$self
1444	}	2104	}
1445		2105
1446	# 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
1447	sub load_diag {	2107	sub load_neighbours {
1448	my ($map) = @_;	2108	my ($map) = @_;
1449		2109
1450	my @diag; # diagonal neighbours	2110	my @neigh; # diagonal neighbours
1451		2111
1452	for (0 .. 3) {	2112	for (0 .. 3) {
1453	my $neigh = $map->tile_path ($_)	2113	my $neigh = $map->tile_path ($_)
1454	or next;	2114	or next;
1455	$neigh = find $neigh, $map	2115	$neigh = find $neigh, $map
1456	or next;	2116	or next;
1457	$neigh->load;	2117	$neigh->load;
1458		2118
		2119	push @neigh,
1459	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2120	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1460	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2121	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1461	}	2122	}
1462		2123
1463	for (@diag) {	2124	for (grep defined $_->[0], @neigh) {
		2125	my ($path, $origin) = @$_;
1464	my $neigh = find @$_	2126	my $neigh = find $path, $origin
1465	or next;	2127	or next;
1466	$neigh->load;	2128	$neigh->load;
1467	}	2129	}
1468	}	2130	}
1469		2131
…		…
1474	}	2136	}
1475		2137
1476	sub do_load_sync {	2138	sub do_load_sync {
1477	my ($map) = @_;	2139	my ($map) = @_;
1478		2140
		2141	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2142	if $Coro::current == $Coro::main;
		2143
1479	cf::sync_job { $map->load };	2144	cf::sync_job { $map->load };
1480	}	2145	}
1481		2146
1482	our %MAP_PREFETCH;	2147	our %MAP_PREFETCH;
1483	our $MAP_PREFETCHER = undef;	2148	our $MAP_PREFETCHER = undef;
1484		2149
1485	sub find_async {	2150	sub find_async {
1486	my ($path, $origin) = @_;	2151	my ($path, $origin, $load) = @_;
1487		2152
1488	$path = normalise $path, $origin && $origin->{path};	2153	$path = normalise $path, $origin && $origin->{path};
1489		2154
1490	if (my $map = $cf::MAP{$path}) {	2155	if (my $map = $cf::MAP{$path}) {
1491	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2156	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1492	}	2157	}
1493		2158
1494	undef $MAP_PREFETCH{$path};	2159	$MAP_PREFETCH{$path} |= $load;
		2160
1495	$MAP_PREFETCHER ||= cf::async {	2161	$MAP_PREFETCHER ||= cf::async {
		2162	$Coro::current->{desc} = "map prefetcher";
		2163
1496	while (%MAP_PREFETCH) {	2164	while (%MAP_PREFETCH) {
1497	for my $path (keys %MAP_PREFETCH) {	2165	while (my ($k, $v) = each %MAP_PREFETCH) {
1498	my $map = find $path	2166	if (my $map = find $k) {
1499	or next;
1500	$map->load;	2167	$map->load if $v;
		2168	}
1501		2169
1502	delete $MAP_PREFETCH{$path};	2170	delete $MAP_PREFETCH{$k};
1503	}	2171	}
1504	}	2172	}
1505	undef $MAP_PREFETCHER;	2173	undef $MAP_PREFETCHER;
1506	};	2174	};
1507	$MAP_PREFETCHER->prio (6);	2175	$MAP_PREFETCHER->prio (6);
…		…
1510	}	2178	}
1511		2179
1512	sub save {	2180	sub save {
1513	my ($self) = @_;	2181	my ($self) = @_;
1514		2182
1515	my $lock = cf::lock_acquire "map_data:" . $self->path;	2183	my $lock = cf::lock_acquire "map_data:$self->{path}";
1516		2184
1517	$self->{last_save} = $cf::RUNTIME;	2185	$self->{last_save} = $cf::RUNTIME;
1518		2186
1519	return unless $self->dirty;	2187	return unless $self->dirty;
1520		2188
…		…
1526	return if $self->{deny_save};	2194	return if $self->{deny_save};
1527		2195
1528	local $self->{last_access} = $self->last_access;#d#	2196	local $self->{last_access} = $self->last_access;#d#
1529		2197
1530	cf::async {	2198	cf::async {
		2199	$Coro::current->{desc} = "map player save";
1531	$_->contr->save for $self->players;	2200	$_->contr->save for $self->players;
1532	};	2201	};
1533		2202
1534	if ($uniq) {	2203	if ($uniq) {
1535	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2204	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
…		…
1543	my ($self) = @_;	2212	my ($self) = @_;
1544		2213
1545	# save first because save cedes	2214	# save first because save cedes
1546	$self->save;	2215	$self->save;
1547		2216
1548	my $lock = cf::lock_acquire "map_data:" . $self->path;	2217	my $lock = cf::lock_acquire "map_data:$self->{path}";
1549		2218
1550	return if $self->players;	2219	return if $self->players;
1551	return if $self->in_memory != cf::MAP_IN_MEMORY;	2220	return if $self->in_memory != cf::MAP_IN_MEMORY;
1552	return if $self->{deny_save};	2221	return if $self->{deny_save};
1553		2222
		2223	$self->in_memory (cf::MAP_SWAPPED);
		2224
		2225	$self->deactivate;
		2226	$_->clear_links_to ($self) for values %cf::MAP;
1554	$self->clear;	2227	$self->clear;
1555	$self->in_memory (cf::MAP_SWAPPED);
1556	}	2228	}
1557		2229
1558	sub reset_at {	2230	sub reset_at {
1559	my ($self) = @_;	2231	my ($self) = @_;
1560		2232
1561	# TODO: safety, remove and allow resettable per-player maps	2233	# TODO: safety, remove and allow resettable per-player maps
1562	return 1e99 if $self->isa ("ext::map_per_player");#d#
1563	return 1e99 if $self->{deny_reset};	2234	return 1e99 if $self->{deny_reset};
1564		2235
1565	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2236	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1566	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;
1567		2238
…		…
1578	my ($self) = @_;	2249	my ($self) = @_;
1579		2250
1580	my $lock = cf::lock_acquire "map_data:$self->{path}";	2251	my $lock = cf::lock_acquire "map_data:$self->{path}";
1581		2252
1582	return if $self->players;	2253	return if $self->players;
1583	return if $self->isa ("ext::map_per_player");#d#
1584		2254
1585	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	}
1586		2266
1587	delete $cf::MAP{$self->path};	2267	delete $cf::MAP{$self->path};
1588		2268
1589	$self->in_memory (cf::MAP_SWAPPED);	2269	$self->deactivate;
		2270	$_->clear_links_to ($self) for values %cf::MAP;
1590	$self->clear;	2271	$self->clear;
1591
1592	$_->clear_links_to ($self) for values %cf::MAP;
1593		2272
1594	$self->unlink_save;	2273	$self->unlink_save;
1595	$self->destroy;	2274	$self->destroy;
1596	}	2275	}
1597		2276
1598	my $nuke_counter = "aaaa";	2277	my $nuke_counter = "aaaa";
1599		2278
1600	sub nuke {	2279	sub nuke {
1601	my ($self) = @_;	2280	my ($self) = @_;
1602		2281
		2282	{
		2283	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2284
1603	delete $cf::MAP{$self->path};	2285	delete $cf::MAP{$self->path};
1604		2286
1605	$self->unlink_save;	2287	$self->unlink_save;
1606		2288
1607	bless $self, "cf::map";	2289	bless $self, "cf::map";
1608	delete $self->{deny_reset};	2290	delete $self->{deny_reset};
1609	$self->{deny_save} = 1;	2291	$self->{deny_save} = 1;
1610	$self->reset_timeout (1);	2292	$self->reset_timeout (1);
1611	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2293	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1612		2294
1613	$cf::MAP{$self->path} = $self;	2295	$cf::MAP{$self->path} = $self;
		2296	}
1614		2297
1615	$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	]
1616	}	2335	}
1617		2336
1618	=item cf::map::unique_maps	2337	=item cf::map::unique_maps
1619		2338
1620	Returns an arrayref of paths of all shared maps that have	2339	Returns an arrayref of paths of all shared maps that have
1621	instantiated unique items. May block.	2340	instantiated unique items. May block.
1622		2341
1623	=cut	2342	=cut
1624		2343
1625	sub unique_maps() {	2344	sub unique_maps() {
1626	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2345	[
1627	or return;	2346	map {
1628
1629	my @paths;
1630
1631	for (@$files) {
1632	utf8::decode $_;	2347	utf8::decode $_;
1633	next if /\.pst$/;	2348	/\.map$/
1634	next unless /^$PATH_SEP/o;	2349	? normalise $_
1635		2350	: ()
1636	push @paths, cf::map::normalise $_;	2351	} @{ aio_readdir $UNIQUEDIR or [] }
1637	}	2352	]
1638
1639	\@paths
1640	}	2353	}
1641		2354
1642	package cf;	2355	package cf;
1643		2356
1644	=back	2357	=back
…		…
1662	map { $_, inv_recursive_ $_->inv } @_	2375	map { $_, inv_recursive_ $_->inv } @_
1663	}	2376	}
1664		2377
1665	sub inv_recursive {	2378	sub inv_recursive {
1666	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	}
1667	}	2408	}
1668		2409
1669	package cf;	2410	package cf;
1670		2411
1671	=back	2412	=back
…		…
1690		2431
1691	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2432	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1692		2433
1693	if ($self->{record_replies}) {	2434	if ($self->{record_replies}) {
1694	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2435	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2436
1695	} 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 {
1696	$msg = $npc->name . " says: $msg" if $npc;	2445	$msg = $npc->name . " says: $msg" if $npc;
1697	$self->message ($msg, $flags);	2446	$self->message ($msg, $flags);
		2447	}
1698	}	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 (@_);
1699	}	2459	}
1700		2460
1701	=item $player_object->may ("access")	2461	=item $player_object->may ("access")
1702		2462
1703	Returns wether the given player is authorized to access resource "access"	2463	Returns wether the given player is authorized to access resource "access"
…		…
1750	$self->deactivate_recursive;	2510	$self->deactivate_recursive;
1751		2511
1752	return if UNIVERSAL::isa $self->map, "ext::map_link";	2512	return if UNIVERSAL::isa $self->map, "ext::map_link";
1753		2513
1754	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2514	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1755	if $self->map;	2515	if $self->map && $self->map->{path} ne "{link}";
1756		2516
1757	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2517	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1758	}	2518	}
1759		2519
1760	sub cf::object::player::leave_link {	2520	sub cf::object::player::leave_link {
1761	my ($self, $map, $x, $y) = @_;	2521	my ($self, $map, $x, $y) = @_;
		2522
		2523	return unless $self->contr->active;
1762		2524
1763	my $link_pos = delete $self->{_link_pos};	2525	my $link_pos = delete $self->{_link_pos};
1764		2526
1765	unless ($map) {	2527	unless ($map) {
1766	# restore original map position	2528	# restore original map position
…		…
1780	# use -1 or undef as default coordinates, not 0, 0	2542	# use -1 or undef as default coordinates, not 0, 0
1781	($x, $y) = ($map->enter_x, $map->enter_y)	2543	($x, $y) = ($map->enter_x, $map->enter_y)
1782	if $x <=0 && $y <= 0;	2544	if $x <=0 && $y <= 0;
1783		2545
1784	$map->load;	2546	$map->load;
1785	$map->load_diag;	2547	$map->load_neighbours;
1786		2548
1787	return unless $self->contr->active;	2549	return unless $self->contr->active;
1788	$self->activate_recursive;	2550	$self->activate_recursive;
		2551
		2552	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1789	$self->enter_map ($map, $x, $y);	2553	$self->enter_map ($map, $x, $y);
1790	}	2554	}
1791		2555
1792	cf::player->attach (	2556	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1793	on_logout => sub {
1794	my ($pl) = @_;
1795		2557
1796	# abort map switching before logout	2558	Moves the player to the given map-path and coordinates by first freezing
1797	if ($pl->ob->{_link_pos}) {	2559	her, loading and preparing them map, calling the provided $check callback
1798	cf::sync_job {	2560	that has to return the map if sucecssful, and then unfreezes the player on
1799	$pl->ob->leave_link	2561	the new (success) or old (failed) map position. In either case, $done will
1800	};	2562	be called at the end of this process.
1801	}
1802	},
1803	on_login => sub {
1804	my ($pl) = @_;
1805		2563
1806	# try to abort aborted map switching on player login :)
1807	# should happen only on crashes
1808	if ($pl->ob->{_link_pos}) {
1809	$pl->ob->enter_link;
1810	(async {
1811	# we need this sleep as the login has a concurrent enter_exit running
1812	# and this sleep increases chances of the player not ending up in scorn
1813	$pl->ob->reply (undef,
1814	"There was an internal problem at your last logout, "
1815	. "the server will try to bring you to your intended destination in a second.",
1816	cf::NDI_RED);
1817	Coro::Timer::sleep 1;
1818	$pl->ob->leave_link;
1819	})->prio (2);
1820	}
1821	},
1822	);
1823
1824	=item $player_object->goto ($path, $x, $y)
1825
1826	=cut	2564	=cut
		2565
		2566	our $GOTOGEN;
1827		2567
1828	sub cf::object::player::goto {	2568	sub cf::object::player::goto {
1829	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;
1830		2573
1831	$self->enter_link;	2574	$self->enter_link;
1832		2575
1833	(async {	2576	(async {
		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
1834	my $map = eval {	2598	my $map = eval {
1835	my $map = cf::map::find $path;	2599	my $map = defined $path ? cf::map::find $path : undef;
		2600
		2601	if ($map) {
1836	$map = $map->customise_for ($self) if $map;	2602	$map = $map->customise_for ($self);
		2603	$map = $check->($map) if $check && $map;
		2604	} else {
		2605	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2606	}
		2607
1837	$map	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 $@;
1838	} or	2614	}
1839	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1840		2615
		2616	if ($gen == $self->{_goto_generation}) {
		2617	delete $self->{_goto_generation};
1841	$self->leave_link ($map, $x, $y);	2618	$self->leave_link ($map, $x, $y);
		2619	}
		2620
		2621	$done->() if $done;
1842	})->prio (1);	2622	})->prio (1);
1843	}	2623	}
1844		2624
1845	=item $player_object->enter_exit ($exit_object)	2625	=item $player_object->enter_exit ($exit_object)
1846		2626
…		…
1883	$rmp->{origin_y} = $exit->y;	2663	$rmp->{origin_y} = $exit->y;
1884	}	2664	}
1885		2665
1886	$rmp->{random_seed} ||= $exit->random_seed;	2666	$rmp->{random_seed} ||= $exit->random_seed;
1887		2667
1888	my $data = cf::to_json $rmp;	2668	my $data = cf::encode_json $rmp;
1889	my $md5 = Digest::MD5::md5_hex $data;	2669	my $md5 = Digest::MD5::md5_hex $data;
1890	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2670	my $meta = "$RANDOMDIR/$md5.meta";
1891		2671
1892	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2672	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1893	aio_write $fh, 0, (length $data), $data, 0;	2673	aio_write $fh, 0, (length $data), $data, 0;
1894	undef $fh;	2674	undef $fh;
1895	aio_rename "$meta~", $meta;	2675	aio_rename "$meta~", $meta;
…		…
1904		2684
1905	return unless $self->type == cf::PLAYER;	2685	return unless $self->type == cf::PLAYER;
1906		2686
1907	if ($exit->slaying eq "/!") {	2687	if ($exit->slaying eq "/!") {
1908	#TODO: this should de-fi-ni-te-ly not be a sync-job	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
1909	cf::sync_job { prepare_random_map $exit };	2691	cf::sync_job { prepare_random_map $exit };
1910	}	2692	}
1911		2693
1912	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2694	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1913	my $hp = $exit->stats->hp;	2695	my $hp = $exit->stats->hp;
1914	my $sp = $exit->stats->sp;	2696	my $sp = $exit->stats->sp;
1915		2697
1916	$self->enter_link;	2698	$self->enter_link;
1917		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
1918	(async {	2704	(async {
		2705	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2706
1919	$self->deactivate_recursive; # just to be sure	2707	$self->deactivate_recursive; # just to be sure
1920	unless (eval {	2708	unless (eval {
1921	$self->goto ($slaying, $hp, $sp);	2709	$self->goto ($slaying, $hp, $sp);
1922		2710
1923	1;	2711	1;
1924	}) {	2712	}) {
1925	$self->message ("Something went wrong deep within the crossfire server. "	2713	$self->message ("Something went wrong deep within the crossfire server. "
1926	. "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. "
1927	. "Please report this to the dungeon master!",	2715	. "Please report this to the dungeon master!",
1928	cf::NDI_UNIQUE | cf::NDI_RED);	2716	cf::NDI_UNIQUE | cf::NDI_RED);
1929		2717
1930	warn "ERROR in enter_exit: $@";	2718	warn "ERROR in enter_exit: $@";
1931	$self->leave_link;	2719	$self->leave_link;
1932	}	2720	}
1933	})->prio (1);	2721	})->prio (1);
…		…
1946		2734
1947	sub cf::client::send_drawinfo {	2735	sub cf::client::send_drawinfo {
1948	my ($self, $text, $flags) = @_;	2736	my ($self, $text, $flags) = @_;
1949		2737
1950	utf8::encode $text;	2738	utf8::encode $text;
1951	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2739	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1952	}	2740	}
1953		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	}
1954		2900
1955	=item $success = $client->query ($flags, "text", \&cb)	2901	=item $success = $client->query ($flags, "text", \&cb)
1956		2902
1957	Queues a query to the client, calling the given callback with	2903	Queues a query to the client, calling the given callback with
1958	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>,
1959	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>.
1960		2906
1961	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
1962	reliable at some point in the future.	2908	become reliable at some point in the future.
1963		2909
1964	=cut	2910	=cut
1965		2911
1966	sub cf::client::query {	2912	sub cf::client::query {
1967	my ($self, $flags, $text, $cb) = @_;	2913	my ($self, $flags, $text, $cb) = @_;
…		…
1975	utf8::encode $text;	2921	utf8::encode $text;
1976	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2922	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1977		2923
1978	$self->send_packet ($self->{query_queue}[0][0])	2924	$self->send_packet ($self->{query_queue}[0][0])
1979	if @{ $self->{query_queue} } == 1;	2925	if @{ $self->{query_queue} } == 1;
		2926
		2927	1
1980	}	2928	}
1981		2929
1982	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	},
1983	on_reply => sub {	2936	on_reply => sub {
1984	my ($ns, $msg) = @_;	2937	my ($ns, $msg) = @_;
1985		2938
1986	# this weird shuffling is so that direct followup queries	2939	# this weird shuffling is so that direct followup queries
1987	# get handled first	2940	# get handled first
1988	my $queue = delete $ns->{query_queue}	2941	my $queue = delete $ns->{query_queue}
1989	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
1990		2943
1991	(shift @$queue)->[1]->($msg);	2944	(shift @$queue)->[1]->($msg);
		2945	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1992		2946
1993	push @{ $ns->{query_queue} }, @$queue;	2947	push @{ $ns->{query_queue} }, @$queue;
1994		2948
1995	if (@{ $ns->{query_queue} } == @$queue) {	2949	if (@{ $ns->{query_queue} } == @$queue) {
1996	if (@$queue) {	2950	if (@$queue) {
…		…
1998	} else {	2952	} else {
1999	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2953	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2000	}	2954	}
2001	}	2955	}
2002	},	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	},
2003	);	2983	);
2004		2984
2005	=item $client->async (\&cb)	2985	=item $client->async (\&cb)
2006		2986
2007	Create a new coroutine, running the specified callback. The coroutine will	2987	Create a new coroutine, running the specified callback. The coroutine will
…		…
2048	our $safe = new Safe "safe";	3028	our $safe = new Safe "safe";
2049	our $safe_hole = new Safe::Hole;	3029	our $safe_hole = new Safe::Hole;
2050		3030
2051	$SIG{FPE} = 'IGNORE';	3031	$SIG{FPE} = 'IGNORE';
2052		3032
2053	$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	));
2054		3038
2055	# here we export the classes and methods available to script code	3039	# here we export the classes and methods available to script code
2056		3040
2057	=pod	3041	=pod
2058		3042
2059	The following fucntions and emthods are available within a safe environment:	3043	The following functions and methods are available within a safe environment:
2060		3044
2061	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
2062	cf::object::player player	3049	cf::object::player
2063	cf::player peaceful	3050	player
2064	cf::map trigger	3051
		3052	cf::player
		3053	peaceful
		3054
		3055	cf::map
		3056	trigger
2065		3057
2066	=cut	3058	=cut
2067		3059
2068	for (	3060	for (
2069	["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)],
2070	["cf::object::player" => qw(player)],	3064	["cf::object::player" => qw(player)],
2071	["cf::player" => qw(peaceful)],	3065	["cf::player" => qw(peaceful)],
2072	["cf::map" => qw(trigger)],	3066	["cf::map" => qw(trigger)],
2073	) {	3067	) {
2074	no strict 'refs';	3068	no strict 'refs';
…		…
2145	=back	3139	=back
2146		3140
2147	=cut	3141	=cut
2148		3142
2149	#############################################################################	3143	#############################################################################
		3144	# the server's init and main functions
2150		3145
2151	=head2 EXTENSION DATABASE SUPPORT	3146	sub load_facedata($) {
		3147	my ($path) = @_;
2152		3148
2153	Crossfire maintains a very simple database for extension use. It can	3149	# HACK to clear player env face cache, we need some signal framework
2154	currently store anything that can be serialised using Storable, which	3150	# for this (global event?)
2155	excludes objects.	3151	%ext::player_env::MUSIC_FACE_CACHE = ();
2156		3152
2157	The parameter C<$family> should best start with the name of the extension	3153	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2158	using it, it should be unique.
2159		3154
2160	=over 4	3155	warn "loading facedata from $path\n";
2161		3156
2162	=item $hashref = cf::db_get $family	3157	my $facedata;
		3158	0 < aio_load $path, $facedata
		3159	or die "$path: $!";
2163		3160
2164	Return a hashref for use by the extension C<$family>, which can be	3161	$facedata = Coro::Storable::thaw $facedata;
2165	modified. After modifications, you have to call C<cf::db_dirty> or
2166	C<cf::db_sync>.
2167		3162
2168	=item $value = cf::db_get $family => $key	3163	$facedata->{version} == 2
		3164	or cf::cleanup "$path: version mismatch, cannot proceed.";
2169		3165
2170	Returns a single value from the database	3166	# patch in the exptable
2171		3167	$facedata->{resource}{"res/exp_table"} = {
2172	=item cf::db_put $family => $hashref	3168	type => FT_RSRC,
2173		3169	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2174	Stores the given family hashref into the database. Updates are delayed, if
2175	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2176
2177	=item cf::db_put $family => $key => $value
2178
2179	Stores the given C<$value> in the family hash. Updates are delayed, if you
2180	want the data to be synced to disk immediately, use C<cf::db_sync>.
2181
2182	=item cf::db_dirty
2183
2184	Marks the database as dirty, to be updated at a later time.
2185
2186	=item cf::db_sync
2187
2188	Immediately write the database to disk I<if it is dirty>.
2189
2190	=cut
2191
2192	our $DB;
2193
2194	{
2195	my $path = cf::localdir . "/database.pst";
2196
2197	sub db_load() {
2198	$DB = stat $path ? Storable::retrieve $path : { };
2199	}	3170	};
		3171	cf::cede_to_tick;
2200		3172
2201	my $pid;
2202
2203	sub db_save() {
2204	waitpid $pid, 0 if $pid;
2205	if (0 == ($pid = fork)) {
2206	$DB->{_meta}{version} = 1;
2207	Storable::nstore $DB, "$path~";
2208	rename "$path~", $path;
2209	cf::_exit 0 if defined $pid;
2210	}
2211	}	3173	{
		3174	my $faces = $facedata->{faceinfo};
2212		3175
2213	my $dirty;	3176	while (my ($face, $info) = each %$faces) {
		3177	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2214		3178
2215	sub db_sync() {	3179	cf::face::set_visibility $idx, $info->{visibility};
2216	db_save if $dirty;	3180	cf::face::set_magicmap $idx, $info->{magicmap};
2217	undef $dirty;	3181	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2218	}	3182	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2219		3183
2220	my $idle = Event->idle (	3184	cf::cede_to_tick;
2221	reentrant => 0,
2222	min => 10,
2223	max => 20,
2224	repeat => 0,
2225	data => WF_AUTOCANCEL,
2226	cb => \&db_sync,
2227	);
2228
2229	sub db_dirty() {
2230	$dirty = 1;
2231	$idle->start;
2232	}
2233
2234	sub db_get($;$) {
2235	@_ >= 2
2236	? $DB->{$_[0]}{$_[1]}
2237	: ($DB->{$_[0]} ||= { })
2238	}
2239
2240	sub db_put($$;$) {
2241	if (@_ >= 3) {
2242	$DB->{$_[0]}{$_[1]} = $_[2];
2243	} else {
2244	$DB->{$_[0]} = $_[1];
2245	}
2246	db_dirty;
2247	}
2248
2249	cf::global->attach (
2250	prio => 10000,
2251	on_cleanup => sub {
2252	db_sync;
2253	},	3185	}
2254	);
2255	}
2256		3186
2257	#############################################################################	3187	while (my ($face, $info) = each %$faces) {
2258	# the server's main()	3188	next unless $info->{smooth};
2259		3189
2260	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 {
2261	open my $fh, "<:utf8", cf::confdir . "/config"	3332	open my $fh, "<:utf8", "$CONFDIR/config"
2262	or return;	3333	or return;
2263		3334
2264	local $/;	3335	local $/;
2265	*CFG = YAML::Syck::Load <$fh>;	3336	*CFG = YAML::Load <$fh>;
2266		3337
2267	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3338	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2268		3339
2269	$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};
2270	$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};
…		…
2281	sub main {	3352	sub main {
2282	# we must not ever block the main coroutine	3353	# we must not ever block the main coroutine
2283	local $Coro::idle = sub {	3354	local $Coro::idle = sub {
2284	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#
2285	(async {	3356	(async {
2286	Event::one_event;	3357	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3358	EV::loop EV::LOOP_ONESHOT;
2287	})->prio (Coro::PRIO_MAX);	3359	})->prio (Coro::PRIO_MAX);
2288	};	3360	};
2289		3361
2290	cfg_load;	3362	reload_config;
2291	db_load;	3363	db_init;
2292	load_extensions;	3364	load_extensions;
2293		3365
2294	$TICK_WATCHER->start;	3366	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3367	evthread_start IO::AIO::poll_fileno;
2295	Event::loop;	3368	EV::loop;
2296	}	3369	}
2297		3370
2298	#############################################################################	3371	#############################################################################
2299	# initialisation and cleanup	3372	# initialisation and cleanup
2300		3373
2301	# install some emergency cleanup handlers	3374	# install some emergency cleanup handlers
2302	BEGIN {	3375	BEGIN {
		3376	our %SIGWATCHER = ();
2303	for my $signal (qw(INT HUP TERM)) {	3377	for my $signal (qw(INT HUP TERM)) {
2304	Event->signal (	3378	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2305	reentrant => 0,
2306	data => WF_AUTOCANCEL,
2307	signal => $signal,
2308	prio => 0,
2309	cb => sub {
2310	cf::cleanup "SIG$signal";	3379	cf::cleanup "SIG$signal";
2311	},
2312	);	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
2313	}	3419	1
2314	}	3420	}
2315		3421
2316	sub emergency_save() {	3422	sub emergency_save() {
2317	my $freeze_guard = cf::freeze_mainloop;	3423	my $freeze_guard = cf::freeze_mainloop;
2318		3424
…		…
2324	# and maps saved/destroyed asynchronously.	3430	# and maps saved/destroyed asynchronously.
2325	warn "begin emergency player save\n";	3431	warn "begin emergency player save\n";
2326	for my $login (keys %cf::PLAYER) {	3432	for my $login (keys %cf::PLAYER) {
2327	my $pl = $cf::PLAYER{$login} or next;	3433	my $pl = $cf::PLAYER{$login} or next;
2328	$pl->valid or next;	3434	$pl->valid or next;
		3435	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2329	$pl->save;	3436	$pl->save;
2330	}	3437	}
2331	warn "end emergency player save\n";	3438	warn "end emergency player save\n";
2332		3439
2333	warn "begin emergency map save\n";	3440	warn "begin emergency map save\n";
…		…
2335	my $map = $cf::MAP{$path} or next;	3442	my $map = $cf::MAP{$path} or next;
2336	$map->valid or next;	3443	$map->valid or next;
2337	$map->save;	3444	$map->save;
2338	}	3445	}
2339	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";
2340	};	3451	};
2341		3452
2342	warn "leave emergency perl save\n";	3453	warn "leave emergency perl save\n";
2343	}	3454	}
2344		3455
		3456	sub post_cleanup {
		3457	my ($make_core) = @_;
		3458
		3459	warn Carp::longmess "post_cleanup backtrace"
		3460	if $make_core;
		3461	}
		3462
2345	sub reload() {	3463	sub do_reload_perl() {
2346	# can/must only be called in main	3464	# can/must only be called in main
2347	if ($Coro::current != $Coro::main) {	3465	if ($Coro::current != $Coro::main) {
2348	warn "can only reload from main coroutine";	3466	warn "can only reload from main coroutine";
2349	return;	3467	return;
2350	}	3468	}
2351		3469
2352	warn "reloading...";	3470	warn "reloading...";
2353		3471
2354	warn "cancelling server ticker";	3472	warn "entering sync_job";
2355	$TICK_WATCHER->cancel;
2356		3473
		3474	cf::sync_job {
		3475	cf::write_runtime; # external watchdog should not bark
2357	cf::emergency_save;	3476	cf::emergency_save;
		3477	cf::write_runtime; # external watchdog should not bark
2358		3478
2359	eval {	3479	warn "syncing database to disk";
		3480	BDB::db_env_txn_checkpoint $DB_ENV;
		3481
2360	# 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
2361
2362	warn "syncing database to disk";
2363	cf::db_sync;
2364
2365	warn "cancelling all WF_AUTOCANCEL watchers";
2366	for (Event::all_watchers) {
2367	$_->cancel if $_->data & WF_AUTOCANCEL;
2368	}
2369		3483
2370	warn "flushing outstanding aio requests";	3484	warn "flushing outstanding aio requests";
2371	for (;;) {	3485	for (;;) {
		3486	BDB::flush;
2372	IO::AIO::flush;	3487	IO::AIO::flush;
2373	Coro::cede;	3488	Coro::cede_notself;
2374	last unless IO::AIO::nreqs;	3489	last unless IO::AIO::nreqs || BDB::nreqs;
2375	warn "iterate...";	3490	warn "iterate...";
2376	}	3491	}
		3492
		3493	++$RELOAD;
2377		3494
2378	warn "cancelling all extension coros";	3495	warn "cancelling all extension coros";
2379	$_->cancel for values %EXT_CORO;	3496	$_->cancel for values %EXT_CORO;
2380	%EXT_CORO = ();	3497	%EXT_CORO = ();
2381		3498
2382	warn "removing commands";	3499	warn "removing commands";
2383	%COMMAND = ();	3500	%COMMAND = ();
2384		3501
2385	warn "removing ext commands";	3502	warn "removing ext/exti commands";
2386	%EXTCMD = ();	3503	%EXTCMD = ();
		3504	%EXTICMD = ();
2387		3505
2388	warn "unloading/nuking all extensions";	3506	warn "unloading/nuking all extensions";
2389	for my $pkg (@EXTS) {	3507	for my $pkg (@EXTS) {
2390	warn "... unloading $pkg";	3508	warn "... unloading $pkg";
2391		3509
…		…
2421	Symbol::delete_package "safe::$_"	3539	Symbol::delete_package "safe::$_"
2422	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);
2423		3541
2424	warn "unloading cf.pm \"a bit\"";	3542	warn "unloading cf.pm \"a bit\"";
2425	delete $INC{"cf.pm"};	3543	delete $INC{"cf.pm"};
		3544	delete $INC{"cf/pod.pm"};
2426		3545
2427	# don't, removes xs symbols, too,	3546	# don't, removes xs symbols, too,
2428	# and global variables created in xs	3547	# and global variables created in xs
2429	#Symbol::delete_package __PACKAGE__;	3548	#Symbol::delete_package __PACKAGE__;
2430		3549
…		…
2433	warn "reloading cf.pm";	3552	warn "reloading cf.pm";
2434	require cf;	3553	require cf;
2435	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3554	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2436		3555
2437	warn "loading config and database again";	3556	warn "loading config and database again";
2438	cf::cfg_load;	3557	cf::reload_config;
2439	cf::db_load;
2440		3558
2441	warn "loading extensions";	3559	warn "loading extensions";
2442	cf::load_extensions;	3560	cf::load_extensions;
2443		3561
2444	warn "reattaching attachments to objects/players";	3562	warn "reattaching attachments to objects/players";
2445	_global_reattach;	3563	_global_reattach; # objects, sockets
2446	warn "reattaching attachments to maps";	3564	warn "reattaching attachments to maps";
2447	reattach $_ for values %MAP;	3565	reattach $_ for values %MAP;
		3566	warn "reattaching attachments to players";
		3567	reattach $_ for values %PLAYER;
2448		3568
2449	warn "restarting server ticker";	3569	warn "leaving sync_job";
2450		3570
2451	$TICK_WATCHER->start;	3571	1
		3572	} or do {
		3573	warn $@;
		3574	cf::cleanup "error while reloading, exiting.";
2452	};	3575	};
2453
2454	if ($@) {
2455	warn $@;
2456	warn "error while reloading, exiting.";
2457	exit 1;
2458	}
2459		3576
2460	warn "reloaded";	3577	warn "reloaded";
2461	};	3578	};
2462		3579
2463	our $RELOAD_WATCHER; # used only during reload	3580	our $RELOAD_WATCHER; # used only during reload
2464		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
2465	register_command "reload" => sub {	3592	register_command "reload" => sub {
2466	my ($who, $arg) = @_;	3593	my ($who, $arg) = @_;
2467		3594
2468	if ($who->flag (FLAG_WIZ)) {	3595	if ($who->flag (FLAG_WIZ)) {
2469	$who->message ("reloading server.");	3596	$who->message ("reloading server.");
2470		3597	async {
2471	# doing reload synchronously and two reloads happen back-to-back,	3598	$Coro::current->{desc} = "perl_reload";
2472	# coro crashes during coro_state_free->destroy here.
2473
2474	$RELOAD_WATCHER ||= Event->timer (
2475	reentrant => 0,
2476	after => 0,
2477	data => WF_AUTOCANCEL,
2478	cb => sub {
2479	reload;	3599	reload_perl;
2480	undef $RELOAD_WATCHER;
2481	},
2482	);	3600	};
2483	}	3601	}
2484	};	3602	};
2485		3603
2486	unshift @INC, $LIBDIR;	3604	unshift @INC, $LIBDIR;
2487		3605
2488	my $bug_warning = 0;	3606	my $bug_warning = 0;
2489		3607
2490	$TICK_WATCHER = Event->timer (	3608	our @WAIT_FOR_TICK;
2491	reentrant => 0,	3609	our @WAIT_FOR_TICK_BEGIN;
2492	parked => 1,	3610
2493	prio => 0,	3611	sub wait_for_tick {
2494	at => $NEXT_TICK || $TICK,	3612	return if tick_inhibit;
2495	data => WF_AUTOCANCEL,	3613	return if $Coro::current == $Coro::main;
2496	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 {
2497	if ($Coro::current != $Coro::main) {	3630	if ($Coro::current != $Coro::main) {
2498	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"
2499	unless ++$bug_warning > 10;	3632	unless ++$bug_warning > 10;
2500	return;	3633	return;
2501	}	3634	}
2502		3635
2503	$NOW = Event::time;
2504
2505	cf::server_tick; # one server iteration	3636	cf::server_tick; # one server iteration
2506	$RUNTIME += $TICK;
2507	$NEXT_TICK += $TICK;
2508		3637
2509	$WAIT_FOR_TICK->broadcast;	3638	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2510	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3639	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2511		3640	Coro::async_pool {
2512	Event::sweep;	3641	$Coro::current->{desc} = "runtime saver";
2513	Coro::cede_notself;
2514
2515	# my $AFTER = Event::time;
2516	# warn $AFTER - $NOW;#d#
2517
2518	# if we are delayed by four ticks or more, skip them all
2519	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2520
2521	$TICK_WATCHER->at ($NEXT_TICK);
2522	$TICK_WATCHER->start;
2523	},
2524	);
2525
2526	IO::AIO::max_poll_time $TICK * 0.1;
2527
2528	undef $Coro::AIO::WATCHER;
2529	$AIO_POLL_WATCHER = Event->io (
2530	reentrant => 0,
2531	fd => IO::AIO::poll_fileno,
2532	poll => 'r',
2533	prio => 6,
2534	data => WF_AUTOCANCEL,
2535	cb => \&IO::AIO::poll_cb,
2536	);
2537
2538	$WRITE_RUNTIME_WATCHER = Event->timer (
2539	reentrant => 0,
2540	data => WF_AUTOCANCEL,
2541	after => 1,
2542	interval => 10,
2543	prio => 6, # keep it lowest so it acts like a watchdog
2544	cb => Coro::unblock_sub {
2545	write_runtime	3642	write_runtime
2546	or warn "ERROR: unable to write runtime file: $!";	3643	or warn "ERROR: unable to write runtime file: $!";
		3644	};
2547	},	3645	}
2548	);	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;
2549		3757
2550	END { cf::emergency_save }	3758	END { cf::emergency_save }
2551		3759
2552	1	3760	1
2553		3761

Diff Legend

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