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

Diff Legend

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