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.207 by root, Sun Feb 11 22:42:09 2007 UTC vs.
Revision 1.407 by root, Sun Jan 13 09:53:53 2008 UTC

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

Diff Legend

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