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.188 by root, Sat Jan 20 23:30:16 2007 UTC vs.
Revision 1.336 by root, Tue Aug 21 00:31:18 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.4 ();	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
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1154	if (my $cb = $EXTCMD{$type}) {
863	if (my %reply = $cb->($pl, $msg)) {	1155	my @reply = $cb->($pl, @payload);
		1156
864	$pl->ext_reply ($msg->{msgid}, %reply);	1157	$pl->ext_reply ($reply, @reply)
865	}	1158	if $reply;
866	}	1159	}
867	} else {	1160	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1161	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869	}	1162	}
870		1163
871	cf::override;	1164	cf::override;
872	},	1165	},
873	);	1166	);
874		1167
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 {	1168	sub load_extensions {
		1169	cf::sync_job {
		1170	my %todo;
		1171
910	for my $ext (<$LIBDIR/*.ext>) {	1172	for my $path (<$LIBDIR/*.ext>) {
911	next unless -r $ext;	1173	next unless -r $path;
912	eval {	1174
913	load_extension $ext;	1175	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1176	my $base = $1;
		1177	my $pkg = $1;
		1178	$pkg =~ s/[^[:word:]]/_/g;
		1179	$pkg = "ext::$pkg";
		1180
		1181	open my $fh, "<:utf8", $path
		1182	or die "$path: $!";
		1183
		1184	my $source = do { local $/; <$fh> };
		1185
		1186	my %ext = (
		1187	path => $path,
		1188	base => $base,
		1189	pkg => $pkg,
		1190	);
		1191
		1192	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1193	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1194
		1195	$ext{source} =
		1196	"package $pkg; use strict; use utf8;\n"
		1197	. "#line 1 \"$path\"\n{\n"
		1198	. $source
		1199	. "\n};\n1";
		1200
		1201	$todo{$base} = \%ext;
		1202	}
		1203
		1204	my %done;
		1205	while (%todo) {
		1206	my $progress;
		1207
		1208	while (my ($k, $v) = each %todo) {
		1209	for (split /,\s*/, $v->{meta}{depends}) {
		1210	goto skip
		1211	unless exists $done{$_};
		1212	}
		1213
		1214	warn "... loading '$k' into '$v->{pkg}'\n";
		1215
		1216	unless (eval $v->{source}) {
		1217	my $msg = $@ ? "$v->{path}: $@\n"
		1218	: "$v->{base}: extension inactive.\n";
		1219
		1220	if (exists $v->{meta}{mandatory}) {
		1221	warn $msg;
		1222	warn "mandatory extension failed to load, exiting.\n";
		1223	exit 1;
		1224	}
		1225
		1226	warn $msg;
		1227	}
		1228
		1229	$done{$k} = delete $todo{$k};
		1230	push @EXTS, $v->{pkg};
		1231	$progress = 1;
914	1	1232	}
915	} or warn "$ext not loaded: $@";	1233
		1234	skip:
		1235	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1236	unless $progress;
		1237	}
916	}	1238	};
917	}	1239	}
918		1240
919	#############################################################################	1241	#############################################################################
920		1242
		1243	=back
		1244
921	=head2 CORE EXTENSIONS	1245	=head2 CORE EXTENSIONS
922		1246
923	Functions and methods that extend core crossfire objects.	1247	Functions and methods that extend core crossfire objects.
924		1248
925	=cut	1249	=cut
…		…
937	Returns the given player object, loading it if necessary (might block).	1261	Returns the given player object, loading it if necessary (might block).
938		1262
939	=cut	1263	=cut
940		1264
941	sub playerdir($) {	1265	sub playerdir($) {
942	cf::localdir	1266	"$PLAYERDIR/"
943	. "/"
944	. cf::playerdir
945	. "/"
946	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1267	. (ref $_[0] ? $_[0]->ob->name : $_[0])
947	}	1268	}
948		1269
949	sub path($) {	1270	sub path($) {
950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1271	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951		1272
952	(playerdir $login) . "/$login.pl"	1273	(playerdir $login) . "/playerdata"
953	}	1274	}
954		1275
955	sub find_active($) {	1276	sub find_active($) {
956	$cf::PLAYER{$_[0]}	1277	$cf::PLAYER{$_[0]}
957	and $cf::PLAYER{$_[0]}->active	1278	and $cf::PLAYER{$_[0]}->active
…		…
970	my $login = $_[0];	1291	my $login = $_[0];
971		1292
972	my $guard = cf::lock_acquire "user_find:$login";	1293	my $guard = cf::lock_acquire "user_find:$login";
973		1294
974	$cf::PLAYER{$_[0]} || do {	1295	$cf::PLAYER{$_[0]} || do {
		1296	# rename old playerfiles to new ones
		1297	#TODO: remove when no longer required
		1298	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1299	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1300	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1301	aio_unlink +(playerdir $login) . "/$login.pl";
		1302
975	my $pl = load_pl path $login	1303	my $pl = load_pl path $login
976	or return;	1304	or return;
977	$cf::PLAYER{$login} = $pl	1305	$cf::PLAYER{$login} = $pl
978	}	1306	}
979	}	1307	}
…		…
1007	$cf::PLAYER{$login} = $self;	1335	$cf::PLAYER{$login} = $self;
1008		1336
1009	$self	1337	$self
1010	}	1338	}
1011		1339
		1340	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1341
		1342	=cut
		1343
		1344	sub send_msg {
		1345	my $ns = shift->ns
		1346	or return;
		1347	$ns->send_msg (@_);
		1348	}
		1349
1012	=item $pl->quit_character	1350	=item $pl->quit_character
1013		1351
1014	Nukes the player without looking back. If logged in, the connection will	1352	Nukes the player without looking back. If logged in, the connection will
1015	be destroyed. May block for a long time.	1353	be destroyed. May block for a long time.
1016		1354
1017	=cut	1355	=cut
1018		1356
1019	sub quit_character {	1357	sub quit_character {
1020	my ($pl) = @_;	1358	my ($pl) = @_;
		1359
		1360	my $name = $pl->ob->name;
1021		1361
1022	$pl->{deny_save} = 1;	1362	$pl->{deny_save} = 1;
1023	$pl->password ("*"); # this should lock out the player until we nuked the dir	1363	$pl->password ("*"); # this should lock out the player until we nuked the dir
1024		1364
1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1365	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1030	my $path = playerdir $pl;	1370	my $path = playerdir $pl;
1031	my $temp = "$path~$cf::RUNTIME~deleting~";	1371	my $temp = "$path~$cf::RUNTIME~deleting~";
1032	aio_rename $path, $temp;	1372	aio_rename $path, $temp;
1033	delete $cf::PLAYER{$pl->ob->name};	1373	delete $cf::PLAYER{$pl->ob->name};
1034	$pl->destroy;	1374	$pl->destroy;
		1375
		1376	my $prefix = qr<^~\Q$name\E/>;
		1377
		1378	# nuke player maps
		1379	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1380
1035	IO::AIO::aio_rmtree $temp;	1381	IO::AIO::aio_rmtree $temp;
		1382	}
		1383
		1384	=item $pl->kick
		1385
		1386	Kicks a player out of the game. This destroys the connection.
		1387
		1388	=cut
		1389
		1390	sub kick {
		1391	my ($pl, $kicker) = @_;
		1392
		1393	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1394	$pl->killer ("kicked");
		1395	$pl->ns->destroy;
1036	}	1396	}
1037		1397
1038	=item cf::player::list_logins	1398	=item cf::player::list_logins
1039		1399
1040	Returns am arrayref of all valid playernames in the system, can take a	1400	Returns am arrayref of all valid playernames in the system, can take a
1041	while and may block, so not sync_job-capable, ever.	1401	while and may block, so not sync_job-capable, ever.
1042		1402
1043	=cut	1403	=cut
1044		1404
1045	sub list_logins {	1405	sub list_logins {
1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1406	my $dirs = aio_readdir $PLAYERDIR
1047	or return [];	1407	or return [];
1048		1408
1049	my @logins;	1409	my @logins;
1050		1410
1051	for my $login (@$dirs) {	1411	for my $login (@$dirs) {
…		…
1068	=cut	1428	=cut
1069		1429
1070	sub maps($) {	1430	sub maps($) {
1071	my ($pl) = @_;	1431	my ($pl) = @_;
1072		1432
		1433	$pl = ref $pl ? $pl->ob->name : $pl;
		1434
1073	my $files = aio_readdir playerdir $pl	1435	my $files = aio_readdir playerdir $pl
1074	or return;	1436	or return;
1075		1437
1076	my @paths;	1438	my @paths;
1077		1439
1078	for (@$files) {	1440	for (@$files) {
1079	utf8::decode $_;	1441	utf8::decode $_;
1080	next if /\.(?:pl|pst)$/;	1442	next if /\.(?:pl|pst)$/;
1081	next unless /^$PATH_SEP/o;	1443	next unless /^$PATH_SEP/o;
1082		1444
1083	s/\.map$//;	1445	push @paths, cf::map::normalise "~$pl/$_";
1084	push @paths, "~" . $pl->ob->name . "/" . $_;
1085	}	1446	}
1086		1447
1087	\@paths	1448	\@paths
1088	}	1449	}
1089		1450
		1451	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1452
		1453	Expand crossfire pod fragments into protocol xml.
		1454
		1455	=cut
		1456
		1457	sub expand_cfpod {
		1458	((my $self), (local $_)) = @_;
		1459
		1460	# escape & and <
		1461	s/&/&amp;/g;
		1462	s/(?<![BIUGH])</&lt;/g;
		1463
		1464	# this is buggy, it needs to properly take care of nested <'s
		1465
		1466	1 while
		1467	# replace B<>, I<>, U<> etc.
		1468	s/B<([^\>]*)>/<b>$1<\/b>/
		1469	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1470	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1471	# replace G<male|female> tags
		1472	|| s{G<([^>|]*)\|([^>]*)>}{
		1473	$self->gender ? $2 : $1
		1474	}ge
		1475	# replace H<hint text>
		1476	|| s{H<([^\>]*)>}
		1477	{
		1478	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1479	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1480	"")
		1481	[$self->{hintmode}]
		1482	}ge;
		1483
		1484	# create single paragraphs (very hackish)
		1485	s/(?<=\S)\n(?=\w)/ /g;
		1486
		1487	# compress some whitespace
		1488	s/\s+\n/\n/g; # ws line-ends
		1489	s/\n\n+/\n/g; # double lines
		1490	s/^\n+//; # beginning lines
		1491	s/\n+$//; # ending lines
		1492
		1493	$_
		1494	}
		1495
		1496	sub hintmode {
		1497	$_[0]{hintmode} = $_[1] if @_ > 1;
		1498	$_[0]{hintmode}
		1499	}
		1500
1090	=item $player->ext_reply ($msgid, $msgtype, %msg)	1501	=item $player->ext_reply ($msgid, @msg)
1091		1502
1092	Sends an ext reply to the player.	1503	Sends an ext reply to the player.
1093		1504
1094	=cut	1505	=cut
1095		1506
1096	sub ext_reply($$$%) {	1507	sub ext_reply($$@) {
1097	my ($self, $id, %msg) = @_;	1508	my ($self, $id, @msg) = @_;
1098		1509
1099	$msg{msgid} = $id;	1510	$self->ns->ext_reply ($id, @msg)
1100
1101	$self->send ("ext " . cf::to_json \%msg);
1102	}	1511	}
1103		1512
1104	package cf;	1513	=item $player->ext_msg ($type, @msg)
		1514
		1515	Sends an ext event to the client.
		1516
		1517	=cut
		1518
		1519	sub ext_msg($$@) {
		1520	my ($self, $type, @msg) = @_;
		1521
		1522	$self->ns->ext_msg ($type, @msg);
		1523	}
		1524
		1525	=head3 cf::region
		1526
		1527	=over 4
		1528
		1529	=cut
		1530
		1531	package cf::region;
		1532
		1533	=item cf::region::find_by_path $path
		1534
		1535	Tries to decuce the likely region for a map knowing only its path.
		1536
		1537	=cut
		1538
		1539	sub find_by_path($) {
		1540	my ($path) = @_;
		1541
		1542	my ($match, $specificity);
		1543
		1544	for my $region (list) {
		1545	if ($region->{match} && $path =~ $region->{match}) {
		1546	($match, $specificity) = ($region, $region->specificity)
		1547	if $region->specificity > $specificity;
		1548	}
		1549	}
		1550
		1551	$match
		1552	}
1105		1553
1106	=back	1554	=back
1107
1108		1555
1109	=head3 cf::map	1556	=head3 cf::map
1110		1557
1111	=over 4	1558	=over 4
1112		1559
…		…
1167	my ($self, $merge) = @_;	1614	my ($self, $merge) = @_;
1168		1615
1169	# we have to keep some variables in memory intact	1616	# we have to keep some variables in memory intact
1170	local $self->{path};	1617	local $self->{path};
1171	local $self->{load_path};	1618	local $self->{load_path};
1172	local $self->{deny_save};
1173	local $self->{deny_reset};
1174		1619
1175	$self->SUPER::thawer_merge ($merge);	1620	$self->SUPER::thawer_merge ($merge);
1176	}	1621	}
1177		1622
1178	sub normalise {	1623	sub normalise {
1179	my ($path, $base) = @_;	1624	my ($path, $base) = @_;
		1625
		1626	$path = "$path"; # make sure its a string
		1627
		1628	$path =~ s/\.map$//;
1180		1629
1181	# map plan:	1630	# map plan:
1182	#	1631	#
1183	# /! non-realised random map exit (special hack!)	1632	# /! non-realised random map exit (special hack!)
1184	# {... are special paths that are not being touched	1633	# {... are special paths that are not being touched
…		…
1221	$self->init; # pass $1 etc.	1670	$self->init; # pass $1 etc.
1222	return $self;	1671	return $self;
1223	}	1672	}
1224	}	1673	}
1225		1674
1226	Carp::carp "unable to resolve path '$path'.";	1675	Carp::cluck "unable to resolve path '$path' (base '$base').";
1227	()	1676	()
1228	}	1677	}
1229		1678
1230	sub init {	1679	sub init {
1231	my ($self) = @_;	1680	my ($self) = @_;
…		…
1246		1695
1247	# the original (read-only) location	1696	# the original (read-only) location
1248	sub load_path {	1697	sub load_path {
1249	my ($self) = @_;	1698	my ($self) = @_;
1250		1699
1251	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1700	"$MAPDIR/$self->{path}.map"
1252	}	1701	}
1253		1702
1254	# the temporary/swap location	1703	# the temporary/swap location
1255	sub save_path {	1704	sub save_path {
1256	my ($self) = @_;	1705	my ($self) = @_;
1257		1706
1258	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1707	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1259	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1708	"$TMPDIR/$path.map"
1260	}	1709	}
1261		1710
1262	# the unique path, undef == no special unique path	1711	# the unique path, undef == no special unique path
1263	sub uniq_path {	1712	sub uniq_path {
1264	my ($self) = @_;	1713	my ($self) = @_;
1265		1714
1266	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1715	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1267	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1716	"$UNIQUEDIR/$path"
1268	}	1717	}
1269		1718
1270	# and all this just because we cannot iterate over	1719	# and all this just because we cannot iterate over
1271	# all maps in C++...	1720	# all maps in C++...
1272	sub change_all_map_light {	1721	sub change_all_map_light {
…		…
1274		1723
1275	$_->change_map_light ($change)	1724	$_->change_map_light ($change)
1276	for grep $_->outdoor, values %cf::MAP;	1725	for grep $_->outdoor, values %cf::MAP;
1277	}	1726	}
1278		1727
		1728	sub decay_objects {
		1729	my ($self) = @_;
		1730
		1731	return if $self->{deny_reset};
		1732
		1733	$self->do_decay_objects;
		1734	}
		1735
1279	sub unlink_save {	1736	sub unlink_save {
1280	my ($self) = @_;	1737	my ($self) = @_;
1281		1738
1282	utf8::encode (my $save = $self->save_path);	1739	utf8::encode (my $save = $self->save_path);
1283	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1740	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1286		1743
1287	sub load_header_from($) {	1744	sub load_header_from($) {
1288	my ($self, $path) = @_;	1745	my ($self, $path) = @_;
1289		1746
1290	utf8::encode $path;	1747	utf8::encode $path;
1291	aio_open $path, O_RDONLY, 0	1748	#aio_open $path, O_RDONLY, 0
1292	or return;	1749	# or return;
1293		1750
1294	$self->_load_header ($path)	1751	$self->_load_header ($path)
1295	or return;	1752	or return;
1296		1753
1297	$self->{load_path} = $path;	1754	$self->{load_path} = $path;
…		…
1339	$self->load_header_orig	1796	$self->load_header_orig
1340	or return;	1797	or return;
1341	$self->prepare_orig;	1798	$self->prepare_orig;
1342	}	1799	}
1343		1800
		1801	$self->{deny_reset} = 1
		1802	if $self->no_reset;
		1803
		1804	$self->default_region (cf::region::find_by_path $self->{path})
		1805	unless $self->default_region;
		1806
1344	1	1807	1
1345	}	1808	}
1346		1809
1347	sub find;	1810	sub find;
1348	sub find {	1811	sub find {
…		…
1360	$map->{last_save} = $cf::RUNTIME;	1823	$map->{last_save} = $cf::RUNTIME;
1361		1824
1362	$map->load_header	1825	$map->load_header
1363	or return;	1826	or return;
1364		1827
1365	if ($map->should_reset) {	1828	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1366	# doing this can freeze the server in a sync job, obviously	1829	# doing this can freeze the server in a sync job, obviously
1367	#$cf::WAIT_FOR_TICK->wait;	1830	#$cf::WAIT_FOR_TICK->wait;
1368	$map->reset;	1831	$map->reset;
1369	undef $guard;	1832	undef $guard;
1370	$map = find $path	1833	return find $path;
1371	or return;
1372	}	1834	}
1373		1835
1374	$cf::MAP{$path} = $map	1836	$cf::MAP{$path} = $map
1375	}	1837	}
1376	}	1838	}
…		…
1379	sub post_load { }	1841	sub post_load { }
1380		1842
1381	sub load {	1843	sub load {
1382	my ($self) = @_;	1844	my ($self) = @_;
1383		1845
		1846	local $self->{deny_reset} = 1; # loading can take a long time
		1847
1384	my $path = $self->{path};	1848	my $path = $self->{path};
		1849
		1850	{
1385	my $guard = cf::lock_acquire "map_load:$path";	1851	my $guard = cf::lock_acquire "map_load:$path";
1386		1852
1387	return if $self->in_memory != cf::MAP_SWAPPED;	1853	return if $self->in_memory != cf::MAP_SWAPPED;
1388		1854
1389	$self->in_memory (cf::MAP_LOADING);	1855	$self->in_memory (cf::MAP_LOADING);
1390		1856
1391	$self->alloc;	1857	$self->alloc;
1392		1858
1393	$self->pre_load;	1859	$self->pre_load;
1394
1395	$self->_load_objects ($self->{load_path}, 1)
1396	or return;
1397
1398	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1399	if delete $self->{load_original};
1400
1401	if (my $uniq = $self->uniq_path) {
1402	utf8::encode $uniq;
1403	if (aio_open $uniq, O_RDONLY, 0) {
1404	$self->clear_unique_items;
1405	$self->_load_objects ($uniq, 0);
1406	}
1407	}
1408
1409	Coro::cede;
1410
1411	# now do the right thing for maps
1412	$self->link_multipart_objects;
1413
1414	unless ($self->{deny_activate}) {
1415	$self->decay_objects;
1416	$self->fix_auto_apply;
1417	$self->update_buttons;
1418	Coro::cede;	1860	Coro::cede;
1419	$self->set_darkness_map;	1861
		1862	$self->_load_objects ($self->{load_path}, 1)
		1863	or return;
		1864
		1865	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1866	if delete $self->{load_original};
		1867
		1868	if (my $uniq = $self->uniq_path) {
		1869	utf8::encode $uniq;
		1870	if (aio_open $uniq, O_RDONLY, 0) {
		1871	$self->clear_unique_items;
		1872	$self->_load_objects ($uniq, 0);
		1873	}
		1874	}
		1875
		1876	Coro::cede;
		1877	# now do the right thing for maps
		1878	$self->link_multipart_objects;
1420	$self->difficulty ($self->estimate_difficulty)	1879	$self->difficulty ($self->estimate_difficulty)
1421	unless $self->difficulty;	1880	unless $self->difficulty;
1422	Coro::cede;	1881	Coro::cede;
		1882
		1883	unless ($self->{deny_activate}) {
		1884	$self->decay_objects;
		1885	$self->fix_auto_apply;
		1886	$self->update_buttons;
		1887	Coro::cede;
		1888	$self->set_darkness_map;
		1889	Coro::cede;
1423	$self->activate;	1890	$self->activate;
		1891	}
		1892
		1893	$self->{last_save} = $cf::RUNTIME;
		1894	$self->last_access ($cf::RUNTIME);
		1895
		1896	$self->in_memory (cf::MAP_IN_MEMORY);
1424	}	1897	}
1425		1898
1426	$self->post_load;	1899	$self->post_load;
1427
1428	$self->in_memory (cf::MAP_IN_MEMORY);
1429	}	1900	}
1430		1901
1431	sub customise_for {	1902	sub customise_for {
1432	my ($self, $ob) = @_;	1903	my ($self, $ob) = @_;
1433		1904
1434	return find "~" . $ob->name . "/" . $self->{path}	1905	return find "~" . $ob->name . "/" . $self->{path}
1435	if $self->per_player;	1906	if $self->per_player;
1436		1907
		1908	# return find "?party/" . $ob->name . "/" . $self->{path}
		1909	# if $self->per_party;
		1910
1437	$self	1911	$self
1438	}	1912	}
1439		1913
1440	# find and load all maps in the 3x3 area around a map	1914	# find and load all maps in the 3x3 area around a map
1441	sub load_diag {	1915	sub load_neighbours {
1442	my ($map) = @_;	1916	my ($map) = @_;
1443		1917
1444	my @diag; # diagonal neighbours	1918	my @neigh; # diagonal neighbours
1445		1919
1446	for (0 .. 3) {	1920	for (0 .. 3) {
1447	my $neigh = $map->tile_path ($_)	1921	my $neigh = $map->tile_path ($_)
1448	or next;	1922	or next;
1449	$neigh = find $neigh, $map	1923	$neigh = find $neigh, $map
1450	or next;	1924	or next;
1451	$neigh->load;	1925	$neigh->load;
1452		1926
		1927	push @neigh,
1453	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	1928	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1454	[$neigh->tile_path (($_ + 1) % 4), $neigh];	1929	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1455	}	1930	}
1456		1931
1457	for (@diag) {	1932	for (grep defined $_->[0], @neigh) {
		1933	my ($path, $origin) = @$_;
1458	my $neigh = find @$_	1934	my $neigh = find $path, $origin
1459	or next;	1935	or next;
1460	$neigh->load;	1936	$neigh->load;
1461	}	1937	}
1462	}	1938	}
1463		1939
…		…
1487		1963
1488	undef $MAP_PREFETCH{$path};	1964	undef $MAP_PREFETCH{$path};
1489	$MAP_PREFETCHER ||= cf::async {	1965	$MAP_PREFETCHER ||= cf::async {
1490	while (%MAP_PREFETCH) {	1966	while (%MAP_PREFETCH) {
1491	for my $path (keys %MAP_PREFETCH) {	1967	for my $path (keys %MAP_PREFETCH) {
1492	my $map = find $path	1968	if (my $map = find $path) {
1493	or next;
1494	$map->load;	1969	$map->load;
		1970	}
1495		1971
1496	delete $MAP_PREFETCH{$path};	1972	delete $MAP_PREFETCH{$path};
1497	}	1973	}
1498	}	1974	}
1499	undef $MAP_PREFETCHER;	1975	undef $MAP_PREFETCHER;
1500	};	1976	};
		1977	$MAP_PREFETCHER->prio (6);
1501		1978
1502	()	1979	()
1503	}	1980	}
1504		1981
1505	sub save {	1982	sub save {
…		…
1550		2027
1551	sub reset_at {	2028	sub reset_at {
1552	my ($self) = @_;	2029	my ($self) = @_;
1553		2030
1554	# TODO: safety, remove and allow resettable per-player maps	2031	# TODO: safety, remove and allow resettable per-player maps
1555	return 1e99 if $self->isa ("ext::map_per_player");#d#
1556	return 1e99 if $self->{deny_reset};	2032	return 1e99 if $self->{deny_reset};
1557		2033
1558	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2034	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1559	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2035	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1560		2036
…		…
1571	my ($self) = @_;	2047	my ($self) = @_;
1572		2048
1573	my $lock = cf::lock_acquire "map_data:$self->{path}";	2049	my $lock = cf::lock_acquire "map_data:$self->{path}";
1574		2050
1575	return if $self->players;	2051	return if $self->players;
1576	return if $self->isa ("ext::map_per_player");#d#
1577		2052
1578	warn "resetting map ", $self->path;#d#	2053	warn "resetting map ", $self->path;
		2054
		2055	$self->in_memory (cf::MAP_SWAPPED);
		2056
		2057	# need to save uniques path
		2058	unless ($self->{deny_save}) {
		2059	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2060
		2061	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2062	if $uniq;
		2063	}
1579		2064
1580	delete $cf::MAP{$self->path};	2065	delete $cf::MAP{$self->path};
1581		2066
1582	$self->in_memory (cf::MAP_SWAPPED);
1583	$self->clear;	2067	$self->clear;
1584		2068
1585	$_->clear_links_to ($self) for values %cf::MAP;	2069	$_->clear_links_to ($self) for values %cf::MAP;
1586		2070
1587	$self->unlink_save;	2071	$self->unlink_save;
…		…
1606	$cf::MAP{$self->path} = $self;	2090	$cf::MAP{$self->path} = $self;
1607		2091
1608	$self->reset; # polite request, might not happen	2092	$self->reset; # polite request, might not happen
1609	}	2093	}
1610		2094
		2095	=item $maps = cf::map::tmp_maps
		2096
		2097	Returns an arrayref with all map paths of currently instantiated and saved
		2098	maps. May block.
		2099
		2100	=cut
		2101
		2102	sub tmp_maps() {
		2103	[
		2104	map {
		2105	utf8::decode $_;
		2106	/\.map$/
		2107	? normalise $_
		2108	: ()
		2109	} @{ aio_readdir $TMPDIR or [] }
		2110	]
		2111	}
		2112
		2113	=item $maps = cf::map::random_maps
		2114
		2115	Returns an arrayref with all map paths of currently instantiated and saved
		2116	random maps. May block.
		2117
		2118	=cut
		2119
		2120	sub random_maps() {
		2121	[
		2122	map {
		2123	utf8::decode $_;
		2124	/\.map$/
		2125	? normalise "?random/$_"
		2126	: ()
		2127	} @{ aio_readdir $RANDOMDIR or [] }
		2128	]
		2129	}
		2130
1611	=item cf::map::unique_maps	2131	=item cf::map::unique_maps
1612		2132
1613	Returns an arrayref of paths of all shared maps that have	2133	Returns an arrayref of paths of all shared maps that have
1614	instantiated unique items. May block.	2134	instantiated unique items. May block.
1615		2135
1616	=cut	2136	=cut
1617		2137
1618	sub unique_maps() {	2138	sub unique_maps() {
1619	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2139	[
1620	or return;	2140	map {
1621
1622	my @paths;
1623
1624	for (@$files) {
1625	utf8::decode $_;	2141	utf8::decode $_;
1626	next if /\.pst$/;
1627	next unless /^$PATH_SEP/o;
1628
1629	s/\.map$//;	2142	/\.map$/
1630	push @paths, $_;	2143	? normalise $_
		2144	: ()
		2145	} @{ aio_readdir $UNIQUEDIR or [] }
1631	}	2146	]
1632
1633	\@paths
1634	}	2147	}
1635		2148
1636	package cf;	2149	package cf;
1637		2150
1638	=back	2151	=back
…		…
1684		2197
1685	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2198	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1686		2199
1687	if ($self->{record_replies}) {	2200	if ($self->{record_replies}) {
1688	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2201	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2202
1689	} else {	2203	} else {
		2204	my $pl = $self->contr;
		2205
		2206	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2207	my $dialog = $pl->{npc_dialog};
		2208	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2209
		2210	} else {
1690	$msg = $npc->name . " says: $msg" if $npc;	2211	$msg = $npc->name . " says: $msg" if $npc;
1691	$self->message ($msg, $flags);	2212	$self->message ($msg, $flags);
		2213	}
1692	}	2214	}
		2215	}
		2216
		2217	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2218
		2219	=cut
		2220
		2221	sub cf::object::send_msg {
		2222	my $pl = shift->contr
		2223	or return;
		2224	$pl->send_msg (@_);
1693	}	2225	}
1694		2226
1695	=item $player_object->may ("access")	2227	=item $player_object->may ("access")
1696		2228
1697	Returns wether the given player is authorized to access resource "access"	2229	Returns wether the given player is authorized to access resource "access"
…		…
1729	=cut	2261	=cut
1730		2262
1731	sub link_map {	2263	sub link_map {
1732	unless ($LINK_MAP) {	2264	unless ($LINK_MAP) {
1733	$LINK_MAP = cf::map::find "{link}"	2265	$LINK_MAP = cf::map::find "{link}"
1734	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2266	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1735	$LINK_MAP->load;	2267	$LINK_MAP->load;
1736	}	2268	}
1737		2269
1738	$LINK_MAP	2270	$LINK_MAP
1739	}	2271	}
…		…
1744	$self->deactivate_recursive;	2276	$self->deactivate_recursive;
1745		2277
1746	return if UNIVERSAL::isa $self->map, "ext::map_link";	2278	return if UNIVERSAL::isa $self->map, "ext::map_link";
1747		2279
1748	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2280	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1749	if $self->map;	2281	if $self->map && $self->map->{path} ne "{link}";
1750		2282
1751	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2283	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1752	}	2284	}
1753		2285
1754	sub cf::object::player::leave_link {	2286	sub cf::object::player::leave_link {
1755	my ($self, $map, $x, $y) = @_;	2287	my ($self, $map, $x, $y) = @_;
		2288
		2289	return unless $self->contr->active;
1756		2290
1757	my $link_pos = delete $self->{_link_pos};	2291	my $link_pos = delete $self->{_link_pos};
1758		2292
1759	unless ($map) {	2293	unless ($map) {
1760	# restore original map position	2294	# restore original map position
…		…
1774	# use -1 or undef as default coordinates, not 0, 0	2308	# use -1 or undef as default coordinates, not 0, 0
1775	($x, $y) = ($map->enter_x, $map->enter_y)	2309	($x, $y) = ($map->enter_x, $map->enter_y)
1776	if $x <=0 && $y <= 0;	2310	if $x <=0 && $y <= 0;
1777		2311
1778	$map->load;	2312	$map->load;
1779	$map->load_diag;	2313	$map->load_neighbours;
1780		2314
1781	return unless $self->contr->active;	2315	return unless $self->contr->active;
1782	$self->activate_recursive;	2316	$self->activate_recursive;
		2317
		2318	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1783	$self->enter_map ($map, $x, $y);	2319	$self->enter_map ($map, $x, $y);
1784	}	2320	}
1785		2321
1786	cf::player->attach (	2322	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1787	on_logout => sub {
1788	my ($pl) = @_;
1789		2323
1790	# abort map switching before logout	2324	Moves the player to the given map-path and coordinates by first freezing
1791	if ($pl->ob->{_link_pos}) {	2325	her, loading and preparing them map, calling the provided $check callback
1792	cf::sync_job {	2326	that has to return the map if sucecssful, and then unfreezes the player on
1793	$pl->ob->leave_link	2327	the new (success) or old (failed) map position. In either case, $done will
1794	};	2328	be called at the end of this process.
1795	}
1796	},
1797	on_login => sub {
1798	my ($pl) = @_;
1799		2329
1800	# try to abort aborted map switching on player login :)
1801	# should happen only on crashes
1802	if ($pl->ob->{_link_pos}) {
1803	$pl->ob->enter_link;
1804	(async {
1805	# we need this sleep as the login has a concurrent enter_exit running
1806	# and this sleep increases chances of the player not ending up in scorn
1807	$pl->ob->reply (undef,
1808	"There was an internal problem at your last logout, "
1809	. "the server will try to bring you to your intended destination in a second.",
1810	cf::NDI_RED);
1811	Coro::Timer::sleep 1;
1812	$pl->ob->leave_link;
1813	})->prio (2);
1814	}
1815	},
1816	);
1817
1818	=item $player_object->goto ($path, $x, $y)
1819
1820	=cut	2330	=cut
		2331
		2332	our $GOTOGEN;
1821		2333
1822	sub cf::object::player::goto {	2334	sub cf::object::player::goto {
1823	my ($self, $path, $x, $y) = @_;	2335	my ($self, $path, $x, $y, $check, $done) = @_;
		2336
		2337	# do generation counting so two concurrent goto's will be executed in-order
		2338	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1824		2339
1825	$self->enter_link;	2340	$self->enter_link;
1826		2341
1827	(async {	2342	(async {
		2343	my $map = eval {
1828	my $map = cf::map::find $path;	2344	my $map = cf::map::find $path;
		2345
		2346	if ($map) {
1829	$map = $map->customise_for ($self) if $map;	2347	$map = $map->customise_for ($self);
1830		2348	$map = $check->($map) if $check && $map;
1831	# warn "entering ", $map->path, " at ($x, $y)\n"	2349	} else {
1832	# if $map;
1833
1834	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2350	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2351	}
1835		2352
		2353	$map
		2354	};
		2355
		2356	if ($@) {
		2357	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2358	LOG llevError | logBacktrace, Carp::longmess $@;
		2359	}
		2360
		2361	if ($gen == $self->{_goto_generation}) {
		2362	delete $self->{_goto_generation};
1836	$self->leave_link ($map, $x, $y);	2363	$self->leave_link ($map, $x, $y);
		2364	}
		2365
		2366	$done->() if $done;
1837	})->prio (1);	2367	})->prio (1);
1838	}	2368	}
1839		2369
1840	=item $player_object->enter_exit ($exit_object)	2370	=item $player_object->enter_exit ($exit_object)
1841		2371
…		…
1870	# that depends on the exit object	2400	# that depends on the exit object
1871		2401
1872	my $rmp = parse_random_map_params $exit->msg;	2402	my $rmp = parse_random_map_params $exit->msg;
1873		2403
1874	if ($exit->map) {	2404	if ($exit->map) {
1875	$rmp->{region} = $exit->map->region_name;	2405	$rmp->{region} = $exit->region->name;
1876	$rmp->{origin_map} = $exit->map->path;	2406	$rmp->{origin_map} = $exit->map->path;
1877	$rmp->{origin_x} = $exit->x;	2407	$rmp->{origin_x} = $exit->x;
1878	$rmp->{origin_y} = $exit->y;	2408	$rmp->{origin_y} = $exit->y;
1879	}	2409	}
1880		2410
1881	$rmp->{random_seed} ||= $exit->random_seed;	2411	$rmp->{random_seed} ||= $exit->random_seed;
1882		2412
1883	my $data = cf::to_json $rmp;	2413	my $data = cf::to_json $rmp;
1884	my $md5 = Digest::MD5::md5_hex $data;	2414	my $md5 = Digest::MD5::md5_hex $data;
1885	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2415	my $meta = "$RANDOMDIR/$md5.meta";
1886		2416
1887	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2417	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1888	aio_write $fh, 0, (length $data), $data, 0;	2418	aio_write $fh, 0, (length $data), $data, 0;
1889	undef $fh;	2419	undef $fh;
1890	aio_rename "$meta~", $meta;	2420	aio_rename "$meta~", $meta;
…		…
1897	sub cf::object::player::enter_exit {	2427	sub cf::object::player::enter_exit {
1898	my ($self, $exit) = @_;	2428	my ($self, $exit) = @_;
1899		2429
1900	return unless $self->type == cf::PLAYER;	2430	return unless $self->type == cf::PLAYER;
1901		2431
		2432	if ($exit->slaying eq "/!") {
		2433	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2434	# the problem is that $exit might not survive long enough
		2435	# so it needs to be done right now, right here
		2436	cf::sync_job { prepare_random_map $exit };
		2437	}
		2438
		2439	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2440	my $hp = $exit->stats->hp;
		2441	my $sp = $exit->stats->sp;
		2442
1902	$self->enter_link;	2443	$self->enter_link;
		2444
		2445	# if exit is damned, update players death & WoR home-position
		2446	$self->contr->savebed ($slaying, $hp, $sp)
		2447	if $exit->flag (FLAG_DAMNED);
1903		2448
1904	(async {	2449	(async {
1905	$self->deactivate_recursive; # just to be sure	2450	$self->deactivate_recursive; # just to be sure
1906	unless (eval {	2451	unless (eval {
1907	prepare_random_map $exit	2452	$self->goto ($slaying, $hp, $sp);
1908	if $exit->slaying eq "/!";
1909
1910	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1911	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1912		2453
1913	1;	2454	1;
1914	}) {	2455	}) {
1915	$self->message ("Something went wrong deep within the crossfire server. "	2456	$self->message ("Something went wrong deep within the crossfire server. "
1916	. "I'll try to bring you back to the map you were before. "	2457	. "I'll try to bring you back to the map you were before. "
1917	. "Please report this to the dungeon master!",	2458	. "Please report this to the dungeon master!",
1918	cf::NDI_UNIQUE | cf::NDI_RED);	2459	cf::NDI_UNIQUE | cf::NDI_RED);
1919		2460
1920	warn "ERROR in enter_exit: $@";	2461	warn "ERROR in enter_exit: $@";
1921	$self->leave_link;	2462	$self->leave_link;
1922	}	2463	}
1923	})->prio (1);	2464	})->prio (1);
…		…
1936		2477
1937	sub cf::client::send_drawinfo {	2478	sub cf::client::send_drawinfo {
1938	my ($self, $text, $flags) = @_;	2479	my ($self, $text, $flags) = @_;
1939		2480
1940	utf8::encode $text;	2481	utf8::encode $text;
1941	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2482	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1942	}	2483	}
1943		2484
		2485	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2486
		2487	Send a drawinfo or msg packet to the client, formatting the msg for the
		2488	client if neccessary. C<$type> should be a string identifying the type of
		2489	the message, with C<log> being the default. If C<$color> is negative, suppress
		2490	the message unless the client supports the msg packet.
		2491
		2492	=cut
		2493
		2494	sub cf::client::send_msg {
		2495	my ($self, $channel, $msg, $color, @extra) = @_;
		2496
		2497	$msg = $self->pl->expand_cfpod ($msg);
		2498
		2499	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2500
		2501	if (ref $channel) {
		2502	# send meta info to client, if not yet sent
		2503	unless (exists $self->{channel}{$channel->{id}}) {
		2504	$self->{channel}{$channel->{id}} = $channel;
		2505	$self->ext_msg (channel_info => $channel);
		2506	}
		2507
		2508	$channel = $channel->{id};
		2509	}
		2510
		2511	return unless @extra || length $msg;
		2512
		2513	if ($self->can_msg) {
		2514	# default colour, mask it out
		2515	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2516	if $color & cf::NDI_DEF;
		2517
		2518	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2519	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2520	} else {
		2521	if ($color >= 0) {
		2522	# replace some tags by gcfclient-compatible ones
		2523	for ($msg) {
		2524	1 while
		2525	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2526	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2527	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2528	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2529	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2530	}
		2531
		2532	$color &= cf::NDI_COLOR_MASK;
		2533
		2534	utf8::encode $msg;
		2535
		2536	if (0 && $msg =~ /\[/) {
		2537	# COMMAND/INFO
		2538	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2539	} else {
		2540	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2541	$self->send_packet ("drawinfo $color $msg")
		2542	}
		2543	}
		2544	}
		2545	}
		2546
		2547	=item $client->ext_msg ($type, @msg)
		2548
		2549	Sends an ext event to the client.
		2550
		2551	=cut
		2552
		2553	sub cf::client::ext_msg($$@) {
		2554	my ($self, $type, @msg) = @_;
		2555
		2556	my $extcmd = $self->extcmd;
		2557
		2558	if ($extcmd == 2) {
		2559	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2560	} elsif ($extcmd == 1) { # TODO: remove
		2561	push @msg, msgtype => "event_$type";
		2562	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2563	}
		2564	}
		2565
		2566	=item $client->ext_reply ($msgid, @msg)
		2567
		2568	Sends an ext reply to the client.
		2569
		2570	=cut
		2571
		2572	sub cf::client::ext_reply($$@) {
		2573	my ($self, $id, @msg) = @_;
		2574
		2575	if ($self->extcmd == 2) {
		2576	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2577	} elsif ($self->ns->extcmd == 1) {
		2578	#TODO: version 1, remove
		2579	unshift @msg, msgtype => "reply", msgid => $id;
		2580	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2581	}
		2582	}
1944		2583
1945	=item $success = $client->query ($flags, "text", \&cb)	2584	=item $success = $client->query ($flags, "text", \&cb)
1946		2585
1947	Queues a query to the client, calling the given callback with	2586	Queues a query to the client, calling the given callback with
1948	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2587	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1949	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2588	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1950		2589
1951	Queries can fail, so check the return code. Or don't, as queries will become	2590	Queries can fail, so check the return code. Or don't, as queries will
1952	reliable at some point in the future.	2591	become reliable at some point in the future.
1953		2592
1954	=cut	2593	=cut
1955		2594
1956	sub cf::client::query {	2595	sub cf::client::query {
1957	my ($self, $flags, $text, $cb) = @_;	2596	my ($self, $flags, $text, $cb) = @_;
…		…
1965	utf8::encode $text;	2604	utf8::encode $text;
1966	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2605	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1967		2606
1968	$self->send_packet ($self->{query_queue}[0][0])	2607	$self->send_packet ($self->{query_queue}[0][0])
1969	if @{ $self->{query_queue} } == 1;	2608	if @{ $self->{query_queue} } == 1;
		2609
		2610	1
1970	}	2611	}
1971		2612
1972	cf::client->attach (	2613	cf::client->attach (
		2614	on_connect => sub {
		2615	my ($ns) = @_;
		2616
		2617	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2618	},
1973	on_reply => sub {	2619	on_reply => sub {
1974	my ($ns, $msg) = @_;	2620	my ($ns, $msg) = @_;
1975		2621
1976	# this weird shuffling is so that direct followup queries	2622	# this weird shuffling is so that direct followup queries
1977	# get handled first	2623	# get handled first
1978	my $queue = delete $ns->{query_queue}	2624	my $queue = delete $ns->{query_queue}
1979	or return; # be conservative, not sure how that can happen, but we saw a crash here	2625	or return; # be conservative, not sure how that can happen, but we saw a crash here
1980		2626
1981	(shift @$queue)->[1]->($msg);	2627	(shift @$queue)->[1]->($msg);
		2628	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1982		2629
1983	push @{ $ns->{query_queue} }, @$queue;	2630	push @{ $ns->{query_queue} }, @$queue;
1984		2631
1985	if (@{ $ns->{query_queue} } == @$queue) {	2632	if (@{ $ns->{query_queue} } == @$queue) {
1986	if (@$queue) {	2633	if (@$queue) {
…		…
1988	} else {	2635	} else {
1989	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2636	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1990	}	2637	}
1991	}	2638	}
1992	},	2639	},
		2640	on_exticmd => sub {
		2641	my ($ns, $buf) = @_;
		2642
		2643	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2644
		2645	if (ref $msg) {
		2646	my ($type, $reply, @payload) =
		2647	"ARRAY" eq ref $msg
		2648	? @$msg
		2649	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2650
		2651	if (my $cb = $EXTICMD{$type}) {
		2652	my @reply = $cb->($ns, @payload);
		2653
		2654	$ns->ext_reply ($reply, @reply)
		2655	if $reply;
		2656	}
		2657	} else {
		2658	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2659	}
		2660
		2661	cf::override;
		2662	},
1993	);	2663	);
1994		2664
1995	=item $client->async (\&cb)	2665	=item $client->async (\&cb)
1996		2666
1997	Create a new coroutine, running the specified callback. The coroutine will	2667	Create a new coroutine, running the specified callback. The coroutine will
…		…
2038	our $safe = new Safe "safe";	2708	our $safe = new Safe "safe";
2039	our $safe_hole = new Safe::Hole;	2709	our $safe_hole = new Safe::Hole;
2040		2710
2041	$SIG{FPE} = 'IGNORE';	2711	$SIG{FPE} = 'IGNORE';
2042		2712
2043	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2713	$safe->permit_only (Opcode::opset qw(
		2714	:base_core :base_mem :base_orig :base_math
		2715	grepstart grepwhile mapstart mapwhile
		2716	sort time
		2717	));
2044		2718
2045	# here we export the classes and methods available to script code	2719	# here we export the classes and methods available to script code
2046		2720
2047	=pod	2721	=pod
2048		2722
2049	The following fucntions and emthods are available within a safe environment:	2723	The following functions and methods are available within a safe environment:
2050		2724
2051	cf::object contr pay_amount pay_player map	2725	cf::object
		2726	contr pay_amount pay_player map x y force_find force_add
		2727	insert remove name archname title slaying race
		2728
2052	cf::object::player player	2729	cf::object::player
2053	cf::player peaceful	2730	player
2054	cf::map trigger	2731
		2732	cf::player
		2733	peaceful
		2734
		2735	cf::map
		2736	trigger
2055		2737
2056	=cut	2738	=cut
2057		2739
2058	for (	2740	for (
2059	["cf::object" => qw(contr pay_amount pay_player map)],	2741	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2742	insert remove inv name archname title slaying race)],
2060	["cf::object::player" => qw(player)],	2743	["cf::object::player" => qw(player)],
2061	["cf::player" => qw(peaceful)],	2744	["cf::player" => qw(peaceful)],
2062	["cf::map" => qw(trigger)],	2745	["cf::map" => qw(trigger)],
2063	) {	2746	) {
2064	no strict 'refs';	2747	no strict 'refs';
…		…
2135	=back	2818	=back
2136		2819
2137	=cut	2820	=cut
2138		2821
2139	#############################################################################	2822	#############################################################################
		2823	# the server's init and main functions
2140		2824
2141	=head2 EXTENSION DATABASE SUPPORT	2825	sub load_facedata($) {
		2826	my ($path) = @_;
2142		2827
2143	Crossfire maintains a very simple database for extension use. It can	2828	my $enc = JSON::XS->new->utf8->canonical;
2144	currently store anything that can be serialised using Storable, which
2145	excludes objects.
2146		2829
2147	The parameter C<$family> should best start with the name of the extension	2830	warn "loading facedata from $path\n";
2148	using it, it should be unique.
2149		2831
2150	=over 4	2832	my $facedata;
		2833	0 < aio_load $path, $facedata
		2834	or die "$path: $!";
2151		2835
2152	=item $hashref = cf::db_get $family	2836	$facedata = Coro::Storable::thaw $facedata;
2153		2837
2154	Return a hashref for use by the extension C<$family>, which can be	2838	$facedata->{version} == 2
2155	modified. After modifications, you have to call C<cf::db_dirty> or	2839	or cf::cleanup "$path: version mismatch, cannot proceed.";
2156	C<cf::db_sync>.
2157		2840
2158	=item $value = cf::db_get $family => $key	2841	# patch in the exptable
2159		2842	$facedata->{resource}{"res/exp_table"} = {
2160	Returns a single value from the database	2843	type => FT_RSRC,
2161		2844	data => $enc->encode ([map cf::level_to_min_exp $_, 0 .. cf::settings->max_level]),
2162	=item cf::db_put $family => $hashref
2163
2164	Stores the given family hashref into the database. Updates are delayed, if
2165	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2166
2167	=item cf::db_put $family => $key => $value
2168
2169	Stores the given C<$value> in the family hash. Updates are delayed, if you
2170	want the data to be synced to disk immediately, use C<cf::db_sync>.
2171
2172	=item cf::db_dirty
2173
2174	Marks the database as dirty, to be updated at a later time.
2175
2176	=item cf::db_sync
2177
2178	Immediately write the database to disk I<if it is dirty>.
2179
2180	=cut
2181
2182	our $DB;
2183
2184	{
2185	my $path = cf::localdir . "/database.pst";
2186
2187	sub db_load() {
2188	$DB = stat $path ? Storable::retrieve $path : { };
2189	}
2190
2191	my $pid;
2192
2193	sub db_save() {
2194	waitpid $pid, 0 if $pid;
2195	if (0 == ($pid = fork)) {
2196	$DB->{_meta}{version} = 1;
2197	Storable::nstore $DB, "$path~";
2198	rename "$path~", $path;
2199	cf::_exit 0 if defined $pid;
2200	}
2201	}
2202
2203	my $dirty;
2204
2205	sub db_sync() {
2206	db_save if $dirty;
2207	undef $dirty;
2208	}
2209
2210	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2211	db_sync;
2212	});	2845	};
		2846	cf::cede_to_tick;
2213		2847
2214	sub db_dirty() {
2215	$dirty = 1;
2216	$idle->start;
2217	}	2848	{
		2849	my $faces = $facedata->{faceinfo};
2218		2850
2219	sub db_get($;$) {	2851	while (my ($face, $info) = each %$faces) {
2220	@_ >= 2	2852	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2221	? $DB->{$_[0]}{$_[1]}	2853	cf::face::set_visibility $idx, $info->{visibility};
2222	: ($DB->{$_[0]} ||= { })	2854	cf::face::set_magicmap $idx, $info->{magicmap};
2223	}	2855	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2856	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2224		2857
2225	sub db_put($$;$) {	2858	cf::cede_to_tick;
2226	if (@_ >= 3) {
2227	$DB->{$_[0]}{$_[1]} = $_[2];
2228	} else {
2229	$DB->{$_[0]} = $_[1];
2230	}
2231	db_dirty;
2232	}
2233
2234	cf::global->attach (
2235	prio => 10000,
2236	on_cleanup => sub {
2237	db_sync;
2238	},	2859	}
2239	);
2240	}
2241		2860
2242	#############################################################################	2861	while (my ($face, $info) = each %$faces) {
2243	# the server's main()	2862	next unless $info->{smooth};
		2863	my $idx = cf::face::find $face
		2864	or next;
		2865	if (my $smooth = cf::face::find $info->{smooth}) {
		2866	cf::face::set_smooth $idx, $smooth;
		2867	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2868	} else {
		2869	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2870	}
		2871
		2872	cf::cede_to_tick;
		2873	}
		2874	}
		2875
		2876	{
		2877	my $anims = $facedata->{animinfo};
		2878
		2879	while (my ($anim, $info) = each %$anims) {
		2880	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2881	cf::cede_to_tick;
		2882	}
		2883
		2884	cf::anim::invalidate_all; # d'oh
		2885	}
		2886
		2887	{
		2888	# TODO: for gcfclient pleasure, we should give resources
		2889	# that gcfclient doesn't grok a >10000 face index.
		2890	my $res = $facedata->{resource};
		2891
		2892	my $soundconf = delete $res->{"res/sound.conf"};
		2893
		2894	while (my ($name, $info) = each %$res) {
		2895	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2896	my $data;
		2897
		2898	if ($info->{type} & 1) {
		2899	# prepend meta info
		2900
		2901	my $meta = $enc->encode ({
		2902	name => $name,
		2903	%{ $info->{meta} || {} },
		2904	});
		2905
		2906	$data = pack "(w/a*)*", $meta, $info->{data};
		2907	}
		2908
		2909	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2910	cf::face::set_type $idx, $info->{type};
		2911
		2912	cf::cede_to_tick;
		2913	}
		2914
		2915	if ($soundconf) {
		2916	$soundconf = $enc->decode (delete $soundconf->{data});
		2917
		2918	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2919	my $sound = $soundconf->{compat}[$_]
		2920	or next;
		2921
		2922	my $face = cf::face::find "sound/$sound->[1]";
		2923	cf::sound::set $sound->[0] => $face;
		2924	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2925	}
		2926
		2927	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2928	my $face = cf::face::find "sound/$v";
		2929	cf::sound::set $k => $face;
		2930	}
		2931	}
		2932	}
		2933
		2934	1
		2935	}
		2936
		2937	register_exticmd fx_want => sub {
		2938	my ($ns, $want) = @_;
		2939
		2940	while (my ($k, $v) = each %$want) {
		2941	$ns->fx_want ($k, $v);
		2942	}
		2943	};
		2944
		2945	sub reload_regions {
		2946	load_resource_file "$MAPDIR/regions"
		2947	or die "unable to load regions file\n";
		2948
		2949	for (cf::region::list) {
		2950	$_->{match} = qr/$_->{match}/
		2951	if exists $_->{match};
		2952	}
		2953	}
		2954
		2955	sub reload_facedata {
		2956	load_facedata "$DATADIR/facedata"
		2957	or die "unable to load facedata\n";
		2958	}
		2959
		2960	sub reload_archetypes {
		2961	load_resource_file "$DATADIR/archetypes"
		2962	or die "unable to load archetypes\n";
		2963	#d# NEED to laod twice to resolve forward references
		2964	# this really needs to be done in an extra post-pass
		2965	# (which needs to be synchronous, so solve it differently)
		2966	load_resource_file "$DATADIR/archetypes"
		2967	or die "unable to load archetypes\n";
		2968	}
		2969
		2970	sub reload_treasures {
		2971	load_resource_file "$DATADIR/treasures"
		2972	or die "unable to load treasurelists\n";
		2973	}
		2974
		2975	sub reload_resources {
		2976	warn "reloading resource files...\n";
		2977
		2978	reload_regions;
		2979	reload_facedata;
		2980	#reload_archetypes;#d#
		2981	reload_archetypes;
		2982	reload_treasures;
		2983
		2984	warn "finished reloading resource files\n";
		2985	}
		2986
		2987	sub init {
		2988	reload_resources;
		2989	}
2244		2990
2245	sub cfg_load {	2991	sub cfg_load {
2246	open my $fh, "<:utf8", cf::confdir . "/config"	2992	open my $fh, "<:utf8", "$CONFDIR/config"
2247	or return;	2993	or return;
2248		2994
2249	local $/;	2995	local $/;
2250	*CFG = YAML::Syck::Load <$fh>;	2996	*CFG = YAML::Syck::Load <$fh>;
2251		2997
…		…
2271	Event::one_event;	3017	Event::one_event;
2272	})->prio (Coro::PRIO_MAX);	3018	})->prio (Coro::PRIO_MAX);
2273	};	3019	};
2274		3020
2275	cfg_load;	3021	cfg_load;
2276	db_load;	3022	db_init;
2277	load_extensions;	3023	load_extensions;
2278		3024
2279	$TICK_WATCHER->start;	3025	$TICK_WATCHER->start;
2280	Event::loop;	3026	Event::loop;
2281	}	3027	}
…		…
2285		3031
2286	# install some emergency cleanup handlers	3032	# install some emergency cleanup handlers
2287	BEGIN {	3033	BEGIN {
2288	for my $signal (qw(INT HUP TERM)) {	3034	for my $signal (qw(INT HUP TERM)) {
2289	Event->signal (	3035	Event->signal (
		3036	reentrant => 0,
2290	data => WF_AUTOCANCEL,	3037	data => WF_AUTOCANCEL,
2291	signal => $signal,	3038	signal => $signal,
		3039	prio => 0,
2292	cb => sub {	3040	cb => sub {
2293	cf::cleanup "SIG$signal";	3041	cf::cleanup "SIG$signal";
2294	},	3042	},
2295	);	3043	);
2296	}	3044	}
		3045	}
		3046
		3047	sub write_runtime {
		3048	my $runtime = "$LOCALDIR/runtime";
		3049
		3050	# first touch the runtime file to show we are still running:
		3051	# the fsync below can take a very very long time.
		3052
		3053	IO::AIO::aio_utime $runtime, undef, undef;
		3054
		3055	my $guard = cf::lock_acquire "write_runtime";
		3056
		3057	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3058	or return;
		3059
		3060	my $value = $cf::RUNTIME + 90 + 10;
		3061	# 10 is the runtime save interval, for a monotonic clock
		3062	# 60 allows for the watchdog to kill the server.
		3063
		3064	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3065	and return;
		3066
		3067	# always fsync - this file is important
		3068	aio_fsync $fh
		3069	and return;
		3070
		3071	# touch it again to show we are up-to-date
		3072	aio_utime $fh, undef, undef;
		3073
		3074	close $fh
		3075	or return;
		3076
		3077	aio_rename "$runtime~", $runtime
		3078	and return;
		3079
		3080	warn "runtime file written.\n";
		3081
		3082	1
2297	}	3083	}
2298		3084
2299	sub emergency_save() {	3085	sub emergency_save() {
2300	my $freeze_guard = cf::freeze_mainloop;	3086	my $freeze_guard = cf::freeze_mainloop;
2301		3087
…		…
2318	my $map = $cf::MAP{$path} or next;	3104	my $map = $cf::MAP{$path} or next;
2319	$map->valid or next;	3105	$map->valid or next;
2320	$map->save;	3106	$map->save;
2321	}	3107	}
2322	warn "end emergency map save\n";	3108	warn "end emergency map save\n";
		3109
		3110	warn "begin emergency database checkpoint\n";
		3111	BDB::db_env_txn_checkpoint $DB_ENV;
		3112	warn "end emergency database checkpoint\n";
2323	};	3113	};
2324		3114
2325	warn "leave emergency perl save\n";	3115	warn "leave emergency perl save\n";
2326	}	3116	}
2327		3117
		3118	sub post_cleanup {
		3119	my ($make_core) = @_;
		3120
		3121	warn Carp::longmess "post_cleanup backtrace"
		3122	if $make_core;
		3123	}
		3124
2328	sub reload() {	3125	sub do_reload_perl() {
2329	# can/must only be called in main	3126	# can/must only be called in main
2330	if ($Coro::current != $Coro::main) {	3127	if ($Coro::current != $Coro::main) {
2331	warn "can only reload from main coroutine";	3128	warn "can only reload from main coroutine";
2332	return;	3129	return;
2333	}	3130	}
2334		3131
2335	warn "reloading...";	3132	warn "reloading...";
2336		3133
2337	warn "cancelling server ticker";	3134	warn "entering sync_job";
2338	$TICK_WATCHER->cancel;
2339		3135
		3136	cf::sync_job {
		3137	cf::write_runtime; # external watchdog should not bark
2340	cf::emergency_save;	3138	cf::emergency_save;
		3139	cf::write_runtime; # external watchdog should not bark
2341		3140
2342	eval {	3141	warn "syncing database to disk";
		3142	BDB::db_env_txn_checkpoint $DB_ENV;
		3143
2343	# if anything goes wrong in here, we should simply crash as we already saved	3144	# if anything goes wrong in here, we should simply crash as we already saved
2344
2345	warn "syncing database to disk";
2346	cf::db_sync;
2347		3145
2348	warn "cancelling all WF_AUTOCANCEL watchers";	3146	warn "cancelling all WF_AUTOCANCEL watchers";
2349	for (Event::all_watchers) {	3147	for (Event::all_watchers) {
2350	$_->cancel if $_->data & WF_AUTOCANCEL;	3148	$_->cancel if $_->data & WF_AUTOCANCEL;
2351	}	3149	}
2352		3150
2353	warn "flushing outstanding aio requests";	3151	warn "flushing outstanding aio requests";
2354	for (;;) {	3152	for (;;) {
		3153	BDB::flush;
2355	IO::AIO::flush;	3154	IO::AIO::flush;
2356	Coro::cede;	3155	Coro::cede;
2357	last unless IO::AIO::nreqs;	3156	last unless IO::AIO::nreqs || BDB::nreqs;
2358	warn "iterate...";	3157	warn "iterate...";
2359	}	3158	}
		3159
		3160	++$RELOAD;
2360		3161
2361	warn "cancelling all extension coros";	3162	warn "cancelling all extension coros";
2362	$_->cancel for values %EXT_CORO;	3163	$_->cancel for values %EXT_CORO;
2363	%EXT_CORO = ();	3164	%EXT_CORO = ();
2364		3165
2365	warn "removing commands";	3166	warn "removing commands";
2366	%COMMAND = ();	3167	%COMMAND = ();
2367		3168
2368	warn "removing ext commands";	3169	warn "removing ext/exti commands";
2369	%EXTCMD = ();	3170	%EXTCMD = ();
		3171	%EXTICMD = ();
2370		3172
2371	warn "unloading/nuking all extensions";	3173	warn "unloading/nuking all extensions";
2372	for my $pkg (@EXTS) {	3174	for my $pkg (@EXTS) {
2373	warn "... unloading $pkg";	3175	warn "... unloading $pkg";
2374		3176
…		…
2404	Symbol::delete_package "safe::$_"	3206	Symbol::delete_package "safe::$_"
2405	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3207	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2406		3208
2407	warn "unloading cf.pm \"a bit\"";	3209	warn "unloading cf.pm \"a bit\"";
2408	delete $INC{"cf.pm"};	3210	delete $INC{"cf.pm"};
		3211	delete $INC{"cf/pod.pm"};
2409		3212
2410	# don't, removes xs symbols, too,	3213	# don't, removes xs symbols, too,
2411	# and global variables created in xs	3214	# and global variables created in xs
2412	#Symbol::delete_package __PACKAGE__;	3215	#Symbol::delete_package __PACKAGE__;
2413		3216
…		…
2417	require cf;	3220	require cf;
2418	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3221	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2419		3222
2420	warn "loading config and database again";	3223	warn "loading config and database again";
2421	cf::cfg_load;	3224	cf::cfg_load;
2422	cf::db_load;
2423		3225
2424	warn "loading extensions";	3226	warn "loading extensions";
2425	cf::load_extensions;	3227	cf::load_extensions;
2426		3228
2427	warn "reattaching attachments to objects/players";	3229	warn "reattaching attachments to objects/players";
2428	_global_reattach;	3230	_global_reattach; # objects, sockets
2429	warn "reattaching attachments to maps";	3231	warn "reattaching attachments to maps";
2430	reattach $_ for values %MAP;	3232	reattach $_ for values %MAP;
		3233	warn "reattaching attachments to players";
		3234	reattach $_ for values %PLAYER;
2431		3235
2432	warn "restarting server ticker";	3236	warn "leaving sync_job";
2433		3237
2434	$TICK_WATCHER->start;	3238	1
2435	};	3239	} or do {
2436
2437	if ($@) {
2438	warn $@;	3240	warn $@;
2439	warn "error while reloading, exiting.";	3241	warn "error while reloading, exiting.";
2440	exit 1;	3242	exit 1;
2441	}	3243	};
2442		3244
2443	warn "reloaded";	3245	warn "reloaded";
2444	};	3246	};
2445		3247
2446	our $RELOAD_WATCHER; # used only during reload	3248	our $RELOAD_WATCHER; # used only during reload
2447		3249
		3250	sub reload_perl() {
		3251	# doing reload synchronously and two reloads happen back-to-back,
		3252	# coro crashes during coro_state_free->destroy here.
		3253
		3254	$RELOAD_WATCHER ||= Event->timer (
		3255	reentrant => 0,
		3256	after => 0,
		3257	data => WF_AUTOCANCEL,
		3258	cb => sub {
		3259	do_reload_perl;
		3260	undef $RELOAD_WATCHER;
		3261	},
		3262	);
		3263	}
		3264
2448	register_command "reload" => sub {	3265	register_command "reload" => sub {
2449	my ($who, $arg) = @_;	3266	my ($who, $arg) = @_;
2450		3267
2451	if ($who->flag (FLAG_WIZ)) {	3268	if ($who->flag (FLAG_WIZ)) {
2452	$who->message ("reloading server.");	3269	$who->message ("reloading server.");
2453		3270	async { reload_perl };
2454	# doing reload synchronously and two reloads happen back-to-back,
2455	# coro crashes during coro_state_free->destroy here.
2456
2457	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2458	reload;
2459	undef $RELOAD_WATCHER;
2460	});
2461	}	3271	}
2462	};	3272	};
2463		3273
2464	unshift @INC, $LIBDIR;	3274	unshift @INC, $LIBDIR;
2465		3275
2466	my $bug_warning = 0;	3276	my $bug_warning = 0;
2467		3277
		3278	our @WAIT_FOR_TICK;
		3279	our @WAIT_FOR_TICK_BEGIN;
		3280
		3281	sub wait_for_tick {
		3282	return unless $TICK_WATCHER->is_active;
		3283	return if $Coro::current == $Coro::main;
		3284
		3285	my $signal = new Coro::Signal;
		3286	push @WAIT_FOR_TICK, $signal;
		3287	$signal->wait;
		3288	}
		3289
		3290	sub wait_for_tick_begin {
		3291	return unless $TICK_WATCHER->is_active;
		3292	return if $Coro::current == $Coro::main;
		3293
		3294	my $signal = new Coro::Signal;
		3295	push @WAIT_FOR_TICK_BEGIN, $signal;
		3296	$signal->wait;
		3297	}
		3298
		3299	my $min = 1e6;#d#
		3300	my $avg = 10;
2468	$TICK_WATCHER = Event->timer (	3301	$TICK_WATCHER = Event->timer (
2469	reentrant => 0,	3302	reentrant => 0,
2470	parked => 1,	3303	parked => 1,
2471	prio => 0,	3304	prio => 0,
2472	at => $NEXT_TICK || $TICK,	3305	at => $NEXT_TICK || $TICK,
…		…
2476	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3309	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2477	unless ++$bug_warning > 10;	3310	unless ++$bug_warning > 10;
2478	return;	3311	return;
2479	}	3312	}
2480		3313
2481	$NOW = Event::time;	3314	$NOW = $tick_start = Event::time;
2482		3315
2483	cf::server_tick; # one server iteration	3316	cf::server_tick; # one server iteration
		3317
		3318	0 && sync_job {#d#
		3319	for(1..10) {
		3320	my $t = Event::time;
		3321	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3322	or die;
		3323
		3324	$map->width (50);
		3325	$map->height (50);
		3326	$map->alloc;
		3327	$map->_load_objects ("/tmp/x.map", 1);
		3328	my $t = Event::time - $t;
		3329
		3330	#next unless $t < 0.0013;#d#
		3331	if ($t < $min) {
		3332	$min = $t;
		3333	}
		3334	$avg = $avg * 0.99 + $t * 0.01;
		3335	}
		3336	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3337	exit 0;
		3338	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3339	};
		3340
2484	$RUNTIME += $TICK;	3341	$RUNTIME += $TICK;
2485	$NEXT_TICK += $TICK;	3342	$NEXT_TICK += $TICK;
2486		3343
2487	$WAIT_FOR_TICK->broadcast;	3344	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2488	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3345	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3346	Coro::async_pool {
		3347	write_runtime
		3348	or warn "ERROR: unable to write runtime file: $!";
		3349	};
		3350	}
		3351
		3352	# my $AFTER = Event::time;
		3353	# warn $AFTER - $NOW;#d#
		3354
		3355	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3356	$sig->send;
		3357	}
		3358	while (my $sig = shift @WAIT_FOR_TICK) {
		3359	$sig->send;
		3360	}
		3361
		3362	$NOW = Event::time;
2489		3363
2490	# if we are delayed by four ticks or more, skip them all	3364	# if we are delayed by four ticks or more, skip them all
2491	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3365	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2492		3366
2493	$TICK_WATCHER->at ($NEXT_TICK);	3367	$TICK_WATCHER->at ($NEXT_TICK);
2494	$TICK_WATCHER->start;	3368	$TICK_WATCHER->start;
		3369
		3370	$LOAD = ($NOW - $tick_start) / $TICK;
		3371	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3372
		3373	_post_tick;
		3374
		3375
2495	},	3376	},
2496	);	3377	);
2497		3378
		3379	{
		3380	BDB::max_poll_time $TICK * 0.1;
		3381	$BDB_POLL_WATCHER = Event->io (
		3382	reentrant => 0,
		3383	fd => BDB::poll_fileno,
		3384	poll => 'r',
		3385	prio => 0,
		3386	data => WF_AUTOCANCEL,
		3387	cb => \&BDB::poll_cb,
		3388	);
		3389	BDB::min_parallel 8;
		3390
		3391	BDB::set_sync_prepare {
		3392	my $status;
		3393	my $current = $Coro::current;
		3394	(
		3395	sub {
		3396	$status = $!;
		3397	$current->ready; undef $current;
		3398	},
		3399	sub {
		3400	Coro::schedule while defined $current;
		3401	$! = $status;
		3402	},
		3403	)
		3404	};
		3405
		3406	unless ($DB_ENV) {
		3407	$DB_ENV = BDB::db_env_create;
		3408
		3409	cf::sync_job {
		3410	eval {
		3411	BDB::db_env_open
		3412	$DB_ENV,
		3413	$BDBDIR,
		3414	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3415	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3416	0666;
		3417
		3418	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3419
		3420	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3421	$DB_ENV->set_lk_detect;
		3422	};
		3423
		3424	cf::cleanup "db_env_open(db): $@" if $@;
		3425	};
		3426	}
		3427	}
		3428
		3429	{
		3430	IO::AIO::min_parallel 8;
		3431
		3432	undef $Coro::AIO::WATCHER;
2498	IO::AIO::max_poll_time $TICK * 0.2;	3433	IO::AIO::max_poll_time $TICK * 0.1;
2499
2500	$AIO_POLL_WATCHER = Event->io (	3434	$AIO_POLL_WATCHER = Event->io (
2501	fd => IO::AIO::poll_fileno,	3435	reentrant => 0,
2502	poll => 'r',
2503	prio => 5,
2504	data => WF_AUTOCANCEL,
2505	cb => \&IO::AIO::poll_cb,
2506	);
2507
2508	$WRITE_RUNTIME_WATCHER = Event->timer (
2509	data => WF_AUTOCANCEL,	3436	data => WF_AUTOCANCEL,
2510	after => 1,	3437	fd => IO::AIO::poll_fileno,
2511	interval => 10,	3438	poll => 'r',
2512	prio => 6, # keep it lowest so it acts like a watchdog	3439	prio => 6,
2513	cb => Coro::unblock_sub {	3440	cb => \&IO::AIO::poll_cb,
2514	write_runtime	3441	);
2515	or warn "ERROR: unable to write runtime file: $!";	3442	}
		3443
		3444	my $_log_backtrace;
		3445
		3446	sub _log_backtrace {
		3447	my ($msg, @addr) = @_;
		3448
		3449	$msg =~ s/\n//;
		3450
		3451	# limit the # of concurrent backtraces
		3452	if ($_log_backtrace < 2) {
		3453	++$_log_backtrace;
		3454	async {
		3455	my @bt = fork_call {
		3456	@addr = map { sprintf "%x", $_ } @addr;
		3457	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3458	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3459	or die "addr2line: $!";
		3460
		3461	my @funcs;
		3462	my @res = <$fh>;
		3463	chomp for @res;
		3464	while (@res) {
		3465	my ($func, $line) = splice @res, 0, 2, ();
		3466	push @funcs, "[$func] $line";
		3467	}
		3468
		3469	@funcs
		3470	};
		3471
		3472	LOG llevInfo, "[ABT] $msg\n";
		3473	LOG llevInfo, "[ABT] $_\n" for @bt;
		3474	--$_log_backtrace;
		3475	};
		3476	} else {
		3477	LOG llevInfo, "[ABT] $msg\n";
		3478	LOG llevInfo, "[ABT] [suppressed]\n";
2516	},	3479	}
2517	);	3480	}
		3481
		3482	# load additional modules
		3483	use cf::pod;
2518		3484
2519	END { cf::emergency_save }	3485	END { cf::emergency_save }
2520		3486
2521	1	3487	1
2522		3488

Diff Legend

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