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.205 by root, Mon Feb 5 18:29:20 2007 UTC vs.
Revision 1.482 by root, Sun Oct 11 05:31:54 2009 UTC

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

Diff Legend

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