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

Diff Legend

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