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.152 by root, Mon Jan 8 22:32:10 2007 UTC vs.
Revision 1.440 by root, Mon Aug 11 23:23:41 2008 UTC

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

Diff Legend

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