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

Diff Legend

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