ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.107 by root, Sun Dec 31 18:10:40 2006 UTC vs.
Revision 1.552 by root, Mon May 17 21:12:59 2010 UTC

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

Diff Legend

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