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.391 by root, Fri Oct 26 04:22:05 2007 UTC

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

Diff Legend

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