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

Diff Legend

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