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.102 by root, Wed Dec 27 15:20:54 2006 UTC vs.
Revision 1.402 by root, Mon Dec 17 07:03:32 2007 UTC

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

Diff Legend

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