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

Diff Legend

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