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

Diff Legend

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