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.204 by root, Fri Feb 2 19:59:22 2007 UTC vs.
Revision 1.406 by root, Mon Dec 17 08:27:44 2007 UTC

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

Diff Legend

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