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

Diff Legend

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