ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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