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.183 by root, Fri Jan 19 19:42:37 2007 UTC vs.
Revision 1.407 by root, Sun Jan 13 09:53:53 2008 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 Storable;	8	use Socket;
		9	use EV 1.86;
9	use Opcode;	10	use Opcode;
10	use Safe;	11	use Safe;
11	use Safe::Hole;	12	use Safe::Hole;
		13	use Storable ();
12		14
13	use Coro 3.4 ();	15	use Coro 4.32 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::EV;
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::BDB;
		24	use Coro::Storable;
		25	use Coro::Util ();
19		26
		27	use JSON::XS 2.01 ();
		28	use BDB ();
20	use Data::Dumper;	29	use Data::Dumper;
21	use Digest::MD5;	30	use Digest::MD5;
22	use Fcntl;	31	use Fcntl;
23	use IO::AIO 2.32 ();
24	use YAML::Syck ();	32	use YAML::Syck ();
		33	use IO::AIO 2.51 ();
25	use Time::HiRes;	34	use Time::HiRes;
		35	use Compress::LZF;
		36	use Digest::MD5 ();
26		37
27	use Event; $Event::Eval = 1; # no idea why this is required, but it is	38	# configure various modules to our taste
28		39	#
29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	40	$Storable::canonical = 1; # reduce rsync transfers
		41	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		42	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		43
31	# 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?
32	$YAML::Syck::ImplicitUnicode = 1;	45	$YAML::Syck::ImplicitUnicode = 1;
33		46
34	$Coro::main->prio (Coro::PRIO_MAX); # 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
35		48
		49	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		50
36	our %COMMAND = ();	51	our %COMMAND = ();
37	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
38		53
39	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
40	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
41	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
42	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
43		59
		60	our $RELOAD; # number of reloads so far
44	our @EVENT;	61	our @EVENT;
45	our $LIBDIR = datadir . "/ext";
46		62
47	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	our %RESOURCE;
		75
		76	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48	our $TICK_WATCHER;	77	our $TICK_WATCHER;
49	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
50	our $WRITE_RUNTIME_WATCHER;	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51	our $NEXT_TICK;	80	our $NEXT_TICK;
52	our $NOW;	81	our $USE_FSYNC = 1; # use fsync to write maps - default off
		82
		83	our $BDB_POLL_WATCHER;
		84	our $BDB_DEADLOCK_WATCHER;
		85	our $BDB_CHECKPOINT_WATCHER;
		86	our $BDB_TRICKLE_WATCHER;
		87	our $DB_ENV;
53		88
54	our %CFG;	89	our %CFG;
55		90
56	our $UPTIME; $UPTIME ||= time;	91	our $UPTIME; $UPTIME ||= time;
57	our $RUNTIME;	92	our $RUNTIME;
		93	our $NOW;
58		94
59	our %PLAYER; # all users	95	our (%PLAYER, %PLAYER_LOADING); # all users
60	our %MAP; # all maps	96	our (%MAP, %MAP_LOADING ); # all maps
61	our $LINK_MAP; # the special {link} map, which is always available	97	our $LINK_MAP; # the special {link} map, which is always available
62	our $RANDOM_MAPS = cf::localdir . "/random";
63
64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66		98
67	# used to convert map paths into valid unix filenames by replacing / by ∕	99	# used to convert map paths into valid unix filenames by replacing / by ∕
68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	100	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69		101
		102	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		103	our $LOADAVG; # same thing, but with alpha-smoothing
		104	our $tick_start; # for load detecting purposes
		105
70	binmode STDOUT;	106	binmode STDOUT;
71	binmode STDERR;	107	binmode STDERR;
72		108
73	# read virtual server time, if available	109	# read virtual server time, if available
74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	110	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75	open my $fh, "<", cf::localdir . "/runtime"	111	open my $fh, "<", "$LOCALDIR/runtime"
76	or die "unable to read runtime file: $!";	112	or die "unable to read runtime file: $!";
77	$RUNTIME = <$fh> + 0.;	113	$RUNTIME = <$fh> + 0.;
78	}	114	}
79		115
80	mkdir cf::localdir;	116	mkdir $_
81	mkdir cf::localdir . "/" . cf::playerdir;	117	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82	mkdir cf::localdir . "/" . cf::tmpdir;
83	mkdir cf::localdir . "/" . cf::uniquedir;
84	mkdir $RANDOM_MAPS;
85		118
86	our $EMERGENCY_POSITION;	119	our $EMERGENCY_POSITION;
		120
		121	sub cf::map::normalise;
87		122
88	#############################################################################	123	#############################################################################
89		124
90	=head2 GLOBAL VARIABLES	125	=head2 GLOBAL VARIABLES
91		126
…		…
98	=item $cf::RUNTIME	133	=item $cf::RUNTIME
99		134
100	The time this server has run, starts at 0 and is increased by $cf::TICK on	135	The time this server has run, starts at 0 and is increased by $cf::TICK on
101	every server tick.	136	every server tick.
102		137
103	=item $cf::LIBDIR	138	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		139	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		140	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104		141
105	The perl library directory, where extensions and cf-specific modules can	142	Various directories - "/etc", read-only install directory, perl-library
106	be found. It will be added to C<@INC> automatically.	143	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		144	unique-items directory, player file directory, random maps directory and
		145	database environment.
107		146
108	=item $cf::NOW	147	=item $cf::NOW
109		148
110	The time of the last (current) server tick.	149	The time of the last (current) server tick.
111		150
112	=item $cf::TICK	151	=item $cf::TICK
113		152
114	The interval between server ticks, in seconds.	153	The interval between server ticks, in seconds.
115		154
		155	=item $cf::LOADAVG
		156
		157	The current CPU load on the server (alpha-smoothed), as a value between 0
		158	(none) and 1 (overloaded), indicating how much time is spent on processing
		159	objects per tick. Healthy values are < 0.5.
		160
		161	=item $cf::LOAD
		162
		163	The raw value load value from the last tick.
		164
116	=item %cf::CFG	165	=item %cf::CFG
117		166
118	Configuration for the server, loaded from C</etc/crossfire/config>, or	167	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
119	from wherever your confdir points to.	168	from wherever your confdir points to.
120		169
121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	170	=item cf::wait_for_tick, cf::wait_for_tick_begin
122		171
123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	172	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	173	returns directly I<after> the tick processing (and consequently, can only wake one process
125	processing has been done. Call C<< ->wait >> on them to maximise the	174	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126	window of cpu time available, or simply to synchronise to the server tick.	175
		176	=item @cf::INVOKE_RESULTS
		177
		178	This array contains the results of the last C<invoke ()> call. When
		179	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		180	that call.
127		181
128	=back	182	=back
129		183
130	=cut	184	=cut
131		185
132	BEGIN {	186	BEGIN {
133	*CORE::GLOBAL::warn = sub {	187	*CORE::GLOBAL::warn = sub {
134	my $msg = join "", @_;	188	my $msg = join "", @_;
135	utf8::encode $msg;
136		189
137	$msg .= "\n"	190	$msg .= "\n"
138	unless $msg =~ /\n$/;	191	unless $msg =~ /\n$/;
139		192
		193	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		194
140	LOG llevError, $msg;	195	LOG llevError, $msg;
141	};	196	};
142	}	197	}
		198
		199	$Coro::State::DIEHOOK = sub {
		200	warn Carp::longmess $_[0];
		201	Coro::terminate;
		202	};
143		203
144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	204	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	205	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	206	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	207	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	208	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		209	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	210	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150		211
151	# we bless all objects into (empty) derived classes to force a method lookup	212	# we bless all objects into (empty) derived classes to force a method lookup
152	# within the Safe compartment.	213	# within the Safe compartment.
153	for my $pkg (qw(	214	for my $pkg (qw(
154	cf::global cf::attachable	215	cf::global cf::attachable
…		…
159	)) {	220	)) {
160	no strict 'refs';	221	no strict 'refs';
161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	222	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
162	}	223	}
163		224
164	$Event::DIED = sub {	225	$EV::DIED = sub {
165	warn "error in event callback: @_";	226	warn "error in event callback: @_";
166	};	227	};
		228
		229	#############################################################################
167		230
168	=head2 UTILITY FUNCTIONS	231	=head2 UTILITY FUNCTIONS
169		232
170	=over 4	233	=over 4
171		234
…		…
190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	253	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191	$d	254	$d
192	} || "[unable to dump $_[0]: '$@']";	255	} || "[unable to dump $_[0]: '$@']";
193	}	256	}
194		257
195	use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197	=item $ref = cf::from_json $json	258	=item $ref = cf::decode_json $json
198		259
199	Converts a JSON string into the corresponding perl data structure.	260	Converts a JSON string into the corresponding perl data structure.
200		261
201	=cut
202
203	sub from_json($) {
204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205	JSON::Syck::Load $_[0]
206	}
207
208	=item $json = cf::to_json $ref	262	=item $json = cf::encode_json $ref
209		263
210	Converts a perl data structure into its JSON representation.	264	Converts a perl data structure into its JSON representation.
211		265
212	=cut	266	=cut
213		267
214	sub to_json($) {	268	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	269
216	JSON::Syck::Dump $_[0]	270	sub encode_json($) { $json_coder->encode ($_[0]) }
217	}	271	sub decode_json($) { $json_coder->decode ($_[0]) }
218		272
219	=item cf::lock_wait $string	273	=item cf::lock_wait $string
220		274
221	Wait until the given lock is available. See cf::lock_acquire.	275	Wait until the given lock is available. See cf::lock_acquire.
222		276
…		…
225	Wait until the given lock is available and then acquires it and returns	279	Wait until the given lock is available and then acquires it and returns
226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	280	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
227	for example when the coroutine gets canceled), the lock is automatically	281	for example when the coroutine gets canceled), the lock is automatically
228	returned.	282	returned.
229		283
		284	Locks are *not* recursive, locking from the same coro twice results in a
		285	deadlocked coro.
		286
230	Lock names should begin with a unique identifier (for example, cf::map::find	287	Lock names should begin with a unique identifier (for example, cf::map::find
231	uses map_find and cf::map::load uses map_load).	288	uses map_find and cf::map::load uses map_load).
232		289
		290	=item $locked = cf::lock_active $string
		291
		292	Return true if the lock is currently active, i.e. somebody has locked it.
		293
233	=cut	294	=cut
234		295
235	our %LOCK;	296	our %LOCK;
		297	our %LOCKER;#d#
236		298
237	sub lock_wait($) {	299	sub lock_wait($) {
238	my ($key) = @_;	300	my ($key) = @_;
		301
		302	if ($LOCKER{$key} == $Coro::current) {#d#
		303	Carp::cluck "lock_wait($key) for already-acquired lock";#d#
		304	return;#d#
		305	}#d#
239		306
240	# wait for lock, if any	307	# wait for lock, if any
241	while ($LOCK{$key}) {	308	while ($LOCK{$key}) {
242	push @{ $LOCK{$key} }, $Coro::current;	309	push @{ $LOCK{$key} }, $Coro::current;
243	Coro::schedule;	310	Coro::schedule;
…		…
249		316
250	# wait, to be sure we are not locked	317	# wait, to be sure we are not locked
251	lock_wait $key;	318	lock_wait $key;
252		319
253	$LOCK{$key} = [];	320	$LOCK{$key} = [];
		321	$LOCKER{$key} = $Coro::current;#d#
254		322
255	Coro::guard {	323	Coro::guard {
		324	delete $LOCKER{$key};#d#
256	# wake up all waiters, to be on the safe side	325	# wake up all waiters, to be on the safe side
257	$_->ready for @{ delete $LOCK{$key} };	326	$_->ready for @{ delete $LOCK{$key} };
258	}	327	}
259	}	328	}
260		329
		330	sub lock_active($) {
		331	my ($key) = @_;
		332
		333	! ! $LOCK{$key}
		334	}
		335
261	sub freeze_mainloop {	336	sub freeze_mainloop {
262	return unless $TICK_WATCHER->is_active;	337	return unless $TICK_WATCHER->is_active;
263		338
264	my $guard = Coro::guard {	339	my $guard = Coro::guard {
265	$TICK_WATCHER->start;	340	$TICK_WATCHER->start;
266	$WRITE_RUNTIME_WATCHER->start;
267	};	341	};
268	$WRITE_RUNTIME_WATCHER->stop;
269	$TICK_WATCHER->stop;	342	$TICK_WATCHER->stop;
270	$guard	343	$guard
		344	}
		345
		346	=item cf::periodic $interval, $cb
		347
		348	Like EV::periodic, but randomly selects a starting point so that the actions
		349	get spread over timer.
		350
		351	=cut
		352
		353	sub periodic($$) {
		354	my ($interval, $cb) = @_;
		355
		356	my $start = rand List::Util::min 180, $interval;
		357
		358	EV::periodic $start, $interval, 0, $cb
		359	}
		360
		361	=item cf::get_slot $time[, $priority[, $name]]
		362
		363	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		364	This call blocks and returns only when you have at least C<$time> seconds
		365	of cpu time till the next tick. The slot is only valid till the next cede.
		366
		367	The optional C<$name> can be used to identify the job to run. It might be
		368	used for statistical purposes and should identify the same time-class.
		369
		370	Useful for short background jobs.
		371
		372	=cut
		373
		374	our @SLOT_QUEUE;
		375	our $SLOT_QUEUE;
		376
		377	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		378	$SLOT_QUEUE = Coro::async {
		379	$Coro::current->desc ("timeslot manager");
		380
		381	my $signal = new Coro::Signal;
		382
		383	while () {
		384	next_job:
		385	my $avail = cf::till_tick;
		386	if ($avail > 0.01) {
		387	for (0 .. $#SLOT_QUEUE) {
		388	if ($SLOT_QUEUE[$_][0] < $avail) {
		389	my $job = splice @SLOT_QUEUE, $_, 1, ();
		390	$job->[2]->send;
		391	Coro::cede;
		392	goto next_job;
		393	}
		394	}
		395	}
		396
		397	if (@SLOT_QUEUE) {
		398	# we do not use wait_for_tick() as it returns immediately when tick is inactive
		399	push @cf::WAIT_FOR_TICK, $signal;
		400	$signal->wait;
		401	} else {
		402	Coro::schedule;
		403	}
		404	}
		405	};
		406
		407	sub get_slot($;$$) {
		408	my ($time, $pri, $name) = @_;
		409
		410	$time = $TICK * .6 if $time > $TICK * .6;
		411	my $sig = new Coro::Signal;
		412
		413	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		414	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		415	$SLOT_QUEUE->ready;
		416	$sig->wait;
271	}	417	}
272		418
273	=item cf::async { BLOCK }	419	=item cf::async { BLOCK }
274		420
275	Currently the same as Coro::async_pool, meaning you cannot use	421	Currently the same as Coro::async_pool, meaning you cannot use
…		…
280		426
281	BEGIN { *async = \&Coro::async_pool }	427	BEGIN { *async = \&Coro::async_pool }
282		428
283	=item cf::sync_job { BLOCK }	429	=item cf::sync_job { BLOCK }
284		430
285	The design of crossfire+ requires that the main coro ($Coro::main) is	431	The design of Deliantra requires that the main coroutine ($Coro::main)
286	always able to handle events or runnable, as crossfire+ is only partly	432	is always able to handle events or runnable, as Deliantra is only
287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	433	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		434	acceptable.
288		435
289	If it must be done, put the blocking parts into C<sync_job>. This will run	436	If it must be done, put the blocking parts into C<sync_job>. This will run
290	the given BLOCK in another coroutine while waiting for the result. The	437	the given BLOCK in another coroutine while waiting for the result. The
291	server will be frozen during this time, so the block should either finish	438	server will be frozen during this time, so the block should either finish
292	fast or be very important.	439	fast or be very important.
…		…
295		442
296	sub sync_job(&) {	443	sub sync_job(&) {
297	my ($job) = @_;	444	my ($job) = @_;
298		445
299	if ($Coro::current == $Coro::main) {	446	if ($Coro::current == $Coro::main) {
		447	my $time = EV::time;
		448
300	# this is the main coro, too bad, we have to block	449	# this is the main coro, too bad, we have to block
301	# till the operation succeeds, freezing the server :/	450	# till the operation succeeds, freezing the server :/
302		451
		452	LOG llevError, Carp::longmess "sync job";#d#
		453
303	# TODO: use suspend/resume instead	454	# TODO: use suspend/resume instead
304	# (but this is cancel-safe)	455	# (but this is cancel-safe)
305	my $freeze_guard = freeze_mainloop;	456	my $freeze_guard = freeze_mainloop;
306		457
307	my $busy = 1;	458	my $busy = 1;
308	my @res;	459	my @res;
309		460
310	(async {	461	(async {
		462	$Coro::current->desc ("sync job coro");
311	@res = eval { $job->() };	463	@res = eval { $job->() };
312	warn $@ if $@;	464	warn $@ if $@;
313	undef $busy;	465	undef $busy;
314	})->prio (Coro::PRIO_MAX);	466	})->prio (Coro::PRIO_MAX);
315		467
316	while ($busy) {	468	while ($busy) {
317	Coro::cede or Event::one_event;	469	if (Coro::nready) {
		470	Coro::cede_notself;
		471	} else {
		472	EV::loop EV::LOOP_ONESHOT;
318	}	473	}
		474	}
		475
		476	$time = EV::time - $time;
		477
		478	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		479	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		480
		481	$tick_start += $time; # do not account sync jobs to server load
319		482
320	wantarray ? @res : $res[0]	483	wantarray ? @res : $res[0]
321	} else {	484	} else {
322	# we are in another coroutine, how wonderful, everything just works	485	# we are in another coroutine, how wonderful, everything just works
323		486
…		…
343	$EXT_CORO{$coro+0} = $coro;	506	$EXT_CORO{$coro+0} = $coro;
344		507
345	$coro	508	$coro
346	}	509	}
347		510
348	sub write_runtime {	511	=item fork_call { }, $args
349	my $runtime = cf::localdir . "/runtime";
350		512
351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	513	Executes the given code block with the given arguments in a seperate
352	or return;	514	process, returning the results. Everything must be serialisable with
		515	Coro::Storable. May, of course, block. Note that the executed sub may
		516	never block itself or use any form of event handling.
353		517
354	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	518	=cut
355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
356	and return;
357		519
358	aio_fsync $fh	520	sub fork_call(&@) {
359	and return;	521	my ($cb, @args) = @_;
360		522
361	close $fh	523	# we seemingly have to make a local copy of the whole thing,
362	or return;	524	# otherwise perl prematurely frees the stuff :/
		525	# TODO: investigate and fix (likely this will be rather laborious)
363		526
364	aio_rename "$runtime~", $runtime	527	my @res = Coro::Util::fork_eval {
365	and return;	528	reset_signals;
		529	&$cb
		530	}, @args;
366		531
		532	wantarray ? @res : $res[-1]
		533	}
		534
		535	=item $value = cf::db_get $family => $key
		536
		537	Returns a single value from the environment database.
		538
		539	=item cf::db_put $family => $key => $value
		540
		541	Stores the given C<$value> in the family. It can currently store binary
		542	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		543
		544	=item $db = cf::db_table "name"
		545
		546	Create and/or open a new database table. The string must not be "db" and must be unique
		547	within each server.
		548
		549	=cut
		550
		551	sub db_table($) {
		552	my ($name) = @_;
		553	my $db = BDB::db_create $DB_ENV;
		554
		555	eval {
		556	$db->set_flags (BDB::CHKSUM);
		557
		558	utf8::encode $name;
		559	BDB::db_open $db, undef, $name, undef, BDB::BTREE,
		560	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		561	cf::cleanup "db_open(db): $!" if $!;
		562	};
		563	cf::cleanup "db_open(db): $@" if $@;
		564
		565	$db
		566	}
		567
		568	our $DB;
		569
		570	sub db_init {
		571	cf::sync_job {
		572	$DB ||= db_table "db";
		573	};
		574	}
		575
		576	sub db_get($$) {
		577	my $key = "$_[0]/$_[1]";
		578
		579	cf::sync_job {
		580	BDB::db_get $DB, undef, $key, my $data;
		581
		582	$! ? ()
		583	: $data
367	1	584	}
		585	}
		586
		587	sub db_put($$$) {
		588	BDB::dbreq_pri 4;
		589	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		590	}
		591
		592	=item cf::cache $id => [$paths...], $processversion => $process
		593
		594	Generic caching function that returns the value of the resource $id,
		595	caching and regenerating as required.
		596
		597	This function can block.
		598
		599	=cut
		600
		601	sub cache {
		602	my ($id, $src, $processversion, $process) = @_;
		603
		604	my $meta =
		605	join "\x00",
		606	$processversion,
		607	map {
		608	aio_stat $_
		609	and Carp::croak "$_: $!";
		610
		611	($_, (stat _)[7,9])
		612	} @$src;
		613
		614	my $dbmeta = db_get cache => "$id/meta";
		615	if ($dbmeta ne $meta) {
		616	# changed, we may need to process
		617
		618	my @data;
		619	my $md5;
		620
		621	for (0 .. $#$src) {
		622	0 <= aio_load $src->[$_], $data[$_]
		623	or Carp::croak "$src->[$_]: $!";
		624	}
		625
		626	# if processing is expensive, check
		627	# checksum first
		628	if (1) {
		629	$md5 =
		630	join "\x00",
		631	$processversion,
		632	map {
		633	cf::cede_to_tick;
		634	($src->[$_], Digest::MD5::md5_hex $data[$_])
		635	} 0.. $#$src;
		636
		637
		638	my $dbmd5 = db_get cache => "$id/md5";
		639	if ($dbmd5 eq $md5) {
		640	db_put cache => "$id/meta", $meta;
		641
		642	return db_get cache => "$id/data";
		643	}
		644	}
		645
		646	my $t1 = Time::HiRes::time;
		647	my $data = $process->(\@data);
		648	my $t2 = Time::HiRes::time;
		649
		650	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		651
		652	db_put cache => "$id/data", $data;
		653	db_put cache => "$id/md5" , $md5;
		654	db_put cache => "$id/meta", $meta;
		655
		656	return $data;
		657	}
		658
		659	db_get cache => "$id/data"
		660	}
		661
		662	=item cf::datalog type => key => value, ...
		663
		664	Log a datalog packet of the given type with the given key-value pairs.
		665
		666	=cut
		667
		668	sub datalog($@) {
		669	my ($type, %kv) = @_;
		670	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
368	}	671	}
369		672
370	=back	673	=back
371		674
372	=cut	675	=cut
…		…
379	attach callbacks/event handlers (a collection of which is called an "attachment")	682	attach callbacks/event handlers (a collection of which is called an "attachment")
380	to it. All such attachable objects support the following methods.	683	to it. All such attachable objects support the following methods.
381		684
382	In the following description, CLASS can be any of C<global>, C<object>	685	In the following description, CLASS can be any of C<global>, C<object>
383	C<player>, C<client> or C<map> (i.e. the attachable objects in	686	C<player>, C<client> or C<map> (i.e. the attachable objects in
384	crossfire+).	687	Deliantra).
385		688
386	=over 4	689	=over 4
387		690
388	=item $attachable->attach ($attachment, key => $value...)	691	=item $attachable->attach ($attachment, key => $value...)
389		692
…		…
552	$registry = $CB_TYPE[$object_type] ||= [];	855	$registry = $CB_TYPE[$object_type] ||= [];
553		856
554	} elsif ($type eq "subtype") {	857	} elsif ($type eq "subtype") {
555	defined $object_type or Carp::croak "subtype specified without type";	858	defined $object_type or Carp::croak "subtype specified without type";
556	my $object_subtype = shift @arg;	859	my $object_subtype = shift @arg;
557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	860	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558		861
559	} elsif ($type eq "package") {	862	} elsif ($type eq "package") {
560	my $pkg = shift @arg;	863	my $pkg = shift @arg;
561		864
562	while (my ($name, $id) = each %cb_id) {	865	while (my ($name, $id) = each %cb_id) {
…		…
591	_attach $registry, $klass, @attach;	894	_attach $registry, $klass, @attach;
592	}	895	}
593		896
594	$obj->{$name} = \%arg;	897	$obj->{$name} = \%arg;
595	} else {	898	} else {
596	warn "object uses attachment '$name' that is not available, postponing.\n";	899	warn "object uses attachment '$name' which is not available, postponing.\n";
597	}	900	}
598		901
599	$obj->{_attachment}{$name} = undef;	902	$obj->{_attachment}{$name} = undef;
600	}	903	}
601		904
…		…
603	if (ref $_[0]) {	906	if (ref $_[0]) {
604	_object_attach @_;	907	_object_attach @_;
605	} else {	908	} else {
606	_attach shift->_attach_registry, @_;	909	_attach shift->_attach_registry, @_;
607	}	910	}
		911	_recalc_want;
608	};	912	};
609		913
610	# all those should be optimised	914	# all those should be optimised
611	sub cf::attachable::detach {	915	sub cf::attachable::detach {
612	my ($obj, $name) = @_;	916	my ($obj, $name) = @_;
…		…
615	delete $obj->{_attachment}{$name};	919	delete $obj->{_attachment}{$name};
616	reattach ($obj);	920	reattach ($obj);
617	} else {	921	} else {
618	Carp::croak "cannot, currently, detach class attachments";	922	Carp::croak "cannot, currently, detach class attachments";
619	}	923	}
		924	_recalc_want;
620	};	925	};
621		926
622	sub cf::attachable::attached {	927	sub cf::attachable::attached {
623	my ($obj, $name) = @_;	928	my ($obj, $name) = @_;
624		929
…		…
639	";	944	";
640	die if $@;	945	die if $@;
641	}	946	}
642		947
643	our $override;	948	our $override;
644	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	949	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
645		950
646	sub override {	951	sub override {
647	$override = 1;	952	$override = 1;
648	@invoke_results = ();	953	@INVOKE_RESULTS = (@_);
649	}	954	}
650		955
651	sub do_invoke {	956	sub do_invoke {
652	my $event = shift;	957	my $event = shift;
653	my $callbacks = shift;	958	my $callbacks = shift;
654		959
655	@invoke_results = ();	960	@INVOKE_RESULTS = ();
656		961
657	local $override;	962	local $override;
658		963
659	for (@$callbacks) {	964	for (@$callbacks) {
660	eval { &{$_->[1]} };	965	eval { &{$_->[1]} };
…		…
669	}	974	}
670		975
671	0	976	0
672	}	977	}
673		978
674	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)	979	=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
675		980
676	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)	981	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
677		982
678	Generate an object-specific event with the given arguments.	983	Generate an object-specific event with the given arguments.
679		984
680	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	985	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
681	removed in future versions), and there is no public API to access override	986	removed in future versions), and there is no public API to access override
682	results (if you must, access C<@cf::invoke_results> directly).	987	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
683		988
684	=back	989	=back
685		990
686	=cut	991	=cut
687		992
688	#############################################################################	993	#############################################################################
689	# object support	994	# object support
		995
		996	sub _object_equal($$);
		997	sub _object_equal($$) {
		998	my ($a, $b) = @_;
		999
		1000	return 0 unless (ref $a) eq (ref $b);
		1001
		1002	if ("HASH" eq ref $a) {
		1003	my @ka = keys %$a;
		1004	my @kb = keys %$b;
		1005
		1006	return 0 if @ka != @kb;
		1007
		1008	for (0 .. $#ka) {
		1009	return 0 unless $ka[$_] eq $kb[$_];
		1010	return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
		1011	}
		1012
		1013	} elsif ("ARRAY" eq ref $a) {
		1014
		1015	return 0 if @$a != @$b;
		1016
		1017	for (0 .. $#$a) {
		1018	return 0 unless _object_equal $a->[$_], $b->[$_];
		1019	}
		1020
		1021	} elsif ($a ne $b) {
		1022	return 0;
		1023	}
		1024
		1025	1
		1026	}
		1027
		1028	our $SLOW_MERGES;#d#
		1029	sub _can_merge {
		1030	my ($ob1, $ob2) = @_;
		1031
		1032	++$SLOW_MERGES;#d#
		1033
		1034	# we do the slow way here
		1035	return _object_equal $ob1, $ob2
		1036	}
690		1037
691	sub reattach {	1038	sub reattach {
692	# basically do the same as instantiate, without calling instantiate	1039	# basically do the same as instantiate, without calling instantiate
693	my ($obj) = @_;	1040	my ($obj) = @_;
694		1041
…		…
715	cf::attachable->attach (	1062	cf::attachable->attach (
716	prio => -1000000,	1063	prio => -1000000,
717	on_instantiate => sub {	1064	on_instantiate => sub {
718	my ($obj, $data) = @_;	1065	my ($obj, $data) = @_;
719		1066
720	$data = from_json $data;	1067	$data = decode_json $data;
721		1068
722	for (@$data) {	1069	for (@$data) {
723	my ($name, $args) = @$_;	1070	my ($name, $args) = @$_;
724		1071
725	$obj->attach ($name, %{$args || {} });	1072	$obj->attach ($name, %{$args || {} });
…		…
741	sub object_freezer_save {	1088	sub object_freezer_save {
742	my ($filename, $rdata, $objs) = @_;	1089	my ($filename, $rdata, $objs) = @_;
743		1090
744	sync_job {	1091	sync_job {
745	if (length $$rdata) {	1092	if (length $$rdata) {
		1093	utf8::decode (my $decname = $filename);
746	warn sprintf "saving %s (%d,%d)\n",	1094	warn sprintf "saving %s (%d,%d)\n",
747	$filename, length $$rdata, scalar @$objs;	1095	$decname, length $$rdata, scalar @$objs;
748		1096
749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1097	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750	chmod SAVE_MODE, $fh;	1098	chmod SAVE_MODE, $fh;
751	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1099	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
752	aio_fsync $fh;	1100	aio_fsync $fh if $cf::USE_FSYNC;
753	close $fh;	1101	close $fh;
754		1102
755	if (@$objs) {	1103	if (@$objs) {
756	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1104	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
757	chmod SAVE_MODE, $fh;	1105	chmod SAVE_MODE, $fh;
758	my $data = Storable::nfreeze { version => 1, objs => $objs };	1106	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
759	aio_write $fh, 0, (length $data), $data, 0;	1107	aio_write $fh, 0, (length $data), $data, 0;
760	aio_fsync $fh;	1108	aio_fsync $fh if $cf::USE_FSYNC;
761	close $fh;	1109	close $fh;
762	aio_rename "$filename.pst~", "$filename.pst";	1110	aio_rename "$filename.pst~", "$filename.pst";
763	}	1111	}
764	} else {	1112	} else {
765	aio_unlink "$filename.pst";	1113	aio_unlink "$filename.pst";
…		…
771	}	1119	}
772	} else {	1120	} else {
773	aio_unlink $filename;	1121	aio_unlink $filename;
774	aio_unlink "$filename.pst";	1122	aio_unlink "$filename.pst";
775	}	1123	}
776	}	1124	};
777	}	1125	}
778		1126
779	sub object_freezer_as_string {	1127	sub object_freezer_as_string {
780	my ($rdata, $objs) = @_;	1128	my ($rdata, $objs) = @_;
781		1129
…		…
793	or return;	1141	or return;
794		1142
795	unless (aio_stat "$filename.pst") {	1143	unless (aio_stat "$filename.pst") {
796	(aio_load "$filename.pst", $av) >= 0	1144	(aio_load "$filename.pst", $av) >= 0
797	or return;	1145	or return;
		1146
798	$av = eval { (Storable::thaw $av)->{objs} };	1147	my $st = eval { Coro::Storable::thaw $av };
		1148	$av = $st->{objs};
799	}	1149	}
800		1150
		1151	utf8::decode (my $decname = $filename);
801	warn sprintf "loading %s (%d)\n",	1152	warn sprintf "loading %s (%d,%d)\n",
802	$filename, length $data, scalar @{$av || []};#d#	1153	$decname, length $data, scalar @{$av || []};
		1154
803	return ($data, $av);	1155	($data, $av)
804	}	1156	}
		1157
		1158	=head2 COMMAND CALLBACKS
		1159
		1160	=over 4
		1161
		1162	=cut
805		1163
806	#############################################################################	1164	#############################################################################
807	# command handling &c	1165	# command handling &c
808		1166
809	=item cf::register_command $name => \&callback($ob,$args);	1167	=item cf::register_command $name => \&callback($ob,$args);
…		…
822	push @{ $COMMAND{$name} }, [$caller, $cb];	1180	push @{ $COMMAND{$name} }, [$caller, $cb];
823	}	1181	}
824		1182
825	=item cf::register_extcmd $name => \&callback($pl,$packet);	1183	=item cf::register_extcmd $name => \&callback($pl,$packet);
826		1184
827	Register a callbackf ro execution when the client sends an extcmd packet.	1185	Register a callback for execution when the client sends an (synchronous)
		1186	extcmd packet. Ext commands will be processed in the order they are
		1187	received by the server, like other user commands. The first argument is
		1188	the logged-in player. Ext commands can only be processed after a player
		1189	has logged in successfully.
828		1190
829	If the callback returns something, it is sent back as if reply was being	1191	If the callback returns something, it is sent back as if reply was being
830	called.	1192	called.
831		1193
		1194	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1195
		1196	Register a callback for execution when the client sends an (asynchronous)
		1197	exticmd packet. Exti commands are processed by the server as soon as they
		1198	are received, i.e. out of order w.r.t. other commands. The first argument
		1199	is a client socket. Exti commands can be received anytime, even before
		1200	log-in.
		1201
		1202	If the callback returns something, it is sent back as if reply was being
		1203	called.
		1204
832	=cut	1205	=cut
833		1206
834	sub register_extcmd {	1207	sub register_extcmd {
835	my ($name, $cb) = @_;	1208	my ($name, $cb) = @_;
836		1209
837	$EXTCMD{$name} = $cb;	1210	$EXTCMD{$name} = $cb;
		1211	}
		1212
		1213	sub register_exticmd {
		1214	my ($name, $cb) = @_;
		1215
		1216	$EXTICMD{$name} = $cb;
838	}	1217	}
839		1218
840	cf::player->attach (	1219	cf::player->attach (
841	on_command => sub {	1220	on_command => sub {
842	my ($pl, $name, $params) = @_;	1221	my ($pl, $name, $params) = @_;
…		…
851	cf::override;	1230	cf::override;
852	},	1231	},
853	on_extcmd => sub {	1232	on_extcmd => sub {
854	my ($pl, $buf) = @_;	1233	my ($pl, $buf) = @_;
855		1234
856	my $msg = eval { from_json $buf };	1235	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857		1236
858	if (ref $msg) {	1237	if (ref $msg) {
		1238	my ($type, $reply, @payload) =
		1239	"ARRAY" eq ref $msg
		1240	? @$msg
		1241	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1242
		1243	my @reply;
		1244
859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1245	if (my $cb = $EXTCMD{$type}) {
860	if (my %reply = $cb->($pl, $msg)) {	1246	@reply = $cb->($pl, @payload);
861	$pl->ext_reply ($msg->{msgid}, %reply);
862	}
863	}	1247	}
		1248
		1249	$pl->ext_reply ($reply, @reply)
		1250	if $reply;
		1251
864	} else {	1252	} else {
865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1253	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
866	}	1254	}
867		1255
868	cf::override;	1256	cf::override;
869	},	1257	},
870	);	1258	);
871		1259
872	sub load_extension {
873	my ($path) = @_;
874
875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
876	my $base = $1;
877	my $pkg = $1;
878	$pkg =~ s/[^[:word:]]/_/g;
879	$pkg = "ext::$pkg";
880
881	warn "... loading '$path' into '$pkg'\n";
882
883	open my $fh, "<:utf8", $path
884	or die "$path: $!";
885
886	my $source =
887	"package $pkg; use strict; use utf8;\n"
888	. "#line 1 \"$path\"\n{\n"
889	. (do { local $/; <$fh> })
890	. "\n};\n1";
891
892	unless (eval $source) {
893	my $msg = $@ ? "$path: $@\n"
894	: "extension disabled.\n";
895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896	warn $@;
897	warn "mandatory extension failed to load, exiting.\n";
898	exit 1;
899	}
900	die $@;
901	}
902
903	push @EXTS, $pkg;
904	}
905
906	sub load_extensions {	1260	sub load_extensions {
		1261	cf::sync_job {
		1262	my %todo;
		1263
907	for my $ext (<$LIBDIR/*.ext>) {	1264	for my $path (<$LIBDIR/*.ext>) {
908	next unless -r $ext;	1265	next unless -r $path;
909	eval {	1266
910	load_extension $ext;	1267	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1268	my $base = $1;
		1269	my $pkg = $1;
		1270	$pkg =~ s/[^[:word:]]/_/g;
		1271	$pkg = "ext::$pkg";
		1272
		1273	open my $fh, "<:utf8", $path
		1274	or die "$path: $!";
		1275
		1276	my $source = do { local $/; <$fh> };
		1277
		1278	my %ext = (
		1279	path => $path,
		1280	base => $base,
		1281	pkg => $pkg,
		1282	);
		1283
		1284	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1285	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1286
		1287	$ext{source} =
		1288	"package $pkg; use strict; use utf8;\n"
		1289	. "#line 1 \"$path\"\n{\n"
		1290	. $source
		1291	. "\n};\n1";
		1292
		1293	$todo{$base} = \%ext;
		1294	}
		1295
		1296	my %done;
		1297	while (%todo) {
		1298	my $progress;
		1299
		1300	while (my ($k, $v) = each %todo) {
		1301	for (split /,\s*/, $v->{meta}{depends}) {
		1302	goto skip
		1303	unless exists $done{$_};
		1304	}
		1305
		1306	warn "... loading '$k' into '$v->{pkg}'\n";
		1307
		1308	unless (eval $v->{source}) {
		1309	my $msg = $@ ? "$v->{path}: $@\n"
		1310	: "$v->{base}: extension inactive.\n";
		1311
		1312	if (exists $v->{meta}{mandatory}) {
		1313	warn $msg;
		1314	warn "mandatory extension failed to load, exiting.\n";
		1315	exit 1;
		1316	}
		1317
		1318	warn $msg;
		1319	}
		1320
		1321	$done{$k} = delete $todo{$k};
		1322	push @EXTS, $v->{pkg};
		1323	$progress = 1;
911	1	1324	}
912	} or warn "$ext not loaded: $@";	1325
		1326	skip:
		1327	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1328	unless $progress;
		1329	}
913	}	1330	};
914	}	1331	}
915		1332
916	#############################################################################	1333	#############################################################################
917		1334
		1335	=back
		1336
918	=head2 CORE EXTENSIONS	1337	=head2 CORE EXTENSIONS
919		1338
920	Functions and methods that extend core crossfire objects.	1339	Functions and methods that extend core crossfire objects.
921		1340
922	=cut	1341	=cut
…		…
927		1346
928	=head3 cf::player	1347	=head3 cf::player
929		1348
930	=over 4	1349	=over 4
931		1350
		1351	=item cf::player::num_playing
		1352
		1353	Returns the official number of playing players, as per the Crossfire metaserver rules.
		1354
		1355	=cut
		1356
		1357	sub num_playing {
		1358	scalar grep
		1359	$_->ob->map
		1360	&& !$_->hidden
		1361	&& !$_->ob->flag (cf::FLAG_WIZ),
		1362	cf::player::list
		1363	}
		1364
932	=item cf::player::find $login	1365	=item cf::player::find $login
933		1366
934	Returns the given player object, loading it if necessary (might block).	1367	Returns the given player object, loading it if necessary (might block).
935		1368
936	=cut	1369	=cut
937		1370
938	sub playerdir($) {	1371	sub playerdir($) {
939	cf::localdir	1372	"$PLAYERDIR/"
940	. "/"
941	. cf::playerdir
942	. "/"
943	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1373	. (ref $_[0] ? $_[0]->ob->name : $_[0])
944	}	1374	}
945		1375
946	sub path($) {	1376	sub path($) {
947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1377	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948		1378
949	(playerdir $login) . "/$login.pl"	1379	(playerdir $login) . "/playerdata"
950	}	1380	}
951		1381
952	sub find_active($) {	1382	sub find_active($) {
953	$cf::PLAYER{$_[0]}	1383	$cf::PLAYER{$_[0]}
954	and $cf::PLAYER{$_[0]}->active	1384	and $cf::PLAYER{$_[0]}->active
…		…
967	my $login = $_[0];	1397	my $login = $_[0];
968		1398
969	my $guard = cf::lock_acquire "user_find:$login";	1399	my $guard = cf::lock_acquire "user_find:$login";
970		1400
971	$cf::PLAYER{$_[0]} || do {	1401	$cf::PLAYER{$_[0]} || do {
972	my $pl = load_pl path $login	1402	# rename old playerfiles to new ones
		1403	#TODO: remove when no longer required
		1404	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1405	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1406	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1407	aio_unlink +(playerdir $login) . "/$login.pl";
		1408
		1409	my $f = new_from_file cf::object::thawer path $login
973	or return;	1410	or return;
		1411
		1412	my $pl = cf::player::load_pl $f
		1413	or return;
		1414	local $cf::PLAYER_LOADING{$login} = $pl;
		1415	$f->resolve_delayed_derefs;
974	$cf::PLAYER{$login} = $pl	1416	$cf::PLAYER{$login} = $pl
975	}	1417	}
976	}	1418	}
977	}	1419	}
978		1420
…		…
988		1430
989	aio_mkdir playerdir $pl, 0770;	1431	aio_mkdir playerdir $pl, 0770;
990	$pl->{last_save} = $cf::RUNTIME;	1432	$pl->{last_save} = $cf::RUNTIME;
991		1433
992	$pl->save_pl ($path);	1434	$pl->save_pl ($path);
993	Coro::cede;	1435	cf::cede_to_tick;
994	}	1436	}
995		1437
996	sub new($) {	1438	sub new($) {
997	my ($login) = @_;	1439	my ($login) = @_;
998		1440
…		…
1004	$cf::PLAYER{$login} = $self;	1446	$cf::PLAYER{$login} = $self;
1005		1447
1006	$self	1448	$self
1007	}	1449	}
1008		1450
		1451	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1452
		1453	=cut
		1454
		1455	sub send_msg {
		1456	my $ns = shift->ns
		1457	or return;
		1458	$ns->send_msg (@_);
		1459	}
		1460
1009	=item $pl->quit_character	1461	=item $pl->quit_character
1010		1462
1011	Nukes the player without looking back. If logged in, the connection will	1463	Nukes the player without looking back. If logged in, the connection will
1012	be destroyed. May block for a long time.	1464	be destroyed. May block for a long time.
1013		1465
1014	=cut	1466	=cut
1015		1467
1016	sub quit_character {	1468	sub quit_character {
1017	my ($pl) = @_;	1469	my ($pl) = @_;
		1470
		1471	my $name = $pl->ob->name;
1018		1472
1019	$pl->{deny_save} = 1;	1473	$pl->{deny_save} = 1;
1020	$pl->password ("*"); # this should lock out the player until we nuked the dir	1474	$pl->password ("*"); # this should lock out the player until we nuked the dir
1021		1475
1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1476	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1027	my $path = playerdir $pl;	1481	my $path = playerdir $pl;
1028	my $temp = "$path~$cf::RUNTIME~deleting~";	1482	my $temp = "$path~$cf::RUNTIME~deleting~";
1029	aio_rename $path, $temp;	1483	aio_rename $path, $temp;
1030	delete $cf::PLAYER{$pl->ob->name};	1484	delete $cf::PLAYER{$pl->ob->name};
1031	$pl->destroy;	1485	$pl->destroy;
		1486
		1487	my $prefix = qr<^~\Q$name\E/>;
		1488
		1489	# nuke player maps
		1490	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1491
1032	IO::AIO::aio_rmtree $temp;	1492	IO::AIO::aio_rmtree $temp;
		1493	}
		1494
		1495	=item $pl->kick
		1496
		1497	Kicks a player out of the game. This destroys the connection.
		1498
		1499	=cut
		1500
		1501	sub kick {
		1502	my ($pl, $kicker) = @_;
		1503
		1504	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1505	$pl->killer ("kicked");
		1506	$pl->ns->destroy;
1033	}	1507	}
1034		1508
1035	=item cf::player::list_logins	1509	=item cf::player::list_logins
1036		1510
1037	Returns am arrayref of all valid playernames in the system, can take a	1511	Returns am arrayref of all valid playernames in the system, can take a
1038	while and may block, so not sync_job-capable, ever.	1512	while and may block, so not sync_job-capable, ever.
1039		1513
1040	=cut	1514	=cut
1041		1515
1042	sub list_logins {	1516	sub list_logins {
1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1517	my $dirs = aio_readdir $PLAYERDIR
1044	or return [];	1518	or return [];
1045		1519
1046	my @logins;	1520	my @logins;
1047		1521
1048	for my $login (@$dirs) {	1522	for my $login (@$dirs) {
		1523	my $path = path $login;
		1524
		1525	# a .pst is a dead give-away for a valid player
		1526	unless (-e "$path.pst") {
1049	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1527	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1050	aio_read $fh, 0, 512, my $buf, 0 or next;	1528	aio_read $fh, 0, 512, my $buf, 0 or next;
1051	$buf !~ /^password -------------$/m or next; # official not-valid tag	1529	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1530	}
1052		1531
1053	utf8::decode $login;	1532	utf8::decode $login;
1054	push @logins, $login;	1533	push @logins, $login;
1055	}	1534	}
1056		1535
…		…
1064		1543
1065	=cut	1544	=cut
1066		1545
1067	sub maps($) {	1546	sub maps($) {
1068	my ($pl) = @_;	1547	my ($pl) = @_;
		1548
		1549	$pl = ref $pl ? $pl->ob->name : $pl;
1069		1550
1070	my $files = aio_readdir playerdir $pl	1551	my $files = aio_readdir playerdir $pl
1071	or return;	1552	or return;
1072		1553
1073	my @paths;	1554	my @paths;
…		…
1075	for (@$files) {	1556	for (@$files) {
1076	utf8::decode $_;	1557	utf8::decode $_;
1077	next if /\.(?:pl|pst)$/;	1558	next if /\.(?:pl|pst)$/;
1078	next unless /^$PATH_SEP/o;	1559	next unless /^$PATH_SEP/o;
1079		1560
1080	s/\.map$//;	1561	push @paths, cf::map::normalise "~$pl/$_";
1081	push @paths, "~" . $pl->ob->name . "/" . $_;
1082	}	1562	}
1083		1563
1084	\@paths	1564	\@paths
1085	}	1565	}
1086		1566
		1567	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1568
		1569	Expand crossfire pod fragments into protocol xml.
		1570
		1571	=cut
		1572
		1573	use re 'eval';
		1574
		1575	my $group;
		1576	my $interior; $interior = qr{
		1577	# match a pod interior sequence sans C<< >>
		1578	(?:
		1579	\ (.*?)\ (?{ $group = $^N })
		1580	| < (??{$interior}) >
		1581	)
		1582	}x;
		1583
		1584	sub expand_cfpod {
		1585	my ($self, $pod) = @_;
		1586
		1587	my $xml;
		1588
		1589	while () {
		1590	if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
		1591	$group = $1;
		1592
		1593	$group =~ s/&/&amp;/g;
		1594	$group =~ s/</&lt;/g;
		1595
		1596	$xml .= $group;
		1597	} elsif ($pod =~ m%\G
		1598	([BCGHITU])
		1599	<
		1600	(?:
		1601	([^<>]*) (?{ $group = $^N })
		1602	| < $interior >
		1603	)
		1604	>
		1605	%gcsx
		1606	) {
		1607	my ($code, $data) = ($1, $group);
		1608
		1609	if ($code eq "B") {
		1610	$xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
		1611	} elsif ($code eq "I") {
		1612	$xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
		1613	} elsif ($code eq "U") {
		1614	$xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
		1615	} elsif ($code eq "C") {
		1616	$xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
		1617	} elsif ($code eq "T") {
		1618	$xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
		1619	} elsif ($code eq "G") {
		1620	my ($male, $female) = split /\|/, $data;
		1621	$data = $self->gender ? $female : $male;
		1622	$xml .= expand_cfpod ($self, $data);
		1623	} elsif ($code eq "H") {
		1624	$xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
		1625	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1626	"")
		1627	[$self->{hintmode}];
		1628	} else {
		1629	$xml .= "error processing '$code($data)' directive";
		1630	}
		1631	} else {
		1632	if ($pod =~ /\G(.+)/) {
		1633	warn "parse error while expanding $pod (at $1)";
		1634	}
		1635	last;
		1636	}
		1637	}
		1638
		1639	for ($xml) {
		1640	# create single paragraphs (very hackish)
		1641	s/(?<=\S)\n(?=\w)/ /g;
		1642
		1643	# compress some whitespace
		1644	s/\s+\n/\n/g; # ws line-ends
		1645	s/\n\n+/\n/g; # double lines
		1646	s/^\n+//; # beginning lines
		1647	s/\n+$//; # ending lines
		1648	}
		1649
		1650	$xml
		1651	}
		1652
		1653	no re 'eval';
		1654
		1655	sub hintmode {
		1656	$_[0]{hintmode} = $_[1] if @_ > 1;
		1657	$_[0]{hintmode}
		1658	}
		1659
1087	=item $player->ext_reply ($msgid, $msgtype, %msg)	1660	=item $player->ext_reply ($msgid, @msg)
1088		1661
1089	Sends an ext reply to the player.	1662	Sends an ext reply to the player.
1090		1663
1091	=cut	1664	=cut
1092		1665
1093	sub ext_reply($$$%) {	1666	sub ext_reply($$@) {
1094	my ($self, $id, %msg) = @_;	1667	my ($self, $id, @msg) = @_;
1095		1668
1096	$msg{msgid} = $id;	1669	$self->ns->ext_reply ($id, @msg)
1097
1098	$self->send ("ext " . cf::to_json \%msg);
1099	}	1670	}
1100		1671
1101	package cf;	1672	=item $player->ext_msg ($type, @msg)
		1673
		1674	Sends an ext event to the client.
		1675
		1676	=cut
		1677
		1678	sub ext_msg($$@) {
		1679	my ($self, $type, @msg) = @_;
		1680
		1681	$self->ns->ext_msg ($type, @msg);
		1682	}
		1683
		1684	=head3 cf::region
		1685
		1686	=over 4
		1687
		1688	=cut
		1689
		1690	package cf::region;
		1691
		1692	=item cf::region::find_by_path $path
		1693
		1694	Tries to decuce the likely region for a map knowing only its path.
		1695
		1696	=cut
		1697
		1698	sub find_by_path($) {
		1699	my ($path) = @_;
		1700
		1701	my ($match, $specificity);
		1702
		1703	for my $region (list) {
		1704	if ($region->{match} && $path =~ $region->{match}) {
		1705	($match, $specificity) = ($region, $region->specificity)
		1706	if $region->specificity > $specificity;
		1707	}
		1708	}
		1709
		1710	$match
		1711	}
1102		1712
1103	=back	1713	=back
1104
1105		1714
1106	=head3 cf::map	1715	=head3 cf::map
1107		1716
1108	=over 4	1717	=over 4
1109		1718
…		…
1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1746	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138	(cf::region::find $rmp->{region}), $rmp->{custom}	1747	(cf::region::find $rmp->{region}), $rmp->{custom}
1139	)	1748	)
1140	}	1749	}
1141		1750
		1751	=item cf::map->register ($regex, $prio)
		1752
		1753	Register a handler for the map path matching the given regex at the
		1754	givne priority (higher is better, built-in handlers have priority 0, the
		1755	default).
		1756
		1757	=cut
		1758
1142	sub register {	1759	sub register {
1143	my (undef, $regex) = @_;	1760	my (undef, $regex, $prio) = @_;
1144	my $pkg = caller;	1761	my $pkg = caller;
1145		1762
1146	no strict;	1763	no strict;
1147	push @{"$pkg\::ISA"}, __PACKAGE__;	1764	push @{"$pkg\::ISA"}, __PACKAGE__;
1148		1765
1149	$EXT_MAP{$pkg} = qr<$regex>;	1766	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150	}	1767	}
1151		1768
1152	# also paths starting with '/'	1769	# also paths starting with '/'
1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};	1770	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154		1771
1155	sub thawer_merge {	1772	sub thawer_merge {
1156	my ($self, $merge) = @_;	1773	my ($self, $merge) = @_;
1157		1774
1158	# we have to keep some variables in memory intact	1775	# we have to keep some variables in memory intact
1159	local $self->{path};	1776	local $self->{path};
1160	local $self->{load_path};	1777	local $self->{load_path};
1161	local $self->{deny_save};
1162	local $self->{deny_reset};
1163		1778
1164	$self->SUPER::thawer_merge ($merge);	1779	$self->SUPER::thawer_merge ($merge);
1165	}	1780	}
1166		1781
1167	sub normalise {	1782	sub normalise {
1168	my ($path, $base) = @_;	1783	my ($path, $base) = @_;
		1784
		1785	$path = "$path"; # make sure its a string
		1786
		1787	$path =~ s/\.map$//;
1169		1788
1170	# map plan:	1789	# map plan:
1171	#	1790	#
1172	# /! non-realised random map exit (special hack!)	1791	# /! non-realised random map exit (special hack!)
1173	# {... are special paths that are not being touched	1792	# {... are special paths that are not being touched
…		…
1201		1820
1202	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object	1821	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203		1822
1204	$path = normalise $path, $base;	1823	$path = normalise $path, $base;
1205		1824
1206	for my $pkg (keys %EXT_MAP) {	1825	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1207	if ($path =~ $EXT_MAP{$pkg}) {	1826	if ($path =~ $EXT_MAP{$pkg}[1]) {
1208	my $self = bless cf::map::new, $pkg;	1827	my $self = bless cf::map::new, $pkg;
1209	$self->{path} = $path; $self->path ($path);	1828	$self->{path} = $path; $self->path ($path);
1210	$self->init; # pass $1 etc.	1829	$self->init; # pass $1 etc.
1211	return $self;	1830	return $self;
1212	}	1831	}
1213	}	1832	}
1214		1833
1215	Carp::carp "unable to resolve path '$path'.";	1834	Carp::cluck "unable to resolve path '$path' (base '$base').";
1216	()	1835	()
1217	}	1836	}
1218		1837
1219	sub init {	1838	sub init {
1220	my ($self) = @_;	1839	my ($self) = @_;
…		…
1235		1854
1236	# the original (read-only) location	1855	# the original (read-only) location
1237	sub load_path {	1856	sub load_path {
1238	my ($self) = @_;	1857	my ($self) = @_;
1239		1858
1240	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}	1859	"$MAPDIR/$self->{path}.map"
1241	}	1860	}
1242		1861
1243	# the temporary/swap location	1862	# the temporary/swap location
1244	sub save_path {	1863	sub save_path {
1245	my ($self) = @_;	1864	my ($self) = @_;
1246		1865
1247	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1866	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1248	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path	1867	"$TMPDIR/$path.map"
1249	}	1868	}
1250		1869
1251	# the unique path, undef == no special unique path	1870	# the unique path, undef == no special unique path
1252	sub uniq_path {	1871	sub uniq_path {
1253	my ($self) = @_;	1872	my ($self) = @_;
1254		1873
1255	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1874	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1256	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1875	"$UNIQUEDIR/$path"
1257	}	1876	}
1258		1877
1259	# and all this just because we cannot iterate over	1878	# and all this just because we cannot iterate over
1260	# all maps in C++...	1879	# all maps in C++...
1261	sub change_all_map_light {	1880	sub change_all_map_light {
…		…
1263		1882
1264	$_->change_map_light ($change)	1883	$_->change_map_light ($change)
1265	for grep $_->outdoor, values %cf::MAP;	1884	for grep $_->outdoor, values %cf::MAP;
1266	}	1885	}
1267		1886
		1887	sub decay_objects {
		1888	my ($self) = @_;
		1889
		1890	return if $self->{deny_reset};
		1891
		1892	$self->do_decay_objects;
		1893	}
		1894
1268	sub unlink_save {	1895	sub unlink_save {
1269	my ($self) = @_;	1896	my ($self) = @_;
1270		1897
1271	utf8::encode (my $save = $self->save_path);	1898	utf8::encode (my $save = $self->save_path);
1272	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1899	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
…		…
1275		1902
1276	sub load_header_from($) {	1903	sub load_header_from($) {
1277	my ($self, $path) = @_;	1904	my ($self, $path) = @_;
1278		1905
1279	utf8::encode $path;	1906	utf8::encode $path;
1280	aio_open $path, O_RDONLY, 0	1907	my $f = new_from_file cf::object::thawer $path
1281	or return;	1908	or return;
1282		1909
1283	$self->_load_header ($path)	1910	$self->_load_header ($f)
1284	or return;	1911	or return;
1285		1912
		1913	local $MAP_LOADING{$self->{path}} = $self;
		1914	$f->resolve_delayed_derefs;
		1915
1286	$self->{load_path} = $path;	1916	$self->{load_path} = $path;
1287		1917
1288	1	1918	1
1289	}	1919	}
1290		1920
1291	sub load_orig {	1921	sub load_header_orig {
1292	my ($self) = @_;	1922	my ($self) = @_;
1293		1923
1294	$self->load_header_from ($self->load_path)	1924	$self->load_header_from ($self->load_path)
1295	}	1925	}
1296		1926
1297	sub load_temp {	1927	sub load_header_temp {
1298	my ($self) = @_;	1928	my ($self) = @_;
1299		1929
1300	$self->load_header_from ($self->save_path)	1930	$self->load_header_from ($self->save_path)
		1931	}
		1932
		1933	sub prepare_temp {
		1934	my ($self) = @_;
		1935
		1936	$self->last_access ((delete $self->{last_access})
		1937	|| $cf::RUNTIME); #d#
		1938	# safety
		1939	$self->{instantiate_time} = $cf::RUNTIME
		1940	if $self->{instantiate_time} > $cf::RUNTIME;
		1941	}
		1942
		1943	sub prepare_orig {
		1944	my ($self) = @_;
		1945
		1946	$self->{load_original} = 1;
		1947	$self->{instantiate_time} = $cf::RUNTIME;
		1948	$self->last_access ($cf::RUNTIME);
		1949	$self->instantiate;
1301	}	1950	}
1302		1951
1303	sub load_header {	1952	sub load_header {
1304	my ($self) = @_;	1953	my ($self) = @_;
1305		1954
1306	if ($self->load_temp) {	1955	if ($self->load_header_temp) {
1307	$self->last_access ((delete $self->{last_access})	1956	$self->prepare_temp;
1308	|| $cf::RUNTIME); #d#
1309	# safety
1310	$self->{instantiate_time} = $cf::RUNTIME
1311	if $self->{instantiate_time} > $cf::RUNTIME;
1312	} else {	1957	} else {
1313	$self->load_orig	1958	$self->load_header_orig
1314	or return;	1959	or return;
1315		1960	$self->prepare_orig;
1316	$self->{load_original} = 1;
1317	$self->{instantiate_time} = $cf::RUNTIME;
1318	$self->last_access ($cf::RUNTIME);
1319	$self->instantiate;
1320	}	1961	}
		1962
		1963	$self->{deny_reset} = 1
		1964	if $self->no_reset;
		1965
		1966	$self->default_region (cf::region::find_by_path $self->{path})
		1967	unless $self->default_region;
1321		1968
1322	1	1969	1
1323	}	1970	}
1324		1971
1325	sub find;	1972	sub find;
1326	sub find {	1973	sub find {
1327	my ($path, $origin) = @_;	1974	my ($path, $origin) = @_;
1328		1975
1329	$path = normalise $path, $origin && $origin->path;	1976	$path = normalise $path, $origin && $origin->path;
1330		1977
		1978	cf::lock_wait "map_data:$path";#d#remove
1331	cf::lock_wait "map_find:$path";	1979	cf::lock_wait "map_find:$path";
1332		1980
1333	$cf::MAP{$path} || do {	1981	$cf::MAP{$path} || do {
1334	my $guard = cf::lock_acquire "map_find:$path";	1982	my $guard1 = cf::lock_acquire "map_find:$path";
		1983	my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
		1984
1335	my $map = new_from_path cf::map $path	1985	my $map = new_from_path cf::map $path
1336	or return;	1986	or return;
1337		1987
1338	$map->{last_save} = $cf::RUNTIME;	1988	$map->{last_save} = $cf::RUNTIME;
1339		1989
1340	$map->load_header	1990	$map->load_header
1341	or return;	1991	or return;
1342		1992
1343	if ($map->should_reset) {	1993	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1994	# doing this can freeze the server in a sync job, obviously
1344	$cf::WAIT_FOR_TICK->wait;	1995	#$cf::WAIT_FOR_TICK->wait;
		1996	undef $guard1;
		1997	undef $guard2;
1345	$map->reset;	1998	$map->reset;
1346	undef $guard;
1347	$map = find $path	1999	return find $path;
1348	or return;
1349	}	2000	}
1350		2001
1351	$cf::MAP{$path} = $map	2002	$cf::MAP{$path} = $map
1352	}	2003	}
1353	}	2004	}
		2005
		2006	sub pre_load { }
		2007	sub post_load { }
1354		2008
1355	sub load {	2009	sub load {
1356	my ($self) = @_;	2010	my ($self) = @_;
1357		2011
		2012	local $self->{deny_reset} = 1; # loading can take a long time
		2013
1358	my $path = $self->{path};	2014	my $path = $self->{path};
		2015
		2016	{
1359	my $guard = cf::lock_acquire "map_load:$path";	2017	my $guard = cf::lock_acquire "map_data:$path";
1360		2018
		2019	return unless $self->valid;
1361	return if $self->in_memory != cf::MAP_SWAPPED;	2020	return unless $self->in_memory == cf::MAP_SWAPPED;
1362		2021
1363	$self->in_memory (cf::MAP_LOADING);	2022	$self->in_memory (cf::MAP_LOADING);
1364		2023
1365	$self->alloc;	2024	$self->alloc;
1366	$self->_load_objects ($self->{load_path}, 1)	2025
		2026	$self->pre_load;
		2027	cf::cede_to_tick;
		2028
		2029	my $f = new_from_file cf::object::thawer $self->{load_path};
		2030	$f->skip_block;
		2031	$self->_load_objects ($f)
1367	or return;	2032	or return;
1368		2033
1369	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2034	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1370	if delete $self->{load_original};	2035	if delete $self->{load_original};
1371		2036
1372	if (my $uniq = $self->uniq_path) {	2037	if (my $uniq = $self->uniq_path) {
1373	utf8::encode $uniq;	2038	utf8::encode $uniq;
1374	if (aio_open $uniq, O_RDONLY, 0) {	2039	unless (aio_stat $uniq) {
		2040	if (my $f = new_from_file cf::object::thawer $uniq) {
1375	$self->clear_unique_items;	2041	$self->clear_unique_items;
1376	$self->_load_objects ($uniq, 0);	2042	$self->_load_objects ($f);
		2043	$f->resolve_delayed_derefs;
		2044	}
1377	}	2045	}
1378	}	2046	}
1379		2047
1380	Coro::cede;	2048	$f->resolve_delayed_derefs;
1381		2049
		2050	cf::cede_to_tick;
1382	# now do the right thing for maps	2051	# now do the right thing for maps
1383	$self->link_multipart_objects;	2052	$self->link_multipart_objects;
1384
1385	unless ($self->{deny_activate}) {
1386	$self->decay_objects;
1387	$self->fix_auto_apply;
1388	$self->update_buttons;
1389	Coro::cede;
1390	$self->set_darkness_map;
1391	$self->difficulty ($self->estimate_difficulty)	2053	$self->difficulty ($self->estimate_difficulty)
1392	unless $self->difficulty;	2054	unless $self->difficulty;
1393	Coro::cede;	2055	cf::cede_to_tick;
		2056
		2057	unless ($self->{deny_activate}) {
		2058	$self->decay_objects;
		2059	$self->fix_auto_apply;
		2060	$self->update_buttons;
		2061	cf::cede_to_tick;
		2062	$self->set_darkness_map;
		2063	cf::cede_to_tick;
1394	$self->activate;	2064	$self->activate;
1395	}	2065	}
1396		2066
		2067	$self->{last_save} = $cf::RUNTIME;
		2068	$self->last_access ($cf::RUNTIME);
		2069
1397	$self->in_memory (cf::MAP_IN_MEMORY);	2070	$self->in_memory (cf::MAP_IN_MEMORY);
		2071	}
		2072
		2073	$self->post_load;
1398	}	2074	}
1399		2075
1400	sub customise_for {	2076	sub customise_for {
1401	my ($self, $ob) = @_;	2077	my ($self, $ob) = @_;
1402		2078
1403	return find "~" . $ob->name . "/" . $self->{path}	2079	return find "~" . $ob->name . "/" . $self->{path}
1404	if $self->per_player;	2080	if $self->per_player;
1405		2081
		2082	# return find "?party/" . $ob->name . "/" . $self->{path}
		2083	# if $self->per_party;
		2084
1406	$self	2085	$self
1407	}	2086	}
1408		2087
1409	# find and load all maps in the 3x3 area around a map	2088	# find and load all maps in the 3x3 area around a map
1410	sub load_diag {	2089	sub load_neighbours {
1411	my ($map) = @_;	2090	my ($map) = @_;
1412		2091
1413	my @diag; # diagonal neighbours	2092	my @neigh; # diagonal neighbours
1414		2093
1415	for (0 .. 3) {	2094	for (0 .. 3) {
1416	my $neigh = $map->tile_path ($_)	2095	my $neigh = $map->tile_path ($_)
1417	or next;	2096	or next;
1418	$neigh = find $neigh, $map	2097	$neigh = find $neigh, $map
1419	or next;	2098	or next;
1420	$neigh->load;	2099	$neigh->load;
1421		2100
		2101	push @neigh,
1422	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2102	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1423	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2103	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1424	}	2104	}
1425		2105
1426	for (@diag) {	2106	for (grep defined $_->[0], @neigh) {
		2107	my ($path, $origin) = @$_;
1427	my $neigh = find @$_	2108	my $neigh = find $path, $origin
1428	or next;	2109	or next;
1429	$neigh->load;	2110	$neigh->load;
1430	}	2111	}
1431	}	2112	}
1432		2113
…		…
1437	}	2118	}
1438		2119
1439	sub do_load_sync {	2120	sub do_load_sync {
1440	my ($map) = @_;	2121	my ($map) = @_;
1441		2122
		2123	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2124	if $Coro::current == $Coro::main;
		2125
1442	cf::sync_job { $map->load };	2126	cf::sync_job { $map->load };
1443	}	2127	}
1444		2128
1445	our %MAP_PREFETCH;	2129	our %MAP_PREFETCH;
1446	our $MAP_PREFETCHER = undef;	2130	our $MAP_PREFETCHER = undef;
1447		2131
1448	sub find_async {	2132	sub find_async {
1449	my ($path, $origin) = @_;	2133	my ($path, $origin, $load) = @_;
1450		2134
1451	$path = normalise $path, $origin && $origin->{path};	2135	$path = normalise $path, $origin && $origin->{path};
1452		2136
1453	if (my $map = $cf::MAP{$path}) {	2137	if (my $map = $cf::MAP{$path}) {
1454	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2138	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1455	}	2139	}
1456		2140
1457	undef $MAP_PREFETCH{$path};	2141	$MAP_PREFETCH{$path} |= $load;
		2142
1458	$MAP_PREFETCHER ||= cf::async {	2143	$MAP_PREFETCHER ||= cf::async {
		2144	$Coro::current->{desc} = "map prefetcher";
		2145
1459	while (%MAP_PREFETCH) {	2146	while (%MAP_PREFETCH) {
1460	for my $path (keys %MAP_PREFETCH) {	2147	while (my ($k, $v) = each %MAP_PREFETCH) {
1461	warn "prefetching $path...\n";#d#
1462	my $map = find $path	2148	if (my $map = find $k) {
1463	or next;
1464	$map->load;	2149	$map->load if $v;
		2150	}
1465		2151
1466	delete $MAP_PREFETCH{$path};	2152	delete $MAP_PREFETCH{$k};
1467	}	2153	}
1468	}	2154	}
1469	undef $MAP_PREFETCHER;	2155	undef $MAP_PREFETCHER;
1470	};	2156	};
		2157	$MAP_PREFETCHER->prio (6);
1471		2158
1472	()	2159	()
1473	}	2160	}
1474		2161
1475	sub save {	2162	sub save {
1476	my ($self) = @_;	2163	my ($self) = @_;
1477		2164
1478	my $lock = cf::lock_acquire "map_data:" . $self->path;	2165	my $lock = cf::lock_acquire "map_data:$self->{path}";
1479		2166
1480	$self->{last_save} = $cf::RUNTIME;	2167	$self->{last_save} = $cf::RUNTIME;
1481		2168
1482	return unless $self->dirty;	2169	return unless $self->dirty;
1483		2170
…		…
1489	return if $self->{deny_save};	2176	return if $self->{deny_save};
1490		2177
1491	local $self->{last_access} = $self->last_access;#d#	2178	local $self->{last_access} = $self->last_access;#d#
1492		2179
1493	cf::async {	2180	cf::async {
		2181	$Coro::current->{desc} = "map player save";
1494	$_->contr->save for $self->players;	2182	$_->contr->save for $self->players;
1495	};	2183	};
1496		2184
1497	if ($uniq) {	2185	if ($uniq) {
1498	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2186	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
…		…
1506	my ($self) = @_;	2194	my ($self) = @_;
1507		2195
1508	# save first because save cedes	2196	# save first because save cedes
1509	$self->save;	2197	$self->save;
1510		2198
1511	my $lock = cf::lock_acquire "map_data:" . $self->path;	2199	my $lock = cf::lock_acquire "map_data:$self->{path}";
1512		2200
1513	return if $self->players;	2201	return if $self->players;
1514	return if $self->in_memory != cf::MAP_IN_MEMORY;	2202	return if $self->in_memory != cf::MAP_IN_MEMORY;
1515	return if $self->{deny_save};	2203	return if $self->{deny_save};
1516		2204
		2205	$self->in_memory (cf::MAP_SWAPPED);
		2206
		2207	$self->deactivate;
		2208	$_->clear_links_to ($self) for values %cf::MAP;
1517	$self->clear;	2209	$self->clear;
1518	$self->in_memory (cf::MAP_SWAPPED);
1519	}	2210	}
1520		2211
1521	sub reset_at {	2212	sub reset_at {
1522	my ($self) = @_;	2213	my ($self) = @_;
1523		2214
1524	# TODO: safety, remove and allow resettable per-player maps	2215	# TODO: safety, remove and allow resettable per-player maps
1525	return 1e99 if $self->isa ("ext::map_per_player");#d#
1526	return 1e99 if $self->{deny_reset};	2216	return 1e99 if $self->{deny_reset};
1527		2217
1528	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2218	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1529	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2219	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1530		2220
…		…
1541	my ($self) = @_;	2231	my ($self) = @_;
1542		2232
1543	my $lock = cf::lock_acquire "map_data:$self->{path}";	2233	my $lock = cf::lock_acquire "map_data:$self->{path}";
1544		2234
1545	return if $self->players;	2235	return if $self->players;
1546	return if $self->isa ("ext::map_per_player");#d#
1547		2236
1548	warn "resetting map ", $self->path;#d#	2237	warn "resetting map ", $self->path;
		2238
		2239	$self->in_memory (cf::MAP_SWAPPED);
		2240
		2241	# need to save uniques path
		2242	unless ($self->{deny_save}) {
		2243	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2244
		2245	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2246	if $uniq;
		2247	}
1549		2248
1550	delete $cf::MAP{$self->path};	2249	delete $cf::MAP{$self->path};
1551		2250
1552	$self->in_memory (cf::MAP_SWAPPED);	2251	$self->deactivate;
		2252	$_->clear_links_to ($self) for values %cf::MAP;
1553	$self->clear;	2253	$self->clear;
1554
1555	$_->clear_links_to ($self) for values %cf::MAP;
1556		2254
1557	$self->unlink_save;	2255	$self->unlink_save;
1558	$self->destroy;	2256	$self->destroy;
1559	}	2257	}
1560		2258
1561	my $nuke_counter = "aaaa";	2259	my $nuke_counter = "aaaa";
1562		2260
1563	sub nuke {	2261	sub nuke {
1564	my ($self) = @_;	2262	my ($self) = @_;
1565		2263
		2264	{
		2265	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2266
1566	delete $cf::MAP{$self->path};	2267	delete $cf::MAP{$self->path};
1567		2268
1568	$self->unlink_save;	2269	$self->unlink_save;
1569		2270
1570	bless $self, "cf::map";	2271	bless $self, "cf::map";
1571	delete $self->{deny_reset};	2272	delete $self->{deny_reset};
1572	$self->{deny_save} = 1;	2273	$self->{deny_save} = 1;
1573	$self->reset_timeout (1);	2274	$self->reset_timeout (1);
1574	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2275	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1575		2276
1576	$cf::MAP{$self->path} = $self;	2277	$cf::MAP{$self->path} = $self;
		2278	}
1577		2279
1578	$self->reset; # polite request, might not happen	2280	$self->reset; # polite request, might not happen
		2281	}
		2282
		2283	=item $maps = cf::map::tmp_maps
		2284
		2285	Returns an arrayref with all map paths of currently instantiated and saved
		2286	maps. May block.
		2287
		2288	=cut
		2289
		2290	sub tmp_maps() {
		2291	[
		2292	map {
		2293	utf8::decode $_;
		2294	/\.map$/
		2295	? normalise $_
		2296	: ()
		2297	} @{ aio_readdir $TMPDIR or [] }
		2298	]
		2299	}
		2300
		2301	=item $maps = cf::map::random_maps
		2302
		2303	Returns an arrayref with all map paths of currently instantiated and saved
		2304	random maps. May block.
		2305
		2306	=cut
		2307
		2308	sub random_maps() {
		2309	[
		2310	map {
		2311	utf8::decode $_;
		2312	/\.map$/
		2313	? normalise "?random/$_"
		2314	: ()
		2315	} @{ aio_readdir $RANDOMDIR or [] }
		2316	]
1579	}	2317	}
1580		2318
1581	=item cf::map::unique_maps	2319	=item cf::map::unique_maps
1582		2320
1583	Returns an arrayref of paths of all shared maps that have	2321	Returns an arrayref of paths of all shared maps that have
1584	instantiated unique items. May block.	2322	instantiated unique items. May block.
1585		2323
1586	=cut	2324	=cut
1587		2325
1588	sub unique_maps() {	2326	sub unique_maps() {
1589	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2327	[
1590	or return;	2328	map {
1591
1592	my @paths;
1593
1594	for (@$files) {
1595	utf8::decode $_;	2329	utf8::decode $_;
1596	next if /\.pst$/;
1597	next unless /^$PATH_SEP/o;
1598
1599	s/\.map$//;	2330	/\.map$/
1600	push @paths, $_;	2331	? normalise $_
		2332	: ()
		2333	} @{ aio_readdir $UNIQUEDIR or [] }
1601	}	2334	]
1602
1603	\@paths
1604	}	2335	}
1605		2336
1606	package cf;	2337	package cf;
1607		2338
1608	=back	2339	=back
…		…
1626	map { $_, inv_recursive_ $_->inv } @_	2357	map { $_, inv_recursive_ $_->inv } @_
1627	}	2358	}
1628		2359
1629	sub inv_recursive {	2360	sub inv_recursive {
1630	inv_recursive_ inv $_[0]	2361	inv_recursive_ inv $_[0]
		2362	}
		2363
		2364	=item $ref = $ob->ref
		2365
		2366	creates and returns a persistent reference to an objetc that can be stored as a string.
		2367
		2368	=item $ob = cf::object::deref ($refstring)
		2369
		2370	returns the objetc referenced by refstring. may return undef when it cnanot find the object,
		2371	even if the object actually exists. May block.
		2372
		2373	=cut
		2374
		2375	sub deref {
		2376	my ($ref) = @_;
		2377
		2378	if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
		2379	my ($uuid, $name) = ($1, $2);
		2380	my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
		2381	or return;
		2382	$pl->ob->uuid eq $uuid
		2383	or return;
		2384
		2385	$pl->ob
		2386	} else {
		2387	warn "$ref: cannot resolve object reference\n";
		2388	undef
		2389	}
1631	}	2390	}
1632		2391
1633	package cf;	2392	package cf;
1634		2393
1635	=back	2394	=back
…		…
1654		2413
1655	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2414	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1656		2415
1657	if ($self->{record_replies}) {	2416	if ($self->{record_replies}) {
1658	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2417	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2418
1659	} else {	2419	} else {
		2420	my $pl = $self->contr;
		2421
		2422	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2423	my $dialog = $pl->{npc_dialog};
		2424	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2425
		2426	} else {
1660	$msg = $npc->name . " says: $msg" if $npc;	2427	$msg = $npc->name . " says: $msg" if $npc;
1661	$self->message ($msg, $flags);	2428	$self->message ($msg, $flags);
		2429	}
1662	}	2430	}
		2431	}
		2432
		2433	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2434
		2435	=cut
		2436
		2437	sub cf::object::send_msg {
		2438	my $pl = shift->contr
		2439	or return;
		2440	$pl->send_msg (@_);
1663	}	2441	}
1664		2442
1665	=item $player_object->may ("access")	2443	=item $player_object->may ("access")
1666		2444
1667	Returns wether the given player is authorized to access resource "access"	2445	Returns wether the given player is authorized to access resource "access"
…		…
1699	=cut	2477	=cut
1700		2478
1701	sub link_map {	2479	sub link_map {
1702	unless ($LINK_MAP) {	2480	unless ($LINK_MAP) {
1703	$LINK_MAP = cf::map::find "{link}"	2481	$LINK_MAP = cf::map::find "{link}"
1704	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };	2482	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1705	$LINK_MAP->load;	2483	$LINK_MAP->load;
1706	}	2484	}
1707		2485
1708	$LINK_MAP	2486	$LINK_MAP
1709	}	2487	}
…		…
1714	$self->deactivate_recursive;	2492	$self->deactivate_recursive;
1715		2493
1716	return if UNIVERSAL::isa $self->map, "ext::map_link";	2494	return if UNIVERSAL::isa $self->map, "ext::map_link";
1717		2495
1718	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2496	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1719	if $self->map;	2497	if $self->map && $self->map->{path} ne "{link}";
1720		2498
1721	$self->enter_map ($LINK_MAP || link_map, 20, 20);	2499	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1722	}	2500	}
1723		2501
1724	sub cf::object::player::leave_link {	2502	sub cf::object::player::leave_link {
1725	my ($self, $map, $x, $y) = @_;	2503	my ($self, $map, $x, $y) = @_;
		2504
		2505	return unless $self->contr->active;
1726		2506
1727	my $link_pos = delete $self->{_link_pos};	2507	my $link_pos = delete $self->{_link_pos};
1728		2508
1729	unless ($map) {	2509	unless ($map) {
1730	# restore original map position	2510	# restore original map position
…		…
1744	# use -1 or undef as default coordinates, not 0, 0	2524	# use -1 or undef as default coordinates, not 0, 0
1745	($x, $y) = ($map->enter_x, $map->enter_y)	2525	($x, $y) = ($map->enter_x, $map->enter_y)
1746	if $x <=0 && $y <= 0;	2526	if $x <=0 && $y <= 0;
1747		2527
1748	$map->load;	2528	$map->load;
1749	$map->load_diag;	2529	$map->load_neighbours;
1750		2530
1751	return unless $self->contr->active;	2531	return unless $self->contr->active;
1752	$self->activate_recursive;	2532	$self->activate_recursive;
		2533
		2534	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1753	$self->enter_map ($map, $x, $y);	2535	$self->enter_map ($map, $x, $y);
1754	}	2536	}
1755		2537
1756	cf::player->attach (	2538	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1757	on_logout => sub {
1758	my ($pl) = @_;
1759		2539
1760	# abort map switching before logout	2540	Moves the player to the given map-path and coordinates by first freezing
1761	if ($pl->ob->{_link_pos}) {	2541	her, loading and preparing them map, calling the provided $check callback
1762	cf::sync_job {	2542	that has to return the map if sucecssful, and then unfreezes the player on
1763	$pl->ob->leave_link	2543	the new (success) or old (failed) map position. In either case, $done will
1764	};	2544	be called at the end of this process.
1765	}
1766	},
1767	on_login => sub {
1768	my ($pl) = @_;
1769		2545
1770	# try to abort aborted map switching on player login :)
1771	# should happen only on crashes
1772	if ($pl->ob->{_link_pos}) {
1773	$pl->ob->enter_link;
1774	(async {
1775	# we need this sleep as the login has a concurrent enter_exit running
1776	# and this sleep increases chances of the player not ending up in scorn
1777	$pl->ob->reply (undef,
1778	"There was an internal problem at your last logout, "
1779	. "the server will try to bring you to your intended destination in a second.",
1780	cf::NDI_RED);
1781	Coro::Timer::sleep 1;
1782	$pl->ob->leave_link;
1783	})->prio (2);
1784	}
1785	},
1786	);
1787
1788	=item $player_object->goto ($path, $x, $y)
1789
1790	=cut	2546	=cut
		2547
		2548	our $GOTOGEN;
1791		2549
1792	sub cf::object::player::goto {	2550	sub cf::object::player::goto {
1793	my ($self, $path, $x, $y) = @_;	2551	my ($self, $path, $x, $y, $check, $done) = @_;
		2552
		2553	# do generation counting so two concurrent goto's will be executed in-order
		2554	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1794		2555
1795	$self->enter_link;	2556	$self->enter_link;
1796		2557
1797	(async {	2558	(async {
1798	my $map = cf::map::find $path;	2559	$Coro::current->{desc} = "player::goto $path $x $y";
		2560
		2561	# *tag paths override both path and x|y
		2562	if ($path =~ /^\*(.*)$/) {
		2563	if (my @obs = grep $_->map, ext::map_tags::find $1) {
		2564	my $ob = $obs[rand @obs];
		2565
		2566	# see if we actually can go there
		2567	if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
		2568	$ob = $obs[rand @obs];
		2569	} else {
		2570	$self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
		2571	}
		2572	# else put us there anyways for now #d#
		2573
		2574	($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
		2575	} else {
		2576	($path, $x, $y) = (undef, undef, undef);
		2577	}
		2578	}
		2579
		2580	my $map = eval {
		2581	my $map = defined $path ? cf::map::find $path : undef;
		2582
		2583	if ($map) {
1799	$map = $map->customise_for ($self) if $map;	2584	$map = $map->customise_for ($self);
1800		2585	$map = $check->($map) if $check && $map;
1801	# warn "entering ", $map->path, " at ($x, $y)\n"	2586	} else {
1802	# if $map;
1803
1804	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2587	$self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
		2588	}
1805		2589
		2590	$map
		2591	};
		2592
		2593	if ($@) {
		2594	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2595	LOG llevError | logBacktrace, Carp::longmess $@;
		2596	}
		2597
		2598	if ($gen == $self->{_goto_generation}) {
		2599	delete $self->{_goto_generation};
1806	$self->leave_link ($map, $x, $y);	2600	$self->leave_link ($map, $x, $y);
		2601	}
		2602
		2603	$done->() if $done;
1807	})->prio (1);	2604	})->prio (1);
1808	}	2605	}
1809		2606
1810	=item $player_object->enter_exit ($exit_object)	2607	=item $player_object->enter_exit ($exit_object)
1811		2608
…		…
1840	# that depends on the exit object	2637	# that depends on the exit object
1841		2638
1842	my $rmp = parse_random_map_params $exit->msg;	2639	my $rmp = parse_random_map_params $exit->msg;
1843		2640
1844	if ($exit->map) {	2641	if ($exit->map) {
1845	$rmp->{region} = $exit->map->region_name;	2642	$rmp->{region} = $exit->region->name;
1846	$rmp->{origin_map} = $exit->map->path;	2643	$rmp->{origin_map} = $exit->map->path;
1847	$rmp->{origin_x} = $exit->x;	2644	$rmp->{origin_x} = $exit->x;
1848	$rmp->{origin_y} = $exit->y;	2645	$rmp->{origin_y} = $exit->y;
1849	}	2646	}
1850		2647
1851	$rmp->{random_seed} ||= $exit->random_seed;	2648	$rmp->{random_seed} ||= $exit->random_seed;
1852		2649
1853	my $data = cf::to_json $rmp;	2650	my $data = cf::encode_json $rmp;
1854	my $md5 = Digest::MD5::md5_hex $data;	2651	my $md5 = Digest::MD5::md5_hex $data;
1855	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2652	my $meta = "$RANDOMDIR/$md5.meta";
1856		2653
1857	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2654	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1858	aio_write $fh, 0, (length $data), $data, 0;	2655	aio_write $fh, 0, (length $data), $data, 0;
1859	undef $fh;	2656	undef $fh;
1860	aio_rename "$meta~", $meta;	2657	aio_rename "$meta~", $meta;
…		…
1867	sub cf::object::player::enter_exit {	2664	sub cf::object::player::enter_exit {
1868	my ($self, $exit) = @_;	2665	my ($self, $exit) = @_;
1869		2666
1870	return unless $self->type == cf::PLAYER;	2667	return unless $self->type == cf::PLAYER;
1871		2668
		2669	if ($exit->slaying eq "/!") {
		2670	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2671	# the problem is that $exit might not survive long enough
		2672	# so it needs to be done right now, right here
		2673	cf::sync_job { prepare_random_map $exit };
		2674	}
		2675
		2676	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2677	my $hp = $exit->stats->hp;
		2678	my $sp = $exit->stats->sp;
		2679
1872	$self->enter_link;	2680	$self->enter_link;
1873		2681
		2682	# if exit is damned, update players death & WoR home-position
		2683	$self->contr->savebed ($slaying, $hp, $sp)
		2684	if $exit->flag (FLAG_DAMNED);
		2685
1874	(async {	2686	(async {
		2687	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2688
1875	$self->deactivate_recursive; # just to be sure	2689	$self->deactivate_recursive; # just to be sure
1876	unless (eval {	2690	unless (eval {
1877	prepare_random_map $exit	2691	$self->goto ($slaying, $hp, $sp);
1878	if $exit->slaying eq "/!";
1879
1880	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1881	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1882		2692
1883	1;	2693	1;
1884	}) {	2694	}) {
1885	$self->message ("Something went wrong deep within the crossfire server. "	2695	$self->message ("Something went wrong deep within the crossfire server. "
1886	. "I'll try to bring you back to the map you were before. "	2696	. "I'll try to bring you back to the map you were before. "
1887	. "Please report this to the dungeon master!",	2697	. "Please report this to the dungeon master!",
1888	cf::NDI_UNIQUE | cf::NDI_RED);	2698	cf::NDI_UNIQUE | cf::NDI_RED);
1889		2699
1890	warn "ERROR in enter_exit: $@";	2700	warn "ERROR in enter_exit: $@";
1891	$self->leave_link;	2701	$self->leave_link;
1892	}	2702	}
1893	})->prio (1);	2703	})->prio (1);
…		…
1906		2716
1907	sub cf::client::send_drawinfo {	2717	sub cf::client::send_drawinfo {
1908	my ($self, $text, $flags) = @_;	2718	my ($self, $text, $flags) = @_;
1909		2719
1910	utf8::encode $text;	2720	utf8::encode $text;
1911	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2721	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1912	}	2722	}
1913		2723
		2724	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2725
		2726	Send a drawinfo or msg packet to the client, formatting the msg for the
		2727	client if neccessary. C<$type> should be a string identifying the type of
		2728	the message, with C<log> being the default. If C<$color> is negative, suppress
		2729	the message unless the client supports the msg packet.
		2730
		2731	=cut
		2732
		2733	# non-persistent channels (usually the info channel)
		2734	our %CHANNEL = (
		2735	"c/identify" => {
		2736	id => "infobox",
		2737	title => "Identify",
		2738	reply => undef,
		2739	tooltip => "Items recently identified",
		2740	},
		2741	"c/examine" => {
		2742	id => "infobox",
		2743	title => "Examine",
		2744	reply => undef,
		2745	tooltip => "Signs and other items you examined",
		2746	},
		2747	"c/book" => {
		2748	id => "infobox",
		2749	title => "Book",
		2750	reply => undef,
		2751	tooltip => "The contents of a note or book",
		2752	},
		2753	"c/lookat" => {
		2754	id => "infobox",
		2755	title => "Look",
		2756	reply => undef,
		2757	tooltip => "What you saw there",
		2758	},
		2759	"c/who" => {
		2760	id => "infobox",
		2761	title => "Players",
		2762	reply => undef,
		2763	tooltip => "Shows players who are currently online",
		2764	},
		2765	"c/body" => {
		2766	id => "infobox",
		2767	title => "Body Parts",
		2768	reply => undef,
		2769	tooltip => "Shows which body parts you posess and are available",
		2770	},
		2771	"c/uptime" => {
		2772	id => "infobox",
		2773	title => "Uptime",
		2774	reply => undef,
		2775	tooltip => "How long the server has been running since last restart",
		2776	},
		2777	"c/mapinfo" => {
		2778	id => "infobox",
		2779	title => "Map Info",
		2780	reply => undef,
		2781	tooltip => "Information related to the maps",
		2782	},
		2783	);
		2784
		2785	sub cf::client::send_msg {
		2786	my ($self, $channel, $msg, $color, @extra) = @_;
		2787
		2788	$msg = $self->pl->expand_cfpod ($msg);
		2789
		2790	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2791
		2792	# check predefined channels, for the benefit of C
		2793	if ($CHANNEL{$channel}) {
		2794	$channel = $CHANNEL{$channel};
		2795
		2796	$self->ext_msg (channel_info => $channel)
		2797	if $self->can_msg;
		2798
		2799	$channel = $channel->{id};
		2800
		2801	} elsif (ref $channel) {
		2802	# send meta info to client, if not yet sent
		2803	unless (exists $self->{channel}{$channel->{id}}) {
		2804	$self->{channel}{$channel->{id}} = $channel;
		2805	$self->ext_msg (channel_info => $channel)
		2806	if $self->can_msg;
		2807	}
		2808
		2809	$channel = $channel->{id};
		2810	}
		2811
		2812	return unless @extra || length $msg;
		2813
		2814	if ($self->can_msg) {
		2815	# default colour, mask it out
		2816	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2817	if $color & cf::NDI_DEF;
		2818
		2819	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2820	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2821	} else {
		2822	if ($color >= 0) {
		2823	# replace some tags by gcfclient-compatible ones
		2824	for ($msg) {
		2825	1 while
		2826	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2827	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2828	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2829	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2830	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2831	}
		2832
		2833	$color &= cf::NDI_COLOR_MASK;
		2834
		2835	utf8::encode $msg;
		2836
		2837	if (0 && $msg =~ /\[/) {
		2838	# COMMAND/INFO
		2839	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2840	} else {
		2841	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2842	$self->send_packet ("drawinfo $color $msg")
		2843	}
		2844	}
		2845	}
		2846	}
		2847
		2848	=item $client->ext_msg ($type, @msg)
		2849
		2850	Sends an ext event to the client.
		2851
		2852	=cut
		2853
		2854	sub cf::client::ext_msg($$@) {
		2855	my ($self, $type, @msg) = @_;
		2856
		2857	if ($self->extcmd == 2) {
		2858	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2859	} elsif ($self->extcmd == 1) { # TODO: remove
		2860	push @msg, msgtype => "event_$type";
		2861	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2862	}
		2863	}
		2864
		2865	=item $client->ext_reply ($msgid, @msg)
		2866
		2867	Sends an ext reply to the client.
		2868
		2869	=cut
		2870
		2871	sub cf::client::ext_reply($$@) {
		2872	my ($self, $id, @msg) = @_;
		2873
		2874	if ($self->extcmd == 2) {
		2875	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2876	} elsif ($self->extcmd == 1) {
		2877	#TODO: version 1, remove
		2878	unshift @msg, msgtype => "reply", msgid => $id;
		2879	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2880	}
		2881	}
1914		2882
1915	=item $success = $client->query ($flags, "text", \&cb)	2883	=item $success = $client->query ($flags, "text", \&cb)
1916		2884
1917	Queues a query to the client, calling the given callback with	2885	Queues a query to the client, calling the given callback with
1918	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2886	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1919	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2887	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1920		2888
1921	Queries can fail, so check the return code. Or don't, as queries will become	2889	Queries can fail, so check the return code. Or don't, as queries will
1922	reliable at some point in the future.	2890	become reliable at some point in the future.
1923		2891
1924	=cut	2892	=cut
1925		2893
1926	sub cf::client::query {	2894	sub cf::client::query {
1927	my ($self, $flags, $text, $cb) = @_;	2895	my ($self, $flags, $text, $cb) = @_;
…		…
1935	utf8::encode $text;	2903	utf8::encode $text;
1936	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2904	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1937		2905
1938	$self->send_packet ($self->{query_queue}[0][0])	2906	$self->send_packet ($self->{query_queue}[0][0])
1939	if @{ $self->{query_queue} } == 1;	2907	if @{ $self->{query_queue} } == 1;
		2908
		2909	1
1940	}	2910	}
1941		2911
1942	cf::client->attach (	2912	cf::client->attach (
		2913	on_connect => sub {
		2914	my ($ns) = @_;
		2915
		2916	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2917	},
1943	on_reply => sub {	2918	on_reply => sub {
1944	my ($ns, $msg) = @_;	2919	my ($ns, $msg) = @_;
1945		2920
1946	# this weird shuffling is so that direct followup queries	2921	# this weird shuffling is so that direct followup queries
1947	# get handled first	2922	# get handled first
1948	my $queue = delete $ns->{query_queue}	2923	my $queue = delete $ns->{query_queue}
1949	or return; # be conservative, not sure how that can happen, but we saw a crash here	2924	or return; # be conservative, not sure how that can happen, but we saw a crash here
1950		2925
1951	(shift @$queue)->[1]->($msg);	2926	(shift @$queue)->[1]->($msg);
		2927	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1952		2928
1953	push @{ $ns->{query_queue} }, @$queue;	2929	push @{ $ns->{query_queue} }, @$queue;
1954		2930
1955	if (@{ $ns->{query_queue} } == @$queue) {	2931	if (@{ $ns->{query_queue} } == @$queue) {
1956	if (@$queue) {	2932	if (@$queue) {
…		…
1958	} else {	2934	} else {
1959	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2935	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1960	}	2936	}
1961	}	2937	}
1962	},	2938	},
		2939	on_exticmd => sub {
		2940	my ($ns, $buf) = @_;
		2941
		2942	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2943
		2944	if (ref $msg) {
		2945	my ($type, $reply, @payload) =
		2946	"ARRAY" eq ref $msg
		2947	? @$msg
		2948	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2949
		2950	my @reply;
		2951
		2952	if (my $cb = $EXTICMD{$type}) {
		2953	@reply = $cb->($ns, @payload);
		2954	}
		2955
		2956	$ns->ext_reply ($reply, @reply)
		2957	if $reply;
		2958
		2959	} else {
		2960	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2961	}
		2962
		2963	cf::override;
		2964	},
1963	);	2965	);
1964		2966
1965	=item $client->async (\&cb)	2967	=item $client->async (\&cb)
1966		2968
1967	Create a new coroutine, running the specified callback. The coroutine will	2969	Create a new coroutine, running the specified callback. The coroutine will
…		…
2008	our $safe = new Safe "safe";	3010	our $safe = new Safe "safe";
2009	our $safe_hole = new Safe::Hole;	3011	our $safe_hole = new Safe::Hole;
2010		3012
2011	$SIG{FPE} = 'IGNORE';	3013	$SIG{FPE} = 'IGNORE';
2012		3014
2013	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	3015	$safe->permit_only (Opcode::opset qw(
		3016	:base_core :base_mem :base_orig :base_math
		3017	grepstart grepwhile mapstart mapwhile
		3018	sort time
		3019	));
2014		3020
2015	# here we export the classes and methods available to script code	3021	# here we export the classes and methods available to script code
2016		3022
2017	=pod	3023	=pod
2018		3024
2019	The following fucntions and emthods are available within a safe environment:	3025	The following functions and methods are available within a safe environment:
2020		3026
2021	cf::object contr pay_amount pay_player map	3027	cf::object
		3028	contr pay_amount pay_player map x y force_find force_add destroy
		3029	insert remove name archname title slaying race decrease_ob_nr
		3030
2022	cf::object::player player	3031	cf::object::player
2023	cf::player peaceful	3032	player
2024	cf::map trigger	3033
		3034	cf::player
		3035	peaceful
		3036
		3037	cf::map
		3038	trigger
2025		3039
2026	=cut	3040	=cut
2027		3041
2028	for (	3042	for (
2029	["cf::object" => qw(contr pay_amount pay_player map)],	3043	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		3044	insert remove inv name archname title slaying race
		3045	decrease_ob_nr destroy)],
2030	["cf::object::player" => qw(player)],	3046	["cf::object::player" => qw(player)],
2031	["cf::player" => qw(peaceful)],	3047	["cf::player" => qw(peaceful)],
2032	["cf::map" => qw(trigger)],	3048	["cf::map" => qw(trigger)],
2033	) {	3049	) {
2034	no strict 'refs';	3050	no strict 'refs';
…		…
2105	=back	3121	=back
2106		3122
2107	=cut	3123	=cut
2108		3124
2109	#############################################################################	3125	#############################################################################
		3126	# the server's init and main functions
2110		3127
2111	=head2 EXTENSION DATABASE SUPPORT	3128	sub load_facedata($) {
		3129	my ($path) = @_;
2112		3130
2113	Crossfire maintains a very simple database for extension use. It can	3131	# HACK to clear player env face cache, we need some signal framework
2114	currently store anything that can be serialised using Storable, which	3132	# for this (global event?)
2115	excludes objects.	3133	%ext::player_env::MUSIC_FACE_CACHE = ();
2116		3134
2117	The parameter C<$family> should best start with the name of the extension	3135	my $enc = JSON::XS->new->utf8->canonical->relaxed;
2118	using it, it should be unique.
2119		3136
2120	=over 4	3137	warn "loading facedata from $path\n";
2121		3138
2122	=item $hashref = cf::db_get $family	3139	my $facedata;
		3140	0 < aio_load $path, $facedata
		3141	or die "$path: $!";
2123		3142
2124	Return a hashref for use by the extension C<$family>, which can be	3143	$facedata = Coro::Storable::thaw $facedata;
2125	modified. After modifications, you have to call C<cf::db_dirty> or
2126	C<cf::db_sync>.
2127		3144
2128	=item $value = cf::db_get $family => $key	3145	$facedata->{version} == 2
		3146	or cf::cleanup "$path: version mismatch, cannot proceed.";
2129		3147
2130	Returns a single value from the database	3148	# patch in the exptable
2131		3149	$facedata->{resource}{"res/exp_table"} = {
2132	=item cf::db_put $family => $hashref	3150	type => FT_RSRC,
2133		3151	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2134	Stores the given family hashref into the database. Updates are delayed, if
2135	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2136
2137	=item cf::db_put $family => $key => $value
2138
2139	Stores the given C<$value> in the family hash. Updates are delayed, if you
2140	want the data to be synced to disk immediately, use C<cf::db_sync>.
2141
2142	=item cf::db_dirty
2143
2144	Marks the database as dirty, to be updated at a later time.
2145
2146	=item cf::db_sync
2147
2148	Immediately write the database to disk I<if it is dirty>.
2149
2150	=cut
2151
2152	our $DB;
2153
2154	{
2155	my $path = cf::localdir . "/database.pst";
2156
2157	sub db_load() {
2158	$DB = stat $path ? Storable::retrieve $path : { };
2159	}
2160
2161	my $pid;
2162
2163	sub db_save() {
2164	waitpid $pid, 0 if $pid;
2165	if (0 == ($pid = fork)) {
2166	$DB->{_meta}{version} = 1;
2167	Storable::nstore $DB, "$path~";
2168	rename "$path~", $path;
2169	cf::_exit 0 if defined $pid;
2170	}
2171	}
2172
2173	my $dirty;
2174
2175	sub db_sync() {
2176	db_save if $dirty;
2177	undef $dirty;
2178	}
2179
2180	my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2181	db_sync;
2182	});	3152	};
		3153	cf::cede_to_tick;
2183		3154
2184	sub db_dirty() {
2185	$dirty = 1;
2186	$idle->start;
2187	}	3155	{
		3156	my $faces = $facedata->{faceinfo};
2188		3157
2189	sub db_get($;$) {	3158	while (my ($face, $info) = each %$faces) {
2190	@_ >= 2	3159	my $idx = (cf::face::find $face) || cf::face::alloc $face;
2191	? $DB->{$_[0]}{$_[1]}
2192	: ($DB->{$_[0]} ||= { })
2193	}
2194		3160
2195	sub db_put($$;$) {	3161	cf::face::set_visibility $idx, $info->{visibility};
2196	if (@_ >= 3) {	3162	cf::face::set_magicmap $idx, $info->{magicmap};
2197	$DB->{$_[0]}{$_[1]} = $_[2];	3163	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2198	} else {	3164	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2199	$DB->{$_[0]} = $_[1];
2200	}
2201	db_dirty;
2202	}
2203		3165
2204	cf::global->attach (	3166	cf::cede_to_tick;
2205	prio => 10000,
2206	on_cleanup => sub {
2207	db_sync;
2208	},	3167	}
2209	);
2210	}
2211		3168
2212	#############################################################################	3169	while (my ($face, $info) = each %$faces) {
2213	# the server's main()	3170	next unless $info->{smooth};
2214		3171
2215	sub cfg_load {	3172	my $idx = cf::face::find $face
		3173	or next;
		3174
		3175	if (my $smooth = cf::face::find $info->{smooth}) {
		3176	cf::face::set_smooth $idx, $smooth;
		3177	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		3178	} else {
		3179	warn "smooth face '$info->{smooth}' not found for face '$face'";
		3180	}
		3181
		3182	cf::cede_to_tick;
		3183	}
		3184	}
		3185
		3186	{
		3187	my $anims = $facedata->{animinfo};
		3188
		3189	while (my ($anim, $info) = each %$anims) {
		3190	cf::anim::set $anim, $info->{frames}, $info->{facings};
		3191	cf::cede_to_tick;
		3192	}
		3193
		3194	cf::anim::invalidate_all; # d'oh
		3195	}
		3196
		3197	{
		3198	# TODO: for gcfclient pleasure, we should give resources
		3199	# that gcfclient doesn't grok a >10000 face index.
		3200	my $res = $facedata->{resource};
		3201
		3202	while (my ($name, $info) = each %$res) {
		3203	if (defined $info->{type}) {
		3204	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		3205	my $data;
		3206
		3207	if ($info->{type} & 1) {
		3208	# prepend meta info
		3209
		3210	my $meta = $enc->encode ({
		3211	name => $name,
		3212	%{ $info->{meta} || {} },
		3213	});
		3214
		3215	$data = pack "(w/a*)*", $meta, $info->{data};
		3216	} else {
		3217	$data = $info->{data};
		3218	}
		3219
		3220	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		3221	cf::face::set_type $idx, $info->{type};
		3222	} else {
		3223	$RESOURCE{$name} = $info;
		3224	}
		3225
		3226	cf::cede_to_tick;
		3227	}
		3228	}
		3229
		3230	cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
		3231
		3232	1
		3233	}
		3234
		3235	cf::global->attach (on_resource_update => sub {
		3236	if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
		3237	$soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
		3238
		3239	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3240	my $sound = $soundconf->{compat}[$_]
		3241	or next;
		3242
		3243	my $face = cf::face::find "sound/$sound->[1]";
		3244	cf::sound::set $sound->[0] => $face;
		3245	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3246	}
		3247
		3248	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3249	my $face = cf::face::find "sound/$v";
		3250	cf::sound::set $k => $face;
		3251	}
		3252	}
		3253	});
		3254
		3255	register_exticmd fx_want => sub {
		3256	my ($ns, $want) = @_;
		3257
		3258	while (my ($k, $v) = each %$want) {
		3259	$ns->fx_want ($k, $v);
		3260	}
		3261	};
		3262
		3263	sub reload_regions {
		3264	# HACK to clear player env face cache, we need some signal framework
		3265	# for this (global event?)
		3266	%ext::player_env::MUSIC_FACE_CACHE = ();
		3267
		3268	load_resource_file "$MAPDIR/regions"
		3269	or die "unable to load regions file\n";
		3270
		3271	for (cf::region::list) {
		3272	$_->{match} = qr/$_->{match}/
		3273	if exists $_->{match};
		3274	}
		3275	}
		3276
		3277	sub reload_facedata {
		3278	load_facedata "$DATADIR/facedata"
		3279	or die "unable to load facedata\n";
		3280	}
		3281
		3282	sub reload_archetypes {
		3283	load_resource_file "$DATADIR/archetypes"
		3284	or die "unable to load archetypes\n";
		3285	#d# NEED to laod twice to resolve forward references
		3286	# this really needs to be done in an extra post-pass
		3287	# (which needs to be synchronous, so solve it differently)
		3288	load_resource_file "$DATADIR/archetypes"
		3289	or die "unable to load archetypes\n";
		3290	}
		3291
		3292	sub reload_treasures {
		3293	load_resource_file "$DATADIR/treasures"
		3294	or die "unable to load treasurelists\n";
		3295	}
		3296
		3297	sub reload_resources {
		3298	warn "reloading resource files...\n";
		3299
		3300	reload_regions;
		3301	reload_facedata;
		3302	#reload_archetypes;#d#
		3303	reload_archetypes;
		3304	reload_treasures;
		3305
		3306	warn "finished reloading resource files\n";
		3307	}
		3308
		3309	sub init {
		3310	reload_resources;
		3311	}
		3312
		3313	sub reload_config {
2216	open my $fh, "<:utf8", cf::confdir . "/config"	3314	open my $fh, "<:utf8", "$CONFDIR/config"
2217	or return;	3315	or return;
2218		3316
2219	local $/;	3317	local $/;
2220	*CFG = YAML::Syck::Load <$fh>;	3318	*CFG = YAML::Syck::Load <$fh>;
2221		3319
…		…
2236	sub main {	3334	sub main {
2237	# we must not ever block the main coroutine	3335	# we must not ever block the main coroutine
2238	local $Coro::idle = sub {	3336	local $Coro::idle = sub {
2239	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3337	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2240	(async {	3338	(async {
2241	Event::one_event;	3339	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3340	EV::loop EV::LOOP_ONESHOT;
2242	})->prio (Coro::PRIO_MAX);	3341	})->prio (Coro::PRIO_MAX);
2243	};	3342	};
2244		3343
2245	cfg_load;	3344	reload_config;
2246	db_load;	3345	db_init;
2247	load_extensions;	3346	load_extensions;
2248		3347
2249	$TICK_WATCHER->start;	3348	$TICK_WATCHER->start;
		3349	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
2250	Event::loop;	3350	EV::loop;
2251	}	3351	}
2252		3352
2253	#############################################################################	3353	#############################################################################
2254	# initialisation and cleanup	3354	# initialisation and cleanup
2255		3355
2256	# install some emergency cleanup handlers	3356	# install some emergency cleanup handlers
2257	BEGIN {	3357	BEGIN {
		3358	our %SIGWATCHER = ();
2258	for my $signal (qw(INT HUP TERM)) {	3359	for my $signal (qw(INT HUP TERM)) {
2259	Event->signal (	3360	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2260	data => WF_AUTOCANCEL,
2261	signal => $signal,
2262	cb => sub {
2263	cf::cleanup "SIG$signal";	3361	cf::cleanup "SIG$signal";
2264	},
2265	);	3362	};
		3363	}
		3364	}
		3365
		3366	sub write_runtime {
		3367	my $runtime = "$LOCALDIR/runtime";
		3368
		3369	# first touch the runtime file to show we are still running:
		3370	# the fsync below can take a very very long time.
		3371
		3372	IO::AIO::aio_utime $runtime, undef, undef;
		3373
		3374	my $guard = cf::lock_acquire "write_runtime";
		3375
		3376	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3377	or return;
		3378
		3379	my $value = $cf::RUNTIME + 90 + 10;
		3380	# 10 is the runtime save interval, for a monotonic clock
		3381	# 60 allows for the watchdog to kill the server.
		3382
		3383	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3384	and return;
		3385
		3386	# always fsync - this file is important
		3387	aio_fsync $fh
		3388	and return;
		3389
		3390	# touch it again to show we are up-to-date
		3391	aio_utime $fh, undef, undef;
		3392
		3393	close $fh
		3394	or return;
		3395
		3396	aio_rename "$runtime~", $runtime
		3397	and return;
		3398
		3399	warn "runtime file written.\n";
		3400
2266	}	3401	1
2267	}	3402	}
2268		3403
2269	sub emergency_save() {	3404	sub emergency_save() {
2270	my $freeze_guard = cf::freeze_mainloop;	3405	my $freeze_guard = cf::freeze_mainloop;
2271		3406
…		…
2277	# and maps saved/destroyed asynchronously.	3412	# and maps saved/destroyed asynchronously.
2278	warn "begin emergency player save\n";	3413	warn "begin emergency player save\n";
2279	for my $login (keys %cf::PLAYER) {	3414	for my $login (keys %cf::PLAYER) {
2280	my $pl = $cf::PLAYER{$login} or next;	3415	my $pl = $cf::PLAYER{$login} or next;
2281	$pl->valid or next;	3416	$pl->valid or next;
		3417	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2282	$pl->save;	3418	$pl->save;
2283	}	3419	}
2284	warn "end emergency player save\n";	3420	warn "end emergency player save\n";
2285		3421
2286	warn "begin emergency map save\n";	3422	warn "begin emergency map save\n";
…		…
2288	my $map = $cf::MAP{$path} or next;	3424	my $map = $cf::MAP{$path} or next;
2289	$map->valid or next;	3425	$map->valid or next;
2290	$map->save;	3426	$map->save;
2291	}	3427	}
2292	warn "end emergency map save\n";	3428	warn "end emergency map save\n";
		3429
		3430	warn "begin emergency database checkpoint\n";
		3431	BDB::db_env_txn_checkpoint $DB_ENV;
		3432	warn "end emergency database checkpoint\n";
2293	};	3433	};
2294		3434
2295	warn "leave emergency perl save\n";	3435	warn "leave emergency perl save\n";
2296	}	3436	}
2297		3437
		3438	sub post_cleanup {
		3439	my ($make_core) = @_;
		3440
		3441	warn Carp::longmess "post_cleanup backtrace"
		3442	if $make_core;
		3443	}
		3444
2298	sub reload() {	3445	sub do_reload_perl() {
2299	# can/must only be called in main	3446	# can/must only be called in main
2300	if ($Coro::current != $Coro::main) {	3447	if ($Coro::current != $Coro::main) {
2301	warn "can only reload from main coroutine";	3448	warn "can only reload from main coroutine";
2302	return;	3449	return;
2303	}	3450	}
2304		3451
2305	warn "reloading...";	3452	warn "reloading...";
2306		3453
2307	warn "cancelling server ticker";	3454	warn "entering sync_job";
2308	$TICK_WATCHER->cancel;
2309		3455
		3456	cf::sync_job {
		3457	cf::write_runtime; # external watchdog should not bark
2310	cf::emergency_save;	3458	cf::emergency_save;
		3459	cf::write_runtime; # external watchdog should not bark
2311		3460
2312	eval {	3461	warn "syncing database to disk";
		3462	BDB::db_env_txn_checkpoint $DB_ENV;
		3463
2313	# if anything goes wrong in here, we should simply crash as we already saved	3464	# if anything goes wrong in here, we should simply crash as we already saved
2314
2315	warn "syncing database to disk";
2316	cf::db_sync;
2317
2318	warn "cancelling all WF_AUTOCANCEL watchers";
2319	for (Event::all_watchers) {
2320	$_->cancel if $_->data & WF_AUTOCANCEL;
2321	}
2322		3465
2323	warn "flushing outstanding aio requests";	3466	warn "flushing outstanding aio requests";
2324	for (;;) {	3467	for (;;) {
		3468	BDB::flush;
2325	IO::AIO::flush;	3469	IO::AIO::flush;
2326	Coro::cede;	3470	Coro::cede_notself;
2327	last unless IO::AIO::nreqs;	3471	last unless IO::AIO::nreqs || BDB::nreqs;
2328	warn "iterate...";	3472	warn "iterate...";
2329	}	3473	}
		3474
		3475	++$RELOAD;
2330		3476
2331	warn "cancelling all extension coros";	3477	warn "cancelling all extension coros";
2332	$_->cancel for values %EXT_CORO;	3478	$_->cancel for values %EXT_CORO;
2333	%EXT_CORO = ();	3479	%EXT_CORO = ();
2334		3480
2335	warn "removing commands";	3481	warn "removing commands";
2336	%COMMAND = ();	3482	%COMMAND = ();
2337		3483
2338	warn "removing ext commands";	3484	warn "removing ext/exti commands";
2339	%EXTCMD = ();	3485	%EXTCMD = ();
		3486	%EXTICMD = ();
2340		3487
2341	warn "unloading/nuking all extensions";	3488	warn "unloading/nuking all extensions";
2342	for my $pkg (@EXTS) {	3489	for my $pkg (@EXTS) {
2343	warn "... unloading $pkg";	3490	warn "... unloading $pkg";
2344		3491
…		…
2374	Symbol::delete_package "safe::$_"	3521	Symbol::delete_package "safe::$_"
2375	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3522	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2376		3523
2377	warn "unloading cf.pm \"a bit\"";	3524	warn "unloading cf.pm \"a bit\"";
2378	delete $INC{"cf.pm"};	3525	delete $INC{"cf.pm"};
		3526	delete $INC{"cf/pod.pm"};
2379		3527
2380	# don't, removes xs symbols, too,	3528	# don't, removes xs symbols, too,
2381	# and global variables created in xs	3529	# and global variables created in xs
2382	#Symbol::delete_package __PACKAGE__;	3530	#Symbol::delete_package __PACKAGE__;
2383		3531
…		…
2386	warn "reloading cf.pm";	3534	warn "reloading cf.pm";
2387	require cf;	3535	require cf;
2388	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3536	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2389		3537
2390	warn "loading config and database again";	3538	warn "loading config and database again";
2391	cf::cfg_load;	3539	cf::reload_config;
2392	cf::db_load;
2393		3540
2394	warn "loading extensions";	3541	warn "loading extensions";
2395	cf::load_extensions;	3542	cf::load_extensions;
2396		3543
2397	warn "reattaching attachments to objects/players";	3544	warn "reattaching attachments to objects/players";
2398	_global_reattach;	3545	_global_reattach; # objects, sockets
2399	warn "reattaching attachments to maps";	3546	warn "reattaching attachments to maps";
2400	reattach $_ for values %MAP;	3547	reattach $_ for values %MAP;
		3548	warn "reattaching attachments to players";
		3549	reattach $_ for values %PLAYER;
2401		3550
2402	warn "restarting server ticker";	3551	warn "leaving sync_job";
2403		3552
2404	$TICK_WATCHER->start;	3553	1
2405	};	3554	} or do {
2406
2407	if ($@) {
2408	warn $@;	3555	warn $@;
2409	warn "error while reloading, exiting.";	3556	warn "error while reloading, exiting.";
2410	exit 1;	3557	exit 1;
2411	}	3558	};
2412		3559
2413	warn "reloaded";	3560	warn "reloaded";
2414	};	3561	};
2415		3562
2416	our $RELOAD_WATCHER; # used only during reload	3563	our $RELOAD_WATCHER; # used only during reload
2417		3564
		3565	sub reload_perl() {
		3566	# doing reload synchronously and two reloads happen back-to-back,
		3567	# coro crashes during coro_state_free->destroy here.
		3568
		3569	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
		3570	undef $RELOAD_WATCHER;
		3571	do_reload_perl;
		3572	};
		3573	}
		3574
2418	register_command "reload" => sub {	3575	register_command "reload" => sub {
2419	my ($who, $arg) = @_;	3576	my ($who, $arg) = @_;
2420		3577
2421	if ($who->flag (FLAG_WIZ)) {	3578	if ($who->flag (FLAG_WIZ)) {
2422	$who->message ("reloading server.");	3579	$who->message ("reloading server.");
2423		3580	async {
2424	# doing reload synchronously and two reloads happen back-to-back,	3581	$Coro::current->{desc} = "perl_reload";
2425	# coro crashes during coro_state_free->destroy here.
2426
2427	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2428	reload;	3582	reload_perl;
2429	undef $RELOAD_WATCHER;
2430	});	3583	};
2431	}	3584	}
2432	};	3585	};
2433		3586
2434	unshift @INC, $LIBDIR;	3587	unshift @INC, $LIBDIR;
2435		3588
2436	my $bug_warning = 0;	3589	my $bug_warning = 0;
2437		3590
2438	$TICK_WATCHER = Event->timer (	3591	our @WAIT_FOR_TICK;
2439	reentrant => 0,	3592	our @WAIT_FOR_TICK_BEGIN;
2440	parked => 1,	3593
2441	prio => 0,	3594	sub wait_for_tick {
2442	at => $NEXT_TICK || $TICK,	3595	return unless $TICK_WATCHER->is_active;
2443	data => WF_AUTOCANCEL,	3596	return if $Coro::current == $Coro::main;
2444	cb => sub {	3597
		3598	my $signal = new Coro::Signal;
		3599	push @WAIT_FOR_TICK, $signal;
		3600	$signal->wait;
		3601	}
		3602
		3603	sub wait_for_tick_begin {
		3604	return unless $TICK_WATCHER->is_active;
		3605	return if $Coro::current == $Coro::main;
		3606
		3607	my $signal = new Coro::Signal;
		3608	push @WAIT_FOR_TICK_BEGIN, $signal;
		3609	$signal->wait;
		3610	}
		3611
		3612	$TICK_WATCHER = EV::periodic_ns 0, $TICK, 0, sub {
2445	if ($Coro::current != $Coro::main) {	3613	if ($Coro::current != $Coro::main) {
2446	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3614	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2447	unless ++$bug_warning > 10;	3615	unless ++$bug_warning > 10;
2448	return;	3616	return;
2449	}	3617	}
2450		3618
2451	$NOW = Event::time;	3619	$NOW = $tick_start = EV::now;
2452		3620
2453	cf::server_tick; # one server iteration	3621	cf::server_tick; # one server iteration
		3622
2454	$RUNTIME += $TICK;	3623	$RUNTIME += $TICK;
2455	$NEXT_TICK += $TICK;	3624	$NEXT_TICK = $_[0]->at;
2456		3625
2457	$WAIT_FOR_TICK->broadcast;	3626	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2458	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3627	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2459		3628	Coro::async_pool {
2460	# if we are delayed by four ticks or more, skip them all	3629	$Coro::current->{desc} = "runtime saver";
2461	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2462
2463	$TICK_WATCHER->at ($NEXT_TICK);
2464	$TICK_WATCHER->start;
2465	},
2466	);
2467
2468	IO::AIO::max_poll_time $TICK * 0.2;
2469
2470	$AIO_POLL_WATCHER = Event->io (
2471	fd => IO::AIO::poll_fileno,
2472	poll => 'r',
2473	prio => 5,
2474	data => WF_AUTOCANCEL,
2475	cb => \&IO::AIO::poll_cb,
2476	);
2477
2478	$WRITE_RUNTIME_WATCHER = Event->timer (
2479	data => WF_AUTOCANCEL,
2480	after => 1,
2481	interval => 10,
2482	cb => Coro::unblock_sub {
2483	write_runtime	3630	write_runtime
2484	or warn "ERROR: unable to write runtime file: $!";	3631	or warn "ERROR: unable to write runtime file: $!";
		3632	};
2485	},	3633	}
2486	);	3634
		3635	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3636	$sig->send;
		3637	}
		3638	while (my $sig = shift @WAIT_FOR_TICK) {
		3639	$sig->send;
		3640	}
		3641
		3642	$LOAD = ($NOW - $tick_start) / $TICK;
		3643	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3644
		3645	_post_tick;
		3646	};
		3647	$TICK_WATCHER->priority (EV::MAXPRI);
		3648
		3649	{
		3650	# configure BDB
		3651
		3652	BDB::min_parallel 8;
		3653	BDB::max_poll_reqs $TICK * 0.1;
		3654	$Coro::BDB::WATCHER->priority (1);
		3655
		3656	unless ($DB_ENV) {
		3657	$DB_ENV = BDB::db_env_create;
		3658	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3659	| BDB::LOG_AUTOREMOVE, 1);
		3660	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3661	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
		3662
		3663	cf::sync_job {
		3664	eval {
		3665	BDB::db_env_open
		3666	$DB_ENV,
		3667	$BDBDIR,
		3668	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3669	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3670	0666;
		3671
		3672	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3673	};
		3674
		3675	cf::cleanup "db_env_open(db): $@" if $@;
		3676	};
		3677	}
		3678
		3679	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3680	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3681	};
		3682	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3683	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3684	};
		3685	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3686	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3687	};
		3688	}
		3689
		3690	{
		3691	# configure IO::AIO
		3692
		3693	IO::AIO::min_parallel 8;
		3694	IO::AIO::max_poll_time $TICK * 0.1;
		3695	$Coro::AIO::WATCHER->priority (1);
		3696	}
		3697
		3698	my $_log_backtrace;
		3699
		3700	sub _log_backtrace {
		3701	my ($msg, @addr) = @_;
		3702
		3703	$msg =~ s/\n//;
		3704
		3705	# limit the # of concurrent backtraces
		3706	if ($_log_backtrace < 2) {
		3707	++$_log_backtrace;
		3708	async {
		3709	$Coro::current->{desc} = "abt $msg";
		3710
		3711	my @bt = fork_call {
		3712	@addr = map { sprintf "%x", $_ } @addr;
		3713	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3714	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3715	or die "addr2line: $!";
		3716
		3717	my @funcs;
		3718	my @res = <$fh>;
		3719	chomp for @res;
		3720	while (@res) {
		3721	my ($func, $line) = splice @res, 0, 2, ();
		3722	push @funcs, "[$func] $line";
		3723	}
		3724
		3725	@funcs
		3726	};
		3727
		3728	LOG llevInfo, "[ABT] $msg\n";
		3729	LOG llevInfo, "[ABT] $_\n" for @bt;
		3730	--$_log_backtrace;
		3731	};
		3732	} else {
		3733	LOG llevInfo, "[ABT] $msg\n";
		3734	LOG llevInfo, "[ABT] [suppressed]\n";
		3735	}
		3736	}
		3737
		3738	# load additional modules
		3739	use cf::pod;
2487		3740
2488	END { cf::emergency_save }	3741	END { cf::emergency_save }
2489		3742
2490	1	3743	1
2491		3744

Diff Legend

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