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

Diff Legend

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