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.161 by root, Thu Jan 11 00:16:58 2007 UTC vs.
Revision 1.455 by root, Sat Sep 27 08:17:40 2008 UTC

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

Diff Legend

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