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

Diff Legend

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