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.211 by root, Tue Feb 13 16:23:32 2007 UTC vs.
Revision 1.405 by root, Mon Dec 17 08:03:22 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 ();
20	use BDB ();	28	use BDB ();
21	use Data::Dumper;	29	use Data::Dumper;
22	use Digest::MD5;	30	use Digest::MD5;
23	use Fcntl;	31	use Fcntl;
24	use IO::AIO 2.32 ();
25	use YAML::Syck ();	32	use YAML::Syck ();
		33	use IO::AIO 2.51 ();
26	use Time::HiRes;	34	use Time::HiRes;
27	use Compress::LZF;	35	use Compress::LZF;
		36	use Digest::MD5 ();
28		37
		38	# configure various modules to our taste
		39	#
		40	$Storable::canonical = 1; # reduce rsync transfers
		41	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	42	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30
31	use Event; $Event::Eval = 1; # no idea why this is required, but it is
32
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		43
35	# 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?
36	$YAML::Syck::ImplicitUnicode = 1;	45	$YAML::Syck::ImplicitUnicode = 1;
37		46
38	$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
39		48
		49	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		50
40	our %COMMAND = ();	51	our %COMMAND = ();
41	our %COMMAND_TIME = ();	52	our %COMMAND_TIME = ();
42		53
43	our @EXTS = (); # list of extension package names	54	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	55	our %EXTCMD = ();
		56	our %EXTICMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	57	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	58	our %EXT_MAP = (); # pluggable maps
47		59
		60	our $RELOAD; # number of reloads so far
48	our @EVENT;	61	our @EVENT;
49	our $LIBDIR = datadir . "/ext";
50		62
51	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(!)
52	our $TICK_WATCHER;	77	our $TICK_WATCHER;
53	our $AIO_POLL_WATCHER;	78	our $AIO_POLL_WATCHER;
54	our $WRITE_RUNTIME_WATCHER;	79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55	our $NEXT_TICK;	80	our $NEXT_TICK;
56	our $NOW;
57	our $USE_FSYNC = 1; # use fsync to write maps - default off	81	our $USE_FSYNC = 1; # use fsync to write maps - default off
58		82
59	our $BDB_POLL_WATCHER;	83	our $BDB_POLL_WATCHER;
		84	our $BDB_DEADLOCK_WATCHER;
		85	our $BDB_CHECKPOINT_WATCHER;
		86	our $BDB_TRICKLE_WATCHER;
60	our $DB_ENV;	87	our $DB_ENV;
61		88
62	our %CFG;	89	our %CFG;
63		90
64	our $UPTIME; $UPTIME ||= time;	91	our $UPTIME; $UPTIME ||= time;
65	our $RUNTIME;	92	our $RUNTIME;
		93	our $NOW;
66		94
67	our %PLAYER; # all users	95	our (%PLAYER, %PLAYER_LOADING); # all users
68	our %MAP; # all maps	96	our (%MAP, %MAP_LOADING ); # all maps
69	our $LINK_MAP; # the special {link} map, which is always available	97	our $LINK_MAP; # the special {link} map, which is always available
70	our $RANDOM_MAPS = cf::localdir . "/random";
71	our $BDB_ENV_DIR = cf::localdir . "/db";
72
73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75		98
76	# 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 ∕
77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	100	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78		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
79	binmode STDOUT;	106	binmode STDOUT;
80	binmode STDERR;	107	binmode STDERR;
81		108
82	# read virtual server time, if available	109	# read virtual server time, if available
83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	110	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84	open my $fh, "<", cf::localdir . "/runtime"	111	open my $fh, "<", "$LOCALDIR/runtime"
85	or die "unable to read runtime file: $!";	112	or die "unable to read runtime file: $!";
86	$RUNTIME = <$fh> + 0.;	113	$RUNTIME = <$fh> + 0.;
87	}	114	}
88		115
89	mkdir cf::localdir;	116	mkdir $_
90	mkdir cf::localdir . "/" . cf::playerdir;	117	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91	mkdir cf::localdir . "/" . cf::tmpdir;
92	mkdir cf::localdir . "/" . cf::uniquedir;
93	mkdir $RANDOM_MAPS;
94	mkdir $BDB_ENV_DIR;
95		118
96	our $EMERGENCY_POSITION;	119	our $EMERGENCY_POSITION;
97		120
98	sub cf::map::normalise;	121	sub cf::map::normalise;
99		122
…		…
110	=item $cf::RUNTIME	133	=item $cf::RUNTIME
111		134
112	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
113	every server tick.	136	every server tick.
114		137
115	=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
116		141
117	The perl library directory, where extensions and cf-specific modules can	142	Various directories - "/etc", read-only install directory, perl-library
118	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.
119		146
120	=item $cf::NOW	147	=item $cf::NOW
121		148
122	The time of the last (current) server tick.	149	The time of the last (current) server tick.
123		150
124	=item $cf::TICK	151	=item $cf::TICK
125		152
126	The interval between server ticks, in seconds.	153	The interval between server ticks, in seconds.
127		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
128	=item %cf::CFG	165	=item %cf::CFG
129		166
130	Configuration for the server, loaded from C</etc/crossfire/config>, or	167	Configuration for the server, loaded from C</etc/deliantra-server/config>, or
131	from wherever your confdir points to.	168	from wherever your confdir points to.
132		169
133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	170	=item cf::wait_for_tick, cf::wait_for_tick_begin
134		171
135	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
136	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
137	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.
138	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.
139		181
140	=back	182	=back
141		183
142	=cut	184	=cut
143		185
144	BEGIN {	186	BEGIN {
145	*CORE::GLOBAL::warn = sub {	187	*CORE::GLOBAL::warn = sub {
146	my $msg = join "", @_;	188	my $msg = join "", @_;
147	utf8::encode $msg;
148		189
149	$msg .= "\n"	190	$msg .= "\n"
150	unless $msg =~ /\n$/;	191	unless $msg =~ /\n$/;
		192
		193	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
151		194
152	LOG llevError, $msg;	195	LOG llevError, $msg;
153	};	196	};
154	}	197	}
155		198
156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	199	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	200	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	201	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	202	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160	@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';
161	@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)
162		206
163	# 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
164	# within the Safe compartment.	208	# within the Safe compartment.
165	for my $pkg (qw(	209	for my $pkg (qw(
166	cf::global cf::attachable	210	cf::global cf::attachable
…		…
171	)) {	215	)) {
172	no strict 'refs';	216	no strict 'refs';
173	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	217	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
174	}	218	}
175		219
176	$Event::DIED = sub {	220	$EV::DIED = sub {
177	warn "error in event callback: @_";	221	warn "error in event callback: @_";
178	};	222	};
		223
		224	#############################################################################
179		225
180	=head2 UTILITY FUNCTIONS	226	=head2 UTILITY FUNCTIONS
181		227
182	=over 4	228	=over 4
183		229
…		…
202	$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;
203	$d	249	$d
204	} || "[unable to dump $_[0]: '$@']";	250	} || "[unable to dump $_[0]: '$@']";
205	}	251	}
206		252
207	use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209	=item $ref = cf::from_json $json	253	=item $ref = cf::decode_json $json
210		254
211	Converts a JSON string into the corresponding perl data structure.	255	Converts a JSON string into the corresponding perl data structure.
212		256
213	=cut
214
215	sub from_json($) {
216	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217	JSON::Syck::Load $_[0]
218	}
219
220	=item $json = cf::to_json $ref	257	=item $json = cf::encode_json $ref
221		258
222	Converts a perl data structure into its JSON representation.	259	Converts a perl data structure into its JSON representation.
223		260
224	=cut	261	=cut
225		262
226	sub to_json($) {	263	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	264
228	JSON::Syck::Dump $_[0]	265	sub encode_json($) { $json_coder->encode ($_[0]) }
229	}	266	sub decode_json($) { $json_coder->decode ($_[0]) }
230		267
231	=item cf::lock_wait $string	268	=item cf::lock_wait $string
232		269
233	Wait until the given lock is available. See cf::lock_acquire.	270	Wait until the given lock is available. See cf::lock_acquire.
234		271
…		…
237	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
238	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,
239	for example when the coroutine gets canceled), the lock is automatically	276	for example when the coroutine gets canceled), the lock is automatically
240	returned.	277	returned.
241		278
		279	Locks are *not* recursive, locking from the same coro twice results in a
		280	deadlocked coro.
		281
242	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
243	uses map_find and cf::map::load uses map_load).	283	uses map_find and cf::map::load uses map_load).
244		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
245	=cut	289	=cut
246		290
247	our %LOCK;	291	our %LOCK;
		292	our %LOCKER;#d#
248		293
249	sub lock_wait($) {	294	sub lock_wait($) {
250	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#
251		301
252	# wait for lock, if any	302	# wait for lock, if any
253	while ($LOCK{$key}) {	303	while ($LOCK{$key}) {
254	push @{ $LOCK{$key} }, $Coro::current;	304	push @{ $LOCK{$key} }, $Coro::current;
255	Coro::schedule;	305	Coro::schedule;
…		…
261		311
262	# wait, to be sure we are not locked	312	# wait, to be sure we are not locked
263	lock_wait $key;	313	lock_wait $key;
264		314
265	$LOCK{$key} = [];	315	$LOCK{$key} = [];
		316	$LOCKER{$key} = $Coro::current;#d#
266		317
267	Coro::guard {	318	Coro::guard {
		319	delete $LOCKER{$key};#d#
268	# wake up all waiters, to be on the safe side	320	# wake up all waiters, to be on the safe side
269	$_->ready for @{ delete $LOCK{$key} };	321	$_->ready for @{ delete $LOCK{$key} };
270	}	322	}
271	}	323	}
272		324
		325	sub lock_active($) {
		326	my ($key) = @_;
		327
		328	! ! $LOCK{$key}
		329	}
		330
273	sub freeze_mainloop {	331	sub freeze_mainloop {
274	return unless $TICK_WATCHER->is_active;	332	return unless $TICK_WATCHER->is_active;
275		333
276	my $guard = Coro::guard {	334	my $guard = Coro::guard {
277	$TICK_WATCHER->start;	335	$TICK_WATCHER->start;
278	$WRITE_RUNTIME_WATCHER->start;
279	};	336	};
280	$WRITE_RUNTIME_WATCHER->stop;
281	$TICK_WATCHER->stop;	337	$TICK_WATCHER->stop;
282	$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;
283	}	412	}
284		413
285	=item cf::async { BLOCK }	414	=item cf::async { BLOCK }
286		415
287	Currently the same as Coro::async_pool, meaning you cannot use	416	Currently the same as Coro::async_pool, meaning you cannot use
…		…
292		421
293	BEGIN { *async = \&Coro::async_pool }	422	BEGIN { *async = \&Coro::async_pool }
294		423
295	=item cf::sync_job { BLOCK }	424	=item cf::sync_job { BLOCK }
296		425
297	The design of crossfire+ requires that the main coro ($Coro::main) is	426	The design of Deliantra requires that the main coroutine ($Coro::main)
298	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
299	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.
300		430
301	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
302	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
303	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
304	fast or be very important.	434	fast or be very important.
…		…
307		437
308	sub sync_job(&) {	438	sub sync_job(&) {
309	my ($job) = @_;	439	my ($job) = @_;
310		440
311	if ($Coro::current == $Coro::main) {	441	if ($Coro::current == $Coro::main) {
		442	my $time = EV::time;
		443
312	# this is the main coro, too bad, we have to block	444	# this is the main coro, too bad, we have to block
313	# till the operation succeeds, freezing the server :/	445	# till the operation succeeds, freezing the server :/
314		446
		447	LOG llevError, Carp::longmess "sync job";#d#
		448
315	# TODO: use suspend/resume instead	449	# TODO: use suspend/resume instead
316	# (but this is cancel-safe)	450	# (but this is cancel-safe)
317	my $freeze_guard = freeze_mainloop;	451	my $freeze_guard = freeze_mainloop;
318		452
319	my $busy = 1;	453	my $busy = 1;
320	my @res;	454	my @res;
321		455
322	(async {	456	(async {
		457	$Coro::current->desc ("sync job coro");
323	@res = eval { $job->() };	458	@res = eval { $job->() };
324	warn $@ if $@;	459	warn $@ if $@;
325	undef $busy;	460	undef $busy;
326	})->prio (Coro::PRIO_MAX);	461	})->prio (Coro::PRIO_MAX);
327		462
328	while ($busy) {	463	while ($busy) {
329	Coro::cede or Event::one_event;	464	if (Coro::nready) {
		465	Coro::cede_notself;
		466	} else {
		467	EV::loop EV::LOOP_ONESHOT;
330	}	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
331		477
332	wantarray ? @res : $res[0]	478	wantarray ? @res : $res[0]
333	} else {	479	} else {
334	# we are in another coroutine, how wonderful, everything just works	480	# we are in another coroutine, how wonderful, everything just works
335		481
…		…
355	$EXT_CORO{$coro+0} = $coro;	501	$EXT_CORO{$coro+0} = $coro;
356		502
357	$coro	503	$coro
358	}	504	}
359		505
360	sub write_runtime {	506	=item fork_call { }, $args
361	$TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
362		507
363	my $runtime = cf::localdir . "/runtime";	508	Executes the given code block with the given arguments in a seperate
		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.
364		512
365	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	513	=cut
366	or return;
367		514
368	my $value = $cf::RUNTIME + 90 + 10;	515	sub fork_call(&@) {
369	# 10 is the runtime save interval, for a monotonic clock	516	my ($cb, @args) = @_;
370	# 60 allows for the watchdog to kill the server.
371		517
372	(aio_write $fh, 0, (length $value), $value, 0) <= 0	518	# we seemingly have to make a local copy of the whole thing,
373	and return;	519	# otherwise perl prematurely frees the stuff :/
		520	# TODO: investigate and fix (likely this will be rather laborious)
374		521
375	# always fsync - this file is important	522	my @res = Coro::Util::fork_eval {
376	aio_fsync $fh	523	reset_signals;
377	and return;	524	&$cb
		525	}, @args;
378		526
379	close $fh	527	wantarray ? @res : $res[-1]
380	or return;	528	}
381		529
382	aio_rename "$runtime~", $runtime	530	=item $value = cf::db_get $family => $key
383	and return;
384		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
385	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 });
386	}	666	}
387		667
388	=back	668	=back
389		669
390	=cut	670	=cut
…		…
397	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")
398	to it. All such attachable objects support the following methods.	678	to it. All such attachable objects support the following methods.
399		679
400	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>
401	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
402	crossfire+).	682	Deliantra).
403		683
404	=over 4	684	=over 4
405		685
406	=item $attachable->attach ($attachment, key => $value...)	686	=item $attachable->attach ($attachment, key => $value...)
407		687
…		…
570	$registry = $CB_TYPE[$object_type] ||= [];	850	$registry = $CB_TYPE[$object_type] ||= [];
571		851
572	} elsif ($type eq "subtype") {	852	} elsif ($type eq "subtype") {
573	defined $object_type or Carp::croak "subtype specified without type";	853	defined $object_type or Carp::croak "subtype specified without type";
574	my $object_subtype = shift @arg;	854	my $object_subtype = shift @arg;
575	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	855	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
576		856
577	} elsif ($type eq "package") {	857	} elsif ($type eq "package") {
578	my $pkg = shift @arg;	858	my $pkg = shift @arg;
579		859
580	while (my ($name, $id) = each %cb_id) {	860	while (my ($name, $id) = each %cb_id) {
…		…
609	_attach $registry, $klass, @attach;	889	_attach $registry, $klass, @attach;
610	}	890	}
611		891
612	$obj->{$name} = \%arg;	892	$obj->{$name} = \%arg;
613	} else {	893	} else {
614	warn "object uses attachment '$name' that is not available, postponing.\n";	894	warn "object uses attachment '$name' which is not available, postponing.\n";
615	}	895	}
616		896
617	$obj->{_attachment}{$name} = undef;	897	$obj->{_attachment}{$name} = undef;
618	}	898	}
619		899
…		…
621	if (ref $_[0]) {	901	if (ref $_[0]) {
622	_object_attach @_;	902	_object_attach @_;
623	} else {	903	} else {
624	_attach shift->_attach_registry, @_;	904	_attach shift->_attach_registry, @_;
625	}	905	}
		906	_recalc_want;
626	};	907	};
627		908
628	# all those should be optimised	909	# all those should be optimised
629	sub cf::attachable::detach {	910	sub cf::attachable::detach {
630	my ($obj, $name) = @_;	911	my ($obj, $name) = @_;
…		…
633	delete $obj->{_attachment}{$name};	914	delete $obj->{_attachment}{$name};
634	reattach ($obj);	915	reattach ($obj);
635	} else {	916	} else {
636	Carp::croak "cannot, currently, detach class attachments";	917	Carp::croak "cannot, currently, detach class attachments";
637	}	918	}
		919	_recalc_want;
638	};	920	};
639		921
640	sub cf::attachable::attached {	922	sub cf::attachable::attached {
641	my ($obj, $name) = @_;	923	my ($obj, $name) = @_;
642		924
…		…
657	";	939	";
658	die if $@;	940	die if $@;
659	}	941	}
660		942
661	our $override;	943	our $override;
662	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?
663		945
664	sub override {	946	sub override {
665	$override = 1;	947	$override = 1;
666	@invoke_results = ();	948	@INVOKE_RESULTS = (@_);
667	}	949	}
668		950
669	sub do_invoke {	951	sub do_invoke {
670	my $event = shift;	952	my $event = shift;
671	my $callbacks = shift;	953	my $callbacks = shift;
672		954
673	@invoke_results = ();	955	@INVOKE_RESULTS = ();
674		956
675	local $override;	957	local $override;
676		958
677	for (@$callbacks) {	959	for (@$callbacks) {
678	eval { &{$_->[1]} };	960	eval { &{$_->[1]} };
…		…
695		977
696	Generate an object-specific event with the given arguments.	978	Generate an object-specific event with the given arguments.
697		979
698	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
699	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
700	results (if you must, access C<@cf::invoke_results> directly).	982	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
701		983
702	=back	984	=back
703		985
704	=cut	986	=cut
705		987
706	#############################################################################	988	#############################################################################
707	# 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	}
708		1032
709	sub reattach {	1033	sub reattach {
710	# basically do the same as instantiate, without calling instantiate	1034	# basically do the same as instantiate, without calling instantiate
711	my ($obj) = @_;	1035	my ($obj) = @_;
712		1036
…		…
733	cf::attachable->attach (	1057	cf::attachable->attach (
734	prio => -1000000,	1058	prio => -1000000,
735	on_instantiate => sub {	1059	on_instantiate => sub {
736	my ($obj, $data) = @_;	1060	my ($obj, $data) = @_;
737		1061
738	$data = from_json $data;	1062	$data = decode_json $data;
739		1063
740	for (@$data) {	1064	for (@$data) {
741	my ($name, $args) = @$_;	1065	my ($name, $args) = @$_;
742		1066
743	$obj->attach ($name, %{$args || {} });	1067	$obj->attach ($name, %{$args || {} });
…		…
759	sub object_freezer_save {	1083	sub object_freezer_save {
760	my ($filename, $rdata, $objs) = @_;	1084	my ($filename, $rdata, $objs) = @_;
761		1085
762	sync_job {	1086	sync_job {
763	if (length $$rdata) {	1087	if (length $$rdata) {
		1088	utf8::decode (my $decname = $filename);
764	warn sprintf "saving %s (%d,%d)\n",	1089	warn sprintf "saving %s (%d,%d)\n",
765	$filename, length $$rdata, scalar @$objs;	1090	$decname, length $$rdata, scalar @$objs;
766		1091
767	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1092	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
768	chmod SAVE_MODE, $fh;	1093	chmod SAVE_MODE, $fh;
769	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1094	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
770	aio_fsync $fh if $cf::USE_FSYNC;	1095	aio_fsync $fh if $cf::USE_FSYNC;
771	close $fh;	1096	close $fh;
772		1097
773	if (@$objs) {	1098	if (@$objs) {
774	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) {
775	chmod SAVE_MODE, $fh;	1100	chmod SAVE_MODE, $fh;
776	my $data = Storable::nfreeze { version => 1, objs => $objs };	1101	my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
777	aio_write $fh, 0, (length $data), $data, 0;	1102	aio_write $fh, 0, (length $data), $data, 0;
778	aio_fsync $fh if $cf::USE_FSYNC;	1103	aio_fsync $fh if $cf::USE_FSYNC;
779	close $fh;	1104	close $fh;
780	aio_rename "$filename.pst~", "$filename.pst";	1105	aio_rename "$filename.pst~", "$filename.pst";
781	}	1106	}
…		…
789	}	1114	}
790	} else {	1115	} else {
791	aio_unlink $filename;	1116	aio_unlink $filename;
792	aio_unlink "$filename.pst";	1117	aio_unlink "$filename.pst";
793	}	1118	}
794
795	#d##TODO# nuke non .map-files if exist
796	if ($filename =~ s/\.map$//) {
797	aio_unlink $filename;
798	aio_unlink "$filename.pst";
799	}
800	}	1119	};
801	}	1120	}
802		1121
803	sub object_freezer_as_string {	1122	sub object_freezer_as_string {
804	my ($rdata, $objs) = @_;	1123	my ($rdata, $objs) = @_;
805		1124
…		…
810		1129
811	sub object_thawer_load {	1130	sub object_thawer_load {
812	my ($filename) = @_;	1131	my ($filename) = @_;
813		1132
814	my ($data, $av);	1133	my ($data, $av);
815
816	#d#TODO remove .map if file does not exist
817	aio_stat $filename and $filename =~ s/\.map$//;
818		1134
819	(aio_load $filename, $data) >= 0	1135	(aio_load $filename, $data) >= 0
820	or return;	1136	or return;
821		1137
822	unless (aio_stat "$filename.pst") {	1138	unless (aio_stat "$filename.pst") {
823	(aio_load "$filename.pst", $av) >= 0	1139	(aio_load "$filename.pst", $av) >= 0
824	or return;	1140	or return;
		1141
825	$av = eval { (Storable::thaw $av)->{objs} };	1142	my $st = eval { Coro::Storable::thaw $av };
		1143	$av = $st->{objs};
826	}	1144	}
827		1145
		1146	utf8::decode (my $decname = $filename);
828	warn sprintf "loading %s (%d)\n",	1147	warn sprintf "loading %s (%d,%d)\n",
829	$filename, length $data, scalar @{$av || []};#d#	1148	$decname, length $data, scalar @{$av || []};
		1149
830	return ($data, $av);	1150	($data, $av)
831	}	1151	}
		1152
		1153	=head2 COMMAND CALLBACKS
		1154
		1155	=over 4
		1156
		1157	=cut
832		1158
833	#############################################################################	1159	#############################################################################
834	# command handling &c	1160	# command handling &c
835		1161
836	=item cf::register_command $name => \&callback($ob,$args);	1162	=item cf::register_command $name => \&callback($ob,$args);
…		…
849	push @{ $COMMAND{$name} }, [$caller, $cb];	1175	push @{ $COMMAND{$name} }, [$caller, $cb];
850	}	1176	}
851		1177
852	=item cf::register_extcmd $name => \&callback($pl,$packet);	1178	=item cf::register_extcmd $name => \&callback($pl,$packet);
853		1179
854	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.
855		1185
856	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
857	called.	1187	called.
858		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
859	=cut	1200	=cut
860		1201
861	sub register_extcmd {	1202	sub register_extcmd {
862	my ($name, $cb) = @_;	1203	my ($name, $cb) = @_;
863		1204
864	$EXTCMD{$name} = $cb;	1205	$EXTCMD{$name} = $cb;
		1206	}
		1207
		1208	sub register_exticmd {
		1209	my ($name, $cb) = @_;
		1210
		1211	$EXTICMD{$name} = $cb;
865	}	1212	}
866		1213
867	cf::player->attach (	1214	cf::player->attach (
868	on_command => sub {	1215	on_command => sub {
869	my ($pl, $name, $params) = @_;	1216	my ($pl, $name, $params) = @_;
…		…
878	cf::override;	1225	cf::override;
879	},	1226	},
880	on_extcmd => sub {	1227	on_extcmd => sub {
881	my ($pl, $buf) = @_;	1228	my ($pl, $buf) = @_;
882		1229
883	my $msg = eval { from_json $buf };	1230	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
884		1231
885	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
886	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1240	if (my $cb = $EXTCMD{$type}) {
887	if (my %reply = $cb->($pl, $msg)) {	1241	@reply = $cb->($pl, @payload);
888	$pl->ext_reply ($msg->{msgid}, %reply);
889	}
890	}	1242	}
		1243
		1244	$pl->ext_reply ($reply, @reply)
		1245	if $reply;
		1246
891	} else {	1247	} else {
892	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1248	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
893	}	1249	}
894		1250
895	cf::override;	1251	cf::override;
896	},	1252	},
897	);	1253	);
898		1254
899	sub load_extension {
900	my ($path) = @_;
901
902	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
903	my $base = $1;
904	my $pkg = $1;
905	$pkg =~ s/[^[:word:]]/_/g;
906	$pkg = "ext::$pkg";
907
908	warn "... loading '$path' into '$pkg'\n";
909
910	open my $fh, "<:utf8", $path
911	or die "$path: $!";
912
913	my $source =
914	"package $pkg; use strict; use utf8;\n"
915	. "#line 1 \"$path\"\n{\n"
916	. (do { local $/; <$fh> })
917	. "\n};\n1";
918
919	unless (eval $source) {
920	my $msg = $@ ? "$path: $@\n"
921	: "extension disabled.\n";
922	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
923	warn $@;
924	warn "mandatory extension failed to load, exiting.\n";
925	exit 1;
926	}
927	die $@;
928	}
929
930	push @EXTS, $pkg;
931	}
932
933	sub load_extensions {	1255	sub load_extensions {
		1256	cf::sync_job {
		1257	my %todo;
		1258
934	for my $ext (<$LIBDIR/*.ext>) {	1259	for my $path (<$LIBDIR/*.ext>) {
935	next unless -r $ext;	1260	next unless -r $path;
936	eval {	1261
937	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;
938	1	1319	}
939	} or warn "$ext not loaded: $@";	1320
		1321	skip:
		1322	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1323	unless $progress;
		1324	}
940	}	1325	};
941	}	1326	}
942		1327
943	#############################################################################	1328	#############################################################################
944		1329
		1330	=back
		1331
945	=head2 CORE EXTENSIONS	1332	=head2 CORE EXTENSIONS
946		1333
947	Functions and methods that extend core crossfire objects.	1334	Functions and methods that extend core crossfire objects.
948		1335
949	=cut	1336	=cut
…		…
954		1341
955	=head3 cf::player	1342	=head3 cf::player
956		1343
957	=over 4	1344	=over 4
958		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
959	=item cf::player::find $login	1360	=item cf::player::find $login
960		1361
961	Returns the given player object, loading it if necessary (might block).	1362	Returns the given player object, loading it if necessary (might block).
962		1363
963	=cut	1364	=cut
964		1365
965	sub playerdir($) {	1366	sub playerdir($) {
966	cf::localdir	1367	"$PLAYERDIR/"
967	. "/"
968	. cf::playerdir
969	. "/"
970	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1368	. (ref $_[0] ? $_[0]->ob->name : $_[0])
971	}	1369	}
972		1370
973	sub path($) {	1371	sub path($) {
974	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1372	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
975		1373
976	(playerdir $login) . "/$login.pl"	1374	(playerdir $login) . "/playerdata"
977	}	1375	}
978		1376
979	sub find_active($) {	1377	sub find_active($) {
980	$cf::PLAYER{$_[0]}	1378	$cf::PLAYER{$_[0]}
981	and $cf::PLAYER{$_[0]}->active	1379	and $cf::PLAYER{$_[0]}->active
…		…
994	my $login = $_[0];	1392	my $login = $_[0];
995		1393
996	my $guard = cf::lock_acquire "user_find:$login";	1394	my $guard = cf::lock_acquire "user_find:$login";
997		1395
998	$cf::PLAYER{$_[0]} || do {	1396	$cf::PLAYER{$_[0]} || do {
999	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
1000	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;
1001	$cf::PLAYER{$login} = $pl	1411	$cf::PLAYER{$login} = $pl
1002	}	1412	}
1003	}	1413	}
1004	}	1414	}
1005		1415
…		…
1015		1425
1016	aio_mkdir playerdir $pl, 0770;	1426	aio_mkdir playerdir $pl, 0770;
1017	$pl->{last_save} = $cf::RUNTIME;	1427	$pl->{last_save} = $cf::RUNTIME;
1018		1428
1019	$pl->save_pl ($path);	1429	$pl->save_pl ($path);
1020	Coro::cede;	1430	cf::cede_to_tick;
1021	}	1431	}
1022		1432
1023	sub new($) {	1433	sub new($) {
1024	my ($login) = @_;	1434	my ($login) = @_;
1025		1435
…		…
1031	$cf::PLAYER{$login} = $self;	1441	$cf::PLAYER{$login} = $self;
1032		1442
1033	$self	1443	$self
1034	}	1444	}
1035		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
1036	=item $pl->quit_character	1456	=item $pl->quit_character
1037		1457
1038	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
1039	be destroyed. May block for a long time.	1459	be destroyed. May block for a long time.
1040		1460
1041	=cut	1461	=cut
1042		1462
1043	sub quit_character {	1463	sub quit_character {
1044	my ($pl) = @_;	1464	my ($pl) = @_;
		1465
		1466	my $name = $pl->ob->name;
1045		1467
1046	$pl->{deny_save} = 1;	1468	$pl->{deny_save} = 1;
1047	$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
1048		1470
1049	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1471	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1054	my $path = playerdir $pl;	1476	my $path = playerdir $pl;
1055	my $temp = "$path~$cf::RUNTIME~deleting~";	1477	my $temp = "$path~$cf::RUNTIME~deleting~";
1056	aio_rename $path, $temp;	1478	aio_rename $path, $temp;
1057	delete $cf::PLAYER{$pl->ob->name};	1479	delete $cf::PLAYER{$pl->ob->name};
1058	$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
1059	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;
1060	}	1502	}
1061		1503
1062	=item cf::player::list_logins	1504	=item cf::player::list_logins
1063		1505
1064	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
1065	while and may block, so not sync_job-capable, ever.	1507	while and may block, so not sync_job-capable, ever.
1066		1508
1067	=cut	1509	=cut
1068		1510
1069	sub list_logins {	1511	sub list_logins {
1070	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1512	my $dirs = aio_readdir $PLAYERDIR
1071	or return [];	1513	or return [];
1072		1514
1073	my @logins;	1515	my @logins;
1074		1516
1075	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") {
1076	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;	1522	my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1077	aio_read $fh, 0, 512, my $buf, 0 or next;	1523	aio_read $fh, 0, 512, my $buf, 0 or next;
1078	$buf !~ /^password -------------$/m or next; # official not-valid tag	1524	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1525	}
1079		1526
1080	utf8::decode $login;	1527	utf8::decode $login;
1081	push @logins, $login;	1528	push @logins, $login;
1082	}	1529	}
1083		1530
…		…
1110	}	1557	}
1111		1558
1112	\@paths	1559	\@paths
1113	}	1560	}
1114		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
1115	=item $player->ext_reply ($msgid, $msgtype, %msg)	1655	=item $player->ext_reply ($msgid, @msg)
1116		1656
1117	Sends an ext reply to the player.	1657	Sends an ext reply to the player.
1118		1658
1119	=cut	1659	=cut
1120		1660
1121	sub ext_reply($$$%) {	1661	sub ext_reply($$@) {
1122	my ($self, $id, %msg) = @_;	1662	my ($self, $id, @msg) = @_;
1123		1663
1124	$msg{msgid} = $id;	1664	$self->ns->ext_reply ($id, @msg)
1125
1126	$self->send ("ext " . cf::to_json \%msg);
1127	}	1665	}
1128		1666
1129	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	}
1130		1707
1131	=back	1708	=back
1132
1133		1709
1134	=head3 cf::map	1710	=head3 cf::map
1135		1711
1136	=over 4	1712	=over 4
1137		1713
…		…
1192	my ($self, $merge) = @_;	1768	my ($self, $merge) = @_;
1193		1769
1194	# we have to keep some variables in memory intact	1770	# we have to keep some variables in memory intact
1195	local $self->{path};	1771	local $self->{path};
1196	local $self->{load_path};	1772	local $self->{load_path};
1197	local $self->{deny_save};
1198	local $self->{deny_reset};
1199		1773
1200	$self->SUPER::thawer_merge ($merge);	1774	$self->SUPER::thawer_merge ($merge);
1201	}	1775	}
1202		1776
1203	sub normalise {	1777	sub normalise {
…		…
1250	$self->init; # pass $1 etc.	1824	$self->init; # pass $1 etc.
1251	return $self;	1825	return $self;
1252	}	1826	}
1253	}	1827	}
1254		1828
1255	Carp::carp "unable to resolve path '$path' (base '$base').";	1829	Carp::cluck "unable to resolve path '$path' (base '$base').";
1256	()	1830	()
1257	}	1831	}
1258		1832
1259	sub init {	1833	sub init {
1260	my ($self) = @_;	1834	my ($self) = @_;
…		…
1275		1849
1276	# the original (read-only) location	1850	# the original (read-only) location
1277	sub load_path {	1851	sub load_path {
1278	my ($self) = @_;	1852	my ($self) = @_;
1279		1853
1280	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1854	"$MAPDIR/$self->{path}.map"
1281	}	1855	}
1282		1856
1283	# the temporary/swap location	1857	# the temporary/swap location
1284	sub save_path {	1858	sub save_path {
1285	my ($self) = @_;	1859	my ($self) = @_;
1286		1860
1287	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1861	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1288	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1862	"$TMPDIR/$path.map"
1289	}	1863	}
1290		1864
1291	# the unique path, undef == no special unique path	1865	# the unique path, undef == no special unique path
1292	sub uniq_path {	1866	sub uniq_path {
1293	my ($self) = @_;	1867	my ($self) = @_;
1294		1868
1295	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1869	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1296	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1870	"$UNIQUEDIR/$path"
1297	}	1871	}
1298		1872
1299	# and all this just because we cannot iterate over	1873	# and all this just because we cannot iterate over
1300	# all maps in C++...	1874	# all maps in C++...
1301	sub change_all_map_light {	1875	sub change_all_map_light {
…		…
1303		1877
1304	$_->change_map_light ($change)	1878	$_->change_map_light ($change)
1305	for grep $_->outdoor, values %cf::MAP;	1879	for grep $_->outdoor, values %cf::MAP;
1306	}	1880	}
1307		1881
		1882	sub decay_objects {
		1883	my ($self) = @_;
		1884
		1885	return if $self->{deny_reset};
		1886
		1887	$self->do_decay_objects;
		1888	}
		1889
1308	sub unlink_save {	1890	sub unlink_save {
1309	my ($self) = @_;	1891	my ($self) = @_;
1310		1892
1311	utf8::encode (my $save = $self->save_path);	1893	utf8::encode (my $save = $self->save_path);
1312	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1894	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1313	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1895	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1314
1315	#d#TODO remove .map and also nuke
1316	$save =~ s/\.map// or return;#d#
1317	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1318	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1319	}	1896	}
1320		1897
1321	sub load_header_from($) {	1898	sub load_header_from($) {
1322	my ($self, $path) = @_;	1899	my ($self, $path) = @_;
1323		1900
1324	utf8::encode $path;	1901	utf8::encode $path;
1325	#aio_open $path, O_RDONLY, 0	1902	my $f = new_from_file cf::object::thawer $path
1326	# or return;
1327
1328	$self->_load_header ($path)
1329	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;
1330		1910
1331	$self->{load_path} = $path;	1911	$self->{load_path} = $path;
1332		1912
1333	1	1913	1
1334	}	1914	}
…		…
1373	$self->load_header_orig	1953	$self->load_header_orig
1374	or return;	1954	or return;
1375	$self->prepare_orig;	1955	$self->prepare_orig;
1376	}	1956	}
1377		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
1378	1	1964	1
1379	}	1965	}
1380		1966
1381	sub find;	1967	sub find;
1382	sub find {	1968	sub find {
1383	my ($path, $origin) = @_;	1969	my ($path, $origin) = @_;
1384		1970
1385	$path = normalise $path, $origin && $origin->path;	1971	$path = normalise $path, $origin && $origin->path;
1386		1972
		1973	cf::lock_wait "map_data:$path";#d#remove
1387	cf::lock_wait "map_find:$path";	1974	cf::lock_wait "map_find:$path";
1388		1975
1389	$cf::MAP{$path} || do {	1976	$cf::MAP{$path} || do {
1390	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
1391	my $map = new_from_path cf::map $path	1980	my $map = new_from_path cf::map $path
1392	or return;	1981	or return;
1393		1982
1394	$map->{last_save} = $cf::RUNTIME;	1983	$map->{last_save} = $cf::RUNTIME;
1395		1984
1396	$map->load_header	1985	$map->load_header
1397	or return;	1986	or return;
1398		1987
1399	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1988	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1400	# doing this can freeze the server in a sync job, obviously	1989	# doing this can freeze the server in a sync job, obviously
1401	#$cf::WAIT_FOR_TICK->wait;	1990	#$cf::WAIT_FOR_TICK->wait;
		1991	undef $guard1;
		1992	undef $guard2;
1402	$map->reset;	1993	$map->reset;
1403	undef $guard;
1404	return find $path;	1994	return find $path;
1405	}	1995	}
1406		1996
1407	$cf::MAP{$path} = $map	1997	$cf::MAP{$path} = $map
1408	}	1998	}
…		…
1415	my ($self) = @_;	2005	my ($self) = @_;
1416		2006
1417	local $self->{deny_reset} = 1; # loading can take a long time	2007	local $self->{deny_reset} = 1; # loading can take a long time
1418		2008
1419	my $path = $self->{path};	2009	my $path = $self->{path};
		2010
		2011	{
1420	my $guard = cf::lock_acquire "map_load:$path";	2012	my $guard = cf::lock_acquire "map_data:$path";
1421		2013
		2014	return unless $self->valid;
1422	return if $self->in_memory != cf::MAP_SWAPPED;	2015	return unless $self->in_memory == cf::MAP_SWAPPED;
1423		2016
1424	$self->in_memory (cf::MAP_LOADING);	2017	$self->in_memory (cf::MAP_LOADING);
1425		2018
1426	$self->alloc;	2019	$self->alloc;
1427		2020
1428	$self->pre_load;	2021	$self->pre_load;
		2022	cf::cede_to_tick;
1429		2023
1430	$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)
1431	or return;	2027	or return;
1432		2028
1433	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	2029	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1434	if delete $self->{load_original};	2030	if delete $self->{load_original};
1435		2031
1436	if (my $uniq = $self->uniq_path) {	2032	if (my $uniq = $self->uniq_path) {
1437	utf8::encode $uniq;	2033	utf8::encode $uniq;
1438	if (aio_open $uniq, O_RDONLY, 0) {	2034	unless (aio_stat $uniq) {
		2035	if (my $f = new_from_file cf::object::thawer $uniq) {
1439	$self->clear_unique_items;	2036	$self->clear_unique_items;
1440	$self->_load_objects ($uniq, 0);	2037	$self->_load_objects ($f);
		2038	$f->resolve_delayed_derefs;
		2039	}
1441	}	2040	}
1442	}	2041	}
1443		2042
1444	Coro::cede;	2043	$f->resolve_delayed_derefs;
1445		2044
		2045	cf::cede_to_tick;
1446	# now do the right thing for maps	2046	# now do the right thing for maps
1447	$self->link_multipart_objects;	2047	$self->link_multipart_objects;
1448
1449	unless ($self->{deny_activate}) {
1450	$self->decay_objects;
1451	$self->fix_auto_apply;
1452	$self->update_buttons;
1453	Coro::cede;
1454	$self->set_darkness_map;
1455	$self->difficulty ($self->estimate_difficulty)	2048	$self->difficulty ($self->estimate_difficulty)
1456	unless $self->difficulty;	2049	unless $self->difficulty;
1457	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;
1458	$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);
1459	}	2066	}
1460		2067
1461	$self->post_load;	2068	$self->post_load;
1462
1463	$self->in_memory (cf::MAP_IN_MEMORY);
1464	}	2069	}
1465		2070
1466	sub customise_for {	2071	sub customise_for {
1467	my ($self, $ob) = @_;	2072	my ($self, $ob) = @_;
1468		2073
1469	return find "~" . $ob->name . "/" . $self->{path}	2074	return find "~" . $ob->name . "/" . $self->{path}
1470	if $self->per_player;	2075	if $self->per_player;
1471		2076
		2077	# return find "?party/" . $ob->name . "/" . $self->{path}
		2078	# if $self->per_party;
		2079
1472	$self	2080	$self
1473	}	2081	}
1474		2082
1475	# 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
1476	sub load_diag {	2084	sub load_neighbours {
1477	my ($map) = @_;	2085	my ($map) = @_;
1478		2086
1479	my @diag; # diagonal neighbours	2087	my @neigh; # diagonal neighbours
1480		2088
1481	for (0 .. 3) {	2089	for (0 .. 3) {
1482	my $neigh = $map->tile_path ($_)	2090	my $neigh = $map->tile_path ($_)
1483	or next;	2091	or next;
1484	$neigh = find $neigh, $map	2092	$neigh = find $neigh, $map
1485	or next;	2093	or next;
1486	$neigh->load;	2094	$neigh->load;
1487		2095
		2096	push @neigh,
1488	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],	2097	[$neigh->tile_path (($_ + 3) % 4), $neigh],
1489	[$neigh->tile_path (($_ + 1) % 4), $neigh];	2098	[$neigh->tile_path (($_ + 1) % 4), $neigh];
1490	}	2099	}
1491		2100
1492	for (@diag) {	2101	for (grep defined $_->[0], @neigh) {
		2102	my ($path, $origin) = @$_;
1493	my $neigh = find @$_	2103	my $neigh = find $path, $origin
1494	or next;	2104	or next;
1495	$neigh->load;	2105	$neigh->load;
1496	}	2106	}
1497	}	2107	}
1498		2108
…		…
1503	}	2113	}
1504		2114
1505	sub do_load_sync {	2115	sub do_load_sync {
1506	my ($map) = @_;	2116	my ($map) = @_;
1507		2117
		2118	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		2119	if $Coro::current == $Coro::main;
		2120
1508	cf::sync_job { $map->load };	2121	cf::sync_job { $map->load };
1509	}	2122	}
1510		2123
1511	our %MAP_PREFETCH;	2124	our %MAP_PREFETCH;
1512	our $MAP_PREFETCHER = undef;	2125	our $MAP_PREFETCHER = undef;
1513		2126
1514	sub find_async {	2127	sub find_async {
1515	my ($path, $origin) = @_;	2128	my ($path, $origin, $load) = @_;
1516		2129
1517	$path = normalise $path, $origin && $origin->{path};	2130	$path = normalise $path, $origin && $origin->{path};
1518		2131
1519	if (my $map = $cf::MAP{$path}) {	2132	if (my $map = $cf::MAP{$path}) {
1520	return $map if $map->in_memory == cf::MAP_IN_MEMORY;	2133	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1521	}	2134	}
1522		2135
1523	undef $MAP_PREFETCH{$path};	2136	$MAP_PREFETCH{$path} |= $load;
		2137
1524	$MAP_PREFETCHER ||= cf::async {	2138	$MAP_PREFETCHER ||= cf::async {
		2139	$Coro::current->{desc} = "map prefetcher";
		2140
1525	while (%MAP_PREFETCH) {	2141	while (%MAP_PREFETCH) {
1526	for my $path (keys %MAP_PREFETCH) {	2142	while (my ($k, $v) = each %MAP_PREFETCH) {
1527	my $map = find $path	2143	if (my $map = find $k) {
1528	or next;
1529	$map->load;	2144	$map->load if $v;
		2145	}
1530		2146
1531	delete $MAP_PREFETCH{$path};	2147	delete $MAP_PREFETCH{$k};
1532	}	2148	}
1533	}	2149	}
1534	undef $MAP_PREFETCHER;	2150	undef $MAP_PREFETCHER;
1535	};	2151	};
1536	$MAP_PREFETCHER->prio (6);	2152	$MAP_PREFETCHER->prio (6);
…		…
1539	}	2155	}
1540		2156
1541	sub save {	2157	sub save {
1542	my ($self) = @_;	2158	my ($self) = @_;
1543		2159
1544	my $lock = cf::lock_acquire "map_data:" . $self->path;	2160	my $lock = cf::lock_acquire "map_data:$self->{path}";
1545		2161
1546	$self->{last_save} = $cf::RUNTIME;	2162	$self->{last_save} = $cf::RUNTIME;
1547		2163
1548	return unless $self->dirty;	2164	return unless $self->dirty;
1549		2165
…		…
1555	return if $self->{deny_save};	2171	return if $self->{deny_save};
1556		2172
1557	local $self->{last_access} = $self->last_access;#d#	2173	local $self->{last_access} = $self->last_access;#d#
1558		2174
1559	cf::async {	2175	cf::async {
		2176	$Coro::current->{desc} = "map player save";
1560	$_->contr->save for $self->players;	2177	$_->contr->save for $self->players;
1561	};	2178	};
1562		2179
1563	if ($uniq) {	2180	if ($uniq) {
1564	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2181	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
…		…
1572	my ($self) = @_;	2189	my ($self) = @_;
1573		2190
1574	# save first because save cedes	2191	# save first because save cedes
1575	$self->save;	2192	$self->save;
1576		2193
1577	my $lock = cf::lock_acquire "map_data:" . $self->path;	2194	my $lock = cf::lock_acquire "map_data:$self->{path}";
1578		2195
1579	return if $self->players;	2196	return if $self->players;
1580	return if $self->in_memory != cf::MAP_IN_MEMORY;	2197	return if $self->in_memory != cf::MAP_IN_MEMORY;
1581	return if $self->{deny_save};	2198	return if $self->{deny_save};
1582		2199
		2200	$self->in_memory (cf::MAP_SWAPPED);
		2201
		2202	$self->deactivate;
		2203	$_->clear_links_to ($self) for values %cf::MAP;
1583	$self->clear;	2204	$self->clear;
1584	$self->in_memory (cf::MAP_SWAPPED);
1585	}	2205	}
1586		2206
1587	sub reset_at {	2207	sub reset_at {
1588	my ($self) = @_;	2208	my ($self) = @_;
1589		2209
1590	# TODO: safety, remove and allow resettable per-player maps	2210	# TODO: safety, remove and allow resettable per-player maps
1591	return 1e99 if $self->isa ("ext::map_per_player");#d#
1592	return 1e99 if $self->{deny_reset};	2211	return 1e99 if $self->{deny_reset};
1593		2212
1594	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2213	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1595	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;
1596		2215
…		…
1607	my ($self) = @_;	2226	my ($self) = @_;
1608		2227
1609	my $lock = cf::lock_acquire "map_data:$self->{path}";	2228	my $lock = cf::lock_acquire "map_data:$self->{path}";
1610		2229
1611	return if $self->players;	2230	return if $self->players;
1612	return if $self->isa ("ext::map_per_player");#d#
1613		2231
1614	warn "resetting map ", $self->path;#d#	2232	warn "resetting map ", $self->path;
1615		2233
1616	$self->in_memory (cf::MAP_SWAPPED);	2234	$self->in_memory (cf::MAP_SWAPPED);
1617		2235
1618	# need to save uniques path	2236	# need to save uniques path
1619	unless ($self->{deny_save}) {	2237	unless ($self->{deny_save}) {
…		…
1623	if $uniq;	2241	if $uniq;
1624	}	2242	}
1625		2243
1626	delete $cf::MAP{$self->path};	2244	delete $cf::MAP{$self->path};
1627		2245
		2246	$self->deactivate;
		2247	$_->clear_links_to ($self) for values %cf::MAP;
1628	$self->clear;	2248	$self->clear;
1629
1630	$_->clear_links_to ($self) for values %cf::MAP;
1631		2249
1632	$self->unlink_save;	2250	$self->unlink_save;
1633	$self->destroy;	2251	$self->destroy;
1634	}	2252	}
1635		2253
1636	my $nuke_counter = "aaaa";	2254	my $nuke_counter = "aaaa";
1637		2255
1638	sub nuke {	2256	sub nuke {
1639	my ($self) = @_;	2257	my ($self) = @_;
1640		2258
		2259	{
		2260	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2261
1641	delete $cf::MAP{$self->path};	2262	delete $cf::MAP{$self->path};
1642		2263
1643	$self->unlink_save;	2264	$self->unlink_save;
1644		2265
1645	bless $self, "cf::map";	2266	bless $self, "cf::map";
1646	delete $self->{deny_reset};	2267	delete $self->{deny_reset};
1647	$self->{deny_save} = 1;	2268	$self->{deny_save} = 1;
1648	$self->reset_timeout (1);	2269	$self->reset_timeout (1);
1649	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));	2270	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1650		2271
1651	$cf::MAP{$self->path} = $self;	2272	$cf::MAP{$self->path} = $self;
		2273	}
1652		2274
1653	$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	]
1654	}	2312	}
1655		2313
1656	=item cf::map::unique_maps	2314	=item cf::map::unique_maps
1657		2315
1658	Returns an arrayref of paths of all shared maps that have	2316	Returns an arrayref of paths of all shared maps that have
1659	instantiated unique items. May block.	2317	instantiated unique items. May block.
1660		2318
1661	=cut	2319	=cut
1662		2320
1663	sub unique_maps() {	2321	sub unique_maps() {
1664	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2322	[
1665	or return;	2323	map {
1666
1667	my @paths;
1668
1669	for (@$files) {
1670	utf8::decode $_;	2324	utf8::decode $_;
1671	next if /\.pst$/;	2325	/\.map$/
1672	next unless /^$PATH_SEP/o;	2326	? normalise $_
1673		2327	: ()
1674	push @paths, cf::map::normalise $_;	2328	} @{ aio_readdir $UNIQUEDIR or [] }
1675	}	2329	]
1676
1677	\@paths
1678	}	2330	}
1679		2331
1680	package cf;	2332	package cf;
1681		2333
1682	=back	2334	=back
…		…
1700	map { $_, inv_recursive_ $_->inv } @_	2352	map { $_, inv_recursive_ $_->inv } @_
1701	}	2353	}
1702		2354
1703	sub inv_recursive {	2355	sub inv_recursive {
1704	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	}
1705	}	2385	}
1706		2386
1707	package cf;	2387	package cf;
1708		2388
1709	=back	2389	=back
…		…
1728		2408
1729	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2409	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1730		2410
1731	if ($self->{record_replies}) {	2411	if ($self->{record_replies}) {
1732	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2412	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2413
1733	} 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 {
1734	$msg = $npc->name . " says: $msg" if $npc;	2422	$msg = $npc->name . " says: $msg" if $npc;
1735	$self->message ($msg, $flags);	2423	$self->message ($msg, $flags);
		2424	}
1736	}	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 (@_);
1737	}	2436	}
1738		2437
1739	=item $player_object->may ("access")	2438	=item $player_object->may ("access")
1740		2439
1741	Returns wether the given player is authorized to access resource "access"	2440	Returns wether the given player is authorized to access resource "access"
…		…
1788	$self->deactivate_recursive;	2487	$self->deactivate_recursive;
1789		2488
1790	return if UNIVERSAL::isa $self->map, "ext::map_link";	2489	return if UNIVERSAL::isa $self->map, "ext::map_link";
1791		2490
1792	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2491	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1793	if $self->map;	2492	if $self->map && $self->map->{path} ne "{link}";
1794		2493
1795	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2494	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1796	}	2495	}
1797		2496
1798	sub cf::object::player::leave_link {	2497	sub cf::object::player::leave_link {
1799	my ($self, $map, $x, $y) = @_;	2498	my ($self, $map, $x, $y) = @_;
		2499
		2500	return unless $self->contr->active;
1800		2501
1801	my $link_pos = delete $self->{_link_pos};	2502	my $link_pos = delete $self->{_link_pos};
1802		2503
1803	unless ($map) {	2504	unless ($map) {
1804	# restore original map position	2505	# restore original map position
…		…
1818	# use -1 or undef as default coordinates, not 0, 0	2519	# use -1 or undef as default coordinates, not 0, 0
1819	($x, $y) = ($map->enter_x, $map->enter_y)	2520	($x, $y) = ($map->enter_x, $map->enter_y)
1820	if $x <=0 && $y <= 0;	2521	if $x <=0 && $y <= 0;
1821		2522
1822	$map->load;	2523	$map->load;
1823	$map->load_diag;	2524	$map->load_neighbours;
1824		2525
1825	return unless $self->contr->active;	2526	return unless $self->contr->active;
1826	$self->activate_recursive;	2527	$self->activate_recursive;
		2528
		2529	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827	$self->enter_map ($map, $x, $y);	2530	$self->enter_map ($map, $x, $y);
1828	}	2531	}
1829		2532
1830	cf::player->attach (	2533	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1831	on_logout => sub {
1832	my ($pl) = @_;
1833		2534
1834	# abort map switching before logout	2535	Moves the player to the given map-path and coordinates by first freezing
1835	if ($pl->ob->{_link_pos}) {	2536	her, loading and preparing them map, calling the provided $check callback
1836	cf::sync_job {	2537	that has to return the map if sucecssful, and then unfreezes the player on
1837	$pl->ob->leave_link	2538	the new (success) or old (failed) map position. In either case, $done will
1838	};	2539	be called at the end of this process.
1839	}
1840	},
1841	on_login => sub {
1842	my ($pl) = @_;
1843		2540
1844	# try to abort aborted map switching on player login :)
1845	# should happen only on crashes
1846	if ($pl->ob->{_link_pos}) {
1847	$pl->ob->enter_link;
1848	(async {
1849	# we need this sleep as the login has a concurrent enter_exit running
1850	# and this sleep increases chances of the player not ending up in scorn
1851	$pl->ob->reply (undef,
1852	"There was an internal problem at your last logout, "
1853	. "the server will try to bring you to your intended destination in a second.",
1854	cf::NDI_RED);
1855	Coro::Timer::sleep 1;
1856	$pl->ob->leave_link;
1857	})->prio (2);
1858	}
1859	},
1860	);
1861
1862	=item $player_object->goto ($path, $x, $y)
1863
1864	=cut	2541	=cut
		2542
		2543	our $GOTOGEN;
1865		2544
1866	sub cf::object::player::goto {	2545	sub cf::object::player::goto {
1867	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;
1868		2550
1869	$self->enter_link;	2551	$self->enter_link;
1870		2552
1871	(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
1872	my $map = eval {	2575	my $map = eval {
1873	my $map = cf::map::find $path;	2576	my $map = defined $path ? cf::map::find $path : undef;
		2577
		2578	if ($map) {
1874	$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
1875	$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 $@;
1876	} or	2591	}
1877	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878		2592
		2593	if ($gen == $self->{_goto_generation}) {
		2594	delete $self->{_goto_generation};
1879	$self->leave_link ($map, $x, $y);	2595	$self->leave_link ($map, $x, $y);
		2596	}
		2597
		2598	$done->() if $done;
1880	})->prio (1);	2599	})->prio (1);
1881	}	2600	}
1882		2601
1883	=item $player_object->enter_exit ($exit_object)	2602	=item $player_object->enter_exit ($exit_object)
1884		2603
…		…
1921	$rmp->{origin_y} = $exit->y;	2640	$rmp->{origin_y} = $exit->y;
1922	}	2641	}
1923		2642
1924	$rmp->{random_seed} ||= $exit->random_seed;	2643	$rmp->{random_seed} ||= $exit->random_seed;
1925		2644
1926	my $data = cf::to_json $rmp;	2645	my $data = cf::encode_json $rmp;
1927	my $md5 = Digest::MD5::md5_hex $data;	2646	my $md5 = Digest::MD5::md5_hex $data;
1928	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2647	my $meta = "$RANDOMDIR/$md5.meta";
1929		2648
1930	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2649	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931	aio_write $fh, 0, (length $data), $data, 0;	2650	aio_write $fh, 0, (length $data), $data, 0;
1932	undef $fh;	2651	undef $fh;
1933	aio_rename "$meta~", $meta;	2652	aio_rename "$meta~", $meta;
…		…
1942		2661
1943	return unless $self->type == cf::PLAYER;	2662	return unless $self->type == cf::PLAYER;
1944		2663
1945	if ($exit->slaying eq "/!") {	2664	if ($exit->slaying eq "/!") {
1946	#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
1947	cf::sync_job { prepare_random_map $exit };	2668	cf::sync_job { prepare_random_map $exit };
1948	}	2669	}
1949		2670
1950	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;
1951	my $hp = $exit->stats->hp;	2672	my $hp = $exit->stats->hp;
1952	my $sp = $exit->stats->sp;	2673	my $sp = $exit->stats->sp;
1953		2674
1954	$self->enter_link;	2675	$self->enter_link;
1955		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
1956	(async {	2681	(async {
		2682	$Coro::current->{desc} = "enter_exit $slaying $hp $sp";
		2683
1957	$self->deactivate_recursive; # just to be sure	2684	$self->deactivate_recursive; # just to be sure
1958	unless (eval {	2685	unless (eval {
1959	$self->goto ($slaying, $hp, $sp);	2686	$self->goto ($slaying, $hp, $sp);
1960		2687
1961	1;	2688	1;
1962	}) {	2689	}) {
1963	$self->message ("Something went wrong deep within the crossfire server. "	2690	$self->message ("Something went wrong deep within the crossfire server. "
1964	. "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. "
1965	. "Please report this to the dungeon master!",	2692	. "Please report this to the dungeon master!",
1966	cf::NDI_UNIQUE | cf::NDI_RED);	2693	cf::NDI_UNIQUE | cf::NDI_RED);
1967		2694
1968	warn "ERROR in enter_exit: $@";	2695	warn "ERROR in enter_exit: $@";
1969	$self->leave_link;	2696	$self->leave_link;
1970	}	2697	}
1971	})->prio (1);	2698	})->prio (1);
…		…
1984		2711
1985	sub cf::client::send_drawinfo {	2712	sub cf::client::send_drawinfo {
1986	my ($self, $text, $flags) = @_;	2713	my ($self, $text, $flags) = @_;
1987		2714
1988	utf8::encode $text;	2715	utf8::encode $text;
1989	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2716	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1990	}	2717	}
1991		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	}
1992		2877
1993	=item $success = $client->query ($flags, "text", \&cb)	2878	=item $success = $client->query ($flags, "text", \&cb)
1994		2879
1995	Queues a query to the client, calling the given callback with	2880	Queues a query to the client, calling the given callback with
1996	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>,
1997	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>.
1998		2883
1999	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
2000	reliable at some point in the future.	2885	become reliable at some point in the future.
2001		2886
2002	=cut	2887	=cut
2003		2888
2004	sub cf::client::query {	2889	sub cf::client::query {
2005	my ($self, $flags, $text, $cb) = @_;	2890	my ($self, $flags, $text, $cb) = @_;
…		…
2013	utf8::encode $text;	2898	utf8::encode $text;
2014	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2899	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015		2900
2016	$self->send_packet ($self->{query_queue}[0][0])	2901	$self->send_packet ($self->{query_queue}[0][0])
2017	if @{ $self->{query_queue} } == 1;	2902	if @{ $self->{query_queue} } == 1;
		2903
		2904	1
2018	}	2905	}
2019		2906
2020	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	},
2021	on_reply => sub {	2913	on_reply => sub {
2022	my ($ns, $msg) = @_;	2914	my ($ns, $msg) = @_;
2023		2915
2024	# this weird shuffling is so that direct followup queries	2916	# this weird shuffling is so that direct followup queries
2025	# get handled first	2917	# get handled first
…		…
2037	} else {	2929	} else {
2038	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2930	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039	}	2931	}
2040	}	2932	}
2041	},	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	},
2042	);	2960	);
2043		2961
2044	=item $client->async (\&cb)	2962	=item $client->async (\&cb)
2045		2963
2046	Create a new coroutine, running the specified callback. The coroutine will	2964	Create a new coroutine, running the specified callback. The coroutine will
…		…
2087	our $safe = new Safe "safe";	3005	our $safe = new Safe "safe";
2088	our $safe_hole = new Safe::Hole;	3006	our $safe_hole = new Safe::Hole;
2089		3007
2090	$SIG{FPE} = 'IGNORE';	3008	$SIG{FPE} = 'IGNORE';
2091		3009
2092	$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	));
2093		3015
2094	# here we export the classes and methods available to script code	3016	# here we export the classes and methods available to script code
2095		3017
2096	=pod	3018	=pod
2097		3019
2098	The following fucntions and emthods are available within a safe environment:	3020	The following functions and methods are available within a safe environment:
2099		3021
2100	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
2101	cf::object::player player	3026	cf::object::player
2102	cf::player peaceful	3027	player
2103	cf::map trigger	3028
		3029	cf::player
		3030	peaceful
		3031
		3032	cf::map
		3033	trigger
2104		3034
2105	=cut	3035	=cut
2106		3036
2107	for (	3037	for (
2108	["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)],
2109	["cf::object::player" => qw(player)],	3041	["cf::object::player" => qw(player)],
2110	["cf::player" => qw(peaceful)],	3042	["cf::player" => qw(peaceful)],
2111	["cf::map" => qw(trigger)],	3043	["cf::map" => qw(trigger)],
2112	) {	3044	) {
2113	no strict 'refs';	3045	no strict 'refs';
…		…
2184	=back	3116	=back
2185		3117
2186	=cut	3118	=cut
2187		3119
2188	#############################################################################	3120	#############################################################################
2189
2190	=head2 EXTENSION DATABASE SUPPORT
2191
2192	Crossfire maintains a very simple database for extension use. It can
2193	currently store anything that can be serialised using Storable, which
2194	excludes objects.
2195
2196	The parameter C<$family> should best start with the name of the extension
2197	using it, it should be unique.
2198
2199	=over 4
2200
2201	=item $value = cf::db_get $family => $key
2202
2203	Returns a single value from the database.
2204
2205	=item cf::db_put $family => $key => $value
2206
2207	Stores the given C<$value> in the family.
2208
2209	=cut
2210
2211	our $DB;
2212
2213	sub db_init {
2214	unless ($DB) {
2215	$DB = BDB::db_create $DB_ENV;
2216
2217	cf::sync_job {
2218	eval {
2219	$DB->set_flags (BDB::CHKSUM);
2220
2221	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223	cf::cleanup "db_open(db): $!" if $!;
2224	};
2225	cf::cleanup "db_open(db): $@" if $@;
2226	};
2227
2228	my $path = cf::localdir . "/database.pst";
2229	if (stat $path) {
2230	cf::sync_job {
2231	my $pst = Storable::retrieve $path;
2232
2233	cf::db_put (board => data => $pst->{board});
2234	cf::db_put (guildrules => data => $pst->{guildrules});
2235	cf::db_put (rent => balance => $pst->{rent}{balance});
2236	BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238	unlink $path;
2239	};
2240	}
2241	}
2242	}
2243
2244	sub db_get($$) {
2245	my $key = "$_[0]/$_[1]";
2246
2247	cf::sync_job {
2248	BDB::db_get $DB, undef, $key, my $data;
2249
2250	$! ? ()
2251	: Compress::LZF::sthaw $data
2252	}
2253	}
2254
2255	sub db_put($$$) {
2256	BDB::dbreq_pri 4;
2257	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258	}
2259
2260	#############################################################################
2261	# the server's init and main functions	3121	# the server's init and main functions
2262		3122
2263	sub load_resources {	3123	sub load_facedata($) {
2264	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	if (my $soundconf = delete $res->{"res/sound.conf"}) {
		3225	$soundconf = $enc->decode (delete $soundconf->{data});
		3226
		3227	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		3228	my $sound = $soundconf->{compat}[$_]
		3229	or next;
		3230
		3231	my $face = cf::face::find "sound/$sound->[1]";
		3232	cf::sound::set $sound->[0] => $face;
		3233	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		3234	}
		3235
		3236	while (my ($k, $v) = each %{$soundconf->{event}}) {
		3237	my $face = cf::face::find "sound/$v";
		3238	cf::sound::set $k => $face;
		3239	}
		3240	}
		3241	}
		3242
		3243	1
		3244	}
		3245
		3246	register_exticmd fx_want => sub {
		3247	my ($ns, $want) = @_;
		3248
		3249	while (my ($k, $v) = each %$want) {
		3250	$ns->fx_want ($k, $v);
		3251	}
		3252	};
		3253
		3254	sub reload_regions {
		3255	# HACK to clear player env face cache, we need some signal framework
		3256	# for this (global event?)
		3257	%ext::player_env::MUSIC_FACE_CACHE = ();
		3258
		3259	load_resource_file "$MAPDIR/regions"
2265	or die "unable to load regions file\n";#d#	3260	or die "unable to load regions file\n";
2266	}
2267		3261
2268	sub cfg_load {	3262	for (cf::region::list) {
		3263	$_->{match} = qr/$_->{match}/
		3264	if exists $_->{match};
		3265	}
		3266	}
		3267
		3268	sub reload_facedata {
		3269	load_facedata "$DATADIR/facedata"
		3270	or die "unable to load facedata\n";
		3271	}
		3272
		3273	sub reload_archetypes {
		3274	load_resource_file "$DATADIR/archetypes"
		3275	or die "unable to load archetypes\n";
		3276	#d# NEED to laod twice to resolve forward references
		3277	# this really needs to be done in an extra post-pass
		3278	# (which needs to be synchronous, so solve it differently)
		3279	load_resource_file "$DATADIR/archetypes"
		3280	or die "unable to load archetypes\n";
		3281	}
		3282
		3283	sub reload_treasures {
		3284	load_resource_file "$DATADIR/treasures"
		3285	or die "unable to load treasurelists\n";
		3286	}
		3287
		3288	sub reload_resources {
		3289	warn "reloading resource files...\n";
		3290
		3291	reload_regions;
		3292	reload_facedata;
		3293	#reload_archetypes;#d#
		3294	reload_archetypes;
		3295	reload_treasures;
		3296
		3297	warn "finished reloading resource files\n";
		3298	}
		3299
		3300	sub init {
		3301	reload_resources;
		3302	}
		3303
		3304	sub reload_config {
2269	open my $fh, "<:utf8", cf::confdir . "/config"	3305	open my $fh, "<:utf8", "$CONFDIR/config"
2270	or return;	3306	or return;
2271		3307
2272	local $/;	3308	local $/;
2273	*CFG = YAML::Syck::Load <$fh>;	3309	*CFG = YAML::Syck::Load <$fh>;
2274		3310
…		…
2284	};	3320	};
2285	warn $@ if $@;	3321	warn $@ if $@;
2286	}	3322	}
2287	}	3323	}
2288		3324
2289	sub init {
2290	load_resources;
2291	}
2292
2293	sub main {	3325	sub main {
2294	# we must not ever block the main coroutine	3326	# we must not ever block the main coroutine
2295	local $Coro::idle = sub {	3327	local $Coro::idle = sub {
2296	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3328	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2297	(async {	3329	(async {
2298	Event::one_event;	3330	$Coro::current->{desc} = "IDLE BUG HANDLER";
		3331	EV::loop EV::LOOP_ONESHOT;
2299	})->prio (Coro::PRIO_MAX);	3332	})->prio (Coro::PRIO_MAX);
2300	};	3333	};
2301		3334
2302	cfg_load;	3335	reload_config;
2303	db_init;	3336	db_init;
2304	load_extensions;	3337	load_extensions;
2305		3338
2306	$TICK_WATCHER->start;	3339	$TICK_WATCHER->start;
		3340	$Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
2307	Event::loop;	3341	EV::loop;
2308	}	3342	}
2309		3343
2310	#############################################################################	3344	#############################################################################
2311	# initialisation and cleanup	3345	# initialisation and cleanup
2312		3346
2313	# install some emergency cleanup handlers	3347	# install some emergency cleanup handlers
2314	BEGIN {	3348	BEGIN {
		3349	our %SIGWATCHER = ();
2315	for my $signal (qw(INT HUP TERM)) {	3350	for my $signal (qw(INT HUP TERM)) {
2316	Event->signal (	3351	$SIGWATCHER{$signal} = EV::signal $signal, sub {
2317	reentrant => 0,
2318	data => WF_AUTOCANCEL,
2319	signal => $signal,
2320	prio => 0,
2321	cb => sub {
2322	cf::cleanup "SIG$signal";	3352	cf::cleanup "SIG$signal";
2323	},
2324	);	3353	};
		3354	}
		3355	}
		3356
		3357	sub write_runtime {
		3358	my $runtime = "$LOCALDIR/runtime";
		3359
		3360	# first touch the runtime file to show we are still running:
		3361	# the fsync below can take a very very long time.
		3362
		3363	IO::AIO::aio_utime $runtime, undef, undef;
		3364
		3365	my $guard = cf::lock_acquire "write_runtime";
		3366
		3367	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3368	or return;
		3369
		3370	my $value = $cf::RUNTIME + 90 + 10;
		3371	# 10 is the runtime save interval, for a monotonic clock
		3372	# 60 allows for the watchdog to kill the server.
		3373
		3374	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3375	and return;
		3376
		3377	# always fsync - this file is important
		3378	aio_fsync $fh
		3379	and return;
		3380
		3381	# touch it again to show we are up-to-date
		3382	aio_utime $fh, undef, undef;
		3383
		3384	close $fh
		3385	or return;
		3386
		3387	aio_rename "$runtime~", $runtime
		3388	and return;
		3389
		3390	warn "runtime file written.\n";
		3391
2325	}	3392	1
2326	}	3393	}
2327		3394
2328	sub emergency_save() {	3395	sub emergency_save() {
2329	my $freeze_guard = cf::freeze_mainloop;	3396	my $freeze_guard = cf::freeze_mainloop;
2330		3397
…		…
2336	# and maps saved/destroyed asynchronously.	3403	# and maps saved/destroyed asynchronously.
2337	warn "begin emergency player save\n";	3404	warn "begin emergency player save\n";
2338	for my $login (keys %cf::PLAYER) {	3405	for my $login (keys %cf::PLAYER) {
2339	my $pl = $cf::PLAYER{$login} or next;	3406	my $pl = $cf::PLAYER{$login} or next;
2340	$pl->valid or next;	3407	$pl->valid or next;
		3408	delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2341	$pl->save;	3409	$pl->save;
2342	}	3410	}
2343	warn "end emergency player save\n";	3411	warn "end emergency player save\n";
2344		3412
2345	warn "begin emergency map save\n";	3413	warn "begin emergency map save\n";
…		…
2363		3431
2364	warn Carp::longmess "post_cleanup backtrace"	3432	warn Carp::longmess "post_cleanup backtrace"
2365	if $make_core;	3433	if $make_core;
2366	}	3434	}
2367		3435
2368	sub reload() {	3436	sub do_reload_perl() {
2369	# can/must only be called in main	3437	# can/must only be called in main
2370	if ($Coro::current != $Coro::main) {	3438	if ($Coro::current != $Coro::main) {
2371	warn "can only reload from main coroutine";	3439	warn "can only reload from main coroutine";
2372	return;	3440	return;
2373	}	3441	}
2374		3442
2375	warn "reloading...";	3443	warn "reloading...";
2376		3444
2377	warn "cancelling server ticker";	3445	warn "entering sync_job";
2378	$TICK_WATCHER->cancel;
2379		3446
		3447	cf::sync_job {
		3448	cf::write_runtime; # external watchdog should not bark
2380	cf::emergency_save;	3449	cf::emergency_save;
		3450	cf::write_runtime; # external watchdog should not bark
2381		3451
2382	eval {	3452	warn "syncing database to disk";
		3453	BDB::db_env_txn_checkpoint $DB_ENV;
		3454
2383	# if anything goes wrong in here, we should simply crash as we already saved	3455	# if anything goes wrong in here, we should simply crash as we already saved
2384
2385	warn "cancelling all WF_AUTOCANCEL watchers";
2386	for (Event::all_watchers) {
2387	$_->cancel if $_->data & WF_AUTOCANCEL;
2388	}
2389
2390	warn "syncing database to disk";
2391	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2392		3456
2393	warn "flushing outstanding aio requests";	3457	warn "flushing outstanding aio requests";
2394	for (;;) {	3458	for (;;) {
2395	BDB::flush;	3459	BDB::flush;
2396	IO::AIO::flush;	3460	IO::AIO::flush;
2397	Coro::cede;	3461	Coro::cede_notself;
2398	last unless IO::AIO::nreqs || BDB::nreqs;	3462	last unless IO::AIO::nreqs || BDB::nreqs;
2399	warn "iterate...";	3463	warn "iterate...";
2400	}	3464	}
		3465
		3466	++$RELOAD;
2401		3467
2402	warn "cancelling all extension coros";	3468	warn "cancelling all extension coros";
2403	$_->cancel for values %EXT_CORO;	3469	$_->cancel for values %EXT_CORO;
2404	%EXT_CORO = ();	3470	%EXT_CORO = ();
2405		3471
2406	warn "removing commands";	3472	warn "removing commands";
2407	%COMMAND = ();	3473	%COMMAND = ();
2408		3474
2409	warn "removing ext commands";	3475	warn "removing ext/exti commands";
2410	%EXTCMD = ();	3476	%EXTCMD = ();
		3477	%EXTICMD = ();
2411		3478
2412	warn "unloading/nuking all extensions";	3479	warn "unloading/nuking all extensions";
2413	for my $pkg (@EXTS) {	3480	for my $pkg (@EXTS) {
2414	warn "... unloading $pkg";	3481	warn "... unloading $pkg";
2415		3482
…		…
2445	Symbol::delete_package "safe::$_"	3512	Symbol::delete_package "safe::$_"
2446	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3513	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2447		3514
2448	warn "unloading cf.pm \"a bit\"";	3515	warn "unloading cf.pm \"a bit\"";
2449	delete $INC{"cf.pm"};	3516	delete $INC{"cf.pm"};
		3517	delete $INC{"cf/pod.pm"};
2450		3518
2451	# don't, removes xs symbols, too,	3519	# don't, removes xs symbols, too,
2452	# and global variables created in xs	3520	# and global variables created in xs
2453	#Symbol::delete_package __PACKAGE__;	3521	#Symbol::delete_package __PACKAGE__;
2454		3522
…		…
2457	warn "reloading cf.pm";	3525	warn "reloading cf.pm";
2458	require cf;	3526	require cf;
2459	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3527	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2460		3528
2461	warn "loading config and database again";	3529	warn "loading config and database again";
2462	cf::cfg_load;	3530	cf::reload_config;
2463		3531
2464	warn "loading extensions";	3532	warn "loading extensions";
2465	cf::load_extensions;	3533	cf::load_extensions;
2466		3534
2467	warn "reattaching attachments to objects/players";	3535	warn "reattaching attachments to objects/players";
2468	_global_reattach;	3536	_global_reattach; # objects, sockets
2469	warn "reattaching attachments to maps";	3537	warn "reattaching attachments to maps";
2470	reattach $_ for values %MAP;	3538	reattach $_ for values %MAP;
		3539	warn "reattaching attachments to players";
		3540	reattach $_ for values %PLAYER;
2471		3541
2472	warn "loading reloadable resources";	3542	warn "leaving sync_job";
2473	load_resources;
2474		3543
2475	warn "restarting server ticker";	3544	1
2476		3545	} or do {
2477	$TICK_WATCHER->start;
2478	};
2479
2480	if ($@) {
2481	warn $@;	3546	warn $@;
2482	warn "error while reloading, exiting.";	3547	warn "error while reloading, exiting.";
2483	exit 1;	3548	exit 1;
2484	}	3549	};
2485		3550
2486	warn "reloaded";	3551	warn "reloaded";
2487	};	3552	};
2488		3553
2489	our $RELOAD_WATCHER; # used only during reload	3554	our $RELOAD_WATCHER; # used only during reload
2490		3555
		3556	sub reload_perl() {
		3557	# doing reload synchronously and two reloads happen back-to-back,
		3558	# coro crashes during coro_state_free->destroy here.
		3559
		3560	$RELOAD_WATCHER ||= EV::timer 0, 0, sub {
		3561	undef $RELOAD_WATCHER;
		3562	do_reload_perl;
		3563	};
		3564	}
		3565
2491	register_command "reload" => sub {	3566	register_command "reload" => sub {
2492	my ($who, $arg) = @_;	3567	my ($who, $arg) = @_;
2493		3568
2494	if ($who->flag (FLAG_WIZ)) {	3569	if ($who->flag (FLAG_WIZ)) {
2495	$who->message ("reloading server.");	3570	$who->message ("reloading server.");
2496		3571	async {
2497	# doing reload synchronously and two reloads happen back-to-back,	3572	$Coro::current->{desc} = "perl_reload";
2498	# coro crashes during coro_state_free->destroy here.
2499
2500	$RELOAD_WATCHER ||= Event->timer (
2501	reentrant => 0,
2502	after => 0,
2503	data => WF_AUTOCANCEL,
2504	cb => sub {
2505	reload;	3573	reload_perl;
2506	undef $RELOAD_WATCHER;
2507	},
2508	);	3574	};
2509	}	3575	}
2510	};	3576	};
2511		3577
2512	unshift @INC, $LIBDIR;	3578	unshift @INC, $LIBDIR;
2513		3579
2514	my $bug_warning = 0;	3580	my $bug_warning = 0;
2515		3581
2516	$TICK_WATCHER = Event->timer (	3582	our @WAIT_FOR_TICK;
2517	reentrant => 0,	3583	our @WAIT_FOR_TICK_BEGIN;
2518	parked => 1,	3584
2519	prio => 0,	3585	sub wait_for_tick {
2520	at => $NEXT_TICK || $TICK,	3586	return unless $TICK_WATCHER->is_active;
2521	data => WF_AUTOCANCEL,	3587	return if $Coro::current == $Coro::main;
2522	cb => sub {	3588
		3589	my $signal = new Coro::Signal;
		3590	push @WAIT_FOR_TICK, $signal;
		3591	$signal->wait;
		3592	}
		3593
		3594	sub wait_for_tick_begin {
		3595	return unless $TICK_WATCHER->is_active;
		3596	return if $Coro::current == $Coro::main;
		3597
		3598	my $signal = new Coro::Signal;
		3599	push @WAIT_FOR_TICK_BEGIN, $signal;
		3600	$signal->wait;
		3601	}
		3602
		3603	$TICK_WATCHER = EV::periodic_ns 0, $TICK, 0, sub {
2523	if ($Coro::current != $Coro::main) {	3604	if ($Coro::current != $Coro::main) {
2524	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3605	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2525	unless ++$bug_warning > 10;	3606	unless ++$bug_warning > 10;
2526	return;	3607	return;
2527	}	3608	}
2528		3609
2529	$NOW = Event::time;	3610	$NOW = $tick_start = EV::now;
2530		3611
2531	cf::server_tick; # one server iteration	3612	cf::server_tick; # one server iteration
		3613
2532	$RUNTIME += $TICK;	3614	$RUNTIME += $TICK;
2533	$NEXT_TICK += $TICK;	3615	$NEXT_TICK = $_[0]->at;
2534		3616
2535	$WAIT_FOR_TICK->broadcast;	3617	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2536	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3618	$NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2537		3619	Coro::async_pool {
2538	Event::sweep;	3620	$Coro::current->{desc} = "runtime saver";
2539	Coro::cede_notself;	3621	write_runtime
		3622	or warn "ERROR: unable to write runtime file: $!";
2540		3623	};
2541	# my $AFTER = Event::time;
2542	# warn $AFTER - $NOW;#d#
2543
2544	# if we are delayed by four ticks or more, skip them all
2545	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2546
2547	$TICK_WATCHER->at ($NEXT_TICK);
2548	$TICK_WATCHER->start;
2549	},	3624	}
2550	);	3625
		3626	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3627	$sig->send;
		3628	}
		3629	while (my $sig = shift @WAIT_FOR_TICK) {
		3630	$sig->send;
		3631	}
		3632
		3633	$LOAD = ($NOW - $tick_start) / $TICK;
		3634	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3635
		3636	_post_tick;
		3637	};
		3638	$TICK_WATCHER->priority (EV::MAXPRI);
2551		3639
2552	{	3640	{
2553	BDB::max_poll_time $TICK * 0.1;	3641	# configure BDB
2554	$BDB_POLL_WATCHER = Event->io (	3642
2555	reentrant => 0,
2556	fd => BDB::poll_fileno,
2557	poll => 'r',
2558	prio => 0,
2559	data => WF_AUTOCANCEL,
2560	cb => \&BDB::poll_cb,
2561	);
2562	BDB::min_parallel 8;	3643	BDB::min_parallel 8;
2563		3644	BDB::max_poll_reqs $TICK * 0.1;
2564	BDB::set_sync_prepare {	3645	$Coro::BDB::WATCHER->priority (1);
2565	my $status;
2566	my $current = $Coro::current;
2567	(
2568	sub {
2569	$status = $!;
2570	$current->ready; undef $current;
2571	},
2572	sub {
2573	Coro::schedule while defined $current;
2574	$! = $status;
2575	},
2576	)
2577	};
2578		3646
2579	unless ($DB_ENV) {	3647	unless ($DB_ENV) {
2580	$DB_ENV = BDB::db_env_create;	3648	$DB_ENV = BDB::db_env_create;
		3649	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
		3650	| BDB::LOG_AUTOREMOVE, 1);
		3651	$DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
		3652	$DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2581		3653
2582	cf::sync_job {	3654	cf::sync_job {
2583	eval {	3655	eval {
2584	BDB::db_env_open	3656	BDB::db_env_open
2585	$DB_ENV,	3657	$DB_ENV,
2586	$BDB_ENV_DIR,	3658	$BDBDIR,
2587	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3659	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2588	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3660	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2589	0666;	3661	0666;
2590		3662
2591	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3663	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2592
2593	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2594	$DB_ENV->set_lk_detect;
2595	};	3664	};
2596		3665
2597	cf::cleanup "db_env_open(db): $@" if $@;	3666	cf::cleanup "db_env_open(db): $@" if $@;
2598	};	3667	};
2599	}	3668	}
		3669
		3670	$BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
		3671	BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
		3672	};
		3673	$BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
		3674	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		3675	};
		3676	$BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
		3677	BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
		3678	};
2600	}	3679	}
2601		3680
2602	{	3681	{
		3682	# configure IO::AIO
		3683
2603	IO::AIO::min_parallel 8;	3684	IO::AIO::min_parallel 8;
2604
2605	undef $Coro::AIO::WATCHER;
2606	IO::AIO::max_poll_time $TICK * 0.1;	3685	IO::AIO::max_poll_time $TICK * 0.1;
2607	$AIO_POLL_WATCHER = Event->io (	3686	$Coro::AIO::WATCHER->priority (1);
2608	reentrant => 0,
2609	fd => IO::AIO::poll_fileno,
2610	poll => 'r',
2611	prio => 6,
2612	data => WF_AUTOCANCEL,
2613	cb => \&IO::AIO::poll_cb,
2614	);
2615	}	3687	}
2616		3688
2617	$WRITE_RUNTIME_WATCHER = Event->timer (	3689	my $_log_backtrace;
2618	reentrant => 0,	3690
2619	data => WF_AUTOCANCEL,	3691	sub _log_backtrace {
2620	after => 1,	3692	my ($msg, @addr) = @_;
2621	interval => 10,	3693
2622	prio => 6, # keep it lowest so it acts like a watchdog	3694	$msg =~ s/\n//;
2623	cb => Coro::unblock_sub {	3695
2624	write_runtime	3696	# limit the # of concurrent backtraces
2625	or warn "ERROR: unable to write runtime file: $!";	3697	if ($_log_backtrace < 2) {
		3698	++$_log_backtrace;
		3699	async {
		3700	$Coro::current->{desc} = "abt $msg";
		3701
		3702	my @bt = fork_call {
		3703	@addr = map { sprintf "%x", $_ } @addr;
		3704	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3705	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3706	or die "addr2line: $!";
		3707
		3708	my @funcs;
		3709	my @res = <$fh>;
		3710	chomp for @res;
		3711	while (@res) {
		3712	my ($func, $line) = splice @res, 0, 2, ();
		3713	push @funcs, "[$func] $line";
		3714	}
		3715
		3716	@funcs
		3717	};
		3718
		3719	LOG llevInfo, "[ABT] $msg\n";
		3720	LOG llevInfo, "[ABT] $_\n" for @bt;
		3721	--$_log_backtrace;
		3722	};
		3723	} else {
		3724	LOG llevInfo, "[ABT] $msg\n";
		3725	LOG llevInfo, "[ABT] [suppressed]\n";
2626	},	3726	}
2627	);	3727	}
		3728
		3729	# load additional modules
		3730	use cf::pod;
2628		3731
2629	END { cf::emergency_save }	3732	END { cf::emergency_save }
2630		3733
2631	1	3734	1
2632		3735

Diff Legend

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