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

Diff Legend

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