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

Diff Legend

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