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.80 by root, Tue Nov 7 16:30:55 2006 UTC vs.
Revision 1.372 by root, Sat Sep 15 13:25:33 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	_init_vars;	50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		51
23	our %COMMAND = ();	52	our %COMMAND = ();
		53	our %COMMAND_TIME = ();
		54
		55	our @EXTS = (); # list of extension package names
		56	our %EXTCMD = ();
		57	our %EXTICMD = ();
		58	our %EXT_CORO = (); # coroutines bound to extensions
		59	our %EXT_MAP = (); # pluggable maps
		60
		61	our $RELOAD; # number of reloads so far
24	our @EVENT;	62	our @EVENT;
25	our $LIBDIR = maps_directory "perl";
26		63
27	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(!)
28	our $TICK_WATCHER;	77	our $TICK_WATCHER;
		78	our $AIO_POLL_WATCHER;
		79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
29	our $NEXT_TICK;	80	our $NEXT_TICK;
		81	our $NOW;
		82	our $USE_FSYNC = 1; # use fsync to write maps - default off
		83
		84	our $BDB_POLL_WATCHER;
		85	our $BDB_DEADLOCK_WATCHER;
		86	our $BDB_CHECKPOINT_WATCHER;
		87	our $BDB_TRICKLE_WATCHER;
		88	our $DB_ENV;
30		89
31	our %CFG;	90	our %CFG;
32		91
33	our $uptime;	92	our $UPTIME; $UPTIME ||= time;
		93	our $RUNTIME;
34		94
35	$uptime ||= time;	95	our (%PLAYER, %PLAYER_LOADING); # all users
		96	our (%MAP, %MAP_LOADING ); # all maps
		97	our $LINK_MAP; # the special {link} map, which is always available
		98
		99	# used to convert map paths into valid unix filenames by replacing / by ∕
		100	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		101
		102	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		103	our $LOADAVG; # same thing, but with alpha-smoothing
		104	our $tick_start; # for load detecting purposes
		105
		106	binmode STDOUT;
		107	binmode STDERR;
		108
		109	# read virtual server time, if available
		110	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
		111	open my $fh, "<", "$LOCALDIR/runtime"
		112	or die "unable to read runtime file: $!";
		113	$RUNTIME = <$fh> + 0.;
		114	}
		115
		116	mkdir $_
		117	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
		118
		119	our $EMERGENCY_POSITION;
		120
		121	sub cf::map::normalise;
36		122
37	#############################################################################	123	#############################################################################
38		124
39	=head2 GLOBAL VARIABLES	125	=head2 GLOBAL VARIABLES
40		126
41	=over 4	127	=over 4
42		128
43	=item $cf::LIBDIR	129	=item $cf::UPTIME
44		130
45	The perl library directory, where extensions and cf-specific modules can	131	The timestamp of the server start (so not actually an uptime).
46	be found. It will be added to C<@INC> automatically.	132
		133	=item $cf::RUNTIME
		134
		135	The time this server has run, starts at 0 and is increased by $cf::TICK on
		136	every server tick.
		137
		138	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		139	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		140	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
		141
		142	Various directories - "/etc", read-only install directory, perl-library
		143	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		144	unique-items directory, player file directory, random maps directory and
		145	database environment.
		146
		147	=item $cf::NOW
		148
		149	The time of the last (current) server tick.
47		150
48	=item $cf::TICK	151	=item $cf::TICK
49		152
50	The interval between server ticks, in seconds.	153	The interval between server ticks, in seconds.
		154
		155	=item $cf::LOADAVG
		156
		157	The current CPU load on the server (alpha-smoothed), as a value between 0
		158	(none) and 1 (overloaded), indicating how much time is spent on processing
		159	objects per tick. Healthy values are < 0.5.
		160
		161	=item $cf::LOAD
		162
		163	The raw value load value from the last tick.
51		164
52	=item %cf::CFG	165	=item %cf::CFG
53		166
54	Configuration for the server, loaded from C</etc/crossfire/config>, or	167	Configuration for the server, loaded from C</etc/crossfire/config>, or
55	from wherever your confdir points to.	168	from wherever your confdir points to.
		169
		170	=item cf::wait_for_tick, cf::wait_for_tick_begin
		171
		172	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		173	returns directly I<after> the tick processing (and consequently, can only wake one process
		174	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		175
		176	=item @cf::INVOKE_RESULTS
		177
		178	This array contains the results of the last C<invoke ()> call. When
		179	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		180	that call.
56		181
57	=back	182	=back
58		183
59	=cut	184	=cut
60		185
61	BEGIN {	186	BEGIN {
62	*CORE::GLOBAL::warn = sub {	187	*CORE::GLOBAL::warn = sub {
63	my $msg = join "", @_;	188	my $msg = join "", @_;
		189
64	$msg .= "\n"	190	$msg .= "\n"
65	unless $msg =~ /\n$/;	191	unless $msg =~ /\n$/;
66		192
67	print STDERR "cfperl: $msg";	193	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		194
68	LOG llevError, "cfperl: $msg";	195	LOG llevError, $msg;
69	};	196	};
70	}	197	}
71		198
		199	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		200	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		201	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		202	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		203	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		204	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
72	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	205	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
73		206
74	# we bless all objects into (empty) derived classes to force a method lookup	207	# we bless all objects into (empty) derived classes to force a method lookup
75	# within the Safe compartment.	208	# within the Safe compartment.
76	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	209	for my $pkg (qw(
		210	cf::global cf::attachable
		211	cf::object cf::object::player
		212	cf::client cf::player
		213	cf::arch cf::living
		214	cf::map cf::party cf::region
		215	)) {
77	no strict 'refs';	216	no strict 'refs';
78	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	217	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
79	}	218	}
80		219
81	$Event::DIED = sub {	220	$Event::DIED = sub {
82	warn "error in event callback: @_";	221	warn "error in event callback: @_";
83	};	222	};
84		223
85	my %ext_pkg;	224	#############################################################################
86	my @exts;
87	my @hook;
88	my %command;
89	my %extcmd;
90		225
91	=head2 UTILITY FUNCTIONS	226	=head2 UTILITY FUNCTIONS
92		227
93	=over 4	228	=over 4
94		229
95	=cut	230	=item dumpval $ref
96		231
97	use JSON::Syck (); # TODO# replace by JSON::PC once working	232	=cut
		233
		234	sub dumpval {
		235	eval {
		236	local $SIG{__DIE__};
		237	my $d;
		238	if (1) {
		239	$d = new Data::Dumper([$_[0]], ["*var"]);
		240	$d->Terse(1);
		241	$d->Indent(2);
		242	$d->Quotekeys(0);
		243	$d->Useqq(1);
		244	#$d->Bless(...);
		245	$d->Seen($_[1]) if @_ > 1;
		246	$d = $d->Dump();
		247	}
		248	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		249	$d
		250	} || "[unable to dump $_[0]: '$@']";
		251	}
98		252
99	=item $ref = cf::from_json $json	253	=item $ref = cf::from_json $json
100		254
101	Converts a JSON string into the corresponding perl data structure.	255	Converts a JSON string into the corresponding perl data structure.
102		256
103	=cut
104
105	sub from_json($) {
106	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
107	JSON::Syck::Load $_[0]
108	}
109
110	=item $json = cf::to_json $ref	257	=item $json = cf::to_json $ref
111		258
112	Converts a perl data structure into its JSON representation.	259	Converts a perl data structure into its JSON representation.
113		260
114	=cut	261	=cut
115		262
116	sub to_json($) {	263	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
117	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	264
118	JSON::Syck::Dump $_[0]	265	sub to_json ($) { $json_coder->encode ($_[0]) }
		266	sub from_json ($) { $json_coder->decode ($_[0]) }
		267
		268	=item cf::lock_wait $string
		269
		270	Wait until the given lock is available. See cf::lock_acquire.
		271
		272	=item my $lock = cf::lock_acquire $string
		273
		274	Wait until the given lock is available and then acquires it and returns
		275	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		276	for example when the coroutine gets canceled), the lock is automatically
		277	returned.
		278
		279	Locks are *not* recursive, locking from the same coro twice results in a
		280	deadlocked coro.
		281
		282	Lock names should begin with a unique identifier (for example, cf::map::find
		283	uses map_find and cf::map::load uses map_load).
		284
		285	=item $locked = cf::lock_active $string
		286
		287	Return true if the lock is currently active, i.e. somebody has locked it.
		288
		289	=cut
		290
		291	our %LOCK;
		292	our %LOCKER;#d#
		293
		294	sub lock_wait($) {
		295	my ($key) = @_;
		296
		297	if ($LOCKER{$key} == $Coro::current) {#d#
		298	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		299	return;#d#
		300	}#d#
		301
		302	# wait for lock, if any
		303	while ($LOCK{$key}) {
		304	push @{ $LOCK{$key} }, $Coro::current;
		305	Coro::schedule;
		306	}
		307	}
		308
		309	sub lock_acquire($) {
		310	my ($key) = @_;
		311
		312	# wait, to be sure we are not locked
		313	lock_wait $key;
		314
		315	$LOCK{$key} = [];
		316	$LOCKER{$key} = $Coro::current;#d#
		317
		318	Coro::guard {
		319	delete $LOCKER{$key};#d#
		320	# wake up all waiters, to be on the safe side
		321	$_->ready for @{ delete $LOCK{$key} };
		322	}
		323	}
		324
		325	sub lock_active($) {
		326	my ($key) = @_;
		327
		328	! ! $LOCK{$key}
		329	}
		330
		331	sub freeze_mainloop {
		332	return unless $TICK_WATCHER->is_active;
		333
		334	my $guard = Coro::guard {
		335	$TICK_WATCHER->start;
		336	};
		337	$TICK_WATCHER->stop;
		338	$guard
		339	}
		340
		341	=item cf::get_slot $time[, $priority[, $name]]
		342
		343	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		344	This call blocks and returns only when you have at least C<$time> seconds
		345	of cpu time till the next tick. The slot is only valid till the next cede.
		346
		347	The optional C<$name> can be used to identify the job to run. It might be
		348	used for statistical purposes and should identify the same time-class.
		349
		350	Useful for short background jobs.
		351
		352	=cut
		353
		354	our @SLOT_QUEUE;
		355	our $SLOT_QUEUE;
		356
		357	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		358	$SLOT_QUEUE = Coro::async {
		359	my $signal = new Coro::Signal;
		360
		361	while () {
		362	next_job:
		363	my $avail = cf::till_tick;
		364	if ($avail > 0.01) {
		365	for (0 .. $#SLOT_QUEUE) {
		366	if ($SLOT_QUEUE[$_][0] < $avail) {
		367	my $job = splice @SLOT_QUEUE, $_, 1, ();
		368	$job->[2]->send;
		369	Coro::cede;
		370	goto next_job;
		371	}
		372	}
		373	}
		374
		375	if (@SLOT_QUEUE) {
		376	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		377	push @cf::WAIT_FOR_TICK, $signal;
		378	$signal->wait;
		379	} else {
		380	Coro::schedule;
		381	}
		382	}
		383	};
		384
		385	sub get_slot($;$$) {
		386	my ($time, $pri, $name) = @_;
		387
		388	$time = $TICK * .6 if $time > $TICK * .6;
		389	my $sig = new Coro::Signal;
		390
		391	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		392	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		393	$SLOT_QUEUE->ready;
		394	$sig->wait;
		395	}
		396
		397	=item cf::async { BLOCK }
		398
		399	Currently the same as Coro::async_pool, meaning you cannot use
		400	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		401	thing you are allowed to do is call C<prio> on it.
		402
		403	=cut
		404
		405	BEGIN { *async = \&Coro::async_pool }
		406
		407	=item cf::sync_job { BLOCK }
		408
		409	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
		410	is always able to handle events or runnable, as Crossfire TRT is only
		411	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		412	acceptable.
		413
		414	If it must be done, put the blocking parts into C<sync_job>. This will run
		415	the given BLOCK in another coroutine while waiting for the result. The
		416	server will be frozen during this time, so the block should either finish
		417	fast or be very important.
		418
		419	=cut
		420
		421	sub sync_job(&) {
		422	my ($job) = @_;
		423
		424	if ($Coro::current == $Coro::main) {
		425	my $time = Event::time;
		426
		427	# this is the main coro, too bad, we have to block
		428	# till the operation succeeds, freezing the server :/
		429
		430	# TODO: use suspend/resume instead
		431	# (but this is cancel-safe)
		432	my $freeze_guard = freeze_mainloop;
		433
		434	my $busy = 1;
		435	my @res;
		436
		437	(async {
		438	@res = eval { $job->() };
		439	warn $@ if $@;
		440	undef $busy;
		441	})->prio (Coro::PRIO_MAX);
		442
		443	while ($busy) {
		444	Coro::cede or Event::one_event;
		445	}
		446
		447	$time = Event::time - $time;
		448
		449	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		450	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		451
		452	$tick_start += $time; # do not account sync jobs to server load
		453
		454	wantarray ? @res : $res[0]
		455	} else {
		456	# we are in another coroutine, how wonderful, everything just works
		457
		458	$job->()
		459	}
		460	}
		461
		462	=item $coro = cf::async_ext { BLOCK }
		463
		464	Like async, but this coro is automatically being canceled when the
		465	extension calling this is being unloaded.
		466
		467	=cut
		468
		469	sub async_ext(&) {
		470	my $cb = shift;
		471
		472	my $coro = &Coro::async ($cb);
		473
		474	$coro->on_destroy (sub {
		475	delete $EXT_CORO{$coro+0};
		476	});
		477	$EXT_CORO{$coro+0} = $coro;
		478
		479	$coro
		480	}
		481
		482	=item fork_call { }, $args
		483
		484	Executes the given code block with the given arguments in a seperate
		485	process, returning the results. Everything must be serialisable with
		486	Coro::Storable. May, of course, block. Note that the executed sub may
		487	never block itself or use any form of Event handling.
		488
		489	=cut
		490
		491	sub fork_call(&@) {
		492	my ($cb, @args) = @_;
		493
		494	# we seemingly have to make a local copy of the whole thing,
		495	# otherwise perl prematurely frees the stuff :/
		496	# TODO: investigate and fix (likely this will be rather laborious)
		497
		498	my @res = Coro::Util::fork_eval {
		499	reset_signals;
		500	&$cb
		501	}, @args;
		502
		503	wantarray ? @res : $res[-1]
		504	}
		505
		506	=item $value = cf::db_get $family => $key
		507
		508	Returns a single value from the environment database.
		509
		510	=item cf::db_put $family => $key => $value
		511
		512	Stores the given C<$value> in the family. It can currently store binary
		513	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		514
		515	=item $db = cf::db_table "name"
		516
		517	Create and/or open a new database table. The string must not be "db" and must be unique
		518	within each server.
		519
		520	=cut
		521
		522	sub db_table($) {
		523	my ($name) = @_;
		524	my $db = BDB::db_create $DB_ENV;
		525
		526	eval {
		527	$db->set_flags (BDB::CHKSUM);
		528
		529	utf8::encode $name;
		530	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		531	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		532	cf::cleanup "db_open(db): $!" if $!;
		533	};
		534	cf::cleanup "db_open(db): $@" if $@;
		535
		536	$db
		537	}
		538
		539	our $DB;
		540
		541	sub db_init {
		542	cf::sync_job {
		543	$DB ||= db_table "db";
		544	};
		545	}
		546
		547	sub db_get($$) {
		548	my $key = "$_[0]/$_[1]";
		549
		550	cf::sync_job {
		551	BDB::db_get $DB, undef, $key, my $data;
		552
		553	$! ? ()
		554	: $data
		555	}
		556	}
		557
		558	sub db_put($$$) {
		559	BDB::dbreq_pri 4;
		560	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		561	}
		562
		563	=item cf::cache $id => [$paths...], $processversion => $process
		564
		565	Generic caching function that returns the value of the resource $id,
		566	caching and regenerating as required.
		567
		568	This function can block.
		569
		570	=cut
		571
		572	sub cache {
		573	my ($id, $src, $processversion, $process) = @_;
		574
		575	my $meta =
		576	join "\x00",
		577	$processversion,
		578	map {
		579	aio_stat $_
		580	and Carp::croak "$_: $!";
		581
		582	($_, (stat _)[7,9])
		583	} @$src;
		584
		585	my $dbmeta = db_get cache => "$id/meta";
		586	if ($dbmeta ne $meta) {
		587	# changed, we may need to process
		588
		589	my @data;
		590	my $md5;
		591
		592	for (0 .. $#$src) {
		593	0 <= aio_load $src->[$_], $data[$_]
		594	or Carp::croak "$src->[$_]: $!";
		595	}
		596
		597	# if processing is expensive, check
		598	# checksum first
		599	if (1) {
		600	$md5 =
		601	join "\x00",
		602	$processversion,
		603	map {
		604	cf::cede_to_tick;
		605	($src->[$_], Digest::MD5::md5_hex $data[$_])
		606	} 0.. $#$src;
		607
		608
		609	my $dbmd5 = db_get cache => "$id/md5";
		610	if ($dbmd5 eq $md5) {
		611	db_put cache => "$id/meta", $meta;
		612
		613	return db_get cache => "$id/data";
		614	}
		615	}
		616
		617	my $t1 = Time::HiRes::time;
		618	my $data = $process->(\@data);
		619	my $t2 = Time::HiRes::time;
		620
		621	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		622
		623	db_put cache => "$id/data", $data;
		624	db_put cache => "$id/md5" , $md5;
		625	db_put cache => "$id/meta", $meta;
		626
		627	return $data;
		628	}
		629
		630	db_get cache => "$id/data"
		631	}
		632
		633	=item cf::datalog type => key => value, ...
		634
		635	Log a datalog packet of the given type with the given key-value pairs.
		636
		637	=cut
		638
		639	sub datalog($@) {
		640	my ($type, %kv) = @_;
		641	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
119	}	642	}
120		643
121	=back	644	=back
122		645
123	=cut	646	=cut
124		647
125	#############################################################################	648	#############################################################################
126		649
127	=head2 EVENTS AND OBJECT ATTACHMENTS	650	=head2 ATTACHABLE OBJECTS
		651
		652	Many objects in crossfire are so-called attachable objects. That means you can
		653	attach callbacks/event handlers (a collection of which is called an "attachment")
		654	to it. All such attachable objects support the following methods.
		655
		656	In the following description, CLASS can be any of C<global>, C<object>
		657	C<player>, C<client> or C<map> (i.e. the attachable objects in
		658	Crossfire TRT).
128		659
129	=over 4	660	=over 4
130		661
131	=item $object->attach ($attachment, key => $value...)
132
133	=item $object->detach ($attachment)
134
135	Attach/detach a pre-registered attachment to an object.
136
137	=item $player->attach ($attachment, key => $value...)
138
139	=item $player->detach ($attachment)
140
141	Attach/detach a pre-registered attachment to a player.
142
143	=item $map->attach ($attachment, key => $value...)	662	=item $attachable->attach ($attachment, key => $value...)
144		663
145	=item $map->detach ($attachment)	664	=item $attachable->detach ($attachment)
146		665
147	Attach/detach a pre-registered attachment to a map.	666	Attach/detach a pre-registered attachment to a specific object and give it
		667	the specified key/value pairs as arguments.
148		668
149	=item $bool = $object->attached ($name)	669	Example, attach a minesweeper attachment to the given object, making it a
		670	10x10 minesweeper game:
150		671
151	=item $bool = $player->attached ($name)	672	$obj->attach (minesweeper => width => 10, height => 10);
152		673
153	=item $bool = $map->attached ($name)	674	=item $bool = $attachable->attached ($name)
154		675
155	Checks wether the named attachment is currently attached to the object.	676	Checks wether the named attachment is currently attached to the object.
156		677
157	=item cf::attach_global ...	678	=item cf::CLASS->attach ...
158		679
159	Attach handlers for global events.	680	=item cf::CLASS->detach ...
160		681
161	This and all following C<attach_*>-functions expect any number of the	682	Define an anonymous attachment and attach it to all objects of the given
162	following handler/hook descriptions:	683	CLASS. See the next function for an explanation of its arguments.
		684
		685	You can attach to global events by using the C<cf::global> class.
		686
		687	Example, log all player logins:
		688
		689	cf::player->attach (
		690	on_login => sub {
		691	my ($pl) = @_;
		692	...
		693	},
		694	);
		695
		696	Example, attach to the jeweler skill:
		697
		698	cf::object->attach (
		699	type => cf::SKILL,
		700	subtype => cf::SK_JEWELER,
		701	on_use_skill => sub {
		702	my ($sk, $ob, $part, $dir, $msg) = @_;
		703	...
		704	},
		705	);
		706
		707	=item cf::CLASS::attachment $name, ...
		708
		709	Register an attachment by C<$name> through which attachable objects of the
		710	given CLASS can refer to this attachment.
		711
		712	Some classes such as crossfire maps and objects can specify attachments
		713	that are attached at load/instantiate time, thus the need for a name.
		714
		715	These calls expect any number of the following handler/hook descriptions:
163		716
164	=over 4	717	=over 4
165		718
166	=item prio => $number	719	=item prio => $number
167		720
…		…
169	by another C<prio> setting). Lower priority handlers get executed	722	by another C<prio> setting). Lower priority handlers get executed
170	earlier. The default priority is C<0>, and many built-in handlers are	723	earlier. The default priority is C<0>, and many built-in handlers are
171	registered at priority C<-1000>, so lower priorities should not be used	724	registered at priority C<-1000>, so lower priorities should not be used
172	unless you know what you are doing.	725	unless you know what you are doing.
173		726
		727	=item type => $type
		728
		729	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		730	given type of objects only (the additional parameter C<subtype> can be
		731	used to further limit to the given subtype).
		732
174	=item on_I<event> => \&cb	733	=item on_I<event> => \&cb
175		734
176	Call the given code reference whenever the named event happens (event is	735	Call the given code reference whenever the named event happens (event is
177	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	736	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
178	handlers are recognised generally depends on the type of object these	737	handlers are recognised generally depends on the type of object these
…		…
187	package and register them. Only handlers for eevents supported by the	746	package and register them. Only handlers for eevents supported by the
188	object/class are recognised.	747	object/class are recognised.
189		748
190	=back	749	=back
191		750
192	=item cf::attach_to_type $object_type, $subtype, ...	751	Example, define an attachment called "sockpuppet" that calls the given
		752	event handler when a monster attacks:
193		753
194	Attach handlers for a specific object type (e.g. TRANSPORT) and	754	cf::object::attachment sockpuppet =>
195	subtype. If C<$subtype> is zero or undef, matches all objects of the given	755	on_skill_attack => sub {
196	type.	756	my ($self, $victim) = @_;
197		757	...
198	=item cf::attach_to_objects ...
199
200	Attach handlers to all objects. Do not use this except for debugging or
201	very rare events, as handlers are (obviously) called for I<all> objects in
202	the game.
203
204	=item cf::attach_to_players ...
205
206	Attach handlers to all players.
207
208	=item cf::attach_to_maps ...
209
210	Attach handlers to all maps.
211
212	=item cf:register_attachment $name, ...
213
214	Register an attachment by name through which objects can refer to this
215	attachment.
216
217	=item cf:register_player_attachment $name, ...
218
219	Register an attachment by name through which players can refer to this
220	attachment.
221
222	=item cf:register_map_attachment $name, ...
223
224	Register an attachment by name through which maps can refer to this
225	attachment.
226
227	=cut
228
229	# the following variables are defined in .xs and must not be re-created
230	our @CB_GLOBAL = (); # registry for all global events
231	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
232	our @CB_PLAYER = ();
233	our @CB_TYPE = (); # registry for type (cf-object class) based events
234	our @CB_MAP = ();
235
236	my %attachment;
237
238	sub _attach_cb($\%$$$) {
239	my ($registry, $undo, $event, $prio, $cb) = @_;
240
241	use sort 'stable';
242
243	$cb = [$prio, $cb];
244
245	@{$registry->[$event]} = sort
246	{ $a->[0] cmp $b->[0] }
247	@{$registry->[$event] || []}, $cb;
248
249	push @{$undo->{cb}}, [$event, $cb];
250	}
251
252	# attach handles attaching event callbacks
253	# the only thing the caller has to do is pass the correct
254	# registry (== where the callback attaches to).
255	sub _attach(\@$@) {
256	my ($registry, $klass, @arg) = @_;
257
258	my $prio = 0;
259
260	my %undo = (
261	registry => $registry,
262	cb => [],
263	);
264
265	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
266
267	while (@arg) {
268	my $type = shift @arg;
269
270	if ($type eq "prio") {
271	$prio = shift @arg;
272
273	} elsif ($type eq "package") {
274	my $pkg = shift @arg;
275
276	while (my ($name, $id) = each %cb_id) {
277	if (my $cb = $pkg->can ($name)) {
278	_attach_cb $registry, %undo, $id, $prio, $cb;
279	}
280	}	758	}
281
282	} elsif (exists $cb_id{$type}) {
283	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
284
285	} elsif (ref $type) {
286	warn "attaching objects not supported, ignoring.\n";
287
288	} else {
289	shift @arg;
290	warn "attach argument '$type' not supported, ignoring.\n";
291	}
292	}
293
294	\%undo
295	}
296
297	sub _attach_attachment {
298	my ($obj, $name, %arg) = @_;
299
300	return if exists $obj->{_attachment}{$name};
301
302	my $res;
303
304	if (my $attach = $attachment{$name}) {
305	my $registry = $obj->registry;
306
307	for (@$attach) {
308	my ($klass, @attach) = @$_;
309	$res = _attach @$registry, $klass, @attach;
310	}
311
312	$obj->{$name} = \%arg;
313	} else {
314	warn "object uses attachment '$name' that is not available, postponing.\n";
315	}
316
317	$obj->{_attachment}{$name} = undef;
318
319	$res->{attachment} = $name;
320	$res
321	}
322
323	*cf::object::attach =
324	*cf::player::attach =
325	*cf::map::attach = sub {
326	my ($obj, $name, %arg) = @_;
327
328	_attach_attachment $obj, $name, %arg;
329	};
330
331	# all those should be optimised
332	*cf::object::detach =
333	*cf::player::detach =
334	*cf::map::detach = sub {
335	my ($obj, $name) = @_;
336
337	delete $obj->{_attachment}{$name};
338	reattach ($obj);
339	};
340
341	*cf::object::attached =
342	*cf::player::attached =
343	*cf::map::attached = sub {
344	my ($obj, $name) = @_;
345
346	exists $obj->{_attachment}{$name}
347	};
348
349	sub attach_global {
350	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
351	}
352
353	sub attach_to_type {
354	my $type = shift;
355	my $subtype = shift;
356
357	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
358	}
359
360	sub attach_to_objects {
361	_attach @CB_OBJECT, KLASS_OBJECT, @_
362	}
363
364	sub attach_to_players {
365	_attach @CB_PLAYER, KLASS_PLAYER, @_
366	}
367
368	sub attach_to_maps {
369	_attach @CB_MAP, KLASS_MAP, @_
370	}
371
372	sub register_attachment {
373	my $name = shift;
374
375	$attachment{$name} = [[KLASS_OBJECT, @_]];
376	}
377
378	sub register_player_attachment {
379	my $name = shift;
380
381	$attachment{$name} = [[KLASS_PLAYER, @_]];
382	}
383
384	sub register_map_attachment {
385	my $name = shift;
386
387	$attachment{$name} = [[KLASS_MAP, @_]];
388	}
389
390	our $override;
391	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
392
393	sub override {
394	$override = 1;
395	@invoke_results = ();
396	}
397
398	sub do_invoke {
399	my $event = shift;
400	my $callbacks = shift;
401
402	@invoke_results = ();
403
404	local $override;
405
406	for (@$callbacks) {
407	eval { &{$_->[1]} };
408
409	if ($@) {
410	warn "$@";
411	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
412	override;
413	}
414
415	return 1 if $override;
416	}
417
418	0	759	}
419	}
420		760
421	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	761	=item $attachable->valid
422
423	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
424
425	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
426
427	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
428
429	Generate a global/object/player/map-specific event with the given arguments.
430
431	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
432	removed in future versions), and there is no public API to access override
433	results (if you must, access C<@cf::invoke_results> directly).
434
435	=back
436
437	=cut
438
439	#############################################################################
440
441	=head2 METHODS VALID FOR ALL CORE OBJECTS
442
443	=over 4
444
445	=item $object->valid, $player->valid, $map->valid
446		762
447	Just because you have a perl object does not mean that the corresponding	763	Just because you have a perl object does not mean that the corresponding
448	C-level object still exists. If you try to access an object that has no	764	C-level object still exists. If you try to access an object that has no
449	valid C counterpart anymore you get an exception at runtime. This method	765	valid C counterpart anymore you get an exception at runtime. This method
450	can be used to test for existence of the C object part without causing an	766	can be used to test for existence of the C object part without causing an
451	exception.	767	exception.
452		768
		769	=cut
		770
		771	# the following variables are defined in .xs and must not be re-created
		772	our @CB_GLOBAL = (); # registry for all global events
		773	our @CB_ATTACHABLE = (); # registry for all attachables
		774	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		775	our @CB_PLAYER = ();
		776	our @CB_CLIENT = ();
		777	our @CB_TYPE = (); # registry for type (cf-object class) based events
		778	our @CB_MAP = ();
		779
		780	my %attachment;
		781
		782	sub cf::attachable::thawer_merge {
		783	# simply override everything except _meta
		784	local $_[0]{_meta};
		785	%{$_[0]} = %{$_[1]};
		786	}
		787
		788	sub _attach_cb($$$$) {
		789	my ($registry, $event, $prio, $cb) = @_;
		790
		791	use sort 'stable';
		792
		793	$cb = [$prio, $cb];
		794
		795	@{$registry->[$event]} = sort
		796	{ $a->[0] cmp $b->[0] }
		797	@{$registry->[$event] || []}, $cb;
		798	}
		799
		800	# hack
		801	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		802
		803	# attach handles attaching event callbacks
		804	# the only thing the caller has to do is pass the correct
		805	# registry (== where the callback attaches to).
		806	sub _attach {
		807	my ($registry, $klass, @arg) = @_;
		808
		809	my $object_type;
		810	my $prio = 0;
		811	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		812
		813	#TODO: get rid of this hack
		814	if ($attachable_klass{$klass}) {
		815	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		816	}
		817
		818	while (@arg) {
		819	my $type = shift @arg;
		820
		821	if ($type eq "prio") {
		822	$prio = shift @arg;
		823
		824	} elsif ($type eq "type") {
		825	$object_type = shift @arg;
		826	$registry = $CB_TYPE[$object_type] ||= [];
		827
		828	} elsif ($type eq "subtype") {
		829	defined $object_type or Carp::croak "subtype specified without type";
		830	my $object_subtype = shift @arg;
		831	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
		832
		833	} elsif ($type eq "package") {
		834	my $pkg = shift @arg;
		835
		836	while (my ($name, $id) = each %cb_id) {
		837	if (my $cb = $pkg->can ($name)) {
		838	_attach_cb $registry, $id, $prio, $cb;
		839	}
		840	}
		841
		842	} elsif (exists $cb_id{$type}) {
		843	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		844
		845	} elsif (ref $type) {
		846	warn "attaching objects not supported, ignoring.\n";
		847
		848	} else {
		849	shift @arg;
		850	warn "attach argument '$type' not supported, ignoring.\n";
		851	}
		852	}
		853	}
		854
		855	sub _object_attach {
		856	my ($obj, $name, %arg) = @_;
		857
		858	return if exists $obj->{_attachment}{$name};
		859
		860	if (my $attach = $attachment{$name}) {
		861	my $registry = $obj->registry;
		862
		863	for (@$attach) {
		864	my ($klass, @attach) = @$_;
		865	_attach $registry, $klass, @attach;
		866	}
		867
		868	$obj->{$name} = \%arg;
		869	} else {
		870	warn "object uses attachment '$name' which is not available, postponing.\n";
		871	}
		872
		873	$obj->{_attachment}{$name} = undef;
		874	}
		875
		876	sub cf::attachable::attach {
		877	if (ref $_[0]) {
		878	_object_attach @_;
		879	} else {
		880	_attach shift->_attach_registry, @_;
		881	}
		882	_recalc_want;
		883	};
		884
		885	# all those should be optimised
		886	sub cf::attachable::detach {
		887	my ($obj, $name) = @_;
		888
		889	if (ref $obj) {
		890	delete $obj->{_attachment}{$name};
		891	reattach ($obj);
		892	} else {
		893	Carp::croak "cannot, currently, detach class attachments";
		894	}
		895	_recalc_want;
		896	};
		897
		898	sub cf::attachable::attached {
		899	my ($obj, $name) = @_;
		900
		901	exists $obj->{_attachment}{$name}
		902	}
		903
		904	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		905	eval "#line " . __LINE__ . " 'cf.pm'
		906	sub cf::\L$klass\E::_attach_registry {
		907	(\\\@CB_$klass, KLASS_$klass)
		908	}
		909
		910	sub cf::\L$klass\E::attachment {
		911	my \$name = shift;
		912
		913	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		914	}
		915	";
		916	die if $@;
		917	}
		918
		919	our $override;
		920	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		921
		922	sub override {
		923	$override = 1;
		924	@INVOKE_RESULTS = (@_);
		925	}
		926
		927	sub do_invoke {
		928	my $event = shift;
		929	my $callbacks = shift;
		930
		931	@INVOKE_RESULTS = ();
		932
		933	local $override;
		934
		935	for (@$callbacks) {
		936	eval { &{$_->[1]} };
		937
		938	if ($@) {
		939	warn "$@";
		940	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		941	override;
		942	}
		943
		944	return 1 if $override;
		945	}
		946
		947	0
		948	}
		949
		950	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		951
		952	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		953
		954	Generate an object-specific event with the given arguments.
		955
		956	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		957	removed in future versions), and there is no public API to access override
		958	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
		959
453	=back	960	=back
454		961
455	=cut	962	=cut
456
457	*cf::object::valid =
458	*cf::player::valid =
459	*cf::map::valid = \&cf::_valid;
460		963
461	#############################################################################	964	#############################################################################
462	# object support	965	# object support
		966	#
463		967
464	sub instantiate {	968	sub _can_merge {
465	my ($obj, $data) = @_;	969	my ($ob1, $ob2) = @_;
466		970
467	$data = from_json $data;	971	local $Storable::canonical = 1;
		972	my $fob1 = Storable::freeze $ob1;
		973	my $fob2 = Storable::freeze $ob2;
468		974
469	for (@$data) {	975	$fob1 eq $fob2
470	my ($name, $args) = @$_;
471
472	$obj->attach ($name, %{$args || {} });
473	}
474	}	976	}
475		977
476	# basically do the same as instantiate, without calling instantiate
477	sub reattach {	978	sub reattach {
		979	# basically do the same as instantiate, without calling instantiate
478	my ($obj) = @_;	980	my ($obj) = @_;
		981
		982	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		983
479	my $registry = $obj->registry;	984	my $registry = $obj->registry;
480		985
481	@$registry = ();	986	@$registry = ();
482		987
483	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	988	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
484		989
485	for my $name (keys %{ $obj->{_attachment} || {} }) {	990	for my $name (keys %{ $obj->{_attachment} || {} }) {
486	if (my $attach = $attachment{$name}) {	991	if (my $attach = $attachment{$name}) {
487	for (@$attach) {	992	for (@$attach) {
488	my ($klass, @attach) = @$_;	993	my ($klass, @attach) = @$_;
489	_attach @$registry, $klass, @attach;	994	_attach $registry, $klass, @attach;
490	}	995	}
491	} else {	996	} else {
492	warn "object uses attachment '$name' that is not available, postponing.\n";	997	warn "object uses attachment '$name' that is not available, postponing.\n";
493	}	998	}
494	}	999	}
495	}	1000	}
496		1001
497	sub object_freezer_save {	1002	cf::attachable->attach (
498	my ($filename, $rdata, $objs) = @_;
499
500	if (length $$rdata) {
501	warn sprintf "saving %s (%d,%d)\n",
502	$filename, length $$rdata, scalar @$objs;
503
504	if (open my $fh, ">:raw", "$filename~") {
505	chmod SAVE_MODE, $fh;
506	syswrite $fh, $$rdata;
507	close $fh;
508
509	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
510	chmod SAVE_MODE, $fh;
511	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
512	close $fh;
513	rename "$filename.pst~", "$filename.pst";
514	} else {
515	unlink "$filename.pst";
516	}
517
518	rename "$filename~", $filename;
519	} else {
520	warn "FATAL: $filename~: $!\n";
521	}
522	} else {
523	unlink $filename;
524	unlink "$filename.pst";
525	}
526	}
527
528	sub object_freezer_as_string {
529	my ($rdata, $objs) = @_;
530
531	use Data::Dumper;
532
533	"$$rdata\n" . Dumper $objs
534	}
535
536	sub object_thawer_load {
537	my ($filename) = @_;
538
539	local $/;
540
541	my $av;
542
543	#TODO: use sysread etc.
544	if (open my $data, "<:raw:perlio", $filename) {
545	$data = <$data>;
546	if (open my $pst, "<:raw:perlio", "$filename.pst") {
547	$av = eval { (Storable::thaw <$pst>)->{objs} };
548	}
549	return ($data, $av);
550	}
551
552	()
553	}
554
555	attach_to_objects
556	prio => -1000000,	1003	prio => -1000000,
		1004	on_instantiate => sub {
		1005	my ($obj, $data) = @_;
		1006
		1007	$data = from_json $data;
		1008
		1009	for (@$data) {
		1010	my ($name, $args) = @$_;
		1011
		1012	$obj->attach ($name, %{$args || {} });
		1013	}
		1014	},
		1015	on_reattach => \&reattach,
557	on_clone => sub {	1016	on_clone => sub {
558	my ($src, $dst) = @_;	1017	my ($src, $dst) = @_;
559		1018
560	@{$dst->registry} = @{$src->registry};	1019	@{$dst->registry} = @{$src->registry};
561		1020
562	%$dst = %$src;	1021	%$dst = %$src;
563		1022
564	%{$dst->{_attachment}} = %{$src->{_attachment}}	1023	%{$dst->{_attachment}} = %{$src->{_attachment}}
565	if exists $src->{_attachment};	1024	if exists $src->{_attachment};
566	},	1025	},
567	;	1026	);
		1027
		1028	sub object_freezer_save {
		1029	my ($filename, $rdata, $objs) = @_;
		1030
		1031	my $guard = cf::lock_acquire "io";
		1032
		1033	sync_job {
		1034	if (length $$rdata) {
		1035	utf8::decode (my $decname = $filename);
		1036	warn sprintf "saving %s (%d,%d)\n",
		1037	$decname, length $$rdata, scalar @$objs;
		1038
		1039	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		1040	chmod SAVE_MODE, $fh;
		1041	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		1042	aio_fsync $fh if $cf::USE_FSYNC;
		1043	close $fh;
		1044
		1045	if (@$objs) {
		1046	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		1047	chmod SAVE_MODE, $fh;
		1048	my $data = Storable::nfreeze { version => 1, objs => $objs };
		1049	aio_write $fh, 0, (length $data), $data, 0;
		1050	aio_fsync $fh if $cf::USE_FSYNC;
		1051	close $fh;
		1052	aio_rename "$filename.pst~", "$filename.pst";
		1053	}
		1054	} else {
		1055	aio_unlink "$filename.pst";
		1056	}
		1057
		1058	aio_rename "$filename~", $filename;
		1059	} else {
		1060	warn "FATAL: $filename~: $!\n";
		1061	}
		1062	} else {
		1063	aio_unlink $filename;
		1064	aio_unlink "$filename.pst";
		1065	}
		1066	};
		1067
		1068	undef $guard;
		1069	}
		1070
		1071	sub object_freezer_as_string {
		1072	my ($rdata, $objs) = @_;
		1073
		1074	use Data::Dumper;
		1075
		1076	$$rdata . Dumper $objs
		1077	}
		1078
		1079	sub object_thawer_load {
		1080	my ($filename) = @_;
		1081
		1082	my ($data, $av);
		1083
		1084	my $guard = cf::lock_acquire "io";
		1085
		1086	(aio_load $filename, $data) >= 0
		1087	or return;
		1088
		1089	unless (aio_stat "$filename.pst") {
		1090	(aio_load "$filename.pst", $av) >= 0
		1091	or return;
		1092
		1093	undef $guard;
		1094	$av = eval { (Storable::thaw $av)->{objs} };
		1095	}
		1096
		1097	utf8::decode (my $decname = $filename);
		1098	warn sprintf "loading %s (%d,%d)\n",
		1099	$decname, length $data, scalar @{$av || []};
		1100
		1101	($data, $av)
		1102	}
		1103
		1104	=head2 COMMAND CALLBACKS
		1105
		1106	=over 4
		1107
		1108	=cut
568		1109
569	#############################################################################	1110	#############################################################################
570	# old plug-in events	1111	# command handling &c
571		1112
572	sub inject_event {	1113	=item cf::register_command $name => \&callback($ob,$args);
573	my $extension = shift;
574	my $event_code = shift;
575		1114
576	my $cb = $hook[$event_code]{$extension}	1115	Register a callback for execution when the client sends the user command
577	or return;	1116	$name.
578		1117
579	&$cb	1118	=cut
580	}
581
582	sub inject_global_event {
583	my $event = shift;
584
585	my $cb = $hook[$event]
586	or return;
587
588	List::Util::max map &$_, values %$cb
589	}
590
591	sub inject_command {
592	my ($name, $obj, $params) = @_;
593
594	for my $cmd (@{ $command{$name} }) {
595	$cmd->[1]->($obj, $params);
596	}
597
598	-1
599	}
600		1119
601	sub register_command {	1120	sub register_command {
602	my ($name, $time, $cb) = @_;	1121	my ($name, $cb) = @_;
603		1122
604	my $caller = caller;	1123	my $caller = caller;
605	#warn "registering command '$name/$time' to '$caller'";	1124	#warn "registering command '$name/$time' to '$caller'";
606		1125
607	push @{ $command{$name} }, [$time, $cb, $caller];	1126	push @{ $COMMAND{$name} }, [$caller, $cb];
608	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
609	}	1127	}
		1128
		1129	=item cf::register_extcmd $name => \&callback($pl,$packet);
		1130
		1131	Register a callback for execution when the client sends an (synchronous)
		1132	extcmd packet. Ext commands will be processed in the order they are
		1133	received by the server, like other user commands. The first argument is
		1134	the logged-in player. Ext commands can only be processed after a player
		1135	has logged in successfully.
		1136
		1137	If the callback returns something, it is sent back as if reply was being
		1138	called.
		1139
		1140	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1141
		1142	Register a callback for execution when the client sends an (asynchronous)
		1143	exticmd packet. Exti commands are processed by the server as soon as they
		1144	are received, i.e. out of order w.r.t. other commands. The first argument
		1145	is a client socket. Exti commands can be received anytime, even before
		1146	log-in.
		1147
		1148	If the callback returns something, it is sent back as if reply was being
		1149	called.
		1150
		1151	=cut
610		1152
611	sub register_extcmd {	1153	sub register_extcmd {
612	my ($name, $cb) = @_;	1154	my ($name, $cb) = @_;
613		1155
614	my $caller = caller;	1156	$EXTCMD{$name} = $cb;
615	#warn "registering extcmd '$name' to '$caller'";
616
617	$extcmd{$name} = [$cb, $caller];
618	}	1157	}
619		1158
620	sub register {	1159	sub register_exticmd {
621	my ($base, $pkg) = @_;	1160	my ($name, $cb) = @_;
622		1161
623	#TODO	1162	$EXTICMD{$name} = $cb;
624	}	1163	}
625		1164
626	sub load_extension {	1165	cf::player->attach (
627	my ($path) = @_;	1166	on_command => sub {
		1167	my ($pl, $name, $params) = @_;
628		1168
629	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1169	my $cb = $COMMAND{$name}
630	my $base = $1;	1170	or return;
631	my $pkg = $1;
632	$pkg =~ s/[^[:word:]]/_/g;
633	$pkg = "ext::$pkg";
634		1171
635	warn "loading '$path' into '$pkg'\n";	1172	for my $cmd (@$cb) {
636		1173	$cmd->[1]->($pl->ob, $params);
637	open my $fh, "<:utf8", $path
638	or die "$path: $!";
639
640	my $source =
641	"package $pkg; use strict; use utf8;\n"
642	. "#line 1 \"$path\"\n{\n"
643	. (do { local $/; <$fh> })
644	. "\n};\n1";
645
646	eval $source
647	or die "$path: $@";
648
649	push @exts, $pkg;
650	$ext_pkg{$base} = $pkg;
651
652	# no strict 'refs';
653	# @{"$pkg\::ISA"} = ext::;
654
655	register $base, $pkg;
656	}
657
658	sub unload_extension {
659	my ($pkg) = @_;
660
661	warn "removing extension $pkg\n";
662
663	# remove hooks
664	#TODO
665	# for my $idx (0 .. $#PLUGIN_EVENT) {
666	# delete $hook[$idx]{$pkg};
667	# }
668
669	# remove commands
670	for my $name (keys %command) {
671	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
672
673	if (@cb) {
674	$command{$name} = \@cb;
675	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
676	} else {
677	delete $command{$name};
678	delete $COMMAND{"$name\000"};
679	}	1174	}
		1175
		1176	cf::override;
680	}	1177	},
681
682	# remove extcmds
683	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
684	delete $extcmd{$name};
685	}
686
687	if (my $cb = $pkg->can ("unload")) {
688	eval {
689	$cb->($pkg);
690	1
691	} or warn "$pkg unloaded, but with errors: $@";
692	}
693
694	Symbol::delete_package $pkg;
695	}
696
697	sub load_extensions {
698	my $LIBDIR = maps_directory "perl";
699
700	for my $ext (<$LIBDIR/*.ext>) {
701	next unless -r $ext;
702	eval {
703	load_extension $ext;
704	1
705	} or warn "$ext not loaded: $@";
706	}
707	}
708
709	#############################################################################
710	# extcmd framework, basically convert ext <msg>
711	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
712
713	attach_to_players
714	on_extcmd => sub {	1178	on_extcmd => sub {
715	my ($pl, $buf) = @_;	1179	my ($pl, $buf) = @_;
716		1180
717	my $msg = eval { from_json $buf };	1181	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
718		1182
719	if (ref $msg) {	1183	if (ref $msg) {
		1184	my ($type, $reply, @payload) =
		1185	"ARRAY" eq ref $msg
		1186	? @$msg
		1187	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1188
		1189	my @reply;
		1190
720	if (my $cb = $extcmd{$msg->{msgtype}}) {	1191	if (my $cb = $EXTCMD{$type}) {
721	if (my %reply = $cb->[0]->($pl, $msg)) {	1192	@reply = $cb->($pl, @payload);
722	$pl->ext_reply ($msg->{msgid}, %reply);	1193	}
		1194
		1195	$pl->ext_reply ($reply, @reply)
		1196	if $reply;
		1197
		1198	} else {
		1199	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		1200	}
		1201
		1202	cf::override;
		1203	},
		1204	);
		1205
		1206	sub load_extensions {
		1207	cf::sync_job {
		1208	my %todo;
		1209
		1210	for my $path (<$LIBDIR/*.ext>) {
		1211	next unless -r $path;
		1212
		1213	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1214	my $base = $1;
		1215	my $pkg = $1;
		1216	$pkg =~ s/[^[:word:]]/_/g;
		1217	$pkg = "ext::$pkg";
		1218
		1219	open my $fh, "<:utf8", $path
		1220	or die "$path: $!";
		1221
		1222	my $source = do { local $/; <$fh> };
		1223
		1224	my %ext = (
		1225	path => $path,
		1226	base => $base,
		1227	pkg => $pkg,
		1228	);
		1229
		1230	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1231	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1232
		1233	$ext{source} =
		1234	"package $pkg; use strict; use utf8;\n"
		1235	. "#line 1 \"$path\"\n{\n"
		1236	. $source
		1237	. "\n};\n1";
		1238
		1239	$todo{$base} = \%ext;
		1240	}
		1241
		1242	my %done;
		1243	while (%todo) {
		1244	my $progress;
		1245
		1246	while (my ($k, $v) = each %todo) {
		1247	for (split /,\s*/, $v->{meta}{depends}) {
		1248	goto skip
		1249	unless exists $done{$_};
		1250	}
		1251
		1252	warn "... loading '$k' into '$v->{pkg}'\n";
		1253
		1254	unless (eval $v->{source}) {
		1255	my $msg = $@ ? "$v->{path}: $@\n"
		1256	: "$v->{base}: extension inactive.\n";
		1257
		1258	if (exists $v->{meta}{mandatory}) {
		1259	warn $msg;
		1260	warn "mandatory extension failed to load, exiting.\n";
		1261	exit 1;
		1262	}
		1263
		1264	warn $msg;
		1265	}
		1266
		1267	$done{$k} = delete $todo{$k};
		1268	push @EXTS, $v->{pkg};
		1269	$progress = 1;
		1270	}
		1271
		1272	skip:
		1273	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1274	unless $progress;
		1275	}
		1276	};
		1277	}
		1278
		1279	#############################################################################
		1280
		1281	=back
		1282
		1283	=head2 CORE EXTENSIONS
		1284
		1285	Functions and methods that extend core crossfire objects.
		1286
		1287	=cut
		1288
		1289	package cf::player;
		1290
		1291	use Coro::AIO;
		1292
		1293	=head3 cf::player
		1294
		1295	=over 4
		1296
		1297	=item cf::player::num_playing
		1298
		1299	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1300
		1301	=cut
		1302
		1303	sub num_playing {
		1304	scalar grep
		1305	$_->ob->map
		1306	&& !$_->hidden
		1307	&& !$_->ob->flag (cf::FLAG_WIZ),
		1308	cf::player::list
		1309	}
		1310
		1311	=item cf::player::find $login
		1312
		1313	Returns the given player object, loading it if necessary (might block).
		1314
		1315	=cut
		1316
		1317	sub playerdir($) {
		1318	"$PLAYERDIR/"
		1319	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1320	}
		1321
		1322	sub path($) {
		1323	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1324
		1325	(playerdir $login) . "/playerdata"
		1326	}
		1327
		1328	sub find_active($) {
		1329	$cf::PLAYER{$_[0]}
		1330	and $cf::PLAYER{$_[0]}->active
		1331	and $cf::PLAYER{$_[0]}
		1332	}
		1333
		1334	sub exists($) {
		1335	my ($login) = @_;
		1336
		1337	$cf::PLAYER{$login}
		1338	or cf::sync_job { !aio_stat path $login }
		1339	}
		1340
		1341	sub find($) {
		1342	return $cf::PLAYER{$_[0]} || do {
		1343	my $login = $_[0];
		1344
		1345	my $guard = cf::lock_acquire "user_find:$login";
		1346
		1347	$cf::PLAYER{$_[0]} || do {
		1348	# rename old playerfiles to new ones
		1349	#TODO: remove when no longer required
		1350	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1351	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1352	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1353	aio_unlink +(playerdir $login) . "/$login.pl";
		1354
		1355	my $f = new_from_file cf::object::thawer path $login
		1356	or return;
		1357
		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;
723	}	1948	}
724	}	1949	}
725	} else {
726	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
727	}	1950	}
728		1951
729	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);
730	},	1975	}
731	;
732		1976
733	#############################################################################	1977	$self->post_load;
734	# load/save/clean perl data associated with a map	1978	}
735		1979
736	*cf::mapsupport::on_clean = sub {	1980	sub customise_for {
		1981	my ($self, $ob) = @_;
		1982
		1983	return find "~" . $ob->name . "/" . $self->{path}
		1984	if $self->per_player;
		1985
		1986	# return find "?party/" . $ob->name . "/" . $self->{path}
		1987	# if $self->per_party;
		1988
		1989	$self
		1990	}
		1991
		1992	# find and load all maps in the 3x3 area around a map
		1993	sub load_neighbours {
737	my ($map) = @_;	1994	my ($map) = @_;
738		1995
739	my $path = $map->tmpname;	1996	my @neigh; # diagonal neighbours
740	defined $path or return;
741		1997
742	unlink "$path.pst";	1998	for (0 .. 3) {
743	};	1999	my $neigh = $map->tile_path ($_)
		2000	or next;
		2001	$neigh = find $neigh, $map
		2002	or next;
		2003	$neigh->load;
744		2004
745	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	}
746		2009
747	#############################################################################	2010	for (grep defined $_->[0], @neigh) {
748	# load/save perl data associated with player->ob objects	2011	my ($path, $origin) = @$_;
749		2012	my $neigh = find $path, $origin
750	sub all_objects(@) {	2013	or next;
751	@_, map all_objects ($_->inv), @_	2014	$neigh->load;
		2015	}
752	}	2016	}
753		2017
754	# TODO: compatibility cruft, remove when no longer needed	2018	sub find_sync {
755	attach_to_players	2019	my ($path, $origin) = @_;
756	on_load => sub {
757	my ($pl, $path) = @_;
758		2020
759	for my $o (all_objects $pl->ob) {	2021	cf::sync_job { find $path, $origin }
760	if (my $value = $o->get_ob_key_value ("_perl_data")) {	2022	}
761	$o->set_ob_key_value ("_perl_data");
762		2023
763	%$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};
764	}	2055	}
765	}	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);
766	},	2091	}
767	;	2092	}
768		2093
769	#############################################################################	2094	sub swap_out {
		2095	my ($self) = @_;
770		2096
771	=head2 CORE EXTENSIONS	2097	# save first because save cedes
		2098	$self->save;
772		2099
773	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;
774		2247
775	=over 4	2248	=over 4
776		2249
777	=item cf::player::exists $login	2250	=item $ob->inv_recursive
778		2251
779	Returns true when the given account exists.	2252	Returns the inventory of the object _and_ their inventories, recursively.
780		2253
781	=cut	2254	=cut
782		2255
783	sub cf::player::exists($) {	2256	sub inv_recursive_;
784	cf::player::find $_[0]	2257	sub inv_recursive_ {
785	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	2258	map { $_, inv_recursive_ $_->inv } @_
786	}	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
787		2303
788	=item $player_object->reply ($npc, $msg[, $flags])	2304	=item $player_object->reply ($npc, $msg[, $flags])
789		2305
790	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>
791	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
…		…
793		2309
794	=cut	2310	=cut
795		2311
796	# rough implementation of a future "reply" method that works	2312	# rough implementation of a future "reply" method that works
797	# with dialog boxes.	2313	# with dialog boxes.
		2314	#TODO: the first argument must go, split into a $npc->reply_to ( method
798	sub cf::object::player::reply($$$;$) {	2315	sub cf::object::player::reply($$$;$) {
799	my ($self, $npc, $msg, $flags) = @_;	2316	my ($self, $npc, $msg, $flags) = @_;
800		2317
801	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2318	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
802		2319
803	if ($self->{record_replies}) {	2320	if ($self->{record_replies}) {
804	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2321	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2322
805	} 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 {
806	$msg = $npc->name . " says: $msg" if $npc;	2331	$msg = $npc->name . " says: $msg" if $npc;
807	$self->message ($msg, $flags);	2332	$self->message ($msg, $flags);
		2333	}
808	}	2334	}
809	}	2335	}
810		2336
811	=item $player->ext_reply ($msgid, $msgtype, %msg)	2337	=item $object->send_msg ($channel, $msg, $color, [extra...])
812		2338
813	Sends an ext reply to the player.
814
815	=cut	2339	=cut
816		2340
817	sub cf::player::ext_reply($$$%) {	2341	sub cf::object::send_msg {
818	my ($self, $id, %msg) = @_;	2342	my $pl = shift->contr
819		2343	or return;
820	$msg{msgid} = $id;	2344	$pl->send_msg (@_);
821
822	$self->send ("ext " . to_json \%msg);
823	}	2345	}
824		2346
825	=item $player_object->may ("access")	2347	=item $player_object->may ("access")
826		2348
827	Returns wether the given player is authorized to access resource "access"	2349	Returns wether the given player is authorized to access resource "access"
…		…
836	(ref $cf::CFG{"may_$access"}	2358	(ref $cf::CFG{"may_$access"}
837	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	2359	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
838	: $cf::CFG{"may_$access"})	2360	: $cf::CFG{"may_$access"})
839	}	2361	}
840		2362
841	=cut	2363	=item $player_object->enter_link
842		2364
843	#############################################################################	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	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2470	$ob = $obs[rand @obs];
		2471	} else {
		2472	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2473	}
		2474	# else put us there anyways for now #d#
		2475
		2476	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2477	} else {
		2478	($path, $x, $y) = (undef, undef, undef);
		2479	}
		2480	}
		2481
		2482	my $map = eval {
		2483	my $map = defined $path ? cf::map::find $path : undef;
		2484
		2485	if ($map) {
		2486	$map = $map->customise_for ($self);
		2487	$map = $check->($map) if $check && $map;
		2488	} else {
		2489	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2490	}
		2491
		2492	$map
		2493	};
		2494
		2495	if ($@) {
		2496	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2497	LOG llevError | logBacktrace, Carp::longmess $@;
		2498	}
		2499
		2500	if ($gen == $self->{_goto_generation}) {
		2501	delete $self->{_goto_generation};
		2502	$self->leave_link ($map, $x, $y);
		2503	}
		2504
		2505	$done->() if $done;
		2506	})->prio (1);
		2507	}
		2508
		2509	=item $player_object->enter_exit ($exit_object)
		2510
		2511	=cut
		2512
		2513	sub parse_random_map_params {
		2514	my ($spec) = @_;
		2515
		2516	my $rmp = { # defaults
		2517	xsize => (cf::rndm 15, 40),
		2518	ysize => (cf::rndm 15, 40),
		2519	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2520	#layout => string,
		2521	};
		2522
		2523	for (split /\n/, $spec) {
		2524	my ($k, $v) = split /\s+/, $_, 2;
		2525
		2526	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2527	}
		2528
		2529	$rmp
		2530	}
		2531
		2532	sub prepare_random_map {
		2533	my ($exit) = @_;
		2534
		2535	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2536
		2537	# all this does is basically replace the /! path by
		2538	# a new random map path (?random/...) with a seed
		2539	# that depends on the exit object
		2540
		2541	my $rmp = parse_random_map_params $exit->msg;
		2542
		2543	if ($exit->map) {
		2544	$rmp->{region} = $exit->region->name;
		2545	$rmp->{origin_map} = $exit->map->path;
		2546	$rmp->{origin_x} = $exit->x;
		2547	$rmp->{origin_y} = $exit->y;
		2548	}
		2549
		2550	$rmp->{random_seed} ||= $exit->random_seed;
		2551
		2552	my $data = cf::to_json $rmp;
		2553	my $md5 = Digest::MD5::md5_hex $data;
		2554	my $meta = "$RANDOMDIR/$md5.meta";
		2555
		2556	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2557	aio_write $fh, 0, (length $data), $data, 0;
		2558	undef $fh;
		2559	aio_rename "$meta~", $meta;
		2560
		2561	$exit->slaying ("?random/$md5");
		2562	$exit->msg (undef);
		2563	}
		2564	}
		2565
		2566	sub cf::object::player::enter_exit {
		2567	my ($self, $exit) = @_;
		2568
		2569	return unless $self->type == cf::PLAYER;
		2570
		2571	if ($exit->slaying eq "/!") {
		2572	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2573	# the problem is that $exit might not survive long enough
		2574	# so it needs to be done right now, right here
		2575	cf::sync_job { prepare_random_map $exit };
		2576	}
		2577
		2578	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2579	my $hp = $exit->stats->hp;
		2580	my $sp = $exit->stats->sp;
		2581
		2582	$self->enter_link;
		2583
		2584	# if exit is damned, update players death & WoR home-position
		2585	$self->contr->savebed ($slaying, $hp, $sp)
		2586	if $exit->flag (FLAG_DAMNED);
		2587
		2588	(async {
		2589	$self->deactivate_recursive; # just to be sure
		2590	unless (eval {
		2591	$self->goto ($slaying, $hp, $sp);
		2592
		2593	1;
		2594	}) {
		2595	$self->message ("Something went wrong deep within the crossfire server. "
		2596	. "I'll try to bring you back to the map you were before. "
		2597	. "Please report this to the dungeon master!",
		2598	cf::NDI_UNIQUE | cf::NDI_RED);
		2599
		2600	warn "ERROR in enter_exit: $@";
		2601	$self->leave_link;
		2602	}
		2603	})->prio (1);
		2604	}
		2605
		2606	=head3 cf::client
		2607
		2608	=over 4
		2609
		2610	=item $client->send_drawinfo ($text, $flags)
		2611
		2612	Sends a drawinfo packet to the client. Circumvents output buffering so
		2613	should not be used under normal circumstances.
		2614
		2615	=cut
		2616
		2617	sub cf::client::send_drawinfo {
		2618	my ($self, $text, $flags) = @_;
		2619
		2620	utf8::encode $text;
		2621	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2622	}
		2623
		2624	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2625
		2626	Send a drawinfo or msg packet to the client, formatting the msg for the
		2627	client if neccessary. C<$type> should be a string identifying the type of
		2628	the message, with C<log> being the default. If C<$color> is negative, suppress
		2629	the message unless the client supports the msg packet.
		2630
		2631	=cut
		2632
		2633	our %CHANNEL = (
		2634	"c/identify" => {
		2635	id => "identify",
		2636	title => "Identify",
		2637	reply => undef,
		2638	tooltip => "Items recently identified",
		2639	},
		2640	"c/examine" => {
		2641	id => "examine",
		2642	title => "Examine",
		2643	reply => undef,
		2644	tooltip => "Signs and other items you examined",
		2645	},
		2646	);
		2647
		2648	sub cf::client::send_msg {
		2649	my ($self, $channel, $msg, $color, @extra) = @_;
		2650
		2651	$msg = $self->pl->expand_cfpod ($msg);
		2652
		2653	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2654
		2655	# check predefined channels, for the benefit of C
		2656	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2657
		2658	if (ref $channel) {
		2659	# send meta info to client, if not yet sent
		2660	unless (exists $self->{channel}{$channel->{id}}) {
		2661	$self->{channel}{$channel->{id}} = $channel;
		2662	$self->ext_msg (channel_info => $channel)
		2663	if $self->can_msg;
		2664	}
		2665
		2666	$channel = $channel->{id};
		2667	}
		2668
		2669	return unless @extra || length $msg;
		2670
		2671	if ($self->can_msg) {
		2672	# default colour, mask it out
		2673	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2674	if $color & cf::NDI_DEF;
		2675
		2676	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2677	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2678	} else {
		2679	if ($color >= 0) {
		2680	# replace some tags by gcfclient-compatible ones
		2681	for ($msg) {
		2682	1 while
		2683	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2684	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2685	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2686	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2687	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2688	}
		2689
		2690	$color &= cf::NDI_COLOR_MASK;
		2691
		2692	utf8::encode $msg;
		2693
		2694	if (0 && $msg =~ /\[/) {
		2695	# COMMAND/INFO
		2696	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2697	} else {
		2698	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2699	$self->send_packet ("drawinfo $color $msg")
		2700	}
		2701	}
		2702	}
		2703	}
		2704
		2705	=item $client->ext_msg ($type, @msg)
		2706
		2707	Sends an ext event to the client.
		2708
		2709	=cut
		2710
		2711	sub cf::client::ext_msg($$@) {
		2712	my ($self, $type, @msg) = @_;
		2713
		2714	if ($self->extcmd == 2) {
		2715	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2716	} elsif ($self->extcmd == 1) { # TODO: remove
		2717	push @msg, msgtype => "event_$type";
		2718	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2719	}
		2720	}
		2721
		2722	=item $client->ext_reply ($msgid, @msg)
		2723
		2724	Sends an ext reply to the client.
		2725
		2726	=cut
		2727
		2728	sub cf::client::ext_reply($$@) {
		2729	my ($self, $id, @msg) = @_;
		2730
		2731	if ($self->extcmd == 2) {
		2732	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2733	} elsif ($self->extcmd == 1) {
		2734	#TODO: version 1, remove
		2735	unshift @msg, msgtype => "reply", msgid => $id;
		2736	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2737	}
		2738	}
		2739
		2740	=item $success = $client->query ($flags, "text", \&cb)
		2741
		2742	Queues a query to the client, calling the given callback with
		2743	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2744	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2745
		2746	Queries can fail, so check the return code. Or don't, as queries will
		2747	become reliable at some point in the future.
		2748
		2749	=cut
		2750
		2751	sub cf::client::query {
		2752	my ($self, $flags, $text, $cb) = @_;
		2753
		2754	return unless $self->state == ST_PLAYING
		2755	|| $self->state == ST_SETUP
		2756	|| $self->state == ST_CUSTOM;
		2757
		2758	$self->state (ST_CUSTOM);
		2759
		2760	utf8::encode $text;
		2761	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2762
		2763	$self->send_packet ($self->{query_queue}[0][0])
		2764	if @{ $self->{query_queue} } == 1;
		2765
		2766	1
		2767	}
		2768
		2769	cf::client->attach (
		2770	on_connect => sub {
		2771	my ($ns) = @_;
		2772
		2773	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2774	},
		2775	on_reply => sub {
		2776	my ($ns, $msg) = @_;
		2777
		2778	# this weird shuffling is so that direct followup queries
		2779	# get handled first
		2780	my $queue = delete $ns->{query_queue}
		2781	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2782
		2783	(shift @$queue)->[1]->($msg);
		2784	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2785
		2786	push @{ $ns->{query_queue} }, @$queue;
		2787
		2788	if (@{ $ns->{query_queue} } == @$queue) {
		2789	if (@$queue) {
		2790	$ns->send_packet ($ns->{query_queue}[0][0]);
		2791	} else {
		2792	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2793	}
		2794	}
		2795	},
		2796	on_exticmd => sub {
		2797	my ($ns, $buf) = @_;
		2798
		2799	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2800
		2801	if (ref $msg) {
		2802	my ($type, $reply, @payload) =
		2803	"ARRAY" eq ref $msg
		2804	? @$msg
		2805	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2806
		2807	my @reply;
		2808
		2809	if (my $cb = $EXTICMD{$type}) {
		2810	@reply = $cb->($ns, @payload);
		2811	}
		2812
		2813	$ns->ext_reply ($reply, @reply)
		2814	if $reply;
		2815
		2816	} else {
		2817	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2818	}
		2819
		2820	cf::override;
		2821	},
		2822	);
		2823
		2824	=item $client->async (\&cb)
		2825
		2826	Create a new coroutine, running the specified callback. The coroutine will
		2827	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2828	or loss of connection).
		2829
		2830	=cut
		2831
		2832	sub cf::client::async {
		2833	my ($self, $cb) = @_;
		2834
		2835	my $coro = &Coro::async ($cb);
		2836
		2837	$coro->on_destroy (sub {
		2838	delete $self->{_coro}{$coro+0};
		2839	});
		2840
		2841	$self->{_coro}{$coro+0} = $coro;
		2842
		2843	$coro
		2844	}
		2845
		2846	cf::client->attach (
		2847	on_destroy => sub {
		2848	my ($ns) = @_;
		2849
		2850	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2851	},
		2852	);
		2853
		2854	=back
		2855
844		2856
845	=head2 SAFE SCRIPTING	2857	=head2 SAFE SCRIPTING
846		2858
847	Functions that provide a safe environment to compile and execute	2859	Functions that provide a safe environment to compile and execute
848	snippets of perl code without them endangering the safety of the server	2860	snippets of perl code without them endangering the safety of the server
…		…
855	our $safe = new Safe "safe";	2867	our $safe = new Safe "safe";
856	our $safe_hole = new Safe::Hole;	2868	our $safe_hole = new Safe::Hole;
857		2869
858	$SIG{FPE} = 'IGNORE';	2870	$SIG{FPE} = 'IGNORE';
859		2871
860	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2872	$safe->permit_only (Opcode::opset qw(
		2873	:base_core :base_mem :base_orig :base_math
		2874	grepstart grepwhile mapstart mapwhile
		2875	sort time
		2876	));
861		2877
862	# here we export the classes and methods available to script code	2878	# here we export the classes and methods available to script code
863		2879
864	=pod	2880	=pod
865		2881
866	The following fucntions and emthods are available within a safe environment:	2882	The following functions and methods are available within a safe environment:
867		2883
868	cf::object contr pay_amount pay_player	2884	cf::object
		2885	contr pay_amount pay_player map x y force_find force_add
		2886	insert remove name archname title slaying race decrease_ob_nr
		2887
869	cf::object::player player	2888	cf::object::player
870	cf::player peaceful	2889	player
		2890
		2891	cf::player
		2892	peaceful
		2893
		2894	cf::map
		2895	trigger
871		2896
872	=cut	2897	=cut
873		2898
874	for (	2899	for (
875	["cf::object" => qw(contr pay_amount pay_player)],	2900	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2901	insert remove inv name archname title slaying race
		2902	decrease_ob_nr)],
876	["cf::object::player" => qw(player)],	2903	["cf::object::player" => qw(player)],
877	["cf::player" => qw(peaceful)],	2904	["cf::player" => qw(peaceful)],
		2905	["cf::map" => qw(trigger)],
878	) {	2906	) {
879	no strict 'refs';	2907	no strict 'refs';
880	my ($pkg, @funs) = @$_;	2908	my ($pkg, @funs) = @$_;
881	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2909	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
882	for @funs;	2910	for @funs;
…		…
950	=back	2978	=back
951		2979
952	=cut	2980	=cut
953		2981
954	#############################################################################	2982	#############################################################################
		2983	# the server's init and main functions
955		2984
956	=head2 EXTENSION DATABASE SUPPORT	2985	sub load_facedata($) {
		2986	my ($path) = @_;
957		2987
958	Crossfire maintains a very simple database for extension use. It can	2988	# HACK to clear player env face cache, we need some signal framework
959	currently store anything that can be serialised using Storable, which	2989	# for this (global event?)
960	excludes objects.	2990	%ext::player_env::MUSIC_FACE_CACHE = ();
961		2991
962	The parameter C<$family> should best start with the name of the extension	2992	my $enc = JSON::XS->new->utf8->canonical->relaxed;
963	using it, it should be unique.
964		2993
965	=over 4	2994	warn "loading facedata from $path\n";
966		2995
967	=item $hashref = cf::db_get $family	2996	my $facedata;
		2997	0 < aio_load $path, $facedata
		2998	or die "$path: $!";
968		2999
969	Return a hashref for use by the extension C<$family>, which can be	3000	$facedata = Coro::Storable::thaw $facedata;
970	modified. After modifications, you have to call C<cf::db_dirty> or
971	C<cf::db_sync>.
972		3001
973	=item $value = cf::db_get $family => $key	3002	$facedata->{version} == 2
		3003	or cf::cleanup "$path: version mismatch, cannot proceed.";
974		3004
975	Returns a single value from the database	3005	# patch in the exptable
976		3006	$facedata->{resource}{"res/exp_table"} = {
977	=item cf::db_put $family => $hashref	3007	type => FT_RSRC,
978		3008	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
979	Stores the given family hashref into the database. Updates are delayed, if
980	you want the data to be synced to disk immediately, use C<cf::db_sync>.
981
982	=item cf::db_put $family => $key => $value
983
984	Stores the given C<$value> in the family hash. Updates are delayed, if you
985	want the data to be synced to disk immediately, use C<cf::db_sync>.
986
987	=item cf::db_dirty
988
989	Marks the database as dirty, to be updated at a later time.
990
991	=item cf::db_sync
992
993	Immediately write the database to disk I<if it is dirty>.
994
995	=cut
996
997	our $DB;
998
999	{
1000	my $path = cf::localdir . "/database.pst";
1001
1002	sub db_load() {
1003	warn "loading database $path\n";#d# remove later
1004	$DB = stat $path ? Storable::retrieve $path : { };
1005	}
1006
1007	my $pid;
1008
1009	sub db_save() {
1010	warn "saving database $path\n";#d# remove later
1011	waitpid $pid, 0 if $pid;
1012	if (0 == ($pid = fork)) {
1013	$DB->{_meta}{version} = 1;
1014	Storable::nstore $DB, "$path~";
1015	rename "$path~", $path;
1016	cf::_exit 0 if defined $pid;
1017	}
1018	}
1019
1020	my $dirty;
1021
1022	sub db_sync() {
1023	db_save if $dirty;
1024	undef $dirty;
1025	}
1026
1027	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
1028	db_sync;
1029	});	3009	};
		3010	cf::cede_to_tick;
1030		3011
1031	sub db_dirty() {
1032	$dirty = 1;
1033	$idle->start;
1034	}	3012	{
		3013	my $faces = $facedata->{faceinfo};
1035		3014
1036	sub db_get($;$) {	3015	while (my ($face, $info) = each %$faces) {
1037	@_ >= 2	3016	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1038	? $DB->{$_[0]}{$_[1]}	3017	cf::face::set_visibility $idx, $info->{visibility};
1039	: ($DB->{$_[0]} ||= { })	3018	cf::face::set_magicmap $idx, $info->{magicmap};
1040	}	3019	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		3020	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1041		3021
1042	sub db_put($$;$) {	3022	cf::cede_to_tick;
1043	if (@_ >= 3) {
1044	$DB->{$_[0]}{$_[1]} = $_[2];
1045	} else {
1046	$DB->{$_[0]} = $_[1];
1047	}
1048	db_dirty;
1049	}
1050
1051	attach_global
1052	prio => 10000,
1053	on_cleanup => sub {
1054	db_sync;
1055	},	3023	}
		3024
		3025	while (my ($face, $info) = each %$faces) {
		3026	next unless $info->{smooth};
		3027	my $idx = cf::face::find $face
		3028	or next;
		3029	if (my $smooth = cf::face::find $info->{smooth}) {
		3030	cf::face::set_smooth $idx, $smooth;
		3031	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3032	} else {
		3033	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3034	}
		3035
		3036	cf::cede_to_tick;
		3037	}
1056	;	3038	}
1057	}
1058		3039
1059	#############################################################################	3040	{
1060	# the server's main()	3041	my $anims = $facedata->{animinfo};
1061		3042
1062	sub cfg_load {	3043	while (my ($anim, $info) = each %$anims) {
		3044	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3045	cf::cede_to_tick;
		3046	}
		3047
		3048	cf::anim::invalidate_all; # d'oh
		3049	}
		3050
		3051	{
		3052	# TODO: for gcfclient pleasure, we should give resources
		3053	# that gcfclient doesn't grok a >10000 face index.
		3054	my $res = $facedata->{resource};
		3055
		3056	my $soundconf = delete $res->{"res/sound.conf"};
		3057
		3058	while (my ($name, $info) = each %$res) {
		3059	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3060	my $data;
		3061
		3062	if ($info->{type} & 1) {
		3063	# prepend meta info
		3064
		3065	my $meta = $enc->encode ({
		3066	name => $name,
		3067	%{ $info->{meta} || {} },
		3068	});
		3069
		3070	$data = pack "(w/a*)*", $meta, $info->{data};
		3071	} else {
		3072	$data = $info->{data};
		3073	}
		3074
		3075	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3076	cf::face::set_type $idx, $info->{type};
		3077
		3078	cf::cede_to_tick;
		3079	}
		3080
		3081	if ($soundconf) {
		3082	$soundconf = $enc->decode (delete $soundconf->{data});
		3083
		3084	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3085	my $sound = $soundconf->{compat}[$_]
		3086	or next;
		3087
		3088	my $face = cf::face::find "sound/$sound->[1]";
		3089	cf::sound::set $sound->[0] => $face;
		3090	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3091	}
		3092
		3093	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3094	my $face = cf::face::find "sound/$v";
		3095	cf::sound::set $k => $face;
		3096	}
		3097	}
		3098	}
		3099
		3100	1
		3101	}
		3102
		3103	register_exticmd fx_want => sub {
		3104	my ($ns, $want) = @_;
		3105
		3106	while (my ($k, $v) = each %$want) {
		3107	$ns->fx_want ($k, $v);
		3108	}
		3109	};
		3110
		3111	sub reload_regions {
		3112	# HACK to clear player env face cache, we need some signal framework
		3113	# for this (global event?)
		3114	%ext::player_env::MUSIC_FACE_CACHE = ();
		3115
		3116	load_resource_file "$MAPDIR/regions"
		3117	or die "unable to load regions file\n";
		3118
		3119	for (cf::region::list) {
		3120	$_->{match} = qr/$_->{match}/
		3121	if exists $_->{match};
		3122	}
		3123	}
		3124
		3125	sub reload_facedata {
		3126	load_facedata "$DATADIR/facedata"
		3127	or die "unable to load facedata\n";
		3128	}
		3129
		3130	sub reload_archetypes {
		3131	load_resource_file "$DATADIR/archetypes"
		3132	or die "unable to load archetypes\n";
		3133	#d# NEED to laod twice to resolve forward references
		3134	# this really needs to be done in an extra post-pass
		3135	# (which needs to be synchronous, so solve it differently)
		3136	load_resource_file "$DATADIR/archetypes"
		3137	or die "unable to load archetypes\n";
		3138	}
		3139
		3140	sub reload_treasures {
		3141	load_resource_file "$DATADIR/treasures"
		3142	or die "unable to load treasurelists\n";
		3143	}
		3144
		3145	sub reload_resources {
		3146	warn "reloading resource files...\n";
		3147
		3148	reload_regions;
		3149	reload_facedata;
		3150	#reload_archetypes;#d#
		3151	reload_archetypes;
		3152	reload_treasures;
		3153
		3154	warn "finished reloading resource files\n";
		3155	}
		3156
		3157	sub init {
		3158	reload_resources;
		3159	}
		3160
		3161	sub reload_config {
1063	open my $fh, "<:utf8", cf::confdir . "/config"	3162	open my $fh, "<:utf8", "$CONFDIR/config"
1064	or return;	3163	or return;
1065		3164
1066	local $/;	3165	local $/;
1067	*CFG = YAML::Syck::Load <$fh>;	3166	*CFG = YAML::Syck::Load <$fh>;
		3167
		3168	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		3169
		3170	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3171	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3172
		3173	if (exists $CFG{mlockall}) {
		3174	eval {
		3175	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		3176	and die "WARNING: m(un)lockall failed: $!\n";
		3177	};
		3178	warn $@ if $@;
		3179	}
1068	}	3180	}
1069		3181
1070	sub main {	3182	sub main {
1071	cfg_load;	3183	# we must not ever block the main coroutine
1072	db_load;	3184	local $Coro::idle = sub {
		3185	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		3186	(async {
		3187	Event::one_event;
		3188	})->prio (Coro::PRIO_MAX);
		3189	};
		3190
		3191	reload_config;
		3192	db_init;
1073	load_extensions;	3193	load_extensions;
		3194
		3195	$TICK_WATCHER->start;
1074	Event::loop;	3196	Event::loop;
1075	}	3197	}
1076		3198
1077	#############################################################################	3199	#############################################################################
1078	# initialisation	3200	# initialisation and cleanup
1079		3201
1080	sub _perl_reload(&) {	3202	# install some emergency cleanup handlers
		3203	BEGIN {
		3204	for my $signal (qw(INT HUP TERM)) {
		3205	Event->signal (
		3206	reentrant => 0,
		3207	data => WF_AUTOCANCEL,
		3208	signal => $signal,
		3209	prio => 0,
		3210	cb => sub {
		3211	cf::cleanup "SIG$signal";
		3212	},
		3213	);
		3214	}
		3215	}
		3216
		3217	sub write_runtime {
		3218	my $runtime = "$LOCALDIR/runtime";
		3219
		3220	# first touch the runtime file to show we are still running:
		3221	# the fsync below can take a very very long time.
		3222
		3223	IO::AIO::aio_utime $runtime, undef, undef;
		3224
		3225	my $guard = cf::lock_acquire "write_runtime";
		3226
		3227	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3228	or return;
		3229
		3230	my $value = $cf::RUNTIME + 90 + 10;
		3231	# 10 is the runtime save interval, for a monotonic clock
		3232	# 60 allows for the watchdog to kill the server.
		3233
		3234	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3235	and return;
		3236
		3237	# always fsync - this file is important
		3238	aio_fsync $fh
		3239	and return;
		3240
		3241	# touch it again to show we are up-to-date
		3242	aio_utime $fh, undef, undef;
		3243
		3244	close $fh
		3245	or return;
		3246
		3247	aio_rename "$runtime~", $runtime
		3248	and return;
		3249
		3250	warn "runtime file written.\n";
		3251
		3252	1
		3253	}
		3254
		3255	sub emergency_save() {
		3256	my $freeze_guard = cf::freeze_mainloop;
		3257
		3258	warn "enter emergency perl save\n";
		3259
		3260	cf::sync_job {
		3261	# use a peculiar iteration method to avoid tripping on perl
		3262	# refcount bugs in for. also avoids problems with players
		3263	# and maps saved/destroyed asynchronously.
		3264	warn "begin emergency player save\n";
		3265	for my $login (keys %cf::PLAYER) {
		3266	my $pl = $cf::PLAYER{$login} or next;
		3267	$pl->valid or next;
		3268	$pl->save;
		3269	}
		3270	warn "end emergency player save\n";
		3271
		3272	warn "begin emergency map save\n";
		3273	for my $path (keys %cf::MAP) {
		3274	my $map = $cf::MAP{$path} or next;
		3275	$map->valid or next;
		3276	$map->save;
		3277	}
		3278	warn "end emergency map save\n";
		3279
		3280	warn "begin emergency database checkpoint\n";
		3281	BDB::db_env_txn_checkpoint $DB_ENV;
		3282	warn "end emergency database checkpoint\n";
		3283	};
		3284
		3285	warn "leave emergency perl save\n";
		3286	}
		3287
		3288	sub post_cleanup {
1081	my ($msg) = @_;	3289	my ($make_core) = @_;
1082		3290
1083	$msg->("reloading...");	3291	warn Carp::longmess "post_cleanup backtrace"
		3292	if $make_core;
		3293	}
1084		3294
1085	eval {	3295	sub do_reload_perl() {
1086	# cancel all watchers	3296	# can/must only be called in main
		3297	if ($Coro::current != $Coro::main) {
		3298	warn "can only reload from main coroutine";
		3299	return;
		3300	}
		3301
		3302	warn "reloading...";
		3303
		3304	warn "entering sync_job";
		3305
		3306	cf::sync_job {
		3307	cf::write_runtime; # external watchdog should not bark
		3308	cf::emergency_save;
		3309	cf::write_runtime; # external watchdog should not bark
		3310
		3311	warn "syncing database to disk";
		3312	BDB::db_env_txn_checkpoint $DB_ENV;
		3313
		3314	# if anything goes wrong in here, we should simply crash as we already saved
		3315
		3316	warn "cancelling all WF_AUTOCANCEL watchers";
1087	$_->cancel for Event::all_watchers;	3317	for (Event::all_watchers) {
		3318	$_->cancel if $_->data & WF_AUTOCANCEL;
		3319	}
1088		3320
1089	# unload all extensions	3321	warn "flushing outstanding aio requests";
1090	for (@exts) {	3322	for (;;) {
1091	$msg->("unloading <$_>");	3323	BDB::flush;
1092	unload_extension $_;	3324	IO::AIO::flush;
		3325	Coro::cede;
		3326	last unless IO::AIO::nreqs || BDB::nreqs;
		3327	warn "iterate...";
		3328	}
		3329
		3330	++$RELOAD;
		3331
		3332	warn "cancelling all extension coros";
		3333	$_->cancel for values %EXT_CORO;
		3334	%EXT_CORO = ();
		3335
		3336	warn "removing commands";
		3337	%COMMAND = ();
		3338
		3339	warn "removing ext/exti commands";
		3340	%EXTCMD = ();
		3341	%EXTICMD = ();
		3342
		3343	warn "unloading/nuking all extensions";
		3344	for my $pkg (@EXTS) {
		3345	warn "... unloading $pkg";
		3346
		3347	if (my $cb = $pkg->can ("unload")) {
		3348	eval {
		3349	$cb->($pkg);
		3350	1
		3351	} or warn "$pkg unloaded, but with errors: $@";
1093	}	3352	}
1094		3353
		3354	warn "... nuking $pkg";
		3355	Symbol::delete_package $pkg;
		3356	}
		3357
1095	# unload all modules loaded from $LIBDIR	3358	warn "unloading all perl modules loaded from $LIBDIR";
1096	while (my ($k, $v) = each %INC) {	3359	while (my ($k, $v) = each %INC) {
1097	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3360	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1098		3361
1099	$msg->("removing <$k>");	3362	warn "... unloading $k";
1100	delete $INC{$k};	3363	delete $INC{$k};
1101		3364
1102	$k =~ s/\.pm$//;	3365	$k =~ s/\.pm$//;
1103	$k =~ s/\//::/g;	3366	$k =~ s/\//::/g;
1104		3367
…		…
1107	}	3370	}
1108		3371
1109	Symbol::delete_package $k;	3372	Symbol::delete_package $k;
1110	}	3373	}
1111		3374
1112	# sync database to disk
1113	cf::db_sync;
1114
1115	# get rid of safe::, as good as possible	3375	warn "getting rid of safe::, as good as possible";
1116	Symbol::delete_package "safe::$_"	3376	Symbol::delete_package "safe::$_"
1117	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	3377	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1118		3378
1119	# remove register_script_function callbacks
1120	# TODO
1121
1122	# unload cf.pm "a bit"	3379	warn "unloading cf.pm \"a bit\"";
1123	delete $INC{"cf.pm"};	3380	delete $INC{"cf.pm"};
		3381	delete $INC{"cf/pod.pm"};
1124		3382
1125	# don't, removes xs symbols, too,	3383	# don't, removes xs symbols, too,
1126	# and global variables created in xs	3384	# and global variables created in xs
1127	#Symbol::delete_package __PACKAGE__;	3385	#Symbol::delete_package __PACKAGE__;
1128		3386
1129	# reload cf.pm	3387	warn "unload completed, starting to reload now";
		3388
1130	$msg->("reloading cf.pm");	3389	warn "reloading cf.pm";
1131	require cf;	3390	require cf;
		3391	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1132		3392
1133	# load config and database again	3393	warn "loading config and database again";
1134	cf::cfg_load;	3394	cf::reload_config;
1135	cf::db_load;
1136		3395
1137	# load extensions	3396	warn "loading extensions";
1138	$msg->("load extensions");
1139	cf::load_extensions;	3397	cf::load_extensions;
1140		3398
1141	# reattach attachments to objects	3399	warn "reattaching attachments to objects/players";
1142	$msg->("reattach");	3400	_global_reattach; # objects, sockets
1143	_global_reattach;	3401	warn "reattaching attachments to maps";
		3402	reattach $_ for values %MAP;
		3403	warn "reattaching attachments to players";
		3404	reattach $_ for values %PLAYER;
		3405
		3406	warn "leaving sync_job";
		3407
		3408	1
		3409	} or do {
		3410	warn $@;
		3411	warn "error while reloading, exiting.";
		3412	exit 1;
1144	};	3413	};
1145	$msg->($@) if $@;
1146		3414
1147	$msg->("reloaded");	3415	warn "reloaded";
1148	};	3416	};
1149		3417
1150	sub perl_reload() {	3418	our $RELOAD_WATCHER; # used only during reload
1151	_perl_reload {	3419
1152	warn $_[0];	3420	sub reload_perl() {
1153	print "$_[0]\n";	3421	# doing reload synchronously and two reloads happen back-to-back,
		3422	# coro crashes during coro_state_free->destroy here.
		3423
		3424	$RELOAD_WATCHER ||= Event->timer (
		3425	reentrant => 0,
		3426	after => 0,
		3427	data => WF_AUTOCANCEL,
		3428	cb => sub {
		3429	do_reload_perl;
		3430	undef $RELOAD_WATCHER;
		3431	},
1154	};	3432	);
1155	}	3433	}
1156		3434
1157	register_command "perl-reload", 0, sub {	3435	register_command "reload" => sub {
1158	my ($who, $arg) = @_;	3436	my ($who, $arg) = @_;
1159		3437
1160	if ($who->flag (FLAG_WIZ)) {	3438	if ($who->flag (FLAG_WIZ)) {
1161	_perl_reload {	3439	$who->message ("reloading server.");
1162	warn $_[0];	3440	async { reload_perl };
1163	$who->message ($_[0]);
1164	};
1165	}	3441	}
1166	};	3442	};
1167		3443
1168	register "<global>", __PACKAGE__;
1169
1170	unshift @INC, $LIBDIR;	3444	unshift @INC, $LIBDIR;
1171		3445
		3446	my $bug_warning = 0;
		3447
		3448	our @WAIT_FOR_TICK;
		3449	our @WAIT_FOR_TICK_BEGIN;
		3450
		3451	sub wait_for_tick {
		3452	return unless $TICK_WATCHER->is_active;
		3453	return if $Coro::current == $Coro::main;
		3454
		3455	my $signal = new Coro::Signal;
		3456	push @WAIT_FOR_TICK, $signal;
		3457	$signal->wait;
		3458	}
		3459
		3460	sub wait_for_tick_begin {
		3461	return unless $TICK_WATCHER->is_active;
		3462	return if $Coro::current == $Coro::main;
		3463
		3464	my $signal = new Coro::Signal;
		3465	push @WAIT_FOR_TICK_BEGIN, $signal;
		3466	$signal->wait;
		3467	}
		3468
1172	$TICK_WATCHER = Event->timer (	3469	$TICK_WATCHER = Event->timer (
		3470	reentrant => 0,
		3471	parked => 1,
1173	prio => 1,	3472	prio => 0,
1174	async => 1,
1175	at => $NEXT_TICK || 1,	3473	at => $NEXT_TICK || $TICK,
		3474	data => WF_AUTOCANCEL,
1176	cb => sub {	3475	cb => sub {
		3476	if ($Coro::current != $Coro::main) {
		3477	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3478	unless ++$bug_warning > 10;
		3479	return;
		3480	}
		3481
		3482	$NOW = $tick_start = Event::time;
		3483
1177	cf::server_tick; # one server iteration	3484	cf::server_tick; # one server iteration
1178		3485
1179	my $NOW = Event::time;	3486	$RUNTIME += $TICK;
1180	$NEXT_TICK += $TICK;	3487	$NEXT_TICK += $TICK;
		3488
		3489	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3490	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3491	Coro::async_pool {
		3492	write_runtime
		3493	or warn "ERROR: unable to write runtime file: $!";
		3494	};
		3495	}
		3496
		3497	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3498	$sig->send;
		3499	}
		3500	while (my $sig = shift @WAIT_FOR_TICK) {
		3501	$sig->send;
		3502	}
		3503
		3504	$NOW = Event::time;
1181		3505
1182	# if we are delayed by four ticks or more, skip them all	3506	# if we are delayed by four ticks or more, skip them all
1183	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	3507	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1184		3508
1185	$TICK_WATCHER->at ($NEXT_TICK);	3509	$TICK_WATCHER->at ($NEXT_TICK);
1186	$TICK_WATCHER->start;	3510	$TICK_WATCHER->start;
		3511
		3512	$LOAD = ($NOW - $tick_start) / $TICK;
		3513	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3514
		3515	_post_tick;
1187	},	3516	},
1188	);	3517	);
1189		3518
		3519	{
		3520	BDB::min_parallel 8;
		3521	BDB::max_poll_time $TICK * 0.1;
		3522	$BDB_POLL_WATCHER = Event->io (
		3523	reentrant => 0,
		3524	fd => BDB::poll_fileno,
		3525	poll => 'r',
		3526	prio => 0,
		3527	data => WF_AUTOCANCEL,
		3528	cb => \&BDB::poll_cb,
		3529	);
		3530
		3531	BDB::set_sync_prepare {
		3532	my $status;
		3533	my $current = $Coro::current;
		3534	(
		3535	sub {
		3536	$status = $!;
		3537	$current->ready; undef $current;
		3538	},
		3539	sub {
		3540	Coro::schedule while defined $current;
		3541	$! = $status;
		3542	},
		3543	)
		3544	};
		3545
		3546	unless ($DB_ENV) {
		3547	$DB_ENV = BDB::db_env_create;
		3548	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3549	| BDB::LOG_AUTOREMOVE, 1);
		3550	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3551	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3552
		3553	cf::sync_job {
		3554	eval {
		3555	BDB::db_env_open
		3556	$DB_ENV,
		3557	$BDBDIR,
		3558	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3559	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3560	0666;
		3561
		3562	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3563	};
		3564
		3565	cf::cleanup "db_env_open(db): $@" if $@;
		3566	};
		3567	}
		3568
		3569	$BDB_DEADLOCK_WATCHER = Event->timer (
		3570	after => 3,
		3571	interval => 1,
		3572	hard => 1,
		3573	prio => 0,
		3574	data => WF_AUTOCANCEL,
		3575	cb => sub {
		3576	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3577	},
		3578	);
		3579	$BDB_CHECKPOINT_WATCHER = Event->timer (
		3580	after => 11,
		3581	interval => 60,
		3582	hard => 1,
		3583	prio => 0,
		3584	data => WF_AUTOCANCEL,
		3585	cb => sub {
		3586	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3587	},
		3588	);
		3589	$BDB_TRICKLE_WATCHER = Event->timer (
		3590	after => 5,
		3591	interval => 10,
		3592	hard => 1,
		3593	prio => 0,
		3594	data => WF_AUTOCANCEL,
		3595	cb => sub {
		3596	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3597	},
		3598	);
		3599	}
		3600
		3601	{
		3602	IO::AIO::min_parallel 8;
		3603
		3604	undef $Coro::AIO::WATCHER;
1190	IO::AIO::max_poll_time $TICK * 0.2;	3605	IO::AIO::max_poll_time $TICK * 0.1;
1191		3606	$AIO_POLL_WATCHER = Event->io (
1192	Event->io (fd => IO::AIO::poll_fileno,	3607	reentrant => 0,
		3608	data => WF_AUTOCANCEL,
		3609	fd => IO::AIO::poll_fileno,
1193	poll => 'r',	3610	poll => 'r',
1194	prio => 5,	3611	prio => 6,
1195	cb => \&IO::AIO::poll_cb);	3612	cb => \&IO::AIO::poll_cb,
		3613	);
		3614	}
		3615
		3616	my $_log_backtrace;
		3617
		3618	sub _log_backtrace {
		3619	my ($msg, @addr) = @_;
		3620
		3621	$msg =~ s/\n//;
		3622
		3623	# limit the # of concurrent backtraces
		3624	if ($_log_backtrace < 2) {
		3625	++$_log_backtrace;
		3626	async {
		3627	my @bt = fork_call {
		3628	@addr = map { sprintf "%x", $_ } @addr;
		3629	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3630	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3631	or die "addr2line: $!";
		3632
		3633	my @funcs;
		3634	my @res = <$fh>;
		3635	chomp for @res;
		3636	while (@res) {
		3637	my ($func, $line) = splice @res, 0, 2, ();
		3638	push @funcs, "[$func] $line";
		3639	}
		3640
		3641	@funcs
		3642	};
		3643
		3644	LOG llevInfo, "[ABT] $msg\n";
		3645	LOG llevInfo, "[ABT] $_\n" for @bt;
		3646	--$_log_backtrace;
		3647	};
		3648	} else {
		3649	LOG llevInfo, "[ABT] $msg\n";
		3650	LOG llevInfo, "[ABT] [suppressed]\n";
		3651	}
		3652	}
		3653
		3654	# load additional modules
		3655	use cf::pod;
		3656
		3657	END { cf::emergency_save }
1196		3658
1197	1	3659	1
1198		3660

Diff Legend

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