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

Diff Legend

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