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

Diff Legend

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