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.176 by root, Sun Jan 14 22:14:35 2007 UTC vs.
Revision 1.447 by root, Fri Sep 19 01:39:45 2008 UTC

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

Diff Legend

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