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

Diff Legend

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