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.232 by root, Wed Apr 4 02:07:19 2007 UTC vs.
Revision 1.516 by root, Thu Apr 15 06:05:52 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	} else {
		1442	$done{$k} = delete $todo{$k};
		1443	push @EXTS, $v->{pkg};
		1444	$progress = 1;
		1445
		1446	warn "$v->{base}: extension inactive.\n"
		1447	unless $active;
		1448	}
930	1	1449	}
931	} or warn "$ext not loaded: $@";	1450
		1451	unless ($progress) {
		1452	warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n";
		1453
		1454	while (my ($k, $v) = each %todo) {
		1455	cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting."
		1456	if exists $v->{meta}{mandatory};
		1457	}
		1458	}
		1459	}
932	}	1460	};
933	}	1461	}
934		1462
935	#############################################################################	1463	#############################################################################
936		1464
		1465	=back
		1466
937	=head2 CORE EXTENSIONS	1467	=head2 CORE EXTENSIONS
938		1468
939	Functions and methods that extend core crossfire objects.	1469	Functions and methods that extend core deliantra objects.
940		1470
941	=cut	1471	=cut
942		1472
943	package cf::player;	1473	package cf::player;
944		1474
…		…
946		1476
947	=head3 cf::player	1477	=head3 cf::player
948		1478
949	=over 4	1479	=over 4
950		1480
		1481	=item cf::player::num_playing
		1482
		1483	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1484
		1485	=cut
		1486
		1487	sub num_playing {
		1488	scalar grep
		1489	$_->ob->map
		1490	&& !$_->hidden
		1491	&& !$_->ob->flag (cf::FLAG_WIZ),
		1492	cf::player::list
		1493	}
		1494
951	=item cf::player::find $login	1495	=item cf::player::find $login
952		1496
953	Returns the given player object, loading it if necessary (might block).	1497	Returns the given player object, loading it if necessary (might block).
954		1498
955	=cut	1499	=cut
956		1500
957	sub playerdir($) {	1501	sub playerdir($) {
958	cf::localdir	1502	"$PLAYERDIR/"
959	. "/"
960	. cf::playerdir
961	. "/"
962	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1503	. (ref $_[0] ? $_[0]->ob->name : $_[0])
963	}	1504	}
964		1505
965	sub path($) {	1506	sub path($) {
966	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1507	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
967		1508
968	(playerdir $login) . "/$login.pl"	1509	(playerdir $login) . "/playerdata"
969	}	1510	}
970		1511
971	sub find_active($) {	1512	sub find_active($) {
972	$cf::PLAYER{$_[0]}	1513	$cf::PLAYER{$_[0]}
973	and $cf::PLAYER{$_[0]}->active	1514	and $cf::PLAYER{$_[0]}->active
…		…
976		1517
977	sub exists($) {	1518	sub exists($) {
978	my ($login) = @_;	1519	my ($login) = @_;
979		1520
980	$cf::PLAYER{$login}	1521	$cf::PLAYER{$login}
981	or cf::sync_job { !aio_stat path $login }	1522	or !aio_stat path $login
982	}	1523	}
983		1524
984	sub find($) {	1525	sub find($) {
985	return $cf::PLAYER{$_[0]} || do {	1526	return $cf::PLAYER{$_[0]} || do {
986	my $login = $_[0];	1527	my $login = $_[0];
987		1528
988	my $guard = cf::lock_acquire "user_find:$login";	1529	my $guard = cf::lock_acquire "user_find:$login";
989		1530
990	$cf::PLAYER{$_[0]} || do {	1531	$cf::PLAYER{$_[0]} || do {
991	my $pl = load_pl path $login	1532	# rename old playerfiles to new ones
		1533	#TODO: remove when no longer required
		1534	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1535	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1536	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1537	aio_unlink +(playerdir $login) . "/$login.pl";
		1538
		1539	my $f = new_from_file cf::object::thawer path $login
992	or return;	1540	or return;
		1541
		1542	my $pl = cf::player::load_pl $f
		1543	or return;
		1544
		1545	local $cf::PLAYER_LOADING{$login} = $pl;
		1546	$f->resolve_delayed_derefs;
993	$cf::PLAYER{$login} = $pl	1547	$cf::PLAYER{$login} = $pl
994	}	1548	}
995	}	1549	}
996	}	1550	}
		1551
		1552	cf::player->attach (
		1553	on_load => sub {
		1554	my ($pl, $path) = @_;
		1555
		1556	# restore slots saved in save, below
		1557	my $slots = delete $pl->{_slots};
		1558
		1559	$pl->ob->current_weapon ($slots->[0]);
		1560	$pl->combat_ob ($slots->[1]);
		1561	$pl->ranged_ob ($slots->[2]);
		1562	},
		1563	);
997		1564
998	sub save($) {	1565	sub save($) {
999	my ($pl) = @_;	1566	my ($pl) = @_;
1000		1567
1001	return if $pl->{deny_save};	1568	return if $pl->{deny_save};
…		…
1006	return if $pl->{deny_save};	1573	return if $pl->{deny_save};
1007		1574
1008	aio_mkdir playerdir $pl, 0770;	1575	aio_mkdir playerdir $pl, 0770;
1009	$pl->{last_save} = $cf::RUNTIME;	1576	$pl->{last_save} = $cf::RUNTIME;
1010		1577
		1578	cf::get_slot 0.01;
		1579
		1580	# save slots, to be restored later
		1581	local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob];
		1582
1011	$pl->save_pl ($path);	1583	$pl->save_pl ($path);
1012	Coro::cede;	1584	cf::cede_to_tick;
1013	}	1585	}
1014		1586
1015	sub new($) {	1587	sub new($) {
1016	my ($login) = @_;	1588	my ($login) = @_;
1017		1589
…		…
1023	$cf::PLAYER{$login} = $self;	1595	$cf::PLAYER{$login} = $self;
1024		1596
1025	$self	1597	$self
1026	}	1598	}
1027		1599
		1600	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1601
		1602	=cut
		1603
		1604	sub send_msg {
		1605	my $ns = shift->ns
		1606	or return;
		1607	$ns->send_msg (@_);
		1608	}
		1609
1028	=item $pl->quit_character	1610	=item $pl->quit_character
1029		1611
1030	Nukes the player without looking back. If logged in, the connection will	1612	Nukes the player without looking back. If logged in, the connection will
1031	be destroyed. May block for a long time.	1613	be destroyed. May block for a long time.
1032		1614
…		…
1036	my ($pl) = @_;	1618	my ($pl) = @_;
1037		1619
1038	my $name = $pl->ob->name;	1620	my $name = $pl->ob->name;
1039		1621
1040	$pl->{deny_save} = 1;	1622	$pl->{deny_save} = 1;
1041	$pl->password ("*"); # this should lock out the player until we nuked the dir	1623	$pl->password ("*"); # this should lock out the player until we have nuked the dir
1042		1624
1043	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1625	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1044	$pl->deactivate;	1626	$pl->deactivate;
		1627	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1628	$pl->ob->check_score;
1045	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1629	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1046	$pl->ns->destroy if $pl->ns;	1630	$pl->ns->destroy if $pl->ns;
1047		1631
1048	my $path = playerdir $pl;	1632	my $path = playerdir $pl;
1049	my $temp = "$path~$cf::RUNTIME~deleting~";	1633	my $temp = "$path~$cf::RUNTIME~deleting~";
…		…
1079	while and may block, so not sync_job-capable, ever.	1663	while and may block, so not sync_job-capable, ever.
1080		1664
1081	=cut	1665	=cut
1082		1666
1083	sub list_logins {	1667	sub list_logins {
1084	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1668	my $dirs = aio_readdir $PLAYERDIR
1085	or return [];	1669	or return [];
1086		1670
1087	my @logins;	1671	my @logins;
1088		1672
1089	for my $login (@$dirs) {	1673	for my $login (@$dirs) {
		1674	my $path = path $login;
		1675
		1676	# a .pst is a dead give-away for a valid player
		1677	# if no pst file found, open and chekc for blocked users
		1678	if (aio_stat "$path.pst") {
1090	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1679	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1091	aio_read $fh, 0, 512, my $buf, 0 or next;	1680	aio_read $fh, 0, 512, my $buf, 0 or next;
1092	$buf !~ /^password -------------$/m or next; # official not-valid tag	1681	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1682	}
1093		1683
1094	utf8::decode $login;	1684	utf8::decode $login;
1095	push @logins, $login;	1685	push @logins, $login;
1096	}	1686	}
1097		1687
…		…
1124	}	1714	}
1125		1715
1126	\@paths	1716	\@paths
1127	}	1717	}
1128		1718
		1719	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1720
		1721	Expand deliantra pod fragments into protocol xml.
		1722
1129	=item $player->ext_reply ($msgid, %msg)	1723	=item $player->ext_reply ($msgid, @msg)
1130		1724
1131	Sends an ext reply to the player.	1725	Sends an ext reply to the player.
1132		1726
1133	=cut	1727	=cut
1134		1728
1135	sub ext_reply($$%) {	1729	sub ext_reply($$@) {
1136	my ($self, $id, %msg) = @_;	1730	my ($self, $id, @msg) = @_;
1137		1731
1138	$msg{msgid} = $id;	1732	$self->ns->ext_reply ($id, @msg)
1139
1140	$self->send ("ext " . cf::to_json \%msg);
1141	}	1733	}
1142		1734
1143	=item $player->ext_event ($type, %msg)	1735	=item $player->ext_msg ($type, @msg)
1144		1736
1145	Sends an ext event to the client.	1737	Sends an ext event to the client.
1146		1738
1147	=cut	1739	=cut
1148		1740
1149	sub ext_event($$%) {	1741	sub ext_msg($$@) {
1150	my ($self, $type, %msg) = @_;	1742	my ($self, $type, @msg) = @_;
1151		1743
1152	$self->ns->ext_event ($type, %msg);	1744	$self->ns->ext_msg ($type, @msg);
1153	}	1745	}
1154		1746
1155	package cf;	1747	=head3 cf::region
		1748
		1749	=over 4
		1750
		1751	=cut
		1752
		1753	package cf::region;
		1754
		1755	=item cf::region::find_by_path $path
		1756
		1757	Tries to decuce the likely region for a map knowing only its path.
		1758
		1759	=cut
		1760
		1761	sub find_by_path($) {
		1762	my ($path) = @_;
		1763
		1764	my ($match, $specificity);
		1765
		1766	for my $region (list) {
		1767	if ($region->{match} && $path =~ $region->{match}) {
		1768	($match, $specificity) = ($region, $region->specificity)
		1769	if $region->specificity > $specificity;
		1770	}
		1771	}
		1772
		1773	$match
		1774	}
1156		1775
1157	=back	1776	=back
1158
1159		1777
1160	=head3 cf::map	1778	=head3 cf::map
1161		1779
1162	=over 4	1780	=over 4
1163		1781
…		…
1175	our $MAX_RESET = 3600;	1793	our $MAX_RESET = 3600;
1176	our $DEFAULT_RESET = 3000;	1794	our $DEFAULT_RESET = 3000;
1177		1795
1178	sub generate_random_map {	1796	sub generate_random_map {
1179	my ($self, $rmp) = @_;	1797	my ($self, $rmp) = @_;
		1798
		1799	my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
		1800
1180	# mit "rum" bekleckern, nicht	1801	# mit "rum" bekleckern, nicht
1181	$self->_create_random_map (	1802	$self->_create_random_map (
1182	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1803	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1183	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1804	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1184	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1805	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1185	$rmp->{exit_on_final_map},	1806	$rmp->{exit_on_final_map},
1186	$rmp->{xsize}, $rmp->{ysize},	1807	$rmp->{xsize}, $rmp->{ysize},
1187	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1808	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1188	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1809	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
…		…
1218	my ($self, $merge) = @_;	1839	my ($self, $merge) = @_;
1219		1840
1220	# we have to keep some variables in memory intact	1841	# we have to keep some variables in memory intact
1221	local $self->{path};	1842	local $self->{path};
1222	local $self->{load_path};	1843	local $self->{load_path};
1223	local $self->{deny_save};
1224	local $self->{deny_reset};
1225		1844
1226	$self->SUPER::thawer_merge ($merge);	1845	$self->SUPER::thawer_merge ($merge);
1227	}	1846	}
1228		1847
1229	sub normalise {	1848	sub normalise {
…		…
1276	$self->init; # pass $1 etc.	1895	$self->init; # pass $1 etc.
1277	return $self;	1896	return $self;
1278	}	1897	}
1279	}	1898	}
1280		1899
1281	Carp::carp "unable to resolve path '$path' (base '$base').";	1900	Carp::cluck "unable to resolve path '$path' (base '$base').";
1282	()	1901	()
1283	}	1902	}
1284		1903
1285	sub init {	1904	sub init {
1286	my ($self) = @_;	1905	my ($self) = @_;
…		…
1301		1920
1302	# the original (read-only) location	1921	# the original (read-only) location
1303	sub load_path {	1922	sub load_path {
1304	my ($self) = @_;	1923	my ($self) = @_;
1305		1924
1306	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1925	"$MAPDIR/$self->{path}.map"
1307	}	1926	}
1308		1927
1309	# the temporary/swap location	1928	# the temporary/swap location
1310	sub save_path {	1929	sub save_path {
1311	my ($self) = @_;	1930	my ($self) = @_;
1312		1931
1313	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1932	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1314	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1933	"$TMPDIR/$path.map"
1315	}	1934	}
1316		1935
1317	# the unique path, undef == no special unique path	1936	# the unique path, undef == no special unique path
1318	sub uniq_path {	1937	sub uniq_path {
1319	my ($self) = @_;	1938	my ($self) = @_;
1320		1939
1321	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1940	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1322	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1941	"$UNIQUEDIR/$path"
1323	}	1942	}
1324		1943
1325	# and all this just because we cannot iterate over	1944	sub decay_objects {
1326	# all maps in C++...
1327	sub change_all_map_light {
1328	my ($change) = @_;	1945	my ($self) = @_;
1329		1946
1330	$_->change_map_light ($change)	1947	return if $self->{deny_reset};
1331	for grep $_->outdoor, values %cf::MAP;	1948
		1949	$self->do_decay_objects;
1332	}	1950	}
1333		1951
1334	sub unlink_save {	1952	sub unlink_save {
1335	my ($self) = @_;	1953	my ($self) = @_;
1336		1954
…		…
1341		1959
1342	sub load_header_from($) {	1960	sub load_header_from($) {
1343	my ($self, $path) = @_;	1961	my ($self, $path) = @_;
1344		1962
1345	utf8::encode $path;	1963	utf8::encode $path;
1346	#aio_open $path, O_RDONLY, 0	1964	my $f = new_from_file cf::object::thawer $path
1347	# or return;
1348
1349	$self->_load_header ($path)
1350	or return;	1965	or return;
		1966
		1967	$self->_load_header ($f)
		1968	or return;
		1969
		1970	local $MAP_LOADING{$self->{path}} = $self;
		1971	$f->resolve_delayed_derefs;
1351		1972
1352	$self->{load_path} = $path;	1973	$self->{load_path} = $path;
1353		1974
1354	1	1975	1
1355	}	1976	}
…		…
1394	$self->load_header_orig	2015	$self->load_header_orig
1395	or return;	2016	or return;
1396	$self->prepare_orig;	2017	$self->prepare_orig;
1397	}	2018	}
1398		2019
		2020	$self->{deny_reset} = 1
		2021	if $self->no_reset;
		2022
		2023	$self->default_region (cf::region::find_by_path $self->{path})
		2024	unless $self->default_region;
		2025
1399	1	2026	1
1400	}	2027	}
1401		2028
1402	sub find;	2029	sub find;
1403	sub find {	2030	sub find {
1404	my ($path, $origin) = @_;	2031	my ($path, $origin) = @_;
1405		2032
1406	$path = normalise $path, $origin && $origin->path;	2033	$path = normalise $path, $origin && $origin->path;
1407		2034
		2035	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1408	cf::lock_wait "map_find:$path";	2036	my $guard2 = cf::lock_acquire "map_find:$path";
1409		2037
1410	$cf::MAP{$path} || do {	2038	$cf::MAP{$path} || do {
1411	my $guard = cf::lock_acquire "map_find:$path";
1412	my $map = new_from_path cf::map $path	2039	my $map = new_from_path cf::map $path
1413	or return;	2040	or return;
1414		2041
1415	$map->{last_save} = $cf::RUNTIME;	2042	$map->{last_save} = $cf::RUNTIME;
1416		2043
1417	$map->load_header	2044	$map->load_header
1418	or return;	2045	or return;
1419		2046
1420	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	2047	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1421	# doing this can freeze the server in a sync job, obviously	2048	# doing this can freeze the server in a sync job, obviously
1422	#$cf::WAIT_FOR_TICK->wait;	2049	#$cf::WAIT_FOR_TICK->wait;
		2050	undef $guard2;
		2051	undef $guard1;
1423	$map->reset;	2052	$map->reset;
1424	undef $guard;
1425	return find $path;	2053	return find $path;
1426	}	2054	}
1427		2055
1428	$cf::MAP{$path} = $map	2056	$cf::MAP{$path} = $map
1429	}	2057	}
1430	}	2058	}
1431		2059
1432	sub pre_load { }	2060	sub pre_load { }
1433	sub post_load { }	2061	#sub post_load { } # XS
1434		2062
1435	sub load {	2063	sub load {
1436	my ($self) = @_;	2064	my ($self) = @_;
1437		2065
1438	local $self->{deny_reset} = 1; # loading can take a long time	2066	local $self->{deny_reset} = 1; # loading can take a long time
1439		2067
1440	my $path = $self->{path};	2068	my $path = $self->{path};
		2069
		2070	{
1441	my $guard = cf::lock_acquire "map_load:$path";	2071	my $guard = cf::lock_acquire "map_data:$path";
1442		2072
		2073	return unless $self->valid;
1443	return if $self->in_memory != cf::MAP_SWAPPED;	2074	return unless $self->in_memory == cf::MAP_SWAPPED;
1444		2075
1445	$self->in_memory (cf::MAP_LOADING);	2076	$self->in_memory (cf::MAP_LOADING);
1446		2077
1447	$self->alloc;	2078	$self->alloc;
1448		2079
1449	$self->pre_load;	2080	$self->pre_load;
		2081	cf::cede_to_tick;
1450		2082
1451	$self->_load_objects ($self->{load_path}, 1)	2083	my $f = new_from_file cf::object::thawer $self->{load_path};
		2084	$f->skip_block;
		2085	$self->_load_objects ($f)
1452	or return;	2086	or return;
1453		2087
1454	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2088	$self->post_load_original
1455	if delete $self->{load_original};	2089	if delete $self->{load_original};
1456		2090
1457	if (my $uniq = $self->uniq_path) {	2091	if (my $uniq = $self->uniq_path) {
1458	utf8::encode $uniq;	2092	utf8::encode $uniq;
1459	if (aio_open $uniq, O_RDONLY, 0) {	2093	unless (aio_stat $uniq) {
		2094	if (my $f = new_from_file cf::object::thawer $uniq) {
1460	$self->clear_unique_items;	2095	$self->clear_unique_items;
1461	$self->_load_objects ($uniq, 0);	2096	$self->_load_objects ($f);
		2097	$f->resolve_delayed_derefs;
		2098	}
1462	}	2099	}
1463	}	2100	}
1464		2101
1465	Coro::cede;	2102	$f->resolve_delayed_derefs;
1466		2103
		2104	cf::cede_to_tick;
1467	# now do the right thing for maps	2105	# now do the right thing for maps
1468	$self->link_multipart_objects;	2106	$self->link_multipart_objects;
1469
1470	unless ($self->{deny_activate}) {
1471	$self->decay_objects;
1472	$self->fix_auto_apply;
1473	$self->update_buttons;
1474	Coro::cede;
1475	$self->set_darkness_map;
1476	$self->difficulty ($self->estimate_difficulty)	2107	$self->difficulty ($self->estimate_difficulty)
1477	unless $self->difficulty;	2108	unless $self->difficulty;
1478	Coro::cede;	2109	cf::cede_to_tick;
		2110
		2111	unless ($self->{deny_activate}) {
		2112	$self->decay_objects;
		2113	$self->fix_auto_apply;
		2114	$self->update_buttons;
		2115	cf::cede_to_tick;
1479	$self->activate;	2116	$self->activate;
		2117	}
		2118
		2119	$self->{last_save} = $cf::RUNTIME;
		2120	$self->last_access ($cf::RUNTIME);
		2121
		2122	$self->in_memory (cf::MAP_ACTIVE);
1480	}	2123	}
1481		2124
1482	$self->post_load;	2125	$self->post_load;
1483
1484	$self->in_memory (cf::MAP_IN_MEMORY);
1485	}	2126	}
1486		2127
		2128	# customize the map for a given player, i.e.
		2129	# return the _real_ map. used by e.g. per-player
		2130	# maps to change the path to ~playername/mappath
1487	sub customise_for {	2131	sub customise_for {
1488	my ($self, $ob) = @_;	2132	my ($self, $ob) = @_;
1489		2133
1490	return find "~" . $ob->name . "/" . $self->{path}	2134	return find "~" . $ob->name . "/" . $self->{path}
1491	if $self->per_player;	2135	if $self->per_player;
1492		2136
		2137	# return find "?party/" . $ob->name . "/" . $self->{path}
		2138	# if $self->per_party;
		2139
1493	$self	2140	$self
1494	}	2141	}
1495		2142
1496	# find and load all maps in the 3x3 area around a map	2143	# find and load all maps in the 3x3 area around a map
1497	sub load_diag {	2144	sub load_neighbours {
1498	my ($map) = @_;	2145	my ($map) = @_;
1499		2146
1500	my @diag; # diagonal neighbours	2147	my @neigh; # diagonal neighbours
1501		2148
1502	for (0 .. 3) {	2149	for (0 .. 3) {
1503	my $neigh = $map->tile_path ($_)	2150	my $neigh = $map->tile_path ($_)
1504	or next;	2151	or next;
1505	$neigh = find $neigh, $map	2152	$neigh = find $neigh, $map
1506	or next;	2153	or next;
1507	$neigh->load;	2154	$neigh->load;
1508		2155
		2156	push @neigh,
1509	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2157	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1510	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2158	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1511	}	2159	}
1512		2160
1513	for (@diag) {	2161	for (grep defined $_->[0], @neigh) {
		2162	my ($path, $origin) = @$_;
1514	my $neigh = find @$_	2163	my $neigh = find $path, $origin
1515	or next;	2164	or next;
1516	$neigh->load;	2165	$neigh->load;
1517	}	2166	}
1518	}	2167	}
1519		2168
…		…
1524	}	2173	}
1525		2174
1526	sub do_load_sync {	2175	sub do_load_sync {
1527	my ($map) = @_;	2176	my ($map) = @_;
1528		2177
		2178	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2179	if $Coro::current == $Coro::main;
		2180
1529	cf::sync_job { $map->load };	2181	cf::sync_job { $map->load };
1530	}	2182	}
1531		2183
1532	our %MAP_PREFETCH;	2184	our %MAP_PREFETCH;
1533	our $MAP_PREFETCHER = undef;	2185	our $MAP_PREFETCHER = undef;
1534		2186
1535	sub find_async {	2187	sub find_async {
1536	my ($path, $origin) = @_;	2188	my ($path, $origin, $load) = @_;
1537		2189
1538	$path = normalise $path, $origin && $origin->{path};	2190	$path = normalise $path, $origin && $origin->{path};
1539		2191
1540	if (my $map = $cf::MAP{$path}) {	2192	if (my $map = $cf::MAP{$path}) {
1541	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2193	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1542	}	2194	}
1543		2195
1544	undef $MAP_PREFETCH{$path};	2196	$MAP_PREFETCH{$path} |= $load;
		2197
1545	$MAP_PREFETCHER ||= cf::async {	2198	$MAP_PREFETCHER ||= cf::async {
		2199	$Coro::current->{desc} = "map prefetcher";
		2200
1546	while (%MAP_PREFETCH) {	2201	while (%MAP_PREFETCH) {
1547	for my $path (keys %MAP_PREFETCH) {	2202	while (my ($k, $v) = each %MAP_PREFETCH) {
1548	my $map = find $path	2203	if (my $map = find $k) {
1549	or next;
1550	$map->load;	2204	$map->load if $v;
		2205	}
1551		2206
1552	delete $MAP_PREFETCH{$path};	2207	delete $MAP_PREFETCH{$k};
1553	}	2208	}
1554	}	2209	}
1555	undef $MAP_PREFETCHER;	2210	undef $MAP_PREFETCHER;
1556	};	2211	};
1557	$MAP_PREFETCHER->prio (6);	2212	$MAP_PREFETCHER->prio (6);
…		…
1560	}	2215	}
1561		2216
1562	sub save {	2217	sub save {
1563	my ($self) = @_;	2218	my ($self) = @_;
1564		2219
1565	my $lock = cf::lock_acquire "map_data:" . $self->path;	2220	my $lock = cf::lock_acquire "map_data:$self->{path}";
1566		2221
1567	$self->{last_save} = $cf::RUNTIME;	2222	$self->{last_save} = $cf::RUNTIME;
1568		2223
1569	return unless $self->dirty;	2224	return unless $self->dirty;
1570		2225
…		…
1576	return if $self->{deny_save};	2231	return if $self->{deny_save};
1577		2232
1578	local $self->{last_access} = $self->last_access;#d#	2233	local $self->{last_access} = $self->last_access;#d#
1579		2234
1580	cf::async {	2235	cf::async {
		2236	$Coro::current->{desc} = "map player save";
1581	$_->contr->save for $self->players;	2237	$_->contr->save for $self->players;
1582	};	2238	};
		2239
		2240	cf::get_slot 0.02;
1583		2241
1584	if ($uniq) {	2242	if ($uniq) {
1585	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2243	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1586	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2244	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1587	} else {	2245	} else {
…		…
1593	my ($self) = @_;	2251	my ($self) = @_;
1594		2252
1595	# save first because save cedes	2253	# save first because save cedes
1596	$self->save;	2254	$self->save;
1597		2255
1598	my $lock = cf::lock_acquire "map_data:" . $self->path;	2256	my $lock = cf::lock_acquire "map_data:$self->{path}";
1599		2257
1600	return if $self->players;	2258	return if $self->players;
1601	return if $self->in_memory != cf::MAP_IN_MEMORY;	2259	return if $self->in_memory != cf::MAP_ACTIVE;
1602	return if $self->{deny_save};	2260	return if $self->{deny_save};
1603		2261
		2262	$self->in_memory (cf::MAP_SWAPPED);
		2263
		2264	$self->deactivate;
		2265	$_->clear_links_to ($self) for values %cf::MAP;
1604	$self->clear;	2266	$self->clear;
1605	$self->in_memory (cf::MAP_SWAPPED);
1606	}	2267	}
1607		2268
1608	sub reset_at {	2269	sub reset_at {
1609	my ($self) = @_;	2270	my ($self) = @_;
1610		2271
1611	# TODO: safety, remove and allow resettable per-player maps	2272	# TODO: safety, remove and allow resettable per-player maps
1612	return 1e99 if $self->isa ("ext::map_per_player");#d#
1613	return 1e99 if $self->{deny_reset};	2273	return 1e99 if $self->{deny_reset};
1614		2274
1615	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2275	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1616	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2276	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1617		2277
…		…
1628	my ($self) = @_;	2288	my ($self) = @_;
1629		2289
1630	my $lock = cf::lock_acquire "map_data:$self->{path}";	2290	my $lock = cf::lock_acquire "map_data:$self->{path}";
1631		2291
1632	return if $self->players;	2292	return if $self->players;
1633	return if $self->isa ("ext::map_per_player");#d#
1634		2293
1635	warn "resetting map ", $self->path;#d#	2294	warn "resetting map ", $self->path, "\n";
1636		2295
1637	$self->in_memory (cf::MAP_SWAPPED);	2296	$self->in_memory (cf::MAP_SWAPPED);
1638		2297
1639	# need to save uniques path	2298	# need to save uniques path
1640	unless ($self->{deny_save}) {	2299	unless ($self->{deny_save}) {
…		…
1644	if $uniq;	2303	if $uniq;
1645	}	2304	}
1646		2305
1647	delete $cf::MAP{$self->path};	2306	delete $cf::MAP{$self->path};
1648		2307
		2308	$self->deactivate;
		2309	$_->clear_links_to ($self) for values %cf::MAP;
1649	$self->clear;	2310	$self->clear;
1650
1651	$_->clear_links_to ($self) for values %cf::MAP;
1652		2311
1653	$self->unlink_save;	2312	$self->unlink_save;
1654	$self->destroy;	2313	$self->destroy;
1655	}	2314	}
1656		2315
1657	my $nuke_counter = "aaaa";	2316	my $nuke_counter = "aaaa";
1658		2317
1659	sub nuke {	2318	sub nuke {
1660	my ($self) = @_;	2319	my ($self) = @_;
1661		2320
		2321	{
		2322	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2323
1662	delete $cf::MAP{$self->path};	2324	delete $cf::MAP{$self->path};
1663		2325
1664	$self->unlink_save;	2326	$self->unlink_save;
1665		2327
1666	bless $self, "cf::map";	2328	bless $self, "cf::map";
1667	delete $self->{deny_reset};	2329	delete $self->{deny_reset};
1668	$self->{deny_save} = 1;	2330	$self->{deny_save} = 1;
1669	$self->reset_timeout (1);	2331	$self->reset_timeout (1);
1670	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2332	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1671		2333
1672	$cf::MAP{$self->path} = $self;	2334	$cf::MAP{$self->path} = $self;
		2335	}
1673		2336
1674	$self->reset; # polite request, might not happen	2337	$self->reset; # polite request, might not happen
		2338	}
		2339
		2340	=item $maps = cf::map::tmp_maps
		2341
		2342	Returns an arrayref with all map paths of currently instantiated and saved
		2343	maps. May block.
		2344
		2345	=cut
		2346
		2347	sub tmp_maps() {
		2348	[
		2349	map {
		2350	utf8::decode $_;
		2351	/\.map$/
		2352	? normalise $_
		2353	: ()
		2354	} @{ aio_readdir $TMPDIR or [] }
		2355	]
		2356	}
		2357
		2358	=item $maps = cf::map::random_maps
		2359
		2360	Returns an arrayref with all map paths of currently instantiated and saved
		2361	random maps. May block.
		2362
		2363	=cut
		2364
		2365	sub random_maps() {
		2366	[
		2367	map {
		2368	utf8::decode $_;
		2369	/\.map$/
		2370	? normalise "?random/$_"
		2371	: ()
		2372	} @{ aio_readdir $RANDOMDIR or [] }
		2373	]
1675	}	2374	}
1676		2375
1677	=item cf::map::unique_maps	2376	=item cf::map::unique_maps
1678		2377
1679	Returns an arrayref of paths of all shared maps that have	2378	Returns an arrayref of paths of all shared maps that have
1680	instantiated unique items. May block.	2379	instantiated unique items. May block.
1681		2380
1682	=cut	2381	=cut
1683		2382
1684	sub unique_maps() {	2383	sub unique_maps() {
1685	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2384	[
1686	or return;	2385	map {
1687
1688	my @paths;
1689
1690	for (@$files) {
1691	utf8::decode $_;	2386	utf8::decode $_;
1692	next if /\.pst$/;	2387	s/\.map$//; # TODO future compatibility hack
1693	next unless /^$PATH_SEP/o;	2388	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1694		2389	? ()
1695	push @paths, cf::map::normalise $_;	2390	: normalise $_
		2391	} @{ aio_readdir $UNIQUEDIR or [] }
1696	}	2392	]
1697
1698	\@paths
1699	}	2393	}
1700		2394
1701	package cf;	2395	=item cf::map::static_maps
		2396
		2397	Returns an arrayref if paths of all static maps (all preinstalled F<.map>
		2398	file in the shared directory excluding F</styles> and F</editor>). May
		2399	block.
		2400
		2401	=cut
		2402
		2403	sub static_maps() {
		2404	my @dirs = "";
		2405	my @maps;
		2406
		2407	while (@dirs) {
		2408	my $dir = shift @dirs;
		2409
		2410	next if $dir eq "/styles" || $dir eq "/editor";
		2411
		2412	my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
		2413	or return;
		2414
		2415	for (@$files) {
		2416	s/\.map$// or next;
		2417	utf8::decode $_;
		2418	push @maps, "$dir/$_";
		2419	}
		2420
		2421	push @dirs, map "$dir/$_", @$dirs;
		2422	}
		2423
		2424	\@maps
		2425	}
1702		2426
1703	=back	2427	=back
1704		2428
1705	=head3 cf::object	2429	=head3 cf::object
1706		2430
…		…
1710		2434
1711	=over 4	2435	=over 4
1712		2436
1713	=item $ob->inv_recursive	2437	=item $ob->inv_recursive
1714		2438
1715	Returns the inventory of the object _and_ their inventories, recursively.	2439	Returns the inventory of the object I<and> their inventories, recursively,
		2440	but I<not> the object itself.
1716		2441
1717	=cut	2442	=cut
1718		2443
1719	sub inv_recursive_;	2444	sub inv_recursive_;
1720	sub inv_recursive_ {	2445	sub inv_recursive_ {
…		…
1723		2448
1724	sub inv_recursive {	2449	sub inv_recursive {
1725	inv_recursive_ inv $_[0]	2450	inv_recursive_ inv $_[0]
1726	}	2451	}
1727		2452
		2453	=item $ref = $ob->ref
		2454
		2455	Creates and returns a persistent reference to an object that can be stored as a string.
		2456
		2457	=item $ob = cf::object::deref ($refstring)
		2458
		2459	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2460	even if the object actually exists. May block.
		2461
		2462	=cut
		2463
		2464	sub deref {
		2465	my ($ref) = @_;
		2466
		2467	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2468	my ($uuid, $name) = ($1, $2);
		2469	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2470	or return;
		2471	$pl->ob->uuid eq $uuid
		2472	or return;
		2473
		2474	$pl->ob
		2475	} else {
		2476	warn "$ref: cannot resolve object reference\n";
		2477	undef
		2478	}
		2479	}
		2480
1728	package cf;	2481	package cf;
1729		2482
1730	=back	2483	=back
1731		2484
1732	=head3 cf::object::player	2485	=head3 cf::object::player
…		…
1738	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2491	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1739	can be C<undef>. Does the right thing when the player is currently in a	2492	can be C<undef>. Does the right thing when the player is currently in a
1740	dialogue with the given NPC character.	2493	dialogue with the given NPC character.
1741		2494
1742	=cut	2495	=cut
		2496
		2497	our $SAY_CHANNEL = {
		2498	id => "say",
		2499	title => "Map",
		2500	reply => "say ",
		2501	tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
		2502	};
		2503
		2504	our $CHAT_CHANNEL = {
		2505	id => "chat",
		2506	title => "Chat",
		2507	reply => "chat ",
		2508	tooltip => "Player chat and shouts, global to the server.",
		2509	};
1743		2510
1744	# rough implementation of a future "reply" method that works	2511	# rough implementation of a future "reply" method that works
1745	# with dialog boxes.	2512	# with dialog boxes.
1746	#TODO: the first argument must go, split into a $npc->reply_to ( method	2513	#TODO: the first argument must go, split into a $npc->reply_to ( method
1747	sub cf::object::player::reply($$$;$) {	2514	sub cf::object::player::reply($$$;$) {
…		…
1749		2516
1750	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2517	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1751		2518
1752	if ($self->{record_replies}) {	2519	if ($self->{record_replies}) {
1753	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2520	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2521
1754	} else {	2522	} else {
		2523	my $pl = $self->contr;
		2524
		2525	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2526	my $dialog = $pl->{npc_dialog};
		2527	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2528
		2529	} else {
1755	$msg = $npc->name . " says: $msg" if $npc;	2530	$msg = $npc->name . " says: $msg" if $npc;
1756	$self->message ($msg, $flags);	2531	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2532	}
1757	}	2533	}
		2534	}
		2535
		2536	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2537
		2538	=cut
		2539
		2540	sub cf::object::send_msg {
		2541	my $pl = shift->contr
		2542	or return;
		2543	$pl->send_msg (@_);
1758	}	2544	}
1759		2545
1760	=item $player_object->may ("access")	2546	=item $player_object->may ("access")
1761		2547
1762	Returns wether the given player is authorized to access resource "access"	2548	Returns wether the given player is authorized to access resource "access"
…		…
1775		2561
1776	=item $player_object->enter_link	2562	=item $player_object->enter_link
1777		2563
1778	Freezes the player and moves him/her to a special map (C<{link}>).	2564	Freezes the player and moves him/her to a special map (C<{link}>).
1779		2565
1780	The player should be reasonably safe there for short amounts of time. You	2566	The player should be reasonably safe there for short amounts of time (e.g.
1781	I<MUST> call C<leave_link> as soon as possible, though.	2567	for loading a map). You I<MUST> call C<leave_link> as soon as possible,
		2568	though, as the palyer cannot control the character while it is on the link
		2569	map.
1782		2570
1783	Will never block.	2571	Will never block.
1784		2572
1785	=item $player_object->leave_link ($map, $x, $y)	2573	=item $player_object->leave_link ($map, $x, $y)
1786		2574
…		…
1809	$self->deactivate_recursive;	2597	$self->deactivate_recursive;
1810		2598
1811	return if UNIVERSAL::isa $self->map, "ext::map_link";	2599	return if UNIVERSAL::isa $self->map, "ext::map_link";
1812		2600
1813	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2601	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1814	if $self->map;	2602	if $self->map && $self->map->{path} ne "{link}";
1815		2603
1816	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2604	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1817	}	2605	}
1818		2606
1819	sub cf::object::player::leave_link {	2607	sub cf::object::player::leave_link {
1820	my ($self, $map, $x, $y) = @_;	2608	my ($self, $map, $x, $y) = @_;
		2609
		2610	return unless $self->contr->active;
1821		2611
1822	my $link_pos = delete $self->{_link_pos};	2612	my $link_pos = delete $self->{_link_pos};
1823		2613
1824	unless ($map) {	2614	unless ($map) {
1825	# restore original map position	2615	# restore original map position
…		…
1836	($x, $y) = (-1, -1)	2626	($x, $y) = (-1, -1)
1837	unless (defined $x) && (defined $y);	2627	unless (defined $x) && (defined $y);
1838		2628
1839	# use -1 or undef as default coordinates, not 0, 0	2629	# use -1 or undef as default coordinates, not 0, 0
1840	($x, $y) = ($map->enter_x, $map->enter_y)	2630	($x, $y) = ($map->enter_x, $map->enter_y)
1841	if $x <=0 && $y <= 0;	2631	if $x <= 0 && $y <= 0;
1842		2632
1843	$map->load;	2633	$map->load;
1844	$map->load_diag;	2634	$map->load_neighbours;
1845		2635
1846	return unless $self->contr->active;	2636	return unless $self->contr->active;
1847	$self->activate_recursive;
1848		2637
1849	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2638	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1850	$self->enter_map ($map, $x, $y);	2639	$self->enter_map ($map, $x, $y);
1851	}
1852		2640
1853	cf::player->attach (	2641	# only activate afterwards, to support waiting in hooks
1854	on_logout => sub {	2642	$self->activate_recursive;
1855	my ($pl) = @_;	2643	}
1856		2644
1857	# abort map switching before logout	2645	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1858	if ($pl->ob->{_link_pos}) {
1859	cf::sync_job {
1860	$pl->ob->leave_link
1861	};
1862	}
1863	},
1864	on_login => sub {
1865	my ($pl) = @_;
1866		2646
1867	# try to abort aborted map switching on player login :)	2647	Moves the player to the given map-path and coordinates by first freezing
1868	# should happen only on crashes	2648	her, loading and preparing them map, calling the provided $check callback
1869	if ($pl->ob->{_link_pos}) {	2649	that has to return the map if sucecssful, and then unfreezes the player on
1870	$pl->ob->enter_link;	2650	the new (success) or old (failed) map position. In either case, $done will
1871	(async {	2651	be called at the end of this process.
1872	$pl->ob->reply (undef,
1873	"There was an internal problem at your last logout, "
1874	. "the server will try to bring you to your intended destination in a second.",
1875	cf::NDI_RED);
1876	# we need this sleep as the login has a concurrent enter_exit running
1877	# and this sleep increases chances of the player not ending up in scorn
1878	Coro::Timer::sleep 1;
1879	$pl->ob->leave_link;
1880	})->prio (2);
1881	}
1882	},
1883	);
1884		2652
1885	=item $player_object->goto ($path, $x, $y)	2653	Note that $check will be called with a potentially non-loaded map, so if
		2654	it needs a loaded map it has to call C<< ->load >>.
1886		2655
1887	=cut	2656	=cut
		2657
		2658	our $GOTOGEN;
1888		2659
1889	sub cf::object::player::goto {	2660	sub cf::object::player::goto {
1890	my ($self, $path, $x, $y) = @_;	2661	my ($self, $path, $x, $y, $check, $done) = @_;
		2662
		2663	# do generation counting so two concurrent goto's will be executed in-order
		2664	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1891		2665
1892	$self->enter_link;	2666	$self->enter_link;
1893		2667
1894	(async {	2668	(async {
		2669	$Coro::current->{desc} = "player::goto $path $x $y";
		2670
		2671	# *tag paths override both path and x|y
		2672	if ($path =~ /^\*(.*)$/) {
		2673	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2674	my $ob = $obs[rand @obs];
		2675
		2676	# see if we actually can go there
		2677	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2678	$ob = $obs[rand @obs];
		2679	} else {
		2680	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2681	}
		2682	# else put us there anyways for now #d#
		2683
		2684	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2685	} else {
		2686	($path, $x, $y) = (undef, undef, undef);
		2687	}
		2688	}
		2689
1895	my $map = eval {	2690	my $map = eval {
1896	my $map = cf::map::find $path;	2691	my $map = defined $path ? cf::map::find $path : undef;
		2692
		2693	if ($map) {
1897	$map = $map->customise_for ($self) if $map;	2694	$map = $map->customise_for ($self);
		2695	$map = $check->($map) if $check && $map;
		2696	} else {
		2697	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2698	}
		2699
1898	$map	2700	$map
		2701	};
		2702
		2703	if ($@) {
		2704	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2705	LOG llevError | logBacktrace, Carp::longmess $@;
1899	} or	2706	}
1900	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1901		2707
		2708	if ($gen == $self->{_goto_generation}) {
		2709	delete $self->{_goto_generation};
1902	$self->leave_link ($map, $x, $y);	2710	$self->leave_link ($map, $x, $y);
		2711	}
		2712
		2713	$done->() if $done;
1903	})->prio (1);	2714	})->prio (1);
1904	}	2715	}
1905		2716
1906	=item $player_object->enter_exit ($exit_object)	2717	=item $player_object->enter_exit ($exit_object)
1907		2718
…		…
1927	}	2738	}
1928		2739
1929	sub prepare_random_map {	2740	sub prepare_random_map {
1930	my ($exit) = @_;	2741	my ($exit) = @_;
1931		2742
1932	my $guard = cf::lock_acquire "exit_prepare:$exit";
1933
1934	# all this does is basically replace the /! path by	2743	# all this does is basically replace the /! path by
1935	# a new random map path (?random/...) with a seed	2744	# a new random map path (?random/...) with a seed
1936	# that depends on the exit object	2745	# that depends on the exit object
1937		2746
1938	my $rmp = parse_random_map_params $exit->msg;	2747	my $rmp = parse_random_map_params $exit->msg;
…		…
1940	if ($exit->map) {	2749	if ($exit->map) {
1941	$rmp->{region} = $exit->region->name;	2750	$rmp->{region} = $exit->region->name;
1942	$rmp->{origin_map} = $exit->map->path;	2751	$rmp->{origin_map} = $exit->map->path;
1943	$rmp->{origin_x} = $exit->x;	2752	$rmp->{origin_x} = $exit->x;
1944	$rmp->{origin_y} = $exit->y;	2753	$rmp->{origin_y} = $exit->y;
		2754
		2755	$exit->map->touch;
1945	}	2756	}
1946		2757
1947	$rmp->{random_seed} ||= $exit->random_seed;	2758	$rmp->{random_seed} ||= $exit->random_seed;
1948		2759
1949	my $data = cf::to_json $rmp;	2760	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1950	my $md5 = Digest::MD5::md5_hex $data;	2761	my $md5 = Digest::MD5::md5_hex $data;
1951	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2762	my $meta = "$RANDOMDIR/$md5.meta";
1952		2763
1953	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2764	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1954	aio_write $fh, 0, (length $data), $data, 0;	2765	aio_write $fh, 0, (length $data), $data, 0;
1955	undef $fh;	2766	undef $fh;
1956	aio_rename "$meta~", $meta;	2767	aio_rename "$meta~", $meta;
1957		2768
		2769	my $slaying = "?random/$md5";
		2770
		2771	if ($exit->valid) {
1958	$exit->slaying ("?random/$md5");	2772	$exit->slaying ("?random/$md5");
1959	$exit->msg (undef);	2773	$exit->msg (undef);
		2774	}
1960	}	2775	}
1961	}	2776	}
1962		2777
1963	sub cf::object::player::enter_exit {	2778	sub cf::object::player::enter_exit {
1964	my ($self, $exit) = @_;	2779	my ($self, $exit) = @_;
1965		2780
1966	return unless $self->type == cf::PLAYER;	2781	return unless $self->type == cf::PLAYER;
1967		2782
1968	if ($exit->slaying eq "/!") {
1969	#TODO: this should de-fi-ni-te-ly not be a sync-job
1970	cf::sync_job { prepare_random_map $exit };
1971	}
1972
1973	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1974	my $hp = $exit->stats->hp;
1975	my $sp = $exit->stats->sp;
1976
1977	$self->enter_link;	2783	$self->enter_link;
1978		2784
1979	(async {	2785	(async {
1980	$self->deactivate_recursive; # just to be sure	2786	$Coro::current->{desc} = "enter_exit";
		2787
1981	unless (eval {	2788	unless (eval {
		2789	$self->deactivate_recursive; # just to be sure
		2790
		2791	# random map handling
		2792	{
		2793	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2794
		2795	prepare_random_map $exit
		2796	if $exit->slaying eq "/!";
		2797	}
		2798
		2799	my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2800	my $x = $exit->stats->hp;
		2801	my $y = $exit->stats->sp;
		2802
1982	$self->goto ($slaying, $hp, $sp);	2803	$self->goto ($map, $x, $y);
1983		2804
		2805	# if exit is damned, update players death & WoR home-position
		2806	$self->contr->savebed ($map, $x, $y)
		2807	if $exit->flag (cf::FLAG_DAMNED);
		2808
1984	1;	2809	1
1985	}) {	2810	}) {
1986	$self->message ("Something went wrong deep within the crossfire server. "	2811	$self->message ("Something went wrong deep within the deliantra server. "
1987	. "I'll try to bring you back to the map you were before. "	2812	. "I'll try to bring you back to the map you were before. "
1988	. "Please report this to the dungeon master!",	2813	. "Please report this to the dungeon master!",
1989	cf::NDI_UNIQUE | cf::NDI_RED);	2814	cf::NDI_UNIQUE | cf::NDI_RED);
1990		2815
1991	warn "ERROR in enter_exit: $@";	2816	warn "ERROR in enter_exit: $@";
1992	$self->leave_link;	2817	$self->leave_link;
1993	}	2818	}
1994	})->prio (1);	2819	})->prio (1);
…		…
2010		2835
2011	utf8::encode $text;	2836	utf8::encode $text;
2012	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2837	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2013	}	2838	}
2014		2839
		2840	=item $client->send_big_packet ($pkt)
		2841
		2842	Like C<send_packet>, but tries to compress large packets, and fragments
		2843	them as required.
		2844
		2845	=cut
		2846
		2847	our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
		2848
		2849	sub cf::client::send_big_packet {
		2850	my ($self, $pkt) = @_;
		2851
		2852	# try lzf for large packets
		2853	$pkt = "lzf " . Compress::LZF::compress $pkt
		2854	if 1024 <= length $pkt and $self->{can_lzf};
		2855
		2856	# split very large packets
		2857	if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
		2858	$self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
		2859	$pkt = "frag";
		2860	}
		2861
		2862	$self->send_packet ($pkt);
		2863	}
		2864
		2865	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2866
		2867	Send a drawinfo or msg packet to the client, formatting the msg for the
		2868	client if neccessary. C<$type> should be a string identifying the type of
		2869	the message, with C<log> being the default. If C<$color> is negative, suppress
		2870	the message unless the client supports the msg packet.
		2871
		2872	=cut
		2873
		2874	# non-persistent channels (usually the info channel)
		2875	our %CHANNEL = (
		2876	"c/motd" => {
		2877	id => "infobox",
		2878	title => "MOTD",
		2879	reply => undef,
		2880	tooltip => "The message of the day",
		2881	},
		2882	"c/identify" => {
		2883	id => "infobox",
		2884	title => "Identify",
		2885	reply => undef,
		2886	tooltip => "Items recently identified",
		2887	},
		2888	"c/examine" => {
		2889	id => "infobox",
		2890	title => "Examine",
		2891	reply => undef,
		2892	tooltip => "Signs and other items you examined",
		2893	},
		2894	"c/shopinfo" => {
		2895	id => "infobox",
		2896	title => "Shop Info",
		2897	reply => undef,
		2898	tooltip => "What your bargaining skill tells you about the shop",
		2899	},
		2900	"c/book" => {
		2901	id => "infobox",
		2902	title => "Book",
		2903	reply => undef,
		2904	tooltip => "The contents of a note or book",
		2905	},
		2906	"c/lookat" => {
		2907	id => "infobox",
		2908	title => "Look",
		2909	reply => undef,
		2910	tooltip => "What you saw there",
		2911	},
		2912	"c/who" => {
		2913	id => "infobox",
		2914	title => "Players",
		2915	reply => undef,
		2916	tooltip => "Shows players who are currently online",
		2917	},
		2918	"c/body" => {
		2919	id => "infobox",
		2920	title => "Body Parts",
		2921	reply => undef,
		2922	tooltip => "Shows which body parts you posess and are available",
		2923	},
		2924	"c/statistics" => {
		2925	id => "infobox",
		2926	title => "Statistics",
		2927	reply => undef,
		2928	tooltip => "Shows your primary statistics",
		2929	},
		2930	"c/skills" => {
		2931	id => "infobox",
		2932	title => "Skills",
		2933	reply => undef,
		2934	tooltip => "Shows your experience per skill and item power",
		2935	},
		2936	"c/shopitems" => {
		2937	id => "infobox",
		2938	title => "Shop Items",
		2939	reply => undef,
		2940	tooltip => "Shows the items currently for sale in this shop",
		2941	},
		2942	"c/resistances" => {
		2943	id => "infobox",
		2944	title => "Resistances",
		2945	reply => undef,
		2946	tooltip => "Shows your resistances",
		2947	},
		2948	"c/pets" => {
		2949	id => "infobox",
		2950	title => "Pets",
		2951	reply => undef,
		2952	tooltip => "Shows information abotu your pets/a specific pet",
		2953	},
		2954	"c/perceiveself" => {
		2955	id => "infobox",
		2956	title => "Perceive Self",
		2957	reply => undef,
		2958	tooltip => "You gained detailed knowledge about yourself",
		2959	},
		2960	"c/uptime" => {
		2961	id => "infobox",
		2962	title => "Uptime",
		2963	reply => undef,
		2964	tooltip => "How long the server has been running since last restart",
		2965	},
		2966	"c/mapinfo" => {
		2967	id => "infobox",
		2968	title => "Map Info",
		2969	reply => undef,
		2970	tooltip => "Information related to the maps",
		2971	},
		2972	"c/party" => {
		2973	id => "party",
		2974	title => "Party",
		2975	reply => "gsay ",
		2976	tooltip => "Messages and chat related to your party",
		2977	},
		2978	"c/death" => {
		2979	id => "death",
		2980	title => "Death",
		2981	reply => undef,
		2982	tooltip => "Reason for and more info about your most recent death",
		2983	},
		2984	"c/say" => $SAY_CHANNEL,
		2985	"c/chat" => $CHAT_CHANNEL,
		2986	);
		2987
		2988	sub cf::client::send_msg {
		2989	my ($self, $channel, $msg, $color, @extra) = @_;
		2990
		2991	$msg = $self->pl->expand_cfpod ($msg)
		2992	unless $color & cf::NDI_VERBATIM;
		2993
		2994	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2995
		2996	# check predefined channels, for the benefit of C
		2997	if ($CHANNEL{$channel}) {
		2998	$channel = $CHANNEL{$channel};
		2999
		3000	$self->ext_msg (channel_info => $channel);
		3001	$channel = $channel->{id};
		3002
		3003	} elsif (ref $channel) {
		3004	# send meta info to client, if not yet sent
		3005	unless (exists $self->{channel}{$channel->{id}}) {
		3006	$self->{channel}{$channel->{id}} = $channel;
		3007	$self->ext_msg (channel_info => $channel);
		3008	}
		3009
		3010	$channel = $channel->{id};
		3011	}
		3012
		3013	return unless @extra || length $msg;
		3014
		3015	# default colour, mask it out
		3016	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		3017	if $color & cf::NDI_DEF;
		3018
		3019	my $pkt = "msg "
		3020	. $self->{json_coder}->encode (
		3021	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
		3022	);
		3023
		3024	$self->send_big_packet ($pkt);
		3025	}
		3026
2015	=item $client->ext_event ($type, %msg)	3027	=item $client->ext_msg ($type, @msg)
2016		3028
2017	Sends an exti event to the client.	3029	Sends an ext event to the client.
2018		3030
2019	=cut	3031	=cut
2020		3032
2021	sub cf::client::ext_event($$%) {	3033	sub cf::client::ext_msg($$@) {
2022	my ($self, $type, %msg) = @_;	3034	my ($self, $type, @msg) = @_;
2023		3035
		3036	if ($self->extcmd == 2) {
		3037	$self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		3038	} elsif ($self->extcmd == 1) { # TODO: remove
2024	$msg{msgtype} = "event_$type";	3039	push @msg, msgtype => "event_$type";
2025	$self->send_packet ("ext " . cf::to_json \%msg);	3040	$self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		3041	}
		3042	}
		3043
		3044	=item $client->ext_reply ($msgid, @msg)
		3045
		3046	Sends an ext reply to the client.
		3047
		3048	=cut
		3049
		3050	sub cf::client::ext_reply($$@) {
		3051	my ($self, $id, @msg) = @_;
		3052
		3053	if ($self->extcmd == 2) {
		3054	$self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		3055	} elsif ($self->extcmd == 1) {
		3056	#TODO: version 1, remove
		3057	unshift @msg, msgtype => "reply", msgid => $id;
		3058	$self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		3059	}
2026	}	3060	}
2027		3061
2028	=item $success = $client->query ($flags, "text", \&cb)	3062	=item $success = $client->query ($flags, "text", \&cb)
2029		3063
2030	Queues a query to the client, calling the given callback with	3064	Queues a query to the client, calling the given callback with
2031	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	3065	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2032	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	3066	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2033		3067
2034	Queries can fail, so check the return code. Or don't, as queries will become	3068	Queries can fail, so check the return code. Or don't, as queries will
2035	reliable at some point in the future.	3069	become reliable at some point in the future.
2036		3070
2037	=cut	3071	=cut
2038		3072
2039	sub cf::client::query {	3073	sub cf::client::query {
2040	my ($self, $flags, $text, $cb) = @_;	3074	my ($self, $flags, $text, $cb) = @_;
…		…
2048	utf8::encode $text;	3082	utf8::encode $text;
2049	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3083	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2050		3084
2051	$self->send_packet ($self->{query_queue}[0][0])	3085	$self->send_packet ($self->{query_queue}[0][0])
2052	if @{ $self->{query_queue} } == 1;	3086	if @{ $self->{query_queue} } == 1;
		3087
		3088	1
2053	}	3089	}
2054		3090
2055	cf::client->attach (	3091	cf::client->attach (
		3092	on_connect => sub {
		3093	my ($ns) = @_;
		3094
		3095	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		3096	},
2056	on_reply => sub {	3097	on_reply => sub {
2057	my ($ns, $msg) = @_;	3098	my ($ns, $msg) = @_;
2058		3099
2059	# this weird shuffling is so that direct followup queries	3100	# this weird shuffling is so that direct followup queries
2060	# get handled first	3101	# get handled first
…		…
2072	} else {	3113	} else {
2073	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3114	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2074	}	3115	}
2075	}	3116	}
2076	},	3117	},
		3118	on_exticmd => sub {
		3119	my ($ns, $buf) = @_;
		3120
		3121	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		3122
		3123	if (ref $msg) {
		3124	my ($type, $reply, @payload) =
		3125	"ARRAY" eq ref $msg
		3126	? @$msg
		3127	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		3128
		3129	my @reply;
		3130
		3131	if (my $cb = $EXTICMD{$type}) {
		3132	@reply = $cb->($ns, @payload);
		3133	}
		3134
		3135	$ns->ext_reply ($reply, @reply)
		3136	if $reply;
		3137
		3138	} else {
		3139	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		3140	}
		3141
		3142	cf::override;
		3143	},
2077	);	3144	);
2078		3145
2079	=item $client->async (\&cb)	3146	=item $client->async (\&cb)
2080		3147
2081	Create a new coroutine, running the specified callback. The coroutine will	3148	Create a new coroutine, running the specified callback. The coroutine will
…		…
2097		3164
2098	$coro	3165	$coro
2099	}	3166	}
2100		3167
2101	cf::client->attach (	3168	cf::client->attach (
2102	on_destroy => sub {	3169	on_client_destroy => sub {
2103	my ($ns) = @_;	3170	my ($ns) = @_;
2104		3171
2105	$_->cancel for values %{ (delete $ns->{_coro}) || {} };	3172	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
2106	},	3173	},
2107	);	3174	);
…		…
2122	our $safe = new Safe "safe";	3189	our $safe = new Safe "safe";
2123	our $safe_hole = new Safe::Hole;	3190	our $safe_hole = new Safe::Hole;
2124		3191
2125	$SIG{FPE} = 'IGNORE';	3192	$SIG{FPE} = 'IGNORE';
2126		3193
2127	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3194	$safe->permit_only (Opcode::opset qw(
		3195	:base_core :base_mem :base_orig :base_math :base_loop
		3196	grepstart grepwhile mapstart mapwhile
		3197	sort time
		3198	));
2128		3199
2129	# here we export the classes and methods available to script code	3200	# here we export the classes and methods available to script code
2130		3201
2131	=pod	3202	=pod
2132		3203
2133	The following functions and methods are available within a safe environment:	3204	The following functions and methods are available within a safe environment:
2134		3205
2135	cf::object contr pay_amount pay_player map	3206	cf::object
		3207	contr pay_amount pay_player map x y force_find force_add destroy
		3208	insert remove name archname title slaying race decrease split
		3209	value
		3210
2136	cf::object::player player	3211	cf::object::player
2137	cf::player peaceful	3212	player
2138	cf::map trigger	3213
		3214	cf::player
		3215	peaceful
		3216
		3217	cf::map
		3218	trigger
2139		3219
2140	=cut	3220	=cut
2141		3221
2142	for (	3222	for (
2143	["cf::object" => qw(contr pay_amount pay_player map)],	3223	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3224	insert remove inv nrof name archname title slaying race
		3225	decrease split destroy change_exp value msg lore send_msg)],
2144	["cf::object::player" => qw(player)],	3226	["cf::object::player" => qw(player)],
2145	["cf::player" => qw(peaceful)],	3227	["cf::player" => qw(peaceful send_msg)],
2146	["cf::map" => qw(trigger)],	3228	["cf::map" => qw(trigger)],
2147	) {	3229	) {
2148	no strict 'refs';	3230	no strict 'refs';
2149	my ($pkg, @funs) = @$_;	3231	my ($pkg, @funs) = @$_;
2150	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3232	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
2168		3250
2169	my $qcode = $code;	3251	my $qcode = $code;
2170	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3252	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2171	$qcode =~ s/\n/\\n/g;	3253	$qcode =~ s/\n/\\n/g;
2172		3254
		3255	%vars = (_dummy => 0) unless %vars;
		3256
		3257	my @res;
2173	local $_;	3258	local $_;
2174	local @safe::cf::_safe_eval_args = values %vars;
2175		3259
2176	my $eval =	3260	my $eval =
2177	"do {\n"	3261	"do {\n"
2178	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	3262	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2179	. "#line 0 \"{$qcode}\"\n"	3263	. "#line 0 \"{$qcode}\"\n"
2180	. $code	3264	. $code
2181	. "\n}"	3265	. "\n}"
2182	;	3266	;
2183		3267
		3268	if ($CFG{safe_eval}) {
2184	sub_generation_inc;	3269	sub_generation_inc;
		3270	local @safe::cf::_safe_eval_args = values %vars;
2185	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);	3271	@res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2186	sub_generation_inc;	3272	sub_generation_inc;
		3273	} else {
		3274	local @cf::_safe_eval_args = values %vars;
		3275	@res = wantarray ? eval eval : scalar eval $eval;
		3276	}
2187		3277
2188	if ($@) {	3278	if ($@) {
2189	warn "$@";	3279	warn "$@";
2190	warn "while executing safe code '$code'\n";	3280	warn "while executing safe code '$code'\n";
2191	warn "with arguments " . (join " ", %vars) . "\n";	3281	warn "with arguments " . (join " ", %vars) . "\n";
…		…
2210	=cut	3300	=cut
2211		3301
2212	sub register_script_function {	3302	sub register_script_function {
2213	my ($fun, $cb) = @_;	3303	my ($fun, $cb) = @_;
2214		3304
2215	no strict 'refs';	3305	$fun = "safe::$fun" if $CFG{safe_eval};
2216	*{"safe::$fun"} = $safe_hole->wrap ($cb);	3306	*$fun = $safe_hole->wrap ($cb);
2217	}	3307	}
2218		3308
2219	=back	3309	=back
2220		3310
2221	=cut	3311	=cut
2222
2223	#############################################################################
2224
2225	=head2 EXTENSION DATABASE SUPPORT
2226
2227	Crossfire maintains a very simple database for extension use. It can
2228	currently store anything that can be serialised using Storable, which
2229	excludes objects.
2230
2231	The parameter C<$family> should best start with the name of the extension
2232	using it, it should be unique.
2233
2234	=over 4
2235
2236	=item $value = cf::db_get $family => $key
2237
2238	Returns a single value from the database.
2239
2240	=item cf::db_put $family => $key => $value
2241
2242	Stores the given C<$value> in the family.
2243
2244	=cut
2245
2246	our $DB;
2247
2248	sub db_init {
2249	unless ($DB) {
2250	$DB = BDB::db_create $DB_ENV;
2251
2252	cf::sync_job {
2253	eval {
2254	$DB->set_flags (BDB::CHKSUM);
2255
2256	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2257	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2258	cf::cleanup "db_open(db): $!" if $!;
2259	};
2260	cf::cleanup "db_open(db): $@" if $@;
2261	};
2262
2263	my $path = cf::localdir . "/database.pst";
2264	if (stat $path) {
2265	cf::sync_job {
2266	my $pst = Storable::retrieve $path;
2267
2268	cf::db_put (board => data => $pst->{board});
2269	cf::db_put (guildrules => data => $pst->{guildrules});
2270	cf::db_put (rent => balance => $pst->{rent}{balance});
2271	BDB::db_env_txn_checkpoint $DB_ENV;
2272
2273	unlink $path;
2274	};
2275	}
2276	}
2277	}
2278
2279	sub db_get($$) {
2280	my $key = "$_[0]/$_[1]";
2281
2282	cf::sync_job {
2283	BDB::db_get $DB, undef, $key, my $data;
2284
2285	$! ? ()
2286	: Compress::LZF::sthaw $data
2287	}
2288	}
2289
2290	sub db_put($$$) {
2291	BDB::dbreq_pri 4;
2292	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2293	}
2294		3312
2295	#############################################################################	3313	#############################################################################
2296	# the server's init and main functions	3314	# the server's init and main functions
2297		3315
2298	sub load_facedata {	3316	sub load_facedata($) {
2299	my $path = sprintf "%s/facedata", cf::datadir;	3317	my ($path) = @_;
		3318
		3319	# HACK to clear player env face cache, we need some signal framework
		3320	# for this (global event?)
		3321	%ext::player_env::MUSIC_FACE_CACHE = ();
		3322
		3323	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2300		3324
2301	warn "loading facedata from $path\n";	3325	warn "loading facedata from $path\n";
2302		3326
2303	my $faces;	3327	my $facedata;
2304	0 < aio_load $path, $faces	3328	0 < aio_load $path, $facedata
2305	or die "$path: $!";	3329	or die "$path: $!";
2306		3330
2307	Coro::cede;
2308	$faces = Storable::thaw $faces;	3331	$facedata = Coro::Storable::thaw $facedata;
2309	Coro::cede;
2310		3332
2311	my $meta = delete $faces->{""};
2312	$meta->{version} == 1	3333	$facedata->{version} == 2
2313	or cf::cleanup "$path: version mismatch, cannot proceed.";	3334	or cf::cleanup "$path: version mismatch, cannot proceed.";
2314		3335
		3336	# patch in the exptable
		3337	my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
		3338	$facedata->{resource}{"res/exp_table"} = {
		3339	type => FT_RSRC,
		3340	data => $exp_table,
		3341	hash => (Digest::MD5::md5 $exp_table),
		3342	};
		3343	cf::cede_to_tick;
		3344
		3345	{
		3346	my $faces = $facedata->{faceinfo};
		3347
2315	while (my ($face, $info) = each %$faces) {	3348	while (my ($face, $info) = each %$faces) {
2316	my $idx = (cf::face::find $face) || cf::face::alloc $face;	3349	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2317	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	3350
		3351	cf::face::set_visibility $idx, $info->{visibility};
		3352	cf::face::set_magicmap $idx, $info->{magicmap};
2318	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	3353	cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
2319	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	3354	cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
2320	Coro::cede;
2321	}
2322		3355
		3356	cf::cede_to_tick;
		3357	}
		3358
2323	while (my ($face, $info) = each %$faces) {	3359	while (my ($face, $info) = each %$faces) {
2324	next unless $info->{smooth};	3360	next unless $info->{smooth};
		3361
2325	my $idx = cf::face::find $face	3362	my $idx = cf::face::find $face
2326	or next;	3363	or next;
		3364
2327	if (my $smooth = cf::face::find $info->{smooth}) {	3365	if (my $smooth = cf::face::find $info->{smooth}) {
2328	cf::face::set_smooth $idx, $smooth;	3366	cf::face::set_smooth $idx, $smooth;
		3367	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2329	} else {	3368	} else {
2330	warn "smooth face '$info->{smooth}' not found for face '$face'";	3369	warn "smooth face '$info->{smooth}' not found for face '$face'";
2331	}	3370	}
2332	Coro::cede;	3371
		3372	cf::cede_to_tick;
		3373	}
		3374	}
		3375
2333	}	3376	{
		3377	my $anims = $facedata->{animinfo};
		3378
		3379	while (my ($anim, $info) = each %$anims) {
		3380	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3381	cf::cede_to_tick;
		3382	}
		3383
		3384	cf::anim::invalidate_all; # d'oh
		3385	}
		3386
		3387	{
		3388	my $res = $facedata->{resource};
		3389
		3390	while (my ($name, $info) = each %$res) {
		3391	if (defined $info->{type}) {
		3392	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3393
		3394	cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
		3395	cf::face::set_type $idx, $info->{type};
		3396	} else {
		3397	$RESOURCE{$name} = $info;
		3398	}
		3399
		3400	cf::cede_to_tick;
		3401	}
		3402	}
		3403
		3404	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
2334		3405
2335	1	3406	1
2336	}	3407	}
2337		3408
		3409	cf::global->attach (on_resource_update => sub {
		3410	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3411	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3412
		3413	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3414	my $sound = $soundconf->{compat}[$_]
		3415	or next;
		3416
		3417	my $face = cf::face::find "sound/$sound->[1]";
		3418	cf::sound::set $sound->[0] => $face;
		3419	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3420	}
		3421
		3422	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3423	my $face = cf::face::find "sound/$v";
		3424	cf::sound::set $k => $face;
		3425	}
		3426	}
		3427	});
		3428
		3429	register_exticmd fx_want => sub {
		3430	my ($ns, $want) = @_;
		3431
		3432	while (my ($k, $v) = each %$want) {
		3433	$ns->fx_want ($k, $v);
		3434	}
		3435	};
		3436
		3437	sub load_resource_file($) {
		3438	my $guard = lock_acquire "load_resource_file";
		3439
		3440	my $status = load_resource_file_ $_[0];
		3441	get_slot 0.1, 100;
		3442	cf::arch::commit_load;
		3443
		3444	$status
		3445	}
		3446
		3447	sub reload_regions {
		3448	# HACK to clear player env face cache, we need some signal framework
		3449	# for this (global event?)
		3450	%ext::player_env::MUSIC_FACE_CACHE = ();
		3451
		3452	load_resource_file "$MAPDIR/regions"
		3453	or die "unable to load regions file\n";
		3454
		3455	for (cf::region::list) {
		3456	$_->{match} = qr/$_->{match}/
		3457	if exists $_->{match};
		3458	}
		3459	}
		3460
		3461	sub reload_facedata {
		3462	load_facedata "$DATADIR/facedata"
		3463	or die "unable to load facedata\n";
		3464	}
		3465
		3466	sub reload_archetypes {
		3467	load_resource_file "$DATADIR/archetypes"
		3468	or die "unable to load archetypes\n";
		3469	}
		3470
		3471	sub reload_treasures {
		3472	load_resource_file "$DATADIR/treasures"
		3473	or die "unable to load treasurelists\n";
		3474	}
		3475
2338	sub reload_resources {	3476	sub reload_resources {
2339	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir	3477	warn "reloading resource files...\n";
2340	or die "unable to load regions file\n";#d#	3478
2341	load_facedata	3479	reload_facedata;
2342	or die "unable to load facedata\n";#d#	3480	reload_archetypes;
2343	}
2344
2345	sub init {
2346	reload_resources;	3481	reload_regions;
2347	}	3482	reload_treasures;
2348		3483
2349	sub cfg_load {	3484	warn "finished reloading resource files\n";
		3485	}
		3486
		3487	sub reload_config {
		3488	warn "reloading config file...\n";
		3489
2350	open my $fh, "<:utf8", cf::confdir . "/config"	3490	open my $fh, "<:utf8", "$CONFDIR/config"
2351	or return;	3491	or return;
2352		3492
2353	local $/;	3493	local $/;
2354	*CFG = YAML::Syck::Load <$fh>;	3494	*CFG = YAML::XS::Load scalar <$fh>;
2355		3495
2356	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3496	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2357		3497
2358	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	3498	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2359	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	3499	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
…		…
2363	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3503	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2364	and die "WARNING: m(un)lockall failed: $!\n";	3504	and die "WARNING: m(un)lockall failed: $!\n";
2365	};	3505	};
2366	warn $@ if $@;	3506	warn $@ if $@;
2367	}	3507	}
		3508
		3509	warn "finished reloading resource files\n";
		3510	}
		3511
		3512	sub pidfile() {
		3513	sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
		3514	or die "$PIDFILE: $!";
		3515	flock $fh, &Fcntl::LOCK_EX
		3516	or die "$PIDFILE: flock: $!";
		3517	$fh
		3518	}
		3519
		3520	# make sure only one server instance is running at any one time
		3521	sub atomic {
		3522	my $fh = pidfile;
		3523
		3524	my $pid = <$fh>;
		3525	kill 9, $pid if $pid > 0;
		3526
		3527	seek $fh, 0, 0;
		3528	print $fh $$;
		3529	}
		3530
		3531	sub main_loop {
		3532	warn "EV::loop starting\n";
		3533	if (1) {
		3534	EV::loop;
		3535	}
		3536	warn "EV::loop returned\n";
		3537	goto &main_loop unless $REALLY_UNLOOP;
2368	}	3538	}
2369		3539
2370	sub main {	3540	sub main {
		3541	cf::init_globals; # initialise logging
		3542
		3543	LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
		3544	LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
		3545	LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
		3546	LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
		3547
		3548	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
		3549
2371	# we must not ever block the main coroutine	3550	# we must not ever block the main coroutine
2372	local $Coro::idle = sub {	3551	local $Coro::idle = sub {
2373	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3552	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2374	(async {	3553	(async {
2375	Event::one_event;	3554	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3555	EV::loop EV::LOOP_ONESHOT;
2376	})->prio (Coro::PRIO_MAX);	3556	})->prio (Coro::PRIO_MAX);
2377	};	3557	};
2378		3558
2379	cfg_load;	3559	evthread_start IO::AIO::poll_fileno;
		3560
		3561	cf::sync_job {
		3562	cf::init_experience;
		3563	cf::init_anim;
		3564	cf::init_attackmess;
		3565	cf::init_dynamic;
		3566
		3567	cf::load_settings;
		3568	cf::load_materials;
		3569
		3570	reload_resources;
		3571	reload_config;
2380	db_init;	3572	db_init;
		3573
		3574	cf::init_uuid;
		3575	cf::init_signals;
		3576	cf::init_skills;
		3577
		3578	cf::init_beforeplay;
		3579
		3580	atomic;
		3581
2381	load_extensions;	3582	load_extensions;
2382		3583
2383	$TICK_WATCHER->start;	3584	utime time, time, $RUNTIMEFILE;
2384	Event::loop;	3585
		3586	# no (long-running) fork's whatsoever before this point(!)
		3587	use POSIX ();
		3588	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3589
		3590	(pop @POST_INIT)->(0) while @POST_INIT;
		3591	};
		3592
		3593	cf::object::thawer::errors_are_fatal 0;
		3594
		3595	main_loop;
2385	}	3596	}
2386		3597
2387	#############################################################################	3598	#############################################################################
2388	# initialisation and cleanup	3599	# initialisation and cleanup
2389		3600
2390	# install some emergency cleanup handlers	3601	# install some emergency cleanup handlers
2391	BEGIN {	3602	BEGIN {
		3603	our %SIGWATCHER = ();
2392	for my $signal (qw(INT HUP TERM)) {	3604	for my $signal (qw(INT HUP TERM)) {
2393	Event->signal (	3605	$SIGWATCHER{$signal} = AE::signal $signal, sub {
2394	reentrant => 0,
2395	data => WF_AUTOCANCEL,
2396	signal => $signal,
2397	prio => 0,
2398	cb => sub {
2399	cf::cleanup "SIG$signal";	3606	cf::cleanup "SIG$signal";
2400	},
2401	);	3607	};
		3608	}
		3609	}
		3610
		3611	sub write_runtime_sync {
		3612	my $t0 = AE::time;
		3613
		3614	# first touch the runtime file to show we are still running:
		3615	# the fsync below can take a very very long time.
		3616
		3617	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3618
		3619	my $guard = cf::lock_acquire "write_runtime";
		3620
		3621	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
		3622	or return;
		3623
		3624	my $value = $cf::RUNTIME + 90 + 10;
		3625	# 10 is the runtime save interval, for a monotonic clock
		3626	# 60 allows for the watchdog to kill the server.
		3627
		3628	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3629	and return;
		3630
		3631	# always fsync - this file is important
		3632	aio_fsync $fh
		3633	and return;
		3634
		3635	# touch it again to show we are up-to-date
		3636	aio_utime $fh, undef, undef;
		3637
		3638	close $fh
		3639	or return;
		3640
		3641	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3642	and return;
		3643
		3644	warn sprintf "runtime file written (%gs).\n", AE::time - $t0;
		3645
2402	}	3646	1
		3647	}
		3648
		3649	our $uuid_lock;
		3650	our $uuid_skip;
		3651
		3652	sub write_uuid_sync($) {
		3653	$uuid_skip ||= $_[0];
		3654
		3655	return if $uuid_lock;
		3656	local $uuid_lock = 1;
		3657
		3658	my $uuid = "$LOCALDIR/uuid";
		3659
		3660	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3661	or return;
		3662
		3663	my $value = uuid_seq uuid_cur;
		3664
		3665	unless ($value) {
		3666	warn "cowardly refusing to write zero uuid value!\n";
		3667	return;
		3668	}
		3669
		3670	my $value = uuid_str $value + $uuid_skip;
		3671	$uuid_skip = 0;
		3672
		3673	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3674	and return;
		3675
		3676	# always fsync - this file is important
		3677	aio_fsync $fh
		3678	and return;
		3679
		3680	close $fh
		3681	or return;
		3682
		3683	aio_rename "$uuid~", $uuid
		3684	and return;
		3685
		3686	warn "uuid file written ($value).\n";
		3687
		3688	1
		3689
		3690	}
		3691
		3692	sub write_uuid($$) {
		3693	my ($skip, $sync) = @_;
		3694
		3695	$sync ? write_uuid_sync $skip
		3696	: async { write_uuid_sync $skip };
2403	}	3697	}
2404		3698
2405	sub emergency_save() {	3699	sub emergency_save() {
2406	my $freeze_guard = cf::freeze_mainloop;	3700	my $freeze_guard = cf::freeze_mainloop;
2407		3701
2408	warn "enter emergency perl save\n";	3702	warn "emergency_perl_save: enter\n";
2409		3703
2410	cf::sync_job {	3704	cf::sync_job {
		3705	# this is a trade-off: we want to be very quick here, so
		3706	# save all maps without fsync, and later call a global sync
		3707	# (which in turn might be very very slow)
		3708	local $USE_FSYNC = 0;
		3709
2411	# use a peculiar iteration method to avoid tripping on perl	3710	# use a peculiar iteration method to avoid tripping on perl
2412	# refcount bugs in for. also avoids problems with players	3711	# refcount bugs in for. also avoids problems with players
2413	# and maps saved/destroyed asynchronously.	3712	# and maps saved/destroyed asynchronously.
2414	warn "begin emergency player save\n";	3713	warn "emergency_perl_save: begin player save\n";
2415	for my $login (keys %cf::PLAYER) {	3714	for my $login (keys %cf::PLAYER) {
2416	my $pl = $cf::PLAYER{$login} or next;	3715	my $pl = $cf::PLAYER{$login} or next;
2417	$pl->valid or next;	3716	$pl->valid or next;
		3717	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2418	$pl->save;	3718	$pl->save;
2419	}	3719	}
2420	warn "end emergency player save\n";	3720	warn "emergency_perl_save: end player save\n";
2421		3721
2422	warn "begin emergency map save\n";	3722	warn "emergency_perl_save: begin map save\n";
2423	for my $path (keys %cf::MAP) {	3723	for my $path (keys %cf::MAP) {
2424	my $map = $cf::MAP{$path} or next;	3724	my $map = $cf::MAP{$path} or next;
2425	$map->valid or next;	3725	$map->valid or next;
2426	$map->save;	3726	$map->save;
2427	}	3727	}
2428	warn "end emergency map save\n";	3728	warn "emergency_perl_save: end map save\n";
2429		3729
2430	warn "begin emergency database checkpoint\n";	3730	warn "emergency_perl_save: begin database checkpoint\n";
2431	BDB::db_env_txn_checkpoint $DB_ENV;	3731	BDB::db_env_txn_checkpoint $DB_ENV;
2432	warn "end emergency database checkpoint\n";	3732	warn "emergency_perl_save: end database checkpoint\n";
		3733
		3734	warn "emergency_perl_save: begin write uuid\n";
		3735	write_uuid_sync 1;
		3736	warn "emergency_perl_save: end write uuid\n";
2433	};	3737	};
2434		3738
		3739	warn "emergency_perl_save: starting sync()\n";
		3740	IO::AIO::aio_sync sub {
		3741	warn "emergency_perl_save: finished sync()\n";
		3742	};
		3743
2435	warn "leave emergency perl save\n";	3744	warn "emergency_perl_save: leave\n";
2436	}	3745	}
2437		3746
2438	sub post_cleanup {	3747	sub post_cleanup {
2439	my ($make_core) = @_;	3748	my ($make_core) = @_;
2440		3749
2441	warn Carp::longmess "post_cleanup backtrace"	3750	warn Carp::longmess "post_cleanup backtrace"
2442	if $make_core;	3751	if $make_core;
2443	}
2444		3752
		3753	my $fh = pidfile;
		3754	unlink $PIDFILE if <$fh> == $$;
		3755	}
		3756
		3757	# a safer delete_package, copied from Symbol
		3758	sub clear_package($) {
		3759	my $pkg = shift;
		3760
		3761	# expand to full symbol table name if needed
		3762	unless ($pkg =~ /^main::.*::$/) {
		3763	$pkg = "main$pkg" if $pkg =~ /^::/;
		3764	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3765	$pkg .= '::' unless $pkg =~ /::$/;
		3766	}
		3767
		3768	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3769	my $stem_symtab = *{$stem}{HASH};
		3770
		3771	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3772	or return;
		3773
		3774	# clear all symbols
		3775	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3776	for my $name (keys %$leaf_symtab) {
		3777	_gv_clear *{"$pkg$name"};
		3778	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3779	}
		3780	warn "cleared package $pkg\n";#d#
		3781	}
		3782
2445	sub reload() {	3783	sub do_reload_perl() {
2446	# can/must only be called in main	3784	# can/must only be called in main
2447	if ($Coro::current != $Coro::main) {	3785	if ($Coro::current != $Coro::main) {
2448	warn "can only reload from main coroutine";	3786	warn "can only reload from main coroutine";
2449	return;	3787	return;
2450	}	3788	}
2451		3789
		3790	return if $RELOAD++;
		3791
		3792	my $t1 = AE::time;
		3793
		3794	while ($RELOAD) {
2452	warn "reloading...";	3795	warn "reloading...";
2453		3796
2454	warn "entering sync_job";	3797	warn "entering sync_job";
2455		3798
2456	cf::sync_job {	3799	cf::sync_job {
2457	cf::write_runtime; # external watchdog should not bark	3800	cf::write_runtime_sync; # external watchdog should not bark
2458	cf::emergency_save;	3801	cf::emergency_save;
2459	cf::write_runtime; # external watchdog should not bark	3802	cf::write_runtime_sync; # external watchdog should not bark
2460		3803
2461	warn "syncing database to disk";	3804	warn "syncing database to disk";
2462	BDB::db_env_txn_checkpoint $DB_ENV;	3805	BDB::db_env_txn_checkpoint $DB_ENV;
2463		3806
2464	# if anything goes wrong in here, we should simply crash as we already saved	3807	# if anything goes wrong in here, we should simply crash as we already saved
2465		3808
2466	warn "cancelling all WF_AUTOCANCEL watchers";
2467	for (Event::all_watchers) {
2468	$_->cancel if $_->data & WF_AUTOCANCEL;
2469	}
2470
2471	warn "flushing outstanding aio requests";	3809	warn "flushing outstanding aio requests";
2472	for (;;) {
2473	BDB::flush;
2474	IO::AIO::flush;
2475	Coro::cede;
2476	last unless IO::AIO::nreqs || BDB::nreqs;	3810	while (IO::AIO::nreqs || BDB::nreqs) {
2477	warn "iterate...";	3811	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2478	}
2479
2480	++$RELOAD;
2481
2482	warn "cancelling all extension coros";
2483	$_->cancel for values %EXT_CORO;
2484	%EXT_CORO = ();
2485
2486	warn "removing commands";
2487	%COMMAND = ();
2488
2489	warn "removing ext commands";
2490	%EXTCMD = ();
2491
2492	warn "unloading/nuking all extensions";
2493	for my $pkg (@EXTS) {
2494	warn "... unloading $pkg";
2495
2496	if (my $cb = $pkg->can ("unload")) {
2497	eval {
2498	$cb->($pkg);
2499	1
2500	} or warn "$pkg unloaded, but with errors: $@";
2501	}	3812	}
2502		3813
2503	warn "... nuking $pkg";	3814	warn "cancelling all extension coros";
2504	Symbol::delete_package $pkg;	3815	$_->cancel for values %EXT_CORO;
2505	}	3816	%EXT_CORO = ();
2506		3817
2507	warn "unloading all perl modules loaded from $LIBDIR";	3818	warn "removing commands";
2508	while (my ($k, $v) = each %INC) {	3819	%COMMAND = ();
2509	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2510		3820
		3821	warn "removing ext/exti commands";
		3822	%EXTCMD = ();
		3823	%EXTICMD = ();
		3824
		3825	warn "unloading/nuking all extensions";
		3826	for my $pkg (@EXTS) {
2511	warn "... unloading $k";	3827	warn "... unloading $pkg";
2512	delete $INC{$k};
2513		3828
2514	$k =~ s/\.pm$//;
2515	$k =~ s/\//::/g;
2516
2517	if (my $cb = $k->can ("unload_module")) {	3829	if (my $cb = $pkg->can ("unload")) {
		3830	eval {
2518	$cb->();	3831	$cb->($pkg);
		3832	1
		3833	} or warn "$pkg unloaded, but with errors: $@";
		3834	}
		3835
		3836	warn "... clearing $pkg";
		3837	clear_package $pkg;
2519	}	3838	}
2520		3839
2521	Symbol::delete_package $k;	3840	warn "unloading all perl modules loaded from $LIBDIR";
		3841	while (my ($k, $v) = each %INC) {
		3842	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3843
		3844	warn "... unloading $k";
		3845	delete $INC{$k};
		3846
		3847	$k =~ s/\.pm$//;
		3848	$k =~ s/\//::/g;
		3849
		3850	if (my $cb = $k->can ("unload_module")) {
		3851	$cb->();
		3852	}
		3853
		3854	clear_package $k;
2522	}	3855	}
2523		3856
2524	warn "getting rid of safe::, as good as possible";	3857	warn "getting rid of safe::, as good as possible";
2525	Symbol::delete_package "safe::$_"	3858	clear_package "safe::$_"
2526	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3859	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2527		3860
2528	warn "unloading cf.pm \"a bit\"";	3861	warn "unloading cf.pm \"a bit\"";
2529	delete $INC{"cf.pm"};	3862	delete $INC{"cf.pm"};
		3863	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2530		3864
2531	# don't, removes xs symbols, too,	3865	# don't, removes xs symbols, too,
2532	# and global variables created in xs	3866	# and global variables created in xs
2533	#Symbol::delete_package __PACKAGE__;	3867	#clear_package __PACKAGE__;
2534		3868
2535	warn "unload completed, starting to reload now";	3869	warn "unload completed, starting to reload now";
2536		3870
2537	warn "reloading cf.pm";	3871	warn "reloading cf.pm";
2538	require cf;	3872	require cf;
2539	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3873	cf::_connect_to_perl_1;
2540		3874
2541	warn "loading config and database again";	3875	warn "loading config and database again";
2542	cf::cfg_load;	3876	cf::reload_config;
2543		3877
2544	warn "loading extensions";	3878	warn "loading extensions";
2545	cf::load_extensions;	3879	cf::load_extensions;
2546		3880
		3881	if ($REATTACH_ON_RELOAD) {
2547	warn "reattaching attachments to objects/players";	3882	warn "reattaching attachments to objects/players";
2548	_global_reattach; # objects, sockets	3883	_global_reattach; # objects, sockets
2549	warn "reattaching attachments to maps";	3884	warn "reattaching attachments to maps";
2550	reattach $_ for values %MAP;	3885	reattach $_ for values %MAP;
2551	warn "reattaching attachments to players";	3886	warn "reattaching attachments to players";
2552	reattach $_ for values %PLAYER;	3887	reattach $_ for values %PLAYER;
		3888	}
2553		3889
2554	warn "loading reloadable resources";	3890	warn "running post_init jobs";
2555	reload_resources;	3891	(pop @POST_INIT)->(1) while @POST_INIT;
2556		3892
2557	warn "leaving sync_job";	3893	warn "leaving sync_job";
2558		3894
2559	1	3895	1
2560	} or do {	3896	} or do {
2561	warn $@;	3897	warn $@;
2562	warn "error while reloading, exiting.";	3898	cf::cleanup "error while reloading, exiting.";
2563	exit 1;	3899	};
		3900
		3901	warn "reloaded";
		3902	--$RELOAD;
		3903	}
		3904
		3905	$t1 = AE::time - $t1;
		3906	warn "reload completed in ${t1}s\n";
		3907	};
		3908
		3909	our $RELOAD_WATCHER; # used only during reload
		3910
		3911	sub reload_perl() {
		3912	# doing reload synchronously and two reloads happen back-to-back,
		3913	# coro crashes during coro_state_free->destroy here.
		3914
		3915	$RELOAD_WATCHER ||= cf::async {
		3916	Coro::AIO::aio_wait cache_extensions;
		3917
		3918	$RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
		3919	do_reload_perl;
		3920	undef $RELOAD_WATCHER;
		3921	};
2564	};	3922	};
2565		3923	}
2566	warn "reloaded";
2567	};
2568
2569	our $RELOAD_WATCHER; # used only during reload
2570		3924
2571	register_command "reload" => sub {	3925	register_command "reload" => sub {
2572	my ($who, $arg) = @_;	3926	my ($who, $arg) = @_;
2573		3927
2574	if ($who->flag (FLAG_WIZ)) {	3928	if ($who->flag (FLAG_WIZ)) {
2575	$who->message ("reloading server.");	3929	$who->message ("reloading server.");
2576		3930	async {
2577	# doing reload synchronously and two reloads happen back-to-back,	3931	$Coro::current->{desc} = "perl_reload";
2578	# coro crashes during coro_state_free->destroy here.
2579
2580	$RELOAD_WATCHER ||= Event->timer (
2581	reentrant => 0,
2582	after => 0,
2583	data => WF_AUTOCANCEL,
2584	cb => sub {
2585	reload;	3932	reload_perl;
2586	undef $RELOAD_WATCHER;
2587	},
2588	);	3933	};
2589	}	3934	}
2590	};	3935	};
2591		3936
2592	unshift @INC, $LIBDIR;	3937	unshift @INC, $LIBDIR;
2593		3938
2594	my $bug_warning = 0;	3939	my $bug_warning = 0;
2595		3940
2596	$TICK_WATCHER = Event->timer (	3941	our @WAIT_FOR_TICK;
2597	reentrant => 0,	3942	our @WAIT_FOR_TICK_BEGIN;
2598	parked => 1,	3943
2599	prio => 0,	3944	sub wait_for_tick {
2600	at => $NEXT_TICK || $TICK,	3945	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2601	data => WF_AUTOCANCEL,	3946
2602	cb => sub {	3947	my $signal = new Coro::Signal;
		3948	push @WAIT_FOR_TICK, $signal;
		3949	$signal->wait;
		3950	}
		3951
		3952	sub wait_for_tick_begin {
		3953	return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
		3954
		3955	my $signal = new Coro::Signal;
		3956	push @WAIT_FOR_TICK_BEGIN, $signal;
		3957	$signal->wait;
		3958	}
		3959
		3960	sub tick {
2603	if ($Coro::current != $Coro::main) {	3961	if ($Coro::current != $Coro::main) {
2604	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3962	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2605	unless ++$bug_warning > 10;	3963	unless ++$bug_warning > 10;
2606	return;	3964	return;
2607	}	3965	}
2608		3966
2609	$NOW = Event::time;
2610
2611	cf::server_tick; # one server iteration	3967	cf::server_tick; # one server iteration
2612	$RUNTIME += $TICK;
2613	$NEXT_TICK += $TICK;
2614		3968
		3969	#for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
		3970
2615	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3971	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2616	$NEXT_RUNTIME_WRITE = $NOW + 10;	3972	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2617	Coro::async_pool {	3973	Coro::async_pool {
		3974	$Coro::current->{desc} = "runtime saver";
2618	write_runtime	3975	write_runtime_sync
2619	or warn "ERROR: unable to write runtime file: $!";	3976	or warn "ERROR: unable to write runtime file: $!";
2620	};
2621	}	3977	};
2622
2623	$WAIT_FOR_TICK->broadcast;
2624	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2625
2626	# my $AFTER = Event::time;
2627	# warn $AFTER - $NOW;#d#
2628
2629	# if we are delayed by four ticks or more, skip them all
2630	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2631
2632	$TICK_WATCHER->at ($NEXT_TICK);
2633	$TICK_WATCHER->start;
2634	},	3978	}
2635	);	3979
		3980	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3981	$sig->send;
		3982	}
		3983	while (my $sig = shift @WAIT_FOR_TICK) {
		3984	$sig->send;
		3985	}
		3986
		3987	$LOAD = ($NOW - $TICK_START) / $TICK;
		3988	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3989
		3990	if (0) {
		3991	if ($NEXT_TICK) {
		3992	my $jitter = $TICK_START - $NEXT_TICK;
		3993	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3994	warn "jitter $JITTER\n";#d#
		3995	}
		3996	}
		3997	}
2636		3998
2637	{	3999	{
2638	BDB::max_poll_time $TICK * 0.1;	4000	# configure BDB
2639	$BDB_POLL_WATCHER = Event->io (	4001
2640	reentrant => 0,
2641	fd => BDB::poll_fileno,
2642	poll => 'r',
2643	prio => 0,
2644	data => WF_AUTOCANCEL,
2645	cb => \&BDB::poll_cb,
2646	);
2647	BDB::min_parallel 8;	4002	BDB::min_parallel 16;
2648		4003	BDB::max_poll_reqs $TICK * 0.1;
2649	BDB::set_sync_prepare {	4004	$AnyEvent::BDB::WATCHER->priority (1);
2650	my $status;
2651	my $current = $Coro::current;
2652	(
2653	sub {
2654	$status = $!;
2655	$current->ready; undef $current;
2656	},
2657	sub {
2658	Coro::schedule while defined $current;
2659	$! = $status;
2660	},
2661	)
2662	};
2663		4005
2664	unless ($DB_ENV) {	4006	unless ($DB_ENV) {
2665	$DB_ENV = BDB::db_env_create;	4007	$DB_ENV = BDB::db_env_create;
		4008	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		4009	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		4010	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		4011	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		4012	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2666		4013
2667	cf::sync_job {	4014	cf::sync_job {
2668	eval {	4015	eval {
2669	BDB::db_env_open	4016	BDB::db_env_open
2670	$DB_ENV,	4017	$DB_ENV,
2671	$BDB_ENV_DIR,	4018	$BDBDIR,
2672	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	4019	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2673	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	4020	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2674	0666;	4021	0666;
2675		4022
2676	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	4023	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2677
2678	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2679	$DB_ENV->set_lk_detect;
2680	};	4024	};
2681		4025
2682	cf::cleanup "db_env_open(db): $@" if $@;	4026	cf::cleanup "db_env_open(db): $@" if $@;
2683	};	4027	};
2684	}	4028	}
		4029
		4030	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		4031	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		4032	};
		4033	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		4034	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		4035	};
		4036	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		4037	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		4038	};
2685	}	4039	}
2686		4040
2687	{	4041	{
		4042	# configure IO::AIO
		4043
2688	IO::AIO::min_parallel 8;	4044	IO::AIO::min_parallel 8;
2689
2690	undef $Coro::AIO::WATCHER;
2691	IO::AIO::max_poll_time $TICK * 0.1;	4045	IO::AIO::max_poll_time $TICK * 0.1;
2692	$AIO_POLL_WATCHER = Event->io (	4046	undef $AnyEvent::AIO::WATCHER;
2693	reentrant => 0,
2694	data => WF_AUTOCANCEL,
2695	fd => IO::AIO::poll_fileno,
2696	poll => 'r',
2697	prio => 6,
2698	cb => \&IO::AIO::poll_cb,
2699	);
2700	}	4047	}
		4048
		4049	my $_log_backtrace;
		4050
		4051	sub _log_backtrace {
		4052	my ($msg, @addr) = @_;
		4053
		4054	$msg =~ s/\n//;
		4055
		4056	# limit the # of concurrent backtraces
		4057	if ($_log_backtrace < 2) {
		4058	++$_log_backtrace;
		4059	my $perl_bt = Carp::longmess $msg;
		4060	async {
		4061	$Coro::current->{desc} = "abt $msg";
		4062
		4063	my @bt = fork_call {
		4064	@addr = map { sprintf "%x", $_ } @addr;
		4065	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4066	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4067	or die "addr2line: $!";
		4068
		4069	my @funcs;
		4070	my @res = <$fh>;
		4071	chomp for @res;
		4072	while (@res) {
		4073	my ($func, $line) = splice @res, 0, 2, ();
		4074	push @funcs, "[$func] $line";
		4075	}
		4076
		4077	@funcs
		4078	};
		4079
		4080	LOG llevInfo, "[ABT] $perl_bt\n";
		4081	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4082	LOG llevInfo, "[ABT] $_\n" for @bt;
		4083	--$_log_backtrace;
		4084	};
		4085	} else {
		4086	LOG llevInfo, "[ABT] $msg\n";
		4087	LOG llevInfo, "[ABT] [suppressed]\n";
		4088	}
		4089	}
		4090
		4091	# load additional modules
		4092	require "cf/$_.pm" for @EXTRA_MODULES;
		4093	cf::_connect_to_perl_2;
2701		4094
2702	END { cf::emergency_save }	4095	END { cf::emergency_save }
2703		4096
2704	1	4097	1
2705		4098

Diff Legend

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