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

Diff Legend

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