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.231 by root, Wed Apr 4 00:02:06 2007 UTC vs.
Revision 1.521 by root, Fri Apr 16 23:28:42 2010 UTC

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

Diff Legend

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