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.228 by root, Mon Mar 26 16:53:33 2007 UTC vs.
Revision 1.361 by root, Sun Sep 9 12:52:48 2007 UTC

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

Diff Legend

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