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.12 by root, Tue Mar 28 16:48:11 2006 UTC vs.
Revision 1.292 by root, Tue Jul 3 00:54:57 2007 UTC

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

Diff Legend

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