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.238 by root, Sat Apr 14 07:23:00 2007 UTC vs.
Revision 1.361 by root, Sun Sep 9 12:52:48 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
9	use Event;	10	use Event;
10	use Opcode;	11	use Opcode;
11	use Safe;	12	use Safe;
12	use Safe::Hole;	13	use Safe::Hole;
13		14
14	use Coro 3.52 ();	15	use Coro 3.64 ();
15	use Coro::State;	16	use Coro::State;
		17	use Coro::Handle;
16	use Coro::Event;	18	use Coro::Event;
17	use Coro::Timer;	19	use Coro::Timer;
18	use Coro::Signal;	20	use Coro::Signal;
19	use Coro::Semaphore;	21	use Coro::Semaphore;
20	use Coro::AIO;	22	use Coro::AIO;
21	use Coro::Storable;	23	use Coro::Storable;
		24	use Coro::Util ();
22		25
		26	use JSON::XS ();
23	use BDB ();	27	use BDB ();
24	use Data::Dumper;	28	use Data::Dumper;
25	use Digest::MD5;	29	use Digest::MD5;
26	use Fcntl;	30	use Fcntl;
27	use YAML::Syck ();	31	use YAML::Syck ();
28	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
29	use Time::HiRes;	33	use Time::HiRes;
30	use Compress::LZF;	34	use Compress::LZF;
		35	use Digest::MD5 ();
31		36
32	# configure various modules to our taste	37	# configure various modules to our taste
33	#	38	#
34	$Storable::canonical = 1; # reduce rsync transfers	39	$Storable::canonical = 1; # reduce rsync transfers
35	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator	40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
…		…
47	our %COMMAND = ();	52	our %COMMAND = ();
48	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
49		54
50	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
51	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
52	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
53	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
54		60
55	our $RELOAD; # number of reloads so far	61	our $RELOAD; # number of reloads so far
56	our @EVENT;	62	our @EVENT;
57	our $LIBDIR = datadir . "/ext";
58		63
59	our $TICK = MAX_TIME * 1e-6;	64	our $CONFDIR = confdir;
		65	our $DATADIR = datadir;
		66	our $LIBDIR = "$DATADIR/ext";
		67	our $PODDIR = "$DATADIR/pod";
		68	our $MAPDIR = "$DATADIR/" . mapdir;
		69	our $LOCALDIR = localdir;
		70	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		71	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		72	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		73	our $RANDOMDIR = "$LOCALDIR/random";
		74	our $BDBDIR = "$LOCALDIR/db";
		75
		76	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
60	our $TICK_WATCHER;	77	our $TICK_WATCHER;
61	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
62	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
63	our $NEXT_TICK;	80	our $NEXT_TICK;
64	our $NOW;	81	our $NOW;
…		…
70	our %CFG;	87	our %CFG;
71		88
72	our $UPTIME; $UPTIME ||= time;	89	our $UPTIME; $UPTIME ||= time;
73	our $RUNTIME;	90	our $RUNTIME;
74		91
75	our %PLAYER; # all users	92	our (%PLAYER, %PLAYER_LOADING); # all users
76	our %MAP; # all maps	93	our (%MAP, %MAP_LOADING ); # all maps
77	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
78	our $RANDOM_MAPS = cf::localdir . "/random";
79	our $BDB_ENV_DIR = cf::localdir . "/db";
80
81	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
82	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
83		95
84	# used to convert map paths into valid unix filenames by replacing / by ∕	96	# used to convert map paths into valid unix filenames by replacing / by ∕
85	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
86		98
		99	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		100	our $LOADAVG; # same thing, but with alpha-smoothing
		101	our $tick_start; # for load detecting purposes
		102
87	binmode STDOUT;	103	binmode STDOUT;
88	binmode STDERR;	104	binmode STDERR;
89		105
90	# read virtual server time, if available	106	# read virtual server time, if available
91	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
92	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
93	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
94	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
95	}	111	}
96		112
97	mkdir cf::localdir;	113	mkdir $_
98	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
99	mkdir cf::localdir . "/" . cf::tmpdir;
100	mkdir cf::localdir . "/" . cf::uniquedir;
101	mkdir $RANDOM_MAPS;
102	mkdir $BDB_ENV_DIR;
103		115
104	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
105		117
106	sub cf::map::normalise;	118	sub cf::map::normalise;
107		119
…		…
118	=item $cf::RUNTIME	130	=item $cf::RUNTIME
119		131
120	The time this server has run, starts at 0 and is increased by $cf::TICK on	132	The time this server has run, starts at 0 and is increased by $cf::TICK on
121	every server tick.	133	every server tick.
122		134
123	=item $cf::LIBDIR	135	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		136	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		137	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
124		138
125	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
126	be found. It will be added to C<@INC> automatically.	140	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		141	unique-items directory, player file directory, random maps directory and
		142	database environment.
127		143
128	=item $cf::NOW	144	=item $cf::NOW
129		145
130	The time of the last (current) server tick.	146	The time of the last (current) server tick.
131		147
132	=item $cf::TICK	148	=item $cf::TICK
133		149
134	The interval between server ticks, in seconds.	150	The interval between server ticks, in seconds.
		151
		152	=item $cf::LOADAVG
		153
		154	The current CPU load on the server (alpha-smoothed), as a value between 0
		155	(none) and 1 (overloaded), indicating how much time is spent on processing
		156	objects per tick. Healthy values are < 0.5.
		157
		158	=item $cf::LOAD
		159
		160	The raw value load value from the last tick.
135		161
136	=item %cf::CFG	162	=item %cf::CFG
137		163
138	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
139	from wherever your confdir points to.	165	from wherever your confdir points to.
140		166
141	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
142		168
143	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	169	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
144	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	170	returns directly I<after> the tick processing (and consequently, can only wake one process
145	processing has been done. Call C<< ->wait >> on them to maximise the	171	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
146	window of cpu time available, or simply to synchronise to the server tick.	172
		173	=item @cf::INVOKE_RESULTS
		174
		175	This array contains the results of the last C<invoke ()> call. When
		176	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		177	that call.
147		178
148	=back	179	=back
149		180
150	=cut	181	=cut
151		182
152	BEGIN {	183	BEGIN {
153	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
154	my $msg = join "", @_;	185	my $msg = join "", @_;
155	utf8::encode $msg;
156		186
157	$msg .= "\n"	187	$msg .= "\n"
158	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
159		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
160	LOG llevError, $msg;	193	LOG llevError, $msg;
161	};	194	};
162	}	195	}
163		196
164	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
165	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
166	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
167	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
168	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	201	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		202	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
169	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	203	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
170		204
171	# we bless all objects into (empty) derived classes to force a method lookup	205	# we bless all objects into (empty) derived classes to force a method lookup
172	# within the Safe compartment.	206	# within the Safe compartment.
173	for my $pkg (qw(	207	for my $pkg (qw(
174	cf::global cf::attachable	208	cf::global cf::attachable
…		…
182	}	216	}
183		217
184	$Event::DIED = sub {	218	$Event::DIED = sub {
185	warn "error in event callback: @_";	219	warn "error in event callback: @_";
186	};	220	};
		221
		222	#############################################################################
187		223
188	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
189		225
190	=over 4	226	=over 4
191		227
…		…
210	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	246	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
211	$d	247	$d
212	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
213	}	249	}
214		250
215	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
216
217	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
218		252
219	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
220		254
221	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
222		256
223	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
		258
		259	=cut
		260
		261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
		262
		263	sub to_json ($) { $json_coder->encode ($_[0]) }
		264	sub from_json ($) { $json_coder->decode ($_[0]) }
224		265
225	=item cf::lock_wait $string	266	=item cf::lock_wait $string
226		267
227	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
228		269
…		…
231	Wait until the given lock is available and then acquires it and returns	272	Wait until the given lock is available and then acquires it and returns
232	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	273	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
233	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
234	returned.	275	returned.
235		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
		279
236	Lock names should begin with a unique identifier (for example, cf::map::find	280	Lock names should begin with a unique identifier (for example, cf::map::find
237	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
238		282
		283	=item $locked = cf::lock_active $string
		284
		285	Return true if the lock is currently active, i.e. somebody has locked it.
		286
239	=cut	287	=cut
240		288
241	our %LOCK;	289	our %LOCK;
		290	our %LOCKER;#d#
242		291
243	sub lock_wait($) {	292	sub lock_wait($) {
244	my ($key) = @_;	293	my ($key) = @_;
		294
		295	if ($LOCKER{$key} == $Coro::current) {#d#
		296	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		297	return;#d#
		298	}#d#
245		299
246	# wait for lock, if any	300	# wait for lock, if any
247	while ($LOCK{$key}) {	301	while ($LOCK{$key}) {
248	push @{ $LOCK{$key} }, $Coro::current;	302	push @{ $LOCK{$key} }, $Coro::current;
249	Coro::schedule;	303	Coro::schedule;
…		…
255		309
256	# wait, to be sure we are not locked	310	# wait, to be sure we are not locked
257	lock_wait $key;	311	lock_wait $key;
258		312
259	$LOCK{$key} = [];	313	$LOCK{$key} = [];
		314	$LOCKER{$key} = $Coro::current;#d#
260		315
261	Coro::guard {	316	Coro::guard {
		317	delete $LOCKER{$key};#d#
262	# wake up all waiters, to be on the safe side	318	# wake up all waiters, to be on the safe side
263	$_->ready for @{ delete $LOCK{$key} };	319	$_->ready for @{ delete $LOCK{$key} };
264	}	320	}
		321	}
		322
		323	sub lock_active($) {
		324	my ($key) = @_;
		325
		326	! ! $LOCK{$key}
265	}	327	}
266		328
267	sub freeze_mainloop {	329	sub freeze_mainloop {
268	return unless $TICK_WATCHER->is_active;	330	return unless $TICK_WATCHER->is_active;
269		331
…		…
272	};	334	};
273	$TICK_WATCHER->stop;	335	$TICK_WATCHER->stop;
274	$guard	336	$guard
275	}	337	}
276		338
		339	=item cf::get_slot $time[, $priority[, $name]]
		340
		341	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		342	This call blocks and returns only when you have at least C<$time> seconds
		343	of cpu time till the next tick. The slot is only valid till the next cede.
		344
		345	The optional C<$name> can be used to identify the job to run. It might be
		346	used for statistical purposes and should identify the same time-class.
		347
		348	Useful for short background jobs.
		349
		350	=cut
		351
		352	our @SLOT_QUEUE;
		353	our $SLOT_QUEUE;
		354
		355	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		356	$SLOT_QUEUE = Coro::async {
		357	my $signal = new Coro::Signal;
		358
		359	while () {
		360	next_job:
		361	my $avail = cf::till_tick;
		362	if ($avail > 0.01) {
		363	for (0 .. $#SLOT_QUEUE) {
		364	if ($SLOT_QUEUE[$_][0] < $avail) {
		365	my $job = splice @SLOT_QUEUE, $_, 1, ();
		366	$job->[2]->send;
		367	Coro::cede;
		368	goto next_job;
		369	}
		370	}
		371	}
		372
		373	if (@SLOT_QUEUE) {
		374	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		375	push @cf::WAIT_FOR_TICK, $signal;
		376	$signal->wait;
		377	} else {
		378	Coro::schedule;
		379	}
		380	}
		381	};
		382
		383	sub get_slot($;$$) {
		384	my ($time, $pri, $name) = @_;
		385
		386	$time = $TICK * .6 if $time > $TICK * .6;
		387	my $sig = new Coro::Signal;
		388
		389	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		390	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		391	$SLOT_QUEUE->ready;
		392	$sig->wait;
		393	}
		394
277	=item cf::async { BLOCK }	395	=item cf::async { BLOCK }
278		396
279	Currently the same as Coro::async_pool, meaning you cannot use	397	Currently the same as Coro::async_pool, meaning you cannot use
280	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only	398	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
281	thing you are allowed to do is call C<prio> on it.	399	thing you are allowed to do is call C<prio> on it.
…		…
284		402
285	BEGIN { *async = \&Coro::async_pool }	403	BEGIN { *async = \&Coro::async_pool }
286		404
287	=item cf::sync_job { BLOCK }	405	=item cf::sync_job { BLOCK }
288		406
289	The design of crossfire+ requires that the main coro ($Coro::main) is	407	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
290	always able to handle events or runnable, as crossfire+ is only partly	408	is always able to handle events or runnable, as Crossfire TRT is only
291	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	409	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		410	acceptable.
292		411
293	If it must be done, put the blocking parts into C<sync_job>. This will run	412	If it must be done, put the blocking parts into C<sync_job>. This will run
294	the given BLOCK in another coroutine while waiting for the result. The	413	the given BLOCK in another coroutine while waiting for the result. The
295	server will be frozen during this time, so the block should either finish	414	server will be frozen during this time, so the block should either finish
296	fast or be very important.	415	fast or be very important.
…		…
299		418
300	sub sync_job(&) {	419	sub sync_job(&) {
301	my ($job) = @_;	420	my ($job) = @_;
302		421
303	if ($Coro::current == $Coro::main) {	422	if ($Coro::current == $Coro::main) {
		423	my $time = Event::time;
		424
304	# this is the main coro, too bad, we have to block	425	# this is the main coro, too bad, we have to block
305	# till the operation succeeds, freezing the server :/	426	# till the operation succeeds, freezing the server :/
306		427
307	# TODO: use suspend/resume instead	428	# TODO: use suspend/resume instead
308	# (but this is cancel-safe)	429	# (but this is cancel-safe)
…		…
319		440
320	while ($busy) {	441	while ($busy) {
321	Coro::cede or Event::one_event;	442	Coro::cede or Event::one_event;
322	}	443	}
323		444
		445	$time = Event::time - $time;
		446
		447	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		448	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		449
		450	$tick_start += $time; # do not account sync jobs to server load
		451
324	wantarray ? @res : $res[0]	452	wantarray ? @res : $res[0]
325	} else {	453	} else {
326	# we are in another coroutine, how wonderful, everything just works	454	# we are in another coroutine, how wonderful, everything just works
327		455
328	$job->()	456	$job->()
…		…
347	$EXT_CORO{$coro+0} = $coro;	475	$EXT_CORO{$coro+0} = $coro;
348		476
349	$coro	477	$coro
350	}	478	}
351		479
352	sub write_runtime {	480	=item fork_call { }, $args
353	my $guard = cf::lock_acquire "write_runtime";
354		481
355	my $runtime = cf::localdir . "/runtime";	482	Executes the given code block with the given arguments in a seperate
		483	process, returning the results. Everything must be serialisable with
		484	Coro::Storable. May, of course, block. Note that the executed sub may
		485	never block itself or use any form of Event handling.
356		486
357	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	487	=cut
358	or return;
359		488
360	my $value = $cf::RUNTIME + 90 + 10;	489	sub fork_call(&@) {
361	# 10 is the runtime save interval, for a monotonic clock	490	my ($cb, @args) = @_;
362	# 60 allows for the watchdog to kill the server.
363		491
364	(aio_write $fh, 0, (length $value), $value, 0) <= 0	492	# we seemingly have to make a local copy of the whole thing,
365	and return;	493	# otherwise perl prematurely frees the stuff :/
		494	# TODO: investigate and fix (likely this will be rather laborious)
366		495
367	# always fsync - this file is important	496	my @res = Coro::Util::fork_eval {
368	aio_fsync $fh	497	reset_signals;
369	and return;	498	&$cb
		499	}, @args;
370		500
371	close $fh	501	wantarray ? @res : $res[-1]
372	or return;	502	}
373		503
374	aio_rename "$runtime~", $runtime	504	=item $value = cf::db_get $family => $key
375	and return;
376		505
		506	Returns a single value from the environment database.
		507
		508	=item cf::db_put $family => $key => $value
		509
		510	Stores the given C<$value> in the family. It can currently store binary
		511	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		512
		513	=cut
		514
		515	our $DB;
		516
		517	sub db_init {
		518	unless ($DB) {
		519	$DB = BDB::db_create $DB_ENV;
		520
		521	cf::sync_job {
		522	eval {
		523	$DB->set_flags (BDB::CHKSUM);
		524
		525	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		526	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		527	cf::cleanup "db_open(db): $!" if $!;
		528	};
		529	cf::cleanup "db_open(db): $@" if $@;
		530	};
377	1	531	}
		532	}
		533
		534	sub db_get($$) {
		535	my $key = "$_[0]/$_[1]";
		536
		537	cf::sync_job {
		538	BDB::db_get $DB, undef, $key, my $data;
		539
		540	$! ? ()
		541	: $data
		542	}
		543	}
		544
		545	sub db_put($$$) {
		546	BDB::dbreq_pri 4;
		547	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		548	}
		549
		550	=item cf::cache $id => [$paths...], $processversion => $process
		551
		552	Generic caching function that returns the value of the resource $id,
		553	caching and regenerating as required.
		554
		555	This function can block.
		556
		557	=cut
		558
		559	sub cache {
		560	my ($id, $src, $processversion, $process) = @_;
		561
		562	my $meta =
		563	join "\x00",
		564	$processversion,
		565	map {
		566	aio_stat $_
		567	and Carp::croak "$_: $!";
		568
		569	($_, (stat _)[7,9])
		570	} @$src;
		571
		572	my $dbmeta = db_get cache => "$id/meta";
		573	if ($dbmeta ne $meta) {
		574	# changed, we may need to process
		575
		576	my @data;
		577	my $md5;
		578
		579	for (0 .. $#$src) {
		580	0 <= aio_load $src->[$_], $data[$_]
		581	or Carp::croak "$src->[$_]: $!";
		582	}
		583
		584	# if processing is expensive, check
		585	# checksum first
		586	if (1) {
		587	$md5 =
		588	join "\x00",
		589	$processversion,
		590	map {
		591	cf::cede_to_tick;
		592	($src->[$_], Digest::MD5::md5_hex $data[$_])
		593	} 0.. $#$src;
		594
		595
		596	my $dbmd5 = db_get cache => "$id/md5";
		597	if ($dbmd5 eq $md5) {
		598	db_put cache => "$id/meta", $meta;
		599
		600	return db_get cache => "$id/data";
		601	}
		602	}
		603
		604	my $t1 = Time::HiRes::time;
		605	my $data = $process->(\@data);
		606	my $t2 = Time::HiRes::time;
		607
		608	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		609
		610	db_put cache => "$id/data", $data;
		611	db_put cache => "$id/md5" , $md5;
		612	db_put cache => "$id/meta", $meta;
		613
		614	return $data;
		615	}
		616
		617	db_get cache => "$id/data"
378	}	618	}
379		619
380	=item cf::datalog type => key => value, ...	620	=item cf::datalog type => key => value, ...
381		621
382	Log a datalog packet of the given type with the given key-value pairs.	622	Log a datalog packet of the given type with the given key-value pairs.
…		…
400	attach callbacks/event handlers (a collection of which is called an "attachment")	640	attach callbacks/event handlers (a collection of which is called an "attachment")
401	to it. All such attachable objects support the following methods.	641	to it. All such attachable objects support the following methods.
402		642
403	In the following description, CLASS can be any of C<global>, C<object>	643	In the following description, CLASS can be any of C<global>, C<object>
404	C<player>, C<client> or C<map> (i.e. the attachable objects in	644	C<player>, C<client> or C<map> (i.e. the attachable objects in
405	crossfire+).	645	Crossfire TRT).
406		646
407	=over 4	647	=over 4
408		648
409	=item $attachable->attach ($attachment, key => $value...)	649	=item $attachable->attach ($attachment, key => $value...)
410		650
…		…
573	$registry = $CB_TYPE[$object_type] ||= [];	813	$registry = $CB_TYPE[$object_type] ||= [];
574		814
575	} elsif ($type eq "subtype") {	815	} elsif ($type eq "subtype") {
576	defined $object_type or Carp::croak "subtype specified without type";	816	defined $object_type or Carp::croak "subtype specified without type";
577	my $object_subtype = shift @arg;	817	my $object_subtype = shift @arg;
578	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	818	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
579		819
580	} elsif ($type eq "package") {	820	} elsif ($type eq "package") {
581	my $pkg = shift @arg;	821	my $pkg = shift @arg;
582		822
583	while (my ($name, $id) = each %cb_id) {	823	while (my ($name, $id) = each %cb_id) {
…		…
612	_attach $registry, $klass, @attach;	852	_attach $registry, $klass, @attach;
613	}	853	}
614		854
615	$obj->{$name} = \%arg;	855	$obj->{$name} = \%arg;
616	} else {	856	} else {
617	warn "object uses attachment '$name' that is not available, postponing.\n";	857	warn "object uses attachment '$name' which is not available, postponing.\n";
618	}	858	}
619		859
620	$obj->{_attachment}{$name} = undef;	860	$obj->{_attachment}{$name} = undef;
621	}	861	}
622		862
…		…
624	if (ref $_[0]) {	864	if (ref $_[0]) {
625	_object_attach @_;	865	_object_attach @_;
626	} else {	866	} else {
627	_attach shift->_attach_registry, @_;	867	_attach shift->_attach_registry, @_;
628	}	868	}
		869	_recalc_want;
629	};	870	};
630		871
631	# all those should be optimised	872	# all those should be optimised
632	sub cf::attachable::detach {	873	sub cf::attachable::detach {
633	my ($obj, $name) = @_;	874	my ($obj, $name) = @_;
…		…
636	delete $obj->{_attachment}{$name};	877	delete $obj->{_attachment}{$name};
637	reattach ($obj);	878	reattach ($obj);
638	} else {	879	} else {
639	Carp::croak "cannot, currently, detach class attachments";	880	Carp::croak "cannot, currently, detach class attachments";
640	}	881	}
		882	_recalc_want;
641	};	883	};
642		884
643	sub cf::attachable::attached {	885	sub cf::attachable::attached {
644	my ($obj, $name) = @_;	886	my ($obj, $name) = @_;
645		887
…		…
660	";	902	";
661	die if $@;	903	die if $@;
662	}	904	}
663		905
664	our $override;	906	our $override;
665	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	907	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
666		908
667	sub override {	909	sub override {
668	$override = 1;	910	$override = 1;
669	@invoke_results = ();	911	@INVOKE_RESULTS = (@_);
670	}	912	}
671		913
672	sub do_invoke {	914	sub do_invoke {
673	my $event = shift;	915	my $event = shift;
674	my $callbacks = shift;	916	my $callbacks = shift;
675		917
676	@invoke_results = ();	918	@INVOKE_RESULTS = ();
677		919
678	local $override;	920	local $override;
679		921
680	for (@$callbacks) {	922	for (@$callbacks) {
681	eval { &{$_->[1]} };	923	eval { &{$_->[1]} };
…		…
698		940
699	Generate an object-specific event with the given arguments.	941	Generate an object-specific event with the given arguments.
700		942
701	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	943	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
702	removed in future versions), and there is no public API to access override	944	removed in future versions), and there is no public API to access override
703	results (if you must, access C<@cf::invoke_results> directly).	945	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
704		946
705	=back	947	=back
706		948
707	=cut	949	=cut
708		950
709	#############################################################################	951	#############################################################################
710	# object support	952	# object support
		953	#
		954
		955	sub _can_merge {
		956	my ($ob1, $ob2) = @_;
		957
		958	local $Storable::canonical = 1;
		959	my $fob1 = Storable::freeze $ob1;
		960	my $fob2 = Storable::freeze $ob2;
		961
		962	$fob1 eq $fob2
		963	}
711		964
712	sub reattach {	965	sub reattach {
713	# basically do the same as instantiate, without calling instantiate	966	# basically do the same as instantiate, without calling instantiate
714	my ($obj) = @_;	967	my ($obj) = @_;
715		968
…		…
759	},	1012	},
760	);	1013	);
761		1014
762	sub object_freezer_save {	1015	sub object_freezer_save {
763	my ($filename, $rdata, $objs) = @_;	1016	my ($filename, $rdata, $objs) = @_;
		1017
		1018	my $guard = cf::lock_acquire "io";
764		1019
765	sync_job {	1020	sync_job {
766	if (length $$rdata) {	1021	if (length $$rdata) {
767	warn sprintf "saving %s (%d,%d)\n",	1022	warn sprintf "saving %s (%d,%d)\n",
768	$filename, length $$rdata, scalar @$objs;	1023	$filename, length $$rdata, scalar @$objs;
…		…
792	}	1047	}
793	} else {	1048	} else {
794	aio_unlink $filename;	1049	aio_unlink $filename;
795	aio_unlink "$filename.pst";	1050	aio_unlink "$filename.pst";
796	}	1051	}
797	}	1052	};
		1053
		1054	undef $guard;
798	}	1055	}
799		1056
800	sub object_freezer_as_string {	1057	sub object_freezer_as_string {
801	my ($rdata, $objs) = @_;	1058	my ($rdata, $objs) = @_;
802		1059
…		…
807		1064
808	sub object_thawer_load {	1065	sub object_thawer_load {
809	my ($filename) = @_;	1066	my ($filename) = @_;
810		1067
811	my ($data, $av);	1068	my ($data, $av);
		1069
		1070	my $guard = cf::lock_acquire "io";
812		1071
813	(aio_load $filename, $data) >= 0	1072	(aio_load $filename, $data) >= 0
814	or return;	1073	or return;
815		1074
816	unless (aio_stat "$filename.pst") {	1075	unless (aio_stat "$filename.pst") {
817	(aio_load "$filename.pst", $av) >= 0	1076	(aio_load "$filename.pst", $av) >= 0
818	or return;	1077	or return;
		1078
		1079	undef $guard;
819	$av = eval { (Storable::thaw $av)->{objs} };	1080	$av = eval { (Storable::thaw $av)->{objs} };
820	}	1081	}
821		1082
822	warn sprintf "loading %s (%d)\n",	1083	warn sprintf "loading %s (%d)\n",
823	$filename, length $data, scalar @{$av || []};#d#	1084	$filename, length $data, scalar @{$av || []};
		1085
824	return ($data, $av);	1086	($data, $av)
825	}	1087	}
		1088
		1089	=head2 COMMAND CALLBACKS
		1090
		1091	=over 4
		1092
		1093	=cut
826		1094
827	#############################################################################	1095	#############################################################################
828	# command handling &c	1096	# command handling &c
829		1097
830	=item cf::register_command $name => \&callback($ob,$args);	1098	=item cf::register_command $name => \&callback($ob,$args);
…		…
843	push @{ $COMMAND{$name} }, [$caller, $cb];	1111	push @{ $COMMAND{$name} }, [$caller, $cb];
844	}	1112	}
845		1113
846	=item cf::register_extcmd $name => \&callback($pl,$packet);	1114	=item cf::register_extcmd $name => \&callback($pl,$packet);
847		1115
848	Register a callbackf ro execution when the client sends an extcmd packet.	1116	Register a callback for execution when the client sends an (synchronous)
		1117	extcmd packet. Ext commands will be processed in the order they are
		1118	received by the server, like other user commands. The first argument is
		1119	the logged-in player. Ext commands can only be processed after a player
		1120	has logged in successfully.
849		1121
850	If the callback returns something, it is sent back as if reply was being	1122	If the callback returns something, it is sent back as if reply was being
851	called.	1123	called.
852		1124
		1125	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1126
		1127	Register a callback for execution when the client sends an (asynchronous)
		1128	exticmd packet. Exti commands are processed by the server as soon as they
		1129	are received, i.e. out of order w.r.t. other commands. The first argument
		1130	is a client socket. Exti commands can be received anytime, even before
		1131	log-in.
		1132
		1133	If the callback returns something, it is sent back as if reply was being
		1134	called.
		1135
853	=cut	1136	=cut
854		1137
855	sub register_extcmd {	1138	sub register_extcmd {
856	my ($name, $cb) = @_;	1139	my ($name, $cb) = @_;
857		1140
858	$EXTCMD{$name} = $cb;	1141	$EXTCMD{$name} = $cb;
		1142	}
		1143
		1144	sub register_exticmd {
		1145	my ($name, $cb) = @_;
		1146
		1147	$EXTICMD{$name} = $cb;
859	}	1148	}
860		1149
861	cf::player->attach (	1150	cf::player->attach (
862	on_command => sub {	1151	on_command => sub {
863	my ($pl, $name, $params) = @_;	1152	my ($pl, $name, $params) = @_;
…		…
872	cf::override;	1161	cf::override;
873	},	1162	},
874	on_extcmd => sub {	1163	on_extcmd => sub {
875	my ($pl, $buf) = @_;	1164	my ($pl, $buf) = @_;
876		1165
877	my $msg = eval { from_json $buf };	1166	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
878		1167
879	if (ref $msg) {	1168	if (ref $msg) {
		1169	my ($type, $reply, @payload) =
		1170	"ARRAY" eq ref $msg
		1171	? @$msg
		1172	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1173
		1174	my @reply;
		1175
880	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1176	if (my $cb = $EXTCMD{$type}) {
881	if (my %reply = $cb->($pl, $msg)) {	1177	@reply = $cb->($pl, @payload);
882	$pl->ext_reply ($msg->{msgid}, %reply);
883	}
884	}	1178	}
		1179
		1180	$pl->ext_reply ($reply, @reply)
		1181	if $reply;
		1182
885	} else {	1183	} else {
886	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1184	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
887	}	1185	}
888		1186
889	cf::override;	1187	cf::override;
890	},	1188	},
891	);	1189	);
892		1190
893	sub load_extension {
894	my ($path) = @_;
895
896	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
897	my $base = $1;
898	my $pkg = $1;
899	$pkg =~ s/[^[:word:]]/_/g;
900	$pkg = "ext::$pkg";
901
902	warn "... loading '$path' into '$pkg'\n";
903
904	open my $fh, "<:utf8", $path
905	or die "$path: $!";
906
907	my $source =
908	"package $pkg; use strict; use utf8;\n"
909	. "#line 1 \"$path\"\n{\n"
910	. (do { local $/; <$fh> })
911	. "\n};\n1";
912
913	unless (eval $source) {
914	my $msg = $@ ? "$path: $@\n"
915	: "extension disabled.\n";
916	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
917	warn $@;
918	warn "mandatory extension failed to load, exiting.\n";
919	exit 1;
920	}
921	die $@;
922	}
923
924	push @EXTS, $pkg;
925	}
926
927	sub load_extensions {	1191	sub load_extensions {
		1192	cf::sync_job {
		1193	my %todo;
		1194
928	for my $ext (<$LIBDIR/*.ext>) {	1195	for my $path (<$LIBDIR/*.ext>) {
929	next unless -r $ext;	1196	next unless -r $path;
930	eval {	1197
931	load_extension $ext;	1198	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1199	my $base = $1;
		1200	my $pkg = $1;
		1201	$pkg =~ s/[^[:word:]]/_/g;
		1202	$pkg = "ext::$pkg";
		1203
		1204	open my $fh, "<:utf8", $path
		1205	or die "$path: $!";
		1206
		1207	my $source = do { local $/; <$fh> };
		1208
		1209	my %ext = (
		1210	path => $path,
		1211	base => $base,
		1212	pkg => $pkg,
		1213	);
		1214
		1215	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1216	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1217
		1218	$ext{source} =
		1219	"package $pkg; use strict; use utf8;\n"
		1220	. "#line 1 \"$path\"\n{\n"
		1221	. $source
		1222	. "\n};\n1";
		1223
		1224	$todo{$base} = \%ext;
		1225	}
		1226
		1227	my %done;
		1228	while (%todo) {
		1229	my $progress;
		1230
		1231	while (my ($k, $v) = each %todo) {
		1232	for (split /,\s*/, $v->{meta}{depends}) {
		1233	goto skip
		1234	unless exists $done{$_};
		1235	}
		1236
		1237	warn "... loading '$k' into '$v->{pkg}'\n";
		1238
		1239	unless (eval $v->{source}) {
		1240	my $msg = $@ ? "$v->{path}: $@\n"
		1241	: "$v->{base}: extension inactive.\n";
		1242
		1243	if (exists $v->{meta}{mandatory}) {
		1244	warn $msg;
		1245	warn "mandatory extension failed to load, exiting.\n";
		1246	exit 1;
		1247	}
		1248
		1249	warn $msg;
		1250	}
		1251
		1252	$done{$k} = delete $todo{$k};
		1253	push @EXTS, $v->{pkg};
		1254	$progress = 1;
932	1	1255	}
933	} or warn "$ext not loaded: $@";	1256
		1257	skip:
		1258	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1259	unless $progress;
		1260	}
934	}	1261	};
935	}	1262	}
936		1263
937	#############################################################################	1264	#############################################################################
938		1265
		1266	=back
		1267
939	=head2 CORE EXTENSIONS	1268	=head2 CORE EXTENSIONS
940		1269
941	Functions and methods that extend core crossfire objects.	1270	Functions and methods that extend core crossfire objects.
942		1271
943	=cut	1272	=cut
…		…
948		1277
949	=head3 cf::player	1278	=head3 cf::player
950		1279
951	=over 4	1280	=over 4
952		1281
		1282	=item cf::player::num_playing
		1283
		1284	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1285
		1286	=cut
		1287
		1288	sub num_playing {
		1289	scalar grep
		1290	$_->ob->map
		1291	&& !$_->hidden
		1292	&& !$_->ob->flag (cf::FLAG_WIZ),
		1293	cf::player::list
		1294	}
		1295
953	=item cf::player::find $login	1296	=item cf::player::find $login
954		1297
955	Returns the given player object, loading it if necessary (might block).	1298	Returns the given player object, loading it if necessary (might block).
956		1299
957	=cut	1300	=cut
958		1301
959	sub playerdir($) {	1302	sub playerdir($) {
960	cf::localdir	1303	"$PLAYERDIR/"
961	. "/"
962	. cf::playerdir
963	. "/"
964	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1304	. (ref $_[0] ? $_[0]->ob->name : $_[0])
965	}	1305	}
966		1306
967	sub path($) {	1307	sub path($) {
968	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1308	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
…		…
995	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";	1335	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
996	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";	1336	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
997	aio_unlink +(playerdir $login) . "/$login.pl.pst";	1337	aio_unlink +(playerdir $login) . "/$login.pl.pst";
998	aio_unlink +(playerdir $login) . "/$login.pl";	1338	aio_unlink +(playerdir $login) . "/$login.pl";
999		1339
1000	my $pl = load_pl path $login	1340	my $f = new_from_file cf::object::thawer path $login
1001	or return;	1341	or return;
		1342
		1343	$f->next;
		1344	my $pl = cf::player::load_pl $f
		1345	or return;
		1346	local $cf::PLAYER_LOADING{$login} = $pl;
		1347	$f->resolve_delayed_derefs;
1002	$cf::PLAYER{$login} = $pl	1348	$cf::PLAYER{$login} = $pl
1003	}	1349	}
1004	}	1350	}
1005	}	1351	}
1006		1352
…		…
1016		1362
1017	aio_mkdir playerdir $pl, 0770;	1363	aio_mkdir playerdir $pl, 0770;
1018	$pl->{last_save} = $cf::RUNTIME;	1364	$pl->{last_save} = $cf::RUNTIME;
1019		1365
1020	$pl->save_pl ($path);	1366	$pl->save_pl ($path);
1021	Coro::cede;	1367	cf::cede_to_tick;
1022	}	1368	}
1023		1369
1024	sub new($) {	1370	sub new($) {
1025	my ($login) = @_;	1371	my ($login) = @_;
1026		1372
…		…
1030	$self->{deny_save} = 1;	1376	$self->{deny_save} = 1;
1031		1377
1032	$cf::PLAYER{$login} = $self;	1378	$cf::PLAYER{$login} = $self;
1033		1379
1034	$self	1380	$self
		1381	}
		1382
		1383	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1384
		1385	=cut
		1386
		1387	sub send_msg {
		1388	my $ns = shift->ns
		1389	or return;
		1390	$ns->send_msg (@_);
1035	}	1391	}
1036		1392
1037	=item $pl->quit_character	1393	=item $pl->quit_character
1038		1394
1039	Nukes the player without looking back. If logged in, the connection will	1395	Nukes the player without looking back. If logged in, the connection will
…		…
1088	while and may block, so not sync_job-capable, ever.	1444	while and may block, so not sync_job-capable, ever.
1089		1445
1090	=cut	1446	=cut
1091		1447
1092	sub list_logins {	1448	sub list_logins {
1093	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1449	my $dirs = aio_readdir $PLAYERDIR
1094	or return [];	1450	or return [];
1095		1451
1096	my @logins;	1452	my @logins;
1097		1453
1098	for my $login (@$dirs) {	1454	for my $login (@$dirs) {
		1455	my $path = path $login;
		1456
		1457	# a .pst is a dead give-away for a valid player
		1458	unless (-e "$path.pst") {
1099	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1459	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1100	aio_read $fh, 0, 512, my $buf, 0 or next;	1460	aio_read $fh, 0, 512, my $buf, 0 or next;
1101	$buf !~ /^password -------------$/m or next; # official not-valid tag	1461	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1462	}
1102		1463
1103	utf8::decode $login;	1464	utf8::decode $login;
1104	push @logins, $login;	1465	push @logins, $login;
1105	}	1466	}
1106		1467
…		…
1133	}	1494	}
1134		1495
1135	\@paths	1496	\@paths
1136	}	1497	}
1137		1498
		1499	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1500
		1501	Expand crossfire pod fragments into protocol xml.
		1502
		1503	=cut
		1504
		1505	sub expand_cfpod {
		1506	((my $self), (local $_)) = @_;
		1507
		1508	# escape & and <
		1509	s/&/&amp;/g;
		1510	s/(?<![BIUGHT])</&lt;/g;
		1511
		1512	# this is buggy, it needs to properly take care of nested <'s
		1513
		1514	1 while
		1515	# replace B<>, I<>, U<> etc.
		1516	s/B<([^\>]*)>/<b>$1<\/b>/
		1517	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1518	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1519	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1520	# replace G<male|female> tags
		1521	|| s{G<([^>|]*)\|([^>]*)>}{
		1522	$self->gender ? $2 : $1
		1523	}ge
		1524	# replace H<hint text>
		1525	|| s{H<([^\>]*)>}
		1526	{
		1527	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1528	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1529	"")
		1530	[$self->{hintmode}]
		1531	}ge;
		1532
		1533	# create single paragraphs (very hackish)
		1534	s/(?<=\S)\n(?=\w)/ /g;
		1535
		1536	# compress some whitespace
		1537	s/\s+\n/\n/g; # ws line-ends
		1538	s/\n\n+/\n/g; # double lines
		1539	s/^\n+//; # beginning lines
		1540	s/\n+$//; # ending lines
		1541
		1542	$_
		1543	}
		1544
		1545	sub hintmode {
		1546	$_[0]{hintmode} = $_[1] if @_ > 1;
		1547	$_[0]{hintmode}
		1548	}
		1549
1138	=item $player->ext_reply ($msgid, %msg)	1550	=item $player->ext_reply ($msgid, @msg)
1139		1551
1140	Sends an ext reply to the player.	1552	Sends an ext reply to the player.
1141		1553
1142	=cut	1554	=cut
1143		1555
1144	sub ext_reply($$%) {	1556	sub ext_reply($$@) {
1145	my ($self, $id, %msg) = @_;	1557	my ($self, $id, @msg) = @_;
1146		1558
1147	$msg{msgid} = $id;	1559	$self->ns->ext_reply ($id, @msg)
1148
1149	$self->send ("ext " . cf::to_json \%msg);
1150	}	1560	}
1151		1561
1152	=item $player->ext_event ($type, %msg)	1562	=item $player->ext_msg ($type, @msg)
1153		1563
1154	Sends an ext event to the client.	1564	Sends an ext event to the client.
1155		1565
1156	=cut	1566	=cut
1157		1567
1158	sub ext_event($$%) {	1568	sub ext_msg($$@) {
1159	my ($self, $type, %msg) = @_;	1569	my ($self, $type, @msg) = @_;
1160		1570
1161	$self->ns->ext_event ($type, %msg);	1571	$self->ns->ext_msg ($type, @msg);
1162	}	1572	}
1163		1573
1164	=head3 cf::region	1574	=head3 cf::region
1165		1575
1166	=over 4	1576	=over 4
…		…
1169		1579
1170	package cf::region;	1580	package cf::region;
1171		1581
1172	=item cf::region::find_by_path $path	1582	=item cf::region::find_by_path $path
1173		1583
1174	Tries to decuce the probable region for a map knowing only its path.	1584	Tries to decuce the likely region for a map knowing only its path.
1175		1585
1176	=cut	1586	=cut
1177		1587
1178	sub find_by_path($) {	1588	sub find_by_path($) {
1179	my ($path) = @_;	1589	my ($path) = @_;
1180		1590
1181	my ($match, $specificity);	1591	my ($match, $specificity);
1182		1592
1183	for my $region (list) {	1593	for my $region (list) {
1184	if ($region->match && $path =~ $region->match) {	1594	if ($region->{match} && $path =~ $region->{match}) {
1185	($match, $specificity) = ($region, $region->specificity)	1595	($match, $specificity) = ($region, $region->specificity)
1186	if $region->specificity > $specificity;	1596	if $region->specificity > $specificity;
1187	}	1597	}
1188	}	1598	}
1189		1599
…		…
1253	my ($self, $merge) = @_;	1663	my ($self, $merge) = @_;
1254		1664
1255	# we have to keep some variables in memory intact	1665	# we have to keep some variables in memory intact
1256	local $self->{path};	1666	local $self->{path};
1257	local $self->{load_path};	1667	local $self->{load_path};
1258	local $self->{deny_save};
1259	local $self->{deny_reset};
1260		1668
1261	$self->SUPER::thawer_merge ($merge);	1669	$self->SUPER::thawer_merge ($merge);
1262	}	1670	}
1263		1671
1264	sub normalise {	1672	sub normalise {
…		…
1311	$self->init; # pass $1 etc.	1719	$self->init; # pass $1 etc.
1312	return $self;	1720	return $self;
1313	}	1721	}
1314	}	1722	}
1315		1723
1316	Carp::carp "unable to resolve path '$path' (base '$base').";	1724	Carp::cluck "unable to resolve path '$path' (base '$base').";
1317	()	1725	()
1318	}	1726	}
1319		1727
1320	sub init {	1728	sub init {
1321	my ($self) = @_;	1729	my ($self) = @_;
…		…
1336		1744
1337	# the original (read-only) location	1745	# the original (read-only) location
1338	sub load_path {	1746	sub load_path {
1339	my ($self) = @_;	1747	my ($self) = @_;
1340		1748
1341	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1749	"$MAPDIR/$self->{path}.map"
1342	}	1750	}
1343		1751
1344	# the temporary/swap location	1752	# the temporary/swap location
1345	sub save_path {	1753	sub save_path {
1346	my ($self) = @_;	1754	my ($self) = @_;
1347		1755
1348	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1756	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1349	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1757	"$TMPDIR/$path.map"
1350	}	1758	}
1351		1759
1352	# the unique path, undef == no special unique path	1760	# the unique path, undef == no special unique path
1353	sub uniq_path {	1761	sub uniq_path {
1354	my ($self) = @_;	1762	my ($self) = @_;
1355		1763
1356	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1764	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1357	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1765	"$UNIQUEDIR/$path"
1358	}	1766	}
1359		1767
1360	# and all this just because we cannot iterate over	1768	# and all this just because we cannot iterate over
1361	# all maps in C++...	1769	# all maps in C++...
1362	sub change_all_map_light {	1770	sub change_all_map_light {
…		…
1364		1772
1365	$_->change_map_light ($change)	1773	$_->change_map_light ($change)
1366	for grep $_->outdoor, values %cf::MAP;	1774	for grep $_->outdoor, values %cf::MAP;
1367	}	1775	}
1368		1776
		1777	sub decay_objects {
		1778	my ($self) = @_;
		1779
		1780	return if $self->{deny_reset};
		1781
		1782	$self->do_decay_objects;
		1783	}
		1784
1369	sub unlink_save {	1785	sub unlink_save {
1370	my ($self) = @_;	1786	my ($self) = @_;
1371		1787
1372	utf8::encode (my $save = $self->save_path);	1788	utf8::encode (my $save = $self->save_path);
1373	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1789	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1376		1792
1377	sub load_header_from($) {	1793	sub load_header_from($) {
1378	my ($self, $path) = @_;	1794	my ($self, $path) = @_;
1379		1795
1380	utf8::encode $path;	1796	utf8::encode $path;
1381	#aio_open $path, O_RDONLY, 0	1797	my $f = new_from_file cf::object::thawer $path
1382	# or return;
1383
1384	$self->_load_header ($path)
1385	or return;	1798	or return;
		1799
		1800	$self->_load_header ($f)
		1801	or return;
		1802
		1803	local $MAP_LOADING{$self->{path}} = $self;
		1804	$f->resolve_delayed_derefs;
1386		1805
1387	$self->{load_path} = $path;	1806	$self->{load_path} = $path;
1388		1807
1389	1	1808	1
1390	}	1809	}
…		…
1429	$self->load_header_orig	1848	$self->load_header_orig
1430	or return;	1849	or return;
1431	$self->prepare_orig;	1850	$self->prepare_orig;
1432	}	1851	}
1433		1852
		1853	$self->{deny_reset} = 1
		1854	if $self->no_reset;
		1855
1434	$self->default_region (cf::region::find_by_path $self->{path})	1856	$self->default_region (cf::region::find_by_path $self->{path})
1435	unless $self->default_region;	1857	unless $self->default_region;
1436		1858
1437	1	1859	1
1438	}	1860	}
…		…
1441	sub find {	1863	sub find {
1442	my ($path, $origin) = @_;	1864	my ($path, $origin) = @_;
1443		1865
1444	$path = normalise $path, $origin && $origin->path;	1866	$path = normalise $path, $origin && $origin->path;
1445		1867
		1868	cf::lock_wait "map_data:$path";#d#remove
1446	cf::lock_wait "map_find:$path";	1869	cf::lock_wait "map_find:$path";
1447		1870
1448	$cf::MAP{$path} || do {	1871	$cf::MAP{$path} || do {
1449	my $guard = cf::lock_acquire "map_find:$path";	1872	my $guard1 = cf::lock_acquire "map_find:$path";
		1873	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1874
1450	my $map = new_from_path cf::map $path	1875	my $map = new_from_path cf::map $path
1451	or return;	1876	or return;
1452		1877
1453	$map->{last_save} = $cf::RUNTIME;	1878	$map->{last_save} = $cf::RUNTIME;
1454		1879
1455	$map->load_header	1880	$map->load_header
1456	or return;	1881	or return;
1457		1882
1458	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1883	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1459	# doing this can freeze the server in a sync job, obviously	1884	# doing this can freeze the server in a sync job, obviously
1460	#$cf::WAIT_FOR_TICK->wait;	1885	#$cf::WAIT_FOR_TICK->wait;
		1886	undef $guard1;
		1887	undef $guard2;
1461	$map->reset;	1888	$map->reset;
1462	undef $guard;
1463	return find $path;	1889	return find $path;
1464	}	1890	}
1465		1891
1466	$cf::MAP{$path} = $map	1892	$cf::MAP{$path} = $map
1467	}	1893	}
…		…
1474	my ($self) = @_;	1900	my ($self) = @_;
1475		1901
1476	local $self->{deny_reset} = 1; # loading can take a long time	1902	local $self->{deny_reset} = 1; # loading can take a long time
1477		1903
1478	my $path = $self->{path};	1904	my $path = $self->{path};
		1905
		1906	{
1479	my $guard = cf::lock_acquire "map_load:$path";	1907	my $guard = cf::lock_acquire "map_data:$path";
1480		1908
		1909	return unless $self->valid;
1481	return if $self->in_memory != cf::MAP_SWAPPED;	1910	return unless $self->in_memory == cf::MAP_SWAPPED;
1482		1911
1483	$self->in_memory (cf::MAP_LOADING);	1912	$self->in_memory (cf::MAP_LOADING);
1484		1913
1485	$self->alloc;	1914	$self->alloc;
1486		1915
1487	$self->pre_load;	1916	$self->pre_load;
		1917	cf::cede_to_tick;
1488		1918
1489	$self->_load_objects ($self->{load_path}, 1)	1919	my $f = new_from_file cf::object::thawer $self->{load_path};
		1920	$f->skip_block;
		1921	$self->_load_objects ($f)
1490	or return;	1922	or return;
1491		1923
1492	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1924	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1493	if delete $self->{load_original};	1925	if delete $self->{load_original};
1494		1926
1495	if (my $uniq = $self->uniq_path) {	1927	if (my $uniq = $self->uniq_path) {
1496	utf8::encode $uniq;	1928	utf8::encode $uniq;
1497	if (aio_open $uniq, O_RDONLY, 0) {	1929	unless (aio_stat $uniq) {
		1930	if (my $f = new_from_file cf::object::thawer $uniq) {
1498	$self->clear_unique_items;	1931	$self->clear_unique_items;
1499	$self->_load_objects ($uniq, 0);	1932	$self->_load_objects ($f);
		1933	$f->resolve_delayed_derefs;
		1934	}
1500	}	1935	}
1501	}	1936	}
1502		1937
1503	Coro::cede;	1938	$f->resolve_delayed_derefs;
1504		1939
		1940	cf::cede_to_tick;
1505	# now do the right thing for maps	1941	# now do the right thing for maps
1506	$self->link_multipart_objects;	1942	$self->link_multipart_objects;
1507
1508	unless ($self->{deny_activate}) {
1509	$self->decay_objects;
1510	$self->fix_auto_apply;
1511	$self->update_buttons;
1512	Coro::cede;
1513	$self->set_darkness_map;
1514	$self->difficulty ($self->estimate_difficulty)	1943	$self->difficulty ($self->estimate_difficulty)
1515	unless $self->difficulty;	1944	unless $self->difficulty;
1516	Coro::cede;	1945	cf::cede_to_tick;
		1946
		1947	unless ($self->{deny_activate}) {
		1948	$self->decay_objects;
		1949	$self->fix_auto_apply;
		1950	$self->update_buttons;
		1951	cf::cede_to_tick;
		1952	$self->set_darkness_map;
		1953	cf::cede_to_tick;
1517	$self->activate;	1954	$self->activate;
		1955	}
		1956
		1957	$self->{last_save} = $cf::RUNTIME;
		1958	$self->last_access ($cf::RUNTIME);
		1959
		1960	$self->in_memory (cf::MAP_IN_MEMORY);
1518	}	1961	}
1519		1962
1520	$self->post_load;	1963	$self->post_load;
1521
1522	$self->in_memory (cf::MAP_IN_MEMORY);
1523	}	1964	}
1524		1965
1525	sub customise_for {	1966	sub customise_for {
1526	my ($self, $ob) = @_;	1967	my ($self, $ob) = @_;
1527		1968
1528	return find "~" . $ob->name . "/" . $self->{path}	1969	return find "~" . $ob->name . "/" . $self->{path}
1529	if $self->per_player;	1970	if $self->per_player;
1530		1971
		1972	# return find "?party/" . $ob->name . "/" . $self->{path}
		1973	# if $self->per_party;
		1974
1531	$self	1975	$self
1532	}	1976	}
1533		1977
1534	# find and load all maps in the 3x3 area around a map	1978	# find and load all maps in the 3x3 area around a map
1535	sub load_diag {	1979	sub load_neighbours {
1536	my ($map) = @_;	1980	my ($map) = @_;
1537		1981
1538	my @diag; # diagonal neighbours	1982	my @neigh; # diagonal neighbours
1539		1983
1540	for (0 .. 3) {	1984	for (0 .. 3) {
1541	my $neigh = $map->tile_path ($_)	1985	my $neigh = $map->tile_path ($_)
1542	or next;	1986	or next;
1543	$neigh = find $neigh, $map	1987	$neigh = find $neigh, $map
1544	or next;	1988	or next;
1545	$neigh->load;	1989	$neigh->load;
1546		1990
		1991	push @neigh,
1547	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1992	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1548	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1993	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1549	}	1994	}
1550		1995
1551	for (@diag) {	1996	for (grep defined $_->[0], @neigh) {
		1997	my ($path, $origin) = @$_;
1552	my $neigh = find @$_	1998	my $neigh = find $path, $origin
1553	or next;	1999	or next;
1554	$neigh->load;	2000	$neigh->load;
1555	}	2001	}
1556	}	2002	}
1557		2003
…		…
1562	}	2008	}
1563		2009
1564	sub do_load_sync {	2010	sub do_load_sync {
1565	my ($map) = @_;	2011	my ($map) = @_;
1566		2012
		2013	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2014	if $Coro::current == $Coro::main;
		2015
1567	cf::sync_job { $map->load };	2016	cf::sync_job { $map->load };
1568	}	2017	}
1569		2018
1570	our %MAP_PREFETCH;	2019	our %MAP_PREFETCH;
1571	our $MAP_PREFETCHER = undef;	2020	our $MAP_PREFETCHER = undef;
1572		2021
1573	sub find_async {	2022	sub find_async {
1574	my ($path, $origin) = @_;	2023	my ($path, $origin, $load) = @_;
1575		2024
1576	$path = normalise $path, $origin && $origin->{path};	2025	$path = normalise $path, $origin && $origin->{path};
1577		2026
1578	if (my $map = $cf::MAP{$path}) {	2027	if (my $map = $cf::MAP{$path}) {
1579	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2028	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1580	}	2029	}
1581		2030
1582	undef $MAP_PREFETCH{$path};	2031	$MAP_PREFETCH{$path} |= $load;
		2032
1583	$MAP_PREFETCHER ||= cf::async {	2033	$MAP_PREFETCHER ||= cf::async {
1584	while (%MAP_PREFETCH) {	2034	while (%MAP_PREFETCH) {
1585	for my $path (keys %MAP_PREFETCH) {	2035	while (my ($k, $v) = each %MAP_PREFETCH) {
1586	my $map = find $path	2036	if (my $map = find $k) {
1587	or next;
1588	$map->load;	2037	$map->load if $v;
		2038	}
1589		2039
1590	delete $MAP_PREFETCH{$path};	2040	delete $MAP_PREFETCH{$k};
1591	}	2041	}
1592	}	2042	}
1593	undef $MAP_PREFETCHER;	2043	undef $MAP_PREFETCHER;
1594	};	2044	};
1595	$MAP_PREFETCHER->prio (6);	2045	$MAP_PREFETCHER->prio (6);
…		…
1598	}	2048	}
1599		2049
1600	sub save {	2050	sub save {
1601	my ($self) = @_;	2051	my ($self) = @_;
1602		2052
1603	my $lock = cf::lock_acquire "map_data:" . $self->path;	2053	my $lock = cf::lock_acquire "map_data:$self->{path}";
1604		2054
1605	$self->{last_save} = $cf::RUNTIME;	2055	$self->{last_save} = $cf::RUNTIME;
1606		2056
1607	return unless $self->dirty;	2057	return unless $self->dirty;
1608		2058
…		…
1631	my ($self) = @_;	2081	my ($self) = @_;
1632		2082
1633	# save first because save cedes	2083	# save first because save cedes
1634	$self->save;	2084	$self->save;
1635		2085
1636	my $lock = cf::lock_acquire "map_data:" . $self->path;	2086	my $lock = cf::lock_acquire "map_data:$self->{path}";
1637		2087
1638	return if $self->players;	2088	return if $self->players;
1639	return if $self->in_memory != cf::MAP_IN_MEMORY;	2089	return if $self->in_memory != cf::MAP_IN_MEMORY;
1640	return if $self->{deny_save};	2090	return if $self->{deny_save};
1641		2091
		2092	$self->in_memory (cf::MAP_SWAPPED);
		2093
		2094	$self->deactivate;
		2095	$_->clear_links_to ($self) for values %cf::MAP;
1642	$self->clear;	2096	$self->clear;
1643	$self->in_memory (cf::MAP_SWAPPED);
1644	}	2097	}
1645		2098
1646	sub reset_at {	2099	sub reset_at {
1647	my ($self) = @_;	2100	my ($self) = @_;
1648		2101
1649	# TODO: safety, remove and allow resettable per-player maps	2102	# TODO: safety, remove and allow resettable per-player maps
1650	return 1e99 if $self->isa ("ext::map_per_player");#d#
1651	return 1e99 if $self->{deny_reset};	2103	return 1e99 if $self->{deny_reset};
1652		2104
1653	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2105	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1654	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2106	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1655		2107
…		…
1666	my ($self) = @_;	2118	my ($self) = @_;
1667		2119
1668	my $lock = cf::lock_acquire "map_data:$self->{path}";	2120	my $lock = cf::lock_acquire "map_data:$self->{path}";
1669		2121
1670	return if $self->players;	2122	return if $self->players;
1671	return if $self->isa ("ext::map_per_player");#d#
1672		2123
1673	warn "resetting map ", $self->path;#d#	2124	warn "resetting map ", $self->path;
1674		2125
1675	$self->in_memory (cf::MAP_SWAPPED);	2126	$self->in_memory (cf::MAP_SWAPPED);
1676		2127
1677	# need to save uniques path	2128	# need to save uniques path
1678	unless ($self->{deny_save}) {	2129	unless ($self->{deny_save}) {
…		…
1682	if $uniq;	2133	if $uniq;
1683	}	2134	}
1684		2135
1685	delete $cf::MAP{$self->path};	2136	delete $cf::MAP{$self->path};
1686		2137
		2138	$self->deactivate;
		2139	$_->clear_links_to ($self) for values %cf::MAP;
1687	$self->clear;	2140	$self->clear;
1688
1689	$_->clear_links_to ($self) for values %cf::MAP;
1690		2141
1691	$self->unlink_save;	2142	$self->unlink_save;
1692	$self->destroy;	2143	$self->destroy;
1693	}	2144	}
1694		2145
1695	my $nuke_counter = "aaaa";	2146	my $nuke_counter = "aaaa";
1696		2147
1697	sub nuke {	2148	sub nuke {
1698	my ($self) = @_;	2149	my ($self) = @_;
1699		2150
		2151	{
		2152	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2153
1700	delete $cf::MAP{$self->path};	2154	delete $cf::MAP{$self->path};
1701		2155
1702	$self->unlink_save;	2156	$self->unlink_save;
1703		2157
1704	bless $self, "cf::map";	2158	bless $self, "cf::map";
1705	delete $self->{deny_reset};	2159	delete $self->{deny_reset};
1706	$self->{deny_save} = 1;	2160	$self->{deny_save} = 1;
1707	$self->reset_timeout (1);	2161	$self->reset_timeout (1);
1708	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2162	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1709		2163
1710	$cf::MAP{$self->path} = $self;	2164	$cf::MAP{$self->path} = $self;
		2165	}
1711		2166
1712	$self->reset; # polite request, might not happen	2167	$self->reset; # polite request, might not happen
		2168	}
		2169
		2170	=item $maps = cf::map::tmp_maps
		2171
		2172	Returns an arrayref with all map paths of currently instantiated and saved
		2173	maps. May block.
		2174
		2175	=cut
		2176
		2177	sub tmp_maps() {
		2178	[
		2179	map {
		2180	utf8::decode $_;
		2181	/\.map$/
		2182	? normalise $_
		2183	: ()
		2184	} @{ aio_readdir $TMPDIR or [] }
		2185	]
		2186	}
		2187
		2188	=item $maps = cf::map::random_maps
		2189
		2190	Returns an arrayref with all map paths of currently instantiated and saved
		2191	random maps. May block.
		2192
		2193	=cut
		2194
		2195	sub random_maps() {
		2196	[
		2197	map {
		2198	utf8::decode $_;
		2199	/\.map$/
		2200	? normalise "?random/$_"
		2201	: ()
		2202	} @{ aio_readdir $RANDOMDIR or [] }
		2203	]
1713	}	2204	}
1714		2205
1715	=item cf::map::unique_maps	2206	=item cf::map::unique_maps
1716		2207
1717	Returns an arrayref of paths of all shared maps that have	2208	Returns an arrayref of paths of all shared maps that have
1718	instantiated unique items. May block.	2209	instantiated unique items. May block.
1719		2210
1720	=cut	2211	=cut
1721		2212
1722	sub unique_maps() {	2213	sub unique_maps() {
1723	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2214	[
1724	or return;	2215	map {
1725
1726	my @paths;
1727
1728	for (@$files) {
1729	utf8::decode $_;	2216	utf8::decode $_;
1730	next if /\.pst$/;	2217	/\.map$/
1731	next unless /^$PATH_SEP/o;	2218	? normalise $_
1732		2219	: ()
1733	push @paths, cf::map::normalise $_;	2220	} @{ aio_readdir $UNIQUEDIR or [] }
1734	}	2221	]
1735
1736	\@paths
1737	}	2222	}
1738		2223
1739	package cf;	2224	package cf;
1740		2225
1741	=back	2226	=back
…		…
1759	map { $_, inv_recursive_ $_->inv } @_	2244	map { $_, inv_recursive_ $_->inv } @_
1760	}	2245	}
1761		2246
1762	sub inv_recursive {	2247	sub inv_recursive {
1763	inv_recursive_ inv $_[0]	2248	inv_recursive_ inv $_[0]
		2249	}
		2250
		2251	=item $ref = $ob->ref
		2252
		2253	creates and returns a persistent reference to an objetc that can be stored as a string.
		2254
		2255	=item $ob = cf::object::deref ($refstring)
		2256
		2257	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2258	even if the object actually exists. May block.
		2259
		2260	=cut
		2261
		2262	sub deref {
		2263	my ($ref) = @_;
		2264
		2265	# temporary compatibility#TODO#remove
		2266	$ref =~ s{^<}{player/<};
		2267
		2268	if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
		2269	my ($uuid, $name) = ($1, $2);
		2270	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2271	or return;
		2272	$pl->ob->uuid eq $uuid
		2273	or return;
		2274
		2275	$pl->ob
		2276	} else {
		2277	warn "$ref: cannot resolve object reference\n";
		2278	undef
		2279	}
1764	}	2280	}
1765		2281
1766	package cf;	2282	package cf;
1767		2283
1768	=back	2284	=back
…		…
1787		2303
1788	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2304	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1789		2305
1790	if ($self->{record_replies}) {	2306	if ($self->{record_replies}) {
1791	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2307	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2308
1792	} else {	2309	} else {
		2310	my $pl = $self->contr;
		2311
		2312	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2313	my $dialog = $pl->{npc_dialog};
		2314	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2315
		2316	} else {
1793	$msg = $npc->name . " says: $msg" if $npc;	2317	$msg = $npc->name . " says: $msg" if $npc;
1794	$self->message ($msg, $flags);	2318	$self->message ($msg, $flags);
		2319	}
1795	}	2320	}
		2321	}
		2322
		2323	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2324
		2325	=cut
		2326
		2327	sub cf::object::send_msg {
		2328	my $pl = shift->contr
		2329	or return;
		2330	$pl->send_msg (@_);
1796	}	2331	}
1797		2332
1798	=item $player_object->may ("access")	2333	=item $player_object->may ("access")
1799		2334
1800	Returns wether the given player is authorized to access resource "access"	2335	Returns wether the given player is authorized to access resource "access"
…		…
1847	$self->deactivate_recursive;	2382	$self->deactivate_recursive;
1848		2383
1849	return if UNIVERSAL::isa $self->map, "ext::map_link";	2384	return if UNIVERSAL::isa $self->map, "ext::map_link";
1850		2385
1851	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2386	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1852	if $self->map;	2387	if $self->map && $self->map->{path} ne "{link}";
1853		2388
1854	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2389	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1855	}	2390	}
1856		2391
1857	sub cf::object::player::leave_link {	2392	sub cf::object::player::leave_link {
1858	my ($self, $map, $x, $y) = @_;	2393	my ($self, $map, $x, $y) = @_;
		2394
		2395	return unless $self->contr->active;
1859		2396
1860	my $link_pos = delete $self->{_link_pos};	2397	my $link_pos = delete $self->{_link_pos};
1861		2398
1862	unless ($map) {	2399	unless ($map) {
1863	# restore original map position	2400	# restore original map position
…		…
1877	# use -1 or undef as default coordinates, not 0, 0	2414	# use -1 or undef as default coordinates, not 0, 0
1878	($x, $y) = ($map->enter_x, $map->enter_y)	2415	($x, $y) = ($map->enter_x, $map->enter_y)
1879	if $x <=0 && $y <= 0;	2416	if $x <=0 && $y <= 0;
1880		2417
1881	$map->load;	2418	$map->load;
1882	$map->load_diag;	2419	$map->load_neighbours;
1883		2420
1884	return unless $self->contr->active;	2421	return unless $self->contr->active;
1885	$self->activate_recursive;	2422	$self->activate_recursive;
1886		2423
1887	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2424	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1888	$self->enter_map ($map, $x, $y);	2425	$self->enter_map ($map, $x, $y);
1889	}	2426	}
1890		2427
1891	cf::player->attach (	2428	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1892	on_logout => sub {
1893	my ($pl) = @_;
1894		2429
1895	# abort map switching before logout	2430	Moves the player to the given map-path and coordinates by first freezing
1896	if ($pl->ob->{_link_pos}) {	2431	her, loading and preparing them map, calling the provided $check callback
1897	cf::sync_job {	2432	that has to return the map if sucecssful, and then unfreezes the player on
1898	$pl->ob->leave_link	2433	the new (success) or old (failed) map position. In either case, $done will
1899	};	2434	be called at the end of this process.
1900	}
1901	},
1902	on_login => sub {
1903	my ($pl) = @_;
1904		2435
1905	# try to abort aborted map switching on player login :)
1906	# should happen only on crashes
1907	if ($pl->ob->{_link_pos}) {
1908	$pl->ob->enter_link;
1909	(async {
1910	$pl->ob->reply (undef,
1911	"There was an internal problem at your last logout, "
1912	. "the server will try to bring you to your intended destination in a second.",
1913	cf::NDI_RED);
1914	# we need this sleep as the login has a concurrent enter_exit running
1915	# and this sleep increases chances of the player not ending up in scorn
1916	Coro::Timer::sleep 1;
1917	$pl->ob->leave_link;
1918	})->prio (2);
1919	}
1920	},
1921	);
1922
1923	=item $player_object->goto ($path, $x, $y)
1924
1925	=cut	2436	=cut
		2437
		2438	our $GOTOGEN;
1926		2439
1927	sub cf::object::player::goto {	2440	sub cf::object::player::goto {
1928	my ($self, $path, $x, $y) = @_;	2441	my ($self, $path, $x, $y, $check, $done) = @_;
		2442
		2443	# do generation counting so two concurrent goto's will be executed in-order
		2444	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1929		2445
1930	$self->enter_link;	2446	$self->enter_link;
1931		2447
1932	(async {	2448	(async {
1933	my $map = eval {	2449	my $map = eval {
1934	my $map = cf::map::find $path;	2450	my $map = cf::map::find $path;
		2451
		2452	if ($map) {
1935	$map = $map->customise_for ($self) if $map;	2453	$map = $map->customise_for ($self);
		2454	$map = $check->($map) if $check && $map;
		2455	} else {
		2456	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2457	}
		2458
1936	$map	2459	$map
		2460	};
		2461
		2462	if ($@) {
		2463	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2464	LOG llevError | logBacktrace, Carp::longmess $@;
1937	} or	2465	}
1938	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1939		2466
		2467	if ($gen == $self->{_goto_generation}) {
		2468	delete $self->{_goto_generation};
1940	$self->leave_link ($map, $x, $y);	2469	$self->leave_link ($map, $x, $y);
		2470	}
		2471
		2472	$done->() if $done;
1941	})->prio (1);	2473	})->prio (1);
1942	}	2474	}
1943		2475
1944	=item $player_object->enter_exit ($exit_object)	2476	=item $player_object->enter_exit ($exit_object)
1945		2477
…		…
1984		2516
1985	$rmp->{random_seed} ||= $exit->random_seed;	2517	$rmp->{random_seed} ||= $exit->random_seed;
1986		2518
1987	my $data = cf::to_json $rmp;	2519	my $data = cf::to_json $rmp;
1988	my $md5 = Digest::MD5::md5_hex $data;	2520	my $md5 = Digest::MD5::md5_hex $data;
1989	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2521	my $meta = "$RANDOMDIR/$md5.meta";
1990		2522
1991	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2523	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1992	aio_write $fh, 0, (length $data), $data, 0;	2524	aio_write $fh, 0, (length $data), $data, 0;
1993	undef $fh;	2525	undef $fh;
1994	aio_rename "$meta~", $meta;	2526	aio_rename "$meta~", $meta;
…		…
2013	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2545	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2014	my $hp = $exit->stats->hp;	2546	my $hp = $exit->stats->hp;
2015	my $sp = $exit->stats->sp;	2547	my $sp = $exit->stats->sp;
2016		2548
2017	$self->enter_link;	2549	$self->enter_link;
		2550
		2551	# if exit is damned, update players death & WoR home-position
		2552	$self->contr->savebed ($slaying, $hp, $sp)
		2553	if $exit->flag (FLAG_DAMNED);
2018		2554
2019	(async {	2555	(async {
2020	$self->deactivate_recursive; # just to be sure	2556	$self->deactivate_recursive; # just to be sure
2021	unless (eval {	2557	unless (eval {
2022	$self->goto ($slaying, $hp, $sp);	2558	$self->goto ($slaying, $hp, $sp);
…		…
2050		2586
2051	utf8::encode $text;	2587	utf8::encode $text;
2052	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2588	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2053	}	2589	}
2054		2590
		2591	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2592
		2593	Send a drawinfo or msg packet to the client, formatting the msg for the
		2594	client if neccessary. C<$type> should be a string identifying the type of
		2595	the message, with C<log> being the default. If C<$color> is negative, suppress
		2596	the message unless the client supports the msg packet.
		2597
		2598	=cut
		2599
		2600	our %CHANNEL = (
		2601	"c/identify" => {
		2602	id => "identify",
		2603	title => "Identify",
		2604	reply => undef,
		2605	tooltip => "Items recently identified",
		2606	},
		2607	"c/examine" => {
		2608	id => "examine",
		2609	title => "Examine",
		2610	reply => undef,
		2611	tooltip => "Signs and other items you examined",
		2612	},
		2613	);
		2614
		2615	sub cf::client::send_msg {
		2616	my ($self, $channel, $msg, $color, @extra) = @_;
		2617
		2618	$msg = $self->pl->expand_cfpod ($msg);
		2619
		2620	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2621
		2622	# check predefined channels, for the benefit of C
		2623	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2624
		2625	if (ref $channel) {
		2626	# send meta info to client, if not yet sent
		2627	unless (exists $self->{channel}{$channel->{id}}) {
		2628	$self->{channel}{$channel->{id}} = $channel;
		2629	$self->ext_msg (channel_info => $channel)
		2630	if $self->can_msg;
		2631	}
		2632
		2633	$channel = $channel->{id};
		2634	}
		2635
		2636	return unless @extra || length $msg;
		2637
		2638	if ($self->can_msg) {
		2639	# default colour, mask it out
		2640	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2641	if $color & cf::NDI_DEF;
		2642
		2643	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2644	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2645	} else {
		2646	if ($color >= 0) {
		2647	# replace some tags by gcfclient-compatible ones
		2648	for ($msg) {
		2649	1 while
		2650	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2651	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2652	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2653	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2654	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2655	}
		2656
		2657	$color &= cf::NDI_COLOR_MASK;
		2658
		2659	utf8::encode $msg;
		2660
		2661	if (0 && $msg =~ /\[/) {
		2662	# COMMAND/INFO
		2663	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2664	} else {
		2665	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2666	$self->send_packet ("drawinfo $color $msg")
		2667	}
		2668	}
		2669	}
		2670	}
		2671
2055	=item $client->ext_event ($type, %msg)	2672	=item $client->ext_msg ($type, @msg)
2056		2673
2057	Sends an exti event to the client.	2674	Sends an ext event to the client.
2058		2675
2059	=cut	2676	=cut
2060		2677
2061	sub cf::client::ext_event($$%) {	2678	sub cf::client::ext_msg($$@) {
2062	my ($self, $type, %msg) = @_;	2679	my ($self, $type, @msg) = @_;
2063		2680
		2681	if ($self->extcmd == 2) {
		2682	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2683	} elsif ($self->extcmd == 1) { # TODO: remove
2064	$msg{msgtype} = "event_$type";	2684	push @msg, msgtype => "event_$type";
2065	$self->send_packet ("ext " . cf::to_json \%msg);	2685	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2686	}
		2687	}
		2688
		2689	=item $client->ext_reply ($msgid, @msg)
		2690
		2691	Sends an ext reply to the client.
		2692
		2693	=cut
		2694
		2695	sub cf::client::ext_reply($$@) {
		2696	my ($self, $id, @msg) = @_;
		2697
		2698	if ($self->extcmd == 2) {
		2699	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2700	} elsif ($self->extcmd == 1) {
		2701	#TODO: version 1, remove
		2702	unshift @msg, msgtype => "reply", msgid => $id;
		2703	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2704	}
2066	}	2705	}
2067		2706
2068	=item $success = $client->query ($flags, "text", \&cb)	2707	=item $success = $client->query ($flags, "text", \&cb)
2069		2708
2070	Queues a query to the client, calling the given callback with	2709	Queues a query to the client, calling the given callback with
2071	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2710	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2072	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2711	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2073		2712
2074	Queries can fail, so check the return code. Or don't, as queries will become	2713	Queries can fail, so check the return code. Or don't, as queries will
2075	reliable at some point in the future.	2714	become reliable at some point in the future.
2076		2715
2077	=cut	2716	=cut
2078		2717
2079	sub cf::client::query {	2718	sub cf::client::query {
2080	my ($self, $flags, $text, $cb) = @_;	2719	my ($self, $flags, $text, $cb) = @_;
…		…
2088	utf8::encode $text;	2727	utf8::encode $text;
2089	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2728	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2090		2729
2091	$self->send_packet ($self->{query_queue}[0][0])	2730	$self->send_packet ($self->{query_queue}[0][0])
2092	if @{ $self->{query_queue} } == 1;	2731	if @{ $self->{query_queue} } == 1;
		2732
		2733	1
2093	}	2734	}
2094		2735
2095	cf::client->attach (	2736	cf::client->attach (
		2737	on_connect => sub {
		2738	my ($ns) = @_;
		2739
		2740	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2741	},
2096	on_reply => sub {	2742	on_reply => sub {
2097	my ($ns, $msg) = @_;	2743	my ($ns, $msg) = @_;
2098		2744
2099	# this weird shuffling is so that direct followup queries	2745	# this weird shuffling is so that direct followup queries
2100	# get handled first	2746	# get handled first
…		…
2112	} else {	2758	} else {
2113	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2759	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2114	}	2760	}
2115	}	2761	}
2116	},	2762	},
		2763	on_exticmd => sub {
		2764	my ($ns, $buf) = @_;
		2765
		2766	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2767
		2768	if (ref $msg) {
		2769	my ($type, $reply, @payload) =
		2770	"ARRAY" eq ref $msg
		2771	? @$msg
		2772	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2773
		2774	my @reply;
		2775
		2776	if (my $cb = $EXTICMD{$type}) {
		2777	@reply = $cb->($ns, @payload);
		2778	}
		2779
		2780	$ns->ext_reply ($reply, @reply)
		2781	if $reply;
		2782
		2783	} else {
		2784	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2785	}
		2786
		2787	cf::override;
		2788	},
2117	);	2789	);
2118		2790
2119	=item $client->async (\&cb)	2791	=item $client->async (\&cb)
2120		2792
2121	Create a new coroutine, running the specified callback. The coroutine will	2793	Create a new coroutine, running the specified callback. The coroutine will
…		…
2162	our $safe = new Safe "safe";	2834	our $safe = new Safe "safe";
2163	our $safe_hole = new Safe::Hole;	2835	our $safe_hole = new Safe::Hole;
2164		2836
2165	$SIG{FPE} = 'IGNORE';	2837	$SIG{FPE} = 'IGNORE';
2166		2838
2167	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2839	$safe->permit_only (Opcode::opset qw(
		2840	:base_core :base_mem :base_orig :base_math
		2841	grepstart grepwhile mapstart mapwhile
		2842	sort time
		2843	));
2168		2844
2169	# here we export the classes and methods available to script code	2845	# here we export the classes and methods available to script code
2170		2846
2171	=pod	2847	=pod
2172		2848
2173	The following functions and methods are available within a safe environment:	2849	The following functions and methods are available within a safe environment:
2174		2850
2175	cf::object contr pay_amount pay_player map	2851	cf::object
		2852	contr pay_amount pay_player map x y force_find force_add
		2853	insert remove name archname title slaying race decrease_ob_nr
		2854
2176	cf::object::player player	2855	cf::object::player
2177	cf::player peaceful	2856	player
2178	cf::map trigger	2857
		2858	cf::player
		2859	peaceful
		2860
		2861	cf::map
		2862	trigger
2179		2863
2180	=cut	2864	=cut
2181		2865
2182	for (	2866	for (
2183	["cf::object" => qw(contr pay_amount pay_player map)],	2867	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2868	insert remove inv name archname title slaying race
		2869	decrease_ob_nr)],
2184	["cf::object::player" => qw(player)],	2870	["cf::object::player" => qw(player)],
2185	["cf::player" => qw(peaceful)],	2871	["cf::player" => qw(peaceful)],
2186	["cf::map" => qw(trigger)],	2872	["cf::map" => qw(trigger)],
2187	) {	2873	) {
2188	no strict 'refs';	2874	no strict 'refs';
…		…
2259	=back	2945	=back
2260		2946
2261	=cut	2947	=cut
2262		2948
2263	#############################################################################	2949	#############################################################################
2264
2265	=head2 EXTENSION DATABASE SUPPORT
2266
2267	Crossfire maintains a very simple database for extension use. It can
2268	currently store anything that can be serialised using Storable, which
2269	excludes objects.
2270
2271	The parameter C<$family> should best start with the name of the extension
2272	using it, it should be unique.
2273
2274	=over 4
2275
2276	=item $value = cf::db_get $family => $key
2277
2278	Returns a single value from the database.
2279
2280	=item cf::db_put $family => $key => $value
2281
2282	Stores the given C<$value> in the family.
2283
2284	=cut
2285
2286	our $DB;
2287
2288	sub db_init {
2289	unless ($DB) {
2290	$DB = BDB::db_create $DB_ENV;
2291
2292	cf::sync_job {
2293	eval {
2294	$DB->set_flags (BDB::CHKSUM);
2295
2296	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2297	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2298	cf::cleanup "db_open(db): $!" if $!;
2299	};
2300	cf::cleanup "db_open(db): $@" if $@;
2301	};
2302
2303	my $path = cf::localdir . "/database.pst";
2304	if (stat $path) {
2305	cf::sync_job {
2306	my $pst = Storable::retrieve $path;
2307
2308	cf::db_put (board => data => $pst->{board});
2309	cf::db_put (guildrules => data => $pst->{guildrules});
2310	cf::db_put (rent => balance => $pst->{rent}{balance});
2311	BDB::db_env_txn_checkpoint $DB_ENV;
2312
2313	unlink $path;
2314	};
2315	}
2316	}
2317	}
2318
2319	sub db_get($$) {
2320	my $key = "$_[0]/$_[1]";
2321
2322	cf::sync_job {
2323	BDB::db_get $DB, undef, $key, my $data;
2324
2325	$! ? ()
2326	: Compress::LZF::sthaw $data
2327	}
2328	}
2329
2330	sub db_put($$$) {
2331	BDB::dbreq_pri 4;
2332	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2333	}
2334
2335	#############################################################################
2336	# the server's init and main functions	2950	# the server's init and main functions
2337		2951
2338	sub load_facedata {	2952	sub load_facedata($) {
2339	my $path = sprintf "%s/facedata", cf::datadir;	2953	my ($path) = @_;
		2954
		2955	# HACK to clear player env face cache, we need some signal framework
		2956	# for this (global event?)
		2957	%ext::player_env::MUSIC_FACE_CACHE = ();
		2958
		2959	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2340		2960
2341	warn "loading facedata from $path\n";	2961	warn "loading facedata from $path\n";
2342		2962
2343	my $facedata;	2963	my $facedata;
2344	0 < aio_load $path, $facedata	2964	0 < aio_load $path, $facedata
…		…
2347	$facedata = Coro::Storable::thaw $facedata;	2967	$facedata = Coro::Storable::thaw $facedata;
2348		2968
2349	$facedata->{version} == 2	2969	$facedata->{version} == 2
2350	or cf::cleanup "$path: version mismatch, cannot proceed.";	2970	or cf::cleanup "$path: version mismatch, cannot proceed.";
2351		2971
		2972	# patch in the exptable
		2973	$facedata->{resource}{"res/exp_table"} = {
		2974	type => FT_RSRC,
		2975	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2976	};
		2977	cf::cede_to_tick;
		2978
2352	{	2979	{
2353	my $faces = $facedata->{faceinfo};	2980	my $faces = $facedata->{faceinfo};
2354		2981
2355	while (my ($face, $info) = each %$faces) {	2982	while (my ($face, $info) = each %$faces) {
2356	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2983	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2357	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2984	cf::face::set_visibility $idx, $info->{visibility};
		2985	cf::face::set_magicmap $idx, $info->{magicmap};
2358	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2986	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2359	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2987	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2360	Coro::cede;	2988
		2989	cf::cede_to_tick;
2361	}	2990	}
2362		2991
2363	while (my ($face, $info) = each %$faces) {	2992	while (my ($face, $info) = each %$faces) {
2364	next unless $info->{smooth};	2993	next unless $info->{smooth};
2365	my $idx = cf::face::find $face	2994	my $idx = cf::face::find $face
2366	or next;	2995	or next;
2367	if (my $smooth = cf::face::find $info->{smooth}) {	2996	if (my $smooth = cf::face::find $info->{smooth}) {
		2997	cf::face::set_smooth $idx, $smooth;
2368	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};	2998	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2369	} else {	2999	} else {
2370	warn "smooth face '$info->{smooth}' not found for face '$face'";	3000	warn "smooth face '$info->{smooth}' not found for face '$face'";
2371	}	3001	}
2372	Coro::cede;	3002
		3003	cf::cede_to_tick;
2373	}	3004	}
2374	}	3005	}
2375		3006
2376	{	3007	{
2377	my $anims = $facedata->{animinfo};	3008	my $anims = $facedata->{animinfo};
2378		3009
2379	while (my ($anim, $info) = each %$anims) {	3010	while (my ($anim, $info) = each %$anims) {
2380	cf::anim::set $anim, $info->{frames}, $info->{facings};	3011	cf::anim::set $anim, $info->{frames}, $info->{facings};
2381	Coro::cede;	3012	cf::cede_to_tick;
2382	}	3013	}
2383		3014
2384	cf::anim::invalidate_all; # d'oh	3015	cf::anim::invalidate_all; # d'oh
2385	}	3016	}
2386		3017
		3018	{
		3019	# TODO: for gcfclient pleasure, we should give resources
		3020	# that gcfclient doesn't grok a >10000 face index.
		3021	my $res = $facedata->{resource};
		3022
		3023	my $soundconf = delete $res->{"res/sound.conf"};
		3024
		3025	while (my ($name, $info) = each %$res) {
		3026	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3027	my $data;
		3028
		3029	if ($info->{type} & 1) {
		3030	# prepend meta info
		3031
		3032	my $meta = $enc->encode ({
		3033	name => $name,
		3034	%{ $info->{meta} || {} },
		3035	});
		3036
		3037	$data = pack "(w/a*)*", $meta, $info->{data};
		3038	} else {
		3039	$data = $info->{data};
		3040	}
		3041
		3042	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3043	cf::face::set_type $idx, $info->{type};
		3044
		3045	cf::cede_to_tick;
		3046	}
		3047
		3048	if ($soundconf) {
		3049	$soundconf = $enc->decode (delete $soundconf->{data});
		3050
		3051	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3052	my $sound = $soundconf->{compat}[$_]
		3053	or next;
		3054
		3055	my $face = cf::face::find "sound/$sound->[1]";
		3056	cf::sound::set $sound->[0] => $face;
		3057	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3058	}
		3059
		3060	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3061	my $face = cf::face::find "sound/$v";
		3062	cf::sound::set $k => $face;
		3063	}
		3064	}
		3065	}
		3066
2387	1	3067	1
2388	}	3068	}
2389		3069
		3070	register_exticmd fx_want => sub {
		3071	my ($ns, $want) = @_;
		3072
		3073	while (my ($k, $v) = each %$want) {
		3074	$ns->fx_want ($k, $v);
		3075	}
		3076	};
		3077
		3078	sub reload_regions {
		3079	# HACK to clear player env face cache, we need some signal framework
		3080	# for this (global event?)
		3081	%ext::player_env::MUSIC_FACE_CACHE = ();
		3082
		3083	load_resource_file "$MAPDIR/regions"
		3084	or die "unable to load regions file\n";
		3085
		3086	for (cf::region::list) {
		3087	$_->{match} = qr/$_->{match}/
		3088	if exists $_->{match};
		3089	}
		3090	}
		3091
		3092	sub reload_facedata {
		3093	load_facedata "$DATADIR/facedata"
		3094	or die "unable to load facedata\n";
		3095	}
		3096
		3097	sub reload_archetypes {
		3098	load_resource_file "$DATADIR/archetypes"
		3099	or die "unable to load archetypes\n";
		3100	#d# NEED to laod twice to resolve forward references
		3101	# this really needs to be done in an extra post-pass
		3102	# (which needs to be synchronous, so solve it differently)
		3103	load_resource_file "$DATADIR/archetypes"
		3104	or die "unable to load archetypes\n";
		3105	}
		3106
		3107	sub reload_treasures {
		3108	load_resource_file "$DATADIR/treasures"
		3109	or die "unable to load treasurelists\n";
		3110	}
		3111
2390	sub reload_resources {	3112	sub reload_resources {
2391	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir	3113	warn "reloading resource files...\n";
2392	or die "unable to load regions file\n";#d#	3114
		3115	reload_regions;
2393	load_facedata	3116	reload_facedata;
2394	or die "unable to load facedata\n";#d#	3117	#reload_archetypes;#d#
		3118	reload_archetypes;
		3119	reload_treasures;
		3120
		3121	warn "finished reloading resource files\n";
2395	}	3122	}
2396		3123
2397	sub init {	3124	sub init {
2398	reload_resources;	3125	reload_resources;
2399	}	3126	}
2400		3127
2401	sub cfg_load {	3128	sub reload_config {
2402	open my $fh, "<:utf8", cf::confdir . "/config"	3129	open my $fh, "<:utf8", "$CONFDIR/config"
2403	or return;	3130	or return;
2404		3131
2405	local $/;	3132	local $/;
2406	*CFG = YAML::Syck::Load <$fh>;	3133	*CFG = YAML::Syck::Load <$fh>;
2407		3134
…		…
2426	(async {	3153	(async {
2427	Event::one_event;	3154	Event::one_event;
2428	})->prio (Coro::PRIO_MAX);	3155	})->prio (Coro::PRIO_MAX);
2429	};	3156	};
2430		3157
2431	cfg_load;	3158	reload_config;
2432	db_init;	3159	db_init;
2433	load_extensions;	3160	load_extensions;
2434		3161
2435	$TICK_WATCHER->start;	3162	$TICK_WATCHER->start;
2436	Event::loop;	3163	Event::loop;
…		…
2452	},	3179	},
2453	);	3180	);
2454	}	3181	}
2455	}	3182	}
2456		3183
		3184	sub write_runtime {
		3185	my $runtime = "$LOCALDIR/runtime";
		3186
		3187	# first touch the runtime file to show we are still running:
		3188	# the fsync below can take a very very long time.
		3189
		3190	IO::AIO::aio_utime $runtime, undef, undef;
		3191
		3192	my $guard = cf::lock_acquire "write_runtime";
		3193
		3194	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3195	or return;
		3196
		3197	my $value = $cf::RUNTIME + 90 + 10;
		3198	# 10 is the runtime save interval, for a monotonic clock
		3199	# 60 allows for the watchdog to kill the server.
		3200
		3201	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3202	and return;
		3203
		3204	# always fsync - this file is important
		3205	aio_fsync $fh
		3206	and return;
		3207
		3208	# touch it again to show we are up-to-date
		3209	aio_utime $fh, undef, undef;
		3210
		3211	close $fh
		3212	or return;
		3213
		3214	aio_rename "$runtime~", $runtime
		3215	and return;
		3216
		3217	warn "runtime file written.\n";
		3218
		3219	1
		3220	}
		3221
2457	sub emergency_save() {	3222	sub emergency_save() {
2458	my $freeze_guard = cf::freeze_mainloop;	3223	my $freeze_guard = cf::freeze_mainloop;
2459		3224
2460	warn "enter emergency perl save\n";	3225	warn "enter emergency perl save\n";
2461		3226
…		…
2492		3257
2493	warn Carp::longmess "post_cleanup backtrace"	3258	warn Carp::longmess "post_cleanup backtrace"
2494	if $make_core;	3259	if $make_core;
2495	}	3260	}
2496		3261
2497	sub reload() {	3262	sub do_reload_perl() {
2498	# can/must only be called in main	3263	# can/must only be called in main
2499	if ($Coro::current != $Coro::main) {	3264	if ($Coro::current != $Coro::main) {
2500	warn "can only reload from main coroutine";	3265	warn "can only reload from main coroutine";
2501	return;	3266	return;
2502	}	3267	}
…		…
2536	%EXT_CORO = ();	3301	%EXT_CORO = ();
2537		3302
2538	warn "removing commands";	3303	warn "removing commands";
2539	%COMMAND = ();	3304	%COMMAND = ();
2540		3305
2541	warn "removing ext commands";	3306	warn "removing ext/exti commands";
2542	%EXTCMD = ();	3307	%EXTCMD = ();
		3308	%EXTICMD = ();
2543		3309
2544	warn "unloading/nuking all extensions";	3310	warn "unloading/nuking all extensions";
2545	for my $pkg (@EXTS) {	3311	for my $pkg (@EXTS) {
2546	warn "... unloading $pkg";	3312	warn "... unloading $pkg";
2547		3313
…		…
2577	Symbol::delete_package "safe::$_"	3343	Symbol::delete_package "safe::$_"
2578	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3344	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2579		3345
2580	warn "unloading cf.pm \"a bit\"";	3346	warn "unloading cf.pm \"a bit\"";
2581	delete $INC{"cf.pm"};	3347	delete $INC{"cf.pm"};
		3348	delete $INC{"cf/pod.pm"};
2582		3349
2583	# don't, removes xs symbols, too,	3350	# don't, removes xs symbols, too,
2584	# and global variables created in xs	3351	# and global variables created in xs
2585	#Symbol::delete_package __PACKAGE__;	3352	#Symbol::delete_package __PACKAGE__;
2586		3353
…		…
2589	warn "reloading cf.pm";	3356	warn "reloading cf.pm";
2590	require cf;	3357	require cf;
2591	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3358	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2592		3359
2593	warn "loading config and database again";	3360	warn "loading config and database again";
2594	cf::cfg_load;	3361	cf::reload_config;
2595		3362
2596	warn "loading extensions";	3363	warn "loading extensions";
2597	cf::load_extensions;	3364	cf::load_extensions;
2598		3365
2599	warn "reattaching attachments to objects/players";	3366	warn "reattaching attachments to objects/players";
…		…
2601	warn "reattaching attachments to maps";	3368	warn "reattaching attachments to maps";
2602	reattach $_ for values %MAP;	3369	reattach $_ for values %MAP;
2603	warn "reattaching attachments to players";	3370	warn "reattaching attachments to players";
2604	reattach $_ for values %PLAYER;	3371	reattach $_ for values %PLAYER;
2605		3372
2606	warn "loading reloadable resources";
2607	reload_resources;
2608
2609	warn "leaving sync_job";	3373	warn "leaving sync_job";
2610		3374
2611	1	3375	1
2612	} or do {	3376	} or do {
2613	warn $@;	3377	warn $@;
…		…
2618	warn "reloaded";	3382	warn "reloaded";
2619	};	3383	};
2620		3384
2621	our $RELOAD_WATCHER; # used only during reload	3385	our $RELOAD_WATCHER; # used only during reload
2622		3386
		3387	sub reload_perl() {
		3388	# doing reload synchronously and two reloads happen back-to-back,
		3389	# coro crashes during coro_state_free->destroy here.
		3390
		3391	$RELOAD_WATCHER ||= Event->timer (
		3392	reentrant => 0,
		3393	after => 0,
		3394	data => WF_AUTOCANCEL,
		3395	cb => sub {
		3396	do_reload_perl;
		3397	undef $RELOAD_WATCHER;
		3398	},
		3399	);
		3400	}
		3401
2623	register_command "reload" => sub {	3402	register_command "reload" => sub {
2624	my ($who, $arg) = @_;	3403	my ($who, $arg) = @_;
2625		3404
2626	if ($who->flag (FLAG_WIZ)) {	3405	if ($who->flag (FLAG_WIZ)) {
2627	$who->message ("reloading server.");	3406	$who->message ("reloading server.");
2628		3407	async { reload_perl };
2629	# doing reload synchronously and two reloads happen back-to-back,
2630	# coro crashes during coro_state_free->destroy here.
2631
2632	$RELOAD_WATCHER ||= Event->timer (
2633	reentrant => 0,
2634	after => 0,
2635	data => WF_AUTOCANCEL,
2636	cb => sub {
2637	reload;
2638	undef $RELOAD_WATCHER;
2639	},
2640	);
2641	}	3408	}
2642	};	3409	};
2643		3410
2644	unshift @INC, $LIBDIR;	3411	unshift @INC, $LIBDIR;
2645		3412
2646	my $bug_warning = 0;	3413	my $bug_warning = 0;
2647		3414
		3415	our @WAIT_FOR_TICK;
		3416	our @WAIT_FOR_TICK_BEGIN;
		3417
		3418	sub wait_for_tick {
		3419	return unless $TICK_WATCHER->is_active;
		3420	return if $Coro::current == $Coro::main;
		3421
		3422	my $signal = new Coro::Signal;
		3423	push @WAIT_FOR_TICK, $signal;
		3424	$signal->wait;
		3425	}
		3426
		3427	sub wait_for_tick_begin {
		3428	return unless $TICK_WATCHER->is_active;
		3429	return if $Coro::current == $Coro::main;
		3430
		3431	my $signal = new Coro::Signal;
		3432	push @WAIT_FOR_TICK_BEGIN, $signal;
		3433	$signal->wait;
		3434	}
		3435
		3436	my $min = 1e6;#d#
		3437	my $avg = 10;
2648	$TICK_WATCHER = Event->timer (	3438	$TICK_WATCHER = Event->timer (
2649	reentrant => 0,	3439	reentrant => 0,
2650	parked => 1,	3440	parked => 1,
2651	prio => 0,	3441	prio => 0,
2652	at => $NEXT_TICK || $TICK,	3442	at => $NEXT_TICK || $TICK,
…		…
2656	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3446	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2657	unless ++$bug_warning > 10;	3447	unless ++$bug_warning > 10;
2658	return;	3448	return;
2659	}	3449	}
2660		3450
2661	$NOW = Event::time;	3451	$NOW = $tick_start = Event::time;
2662		3452
2663	cf::server_tick; # one server iteration	3453	cf::server_tick; # one server iteration
		3454
		3455	0 && sync_job {#d#
		3456	for(1..10) {
		3457	my $t = Event::time;
		3458	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3459	or die;
		3460
		3461	$map->width (50);
		3462	$map->height (50);
		3463	$map->alloc;
		3464	$map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
		3465	my $t = Event::time - $t;
		3466
		3467	#next unless $t < 0.0013;#d#
		3468	if ($t < $min) {
		3469	$min = $t;
		3470	}
		3471	$avg = $avg * 0.99 + $t * 0.01;
		3472	}
		3473	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3474	exit 0;
		3475	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3476	};
		3477
2664	$RUNTIME += $TICK;	3478	$RUNTIME += $TICK;
2665	$NEXT_TICK += $TICK;	3479	$NEXT_TICK += $TICK;
2666		3480
2667	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3481	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2668	$NEXT_RUNTIME_WRITE = $NOW + 10;	3482	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2670	write_runtime	3484	write_runtime
2671	or warn "ERROR: unable to write runtime file: $!";	3485	or warn "ERROR: unable to write runtime file: $!";
2672	};	3486	};
2673	}	3487	}
2674		3488
2675	$WAIT_FOR_TICK->broadcast;
2676	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2677
2678	# my $AFTER = Event::time;	3489	# my $AFTER = Event::time;
2679	# warn $AFTER - $NOW;#d#	3490	# warn $AFTER - $NOW;#d#
2680		3491
		3492	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3493	$sig->send;
		3494	}
		3495	while (my $sig = shift @WAIT_FOR_TICK) {
		3496	$sig->send;
		3497	}
		3498
		3499	$NOW = Event::time;
		3500
2681	# if we are delayed by four ticks or more, skip them all	3501	# if we are delayed by four ticks or more, skip them all
2682	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3502	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2683		3503
2684	$TICK_WATCHER->at ($NEXT_TICK);	3504	$TICK_WATCHER->at ($NEXT_TICK);
2685	$TICK_WATCHER->start;	3505	$TICK_WATCHER->start;
		3506
		3507	$LOAD = ($NOW - $tick_start) / $TICK;
		3508	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3509
		3510	_post_tick;
		3511
		3512
2686	},	3513	},
2687	);	3514	);
2688		3515
2689	{	3516	{
2690	BDB::max_poll_time $TICK * 0.1;	3517	BDB::max_poll_time $TICK * 0.1;
…		…
2718		3545
2719	cf::sync_job {	3546	cf::sync_job {
2720	eval {	3547	eval {
2721	BDB::db_env_open	3548	BDB::db_env_open
2722	$DB_ENV,	3549	$DB_ENV,
2723	$BDB_ENV_DIR,	3550	$BDBDIR,
2724	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3551	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2725	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3552	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2726	0666;	3553	0666;
2727		3554
2728	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3555	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2729		3556
2730	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3557	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2731	$DB_ENV->set_lk_detect;	3558	$DB_ENV->set_lk_detect;
2732	};	3559	};
2733		3560
…		…
2749	prio => 6,	3576	prio => 6,
2750	cb => \&IO::AIO::poll_cb,	3577	cb => \&IO::AIO::poll_cb,
2751	);	3578	);
2752	}	3579	}
2753		3580
		3581	my $_log_backtrace;
		3582
		3583	sub _log_backtrace {
		3584	my ($msg, @addr) = @_;
		3585
		3586	$msg =~ s/\n//;
		3587
		3588	# limit the # of concurrent backtraces
		3589	if ($_log_backtrace < 2) {
		3590	++$_log_backtrace;
		3591	async {
		3592	my @bt = fork_call {
		3593	@addr = map { sprintf "%x", $_ } @addr;
		3594	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3595	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3596	or die "addr2line: $!";
		3597
		3598	my @funcs;
		3599	my @res = <$fh>;
		3600	chomp for @res;
		3601	while (@res) {
		3602	my ($func, $line) = splice @res, 0, 2, ();
		3603	push @funcs, "[$func] $line";
		3604	}
		3605
		3606	@funcs
		3607	};
		3608
		3609	LOG llevInfo, "[ABT] $msg\n";
		3610	LOG llevInfo, "[ABT] $_\n" for @bt;
		3611	--$_log_backtrace;
		3612	};
		3613	} else {
		3614	LOG llevInfo, "[ABT] $msg\n";
		3615	LOG llevInfo, "[ABT] [suppressed]\n";
		3616	}
		3617	}
		3618
		3619	# load additional modules
		3620	use cf::pod;
		3621
2754	END { cf::emergency_save }	3622	END { cf::emergency_save }
2755		3623
2756	1	3624	1
2757		3625

Diff Legend

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