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

Diff Legend

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