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.210 by root, Mon Feb 12 01:32:49 2007 UTC vs.
Revision 1.353 by root, Sun Sep 2 08:43:46 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;
27	use Compress::LZF;	34	use Compress::LZF;
		35	use Digest::MD5 ();
28		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
29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	41	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		42
31	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
32
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		44
35	# 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?
36	$YAML::Syck::ImplicitUnicode = 1;	46	$YAML::Syck::ImplicitUnicode = 1;
37		47
38	$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
39		49
		50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		51
40	our %COMMAND = ();	52	our %COMMAND = ();
41	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
42		54
43	our @EXTS = (); # list of extension package names	55	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	58	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	59	our %EXT_MAP = (); # pluggable maps
47		60
		61	our $RELOAD; # number of reloads so far
48	our @EVENT;	62	our @EVENT;
49	our $LIBDIR = datadir . "/ext";
50		63
51	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(!)
52	our $TICK_WATCHER;	77	our $TICK_WATCHER;
53	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
54	our $WRITE_RUNTIME_WATCHER;	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55	our $NEXT_TICK;	80	our $NEXT_TICK;
56	our $NOW;	81	our $NOW;
57	our $USE_FSYNC = 1; # use fsync to write maps - default off	82	our $USE_FSYNC = 1; # use fsync to write maps - default off
58		83
59	our $BDB_POLL_WATCHER;	84	our $BDB_POLL_WATCHER;
…		…
65	our $RUNTIME;	90	our $RUNTIME;
66		91
67	our %PLAYER; # all users	92	our %PLAYER; # all users
68	our %MAP; # all maps	93	our %MAP; # all maps
69	our $LINK_MAP; # the special {link} map, which is always available	94	our $LINK_MAP; # the special {link} map, which is always available
70	our $RANDOM_MAPS = cf::localdir . "/random";
71	our $BDB_ENV_DIR = cf::localdir . "/db";
72
73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75		95
76	# 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 ∕
77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78		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
79	binmode STDOUT;	103	binmode STDOUT;
80	binmode STDERR;	104	binmode STDERR;
81		105
82	# read virtual server time, if available	106	# read virtual server time, if available
83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
85	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
86	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
87	}	111	}
88		112
89	mkdir cf::localdir;	113	mkdir $_
90	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91	mkdir cf::localdir . "/" . cf::tmpdir;
92	mkdir cf::localdir . "/" . cf::uniquedir;
93	mkdir $RANDOM_MAPS;
94	mkdir $BDB_ENV_DIR;
95		115
96	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
97		117
98	sub cf::map::normalise;	118	sub cf::map::normalise;
99		119
…		…
110	=item $cf::RUNTIME	130	=item $cf::RUNTIME
111		131
112	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
113	every server tick.	133	every server tick.
114		134
115	=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
116		138
117	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
118	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.
119		143
120	=item $cf::NOW	144	=item $cf::NOW
121		145
122	The time of the last (current) server tick.	146	The time of the last (current) server tick.
123		147
124	=item $cf::TICK	148	=item $cf::TICK
125		149
126	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.
127		161
128	=item %cf::CFG	162	=item %cf::CFG
129		163
130	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
131	from wherever your confdir points to.	165	from wherever your confdir points to.
132		166
133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
134		168
135	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
136	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
137	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.
138	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.
139		178
140	=back	179	=back
141		180
142	=cut	181	=cut
143		182
144	BEGIN {	183	BEGIN {
145	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
146	my $msg = join "", @_;	185	my $msg = join "", @_;
147	utf8::encode $msg;
148		186
149	$msg .= "\n"	187	$msg .= "\n"
150	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
151		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
152	LOG llevError, $msg;	193	LOG llevError, $msg;
153	};	194	};
154	}	195	}
155		196
156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160	@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';
161	@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)
162		204
163	# 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
164	# within the Safe compartment.	206	# within the Safe compartment.
165	for my $pkg (qw(	207	for my $pkg (qw(
166	cf::global cf::attachable	208	cf::global cf::attachable
…		…
174	}	216	}
175		217
176	$Event::DIED = sub {	218	$Event::DIED = sub {
177	warn "error in event callback: @_";	219	warn "error in event callback: @_";
178	};	220	};
		221
		222	#############################################################################
179		223
180	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
181		225
182	=over 4	226	=over 4
183		227
…		…
202	$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;
203	$d	247	$d
204	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
205	}	249	}
206		250
207	use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
210		252
211	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
212		254
213	=cut
214
215	sub from_json($) {
216	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217	JSON::Syck::Load $_[0]
218	}
219
220	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
221		256
222	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
223		258
224	=cut	259	=cut
225		260
226	sub to_json($) {	261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	262
228	JSON::Syck::Dump $_[0]	263	sub to_json ($) { $json_coder->encode ($_[0]) }
229	}	264	sub from_json ($) { $json_coder->decode ($_[0]) }
230		265
231	=item cf::lock_wait $string	266	=item cf::lock_wait $string
232		267
233	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
234		269
…		…
237	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
238	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,
239	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
240	returned.	275	returned.
241		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
		279
242	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
243	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.
244		286
245	=cut	287	=cut
246		288
247	our %LOCK;	289	our %LOCK;
248		290
…		…
268	# wake up all waiters, to be on the safe side	310	# wake up all waiters, to be on the safe side
269	$_->ready for @{ delete $LOCK{$key} };	311	$_->ready for @{ delete $LOCK{$key} };
270	}	312	}
271	}	313	}
272		314
		315	sub lock_active($) {
		316	my ($key) = @_;
		317
		318	! ! $LOCK{$key}
		319	}
		320
273	sub freeze_mainloop {	321	sub freeze_mainloop {
274	return unless $TICK_WATCHER->is_active;	322	return unless $TICK_WATCHER->is_active;
275		323
276	my $guard = Coro::guard {	324	my $guard = Coro::guard {
277	$TICK_WATCHER->start;	325	$TICK_WATCHER->start;
278	$WRITE_RUNTIME_WATCHER->start;
279	};	326	};
280	$WRITE_RUNTIME_WATCHER->stop;
281	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
282	$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;
283	}	385	}
284		386
285	=item cf::async { BLOCK }	387	=item cf::async { BLOCK }
286		388
287	Currently the same as Coro::async_pool, meaning you cannot use	389	Currently the same as Coro::async_pool, meaning you cannot use
…		…
292		394
293	BEGIN { *async = \&Coro::async_pool }	395	BEGIN { *async = \&Coro::async_pool }
294		396
295	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
296		398
297	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)
298	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
299	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.
300		403
301	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
302	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
303	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
304	fast or be very important.	407	fast or be very important.
…		…
307		410
308	sub sync_job(&) {	411	sub sync_job(&) {
309	my ($job) = @_;	412	my ($job) = @_;
310		413
311	if ($Coro::current == $Coro::main) {	414	if ($Coro::current == $Coro::main) {
		415	my $time = Event::time;
		416
312	# this is the main coro, too bad, we have to block	417	# this is the main coro, too bad, we have to block
313	# till the operation succeeds, freezing the server :/	418	# till the operation succeeds, freezing the server :/
314		419
315	# TODO: use suspend/resume instead	420	# TODO: use suspend/resume instead
316	# (but this is cancel-safe)	421	# (but this is cancel-safe)
…		…
327		432
328	while ($busy) {	433	while ($busy) {
329	Coro::cede or Event::one_event;	434	Coro::cede or Event::one_event;
330	}	435	}
331		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
332	wantarray ? @res : $res[0]	444	wantarray ? @res : $res[0]
333	} else {	445	} else {
334	# we are in another coroutine, how wonderful, everything just works	446	# we are in another coroutine, how wonderful, everything just works
335		447
336	$job->()	448	$job->()
…		…
355	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
356		468
357	$coro	469	$coro
358	}	470	}
359		471
360	sub write_runtime {	472	=item fork_call { }, $args
361	my $runtime = cf::localdir . "/runtime";
362		473
363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	474	Executes the given code block with the given arguments in a seperate
364	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.
365		478
366	my $value = $cf::RUNTIME + 90 + 10;	479	=cut
367	# 10 is the runtime save interval, for a monotonic clock
368	# 60 allows for the watchdog to kill the server.
369		480
370	(aio_write $fh, 0, (length $value), $value, 0) <= 0	481	sub fork_call(&@) {
371	and return;	482	my ($cb, @args) = @_;
372		483
373	# always fsync - this file is important	484	# we seemingly have to make a local copy of the whole thing,
374	aio_fsync $fh	485	# otherwise perl prematurely frees the stuff :/
375	and return;	486	# TODO: investigate and fix (liekly this will be rather laborious)
376		487
377	close $fh	488	my @res = Coro::Util::fork_eval {
378	or return;	489	reset_signals;
		490	&$cb
		491	}, @args;
379		492
380	aio_rename "$runtime~", $runtime	493	wantarray ? @res : $res[-1]
381	and return;	494	}
382		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	};
383	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 });
384	}	621	}
385		622
386	=back	623	=back
387		624
388	=cut	625	=cut
…		…
395	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")
396	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
397		634
398	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>
399	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
400	crossfire+).	637	Crossfire TRT).
401		638
402	=over 4	639	=over 4
403		640
404	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
405		642
…		…
568	$registry = $CB_TYPE[$object_type] ||= [];	805	$registry = $CB_TYPE[$object_type] ||= [];
569		806
570	} elsif ($type eq "subtype") {	807	} elsif ($type eq "subtype") {
571	defined $object_type or Carp::croak "subtype specified without type";	808	defined $object_type or Carp::croak "subtype specified without type";
572	my $object_subtype = shift @arg;	809	my $object_subtype = shift @arg;
573	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	810	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574		811
575	} elsif ($type eq "package") {	812	} elsif ($type eq "package") {
576	my $pkg = shift @arg;	813	my $pkg = shift @arg;
577		814
578	while (my ($name, $id) = each %cb_id) {	815	while (my ($name, $id) = each %cb_id) {
…		…
607	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
608	}	845	}
609		846
610	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
611	} else {	848	} else {
612	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
613	}	850	}
614		851
615	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
616	}	853	}
617		854
…		…
619	if (ref $_[0]) {	856	if (ref $_[0]) {
620	_object_attach @_;	857	_object_attach @_;
621	} else {	858	} else {
622	_attach shift->_attach_registry, @_;	859	_attach shift->_attach_registry, @_;
623	}	860	}
		861	_recalc_want;
624	};	862	};
625		863
626	# all those should be optimised	864	# all those should be optimised
627	sub cf::attachable::detach {	865	sub cf::attachable::detach {
628	my ($obj, $name) = @_;	866	my ($obj, $name) = @_;
…		…
631	delete $obj->{_attachment}{$name};	869	delete $obj->{_attachment}{$name};
632	reattach ($obj);	870	reattach ($obj);
633	} else {	871	} else {
634	Carp::croak "cannot, currently, detach class attachments";	872	Carp::croak "cannot, currently, detach class attachments";
635	}	873	}
		874	_recalc_want;
636	};	875	};
637		876
638	sub cf::attachable::attached {	877	sub cf::attachable::attached {
639	my ($obj, $name) = @_;	878	my ($obj, $name) = @_;
640		879
…		…
655	";	894	";
656	die if $@;	895	die if $@;
657	}	896	}
658		897
659	our $override;	898	our $override;
660	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?
661		900
662	sub override {	901	sub override {
663	$override = 1;	902	$override = 1;
664	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
665	}	904	}
666		905
667	sub do_invoke {	906	sub do_invoke {
668	my $event = shift;	907	my $event = shift;
669	my $callbacks = shift;	908	my $callbacks = shift;
670		909
671	@invoke_results = ();	910	@INVOKE_RESULTS = ();
672		911
673	local $override;	912	local $override;
674		913
675	for (@$callbacks) {	914	for (@$callbacks) {
676	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
693		932
694	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
695		934
696	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
697	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
698	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
699		938
700	=back	939	=back
701		940
702	=cut	941	=cut
703		942
704	#############################################################################	943	#############################################################################
705	# 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	}
706		956
707	sub reattach {	957	sub reattach {
708	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
709	my ($obj) = @_;	959	my ($obj) = @_;
710		960
…		…
787	}	1037	}
788	} else {	1038	} else {
789	aio_unlink $filename;	1039	aio_unlink $filename;
790	aio_unlink "$filename.pst";	1040	aio_unlink "$filename.pst";
791	}	1041	}
792
793	#d##TODO# nuke non .map-files if exist
794	if ($filename =~ s/\.map$//) {
795	aio_unlink $filename;
796	aio_unlink "$filename.pst";
797	}
798	}	1042	}
799	}	1043	}
800		1044
801	sub object_freezer_as_string {	1045	sub object_freezer_as_string {
802	my ($rdata, $objs) = @_;	1046	my ($rdata, $objs) = @_;
…		…
808		1052
809	sub object_thawer_load {	1053	sub object_thawer_load {
810	my ($filename) = @_;	1054	my ($filename) = @_;
811		1055
812	my ($data, $av);	1056	my ($data, $av);
813
814	#d#TODO remove .map if file does not exist
815	aio_stat $filename and $filename =~ s/\.map$//;
816		1057
817	(aio_load $filename, $data) >= 0	1058	(aio_load $filename, $data) >= 0
818	or return;	1059	or return;
819		1060
820	unless (aio_stat "$filename.pst") {	1061	unless (aio_stat "$filename.pst") {
…		…
822	or return;	1063	or return;
823	$av = eval { (Storable::thaw $av)->{objs} };	1064	$av = eval { (Storable::thaw $av)->{objs} };
824	}	1065	}
825		1066
826	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
827	$filename, length $data, scalar @{$av || []};#d#	1068	$filename, length $data, scalar @{$av || []};
828	return ($data, $av);	1069	return ($data, $av);
829	}	1070	}
		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
830		1077
831	#############################################################################	1078	#############################################################################
832	# command handling &c	1079	# command handling &c
833		1080
834	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
…		…
847	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
848	}	1095	}
849		1096
850	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
851		1098
852	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.
853		1104
854	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
855	called.	1106	called.
856		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
857	=cut	1119	=cut
858		1120
859	sub register_extcmd {	1121	sub register_extcmd {
860	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
861		1123
862	$EXTCMD{$name} = $cb;	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
863	}	1131	}
864		1132
865	cf::player->attach (	1133	cf::player->attach (
866	on_command => sub {	1134	on_command => sub {
867	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
876	cf::override;	1144	cf::override;
877	},	1145	},
878	on_extcmd => sub {	1146	on_extcmd => sub {
879	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
880		1148
881	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
882		1150
883	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
884	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
885	if (my %reply = $cb->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
886	$pl->ext_reply ($msg->{msgid}, %reply);
887	}
888	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
889	} else {	1166	} else {
890	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
891	}	1168	}
892		1169
893	cf::override;	1170	cf::override;
894	},	1171	},
895	);	1172	);
896		1173
897	sub load_extension {
898	my ($path) = @_;
899
900	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
901	my $base = $1;
902	my $pkg = $1;
903	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "ext::$pkg";
905
906	warn "... loading '$path' into '$pkg'\n";
907
908	open my $fh, "<:utf8", $path
909	or die "$path: $!";
910
911	my $source =
912	"package $pkg; use strict; use utf8;\n"
913	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })
915	. "\n};\n1";
916
917	unless (eval $source) {
918	my $msg = $@ ? "$path: $@\n"
919	: "extension disabled.\n";
920	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
921	warn $@;
922	warn "mandatory extension failed to load, exiting.\n";
923	exit 1;
924	}
925	die $@;
926	}
927
928	push @EXTS, $pkg;
929	}
930
931	sub load_extensions {	1174	sub load_extensions {
		1175	cf::sync_job {
		1176	my %todo;
		1177
932	for my $ext (<$LIBDIR/*.ext>) {	1178	for my $path (<$LIBDIR/*.ext>) {
933	next unless -r $ext;	1179	next unless -r $path;
934	eval {	1180
935	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;
936	1	1238	}
937	} or warn "$ext not loaded: $@";	1239
		1240	skip:
		1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1242	unless $progress;
		1243	}
938	}	1244	};
939	}	1245	}
940		1246
941	#############################################################################	1247	#############################################################################
942		1248
		1249	=back
		1250
943	=head2 CORE EXTENSIONS	1251	=head2 CORE EXTENSIONS
944		1252
945	Functions and methods that extend core crossfire objects.	1253	Functions and methods that extend core crossfire objects.
946		1254
947	=cut	1255	=cut
…		…
959	Returns the given player object, loading it if necessary (might block).	1267	Returns the given player object, loading it if necessary (might block).
960		1268
961	=cut	1269	=cut
962		1270
963	sub playerdir($) {	1271	sub playerdir($) {
964	cf::localdir	1272	"$PLAYERDIR/"
965	. "/"
966	. cf::playerdir
967	. "/"
968	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1273	. (ref $_[0] ? $_[0]->ob->name : $_[0])
969	}	1274	}
970		1275
971	sub path($) {	1276	sub path($) {
972	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1277	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
973		1278
974	(playerdir $login) . "/$login.pl"	1279	(playerdir $login) . "/playerdata"
975	}	1280	}
976		1281
977	sub find_active($) {	1282	sub find_active($) {
978	$cf::PLAYER{$_[0]}	1283	$cf::PLAYER{$_[0]}
979	and $cf::PLAYER{$_[0]}->active	1284	and $cf::PLAYER{$_[0]}->active
…		…
992	my $login = $_[0];	1297	my $login = $_[0];
993		1298
994	my $guard = cf::lock_acquire "user_find:$login";	1299	my $guard = cf::lock_acquire "user_find:$login";
995		1300
996	$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
997	my $pl = load_pl path $login	1309	my $pl = load_pl path $login
998	or return;	1310	or return;
999	$cf::PLAYER{$login} = $pl	1311	$cf::PLAYER{$login} = $pl
1000	}	1312	}
1001	}	1313	}
…		…
1013		1325
1014	aio_mkdir playerdir $pl, 0770;	1326	aio_mkdir playerdir $pl, 0770;
1015	$pl->{last_save} = $cf::RUNTIME;	1327	$pl->{last_save} = $cf::RUNTIME;
1016		1328
1017	$pl->save_pl ($path);	1329	$pl->save_pl ($path);
1018	Coro::cede;	1330	cf::cede_to_tick;
1019	}	1331	}
1020		1332
1021	sub new($) {	1333	sub new($) {
1022	my ($login) = @_;	1334	my ($login) = @_;
1023		1335
…		…
1029	$cf::PLAYER{$login} = $self;	1341	$cf::PLAYER{$login} = $self;
1030		1342
1031	$self	1343	$self
1032	}	1344	}
1033		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
1034	=item $pl->quit_character	1356	=item $pl->quit_character
1035		1357
1036	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
1037	be destroyed. May block for a long time.	1359	be destroyed. May block for a long time.
1038		1360
1039	=cut	1361	=cut
1040		1362
1041	sub quit_character {	1363	sub quit_character {
1042	my ($pl) = @_;	1364	my ($pl) = @_;
		1365
		1366	my $name = $pl->ob->name;
1043		1367
1044	$pl->{deny_save} = 1;	1368	$pl->{deny_save} = 1;
1045	$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
1046		1370
1047	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1371	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1052	my $path = playerdir $pl;	1376	my $path = playerdir $pl;
1053	my $temp = "$path~$cf::RUNTIME~deleting~";	1377	my $temp = "$path~$cf::RUNTIME~deleting~";
1054	aio_rename $path, $temp;	1378	aio_rename $path, $temp;
1055	delete $cf::PLAYER{$pl->ob->name};	1379	delete $cf::PLAYER{$pl->ob->name};
1056	$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
1057	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;
1058	}	1402	}
1059		1403
1060	=item cf::player::list_logins	1404	=item cf::player::list_logins
1061		1405
1062	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
1063	while and may block, so not sync_job-capable, ever.	1407	while and may block, so not sync_job-capable, ever.
1064		1408
1065	=cut	1409	=cut
1066		1410
1067	sub list_logins {	1411	sub list_logins {
1068	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1412	my $dirs = aio_readdir $PLAYERDIR
1069	or return [];	1413	or return [];
1070		1414
1071	my @logins;	1415	my @logins;
1072		1416
1073	for my $login (@$dirs) {	1417	for my $login (@$dirs) {
…		…
1108	}	1452	}
1109		1453
1110	\@paths	1454	\@paths
1111	}	1455	}
1112		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/(?<![BIUGHT])</&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	|| s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
		1478	# replace G<male|female> tags
		1479	|| s{G<([^>|]*)\|([^>]*)>}{
		1480	$self->gender ? $2 : $1
		1481	}ge
		1482	# replace H<hint text>
		1483	|| s{H<([^\>]*)>}
		1484	{
		1485	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1486	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1487	"")
		1488	[$self->{hintmode}]
		1489	}ge;
		1490
		1491	# create single paragraphs (very hackish)
		1492	s/(?<=\S)\n(?=\w)/ /g;
		1493
		1494	# compress some whitespace
		1495	s/\s+\n/\n/g; # ws line-ends
		1496	s/\n\n+/\n/g; # double lines
		1497	s/^\n+//; # beginning lines
		1498	s/\n+$//; # ending lines
		1499
		1500	$_
		1501	}
		1502
		1503	sub hintmode {
		1504	$_[0]{hintmode} = $_[1] if @_ > 1;
		1505	$_[0]{hintmode}
		1506	}
		1507
1113	=item $player->ext_reply ($msgid, $msgtype, %msg)	1508	=item $player->ext_reply ($msgid, @msg)
1114		1509
1115	Sends an ext reply to the player.	1510	Sends an ext reply to the player.
1116		1511
1117	=cut	1512	=cut
1118		1513
1119	sub ext_reply($$$%) {	1514	sub ext_reply($$@) {
1120	my ($self, $id, %msg) = @_;	1515	my ($self, $id, @msg) = @_;
1121		1516
1122	$msg{msgid} = $id;	1517	$self->ns->ext_reply ($id, @msg)
1123
1124	$self->send ("ext " . cf::to_json \%msg);
1125	}	1518	}
1126		1519
1127	package cf;	1520	=item $player->ext_msg ($type, @msg)
		1521
		1522	Sends an ext event to the client.
		1523
		1524	=cut
		1525
		1526	sub ext_msg($$@) {
		1527	my ($self, $type, @msg) = @_;
		1528
		1529	$self->ns->ext_msg ($type, @msg);
		1530	}
		1531
		1532	=head3 cf::region
		1533
		1534	=over 4
		1535
		1536	=cut
		1537
		1538	package cf::region;
		1539
		1540	=item cf::region::find_by_path $path
		1541
		1542	Tries to decuce the likely region for a map knowing only its path.
		1543
		1544	=cut
		1545
		1546	sub find_by_path($) {
		1547	my ($path) = @_;
		1548
		1549	my ($match, $specificity);
		1550
		1551	for my $region (list) {
		1552	if ($region->{match} && $path =~ $region->{match}) {
		1553	($match, $specificity) = ($region, $region->specificity)
		1554	if $region->specificity > $specificity;
		1555	}
		1556	}
		1557
		1558	$match
		1559	}
1128		1560
1129	=back	1561	=back
1130
1131		1562
1132	=head3 cf::map	1563	=head3 cf::map
1133		1564
1134	=over 4	1565	=over 4
1135		1566
…		…
1190	my ($self, $merge) = @_;	1621	my ($self, $merge) = @_;
1191		1622
1192	# we have to keep some variables in memory intact	1623	# we have to keep some variables in memory intact
1193	local $self->{path};	1624	local $self->{path};
1194	local $self->{load_path};	1625	local $self->{load_path};
1195	local $self->{deny_save};
1196	local $self->{deny_reset};
1197		1626
1198	$self->SUPER::thawer_merge ($merge);	1627	$self->SUPER::thawer_merge ($merge);
1199	}	1628	}
1200		1629
1201	sub normalise {	1630	sub normalise {
…		…
1248	$self->init; # pass $1 etc.	1677	$self->init; # pass $1 etc.
1249	return $self;	1678	return $self;
1250	}	1679	}
1251	}	1680	}
1252		1681
1253	Carp::carp "unable to resolve path '$path' (base '$base').";	1682	Carp::cluck "unable to resolve path '$path' (base '$base').";
1254	()	1683	()
1255	}	1684	}
1256		1685
1257	sub init {	1686	sub init {
1258	my ($self) = @_;	1687	my ($self) = @_;
…		…
1273		1702
1274	# the original (read-only) location	1703	# the original (read-only) location
1275	sub load_path {	1704	sub load_path {
1276	my ($self) = @_;	1705	my ($self) = @_;
1277		1706
1278	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1707	"$MAPDIR/$self->{path}.map"
1279	}	1708	}
1280		1709
1281	# the temporary/swap location	1710	# the temporary/swap location
1282	sub save_path {	1711	sub save_path {
1283	my ($self) = @_;	1712	my ($self) = @_;
1284		1713
1285	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1714	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1286	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1715	"$TMPDIR/$path.map"
1287	}	1716	}
1288		1717
1289	# the unique path, undef == no special unique path	1718	# the unique path, undef == no special unique path
1290	sub uniq_path {	1719	sub uniq_path {
1291	my ($self) = @_;	1720	my ($self) = @_;
1292		1721
1293	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1722	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1294	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1723	"$UNIQUEDIR/$path"
1295	}	1724	}
1296		1725
1297	# and all this just because we cannot iterate over	1726	# and all this just because we cannot iterate over
1298	# all maps in C++...	1727	# all maps in C++...
1299	sub change_all_map_light {	1728	sub change_all_map_light {
…		…
1301		1730
1302	$_->change_map_light ($change)	1731	$_->change_map_light ($change)
1303	for grep $_->outdoor, values %cf::MAP;	1732	for grep $_->outdoor, values %cf::MAP;
1304	}	1733	}
1305		1734
		1735	sub decay_objects {
		1736	my ($self) = @_;
		1737
		1738	return if $self->{deny_reset};
		1739
		1740	$self->do_decay_objects;
		1741	}
		1742
1306	sub unlink_save {	1743	sub unlink_save {
1307	my ($self) = @_;	1744	my ($self) = @_;
1308		1745
1309	utf8::encode (my $save = $self->save_path);	1746	utf8::encode (my $save = $self->save_path);
1310	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1747	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1311	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1748	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1312
1313	#d#TODO remove .map and also nuke
1314	$save =~ s/\.map// or return;#d#
1315	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1316	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1317	}	1749	}
1318		1750
1319	sub load_header_from($) {	1751	sub load_header_from($) {
1320	my ($self, $path) = @_;	1752	my ($self, $path) = @_;
1321		1753
…		…
1371	$self->load_header_orig	1803	$self->load_header_orig
1372	or return;	1804	or return;
1373	$self->prepare_orig;	1805	$self->prepare_orig;
1374	}	1806	}
1375		1807
		1808	$self->{deny_reset} = 1
		1809	if $self->no_reset;
		1810
		1811	$self->default_region (cf::region::find_by_path $self->{path})
		1812	unless $self->default_region;
		1813
1376	1	1814	1
1377	}	1815	}
1378		1816
1379	sub find;	1817	sub find;
1380	sub find {	1818	sub find {
…		…
1392	$map->{last_save} = $cf::RUNTIME;	1830	$map->{last_save} = $cf::RUNTIME;
1393		1831
1394	$map->load_header	1832	$map->load_header
1395	or return;	1833	or return;
1396		1834
1397	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1835	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398	# doing this can freeze the server in a sync job, obviously	1836	# doing this can freeze the server in a sync job, obviously
1399	#$cf::WAIT_FOR_TICK->wait;	1837	#$cf::WAIT_FOR_TICK->wait;
1400	$map->reset;	1838	$map->reset;
1401	undef $guard;	1839	undef $guard;
1402	return find $path;	1840	return find $path;
…		…
1413	my ($self) = @_;	1851	my ($self) = @_;
1414		1852
1415	local $self->{deny_reset} = 1; # loading can take a long time	1853	local $self->{deny_reset} = 1; # loading can take a long time
1416		1854
1417	my $path = $self->{path};	1855	my $path = $self->{path};
		1856
		1857	{
		1858	my $guard1 = cf::lock_acquire "map_data:$path";
1418	my $guard = cf::lock_acquire "map_load:$path";	1859	my $guard2 = cf::lock_acquire "map_load:$path";
1419		1860
1420	return if $self->in_memory != cf::MAP_SWAPPED;	1861	return if $self->in_memory != cf::MAP_SWAPPED;
1421		1862
1422	$self->in_memory (cf::MAP_LOADING);	1863	$self->in_memory (cf::MAP_LOADING);
1423		1864
1424	$self->alloc;	1865	$self->alloc;
1425		1866
1426	$self->pre_load;	1867	$self->pre_load;
		1868	cf::cede_to_tick;
1427		1869
1428	$self->_load_objects ($self->{load_path}, 1)	1870	$self->_load_objects ($self->{load_path}, 1)
1429	or return;	1871	or return;
1430		1872
1431	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1873	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432	if delete $self->{load_original};	1874	if delete $self->{load_original};
1433		1875
1434	if (my $uniq = $self->uniq_path) {	1876	if (my $uniq = $self->uniq_path) {
1435	utf8::encode $uniq;	1877	utf8::encode $uniq;
1436	if (aio_open $uniq, O_RDONLY, 0) {	1878	if (aio_open $uniq, O_RDONLY, 0) {
1437	$self->clear_unique_items;	1879	$self->clear_unique_items;
1438	$self->_load_objects ($uniq, 0);	1880	$self->_load_objects ($uniq, 0);
1439	}	1881	}
1440	}	1882	}
1441		1883
1442	Coro::cede;	1884	cf::cede_to_tick;
1443
1444	# now do the right thing for maps	1885	# now do the right thing for maps
1445	$self->link_multipart_objects;	1886	$self->link_multipart_objects;
1446
1447	unless ($self->{deny_activate}) {
1448	$self->decay_objects;
1449	$self->fix_auto_apply;
1450	$self->update_buttons;
1451	Coro::cede;
1452	$self->set_darkness_map;
1453	$self->difficulty ($self->estimate_difficulty)	1887	$self->difficulty ($self->estimate_difficulty)
1454	unless $self->difficulty;	1888	unless $self->difficulty;
1455	Coro::cede;	1889	cf::cede_to_tick;
		1890
		1891	unless ($self->{deny_activate}) {
		1892	$self->decay_objects;
		1893	$self->fix_auto_apply;
		1894	$self->update_buttons;
		1895	cf::cede_to_tick;
		1896	$self->set_darkness_map;
		1897	cf::cede_to_tick;
1456	$self->activate;	1898	$self->activate;
		1899	}
		1900
		1901	$self->{last_save} = $cf::RUNTIME;
		1902	$self->last_access ($cf::RUNTIME);
		1903
		1904	$self->in_memory (cf::MAP_IN_MEMORY);
1457	}	1905	}
1458		1906
1459	$self->post_load;	1907	$self->post_load;
1460
1461	$self->in_memory (cf::MAP_IN_MEMORY);
1462	}	1908	}
1463		1909
1464	sub customise_for {	1910	sub customise_for {
1465	my ($self, $ob) = @_;	1911	my ($self, $ob) = @_;
1466		1912
1467	return find "~" . $ob->name . "/" . $self->{path}	1913	return find "~" . $ob->name . "/" . $self->{path}
1468	if $self->per_player;	1914	if $self->per_player;
1469		1915
		1916	# return find "?party/" . $ob->name . "/" . $self->{path}
		1917	# if $self->per_party;
		1918
1470	$self	1919	$self
1471	}	1920	}
1472		1921
1473	# find and load all maps in the 3x3 area around a map	1922	# find and load all maps in the 3x3 area around a map
1474	sub load_diag {	1923	sub load_neighbours {
1475	my ($map) = @_;	1924	my ($map) = @_;
1476		1925
1477	my @diag; # diagonal neighbours	1926	my @neigh; # diagonal neighbours
1478		1927
1479	for (0 .. 3) {	1928	for (0 .. 3) {
1480	my $neigh = $map->tile_path ($_)	1929	my $neigh = $map->tile_path ($_)
1481	or next;	1930	or next;
1482	$neigh = find $neigh, $map	1931	$neigh = find $neigh, $map
1483	or next;	1932	or next;
1484	$neigh->load;	1933	$neigh->load;
1485		1934
		1935	push @neigh,
1486	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1936	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1487	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1937	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1488	}	1938	}
1489		1939
1490	for (@diag) {	1940	for (grep defined $_->[0], @neigh) {
		1941	my ($path, $origin) = @$_;
1491	my $neigh = find @$_	1942	my $neigh = find $path, $origin
1492	or next;	1943	or next;
1493	$neigh->load;	1944	$neigh->load;
1494	}	1945	}
1495	}	1946	}
1496		1947
…		…
1501	}	1952	}
1502		1953
1503	sub do_load_sync {	1954	sub do_load_sync {
1504	my ($map) = @_;	1955	my ($map) = @_;
1505		1956
		1957	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1958	if $Coro::current == $Coro::main;
		1959
1506	cf::sync_job { $map->load };	1960	cf::sync_job { $map->load };
1507	}	1961	}
1508		1962
1509	our %MAP_PREFETCH;	1963	our %MAP_PREFETCH;
1510	our $MAP_PREFETCHER = undef;	1964	our $MAP_PREFETCHER = undef;
1511		1965
1512	sub find_async {	1966	sub find_async {
1513	my ($path, $origin) = @_;	1967	my ($path, $origin, $load) = @_;
1514		1968
1515	$path = normalise $path, $origin && $origin->{path};	1969	$path = normalise $path, $origin && $origin->{path};
1516		1970
1517	if (my $map = $cf::MAP{$path}) {	1971	if (my $map = $cf::MAP{$path}) {
1518	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1972	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1519	}	1973	}
1520		1974
1521	undef $MAP_PREFETCH{$path};	1975	$MAP_PREFETCH{$path} |= $load;
		1976
1522	$MAP_PREFETCHER ||= cf::async {	1977	$MAP_PREFETCHER ||= cf::async {
1523	while (%MAP_PREFETCH) {	1978	while (%MAP_PREFETCH) {
1524	for my $path (keys %MAP_PREFETCH) {	1979	while (my ($k, $v) = each %MAP_PREFETCH) {
1525	my $map = find $path	1980	if (my $map = find $k) {
1526	or next;
1527	$map->load;	1981	$map->load if $v;
		1982	}
1528		1983
1529	delete $MAP_PREFETCH{$path};	1984	delete $MAP_PREFETCH{$k};
1530	}	1985	}
1531	}	1986	}
1532	undef $MAP_PREFETCHER;	1987	undef $MAP_PREFETCHER;
1533	};	1988	};
1534	$MAP_PREFETCHER->prio (6);	1989	$MAP_PREFETCHER->prio (6);
…		…
1537	}	1992	}
1538		1993
1539	sub save {	1994	sub save {
1540	my ($self) = @_;	1995	my ($self) = @_;
1541		1996
1542	my $lock = cf::lock_acquire "map_data:" . $self->path;	1997	my $lock = cf::lock_acquire "map_data:$self->{path}";
1543		1998
1544	$self->{last_save} = $cf::RUNTIME;	1999	$self->{last_save} = $cf::RUNTIME;
1545		2000
1546	return unless $self->dirty;	2001	return unless $self->dirty;
1547		2002
…		…
1570	my ($self) = @_;	2025	my ($self) = @_;
1571		2026
1572	# save first because save cedes	2027	# save first because save cedes
1573	$self->save;	2028	$self->save;
1574		2029
1575	my $lock = cf::lock_acquire "map_data:" . $self->path;	2030	my $lock = cf::lock_acquire "map_data:$self->{path}";
1576		2031
1577	return if $self->players;	2032	return if $self->players;
1578	return if $self->in_memory != cf::MAP_IN_MEMORY;	2033	return if $self->in_memory != cf::MAP_IN_MEMORY;
1579	return if $self->{deny_save};	2034	return if $self->{deny_save};
1580		2035
…		…
1584		2039
1585	sub reset_at {	2040	sub reset_at {
1586	my ($self) = @_;	2041	my ($self) = @_;
1587		2042
1588	# TODO: safety, remove and allow resettable per-player maps	2043	# TODO: safety, remove and allow resettable per-player maps
1589	return 1e99 if $self->isa ("ext::map_per_player");#d#
1590	return 1e99 if $self->{deny_reset};	2044	return 1e99 if $self->{deny_reset};
1591		2045
1592	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2046	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2047	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594		2048
…		…
1605	my ($self) = @_;	2059	my ($self) = @_;
1606		2060
1607	my $lock = cf::lock_acquire "map_data:$self->{path}";	2061	my $lock = cf::lock_acquire "map_data:$self->{path}";
1608		2062
1609	return if $self->players;	2063	return if $self->players;
1610	return if $self->isa ("ext::map_per_player");#d#
1611		2064
1612	warn "resetting map ", $self->path;#d#	2065	warn "resetting map ", $self->path;
1613		2066
1614	$self->in_memory (cf::MAP_SWAPPED);	2067	$self->in_memory (cf::MAP_SWAPPED);
1615		2068
1616	# need to save uniques path	2069	# need to save uniques path
1617	unless ($self->{deny_save}) {	2070	unless ($self->{deny_save}) {
…		…
1634	my $nuke_counter = "aaaa";	2087	my $nuke_counter = "aaaa";
1635		2088
1636	sub nuke {	2089	sub nuke {
1637	my ($self) = @_;	2090	my ($self) = @_;
1638		2091
		2092	{
		2093	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2094
1639	delete $cf::MAP{$self->path};	2095	delete $cf::MAP{$self->path};
1640		2096
1641	$self->unlink_save;	2097	$self->unlink_save;
1642		2098
1643	bless $self, "cf::map";	2099	bless $self, "cf::map";
1644	delete $self->{deny_reset};	2100	delete $self->{deny_reset};
1645	$self->{deny_save} = 1;	2101	$self->{deny_save} = 1;
1646	$self->reset_timeout (1);	2102	$self->reset_timeout (1);
1647	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2103	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1648		2104
1649	$cf::MAP{$self->path} = $self;	2105	$cf::MAP{$self->path} = $self;
		2106	}
1650		2107
1651	$self->reset; # polite request, might not happen	2108	$self->reset; # polite request, might not happen
		2109	}
		2110
		2111	=item $maps = cf::map::tmp_maps
		2112
		2113	Returns an arrayref with all map paths of currently instantiated and saved
		2114	maps. May block.
		2115
		2116	=cut
		2117
		2118	sub tmp_maps() {
		2119	[
		2120	map {
		2121	utf8::decode $_;
		2122	/\.map$/
		2123	? normalise $_
		2124	: ()
		2125	} @{ aio_readdir $TMPDIR or [] }
		2126	]
		2127	}
		2128
		2129	=item $maps = cf::map::random_maps
		2130
		2131	Returns an arrayref with all map paths of currently instantiated and saved
		2132	random maps. May block.
		2133
		2134	=cut
		2135
		2136	sub random_maps() {
		2137	[
		2138	map {
		2139	utf8::decode $_;
		2140	/\.map$/
		2141	? normalise "?random/$_"
		2142	: ()
		2143	} @{ aio_readdir $RANDOMDIR or [] }
		2144	]
1652	}	2145	}
1653		2146
1654	=item cf::map::unique_maps	2147	=item cf::map::unique_maps
1655		2148
1656	Returns an arrayref of paths of all shared maps that have	2149	Returns an arrayref of paths of all shared maps that have
1657	instantiated unique items. May block.	2150	instantiated unique items. May block.
1658		2151
1659	=cut	2152	=cut
1660		2153
1661	sub unique_maps() {	2154	sub unique_maps() {
1662	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2155	[
1663	or return;	2156	map {
1664
1665	my @paths;
1666
1667	for (@$files) {
1668	utf8::decode $_;	2157	utf8::decode $_;
1669	next if /\.pst$/;	2158	/\.map$/
1670	next unless /^$PATH_SEP/o;	2159	? normalise $_
1671		2160	: ()
1672	push @paths, cf::map::normalise $_;	2161	} @{ aio_readdir $UNIQUEDIR or [] }
1673	}	2162	]
1674
1675	\@paths
1676	}	2163	}
1677		2164
1678	package cf;	2165	package cf;
1679		2166
1680	=back	2167	=back
…		…
1726		2213
1727	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2214	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1728		2215
1729	if ($self->{record_replies}) {	2216	if ($self->{record_replies}) {
1730	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2217	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2218
1731	} else {	2219	} else {
		2220	my $pl = $self->contr;
		2221
		2222	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2223	my $dialog = $pl->{npc_dialog};
		2224	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2225
		2226	} else {
1732	$msg = $npc->name . " says: $msg" if $npc;	2227	$msg = $npc->name . " says: $msg" if $npc;
1733	$self->message ($msg, $flags);	2228	$self->message ($msg, $flags);
		2229	}
1734	}	2230	}
		2231	}
		2232
		2233	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2234
		2235	=cut
		2236
		2237	sub cf::object::send_msg {
		2238	my $pl = shift->contr
		2239	or return;
		2240	$pl->send_msg (@_);
1735	}	2241	}
1736		2242
1737	=item $player_object->may ("access")	2243	=item $player_object->may ("access")
1738		2244
1739	Returns wether the given player is authorized to access resource "access"	2245	Returns wether the given player is authorized to access resource "access"
…		…
1786	$self->deactivate_recursive;	2292	$self->deactivate_recursive;
1787		2293
1788	return if UNIVERSAL::isa $self->map, "ext::map_link";	2294	return if UNIVERSAL::isa $self->map, "ext::map_link";
1789		2295
1790	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2296	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1791	if $self->map;	2297	if $self->map && $self->map->{path} ne "{link}";
1792		2298
1793	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2299	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1794	}	2300	}
1795		2301
1796	sub cf::object::player::leave_link {	2302	sub cf::object::player::leave_link {
1797	my ($self, $map, $x, $y) = @_;	2303	my ($self, $map, $x, $y) = @_;
		2304
		2305	return unless $self->contr->active;
1798		2306
1799	my $link_pos = delete $self->{_link_pos};	2307	my $link_pos = delete $self->{_link_pos};
1800		2308
1801	unless ($map) {	2309	unless ($map) {
1802	# restore original map position	2310	# restore original map position
…		…
1816	# use -1 or undef as default coordinates, not 0, 0	2324	# use -1 or undef as default coordinates, not 0, 0
1817	($x, $y) = ($map->enter_x, $map->enter_y)	2325	($x, $y) = ($map->enter_x, $map->enter_y)
1818	if $x <=0 && $y <= 0;	2326	if $x <=0 && $y <= 0;
1819		2327
1820	$map->load;	2328	$map->load;
1821	$map->load_diag;	2329	$map->load_neighbours;
1822		2330
1823	return unless $self->contr->active;	2331	return unless $self->contr->active;
1824	$self->activate_recursive;	2332	$self->activate_recursive;
		2333
		2334	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1825	$self->enter_map ($map, $x, $y);	2335	$self->enter_map ($map, $x, $y);
1826	}	2336	}
1827		2337
1828	cf::player->attach (	2338	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1829	on_logout => sub {
1830	my ($pl) = @_;
1831		2339
1832	# abort map switching before logout	2340	Moves the player to the given map-path and coordinates by first freezing
1833	if ($pl->ob->{_link_pos}) {	2341	her, loading and preparing them map, calling the provided $check callback
1834	cf::sync_job {	2342	that has to return the map if sucecssful, and then unfreezes the player on
1835	$pl->ob->leave_link	2343	the new (success) or old (failed) map position. In either case, $done will
1836	};	2344	be called at the end of this process.
1837	}
1838	},
1839	on_login => sub {
1840	my ($pl) = @_;
1841		2345
1842	# try to abort aborted map switching on player login :)
1843	# should happen only on crashes
1844	if ($pl->ob->{_link_pos}) {
1845	$pl->ob->enter_link;
1846	(async {
1847	# we need this sleep as the login has a concurrent enter_exit running
1848	# and this sleep increases chances of the player not ending up in scorn
1849	$pl->ob->reply (undef,
1850	"There was an internal problem at your last logout, "
1851	. "the server will try to bring you to your intended destination in a second.",
1852	cf::NDI_RED);
1853	Coro::Timer::sleep 1;
1854	$pl->ob->leave_link;
1855	})->prio (2);
1856	}
1857	},
1858	);
1859
1860	=item $player_object->goto ($path, $x, $y)
1861
1862	=cut	2346	=cut
		2347
		2348	our $GOTOGEN;
1863		2349
1864	sub cf::object::player::goto {	2350	sub cf::object::player::goto {
1865	my ($self, $path, $x, $y) = @_;	2351	my ($self, $path, $x, $y, $check, $done) = @_;
		2352
		2353	# do generation counting so two concurrent goto's will be executed in-order
		2354	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1866		2355
1867	$self->enter_link;	2356	$self->enter_link;
1868		2357
1869	(async {	2358	(async {
1870	my $map = eval {	2359	my $map = eval {
1871	my $map = cf::map::find $path;	2360	my $map = cf::map::find $path;
		2361
		2362	if ($map) {
1872	$map = $map->customise_for ($self) if $map;	2363	$map = $map->customise_for ($self);
		2364	$map = $check->($map) if $check && $map;
		2365	} else {
		2366	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2367	}
		2368
1873	$map	2369	$map
		2370	};
		2371
		2372	if ($@) {
		2373	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2374	LOG llevError | logBacktrace, Carp::longmess $@;
1874	} or	2375	}
1875	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1876		2376
		2377	if ($gen == $self->{_goto_generation}) {
		2378	delete $self->{_goto_generation};
1877	$self->leave_link ($map, $x, $y);	2379	$self->leave_link ($map, $x, $y);
		2380	}
		2381
		2382	$done->() if $done;
1878	})->prio (1);	2383	})->prio (1);
1879	}	2384	}
1880		2385
1881	=item $player_object->enter_exit ($exit_object)	2386	=item $player_object->enter_exit ($exit_object)
1882		2387
…		…
1921		2426
1922	$rmp->{random_seed} ||= $exit->random_seed;	2427	$rmp->{random_seed} ||= $exit->random_seed;
1923		2428
1924	my $data = cf::to_json $rmp;	2429	my $data = cf::to_json $rmp;
1925	my $md5 = Digest::MD5::md5_hex $data;	2430	my $md5 = Digest::MD5::md5_hex $data;
1926	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2431	my $meta = "$RANDOMDIR/$md5.meta";
1927		2432
1928	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2433	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1929	aio_write $fh, 0, (length $data), $data, 0;	2434	aio_write $fh, 0, (length $data), $data, 0;
1930	undef $fh;	2435	undef $fh;
1931	aio_rename "$meta~", $meta;	2436	aio_rename "$meta~", $meta;
…		…
1940		2445
1941	return unless $self->type == cf::PLAYER;	2446	return unless $self->type == cf::PLAYER;
1942		2447
1943	if ($exit->slaying eq "/!") {	2448	if ($exit->slaying eq "/!") {
1944	#TODO: this should de-fi-ni-te-ly not be a sync-job	2449	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2450	# the problem is that $exit might not survive long enough
		2451	# so it needs to be done right now, right here
1945	cf::sync_job { prepare_random_map $exit };	2452	cf::sync_job { prepare_random_map $exit };
1946	}	2453	}
1947		2454
1948	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2455	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1949	my $hp = $exit->stats->hp;	2456	my $hp = $exit->stats->hp;
1950	my $sp = $exit->stats->sp;	2457	my $sp = $exit->stats->sp;
1951		2458
1952	$self->enter_link;	2459	$self->enter_link;
		2460
		2461	# if exit is damned, update players death & WoR home-position
		2462	$self->contr->savebed ($slaying, $hp, $sp)
		2463	if $exit->flag (FLAG_DAMNED);
1953		2464
1954	(async {	2465	(async {
1955	$self->deactivate_recursive; # just to be sure	2466	$self->deactivate_recursive; # just to be sure
1956	unless (eval {	2467	unless (eval {
1957	$self->goto ($slaying, $hp, $sp);	2468	$self->goto ($slaying, $hp, $sp);
1958		2469
1959	1;	2470	1;
1960	}) {	2471	}) {
1961	$self->message ("Something went wrong deep within the crossfire server. "	2472	$self->message ("Something went wrong deep within the crossfire server. "
1962	. "I'll try to bring you back to the map you were before. "	2473	. "I'll try to bring you back to the map you were before. "
1963	. "Please report this to the dungeon master!",	2474	. "Please report this to the dungeon master!",
1964	cf::NDI_UNIQUE | cf::NDI_RED);	2475	cf::NDI_UNIQUE | cf::NDI_RED);
1965		2476
1966	warn "ERROR in enter_exit: $@";	2477	warn "ERROR in enter_exit: $@";
1967	$self->leave_link;	2478	$self->leave_link;
1968	}	2479	}
1969	})->prio (1);	2480	})->prio (1);
…		…
1982		2493
1983	sub cf::client::send_drawinfo {	2494	sub cf::client::send_drawinfo {
1984	my ($self, $text, $flags) = @_;	2495	my ($self, $text, $flags) = @_;
1985		2496
1986	utf8::encode $text;	2497	utf8::encode $text;
1987	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2498	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1988	}	2499	}
1989		2500
		2501	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2502
		2503	Send a drawinfo or msg packet to the client, formatting the msg for the
		2504	client if neccessary. C<$type> should be a string identifying the type of
		2505	the message, with C<log> being the default. If C<$color> is negative, suppress
		2506	the message unless the client supports the msg packet.
		2507
		2508	=cut
		2509
		2510	our %CHANNEL = (
		2511	"c/identify" => {
		2512	id => "identify",
		2513	title => "Identify",
		2514	reply => undef,
		2515	tooltip => "Items recently identified",
		2516	},
		2517	"c/examine" => {
		2518	id => "examine",
		2519	title => "Examine",
		2520	reply => undef,
		2521	tooltip => "Signs and other items you examined",
		2522	},
		2523	);
		2524
		2525	sub cf::client::send_msg {
		2526	my ($self, $channel, $msg, $color, @extra) = @_;
		2527
		2528	$msg = $self->pl->expand_cfpod ($msg);
		2529
		2530	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2531
		2532	# check predefined channels, for the benefit of C
		2533	$channel = $CHANNEL{$channel} if $CHANNEL{$channel};
		2534
		2535	if (ref $channel) {
		2536	# send meta info to client, if not yet sent
		2537	unless (exists $self->{channel}{$channel->{id}}) {
		2538	$self->{channel}{$channel->{id}} = $channel;
		2539	$self->ext_msg (channel_info => $channel)
		2540	if $self->can_msg;
		2541	}
		2542
		2543	$channel = $channel->{id};
		2544	}
		2545
		2546	return unless @extra || length $msg;
		2547
		2548	if ($self->can_msg) {
		2549	# default colour, mask it out
		2550	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2551	if $color & cf::NDI_DEF;
		2552
		2553	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2554	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2555	} else {
		2556	if ($color >= 0) {
		2557	# replace some tags by gcfclient-compatible ones
		2558	for ($msg) {
		2559	1 while
		2560	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2561	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2562	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2563	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2564	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2565	}
		2566
		2567	$color &= cf::NDI_COLOR_MASK;
		2568
		2569	utf8::encode $msg;
		2570
		2571	if (0 && $msg =~ /\[/) {
		2572	# COMMAND/INFO
		2573	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2574	} else {
		2575	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2576	$self->send_packet ("drawinfo $color $msg")
		2577	}
		2578	}
		2579	}
		2580	}
		2581
		2582	=item $client->ext_msg ($type, @msg)
		2583
		2584	Sends an ext event to the client.
		2585
		2586	=cut
		2587
		2588	sub cf::client::ext_msg($$@) {
		2589	my ($self, $type, @msg) = @_;
		2590
		2591	if ($self->extcmd == 2) {
		2592	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2593	} elsif ($self->extcmd == 1) { # TODO: remove
		2594	push @msg, msgtype => "event_$type";
		2595	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2596	}
		2597	}
		2598
		2599	=item $client->ext_reply ($msgid, @msg)
		2600
		2601	Sends an ext reply to the client.
		2602
		2603	=cut
		2604
		2605	sub cf::client::ext_reply($$@) {
		2606	my ($self, $id, @msg) = @_;
		2607
		2608	if ($self->extcmd == 2) {
		2609	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2610	} elsif ($self->extcmd == 1) {
		2611	#TODO: version 1, remove
		2612	unshift @msg, msgtype => "reply", msgid => $id;
		2613	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2614	}
		2615	}
1990		2616
1991	=item $success = $client->query ($flags, "text", \&cb)	2617	=item $success = $client->query ($flags, "text", \&cb)
1992		2618
1993	Queues a query to the client, calling the given callback with	2619	Queues a query to the client, calling the given callback with
1994	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2620	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1995	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2621	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1996		2622
1997	Queries can fail, so check the return code. Or don't, as queries will become	2623	Queries can fail, so check the return code. Or don't, as queries will
1998	reliable at some point in the future.	2624	become reliable at some point in the future.
1999		2625
2000	=cut	2626	=cut
2001		2627
2002	sub cf::client::query {	2628	sub cf::client::query {
2003	my ($self, $flags, $text, $cb) = @_;	2629	my ($self, $flags, $text, $cb) = @_;
…		…
2011	utf8::encode $text;	2637	utf8::encode $text;
2012	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2638	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2013		2639
2014	$self->send_packet ($self->{query_queue}[0][0])	2640	$self->send_packet ($self->{query_queue}[0][0])
2015	if @{ $self->{query_queue} } == 1;	2641	if @{ $self->{query_queue} } == 1;
		2642
		2643	1
2016	}	2644	}
2017		2645
2018	cf::client->attach (	2646	cf::client->attach (
		2647	on_connect => sub {
		2648	my ($ns) = @_;
		2649
		2650	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2651	},
2019	on_reply => sub {	2652	on_reply => sub {
2020	my ($ns, $msg) = @_;	2653	my ($ns, $msg) = @_;
2021		2654
2022	# this weird shuffling is so that direct followup queries	2655	# this weird shuffling is so that direct followup queries
2023	# get handled first	2656	# get handled first
…		…
2035	} else {	2668	} else {
2036	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2669	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2037	}	2670	}
2038	}	2671	}
2039	},	2672	},
		2673	on_exticmd => sub {
		2674	my ($ns, $buf) = @_;
		2675
		2676	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2677
		2678	if (ref $msg) {
		2679	my ($type, $reply, @payload) =
		2680	"ARRAY" eq ref $msg
		2681	? @$msg
		2682	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2683
		2684	my @reply;
		2685
		2686	if (my $cb = $EXTICMD{$type}) {
		2687	@reply = $cb->($ns, @payload);
		2688	}
		2689
		2690	$ns->ext_reply ($reply, @reply)
		2691	if $reply;
		2692
		2693	} else {
		2694	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2695	}
		2696
		2697	cf::override;
		2698	},
2040	);	2699	);
2041		2700
2042	=item $client->async (\&cb)	2701	=item $client->async (\&cb)
2043		2702
2044	Create a new coroutine, running the specified callback. The coroutine will	2703	Create a new coroutine, running the specified callback. The coroutine will
…		…
2085	our $safe = new Safe "safe";	2744	our $safe = new Safe "safe";
2086	our $safe_hole = new Safe::Hole;	2745	our $safe_hole = new Safe::Hole;
2087		2746
2088	$SIG{FPE} = 'IGNORE';	2747	$SIG{FPE} = 'IGNORE';
2089		2748
2090	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2749	$safe->permit_only (Opcode::opset qw(
		2750	:base_core :base_mem :base_orig :base_math
		2751	grepstart grepwhile mapstart mapwhile
		2752	sort time
		2753	));
2091		2754
2092	# here we export the classes and methods available to script code	2755	# here we export the classes and methods available to script code
2093		2756
2094	=pod	2757	=pod
2095		2758
2096	The following fucntions and emthods are available within a safe environment:	2759	The following functions and methods are available within a safe environment:
2097		2760
2098	cf::object contr pay_amount pay_player map	2761	cf::object
		2762	contr pay_amount pay_player map x y force_find force_add
		2763	insert remove name archname title slaying race decrease_ob_nr
		2764
2099	cf::object::player player	2765	cf::object::player
2100	cf::player peaceful	2766	player
2101	cf::map trigger	2767
		2768	cf::player
		2769	peaceful
		2770
		2771	cf::map
		2772	trigger
2102		2773
2103	=cut	2774	=cut
2104		2775
2105	for (	2776	for (
2106	["cf::object" => qw(contr pay_amount pay_player map)],	2777	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2778	insert remove inv name archname title slaying race
		2779	decrease_ob_nr)],
2107	["cf::object::player" => qw(player)],	2780	["cf::object::player" => qw(player)],
2108	["cf::player" => qw(peaceful)],	2781	["cf::player" => qw(peaceful)],
2109	["cf::map" => qw(trigger)],	2782	["cf::map" => qw(trigger)],
2110	) {	2783	) {
2111	no strict 'refs';	2784	no strict 'refs';
…		…
2182	=back	2855	=back
2183		2856
2184	=cut	2857	=cut
2185		2858
2186	#############################################################################	2859	#############################################################################
2187
2188	=head2 EXTENSION DATABASE SUPPORT
2189
2190	Crossfire maintains a very simple database for extension use. It can
2191	currently store anything that can be serialised using Storable, which
2192	excludes objects.
2193
2194	The parameter C<$family> should best start with the name of the extension
2195	using it, it should be unique.
2196
2197	=over 4
2198
2199	=item $value = cf::db_get $family => $key
2200
2201	Returns a single value from the database.
2202
2203	=item cf::db_put $family => $key => $value
2204
2205	Stores the given C<$value> in the family.
2206
2207	=cut
2208
2209	our $DB;
2210
2211	sub db_init {
2212	unless ($DB) {
2213	$DB = BDB::db_create $DB_ENV;
2214
2215	cf::sync_job {
2216	eval {
2217	$DB->set_flags (BDB::CHKSUM);
2218
2219	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2220	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2221	cf::cleanup "db_open(db): $!" if $!;
2222	};
2223	cf::cleanup "db_open(db): $@" if $@;
2224	};
2225
2226	my $path = cf::localdir . "/database.pst";
2227	if (stat $path) {
2228	cf::sync_job {
2229	my $pst = Storable::retrieve $path;
2230
2231	cf::db_put (board => data => $pst->{board});
2232	cf::db_put (guildrules => data => $pst->{guildrules});
2233	cf::db_put (rent => balance => $pst->{rent}{balance});
2234	BDB::db_env_txn_checkpoint $DB_ENV;
2235
2236	unlink $path;
2237	};
2238	}
2239	}
2240	}
2241
2242	sub db_get($$) {
2243	my $key = "$_[0]/$_[1]";
2244
2245	cf::sync_job {
2246	BDB::db_get $DB, undef, $key, my $data;
2247
2248	$! ? ()
2249	: Compress::LZF::sthaw $data
2250	}
2251	}
2252
2253	sub db_put($$$) {
2254	BDB::dbreq_pri 4;
2255	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2256	}
2257
2258	#############################################################################
2259	# the server's init and main functions	2860	# the server's init and main functions
2260		2861
2261	sub load_resources {	2862	sub load_facedata($) {
2262	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2863	my ($path) = @_;
		2864
		2865	# HACK to clear player env face cache, we need some signal framework
		2866	# for this (global event?)
		2867	%ext::player_env::MUSIC_FACE_CACHE = ();
		2868
		2869	my $enc = JSON::XS->new->utf8->canonical->relaxed;
		2870
		2871	warn "loading facedata from $path\n";
		2872
		2873	my $facedata;
		2874	0 < aio_load $path, $facedata
		2875	or die "$path: $!";
		2876
		2877	$facedata = Coro::Storable::thaw $facedata;
		2878
		2879	$facedata->{version} == 2
		2880	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2881
		2882	# patch in the exptable
		2883	$facedata->{resource}{"res/exp_table"} = {
		2884	type => FT_RSRC,
		2885	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
		2886	};
		2887	cf::cede_to_tick;
		2888
		2889	{
		2890	my $faces = $facedata->{faceinfo};
		2891
		2892	while (my ($face, $info) = each %$faces) {
		2893	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2894	cf::face::set_visibility $idx, $info->{visibility};
		2895	cf::face::set_magicmap $idx, $info->{magicmap};
		2896	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2897	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
		2898
		2899	cf::cede_to_tick;
		2900	}
		2901
		2902	while (my ($face, $info) = each %$faces) {
		2903	next unless $info->{smooth};
		2904	my $idx = cf::face::find $face
		2905	or next;
		2906	if (my $smooth = cf::face::find $info->{smooth}) {
		2907	cf::face::set_smooth $idx, $smooth;
		2908	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2909	} else {
		2910	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2911	}
		2912
		2913	cf::cede_to_tick;
		2914	}
		2915	}
		2916
		2917	{
		2918	my $anims = $facedata->{animinfo};
		2919
		2920	while (my ($anim, $info) = each %$anims) {
		2921	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2922	cf::cede_to_tick;
		2923	}
		2924
		2925	cf::anim::invalidate_all; # d'oh
		2926	}
		2927
		2928	{
		2929	# TODO: for gcfclient pleasure, we should give resources
		2930	# that gcfclient doesn't grok a >10000 face index.
		2931	my $res = $facedata->{resource};
		2932
		2933	my $soundconf = delete $res->{"res/sound.conf"};
		2934
		2935	while (my ($name, $info) = each %$res) {
		2936	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2937	my $data;
		2938
		2939	if ($info->{type} & 1) {
		2940	# prepend meta info
		2941
		2942	my $meta = $enc->encode ({
		2943	name => $name,
		2944	%{ $info->{meta} || {} },
		2945	});
		2946
		2947	$data = pack "(w/a*)*", $meta, $info->{data};
		2948	} else {
		2949	$data = $info->{data};
		2950	}
		2951
		2952	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2953	cf::face::set_type $idx, $info->{type};
		2954
		2955	cf::cede_to_tick;
		2956	}
		2957
		2958	if ($soundconf) {
		2959	$soundconf = $enc->decode (delete $soundconf->{data});
		2960
		2961	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2962	my $sound = $soundconf->{compat}[$_]
		2963	or next;
		2964
		2965	my $face = cf::face::find "sound/$sound->[1]";
		2966	cf::sound::set $sound->[0] => $face;
		2967	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2968	}
		2969
		2970	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2971	my $face = cf::face::find "sound/$v";
		2972	cf::sound::set $k => $face;
		2973	}
		2974	}
		2975	}
		2976
		2977	1
		2978	}
		2979
		2980	register_exticmd fx_want => sub {
		2981	my ($ns, $want) = @_;
		2982
		2983	while (my ($k, $v) = each %$want) {
		2984	$ns->fx_want ($k, $v);
		2985	}
		2986	};
		2987
		2988	sub reload_regions {
		2989	# HACK to clear player env face cache, we need some signal framework
		2990	# for this (global event?)
		2991	%ext::player_env::MUSIC_FACE_CACHE = ();
		2992
		2993	load_resource_file "$MAPDIR/regions"
2263	or die "unable to load regions file\n";#d#	2994	or die "unable to load regions file\n";
2264	}
2265		2995
2266	sub cfg_load {	2996	for (cf::region::list) {
		2997	$_->{match} = qr/$_->{match}/
		2998	if exists $_->{match};
		2999	}
		3000	}
		3001
		3002	sub reload_facedata {
		3003	load_facedata "$DATADIR/facedata"
		3004	or die "unable to load facedata\n";
		3005	}
		3006
		3007	sub reload_archetypes {
		3008	load_resource_file "$DATADIR/archetypes"
		3009	or die "unable to load archetypes\n";
		3010	#d# NEED to laod twice to resolve forward references
		3011	# this really needs to be done in an extra post-pass
		3012	# (which needs to be synchronous, so solve it differently)
		3013	load_resource_file "$DATADIR/archetypes"
		3014	or die "unable to load archetypes\n";
		3015	}
		3016
		3017	sub reload_treasures {
		3018	load_resource_file "$DATADIR/treasures"
		3019	or die "unable to load treasurelists\n";
		3020	}
		3021
		3022	sub reload_resources {
		3023	warn "reloading resource files...\n";
		3024
		3025	reload_regions;
		3026	reload_facedata;
		3027	#reload_archetypes;#d#
		3028	reload_archetypes;
		3029	reload_treasures;
		3030
		3031	warn "finished reloading resource files\n";
		3032	}
		3033
		3034	sub init {
		3035	reload_resources;
		3036	}
		3037
		3038	sub reload_config {
2267	open my $fh, "<:utf8", cf::confdir . "/config"	3039	open my $fh, "<:utf8", "$CONFDIR/config"
2268	or return;	3040	or return;
2269		3041
2270	local $/;	3042	local $/;
2271	*CFG = YAML::Syck::Load <$fh>;	3043	*CFG = YAML::Syck::Load <$fh>;
2272		3044
…		…
2280	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	3052	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2281	and die "WARNING: m(un)lockall failed: $!\n";	3053	and die "WARNING: m(un)lockall failed: $!\n";
2282	};	3054	};
2283	warn $@ if $@;	3055	warn $@ if $@;
2284	}	3056	}
2285	}
2286
2287	sub init {
2288	load_resources;
2289	}	3057	}
2290		3058
2291	sub main {	3059	sub main {
2292	# we must not ever block the main coroutine	3060	# we must not ever block the main coroutine
2293	local $Coro::idle = sub {	3061	local $Coro::idle = sub {
…		…
2295	(async {	3063	(async {
2296	Event::one_event;	3064	Event::one_event;
2297	})->prio (Coro::PRIO_MAX);	3065	})->prio (Coro::PRIO_MAX);
2298	};	3066	};
2299		3067
2300	cfg_load;	3068	reload_config;
2301	db_init;	3069	db_init;
2302	load_extensions;	3070	load_extensions;
2303		3071
2304	$TICK_WATCHER->start;	3072	$TICK_WATCHER->start;
2305	Event::loop;	3073	Event::loop;
…		…
2321	},	3089	},
2322	);	3090	);
2323	}	3091	}
2324	}	3092	}
2325		3093
		3094	sub write_runtime {
		3095	my $runtime = "$LOCALDIR/runtime";
		3096
		3097	# first touch the runtime file to show we are still running:
		3098	# the fsync below can take a very very long time.
		3099
		3100	IO::AIO::aio_utime $runtime, undef, undef;
		3101
		3102	my $guard = cf::lock_acquire "write_runtime";
		3103
		3104	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3105	or return;
		3106
		3107	my $value = $cf::RUNTIME + 90 + 10;
		3108	# 10 is the runtime save interval, for a monotonic clock
		3109	# 60 allows for the watchdog to kill the server.
		3110
		3111	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3112	and return;
		3113
		3114	# always fsync - this file is important
		3115	aio_fsync $fh
		3116	and return;
		3117
		3118	# touch it again to show we are up-to-date
		3119	aio_utime $fh, undef, undef;
		3120
		3121	close $fh
		3122	or return;
		3123
		3124	aio_rename "$runtime~", $runtime
		3125	and return;
		3126
		3127	warn "runtime file written.\n";
		3128
		3129	1
		3130	}
		3131
2326	sub emergency_save() {	3132	sub emergency_save() {
2327	my $freeze_guard = cf::freeze_mainloop;	3133	my $freeze_guard = cf::freeze_mainloop;
2328		3134
2329	warn "enter emergency perl save\n";	3135	warn "enter emergency perl save\n";
2330		3136
…		…
2354	};	3160	};
2355		3161
2356	warn "leave emergency perl save\n";	3162	warn "leave emergency perl save\n";
2357	}	3163	}
2358		3164
		3165	sub post_cleanup {
		3166	my ($make_core) = @_;
		3167
		3168	warn Carp::longmess "post_cleanup backtrace"
		3169	if $make_core;
		3170	}
		3171
2359	sub reload() {	3172	sub do_reload_perl() {
2360	# can/must only be called in main	3173	# can/must only be called in main
2361	if ($Coro::current != $Coro::main) {	3174	if ($Coro::current != $Coro::main) {
2362	warn "can only reload from main coroutine";	3175	warn "can only reload from main coroutine";
2363	return;	3176	return;
2364	}	3177	}
2365		3178
2366	warn "reloading...";	3179	warn "reloading...";
2367		3180
2368	warn "cancelling server ticker";	3181	warn "entering sync_job";
2369	$TICK_WATCHER->cancel;
2370		3182
		3183	cf::sync_job {
		3184	cf::write_runtime; # external watchdog should not bark
2371	cf::emergency_save;	3185	cf::emergency_save;
		3186	cf::write_runtime; # external watchdog should not bark
2372		3187
2373	eval {	3188	warn "syncing database to disk";
		3189	BDB::db_env_txn_checkpoint $DB_ENV;
		3190
2374	# if anything goes wrong in here, we should simply crash as we already saved	3191	# if anything goes wrong in here, we should simply crash as we already saved
2375		3192
2376	warn "cancelling all WF_AUTOCANCEL watchers";	3193	warn "cancelling all WF_AUTOCANCEL watchers";
2377	for (Event::all_watchers) {	3194	for (Event::all_watchers) {
2378	$_->cancel if $_->data & WF_AUTOCANCEL;	3195	$_->cancel if $_->data & WF_AUTOCANCEL;
2379	}	3196	}
2380
2381	warn "syncing database to disk";
2382	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2383		3197
2384	warn "flushing outstanding aio requests";	3198	warn "flushing outstanding aio requests";
2385	for (;;) {	3199	for (;;) {
2386	BDB::flush;	3200	BDB::flush;
2387	IO::AIO::flush;	3201	IO::AIO::flush;
2388	Coro::cede;	3202	Coro::cede;
2389	last unless IO::AIO::nreqs || BDB::nreqs;	3203	last unless IO::AIO::nreqs || BDB::nreqs;
2390	warn "iterate...";	3204	warn "iterate...";
2391	}	3205	}
2392		3206
		3207	++$RELOAD;
		3208
2393	warn "cancelling all extension coros";	3209	warn "cancelling all extension coros";
2394	$_->cancel for values %EXT_CORO;	3210	$_->cancel for values %EXT_CORO;
2395	%EXT_CORO = ();	3211	%EXT_CORO = ();
2396		3212
2397	warn "removing commands";	3213	warn "removing commands";
2398	%COMMAND = ();	3214	%COMMAND = ();
2399		3215
2400	warn "removing ext commands";	3216	warn "removing ext/exti commands";
2401	%EXTCMD = ();	3217	%EXTCMD = ();
		3218	%EXTICMD = ();
2402		3219
2403	warn "unloading/nuking all extensions";	3220	warn "unloading/nuking all extensions";
2404	for my $pkg (@EXTS) {	3221	for my $pkg (@EXTS) {
2405	warn "... unloading $pkg";	3222	warn "... unloading $pkg";
2406		3223
…		…
2436	Symbol::delete_package "safe::$_"	3253	Symbol::delete_package "safe::$_"
2437	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3254	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2438		3255
2439	warn "unloading cf.pm \"a bit\"";	3256	warn "unloading cf.pm \"a bit\"";
2440	delete $INC{"cf.pm"};	3257	delete $INC{"cf.pm"};
		3258	delete $INC{"cf/pod.pm"};
2441		3259
2442	# don't, removes xs symbols, too,	3260	# don't, removes xs symbols, too,
2443	# and global variables created in xs	3261	# and global variables created in xs
2444	#Symbol::delete_package __PACKAGE__;	3262	#Symbol::delete_package __PACKAGE__;
2445		3263
…		…
2448	warn "reloading cf.pm";	3266	warn "reloading cf.pm";
2449	require cf;	3267	require cf;
2450	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3268	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2451		3269
2452	warn "loading config and database again";	3270	warn "loading config and database again";
2453	cf::cfg_load;	3271	cf::reload_config;
2454		3272
2455	warn "loading extensions";	3273	warn "loading extensions";
2456	cf::load_extensions;	3274	cf::load_extensions;
2457		3275
2458	warn "reattaching attachments to objects/players";	3276	warn "reattaching attachments to objects/players";
2459	_global_reattach;	3277	_global_reattach; # objects, sockets
2460	warn "reattaching attachments to maps";	3278	warn "reattaching attachments to maps";
2461	reattach $_ for values %MAP;	3279	reattach $_ for values %MAP;
		3280	warn "reattaching attachments to players";
		3281	reattach $_ for values %PLAYER;
2462		3282
2463	warn "loading reloadable resources";	3283	warn "leaving sync_job";
2464	load_resources;
2465		3284
2466	warn "restarting server ticker";	3285	1
2467		3286	} or do {
2468	$TICK_WATCHER->start;
2469	};
2470
2471	if ($@) {
2472	warn $@;	3287	warn $@;
2473	warn "error while reloading, exiting.";	3288	warn "error while reloading, exiting.";
2474	exit 1;	3289	exit 1;
2475	}	3290	};
2476		3291
2477	warn "reloaded";	3292	warn "reloaded";
2478	};	3293	};
2479		3294
2480	our $RELOAD_WATCHER; # used only during reload	3295	our $RELOAD_WATCHER; # used only during reload
2481		3296
		3297	sub reload_perl() {
		3298	# doing reload synchronously and two reloads happen back-to-back,
		3299	# coro crashes during coro_state_free->destroy here.
		3300
		3301	$RELOAD_WATCHER ||= Event->timer (
		3302	reentrant => 0,
		3303	after => 0,
		3304	data => WF_AUTOCANCEL,
		3305	cb => sub {
		3306	do_reload_perl;
		3307	undef $RELOAD_WATCHER;
		3308	},
		3309	);
		3310	}
		3311
2482	register_command "reload" => sub {	3312	register_command "reload" => sub {
2483	my ($who, $arg) = @_;	3313	my ($who, $arg) = @_;
2484		3314
2485	if ($who->flag (FLAG_WIZ)) {	3315	if ($who->flag (FLAG_WIZ)) {
2486	$who->message ("reloading server.");	3316	$who->message ("reloading server.");
2487		3317	async { reload_perl };
2488	# doing reload synchronously and two reloads happen back-to-back,
2489	# coro crashes during coro_state_free->destroy here.
2490
2491	$RELOAD_WATCHER ||= Event->timer (
2492	reentrant => 0,
2493	after => 0,
2494	data => WF_AUTOCANCEL,
2495	cb => sub {
2496	reload;
2497	undef $RELOAD_WATCHER;
2498	},
2499	);
2500	}	3318	}
2501	};	3319	};
2502		3320
2503	unshift @INC, $LIBDIR;	3321	unshift @INC, $LIBDIR;
2504		3322
2505	my $bug_warning = 0;	3323	my $bug_warning = 0;
2506		3324
		3325	our @WAIT_FOR_TICK;
		3326	our @WAIT_FOR_TICK_BEGIN;
		3327
		3328	sub wait_for_tick {
		3329	return unless $TICK_WATCHER->is_active;
		3330	return if $Coro::current == $Coro::main;
		3331
		3332	my $signal = new Coro::Signal;
		3333	push @WAIT_FOR_TICK, $signal;
		3334	$signal->wait;
		3335	}
		3336
		3337	sub wait_for_tick_begin {
		3338	return unless $TICK_WATCHER->is_active;
		3339	return if $Coro::current == $Coro::main;
		3340
		3341	my $signal = new Coro::Signal;
		3342	push @WAIT_FOR_TICK_BEGIN, $signal;
		3343	$signal->wait;
		3344	}
		3345
		3346	my $min = 1e6;#d#
		3347	my $avg = 10;
2507	$TICK_WATCHER = Event->timer (	3348	$TICK_WATCHER = Event->timer (
2508	reentrant => 0,	3349	reentrant => 0,
2509	parked => 1,	3350	parked => 1,
2510	prio => 0,	3351	prio => 0,
2511	at => $NEXT_TICK || $TICK,	3352	at => $NEXT_TICK || $TICK,
…		…
2515	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3356	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2516	unless ++$bug_warning > 10;	3357	unless ++$bug_warning > 10;
2517	return;	3358	return;
2518	}	3359	}
2519		3360
2520	$NOW = Event::time;	3361	$NOW = $tick_start = Event::time;
2521		3362
2522	cf::server_tick; # one server iteration	3363	cf::server_tick; # one server iteration
		3364
		3365	0 && sync_job {#d#
		3366	for(1..10) {
		3367	my $t = Event::time;
		3368	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3369	or die;
		3370
		3371	$map->width (50);
		3372	$map->height (50);
		3373	$map->alloc;
		3374	$map->_load_objects ("/tmp/x.map", 1);
		3375	my $t = Event::time - $t;
		3376
		3377	#next unless $t < 0.0013;#d#
		3378	if ($t < $min) {
		3379	$min = $t;
		3380	}
		3381	$avg = $avg * 0.99 + $t * 0.01;
		3382	}
		3383	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3384	exit 0;
		3385	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3386	};
		3387
2523	$RUNTIME += $TICK;	3388	$RUNTIME += $TICK;
2524	$NEXT_TICK += $TICK;	3389	$NEXT_TICK += $TICK;
2525		3390
2526	$WAIT_FOR_TICK->broadcast;	3391	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2527	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3392	$NEXT_RUNTIME_WRITE = $NOW + 10;
2528		3393	Coro::async_pool {
2529	Event::sweep;	3394	write_runtime
2530	Coro::cede_notself;	3395	or warn "ERROR: unable to write runtime file: $!";
		3396	};
2531		3397	}
		3398
2532	# my $AFTER = Event::time;	3399	# my $AFTER = Event::time;
2533	# warn $AFTER - $NOW;#d#	3400	# warn $AFTER - $NOW;#d#
2534		3401
		3402	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3403	$sig->send;
		3404	}
		3405	while (my $sig = shift @WAIT_FOR_TICK) {
		3406	$sig->send;
		3407	}
		3408
		3409	$NOW = Event::time;
		3410
2535	# if we are delayed by four ticks or more, skip them all	3411	# if we are delayed by four ticks or more, skip them all
2536	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3412	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2537		3413
2538	$TICK_WATCHER->at ($NEXT_TICK);	3414	$TICK_WATCHER->at ($NEXT_TICK);
2539	$TICK_WATCHER->start;	3415	$TICK_WATCHER->start;
		3416
		3417	$LOAD = ($NOW - $tick_start) / $TICK;
		3418	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3419
		3420	_post_tick;
		3421
		3422
2540	},	3423	},
2541	);	3424	);
2542		3425
2543	{	3426	{
2544	BDB::max_poll_time $TICK * 0.1;	3427	BDB::max_poll_time $TICK * 0.1;
…		…
2572		3455
2573	cf::sync_job {	3456	cf::sync_job {
2574	eval {	3457	eval {
2575	BDB::db_env_open	3458	BDB::db_env_open
2576	$DB_ENV,	3459	$DB_ENV,
2577	$BDB_ENV_DIR,	3460	$BDBDIR,
2578	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3461	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2579	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3462	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2580	0666;	3463	0666;
2581		3464
2582	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3465	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2583		3466
2584	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3467	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2585	$DB_ENV->set_lk_detect;	3468	$DB_ENV->set_lk_detect;
2586	};	3469	};
2587		3470
…		…
2595		3478
2596	undef $Coro::AIO::WATCHER;	3479	undef $Coro::AIO::WATCHER;
2597	IO::AIO::max_poll_time $TICK * 0.1;	3480	IO::AIO::max_poll_time $TICK * 0.1;
2598	$AIO_POLL_WATCHER = Event->io (	3481	$AIO_POLL_WATCHER = Event->io (
2599	reentrant => 0,	3482	reentrant => 0,
		3483	data => WF_AUTOCANCEL,
2600	fd => IO::AIO::poll_fileno,	3484	fd => IO::AIO::poll_fileno,
2601	poll => 'r',	3485	poll => 'r',
2602	prio => 6,	3486	prio => 6,
2603	data => WF_AUTOCANCEL,
2604	cb => \&IO::AIO::poll_cb,	3487	cb => \&IO::AIO::poll_cb,
2605	);	3488	);
2606	}	3489	}
2607		3490
2608	$WRITE_RUNTIME_WATCHER = Event->timer (	3491	my $_log_backtrace;
2609	reentrant => 0,	3492
2610	data => WF_AUTOCANCEL,	3493	sub _log_backtrace {
2611	after => 1,	3494	my ($msg, @addr) = @_;
2612	interval => 10,	3495
2613	prio => 6, # keep it lowest so it acts like a watchdog	3496	$msg =~ s/\n//;
2614	cb => Coro::unblock_sub {	3497
2615	write_runtime	3498	# limit the # of concurrent backtraces
2616	or warn "ERROR: unable to write runtime file: $!";	3499	if ($_log_backtrace < 2) {
		3500	++$_log_backtrace;
		3501	async {
		3502	my @bt = fork_call {
		3503	@addr = map { sprintf "%x", $_ } @addr;
		3504	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3505	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3506	or die "addr2line: $!";
		3507
		3508	my @funcs;
		3509	my @res = <$fh>;
		3510	chomp for @res;
		3511	while (@res) {
		3512	my ($func, $line) = splice @res, 0, 2, ();
		3513	push @funcs, "[$func] $line";
		3514	}
		3515
		3516	@funcs
		3517	};
		3518
		3519	LOG llevInfo, "[ABT] $msg\n";
		3520	LOG llevInfo, "[ABT] $_\n" for @bt;
		3521	--$_log_backtrace;
		3522	};
		3523	} else {
		3524	LOG llevInfo, "[ABT] $msg\n";
		3525	LOG llevInfo, "[ABT] [suppressed]\n";
2617	},	3526	}
2618	);	3527	}
		3528
		3529	# load additional modules
		3530	use cf::pod;
2619		3531
2620	END { cf::emergency_save }	3532	END { cf::emergency_save }
2621		3533
2622	1	3534	1
2623		3535

Diff Legend

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