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.231 by root, Wed Apr 4 00:02:06 2007 UTC vs.
Revision 1.359 by root, Sat Sep 8 18:15:55 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;
		23	use Coro::Storable;
		24	use Coro::Util ();
21		25
		26	use JSON::XS ();
22	use BDB ();	27	use BDB ();
23	use Data::Dumper;	28	use Data::Dumper;
24	use Digest::MD5;	29	use Digest::MD5;
25	use Fcntl;	30	use Fcntl;
26	use YAML::Syck ();	31	use YAML::Syck ();
27	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
28	use Time::HiRes;	33	use Time::HiRes;
29	use Compress::LZF;	34	use Compress::LZF;
		35	use Digest::MD5 ();
30		36
31	# configure various modules to our taste	37	# configure various modules to our taste
32	#	38	#
		39	$Storable::canonical = 1; # reduce rsync transfers
33	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
34	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	41	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
35		42
36	$Event::Eval = 1; # no idea why this is required, but it is	43	$Event::Eval = 1; # no idea why this is required, but it is
37		44
…		…
45	our %COMMAND = ();	52	our %COMMAND = ();
46	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
47		54
48	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
49	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
50	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
51	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
52		60
53	our $RELOAD; # number of reloads so far	61	our $RELOAD; # number of reloads so far
54	our @EVENT;	62	our @EVENT;
55	our $LIBDIR = datadir . "/ext";
56		63
57	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(!)
58	our $TICK_WATCHER;	77	our $TICK_WATCHER;
59	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
60	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
61	our $NEXT_TICK;	80	our $NEXT_TICK;
62	our $NOW;	81	our $NOW;
…		…
68	our %CFG;	87	our %CFG;
69		88
70	our $UPTIME; $UPTIME ||= time;	89	our $UPTIME; $UPTIME ||= time;
71	our $RUNTIME;	90	our $RUNTIME;
72		91
73	our %PLAYER; # all users	92	our (%PLAYER, %PLAYER_LOADING); # all users
74	our %MAP; # all maps	93	our (%MAP, %MAP_LOADING ); # all maps
75	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
76	our $RANDOM_MAPS = cf::localdir . "/random";
77	our $BDB_ENV_DIR = cf::localdir . "/db";
78
79	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
80	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
81		95
82	# 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 ∕
83	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
84		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
85	binmode STDOUT;	103	binmode STDOUT;
86	binmode STDERR;	104	binmode STDERR;
87		105
88	# read virtual server time, if available	106	# read virtual server time, if available
89	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
90	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
91	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
92	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
93	}	111	}
94		112
95	mkdir cf::localdir;	113	mkdir $_
96	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
97	mkdir cf::localdir . "/" . cf::tmpdir;
98	mkdir cf::localdir . "/" . cf::uniquedir;
99	mkdir $RANDOM_MAPS;
100	mkdir $BDB_ENV_DIR;
101		115
102	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
103		117
104	sub cf::map::normalise;	118	sub cf::map::normalise;
105		119
…		…
116	=item $cf::RUNTIME	130	=item $cf::RUNTIME
117		131
118	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
119	every server tick.	133	every server tick.
120		134
121	=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
122		138
123	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
124	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.
125		143
126	=item $cf::NOW	144	=item $cf::NOW
127		145
128	The time of the last (current) server tick.	146	The time of the last (current) server tick.
129		147
130	=item $cf::TICK	148	=item $cf::TICK
131		149
132	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.
133		161
134	=item %cf::CFG	162	=item %cf::CFG
135		163
136	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
137	from wherever your confdir points to.	165	from wherever your confdir points to.
138		166
139	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
140		168
141	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
142	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
143	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.
144	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.
145		178
146	=back	179	=back
147		180
148	=cut	181	=cut
149		182
150	BEGIN {	183	BEGIN {
151	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
152	my $msg = join "", @_;	185	my $msg = join "", @_;
153	utf8::encode $msg;
154		186
155	$msg .= "\n"	187	$msg .= "\n"
156	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
157		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
158	LOG llevError, $msg;	193	LOG llevError, $msg;
159	};	194	};
160	}	195	}
161		196
162	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
163	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
164	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
165	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
166	@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';
167	@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)
168		204
169	# 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
170	# within the Safe compartment.	206	# within the Safe compartment.
171	for my $pkg (qw(	207	for my $pkg (qw(
172	cf::global cf::attachable	208	cf::global cf::attachable
…		…
180	}	216	}
181		217
182	$Event::DIED = sub {	218	$Event::DIED = sub {
183	warn "error in event callback: @_";	219	warn "error in event callback: @_";
184	};	220	};
		221
		222	#############################################################################
185		223
186	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
187		225
188	=over 4	226	=over 4
189		227
…		…
208	$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;
209	$d	247	$d
210	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
211	}	249	}
212		250
213	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
214
215	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
216		252
217	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
218		254
219	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
220		256
221	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]) }
222		265
223	=item cf::lock_wait $string	266	=item cf::lock_wait $string
224		267
225	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
226		269
…		…
229	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
230	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,
231	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
232	returned.	275	returned.
233		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
		279
234	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
235	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
236		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
237	=cut	287	=cut
238		288
239	our %LOCK;	289	our %LOCK;
		290	our %LOCKER;#d#
240		291
241	sub lock_wait($) {	292	sub lock_wait($) {
242	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#
243		299
244	# wait for lock, if any	300	# wait for lock, if any
245	while ($LOCK{$key}) {	301	while ($LOCK{$key}) {
246	push @{ $LOCK{$key} }, $Coro::current;	302	push @{ $LOCK{$key} }, $Coro::current;
247	Coro::schedule;	303	Coro::schedule;
…		…
253		309
254	# wait, to be sure we are not locked	310	# wait, to be sure we are not locked
255	lock_wait $key;	311	lock_wait $key;
256		312
257	$LOCK{$key} = [];	313	$LOCK{$key} = [];
		314	$LOCKER{$key} = $Coro::current;#d#
258		315
259	Coro::guard {	316	Coro::guard {
		317	delete $LOCKER{$key};#d#
260	# wake up all waiters, to be on the safe side	318	# wake up all waiters, to be on the safe side
261	$_->ready for @{ delete $LOCK{$key} };	319	$_->ready for @{ delete $LOCK{$key} };
262	}	320	}
		321	}
		322
		323	sub lock_active($) {
		324	my ($key) = @_;
		325
		326	! ! $LOCK{$key}
263	}	327	}
264		328
265	sub freeze_mainloop {	329	sub freeze_mainloop {
266	return unless $TICK_WATCHER->is_active;	330	return unless $TICK_WATCHER->is_active;
267		331
…		…
270	};	334	};
271	$TICK_WATCHER->stop;	335	$TICK_WATCHER->stop;
272	$guard	336	$guard
273	}	337	}
274		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
275	=item cf::async { BLOCK }	395	=item cf::async { BLOCK }
276		396
277	Currently the same as Coro::async_pool, meaning you cannot use	397	Currently the same as Coro::async_pool, meaning you cannot use
278	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
279	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.
…		…
282		402
283	BEGIN { *async = \&Coro::async_pool }	403	BEGIN { *async = \&Coro::async_pool }
284		404
285	=item cf::sync_job { BLOCK }	405	=item cf::sync_job { BLOCK }
286		406
287	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)
288	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
289	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.
290		411
291	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
292	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
293	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
294	fast or be very important.	415	fast or be very important.
…		…
297		418
298	sub sync_job(&) {	419	sub sync_job(&) {
299	my ($job) = @_;	420	my ($job) = @_;
300		421
301	if ($Coro::current == $Coro::main) {	422	if ($Coro::current == $Coro::main) {
		423	my $time = Event::time;
		424
302	# this is the main coro, too bad, we have to block	425	# this is the main coro, too bad, we have to block
303	# till the operation succeeds, freezing the server :/	426	# till the operation succeeds, freezing the server :/
304		427
305	# TODO: use suspend/resume instead	428	# TODO: use suspend/resume instead
306	# (but this is cancel-safe)	429	# (but this is cancel-safe)
…		…
317		440
318	while ($busy) {	441	while ($busy) {
319	Coro::cede or Event::one_event;	442	Coro::cede or Event::one_event;
320	}	443	}
321		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
322	wantarray ? @res : $res[0]	452	wantarray ? @res : $res[0]
323	} else {	453	} else {
324	# we are in another coroutine, how wonderful, everything just works	454	# we are in another coroutine, how wonderful, everything just works
325		455
326	$job->()	456	$job->()
…		…
345	$EXT_CORO{$coro+0} = $coro;	475	$EXT_CORO{$coro+0} = $coro;
346		476
347	$coro	477	$coro
348	}	478	}
349		479
350	sub write_runtime {	480	=item fork_call { }, $args
351	my $guard = cf::lock_acquire "write_runtime";
352		481
353	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.
354		486
355	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	487	=cut
356	or return;
357		488
358	my $value = $cf::RUNTIME + 90 + 10;	489	sub fork_call(&@) {
359	# 10 is the runtime save interval, for a monotonic clock	490	my ($cb, @args) = @_;
360	# 60 allows for the watchdog to kill the server.
361		491
362	(aio_write $fh, 0, (length $value), $value, 0) <= 0	492	# we seemingly have to make a local copy of the whole thing,
363	and return;	493	# otherwise perl prematurely frees the stuff :/
		494	# TODO: investigate and fix (likely this will be rather laborious)
364		495
365	# always fsync - this file is important	496	my @res = Coro::Util::fork_eval {
366	aio_fsync $fh	497	reset_signals;
367	and return;	498	&$cb
		499	}, @args;
368		500
369	close $fh	501	wantarray ? @res : $res[-1]
370	or return;	502	}
371		503
372	aio_rename "$runtime~", $runtime	504	=item $value = cf::db_get $family => $key
373	and return;
374		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	};
375	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"
376	}	618	}
377		619
378	=item cf::datalog type => key => value, ...	620	=item cf::datalog type => key => value, ...
379		621
380	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.
…		…
398	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")
399	to it. All such attachable objects support the following methods.	641	to it. All such attachable objects support the following methods.
400		642
401	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>
402	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
403	crossfire+).	645	Crossfire TRT).
404		646
405	=over 4	647	=over 4
406		648
407	=item $attachable->attach ($attachment, key => $value...)	649	=item $attachable->attach ($attachment, key => $value...)
408		650
…		…
571	$registry = $CB_TYPE[$object_type] ||= [];	813	$registry = $CB_TYPE[$object_type] ||= [];
572		814
573	} elsif ($type eq "subtype") {	815	} elsif ($type eq "subtype") {
574	defined $object_type or Carp::croak "subtype specified without type";	816	defined $object_type or Carp::croak "subtype specified without type";
575	my $object_subtype = shift @arg;	817	my $object_subtype = shift @arg;
576	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	818	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
577		819
578	} elsif ($type eq "package") {	820	} elsif ($type eq "package") {
579	my $pkg = shift @arg;	821	my $pkg = shift @arg;
580		822
581	while (my ($name, $id) = each %cb_id) {	823	while (my ($name, $id) = each %cb_id) {
…		…
610	_attach $registry, $klass, @attach;	852	_attach $registry, $klass, @attach;
611	}	853	}
612		854
613	$obj->{$name} = \%arg;	855	$obj->{$name} = \%arg;
614	} else {	856	} else {
615	warn "object uses attachment '$name' that is not available, postponing.\n";	857	warn "object uses attachment '$name' which is not available, postponing.\n";
616	}	858	}
617		859
618	$obj->{_attachment}{$name} = undef;	860	$obj->{_attachment}{$name} = undef;
619	}	861	}
620		862
…		…
622	if (ref $_[0]) {	864	if (ref $_[0]) {
623	_object_attach @_;	865	_object_attach @_;
624	} else {	866	} else {
625	_attach shift->_attach_registry, @_;	867	_attach shift->_attach_registry, @_;
626	}	868	}
		869	_recalc_want;
627	};	870	};
628		871
629	# all those should be optimised	872	# all those should be optimised
630	sub cf::attachable::detach {	873	sub cf::attachable::detach {
631	my ($obj, $name) = @_;	874	my ($obj, $name) = @_;
…		…
634	delete $obj->{_attachment}{$name};	877	delete $obj->{_attachment}{$name};
635	reattach ($obj);	878	reattach ($obj);
636	} else {	879	} else {
637	Carp::croak "cannot, currently, detach class attachments";	880	Carp::croak "cannot, currently, detach class attachments";
638	}	881	}
		882	_recalc_want;
639	};	883	};
640		884
641	sub cf::attachable::attached {	885	sub cf::attachable::attached {
642	my ($obj, $name) = @_;	886	my ($obj, $name) = @_;
643		887
…		…
658	";	902	";
659	die if $@;	903	die if $@;
660	}	904	}
661		905
662	our $override;	906	our $override;
663	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?
664		908
665	sub override {	909	sub override {
666	$override = 1;	910	$override = 1;
667	@invoke_results = ();	911	@INVOKE_RESULTS = (@_);
668	}	912	}
669		913
670	sub do_invoke {	914	sub do_invoke {
671	my $event = shift;	915	my $event = shift;
672	my $callbacks = shift;	916	my $callbacks = shift;
673		917
674	@invoke_results = ();	918	@INVOKE_RESULTS = ();
675		919
676	local $override;	920	local $override;
677		921
678	for (@$callbacks) {	922	for (@$callbacks) {
679	eval { &{$_->[1]} };	923	eval { &{$_->[1]} };
…		…
696		940
697	Generate an object-specific event with the given arguments.	941	Generate an object-specific event with the given arguments.
698		942
699	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
700	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
701	results (if you must, access C<@cf::invoke_results> directly).	945	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
702		946
703	=back	947	=back
704		948
705	=cut	949	=cut
706		950
707	#############################################################################	951	#############################################################################
708	# 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	}
709		964
710	sub reattach {	965	sub reattach {
711	# basically do the same as instantiate, without calling instantiate	966	# basically do the same as instantiate, without calling instantiate
712	my ($obj) = @_;	967	my ($obj) = @_;
713		968
…		…
757	},	1012	},
758	);	1013	);
759		1014
760	sub object_freezer_save {	1015	sub object_freezer_save {
761	my ($filename, $rdata, $objs) = @_;	1016	my ($filename, $rdata, $objs) = @_;
		1017
		1018	my $guard = cf::lock_acquire "io";
762		1019
763	sync_job {	1020	sync_job {
764	if (length $$rdata) {	1021	if (length $$rdata) {
765	warn sprintf "saving %s (%d,%d)\n",	1022	warn sprintf "saving %s (%d,%d)\n",
766	$filename, length $$rdata, scalar @$objs;	1023	$filename, length $$rdata, scalar @$objs;
…		…
790	}	1047	}
791	} else {	1048	} else {
792	aio_unlink $filename;	1049	aio_unlink $filename;
793	aio_unlink "$filename.pst";	1050	aio_unlink "$filename.pst";
794	}	1051	}
795	}	1052	};
		1053
		1054	undef $guard;
796	}	1055	}
797		1056
798	sub object_freezer_as_string {	1057	sub object_freezer_as_string {
799	my ($rdata, $objs) = @_;	1058	my ($rdata, $objs) = @_;
800		1059
…		…
805		1064
806	sub object_thawer_load {	1065	sub object_thawer_load {
807	my ($filename) = @_;	1066	my ($filename) = @_;
808		1067
809	my ($data, $av);	1068	my ($data, $av);
		1069
		1070	my $guard = cf::lock_acquire "io";
810		1071
811	(aio_load $filename, $data) >= 0	1072	(aio_load $filename, $data) >= 0
812	or return;	1073	or return;
813		1074
814	unless (aio_stat "$filename.pst") {	1075	unless (aio_stat "$filename.pst") {
815	(aio_load "$filename.pst", $av) >= 0	1076	(aio_load "$filename.pst", $av) >= 0
816	or return;	1077	or return;
		1078
		1079	undef $guard;
817	$av = eval { (Storable::thaw $av)->{objs} };	1080	$av = eval { (Storable::thaw $av)->{objs} };
818	}	1081	}
819		1082
820	warn sprintf "loading %s (%d)\n",	1083	warn sprintf "loading %s (%d)\n",
821	$filename, length $data, scalar @{$av || []};#d#	1084	$filename, length $data, scalar @{$av || []};
		1085
822	return ($data, $av);	1086	($data, $av)
823	}	1087	}
		1088
		1089	=head2 COMMAND CALLBACKS
		1090
		1091	=over 4
		1092
		1093	=cut
824		1094
825	#############################################################################	1095	#############################################################################
826	# command handling &c	1096	# command handling &c
827		1097
828	=item cf::register_command $name => \&callback($ob,$args);	1098	=item cf::register_command $name => \&callback($ob,$args);
…		…
841	push @{ $COMMAND{$name} }, [$caller, $cb];	1111	push @{ $COMMAND{$name} }, [$caller, $cb];
842	}	1112	}
843		1113
844	=item cf::register_extcmd $name => \&callback($pl,$packet);	1114	=item cf::register_extcmd $name => \&callback($pl,$packet);
845		1115
846	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.
847		1121
848	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
849	called.	1123	called.
850		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
851	=cut	1136	=cut
852		1137
853	sub register_extcmd {	1138	sub register_extcmd {
854	my ($name, $cb) = @_;	1139	my ($name, $cb) = @_;
855		1140
856	$EXTCMD{$name} = $cb;	1141	$EXTCMD{$name} = $cb;
		1142	}
		1143
		1144	sub register_exticmd {
		1145	my ($name, $cb) = @_;
		1146
		1147	$EXTICMD{$name} = $cb;
857	}	1148	}
858		1149
859	cf::player->attach (	1150	cf::player->attach (
860	on_command => sub {	1151	on_command => sub {
861	my ($pl, $name, $params) = @_;	1152	my ($pl, $name, $params) = @_;
…		…
870	cf::override;	1161	cf::override;
871	},	1162	},
872	on_extcmd => sub {	1163	on_extcmd => sub {
873	my ($pl, $buf) = @_;	1164	my ($pl, $buf) = @_;
874		1165
875	my $msg = eval { from_json $buf };	1166	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
876		1167
877	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
878	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1176	if (my $cb = $EXTCMD{$type}) {
879	if (my %reply = $cb->($pl, $msg)) {	1177	@reply = $cb->($pl, @payload);
880	$pl->ext_reply ($msg->{msgid}, %reply);
881	}
882	}	1178	}
		1179
		1180	$pl->ext_reply ($reply, @reply)
		1181	if $reply;
		1182
883	} else {	1183	} else {
884	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1184	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
885	}	1185	}
886		1186
887	cf::override;	1187	cf::override;
888	},	1188	},
889	);	1189	);
890		1190
891	sub load_extension {
892	my ($path) = @_;
893
894	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
895	my $base = $1;
896	my $pkg = $1;
897	$pkg =~ s/[^[:word:]]/_/g;
898	$pkg = "ext::$pkg";
899
900	warn "... loading '$path' into '$pkg'\n";
901
902	open my $fh, "<:utf8", $path
903	or die "$path: $!";
904
905	my $source =
906	"package $pkg; use strict; use utf8;\n"
907	. "#line 1 \"$path\"\n{\n"
908	. (do { local $/; <$fh> })
909	. "\n};\n1";
910
911	unless (eval $source) {
912	my $msg = $@ ? "$path: $@\n"
913	: "extension disabled.\n";
914	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
915	warn $@;
916	warn "mandatory extension failed to load, exiting.\n";
917	exit 1;
918	}
919	die $@;
920	}
921
922	push @EXTS, $pkg;
923	}
924
925	sub load_extensions {	1191	sub load_extensions {
		1192	cf::sync_job {
		1193	my %todo;
		1194
926	for my $ext (<$LIBDIR/*.ext>) {	1195	for my $path (<$LIBDIR/*.ext>) {
927	next unless -r $ext;	1196	next unless -r $path;
928	eval {	1197
929	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;
930	1	1255	}
931	} or warn "$ext not loaded: $@";	1256
		1257	skip:
		1258	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1259	unless $progress;
		1260	}
932	}	1261	};
933	}	1262	}
934		1263
935	#############################################################################	1264	#############################################################################
936		1265
		1266	=back
		1267
937	=head2 CORE EXTENSIONS	1268	=head2 CORE EXTENSIONS
938		1269
939	Functions and methods that extend core crossfire objects.	1270	Functions and methods that extend core crossfire objects.
940		1271
941	=cut	1272	=cut
…		…
953	Returns the given player object, loading it if necessary (might block).	1284	Returns the given player object, loading it if necessary (might block).
954		1285
955	=cut	1286	=cut
956		1287
957	sub playerdir($) {	1288	sub playerdir($) {
958	cf::localdir	1289	"$PLAYERDIR/"
959	. "/"
960	. cf::playerdir
961	. "/"
962	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1290	. (ref $_[0] ? $_[0]->ob->name : $_[0])
963	}	1291	}
964		1292
965	sub path($) {	1293	sub path($) {
966	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1294	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
967		1295
968	(playerdir $login) . "/$login.pl"	1296	(playerdir $login) . "/playerdata"
969	}	1297	}
970		1298
971	sub find_active($) {	1299	sub find_active($) {
972	$cf::PLAYER{$_[0]}	1300	$cf::PLAYER{$_[0]}
973	and $cf::PLAYER{$_[0]}->active	1301	and $cf::PLAYER{$_[0]}->active
…		…
986	my $login = $_[0];	1314	my $login = $_[0];
987		1315
988	my $guard = cf::lock_acquire "user_find:$login";	1316	my $guard = cf::lock_acquire "user_find:$login";
989		1317
990	$cf::PLAYER{$_[0]} || do {	1318	$cf::PLAYER{$_[0]} || do {
991	my $pl = load_pl path $login	1319	# rename old playerfiles to new ones
		1320	#TODO: remove when no longer required
		1321	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1322	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1323	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1324	aio_unlink +(playerdir $login) . "/$login.pl";
		1325
		1326	my $f = new_from_file cf::object::thawer path $login
992	or return;	1327	or return;
		1328
		1329	$f->next;
		1330	my $pl = cf::player::load_pl $f
		1331	or return;
		1332	local $cf::PLAYER_LOADING{$login} = $pl;
		1333	$f->resolve_delayed_derefs;
993	$cf::PLAYER{$login} = $pl	1334	$cf::PLAYER{$login} = $pl
994	}	1335	}
995	}	1336	}
996	}	1337	}
997		1338
…		…
1007		1348
1008	aio_mkdir playerdir $pl, 0770;	1349	aio_mkdir playerdir $pl, 0770;
1009	$pl->{last_save} = $cf::RUNTIME;	1350	$pl->{last_save} = $cf::RUNTIME;
1010		1351
1011	$pl->save_pl ($path);	1352	$pl->save_pl ($path);
1012	Coro::cede;	1353	cf::cede_to_tick;
1013	}	1354	}
1014		1355
1015	sub new($) {	1356	sub new($) {
1016	my ($login) = @_;	1357	my ($login) = @_;
1017		1358
…		…
1021	$self->{deny_save} = 1;	1362	$self->{deny_save} = 1;
1022		1363
1023	$cf::PLAYER{$login} = $self;	1364	$cf::PLAYER{$login} = $self;
1024		1365
1025	$self	1366	$self
		1367	}
		1368
		1369	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1370
		1371	=cut
		1372
		1373	sub send_msg {
		1374	my $ns = shift->ns
		1375	or return;
		1376	$ns->send_msg (@_);
1026	}	1377	}
1027		1378
1028	=item $pl->quit_character	1379	=item $pl->quit_character
1029		1380
1030	Nukes the player without looking back. If logged in, the connection will	1381	Nukes the player without looking back. If logged in, the connection will
…		…
1079	while and may block, so not sync_job-capable, ever.	1430	while and may block, so not sync_job-capable, ever.
1080		1431
1081	=cut	1432	=cut
1082		1433
1083	sub list_logins {	1434	sub list_logins {
1084	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1435	my $dirs = aio_readdir $PLAYERDIR
1085	or return [];	1436	or return [];
1086		1437
1087	my @logins;	1438	my @logins;
1088		1439
1089	for my $login (@$dirs) {	1440	for my $login (@$dirs) {
		1441	my $path = path $login;
		1442
		1443	# a .pst is a dead give-away for a valid player
		1444	unless (-e "$path.pst") {
1090	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1445	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1091	aio_read $fh, 0, 512, my $buf, 0 or next;	1446	aio_read $fh, 0, 512, my $buf, 0 or next;
1092	$buf !~ /^password -------------$/m or next; # official not-valid tag	1447	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1448	}
1093		1449
1094	utf8::decode $login;	1450	utf8::decode $login;
1095	push @logins, $login;	1451	push @logins, $login;
1096	}	1452	}
1097		1453
…		…
1124	}	1480	}
1125		1481
1126	\@paths	1482	\@paths
1127	}	1483	}
1128		1484
		1485	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1486
		1487	Expand crossfire pod fragments into protocol xml.
		1488
		1489	=cut
		1490
		1491	sub expand_cfpod {
		1492	((my $self), (local $_)) = @_;
		1493
		1494	# escape & and <
		1495	s/&/&amp;/g;
		1496	s/(?<![BIUGHT])</&lt;/g;
		1497
		1498	# this is buggy, it needs to properly take care of nested <'s
		1499
		1500	1 while
		1501	# replace B<>, I<>, U<> etc.
		1502	s/B<([^\>]*)>/<b>$1<\/b>/
		1503	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1504	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1505	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1506	# replace G<male|female> tags
		1507	|| s{G<([^>|]*)\|([^>]*)>}{
		1508	$self->gender ? $2 : $1
		1509	}ge
		1510	# replace H<hint text>
		1511	|| s{H<([^\>]*)>}
		1512	{
		1513	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1514	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1515	"")
		1516	[$self->{hintmode}]
		1517	}ge;
		1518
		1519	# create single paragraphs (very hackish)
		1520	s/(?<=\S)\n(?=\w)/ /g;
		1521
		1522	# compress some whitespace
		1523	s/\s+\n/\n/g; # ws line-ends
		1524	s/\n\n+/\n/g; # double lines
		1525	s/^\n+//; # beginning lines
		1526	s/\n+$//; # ending lines
		1527
		1528	$_
		1529	}
		1530
		1531	sub hintmode {
		1532	$_[0]{hintmode} = $_[1] if @_ > 1;
		1533	$_[0]{hintmode}
		1534	}
		1535
1129	=item $player->ext_reply ($msgid, %msg)	1536	=item $player->ext_reply ($msgid, @msg)
1130		1537
1131	Sends an ext reply to the player.	1538	Sends an ext reply to the player.
1132		1539
1133	=cut	1540	=cut
1134		1541
1135	sub ext_reply($$%) {	1542	sub ext_reply($$@) {
1136	my ($self, $id, %msg) = @_;	1543	my ($self, $id, @msg) = @_;
1137		1544
1138	$msg{msgid} = $id;	1545	$self->ns->ext_reply ($id, @msg)
1139
1140	$self->send ("ext " . cf::to_json \%msg);
1141	}	1546	}
1142		1547
1143	=item $player->ext_event ($type, %msg)	1548	=item $player->ext_msg ($type, @msg)
1144		1549
1145	Sends an ext event to the client.	1550	Sends an ext event to the client.
1146		1551
1147	=cut	1552	=cut
1148		1553
1149	sub ext_event($$%) {	1554	sub ext_msg($$@) {
1150	my ($self, $type, %msg) = @_;	1555	my ($self, $type, @msg) = @_;
1151		1556
1152	delete $msg{msgid};	1557	$self->ns->ext_msg ($type, @msg);
1153	$msg{msgtype} = "event";
1154	$msg{eventtype} = $type;
1155
1156	$self->send ("ext " . cf::to_json \%msg);
1157	}	1558	}
1158		1559
1159	package cf;	1560	=head3 cf::region
		1561
		1562	=over 4
		1563
		1564	=cut
		1565
		1566	package cf::region;
		1567
		1568	=item cf::region::find_by_path $path
		1569
		1570	Tries to decuce the likely region for a map knowing only its path.
		1571
		1572	=cut
		1573
		1574	sub find_by_path($) {
		1575	my ($path) = @_;
		1576
		1577	my ($match, $specificity);
		1578
		1579	for my $region (list) {
		1580	if ($region->{match} && $path =~ $region->{match}) {
		1581	($match, $specificity) = ($region, $region->specificity)
		1582	if $region->specificity > $specificity;
		1583	}
		1584	}
		1585
		1586	$match
		1587	}
1160		1588
1161	=back	1589	=back
1162
1163		1590
1164	=head3 cf::map	1591	=head3 cf::map
1165		1592
1166	=over 4	1593	=over 4
1167		1594
…		…
1222	my ($self, $merge) = @_;	1649	my ($self, $merge) = @_;
1223		1650
1224	# we have to keep some variables in memory intact	1651	# we have to keep some variables in memory intact
1225	local $self->{path};	1652	local $self->{path};
1226	local $self->{load_path};	1653	local $self->{load_path};
1227	local $self->{deny_save};
1228	local $self->{deny_reset};
1229		1654
1230	$self->SUPER::thawer_merge ($merge);	1655	$self->SUPER::thawer_merge ($merge);
1231	}	1656	}
1232		1657
1233	sub normalise {	1658	sub normalise {
…		…
1280	$self->init; # pass $1 etc.	1705	$self->init; # pass $1 etc.
1281	return $self;	1706	return $self;
1282	}	1707	}
1283	}	1708	}
1284		1709
1285	Carp::carp "unable to resolve path '$path' (base '$base').";	1710	Carp::cluck "unable to resolve path '$path' (base '$base').";
1286	()	1711	()
1287	}	1712	}
1288		1713
1289	sub init {	1714	sub init {
1290	my ($self) = @_;	1715	my ($self) = @_;
…		…
1305		1730
1306	# the original (read-only) location	1731	# the original (read-only) location
1307	sub load_path {	1732	sub load_path {
1308	my ($self) = @_;	1733	my ($self) = @_;
1309		1734
1310	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1735	"$MAPDIR/$self->{path}.map"
1311	}	1736	}
1312		1737
1313	# the temporary/swap location	1738	# the temporary/swap location
1314	sub save_path {	1739	sub save_path {
1315	my ($self) = @_;	1740	my ($self) = @_;
1316		1741
1317	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1742	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1318	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1743	"$TMPDIR/$path.map"
1319	}	1744	}
1320		1745
1321	# the unique path, undef == no special unique path	1746	# the unique path, undef == no special unique path
1322	sub uniq_path {	1747	sub uniq_path {
1323	my ($self) = @_;	1748	my ($self) = @_;
1324		1749
1325	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1750	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1326	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1751	"$UNIQUEDIR/$path"
1327	}	1752	}
1328		1753
1329	# and all this just because we cannot iterate over	1754	# and all this just because we cannot iterate over
1330	# all maps in C++...	1755	# all maps in C++...
1331	sub change_all_map_light {	1756	sub change_all_map_light {
…		…
1333		1758
1334	$_->change_map_light ($change)	1759	$_->change_map_light ($change)
1335	for grep $_->outdoor, values %cf::MAP;	1760	for grep $_->outdoor, values %cf::MAP;
1336	}	1761	}
1337		1762
		1763	sub decay_objects {
		1764	my ($self) = @_;
		1765
		1766	return if $self->{deny_reset};
		1767
		1768	$self->do_decay_objects;
		1769	}
		1770
1338	sub unlink_save {	1771	sub unlink_save {
1339	my ($self) = @_;	1772	my ($self) = @_;
1340		1773
1341	utf8::encode (my $save = $self->save_path);	1774	utf8::encode (my $save = $self->save_path);
1342	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1775	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1345		1778
1346	sub load_header_from($) {	1779	sub load_header_from($) {
1347	my ($self, $path) = @_;	1780	my ($self, $path) = @_;
1348		1781
1349	utf8::encode $path;	1782	utf8::encode $path;
1350	#aio_open $path, O_RDONLY, 0	1783	my $f = new_from_file cf::object::thawer $path
1351	# or return;
1352
1353	$self->_load_header ($path)
1354	or return;	1784	or return;
		1785
		1786	$self->_load_header ($f)
		1787	or return;
		1788
		1789	local $MAP_LOADING{$self->{path}} = $self;
		1790	$f->resolve_delayed_derefs;
1355		1791
1356	$self->{load_path} = $path;	1792	$self->{load_path} = $path;
1357		1793
1358	1	1794	1
1359	}	1795	}
…		…
1398	$self->load_header_orig	1834	$self->load_header_orig
1399	or return;	1835	or return;
1400	$self->prepare_orig;	1836	$self->prepare_orig;
1401	}	1837	}
1402		1838
		1839	$self->{deny_reset} = 1
		1840	if $self->no_reset;
		1841
		1842	$self->default_region (cf::region::find_by_path $self->{path})
		1843	unless $self->default_region;
		1844
1403	1	1845	1
1404	}	1846	}
1405		1847
1406	sub find;	1848	sub find;
1407	sub find {	1849	sub find {
1408	my ($path, $origin) = @_;	1850	my ($path, $origin) = @_;
1409		1851
1410	$path = normalise $path, $origin && $origin->path;	1852	$path = normalise $path, $origin && $origin->path;
1411		1853
		1854	cf::lock_wait "map_data:$path";#d#remove
1412	cf::lock_wait "map_find:$path";	1855	cf::lock_wait "map_find:$path";
1413		1856
1414	$cf::MAP{$path} || do {	1857	$cf::MAP{$path} || do {
1415	my $guard = cf::lock_acquire "map_find:$path";	1858	my $guard1 = cf::lock_acquire "map_find:$path";
		1859	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1860
1416	my $map = new_from_path cf::map $path	1861	my $map = new_from_path cf::map $path
1417	or return;	1862	or return;
1418		1863
1419	$map->{last_save} = $cf::RUNTIME;	1864	$map->{last_save} = $cf::RUNTIME;
1420		1865
1421	$map->load_header	1866	$map->load_header
1422	or return;	1867	or return;
1423		1868
1424	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1869	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1425	# doing this can freeze the server in a sync job, obviously	1870	# doing this can freeze the server in a sync job, obviously
1426	#$cf::WAIT_FOR_TICK->wait;	1871	#$cf::WAIT_FOR_TICK->wait;
		1872	undef $guard1;
		1873	undef $guard2;
1427	$map->reset;	1874	$map->reset;
1428	undef $guard;
1429	return find $path;	1875	return find $path;
1430	}	1876	}
1431		1877
1432	$cf::MAP{$path} = $map	1878	$cf::MAP{$path} = $map
1433	}	1879	}
…		…
1440	my ($self) = @_;	1886	my ($self) = @_;
1441		1887
1442	local $self->{deny_reset} = 1; # loading can take a long time	1888	local $self->{deny_reset} = 1; # loading can take a long time
1443		1889
1444	my $path = $self->{path};	1890	my $path = $self->{path};
		1891
		1892	{
1445	my $guard = cf::lock_acquire "map_load:$path";	1893	my $guard = cf::lock_acquire "map_data:$path";
1446		1894
		1895	return unless $self->valid;
1447	return if $self->in_memory != cf::MAP_SWAPPED;	1896	return if $self->in_memory != cf::MAP_SWAPPED;
1448		1897
1449	$self->in_memory (cf::MAP_LOADING);	1898	$self->in_memory (cf::MAP_LOADING);
1450		1899
1451	$self->alloc;	1900	$self->alloc;
1452		1901
1453	$self->pre_load;	1902	$self->pre_load;
		1903	cf::cede_to_tick;
1454		1904
1455	$self->_load_objects ($self->{load_path}, 1)	1905	my $f = new_from_file cf::object::thawer $self->{load_path};
		1906	$f->skip_block;
		1907	$self->_load_objects ($f)
1456	or return;	1908	or return;
1457		1909
1458	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1910	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1459	if delete $self->{load_original};	1911	if delete $self->{load_original};
1460		1912
1461	if (my $uniq = $self->uniq_path) {	1913	if (my $uniq = $self->uniq_path) {
1462	utf8::encode $uniq;	1914	utf8::encode $uniq;
1463	if (aio_open $uniq, O_RDONLY, 0) {	1915	unless (aio_stat $uniq) {
		1916	if (my $f = new_from_file cf::object::thawer $uniq) {
1464	$self->clear_unique_items;	1917	$self->clear_unique_items;
1465	$self->_load_objects ($uniq, 0);	1918	$self->_load_objects ($f);
		1919	$f->resolve_delayed_derefs;
		1920	}
1466	}	1921	}
1467	}	1922	}
1468		1923
1469	Coro::cede;	1924	$f->resolve_delayed_derefs;
1470		1925
		1926	cf::cede_to_tick;
1471	# now do the right thing for maps	1927	# now do the right thing for maps
1472	$self->link_multipart_objects;	1928	$self->link_multipart_objects;
1473
1474	unless ($self->{deny_activate}) {
1475	$self->decay_objects;
1476	$self->fix_auto_apply;
1477	$self->update_buttons;
1478	Coro::cede;
1479	$self->set_darkness_map;
1480	$self->difficulty ($self->estimate_difficulty)	1929	$self->difficulty ($self->estimate_difficulty)
1481	unless $self->difficulty;	1930	unless $self->difficulty;
1482	Coro::cede;	1931	cf::cede_to_tick;
		1932
		1933	unless ($self->{deny_activate}) {
		1934	$self->decay_objects;
		1935	$self->fix_auto_apply;
		1936	$self->update_buttons;
		1937	cf::cede_to_tick;
		1938	$self->set_darkness_map;
		1939	cf::cede_to_tick;
1483	$self->activate;	1940	$self->activate;
		1941	}
		1942
		1943	$self->{last_save} = $cf::RUNTIME;
		1944	$self->last_access ($cf::RUNTIME);
		1945
		1946	$self->in_memory (cf::MAP_IN_MEMORY);
1484	}	1947	}
1485		1948
1486	$self->post_load;	1949	$self->post_load;
1487
1488	$self->in_memory (cf::MAP_IN_MEMORY);
1489	}	1950	}
1490		1951
1491	sub customise_for {	1952	sub customise_for {
1492	my ($self, $ob) = @_;	1953	my ($self, $ob) = @_;
1493		1954
1494	return find "~" . $ob->name . "/" . $self->{path}	1955	return find "~" . $ob->name . "/" . $self->{path}
1495	if $self->per_player;	1956	if $self->per_player;
1496		1957
		1958	# return find "?party/" . $ob->name . "/" . $self->{path}
		1959	# if $self->per_party;
		1960
1497	$self	1961	$self
1498	}	1962	}
1499		1963
1500	# find and load all maps in the 3x3 area around a map	1964	# find and load all maps in the 3x3 area around a map
1501	sub load_diag {	1965	sub load_neighbours {
1502	my ($map) = @_;	1966	my ($map) = @_;
1503		1967
1504	my @diag; # diagonal neighbours	1968	my @neigh; # diagonal neighbours
1505		1969
1506	for (0 .. 3) {	1970	for (0 .. 3) {
1507	my $neigh = $map->tile_path ($_)	1971	my $neigh = $map->tile_path ($_)
1508	or next;	1972	or next;
1509	$neigh = find $neigh, $map	1973	$neigh = find $neigh, $map
1510	or next;	1974	or next;
1511	$neigh->load;	1975	$neigh->load;
1512		1976
		1977	push @neigh,
1513	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1978	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1514	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1979	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1515	}	1980	}
1516		1981
1517	for (@diag) {	1982	for (grep defined $_->[0], @neigh) {
		1983	my ($path, $origin) = @$_;
1518	my $neigh = find @$_	1984	my $neigh = find $path, $origin
1519	or next;	1985	or next;
1520	$neigh->load;	1986	$neigh->load;
1521	}	1987	}
1522	}	1988	}
1523		1989
…		…
1528	}	1994	}
1529		1995
1530	sub do_load_sync {	1996	sub do_load_sync {
1531	my ($map) = @_;	1997	my ($map) = @_;
1532		1998
		1999	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2000	if $Coro::current == $Coro::main;
		2001
1533	cf::sync_job { $map->load };	2002	cf::sync_job { $map->load };
1534	}	2003	}
1535		2004
1536	our %MAP_PREFETCH;	2005	our %MAP_PREFETCH;
1537	our $MAP_PREFETCHER = undef;	2006	our $MAP_PREFETCHER = undef;
1538		2007
1539	sub find_async {	2008	sub find_async {
1540	my ($path, $origin) = @_;	2009	my ($path, $origin, $load) = @_;
1541		2010
1542	$path = normalise $path, $origin && $origin->{path};	2011	$path = normalise $path, $origin && $origin->{path};
1543		2012
1544	if (my $map = $cf::MAP{$path}) {	2013	if (my $map = $cf::MAP{$path}) {
1545	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2014	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1546	}	2015	}
1547		2016
1548	undef $MAP_PREFETCH{$path};	2017	$MAP_PREFETCH{$path} |= $load;
		2018
1549	$MAP_PREFETCHER ||= cf::async {	2019	$MAP_PREFETCHER ||= cf::async {
1550	while (%MAP_PREFETCH) {	2020	while (%MAP_PREFETCH) {
1551	for my $path (keys %MAP_PREFETCH) {	2021	while (my ($k, $v) = each %MAP_PREFETCH) {
1552	my $map = find $path	2022	if (my $map = find $k) {
1553	or next;
1554	$map->load;	2023	$map->load if $v;
		2024	}
1555		2025
1556	delete $MAP_PREFETCH{$path};	2026	delete $MAP_PREFETCH{$k};
1557	}	2027	}
1558	}	2028	}
1559	undef $MAP_PREFETCHER;	2029	undef $MAP_PREFETCHER;
1560	};	2030	};
1561	$MAP_PREFETCHER->prio (6);	2031	$MAP_PREFETCHER->prio (6);
…		…
1564	}	2034	}
1565		2035
1566	sub save {	2036	sub save {
1567	my ($self) = @_;	2037	my ($self) = @_;
1568		2038
1569	my $lock = cf::lock_acquire "map_data:" . $self->path;	2039	my $lock = cf::lock_acquire "map_data:$self->{path}";
1570		2040
1571	$self->{last_save} = $cf::RUNTIME;	2041	$self->{last_save} = $cf::RUNTIME;
1572		2042
1573	return unless $self->dirty;	2043	return unless $self->dirty;
1574		2044
…		…
1597	my ($self) = @_;	2067	my ($self) = @_;
1598		2068
1599	# save first because save cedes	2069	# save first because save cedes
1600	$self->save;	2070	$self->save;
1601		2071
1602	my $lock = cf::lock_acquire "map_data:" . $self->path;	2072	my $lock = cf::lock_acquire "map_data:$self->{path}";
1603		2073
1604	return if $self->players;	2074	return if $self->players;
1605	return if $self->in_memory != cf::MAP_IN_MEMORY;	2075	return if $self->in_memory != cf::MAP_IN_MEMORY;
1606	return if $self->{deny_save};	2076	return if $self->{deny_save};
1607		2077
		2078	$self->in_memory (cf::MAP_SWAPPED);
		2079
		2080	$self->deactivate;
		2081	$_->clear_links_to ($self) for values %cf::MAP;
1608	$self->clear;	2082	$self->clear;
1609	$self->in_memory (cf::MAP_SWAPPED);
1610	}	2083	}
1611		2084
1612	sub reset_at {	2085	sub reset_at {
1613	my ($self) = @_;	2086	my ($self) = @_;
1614		2087
1615	# TODO: safety, remove and allow resettable per-player maps	2088	# TODO: safety, remove and allow resettable per-player maps
1616	return 1e99 if $self->isa ("ext::map_per_player");#d#
1617	return 1e99 if $self->{deny_reset};	2089	return 1e99 if $self->{deny_reset};
1618		2090
1619	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2091	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1620	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2092	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1621		2093
…		…
1632	my ($self) = @_;	2104	my ($self) = @_;
1633		2105
1634	my $lock = cf::lock_acquire "map_data:$self->{path}";	2106	my $lock = cf::lock_acquire "map_data:$self->{path}";
1635		2107
1636	return if $self->players;	2108	return if $self->players;
1637	return if $self->isa ("ext::map_per_player");#d#
1638		2109
1639	warn "resetting map ", $self->path;#d#	2110	warn "resetting map ", $self->path;
1640		2111
1641	$self->in_memory (cf::MAP_SWAPPED);	2112	$self->in_memory (cf::MAP_SWAPPED);
1642		2113
1643	# need to save uniques path	2114	# need to save uniques path
1644	unless ($self->{deny_save}) {	2115	unless ($self->{deny_save}) {
…		…
1648	if $uniq;	2119	if $uniq;
1649	}	2120	}
1650		2121
1651	delete $cf::MAP{$self->path};	2122	delete $cf::MAP{$self->path};
1652		2123
		2124	$self->deactivate;
		2125	$_->clear_links_to ($self) for values %cf::MAP;
1653	$self->clear;	2126	$self->clear;
1654
1655	$_->clear_links_to ($self) for values %cf::MAP;
1656		2127
1657	$self->unlink_save;	2128	$self->unlink_save;
1658	$self->destroy;	2129	$self->destroy;
1659	}	2130	}
1660		2131
1661	my $nuke_counter = "aaaa";	2132	my $nuke_counter = "aaaa";
1662		2133
1663	sub nuke {	2134	sub nuke {
1664	my ($self) = @_;	2135	my ($self) = @_;
1665		2136
		2137	{
		2138	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2139
1666	delete $cf::MAP{$self->path};	2140	delete $cf::MAP{$self->path};
1667		2141
1668	$self->unlink_save;	2142	$self->unlink_save;
1669		2143
1670	bless $self, "cf::map";	2144	bless $self, "cf::map";
1671	delete $self->{deny_reset};	2145	delete $self->{deny_reset};
1672	$self->{deny_save} = 1;	2146	$self->{deny_save} = 1;
1673	$self->reset_timeout (1);	2147	$self->reset_timeout (1);
1674	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2148	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1675		2149
1676	$cf::MAP{$self->path} = $self;	2150	$cf::MAP{$self->path} = $self;
		2151	}
1677		2152
1678	$self->reset; # polite request, might not happen	2153	$self->reset; # polite request, might not happen
		2154	}
		2155
		2156	=item $maps = cf::map::tmp_maps
		2157
		2158	Returns an arrayref with all map paths of currently instantiated and saved
		2159	maps. May block.
		2160
		2161	=cut
		2162
		2163	sub tmp_maps() {
		2164	[
		2165	map {
		2166	utf8::decode $_;
		2167	/\.map$/
		2168	? normalise $_
		2169	: ()
		2170	} @{ aio_readdir $TMPDIR or [] }
		2171	]
		2172	}
		2173
		2174	=item $maps = cf::map::random_maps
		2175
		2176	Returns an arrayref with all map paths of currently instantiated and saved
		2177	random maps. May block.
		2178
		2179	=cut
		2180
		2181	sub random_maps() {
		2182	[
		2183	map {
		2184	utf8::decode $_;
		2185	/\.map$/
		2186	? normalise "?random/$_"
		2187	: ()
		2188	} @{ aio_readdir $RANDOMDIR or [] }
		2189	]
1679	}	2190	}
1680		2191
1681	=item cf::map::unique_maps	2192	=item cf::map::unique_maps
1682		2193
1683	Returns an arrayref of paths of all shared maps that have	2194	Returns an arrayref of paths of all shared maps that have
1684	instantiated unique items. May block.	2195	instantiated unique items. May block.
1685		2196
1686	=cut	2197	=cut
1687		2198
1688	sub unique_maps() {	2199	sub unique_maps() {
1689	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2200	[
1690	or return;	2201	map {
1691
1692	my @paths;
1693
1694	for (@$files) {
1695	utf8::decode $_;	2202	utf8::decode $_;
1696	next if /\.pst$/;	2203	/\.map$/
1697	next unless /^$PATH_SEP/o;	2204	? normalise $_
1698		2205	: ()
1699	push @paths, cf::map::normalise $_;	2206	} @{ aio_readdir $UNIQUEDIR or [] }
1700	}	2207	]
1701
1702	\@paths
1703	}	2208	}
1704		2209
1705	package cf;	2210	package cf;
1706		2211
1707	=back	2212	=back
…		…
1725	map { $_, inv_recursive_ $_->inv } @_	2230	map { $_, inv_recursive_ $_->inv } @_
1726	}	2231	}
1727		2232
1728	sub inv_recursive {	2233	sub inv_recursive {
1729	inv_recursive_ inv $_[0]	2234	inv_recursive_ inv $_[0]
		2235	}
		2236
		2237	=item $ref = $ob->ref
		2238
		2239	creates and returns a persistent reference to an objetc that can be stored as a string.
		2240
		2241	=item $ob = cf::object::deref ($refstring)
		2242
		2243	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2244	even if the object actually exists. May block.
		2245
		2246	=cut
		2247
		2248	sub deref {
		2249	my ($ref) = @_;
		2250
		2251	# temporary compatibility#TODO#remove
		2252	$ref =~ s{^<}{player/<};
		2253
		2254	if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
		2255	my ($uuid, $name) = ($1, $2);
		2256	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2257	or return;
		2258	$pl->ob->uuid eq $uuid
		2259	or return;
		2260
		2261	$pl->ob
		2262	} else {
		2263	warn "$ref: cannot resolve object reference\n";
		2264	undef
		2265	}
1730	}	2266	}
1731		2267
1732	package cf;	2268	package cf;
1733		2269
1734	=back	2270	=back
…		…
1753		2289
1754	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2290	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1755		2291
1756	if ($self->{record_replies}) {	2292	if ($self->{record_replies}) {
1757	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2293	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2294
1758	} else {	2295	} else {
		2296	my $pl = $self->contr;
		2297
		2298	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2299	my $dialog = $pl->{npc_dialog};
		2300	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2301
		2302	} else {
1759	$msg = $npc->name . " says: $msg" if $npc;	2303	$msg = $npc->name . " says: $msg" if $npc;
1760	$self->message ($msg, $flags);	2304	$self->message ($msg, $flags);
		2305	}
1761	}	2306	}
		2307	}
		2308
		2309	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2310
		2311	=cut
		2312
		2313	sub cf::object::send_msg {
		2314	my $pl = shift->contr
		2315	or return;
		2316	$pl->send_msg (@_);
1762	}	2317	}
1763		2318
1764	=item $player_object->may ("access")	2319	=item $player_object->may ("access")
1765		2320
1766	Returns wether the given player is authorized to access resource "access"	2321	Returns wether the given player is authorized to access resource "access"
…		…
1813	$self->deactivate_recursive;	2368	$self->deactivate_recursive;
1814		2369
1815	return if UNIVERSAL::isa $self->map, "ext::map_link";	2370	return if UNIVERSAL::isa $self->map, "ext::map_link";
1816		2371
1817	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2372	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1818	if $self->map;	2373	if $self->map && $self->map->{path} ne "{link}";
1819		2374
1820	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2375	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1821	}	2376	}
1822		2377
1823	sub cf::object::player::leave_link {	2378	sub cf::object::player::leave_link {
1824	my ($self, $map, $x, $y) = @_;	2379	my ($self, $map, $x, $y) = @_;
		2380
		2381	return unless $self->contr->active;
1825		2382
1826	my $link_pos = delete $self->{_link_pos};	2383	my $link_pos = delete $self->{_link_pos};
1827		2384
1828	unless ($map) {	2385	unless ($map) {
1829	# restore original map position	2386	# restore original map position
…		…
1843	# use -1 or undef as default coordinates, not 0, 0	2400	# use -1 or undef as default coordinates, not 0, 0
1844	($x, $y) = ($map->enter_x, $map->enter_y)	2401	($x, $y) = ($map->enter_x, $map->enter_y)
1845	if $x <=0 && $y <= 0;	2402	if $x <=0 && $y <= 0;
1846		2403
1847	$map->load;	2404	$map->load;
1848	$map->load_diag;	2405	$map->load_neighbours;
1849		2406
1850	return unless $self->contr->active;	2407	return unless $self->contr->active;
1851	$self->activate_recursive;	2408	$self->activate_recursive;
1852		2409
1853	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext	2410	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1854	$self->enter_map ($map, $x, $y);	2411	$self->enter_map ($map, $x, $y);
1855	}	2412	}
1856		2413
1857	cf::player->attach (	2414	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1858	on_logout => sub {
1859	my ($pl) = @_;
1860		2415
1861	# abort map switching before logout	2416	Moves the player to the given map-path and coordinates by first freezing
1862	if ($pl->ob->{_link_pos}) {	2417	her, loading and preparing them map, calling the provided $check callback
1863	cf::sync_job {	2418	that has to return the map if sucecssful, and then unfreezes the player on
1864	$pl->ob->leave_link	2419	the new (success) or old (failed) map position. In either case, $done will
1865	};	2420	be called at the end of this process.
1866	}
1867	},
1868	on_login => sub {
1869	my ($pl) = @_;
1870		2421
1871	# try to abort aborted map switching on player login :)
1872	# should happen only on crashes
1873	if ($pl->ob->{_link_pos}) {
1874	$pl->ob->enter_link;
1875	(async {
1876	$pl->ob->reply (undef,
1877	"There was an internal problem at your last logout, "
1878	. "the server will try to bring you to your intended destination in a second.",
1879	cf::NDI_RED);
1880	# we need this sleep as the login has a concurrent enter_exit running
1881	# and this sleep increases chances of the player not ending up in scorn
1882	Coro::Timer::sleep 1;
1883	$pl->ob->leave_link;
1884	})->prio (2);
1885	}
1886	},
1887	);
1888
1889	=item $player_object->goto ($path, $x, $y)
1890
1891	=cut	2422	=cut
		2423
		2424	our $GOTOGEN;
1892		2425
1893	sub cf::object::player::goto {	2426	sub cf::object::player::goto {
1894	my ($self, $path, $x, $y) = @_;	2427	my ($self, $path, $x, $y, $check, $done) = @_;
		2428
		2429	# do generation counting so two concurrent goto's will be executed in-order
		2430	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1895		2431
1896	$self->enter_link;	2432	$self->enter_link;
1897		2433
1898	(async {	2434	(async {
1899	my $map = eval {	2435	my $map = eval {
1900	my $map = cf::map::find $path;	2436	my $map = cf::map::find $path;
		2437
		2438	if ($map) {
1901	$map = $map->customise_for ($self) if $map;	2439	$map = $map->customise_for ($self);
		2440	$map = $check->($map) if $check && $map;
		2441	} else {
		2442	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2443	}
		2444
1902	$map	2445	$map
		2446	};
		2447
		2448	if ($@) {
		2449	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2450	LOG llevError | logBacktrace, Carp::longmess $@;
1903	} or	2451	}
1904	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1905		2452
		2453	if ($gen == $self->{_goto_generation}) {
		2454	delete $self->{_goto_generation};
1906	$self->leave_link ($map, $x, $y);	2455	$self->leave_link ($map, $x, $y);
		2456	}
		2457
		2458	$done->() if $done;
1907	})->prio (1);	2459	})->prio (1);
1908	}	2460	}
1909		2461
1910	=item $player_object->enter_exit ($exit_object)	2462	=item $player_object->enter_exit ($exit_object)
1911		2463
…		…
1950		2502
1951	$rmp->{random_seed} ||= $exit->random_seed;	2503	$rmp->{random_seed} ||= $exit->random_seed;
1952		2504
1953	my $data = cf::to_json $rmp;	2505	my $data = cf::to_json $rmp;
1954	my $md5 = Digest::MD5::md5_hex $data;	2506	my $md5 = Digest::MD5::md5_hex $data;
1955	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2507	my $meta = "$RANDOMDIR/$md5.meta";
1956		2508
1957	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2509	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1958	aio_write $fh, 0, (length $data), $data, 0;	2510	aio_write $fh, 0, (length $data), $data, 0;
1959	undef $fh;	2511	undef $fh;
1960	aio_rename "$meta~", $meta;	2512	aio_rename "$meta~", $meta;
…		…
1969		2521
1970	return unless $self->type == cf::PLAYER;	2522	return unless $self->type == cf::PLAYER;
1971		2523
1972	if ($exit->slaying eq "/!") {	2524	if ($exit->slaying eq "/!") {
1973	#TODO: this should de-fi-ni-te-ly not be a sync-job	2525	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2526	# the problem is that $exit might not survive long enough
		2527	# so it needs to be done right now, right here
1974	cf::sync_job { prepare_random_map $exit };	2528	cf::sync_job { prepare_random_map $exit };
1975	}	2529	}
1976		2530
1977	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2531	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1978	my $hp = $exit->stats->hp;	2532	my $hp = $exit->stats->hp;
1979	my $sp = $exit->stats->sp;	2533	my $sp = $exit->stats->sp;
1980		2534
1981	$self->enter_link;	2535	$self->enter_link;
		2536
		2537	# if exit is damned, update players death & WoR home-position
		2538	$self->contr->savebed ($slaying, $hp, $sp)
		2539	if $exit->flag (FLAG_DAMNED);
1982		2540
1983	(async {	2541	(async {
1984	$self->deactivate_recursive; # just to be sure	2542	$self->deactivate_recursive; # just to be sure
1985	unless (eval {	2543	unless (eval {
1986	$self->goto ($slaying, $hp, $sp);	2544	$self->goto ($slaying, $hp, $sp);
1987		2545
1988	1;	2546	1;
1989	}) {	2547	}) {
1990	$self->message ("Something went wrong deep within the crossfire server. "	2548	$self->message ("Something went wrong deep within the crossfire server. "
1991	. "I'll try to bring you back to the map you were before. "	2549	. "I'll try to bring you back to the map you were before. "
1992	. "Please report this to the dungeon master!",	2550	. "Please report this to the dungeon master!",
1993	cf::NDI_UNIQUE | cf::NDI_RED);	2551	cf::NDI_UNIQUE | cf::NDI_RED);
1994		2552
1995	warn "ERROR in enter_exit: $@";	2553	warn "ERROR in enter_exit: $@";
1996	$self->leave_link;	2554	$self->leave_link;
1997	}	2555	}
1998	})->prio (1);	2556	})->prio (1);
…		…
2014		2572
2015	utf8::encode $text;	2573	utf8::encode $text;
2016	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);	2574	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2017	}	2575	}
2018		2576
		2577	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2578
		2579	Send a drawinfo or msg packet to the client, formatting the msg for the
		2580	client if neccessary. C<$type> should be a string identifying the type of
		2581	the message, with C<log> being the default. If C<$color> is negative, suppress
		2582	the message unless the client supports the msg packet.
		2583
		2584	=cut
		2585
		2586	our %CHANNEL = (
		2587	"c/identify" => {
		2588	id => "identify",
		2589	title => "Identify",
		2590	reply => undef,
		2591	tooltip => "Items recently identified",
		2592	},
		2593	"c/examine" => {
		2594	id => "examine",
		2595	title => "Examine",
		2596	reply => undef,
		2597	tooltip => "Signs and other items you examined",
		2598	},
		2599	);
		2600
		2601	sub cf::client::send_msg {
		2602	my ($self, $channel, $msg, $color, @extra) = @_;
		2603
		2604	$msg = $self->pl->expand_cfpod ($msg);
		2605
		2606	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2607
		2608	# check predefined channels, for the benefit of C
		2609	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2610
		2611	if (ref $channel) {
		2612	# send meta info to client, if not yet sent
		2613	unless (exists $self->{channel}{$channel->{id}}) {
		2614	$self->{channel}{$channel->{id}} = $channel;
		2615	$self->ext_msg (channel_info => $channel)
		2616	if $self->can_msg;
		2617	}
		2618
		2619	$channel = $channel->{id};
		2620	}
		2621
		2622	return unless @extra || length $msg;
		2623
		2624	if ($self->can_msg) {
		2625	# default colour, mask it out
		2626	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2627	if $color & cf::NDI_DEF;
		2628
		2629	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2630	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2631	} else {
		2632	if ($color >= 0) {
		2633	# replace some tags by gcfclient-compatible ones
		2634	for ($msg) {
		2635	1 while
		2636	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2637	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2638	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2639	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2640	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2641	}
		2642
		2643	$color &= cf::NDI_COLOR_MASK;
		2644
		2645	utf8::encode $msg;
		2646
		2647	if (0 && $msg =~ /\[/) {
		2648	# COMMAND/INFO
		2649	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2650	} else {
		2651	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2652	$self->send_packet ("drawinfo $color $msg")
		2653	}
		2654	}
		2655	}
		2656	}
		2657
		2658	=item $client->ext_msg ($type, @msg)
		2659
		2660	Sends an ext event to the client.
		2661
		2662	=cut
		2663
		2664	sub cf::client::ext_msg($$@) {
		2665	my ($self, $type, @msg) = @_;
		2666
		2667	if ($self->extcmd == 2) {
		2668	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2669	} elsif ($self->extcmd == 1) { # TODO: remove
		2670	push @msg, msgtype => "event_$type";
		2671	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2672	}
		2673	}
		2674
		2675	=item $client->ext_reply ($msgid, @msg)
		2676
		2677	Sends an ext reply to the client.
		2678
		2679	=cut
		2680
		2681	sub cf::client::ext_reply($$@) {
		2682	my ($self, $id, @msg) = @_;
		2683
		2684	if ($self->extcmd == 2) {
		2685	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2686	} elsif ($self->extcmd == 1) {
		2687	#TODO: version 1, remove
		2688	unshift @msg, msgtype => "reply", msgid => $id;
		2689	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2690	}
		2691	}
2019		2692
2020	=item $success = $client->query ($flags, "text", \&cb)	2693	=item $success = $client->query ($flags, "text", \&cb)
2021		2694
2022	Queues a query to the client, calling the given callback with	2695	Queues a query to the client, calling the given callback with
2023	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2696	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2024	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2697	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2025		2698
2026	Queries can fail, so check the return code. Or don't, as queries will become	2699	Queries can fail, so check the return code. Or don't, as queries will
2027	reliable at some point in the future.	2700	become reliable at some point in the future.
2028		2701
2029	=cut	2702	=cut
2030		2703
2031	sub cf::client::query {	2704	sub cf::client::query {
2032	my ($self, $flags, $text, $cb) = @_;	2705	my ($self, $flags, $text, $cb) = @_;
…		…
2040	utf8::encode $text;	2713	utf8::encode $text;
2041	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2714	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2042		2715
2043	$self->send_packet ($self->{query_queue}[0][0])	2716	$self->send_packet ($self->{query_queue}[0][0])
2044	if @{ $self->{query_queue} } == 1;	2717	if @{ $self->{query_queue} } == 1;
		2718
		2719	1
2045	}	2720	}
2046		2721
2047	cf::client->attach (	2722	cf::client->attach (
		2723	on_connect => sub {
		2724	my ($ns) = @_;
		2725
		2726	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2727	},
2048	on_reply => sub {	2728	on_reply => sub {
2049	my ($ns, $msg) = @_;	2729	my ($ns, $msg) = @_;
2050		2730
2051	# this weird shuffling is so that direct followup queries	2731	# this weird shuffling is so that direct followup queries
2052	# get handled first	2732	# get handled first
…		…
2064	} else {	2744	} else {
2065	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2745	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2066	}	2746	}
2067	}	2747	}
2068	},	2748	},
		2749	on_exticmd => sub {
		2750	my ($ns, $buf) = @_;
		2751
		2752	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2753
		2754	if (ref $msg) {
		2755	my ($type, $reply, @payload) =
		2756	"ARRAY" eq ref $msg
		2757	? @$msg
		2758	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2759
		2760	my @reply;
		2761
		2762	if (my $cb = $EXTICMD{$type}) {
		2763	@reply = $cb->($ns, @payload);
		2764	}
		2765
		2766	$ns->ext_reply ($reply, @reply)
		2767	if $reply;
		2768
		2769	} else {
		2770	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2771	}
		2772
		2773	cf::override;
		2774	},
2069	);	2775	);
2070		2776
2071	=item $client->async (\&cb)	2777	=item $client->async (\&cb)
2072		2778
2073	Create a new coroutine, running the specified callback. The coroutine will	2779	Create a new coroutine, running the specified callback. The coroutine will
…		…
2114	our $safe = new Safe "safe";	2820	our $safe = new Safe "safe";
2115	our $safe_hole = new Safe::Hole;	2821	our $safe_hole = new Safe::Hole;
2116		2822
2117	$SIG{FPE} = 'IGNORE';	2823	$SIG{FPE} = 'IGNORE';
2118		2824
2119	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2825	$safe->permit_only (Opcode::opset qw(
		2826	:base_core :base_mem :base_orig :base_math
		2827	grepstart grepwhile mapstart mapwhile
		2828	sort time
		2829	));
2120		2830
2121	# here we export the classes and methods available to script code	2831	# here we export the classes and methods available to script code
2122		2832
2123	=pod	2833	=pod
2124		2834
2125	The following functions and methods are available within a safe environment:	2835	The following functions and methods are available within a safe environment:
2126		2836
2127	cf::object contr pay_amount pay_player map	2837	cf::object
		2838	contr pay_amount pay_player map x y force_find force_add
		2839	insert remove name archname title slaying race decrease_ob_nr
		2840
2128	cf::object::player player	2841	cf::object::player
2129	cf::player peaceful	2842	player
2130	cf::map trigger	2843
		2844	cf::player
		2845	peaceful
		2846
		2847	cf::map
		2848	trigger
2131		2849
2132	=cut	2850	=cut
2133		2851
2134	for (	2852	for (
2135	["cf::object" => qw(contr pay_amount pay_player map)],	2853	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2854	insert remove inv name archname title slaying race
		2855	decrease_ob_nr)],
2136	["cf::object::player" => qw(player)],	2856	["cf::object::player" => qw(player)],
2137	["cf::player" => qw(peaceful)],	2857	["cf::player" => qw(peaceful)],
2138	["cf::map" => qw(trigger)],	2858	["cf::map" => qw(trigger)],
2139	) {	2859	) {
2140	no strict 'refs';	2860	no strict 'refs';
…		…
2211	=back	2931	=back
2212		2932
2213	=cut	2933	=cut
2214		2934
2215	#############################################################################	2935	#############################################################################
2216
2217	=head2 EXTENSION DATABASE SUPPORT
2218
2219	Crossfire maintains a very simple database for extension use. It can
2220	currently store anything that can be serialised using Storable, which
2221	excludes objects.
2222
2223	The parameter C<$family> should best start with the name of the extension
2224	using it, it should be unique.
2225
2226	=over 4
2227
2228	=item $value = cf::db_get $family => $key
2229
2230	Returns a single value from the database.
2231
2232	=item cf::db_put $family => $key => $value
2233
2234	Stores the given C<$value> in the family.
2235
2236	=cut
2237
2238	our $DB;
2239
2240	sub db_init {
2241	unless ($DB) {
2242	$DB = BDB::db_create $DB_ENV;
2243
2244	cf::sync_job {
2245	eval {
2246	$DB->set_flags (BDB::CHKSUM);
2247
2248	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2249	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2250	cf::cleanup "db_open(db): $!" if $!;
2251	};
2252	cf::cleanup "db_open(db): $@" if $@;
2253	};
2254
2255	my $path = cf::localdir . "/database.pst";
2256	if (stat $path) {
2257	cf::sync_job {
2258	my $pst = Storable::retrieve $path;
2259
2260	cf::db_put (board => data => $pst->{board});
2261	cf::db_put (guildrules => data => $pst->{guildrules});
2262	cf::db_put (rent => balance => $pst->{rent}{balance});
2263	BDB::db_env_txn_checkpoint $DB_ENV;
2264
2265	unlink $path;
2266	};
2267	}
2268	}
2269	}
2270
2271	sub db_get($$) {
2272	my $key = "$_[0]/$_[1]";
2273
2274	cf::sync_job {
2275	BDB::db_get $DB, undef, $key, my $data;
2276
2277	$! ? ()
2278	: Compress::LZF::sthaw $data
2279	}
2280	}
2281
2282	sub db_put($$$) {
2283	BDB::dbreq_pri 4;
2284	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2285	}
2286
2287	#############################################################################
2288	# the server's init and main functions	2936	# the server's init and main functions
2289		2937
2290	sub load_facedata {	2938	sub load_facedata($) {
2291	my $path = sprintf "%s/facedata", cf::datadir;	2939	my ($path) = @_;
		2940
		2941	# HACK to clear player env face cache, we need some signal framework
		2942	# for this (global event?)
		2943	%ext::player_env::MUSIC_FACE_CACHE = ();
		2944
		2945	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2292		2946
2293	warn "loading facedata from $path\n";	2947	warn "loading facedata from $path\n";
2294		2948
2295	my $faces;	2949	my $facedata;
2296	0 < aio_load $path, $faces	2950	0 < aio_load $path, $facedata
2297	or die "$path: $!";	2951	or die "$path: $!";
2298		2952
2299	Coro::cede;
2300	$faces = Storable::thaw $faces;	2953	$facedata = Coro::Storable::thaw $facedata;
2301	Coro::cede;
2302		2954
2303	my $meta = delete $faces->{""};
2304	$meta->{version} == 1	2955	$facedata->{version} == 2
2305	or cf::cleanup "$path: version mismatch, cannot proceed.";	2956	or cf::cleanup "$path: version mismatch, cannot proceed.";
2306		2957
		2958	# patch in the exptable
		2959	$facedata->{resource}{"res/exp_table"} = {
		2960	type => FT_RSRC,
		2961	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2962	};
		2963	cf::cede_to_tick;
		2964
		2965	{
		2966	my $faces = $facedata->{faceinfo};
		2967
2307	while (my ($face, $info) = each %$faces) {	2968	while (my ($face, $info) = each %$faces) {
2308	my $idx = (cf::face::find $face) || cf::face::alloc $face;	2969	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2309	cf::face::set $idx, $info->{visibility}, $info->{magicmap};	2970	cf::face::set_visibility $idx, $info->{visibility};
		2971	cf::face::set_magicmap $idx, $info->{magicmap};
2310	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};	2972	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2311	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};	2973	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2312	Coro::cede;
2313	}
2314		2974
		2975	cf::cede_to_tick;
		2976	}
		2977
2315	while (my ($face, $info) = each %$faces) {	2978	while (my ($face, $info) = each %$faces) {
2316	next unless $info->{smooth};	2979	next unless $info->{smooth};
2317	my $idx = cf::face::find $face	2980	my $idx = cf::face::find $face
2318	or next;	2981	or next;
2319	if (my $smooth = cf::face::find $info->{smooth}) {	2982	if (my $smooth = cf::face::find $info->{smooth}) {
2320	cf::face::set_smooth $idx, $smooth;	2983	cf::face::set_smooth $idx, $smooth;
		2984	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2321	} else {	2985	} else {
2322	warn "smooth face '$info->{smooth}' not found for face '$face'";	2986	warn "smooth face '$info->{smooth}' not found for face '$face'";
2323	}	2987	}
2324	Coro::cede;	2988
		2989	cf::cede_to_tick;
		2990	}
		2991	}
		2992
		2993	{
		2994	my $anims = $facedata->{animinfo};
		2995
		2996	while (my ($anim, $info) = each %$anims) {
		2997	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2998	cf::cede_to_tick;
		2999	}
		3000
		3001	cf::anim::invalidate_all; # d'oh
		3002	}
		3003
		3004	{
		3005	# TODO: for gcfclient pleasure, we should give resources
		3006	# that gcfclient doesn't grok a >10000 face index.
		3007	my $res = $facedata->{resource};
		3008
		3009	my $soundconf = delete $res->{"res/sound.conf"};
		3010
		3011	while (my ($name, $info) = each %$res) {
		3012	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3013	my $data;
		3014
		3015	if ($info->{type} & 1) {
		3016	# prepend meta info
		3017
		3018	my $meta = $enc->encode ({
		3019	name => $name,
		3020	%{ $info->{meta} || {} },
		3021	});
		3022
		3023	$data = pack "(w/a*)*", $meta, $info->{data};
		3024	} else {
		3025	$data = $info->{data};
		3026	}
		3027
		3028	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3029	cf::face::set_type $idx, $info->{type};
		3030
		3031	cf::cede_to_tick;
		3032	}
		3033
		3034	if ($soundconf) {
		3035	$soundconf = $enc->decode (delete $soundconf->{data});
		3036
		3037	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3038	my $sound = $soundconf->{compat}[$_]
		3039	or next;
		3040
		3041	my $face = cf::face::find "sound/$sound->[1]";
		3042	cf::sound::set $sound->[0] => $face;
		3043	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3044	}
		3045
		3046	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3047	my $face = cf::face::find "sound/$v";
		3048	cf::sound::set $k => $face;
		3049	}
		3050	}
2325	}	3051	}
2326		3052
2327	1	3053	1
2328	}	3054	}
2329		3055
		3056	register_exticmd fx_want => sub {
		3057	my ($ns, $want) = @_;
		3058
		3059	while (my ($k, $v) = each %$want) {
		3060	$ns->fx_want ($k, $v);
		3061	}
		3062	};
		3063
		3064	sub reload_regions {
		3065	# HACK to clear player env face cache, we need some signal framework
		3066	# for this (global event?)
		3067	%ext::player_env::MUSIC_FACE_CACHE = ();
		3068
		3069	load_resource_file "$MAPDIR/regions"
		3070	or die "unable to load regions file\n";
		3071
		3072	for (cf::region::list) {
		3073	$_->{match} = qr/$_->{match}/
		3074	if exists $_->{match};
		3075	}
		3076	}
		3077
		3078	sub reload_facedata {
		3079	load_facedata "$DATADIR/facedata"
		3080	or die "unable to load facedata\n";
		3081	}
		3082
		3083	sub reload_archetypes {
		3084	load_resource_file "$DATADIR/archetypes"
		3085	or die "unable to load archetypes\n";
		3086	#d# NEED to laod twice to resolve forward references
		3087	# this really needs to be done in an extra post-pass
		3088	# (which needs to be synchronous, so solve it differently)
		3089	load_resource_file "$DATADIR/archetypes"
		3090	or die "unable to load archetypes\n";
		3091	}
		3092
		3093	sub reload_treasures {
		3094	load_resource_file "$DATADIR/treasures"
		3095	or die "unable to load treasurelists\n";
		3096	}
		3097
2330	sub reload_resources {	3098	sub reload_resources {
2331	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir	3099	warn "reloading resource files...\n";
2332	or die "unable to load regions file\n";#d#	3100
		3101	reload_regions;
2333	load_facedata	3102	reload_facedata;
2334	or die "unable to load facedata\n";#d#	3103	#reload_archetypes;#d#
		3104	reload_archetypes;
		3105	reload_treasures;
		3106
		3107	warn "finished reloading resource files\n";
2335	}	3108	}
2336		3109
2337	sub init {	3110	sub init {
2338	reload_resources;	3111	reload_resources;
2339	}	3112	}
2340		3113
2341	sub cfg_load {	3114	sub reload_config {
2342	open my $fh, "<:utf8", cf::confdir . "/config"	3115	open my $fh, "<:utf8", "$CONFDIR/config"
2343	or return;	3116	or return;
2344		3117
2345	local $/;	3118	local $/;
2346	*CFG = YAML::Syck::Load <$fh>;	3119	*CFG = YAML::Syck::Load <$fh>;
2347		3120
…		…
2366	(async {	3139	(async {
2367	Event::one_event;	3140	Event::one_event;
2368	})->prio (Coro::PRIO_MAX);	3141	})->prio (Coro::PRIO_MAX);
2369	};	3142	};
2370		3143
2371	cfg_load;	3144	reload_config;
2372	db_init;	3145	db_init;
2373	load_extensions;	3146	load_extensions;
2374		3147
2375	$TICK_WATCHER->start;	3148	$TICK_WATCHER->start;
2376	Event::loop;	3149	Event::loop;
…		…
2392	},	3165	},
2393	);	3166	);
2394	}	3167	}
2395	}	3168	}
2396		3169
		3170	sub write_runtime {
		3171	my $runtime = "$LOCALDIR/runtime";
		3172
		3173	# first touch the runtime file to show we are still running:
		3174	# the fsync below can take a very very long time.
		3175
		3176	IO::AIO::aio_utime $runtime, undef, undef;
		3177
		3178	my $guard = cf::lock_acquire "write_runtime";
		3179
		3180	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3181	or return;
		3182
		3183	my $value = $cf::RUNTIME + 90 + 10;
		3184	# 10 is the runtime save interval, for a monotonic clock
		3185	# 60 allows for the watchdog to kill the server.
		3186
		3187	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3188	and return;
		3189
		3190	# always fsync - this file is important
		3191	aio_fsync $fh
		3192	and return;
		3193
		3194	# touch it again to show we are up-to-date
		3195	aio_utime $fh, undef, undef;
		3196
		3197	close $fh
		3198	or return;
		3199
		3200	aio_rename "$runtime~", $runtime
		3201	and return;
		3202
		3203	warn "runtime file written.\n";
		3204
		3205	1
		3206	}
		3207
2397	sub emergency_save() {	3208	sub emergency_save() {
2398	my $freeze_guard = cf::freeze_mainloop;	3209	my $freeze_guard = cf::freeze_mainloop;
2399		3210
2400	warn "enter emergency perl save\n";	3211	warn "enter emergency perl save\n";
2401		3212
…		…
2432		3243
2433	warn Carp::longmess "post_cleanup backtrace"	3244	warn Carp::longmess "post_cleanup backtrace"
2434	if $make_core;	3245	if $make_core;
2435	}	3246	}
2436		3247
2437	sub reload() {	3248	sub do_reload_perl() {
2438	# can/must only be called in main	3249	# can/must only be called in main
2439	if ($Coro::current != $Coro::main) {	3250	if ($Coro::current != $Coro::main) {
2440	warn "can only reload from main coroutine";	3251	warn "can only reload from main coroutine";
2441	return;	3252	return;
2442	}	3253	}
…		…
2476	%EXT_CORO = ();	3287	%EXT_CORO = ();
2477		3288
2478	warn "removing commands";	3289	warn "removing commands";
2479	%COMMAND = ();	3290	%COMMAND = ();
2480		3291
2481	warn "removing ext commands";	3292	warn "removing ext/exti commands";
2482	%EXTCMD = ();	3293	%EXTCMD = ();
		3294	%EXTICMD = ();
2483		3295
2484	warn "unloading/nuking all extensions";	3296	warn "unloading/nuking all extensions";
2485	for my $pkg (@EXTS) {	3297	for my $pkg (@EXTS) {
2486	warn "... unloading $pkg";	3298	warn "... unloading $pkg";
2487		3299
…		…
2517	Symbol::delete_package "safe::$_"	3329	Symbol::delete_package "safe::$_"
2518	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3330	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2519		3331
2520	warn "unloading cf.pm \"a bit\"";	3332	warn "unloading cf.pm \"a bit\"";
2521	delete $INC{"cf.pm"};	3333	delete $INC{"cf.pm"};
		3334	delete $INC{"cf/pod.pm"};
2522		3335
2523	# don't, removes xs symbols, too,	3336	# don't, removes xs symbols, too,
2524	# and global variables created in xs	3337	# and global variables created in xs
2525	#Symbol::delete_package __PACKAGE__;	3338	#Symbol::delete_package __PACKAGE__;
2526		3339
…		…
2529	warn "reloading cf.pm";	3342	warn "reloading cf.pm";
2530	require cf;	3343	require cf;
2531	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3344	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2532		3345
2533	warn "loading config and database again";	3346	warn "loading config and database again";
2534	cf::cfg_load;	3347	cf::reload_config;
2535		3348
2536	warn "loading extensions";	3349	warn "loading extensions";
2537	cf::load_extensions;	3350	cf::load_extensions;
2538		3351
2539	warn "reattaching attachments to objects/players";	3352	warn "reattaching attachments to objects/players";
…		…
2541	warn "reattaching attachments to maps";	3354	warn "reattaching attachments to maps";
2542	reattach $_ for values %MAP;	3355	reattach $_ for values %MAP;
2543	warn "reattaching attachments to players";	3356	warn "reattaching attachments to players";
2544	reattach $_ for values %PLAYER;	3357	reattach $_ for values %PLAYER;
2545		3358
2546	warn "loading reloadable resources";
2547	reload_resources;
2548
2549	warn "leaving sync_job";	3359	warn "leaving sync_job";
2550		3360
2551	1	3361	1
2552	} or do {	3362	} or do {
2553	warn $@;	3363	warn $@;
…		…
2558	warn "reloaded";	3368	warn "reloaded";
2559	};	3369	};
2560		3370
2561	our $RELOAD_WATCHER; # used only during reload	3371	our $RELOAD_WATCHER; # used only during reload
2562		3372
		3373	sub reload_perl() {
		3374	# doing reload synchronously and two reloads happen back-to-back,
		3375	# coro crashes during coro_state_free->destroy here.
		3376
		3377	$RELOAD_WATCHER ||= Event->timer (
		3378	reentrant => 0,
		3379	after => 0,
		3380	data => WF_AUTOCANCEL,
		3381	cb => sub {
		3382	do_reload_perl;
		3383	undef $RELOAD_WATCHER;
		3384	},
		3385	);
		3386	}
		3387
2563	register_command "reload" => sub {	3388	register_command "reload" => sub {
2564	my ($who, $arg) = @_;	3389	my ($who, $arg) = @_;
2565		3390
2566	if ($who->flag (FLAG_WIZ)) {	3391	if ($who->flag (FLAG_WIZ)) {
2567	$who->message ("reloading server.");	3392	$who->message ("reloading server.");
2568		3393	async { reload_perl };
2569	# doing reload synchronously and two reloads happen back-to-back,
2570	# coro crashes during coro_state_free->destroy here.
2571
2572	$RELOAD_WATCHER ||= Event->timer (
2573	reentrant => 0,
2574	after => 0,
2575	data => WF_AUTOCANCEL,
2576	cb => sub {
2577	reload;
2578	undef $RELOAD_WATCHER;
2579	},
2580	);
2581	}	3394	}
2582	};	3395	};
2583		3396
2584	unshift @INC, $LIBDIR;	3397	unshift @INC, $LIBDIR;
2585		3398
2586	my $bug_warning = 0;	3399	my $bug_warning = 0;
2587		3400
		3401	our @WAIT_FOR_TICK;
		3402	our @WAIT_FOR_TICK_BEGIN;
		3403
		3404	sub wait_for_tick {
		3405	return unless $TICK_WATCHER->is_active;
		3406	return if $Coro::current == $Coro::main;
		3407
		3408	my $signal = new Coro::Signal;
		3409	push @WAIT_FOR_TICK, $signal;
		3410	$signal->wait;
		3411	}
		3412
		3413	sub wait_for_tick_begin {
		3414	return unless $TICK_WATCHER->is_active;
		3415	return if $Coro::current == $Coro::main;
		3416
		3417	my $signal = new Coro::Signal;
		3418	push @WAIT_FOR_TICK_BEGIN, $signal;
		3419	$signal->wait;
		3420	}
		3421
		3422	my $min = 1e6;#d#
		3423	my $avg = 10;
2588	$TICK_WATCHER = Event->timer (	3424	$TICK_WATCHER = Event->timer (
2589	reentrant => 0,	3425	reentrant => 0,
2590	parked => 1,	3426	parked => 1,
2591	prio => 0,	3427	prio => 0,
2592	at => $NEXT_TICK || $TICK,	3428	at => $NEXT_TICK || $TICK,
…		…
2596	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3432	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2597	unless ++$bug_warning > 10;	3433	unless ++$bug_warning > 10;
2598	return;	3434	return;
2599	}	3435	}
2600		3436
2601	$NOW = Event::time;	3437	$NOW = $tick_start = Event::time;
2602		3438
2603	cf::server_tick; # one server iteration	3439	cf::server_tick; # one server iteration
		3440
		3441	0 && sync_job {#d#
		3442	for(1..10) {
		3443	my $t = Event::time;
		3444	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3445	or die;
		3446
		3447	$map->width (50);
		3448	$map->height (50);
		3449	$map->alloc;
		3450	$map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
		3451	my $t = Event::time - $t;
		3452
		3453	#next unless $t < 0.0013;#d#
		3454	if ($t < $min) {
		3455	$min = $t;
		3456	}
		3457	$avg = $avg * 0.99 + $t * 0.01;
		3458	}
		3459	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3460	exit 0;
		3461	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3462	};
		3463
2604	$RUNTIME += $TICK;	3464	$RUNTIME += $TICK;
2605	$NEXT_TICK += $TICK;	3465	$NEXT_TICK += $TICK;
2606		3466
2607	if ($NOW >= $NEXT_RUNTIME_WRITE) {	3467	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2608	$NEXT_RUNTIME_WRITE = $NOW + 10;	3468	$NEXT_RUNTIME_WRITE = $NOW + 10;
…		…
2610	write_runtime	3470	write_runtime
2611	or warn "ERROR: unable to write runtime file: $!";	3471	or warn "ERROR: unable to write runtime file: $!";
2612	};	3472	};
2613	}	3473	}
2614		3474
2615	$WAIT_FOR_TICK->broadcast;
2616	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2617
2618	# my $AFTER = Event::time;	3475	# my $AFTER = Event::time;
2619	# warn $AFTER - $NOW;#d#	3476	# warn $AFTER - $NOW;#d#
2620		3477
		3478	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3479	$sig->send;
		3480	}
		3481	while (my $sig = shift @WAIT_FOR_TICK) {
		3482	$sig->send;
		3483	}
		3484
		3485	$NOW = Event::time;
		3486
2621	# if we are delayed by four ticks or more, skip them all	3487	# if we are delayed by four ticks or more, skip them all
2622	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3488	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2623		3489
2624	$TICK_WATCHER->at ($NEXT_TICK);	3490	$TICK_WATCHER->at ($NEXT_TICK);
2625	$TICK_WATCHER->start;	3491	$TICK_WATCHER->start;
		3492
		3493	$LOAD = ($NOW - $tick_start) / $TICK;
		3494	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3495
		3496	_post_tick;
		3497
		3498
2626	},	3499	},
2627	);	3500	);
2628		3501
2629	{	3502	{
2630	BDB::max_poll_time $TICK * 0.1;	3503	BDB::max_poll_time $TICK * 0.1;
…		…
2658		3531
2659	cf::sync_job {	3532	cf::sync_job {
2660	eval {	3533	eval {
2661	BDB::db_env_open	3534	BDB::db_env_open
2662	$DB_ENV,	3535	$DB_ENV,
2663	$BDB_ENV_DIR,	3536	$BDBDIR,
2664	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3537	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2665	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3538	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2666	0666;	3539	0666;
2667		3540
2668	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3541	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2669		3542
2670	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3543	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2671	$DB_ENV->set_lk_detect;	3544	$DB_ENV->set_lk_detect;
2672	};	3545	};
2673		3546
…		…
2689	prio => 6,	3562	prio => 6,
2690	cb => \&IO::AIO::poll_cb,	3563	cb => \&IO::AIO::poll_cb,
2691	);	3564	);
2692	}	3565	}
2693		3566
		3567	my $_log_backtrace;
		3568
		3569	sub _log_backtrace {
		3570	my ($msg, @addr) = @_;
		3571
		3572	$msg =~ s/\n//;
		3573
		3574	# limit the # of concurrent backtraces
		3575	if ($_log_backtrace < 2) {
		3576	++$_log_backtrace;
		3577	async {
		3578	my @bt = fork_call {
		3579	@addr = map { sprintf "%x", $_ } @addr;
		3580	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3581	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3582	or die "addr2line: $!";
		3583
		3584	my @funcs;
		3585	my @res = <$fh>;
		3586	chomp for @res;
		3587	while (@res) {
		3588	my ($func, $line) = splice @res, 0, 2, ();
		3589	push @funcs, "[$func] $line";
		3590	}
		3591
		3592	@funcs
		3593	};
		3594
		3595	LOG llevInfo, "[ABT] $msg\n";
		3596	LOG llevInfo, "[ABT] $_\n" for @bt;
		3597	--$_log_backtrace;
		3598	};
		3599	} else {
		3600	LOG llevInfo, "[ABT] $msg\n";
		3601	LOG llevInfo, "[ABT] [suppressed]\n";
		3602	}
		3603	}
		3604
		3605	# load additional modules
		3606	use cf::pod;
		3607
2694	END { cf::emergency_save }	3608	END { cf::emergency_save }
2695		3609
2696	1	3610	1
2697		3611

Diff Legend

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