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

Diff Legend

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