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.174 by root, Sun Jan 14 19:55:37 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 ();
20	use Data::Dumper;	53	use Data::Dumper;
21	use Digest::MD5;	54	use Digest::MD5;
22	use Fcntl;	55	use Fcntl;
		56	use YAML ();
23	use IO::AIO 2.32 ();	57	use IO::AIO ();
24	use YAML::Syck ();
25	use Time::HiRes;	58	use Time::HiRes;
		59	use Compress::LZF;
		60	use Digest::MD5 ();
26		61
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	62	AnyEvent::detect;
		63
		64	# configure various modules to our taste
		65	#
		66	$Storable::canonical = 1; # reduce rsync transfers
		67	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		68
		69	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		70
		71	{
		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	}
28		87
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	88	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32	$YAML::Syck::ImplicitUnicode = 1;
33
34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35		89
36	our %COMMAND = ();	90	our %COMMAND = ();
37	our %COMMAND_TIME = ();	91	our %COMMAND_TIME = ();
38		92
39	our @EXTS = (); # list of extension package names	93	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	94	our %EXTCMD = ();
		95	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	96	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	97	our %EXT_MAP = (); # pluggable maps
43		98
		99	our $RELOAD; # number of reloads so far
44	our @EVENT;	100	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		101
47	our $TICK = MAX_TIME * 1e-6;	102	our $CONFDIR = confdir;
48	our $TICK_WATCHER;	103	our $DATADIR = datadir;
49	our $AIO_POLL_WATCHER;	104	our $LIBDIR = "$DATADIR/ext";
50	our $WRITE_RUNTIME_WATCHER;	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
51	our $NEXT_TICK;	120	our $NEXT_TICK;
52	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;
53		127
54	our %CFG;	128	our %CFG;
55		129
56	our $UPTIME; $UPTIME ||= time;	130	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	131	our $RUNTIME;
		132	our $NOW;
58		133
59	our %PLAYER; # all users	134	our (%PLAYER, %PLAYER_LOADING); # all users
60	our %MAP; # all maps	135	our (%MAP, %MAP_LOADING ); # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	136	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		137
67	# used to convert map paths into valid unix filenames by replacing / by ∕	138	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	139	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		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
		145
70	binmode STDOUT;	146	binmode STDOUT;
71	binmode STDERR;	147	binmode STDERR;
72		148
73	# read virtual server time, if available	149	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	150	unless ($RUNTIME || !-e $RUNTIMEFILE) {
75	open my $fh, "<", cf::localdir . "/runtime"	151	open my $fh, "<", $RUNTIMEFILE
76	or die "unable to read runtime file: $!";	152	or die "unable to read $RUNTIMEFILE file: $!";
77	$RUNTIME = <$fh> + 0.;	153	$RUNTIME = <$fh> + 0.;
78	}	154	}
79		155
80	mkdir cf::localdir;	156	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	157	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		158
86	our $EMERGENCY_POSITION;	159	our $EMERGENCY_POSITION;
		160
		161	sub cf::map::normalise;
87		162
88	#############################################################################	163	#############################################################################
89		164
90	=head2 GLOBAL VARIABLES	165	=head2 GLOBAL VARIABLES
91		166
…		…
98	=item $cf::RUNTIME	173	=item $cf::RUNTIME
99		174
100	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
101	every server tick.	176	every server tick.
102		177
103	=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
104		181
105	The perl library directory, where extensions and cf-specific modules can	182	Various directories - "/etc", read-only install directory, perl-library
106	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.
107		186
108	=item $cf::NOW	187	=item $cf::NOW
109		188
110	The time of the last (current) server tick.	189	The time of the last (current) server tick.
111		190
112	=item $cf::TICK	191	=item $cf::TICK
113		192
114	The interval between server ticks, in seconds.	193	The interval between server ticks, in seconds.
115		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
116	=item %cf::CFG	205	=item %cf::CFG
117		206
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	207	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
119	from wherever your confdir points to.	208	from wherever your confdir points to.
120		209
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	210	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		211
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	212	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	213	returns directly I<after> the tick processing (and consequently, can only wake one process
125	processing has been done. Call C<< ->wait >> on them to maximise the	214	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126	window of cpu time available, or simply to synchronise to the server tick.	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.
127		221
128	=back	222	=back
129		223
130	=cut	224	=cut
131		225
132	BEGIN {	226	BEGIN {
133	*CORE::GLOBAL::warn = sub {	227	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	228	my $msg = join "", @_;
135	utf8::encode $msg;
136		229
137	$msg .= "\n"	230	$msg .= "\n"
138	unless $msg =~ /\n$/;	231	unless $msg =~ /\n$/;
139		232
		233	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		234
140	LOG llevError, $msg;	235	LOG llevError, $msg;
141	};	236	};
142	}	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#?
143		253
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	254	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	255	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	256	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	257	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@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';
149	@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)
150		261
151	# 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
152	# within the Safe compartment.	263	# within the Safe compartment.
153	for my $pkg (qw(	264	for my $pkg (qw(
154	cf::global cf::attachable	265	cf::global cf::attachable
155	cf::object cf::object::player	266	cf::object cf::object::player
156	cf::client cf::player	267	cf::client cf::player
157	cf::arch cf::living	268	cf::arch cf::living
		269	cf::map cf::mapspace
158	cf::map cf::party cf::region	270	cf::party cf::region
159	)) {	271	)) {
160	no strict 'refs';
161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	272	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
162	}	273	}
163		274
164	$Event::DIED = sub {	275	$EV::DIED = sub {
165	warn "error in event callback: @_";	276	warn "error in event callback: @_";
166	};	277	};
		278
		279	#############################################################################
167		280
168	=head2 UTILITY FUNCTIONS	281	=head2 UTILITY FUNCTIONS
169		282
170	=over 4	283	=over 4
171		284
…		…
190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	303	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191	$d	304	$d
192	} || "[unable to dump $_[0]: '$@']";	305	} || "[unable to dump $_[0]: '$@']";
193	}	306	}
194		307
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	308	=item $ref = cf::decode_json $json
198		309
199	Converts a JSON string into the corresponding perl data structure.	310	Converts a JSON string into the corresponding perl data structure.
200		311
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	312	=item $json = cf::encode_json $ref
209		313
210	Converts a perl data structure into its JSON representation.	314	Converts a perl data structure into its JSON representation.
211		315
212	=cut	316	=cut
213		317
214	sub to_json($) {	318	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	319
216	JSON::Syck::Dump $_[0]	320	sub encode_json($) { $json_coder->encode ($_[0]) }
217	}	321	sub decode_json($) { $json_coder->decode ($_[0]) }
218		322
219	=item cf::lock_wait $string	323	=item cf::lock_wait $string
220		324
221	Wait until the given lock is available. See cf::lock_acquire.	325	Wait until the given lock is available. See cf::lock_acquire.
222		326
…		…
225	Wait until the given lock is available and then acquires it and returns	329	Wait until the given lock is available and then acquires it and returns
226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	330	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
227	for example when the coroutine gets canceled), the lock is automatically	331	for example when the coroutine gets canceled), the lock is automatically
228	returned.	332	returned.
229		333
		334	Locks are *not* recursive, locking from the same coro twice results in a
		335	deadlocked coro.
		336
230	Lock names should begin with a unique identifier (for example, cf::map::find	337	Lock names should begin with a unique identifier (for example, cf::map::find
231	uses map_find and cf::map::load uses map_load).	338	uses map_find and cf::map::load uses map_load).
232		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
233	=cut	344	=cut
234		345
235	our %LOCK;	346	our %LOCK;
		347	our %LOCKER;#d#
236		348
237	sub lock_wait($) {	349	sub lock_wait($) {
238	my ($key) = @_;	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#
239		356
240	# wait for lock, if any	357	# wait for lock, if any
241	while ($LOCK{$key}) {	358	while ($LOCK{$key}) {
242	push @{ $LOCK{$key} }, $Coro::current;	359	push @{ $LOCK{$key} }, $Coro::current;
243	Coro::schedule;	360	Coro::schedule;
…		…
249		366
250	# wait, to be sure we are not locked	367	# wait, to be sure we are not locked
251	lock_wait $key;	368	lock_wait $key;
252		369
253	$LOCK{$key} = [];	370	$LOCK{$key} = [];
		371	$LOCKER{$key} = $Coro::current;#d#
254		372
255	Coro::guard {	373	Coro::guard {
		374	delete $LOCKER{$key};#d#
256	# wake up all waiters, to be on the safe side	375	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	376	$_->ready for @{ delete $LOCK{$key} };
258	}	377	}
259	}	378	}
260		379
		380	sub lock_active($) {
		381	my ($key) = @_;
		382
		383	! ! $LOCK{$key}
		384	}
		385
261	sub freeze_mainloop {	386	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	387	tick_inhibit_inc;
263		388
264	my $guard = Coro::guard {	389	Coro::guard \&tick_inhibit_dec;
265	$TICK_WATCHER->start;	390	}
266	$WRITE_RUNTIME_WATCHER->start;	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	}
267	};	450	}
268	$WRITE_RUNTIME_WATCHER->stop;	451	};
269	$TICK_WATCHER->stop;	452
270	$guard	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;
271	}	465	}
272		466
273	=item cf::async { BLOCK }	467	=item cf::async { BLOCK }
274		468
275	Currently the same as Coro::async_pool, meaning you cannot use	469	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		474
281	BEGIN { *async = \&Coro::async_pool }	475	BEGIN { *async = \&Coro::async_pool }
282		476
283	=item cf::sync_job { BLOCK }	477	=item cf::sync_job { BLOCK }
284		478
285	The design of crossfire+ requires that the main coro ($Coro::main) is	479	The design of Deliantra requires that the main coroutine ($Coro::main)
286	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
287	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.
288		483
289	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
290	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
291	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
292	fast or be very important.	487	fast or be very important.
…		…
295		490
296	sub sync_job(&) {	491	sub sync_job(&) {
297	my ($job) = @_;	492	my ($job) = @_;
298		493
299	if ($Coro::current == $Coro::main) {	494	if ($Coro::current == $Coro::main) {
		495	my $time = EV::time;
		496
300	# this is the main coro, too bad, we have to block	497	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	498	# till the operation succeeds, freezing the server :/
302		499
303	# TODO: use suspend/resume instead	500	LOG llevError, Carp::longmess "sync job";#d#
304	# (but this is cancel-safe)	501
305	my $freeze_guard = freeze_mainloop;	502	my $freeze_guard = freeze_mainloop;
306		503
307	my $busy = 1;	504	my $busy = 1;
308	my @res;	505	my @res;
309		506
310	(async {	507	(async {
		508	$Coro::current->desc ("sync job coro");
311	@res = eval { $job->() };	509	@res = eval { $job->() };
312	warn $@ if $@;	510	warn $@ if $@;
313	undef $busy;	511	undef $busy;
314	})->prio (Coro::PRIO_MAX);	512	})->prio (Coro::PRIO_MAX);
315		513
316	while ($busy) {	514	while ($busy) {
317	Coro::cede or Event::one_event;	515	if (Coro::nready) {
		516	Coro::cede_notself;
		517	} else {
		518	EV::loop EV::LOOP_ONESHOT;
318	}	519	}
		520	}
		521
		522	my $time = EV::time - $time;
		523
		524	$TICK_START += $time; # do not account sync jobs to server load
319		525
320	wantarray ? @res : $res[0]	526	wantarray ? @res : $res[0]
321	} else {	527	} else {
322	# we are in another coroutine, how wonderful, everything just works	528	# we are in another coroutine, how wonderful, everything just works
323		529
…		…
343	$EXT_CORO{$coro+0} = $coro;	549	$EXT_CORO{$coro+0} = $coro;
344		550
345	$coro	551	$coro
346	}	552	}
347		553
348	sub write_runtime {	554	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		555
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	556	Executes the given code block with the given arguments in a seperate
352	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.
353		560
354	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	561	=cut
355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
356	and return;
357		562
358	aio_fsync $fh	563	sub fork_call(&@) {
359	and return;	564	my ($cb, @args) = @_;
360		565
361	close $fh	566	# we seemingly have to make a local copy of the whole thing,
362	or return;	567	# otherwise perl prematurely frees the stuff :/
		568	# TODO: investigate and fix (likely this will be rather laborious)
363		569
364	aio_rename "$runtime~", $runtime	570	my @res = Coro::Util::fork_eval {
365	and return;	571	reset_signals;
		572	&$cb
		573	}, @args;
366		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
367	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 });
368	}	741	}
369		742
370	=back	743	=back
371		744
372	=cut	745	=cut
373		746
374	#############################################################################	747	#############################################################################
375		748
376	=head2 ATTACHABLE OBJECTS	749	=head2 ATTACHABLE OBJECTS
377		750
378	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
379	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")
380	to it. All such attachable objects support the following methods.	753	to it. All such attachable objects support the following methods.
381		754
382	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>
383	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
384	crossfire+).	757	Deliantra).
385		758
386	=over 4	759	=over 4
387		760
388	=item $attachable->attach ($attachment, key => $value...)	761	=item $attachable->attach ($attachment, key => $value...)
389		762
…		…
433	=item cf::CLASS::attachment $name, ...	806	=item cf::CLASS::attachment $name, ...
434		807
435	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
436	given CLASS can refer to this attachment.	809	given CLASS can refer to this attachment.
437		810
438	Some classes such as crossfire maps and objects can specify attachments	811	Some classes such as deliantra maps and objects can specify attachments
439	that are attached at load/instantiate time, thus the need for a name.	812	that are attached at load/instantiate time, thus the need for a name.
440		813
441	These calls expect any number of the following handler/hook descriptions:	814	These calls expect any number of the following handler/hook descriptions:
442		815
443	=over 4	816	=over 4
…		…
552	$registry = $CB_TYPE[$object_type] ||= [];	925	$registry = $CB_TYPE[$object_type] ||= [];
553		926
554	} elsif ($type eq "subtype") {	927	} elsif ($type eq "subtype") {
555	defined $object_type or Carp::croak "subtype specified without type";	928	defined $object_type or Carp::croak "subtype specified without type";
556	my $object_subtype = shift @arg;	929	my $object_subtype = shift @arg;
557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	930	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558		931
559	} elsif ($type eq "package") {	932	} elsif ($type eq "package") {
560	my $pkg = shift @arg;	933	my $pkg = shift @arg;
561		934
562	while (my ($name, $id) = each %cb_id) {	935	while (my ($name, $id) = each %cb_id) {
…		…
591	_attach $registry, $klass, @attach;	964	_attach $registry, $klass, @attach;
592	}	965	}
593		966
594	$obj->{$name} = \%arg;	967	$obj->{$name} = \%arg;
595	} else {	968	} else {
596	warn "object uses attachment '$name' that is not available, postponing.\n";	969	warn "object uses attachment '$name' which is not available, postponing.\n";
597	}	970	}
598		971
599	$obj->{_attachment}{$name} = undef;	972	$obj->{_attachment}{$name} = undef;
600	}	973	}
601		974
…		…
603	if (ref $_[0]) {	976	if (ref $_[0]) {
604	_object_attach @_;	977	_object_attach @_;
605	} else {	978	} else {
606	_attach shift->_attach_registry, @_;	979	_attach shift->_attach_registry, @_;
607	}	980	}
		981	_recalc_want;
608	};	982	};
609		983
610	# all those should be optimised	984	# all those should be optimised
611	sub cf::attachable::detach {	985	sub cf::attachable::detach {
612	my ($obj, $name) = @_;	986	my ($obj, $name) = @_;
…		…
615	delete $obj->{_attachment}{$name};	989	delete $obj->{_attachment}{$name};
616	reattach ($obj);	990	reattach ($obj);
617	} else {	991	} else {
618	Carp::croak "cannot, currently, detach class attachments";	992	Carp::croak "cannot, currently, detach class attachments";
619	}	993	}
		994	_recalc_want;
620	};	995	};
621		996
622	sub cf::attachable::attached {	997	sub cf::attachable::attached {
623	my ($obj, $name) = @_;	998	my ($obj, $name) = @_;
624		999
…		…
639	";	1014	";
640	die if $@;	1015	die if $@;
641	}	1016	}
642		1017
643	our $override;	1018	our $override;
644	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?
645		1020
646	sub override {	1021	sub override {
647	$override = 1;	1022	$override = 1;
648	@invoke_results = ();	1023	@INVOKE_RESULTS = (@_);
649	}	1024	}
650		1025
651	sub do_invoke {	1026	sub do_invoke {
652	my $event = shift;	1027	my $event = shift;
653	my $callbacks = shift;	1028	my $callbacks = shift;
654		1029
655	@invoke_results = ();	1030	@INVOKE_RESULTS = ();
656		1031
657	local $override;	1032	local $override;
658		1033
659	for (@$callbacks) {	1034	for (@$callbacks) {
660	eval { &{$_->[1]} };	1035	eval { &{$_->[1]} };
…		…
669	}	1044	}
670		1045
671	0	1046	0
672	}	1047	}
673		1048
674	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1049	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
675		1050
676	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1051	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
677		1052
678	Generate an object-specific event with the given arguments.	1053	Generate an object-specific event with the given arguments.
679		1054
680	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
681	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
682	results (if you must, access C<@cf::invoke_results> directly).	1057	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
683		1058
684	=back	1059	=back
685		1060
686	=cut	1061	=cut
687		1062
688	#############################################################################	1063	#############################################################################
689	# 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	}
690		1107
691	sub reattach {	1108	sub reattach {
692	# basically do the same as instantiate, without calling instantiate	1109	# basically do the same as instantiate, without calling instantiate
693	my ($obj) = @_;	1110	my ($obj) = @_;
694		1111
		1112	# no longer needed after getting rid of delete_package?
695	bless $obj, ref $obj; # re-bless in case extensions have been reloaded	1113	#bless $obj, ref $obj; # re-bless in case extensions have been reloaded
696		1114
697	my $registry = $obj->registry;	1115	my $registry = $obj->registry;
698		1116
699	@$registry = ();	1117	@$registry = ();
700		1118
…		…
715	cf::attachable->attach (	1133	cf::attachable->attach (
716	prio => -1000000,	1134	prio => -1000000,
717	on_instantiate => sub {	1135	on_instantiate => sub {
718	my ($obj, $data) = @_;	1136	my ($obj, $data) = @_;
719		1137
720	$data = from_json $data;	1138	$data = decode_json $data;
721		1139
722	for (@$data) {	1140	for (@$data) {
723	my ($name, $args) = @$_;	1141	my ($name, $args) = @$_;
724		1142
725	$obj->attach ($name, %{$args || {} });	1143	$obj->attach ($name, %{$args || {} });
…		…
741	sub object_freezer_save {	1159	sub object_freezer_save {
742	my ($filename, $rdata, $objs) = @_;	1160	my ($filename, $rdata, $objs) = @_;
743		1161
744	sync_job {	1162	sync_job {
745	if (length $$rdata) {	1163	if (length $$rdata) {
		1164	utf8::decode (my $decname = $filename);
746	warn sprintf "saving %s (%d,%d)\n",	1165	warn sprintf "saving %s (%d,%d)\n",
747	$filename, length $$rdata, scalar @$objs;	1166	$decname, length $$rdata, scalar @$objs;
748		1167
749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1168	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750	chmod SAVE_MODE, $fh;	1169	aio_chmod $fh, SAVE_MODE;
751	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1170	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
752	aio_fsync $fh;	1171	aio_fsync $fh if $cf::USE_FSYNC;
753	close $fh;	1172	aio_close $fh;
754		1173
755	if (@$objs) {	1174	if (@$objs) {
756	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) {
757	chmod SAVE_MODE, $fh;	1176	aio_chmod $fh, SAVE_MODE;
758	my $data = Storable::nfreeze { version => 1, objs => $objs };	1177	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
759	aio_write $fh, 0, (length $data), $data, 0;	1178	aio_write $fh, 0, (length $data), $data, 0;
760	aio_fsync $fh;	1179	aio_fsync $fh if $cf::USE_FSYNC;
761	close $fh;	1180	aio_close $fh;
762	aio_rename "$filename.pst~", "$filename.pst";	1181	aio_rename "$filename.pst~", "$filename.pst";
763	}	1182	}
764	} else {	1183	} else {
765	aio_unlink "$filename.pst";	1184	aio_unlink "$filename.pst";
766	}	1185	}
…		…
771	}	1190	}
772	} else {	1191	} else {
773	aio_unlink $filename;	1192	aio_unlink $filename;
774	aio_unlink "$filename.pst";	1193	aio_unlink "$filename.pst";
775	}	1194	}
776	}	1195	};
777	}	1196	}
778		1197
779	sub object_freezer_as_string {	1198	sub object_freezer_as_string {
780	my ($rdata, $objs) = @_;	1199	my ($rdata, $objs) = @_;
781		1200
…		…
793	or return;	1212	or return;
794		1213
795	unless (aio_stat "$filename.pst") {	1214	unless (aio_stat "$filename.pst") {
796	(aio_load "$filename.pst", $av) >= 0	1215	(aio_load "$filename.pst", $av) >= 0
797	or return;	1216	or return;
		1217
798	$av = eval { (Storable::thaw $av)->{objs} };	1218	my $st = eval { Coro::Storable::thaw $av };
		1219	$av = $st->{objs};
799	}	1220	}
800		1221
		1222	utf8::decode (my $decname = $filename);
801	warn sprintf "loading %s (%d)\n",	1223	warn sprintf "loading %s (%d,%d)\n",
802	$filename, length $data, scalar @{$av || []};#d#	1224	$decname, length $data, scalar @{$av || []};
		1225
803	return ($data, $av);	1226	($data, $av)
804	}	1227	}
		1228
		1229	=head2 COMMAND CALLBACKS
		1230
		1231	=over 4
		1232
		1233	=cut
805		1234
806	#############################################################################	1235	#############################################################################
807	# command handling &c	1236	# command handling &c
808		1237
809	=item cf::register_command $name => \&callback($ob,$args);	1238	=item cf::register_command $name => \&callback($ob,$args);
…		…
822	push @{ $COMMAND{$name} }, [$caller, $cb];	1251	push @{ $COMMAND{$name} }, [$caller, $cb];
823	}	1252	}
824		1253
825	=item cf::register_extcmd $name => \&callback($pl,$packet);	1254	=item cf::register_extcmd $name => \&callback($pl,$packet);
826		1255
827	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.
828		1261
829	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
830	called.	1263	called.
831		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
832	=cut	1276	=cut
833		1277
834	sub register_extcmd {	1278	sub register_extcmd {
835	my ($name, $cb) = @_;	1279	my ($name, $cb) = @_;
836		1280
837	$EXTCMD{$name} = $cb;	1281	$EXTCMD{$name} = $cb;
		1282	}
		1283
		1284	sub register_exticmd {
		1285	my ($name, $cb) = @_;
		1286
		1287	$EXTICMD{$name} = $cb;
838	}	1288	}
839		1289
840	cf::player->attach (	1290	cf::player->attach (
841	on_command => sub {	1291	on_command => sub {
842	my ($pl, $name, $params) = @_;	1292	my ($pl, $name, $params) = @_;
…		…
851	cf::override;	1301	cf::override;
852	},	1302	},
853	on_extcmd => sub {	1303	on_extcmd => sub {
854	my ($pl, $buf) = @_;	1304	my ($pl, $buf) = @_;
855		1305
856	my $msg = eval { from_json $buf };	1306	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857		1307
858	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
859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1316	if (my $cb = $EXTCMD{$type}) {
860	if (my %reply = $cb->($pl, $msg)) {	1317	@reply = $cb->($pl, @payload);
861	$pl->ext_reply ($msg->{msgid}, %reply);
862	}
863	}	1318	}
		1319
		1320	$pl->ext_reply ($reply, @reply)
		1321	if $reply;
		1322
864	} else {	1323	} else {
865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1324	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
866	}	1325	}
867		1326
868	cf::override;	1327	cf::override;
869	},	1328	},
870	);	1329	);
871		1330
872	sub load_extension {
873	my ($path) = @_;
874
875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
876	my $base = $1;
877	my $pkg = $1;
878	$pkg =~ s/[^[:word:]]/_/g;
879	$pkg = "ext::$pkg";
880
881	warn "... loading '$path' into '$pkg'\n";
882
883	open my $fh, "<:utf8", $path
884	or die "$path: $!";
885
886	my $source =
887	"package $pkg; use strict; use utf8;\n"
888	. "#line 1 \"$path\"\n{\n"
889	. (do { local $/; <$fh> })
890	. "\n};\n1";
891
892	unless (eval $source) {
893	my $msg = $@ ? "$path: $@\n"
894	: "extension disabled.\n";
895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896	warn $@;
897	warn "mandatory extension failed to load, exiting.\n";
898	exit 1;
899	}
900	die $@;
901	}
902
903	push @EXTS, $pkg;
904	}
905
906	sub load_extensions {	1331	sub load_extensions {
		1332	cf::sync_job {
		1333	my %todo;
		1334
907	for my $ext (<$LIBDIR/*.ext>) {	1335	for my $path (<$LIBDIR/*.ext>) {
908	next unless -r $ext;	1336	next unless -r $path;
909	eval {	1337
910	load_extension $ext;	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;
911	1	1394	}
912	} or warn "$ext not loaded: $@";	1395
		1396	skip:
		1397	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1398	unless $progress;
		1399	}
913	}	1400	};
914	}	1401	}
915		1402
916	#############################################################################	1403	#############################################################################
917		1404
		1405	=back
		1406
918	=head2 CORE EXTENSIONS	1407	=head2 CORE EXTENSIONS
919		1408
920	Functions and methods that extend core crossfire objects.	1409	Functions and methods that extend core deliantra objects.
921		1410
922	=cut	1411	=cut
923		1412
924	package cf::player;	1413	package cf::player;
925		1414
…		…
927		1416
928	=head3 cf::player	1417	=head3 cf::player
929		1418
930	=over 4	1419	=over 4
931		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
932	=item cf::player::find $login	1435	=item cf::player::find $login
933		1436
934	Returns the given player object, loading it if necessary (might block).	1437	Returns the given player object, loading it if necessary (might block).
935		1438
936	=cut	1439	=cut
937		1440
938	sub playerdir($) {	1441	sub playerdir($) {
939	cf::localdir	1442	"$PLAYERDIR/"
940	. "/"
941	. cf::playerdir
942	. "/"
943	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1443	. (ref $_[0] ? $_[0]->ob->name : $_[0])
944	}	1444	}
945		1445
946	sub path($) {	1446	sub path($) {
947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1447	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948		1448
949	(playerdir $login) . "/$login.pl"	1449	(playerdir $login) . "/playerdata"
950	}	1450	}
951		1451
952	sub find_active($) {	1452	sub find_active($) {
953	$cf::PLAYER{$_[0]}	1453	$cf::PLAYER{$_[0]}
954	and $cf::PLAYER{$_[0]}->active	1454	and $cf::PLAYER{$_[0]}->active
…		…
957		1457
958	sub exists($) {	1458	sub exists($) {
959	my ($login) = @_;	1459	my ($login) = @_;
960		1460
961	$cf::PLAYER{$login}	1461	$cf::PLAYER{$login}
962	or cf::sync_job { !aio_stat $login }	1462	or cf::sync_job { !aio_stat path $login }
963	}	1463	}
964		1464
965	sub find($) {	1465	sub find($) {
966	return $cf::PLAYER{$_[0]} || do {	1466	return $cf::PLAYER{$_[0]} || do {
967	my $login = $_[0];	1467	my $login = $_[0];
968		1468
969	my $guard = cf::lock_acquire "user_find:$login";	1469	my $guard = cf::lock_acquire "user_find:$login";
970		1470
971	$cf::PLAYER{$_[0]} || do {	1471	$cf::PLAYER{$_[0]} || do {
972	my $pl = load_pl path $login	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
973	or return;	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;
974	$cf::PLAYER{$login} = $pl	1487	$cf::PLAYER{$login} = $pl
975	}	1488	}
976	}	1489	}
977	}	1490	}
978		1491
…		…
987	return if $pl->{deny_save};	1500	return if $pl->{deny_save};
988		1501
989	aio_mkdir playerdir $pl, 0770;	1502	aio_mkdir playerdir $pl, 0770;
990	$pl->{last_save} = $cf::RUNTIME;	1503	$pl->{last_save} = $cf::RUNTIME;
991		1504
		1505	cf::get_slot 0.01;
		1506
992	$pl->save_pl ($path);	1507	$pl->save_pl ($path);
993	Coro::cede;	1508	cf::cede_to_tick;
994	}	1509	}
995		1510
996	sub new($) {	1511	sub new($) {
997	my ($login) = @_;	1512	my ($login) = @_;
998		1513
…		…
1004	$cf::PLAYER{$login} = $self;	1519	$cf::PLAYER{$login} = $self;
1005		1520
1006	$self	1521	$self
1007	}	1522	}
1008		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
1009	=item $pl->quit_character	1534	=item $pl->quit_character
1010		1535
1011	Nukes the player without looking back. If logged in, the connection will	1536	Nukes the player without looking back. If logged in, the connection will
1012	be destroyed. May block for a long time.	1537	be destroyed. May block for a long time.
1013		1538
1014	=cut	1539	=cut
1015		1540
1016	sub quit_character {	1541	sub quit_character {
1017	my ($pl) = @_;	1542	my ($pl) = @_;
1018		1543
		1544	my $name = $pl->ob->name;
		1545
1019	$pl->{deny_save} = 1;	1546	$pl->{deny_save} = 1;
1020	$pl->password ("*"); # this should lock out the player until we nuked the dir	1547	$pl->password ("*"); # this should lock out the player until we have nuked the dir
1021		1548
1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1549	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1023	$pl->deactivate;	1550	$pl->deactivate;
		1551	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1552	$pl->ob->check_score;
1024	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1553	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1025	$pl->ns->destroy if $pl->ns;	1554	$pl->ns->destroy if $pl->ns;
1026		1555
1027	my $path = playerdir $pl;	1556	my $path = playerdir $pl;
1028	my $temp = "$path~$cf::RUNTIME~deleting~";	1557	my $temp = "$path~$cf::RUNTIME~deleting~";
1029	aio_rename $path, $temp;	1558	aio_rename $path, $temp;
1030	delete $cf::PLAYER{$pl->ob->name};	1559	delete $cf::PLAYER{$pl->ob->name};
1031	$pl->destroy;	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
1032	IO::AIO::aio_rmtree $temp;	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;
1033	}	1582	}
1034		1583
1035	=item cf::player::list_logins	1584	=item cf::player::list_logins
1036		1585
1037	Returns am arrayref of all valid playernames in the system, can take a	1586	Returns am arrayref of all valid playernames in the system, can take a
1038	while and may block, so not sync_job-capable, ever.	1587	while and may block, so not sync_job-capable, ever.
1039		1588
1040	=cut	1589	=cut
1041		1590
1042	sub list_logins {	1591	sub list_logins {
1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1592	my $dirs = aio_readdir $PLAYERDIR
1044	or return [];	1593	or return [];
1045		1594
1046	my @logins;	1595	my @logins;
1047		1596
1048	for my $login (@$dirs) {	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") {
1049	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1603	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1050	aio_read $fh, 0, 512, my $buf, 0 or next;	1604	aio_read $fh, 0, 512, my $buf, 0 or next;
1051	$buf !~ /^password -------------$/m or next; # official not-valid tag	1605	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1606	}
1052		1607
1053	utf8::decode $login;	1608	utf8::decode $login;
1054	push @logins, $login;	1609	push @logins, $login;
1055	}	1610	}
1056		1611
…		…
1064		1619
1065	=cut	1620	=cut
1066		1621
1067	sub maps($) {	1622	sub maps($) {
1068	my ($pl) = @_;	1623	my ($pl) = @_;
		1624
		1625	$pl = ref $pl ? $pl->ob->name : $pl;
1069		1626
1070	my $files = aio_readdir playerdir $pl	1627	my $files = aio_readdir playerdir $pl
1071	or return;	1628	or return;
1072		1629
1073	my @paths;	1630	my @paths;
…		…
1075	for (@$files) {	1632	for (@$files) {
1076	utf8::decode $_;	1633	utf8::decode $_;
1077	next if /\.(?:pl|pst)$/;	1634	next if /\.(?:pl|pst)$/;
1078	next unless /^$PATH_SEP/o;	1635	next unless /^$PATH_SEP/o;
1079		1636
1080	s/\.map$//;	1637	push @paths, cf::map::normalise "~$pl/$_";
1081	push @paths, "~" . $pl->ob->name . "/" . $_;
1082	}	1638	}
1083		1639
1084	\@paths	1640	\@paths
1085	}	1641	}
1086		1642
		1643	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1644
		1645	Expand deliantra pod fragments into protocol xml.
		1646
1087	=item $player->ext_reply ($msgid, $msgtype, %msg)	1647	=item $player->ext_reply ($msgid, @msg)
1088		1648
1089	Sends an ext reply to the player.	1649	Sends an ext reply to the player.
1090		1650
1091	=cut	1651	=cut
1092		1652
1093	sub ext_reply($$$%) {	1653	sub ext_reply($$@) {
1094	my ($self, $id, %msg) = @_;	1654	my ($self, $id, @msg) = @_;
1095		1655
1096	$msg{msgid} = $id;	1656	$self->ns->ext_reply ($id, @msg)
1097
1098	$self->send ("ext " . cf::to_json \%msg);
1099	}	1657	}
1100		1658
1101	package cf;	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($) {
		1686	my ($path) = @_;
		1687
		1688	my ($match, $specificity);
		1689
		1690	for my $region (list) {
		1691	if ($region->{match} && $path =~ $region->{match}) {
		1692	($match, $specificity) = ($region, $region->specificity)
		1693	if $region->specificity > $specificity;
		1694	}
		1695	}
		1696
		1697	$match
		1698	}
1102		1699
1103	=back	1700	=back
1104
1105		1701
1106	=head3 cf::map	1702	=head3 cf::map
1107		1703
1108	=over 4	1704	=over 4
1109		1705
…		…
1121	our $MAX_RESET = 3600;	1717	our $MAX_RESET = 3600;
1122	our $DEFAULT_RESET = 3000;	1718	our $DEFAULT_RESET = 3000;
1123		1719
1124	sub generate_random_map {	1720	sub generate_random_map {
1125	my ($self, $rmp) = @_;	1721	my ($self, $rmp) = @_;
		1722
		1723	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1126		1724
1127	# mit "rum" bekleckern, nicht	1725	# mit "rum" bekleckern, nicht
1128	$self->_create_random_map (	1726	$self->_create_random_map (
1129	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1727	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1130	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1728	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
…		…
1138	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1736	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1139	(cf::region::find $rmp->{region}), $rmp->{custom}	1737	(cf::region::find $rmp->{region}), $rmp->{custom}
1140	)	1738	)
1141	}	1739	}
1142		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
1143	sub register {	1749	sub register {
1144	my (undef, $regex) = @_;	1750	my (undef, $regex, $prio) = @_;
1145	my $pkg = caller;	1751	my $pkg = caller;
1146		1752
1147	no strict;	1753	no strict;
1148	push @{"$pkg\::ISA"}, __PACKAGE__;	1754	push @{"$pkg\::ISA"}, __PACKAGE__;
1149		1755
1150	$EXT_MAP{$pkg} = qr<$regex>;	1756	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1151	}	1757	}
1152		1758
1153	# also paths starting with '/'	1759	# also paths starting with '/'
1154	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1760	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1155		1761
1156	sub thawer_merge {	1762	sub thawer_merge {
1157	my ($self, $merge) = @_;	1763	my ($self, $merge) = @_;
1158		1764
1159	# we have to keep some variables in memory intact	1765	# we have to keep some variables in memory intact
1160	local $self->{path};	1766	local $self->{path};
1161	local $self->{load_path};	1767	local $self->{load_path};
1162	local $self->{deny_save};
1163	local $self->{deny_reset};
1164		1768
1165	$self->SUPER::thawer_merge ($merge);	1769	$self->SUPER::thawer_merge ($merge);
1166	}	1770	}
1167		1771
1168	sub normalise {	1772	sub normalise {
1169	my ($path, $base) = @_;	1773	my ($path, $base) = @_;
		1774
		1775	$path = "$path"; # make sure its a string
		1776
		1777	$path =~ s/\.map$//;
1170		1778
1171	# map plan:	1779	# map plan:
1172	#	1780	#
1173	# /! non-realised random map exit (special hack!)	1781	# /! non-realised random map exit (special hack!)
1174	# {... are special paths that are not being touched	1782	# {... are special paths that are not being touched
…		…
1202		1810
1203	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1811	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1204		1812
1205	$path = normalise $path, $base;	1813	$path = normalise $path, $base;
1206		1814
1207	for my $pkg (keys %EXT_MAP) {	1815	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1208	if ($path =~ $EXT_MAP{$pkg}) {	1816	if ($path =~ $EXT_MAP{$pkg}[1]) {
1209	my $self = bless cf::map::new, $pkg;	1817	my $self = bless cf::map::new, $pkg;
1210	$self->{path} = $path; $self->path ($path);	1818	$self->{path} = $path; $self->path ($path);
1211	$self->init; # pass $1 etc.	1819	$self->init; # pass $1 etc.
1212	return $self;	1820	return $self;
1213	}	1821	}
1214	}	1822	}
1215		1823
1216	Carp::carp "unable to resolve path '$path'.";	1824	Carp::cluck "unable to resolve path '$path' (base '$base').";
1217	()	1825	()
1218	}	1826	}
1219		1827
1220	sub init {	1828	sub init {
1221	my ($self) = @_;	1829	my ($self) = @_;
…		…
1236		1844
1237	# the original (read-only) location	1845	# the original (read-only) location
1238	sub load_path {	1846	sub load_path {
1239	my ($self) = @_;	1847	my ($self) = @_;
1240		1848
1241	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1849	"$MAPDIR/$self->{path}.map"
1242	}	1850	}
1243		1851
1244	# the temporary/swap location	1852	# the temporary/swap location
1245	sub save_path {	1853	sub save_path {
1246	my ($self) = @_;	1854	my ($self) = @_;
1247		1855
1248	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1856	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1249	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1857	"$TMPDIR/$path.map"
1250	}	1858	}
1251		1859
1252	# the unique path, undef == no special unique path	1860	# the unique path, undef == no special unique path
1253	sub uniq_path {	1861	sub uniq_path {
1254	my ($self) = @_;	1862	my ($self) = @_;
1255		1863
1256	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1864	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1257	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1865	"$UNIQUEDIR/$path"
1258	}	1866	}
1259		1867
1260	# and all this just because we cannot iterate over	1868	# and all this just because we cannot iterate over
1261	# all maps in C++...	1869	# all maps in C++...
1262	sub change_all_map_light {	1870	sub change_all_map_light {
…		…
1264		1872
1265	$_->change_map_light ($change)	1873	$_->change_map_light ($change)
1266	for grep $_->outdoor, values %cf::MAP;	1874	for grep $_->outdoor, values %cf::MAP;
1267	}	1875	}
1268		1876
		1877	sub decay_objects {
		1878	my ($self) = @_;
		1879
		1880	return if $self->{deny_reset};
		1881
		1882	$self->do_decay_objects;
		1883	}
		1884
1269	sub unlink_save {	1885	sub unlink_save {
1270	my ($self) = @_;	1886	my ($self) = @_;
1271		1887
1272	utf8::encode (my $save = $self->save_path);	1888	utf8::encode (my $save = $self->save_path);
1273	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1889	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1276		1892
1277	sub load_header_from($) {	1893	sub load_header_from($) {
1278	my ($self, $path) = @_;	1894	my ($self, $path) = @_;
1279		1895
1280	utf8::encode $path;	1896	utf8::encode $path;
1281	aio_open $path, O_RDONLY, 0	1897	my $f = new_from_file cf::object::thawer $path
1282	or return;	1898	or return;
1283		1899
1284	$self->_load_header ($path)	1900	$self->_load_header ($f)
1285	or return;	1901	or return;
1286		1902
		1903	local $MAP_LOADING{$self->{path}} = $self;
		1904	$f->resolve_delayed_derefs;
		1905
1287	$self->{load_path} = $path;	1906	$self->{load_path} = $path;
1288		1907
1289	1	1908	1
1290	}	1909	}
1291		1910
1292	sub load_orig {	1911	sub load_header_orig {
1293	my ($self) = @_;	1912	my ($self) = @_;
1294		1913
1295	$self->load_header_from ($self->load_path)	1914	$self->load_header_from ($self->load_path)
1296	}	1915	}
1297		1916
1298	sub load_temp {	1917	sub load_header_temp {
1299	my ($self) = @_;	1918	my ($self) = @_;
1300		1919
1301	$self->load_header_from ($self->save_path)	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;
1302	}	1940	}
1303		1941
1304	sub load_header {	1942	sub load_header {
1305	my ($self) = @_;	1943	my ($self) = @_;
1306		1944
1307	if ($self->load_temp) {	1945	if ($self->load_header_temp) {
1308	$self->last_access ((delete $self->{last_access})	1946	$self->prepare_temp;
1309	|| $cf::RUNTIME); #d#
1310	# safety
1311	$self->{instantiate_time} = $cf::RUNTIME
1312	if $self->{instantiate_time} > $cf::RUNTIME;
1313	} else {	1947	} else {
1314	$self->load_orig	1948	$self->load_header_orig
1315	or return;	1949	or return;
1316		1950	$self->prepare_orig;
1317	$self->{load_original} = 1;
1318	$self->{instantiate_time} = $cf::RUNTIME;
1319	$self->last_access ($cf::RUNTIME);
1320	$self->instantiate;
1321	}	1951	}
		1952
		1953	$self->{deny_reset} = 1
		1954	if $self->no_reset;
		1955
		1956	$self->default_region (cf::region::find_by_path $self->{path})
		1957	unless $self->default_region;
1322		1958
1323	1	1959	1
1324	}	1960	}
1325		1961
1326	sub find;	1962	sub find;
1327	sub find {	1963	sub find {
1328	my ($path, $origin) = @_;	1964	my ($path, $origin) = @_;
1329		1965
1330	$path = normalise $path, $origin && $origin->path;	1966	$path = normalise $path, $origin && $origin->path;
1331		1967
		1968	cf::lock_wait "map_data:$path";#d#remove
1332	cf::lock_wait "map_find:$path";	1969	cf::lock_wait "map_find:$path";
1333		1970
1334	$cf::MAP{$path} || do {	1971	$cf::MAP{$path} || do {
		1972	my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1335	my $guard = cf::lock_acquire "map_find:$path";	1973	my $guard2 = cf::lock_acquire "map_find:$path";
		1974
1336	my $map = new_from_path cf::map $path	1975	my $map = new_from_path cf::map $path
1337	or return;	1976	or return;
1338		1977
1339	$map->{last_save} = $cf::RUNTIME;	1978	$map->{last_save} = $cf::RUNTIME;
1340		1979
1341	$map->load_header	1980	$map->load_header
1342	or return;	1981	or return;
1343		1982
1344	if ($map->should_reset) {	1983	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1984	# doing this can freeze the server in a sync job, obviously
1345	$cf::WAIT_FOR_TICK->wait;	1985	#$cf::WAIT_FOR_TICK->wait;
		1986	undef $guard2;
		1987	undef $guard1;
1346	$map->reset;	1988	$map->reset;
1347	undef $guard;
1348	$map = find $path	1989	return find $path;
1349	or return;
1350	}	1990	}
1351		1991
1352	$cf::MAP{$path} = $map	1992	$cf::MAP{$path} = $map
1353	}	1993	}
1354	}	1994	}
		1995
		1996	sub pre_load { }
		1997	sub post_load { }
1355		1998
1356	sub load {	1999	sub load {
1357	my ($self) = @_;	2000	my ($self) = @_;
1358		2001
		2002	local $self->{deny_reset} = 1; # loading can take a long time
		2003
1359	my $path = $self->{path};	2004	my $path = $self->{path};
		2005
		2006	{
1360	my $guard = cf::lock_acquire "map_load:$path";	2007	my $guard = cf::lock_acquire "map_data:$path";
1361		2008
		2009	return unless $self->valid;
1362	return if $self->in_memory != cf::MAP_SWAPPED;	2010	return unless $self->in_memory == cf::MAP_SWAPPED;
1363		2011
1364	$self->in_memory (cf::MAP_LOADING);	2012	$self->in_memory (cf::MAP_LOADING);
1365		2013
1366	$self->alloc;	2014	$self->alloc;
1367	$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)
1368	or return;	2022	or return;
1369		2023
1370	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2024	$self->post_load_original
1371	if delete $self->{load_original};	2025	if delete $self->{load_original};
1372		2026
1373	if (my $uniq = $self->uniq_path) {	2027	if (my $uniq = $self->uniq_path) {
1374	utf8::encode $uniq;	2028	utf8::encode $uniq;
1375	if (aio_open $uniq, O_RDONLY, 0) {	2029	unless (aio_stat $uniq) {
		2030	if (my $f = new_from_file cf::object::thawer $uniq) {
1376	$self->clear_unique_items;	2031	$self->clear_unique_items;
1377	$self->_load_objects ($uniq, 0);	2032	$self->_load_objects ($f);
		2033	$f->resolve_delayed_derefs;
		2034	}
1378	}	2035	}
1379	}	2036	}
1380		2037
1381	Coro::cede;	2038	$f->resolve_delayed_derefs;
1382		2039
		2040	cf::cede_to_tick;
1383	# now do the right thing for maps	2041	# now do the right thing for maps
1384	$self->link_multipart_objects;	2042	$self->link_multipart_objects;
1385
1386	unless ($self->{deny_activate}) {
1387	$self->decay_objects;
1388	$self->fix_auto_apply;
1389	$self->update_buttons;
1390	Coro::cede;
1391	$self->set_darkness_map;
1392	$self->difficulty ($self->estimate_difficulty)	2043	$self->difficulty ($self->estimate_difficulty)
1393	unless $self->difficulty;	2044	unless $self->difficulty;
1394	Coro::cede;	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;
1395	$self->activate;	2054	$self->activate;
1396	}	2055	}
1397		2056
		2057	$self->{last_save} = $cf::RUNTIME;
		2058	$self->last_access ($cf::RUNTIME);
		2059
1398	$self->in_memory (cf::MAP_IN_MEMORY);	2060	$self->in_memory (cf::MAP_ACTIVE);
		2061	}
		2062
		2063	$self->post_load;
1399	}	2064	}
1400		2065
1401	sub customise_for {	2066	sub customise_for {
1402	my ($self, $ob) = @_;	2067	my ($self, $ob) = @_;
1403		2068
1404	return find "~" . $ob->name . "/" . $self->{path}	2069	return find "~" . $ob->name . "/" . $self->{path}
1405	if $self->per_player;	2070	if $self->per_player;
1406		2071
		2072	# return find "?party/" . $ob->name . "/" . $self->{path}
		2073	# if $self->per_party;
		2074
1407	$self	2075	$self
1408	}	2076	}
1409		2077
1410	# find and load all maps in the 3x3 area around a map	2078	# find and load all maps in the 3x3 area around a map
1411	sub load_diag {	2079	sub load_neighbours {
1412	my ($map) = @_;	2080	my ($map) = @_;
1413		2081
1414	my @diag; # diagonal neighbours	2082	my @neigh; # diagonal neighbours
1415		2083
1416	for (0 .. 3) {	2084	for (0 .. 3) {
1417	my $neigh = $map->tile_path ($_)	2085	my $neigh = $map->tile_path ($_)
1418	or next;	2086	or next;
1419	$neigh = find $neigh, $map	2087	$neigh = find $neigh, $map
1420	or next;	2088	or next;
1421	$neigh->load;	2089	$neigh->load;
1422		2090
		2091	push @neigh,
1423	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2092	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1424	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2093	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1425	}	2094	}
1426		2095
1427	for (@diag) {	2096	for (grep defined $_->[0], @neigh) {
		2097	my ($path, $origin) = @$_;
1428	my $neigh = find @$_	2098	my $neigh = find $path, $origin
1429	or next;	2099	or next;
1430	$neigh->load;	2100	$neigh->load;
1431	}	2101	}
1432	}	2102	}
1433		2103
…		…
1438	}	2108	}
1439		2109
1440	sub do_load_sync {	2110	sub do_load_sync {
1441	my ($map) = @_;	2111	my ($map) = @_;
1442		2112
		2113	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2114	if $Coro::current == $Coro::main;
		2115
1443	cf::sync_job { $map->load };	2116	cf::sync_job { $map->load };
1444	}	2117	}
1445		2118
1446	our %MAP_PREFETCH;	2119	our %MAP_PREFETCH;
1447	our $MAP_PREFETCHER = Coro::async {	2120	our $MAP_PREFETCHER = undef;
1448	while () {
1449	for my $path (keys %MAP_PREFETCH) {
1450	my $map = find $path
1451	or next;
1452	$map->load;
1453
1454	delete $MAP_PREFETCH{$path};
1455	}
1456	Coro::schedule;
1457	}
1458	};
1459		2121
1460	sub find_async {	2122	sub find_async {
1461	my ($path, $origin) = @_;	2123	my ($path, $origin, $load) = @_;
1462		2124
1463	$path = normalise $path, $origin && $origin->{path};	2125	$path = normalise $path, $origin && $origin->{path};
1464		2126
1465	if (my $map = $cf::MAP{$path}) {	2127	if (my $map = $cf::MAP{$path}) {
1466	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	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;
1467	}	2146	};
1468
1469	$MAP_PREFETCH{$path} = 0;
1470	$MAP_PREFETCHER->ready;	2147	$MAP_PREFETCHER->prio (6);
1471		2148
1472	()	2149	()
1473	}	2150	}
1474		2151
1475	sub save {	2152	sub save {
1476	my ($self) = @_;	2153	my ($self) = @_;
1477		2154
1478	my $lock = cf::lock_acquire "map_data:" . $self->path;	2155	my $lock = cf::lock_acquire "map_data:$self->{path}";
1479		2156
1480	$self->{last_save} = $cf::RUNTIME;	2157	$self->{last_save} = $cf::RUNTIME;
1481		2158
1482	return unless $self->dirty;	2159	return unless $self->dirty;
1483		2160
…		…
1489	return if $self->{deny_save};	2166	return if $self->{deny_save};
1490		2167
1491	local $self->{last_access} = $self->last_access;#d#	2168	local $self->{last_access} = $self->last_access;#d#
1492		2169
1493	cf::async {	2170	cf::async {
		2171	$Coro::current->{desc} = "map player save";
1494	$_->contr->save for $self->players;	2172	$_->contr->save for $self->players;
1495	};	2173	};
		2174
		2175	cf::get_slot 0.02;
1496		2176
1497	if ($uniq) {	2177	if ($uniq) {
1498	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2178	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1499	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2179	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1500	} else {	2180	} else {
…		…
1506	my ($self) = @_;	2186	my ($self) = @_;
1507		2187
1508	# save first because save cedes	2188	# save first because save cedes
1509	$self->save;	2189	$self->save;
1510		2190
1511	my $lock = cf::lock_acquire "map_data:" . $self->path;	2191	my $lock = cf::lock_acquire "map_data:$self->{path}";
1512		2192
1513	return if $self->players;	2193	return if $self->players;
1514	return if $self->in_memory != cf::MAP_IN_MEMORY;	2194	return if $self->in_memory != cf::MAP_ACTIVE;
1515	return if $self->{deny_save};	2195	return if $self->{deny_save};
1516		2196
		2197	$self->in_memory (cf::MAP_SWAPPED);
		2198
		2199	$self->deactivate;
		2200	$_->clear_links_to ($self) for values %cf::MAP;
1517	$self->clear;	2201	$self->clear;
1518	$self->in_memory (cf::MAP_SWAPPED);
1519	}	2202	}
1520		2203
1521	sub reset_at {	2204	sub reset_at {
1522	my ($self) = @_;	2205	my ($self) = @_;
1523		2206
1524	# TODO: safety, remove and allow resettable per-player maps	2207	# TODO: safety, remove and allow resettable per-player maps
1525	return 1e99 if $self->isa ("ext::map_per_player");#d#
1526	return 1e99 if $self->{deny_reset};	2208	return 1e99 if $self->{deny_reset};
1527		2209
1528	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2210	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1529	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;
1530		2212
…		…
1541	my ($self) = @_;	2223	my ($self) = @_;
1542		2224
1543	my $lock = cf::lock_acquire "map_data:$self->{path}";	2225	my $lock = cf::lock_acquire "map_data:$self->{path}";
1544		2226
1545	return if $self->players;	2227	return if $self->players;
1546	return if $self->isa ("ext::map_per_player");#d#
1547		2228
1548	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	}
1549		2240
1550	delete $cf::MAP{$self->path};	2241	delete $cf::MAP{$self->path};
1551		2242
1552	$self->in_memory (cf::MAP_SWAPPED);	2243	$self->deactivate;
		2244	$_->clear_links_to ($self) for values %cf::MAP;
1553	$self->clear;	2245	$self->clear;
1554
1555	$_->clear_links_to ($self) for values %cf::MAP;
1556		2246
1557	$self->unlink_save;	2247	$self->unlink_save;
1558	$self->destroy;	2248	$self->destroy;
1559	}	2249	}
1560		2250
1561	my $nuke_counter = "aaaa";	2251	my $nuke_counter = "aaaa";
1562		2252
1563	sub nuke {	2253	sub nuke {
1564	my ($self) = @_;	2254	my ($self) = @_;
1565		2255
		2256	{
		2257	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2258
1566	delete $cf::MAP{$self->path};	2259	delete $cf::MAP{$self->path};
1567		2260
1568	$self->unlink_save;	2261	$self->unlink_save;
1569		2262
1570	bless $self, "cf::map";	2263	bless $self, "cf::map";
1571	delete $self->{deny_reset};	2264	delete $self->{deny_reset};
1572	$self->{deny_save} = 1;	2265	$self->{deny_save} = 1;
1573	$self->reset_timeout (1);	2266	$self->reset_timeout (1);
1574	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2267	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1575		2268
1576	$cf::MAP{$self->path} = $self;	2269	$cf::MAP{$self->path} = $self;
		2270	}
1577		2271
1578	$self->reset; # polite request, might not happen	2272	$self->reset; # polite request, might not happen
		2273	}
		2274
		2275	=item $maps = cf::map::tmp_maps
		2276
		2277	Returns an arrayref with all map paths of currently instantiated and saved
		2278	maps. May block.
		2279
		2280	=cut
		2281
		2282	sub tmp_maps() {
		2283	[
		2284	map {
		2285	utf8::decode $_;
		2286	/\.map$/
		2287	? normalise $_
		2288	: ()
		2289	} @{ aio_readdir $TMPDIR or [] }
		2290	]
		2291	}
		2292
		2293	=item $maps = cf::map::random_maps
		2294
		2295	Returns an arrayref with all map paths of currently instantiated and saved
		2296	random maps. May block.
		2297
		2298	=cut
		2299
		2300	sub random_maps() {
		2301	[
		2302	map {
		2303	utf8::decode $_;
		2304	/\.map$/
		2305	? normalise "?random/$_"
		2306	: ()
		2307	} @{ aio_readdir $RANDOMDIR or [] }
		2308	]
1579	}	2309	}
1580		2310
1581	=item cf::map::unique_maps	2311	=item cf::map::unique_maps
1582		2312
1583	Returns an arrayref of paths of all shared maps that have	2313	Returns an arrayref of paths of all shared maps that have
1584	instantiated unique items. May block.	2314	instantiated unique items. May block.
1585		2315
1586	=cut	2316	=cut
1587		2317
1588	sub unique_maps() {	2318	sub unique_maps() {
1589	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2319	[
1590	or return;	2320	map {
1591
1592	my @paths;
1593
1594	for (@$files) {
1595	utf8::decode $_;	2321	utf8::decode $_;
1596	next if /\.pst$/;	2322	s/\.map$//; # TODO future compatibility hack
1597	next unless /^$PATH_SEP/o;	2323	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1598		2324	? ()
1599	s/\.map$//;	2325	: normalise $_
1600	push @paths, $_;	2326	} @{ aio_readdir $UNIQUEDIR or [] }
1601	}	2327	]
1602
1603	\@paths
1604	}	2328	}
1605
1606	package cf;
1607		2329
1608	=back	2330	=back
1609		2331
1610	=head3 cf::object	2332	=head3 cf::object
1611		2333
…		…
1615		2337
1616	=over 4	2338	=over 4
1617		2339
1618	=item $ob->inv_recursive	2340	=item $ob->inv_recursive
1619		2341
1620	Returns the inventory of the object _and_ their inventories, recursively.	2342	Returns the inventory of the object I<and> their inventories, recursively,
		2343	but I<not> the object itself.
1621		2344
1622	=cut	2345	=cut
1623		2346
1624	sub inv_recursive_;	2347	sub inv_recursive_;
1625	sub inv_recursive_ {	2348	sub inv_recursive_ {
…		…
1628		2351
1629	sub inv_recursive {	2352	sub inv_recursive {
1630	inv_recursive_ inv $_[0]	2353	inv_recursive_ inv $_[0]
1631	}	2354	}
1632		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
		2381	}
		2382	}
		2383
1633	package cf;	2384	package cf;
1634		2385
1635	=back	2386	=back
1636		2387
1637	=head3 cf::object::player	2388	=head3 cf::object::player
…		…
1643	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>
1644	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
1645	dialogue with the given NPC character.	2396	dialogue with the given NPC character.
1646		2397
1647	=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	};
1648		2413
1649	# rough implementation of a future "reply" method that works	2414	# rough implementation of a future "reply" method that works
1650	# with dialog boxes.	2415	# with dialog boxes.
1651	#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
1652	sub cf::object::player::reply($$$;$) {	2417	sub cf::object::player::reply($$$;$) {
…		…
1654		2419
1655	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2420	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1656		2421
1657	if ($self->{record_replies}) {	2422	if ($self->{record_replies}) {
1658	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2423	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2424
1659	} 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 {
1660	$msg = $npc->name . " says: $msg" if $npc;	2433	$msg = $npc->name . " says: $msg" if $npc;
1661	$self->message ($msg, $flags);	2434	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2435	}
1662	}	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 (@_);
1663	}	2447	}
1664		2448
1665	=item $player_object->may ("access")	2449	=item $player_object->may ("access")
1666		2450
1667	Returns wether the given player is authorized to access resource "access"	2451	Returns wether the given player is authorized to access resource "access"
…		…
1680		2464
1681	=item $player_object->enter_link	2465	=item $player_object->enter_link
1682		2466
1683	Freezes the player and moves him/her to a special map (C<{link}>).	2467	Freezes the player and moves him/her to a special map (C<{link}>).
1684		2468
1685	The player should be reasonably safe there for short amounts of time. You	2469	The player should be reasonably safe there for short amounts of time (e.g.
1686	I<MUST> call C<leave_link> as soon as possible, though.	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.
1687		2473
1688	Will never block.	2474	Will never block.
1689		2475
1690	=item $player_object->leave_link ($map, $x, $y)	2476	=item $player_object->leave_link ($map, $x, $y)
1691		2477
…		…
1699	=cut	2485	=cut
1700		2486
1701	sub link_map {	2487	sub link_map {
1702	unless ($LINK_MAP) {	2488	unless ($LINK_MAP) {
1703	$LINK_MAP = cf::map::find "{link}"	2489	$LINK_MAP = cf::map::find "{link}"
1704	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2490	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1705	$LINK_MAP->load;	2491	$LINK_MAP->load;
1706	}	2492	}
1707		2493
1708	$LINK_MAP	2494	$LINK_MAP
1709	}	2495	}
…		…
1714	$self->deactivate_recursive;	2500	$self->deactivate_recursive;
1715		2501
1716	return if UNIVERSAL::isa $self->map, "ext::map_link";	2502	return if UNIVERSAL::isa $self->map, "ext::map_link";
1717		2503
1718	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2504	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1719	if $self->map;	2505	if $self->map && $self->map->{path} ne "{link}";
1720		2506
1721	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2507	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1722	}	2508	}
1723		2509
1724	sub cf::object::player::leave_link {	2510	sub cf::object::player::leave_link {
1725	my ($self, $map, $x, $y) = @_;	2511	my ($self, $map, $x, $y) = @_;
		2512
		2513	return unless $self->contr->active;
1726		2514
1727	my $link_pos = delete $self->{_link_pos};	2515	my $link_pos = delete $self->{_link_pos};
1728		2516
1729	unless ($map) {	2517	unless ($map) {
1730	# restore original map position	2518	# restore original map position
…		…
1744	# use -1 or undef as default coordinates, not 0, 0	2532	# use -1 or undef as default coordinates, not 0, 0
1745	($x, $y) = ($map->enter_x, $map->enter_y)	2533	($x, $y) = ($map->enter_x, $map->enter_y)
1746	if $x <=0 && $y <= 0;	2534	if $x <=0 && $y <= 0;
1747		2535
1748	$map->load;	2536	$map->load;
1749	$map->load_diag;	2537	$map->load_neighbours;
1750		2538
1751	return unless $self->contr->active;	2539	return unless $self->contr->active;
		2540	$self->flag (cf::FLAG_DEBUG, 0);#d# temp
1752	$self->activate_recursive;	2541	$self->activate_recursive;
		2542
		2543	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1753	$self->enter_map ($map, $x, $y);	2544	$self->enter_map ($map, $x, $y);
1754	}	2545	}
1755		2546
1756	cf::player->attach (	2547	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1757	on_logout => sub {
1758	my ($pl) = @_;
1759		2548
1760	# abort map switching before logout	2549	Moves the player to the given map-path and coordinates by first freezing
1761	if ($pl->ob->{_link_pos}) {	2550	her, loading and preparing them map, calling the provided $check callback
1762	cf::sync_job {	2551	that has to return the map if sucecssful, and then unfreezes the player on
1763	$pl->ob->leave_link	2552	the new (success) or old (failed) map position. In either case, $done will
1764	};	2553	be called at the end of this process.
1765	}
1766	},
1767	on_login => sub {
1768	my ($pl) = @_;
1769		2554
1770	# try to abort aborted map switching on player login :)	2555	Note that $check will be called with a potentially non-loaded map, so if
1771	# should happen only on crashes	2556	it needs a loaded map it has to call C<< ->load >>.
1772	if ($pl->ob->{_link_pos}) {
1773	$pl->ob->enter_link;
1774	(async {
1775	# we need this sleep as the login has a concurrent enter_exit running
1776	# and this sleep increases chances of the player not ending up in scorn
1777	$pl->ob->reply (undef,
1778	"There was an internal problem at your last logout, "
1779	. "the server will try to bring you to your intended destination in a second.",
1780	cf::NDI_RED);
1781	Coro::Timer::sleep 1;
1782	$pl->ob->leave_link;
1783	})->prio (2);
1784	}
1785	},
1786	);
1787		2557
1788	=item $player_object->goto ($path, $x, $y)
1789
1790	=cut	2558	=cut
		2559
		2560	our $GOTOGEN;
1791		2561
1792	sub cf::object::player::goto {	2562	sub cf::object::player::goto {
1793	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;
1794		2567
1795	$self->enter_link;	2568	$self->enter_link;
1796		2569
1797	(async {	2570	(async {
1798	my $map = cf::map::find $path;	2571	$Coro::current->{desc} = "player::goto $path $x $y";
		2572
		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) {
1799	$map = $map->customise_for ($self) if $map;	2596	$map = $map->customise_for ($self);
1800		2597	$map = $check->($map) if $check && $map;
1801	# warn "entering ", $map->path, " at ($x, $y)\n"	2598	} else {
1802	# if $map;
1803
1804	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2599	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2600	}
1805		2601
		2602	$map
		2603	};
		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};
1806	$self->leave_link ($map, $x, $y);	2612	$self->leave_link ($map, $x, $y);
		2613	}
		2614
		2615	$done->() if $done;
1807	})->prio (1);	2616	})->prio (1);
1808	}	2617	}
1809		2618
1810	=item $player_object->enter_exit ($exit_object)	2619	=item $player_object->enter_exit ($exit_object)
1811		2620
…		…
1813		2622
1814	sub parse_random_map_params {	2623	sub parse_random_map_params {
1815	my ($spec) = @_;	2624	my ($spec) = @_;
1816		2625
1817	my $rmp = { # defaults	2626	my $rmp = { # defaults
1818	xsize => 10,	2627	xsize => (cf::rndm 15, 40),
1819	ysize => 10,	2628	ysize => (cf::rndm 15, 40),
		2629	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2630	#layout => string,
1820	};	2631	};
1821		2632
1822	for (split /\n/, $spec) {	2633	for (split /\n/, $spec) {
1823	my ($k, $v) = split /\s+/, $_, 2;	2634	my ($k, $v) = split /\s+/, $_, 2;
1824		2635
…		…
1836	# that depends on the exit object	2647	# that depends on the exit object
1837		2648
1838	my $rmp = parse_random_map_params $exit->msg;	2649	my $rmp = parse_random_map_params $exit->msg;
1839		2650
1840	if ($exit->map) {	2651	if ($exit->map) {
1841	$rmp->{region} = $exit->map->region_name;	2652	$rmp->{region} = $exit->region->name;
1842	$rmp->{origin_map} = $exit->map->path;	2653	$rmp->{origin_map} = $exit->map->path;
1843	$rmp->{origin_x} = $exit->x;	2654	$rmp->{origin_x} = $exit->x;
1844	$rmp->{origin_y} = $exit->y;	2655	$rmp->{origin_y} = $exit->y;
		2656
		2657	$exit->map->touch;
1845	}	2658	}
1846		2659
1847	$rmp->{random_seed} ||= $exit->random_seed;	2660	$rmp->{random_seed} ||= $exit->random_seed;
1848		2661
1849	my $data = cf::to_json $rmp;	2662	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1850	my $md5 = Digest::MD5::md5_hex $data;	2663	my $md5 = Digest::MD5::md5_hex $data;
		2664	my $meta = "$RANDOMDIR/$md5.meta";
1851		2665
1852	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) {
1853	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;
1854		2670
		2671	my $slaying = "?random/$md5";
		2672
		2673	if ($exit->valid) {
1855	$exit->slaying ("?random/$md5");	2674	$exit->slaying ("?random/$md5");
1856	$exit->msg (undef);	2675	$exit->msg (undef);
		2676	}
1857	}	2677	}
1858	}	2678	}
1859		2679
1860	sub cf::object::player::enter_exit {	2680	sub cf::object::player::enter_exit {
1861	my ($self, $exit) = @_;	2681	my ($self, $exit) = @_;
…		…
1863	return unless $self->type == cf::PLAYER;	2683	return unless $self->type == cf::PLAYER;
1864		2684
1865	$self->enter_link;	2685	$self->enter_link;
1866		2686
1867	(async {	2687	(async {
1868	$self->deactivate_recursive; # just to be sure	2688	$Coro::current->{desc} = "enter_exit";
		2689
1869	unless (eval {	2690	unless (eval {
		2691	$self->deactivate_recursive; # just to be sure
		2692
		2693	# random map handling
		2694	{
		2695	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2696
1870	prepare_random_map $exit	2697	prepare_random_map $exit
1871	if $exit->slaying eq "/!";	2698	if $exit->slaying eq "/!";
		2699	}
1872		2700
1873	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;	2701	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1874	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);	2702	my $x = $exit->stats->hp;
		2703	my $y = $exit->stats->sp;
1875		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
1876	1;	2711	1
1877	}) {	2712	}) {
1878	$self->message ("Something went wrong deep within the crossfire server. "	2713	$self->message ("Something went wrong deep within the deliantra server. "
1879	. "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. "
1880	. "Please report this to the dungeon master!",	2715	. "Please report this to the dungeon master!",
1881	cf::NDI_UNIQUE | cf::NDI_RED);	2716	cf::NDI_UNIQUE | cf::NDI_RED);
1882		2717
1883	warn "ERROR in enter_exit: $@";	2718	warn "ERROR in enter_exit: $@";
1884	$self->leave_link;	2719	$self->leave_link;
1885	}	2720	}
1886	})->prio (1);	2721	})->prio (1);
…		…
1899		2734
1900	sub cf::client::send_drawinfo {	2735	sub cf::client::send_drawinfo {
1901	my ($self, $text, $flags) = @_;	2736	my ($self, $text, $flags) = @_;
1902		2737
1903	utf8::encode $text;	2738	utf8::encode $text;
1904	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2739	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1905	}	2740	}
1906		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	}
1907		2921
1908	=item $success = $client->query ($flags, "text", \&cb)	2922	=item $success = $client->query ($flags, "text", \&cb)
1909		2923
1910	Queues a query to the client, calling the given callback with	2924	Queues a query to the client, calling the given callback with
1911	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2925	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1912	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2926	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1913		2927
1914	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
1915	reliable at some point in the future.	2929	become reliable at some point in the future.
1916		2930
1917	=cut	2931	=cut
1918		2932
1919	sub cf::client::query {	2933	sub cf::client::query {
1920	my ($self, $flags, $text, $cb) = @_;	2934	my ($self, $flags, $text, $cb) = @_;
…		…
1928	utf8::encode $text;	2942	utf8::encode $text;
1929	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2943	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1930		2944
1931	$self->send_packet ($self->{query_queue}[0][0])	2945	$self->send_packet ($self->{query_queue}[0][0])
1932	if @{ $self->{query_queue} } == 1;	2946	if @{ $self->{query_queue} } == 1;
		2947
		2948	1
1933	}	2949	}
1934		2950
1935	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	},
1936	on_reply => sub {	2957	on_reply => sub {
1937	my ($ns, $msg) = @_;	2958	my ($ns, $msg) = @_;
1938		2959
1939	# this weird shuffling is so that direct followup queries	2960	# this weird shuffling is so that direct followup queries
1940	# get handled first	2961	# get handled first
1941	my $queue = delete $ns->{query_queue}	2962	my $queue = delete $ns->{query_queue}
1942	or return; # be conservative, not sure how that can happen, but we saw a crash here	2963	or return; # be conservative, not sure how that can happen, but we saw a crash here
1943		2964
1944	(shift @$queue)->[1]->($msg);	2965	(shift @$queue)->[1]->($msg);
		2966	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1945		2967
1946	push @{ $ns->{query_queue} }, @$queue;	2968	push @{ $ns->{query_queue} }, @$queue;
1947		2969
1948	if (@{ $ns->{query_queue} } == @$queue) {	2970	if (@{ $ns->{query_queue} } == @$queue) {
1949	if (@$queue) {	2971	if (@$queue) {
…		…
1951	} else {	2973	} else {
1952	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2974	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1953	}	2975	}
1954	}	2976	}
1955	},	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	},
1956	);	3004	);
1957		3005
1958	=item $client->async (\&cb)	3006	=item $client->async (\&cb)
1959		3007
1960	Create a new coroutine, running the specified callback. The coroutine will	3008	Create a new coroutine, running the specified callback. The coroutine will
…		…
2001	our $safe = new Safe "safe";	3049	our $safe = new Safe "safe";
2002	our $safe_hole = new Safe::Hole;	3050	our $safe_hole = new Safe::Hole;
2003		3051
2004	$SIG{FPE} = 'IGNORE';	3052	$SIG{FPE} = 'IGNORE';
2005		3053
2006	$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	));
2007		3059
2008	# here we export the classes and methods available to script code	3060	# here we export the classes and methods available to script code
2009		3061
2010	=pod	3062	=pod
2011		3063
2012	The following fucntions and emthods are available within a safe environment:	3064	The following functions and methods are available within a safe environment:
2013		3065
2014	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
2015	cf::object::player player	3070	cf::object::player
2016	cf::player peaceful	3071	player
2017	cf::map trigger	3072
		3073	cf::player
		3074	peaceful
		3075
		3076	cf::map
		3077	trigger
2018		3078
2019	=cut	3079	=cut
2020		3080
2021	for (	3081	for (
2022	["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)],
2023	["cf::object::player" => qw(player)],	3085	["cf::object::player" => qw(player)],
2024	["cf::player" => qw(peaceful)],	3086	["cf::player" => qw(peaceful)],
2025	["cf::map" => qw(trigger)],	3087	["cf::map" => qw(trigger)],
2026	) {	3088	) {
2027	no strict 'refs';	3089	no strict 'refs';
…		…
2098	=back	3160	=back
2099		3161
2100	=cut	3162	=cut
2101		3163
2102	#############################################################################	3164	#############################################################################
		3165	# the server's init and main functions
2103		3166
2104	=head2 EXTENSION DATABASE SUPPORT	3167	sub load_facedata($) {
		3168	my ($path) = @_;
2105		3169
2106	Crossfire maintains a very simple database for extension use. It can	3170	# HACK to clear player env face cache, we need some signal framework
2107	currently store anything that can be serialised using Storable, which	3171	# for this (global event?)
2108	excludes objects.	3172	%ext::player_env::MUSIC_FACE_CACHE = ();
2109		3173
2110	The parameter C<$family> should best start with the name of the extension	3174	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2111	using it, it should be unique.
2112		3175
2113	=over 4	3176	warn "loading facedata from $path\n";
2114		3177
2115	=item $hashref = cf::db_get $family	3178	my $facedata;
		3179	0 < aio_load $path, $facedata
		3180	or die "$path: $!";
2116		3181
2117	Return a hashref for use by the extension C<$family>, which can be	3182	$facedata = Coro::Storable::thaw $facedata;
2118	modified. After modifications, you have to call C<cf::db_dirty> or
2119	C<cf::db_sync>.
2120		3183
2121	=item $value = cf::db_get $family => $key	3184	$facedata->{version} == 2
		3185	or cf::cleanup "$path: version mismatch, cannot proceed.";
2122		3186
2123	Returns a single value from the database	3187	# patch in the exptable
2124		3188	$facedata->{resource}{"res/exp_table"} = {
2125	=item cf::db_put $family => $hashref	3189	type => FT_RSRC,
2126		3190	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2127	Stores the given family hashref into the database. Updates are delayed, if
2128	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2129
2130	=item cf::db_put $family => $key => $value
2131
2132	Stores the given C<$value> in the family hash. Updates are delayed, if you
2133	want the data to be synced to disk immediately, use C<cf::db_sync>.
2134
2135	=item cf::db_dirty
2136
2137	Marks the database as dirty, to be updated at a later time.
2138
2139	=item cf::db_sync
2140
2141	Immediately write the database to disk I<if it is dirty>.
2142
2143	=cut
2144
2145	our $DB;
2146
2147	{
2148	my $path = cf::localdir . "/database.pst";
2149
2150	sub db_load() {
2151	$DB = stat $path ? Storable::retrieve $path : { };
2152	}
2153
2154	my $pid;
2155
2156	sub db_save() {
2157	waitpid $pid, 0 if $pid;
2158	if (0 == ($pid = fork)) {
2159	$DB->{_meta}{version} = 1;
2160	Storable::nstore $DB, "$path~";
2161	rename "$path~", $path;
2162	cf::_exit 0 if defined $pid;
2163	}
2164	}
2165
2166	my $dirty;
2167
2168	sub db_sync() {
2169	db_save if $dirty;
2170	undef $dirty;
2171	}
2172
2173	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2174	db_sync;
2175	});	3191	};
		3192	cf::cede_to_tick;
2176		3193
2177	sub db_dirty() {
2178	$dirty = 1;
2179	$idle->start;
2180	}	3194	{
		3195	my $faces = $facedata->{faceinfo};
2181		3196
2182	sub db_get($;$) {	3197	while (my ($face, $info) = each %$faces) {
2183	@_ >= 2	3198	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2184	? $DB->{$_[0]}{$_[1]}
2185	: ($DB->{$_[0]} ||= { })
2186	}
2187		3199
2188	sub db_put($$;$) {	3200	cf::face::set_visibility $idx, $info->{visibility};
2189	if (@_ >= 3) {	3201	cf::face::set_magicmap $idx, $info->{magicmap};
2190	$DB->{$_[0]}{$_[1]} = $_[2];	3202	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2191	} else {	3203	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2192	$DB->{$_[0]} = $_[1];
2193	}
2194	db_dirty;
2195	}
2196		3204
2197	cf::global->attach (	3205	cf::cede_to_tick;
2198	prio => 10000,
2199	on_cleanup => sub {
2200	db_sync;
2201	},	3206	}
2202	);
2203	}
2204		3207
2205	#############################################################################	3208	while (my ($face, $info) = each %$faces) {
2206	# the server's main()	3209	next unless $info->{smooth};
2207		3210
2208	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 {
2209	open my $fh, "<:utf8", cf::confdir . "/config"	3361	open my $fh, "<:utf8", "$CONFDIR/config"
2210	or return;	3362	or return;
2211		3363
2212	local $/;	3364	local $/;
2213	*CFG = YAML::Syck::Load <$fh>;	3365	*CFG = YAML::Load <$fh>;
2214		3366
2215	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3367	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2216		3368
2217	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3369	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2218	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3370	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2224	};	3376	};
2225	warn $@ if $@;	3377	warn $@ if $@;
2226	}	3378	}
2227	}	3379	}
2228		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 $$;
		3398	}
		3399
2229	sub main {	3400	sub main {
		3401	atomic;
		3402
2230	# we must not ever block the main coroutine	3403	# we must not ever block the main coroutine
2231	local $Coro::idle = sub {	3404	local $Coro::idle = sub {
2232	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3405	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2233	async { Event::one_event };	3406	(async {
		3407	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3408	EV::loop EV::LOOP_ONESHOT;
		3409	})->prio (Coro::PRIO_MAX);
2234	};	3410	};
2235		3411
2236	cfg_load;	3412	{
2237	db_load;	3413	my $guard = freeze_mainloop;
		3414	reload_config;
		3415	db_init;
2238	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
2239	Event::loop;	3426	EV::loop;
2240	}	3427	}
2241		3428
2242	#############################################################################	3429	#############################################################################
2243	# initialisation and cleanup	3430	# initialisation and cleanup
2244		3431
2245	# install some emergency cleanup handlers	3432	# install some emergency cleanup handlers
2246	BEGIN {	3433	BEGIN {
		3434	our %SIGWATCHER = ();
2247	for my $signal (qw(INT HUP TERM)) {	3435	for my $signal (qw(INT HUP TERM)) {
2248	Event->signal (	3436	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2249	data => WF_AUTOCANCEL,
2250	signal => $signal,
2251	cb => sub {
2252	cf::cleanup "SIG$signal";	3437	cf::cleanup "SIG$signal";
2253	},
2254	);	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
2255	}	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 };
2256	}	3519	}
2257		3520
2258	sub emergency_save() {	3521	sub emergency_save() {
2259	my $freeze_guard = cf::freeze_mainloop;	3522	my $freeze_guard = cf::freeze_mainloop;
2260		3523
…		…
2266	# and maps saved/destroyed asynchronously.	3529	# and maps saved/destroyed asynchronously.
2267	warn "begin emergency player save\n";	3530	warn "begin emergency player save\n";
2268	for my $login (keys %cf::PLAYER) {	3531	for my $login (keys %cf::PLAYER) {
2269	my $pl = $cf::PLAYER{$login} or next;	3532	my $pl = $cf::PLAYER{$login} or next;
2270	$pl->valid or next;	3533	$pl->valid or next;
		3534	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2271	$pl->save;	3535	$pl->save;
2272	}	3536	}
2273	warn "end emergency player save\n";	3537	warn "end emergency player save\n";
2274		3538
2275	warn "begin emergency map save\n";	3539	warn "begin emergency map save\n";
…		…
2277	my $map = $cf::MAP{$path} or next;	3541	my $map = $cf::MAP{$path} or next;
2278	$map->valid or next;	3542	$map->valid or next;
2279	$map->save;	3543	$map->save;
2280	}	3544	}
2281	warn "end emergency map save\n";	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";
2282	};	3554	};
2283		3555
2284	warn "leave emergency perl save\n";	3556	warn "leave emergency perl save\n";
2285	}	3557	}
2286		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
2287	sub reload() {	3597	sub do_reload_perl() {
2288	# can/must only be called in main	3598	# can/must only be called in main
2289	if ($Coro::current != $Coro::main) {	3599	if ($Coro::current != $Coro::main) {
2290	warn "can only reload from main coroutine\n";	3600	warn "can only reload from main coroutine";
2291	return;	3601	return;
2292	}	3602	}
2293		3603
		3604	return if $RELOAD++;
		3605
		3606	while ($RELOAD) {
2294	warn "reloading...";	3607	warn "reloading...";
2295		3608
2296	warn "freezing server";	3609	warn "entering sync_job";
2297	my $guard = freeze_mainloop;	3610
		3611	cf::sync_job {
		3612	cf::write_runtime_sync; # external watchdog should not bark
2298	cf::emergency_save;	3613	cf::emergency_save;
		3614	cf::write_runtime_sync; # external watchdog should not bark
2299		3615
2300	warn "sync database to disk";	3616	warn "syncing database to disk";
2301	cf::db_sync;	3617	BDB::db_env_txn_checkpoint $DB_ENV;
2302	IO::AIO::flush;
2303		3618
2304	eval {
2305	# 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
2306		3620
2307	warn "cancel all watchers";	3621	warn "flushing outstanding aio requests";
2308	for (Event::all_watchers) {	3622	while (IO::AIO::nreqs || BDB::nreqs) {
2309	$_->cancel if $_->data & WF_AUTOCANCEL;	3623	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2310	}
2311
2312	warn "cancel all extension coros";
2313	$_->cancel for values %EXT_CORO;
2314	%EXT_CORO = ();
2315
2316	warn "remove commands";
2317	%COMMAND = ();
2318
2319	warn "remove ext commands";
2320	%EXTCMD = ();
2321
2322	warn "unload/nuke all extensions";
2323	for my $pkg (@EXTS) {
2324	warn "... unloading $pkg";
2325
2326	if (my $cb = $pkg->can ("unload")) {
2327	eval {
2328	$cb->($pkg);
2329	1
2330	} or warn "$pkg unloaded, but with errors: $@";
2331	}	3624	}
2332		3625
		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) {
2333	warn "... nuking $pkg";	3639	warn "... unloading $pkg";
2334	Symbol::delete_package $pkg;
2335	}
2336		3640
2337	warn "unload all perl modules loaded from $LIBDIR";
2338	while (my ($k, $v) = each %INC) {
2339	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2340
2341	warn "removing <$k>";
2342	delete $INC{$k};
2343
2344	$k =~ s/\.pm$//;
2345	$k =~ s/\//::/g;
2346
2347	if (my $cb = $k->can ("unload_module")) {	3641	if (my $cb = $pkg->can ("unload")) {
		3642	eval {
2348	$cb->();	3643	$cb->($pkg);
		3644	1
		3645	} or warn "$pkg unloaded, but with errors: $@";
		3646	}
		3647
		3648	warn "... clearing $pkg";
		3649	clear_package $pkg;
2349	}	3650	}
2350		3651
2351	Symbol::delete_package $k;	3652	warn "unloading all perl modules loaded from $LIBDIR";
		3653	while (my ($k, $v) = each %INC) {
		3654	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		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;
2352	}	3667	}
2353		3668
2354	warn "get rid of safe::, as good as possible";	3669	warn "getting rid of safe::, as good as possible";
2355	Symbol::delete_package "safe::$_"	3670	clear_package "safe::$_"
2356	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);
2357		3672
2358	warn "unload cf.pm \"a bit\"";	3673	warn "unloading cf.pm \"a bit\"";
2359	delete $INC{"cf.pm"};	3674	delete $INC{"cf.pm"};
		3675	delete $INC{"cf/pod.pm"};
2360		3676
2361	# don't, removes xs symbols, too,	3677	# don't, removes xs symbols, too,
2362	# and global variables created in xs	3678	# and global variables created in xs
2363	#Symbol::delete_package __PACKAGE__;	3679	#clear_package __PACKAGE__;
2364		3680
		3681	warn "unload completed, starting to reload now";
		3682
2365	warn "reloading cf.pm";	3683	warn "reloading cf.pm";
2366	require cf;	3684	require cf;
2367	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3685	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2368		3686
2369	warn "load config and database again";	3687	warn "loading config and database again";
2370	cf::cfg_load;	3688	cf::reload_config;
2371	cf::db_load;
2372		3689
2373	warn "load extensions";	3690	warn "loading extensions";
2374	cf::load_extensions;	3691	cf::load_extensions;
2375		3692
2376	warn "reattach attachments to objects/players";	3693	warn "reattaching attachments to objects/players";
2377	_global_reattach;	3694	_global_reattach; # objects, sockets
2378	warn "reattach attachments to maps";	3695	warn "reattaching attachments to maps";
2379	reattach $_ for values %MAP;	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
		3708	warn "reloaded";
		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;
2380	};	3722	};
2381		3723	}
2382	if ($@) {
2383	warn $@;
2384	warn "error while reloading, exiting.";
2385	exit 1;
2386	}
2387
2388	warn "reloaded";
2389	};
2390		3724
2391	register_command "reload" => sub {	3725	register_command "reload" => sub {
2392	my ($who, $arg) = @_;	3726	my ($who, $arg) = @_;
2393		3727
2394	if ($who->flag (FLAG_WIZ)) {	3728	if ($who->flag (FLAG_WIZ)) {
2395	$who->message ("start of reload.");
2396	reload;
2397	$who->message ("end of reload.");	3729	$who->message ("reloading server.");
		3730	async {
		3731	$Coro::current->{desc} = "perl_reload";
		3732	reload_perl;
		3733	};
2398	}	3734	}
2399	};	3735	};
2400		3736
2401	unshift @INC, $LIBDIR;	3737	unshift @INC, $LIBDIR;
2402		3738
2403	$TICK_WATCHER = Event->timer (	3739	my $bug_warning = 0;
2404	reentrant => 0,
2405	prio => 0,
2406	at => $NEXT_TICK || $TICK,
2407	data => WF_AUTOCANCEL,
2408	cb => sub {
2409	$NOW = Event::time;
2410		3740
		3741	our @WAIT_FOR_TICK;
		3742	our @WAIT_FOR_TICK_BEGIN;
		3743
		3744	sub wait_for_tick {
		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
2411	cf::server_tick; # one server iteration	3767	cf::server_tick; # one server iteration
2412	$RUNTIME += $TICK;
2413	$NEXT_TICK += $TICK;
2414		3768
2415	$WAIT_FOR_TICK->broadcast;	3769	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2416	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3770	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2417		3771	Coro::async_pool {
2418	# if we are delayed by four ticks or more, skip them all	3772	$Coro::current->{desc} = "runtime saver";
2419	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2420
2421	$TICK_WATCHER->at ($NEXT_TICK);
2422	$TICK_WATCHER->start;
2423	},
2424	);
2425
2426	IO::AIO::max_poll_time $TICK * 0.2;
2427
2428	$AIO_POLL_WATCHER = Event->io (
2429	fd => IO::AIO::poll_fileno,
2430	poll => 'r',
2431	prio => 5,
2432	data => WF_AUTOCANCEL,
2433	cb => \&IO::AIO::poll_cb,
2434	);
2435
2436	$WRITE_RUNTIME_WATCHER = Event->timer (
2437	data => WF_AUTOCANCEL,
2438	after => 0,
2439	interval => 10,
2440	cb => sub {
2441	(Coro::unblock_sub {
2442	write_runtime	3773	write_runtime_sync
2443	or warn "ERROR: unable to write runtime file: $!";	3774	or warn "ERROR: unable to write runtime file: $!";
2444	})->();	3775	};
2445	},	3776	}
2446	);	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;
2447		3891
2448	END { cf::emergency_save }	3892	END { cf::emergency_save }
2449		3893
2450	1	3894	1
2451		3895

Diff Legend

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