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

Diff Legend

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