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.252 by root, Wed Apr 18 15:28:18 2007 UTC vs.
Revision 1.362 by root, Mon Sep 10 12:44:06 2007 UTC

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

Diff Legend

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