ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.206 by root, Sun Feb 11 22:27:05 2007 UTC vs.
Revision 1.406 by root, Mon Dec 17 08:27:44 2007 UTC

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

Diff Legend

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