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.83 by root, Mon Dec 11 01:30:41 2006 UTC vs.
Revision 1.552 by root, Mon May 17 21:12:59 2010 UTC

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

Diff Legend

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