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.107 by root, Sun Dec 31 18:10:40 2006 UTC vs.
Revision 1.447 by root, Fri Sep 19 01:39:45 2008 UTC

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

Diff Legend

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