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.163 by root, Thu Jan 11 01:01:56 2007 UTC vs.
Revision 1.351 by root, Sun Sep 2 00:57:38 2007 UTC

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

Diff Legend

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