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.206 by root, Sun Feb 11 22:27:05 2007 UTC vs.
Revision 1.347 by root, Thu Aug 30 05:16:09 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.5 ();	15	use Coro 3.64 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
		24	use Coro::Util ();
19		25
		26	use JSON::XS ();
20	use BDB ();	27	use BDB ();
21	use Data::Dumper;	28	use Data::Dumper;
22	use Digest::MD5;	29	use Digest::MD5;
23	use Fcntl;	30	use Fcntl;
		31	use YAML::Syck ();
24	use IO::AIO 2.32 ();	32	use IO::AIO 2.32 ();
25	use YAML::Syck ();
26	use Time::HiRes;	33	use Time::HiRes;
		34	use Compress::LZF;
		35	use Digest::MD5 ();
27		36
		37	# configure various modules to our taste
		38	#
		39	$Storable::canonical = 1; # reduce rsync transfers
		40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		41	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		42
28	use Event; $Event::Eval = 1; # no idea why this is required, but it is	43	$Event::Eval = 1; # no idea why this is required, but it is
29
30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31		44
32	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	45	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
33	$YAML::Syck::ImplicitUnicode = 1;	46	$YAML::Syck::ImplicitUnicode = 1;
34		47
35	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	48	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
36		49
		50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		51
37	our %COMMAND = ();	52	our %COMMAND = ();
38	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
39		54
40	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
41	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
42	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
43	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
44		60
		61	our $RELOAD; # number of reloads so far
45	our @EVENT;	62	our @EVENT;
46	our $LIBDIR = datadir . "/ext";
47		63
48	our $TICK = MAX_TIME * 1e-6;	64	our $CONFDIR = confdir;
		65	our $DATADIR = datadir;
		66	our $LIBDIR = "$DATADIR/ext";
		67	our $PODDIR = "$DATADIR/pod";
		68	our $MAPDIR = "$DATADIR/" . mapdir;
		69	our $LOCALDIR = localdir;
		70	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		71	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		72	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		73	our $RANDOMDIR = "$LOCALDIR/random";
		74	our $BDBDIR = "$LOCALDIR/db";
		75
		76	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
49	our $TICK_WATCHER;	77	our $TICK_WATCHER;
50	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
51	our $WRITE_RUNTIME_WATCHER;	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
52	our $NEXT_TICK;	80	our $NEXT_TICK;
53	our $NOW;	81	our $NOW;
54	our $USE_FSYNC = 1; # use fsync to write maps - default off	82	our $USE_FSYNC = 1; # use fsync to write maps - default off
55		83
56	our $BDB_POLL_WATCHER;	84	our $BDB_POLL_WATCHER;
…		…
62	our $RUNTIME;	90	our $RUNTIME;
63		91
64	our %PLAYER; # all users	92	our %PLAYER; # all users
65	our %MAP; # all maps	93	our %MAP; # all maps
66	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
67	our $RANDOM_MAPS = cf::localdir . "/random";
68	our $BDB_ENV_DIR = cf::localdir . "/db";
69
70	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
71	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
72		95
73	# 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 ∕
74	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
75		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
76	binmode STDOUT;	103	binmode STDOUT;
77	binmode STDERR;	104	binmode STDERR;
78		105
79	# read virtual server time, if available	106	# read virtual server time, if available
80	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
81	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
82	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
83	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
84	}	111	}
85		112
86	mkdir cf::localdir;	113	mkdir $_
87	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
88	mkdir cf::localdir . "/" . cf::tmpdir;
89	mkdir cf::localdir . "/" . cf::uniquedir;
90	mkdir $RANDOM_MAPS;
91	mkdir $BDB_ENV_DIR;
92		115
93	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
94		117
95	sub cf::map::normalise;	118	sub cf::map::normalise;
96		119
…		…
107	=item $cf::RUNTIME	130	=item $cf::RUNTIME
108		131
109	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
110	every server tick.	133	every server tick.
111		134
112	=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
113		138
114	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
115	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.
116		143
117	=item $cf::NOW	144	=item $cf::NOW
118		145
119	The time of the last (current) server tick.	146	The time of the last (current) server tick.
120		147
121	=item $cf::TICK	148	=item $cf::TICK
122		149
123	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.
124		161
125	=item %cf::CFG	162	=item %cf::CFG
126		163
127	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
128	from wherever your confdir points to.	165	from wherever your confdir points to.
129		166
130	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
131		168
132	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	169	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
133	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	170	returns directly I<after> the tick processing (and consequently, can only wake one process
134	processing has been done. Call C<< ->wait >> on them to maximise the	171	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
135	window of cpu time available, or simply to synchronise to the server tick.	172
		173	=item @cf::INVOKE_RESULTS
		174
		175	This array contains the results of the last C<invoke ()> call. When
		176	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		177	that call.
136		178
137	=back	179	=back
138		180
139	=cut	181	=cut
140		182
141	BEGIN {	183	BEGIN {
142	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
143	my $msg = join "", @_;	185	my $msg = join "", @_;
144	utf8::encode $msg;
145		186
146	$msg .= "\n"	187	$msg .= "\n"
147	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
148		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
149	LOG llevError, $msg;	193	LOG llevError, $msg;
150	};	194	};
151	}	195	}
152		196
153	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
154	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
155	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
156	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
157	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	201	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		202	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
158	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	203	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
159		204
160	# we bless all objects into (empty) derived classes to force a method lookup	205	# we bless all objects into (empty) derived classes to force a method lookup
161	# within the Safe compartment.	206	# within the Safe compartment.
162	for my $pkg (qw(	207	for my $pkg (qw(
163	cf::global cf::attachable	208	cf::global cf::attachable
…		…
171	}	216	}
172		217
173	$Event::DIED = sub {	218	$Event::DIED = sub {
174	warn "error in event callback: @_";	219	warn "error in event callback: @_";
175	};	220	};
		221
		222	#############################################################################
176		223
177	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
178		225
179	=over 4	226	=over 4
180		227
…		…
199	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	246	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
200	$d	247	$d
201	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
202	}	249	}
203		250
204	use JSON::Syck (); # TODO# replace by JSON::PC once working
205
206	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
207		252
208	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
209		254
210	=cut
211
212	sub from_json($) {
213	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
214	JSON::Syck::Load $_[0]
215	}
216
217	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
218		256
219	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
220		258
221	=cut	259	=cut
222		260
223	sub to_json($) {	261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
224	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	262
225	JSON::Syck::Dump $_[0]	263	sub to_json ($) { $json_coder->encode ($_[0]) }
226	}	264	sub from_json ($) { $json_coder->decode ($_[0]) }
227		265
228	=item cf::lock_wait $string	266	=item cf::lock_wait $string
229		267
230	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
231		269
…		…
234	Wait until the given lock is available and then acquires it and returns	272	Wait until the given lock is available and then acquires it and returns
235	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	273	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
236	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
237	returned.	275	returned.
238		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
		279
239	Lock names should begin with a unique identifier (for example, cf::map::find	280	Lock names should begin with a unique identifier (for example, cf::map::find
240	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
		282
		283	=item $locked = cf::lock_active $string
		284
		285	Return true if the lock is currently active, i.e. somebody has locked it.
241		286
242	=cut	287	=cut
243		288
244	our %LOCK;	289	our %LOCK;
245		290
…		…
265	# wake up all waiters, to be on the safe side	310	# wake up all waiters, to be on the safe side
266	$_->ready for @{ delete $LOCK{$key} };	311	$_->ready for @{ delete $LOCK{$key} };
267	}	312	}
268	}	313	}
269		314
		315	sub lock_active($) {
		316	my ($key) = @_;
		317
		318	! ! $LOCK{$key}
		319	}
		320
270	sub freeze_mainloop {	321	sub freeze_mainloop {
271	return unless $TICK_WATCHER->is_active;	322	return unless $TICK_WATCHER->is_active;
272		323
273	my $guard = Coro::guard {	324	my $guard = Coro::guard {
274	$TICK_WATCHER->start;	325	$TICK_WATCHER->start;
275	$WRITE_RUNTIME_WATCHER->start;
276	};	326	};
277	$WRITE_RUNTIME_WATCHER->stop;
278	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
279	$guard	328	$guard
		329	}
		330
		331	=item cf::get_slot $time[, $priority[, $name]]
		332
		333	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		334	This call blocks and returns only when you have at least C<$time> seconds
		335	of cpu time till the next tick. The slot is only valid till the next cede.
		336
		337	The optional C<$name> can be used to identify the job to run. It might be
		338	used for statistical purposes and should identify the same time-class.
		339
		340	Useful for short background jobs.
		341
		342	=cut
		343
		344	our @SLOT_QUEUE;
		345	our $SLOT_QUEUE;
		346
		347	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		348	$SLOT_QUEUE = Coro::async {
		349	my $signal = new Coro::Signal;
		350
		351	while () {
		352	next_job:
		353	my $avail = cf::till_tick;
		354	if ($avail > 0.01) {
		355	for (0 .. $#SLOT_QUEUE) {
		356	if ($SLOT_QUEUE[$_][0] < $avail) {
		357	my $job = splice @SLOT_QUEUE, $_, 1, ();
		358	$job->[2]->send;
		359	Coro::cede;
		360	goto next_job;
		361	}
		362	}
		363	}
		364
		365	if (@SLOT_QUEUE) {
		366	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		367	push @cf::WAIT_FOR_TICK, $signal;
		368	$signal->wait;
		369	} else {
		370	Coro::schedule;
		371	}
		372	}
		373	};
		374
		375	sub get_slot($;$$) {
		376	my ($time, $pri, $name) = @_;
		377
		378	$time = $TICK * .6 if $time > $TICK * .6;
		379	my $sig = new Coro::Signal;
		380
		381	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		382	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		383	$SLOT_QUEUE->ready;
		384	$sig->wait;
280	}	385	}
281		386
282	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
283		388
284	Currently the same as Coro::async_pool, meaning you cannot use	389	Currently the same as Coro::async_pool, meaning you cannot use
…		…
289		394
290	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
291		396
292	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
293		398
294	The design of crossfire+ requires that the main coro ($Coro::main) is	399	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
295	always able to handle events or runnable, as crossfire+ is only partly	400	is always able to handle events or runnable, as Crossfire TRT is only
296	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	401	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		402	acceptable.
297		403
298	If it must be done, put the blocking parts into C<sync_job>. This will run	404	If it must be done, put the blocking parts into C<sync_job>. This will run
299	the given BLOCK in another coroutine while waiting for the result. The	405	the given BLOCK in another coroutine while waiting for the result. The
300	server will be frozen during this time, so the block should either finish	406	server will be frozen during this time, so the block should either finish
301	fast or be very important.	407	fast or be very important.
…		…
304		410
305	sub sync_job(&) {	411	sub sync_job(&) {
306	my ($job) = @_;	412	my ($job) = @_;
307		413
308	if ($Coro::current == $Coro::main) {	414	if ($Coro::current == $Coro::main) {
		415	my $time = Event::time;
		416
309	# this is the main coro, too bad, we have to block	417	# this is the main coro, too bad, we have to block
310	# till the operation succeeds, freezing the server :/	418	# till the operation succeeds, freezing the server :/
311		419
312	# TODO: use suspend/resume instead	420	# TODO: use suspend/resume instead
313	# (but this is cancel-safe)	421	# (but this is cancel-safe)
…		…
324		432
325	while ($busy) {	433	while ($busy) {
326	Coro::cede or Event::one_event;	434	Coro::cede or Event::one_event;
327	}	435	}
328		436
		437	$time = Event::time - $time;
		438
		439	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		440	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		441
		442	$tick_start += $time; # do not account sync jobs to server load
		443
329	wantarray ? @res : $res[0]	444	wantarray ? @res : $res[0]
330	} else {	445	} else {
331	# we are in another coroutine, how wonderful, everything just works	446	# we are in another coroutine, how wonderful, everything just works
332		447
333	$job->()	448	$job->()
…		…
352	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
353		468
354	$coro	469	$coro
355	}	470	}
356		471
357	sub write_runtime {	472	=item fork_call { }, $args
358	my $runtime = cf::localdir . "/runtime";
359		473
360	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	474	Executes the given code block with the given arguments in a seperate
361	or return;	475	process, returning the results. Everything must be serialisable with
		476	Coro::Storable. May, of course, block. Note that the executed sub may
		477	never block itself or use any form of Event handling.
362		478
363	my $value = $cf::RUNTIME + 90 + 10;	479	=cut
364	# 10 is the runtime save interval, for a monotonic clock
365	# 60 allows for the watchdog to kill the server.
366		480
367	(aio_write $fh, 0, (length $value), $value, 0) <= 0	481	sub fork_call(&@) {
368	and return;	482	my ($cb, @args) = @_;
369		483
370	# always fsync - this file is important	484	# we seemingly have to make a local copy of the whole thing,
371	aio_fsync $fh	485	# otherwise perl prematurely frees the stuff :/
372	and return;	486	# TODO: investigate and fix (liekly this will be rather laborious)
373		487
374	close $fh	488	my @res = Coro::Util::fork_eval {
375	or return;	489	reset_signals;
		490	&$cb
		491	}, @args;
376		492
377	aio_rename "$runtime~", $runtime	493	wantarray ? @res : $res[-1]
378	and return;	494	}
379		495
		496	=item $value = cf::db_get $family => $key
		497
		498	Returns a single value from the environment database.
		499
		500	=item cf::db_put $family => $key => $value
		501
		502	Stores the given C<$value> in the family. It can currently store binary
		503	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		504
		505	=cut
		506
		507	our $DB;
		508
		509	sub db_init {
		510	unless ($DB) {
		511	$DB = BDB::db_create $DB_ENV;
		512
		513	cf::sync_job {
		514	eval {
		515	$DB->set_flags (BDB::CHKSUM);
		516
		517	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		518	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		519	cf::cleanup "db_open(db): $!" if $!;
		520	};
		521	cf::cleanup "db_open(db): $@" if $@;
		522	};
380	1	523	}
		524	}
		525
		526	sub db_get($$) {
		527	my $key = "$_[0]/$_[1]";
		528
		529	cf::sync_job {
		530	BDB::db_get $DB, undef, $key, my $data;
		531
		532	$! ? ()
		533	: $data
		534	}
		535	}
		536
		537	sub db_put($$$) {
		538	BDB::dbreq_pri 4;
		539	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		540	}
		541
		542	=item cf::cache $id => [$paths...], $processversion => $process
		543
		544	Generic caching function that returns the value of the resource $id,
		545	caching and regenerating as required.
		546
		547	This function can block.
		548
		549	=cut
		550
		551	sub cache {
		552	my ($id, $src, $processversion, $process) = @_;
		553
		554	my $meta =
		555	join "\x00",
		556	$processversion,
		557	map {
		558	aio_stat $_
		559	and Carp::croak "$_: $!";
		560
		561	($_, (stat _)[7,9])
		562	} @$src;
		563
		564	my $dbmeta = db_get cache => "$id/meta";
		565	if ($dbmeta ne $meta) {
		566	# changed, we may need to process
		567
		568	my @data;
		569	my $md5;
		570
		571	for (0 .. $#$src) {
		572	0 <= aio_load $src->[$_], $data[$_]
		573	or Carp::croak "$src->[$_]: $!";
		574	}
		575
		576	# if processing is expensive, check
		577	# checksum first
		578	if (1) {
		579	$md5 =
		580	join "\x00",
		581	$processversion,
		582	map {
		583	cf::cede_to_tick;
		584	($src->[$_], Digest::MD5::md5_hex $data[$_])
		585	} 0.. $#$src;
		586
		587
		588	my $dbmd5 = db_get cache => "$id/md5";
		589	if ($dbmd5 eq $md5) {
		590	db_put cache => "$id/meta", $meta;
		591
		592	return db_get cache => "$id/data";
		593	}
		594	}
		595
		596	my $t1 = Time::HiRes::time;
		597	my $data = $process->(\@data);
		598	my $t2 = Time::HiRes::time;
		599
		600	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		601
		602	db_put cache => "$id/data", $data;
		603	db_put cache => "$id/md5" , $md5;
		604	db_put cache => "$id/meta", $meta;
		605
		606	return $data;
		607	}
		608
		609	db_get cache => "$id/data"
		610	}
		611
		612	=item cf::datalog type => key => value, ...
		613
		614	Log a datalog packet of the given type with the given key-value pairs.
		615
		616	=cut
		617
		618	sub datalog($@) {
		619	my ($type, %kv) = @_;
		620	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
381	}	621	}
382		622
383	=back	623	=back
384		624
385	=cut	625	=cut
…		…
392	attach callbacks/event handlers (a collection of which is called an "attachment")	632	attach callbacks/event handlers (a collection of which is called an "attachment")
393	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
394		634
395	In the following description, CLASS can be any of C<global>, C<object>	635	In the following description, CLASS can be any of C<global>, C<object>
396	C<player>, C<client> or C<map> (i.e. the attachable objects in	636	C<player>, C<client> or C<map> (i.e. the attachable objects in
397	crossfire+).	637	Crossfire TRT).
398		638
399	=over 4	639	=over 4
400		640
401	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
402		642
…		…
565	$registry = $CB_TYPE[$object_type] ||= [];	805	$registry = $CB_TYPE[$object_type] ||= [];
566		806
567	} elsif ($type eq "subtype") {	807	} elsif ($type eq "subtype") {
568	defined $object_type or Carp::croak "subtype specified without type";	808	defined $object_type or Carp::croak "subtype specified without type";
569	my $object_subtype = shift @arg;	809	my $object_subtype = shift @arg;
570	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	810	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571		811
572	} elsif ($type eq "package") {	812	} elsif ($type eq "package") {
573	my $pkg = shift @arg;	813	my $pkg = shift @arg;
574		814
575	while (my ($name, $id) = each %cb_id) {	815	while (my ($name, $id) = each %cb_id) {
…		…
604	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
605	}	845	}
606		846
607	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
608	} else {	848	} else {
609	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
610	}	850	}
611		851
612	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
613	}	853	}
614		854
…		…
616	if (ref $_[0]) {	856	if (ref $_[0]) {
617	_object_attach @_;	857	_object_attach @_;
618	} else {	858	} else {
619	_attach shift->_attach_registry, @_;	859	_attach shift->_attach_registry, @_;
620	}	860	}
		861	_recalc_want;
621	};	862	};
622		863
623	# all those should be optimised	864	# all those should be optimised
624	sub cf::attachable::detach {	865	sub cf::attachable::detach {
625	my ($obj, $name) = @_;	866	my ($obj, $name) = @_;
…		…
628	delete $obj->{_attachment}{$name};	869	delete $obj->{_attachment}{$name};
629	reattach ($obj);	870	reattach ($obj);
630	} else {	871	} else {
631	Carp::croak "cannot, currently, detach class attachments";	872	Carp::croak "cannot, currently, detach class attachments";
632	}	873	}
		874	_recalc_want;
633	};	875	};
634		876
635	sub cf::attachable::attached {	877	sub cf::attachable::attached {
636	my ($obj, $name) = @_;	878	my ($obj, $name) = @_;
637		879
…		…
652	";	894	";
653	die if $@;	895	die if $@;
654	}	896	}
655		897
656	our $override;	898	our $override;
657	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	899	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
658		900
659	sub override {	901	sub override {
660	$override = 1;	902	$override = 1;
661	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
662	}	904	}
663		905
664	sub do_invoke {	906	sub do_invoke {
665	my $event = shift;	907	my $event = shift;
666	my $callbacks = shift;	908	my $callbacks = shift;
667		909
668	@invoke_results = ();	910	@INVOKE_RESULTS = ();
669		911
670	local $override;	912	local $override;
671		913
672	for (@$callbacks) {	914	for (@$callbacks) {
673	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
690		932
691	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
692		934
693	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	935	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
694	removed in future versions), and there is no public API to access override	936	removed in future versions), and there is no public API to access override
695	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696		938
697	=back	939	=back
698		940
699	=cut	941	=cut
700		942
701	#############################################################################	943	#############################################################################
702	# object support	944	# object support
		945	#
		946
		947	sub _can_merge {
		948	my ($ob1, $ob2) = @_;
		949
		950	local $Storable::canonical = 1;
		951	my $fob1 = Storable::freeze $ob1;
		952	my $fob2 = Storable::freeze $ob2;
		953
		954	$fob1 eq $fob2
		955	}
703		956
704	sub reattach {	957	sub reattach {
705	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
706	my ($obj) = @_;	959	my ($obj) = @_;
707		960
…		…
784	}	1037	}
785	} else {	1038	} else {
786	aio_unlink $filename;	1039	aio_unlink $filename;
787	aio_unlink "$filename.pst";	1040	aio_unlink "$filename.pst";
788	}	1041	}
789
790	#d##TODO# nuke non .map-files if exist
791	if ($filename =~ s/\.map$//) {
792	aio_unlink $filename;
793	aio_unlink "$filename.pst";
794	}
795	}	1042	}
796	}	1043	}
797		1044
798	sub object_freezer_as_string {	1045	sub object_freezer_as_string {
799	my ($rdata, $objs) = @_;	1046	my ($rdata, $objs) = @_;
…		…
805		1052
806	sub object_thawer_load {	1053	sub object_thawer_load {
807	my ($filename) = @_;	1054	my ($filename) = @_;
808		1055
809	my ($data, $av);	1056	my ($data, $av);
810
811	#d#TODO remove .map if file does not exist
812	aio_stat $filename and $filename =~ s/\.map$//;
813		1057
814	(aio_load $filename, $data) >= 0	1058	(aio_load $filename, $data) >= 0
815	or return;	1059	or return;
816		1060
817	unless (aio_stat "$filename.pst") {	1061	unless (aio_stat "$filename.pst") {
…		…
819	or return;	1063	or return;
820	$av = eval { (Storable::thaw $av)->{objs} };	1064	$av = eval { (Storable::thaw $av)->{objs} };
821	}	1065	}
822		1066
823	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
824	$filename, length $data, scalar @{$av || []};#d#	1068	$filename, length $data, scalar @{$av || []};
825	return ($data, $av);	1069	return ($data, $av);
826	}	1070	}
		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
827		1077
828	#############################################################################	1078	#############################################################################
829	# command handling &c	1079	# command handling &c
830		1080
831	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
…		…
844	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
845	}	1095	}
846		1096
847	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
848		1098
849	Register a callbackf ro execution when the client sends an extcmd packet.	1099	Register a callback for execution when the client sends an (synchronous)
		1100	extcmd packet. Ext commands will be processed in the order they are
		1101	received by the server, like other user commands. The first argument is
		1102	the logged-in player. Ext commands can only be processed after a player
		1103	has logged in successfully.
850		1104
851	If the callback returns something, it is sent back as if reply was being	1105	If the callback returns something, it is sent back as if reply was being
852	called.	1106	called.
853		1107
		1108	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1109
		1110	Register a callback for execution when the client sends an (asynchronous)
		1111	exticmd packet. Exti commands are processed by the server as soon as they
		1112	are received, i.e. out of order w.r.t. other commands. The first argument
		1113	is a client socket. Exti commands can be received anytime, even before
		1114	log-in.
		1115
		1116	If the callback returns something, it is sent back as if reply was being
		1117	called.
		1118
854	=cut	1119	=cut
855		1120
856	sub register_extcmd {	1121	sub register_extcmd {
857	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
858		1123
859	$EXTCMD{$name} = $cb;	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
860	}	1131	}
861		1132
862	cf::player->attach (	1133	cf::player->attach (
863	on_command => sub {	1134	on_command => sub {
864	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
873	cf::override;	1144	cf::override;
874	},	1145	},
875	on_extcmd => sub {	1146	on_extcmd => sub {
876	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
877		1148
878	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
879		1150
880	if (ref $msg) {	1151	if (ref $msg) {
		1152	my ($type, $reply, @payload) =
		1153	"ARRAY" eq ref $msg
		1154	? @$msg
		1155	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1156
		1157	my @reply;
		1158
881	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
882	if (my %reply = $cb->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
883	$pl->ext_reply ($msg->{msgid}, %reply);
884	}
885	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
886	} else {	1166	} else {
887	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
888	}	1168	}
889		1169
890	cf::override;	1170	cf::override;
891	},	1171	},
892	);	1172	);
893		1173
894	sub load_extension {
895	my ($path) = @_;
896
897	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
898	my $base = $1;
899	my $pkg = $1;
900	$pkg =~ s/[^[:word:]]/_/g;
901	$pkg = "ext::$pkg";
902
903	warn "... loading '$path' into '$pkg'\n";
904
905	open my $fh, "<:utf8", $path
906	or die "$path: $!";
907
908	my $source =
909	"package $pkg; use strict; use utf8;\n"
910	. "#line 1 \"$path\"\n{\n"
911	. (do { local $/; <$fh> })
912	. "\n};\n1";
913
914	unless (eval $source) {
915	my $msg = $@ ? "$path: $@\n"
916	: "extension disabled.\n";
917	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
918	warn $@;
919	warn "mandatory extension failed to load, exiting.\n";
920	exit 1;
921	}
922	die $@;
923	}
924
925	push @EXTS, $pkg;
926	}
927
928	sub load_extensions {	1174	sub load_extensions {
		1175	cf::sync_job {
		1176	my %todo;
		1177
929	for my $ext (<$LIBDIR/*.ext>) {	1178	for my $path (<$LIBDIR/*.ext>) {
930	next unless -r $ext;	1179	next unless -r $path;
931	eval {	1180
932	load_extension $ext;	1181	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1182	my $base = $1;
		1183	my $pkg = $1;
		1184	$pkg =~ s/[^[:word:]]/_/g;
		1185	$pkg = "ext::$pkg";
		1186
		1187	open my $fh, "<:utf8", $path
		1188	or die "$path: $!";
		1189
		1190	my $source = do { local $/; <$fh> };
		1191
		1192	my %ext = (
		1193	path => $path,
		1194	base => $base,
		1195	pkg => $pkg,
		1196	);
		1197
		1198	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1199	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1200
		1201	$ext{source} =
		1202	"package $pkg; use strict; use utf8;\n"
		1203	. "#line 1 \"$path\"\n{\n"
		1204	. $source
		1205	. "\n};\n1";
		1206
		1207	$todo{$base} = \%ext;
		1208	}
		1209
		1210	my %done;
		1211	while (%todo) {
		1212	my $progress;
		1213
		1214	while (my ($k, $v) = each %todo) {
		1215	for (split /,\s*/, $v->{meta}{depends}) {
		1216	goto skip
		1217	unless exists $done{$_};
		1218	}
		1219
		1220	warn "... loading '$k' into '$v->{pkg}'\n";
		1221
		1222	unless (eval $v->{source}) {
		1223	my $msg = $@ ? "$v->{path}: $@\n"
		1224	: "$v->{base}: extension inactive.\n";
		1225
		1226	if (exists $v->{meta}{mandatory}) {
		1227	warn $msg;
		1228	warn "mandatory extension failed to load, exiting.\n";
		1229	exit 1;
		1230	}
		1231
		1232	warn $msg;
		1233	}
		1234
		1235	$done{$k} = delete $todo{$k};
		1236	push @EXTS, $v->{pkg};
		1237	$progress = 1;
933	1	1238	}
934	} or warn "$ext not loaded: $@";	1239
		1240	skip:
		1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1242	unless $progress;
		1243	}
935	}	1244	};
936	}	1245	}
937		1246
938	#############################################################################	1247	#############################################################################
939		1248
		1249	=back
		1250
940	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
941		1252
942	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
943		1254
944	=cut	1255	=cut
…		…
956	Returns the given player object, loading it if necessary (might block).	1267	Returns the given player object, loading it if necessary (might block).
957		1268
958	=cut	1269	=cut
959		1270
960	sub playerdir($) {	1271	sub playerdir($) {
961	cf::localdir	1272	"$PLAYERDIR/"
962	. "/"
963	. cf::playerdir
964	. "/"
965	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1273	. (ref $_[0] ? $_[0]->ob->name : $_[0])
966	}	1274	}
967		1275
968	sub path($) {	1276	sub path($) {
969	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1277	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
970		1278
971	(playerdir $login) . "/$login.pl"	1279	(playerdir $login) . "/playerdata"
972	}	1280	}
973		1281
974	sub find_active($) {	1282	sub find_active($) {
975	$cf::PLAYER{$_[0]}	1283	$cf::PLAYER{$_[0]}
976	and $cf::PLAYER{$_[0]}->active	1284	and $cf::PLAYER{$_[0]}->active
…		…
989	my $login = $_[0];	1297	my $login = $_[0];
990		1298
991	my $guard = cf::lock_acquire "user_find:$login";	1299	my $guard = cf::lock_acquire "user_find:$login";
992		1300
993	$cf::PLAYER{$_[0]} || do {	1301	$cf::PLAYER{$_[0]} || do {
		1302	# rename old playerfiles to new ones
		1303	#TODO: remove when no longer required
		1304	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1305	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1306	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1307	aio_unlink +(playerdir $login) . "/$login.pl";
		1308
994	my $pl = load_pl path $login	1309	my $pl = load_pl path $login
995	or return;	1310	or return;
996	$cf::PLAYER{$login} = $pl	1311	$cf::PLAYER{$login} = $pl
997	}	1312	}
998	}	1313	}
…		…
1010		1325
1011	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
1012	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
1013		1328
1014	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
1015	Coro::cede;	1330	cf::cede_to_tick;
1016	}	1331	}
1017		1332
1018	sub new($) {	1333	sub new($) {
1019	my ($login) = @_;	1334	my ($login) = @_;
1020		1335
…		…
1026	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1027		1342
1028	$self	1343	$self
1029	}	1344	}
1030		1345
		1346	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1347
		1348	=cut
		1349
		1350	sub send_msg {
		1351	my $ns = shift->ns
		1352	or return;
		1353	$ns->send_msg (@_);
		1354	}
		1355
1031	=item $pl->quit_character	1356	=item $pl->quit_character
1032		1357
1033	Nukes the player without looking back. If logged in, the connection will	1358	Nukes the player without looking back. If logged in, the connection will
1034	be destroyed. May block for a long time.	1359	be destroyed. May block for a long time.
1035		1360
1036	=cut	1361	=cut
1037		1362
1038	sub quit_character {	1363	sub quit_character {
1039	my ($pl) = @_;	1364	my ($pl) = @_;
		1365
		1366	my $name = $pl->ob->name;
1040		1367
1041	$pl->{deny_save} = 1;	1368	$pl->{deny_save} = 1;
1042	$pl->password ("*"); # this should lock out the player until we nuked the dir	1369	$pl->password ("*"); # this should lock out the player until we nuked the dir
1043		1370
1044	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1371	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1049	my $path = playerdir $pl;	1376	my $path = playerdir $pl;
1050	my $temp = "$path~$cf::RUNTIME~deleting~";	1377	my $temp = "$path~$cf::RUNTIME~deleting~";
1051	aio_rename $path, $temp;	1378	aio_rename $path, $temp;
1052	delete $cf::PLAYER{$pl->ob->name};	1379	delete $cf::PLAYER{$pl->ob->name};
1053	$pl->destroy;	1380	$pl->destroy;
		1381
		1382	my $prefix = qr<^~\Q$name\E/>;
		1383
		1384	# nuke player maps
		1385	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1386
1054	IO::AIO::aio_rmtree $temp;	1387	IO::AIO::aio_rmtree $temp;
		1388	}
		1389
		1390	=item $pl->kick
		1391
		1392	Kicks a player out of the game. This destroys the connection.
		1393
		1394	=cut
		1395
		1396	sub kick {
		1397	my ($pl, $kicker) = @_;
		1398
		1399	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1400	$pl->killer ("kicked");
		1401	$pl->ns->destroy;
1055	}	1402	}
1056		1403
1057	=item cf::player::list_logins	1404	=item cf::player::list_logins
1058		1405
1059	Returns am arrayref of all valid playernames in the system, can take a	1406	Returns am arrayref of all valid playernames in the system, can take a
1060	while and may block, so not sync_job-capable, ever.	1407	while and may block, so not sync_job-capable, ever.
1061		1408
1062	=cut	1409	=cut
1063		1410
1064	sub list_logins {	1411	sub list_logins {
1065	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1412	my $dirs = aio_readdir $PLAYERDIR
1066	or return [];	1413	or return [];
1067		1414
1068	my @logins;	1415	my @logins;
1069		1416
1070	for my $login (@$dirs) {	1417	for my $login (@$dirs) {
…		…
1105	}	1452	}
1106		1453
1107	\@paths	1454	\@paths
1108	}	1455	}
1109		1456
		1457	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1458
		1459	Expand crossfire pod fragments into protocol xml.
		1460
		1461	=cut
		1462
		1463	sub expand_cfpod {
		1464	((my $self), (local $_)) = @_;
		1465
		1466	# escape & and <
		1467	s/&/&amp;/g;
		1468	s/(?<![BIUGH])</&lt;/g;
		1469
		1470	# this is buggy, it needs to properly take care of nested <'s
		1471
		1472	1 while
		1473	# replace B<>, I<>, U<> etc.
		1474	s/B<([^\>]*)>/<b>$1<\/b>/
		1475	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1476	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1477	# replace G<male|female> tags
		1478	|| s{G<([^>|]*)\|([^>]*)>}{
		1479	$self->gender ? $2 : $1
		1480	}ge
		1481	# replace H<hint text>
		1482	|| s{H<([^\>]*)>}
		1483	{
		1484	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1485	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1486	"")
		1487	[$self->{hintmode}]
		1488	}ge;
		1489
		1490	# create single paragraphs (very hackish)
		1491	s/(?<=\S)\n(?=\w)/ /g;
		1492
		1493	# compress some whitespace
		1494	s/\s+\n/\n/g; # ws line-ends
		1495	s/\n\n+/\n/g; # double lines
		1496	s/^\n+//; # beginning lines
		1497	s/\n+$//; # ending lines
		1498
		1499	$_
		1500	}
		1501
		1502	sub hintmode {
		1503	$_[0]{hintmode} = $_[1] if @_ > 1;
		1504	$_[0]{hintmode}
		1505	}
		1506
1110	=item $player->ext_reply ($msgid, $msgtype, %msg)	1507	=item $player->ext_reply ($msgid, @msg)
1111		1508
1112	Sends an ext reply to the player.	1509	Sends an ext reply to the player.
1113		1510
1114	=cut	1511	=cut
1115		1512
1116	sub ext_reply($$$%) {	1513	sub ext_reply($$@) {
1117	my ($self, $id, %msg) = @_;	1514	my ($self, $id, @msg) = @_;
1118		1515
1119	$msg{msgid} = $id;	1516	$self->ns->ext_reply ($id, @msg)
1120
1121	$self->send ("ext " . cf::to_json \%msg);
1122	}	1517	}
1123		1518
1124	package cf;	1519	=item $player->ext_msg ($type, @msg)
		1520
		1521	Sends an ext event to the client.
		1522
		1523	=cut
		1524
		1525	sub ext_msg($$@) {
		1526	my ($self, $type, @msg) = @_;
		1527
		1528	$self->ns->ext_msg ($type, @msg);
		1529	}
		1530
		1531	=head3 cf::region
		1532
		1533	=over 4
		1534
		1535	=cut
		1536
		1537	package cf::region;
		1538
		1539	=item cf::region::find_by_path $path
		1540
		1541	Tries to decuce the likely region for a map knowing only its path.
		1542
		1543	=cut
		1544
		1545	sub find_by_path($) {
		1546	my ($path) = @_;
		1547
		1548	my ($match, $specificity);
		1549
		1550	for my $region (list) {
		1551	if ($region->{match} && $path =~ $region->{match}) {
		1552	($match, $specificity) = ($region, $region->specificity)
		1553	if $region->specificity > $specificity;
		1554	}
		1555	}
		1556
		1557	$match
		1558	}
1125		1559
1126	=back	1560	=back
1127
1128		1561
1129	=head3 cf::map	1562	=head3 cf::map
1130		1563
1131	=over 4	1564	=over 4
1132		1565
…		…
1187	my ($self, $merge) = @_;	1620	my ($self, $merge) = @_;
1188		1621
1189	# we have to keep some variables in memory intact	1622	# we have to keep some variables in memory intact
1190	local $self->{path};	1623	local $self->{path};
1191	local $self->{load_path};	1624	local $self->{load_path};
1192	local $self->{deny_save};
1193	local $self->{deny_reset};
1194		1625
1195	$self->SUPER::thawer_merge ($merge);	1626	$self->SUPER::thawer_merge ($merge);
1196	}	1627	}
1197		1628
1198	sub normalise {	1629	sub normalise {
…		…
1245	$self->init; # pass $1 etc.	1676	$self->init; # pass $1 etc.
1246	return $self;	1677	return $self;
1247	}	1678	}
1248	}	1679	}
1249		1680
1250	Carp::carp "unable to resolve path '$path' (base '$base').";	1681	Carp::cluck "unable to resolve path '$path' (base '$base').";
1251	()	1682	()
1252	}	1683	}
1253		1684
1254	sub init {	1685	sub init {
1255	my ($self) = @_;	1686	my ($self) = @_;
…		…
1270		1701
1271	# the original (read-only) location	1702	# the original (read-only) location
1272	sub load_path {	1703	sub load_path {
1273	my ($self) = @_;	1704	my ($self) = @_;
1274		1705
1275	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1706	"$MAPDIR/$self->{path}.map"
1276	}	1707	}
1277		1708
1278	# the temporary/swap location	1709	# the temporary/swap location
1279	sub save_path {	1710	sub save_path {
1280	my ($self) = @_;	1711	my ($self) = @_;
1281		1712
1282	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1713	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1714	"$TMPDIR/$path.map"
1284	}	1715	}
1285		1716
1286	# the unique path, undef == no special unique path	1717	# the unique path, undef == no special unique path
1287	sub uniq_path {	1718	sub uniq_path {
1288	my ($self) = @_;	1719	my ($self) = @_;
1289		1720
1290	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1721	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1291	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1722	"$UNIQUEDIR/$path"
1292	}	1723	}
1293		1724
1294	# and all this just because we cannot iterate over	1725	# and all this just because we cannot iterate over
1295	# all maps in C++...	1726	# all maps in C++...
1296	sub change_all_map_light {	1727	sub change_all_map_light {
…		…
1298		1729
1299	$_->change_map_light ($change)	1730	$_->change_map_light ($change)
1300	for grep $_->outdoor, values %cf::MAP;	1731	for grep $_->outdoor, values %cf::MAP;
1301	}	1732	}
1302		1733
		1734	sub decay_objects {
		1735	my ($self) = @_;
		1736
		1737	return if $self->{deny_reset};
		1738
		1739	$self->do_decay_objects;
		1740	}
		1741
1303	sub unlink_save {	1742	sub unlink_save {
1304	my ($self) = @_;	1743	my ($self) = @_;
1305		1744
1306	utf8::encode (my $save = $self->save_path);	1745	utf8::encode (my $save = $self->save_path);
1307	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1746	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1308	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1747	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1309
1310	#d#TODO remove .map and also nuke
1311	$save =~ s/\.map// or return;#d#
1312	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1313	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1314	}	1748	}
1315		1749
1316	sub load_header_from($) {	1750	sub load_header_from($) {
1317	my ($self, $path) = @_;	1751	my ($self, $path) = @_;
1318		1752
…		…
1368	$self->load_header_orig	1802	$self->load_header_orig
1369	or return;	1803	or return;
1370	$self->prepare_orig;	1804	$self->prepare_orig;
1371	}	1805	}
1372		1806
		1807	$self->{deny_reset} = 1
		1808	if $self->no_reset;
		1809
		1810	$self->default_region (cf::region::find_by_path $self->{path})
		1811	unless $self->default_region;
		1812
1373	1	1813	1
1374	}	1814	}
1375		1815
1376	sub find;	1816	sub find;
1377	sub find {	1817	sub find {
…		…
1389	$map->{last_save} = $cf::RUNTIME;	1829	$map->{last_save} = $cf::RUNTIME;
1390		1830
1391	$map->load_header	1831	$map->load_header
1392	or return;	1832	or return;
1393		1833
1394	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1834	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1395	# doing this can freeze the server in a sync job, obviously	1835	# doing this can freeze the server in a sync job, obviously
1396	#$cf::WAIT_FOR_TICK->wait;	1836	#$cf::WAIT_FOR_TICK->wait;
1397	$map->reset;	1837	$map->reset;
1398	undef $guard;	1838	undef $guard;
1399	return find $path;	1839	return find $path;
…		…
1410	my ($self) = @_;	1850	my ($self) = @_;
1411		1851
1412	local $self->{deny_reset} = 1; # loading can take a long time	1852	local $self->{deny_reset} = 1; # loading can take a long time
1413		1853
1414	my $path = $self->{path};	1854	my $path = $self->{path};
		1855
		1856	{
		1857	my $guard1 = cf::lock_acquire "map_data:$path";
1415	my $guard = cf::lock_acquire "map_load:$path";	1858	my $guard2 = cf::lock_acquire "map_load:$path";
1416		1859
1417	return if $self->in_memory != cf::MAP_SWAPPED;	1860	return if $self->in_memory != cf::MAP_SWAPPED;
1418		1861
1419	$self->in_memory (cf::MAP_LOADING);	1862	$self->in_memory (cf::MAP_LOADING);
1420		1863
1421	$self->alloc;	1864	$self->alloc;
1422		1865
1423	$self->pre_load;	1866	$self->pre_load;
		1867	cf::cede_to_tick;
1424		1868
1425	$self->_load_objects ($self->{load_path}, 1)	1869	$self->_load_objects ($self->{load_path}, 1)
1426	or return;	1870	or return;
1427		1871
1428	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1872	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1429	if delete $self->{load_original};	1873	if delete $self->{load_original};
1430		1874
1431	if (my $uniq = $self->uniq_path) {	1875	if (my $uniq = $self->uniq_path) {
1432	utf8::encode $uniq;	1876	utf8::encode $uniq;
1433	if (aio_open $uniq, O_RDONLY, 0) {	1877	if (aio_open $uniq, O_RDONLY, 0) {
1434	$self->clear_unique_items;	1878	$self->clear_unique_items;
1435	$self->_load_objects ($uniq, 0);	1879	$self->_load_objects ($uniq, 0);
1436	}	1880	}
1437	}	1881	}
1438		1882
1439	Coro::cede;	1883	cf::cede_to_tick;
1440
1441	# now do the right thing for maps	1884	# now do the right thing for maps
1442	$self->link_multipart_objects;	1885	$self->link_multipart_objects;
1443
1444	unless ($self->{deny_activate}) {
1445	$self->decay_objects;
1446	$self->fix_auto_apply;
1447	$self->update_buttons;
1448	Coro::cede;
1449	$self->set_darkness_map;
1450	$self->difficulty ($self->estimate_difficulty)	1886	$self->difficulty ($self->estimate_difficulty)
1451	unless $self->difficulty;	1887	unless $self->difficulty;
1452	Coro::cede;	1888	cf::cede_to_tick;
		1889
		1890	unless ($self->{deny_activate}) {
		1891	$self->decay_objects;
		1892	$self->fix_auto_apply;
		1893	$self->update_buttons;
		1894	cf::cede_to_tick;
		1895	$self->set_darkness_map;
		1896	cf::cede_to_tick;
1453	$self->activate;	1897	$self->activate;
		1898	}
		1899
		1900	$self->{last_save} = $cf::RUNTIME;
		1901	$self->last_access ($cf::RUNTIME);
		1902
		1903	$self->in_memory (cf::MAP_IN_MEMORY);
1454	}	1904	}
1455		1905
1456	$self->post_load;	1906	$self->post_load;
1457
1458	$self->in_memory (cf::MAP_IN_MEMORY);
1459	}	1907	}
1460		1908
1461	sub customise_for {	1909	sub customise_for {
1462	my ($self, $ob) = @_;	1910	my ($self, $ob) = @_;
1463		1911
1464	return find "~" . $ob->name . "/" . $self->{path}	1912	return find "~" . $ob->name . "/" . $self->{path}
1465	if $self->per_player;	1913	if $self->per_player;
1466		1914
		1915	# return find "?party/" . $ob->name . "/" . $self->{path}
		1916	# if $self->per_party;
		1917
1467	$self	1918	$self
1468	}	1919	}
1469		1920
1470	# find and load all maps in the 3x3 area around a map	1921	# find and load all maps in the 3x3 area around a map
1471	sub load_diag {	1922	sub load_neighbours {
1472	my ($map) = @_;	1923	my ($map) = @_;
1473		1924
1474	my @diag; # diagonal neighbours	1925	my @neigh; # diagonal neighbours
1475		1926
1476	for (0 .. 3) {	1927	for (0 .. 3) {
1477	my $neigh = $map->tile_path ($_)	1928	my $neigh = $map->tile_path ($_)
1478	or next;	1929	or next;
1479	$neigh = find $neigh, $map	1930	$neigh = find $neigh, $map
1480	or next;	1931	or next;
1481	$neigh->load;	1932	$neigh->load;
1482		1933
		1934	push @neigh,
1483	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1935	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1484	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1936	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1485	}	1937	}
1486		1938
1487	for (@diag) {	1939	for (grep defined $_->[0], @neigh) {
		1940	my ($path, $origin) = @$_;
1488	my $neigh = find @$_	1941	my $neigh = find $path, $origin
1489	or next;	1942	or next;
1490	$neigh->load;	1943	$neigh->load;
1491	}	1944	}
1492	}	1945	}
1493		1946
…		…
1498	}	1951	}
1499		1952
1500	sub do_load_sync {	1953	sub do_load_sync {
1501	my ($map) = @_;	1954	my ($map) = @_;
1502		1955
		1956	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1957	if $Coro::current == $Coro::main;
		1958
1503	cf::sync_job { $map->load };	1959	cf::sync_job { $map->load };
1504	}	1960	}
1505		1961
1506	our %MAP_PREFETCH;	1962	our %MAP_PREFETCH;
1507	our $MAP_PREFETCHER = undef;	1963	our $MAP_PREFETCHER = undef;
1508		1964
1509	sub find_async {	1965	sub find_async {
1510	my ($path, $origin) = @_;	1966	my ($path, $origin, $load) = @_;
1511		1967
1512	$path = normalise $path, $origin && $origin->{path};	1968	$path = normalise $path, $origin && $origin->{path};
1513		1969
1514	if (my $map = $cf::MAP{$path}) {	1970	if (my $map = $cf::MAP{$path}) {
1515	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1971	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1516	}	1972	}
1517		1973
1518	undef $MAP_PREFETCH{$path};	1974	$MAP_PREFETCH{$path} |= $load;
		1975
1519	$MAP_PREFETCHER ||= cf::async {	1976	$MAP_PREFETCHER ||= cf::async {
1520	while (%MAP_PREFETCH) {	1977	while (%MAP_PREFETCH) {
1521	for my $path (keys %MAP_PREFETCH) {	1978	while (my ($k, $v) = each %MAP_PREFETCH) {
1522	my $map = find $path	1979	if (my $map = find $k) {
1523	or next;
1524	$map->load;	1980	$map->load if $v;
		1981	}
1525		1982
1526	delete $MAP_PREFETCH{$path};	1983	delete $MAP_PREFETCH{$k};
1527	}	1984	}
1528	}	1985	}
1529	undef $MAP_PREFETCHER;	1986	undef $MAP_PREFETCHER;
1530	};	1987	};
1531	$MAP_PREFETCHER->prio (6);	1988	$MAP_PREFETCHER->prio (6);
…		…
1534	}	1991	}
1535		1992
1536	sub save {	1993	sub save {
1537	my ($self) = @_;	1994	my ($self) = @_;
1538		1995
1539	my $lock = cf::lock_acquire "map_data:" . $self->path;	1996	my $lock = cf::lock_acquire "map_data:$self->{path}";
1540		1997
1541	$self->{last_save} = $cf::RUNTIME;	1998	$self->{last_save} = $cf::RUNTIME;
1542		1999
1543	return unless $self->dirty;	2000	return unless $self->dirty;
1544		2001
…		…
1567	my ($self) = @_;	2024	my ($self) = @_;
1568		2025
1569	# save first because save cedes	2026	# save first because save cedes
1570	$self->save;	2027	$self->save;
1571		2028
1572	my $lock = cf::lock_acquire "map_data:" . $self->path;	2029	my $lock = cf::lock_acquire "map_data:$self->{path}";
1573		2030
1574	return if $self->players;	2031	return if $self->players;
1575	return if $self->in_memory != cf::MAP_IN_MEMORY;	2032	return if $self->in_memory != cf::MAP_IN_MEMORY;
1576	return if $self->{deny_save};	2033	return if $self->{deny_save};
1577		2034
…		…
1581		2038
1582	sub reset_at {	2039	sub reset_at {
1583	my ($self) = @_;	2040	my ($self) = @_;
1584		2041
1585	# TODO: safety, remove and allow resettable per-player maps	2042	# TODO: safety, remove and allow resettable per-player maps
1586	return 1e99 if $self->isa ("ext::map_per_player");#d#
1587	return 1e99 if $self->{deny_reset};	2043	return 1e99 if $self->{deny_reset};
1588		2044
1589	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2045	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1590	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2046	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1591		2047
…		…
1602	my ($self) = @_;	2058	my ($self) = @_;
1603		2059
1604	my $lock = cf::lock_acquire "map_data:$self->{path}";	2060	my $lock = cf::lock_acquire "map_data:$self->{path}";
1605		2061
1606	return if $self->players;	2062	return if $self->players;
1607	return if $self->isa ("ext::map_per_player");#d#
1608		2063
1609	warn "resetting map ", $self->path;#d#	2064	warn "resetting map ", $self->path;
		2065
		2066	$self->in_memory (cf::MAP_SWAPPED);
		2067
		2068	# need to save uniques path
		2069	unless ($self->{deny_save}) {
		2070	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2071
		2072	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2073	if $uniq;
		2074	}
1610		2075
1611	delete $cf::MAP{$self->path};	2076	delete $cf::MAP{$self->path};
1612		2077
1613	$self->in_memory (cf::MAP_SWAPPED);
1614	$self->clear;	2078	$self->clear;
1615		2079
1616	$_->clear_links_to ($self) for values %cf::MAP;	2080	$_->clear_links_to ($self) for values %cf::MAP;
1617		2081
1618	$self->unlink_save;	2082	$self->unlink_save;
…		…
1637	$cf::MAP{$self->path} = $self;	2101	$cf::MAP{$self->path} = $self;
1638		2102
1639	$self->reset; # polite request, might not happen	2103	$self->reset; # polite request, might not happen
1640	}	2104	}
1641		2105
		2106	=item $maps = cf::map::tmp_maps
		2107
		2108	Returns an arrayref with all map paths of currently instantiated and saved
		2109	maps. May block.
		2110
		2111	=cut
		2112
		2113	sub tmp_maps() {
		2114	[
		2115	map {
		2116	utf8::decode $_;
		2117	/\.map$/
		2118	? normalise $_
		2119	: ()
		2120	} @{ aio_readdir $TMPDIR or [] }
		2121	]
		2122	}
		2123
		2124	=item $maps = cf::map::random_maps
		2125
		2126	Returns an arrayref with all map paths of currently instantiated and saved
		2127	random maps. May block.
		2128
		2129	=cut
		2130
		2131	sub random_maps() {
		2132	[
		2133	map {
		2134	utf8::decode $_;
		2135	/\.map$/
		2136	? normalise "?random/$_"
		2137	: ()
		2138	} @{ aio_readdir $RANDOMDIR or [] }
		2139	]
		2140	}
		2141
1642	=item cf::map::unique_maps	2142	=item cf::map::unique_maps
1643		2143
1644	Returns an arrayref of paths of all shared maps that have	2144	Returns an arrayref of paths of all shared maps that have
1645	instantiated unique items. May block.	2145	instantiated unique items. May block.
1646		2146
1647	=cut	2147	=cut
1648		2148
1649	sub unique_maps() {	2149	sub unique_maps() {
1650	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2150	[
1651	or return;	2151	map {
1652
1653	my @paths;
1654
1655	for (@$files) {
1656	utf8::decode $_;	2152	utf8::decode $_;
1657	next if /\.pst$/;	2153	/\.map$/
1658	next unless /^$PATH_SEP/o;	2154	? normalise $_
1659		2155	: ()
1660	push @paths, cf::map::normalise $_;	2156	} @{ aio_readdir $UNIQUEDIR or [] }
1661	}	2157	]
1662
1663	\@paths
1664	}	2158	}
1665		2159
1666	package cf;	2160	package cf;
1667		2161
1668	=back	2162	=back
…		…
1714		2208
1715	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2209	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1716		2210
1717	if ($self->{record_replies}) {	2211	if ($self->{record_replies}) {
1718	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2212	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2213
1719	} else {	2214	} else {
		2215	my $pl = $self->contr;
		2216
		2217	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2218	my $dialog = $pl->{npc_dialog};
		2219	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2220
		2221	} else {
1720	$msg = $npc->name . " says: $msg" if $npc;	2222	$msg = $npc->name . " says: $msg" if $npc;
1721	$self->message ($msg, $flags);	2223	$self->message ($msg, $flags);
		2224	}
1722	}	2225	}
		2226	}
		2227
		2228	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2229
		2230	=cut
		2231
		2232	sub cf::object::send_msg {
		2233	my $pl = shift->contr
		2234	or return;
		2235	$pl->send_msg (@_);
1723	}	2236	}
1724		2237
1725	=item $player_object->may ("access")	2238	=item $player_object->may ("access")
1726		2239
1727	Returns wether the given player is authorized to access resource "access"	2240	Returns wether the given player is authorized to access resource "access"
…		…
1774	$self->deactivate_recursive;	2287	$self->deactivate_recursive;
1775		2288
1776	return if UNIVERSAL::isa $self->map, "ext::map_link";	2289	return if UNIVERSAL::isa $self->map, "ext::map_link";
1777		2290
1778	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2291	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1779	if $self->map;	2292	if $self->map && $self->map->{path} ne "{link}";
1780		2293
1781	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2294	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1782	}	2295	}
1783		2296
1784	sub cf::object::player::leave_link {	2297	sub cf::object::player::leave_link {
1785	my ($self, $map, $x, $y) = @_;	2298	my ($self, $map, $x, $y) = @_;
		2299
		2300	return unless $self->contr->active;
1786		2301
1787	my $link_pos = delete $self->{_link_pos};	2302	my $link_pos = delete $self->{_link_pos};
1788		2303
1789	unless ($map) {	2304	unless ($map) {
1790	# restore original map position	2305	# restore original map position
…		…
1804	# use -1 or undef as default coordinates, not 0, 0	2319	# use -1 or undef as default coordinates, not 0, 0
1805	($x, $y) = ($map->enter_x, $map->enter_y)	2320	($x, $y) = ($map->enter_x, $map->enter_y)
1806	if $x <=0 && $y <= 0;	2321	if $x <=0 && $y <= 0;
1807		2322
1808	$map->load;	2323	$map->load;
1809	$map->load_diag;	2324	$map->load_neighbours;
1810		2325
1811	return unless $self->contr->active;	2326	return unless $self->contr->active;
1812	$self->activate_recursive;	2327	$self->activate_recursive;
		2328
		2329	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813	$self->enter_map ($map, $x, $y);	2330	$self->enter_map ($map, $x, $y);
1814	}	2331	}
1815		2332
1816	cf::player->attach (	2333	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1817	on_logout => sub {
1818	my ($pl) = @_;
1819		2334
1820	# abort map switching before logout	2335	Moves the player to the given map-path and coordinates by first freezing
1821	if ($pl->ob->{_link_pos}) {	2336	her, loading and preparing them map, calling the provided $check callback
1822	cf::sync_job {	2337	that has to return the map if sucecssful, and then unfreezes the player on
1823	$pl->ob->leave_link	2338	the new (success) or old (failed) map position. In either case, $done will
1824	};	2339	be called at the end of this process.
1825	}
1826	},
1827	on_login => sub {
1828	my ($pl) = @_;
1829		2340
1830	# try to abort aborted map switching on player login :)
1831	# should happen only on crashes
1832	if ($pl->ob->{_link_pos}) {
1833	$pl->ob->enter_link;
1834	(async {
1835	# we need this sleep as the login has a concurrent enter_exit running
1836	# and this sleep increases chances of the player not ending up in scorn
1837	$pl->ob->reply (undef,
1838	"There was an internal problem at your last logout, "
1839	. "the server will try to bring you to your intended destination in a second.",
1840	cf::NDI_RED);
1841	Coro::Timer::sleep 1;
1842	$pl->ob->leave_link;
1843	})->prio (2);
1844	}
1845	},
1846	);
1847
1848	=item $player_object->goto ($path, $x, $y)
1849
1850	=cut	2341	=cut
		2342
		2343	our $GOTOGEN;
1851		2344
1852	sub cf::object::player::goto {	2345	sub cf::object::player::goto {
1853	my ($self, $path, $x, $y) = @_;	2346	my ($self, $path, $x, $y, $check, $done) = @_;
		2347
		2348	# do generation counting so two concurrent goto's will be executed in-order
		2349	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1854		2350
1855	$self->enter_link;	2351	$self->enter_link;
1856		2352
1857	(async {	2353	(async {
1858	my $map = eval {	2354	my $map = eval {
1859	my $map = cf::map::find $path;	2355	my $map = cf::map::find $path;
		2356
		2357	if ($map) {
1860	$map = $map->customise_for ($self) if $map;	2358	$map = $map->customise_for ($self);
		2359	$map = $check->($map) if $check && $map;
		2360	} else {
		2361	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2362	}
		2363
1861	$map	2364	$map
		2365	};
		2366
		2367	if ($@) {
		2368	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2369	LOG llevError | logBacktrace, Carp::longmess $@;
1862	} or	2370	}
1863	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864		2371
		2372	if ($gen == $self->{_goto_generation}) {
		2373	delete $self->{_goto_generation};
1865	$self->leave_link ($map, $x, $y);	2374	$self->leave_link ($map, $x, $y);
		2375	}
		2376
		2377	$done->() if $done;
1866	})->prio (1);	2378	})->prio (1);
1867	}	2379	}
1868		2380
1869	=item $player_object->enter_exit ($exit_object)	2381	=item $player_object->enter_exit ($exit_object)
1870		2382
…		…
1909		2421
1910	$rmp->{random_seed} ||= $exit->random_seed;	2422	$rmp->{random_seed} ||= $exit->random_seed;
1911		2423
1912	my $data = cf::to_json $rmp;	2424	my $data = cf::to_json $rmp;
1913	my $md5 = Digest::MD5::md5_hex $data;	2425	my $md5 = Digest::MD5::md5_hex $data;
1914	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2426	my $meta = "$RANDOMDIR/$md5.meta";
1915		2427
1916	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2428	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917	aio_write $fh, 0, (length $data), $data, 0;	2429	aio_write $fh, 0, (length $data), $data, 0;
1918	undef $fh;	2430	undef $fh;
1919	aio_rename "$meta~", $meta;	2431	aio_rename "$meta~", $meta;
…		…
1928		2440
1929	return unless $self->type == cf::PLAYER;	2441	return unless $self->type == cf::PLAYER;
1930		2442
1931	if ($exit->slaying eq "/!") {	2443	if ($exit->slaying eq "/!") {
1932	#TODO: this should de-fi-ni-te-ly not be a sync-job	2444	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2445	# the problem is that $exit might not survive long enough
		2446	# so it needs to be done right now, right here
1933	cf::sync_job { prepare_random_map $exit };	2447	cf::sync_job { prepare_random_map $exit };
1934	}	2448	}
1935		2449
1936	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2450	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1937	my $hp = $exit->stats->hp;	2451	my $hp = $exit->stats->hp;
1938	my $sp = $exit->stats->sp;	2452	my $sp = $exit->stats->sp;
1939		2453
1940	$self->enter_link;	2454	$self->enter_link;
		2455
		2456	# if exit is damned, update players death & WoR home-position
		2457	$self->contr->savebed ($slaying, $hp, $sp)
		2458	if $exit->flag (FLAG_DAMNED);
1941		2459
1942	(async {	2460	(async {
1943	$self->deactivate_recursive; # just to be sure	2461	$self->deactivate_recursive; # just to be sure
1944	unless (eval {	2462	unless (eval {
1945	$self->goto ($slaying, $hp, $sp);	2463	$self->goto ($slaying, $hp, $sp);
1946		2464
1947	1;	2465	1;
1948	}) {	2466	}) {
1949	$self->message ("Something went wrong deep within the crossfire server. "	2467	$self->message ("Something went wrong deep within the crossfire server. "
1950	. "I'll try to bring you back to the map you were before. "	2468	. "I'll try to bring you back to the map you were before. "
1951	. "Please report this to the dungeon master!",	2469	. "Please report this to the dungeon master!",
1952	cf::NDI_UNIQUE | cf::NDI_RED);	2470	cf::NDI_UNIQUE | cf::NDI_RED);
1953		2471
1954	warn "ERROR in enter_exit: $@";	2472	warn "ERROR in enter_exit: $@";
1955	$self->leave_link;	2473	$self->leave_link;
1956	}	2474	}
1957	})->prio (1);	2475	})->prio (1);
…		…
1970		2488
1971	sub cf::client::send_drawinfo {	2489	sub cf::client::send_drawinfo {
1972	my ($self, $text, $flags) = @_;	2490	my ($self, $text, $flags) = @_;
1973		2491
1974	utf8::encode $text;	2492	utf8::encode $text;
1975	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2493	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976	}	2494	}
1977		2495
		2496	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2497
		2498	Send a drawinfo or msg packet to the client, formatting the msg for the
		2499	client if neccessary. C<$type> should be a string identifying the type of
		2500	the message, with C<log> being the default. If C<$color> is negative, suppress
		2501	the message unless the client supports the msg packet.
		2502
		2503	=cut
		2504
		2505	sub cf::client::send_msg {
		2506	my ($self, $channel, $msg, $color, @extra) = @_;
		2507
		2508	$msg = $self->pl->expand_cfpod ($msg);
		2509
		2510	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2511
		2512	if (ref $channel) {
		2513	# send meta info to client, if not yet sent
		2514	unless (exists $self->{channel}{$channel->{id}}) {
		2515	$self->{channel}{$channel->{id}} = $channel;
		2516	$self->ext_msg (channel_info => $channel);
		2517	}
		2518
		2519	$channel = $channel->{id};
		2520	}
		2521
		2522	return unless @extra || length $msg;
		2523
		2524	if ($self->can_msg) {
		2525	# default colour, mask it out
		2526	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2527	if $color & cf::NDI_DEF;
		2528
		2529	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2530	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2531	} else {
		2532	if ($color >= 0) {
		2533	# replace some tags by gcfclient-compatible ones
		2534	for ($msg) {
		2535	1 while
		2536	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2537	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2538	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2539	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2540	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2541	}
		2542
		2543	$color &= cf::NDI_COLOR_MASK;
		2544
		2545	utf8::encode $msg;
		2546
		2547	if (0 && $msg =~ /\[/) {
		2548	# COMMAND/INFO
		2549	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2550	} else {
		2551	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2552	$self->send_packet ("drawinfo $color $msg")
		2553	}
		2554	}
		2555	}
		2556	}
		2557
		2558	=item $client->ext_msg ($type, @msg)
		2559
		2560	Sends an ext event to the client.
		2561
		2562	=cut
		2563
		2564	sub cf::client::ext_msg($$@) {
		2565	my ($self, $type, @msg) = @_;
		2566
		2567	if ($self->extcmd == 2) {
		2568	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2569	} elsif ($self->extcmd == 1) { # TODO: remove
		2570	push @msg, msgtype => "event_$type";
		2571	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2572	}
		2573	}
		2574
		2575	=item $client->ext_reply ($msgid, @msg)
		2576
		2577	Sends an ext reply to the client.
		2578
		2579	=cut
		2580
		2581	sub cf::client::ext_reply($$@) {
		2582	my ($self, $id, @msg) = @_;
		2583
		2584	if ($self->extcmd == 2) {
		2585	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2586	} elsif ($self->extcmd == 1) {
		2587	#TODO: version 1, remove
		2588	unshift @msg, msgtype => "reply", msgid => $id;
		2589	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2590	}
		2591	}
1978		2592
1979	=item $success = $client->query ($flags, "text", \&cb)	2593	=item $success = $client->query ($flags, "text", \&cb)
1980		2594
1981	Queues a query to the client, calling the given callback with	2595	Queues a query to the client, calling the given callback with
1982	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2596	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1983	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2597	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1984		2598
1985	Queries can fail, so check the return code. Or don't, as queries will become	2599	Queries can fail, so check the return code. Or don't, as queries will
1986	reliable at some point in the future.	2600	become reliable at some point in the future.
1987		2601
1988	=cut	2602	=cut
1989		2603
1990	sub cf::client::query {	2604	sub cf::client::query {
1991	my ($self, $flags, $text, $cb) = @_;	2605	my ($self, $flags, $text, $cb) = @_;
…		…
1999	utf8::encode $text;	2613	utf8::encode $text;
2000	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2614	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001		2615
2002	$self->send_packet ($self->{query_queue}[0][0])	2616	$self->send_packet ($self->{query_queue}[0][0])
2003	if @{ $self->{query_queue} } == 1;	2617	if @{ $self->{query_queue} } == 1;
		2618
		2619	1
2004	}	2620	}
2005		2621
2006	cf::client->attach (	2622	cf::client->attach (
		2623	on_connect => sub {
		2624	my ($ns) = @_;
		2625
		2626	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2627	},
2007	on_reply => sub {	2628	on_reply => sub {
2008	my ($ns, $msg) = @_;	2629	my ($ns, $msg) = @_;
2009		2630
2010	# this weird shuffling is so that direct followup queries	2631	# this weird shuffling is so that direct followup queries
2011	# get handled first	2632	# get handled first
…		…
2023	} else {	2644	} else {
2024	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2645	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025	}	2646	}
2026	}	2647	}
2027	},	2648	},
		2649	on_exticmd => sub {
		2650	my ($ns, $buf) = @_;
		2651
		2652	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2653
		2654	if (ref $msg) {
		2655	my ($type, $reply, @payload) =
		2656	"ARRAY" eq ref $msg
		2657	? @$msg
		2658	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2659
		2660	my @reply;
		2661
		2662	if (my $cb = $EXTICMD{$type}) {
		2663	@reply = $cb->($ns, @payload);
		2664	}
		2665
		2666	$ns->ext_reply ($reply, @reply)
		2667	if $reply;
		2668
		2669	} else {
		2670	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2671	}
		2672
		2673	cf::override;
		2674	},
2028	);	2675	);
2029		2676
2030	=item $client->async (\&cb)	2677	=item $client->async (\&cb)
2031		2678
2032	Create a new coroutine, running the specified callback. The coroutine will	2679	Create a new coroutine, running the specified callback. The coroutine will
…		…
2073	our $safe = new Safe "safe";	2720	our $safe = new Safe "safe";
2074	our $safe_hole = new Safe::Hole;	2721	our $safe_hole = new Safe::Hole;
2075		2722
2076	$SIG{FPE} = 'IGNORE';	2723	$SIG{FPE} = 'IGNORE';
2077		2724
2078	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2725	$safe->permit_only (Opcode::opset qw(
		2726	:base_core :base_mem :base_orig :base_math
		2727	grepstart grepwhile mapstart mapwhile
		2728	sort time
		2729	));
2079		2730
2080	# here we export the classes and methods available to script code	2731	# here we export the classes and methods available to script code
2081		2732
2082	=pod	2733	=pod
2083		2734
2084	The following fucntions and emthods are available within a safe environment:	2735	The following functions and methods are available within a safe environment:
2085		2736
2086	cf::object contr pay_amount pay_player map	2737	cf::object
		2738	contr pay_amount pay_player map x y force_find force_add
		2739	insert remove name archname title slaying race decrease_ob_nr
		2740
2087	cf::object::player player	2741	cf::object::player
2088	cf::player peaceful	2742	player
2089	cf::map trigger	2743
		2744	cf::player
		2745	peaceful
		2746
		2747	cf::map
		2748	trigger
2090		2749
2091	=cut	2750	=cut
2092		2751
2093	for (	2752	for (
2094	["cf::object" => qw(contr pay_amount pay_player map)],	2753	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2754	insert remove inv name archname title slaying race
		2755	decrease_ob_nr)],
2095	["cf::object::player" => qw(player)],	2756	["cf::object::player" => qw(player)],
2096	["cf::player" => qw(peaceful)],	2757	["cf::player" => qw(peaceful)],
2097	["cf::map" => qw(trigger)],	2758	["cf::map" => qw(trigger)],
2098	) {	2759	) {
2099	no strict 'refs';	2760	no strict 'refs';
…		…
2170	=back	2831	=back
2171		2832
2172	=cut	2833	=cut
2173		2834
2174	#############################################################################	2835	#############################################################################
2175
2176	=head2 EXTENSION DATABASE SUPPORT
2177
2178	Crossfire maintains a very simple database for extension use. It can
2179	currently store anything that can be serialised using Storable, which
2180	excludes objects.
2181
2182	The parameter C<$family> should best start with the name of the extension
2183	using it, it should be unique.
2184
2185	=over 4
2186
2187	=item $hashref = cf::db_get $family
2188
2189	Return a hashref for use by the extension C<$family>, which can be
2190	modified. After modifications, you have to call C<cf::db_dirty> or
2191	C<cf::db_sync>.
2192
2193	=item $value = cf::db_get $family => $key
2194
2195	Returns a single value from the database
2196
2197	=item cf::db_put $family => $hashref
2198
2199	Stores the given family hashref into the database. Updates are delayed, if
2200	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2201
2202	=item cf::db_put $family => $key => $value
2203
2204	Stores the given C<$value> in the family hash. Updates are delayed, if you
2205	want the data to be synced to disk immediately, use C<cf::db_sync>.
2206
2207	=item cf::db_dirty
2208
2209	Marks the database as dirty, to be updated at a later time.
2210
2211	=item cf::db_sync
2212
2213	Immediately write the database to disk I<if it is dirty>.
2214
2215	=cut
2216
2217	our $DB;
2218
2219	{
2220	my $path = cf::localdir . "/database.pst";
2221
2222	sub db_load() {
2223	$DB = stat $path ? Storable::retrieve $path : { };
2224	}
2225
2226	my $pid;
2227
2228	sub db_save() {
2229	waitpid $pid, 0 if $pid;
2230	if (0 == ($pid = fork)) {
2231	$DB->{_meta}{version} = 1;
2232	Storable::nstore $DB, "$path~";
2233	rename "$path~", $path;
2234	cf::_exit 0 if defined $pid;
2235	}
2236	}
2237
2238	my $dirty;
2239
2240	sub db_sync() {
2241	db_save if $dirty;
2242	undef $dirty;
2243	}
2244
2245	my $idle = Event->idle (
2246	reentrant => 0,
2247	min => 10,
2248	max => 20,
2249	repeat => 0,
2250	data => WF_AUTOCANCEL,
2251	cb => \&db_sync,
2252	);
2253
2254	sub db_dirty() {
2255	$dirty = 1;
2256	$idle->start;
2257	}
2258
2259	sub db_get($;$) {
2260	@_ >= 2
2261	? $DB->{$_[0]}{$_[1]}
2262	: ($DB->{$_[0]} ||= { })
2263	}
2264
2265	sub db_put($$;$) {
2266	if (@_ >= 3) {
2267	$DB->{$_[0]}{$_[1]} = $_[2];
2268	} else {
2269	$DB->{$_[0]} = $_[1];
2270	}
2271	db_dirty;
2272	}
2273
2274	cf::global->attach (
2275	prio => 10000,
2276	on_cleanup => sub {
2277	db_sync;
2278	},
2279	);
2280	}
2281
2282	#############################################################################
2283	# the server's init and main functions	2836	# the server's init and main functions
2284		2837
2285	sub load_resources {	2838	sub load_facedata($) {
2286	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2839	my ($path) = @_;
		2840
		2841	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		2842
		2843	warn "loading facedata from $path\n";
		2844
		2845	my $facedata;
		2846	0 < aio_load $path, $facedata
		2847	or die "$path: $!";
		2848
		2849	$facedata = Coro::Storable::thaw $facedata;
		2850
		2851	$facedata->{version} == 2
		2852	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2853
		2854	# patch in the exptable
		2855	$facedata->{resource}{"res/exp_table"} = {
		2856	type => FT_RSRC,
		2857	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2858	};
		2859	cf::cede_to_tick;
		2860
		2861	{
		2862	my $faces = $facedata->{faceinfo};
		2863
		2864	while (my ($face, $info) = each %$faces) {
		2865	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2866	cf::face::set_visibility $idx, $info->{visibility};
		2867	cf::face::set_magicmap $idx, $info->{magicmap};
		2868	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2869	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
		2870
		2871	cf::cede_to_tick;
		2872	}
		2873
		2874	while (my ($face, $info) = each %$faces) {
		2875	next unless $info->{smooth};
		2876	my $idx = cf::face::find $face
		2877	or next;
		2878	if (my $smooth = cf::face::find $info->{smooth}) {
		2879	cf::face::set_smooth $idx, $smooth;
		2880	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2881	} else {
		2882	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2883	}
		2884
		2885	cf::cede_to_tick;
		2886	}
		2887	}
		2888
		2889	{
		2890	my $anims = $facedata->{animinfo};
		2891
		2892	while (my ($anim, $info) = each %$anims) {
		2893	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2894	cf::cede_to_tick;
		2895	}
		2896
		2897	cf::anim::invalidate_all; # d'oh
		2898	}
		2899
		2900	{
		2901	# TODO: for gcfclient pleasure, we should give resources
		2902	# that gcfclient doesn't grok a >10000 face index.
		2903	my $res = $facedata->{resource};
		2904
		2905	my $soundconf = delete $res->{"res/sound.conf"};
		2906
		2907	while (my ($name, $info) = each %$res) {
		2908	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2909	my $data;
		2910
		2911	if ($info->{type} & 1) {
		2912	# prepend meta info
		2913
		2914	my $meta = $enc->encode ({
		2915	name => $name,
		2916	%{ $info->{meta} || {} },
		2917	});
		2918
		2919	$data = pack "(w/a*)*", $meta, $info->{data};
		2920	} else {
		2921	$data = $info->{data};
		2922	}
		2923
		2924	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2925	cf::face::set_type $idx, $info->{type};
		2926
		2927	cf::cede_to_tick;
		2928	}
		2929
		2930	if ($soundconf) {
		2931	$soundconf = $enc->decode (delete $soundconf->{data});
		2932
		2933	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2934	my $sound = $soundconf->{compat}[$_]
		2935	or next;
		2936
		2937	my $face = cf::face::find "sound/$sound->[1]";
		2938	cf::sound::set $sound->[0] => $face;
		2939	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2940	}
		2941
		2942	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2943	my $face = cf::face::find "sound/$v";
		2944	cf::sound::set $k => $face;
		2945	}
		2946	}
		2947	}
		2948
		2949	1
		2950	}
		2951
		2952	register_exticmd fx_want => sub {
		2953	my ($ns, $want) = @_;
		2954
		2955	while (my ($k, $v) = each %$want) {
		2956	$ns->fx_want ($k, $v);
		2957	}
		2958	};
		2959
		2960	sub reload_regions {
		2961	load_resource_file "$MAPDIR/regions"
2287	or die "unable to load regions file\n";#d#	2962	or die "unable to load regions file\n";
2288	}
2289		2963
2290	sub cfg_load {	2964	for (cf::region::list) {
		2965	$_->{match} = qr/$_->{match}/
		2966	if exists $_->{match};
		2967	}
		2968	}
		2969
		2970	sub reload_facedata {
		2971	load_facedata "$DATADIR/facedata"
		2972	or die "unable to load facedata\n";
		2973	}
		2974
		2975	sub reload_archetypes {
		2976	load_resource_file "$DATADIR/archetypes"
		2977	or die "unable to load archetypes\n";
		2978	#d# NEED to laod twice to resolve forward references
		2979	# this really needs to be done in an extra post-pass
		2980	# (which needs to be synchronous, so solve it differently)
		2981	load_resource_file "$DATADIR/archetypes"
		2982	or die "unable to load archetypes\n";
		2983	}
		2984
		2985	sub reload_treasures {
		2986	load_resource_file "$DATADIR/treasures"
		2987	or die "unable to load treasurelists\n";
		2988	}
		2989
		2990	sub reload_resources {
		2991	warn "reloading resource files...\n";
		2992
		2993	reload_regions;
		2994	reload_facedata;
		2995	#reload_archetypes;#d#
		2996	reload_archetypes;
		2997	reload_treasures;
		2998
		2999	warn "finished reloading resource files\n";
		3000	}
		3001
		3002	sub init {
		3003	reload_resources;
		3004	}
		3005
		3006	sub reload_config {
2291	open my $fh, "<:utf8", cf::confdir . "/config"	3007	open my $fh, "<:utf8", "$CONFDIR/config"
2292	or return;	3008	or return;
2293		3009
2294	local $/;	3010	local $/;
2295	*CFG = YAML::Syck::Load <$fh>;	3011	*CFG = YAML::Syck::Load <$fh>;
2296		3012
…		…
2304	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3020	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2305	and die "WARNING: m(un)lockall failed: $!\n";	3021	and die "WARNING: m(un)lockall failed: $!\n";
2306	};	3022	};
2307	warn $@ if $@;	3023	warn $@ if $@;
2308	}	3024	}
2309	}
2310
2311	sub init {
2312	load_resources;
2313	}	3025	}
2314		3026
2315	sub main {	3027	sub main {
2316	# we must not ever block the main coroutine	3028	# we must not ever block the main coroutine
2317	local $Coro::idle = sub {	3029	local $Coro::idle = sub {
…		…
2319	(async {	3031	(async {
2320	Event::one_event;	3032	Event::one_event;
2321	})->prio (Coro::PRIO_MAX);	3033	})->prio (Coro::PRIO_MAX);
2322	};	3034	};
2323		3035
2324	cfg_load;	3036	reload_config;
2325	db_load;	3037	db_init;
2326	load_extensions;	3038	load_extensions;
2327		3039
2328	$TICK_WATCHER->start;	3040	$TICK_WATCHER->start;
2329	Event::loop;	3041	Event::loop;
2330	}	3042	}
…		…
2345	},	3057	},
2346	);	3058	);
2347	}	3059	}
2348	}	3060	}
2349		3061
		3062	sub write_runtime {
		3063	my $runtime = "$LOCALDIR/runtime";
		3064
		3065	# first touch the runtime file to show we are still running:
		3066	# the fsync below can take a very very long time.
		3067
		3068	IO::AIO::aio_utime $runtime, undef, undef;
		3069
		3070	my $guard = cf::lock_acquire "write_runtime";
		3071
		3072	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3073	or return;
		3074
		3075	my $value = $cf::RUNTIME + 90 + 10;
		3076	# 10 is the runtime save interval, for a monotonic clock
		3077	# 60 allows for the watchdog to kill the server.
		3078
		3079	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3080	and return;
		3081
		3082	# always fsync - this file is important
		3083	aio_fsync $fh
		3084	and return;
		3085
		3086	# touch it again to show we are up-to-date
		3087	aio_utime $fh, undef, undef;
		3088
		3089	close $fh
		3090	or return;
		3091
		3092	aio_rename "$runtime~", $runtime
		3093	and return;
		3094
		3095	warn "runtime file written.\n";
		3096
		3097	1
		3098	}
		3099
2350	sub emergency_save() {	3100	sub emergency_save() {
2351	my $freeze_guard = cf::freeze_mainloop;	3101	my $freeze_guard = cf::freeze_mainloop;
2352		3102
2353	warn "enter emergency perl save\n";	3103	warn "enter emergency perl save\n";
2354		3104
…		…
2369	my $map = $cf::MAP{$path} or next;	3119	my $map = $cf::MAP{$path} or next;
2370	$map->valid or next;	3120	$map->valid or next;
2371	$map->save;	3121	$map->save;
2372	}	3122	}
2373	warn "end emergency map save\n";	3123	warn "end emergency map save\n";
		3124
		3125	warn "begin emergency database checkpoint\n";
		3126	BDB::db_env_txn_checkpoint $DB_ENV;
		3127	warn "end emergency database checkpoint\n";
2374	};	3128	};
2375		3129
2376	warn "leave emergency perl save\n";	3130	warn "leave emergency perl save\n";
2377	}	3131	}
2378		3132
		3133	sub post_cleanup {
		3134	my ($make_core) = @_;
		3135
		3136	warn Carp::longmess "post_cleanup backtrace"
		3137	if $make_core;
		3138	}
		3139
2379	sub reload() {	3140	sub do_reload_perl() {
2380	# can/must only be called in main	3141	# can/must only be called in main
2381	if ($Coro::current != $Coro::main) {	3142	if ($Coro::current != $Coro::main) {
2382	warn "can only reload from main coroutine";	3143	warn "can only reload from main coroutine";
2383	return;	3144	return;
2384	}	3145	}
2385		3146
2386	warn "reloading...";	3147	warn "reloading...";
2387		3148
2388	warn "cancelling server ticker";	3149	warn "entering sync_job";
2389	$TICK_WATCHER->cancel;
2390		3150
		3151	cf::sync_job {
		3152	cf::write_runtime; # external watchdog should not bark
2391	cf::emergency_save;	3153	cf::emergency_save;
		3154	cf::write_runtime; # external watchdog should not bark
2392		3155
2393	eval {	3156	warn "syncing database to disk";
		3157	BDB::db_env_txn_checkpoint $DB_ENV;
		3158
2394	# if anything goes wrong in here, we should simply crash as we already saved	3159	# if anything goes wrong in here, we should simply crash as we already saved
2395
2396	warn "syncing database to disk";
2397	cf::db_sync;
2398		3160
2399	warn "cancelling all WF_AUTOCANCEL watchers";	3161	warn "cancelling all WF_AUTOCANCEL watchers";
2400	for (Event::all_watchers) {	3162	for (Event::all_watchers) {
2401	$_->cancel if $_->data & WF_AUTOCANCEL;	3163	$_->cancel if $_->data & WF_AUTOCANCEL;
2402	}	3164	}
2403		3165
2404	warn "flushing outstanding aio requests";	3166	warn "flushing outstanding aio requests";
2405	for (;;) {	3167	for (;;) {
		3168	BDB::flush;
2406	IO::AIO::flush;	3169	IO::AIO::flush;
2407	Coro::cede;	3170	Coro::cede;
2408	last unless IO::AIO::nreqs;	3171	last unless IO::AIO::nreqs || BDB::nreqs;
2409	warn "iterate...";	3172	warn "iterate...";
2410	}	3173	}
		3174
		3175	++$RELOAD;
2411		3176
2412	warn "cancelling all extension coros";	3177	warn "cancelling all extension coros";
2413	$_->cancel for values %EXT_CORO;	3178	$_->cancel for values %EXT_CORO;
2414	%EXT_CORO = ();	3179	%EXT_CORO = ();
2415		3180
2416	warn "removing commands";	3181	warn "removing commands";
2417	%COMMAND = ();	3182	%COMMAND = ();
2418		3183
2419	warn "removing ext commands";	3184	warn "removing ext/exti commands";
2420	%EXTCMD = ();	3185	%EXTCMD = ();
		3186	%EXTICMD = ();
2421		3187
2422	warn "unloading/nuking all extensions";	3188	warn "unloading/nuking all extensions";
2423	for my $pkg (@EXTS) {	3189	for my $pkg (@EXTS) {
2424	warn "... unloading $pkg";	3190	warn "... unloading $pkg";
2425		3191
…		…
2455	Symbol::delete_package "safe::$_"	3221	Symbol::delete_package "safe::$_"
2456	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3222	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2457		3223
2458	warn "unloading cf.pm \"a bit\"";	3224	warn "unloading cf.pm \"a bit\"";
2459	delete $INC{"cf.pm"};	3225	delete $INC{"cf.pm"};
		3226	delete $INC{"cf/pod.pm"};
2460		3227
2461	# don't, removes xs symbols, too,	3228	# don't, removes xs symbols, too,
2462	# and global variables created in xs	3229	# and global variables created in xs
2463	#Symbol::delete_package __PACKAGE__;	3230	#Symbol::delete_package __PACKAGE__;
2464		3231
…		…
2467	warn "reloading cf.pm";	3234	warn "reloading cf.pm";
2468	require cf;	3235	require cf;
2469	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3236	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2470		3237
2471	warn "loading config and database again";	3238	warn "loading config and database again";
2472	cf::cfg_load;	3239	cf::reload_config;
2473	cf::db_load;
2474		3240
2475	warn "loading extensions";	3241	warn "loading extensions";
2476	cf::load_extensions;	3242	cf::load_extensions;
2477		3243
2478	warn "reattaching attachments to objects/players";	3244	warn "reattaching attachments to objects/players";
2479	_global_reattach;	3245	_global_reattach; # objects, sockets
2480	warn "reattaching attachments to maps";	3246	warn "reattaching attachments to maps";
2481	reattach $_ for values %MAP;	3247	reattach $_ for values %MAP;
		3248	warn "reattaching attachments to players";
		3249	reattach $_ for values %PLAYER;
2482		3250
2483	warn "loading reloadable resources";	3251	warn "leaving sync_job";
2484	load_resources;
2485		3252
2486	warn "restarting server ticker";	3253	1
2487		3254	} or do {
2488	$TICK_WATCHER->start;
2489	};
2490
2491	if ($@) {
2492	warn $@;	3255	warn $@;
2493	warn "error while reloading, exiting.";	3256	warn "error while reloading, exiting.";
2494	exit 1;	3257	exit 1;
2495	}	3258	};
2496		3259
2497	warn "reloaded";	3260	warn "reloaded";
2498	};	3261	};
2499		3262
2500	our $RELOAD_WATCHER; # used only during reload	3263	our $RELOAD_WATCHER; # used only during reload
2501		3264
		3265	sub reload_perl() {
		3266	# doing reload synchronously and two reloads happen back-to-back,
		3267	# coro crashes during coro_state_free->destroy here.
		3268
		3269	$RELOAD_WATCHER ||= Event->timer (
		3270	reentrant => 0,
		3271	after => 0,
		3272	data => WF_AUTOCANCEL,
		3273	cb => sub {
		3274	do_reload_perl;
		3275	undef $RELOAD_WATCHER;
		3276	},
		3277	);
		3278	}
		3279
2502	register_command "reload" => sub {	3280	register_command "reload" => sub {
2503	my ($who, $arg) = @_;	3281	my ($who, $arg) = @_;
2504		3282
2505	if ($who->flag (FLAG_WIZ)) {	3283	if ($who->flag (FLAG_WIZ)) {
2506	$who->message ("reloading server.");	3284	$who->message ("reloading server.");
2507		3285	async { reload_perl };
2508	# doing reload synchronously and two reloads happen back-to-back,
2509	# coro crashes during coro_state_free->destroy here.
2510
2511	$RELOAD_WATCHER ||= Event->timer (
2512	reentrant => 0,
2513	after => 0,
2514	data => WF_AUTOCANCEL,
2515	cb => sub {
2516	reload;
2517	undef $RELOAD_WATCHER;
2518	},
2519	);
2520	}	3286	}
2521	};	3287	};
2522		3288
2523	unshift @INC, $LIBDIR;	3289	unshift @INC, $LIBDIR;
2524		3290
2525	my $bug_warning = 0;	3291	my $bug_warning = 0;
2526		3292
		3293	our @WAIT_FOR_TICK;
		3294	our @WAIT_FOR_TICK_BEGIN;
		3295
		3296	sub wait_for_tick {
		3297	return unless $TICK_WATCHER->is_active;
		3298	return if $Coro::current == $Coro::main;
		3299
		3300	my $signal = new Coro::Signal;
		3301	push @WAIT_FOR_TICK, $signal;
		3302	$signal->wait;
		3303	}
		3304
		3305	sub wait_for_tick_begin {
		3306	return unless $TICK_WATCHER->is_active;
		3307	return if $Coro::current == $Coro::main;
		3308
		3309	my $signal = new Coro::Signal;
		3310	push @WAIT_FOR_TICK_BEGIN, $signal;
		3311	$signal->wait;
		3312	}
		3313
		3314	my $min = 1e6;#d#
		3315	my $avg = 10;
2527	$TICK_WATCHER = Event->timer (	3316	$TICK_WATCHER = Event->timer (
2528	reentrant => 0,	3317	reentrant => 0,
2529	parked => 1,	3318	parked => 1,
2530	prio => 0,	3319	prio => 0,
2531	at => $NEXT_TICK || $TICK,	3320	at => $NEXT_TICK || $TICK,
…		…
2535	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3324	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2536	unless ++$bug_warning > 10;	3325	unless ++$bug_warning > 10;
2537	return;	3326	return;
2538	}	3327	}
2539		3328
2540	$NOW = Event::time;	3329	$NOW = $tick_start = Event::time;
2541		3330
2542	cf::server_tick; # one server iteration	3331	cf::server_tick; # one server iteration
		3332
		3333	0 && sync_job {#d#
		3334	for(1..10) {
		3335	my $t = Event::time;
		3336	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3337	or die;
		3338
		3339	$map->width (50);
		3340	$map->height (50);
		3341	$map->alloc;
		3342	$map->_load_objects ("/tmp/x.map", 1);
		3343	my $t = Event::time - $t;
		3344
		3345	#next unless $t < 0.0013;#d#
		3346	if ($t < $min) {
		3347	$min = $t;
		3348	}
		3349	$avg = $avg * 0.99 + $t * 0.01;
		3350	}
		3351	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3352	exit 0;
		3353	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3354	};
		3355
2543	$RUNTIME += $TICK;	3356	$RUNTIME += $TICK;
2544	$NEXT_TICK += $TICK;	3357	$NEXT_TICK += $TICK;
2545		3358
2546	$WAIT_FOR_TICK->broadcast;	3359	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2547	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3360	$NEXT_RUNTIME_WRITE = $NOW + 10;
2548		3361	Coro::async_pool {
2549	Event::sweep;	3362	write_runtime
2550	Coro::cede_notself;	3363	or warn "ERROR: unable to write runtime file: $!";
		3364	};
2551		3365	}
		3366
2552	# my $AFTER = Event::time;	3367	# my $AFTER = Event::time;
2553	# warn $AFTER - $NOW;#d#	3368	# warn $AFTER - $NOW;#d#
2554		3369
		3370	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3371	$sig->send;
		3372	}
		3373	while (my $sig = shift @WAIT_FOR_TICK) {
		3374	$sig->send;
		3375	}
		3376
		3377	$NOW = Event::time;
		3378
2555	# if we are delayed by four ticks or more, skip them all	3379	# if we are delayed by four ticks or more, skip them all
2556	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3380	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2557		3381
2558	$TICK_WATCHER->at ($NEXT_TICK);	3382	$TICK_WATCHER->at ($NEXT_TICK);
2559	$TICK_WATCHER->start;	3383	$TICK_WATCHER->start;
		3384
		3385	$LOAD = ($NOW - $tick_start) / $TICK;
		3386	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3387
		3388	_post_tick;
		3389
		3390
2560	},	3391	},
2561	);	3392	);
2562		3393
2563	{	3394	{
2564	BDB::max_poll_time $TICK * 0.1;	3395	BDB::max_poll_time $TICK * 0.1;
…		…
2589		3420
2590	unless ($DB_ENV) {	3421	unless ($DB_ENV) {
2591	$DB_ENV = BDB::db_env_create;	3422	$DB_ENV = BDB::db_env_create;
2592		3423
2593	cf::sync_job {	3424	cf::sync_job {
		3425	eval {
2594	BDB::db_env_open	3426	BDB::db_env_open
2595	$DB_ENV,	3427	$DB_ENV,
2596	$BDB_ENV_DIR,	3428	$BDBDIR,
2597	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3429	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2598	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3430	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2599	0666;	3431	0666;
2600		3432
2601	cf::cleanup "$!" if $!;	3433	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2602		3434
2603	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3435	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3436	$DB_ENV->set_lk_detect;
		3437	};
		3438
		3439	cf::cleanup "db_env_open(db): $@" if $@;
2604	};	3440	};
2605	}	3441	}
2606	}	3442	}
2607		3443
2608	{	3444	{
…		…
2610		3446
2611	undef $Coro::AIO::WATCHER;	3447	undef $Coro::AIO::WATCHER;
2612	IO::AIO::max_poll_time $TICK * 0.1;	3448	IO::AIO::max_poll_time $TICK * 0.1;
2613	$AIO_POLL_WATCHER = Event->io (	3449	$AIO_POLL_WATCHER = Event->io (
2614	reentrant => 0,	3450	reentrant => 0,
		3451	data => WF_AUTOCANCEL,
2615	fd => IO::AIO::poll_fileno,	3452	fd => IO::AIO::poll_fileno,
2616	poll => 'r',	3453	poll => 'r',
2617	prio => 6,	3454	prio => 6,
2618	data => WF_AUTOCANCEL,
2619	cb => \&IO::AIO::poll_cb,	3455	cb => \&IO::AIO::poll_cb,
2620	);	3456	);
2621	}	3457	}
2622		3458
2623	$WRITE_RUNTIME_WATCHER = Event->timer (	3459	my $_log_backtrace;
2624	reentrant => 0,	3460
2625	data => WF_AUTOCANCEL,	3461	sub _log_backtrace {
2626	after => 1,	3462	my ($msg, @addr) = @_;
2627	interval => 10,	3463
2628	prio => 6, # keep it lowest so it acts like a watchdog	3464	$msg =~ s/\n//;
2629	cb => Coro::unblock_sub {	3465
2630	write_runtime	3466	# limit the # of concurrent backtraces
2631	or warn "ERROR: unable to write runtime file: $!";	3467	if ($_log_backtrace < 2) {
		3468	++$_log_backtrace;
		3469	async {
		3470	my @bt = fork_call {
		3471	@addr = map { sprintf "%x", $_ } @addr;
		3472	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3473	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3474	or die "addr2line: $!";
		3475
		3476	my @funcs;
		3477	my @res = <$fh>;
		3478	chomp for @res;
		3479	while (@res) {
		3480	my ($func, $line) = splice @res, 0, 2, ();
		3481	push @funcs, "[$func] $line";
		3482	}
		3483
		3484	@funcs
		3485	};
		3486
		3487	LOG llevInfo, "[ABT] $msg\n";
		3488	LOG llevInfo, "[ABT] $_\n" for @bt;
		3489	--$_log_backtrace;
		3490	};
		3491	} else {
		3492	LOG llevInfo, "[ABT] $msg\n";
		3493	LOG llevInfo, "[ABT] [suppressed]\n";
2632	},	3494	}
2633	);	3495	}
		3496
		3497	# load additional modules
		3498	use cf::pod;
2634		3499
2635	END { cf::emergency_save }	3500	END { cf::emergency_save }
2636		3501
2637	1	3502	1
2638		3503

Diff Legend

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