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.75 by root, Mon Oct 2 00:22:01 2006 UTC vs.
Revision 1.479 by root, Thu Oct 8 05:04:27 2009 UTC

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

Diff Legend

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