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.147 by root, Mon Jan 8 12:23:33 2007 UTC vs.
Revision 1.447 by root, Fri Sep 19 01:39:45 2008 UTC

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

Diff Legend

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