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

Diff Legend

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