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.90 by root, Sat Dec 16 04:22:13 2006 UTC vs.
Revision 1.281 by root, Sat Jun 16 23:22:59 2007 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
		8	use Socket;
5	use Storable;	9	use Storable;
		10	use Event;
6	use Opcode;	11	use Opcode;
7	use Safe;	12	use Safe;
8	use Safe::Hole;	13	use Safe::Hole;
9		14
10	use IO::AIO ();	15	use Coro 3.61 ();
		16	use Coro::State;
		17	use Coro::Handle;
		18	use Coro::Event;
		19	use Coro::Timer;
		20	use Coro::Signal;
		21	use Coro::Semaphore;
		22	use Coro::AIO;
		23	use Coro::Storable;
		24
		25	use BDB ();
		26	use Data::Dumper;
		27	use Digest::MD5;
		28	use Fcntl;
11	use YAML::Syck ();	29	use YAML::Syck ();
		30	use IO::AIO 2.32 ();
12	use Time::HiRes;	31	use Time::HiRes;
13	use Event;	32	use Compress::LZF;
		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		39
14	$Event::Eval = 1; # no idea why this is required, but it is	40	$Event::Eval = 1; # no idea why this is required, but it is
15		41
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
18		44
19	use strict;	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20		46
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		48
23	our %COMMAND = ();	49	our %COMMAND = ();
24	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
		51
		52	our @EXTS = (); # list of extension package names
25	our %EXTCMD = ();	53	our %EXTCMD = ();
		54	our %EXT_CORO = (); # coroutines bound to extensions
		55	our %EXT_MAP = (); # pluggable maps
26		56
27	_init_vars;	57	our $RELOAD; # number of reloads so far
28
29	our @EVENT;	58	our @EVENT;
30	our $LIBDIR = datadir . "/ext";
31		59
32	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
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
33	our $TICK_WATCHER;	73	our $TICK_WATCHER;
		74	our $AIO_POLL_WATCHER;
		75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
34	our $NEXT_TICK;	76	our $NEXT_TICK;
		77	our $NOW;
		78	our $USE_FSYNC = 1; # use fsync to write maps - default off
		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
35		82
36	our %CFG;	83	our %CFG;
37		84
38	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
		86	our $RUNTIME;
		87
		88	our %PLAYER; # all users
		89	our %MAP; # all maps
		90	our $LINK_MAP; # the special {link} map, which is always available
		91
		92	# used to convert map paths into valid unix filenames by replacing / by ∕
		93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		94
		95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		96	our $LOADAVG; # same thing, but with alpha-smoothing
		97	our $tick_start; # for load detecting purposes
		98
		99	binmode STDOUT;
		100	binmode STDERR;
		101
		102	# read virtual server time, if available
		103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
		104	open my $fh, "<", "$LOCALDIR/runtime"
		105	or die "unable to read runtime file: $!";
		106	$RUNTIME = <$fh> + 0.;
		107	}
		108
		109	mkdir $_
		110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
		111
		112	our $EMERGENCY_POSITION;
		113
		114	sub cf::map::normalise;
39		115
40	#############################################################################	116	#############################################################################
41		117
42	=head2 GLOBAL VARIABLES	118	=head2 GLOBAL VARIABLES
43		119
…		…
45		121
46	=item $cf::UPTIME	122	=item $cf::UPTIME
47		123
48	The timestamp of the server start (so not actually an uptime).	124	The timestamp of the server start (so not actually an uptime).
49		125
50	=item $cf::LIBDIR	126	=item $cf::RUNTIME
51		127
52	The perl library directory, where extensions and cf-specific modules can	128	The time this server has run, starts at 0 and is increased by $cf::TICK on
53	be found. It will be added to C<@INC> automatically.	129	every server tick.
		130
		131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
		134
		135	Various directories - "/etc", read-only install directory, perl-library
		136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		137	unique-items directory, player file directory, random maps directory and
		138	database environment.
		139
		140	=item $cf::NOW
		141
		142	The time of the last (current) server tick.
54		143
55	=item $cf::TICK	144	=item $cf::TICK
56		145
57	The interval between server ticks, in seconds.	146	The interval between server ticks, in seconds.
		147
		148	=item $cf::LOADAVG
		149
		150	The current CPU load on the server (alpha-smoothed), as a value between 0
		151	(none) and 1 (overloaded), indicating how much time is spent on processing
		152	objects per tick. Healthy values are < 0.5.
		153
		154	=item $cf::LOAD
		155
		156	The raw value load value from the last tick.
58		157
59	=item %cf::CFG	158	=item %cf::CFG
60		159
61	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
62	from wherever your confdir points to.	161	from wherever your confdir points to.
		162
		163	=item cf::wait_for_tick, cf::wait_for_tick_begin
		164
		165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		166	returns directly I<after> the tick processing (and consequently, can only wake one process
		167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
63		168
64	=back	169	=back
65		170
66	=cut	171	=cut
67		172
68	BEGIN {	173	BEGIN {
69	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	175	my $msg = join "", @_;
		176
71	$msg .= "\n"	177	$msg .= "\n"
72	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
73		179
74	print STDERR "cfperl: $msg";	180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
75	LOG llevError, "cfperl: $msg";	183	LOG llevError, $msg;
76	};	184	};
77	}	185	}
78		186
		187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		192	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
79	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	193	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
80		194
81	# we bless all objects into (empty) derived classes to force a method lookup	195	# we bless all objects into (empty) derived classes to force a method lookup
82	# within the Safe compartment.	196	# within the Safe compartment.
83	for my $pkg (qw(	197	for my $pkg (qw(
		198	cf::global cf::attachable
84	cf::object cf::object::player	199	cf::object cf::object::player
85	cf::client cf::player	200	cf::client cf::player
86	cf::arch cf::living	201	cf::arch cf::living
87	cf::map cf::party cf::region	202	cf::map cf::party cf::region
88	)) {	203	)) {
…		…
92		207
93	$Event::DIED = sub {	208	$Event::DIED = sub {
94	warn "error in event callback: @_";	209	warn "error in event callback: @_";
95	};	210	};
96		211
97	my %ext_pkg;	212	#############################################################################
98	my @exts;
99	my @hook;
100		213
101	=head2 UTILITY FUNCTIONS	214	=head2 UTILITY FUNCTIONS
102		215
103	=over 4	216	=over 4
104		217
105	=cut	218	=item dumpval $ref
106		219
		220	=cut
		221
		222	sub dumpval {
		223	eval {
		224	local $SIG{__DIE__};
		225	my $d;
		226	if (1) {
		227	$d = new Data::Dumper([$_[0]], ["*var"]);
		228	$d->Terse(1);
		229	$d->Indent(2);
		230	$d->Quotekeys(0);
		231	$d->Useqq(1);
		232	#$d->Bless(...);
		233	$d->Seen($_[1]) if @_ > 1;
		234	$d = $d->Dump();
		235	}
		236	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		237	$d
		238	} || "[unable to dump $_[0]: '$@']";
		239	}
		240
107	use JSON::Syck (); # TODO# replace by JSON::PC once working	241	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
108		242
109	=item $ref = cf::from_json $json	243	=item $ref = cf::from_json $json
110		244
111	Converts a JSON string into the corresponding perl data structure.	245	Converts a JSON string into the corresponding perl data structure.
112		246
113	=cut
114
115	sub from_json($) {
116	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
117	JSON::Syck::Load $_[0]
118	}
119
120	=item $json = cf::to_json $ref	247	=item $json = cf::to_json $ref
121		248
122	Converts a perl data structure into its JSON representation.	249	Converts a perl data structure into its JSON representation.
123		250
124	=cut	251	=item cf::lock_wait $string
125		252
126	sub to_json($) {	253	Wait until the given lock is available. See cf::lock_acquire.
127	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	254
128	JSON::Syck::Dump $_[0]	255	=item my $lock = cf::lock_acquire $string
		256
		257	Wait until the given lock is available and then acquires it and returns
		258	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		259	for example when the coroutine gets canceled), the lock is automatically
		260	returned.
		261
		262	Lock names should begin with a unique identifier (for example, cf::map::find
		263	uses map_find and cf::map::load uses map_load).
		264
		265	=item $locked = cf::lock_active $string
		266
		267	Return true if the lock is currently active, i.e. somebody has locked it.
		268
		269	=cut
		270
		271	our %LOCK;
		272
		273	sub lock_wait($) {
		274	my ($key) = @_;
		275
		276	# wait for lock, if any
		277	while ($LOCK{$key}) {
		278	push @{ $LOCK{$key} }, $Coro::current;
		279	Coro::schedule;
		280	}
		281	}
		282
		283	sub lock_acquire($) {
		284	my ($key) = @_;
		285
		286	# wait, to be sure we are not locked
		287	lock_wait $key;
		288
		289	$LOCK{$key} = [];
		290
		291	Coro::guard {
		292	# wake up all waiters, to be on the safe side
		293	$_->ready for @{ delete $LOCK{$key} };
		294	}
		295	}
		296
		297	sub lock_active($) {
		298	my ($key) = @_;
		299
		300	! ! $LOCK{$key}
		301	}
		302
		303	sub freeze_mainloop {
		304	return unless $TICK_WATCHER->is_active;
		305
		306	my $guard = Coro::guard {
		307	$TICK_WATCHER->start;
		308	};
		309	$TICK_WATCHER->stop;
		310	$guard
		311	}
		312
		313	=item cf::async { BLOCK }
		314
		315	Currently the same as Coro::async_pool, meaning you cannot use
		316	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		317	thing you are allowed to do is call C<prio> on it.
		318
		319	=cut
		320
		321	BEGIN { *async = \&Coro::async_pool }
		322
		323	=item cf::sync_job { BLOCK }
		324
		325	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
		326	is always able to handle events or runnable, as Crossfire TRT is only
		327	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		328	acceptable.
		329
		330	If it must be done, put the blocking parts into C<sync_job>. This will run
		331	the given BLOCK in another coroutine while waiting for the result. The
		332	server will be frozen during this time, so the block should either finish
		333	fast or be very important.
		334
		335	=cut
		336
		337	sub sync_job(&) {
		338	my ($job) = @_;
		339
		340	if ($Coro::current == $Coro::main) {
		341	my $time = Event::time;
		342
		343	# this is the main coro, too bad, we have to block
		344	# till the operation succeeds, freezing the server :/
		345
		346	# TODO: use suspend/resume instead
		347	# (but this is cancel-safe)
		348	my $freeze_guard = freeze_mainloop;
		349
		350	my $busy = 1;
		351	my @res;
		352
		353	(async {
		354	@res = eval { $job->() };
		355	warn $@ if $@;
		356	undef $busy;
		357	})->prio (Coro::PRIO_MAX);
		358
		359	while ($busy) {
		360	Coro::cede or Event::one_event;
		361	}
		362
		363	$time = Event::time - $time;
		364
		365	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		366	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		367
		368	$tick_start += $time; # do not account sync jobs to server load
		369
		370	wantarray ? @res : $res[0]
		371	} else {
		372	# we are in another coroutine, how wonderful, everything just works
		373
		374	$job->()
		375	}
		376	}
		377
		378	=item $coro = cf::async_ext { BLOCK }
		379
		380	Like async, but this coro is automatically being canceled when the
		381	extension calling this is being unloaded.
		382
		383	=cut
		384
		385	sub async_ext(&) {
		386	my $cb = shift;
		387
		388	my $coro = &Coro::async ($cb);
		389
		390	$coro->on_destroy (sub {
		391	delete $EXT_CORO{$coro+0};
		392	});
		393	$EXT_CORO{$coro+0} = $coro;
		394
		395	$coro
		396	}
		397
		398	=item fork_call { }, $args
		399
		400	Executes the given code block with the given arguments in a seperate
		401	process, returning the results. Everything must be serialisable with
		402	Coro::Storable. May, of course, block. Note that the executed sub may
		403	never block itself or use any form of Event handling.
		404
		405	=cut
		406
		407	sub fork_call(&@) {
		408	my ($cb, @args) = @_;
		409
		410	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		411	# or die "socketpair: $!";
		412	pipe my $fh1, my $fh2
		413	or die "pipe: $!";
		414
		415	if (my $pid = fork) {
		416	close $fh2;
		417
		418	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		419	$res = Coro::Storable::thaw $res;
		420
		421	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		422
		423	die $$res unless "ARRAY" eq ref $res;
		424
		425	return wantarray ? @$res : $res->[-1];
		426	} else {
		427	reset_signals;
		428	local $SIG{__WARN__};
		429	local $SIG{__DIE__};
		430	eval {
		431	close $fh1;
		432
		433	my @res = eval { $cb->(@args) };
		434	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		435	};
		436
		437	warn $@ if $@;
		438	_exit 0;
		439	}
		440	}
		441
		442	=item $value = cf::db_get $family => $key
		443
		444	Returns a single value from the environment database.
		445
		446	=item cf::db_put $family => $key => $value
		447
		448	Stores the given C<$value> in the family. It can currently store binary
		449	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		450
		451	=cut
		452
		453	our $DB;
		454
		455	sub db_init {
		456	unless ($DB) {
		457	$DB = BDB::db_create $DB_ENV;
		458
		459	cf::sync_job {
		460	eval {
		461	$DB->set_flags (BDB::CHKSUM);
		462
		463	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		464	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		465	cf::cleanup "db_open(db): $!" if $!;
		466	};
		467	cf::cleanup "db_open(db): $@" if $@;
		468	};
		469	}
		470	}
		471
		472	sub db_get($$) {
		473	my $key = "$_[0]/$_[1]";
		474
		475	cf::sync_job {
		476	BDB::db_get $DB, undef, $key, my $data;
		477
		478	$! ? ()
		479	: $data
		480	}
		481	}
		482
		483	sub db_put($$$) {
		484	BDB::dbreq_pri 4;
		485	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		486	}
		487
		488	=item cf::cache $id => [$paths...], $processversion => $process
		489
		490	Generic caching function that returns the value of the resource $id,
		491	caching and regenerating as required.
		492
		493	This function can block.
		494
		495	=cut
		496
		497	sub cache {
		498	my ($id, $src, $processversion, $process) = @_;
		499
		500	my $meta =
		501	join "\x00",
		502	$processversion,
		503	map {
		504	aio_stat $_
		505	and Carp::croak "$_: $!";
		506
		507	($_, (stat _)[7,9])
		508	} @$src;
		509
		510	my $dbmeta = db_get cache => "$id/meta";
		511	if ($dbmeta ne $meta) {
		512	# changed, we may need to process
		513
		514	my @data;
		515	my $md5;
		516
		517	for (0 .. $#$src) {
		518	0 <= aio_load $src->[$_], $data[$_]
		519	or Carp::croak "$src->[$_]: $!";
		520	}
		521
		522	# if processing is expensive, check
		523	# checksum first
		524	if (1) {
		525	$md5 =
		526	join "\x00",
		527	$processversion,
		528	map {
		529	Coro::cede;
		530	($src->[$_], Digest::MD5::md5_hex $data[$_])
		531	} 0.. $#$src;
		532
		533
		534	my $dbmd5 = db_get cache => "$id/md5";
		535	if ($dbmd5 eq $md5) {
		536	db_put cache => "$id/meta", $meta;
		537
		538	return db_get cache => "$id/data";
		539	}
		540	}
		541
		542	my $t1 = Time::HiRes::time;
		543	my $data = $process->(\@data);
		544	my $t2 = Time::HiRes::time;
		545
		546	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		547
		548	db_put cache => "$id/data", $data;
		549	db_put cache => "$id/md5" , $md5;
		550	db_put cache => "$id/meta", $meta;
		551
		552	return $data;
		553	}
		554
		555	db_get cache => "$id/data"
		556	}
		557
		558	=item cf::datalog type => key => value, ...
		559
		560	Log a datalog packet of the given type with the given key-value pairs.
		561
		562	=cut
		563
		564	sub datalog($@) {
		565	my ($type, %kv) = @_;
		566	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
129	}	567	}
130		568
131	=back	569	=back
132		570
133	=cut	571	=cut
134		572
135	#############################################################################	573	#############################################################################
136		574
137	=head2 EVENTS AND OBJECT ATTACHMENTS	575	=head2 ATTACHABLE OBJECTS
		576
		577	Many objects in crossfire are so-called attachable objects. That means you can
		578	attach callbacks/event handlers (a collection of which is called an "attachment")
		579	to it. All such attachable objects support the following methods.
		580
		581	In the following description, CLASS can be any of C<global>, C<object>
		582	C<player>, C<client> or C<map> (i.e. the attachable objects in
		583	Crossfire TRT).
138		584
139	=over 4	585	=over 4
140		586
141	=item $object->attach ($attachment, key => $value...)
142
143	=item $object->detach ($attachment)
144
145	Attach/detach a pre-registered attachment to an object.
146
147	=item $player->attach ($attachment, key => $value...)
148
149	=item $player->detach ($attachment)
150
151	Attach/detach a pre-registered attachment to a player.
152
153	=item $map->attach ($attachment, key => $value...)	587	=item $attachable->attach ($attachment, key => $value...)
154		588
155	=item $map->detach ($attachment)	589	=item $attachable->detach ($attachment)
156		590
157	Attach/detach a pre-registered attachment to a map.	591	Attach/detach a pre-registered attachment to a specific object and give it
		592	the specified key/value pairs as arguments.
158		593
159	=item $bool = $object->attached ($name)	594	Example, attach a minesweeper attachment to the given object, making it a
		595	10x10 minesweeper game:
160		596
161	=item $bool = $player->attached ($name)	597	$obj->attach (minesweeper => width => 10, height => 10);
162		598
163	=item $bool = $map->attached ($name)	599	=item $bool = $attachable->attached ($name)
164		600
165	Checks wether the named attachment is currently attached to the object.	601	Checks wether the named attachment is currently attached to the object.
166		602
167	=item cf::attach_global ...	603	=item cf::CLASS->attach ...
168		604
169	Attach handlers for global events.	605	=item cf::CLASS->detach ...
170		606
171	This and all following C<attach_*>-functions expect any number of the	607	Define an anonymous attachment and attach it to all objects of the given
172	following handler/hook descriptions:	608	CLASS. See the next function for an explanation of its arguments.
		609
		610	You can attach to global events by using the C<cf::global> class.
		611
		612	Example, log all player logins:
		613
		614	cf::player->attach (
		615	on_login => sub {
		616	my ($pl) = @_;
		617	...
		618	},
		619	);
		620
		621	Example, attach to the jeweler skill:
		622
		623	cf::object->attach (
		624	type => cf::SKILL,
		625	subtype => cf::SK_JEWELER,
		626	on_use_skill => sub {
		627	my ($sk, $ob, $part, $dir, $msg) = @_;
		628	...
		629	},
		630	);
		631
		632	=item cf::CLASS::attachment $name, ...
		633
		634	Register an attachment by C<$name> through which attachable objects of the
		635	given CLASS can refer to this attachment.
		636
		637	Some classes such as crossfire maps and objects can specify attachments
		638	that are attached at load/instantiate time, thus the need for a name.
		639
		640	These calls expect any number of the following handler/hook descriptions:
173		641
174	=over 4	642	=over 4
175		643
176	=item prio => $number	644	=item prio => $number
177		645
…		…
179	by another C<prio> setting). Lower priority handlers get executed	647	by another C<prio> setting). Lower priority handlers get executed
180	earlier. The default priority is C<0>, and many built-in handlers are	648	earlier. The default priority is C<0>, and many built-in handlers are
181	registered at priority C<-1000>, so lower priorities should not be used	649	registered at priority C<-1000>, so lower priorities should not be used
182	unless you know what you are doing.	650	unless you know what you are doing.
183		651
		652	=item type => $type
		653
		654	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		655	given type of objects only (the additional parameter C<subtype> can be
		656	used to further limit to the given subtype).
		657
184	=item on_I<event> => \&cb	658	=item on_I<event> => \&cb
185		659
186	Call the given code reference whenever the named event happens (event is	660	Call the given code reference whenever the named event happens (event is
187	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	661	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
188	handlers are recognised generally depends on the type of object these	662	handlers are recognised generally depends on the type of object these
…		…
197	package and register them. Only handlers for eevents supported by the	671	package and register them. Only handlers for eevents supported by the
198	object/class are recognised.	672	object/class are recognised.
199		673
200	=back	674	=back
201		675
202	=item cf::attach_to_type $object_type, $subtype, ...	676	Example, define an attachment called "sockpuppet" that calls the given
		677	event handler when a monster attacks:
203		678
204	Attach handlers for a specific object type (e.g. TRANSPORT) and	679	cf::object::attachment sockpuppet =>
205	subtype. If C<$subtype> is zero or undef, matches all objects of the given	680	on_skill_attack => sub {
206	type.	681	my ($self, $victim) = @_;
207		682	...
208	=item cf::attach_to_objects ...
209
210	Attach handlers to all objects. Do not use this except for debugging or
211	very rare events, as handlers are (obviously) called for I<all> objects in
212	the game.
213
214	=item cf::attach_to_players ...
215
216	Attach handlers to all players.
217
218	=item cf::attach_to_maps ...
219
220	Attach handlers to all maps.
221
222	=item cf:register_attachment $name, ...
223
224	Register an attachment by name through which objects can refer to this
225	attachment.
226
227	=item cf:register_player_attachment $name, ...
228
229	Register an attachment by name through which players can refer to this
230	attachment.
231
232	=item cf:register_map_attachment $name, ...
233
234	Register an attachment by name through which maps can refer to this
235	attachment.
236
237	=cut
238
239	# the following variables are defined in .xs and must not be re-created
240	our @CB_GLOBAL = (); # registry for all global events
241	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
242	our @CB_PLAYER = ();
243	our @CB_TYPE = (); # registry for type (cf-object class) based events
244	our @CB_MAP = ();
245
246	my %attachment;
247
248	sub _attach_cb($\%$$$) {
249	my ($registry, $undo, $event, $prio, $cb) = @_;
250
251	use sort 'stable';
252
253	$cb = [$prio, $cb];
254
255	@{$registry->[$event]} = sort
256	{ $a->[0] cmp $b->[0] }
257	@{$registry->[$event] || []}, $cb;
258
259	push @{$undo->{cb}}, [$event, $cb];
260	}
261
262	# attach handles attaching event callbacks
263	# the only thing the caller has to do is pass the correct
264	# registry (== where the callback attaches to).
265	sub _attach(\@$@) {
266	my ($registry, $klass, @arg) = @_;
267
268	my $prio = 0;
269
270	my %undo = (
271	registry => $registry,
272	cb => [],
273	);
274
275	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
276
277	while (@arg) {
278	my $type = shift @arg;
279
280	if ($type eq "prio") {
281	$prio = shift @arg;
282
283	} elsif ($type eq "package") {
284	my $pkg = shift @arg;
285
286	while (my ($name, $id) = each %cb_id) {
287	if (my $cb = $pkg->can ($name)) {
288	_attach_cb $registry, %undo, $id, $prio, $cb;
289	}
290	}	683	}
291
292	} elsif (exists $cb_id{$type}) {
293	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
294
295	} elsif (ref $type) {
296	warn "attaching objects not supported, ignoring.\n";
297
298	} else {
299	shift @arg;
300	warn "attach argument '$type' not supported, ignoring.\n";
301	}
302	}
303
304	\%undo
305	}
306
307	sub _attach_attachment {
308	my ($obj, $name, %arg) = @_;
309
310	return if exists $obj->{_attachment}{$name};
311
312	my $res;
313
314	if (my $attach = $attachment{$name}) {
315	my $registry = $obj->registry;
316
317	for (@$attach) {
318	my ($klass, @attach) = @$_;
319	$res = _attach @$registry, $klass, @attach;
320	}
321
322	$obj->{$name} = \%arg;
323	} else {
324	warn "object uses attachment '$name' that is not available, postponing.\n";
325	}
326
327	$obj->{_attachment}{$name} = undef;
328
329	$res->{attachment} = $name;
330	$res
331	}
332
333	*cf::object::attach =
334	*cf::player::attach =
335	*cf::map::attach = sub {
336	my ($obj, $name, %arg) = @_;
337
338	_attach_attachment $obj, $name, %arg;
339	};
340
341	# all those should be optimised
342	*cf::object::detach =
343	*cf::player::detach =
344	*cf::map::detach = sub {
345	my ($obj, $name) = @_;
346
347	delete $obj->{_attachment}{$name};
348	reattach ($obj);
349	};
350
351	*cf::object::attached =
352	*cf::player::attached =
353	*cf::map::attached = sub {
354	my ($obj, $name) = @_;
355
356	exists $obj->{_attachment}{$name}
357	};
358
359	sub attach_global {
360	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
361	}
362
363	sub attach_to_type {
364	my $type = shift;
365	my $subtype = shift;
366
367	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
368	}
369
370	sub attach_to_objects {
371	_attach @CB_OBJECT, KLASS_OBJECT, @_
372	}
373
374	sub attach_to_players {
375	_attach @CB_PLAYER, KLASS_PLAYER, @_
376	}
377
378	sub attach_to_maps {
379	_attach @CB_MAP, KLASS_MAP, @_
380	}
381
382	sub register_attachment {
383	my $name = shift;
384
385	$attachment{$name} = [[KLASS_OBJECT, @_]];
386	}
387
388	sub register_player_attachment {
389	my $name = shift;
390
391	$attachment{$name} = [[KLASS_PLAYER, @_]];
392	}
393
394	sub register_map_attachment {
395	my $name = shift;
396
397	$attachment{$name} = [[KLASS_MAP, @_]];
398	}
399
400	our $override;
401	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
402
403	sub override {
404	$override = 1;
405	@invoke_results = ();
406	}
407
408	sub do_invoke {
409	my $event = shift;
410	my $callbacks = shift;
411
412	@invoke_results = ();
413
414	local $override;
415
416	for (@$callbacks) {
417	eval { &{$_->[1]} };
418
419	if ($@) {
420	warn "$@";
421	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
422	override;
423	}
424
425	return 1 if $override;
426	}
427
428	0	684	}
429	}
430		685
431	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	686	=item $attachable->valid
432
433	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
434
435	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
436
437	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
438
439	Generate a global/object/player/map-specific event with the given arguments.
440
441	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
442	removed in future versions), and there is no public API to access override
443	results (if you must, access C<@cf::invoke_results> directly).
444
445	=back
446
447	=cut
448
449	#############################################################################
450
451	=head2 METHODS VALID FOR ALL CORE OBJECTS
452
453	=over 4
454
455	=item $object->valid, $player->valid, $map->valid
456		687
457	Just because you have a perl object does not mean that the corresponding	688	Just because you have a perl object does not mean that the corresponding
458	C-level object still exists. If you try to access an object that has no	689	C-level object still exists. If you try to access an object that has no
459	valid C counterpart anymore you get an exception at runtime. This method	690	valid C counterpart anymore you get an exception at runtime. This method
460	can be used to test for existence of the C object part without causing an	691	can be used to test for existence of the C object part without causing an
461	exception.	692	exception.
462		693
		694	=cut
		695
		696	# the following variables are defined in .xs and must not be re-created
		697	our @CB_GLOBAL = (); # registry for all global events
		698	our @CB_ATTACHABLE = (); # registry for all attachables
		699	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		700	our @CB_PLAYER = ();
		701	our @CB_CLIENT = ();
		702	our @CB_TYPE = (); # registry for type (cf-object class) based events
		703	our @CB_MAP = ();
		704
		705	my %attachment;
		706
		707	sub cf::attachable::thawer_merge {
		708	# simply override everything except _meta
		709	local $_[0]{_meta};
		710	%{$_[0]} = %{$_[1]};
		711	}
		712
		713	sub _attach_cb($$$$) {
		714	my ($registry, $event, $prio, $cb) = @_;
		715
		716	use sort 'stable';
		717
		718	$cb = [$prio, $cb];
		719
		720	@{$registry->[$event]} = sort
		721	{ $a->[0] cmp $b->[0] }
		722	@{$registry->[$event] || []}, $cb;
		723	}
		724
		725	# hack
		726	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		727
		728	# attach handles attaching event callbacks
		729	# the only thing the caller has to do is pass the correct
		730	# registry (== where the callback attaches to).
		731	sub _attach {
		732	my ($registry, $klass, @arg) = @_;
		733
		734	my $object_type;
		735	my $prio = 0;
		736	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		737
		738	#TODO: get rid of this hack
		739	if ($attachable_klass{$klass}) {
		740	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		741	}
		742
		743	while (@arg) {
		744	my $type = shift @arg;
		745
		746	if ($type eq "prio") {
		747	$prio = shift @arg;
		748
		749	} elsif ($type eq "type") {
		750	$object_type = shift @arg;
		751	$registry = $CB_TYPE[$object_type] ||= [];
		752
		753	} elsif ($type eq "subtype") {
		754	defined $object_type or Carp::croak "subtype specified without type";
		755	my $object_subtype = shift @arg;
		756	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
		757
		758	} elsif ($type eq "package") {
		759	my $pkg = shift @arg;
		760
		761	while (my ($name, $id) = each %cb_id) {
		762	if (my $cb = $pkg->can ($name)) {
		763	_attach_cb $registry, $id, $prio, $cb;
		764	}
		765	}
		766
		767	} elsif (exists $cb_id{$type}) {
		768	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		769
		770	} elsif (ref $type) {
		771	warn "attaching objects not supported, ignoring.\n";
		772
		773	} else {
		774	shift @arg;
		775	warn "attach argument '$type' not supported, ignoring.\n";
		776	}
		777	}
		778	}
		779
		780	sub _object_attach {
		781	my ($obj, $name, %arg) = @_;
		782
		783	return if exists $obj->{_attachment}{$name};
		784
		785	if (my $attach = $attachment{$name}) {
		786	my $registry = $obj->registry;
		787
		788	for (@$attach) {
		789	my ($klass, @attach) = @$_;
		790	_attach $registry, $klass, @attach;
		791	}
		792
		793	$obj->{$name} = \%arg;
		794	} else {
		795	warn "object uses attachment '$name' which is not available, postponing.\n";
		796	}
		797
		798	$obj->{_attachment}{$name} = undef;
		799	}
		800
		801	sub cf::attachable::attach {
		802	if (ref $_[0]) {
		803	_object_attach @_;
		804	} else {
		805	_attach shift->_attach_registry, @_;
		806	}
		807	_recalc_want;
		808	};
		809
		810	# all those should be optimised
		811	sub cf::attachable::detach {
		812	my ($obj, $name) = @_;
		813
		814	if (ref $obj) {
		815	delete $obj->{_attachment}{$name};
		816	reattach ($obj);
		817	} else {
		818	Carp::croak "cannot, currently, detach class attachments";
		819	}
		820	_recalc_want;
		821	};
		822
		823	sub cf::attachable::attached {
		824	my ($obj, $name) = @_;
		825
		826	exists $obj->{_attachment}{$name}
		827	}
		828
		829	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		830	eval "#line " . __LINE__ . " 'cf.pm'
		831	sub cf::\L$klass\E::_attach_registry {
		832	(\\\@CB_$klass, KLASS_$klass)
		833	}
		834
		835	sub cf::\L$klass\E::attachment {
		836	my \$name = shift;
		837
		838	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		839	}
		840	";
		841	die if $@;
		842	}
		843
		844	our $override;
		845	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		846
		847	sub override {
		848	$override = 1;
		849	@invoke_results = ();
		850	}
		851
		852	sub do_invoke {
		853	my $event = shift;
		854	my $callbacks = shift;
		855
		856	@invoke_results = ();
		857
		858	local $override;
		859
		860	for (@$callbacks) {
		861	eval { &{$_->[1]} };
		862
		863	if ($@) {
		864	warn "$@";
		865	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		866	override;
		867	}
		868
		869	return 1 if $override;
		870	}
		871
		872	0
		873	}
		874
		875	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		876
		877	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		878
		879	Generate an object-specific event with the given arguments.
		880
		881	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		882	removed in future versions), and there is no public API to access override
		883	results (if you must, access C<@cf::invoke_results> directly).
		884
463	=back	885	=back
464		886
465	=cut	887	=cut
466
467	*cf::object::valid =
468	*cf::player::valid =
469	*cf::map::valid = \&cf::_valid;
470		888
471	#############################################################################	889	#############################################################################
472	# object support	890	# object support
473		891
474	sub instantiate {
475	my ($obj, $data) = @_;
476
477	$data = from_json $data;
478
479	for (@$data) {
480	my ($name, $args) = @$_;
481
482	$obj->attach ($name, %{$args || {} });
483	}
484	}
485
486	# basically do the same as instantiate, without calling instantiate
487	sub reattach {	892	sub reattach {
		893	# basically do the same as instantiate, without calling instantiate
488	my ($obj) = @_;	894	my ($obj) = @_;
		895
		896	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		897
489	my $registry = $obj->registry;	898	my $registry = $obj->registry;
490		899
491	@$registry = ();	900	@$registry = ();
492		901
493	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	902	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
494		903
495	for my $name (keys %{ $obj->{_attachment} || {} }) {	904	for my $name (keys %{ $obj->{_attachment} || {} }) {
496	if (my $attach = $attachment{$name}) {	905	if (my $attach = $attachment{$name}) {
497	for (@$attach) {	906	for (@$attach) {
498	my ($klass, @attach) = @$_;	907	my ($klass, @attach) = @$_;
499	_attach @$registry, $klass, @attach;	908	_attach $registry, $klass, @attach;
500	}	909	}
501	} else {	910	} else {
502	warn "object uses attachment '$name' that is not available, postponing.\n";	911	warn "object uses attachment '$name' that is not available, postponing.\n";
503	}	912	}
504	}	913	}
505	}	914	}
506		915
507	sub object_freezer_save {	916	cf::attachable->attach (
508	my ($filename, $rdata, $objs) = @_;
509
510	if (length $$rdata) {
511	warn sprintf "saving %s (%d,%d)\n",
512	$filename, length $$rdata, scalar @$objs;
513
514	if (open my $fh, ">:raw", "$filename~") {
515	chmod SAVE_MODE, $fh;
516	syswrite $fh, $$rdata;
517	close $fh;
518
519	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
520	chmod SAVE_MODE, $fh;
521	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
522	close $fh;
523	rename "$filename.pst~", "$filename.pst";
524	} else {
525	unlink "$filename.pst";
526	}
527
528	rename "$filename~", $filename;
529	} else {
530	warn "FATAL: $filename~: $!\n";
531	}
532	} else {
533	unlink $filename;
534	unlink "$filename.pst";
535	}
536	}
537
538	sub object_freezer_as_string {
539	my ($rdata, $objs) = @_;
540
541	use Data::Dumper;
542
543	$$rdata . Dumper $objs
544	}
545
546	sub object_thawer_load {
547	my ($filename) = @_;
548
549	local $/;
550
551	my $av;
552
553	#TODO: use sysread etc.
554	if (open my $data, "<:raw:perlio", $filename) {
555	$data = <$data>;
556	if (open my $pst, "<:raw:perlio", "$filename.pst") {
557	$av = eval { (Storable::thaw <$pst>)->{objs} };
558	}
559	return ($data, $av);
560	}
561
562	()
563	}
564
565	attach_to_objects
566	prio => -1000000,	917	prio => -1000000,
		918	on_instantiate => sub {
		919	my ($obj, $data) = @_;
		920
		921	$data = from_json $data;
		922
		923	for (@$data) {
		924	my ($name, $args) = @$_;
		925
		926	$obj->attach ($name, %{$args || {} });
		927	}
		928	},
		929	on_reattach => \&reattach,
567	on_clone => sub {	930	on_clone => sub {
568	my ($src, $dst) = @_;	931	my ($src, $dst) = @_;
569		932
570	@{$dst->registry} = @{$src->registry};	933	@{$dst->registry} = @{$src->registry};
571		934
572	%$dst = %$src;	935	%$dst = %$src;
573		936
574	%{$dst->{_attachment}} = %{$src->{_attachment}}	937	%{$dst->{_attachment}} = %{$src->{_attachment}}
575	if exists $src->{_attachment};	938	if exists $src->{_attachment};
576	},	939	},
577	;	940	);
		941
		942	sub object_freezer_save {
		943	my ($filename, $rdata, $objs) = @_;
		944
		945	sync_job {
		946	if (length $$rdata) {
		947	warn sprintf "saving %s (%d,%d)\n",
		948	$filename, length $$rdata, scalar @$objs;
		949
		950	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		951	chmod SAVE_MODE, $fh;
		952	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		953	aio_fsync $fh if $cf::USE_FSYNC;
		954	close $fh;
		955
		956	if (@$objs) {
		957	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		958	chmod SAVE_MODE, $fh;
		959	my $data = Storable::nfreeze { version => 1, objs => $objs };
		960	aio_write $fh, 0, (length $data), $data, 0;
		961	aio_fsync $fh if $cf::USE_FSYNC;
		962	close $fh;
		963	aio_rename "$filename.pst~", "$filename.pst";
		964	}
		965	} else {
		966	aio_unlink "$filename.pst";
		967	}
		968
		969	aio_rename "$filename~", $filename;
		970	} else {
		971	warn "FATAL: $filename~: $!\n";
		972	}
		973	} else {
		974	aio_unlink $filename;
		975	aio_unlink "$filename.pst";
		976	}
		977	}
		978	}
		979
		980	sub object_freezer_as_string {
		981	my ($rdata, $objs) = @_;
		982
		983	use Data::Dumper;
		984
		985	$$rdata . Dumper $objs
		986	}
		987
		988	sub object_thawer_load {
		989	my ($filename) = @_;
		990
		991	my ($data, $av);
		992
		993	(aio_load $filename, $data) >= 0
		994	or return;
		995
		996	unless (aio_stat "$filename.pst") {
		997	(aio_load "$filename.pst", $av) >= 0
		998	or return;
		999	$av = eval { (Storable::thaw $av)->{objs} };
		1000	}
		1001
		1002	warn sprintf "loading %s (%d)\n",
		1003	$filename, length $data, scalar @{$av || []};
		1004	return ($data, $av);
		1005	}
		1006
		1007	=head2 COMMAND CALLBACKS
		1008
		1009	=over 4
		1010
		1011	=cut
578		1012
579	#############################################################################	1013	#############################################################################
580	# command handling &c	1014	# command handling &c
581		1015
582	=item cf::register_command $name => \&callback($ob,$args);	1016	=item cf::register_command $name => \&callback($ob,$args);
…		…
595	push @{ $COMMAND{$name} }, [$caller, $cb];	1029	push @{ $COMMAND{$name} }, [$caller, $cb];
596	}	1030	}
597		1031
598	=item cf::register_extcmd $name => \&callback($pl,$packet);	1032	=item cf::register_extcmd $name => \&callback($pl,$packet);
599		1033
600	Register a callbackf ro execution when the client sends an extcmd packet.	1034	Register a callback fro execution when the client sends an extcmd packet.
601		1035
602	If the callback returns something, it is sent back as if reply was being	1036	If the callback returns something, it is sent back as if reply was being
603	called.	1037	called.
604		1038
605	=cut	1039	=cut
606		1040
607	sub register_extcmd {	1041	sub register_extcmd {
608	my ($name, $cb) = @_;	1042	my ($name, $cb) = @_;
609		1043
610	my $caller = caller;
611	#warn "registering extcmd '$name' to '$caller'";
612
613	$EXTCMD{$name} = [$cb, $caller];	1044	$EXTCMD{$name} = $cb;
614	}	1045	}
615		1046
616	attach_to_players	1047	cf::player->attach (
617	on_command => sub {	1048	on_command => sub {
618	my ($pl, $name, $params) = @_;	1049	my ($pl, $name, $params) = @_;
619		1050
620	my $cb = $COMMAND{$name}	1051	my $cb = $COMMAND{$name}
621	or return;	1052	or return;
…		…
631		1062
632	my $msg = eval { from_json $buf };	1063	my $msg = eval { from_json $buf };
633		1064
634	if (ref $msg) {	1065	if (ref $msg) {
635	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1066	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
636	if (my %reply = $cb->[0]->($pl, $msg)) {	1067	if (my %reply = $cb->($pl, $msg)) {
637	$pl->ext_reply ($msg->{msgid}, %reply);	1068	$pl->ext_reply ($msg->{msgid}, %reply);
638	}	1069	}
639	}	1070	}
640	} else {	1071	} else {
641	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1072	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
642	}	1073	}
643		1074
644	cf::override;	1075	cf::override;
645	},	1076	},
646	;	1077	);
		1078
		1079	sub load_extensions {
		1080	cf::sync_job {
		1081	my %todo;
		1082
		1083	for my $path (<$LIBDIR/*.ext>) {
		1084	next unless -r $path;
		1085
		1086	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1087	my $base = $1;
		1088	my $pkg = $1;
		1089	$pkg =~ s/[^[:word:]]/_/g;
		1090	$pkg = "ext::$pkg";
		1091
		1092	open my $fh, "<:utf8", $path
		1093	or die "$path: $!";
		1094
		1095	my $source = do { local $/; <$fh> };
		1096
		1097	my %ext = (
		1098	path => $path,
		1099	base => $base,
		1100	pkg => $pkg,
		1101	);
		1102
		1103	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1104	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1105
		1106	$ext{source} =
		1107	"package $pkg; use strict; use utf8;\n"
		1108	. "#line 1 \"$path\"\n{\n"
		1109	. $source
		1110	. "\n};\n1";
		1111
		1112	$todo{$base} = \%ext;
		1113	}
		1114
		1115	my %done;
		1116	while (%todo) {
		1117	my $progress;
		1118
		1119	while (my ($k, $v) = each %todo) {
		1120	for (split /,\s*/, $v->{meta}{depends}) {
		1121	goto skip
		1122	unless exists $done{$_};
		1123	}
		1124
		1125	warn "... loading '$k' into '$v->{pkg}'\n";
		1126
		1127	unless (eval $v->{source}) {
		1128	my $msg = $@ ? "$v->{path}: $@\n"
		1129	: "$v->{base}: extension inactive.\n";
		1130
		1131	if (exists $v->{meta}{mandatory}) {
		1132	warn $msg;
		1133	warn "mandatory extension failed to load, exiting.\n";
		1134	exit 1;
		1135	}
		1136
		1137	warn $msg;
		1138	}
		1139
		1140	$done{$k} = delete $todo{$k};
		1141	push @EXTS, $v->{pkg};
		1142	$progress = 1;
		1143	}
		1144
		1145	skip:
		1146	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1147	unless $progress;
		1148	}
		1149	};
		1150	}
		1151
		1152	#############################################################################
		1153
		1154	=back
		1155
		1156	=head2 CORE EXTENSIONS
		1157
		1158	Functions and methods that extend core crossfire objects.
		1159
		1160	=cut
		1161
		1162	package cf::player;
		1163
		1164	use Coro::AIO;
		1165
		1166	=head3 cf::player
		1167
		1168	=over 4
		1169
		1170	=item cf::player::find $login
		1171
		1172	Returns the given player object, loading it if necessary (might block).
		1173
		1174	=cut
		1175
		1176	sub playerdir($) {
		1177	"$PLAYERDIR/"
		1178	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1179	}
		1180
		1181	sub path($) {
		1182	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1183
		1184	(playerdir $login) . "/playerdata"
		1185	}
		1186
		1187	sub find_active($) {
		1188	$cf::PLAYER{$_[0]}
		1189	and $cf::PLAYER{$_[0]}->active
		1190	and $cf::PLAYER{$_[0]}
		1191	}
		1192
		1193	sub exists($) {
		1194	my ($login) = @_;
		1195
		1196	$cf::PLAYER{$login}
		1197	or cf::sync_job { !aio_stat path $login }
		1198	}
		1199
		1200	sub find($) {
		1201	return $cf::PLAYER{$_[0]} || do {
		1202	my $login = $_[0];
		1203
		1204	my $guard = cf::lock_acquire "user_find:$login";
		1205
		1206	$cf::PLAYER{$_[0]} || do {
		1207	# rename old playerfiles to new ones
		1208	#TODO: remove when no longer required
		1209	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1210	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1211	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1212	aio_unlink +(playerdir $login) . "/$login.pl";
		1213
		1214	my $pl = load_pl path $login
		1215	or return;
		1216	$cf::PLAYER{$login} = $pl
		1217	}
		1218	}
		1219	}
		1220
		1221	sub save($) {
		1222	my ($pl) = @_;
		1223
		1224	return if $pl->{deny_save};
		1225
		1226	my $path = path $pl;
		1227	my $guard = cf::lock_acquire "user_save:$path";
		1228
		1229	return if $pl->{deny_save};
		1230
		1231	aio_mkdir playerdir $pl, 0770;
		1232	$pl->{last_save} = $cf::RUNTIME;
		1233
		1234	$pl->save_pl ($path);
		1235	Coro::cede;
		1236	}
		1237
		1238	sub new($) {
		1239	my ($login) = @_;
		1240
		1241	my $self = create;
		1242
		1243	$self->ob->name ($login);
		1244	$self->{deny_save} = 1;
		1245
		1246	$cf::PLAYER{$login} = $self;
		1247
		1248	$self
		1249	}
		1250
		1251	=item $pl->quit_character
		1252
		1253	Nukes the player without looking back. If logged in, the connection will
		1254	be destroyed. May block for a long time.
		1255
		1256	=cut
		1257
		1258	sub quit_character {
		1259	my ($pl) = @_;
		1260
		1261	my $name = $pl->ob->name;
		1262
		1263	$pl->{deny_save} = 1;
		1264	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1265
		1266	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1267	$pl->deactivate;
		1268	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1269	$pl->ns->destroy if $pl->ns;
		1270
		1271	my $path = playerdir $pl;
		1272	my $temp = "$path~$cf::RUNTIME~deleting~";
		1273	aio_rename $path, $temp;
		1274	delete $cf::PLAYER{$pl->ob->name};
		1275	$pl->destroy;
		1276
		1277	my $prefix = qr<^~\Q$name\E/>;
		1278
		1279	# nuke player maps
		1280	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1281
		1282	IO::AIO::aio_rmtree $temp;
		1283	}
		1284
		1285	=item $pl->kick
		1286
		1287	Kicks a player out of the game. This destroys the connection.
		1288
		1289	=cut
		1290
		1291	sub kick {
		1292	my ($pl, $kicker) = @_;
		1293
		1294	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1295	$pl->killer ("kicked");
		1296	$pl->ns->destroy;
		1297	}
		1298
		1299	=item cf::player::list_logins
		1300
		1301	Returns am arrayref of all valid playernames in the system, can take a
		1302	while and may block, so not sync_job-capable, ever.
		1303
		1304	=cut
		1305
		1306	sub list_logins {
		1307	my $dirs = aio_readdir $PLAYERDIR
		1308	or return [];
		1309
		1310	my @logins;
		1311
		1312	for my $login (@$dirs) {
		1313	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1314	aio_read $fh, 0, 512, my $buf, 0 or next;
		1315	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1316
		1317	utf8::decode $login;
		1318	push @logins, $login;
		1319	}
		1320
		1321	\@logins
		1322	}
		1323
		1324	=item $player->maps
		1325
		1326	Returns an arrayref of map paths that are private for this
		1327	player. May block.
		1328
		1329	=cut
		1330
		1331	sub maps($) {
		1332	my ($pl) = @_;
		1333
		1334	$pl = ref $pl ? $pl->ob->name : $pl;
		1335
		1336	my $files = aio_readdir playerdir $pl
		1337	or return;
		1338
		1339	my @paths;
		1340
		1341	for (@$files) {
		1342	utf8::decode $_;
		1343	next if /\.(?:pl|pst)$/;
		1344	next unless /^$PATH_SEP/o;
		1345
		1346	push @paths, cf::map::normalise "~$pl/$_";
		1347	}
		1348
		1349	\@paths
		1350	}
		1351
		1352	=item $player->ext_reply ($msgid, %msg)
		1353
		1354	Sends an ext reply to the player.
		1355
		1356	=cut
		1357
		1358	sub ext_reply($$%) {
		1359	my ($self, $id, %msg) = @_;
		1360
		1361	$msg{msgid} = $id;
		1362
		1363	$self->send ("ext " . cf::to_json \%msg);
		1364	}
		1365
		1366	=item $player->ext_event ($type, %msg)
		1367
		1368	Sends an ext event to the client.
		1369
		1370	=cut
		1371
		1372	sub ext_event($$%) {
		1373	my ($self, $type, %msg) = @_;
		1374
		1375	$self->ns->ext_event ($type, %msg);
		1376	}
		1377
		1378	=head3 cf::region
		1379
		1380	=over 4
		1381
		1382	=cut
		1383
		1384	package cf::region;
		1385
		1386	=item cf::region::find_by_path $path
		1387
		1388	Tries to decuce the likely region for a map knowing only its path.
		1389
		1390	=cut
		1391
		1392	sub find_by_path($) {
		1393	my ($path) = @_;
		1394
		1395	my ($match, $specificity);
		1396
		1397	for my $region (list) {
		1398	if ($region->match && $path =~ $region->match) {
		1399	($match, $specificity) = ($region, $region->specificity)
		1400	if $region->specificity > $specificity;
		1401	}
		1402	}
		1403
		1404	$match
		1405	}
		1406
		1407	=back
		1408
		1409	=head3 cf::map
		1410
		1411	=over 4
		1412
		1413	=cut
		1414
		1415	package cf::map;
		1416
		1417	use Fcntl;
		1418	use Coro::AIO;
		1419
		1420	use overload
		1421	'""' => \&as_string,
		1422	fallback => 1;
		1423
		1424	our $MAX_RESET = 3600;
		1425	our $DEFAULT_RESET = 3000;
		1426
		1427	sub generate_random_map {
		1428	my ($self, $rmp) = @_;
		1429	# mit "rum" bekleckern, nicht
		1430	$self->_create_random_map (
		1431	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1432	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1433	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1434	$rmp->{exit_on_final_map},
		1435	$rmp->{xsize}, $rmp->{ysize},
		1436	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1437	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1438	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1439	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1440	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1441	(cf::region::find $rmp->{region}), $rmp->{custom}
		1442	)
		1443	}
		1444
		1445	=item cf::map->register ($regex, $prio)
		1446
		1447	Register a handler for the map path matching the given regex at the
		1448	givne priority (higher is better, built-in handlers have priority 0, the
		1449	default).
		1450
		1451	=cut
647		1452
648	sub register {	1453	sub register {
		1454	my (undef, $regex, $prio) = @_;
		1455	my $pkg = caller;
		1456
		1457	no strict;
		1458	push @{"$pkg\::ISA"}, __PACKAGE__;
		1459
		1460	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1461	}
		1462
		1463	# also paths starting with '/'
		1464	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1465
		1466	sub thawer_merge {
649	my ($base, $pkg) = @_;	1467	my ($self, $merge) = @_;
650		1468
651	#TODO	1469	# we have to keep some variables in memory intact
652	}	1470	local $self->{path};
		1471	local $self->{load_path};
653		1472
654	sub load_extension {	1473	$self->SUPER::thawer_merge ($merge);
		1474	}
		1475
		1476	sub normalise {
655	my ($path) = @_;	1477	my ($path, $base) = @_;
656		1478
657	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1479	$path = "$path"; # make sure its a string
658	my $base = $1;
659	my $pkg = $1;
660	$pkg =~ s/[^[:word:]]/_/g;
661	$pkg = "ext::$pkg";
662		1480
663	warn "loading '$path' into '$pkg'\n";	1481	$path =~ s/\.map$//;
664		1482
665	open my $fh, "<:utf8", $path	1483	# map plan:
666	or die "$path: $!";	1484	#
		1485	# /! non-realised random map exit (special hack!)
		1486	# {... are special paths that are not being touched
		1487	# ?xxx/... are special absolute paths
		1488	# ?random/... random maps
		1489	# /... normal maps
		1490	# ~user/... per-player map of a specific user
667		1491
668	my $source =	1492	$path =~ s/$PATH_SEP/\//go;
669	"package $pkg; use strict; use utf8;\n"
670	. "#line 1 \"$path\"\n{\n"
671	. (do { local $/; <$fh> })
672	. "\n};\n1";
673		1493
674	eval $source	1494	# treat it as relative path if it starts with
675	or die $@ ? "$path: $@\n"	1495	# something that looks reasonable
676	: "extension disabled.\n";	1496	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1497	$base or Carp::carp "normalise called with relative path and no base: '$path'";
677		1498
678	push @exts, $pkg;	1499	$base =~ s{[^/]+/?$}{};
679	$ext_pkg{$base} = $pkg;	1500	$path = "$base/$path";
680
681	# no strict 'refs';
682	# @{"$pkg\::ISA"} = ext::;
683
684	register $base, $pkg;
685	}
686
687	sub unload_extension {
688	my ($pkg) = @_;
689
690	warn "removing extension $pkg\n";
691
692	# remove hooks
693	#TODO
694	# for my $idx (0 .. $#PLUGIN_EVENT) {
695	# delete $hook[$idx]{$pkg};
696	# }	1501	}
697		1502
698	# remove commands	1503	for ($path) {
699	for my $name (keys %COMMAND) {	1504	redo if s{//}{/};
700	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };	1505	redo if s{/\.?/}{/};
		1506	redo if s{/[^/]+/\.\./}{/};
		1507	}
701		1508
702	if (@cb) {	1509	$path
703	$COMMAND{$name} = \@cb;	1510	}
		1511
		1512	sub new_from_path {
		1513	my (undef, $path, $base) = @_;
		1514
		1515	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1516
		1517	$path = normalise $path, $base;
		1518
		1519	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1520	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1521	my $self = bless cf::map::new, $pkg;
		1522	$self->{path} = $path; $self->path ($path);
		1523	$self->init; # pass $1 etc.
		1524	return $self;
		1525	}
		1526	}
		1527
		1528	Carp::carp "unable to resolve path '$path' (base '$base').";
		1529	()
		1530	}
		1531
		1532	sub init {
		1533	my ($self) = @_;
		1534
		1535	$self
		1536	}
		1537
		1538	sub as_string {
		1539	my ($self) = @_;
		1540
		1541	"$self->{path}"
		1542	}
		1543
		1544	# the displayed name, this is a one way mapping
		1545	sub visible_name {
		1546	&as_string
		1547	}
		1548
		1549	# the original (read-only) location
		1550	sub load_path {
		1551	my ($self) = @_;
		1552
		1553	"$MAPDIR/$self->{path}.map"
		1554	}
		1555
		1556	# the temporary/swap location
		1557	sub save_path {
		1558	my ($self) = @_;
		1559
		1560	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1561	"$TMPDIR/$path.map"
		1562	}
		1563
		1564	# the unique path, undef == no special unique path
		1565	sub uniq_path {
		1566	my ($self) = @_;
		1567
		1568	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1569	"$UNIQUEDIR/$path"
		1570	}
		1571
		1572	# and all this just because we cannot iterate over
		1573	# all maps in C++...
		1574	sub change_all_map_light {
		1575	my ($change) = @_;
		1576
		1577	$_->change_map_light ($change)
		1578	for grep $_->outdoor, values %cf::MAP;
		1579	}
		1580
		1581	sub decay_objects {
		1582	my ($self) = @_;
		1583
		1584	return if $self->{deny_reset};
		1585
		1586	$self->do_decay_objects;
		1587	}
		1588
		1589	sub unlink_save {
		1590	my ($self) = @_;
		1591
		1592	utf8::encode (my $save = $self->save_path);
		1593	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1594	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1595	}
		1596
		1597	sub load_header_from($) {
		1598	my ($self, $path) = @_;
		1599
		1600	utf8::encode $path;
		1601	#aio_open $path, O_RDONLY, 0
		1602	# or return;
		1603
		1604	$self->_load_header ($path)
		1605	or return;
		1606
		1607	$self->{load_path} = $path;
		1608
		1609	1
		1610	}
		1611
		1612	sub load_header_orig {
		1613	my ($self) = @_;
		1614
		1615	$self->load_header_from ($self->load_path)
		1616	}
		1617
		1618	sub load_header_temp {
		1619	my ($self) = @_;
		1620
		1621	$self->load_header_from ($self->save_path)
		1622	}
		1623
		1624	sub prepare_temp {
		1625	my ($self) = @_;
		1626
		1627	$self->last_access ((delete $self->{last_access})
		1628	|| $cf::RUNTIME); #d#
		1629	# safety
		1630	$self->{instantiate_time} = $cf::RUNTIME
		1631	if $self->{instantiate_time} > $cf::RUNTIME;
		1632	}
		1633
		1634	sub prepare_orig {
		1635	my ($self) = @_;
		1636
		1637	$self->{load_original} = 1;
		1638	$self->{instantiate_time} = $cf::RUNTIME;
		1639	$self->last_access ($cf::RUNTIME);
		1640	$self->instantiate;
		1641	}
		1642
		1643	sub load_header {
		1644	my ($self) = @_;
		1645
		1646	if ($self->load_header_temp) {
		1647	$self->prepare_temp;
704	} else {	1648	} else {
705	delete $COMMAND{$name};	1649	$self->load_header_orig
706	}	1650	or return;
		1651	$self->prepare_orig;
		1652	}
		1653
		1654	$self->{deny_reset} = 1
		1655	if $self->no_reset;
		1656
		1657	$self->default_region (cf::region::find_by_path $self->{path})
		1658	unless $self->default_region;
		1659
707	}	1660	1
		1661	}
708		1662
709	# remove extcmds	1663	sub find;
710	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {	1664	sub find {
711	delete $EXTCMD{$name};	1665	my ($path, $origin) = @_;
		1666
		1667	$path = normalise $path, $origin && $origin->path;
		1668
		1669	cf::lock_wait "map_find:$path";
		1670
		1671	$cf::MAP{$path} || do {
		1672	my $guard = cf::lock_acquire "map_find:$path";
		1673	my $map = new_from_path cf::map $path
		1674	or return;
		1675
		1676	$map->{last_save} = $cf::RUNTIME;
		1677
		1678	$map->load_header
		1679	or return;
		1680
		1681	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1682	# doing this can freeze the server in a sync job, obviously
		1683	#$cf::WAIT_FOR_TICK->wait;
		1684	$map->reset;
		1685	undef $guard;
		1686	return find $path;
		1687	}
		1688
		1689	$cf::MAP{$path} = $map
		1690	}
		1691	}
		1692
		1693	sub pre_load { }
		1694	sub post_load { }
		1695
		1696	sub load {
		1697	my ($self) = @_;
		1698
		1699	local $self->{deny_reset} = 1; # loading can take a long time
		1700
		1701	my $path = $self->{path};
		1702
712	}	1703	{
		1704	my $guard = cf::lock_acquire "map_load:$path";
713		1705
714	if (my $cb = $pkg->can ("unload")) {	1706	return if $self->in_memory != cf::MAP_SWAPPED;
715	eval {	1707
716	$cb->($pkg);	1708	$self->in_memory (cf::MAP_LOADING);
		1709
		1710	$self->alloc;
		1711
		1712	$self->pre_load;
		1713	Coro::cede;
		1714
		1715	$self->_load_objects ($self->{load_path}, 1)
		1716	or return;
		1717
		1718	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1719	if delete $self->{load_original};
		1720
		1721	if (my $uniq = $self->uniq_path) {
		1722	utf8::encode $uniq;
		1723	if (aio_open $uniq, O_RDONLY, 0) {
		1724	$self->clear_unique_items;
		1725	$self->_load_objects ($uniq, 0);
717	1	1726	}
718	} or warn "$pkg unloaded, but with errors: $@";	1727	}
719	}
720		1728
721	Symbol::delete_package $pkg;	1729	Coro::cede;
722	}	1730	# now do the right thing for maps
		1731	$self->link_multipart_objects;
		1732	$self->difficulty ($self->estimate_difficulty)
		1733	unless $self->difficulty;
		1734	Coro::cede;
723		1735
724	sub load_extensions {	1736	unless ($self->{deny_activate}) {
725	for my $ext (<$LIBDIR/*.ext>) {	1737	$self->decay_objects;
726	next unless -r $ext;	1738	$self->fix_auto_apply;
727	eval {	1739	$self->update_buttons;
728	load_extension $ext;	1740	Coro::cede;
729	1	1741	$self->set_darkness_map;
730	} or warn "$ext not loaded: $@";	1742	Coro::cede;
731	}	1743	$self->activate;
732	}	1744	}
733		1745
734	#############################################################################	1746	$self->in_memory (cf::MAP_IN_MEMORY);
735	# load/save/clean perl data associated with a map	1747	}
736		1748
737	*cf::mapsupport::on_clean = sub {	1749	$self->post_load;
		1750	}
		1751
		1752	sub customise_for {
		1753	my ($self, $ob) = @_;
		1754
		1755	return find "~" . $ob->name . "/" . $self->{path}
		1756	if $self->per_player;
		1757
		1758	# return find "?party/" . $ob->name . "/" . $self->{path}
		1759	# if $self->per_party;
		1760
		1761	$self
		1762	}
		1763
		1764	# find and load all maps in the 3x3 area around a map
		1765	sub load_diag {
738	my ($map) = @_;	1766	my ($map) = @_;
739		1767
740	my $path = $map->tmpname;	1768	my @diag; # diagonal neighbours
741	defined $path or return;
742		1769
743	unlink "$path.pst";	1770	for (0 .. 3) {
744	};	1771	my $neigh = $map->tile_path ($_)
		1772	or next;
		1773	$neigh = find $neigh, $map
		1774	or next;
		1775	$neigh->load;
745		1776
746	attach_to_maps prio => -10000, package => cf::mapsupport::;	1777	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1778	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1779	}
747		1780
748	#############################################################################	1781	for (@diag) {
749	# load/save perl data associated with player->ob objects	1782	my $neigh = find @$_
750		1783	or next;
751	sub all_objects(@) {	1784	$neigh->load;
752	@_, map all_objects ($_->inv), @_	1785	}
753	}	1786	}
754		1787
755	# TODO: compatibility cruft, remove when no longer needed	1788	sub find_sync {
756	attach_to_players	1789	my ($path, $origin) = @_;
757	on_load => sub {
758	my ($pl, $path) = @_;
759		1790
760	for my $o (all_objects $pl->ob) {	1791	cf::sync_job { find $path, $origin }
761	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1792	}
762	$o->set_ob_key_value ("_perl_data");
763		1793
764	%$o = %{ Storable::thaw pack "H*", $value };	1794	sub do_load_sync {
		1795	my ($map) = @_;
		1796
		1797	cf::sync_job { $map->load };
		1798	}
		1799
		1800	our %MAP_PREFETCH;
		1801	our $MAP_PREFETCHER = undef;
		1802
		1803	sub find_async {
		1804	my ($path, $origin) = @_;
		1805
		1806	$path = normalise $path, $origin && $origin->{path};
		1807
		1808	if (my $map = $cf::MAP{$path}) {
		1809	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1810	}
		1811
		1812	undef $MAP_PREFETCH{$path};
		1813	$MAP_PREFETCHER ||= cf::async {
		1814	while (%MAP_PREFETCH) {
		1815	for my $path (keys %MAP_PREFETCH) {
		1816	my $map = find $path
		1817	or next;
		1818	$map->load;
		1819
		1820	delete $MAP_PREFETCH{$path};
765	}	1821	}
766	}	1822	}
		1823	undef $MAP_PREFETCHER;
		1824	};
		1825	$MAP_PREFETCHER->prio (6);
		1826
		1827	()
		1828	}
		1829
		1830	sub save {
		1831	my ($self) = @_;
		1832
		1833	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1834
		1835	$self->{last_save} = $cf::RUNTIME;
		1836
		1837	return unless $self->dirty;
		1838
		1839	my $save = $self->save_path; utf8::encode $save;
		1840	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1841
		1842	$self->{load_path} = $save;
		1843
		1844	return if $self->{deny_save};
		1845
		1846	local $self->{last_access} = $self->last_access;#d#
		1847
		1848	cf::async {
		1849	$_->contr->save for $self->players;
		1850	};
		1851
		1852	if ($uniq) {
		1853	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1854	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1855	} else {
		1856	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
767	},	1857	}
768	;	1858	}
769		1859
770	#############################################################################	1860	sub swap_out {
		1861	my ($self) = @_;
771		1862
772	=head2 CORE EXTENSIONS	1863	# save first because save cedes
		1864	$self->save;
773		1865
774	Functions and methods that extend core crossfire objects.	1866	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1867
		1868	return if $self->players;
		1869	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1870	return if $self->{deny_save};
		1871
		1872	$self->clear;
		1873	$self->in_memory (cf::MAP_SWAPPED);
		1874	}
		1875
		1876	sub reset_at {
		1877	my ($self) = @_;
		1878
		1879	# TODO: safety, remove and allow resettable per-player maps
		1880	return 1e99 if $self->{deny_reset};
		1881
		1882	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1883	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1884
		1885	$time + $to
		1886	}
		1887
		1888	sub should_reset {
		1889	my ($self) = @_;
		1890
		1891	$self->reset_at <= $cf::RUNTIME
		1892	}
		1893
		1894	sub reset {
		1895	my ($self) = @_;
		1896
		1897	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1898
		1899	return if $self->players;
		1900
		1901	warn "resetting map ", $self->path;
		1902
		1903	$self->in_memory (cf::MAP_SWAPPED);
		1904
		1905	# need to save uniques path
		1906	unless ($self->{deny_save}) {
		1907	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1908
		1909	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1910	if $uniq;
		1911	}
		1912
		1913	delete $cf::MAP{$self->path};
		1914
		1915	$self->clear;
		1916
		1917	$_->clear_links_to ($self) for values %cf::MAP;
		1918
		1919	$self->unlink_save;
		1920	$self->destroy;
		1921	}
		1922
		1923	my $nuke_counter = "aaaa";
		1924
		1925	sub nuke {
		1926	my ($self) = @_;
		1927
		1928	delete $cf::MAP{$self->path};
		1929
		1930	$self->unlink_save;
		1931
		1932	bless $self, "cf::map";
		1933	delete $self->{deny_reset};
		1934	$self->{deny_save} = 1;
		1935	$self->reset_timeout (1);
		1936	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1937
		1938	$cf::MAP{$self->path} = $self;
		1939
		1940	$self->reset; # polite request, might not happen
		1941	}
		1942
		1943	=item $maps = cf::map::tmp_maps
		1944
		1945	Returns an arrayref with all map paths of currently instantiated and saved
		1946	maps. May block.
		1947
		1948	=cut
		1949
		1950	sub tmp_maps() {
		1951	[
		1952	map {
		1953	utf8::decode $_;
		1954	/\.map$/
		1955	? normalise $_
		1956	: ()
		1957	} @{ aio_readdir $TMPDIR or [] }
		1958	]
		1959	}
		1960
		1961	=item $maps = cf::map::random_maps
		1962
		1963	Returns an arrayref with all map paths of currently instantiated and saved
		1964	random maps. May block.
		1965
		1966	=cut
		1967
		1968	sub random_maps() {
		1969	[
		1970	map {
		1971	utf8::decode $_;
		1972	/\.map$/
		1973	? normalise "?random/$_"
		1974	: ()
		1975	} @{ aio_readdir $RANDOMDIR or [] }
		1976	]
		1977	}
		1978
		1979	=item cf::map::unique_maps
		1980
		1981	Returns an arrayref of paths of all shared maps that have
		1982	instantiated unique items. May block.
		1983
		1984	=cut
		1985
		1986	sub unique_maps() {
		1987	[
		1988	map {
		1989	utf8::decode $_;
		1990	/\.map$/
		1991	? normalise $_
		1992	: ()
		1993	} @{ aio_readdir $UNIQUEDIR or [] }
		1994	]
		1995	}
		1996
		1997	package cf;
		1998
		1999	=back
		2000
		2001	=head3 cf::object
		2002
		2003	=cut
		2004
		2005	package cf::object;
775		2006
776	=over 4	2007	=over 4
777		2008
778	=item cf::player::exists $login	2009	=item $ob->inv_recursive
779		2010
780	Returns true when the given account exists.	2011	Returns the inventory of the object _and_ their inventories, recursively.
781		2012
782	=cut	2013	=cut
783		2014
784	sub cf::player::exists($) {	2015	sub inv_recursive_;
785	cf::player::find $_[0]	2016	sub inv_recursive_ {
786	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2017	map { $_, inv_recursive_ $_->inv } @_
787	}	2018	}
		2019
		2020	sub inv_recursive {
		2021	inv_recursive_ inv $_[0]
		2022	}
		2023
		2024	package cf;
		2025
		2026	=back
		2027
		2028	=head3 cf::object::player
		2029
		2030	=over 4
788		2031
789	=item $player_object->reply ($npc, $msg[, $flags])	2032	=item $player_object->reply ($npc, $msg[, $flags])
790		2033
791	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	2034	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	2035	can be C<undef>. Does the right thing when the player is currently in a
…		…
794		2037
795	=cut	2038	=cut
796		2039
797	# rough implementation of a future "reply" method that works	2040	# rough implementation of a future "reply" method that works
798	# with dialog boxes.	2041	# with dialog boxes.
		2042	#TODO: the first argument must go, split into a $npc->reply_to ( method
799	sub cf::object::player::reply($$$;$) {	2043	sub cf::object::player::reply($$$;$) {
800	my ($self, $npc, $msg, $flags) = @_;	2044	my ($self, $npc, $msg, $flags) = @_;
801		2045
802	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2046	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
803		2047
…		…
807	$msg = $npc->name . " says: $msg" if $npc;	2051	$msg = $npc->name . " says: $msg" if $npc;
808	$self->message ($msg, $flags);	2052	$self->message ($msg, $flags);
809	}	2053	}
810	}	2054	}
811		2055
812	=item $player->ext_reply ($msgid, $msgtype, %msg)
813
814	Sends an ext reply to the player.
815
816	=cut
817
818	sub cf::player::ext_reply($$$%) {
819	my ($self, $id, %msg) = @_;
820
821	$msg{msgid} = $id;
822
823	$self->send ("ext " . to_json \%msg);
824	}
825
826	=item $player_object->may ("access")	2056	=item $player_object->may ("access")
827		2057
828	Returns wether the given player is authorized to access resource "access"	2058	Returns wether the given player is authorized to access resource "access"
829	(e.g. "command_wizcast").	2059	(e.g. "command_wizcast").
830		2060
…		…
837	(ref $cf::CFG{"may_$access"}	2067	(ref $cf::CFG{"may_$access"}
838	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2068	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839	: $cf::CFG{"may_$access"})	2069	: $cf::CFG{"may_$access"})
840	}	2070	}
841		2071
842	=cut	2072	=item $player_object->enter_link
843		2073
844	#############################################################################	2074	Freezes the player and moves him/her to a special map (C<{link}>).
		2075
		2076	The player should be reasonably safe there for short amounts of time. You
		2077	I<MUST> call C<leave_link> as soon as possible, though.
		2078
		2079	Will never block.
		2080
		2081	=item $player_object->leave_link ($map, $x, $y)
		2082
		2083	Moves the player out of the special C<{link}> map onto the specified
		2084	map. If the map is not valid (or omitted), the player will be moved back
		2085	to the location he/she was before the call to C<enter_link>, or, if that
		2086	fails, to the emergency map position.
		2087
		2088	Might block.
		2089
		2090	=cut
		2091
		2092	sub link_map {
		2093	unless ($LINK_MAP) {
		2094	$LINK_MAP = cf::map::find "{link}"
		2095	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2096	$LINK_MAP->load;
		2097	}
		2098
		2099	$LINK_MAP
		2100	}
		2101
		2102	sub cf::object::player::enter_link {
		2103	my ($self) = @_;
		2104
		2105	$self->deactivate_recursive;
		2106
		2107	return if UNIVERSAL::isa $self->map, "ext::map_link";
		2108
		2109	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		2110	if $self->map && $self->map->{path} ne "{link}";
		2111
		2112	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		2113	}
		2114
		2115	sub cf::object::player::leave_link {
		2116	my ($self, $map, $x, $y) = @_;
		2117
		2118	return unless $self->contr->active;
		2119
		2120	my $link_pos = delete $self->{_link_pos};
		2121
		2122	unless ($map) {
		2123	# restore original map position
		2124	($map, $x, $y) = @{ $link_pos || [] };
		2125	$map = cf::map::find $map;
		2126
		2127	unless ($map) {
		2128	($map, $x, $y) = @$EMERGENCY_POSITION;
		2129	$map = cf::map::find $map
		2130	or die "FATAL: cannot load emergency map\n";
		2131	}
		2132	}
		2133
		2134	($x, $y) = (-1, -1)
		2135	unless (defined $x) && (defined $y);
		2136
		2137	# use -1 or undef as default coordinates, not 0, 0
		2138	($x, $y) = ($map->enter_x, $map->enter_y)
		2139	if $x <=0 && $y <= 0;
		2140
		2141	$map->load;
		2142	$map->load_diag;
		2143
		2144	return unless $self->contr->active;
		2145	$self->activate_recursive;
		2146
		2147	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2148	$self->enter_map ($map, $x, $y);
		2149	}
		2150
		2151	=item $player_object->goto ($path, $x, $y[, $check->($map)])
		2152
		2153	Moves the player to the given map-path and coordinates by first freezing
		2154	her, loading and preparing them map, calling the provided $check callback
		2155	that has to return the map if sucecssful, and then unfreezes the player on
		2156	the new (success) or old (failed) map position.
		2157
		2158	=cut
		2159
		2160	our $GOTOGEN;
		2161
		2162	sub cf::object::player::goto {
		2163	my ($self, $path, $x, $y, $check) = @_;
		2164
		2165	# do generation counting so two concurrent goto's will be executed in-order
		2166	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2167
		2168	$self->enter_link;
		2169
		2170	(async {
		2171	my $map = eval {
		2172	my $map = cf::map::find $path;
		2173
		2174	if ($map) {
		2175	$map = $map->customise_for ($self);
		2176	$map = $check->($map) if $check && $map;
		2177	} else {
		2178	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2179	}
		2180
		2181	$map
		2182	};
		2183
		2184	if ($@) {
		2185	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2186	LOG llevError | logBacktrace, Carp::longmess $@;
		2187	}
		2188
		2189	if ($gen == $self->{_goto_generation}) {
		2190	delete $self->{_goto_generation};
		2191	$self->leave_link ($map, $x, $y);
		2192	}
		2193	})->prio (1);
		2194	}
		2195
		2196	=item $player_object->enter_exit ($exit_object)
		2197
		2198	=cut
		2199
		2200	sub parse_random_map_params {
		2201	my ($spec) = @_;
		2202
		2203	my $rmp = { # defaults
		2204	xsize => (cf::rndm 15, 40),
		2205	ysize => (cf::rndm 15, 40),
		2206	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2207	#layout => string,
		2208	};
		2209
		2210	for (split /\n/, $spec) {
		2211	my ($k, $v) = split /\s+/, $_, 2;
		2212
		2213	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2214	}
		2215
		2216	$rmp
		2217	}
		2218
		2219	sub prepare_random_map {
		2220	my ($exit) = @_;
		2221
		2222	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2223
		2224	# all this does is basically replace the /! path by
		2225	# a new random map path (?random/...) with a seed
		2226	# that depends on the exit object
		2227
		2228	my $rmp = parse_random_map_params $exit->msg;
		2229
		2230	if ($exit->map) {
		2231	$rmp->{region} = $exit->region->name;
		2232	$rmp->{origin_map} = $exit->map->path;
		2233	$rmp->{origin_x} = $exit->x;
		2234	$rmp->{origin_y} = $exit->y;
		2235	}
		2236
		2237	$rmp->{random_seed} ||= $exit->random_seed;
		2238
		2239	my $data = cf::to_json $rmp;
		2240	my $md5 = Digest::MD5::md5_hex $data;
		2241	my $meta = "$RANDOMDIR/$md5.meta";
		2242
		2243	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2244	aio_write $fh, 0, (length $data), $data, 0;
		2245	undef $fh;
		2246	aio_rename "$meta~", $meta;
		2247
		2248	$exit->slaying ("?random/$md5");
		2249	$exit->msg (undef);
		2250	}
		2251	}
		2252
		2253	sub cf::object::player::enter_exit {
		2254	my ($self, $exit) = @_;
		2255
		2256	return unless $self->type == cf::PLAYER;
		2257
		2258	if ($exit->slaying eq "/!") {
		2259	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2260	# the problem is that $exit might not survive long enough
		2261	# so it needs to be done right now, right here
		2262	cf::sync_job { prepare_random_map $exit };
		2263	}
		2264
		2265	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2266	my $hp = $exit->stats->hp;
		2267	my $sp = $exit->stats->sp;
		2268
		2269	$self->enter_link;
		2270
		2271	(async {
		2272	$self->deactivate_recursive; # just to be sure
		2273	unless (eval {
		2274	$self->goto ($slaying, $hp, $sp);
		2275
		2276	1;
		2277	}) {
		2278	$self->message ("Something went wrong deep within the crossfire server. "
		2279	. "I'll try to bring you back to the map you were before. "
		2280	. "Please report this to the dungeon master!",
		2281	cf::NDI_UNIQUE | cf::NDI_RED);
		2282
		2283	warn "ERROR in enter_exit: $@";
		2284	$self->leave_link;
		2285	}
		2286	})->prio (1);
		2287	}
		2288
		2289	=head3 cf::client
		2290
		2291	=over 4
		2292
		2293	=item $client->send_drawinfo ($text, $flags)
		2294
		2295	Sends a drawinfo packet to the client. Circumvents output buffering so
		2296	should not be used under normal circumstances.
		2297
		2298	=cut
		2299
		2300	sub cf::client::send_drawinfo {
		2301	my ($self, $text, $flags) = @_;
		2302
		2303	utf8::encode $text;
		2304	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2305	}
		2306
		2307	=item $client->ext_event ($type, %msg)
		2308
		2309	Sends an exti event to the client.
		2310
		2311	=cut
		2312
		2313	sub cf::client::ext_event($$%) {
		2314	my ($self, $type, %msg) = @_;
		2315
		2316	$msg{msgtype} = "event_$type";
		2317	$self->send_packet ("ext " . cf::to_json \%msg);
		2318	}
		2319
		2320	=item $success = $client->query ($flags, "text", \&cb)
		2321
		2322	Queues a query to the client, calling the given callback with
		2323	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2324	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2325
		2326	Queries can fail, so check the return code. Or don't, as queries will become
		2327	reliable at some point in the future.
		2328
		2329	=cut
		2330
		2331	sub cf::client::query {
		2332	my ($self, $flags, $text, $cb) = @_;
		2333
		2334	return unless $self->state == ST_PLAYING
		2335	|| $self->state == ST_SETUP
		2336	|| $self->state == ST_CUSTOM;
		2337
		2338	$self->state (ST_CUSTOM);
		2339
		2340	utf8::encode $text;
		2341	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2342
		2343	$self->send_packet ($self->{query_queue}[0][0])
		2344	if @{ $self->{query_queue} } == 1;
		2345	}
		2346
		2347	cf::client->attach (
		2348	on_reply => sub {
		2349	my ($ns, $msg) = @_;
		2350
		2351	# this weird shuffling is so that direct followup queries
		2352	# get handled first
		2353	my $queue = delete $ns->{query_queue}
		2354	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2355
		2356	(shift @$queue)->[1]->($msg);
		2357	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2358
		2359	push @{ $ns->{query_queue} }, @$queue;
		2360
		2361	if (@{ $ns->{query_queue} } == @$queue) {
		2362	if (@$queue) {
		2363	$ns->send_packet ($ns->{query_queue}[0][0]);
		2364	} else {
		2365	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2366	}
		2367	}
		2368	},
		2369	);
		2370
		2371	=item $client->async (\&cb)
		2372
		2373	Create a new coroutine, running the specified callback. The coroutine will
		2374	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2375	or loss of connection).
		2376
		2377	=cut
		2378
		2379	sub cf::client::async {
		2380	my ($self, $cb) = @_;
		2381
		2382	my $coro = &Coro::async ($cb);
		2383
		2384	$coro->on_destroy (sub {
		2385	delete $self->{_coro}{$coro+0};
		2386	});
		2387
		2388	$self->{_coro}{$coro+0} = $coro;
		2389
		2390	$coro
		2391	}
		2392
		2393	cf::client->attach (
		2394	on_destroy => sub {
		2395	my ($ns) = @_;
		2396
		2397	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2398	},
		2399	);
		2400
		2401	=back
		2402
845		2403
846	=head2 SAFE SCRIPTING	2404	=head2 SAFE SCRIPTING
847		2405
848	Functions that provide a safe environment to compile and execute	2406	Functions that provide a safe environment to compile and execute
849	snippets of perl code without them endangering the safety of the server	2407	snippets of perl code without them endangering the safety of the server
…		…
862		2420
863	# here we export the classes and methods available to script code	2421	# here we export the classes and methods available to script code
864		2422
865	=pod	2423	=pod
866		2424
867	The following fucntions and emthods are available within a safe environment:	2425	The following functions and methods are available within a safe environment:
868		2426
869	cf::object contr pay_amount pay_player	2427	cf::object contr pay_amount pay_player map
870	cf::object::player player	2428	cf::object::player player
871	cf::player peaceful	2429	cf::player peaceful
		2430	cf::map trigger
872		2431
873	=cut	2432	=cut
874		2433
875	for (	2434	for (
876	["cf::object" => qw(contr pay_amount pay_player)],	2435	["cf::object" => qw(contr pay_amount pay_player map)],
877	["cf::object::player" => qw(player)],	2436	["cf::object::player" => qw(player)],
878	["cf::player" => qw(peaceful)],	2437	["cf::player" => qw(peaceful)],
		2438	["cf::map" => qw(trigger)],
879	) {	2439	) {
880	no strict 'refs';	2440	no strict 'refs';
881	my ($pkg, @funs) = @$_;	2441	my ($pkg, @funs) = @$_;
882	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2442	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883	for @funs;	2443	for @funs;
…		…
951	=back	2511	=back
952		2512
953	=cut	2513	=cut
954		2514
955	#############################################################################	2515	#############################################################################
		2516	# the server's init and main functions
956		2517
957	=head2 EXTENSION DATABASE SUPPORT	2518	sub load_facedata($) {
		2519	my ($path) = @_;
958		2520
959	Crossfire maintains a very simple database for extension use. It can	2521	warn "loading facedata from $path\n";
960	currently store anything that can be serialised using Storable, which
961	excludes objects.
962		2522
963	The parameter C<$family> should best start with the name of the extension	2523	my $facedata;
964	using it, it should be unique.	2524	0 < aio_load $path, $facedata
		2525	or die "$path: $!";
965		2526
966	=over 4	2527	$facedata = Coro::Storable::thaw $facedata;
967		2528
968	=item $hashref = cf::db_get $family	2529	$facedata->{version} == 2
		2530	or cf::cleanup "$path: version mismatch, cannot proceed.";
969		2531
970	Return a hashref for use by the extension C<$family>, which can be
971	modified. After modifications, you have to call C<cf::db_dirty> or
972	C<cf::db_sync>.
973
974	=item $value = cf::db_get $family => $key
975
976	Returns a single value from the database
977
978	=item cf::db_put $family => $hashref
979
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	}	2532	{
		2533	my $faces = $facedata->{faceinfo};
1007		2534
1008	my $pid;	2535	while (my ($face, $info) = each %$faces) {
1009		2536	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1010	sub db_save() {	2537	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
1011	warn "saving database $path\n";#d# remove later	2538	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
1012	waitpid $pid, 0 if $pid;	2539	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1013	if (0 == ($pid = fork)) {	2540	Coro::cede;
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, data => WF_AUTOCANCEL, cb => sub {
1029	db_sync;
1030	});
1031
1032	sub db_dirty() {
1033	$dirty = 1;
1034	$idle->start;
1035	}
1036
1037	sub db_get($;$) {
1038	@_ >= 2
1039	? $DB->{$_[0]}{$_[1]}
1040	: ($DB->{$_[0]} ||= { })
1041	}
1042
1043	sub db_put($$;$) {
1044	if (@_ >= 3) {
1045	$DB->{$_[0]}{$_[1]} = $_[2];
1046	} else {
1047	$DB->{$_[0]} = $_[1];
1048	}
1049	db_dirty;
1050	}
1051
1052	attach_global
1053	prio => 10000,
1054	on_cleanup => sub {
1055	db_sync;
1056	},	2541	}
		2542
		2543	while (my ($face, $info) = each %$faces) {
		2544	next unless $info->{smooth};
		2545	my $idx = cf::face::find $face
		2546	or next;
		2547	if (my $smooth = cf::face::find $info->{smooth}) {
		2548	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2549	} else {
		2550	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2551	}
		2552	Coro::cede;
		2553	}
1057	;	2554	}
1058	}
1059		2555
1060	#############################################################################	2556	{
1061	# the server's main()	2557	my $anims = $facedata->{animinfo};
		2558
		2559	while (my ($anim, $info) = each %$anims) {
		2560	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2561	Coro::cede;
		2562	}
		2563
		2564	cf::anim::invalidate_all; # d'oh
		2565	}
		2566
		2567	1
		2568	}
		2569
		2570	sub reload_regions {
		2571	load_resource_file "$MAPDIR/regions"
		2572	or die "unable to load regions file\n";
		2573	}
		2574
		2575	sub reload_facedata {
		2576	load_facedata "$DATADIR/facedata"
		2577	or die "unable to load facedata\n";
		2578	}
		2579
		2580	sub reload_archetypes {
		2581	load_resource_file "$DATADIR/archetypes"
		2582	or die "unable to load archetypes\n";
		2583	}
		2584
		2585	sub reload_treasures {
		2586	load_resource_file "$DATADIR/treasures"
		2587	or die "unable to load treasurelists\n";
		2588	}
		2589
		2590	sub reload_resources {
		2591	warn "reloading resource files...\n";
		2592
		2593	reload_regions;
		2594	reload_facedata;
		2595	#reload_archetypes;#d#
		2596	reload_archetypes;
		2597	reload_treasures;
		2598
		2599	warn "finished reloading resource files\n";
		2600	}
		2601
		2602	sub init {
		2603	reload_resources;
		2604	}
1062		2605
1063	sub cfg_load {	2606	sub cfg_load {
1064	open my $fh, "<:utf8", cf::confdir . "/config"	2607	open my $fh, "<:utf8", "$CONFDIR/config"
1065	or return;	2608	or return;
1066		2609
1067	local $/;	2610	local $/;
1068	*CFG = YAML::Syck::Load <$fh>;	2611	*CFG = YAML::Syck::Load <$fh>;
		2612
		2613	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2614
		2615	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2616	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2617
		2618	if (exists $CFG{mlockall}) {
		2619	eval {
		2620	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2621	and die "WARNING: m(un)lockall failed: $!\n";
		2622	};
		2623	warn $@ if $@;
		2624	}
1069	}	2625	}
1070		2626
1071	sub main {	2627	sub main {
		2628	# we must not ever block the main coroutine
		2629	local $Coro::idle = sub {
		2630	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2631	(async {
		2632	Event::one_event;
		2633	})->prio (Coro::PRIO_MAX);
		2634	};
		2635
1072	cfg_load;	2636	cfg_load;
1073	db_load;	2637	db_init;
1074	load_extensions;	2638	load_extensions;
		2639
		2640	$TICK_WATCHER->start;
1075	Event::loop;	2641	Event::loop;
1076	}	2642	}
1077		2643
1078	#############################################################################	2644	#############################################################################
1079	# initialisation	2645	# initialisation and cleanup
1080		2646
1081	sub _perl_reload(&) {	2647	# install some emergency cleanup handlers
		2648	BEGIN {
		2649	for my $signal (qw(INT HUP TERM)) {
		2650	Event->signal (
		2651	reentrant => 0,
		2652	data => WF_AUTOCANCEL,
		2653	signal => $signal,
		2654	prio => 0,
		2655	cb => sub {
		2656	cf::cleanup "SIG$signal";
		2657	},
		2658	);
		2659	}
		2660	}
		2661
		2662	sub write_runtime {
		2663	my $runtime = "$LOCALDIR/runtime";
		2664
		2665	# first touch the runtime file to show we are still running:
		2666	# the fsync below can take a very very long time.
		2667
		2668	IO::AIO::aio_utime $runtime, undef, undef;
		2669
		2670	my $guard = cf::lock_acquire "write_runtime";
		2671
		2672	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2673	or return;
		2674
		2675	my $value = $cf::RUNTIME + 90 + 10;
		2676	# 10 is the runtime save interval, for a monotonic clock
		2677	# 60 allows for the watchdog to kill the server.
		2678
		2679	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2680	and return;
		2681
		2682	# always fsync - this file is important
		2683	aio_fsync $fh
		2684	and return;
		2685
		2686	# touch it again to show we are up-to-date
		2687	aio_utime $fh, undef, undef;
		2688
		2689	close $fh
		2690	or return;
		2691
		2692	aio_rename "$runtime~", $runtime
		2693	and return;
		2694
		2695	warn "runtime file written.\n";
		2696
		2697	1
		2698	}
		2699
		2700	sub emergency_save() {
		2701	my $freeze_guard = cf::freeze_mainloop;
		2702
		2703	warn "enter emergency perl save\n";
		2704
		2705	cf::sync_job {
		2706	# use a peculiar iteration method to avoid tripping on perl
		2707	# refcount bugs in for. also avoids problems with players
		2708	# and maps saved/destroyed asynchronously.
		2709	warn "begin emergency player save\n";
		2710	for my $login (keys %cf::PLAYER) {
		2711	my $pl = $cf::PLAYER{$login} or next;
		2712	$pl->valid or next;
		2713	$pl->save;
		2714	}
		2715	warn "end emergency player save\n";
		2716
		2717	warn "begin emergency map save\n";
		2718	for my $path (keys %cf::MAP) {
		2719	my $map = $cf::MAP{$path} or next;
		2720	$map->valid or next;
		2721	$map->save;
		2722	}
		2723	warn "end emergency map save\n";
		2724
		2725	warn "begin emergency database checkpoint\n";
		2726	BDB::db_env_txn_checkpoint $DB_ENV;
		2727	warn "end emergency database checkpoint\n";
		2728	};
		2729
		2730	warn "leave emergency perl save\n";
		2731	}
		2732
		2733	sub post_cleanup {
1082	my ($msg) = @_;	2734	my ($make_core) = @_;
1083		2735
1084	$msg->("reloading...");	2736	warn Carp::longmess "post_cleanup backtrace"
		2737	if $make_core;
		2738	}
1085		2739
1086	eval {	2740	sub do_reload_perl() {
1087	# cancel all watchers	2741	# can/must only be called in main
		2742	if ($Coro::current != $Coro::main) {
		2743	warn "can only reload from main coroutine";
		2744	return;
		2745	}
		2746
		2747	warn "reloading...";
		2748
		2749	warn "entering sync_job";
		2750
		2751	cf::sync_job {
		2752	cf::write_runtime; # external watchdog should not bark
		2753	cf::emergency_save;
		2754	cf::write_runtime; # external watchdog should not bark
		2755
		2756	warn "syncing database to disk";
		2757	BDB::db_env_txn_checkpoint $DB_ENV;
		2758
		2759	# if anything goes wrong in here, we should simply crash as we already saved
		2760
		2761	warn "cancelling all WF_AUTOCANCEL watchers";
1088	for (Event::all_watchers) {	2762	for (Event::all_watchers) {
1089	$_->cancel if $_->data & WF_AUTOCANCEL;	2763	$_->cancel if $_->data & WF_AUTOCANCEL;
1090	}	2764	}
1091		2765
1092	# unload all extensions	2766	warn "flushing outstanding aio requests";
1093	for (@exts) {	2767	for (;;) {
1094	$msg->("unloading <$_>");	2768	BDB::flush;
1095	unload_extension $_;	2769	IO::AIO::flush;
		2770	Coro::cede;
		2771	last unless IO::AIO::nreqs || BDB::nreqs;
		2772	warn "iterate...";
		2773	}
		2774
		2775	++$RELOAD;
		2776
		2777	warn "cancelling all extension coros";
		2778	$_->cancel for values %EXT_CORO;
		2779	%EXT_CORO = ();
		2780
		2781	warn "removing commands";
		2782	%COMMAND = ();
		2783
		2784	warn "removing ext commands";
		2785	%EXTCMD = ();
		2786
		2787	warn "unloading/nuking all extensions";
		2788	for my $pkg (@EXTS) {
		2789	warn "... unloading $pkg";
		2790
		2791	if (my $cb = $pkg->can ("unload")) {
		2792	eval {
		2793	$cb->($pkg);
		2794	1
		2795	} or warn "$pkg unloaded, but with errors: $@";
1096	}	2796	}
1097		2797
		2798	warn "... nuking $pkg";
		2799	Symbol::delete_package $pkg;
		2800	}
		2801
1098	# unload all modules loaded from $LIBDIR	2802	warn "unloading all perl modules loaded from $LIBDIR";
1099	while (my ($k, $v) = each %INC) {	2803	while (my ($k, $v) = each %INC) {
1100	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2804	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101		2805
1102	$msg->("removing <$k>");	2806	warn "... unloading $k";
1103	delete $INC{$k};	2807	delete $INC{$k};
1104		2808
1105	$k =~ s/\.pm$//;	2809	$k =~ s/\.pm$//;
1106	$k =~ s/\//::/g;	2810	$k =~ s/\//::/g;
1107		2811
…		…
1110	}	2814	}
1111		2815
1112	Symbol::delete_package $k;	2816	Symbol::delete_package $k;
1113	}	2817	}
1114		2818
1115	# sync database to disk
1116	cf::db_sync;
1117
1118	# get rid of safe::, as good as possible	2819	warn "getting rid of safe::, as good as possible";
1119	Symbol::delete_package "safe::$_"	2820	Symbol::delete_package "safe::$_"
1120	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2821	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1121		2822
1122	# remove register_script_function callbacks
1123	# TODO
1124
1125	# unload cf.pm "a bit"	2823	warn "unloading cf.pm \"a bit\"";
1126	delete $INC{"cf.pm"};	2824	delete $INC{"cf.pm"};
		2825	delete $INC{"cf/pod.pm"};
1127		2826
1128	# don't, removes xs symbols, too,	2827	# don't, removes xs symbols, too,
1129	# and global variables created in xs	2828	# and global variables created in xs
1130	#Symbol::delete_package __PACKAGE__;	2829	#Symbol::delete_package __PACKAGE__;
1131		2830
1132	# reload cf.pm	2831	warn "unload completed, starting to reload now";
		2832
1133	$msg->("reloading cf.pm");	2833	warn "reloading cf.pm";
1134	require cf;	2834	require cf;
		2835	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1135		2836
1136	# load config and database again	2837	warn "loading config and database again";
1137	cf::cfg_load;	2838	cf::cfg_load;
1138	cf::db_load;
1139		2839
1140	# load extensions	2840	warn "loading extensions";
1141	$msg->("load extensions");
1142	cf::load_extensions;	2841	cf::load_extensions;
1143		2842
1144	# reattach attachments to objects	2843	warn "reattaching attachments to objects/players";
1145	$msg->("reattach");	2844	_global_reattach; # objects, sockets
1146	_global_reattach;	2845	warn "reattaching attachments to maps";
		2846	reattach $_ for values %MAP;
		2847	warn "reattaching attachments to players";
		2848	reattach $_ for values %PLAYER;
		2849
		2850	warn "leaving sync_job";
		2851
		2852	1
		2853	} or do {
		2854	warn $@;
		2855	warn "error while reloading, exiting.";
		2856	exit 1;
1147	};	2857	};
1148	$msg->($@) if $@;
1149		2858
1150	$msg->("reloaded");	2859	warn "reloaded";
1151	};	2860	};
1152		2861
1153	sub perl_reload() {	2862	our $RELOAD_WATCHER; # used only during reload
1154	_perl_reload {	2863
1155	warn $_[0];	2864	sub reload_perl() {
1156	print "$_[0]\n";	2865	# doing reload synchronously and two reloads happen back-to-back,
		2866	# coro crashes during coro_state_free->destroy here.
		2867
		2868	$RELOAD_WATCHER ||= Event->timer (
		2869	reentrant => 0,
		2870	after => 0,
		2871	data => WF_AUTOCANCEL,
		2872	cb => sub {
		2873	do_reload_perl;
		2874	undef $RELOAD_WATCHER;
		2875	},
1157	};	2876	);
1158	}	2877	}
1159		2878
1160	register "<global>", __PACKAGE__;
1161
1162	register_command "perl-reload" => sub {	2879	register_command "reload" => sub {
1163	my ($who, $arg) = @_;	2880	my ($who, $arg) = @_;
1164		2881
1165	if ($who->flag (FLAG_WIZ)) {	2882	if ($who->flag (FLAG_WIZ)) {
1166	_perl_reload {	2883	$who->message ("reloading server.");
1167	warn $_[0];	2884	async { reload_perl };
1168	$who->message ($_[0]);	2885	}
		2886	};
		2887
		2888	unshift @INC, $LIBDIR;
		2889
		2890	my $bug_warning = 0;
		2891
		2892	our @WAIT_FOR_TICK;
		2893	our @WAIT_FOR_TICK_BEGIN;
		2894
		2895	sub wait_for_tick {
		2896	return unless $TICK_WATCHER->is_active;
		2897	return if $Coro::current == $Coro::main;
		2898
		2899	my $signal = new Coro::Signal;
		2900	push @WAIT_FOR_TICK, $signal;
		2901	$signal->wait;
		2902	}
		2903
		2904	sub wait_for_tick_begin {
		2905	return unless $TICK_WATCHER->is_active;
		2906	return if $Coro::current == $Coro::main;
		2907
		2908	my $signal = new Coro::Signal;
		2909	push @WAIT_FOR_TICK_BEGIN, $signal;
		2910	$signal->wait;
		2911	}
		2912
		2913	my $min = 1e6;#d#
		2914	my $avg = 10;
		2915	$TICK_WATCHER = Event->timer (
		2916	reentrant => 0,
		2917	parked => 1,
		2918	prio => 0,
		2919	at => $NEXT_TICK || $TICK,
		2920	data => WF_AUTOCANCEL,
		2921	cb => sub {
		2922	if ($Coro::current != $Coro::main) {
		2923	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2924	unless ++$bug_warning > 10;
		2925	return;
		2926	}
		2927
		2928	$NOW = $tick_start = Event::time;
		2929
		2930	cf::server_tick; # one server iteration
		2931
		2932	0 && sync_job {#d#
		2933	for(1..10) {
		2934	my $t = Event::time;
		2935	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2936	or die;
		2937
		2938	$map->width (50);
		2939	$map->height (50);
		2940	$map->alloc;
		2941	$map->_load_objects ("/tmp/x.map", 1);
		2942	my $t = Event::time - $t;
		2943
		2944	#next unless $t < 0.0013;#d#
		2945	if ($t < $min) {
		2946	$min = $t;
		2947	}
		2948	$avg = $avg * 0.99 + $t * 0.01;
		2949	}
		2950	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2951	exit 0;
		2952	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
1169	};	2953	};
1170	}
1171	};
1172		2954
1173	unshift @INC, $LIBDIR;	2955	$RUNTIME += $TICK;
1174
1175	$TICK_WATCHER = Event->timer (
1176	prio => 0,
1177	at => $NEXT_TICK || 1,
1178	data => WF_AUTOCANCEL,
1179	cb => sub {
1180	cf::server_tick; # one server iteration
1181
1182	my $NOW = Event::time;
1183	$NEXT_TICK += $TICK;	2956	$NEXT_TICK += $TICK;
		2957
		2958	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2959	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2960	Coro::async_pool {
		2961	write_runtime
		2962	or warn "ERROR: unable to write runtime file: $!";
		2963	};
		2964	}
		2965
		2966	# my $AFTER = Event::time;
		2967	# warn $AFTER - $NOW;#d#
		2968
		2969	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2970	$sig->send;
		2971	}
		2972	while (my $sig = shift @WAIT_FOR_TICK) {
		2973	$sig->send;
		2974	}
		2975
		2976	$NOW = Event::time;
1184		2977
1185	# if we are delayed by four ticks or more, skip them all	2978	# if we are delayed by four ticks or more, skip them all
1186	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2979	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1187		2980
1188	$TICK_WATCHER->at ($NEXT_TICK);	2981	$TICK_WATCHER->at ($NEXT_TICK);
1189	$TICK_WATCHER->start;	2982	$TICK_WATCHER->start;
		2983
		2984	$LOAD = ($NOW - $tick_start) / $TICK;
		2985	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2986
		2987	_post_tick;
		2988
		2989
1190	},	2990	},
1191	);	2991	);
1192		2992
		2993	{
		2994	BDB::max_poll_time $TICK * 0.1;
		2995	$BDB_POLL_WATCHER = Event->io (
		2996	reentrant => 0,
		2997	fd => BDB::poll_fileno,
		2998	poll => 'r',
		2999	prio => 0,
		3000	data => WF_AUTOCANCEL,
		3001	cb => \&BDB::poll_cb,
		3002	);
		3003	BDB::min_parallel 8;
		3004
		3005	BDB::set_sync_prepare {
		3006	my $status;
		3007	my $current = $Coro::current;
		3008	(
		3009	sub {
		3010	$status = $!;
		3011	$current->ready; undef $current;
		3012	},
		3013	sub {
		3014	Coro::schedule while defined $current;
		3015	$! = $status;
		3016	},
		3017	)
		3018	};
		3019
		3020	unless ($DB_ENV) {
		3021	$DB_ENV = BDB::db_env_create;
		3022
		3023	cf::sync_job {
		3024	eval {
		3025	BDB::db_env_open
		3026	$DB_ENV,
		3027	$BDBDIR,
		3028	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3029	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3030	0666;
		3031
		3032	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3033
		3034	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3035	$DB_ENV->set_lk_detect;
		3036	};
		3037
		3038	cf::cleanup "db_env_open(db): $@" if $@;
		3039	};
		3040	}
		3041	}
		3042
		3043	{
		3044	IO::AIO::min_parallel 8;
		3045
		3046	undef $Coro::AIO::WATCHER;
1193	IO::AIO::max_poll_time $TICK * 0.2;	3047	IO::AIO::max_poll_time $TICK * 0.1;
1194		3048	$AIO_POLL_WATCHER = Event->io (
1195	Event->io (fd => IO::AIO::poll_fileno,	3049	reentrant => 0,
1196	poll => 'r',
1197	prio => 5,
1198	data => WF_AUTOCANCEL,	3050	data => WF_AUTOCANCEL,
		3051	fd => IO::AIO::poll_fileno,
		3052	poll => 'r',
		3053	prio => 6,
1199	cb => \&IO::AIO::poll_cb);	3054	cb => \&IO::AIO::poll_cb,
		3055	);
		3056	}
		3057
		3058	my $_log_backtrace;
		3059
		3060	sub _log_backtrace {
		3061	my ($msg, @addr) = @_;
		3062
		3063	$msg =~ s/\n//;
		3064
		3065	# limit the # of concurrent backtraces
		3066	if ($_log_backtrace < 2) {
		3067	++$_log_backtrace;
		3068	async {
		3069	my @bt = fork_call {
		3070	@addr = map { sprintf "%x", $_ } @addr;
		3071	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3072	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3073	or die "addr2line: $!";
		3074
		3075	my @funcs;
		3076	my @res = <$fh>;
		3077	chomp for @res;
		3078	while (@res) {
		3079	my ($func, $line) = splice @res, 0, 2, ();
		3080	push @funcs, "[$func] $line";
		3081	}
		3082
		3083	@funcs
		3084	};
		3085
		3086	LOG llevInfo, "[ABT] $msg\n";
		3087	LOG llevInfo, "[ABT] $_\n" for @bt;
		3088	--$_log_backtrace;
		3089	};
		3090	} else {
		3091	LOG llevInfo, "[ABT] $msg\n";
		3092	LOG llevInfo, "[ABT] [suppressed]\n";
		3093	}
		3094	}
		3095
		3096	# load additional modules
		3097	use cf::pod;
		3098
		3099	END { cf::emergency_save }
1200		3100
1201	1	3101	1
1202		3102

Diff Legend

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