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.101 by root, Mon Dec 25 14:43:23 2006 UTC vs.
Revision 1.549 by root, Tue May 11 13:19:59 2010 UTC

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

Diff Legend

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