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.195 by root, Fri Jan 26 20:59:57 2007 UTC vs.
Revision 1.342 by root, Sun Aug 26 15:31:02 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;
		117
		118	sub cf::map::normalise;
87		119
88	#############################################################################	120	#############################################################################
89		121
90	=head2 GLOBAL VARIABLES	122	=head2 GLOBAL VARIABLES
91		123
…		…
98	=item $cf::RUNTIME	130	=item $cf::RUNTIME
99		131
100	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
101	every server tick.	133	every server tick.
102		134
103	=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
104		138
105	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
106	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.
107		143
108	=item $cf::NOW	144	=item $cf::NOW
109		145
110	The time of the last (current) server tick.	146	The time of the last (current) server tick.
111		147
112	=item $cf::TICK	148	=item $cf::TICK
113		149
114	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.
115		161
116	=item %cf::CFG	162	=item %cf::CFG
117		163
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
119	from wherever your confdir points to.	165	from wherever your confdir points to.
120		166
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	167	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		168
123	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
124	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
125	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.
126	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.
127		178
128	=back	179	=back
129		180
130	=cut	181	=cut
131		182
132	BEGIN {	183	BEGIN {
133	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	185	my $msg = join "", @_;
135	utf8::encode $msg;
136		186
137	$msg .= "\n"	187	$msg .= "\n"
138	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
139		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
140	LOG llevError, $msg;	193	LOG llevError, $msg;
141	};	194	};
142	}	195	}
143		196
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@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';
149	@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)
150		204
151	# 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
152	# within the Safe compartment.	206	# within the Safe compartment.
153	for my $pkg (qw(	207	for my $pkg (qw(
154	cf::global cf::attachable	208	cf::global cf::attachable
…		…
162	}	216	}
163		217
164	$Event::DIED = sub {	218	$Event::DIED = sub {
165	warn "error in event callback: @_";	219	warn "error in event callback: @_";
166	};	220	};
		221
		222	#############################################################################
167		223
168	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
169		225
170	=over 4	226	=over 4
171		227
…		…
190	$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;
191	$d	247	$d
192	} || "[unable to dump $_[0]: '$@']";	248	} || "[unable to dump $_[0]: '$@']";
193	}	249	}
194		250
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
198		252
199	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
200		254
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	255	=item $json = cf::to_json $ref
209		256
210	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
211		258
212	=cut	259	=cut
213		260
214	sub to_json($) {	261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	262
216	JSON::Syck::Dump $_[0]	263	sub to_json ($) { $json_coder->encode ($_[0]) }
217	}	264	sub from_json ($) { $json_coder->decode ($_[0]) }
218		265
219	=item cf::lock_wait $string	266	=item cf::lock_wait $string
220		267
221	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
222		269
…		…
228	returned.	275	returned.
229		276
230	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
231	uses map_find and cf::map::load uses map_load).	278	uses map_find and cf::map::load uses map_load).
232		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
233	=cut	284	=cut
234		285
235	our %LOCK;	286	our %LOCK;
236		287
237	sub lock_wait($) {	288	sub lock_wait($) {
…		…
256	# wake up all waiters, to be on the safe side	307	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	308	$_->ready for @{ delete $LOCK{$key} };
258	}	309	}
259	}	310	}
260		311
		312	sub lock_active($) {
		313	my ($key) = @_;
		314
		315	! ! $LOCK{$key}
		316	}
		317
261	sub freeze_mainloop {	318	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	319	return unless $TICK_WATCHER->is_active;
263		320
264	my $guard = Coro::guard {	321	my $guard = Coro::guard {
265	$TICK_WATCHER->start;	322	$TICK_WATCHER->start;
266	$WRITE_RUNTIME_WATCHER->start;
267	};	323	};
268	$WRITE_RUNTIME_WATCHER->stop;
269	$TICK_WATCHER->stop;	324	$TICK_WATCHER->stop;
270	$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;
271	}	382	}
272		383
273	=item cf::async { BLOCK }	384	=item cf::async { BLOCK }
274		385
275	Currently the same as Coro::async_pool, meaning you cannot use	386	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		391
281	BEGIN { *async = \&Coro::async_pool }	392	BEGIN { *async = \&Coro::async_pool }
282		393
283	=item cf::sync_job { BLOCK }	394	=item cf::sync_job { BLOCK }
284		395
285	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)
286	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
287	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.
288		400
289	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
290	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
291	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
292	fast or be very important.	404	fast or be very important.
…		…
295		407
296	sub sync_job(&) {	408	sub sync_job(&) {
297	my ($job) = @_;	409	my ($job) = @_;
298		410
299	if ($Coro::current == $Coro::main) {	411	if ($Coro::current == $Coro::main) {
		412	my $time = Event::time;
		413
300	# this is the main coro, too bad, we have to block	414	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	415	# till the operation succeeds, freezing the server :/
302		416
303	# TODO: use suspend/resume instead	417	# TODO: use suspend/resume instead
304	# (but this is cancel-safe)	418	# (but this is cancel-safe)
…		…
315		429
316	while ($busy) {	430	while ($busy) {
317	Coro::cede or Event::one_event;	431	Coro::cede or Event::one_event;
318	}	432	}
319		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
320	wantarray ? @res : $res[0]	441	wantarray ? @res : $res[0]
321	} else {	442	} else {
322	# we are in another coroutine, how wonderful, everything just works	443	# we are in another coroutine, how wonderful, everything just works
323		444
324	$job->()	445	$job->()
…		…
343	$EXT_CORO{$coro+0} = $coro;	464	$EXT_CORO{$coro+0} = $coro;
344		465
345	$coro	466	$coro
346	}	467	}
347		468
348	sub write_runtime {	469	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		470
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	471	Executes the given code block with the given arguments in a seperate
352	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.
353		475
354	my $value = $cf::RUNTIME + 90 + 10;	476	=cut
355	# 10 is the runtime save interval, for a monotonic clock
356	# 60 allows for the watchdog to kill the server.
357		477
358	(aio_write $fh, 0, (length $value), $value, 0) <= 0	478	sub fork_call(&@) {
359	and return;	479	my ($cb, @args) = @_;
360		480
361	aio_fsync $fh	481	# we seemingly have to make a local copy of the whole thing,
362	and return;	482	# otherwise perl prematurely frees the stuff :/
		483	# TODO: investigate and fix (liekly this will be rather laborious)
363		484
364	close $fh	485	my @res = Coro::Util::fork_eval {
365	or return;	486	reset_signals;
		487	&$cb
		488	}, @args;
366		489
367	aio_rename "$runtime~", $runtime	490	wantarray ? @res : $res[-1]
368	and return;	491	}
369		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	};
370	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 });
371	}	618	}
372		619
373	=back	620	=back
374		621
375	=cut	622	=cut
…		…
382	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")
383	to it. All such attachable objects support the following methods.	630	to it. All such attachable objects support the following methods.
384		631
385	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>
386	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
387	crossfire+).	634	Crossfire TRT).
388		635
389	=over 4	636	=over 4
390		637
391	=item $attachable->attach ($attachment, key => $value...)	638	=item $attachable->attach ($attachment, key => $value...)
392		639
…		…
555	$registry = $CB_TYPE[$object_type] ||= [];	802	$registry = $CB_TYPE[$object_type] ||= [];
556		803
557	} elsif ($type eq "subtype") {	804	} elsif ($type eq "subtype") {
558	defined $object_type or Carp::croak "subtype specified without type";	805	defined $object_type or Carp::croak "subtype specified without type";
559	my $object_subtype = shift @arg;	806	my $object_subtype = shift @arg;
560	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	807	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561		808
562	} elsif ($type eq "package") {	809	} elsif ($type eq "package") {
563	my $pkg = shift @arg;	810	my $pkg = shift @arg;
564		811
565	while (my ($name, $id) = each %cb_id) {	812	while (my ($name, $id) = each %cb_id) {
…		…
594	_attach $registry, $klass, @attach;	841	_attach $registry, $klass, @attach;
595	}	842	}
596		843
597	$obj->{$name} = \%arg;	844	$obj->{$name} = \%arg;
598	} else {	845	} else {
599	warn "object uses attachment '$name' that is not available, postponing.\n";	846	warn "object uses attachment '$name' which is not available, postponing.\n";
600	}	847	}
601		848
602	$obj->{_attachment}{$name} = undef;	849	$obj->{_attachment}{$name} = undef;
603	}	850	}
604		851
…		…
606	if (ref $_[0]) {	853	if (ref $_[0]) {
607	_object_attach @_;	854	_object_attach @_;
608	} else {	855	} else {
609	_attach shift->_attach_registry, @_;	856	_attach shift->_attach_registry, @_;
610	}	857	}
		858	_recalc_want;
611	};	859	};
612		860
613	# all those should be optimised	861	# all those should be optimised
614	sub cf::attachable::detach {	862	sub cf::attachable::detach {
615	my ($obj, $name) = @_;	863	my ($obj, $name) = @_;
…		…
618	delete $obj->{_attachment}{$name};	866	delete $obj->{_attachment}{$name};
619	reattach ($obj);	867	reattach ($obj);
620	} else {	868	} else {
621	Carp::croak "cannot, currently, detach class attachments";	869	Carp::croak "cannot, currently, detach class attachments";
622	}	870	}
		871	_recalc_want;
623	};	872	};
624		873
625	sub cf::attachable::attached {	874	sub cf::attachable::attached {
626	my ($obj, $name) = @_;	875	my ($obj, $name) = @_;
627		876
…		…
642	";	891	";
643	die if $@;	892	die if $@;
644	}	893	}
645		894
646	our $override;	895	our $override;
647	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?
648		897
649	sub override {	898	sub override {
650	$override = 1;	899	$override = 1;
651	@invoke_results = ();	900	@INVOKE_RESULTS = (@_);
652	}	901	}
653		902
654	sub do_invoke {	903	sub do_invoke {
655	my $event = shift;	904	my $event = shift;
656	my $callbacks = shift;	905	my $callbacks = shift;
657		906
658	@invoke_results = ();	907	@INVOKE_RESULTS = ();
659		908
660	local $override;	909	local $override;
661		910
662	for (@$callbacks) {	911	for (@$callbacks) {
663	eval { &{$_->[1]} };	912	eval { &{$_->[1]} };
…		…
680		929
681	Generate an object-specific event with the given arguments.	930	Generate an object-specific event with the given arguments.
682		931
683	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
684	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
685	results (if you must, access C<@cf::invoke_results> directly).	934	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686		935
687	=back	936	=back
688		937
689	=cut	938	=cut
690		939
691	#############################################################################	940	#############################################################################
692	# 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	}
693		953
694	sub reattach {	954	sub reattach {
695	# basically do the same as instantiate, without calling instantiate	955	# basically do the same as instantiate, without calling instantiate
696	my ($obj) = @_;	956	my ($obj) = @_;
697		957
…		…
750	$filename, length $$rdata, scalar @$objs;	1010	$filename, length $$rdata, scalar @$objs;
751		1011
752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1012	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753	chmod SAVE_MODE, $fh;	1013	chmod SAVE_MODE, $fh;
754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1014	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
755	aio_fsync $fh;	1015	aio_fsync $fh if $cf::USE_FSYNC;
756	close $fh;	1016	close $fh;
757		1017
758	if (@$objs) {	1018	if (@$objs) {
759	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) {
760	chmod SAVE_MODE, $fh;	1020	chmod SAVE_MODE, $fh;
761	my $data = Storable::nfreeze { version => 1, objs => $objs };	1021	my $data = Storable::nfreeze { version => 1, objs => $objs };
762	aio_write $fh, 0, (length $data), $data, 0;	1022	aio_write $fh, 0, (length $data), $data, 0;
763	aio_fsync $fh;	1023	aio_fsync $fh if $cf::USE_FSYNC;
764	close $fh;	1024	close $fh;
765	aio_rename "$filename.pst~", "$filename.pst";	1025	aio_rename "$filename.pst~", "$filename.pst";
766	}	1026	}
767	} else {	1027	} else {
768	aio_unlink "$filename.pst";	1028	aio_unlink "$filename.pst";
…		…
800	or return;	1060	or return;
801	$av = eval { (Storable::thaw $av)->{objs} };	1061	$av = eval { (Storable::thaw $av)->{objs} };
802	}	1062	}
803		1063
804	warn sprintf "loading %s (%d)\n",	1064	warn sprintf "loading %s (%d)\n",
805	$filename, length $data, scalar @{$av || []};#d#	1065	$filename, length $data, scalar @{$av || []};
806	return ($data, $av);	1066	return ($data, $av);
807	}	1067	}
		1068
		1069	=head2 COMMAND CALLBACKS
		1070
		1071	=over 4
		1072
		1073	=cut
808		1074
809	#############################################################################	1075	#############################################################################
810	# command handling &c	1076	# command handling &c
811		1077
812	=item cf::register_command $name => \&callback($ob,$args);	1078	=item cf::register_command $name => \&callback($ob,$args);
…		…
825	push @{ $COMMAND{$name} }, [$caller, $cb];	1091	push @{ $COMMAND{$name} }, [$caller, $cb];
826	}	1092	}
827		1093
828	=item cf::register_extcmd $name => \&callback($pl,$packet);	1094	=item cf::register_extcmd $name => \&callback($pl,$packet);
829		1095
830	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.
831		1101
832	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
833	called.	1103	called.
834		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
835	=cut	1116	=cut
836		1117
837	sub register_extcmd {	1118	sub register_extcmd {
838	my ($name, $cb) = @_;	1119	my ($name, $cb) = @_;
839		1120
840	$EXTCMD{$name} = $cb;	1121	$EXTCMD{$name} = $cb;
		1122	}
		1123
		1124	sub register_exticmd {
		1125	my ($name, $cb) = @_;
		1126
		1127	$EXTICMD{$name} = $cb;
841	}	1128	}
842		1129
843	cf::player->attach (	1130	cf::player->attach (
844	on_command => sub {	1131	on_command => sub {
845	my ($pl, $name, $params) = @_;	1132	my ($pl, $name, $params) = @_;
…		…
854	cf::override;	1141	cf::override;
855	},	1142	},
856	on_extcmd => sub {	1143	on_extcmd => sub {
857	my ($pl, $buf) = @_;	1144	my ($pl, $buf) = @_;
858		1145
859	my $msg = eval { from_json $buf };	1146	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860		1147
861	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
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1156	if (my $cb = $EXTCMD{$type}) {
863	if (my %reply = $cb->($pl, $msg)) {	1157	@reply = $cb->($pl, @payload);
864	$pl->ext_reply ($msg->{msgid}, %reply);
865	}
866	}	1158	}
		1159
		1160	$pl->ext_reply ($reply, @reply)
		1161	if $reply;
		1162
867	} else {	1163	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1164	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869	}	1165	}
870		1166
871	cf::override;	1167	cf::override;
872	},	1168	},
873	);	1169	);
874		1170
875	sub load_extension {
876	my ($path) = @_;
877
878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
879	my $base = $1;
880	my $pkg = $1;
881	$pkg =~ s/[^[:word:]]/_/g;
882	$pkg = "ext::$pkg";
883
884	warn "... loading '$path' into '$pkg'\n";
885
886	open my $fh, "<:utf8", $path
887	or die "$path: $!";
888
889	my $source =
890	"package $pkg; use strict; use utf8;\n"
891	. "#line 1 \"$path\"\n{\n"
892	. (do { local $/; <$fh> })
893	. "\n};\n1";
894
895	unless (eval $source) {
896	my $msg = $@ ? "$path: $@\n"
897	: "extension disabled.\n";
898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899	warn $@;
900	warn "mandatory extension failed to load, exiting.\n";
901	exit 1;
902	}
903	die $@;
904	}
905
906	push @EXTS, $pkg;
907	}
908
909	sub load_extensions {	1171	sub load_extensions {
		1172	cf::sync_job {
		1173	my %todo;
		1174
910	for my $ext (<$LIBDIR/*.ext>) {	1175	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1176	next unless -r $path;
912	eval {	1177
913	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;
914	1	1235	}
915	} or warn "$ext not loaded: $@";	1236
		1237	skip:
		1238	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1239	unless $progress;
		1240	}
916	}	1241	};
917	}	1242	}
918		1243
919	#############################################################################	1244	#############################################################################
920		1245
		1246	=back
		1247
921	=head2 CORE EXTENSIONS	1248	=head2 CORE EXTENSIONS
922		1249
923	Functions and methods that extend core crossfire objects.	1250	Functions and methods that extend core crossfire objects.
924		1251
925	=cut	1252	=cut
…		…
937	Returns the given player object, loading it if necessary (might block).	1264	Returns the given player object, loading it if necessary (might block).
938		1265
939	=cut	1266	=cut
940		1267
941	sub playerdir($) {	1268	sub playerdir($) {
942	cf::localdir	1269	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1270	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1271	}
948		1272
949	sub path($) {	1273	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1274	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1275
952	(playerdir $login) . "/$login.pl"	1276	(playerdir $login) . "/playerdata"
953	}	1277	}
954		1278
955	sub find_active($) {	1279	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1280	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1281	and $cf::PLAYER{$_[0]}->active
…		…
970	my $login = $_[0];	1294	my $login = $_[0];
971		1295
972	my $guard = cf::lock_acquire "user_find:$login";	1296	my $guard = cf::lock_acquire "user_find:$login";
973		1297
974	$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
975	my $pl = load_pl path $login	1306	my $pl = load_pl path $login
976	or return;	1307	or return;
977	$cf::PLAYER{$login} = $pl	1308	$cf::PLAYER{$login} = $pl
978	}	1309	}
979	}	1310	}
…		…
1007	$cf::PLAYER{$login} = $self;	1338	$cf::PLAYER{$login} = $self;
1008		1339
1009	$self	1340	$self
1010	}	1341	}
1011		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
1012	=item $pl->quit_character	1353	=item $pl->quit_character
1013		1354
1014	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
1015	be destroyed. May block for a long time.	1356	be destroyed. May block for a long time.
1016		1357
1017	=cut	1358	=cut
1018		1359
1019	sub quit_character {	1360	sub quit_character {
1020	my ($pl) = @_;	1361	my ($pl) = @_;
		1362
		1363	my $name = $pl->ob->name;
1021		1364
1022	$pl->{deny_save} = 1;	1365	$pl->{deny_save} = 1;
1023	$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
1024		1367
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1368	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1030	my $path = playerdir $pl;	1373	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1374	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1375	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1376	delete $cf::PLAYER{$pl->ob->name};
1034	$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
1035	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;
1036	}	1399	}
1037		1400
1038	=item cf::player::list_logins	1401	=item cf::player::list_logins
1039		1402
1040	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
1041	while and may block, so not sync_job-capable, ever.	1404	while and may block, so not sync_job-capable, ever.
1042		1405
1043	=cut	1406	=cut
1044		1407
1045	sub list_logins {	1408	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1409	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1410	or return [];
1048		1411
1049	my @logins;	1412	my @logins;
1050		1413
1051	for my $login (@$dirs) {	1414	for my $login (@$dirs) {
…		…
1068	=cut	1431	=cut
1069		1432
1070	sub maps($) {	1433	sub maps($) {
1071	my ($pl) = @_;	1434	my ($pl) = @_;
1072		1435
		1436	$pl = ref $pl ? $pl->ob->name : $pl;
		1437
1073	my $files = aio_readdir playerdir $pl	1438	my $files = aio_readdir playerdir $pl
1074	or return;	1439	or return;
1075		1440
1076	my @paths;	1441	my @paths;
1077		1442
1078	for (@$files) {	1443	for (@$files) {
1079	utf8::decode $_;	1444	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1445	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1446	next unless /^$PATH_SEP/o;
1082		1447
1083	s/\.map$//;	1448	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1449	}
1086		1450
1087	\@paths	1451	\@paths
1088	}	1452	}
1089		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
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1504	=item $player->ext_reply ($msgid, @msg)
1091		1505
1092	Sends an ext reply to the player.	1506	Sends an ext reply to the player.
1093		1507
1094	=cut	1508	=cut
1095		1509
1096	sub ext_reply($$$%) {	1510	sub ext_reply($$@) {
1097	my ($self, $id, %msg) = @_;	1511	my ($self, $id, @msg) = @_;
1098		1512
1099	$msg{msgid} = $id;	1513	$self->ns->ext_reply ($id, @msg)
1100
1101	$self->send ("ext " . cf::to_json \%msg);
1102	}	1514	}
1103		1515
1104	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	}
1105		1556
1106	=back	1557	=back
1107
1108		1558
1109	=head3 cf::map	1559	=head3 cf::map
1110		1560
1111	=over 4	1561	=over 4
1112		1562
…		…
1167	my ($self, $merge) = @_;	1617	my ($self, $merge) = @_;
1168		1618
1169	# we have to keep some variables in memory intact	1619	# we have to keep some variables in memory intact
1170	local $self->{path};	1620	local $self->{path};
1171	local $self->{load_path};	1621	local $self->{load_path};
1172	local $self->{deny_save};
1173	local $self->{deny_reset};
1174		1622
1175	$self->SUPER::thawer_merge ($merge);	1623	$self->SUPER::thawer_merge ($merge);
1176	}	1624	}
1177		1625
1178	sub normalise {	1626	sub normalise {
1179	my ($path, $base) = @_;	1627	my ($path, $base) = @_;
1180		1628
1181	$path = "$path"; # make sure its a string	1629	$path = "$path"; # make sure its a string
		1630
		1631	$path =~ s/\.map$//;
1182		1632
1183	# map plan:	1633	# map plan:
1184	#	1634	#
1185	# /! non-realised random map exit (special hack!)	1635	# /! non-realised random map exit (special hack!)
1186	# {... are special paths that are not being touched	1636	# {... are special paths that are not being touched
…		…
1223	$self->init; # pass $1 etc.	1673	$self->init; # pass $1 etc.
1224	return $self;	1674	return $self;
1225	}	1675	}
1226	}	1676	}
1227		1677
1228	Carp::carp "unable to resolve path '$path' (base '$base').";	1678	Carp::cluck "unable to resolve path '$path' (base '$base').";
1229	()	1679	()
1230	}	1680	}
1231		1681
1232	sub init {	1682	sub init {
1233	my ($self) = @_;	1683	my ($self) = @_;
…		…
1248		1698
1249	# the original (read-only) location	1699	# the original (read-only) location
1250	sub load_path {	1700	sub load_path {
1251	my ($self) = @_;	1701	my ($self) = @_;
1252		1702
1253	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1703	"$MAPDIR/$self->{path}.map"
1254	}	1704	}
1255		1705
1256	# the temporary/swap location	1706	# the temporary/swap location
1257	sub save_path {	1707	sub save_path {
1258	my ($self) = @_;	1708	my ($self) = @_;
1259		1709
1260	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1710	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1261	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1711	"$TMPDIR/$path.map"
1262	}	1712	}
1263		1713
1264	# the unique path, undef == no special unique path	1714	# the unique path, undef == no special unique path
1265	sub uniq_path {	1715	sub uniq_path {
1266	my ($self) = @_;	1716	my ($self) = @_;
1267		1717
1268	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1718	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1269	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1719	"$UNIQUEDIR/$path"
1270	}	1720	}
1271		1721
1272	# and all this just because we cannot iterate over	1722	# and all this just because we cannot iterate over
1273	# all maps in C++...	1723	# all maps in C++...
1274	sub change_all_map_light {	1724	sub change_all_map_light {
…		…
1276		1726
1277	$_->change_map_light ($change)	1727	$_->change_map_light ($change)
1278	for grep $_->outdoor, values %cf::MAP;	1728	for grep $_->outdoor, values %cf::MAP;
1279	}	1729	}
1280		1730
		1731	sub decay_objects {
		1732	my ($self) = @_;
		1733
		1734	return if $self->{deny_reset};
		1735
		1736	$self->do_decay_objects;
		1737	}
		1738
1281	sub unlink_save {	1739	sub unlink_save {
1282	my ($self) = @_;	1740	my ($self) = @_;
1283		1741
1284	utf8::encode (my $save = $self->save_path);	1742	utf8::encode (my $save = $self->save_path);
1285	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1743	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1288		1746
1289	sub load_header_from($) {	1747	sub load_header_from($) {
1290	my ($self, $path) = @_;	1748	my ($self, $path) = @_;
1291		1749
1292	utf8::encode $path;	1750	utf8::encode $path;
1293	aio_open $path, O_RDONLY, 0	1751	#aio_open $path, O_RDONLY, 0
1294	or return;	1752	# or return;
1295		1753
1296	$self->_load_header ($path)	1754	$self->_load_header ($path)
1297	or return;	1755	or return;
1298		1756
1299	$self->{load_path} = $path;	1757	$self->{load_path} = $path;
…		…
1341	$self->load_header_orig	1799	$self->load_header_orig
1342	or return;	1800	or return;
1343	$self->prepare_orig;	1801	$self->prepare_orig;
1344	}	1802	}
1345		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
1346	1	1810	1
1347	}	1811	}
1348		1812
1349	sub find;	1813	sub find;
1350	sub find {	1814	sub find {
…		…
1362	$map->{last_save} = $cf::RUNTIME;	1826	$map->{last_save} = $cf::RUNTIME;
1363		1827
1364	$map->load_header	1828	$map->load_header
1365	or return;	1829	or return;
1366		1830
1367	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1831	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1368	# doing this can freeze the server in a sync job, obviously	1832	# doing this can freeze the server in a sync job, obviously
1369	#$cf::WAIT_FOR_TICK->wait;	1833	#$cf::WAIT_FOR_TICK->wait;
1370	$map->reset;	1834	$map->reset;
1371	undef $guard;	1835	undef $guard;
1372	return find $path;	1836	return find $path;
…		…
1380	sub post_load { }	1844	sub post_load { }
1381		1845
1382	sub load {	1846	sub load {
1383	my ($self) = @_;	1847	my ($self) = @_;
1384		1848
		1849	local $self->{deny_reset} = 1; # loading can take a long time
		1850
1385	my $path = $self->{path};	1851	my $path = $self->{path};
		1852
		1853	{
1386	my $guard = cf::lock_acquire "map_load:$path";	1854	my $guard = cf::lock_acquire "map_load:$path";
1387		1855
1388	return if $self->in_memory != cf::MAP_SWAPPED;	1856	return if $self->in_memory != cf::MAP_SWAPPED;
1389		1857
1390	$self->in_memory (cf::MAP_LOADING);	1858	$self->in_memory (cf::MAP_LOADING);
1391		1859
1392	$self->alloc;	1860	$self->alloc;
1393		1861
1394	$self->pre_load;	1862	$self->pre_load;
1395
1396	$self->_load_objects ($self->{load_path}, 1)
1397	or return;
1398
1399	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1400	if delete $self->{load_original};
1401
1402	if (my $uniq = $self->uniq_path) {
1403	utf8::encode $uniq;
1404	if (aio_open $uniq, O_RDONLY, 0) {
1405	$self->clear_unique_items;
1406	$self->_load_objects ($uniq, 0);
1407	}
1408	}
1409
1410	Coro::cede;
1411
1412	# now do the right thing for maps
1413	$self->link_multipart_objects;
1414
1415	unless ($self->{deny_activate}) {
1416	$self->decay_objects;
1417	$self->fix_auto_apply;
1418	$self->update_buttons;
1419	Coro::cede;	1863	Coro::cede;
1420	$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;
1421	$self->difficulty ($self->estimate_difficulty)	1882	$self->difficulty ($self->estimate_difficulty)
1422	unless $self->difficulty;	1883	unless $self->difficulty;
1423	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;
1424	$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);
1425	}	1900	}
1426		1901
1427	$self->post_load;	1902	$self->post_load;
1428
1429	$self->in_memory (cf::MAP_IN_MEMORY);
1430	}	1903	}
1431		1904
1432	sub customise_for {	1905	sub customise_for {
1433	my ($self, $ob) = @_;	1906	my ($self, $ob) = @_;
1434		1907
1435	return find "~" . $ob->name . "/" . $self->{path}	1908	return find "~" . $ob->name . "/" . $self->{path}
1436	if $self->per_player;	1909	if $self->per_player;
1437		1910
		1911	# return find "?party/" . $ob->name . "/" . $self->{path}
		1912	# if $self->per_party;
		1913
1438	$self	1914	$self
1439	}	1915	}
1440		1916
1441	# 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
1442	sub load_diag {	1918	sub load_neighbours {
1443	my ($map) = @_;	1919	my ($map) = @_;
1444		1920
1445	my @diag; # diagonal neighbours	1921	my @neigh; # diagonal neighbours
1446		1922
1447	for (0 .. 3) {	1923	for (0 .. 3) {
1448	my $neigh = $map->tile_path ($_)	1924	my $neigh = $map->tile_path ($_)
1449	or next;	1925	or next;
1450	$neigh = find $neigh, $map	1926	$neigh = find $neigh, $map
1451	or next;	1927	or next;
1452	$neigh->load;	1928	$neigh->load;
1453		1929
		1930	push @neigh,
1454	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1931	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1455	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1932	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1456	}	1933	}
1457		1934
1458	for (@diag) {	1935	for (grep defined $_->[0], @neigh) {
		1936	my ($path, $origin) = @$_;
1459	my $neigh = find @$_	1937	my $neigh = find $path, $origin
1460	or next;	1938	or next;
1461	$neigh->load;	1939	$neigh->load;
1462	}	1940	}
1463	}	1941	}
1464		1942
…		…
1469	}	1947	}
1470		1948
1471	sub do_load_sync {	1949	sub do_load_sync {
1472	my ($map) = @_;	1950	my ($map) = @_;
1473		1951
		1952	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1953	if $Coro::current == $Coro::main;
		1954
1474	cf::sync_job { $map->load };	1955	cf::sync_job { $map->load };
1475	}	1956	}
1476		1957
1477	our %MAP_PREFETCH;	1958	our %MAP_PREFETCH;
1478	our $MAP_PREFETCHER = undef;	1959	our $MAP_PREFETCHER = undef;
1479		1960
1480	sub find_async {	1961	sub find_async {
1481	my ($path, $origin) = @_;	1962	my ($path, $origin, $load) = @_;
1482		1963
1483	$path = normalise $path, $origin && $origin->{path};	1964	$path = normalise $path, $origin && $origin->{path};
1484		1965
1485	if (my $map = $cf::MAP{$path}) {	1966	if (my $map = $cf::MAP{$path}) {
1486	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	1967	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1487	}	1968	}
1488		1969
1489	undef $MAP_PREFETCH{$path};	1970	$MAP_PREFETCH{$path} |= $load;
		1971
1490	$MAP_PREFETCHER ||= cf::async {	1972	$MAP_PREFETCHER ||= cf::async {
1491	while (%MAP_PREFETCH) {	1973	while (%MAP_PREFETCH) {
1492	for my $path (keys %MAP_PREFETCH) {	1974	while (my ($k, $v) = each %MAP_PREFETCH) {
1493	my $map = find $path	1975	if (my $map = find $k) {
1494	or next;
1495	$map->load;	1976	$map->load if $v;
		1977	}
1496		1978
1497	delete $MAP_PREFETCH{$path};	1979	delete $MAP_PREFETCH{$k};
1498	}	1980	}
1499	}	1981	}
1500	undef $MAP_PREFETCHER;	1982	undef $MAP_PREFETCHER;
1501	};	1983	};
1502	$MAP_PREFETCHER->prio (6);	1984	$MAP_PREFETCHER->prio (6);
…		…
1552		2034
1553	sub reset_at {	2035	sub reset_at {
1554	my ($self) = @_;	2036	my ($self) = @_;
1555		2037
1556	# TODO: safety, remove and allow resettable per-player maps	2038	# TODO: safety, remove and allow resettable per-player maps
1557	return 1e99 if $self->isa ("ext::map_per_player");#d#
1558	return 1e99 if $self->{deny_reset};	2039	return 1e99 if $self->{deny_reset};
1559		2040
1560	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2041	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1561	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;
1562		2043
…		…
1573	my ($self) = @_;	2054	my ($self) = @_;
1574		2055
1575	my $lock = cf::lock_acquire "map_data:$self->{path}";	2056	my $lock = cf::lock_acquire "map_data:$self->{path}";
1576		2057
1577	return if $self->players;	2058	return if $self->players;
1578	return if $self->isa ("ext::map_per_player");#d#
1579		2059
1580	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	}
1581		2071
1582	delete $cf::MAP{$self->path};	2072	delete $cf::MAP{$self->path};
1583		2073
1584	$self->in_memory (cf::MAP_SWAPPED);
1585	$self->clear;	2074	$self->clear;
1586		2075
1587	$_->clear_links_to ($self) for values %cf::MAP;	2076	$_->clear_links_to ($self) for values %cf::MAP;
1588		2077
1589	$self->unlink_save;	2078	$self->unlink_save;
…		…
1608	$cf::MAP{$self->path} = $self;	2097	$cf::MAP{$self->path} = $self;
1609		2098
1610	$self->reset; # polite request, might not happen	2099	$self->reset; # polite request, might not happen
1611	}	2100	}
1612		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
1613	=item cf::map::unique_maps	2138	=item cf::map::unique_maps
1614		2139
1615	Returns an arrayref of paths of all shared maps that have	2140	Returns an arrayref of paths of all shared maps that have
1616	instantiated unique items. May block.	2141	instantiated unique items. May block.
1617		2142
1618	=cut	2143	=cut
1619		2144
1620	sub unique_maps() {	2145	sub unique_maps() {
1621	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2146	[
1622	or return;	2147	map {
1623
1624	my @paths;
1625
1626	for (@$files) {
1627	utf8::decode $_;	2148	utf8::decode $_;
1628	next if /\.pst$/;
1629	next unless /^$PATH_SEP/o;
1630
1631	s/\.map$//;	2149	/\.map$/
1632	push @paths, $_;	2150	? normalise $_
		2151	: ()
		2152	} @{ aio_readdir $UNIQUEDIR or [] }
1633	}	2153	]
1634
1635	\@paths
1636	}	2154	}
1637		2155
1638	package cf;	2156	package cf;
1639		2157
1640	=back	2158	=back
…		…
1686		2204
1687	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2205	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1688		2206
1689	if ($self->{record_replies}) {	2207	if ($self->{record_replies}) {
1690	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2208	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2209
1691	} 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 {
1692	$msg = $npc->name . " says: $msg" if $npc;	2218	$msg = $npc->name . " says: $msg" if $npc;
1693	$self->message ($msg, $flags);	2219	$self->message ($msg, $flags);
		2220	}
1694	}	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 (@_);
1695	}	2232	}
1696		2233
1697	=item $player_object->may ("access")	2234	=item $player_object->may ("access")
1698		2235
1699	Returns wether the given player is authorized to access resource "access"	2236	Returns wether the given player is authorized to access resource "access"
…		…
1731	=cut	2268	=cut
1732		2269
1733	sub link_map {	2270	sub link_map {
1734	unless ($LINK_MAP) {	2271	unless ($LINK_MAP) {
1735	$LINK_MAP = cf::map::find "{link}"	2272	$LINK_MAP = cf::map::find "{link}"
1736	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2273	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1737	$LINK_MAP->load;	2274	$LINK_MAP->load;
1738	}	2275	}
1739		2276
1740	$LINK_MAP	2277	$LINK_MAP
1741	}	2278	}
…		…
1746	$self->deactivate_recursive;	2283	$self->deactivate_recursive;
1747		2284
1748	return if UNIVERSAL::isa $self->map, "ext::map_link";	2285	return if UNIVERSAL::isa $self->map, "ext::map_link";
1749		2286
1750	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2287	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1751	if $self->map;	2288	if $self->map && $self->map->{path} ne "{link}";
1752		2289
1753	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2290	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1754	}	2291	}
1755		2292
1756	sub cf::object::player::leave_link {	2293	sub cf::object::player::leave_link {
1757	my ($self, $map, $x, $y) = @_;	2294	my ($self, $map, $x, $y) = @_;
		2295
		2296	return unless $self->contr->active;
1758		2297
1759	my $link_pos = delete $self->{_link_pos};	2298	my $link_pos = delete $self->{_link_pos};
1760		2299
1761	unless ($map) {	2300	unless ($map) {
1762	# restore original map position	2301	# restore original map position
…		…
1776	# use -1 or undef as default coordinates, not 0, 0	2315	# use -1 or undef as default coordinates, not 0, 0
1777	($x, $y) = ($map->enter_x, $map->enter_y)	2316	($x, $y) = ($map->enter_x, $map->enter_y)
1778	if $x <=0 && $y <= 0;	2317	if $x <=0 && $y <= 0;
1779		2318
1780	$map->load;	2319	$map->load;
1781	$map->load_diag;	2320	$map->load_neighbours;
1782		2321
1783	return unless $self->contr->active;	2322	return unless $self->contr->active;
1784	$self->activate_recursive;	2323	$self->activate_recursive;
		2324
		2325	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1785	$self->enter_map ($map, $x, $y);	2326	$self->enter_map ($map, $x, $y);
1786	}	2327	}
1787		2328
1788	cf::player->attach (	2329	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1789	on_logout => sub {
1790	my ($pl) = @_;
1791		2330
1792	# abort map switching before logout	2331	Moves the player to the given map-path and coordinates by first freezing
1793	if ($pl->ob->{_link_pos}) {	2332	her, loading and preparing them map, calling the provided $check callback
1794	cf::sync_job {	2333	that has to return the map if sucecssful, and then unfreezes the player on
1795	$pl->ob->leave_link	2334	the new (success) or old (failed) map position. In either case, $done will
1796	};	2335	be called at the end of this process.
1797	}
1798	},
1799	on_login => sub {
1800	my ($pl) = @_;
1801		2336
1802	# try to abort aborted map switching on player login :)
1803	# should happen only on crashes
1804	if ($pl->ob->{_link_pos}) {
1805	$pl->ob->enter_link;
1806	(async {
1807	# we need this sleep as the login has a concurrent enter_exit running
1808	# and this sleep increases chances of the player not ending up in scorn
1809	$pl->ob->reply (undef,
1810	"There was an internal problem at your last logout, "
1811	. "the server will try to bring you to your intended destination in a second.",
1812	cf::NDI_RED);
1813	Coro::Timer::sleep 1;
1814	$pl->ob->leave_link;
1815	})->prio (2);
1816	}
1817	},
1818	);
1819
1820	=item $player_object->goto ($path, $x, $y)
1821
1822	=cut	2337	=cut
		2338
		2339	our $GOTOGEN;
1823		2340
1824	sub cf::object::player::goto {	2341	sub cf::object::player::goto {
1825	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;
1826		2346
1827	$self->enter_link;	2347	$self->enter_link;
1828		2348
1829	(async {	2349	(async {
		2350	my $map = eval {
1830	my $map = cf::map::find $path;	2351	my $map = cf::map::find $path;
		2352
		2353	if ($map) {
1831	$map = $map->customise_for ($self) if $map;	2354	$map = $map->customise_for ($self);
1832		2355	$map = $check->($map) if $check && $map;
1833	# warn "entering ", $map->path, " at ($x, $y)\n"	2356	} else {
1834	# if $map;
1835
1836	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2357	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2358	}
1837		2359
		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 $@;
		2366	}
		2367
		2368	if ($gen == $self->{_goto_generation}) {
		2369	delete $self->{_goto_generation};
1838	$self->leave_link ($map, $x, $y);	2370	$self->leave_link ($map, $x, $y);
		2371	}
		2372
		2373	$done->() if $done;
1839	})->prio (1);	2374	})->prio (1);
1840	}	2375	}
1841		2376
1842	=item $player_object->enter_exit ($exit_object)	2377	=item $player_object->enter_exit ($exit_object)
1843		2378
…		…
1872	# that depends on the exit object	2407	# that depends on the exit object
1873		2408
1874	my $rmp = parse_random_map_params $exit->msg;	2409	my $rmp = parse_random_map_params $exit->msg;
1875		2410
1876	if ($exit->map) {	2411	if ($exit->map) {
1877	$rmp->{region} = $exit->map->region_name;	2412	$rmp->{region} = $exit->region->name;
1878	$rmp->{origin_map} = $exit->map->path;	2413	$rmp->{origin_map} = $exit->map->path;
1879	$rmp->{origin_x} = $exit->x;	2414	$rmp->{origin_x} = $exit->x;
1880	$rmp->{origin_y} = $exit->y;	2415	$rmp->{origin_y} = $exit->y;
1881	}	2416	}
1882		2417
1883	$rmp->{random_seed} ||= $exit->random_seed;	2418	$rmp->{random_seed} ||= $exit->random_seed;
1884		2419
1885	my $data = cf::to_json $rmp;	2420	my $data = cf::to_json $rmp;
1886	my $md5 = Digest::MD5::md5_hex $data;	2421	my $md5 = Digest::MD5::md5_hex $data;
1887	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2422	my $meta = "$RANDOMDIR/$md5.meta";
1888		2423
1889	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2424	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1890	aio_write $fh, 0, (length $data), $data, 0;	2425	aio_write $fh, 0, (length $data), $data, 0;
1891	undef $fh;	2426	undef $fh;
1892	aio_rename "$meta~", $meta;	2427	aio_rename "$meta~", $meta;
…		…
1901		2436
1902	return unless $self->type == cf::PLAYER;	2437	return unless $self->type == cf::PLAYER;
1903		2438
1904	if ($exit->slaying eq "/!") {	2439	if ($exit->slaying eq "/!") {
1905	#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
1906	cf::sync_job { prepare_random_map $exit };	2443	cf::sync_job { prepare_random_map $exit };
1907	}	2444	}
1908		2445
1909	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;
1910	my $hp = $exit->stats->hp;	2447	my $hp = $exit->stats->hp;
1911	my $sp = $exit->stats->sp;	2448	my $sp = $exit->stats->sp;
1912		2449
1913	$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);
1914		2455
1915	(async {	2456	(async {
1916	$self->deactivate_recursive; # just to be sure	2457	$self->deactivate_recursive; # just to be sure
1917	unless (eval {	2458	unless (eval {
1918	$self->goto ($slaying, $hp, $sp);	2459	$self->goto ($slaying, $hp, $sp);
1919		2460
1920	1;	2461	1;
1921	}) {	2462	}) {
1922	$self->message ("Something went wrong deep within the crossfire server. "	2463	$self->message ("Something went wrong deep within the crossfire server. "
1923	. "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. "
1924	. "Please report this to the dungeon master!",	2465	. "Please report this to the dungeon master!",
1925	cf::NDI_UNIQUE | cf::NDI_RED);	2466	cf::NDI_UNIQUE | cf::NDI_RED);
1926		2467
1927	warn "ERROR in enter_exit: $@";	2468	warn "ERROR in enter_exit: $@";
1928	$self->leave_link;	2469	$self->leave_link;
1929	}	2470	}
1930	})->prio (1);	2471	})->prio (1);
…		…
1943		2484
1944	sub cf::client::send_drawinfo {	2485	sub cf::client::send_drawinfo {
1945	my ($self, $text, $flags) = @_;	2486	my ($self, $text, $flags) = @_;
1946		2487
1947	utf8::encode $text;	2488	utf8::encode $text;
1948	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2489	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1949	}	2490	}
1950		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	}
1951		2590
1952	=item $success = $client->query ($flags, "text", \&cb)	2591	=item $success = $client->query ($flags, "text", \&cb)
1953		2592
1954	Queues a query to the client, calling the given callback with	2593	Queues a query to the client, calling the given callback with
1955	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>,
1956	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>.
1957		2596
1958	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
1959	reliable at some point in the future.	2598	become reliable at some point in the future.
1960		2599
1961	=cut	2600	=cut
1962		2601
1963	sub cf::client::query {	2602	sub cf::client::query {
1964	my ($self, $flags, $text, $cb) = @_;	2603	my ($self, $flags, $text, $cb) = @_;
…		…
1972	utf8::encode $text;	2611	utf8::encode $text;
1973	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2612	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1974		2613
1975	$self->send_packet ($self->{query_queue}[0][0])	2614	$self->send_packet ($self->{query_queue}[0][0])
1976	if @{ $self->{query_queue} } == 1;	2615	if @{ $self->{query_queue} } == 1;
		2616
		2617	1
1977	}	2618	}
1978		2619
1979	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	},
1980	on_reply => sub {	2626	on_reply => sub {
1981	my ($ns, $msg) = @_;	2627	my ($ns, $msg) = @_;
1982		2628
1983	# this weird shuffling is so that direct followup queries	2629	# this weird shuffling is so that direct followup queries
1984	# get handled first	2630	# get handled first
1985	my $queue = delete $ns->{query_queue}	2631	my $queue = delete $ns->{query_queue}
1986	or return; # be conservative, not sure how that can happen, but we saw a crash here	2632	or return; # be conservative, not sure how that can happen, but we saw a crash here
1987		2633
1988	(shift @$queue)->[1]->($msg);	2634	(shift @$queue)->[1]->($msg);
		2635	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1989		2636
1990	push @{ $ns->{query_queue} }, @$queue;	2637	push @{ $ns->{query_queue} }, @$queue;
1991		2638
1992	if (@{ $ns->{query_queue} } == @$queue) {	2639	if (@{ $ns->{query_queue} } == @$queue) {
1993	if (@$queue) {	2640	if (@$queue) {
…		…
1995	} else {	2642	} else {
1996	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2643	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1997	}	2644	}
1998	}	2645	}
1999	},	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	},
2000	);	2673	);
2001		2674
2002	=item $client->async (\&cb)	2675	=item $client->async (\&cb)
2003		2676
2004	Create a new coroutine, running the specified callback. The coroutine will	2677	Create a new coroutine, running the specified callback. The coroutine will
…		…
2045	our $safe = new Safe "safe";	2718	our $safe = new Safe "safe";
2046	our $safe_hole = new Safe::Hole;	2719	our $safe_hole = new Safe::Hole;
2047		2720
2048	$SIG{FPE} = 'IGNORE';	2721	$SIG{FPE} = 'IGNORE';
2049		2722
2050	$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	));
2051		2728
2052	# here we export the classes and methods available to script code	2729	# here we export the classes and methods available to script code
2053		2730
2054	=pod	2731	=pod
2055		2732
2056	The following fucntions and emthods are available within a safe environment:	2733	The following functions and methods are available within a safe environment:
2057		2734
2058	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
2059	cf::object::player player	2739	cf::object::player
2060	cf::player peaceful	2740	player
2061	cf::map trigger	2741
		2742	cf::player
		2743	peaceful
		2744
		2745	cf::map
		2746	trigger
2062		2747
2063	=cut	2748	=cut
2064		2749
2065	for (	2750	for (
2066	["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)],
2067	["cf::object::player" => qw(player)],	2754	["cf::object::player" => qw(player)],
2068	["cf::player" => qw(peaceful)],	2755	["cf::player" => qw(peaceful)],
2069	["cf::map" => qw(trigger)],	2756	["cf::map" => qw(trigger)],
2070	) {	2757	) {
2071	no strict 'refs';	2758	no strict 'refs';
…		…
2142	=back	2829	=back
2143		2830
2144	=cut	2831	=cut
2145		2832
2146	#############################################################################	2833	#############################################################################
		2834	# the server's init and main functions
2147		2835
2148	=head2 EXTENSION DATABASE SUPPORT	2836	sub load_facedata($) {
		2837	my ($path) = @_;
2149		2838
2150	Crossfire maintains a very simple database for extension use. It can	2839	my $enc = JSON::XS->new->utf8->canonical;
2151	currently store anything that can be serialised using Storable, which
2152	excludes objects.
2153		2840
2154	The parameter C<$family> should best start with the name of the extension	2841	warn "loading facedata from $path\n";
2155	using it, it should be unique.
2156		2842
2157	=over 4	2843	my $facedata;
		2844	0 < aio_load $path, $facedata
		2845	or die "$path: $!";
2158		2846
2159	=item $hashref = cf::db_get $family	2847	$facedata = Coro::Storable::thaw $facedata;
2160		2848
2161	Return a hashref for use by the extension C<$family>, which can be	2849	$facedata->{version} == 2
2162	modified. After modifications, you have to call C<cf::db_dirty> or	2850	or cf::cleanup "$path: version mismatch, cannot proceed.";
2163	C<cf::db_sync>.
2164		2851
2165	=item $value = cf::db_get $family => $key	2852	# patch in the exptable
2166		2853	$facedata->{resource}{"res/exp_table"} = {
2167	Returns a single value from the database	2854	type => FT_RSRC,
2168		2855	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2169	=item cf::db_put $family => $hashref
2170
2171	Stores the given family hashref into the database. Updates are delayed, if
2172	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2173
2174	=item cf::db_put $family => $key => $value
2175
2176	Stores the given C<$value> in the family hash. Updates are delayed, if you
2177	want the data to be synced to disk immediately, use C<cf::db_sync>.
2178
2179	=item cf::db_dirty
2180
2181	Marks the database as dirty, to be updated at a later time.
2182
2183	=item cf::db_sync
2184
2185	Immediately write the database to disk I<if it is dirty>.
2186
2187	=cut
2188
2189	our $DB;
2190
2191	{
2192	my $path = cf::localdir . "/database.pst";
2193
2194	sub db_load() {
2195	$DB = stat $path ? Storable::retrieve $path : { };
2196	}	2856	};
		2857	cf::cede_to_tick;
2197		2858
2198	my $pid;
2199
2200	sub db_save() {
2201	waitpid $pid, 0 if $pid;
2202	if (0 == ($pid = fork)) {
2203	$DB->{_meta}{version} = 1;
2204	Storable::nstore $DB, "$path~";
2205	rename "$path~", $path;
2206	cf::_exit 0 if defined $pid;
2207	}
2208	}	2859	{
		2860	my $faces = $facedata->{faceinfo};
2209		2861
2210	my $dirty;	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};
2211		2868
2212	sub db_sync() {	2869	cf::cede_to_tick;
2213	db_save if $dirty;
2214	undef $dirty;
2215	}
2216
2217	my $idle = Event->idle (
2218	reentrant => 0,
2219	min => 10,
2220	max => 20,
2221	repeat => 0,
2222	data => WF_AUTOCANCEL,
2223	cb => \&db_sync,
2224	);
2225
2226	sub db_dirty() {
2227	$dirty = 1;
2228	$idle->start;
2229	}
2230
2231	sub db_get($;$) {
2232	@_ >= 2
2233	? $DB->{$_[0]}{$_[1]}
2234	: ($DB->{$_[0]} ||= { })
2235	}
2236
2237	sub db_put($$;$) {
2238	if (@_ >= 3) {
2239	$DB->{$_[0]}{$_[1]} = $_[2];
2240	} else {
2241	$DB->{$_[0]} = $_[1];
2242	}
2243	db_dirty;
2244	}
2245
2246	cf::global->attach (
2247	prio => 10000,
2248	on_cleanup => sub {
2249	db_sync;
2250	},	2870	}
2251	);
2252	}
2253		2871
2254	#############################################################################	2872	while (my ($face, $info) = each %$faces) {
2255	# the server's main()	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"
		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;
		3002	}
2256		3003
2257	sub cfg_load {	3004	sub cfg_load {
2258	open my $fh, "<:utf8", cf::confdir . "/config"	3005	open my $fh, "<:utf8", "$CONFDIR/config"
2259	or return;	3006	or return;
2260		3007
2261	local $/;	3008	local $/;
2262	*CFG = YAML::Syck::Load <$fh>;	3009	*CFG = YAML::Syck::Load <$fh>;
2263		3010
…		…
2283	Event::one_event;	3030	Event::one_event;
2284	})->prio (Coro::PRIO_MAX);	3031	})->prio (Coro::PRIO_MAX);
2285	};	3032	};
2286		3033
2287	cfg_load;	3034	cfg_load;
2288	db_load;	3035	db_init;
2289	load_extensions;	3036	load_extensions;
2290		3037
2291	$TICK_WATCHER->start;	3038	$TICK_WATCHER->start;
2292	Event::loop;	3039	Event::loop;
2293	}	3040	}
…		…
2308	},	3055	},
2309	);	3056	);
2310	}	3057	}
2311	}	3058	}
2312		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
2313	sub emergency_save() {	3098	sub emergency_save() {
2314	my $freeze_guard = cf::freeze_mainloop;	3099	my $freeze_guard = cf::freeze_mainloop;
2315		3100
2316	warn "enter emergency perl save\n";	3101	warn "enter emergency perl save\n";
2317		3102
…		…
2332	my $map = $cf::MAP{$path} or next;	3117	my $map = $cf::MAP{$path} or next;
2333	$map->valid or next;	3118	$map->valid or next;
2334	$map->save;	3119	$map->save;
2335	}	3120	}
2336	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";
2337	};	3126	};
2338		3127
2339	warn "leave emergency perl save\n";	3128	warn "leave emergency perl save\n";
2340	}	3129	}
2341		3130
		3131	sub post_cleanup {
		3132	my ($make_core) = @_;
		3133
		3134	warn Carp::longmess "post_cleanup backtrace"
		3135	if $make_core;
		3136	}
		3137
2342	sub reload() {	3138	sub do_reload_perl() {
2343	# can/must only be called in main	3139	# can/must only be called in main
2344	if ($Coro::current != $Coro::main) {	3140	if ($Coro::current != $Coro::main) {
2345	warn "can only reload from main coroutine";	3141	warn "can only reload from main coroutine";
2346	return;	3142	return;
2347	}	3143	}
2348		3144
2349	warn "reloading...";	3145	warn "reloading...";
2350		3146
2351	warn "cancelling server ticker";	3147	warn "entering sync_job";
2352	$TICK_WATCHER->cancel;
2353		3148
		3149	cf::sync_job {
		3150	cf::write_runtime; # external watchdog should not bark
2354	cf::emergency_save;	3151	cf::emergency_save;
		3152	cf::write_runtime; # external watchdog should not bark
2355		3153
2356	eval {	3154	warn "syncing database to disk";
		3155	BDB::db_env_txn_checkpoint $DB_ENV;
		3156
2357	# 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
2358
2359	warn "syncing database to disk";
2360	cf::db_sync;
2361		3158
2362	warn "cancelling all WF_AUTOCANCEL watchers";	3159	warn "cancelling all WF_AUTOCANCEL watchers";
2363	for (Event::all_watchers) {	3160	for (Event::all_watchers) {
2364	$_->cancel if $_->data & WF_AUTOCANCEL;	3161	$_->cancel if $_->data & WF_AUTOCANCEL;
2365	}	3162	}
2366		3163
2367	warn "flushing outstanding aio requests";	3164	warn "flushing outstanding aio requests";
2368	for (;;) {	3165	for (;;) {
		3166	BDB::flush;
2369	IO::AIO::flush;	3167	IO::AIO::flush;
2370	Coro::cede;	3168	Coro::cede;
2371	last unless IO::AIO::nreqs;	3169	last unless IO::AIO::nreqs || BDB::nreqs;
2372	warn "iterate...";	3170	warn "iterate...";
2373	}	3171	}
		3172
		3173	++$RELOAD;
2374		3174
2375	warn "cancelling all extension coros";	3175	warn "cancelling all extension coros";
2376	$_->cancel for values %EXT_CORO;	3176	$_->cancel for values %EXT_CORO;
2377	%EXT_CORO = ();	3177	%EXT_CORO = ();
2378		3178
2379	warn "removing commands";	3179	warn "removing commands";
2380	%COMMAND = ();	3180	%COMMAND = ();
2381		3181
2382	warn "removing ext commands";	3182	warn "removing ext/exti commands";
2383	%EXTCMD = ();	3183	%EXTCMD = ();
		3184	%EXTICMD = ();
2384		3185
2385	warn "unloading/nuking all extensions";	3186	warn "unloading/nuking all extensions";
2386	for my $pkg (@EXTS) {	3187	for my $pkg (@EXTS) {
2387	warn "... unloading $pkg";	3188	warn "... unloading $pkg";
2388		3189
…		…
2418	Symbol::delete_package "safe::$_"	3219	Symbol::delete_package "safe::$_"
2419	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);
2420		3221
2421	warn "unloading cf.pm \"a bit\"";	3222	warn "unloading cf.pm \"a bit\"";
2422	delete $INC{"cf.pm"};	3223	delete $INC{"cf.pm"};
		3224	delete $INC{"cf/pod.pm"};
2423		3225
2424	# don't, removes xs symbols, too,	3226	# don't, removes xs symbols, too,
2425	# and global variables created in xs	3227	# and global variables created in xs
2426	#Symbol::delete_package __PACKAGE__;	3228	#Symbol::delete_package __PACKAGE__;
2427		3229
…		…
2431	require cf;	3233	require cf;
2432	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3234	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2433		3235
2434	warn "loading config and database again";	3236	warn "loading config and database again";
2435	cf::cfg_load;	3237	cf::cfg_load;
2436	cf::db_load;
2437		3238
2438	warn "loading extensions";	3239	warn "loading extensions";
2439	cf::load_extensions;	3240	cf::load_extensions;
2440		3241
2441	warn "reattaching attachments to objects/players";	3242	warn "reattaching attachments to objects/players";
2442	_global_reattach;	3243	_global_reattach; # objects, sockets
2443	warn "reattaching attachments to maps";	3244	warn "reattaching attachments to maps";
2444	reattach $_ for values %MAP;	3245	reattach $_ for values %MAP;
		3246	warn "reattaching attachments to players";
		3247	reattach $_ for values %PLAYER;
2445		3248
2446	warn "restarting server ticker";	3249	warn "leaving sync_job";
2447		3250
2448	$TICK_WATCHER->start;	3251	1
2449	};	3252	} or do {
2450
2451	if ($@) {
2452	warn $@;	3253	warn $@;
2453	warn "error while reloading, exiting.";	3254	warn "error while reloading, exiting.";
2454	exit 1;	3255	exit 1;
2455	}	3256	};
2456		3257
2457	warn "reloaded";	3258	warn "reloaded";
2458	};	3259	};
2459		3260
2460	our $RELOAD_WATCHER; # used only during reload	3261	our $RELOAD_WATCHER; # used only during reload
2461		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
2462	register_command "reload" => sub {	3278	register_command "reload" => sub {
2463	my ($who, $arg) = @_;	3279	my ($who, $arg) = @_;
2464		3280
2465	if ($who->flag (FLAG_WIZ)) {	3281	if ($who->flag (FLAG_WIZ)) {
2466	$who->message ("reloading server.");	3282	$who->message ("reloading server.");
2467		3283	async { reload_perl };
2468	# doing reload synchronously and two reloads happen back-to-back,
2469	# coro crashes during coro_state_free->destroy here.
2470
2471	$RELOAD_WATCHER ||= Event->timer (
2472	reentrant => 0,
2473	after => 0,
2474	data => WF_AUTOCANCEL,
2475	cb => sub {
2476	reload;
2477	undef $RELOAD_WATCHER;
2478	},
2479	);
2480	}	3284	}
2481	};	3285	};
2482		3286
2483	unshift @INC, $LIBDIR;	3287	unshift @INC, $LIBDIR;
2484		3288
2485	my $bug_warning = 0;	3289	my $bug_warning = 0;
2486		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;
2487	$TICK_WATCHER = Event->timer (	3314	$TICK_WATCHER = Event->timer (
2488	reentrant => 0,	3315	reentrant => 0,
2489	parked => 1,	3316	parked => 1,
2490	prio => 0,	3317	prio => 0,
2491	at => $NEXT_TICK || $TICK,	3318	at => $NEXT_TICK || $TICK,
…		…
2495	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"
2496	unless ++$bug_warning > 10;	3323	unless ++$bug_warning > 10;
2497	return;	3324	return;
2498	}	3325	}
2499		3326
2500	$NOW = Event::time;	3327	$NOW = $tick_start = Event::time;
2501		3328
2502	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
2503	$RUNTIME += $TICK;	3354	$RUNTIME += $TICK;
2504	$NEXT_TICK += $TICK;	3355	$NEXT_TICK += $TICK;
2505		3356
2506	$WAIT_FOR_TICK->broadcast;	3357	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2507	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3358	$NEXT_RUNTIME_WRITE = $NOW + 10;
2508		3359	Coro::async_pool {
2509	Event::sweep;	3360	write_runtime
2510	Coro::cede_notself;	3361	or warn "ERROR: unable to write runtime file: $!";
		3362	};
2511		3363	}
		3364
2512	# my $AFTER = Event::time;	3365	# my $AFTER = Event::time;
2513	# warn $AFTER - $NOW;#d#	3366	# warn $AFTER - $NOW;#d#
2514		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
2515	# 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
2516	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3378	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2517		3379
2518	$TICK_WATCHER->at ($NEXT_TICK);	3380	$TICK_WATCHER->at ($NEXT_TICK);
2519	$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
2520	},	3389	},
2521	);	3390	);
2522		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;
2523	IO::AIO::max_poll_time $TICK * 0.1;	3446	IO::AIO::max_poll_time $TICK * 0.1;
2524
2525	undef $Coro::AIO::WATCHER;
2526	$AIO_POLL_WATCHER = Event->io (	3447	$AIO_POLL_WATCHER = Event->io (
2527	reentrant => 0,	3448	reentrant => 0,
		3449	data => WF_AUTOCANCEL,
2528	fd => IO::AIO::poll_fileno,	3450	fd => IO::AIO::poll_fileno,
2529	poll => 'r',	3451	poll => 'r',
2530	prio => 6,	3452	prio => 6,
2531	data => WF_AUTOCANCEL,
2532	cb => \&IO::AIO::poll_cb,	3453	cb => \&IO::AIO::poll_cb,
2533	);	3454	);
		3455	}
2534		3456
2535	$WRITE_RUNTIME_WATCHER = Event->timer (	3457	my $_log_backtrace;
2536	reentrant => 0,	3458
2537	data => WF_AUTOCANCEL,	3459	sub _log_backtrace {
2538	after => 1,	3460	my ($msg, @addr) = @_;
2539	interval => 10,	3461
2540	prio => 6, # keep it lowest so it acts like a watchdog	3462	$msg =~ s/\n//;
2541	cb => Coro::unblock_sub {	3463
2542	write_runtime	3464	# limit the # of concurrent backtraces
2543	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";
2544	},	3492	}
2545	);	3493	}
		3494
		3495	# load additional modules
		3496	use cf::pod;
2546		3497
2547	END { cf::emergency_save }	3498	END { cf::emergency_save }
2548		3499
2549	1	3500	1
2550		3501

Diff Legend

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