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.86 by root, Thu Dec 14 05:09:32 2006 UTC vs.
Revision 1.521 by root, Fri Apr 16 23:28:42 2010 UTC

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

Diff Legend

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