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

Diff Legend

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