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

Diff Legend

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