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

Diff Legend

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