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.52 by root, Mon Aug 28 16:52:51 2006 UTC vs.
Revision 1.373 by root, Sat Sep 15 15:58:06 2007 UTC

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

Diff Legend

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