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.94 by root, Thu Dec 21 23:02:54 2006 UTC vs.
Revision 1.377 by root, Thu Oct 4 11:36:38 2007 UTC

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

Diff Legend

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