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

Diff Legend

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