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

Diff Legend

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