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

Diff Legend

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