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.226 by root, Wed Mar 14 04:12:29 2007 UTC vs.
Revision 1.495 by root, Tue Nov 10 04:38:45 2009 UTC

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

Diff Legend

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