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.207 by root, Sun Feb 11 22:42:09 2007 UTC vs.
Revision 1.494 by root, Mon Oct 26 05:18:00 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;
		32	use EV;
9	use Opcode;	33	use Opcode;
10	use Safe;	34	use Safe;
11	use Safe::Hole;	35	use Safe::Hole;
		36	use Storable ();
		37	use Carp ();
12		38
		39	use Guard ();
13	use Coro 3.5 ();	40	use Coro ();
		41	use Coro::State;
		42	use Coro::Handle;
		43	use Coro::EV;
14	use Coro::Event;	44	use Coro::AnyEvent;
15	use Coro::Timer;	45	use Coro::Timer;
16	use Coro::Signal;	46	use Coro::Signal;
17	use Coro::Semaphore;	47	use Coro::Semaphore;
		48	use Coro::SemaphoreSet;
		49	use Coro::AnyEvent;
18	use Coro::AIO;	50	use Coro::AIO;
		51	use Coro::BDB 1.6;
		52	use Coro::Storable;
		53	use Coro::Util ();
19		54
		55	use JSON::XS 2.01 ();
20	use BDB ();	56	use BDB ();
21	use Data::Dumper;	57	use Data::Dumper;
22	use Digest::MD5;	58	use Digest::MD5;
23	use Fcntl;	59	use Fcntl;
24	use IO::AIO 2.32 ();
25	use YAML::Syck ();	60	use YAML::XS ();
		61	use IO::AIO ();
26	use Time::HiRes;	62	use Time::HiRes;
		63	use Compress::LZF;
		64	use Digest::MD5 ();
27		65
28	use Event; $Event::Eval = 1; # no idea why this is required, but it is	66	AnyEvent::detect;
		67
		68	# configure various modules to our taste
		69	#
		70	$Storable::canonical = 1; # reduce rsync transfers
		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";
		77	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		78
		79	# strictly for debugging
		80	$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
29		81
30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	82	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31
32	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
33	$YAML::Syck::ImplicitUnicode = 1;
34
35	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
36		83
37	our %COMMAND = ();	84	our %COMMAND = ();
38	our %COMMAND_TIME = ();	85	our %COMMAND_TIME = ();
39		86
40	our @EXTS = (); # list of extension package names	87	our @EXTS = (); # list of extension package names
41	our %EXTCMD = ();	88	our %EXTCMD = ();
		89	our %EXTICMD = ();
42	our %EXT_CORO = (); # coroutines bound to extensions	90	our %EXT_CORO = (); # coroutines bound to extensions
43	our %EXT_MAP = (); # pluggable maps	91	our %EXT_MAP = (); # pluggable maps
44		92
		93	our $RELOAD; # number of reloads so far, non-zero while in reload
45	our @EVENT;	94	our @EVENT;
46	our $LIBDIR = datadir . "/ext";	95	our @REFLECT; # set by XS
		96	our %REFLECT; # set by us
47		97
48	our $TICK = MAX_TIME * 1e-6;	98	our $CONFDIR = confdir;
49	our $TICK_WATCHER;	99	our $DATADIR = datadir;
50	our $AIO_POLL_WATCHER;	100	our $LIBDIR = "$DATADIR/ext";
51	our $WRITE_RUNTIME_WATCHER;	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(!)
		115	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
52	our $NEXT_TICK;	116	our $NEXT_TICK;
53	our $NOW;
54	our $USE_FSYNC = 1; # use fsync to write maps - default off	117	our $USE_FSYNC = 1; # use fsync to write maps - default on
55		118
		119	our $BDB_DEADLOCK_WATCHER;
		120	our $BDB_CHECKPOINT_WATCHER;
56	our $BDB_POLL_WATCHER;	121	our $BDB_TRICKLE_WATCHER;
57	our $DB_ENV;	122	our $DB_ENV;
		123
		124	our @EXTRA_MODULES = qw(pod match mapscript);
58		125
59	our %CFG;	126	our %CFG;
60		127
61	our $UPTIME; $UPTIME ||= time;	128	our $UPTIME; $UPTIME ||= time;
62	our $RUNTIME;	129	our $RUNTIME;
		130	our $NOW;
63		131
64	our %PLAYER; # all users	132	our (%PLAYER, %PLAYER_LOADING); # all users
65	our %MAP; # all maps	133	our (%MAP, %MAP_LOADING ); # all maps
66	our $LINK_MAP; # the special {link} map, which is always available	134	our $LINK_MAP; # the special {link} map, which is always available
67	our $RANDOM_MAPS = cf::localdir . "/random";
68	our $BDB_ENV_DIR = cf::localdir . "/db";
69
70	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
71	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
72		135
73	# 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 ∕
74	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	137	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
75		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
76	binmode STDOUT;	149	binmode STDOUT;
77	binmode STDERR;	150	binmode STDERR;
78		151
79	# read virtual server time, if available	152	# read virtual server time, if available
80	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	153	unless ($RUNTIME || !-e $RUNTIMEFILE) {
81	open my $fh, "<", cf::localdir . "/runtime"	154	open my $fh, "<", $RUNTIMEFILE
82	or die "unable to read runtime file: $!";	155	or die "unable to read $RUNTIMEFILE file: $!";
83	$RUNTIME = <$fh> + 0.;	156	$RUNTIME = <$fh> + 0.;
84	}	157	}
85		158
86	mkdir cf::localdir;	159	eval "sub TICK() { $TICK } 1" or die;
87	mkdir cf::localdir . "/" . cf::playerdir;	160
88	mkdir cf::localdir . "/" . cf::tmpdir;	161	mkdir $_
89	mkdir cf::localdir . "/" . cf::uniquedir;	162	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
90	mkdir $RANDOM_MAPS;
91	mkdir $BDB_ENV_DIR;
92		163
93	our $EMERGENCY_POSITION;	164	our $EMERGENCY_POSITION;
94		165
95	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::"} };
96		178
97	#############################################################################	179	#############################################################################
98		180
99	=head2 GLOBAL VARIABLES	181	=head2 GLOBAL VARIABLES
100		182
…		…
107	=item $cf::RUNTIME	189	=item $cf::RUNTIME
108		190
109	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
110	every server tick.	192	every server tick.
111		193
112	=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
113		197
114	The perl library directory, where extensions and cf-specific modules can	198	Various directories - "/etc", read-only install directory, perl-library
115	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.
116		202
117	=item $cf::NOW	203	=item $cf::NOW
118		204
119	The time of the last (current) server tick.	205	The time of the last (current) server tick.
120		206
121	=item $cf::TICK	207	=item $cf::TICK
122		208
123	The interval between server ticks, in seconds.	209	The interval between server ticks, in seconds.
124		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
125	=item %cf::CFG	221	=item %cf::CFG
126		222
127	Configuration for the server, loaded from C</etc/crossfire/config>, or	223	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
128	from wherever your confdir points to.	224	from wherever your confdir points to.
129		225
130	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	226	=item cf::wait_for_tick, cf::wait_for_tick_begin
131		227
132	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
133	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
134	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.
135	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.
136		243
137	=back	244	=back
138		245
139	=cut	246	=cut
140		247
141	BEGIN {	248	$Coro::State::WARNHOOK = sub {
142	*CORE::GLOBAL::warn = sub {
143	my $msg = join "", @_;	249	my $msg = join "", @_;
144	utf8::encode $msg;
145		250
146	$msg .= "\n"	251	$msg .= "\n"
147	unless $msg =~ /\n$/;	252	unless $msg =~ /\n$/;
148		253
		254	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		255
149	LOG llevError, $msg;	256	LOG llevError, $msg;
150	};	257	};
151	}	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	};
152		272
153	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	273	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
154	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	274	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
155	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	275	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
156	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	276	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
157	@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';
158	@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)
159		280
160	# 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
161	# within the Safe compartment.	282	# within the Safe compartment.
162	for my $pkg (qw(	283	for my $pkg (qw(
163	cf::global cf::attachable	284	cf::global cf::attachable
164	cf::object cf::object::player	285	cf::object cf::object::player
165	cf::client cf::player	286	cf::client cf::player
166	cf::arch cf::living	287	cf::arch cf::living
		288	cf::map cf::mapspace
167	cf::map cf::party cf::region	289	cf::party cf::region
168	)) {	290	)) {
169	no strict 'refs';
170	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	291	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
171	}	292	}
172		293
173	$Event::DIED = sub {	294	$EV::DIED = sub {
174	warn "error in event callback: @_";	295	Carp::cluck "error in event callback: @_";
175	};	296	};
		297
		298	#############################################################################
176		299
177	=head2 UTILITY FUNCTIONS	300	=head2 UTILITY FUNCTIONS
178		301
179	=over 4	302	=over 4
180		303
…		…
199	$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;
200	$d	323	$d
201	} || "[unable to dump $_[0]: '$@']";	324	} || "[unable to dump $_[0]: '$@']";
202	}	325	}
203		326
204	use JSON::Syck (); # TODO# replace by JSON::PC once working
205
206	=item $ref = cf::from_json $json	327	=item $ref = cf::decode_json $json
207		328
208	Converts a JSON string into the corresponding perl data structure.	329	Converts a JSON string into the corresponding perl data structure.
209		330
210	=cut
211
212	sub from_json($) {
213	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
214	JSON::Syck::Load $_[0]
215	}
216
217	=item $json = cf::to_json $ref	331	=item $json = cf::encode_json $ref
218		332
219	Converts a perl data structure into its JSON representation.	333	Converts a perl data structure into its JSON representation.
220		334
221	=cut	335	=cut
222		336
223	sub to_json($) {	337	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
224	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	338
225	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;
226	}	354	}
227		355
228	=item cf::lock_wait $string	356	=item cf::lock_wait $string
229		357
230	Wait until the given lock is available. See cf::lock_acquire.	358	Wait until the given lock is available. See cf::lock_acquire.
231		359
232	=item my $lock = cf::lock_acquire $string	360	=item my $lock = cf::lock_acquire $string
233		361
234	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
235	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,
236	for example when the coroutine gets canceled), the lock is automatically	364	for example when the coroutine gets canceled), the lock is automatically
237	returned.	365	returned.
238		366
		367	Locks are *not* recursive, locking from the same coro twice results in a
		368	deadlocked coro.
		369
239	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
240	uses map_find and cf::map::load uses map_load).	371	uses map_find and cf::map::load uses map_load).
241		372
242	=cut	373	=item $locked = cf::lock_active $string
243		374
244	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;
245		380
246	sub lock_wait($) {	381	sub lock_wait($) {
247	my ($key) = @_;	382	$LOCKS->wait ($_[0]);
248
249	# wait for lock, if any
250	while ($LOCK{$key}) {
251	push @{ $LOCK{$key} }, $Coro::current;
252	Coro::schedule;
253	}
254	}	383	}
255		384
256	sub lock_acquire($) {	385	sub lock_acquire($) {
257	my ($key) = @_;	386	$LOCKS->guard ($_[0])
		387	}
258		388
259	# wait, to be sure we are not locked	389	sub lock_active($) {
260	lock_wait $key;	390	$LOCKS->count ($_[0]) < 1
261
262	$LOCK{$key} = [];
263
264	Coro::guard {
265	# wake up all waiters, to be on the safe side
266	$_->ready for @{ delete $LOCK{$key} };
267	}
268	}	391	}
269		392
270	sub freeze_mainloop {	393	sub freeze_mainloop {
271	return unless $TICK_WATCHER->is_active;	394	tick_inhibit_inc;
272		395
273	my $guard = Coro::guard {	396	&Guard::guard (\&tick_inhibit_dec);
274	$TICK_WATCHER->start;	397	}
275	$WRITE_RUNTIME_WATCHER->start;	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	}
276	};	457	}
277	$WRITE_RUNTIME_WATCHER->stop;	458	};
278	$TICK_WATCHER->stop;	459
279	$guard	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;
280	}	472	}
281		473
282	=item cf::async { BLOCK }	474	=item cf::async { BLOCK }
283		475
284	Currently the same as Coro::async_pool, meaning you cannot use	476	Currently the same as Coro::async_pool, meaning you cannot use
…		…
289		481
290	BEGIN { *async = \&Coro::async_pool }	482	BEGIN { *async = \&Coro::async_pool }
291		483
292	=item cf::sync_job { BLOCK }	484	=item cf::sync_job { BLOCK }
293		485
294	The design of crossfire+ requires that the main coro ($Coro::main) is	486	The design of Deliantra requires that the main coroutine ($Coro::main)
295	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
296	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.
297		490
298	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
299	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
300	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
301	fast or be very important.	494	fast or be very important.
…		…
304		497
305	sub sync_job(&) {	498	sub sync_job(&) {
306	my ($job) = @_;	499	my ($job) = @_;
307		500
308	if ($Coro::current == $Coro::main) {	501	if ($Coro::current == $Coro::main) {
		502	my $time = EV::time;
		503
309	# this is the main coro, too bad, we have to block	504	# this is the main coro, too bad, we have to block
310	# till the operation succeeds, freezing the server :/	505	# till the operation succeeds, freezing the server :/
311		506
312	# TODO: use suspend/resume instead	507	LOG llevError, Carp::longmess "sync job";#d#
313	# (but this is cancel-safe)	508
314	my $freeze_guard = freeze_mainloop;	509	my $freeze_guard = freeze_mainloop;
315		510
316	my $busy = 1;	511	my $busy = 1;
317	my @res;	512	my @res;
318		513
319	(async {	514	(async {
		515	$Coro::current->desc ("sync job coro");
320	@res = eval { $job->() };	516	@res = eval { $job->() };
321	warn $@ if $@;	517	warn $@ if $@;
322	undef $busy;	518	undef $busy;
323	})->prio (Coro::PRIO_MAX);	519	})->prio (Coro::PRIO_MAX);
324		520
325	while ($busy) {	521	while ($busy) {
326	Coro::cede or Event::one_event;	522	if (Coro::nready) {
		523	Coro::cede_notself;
		524	} else {
		525	EV::loop EV::LOOP_ONESHOT;
327	}	526	}
		527	}
		528
		529	my $time = EV::time - $time;
		530
		531	$TICK_START += $time; # do not account sync jobs to server load
328		532
329	wantarray ? @res : $res[0]	533	wantarray ? @res : $res[0]
330	} else {	534	} else {
331	# we are in another coroutine, how wonderful, everything just works	535	# we are in another coroutine, how wonderful, everything just works
332		536
…		…
352	$EXT_CORO{$coro+0} = $coro;	556	$EXT_CORO{$coro+0} = $coro;
353		557
354	$coro	558	$coro
355	}	559	}
356		560
357	sub write_runtime {	561	=item fork_call { }, $args
358	my $runtime = cf::localdir . "/runtime";
359		562
360	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	563	Executes the given code block with the given arguments in a seperate
361	or return;	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.
362		567
363	my $value = $cf::RUNTIME + 90 + 10;	568	=cut
364	# 10 is the runtime save interval, for a monotonic clock
365	# 60 allows for the watchdog to kill the server.
366		569
367	(aio_write $fh, 0, (length $value), $value, 0) <= 0	570	sub fork_call(&@) {
368	and return;	571	my ($cb, @args) = @_;
369		572
370	# always fsync - this file is important	573	# we seemingly have to make a local copy of the whole thing,
371	aio_fsync $fh	574	# otherwise perl prematurely frees the stuff :/
372	and return;	575	# TODO: investigate and fix (likely this will be rather laborious)
373		576
374	close $fh	577	my @res = Coro::Util::fork_eval {
375	or return;	578	reset_signals;
		579	&$cb
		580	}, @args;
376		581
377	aio_rename "$runtime~", $runtime	582	wantarray ? @res : $res[-1]
378	and return;	583	}
379		584
		585	=item $coin = coin_from_name $name
		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
380	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 });
381	}	748	}
382		749
383	=back	750	=back
384		751
385	=cut	752	=cut
386		753
387	#############################################################################	754	#############################################################################
388		755
389	=head2 ATTACHABLE OBJECTS	756	=head2 ATTACHABLE OBJECTS
390		757
391	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
392	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")
393	to it. All such attachable objects support the following methods.	760	to it. All such attachable objects support the following methods.
394		761
395	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>
396	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
397	crossfire+).	764	Deliantra).
398		765
399	=over 4	766	=over 4
400		767
401	=item $attachable->attach ($attachment, key => $value...)	768	=item $attachable->attach ($attachment, key => $value...)
402		769
…		…
446	=item cf::CLASS::attachment $name, ...	813	=item cf::CLASS::attachment $name, ...
447		814
448	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
449	given CLASS can refer to this attachment.	816	given CLASS can refer to this attachment.
450		817
451	Some classes such as crossfire maps and objects can specify attachments	818	Some classes such as deliantra maps and objects can specify attachments
452	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.
453		820
454	These calls expect any number of the following handler/hook descriptions:	821	These calls expect any number of the following handler/hook descriptions:
455		822
456	=over 4	823	=over 4
…		…
565	$registry = $CB_TYPE[$object_type] ||= [];	932	$registry = $CB_TYPE[$object_type] ||= [];
566		933
567	} elsif ($type eq "subtype") {	934	} elsif ($type eq "subtype") {
568	defined $object_type or Carp::croak "subtype specified without type";	935	defined $object_type or Carp::croak "subtype specified without type";
569	my $object_subtype = shift @arg;	936	my $object_subtype = shift @arg;
570	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	937	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571		938
572	} elsif ($type eq "package") {	939	} elsif ($type eq "package") {
573	my $pkg = shift @arg;	940	my $pkg = shift @arg;
574		941
575	while (my ($name, $id) = each %cb_id) {	942	while (my ($name, $id) = each %cb_id) {
…		…
604	_attach $registry, $klass, @attach;	971	_attach $registry, $klass, @attach;
605	}	972	}
606		973
607	$obj->{$name} = \%arg;	974	$obj->{$name} = \%arg;
608	} else {	975	} else {
609	warn "object uses attachment '$name' that is not available, postponing.\n";	976	warn "object uses attachment '$name' which is not available, postponing.\n";
610	}	977	}
611		978
612	$obj->{_attachment}{$name} = undef;	979	$obj->{_attachment}{$name} = undef;
613	}	980	}
614		981
…		…
616	if (ref $_[0]) {	983	if (ref $_[0]) {
617	_object_attach @_;	984	_object_attach @_;
618	} else {	985	} else {
619	_attach shift->_attach_registry, @_;	986	_attach shift->_attach_registry, @_;
620	}	987	}
		988	_recalc_want;
621	};	989	};
622		990
623	# all those should be optimised	991	# all those should be optimised
624	sub cf::attachable::detach {	992	sub cf::attachable::detach {
625	my ($obj, $name) = @_;	993	my ($obj, $name) = @_;
…		…
628	delete $obj->{_attachment}{$name};	996	delete $obj->{_attachment}{$name};
629	reattach ($obj);	997	reattach ($obj);
630	} else {	998	} else {
631	Carp::croak "cannot, currently, detach class attachments";	999	Carp::croak "cannot, currently, detach class attachments";
632	}	1000	}
		1001	_recalc_want;
633	};	1002	};
634		1003
635	sub cf::attachable::attached {	1004	sub cf::attachable::attached {
636	my ($obj, $name) = @_;	1005	my ($obj, $name) = @_;
637		1006
…		…
652	";	1021	";
653	die if $@;	1022	die if $@;
654	}	1023	}
655		1024
656	our $override;	1025	our $override;
657	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?
658		1027
659	sub override {	1028	sub override {
660	$override = 1;	1029	$override = 1;
661	@invoke_results = ();	1030	@INVOKE_RESULTS = (@_);
662	}	1031	}
663		1032
664	sub do_invoke {	1033	sub do_invoke {
665	my $event = shift;	1034	my $event = shift;
666	my $callbacks = shift;	1035	my $callbacks = shift;
667		1036
668	@invoke_results = ();	1037	@INVOKE_RESULTS = ();
669		1038
670	local $override;	1039	local $override;
671		1040
672	for (@$callbacks) {	1041	for (@$callbacks) {
673	eval { &{$_->[1]} };	1042	eval { &{$_->[1]} };
…		…
682	}	1051	}
683		1052
684	0	1053	0
685	}	1054	}
686		1055
687	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	1056	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
688		1057
689	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	1058	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
690		1059
691	Generate an object-specific event with the given arguments.	1060	Generate an object-specific event with the given arguments.
692		1061
693	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
694	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
695	results (if you must, access C<@cf::invoke_results> directly).	1064	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696		1065
697	=back	1066	=back
698		1067
699	=cut	1068	=cut
700		1069
701	#############################################################################	1070	#############################################################################
702	# 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	}
703		1114
704	sub reattach {	1115	sub reattach {
705	# basically do the same as instantiate, without calling instantiate	1116	# basically do the same as instantiate, without calling instantiate
706	my ($obj) = @_;	1117	my ($obj) = @_;
707		1118
		1119	# no longer needed after getting rid of delete_package?
708	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
709		1121
710	my $registry = $obj->registry;	1122	my $registry = $obj->registry;
711		1123
712	@$registry = ();	1124	@$registry = ();
713		1125
…		…
728	cf::attachable->attach (	1140	cf::attachable->attach (
729	prio => -1000000,	1141	prio => -1000000,
730	on_instantiate => sub {	1142	on_instantiate => sub {
731	my ($obj, $data) = @_;	1143	my ($obj, $data) = @_;
732		1144
733	$data = from_json $data;	1145	$data = decode_json $data;
734		1146
735	for (@$data) {	1147	for (@$data) {
736	my ($name, $args) = @$_;	1148	my ($name, $args) = @$_;
737		1149
738	$obj->attach ($name, %{$args || {} });	1150	$obj->attach ($name, %{$args || {} });
…		…
754	sub object_freezer_save {	1166	sub object_freezer_save {
755	my ($filename, $rdata, $objs) = @_;	1167	my ($filename, $rdata, $objs) = @_;
756		1168
757	sync_job {	1169	sync_job {
758	if (length $$rdata) {	1170	if (length $$rdata) {
		1171	utf8::decode (my $decname = $filename);
759	warn sprintf "saving %s (%d,%d)\n",	1172	warn sprintf "saving %s (%d,%d)\n",
760	$filename, length $$rdata, scalar @$objs;	1173	$decname, length $$rdata, scalar @$objs;
761		1174
762	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1175	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
763	chmod SAVE_MODE, $fh;	1176	aio_chmod $fh, SAVE_MODE;
764	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1177	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
765	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	}
766	close $fh;	1182	aio_close $fh;
767		1183
768	if (@$objs) {	1184	if (@$objs) {
769	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) {
770	chmod SAVE_MODE, $fh;	1186	aio_chmod $fh, SAVE_MODE;
771	my $data = Storable::nfreeze { version => 1, objs => $objs };	1187	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
772	aio_write $fh, 0, (length $data), $data, 0;	1188	aio_write $fh, 0, (length $data), $data, 0;
773	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	}
774	close $fh;	1193	aio_close $fh;
775	aio_rename "$filename.pst~", "$filename.pst";	1194	aio_rename "$filename.pst~", "$filename.pst";
776	}	1195	}
777	} else {	1196	} else {
778	aio_unlink "$filename.pst";	1197	aio_unlink "$filename.pst";
779	}	1198	}
780		1199
781	aio_rename "$filename~", $filename;	1200	aio_rename "$filename~", $filename;
		1201
		1202	$filename =~ s%/[^/]+$%%;
		1203	aio_pathsync $filename if $cf::USE_FSYNC;
782	} else {	1204	} else {
783	warn "FATAL: $filename~: $!\n";	1205	warn "unable to save objects: $filename~: $!\n";
784	}	1206	}
785	} else {	1207	} else {
786	aio_unlink $filename;	1208	aio_unlink $filename;
787	aio_unlink "$filename.pst";	1209	aio_unlink "$filename.pst";
788	}	1210	}
789
790	#d##TODO# nuke non .map-files if exist
791	if ($filename =~ s/\.map$//) {
792	aio_unlink $filename;
793	aio_unlink "$filename.pst";
794	}
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
…		…
805		1221
806	sub object_thawer_load {	1222	sub object_thawer_load {
807	my ($filename) = @_;	1223	my ($filename) = @_;
808		1224
809	my ($data, $av);	1225	my ($data, $av);
810
811	#d#TODO remove .map if file does not exist
812	aio_stat $filename and $filename =~ s/\.map$//;
813		1226
814	(aio_load $filename, $data) >= 0	1227	(aio_load $filename, $data) >= 0
815	or return;	1228	or return;
816		1229
817	unless (aio_stat "$filename.pst") {	1230	unless (aio_stat "$filename.pst") {
818	(aio_load "$filename.pst", $av) >= 0	1231	(aio_load "$filename.pst", $av) >= 0
819	or return;	1232	or return;
		1233
820	$av = eval { (Storable::thaw $av)->{objs} };	1234	my $st = eval { Coro::Storable::thaw $av };
		1235	$av = $st->{objs};
821	}	1236	}
822		1237
		1238	utf8::decode (my $decname = $filename);
823	warn sprintf "loading %s (%d)\n",	1239	warn sprintf "loading %s (%d,%d)\n",
824	$filename, length $data, scalar @{$av || []};#d#	1240	$decname, length $data, scalar @{$av || []};
		1241
825	return ($data, $av);	1242	($data, $av)
826	}	1243	}
		1244
		1245	=head2 COMMAND CALLBACKS
		1246
		1247	=over 4
		1248
		1249	=cut
827		1250
828	#############################################################################	1251	#############################################################################
829	# command handling &c	1252	# command handling &c
830		1253
831	=item cf::register_command $name => \&callback($ob,$args);	1254	=item cf::register_command $name => \&callback($ob,$args);
…		…
844	push @{ $COMMAND{$name} }, [$caller, $cb];	1267	push @{ $COMMAND{$name} }, [$caller, $cb];
845	}	1268	}
846		1269
847	=item cf::register_extcmd $name => \&callback($pl,$packet);	1270	=item cf::register_extcmd $name => \&callback($pl,$packet);
848		1271
849	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.
850		1277
851	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
852	called.	1279	called.
853		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
854	=cut	1292	=cut
855		1293
856	sub register_extcmd {	1294	sub register_extcmd {
857	my ($name, $cb) = @_;	1295	my ($name, $cb) = @_;
858		1296
859	$EXTCMD{$name} = $cb;	1297	$EXTCMD{$name} = $cb;
860	}	1298	}
		1299
		1300	sub register_exticmd {
		1301	my ($name, $cb) = @_;
		1302
		1303	$EXTICMD{$name} = $cb;
		1304	}
		1305
		1306	use File::Glob ();
861		1307
862	cf::player->attach (	1308	cf::player->attach (
863	on_command => sub {	1309	on_command => sub {
864	my ($pl, $name, $params) = @_;	1310	my ($pl, $name, $params) = @_;
865		1311
…		…
873	cf::override;	1319	cf::override;
874	},	1320	},
875	on_extcmd => sub {	1321	on_extcmd => sub {
876	my ($pl, $buf) = @_;	1322	my ($pl, $buf) = @_;
877		1323
878	my $msg = eval { from_json $buf };	1324	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
879		1325
880	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
881	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1334	if (my $cb = $EXTCMD{$type}) {
882	if (my %reply = $cb->($pl, $msg)) {	1335	@reply = $cb->($pl, @payload);
883	$pl->ext_reply ($msg->{msgid}, %reply);
884	}
885	}	1336	}
		1337
		1338	$pl->ext_reply ($reply, @reply)
		1339	if $reply;
		1340
886	} else {	1341	} else {
887	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1342	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
888	}	1343	}
889		1344
890	cf::override;	1345	cf::override;
891	},	1346	},
892	);	1347	);
893		1348
		1349	# "readahead" all extensions
894	sub load_extension {	1350	sub cache_extensions {
895	my ($path) = @_;	1351	my $grp = IO::AIO::aio_group;
896		1352
897	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1353	add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
898	my $base = $1;	1354	for (grep /\.ext$/, @{$_[0]}) {
899	my $pkg = $1;	1355	add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
900	$pkg =~ s/[^[:word:]]/_/g;
901	$pkg = "ext::$pkg";
902
903	warn "... loading '$path' into '$pkg'\n";
904
905	open my $fh, "<:utf8", $path
906	or die "$path: $!";
907
908	my $source =
909	"package $pkg; use strict; use utf8;\n"
910	. "#line 1 \"$path\"\n{\n"
911	. (do { local $/; <$fh> })
912	. "\n};\n1";
913
914	unless (eval $source) {
915	my $msg = $@ ? "$path: $@\n"
916	: "extension disabled.\n";
917	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
918	warn $@;
919	warn "mandatory extension failed to load, exiting.\n";
920	exit 1;
921	}	1356	}
922	die $@;
923	}	1357	};
924		1358
925	push @EXTS, $pkg;	1359	$grp
926	}	1360	}
927		1361
928	sub load_extensions {	1362	sub load_extensions {
		1363	cf::sync_job {
		1364	my %todo;
		1365
929	for my $ext (<$LIBDIR/*.ext>) {	1366	for my $path (<$LIBDIR/*.ext>) {
930	next unless -r $ext;	1367	next unless -r $path;
931	eval {	1368
932	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;
933	1	1425	}
934	} or warn "$ext not loaded: $@";	1426
		1427	skip:
		1428	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1429	unless $progress;
		1430	}
935	}	1431	};
936	}	1432	}
937		1433
938	#############################################################################	1434	#############################################################################
939		1435
		1436	=back
		1437
940	=head2 CORE EXTENSIONS	1438	=head2 CORE EXTENSIONS
941		1439
942	Functions and methods that extend core crossfire objects.	1440	Functions and methods that extend core deliantra objects.
943		1441
944	=cut	1442	=cut
945		1443
946	package cf::player;	1444	package cf::player;
947		1445
…		…
949		1447
950	=head3 cf::player	1448	=head3 cf::player
951		1449
952	=over 4	1450	=over 4
953		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
954	=item cf::player::find $login	1466	=item cf::player::find $login
955		1467
956	Returns the given player object, loading it if necessary (might block).	1468	Returns the given player object, loading it if necessary (might block).
957		1469
958	=cut	1470	=cut
959		1471
960	sub playerdir($) {	1472	sub playerdir($) {
961	cf::localdir	1473	"$PLAYERDIR/"
962	. "/"
963	. cf::playerdir
964	. "/"
965	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1474	. (ref $_[0] ? $_[0]->ob->name : $_[0])
966	}	1475	}
967		1476
968	sub path($) {	1477	sub path($) {
969	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1478	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
970		1479
971	(playerdir $login) . "/$login.pl"	1480	(playerdir $login) . "/playerdata"
972	}	1481	}
973		1482
974	sub find_active($) {	1483	sub find_active($) {
975	$cf::PLAYER{$_[0]}	1484	$cf::PLAYER{$_[0]}
976	and $cf::PLAYER{$_[0]}->active	1485	and $cf::PLAYER{$_[0]}->active
…		…
979		1488
980	sub exists($) {	1489	sub exists($) {
981	my ($login) = @_;	1490	my ($login) = @_;
982		1491
983	$cf::PLAYER{$login}	1492	$cf::PLAYER{$login}
984	or cf::sync_job { !aio_stat path $login }	1493	or !aio_stat path $login
985	}	1494	}
986		1495
987	sub find($) {	1496	sub find($) {
988	return $cf::PLAYER{$_[0]} || do {	1497	return $cf::PLAYER{$_[0]} || do {
989	my $login = $_[0];	1498	my $login = $_[0];
990		1499
991	my $guard = cf::lock_acquire "user_find:$login";	1500	my $guard = cf::lock_acquire "user_find:$login";
992		1501
993	$cf::PLAYER{$_[0]} || do {	1502	$cf::PLAYER{$_[0]} || do {
994	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
995	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;
996	$cf::PLAYER{$login} = $pl	1518	$cf::PLAYER{$login} = $pl
997	}	1519	}
998	}	1520	}
999	}	1521	}
1000		1522
…		…
1009	return if $pl->{deny_save};	1531	return if $pl->{deny_save};
1010		1532
1011	aio_mkdir playerdir $pl, 0770;	1533	aio_mkdir playerdir $pl, 0770;
1012	$pl->{last_save} = $cf::RUNTIME;	1534	$pl->{last_save} = $cf::RUNTIME;
1013		1535
		1536	cf::get_slot 0.01;
		1537
1014	$pl->save_pl ($path);	1538	$pl->save_pl ($path);
1015	Coro::cede;	1539	cf::cede_to_tick;
1016	}	1540	}
1017		1541
1018	sub new($) {	1542	sub new($) {
1019	my ($login) = @_;	1543	my ($login) = @_;
1020		1544
…		…
1026	$cf::PLAYER{$login} = $self;	1550	$cf::PLAYER{$login} = $self;
1027		1551
1028	$self	1552	$self
1029	}	1553	}
1030		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
1031	=item $pl->quit_character	1565	=item $pl->quit_character
1032		1566
1033	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
1034	be destroyed. May block for a long time.	1568	be destroyed. May block for a long time.
1035		1569
1036	=cut	1570	=cut
1037		1571
1038	sub quit_character {	1572	sub quit_character {
1039	my ($pl) = @_;	1573	my ($pl) = @_;
1040		1574
		1575	my $name = $pl->ob->name;
		1576
1041	$pl->{deny_save} = 1;	1577	$pl->{deny_save} = 1;
1042	$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
1043		1579
1044	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1580	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1045	$pl->deactivate;	1581	$pl->deactivate;
		1582	my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
		1583	$pl->ob->check_score;
1046	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1584	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1047	$pl->ns->destroy if $pl->ns;	1585	$pl->ns->destroy if $pl->ns;
1048		1586
1049	my $path = playerdir $pl;	1587	my $path = playerdir $pl;
1050	my $temp = "$path~$cf::RUNTIME~deleting~";	1588	my $temp = "$path~$cf::RUNTIME~deleting~";
1051	aio_rename $path, $temp;	1589	aio_rename $path, $temp;
1052	delete $cf::PLAYER{$pl->ob->name};	1590	delete $cf::PLAYER{$pl->ob->name};
1053	$pl->destroy;	1591	$pl->destroy;
		1592
		1593	my $prefix = qr<^~\Q$name\E/>;
		1594
		1595	# nuke player maps
		1596	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1597
1054	IO::AIO::aio_rmtree $temp;	1598	IO::AIO::aio_rmtree $temp;
		1599	}
		1600
		1601	=item $pl->kick
		1602
		1603	Kicks a player out of the game. This destroys the connection.
		1604
		1605	=cut
		1606
		1607	sub kick {
		1608	my ($pl, $kicker) = @_;
		1609
		1610	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1611	$pl->killer ("kicked");
		1612	$pl->ns->destroy;
1055	}	1613	}
1056		1614
1057	=item cf::player::list_logins	1615	=item cf::player::list_logins
1058		1616
1059	Returns am arrayref of all valid playernames in the system, can take a	1617	Returns am arrayref of all valid playernames in the system, can take a
1060	while and may block, so not sync_job-capable, ever.	1618	while and may block, so not sync_job-capable, ever.
1061		1619
1062	=cut	1620	=cut
1063		1621
1064	sub list_logins {	1622	sub list_logins {
1065	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1623	my $dirs = aio_readdir $PLAYERDIR
1066	or return [];	1624	or return [];
1067		1625
1068	my @logins;	1626	my @logins;
1069		1627
1070	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") {
1071	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1634	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1072	aio_read $fh, 0, 512, my $buf, 0 or next;	1635	aio_read $fh, 0, 512, my $buf, 0 or next;
1073	$buf !~ /^password -------------$/m or next; # official not-valid tag	1636	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1637	}
1074		1638
1075	utf8::decode $login;	1639	utf8::decode $login;
1076	push @logins, $login;	1640	push @logins, $login;
1077	}	1641	}
1078		1642
…		…
1105	}	1669	}
1106		1670
1107	\@paths	1671	\@paths
1108	}	1672	}
1109		1673
		1674	=item $protocol_xml = $player->expand_cfpod ($cfpod)
		1675
		1676	Expand deliantra pod fragments into protocol xml.
		1677
1110	=item $player->ext_reply ($msgid, $msgtype, %msg)	1678	=item $player->ext_reply ($msgid, @msg)
1111		1679
1112	Sends an ext reply to the player.	1680	Sends an ext reply to the player.
1113		1681
1114	=cut	1682	=cut
1115		1683
1116	sub ext_reply($$$%) {	1684	sub ext_reply($$@) {
1117	my ($self, $id, %msg) = @_;	1685	my ($self, $id, @msg) = @_;
1118		1686
1119	$msg{msgid} = $id;	1687	$self->ns->ext_reply ($id, @msg)
1120
1121	$self->send ("ext " . cf::to_json \%msg);
1122	}	1688	}
1123		1689
1124	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	}
1125		1730
1126	=back	1731	=back
1127
1128		1732
1129	=head3 cf::map	1733	=head3 cf::map
1130		1734
1131	=over 4	1735	=over 4
1132		1736
…		…
1144	our $MAX_RESET = 3600;	1748	our $MAX_RESET = 3600;
1145	our $DEFAULT_RESET = 3000;	1749	our $DEFAULT_RESET = 3000;
1146		1750
1147	sub generate_random_map {	1751	sub generate_random_map {
1148	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
1149	# mit "rum" bekleckern, nicht	1756	# mit "rum" bekleckern, nicht
1150	$self->_create_random_map (	1757	$self->_create_random_map (
1151	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1758	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1152	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1759	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1153	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1760	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
…		…
1187	my ($self, $merge) = @_;	1794	my ($self, $merge) = @_;
1188		1795
1189	# we have to keep some variables in memory intact	1796	# we have to keep some variables in memory intact
1190	local $self->{path};	1797	local $self->{path};
1191	local $self->{load_path};	1798	local $self->{load_path};
1192	local $self->{deny_save};
1193	local $self->{deny_reset};
1194		1799
1195	$self->SUPER::thawer_merge ($merge);	1800	$self->SUPER::thawer_merge ($merge);
1196	}	1801	}
1197		1802
1198	sub normalise {	1803	sub normalise {
…		…
1245	$self->init; # pass $1 etc.	1850	$self->init; # pass $1 etc.
1246	return $self;	1851	return $self;
1247	}	1852	}
1248	}	1853	}
1249		1854
1250	Carp::carp "unable to resolve path '$path' (base '$base').";	1855	Carp::cluck "unable to resolve path '$path' (base '$base').";
1251	()	1856	()
1252	}	1857	}
1253		1858
1254	sub init {	1859	sub init {
1255	my ($self) = @_;	1860	my ($self) = @_;
…		…
1270		1875
1271	# the original (read-only) location	1876	# the original (read-only) location
1272	sub load_path {	1877	sub load_path {
1273	my ($self) = @_;	1878	my ($self) = @_;
1274		1879
1275	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1880	"$MAPDIR/$self->{path}.map"
1276	}	1881	}
1277		1882
1278	# the temporary/swap location	1883	# the temporary/swap location
1279	sub save_path {	1884	sub save_path {
1280	my ($self) = @_;	1885	my ($self) = @_;
1281		1886
1282	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1887	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1283	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1888	"$TMPDIR/$path.map"
1284	}	1889	}
1285		1890
1286	# the unique path, undef == no special unique path	1891	# the unique path, undef == no special unique path
1287	sub uniq_path {	1892	sub uniq_path {
1288	my ($self) = @_;	1893	my ($self) = @_;
1289		1894
1290	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1895	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1291	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1896	"$UNIQUEDIR/$path"
1292	}	1897	}
1293		1898
1294	# and all this just because we cannot iterate over	1899	sub decay_objects {
1295	# all maps in C++...
1296	sub change_all_map_light {
1297	my ($change) = @_;	1900	my ($self) = @_;
1298		1901
1299	$_->change_map_light ($change)	1902	return if $self->{deny_reset};
1300	for grep $_->outdoor, values %cf::MAP;	1903
		1904	$self->do_decay_objects;
1301	}	1905	}
1302		1906
1303	sub unlink_save {	1907	sub unlink_save {
1304	my ($self) = @_;	1908	my ($self) = @_;
1305		1909
1306	utf8::encode (my $save = $self->save_path);	1910	utf8::encode (my $save = $self->save_path);
1307	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1911	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1308	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1912	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1309
1310	#d#TODO remove .map and also nuke
1311	$save =~ s/\.map// or return;#d#
1312	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1313	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1314	}	1913	}
1315		1914
1316	sub load_header_from($) {	1915	sub load_header_from($) {
1317	my ($self, $path) = @_;	1916	my ($self, $path) = @_;
1318		1917
1319	utf8::encode $path;	1918	utf8::encode $path;
1320	#aio_open $path, O_RDONLY, 0	1919	my $f = new_from_file cf::object::thawer $path
1321	# or return;
1322
1323	$self->_load_header ($path)
1324	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;
1325		1927
1326	$self->{load_path} = $path;	1928	$self->{load_path} = $path;
1327		1929
1328	1	1930	1
1329	}	1931	}
…		…
1368	$self->load_header_orig	1970	$self->load_header_orig
1369	or return;	1971	or return;
1370	$self->prepare_orig;	1972	$self->prepare_orig;
1371	}	1973	}
1372		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
1373	1	1981	1
1374	}	1982	}
1375		1983
1376	sub find;	1984	sub find;
1377	sub find {	1985	sub find {
1378	my ($path, $origin) = @_;	1986	my ($path, $origin) = @_;
1379		1987
1380	$path = normalise $path, $origin && $origin->path;	1988	$path = normalise $path, $origin && $origin->path;
1381		1989
		1990	my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1382	cf::lock_wait "map_find:$path";	1991	my $guard2 = cf::lock_acquire "map_find:$path";
1383		1992
1384	$cf::MAP{$path} || do {	1993	$cf::MAP{$path} || do {
1385	my $guard = cf::lock_acquire "map_find:$path";
1386	my $map = new_from_path cf::map $path	1994	my $map = new_from_path cf::map $path
1387	or return;	1995	or return;
1388		1996
1389	$map->{last_save} = $cf::RUNTIME;	1997	$map->{last_save} = $cf::RUNTIME;
1390		1998
1391	$map->load_header	1999	$map->load_header
1392	or return;	2000	or return;
1393		2001
1394	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	2002	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1395	# doing this can freeze the server in a sync job, obviously	2003	# doing this can freeze the server in a sync job, obviously
1396	#$cf::WAIT_FOR_TICK->wait;	2004	#$cf::WAIT_FOR_TICK->wait;
		2005	undef $guard2;
		2006	undef $guard1;
1397	$map->reset;	2007	$map->reset;
1398	undef $guard;
1399	return find $path;	2008	return find $path;
1400	}	2009	}
1401		2010
1402	$cf::MAP{$path} = $map	2011	$cf::MAP{$path} = $map
1403	}	2012	}
…		…
1410	my ($self) = @_;	2019	my ($self) = @_;
1411		2020
1412	local $self->{deny_reset} = 1; # loading can take a long time	2021	local $self->{deny_reset} = 1; # loading can take a long time
1413		2022
1414	my $path = $self->{path};	2023	my $path = $self->{path};
		2024
		2025	{
1415	my $guard = cf::lock_acquire "map_load:$path";	2026	my $guard = cf::lock_acquire "map_data:$path";
1416		2027
		2028	return unless $self->valid;
1417	return if $self->in_memory != cf::MAP_SWAPPED;	2029	return unless $self->in_memory == cf::MAP_SWAPPED;
1418		2030
1419	$self->in_memory (cf::MAP_LOADING);	2031	$self->in_memory (cf::MAP_LOADING);
1420		2032
1421	$self->alloc;	2033	$self->alloc;
1422		2034
1423	$self->pre_load;	2035	$self->pre_load;
		2036	cf::cede_to_tick;
1424		2037
1425	$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)
1426	or return;	2041	or return;
1427		2042
1428	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2043	$self->post_load_original
1429	if delete $self->{load_original};	2044	if delete $self->{load_original};
1430		2045
1431	if (my $uniq = $self->uniq_path) {	2046	if (my $uniq = $self->uniq_path) {
1432	utf8::encode $uniq;	2047	utf8::encode $uniq;
1433	if (aio_open $uniq, O_RDONLY, 0) {	2048	unless (aio_stat $uniq) {
		2049	if (my $f = new_from_file cf::object::thawer $uniq) {
1434	$self->clear_unique_items;	2050	$self->clear_unique_items;
1435	$self->_load_objects ($uniq, 0);	2051	$self->_load_objects ($f);
		2052	$f->resolve_delayed_derefs;
		2053	}
1436	}	2054	}
1437	}	2055	}
1438		2056
1439	Coro::cede;	2057	$f->resolve_delayed_derefs;
1440		2058
		2059	cf::cede_to_tick;
1441	# now do the right thing for maps	2060	# now do the right thing for maps
1442	$self->link_multipart_objects;	2061	$self->link_multipart_objects;
1443
1444	unless ($self->{deny_activate}) {
1445	$self->decay_objects;
1446	$self->fix_auto_apply;
1447	$self->update_buttons;
1448	Coro::cede;
1449	$self->set_darkness_map;
1450	$self->difficulty ($self->estimate_difficulty)	2062	$self->difficulty ($self->estimate_difficulty)
1451	unless $self->difficulty;	2063	unless $self->difficulty;
1452	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;
1453	$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);
1454	}	2078	}
1455		2079
1456	$self->post_load;	2080	$self->post_load;
1457
1458	$self->in_memory (cf::MAP_IN_MEMORY);
1459	}	2081	}
1460		2082
1461	sub customise_for {	2083	sub customise_for {
1462	my ($self, $ob) = @_;	2084	my ($self, $ob) = @_;
1463		2085
1464	return find "~" . $ob->name . "/" . $self->{path}	2086	return find "~" . $ob->name . "/" . $self->{path}
1465	if $self->per_player;	2087	if $self->per_player;
1466		2088
		2089	# return find "?party/" . $ob->name . "/" . $self->{path}
		2090	# if $self->per_party;
		2091
1467	$self	2092	$self
1468	}	2093	}
1469		2094
1470	# 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
1471	sub load_diag {	2096	sub load_neighbours {
1472	my ($map) = @_;	2097	my ($map) = @_;
1473		2098
1474	my @diag; # diagonal neighbours	2099	my @neigh; # diagonal neighbours
1475		2100
1476	for (0 .. 3) {	2101	for (0 .. 3) {
1477	my $neigh = $map->tile_path ($_)	2102	my $neigh = $map->tile_path ($_)
1478	or next;	2103	or next;
1479	$neigh = find $neigh, $map	2104	$neigh = find $neigh, $map
1480	or next;	2105	or next;
1481	$neigh->load;	2106	$neigh->load;
1482		2107
		2108	push @neigh,
1483	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2109	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1484	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2110	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1485	}	2111	}
1486		2112
1487	for (@diag) {	2113	for (grep defined $_->[0], @neigh) {
		2114	my ($path, $origin) = @$_;
1488	my $neigh = find @$_	2115	my $neigh = find $path, $origin
1489	or next;	2116	or next;
1490	$neigh->load;	2117	$neigh->load;
1491	}	2118	}
1492	}	2119	}
1493		2120
…		…
1498	}	2125	}
1499		2126
1500	sub do_load_sync {	2127	sub do_load_sync {
1501	my ($map) = @_;	2128	my ($map) = @_;
1502		2129
		2130	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2131	if $Coro::current == $Coro::main;
		2132
1503	cf::sync_job { $map->load };	2133	cf::sync_job { $map->load };
1504	}	2134	}
1505		2135
1506	our %MAP_PREFETCH;	2136	our %MAP_PREFETCH;
1507	our $MAP_PREFETCHER = undef;	2137	our $MAP_PREFETCHER = undef;
1508		2138
1509	sub find_async {	2139	sub find_async {
1510	my ($path, $origin) = @_;	2140	my ($path, $origin, $load) = @_;
1511		2141
1512	$path = normalise $path, $origin && $origin->{path};	2142	$path = normalise $path, $origin && $origin->{path};
1513		2143
1514	if (my $map = $cf::MAP{$path}) {	2144	if (my $map = $cf::MAP{$path}) {
1515	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2145	return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1516	}	2146	}
1517		2147
1518	undef $MAP_PREFETCH{$path};	2148	$MAP_PREFETCH{$path} |= $load;
		2149
1519	$MAP_PREFETCHER ||= cf::async {	2150	$MAP_PREFETCHER ||= cf::async {
		2151	$Coro::current->{desc} = "map prefetcher";
		2152
1520	while (%MAP_PREFETCH) {	2153	while (%MAP_PREFETCH) {
1521	for my $path (keys %MAP_PREFETCH) {	2154	while (my ($k, $v) = each %MAP_PREFETCH) {
1522	my $map = find $path	2155	if (my $map = find $k) {
1523	or next;
1524	$map->load;	2156	$map->load if $v;
		2157	}
1525		2158
1526	delete $MAP_PREFETCH{$path};	2159	delete $MAP_PREFETCH{$k};
1527	}	2160	}
1528	}	2161	}
1529	undef $MAP_PREFETCHER;	2162	undef $MAP_PREFETCHER;
1530	};	2163	};
1531	$MAP_PREFETCHER->prio (6);	2164	$MAP_PREFETCHER->prio (6);
…		…
1534	}	2167	}
1535		2168
1536	sub save {	2169	sub save {
1537	my ($self) = @_;	2170	my ($self) = @_;
1538		2171
1539	my $lock = cf::lock_acquire "map_data:" . $self->path;	2172	my $lock = cf::lock_acquire "map_data:$self->{path}";
1540		2173
1541	$self->{last_save} = $cf::RUNTIME;	2174	$self->{last_save} = $cf::RUNTIME;
1542		2175
1543	return unless $self->dirty;	2176	return unless $self->dirty;
1544		2177
…		…
1550	return if $self->{deny_save};	2183	return if $self->{deny_save};
1551		2184
1552	local $self->{last_access} = $self->last_access;#d#	2185	local $self->{last_access} = $self->last_access;#d#
1553		2186
1554	cf::async {	2187	cf::async {
		2188	$Coro::current->{desc} = "map player save";
1555	$_->contr->save for $self->players;	2189	$_->contr->save for $self->players;
1556	};	2190	};
		2191
		2192	cf::get_slot 0.02;
1557		2193
1558	if ($uniq) {	2194	if ($uniq) {
1559	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2195	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1560	$self->_save_objects ($uniq, cf::IO_UNIQUES);	2196	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1561	} else {	2197	} else {
…		…
1567	my ($self) = @_;	2203	my ($self) = @_;
1568		2204
1569	# save first because save cedes	2205	# save first because save cedes
1570	$self->save;	2206	$self->save;
1571		2207
1572	my $lock = cf::lock_acquire "map_data:" . $self->path;	2208	my $lock = cf::lock_acquire "map_data:$self->{path}";
1573		2209
1574	return if $self->players;	2210	return if $self->players;
1575	return if $self->in_memory != cf::MAP_IN_MEMORY;	2211	return if $self->in_memory != cf::MAP_ACTIVE;
1576	return if $self->{deny_save};	2212	return if $self->{deny_save};
1577		2213
		2214	$self->in_memory (cf::MAP_SWAPPED);
		2215
		2216	$self->deactivate;
		2217	$_->clear_links_to ($self) for values %cf::MAP;
1578	$self->clear;	2218	$self->clear;
1579	$self->in_memory (cf::MAP_SWAPPED);
1580	}	2219	}
1581		2220
1582	sub reset_at {	2221	sub reset_at {
1583	my ($self) = @_;	2222	my ($self) = @_;
1584		2223
1585	# TODO: safety, remove and allow resettable per-player maps	2224	# TODO: safety, remove and allow resettable per-player maps
1586	return 1e99 if $self->isa ("ext::map_per_player");#d#
1587	return 1e99 if $self->{deny_reset};	2225	return 1e99 if $self->{deny_reset};
1588		2226
1589	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2227	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1590	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;
1591		2229
…		…
1602	my ($self) = @_;	2240	my ($self) = @_;
1603		2241
1604	my $lock = cf::lock_acquire "map_data:$self->{path}";	2242	my $lock = cf::lock_acquire "map_data:$self->{path}";
1605		2243
1606	return if $self->players;	2244	return if $self->players;
1607	return if $self->isa ("ext::map_per_player");#d#
1608		2245
1609	warn "resetting map ", $self->path;#d#	2246	warn "resetting map ", $self->path, "\n";
		2247
		2248	$self->in_memory (cf::MAP_SWAPPED);
		2249
		2250	# need to save uniques path
		2251	unless ($self->{deny_save}) {
		2252	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2253
		2254	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2255	if $uniq;
		2256	}
1610		2257
1611	delete $cf::MAP{$self->path};	2258	delete $cf::MAP{$self->path};
1612		2259
1613	$self->in_memory (cf::MAP_SWAPPED);	2260	$self->deactivate;
		2261	$_->clear_links_to ($self) for values %cf::MAP;
1614	$self->clear;	2262	$self->clear;
1615
1616	$_->clear_links_to ($self) for values %cf::MAP;
1617		2263
1618	$self->unlink_save;	2264	$self->unlink_save;
1619	$self->destroy;	2265	$self->destroy;
1620	}	2266	}
1621		2267
1622	my $nuke_counter = "aaaa";	2268	my $nuke_counter = "aaaa";
1623		2269
1624	sub nuke {	2270	sub nuke {
1625	my ($self) = @_;	2271	my ($self) = @_;
1626		2272
		2273	{
		2274	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2275
1627	delete $cf::MAP{$self->path};	2276	delete $cf::MAP{$self->path};
1628		2277
1629	$self->unlink_save;	2278	$self->unlink_save;
1630		2279
1631	bless $self, "cf::map";	2280	bless $self, "cf::map";
1632	delete $self->{deny_reset};	2281	delete $self->{deny_reset};
1633	$self->{deny_save} = 1;	2282	$self->{deny_save} = 1;
1634	$self->reset_timeout (1);	2283	$self->reset_timeout (1);
1635	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2284	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1636		2285
1637	$cf::MAP{$self->path} = $self;	2286	$cf::MAP{$self->path} = $self;
		2287	}
1638		2288
1639	$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	]
1640	}	2326	}
1641		2327
1642	=item cf::map::unique_maps	2328	=item cf::map::unique_maps
1643		2329
1644	Returns an arrayref of paths of all shared maps that have	2330	Returns an arrayref of paths of all shared maps that have
1645	instantiated unique items. May block.	2331	instantiated unique items. May block.
1646		2332
1647	=cut	2333	=cut
1648		2334
1649	sub unique_maps() {	2335	sub unique_maps() {
1650	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2336	[
1651	or return;	2337	map {
1652
1653	my @paths;
1654
1655	for (@$files) {
1656	utf8::decode $_;	2338	utf8::decode $_;
1657	next if /\.pst$/;	2339	s/\.map$//; # TODO future compatibility hack
1658	next unless /^$PATH_SEP/o;	2340	/\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1659		2341	? ()
1660	push @paths, cf::map::normalise $_;	2342	: normalise $_
		2343	} @{ aio_readdir $UNIQUEDIR or [] }
1661	}	2344	]
1662
1663	\@paths
1664	}	2345	}
1665		2346
1666	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	}
1667		2378
1668	=back	2379	=back
1669		2380
1670	=head3 cf::object	2381	=head3 cf::object
1671		2382
…		…
1675		2386
1676	=over 4	2387	=over 4
1677		2388
1678	=item $ob->inv_recursive	2389	=item $ob->inv_recursive
1679		2390
1680	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.
1681		2393
1682	=cut	2394	=cut
1683		2395
1684	sub inv_recursive_;	2396	sub inv_recursive_;
1685	sub inv_recursive_ {	2397	sub inv_recursive_ {
…		…
1688		2400
1689	sub inv_recursive {	2401	sub inv_recursive {
1690	inv_recursive_ inv $_[0]	2402	inv_recursive_ inv $_[0]
1691	}	2403	}
1692		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
1693	package cf;	2433	package cf;
1694		2434
1695	=back	2435	=back
1696		2436
1697	=head3 cf::object::player	2437	=head3 cf::object::player
…		…
1703	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>
1704	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
1705	dialogue with the given NPC character.	2445	dialogue with the given NPC character.
1706		2446
1707	=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	};
1708		2462
1709	# rough implementation of a future "reply" method that works	2463	# rough implementation of a future "reply" method that works
1710	# with dialog boxes.	2464	# with dialog boxes.
1711	#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
1712	sub cf::object::player::reply($$$;$) {	2466	sub cf::object::player::reply($$$;$) {
…		…
1714		2468
1715	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2469	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1716		2470
1717	if ($self->{record_replies}) {	2471	if ($self->{record_replies}) {
1718	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2472	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2473
1719	} 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 {
1720	$msg = $npc->name . " says: $msg" if $npc;	2482	$msg = $npc->name . " says: $msg" if $npc;
1721	$self->message ($msg, $flags);	2483	$self->send_msg ($SAY_CHANNEL => $msg, $flags);
		2484	}
1722	}	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 (@_);
1723	}	2496	}
1724		2497
1725	=item $player_object->may ("access")	2498	=item $player_object->may ("access")
1726		2499
1727	Returns wether the given player is authorized to access resource "access"	2500	Returns wether the given player is authorized to access resource "access"
…		…
1740		2513
1741	=item $player_object->enter_link	2514	=item $player_object->enter_link
1742		2515
1743	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}>).
1744		2517
1745	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.
1746	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.
1747		2522
1748	Will never block.	2523	Will never block.
1749		2524
1750	=item $player_object->leave_link ($map, $x, $y)	2525	=item $player_object->leave_link ($map, $x, $y)
1751		2526
…		…
1774	$self->deactivate_recursive;	2549	$self->deactivate_recursive;
1775		2550
1776	return if UNIVERSAL::isa $self->map, "ext::map_link";	2551	return if UNIVERSAL::isa $self->map, "ext::map_link";
1777		2552
1778	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2553	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1779	if $self->map;	2554	if $self->map && $self->map->{path} ne "{link}";
1780		2555
1781	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2556	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1782	}	2557	}
1783		2558
1784	sub cf::object::player::leave_link {	2559	sub cf::object::player::leave_link {
1785	my ($self, $map, $x, $y) = @_;	2560	my ($self, $map, $x, $y) = @_;
		2561
		2562	return unless $self->contr->active;
1786		2563
1787	my $link_pos = delete $self->{_link_pos};	2564	my $link_pos = delete $self->{_link_pos};
1788		2565
1789	unless ($map) {	2566	unless ($map) {
1790	# restore original map position	2567	# restore original map position
…		…
1801	($x, $y) = (-1, -1)	2578	($x, $y) = (-1, -1)
1802	unless (defined $x) && (defined $y);	2579	unless (defined $x) && (defined $y);
1803		2580
1804	# use -1 or undef as default coordinates, not 0, 0	2581	# use -1 or undef as default coordinates, not 0, 0
1805	($x, $y) = ($map->enter_x, $map->enter_y)	2582	($x, $y) = ($map->enter_x, $map->enter_y)
1806	if $x <=0 && $y <= 0;	2583	if $x <= 0 && $y <= 0;
1807		2584
1808	$map->load;	2585	$map->load;
1809	$map->load_diag;	2586	$map->load_neighbours;
1810		2587
1811	return unless $self->contr->active;	2588	return unless $self->contr->active;
		2589
		2590	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		2591	$self->enter_map ($map, $x, $y);
		2592
		2593	# only activate afterwards, to support waiting in hooks
1812	$self->activate_recursive;	2594	$self->activate_recursive;
1813	$self->enter_map ($map, $x, $y);
1814	}	2595	}
1815		2596
1816	cf::player->attach (	2597	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1817	on_logout => sub {
1818	my ($pl) = @_;
1819		2598
1820	# abort map switching before logout	2599	Moves the player to the given map-path and coordinates by first freezing
1821	if ($pl->ob->{_link_pos}) {	2600	her, loading and preparing them map, calling the provided $check callback
1822	cf::sync_job {	2601	that has to return the map if sucecssful, and then unfreezes the player on
1823	$pl->ob->leave_link	2602	the new (success) or old (failed) map position. In either case, $done will
1824	};	2603	be called at the end of this process.
1825	}
1826	},
1827	on_login => sub {
1828	my ($pl) = @_;
1829		2604
1830	# try to abort aborted map switching on player login :)	2605	Note that $check will be called with a potentially non-loaded map, so if
1831	# should happen only on crashes	2606	it needs a loaded map it has to call C<< ->load >>.
1832	if ($pl->ob->{_link_pos}) {
1833	$pl->ob->enter_link;
1834	(async {
1835	# we need this sleep as the login has a concurrent enter_exit running
1836	# and this sleep increases chances of the player not ending up in scorn
1837	$pl->ob->reply (undef,
1838	"There was an internal problem at your last logout, "
1839	. "the server will try to bring you to your intended destination in a second.",
1840	cf::NDI_RED);
1841	Coro::Timer::sleep 1;
1842	$pl->ob->leave_link;
1843	})->prio (2);
1844	}
1845	},
1846	);
1847		2607
1848	=item $player_object->goto ($path, $x, $y)
1849
1850	=cut	2608	=cut
		2609
		2610	our $GOTOGEN;
1851		2611
1852	sub cf::object::player::goto {	2612	sub cf::object::player::goto {
1853	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;
1854		2617
1855	$self->enter_link;	2618	$self->enter_link;
1856		2619
1857	(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
1858	my $map = eval {	2642	my $map = eval {
1859	my $map = cf::map::find $path;	2643	my $map = defined $path ? cf::map::find $path : undef;
		2644
		2645	if ($map) {
1860	$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
1861	$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 $@;
1862	} or	2658	}
1863	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864		2659
		2660	if ($gen == $self->{_goto_generation}) {
		2661	delete $self->{_goto_generation};
1865	$self->leave_link ($map, $x, $y);	2662	$self->leave_link ($map, $x, $y);
		2663	}
		2664
		2665	$done->() if $done;
1866	})->prio (1);	2666	})->prio (1);
1867	}	2667	}
1868		2668
1869	=item $player_object->enter_exit ($exit_object)	2669	=item $player_object->enter_exit ($exit_object)
1870		2670
…		…
1890	}	2690	}
1891		2691
1892	sub prepare_random_map {	2692	sub prepare_random_map {
1893	my ($exit) = @_;	2693	my ($exit) = @_;
1894		2694
1895	my $guard = cf::lock_acquire "exit_prepare:$exit";
1896
1897	# all this does is basically replace the /! path by	2695	# all this does is basically replace the /! path by
1898	# a new random map path (?random/...) with a seed	2696	# a new random map path (?random/...) with a seed
1899	# that depends on the exit object	2697	# that depends on the exit object
1900		2698
1901	my $rmp = parse_random_map_params $exit->msg;	2699	my $rmp = parse_random_map_params $exit->msg;
…		…
1903	if ($exit->map) {	2701	if ($exit->map) {
1904	$rmp->{region} = $exit->region->name;	2702	$rmp->{region} = $exit->region->name;
1905	$rmp->{origin_map} = $exit->map->path;	2703	$rmp->{origin_map} = $exit->map->path;
1906	$rmp->{origin_x} = $exit->x;	2704	$rmp->{origin_x} = $exit->x;
1907	$rmp->{origin_y} = $exit->y;	2705	$rmp->{origin_y} = $exit->y;
		2706
		2707	$exit->map->touch;
1908	}	2708	}
1909		2709
1910	$rmp->{random_seed} ||= $exit->random_seed;	2710	$rmp->{random_seed} ||= $exit->random_seed;
1911		2711
1912	my $data = cf::to_json $rmp;	2712	my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1913	my $md5 = Digest::MD5::md5_hex $data;	2713	my $md5 = Digest::MD5::md5_hex $data;
1914	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2714	my $meta = "$RANDOMDIR/$md5.meta";
1915		2715
1916	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2716	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917	aio_write $fh, 0, (length $data), $data, 0;	2717	aio_write $fh, 0, (length $data), $data, 0;
1918	undef $fh;	2718	undef $fh;
1919	aio_rename "$meta~", $meta;	2719	aio_rename "$meta~", $meta;
1920		2720
		2721	my $slaying = "?random/$md5";
		2722
		2723	if ($exit->valid) {
1921	$exit->slaying ("?random/$md5");	2724	$exit->slaying ("?random/$md5");
1922	$exit->msg (undef);	2725	$exit->msg (undef);
		2726	}
1923	}	2727	}
1924	}	2728	}
1925		2729
1926	sub cf::object::player::enter_exit {	2730	sub cf::object::player::enter_exit {
1927	my ($self, $exit) = @_;	2731	my ($self, $exit) = @_;
1928		2732
1929	return unless $self->type == cf::PLAYER;	2733	return unless $self->type == cf::PLAYER;
1930		2734
1931	if ($exit->slaying eq "/!") {
1932	#TODO: this should de-fi-ni-te-ly not be a sync-job
1933	cf::sync_job { prepare_random_map $exit };
1934	}
1935
1936	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1937	my $hp = $exit->stats->hp;
1938	my $sp = $exit->stats->sp;
1939
1940	$self->enter_link;	2735	$self->enter_link;
1941		2736
1942	(async {	2737	(async {
1943	$self->deactivate_recursive; # just to be sure	2738	$Coro::current->{desc} = "enter_exit";
		2739
1944	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
1945	$self->goto ($slaying, $hp, $sp);	2755	$self->goto ($map, $x, $y);
1946		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
1947	1;	2761	1
1948	}) {	2762	}) {
1949	$self->message ("Something went wrong deep within the crossfire server. "	2763	$self->message ("Something went wrong deep within the deliantra server. "
1950	. "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. "
1951	. "Please report this to the dungeon master!",	2765	. "Please report this to the dungeon master!",
1952	cf::NDI_UNIQUE | cf::NDI_RED);	2766	cf::NDI_UNIQUE | cf::NDI_RED);
1953		2767
1954	warn "ERROR in enter_exit: $@";	2768	warn "ERROR in enter_exit: $@";
1955	$self->leave_link;	2769	$self->leave_link;
1956	}	2770	}
1957	})->prio (1);	2771	})->prio (1);
…		…
1970		2784
1971	sub cf::client::send_drawinfo {	2785	sub cf::client::send_drawinfo {
1972	my ($self, $text, $flags) = @_;	2786	my ($self, $text, $flags) = @_;
1973		2787
1974	utf8::encode $text;	2788	utf8::encode $text;
1975	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2789	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976	}	2790	}
1977		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	}
1978		3013
1979	=item $success = $client->query ($flags, "text", \&cb)	3014	=item $success = $client->query ($flags, "text", \&cb)
1980		3015
1981	Queues a query to the client, calling the given callback with	3016	Queues a query to the client, calling the given callback with
1982	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>,
1983	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>.
1984		3019
1985	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
1986	reliable at some point in the future.	3021	become reliable at some point in the future.
1987		3022
1988	=cut	3023	=cut
1989		3024
1990	sub cf::client::query {	3025	sub cf::client::query {
1991	my ($self, $flags, $text, $cb) = @_;	3026	my ($self, $flags, $text, $cb) = @_;
…		…
1999	utf8::encode $text;	3034	utf8::encode $text;
2000	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	3035	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001		3036
2002	$self->send_packet ($self->{query_queue}[0][0])	3037	$self->send_packet ($self->{query_queue}[0][0])
2003	if @{ $self->{query_queue} } == 1;	3038	if @{ $self->{query_queue} } == 1;
		3039
		3040	1
2004	}	3041	}
2005		3042
2006	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	},
2007	on_reply => sub {	3049	on_reply => sub {
2008	my ($ns, $msg) = @_;	3050	my ($ns, $msg) = @_;
2009		3051
2010	# this weird shuffling is so that direct followup queries	3052	# this weird shuffling is so that direct followup queries
2011	# get handled first	3053	# get handled first
…		…
2023	} else {	3065	} else {
2024	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	3066	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025	}	3067	}
2026	}	3068	}
2027	},	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	},
2028	);	3096	);
2029		3097
2030	=item $client->async (\&cb)	3098	=item $client->async (\&cb)
2031		3099
2032	Create a new coroutine, running the specified callback. The coroutine will	3100	Create a new coroutine, running the specified callback. The coroutine will
…		…
2073	our $safe = new Safe "safe";	3141	our $safe = new Safe "safe";
2074	our $safe_hole = new Safe::Hole;	3142	our $safe_hole = new Safe::Hole;
2075		3143
2076	$SIG{FPE} = 'IGNORE';	3144	$SIG{FPE} = 'IGNORE';
2077		3145
2078	$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	));
2079		3151
2080	# here we export the classes and methods available to script code	3152	# here we export the classes and methods available to script code
2081		3153
2082	=pod	3154	=pod
2083		3155
2084	The following fucntions and emthods are available within a safe environment:	3156	The following functions and methods are available within a safe environment:
2085		3157
2086	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
2087	cf::object::player player	3163	cf::object::player
2088	cf::player peaceful	3164	player
2089	cf::map trigger	3165
		3166	cf::player
		3167	peaceful
		3168
		3169	cf::map
		3170	trigger
2090		3171
2091	=cut	3172	=cut
2092		3173
2093	for (	3174	for (
2094	["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)],
2095	["cf::object::player" => qw(player)],	3178	["cf::object::player" => qw(player)],
2096	["cf::player" => qw(peaceful)],	3179	["cf::player" => qw(peaceful send_msg)],
2097	["cf::map" => qw(trigger)],	3180	["cf::map" => qw(trigger)],
2098	) {	3181	) {
2099	no strict 'refs';	3182	no strict 'refs';
2100	my ($pkg, @funs) = @$_;	3183	my ($pkg, @funs) = @$_;
2101	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	3184	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
…		…
2118	my ($code, %vars) = @_;	3201	my ($code, %vars) = @_;
2119		3202
2120	my $qcode = $code;	3203	my $qcode = $code;
2121	$qcode =~ s/"/‟/g; # not allowed in #line filenames	3204	$qcode =~ s/"/‟/g; # not allowed in #line filenames
2122	$qcode =~ s/\n/\\n/g;	3205	$qcode =~ s/\n/\\n/g;
		3206
		3207	%vars = (_dummy => 0) unless %vars;
2123		3208
2124	local $_;	3209	local $_;
2125	local @safe::cf::_safe_eval_args = values %vars;	3210	local @safe::cf::_safe_eval_args = values %vars;
2126		3211
2127	my $eval =	3212	my $eval =
…		…
2170	=back	3255	=back
2171		3256
2172	=cut	3257	=cut
2173		3258
2174	#############################################################################	3259	#############################################################################
2175
2176	=head2 EXTENSION DATABASE SUPPORT
2177
2178	Crossfire maintains a very simple database for extension use. It can
2179	currently store anything that can be serialised using Storable, which
2180	excludes objects.
2181
2182	The parameter C<$family> should best start with the name of the extension
2183	using it, it should be unique.
2184
2185	=over 4
2186
2187	=item $hashref = cf::db_get $family
2188
2189	Return a hashref for use by the extension C<$family>, which can be
2190	modified. After modifications, you have to call C<cf::db_dirty> or
2191	C<cf::db_sync>.
2192
2193	=item $value = cf::db_get $family => $key
2194
2195	Returns a single value from the database
2196
2197	=item cf::db_put $family => $hashref
2198
2199	Stores the given family hashref into the database. Updates are delayed, if
2200	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2201
2202	=item cf::db_put $family => $key => $value
2203
2204	Stores the given C<$value> in the family hash. Updates are delayed, if you
2205	want the data to be synced to disk immediately, use C<cf::db_sync>.
2206
2207	=item cf::db_dirty
2208
2209	Marks the database as dirty, to be updated at a later time.
2210
2211	=item cf::db_sync
2212
2213	Immediately write the database to disk I<if it is dirty>.
2214
2215	=cut
2216
2217	our $DB;
2218
2219	{
2220	my $path = cf::localdir . "/database.pst";
2221
2222	sub db_load() {
2223	$DB = stat $path ? Storable::retrieve $path : { };
2224	}
2225
2226	my $pid;
2227
2228	sub db_save() {
2229	waitpid $pid, 0 if $pid;
2230	if (0 == ($pid = fork)) {
2231	$DB->{_meta}{version} = 1;
2232	Storable::nstore $DB, "$path~";
2233	rename "$path~", $path;
2234	cf::_exit 0 if defined $pid;
2235	}
2236	}
2237
2238	my $dirty;
2239
2240	sub db_sync() {
2241	db_save if $dirty;
2242	undef $dirty;
2243	}
2244
2245	my $idle = Event->idle (
2246	reentrant => 0,
2247	min => 10,
2248	max => 20,
2249	repeat => 0,
2250	data => WF_AUTOCANCEL,
2251	cb => \&db_sync,
2252	);
2253
2254	sub db_dirty() {
2255	$dirty = 1;
2256	$idle->start;
2257	}
2258
2259	sub db_get($;$) {
2260	@_ >= 2
2261	? $DB->{$_[0]}{$_[1]}
2262	: ($DB->{$_[0]} ||= { })
2263	}
2264
2265	sub db_put($$;$) {
2266	if (@_ >= 3) {
2267	$DB->{$_[0]}{$_[1]} = $_[2];
2268	} else {
2269	$DB->{$_[0]} = $_[1];
2270	}
2271	db_dirty;
2272	}
2273
2274	cf::global->attach (
2275	prio => 10000,
2276	on_cleanup => sub {
2277	db_sync;
2278	},
2279	);
2280	}
2281
2282	#############################################################################
2283	# the server's init and main functions	3260	# the server's init and main functions
2284		3261
		3262	sub load_facedata($) {
		3263	my ($path) = @_;
		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
		3271	warn "loading facedata from $path\n";
		3272
		3273	my $facedata;
		3274	0 < aio_load $path, $facedata
		3275	or die "$path: $!";
		3276
		3277	$facedata = Coro::Storable::thaw $facedata;
		3278
		3279	$facedata->{version} == 2
		3280	or cf::cleanup "$path: version mismatch, cannot proceed.";
		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
		3292	while (my ($face, $info) = each %$faces) {
		3293	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		3294
		3295	cf::face::set_visibility $idx, $info->{visibility};
		3296	cf::face::set_magicmap $idx, $info->{magicmap};
		3297	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		3298	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
		3299
		3300	cf::cede_to_tick;
		3301	}
		3302
		3303	while (my ($face, $info) = each %$faces) {
		3304	next unless $info->{smooth};
		3305
		3306	my $idx = cf::face::find $face
		3307	or next;
		3308
		3309	if (my $smooth = cf::face::find $info->{smooth}) {
		3310	cf::face::set_smooth $idx, $smooth;
		3311	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3312	} else {
		3313	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3314	}
		3315
		3316	cf::cede_to_tick;
		3317	}
		3318	}
		3319
		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);
		3365
		3366	1
		3367	}
		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
2285	sub load_resources {	3397	sub load_resource_file($) {
2286	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	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"
2287	or die "unable to load regions file\n";#d#	3413	or die "unable to load regions file\n";
2288	}
2289		3414
2290	sub cfg_load {	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
		3436	sub reload_resources {
		3437	warn "reloading resource files...\n";
		3438
		3439	reload_facedata;
		3440	reload_archetypes;
		3441	reload_regions;
		3442	reload_treasures;
		3443
		3444	warn "finished reloading resource files\n";
		3445	}
		3446
		3447	sub reload_config {
		3448	warn "reloading config file...\n";
		3449
2291	open my $fh, "<:utf8", cf::confdir . "/config"	3450	open my $fh, "<:utf8", "$CONFDIR/config"
2292	or return;	3451	or return;
2293		3452
2294	local $/;	3453	local $/;
2295	*CFG = YAML::Syck::Load <$fh>;	3454	*CFG = YAML::XS::Load scalar <$fh>;
2296		3455
2297	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3456	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2298		3457
2299	$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};
2300	$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};
…		…
2304	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3463	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2305	and die "WARNING: m(un)lockall failed: $!\n";	3464	and die "WARNING: m(un)lockall failed: $!\n";
2306	};	3465	};
2307	warn $@ if $@;	3466	warn $@ if $@;
2308	}	3467	}
2309	}
2310		3468
2311	sub init {	3469	warn "finished reloading resource files\n";
2312	load_resources;	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;
2313	}	3498	}
2314		3499
2315	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
2316	# we must not ever block the main coroutine	3515	# we must not ever block the main coroutine
2317	local $Coro::idle = sub {	3516	local $Coro::idle = sub {
2318	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#
2319	(async {	3518	(async {
2320	Event::one_event;	3519	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3520	EV::loop EV::LOOP_ONESHOT;
2321	})->prio (Coro::PRIO_MAX);	3521	})->prio (Coro::PRIO_MAX);
2322	};	3522	};
2323		3523
2324	cfg_load;	3524	evthread_start IO::AIO::poll_fileno;
2325	db_load;	3525
		3526	cf::sync_job {
		3527	reload_resources;
		3528	reload_config;
		3529	db_init;
		3530
		3531	cf::load_settings;
		3532	cf::load_materials;
		3533	cf::init_uuid;
		3534	cf::init_signals;
		3535	cf::init_commands;
		3536	cf::init_skills;
		3537
		3538	cf::init_beforeplay;
		3539
		3540	atomic;
		3541
2326	load_extensions;	3542	load_extensions;
2327		3543
2328	$TICK_WATCHER->start;	3544	utime time, time, $RUNTIMEFILE;
2329	Event::loop;	3545
		3546	# no (long-running) fork's whatsoever before this point(!)
		3547	use POSIX ();
		3548	POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
		3549
		3550	(pop @POST_INIT)->(0) while @POST_INIT;
		3551	};
		3552
		3553	main_loop;
2330	}	3554	}
2331		3555
2332	#############################################################################	3556	#############################################################################
2333	# initialisation and cleanup	3557	# initialisation and cleanup
2334		3558
2335	# install some emergency cleanup handlers	3559	# install some emergency cleanup handlers
2336	BEGIN {	3560	BEGIN {
		3561	our %SIGWATCHER = ();
2337	for my $signal (qw(INT HUP TERM)) {	3562	for my $signal (qw(INT HUP TERM)) {
2338	Event->signal (	3563	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2339	reentrant => 0,
2340	data => WF_AUTOCANCEL,
2341	signal => $signal,
2342	prio => 0,
2343	cb => sub {
2344	cf::cleanup "SIG$signal";	3564	cf::cleanup "SIG$signal";
2345	},
2346	);	3565	};
		3566	}
		3567	}
		3568
		3569	sub write_runtime_sync {
		3570	# first touch the runtime file to show we are still running:
		3571	# the fsync below can take a very very long time.
		3572
		3573	IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
		3574
		3575	my $guard = cf::lock_acquire "write_runtime";
		3576
		3577	my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
		3578	or return;
		3579
		3580	my $value = $cf::RUNTIME + 90 + 10;
		3581	# 10 is the runtime save interval, for a monotonic clock
		3582	# 60 allows for the watchdog to kill the server.
		3583
		3584	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3585	and return;
		3586
		3587	# always fsync - this file is important
		3588	aio_fsync $fh
		3589	and return;
		3590
		3591	# touch it again to show we are up-to-date
		3592	aio_utime $fh, undef, undef;
		3593
		3594	close $fh
		3595	or return;
		3596
		3597	aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
		3598	and return;
		3599
		3600	warn "runtime file written.\n";
		3601
2347	}	3602	1
		3603	}
		3604
		3605	our $uuid_lock;
		3606	our $uuid_skip;
		3607
		3608	sub write_uuid_sync($) {
		3609	$uuid_skip ||= $_[0];
		3610
		3611	return if $uuid_lock;
		3612	local $uuid_lock = 1;
		3613
		3614	my $uuid = "$LOCALDIR/uuid";
		3615
		3616	my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
		3617	or return;
		3618
		3619	my $value = uuid_seq uuid_cur;
		3620
		3621	unless ($value) {
		3622	warn "cowardly refusing to write zero uuid value!\n";
		3623	return;
		3624	}
		3625
		3626	my $value = uuid_str $value + $uuid_skip;
		3627	$uuid_skip = 0;
		3628
		3629	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3630	and return;
		3631
		3632	# always fsync - this file is important
		3633	aio_fsync $fh
		3634	and return;
		3635
		3636	close $fh
		3637	or return;
		3638
		3639	aio_rename "$uuid~", $uuid
		3640	and return;
		3641
		3642	warn "uuid file written ($value).\n";
		3643
		3644	1
		3645
		3646	}
		3647
		3648	sub write_uuid($$) {
		3649	my ($skip, $sync) = @_;
		3650
		3651	$sync ? write_uuid_sync $skip
		3652	: async { write_uuid_sync $skip };
2348	}	3653	}
2349		3654
2350	sub emergency_save() {	3655	sub emergency_save() {
2351	my $freeze_guard = cf::freeze_mainloop;	3656	my $freeze_guard = cf::freeze_mainloop;
2352		3657
2353	warn "enter emergency perl save\n";	3658	warn "emergency_perl_save: enter\n";
2354		3659
2355	cf::sync_job {	3660	cf::sync_job {
		3661	# this is a trade-off: we want to be very quick here, so
		3662	# save all maps without fsync, and later call a global sync
		3663	# (which in turn might be very very slow)
		3664	local $USE_FSYNC = 0;
		3665
2356	# use a peculiar iteration method to avoid tripping on perl	3666	# use a peculiar iteration method to avoid tripping on perl
2357	# refcount bugs in for. also avoids problems with players	3667	# refcount bugs in for. also avoids problems with players
2358	# and maps saved/destroyed asynchronously.	3668	# and maps saved/destroyed asynchronously.
2359	warn "begin emergency player save\n";	3669	warn "emergency_perl_save: begin player save\n";
2360	for my $login (keys %cf::PLAYER) {	3670	for my $login (keys %cf::PLAYER) {
2361	my $pl = $cf::PLAYER{$login} or next;	3671	my $pl = $cf::PLAYER{$login} or next;
2362	$pl->valid or next;	3672	$pl->valid or next;
		3673	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2363	$pl->save;	3674	$pl->save;
2364	}	3675	}
2365	warn "end emergency player save\n";	3676	warn "emergency_perl_save: end player save\n";
2366		3677
2367	warn "begin emergency map save\n";	3678	warn "emergency_perl_save: begin map save\n";
2368	for my $path (keys %cf::MAP) {	3679	for my $path (keys %cf::MAP) {
2369	my $map = $cf::MAP{$path} or next;	3680	my $map = $cf::MAP{$path} or next;
2370	$map->valid or next;	3681	$map->valid or next;
2371	$map->save;	3682	$map->save;
2372	}	3683	}
2373	warn "end emergency map save\n";	3684	warn "emergency_perl_save: end map save\n";
		3685
		3686	warn "emergency_perl_save: begin database checkpoint\n";
		3687	BDB::db_env_txn_checkpoint $DB_ENV;
		3688	warn "emergency_perl_save: end database checkpoint\n";
		3689
		3690	warn "emergency_perl_save: begin write uuid\n";
		3691	write_uuid_sync 1;
		3692	warn "emergency_perl_save: end write uuid\n";
2374	};	3693	};
2375		3694
		3695	warn "emergency_perl_save: starting sync()\n";
		3696	IO::AIO::aio_sync sub {
		3697	warn "emergency_perl_save: finished sync()\n";
		3698	};
		3699
2376	warn "leave emergency perl save\n";	3700	warn "emergency_perl_save: leave\n";
2377	}	3701	}
2378		3702
		3703	sub post_cleanup {
		3704	my ($make_core) = @_;
		3705
		3706	warn Carp::longmess "post_cleanup backtrace"
		3707	if $make_core;
		3708
		3709	my $fh = pidfile;
		3710	unlink $PIDFILE if <$fh> == $$;
		3711	}
		3712
		3713	# a safer delete_package, copied from Symbol
		3714	sub clear_package($) {
		3715	my $pkg = shift;
		3716
		3717	# expand to full symbol table name if needed
		3718	unless ($pkg =~ /^main::.*::$/) {
		3719	$pkg = "main$pkg" if $pkg =~ /^::/;
		3720	$pkg = "main::$pkg" unless $pkg =~ /^main::/;
		3721	$pkg .= '::' unless $pkg =~ /::$/;
		3722	}
		3723
		3724	my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
		3725	my $stem_symtab = *{$stem}{HASH};
		3726
		3727	defined $stem_symtab and exists $stem_symtab->{$leaf}
		3728	or return;
		3729
		3730	# clear all symbols
		3731	my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
		3732	for my $name (keys %$leaf_symtab) {
		3733	_gv_clear *{"$pkg$name"};
		3734	# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
		3735	}
		3736	warn "cleared package $pkg\n";#d#
		3737	}
		3738
2379	sub reload() {	3739	sub do_reload_perl() {
2380	# can/must only be called in main	3740	# can/must only be called in main
2381	if ($Coro::current != $Coro::main) {	3741	if ($Coro::current != $Coro::main) {
2382	warn "can only reload from main coroutine";	3742	warn "can only reload from main coroutine";
2383	return;	3743	return;
2384	}	3744	}
2385		3745
		3746	return if $RELOAD++;
		3747
		3748	my $t1 = EV::time;
		3749
		3750	while ($RELOAD) {
2386	warn "reloading...";	3751	warn "reloading...";
2387		3752
2388	warn "cancelling server ticker";	3753	warn "entering sync_job";
2389	$TICK_WATCHER->cancel;
2390		3754
		3755	cf::sync_job {
		3756	cf::write_runtime_sync; # external watchdog should not bark
2391	cf::emergency_save;	3757	cf::emergency_save;
		3758	cf::write_runtime_sync; # external watchdog should not bark
2392		3759
2393	eval {	3760	warn "syncing database to disk";
		3761	BDB::db_env_txn_checkpoint $DB_ENV;
		3762
2394	# if anything goes wrong in here, we should simply crash as we already saved	3763	# if anything goes wrong in here, we should simply crash as we already saved
2395		3764
2396	warn "syncing database to disk";
2397	cf::db_sync;
2398
2399	warn "cancelling all WF_AUTOCANCEL watchers";
2400	for (Event::all_watchers) {
2401	$_->cancel if $_->data & WF_AUTOCANCEL;
2402	}
2403
2404	warn "flushing outstanding aio requests";	3765	warn "flushing outstanding aio requests";
2405	for (;;) {	3766	while (IO::AIO::nreqs || BDB::nreqs) {
2406	IO::AIO::flush;	3767	Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2407	Coro::cede;
2408	last unless IO::AIO::nreqs;
2409	warn "iterate...";
2410	}
2411
2412	warn "cancelling all extension coros";
2413	$_->cancel for values %EXT_CORO;
2414	%EXT_CORO = ();
2415
2416	warn "removing commands";
2417	%COMMAND = ();
2418
2419	warn "removing ext commands";
2420	%EXTCMD = ();
2421
2422	warn "unloading/nuking all extensions";
2423	for my $pkg (@EXTS) {
2424	warn "... unloading $pkg";
2425
2426	if (my $cb = $pkg->can ("unload")) {
2427	eval {
2428	$cb->($pkg);
2429	1
2430	} or warn "$pkg unloaded, but with errors: $@";
2431	}	3768	}
2432		3769
2433	warn "... nuking $pkg";	3770	warn "cancelling all extension coros";
2434	Symbol::delete_package $pkg;	3771	$_->cancel for values %EXT_CORO;
2435	}	3772	%EXT_CORO = ();
2436		3773
2437	warn "unloading all perl modules loaded from $LIBDIR";	3774	warn "removing commands";
2438	while (my ($k, $v) = each %INC) {	3775	%COMMAND = ();
2439	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2440		3776
		3777	warn "removing ext/exti commands";
		3778	%EXTCMD = ();
		3779	%EXTICMD = ();
		3780
		3781	warn "unloading/nuking all extensions";
		3782	for my $pkg (@EXTS) {
2441	warn "... unloading $k";	3783	warn "... unloading $pkg";
2442	delete $INC{$k};
2443		3784
2444	$k =~ s/\.pm$//;
2445	$k =~ s/\//::/g;
2446
2447	if (my $cb = $k->can ("unload_module")) {	3785	if (my $cb = $pkg->can ("unload")) {
		3786	eval {
2448	$cb->();	3787	$cb->($pkg);
		3788	1
		3789	} or warn "$pkg unloaded, but with errors: $@";
		3790	}
		3791
		3792	warn "... clearing $pkg";
		3793	clear_package $pkg;
2449	}	3794	}
2450		3795
2451	Symbol::delete_package $k;	3796	warn "unloading all perl modules loaded from $LIBDIR";
		3797	while (my ($k, $v) = each %INC) {
		3798	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		3799
		3800	warn "... unloading $k";
		3801	delete $INC{$k};
		3802
		3803	$k =~ s/\.pm$//;
		3804	$k =~ s/\//::/g;
		3805
		3806	if (my $cb = $k->can ("unload_module")) {
		3807	$cb->();
		3808	}
		3809
		3810	clear_package $k;
2452	}	3811	}
2453		3812
2454	warn "getting rid of safe::, as good as possible";	3813	warn "getting rid of safe::, as good as possible";
2455	Symbol::delete_package "safe::$_"	3814	clear_package "safe::$_"
2456	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3815	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2457		3816
2458	warn "unloading cf.pm \"a bit\"";	3817	warn "unloading cf.pm \"a bit\"";
2459	delete $INC{"cf.pm"};	3818	delete $INC{"cf.pm"};
		3819	delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2460		3820
2461	# don't, removes xs symbols, too,	3821	# don't, removes xs symbols, too,
2462	# and global variables created in xs	3822	# and global variables created in xs
2463	#Symbol::delete_package __PACKAGE__;	3823	#clear_package __PACKAGE__;
2464		3824
2465	warn "unload completed, starting to reload now";	3825	warn "unload completed, starting to reload now";
2466		3826
2467	warn "reloading cf.pm";	3827	warn "reloading cf.pm";
2468	require cf;	3828	require cf;
2469	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3829	cf::_connect_to_perl_1;
2470		3830
2471	warn "loading config and database again";	3831	warn "loading config and database again";
2472	cf::cfg_load;	3832	cf::reload_config;
2473	cf::db_load;
2474		3833
2475	warn "loading extensions";	3834	warn "loading extensions";
2476	cf::load_extensions;	3835	cf::load_extensions;
2477		3836
		3837	if ($REATTACH_ON_RELOAD) {
2478	warn "reattaching attachments to objects/players";	3838	warn "reattaching attachments to objects/players";
2479	_global_reattach;	3839	_global_reattach; # objects, sockets
2480	warn "reattaching attachments to maps";	3840	warn "reattaching attachments to maps";
2481	reattach $_ for values %MAP;	3841	reattach $_ for values %MAP;
		3842	warn "reattaching attachments to players";
		3843	reattach $_ for values %PLAYER;
		3844	}
2482		3845
2483	warn "loading reloadable resources";	3846	warn "running post_init jobs";
2484	load_resources;	3847	(pop @POST_INIT)->(1) while @POST_INIT;
2485		3848
2486	warn "restarting server ticker";	3849	warn "leaving sync_job";
2487		3850
2488	$TICK_WATCHER->start;	3851	1
		3852	} or do {
		3853	warn $@;
		3854	cf::cleanup "error while reloading, exiting.";
		3855	};
		3856
		3857	warn "reloaded";
		3858	--$RELOAD;
		3859	}
		3860
		3861	$t1 = EV::time - $t1;
		3862	warn "reload completed in ${t1}s\n";
		3863	};
		3864
		3865	our $RELOAD_WATCHER; # used only during reload
		3866
		3867	sub reload_perl() {
		3868	# doing reload synchronously and two reloads happen back-to-back,
		3869	# coro crashes during coro_state_free->destroy here.
		3870
		3871	$RELOAD_WATCHER ||= cf::async {
		3872	Coro::AIO::aio_wait cache_extensions;
		3873
		3874	$RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
		3875	do_reload_perl;
		3876	undef $RELOAD_WATCHER;
		3877	};
2489	};	3878	};
2490		3879	}
2491	if ($@) {
2492	warn $@;
2493	warn "error while reloading, exiting.";
2494	exit 1;
2495	}
2496
2497	warn "reloaded";
2498	};
2499
2500	our $RELOAD_WATCHER; # used only during reload
2501		3880
2502	register_command "reload" => sub {	3881	register_command "reload" => sub {
2503	my ($who, $arg) = @_;	3882	my ($who, $arg) = @_;
2504		3883
2505	if ($who->flag (FLAG_WIZ)) {	3884	if ($who->flag (FLAG_WIZ)) {
2506	$who->message ("reloading server.");	3885	$who->message ("reloading server.");
2507		3886	async {
2508	# doing reload synchronously and two reloads happen back-to-back,	3887	$Coro::current->{desc} = "perl_reload";
2509	# coro crashes during coro_state_free->destroy here.
2510
2511	$RELOAD_WATCHER ||= Event->timer (
2512	reentrant => 0,
2513	after => 0,
2514	data => WF_AUTOCANCEL,
2515	cb => sub {
2516	reload;	3888	reload_perl;
2517	undef $RELOAD_WATCHER;
2518	},
2519	);	3889	};
2520	}	3890	}
2521	};	3891	};
2522		3892
2523	unshift @INC, $LIBDIR;	3893	unshift @INC, $LIBDIR;
2524		3894
2525	my $bug_warning = 0;	3895	my $bug_warning = 0;
2526		3896
2527	$TICK_WATCHER = Event->timer (	3897	our @WAIT_FOR_TICK;
2528	reentrant => 0,	3898	our @WAIT_FOR_TICK_BEGIN;
2529	parked => 1,	3899
2530	prio => 0,	3900	sub wait_for_tick {
2531	at => $NEXT_TICK || $TICK,	3901	return if tick_inhibit || $Coro::current == $Coro::main;
2532	data => WF_AUTOCANCEL,	3902
2533	cb => sub {	3903	my $signal = new Coro::Signal;
		3904	push @WAIT_FOR_TICK, $signal;
		3905	$signal->wait;
		3906	}
		3907
		3908	sub wait_for_tick_begin {
		3909	return if tick_inhibit || $Coro::current == $Coro::main;
		3910
		3911	my $signal = new Coro::Signal;
		3912	push @WAIT_FOR_TICK_BEGIN, $signal;
		3913	$signal->wait;
		3914	}
		3915
		3916	sub tick {
2534	if ($Coro::current != $Coro::main) {	3917	if ($Coro::current != $Coro::main) {
2535	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3918	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2536	unless ++$bug_warning > 10;	3919	unless ++$bug_warning > 10;
2537	return;	3920	return;
2538	}	3921	}
2539		3922
2540	$NOW = Event::time;
2541
2542	cf::server_tick; # one server iteration	3923	cf::server_tick; # one server iteration
2543	$RUNTIME += $TICK;
2544	$NEXT_TICK += $TICK;
2545		3924
2546	$WAIT_FOR_TICK->broadcast;	3925	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2547	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3926	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
		3927	Coro::async_pool {
		3928	$Coro::current->{desc} = "runtime saver";
		3929	write_runtime_sync
		3930	or warn "ERROR: unable to write runtime file: $!";
		3931	};
		3932	}
2548		3933
2549	Event::sweep;	3934	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2550	Coro::cede_notself;	3935	$sig->send;
		3936	}
		3937	while (my $sig = shift @WAIT_FOR_TICK) {
		3938	$sig->send;
		3939	}
		3940
		3941	$LOAD = ($NOW - $TICK_START) / $TICK;
		3942	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3943
		3944	if (0) {
		3945	if ($NEXT_TICK) {
		3946	my $jitter = $TICK_START - $NEXT_TICK;
		3947	$JITTER = $JITTER * 0.75 + $jitter * 0.25;
		3948	warn "jitter $JITTER\n";#d#
2551		3949	}
2552	# my $AFTER = Event::time;
2553	# warn $AFTER - $NOW;#d#
2554
2555	# if we are delayed by four ticks or more, skip them all
2556	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2557
2558	$TICK_WATCHER->at ($NEXT_TICK);
2559	$TICK_WATCHER->start;
2560	},	3950	}
2561	);	3951	}
2562		3952
2563	{	3953	{
2564	BDB::max_poll_time $TICK * 0.1;	3954	# configure BDB
2565	$BDB_POLL_WATCHER = Event->io (	3955
2566	reentrant => 0,
2567	fd => BDB::poll_fileno,
2568	poll => 'r',
2569	prio => 0,
2570	data => WF_AUTOCANCEL,
2571	cb => \&BDB::poll_cb,
2572	);
2573	BDB::min_parallel 8;	3956	BDB::min_parallel 8;
2574		3957	BDB::max_poll_reqs $TICK * 0.1;
2575	BDB::set_sync_prepare {	3958	$AnyEvent::BDB::WATCHER->priority (1);
2576	my $status;
2577	my $current = $Coro::current;
2578	(
2579	sub {
2580	$status = $!;
2581	$current->ready; undef $current;
2582	},
2583	sub {
2584	Coro::schedule while defined $current;
2585	$! = $status;
2586	},
2587	)
2588	};
2589		3959
2590	unless ($DB_ENV) {	3960	unless ($DB_ENV) {
2591	$DB_ENV = BDB::db_env_create;	3961	$DB_ENV = BDB::db_env_create;
		3962	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
		3963	$DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
		3964	$DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
		3965	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3966	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2592		3967
2593	cf::sync_job {	3968	cf::sync_job {
		3969	eval {
2594	BDB::db_env_open	3970	BDB::db_env_open
2595	$DB_ENV,	3971	$DB_ENV,
2596	$BDB_ENV_DIR,	3972	$BDBDIR,
2597	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3973	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2598	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3974	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2599	0666;	3975	0666;
2600		3976
2601	cf::cleanup "$!" if $!;	3977	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2602		3978	};
2603	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3979
2604	$DB_ENV->set_lk_detect;	3980	cf::cleanup "db_env_open(db): $@" if $@;
2605	};	3981	};
2606	}	3982	}
		3983
		3984	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3985	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3986	};
		3987	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3988	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3989	};
		3990	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3991	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3992	};
2607	}	3993	}
2608		3994
2609	{	3995	{
		3996	# configure IO::AIO
		3997
2610	IO::AIO::min_parallel 8;	3998	IO::AIO::min_parallel 8;
2611
2612	undef $Coro::AIO::WATCHER;
2613	IO::AIO::max_poll_time $TICK * 0.1;	3999	IO::AIO::max_poll_time $TICK * 0.1;
2614	$AIO_POLL_WATCHER = Event->io (	4000	undef $AnyEvent::AIO::WATCHER;
2615	reentrant => 0,
2616	fd => IO::AIO::poll_fileno,
2617	poll => 'r',
2618	prio => 6,
2619	data => WF_AUTOCANCEL,
2620	cb => \&IO::AIO::poll_cb,
2621	);
2622	}	4001	}
2623		4002
2624	$WRITE_RUNTIME_WATCHER = Event->timer (	4003	my $_log_backtrace;
2625	reentrant => 0,	4004
2626	data => WF_AUTOCANCEL,	4005	sub _log_backtrace {
2627	after => 1,	4006	my ($msg, @addr) = @_;
2628	interval => 10,	4007
2629	prio => 6, # keep it lowest so it acts like a watchdog	4008	$msg =~ s/\n//;
2630	cb => Coro::unblock_sub {	4009
2631	write_runtime	4010	# limit the # of concurrent backtraces
2632	or warn "ERROR: unable to write runtime file: $!";	4011	if ($_log_backtrace < 2) {
		4012	++$_log_backtrace;
		4013	my $perl_bt = Carp::longmess $msg;
		4014	async {
		4015	$Coro::current->{desc} = "abt $msg";
		4016
		4017	my @bt = fork_call {
		4018	@addr = map { sprintf "%x", $_ } @addr;
		4019	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		4020	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		4021	or die "addr2line: $!";
		4022
		4023	my @funcs;
		4024	my @res = <$fh>;
		4025	chomp for @res;
		4026	while (@res) {
		4027	my ($func, $line) = splice @res, 0, 2, ();
		4028	push @funcs, "[$func] $line";
		4029	}
		4030
		4031	@funcs
		4032	};
		4033
		4034	LOG llevInfo, "[ABT] $perl_bt\n";
		4035	LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
		4036	LOG llevInfo, "[ABT] $_\n" for @bt;
		4037	--$_log_backtrace;
		4038	};
		4039	} else {
		4040	LOG llevInfo, "[ABT] $msg\n";
		4041	LOG llevInfo, "[ABT] [suppressed]\n";
2633	},	4042	}
2634	);	4043	}
		4044
		4045	# load additional modules
		4046	require "cf/$_.pm" for @EXTRA_MODULES;
		4047	cf::_connect_to_perl_2;
2635		4048
2636	END { cf::emergency_save }	4049	END { cf::emergency_save }
2637		4050
2638	1	4051	1
2639		4052

Diff Legend

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