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

Diff Legend

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