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.91 by elmex, Sun Dec 17 22:03:44 2006 UTC vs.
Revision 1.371 by root, Thu Sep 13 16:16:01 2007 UTC

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

Diff Legend

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